1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95,96 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"
36 #include "dispextern.h"
38 #include "intervals.h"
39 #include "blockinput.h"
48 #include <sys/ioctl.h>
50 #endif /* not MSDOS */
52 #include "syssignal.h"
55 /* This is to get the definitions of the XK_ symbols. */
62 #endif /* HAVE_NTGUI */
64 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
69 /* Variables for blockinput.h: */
71 /* Non-zero if interrupt input is blocked right now. */
72 int interrupt_input_blocked
;
74 /* Nonzero means an input interrupt has arrived
75 during the current critical section. */
76 int interrupt_input_pending
;
79 /* File descriptor to use for input. */
82 #ifdef HAVE_WINDOW_SYSTEM
83 /* Make all keyboard buffers much bigger when using X windows. */
84 #define KBD_BUFFER_SIZE 4096
85 #else /* No X-windows, character input */
86 #define KBD_BUFFER_SIZE 256
87 #endif /* No X-windows */
89 /* Following definition copied from eval.c */
93 struct backtrace
*next
;
94 Lisp_Object
*function
;
95 Lisp_Object
*args
; /* Points to vector of args. */
96 int nargs
; /* length of vector. If nargs is UNEVALLED,
97 args points to slot holding list of
103 KBOARD
*initial_kboard
;
104 KBOARD
*current_kboard
;
108 KBOARD the_only_kboard
;
111 /* Non-nil disable property on a command means
112 do not execute it; call disabled-command-hook's value instead. */
113 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
115 #define NUM_RECENT_KEYS (100)
116 int recent_keys_index
; /* Index for storing next element into recent_keys */
117 int total_keys
; /* Total number of elements stored into recent_keys */
118 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
120 /* Vector holding the key sequence that invoked the current command.
121 It is reused for each command, and it may be longer than the current
122 sequence; this_command_key_count indicates how many elements
123 actually mean something.
124 It's easier to staticpro a single Lisp_Object than an array. */
125 Lisp_Object this_command_keys
;
126 int this_command_key_count
;
128 /* Number of elements of this_command_keys
129 that precede this key sequence. */
130 int this_single_command_key_start
;
132 /* Record values of this_command_key_count and echo_length ()
133 before this command was read. */
134 static int before_command_key_count
;
135 static int before_command_echo_length
;
136 /* Values of before_command_key_count and before_command_echo_length
137 saved by reset-this-command-lengths. */
138 static int before_command_key_count_1
;
139 static int before_command_echo_length_1
;
140 /* Flag set by reset-this-command-lengths,
141 saying to reset the lengths when add_command_key is called. */
142 static int before_command_restore_flag
;
144 extern int minbuf_level
;
146 extern struct backtrace
*backtrace_list
;
148 /* Nonzero means do menu prompting. */
149 static int menu_prompting
;
151 /* Character to see next line of menu prompt. */
152 static Lisp_Object menu_prompt_more_char
;
154 /* For longjmp to where kbd input is being done. */
155 static jmp_buf getcjmp
;
157 /* True while doing kbd input. */
158 int waiting_for_input
;
160 /* True while displaying for echoing. Delays C-g throwing. */
163 /* True means we can start echoing at the next input pause
164 even though there is something in the echo area. */
165 static char *ok_to_echo_at_next_pause
;
167 /* Nonzero means disregard local maps for the menu bar. */
168 static int inhibit_local_menu_bar_menus
;
170 /* Nonzero means C-g should cause immediate error-signal. */
173 /* Character to recognize as the help char. */
174 Lisp_Object Vhelp_char
;
176 /* List of other event types to recognize as meaning "help". */
177 Lisp_Object Vhelp_event_list
;
179 /* Form to execute when help char is typed. */
180 Lisp_Object Vhelp_form
;
182 /* Command to run when the help character follows a prefix key. */
183 Lisp_Object Vprefix_help_command
;
185 /* List of items that should move to the end of the menu bar. */
186 Lisp_Object Vmenu_bar_final_items
;
188 /* Non-nil means show the equivalent key-binding for
189 any M-x command that has one.
190 The value can be a length of time to show the message for.
191 If the value is non-nil and not a number, we wait 2 seconds. */
192 Lisp_Object Vsuggest_key_bindings
;
194 /* Character that causes a quit. Normally C-g.
196 If we are running on an ordinary terminal, this must be an ordinary
197 ASCII char, since we want to make it our interrupt character.
199 If we are not running on an ordinary terminal, it still needs to be
200 an ordinary ASCII char. This character needs to be recognized in
201 the input interrupt handler. At this point, the keystroke is
202 represented as a struct input_event, while the desired quit
203 character is specified as a lispy event. The mapping from struct
204 input_events to lispy events cannot run in an interrupt handler,
205 and the reverse mapping is difficult for anything but ASCII
208 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
212 extern Lisp_Object current_global_map
;
213 extern int minibuf_level
;
215 /* If non-nil, this is a map that overrides all other local maps. */
216 Lisp_Object Voverriding_local_map
;
218 /* If non-nil, Voverriding_local_map applies to the menu bar. */
219 Lisp_Object Voverriding_local_map_menu_flag
;
221 /* Keymap that defines special misc events that should
222 be processed immediately at a low level. */
223 Lisp_Object Vspecial_event_map
;
225 /* Current depth in recursive edits. */
226 int command_loop_level
;
228 /* Total number of times command_loop has read a key sequence. */
231 /* Last input character read as a command. */
232 Lisp_Object last_command_char
;
234 /* Last input character read as a command, not counting menus
235 reached by the mouse. */
236 Lisp_Object last_nonmenu_event
;
238 /* Last input character read for any purpose. */
239 Lisp_Object last_input_char
;
241 /* If not Qnil, a list of objects to be read as subsequent command input. */
242 Lisp_Object Vunread_command_events
;
244 /* If not -1, an event to be read as subsequent command input. */
245 int unread_command_char
;
247 /* If not Qnil, this is a switch-frame event which we decided to put
248 off until the end of a key sequence. This should be read as the
249 next command input, after any unread_command_events.
251 read_key_sequence uses this to delay switch-frame events until the
252 end of the key sequence; Fread_char uses it to put off switch-frame
253 events until a non-ASCII event is acceptable as input. */
254 Lisp_Object unread_switch_frame
;
256 /* A mask of extra modifier bits to put into every keyboard char. */
257 int extra_keyboard_modifiers
;
259 /* Char to use as prefix when a meta character is typed in.
260 This is bound on entry to minibuffer in case ESC is changed there. */
262 Lisp_Object meta_prefix_char
;
264 /* Last size recorded for a current buffer which is not a minibuffer. */
265 static int last_non_minibuf_size
;
267 /* Number of idle seconds before an auto-save and garbage collection. */
268 static Lisp_Object Vauto_save_timeout
;
270 /* Total number of times read_char has returned. */
273 /* Total number of times read_char has returned, outside of macros. */
274 int num_nonmacro_input_chars
;
276 /* Auto-save automatically when this many characters have been typed
277 since the last time. */
279 static int auto_save_interval
;
281 /* Value of num_nonmacro_input_chars as of last auto save. */
285 /* The command being executed by the command loop.
286 Commands may set this, and the value set will be copied into
287 current_kboard->Vlast_command instead of the actual command. */
288 Lisp_Object this_command
;
290 /* The value of point when the last command was executed. */
291 int last_point_position
;
293 /* The buffer that was current when the last command was started. */
294 Lisp_Object last_point_position_buffer
;
297 /* The frame in which the last input event occurred, or Qmacro if the
298 last event came from a macro. We use this to determine when to
299 generate switch-frame events. This may be cleared by functions
300 like Fselect_frame, to make sure that a switch-frame event is
301 generated by the next character. */
302 Lisp_Object internal_last_event_frame
;
305 /* A user-visible version of the above, intended to allow users to
306 figure out where the last event came from, if the event doesn't
307 carry that information itself (i.e. if it was a character). */
308 Lisp_Object Vlast_event_frame
;
310 /* The timestamp of the last input event we received from the X server.
311 X Windows wants this for selection ownership. */
312 unsigned long last_event_timestamp
;
314 Lisp_Object Qself_insert_command
;
315 Lisp_Object Qforward_char
;
316 Lisp_Object Qbackward_char
;
317 Lisp_Object Qundefined
;
319 /* read_key_sequence stores here the command definition of the
320 key sequence that it reads. */
321 Lisp_Object read_key_sequence_cmd
;
323 /* Form to evaluate (if non-nil) when Emacs is started. */
324 Lisp_Object Vtop_level
;
326 /* User-supplied string to translate input characters through. */
327 Lisp_Object Vkeyboard_translate_table
;
329 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
330 extern Lisp_Object Vfunction_key_map
;
332 /* Another keymap that maps key sequences into key sequences.
333 This one takes precedence over ordinary definitions. */
334 extern Lisp_Object Vkey_translation_map
;
336 /* Non-nil means deactivate the mark at end of this command. */
337 Lisp_Object Vdeactivate_mark
;
339 /* Menu bar specified in Lucid Emacs fashion. */
341 Lisp_Object Vlucid_menu_bar_dirty_flag
;
342 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
344 /* Hooks to run before and after each command. */
345 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
346 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
347 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
348 /* Hook run after a command if there's no more input soon. */
349 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
351 /* Delay time in microseconds before running post-command-idle-hook. */
352 int post_command_idle_delay
;
354 /* List of deferred actions to be performed at a later time.
355 The precise format isn't relevant here; we just check whether it is nil. */
356 Lisp_Object Vdeferred_action_list
;
358 /* Function to call to handle deferred actions, when there are any. */
359 Lisp_Object Vdeferred_action_function
;
360 Lisp_Object Qdeferred_action_function
;
362 /* File in which we write all commands we read. */
365 /* Nonzero if input is available. */
368 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
369 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
373 extern char *pending_malloc_warning
;
375 /* Circular buffer for pre-read keyboard input. */
376 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
378 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
380 The interrupt-level event handlers will never enqueue an event on a
381 frame which is not in Vframe_list, and once an event is dequeued,
382 internal_last_event_frame or the event itself points to the frame.
385 But while the event is sitting in the queue, it's completely
386 unprotected. Suppose the user types one command which will run for
387 a while and then delete a frame, and then types another event at
388 the frame that will be deleted, before the command gets around to
389 it. Suppose there are no references to this frame elsewhere in
390 Emacs, and a GC occurs before the second event is dequeued. Now we
391 have an event referring to a freed frame, which will crash Emacs
394 Similar things happen when an event on a scroll bar is enqueued; the
395 window may be deleted while the event is in the queue.
397 So, we use this vector to protect the frame_or_window field in the
398 event queue. That way, they'll be dequeued as dead frames or
399 windows, but still valid lisp objects.
401 If kbd_buffer[i].kind != no_event, then
402 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
403 == kbd_buffer[i].frame_or_window. */
404 static Lisp_Object kbd_buffer_frame_or_window
;
406 /* Pointer to next available character in kbd_buffer.
407 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
408 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
409 next available char is in kbd_buffer[0]. */
410 static struct input_event
*kbd_fetch_ptr
;
412 /* Pointer to next place to store character in kbd_buffer. This
413 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
414 character should go in kbd_buffer[0]. */
415 static volatile struct input_event
*kbd_store_ptr
;
417 /* The above pair of variables forms a "queue empty" flag. When we
418 enqueue a non-hook event, we increment kbd_store_ptr. When we
419 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
420 there is input available iff the two pointers are not equal.
422 Why not just have a flag set and cleared by the enqueuing and
423 dequeuing functions? Such a flag could be screwed up by interrupts
424 at inopportune times. */
426 /* If this flag is non-nil, we check mouse_moved to see when the
427 mouse moves, and motion events will appear in the input stream.
428 Otherwise, mouse motion is ignored. */
429 static Lisp_Object do_mouse_tracking
;
431 /* Symbols to head events. */
432 Lisp_Object Qmouse_movement
;
433 Lisp_Object Qscroll_bar_movement
;
434 Lisp_Object Qswitch_frame
;
435 Lisp_Object Qdelete_frame
;
436 Lisp_Object Qiconify_frame
;
437 Lisp_Object Qmake_frame_visible
;
439 /* Symbols to denote kinds of events. */
440 Lisp_Object Qfunction_key
;
441 Lisp_Object Qmouse_click
;
442 Lisp_Object Qtimer_event
;
443 /* Lisp_Object Qmouse_movement; - also an event header */
445 /* Properties of event headers. */
446 Lisp_Object Qevent_kind
;
447 Lisp_Object Qevent_symbol_elements
;
449 Lisp_Object Qmenu_enable
;
451 /* An event header symbol HEAD may have a property named
452 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
453 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
454 mask of modifiers applied to it. If present, this is used to help
455 speed up parse_modifiers. */
456 Lisp_Object Qevent_symbol_element_mask
;
458 /* An unmodified event header BASE may have a property named
459 Qmodifier_cache, which is an alist mapping modifier masks onto
460 modified versions of BASE. If present, this helps speed up
462 Lisp_Object Qmodifier_cache
;
464 /* Symbols to use for parts of windows. */
465 Lisp_Object Qmode_line
;
466 Lisp_Object Qvertical_line
;
467 Lisp_Object Qvertical_scroll_bar
;
468 Lisp_Object Qmenu_bar
;
470 extern Lisp_Object Qmenu_enable
;
472 Lisp_Object
recursive_edit_unwind (), command_loop ();
473 Lisp_Object
Fthis_command_keys ();
474 Lisp_Object Qextended_command_history
;
475 EMACS_TIME
timer_check ();
477 extern char *x_get_keysym_name ();
479 Lisp_Object Qpolling_period
;
481 /* List of absolute timers. Appears in order of next scheduled event. */
482 Lisp_Object Vtimer_list
;
484 /* List of idle time timers. Appears in order of next scheduled event. */
485 Lisp_Object Vtimer_idle_list
;
487 /* Incremented whenever a timer is run. */
490 extern Lisp_Object Vprint_level
, Vprint_length
;
492 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
494 EMACS_TIME
*input_available_clear_time
;
496 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
497 Default is 1 if INTERRUPT_INPUT is defined. */
500 /* Nonzero while interrupts are temporarily deferred during redisplay. */
501 int interrupts_deferred
;
503 /* Nonzero means use ^S/^Q for flow control. */
506 /* Allow m- file to inhibit use of FIONREAD. */
507 #ifdef BROKEN_FIONREAD
511 /* We are unable to use interrupts if FIONREAD is not available,
512 so flush SIGIO so we won't try. */
519 /* If we support a window system, turn on the code to poll periodically
520 to detect C-g. It isn't actually used when doing interrupt input. */
521 #ifdef HAVE_WINDOW_SYSTEM
522 #define POLL_FOR_INPUT
525 /* Non-nil enables Column Number mode. */
526 Lisp_Object Vcolumn_number_mode
;
528 /* Global variable declarations. */
530 /* Function for init_keyboard to call with no args (if nonzero). */
531 void (*keyboard_init_hook
) ();
533 static int read_avail_input ();
534 static void get_input_pending ();
535 static int readable_events ();
536 static Lisp_Object
read_char_x_menu_prompt ();
537 static Lisp_Object
read_char_minibuf_menu_prompt ();
538 static Lisp_Object
make_lispy_event ();
540 static Lisp_Object
make_lispy_movement ();
542 static Lisp_Object
modify_event_symbol ();
543 static Lisp_Object
make_lispy_switch_frame ();
544 static int parse_solitary_modifier ();
546 /* > 0 if we are to echo keystrokes. */
547 static int echo_keystrokes
;
549 /* Nonzero means don't try to suspend even if the operating system seems
551 static int cannot_suspend
;
553 #define min(a,b) ((a)<(b)?(a):(b))
554 #define max(a,b) ((a)>(b)?(a):(b))
556 /* Install the string STR as the beginning of the string of echoing,
557 so that it serves as a prompt for the next character.
558 Also start echoing. */
563 int len
= strlen (str
);
565 if (len
> ECHOBUFSIZE
- 4)
566 len
= ECHOBUFSIZE
- 4;
567 bcopy (str
, current_kboard
->echobuf
, len
);
568 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
569 *current_kboard
->echoptr
= '\0';
571 current_kboard
->echo_after_prompt
= len
;
576 /* Add C to the echo string, if echoing is going on.
577 C can be a character, which is printed prettily ("M-C-x" and all that
578 jazz), or a symbol, whose name is printed. */
583 extern char *push_key_description ();
585 if (current_kboard
->immediate_echo
)
587 char *ptr
= current_kboard
->echoptr
;
589 if (ptr
!= current_kboard
->echobuf
)
592 /* If someone has passed us a composite event, use its head symbol. */
597 if (ptr
- current_kboard
->echobuf
> ECHOBUFSIZE
- 6)
600 ptr
= push_key_description (XINT (c
), ptr
);
602 else if (SYMBOLP (c
))
604 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
605 if ((ptr
- current_kboard
->echobuf
) + name
->size
+ 4 > ECHOBUFSIZE
)
607 bcopy (name
->data
, ptr
, name
->size
);
611 if (current_kboard
->echoptr
== current_kboard
->echobuf
614 strcpy (ptr
, " (Type ? for further options)");
619 current_kboard
->echoptr
= ptr
;
625 /* Temporarily add a dash to the end of the echo string if it's not
626 empty, so that it serves as a mini-prompt for the very next character. */
630 if (!current_kboard
->immediate_echo
631 && current_kboard
->echoptr
== current_kboard
->echobuf
)
633 /* Do nothing if we just printed a prompt. */
634 if (current_kboard
->echo_after_prompt
635 == current_kboard
->echoptr
- current_kboard
->echobuf
)
637 /* Do nothing if not echoing at all. */
638 if (current_kboard
->echoptr
== 0)
641 /* Put a dash at the end of the buffer temporarily,
642 but make it go away when the next character is added. */
643 current_kboard
->echoptr
[0] = '-';
644 current_kboard
->echoptr
[1] = 0;
649 /* Display the current echo string, and begin echoing if not already
654 if (!current_kboard
->immediate_echo
)
657 current_kboard
->immediate_echo
= 1;
659 for (i
= 0; i
< this_command_key_count
; i
++)
662 c
= XVECTOR (this_command_keys
)->contents
[i
];
663 if (! (EVENT_HAS_PARAMETERS (c
)
664 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
671 message1_nolog (current_kboard
->echobuf
);
674 if (waiting_for_input
&& !NILP (Vquit_flag
))
675 quit_throw_to_read_char ();
678 /* Turn off echoing, for the start of a new command. */
682 current_kboard
->immediate_echo
= 0;
683 current_kboard
->echoptr
= current_kboard
->echobuf
;
684 current_kboard
->echo_after_prompt
= -1;
685 ok_to_echo_at_next_pause
= 0;
688 /* Return the length of the current echo string. */
693 return current_kboard
->echoptr
- current_kboard
->echobuf
;
696 /* Truncate the current echo message to its first LEN chars.
697 This and echo_char get used by read_key_sequence when the user
698 switches frames while entering a key sequence. */
704 current_kboard
->echobuf
[len
] = '\0';
705 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
706 truncate_echo_area (len
);
710 /* Functions for manipulating this_command_keys. */
712 add_command_key (key
)
715 int size
= XVECTOR (this_command_keys
)->size
;
717 /* If reset-this-command-length was called recently, obey it now.
718 See the doc string of that function for an explanation of why. */
719 if (before_command_restore_flag
)
721 this_command_key_count
= before_command_key_count_1
;
722 if (this_command_key_count
< this_single_command_key_start
)
723 this_single_command_key_start
= this_command_key_count
;
724 echo_truncate (before_command_echo_length_1
);
725 before_command_restore_flag
= 0;
728 if (this_command_key_count
>= size
)
730 Lisp_Object new_keys
;
732 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
733 bcopy (XVECTOR (this_command_keys
)->contents
,
734 XVECTOR (new_keys
)->contents
,
735 size
* sizeof (Lisp_Object
));
737 this_command_keys
= new_keys
;
740 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
746 int count
= specpdl_ptr
- specpdl
;
749 if (command_loop_level
> 0)
751 specbind (Qstandard_output
, Qt
);
752 specbind (Qstandard_input
, Qt
);
755 val
= command_loop ();
757 Fsignal (Qquit
, Qnil
);
759 return unbind_to (count
, Qnil
);
762 /* When an auto-save happens, record the "time", and don't do again soon. */
766 last_auto_save
= num_nonmacro_input_chars
;
769 /* Make an auto save happen as soon as possible at command level. */
771 force_auto_save_soon ()
773 last_auto_save
= - auto_save_interval
- 1;
775 record_asynch_buffer_change ();
778 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
779 "Invoke the editor command loop recursively.\n\
780 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
781 that tells this function to return.\n\
782 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
783 This function is called by the editor initialization to begin editing.")
786 int count
= specpdl_ptr
- specpdl
;
789 command_loop_level
++;
790 update_mode_lines
= 1;
792 record_unwind_protect (recursive_edit_unwind
,
794 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
798 return unbind_to (count
, Qnil
);
802 recursive_edit_unwind (buffer
)
806 Fset_buffer (buffer
);
808 command_loop_level
--;
809 update_mode_lines
= 1;
817 #if 0 /* Theory: if there's anything in Vunread_command_events,
818 it will right away be read by read_key_sequence,
819 and then if we do switch KBOARDS, it will go into the side
820 queue then. So we don't need to do anything special here -- rms. */
821 if (CONSP (Vunread_command_events
))
823 current_kboard
->kbd_queue
824 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
825 current_kboard
->kbd_queue_has_data
= 1;
827 Vunread_command_events
= Qnil
;
833 /* Switch to the single-kboard state, making current_kboard
834 the only KBOARD from which further input is accepted. */
837 single_kboard_state ()
844 /* Maintain a stack of kboards, so other parts of Emacs
845 can switch temporarily to the kboard of a given frame
846 and then revert to the previous status. */
851 struct kboard_stack
*next
;
854 static struct kboard_stack
*kboard_stack
;
857 push_frame_kboard (f
)
861 struct kboard_stack
*p
862 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
864 p
->next
= kboard_stack
;
865 p
->kboard
= current_kboard
;
868 current_kboard
= FRAME_KBOARD (f
);
876 struct kboard_stack
*p
= kboard_stack
;
877 current_kboard
= p
->kboard
;
878 kboard_stack
= p
->next
;
883 /* Handle errors that are not handled at inner levels
884 by printing an error message and returning to the editor command loop. */
890 Lisp_Object old_level
, old_length
;
892 Vstandard_output
= Qt
;
893 Vstandard_input
= Qt
;
894 Vexecuting_macro
= Qnil
;
895 current_kboard
->Vprefix_arg
= Qnil
;
898 /* Avoid unquittable loop if data contains a circular list. */
899 old_level
= Vprint_level
;
900 old_length
= Vprint_length
;
901 XSETFASTINT (Vprint_level
, 10);
902 XSETFASTINT (Vprint_length
, 10);
903 cmd_error_internal (data
, NULL
);
904 Vprint_level
= old_level
;
905 Vprint_length
= old_length
;
909 Vinhibit_quit
= Qnil
;
914 return make_number (0);
917 cmd_error_internal (data
, context
)
925 echo_area_glyphs
= 0;
927 /* If the window system or terminal frame hasn't been initialized
928 yet, or we're not interactive, it's best to dump this message out
929 to stderr and exit. */
930 if (! FRAME_MESSAGE_BUF (selected_frame
)
932 stream
= Qexternal_debugging_output
;
941 write_string_1 (context
, -1, stream
);
943 print_error_message (data
, stream
);
945 /* If the window system or terminal frame hasn't been initialized
946 yet, or we're in -batch mode, this error should cause Emacs to exit. */
947 if (! FRAME_MESSAGE_BUF (selected_frame
)
951 Fkill_emacs (make_number (-1));
955 Lisp_Object
command_loop_1 ();
956 Lisp_Object
command_loop_2 ();
957 Lisp_Object
top_level_1 ();
959 /* Entry to editor-command-loop.
960 This level has the catches for exiting/returning to editor command loop.
961 It returns nil to exit recursive edit, t to abort it. */
966 if (command_loop_level
> 0 || minibuf_level
> 0)
968 return internal_catch (Qexit
, command_loop_2
, Qnil
);
973 internal_catch (Qtop_level
, top_level_1
, Qnil
);
974 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
976 /* End of file in -batch run causes exit here. */
982 /* Here we catch errors in execution of commands within the
983 editing loop, and reenter the editing loop.
984 When there is an error, cmd_error runs and returns a non-nil
985 value to us. A value of nil means that cmd_loop_1 itself
986 returned due to end of file (or end of kbd macro). */
991 register Lisp_Object val
;
994 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1003 return Feval (Vtop_level
);
1009 /* On entry to the outer level, run the startup file */
1010 if (!NILP (Vtop_level
))
1011 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1012 else if (!NILP (Vpurify_flag
))
1013 message ("Bare impure Emacs (standard Lisp code not loaded)");
1015 message ("Bare Emacs (standard Lisp code not loaded)");
1019 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1020 "Exit all recursive editing levels.")
1023 Fthrow (Qtop_level
, Qnil
);
1026 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1027 "Exit from the innermost recursive edit or minibuffer.")
1030 if (command_loop_level
> 0 || minibuf_level
> 0)
1031 Fthrow (Qexit
, Qnil
);
1033 error ("No recursive edit is in progress");
1036 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1037 "Abort the command that requested this recursive edit or minibuffer input.")
1040 if (command_loop_level
> 0 || minibuf_level
> 0)
1043 error ("No recursive edit is in progress");
1046 /* This is the actual command reading loop,
1047 sans error-handling encapsulation. */
1049 Lisp_Object
Fcommand_execute ();
1050 static int read_key_sequence ();
1051 void safe_run_hooks ();
1056 Lisp_Object cmd
, tem
;
1059 Lisp_Object keybuf
[30];
1064 struct buffer
*prev_buffer
;
1066 int was_locked
= single_kboard
;
1069 current_kboard
->Vprefix_arg
= Qnil
;
1070 Vdeactivate_mark
= Qnil
;
1071 waiting_for_input
= 0;
1076 this_command_key_count
= 0;
1077 this_single_command_key_start
= 0;
1079 /* Make sure this hook runs after commands that get errors and
1080 throw to top level. */
1081 /* Note that the value cell will never directly contain nil
1082 if the symbol is a local variable. */
1083 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1084 safe_run_hooks (Qpost_command_hook
);
1086 if (!NILP (Vdeferred_action_list
))
1087 call0 (Vdeferred_action_function
);
1089 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1091 if (NILP (Vunread_command_events
)
1092 && NILP (Vexecuting_macro
)
1093 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1)))
1094 safe_run_hooks (Qpost_command_idle_hook
);
1097 /* Do this after running Vpost_command_hook, for consistency. */
1098 current_kboard
->Vlast_command
= this_command
;
1102 /* Make sure the current window's buffer is selected. */
1103 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1104 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1106 /* Display any malloc warning that just came out. Use while because
1107 displaying one warning can cause another. */
1109 while (pending_malloc_warning
)
1110 display_malloc_warning ();
1114 Vdeactivate_mark
= Qnil
;
1116 /* If minibuffer on and echo area in use,
1117 wait 2 sec and redraw minibuffer. */
1119 if (minibuf_level
&& echo_area_glyphs
1120 && EQ (minibuf_window
, echo_area_window
))
1122 /* Bind inhibit-quit to t so that C-g gets read in
1123 rather than quitting back to the minibuffer. */
1124 int count
= specpdl_ptr
- specpdl
;
1125 specbind (Qinhibit_quit
, Qt
);
1127 Fsit_for (make_number (2), Qnil
, Qnil
);
1128 /* Clear the echo area. */
1131 unbind_to (count
, Qnil
);
1133 /* If a C-g came in before, treat it as input now. */
1134 if (!NILP (Vquit_flag
))
1137 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1142 alloca (0); /* Cause a garbage collection now */
1143 /* Since we can free the most stuff here. */
1144 #endif /* C_ALLOCA */
1148 /* Select the frame that the last event came from. Usually,
1149 switch-frame events will take care of this, but if some lisp
1150 code swallows a switch-frame event, we'll fix things up here.
1151 Is this a good idea? */
1152 if (FRAMEP (internal_last_event_frame
)
1153 && XFRAME (internal_last_event_frame
) != selected_frame
)
1154 Fselect_frame (internal_last_event_frame
, Qnil
);
1157 /* If it has changed current-menubar from previous value,
1158 really recompute the menubar from the value. */
1159 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1160 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1161 call0 (Qrecompute_lucid_menubar
);
1163 before_command_key_count
= this_command_key_count
;
1164 before_command_echo_length
= echo_length ();
1166 this_command
= Qnil
;
1168 /* Read next key sequence; i gets its length. */
1169 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1174 /* Now we have read a key sequence of length I,
1175 or else I is 0 and we found end of file. */
1177 if (i
== 0) /* End of file -- happens only in */
1178 return Qnil
; /* a kbd macro, at the end. */
1179 /* -1 means read_key_sequence got a menu that was rejected.
1180 Just loop around and read another command. */
1184 this_command_key_count
= 0;
1185 this_single_command_key_start
= 0;
1189 last_command_char
= keybuf
[i
- 1];
1191 /* If the previous command tried to force a specific window-start,
1192 forget about that, in case this command moves point far away
1193 from that position. But also throw away beg_unchanged and
1194 end_unchanged information in that case, so that redisplay will
1195 update the whole window properly. */
1196 if (!NILP (XWINDOW (selected_window
)->force_start
))
1198 XWINDOW (selected_window
)->force_start
= Qnil
;
1199 beg_unchanged
= end_unchanged
= 0;
1202 cmd
= read_key_sequence_cmd
;
1203 if (!NILP (Vexecuting_macro
))
1205 if (!NILP (Vquit_flag
))
1207 Vexecuting_macro
= Qt
;
1208 QUIT
; /* Make some noise. */
1209 /* Will return since macro now empty. */
1213 /* Do redisplay processing after this command except in special
1214 cases identified below that set no_redisplay to 1.
1215 (actually, there's currently no way to prevent the redisplay,
1216 and no_redisplay is ignored.
1217 Perhaps someday we will really implement it.) */
1220 prev_buffer
= current_buffer
;
1221 prev_modiff
= MODIFF
;
1222 last_point_position
= PT
;
1223 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1225 /* Execute the command. */
1228 /* Note that the value cell will never directly contain nil
1229 if the symbol is a local variable. */
1230 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1231 safe_run_hooks (Qpre_command_hook
);
1233 if (NILP (this_command
))
1235 /* nil means key is undefined. */
1237 current_kboard
->defining_kbd_macro
= Qnil
;
1238 update_mode_lines
= 1;
1239 current_kboard
->Vprefix_arg
= Qnil
;
1243 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1245 /* Recognize some common commands in common situations and
1246 do them directly. */
1247 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1249 struct Lisp_Char_Table
*dp
1250 = window_display_table (XWINDOW (selected_window
));
1251 lose
= FETCH_CHAR (PT
);
1254 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1255 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1256 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1257 && (lose
>= 0x20 && lose
< 0x7f)))
1258 : (lose
>= 0x20 && lose
< 0x7f))
1259 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1261 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1263 && !windows_or_buffers_changed
1264 && EQ (current_buffer
->selective_display
, Qnil
)
1265 && !detect_input_pending ()
1266 && NILP (Vcolumn_number_mode
)
1267 && NILP (Vexecuting_macro
))
1268 no_redisplay
= direct_output_forward_char (1);
1271 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1273 struct Lisp_Char_Table
*dp
1274 = window_display_table (XWINDOW (selected_window
));
1276 lose
= FETCH_CHAR (PT
);
1278 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1279 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1280 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1281 && (lose
>= 0x20 && lose
< 0x7f)))
1282 : (lose
>= 0x20 && lose
< 0x7f))
1283 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1285 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1287 && !windows_or_buffers_changed
1288 && EQ (current_buffer
->selective_display
, Qnil
)
1289 && !detect_input_pending ()
1290 && NILP (Vcolumn_number_mode
)
1291 && NILP (Vexecuting_macro
))
1292 no_redisplay
= direct_output_forward_char (-1);
1295 else if (EQ (this_command
, Qself_insert_command
)
1296 /* Try this optimization only on ascii keystrokes. */
1297 && INTEGERP (last_command_char
))
1299 unsigned char c
= XINT (last_command_char
);
1302 if (NILP (Vexecuting_macro
)
1303 && !EQ (minibuf_window
, selected_window
))
1305 if (!nonundocount
|| nonundocount
>= 20)
1312 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1314 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1316 || MODIFF
<= SAVE_MODIFF
1317 || windows_or_buffers_changed
1318 || !EQ (current_buffer
->selective_display
, Qnil
)
1319 || detect_input_pending ()
1320 || !NILP (Vcolumn_number_mode
)
1321 || !NILP (Vexecuting_macro
));
1322 value
= internal_self_insert (c
, 0);
1329 && (PT
== ZV
|| FETCH_CHAR (PT
) == '\n'))
1331 struct Lisp_Char_Table
*dp
1332 = window_display_table (XWINDOW (selected_window
));
1339 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1342 /* Do it only for char codes
1343 that by default display as themselves. */
1344 if (lose
>= 0x20 && lose
<= 0x7e)
1345 no_redisplay
= direct_output_for_insert (lose
);
1347 else if (VECTORP (obj
)
1348 && XVECTOR (obj
)->size
== 1
1349 && (obj
= XVECTOR (obj
)->contents
[0],
1351 /* Insist face not specified in glyph. */
1352 && (XINT (obj
) & ((-1) << 8)) == 0)
1354 = direct_output_for_insert (XINT (obj
));
1358 if (lose
>= 0x20 && lose
<= 0x7e)
1359 no_redisplay
= direct_output_for_insert (lose
);
1366 /* Here for a command that isn't executed directly */
1369 if (NILP (current_kboard
->Vprefix_arg
))
1371 Fcommand_execute (this_command
, Qnil
, Qnil
, Qnil
);
1376 /* Note that the value cell will never directly contain nil
1377 if the symbol is a local variable. */
1378 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1379 safe_run_hooks (Qpost_command_hook
);
1381 if (!NILP (Vdeferred_action_list
))
1382 safe_run_hooks (Qdeferred_action_function
);
1384 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1386 if (NILP (Vunread_command_events
)
1387 && NILP (Vexecuting_macro
)
1388 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1)))
1389 safe_run_hooks (Qpost_command_idle_hook
);
1392 /* If there is a prefix argument,
1393 1) We don't want Vlast_command to be ``universal-argument''
1394 (that would be dumb), so don't set Vlast_command,
1395 2) we want to leave echoing on so that the prefix will be
1396 echoed as part of this key sequence, so don't call
1398 3) we want to leave this_command_key_count non-zero, so that
1399 read_char will realize that it is re-reading a character, and
1400 not echo it a second time.
1402 If the command didn't actually create a prefix arg,
1403 but is merely a frame event that is transparent to prefix args,
1404 then the above doesn't apply. */
1405 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1407 current_kboard
->Vlast_command
= this_command
;
1409 this_command_key_count
= 0;
1410 this_single_command_key_start
= 0;
1413 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1415 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1417 current_buffer
->mark_active
= Qnil
;
1418 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1420 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1421 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1425 /* Install chars successfully executed in kbd macro. */
1427 if (!NILP (current_kboard
->defining_kbd_macro
)
1428 && NILP (current_kboard
->Vprefix_arg
))
1429 finalize_kbd_macro_chars ();
1433 any_kboard_state ();
1438 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1441 safe_run_hooks_1 (hook
)
1444 return call1 (Vrun_hooks
, Vinhibit_quit
);
1447 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1450 safe_run_hooks_error (data
)
1453 Fset (Vinhibit_quit
, Qnil
);
1456 /* If we get an error while running the hook, cause the hook variable
1457 to be nil. Also inhibit quits, so that C-g won't cause the hook
1458 to mysteriously evaporate. */
1461 safe_run_hooks (hook
)
1465 int count
= specpdl_ptr
- specpdl
;
1466 specbind (Qinhibit_quit
, hook
);
1468 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1470 unbind_to (count
, Qnil
);
1473 /* Number of seconds between polling for input. */
1476 /* Nonzero means polling for input is temporarily suppressed. */
1477 int poll_suppress_count
;
1479 /* Nonzero if polling_for_input is actually being used. */
1480 int polling_for_input
;
1482 #ifdef POLL_FOR_INPUT
1484 /* Handle an alarm once each second and read pending input
1485 so as to handle a C-g if it comces in. */
1488 input_poll_signal (signalnum
) /* If we don't have an argument, */
1489 int signalnum
; /* some compilers complain in signal calls. */
1491 /* This causes the call to start_polling at the end
1492 to do its job. It also arranges for a quit or error
1493 from within read_avail_input to resume polling. */
1494 poll_suppress_count
++;
1495 if (interrupt_input_blocked
== 0
1496 && !waiting_for_input
)
1497 read_avail_input (0);
1498 /* Turn on the SIGALRM handler and request another alarm. */
1504 /* Begin signals to poll for input, if they are appropriate.
1505 This function is called unconditionally from various places. */
1509 #ifdef POLL_FOR_INPUT
1510 if (read_socket_hook
&& !interrupt_input
)
1512 poll_suppress_count
--;
1513 if (poll_suppress_count
== 0)
1515 signal (SIGALRM
, input_poll_signal
);
1516 polling_for_input
= 1;
1517 alarm (polling_period
);
1523 /* Nonzero if we are using polling to handle input asynchronously. */
1526 input_polling_used ()
1528 #ifdef POLL_FOR_INPUT
1529 return read_socket_hook
&& !interrupt_input
;
1535 /* Turn off polling. */
1539 #ifdef POLL_FOR_INPUT
1540 if (read_socket_hook
&& !interrupt_input
)
1542 if (poll_suppress_count
== 0)
1544 polling_for_input
= 0;
1547 poll_suppress_count
++;
1552 /* Set the value of poll_suppress_count to COUNT
1553 and start or stop polling accordingly. */
1556 set_poll_suppress_count (count
)
1559 #ifdef POLL_FOR_INPUT
1560 if (count
== 0 && poll_suppress_count
!= 0)
1562 poll_suppress_count
= 1;
1565 else if (count
!= 0 && poll_suppress_count
== 0)
1569 poll_suppress_count
= count
;
1573 /* Bind polling_period to a value at least N.
1574 But don't decrease it. */
1576 bind_polling_period (n
)
1579 #ifdef POLL_FOR_INPUT
1580 int new = polling_period
;
1586 specbind (Qpolling_period
, make_number (new));
1587 /* Start a new alarm with the new period. */
1592 /* Apply the control modifier to CHARACTER. */
1598 /* Save the upper bits here. */
1599 int upper
= c
& ~0177;
1603 /* Everything in the columns containing the upper-case letters
1604 denotes a control character. */
1605 if (c
>= 0100 && c
< 0140)
1609 /* Set the shift modifier for a control char
1610 made from a shifted letter. But only for letters! */
1611 if (oc
>= 'A' && oc
<= 'Z')
1612 c
|= shift_modifier
;
1615 /* The lower-case letters denote control characters too. */
1616 else if (c
>= 'a' && c
<= 'z')
1619 /* Include the bits for control and shift
1620 only if the basic ASCII code can't indicate them. */
1624 /* Replace the high bits. */
1625 c
|= (upper
& ~ctrl_modifier
);
1632 /* Input of single characters from keyboard */
1634 Lisp_Object
print_help ();
1635 static Lisp_Object
kbd_buffer_get_event ();
1636 static void record_char ();
1639 static jmp_buf wrong_kboard_jmpbuf
;
1642 /* read a character from the keyboard; call the redisplay if needed */
1643 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1644 -1 means do not do redisplay, but do do autosaving.
1647 /* The arguments MAPS and NMAPS are for menu prompting.
1648 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1650 PREV_EVENT is the previous input event, or nil if we are reading
1651 the first event of a key sequence.
1653 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
1654 if we used a mouse menu to read the input, or zero otherwise. If
1655 USED_MOUSE_MENU is null, we don't dereference it.
1657 Value is t if we showed a menu and the user rejected it. */
1660 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1664 Lisp_Object prev_event
;
1665 int *used_mouse_menu
;
1667 register Lisp_Object c
;
1669 jmp_buf local_getcjmp
;
1671 int key_already_recorded
= 0;
1672 Lisp_Object tem
, save
;
1673 Lisp_Object also_record
;
1676 before_command_key_count
= this_command_key_count
;
1677 before_command_echo_length
= echo_length ();
1681 if (CONSP (Vunread_command_events
))
1683 c
= XCONS (Vunread_command_events
)->car
;
1684 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1686 /* Undo what read_char_x_menu_prompt did when it unread
1687 additional keys returned by Fx_popup_menu. */
1689 && (SYMBOLP (XCONS (c
)->car
) || INTEGERP (XCONS (c
)->car
))
1690 && NILP (XCONS (c
)->cdr
))
1693 if (this_command_key_count
== 0)
1699 if (unread_command_char
!= -1)
1701 XSETINT (c
, unread_command_char
);
1702 unread_command_char
= -1;
1704 if (this_command_key_count
== 0)
1710 /* If there is no function key translated before
1711 reset-this-command-lengths takes effect, forget about it. */
1712 before_command_restore_flag
= 0;
1714 if (!NILP (Vexecuting_macro
))
1717 /* We set this to Qmacro; since that's not a frame, nobody will
1718 try to switch frames on us, and the selected window will
1721 Since this event came from a macro, it would be misleading to
1722 leave internal_last_event_frame set to wherever the last
1723 real event came from. Normally, a switch-frame event selects
1724 internal_last_event_frame after each command is read, but
1725 events read from a macro should never cause a new frame to be
1727 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1730 /* Exit the macro if we are at the end.
1731 Also, some things replace the macro with t
1732 to force an early exit. */
1733 if (EQ (Vexecuting_macro
, Qt
)
1734 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1740 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1741 if (STRINGP (Vexecuting_macro
)
1742 && (XINT (c
) & 0x80))
1743 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
1745 executing_macro_index
++;
1750 if (!NILP (unread_switch_frame
))
1752 c
= unread_switch_frame
;
1753 unread_switch_frame
= Qnil
;
1755 /* This event should make it into this_command_keys, and get echoed
1756 again, so we go to reread_first, rather than reread. */
1760 if (commandflag
>= 0 && !input_pending
1761 && !detect_input_pending_run_timers (0))
1764 /* Message turns off echoing unless more keystrokes turn it on again. */
1765 if (echo_area_glyphs
&& *echo_area_glyphs
1766 && echo_area_glyphs
!= current_kboard
->echobuf
1767 && ok_to_echo_at_next_pause
!= echo_area_glyphs
)
1770 /* If already echoing, continue. */
1773 /* Try reading a character via menu prompting in the minibuf.
1774 Try this before the sit-for, because the sit-for
1775 would do the wrong thing if we are supposed to do
1776 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1777 after a mouse event so don't try a minibuf menu. */
1779 if (nmaps
> 0 && INTERACTIVE
1780 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1781 /* Don't bring up a menu if we already have another event. */
1782 && NILP (Vunread_command_events
)
1783 && unread_command_char
< 0
1784 && !detect_input_pending_run_timers (0))
1786 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1789 key_already_recorded
= 1;
1794 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
1795 We will do that below, temporarily for short sections of code,
1796 when appropriate. local_getcjmp must be in effect
1797 around any call to sit_for or kbd_buffer_get_event;
1798 it *must not* be in effect when we call redisplay. */
1800 if (_setjmp (local_getcjmp
))
1802 XSETINT (c
, quit_char
);
1804 XSETFRAME (internal_last_event_frame
, selected_frame
);
1805 Vlast_event_frame
= internal_last_event_frame
;
1807 /* If we report the quit char as an event,
1808 don't do so more than once. */
1809 if (!NILP (Vinhibit_quit
))
1814 KBOARD
*kb
= FRAME_KBOARD (selected_frame
);
1815 if (kb
!= current_kboard
)
1817 Lisp_Object
*tailp
= &kb
->kbd_queue
;
1818 /* We shouldn't get here if we were in single-kboard mode! */
1821 while (CONSP (*tailp
))
1822 tailp
= &XCONS (*tailp
)->cdr
;
1825 *tailp
= Fcons (c
, Qnil
);
1826 kb
->kbd_queue_has_data
= 1;
1827 current_kboard
= kb
;
1828 longjmp (wrong_kboard_jmpbuf
, 1);
1835 timer_start_idle ();
1837 /* If in middle of key sequence and minibuffer not active,
1838 start echoing if enough time elapses. */
1840 if (minibuf_level
== 0 && !current_kboard
->immediate_echo
1841 && this_command_key_count
> 0
1843 && echo_keystrokes
> 0
1844 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0
1845 || ok_to_echo_at_next_pause
== echo_area_glyphs
))
1849 /* After a mouse event, start echoing right away.
1850 This is because we are probably about to display a menu,
1851 and we don't want to delay before doing so. */
1852 if (EVENT_HAS_PARAMETERS (prev_event
))
1856 save_getcjmp (save_jump
);
1857 restore_getcjmp (local_getcjmp
);
1858 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1859 restore_getcjmp (save_jump
);
1865 /* Maybe auto save due to number of keystrokes. */
1867 if (commandflag
!= 0
1868 && auto_save_interval
> 0
1869 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1870 && !detect_input_pending_run_timers (0))
1872 Fdo_auto_save (Qnil
, Qnil
);
1873 /* Hooks can actually change some buffers in auto save. */
1877 /* Try reading using an X menu.
1878 This is never confused with reading using the minibuf
1879 because the recursive call of read_char in read_char_minibuf_menu_prompt
1880 does not pass on any keymaps. */
1882 if (nmaps
> 0 && INTERACTIVE
1883 && !NILP (prev_event
)
1884 && EVENT_HAS_PARAMETERS (prev_event
)
1885 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
)
1886 /* Don't bring up a menu if we already have another event. */
1887 && NILP (Vunread_command_events
)
1888 && unread_command_char
< 0)
1889 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1891 /* Maybe autosave and/or garbage collect due to idleness. */
1893 if (INTERACTIVE
&& NILP (c
))
1895 int delay_level
, buffer_size
;
1897 /* Slow down auto saves logarithmically in size of current buffer,
1898 and garbage collect while we're at it. */
1899 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1900 last_non_minibuf_size
= Z
- BEG
;
1901 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1903 while (buffer_size
> 64)
1904 delay_level
++, buffer_size
-= buffer_size
>> 2;
1905 if (delay_level
< 4) delay_level
= 4;
1906 /* delay_level is 4 for files under around 50k, 7 at 100k,
1907 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1909 /* Auto save if enough time goes by without input. */
1910 if (commandflag
!= 0
1911 && num_nonmacro_input_chars
> last_auto_save
1912 && INTEGERP (Vauto_save_timeout
)
1913 && XINT (Vauto_save_timeout
) > 0)
1917 save_getcjmp (save_jump
);
1918 restore_getcjmp (local_getcjmp
);
1919 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
1921 restore_getcjmp (save_jump
);
1925 Fdo_auto_save (Qnil
, Qnil
);
1927 /* If we have auto-saved and there is still no input
1928 available, garbage collect if there has been enough
1929 consing going on to make it worthwhile. */
1930 if (!detect_input_pending_run_timers (0)
1931 && consing_since_gc
> gc_cons_threshold
/ 2)
1932 Fgarbage_collect ();
1939 /* Read something from current KBOARD's side queue, if possible. */
1943 if (current_kboard
->kbd_queue_has_data
)
1945 if (!CONSP (current_kboard
->kbd_queue
))
1947 c
= XCONS (current_kboard
->kbd_queue
)->car
;
1948 current_kboard
->kbd_queue
1949 = XCONS (current_kboard
->kbd_queue
)->cdr
;
1950 if (NILP (current_kboard
->kbd_queue
))
1951 current_kboard
->kbd_queue_has_data
= 0;
1952 input_pending
= readable_events (0);
1954 if (EVENT_HAS_PARAMETERS (c
)
1955 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
1956 internal_last_event_frame
= XCONS (XCONS (c
)->cdr
)->car
;
1957 Vlast_event_frame
= internal_last_event_frame
;
1963 /* If current_kboard's side queue is empty check the other kboards.
1964 If one of them has data that we have not yet seen here,
1965 switch to it and process the data waiting for it.
1967 Note: if the events queued up for another kboard
1968 have already been seen here, and therefore are not a complete command,
1969 the kbd_queue_has_data field is 0, so we skip that kboard here.
1970 That's to avoid an infinite loop switching between kboards here. */
1971 if (NILP (c
) && !single_kboard
)
1974 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
1975 if (kb
->kbd_queue_has_data
)
1977 current_kboard
= kb
;
1978 longjmp (wrong_kboard_jmpbuf
, 1);
1987 /* Finally, we read from the main queue,
1988 and if that gives us something we can't use yet, we put it on the
1989 appropriate side queue and try again. */
1995 /* Actually read a character, waiting if necessary. */
1996 save_getcjmp (save_jump
);
1997 restore_getcjmp (local_getcjmp
);
1998 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
1999 restore_getcjmp (save_jump
);
2002 if (! NILP (c
) && (kb
!= current_kboard
))
2004 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2005 while (CONSP (*tailp
))
2006 tailp
= &XCONS (*tailp
)->cdr
;
2009 *tailp
= Fcons (c
, Qnil
);
2010 kb
->kbd_queue_has_data
= 1;
2014 current_kboard
= kb
;
2015 longjmp (wrong_kboard_jmpbuf
, 1);
2020 /* Terminate Emacs in batch mode if at eof. */
2021 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2022 Fkill_emacs (make_number (1));
2026 /* Add in any extra modifiers, where appropriate. */
2027 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2028 || ((extra_keyboard_modifiers
& 0177) < ' '
2029 && (extra_keyboard_modifiers
& 0177) != 0))
2030 XSETINT (c
, make_ctrl_char (XINT (c
)));
2032 /* Transfer any other modifier bits directly from
2033 extra_keyboard_modifiers to c. Ignore the actual character code
2034 in the low 16 bits of extra_keyboard_modifiers. */
2035 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2040 /* Now that we have read an event, Emacs is not idle--
2041 unless the event was a timer event (not used now). */
2042 if (! (CONSP (c
) && EQ (XCONS (c
)->car
, Qtimer_event
)))
2049 if (commandflag
>= 0
2050 && !input_pending
&& !detect_input_pending_run_timers (0))
2058 /* Buffer switch events are only for internal wakeups
2059 so don't show them to the user. */
2063 if (key_already_recorded
)
2066 /* Process special events within read_char
2067 and loop around to read another event. */
2070 tem
= get_keyelt (access_keymap (get_keymap_1 (Vspecial_event_map
, 0, 0),
2076 int was_locked
= single_kboard
;
2078 last_input_char
= c
;
2079 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2081 /* Resume allowing input from any kboard, if that was true before. */
2083 any_kboard_state ();
2088 /* Wipe the echo area. */
2089 echo_area_glyphs
= 0;
2091 /* Handle things that only apply to characters. */
2094 /* If kbd_buffer_get_event gave us an EOF, return that. */
2098 if (STRINGP (Vkeyboard_translate_table
)
2099 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2100 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
2101 else if ((VECTORP (Vkeyboard_translate_table
)
2102 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2103 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2104 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2107 d
= Faref (Vkeyboard_translate_table
, c
);
2108 /* nil in keyboard-translate-table means no translation. */
2114 /* If this event is a mouse click in the menu bar,
2115 return just menu-bar for now. Modify the mouse click event
2116 so we won't do this twice, then queue it up. */
2117 if (EVENT_HAS_PARAMETERS (c
)
2118 && CONSP (XCONS (c
)->cdr
)
2119 && CONSP (EVENT_START (c
))
2120 && CONSP (XCONS (EVENT_START (c
))->cdr
))
2124 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2125 /* Handle menu-bar events:
2126 insert the dummy prefix event `menu-bar'. */
2127 if (EQ (posn
, Qmenu_bar
))
2129 /* Change menu-bar to (menu-bar) as the event "position". */
2130 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2133 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2139 if (! NILP (also_record
))
2140 record_char (also_record
);
2144 before_command_key_count
= this_command_key_count
;
2145 before_command_echo_length
= echo_length ();
2147 /* Don't echo mouse motion events. */
2149 && ! (EVENT_HAS_PARAMETERS (c
)
2150 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2153 if (! NILP (also_record
))
2154 echo_char (also_record
);
2155 /* Once we reread a character, echoing can happen
2156 the next time we pause to read a new one. */
2157 ok_to_echo_at_next_pause
= echo_area_glyphs
;
2160 /* Record this character as part of the current key. */
2161 add_command_key (c
);
2162 if (! NILP (also_record
))
2163 add_command_key (also_record
);
2165 /* Re-reading in the middle of a command */
2167 last_input_char
= c
;
2170 /* Process the help character specially if enabled */
2171 if (!NILP (Vhelp_form
) && help_char_p (c
))
2174 count
= specpdl_ptr
- specpdl
;
2176 record_unwind_protect (Fset_window_configuration
,
2177 Fcurrent_window_configuration (Qnil
));
2179 tem0
= Feval (Vhelp_form
);
2181 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2185 c
= read_char (0, 0, 0, Qnil
, 0);
2186 while (BUFFERP (c
));
2187 /* Remove the help from the frame */
2188 unbind_to (count
, Qnil
);
2191 if (EQ (c
, make_number (040)))
2195 c
= read_char (0, 0, 0, Qnil
, 0);
2196 while (BUFFERP (c
));
2203 /* Return 1 if should recognize C as "the help character". */
2211 if (EQ (c
, Vhelp_char
))
2213 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2214 if (EQ (c
, XCONS (tail
)->car
))
2219 /* Record the input event C in various ways. */
2226 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
2227 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2228 recent_keys_index
= 0;
2230 /* Write c to the dribble file. If c is a lispy event, write
2231 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2232 If you, dear reader, have a better idea, you've got the source. :-) */
2237 if (XUINT (c
) < 0x100)
2238 putc (XINT (c
), dribble
);
2240 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
2244 Lisp_Object dribblee
;
2246 /* If it's a structured event, take the event header. */
2247 dribblee
= EVENT_HEAD (c
);
2249 if (SYMBOLP (dribblee
))
2251 putc ('<', dribble
);
2252 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
2253 XSYMBOL (dribblee
)->name
->size
,
2255 putc ('>', dribble
);
2262 store_kbd_macro_char (c
);
2264 num_nonmacro_input_chars
++;
2271 struct buffer
*old
= current_buffer
;
2272 Fprinc (object
, Qnil
);
2273 set_buffer_internal (XBUFFER (Vstandard_output
));
2274 call0 (intern ("help-mode"));
2275 set_buffer_internal (old
);
2279 /* Copy out or in the info on where C-g should throw to.
2280 This is used when running Lisp code from within get_char,
2281 in case get_char is called recursively.
2282 See read_process_output. */
2287 bcopy (getcjmp
, temp
, sizeof getcjmp
);
2290 restore_getcjmp (temp
)
2293 bcopy (temp
, getcjmp
, sizeof getcjmp
);
2298 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
2299 of this function. */
2302 tracking_off (old_value
)
2303 Lisp_Object old_value
;
2305 do_mouse_tracking
= old_value
;
2306 if (NILP (old_value
))
2308 /* Redisplay may have been preempted because there was input
2309 available, and it assumes it will be called again after the
2310 input has been processed. If the only input available was
2311 the sort that we have just disabled, then we need to call
2313 if (!readable_events (1))
2315 redisplay_preserve_echo_area ();
2316 get_input_pending (&input_pending
, 1);
2321 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
2322 "Evaluate BODY with mouse movement events enabled.\n\
2323 Within a `track-mouse' form, mouse motion generates input events that\n\
2324 you can read with `read-event'.\n\
2325 Normally, mouse motion is ignored.")
2329 int count
= specpdl_ptr
- specpdl
;
2332 record_unwind_protect (tracking_off
, do_mouse_tracking
);
2334 do_mouse_tracking
= Qt
;
2336 val
= Fprogn (args
);
2337 return unbind_to (count
, val
);
2340 /* If mouse has moved on some frame, return one of those frames.
2341 Return 0 otherwise. */
2346 Lisp_Object tail
, frame
;
2348 FOR_EACH_FRAME (tail
, frame
)
2350 if (XFRAME (frame
)->mouse_moved
)
2351 return XFRAME (frame
);
2357 #endif /* HAVE_MOUSE */
2359 /* Low level keyboard/mouse input.
2360 kbd_buffer_store_event places events in kbd_buffer, and
2361 kbd_buffer_get_event retrieves them. */
2363 /* Return true iff there are any events in the queue that read-char
2364 would return. If this returns false, a read-char would block. */
2366 readable_events (do_timers_now
)
2370 timer_check (do_timers_now
);
2372 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2375 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2380 if (current_kboard
->kbd_queue_has_data
)
2386 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2387 if (kb
->kbd_queue_has_data
)
2393 /* Set this for debugging, to have a way to get out */
2398 event_to_kboard (event
)
2399 struct input_event
*event
;
2402 frame
= event
->frame_or_window
;
2404 frame
= XCONS (frame
)->car
;
2405 else if (WINDOWP (frame
))
2406 frame
= WINDOW_FRAME (XWINDOW (frame
));
2408 /* There are still some events that don't set this field.
2409 For now, just ignore the problem.
2410 Also ignore dead frames here. */
2411 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
2414 return FRAME_KBOARD (XFRAME (frame
));
2418 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
2421 kbd_buffer_store_event (event
)
2422 register struct input_event
*event
;
2424 if (event
->kind
== no_event
)
2427 if (event
->kind
== ascii_keystroke
)
2429 register int c
= event
->code
& 0377;
2431 if (event
->modifiers
& ctrl_modifier
)
2432 c
= make_ctrl_char (c
);
2434 c
|= (event
->modifiers
2435 & (meta_modifier
| alt_modifier
2436 | hyper_modifier
| super_modifier
));
2440 extern SIGTYPE
interrupt_signal ();
2443 struct input_event
*sp
;
2446 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
2447 kb
!= current_kboard
))
2450 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
2451 Fcons (make_number (c
), Qnil
));
2452 kb
->kbd_queue_has_data
= 1;
2453 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2455 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2458 if (event_to_kboard (sp
) == kb
)
2460 sp
->kind
= no_event
;
2461 sp
->frame_or_window
= Qnil
;
2469 /* If this results in a quit_char being returned to Emacs as
2470 input, set Vlast_event_frame properly. If this doesn't
2471 get returned to Emacs as an event, the next event read
2472 will set Vlast_event_frame again, so this is safe to do. */
2476 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
2478 focus
= event
->frame_or_window
;
2479 internal_last_event_frame
= focus
;
2480 Vlast_event_frame
= focus
;
2484 last_event_timestamp
= event
->timestamp
;
2485 interrupt_signal ();
2489 if (c
&& c
== stop_character
)
2495 /* Don't insert two buffer_switch_event's in a row.
2496 Just ignore the second one. */
2497 else if (event
->kind
== buffer_switch_event
2498 && kbd_fetch_ptr
!= kbd_store_ptr
2499 && kbd_store_ptr
->kind
== buffer_switch_event
)
2502 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
2503 kbd_store_ptr
= kbd_buffer
;
2505 /* Don't let the very last slot in the buffer become full,
2506 since that would make the two pointers equal,
2507 and that is indistinguishable from an empty buffer.
2508 Discard the event if it would fill the last slot. */
2509 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
2511 volatile struct input_event
*sp
= kbd_store_ptr
;
2512 sp
->kind
= event
->kind
;
2513 if (event
->kind
== selection_request_event
)
2515 /* We must not use the ordinary copying code for this case,
2516 since `part' is an enum and copying it might not copy enough
2518 bcopy (event
, (char *) sp
, sizeof (*event
));
2522 sp
->code
= event
->code
;
2523 sp
->part
= event
->part
;
2524 sp
->frame_or_window
= event
->frame_or_window
;
2525 sp
->modifiers
= event
->modifiers
;
2528 sp
->timestamp
= event
->timestamp
;
2530 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
2532 = event
->frame_or_window
);
2538 /* Read one event from the event buffer, waiting if necessary.
2539 The value is a Lisp object representing the event.
2540 The value is nil for an event that should be ignored,
2541 or that was handled here.
2542 We always read and discard one event. */
2545 kbd_buffer_get_event (kbp
, used_mouse_menu
)
2547 int *used_mouse_menu
;
2551 EMACS_TIME next_timer_delay
;
2557 *kbp
= current_kboard
;
2561 /* Wait until there is input available. */
2564 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2567 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2571 /* If the quit flag is set, then read_char will return
2572 quit_char, so that counts as "available input." */
2573 if (!NILP (Vquit_flag
))
2574 quit_throw_to_read_char ();
2576 /* One way or another, wait until input is available; then, if
2577 interrupt handlers have not read it, read it now. */
2580 wait_for_kbd_input ();
2582 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2586 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2589 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2593 Lisp_Object minus_one
;
2595 XSETINT (minus_one
, -1);
2596 wait_reading_process_input (0, 0, minus_one
, 1);
2598 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
2599 /* Pass 1 for EXPECT since we just waited to have input. */
2600 read_avail_input (1);
2602 #endif /* not VMS */
2605 /* At this point, we know that there is a readable event available
2606 somewhere. If the event queue is empty, then there must be a
2607 mouse movement enabled and available. */
2608 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2610 struct input_event
*event
;
2612 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2616 last_event_timestamp
= event
->timestamp
;
2619 *kbp
= event_to_kboard (event
);
2621 *kbp
= current_kboard
; /* Better than returning null ptr? */
2623 *kbp
= &the_only_kboard
;
2628 /* These two kinds of events get special handling
2629 and don't actually appear to the command loop.
2630 We return nil for them. */
2631 if (event
->kind
== selection_request_event
)
2634 struct input_event copy
;
2636 /* Remove it from the buffer before processing it,
2637 since otherwise swallow_events will see it
2638 and process it again. */
2640 kbd_fetch_ptr
= event
+ 1;
2641 input_pending
= readable_events (0);
2642 x_handle_selection_request (©
);
2644 /* We're getting selection request events, but we don't have
2650 else if (event
->kind
== selection_clear_event
)
2653 struct input_event copy
;
2655 /* Remove it from the buffer before processing it. */
2657 kbd_fetch_ptr
= event
+ 1;
2658 input_pending
= readable_events (0);
2659 x_handle_selection_clear (©
);
2661 /* We're getting selection request events, but we don't have
2666 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
2667 else if (event
->kind
== delete_window_event
)
2669 /* Make an event (delete-frame (FRAME)). */
2670 obj
= Fcons (event
->frame_or_window
, Qnil
);
2671 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
2672 kbd_fetch_ptr
= event
+ 1;
2674 else if (event
->kind
== iconify_event
)
2676 /* Make an event (iconify-frame (FRAME)). */
2677 obj
= Fcons (event
->frame_or_window
, Qnil
);
2678 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
2679 kbd_fetch_ptr
= event
+ 1;
2681 else if (event
->kind
== deiconify_event
)
2683 /* Make an event (make-frame-visible (FRAME)). */
2684 obj
= Fcons (event
->frame_or_window
, Qnil
);
2685 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
2686 kbd_fetch_ptr
= event
+ 1;
2689 else if (event
->kind
== buffer_switch_event
)
2691 /* The value doesn't matter here; only the type is tested. */
2692 XSETBUFFER (obj
, current_buffer
);
2693 kbd_fetch_ptr
= event
+ 1;
2695 #ifdef USE_X_TOOLKIT
2696 else if (event
->kind
== menu_bar_activate_event
)
2698 kbd_fetch_ptr
= event
+ 1;
2699 input_pending
= readable_events (0);
2700 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
2701 x_activate_menubar (XFRAME (event
->frame_or_window
));
2704 /* Just discard these, by returning nil.
2705 With MULTI_KBOARD, these events are used as placeholders
2706 when we need to randomly delete events from the queue.
2707 (They shouldn't otherwise be found in the buffer,
2708 but on some machines it appears they do show up
2709 even without MULTI_KBOARD.) */
2710 else if (event
->kind
== no_event
)
2711 kbd_fetch_ptr
= event
+ 1;
2713 /* If this event is on a different frame, return a switch-frame this
2714 time, and leave the event in the queue for next time. */
2721 frame
= event
->frame_or_window
;
2723 frame
= XCONS (frame
)->car
;
2724 else if (WINDOWP (frame
))
2725 frame
= WINDOW_FRAME (XWINDOW (frame
));
2727 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2731 if (! EQ (frame
, internal_last_event_frame
)
2732 && XFRAME (frame
) != selected_frame
)
2733 obj
= make_lispy_switch_frame (frame
);
2734 internal_last_event_frame
= frame
;
2735 #endif /* MULTI_FRAME */
2737 /* If we didn't decide to make a switch-frame event, go ahead
2738 and build a real event from the queue entry. */
2742 obj
= make_lispy_event (event
);
2743 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2744 /* If this was a menu selection, then set the flag to inhibit
2745 writing to last_nonmenu_event. Don't do this if the event
2746 we're returning is (menu-bar), though; that indicates the
2747 beginning of the menu sequence, and we might as well leave
2748 that as the `event with parameters' for this selection. */
2749 if (event
->kind
== menu_bar_event
2750 && !(CONSP (obj
) && EQ (XCONS (obj
)->car
, Qmenu_bar
))
2752 *used_mouse_menu
= 1;
2755 /* Wipe out this event, to catch bugs. */
2756 event
->kind
= no_event
;
2757 XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
] = Qnil
;
2759 kbd_fetch_ptr
= event
+ 1;
2764 /* Try generating a mouse motion event. */
2765 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2767 FRAME_PTR f
= some_mouse_moved ();
2768 Lisp_Object bar_window
;
2769 enum scroll_bar_part part
;
2773 *kbp
= current_kboard
;
2774 /* Note that this uses F to determine which display to look at.
2775 If there is no valid info, it does not store anything
2776 so x remains nil. */
2778 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
2783 /* Decide if we should generate a switch-frame event. Don't
2784 generate switch-frame events for motion outside of all Emacs
2790 frame
= FRAME_FOCUS_FRAME (f
);
2792 XSETFRAME (frame
, f
);
2794 if (! EQ (frame
, internal_last_event_frame
)
2795 && XFRAME (frame
) != selected_frame
)
2796 obj
= make_lispy_switch_frame (frame
);
2797 internal_last_event_frame
= frame
;
2801 /* If we didn't decide to make a switch-frame event, go ahead and
2802 return a mouse-motion event. */
2803 if (!NILP (x
) && NILP (obj
))
2804 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2806 #endif /* HAVE_MOUSE */
2808 /* We were promised by the above while loop that there was
2809 something for us to read! */
2812 input_pending
= readable_events (0);
2815 Vlast_event_frame
= internal_last_event_frame
;
2821 /* Process any events that are not user-visible,
2822 then return, without reading any user-visible events. */
2825 swallow_events (do_display
)
2830 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2832 struct input_event
*event
;
2834 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2838 last_event_timestamp
= event
->timestamp
;
2840 /* These two kinds of events get special handling
2841 and don't actually appear to the command loop. */
2842 if (event
->kind
== selection_request_event
)
2845 struct input_event copy
;
2847 /* Remove it from the buffer before processing it,
2848 since otherwise swallow_events called recursively could see it
2849 and process it again. */
2851 kbd_fetch_ptr
= event
+ 1;
2852 input_pending
= readable_events (0);
2853 x_handle_selection_request (©
);
2855 /* We're getting selection request events, but we don't have
2861 else if (event
->kind
== selection_clear_event
)
2864 struct input_event copy
;
2866 /* Remove it from the buffer before processing it, */
2869 kbd_fetch_ptr
= event
+ 1;
2870 input_pending
= readable_events (0);
2871 x_handle_selection_clear (©
);
2873 /* We're getting selection request events, but we don't have
2878 /* Note that timer_event is currently never used. */
2879 else if (event
->kind
== timer_event
)
2881 Lisp_Object tem
, lisp_event
;
2882 int was_locked
= single_kboard
;
2884 tem
= get_keymap_1 (Vspecial_event_map
, 0, 0);
2885 tem
= get_keyelt (access_keymap (tem
, Qtimer_event
, 0, 0),
2887 lisp_event
= Fcons (Qtimer_event
,
2888 Fcons (Fcdr (event
->frame_or_window
), Qnil
));
2889 kbd_fetch_ptr
= event
+ 1;
2890 if (kbd_fetch_ptr
== kbd_store_ptr
)
2892 Fcommand_execute (tem
, Qnil
, Fvector (1, &lisp_event
), Qt
);
2895 redisplay_preserve_echo_area ();
2897 /* Resume allowing input from any kboard, if that was true before. */
2899 any_kboard_state ();
2905 old_timers_run
= timers_run
;
2906 get_input_pending (&input_pending
, 1);
2908 if (timers_run
!= old_timers_run
&& do_display
)
2909 redisplay_preserve_echo_area ();
2912 static EMACS_TIME timer_idleness_start_time
;
2914 /* Record the start of when Emacs is idle,
2915 for the sake of running idle-time timers. */
2921 /* If we are already in the idle state, do nothing. */
2922 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
2925 EMACS_GET_TIME (timer_idleness_start_time
);
2927 /* Mark all idle-time timers as once again candidates for running. */
2928 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCONS (timers
)->cdr
)
2932 timer
= XCONS (timers
)->car
;
2934 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
2936 XVECTOR (timer
)->contents
[0] = Qnil
;
2940 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
2944 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
2947 /* This is only for debugging. */
2948 struct input_event last_timer_event
;
2950 /* Check whether a timer has fired. To prevent larger problems we simply
2951 disregard elements that are not proper timers. Do not make a circular
2952 timer list for the time being.
2954 Returns the number of seconds to wait until the next timer fires. If a
2955 timer is triggering now, return zero seconds.
2956 If no timer is active, return -1 seconds.
2958 If a timer is ripe, we run it, with quitting turned off.
2960 DO_IT_NOW is now ignored. It used to mean that we should
2961 run the timer directly instead of queueing a timer-event.
2962 Now we always run timers directly. */
2965 timer_check (do_it_now
)
2968 EMACS_TIME nexttime
;
2969 EMACS_TIME now
, idleness_now
;
2970 Lisp_Object timers
, idle_timers
, chosen_timer
;
2971 /* Nonzero if we generate some events. */
2972 int events_generated
= 0;
2973 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2975 EMACS_SET_SECS (nexttime
, -1);
2976 EMACS_SET_USECS (nexttime
, -1);
2978 /* Always consider the ordinary timers. */
2979 timers
= Vtimer_list
;
2980 /* Consider the idle timers only if Emacs is idle. */
2981 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
2982 idle_timers
= Vtimer_idle_list
;
2985 chosen_timer
= Qnil
;
2986 GCPRO3 (timers
, idle_timers
, chosen_timer
);
2988 if (CONSP (timers
) || CONSP (idle_timers
))
2990 EMACS_GET_TIME (now
);
2991 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
2992 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
2995 while (CONSP (timers
) || CONSP (idle_timers
))
2997 int triggertime
= EMACS_SECS (now
);
2998 Lisp_Object
*vector
;
2999 Lisp_Object timer
, idle_timer
;
3000 EMACS_TIME timer_time
, idle_timer_time
;
3001 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
3003 /* Skip past invalid timers and timers already handled. */
3006 timer
= XCONS (timers
)->car
;
3007 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3009 timers
= XCONS (timers
)->cdr
;
3012 vector
= XVECTOR (timer
)->contents
;
3014 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3015 || !INTEGERP (vector
[3])
3016 || ! NILP (vector
[0]))
3018 timers
= XCONS (timers
)->cdr
;
3022 if (!NILP (idle_timers
))
3024 timer
= XCONS (idle_timers
)->car
;
3025 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3027 idle_timers
= XCONS (idle_timers
)->cdr
;
3030 vector
= XVECTOR (timer
)->contents
;
3032 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3033 || !INTEGERP (vector
[3])
3034 || ! NILP (vector
[0]))
3036 idle_timers
= XCONS (idle_timers
)->cdr
;
3041 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
3042 based on the next ordinary timer.
3043 TIMER_DIFFERENCE is the distance in time from NOW to when
3044 this timer becomes ripe (negative if it's already ripe). */
3047 timer
= XCONS (timers
)->car
;
3048 vector
= XVECTOR (timer
)->contents
;
3049 EMACS_SET_SECS (timer_time
,
3050 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3051 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
3052 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
3055 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
3056 based on the next idle timer. */
3057 if (!NILP (idle_timers
))
3059 idle_timer
= XCONS (idle_timers
)->car
;
3060 vector
= XVECTOR (idle_timer
)->contents
;
3061 EMACS_SET_SECS (idle_timer_time
,
3062 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3063 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
3064 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
3067 /* Decide which timer is the next timer,
3068 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
3069 Also step down the list where we found that timer. */
3071 if (! NILP (timers
) && ! NILP (idle_timers
))
3074 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
3075 if (EMACS_TIME_NEG_P (temp
))
3077 chosen_timer
= timer
;
3078 timers
= XCONS (timers
)->cdr
;
3079 difference
= timer_difference
;
3083 chosen_timer
= idle_timer
;
3084 idle_timers
= XCONS (idle_timers
)->cdr
;
3085 difference
= idle_timer_difference
;
3088 else if (! NILP (timers
))
3090 chosen_timer
= timer
;
3091 timers
= XCONS (timers
)->cdr
;
3092 difference
= timer_difference
;
3096 chosen_timer
= idle_timer
;
3097 idle_timers
= XCONS (idle_timers
)->cdr
;
3098 difference
= idle_timer_difference
;
3100 vector
= XVECTOR (chosen_timer
)->contents
;
3102 /* If timer is rupe, run it if it hasn't been run. */
3103 if (EMACS_TIME_NEG_P (difference
)
3104 || (EMACS_SECS (difference
) == 0
3105 && EMACS_USECS (difference
) == 0))
3107 if (NILP (vector
[0]))
3109 /* Mark the timer as triggered to prevent problems if the lisp
3110 code fails to reschedule it right. */
3113 /* Run the timer or queue a timer event. */
3116 Lisp_Object tem
, event
;
3117 int was_locked
= single_kboard
;
3118 int count
= specpdl_ptr
- specpdl
;
3120 specbind (Qinhibit_quit
, Qt
);
3122 tem
= get_keymap_1 (Vspecial_event_map
, 0, 0);
3123 tem
= get_keyelt (access_keymap (tem
, Qtimer_event
, 0, 0),
3125 event
= Fcons (Qtimer_event
, Fcons (chosen_timer
, Qnil
));
3126 Fcommand_execute (tem
, Qnil
, Fvector (1, &event
), Qt
);
3129 unbind_to (count
, Qnil
);
3131 /* Resume allowing input from any kboard, if that was true before. */
3133 any_kboard_state ();
3135 /* Since we have handled the event,
3136 we don't need to tell the caller to wake up and do it. */
3141 /* Generate a timer event so the caller will handle it. */
3142 struct input_event event
;
3144 event
.kind
= timer_event
;
3145 event
.modifiers
= 0;
3146 event
.x
= event
.y
= Qnil
;
3147 event
.timestamp
= triggertime
;
3148 /* Store the timer in the frame slot. */
3149 event
.frame_or_window
3150 = Fcons (Fselected_frame (), chosen_timer
);
3151 kbd_buffer_store_event (&event
);
3153 last_timer_event
= event
;
3155 /* Tell caller to handle this event right away. */
3156 events_generated
= 1;
3157 EMACS_SET_SECS (nexttime
, 0);
3158 EMACS_SET_USECS (nexttime
, 0);
3160 /* Don't queue more than one event at once.
3161 When Emacs is ready for another, it will
3162 queue the next one. */
3170 /* When we encounter a timer that is still waiting,
3171 return the amount of time to wait before it is ripe. */
3174 /* But if we generated an event,
3175 tell the caller to handle it now. */
3176 if (events_generated
)
3182 /* No timers are pending in the future. */
3183 /* Return 0 if we generated an event, and -1 if not. */
3188 /* Caches for modify_event_symbol. */
3189 static Lisp_Object accent_key_syms
;
3190 static Lisp_Object func_key_syms
;
3191 static Lisp_Object mouse_syms
;
3193 /* This is a list of keysym codes for special "accent" characters.
3194 It parallels lispy_accent_keys. */
3196 static int lispy_accent_codes
[] =
3198 #ifdef XK_dead_circumflex
3203 #ifdef XK_dead_grave
3208 #ifdef XK_dead_tilde
3213 #ifdef XK_dead_diaeresis
3218 #ifdef XK_dead_macron
3223 #ifdef XK_dead_degree
3228 #ifdef XK_dead_acute
3233 #ifdef XK_dead_cedilla
3238 #ifdef XK_dead_breve
3243 #ifdef XK_dead_ogonek
3248 #ifdef XK_dead_caron
3253 #ifdef XK_dead_doubleacute
3254 XK_dead_doubleacute
,
3258 #ifdef XK_dead_abovedot
3265 /* This is a list of Lisp names for special "accent" characters.
3266 It parallels lispy_accent_codes. */
3268 static char *lispy_accent_keys
[] =
3286 #define FUNCTION_KEY_OFFSET 0x0
3288 char *lispy_function_keys
[] =
3292 0, /* VK_LBUTTON 0x01 */
3293 0, /* VK_RBUTTON 0x02 */
3294 "cancel", /* VK_CANCEL 0x03 */
3295 0, /* VK_MBUTTON 0x04 */
3297 0, 0, 0, /* 0x05 .. 0x07 */
3299 "backspace", /* VK_BACK 0x08 */
3300 "tab", /* VK_TAB 0x09 */
3302 0, 0, /* 0x0A .. 0x0B */
3304 "clear", /* VK_CLEAR 0x0C */
3305 "return", /* VK_RETURN 0x0D */
3307 0, 0, /* 0x0E .. 0x0F */
3309 "shift", /* VK_SHIFT 0x10 */
3310 "control", /* VK_CONTROL 0x11 */
3311 "menu", /* VK_MENU 0x12 */
3312 "pause", /* VK_PAUSE 0x13 */
3313 "capital", /* VK_CAPITAL 0x14 */
3315 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
3317 0, /* VK_ESCAPE 0x1B */
3319 0, 0, 0, 0, /* 0x1C .. 0x1F */
3321 0, /* VK_SPACE 0x20 */
3322 "prior", /* VK_PRIOR 0x21 */
3323 "next", /* VK_NEXT 0x22 */
3324 "end", /* VK_END 0x23 */
3325 "home", /* VK_HOME 0x24 */
3326 "left", /* VK_LEFT 0x25 */
3327 "up", /* VK_UP 0x26 */
3328 "right", /* VK_RIGHT 0x27 */
3329 "down", /* VK_DOWN 0x28 */
3330 "select", /* VK_SELECT 0x29 */
3331 "print", /* VK_PRINT 0x2A */
3332 "execute", /* VK_EXECUTE 0x2B */
3333 "snapshot", /* VK_SNAPSHOT 0x2C */
3334 "insert", /* VK_INSERT 0x2D */
3335 "delete", /* VK_DELETE 0x2E */
3336 "help", /* VK_HELP 0x2F */
3338 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
3340 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3342 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
3344 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
3346 0, 0, 0, 0, 0, 0, 0, 0, 0,
3347 0, 0, 0, 0, 0, 0, 0, 0, 0,
3348 0, 0, 0, 0, 0, 0, 0, 0,
3350 "lwindow", /* VK_LWIN 0x5B */
3351 "rwindow", /* VK_RWIN 0x5C */
3352 "apps", /* VK_APPS 0x5D */
3354 0, 0, /* 0x5E .. 0x5F */
3356 "kp-0", /* VK_NUMPAD0 0x60 */
3357 "kp-1", /* VK_NUMPAD1 0x61 */
3358 "kp-2", /* VK_NUMPAD2 0x62 */
3359 "kp-3", /* VK_NUMPAD3 0x63 */
3360 "kp-4", /* VK_NUMPAD4 0x64 */
3361 "kp-5", /* VK_NUMPAD5 0x65 */
3362 "kp-6", /* VK_NUMPAD6 0x66 */
3363 "kp-7", /* VK_NUMPAD7 0x67 */
3364 "kp-8", /* VK_NUMPAD8 0x68 */
3365 "kp-9", /* VK_NUMPAD9 0x69 */
3366 "kp-multiply", /* VK_MULTIPLY 0x6A */
3367 "kp-add", /* VK_ADD 0x6B */
3368 "kp-separator", /* VK_SEPARATOR 0x6C */
3369 "kp-subtract", /* VK_SUBTRACT 0x6D */
3370 "kp-decimal", /* VK_DECIMAL 0x6E */
3371 "kp-divide", /* VK_DIVIDE 0x6F */
3372 "f1", /* VK_F1 0x70 */
3373 "f2", /* VK_F2 0x71 */
3374 "f3", /* VK_F3 0x72 */
3375 "f4", /* VK_F4 0x73 */
3376 "f5", /* VK_F5 0x74 */
3377 "f6", /* VK_F6 0x75 */
3378 "f7", /* VK_F7 0x76 */
3379 "f8", /* VK_F8 0x77 */
3380 "f9", /* VK_F9 0x78 */
3381 "f10", /* VK_F10 0x79 */
3382 "f11", /* VK_F11 0x7A */
3383 "f12", /* VK_F12 0x7B */
3384 "f13", /* VK_F13 0x7C */
3385 "f14", /* VK_F14 0x7D */
3386 "f15", /* VK_F15 0x7E */
3387 "f16", /* VK_F16 0x7F */
3388 "f17", /* VK_F17 0x80 */
3389 "f18", /* VK_F18 0x81 */
3390 "f19", /* VK_F19 0x82 */
3391 "f20", /* VK_F20 0x83 */
3392 "f21", /* VK_F21 0x84 */
3393 "f22", /* VK_F22 0x85 */
3394 "f23", /* VK_F23 0x86 */
3395 "f24", /* VK_F24 0x87 */
3397 0, 0, 0, 0, /* 0x88 .. 0x8B */
3398 0, 0, 0, 0, /* 0x8C .. 0x8F */
3400 "kp-numlock", /* VK_NUMLOCK 0x90 */
3401 "scroll", /* VK_SCROLL 0x91 */
3403 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
3404 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
3405 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
3406 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
3407 "kp-end", /* VK_NUMPAD_END 0x96 */
3408 "kp-home", /* VK_NUMPAD_HOME 0x97 */
3409 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
3410 "kp-up", /* VK_NUMPAD_UP 0x99 */
3411 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
3412 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
3413 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
3414 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
3416 0, 0, /* 0x9E .. 0x9F */
3419 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
3420 * Used only as parameters to GetAsyncKeyState() and GetKeyState().
3421 * No other API or message will distinguish left and right keys this way.
3425 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3426 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3427 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3428 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3429 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3435 "attn", /* VK_ATTN 0xF6 */
3436 "crsel", /* VK_CRSEL 0xF7 */
3437 "exsel", /* VK_EXSEL 0xF8 */
3438 "ereof", /* VK_EREOF 0xF9 */
3439 "play", /* VK_PLAY 0xFA */
3440 "zoom", /* VK_ZOOM 0xFB */
3441 "noname", /* VK_NONAME 0xFC */
3442 "pa1", /* VK_PA1 0xFD */
3443 "oem_clear", /* VK_OEM_CLEAR 0xFE */
3448 #define FUNCTION_KEY_OFFSET 0xff00
3450 /* You'll notice that this table is arranged to be conveniently
3451 indexed by X Windows keysym values. */
3452 static char *lispy_function_keys
[] =
3454 /* X Keysym value */
3456 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
3464 0, 0, 0, /* 0xff10 */
3466 0, 0, 0, 0, 0, 0, 0,
3469 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
3470 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
3471 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
3473 "home", /* 0xff50 */ /* IsCursorKey */
3484 "select", /* 0xff60 */ /* IsMiscFunctionKey */
3495 "break", /* 0xff6b */
3497 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
3499 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
3500 "kp-space", /* 0xff80 */ /* IsKeypadKey */
3501 0, 0, 0, 0, 0, 0, 0, 0,
3502 "kp-tab", /* 0xff89 */
3504 "kp-enter", /* 0xff8d */
3506 "kp-f1", /* 0xff91 */
3510 "kp-home", /* 0xff95 */
3515 "kp-prior", /* kp-page-up */
3516 "kp-next", /* kp-page-down */
3522 0, 0, 0, 0, 0, 0, 0, 0, 0,
3523 "kp-multiply", /* 0xffaa */
3528 "kp-divide", /* 0xffaf */
3529 "kp-0", /* 0xffb0 */
3530 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
3533 "kp-equal", /* 0xffbd */
3534 "f1", /* 0xffbe */ /* IsFunctionKey */
3536 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
3537 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
3538 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
3539 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
3540 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
3541 0, 0, 0, 0, 0, 0, 0, 0,
3542 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
3543 0, 0, 0, 0, 0, 0, 0, "delete"
3546 #endif /* HAVE_NTGUI */
3548 static char *lispy_mouse_names
[] =
3550 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
3553 /* Scroll bar parts. */
3554 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
3555 Lisp_Object Qup
, Qdown
;
3557 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
3558 Lisp_Object
*scroll_bar_parts
[] = {
3559 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
3564 /* A vector, indexed by button number, giving the down-going location
3565 of currently depressed buttons, both scroll bar and non-scroll bar.
3567 The elements have the form
3568 (BUTTON-NUMBER MODIFIER-MASK . REST)
3569 where REST is the cdr of a position as it would be reported in the event.
3571 The make_lispy_event function stores positions here to tell the
3572 difference between click and drag events, and to store the starting
3573 location to be included in drag events. */
3575 static Lisp_Object button_down_location
;
3577 /* Information about the most recent up-going button event: Which
3578 button, what location, and what time. */
3580 static int last_mouse_button
;
3581 static int last_mouse_x
;
3582 static int last_mouse_y
;
3583 static unsigned long button_down_time
;
3585 /* The maximum time between clicks to make a double-click,
3586 or Qnil to disable double-click detection,
3587 or Qt for no time limit. */
3588 Lisp_Object Vdouble_click_time
;
3590 /* The number of clicks in this multiple-click. */
3592 int double_click_count
;
3594 /* Given a struct input_event, build the lisp event which represents
3595 it. If EVENT is 0, build a mouse movement event from the mouse
3596 movement buffer, which should have a movement event in it.
3598 Note that events must be passed to this function in the order they
3599 are received; this function stores the location of button presses
3600 in order to build drag events when the button is released. */
3603 make_lispy_event (event
)
3604 struct input_event
*event
;
3608 switch (SWITCH_ENUM_CAST (event
->kind
))
3610 /* A simple keystroke. */
3611 case ascii_keystroke
:
3613 Lisp_Object lispy_c
;
3614 int c
= event
->code
& 0377;
3615 /* Turn ASCII characters into control characters
3617 if (event
->modifiers
& ctrl_modifier
)
3618 c
= make_ctrl_char (c
);
3620 /* Add in the other modifier bits. We took care of ctrl_modifier
3621 just above, and the shift key was taken care of by the X code,
3622 and applied to control characters by make_ctrl_char. */
3623 c
|= (event
->modifiers
3624 & (meta_modifier
| alt_modifier
3625 | hyper_modifier
| super_modifier
));
3626 button_down_time
= 0;
3627 XSETFASTINT (lispy_c
, c
);
3631 /* A function key. The symbol may need to have modifier prefixes
3633 case non_ascii_keystroke
:
3634 button_down_time
= 0;
3636 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
3637 if (event
->code
== lispy_accent_codes
[i
])
3638 return modify_event_symbol (i
,
3640 Qfunction_key
, Qnil
,
3641 lispy_accent_keys
, &accent_key_syms
,
3642 (sizeof (lispy_accent_keys
)
3643 / sizeof (lispy_accent_keys
[0])));
3645 /* Handle system-specific keysyms. */
3646 if (event
->code
& (1 << 28))
3648 /* We need to use an alist rather than a vector as the cache
3649 since we can't make a vector long enuf. */
3650 if (NILP (current_kboard
->system_key_syms
))
3651 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
3652 return modify_event_symbol (event
->code
,
3655 current_kboard
->Vsystem_key_alist
,
3656 0, ¤t_kboard
->system_key_syms
,
3660 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
3662 Qfunction_key
, Qnil
,
3663 lispy_function_keys
, &func_key_syms
,
3664 (sizeof (lispy_function_keys
)
3665 / sizeof (lispy_function_keys
[0])));
3668 /* Note that timer_event is currently never used. */
3670 return Fcons (Qtimer_event
, Fcons (Fcdr (event
->frame_or_window
), Qnil
));
3673 /* A mouse click. Figure out where it is, decide whether it's
3674 a press, click or drag, and build the appropriate structure. */
3676 case scroll_bar_click
:
3678 int button
= event
->code
;
3680 Lisp_Object position
;
3681 Lisp_Object
*start_pos_ptr
;
3682 Lisp_Object start_pos
;
3684 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
3687 /* Build the position as appropriate for this mouse click. */
3688 if (event
->kind
== mouse_click
)
3691 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
3696 /* Ignore mouse events that were made on frame that
3697 have been deleted. */
3698 if (! FRAME_LIVE_P (f
))
3701 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
3702 &column
, &row
, NULL
, 1);
3704 #ifndef USE_X_TOOLKIT
3705 /* In the non-toolkit version, clicks on the menu bar
3706 are ordinary button events in the event buffer.
3707 Distinguish them, and invoke the menu.
3709 (In the toolkit version, the toolkit handles the menu bar
3710 and Emacs doesn't know about it until after the user
3711 makes a selection.) */
3712 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
3713 && (event
->modifiers
& down_modifier
))
3715 Lisp_Object items
, item
;
3720 /* Activate the menu bar on the down event. If the
3721 up event comes in before the menu code can deal with it,
3723 if (! (event
->modifiers
& down_modifier
))
3728 items
= FRAME_MENU_BAR_ITEMS (f
);
3729 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
3731 Lisp_Object pos
, string
;
3732 string
= XVECTOR (items
)->contents
[i
+ 1];
3733 pos
= XVECTOR (items
)->contents
[i
+ 3];
3736 if (column
>= XINT (pos
)
3737 && column
< XINT (pos
) + XSTRING (string
)->size
)
3739 item
= XVECTOR (items
)->contents
[i
];
3745 = Fcons (event
->frame_or_window
,
3747 Fcons (Fcons (event
->x
, event
->y
),
3748 Fcons (make_number (event
->timestamp
),
3751 return Fcons (item
, Fcons (position
, Qnil
));
3753 #endif /* not USE_X_TOOLKIT */
3755 window
= window_from_coordinates (f
, column
, row
, &part
);
3757 if (!WINDOWP (window
))
3759 window
= event
->frame_or_window
;
3764 int pixcolumn
, pixrow
;
3765 column
-= XINT (XWINDOW (window
)->left
);
3766 row
-= XINT (XWINDOW (window
)->top
);
3767 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
3768 XSETINT (event
->x
, pixcolumn
);
3769 XSETINT (event
->y
, pixrow
);
3774 posn
= Qvertical_line
;
3777 buffer_posn_from_coords (XWINDOW (window
),
3784 Fcons (Fcons (event
->x
, event
->y
),
3785 Fcons (make_number (event
->timestamp
),
3791 Lisp_Object portion_whole
;
3794 window
= event
->frame_or_window
;
3795 portion_whole
= Fcons (event
->x
, event
->y
);
3796 part
= *scroll_bar_parts
[(int) event
->part
];
3800 Fcons (Qvertical_scroll_bar
,
3801 Fcons (portion_whole
,
3802 Fcons (make_number (event
->timestamp
),
3803 Fcons (part
, Qnil
)))));
3806 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
3808 start_pos
= *start_pos_ptr
;
3809 *start_pos_ptr
= Qnil
;
3811 is_double
= (button
== last_mouse_button
3812 && XINT (event
->x
) == last_mouse_x
3813 && XINT (event
->y
) == last_mouse_y
3814 && button_down_time
!= 0
3815 && (EQ (Vdouble_click_time
, Qt
)
3816 || (INTEGERP (Vdouble_click_time
)
3817 && ((int)(event
->timestamp
- button_down_time
)
3818 < XINT (Vdouble_click_time
)))));
3819 last_mouse_button
= button
;
3820 last_mouse_x
= XINT (event
->x
);
3821 last_mouse_y
= XINT (event
->y
);
3823 /* If this is a button press, squirrel away the location, so
3824 we can decide later whether it was a click or a drag. */
3825 if (event
->modifiers
& down_modifier
)
3829 double_click_count
++;
3830 event
->modifiers
|= ((double_click_count
> 2)
3835 double_click_count
= 1;
3836 button_down_time
= event
->timestamp
;
3837 *start_pos_ptr
= Fcopy_alist (position
);
3840 /* Now we're releasing a button - check the co-ordinates to
3841 see if this was a click or a drag. */
3842 else if (event
->modifiers
& up_modifier
)
3844 /* If we did not see a down before this up,
3845 ignore the up. Probably this happened because
3846 the down event chose a menu item.
3847 It would be an annoyance to treat the release
3848 of the button that chose the menu item
3849 as a separate event. */
3851 if (!CONSP (start_pos
))
3854 event
->modifiers
&= ~up_modifier
;
3855 #if 0 /* Formerly we treated an up with no down as a click event. */
3856 if (!CONSP (start_pos
))
3857 event
->modifiers
|= click_modifier
;
3861 /* The third element of every position should be the (x,y)
3865 down
= Fnth (make_number (2), start_pos
);
3866 if (EQ (event
->x
, XCONS (down
)->car
)
3867 && EQ (event
->y
, XCONS (down
)->cdr
))
3869 event
->modifiers
|= click_modifier
;
3873 button_down_time
= 0;
3874 event
->modifiers
|= drag_modifier
;
3876 /* Don't check is_double; treat this as multiple
3877 if the down-event was multiple. */
3878 if (double_click_count
> 1)
3879 event
->modifiers
|= ((double_click_count
> 2)
3885 /* Every mouse event should either have the down_modifier or
3886 the up_modifier set. */
3890 /* Get the symbol we should use for the mouse click. */
3893 head
= modify_event_symbol (button
,
3896 lispy_mouse_names
, &mouse_syms
,
3897 (sizeof (lispy_mouse_names
)
3898 / sizeof (lispy_mouse_names
[0])));
3899 if (event
->modifiers
& drag_modifier
)
3904 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
3907 Fcons (make_number (double_click_count
),
3917 case win32_scroll_bar_click
:
3919 int button
= event
->code
;
3921 Lisp_Object position
;
3922 Lisp_Object
*start_pos_ptr
;
3923 Lisp_Object start_pos
;
3925 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
3930 Lisp_Object portion_whole
;
3933 window
= event
->frame_or_window
;
3934 portion_whole
= Fcons (event
->x
, event
->y
);
3935 part
= *scroll_bar_parts
[(int) event
->part
];
3939 Fcons (Qvertical_scroll_bar
,
3940 Fcons (portion_whole
,
3941 Fcons (make_number (event
->timestamp
),
3942 Fcons (part
, Qnil
)))));
3945 /* Always treat Win32 scroll bar events as clicks. */
3946 event
->modifiers
|= click_modifier
;
3949 /* Get the symbol we should use for the mouse click. */
3952 head
= modify_event_symbol (button
,
3955 lispy_mouse_names
, &mouse_syms
,
3956 (sizeof (lispy_mouse_names
)
3957 / sizeof (lispy_mouse_names
[0])));
3965 #endif /* HAVE_MOUSE */
3967 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
3968 case menu_bar_event
:
3969 /* The event value is in the cdr of the frame_or_window slot. */
3970 if (!CONSP (event
->frame_or_window
))
3972 return XCONS (event
->frame_or_window
)->cdr
;
3975 /* The 'kind' field of the event is something we don't recognize. */
3984 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
3986 Lisp_Object bar_window
;
3987 enum scroll_bar_part part
;
3992 /* Is it a scroll bar movement? */
3993 if (frame
&& ! NILP (bar_window
))
3995 Lisp_Object part_sym
;
3997 part_sym
= *scroll_bar_parts
[(int) part
];
3998 return Fcons (Qscroll_bar_movement
,
3999 (Fcons (Fcons (bar_window
,
4000 Fcons (Qvertical_scroll_bar
,
4001 Fcons (Fcons (x
, y
),
4002 Fcons (make_number (time
),
4008 /* Or is it an ordinary mouse movement? */
4010 #endif /* MULTI_FRAME */
4023 /* It's in a frame; which window on that frame? */
4024 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
,
4026 window
= window_from_coordinates (frame
, column
, row
, &area
);
4031 if (WINDOWP (window
))
4033 int pixcolumn
, pixrow
;
4034 column
-= XINT (XWINDOW (window
)->left
);
4035 row
-= XINT (XWINDOW (window
)->top
);
4036 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
4037 XSETINT (x
, pixcolumn
);
4038 XSETINT (y
, pixrow
);
4043 posn
= Qvertical_line
;
4046 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
4049 else if (frame
!= 0)
4051 XSETFRAME (window
, frame
);
4063 return Fcons (Qmouse_movement
,
4064 Fcons (Fcons (window
,
4066 Fcons (Fcons (x
, y
),
4067 Fcons (make_number (time
),
4073 #endif /* HAVE_MOUSE */
4075 /* Construct a switch frame event. */
4077 make_lispy_switch_frame (frame
)
4080 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
4083 /* Manipulating modifiers. */
4085 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
4087 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
4088 SYMBOL's name of the end of the modifiers; the string from this
4089 position is the unmodified symbol name.
4091 This doesn't use any caches. */
4094 parse_modifiers_uncached (symbol
, modifier_end
)
4098 struct Lisp_String
*name
;
4102 CHECK_SYMBOL (symbol
, 1);
4105 name
= XSYMBOL (symbol
)->name
;
4107 for (i
= 0; i
+2 <= name
->size
; )
4109 int this_mod_end
= 0;
4112 /* See if the name continues with a modifier word.
4113 Check that the word appears, but don't check what follows it.
4114 Set this_mod and this_mod_end to record what we find. */
4116 switch (name
->data
[i
])
4118 #define SINGLE_LETTER_MOD(BIT) \
4119 (this_mod_end = i + 1, this_mod = BIT)
4122 SINGLE_LETTER_MOD (alt_modifier
);
4126 SINGLE_LETTER_MOD (ctrl_modifier
);
4130 SINGLE_LETTER_MOD (hyper_modifier
);
4134 SINGLE_LETTER_MOD (meta_modifier
);
4138 SINGLE_LETTER_MOD (shift_modifier
);
4142 SINGLE_LETTER_MOD (super_modifier
);
4145 #undef SINGLE_LETTER_MOD
4148 /* If we found no modifier, stop looking for them. */
4149 if (this_mod_end
== 0)
4152 /* Check there is a dash after the modifier, so that it
4153 really is a modifier. */
4154 if (this_mod_end
>= name
->size
|| name
->data
[this_mod_end
] != '-')
4157 /* This modifier is real; look for another. */
4158 modifiers
|= this_mod
;
4159 i
= this_mod_end
+ 1;
4162 /* Should we include the `click' modifier? */
4163 if (! (modifiers
& (down_modifier
| drag_modifier
4164 | double_modifier
| triple_modifier
))
4165 && i
+ 7 == name
->size
4166 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
4167 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
4168 modifiers
|= click_modifier
;
4176 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
4177 prepended to the string BASE[0..BASE_LEN-1].
4178 This doesn't use any caches. */
4180 apply_modifiers_uncached (modifiers
, base
, base_len
)
4185 /* Since BASE could contain nulls, we can't use intern here; we have
4186 to use Fintern, which expects a genuine Lisp_String, and keeps a
4189 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
4195 /* Only the event queue may use the `up' modifier; it should always
4196 be turned into a click or drag event before presented to lisp code. */
4197 if (modifiers
& up_modifier
)
4200 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
4201 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
4202 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
4203 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
4204 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
4205 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
4206 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
4207 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
4208 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
4209 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
4210 /* The click modifier is denoted by the absence of other modifiers. */
4214 mod_len
= p
- new_mods
;
4218 Lisp_Object new_name
;
4220 new_name
= make_uninit_string (mod_len
+ base_len
);
4221 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
4222 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
4224 return Fintern (new_name
, Qnil
);
4229 static char *modifier_names
[] =
4231 "up", "down", "drag", "click", "double", "triple", 0, 0,
4232 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4233 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
4235 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
4237 static Lisp_Object modifier_symbols
;
4239 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
4241 lispy_modifier_list (modifiers
)
4244 Lisp_Object modifier_list
;
4247 modifier_list
= Qnil
;
4248 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
4249 if (modifiers
& (1<<i
))
4250 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
4253 return modifier_list
;
4257 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
4258 where UNMODIFIED is the unmodified form of SYMBOL,
4259 MASK is the set of modifiers present in SYMBOL's name.
4260 This is similar to parse_modifiers_uncached, but uses the cache in
4261 SYMBOL's Qevent_symbol_element_mask property, and maintains the
4262 Qevent_symbol_elements property. */
4265 parse_modifiers (symbol
)
4268 Lisp_Object elements
;
4270 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
4271 if (CONSP (elements
))
4276 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
4277 Lisp_Object unmodified
;
4280 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
4281 XSYMBOL (symbol
)->name
->size
- end
),
4284 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
4286 XSETFASTINT (mask
, modifiers
);
4287 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
4289 /* Cache the parsing results on SYMBOL. */
4290 Fput (symbol
, Qevent_symbol_element_mask
,
4292 Fput (symbol
, Qevent_symbol_elements
,
4293 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
4295 /* Since we know that SYMBOL is modifiers applied to unmodified,
4296 it would be nice to put that in unmodified's cache.
4297 But we can't, since we're not sure that parse_modifiers is
4304 /* Apply the modifiers MODIFIERS to the symbol BASE.
4305 BASE must be unmodified.
4307 This is like apply_modifiers_uncached, but uses BASE's
4308 Qmodifier_cache property, if present. It also builds
4309 Qevent_symbol_elements properties, since it has that info anyway.
4311 apply_modifiers copies the value of BASE's Qevent_kind property to
4312 the modified symbol. */
4314 apply_modifiers (modifiers
, base
)
4318 Lisp_Object cache
, index
, entry
, new_symbol
;
4320 /* Mask out upper bits. We don't know where this value's been. */
4321 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
4323 /* The click modifier never figures into cache indices. */
4324 cache
= Fget (base
, Qmodifier_cache
);
4325 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
4326 entry
= assq_no_quit (index
, cache
);
4329 new_symbol
= XCONS (entry
)->cdr
;
4332 /* We have to create the symbol ourselves. */
4333 new_symbol
= apply_modifiers_uncached (modifiers
,
4334 XSYMBOL (base
)->name
->data
,
4335 XSYMBOL (base
)->name
->size
);
4337 /* Add the new symbol to the base's cache. */
4338 entry
= Fcons (index
, new_symbol
);
4339 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
4341 /* We have the parsing info now for free, so add it to the caches. */
4342 XSETFASTINT (index
, modifiers
);
4343 Fput (new_symbol
, Qevent_symbol_element_mask
,
4344 Fcons (base
, Fcons (index
, Qnil
)));
4345 Fput (new_symbol
, Qevent_symbol_elements
,
4346 Fcons (base
, lispy_modifier_list (modifiers
)));
4349 /* Make sure this symbol is of the same kind as BASE.
4351 You'd think we could just set this once and for all when we
4352 intern the symbol above, but reorder_modifiers may call us when
4353 BASE's property isn't set right; we can't assume that just
4354 because it has a Qmodifier_cache property it must have its
4355 Qevent_kind set right as well. */
4356 if (NILP (Fget (new_symbol
, Qevent_kind
)))
4360 kind
= Fget (base
, Qevent_kind
);
4362 Fput (new_symbol
, Qevent_kind
, kind
);
4369 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
4370 return a symbol with the modifiers placed in the canonical order.
4371 Canonical order is alphabetical, except for down and drag, which
4372 always come last. The 'click' modifier is never written out.
4374 Fdefine_key calls this to make sure that (for example) C-M-foo
4375 and M-C-foo end up being equivalent in the keymap. */
4378 reorder_modifiers (symbol
)
4381 /* It's hopefully okay to write the code this way, since everything
4382 will soon be in caches, and no consing will be done at all. */
4385 parsed
= parse_modifiers (symbol
);
4386 return apply_modifiers ((int) XINT (XCONS (XCONS (parsed
)->cdr
)->car
),
4387 XCONS (parsed
)->car
);
4391 /* For handling events, we often want to produce a symbol whose name
4392 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
4393 to some base, like the name of a function key or mouse button.
4394 modify_event_symbol produces symbols of this sort.
4396 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
4397 is the name of the i'th symbol. TABLE_SIZE is the number of elements
4400 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
4401 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
4403 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
4404 persist between calls to modify_event_symbol that it can use to
4405 store a cache of the symbols it's generated for this NAME_TABLE
4406 before. The object stored there may be a vector or an alist.
4408 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
4410 MODIFIERS is a set of modifier bits (as given in struct input_events)
4411 whose prefixes should be applied to the symbol name.
4413 SYMBOL_KIND is the value to be placed in the event_kind property of
4414 the returned symbol.
4416 The symbols we create are supposed to have an
4417 `event-symbol-elements' property, which lists the modifiers present
4418 in the symbol's name. */
4421 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
4422 name_table
, symbol_table
, table_size
)
4425 Lisp_Object symbol_kind
;
4426 Lisp_Object name_alist
;
4428 Lisp_Object
*symbol_table
;
4429 unsigned int table_size
;
4432 Lisp_Object symbol_int
;
4434 /* Get rid of the "vendor-specific" bit here. */
4435 XSETINT (symbol_int
, symbol_num
& 0xffffff);
4437 /* Is this a request for a valid symbol? */
4438 if (symbol_num
< 0 || symbol_num
>= table_size
)
4441 if (CONSP (*symbol_table
))
4442 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
4444 /* If *symbol_table doesn't seem to be initialized properly, fix that.
4445 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4446 where the Nth element is the symbol for NAME_TABLE[N], or nil if
4447 we've never used that symbol before. */
4450 if (! VECTORP (*symbol_table
)
4451 || XVECTOR (*symbol_table
)->size
!= table_size
)
4455 XSETFASTINT (size
, table_size
);
4456 *symbol_table
= Fmake_vector (size
, Qnil
);
4459 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
4462 /* Have we already used this symbol before? */
4465 /* No; let's create it. */
4466 if (!NILP (name_alist
))
4467 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
4468 else if (name_table
[symbol_num
])
4469 value
= intern (name_table
[symbol_num
]);
4471 #ifdef HAVE_WINDOW_SYSTEM
4474 char *name
= x_get_keysym_name (symbol_num
);
4476 value
= intern (name
);
4483 sprintf (buf
, "key-%d", symbol_num
);
4484 value
= intern (buf
);
4487 if (CONSP (*symbol_table
))
4488 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
4490 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
4492 /* Fill in the cache entries for this symbol; this also
4493 builds the Qevent_symbol_elements property, which the user
4495 apply_modifiers (modifiers
& click_modifier
, value
);
4496 Fput (value
, Qevent_kind
, symbol_kind
);
4499 /* Apply modifiers to that symbol. */
4500 return apply_modifiers (modifiers
, value
);
4503 /* Convert a list that represents an event type,
4504 such as (ctrl meta backspace), into the usual representation of that
4505 event type as a number or a symbol. */
4507 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
4508 "Convert the event description list EVENT-DESC to an event type.\n\
4509 EVENT-DESC should contain one base event type (a character or symbol)\n\
4510 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
4511 drag, down, double or triple). The base must be last.\n\
4512 The return value is an event type (a character or symbol) which\n\
4513 has the same base event type and all the specified modifiers.")
4515 Lisp_Object event_desc
;
4523 while (CONSP (rest
))
4528 elt
= XCONS (rest
)->car
;
4529 rest
= XCONS (rest
)->cdr
;
4531 /* Given a symbol, see if it is a modifier name. */
4532 if (SYMBOLP (elt
) && CONSP (rest
))
4533 this = parse_solitary_modifier (elt
);
4537 else if (!NILP (base
))
4538 error ("Two bases given in one event");
4544 /* Let the symbol A refer to the character A. */
4545 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
4546 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
4548 if (INTEGERP (base
))
4550 /* Turn (shift a) into A. */
4551 if ((modifiers
& shift_modifier
) != 0
4552 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
4554 XSETINT (base
, XINT (base
) - ('a' - 'A'));
4555 modifiers
&= ~shift_modifier
;
4558 /* Turn (control a) into C-a. */
4559 if (modifiers
& ctrl_modifier
)
4560 return make_number ((modifiers
& ~ctrl_modifier
)
4561 | make_ctrl_char (XINT (base
)));
4563 return make_number (modifiers
| XINT (base
));
4565 else if (SYMBOLP (base
))
4566 return apply_modifiers (modifiers
, base
);
4568 error ("Invalid base event");
4571 /* Try to recognize SYMBOL as a modifier name.
4572 Return the modifier flag bit, or 0 if not recognized. */
4575 parse_solitary_modifier (symbol
)
4578 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
4580 switch (name
->data
[0])
4582 #define SINGLE_LETTER_MOD(BIT) \
4583 if (name->size == 1) \
4586 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
4587 if (LEN == name->size \
4588 && ! strncmp (name->data, NAME, LEN)) \
4592 SINGLE_LETTER_MOD (alt_modifier
);
4596 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
4600 SINGLE_LETTER_MOD (ctrl_modifier
);
4604 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
4605 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
4609 SINGLE_LETTER_MOD (hyper_modifier
);
4613 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
4617 SINGLE_LETTER_MOD (meta_modifier
);
4621 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
4625 SINGLE_LETTER_MOD (shift_modifier
);
4629 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
4630 MULTI_LETTER_MOD (super_modifier
, "super", 5);
4631 SINGLE_LETTER_MOD (super_modifier
);
4635 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
4636 MULTI_LETTER_MOD (down_modifier
, "down", 4);
4637 MULTI_LETTER_MOD (double_modifier
, "double", 6);
4641 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
4644 #undef SINGLE_LETTER_MOD
4645 #undef MULTI_LETTER_MOD
4651 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
4652 Such a list is not valid as an event,
4653 but it can be a Lucid-style event type list. */
4656 lucid_event_type_list_p (object
)
4661 if (! CONSP (object
))
4664 for (tail
= object
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
4667 elt
= XCONS (tail
)->car
;
4668 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
4675 /* Store into *addr a value nonzero if terminal input chars are available.
4676 Serves the purpose of ioctl (0, FIONREAD, addr)
4677 but works even if FIONREAD does not exist.
4678 (In fact, this may actually read some input.)
4680 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
4683 get_input_pending (addr
, do_timers_now
)
4687 /* First of all, have we already counted some input? */
4688 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4690 /* If input is being read as it arrives, and we have none, there is none. */
4691 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
4694 /* Try to read some input and see how much we get. */
4696 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4699 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
4702 gobble_input (expected
)
4707 if (interrupt_input
)
4710 mask
= sigblockx (SIGIO
);
4711 read_avail_input (expected
);
4715 #ifdef POLL_FOR_INPUT
4716 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
4719 mask
= sigblockx (SIGALRM
);
4720 read_avail_input (expected
);
4726 read_avail_input (expected
);
4730 /* Put a buffer_switch_event in the buffer
4731 so that read_key_sequence will notice the new current buffer. */
4733 record_asynch_buffer_change ()
4735 struct input_event event
;
4738 event
.kind
= buffer_switch_event
;
4739 event
.frame_or_window
= Qnil
;
4742 /* We don't need a buffer-switch event unless Emacs is waiting for input.
4743 The purpose of the event is to make read_key_sequence look up the
4744 keymaps again. If we aren't in read_key_sequence, we don't need one,
4745 and the event could cause trouble by messing up (input-pending-p). */
4746 tem
= Fwaiting_for_user_input_p ();
4750 /* We never need these events if we have no asynchronous subprocesses. */
4754 /* Make sure no interrupt happens while storing the event. */
4756 if (interrupt_input
)
4759 mask
= sigblockx (SIGIO
);
4760 kbd_buffer_store_event (&event
);
4767 kbd_buffer_store_event (&event
);
4774 /* Read any terminal input already buffered up by the system
4775 into the kbd_buffer, but do not wait.
4777 EXPECTED should be nonzero if the caller knows there is some input.
4779 Except on VMS, all input is read by this function.
4780 If interrupt_input is nonzero, this function MUST be called
4781 only when SIGIO is blocked.
4783 Returns the number of keyboard chars read, or -1 meaning
4784 this is a bad time to try to read input. */
4787 read_avail_input (expected
)
4790 struct input_event buf
[KBD_BUFFER_SIZE
];
4794 if (read_socket_hook
)
4795 /* No need for FIONREAD or fcntl; just say don't wait. */
4796 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
,
4797 expected
, expected
);
4800 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
4801 the kbd_buffer can really hold. That may prevent loss
4802 of characters on some systems when input is stuffed at us. */
4803 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
4806 /* Determine how many characters we should *try* to read. */
4809 #else /* not WINDOWSNT */
4811 n_to_read
= dos_keysns ();
4814 #else /* not MSDOS */
4816 /* Find out how much input is available. */
4817 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
4818 /* Formerly simply reported no input, but that sometimes led to
4819 a failure of Emacs to terminate.
4820 SIGHUP seems appropriate if we can't reach the terminal. */
4821 /* ??? Is it really right to send the signal just to this process
4822 rather than to the whole process group?
4823 Perhaps on systems with FIONREAD Emacs is alone in its group. */
4824 kill (getpid (), SIGHUP
);
4827 if (n_to_read
> sizeof cbuf
)
4828 n_to_read
= sizeof cbuf
;
4829 #else /* no FIONREAD */
4830 #if defined (USG) || defined (DGUX)
4831 /* Read some input if available, but don't wait. */
4832 n_to_read
= sizeof cbuf
;
4833 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
4838 #endif /* not MSDOS */
4839 #endif /* not WINDOWSNT */
4841 /* Now read; for one reason or another, this will not block.
4842 NREAD is set to the number of chars read. */
4846 cbuf
[0] = dos_keyread ();
4849 nread
= read (input_fd
, cbuf
, n_to_read
);
4851 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
4852 /* The kernel sometimes fails to deliver SIGHUP for ptys.
4853 This looks incorrect, but it isn't, because _BSD causes
4854 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
4855 and that causes a value other than 0 when there is no input. */
4861 /* We used to retry the read if it was interrupted.
4862 But this does the wrong thing when O_NDELAY causes
4863 an EAGAIN error. Does anybody know of a situation
4864 where a retry is actually needed? */
4866 nread
< 0 && (errno
== EAGAIN
4880 #if defined (USG) || defined (DGUX)
4881 fcntl (input_fd
, F_SETFL
, 0);
4882 #endif /* USG or DGUX */
4883 #endif /* no FIONREAD */
4884 for (i
= 0; i
< nread
; i
++)
4886 buf
[i
].kind
= ascii_keystroke
;
4887 buf
[i
].modifiers
= 0;
4888 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
4889 buf
[i
].modifiers
= meta_modifier
;
4893 buf
[i
].code
= cbuf
[i
];
4895 XSETFRAME (buf
[i
].frame_or_window
, selected_frame
);
4897 buf
[i
].frame_or_window
= Qnil
;
4902 /* Scan the chars for C-g and store them in kbd_buffer. */
4903 for (i
= 0; i
< nread
; i
++)
4905 kbd_buffer_store_event (&buf
[i
]);
4906 /* Don't look at input that follows a C-g too closely.
4907 This reduces lossage due to autorepeat on C-g. */
4908 if (buf
[i
].kind
== ascii_keystroke
4909 && buf
[i
].code
== quit_char
)
4915 #endif /* not VMS */
4917 #ifdef SIGIO /* for entire page */
4918 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4921 input_available_signal (signo
)
4924 /* Must preserve main program's value of errno. */
4925 int old_errno
= errno
;
4927 extern int select_alarmed
;
4931 /* USG systems forget handlers when they are used;
4932 must reestablish each time */
4933 signal (signo
, input_available_signal
);
4940 if (input_available_clear_time
)
4941 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
4946 nread
= read_avail_input (1);
4947 /* -1 means it's not ok to read the input now.
4948 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
4949 0 means there was no keyboard input available. */
4954 select_alarmed
= 1; /* Force the select emulator back to life */
4965 /* Send ourselves a SIGIO.
4967 This function exists so that the UNBLOCK_INPUT macro in
4968 blockinput.h can have some way to take care of input we put off
4969 dealing with, without assuming that every file which uses
4970 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
4972 reinvoke_input_signal ()
4975 kill (getpid (), SIGIO
);
4981 /* Return the prompt-string of a sparse keymap.
4982 This is the first element which is a string.
4983 Return nil if there is none. */
4991 register Lisp_Object tem
;
5000 static void menu_bar_item ();
5001 static void menu_bar_one_keymap ();
5003 /* These variables hold the vector under construction within
5004 menu_bar_items and its subroutines, and the current index
5005 for storing into that vector. */
5006 static Lisp_Object menu_bar_items_vector
;
5007 static int menu_bar_items_index
;
5009 /* Return a vector of menu items for a menu bar, appropriate
5010 to the current buffer. Each item has three elements in the vector:
5013 OLD is an old vector we can optionally reuse, or nil. */
5016 menu_bar_items (old
)
5019 /* The number of keymaps we're scanning right now, and the number of
5020 keymaps we have allocated space for. */
5023 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5024 in the current keymaps, or nil where it is not a prefix. */
5027 Lisp_Object def
, tem
, tail
;
5036 struct gcpro gcpro1
;
5038 /* In order to build the menus, we need to call the keymap
5039 accessors. They all call QUIT. But this function is called
5040 during redisplay, during which a quit is fatal. So inhibit
5041 quitting while building the menus.
5042 We do this instead of specbind because (1) errors will clear it anyway
5043 and (2) this avoids risk of specpdl overflow. */
5044 oquit
= Vinhibit_quit
;
5048 menu_bar_items_vector
= old
;
5050 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
5051 menu_bar_items_index
= 0;
5053 GCPRO1 (menu_bar_items_vector
);
5055 /* Build our list of keymaps.
5056 If we recognize a function key and replace its escape sequence in
5057 keybuf with its symbol, or if the sequence starts with a mouse
5058 click and we need to switch buffers, we jump back here to rebuild
5059 the initial keymaps from the current buffer. */
5063 /* Should overriding-terminal-local-map and overriding-local-map apply? */
5064 if (!NILP (Voverriding_local_map_menu_flag
))
5066 /* Yes, use them (if non-nil) as well as the global map. */
5067 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
5069 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5070 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5071 if (!NILP (Voverriding_local_map
))
5072 maps
[nmaps
++] = Voverriding_local_map
;
5076 /* No, so use major and minor mode keymaps. */
5077 nmaps
= current_minor_maps (NULL
, &tmaps
);
5078 maps
= (Lisp_Object
*) alloca ((nmaps
+ 2) * sizeof (maps
[0]));
5079 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
5080 #ifdef USE_TEXT_PROPERTIES
5081 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
5083 maps
[nmaps
++] = current_buffer
->keymap
;
5086 maps
[nmaps
++] = current_global_map
;
5089 /* Look up in each map the dummy prefix key `menu-bar'. */
5093 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
5095 if (! NILP (maps
[mapno
]))
5096 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
5100 tem
= Fkeymapp (def
);
5102 menu_bar_one_keymap (def
);
5105 /* Move to the end those items that should be at the end. */
5107 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5110 int end
= menu_bar_items_index
;
5112 for (i
= 0; i
< end
; i
+= 4)
5113 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5115 Lisp_Object tem0
, tem1
, tem2
, tem3
;
5116 /* Move the item at index I to the end,
5117 shifting all the others forward. */
5118 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
5119 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
5120 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5121 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
5123 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5124 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5125 (end
- i
- 4) * sizeof (Lisp_Object
));
5126 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
5127 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
5128 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
5129 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
5134 /* Add nil, nil, nil, nil at the end. */
5135 i
= menu_bar_items_index
;
5136 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5139 int newsize
= 2 * i
;
5140 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5141 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5142 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5143 menu_bar_items_vector
= tem
;
5145 /* Add this item. */
5146 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5147 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5148 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5149 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5150 menu_bar_items_index
= i
;
5152 Vinhibit_quit
= oquit
;
5154 return menu_bar_items_vector
;
5157 /* Scan one map KEYMAP, accumulating any menu items it defines
5158 in menu_bar_items_vector. */
5161 menu_bar_one_keymap (keymap
)
5164 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
5166 /* Loop over all keymap entries that have menu strings. */
5167 for (tail
= keymap
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5169 item
= XCONS (tail
)->car
;
5172 key
= XCONS (item
)->car
;
5173 binding
= XCONS (item
)->cdr
;
5174 if (CONSP (binding
))
5176 item_string
= XCONS (binding
)->car
;
5177 if (STRINGP (item_string
))
5178 menu_bar_item (key
, item_string
, Fcdr (binding
));
5180 else if (EQ (binding
, Qundefined
))
5181 menu_bar_item (key
, Qnil
, binding
);
5183 else if (VECTORP (item
))
5185 /* Loop over the char values represented in the vector. */
5186 int len
= XVECTOR (item
)->size
;
5188 for (c
= 0; c
< len
; c
++)
5190 Lisp_Object character
;
5191 XSETFASTINT (character
, c
);
5192 binding
= XVECTOR (item
)->contents
[c
];
5193 if (CONSP (binding
))
5195 item_string
= XCONS (binding
)->car
;
5196 if (STRINGP (item_string
))
5197 menu_bar_item (key
, item_string
, Fcdr (binding
));
5199 else if (EQ (binding
, Qundefined
))
5200 menu_bar_item (key
, Qnil
, binding
);
5206 /* This is used as the handler when calling internal_condition_case_1. */
5209 menu_bar_item_1 (arg
)
5215 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
5216 If there's already an item for KEY, add this DEF to it. */
5219 menu_bar_item (key
, item_string
, def
)
5220 Lisp_Object key
, item_string
, def
;
5223 Lisp_Object enabled
;
5226 if (EQ (def
, Qundefined
))
5228 /* If a map has an explicit `undefined' as definition,
5229 discard any previously made menu bar item. */
5231 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5232 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5234 if (menu_bar_items_index
> i
+ 4)
5235 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5236 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5237 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
5238 menu_bar_items_index
-= 4;
5242 /* If there's no definition for this key yet,
5243 just ignore `undefined'. */
5247 /* See if this entry is enabled. */
5252 /* No property, or nil, means enable.
5253 Otherwise, enable if value is not nil. */
5254 tem
= Fget (def
, Qmenu_enable
);
5256 /* (condition-case nil (eval tem)
5258 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
5262 /* Ignore this item if it's not enabled. */
5266 /* Find any existing item for this KEY. */
5267 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5268 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5271 /* If we did not find this KEY, add it at the end. */
5272 if (i
== menu_bar_items_index
)
5274 /* If vector is too small, get a bigger one. */
5275 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5278 int newsize
= 2 * i
;
5279 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5280 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5281 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5282 menu_bar_items_vector
= tem
;
5284 /* Add this item. */
5285 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
5286 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
5287 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
5288 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
5289 menu_bar_items_index
= i
;
5291 /* We did find an item for this KEY. Add DEF to its list of maps. */
5295 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5296 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
5300 /* Read a character using menus based on maps in the array MAPS.
5301 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
5302 Return t if we displayed a menu but the user rejected it.
5304 PREV_EVENT is the previous input event, or nil if we are reading
5305 the first event of a key sequence.
5307 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
5308 if we used a mouse menu to read the input, or zero otherwise. If
5309 USED_MOUSE_MENU is null, we don't dereference it.
5311 The prompting is done based on the prompt-string of the map
5312 and the strings associated with various map elements.
5314 This can be done with X menus or with menus put in the minibuf.
5315 These are done in different ways, depending on how the input will be read.
5316 Menus using X are done after auto-saving in read-char, getting the input
5317 event from Fx_popup_menu; menus using the minibuf use read_char recursively
5318 and do auto-saving in the inner call of read_char. */
5321 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
5324 Lisp_Object prev_event
;
5325 int *used_mouse_menu
;
5328 register Lisp_Object name
;
5329 Lisp_Object rest
, vector
;
5331 if (used_mouse_menu
)
5332 *used_mouse_menu
= 0;
5334 /* Use local over global Menu maps */
5336 if (! menu_prompting
)
5339 /* Optionally disregard all but the global map. */
5340 if (inhibit_local_menu_bar_menus
)
5342 maps
+= (nmaps
- 1);
5346 /* Get the menu name from the first map that has one (a prompt string). */
5347 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5349 name
= map_prompt (maps
[mapno
]);
5354 /* If we don't have any menus, just read a character normally. */
5359 /* If we got to this point via a mouse click,
5360 use a real menu for mouse selection. */
5361 if (EVENT_HAS_PARAMETERS (prev_event
)
5362 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
))
5364 /* Display the menu and get the selection. */
5365 Lisp_Object
*realmaps
5366 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
5370 /* Use the maps that are not nil. */
5371 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5372 if (!NILP (maps
[mapno
]))
5373 realmaps
[nmaps1
++] = maps
[mapno
];
5375 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
5380 /* If we got multiple events, unread all but
5382 There is no way to prevent those unread events
5383 from showing up later in last_nonmenu_event.
5384 So turn symbol and integer events into lists,
5385 to indicate that they came from a mouse menu,
5386 so that when present in last_nonmenu_event
5387 they won't confuse things. */
5388 for (tem
= XCONS (value
)->cdr
; !NILP (tem
);
5389 tem
= XCONS (tem
)->cdr
)
5390 if (SYMBOLP (XCONS (tem
)->car
)
5391 || INTEGERP (XCONS (tem
)->car
))
5393 = Fcons (XCONS (tem
)->car
, Qnil
);
5395 /* If we got more than one event, put all but the first
5396 onto this list to be read later.
5397 Return just the first event now. */
5398 Vunread_command_events
5399 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
5400 value
= XCONS (value
)->car
;
5402 else if (NILP (value
))
5404 if (used_mouse_menu
)
5405 *used_mouse_menu
= 1;
5408 #endif /* HAVE_MENUS */
5412 /* Buffer in use so far for the minibuf prompts for menu keymaps.
5413 We make this bigger when necessary, and never free it. */
5414 static char *read_char_minibuf_menu_text
;
5415 /* Size of that buffer. */
5416 static int read_char_minibuf_menu_width
;
5419 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
5425 register Lisp_Object name
;
5427 int width
= FRAME_WIDTH (selected_frame
) - 4;
5430 Lisp_Object rest
, vector
;
5433 if (! menu_prompting
)
5436 /* Make sure we have a big enough buffer for the menu text. */
5437 if (read_char_minibuf_menu_text
== 0)
5439 read_char_minibuf_menu_width
= width
+ 4;
5440 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
5442 else if (width
+ 4 > read_char_minibuf_menu_width
)
5444 read_char_minibuf_menu_width
= width
+ 4;
5445 read_char_minibuf_menu_text
5446 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
5448 menu
= read_char_minibuf_menu_text
;
5450 /* Get the menu name from the first map that has one (a prompt string). */
5451 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5453 name
= map_prompt (maps
[mapno
]);
5458 /* If we don't have any menus, just read a character normally. */
5462 /* Prompt string always starts with map's prompt, and a space. */
5463 strcpy (menu
, XSTRING (name
)->data
);
5464 nlength
= XSTRING (name
)->size
;
5465 menu
[nlength
++] = ':';
5466 menu
[nlength
++] = ' ';
5469 /* Start prompting at start of first map. */
5473 /* Present the documented bindings, a line at a time. */
5480 Lisp_Object orig_defn_macro
;
5482 /* Loop over elements of map. */
5487 /* If reached end of map, start at beginning of next map. */
5491 /* At end of last map, wrap around to first map if just starting,
5492 or end this line if already have something on it. */
5496 if (notfirst
|| nobindings
) break;
5501 /* Look at the next element of the map. */
5503 elt
= XVECTOR (vector
)->contents
[idx
];
5505 elt
= Fcar_safe (rest
);
5507 if (idx
< 0 && VECTORP (elt
))
5509 /* If we found a dense table in the keymap,
5510 advanced past it, but start scanning its contents. */
5511 rest
= Fcdr_safe (rest
);
5517 /* An ordinary element. */
5522 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
5523 event
= Fcar_safe (elt
);
5527 s
= Fcar_safe (elt
); /* vector */
5528 XSETINT (event
, idx
);
5531 /* Ignore the element if it has no prompt string. */
5532 if (STRINGP (s
) && INTEGERP (event
))
5534 /* 1 if the char to type matches the string. */
5536 Lisp_Object upcased_event
, downcased_event
;
5539 upcased_event
= Fupcase (event
);
5540 downcased_event
= Fdowncase (event
);
5541 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
5542 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
5544 desc
= Fsingle_key_description (event
);
5546 /* If we have room for the prompt string, add it to this line.
5547 If this is the first on the line, always add it. */
5548 if ((XSTRING (s
)->size
+ i
+ 2
5549 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
5555 /* Punctuate between strings. */
5558 strcpy (menu
+ i
, ", ");
5564 /* If the char to type doesn't match the string's
5565 first char, explicitly show what char to type. */
5568 /* Add as much of string as fits. */
5569 thiswidth
= XSTRING (desc
)->size
;
5570 if (thiswidth
+ i
> width
)
5571 thiswidth
= width
- i
;
5572 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
5574 strcpy (menu
+ i
, " = ");
5578 /* Add as much of string as fits. */
5579 thiswidth
= XSTRING (s
)->size
;
5580 if (thiswidth
+ i
> width
)
5581 thiswidth
= width
- i
;
5582 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
5588 /* If this element does not fit, end the line now,
5589 and save the element for the next line. */
5590 strcpy (menu
+ i
, "...");
5595 /* Move past this element. */
5596 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
5597 /* Handle reaching end of dense table. */
5602 rest
= Fcdr_safe (rest
);
5606 /* Prompt with that and read response. */
5609 /* Make believe its not a keyboard macro in case the help char
5610 is pressed. Help characters are not recorded because menu prompting
5611 is not used on replay.
5613 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
5614 current_kboard
->defining_kbd_macro
= Qnil
;
5616 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
5617 while (BUFFERP (obj
));
5618 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
5620 if (!INTEGERP (obj
))
5625 if (! EQ (obj
, menu_prompt_more_char
)
5626 && (!INTEGERP (menu_prompt_more_char
)
5627 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
5629 if (!NILP (current_kboard
->defining_kbd_macro
))
5630 store_kbd_macro_char (obj
);
5633 /* Help char - go round again */
5637 /* Reading key sequences. */
5639 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
5640 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
5641 keymap, or nil otherwise. Return the index of the first keymap in
5642 which KEY has any binding, or NMAPS if no map has a binding.
5644 If KEY is a meta ASCII character, treat it like meta-prefix-char
5645 followed by the corresponding non-meta character. Keymaps in
5646 CURRENT with non-prefix bindings for meta-prefix-char become nil in
5649 If KEY has no bindings in any of the CURRENT maps, NEXT is left
5652 NEXT may be the same array as CURRENT. */
5655 follow_key (key
, nmaps
, current
, defs
, next
)
5657 Lisp_Object
*current
, *defs
, *next
;
5660 int i
, first_binding
;
5663 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
5664 followed by the corresponding non-meta character.
5665 Put the results into DEFS, since we are going to alter that anyway.
5666 Do not alter CURRENT or NEXT. */
5667 if (INTEGERP (key
) && (XINT (key
) & CHAR_META
))
5669 for (i
= 0; i
< nmaps
; i
++)
5670 if (! NILP (current
[i
]))
5673 def
= get_keyelt (access_keymap (current
[i
],
5674 meta_prefix_char
, 1, 0));
5676 /* Note that since we pass the resulting bindings through
5677 get_keymap_1, non-prefix bindings for meta-prefix-char
5679 defs
[i
] = get_keymap_1 (def
, 0, 1);
5685 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
5688 first_binding
= nmaps
;
5689 for (i
= nmaps
- 1; i
>= 0; i
--)
5691 if (! NILP (current
[i
]))
5699 defs
[i
] = get_keyelt (access_keymap (map
, key
, 1, 0));
5700 if (! NILP (defs
[i
]))
5707 /* Given the set of bindings we've found, produce the next set of maps. */
5708 if (first_binding
< nmaps
)
5709 for (i
= 0; i
< nmaps
; i
++)
5710 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
5712 return first_binding
;
5715 /* Read a sequence of keys that ends with a non prefix character,
5716 storing it in KEYBUF, a buffer of size BUFSIZE.
5718 Return the length of the key sequence stored.
5719 Return -1 if the user rejected a command menu.
5721 Echo starting immediately unless `prompt' is 0.
5723 Where a key sequence ends depends on the currently active keymaps.
5724 These include any minor mode keymaps active in the current buffer,
5725 the current buffer's local map, and the global map.
5727 If a key sequence has no other bindings, we check Vfunction_key_map
5728 to see if some trailing subsequence might be the beginning of a
5729 function key's sequence. If so, we try to read the whole function
5730 key, and substitute its symbolic name into the key sequence.
5732 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
5733 `double-' events into similar click events, if that would make them
5734 bound. We try to turn `triple-' events first into `double-' events,
5737 If we get a mouse click in a mode line, vertical divider, or other
5738 non-text area, we treat the click as if it were prefixed by the
5739 symbol denoting that area - `mode-line', `vertical-line', or
5742 If the sequence starts with a mouse click, we read the key sequence
5743 with respect to the buffer clicked on, not the current buffer.
5745 If the user switches frames in the midst of a key sequence, we put
5746 off the switch-frame event until later; the next call to
5747 read_char will return it. */
5750 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
5751 can_return_switch_frame
)
5752 Lisp_Object
*keybuf
;
5755 int dont_downcase_last
;
5756 int can_return_switch_frame
;
5758 int count
= specpdl_ptr
- specpdl
;
5760 /* How many keys there are in the current key sequence. */
5763 /* The length of the echo buffer when we started reading, and
5764 the length of this_command_keys when we started reading. */
5768 /* The number of keymaps we're scanning right now, and the number of
5769 keymaps we have allocated space for. */
5771 int nmaps_allocated
= 0;
5773 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
5774 the current keymaps. */
5777 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5778 in the current keymaps, or nil where it is not a prefix. */
5779 Lisp_Object
*submaps
;
5781 /* The local map to start out with at start of key sequence. */
5782 Lisp_Object orig_local_map
;
5784 /* 1 if we have already considered switching to the local-map property
5785 of the place where a mouse click occurred. */
5786 int localized_local_map
= 0;
5788 /* The index in defs[] of the first keymap that has a binding for
5789 this key sequence. In other words, the lowest i such that
5790 defs[i] is non-nil. */
5793 /* If t < mock_input, then KEYBUF[t] should be read as the next
5796 We use this to recover after recognizing a function key. Once we
5797 realize that a suffix of the current key sequence is actually a
5798 function key's escape sequence, we replace the suffix with the
5799 function key's binding from Vfunction_key_map. Now keybuf
5800 contains a new and different key sequence, so the echo area,
5801 this_command_keys, and the submaps and defs arrays are wrong. In
5802 this situation, we set mock_input to t, set t to 0, and jump to
5803 restart_sequence; the loop will read keys from keybuf up until
5804 mock_input, thus rebuilding the state; and then it will resume
5805 reading characters from the keyboard. */
5808 /* If the sequence is unbound in submaps[], then
5809 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
5810 and fkey_map is its binding.
5812 These might be > t, indicating that all function key scanning
5813 should hold off until t reaches them. We do this when we've just
5814 recognized a function key, to avoid searching for the function
5815 key's again in Vfunction_key_map. */
5816 int fkey_start
= 0, fkey_end
= 0;
5817 Lisp_Object fkey_map
;
5819 /* Likewise, for key_translation_map. */
5820 int keytran_start
= 0, keytran_end
= 0;
5821 Lisp_Object keytran_map
;
5823 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
5824 we put it off for later. While we're reading, we keep the event here. */
5825 Lisp_Object delayed_switch_frame
;
5827 /* See the comment below... */
5828 #if defined (GOBBLE_FIRST_EVENT)
5829 Lisp_Object first_event
;
5832 Lisp_Object original_uppercase
;
5833 int original_uppercase_position
= -1;
5835 /* Gets around Microsoft compiler limitations. */
5838 struct buffer
*starting_buffer
;
5840 /* Nonzero if we seem to have got the beginning of a binding
5841 in function_key_map. */
5842 int function_key_possible
= 0;
5843 int key_translation_possible
= 0;
5845 /* Save the status of key translation before each step,
5846 so that we can restore this after downcasing. */
5847 Lisp_Object prev_fkey_map
;
5848 Lisp_Object prev_fkey_start
;
5849 Lisp_Object prev_fkey_end
;
5851 Lisp_Object prev_keytran_map
;
5852 Lisp_Object prev_keytran_start
;
5853 Lisp_Object prev_keytran_end
;
5857 last_nonmenu_event
= Qnil
;
5859 delayed_switch_frame
= Qnil
;
5860 fkey_map
= Vfunction_key_map
;
5861 keytran_map
= Vkey_translation_map
;
5863 /* If there is no function-key-map, turn off function key scanning. */
5864 if (NILP (Fkeymapp (Vfunction_key_map
)))
5865 fkey_start
= fkey_end
= bufsize
+ 1;
5867 /* If there is no key-translation-map, turn off scanning. */
5868 if (NILP (Fkeymapp (Vkey_translation_map
)))
5869 keytran_start
= keytran_end
= bufsize
+ 1;
5874 echo_prompt (XSTRING (prompt
)->data
);
5875 else if (cursor_in_echo_area
&& echo_keystrokes
)
5876 /* This doesn't put in a dash if the echo buffer is empty, so
5877 you don't always see a dash hanging out in the minibuffer. */
5881 /* Record the initial state of the echo area and this_command_keys;
5882 we will need to restore them if we replay a key sequence. */
5884 echo_start
= echo_length ();
5885 keys_start
= this_command_key_count
;
5886 this_single_command_key_start
= keys_start
;
5888 #if defined (GOBBLE_FIRST_EVENT)
5889 /* This doesn't quite work, because some of the things that read_char
5890 does cannot safely be bypassed. It seems too risky to try to make
5893 /* Read the first char of the sequence specially, before setting
5894 up any keymaps, in case a filter runs and switches buffers on us. */
5895 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
5897 #endif /* GOBBLE_FIRST_EVENT */
5899 orig_local_map
= get_local_map (PT
, current_buffer
);
5901 /* We jump here when the key sequence has been thoroughly changed, and
5902 we need to rescan it starting from the beginning. When we jump here,
5903 keybuf[0..mock_input] holds the sequence we should reread. */
5906 starting_buffer
= current_buffer
;
5907 function_key_possible
= 0;
5908 key_translation_possible
= 0;
5910 /* Build our list of keymaps.
5911 If we recognize a function key and replace its escape sequence in
5912 keybuf with its symbol, or if the sequence starts with a mouse
5913 click and we need to switch buffers, we jump back here to rebuild
5914 the initial keymaps from the current buffer. */
5918 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
5919 || !NILP (Voverriding_local_map
))
5921 if (3 > nmaps_allocated
)
5923 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
5924 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
5925 nmaps_allocated
= 3;
5928 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5929 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5930 if (!NILP (Voverriding_local_map
))
5931 submaps
[nmaps
++] = Voverriding_local_map
;
5935 nmaps
= current_minor_maps (0, &maps
);
5936 if (nmaps
+ 2 > nmaps_allocated
)
5938 submaps
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (submaps
[0]));
5939 defs
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (defs
[0]));
5940 nmaps_allocated
= nmaps
+ 2;
5942 bcopy (maps
, submaps
, nmaps
* sizeof (submaps
[0]));
5943 #ifdef USE_TEXT_PROPERTIES
5944 submaps
[nmaps
++] = orig_local_map
;
5946 submaps
[nmaps
++] = current_buffer
->keymap
;
5949 submaps
[nmaps
++] = current_global_map
;
5952 /* Find an accurate initial value for first_binding. */
5953 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
5954 if (! NILP (submaps
[first_binding
]))
5957 /* Start from the beginning in keybuf. */
5960 /* These are no-ops the first time through, but if we restart, they
5961 revert the echo area and this_command_keys to their original state. */
5962 this_command_key_count
= keys_start
;
5963 if (INTERACTIVE
&& t
< mock_input
)
5964 echo_truncate (echo_start
);
5966 /* If the best binding for the current key sequence is a keymap, or
5967 we may be looking at a function key's escape sequence, keep on
5969 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
5970 || (first_binding
>= nmaps
5972 /* mock input is never part of a function key's sequence. */
5973 && mock_input
<= fkey_start
)
5974 || (first_binding
>= nmaps
5975 && keytran_start
< t
&& key_translation_possible
)
5976 /* Don't return in the middle of a possible function key sequence,
5977 if the only bindings we found were via case conversion.
5978 Thus, if ESC O a has a function-key-map translation
5979 and ESC o has a binding, don't return after ESC O,
5980 so that we can translate ESC O plus the next character. */
5984 int used_mouse_menu
= 0;
5986 /* Where the last real key started. If we need to throw away a
5987 key that has expanded into more than one element of keybuf
5988 (say, a mouse click on the mode line which is being treated
5989 as [mode-line (mouse-...)], then we backtrack to this point
5991 int last_real_key_start
;
5993 /* These variables are analogous to echo_start and keys_start;
5994 while those allow us to restart the entire key sequence,
5995 echo_local_start and keys_local_start allow us to throw away
5997 int echo_local_start
, keys_local_start
, local_first_binding
;
6000 error ("Key sequence too long");
6003 echo_local_start
= echo_length ();
6004 keys_local_start
= this_command_key_count
;
6005 local_first_binding
= first_binding
;
6008 /* These are no-ops, unless we throw away a keystroke below and
6009 jumped back up to replay_key; in that case, these restore the
6010 variables to their original state, allowing us to replay the
6012 if (INTERACTIVE
&& t
< mock_input
)
6013 echo_truncate (echo_local_start
);
6014 this_command_key_count
= keys_local_start
;
6015 first_binding
= local_first_binding
;
6017 /* By default, assume each event is "real". */
6018 last_real_key_start
= t
;
6020 /* Does mock_input indicate that we are re-reading a key sequence? */
6024 add_command_key (key
);
6025 if (echo_keystrokes
)
6029 /* If not, we should actually read a character. */
6032 struct buffer
*buf
= current_buffer
;
6036 KBOARD
*interrupted_kboard
= current_kboard
;
6037 struct frame
*interrupted_frame
= selected_frame
;
6038 if (setjmp (wrong_kboard_jmpbuf
))
6040 if (!NILP (delayed_switch_frame
))
6042 interrupted_kboard
->kbd_queue
6043 = Fcons (delayed_switch_frame
,
6044 interrupted_kboard
->kbd_queue
);
6045 delayed_switch_frame
= Qnil
;
6048 interrupted_kboard
->kbd_queue
6049 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
6051 /* If the side queue is non-empty, ensure it begins with a
6052 switch-frame, so we'll replay it in the right context. */
6053 if (CONSP (interrupted_kboard
->kbd_queue
)
6054 && (key
= XCONS (interrupted_kboard
->kbd_queue
)->car
,
6055 !(EVENT_HAS_PARAMETERS (key
)
6056 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
6060 XSETFRAME (frame
, interrupted_frame
);
6061 interrupted_kboard
->kbd_queue
6062 = Fcons (make_lispy_switch_frame (frame
),
6063 interrupted_kboard
->kbd_queue
);
6066 orig_local_map
= get_local_map (PT
, current_buffer
);
6067 goto replay_sequence
;
6070 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
6074 /* read_char returns t when it shows a menu and the user rejects it.
6079 /* read_char returns -1 at the end of a macro.
6080 Emacs 18 handles this by returning immediately with a
6081 zero, so that's what we'll do. */
6082 if (INTEGERP (key
) && XINT (key
) == -1)
6085 /* The Microsoft C compiler can't handle the goto that
6091 /* If the current buffer has been changed from under us, the
6092 keymap may have changed, so replay the sequence. */
6096 orig_local_map
= get_local_map (PT
, current_buffer
);
6097 goto replay_sequence
;
6100 /* If we have a quit that was typed in another frame, and
6101 quit_throw_to_read_char switched buffers,
6102 replay to get the right keymap. */
6103 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
6108 orig_local_map
= get_local_map (PT
, current_buffer
);
6109 goto replay_sequence
;
6115 /* Clicks in non-text areas get prefixed by the symbol
6116 in their CHAR-ADDRESS field. For example, a click on
6117 the mode line is prefixed by the symbol `mode-line'.
6119 Furthermore, key sequences beginning with mouse clicks
6120 are read using the keymaps of the buffer clicked on, not
6121 the current buffer. So we may have to switch the buffer
6124 When we turn one event into two events, we must make sure
6125 that neither of the two looks like the original--so that,
6126 if we replay the events, they won't be expanded again.
6127 If not for this, such reexpansion could happen either here
6128 or when user programs play with this-command-keys. */
6129 if (EVENT_HAS_PARAMETERS (key
))
6133 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
6134 if (EQ (kind
, Qmouse_click
))
6136 Lisp_Object window
, posn
;
6138 window
= POSN_WINDOW (EVENT_START (key
));
6139 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6142 /* We're looking at the second event of a
6143 sequence which we expanded before. Set
6144 last_real_key_start appropriately. */
6146 last_real_key_start
= t
- 1;
6149 /* Key sequences beginning with mouse clicks are
6150 read using the keymaps in the buffer clicked on,
6151 not the current buffer. If we're at the
6152 beginning of a key sequence, switch buffers. */
6153 if (last_real_key_start
== 0
6155 && BUFFERP (XWINDOW (window
)->buffer
)
6156 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
6161 /* Arrange to go back to the original buffer once we're
6162 done reading the key sequence. Note that we can't
6163 use save_excursion_{save,restore} here, because they
6164 save point as well as the current buffer; we don't
6165 want to save point, because redisplay may change it,
6166 to accommodate a Fset_window_start or something. We
6167 don't want to do this at the top of the function,
6168 because we may get input from a subprocess which
6169 wants to change the selected window and stuff (say,
6171 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
6173 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
6174 orig_local_map
= get_local_map (PT
, current_buffer
);
6175 goto replay_sequence
;
6177 /* For a mouse click, get the local text-property keymap
6178 of the place clicked on, rather than point. */
6179 if (last_real_key_start
== 0 && CONSP (XCONS (key
)->cdr
)
6180 && ! localized_local_map
)
6182 Lisp_Object map_here
, start
, pos
;
6184 localized_local_map
= 1;
6185 start
= EVENT_START (key
);
6186 if (CONSP (start
) && CONSP (XCONS (start
)->cdr
))
6188 pos
= POSN_BUFFER_POSN (start
);
6190 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
6192 map_here
= get_local_map (XINT (pos
), current_buffer
);
6193 if (!EQ (map_here
, orig_local_map
))
6195 orig_local_map
= map_here
;
6199 goto replay_sequence
;
6205 /* Expand mode-line and scroll-bar events into two events:
6206 use posn as a fake prefix key. */
6209 if (t
+ 1 >= bufsize
)
6210 error ("Key sequence too long");
6215 /* Zap the position in key, so we know that we've
6216 expanded it, and don't try to do so again. */
6217 POSN_BUFFER_POSN (EVENT_START (key
))
6218 = Fcons (posn
, Qnil
);
6222 else if (EQ (kind
, Qswitch_frame
))
6224 /* If we're at the beginning of a key sequence, and the caller
6225 says it's okay, go ahead and return this event. If we're
6226 in the midst of a key sequence, delay it until the end. */
6227 if (t
> 0 || !can_return_switch_frame
)
6229 delayed_switch_frame
= key
;
6233 else if (CONSP (XCONS (key
)->cdr
)
6234 && CONSP (EVENT_START (key
))
6235 && CONSP (XCONS (EVENT_START (key
))->cdr
))
6239 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6240 /* Handle menu-bar events:
6241 insert the dummy prefix event `menu-bar'. */
6242 if (EQ (posn
, Qmenu_bar
))
6244 if (t
+ 1 >= bufsize
)
6245 error ("Key sequence too long");
6249 /* Zap the position in key, so we know that we've
6250 expanded it, and don't try to do so again. */
6251 POSN_BUFFER_POSN (EVENT_START (key
))
6252 = Fcons (posn
, Qnil
);
6255 goto replay_sequence
;
6257 else if (CONSP (posn
))
6259 /* We're looking at the second event of a
6260 sequence which we expanded before. Set
6261 last_real_key_start appropriately. */
6262 if (last_real_key_start
== t
&& t
> 0)
6263 last_real_key_start
= t
- 1;
6268 /* We have finally decided that KEY is something we might want
6270 first_binding
= (follow_key (key
,
6271 nmaps
- first_binding
,
6272 submaps
+ first_binding
,
6273 defs
+ first_binding
,
6274 submaps
+ first_binding
)
6277 /* If KEY wasn't bound, we'll try some fallbacks. */
6278 if (first_binding
>= nmaps
)
6282 head
= EVENT_HEAD (key
);
6283 if (help_char_p (head
) && t
> 0)
6285 read_key_sequence_cmd
= Vprefix_help_command
;
6287 last_nonmenu_event
= key
;
6288 /* The Microsoft C compiler can't handle the goto that
6296 Lisp_Object breakdown
;
6299 breakdown
= parse_modifiers (head
);
6300 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6301 /* Attempt to reduce an unbound mouse event to a simpler
6302 event that is bound:
6303 Drags reduce to clicks.
6304 Double-clicks reduce to clicks.
6305 Triple-clicks reduce to double-clicks, then to clicks.
6306 Down-clicks are eliminated.
6307 Double-downs reduce to downs, then are eliminated.
6308 Triple-downs reduce to double-downs, then to downs,
6309 then are eliminated. */
6310 if (modifiers
& (down_modifier
| drag_modifier
6311 | double_modifier
| triple_modifier
))
6313 while (modifiers
& (down_modifier
| drag_modifier
6314 | double_modifier
| triple_modifier
))
6316 Lisp_Object new_head
, new_click
;
6317 if (modifiers
& triple_modifier
)
6318 modifiers
^= (double_modifier
| triple_modifier
);
6319 else if (modifiers
& double_modifier
)
6320 modifiers
&= ~double_modifier
;
6321 else if (modifiers
& drag_modifier
)
6322 modifiers
&= ~drag_modifier
;
6325 /* Dispose of this `down' event by simply jumping
6326 back to replay_key, to get another event.
6328 Note that if this event came from mock input,
6329 then just jumping back to replay_key will just
6330 hand it to us again. So we have to wipe out any
6333 We could delete keybuf[t] and shift everything
6334 after that to the left by one spot, but we'd also
6335 have to fix up any variable that points into
6336 keybuf, and shifting isn't really necessary
6339 Adding prefixes for non-textual mouse clicks
6340 creates two characters of mock input, and both
6341 must be thrown away. If we're only looking at
6342 the prefix now, we can just jump back to
6343 replay_key. On the other hand, if we've already
6344 processed the prefix, and now the actual click
6345 itself is giving us trouble, then we've lost the
6346 state of the keymaps we want to backtrack to, and
6347 we need to replay the whole sequence to rebuild
6350 Beyond that, only function key expansion could
6351 create more than two keys, but that should never
6352 generate mouse events, so it's okay to zero
6353 mock_input in that case too.
6355 Isn't this just the most wonderful code ever? */
6356 if (t
== last_real_key_start
)
6363 mock_input
= last_real_key_start
;
6364 goto replay_sequence
;
6369 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
6371 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
6373 /* Look for a binding for this new key. follow_key
6374 promises that it didn't munge submaps the
6375 last time we called it, since key was unbound. */
6377 = (follow_key (new_click
,
6378 nmaps
- local_first_binding
,
6379 submaps
+ local_first_binding
,
6380 defs
+ local_first_binding
,
6381 submaps
+ local_first_binding
)
6382 + local_first_binding
);
6384 /* If that click is bound, go for it. */
6385 if (first_binding
< nmaps
)
6390 /* Otherwise, we'll leave key set to the drag event. */
6397 /* Normally, last_nonmenu_event gets the previous key we read.
6398 But when a mouse popup menu is being used,
6399 we don't update last_nonmenu_event; it continues to hold the mouse
6400 event that preceded the first level of menu. */
6401 if (!used_mouse_menu
)
6402 last_nonmenu_event
= key
;
6404 /* Record what part of this_command_keys is the current key sequence. */
6405 this_single_command_key_start
= this_command_key_count
- t
;
6407 prev_fkey_map
= fkey_map
;
6408 prev_fkey_start
= fkey_start
;
6409 prev_fkey_end
= fkey_end
;
6411 prev_keytran_map
= keytran_map
;
6412 prev_keytran_start
= keytran_start
;
6413 prev_keytran_end
= keytran_end
;
6415 /* If the sequence is unbound, see if we can hang a function key
6416 off the end of it. We only want to scan real keyboard input
6417 for function key sequences, so if mock_input says that we're
6418 re-reading old events, don't examine it. */
6419 if (first_binding
>= nmaps
6422 Lisp_Object fkey_next
;
6424 /* Continue scan from fkey_end until we find a bound suffix.
6425 If we fail, increment fkey_start
6426 and start fkey_end from there. */
6427 while (fkey_end
< t
)
6431 key
= keybuf
[fkey_end
++];
6432 /* Look up meta-characters by prefixing them
6433 with meta_prefix_char. I hate this. */
6434 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6439 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
6441 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6444 fkey_next
= fkey_map
;
6447 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
6449 #if 0 /* I didn't turn this on, because it might cause trouble
6450 for the mapping of return into C-m and tab into C-i. */
6451 /* Optionally don't map function keys into other things.
6452 This enables the user to redefine kp- keys easily. */
6453 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
6457 /* If the function key map gives a function, not an
6458 array, then call the function with no args and use
6459 its value instead. */
6460 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
6463 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6467 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6468 fkey_next
= call1 (fkey_next
, prompt
);
6470 /* If the function returned something invalid,
6471 barf--don't ignore it.
6472 (To ignore it safely, we would need to gcpro a bunch of
6473 other variables.) */
6474 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
6475 error ("Function in key-translation-map returns invalid key sequence");
6478 function_key_possible
= ! NILP (fkey_next
);
6480 /* If keybuf[fkey_start..fkey_end] is bound in the
6481 function key map and it's a suffix of the current
6482 sequence (i.e. fkey_end == t), replace it with
6483 the binding and restart with fkey_start at the end. */
6484 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
6487 int len
= XFASTINT (Flength (fkey_next
));
6489 t
= fkey_start
+ len
;
6491 error ("Key sequence too long");
6493 if (VECTORP (fkey_next
))
6494 bcopy (XVECTOR (fkey_next
)->contents
,
6495 keybuf
+ fkey_start
,
6496 (t
- fkey_start
) * sizeof (keybuf
[0]));
6497 else if (STRINGP (fkey_next
))
6501 for (i
= 0; i
< len
; i
++)
6502 XSETFASTINT (keybuf
[fkey_start
+ i
],
6503 XSTRING (fkey_next
)->data
[i
]);
6507 fkey_start
= fkey_end
= t
;
6508 fkey_map
= Vfunction_key_map
;
6510 /* Do pass the results through key-translation-map. */
6511 keytran_start
= keytran_end
= 0;
6512 keytran_map
= Vkey_translation_map
;
6514 goto replay_sequence
;
6517 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
6519 /* If we no longer have a bound suffix, try a new positions for
6521 if (NILP (fkey_map
))
6523 fkey_end
= ++fkey_start
;
6524 fkey_map
= Vfunction_key_map
;
6525 function_key_possible
= 0;
6530 /* Look for this sequence in key-translation-map. */
6532 Lisp_Object keytran_next
;
6534 /* Scan from keytran_end until we find a bound suffix. */
6535 while (keytran_end
< t
)
6539 key
= keybuf
[keytran_end
++];
6540 /* Look up meta-characters by prefixing them
6541 with meta_prefix_char. I hate this. */
6542 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6547 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
6549 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6552 keytran_next
= keytran_map
;
6555 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
6557 /* If the key translation map gives a function, not an
6558 array, then call the function with no args and use
6559 its value instead. */
6560 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
6561 && keytran_end
== t
)
6563 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6567 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6568 keytran_next
= call1 (keytran_next
, prompt
);
6570 /* If the function returned something invalid,
6571 barf--don't ignore it.
6572 (To ignore it safely, we would need to gcpro a bunch of
6573 other variables.) */
6574 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
6575 error ("Function in key-translation-map returns invalid key sequence");
6578 key_translation_possible
= ! NILP (keytran_next
);
6580 /* If keybuf[keytran_start..keytran_end] is bound in the
6581 key translation map and it's a suffix of the current
6582 sequence (i.e. keytran_end == t), replace it with
6583 the binding and restart with keytran_start at the end. */
6584 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
6585 && keytran_end
== t
)
6587 int len
= XFASTINT (Flength (keytran_next
));
6589 t
= keytran_start
+ len
;
6591 error ("Key sequence too long");
6593 if (VECTORP (keytran_next
))
6594 bcopy (XVECTOR (keytran_next
)->contents
,
6595 keybuf
+ keytran_start
,
6596 (t
- keytran_start
) * sizeof (keybuf
[0]));
6597 else if (STRINGP (keytran_next
))
6601 for (i
= 0; i
< len
; i
++)
6602 XSETFASTINT (keybuf
[keytran_start
+ i
],
6603 XSTRING (keytran_next
)->data
[i
]);
6607 keytran_start
= keytran_end
= t
;
6608 keytran_map
= Vkey_translation_map
;
6610 /* Don't pass the results of key-translation-map
6611 through function-key-map. */
6612 fkey_start
= fkey_end
= t
;
6613 fkey_map
= Vkey_translation_map
;
6615 goto replay_sequence
;
6618 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
6620 /* If we no longer have a bound suffix, try a new positions for
6622 if (NILP (keytran_map
))
6624 keytran_end
= ++keytran_start
;
6625 keytran_map
= Vkey_translation_map
;
6626 key_translation_possible
= 0;
6631 /* If KEY is not defined in any of the keymaps,
6632 and cannot be part of a function key or translation,
6633 and is an upper case letter
6634 use the corresponding lower-case letter instead. */
6635 if (first_binding
== nmaps
&& ! function_key_possible
6636 && ! key_translation_possible
6638 && ((((XINT (key
) & 0x3ffff)
6639 < XSTRING (current_buffer
->downcase_table
)->size
)
6640 && UPPERCASEP (XINT (key
) & 0x3ffff))
6641 || (XINT (key
) & shift_modifier
)))
6643 Lisp_Object new_key
;
6645 original_uppercase
= key
;
6646 original_uppercase_position
= t
- 1;
6648 if (XINT (key
) & shift_modifier
)
6649 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
6651 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
6652 | (XINT (key
) & ~0x3ffff)));
6654 /* We have to do this unconditionally, regardless of whether
6655 the lower-case char is defined in the keymaps, because they
6656 might get translated through function-key-map. */
6657 keybuf
[t
- 1] = new_key
;
6660 fkey_map
= prev_fkey_map
;
6661 fkey_start
= prev_fkey_start
;
6662 fkey_end
= prev_fkey_end
;
6664 keytran_map
= prev_keytran_map
;
6665 keytran_start
= prev_keytran_start
;
6666 keytran_end
= prev_keytran_end
;
6668 goto replay_sequence
;
6670 /* If KEY is not defined in any of the keymaps,
6671 and cannot be part of a function key or translation,
6672 and is a shifted function key,
6673 use the corresponding unshifted function key instead. */
6674 if (first_binding
== nmaps
&& ! function_key_possible
6675 && ! key_translation_possible
6678 Lisp_Object breakdown
;
6681 breakdown
= parse_modifiers (key
);
6682 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6683 if (modifiers
& shift_modifier
)
6685 Lisp_Object new_key
;
6687 original_uppercase
= key
;
6688 original_uppercase_position
= t
- 1;
6690 modifiers
&= ~shift_modifier
;
6691 new_key
= apply_modifiers (modifiers
,
6692 XCONS (breakdown
)->car
);
6694 keybuf
[t
- 1] = new_key
;
6697 fkey_map
= prev_fkey_map
;
6698 fkey_start
= prev_fkey_start
;
6699 fkey_end
= prev_fkey_end
;
6701 keytran_map
= prev_keytran_map
;
6702 keytran_start
= prev_keytran_start
;
6703 keytran_end
= prev_keytran_end
;
6705 goto replay_sequence
;
6711 read_key_sequence_cmd
= (first_binding
< nmaps
6712 ? defs
[first_binding
]
6715 unread_switch_frame
= delayed_switch_frame
;
6716 unbind_to (count
, Qnil
);
6718 /* Don't downcase the last character if the caller says don't.
6719 Don't downcase it if the result is undefined, either. */
6720 if ((dont_downcase_last
|| first_binding
>= nmaps
)
6721 && t
- 1 == original_uppercase_position
)
6722 keybuf
[t
- 1] = original_uppercase
;
6724 /* Occasionally we fabricate events, perhaps by expanding something
6725 according to function-key-map, or by adding a prefix symbol to a
6726 mouse click in the scroll bar or modeline. In this cases, return
6727 the entire generated key sequence, even if we hit an unbound
6728 prefix or a definition before the end. This means that you will
6729 be able to push back the event properly, and also means that
6730 read-key-sequence will always return a logical unit.
6733 for (; t
< mock_input
; t
++)
6735 if (echo_keystrokes
)
6736 echo_char (keybuf
[t
]);
6737 add_command_key (keybuf
[t
]);
6743 #if 0 /* This doc string is too long for some compilers.
6744 This commented-out definition serves for DOC. */
6745 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
6746 "Read a sequence of keystrokes and return as a string or vector.\n\
6747 The sequence is sufficient to specify a non-prefix command in the\n\
6748 current local and global maps.\n\
6750 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
6751 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
6752 as a continuation of the previous key.\n\
6754 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
6755 convert the last event to lower case. (Normally any upper case event\n\
6756 is converted to lower case if the original event is undefined and the lower\n\
6757 case equivalent is defined.) A non-nil value is appropriate for reading\n\
6758 a key sequence to be defined.\n\
6760 A C-g typed while in this function is treated like any other character,\n\
6761 and `quit-flag' is not set.\n\
6763 If the key sequence starts with a mouse click, then the sequence is read\n\
6764 using the keymaps of the buffer of the window clicked in, not the buffer\n\
6765 of the selected window as normal.\n\
6767 `read-key-sequence' drops unbound button-down events, since you normally\n\
6768 only care about the click or drag events which follow them. If a drag\n\
6769 or multi-click event is unbound, but the corresponding click event would\n\
6770 be bound, `read-key-sequence' turns the event into a click event at the\n\
6771 drag's starting position. This means that you don't have to distinguish\n\
6772 between click and drag, double, or triple events unless you want to.\n\
6774 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
6775 lines separating windows, and scroll bars with imaginary keys\n\
6776 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
6778 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
6779 function will process a switch-frame event if the user switches frames\n\
6780 before typing anything. If the user switches frames in the middle of a\n\
6781 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
6782 is nil, then the event will be put off until after the current key sequence.\n\
6784 `read-key-sequence' checks `function-key-map' for function key\n\
6785 sequences, where they wouldn't conflict with ordinary bindings. See\n\
6786 `function-key-map' for more details.")
6787 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
6790 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
6792 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
6793 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
6794 Lisp_Object can_return_switch_frame
;
6796 Lisp_Object keybuf
[30];
6798 struct gcpro gcpro1
, gcpro2
;
6801 CHECK_STRING (prompt
, 0);
6804 bzero (keybuf
, sizeof keybuf
);
6806 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
6808 if (NILP (continue_echo
))
6810 this_command_key_count
= 0;
6811 this_single_command_key_start
= 0;
6814 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
6815 prompt
, ! NILP (dont_downcase_last
),
6816 ! NILP (can_return_switch_frame
));
6824 return make_event_array (i
, keybuf
);
6827 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
6828 "Execute CMD as an editor command.\n\
6829 CMD must be a symbol that satisfies the `commandp' predicate.\n\
6830 Optional second arg RECORD-FLAG non-nil\n\
6831 means unconditionally put this command in `command-history'.\n\
6832 Otherwise, that is done only if an arg is read using the minibuffer.\n\
6833 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
6834 when reading the arguments; if it is nil, (this-command-keys) is used.\n\
6835 The argument SPECIAL, if non-nil, means that this command is executing\n\
6836 a special event, so ignore the prefix argument and don't clear it.")
6837 (cmd
, record_flag
, keys
, special
)
6838 Lisp_Object cmd
, record_flag
, keys
, special
;
6840 register Lisp_Object final
;
6841 register Lisp_Object tem
;
6842 Lisp_Object prefixarg
;
6843 struct backtrace backtrace
;
6844 extern int debug_on_next_call
;
6846 debug_on_next_call
= 0;
6850 prefixarg
= current_kboard
->Vprefix_arg
;
6851 Vcurrent_prefix_arg
= prefixarg
;
6852 current_kboard
->Vprefix_arg
= Qnil
;
6859 tem
= Fget (cmd
, Qdisabled
);
6860 if (!NILP (tem
) && !NILP (Vrun_hooks
))
6862 tem
= Fsymbol_value (Qdisabled_command_hook
);
6864 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
6870 final
= Findirect_function (cmd
);
6872 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
6873 do_autoload (final
, cmd
);
6878 if (STRINGP (final
) || VECTORP (final
))
6880 /* If requested, place the macro in the command history. For
6881 other sorts of commands, call-interactively takes care of
6883 if (!NILP (record_flag
))
6885 = Fcons (Fcons (Qexecute_kbd_macro
,
6886 Fcons (final
, Fcons (prefixarg
, Qnil
))),
6889 return Fexecute_kbd_macro (final
, prefixarg
);
6891 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
6893 backtrace
.next
= backtrace_list
;
6894 backtrace_list
= &backtrace
;
6895 backtrace
.function
= &Qcall_interactively
;
6896 backtrace
.args
= &cmd
;
6897 backtrace
.nargs
= 1;
6898 backtrace
.evalargs
= 0;
6900 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
6902 backtrace_list
= backtrace
.next
;
6908 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
6910 "Read function name, then read its arguments and call it.")
6912 Lisp_Object prefixarg
;
6914 Lisp_Object function
;
6916 Lisp_Object saved_keys
;
6917 struct gcpro gcpro1
;
6919 saved_keys
= Fvector (this_command_key_count
,
6920 XVECTOR (this_command_keys
)->contents
);
6922 GCPRO1 (saved_keys
);
6924 if (EQ (prefixarg
, Qminus
))
6926 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
6927 strcpy (buf
, "C-u ");
6928 else if (CONSP (prefixarg
) && INTEGERP (XCONS (prefixarg
)->car
))
6930 if (sizeof (int) == sizeof (EMACS_INT
))
6931 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
6932 else if (sizeof (long) == sizeof (EMACS_INT
))
6933 sprintf (buf
, "%ld ", XINT (XCONS (prefixarg
)->car
));
6937 else if (INTEGERP (prefixarg
))
6939 if (sizeof (int) == sizeof (EMACS_INT
))
6940 sprintf (buf
, "%d ", XINT (prefixarg
));
6941 else if (sizeof (long) == sizeof (EMACS_INT
))
6942 sprintf (buf
, "%ld ", XINT (prefixarg
));
6947 /* This isn't strictly correct if execute-extended-command
6948 is bound to anything else. Perhaps it should use
6949 this_command_keys? */
6950 strcat (buf
, "M-x ");
6952 /* Prompt with buf, and then read a string, completing from and
6953 restricting to the set of all defined commands. Don't provide
6954 any initial input. Save the command read on the extended-command
6956 function
= Fcompleting_read (build_string (buf
),
6957 Vobarray
, Qcommandp
,
6958 Qt
, Qnil
, Qextended_command_history
);
6960 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
6961 error ("No command name given");
6963 /* Set this_command_keys to the concatenation of saved_keys and
6964 function, followed by a RET. */
6966 struct Lisp_String
*str
;
6971 this_command_key_count
= 0;
6972 this_single_command_key_start
= 0;
6974 keys
= XVECTOR (saved_keys
)->contents
;
6975 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
6976 add_command_key (keys
[i
]);
6978 str
= XSTRING (function
);
6979 for (i
= 0; i
< str
->size
; i
++)
6981 XSETFASTINT (tem
, str
->data
[i
]);
6982 add_command_key (tem
);
6985 XSETFASTINT (tem
, '\015');
6986 add_command_key (tem
);
6991 function
= Fintern (function
, Qnil
);
6992 current_kboard
->Vprefix_arg
= prefixarg
;
6993 this_command
= function
;
6995 /* If enabled, show which key runs this command. */
6996 if (!NILP (Vsuggest_key_bindings
)
6997 && NILP (Vexecuting_macro
)
6998 && SYMBOLP (function
))
7000 Lisp_Object bindings
;
7002 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
7005 if (!NILP (bindings
))
7007 message ("You can run the command `%s' by typing %s",
7008 XSYMBOL (function
)->name
->data
,
7009 XSTRING (Fkey_description (bindings
))->data
);
7010 Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7011 ? Vsuggest_key_bindings
: make_number (2)),
7016 return Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
7019 /* Find the set of keymaps now active.
7020 Store into *MAPS_P a vector holding the various maps
7021 and return the number of them. The vector was malloc'd
7022 and the caller should free it. */
7025 current_active_maps (maps_p
)
7026 Lisp_Object
**maps_p
;
7028 Lisp_Object
*tmaps
, *maps
;
7031 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7032 if (!NILP (Voverriding_local_map_menu_flag
))
7034 /* Yes, use them (if non-nil) as well as the global map. */
7035 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
7037 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7038 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7039 if (!NILP (Voverriding_local_map
))
7040 maps
[nmaps
++] = Voverriding_local_map
;
7044 /* No, so use major and minor mode keymaps. */
7045 nmaps
= current_minor_maps (NULL
, &tmaps
);
7046 maps
= (Lisp_Object
*) xmalloc ((nmaps
+ 2) * sizeof (maps
[0]));
7047 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
7048 #ifdef USE_TEXT_PROPERTIES
7049 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
7051 maps
[nmaps
++] = current_buffer
->keymap
;
7054 maps
[nmaps
++] = current_global_map
;
7060 /* Return nonzero if input events are pending. */
7062 detect_input_pending ()
7065 get_input_pending (&input_pending
, 0);
7067 return input_pending
;
7070 /* Return nonzero if input events are pending.
7071 Execute timers immediately; don't make events for them. */
7073 detect_input_pending_run_timers (do_display
)
7076 int old_timers_run
= timers_run
;
7079 get_input_pending (&input_pending
, 1);
7081 if (old_timers_run
!= timers_run
&& do_display
)
7082 redisplay_preserve_echo_area ();
7084 return input_pending
;
7087 /* This is called in some cases before a possible quit.
7088 It cases the next call to detect_input_pending to recompute input_pending.
7089 So calling this function unnecessarily can't do any harm. */
7090 clear_input_pending ()
7095 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
7096 "T if command input is currently available with no waiting.\n\
7097 Actually, the value is nil only if we can be sure that no input is available.")
7100 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
7103 get_input_pending (&input_pending
, 1);
7104 return input_pending
> 0 ? Qt
: Qnil
;
7107 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
7108 "Return vector of last 100 events, not counting those from keyboard macros.")
7111 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
7114 if (total_keys
< NUM_RECENT_KEYS
)
7115 return Fvector (total_keys
, keys
);
7118 val
= Fvector (NUM_RECENT_KEYS
, keys
);
7119 bcopy (keys
+ recent_keys_index
,
7120 XVECTOR (val
)->contents
,
7121 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
7123 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
7124 recent_keys_index
* sizeof (Lisp_Object
));
7129 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
7130 "Return the key sequence that invoked this command.\n\
7131 The value is a string or a vector.")
7134 return make_event_array (this_command_key_count
,
7135 XVECTOR (this_command_keys
)->contents
);
7138 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
7139 Sthis_single_command_keys
, 0, 0, 0,
7140 "Return the key sequence that invoked this command.\n\
7141 Unlike `this-command-keys', this function's value\n\
7142 does not include prefix arguments.\n\
7143 The value is a string or a vector.")
7146 return make_event_array (this_command_key_count
7147 - this_single_command_key_start
,
7148 (XVECTOR (this_command_keys
)->contents
7149 + this_single_command_key_start
));
7152 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
7153 Sreset_this_command_lengths
, 0, 0, 0,
7154 "Used for complicated reasons in `universal-argument-other-key'.\n\
7156 `universal-argument-other-key' rereads the event just typed.\n\
7157 It then gets translated through `function-key-map'.\n\
7158 The translated event gets included in the echo area and in\n\
7159 the value of `this-command-keys' in addition to the raw original event.\n\
7160 That is not right.\n\
7162 Calling this function directs the translated event to replace\n\
7163 the original event, so that only one version of the event actually\n\
7164 appears in the echo area and in the value of `this-command-keys.'.")
7167 before_command_restore_flag
= 1;
7168 before_command_key_count_1
= before_command_key_count
;
7169 before_command_echo_length_1
= before_command_echo_length
;
7172 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
7173 "Return the current depth in recursive edits.")
7177 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
7181 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
7182 "FOpen dribble file: ",
7183 "Start writing all keyboard characters to a dribble file called FILE.\n\
7184 If FILE is nil, close any open dribble file.")
7195 file
= Fexpand_file_name (file
, Qnil
);
7196 dribble
= fopen (XSTRING (file
)->data
, "w");
7198 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
7203 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
7204 "Discard the contents of the terminal input buffer.\n\
7205 Also cancel any kbd macro being defined.")
7208 current_kboard
->defining_kbd_macro
= Qnil
;
7209 update_mode_lines
++;
7211 Vunread_command_events
= Qnil
;
7212 unread_command_char
= -1;
7214 discard_tty_input ();
7216 /* Without the cast, GCC complains that this assignment loses the
7217 volatile qualifier of kbd_store_ptr. Is there anything wrong
7219 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
7220 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7226 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
7227 "Stop Emacs and return to superior process. You can resume later.\n\
7228 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
7229 control, run a subshell instead.\n\n\
7230 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
7231 to be read as terminal input by Emacs's parent, after suspension.\n\
7233 Before suspending, run the normal hook `suspend-hook'.\n\
7234 After resumption run the normal hook `suspend-resume-hook'.\n\
7236 Some operating systems cannot stop the Emacs process and resume it later.\n\
7237 On such systems, Emacs starts a subshell instead of suspending.")
7239 Lisp_Object stuffstring
;
7242 int count
= specpdl_ptr
- specpdl
;
7243 int old_height
, old_width
;
7245 struct gcpro gcpro1
, gcpro2
;
7246 extern init_sys_modes ();
7248 if (!NILP (stuffstring
))
7249 CHECK_STRING (stuffstring
, 0);
7251 /* Run the functions in suspend-hook. */
7252 if (!NILP (Vrun_hooks
))
7253 call1 (Vrun_hooks
, intern ("suspend-hook"));
7255 GCPRO1 (stuffstring
);
7256 get_frame_size (&old_width
, &old_height
);
7258 /* sys_suspend can get an error if it tries to fork a subshell
7259 and the system resources aren't available for that. */
7260 record_unwind_protect (init_sys_modes
, 0);
7261 stuff_buffered_input (stuffstring
);
7266 unbind_to (count
, Qnil
);
7268 /* Check if terminal/window size has changed.
7269 Note that this is not useful when we are running directly
7270 with a window system; but suspend should be disabled in that case. */
7271 get_frame_size (&width
, &height
);
7272 if (width
!= old_width
|| height
!= old_height
)
7273 change_frame_size (selected_frame
, height
, width
, 0, 0);
7275 /* Run suspend-resume-hook. */
7276 if (!NILP (Vrun_hooks
))
7277 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
7283 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
7284 Then in any case stuff anything Emacs has read ahead and not used. */
7286 stuff_buffered_input (stuffstring
)
7287 Lisp_Object stuffstring
;
7289 /* stuff_char works only in BSD, versions 4.2 and up. */
7292 register unsigned char *p
;
7294 if (STRINGP (stuffstring
))
7298 p
= XSTRING (stuffstring
)->data
;
7299 count
= XSTRING (stuffstring
)->size
;
7304 /* Anything we have read ahead, put back for the shell to read. */
7305 /* ?? What should this do when we have multiple keyboards??
7306 Should we ignore anything that was typed in at the "wrong" kboard? */
7307 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
7309 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
7310 kbd_fetch_ptr
= kbd_buffer
;
7311 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
7312 stuff_char (kbd_fetch_ptr
->code
);
7313 kbd_fetch_ptr
->kind
= no_event
;
7314 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
7320 #endif /* BSD and not BSD4_1 */
7323 set_waiting_for_input (time_to_clear
)
7324 EMACS_TIME
*time_to_clear
;
7326 input_available_clear_time
= time_to_clear
;
7328 /* Tell interrupt_signal to throw back to read_char, */
7329 waiting_for_input
= 1;
7331 /* If interrupt_signal was called before and buffered a C-g,
7332 make it run again now, to avoid timing error. */
7333 if (!NILP (Vquit_flag
))
7334 quit_throw_to_read_char ();
7337 clear_waiting_for_input ()
7339 /* Tell interrupt_signal not to throw back to read_char, */
7340 waiting_for_input
= 0;
7341 input_available_clear_time
= 0;
7344 /* This routine is called at interrupt level in response to C-G.
7345 If interrupt_input, this is the handler for SIGINT.
7346 Otherwise, it is called from kbd_buffer_store_event,
7347 in handling SIGIO or SIGTINT.
7349 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
7350 immediately throw back to read_char.
7352 Otherwise it sets the Lisp variable quit-flag not-nil.
7353 This causes eval to throw, when it gets a chance.
7354 If quit-flag is already non-nil, it stops the job right away. */
7357 interrupt_signal (signalnum
) /* If we don't have an argument, */
7358 int signalnum
; /* some compilers complain in signal calls. */
7361 /* Must preserve main program's value of errno. */
7362 int old_errno
= errno
;
7365 if (!read_socket_hook
&& NILP (Vwindow_system
))
7367 /* USG systems forget handlers when they are used;
7368 must reestablish each time */
7369 signal (SIGINT
, interrupt_signal
);
7370 signal (SIGQUIT
, interrupt_signal
);
7376 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
7381 #ifdef SIGTSTP /* Support possible in later USG versions */
7383 * On systems which can suspend the current process and return to the original
7384 * shell, this command causes the user to end up back at the shell.
7385 * The "Auto-save" and "Abort" questions are not asked until
7386 * the user elects to return to emacs, at which point he can save the current
7387 * job and either dump core or continue.
7392 if (sys_suspend () == -1)
7394 printf ("Not running as a subprocess;\n");
7395 printf ("you can continue or abort.\n");
7398 /* Perhaps should really fork an inferior shell?
7399 But that would not provide any way to get back
7400 to the original shell, ever. */
7401 printf ("No support for stopping a process on this operating system;\n");
7402 printf ("you can continue or abort.\n");
7403 #endif /* not VMS */
7404 #endif /* not SIGTSTP */
7406 /* We must remain inside the screen area when the internal terminal
7407 is used. Note that [Enter] is not echoed by dos. */
7410 /* It doesn't work to autosave while GC is in progress;
7411 the code used for auto-saving doesn't cope with the mark bit. */
7412 if (!gc_in_progress
)
7414 printf ("Auto-save? (y or n) ");
7416 if (((c
= getchar ()) & ~040) == 'Y')
7418 Fdo_auto_save (Qt
, Qnil
);
7420 printf ("\r\nAuto-save done");
7421 #else /* not MSDOS */
7422 printf ("Auto-save done\n");
7423 #endif /* not MSDOS */
7425 while (c
!= '\n') c
= getchar ();
7429 /* During GC, it must be safe to reenable quitting again. */
7430 Vinhibit_quit
= Qnil
;
7433 #endif /* not MSDOS */
7434 printf ("Garbage collection in progress; cannot auto-save now\r\n");
7435 printf ("but will instead do a real quit after garbage collection ends\r\n");
7440 printf ("\r\nAbort? (y or n) ");
7441 #else /* not MSDOS */
7443 printf ("Abort (and enter debugger)? (y or n) ");
7445 printf ("Abort (and dump core)? (y or n) ");
7446 #endif /* not VMS */
7447 #endif /* not MSDOS */
7449 if (((c
= getchar ()) & ~040) == 'Y')
7451 while (c
!= '\n') c
= getchar ();
7453 printf ("\r\nContinuing...\r\n");
7454 #else /* not MSDOS */
7455 printf ("Continuing...\n");
7456 #endif /* not MSDOS */
7462 /* If executing a function that wants to be interrupted out of
7463 and the user has not deferred quitting by binding `inhibit-quit'
7464 then quit right away. */
7465 if (immediate_quit
&& NILP (Vinhibit_quit
))
7469 Fsignal (Qquit
, Qnil
);
7472 /* Else request quit when it's safe */
7476 if (waiting_for_input
&& !echoing
)
7477 quit_throw_to_read_char ();
7482 /* Handle a C-g by making read_char return C-g. */
7484 quit_throw_to_read_char ()
7486 quit_error_check ();
7488 /* Prevent another signal from doing this before we finish. */
7489 clear_waiting_for_input ();
7492 Vunread_command_events
= Qnil
;
7493 unread_command_char
= -1;
7495 #if 0 /* Currently, sit_for is called from read_char without turning
7496 off polling. And that can call set_waiting_for_input.
7497 It seems to be harmless. */
7498 #ifdef POLL_FOR_INPUT
7499 /* May be > 1 if in recursive minibuffer. */
7500 if (poll_suppress_count
== 0)
7505 if (FRAMEP (internal_last_event_frame
)
7506 && XFRAME (internal_last_event_frame
) != selected_frame
)
7507 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
7511 _longjmp (getcjmp
, 1);
7514 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
7515 "Set mode of reading keyboard input.\n\
7516 First arg INTERRUPT non-nil means use input interrupts;\n\
7517 nil means use CBREAK mode.\n\
7518 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
7519 (no effect except in CBREAK mode).\n\
7520 Third arg META t means accept 8-bit input (for a Meta key).\n\
7521 META nil means ignore the top bit, on the assumption it is parity.\n\
7522 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
7523 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
7524 See also `current-input-mode'.")
7525 (interrupt
, flow
, meta
, quit
)
7526 Lisp_Object interrupt
, flow
, meta
, quit
;
7529 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
7530 error ("set-input-mode: QUIT must be an ASCII character");
7532 #ifdef POLL_FOR_INPUT
7537 /* this causes startup screen to be restored and messes with the mouse */
7542 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7543 if (read_socket_hook
)
7545 /* When using X, don't give the user a real choice,
7546 because we haven't implemented the mechanisms to support it. */
7547 #ifdef NO_SOCK_SIGIO
7548 interrupt_input
= 0;
7549 #else /* not NO_SOCK_SIGIO */
7550 interrupt_input
= 1;
7551 #endif /* NO_SOCK_SIGIO */
7554 interrupt_input
= !NILP (interrupt
);
7555 #else /* not SIGIO */
7556 interrupt_input
= 0;
7557 #endif /* not SIGIO */
7559 /* Our VMS input only works by interrupts, as of now. */
7561 interrupt_input
= 1;
7564 flow_control
= !NILP (flow
);
7567 else if (EQ (meta
, Qt
))
7572 /* Don't let this value be out of range. */
7573 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
7579 #ifdef POLL_FOR_INPUT
7580 poll_suppress_count
= 1;
7586 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
7587 "Return information about the way Emacs currently reads keyboard input.\n\
7588 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
7589 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
7590 nil, Emacs is using CBREAK mode.\n\
7591 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
7592 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
7593 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
7594 META nil means ignoring the top bit, on the assumption it is parity.\n\
7595 META is neither t nor nil if accepting 8-bit input and using\n\
7596 all 8 bits as the character code.\n\
7597 QUIT is the character Emacs currently uses to quit.\n\
7598 The elements of this list correspond to the arguments of\n\
7604 val
[0] = interrupt_input
? Qt
: Qnil
;
7605 val
[1] = flow_control
? Qt
: Qnil
;
7606 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
7607 XSETFASTINT (val
[3], quit_char
);
7609 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
7614 * Set up a new kboard object with reasonable initial values.
7620 kb
->Voverriding_terminal_local_map
= Qnil
;
7621 kb
->Vlast_command
= Qnil
;
7622 kb
->Vprefix_arg
= Qnil
;
7623 kb
->kbd_queue
= Qnil
;
7624 kb
->kbd_queue_has_data
= 0;
7625 kb
->immediate_echo
= 0;
7626 kb
->echoptr
= kb
->echobuf
;
7627 kb
->echo_after_prompt
= -1;
7628 kb
->kbd_macro_buffer
= 0;
7629 kb
->kbd_macro_bufsize
= 0;
7630 kb
->defining_kbd_macro
= Qnil
;
7631 kb
->Vlast_kbd_macro
= Qnil
;
7632 kb
->reference_count
= 0;
7633 kb
->Vsystem_key_alist
= Qnil
;
7634 kb
->system_key_syms
= Qnil
;
7635 kb
->Vdefault_minibuffer_frame
= Qnil
;
7639 * Destroy the contents of a kboard object, but not the object itself.
7640 * We use this just before deleting it, or if we're going to initialize
7647 if (kb
->kbd_macro_buffer
)
7648 xfree (kb
->kbd_macro_buffer
);
7657 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
7660 *kbp
= kb
->next_kboard
;
7668 /* This is correct before outermost invocation of the editor loop */
7669 command_loop_level
= -1;
7671 quit_char
= Ctl ('g');
7672 Vunread_command_events
= Qnil
;
7673 unread_command_char
= -1;
7674 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
7676 recent_keys_index
= 0;
7677 kbd_fetch_ptr
= kbd_buffer
;
7678 kbd_store_ptr
= kbd_buffer
;
7679 kbd_buffer_frame_or_window
7680 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7682 do_mouse_tracking
= Qnil
;
7687 /* This means that command_loop_1 won't try to select anything the first
7689 internal_last_event_frame
= Qnil
;
7690 Vlast_event_frame
= internal_last_event_frame
;
7694 current_kboard
= initial_kboard
;
7696 wipe_kboard (current_kboard
);
7697 init_kboard (current_kboard
);
7700 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7702 kbd_buffer_frame_or_window
7703 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7704 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
7706 signal (SIGINT
, interrupt_signal
);
7707 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
7708 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
7709 SIGQUIT and we can't tell which one it will give us. */
7710 signal (SIGQUIT
, interrupt_signal
);
7711 #endif /* HAVE_TERMIO */
7713 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7715 if (!noninteractive
)
7716 signal (SIGIO
, input_available_signal
);
7719 /* Use interrupt input by default, if it works and noninterrupt input
7720 has deficiencies. */
7722 #ifdef INTERRUPT_INPUT
7723 interrupt_input
= 1;
7725 interrupt_input
= 0;
7728 /* Our VMS input only works by interrupts, as of now. */
7730 interrupt_input
= 1;
7736 if (keyboard_init_hook
)
7737 (*keyboard_init_hook
) ();
7739 #ifdef POLL_FOR_INPUT
7740 poll_suppress_count
= 1;
7745 /* This type's only use is in syms_of_keyboard, to initialize the
7746 event header symbols and put properties on them. */
7753 struct event_head head_table
[] = {
7754 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
7755 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
7756 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
7757 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
7758 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
7759 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
7764 Qdisabled_command_hook
= intern ("disabled-command-hook");
7765 staticpro (&Qdisabled_command_hook
);
7767 Qself_insert_command
= intern ("self-insert-command");
7768 staticpro (&Qself_insert_command
);
7770 Qforward_char
= intern ("forward-char");
7771 staticpro (&Qforward_char
);
7773 Qbackward_char
= intern ("backward-char");
7774 staticpro (&Qbackward_char
);
7776 Qdisabled
= intern ("disabled");
7777 staticpro (&Qdisabled
);
7779 Qundefined
= intern ("undefined");
7780 staticpro (&Qundefined
);
7782 Qpre_command_hook
= intern ("pre-command-hook");
7783 staticpro (&Qpre_command_hook
);
7785 Qpost_command_hook
= intern ("post-command-hook");
7786 staticpro (&Qpost_command_hook
);
7788 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
7789 staticpro (&Qpost_command_idle_hook
);
7791 Qdeferred_action_function
= intern ("deferred-action-function");
7792 staticpro (&Qdeferred_action_function
);
7794 Qcommand_hook_internal
= intern ("command-hook-internal");
7795 staticpro (&Qcommand_hook_internal
);
7797 Qfunction_key
= intern ("function-key");
7798 staticpro (&Qfunction_key
);
7799 Qmouse_click
= intern ("mouse-click");
7800 staticpro (&Qmouse_click
);
7801 Qtimer_event
= intern ("timer-event");
7802 staticpro (&Qtimer_event
);
7804 Qmenu_enable
= intern ("menu-enable");
7805 staticpro (&Qmenu_enable
);
7807 Qmode_line
= intern ("mode-line");
7808 staticpro (&Qmode_line
);
7809 Qvertical_line
= intern ("vertical-line");
7810 staticpro (&Qvertical_line
);
7811 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
7812 staticpro (&Qvertical_scroll_bar
);
7813 Qmenu_bar
= intern ("menu-bar");
7814 staticpro (&Qmenu_bar
);
7816 Qabove_handle
= intern ("above-handle");
7817 staticpro (&Qabove_handle
);
7818 Qhandle
= intern ("handle");
7819 staticpro (&Qhandle
);
7820 Qbelow_handle
= intern ("below-handle");
7821 staticpro (&Qbelow_handle
);
7822 Qup
= intern ("up");
7824 Qdown
= intern ("down");
7827 Qevent_kind
= intern ("event-kind");
7828 staticpro (&Qevent_kind
);
7829 Qevent_symbol_elements
= intern ("event-symbol-elements");
7830 staticpro (&Qevent_symbol_elements
);
7831 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
7832 staticpro (&Qevent_symbol_element_mask
);
7833 Qmodifier_cache
= intern ("modifier-cache");
7834 staticpro (&Qmodifier_cache
);
7836 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
7837 staticpro (&Qrecompute_lucid_menubar
);
7838 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
7839 staticpro (&Qactivate_menubar_hook
);
7841 Qpolling_period
= intern ("polling-period");
7842 staticpro (&Qpolling_period
);
7845 struct event_head
*p
;
7847 for (p
= head_table
;
7848 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
7851 *p
->var
= intern (p
->name
);
7853 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
7854 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
7858 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
7859 staticpro (&button_down_location
);
7863 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
7865 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
7866 for (i
= 0; i
< len
; i
++)
7867 if (modifier_names
[i
])
7868 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
7869 staticpro (&modifier_symbols
);
7872 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
7873 staticpro (&recent_keys
);
7875 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
7876 staticpro (&this_command_keys
);
7878 Qextended_command_history
= intern ("extended-command-history");
7879 Fset (Qextended_command_history
, Qnil
);
7880 staticpro (&Qextended_command_history
);
7882 kbd_buffer_frame_or_window
7883 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7884 staticpro (&kbd_buffer_frame_or_window
);
7886 accent_key_syms
= Qnil
;
7887 staticpro (&accent_key_syms
);
7889 func_key_syms
= Qnil
;
7890 staticpro (&func_key_syms
);
7893 staticpro (&mouse_syms
);
7895 unread_switch_frame
= Qnil
;
7896 staticpro (&unread_switch_frame
);
7898 defsubr (&Sevent_convert_list
);
7899 defsubr (&Sread_key_sequence
);
7900 defsubr (&Srecursive_edit
);
7902 defsubr (&Strack_mouse
);
7904 defsubr (&Sinput_pending_p
);
7905 defsubr (&Scommand_execute
);
7906 defsubr (&Srecent_keys
);
7907 defsubr (&Sthis_command_keys
);
7908 defsubr (&Sthis_single_command_keys
);
7909 defsubr (&Sreset_this_command_lengths
);
7910 defsubr (&Ssuspend_emacs
);
7911 defsubr (&Sabort_recursive_edit
);
7912 defsubr (&Sexit_recursive_edit
);
7913 defsubr (&Srecursion_depth
);
7914 defsubr (&Stop_level
);
7915 defsubr (&Sdiscard_input
);
7916 defsubr (&Sopen_dribble_file
);
7917 defsubr (&Sset_input_mode
);
7918 defsubr (&Scurrent_input_mode
);
7919 defsubr (&Sexecute_extended_command
);
7921 DEFVAR_LISP ("last-command-char", &last_command_char
,
7922 "Last input event that was part of a command.");
7924 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
7925 "Last input event that was part of a command.");
7927 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
7928 "Last input event in a command, except for mouse menu events.\n\
7929 Mouse menus give back keys that don't look like mouse events;\n\
7930 this variable holds the actual mouse event that led to the menu,\n\
7931 so that you can determine whether the command was run by mouse or not.");
7933 DEFVAR_LISP ("last-input-char", &last_input_char
,
7934 "Last input event.");
7936 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
7937 "Last input event.");
7939 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
7940 "List of objects to be read as next command input events.");
7942 DEFVAR_INT ("unread-command-char", &unread_command_char
,
7943 "If not -1, an object to be read as next command input event.");
7945 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
7946 "Meta-prefix character code. Meta-foo as command input\n\
7947 turns into this character followed by foo.");
7948 XSETINT (meta_prefix_char
, 033);
7950 DEFVAR_KBOARD ("last-command", Vlast_command
,
7951 "The last command executed. Normally a symbol with a function definition,\n\
7952 but can be whatever was found in the keymap, or whatever the variable\n\
7953 `this-command' was set to by that command.\n\
7955 The value `mode-exit' is special; it means that the previous command\n\
7956 read an event that told it to exit, and it did so and unread that event.\n\
7957 In other words, the present command is the event that made the previous\n\
7960 The value `kill-region' is special; it means that the previous command\n\
7961 was a kill command.");
7963 DEFVAR_LISP ("this-command", &this_command
,
7964 "The command now being executed.\n\
7965 The command can set this variable; whatever is put here\n\
7966 will be in `last-command' during the following command.");
7967 this_command
= Qnil
;
7969 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
7970 "*Number of keyboard input characters between auto-saves.\n\
7971 Zero means disable autosaving due to number of characters typed.");
7972 auto_save_interval
= 300;
7974 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
7975 "*Number of seconds idle time before auto-save.\n\
7976 Zero or nil means disable auto-saving due to idleness.\n\
7977 After auto-saving due to this many seconds of idle time,\n\
7978 Emacs also does a garbage collection if that seems to be warranted.");
7979 XSETFASTINT (Vauto_save_timeout
, 30);
7981 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
7982 "*Nonzero means echo unfinished commands after this many seconds of pause.");
7983 echo_keystrokes
= 1;
7985 DEFVAR_INT ("polling-period", &polling_period
,
7986 "*Interval between polling for input during Lisp execution.\n\
7987 The reason for polling is to make C-g work to stop a running program.\n\
7988 Polling is needed only when using X windows and SIGIO does not work.\n\
7989 Polling is automatically disabled in all other cases.");
7992 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
7993 "*Maximum time between mouse clicks to make a double-click.\n\
7994 Measured in milliseconds. nil means disable double-click recognition;\n\
7995 t means double-clicks have no time limit and are detected\n\
7996 by position only.");
7997 Vdouble_click_time
= make_number (500);
7999 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
8000 "*Non-nil means inhibit local map menu bar menus.");
8001 inhibit_local_menu_bar_menus
= 0;
8003 DEFVAR_INT ("num-input-keys", &num_input_keys
,
8004 "Number of complete keys read from the keyboard so far.");
8007 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
8008 "The frame in which the most recently read event occurred.\n\
8009 If the last event came from a keyboard macro, this is set to `macro'.");
8010 Vlast_event_frame
= Qnil
;
8012 DEFVAR_LISP ("help-char", &Vhelp_char
,
8013 "Character to recognize as meaning Help.\n\
8014 When it is read, do `(eval help-form)', and display result if it's a string.\n\
8015 If the value of `help-form' is nil, this char can be read normally.");
8016 XSETINT (Vhelp_char
, Ctl ('H'));
8018 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
8019 "List of input events to recognize as meaning Help.\n\
8020 These work just like the value of `help-char' (see that).");
8021 Vhelp_event_list
= Qnil
;
8023 DEFVAR_LISP ("help-form", &Vhelp_form
,
8024 "Form to execute when character `help-char' is read.\n\
8025 If the form returns a string, that string is displayed.\n\
8026 If `help-form' is nil, the help char is not recognized.");
8029 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
8030 "Command to run when `help-char' character follows a prefix key.\n\
8031 This command is used only when there is no actual binding\n\
8032 for that character after that prefix key.");
8033 Vprefix_help_command
= Qnil
;
8035 DEFVAR_LISP ("top-level", &Vtop_level
,
8036 "Form to evaluate when Emacs starts up.\n\
8037 Useful to set before you dump a modified Emacs.");
8040 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
8041 "Translate table for keyboard input, or nil.\n\
8042 Each character is looked up in this string and the contents used instead.\n\
8043 The value may be a string, a vector, or a char-table.\n\
8044 If it is a string or vector of length N,\n\
8045 character codes N and up are untranslated.\n\
8046 In a vector or a char-table, an element which is nil means \"no translation\".");
8047 Vkeyboard_translate_table
= Qnil
;
8049 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
8050 "Non-nil means to always spawn a subshell instead of suspending,\n\
8051 even if the operating system has support for stopping a process.");
8054 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
8055 "Non-nil means prompt with menus when appropriate.\n\
8056 This is done when reading from a keymap that has a prompt string,\n\
8057 for elements that have prompt strings.\n\
8058 The menu is displayed on the screen\n\
8059 if X menus were enabled at configuration\n\
8060 time and the previous event was a mouse click prefix key.\n\
8061 Otherwise, menu prompting uses the echo area.");
8064 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
8065 "Character to see next line of menu prompt.\n\
8066 Type this character while in a menu prompt to rotate around the lines of it.");
8067 XSETINT (menu_prompt_more_char
, ' ');
8069 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
8070 "A mask of additional modifier keys to use with every keyboard character.\n\
8071 Emacs applies the modifiers of the character stored here to each keyboard\n\
8072 character it reads. For example, after evaluating the expression\n\
8073 (setq extra-keyboard-modifiers ?\\C-x)\n\
8074 all input characters will have the control modifier applied to them.\n\
8076 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
8077 not count as a control character; rather, it counts as a character\n\
8078 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
8079 cancels any modification.");
8080 extra_keyboard_modifiers
= 0;
8082 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
8083 "If an editing command sets this to t, deactivate the mark afterward.\n\
8084 The command loop sets this to nil before each command,\n\
8085 and tests the value when the command returns.\n\
8086 Buffer modification stores t in this variable.");
8087 Vdeactivate_mark
= Qnil
;
8089 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
8090 "Temporary storage of pre-command-hook or post-command-hook.");
8091 Vcommand_hook_internal
= Qnil
;
8093 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
8094 "Normal hook run before each command is executed.\n\
8095 Errors running the hook are caught and ignored.");
8096 Vpre_command_hook
= Qnil
;
8098 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
8099 "Normal hook run after each command is executed.\n\
8100 Errors running the hook are caught and ignored.");
8101 Vpost_command_hook
= Qnil
;
8103 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
8104 "Normal hook run after each command is executed, if idle.\n\
8105 Errors running the hook are caught and ignored.\n\
8106 This feature is obsolete; use idle timers instead. See `etc/NEWS'.");
8107 Vpost_command_idle_hook
= Qnil
;
8109 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
8110 "Delay time before running `post-command-idle-hook'.\n\
8111 This is measured in microseconds.");
8112 post_command_idle_delay
= 100000;
8114 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
8115 "t means menu bar, specified Lucid style, needs to be recomputed.");
8116 Vlucid_menu_bar_dirty_flag
= Qnil
;
8118 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
8119 "List of menu bar items to move to the end of the menu bar.\n\
8120 The elements of the list are event types that may have menu bar bindings.");
8121 Vmenu_bar_final_items
= Qnil
;
8123 DEFVAR_KBOARD ("overriding-terminal-local-map",
8124 Voverriding_terminal_local_map
,
8125 "Keymap that overrides all other local keymaps.\n\
8126 If this variable is non-nil, it is used as a keymap instead of the\n\
8127 buffer's local map, and the minor mode keymaps and text property keymaps.");
8129 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
8130 "Keymap that overrides all other local keymaps.\n\
8131 If this variable is non-nil, it is used as a keymap instead of the\n\
8132 buffer's local map, and the minor mode keymaps and text property keymaps.");
8133 Voverriding_local_map
= Qnil
;
8135 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
8136 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
8137 Otherwise, the menu bar continues to reflect the buffer's local map\n\
8138 and the minor mode maps regardless of `overriding-local-map'.");
8139 Voverriding_local_map_menu_flag
= Qnil
;
8141 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
8142 "Keymap defining bindings for special events to execute at low level.");
8143 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
8145 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
8146 "*Non-nil means generate motion events for mouse motion.");
8148 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
8149 "Alist of system-specific X windows key symbols.\n\
8150 Each element should have the form (N . SYMBOL) where N is the\n\
8151 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
8152 and SYMBOL is its name.");
8154 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
8155 "List of deferred actions to be performed at a later time.\n\
8156 The precise format isn't relevant here; we just check whether it is nil.");
8157 Vdeferred_action_list
= Qnil
;
8159 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
8160 "Function to call to handle deferred actions, after each command.\n\
8161 This function is called with no arguments after each command\n\
8162 whenever `deferred-action-list' is non-nil.");
8163 Vdeferred_action_function
= Qnil
;
8165 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
8166 "Non-nil means show the equivalent key-binding when M-x command has one.\n\
8167 The value can be a length of time to show the message for.\n\
8168 If the value is non-nil and not a number, we wait 2 seconds.");
8169 Vsuggest_key_bindings
= Qt
;
8171 DEFVAR_LISP ("column-number-mode", &Vcolumn_number_mode
,
8172 "Non-nil enables display of the current column number in the mode line.");
8173 Vcolumn_number_mode
= Qnil
;
8175 DEFVAR_LISP ("timer-list", &Vtimer_list
,
8176 "List of active absolute time timers in order of increasing time");
8179 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
8180 "List of active idle-time timers in order of increasing time");
8181 Vtimer_idle_list
= Qnil
;
8186 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
8187 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
8188 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
8189 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
8190 initial_define_key (meta_map
, 'x', "execute-extended-command");
8192 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
8193 "handle-delete-frame");
8194 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
8196 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",