1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95,96,97 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 /* Allow config.h to undefine symbols found here. */
29 #include "termhooks.h"
37 #include "dispextern.h"
39 #include "intervals.h"
40 #include "blockinput.h"
49 #include <sys/ioctl.h>
51 #endif /* not MSDOS */
53 #include "syssignal.h"
56 /* This is to get the definitions of the XK_ symbols. */
63 #endif /* HAVE_NTGUI */
65 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
70 /* Variables for blockinput.h: */
72 /* Non-zero if interrupt input is blocked right now. */
73 int interrupt_input_blocked
;
75 /* Nonzero means an input interrupt has arrived
76 during the current critical section. */
77 int interrupt_input_pending
;
80 /* File descriptor to use for input. */
83 #ifdef HAVE_WINDOW_SYSTEM
84 /* Make all keyboard buffers much bigger when using X windows. */
85 #define KBD_BUFFER_SIZE 4096
86 #else /* No X-windows, character input */
87 #define KBD_BUFFER_SIZE 256
88 #endif /* No X-windows */
90 /* Following definition copied from eval.c */
94 struct backtrace
*next
;
95 Lisp_Object
*function
;
96 Lisp_Object
*args
; /* Points to vector of args. */
97 int nargs
; /* length of vector. If nargs is UNEVALLED,
98 args points to slot holding list of
104 KBOARD
*initial_kboard
;
105 KBOARD
*current_kboard
;
109 KBOARD the_only_kboard
;
112 /* Non-nil disable property on a command means
113 do not execute it; call disabled-command-hook's value instead. */
114 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
116 #define NUM_RECENT_KEYS (100)
117 int recent_keys_index
; /* Index for storing next element into recent_keys */
118 int total_keys
; /* Total number of elements stored into recent_keys */
119 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
121 /* Vector holding the key sequence that invoked the current command.
122 It is reused for each command, and it may be longer than the current
123 sequence; this_command_key_count indicates how many elements
124 actually mean something.
125 It's easier to staticpro a single Lisp_Object than an array. */
126 Lisp_Object this_command_keys
;
127 int this_command_key_count
;
129 /* Number of elements of this_command_keys
130 that precede this key sequence. */
131 int this_single_command_key_start
;
133 /* Record values of this_command_key_count and echo_length ()
134 before this command was read. */
135 static int before_command_key_count
;
136 static int before_command_echo_length
;
137 /* Values of before_command_key_count and before_command_echo_length
138 saved by reset-this-command-lengths. */
139 static int before_command_key_count_1
;
140 static int before_command_echo_length_1
;
141 /* Flag set by reset-this-command-lengths,
142 saying to reset the lengths when add_command_key is called. */
143 static int before_command_restore_flag
;
145 extern int minbuf_level
;
147 extern struct backtrace
*backtrace_list
;
149 /* Nonzero means do menu prompting. */
150 static int menu_prompting
;
152 /* Character to see next line of menu prompt. */
153 static Lisp_Object menu_prompt_more_char
;
155 /* For longjmp to where kbd input is being done. */
156 static jmp_buf getcjmp
;
158 /* True while doing kbd input. */
159 int waiting_for_input
;
161 /* True while displaying for echoing. Delays C-g throwing. */
164 /* True means we can start echoing at the next input pause
165 even though there is something in the echo area. */
166 static char *ok_to_echo_at_next_pause
;
168 /* Nonzero means disregard local maps for the menu bar. */
169 static int inhibit_local_menu_bar_menus
;
171 /* Nonzero means C-g should cause immediate error-signal. */
174 /* The user's ERASE setting. */
175 Lisp_Object Vtty_erase_char
;
177 /* Character to recognize as the help char. */
178 Lisp_Object Vhelp_char
;
180 /* List of other event types to recognize as meaning "help". */
181 Lisp_Object Vhelp_event_list
;
183 /* Form to execute when help char is typed. */
184 Lisp_Object Vhelp_form
;
186 /* Command to run when the help character follows a prefix key. */
187 Lisp_Object Vprefix_help_command
;
189 /* List of items that should move to the end of the menu bar. */
190 Lisp_Object Vmenu_bar_final_items
;
192 /* Non-nil means show the equivalent key-binding for
193 any M-x command that has one.
194 The value can be a length of time to show the message for.
195 If the value is non-nil and not a number, we wait 2 seconds. */
196 Lisp_Object Vsuggest_key_bindings
;
198 /* Character that causes a quit. Normally C-g.
200 If we are running on an ordinary terminal, this must be an ordinary
201 ASCII char, since we want to make it our interrupt character.
203 If we are not running on an ordinary terminal, it still needs to be
204 an ordinary ASCII char. This character needs to be recognized in
205 the input interrupt handler. At this point, the keystroke is
206 represented as a struct input_event, while the desired quit
207 character is specified as a lispy event. The mapping from struct
208 input_events to lispy events cannot run in an interrupt handler,
209 and the reverse mapping is difficult for anything but ASCII
212 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
216 extern Lisp_Object current_global_map
;
217 extern int minibuf_level
;
219 /* If non-nil, this is a map that overrides all other local maps. */
220 Lisp_Object Voverriding_local_map
;
222 /* If non-nil, Voverriding_local_map applies to the menu bar. */
223 Lisp_Object Voverriding_local_map_menu_flag
;
225 /* Keymap that defines special misc events that should
226 be processed immediately at a low level. */
227 Lisp_Object Vspecial_event_map
;
229 /* Current depth in recursive edits. */
230 int command_loop_level
;
232 /* Total number of times command_loop has read a key sequence. */
235 /* Last input character read as a command. */
236 Lisp_Object last_command_char
;
238 /* Last input character read as a command, not counting menus
239 reached by the mouse. */
240 Lisp_Object last_nonmenu_event
;
242 /* Last input character read for any purpose. */
243 Lisp_Object last_input_char
;
245 /* If not Qnil, a list of objects to be read as subsequent command input. */
246 Lisp_Object Vunread_command_events
;
248 /* If not -1, an event to be read as subsequent command input. */
249 int unread_command_char
;
251 /* If not Qnil, this is a switch-frame event which we decided to put
252 off until the end of a key sequence. This should be read as the
253 next command input, after any unread_command_events.
255 read_key_sequence uses this to delay switch-frame events until the
256 end of the key sequence; Fread_char uses it to put off switch-frame
257 events until a non-ASCII event is acceptable as input. */
258 Lisp_Object unread_switch_frame
;
260 /* A mask of extra modifier bits to put into every keyboard char. */
261 int extra_keyboard_modifiers
;
263 /* Char to use as prefix when a meta character is typed in.
264 This is bound on entry to minibuffer in case ESC is changed there. */
266 Lisp_Object meta_prefix_char
;
268 /* Last size recorded for a current buffer which is not a minibuffer. */
269 static int last_non_minibuf_size
;
271 /* Number of idle seconds before an auto-save and garbage collection. */
272 static Lisp_Object Vauto_save_timeout
;
274 /* Total number of times read_char has returned. */
275 int num_input_events
;
277 /* Total number of times read_char has returned, outside of macros. */
278 int num_nonmacro_input_events
;
280 /* Auto-save automatically when this many characters have been typed
281 since the last time. */
283 static int auto_save_interval
;
285 /* Value of num_nonmacro_input_events as of last auto save. */
289 /* The command being executed by the command loop.
290 Commands may set this, and the value set will be copied into
291 current_kboard->Vlast_command instead of the actual command. */
292 Lisp_Object this_command
;
294 /* The value of point when the last command was executed. */
295 int last_point_position
;
297 /* The buffer that was current when the last command was started. */
298 Lisp_Object last_point_position_buffer
;
300 /* The frame in which the last input event occurred, or Qmacro if the
301 last event came from a macro. We use this to determine when to
302 generate switch-frame events. This may be cleared by functions
303 like Fselect_frame, to make sure that a switch-frame event is
304 generated by the next character. */
305 Lisp_Object internal_last_event_frame
;
307 /* A user-visible version of the above, intended to allow users to
308 figure out where the last event came from, if the event doesn't
309 carry that information itself (i.e. if it was a character). */
310 Lisp_Object Vlast_event_frame
;
312 /* The timestamp of the last input event we received from the X server.
313 X Windows wants this for selection ownership. */
314 unsigned long last_event_timestamp
;
316 Lisp_Object Qself_insert_command
;
317 Lisp_Object Qforward_char
;
318 Lisp_Object Qbackward_char
;
319 Lisp_Object Qundefined
;
320 Lisp_Object Qtimer_event_handler
;
322 /* read_key_sequence stores here the command definition of the
323 key sequence that it reads. */
324 Lisp_Object read_key_sequence_cmd
;
326 /* Form to evaluate (if non-nil) when Emacs is started. */
327 Lisp_Object Vtop_level
;
329 /* User-supplied string to translate input characters through. */
330 Lisp_Object Vkeyboard_translate_table
;
332 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
333 extern Lisp_Object Vfunction_key_map
;
335 /* Another keymap that maps key sequences into key sequences.
336 This one takes precedence over ordinary definitions. */
337 extern Lisp_Object Vkey_translation_map
;
339 /* Non-nil means deactivate the mark at end of this command. */
340 Lisp_Object Vdeactivate_mark
;
342 /* Menu bar specified in Lucid Emacs fashion. */
344 Lisp_Object Vlucid_menu_bar_dirty_flag
;
345 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
347 Lisp_Object Qecho_area_clear_hook
;
349 /* Hooks to run before and after each command. */
350 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
351 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
352 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
353 /* Hook run after a command if there's no more input soon. */
354 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
356 /* Delay time in microseconds before running post-command-idle-hook. */
357 int post_command_idle_delay
;
359 /* List of deferred actions to be performed at a later time.
360 The precise format isn't relevant here; we just check whether it is nil. */
361 Lisp_Object Vdeferred_action_list
;
363 /* Function to call to handle deferred actions, when there are any. */
364 Lisp_Object Vdeferred_action_function
;
365 Lisp_Object Qdeferred_action_function
;
367 /* File in which we write all commands we read. */
370 /* Nonzero if input is available. */
373 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
374 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
378 extern char *pending_malloc_warning
;
380 /* Circular buffer for pre-read keyboard input. */
381 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
383 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
385 The interrupt-level event handlers will never enqueue an event on a
386 frame which is not in Vframe_list, and once an event is dequeued,
387 internal_last_event_frame or the event itself points to the frame.
390 But while the event is sitting in the queue, it's completely
391 unprotected. Suppose the user types one command which will run for
392 a while and then delete a frame, and then types another event at
393 the frame that will be deleted, before the command gets around to
394 it. Suppose there are no references to this frame elsewhere in
395 Emacs, and a GC occurs before the second event is dequeued. Now we
396 have an event referring to a freed frame, which will crash Emacs
399 Similar things happen when an event on a scroll bar is enqueued; the
400 window may be deleted while the event is in the queue.
402 So, we use this vector to protect the frame_or_window field in the
403 event queue. That way, they'll be dequeued as dead frames or
404 windows, but still valid lisp objects.
406 If kbd_buffer[i].kind != no_event, then
407 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
408 == kbd_buffer[i].frame_or_window. */
409 static Lisp_Object kbd_buffer_frame_or_window
;
411 /* Pointer to next available character in kbd_buffer.
412 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
413 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
414 next available char is in kbd_buffer[0]. */
415 static struct input_event
*kbd_fetch_ptr
;
417 /* Pointer to next place to store character in kbd_buffer. This
418 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
419 character should go in kbd_buffer[0]. */
420 static volatile struct input_event
*kbd_store_ptr
;
422 /* The above pair of variables forms a "queue empty" flag. When we
423 enqueue a non-hook event, we increment kbd_store_ptr. When we
424 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
425 there is input available iff the two pointers are not equal.
427 Why not just have a flag set and cleared by the enqueuing and
428 dequeuing functions? Such a flag could be screwed up by interrupts
429 at inopportune times. */
431 /* If this flag is non-nil, we check mouse_moved to see when the
432 mouse moves, and motion events will appear in the input stream.
433 Otherwise, mouse motion is ignored. */
434 static Lisp_Object do_mouse_tracking
;
436 /* Symbols to head events. */
437 Lisp_Object Qmouse_movement
;
438 Lisp_Object Qscroll_bar_movement
;
439 Lisp_Object Qswitch_frame
;
440 Lisp_Object Qdelete_frame
;
441 Lisp_Object Qiconify_frame
;
442 Lisp_Object Qmake_frame_visible
;
444 /* Symbols to denote kinds of events. */
445 Lisp_Object Qfunction_key
;
446 Lisp_Object Qmouse_click
;
447 /* Lisp_Object Qmouse_movement; - also an event header */
449 /* Properties of event headers. */
450 Lisp_Object Qevent_kind
;
451 Lisp_Object Qevent_symbol_elements
;
453 Lisp_Object Qmenu_enable
;
455 /* An event header symbol HEAD may have a property named
456 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
457 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
458 mask of modifiers applied to it. If present, this is used to help
459 speed up parse_modifiers. */
460 Lisp_Object Qevent_symbol_element_mask
;
462 /* An unmodified event header BASE may have a property named
463 Qmodifier_cache, which is an alist mapping modifier masks onto
464 modified versions of BASE. If present, this helps speed up
466 Lisp_Object Qmodifier_cache
;
468 /* Symbols to use for parts of windows. */
469 Lisp_Object Qmode_line
;
470 Lisp_Object Qvertical_line
;
471 Lisp_Object Qvertical_scroll_bar
;
472 Lisp_Object Qmenu_bar
;
474 extern Lisp_Object Qmenu_enable
;
476 Lisp_Object
recursive_edit_unwind (), command_loop ();
477 Lisp_Object
Fthis_command_keys ();
478 Lisp_Object Qextended_command_history
;
479 EMACS_TIME
timer_check ();
481 extern char *x_get_keysym_name ();
483 static void record_menu_key ();
485 void swallow_events ();
487 Lisp_Object Qpolling_period
;
489 /* List of absolute timers. Appears in order of next scheduled event. */
490 Lisp_Object Vtimer_list
;
492 /* List of idle time timers. Appears in order of next scheduled event. */
493 Lisp_Object Vtimer_idle_list
;
495 /* Incremented whenever a timer is run. */
498 extern Lisp_Object Vprint_level
, Vprint_length
;
500 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
502 EMACS_TIME
*input_available_clear_time
;
504 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
505 Default is 1 if INTERRUPT_INPUT is defined. */
508 /* Nonzero while interrupts are temporarily deferred during redisplay. */
509 int interrupts_deferred
;
511 /* Nonzero means use ^S/^Q for flow control. */
514 /* Allow m- file to inhibit use of FIONREAD. */
515 #ifdef BROKEN_FIONREAD
519 /* We are unable to use interrupts if FIONREAD is not available,
520 so flush SIGIO so we won't try. */
527 /* If we support a window system, turn on the code to poll periodically
528 to detect C-g. It isn't actually used when doing interrupt input. */
529 #ifdef HAVE_WINDOW_SYSTEM
530 #define POLL_FOR_INPUT
533 /* Global variable declarations. */
535 /* Function for init_keyboard to call with no args (if nonzero). */
536 void (*keyboard_init_hook
) ();
538 static int read_avail_input ();
539 static void get_input_pending ();
540 static int readable_events ();
541 static Lisp_Object
read_char_x_menu_prompt ();
542 static Lisp_Object
read_char_minibuf_menu_prompt ();
543 static Lisp_Object
make_lispy_event ();
545 static Lisp_Object
make_lispy_movement ();
547 static Lisp_Object
modify_event_symbol ();
548 static Lisp_Object
make_lispy_switch_frame ();
549 static int parse_solitary_modifier ();
551 /* > 0 if we are to echo keystrokes. */
552 static int echo_keystrokes
;
554 /* Nonzero means don't try to suspend even if the operating system seems
556 static int cannot_suspend
;
558 #define min(a,b) ((a)<(b)?(a):(b))
559 #define max(a,b) ((a)>(b)?(a):(b))
561 /* Install the string STR as the beginning of the string of echoing,
562 so that it serves as a prompt for the next character.
563 Also start echoing. */
568 int len
= strlen (str
);
570 if (len
> ECHOBUFSIZE
- 4)
571 len
= ECHOBUFSIZE
- 4;
572 bcopy (str
, current_kboard
->echobuf
, len
);
573 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
574 *current_kboard
->echoptr
= '\0';
576 current_kboard
->echo_after_prompt
= len
;
581 /* Add C to the echo string, if echoing is going on.
582 C can be a character, which is printed prettily ("M-C-x" and all that
583 jazz), or a symbol, whose name is printed. */
588 extern char *push_key_description ();
590 if (current_kboard
->immediate_echo
)
592 char *ptr
= current_kboard
->echoptr
;
594 if (ptr
!= current_kboard
->echobuf
)
597 /* If someone has passed us a composite event, use its head symbol. */
602 if (ptr
- current_kboard
->echobuf
> ECHOBUFSIZE
- 6)
605 ptr
= push_key_description (XINT (c
), ptr
);
607 else if (SYMBOLP (c
))
609 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
610 if ((ptr
- current_kboard
->echobuf
) + name
->size
+ 4 > ECHOBUFSIZE
)
612 bcopy (name
->data
, ptr
, name
->size
);
616 if (current_kboard
->echoptr
== current_kboard
->echobuf
619 strcpy (ptr
, " (Type ? for further options)");
624 current_kboard
->echoptr
= ptr
;
630 /* Temporarily add a dash to the end of the echo string if it's not
631 empty, so that it serves as a mini-prompt for the very next character. */
635 if (!current_kboard
->immediate_echo
636 && current_kboard
->echoptr
== current_kboard
->echobuf
)
638 /* Do nothing if we just printed a prompt. */
639 if (current_kboard
->echo_after_prompt
640 == current_kboard
->echoptr
- current_kboard
->echobuf
)
642 /* Do nothing if not echoing at all. */
643 if (current_kboard
->echoptr
== 0)
646 /* Put a dash at the end of the buffer temporarily,
647 but make it go away when the next character is added. */
648 current_kboard
->echoptr
[0] = '-';
649 current_kboard
->echoptr
[1] = 0;
654 /* Display the current echo string, and begin echoing if not already
659 if (!current_kboard
->immediate_echo
)
662 current_kboard
->immediate_echo
= 1;
664 for (i
= 0; i
< this_command_key_count
; i
++)
667 c
= XVECTOR (this_command_keys
)->contents
[i
];
668 if (! (EVENT_HAS_PARAMETERS (c
)
669 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
676 message1_nolog (current_kboard
->echobuf
);
679 if (waiting_for_input
&& !NILP (Vquit_flag
))
680 quit_throw_to_read_char ();
683 /* Turn off echoing, for the start of a new command. */
687 current_kboard
->immediate_echo
= 0;
688 current_kboard
->echoptr
= current_kboard
->echobuf
;
689 current_kboard
->echo_after_prompt
= -1;
690 ok_to_echo_at_next_pause
= 0;
693 /* Return the length of the current echo string. */
698 return current_kboard
->echoptr
- current_kboard
->echobuf
;
701 /* Truncate the current echo message to its first LEN chars.
702 This and echo_char get used by read_key_sequence when the user
703 switches frames while entering a key sequence. */
709 current_kboard
->echobuf
[len
] = '\0';
710 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
711 truncate_echo_area (len
);
715 /* Functions for manipulating this_command_keys. */
717 add_command_key (key
)
720 int size
= XVECTOR (this_command_keys
)->size
;
722 /* If reset-this-command-length was called recently, obey it now.
723 See the doc string of that function for an explanation of why. */
724 if (before_command_restore_flag
)
726 this_command_key_count
= before_command_key_count_1
;
727 if (this_command_key_count
< this_single_command_key_start
)
728 this_single_command_key_start
= this_command_key_count
;
729 echo_truncate (before_command_echo_length_1
);
730 before_command_restore_flag
= 0;
733 if (this_command_key_count
>= size
)
735 Lisp_Object new_keys
;
737 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
738 bcopy (XVECTOR (this_command_keys
)->contents
,
739 XVECTOR (new_keys
)->contents
,
740 size
* sizeof (Lisp_Object
));
742 this_command_keys
= new_keys
;
745 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
751 int count
= specpdl_ptr
- specpdl
;
754 if (command_loop_level
> 0)
756 specbind (Qstandard_output
, Qt
);
757 specbind (Qstandard_input
, Qt
);
760 val
= command_loop ();
762 Fsignal (Qquit
, Qnil
);
763 /* Handle throw from read_minibuf when using minibuffer
764 while it's active but we're in another window. */
766 Fsignal (Qerror
, Fcons (val
, Qnil
));
768 return unbind_to (count
, Qnil
);
771 /* When an auto-save happens, record the "time", and don't do again soon. */
775 last_auto_save
= num_nonmacro_input_events
;
778 /* Make an auto save happen as soon as possible at command level. */
780 force_auto_save_soon ()
782 last_auto_save
= - auto_save_interval
- 1;
784 record_asynch_buffer_change ();
787 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
788 "Invoke the editor command loop recursively.\n\
789 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
790 that tells this function to return.\n\
791 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
792 This function is called by the editor initialization to begin editing.")
795 int count
= specpdl_ptr
- specpdl
;
798 command_loop_level
++;
799 update_mode_lines
= 1;
801 record_unwind_protect (recursive_edit_unwind
,
803 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
807 return unbind_to (count
, Qnil
);
811 recursive_edit_unwind (buffer
)
815 Fset_buffer (buffer
);
817 command_loop_level
--;
818 update_mode_lines
= 1;
826 #if 0 /* Theory: if there's anything in Vunread_command_events,
827 it will right away be read by read_key_sequence,
828 and then if we do switch KBOARDS, it will go into the side
829 queue then. So we don't need to do anything special here -- rms. */
830 if (CONSP (Vunread_command_events
))
832 current_kboard
->kbd_queue
833 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
834 current_kboard
->kbd_queue_has_data
= 1;
836 Vunread_command_events
= Qnil
;
842 /* Switch to the single-kboard state, making current_kboard
843 the only KBOARD from which further input is accepted. */
846 single_kboard_state ()
853 /* Maintain a stack of kboards, so other parts of Emacs
854 can switch temporarily to the kboard of a given frame
855 and then revert to the previous status. */
860 struct kboard_stack
*next
;
863 static struct kboard_stack
*kboard_stack
;
866 push_frame_kboard (f
)
870 struct kboard_stack
*p
871 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
873 p
->next
= kboard_stack
;
874 p
->kboard
= current_kboard
;
877 current_kboard
= FRAME_KBOARD (f
);
885 struct kboard_stack
*p
= kboard_stack
;
886 current_kboard
= p
->kboard
;
887 kboard_stack
= p
->next
;
892 /* Handle errors that are not handled at inner levels
893 by printing an error message and returning to the editor command loop. */
899 Lisp_Object old_level
, old_length
;
902 if (!NILP (executing_macro
))
904 if (executing_macro_iterations
== 1)
905 sprintf (macroerror
, "After 1 kbd macro iteration: ");
907 sprintf (macroerror
, "After %d kbd macro iterations: ",
908 executing_macro_iterations
);
913 Vstandard_output
= Qt
;
914 Vstandard_input
= Qt
;
915 Vexecuting_macro
= Qnil
;
916 executing_macro
= Qnil
;
917 current_kboard
->Vprefix_arg
= Qnil
;
920 /* Avoid unquittable loop if data contains a circular list. */
921 old_level
= Vprint_level
;
922 old_length
= Vprint_length
;
923 XSETFASTINT (Vprint_level
, 10);
924 XSETFASTINT (Vprint_length
, 10);
925 cmd_error_internal (data
, macroerror
);
926 Vprint_level
= old_level
;
927 Vprint_length
= old_length
;
931 Vinhibit_quit
= Qnil
;
936 return make_number (0);
939 cmd_error_internal (data
, context
)
947 echo_area_glyphs
= 0;
949 /* If the window system or terminal frame hasn't been initialized
950 yet, or we're not interactive, it's best to dump this message out
951 to stderr and exit. */
952 if (! FRAME_MESSAGE_BUF (selected_frame
)
954 stream
= Qexternal_debugging_output
;
963 write_string_1 (context
, -1, stream
);
965 print_error_message (data
, stream
);
967 /* If the window system or terminal frame hasn't been initialized
968 yet, or we're in -batch mode, this error should cause Emacs to exit. */
969 if (! FRAME_MESSAGE_BUF (selected_frame
)
973 Fkill_emacs (make_number (-1));
977 Lisp_Object
command_loop_1 ();
978 Lisp_Object
command_loop_2 ();
979 Lisp_Object
top_level_1 ();
981 /* Entry to editor-command-loop.
982 This level has the catches for exiting/returning to editor command loop.
983 It returns nil to exit recursive edit, t to abort it. */
988 if (command_loop_level
> 0 || minibuf_level
> 0)
990 return internal_catch (Qexit
, command_loop_2
, Qnil
);
995 internal_catch (Qtop_level
, top_level_1
, Qnil
);
996 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
998 /* End of file in -batch run causes exit here. */
1004 /* Here we catch errors in execution of commands within the
1005 editing loop, and reenter the editing loop.
1006 When there is an error, cmd_error runs and returns a non-nil
1007 value to us. A value of nil means that cmd_loop_1 itself
1008 returned due to end of file (or end of kbd macro). */
1013 register Lisp_Object val
;
1016 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1017 while (!NILP (val
));
1025 return Feval (Vtop_level
);
1031 /* On entry to the outer level, run the startup file */
1032 if (!NILP (Vtop_level
))
1033 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1034 else if (!NILP (Vpurify_flag
))
1035 message ("Bare impure Emacs (standard Lisp code not loaded)");
1037 message ("Bare Emacs (standard Lisp code not loaded)");
1041 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1042 "Exit all recursive editing levels.")
1045 Fthrow (Qtop_level
, Qnil
);
1048 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1049 "Exit from the innermost recursive edit or minibuffer.")
1052 if (command_loop_level
> 0 || minibuf_level
> 0)
1053 Fthrow (Qexit
, Qnil
);
1055 error ("No recursive edit is in progress");
1058 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1059 "Abort the command that requested this recursive edit or minibuffer input.")
1062 if (command_loop_level
> 0 || minibuf_level
> 0)
1065 error ("No recursive edit is in progress");
1068 /* This is the actual command reading loop,
1069 sans error-handling encapsulation. */
1071 Lisp_Object
Fcommand_execute ();
1072 static int read_key_sequence ();
1073 void safe_run_hooks ();
1078 Lisp_Object cmd
, tem
;
1081 Lisp_Object keybuf
[30];
1086 struct buffer
*prev_buffer
;
1088 int was_locked
= single_kboard
;
1091 current_kboard
->Vprefix_arg
= Qnil
;
1092 Vdeactivate_mark
= Qnil
;
1093 waiting_for_input
= 0;
1098 this_command_key_count
= 0;
1099 this_single_command_key_start
= 0;
1101 /* Make sure this hook runs after commands that get errors and
1102 throw to top level. */
1103 /* Note that the value cell will never directly contain nil
1104 if the symbol is a local variable. */
1105 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1106 safe_run_hooks (Qpost_command_hook
);
1108 if (!NILP (Vdeferred_action_list
))
1109 call0 (Vdeferred_action_function
);
1111 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1113 if (NILP (Vunread_command_events
)
1114 && NILP (Vexecuting_macro
)
1115 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1116 safe_run_hooks (Qpost_command_idle_hook
);
1119 /* Do this after running Vpost_command_hook, for consistency. */
1120 current_kboard
->Vlast_command
= this_command
;
1124 /* Make sure the current window's buffer is selected. */
1125 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1126 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1128 /* Display any malloc warning that just came out. Use while because
1129 displaying one warning can cause another. */
1131 while (pending_malloc_warning
)
1132 display_malloc_warning ();
1136 Vdeactivate_mark
= Qnil
;
1138 /* If minibuffer on and echo area in use,
1139 wait 2 sec and redraw minibuffer. */
1141 if (minibuf_level
&& echo_area_glyphs
1142 && EQ (minibuf_window
, echo_area_window
))
1144 /* Bind inhibit-quit to t so that C-g gets read in
1145 rather than quitting back to the minibuffer. */
1146 int count
= specpdl_ptr
- specpdl
;
1147 specbind (Qinhibit_quit
, Qt
);
1149 Fsit_for (make_number (2), Qnil
, Qnil
);
1150 /* Clear the echo area. */
1152 safe_run_hooks (Qecho_area_clear_hook
);
1154 unbind_to (count
, Qnil
);
1156 /* If a C-g came in before, treat it as input now. */
1157 if (!NILP (Vquit_flag
))
1160 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1165 alloca (0); /* Cause a garbage collection now */
1166 /* Since we can free the most stuff here. */
1167 #endif /* C_ALLOCA */
1170 /* Select the frame that the last event came from. Usually,
1171 switch-frame events will take care of this, but if some lisp
1172 code swallows a switch-frame event, we'll fix things up here.
1173 Is this a good idea? */
1174 if (FRAMEP (internal_last_event_frame
)
1175 && XFRAME (internal_last_event_frame
) != selected_frame
)
1176 Fselect_frame (internal_last_event_frame
, Qnil
);
1178 /* If it has changed current-menubar from previous value,
1179 really recompute the menubar from the value. */
1180 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1181 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1182 call0 (Qrecompute_lucid_menubar
);
1184 before_command_key_count
= this_command_key_count
;
1185 before_command_echo_length
= echo_length ();
1187 this_command
= Qnil
;
1189 /* Read next key sequence; i gets its length. */
1190 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1193 /* A filter may have run while we were reading the input. */
1194 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1195 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1199 /* Now we have read a key sequence of length I,
1200 or else I is 0 and we found end of file. */
1202 if (i
== 0) /* End of file -- happens only in */
1203 return Qnil
; /* a kbd macro, at the end. */
1204 /* -1 means read_key_sequence got a menu that was rejected.
1205 Just loop around and read another command. */
1209 this_command_key_count
= 0;
1210 this_single_command_key_start
= 0;
1214 last_command_char
= keybuf
[i
- 1];
1216 /* If the previous command tried to force a specific window-start,
1217 forget about that, in case this command moves point far away
1218 from that position. But also throw away beg_unchanged and
1219 end_unchanged information in that case, so that redisplay will
1220 update the whole window properly. */
1221 if (!NILP (XWINDOW (selected_window
)->force_start
))
1223 XWINDOW (selected_window
)->force_start
= Qnil
;
1224 beg_unchanged
= end_unchanged
= 0;
1227 cmd
= read_key_sequence_cmd
;
1228 if (!NILP (Vexecuting_macro
))
1230 if (!NILP (Vquit_flag
))
1232 Vexecuting_macro
= Qt
;
1233 QUIT
; /* Make some noise. */
1234 /* Will return since macro now empty. */
1238 /* Do redisplay processing after this command except in special
1239 cases identified below that set no_redisplay to 1.
1240 (actually, there's currently no way to prevent the redisplay,
1241 and no_redisplay is ignored.
1242 Perhaps someday we will really implement it.) */
1245 prev_buffer
= current_buffer
;
1246 prev_modiff
= MODIFF
;
1247 last_point_position
= PT
;
1248 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1250 /* Execute the command. */
1253 /* Note that the value cell will never directly contain nil
1254 if the symbol is a local variable. */
1255 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1256 safe_run_hooks (Qpre_command_hook
);
1258 if (NILP (this_command
))
1260 /* nil means key is undefined. */
1262 current_kboard
->defining_kbd_macro
= Qnil
;
1263 update_mode_lines
= 1;
1264 current_kboard
->Vprefix_arg
= Qnil
;
1268 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1270 /* Recognize some common commands in common situations and
1271 do them directly. */
1272 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1274 struct Lisp_Char_Table
*dp
1275 = window_display_table (XWINDOW (selected_window
));
1276 lose
= FETCH_BYTE (PT
);
1277 SET_PT (forward_point (1));
1279 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1280 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1281 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1282 && (lose
>= 0x20 && lose
< 0x7f)))
1283 : (lose
>= 0x20 && lose
< 0x7f))
1284 /* To extract the case of continuation on
1285 wide-column characters. */
1286 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT
)) == 1)
1287 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1289 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1291 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1293 && !windows_or_buffers_changed
1294 && EQ (current_buffer
->selective_display
, Qnil
)
1295 && !detect_input_pending ()
1296 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1297 && NILP (Vexecuting_macro
))
1298 no_redisplay
= direct_output_forward_char (1);
1301 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1303 struct Lisp_Char_Table
*dp
1304 = window_display_table (XWINDOW (selected_window
));
1305 SET_PT (forward_point (-1));
1306 lose
= FETCH_BYTE (PT
);
1308 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1309 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1310 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1311 && (lose
>= 0x20 && lose
< 0x7f)))
1312 : (lose
>= 0x20 && lose
< 0x7f))
1313 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1315 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1317 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1319 && !windows_or_buffers_changed
1320 && EQ (current_buffer
->selective_display
, Qnil
)
1321 && !detect_input_pending ()
1322 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1323 && NILP (Vexecuting_macro
))
1324 no_redisplay
= direct_output_forward_char (-1);
1327 else if (EQ (this_command
, Qself_insert_command
)
1328 /* Try this optimization only on ascii keystrokes. */
1329 && INTEGERP (last_command_char
))
1331 unsigned int c
= XINT (last_command_char
);
1334 if (NILP (Vexecuting_macro
)
1335 && !EQ (minibuf_window
, selected_window
))
1337 if (!nonundocount
|| nonundocount
>= 20)
1344 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1346 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1348 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1350 || MODIFF
<= SAVE_MODIFF
1351 || windows_or_buffers_changed
1352 || !EQ (current_buffer
->selective_display
, Qnil
)
1353 || detect_input_pending ()
1354 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1355 || !NILP (Vexecuting_macro
));
1356 value
= internal_self_insert (c
, 0);
1363 && (PT
== ZV
|| FETCH_BYTE (PT
) == '\n'))
1365 struct Lisp_Char_Table
*dp
1366 = window_display_table (XWINDOW (selected_window
));
1373 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1376 /* Do it only for char codes
1377 that by default display as themselves. */
1378 if (lose
>= 0x20 && lose
<= 0x7e)
1379 no_redisplay
= direct_output_for_insert (lose
);
1381 else if (VECTORP (obj
)
1382 && XVECTOR (obj
)->size
== 1
1383 && (obj
= XVECTOR (obj
)->contents
[0],
1385 /* Insist face not specified in glyph. */
1386 && (XINT (obj
) & ((-1) << 8)) == 0)
1388 = direct_output_for_insert (XINT (obj
));
1392 if (lose
>= 0x20 && lose
<= 0x7e)
1393 no_redisplay
= direct_output_for_insert (lose
);
1400 /* Here for a command that isn't executed directly */
1403 if (NILP (current_kboard
->Vprefix_arg
))
1405 Fcommand_execute (this_command
, Qnil
, Qnil
, Qnil
);
1410 /* If there is a prefix argument,
1411 1) We don't want Vlast_command to be ``universal-argument''
1412 (that would be dumb), so don't set Vlast_command,
1413 2) we want to leave echoing on so that the prefix will be
1414 echoed as part of this key sequence, so don't call
1416 3) we want to leave this_command_key_count non-zero, so that
1417 read_char will realize that it is re-reading a character, and
1418 not echo it a second time.
1420 If the command didn't actually create a prefix arg,
1421 but is merely a frame event that is transparent to prefix args,
1422 then the above doesn't apply. */
1423 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1425 current_kboard
->Vlast_command
= this_command
;
1427 this_command_key_count
= 0;
1428 this_single_command_key_start
= 0;
1431 /* Note that the value cell will never directly contain nil
1432 if the symbol is a local variable. */
1433 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1434 safe_run_hooks (Qpost_command_hook
);
1436 if (!NILP (Vdeferred_action_list
))
1437 safe_run_hooks (Qdeferred_action_function
);
1439 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1441 if (NILP (Vunread_command_events
)
1442 && NILP (Vexecuting_macro
)
1443 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1444 safe_run_hooks (Qpost_command_idle_hook
);
1447 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1449 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1451 current_buffer
->mark_active
= Qnil
;
1452 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1454 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1455 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1459 /* Install chars successfully executed in kbd macro. */
1461 if (!NILP (current_kboard
->defining_kbd_macro
)
1462 && NILP (current_kboard
->Vprefix_arg
))
1463 finalize_kbd_macro_chars ();
1467 any_kboard_state ();
1472 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1475 safe_run_hooks_1 (hook
)
1478 return call1 (Vrun_hooks
, Vinhibit_quit
);
1481 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1484 safe_run_hooks_error (data
)
1487 Fset (Vinhibit_quit
, Qnil
);
1490 /* If we get an error while running the hook, cause the hook variable
1491 to be nil. Also inhibit quits, so that C-g won't cause the hook
1492 to mysteriously evaporate. */
1495 safe_run_hooks (hook
)
1499 int count
= specpdl_ptr
- specpdl
;
1500 specbind (Qinhibit_quit
, hook
);
1502 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1504 unbind_to (count
, Qnil
);
1507 /* Number of seconds between polling for input. */
1510 /* Nonzero means polling for input is temporarily suppressed. */
1511 int poll_suppress_count
;
1513 /* Nonzero if polling_for_input is actually being used. */
1514 int polling_for_input
;
1516 #ifdef POLL_FOR_INPUT
1518 /* Handle an alarm once each second and read pending input
1519 so as to handle a C-g if it comces in. */
1522 input_poll_signal (signalnum
) /* If we don't have an argument, */
1523 int signalnum
; /* some compilers complain in signal calls. */
1525 /* This causes the call to start_polling at the end
1526 to do its job. It also arranges for a quit or error
1527 from within read_avail_input to resume polling. */
1528 poll_suppress_count
++;
1529 if (interrupt_input_blocked
== 0
1530 && !waiting_for_input
)
1531 read_avail_input (0);
1532 /* Turn on the SIGALRM handler and request another alarm. */
1538 /* Begin signals to poll for input, if they are appropriate.
1539 This function is called unconditionally from various places. */
1543 #ifdef POLL_FOR_INPUT
1544 if (read_socket_hook
&& !interrupt_input
)
1546 poll_suppress_count
--;
1547 if (poll_suppress_count
== 0)
1549 signal (SIGALRM
, input_poll_signal
);
1550 polling_for_input
= 1;
1551 alarm (polling_period
);
1557 /* Nonzero if we are using polling to handle input asynchronously. */
1560 input_polling_used ()
1562 #ifdef POLL_FOR_INPUT
1563 return read_socket_hook
&& !interrupt_input
;
1569 /* Turn off polling. */
1573 #ifdef POLL_FOR_INPUT
1574 if (read_socket_hook
&& !interrupt_input
)
1576 if (poll_suppress_count
== 0)
1578 polling_for_input
= 0;
1581 poll_suppress_count
++;
1586 /* Set the value of poll_suppress_count to COUNT
1587 and start or stop polling accordingly. */
1590 set_poll_suppress_count (count
)
1593 #ifdef POLL_FOR_INPUT
1594 if (count
== 0 && poll_suppress_count
!= 0)
1596 poll_suppress_count
= 1;
1599 else if (count
!= 0 && poll_suppress_count
== 0)
1603 poll_suppress_count
= count
;
1607 /* Bind polling_period to a value at least N.
1608 But don't decrease it. */
1610 bind_polling_period (n
)
1613 #ifdef POLL_FOR_INPUT
1614 int new = polling_period
;
1620 specbind (Qpolling_period
, make_number (new));
1621 /* Start a new alarm with the new period. */
1626 /* Apply the control modifier to CHARACTER. */
1632 /* Save the upper bits here. */
1633 int upper
= c
& ~0177;
1637 /* Everything in the columns containing the upper-case letters
1638 denotes a control character. */
1639 if (c
>= 0100 && c
< 0140)
1643 /* Set the shift modifier for a control char
1644 made from a shifted letter. But only for letters! */
1645 if (oc
>= 'A' && oc
<= 'Z')
1646 c
|= shift_modifier
;
1649 /* The lower-case letters denote control characters too. */
1650 else if (c
>= 'a' && c
<= 'z')
1653 /* Include the bits for control and shift
1654 only if the basic ASCII code can't indicate them. */
1658 /* Replace the high bits. */
1659 c
|= (upper
& ~ctrl_modifier
);
1666 /* Input of single characters from keyboard */
1668 Lisp_Object
print_help ();
1669 static Lisp_Object
kbd_buffer_get_event ();
1670 static void record_char ();
1673 static jmp_buf wrong_kboard_jmpbuf
;
1676 /* read a character from the keyboard; call the redisplay if needed */
1677 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1678 -1 means do not do redisplay, but do do autosaving.
1681 /* The arguments MAPS and NMAPS are for menu prompting.
1682 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1684 PREV_EVENT is the previous input event, or nil if we are reading
1685 the first event of a key sequence.
1687 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
1688 if we used a mouse menu to read the input, or zero otherwise. If
1689 USED_MOUSE_MENU is null, we don't dereference it.
1691 Value is t if we showed a menu and the user rejected it. */
1694 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1698 Lisp_Object prev_event
;
1699 int *used_mouse_menu
;
1701 register Lisp_Object c
;
1703 jmp_buf local_getcjmp
;
1705 int key_already_recorded
= 0;
1706 Lisp_Object tem
, save
;
1707 Lisp_Object also_record
;
1710 before_command_key_count
= this_command_key_count
;
1711 before_command_echo_length
= echo_length ();
1715 if (CONSP (Vunread_command_events
))
1717 c
= XCONS (Vunread_command_events
)->car
;
1718 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1720 /* Undo what read_char_x_menu_prompt did when it unread
1721 additional keys returned by Fx_popup_menu. */
1723 && (SYMBOLP (XCONS (c
)->car
) || INTEGERP (XCONS (c
)->car
))
1724 && NILP (XCONS (c
)->cdr
))
1727 if (this_command_key_count
== 0)
1733 if (unread_command_char
!= -1)
1735 XSETINT (c
, unread_command_char
);
1736 unread_command_char
= -1;
1738 if (this_command_key_count
== 0)
1744 /* If there is no function key translated before
1745 reset-this-command-lengths takes effect, forget about it. */
1746 before_command_restore_flag
= 0;
1748 if (!NILP (Vexecuting_macro
))
1750 /* We set this to Qmacro; since that's not a frame, nobody will
1751 try to switch frames on us, and the selected window will
1754 Since this event came from a macro, it would be misleading to
1755 leave internal_last_event_frame set to wherever the last
1756 real event came from. Normally, a switch-frame event selects
1757 internal_last_event_frame after each command is read, but
1758 events read from a macro should never cause a new frame to be
1760 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1762 /* Exit the macro if we are at the end.
1763 Also, some things replace the macro with t
1764 to force an early exit. */
1765 if (EQ (Vexecuting_macro
, Qt
)
1766 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1772 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1773 if (STRINGP (Vexecuting_macro
)
1774 && (XINT (c
) & 0x80))
1775 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
1777 executing_macro_index
++;
1782 if (!NILP (unread_switch_frame
))
1784 c
= unread_switch_frame
;
1785 unread_switch_frame
= Qnil
;
1787 /* This event should make it into this_command_keys, and get echoed
1788 again, so we go to reread_first, rather than reread. */
1792 if (commandflag
>= 0)
1795 || detect_input_pending_run_timers (0))
1802 /* Message turns off echoing unless more keystrokes turn it on again. */
1803 if (echo_area_glyphs
&& *echo_area_glyphs
1804 && echo_area_glyphs
!= current_kboard
->echobuf
1805 && ok_to_echo_at_next_pause
!= echo_area_glyphs
)
1808 /* If already echoing, continue. */
1811 /* Try reading a character via menu prompting in the minibuf.
1812 Try this before the sit-for, because the sit-for
1813 would do the wrong thing if we are supposed to do
1814 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1815 after a mouse event so don't try a minibuf menu. */
1817 if (nmaps
> 0 && INTERACTIVE
1818 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1819 /* Don't bring up a menu if we already have another event. */
1820 && NILP (Vunread_command_events
)
1821 && unread_command_char
< 0
1822 && !detect_input_pending_run_timers (0))
1824 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1827 key_already_recorded
= 1;
1832 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
1833 We will do that below, temporarily for short sections of code,
1834 when appropriate. local_getcjmp must be in effect
1835 around any call to sit_for or kbd_buffer_get_event;
1836 it *must not* be in effect when we call redisplay. */
1838 if (_setjmp (local_getcjmp
))
1840 XSETINT (c
, quit_char
);
1841 XSETFRAME (internal_last_event_frame
, selected_frame
);
1842 Vlast_event_frame
= internal_last_event_frame
;
1843 /* If we report the quit char as an event,
1844 don't do so more than once. */
1845 if (!NILP (Vinhibit_quit
))
1850 KBOARD
*kb
= FRAME_KBOARD (selected_frame
);
1851 if (kb
!= current_kboard
)
1853 Lisp_Object
*tailp
= &kb
->kbd_queue
;
1854 /* We shouldn't get here if we were in single-kboard mode! */
1857 while (CONSP (*tailp
))
1858 tailp
= &XCONS (*tailp
)->cdr
;
1861 *tailp
= Fcons (c
, Qnil
);
1862 kb
->kbd_queue_has_data
= 1;
1863 current_kboard
= kb
;
1864 longjmp (wrong_kboard_jmpbuf
, 1);
1871 timer_start_idle ();
1873 /* If in middle of key sequence and minibuffer not active,
1874 start echoing if enough time elapses. */
1876 if (minibuf_level
== 0 && !current_kboard
->immediate_echo
1877 && this_command_key_count
> 0
1879 && echo_keystrokes
> 0
1880 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0
1881 || ok_to_echo_at_next_pause
== echo_area_glyphs
))
1885 /* After a mouse event, start echoing right away.
1886 This is because we are probably about to display a menu,
1887 and we don't want to delay before doing so. */
1888 if (EVENT_HAS_PARAMETERS (prev_event
))
1892 save_getcjmp (save_jump
);
1893 restore_getcjmp (local_getcjmp
);
1894 tem0
= sit_for (echo_keystrokes
, 0, 1, 1, 0);
1895 restore_getcjmp (save_jump
);
1897 && ! CONSP (Vunread_command_events
))
1902 /* Maybe auto save due to number of keystrokes. */
1904 if (commandflag
!= 0
1905 && auto_save_interval
> 0
1906 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
1907 && !detect_input_pending_run_timers (0))
1909 Fdo_auto_save (Qnil
, Qnil
);
1910 /* Hooks can actually change some buffers in auto save. */
1914 /* Try reading using an X menu.
1915 This is never confused with reading using the minibuf
1916 because the recursive call of read_char in read_char_minibuf_menu_prompt
1917 does not pass on any keymaps. */
1919 if (nmaps
> 0 && INTERACTIVE
1920 && !NILP (prev_event
)
1921 && EVENT_HAS_PARAMETERS (prev_event
)
1922 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
)
1923 /* Don't bring up a menu if we already have another event. */
1924 && NILP (Vunread_command_events
)
1925 && unread_command_char
< 0)
1927 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1929 /* Now that we have read an event, Emacs is not idle. */
1935 /* Maybe autosave and/or garbage collect due to idleness. */
1937 if (INTERACTIVE
&& NILP (c
))
1939 int delay_level
, buffer_size
;
1941 /* Slow down auto saves logarithmically in size of current buffer,
1942 and garbage collect while we're at it. */
1943 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1944 last_non_minibuf_size
= Z
- BEG
;
1945 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1947 while (buffer_size
> 64)
1948 delay_level
++, buffer_size
-= buffer_size
>> 2;
1949 if (delay_level
< 4) delay_level
= 4;
1950 /* delay_level is 4 for files under around 50k, 7 at 100k,
1951 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1953 /* Auto save if enough time goes by without input. */
1954 if (commandflag
!= 0
1955 && num_nonmacro_input_events
> last_auto_save
1956 && INTEGERP (Vauto_save_timeout
)
1957 && XINT (Vauto_save_timeout
) > 0)
1961 save_getcjmp (save_jump
);
1962 restore_getcjmp (local_getcjmp
);
1963 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
1965 restore_getcjmp (save_jump
);
1968 && ! CONSP (Vunread_command_events
))
1970 Fdo_auto_save (Qnil
, Qnil
);
1972 /* If we have auto-saved and there is still no input
1973 available, garbage collect if there has been enough
1974 consing going on to make it worthwhile. */
1975 if (!detect_input_pending_run_timers (0)
1976 && consing_since_gc
> gc_cons_threshold
/ 2)
1977 Fgarbage_collect ();
1984 /* If this has become non-nil here, it has been set by a timer
1985 or sentinel or filter. */
1986 if (CONSP (Vunread_command_events
))
1988 c
= XCONS (Vunread_command_events
)->car
;
1989 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1992 /* Read something from current KBOARD's side queue, if possible. */
1996 if (current_kboard
->kbd_queue_has_data
)
1998 if (!CONSP (current_kboard
->kbd_queue
))
2000 c
= XCONS (current_kboard
->kbd_queue
)->car
;
2001 current_kboard
->kbd_queue
2002 = XCONS (current_kboard
->kbd_queue
)->cdr
;
2003 if (NILP (current_kboard
->kbd_queue
))
2004 current_kboard
->kbd_queue_has_data
= 0;
2005 input_pending
= readable_events (0);
2006 if (EVENT_HAS_PARAMETERS (c
)
2007 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2008 internal_last_event_frame
= XCONS (XCONS (c
)->cdr
)->car
;
2009 Vlast_event_frame
= internal_last_event_frame
;
2014 /* If current_kboard's side queue is empty check the other kboards.
2015 If one of them has data that we have not yet seen here,
2016 switch to it and process the data waiting for it.
2018 Note: if the events queued up for another kboard
2019 have already been seen here, and therefore are not a complete command,
2020 the kbd_queue_has_data field is 0, so we skip that kboard here.
2021 That's to avoid an infinite loop switching between kboards here. */
2022 if (NILP (c
) && !single_kboard
)
2025 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2026 if (kb
->kbd_queue_has_data
)
2028 current_kboard
= kb
;
2029 longjmp (wrong_kboard_jmpbuf
, 1);
2038 /* Finally, we read from the main queue,
2039 and if that gives us something we can't use yet, we put it on the
2040 appropriate side queue and try again. */
2046 /* Actually read a character, waiting if necessary. */
2047 save_getcjmp (save_jump
);
2048 restore_getcjmp (local_getcjmp
);
2049 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2050 restore_getcjmp (save_jump
);
2053 if (! NILP (c
) && (kb
!= current_kboard
))
2055 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2056 while (CONSP (*tailp
))
2057 tailp
= &XCONS (*tailp
)->cdr
;
2060 *tailp
= Fcons (c
, Qnil
);
2061 kb
->kbd_queue_has_data
= 1;
2065 current_kboard
= kb
;
2066 longjmp (wrong_kboard_jmpbuf
, 1);
2071 /* Terminate Emacs in batch mode if at eof. */
2072 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2073 Fkill_emacs (make_number (1));
2077 /* Add in any extra modifiers, where appropriate. */
2078 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2079 || ((extra_keyboard_modifiers
& 0177) < ' '
2080 && (extra_keyboard_modifiers
& 0177) != 0))
2081 XSETINT (c
, make_ctrl_char (XINT (c
)));
2083 /* Transfer any other modifier bits directly from
2084 extra_keyboard_modifiers to c. Ignore the actual character code
2085 in the low 16 bits of extra_keyboard_modifiers. */
2086 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2097 if (commandflag
>= 0
2098 && !input_pending
&& !detect_input_pending_run_timers (0))
2106 /* Buffer switch events are only for internal wakeups
2107 so don't show them to the user. */
2111 if (key_already_recorded
)
2114 /* Process special events within read_char
2115 and loop around to read another event. */
2118 tem
= get_keyelt (access_keymap (get_keymap_1 (Vspecial_event_map
, 0, 0),
2124 int was_locked
= single_kboard
;
2126 last_input_char
= c
;
2127 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2129 /* Resume allowing input from any kboard, if that was true before. */
2131 any_kboard_state ();
2136 /* Wipe the echo area. */
2137 if (echo_area_glyphs
)
2138 safe_run_hooks (Qecho_area_clear_hook
);
2139 echo_area_glyphs
= 0;
2141 /* Handle things that only apply to characters. */
2144 /* If kbd_buffer_get_event gave us an EOF, return that. */
2148 if (STRINGP (Vkeyboard_translate_table
)
2149 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2150 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
2151 else if ((VECTORP (Vkeyboard_translate_table
)
2152 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2153 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2154 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2157 d
= Faref (Vkeyboard_translate_table
, c
);
2158 /* nil in keyboard-translate-table means no translation. */
2164 /* If this event is a mouse click in the menu bar,
2165 return just menu-bar for now. Modify the mouse click event
2166 so we won't do this twice, then queue it up. */
2167 if (EVENT_HAS_PARAMETERS (c
)
2168 && CONSP (XCONS (c
)->cdr
)
2169 && CONSP (EVENT_START (c
))
2170 && CONSP (XCONS (EVENT_START (c
))->cdr
))
2174 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2175 /* Handle menu-bar events:
2176 insert the dummy prefix event `menu-bar'. */
2177 if (EQ (posn
, Qmenu_bar
))
2179 /* Change menu-bar to (menu-bar) as the event "position". */
2180 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2183 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2189 if (! NILP (also_record
))
2190 record_char (also_record
);
2194 before_command_key_count
= this_command_key_count
;
2195 before_command_echo_length
= echo_length ();
2197 /* Don't echo mouse motion events. */
2199 && ! (EVENT_HAS_PARAMETERS (c
)
2200 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2203 if (! NILP (also_record
))
2204 echo_char (also_record
);
2205 /* Once we reread a character, echoing can happen
2206 the next time we pause to read a new one. */
2207 ok_to_echo_at_next_pause
= echo_area_glyphs
;
2210 /* Record this character as part of the current key. */
2211 add_command_key (c
);
2212 if (! NILP (also_record
))
2213 add_command_key (also_record
);
2215 /* Re-reading in the middle of a command */
2217 last_input_char
= c
;
2220 /* Process the help character specially if enabled */
2221 if (!NILP (Vhelp_form
) && help_char_p (c
))
2224 count
= specpdl_ptr
- specpdl
;
2226 record_unwind_protect (Fset_window_configuration
,
2227 Fcurrent_window_configuration (Qnil
));
2229 tem0
= Feval (Vhelp_form
);
2231 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2235 c
= read_char (0, 0, 0, Qnil
, 0);
2236 while (BUFFERP (c
));
2237 /* Remove the help from the frame */
2238 unbind_to (count
, Qnil
);
2241 if (EQ (c
, make_number (040)))
2245 c
= read_char (0, 0, 0, Qnil
, 0);
2246 while (BUFFERP (c
));
2253 /* Record a key that came from a mouse menu.
2254 Record it for echoing, for this-command-keys, and so on. */
2260 /* Wipe the echo area. */
2261 echo_area_glyphs
= 0;
2265 before_command_key_count
= this_command_key_count
;
2266 before_command_echo_length
= echo_length ();
2268 /* Don't echo mouse motion events. */
2269 if (echo_keystrokes
)
2273 /* Once we reread a character, echoing can happen
2274 the next time we pause to read a new one. */
2275 ok_to_echo_at_next_pause
= 0;
2278 /* Record this character as part of the current key. */
2279 add_command_key (c
);
2281 /* Re-reading in the middle of a command */
2282 last_input_char
= c
;
2286 /* Return 1 if should recognize C as "the help character". */
2294 if (EQ (c
, Vhelp_char
))
2296 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2297 if (EQ (c
, XCONS (tail
)->car
))
2302 /* Record the input event C in various ways. */
2309 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
2310 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2311 recent_keys_index
= 0;
2313 /* Write c to the dribble file. If c is a lispy event, write
2314 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2315 If you, dear reader, have a better idea, you've got the source. :-) */
2320 if (XUINT (c
) < 0x100)
2321 putc (XINT (c
), dribble
);
2323 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
2327 Lisp_Object dribblee
;
2329 /* If it's a structured event, take the event header. */
2330 dribblee
= EVENT_HEAD (c
);
2332 if (SYMBOLP (dribblee
))
2334 putc ('<', dribble
);
2335 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
2336 XSYMBOL (dribblee
)->name
->size
,
2338 putc ('>', dribble
);
2345 store_kbd_macro_char (c
);
2347 num_nonmacro_input_events
++;
2354 struct buffer
*old
= current_buffer
;
2355 Fprinc (object
, Qnil
);
2356 set_buffer_internal (XBUFFER (Vstandard_output
));
2357 call0 (intern ("help-mode"));
2358 set_buffer_internal (old
);
2362 /* Copy out or in the info on where C-g should throw to.
2363 This is used when running Lisp code from within get_char,
2364 in case get_char is called recursively.
2365 See read_process_output. */
2370 bcopy (getcjmp
, temp
, sizeof getcjmp
);
2373 restore_getcjmp (temp
)
2376 bcopy (temp
, getcjmp
, sizeof getcjmp
);
2381 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
2382 of this function. */
2385 tracking_off (old_value
)
2386 Lisp_Object old_value
;
2388 do_mouse_tracking
= old_value
;
2389 if (NILP (old_value
))
2391 /* Redisplay may have been preempted because there was input
2392 available, and it assumes it will be called again after the
2393 input has been processed. If the only input available was
2394 the sort that we have just disabled, then we need to call
2396 if (!readable_events (1))
2398 redisplay_preserve_echo_area ();
2399 get_input_pending (&input_pending
, 1);
2404 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
2405 "Evaluate BODY with mouse movement events enabled.\n\
2406 Within a `track-mouse' form, mouse motion generates input events that\n\
2407 you can read with `read-event'.\n\
2408 Normally, mouse motion is ignored.")
2412 int count
= specpdl_ptr
- specpdl
;
2415 record_unwind_protect (tracking_off
, do_mouse_tracking
);
2417 do_mouse_tracking
= Qt
;
2419 val
= Fprogn (args
);
2420 return unbind_to (count
, val
);
2423 /* If mouse has moved on some frame, return one of those frames.
2424 Return 0 otherwise. */
2429 Lisp_Object tail
, frame
;
2431 FOR_EACH_FRAME (tail
, frame
)
2433 if (XFRAME (frame
)->mouse_moved
)
2434 return XFRAME (frame
);
2440 #endif /* HAVE_MOUSE */
2442 /* Low level keyboard/mouse input.
2443 kbd_buffer_store_event places events in kbd_buffer, and
2444 kbd_buffer_get_event retrieves them. */
2446 /* Return true iff there are any events in the queue that read-char
2447 would return. If this returns false, a read-char would block. */
2449 readable_events (do_timers_now
)
2453 timer_check (do_timers_now
);
2455 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2458 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2463 if (current_kboard
->kbd_queue_has_data
)
2469 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2470 if (kb
->kbd_queue_has_data
)
2476 /* Set this for debugging, to have a way to get out */
2481 event_to_kboard (event
)
2482 struct input_event
*event
;
2485 frame
= event
->frame_or_window
;
2487 frame
= XCONS (frame
)->car
;
2488 else if (WINDOWP (frame
))
2489 frame
= WINDOW_FRAME (XWINDOW (frame
));
2491 /* There are still some events that don't set this field.
2492 For now, just ignore the problem.
2493 Also ignore dead frames here. */
2494 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
2497 return FRAME_KBOARD (XFRAME (frame
));
2501 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
2504 kbd_buffer_store_event (event
)
2505 register struct input_event
*event
;
2507 if (event
->kind
== no_event
)
2510 if (event
->kind
== ascii_keystroke
)
2512 register int c
= event
->code
& 0377;
2514 if (event
->modifiers
& ctrl_modifier
)
2515 c
= make_ctrl_char (c
);
2517 c
|= (event
->modifiers
2518 & (meta_modifier
| alt_modifier
2519 | hyper_modifier
| super_modifier
));
2523 extern SIGTYPE
interrupt_signal ();
2526 struct input_event
*sp
;
2529 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
2530 kb
!= current_kboard
))
2533 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
2534 Fcons (make_number (c
), Qnil
));
2535 kb
->kbd_queue_has_data
= 1;
2536 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2538 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2541 if (event_to_kboard (sp
) == kb
)
2543 sp
->kind
= no_event
;
2544 sp
->frame_or_window
= Qnil
;
2551 /* If this results in a quit_char being returned to Emacs as
2552 input, set Vlast_event_frame properly. If this doesn't
2553 get returned to Emacs as an event, the next event read
2554 will set Vlast_event_frame again, so this is safe to do. */
2558 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
2560 focus
= event
->frame_or_window
;
2561 internal_last_event_frame
= focus
;
2562 Vlast_event_frame
= focus
;
2565 last_event_timestamp
= event
->timestamp
;
2566 interrupt_signal ();
2570 if (c
&& c
== stop_character
)
2576 /* Don't insert two buffer_switch_event's in a row.
2577 Just ignore the second one. */
2578 else if (event
->kind
== buffer_switch_event
2579 && kbd_fetch_ptr
!= kbd_store_ptr
2580 && kbd_store_ptr
->kind
== buffer_switch_event
)
2583 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
2584 kbd_store_ptr
= kbd_buffer
;
2586 /* Don't let the very last slot in the buffer become full,
2587 since that would make the two pointers equal,
2588 and that is indistinguishable from an empty buffer.
2589 Discard the event if it would fill the last slot. */
2590 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
2592 volatile struct input_event
*sp
= kbd_store_ptr
;
2593 sp
->kind
= event
->kind
;
2594 if (event
->kind
== selection_request_event
)
2596 /* We must not use the ordinary copying code for this case,
2597 since `part' is an enum and copying it might not copy enough
2599 bcopy (event
, (char *) sp
, sizeof (*event
));
2603 sp
->code
= event
->code
;
2604 sp
->part
= event
->part
;
2605 sp
->frame_or_window
= event
->frame_or_window
;
2606 sp
->modifiers
= event
->modifiers
;
2609 sp
->timestamp
= event
->timestamp
;
2611 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
2613 = event
->frame_or_window
);
2619 /* Read one event from the event buffer, waiting if necessary.
2620 The value is a Lisp object representing the event.
2621 The value is nil for an event that should be ignored,
2622 or that was handled here.
2623 We always read and discard one event. */
2626 kbd_buffer_get_event (kbp
, used_mouse_menu
)
2628 int *used_mouse_menu
;
2632 EMACS_TIME next_timer_delay
;
2638 *kbp
= current_kboard
;
2642 /* Wait until there is input available. */
2645 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2648 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2652 /* If the quit flag is set, then read_char will return
2653 quit_char, so that counts as "available input." */
2654 if (!NILP (Vquit_flag
))
2655 quit_throw_to_read_char ();
2657 /* One way or another, wait until input is available; then, if
2658 interrupt handlers have not read it, read it now. */
2661 wait_for_kbd_input ();
2663 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2667 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2670 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2674 Lisp_Object minus_one
;
2676 XSETINT (minus_one
, -1);
2677 wait_reading_process_input (0, 0, minus_one
, 1);
2679 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
2680 /* Pass 1 for EXPECT since we just waited to have input. */
2681 read_avail_input (1);
2683 #endif /* not VMS */
2686 if (CONSP (Vunread_command_events
))
2689 first
= XCONS (Vunread_command_events
)->car
;
2690 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
2691 *kbp
= current_kboard
;
2695 /* At this point, we know that there is a readable event available
2696 somewhere. If the event queue is empty, then there must be a
2697 mouse movement enabled and available. */
2698 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2700 struct input_event
*event
;
2702 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2706 last_event_timestamp
= event
->timestamp
;
2709 *kbp
= event_to_kboard (event
);
2711 *kbp
= current_kboard
; /* Better than returning null ptr? */
2713 *kbp
= &the_only_kboard
;
2718 /* These two kinds of events get special handling
2719 and don't actually appear to the command loop.
2720 We return nil for them. */
2721 if (event
->kind
== selection_request_event
)
2724 struct input_event copy
;
2726 /* Remove it from the buffer before processing it,
2727 since otherwise swallow_events will see it
2728 and process it again. */
2730 kbd_fetch_ptr
= event
+ 1;
2731 input_pending
= readable_events (0);
2732 x_handle_selection_request (©
);
2734 /* We're getting selection request events, but we don't have
2740 else if (event
->kind
== selection_clear_event
)
2743 struct input_event copy
;
2745 /* Remove it from the buffer before processing it. */
2747 kbd_fetch_ptr
= event
+ 1;
2748 input_pending
= readable_events (0);
2749 x_handle_selection_clear (©
);
2751 /* We're getting selection request events, but we don't have
2756 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
2757 else if (event
->kind
== delete_window_event
)
2759 /* Make an event (delete-frame (FRAME)). */
2760 obj
= Fcons (event
->frame_or_window
, Qnil
);
2761 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
2762 kbd_fetch_ptr
= event
+ 1;
2764 else if (event
->kind
== iconify_event
)
2766 /* Make an event (iconify-frame (FRAME)). */
2767 obj
= Fcons (event
->frame_or_window
, Qnil
);
2768 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
2769 kbd_fetch_ptr
= event
+ 1;
2771 else if (event
->kind
== deiconify_event
)
2773 /* Make an event (make-frame-visible (FRAME)). */
2774 obj
= Fcons (event
->frame_or_window
, Qnil
);
2775 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
2776 kbd_fetch_ptr
= event
+ 1;
2779 else if (event
->kind
== buffer_switch_event
)
2781 /* The value doesn't matter here; only the type is tested. */
2782 XSETBUFFER (obj
, current_buffer
);
2783 kbd_fetch_ptr
= event
+ 1;
2785 #ifdef USE_X_TOOLKIT
2786 else if (event
->kind
== menu_bar_activate_event
)
2788 kbd_fetch_ptr
= event
+ 1;
2789 input_pending
= readable_events (0);
2790 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
2791 x_activate_menubar (XFRAME (event
->frame_or_window
));
2794 /* Just discard these, by returning nil.
2795 With MULTI_KBOARD, these events are used as placeholders
2796 when we need to randomly delete events from the queue.
2797 (They shouldn't otherwise be found in the buffer,
2798 but on some machines it appears they do show up
2799 even without MULTI_KBOARD.) */
2800 else if (event
->kind
== no_event
)
2801 kbd_fetch_ptr
= event
+ 1;
2803 /* If this event is on a different frame, return a switch-frame this
2804 time, and leave the event in the queue for next time. */
2810 frame
= event
->frame_or_window
;
2812 frame
= XCONS (frame
)->car
;
2813 else if (WINDOWP (frame
))
2814 frame
= WINDOW_FRAME (XWINDOW (frame
));
2816 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2820 if (! EQ (frame
, internal_last_event_frame
)
2821 && XFRAME (frame
) != selected_frame
)
2822 obj
= make_lispy_switch_frame (frame
);
2823 internal_last_event_frame
= frame
;
2825 /* If we didn't decide to make a switch-frame event, go ahead
2826 and build a real event from the queue entry. */
2830 obj
= make_lispy_event (event
);
2831 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2832 /* If this was a menu selection, then set the flag to inhibit
2833 writing to last_nonmenu_event. Don't do this if the event
2834 we're returning is (menu-bar), though; that indicates the
2835 beginning of the menu sequence, and we might as well leave
2836 that as the `event with parameters' for this selection. */
2837 if (event
->kind
== menu_bar_event
2838 && !(CONSP (obj
) && EQ (XCONS (obj
)->car
, Qmenu_bar
))
2840 *used_mouse_menu
= 1;
2843 /* Wipe out this event, to catch bugs. */
2844 event
->kind
= no_event
;
2845 XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
] = Qnil
;
2847 kbd_fetch_ptr
= event
+ 1;
2852 /* Try generating a mouse motion event. */
2853 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2855 FRAME_PTR f
= some_mouse_moved ();
2856 Lisp_Object bar_window
;
2857 enum scroll_bar_part part
;
2861 *kbp
= current_kboard
;
2862 /* Note that this uses F to determine which display to look at.
2863 If there is no valid info, it does not store anything
2864 so x remains nil. */
2866 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
2870 /* Decide if we should generate a switch-frame event. Don't
2871 generate switch-frame events for motion outside of all Emacs
2877 frame
= FRAME_FOCUS_FRAME (f
);
2879 XSETFRAME (frame
, f
);
2881 if (! EQ (frame
, internal_last_event_frame
)
2882 && XFRAME (frame
) != selected_frame
)
2883 obj
= make_lispy_switch_frame (frame
);
2884 internal_last_event_frame
= frame
;
2887 /* If we didn't decide to make a switch-frame event, go ahead and
2888 return a mouse-motion event. */
2889 if (!NILP (x
) && NILP (obj
))
2890 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2892 #endif /* HAVE_MOUSE */
2894 /* We were promised by the above while loop that there was
2895 something for us to read! */
2898 input_pending
= readable_events (0);
2900 Vlast_event_frame
= internal_last_event_frame
;
2905 /* Process any events that are not user-visible,
2906 then return, without reading any user-visible events. */
2909 swallow_events (do_display
)
2914 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2916 struct input_event
*event
;
2918 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2922 last_event_timestamp
= event
->timestamp
;
2924 /* These two kinds of events get special handling
2925 and don't actually appear to the command loop. */
2926 if (event
->kind
== selection_request_event
)
2929 struct input_event copy
;
2931 /* Remove it from the buffer before processing it,
2932 since otherwise swallow_events called recursively could see it
2933 and process it again. */
2935 kbd_fetch_ptr
= event
+ 1;
2936 input_pending
= readable_events (0);
2937 x_handle_selection_request (©
);
2939 /* We're getting selection request events, but we don't have
2945 else if (event
->kind
== selection_clear_event
)
2948 struct input_event copy
;
2950 /* Remove it from the buffer before processing it, */
2953 kbd_fetch_ptr
= event
+ 1;
2954 input_pending
= readable_events (0);
2955 x_handle_selection_clear (©
);
2957 /* We're getting selection request events, but we don't have
2966 old_timers_run
= timers_run
;
2967 get_input_pending (&input_pending
, 1);
2969 if (timers_run
!= old_timers_run
&& do_display
)
2970 redisplay_preserve_echo_area ();
2973 static EMACS_TIME timer_idleness_start_time
;
2975 /* Record the start of when Emacs is idle,
2976 for the sake of running idle-time timers. */
2982 /* If we are already in the idle state, do nothing. */
2983 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
2986 EMACS_GET_TIME (timer_idleness_start_time
);
2988 /* Mark all idle-time timers as once again candidates for running. */
2989 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCONS (timers
)->cdr
)
2993 timer
= XCONS (timers
)->car
;
2995 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
2997 XVECTOR (timer
)->contents
[0] = Qnil
;
3001 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
3005 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
3008 /* This is only for debugging. */
3009 struct input_event last_timer_event
;
3011 /* Check whether a timer has fired. To prevent larger problems we simply
3012 disregard elements that are not proper timers. Do not make a circular
3013 timer list for the time being.
3015 Returns the number of seconds to wait until the next timer fires. If a
3016 timer is triggering now, return zero seconds.
3017 If no timer is active, return -1 seconds.
3019 If a timer is ripe, we run it, with quitting turned off.
3021 DO_IT_NOW is now ignored. It used to mean that we should
3022 run the timer directly instead of queueing a timer-event.
3023 Now we always run timers directly. */
3026 timer_check (do_it_now
)
3029 EMACS_TIME nexttime
;
3030 EMACS_TIME now
, idleness_now
;
3031 Lisp_Object timers
, idle_timers
, chosen_timer
;
3032 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3034 EMACS_SET_SECS (nexttime
, -1);
3035 EMACS_SET_USECS (nexttime
, -1);
3037 /* Always consider the ordinary timers. */
3038 timers
= Vtimer_list
;
3039 /* Consider the idle timers only if Emacs is idle. */
3040 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3041 idle_timers
= Vtimer_idle_list
;
3044 chosen_timer
= Qnil
;
3045 GCPRO3 (timers
, idle_timers
, chosen_timer
);
3047 if (CONSP (timers
) || CONSP (idle_timers
))
3049 EMACS_GET_TIME (now
);
3050 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3051 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
3054 while (CONSP (timers
) || CONSP (idle_timers
))
3056 int triggertime
= EMACS_SECS (now
);
3057 Lisp_Object
*vector
;
3058 Lisp_Object timer
, idle_timer
;
3059 EMACS_TIME timer_time
, idle_timer_time
;
3060 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
3062 /* Skip past invalid timers and timers already handled. */
3065 timer
= XCONS (timers
)->car
;
3066 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3068 timers
= XCONS (timers
)->cdr
;
3071 vector
= XVECTOR (timer
)->contents
;
3073 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3074 || !INTEGERP (vector
[3])
3075 || ! NILP (vector
[0]))
3077 timers
= XCONS (timers
)->cdr
;
3081 if (!NILP (idle_timers
))
3083 timer
= XCONS (idle_timers
)->car
;
3084 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3086 idle_timers
= XCONS (idle_timers
)->cdr
;
3089 vector
= XVECTOR (timer
)->contents
;
3091 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3092 || !INTEGERP (vector
[3])
3093 || ! NILP (vector
[0]))
3095 idle_timers
= XCONS (idle_timers
)->cdr
;
3100 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
3101 based on the next ordinary timer.
3102 TIMER_DIFFERENCE is the distance in time from NOW to when
3103 this timer becomes ripe (negative if it's already ripe). */
3106 timer
= XCONS (timers
)->car
;
3107 vector
= XVECTOR (timer
)->contents
;
3108 EMACS_SET_SECS (timer_time
,
3109 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3110 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
3111 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
3114 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
3115 based on the next idle timer. */
3116 if (!NILP (idle_timers
))
3118 idle_timer
= XCONS (idle_timers
)->car
;
3119 vector
= XVECTOR (idle_timer
)->contents
;
3120 EMACS_SET_SECS (idle_timer_time
,
3121 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3122 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
3123 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
3126 /* Decide which timer is the next timer,
3127 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
3128 Also step down the list where we found that timer. */
3130 if (! NILP (timers
) && ! NILP (idle_timers
))
3133 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
3134 if (EMACS_TIME_NEG_P (temp
))
3136 chosen_timer
= timer
;
3137 timers
= XCONS (timers
)->cdr
;
3138 difference
= timer_difference
;
3142 chosen_timer
= idle_timer
;
3143 idle_timers
= XCONS (idle_timers
)->cdr
;
3144 difference
= idle_timer_difference
;
3147 else if (! NILP (timers
))
3149 chosen_timer
= timer
;
3150 timers
= XCONS (timers
)->cdr
;
3151 difference
= timer_difference
;
3155 chosen_timer
= idle_timer
;
3156 idle_timers
= XCONS (idle_timers
)->cdr
;
3157 difference
= idle_timer_difference
;
3159 vector
= XVECTOR (chosen_timer
)->contents
;
3161 /* If timer is rupe, run it if it hasn't been run. */
3162 if (EMACS_TIME_NEG_P (difference
)
3163 || (EMACS_SECS (difference
) == 0
3164 && EMACS_USECS (difference
) == 0))
3166 if (NILP (vector
[0]))
3169 int was_locked
= single_kboard
;
3170 int count
= specpdl_ptr
- specpdl
;
3172 /* Mark the timer as triggered to prevent problems if the lisp
3173 code fails to reschedule it right. */
3176 specbind (Qinhibit_quit
, Qt
);
3178 call1 (Qtimer_event_handler
, chosen_timer
);
3181 unbind_to (count
, Qnil
);
3183 /* Resume allowing input from any kboard, if that was true before. */
3185 any_kboard_state ();
3187 /* Since we have handled the event,
3188 we don't need to tell the caller to wake up and do it. */
3192 /* When we encounter a timer that is still waiting,
3193 return the amount of time to wait before it is ripe. */
3200 /* No timers are pending in the future. */
3201 /* Return 0 if we generated an event, and -1 if not. */
3206 /* Caches for modify_event_symbol. */
3207 static Lisp_Object accent_key_syms
;
3208 static Lisp_Object func_key_syms
;
3209 static Lisp_Object mouse_syms
;
3211 /* This is a list of keysym codes for special "accent" characters.
3212 It parallels lispy_accent_keys. */
3214 static int lispy_accent_codes
[] =
3216 #ifdef XK_dead_circumflex
3221 #ifdef XK_dead_grave
3226 #ifdef XK_dead_tilde
3231 #ifdef XK_dead_diaeresis
3236 #ifdef XK_dead_macron
3241 #ifdef XK_dead_degree
3246 #ifdef XK_dead_acute
3251 #ifdef XK_dead_cedilla
3256 #ifdef XK_dead_breve
3261 #ifdef XK_dead_ogonek
3266 #ifdef XK_dead_caron
3271 #ifdef XK_dead_doubleacute
3272 XK_dead_doubleacute
,
3276 #ifdef XK_dead_abovedot
3283 /* This is a list of Lisp names for special "accent" characters.
3284 It parallels lispy_accent_codes. */
3286 static char *lispy_accent_keys
[] =
3304 #define FUNCTION_KEY_OFFSET 0x0
3306 char *lispy_function_keys
[] =
3310 0, /* VK_LBUTTON 0x01 */
3311 0, /* VK_RBUTTON 0x02 */
3312 "cancel", /* VK_CANCEL 0x03 */
3313 0, /* VK_MBUTTON 0x04 */
3315 0, 0, 0, /* 0x05 .. 0x07 */
3317 "backspace", /* VK_BACK 0x08 */
3318 "tab", /* VK_TAB 0x09 */
3320 0, 0, /* 0x0A .. 0x0B */
3322 "clear", /* VK_CLEAR 0x0C */
3323 "return", /* VK_RETURN 0x0D */
3325 0, 0, /* 0x0E .. 0x0F */
3327 "shift", /* VK_SHIFT 0x10 */
3328 "control", /* VK_CONTROL 0x11 */
3329 "menu", /* VK_MENU 0x12 */
3330 "pause", /* VK_PAUSE 0x13 */
3331 "capital", /* VK_CAPITAL 0x14 */
3333 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
3335 0, /* VK_ESCAPE 0x1B */
3337 0, 0, 0, 0, /* 0x1C .. 0x1F */
3339 0, /* VK_SPACE 0x20 */
3340 "prior", /* VK_PRIOR 0x21 */
3341 "next", /* VK_NEXT 0x22 */
3342 "end", /* VK_END 0x23 */
3343 "home", /* VK_HOME 0x24 */
3344 "left", /* VK_LEFT 0x25 */
3345 "up", /* VK_UP 0x26 */
3346 "right", /* VK_RIGHT 0x27 */
3347 "down", /* VK_DOWN 0x28 */
3348 "select", /* VK_SELECT 0x29 */
3349 "print", /* VK_PRINT 0x2A */
3350 "execute", /* VK_EXECUTE 0x2B */
3351 "snapshot", /* VK_SNAPSHOT 0x2C */
3352 "insert", /* VK_INSERT 0x2D */
3353 "delete", /* VK_DELETE 0x2E */
3354 "help", /* VK_HELP 0x2F */
3356 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
3358 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3360 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
3362 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
3364 0, 0, 0, 0, 0, 0, 0, 0, 0,
3365 0, 0, 0, 0, 0, 0, 0, 0, 0,
3366 0, 0, 0, 0, 0, 0, 0, 0,
3368 "lwindow", /* VK_LWIN 0x5B */
3369 "rwindow", /* VK_RWIN 0x5C */
3370 "apps", /* VK_APPS 0x5D */
3372 0, 0, /* 0x5E .. 0x5F */
3374 "kp-0", /* VK_NUMPAD0 0x60 */
3375 "kp-1", /* VK_NUMPAD1 0x61 */
3376 "kp-2", /* VK_NUMPAD2 0x62 */
3377 "kp-3", /* VK_NUMPAD3 0x63 */
3378 "kp-4", /* VK_NUMPAD4 0x64 */
3379 "kp-5", /* VK_NUMPAD5 0x65 */
3380 "kp-6", /* VK_NUMPAD6 0x66 */
3381 "kp-7", /* VK_NUMPAD7 0x67 */
3382 "kp-8", /* VK_NUMPAD8 0x68 */
3383 "kp-9", /* VK_NUMPAD9 0x69 */
3384 "kp-multiply", /* VK_MULTIPLY 0x6A */
3385 "kp-add", /* VK_ADD 0x6B */
3386 "kp-separator", /* VK_SEPARATOR 0x6C */
3387 "kp-subtract", /* VK_SUBTRACT 0x6D */
3388 "kp-decimal", /* VK_DECIMAL 0x6E */
3389 "kp-divide", /* VK_DIVIDE 0x6F */
3390 "f1", /* VK_F1 0x70 */
3391 "f2", /* VK_F2 0x71 */
3392 "f3", /* VK_F3 0x72 */
3393 "f4", /* VK_F4 0x73 */
3394 "f5", /* VK_F5 0x74 */
3395 "f6", /* VK_F6 0x75 */
3396 "f7", /* VK_F7 0x76 */
3397 "f8", /* VK_F8 0x77 */
3398 "f9", /* VK_F9 0x78 */
3399 "f10", /* VK_F10 0x79 */
3400 "f11", /* VK_F11 0x7A */
3401 "f12", /* VK_F12 0x7B */
3402 "f13", /* VK_F13 0x7C */
3403 "f14", /* VK_F14 0x7D */
3404 "f15", /* VK_F15 0x7E */
3405 "f16", /* VK_F16 0x7F */
3406 "f17", /* VK_F17 0x80 */
3407 "f18", /* VK_F18 0x81 */
3408 "f19", /* VK_F19 0x82 */
3409 "f20", /* VK_F20 0x83 */
3410 "f21", /* VK_F21 0x84 */
3411 "f22", /* VK_F22 0x85 */
3412 "f23", /* VK_F23 0x86 */
3413 "f24", /* VK_F24 0x87 */
3415 0, 0, 0, 0, /* 0x88 .. 0x8B */
3416 0, 0, 0, 0, /* 0x8C .. 0x8F */
3418 "kp-numlock", /* VK_NUMLOCK 0x90 */
3419 "scroll", /* VK_SCROLL 0x91 */
3421 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
3422 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
3423 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
3424 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
3425 "kp-end", /* VK_NUMPAD_END 0x96 */
3426 "kp-home", /* VK_NUMPAD_HOME 0x97 */
3427 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
3428 "kp-up", /* VK_NUMPAD_UP 0x99 */
3429 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
3430 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
3431 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
3432 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
3434 0, 0, /* 0x9E .. 0x9F */
3437 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
3438 * Used only as parameters to GetAsyncKeyState() and GetKeyState().
3439 * No other API or message will distinguish left and right keys this way.
3443 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3444 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3445 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3446 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3447 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3453 "attn", /* VK_ATTN 0xF6 */
3454 "crsel", /* VK_CRSEL 0xF7 */
3455 "exsel", /* VK_EXSEL 0xF8 */
3456 "ereof", /* VK_EREOF 0xF9 */
3457 "play", /* VK_PLAY 0xFA */
3458 "zoom", /* VK_ZOOM 0xFB */
3459 "noname", /* VK_NONAME 0xFC */
3460 "pa1", /* VK_PA1 0xFD */
3461 "oem_clear", /* VK_OEM_CLEAR 0xFE */
3464 #else /* not HAVE_NTGUI */
3467 static char *lispy_kana_keys
[] =
3469 /* X Keysym value */
3470 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
3471 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
3472 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
3473 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
3474 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
3475 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
3476 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
3477 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
3478 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
3479 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
3480 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
3481 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
3482 "kana-i", "kana-u", "kana-e", "kana-o",
3483 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
3484 "prolongedsound", "kana-A", "kana-I", "kana-U",
3485 "kana-E", "kana-O", "kana-KA", "kana-KI",
3486 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
3487 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
3488 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
3489 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
3490 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
3491 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
3492 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
3493 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
3494 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
3495 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
3496 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
3497 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
3499 #endif /* XK_kana_A */
3501 #define FUNCTION_KEY_OFFSET 0xff00
3503 /* You'll notice that this table is arranged to be conveniently
3504 indexed by X Windows keysym values. */
3505 static char *lispy_function_keys
[] =
3507 /* X Keysym value */
3509 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
3517 0, 0, 0, /* 0xff10 */
3519 0, 0, 0, 0, 0, 0, 0,
3522 0, "kanji", "muhenkan",
3523 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
3524 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
3525 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
3527 "home", /* 0xff50 */ /* IsCursorKey */
3538 "select", /* 0xff60 */ /* IsMiscFunctionKey */
3549 "break", /* 0xff6b */
3551 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
3553 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
3554 "kp-space", /* 0xff80 */ /* IsKeypadKey */
3555 0, 0, 0, 0, 0, 0, 0, 0,
3556 "kp-tab", /* 0xff89 */
3558 "kp-enter", /* 0xff8d */
3560 "kp-f1", /* 0xff91 */
3564 "kp-home", /* 0xff95 */
3569 "kp-prior", /* kp-page-up */
3570 "kp-next", /* kp-page-down */
3576 0, 0, 0, 0, 0, 0, 0, 0, 0,
3577 "kp-multiply", /* 0xffaa */
3582 "kp-divide", /* 0xffaf */
3583 "kp-0", /* 0xffb0 */
3584 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
3587 "kp-equal", /* 0xffbd */
3588 "f1", /* 0xffbe */ /* IsFunctionKey */
3590 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
3591 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
3592 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
3593 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
3594 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
3595 0, 0, 0, 0, 0, 0, 0, 0,
3596 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
3597 0, 0, 0, 0, 0, 0, 0, "delete"
3600 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
3601 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
3603 static char *iso_lispy_function_keys
[] =
3605 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
3606 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
3607 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
3608 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
3609 "iso-lefttab", /* 0xfe20 */
3610 "iso-move-line-up", "iso-move-line-down",
3611 "iso-partial-line-up", "iso-partial-line-down",
3612 "iso-partial-space-left", "iso-partial-space-right",
3613 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
3614 "iso-release-margin-left", "iso-release-margin-right",
3615 "iso-release-both-margins",
3616 "iso-fast-cursor-left", "iso-fast-cursor-right",
3617 "iso-fast-cursor-up", "iso-fast-cursor-down",
3618 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
3619 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
3622 #endif /* not HAVE_NTGUI */
3624 static char *lispy_mouse_names
[] =
3626 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
3629 /* Scroll bar parts. */
3630 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
3631 Lisp_Object Qup
, Qdown
;
3633 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
3634 Lisp_Object
*scroll_bar_parts
[] = {
3635 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
3640 /* A vector, indexed by button number, giving the down-going location
3641 of currently depressed buttons, both scroll bar and non-scroll bar.
3643 The elements have the form
3644 (BUTTON-NUMBER MODIFIER-MASK . REST)
3645 where REST is the cdr of a position as it would be reported in the event.
3647 The make_lispy_event function stores positions here to tell the
3648 difference between click and drag events, and to store the starting
3649 location to be included in drag events. */
3651 static Lisp_Object button_down_location
;
3653 /* Information about the most recent up-going button event: Which
3654 button, what location, and what time. */
3656 static int last_mouse_button
;
3657 static int last_mouse_x
;
3658 static int last_mouse_y
;
3659 static unsigned long button_down_time
;
3661 /* The maximum time between clicks to make a double-click,
3662 or Qnil to disable double-click detection,
3663 or Qt for no time limit. */
3664 Lisp_Object Vdouble_click_time
;
3666 /* The number of clicks in this multiple-click. */
3668 int double_click_count
;
3670 /* Given a struct input_event, build the lisp event which represents
3671 it. If EVENT is 0, build a mouse movement event from the mouse
3672 movement buffer, which should have a movement event in it.
3674 Note that events must be passed to this function in the order they
3675 are received; this function stores the location of button presses
3676 in order to build drag events when the button is released. */
3679 make_lispy_event (event
)
3680 struct input_event
*event
;
3684 switch (SWITCH_ENUM_CAST (event
->kind
))
3686 /* A simple keystroke. */
3687 case ascii_keystroke
:
3689 Lisp_Object lispy_c
;
3690 int c
= event
->code
& 0377;
3691 /* Turn ASCII characters into control characters
3693 if (event
->modifiers
& ctrl_modifier
)
3694 c
= make_ctrl_char (c
);
3696 /* Add in the other modifier bits. We took care of ctrl_modifier
3697 just above, and the shift key was taken care of by the X code,
3698 and applied to control characters by make_ctrl_char. */
3699 c
|= (event
->modifiers
3700 & (meta_modifier
| alt_modifier
3701 | hyper_modifier
| super_modifier
));
3702 button_down_time
= 0;
3703 XSETFASTINT (lispy_c
, c
);
3707 /* A function key. The symbol may need to have modifier prefixes
3709 case non_ascii_keystroke
:
3710 button_down_time
= 0;
3712 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
3713 if (event
->code
== lispy_accent_codes
[i
])
3714 return modify_event_symbol (i
,
3716 Qfunction_key
, Qnil
,
3717 lispy_accent_keys
, &accent_key_syms
,
3718 (sizeof (lispy_accent_keys
)
3719 / sizeof (lispy_accent_keys
[0])));
3721 /* Handle system-specific keysyms. */
3722 if (event
->code
& (1 << 28))
3724 /* We need to use an alist rather than a vector as the cache
3725 since we can't make a vector long enuf. */
3726 if (NILP (current_kboard
->system_key_syms
))
3727 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
3728 return modify_event_symbol (event
->code
,
3731 current_kboard
->Vsystem_key_alist
,
3732 0, ¤t_kboard
->system_key_syms
,
3737 if (event
->code
>= 0x400 && event
->code
< 0x500)
3738 return modify_event_symbol (event
->code
- 0x400,
3739 event
->modifiers
& ~shift_modifier
,
3740 Qfunction_key
, Qnil
,
3741 lispy_kana_keys
, &func_key_syms
,
3742 (sizeof (lispy_kana_keys
)
3743 / sizeof (lispy_kana_keys
[0])));
3744 #endif /* XK_kana_A */
3746 #ifdef ISO_FUNCTION_KEY_OFFSET
3747 if (event
->code
< FUNCTION_KEY_OFFSET
3748 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
3749 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
3751 Qfunction_key
, Qnil
,
3752 iso_lispy_function_keys
, &func_key_syms
,
3753 (sizeof (iso_lispy_function_keys
)
3754 / sizeof (iso_lispy_function_keys
[0])));
3757 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
3759 Qfunction_key
, Qnil
,
3760 lispy_function_keys
, &func_key_syms
,
3761 (sizeof (lispy_function_keys
)
3762 / sizeof (lispy_function_keys
[0])));
3765 /* A mouse click. Figure out where it is, decide whether it's
3766 a press, click or drag, and build the appropriate structure. */
3768 case scroll_bar_click
:
3770 int button
= event
->code
;
3772 Lisp_Object position
;
3773 Lisp_Object
*start_pos_ptr
;
3774 Lisp_Object start_pos
;
3776 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
3779 /* Build the position as appropriate for this mouse click. */
3780 if (event
->kind
== mouse_click
)
3783 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
3788 /* Ignore mouse events that were made on frame that
3789 have been deleted. */
3790 if (! FRAME_LIVE_P (f
))
3793 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
3794 &column
, &row
, NULL
, 1);
3796 #ifndef USE_X_TOOLKIT
3797 /* In the non-toolkit version, clicks on the menu bar
3798 are ordinary button events in the event buffer.
3799 Distinguish them, and invoke the menu.
3801 (In the toolkit version, the toolkit handles the menu bar
3802 and Emacs doesn't know about it until after the user
3803 makes a selection.) */
3804 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
3805 && (event
->modifiers
& down_modifier
))
3807 Lisp_Object items
, item
;
3812 /* Activate the menu bar on the down event. If the
3813 up event comes in before the menu code can deal with it,
3815 if (! (event
->modifiers
& down_modifier
))
3820 items
= FRAME_MENU_BAR_ITEMS (f
);
3821 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
3823 Lisp_Object pos
, string
;
3824 string
= XVECTOR (items
)->contents
[i
+ 1];
3825 pos
= XVECTOR (items
)->contents
[i
+ 3];
3828 if (column
>= XINT (pos
)
3829 && column
< XINT (pos
) + XSTRING (string
)->size
)
3831 item
= XVECTOR (items
)->contents
[i
];
3837 = Fcons (event
->frame_or_window
,
3839 Fcons (Fcons (event
->x
, event
->y
),
3840 Fcons (make_number (event
->timestamp
),
3843 return Fcons (item
, Fcons (position
, Qnil
));
3845 #endif /* not USE_X_TOOLKIT */
3847 window
= window_from_coordinates (f
, column
, row
, &part
);
3849 if (!WINDOWP (window
))
3851 window
= event
->frame_or_window
;
3856 int pixcolumn
, pixrow
;
3857 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
3858 row
-= XINT (XWINDOW (window
)->top
);
3859 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
3860 XSETINT (event
->x
, pixcolumn
);
3861 XSETINT (event
->y
, pixrow
);
3866 posn
= Qvertical_line
;
3869 buffer_posn_from_coords (XWINDOW (window
),
3876 Fcons (Fcons (event
->x
, event
->y
),
3877 Fcons (make_number (event
->timestamp
),
3883 Lisp_Object portion_whole
;
3886 window
= event
->frame_or_window
;
3887 portion_whole
= Fcons (event
->x
, event
->y
);
3888 part
= *scroll_bar_parts
[(int) event
->part
];
3892 Fcons (Qvertical_scroll_bar
,
3893 Fcons (portion_whole
,
3894 Fcons (make_number (event
->timestamp
),
3895 Fcons (part
, Qnil
)))));
3898 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
3900 start_pos
= *start_pos_ptr
;
3901 *start_pos_ptr
= Qnil
;
3903 is_double
= (button
== last_mouse_button
3904 && XINT (event
->x
) == last_mouse_x
3905 && XINT (event
->y
) == last_mouse_y
3906 && button_down_time
!= 0
3907 && (EQ (Vdouble_click_time
, Qt
)
3908 || (INTEGERP (Vdouble_click_time
)
3909 && ((int)(event
->timestamp
- button_down_time
)
3910 < XINT (Vdouble_click_time
)))));
3911 last_mouse_button
= button
;
3912 last_mouse_x
= XINT (event
->x
);
3913 last_mouse_y
= XINT (event
->y
);
3915 /* If this is a button press, squirrel away the location, so
3916 we can decide later whether it was a click or a drag. */
3917 if (event
->modifiers
& down_modifier
)
3921 double_click_count
++;
3922 event
->modifiers
|= ((double_click_count
> 2)
3927 double_click_count
= 1;
3928 button_down_time
= event
->timestamp
;
3929 *start_pos_ptr
= Fcopy_alist (position
);
3932 /* Now we're releasing a button - check the co-ordinates to
3933 see if this was a click or a drag. */
3934 else if (event
->modifiers
& up_modifier
)
3936 /* If we did not see a down before this up,
3937 ignore the up. Probably this happened because
3938 the down event chose a menu item.
3939 It would be an annoyance to treat the release
3940 of the button that chose the menu item
3941 as a separate event. */
3943 if (!CONSP (start_pos
))
3946 event
->modifiers
&= ~up_modifier
;
3947 #if 0 /* Formerly we treated an up with no down as a click event. */
3948 if (!CONSP (start_pos
))
3949 event
->modifiers
|= click_modifier
;
3953 /* The third element of every position should be the (x,y)
3957 down
= Fnth (make_number (2), start_pos
);
3958 if (EQ (event
->x
, XCONS (down
)->car
)
3959 && EQ (event
->y
, XCONS (down
)->cdr
))
3961 event
->modifiers
|= click_modifier
;
3965 button_down_time
= 0;
3966 event
->modifiers
|= drag_modifier
;
3968 /* Don't check is_double; treat this as multiple
3969 if the down-event was multiple. */
3970 if (double_click_count
> 1)
3971 event
->modifiers
|= ((double_click_count
> 2)
3977 /* Every mouse event should either have the down_modifier or
3978 the up_modifier set. */
3982 /* Get the symbol we should use for the mouse click. */
3985 head
= modify_event_symbol (button
,
3988 lispy_mouse_names
, &mouse_syms
,
3989 (sizeof (lispy_mouse_names
)
3990 / sizeof (lispy_mouse_names
[0])));
3991 if (event
->modifiers
& drag_modifier
)
3996 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
3999 Fcons (make_number (double_click_count
),
4009 case w32_scroll_bar_click
:
4011 int button
= event
->code
;
4013 Lisp_Object position
;
4014 Lisp_Object
*start_pos_ptr
;
4015 Lisp_Object start_pos
;
4017 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
4022 Lisp_Object portion_whole
;
4025 window
= event
->frame_or_window
;
4026 portion_whole
= Fcons (event
->x
, event
->y
);
4027 part
= *scroll_bar_parts
[(int) event
->part
];
4031 Fcons (Qvertical_scroll_bar
,
4032 Fcons (portion_whole
,
4033 Fcons (make_number (event
->timestamp
),
4034 Fcons (part
, Qnil
)))));
4037 /* Always treat W32 scroll bar events as clicks. */
4038 event
->modifiers
|= click_modifier
;
4041 /* Get the symbol we should use for the mouse click. */
4044 head
= modify_event_symbol (button
,
4047 lispy_mouse_names
, &mouse_syms
,
4048 (sizeof (lispy_mouse_names
)
4049 / sizeof (lispy_mouse_names
[0])));
4057 #endif /* HAVE_MOUSE */
4059 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
4060 case menu_bar_event
:
4061 /* The event value is in the cdr of the frame_or_window slot. */
4062 if (!CONSP (event
->frame_or_window
))
4064 return XCONS (event
->frame_or_window
)->cdr
;
4067 /* The 'kind' field of the event is something we don't recognize. */
4076 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
4078 Lisp_Object bar_window
;
4079 enum scroll_bar_part part
;
4083 /* Is it a scroll bar movement? */
4084 if (frame
&& ! NILP (bar_window
))
4086 Lisp_Object part_sym
;
4088 part_sym
= *scroll_bar_parts
[(int) part
];
4089 return Fcons (Qscroll_bar_movement
,
4090 (Fcons (Fcons (bar_window
,
4091 Fcons (Qvertical_scroll_bar
,
4092 Fcons (Fcons (x
, y
),
4093 Fcons (make_number (time
),
4099 /* Or is it an ordinary mouse movement? */
4109 /* It's in a frame; which window on that frame? */
4110 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
,
4112 window
= window_from_coordinates (frame
, column
, row
, &area
);
4117 if (WINDOWP (window
))
4119 int pixcolumn
, pixrow
;
4120 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
4121 row
-= XINT (XWINDOW (window
)->top
);
4122 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
4123 XSETINT (x
, pixcolumn
);
4124 XSETINT (y
, pixrow
);
4129 posn
= Qvertical_line
;
4132 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
4134 else if (frame
!= 0)
4136 XSETFRAME (window
, frame
);
4147 return Fcons (Qmouse_movement
,
4148 Fcons (Fcons (window
,
4150 Fcons (Fcons (x
, y
),
4151 Fcons (make_number (time
),
4157 #endif /* HAVE_MOUSE */
4159 /* Construct a switch frame event. */
4161 make_lispy_switch_frame (frame
)
4164 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
4167 /* Manipulating modifiers. */
4169 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
4171 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
4172 SYMBOL's name of the end of the modifiers; the string from this
4173 position is the unmodified symbol name.
4175 This doesn't use any caches. */
4178 parse_modifiers_uncached (symbol
, modifier_end
)
4182 struct Lisp_String
*name
;
4186 CHECK_SYMBOL (symbol
, 1);
4189 name
= XSYMBOL (symbol
)->name
;
4191 for (i
= 0; i
+2 <= name
->size
; )
4193 int this_mod_end
= 0;
4196 /* See if the name continues with a modifier word.
4197 Check that the word appears, but don't check what follows it.
4198 Set this_mod and this_mod_end to record what we find. */
4200 switch (name
->data
[i
])
4202 #define SINGLE_LETTER_MOD(BIT) \
4203 (this_mod_end = i + 1, this_mod = BIT)
4206 SINGLE_LETTER_MOD (alt_modifier
);
4210 SINGLE_LETTER_MOD (ctrl_modifier
);
4214 SINGLE_LETTER_MOD (hyper_modifier
);
4218 SINGLE_LETTER_MOD (meta_modifier
);
4222 SINGLE_LETTER_MOD (shift_modifier
);
4226 SINGLE_LETTER_MOD (super_modifier
);
4229 #undef SINGLE_LETTER_MOD
4232 /* If we found no modifier, stop looking for them. */
4233 if (this_mod_end
== 0)
4236 /* Check there is a dash after the modifier, so that it
4237 really is a modifier. */
4238 if (this_mod_end
>= name
->size
|| name
->data
[this_mod_end
] != '-')
4241 /* This modifier is real; look for another. */
4242 modifiers
|= this_mod
;
4243 i
= this_mod_end
+ 1;
4246 /* Should we include the `click' modifier? */
4247 if (! (modifiers
& (down_modifier
| drag_modifier
4248 | double_modifier
| triple_modifier
))
4249 && i
+ 7 == name
->size
4250 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
4251 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
4252 modifiers
|= click_modifier
;
4260 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
4261 prepended to the string BASE[0..BASE_LEN-1].
4262 This doesn't use any caches. */
4264 apply_modifiers_uncached (modifiers
, base
, base_len
)
4269 /* Since BASE could contain nulls, we can't use intern here; we have
4270 to use Fintern, which expects a genuine Lisp_String, and keeps a
4273 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
4279 /* Only the event queue may use the `up' modifier; it should always
4280 be turned into a click or drag event before presented to lisp code. */
4281 if (modifiers
& up_modifier
)
4284 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
4285 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
4286 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
4287 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
4288 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
4289 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
4290 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
4291 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
4292 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
4293 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
4294 /* The click modifier is denoted by the absence of other modifiers. */
4298 mod_len
= p
- new_mods
;
4302 Lisp_Object new_name
;
4304 new_name
= make_uninit_string (mod_len
+ base_len
);
4305 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
4306 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
4308 return Fintern (new_name
, Qnil
);
4313 static char *modifier_names
[] =
4315 "up", "down", "drag", "click", "double", "triple", 0, 0,
4316 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4317 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
4319 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
4321 static Lisp_Object modifier_symbols
;
4323 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
4325 lispy_modifier_list (modifiers
)
4328 Lisp_Object modifier_list
;
4331 modifier_list
= Qnil
;
4332 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
4333 if (modifiers
& (1<<i
))
4334 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
4337 return modifier_list
;
4341 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
4342 where UNMODIFIED is the unmodified form of SYMBOL,
4343 MASK is the set of modifiers present in SYMBOL's name.
4344 This is similar to parse_modifiers_uncached, but uses the cache in
4345 SYMBOL's Qevent_symbol_element_mask property, and maintains the
4346 Qevent_symbol_elements property. */
4349 parse_modifiers (symbol
)
4352 Lisp_Object elements
;
4354 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
4355 if (CONSP (elements
))
4360 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
4361 Lisp_Object unmodified
;
4364 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
4365 XSYMBOL (symbol
)->name
->size
- end
),
4368 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
4370 XSETFASTINT (mask
, modifiers
);
4371 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
4373 /* Cache the parsing results on SYMBOL. */
4374 Fput (symbol
, Qevent_symbol_element_mask
,
4376 Fput (symbol
, Qevent_symbol_elements
,
4377 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
4379 /* Since we know that SYMBOL is modifiers applied to unmodified,
4380 it would be nice to put that in unmodified's cache.
4381 But we can't, since we're not sure that parse_modifiers is
4388 /* Apply the modifiers MODIFIERS to the symbol BASE.
4389 BASE must be unmodified.
4391 This is like apply_modifiers_uncached, but uses BASE's
4392 Qmodifier_cache property, if present. It also builds
4393 Qevent_symbol_elements properties, since it has that info anyway.
4395 apply_modifiers copies the value of BASE's Qevent_kind property to
4396 the modified symbol. */
4398 apply_modifiers (modifiers
, base
)
4402 Lisp_Object cache
, index
, entry
, new_symbol
;
4404 /* Mask out upper bits. We don't know where this value's been. */
4405 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
4407 /* The click modifier never figures into cache indices. */
4408 cache
= Fget (base
, Qmodifier_cache
);
4409 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
4410 entry
= assq_no_quit (index
, cache
);
4413 new_symbol
= XCONS (entry
)->cdr
;
4416 /* We have to create the symbol ourselves. */
4417 new_symbol
= apply_modifiers_uncached (modifiers
,
4418 XSYMBOL (base
)->name
->data
,
4419 XSYMBOL (base
)->name
->size
);
4421 /* Add the new symbol to the base's cache. */
4422 entry
= Fcons (index
, new_symbol
);
4423 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
4425 /* We have the parsing info now for free, so add it to the caches. */
4426 XSETFASTINT (index
, modifiers
);
4427 Fput (new_symbol
, Qevent_symbol_element_mask
,
4428 Fcons (base
, Fcons (index
, Qnil
)));
4429 Fput (new_symbol
, Qevent_symbol_elements
,
4430 Fcons (base
, lispy_modifier_list (modifiers
)));
4433 /* Make sure this symbol is of the same kind as BASE.
4435 You'd think we could just set this once and for all when we
4436 intern the symbol above, but reorder_modifiers may call us when
4437 BASE's property isn't set right; we can't assume that just
4438 because it has a Qmodifier_cache property it must have its
4439 Qevent_kind set right as well. */
4440 if (NILP (Fget (new_symbol
, Qevent_kind
)))
4444 kind
= Fget (base
, Qevent_kind
);
4446 Fput (new_symbol
, Qevent_kind
, kind
);
4453 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
4454 return a symbol with the modifiers placed in the canonical order.
4455 Canonical order is alphabetical, except for down and drag, which
4456 always come last. The 'click' modifier is never written out.
4458 Fdefine_key calls this to make sure that (for example) C-M-foo
4459 and M-C-foo end up being equivalent in the keymap. */
4462 reorder_modifiers (symbol
)
4465 /* It's hopefully okay to write the code this way, since everything
4466 will soon be in caches, and no consing will be done at all. */
4469 parsed
= parse_modifiers (symbol
);
4470 return apply_modifiers ((int) XINT (XCONS (XCONS (parsed
)->cdr
)->car
),
4471 XCONS (parsed
)->car
);
4475 /* For handling events, we often want to produce a symbol whose name
4476 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
4477 to some base, like the name of a function key or mouse button.
4478 modify_event_symbol produces symbols of this sort.
4480 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
4481 is the name of the i'th symbol. TABLE_SIZE is the number of elements
4484 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
4485 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
4487 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
4488 persist between calls to modify_event_symbol that it can use to
4489 store a cache of the symbols it's generated for this NAME_TABLE
4490 before. The object stored there may be a vector or an alist.
4492 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
4494 MODIFIERS is a set of modifier bits (as given in struct input_events)
4495 whose prefixes should be applied to the symbol name.
4497 SYMBOL_KIND is the value to be placed in the event_kind property of
4498 the returned symbol.
4500 The symbols we create are supposed to have an
4501 `event-symbol-elements' property, which lists the modifiers present
4502 in the symbol's name. */
4505 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
4506 name_table
, symbol_table
, table_size
)
4509 Lisp_Object symbol_kind
;
4510 Lisp_Object name_alist
;
4512 Lisp_Object
*symbol_table
;
4513 unsigned int table_size
;
4516 Lisp_Object symbol_int
;
4518 /* Get rid of the "vendor-specific" bit here. */
4519 XSETINT (symbol_int
, symbol_num
& 0xffffff);
4521 /* Is this a request for a valid symbol? */
4522 if (symbol_num
< 0 || symbol_num
>= table_size
)
4525 if (CONSP (*symbol_table
))
4526 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
4528 /* If *symbol_table doesn't seem to be initialized properly, fix that.
4529 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4530 where the Nth element is the symbol for NAME_TABLE[N], or nil if
4531 we've never used that symbol before. */
4534 if (! VECTORP (*symbol_table
)
4535 || XVECTOR (*symbol_table
)->size
!= table_size
)
4539 XSETFASTINT (size
, table_size
);
4540 *symbol_table
= Fmake_vector (size
, Qnil
);
4543 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
4546 /* Have we already used this symbol before? */
4549 /* No; let's create it. */
4550 if (!NILP (name_alist
))
4551 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
4552 else if (name_table
!= 0 && name_table
[symbol_num
])
4553 value
= intern (name_table
[symbol_num
]);
4555 #ifdef HAVE_WINDOW_SYSTEM
4558 char *name
= x_get_keysym_name (symbol_num
);
4560 value
= intern (name
);
4567 sprintf (buf
, "key-%d", symbol_num
);
4568 value
= intern (buf
);
4571 if (CONSP (*symbol_table
))
4572 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
4574 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
4576 /* Fill in the cache entries for this symbol; this also
4577 builds the Qevent_symbol_elements property, which the user
4579 apply_modifiers (modifiers
& click_modifier
, value
);
4580 Fput (value
, Qevent_kind
, symbol_kind
);
4583 /* Apply modifiers to that symbol. */
4584 return apply_modifiers (modifiers
, value
);
4587 /* Convert a list that represents an event type,
4588 such as (ctrl meta backspace), into the usual representation of that
4589 event type as a number or a symbol. */
4591 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
4592 "Convert the event description list EVENT-DESC to an event type.\n\
4593 EVENT-DESC should contain one base event type (a character or symbol)\n\
4594 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
4595 drag, down, double or triple). The base must be last.\n\
4596 The return value is an event type (a character or symbol) which\n\
4597 has the same base event type and all the specified modifiers.")
4599 Lisp_Object event_desc
;
4607 while (CONSP (rest
))
4612 elt
= XCONS (rest
)->car
;
4613 rest
= XCONS (rest
)->cdr
;
4615 /* Given a symbol, see if it is a modifier name. */
4616 if (SYMBOLP (elt
) && CONSP (rest
))
4617 this = parse_solitary_modifier (elt
);
4621 else if (!NILP (base
))
4622 error ("Two bases given in one event");
4628 /* Let the symbol A refer to the character A. */
4629 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
4630 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
4632 if (INTEGERP (base
))
4634 /* Turn (shift a) into A. */
4635 if ((modifiers
& shift_modifier
) != 0
4636 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
4638 XSETINT (base
, XINT (base
) - ('a' - 'A'));
4639 modifiers
&= ~shift_modifier
;
4642 /* Turn (control a) into C-a. */
4643 if (modifiers
& ctrl_modifier
)
4644 return make_number ((modifiers
& ~ctrl_modifier
)
4645 | make_ctrl_char (XINT (base
)));
4647 return make_number (modifiers
| XINT (base
));
4649 else if (SYMBOLP (base
))
4650 return apply_modifiers (modifiers
, base
);
4652 error ("Invalid base event");
4655 /* Try to recognize SYMBOL as a modifier name.
4656 Return the modifier flag bit, or 0 if not recognized. */
4659 parse_solitary_modifier (symbol
)
4662 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
4664 switch (name
->data
[0])
4666 #define SINGLE_LETTER_MOD(BIT) \
4667 if (name->size == 1) \
4670 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
4671 if (LEN == name->size \
4672 && ! strncmp (name->data, NAME, LEN)) \
4676 SINGLE_LETTER_MOD (alt_modifier
);
4680 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
4684 SINGLE_LETTER_MOD (ctrl_modifier
);
4688 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
4689 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
4693 SINGLE_LETTER_MOD (hyper_modifier
);
4697 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
4701 SINGLE_LETTER_MOD (meta_modifier
);
4705 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
4709 SINGLE_LETTER_MOD (shift_modifier
);
4713 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
4714 MULTI_LETTER_MOD (super_modifier
, "super", 5);
4715 SINGLE_LETTER_MOD (super_modifier
);
4719 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
4720 MULTI_LETTER_MOD (down_modifier
, "down", 4);
4721 MULTI_LETTER_MOD (double_modifier
, "double", 6);
4725 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
4728 #undef SINGLE_LETTER_MOD
4729 #undef MULTI_LETTER_MOD
4735 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
4736 Such a list is not valid as an event,
4737 but it can be a Lucid-style event type list. */
4740 lucid_event_type_list_p (object
)
4745 if (! CONSP (object
))
4748 for (tail
= object
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
4751 elt
= XCONS (tail
)->car
;
4752 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
4759 /* Store into *addr a value nonzero if terminal input chars are available.
4760 Serves the purpose of ioctl (0, FIONREAD, addr)
4761 but works even if FIONREAD does not exist.
4762 (In fact, this may actually read some input.)
4764 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
4767 get_input_pending (addr
, do_timers_now
)
4771 /* First of all, have we already counted some input? */
4772 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4774 /* If input is being read as it arrives, and we have none, there is none. */
4775 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
4778 /* Try to read some input and see how much we get. */
4780 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4783 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
4786 gobble_input (expected
)
4791 if (interrupt_input
)
4794 mask
= sigblock (sigmask (SIGIO
));
4795 read_avail_input (expected
);
4799 #ifdef POLL_FOR_INPUT
4800 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
4803 mask
= sigblock (sigmask (SIGALRM
));
4804 read_avail_input (expected
);
4810 read_avail_input (expected
);
4814 /* Put a buffer_switch_event in the buffer
4815 so that read_key_sequence will notice the new current buffer. */
4817 record_asynch_buffer_change ()
4819 struct input_event event
;
4822 event
.kind
= buffer_switch_event
;
4823 event
.frame_or_window
= Qnil
;
4826 /* We don't need a buffer-switch event unless Emacs is waiting for input.
4827 The purpose of the event is to make read_key_sequence look up the
4828 keymaps again. If we aren't in read_key_sequence, we don't need one,
4829 and the event could cause trouble by messing up (input-pending-p). */
4830 tem
= Fwaiting_for_user_input_p ();
4834 /* We never need these events if we have no asynchronous subprocesses. */
4838 /* Make sure no interrupt happens while storing the event. */
4840 if (interrupt_input
)
4843 mask
= sigblock (sigmask (SIGIO
));
4844 kbd_buffer_store_event (&event
);
4851 kbd_buffer_store_event (&event
);
4858 /* Read any terminal input already buffered up by the system
4859 into the kbd_buffer, but do not wait.
4861 EXPECTED should be nonzero if the caller knows there is some input.
4863 Except on VMS, all input is read by this function.
4864 If interrupt_input is nonzero, this function MUST be called
4865 only when SIGIO is blocked.
4867 Returns the number of keyboard chars read, or -1 meaning
4868 this is a bad time to try to read input. */
4871 read_avail_input (expected
)
4874 struct input_event buf
[KBD_BUFFER_SIZE
];
4878 if (read_socket_hook
)
4879 /* No need for FIONREAD or fcntl; just say don't wait. */
4880 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
4883 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
4884 the kbd_buffer can really hold. That may prevent loss
4885 of characters on some systems when input is stuffed at us. */
4886 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
4889 /* Determine how many characters we should *try* to read. */
4892 #else /* not WINDOWSNT */
4894 n_to_read
= dos_keysns ();
4897 #else /* not MSDOS */
4899 /* Find out how much input is available. */
4900 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
4901 /* Formerly simply reported no input, but that sometimes led to
4902 a failure of Emacs to terminate.
4903 SIGHUP seems appropriate if we can't reach the terminal. */
4904 /* ??? Is it really right to send the signal just to this process
4905 rather than to the whole process group?
4906 Perhaps on systems with FIONREAD Emacs is alone in its group. */
4907 kill (getpid (), SIGHUP
);
4910 if (n_to_read
> sizeof cbuf
)
4911 n_to_read
= sizeof cbuf
;
4912 #else /* no FIONREAD */
4913 #if defined (USG) || defined (DGUX)
4914 /* Read some input if available, but don't wait. */
4915 n_to_read
= sizeof cbuf
;
4916 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
4921 #endif /* not MSDOS */
4922 #endif /* not WINDOWSNT */
4924 /* Now read; for one reason or another, this will not block.
4925 NREAD is set to the number of chars read. */
4929 cbuf
[0] = dos_keyread ();
4932 nread
= read (input_fd
, cbuf
, n_to_read
);
4934 /* POSIX infers that processes which are not in the session leader's
4935 process group won't get SIGHUP's at logout time. BSDI adheres to
4936 this part standard and returns -1 from read(0) with errno==EIO
4937 when the control tty is taken away.
4938 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
4939 if (nread
== -1 && errno
== EIO
)
4941 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
4942 /* The kernel sometimes fails to deliver SIGHUP for ptys.
4943 This looks incorrect, but it isn't, because _BSD causes
4944 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
4945 and that causes a value other than 0 when there is no input. */
4951 /* We used to retry the read if it was interrupted.
4952 But this does the wrong thing when O_NDELAY causes
4953 an EAGAIN error. Does anybody know of a situation
4954 where a retry is actually needed? */
4956 nread
< 0 && (errno
== EAGAIN
4970 #if defined (USG) || defined (DGUX)
4971 fcntl (input_fd
, F_SETFL
, 0);
4972 #endif /* USG or DGUX */
4973 #endif /* no FIONREAD */
4974 for (i
= 0; i
< nread
; i
++)
4976 buf
[i
].kind
= ascii_keystroke
;
4977 buf
[i
].modifiers
= 0;
4978 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
4979 buf
[i
].modifiers
= meta_modifier
;
4983 buf
[i
].code
= cbuf
[i
];
4984 XSETFRAME (buf
[i
].frame_or_window
, selected_frame
);
4988 /* Scan the chars for C-g and store them in kbd_buffer. */
4989 for (i
= 0; i
< nread
; i
++)
4991 kbd_buffer_store_event (&buf
[i
]);
4992 /* Don't look at input that follows a C-g too closely.
4993 This reduces lossage due to autorepeat on C-g. */
4994 if (buf
[i
].kind
== ascii_keystroke
4995 && buf
[i
].code
== quit_char
)
5001 #endif /* not VMS */
5003 #ifdef SIGIO /* for entire page */
5004 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5007 input_available_signal (signo
)
5010 /* Must preserve main program's value of errno. */
5011 int old_errno
= errno
;
5013 extern int select_alarmed
;
5016 #if defined (USG) && !defined (POSIX_SIGNALS)
5017 /* USG systems forget handlers when they are used;
5018 must reestablish each time */
5019 signal (signo
, input_available_signal
);
5026 if (input_available_clear_time
)
5027 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
5032 nread
= read_avail_input (1);
5033 /* -1 means it's not ok to read the input now.
5034 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
5035 0 means there was no keyboard input available. */
5040 select_alarmed
= 1; /* Force the select emulator back to life */
5051 /* Send ourselves a SIGIO.
5053 This function exists so that the UNBLOCK_INPUT macro in
5054 blockinput.h can have some way to take care of input we put off
5055 dealing with, without assuming that every file which uses
5056 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
5058 reinvoke_input_signal ()
5061 kill (getpid (), SIGIO
);
5067 /* Return the prompt-string of a sparse keymap.
5068 This is the first element which is a string.
5069 Return nil if there is none. */
5077 register Lisp_Object tem
;
5086 static void menu_bar_item ();
5087 static void menu_bar_one_keymap ();
5089 /* These variables hold the vector under construction within
5090 menu_bar_items and its subroutines, and the current index
5091 for storing into that vector. */
5092 static Lisp_Object menu_bar_items_vector
;
5093 static int menu_bar_items_index
;
5095 /* Return a vector of menu items for a menu bar, appropriate
5096 to the current buffer. Each item has three elements in the vector:
5099 OLD is an old vector we can optionally reuse, or nil. */
5102 menu_bar_items (old
)
5105 /* The number of keymaps we're scanning right now, and the number of
5106 keymaps we have allocated space for. */
5109 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5110 in the current keymaps, or nil where it is not a prefix. */
5113 Lisp_Object def
, tem
, tail
;
5122 struct gcpro gcpro1
;
5124 /* In order to build the menus, we need to call the keymap
5125 accessors. They all call QUIT. But this function is called
5126 during redisplay, during which a quit is fatal. So inhibit
5127 quitting while building the menus.
5128 We do this instead of specbind because (1) errors will clear it anyway
5129 and (2) this avoids risk of specpdl overflow. */
5130 oquit
= Vinhibit_quit
;
5134 menu_bar_items_vector
= old
;
5136 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
5137 menu_bar_items_index
= 0;
5139 GCPRO1 (menu_bar_items_vector
);
5141 /* Build our list of keymaps.
5142 If we recognize a function key and replace its escape sequence in
5143 keybuf with its symbol, or if the sequence starts with a mouse
5144 click and we need to switch buffers, we jump back here to rebuild
5145 the initial keymaps from the current buffer. */
5149 /* Should overriding-terminal-local-map and overriding-local-map apply? */
5150 if (!NILP (Voverriding_local_map_menu_flag
))
5152 /* Yes, use them (if non-nil) as well as the global map. */
5153 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
5155 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5156 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5157 if (!NILP (Voverriding_local_map
))
5158 maps
[nmaps
++] = Voverriding_local_map
;
5162 /* No, so use major and minor mode keymaps. */
5163 nmaps
= current_minor_maps (NULL
, &tmaps
);
5164 maps
= (Lisp_Object
*) alloca ((nmaps
+ 2) * sizeof (maps
[0]));
5165 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
5166 #ifdef USE_TEXT_PROPERTIES
5167 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
5169 maps
[nmaps
++] = current_buffer
->keymap
;
5172 maps
[nmaps
++] = current_global_map
;
5175 /* Look up in each map the dummy prefix key `menu-bar'. */
5179 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
5181 if (! NILP (maps
[mapno
]))
5182 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0), 0);
5186 tem
= Fkeymapp (def
);
5188 menu_bar_one_keymap (def
);
5191 /* Move to the end those items that should be at the end. */
5193 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5196 int end
= menu_bar_items_index
;
5198 for (i
= 0; i
< end
; i
+= 4)
5199 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5201 Lisp_Object tem0
, tem1
, tem2
, tem3
;
5202 /* Move the item at index I to the end,
5203 shifting all the others forward. */
5204 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
5205 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
5206 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5207 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
5209 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5210 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5211 (end
- i
- 4) * sizeof (Lisp_Object
));
5212 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
5213 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
5214 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
5215 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
5220 /* Add nil, nil, nil, nil at the end. */
5221 i
= menu_bar_items_index
;
5222 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5225 int newsize
= 2 * i
;
5226 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5227 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5228 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5229 menu_bar_items_vector
= tem
;
5231 /* Add this item. */
5232 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5233 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5234 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5235 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5236 menu_bar_items_index
= i
;
5238 Vinhibit_quit
= oquit
;
5240 return menu_bar_items_vector
;
5243 /* Scan one map KEYMAP, accumulating any menu items it defines
5244 in menu_bar_items_vector. */
5247 menu_bar_one_keymap (keymap
)
5250 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
5252 /* Loop over all keymap entries that have menu strings. */
5253 for (tail
= keymap
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5255 item
= XCONS (tail
)->car
;
5258 key
= XCONS (item
)->car
;
5259 binding
= XCONS (item
)->cdr
;
5260 if (CONSP (binding
))
5262 item_string
= XCONS (binding
)->car
;
5263 if (STRINGP (item_string
))
5264 menu_bar_item (key
, item_string
, Fcdr (binding
));
5266 else if (EQ (binding
, Qundefined
))
5267 menu_bar_item (key
, Qnil
, binding
);
5269 else if (VECTORP (item
))
5271 /* Loop over the char values represented in the vector. */
5272 int len
= XVECTOR (item
)->size
;
5274 for (c
= 0; c
< len
; c
++)
5276 Lisp_Object character
;
5277 XSETFASTINT (character
, c
);
5278 binding
= XVECTOR (item
)->contents
[c
];
5279 if (CONSP (binding
))
5281 item_string
= XCONS (binding
)->car
;
5282 if (STRINGP (item_string
))
5283 menu_bar_item (key
, item_string
, Fcdr (binding
));
5285 else if (EQ (binding
, Qundefined
))
5286 menu_bar_item (key
, Qnil
, binding
);
5292 /* This is used as the handler when calling internal_condition_case_1. */
5295 menu_bar_item_1 (arg
)
5301 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
5302 If there's already an item for KEY, add this DEF to it. */
5305 menu_bar_item (key
, item_string
, def
)
5306 Lisp_Object key
, item_string
, def
;
5309 Lisp_Object enabled
;
5312 /* Skip menu-bar equiv keys data. */
5313 if (CONSP (def
) && CONSP (XCONS (def
)->car
))
5314 def
= XCONS (def
)->cdr
;
5316 if (EQ (def
, Qundefined
))
5318 /* If a map has an explicit `undefined' as definition,
5319 discard any previously made menu bar item. */
5321 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5322 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5324 if (menu_bar_items_index
> i
+ 4)
5325 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5326 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5327 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
5328 menu_bar_items_index
-= 4;
5332 /* If there's no definition for this key yet,
5333 just ignore `undefined'. */
5337 /* See if this entry is enabled. */
5342 /* No property, or nil, means enable.
5343 Otherwise, enable if value is not nil. */
5344 tem
= Fget (def
, Qmenu_enable
);
5346 /* (condition-case nil (eval tem)
5348 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
5352 /* Ignore this item if it's not enabled. */
5356 /* Find any existing item for this KEY. */
5357 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5358 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5361 /* If we did not find this KEY, add it at the end. */
5362 if (i
== menu_bar_items_index
)
5364 /* If vector is too small, get a bigger one. */
5365 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5368 int newsize
= 2 * i
;
5369 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5370 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5371 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5372 menu_bar_items_vector
= tem
;
5374 /* Add this item. */
5375 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
5376 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
5377 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
5378 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
5379 menu_bar_items_index
= i
;
5381 /* We did find an item for this KEY. Add DEF to its list of maps. */
5385 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5386 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
5390 /* Read a character using menus based on maps in the array MAPS.
5391 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
5392 Return t if we displayed a menu but the user rejected it.
5394 PREV_EVENT is the previous input event, or nil if we are reading
5395 the first event of a key sequence.
5397 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
5398 if we used a mouse menu to read the input, or zero otherwise. If
5399 USED_MOUSE_MENU is null, we don't dereference it.
5401 The prompting is done based on the prompt-string of the map
5402 and the strings associated with various map elements.
5404 This can be done with X menus or with menus put in the minibuf.
5405 These are done in different ways, depending on how the input will be read.
5406 Menus using X are done after auto-saving in read-char, getting the input
5407 event from Fx_popup_menu; menus using the minibuf use read_char recursively
5408 and do auto-saving in the inner call of read_char. */
5411 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
5414 Lisp_Object prev_event
;
5415 int *used_mouse_menu
;
5418 register Lisp_Object name
;
5419 Lisp_Object rest
, vector
;
5421 if (used_mouse_menu
)
5422 *used_mouse_menu
= 0;
5424 /* Use local over global Menu maps */
5426 if (! menu_prompting
)
5429 /* Optionally disregard all but the global map. */
5430 if (inhibit_local_menu_bar_menus
)
5432 maps
+= (nmaps
- 1);
5436 /* Get the menu name from the first map that has one (a prompt string). */
5437 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5439 name
= map_prompt (maps
[mapno
]);
5444 /* If we don't have any menus, just read a character normally. */
5449 /* If we got to this point via a mouse click,
5450 use a real menu for mouse selection. */
5451 if (EVENT_HAS_PARAMETERS (prev_event
)
5452 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
))
5454 /* Display the menu and get the selection. */
5455 Lisp_Object
*realmaps
5456 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
5460 /* Use the maps that are not nil. */
5461 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5462 if (!NILP (maps
[mapno
]))
5463 realmaps
[nmaps1
++] = maps
[mapno
];
5465 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
5470 record_menu_key (XCONS (value
)->car
);
5472 /* If we got multiple events, unread all but
5474 There is no way to prevent those unread events
5475 from showing up later in last_nonmenu_event.
5476 So turn symbol and integer events into lists,
5477 to indicate that they came from a mouse menu,
5478 so that when present in last_nonmenu_event
5479 they won't confuse things. */
5480 for (tem
= XCONS (value
)->cdr
; !NILP (tem
);
5481 tem
= XCONS (tem
)->cdr
)
5483 record_menu_key (XCONS (tem
)->car
);
5484 if (SYMBOLP (XCONS (tem
)->car
)
5485 || INTEGERP (XCONS (tem
)->car
))
5487 = Fcons (XCONS (tem
)->car
, Qnil
);
5490 /* If we got more than one event, put all but the first
5491 onto this list to be read later.
5492 Return just the first event now. */
5493 Vunread_command_events
5494 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
5495 value
= XCONS (value
)->car
;
5497 else if (NILP (value
))
5499 if (used_mouse_menu
)
5500 *used_mouse_menu
= 1;
5503 #endif /* HAVE_MENUS */
5507 /* Buffer in use so far for the minibuf prompts for menu keymaps.
5508 We make this bigger when necessary, and never free it. */
5509 static char *read_char_minibuf_menu_text
;
5510 /* Size of that buffer. */
5511 static int read_char_minibuf_menu_width
;
5514 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
5520 register Lisp_Object name
;
5522 int width
= FRAME_WIDTH (selected_frame
) - 4;
5525 Lisp_Object rest
, vector
;
5528 if (! menu_prompting
)
5531 /* Make sure we have a big enough buffer for the menu text. */
5532 if (read_char_minibuf_menu_text
== 0)
5534 read_char_minibuf_menu_width
= width
+ 4;
5535 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
5537 else if (width
+ 4 > read_char_minibuf_menu_width
)
5539 read_char_minibuf_menu_width
= width
+ 4;
5540 read_char_minibuf_menu_text
5541 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
5543 menu
= read_char_minibuf_menu_text
;
5545 /* Get the menu name from the first map that has one (a prompt string). */
5546 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5548 name
= map_prompt (maps
[mapno
]);
5553 /* If we don't have any menus, just read a character normally. */
5557 /* Prompt string always starts with map's prompt, and a space. */
5558 strcpy (menu
, XSTRING (name
)->data
);
5559 nlength
= XSTRING (name
)->size
;
5560 menu
[nlength
++] = ':';
5561 menu
[nlength
++] = ' ';
5564 /* Start prompting at start of first map. */
5568 /* Present the documented bindings, a line at a time. */
5575 Lisp_Object orig_defn_macro
;
5577 /* Loop over elements of map. */
5582 /* If reached end of map, start at beginning of next map. */
5586 /* At end of last map, wrap around to first map if just starting,
5587 or end this line if already have something on it. */
5591 if (notfirst
|| nobindings
) break;
5596 /* Look at the next element of the map. */
5598 elt
= XVECTOR (vector
)->contents
[idx
];
5600 elt
= Fcar_safe (rest
);
5602 if (idx
< 0 && VECTORP (elt
))
5604 /* If we found a dense table in the keymap,
5605 advanced past it, but start scanning its contents. */
5606 rest
= Fcdr_safe (rest
);
5612 /* An ordinary element. */
5617 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
5618 event
= Fcar_safe (elt
);
5622 s
= Fcar_safe (elt
); /* vector */
5623 XSETINT (event
, idx
);
5626 /* Ignore the element if it has no prompt string. */
5627 if (STRINGP (s
) && INTEGERP (event
))
5629 /* 1 if the char to type matches the string. */
5631 Lisp_Object upcased_event
, downcased_event
;
5634 upcased_event
= Fupcase (event
);
5635 downcased_event
= Fdowncase (event
);
5636 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
5637 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
5639 desc
= Fsingle_key_description (event
);
5641 /* If we have room for the prompt string, add it to this line.
5642 If this is the first on the line, always add it. */
5643 if ((XSTRING (s
)->size
+ i
+ 2
5644 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
5650 /* Punctuate between strings. */
5653 strcpy (menu
+ i
, ", ");
5659 /* If the char to type doesn't match the string's
5660 first char, explicitly show what char to type. */
5663 /* Add as much of string as fits. */
5664 thiswidth
= XSTRING (desc
)->size
;
5665 if (thiswidth
+ i
> width
)
5666 thiswidth
= width
- i
;
5667 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
5669 strcpy (menu
+ i
, " = ");
5673 /* Add as much of string as fits. */
5674 thiswidth
= XSTRING (s
)->size
;
5675 if (thiswidth
+ i
> width
)
5676 thiswidth
= width
- i
;
5677 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
5683 /* If this element does not fit, end the line now,
5684 and save the element for the next line. */
5685 strcpy (menu
+ i
, "...");
5690 /* Move past this element. */
5691 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
5692 /* Handle reaching end of dense table. */
5697 rest
= Fcdr_safe (rest
);
5701 /* Prompt with that and read response. */
5704 /* Make believe its not a keyboard macro in case the help char
5705 is pressed. Help characters are not recorded because menu prompting
5706 is not used on replay.
5708 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
5709 current_kboard
->defining_kbd_macro
= Qnil
;
5711 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
5712 while (BUFFERP (obj
));
5713 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
5715 if (!INTEGERP (obj
))
5720 if (! EQ (obj
, menu_prompt_more_char
)
5721 && (!INTEGERP (menu_prompt_more_char
)
5722 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
5724 if (!NILP (current_kboard
->defining_kbd_macro
))
5725 store_kbd_macro_char (obj
);
5728 /* Help char - go round again */
5732 /* Reading key sequences. */
5734 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
5735 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
5736 keymap, or nil otherwise. Return the index of the first keymap in
5737 which KEY has any binding, or NMAPS if no map has a binding.
5739 If KEY is a meta ASCII character, treat it like meta-prefix-char
5740 followed by the corresponding non-meta character. Keymaps in
5741 CURRENT with non-prefix bindings for meta-prefix-char become nil in
5744 If KEY has no bindings in any of the CURRENT maps, NEXT is left
5747 NEXT may be the same array as CURRENT. */
5750 follow_key (key
, nmaps
, current
, defs
, next
)
5752 Lisp_Object
*current
, *defs
, *next
;
5755 int i
, first_binding
;
5758 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
5759 followed by the corresponding non-meta character.
5760 Put the results into DEFS, since we are going to alter that anyway.
5761 Do not alter CURRENT or NEXT. */
5762 if (INTEGERP (key
) && (XINT (key
) & CHAR_META
))
5764 for (i
= 0; i
< nmaps
; i
++)
5765 if (! NILP (current
[i
]))
5768 def
= get_keyelt (access_keymap (current
[i
],
5769 meta_prefix_char
, 1, 0), 0);
5771 /* Note that since we pass the resulting bindings through
5772 get_keymap_1, non-prefix bindings for meta-prefix-char
5774 defs
[i
] = get_keymap_1 (def
, 0, 1);
5780 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
5783 first_binding
= nmaps
;
5784 for (i
= nmaps
- 1; i
>= 0; i
--)
5786 if (! NILP (current
[i
]))
5794 defs
[i
] = get_keyelt (access_keymap (map
, key
, 1, 0), 0);
5795 if (! NILP (defs
[i
]))
5802 /* Given the set of bindings we've found, produce the next set of maps. */
5803 if (first_binding
< nmaps
)
5804 for (i
= 0; i
< nmaps
; i
++)
5805 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
5807 return first_binding
;
5810 /* Read a sequence of keys that ends with a non prefix character,
5811 storing it in KEYBUF, a buffer of size BUFSIZE.
5813 Return the length of the key sequence stored.
5814 Return -1 if the user rejected a command menu.
5816 Echo starting immediately unless `prompt' is 0.
5818 Where a key sequence ends depends on the currently active keymaps.
5819 These include any minor mode keymaps active in the current buffer,
5820 the current buffer's local map, and the global map.
5822 If a key sequence has no other bindings, we check Vfunction_key_map
5823 to see if some trailing subsequence might be the beginning of a
5824 function key's sequence. If so, we try to read the whole function
5825 key, and substitute its symbolic name into the key sequence.
5827 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
5828 `double-' events into similar click events, if that would make them
5829 bound. We try to turn `triple-' events first into `double-' events,
5832 If we get a mouse click in a mode line, vertical divider, or other
5833 non-text area, we treat the click as if it were prefixed by the
5834 symbol denoting that area - `mode-line', `vertical-line', or
5837 If the sequence starts with a mouse click, we read the key sequence
5838 with respect to the buffer clicked on, not the current buffer.
5840 If the user switches frames in the midst of a key sequence, we put
5841 off the switch-frame event until later; the next call to
5842 read_char will return it.
5844 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
5845 from the selected window's buffer. */
5848 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
5849 can_return_switch_frame
, fix_current_buffer
)
5850 Lisp_Object
*keybuf
;
5853 int dont_downcase_last
;
5854 int can_return_switch_frame
;
5855 int fix_current_buffer
;
5857 int count
= specpdl_ptr
- specpdl
;
5859 /* How many keys there are in the current key sequence. */
5862 /* The length of the echo buffer when we started reading, and
5863 the length of this_command_keys when we started reading. */
5867 /* The number of keymaps we're scanning right now, and the number of
5868 keymaps we have allocated space for. */
5870 int nmaps_allocated
= 0;
5872 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
5873 the current keymaps. */
5876 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5877 in the current keymaps, or nil where it is not a prefix. */
5878 Lisp_Object
*submaps
;
5880 /* The local map to start out with at start of key sequence. */
5881 Lisp_Object orig_local_map
;
5883 /* 1 if we have already considered switching to the local-map property
5884 of the place where a mouse click occurred. */
5885 int localized_local_map
= 0;
5887 /* The index in defs[] of the first keymap that has a binding for
5888 this key sequence. In other words, the lowest i such that
5889 defs[i] is non-nil. */
5892 /* If t < mock_input, then KEYBUF[t] should be read as the next
5895 We use this to recover after recognizing a function key. Once we
5896 realize that a suffix of the current key sequence is actually a
5897 function key's escape sequence, we replace the suffix with the
5898 function key's binding from Vfunction_key_map. Now keybuf
5899 contains a new and different key sequence, so the echo area,
5900 this_command_keys, and the submaps and defs arrays are wrong. In
5901 this situation, we set mock_input to t, set t to 0, and jump to
5902 restart_sequence; the loop will read keys from keybuf up until
5903 mock_input, thus rebuilding the state; and then it will resume
5904 reading characters from the keyboard. */
5907 /* If the sequence is unbound in submaps[], then
5908 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
5909 and fkey_map is its binding.
5911 These might be > t, indicating that all function key scanning
5912 should hold off until t reaches them. We do this when we've just
5913 recognized a function key, to avoid searching for the function
5914 key's again in Vfunction_key_map. */
5915 int fkey_start
= 0, fkey_end
= 0;
5916 Lisp_Object fkey_map
;
5918 /* Likewise, for key_translation_map. */
5919 int keytran_start
= 0, keytran_end
= 0;
5920 Lisp_Object keytran_map
;
5922 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
5923 we put it off for later. While we're reading, we keep the event here. */
5924 Lisp_Object delayed_switch_frame
;
5926 /* See the comment below... */
5927 #if defined (GOBBLE_FIRST_EVENT)
5928 Lisp_Object first_event
;
5931 Lisp_Object original_uppercase
;
5932 int original_uppercase_position
= -1;
5934 /* Gets around Microsoft compiler limitations. */
5937 struct buffer
*starting_buffer
;
5939 /* Nonzero if we seem to have got the beginning of a binding
5940 in function_key_map. */
5941 int function_key_possible
= 0;
5942 int key_translation_possible
= 0;
5944 /* Save the status of key translation before each step,
5945 so that we can restore this after downcasing. */
5946 Lisp_Object prev_fkey_map
;
5947 int prev_fkey_start
;
5950 Lisp_Object prev_keytran_map
;
5951 int prev_keytran_start
;
5952 int prev_keytran_end
;
5956 last_nonmenu_event
= Qnil
;
5958 delayed_switch_frame
= Qnil
;
5959 fkey_map
= Vfunction_key_map
;
5960 keytran_map
= Vkey_translation_map
;
5962 /* If there is no function-key-map, turn off function key scanning. */
5963 if (NILP (Fkeymapp (Vfunction_key_map
)))
5964 fkey_start
= fkey_end
= bufsize
+ 1;
5966 /* If there is no key-translation-map, turn off scanning. */
5967 if (NILP (Fkeymapp (Vkey_translation_map
)))
5968 keytran_start
= keytran_end
= bufsize
+ 1;
5973 echo_prompt (XSTRING (prompt
)->data
);
5974 else if (cursor_in_echo_area
&& echo_keystrokes
)
5975 /* This doesn't put in a dash if the echo buffer is empty, so
5976 you don't always see a dash hanging out in the minibuffer. */
5980 /* Record the initial state of the echo area and this_command_keys;
5981 we will need to restore them if we replay a key sequence. */
5983 echo_start
= echo_length ();
5984 keys_start
= this_command_key_count
;
5985 this_single_command_key_start
= keys_start
;
5987 #if defined (GOBBLE_FIRST_EVENT)
5988 /* This doesn't quite work, because some of the things that read_char
5989 does cannot safely be bypassed. It seems too risky to try to make
5992 /* Read the first char of the sequence specially, before setting
5993 up any keymaps, in case a filter runs and switches buffers on us. */
5994 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
5996 #endif /* GOBBLE_FIRST_EVENT */
5998 orig_local_map
= get_local_map (PT
, current_buffer
);
6000 /* We jump here when the key sequence has been thoroughly changed, and
6001 we need to rescan it starting from the beginning. When we jump here,
6002 keybuf[0..mock_input] holds the sequence we should reread. */
6005 starting_buffer
= current_buffer
;
6006 function_key_possible
= 0;
6007 key_translation_possible
= 0;
6009 /* Build our list of keymaps.
6010 If we recognize a function key and replace its escape sequence in
6011 keybuf with its symbol, or if the sequence starts with a mouse
6012 click and we need to switch buffers, we jump back here to rebuild
6013 the initial keymaps from the current buffer. */
6017 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
6018 || !NILP (Voverriding_local_map
))
6020 if (3 > nmaps_allocated
)
6022 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
6023 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
6024 nmaps_allocated
= 3;
6027 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6028 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6029 if (!NILP (Voverriding_local_map
))
6030 submaps
[nmaps
++] = Voverriding_local_map
;
6034 nmaps
= current_minor_maps (0, &maps
);
6035 if (nmaps
+ 2 > nmaps_allocated
)
6037 submaps
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (submaps
[0]));
6038 defs
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (defs
[0]));
6039 nmaps_allocated
= nmaps
+ 2;
6041 bcopy (maps
, submaps
, nmaps
* sizeof (submaps
[0]));
6042 #ifdef USE_TEXT_PROPERTIES
6043 submaps
[nmaps
++] = orig_local_map
;
6045 submaps
[nmaps
++] = current_buffer
->keymap
;
6048 submaps
[nmaps
++] = current_global_map
;
6051 /* Find an accurate initial value for first_binding. */
6052 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
6053 if (! NILP (submaps
[first_binding
]))
6056 /* Start from the beginning in keybuf. */
6059 /* These are no-ops the first time through, but if we restart, they
6060 revert the echo area and this_command_keys to their original state. */
6061 this_command_key_count
= keys_start
;
6062 if (INTERACTIVE
&& t
< mock_input
)
6063 echo_truncate (echo_start
);
6065 /* If the best binding for the current key sequence is a keymap, or
6066 we may be looking at a function key's escape sequence, keep on
6068 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
6069 || (first_binding
>= nmaps
6071 /* mock input is never part of a function key's sequence. */
6072 && mock_input
<= fkey_start
)
6073 || (first_binding
>= nmaps
6074 && keytran_start
< t
&& key_translation_possible
)
6075 /* Don't return in the middle of a possible function key sequence,
6076 if the only bindings we found were via case conversion.
6077 Thus, if ESC O a has a function-key-map translation
6078 and ESC o has a binding, don't return after ESC O,
6079 so that we can translate ESC O plus the next character. */
6083 int used_mouse_menu
= 0;
6085 /* Where the last real key started. If we need to throw away a
6086 key that has expanded into more than one element of keybuf
6087 (say, a mouse click on the mode line which is being treated
6088 as [mode-line (mouse-...)], then we backtrack to this point
6090 int last_real_key_start
;
6092 /* These variables are analogous to echo_start and keys_start;
6093 while those allow us to restart the entire key sequence,
6094 echo_local_start and keys_local_start allow us to throw away
6096 int echo_local_start
, keys_local_start
, local_first_binding
;
6099 error ("Key sequence too long");
6102 echo_local_start
= echo_length ();
6103 keys_local_start
= this_command_key_count
;
6104 local_first_binding
= first_binding
;
6107 /* These are no-ops, unless we throw away a keystroke below and
6108 jumped back up to replay_key; in that case, these restore the
6109 variables to their original state, allowing us to replay the
6111 if (INTERACTIVE
&& t
< mock_input
)
6112 echo_truncate (echo_local_start
);
6113 this_command_key_count
= keys_local_start
;
6114 first_binding
= local_first_binding
;
6116 /* By default, assume each event is "real". */
6117 last_real_key_start
= t
;
6119 /* Does mock_input indicate that we are re-reading a key sequence? */
6123 add_command_key (key
);
6124 if (echo_keystrokes
)
6128 /* If not, we should actually read a character. */
6131 struct buffer
*buf
= current_buffer
;
6135 KBOARD
*interrupted_kboard
= current_kboard
;
6136 struct frame
*interrupted_frame
= selected_frame
;
6137 if (setjmp (wrong_kboard_jmpbuf
))
6139 if (!NILP (delayed_switch_frame
))
6141 interrupted_kboard
->kbd_queue
6142 = Fcons (delayed_switch_frame
,
6143 interrupted_kboard
->kbd_queue
);
6144 delayed_switch_frame
= Qnil
;
6147 interrupted_kboard
->kbd_queue
6148 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
6150 /* If the side queue is non-empty, ensure it begins with a
6151 switch-frame, so we'll replay it in the right context. */
6152 if (CONSP (interrupted_kboard
->kbd_queue
)
6153 && (key
= XCONS (interrupted_kboard
->kbd_queue
)->car
,
6154 !(EVENT_HAS_PARAMETERS (key
)
6155 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
6159 XSETFRAME (frame
, interrupted_frame
);
6160 interrupted_kboard
->kbd_queue
6161 = Fcons (make_lispy_switch_frame (frame
),
6162 interrupted_kboard
->kbd_queue
);
6165 orig_local_map
= get_local_map (PT
, current_buffer
);
6166 goto replay_sequence
;
6169 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
6173 /* read_char returns t when it shows a menu and the user rejects it.
6178 /* read_char returns -1 at the end of a macro.
6179 Emacs 18 handles this by returning immediately with a
6180 zero, so that's what we'll do. */
6181 if (INTEGERP (key
) && XINT (key
) == -1)
6184 /* The Microsoft C compiler can't handle the goto that
6190 /* If the current buffer has been changed from under us, the
6191 keymap may have changed, so replay the sequence. */
6195 /* Reset the current buffer from the selected window
6196 in case something changed the former and not the latter.
6197 This is to be more consistent with the behavior
6198 of the command_loop_1. */
6199 if (fix_current_buffer
)
6200 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
6201 Fset_buffer (XWINDOW (selected_window
)->buffer
);
6203 orig_local_map
= get_local_map (PT
, current_buffer
);
6204 goto replay_sequence
;
6207 /* If we have a quit that was typed in another frame, and
6208 quit_throw_to_read_char switched buffers,
6209 replay to get the right keymap. */
6210 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
6215 orig_local_map
= get_local_map (PT
, current_buffer
);
6216 goto replay_sequence
;
6222 /* Clicks in non-text areas get prefixed by the symbol
6223 in their CHAR-ADDRESS field. For example, a click on
6224 the mode line is prefixed by the symbol `mode-line'.
6226 Furthermore, key sequences beginning with mouse clicks
6227 are read using the keymaps of the buffer clicked on, not
6228 the current buffer. So we may have to switch the buffer
6231 When we turn one event into two events, we must make sure
6232 that neither of the two looks like the original--so that,
6233 if we replay the events, they won't be expanded again.
6234 If not for this, such reexpansion could happen either here
6235 or when user programs play with this-command-keys. */
6236 if (EVENT_HAS_PARAMETERS (key
))
6240 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
6241 if (EQ (kind
, Qmouse_click
))
6243 Lisp_Object window
, posn
;
6245 window
= POSN_WINDOW (EVENT_START (key
));
6246 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6249 /* We're looking at the second event of a
6250 sequence which we expanded before. Set
6251 last_real_key_start appropriately. */
6253 last_real_key_start
= t
- 1;
6256 /* Key sequences beginning with mouse clicks are
6257 read using the keymaps in the buffer clicked on,
6258 not the current buffer. If we're at the
6259 beginning of a key sequence, switch buffers. */
6260 if (last_real_key_start
== 0
6262 && BUFFERP (XWINDOW (window
)->buffer
)
6263 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
6268 /* Arrange to go back to the original buffer once we're
6269 done reading the key sequence. Note that we can't
6270 use save_excursion_{save,restore} here, because they
6271 save point as well as the current buffer; we don't
6272 want to save point, because redisplay may change it,
6273 to accommodate a Fset_window_start or something. We
6274 don't want to do this at the top of the function,
6275 because we may get input from a subprocess which
6276 wants to change the selected window and stuff (say,
6278 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
6280 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
6281 orig_local_map
= get_local_map (PT
, current_buffer
);
6282 goto replay_sequence
;
6284 /* For a mouse click, get the local text-property keymap
6285 of the place clicked on, rather than point. */
6286 if (last_real_key_start
== 0 && CONSP (XCONS (key
)->cdr
)
6287 && ! localized_local_map
)
6289 Lisp_Object map_here
, start
, pos
;
6291 localized_local_map
= 1;
6292 start
= EVENT_START (key
);
6293 if (CONSP (start
) && CONSP (XCONS (start
)->cdr
))
6295 pos
= POSN_BUFFER_POSN (start
);
6297 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
6299 map_here
= get_local_map (XINT (pos
), current_buffer
);
6300 if (!EQ (map_here
, orig_local_map
))
6302 orig_local_map
= map_here
;
6306 goto replay_sequence
;
6312 /* Expand mode-line and scroll-bar events into two events:
6313 use posn as a fake prefix key. */
6316 if (t
+ 1 >= bufsize
)
6317 error ("Key sequence too long");
6322 /* Zap the position in key, so we know that we've
6323 expanded it, and don't try to do so again. */
6324 POSN_BUFFER_POSN (EVENT_START (key
))
6325 = Fcons (posn
, Qnil
);
6329 else if (EQ (kind
, Qswitch_frame
))
6331 /* If we're at the beginning of a key sequence, and the caller
6332 says it's okay, go ahead and return this event. If we're
6333 in the midst of a key sequence, delay it until the end. */
6334 if (t
> 0 || !can_return_switch_frame
)
6336 delayed_switch_frame
= key
;
6340 else if (CONSP (XCONS (key
)->cdr
)
6341 && CONSP (EVENT_START (key
))
6342 && CONSP (XCONS (EVENT_START (key
))->cdr
))
6346 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6347 /* Handle menu-bar events:
6348 insert the dummy prefix event `menu-bar'. */
6349 if (EQ (posn
, Qmenu_bar
))
6351 if (t
+ 1 >= bufsize
)
6352 error ("Key sequence too long");
6356 /* Zap the position in key, so we know that we've
6357 expanded it, and don't try to do so again. */
6358 POSN_BUFFER_POSN (EVENT_START (key
))
6359 = Fcons (posn
, Qnil
);
6362 goto replay_sequence
;
6364 else if (CONSP (posn
))
6366 /* We're looking at the second event of a
6367 sequence which we expanded before. Set
6368 last_real_key_start appropriately. */
6369 if (last_real_key_start
== t
&& t
> 0)
6370 last_real_key_start
= t
- 1;
6375 /* We have finally decided that KEY is something we might want
6377 first_binding
= (follow_key (key
,
6378 nmaps
- first_binding
,
6379 submaps
+ first_binding
,
6380 defs
+ first_binding
,
6381 submaps
+ first_binding
)
6384 /* If KEY wasn't bound, we'll try some fallbacks. */
6385 if (first_binding
>= nmaps
)
6389 head
= EVENT_HEAD (key
);
6390 if (help_char_p (head
) && t
> 0)
6392 read_key_sequence_cmd
= Vprefix_help_command
;
6394 last_nonmenu_event
= key
;
6395 /* The Microsoft C compiler can't handle the goto that
6403 Lisp_Object breakdown
;
6406 breakdown
= parse_modifiers (head
);
6407 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6408 /* Attempt to reduce an unbound mouse event to a simpler
6409 event that is bound:
6410 Drags reduce to clicks.
6411 Double-clicks reduce to clicks.
6412 Triple-clicks reduce to double-clicks, then to clicks.
6413 Down-clicks are eliminated.
6414 Double-downs reduce to downs, then are eliminated.
6415 Triple-downs reduce to double-downs, then to downs,
6416 then are eliminated. */
6417 if (modifiers
& (down_modifier
| drag_modifier
6418 | double_modifier
| triple_modifier
))
6420 while (modifiers
& (down_modifier
| drag_modifier
6421 | double_modifier
| triple_modifier
))
6423 Lisp_Object new_head
, new_click
;
6424 if (modifiers
& triple_modifier
)
6425 modifiers
^= (double_modifier
| triple_modifier
);
6426 else if (modifiers
& double_modifier
)
6427 modifiers
&= ~double_modifier
;
6428 else if (modifiers
& drag_modifier
)
6429 modifiers
&= ~drag_modifier
;
6432 /* Dispose of this `down' event by simply jumping
6433 back to replay_key, to get another event.
6435 Note that if this event came from mock input,
6436 then just jumping back to replay_key will just
6437 hand it to us again. So we have to wipe out any
6440 We could delete keybuf[t] and shift everything
6441 after that to the left by one spot, but we'd also
6442 have to fix up any variable that points into
6443 keybuf, and shifting isn't really necessary
6446 Adding prefixes for non-textual mouse clicks
6447 creates two characters of mock input, and both
6448 must be thrown away. If we're only looking at
6449 the prefix now, we can just jump back to
6450 replay_key. On the other hand, if we've already
6451 processed the prefix, and now the actual click
6452 itself is giving us trouble, then we've lost the
6453 state of the keymaps we want to backtrack to, and
6454 we need to replay the whole sequence to rebuild
6457 Beyond that, only function key expansion could
6458 create more than two keys, but that should never
6459 generate mouse events, so it's okay to zero
6460 mock_input in that case too.
6462 Isn't this just the most wonderful code ever? */
6463 if (t
== last_real_key_start
)
6470 mock_input
= last_real_key_start
;
6471 goto replay_sequence
;
6476 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
6478 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
6480 /* Look for a binding for this new key. follow_key
6481 promises that it didn't munge submaps the
6482 last time we called it, since key was unbound. */
6484 = (follow_key (new_click
,
6485 nmaps
- local_first_binding
,
6486 submaps
+ local_first_binding
,
6487 defs
+ local_first_binding
,
6488 submaps
+ local_first_binding
)
6489 + local_first_binding
);
6491 /* If that click is bound, go for it. */
6492 if (first_binding
< nmaps
)
6497 /* Otherwise, we'll leave key set to the drag event. */
6504 /* Normally, last_nonmenu_event gets the previous key we read.
6505 But when a mouse popup menu is being used,
6506 we don't update last_nonmenu_event; it continues to hold the mouse
6507 event that preceded the first level of menu. */
6508 if (!used_mouse_menu
)
6509 last_nonmenu_event
= key
;
6511 /* Record what part of this_command_keys is the current key sequence. */
6512 this_single_command_key_start
= this_command_key_count
- t
;
6514 prev_fkey_map
= fkey_map
;
6515 prev_fkey_start
= fkey_start
;
6516 prev_fkey_end
= fkey_end
;
6518 prev_keytran_map
= keytran_map
;
6519 prev_keytran_start
= keytran_start
;
6520 prev_keytran_end
= keytran_end
;
6522 /* If the sequence is unbound, see if we can hang a function key
6523 off the end of it. We only want to scan real keyboard input
6524 for function key sequences, so if mock_input says that we're
6525 re-reading old events, don't examine it. */
6526 if (first_binding
>= nmaps
6529 Lisp_Object fkey_next
;
6531 /* Continue scan from fkey_end until we find a bound suffix.
6532 If we fail, increment fkey_start
6533 and start fkey_end from there. */
6534 while (fkey_end
< t
)
6538 key
= keybuf
[fkey_end
++];
6539 /* Look up meta-characters by prefixing them
6540 with meta_prefix_char. I hate this. */
6541 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6546 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0), 0),
6548 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6551 fkey_next
= fkey_map
;
6554 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0), 0);
6556 #if 0 /* I didn't turn this on, because it might cause trouble
6557 for the mapping of return into C-m and tab into C-i. */
6558 /* Optionally don't map function keys into other things.
6559 This enables the user to redefine kp- keys easily. */
6560 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
6564 /* If the function key map gives a function, not an
6565 array, then call the function with no args and use
6566 its value instead. */
6567 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
6570 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6574 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6575 fkey_next
= call1 (fkey_next
, prompt
);
6577 /* If the function returned something invalid,
6578 barf--don't ignore it.
6579 (To ignore it safely, we would need to gcpro a bunch of
6580 other variables.) */
6581 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
6582 error ("Function in key-translation-map returns invalid key sequence");
6585 function_key_possible
= ! NILP (fkey_next
);
6587 /* If keybuf[fkey_start..fkey_end] is bound in the
6588 function key map and it's a suffix of the current
6589 sequence (i.e. fkey_end == t), replace it with
6590 the binding and restart with fkey_start at the end. */
6591 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
6594 int len
= XFASTINT (Flength (fkey_next
));
6596 t
= fkey_start
+ len
;
6598 error ("Key sequence too long");
6600 if (VECTORP (fkey_next
))
6601 bcopy (XVECTOR (fkey_next
)->contents
,
6602 keybuf
+ fkey_start
,
6603 (t
- fkey_start
) * sizeof (keybuf
[0]));
6604 else if (STRINGP (fkey_next
))
6608 for (i
= 0; i
< len
; i
++)
6609 XSETFASTINT (keybuf
[fkey_start
+ i
],
6610 XSTRING (fkey_next
)->data
[i
]);
6614 fkey_start
= fkey_end
= t
;
6615 fkey_map
= Vfunction_key_map
;
6617 /* Do pass the results through key-translation-map. */
6618 keytran_start
= keytran_end
= 0;
6619 keytran_map
= Vkey_translation_map
;
6621 goto replay_sequence
;
6624 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
6626 /* If we no longer have a bound suffix, try a new positions for
6628 if (NILP (fkey_map
))
6630 fkey_end
= ++fkey_start
;
6631 fkey_map
= Vfunction_key_map
;
6632 function_key_possible
= 0;
6637 /* Look for this sequence in key-translation-map. */
6639 Lisp_Object keytran_next
;
6641 /* Scan from keytran_end until we find a bound suffix. */
6642 while (keytran_end
< t
)
6646 key
= keybuf
[keytran_end
++];
6647 /* Look up meta-characters by prefixing them
6648 with meta_prefix_char. I hate this. */
6649 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6654 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0), 0),
6656 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6659 keytran_next
= keytran_map
;
6662 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0), 0);
6664 /* If the key translation map gives a function, not an
6665 array, then call the function with no args and use
6666 its value instead. */
6667 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
6668 && keytran_end
== t
)
6670 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6674 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6675 keytran_next
= call1 (keytran_next
, prompt
);
6677 /* If the function returned something invalid,
6678 barf--don't ignore it.
6679 (To ignore it safely, we would need to gcpro a bunch of
6680 other variables.) */
6681 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
6682 error ("Function in key-translation-map returns invalid key sequence");
6685 key_translation_possible
= ! NILP (keytran_next
);
6687 /* If keybuf[keytran_start..keytran_end] is bound in the
6688 key translation map and it's a suffix of the current
6689 sequence (i.e. keytran_end == t), replace it with
6690 the binding and restart with keytran_start at the end. */
6691 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
6692 && keytran_end
== t
)
6694 int len
= XFASTINT (Flength (keytran_next
));
6696 t
= keytran_start
+ len
;
6698 error ("Key sequence too long");
6700 if (VECTORP (keytran_next
))
6701 bcopy (XVECTOR (keytran_next
)->contents
,
6702 keybuf
+ keytran_start
,
6703 (t
- keytran_start
) * sizeof (keybuf
[0]));
6704 else if (STRINGP (keytran_next
))
6708 for (i
= 0; i
< len
; i
++)
6709 XSETFASTINT (keybuf
[keytran_start
+ i
],
6710 XSTRING (keytran_next
)->data
[i
]);
6714 keytran_start
= keytran_end
= t
;
6715 keytran_map
= Vkey_translation_map
;
6717 /* Don't pass the results of key-translation-map
6718 through function-key-map. */
6719 fkey_start
= fkey_end
= t
;
6720 fkey_map
= Vkey_translation_map
;
6722 goto replay_sequence
;
6725 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
6727 /* If we no longer have a bound suffix, try a new positions for
6729 if (NILP (keytran_map
))
6731 keytran_end
= ++keytran_start
;
6732 keytran_map
= Vkey_translation_map
;
6733 key_translation_possible
= 0;
6738 /* If KEY is not defined in any of the keymaps,
6739 and cannot be part of a function key or translation,
6740 and is an upper case letter
6741 use the corresponding lower-case letter instead. */
6742 if (first_binding
== nmaps
&& ! function_key_possible
6743 && ! key_translation_possible
6745 && ((((XINT (key
) & 0x3ffff)
6746 < XSTRING (current_buffer
->downcase_table
)->size
)
6747 && UPPERCASEP (XINT (key
) & 0x3ffff))
6748 || (XINT (key
) & shift_modifier
)))
6750 Lisp_Object new_key
;
6752 original_uppercase
= key
;
6753 original_uppercase_position
= t
- 1;
6755 if (XINT (key
) & shift_modifier
)
6756 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
6758 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
6759 | (XINT (key
) & ~0x3ffff)));
6761 /* We have to do this unconditionally, regardless of whether
6762 the lower-case char is defined in the keymaps, because they
6763 might get translated through function-key-map. */
6764 keybuf
[t
- 1] = new_key
;
6767 fkey_map
= prev_fkey_map
;
6768 fkey_start
= prev_fkey_start
;
6769 fkey_end
= prev_fkey_end
;
6771 keytran_map
= prev_keytran_map
;
6772 keytran_start
= prev_keytran_start
;
6773 keytran_end
= prev_keytran_end
;
6775 goto replay_sequence
;
6777 /* If KEY is not defined in any of the keymaps,
6778 and cannot be part of a function key or translation,
6779 and is a shifted function key,
6780 use the corresponding unshifted function key instead. */
6781 if (first_binding
== nmaps
&& ! function_key_possible
6782 && ! key_translation_possible
6785 Lisp_Object breakdown
;
6788 breakdown
= parse_modifiers (key
);
6789 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6790 if (modifiers
& shift_modifier
)
6792 Lisp_Object new_key
;
6794 original_uppercase
= key
;
6795 original_uppercase_position
= t
- 1;
6797 modifiers
&= ~shift_modifier
;
6798 new_key
= apply_modifiers (modifiers
,
6799 XCONS (breakdown
)->car
);
6801 keybuf
[t
- 1] = new_key
;
6804 fkey_map
= prev_fkey_map
;
6805 fkey_start
= prev_fkey_start
;
6806 fkey_end
= prev_fkey_end
;
6808 keytran_map
= prev_keytran_map
;
6809 keytran_start
= prev_keytran_start
;
6810 keytran_end
= prev_keytran_end
;
6812 goto replay_sequence
;
6818 read_key_sequence_cmd
= (first_binding
< nmaps
6819 ? defs
[first_binding
]
6822 unread_switch_frame
= delayed_switch_frame
;
6823 unbind_to (count
, Qnil
);
6825 /* Don't downcase the last character if the caller says don't.
6826 Don't downcase it if the result is undefined, either. */
6827 if ((dont_downcase_last
|| first_binding
>= nmaps
)
6828 && t
- 1 == original_uppercase_position
)
6829 keybuf
[t
- 1] = original_uppercase
;
6831 /* Occasionally we fabricate events, perhaps by expanding something
6832 according to function-key-map, or by adding a prefix symbol to a
6833 mouse click in the scroll bar or modeline. In this cases, return
6834 the entire generated key sequence, even if we hit an unbound
6835 prefix or a definition before the end. This means that you will
6836 be able to push back the event properly, and also means that
6837 read-key-sequence will always return a logical unit.
6840 for (; t
< mock_input
; t
++)
6842 if (echo_keystrokes
)
6843 echo_char (keybuf
[t
]);
6844 add_command_key (keybuf
[t
]);
6850 #if 0 /* This doc string is too long for some compilers.
6851 This commented-out definition serves for DOC. */
6852 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
6853 "Read a sequence of keystrokes and return as a string or vector.\n\
6854 The sequence is sufficient to specify a non-prefix command in the\n\
6855 current local and global maps.\n\
6857 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
6858 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
6859 as a continuation of the previous key.\n\
6861 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
6862 convert the last event to lower case. (Normally any upper case event\n\
6863 is converted to lower case if the original event is undefined and the lower\n\
6864 case equivalent is defined.) A non-nil value is appropriate for reading\n\
6865 a key sequence to be defined.\n\
6867 A C-g typed while in this function is treated like any other character,\n\
6868 and `quit-flag' is not set.\n\
6870 If the key sequence starts with a mouse click, then the sequence is read\n\
6871 using the keymaps of the buffer of the window clicked in, not the buffer\n\
6872 of the selected window as normal.\n\
6874 `read-key-sequence' drops unbound button-down events, since you normally\n\
6875 only care about the click or drag events which follow them. If a drag\n\
6876 or multi-click event is unbound, but the corresponding click event would\n\
6877 be bound, `read-key-sequence' turns the event into a click event at the\n\
6878 drag's starting position. This means that you don't have to distinguish\n\
6879 between click and drag, double, or triple events unless you want to.\n\
6881 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
6882 lines separating windows, and scroll bars with imaginary keys\n\
6883 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
6885 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
6886 function will process a switch-frame event if the user switches frames\n\
6887 before typing anything. If the user switches frames in the middle of a\n\
6888 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
6889 is nil, then the event will be put off until after the current key sequence.\n\
6891 `read-key-sequence' checks `function-key-map' for function key\n\
6892 sequences, where they wouldn't conflict with ordinary bindings. See\n\
6893 `function-key-map' for more details.")
6894 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
6897 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
6899 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
6900 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
6901 Lisp_Object can_return_switch_frame
;
6903 Lisp_Object keybuf
[30];
6905 struct gcpro gcpro1
, gcpro2
;
6908 CHECK_STRING (prompt
, 0);
6911 bzero (keybuf
, sizeof keybuf
);
6913 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
6915 if (NILP (continue_echo
))
6917 this_command_key_count
= 0;
6918 this_single_command_key_start
= 0;
6921 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
6922 prompt
, ! NILP (dont_downcase_last
),
6923 ! NILP (can_return_switch_frame
), 0);
6931 return make_event_array (i
, keybuf
);
6934 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
6935 "Execute CMD as an editor command.\n\
6936 CMD must be a symbol that satisfies the `commandp' predicate.\n\
6937 Optional second arg RECORD-FLAG non-nil\n\
6938 means unconditionally put this command in `command-history'.\n\
6939 Otherwise, that is done only if an arg is read using the minibuffer.\n\
6940 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
6941 when reading the arguments; if it is nil, (this-command-keys) is used.\n\
6942 The argument SPECIAL, if non-nil, means that this command is executing\n\
6943 a special event, so ignore the prefix argument and don't clear it.")
6944 (cmd
, record_flag
, keys
, special
)
6945 Lisp_Object cmd
, record_flag
, keys
, special
;
6947 register Lisp_Object final
;
6948 register Lisp_Object tem
;
6949 Lisp_Object prefixarg
;
6950 struct backtrace backtrace
;
6951 extern int debug_on_next_call
;
6953 debug_on_next_call
= 0;
6957 prefixarg
= current_kboard
->Vprefix_arg
;
6958 Vcurrent_prefix_arg
= prefixarg
;
6959 current_kboard
->Vprefix_arg
= Qnil
;
6966 tem
= Fget (cmd
, Qdisabled
);
6967 if (!NILP (tem
) && !NILP (Vrun_hooks
))
6969 tem
= Fsymbol_value (Qdisabled_command_hook
);
6971 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
6977 final
= Findirect_function (cmd
);
6979 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
6981 struct gcpro gcpro1
, gcpro2
;
6983 GCPRO2 (cmd
, prefixarg
);
6984 do_autoload (final
, cmd
);
6991 if (STRINGP (final
) || VECTORP (final
))
6993 /* If requested, place the macro in the command history. For
6994 other sorts of commands, call-interactively takes care of
6996 if (!NILP (record_flag
))
6998 = Fcons (Fcons (Qexecute_kbd_macro
,
6999 Fcons (final
, Fcons (prefixarg
, Qnil
))),
7002 return Fexecute_kbd_macro (final
, prefixarg
);
7004 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
7006 backtrace
.next
= backtrace_list
;
7007 backtrace_list
= &backtrace
;
7008 backtrace
.function
= &Qcall_interactively
;
7009 backtrace
.args
= &cmd
;
7010 backtrace
.nargs
= 1;
7011 backtrace
.evalargs
= 0;
7013 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
7015 backtrace_list
= backtrace
.next
;
7021 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
7023 "Read function name, then read its arguments and call it.")
7025 Lisp_Object prefixarg
;
7027 Lisp_Object function
;
7029 Lisp_Object saved_keys
;
7030 Lisp_Object bindings
, value
;
7031 struct gcpro gcpro1
, gcpro2
;
7033 saved_keys
= Fvector (this_command_key_count
,
7034 XVECTOR (this_command_keys
)->contents
);
7036 GCPRO2 (saved_keys
, prefixarg
);
7038 if (EQ (prefixarg
, Qminus
))
7040 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
7041 strcpy (buf
, "C-u ");
7042 else if (CONSP (prefixarg
) && INTEGERP (XCONS (prefixarg
)->car
))
7044 if (sizeof (int) == sizeof (EMACS_INT
))
7045 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
7046 else if (sizeof (long) == sizeof (EMACS_INT
))
7047 sprintf (buf
, "%ld ", XINT (XCONS (prefixarg
)->car
));
7051 else if (INTEGERP (prefixarg
))
7053 if (sizeof (int) == sizeof (EMACS_INT
))
7054 sprintf (buf
, "%d ", XINT (prefixarg
));
7055 else if (sizeof (long) == sizeof (EMACS_INT
))
7056 sprintf (buf
, "%ld ", XINT (prefixarg
));
7061 /* This isn't strictly correct if execute-extended-command
7062 is bound to anything else. Perhaps it should use
7063 this_command_keys? */
7064 strcat (buf
, "M-x ");
7066 /* Prompt with buf, and then read a string, completing from and
7067 restricting to the set of all defined commands. Don't provide
7068 any initial input. Save the command read on the extended-command
7070 function
= Fcompleting_read (build_string (buf
),
7071 Vobarray
, Qcommandp
,
7072 Qt
, Qnil
, Qextended_command_history
, Qnil
);
7074 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
7075 error ("No command name given");
7077 /* Set this_command_keys to the concatenation of saved_keys and
7078 function, followed by a RET. */
7080 struct Lisp_String
*str
;
7085 this_command_key_count
= 0;
7086 this_single_command_key_start
= 0;
7088 keys
= XVECTOR (saved_keys
)->contents
;
7089 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
7090 add_command_key (keys
[i
]);
7092 str
= XSTRING (function
);
7093 for (i
= 0; i
< str
->size
; i
++)
7095 XSETFASTINT (tem
, str
->data
[i
]);
7096 add_command_key (tem
);
7099 XSETFASTINT (tem
, '\015');
7100 add_command_key (tem
);
7105 function
= Fintern (function
, Qnil
);
7106 current_kboard
->Vprefix_arg
= prefixarg
;
7107 this_command
= function
;
7109 /* If enabled, show which key runs this command. */
7110 if (!NILP (Vsuggest_key_bindings
)
7111 && NILP (Vexecuting_macro
)
7112 && SYMBOLP (function
))
7113 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
7119 GCPRO2 (bindings
, value
);
7120 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
7122 /* If the command has a key binding, print it now. */
7123 if (!NILP (bindings
))
7125 /* But first wait, and skip the message if there is input. */
7126 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7127 ? Vsuggest_key_bindings
: make_number (2)),
7129 && ! CONSP (Vunread_command_events
))
7131 Lisp_Object binding
;
7133 char *oldmessage
= echo_area_glyphs
;
7134 int oldmessage_len
= echo_area_glyphs_length
;
7136 binding
= Fkey_description (bindings
);
7139 = (char *) alloca (XSYMBOL (function
)->name
->size
7140 + XSTRING (binding
)->size
7142 sprintf (newmessage
, "You can run the command `%s' by typing %s",
7143 XSYMBOL (function
)->name
->data
,
7144 XSTRING (binding
)->data
);
7145 message1_nolog (newmessage
);
7146 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7147 ? Vsuggest_key_bindings
: make_number (2)),
7149 message2_nolog (oldmessage
, oldmessage_len
);
7153 RETURN_UNGCPRO (value
);
7156 /* Find the set of keymaps now active.
7157 Store into *MAPS_P a vector holding the various maps
7158 and return the number of them. The vector was malloc'd
7159 and the caller should free it. */
7162 current_active_maps (maps_p
)
7163 Lisp_Object
**maps_p
;
7165 Lisp_Object
*tmaps
, *maps
;
7168 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7169 if (!NILP (Voverriding_local_map_menu_flag
))
7171 /* Yes, use them (if non-nil) as well as the global map. */
7172 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
7174 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7175 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7176 if (!NILP (Voverriding_local_map
))
7177 maps
[nmaps
++] = Voverriding_local_map
;
7181 /* No, so use major and minor mode keymaps. */
7182 nmaps
= current_minor_maps (NULL
, &tmaps
);
7183 maps
= (Lisp_Object
*) xmalloc ((nmaps
+ 2) * sizeof (maps
[0]));
7184 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
7185 #ifdef USE_TEXT_PROPERTIES
7186 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
7188 maps
[nmaps
++] = current_buffer
->keymap
;
7191 maps
[nmaps
++] = current_global_map
;
7197 /* Return nonzero if input events are pending. */
7199 detect_input_pending ()
7202 get_input_pending (&input_pending
, 0);
7204 return input_pending
;
7207 /* Return nonzero if input events are pending, and run any pending timers. */
7209 detect_input_pending_run_timers (do_display
)
7212 int old_timers_run
= timers_run
;
7215 get_input_pending (&input_pending
, 1);
7217 if (old_timers_run
!= timers_run
&& do_display
)
7218 redisplay_preserve_echo_area ();
7220 return input_pending
;
7223 /* This is called in some cases before a possible quit.
7224 It cases the next call to detect_input_pending to recompute input_pending.
7225 So calling this function unnecessarily can't do any harm. */
7226 clear_input_pending ()
7231 /* Return nonzero if there are pending requeued events.
7232 This isn't used yet. The hope is to make wait_reading_process_input
7233 call it, and return return if it runs Lisp code that unreads something.
7234 The problem is, kbd_buffer_get_event needs to be fixed to know what
7235 to do in that case. It isn't trivial. */
7237 requeued_events_pending_p ()
7239 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
7243 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
7244 "T if command input is currently available with no waiting.\n\
7245 Actually, the value is nil only if we can be sure that no input is available.")
7248 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
7251 get_input_pending (&input_pending
, 1);
7252 return input_pending
> 0 ? Qt
: Qnil
;
7255 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
7256 "Return vector of last 100 events, not counting those from keyboard macros.")
7259 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
7262 if (total_keys
< NUM_RECENT_KEYS
)
7263 return Fvector (total_keys
, keys
);
7266 val
= Fvector (NUM_RECENT_KEYS
, keys
);
7267 bcopy (keys
+ recent_keys_index
,
7268 XVECTOR (val
)->contents
,
7269 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
7271 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
7272 recent_keys_index
* sizeof (Lisp_Object
));
7277 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
7278 "Return the key sequence that invoked this command.\n\
7279 The value is a string or a vector.")
7282 return make_event_array (this_command_key_count
,
7283 XVECTOR (this_command_keys
)->contents
);
7286 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
7287 Sthis_single_command_keys
, 0, 0, 0,
7288 "Return the key sequence that invoked this command.\n\
7289 Unlike `this-command-keys', this function's value\n\
7290 does not include prefix arguments.\n\
7291 The value is a string or a vector.")
7294 return make_event_array (this_command_key_count
7295 - this_single_command_key_start
,
7296 (XVECTOR (this_command_keys
)->contents
7297 + this_single_command_key_start
));
7300 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
7301 Sreset_this_command_lengths
, 0, 0, 0,
7302 "Used for complicated reasons in `universal-argument-other-key'.\n\
7304 `universal-argument-other-key' rereads the event just typed.\n\
7305 It then gets translated through `function-key-map'.\n\
7306 The translated event gets included in the echo area and in\n\
7307 the value of `this-command-keys' in addition to the raw original event.\n\
7308 That is not right.\n\
7310 Calling this function directs the translated event to replace\n\
7311 the original event, so that only one version of the event actually\n\
7312 appears in the echo area and in the value of `this-command-keys.'.")
7315 before_command_restore_flag
= 1;
7316 before_command_key_count_1
= before_command_key_count
;
7317 before_command_echo_length_1
= before_command_echo_length
;
7320 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
7321 "Return the current depth in recursive edits.")
7325 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
7329 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
7330 "FOpen dribble file: ",
7331 "Start writing all keyboard characters to a dribble file called FILE.\n\
7332 If FILE is nil, close any open dribble file.")
7343 file
= Fexpand_file_name (file
, Qnil
);
7344 dribble
= fopen (XSTRING (file
)->data
, "w");
7346 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
7351 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
7352 "Discard the contents of the terminal input buffer.\n\
7353 Also cancel any kbd macro being defined.")
7356 current_kboard
->defining_kbd_macro
= Qnil
;
7357 update_mode_lines
++;
7359 Vunread_command_events
= Qnil
;
7360 unread_command_char
= -1;
7362 discard_tty_input ();
7364 /* Without the cast, GCC complains that this assignment loses the
7365 volatile qualifier of kbd_store_ptr. Is there anything wrong
7367 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
7368 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7374 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
7375 "Stop Emacs and return to superior process. You can resume later.\n\
7376 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
7377 control, run a subshell instead.\n\n\
7378 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
7379 to be read as terminal input by Emacs's parent, after suspension.\n\
7381 Before suspending, run the normal hook `suspend-hook'.\n\
7382 After resumption run the normal hook `suspend-resume-hook'.\n\
7384 Some operating systems cannot stop the Emacs process and resume it later.\n\
7385 On such systems, Emacs starts a subshell instead of suspending.")
7387 Lisp_Object stuffstring
;
7390 int count
= specpdl_ptr
- specpdl
;
7391 int old_height
, old_width
;
7393 struct gcpro gcpro1
, gcpro2
;
7394 extern init_sys_modes ();
7396 if (!NILP (stuffstring
))
7397 CHECK_STRING (stuffstring
, 0);
7399 /* Run the functions in suspend-hook. */
7400 if (!NILP (Vrun_hooks
))
7401 call1 (Vrun_hooks
, intern ("suspend-hook"));
7403 GCPRO1 (stuffstring
);
7404 get_frame_size (&old_width
, &old_height
);
7406 /* sys_suspend can get an error if it tries to fork a subshell
7407 and the system resources aren't available for that. */
7408 record_unwind_protect (init_sys_modes
, 0);
7409 stuff_buffered_input (stuffstring
);
7414 unbind_to (count
, Qnil
);
7416 /* Check if terminal/window size has changed.
7417 Note that this is not useful when we are running directly
7418 with a window system; but suspend should be disabled in that case. */
7419 get_frame_size (&width
, &height
);
7420 if (width
!= old_width
|| height
!= old_height
)
7421 change_frame_size (selected_frame
, height
, width
, 0, 0);
7423 /* Run suspend-resume-hook. */
7424 if (!NILP (Vrun_hooks
))
7425 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
7431 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
7432 Then in any case stuff anything Emacs has read ahead and not used. */
7434 stuff_buffered_input (stuffstring
)
7435 Lisp_Object stuffstring
;
7437 /* stuff_char works only in BSD, versions 4.2 and up. */
7440 register unsigned char *p
;
7442 if (STRINGP (stuffstring
))
7446 p
= XSTRING (stuffstring
)->data
;
7447 count
= XSTRING (stuffstring
)->size
;
7452 /* Anything we have read ahead, put back for the shell to read. */
7453 /* ?? What should this do when we have multiple keyboards??
7454 Should we ignore anything that was typed in at the "wrong" kboard? */
7455 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
7457 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
7458 kbd_fetch_ptr
= kbd_buffer
;
7459 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
7460 stuff_char (kbd_fetch_ptr
->code
);
7461 kbd_fetch_ptr
->kind
= no_event
;
7462 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
7468 #endif /* BSD_SYSTEM and not BSD4_1 */
7471 set_waiting_for_input (time_to_clear
)
7472 EMACS_TIME
*time_to_clear
;
7474 input_available_clear_time
= time_to_clear
;
7476 /* Tell interrupt_signal to throw back to read_char, */
7477 waiting_for_input
= 1;
7479 /* If interrupt_signal was called before and buffered a C-g,
7480 make it run again now, to avoid timing error. */
7481 if (!NILP (Vquit_flag
))
7482 quit_throw_to_read_char ();
7485 clear_waiting_for_input ()
7487 /* Tell interrupt_signal not to throw back to read_char, */
7488 waiting_for_input
= 0;
7489 input_available_clear_time
= 0;
7492 /* This routine is called at interrupt level in response to C-G.
7493 If interrupt_input, this is the handler for SIGINT.
7494 Otherwise, it is called from kbd_buffer_store_event,
7495 in handling SIGIO or SIGTINT.
7497 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
7498 immediately throw back to read_char.
7500 Otherwise it sets the Lisp variable quit-flag not-nil.
7501 This causes eval to throw, when it gets a chance.
7502 If quit-flag is already non-nil, it stops the job right away. */
7505 interrupt_signal (signalnum
) /* If we don't have an argument, */
7506 int signalnum
; /* some compilers complain in signal calls. */
7509 /* Must preserve main program's value of errno. */
7510 int old_errno
= errno
;
7512 #if defined (USG) && !defined (POSIX_SIGNALS)
7513 if (!read_socket_hook
&& NILP (Vwindow_system
))
7515 /* USG systems forget handlers when they are used;
7516 must reestablish each time */
7517 signal (SIGINT
, interrupt_signal
);
7518 signal (SIGQUIT
, interrupt_signal
);
7524 if (!NILP (Vquit_flag
)
7525 && (FRAME_TERMCAP_P (selected_frame
) || FRAME_MSDOS_P (selected_frame
)))
7527 /* If SIGINT isn't blocked, don't let us be interrupted by
7528 another SIGINT, it might be harmful due to non-reentrancy
7529 in I/O functions. */
7530 sigblock (sigmask (SIGINT
));
7535 #ifdef SIGTSTP /* Support possible in later USG versions */
7537 * On systems which can suspend the current process and return to the original
7538 * shell, this command causes the user to end up back at the shell.
7539 * The "Auto-save" and "Abort" questions are not asked until
7540 * the user elects to return to emacs, at which point he can save the current
7541 * job and either dump core or continue.
7546 if (sys_suspend () == -1)
7548 printf ("Not running as a subprocess;\n");
7549 printf ("you can continue or abort.\n");
7552 /* Perhaps should really fork an inferior shell?
7553 But that would not provide any way to get back
7554 to the original shell, ever. */
7555 printf ("No support for stopping a process on this operating system;\n");
7556 printf ("you can continue or abort.\n");
7557 #endif /* not VMS */
7558 #endif /* not SIGTSTP */
7560 /* We must remain inside the screen area when the internal terminal
7561 is used. Note that [Enter] is not echoed by dos. */
7564 /* It doesn't work to autosave while GC is in progress;
7565 the code used for auto-saving doesn't cope with the mark bit. */
7566 if (!gc_in_progress
)
7568 printf ("Auto-save? (y or n) ");
7570 if (((c
= getchar ()) & ~040) == 'Y')
7572 Fdo_auto_save (Qt
, Qnil
);
7574 printf ("\r\nAuto-save done");
7575 #else /* not MSDOS */
7576 printf ("Auto-save done\n");
7577 #endif /* not MSDOS */
7579 while (c
!= '\n') c
= getchar ();
7583 /* During GC, it must be safe to reenable quitting again. */
7584 Vinhibit_quit
= Qnil
;
7587 #endif /* not MSDOS */
7588 printf ("Garbage collection in progress; cannot auto-save now\r\n");
7589 printf ("but will instead do a real quit after garbage collection ends\r\n");
7594 printf ("\r\nAbort? (y or n) ");
7595 #else /* not MSDOS */
7597 printf ("Abort (and enter debugger)? (y or n) ");
7599 printf ("Abort (and dump core)? (y or n) ");
7600 #endif /* not VMS */
7601 #endif /* not MSDOS */
7603 if (((c
= getchar ()) & ~040) == 'Y')
7605 while (c
!= '\n') c
= getchar ();
7607 printf ("\r\nContinuing...\r\n");
7608 #else /* not MSDOS */
7609 printf ("Continuing...\n");
7610 #endif /* not MSDOS */
7617 /* If executing a function that wants to be interrupted out of
7618 and the user has not deferred quitting by binding `inhibit-quit'
7619 then quit right away. */
7620 if (immediate_quit
&& NILP (Vinhibit_quit
))
7624 Fsignal (Qquit
, Qnil
);
7627 /* Else request quit when it's safe */
7631 if (waiting_for_input
&& !echoing
)
7632 quit_throw_to_read_char ();
7637 /* Handle a C-g by making read_char return C-g. */
7639 quit_throw_to_read_char ()
7641 quit_error_check ();
7643 /* Prevent another signal from doing this before we finish. */
7644 clear_waiting_for_input ();
7647 Vunread_command_events
= Qnil
;
7648 unread_command_char
= -1;
7650 #if 0 /* Currently, sit_for is called from read_char without turning
7651 off polling. And that can call set_waiting_for_input.
7652 It seems to be harmless. */
7653 #ifdef POLL_FOR_INPUT
7654 /* May be > 1 if in recursive minibuffer. */
7655 if (poll_suppress_count
== 0)
7659 if (FRAMEP (internal_last_event_frame
)
7660 && XFRAME (internal_last_event_frame
) != selected_frame
)
7661 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
7664 _longjmp (getcjmp
, 1);
7667 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
7668 "Set mode of reading keyboard input.\n\
7669 First arg INTERRUPT non-nil means use input interrupts;\n\
7670 nil means use CBREAK mode.\n\
7671 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
7672 (no effect except in CBREAK mode).\n\
7673 Third arg META t means accept 8-bit input (for a Meta key).\n\
7674 META nil means ignore the top bit, on the assumption it is parity.\n\
7675 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
7676 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
7677 See also `current-input-mode'.")
7678 (interrupt
, flow
, meta
, quit
)
7679 Lisp_Object interrupt
, flow
, meta
, quit
;
7682 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
7683 error ("set-input-mode: QUIT must be an ASCII character");
7685 #ifdef POLL_FOR_INPUT
7690 /* this causes startup screen to be restored and messes with the mouse */
7695 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7696 if (read_socket_hook
)
7698 /* When using X, don't give the user a real choice,
7699 because we haven't implemented the mechanisms to support it. */
7700 #ifdef NO_SOCK_SIGIO
7701 interrupt_input
= 0;
7702 #else /* not NO_SOCK_SIGIO */
7703 interrupt_input
= 1;
7704 #endif /* NO_SOCK_SIGIO */
7707 interrupt_input
= !NILP (interrupt
);
7708 #else /* not SIGIO */
7709 interrupt_input
= 0;
7710 #endif /* not SIGIO */
7712 /* Our VMS input only works by interrupts, as of now. */
7714 interrupt_input
= 1;
7717 flow_control
= !NILP (flow
);
7720 else if (EQ (meta
, Qt
))
7725 /* Don't let this value be out of range. */
7726 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
7732 #ifdef POLL_FOR_INPUT
7733 poll_suppress_count
= 1;
7739 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
7740 "Return information about the way Emacs currently reads keyboard input.\n\
7741 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
7742 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
7743 nil, Emacs is using CBREAK mode.\n\
7744 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
7745 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
7746 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
7747 META nil means ignoring the top bit, on the assumption it is parity.\n\
7748 META is neither t nor nil if accepting 8-bit input and using\n\
7749 all 8 bits as the character code.\n\
7750 QUIT is the character Emacs currently uses to quit.\n\
7751 The elements of this list correspond to the arguments of\n\
7757 val
[0] = interrupt_input
? Qt
: Qnil
;
7758 val
[1] = flow_control
? Qt
: Qnil
;
7759 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
7760 XSETFASTINT (val
[3], quit_char
);
7762 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
7767 * Set up a new kboard object with reasonable initial values.
7773 kb
->Voverriding_terminal_local_map
= Qnil
;
7774 kb
->Vlast_command
= Qnil
;
7775 kb
->Vprefix_arg
= Qnil
;
7776 kb
->kbd_queue
= Qnil
;
7777 kb
->kbd_queue_has_data
= 0;
7778 kb
->immediate_echo
= 0;
7779 kb
->echoptr
= kb
->echobuf
;
7780 kb
->echo_after_prompt
= -1;
7781 kb
->kbd_macro_buffer
= 0;
7782 kb
->kbd_macro_bufsize
= 0;
7783 kb
->defining_kbd_macro
= Qnil
;
7784 kb
->Vlast_kbd_macro
= Qnil
;
7785 kb
->reference_count
= 0;
7786 kb
->Vsystem_key_alist
= Qnil
;
7787 kb
->system_key_syms
= Qnil
;
7788 kb
->Vdefault_minibuffer_frame
= Qnil
;
7792 * Destroy the contents of a kboard object, but not the object itself.
7793 * We use this just before deleting it, or if we're going to initialize
7800 if (kb
->kbd_macro_buffer
)
7801 xfree (kb
->kbd_macro_buffer
);
7810 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
7813 *kbp
= kb
->next_kboard
;
7821 /* This is correct before outermost invocation of the editor loop */
7822 command_loop_level
= -1;
7824 quit_char
= Ctl ('g');
7825 Vunread_command_events
= Qnil
;
7826 unread_command_char
= -1;
7827 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
7829 recent_keys_index
= 0;
7830 kbd_fetch_ptr
= kbd_buffer
;
7831 kbd_store_ptr
= kbd_buffer
;
7832 kbd_buffer_frame_or_window
7833 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7835 do_mouse_tracking
= Qnil
;
7839 /* This means that command_loop_1 won't try to select anything the first
7841 internal_last_event_frame
= Qnil
;
7842 Vlast_event_frame
= internal_last_event_frame
;
7845 current_kboard
= initial_kboard
;
7847 wipe_kboard (current_kboard
);
7848 init_kboard (current_kboard
);
7851 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7853 kbd_buffer_frame_or_window
7854 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7855 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
7857 signal (SIGINT
, interrupt_signal
);
7858 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
7859 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
7860 SIGQUIT and we can't tell which one it will give us. */
7861 signal (SIGQUIT
, interrupt_signal
);
7862 #endif /* HAVE_TERMIO */
7864 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7866 if (!noninteractive
)
7867 signal (SIGIO
, input_available_signal
);
7870 /* Use interrupt input by default, if it works and noninterrupt input
7871 has deficiencies. */
7873 #ifdef INTERRUPT_INPUT
7874 interrupt_input
= 1;
7876 interrupt_input
= 0;
7879 /* Our VMS input only works by interrupts, as of now. */
7881 interrupt_input
= 1;
7887 if (keyboard_init_hook
)
7888 (*keyboard_init_hook
) ();
7890 #ifdef POLL_FOR_INPUT
7891 poll_suppress_count
= 1;
7896 /* This type's only use is in syms_of_keyboard, to initialize the
7897 event header symbols and put properties on them. */
7904 struct event_head head_table
[] = {
7905 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
7906 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
7907 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
7908 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
7909 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
7910 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
7915 Qtimer_event_handler
= intern ("timer-event-handler");
7916 staticpro (&Qtimer_event_handler
);
7918 Qdisabled_command_hook
= intern ("disabled-command-hook");
7919 staticpro (&Qdisabled_command_hook
);
7921 Qself_insert_command
= intern ("self-insert-command");
7922 staticpro (&Qself_insert_command
);
7924 Qforward_char
= intern ("forward-char");
7925 staticpro (&Qforward_char
);
7927 Qbackward_char
= intern ("backward-char");
7928 staticpro (&Qbackward_char
);
7930 Qdisabled
= intern ("disabled");
7931 staticpro (&Qdisabled
);
7933 Qundefined
= intern ("undefined");
7934 staticpro (&Qundefined
);
7936 Qpre_command_hook
= intern ("pre-command-hook");
7937 staticpro (&Qpre_command_hook
);
7939 Qpost_command_hook
= intern ("post-command-hook");
7940 staticpro (&Qpost_command_hook
);
7942 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
7943 staticpro (&Qpost_command_idle_hook
);
7945 Qdeferred_action_function
= intern ("deferred-action-function");
7946 staticpro (&Qdeferred_action_function
);
7948 Qcommand_hook_internal
= intern ("command-hook-internal");
7949 staticpro (&Qcommand_hook_internal
);
7951 Qfunction_key
= intern ("function-key");
7952 staticpro (&Qfunction_key
);
7953 Qmouse_click
= intern ("mouse-click");
7954 staticpro (&Qmouse_click
);
7956 Qmenu_enable
= intern ("menu-enable");
7957 staticpro (&Qmenu_enable
);
7959 Qmode_line
= intern ("mode-line");
7960 staticpro (&Qmode_line
);
7961 Qvertical_line
= intern ("vertical-line");
7962 staticpro (&Qvertical_line
);
7963 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
7964 staticpro (&Qvertical_scroll_bar
);
7965 Qmenu_bar
= intern ("menu-bar");
7966 staticpro (&Qmenu_bar
);
7968 Qabove_handle
= intern ("above-handle");
7969 staticpro (&Qabove_handle
);
7970 Qhandle
= intern ("handle");
7971 staticpro (&Qhandle
);
7972 Qbelow_handle
= intern ("below-handle");
7973 staticpro (&Qbelow_handle
);
7974 Qup
= intern ("up");
7976 Qdown
= intern ("down");
7979 Qevent_kind
= intern ("event-kind");
7980 staticpro (&Qevent_kind
);
7981 Qevent_symbol_elements
= intern ("event-symbol-elements");
7982 staticpro (&Qevent_symbol_elements
);
7983 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
7984 staticpro (&Qevent_symbol_element_mask
);
7985 Qmodifier_cache
= intern ("modifier-cache");
7986 staticpro (&Qmodifier_cache
);
7988 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
7989 staticpro (&Qrecompute_lucid_menubar
);
7990 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
7991 staticpro (&Qactivate_menubar_hook
);
7993 Qpolling_period
= intern ("polling-period");
7994 staticpro (&Qpolling_period
);
7997 struct event_head
*p
;
7999 for (p
= head_table
;
8000 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
8003 *p
->var
= intern (p
->name
);
8005 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
8006 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
8010 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
8011 staticpro (&button_down_location
);
8015 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
8017 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
8018 for (i
= 0; i
< len
; i
++)
8019 if (modifier_names
[i
])
8020 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
8021 staticpro (&modifier_symbols
);
8024 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
8025 staticpro (&recent_keys
);
8027 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
8028 staticpro (&this_command_keys
);
8030 Qextended_command_history
= intern ("extended-command-history");
8031 Fset (Qextended_command_history
, Qnil
);
8032 staticpro (&Qextended_command_history
);
8034 kbd_buffer_frame_or_window
8035 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8036 staticpro (&kbd_buffer_frame_or_window
);
8038 accent_key_syms
= Qnil
;
8039 staticpro (&accent_key_syms
);
8041 func_key_syms
= Qnil
;
8042 staticpro (&func_key_syms
);
8045 staticpro (&mouse_syms
);
8047 unread_switch_frame
= Qnil
;
8048 staticpro (&unread_switch_frame
);
8050 internal_last_event_frame
= Qnil
;
8051 staticpro (&internal_last_event_frame
);
8053 read_key_sequence_cmd
= Qnil
;
8054 staticpro (&read_key_sequence_cmd
);
8056 defsubr (&Sevent_convert_list
);
8057 defsubr (&Sread_key_sequence
);
8058 defsubr (&Srecursive_edit
);
8060 defsubr (&Strack_mouse
);
8062 defsubr (&Sinput_pending_p
);
8063 defsubr (&Scommand_execute
);
8064 defsubr (&Srecent_keys
);
8065 defsubr (&Sthis_command_keys
);
8066 defsubr (&Sthis_single_command_keys
);
8067 defsubr (&Sreset_this_command_lengths
);
8068 defsubr (&Ssuspend_emacs
);
8069 defsubr (&Sabort_recursive_edit
);
8070 defsubr (&Sexit_recursive_edit
);
8071 defsubr (&Srecursion_depth
);
8072 defsubr (&Stop_level
);
8073 defsubr (&Sdiscard_input
);
8074 defsubr (&Sopen_dribble_file
);
8075 defsubr (&Sset_input_mode
);
8076 defsubr (&Scurrent_input_mode
);
8077 defsubr (&Sexecute_extended_command
);
8079 DEFVAR_LISP ("last-command-char", &last_command_char
,
8080 "Last input event that was part of a command.");
8082 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
8083 "Last input event that was part of a command.");
8085 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
8086 "Last input event in a command, except for mouse menu events.\n\
8087 Mouse menus give back keys that don't look like mouse events;\n\
8088 this variable holds the actual mouse event that led to the menu,\n\
8089 so that you can determine whether the command was run by mouse or not.");
8091 DEFVAR_LISP ("last-input-char", &last_input_char
,
8092 "Last input event.");
8094 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
8095 "Last input event.");
8097 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
8098 "List of objects to be read as next command input events.");
8100 DEFVAR_INT ("unread-command-char", &unread_command_char
,
8101 "If not -1, an object to be read as next command input event.");
8103 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
8104 "Meta-prefix character code. Meta-foo as command input\n\
8105 turns into this character followed by foo.");
8106 XSETINT (meta_prefix_char
, 033);
8108 DEFVAR_KBOARD ("last-command", Vlast_command
,
8109 "The last command executed. Normally a symbol with a function definition,\n\
8110 but can be whatever was found in the keymap, or whatever the variable\n\
8111 `this-command' was set to by that command.\n\
8113 The value `mode-exit' is special; it means that the previous command\n\
8114 read an event that told it to exit, and it did so and unread that event.\n\
8115 In other words, the present command is the event that made the previous\n\
8118 The value `kill-region' is special; it means that the previous command\n\
8119 was a kill command.");
8121 DEFVAR_LISP ("this-command", &this_command
,
8122 "The command now being executed.\n\
8123 The command can set this variable; whatever is put here\n\
8124 will be in `last-command' during the following command.");
8125 this_command
= Qnil
;
8127 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
8128 "*Number of keyboard input characters between auto-saves.\n\
8129 Zero means disable autosaving due to number of characters typed.");
8130 auto_save_interval
= 300;
8132 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
8133 "*Number of seconds idle time before auto-save.\n\
8134 Zero or nil means disable auto-saving due to idleness.\n\
8135 After auto-saving due to this many seconds of idle time,\n\
8136 Emacs also does a garbage collection if that seems to be warranted.");
8137 XSETFASTINT (Vauto_save_timeout
, 30);
8139 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
8140 "*Nonzero means echo unfinished commands after this many seconds of pause.");
8141 echo_keystrokes
= 1;
8143 DEFVAR_INT ("polling-period", &polling_period
,
8144 "*Interval between polling for input during Lisp execution.\n\
8145 The reason for polling is to make C-g work to stop a running program.\n\
8146 Polling is needed only when using X windows and SIGIO does not work.\n\
8147 Polling is automatically disabled in all other cases.");
8150 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
8151 "*Maximum time between mouse clicks to make a double-click.\n\
8152 Measured in milliseconds. nil means disable double-click recognition;\n\
8153 t means double-clicks have no time limit and are detected\n\
8154 by position only.");
8155 Vdouble_click_time
= make_number (500);
8157 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
8158 "*Non-nil means inhibit local map menu bar menus.");
8159 inhibit_local_menu_bar_menus
= 0;
8161 DEFVAR_INT ("num-input-keys", &num_input_keys
,
8162 "Number of complete key sequences read as input so far.\n\
8163 This includes key sequences read from keyboard macros.\n\
8164 The number is effectively the number of interactive command invocations.");
8167 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
8168 "Number of input events read from the keyboard so far.\n\
8169 This does not include events generated by keyboard macros.");
8170 num_nonmacro_input_events
= 0;
8172 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
8173 "The frame in which the most recently read event occurred.\n\
8174 If the last event came from a keyboard macro, this is set to `macro'.");
8175 Vlast_event_frame
= Qnil
;
8177 /* This variable is set up in sysdep.c. */
8178 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
8179 "The ERASE character as set by the user with stty.");
8181 DEFVAR_LISP ("help-char", &Vhelp_char
,
8182 "Character to recognize as meaning Help.\n\
8183 When it is read, do `(eval help-form)', and display result if it's a string.\n\
8184 If the value of `help-form' is nil, this char can be read normally.");
8185 XSETINT (Vhelp_char
, Ctl ('H'));
8187 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
8188 "List of input events to recognize as meaning Help.\n\
8189 These work just like the value of `help-char' (see that).");
8190 Vhelp_event_list
= Qnil
;
8192 DEFVAR_LISP ("help-form", &Vhelp_form
,
8193 "Form to execute when character `help-char' is read.\n\
8194 If the form returns a string, that string is displayed.\n\
8195 If `help-form' is nil, the help char is not recognized.");
8198 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
8199 "Command to run when `help-char' character follows a prefix key.\n\
8200 This command is used only when there is no actual binding\n\
8201 for that character after that prefix key.");
8202 Vprefix_help_command
= Qnil
;
8204 DEFVAR_LISP ("top-level", &Vtop_level
,
8205 "Form to evaluate when Emacs starts up.\n\
8206 Useful to set before you dump a modified Emacs.");
8209 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
8210 "Translate table for keyboard input, or nil.\n\
8211 Each character is looked up in this string and the contents used instead.\n\
8212 The value may be a string, a vector, or a char-table.\n\
8213 If it is a string or vector of length N,\n\
8214 character codes N and up are untranslated.\n\
8215 In a vector or a char-table, an element which is nil means \"no translation\".");
8216 Vkeyboard_translate_table
= Qnil
;
8218 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
8219 "Non-nil means to always spawn a subshell instead of suspending,\n\
8220 even if the operating system has support for stopping a process.");
8223 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
8224 "Non-nil means prompt with menus when appropriate.\n\
8225 This is done when reading from a keymap that has a prompt string,\n\
8226 for elements that have prompt strings.\n\
8227 The menu is displayed on the screen\n\
8228 if X menus were enabled at configuration\n\
8229 time and the previous event was a mouse click prefix key.\n\
8230 Otherwise, menu prompting uses the echo area.");
8233 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
8234 "Character to see next line of menu prompt.\n\
8235 Type this character while in a menu prompt to rotate around the lines of it.");
8236 XSETINT (menu_prompt_more_char
, ' ');
8238 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
8239 "A mask of additional modifier keys to use with every keyboard character.\n\
8240 Emacs applies the modifiers of the character stored here to each keyboard\n\
8241 character it reads. For example, after evaluating the expression\n\
8242 (setq extra-keyboard-modifiers ?\\C-x)\n\
8243 all input characters will have the control modifier applied to them.\n\
8245 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
8246 not count as a control character; rather, it counts as a character\n\
8247 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
8248 cancels any modification.");
8249 extra_keyboard_modifiers
= 0;
8251 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
8252 "If an editing command sets this to t, deactivate the mark afterward.\n\
8253 The command loop sets this to nil before each command,\n\
8254 and tests the value when the command returns.\n\
8255 Buffer modification stores t in this variable.");
8256 Vdeactivate_mark
= Qnil
;
8258 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
8259 "Temporary storage of pre-command-hook or post-command-hook.");
8260 Vcommand_hook_internal
= Qnil
;
8262 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
8263 "Normal hook run before each command is executed.\n\
8264 Errors running the hook are caught and ignored.");
8265 Vpre_command_hook
= Qnil
;
8267 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
8268 "Normal hook run after each command is executed.\n\
8269 Errors running the hook are caught and ignored.");
8270 Vpost_command_hook
= Qnil
;
8272 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
8273 "Normal hook run after each command is executed, if idle.\n\
8274 Errors running the hook are caught and ignored.\n\
8275 This feature is obsolete; use idle timers instead. See `etc/NEWS'.");
8276 Vpost_command_idle_hook
= Qnil
;
8278 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
8279 "Delay time before running `post-command-idle-hook'.\n\
8280 This is measured in microseconds.");
8281 post_command_idle_delay
= 100000;
8284 DEFVAR_LISP ("echo-area-clear-hook", ...,
8285 "Normal hook run when clearing the echo area.");
8287 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
8288 XSYMBOL (Qecho_area_clear_hook
)->value
= Qnil
;
8290 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
8291 "t means menu bar, specified Lucid style, needs to be recomputed.");
8292 Vlucid_menu_bar_dirty_flag
= Qnil
;
8294 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
8295 "List of menu bar items to move to the end of the menu bar.\n\
8296 The elements of the list are event types that may have menu bar bindings.");
8297 Vmenu_bar_final_items
= Qnil
;
8299 DEFVAR_KBOARD ("overriding-terminal-local-map",
8300 Voverriding_terminal_local_map
,
8301 "Per-terminal keymap that overrides all other local keymaps.\n\
8302 If this variable is non-nil, it is used as a keymap instead of the\n\
8303 buffer's local map, and the minor mode keymaps and text property keymaps.\n\
8304 This variable is intended to let commands such as `universal-argumemnt'\n\
8305 set up a different keymap for reading the next command.");
8307 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
8308 "Keymap that overrides all other local keymaps.\n\
8309 If this variable is non-nil, it is used as a keymap instead of the\n\
8310 buffer's local map, and the minor mode keymaps and text property keymaps.");
8311 Voverriding_local_map
= Qnil
;
8313 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
8314 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
8315 Otherwise, the menu bar continues to reflect the buffer's local map\n\
8316 and the minor mode maps regardless of `overriding-local-map'.");
8317 Voverriding_local_map_menu_flag
= Qnil
;
8319 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
8320 "Keymap defining bindings for special events to execute at low level.");
8321 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
8323 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
8324 "*Non-nil means generate motion events for mouse motion.");
8326 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
8327 "Alist of system-specific X windows key symbols.\n\
8328 Each element should have the form (N . SYMBOL) where N is the\n\
8329 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
8330 and SYMBOL is its name.");
8332 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
8333 "List of deferred actions to be performed at a later time.\n\
8334 The precise format isn't relevant here; we just check whether it is nil.");
8335 Vdeferred_action_list
= Qnil
;
8337 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
8338 "Function to call to handle deferred actions, after each command.\n\
8339 This function is called with no arguments after each command\n\
8340 whenever `deferred-action-list' is non-nil.");
8341 Vdeferred_action_function
= Qnil
;
8343 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
8344 "Non-nil means show the equivalent key-binding when M-x command has one.\n\
8345 The value can be a length of time to show the message for.\n\
8346 If the value is non-nil and not a number, we wait 2 seconds.");
8347 Vsuggest_key_bindings
= Qt
;
8349 DEFVAR_LISP ("timer-list", &Vtimer_list
,
8350 "List of active absolute time timers in order of increasing time");
8353 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
8354 "List of active idle-time timers in order of increasing time");
8355 Vtimer_idle_list
= Qnil
;
8360 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
8361 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
8362 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
8363 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
8364 initial_define_key (meta_map
, 'x', "execute-extended-command");
8366 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
8367 "handle-delete-frame");
8368 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
8370 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",