1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95,96,97 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 /* Allow config.h to undefine symbols found here. */
29 #include "termhooks.h"
37 #include "dispextern.h"
40 #include "intervals.h"
41 #include "blockinput.h"
51 #include <sys/ioctl.h>
53 #endif /* not MSDOS */
55 #include "syssignal.h"
58 /* This is to get the definitions of the XK_ symbols. */
65 #endif /* HAVE_NTGUI */
67 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
72 /* Variables for blockinput.h: */
74 /* Non-zero if interrupt input is blocked right now. */
75 int interrupt_input_blocked
;
77 /* Nonzero means an input interrupt has arrived
78 during the current critical section. */
79 int interrupt_input_pending
;
82 /* File descriptor to use for input. */
85 #ifdef HAVE_WINDOW_SYSTEM
86 /* Make all keyboard buffers much bigger when using X windows. */
87 #define KBD_BUFFER_SIZE 4096
88 #else /* No X-windows, character input */
89 #define KBD_BUFFER_SIZE 256
90 #endif /* No X-windows */
92 /* Following definition copied from eval.c */
96 struct backtrace
*next
;
97 Lisp_Object
*function
;
98 Lisp_Object
*args
; /* Points to vector of args. */
99 int nargs
; /* length of vector. If nargs is UNEVALLED,
100 args points to slot holding list of
106 KBOARD
*initial_kboard
;
107 KBOARD
*current_kboard
;
111 KBOARD the_only_kboard
;
114 /* Non-nil disable property on a command means
115 do not execute it; call disabled-command-hook's value instead. */
116 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
118 #define NUM_RECENT_KEYS (100)
119 int recent_keys_index
; /* Index for storing next element into recent_keys */
120 int total_keys
; /* Total number of elements stored into recent_keys */
121 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
123 /* Vector holding the key sequence that invoked the current command.
124 It is reused for each command, and it may be longer than the current
125 sequence; this_command_key_count indicates how many elements
126 actually mean something.
127 It's easier to staticpro a single Lisp_Object than an array. */
128 Lisp_Object this_command_keys
;
129 int this_command_key_count
;
131 /* This vector is used as a buffer to record the events that were actually read
132 by read_key_sequence. */
133 Lisp_Object raw_keybuf
;
134 int raw_keybuf_count
;
136 #define GROW_RAW_KEYBUF \
137 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
139 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
141 new = Fmake_vector (make_number (newsize), Qnil); \
142 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
143 raw_keybuf_count * sizeof (Lisp_Object)); \
147 /* Number of elements of this_command_keys
148 that precede this key sequence. */
149 int this_single_command_key_start
;
151 /* Record values of this_command_key_count and echo_length ()
152 before this command was read. */
153 static int before_command_key_count
;
154 static int before_command_echo_length
;
155 /* Values of before_command_key_count and before_command_echo_length
156 saved by reset-this-command-lengths. */
157 static int before_command_key_count_1
;
158 static int before_command_echo_length_1
;
159 /* Flag set by reset-this-command-lengths,
160 saying to reset the lengths when add_command_key is called. */
161 static int before_command_restore_flag
;
163 extern int minbuf_level
;
165 extern int message_enable_multibyte
;
167 extern struct backtrace
*backtrace_list
;
169 /* Nonzero means do menu prompting. */
170 static int menu_prompting
;
172 /* Character to see next line of menu prompt. */
173 static Lisp_Object menu_prompt_more_char
;
175 /* For longjmp to where kbd input is being done. */
176 static jmp_buf getcjmp
;
178 /* True while doing kbd input. */
179 int waiting_for_input
;
181 /* True while displaying for echoing. Delays C-g throwing. */
184 /* True means we can start echoing at the next input pause
185 even though there is something in the echo area. */
186 static char *ok_to_echo_at_next_pause
;
188 /* Nonzero means disregard local maps for the menu bar. */
189 static int inhibit_local_menu_bar_menus
;
191 /* Nonzero means C-g should cause immediate error-signal. */
194 /* The user's ERASE setting. */
195 Lisp_Object Vtty_erase_char
;
197 /* Character to recognize as the help char. */
198 Lisp_Object Vhelp_char
;
200 /* List of other event types to recognize as meaning "help". */
201 Lisp_Object Vhelp_event_list
;
203 /* Form to execute when help char is typed. */
204 Lisp_Object Vhelp_form
;
206 /* Command to run when the help character follows a prefix key. */
207 Lisp_Object Vprefix_help_command
;
209 /* List of items that should move to the end of the menu bar. */
210 Lisp_Object Vmenu_bar_final_items
;
212 /* Non-nil means show the equivalent key-binding for
213 any M-x command that has one.
214 The value can be a length of time to show the message for.
215 If the value is non-nil and not a number, we wait 2 seconds. */
216 Lisp_Object Vsuggest_key_bindings
;
218 /* Character that causes a quit. Normally C-g.
220 If we are running on an ordinary terminal, this must be an ordinary
221 ASCII char, since we want to make it our interrupt character.
223 If we are not running on an ordinary terminal, it still needs to be
224 an ordinary ASCII char. This character needs to be recognized in
225 the input interrupt handler. At this point, the keystroke is
226 represented as a struct input_event, while the desired quit
227 character is specified as a lispy event. The mapping from struct
228 input_events to lispy events cannot run in an interrupt handler,
229 and the reverse mapping is difficult for anything but ASCII
232 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
236 extern Lisp_Object current_global_map
;
237 extern int minibuf_level
;
239 /* If non-nil, this is a map that overrides all other local maps. */
240 Lisp_Object Voverriding_local_map
;
242 /* If non-nil, Voverriding_local_map applies to the menu bar. */
243 Lisp_Object Voverriding_local_map_menu_flag
;
245 /* Keymap that defines special misc events that should
246 be processed immediately at a low level. */
247 Lisp_Object Vspecial_event_map
;
249 /* Current depth in recursive edits. */
250 int command_loop_level
;
252 /* Total number of times command_loop has read a key sequence. */
255 /* Last input character read as a command. */
256 Lisp_Object last_command_char
;
258 /* Last input character read as a command, not counting menus
259 reached by the mouse. */
260 Lisp_Object last_nonmenu_event
;
262 /* Last input character read for any purpose. */
263 Lisp_Object last_input_char
;
265 /* If not Qnil, a list of objects to be read as subsequent command input. */
266 Lisp_Object Vunread_command_events
;
268 /* If not Qnil, a list of objects to be read as subsequent command input
269 including input method processing. */
270 Lisp_Object Vunread_input_method_events
;
272 /* If not Qnil, a list of objects to be read as subsequent command input
273 but NOT including input method processing. */
274 Lisp_Object Vunread_post_input_method_events
;
276 /* If not -1, an event to be read as subsequent command input. */
277 int unread_command_char
;
279 /* If not Qnil, this is a switch-frame event which we decided to put
280 off until the end of a key sequence. This should be read as the
281 next command input, after any unread_command_events.
283 read_key_sequence uses this to delay switch-frame events until the
284 end of the key sequence; Fread_char uses it to put off switch-frame
285 events until a non-ASCII event is acceptable as input. */
286 Lisp_Object unread_switch_frame
;
288 /* A mask of extra modifier bits to put into every keyboard char. */
289 int extra_keyboard_modifiers
;
291 /* Char to use as prefix when a meta character is typed in.
292 This is bound on entry to minibuffer in case ESC is changed there. */
294 Lisp_Object meta_prefix_char
;
296 /* Last size recorded for a current buffer which is not a minibuffer. */
297 static int last_non_minibuf_size
;
299 /* Number of idle seconds before an auto-save and garbage collection. */
300 static Lisp_Object Vauto_save_timeout
;
302 /* Total number of times read_char has returned. */
303 int num_input_events
;
305 /* Total number of times read_char has returned, outside of macros. */
306 int num_nonmacro_input_events
;
308 /* Auto-save automatically when this many characters have been typed
309 since the last time. */
311 static int auto_save_interval
;
313 /* Value of num_nonmacro_input_events as of last auto save. */
317 /* The command being executed by the command loop.
318 Commands may set this, and the value set will be copied into
319 current_kboard->Vlast_command instead of the actual command. */
320 Lisp_Object Vthis_command
;
322 /* This is like Vthis_command, except that commands never set it. */
323 Lisp_Object real_this_command
;
325 /* The value of point when the last command was executed. */
326 int last_point_position
;
328 /* The buffer that was current when the last command was started. */
329 Lisp_Object last_point_position_buffer
;
331 /* The frame in which the last input event occurred, or Qmacro if the
332 last event came from a macro. We use this to determine when to
333 generate switch-frame events. This may be cleared by functions
334 like Fselect_frame, to make sure that a switch-frame event is
335 generated by the next character. */
336 Lisp_Object internal_last_event_frame
;
338 /* A user-visible version of the above, intended to allow users to
339 figure out where the last event came from, if the event doesn't
340 carry that information itself (i.e. if it was a character). */
341 Lisp_Object Vlast_event_frame
;
343 /* The timestamp of the last input event we received from the X server.
344 X Windows wants this for selection ownership. */
345 unsigned long last_event_timestamp
;
347 Lisp_Object Qself_insert_command
;
348 Lisp_Object Qforward_char
;
349 Lisp_Object Qbackward_char
;
350 Lisp_Object Qundefined
;
351 Lisp_Object Qtimer_event_handler
;
353 /* read_key_sequence stores here the command definition of the
354 key sequence that it reads. */
355 Lisp_Object read_key_sequence_cmd
;
357 /* Form to evaluate (if non-nil) when Emacs is started. */
358 Lisp_Object Vtop_level
;
360 /* User-supplied string to translate input characters through. */
361 Lisp_Object Vkeyboard_translate_table
;
363 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
364 extern Lisp_Object Vfunction_key_map
;
366 /* Another keymap that maps key sequences into key sequences.
367 This one takes precedence over ordinary definitions. */
368 extern Lisp_Object Vkey_translation_map
;
370 /* If non-nil, this implements the current input method. */
371 Lisp_Object Vinput_method_function
;
372 Lisp_Object Qinput_method_function
;
374 /* When we call Vinput_method_function,
375 this holds the echo area message that was just erased. */
376 Lisp_Object Vinput_method_previous_message
;
378 /* Non-nil means deactivate the mark at end of this command. */
379 Lisp_Object Vdeactivate_mark
;
381 /* Menu bar specified in Lucid Emacs fashion. */
383 Lisp_Object Vlucid_menu_bar_dirty_flag
;
384 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
386 Lisp_Object Qecho_area_clear_hook
;
388 /* Hooks to run before and after each command. */
389 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
390 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
391 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
392 /* Hook run after a command if there's no more input soon. */
393 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
395 /* Delay time in microseconds before running post-command-idle-hook. */
396 int post_command_idle_delay
;
398 /* List of deferred actions to be performed at a later time.
399 The precise format isn't relevant here; we just check whether it is nil. */
400 Lisp_Object Vdeferred_action_list
;
402 /* Function to call to handle deferred actions, when there are any. */
403 Lisp_Object Vdeferred_action_function
;
404 Lisp_Object Qdeferred_action_function
;
406 Lisp_Object Qinput_method_exit_on_first_char
;
407 Lisp_Object Qinput_method_use_echo_area
;
409 /* File in which we write all commands we read. */
412 /* Nonzero if input is available. */
415 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
416 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
420 extern char *pending_malloc_warning
;
422 /* Circular buffer for pre-read keyboard input. */
423 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
425 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
427 The interrupt-level event handlers will never enqueue an event on a
428 frame which is not in Vframe_list, and once an event is dequeued,
429 internal_last_event_frame or the event itself points to the frame.
432 But while the event is sitting in the queue, it's completely
433 unprotected. Suppose the user types one command which will run for
434 a while and then delete a frame, and then types another event at
435 the frame that will be deleted, before the command gets around to
436 it. Suppose there are no references to this frame elsewhere in
437 Emacs, and a GC occurs before the second event is dequeued. Now we
438 have an event referring to a freed frame, which will crash Emacs
441 Similar things happen when an event on a scroll bar is enqueued; the
442 window may be deleted while the event is in the queue.
444 So, we use this vector to protect the frame_or_window field in the
445 event queue. That way, they'll be dequeued as dead frames or
446 windows, but still valid lisp objects.
448 If kbd_buffer[i].kind != no_event, then
449 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
450 == kbd_buffer[i].frame_or_window. */
451 static Lisp_Object kbd_buffer_frame_or_window
;
453 /* Pointer to next available character in kbd_buffer.
454 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
455 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
456 next available char is in kbd_buffer[0]. */
457 static struct input_event
*kbd_fetch_ptr
;
459 /* Pointer to next place to store character in kbd_buffer. This
460 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
461 character should go in kbd_buffer[0]. */
462 static volatile struct input_event
*kbd_store_ptr
;
464 /* The above pair of variables forms a "queue empty" flag. When we
465 enqueue a non-hook event, we increment kbd_store_ptr. When we
466 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
467 there is input available iff the two pointers are not equal.
469 Why not just have a flag set and cleared by the enqueuing and
470 dequeuing functions? Such a flag could be screwed up by interrupts
471 at inopportune times. */
473 /* If this flag is non-nil, we check mouse_moved to see when the
474 mouse moves, and motion events will appear in the input stream.
475 Otherwise, mouse motion is ignored. */
476 static Lisp_Object do_mouse_tracking
;
478 /* Symbols to head events. */
479 Lisp_Object Qmouse_movement
;
480 Lisp_Object Qscroll_bar_movement
;
481 Lisp_Object Qswitch_frame
;
482 Lisp_Object Qdelete_frame
;
483 Lisp_Object Qiconify_frame
;
484 Lisp_Object Qmake_frame_visible
;
486 /* Symbols to denote kinds of events. */
487 Lisp_Object Qfunction_key
;
488 Lisp_Object Qmouse_click
;
490 Lisp_Object Qmouse_wheel
;
492 Lisp_Object Qdrag_n_drop
;
493 /* Lisp_Object Qmouse_movement; - also an event header */
495 /* Properties of event headers. */
496 Lisp_Object Qevent_kind
;
497 Lisp_Object Qevent_symbol_elements
;
499 /* menu item parts */
500 Lisp_Object Qmenu_alias
;
501 Lisp_Object Qmenu_enable
;
502 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
503 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
504 extern Lisp_Object Vdefine_key_rebound_commands
;
505 extern Lisp_Object Qmenu_item
;
507 /* An event header symbol HEAD may have a property named
508 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
509 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
510 mask of modifiers applied to it. If present, this is used to help
511 speed up parse_modifiers. */
512 Lisp_Object Qevent_symbol_element_mask
;
514 /* An unmodified event header BASE may have a property named
515 Qmodifier_cache, which is an alist mapping modifier masks onto
516 modified versions of BASE. If present, this helps speed up
518 Lisp_Object Qmodifier_cache
;
520 /* Symbols to use for parts of windows. */
521 Lisp_Object Qmode_line
;
522 Lisp_Object Qvertical_line
;
523 Lisp_Object Qvertical_scroll_bar
;
524 Lisp_Object Qmenu_bar
;
526 Lisp_Object
recursive_edit_unwind (), command_loop ();
527 Lisp_Object
Fthis_command_keys ();
528 Lisp_Object Qextended_command_history
;
529 EMACS_TIME
timer_check ();
531 extern Lisp_Object Vhistory_length
;
533 extern char *x_get_keysym_name ();
535 static void record_menu_key ();
537 Lisp_Object Qpolling_period
;
539 /* List of absolute timers. Appears in order of next scheduled event. */
540 Lisp_Object Vtimer_list
;
542 /* List of idle time timers. Appears in order of next scheduled event. */
543 Lisp_Object Vtimer_idle_list
;
545 /* Incremented whenever a timer is run. */
548 extern Lisp_Object Vprint_level
, Vprint_length
;
550 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
552 EMACS_TIME
*input_available_clear_time
;
554 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
555 Default is 1 if INTERRUPT_INPUT is defined. */
558 /* Nonzero while interrupts are temporarily deferred during redisplay. */
559 int interrupts_deferred
;
561 /* Nonzero means use ^S/^Q for flow control. */
564 /* Allow m- file to inhibit use of FIONREAD. */
565 #ifdef BROKEN_FIONREAD
569 /* We are unable to use interrupts if FIONREAD is not available,
570 so flush SIGIO so we won't try. */
577 /* If we support a window system, turn on the code to poll periodically
578 to detect C-g. It isn't actually used when doing interrupt input. */
579 #ifdef HAVE_WINDOW_SYSTEM
580 #define POLL_FOR_INPUT
583 /* Global variable declarations. */
585 /* Function for init_keyboard to call with no args (if nonzero). */
586 void (*keyboard_init_hook
) ();
588 static int read_avail_input ();
589 static void get_input_pending ();
590 static int readable_events ();
591 static Lisp_Object
read_char_x_menu_prompt ();
592 static Lisp_Object
read_char_minibuf_menu_prompt ();
593 static Lisp_Object
make_lispy_event ();
595 static Lisp_Object
make_lispy_movement ();
597 static Lisp_Object
modify_event_symbol ();
598 static Lisp_Object
make_lispy_switch_frame ();
599 static int parse_solitary_modifier ();
600 static void save_getcjmp ();
601 static void restore_getcjmp ();
603 /* > 0 if we are to echo keystrokes. */
604 static int echo_keystrokes
;
606 /* Nonzero means don't try to suspend even if the operating system seems
608 static int cannot_suspend
;
610 #define min(a,b) ((a)<(b)?(a):(b))
611 #define max(a,b) ((a)>(b)?(a):(b))
613 /* Install the string STR as the beginning of the string of echoing,
614 so that it serves as a prompt for the next character.
615 Also start echoing. */
621 int len
= strlen (str
);
623 if (len
> ECHOBUFSIZE
- 4)
624 len
= ECHOBUFSIZE
- 4;
625 bcopy (str
, current_kboard
->echobuf
, len
);
626 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
627 *current_kboard
->echoptr
= '\0';
629 current_kboard
->echo_after_prompt
= len
;
634 /* Add C to the echo string, if echoing is going on.
635 C can be a character, which is printed prettily ("M-C-x" and all that
636 jazz), or a symbol, whose name is printed. */
642 extern char *push_key_description ();
644 if (current_kboard
->immediate_echo
)
646 char *ptr
= current_kboard
->echoptr
;
648 if (ptr
!= current_kboard
->echobuf
)
651 /* If someone has passed us a composite event, use its head symbol. */
656 if (ptr
- current_kboard
->echobuf
> ECHOBUFSIZE
- 6)
659 ptr
= push_key_description (XINT (c
), ptr
);
661 else if (SYMBOLP (c
))
663 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
664 if ((ptr
- current_kboard
->echobuf
) + STRING_BYTES (name
) + 4
667 bcopy (name
->data
, ptr
, STRING_BYTES (name
));
668 ptr
+= STRING_BYTES (name
);
671 if (current_kboard
->echoptr
== current_kboard
->echobuf
674 strcpy (ptr
, " (Type ? for further options)");
679 current_kboard
->echoptr
= ptr
;
685 /* Temporarily add a dash to the end of the echo string if it's not
686 empty, so that it serves as a mini-prompt for the very next character. */
691 if (!current_kboard
->immediate_echo
692 && current_kboard
->echoptr
== current_kboard
->echobuf
)
694 /* Do nothing if we just printed a prompt. */
695 if (current_kboard
->echo_after_prompt
696 == current_kboard
->echoptr
- current_kboard
->echobuf
)
698 /* Do nothing if not echoing at all. */
699 if (current_kboard
->echoptr
== 0)
702 /* Put a dash at the end of the buffer temporarily,
703 but make it go away when the next character is added. */
704 current_kboard
->echoptr
[0] = '-';
705 current_kboard
->echoptr
[1] = 0;
710 /* Display the current echo string, and begin echoing if not already
716 if (!current_kboard
->immediate_echo
)
719 current_kboard
->immediate_echo
= 1;
721 for (i
= 0; i
< this_command_key_count
; i
++)
724 c
= XVECTOR (this_command_keys
)->contents
[i
];
725 if (! (EVENT_HAS_PARAMETERS (c
)
726 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
733 message2_nolog (current_kboard
->echobuf
, strlen (current_kboard
->echobuf
),
734 ! NILP (current_buffer
->enable_multibyte_characters
));
738 if (waiting_for_input
&& !NILP (Vquit_flag
))
739 quit_throw_to_read_char ();
742 /* Turn off echoing, for the start of a new command. */
747 current_kboard
->immediate_echo
= 0;
748 current_kboard
->echoptr
= current_kboard
->echobuf
;
749 current_kboard
->echo_after_prompt
= -1;
750 ok_to_echo_at_next_pause
= 0;
753 /* Return the length of the current echo string. */
758 return current_kboard
->echoptr
- current_kboard
->echobuf
;
761 /* Truncate the current echo message to its first LEN chars.
762 This and echo_char get used by read_key_sequence when the user
763 switches frames while entering a key sequence. */
769 current_kboard
->echobuf
[len
] = '\0';
770 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
771 truncate_echo_area (len
);
775 /* Functions for manipulating this_command_keys. */
777 add_command_key (key
)
780 int size
= XVECTOR (this_command_keys
)->size
;
782 /* If reset-this-command-length was called recently, obey it now.
783 See the doc string of that function for an explanation of why. */
784 if (before_command_restore_flag
)
786 this_command_key_count
= before_command_key_count_1
;
787 if (this_command_key_count
< this_single_command_key_start
)
788 this_single_command_key_start
= this_command_key_count
;
789 echo_truncate (before_command_echo_length_1
);
790 before_command_restore_flag
= 0;
793 if (this_command_key_count
>= size
)
795 Lisp_Object new_keys
;
797 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
798 bcopy (XVECTOR (this_command_keys
)->contents
,
799 XVECTOR (new_keys
)->contents
,
800 size
* sizeof (Lisp_Object
));
802 this_command_keys
= new_keys
;
805 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
811 int count
= specpdl_ptr
- specpdl
;
814 if (command_loop_level
> 0)
816 specbind (Qstandard_output
, Qt
);
817 specbind (Qstandard_input
, Qt
);
820 val
= command_loop ();
822 Fsignal (Qquit
, Qnil
);
823 /* Handle throw from read_minibuf when using minibuffer
824 while it's active but we're in another window. */
826 Fsignal (Qerror
, Fcons (val
, Qnil
));
828 return unbind_to (count
, Qnil
);
831 /* When an auto-save happens, record the "time", and don't do again soon. */
836 last_auto_save
= num_nonmacro_input_events
;
839 /* Make an auto save happen as soon as possible at command level. */
842 force_auto_save_soon ()
844 last_auto_save
= - auto_save_interval
- 1;
846 record_asynch_buffer_change ();
849 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
850 "Invoke the editor command loop recursively.\n\
851 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
852 that tells this function to return.\n\
853 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
854 This function is called by the editor initialization to begin editing.")
857 int count
= specpdl_ptr
- specpdl
;
860 command_loop_level
++;
861 update_mode_lines
= 1;
863 record_unwind_protect (recursive_edit_unwind
,
865 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
869 return unbind_to (count
, Qnil
);
873 recursive_edit_unwind (buffer
)
877 Fset_buffer (buffer
);
879 command_loop_level
--;
880 update_mode_lines
= 1;
888 #if 0 /* Theory: if there's anything in Vunread_command_events,
889 it will right away be read by read_key_sequence,
890 and then if we do switch KBOARDS, it will go into the side
891 queue then. So we don't need to do anything special here -- rms. */
892 if (CONSP (Vunread_command_events
))
894 current_kboard
->kbd_queue
895 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
896 current_kboard
->kbd_queue_has_data
= 1;
898 Vunread_command_events
= Qnil
;
904 /* Switch to the single-kboard state, making current_kboard
905 the only KBOARD from which further input is accepted. */
908 single_kboard_state ()
915 /* Maintain a stack of kboards, so other parts of Emacs
916 can switch temporarily to the kboard of a given frame
917 and then revert to the previous status. */
922 struct kboard_stack
*next
;
925 static struct kboard_stack
*kboard_stack
;
928 push_frame_kboard (f
)
932 struct kboard_stack
*p
933 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
935 p
->next
= kboard_stack
;
936 p
->kboard
= current_kboard
;
939 current_kboard
= FRAME_KBOARD (f
);
947 struct kboard_stack
*p
= kboard_stack
;
948 current_kboard
= p
->kboard
;
949 kboard_stack
= p
->next
;
954 /* Handle errors that are not handled at inner levels
955 by printing an error message and returning to the editor command loop. */
961 Lisp_Object old_level
, old_length
;
964 if (!NILP (executing_macro
))
966 if (executing_macro_iterations
== 1)
967 sprintf (macroerror
, "After 1 kbd macro iteration: ");
969 sprintf (macroerror
, "After %d kbd macro iterations: ",
970 executing_macro_iterations
);
975 Vstandard_output
= Qt
;
976 Vstandard_input
= Qt
;
977 Vexecuting_macro
= Qnil
;
978 executing_macro
= Qnil
;
979 current_kboard
->Vprefix_arg
= Qnil
;
980 current_kboard
->Vlast_prefix_arg
= Qnil
;
983 /* Avoid unquittable loop if data contains a circular list. */
984 old_level
= Vprint_level
;
985 old_length
= Vprint_length
;
986 XSETFASTINT (Vprint_level
, 10);
987 XSETFASTINT (Vprint_length
, 10);
988 cmd_error_internal (data
, macroerror
);
989 Vprint_level
= old_level
;
990 Vprint_length
= old_length
;
994 Vinhibit_quit
= Qnil
;
999 return make_number (0);
1002 /* Take actions on handling an error. DATA is the data that describes
1005 CONTEXT is a C-string containing ASCII characters only which
1006 describes the context in which the error happened. If we need to
1007 generalize CONTEXT to allow multibyte characters, make it a Lisp
1011 cmd_error_internal (data
, context
)
1019 echo_area_glyphs
= 0;
1021 /* If the window system or terminal frame hasn't been initialized
1022 yet, or we're not interactive, it's best to dump this message out
1023 to stderr and exit. */
1024 if (! FRAME_MESSAGE_BUF (selected_frame
)
1026 stream
= Qexternal_debugging_output
;
1035 write_string_1 (context
, -1, stream
);
1037 print_error_message (data
, stream
);
1039 /* If the window system or terminal frame hasn't been initialized
1040 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1041 if (! FRAME_MESSAGE_BUF (selected_frame
)
1045 Fkill_emacs (make_number (-1));
1049 Lisp_Object
command_loop_1 ();
1050 Lisp_Object
command_loop_2 ();
1051 Lisp_Object
top_level_1 ();
1053 /* Entry to editor-command-loop.
1054 This level has the catches for exiting/returning to editor command loop.
1055 It returns nil to exit recursive edit, t to abort it. */
1060 if (command_loop_level
> 0 || minibuf_level
> 0)
1063 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1064 executing_macro
= Qnil
;
1070 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1071 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1072 executing_macro
= Qnil
;
1074 /* End of file in -batch run causes exit here. */
1080 /* Here we catch errors in execution of commands within the
1081 editing loop, and reenter the editing loop.
1082 When there is an error, cmd_error runs and returns a non-nil
1083 value to us. A value of nil means that cmd_loop_1 itself
1084 returned due to end of file (or end of kbd macro). */
1089 register Lisp_Object val
;
1092 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1093 while (!NILP (val
));
1101 return Feval (Vtop_level
);
1107 /* On entry to the outer level, run the startup file */
1108 if (!NILP (Vtop_level
))
1109 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1110 else if (!NILP (Vpurify_flag
))
1111 message ("Bare impure Emacs (standard Lisp code not loaded)");
1113 message ("Bare Emacs (standard Lisp code not loaded)");
1117 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1118 "Exit all recursive editing levels.")
1121 Fthrow (Qtop_level
, Qnil
);
1124 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1125 "Exit from the innermost recursive edit or minibuffer.")
1128 if (command_loop_level
> 0 || minibuf_level
> 0)
1129 Fthrow (Qexit
, Qnil
);
1131 error ("No recursive edit is in progress");
1134 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1135 "Abort the command that requested this recursive edit or minibuffer input.")
1138 if (command_loop_level
> 0 || minibuf_level
> 0)
1141 error ("No recursive edit is in progress");
1144 /* This is the actual command reading loop,
1145 sans error-handling encapsulation. */
1147 Lisp_Object
Fcommand_execute ();
1148 static int read_key_sequence ();
1149 void safe_run_hooks ();
1154 Lisp_Object cmd
, tem
;
1157 Lisp_Object keybuf
[30];
1162 struct buffer
*prev_buffer
;
1164 int was_locked
= single_kboard
;
1167 current_kboard
->Vprefix_arg
= Qnil
;
1168 current_kboard
->Vlast_prefix_arg
= Qnil
;
1169 Vdeactivate_mark
= Qnil
;
1170 waiting_for_input
= 0;
1175 this_command_key_count
= 0;
1176 this_single_command_key_start
= 0;
1178 /* Make sure this hook runs after commands that get errors and
1179 throw to top level. */
1180 /* Note that the value cell will never directly contain nil
1181 if the symbol is a local variable. */
1182 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1183 safe_run_hooks (Qpost_command_hook
);
1185 if (!NILP (Vdeferred_action_list
))
1186 call0 (Vdeferred_action_function
);
1188 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1190 if (NILP (Vunread_command_events
)
1191 && NILP (Vunread_input_method_events
)
1192 && NILP (Vunread_post_input_method_events
)
1193 && NILP (Vexecuting_macro
)
1194 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1195 safe_run_hooks (Qpost_command_idle_hook
);
1198 /* Do this after running Vpost_command_hook, for consistency. */
1199 current_kboard
->Vlast_command
= Vthis_command
;
1200 current_kboard
->Vreal_last_command
= real_this_command
;
1204 if (! FRAME_LIVE_P (selected_frame
))
1207 /* Make sure the current window's buffer is selected. */
1208 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1209 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1211 /* Display any malloc warning that just came out. Use while because
1212 displaying one warning can cause another. */
1214 while (pending_malloc_warning
)
1215 display_malloc_warning ();
1219 Vdeactivate_mark
= Qnil
;
1221 /* If minibuffer on and echo area in use,
1222 wait 2 sec and redraw minibuffer. */
1224 if (minibuf_level
&& echo_area_glyphs
1225 && EQ (minibuf_window
, echo_area_window
))
1227 /* Bind inhibit-quit to t so that C-g gets read in
1228 rather than quitting back to the minibuffer. */
1229 int count
= specpdl_ptr
- specpdl
;
1230 specbind (Qinhibit_quit
, Qt
);
1232 Fsit_for (make_number (2), Qnil
, Qnil
);
1233 /* Clear the echo area. */
1235 safe_run_hooks (Qecho_area_clear_hook
);
1237 unbind_to (count
, Qnil
);
1239 /* If a C-g came in before, treat it as input now. */
1240 if (!NILP (Vquit_flag
))
1243 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1248 alloca (0); /* Cause a garbage collection now */
1249 /* Since we can free the most stuff here. */
1250 #endif /* C_ALLOCA */
1253 /* Select the frame that the last event came from. Usually,
1254 switch-frame events will take care of this, but if some lisp
1255 code swallows a switch-frame event, we'll fix things up here.
1256 Is this a good idea? */
1257 if (FRAMEP (internal_last_event_frame
)
1258 && XFRAME (internal_last_event_frame
) != selected_frame
)
1259 Fselect_frame (internal_last_event_frame
, Qnil
);
1261 /* If it has changed current-menubar from previous value,
1262 really recompute the menubar from the value. */
1263 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1264 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1265 call0 (Qrecompute_lucid_menubar
);
1267 before_command_key_count
= this_command_key_count
;
1268 before_command_echo_length
= echo_length ();
1270 Vthis_command
= Qnil
;
1271 real_this_command
= Qnil
;
1273 /* Read next key sequence; i gets its length. */
1274 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1277 /* A filter may have run while we were reading the input. */
1278 if (! FRAME_LIVE_P (selected_frame
))
1280 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1281 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1285 /* Now we have read a key sequence of length I,
1286 or else I is 0 and we found end of file. */
1288 if (i
== 0) /* End of file -- happens only in */
1289 return Qnil
; /* a kbd macro, at the end. */
1290 /* -1 means read_key_sequence got a menu that was rejected.
1291 Just loop around and read another command. */
1295 this_command_key_count
= 0;
1296 this_single_command_key_start
= 0;
1300 last_command_char
= keybuf
[i
- 1];
1302 /* If the previous command tried to force a specific window-start,
1303 forget about that, in case this command moves point far away
1304 from that position. But also throw away beg_unchanged and
1305 end_unchanged information in that case, so that redisplay will
1306 update the whole window properly. */
1307 if (!NILP (XWINDOW (selected_window
)->force_start
))
1309 XWINDOW (selected_window
)->force_start
= Qnil
;
1310 beg_unchanged
= end_unchanged
= 0;
1313 cmd
= read_key_sequence_cmd
;
1314 if (!NILP (Vexecuting_macro
))
1316 if (!NILP (Vquit_flag
))
1318 Vexecuting_macro
= Qt
;
1319 QUIT
; /* Make some noise. */
1320 /* Will return since macro now empty. */
1324 /* Do redisplay processing after this command except in special
1325 cases identified below that set no_redisplay to 1.
1326 (actually, there's currently no way to prevent the redisplay,
1327 and no_redisplay is ignored.
1328 Perhaps someday we will really implement it.) */
1331 prev_buffer
= current_buffer
;
1332 prev_modiff
= MODIFF
;
1333 last_point_position
= PT
;
1334 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1336 /* Execute the command. */
1338 Vthis_command
= cmd
;
1339 real_this_command
= cmd
;
1340 /* Note that the value cell will never directly contain nil
1341 if the symbol is a local variable. */
1342 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1343 safe_run_hooks (Qpre_command_hook
);
1345 if (NILP (Vthis_command
))
1347 /* nil means key is undefined. */
1349 current_kboard
->defining_kbd_macro
= Qnil
;
1350 update_mode_lines
= 1;
1351 current_kboard
->Vprefix_arg
= Qnil
;
1355 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1357 /* In case we jump to directly_done. */
1358 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1360 /* Recognize some common commands in common situations and
1361 do them directly. */
1362 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1364 struct Lisp_Char_Table
*dp
1365 = window_display_table (XWINDOW (selected_window
));
1366 lose
= FETCH_CHAR (PT_BYTE
);
1369 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1370 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1371 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1372 && (lose
>= 0x20 && lose
< 0x7f)))
1373 : (lose
>= 0x20 && lose
< 0x7f))
1374 /* To extract the case of continuation on
1375 wide-column characters. */
1376 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1377 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1379 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1381 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1383 && !windows_or_buffers_changed
1384 && EQ (current_buffer
->selective_display
, Qnil
)
1385 && !detect_input_pending ()
1386 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1387 && NILP (Vexecuting_macro
))
1388 no_redisplay
= direct_output_forward_char (1);
1391 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1393 struct Lisp_Char_Table
*dp
1394 = window_display_table (XWINDOW (selected_window
));
1396 lose
= FETCH_CHAR (PT_BYTE
);
1398 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1399 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1400 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1401 && (lose
>= 0x20 && lose
< 0x7f)))
1402 : (lose
>= 0x20 && lose
< 0x7f))
1403 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1405 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1407 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1409 && !windows_or_buffers_changed
1410 && EQ (current_buffer
->selective_display
, Qnil
)
1411 && !detect_input_pending ()
1412 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1413 && NILP (Vexecuting_macro
))
1414 no_redisplay
= direct_output_forward_char (-1);
1417 else if (EQ (Vthis_command
, Qself_insert_command
)
1418 /* Try this optimization only on ascii keystrokes. */
1419 && INTEGERP (last_command_char
))
1421 unsigned int c
= XINT (last_command_char
);
1424 if (NILP (Vexecuting_macro
)
1425 && !EQ (minibuf_window
, selected_window
))
1427 if (!nonundocount
|| nonundocount
>= 20)
1434 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1436 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1438 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1440 || MODIFF
<= SAVE_MODIFF
1441 || windows_or_buffers_changed
1442 || !EQ (current_buffer
->selective_display
, Qnil
)
1443 || detect_input_pending ()
1444 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1445 || !NILP (Vexecuting_macro
));
1446 value
= internal_self_insert (c
, 0);
1453 && (PT
== ZV
|| FETCH_BYTE (PT_BYTE
) == '\n'))
1455 struct Lisp_Char_Table
*dp
1456 = window_display_table (XWINDOW (selected_window
));
1459 /* Add the offset to the character, for Finsert_char.
1460 We pass internal_self_insert the unmodified character
1461 because it itself does this offsetting. */
1462 if (! NILP (current_buffer
->enable_multibyte_characters
))
1463 lose
= unibyte_char_to_multibyte (lose
);
1469 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1472 /* Do it only for char codes
1473 that by default display as themselves. */
1474 if (lose
>= 0x20 && lose
<= 0x7e)
1475 no_redisplay
= direct_output_for_insert (lose
);
1477 else if (VECTORP (obj
)
1478 && XVECTOR (obj
)->size
== 1
1479 && (obj
= XVECTOR (obj
)->contents
[0],
1481 /* Insist face not specified in glyph. */
1482 && (XINT (obj
) & ((-1) << 8)) == 0)
1484 = direct_output_for_insert (XINT (obj
));
1488 if (lose
>= 0x20 && lose
<= 0x7e)
1489 no_redisplay
= direct_output_for_insert (lose
);
1496 /* Here for a command that isn't executed directly */
1499 if (NILP (current_kboard
->Vprefix_arg
))
1501 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1504 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1506 /* Note that the value cell will never directly contain nil
1507 if the symbol is a local variable. */
1508 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1509 safe_run_hooks (Qpost_command_hook
);
1511 if (!NILP (Vdeferred_action_list
))
1512 safe_run_hooks (Qdeferred_action_function
);
1514 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1516 if (NILP (Vunread_command_events
)
1517 && NILP (Vunread_input_method_events
)
1518 && NILP (Vunread_post_input_method_events
)
1519 && NILP (Vexecuting_macro
)
1520 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1521 safe_run_hooks (Qpost_command_idle_hook
);
1524 /* If there is a prefix argument,
1525 1) We don't want Vlast_command to be ``universal-argument''
1526 (that would be dumb), so don't set Vlast_command,
1527 2) we want to leave echoing on so that the prefix will be
1528 echoed as part of this key sequence, so don't call
1530 3) we want to leave this_command_key_count non-zero, so that
1531 read_char will realize that it is re-reading a character, and
1532 not echo it a second time.
1534 If the command didn't actually create a prefix arg,
1535 but is merely a frame event that is transparent to prefix args,
1536 then the above doesn't apply. */
1537 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1539 current_kboard
->Vlast_command
= Vthis_command
;
1540 current_kboard
->Vreal_last_command
= real_this_command
;
1542 this_command_key_count
= 0;
1543 this_single_command_key_start
= 0;
1546 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1548 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1550 current_buffer
->mark_active
= Qnil
;
1551 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1553 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1554 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1558 /* Install chars successfully executed in kbd macro. */
1560 if (!NILP (current_kboard
->defining_kbd_macro
)
1561 && NILP (current_kboard
->Vprefix_arg
))
1562 finalize_kbd_macro_chars ();
1566 any_kboard_state ();
1571 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1574 safe_run_hooks_1 (hook
)
1577 return call1 (Vrun_hooks
, Vinhibit_quit
);
1580 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1583 safe_run_hooks_error (data
)
1586 Fset (Vinhibit_quit
, Qnil
);
1589 /* If we get an error while running the hook, cause the hook variable
1590 to be nil. Also inhibit quits, so that C-g won't cause the hook
1591 to mysteriously evaporate. */
1594 safe_run_hooks (hook
)
1598 int count
= specpdl_ptr
- specpdl
;
1599 specbind (Qinhibit_quit
, hook
);
1601 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1603 unbind_to (count
, Qnil
);
1606 /* Number of seconds between polling for input. */
1609 /* Nonzero means polling for input is temporarily suppressed. */
1610 int poll_suppress_count
;
1612 /* Nonzero if polling_for_input is actually being used. */
1613 int polling_for_input
;
1615 #ifdef POLL_FOR_INPUT
1617 /* Handle an alarm once each second and read pending input
1618 so as to handle a C-g if it comces in. */
1621 input_poll_signal (signalnum
) /* If we don't have an argument, */
1622 int signalnum
; /* some compilers complain in signal calls. */
1624 /* This causes the call to start_polling at the end
1625 to do its job. It also arranges for a quit or error
1626 from within read_avail_input to resume polling. */
1627 poll_suppress_count
++;
1628 if (interrupt_input_blocked
== 0
1629 && !waiting_for_input
)
1630 read_avail_input (0);
1631 /* Turn on the SIGALRM handler and request another alarm. */
1637 /* Begin signals to poll for input, if they are appropriate.
1638 This function is called unconditionally from various places. */
1643 #ifdef POLL_FOR_INPUT
1644 if (read_socket_hook
&& !interrupt_input
)
1646 poll_suppress_count
--;
1647 if (poll_suppress_count
== 0)
1649 signal (SIGALRM
, input_poll_signal
);
1650 polling_for_input
= 1;
1651 alarm (polling_period
);
1657 /* Nonzero if we are using polling to handle input asynchronously. */
1660 input_polling_used ()
1662 #ifdef POLL_FOR_INPUT
1663 return read_socket_hook
&& !interrupt_input
;
1669 /* Turn off polling. */
1674 #ifdef POLL_FOR_INPUT
1675 if (read_socket_hook
&& !interrupt_input
)
1677 if (poll_suppress_count
== 0)
1679 polling_for_input
= 0;
1682 poll_suppress_count
++;
1687 /* Set the value of poll_suppress_count to COUNT
1688 and start or stop polling accordingly. */
1691 set_poll_suppress_count (count
)
1694 #ifdef POLL_FOR_INPUT
1695 if (count
== 0 && poll_suppress_count
!= 0)
1697 poll_suppress_count
= 1;
1700 else if (count
!= 0 && poll_suppress_count
== 0)
1704 poll_suppress_count
= count
;
1708 /* Bind polling_period to a value at least N.
1709 But don't decrease it. */
1712 bind_polling_period (n
)
1715 #ifdef POLL_FOR_INPUT
1716 int new = polling_period
;
1722 specbind (Qpolling_period
, make_number (new));
1723 /* Start a new alarm with the new period. */
1728 /* Apply the control modifier to CHARACTER. */
1734 /* Save the upper bits here. */
1735 int upper
= c
& ~0177;
1739 /* Everything in the columns containing the upper-case letters
1740 denotes a control character. */
1741 if (c
>= 0100 && c
< 0140)
1745 /* Set the shift modifier for a control char
1746 made from a shifted letter. But only for letters! */
1747 if (oc
>= 'A' && oc
<= 'Z')
1748 c
|= shift_modifier
;
1751 /* The lower-case letters denote control characters too. */
1752 else if (c
>= 'a' && c
<= 'z')
1755 /* Include the bits for control and shift
1756 only if the basic ASCII code can't indicate them. */
1760 /* Replace the high bits. */
1761 c
|= (upper
& ~ctrl_modifier
);
1768 /* Input of single characters from keyboard */
1770 Lisp_Object
print_help ();
1771 static Lisp_Object
kbd_buffer_get_event ();
1772 static void record_char ();
1775 static jmp_buf wrong_kboard_jmpbuf
;
1778 /* read a character from the keyboard; call the redisplay if needed */
1779 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1780 -1 means do not do redisplay, but do do autosaving.
1783 /* The arguments MAPS and NMAPS are for menu prompting.
1784 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1786 PREV_EVENT is the previous input event, or nil if we are reading
1787 the first event of a key sequence (or not reading a key sequence).
1788 If PREV_EVENT is t, that is a "magic" value that says
1789 not to run input methods, but in other respects to act as if
1790 not reading a key sequence.
1792 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
1793 if we used a mouse menu to read the input, or zero otherwise. If
1794 USED_MOUSE_MENU is null, we don't dereference it.
1796 Value is t if we showed a menu and the user rejected it. */
1799 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1803 Lisp_Object prev_event
;
1804 int *used_mouse_menu
;
1808 jmp_buf local_getcjmp
;
1810 int key_already_recorded
= 0;
1811 Lisp_Object tem
, save
;
1812 Lisp_Object echo_area_message
;
1813 Lisp_Object also_record
;
1815 struct gcpro gcpro1
, gcpro2
;
1819 before_command_key_count
= this_command_key_count
;
1820 before_command_echo_length
= echo_length ();
1822 echo_area_message
= Qnil
;
1824 GCPRO2 (c
, echo_area_message
);
1829 if (CONSP (Vunread_post_input_method_events
))
1831 c
= XCONS (Vunread_post_input_method_events
)->car
;
1832 Vunread_post_input_method_events
1833 = XCONS (Vunread_post_input_method_events
)->cdr
;
1835 /* Undo what read_char_x_menu_prompt did when it unread
1836 additional keys returned by Fx_popup_menu. */
1838 && (SYMBOLP (XCONS (c
)->car
) || INTEGERP (XCONS (c
)->car
))
1839 && NILP (XCONS (c
)->cdr
))
1846 if (unread_command_char
!= -1)
1848 XSETINT (c
, unread_command_char
);
1849 unread_command_char
= -1;
1855 if (CONSP (Vunread_command_events
))
1857 c
= XCONS (Vunread_command_events
)->car
;
1858 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1860 /* Undo what read_char_x_menu_prompt did when it unread
1861 additional keys returned by Fx_popup_menu. */
1863 && (SYMBOLP (XCONS (c
)->car
) || INTEGERP (XCONS (c
)->car
))
1864 && NILP (XCONS (c
)->cdr
))
1868 goto reread_for_input_method
;
1871 if (CONSP (Vunread_input_method_events
))
1873 c
= XCONS (Vunread_input_method_events
)->car
;
1874 Vunread_input_method_events
= XCONS (Vunread_input_method_events
)->cdr
;
1876 /* Undo what read_char_x_menu_prompt did when it unread
1877 additional keys returned by Fx_popup_menu. */
1879 && (SYMBOLP (XCONS (c
)->car
) || INTEGERP (XCONS (c
)->car
))
1880 && NILP (XCONS (c
)->cdr
))
1883 goto reread_for_input_method
;
1886 /* If there is no function key translated before
1887 reset-this-command-lengths takes effect, forget about it. */
1888 before_command_restore_flag
= 0;
1890 if (!NILP (Vexecuting_macro
))
1892 /* We set this to Qmacro; since that's not a frame, nobody will
1893 try to switch frames on us, and the selected window will
1896 Since this event came from a macro, it would be misleading to
1897 leave internal_last_event_frame set to wherever the last
1898 real event came from. Normally, a switch-frame event selects
1899 internal_last_event_frame after each command is read, but
1900 events read from a macro should never cause a new frame to be
1902 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1904 /* Exit the macro if we are at the end.
1905 Also, some things replace the macro with t
1906 to force an early exit. */
1907 if (EQ (Vexecuting_macro
, Qt
)
1908 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1914 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1915 if (STRINGP (Vexecuting_macro
)
1916 && (XINT (c
) & 0x80))
1917 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
1919 executing_macro_index
++;
1924 if (!NILP (unread_switch_frame
))
1926 c
= unread_switch_frame
;
1927 unread_switch_frame
= Qnil
;
1929 /* This event should make it into this_command_keys, and get echoed
1930 again, so we do not set `reread'. */
1934 /* if redisplay was requested */
1935 if (commandflag
>= 0)
1937 /* If there is pending input, process any events which are not
1938 user-visible, such as X selection_request events. */
1940 || detect_input_pending_run_timers (0))
1941 swallow_events (0); /* may clear input_pending */
1943 /* Redisplay if no pending input. */
1944 while (!input_pending
)
1949 /* Normal case: no input arrived during redisplay. */
1952 /* Input arrived and pre-empted redisplay.
1953 Process any events which are not user-visible. */
1955 /* If that cleared input_pending, try again to redisplay. */
1959 /* Message turns off echoing unless more keystrokes turn it on again. */
1960 if (echo_area_glyphs
&& *echo_area_glyphs
1961 && echo_area_glyphs
!= current_kboard
->echobuf
1962 && ok_to_echo_at_next_pause
!= echo_area_glyphs
)
1965 /* If already echoing, continue. */
1968 /* Try reading a character via menu prompting in the minibuf.
1969 Try this before the sit-for, because the sit-for
1970 would do the wrong thing if we are supposed to do
1971 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1972 after a mouse event so don't try a minibuf menu. */
1974 if (nmaps
> 0 && INTERACTIVE
1975 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1976 /* Don't bring up a menu if we already have another event. */
1977 && NILP (Vunread_command_events
)
1978 && unread_command_char
< 0
1979 && !detect_input_pending_run_timers (0))
1981 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1984 key_already_recorded
= 1;
1989 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
1990 We will do that below, temporarily for short sections of code,
1991 when appropriate. local_getcjmp must be in effect
1992 around any call to sit_for or kbd_buffer_get_event;
1993 it *must not* be in effect when we call redisplay. */
1995 if (_setjmp (local_getcjmp
))
1997 XSETINT (c
, quit_char
);
1998 XSETFRAME (internal_last_event_frame
, selected_frame
);
1999 Vlast_event_frame
= internal_last_event_frame
;
2000 /* If we report the quit char as an event,
2001 don't do so more than once. */
2002 if (!NILP (Vinhibit_quit
))
2007 KBOARD
*kb
= FRAME_KBOARD (selected_frame
);
2008 if (kb
!= current_kboard
)
2010 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2011 /* We shouldn't get here if we were in single-kboard mode! */
2014 while (CONSP (*tailp
))
2015 tailp
= &XCONS (*tailp
)->cdr
;
2018 *tailp
= Fcons (c
, Qnil
);
2019 kb
->kbd_queue_has_data
= 1;
2020 current_kboard
= kb
;
2021 /* This is going to exit from read_char
2022 so we had better get rid of this frame's stuff. */
2024 longjmp (wrong_kboard_jmpbuf
, 1);
2031 timer_start_idle ();
2033 /* If in middle of key sequence and minibuffer not active,
2034 start echoing if enough time elapses. */
2036 if (minibuf_level
== 0 && !current_kboard
->immediate_echo
2037 && this_command_key_count
> 0
2039 && echo_keystrokes
> 0
2040 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0
2041 || ok_to_echo_at_next_pause
== echo_area_glyphs
))
2045 /* After a mouse event, start echoing right away.
2046 This is because we are probably about to display a menu,
2047 and we don't want to delay before doing so. */
2048 if (EVENT_HAS_PARAMETERS (prev_event
))
2052 save_getcjmp (save_jump
);
2053 restore_getcjmp (local_getcjmp
);
2054 tem0
= sit_for (echo_keystrokes
, 0, 1, 1, 0);
2055 restore_getcjmp (save_jump
);
2057 && ! CONSP (Vunread_command_events
))
2062 /* Maybe auto save due to number of keystrokes. */
2064 if (commandflag
!= 0
2065 && auto_save_interval
> 0
2066 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2067 && !detect_input_pending_run_timers (0))
2069 Fdo_auto_save (Qnil
, Qnil
);
2070 /* Hooks can actually change some buffers in auto save. */
2074 /* Try reading using an X menu.
2075 This is never confused with reading using the minibuf
2076 because the recursive call of read_char in read_char_minibuf_menu_prompt
2077 does not pass on any keymaps. */
2079 if (nmaps
> 0 && INTERACTIVE
2080 && !NILP (prev_event
)
2081 && EVENT_HAS_PARAMETERS (prev_event
)
2082 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
)
2083 /* Don't bring up a menu if we already have another event. */
2084 && NILP (Vunread_command_events
)
2085 && unread_command_char
< 0)
2087 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2089 /* Now that we have read an event, Emacs is not idle. */
2095 /* Maybe autosave and/or garbage collect due to idleness. */
2097 if (INTERACTIVE
&& NILP (c
))
2099 int delay_level
, buffer_size
;
2101 /* Slow down auto saves logarithmically in size of current buffer,
2102 and garbage collect while we're at it. */
2103 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2104 last_non_minibuf_size
= Z
- BEG
;
2105 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2107 while (buffer_size
> 64)
2108 delay_level
++, buffer_size
-= buffer_size
>> 2;
2109 if (delay_level
< 4) delay_level
= 4;
2110 /* delay_level is 4 for files under around 50k, 7 at 100k,
2111 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2113 /* Auto save if enough time goes by without input. */
2114 if (commandflag
!= 0
2115 && num_nonmacro_input_events
> last_auto_save
2116 && INTEGERP (Vauto_save_timeout
)
2117 && XINT (Vauto_save_timeout
) > 0)
2121 save_getcjmp (save_jump
);
2122 restore_getcjmp (local_getcjmp
);
2123 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2125 restore_getcjmp (save_jump
);
2128 && ! CONSP (Vunread_command_events
))
2130 Fdo_auto_save (Qnil
, Qnil
);
2132 /* If we have auto-saved and there is still no input
2133 available, garbage collect if there has been enough
2134 consing going on to make it worthwhile. */
2135 if (!detect_input_pending_run_timers (0)
2136 && consing_since_gc
> gc_cons_threshold
/ 2)
2137 Fgarbage_collect ();
2144 /* If this has become non-nil here, it has been set by a timer
2145 or sentinel or filter. */
2146 if (CONSP (Vunread_command_events
))
2148 c
= XCONS (Vunread_command_events
)->car
;
2149 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
2152 /* Read something from current KBOARD's side queue, if possible. */
2156 if (current_kboard
->kbd_queue_has_data
)
2158 if (!CONSP (current_kboard
->kbd_queue
))
2160 c
= XCONS (current_kboard
->kbd_queue
)->car
;
2161 current_kboard
->kbd_queue
2162 = XCONS (current_kboard
->kbd_queue
)->cdr
;
2163 if (NILP (current_kboard
->kbd_queue
))
2164 current_kboard
->kbd_queue_has_data
= 0;
2165 input_pending
= readable_events (0);
2166 if (EVENT_HAS_PARAMETERS (c
)
2167 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2168 internal_last_event_frame
= XCONS (XCONS (c
)->cdr
)->car
;
2169 Vlast_event_frame
= internal_last_event_frame
;
2174 /* If current_kboard's side queue is empty check the other kboards.
2175 If one of them has data that we have not yet seen here,
2176 switch to it and process the data waiting for it.
2178 Note: if the events queued up for another kboard
2179 have already been seen here, and therefore are not a complete command,
2180 the kbd_queue_has_data field is 0, so we skip that kboard here.
2181 That's to avoid an infinite loop switching between kboards here. */
2182 if (NILP (c
) && !single_kboard
)
2185 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2186 if (kb
->kbd_queue_has_data
)
2188 current_kboard
= kb
;
2189 /* This is going to exit from read_char
2190 so we had better get rid of this frame's stuff. */
2192 longjmp (wrong_kboard_jmpbuf
, 1);
2201 /* Finally, we read from the main queue,
2202 and if that gives us something we can't use yet, we put it on the
2203 appropriate side queue and try again. */
2209 /* Actually read a character, waiting if necessary. */
2210 save_getcjmp (save_jump
);
2211 restore_getcjmp (local_getcjmp
);
2212 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2213 restore_getcjmp (save_jump
);
2216 if (! NILP (c
) && (kb
!= current_kboard
))
2218 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2219 while (CONSP (*tailp
))
2220 tailp
= &XCONS (*tailp
)->cdr
;
2223 *tailp
= Fcons (c
, Qnil
);
2224 kb
->kbd_queue_has_data
= 1;
2228 current_kboard
= kb
;
2229 /* This is going to exit from read_char
2230 so we had better get rid of this frame's stuff. */
2232 longjmp (wrong_kboard_jmpbuf
, 1);
2237 /* Terminate Emacs in batch mode if at eof. */
2238 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2239 Fkill_emacs (make_number (1));
2243 /* Add in any extra modifiers, where appropriate. */
2244 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2245 || ((extra_keyboard_modifiers
& 0177) < ' '
2246 && (extra_keyboard_modifiers
& 0177) != 0))
2247 XSETINT (c
, make_ctrl_char (XINT (c
)));
2249 /* Transfer any other modifier bits directly from
2250 extra_keyboard_modifiers to c. Ignore the actual character code
2251 in the low 16 bits of extra_keyboard_modifiers. */
2252 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2263 if (commandflag
>= 0
2264 && !input_pending
&& !detect_input_pending_run_timers (0))
2272 /* Buffer switch events are only for internal wakeups
2273 so don't show them to the user.
2274 Also, don't record a key if we already did. */
2275 if (BUFFERP (c
) || key_already_recorded
)
2278 /* Process special events within read_char
2279 and loop around to read another event. */
2282 tem
= get_keyelt (access_keymap (get_keymap_1 (Vspecial_event_map
, 0, 0),
2288 int was_locked
= single_kboard
;
2290 last_input_char
= c
;
2291 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2293 /* Resume allowing input from any kboard, if that was true before. */
2295 any_kboard_state ();
2300 /* Handle things that only apply to characters. */
2303 /* If kbd_buffer_get_event gave us an EOF, return that. */
2307 if ((STRINGP (Vkeyboard_translate_table
)
2308 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2309 || (VECTORP (Vkeyboard_translate_table
)
2310 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2311 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2312 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2315 d
= Faref (Vkeyboard_translate_table
, c
);
2316 /* nil in keyboard-translate-table means no translation. */
2322 /* If this event is a mouse click in the menu bar,
2323 return just menu-bar for now. Modify the mouse click event
2324 so we won't do this twice, then queue it up. */
2325 if (EVENT_HAS_PARAMETERS (c
)
2326 && CONSP (XCONS (c
)->cdr
)
2327 && CONSP (EVENT_START (c
))
2328 && CONSP (XCONS (EVENT_START (c
))->cdr
))
2332 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2333 /* Handle menu-bar events:
2334 insert the dummy prefix event `menu-bar'. */
2335 if (EQ (posn
, Qmenu_bar
))
2337 /* Change menu-bar to (menu-bar) as the event "position". */
2338 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2341 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2346 /* Store these characters into recent_keys, the dribble file if any,
2347 and the keyboard macro being defined, if any. */
2349 if (! NILP (also_record
))
2350 record_char (also_record
);
2352 /* Wipe the echo area.
2353 But first, if we are about to use an input method,
2354 save the echo area contents for it to refer to. */
2356 && ! NILP (Vinput_method_function
)
2357 && (unsigned) XINT (c
) >= ' '
2358 && (unsigned) XINT (c
) < 127)
2359 Vinput_method_previous_message
= echo_area_message
= Fcurrent_message ();
2361 /* Now wipe the echo area. */
2362 if (echo_area_glyphs
)
2363 safe_run_hooks (Qecho_area_clear_hook
);
2364 echo_area_glyphs
= 0;
2366 reread_for_input_method
:
2368 /* Pass this to the input method, if appropriate. */
2370 && ! NILP (Vinput_method_function
)
2371 /* Don't run the input method within a key sequence,
2372 after the first event of the key sequence. */
2373 && NILP (prev_event
)
2374 && (unsigned) XINT (c
) >= ' '
2375 && (unsigned) XINT (c
) < 127)
2379 struct gcpro gcpro1
;
2380 int count
= specpdl_ptr
- specpdl
;
2382 /* Save the echo status. */
2383 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2384 char *saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2385 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2387 if (before_command_restore_flag
)
2389 this_command_key_count
= before_command_key_count_1
;
2390 if (this_command_key_count
< this_single_command_key_start
)
2391 this_single_command_key_start
= this_command_key_count
;
2392 echo_truncate (before_command_echo_length_1
);
2393 before_command_restore_flag
= 0;
2396 /* Save the this_command_keys status. */
2397 key_count
= this_command_key_count
;
2400 keys
= Fcopy_sequence (this_command_keys
);
2405 /* Clear out this_command_keys. */
2406 this_command_key_count
= 0;
2408 /* Now wipe the echo area. */
2409 if (echo_area_glyphs
)
2410 safe_run_hooks (Qecho_area_clear_hook
);
2411 echo_area_glyphs
= 0;
2414 /* If we are not reading a key sequence,
2415 never use the echo area. */
2418 specbind (Qinput_method_exit_on_first_char
, Qt
);
2419 specbind (Qinput_method_use_echo_area
, Qt
);
2422 /* Call the input method. */
2423 tem
= call1 (Vinput_method_function
, c
);
2425 tem
= unbind_to (count
, tem
);
2427 /* Restore the saved echoing state
2428 and this_command_keys state. */
2429 this_command_key_count
= key_count
;
2431 this_command_keys
= keys
;
2434 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
2435 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
2436 if (saved_immediate_echo
)
2441 /* The input method can return no events. */
2444 /* Bring back the previous message, if any. */
2445 if (! NILP (echo_area_message
))
2446 message_with_string ("%s", echo_area_message
, 0);
2449 /* It returned one event or more. */
2450 c
= XCONS (tem
)->car
;
2451 Vunread_post_input_method_events
2452 = nconc2 (XCONS (tem
)->cdr
, Vunread_post_input_method_events
);
2457 if (this_command_key_count
== 0 || ! reread
)
2459 before_command_key_count
= this_command_key_count
;
2460 before_command_echo_length
= echo_length ();
2462 /* Don't echo mouse motion events. */
2464 && ! (EVENT_HAS_PARAMETERS (c
)
2465 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2468 if (! NILP (also_record
))
2469 echo_char (also_record
);
2470 /* Once we reread a character, echoing can happen
2471 the next time we pause to read a new one. */
2472 ok_to_echo_at_next_pause
= echo_area_glyphs
;
2475 /* Record this character as part of the current key. */
2476 add_command_key (c
);
2477 if (! NILP (also_record
))
2478 add_command_key (also_record
);
2481 last_input_char
= c
;
2484 /* Process the help character specially if enabled */
2485 if (!NILP (Vhelp_form
) && help_char_p (c
))
2488 count
= specpdl_ptr
- specpdl
;
2490 record_unwind_protect (Fset_window_configuration
,
2491 Fcurrent_window_configuration (Qnil
));
2493 tem0
= Feval (Vhelp_form
);
2495 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2499 c
= read_char (0, 0, 0, Qnil
, 0);
2500 while (BUFFERP (c
));
2501 /* Remove the help from the frame */
2502 unbind_to (count
, Qnil
);
2505 if (EQ (c
, make_number (040)))
2509 c
= read_char (0, 0, 0, Qnil
, 0);
2510 while (BUFFERP (c
));
2517 /* Record a key that came from a mouse menu.
2518 Record it for echoing, for this-command-keys, and so on. */
2524 /* Wipe the echo area. */
2525 echo_area_glyphs
= 0;
2529 before_command_key_count
= this_command_key_count
;
2530 before_command_echo_length
= echo_length ();
2532 /* Don't echo mouse motion events. */
2533 if (echo_keystrokes
)
2537 /* Once we reread a character, echoing can happen
2538 the next time we pause to read a new one. */
2539 ok_to_echo_at_next_pause
= 0;
2542 /* Record this character as part of the current key. */
2543 add_command_key (c
);
2545 /* Re-reading in the middle of a command */
2546 last_input_char
= c
;
2550 /* Return 1 if should recognize C as "the help character". */
2558 if (EQ (c
, Vhelp_char
))
2560 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2561 if (EQ (c
, XCONS (tail
)->car
))
2566 /* Record the input event C in various ways. */
2573 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
2574 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2575 recent_keys_index
= 0;
2577 /* Write c to the dribble file. If c is a lispy event, write
2578 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2579 If you, dear reader, have a better idea, you've got the source. :-) */
2584 if (XUINT (c
) < 0x100)
2585 putc (XINT (c
), dribble
);
2587 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
2591 Lisp_Object dribblee
;
2593 /* If it's a structured event, take the event header. */
2594 dribblee
= EVENT_HEAD (c
);
2596 if (SYMBOLP (dribblee
))
2598 putc ('<', dribble
);
2599 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
2600 STRING_BYTES (XSYMBOL (dribblee
)->name
),
2602 putc ('>', dribble
);
2609 store_kbd_macro_char (c
);
2611 num_nonmacro_input_events
++;
2618 struct buffer
*old
= current_buffer
;
2619 Fprinc (object
, Qnil
);
2620 set_buffer_internal (XBUFFER (Vstandard_output
));
2621 call0 (intern ("help-mode"));
2622 set_buffer_internal (old
);
2626 /* Copy out or in the info on where C-g should throw to.
2627 This is used when running Lisp code from within get_char,
2628 in case get_char is called recursively.
2629 See read_process_output. */
2635 bcopy (getcjmp
, temp
, sizeof getcjmp
);
2639 restore_getcjmp (temp
)
2642 bcopy (temp
, getcjmp
, sizeof getcjmp
);
2647 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
2648 of this function. */
2651 tracking_off (old_value
)
2652 Lisp_Object old_value
;
2654 do_mouse_tracking
= old_value
;
2655 if (NILP (old_value
))
2657 /* Redisplay may have been preempted because there was input
2658 available, and it assumes it will be called again after the
2659 input has been processed. If the only input available was
2660 the sort that we have just disabled, then we need to call
2662 if (!readable_events (1))
2664 redisplay_preserve_echo_area ();
2665 get_input_pending (&input_pending
, 1);
2670 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
2671 "Evaluate BODY with mouse movement events enabled.\n\
2672 Within a `track-mouse' form, mouse motion generates input events that\n\
2673 you can read with `read-event'.\n\
2674 Normally, mouse motion is ignored.")
2678 int count
= specpdl_ptr
- specpdl
;
2681 record_unwind_protect (tracking_off
, do_mouse_tracking
);
2683 do_mouse_tracking
= Qt
;
2685 val
= Fprogn (args
);
2686 return unbind_to (count
, val
);
2689 /* If mouse has moved on some frame, return one of those frames.
2690 Return 0 otherwise. */
2695 Lisp_Object tail
, frame
;
2697 FOR_EACH_FRAME (tail
, frame
)
2699 if (XFRAME (frame
)->mouse_moved
)
2700 return XFRAME (frame
);
2706 #endif /* HAVE_MOUSE */
2708 /* Low level keyboard/mouse input.
2709 kbd_buffer_store_event places events in kbd_buffer, and
2710 kbd_buffer_get_event retrieves them. */
2712 /* Return true iff there are any events in the queue that read-char
2713 would return. If this returns false, a read-char would block. */
2715 readable_events (do_timers_now
)
2719 timer_check (do_timers_now
);
2721 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2724 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2729 if (current_kboard
->kbd_queue_has_data
)
2735 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2736 if (kb
->kbd_queue_has_data
)
2742 /* Set this for debugging, to have a way to get out */
2747 event_to_kboard (event
)
2748 struct input_event
*event
;
2751 frame
= event
->frame_or_window
;
2753 frame
= XCONS (frame
)->car
;
2754 else if (WINDOWP (frame
))
2755 frame
= WINDOW_FRAME (XWINDOW (frame
));
2757 /* There are still some events that don't set this field.
2758 For now, just ignore the problem.
2759 Also ignore dead frames here. */
2760 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
2763 return FRAME_KBOARD (XFRAME (frame
));
2767 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
2770 kbd_buffer_store_event (event
)
2771 register struct input_event
*event
;
2773 if (event
->kind
== no_event
)
2776 if (event
->kind
== ascii_keystroke
)
2778 register int c
= event
->code
& 0377;
2780 if (event
->modifiers
& ctrl_modifier
)
2781 c
= make_ctrl_char (c
);
2783 c
|= (event
->modifiers
2784 & (meta_modifier
| alt_modifier
2785 | hyper_modifier
| super_modifier
));
2789 extern SIGTYPE
interrupt_signal ();
2792 struct input_event
*sp
;
2795 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
2796 kb
!= current_kboard
))
2799 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
2800 Fcons (make_number (c
), Qnil
));
2801 kb
->kbd_queue_has_data
= 1;
2802 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2804 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2807 if (event_to_kboard (sp
) == kb
)
2809 sp
->kind
= no_event
;
2810 sp
->frame_or_window
= Qnil
;
2817 /* If this results in a quit_char being returned to Emacs as
2818 input, set Vlast_event_frame properly. If this doesn't
2819 get returned to Emacs as an event, the next event read
2820 will set Vlast_event_frame again, so this is safe to do. */
2824 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
2826 focus
= event
->frame_or_window
;
2827 internal_last_event_frame
= focus
;
2828 Vlast_event_frame
= focus
;
2831 last_event_timestamp
= event
->timestamp
;
2832 interrupt_signal ();
2836 if (c
&& c
== stop_character
)
2842 /* Don't insert two buffer_switch_event's in a row.
2843 Just ignore the second one. */
2844 else if (event
->kind
== buffer_switch_event
2845 && kbd_fetch_ptr
!= kbd_store_ptr
2846 && kbd_store_ptr
->kind
== buffer_switch_event
)
2849 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
2850 kbd_store_ptr
= kbd_buffer
;
2852 /* Don't let the very last slot in the buffer become full,
2853 since that would make the two pointers equal,
2854 and that is indistinguishable from an empty buffer.
2855 Discard the event if it would fill the last slot. */
2856 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
2858 volatile struct input_event
*sp
= kbd_store_ptr
;
2859 sp
->kind
= event
->kind
;
2860 if (event
->kind
== selection_request_event
)
2862 /* We must not use the ordinary copying code for this case,
2863 since `part' is an enum and copying it might not copy enough
2865 bcopy (event
, (char *) sp
, sizeof (*event
));
2869 sp
->code
= event
->code
;
2870 sp
->part
= event
->part
;
2871 sp
->frame_or_window
= event
->frame_or_window
;
2872 sp
->modifiers
= event
->modifiers
;
2875 sp
->timestamp
= event
->timestamp
;
2877 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
2879 = event
->frame_or_window
);
2885 /* Discard any mouse events in the event buffer by setting them to
2888 discard_mouse_events ()
2890 struct input_event
*sp
;
2891 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2893 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2896 if (sp
->kind
== mouse_click
2898 || sp
->kind
== w32_scroll_bar_click
2900 || sp
->kind
== scroll_bar_click
)
2902 sp
->kind
= no_event
;
2907 /* Read one event from the event buffer, waiting if necessary.
2908 The value is a Lisp object representing the event.
2909 The value is nil for an event that should be ignored,
2910 or that was handled here.
2911 We always read and discard one event. */
2914 kbd_buffer_get_event (kbp
, used_mouse_menu
)
2916 int *used_mouse_menu
;
2920 EMACS_TIME next_timer_delay
;
2926 *kbp
= current_kboard
;
2930 /* Wait until there is input available. */
2933 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2936 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2940 /* If the quit flag is set, then read_char will return
2941 quit_char, so that counts as "available input." */
2942 if (!NILP (Vquit_flag
))
2943 quit_throw_to_read_char ();
2945 /* One way or another, wait until input is available; then, if
2946 interrupt handlers have not read it, read it now. */
2949 wait_for_kbd_input ();
2951 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2955 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2958 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2962 Lisp_Object minus_one
;
2964 XSETINT (minus_one
, -1);
2965 wait_reading_process_input (0, 0, minus_one
, 1);
2967 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
2968 /* Pass 1 for EXPECT since we just waited to have input. */
2969 read_avail_input (1);
2971 #endif /* not VMS */
2974 if (CONSP (Vunread_command_events
))
2977 first
= XCONS (Vunread_command_events
)->car
;
2978 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
2979 *kbp
= current_kboard
;
2983 /* At this point, we know that there is a readable event available
2984 somewhere. If the event queue is empty, then there must be a
2985 mouse movement enabled and available. */
2986 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2988 struct input_event
*event
;
2990 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2994 last_event_timestamp
= event
->timestamp
;
2997 *kbp
= event_to_kboard (event
);
2999 *kbp
= current_kboard
; /* Better than returning null ptr? */
3001 *kbp
= &the_only_kboard
;
3006 /* These two kinds of events get special handling
3007 and don't actually appear to the command loop.
3008 We return nil for them. */
3009 if (event
->kind
== selection_request_event
)
3012 struct input_event copy
;
3014 /* Remove it from the buffer before processing it,
3015 since otherwise swallow_events will see it
3016 and process it again. */
3018 kbd_fetch_ptr
= event
+ 1;
3019 input_pending
= readable_events (0);
3020 x_handle_selection_request (©
);
3022 /* We're getting selection request events, but we don't have
3028 else if (event
->kind
== selection_clear_event
)
3031 struct input_event copy
;
3033 /* Remove it from the buffer before processing it. */
3035 kbd_fetch_ptr
= event
+ 1;
3036 input_pending
= readable_events (0);
3037 x_handle_selection_clear (©
);
3039 /* We're getting selection request events, but we don't have
3044 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3045 else if (event
->kind
== delete_window_event
)
3047 /* Make an event (delete-frame (FRAME)). */
3048 obj
= Fcons (event
->frame_or_window
, Qnil
);
3049 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3050 kbd_fetch_ptr
= event
+ 1;
3052 else if (event
->kind
== iconify_event
)
3054 /* Make an event (iconify-frame (FRAME)). */
3055 obj
= Fcons (event
->frame_or_window
, Qnil
);
3056 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3057 kbd_fetch_ptr
= event
+ 1;
3059 else if (event
->kind
== deiconify_event
)
3061 /* Make an event (make-frame-visible (FRAME)). */
3062 obj
= Fcons (event
->frame_or_window
, Qnil
);
3063 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3064 kbd_fetch_ptr
= event
+ 1;
3067 else if (event
->kind
== buffer_switch_event
)
3069 /* The value doesn't matter here; only the type is tested. */
3070 XSETBUFFER (obj
, current_buffer
);
3071 kbd_fetch_ptr
= event
+ 1;
3073 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
3074 else if (event
->kind
== menu_bar_activate_event
)
3076 kbd_fetch_ptr
= event
+ 1;
3077 input_pending
= readable_events (0);
3078 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3079 x_activate_menubar (XFRAME (event
->frame_or_window
));
3082 /* Just discard these, by returning nil.
3083 With MULTI_KBOARD, these events are used as placeholders
3084 when we need to randomly delete events from the queue.
3085 (They shouldn't otherwise be found in the buffer,
3086 but on some machines it appears they do show up
3087 even without MULTI_KBOARD.) */
3088 /* On Windows NT/9X, no_event is used to delete extraneous
3089 mouse events during a popup-menu call. */
3090 else if (event
->kind
== no_event
)
3091 kbd_fetch_ptr
= event
+ 1;
3093 /* If this event is on a different frame, return a switch-frame this
3094 time, and leave the event in the queue for next time. */
3100 frame
= event
->frame_or_window
;
3102 frame
= XCONS (frame
)->car
;
3103 else if (WINDOWP (frame
))
3104 frame
= WINDOW_FRAME (XWINDOW (frame
));
3106 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3110 if (! EQ (frame
, internal_last_event_frame
)
3111 && XFRAME (frame
) != selected_frame
)
3112 obj
= make_lispy_switch_frame (frame
);
3113 internal_last_event_frame
= frame
;
3115 /* If we didn't decide to make a switch-frame event, go ahead
3116 and build a real event from the queue entry. */
3120 obj
= make_lispy_event (event
);
3121 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
3122 /* If this was a menu selection, then set the flag to inhibit
3123 writing to last_nonmenu_event. Don't do this if the event
3124 we're returning is (menu-bar), though; that indicates the
3125 beginning of the menu sequence, and we might as well leave
3126 that as the `event with parameters' for this selection. */
3127 if (event
->kind
== menu_bar_event
3128 && !(CONSP (obj
) && EQ (XCONS (obj
)->car
, Qmenu_bar
))
3130 *used_mouse_menu
= 1;
3133 /* Wipe out this event, to catch bugs. */
3134 event
->kind
= no_event
;
3135 XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
] = Qnil
;
3137 kbd_fetch_ptr
= event
+ 1;
3142 /* Try generating a mouse motion event. */
3143 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3145 FRAME_PTR f
= some_mouse_moved ();
3146 Lisp_Object bar_window
;
3147 enum scroll_bar_part part
;
3151 *kbp
= current_kboard
;
3152 /* Note that this uses F to determine which display to look at.
3153 If there is no valid info, it does not store anything
3154 so x remains nil. */
3156 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
3160 /* Decide if we should generate a switch-frame event. Don't
3161 generate switch-frame events for motion outside of all Emacs
3167 frame
= FRAME_FOCUS_FRAME (f
);
3169 XSETFRAME (frame
, f
);
3171 if (! EQ (frame
, internal_last_event_frame
)
3172 && XFRAME (frame
) != selected_frame
)
3173 obj
= make_lispy_switch_frame (frame
);
3174 internal_last_event_frame
= frame
;
3177 /* If we didn't decide to make a switch-frame event, go ahead and
3178 return a mouse-motion event. */
3179 if (!NILP (x
) && NILP (obj
))
3180 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
3182 #endif /* HAVE_MOUSE */
3184 /* We were promised by the above while loop that there was
3185 something for us to read! */
3188 input_pending
= readable_events (0);
3190 Vlast_event_frame
= internal_last_event_frame
;
3195 /* Process any events that are not user-visible,
3196 then return, without reading any user-visible events. */
3199 swallow_events (do_display
)
3204 while (kbd_fetch_ptr
!= kbd_store_ptr
)
3206 struct input_event
*event
;
3208 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3212 last_event_timestamp
= event
->timestamp
;
3214 /* These two kinds of events get special handling
3215 and don't actually appear to the command loop. */
3216 if (event
->kind
== selection_request_event
)
3219 struct input_event copy
;
3221 /* Remove it from the buffer before processing it,
3222 since otherwise swallow_events called recursively could see it
3223 and process it again. */
3225 kbd_fetch_ptr
= event
+ 1;
3226 input_pending
= readable_events (0);
3227 x_handle_selection_request (©
);
3229 /* We're getting selection request events, but we don't have
3235 else if (event
->kind
== selection_clear_event
)
3238 struct input_event copy
;
3240 /* Remove it from the buffer before processing it, */
3243 kbd_fetch_ptr
= event
+ 1;
3244 input_pending
= readable_events (0);
3245 x_handle_selection_clear (©
);
3247 /* We're getting selection request events, but we don't have
3256 old_timers_run
= timers_run
;
3257 get_input_pending (&input_pending
, 1);
3259 if (timers_run
!= old_timers_run
&& do_display
)
3260 redisplay_preserve_echo_area ();
3263 static EMACS_TIME timer_idleness_start_time
;
3265 /* Record the start of when Emacs is idle,
3266 for the sake of running idle-time timers. */
3273 /* If we are already in the idle state, do nothing. */
3274 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3277 EMACS_GET_TIME (timer_idleness_start_time
);
3279 /* Mark all idle-time timers as once again candidates for running. */
3280 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCONS (timers
)->cdr
)
3284 timer
= XCONS (timers
)->car
;
3286 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3288 XVECTOR (timer
)->contents
[0] = Qnil
;
3292 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
3297 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
3300 /* This is only for debugging. */
3301 struct input_event last_timer_event
;
3303 /* Check whether a timer has fired. To prevent larger problems we simply
3304 disregard elements that are not proper timers. Do not make a circular
3305 timer list for the time being.
3307 Returns the number of seconds to wait until the next timer fires. If a
3308 timer is triggering now, return zero seconds.
3309 If no timer is active, return -1 seconds.
3311 If a timer is ripe, we run it, with quitting turned off.
3313 DO_IT_NOW is now ignored. It used to mean that we should
3314 run the timer directly instead of queueing a timer-event.
3315 Now we always run timers directly. */
3318 timer_check (do_it_now
)
3321 EMACS_TIME nexttime
;
3322 EMACS_TIME now
, idleness_now
;
3323 Lisp_Object timers
, idle_timers
, chosen_timer
;
3324 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3326 EMACS_SET_SECS (nexttime
, -1);
3327 EMACS_SET_USECS (nexttime
, -1);
3329 /* Always consider the ordinary timers. */
3330 timers
= Vtimer_list
;
3331 /* Consider the idle timers only if Emacs is idle. */
3332 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3333 idle_timers
= Vtimer_idle_list
;
3336 chosen_timer
= Qnil
;
3337 GCPRO3 (timers
, idle_timers
, chosen_timer
);
3339 if (CONSP (timers
) || CONSP (idle_timers
))
3341 EMACS_GET_TIME (now
);
3342 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3343 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
3346 while (CONSP (timers
) || CONSP (idle_timers
))
3348 int triggertime
= EMACS_SECS (now
);
3349 Lisp_Object
*vector
;
3350 Lisp_Object timer
, idle_timer
;
3351 EMACS_TIME timer_time
, idle_timer_time
;
3352 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
3354 /* Skip past invalid timers and timers already handled. */
3357 timer
= XCONS (timers
)->car
;
3358 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3360 timers
= XCONS (timers
)->cdr
;
3363 vector
= XVECTOR (timer
)->contents
;
3365 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3366 || !INTEGERP (vector
[3])
3367 || ! NILP (vector
[0]))
3369 timers
= XCONS (timers
)->cdr
;
3373 if (!NILP (idle_timers
))
3375 timer
= XCONS (idle_timers
)->car
;
3376 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3378 idle_timers
= XCONS (idle_timers
)->cdr
;
3381 vector
= XVECTOR (timer
)->contents
;
3383 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3384 || !INTEGERP (vector
[3])
3385 || ! NILP (vector
[0]))
3387 idle_timers
= XCONS (idle_timers
)->cdr
;
3392 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
3393 based on the next ordinary timer.
3394 TIMER_DIFFERENCE is the distance in time from NOW to when
3395 this timer becomes ripe (negative if it's already ripe). */
3398 timer
= XCONS (timers
)->car
;
3399 vector
= XVECTOR (timer
)->contents
;
3400 EMACS_SET_SECS (timer_time
,
3401 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3402 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
3403 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
3406 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
3407 based on the next idle timer. */
3408 if (!NILP (idle_timers
))
3410 idle_timer
= XCONS (idle_timers
)->car
;
3411 vector
= XVECTOR (idle_timer
)->contents
;
3412 EMACS_SET_SECS (idle_timer_time
,
3413 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3414 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
3415 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
3418 /* Decide which timer is the next timer,
3419 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
3420 Also step down the list where we found that timer. */
3422 if (! NILP (timers
) && ! NILP (idle_timers
))
3425 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
3426 if (EMACS_TIME_NEG_P (temp
))
3428 chosen_timer
= timer
;
3429 timers
= XCONS (timers
)->cdr
;
3430 difference
= timer_difference
;
3434 chosen_timer
= idle_timer
;
3435 idle_timers
= XCONS (idle_timers
)->cdr
;
3436 difference
= idle_timer_difference
;
3439 else if (! NILP (timers
))
3441 chosen_timer
= timer
;
3442 timers
= XCONS (timers
)->cdr
;
3443 difference
= timer_difference
;
3447 chosen_timer
= idle_timer
;
3448 idle_timers
= XCONS (idle_timers
)->cdr
;
3449 difference
= idle_timer_difference
;
3451 vector
= XVECTOR (chosen_timer
)->contents
;
3453 /* If timer is rupe, run it if it hasn't been run. */
3454 if (EMACS_TIME_NEG_P (difference
)
3455 || (EMACS_SECS (difference
) == 0
3456 && EMACS_USECS (difference
) == 0))
3458 if (NILP (vector
[0]))
3461 int was_locked
= single_kboard
;
3462 int count
= specpdl_ptr
- specpdl
;
3464 /* Mark the timer as triggered to prevent problems if the lisp
3465 code fails to reschedule it right. */
3468 specbind (Qinhibit_quit
, Qt
);
3470 call1 (Qtimer_event_handler
, chosen_timer
);
3473 unbind_to (count
, Qnil
);
3475 /* Resume allowing input from any kboard, if that was true before. */
3477 any_kboard_state ();
3479 /* Since we have handled the event,
3480 we don't need to tell the caller to wake up and do it. */
3484 /* When we encounter a timer that is still waiting,
3485 return the amount of time to wait before it is ripe. */
3492 /* No timers are pending in the future. */
3493 /* Return 0 if we generated an event, and -1 if not. */
3498 /* Caches for modify_event_symbol. */
3499 static Lisp_Object accent_key_syms
;
3500 static Lisp_Object func_key_syms
;
3501 static Lisp_Object mouse_syms
;
3503 static Lisp_Object mouse_wheel_syms
;
3505 static Lisp_Object drag_n_drop_syms
;
3507 /* This is a list of keysym codes for special "accent" characters.
3508 It parallels lispy_accent_keys. */
3510 static int lispy_accent_codes
[] =
3512 #ifdef XK_dead_circumflex
3517 #ifdef XK_dead_grave
3522 #ifdef XK_dead_tilde
3527 #ifdef XK_dead_diaeresis
3532 #ifdef XK_dead_macron
3537 #ifdef XK_dead_degree
3542 #ifdef XK_dead_acute
3547 #ifdef XK_dead_cedilla
3552 #ifdef XK_dead_breve
3557 #ifdef XK_dead_ogonek
3562 #ifdef XK_dead_caron
3567 #ifdef XK_dead_doubleacute
3568 XK_dead_doubleacute
,
3572 #ifdef XK_dead_abovedot
3579 /* This is a list of Lisp names for special "accent" characters.
3580 It parallels lispy_accent_codes. */
3582 static char *lispy_accent_keys
[] =
3600 #define FUNCTION_KEY_OFFSET 0x0
3602 char *lispy_function_keys
[] =
3606 0, /* VK_LBUTTON 0x01 */
3607 0, /* VK_RBUTTON 0x02 */
3608 "cancel", /* VK_CANCEL 0x03 */
3609 0, /* VK_MBUTTON 0x04 */
3611 0, 0, 0, /* 0x05 .. 0x07 */
3613 "backspace", /* VK_BACK 0x08 */
3614 "tab", /* VK_TAB 0x09 */
3616 0, 0, /* 0x0A .. 0x0B */
3618 "clear", /* VK_CLEAR 0x0C */
3619 "return", /* VK_RETURN 0x0D */
3621 0, 0, /* 0x0E .. 0x0F */
3623 "shift", /* VK_SHIFT 0x10 */
3624 "control", /* VK_CONTROL 0x11 */
3625 "menu", /* VK_MENU 0x12 */
3626 "pause", /* VK_PAUSE 0x13 */
3627 "capital", /* VK_CAPITAL 0x14 */
3629 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
3631 0, /* VK_ESCAPE 0x1B */
3633 0, 0, 0, 0, /* 0x1C .. 0x1F */
3635 0, /* VK_SPACE 0x20 */
3636 "prior", /* VK_PRIOR 0x21 */
3637 "next", /* VK_NEXT 0x22 */
3638 "end", /* VK_END 0x23 */
3639 "home", /* VK_HOME 0x24 */
3640 "left", /* VK_LEFT 0x25 */
3641 "up", /* VK_UP 0x26 */
3642 "right", /* VK_RIGHT 0x27 */
3643 "down", /* VK_DOWN 0x28 */
3644 "select", /* VK_SELECT 0x29 */
3645 "print", /* VK_PRINT 0x2A */
3646 "execute", /* VK_EXECUTE 0x2B */
3647 "snapshot", /* VK_SNAPSHOT 0x2C */
3648 "insert", /* VK_INSERT 0x2D */
3649 "delete", /* VK_DELETE 0x2E */
3650 "help", /* VK_HELP 0x2F */
3652 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
3654 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3656 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
3658 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
3660 0, 0, 0, 0, 0, 0, 0, 0, 0,
3661 0, 0, 0, 0, 0, 0, 0, 0, 0,
3662 0, 0, 0, 0, 0, 0, 0, 0,
3664 "lwindow", /* VK_LWIN 0x5B */
3665 "rwindow", /* VK_RWIN 0x5C */
3666 "apps", /* VK_APPS 0x5D */
3668 0, 0, /* 0x5E .. 0x5F */
3670 "kp-0", /* VK_NUMPAD0 0x60 */
3671 "kp-1", /* VK_NUMPAD1 0x61 */
3672 "kp-2", /* VK_NUMPAD2 0x62 */
3673 "kp-3", /* VK_NUMPAD3 0x63 */
3674 "kp-4", /* VK_NUMPAD4 0x64 */
3675 "kp-5", /* VK_NUMPAD5 0x65 */
3676 "kp-6", /* VK_NUMPAD6 0x66 */
3677 "kp-7", /* VK_NUMPAD7 0x67 */
3678 "kp-8", /* VK_NUMPAD8 0x68 */
3679 "kp-9", /* VK_NUMPAD9 0x69 */
3680 "kp-multiply", /* VK_MULTIPLY 0x6A */
3681 "kp-add", /* VK_ADD 0x6B */
3682 "kp-separator", /* VK_SEPARATOR 0x6C */
3683 "kp-subtract", /* VK_SUBTRACT 0x6D */
3684 "kp-decimal", /* VK_DECIMAL 0x6E */
3685 "kp-divide", /* VK_DIVIDE 0x6F */
3686 "f1", /* VK_F1 0x70 */
3687 "f2", /* VK_F2 0x71 */
3688 "f3", /* VK_F3 0x72 */
3689 "f4", /* VK_F4 0x73 */
3690 "f5", /* VK_F5 0x74 */
3691 "f6", /* VK_F6 0x75 */
3692 "f7", /* VK_F7 0x76 */
3693 "f8", /* VK_F8 0x77 */
3694 "f9", /* VK_F9 0x78 */
3695 "f10", /* VK_F10 0x79 */
3696 "f11", /* VK_F11 0x7A */
3697 "f12", /* VK_F12 0x7B */
3698 "f13", /* VK_F13 0x7C */
3699 "f14", /* VK_F14 0x7D */
3700 "f15", /* VK_F15 0x7E */
3701 "f16", /* VK_F16 0x7F */
3702 "f17", /* VK_F17 0x80 */
3703 "f18", /* VK_F18 0x81 */
3704 "f19", /* VK_F19 0x82 */
3705 "f20", /* VK_F20 0x83 */
3706 "f21", /* VK_F21 0x84 */
3707 "f22", /* VK_F22 0x85 */
3708 "f23", /* VK_F23 0x86 */
3709 "f24", /* VK_F24 0x87 */
3711 0, 0, 0, 0, /* 0x88 .. 0x8B */
3712 0, 0, 0, 0, /* 0x8C .. 0x8F */
3714 "kp-numlock", /* VK_NUMLOCK 0x90 */
3715 "scroll", /* VK_SCROLL 0x91 */
3717 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
3718 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
3719 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
3720 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
3721 "kp-end", /* VK_NUMPAD_END 0x96 */
3722 "kp-home", /* VK_NUMPAD_HOME 0x97 */
3723 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
3724 "kp-up", /* VK_NUMPAD_UP 0x99 */
3725 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
3726 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
3727 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
3728 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
3730 0, 0, /* 0x9E .. 0x9F */
3733 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
3734 * Used only as parameters to GetAsyncKeyState and GetKeyState.
3735 * No other API or message will distinguish left and right keys this way.
3739 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3740 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3741 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3742 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3743 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3749 "attn", /* VK_ATTN 0xF6 */
3750 "crsel", /* VK_CRSEL 0xF7 */
3751 "exsel", /* VK_EXSEL 0xF8 */
3752 "ereof", /* VK_EREOF 0xF9 */
3753 "play", /* VK_PLAY 0xFA */
3754 "zoom", /* VK_ZOOM 0xFB */
3755 "noname", /* VK_NONAME 0xFC */
3756 "pa1", /* VK_PA1 0xFD */
3757 "oem_clear", /* VK_OEM_CLEAR 0xFE */
3760 #else /* not HAVE_NTGUI */
3763 static char *lispy_kana_keys
[] =
3765 /* X Keysym value */
3766 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
3767 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
3768 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
3769 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
3770 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
3771 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
3772 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
3773 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
3774 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
3775 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
3776 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
3777 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
3778 "kana-i", "kana-u", "kana-e", "kana-o",
3779 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
3780 "prolongedsound", "kana-A", "kana-I", "kana-U",
3781 "kana-E", "kana-O", "kana-KA", "kana-KI",
3782 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
3783 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
3784 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
3785 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
3786 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
3787 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
3788 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
3789 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
3790 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
3791 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
3792 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
3793 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
3795 #endif /* XK_kana_A */
3797 #define FUNCTION_KEY_OFFSET 0xff00
3799 /* You'll notice that this table is arranged to be conveniently
3800 indexed by X Windows keysym values. */
3801 static char *lispy_function_keys
[] =
3803 /* X Keysym value */
3805 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
3806 "backspace", "tab", "linefeed", "clear",
3808 0, 0, 0, "pause", /* 0xff10...1f */
3809 0, 0, 0, 0, 0, 0, 0, "escape",
3811 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
3812 "romaji", "hiragana", "katakana", "hiragana-katakana",
3813 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
3814 "massyo", "kana-lock", "kana-shift", "eisu-shift",
3815 "eisu-toggle", /* 0xff30...3f */
3816 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3817 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
3819 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
3820 "down", "prior", "next", "end",
3821 "begin", 0, 0, 0, 0, 0, 0, 0,
3822 "select", /* 0xff60 */ /* IsMiscFunctionKey */
3833 "break", /* 0xff6b */
3836 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
3837 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
3838 "kp-space", /* 0xff80 */ /* IsKeypadKey */
3839 0, 0, 0, 0, 0, 0, 0, 0,
3840 "kp-tab", /* 0xff89 */
3842 "kp-enter", /* 0xff8d */
3844 "kp-f1", /* 0xff91 */
3848 "kp-home", /* 0xff95 */
3853 "kp-prior", /* kp-page-up */
3854 "kp-next", /* kp-page-down */
3860 0, 0, 0, 0, 0, 0, 0, 0, 0,
3861 "kp-multiply", /* 0xffaa */
3866 "kp-divide", /* 0xffaf */
3867 "kp-0", /* 0xffb0 */
3868 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
3871 "kp-equal", /* 0xffbd */
3872 "f1", /* 0xffbe */ /* IsFunctionKey */
3874 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
3875 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
3876 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
3877 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
3878 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
3879 0, 0, 0, 0, 0, 0, 0, 0,
3880 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
3881 0, 0, 0, 0, 0, 0, 0, "delete"
3884 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
3885 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
3887 static char *iso_lispy_function_keys
[] =
3889 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
3890 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
3891 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
3892 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
3893 "iso-lefttab", /* 0xfe20 */
3894 "iso-move-line-up", "iso-move-line-down",
3895 "iso-partial-line-up", "iso-partial-line-down",
3896 "iso-partial-space-left", "iso-partial-space-right",
3897 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
3898 "iso-release-margin-left", "iso-release-margin-right",
3899 "iso-release-both-margins",
3900 "iso-fast-cursor-left", "iso-fast-cursor-right",
3901 "iso-fast-cursor-up", "iso-fast-cursor-down",
3902 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
3903 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
3906 #endif /* not HAVE_NTGUI */
3908 static char *lispy_mouse_names
[] =
3910 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
3914 /* mouse-wheel events are generated by the wheel on devices such as
3915 the MS Intellimouse. The wheel sits in between the left and right
3916 mouse buttons, and is typically used to scroll or zoom the window
3917 underneath the pointer. mouse-wheel events specify the object on
3918 which they operate, and a delta corresponding to the amount and
3919 direction that the wheel is rotated. Clicking the mouse-wheel
3920 generates a mouse-2 event. */
3921 static char *lispy_mouse_wheel_names
[] =
3926 #endif /* WINDOWSNT */
3928 /* drag-n-drop events are generated when a set of selected files are
3929 dragged from another application and dropped onto an Emacs window. */
3930 static char *lispy_drag_n_drop_names
[] =
3935 /* Scroll bar parts. */
3936 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
3937 Lisp_Object Qup
, Qdown
;
3939 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
3940 Lisp_Object
*scroll_bar_parts
[] = {
3941 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
3946 /* A vector, indexed by button number, giving the down-going location
3947 of currently depressed buttons, both scroll bar and non-scroll bar.
3949 The elements have the form
3950 (BUTTON-NUMBER MODIFIER-MASK . REST)
3951 where REST is the cdr of a position as it would be reported in the event.
3953 The make_lispy_event function stores positions here to tell the
3954 difference between click and drag events, and to store the starting
3955 location to be included in drag events. */
3957 static Lisp_Object button_down_location
;
3959 /* Information about the most recent up-going button event: Which
3960 button, what location, and what time. */
3962 static int last_mouse_button
;
3963 static int last_mouse_x
;
3964 static int last_mouse_y
;
3965 static unsigned long button_down_time
;
3967 /* The maximum time between clicks to make a double-click,
3968 or Qnil to disable double-click detection,
3969 or Qt for no time limit. */
3970 Lisp_Object Vdouble_click_time
;
3972 /* The number of clicks in this multiple-click. */
3974 int double_click_count
;
3976 /* Given a struct input_event, build the lisp event which represents
3977 it. If EVENT is 0, build a mouse movement event from the mouse
3978 movement buffer, which should have a movement event in it.
3980 Note that events must be passed to this function in the order they
3981 are received; this function stores the location of button presses
3982 in order to build drag events when the button is released. */
3985 make_lispy_event (event
)
3986 struct input_event
*event
;
3990 switch (SWITCH_ENUM_CAST (event
->kind
))
3992 /* A simple keystroke. */
3993 case ascii_keystroke
:
3995 Lisp_Object lispy_c
;
3996 int c
= event
->code
& 0377;
3997 /* Turn ASCII characters into control characters
3999 if (event
->modifiers
& ctrl_modifier
)
4000 c
= make_ctrl_char (c
);
4002 /* Add in the other modifier bits. We took care of ctrl_modifier
4003 just above, and the shift key was taken care of by the X code,
4004 and applied to control characters by make_ctrl_char. */
4005 c
|= (event
->modifiers
4006 & (meta_modifier
| alt_modifier
4007 | hyper_modifier
| super_modifier
));
4008 /* Distinguish Shift-SPC from SPC. */
4009 if ((event
->code
& 0377) == 040
4010 && event
->modifiers
& shift_modifier
)
4011 c
|= shift_modifier
;
4012 button_down_time
= 0;
4013 XSETFASTINT (lispy_c
, c
);
4017 /* A function key. The symbol may need to have modifier prefixes
4019 case non_ascii_keystroke
:
4020 button_down_time
= 0;
4022 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
4023 if (event
->code
== lispy_accent_codes
[i
])
4024 return modify_event_symbol (i
,
4026 Qfunction_key
, Qnil
,
4027 lispy_accent_keys
, &accent_key_syms
,
4028 (sizeof (lispy_accent_keys
)
4029 / sizeof (lispy_accent_keys
[0])));
4031 /* Handle system-specific keysyms. */
4032 if (event
->code
& (1 << 28))
4034 /* We need to use an alist rather than a vector as the cache
4035 since we can't make a vector long enuf. */
4036 if (NILP (current_kboard
->system_key_syms
))
4037 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
4038 return modify_event_symbol (event
->code
,
4041 current_kboard
->Vsystem_key_alist
,
4042 0, ¤t_kboard
->system_key_syms
,
4047 if (event
->code
>= 0x400 && event
->code
< 0x500)
4048 return modify_event_symbol (event
->code
- 0x400,
4049 event
->modifiers
& ~shift_modifier
,
4050 Qfunction_key
, Qnil
,
4051 lispy_kana_keys
, &func_key_syms
,
4052 (sizeof (lispy_kana_keys
)
4053 / sizeof (lispy_kana_keys
[0])));
4054 #endif /* XK_kana_A */
4056 #ifdef ISO_FUNCTION_KEY_OFFSET
4057 if (event
->code
< FUNCTION_KEY_OFFSET
4058 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
4059 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
4061 Qfunction_key
, Qnil
,
4062 iso_lispy_function_keys
, &func_key_syms
,
4063 (sizeof (iso_lispy_function_keys
)
4064 / sizeof (iso_lispy_function_keys
[0])));
4067 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
4069 Qfunction_key
, Qnil
,
4070 lispy_function_keys
, &func_key_syms
,
4071 (sizeof (lispy_function_keys
)
4072 / sizeof (lispy_function_keys
[0])));
4075 /* A mouse click. Figure out where it is, decide whether it's
4076 a press, click or drag, and build the appropriate structure. */
4078 case scroll_bar_click
:
4080 int button
= event
->code
;
4082 Lisp_Object position
;
4083 Lisp_Object
*start_pos_ptr
;
4084 Lisp_Object start_pos
;
4086 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
4089 /* Build the position as appropriate for this mouse click. */
4090 if (event
->kind
== mouse_click
)
4093 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
4098 /* Ignore mouse events that were made on frame that
4099 have been deleted. */
4100 if (! FRAME_LIVE_P (f
))
4103 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4104 &column
, &row
, NULL
, 1);
4106 #ifndef USE_X_TOOLKIT
4107 /* In the non-toolkit version, clicks on the menu bar
4108 are ordinary button events in the event buffer.
4109 Distinguish them, and invoke the menu.
4111 (In the toolkit version, the toolkit handles the menu bar
4112 and Emacs doesn't know about it until after the user
4113 makes a selection.) */
4114 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
4115 && (event
->modifiers
& down_modifier
))
4117 Lisp_Object items
, item
;
4122 /* Activate the menu bar on the down event. If the
4123 up event comes in before the menu code can deal with it,
4125 if (! (event
->modifiers
& down_modifier
))
4130 items
= FRAME_MENU_BAR_ITEMS (f
);
4131 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
4133 Lisp_Object pos
, string
;
4134 string
= XVECTOR (items
)->contents
[i
+ 1];
4135 pos
= XVECTOR (items
)->contents
[i
+ 3];
4138 if (column
>= XINT (pos
)
4139 && column
< XINT (pos
) + XSTRING (string
)->size
)
4141 item
= XVECTOR (items
)->contents
[i
];
4147 = Fcons (event
->frame_or_window
,
4149 Fcons (Fcons (event
->x
, event
->y
),
4150 Fcons (make_number (event
->timestamp
),
4153 return Fcons (item
, Fcons (position
, Qnil
));
4155 #endif /* not USE_X_TOOLKIT */
4157 window
= window_from_coordinates (f
, column
, row
, &part
);
4159 if (!WINDOWP (window
))
4161 window
= event
->frame_or_window
;
4166 int pixcolumn
, pixrow
;
4167 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
4168 row
-= XINT (XWINDOW (window
)->top
);
4169 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
4170 XSETINT (event
->x
, pixcolumn
);
4171 XSETINT (event
->y
, pixrow
);
4176 posn
= Qvertical_line
;
4179 buffer_posn_from_coords (XWINDOW (window
),
4186 Fcons (Fcons (event
->x
, event
->y
),
4187 Fcons (make_number (event
->timestamp
),
4193 Lisp_Object portion_whole
;
4196 window
= event
->frame_or_window
;
4197 portion_whole
= Fcons (event
->x
, event
->y
);
4198 part
= *scroll_bar_parts
[(int) event
->part
];
4202 Fcons (Qvertical_scroll_bar
,
4203 Fcons (portion_whole
,
4204 Fcons (make_number (event
->timestamp
),
4205 Fcons (part
, Qnil
)))));
4208 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
4210 start_pos
= *start_pos_ptr
;
4211 *start_pos_ptr
= Qnil
;
4213 is_double
= (button
== last_mouse_button
4214 && XINT (event
->x
) == last_mouse_x
4215 && XINT (event
->y
) == last_mouse_y
4216 && button_down_time
!= 0
4217 && (EQ (Vdouble_click_time
, Qt
)
4218 || (INTEGERP (Vdouble_click_time
)
4219 && ((int)(event
->timestamp
- button_down_time
)
4220 < XINT (Vdouble_click_time
)))));
4221 last_mouse_button
= button
;
4222 last_mouse_x
= XINT (event
->x
);
4223 last_mouse_y
= XINT (event
->y
);
4225 /* If this is a button press, squirrel away the location, so
4226 we can decide later whether it was a click or a drag. */
4227 if (event
->modifiers
& down_modifier
)
4231 double_click_count
++;
4232 event
->modifiers
|= ((double_click_count
> 2)
4237 double_click_count
= 1;
4238 button_down_time
= event
->timestamp
;
4239 *start_pos_ptr
= Fcopy_alist (position
);
4242 /* Now we're releasing a button - check the co-ordinates to
4243 see if this was a click or a drag. */
4244 else if (event
->modifiers
& up_modifier
)
4246 /* If we did not see a down before this up,
4247 ignore the up. Probably this happened because
4248 the down event chose a menu item.
4249 It would be an annoyance to treat the release
4250 of the button that chose the menu item
4251 as a separate event. */
4253 if (!CONSP (start_pos
))
4256 event
->modifiers
&= ~up_modifier
;
4257 #if 0 /* Formerly we treated an up with no down as a click event. */
4258 if (!CONSP (start_pos
))
4259 event
->modifiers
|= click_modifier
;
4263 /* The third element of every position should be the (x,y)
4267 down
= Fnth (make_number (2), start_pos
);
4268 if (EQ (event
->x
, XCONS (down
)->car
)
4269 && EQ (event
->y
, XCONS (down
)->cdr
))
4271 event
->modifiers
|= click_modifier
;
4275 button_down_time
= 0;
4276 event
->modifiers
|= drag_modifier
;
4278 /* Don't check is_double; treat this as multiple
4279 if the down-event was multiple. */
4280 if (double_click_count
> 1)
4281 event
->modifiers
|= ((double_click_count
> 2)
4287 /* Every mouse event should either have the down_modifier or
4288 the up_modifier set. */
4292 /* Get the symbol we should use for the mouse click. */
4295 head
= modify_event_symbol (button
,
4298 lispy_mouse_names
, &mouse_syms
,
4299 (sizeof (lispy_mouse_names
)
4300 / sizeof (lispy_mouse_names
[0])));
4301 if (event
->modifiers
& drag_modifier
)
4306 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
4309 Fcons (make_number (double_click_count
),
4319 case w32_scroll_bar_click
:
4321 int button
= event
->code
;
4323 Lisp_Object position
;
4324 Lisp_Object
*start_pos_ptr
;
4325 Lisp_Object start_pos
;
4327 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
4332 Lisp_Object portion_whole
;
4335 window
= event
->frame_or_window
;
4336 portion_whole
= Fcons (event
->x
, event
->y
);
4337 part
= *scroll_bar_parts
[(int) event
->part
];
4341 Fcons (Qvertical_scroll_bar
,
4342 Fcons (portion_whole
,
4343 Fcons (make_number (event
->timestamp
),
4344 Fcons (part
, Qnil
)))));
4347 /* Always treat W32 scroll bar events as clicks. */
4348 event
->modifiers
|= click_modifier
;
4351 /* Get the symbol we should use for the mouse click. */
4354 head
= modify_event_symbol (button
,
4357 lispy_mouse_names
, &mouse_syms
,
4358 (sizeof (lispy_mouse_names
)
4359 / sizeof (lispy_mouse_names
[0])));
4368 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
4371 Lisp_Object head
, position
;
4374 /* Ignore mouse events that were made on frame that
4375 have been deleted. */
4376 if (! FRAME_LIVE_P (f
))
4378 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4379 &column
, &row
, NULL
, 1);
4380 window
= window_from_coordinates (f
, column
, row
, &part
);
4382 if (!WINDOWP (window
))
4384 window
= event
->frame_or_window
;
4389 int pixcolumn
, pixrow
;
4390 column
-= XINT (XWINDOW (window
)->left
);
4391 row
-= XINT (XWINDOW (window
)->top
);
4392 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
4393 XSETINT (event
->x
, pixcolumn
);
4394 XSETINT (event
->y
, pixrow
);
4399 posn
= Qvertical_line
;
4402 buffer_posn_from_coords (XWINDOW (window
),
4407 Lisp_Object head
, position
;
4412 Fcons (Fcons (event
->x
, event
->y
),
4413 Fcons (make_number (event
->timestamp
),
4416 head
= modify_event_symbol (0, event
->modifiers
,
4418 lispy_mouse_wheel_names
,
4419 &mouse_wheel_syms
, 1);
4422 Fcons (make_number (event
->code
),
4426 #endif /* WINDOWSNT */
4434 Lisp_Object head
, position
;
4438 /* The frame_or_window field should be a cons of the frame in
4439 which the event occurred and a list of the filenames
4441 if (! CONSP (event
->frame_or_window
))
4444 f
= XFRAME (XCONS (event
->frame_or_window
)->car
);
4445 files
= XCONS (event
->frame_or_window
)->cdr
;
4447 /* Ignore mouse events that were made on frames that
4448 have been deleted. */
4449 if (! FRAME_LIVE_P (f
))
4451 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4452 &column
, &row
, NULL
, 1);
4453 window
= window_from_coordinates (f
, column
, row
, &part
);
4455 if (!WINDOWP (window
))
4457 window
= XCONS (event
->frame_or_window
)->car
;
4462 int pixcolumn
, pixrow
;
4463 column
-= XINT (XWINDOW (window
)->left
);
4464 row
-= XINT (XWINDOW (window
)->top
);
4465 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
4466 XSETINT (event
->x
, pixcolumn
);
4467 XSETINT (event
->y
, pixrow
);
4472 posn
= Qvertical_line
;
4475 buffer_posn_from_coords (XWINDOW (window
),
4480 Lisp_Object head
, position
;
4485 Fcons (Fcons (event
->x
, event
->y
),
4486 Fcons (make_number (event
->timestamp
),
4489 head
= modify_event_symbol (0, event
->modifiers
,
4491 lispy_drag_n_drop_names
,
4492 &drag_n_drop_syms
, 1);
4499 #endif /* HAVE_MOUSE */
4501 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
4502 case menu_bar_event
:
4503 /* The event value is in the cdr of the frame_or_window slot. */
4504 if (!CONSP (event
->frame_or_window
))
4506 return XCONS (event
->frame_or_window
)->cdr
;
4509 /* The 'kind' field of the event is something we don't recognize. */
4518 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
4520 Lisp_Object bar_window
;
4521 enum scroll_bar_part part
;
4525 /* Is it a scroll bar movement? */
4526 if (frame
&& ! NILP (bar_window
))
4528 Lisp_Object part_sym
;
4530 part_sym
= *scroll_bar_parts
[(int) part
];
4531 return Fcons (Qscroll_bar_movement
,
4532 (Fcons (Fcons (bar_window
,
4533 Fcons (Qvertical_scroll_bar
,
4534 Fcons (Fcons (x
, y
),
4535 Fcons (make_number (time
),
4541 /* Or is it an ordinary mouse movement? */
4551 /* It's in a frame; which window on that frame? */
4552 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
,
4554 window
= window_from_coordinates (frame
, column
, row
, &area
);
4559 if (WINDOWP (window
))
4561 int pixcolumn
, pixrow
;
4562 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
4563 row
-= XINT (XWINDOW (window
)->top
);
4564 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
4565 XSETINT (x
, pixcolumn
);
4566 XSETINT (y
, pixrow
);
4571 posn
= Qvertical_line
;
4574 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
4576 else if (frame
!= 0)
4578 XSETFRAME (window
, frame
);
4589 return Fcons (Qmouse_movement
,
4590 Fcons (Fcons (window
,
4592 Fcons (Fcons (x
, y
),
4593 Fcons (make_number (time
),
4599 #endif /* HAVE_MOUSE */
4601 /* Construct a switch frame event. */
4603 make_lispy_switch_frame (frame
)
4606 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
4609 /* Manipulating modifiers. */
4611 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
4613 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
4614 SYMBOL's name of the end of the modifiers; the string from this
4615 position is the unmodified symbol name.
4617 This doesn't use any caches. */
4620 parse_modifiers_uncached (symbol
, modifier_end
)
4624 struct Lisp_String
*name
;
4628 CHECK_SYMBOL (symbol
, 1);
4631 name
= XSYMBOL (symbol
)->name
;
4633 for (i
= 0; i
+2 <= STRING_BYTES (name
); )
4635 int this_mod_end
= 0;
4638 /* See if the name continues with a modifier word.
4639 Check that the word appears, but don't check what follows it.
4640 Set this_mod and this_mod_end to record what we find. */
4642 switch (name
->data
[i
])
4644 #define SINGLE_LETTER_MOD(BIT) \
4645 (this_mod_end = i + 1, this_mod = BIT)
4648 SINGLE_LETTER_MOD (alt_modifier
);
4652 SINGLE_LETTER_MOD (ctrl_modifier
);
4656 SINGLE_LETTER_MOD (hyper_modifier
);
4660 SINGLE_LETTER_MOD (meta_modifier
);
4664 SINGLE_LETTER_MOD (shift_modifier
);
4668 SINGLE_LETTER_MOD (super_modifier
);
4671 #undef SINGLE_LETTER_MOD
4674 /* If we found no modifier, stop looking for them. */
4675 if (this_mod_end
== 0)
4678 /* Check there is a dash after the modifier, so that it
4679 really is a modifier. */
4680 if (this_mod_end
>= STRING_BYTES (name
)
4681 || name
->data
[this_mod_end
] != '-')
4684 /* This modifier is real; look for another. */
4685 modifiers
|= this_mod
;
4686 i
= this_mod_end
+ 1;
4689 /* Should we include the `click' modifier? */
4690 if (! (modifiers
& (down_modifier
| drag_modifier
4691 | double_modifier
| triple_modifier
))
4692 && i
+ 7 == STRING_BYTES (name
)
4693 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
4694 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
4695 modifiers
|= click_modifier
;
4703 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
4704 prepended to the string BASE[0..BASE_LEN-1].
4705 This doesn't use any caches. */
4707 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
4710 int base_len
, base_len_byte
;
4712 /* Since BASE could contain nulls, we can't use intern here; we have
4713 to use Fintern, which expects a genuine Lisp_String, and keeps a
4716 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
4722 /* Only the event queue may use the `up' modifier; it should always
4723 be turned into a click or drag event before presented to lisp code. */
4724 if (modifiers
& up_modifier
)
4727 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
4728 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
4729 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
4730 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
4731 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
4732 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
4733 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
4734 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
4735 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
4736 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
4737 /* The click modifier is denoted by the absence of other modifiers. */
4741 mod_len
= p
- new_mods
;
4745 Lisp_Object new_name
;
4747 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
4748 mod_len
+ base_len_byte
);
4749 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
4750 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len_byte
);
4752 return Fintern (new_name
, Qnil
);
4757 static char *modifier_names
[] =
4759 "up", "down", "drag", "click", "double", "triple", 0, 0,
4760 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4761 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
4763 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
4765 static Lisp_Object modifier_symbols
;
4767 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
4769 lispy_modifier_list (modifiers
)
4772 Lisp_Object modifier_list
;
4775 modifier_list
= Qnil
;
4776 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
4777 if (modifiers
& (1<<i
))
4778 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
4781 return modifier_list
;
4785 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
4786 where UNMODIFIED is the unmodified form of SYMBOL,
4787 MASK is the set of modifiers present in SYMBOL's name.
4788 This is similar to parse_modifiers_uncached, but uses the cache in
4789 SYMBOL's Qevent_symbol_element_mask property, and maintains the
4790 Qevent_symbol_elements property. */
4793 parse_modifiers (symbol
)
4796 Lisp_Object elements
;
4798 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
4799 if (CONSP (elements
))
4804 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
4805 Lisp_Object unmodified
;
4808 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
4809 STRING_BYTES (XSYMBOL (symbol
)->name
) - end
),
4812 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
4814 XSETFASTINT (mask
, modifiers
);
4815 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
4817 /* Cache the parsing results on SYMBOL. */
4818 Fput (symbol
, Qevent_symbol_element_mask
,
4820 Fput (symbol
, Qevent_symbol_elements
,
4821 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
4823 /* Since we know that SYMBOL is modifiers applied to unmodified,
4824 it would be nice to put that in unmodified's cache.
4825 But we can't, since we're not sure that parse_modifiers is
4832 /* Apply the modifiers MODIFIERS to the symbol BASE.
4833 BASE must be unmodified.
4835 This is like apply_modifiers_uncached, but uses BASE's
4836 Qmodifier_cache property, if present. It also builds
4837 Qevent_symbol_elements properties, since it has that info anyway.
4839 apply_modifiers copies the value of BASE's Qevent_kind property to
4840 the modified symbol. */
4842 apply_modifiers (modifiers
, base
)
4846 Lisp_Object cache
, index
, entry
, new_symbol
;
4848 /* Mask out upper bits. We don't know where this value's been. */
4849 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
4851 /* The click modifier never figures into cache indices. */
4852 cache
= Fget (base
, Qmodifier_cache
);
4853 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
4854 entry
= assq_no_quit (index
, cache
);
4857 new_symbol
= XCONS (entry
)->cdr
;
4860 /* We have to create the symbol ourselves. */
4861 new_symbol
= apply_modifiers_uncached (modifiers
,
4862 XSYMBOL (base
)->name
->data
,
4863 XSYMBOL (base
)->name
->size
,
4864 STRING_BYTES (XSYMBOL (base
)->name
));
4866 /* Add the new symbol to the base's cache. */
4867 entry
= Fcons (index
, new_symbol
);
4868 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
4870 /* We have the parsing info now for free, so add it to the caches. */
4871 XSETFASTINT (index
, modifiers
);
4872 Fput (new_symbol
, Qevent_symbol_element_mask
,
4873 Fcons (base
, Fcons (index
, Qnil
)));
4874 Fput (new_symbol
, Qevent_symbol_elements
,
4875 Fcons (base
, lispy_modifier_list (modifiers
)));
4878 /* Make sure this symbol is of the same kind as BASE.
4880 You'd think we could just set this once and for all when we
4881 intern the symbol above, but reorder_modifiers may call us when
4882 BASE's property isn't set right; we can't assume that just
4883 because it has a Qmodifier_cache property it must have its
4884 Qevent_kind set right as well. */
4885 if (NILP (Fget (new_symbol
, Qevent_kind
)))
4889 kind
= Fget (base
, Qevent_kind
);
4891 Fput (new_symbol
, Qevent_kind
, kind
);
4898 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
4899 return a symbol with the modifiers placed in the canonical order.
4900 Canonical order is alphabetical, except for down and drag, which
4901 always come last. The 'click' modifier is never written out.
4903 Fdefine_key calls this to make sure that (for example) C-M-foo
4904 and M-C-foo end up being equivalent in the keymap. */
4907 reorder_modifiers (symbol
)
4910 /* It's hopefully okay to write the code this way, since everything
4911 will soon be in caches, and no consing will be done at all. */
4914 parsed
= parse_modifiers (symbol
);
4915 return apply_modifiers ((int) XINT (XCONS (XCONS (parsed
)->cdr
)->car
),
4916 XCONS (parsed
)->car
);
4920 /* For handling events, we often want to produce a symbol whose name
4921 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
4922 to some base, like the name of a function key or mouse button.
4923 modify_event_symbol produces symbols of this sort.
4925 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
4926 is the name of the i'th symbol. TABLE_SIZE is the number of elements
4929 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
4930 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
4932 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
4933 persist between calls to modify_event_symbol that it can use to
4934 store a cache of the symbols it's generated for this NAME_TABLE
4935 before. The object stored there may be a vector or an alist.
4937 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
4939 MODIFIERS is a set of modifier bits (as given in struct input_events)
4940 whose prefixes should be applied to the symbol name.
4942 SYMBOL_KIND is the value to be placed in the event_kind property of
4943 the returned symbol.
4945 The symbols we create are supposed to have an
4946 `event-symbol-elements' property, which lists the modifiers present
4947 in the symbol's name. */
4950 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
4951 name_table
, symbol_table
, table_size
)
4954 Lisp_Object symbol_kind
;
4955 Lisp_Object name_alist
;
4957 Lisp_Object
*symbol_table
;
4958 unsigned int table_size
;
4961 Lisp_Object symbol_int
;
4963 /* Get rid of the "vendor-specific" bit here. */
4964 XSETINT (symbol_int
, symbol_num
& 0xffffff);
4966 /* Is this a request for a valid symbol? */
4967 if (symbol_num
< 0 || symbol_num
>= table_size
)
4970 if (CONSP (*symbol_table
))
4971 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
4973 /* If *symbol_table doesn't seem to be initialized properly, fix that.
4974 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4975 where the Nth element is the symbol for NAME_TABLE[N], or nil if
4976 we've never used that symbol before. */
4979 if (! VECTORP (*symbol_table
)
4980 || XVECTOR (*symbol_table
)->size
!= table_size
)
4984 XSETFASTINT (size
, table_size
);
4985 *symbol_table
= Fmake_vector (size
, Qnil
);
4988 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
4991 /* Have we already used this symbol before? */
4994 /* No; let's create it. */
4995 if (!NILP (name_alist
))
4996 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
4997 else if (name_table
!= 0 && name_table
[symbol_num
])
4998 value
= intern (name_table
[symbol_num
]);
5000 #ifdef HAVE_WINDOW_SYSTEM
5003 char *name
= x_get_keysym_name (symbol_num
);
5005 value
= intern (name
);
5012 sprintf (buf
, "key-%d", symbol_num
);
5013 value
= intern (buf
);
5016 if (CONSP (*symbol_table
))
5017 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
5019 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
5021 /* Fill in the cache entries for this symbol; this also
5022 builds the Qevent_symbol_elements property, which the user
5024 apply_modifiers (modifiers
& click_modifier
, value
);
5025 Fput (value
, Qevent_kind
, symbol_kind
);
5028 /* Apply modifiers to that symbol. */
5029 return apply_modifiers (modifiers
, value
);
5032 /* Convert a list that represents an event type,
5033 such as (ctrl meta backspace), into the usual representation of that
5034 event type as a number or a symbol. */
5036 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
5037 "Convert the event description list EVENT-DESC to an event type.\n\
5038 EVENT-DESC should contain one base event type (a character or symbol)\n\
5039 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
5040 drag, down, double or triple). The base must be last.\n\
5041 The return value is an event type (a character or symbol) which\n\
5042 has the same base event type and all the specified modifiers.")
5044 Lisp_Object event_desc
;
5052 while (CONSP (rest
))
5057 elt
= XCONS (rest
)->car
;
5058 rest
= XCONS (rest
)->cdr
;
5060 /* Given a symbol, see if it is a modifier name. */
5061 if (SYMBOLP (elt
) && CONSP (rest
))
5062 this = parse_solitary_modifier (elt
);
5066 else if (!NILP (base
))
5067 error ("Two bases given in one event");
5073 /* Let the symbol A refer to the character A. */
5074 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
5075 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
5077 if (INTEGERP (base
))
5079 /* Turn (shift a) into A. */
5080 if ((modifiers
& shift_modifier
) != 0
5081 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
5083 XSETINT (base
, XINT (base
) - ('a' - 'A'));
5084 modifiers
&= ~shift_modifier
;
5087 /* Turn (control a) into C-a. */
5088 if (modifiers
& ctrl_modifier
)
5089 return make_number ((modifiers
& ~ctrl_modifier
)
5090 | make_ctrl_char (XINT (base
)));
5092 return make_number (modifiers
| XINT (base
));
5094 else if (SYMBOLP (base
))
5095 return apply_modifiers (modifiers
, base
);
5097 error ("Invalid base event");
5100 /* Try to recognize SYMBOL as a modifier name.
5101 Return the modifier flag bit, or 0 if not recognized. */
5104 parse_solitary_modifier (symbol
)
5107 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
5109 switch (name
->data
[0])
5111 #define SINGLE_LETTER_MOD(BIT) \
5112 if (STRING_BYTES (name) == 1) \
5115 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5116 if (LEN == STRING_BYTES (name) \
5117 && ! strncmp (name->data, NAME, LEN)) \
5121 SINGLE_LETTER_MOD (alt_modifier
);
5125 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
5129 SINGLE_LETTER_MOD (ctrl_modifier
);
5133 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
5134 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
5138 SINGLE_LETTER_MOD (hyper_modifier
);
5142 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
5146 SINGLE_LETTER_MOD (meta_modifier
);
5150 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
5154 SINGLE_LETTER_MOD (shift_modifier
);
5158 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
5159 MULTI_LETTER_MOD (super_modifier
, "super", 5);
5160 SINGLE_LETTER_MOD (super_modifier
);
5164 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5165 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5166 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5170 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5173 #undef SINGLE_LETTER_MOD
5174 #undef MULTI_LETTER_MOD
5180 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
5181 Such a list is not valid as an event,
5182 but it can be a Lucid-style event type list. */
5185 lucid_event_type_list_p (object
)
5190 if (! CONSP (object
))
5193 for (tail
= object
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5196 elt
= XCONS (tail
)->car
;
5197 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
5204 /* Store into *addr a value nonzero if terminal input chars are available.
5205 Serves the purpose of ioctl (0, FIONREAD, addr)
5206 but works even if FIONREAD does not exist.
5207 (In fact, this may actually read some input.)
5209 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
5212 get_input_pending (addr
, do_timers_now
)
5216 /* First of all, have we already counted some input? */
5217 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
5219 /* If input is being read as it arrives, and we have none, there is none. */
5220 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
5223 /* Try to read some input and see how much we get. */
5225 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
5228 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
5231 gobble_input (expected
)
5236 if (interrupt_input
)
5239 mask
= sigblock (sigmask (SIGIO
));
5240 read_avail_input (expected
);
5244 #ifdef POLL_FOR_INPUT
5245 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
5248 mask
= sigblock (sigmask (SIGALRM
));
5249 read_avail_input (expected
);
5255 read_avail_input (expected
);
5259 /* Put a buffer_switch_event in the buffer
5260 so that read_key_sequence will notice the new current buffer. */
5263 record_asynch_buffer_change ()
5265 struct input_event event
;
5268 event
.kind
= buffer_switch_event
;
5269 event
.frame_or_window
= Qnil
;
5272 /* We don't need a buffer-switch event unless Emacs is waiting for input.
5273 The purpose of the event is to make read_key_sequence look up the
5274 keymaps again. If we aren't in read_key_sequence, we don't need one,
5275 and the event could cause trouble by messing up (input-pending-p). */
5276 tem
= Fwaiting_for_user_input_p ();
5280 /* We never need these events if we have no asynchronous subprocesses. */
5284 /* Make sure no interrupt happens while storing the event. */
5286 if (interrupt_input
)
5289 mask
= sigblock (sigmask (SIGIO
));
5290 kbd_buffer_store_event (&event
);
5297 kbd_buffer_store_event (&event
);
5304 /* Read any terminal input already buffered up by the system
5305 into the kbd_buffer, but do not wait.
5307 EXPECTED should be nonzero if the caller knows there is some input.
5309 Except on VMS, all input is read by this function.
5310 If interrupt_input is nonzero, this function MUST be called
5311 only when SIGIO is blocked.
5313 Returns the number of keyboard chars read, or -1 meaning
5314 this is a bad time to try to read input. */
5317 read_avail_input (expected
)
5320 struct input_event buf
[KBD_BUFFER_SIZE
];
5324 if (read_socket_hook
)
5325 /* No need for FIONREAD or fcntl; just say don't wait. */
5326 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
5329 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
5330 the kbd_buffer can really hold. That may prevent loss
5331 of characters on some systems when input is stuffed at us. */
5332 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
5335 /* Determine how many characters we should *try* to read. */
5338 #else /* not WINDOWSNT */
5340 n_to_read
= dos_keysns ();
5343 #else /* not MSDOS */
5345 /* Find out how much input is available. */
5346 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
5347 /* Formerly simply reported no input, but that sometimes led to
5348 a failure of Emacs to terminate.
5349 SIGHUP seems appropriate if we can't reach the terminal. */
5350 /* ??? Is it really right to send the signal just to this process
5351 rather than to the whole process group?
5352 Perhaps on systems with FIONREAD Emacs is alone in its group. */
5353 kill (getpid (), SIGHUP
);
5356 if (n_to_read
> sizeof cbuf
)
5357 n_to_read
= sizeof cbuf
;
5358 #else /* no FIONREAD */
5359 #if defined (USG) || defined (DGUX)
5360 /* Read some input if available, but don't wait. */
5361 n_to_read
= sizeof cbuf
;
5362 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
5367 #endif /* not MSDOS */
5368 #endif /* not WINDOWSNT */
5370 /* Now read; for one reason or another, this will not block.
5371 NREAD is set to the number of chars read. */
5375 cbuf
[0] = dos_keyread ();
5378 nread
= read (input_fd
, cbuf
, n_to_read
);
5380 /* POSIX infers that processes which are not in the session leader's
5381 process group won't get SIGHUP's at logout time. BSDI adheres to
5382 this part standard and returns -1 from read (0) with errno==EIO
5383 when the control tty is taken away.
5384 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
5385 if (nread
== -1 && errno
== EIO
)
5387 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
5388 /* The kernel sometimes fails to deliver SIGHUP for ptys.
5389 This looks incorrect, but it isn't, because _BSD causes
5390 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
5391 and that causes a value other than 0 when there is no input. */
5397 /* We used to retry the read if it was interrupted.
5398 But this does the wrong thing when O_NDELAY causes
5399 an EAGAIN error. Does anybody know of a situation
5400 where a retry is actually needed? */
5402 nread
< 0 && (errno
== EAGAIN
5416 #if defined (USG) || defined (DGUX)
5417 fcntl (input_fd
, F_SETFL
, 0);
5418 #endif /* USG or DGUX */
5419 #endif /* no FIONREAD */
5420 for (i
= 0; i
< nread
; i
++)
5422 buf
[i
].kind
= ascii_keystroke
;
5423 buf
[i
].modifiers
= 0;
5424 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
5425 buf
[i
].modifiers
= meta_modifier
;
5429 buf
[i
].code
= cbuf
[i
];
5430 XSETFRAME (buf
[i
].frame_or_window
, selected_frame
);
5434 /* Scan the chars for C-g and store them in kbd_buffer. */
5435 for (i
= 0; i
< nread
; i
++)
5437 kbd_buffer_store_event (&buf
[i
]);
5438 /* Don't look at input that follows a C-g too closely.
5439 This reduces lossage due to autorepeat on C-g. */
5440 if (buf
[i
].kind
== ascii_keystroke
5441 && buf
[i
].code
== quit_char
)
5447 #endif /* not VMS */
5449 #ifdef SIGIO /* for entire page */
5450 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5453 input_available_signal (signo
)
5456 /* Must preserve main program's value of errno. */
5457 int old_errno
= errno
;
5459 extern int select_alarmed
;
5462 #if defined (USG) && !defined (POSIX_SIGNALS)
5463 /* USG systems forget handlers when they are used;
5464 must reestablish each time */
5465 signal (signo
, input_available_signal
);
5472 if (input_available_clear_time
)
5473 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
5478 nread
= read_avail_input (1);
5479 /* -1 means it's not ok to read the input now.
5480 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
5481 0 means there was no keyboard input available. */
5486 select_alarmed
= 1; /* Force the select emulator back to life */
5497 /* Send ourselves a SIGIO.
5499 This function exists so that the UNBLOCK_INPUT macro in
5500 blockinput.h can have some way to take care of input we put off
5501 dealing with, without assuming that every file which uses
5502 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
5504 reinvoke_input_signal ()
5507 kill (getpid (), SIGIO
);
5513 /* Return the prompt-string of a sparse keymap.
5514 This is the first element which is a string.
5515 Return nil if there is none. */
5523 register Lisp_Object tem
;
5532 static void menu_bar_item ();
5533 static void menu_bar_one_keymap ();
5535 /* These variables hold the vector under construction within
5536 menu_bar_items and its subroutines, and the current index
5537 for storing into that vector. */
5538 static Lisp_Object menu_bar_items_vector
;
5539 static int menu_bar_items_index
;
5541 /* Return a vector of menu items for a menu bar, appropriate
5542 to the current buffer. Each item has three elements in the vector:
5545 OLD is an old vector we can optionally reuse, or nil. */
5548 menu_bar_items (old
)
5551 /* The number of keymaps we're scanning right now, and the number of
5552 keymaps we have allocated space for. */
5555 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5556 in the current keymaps, or nil where it is not a prefix. */
5559 Lisp_Object def
, tem
, tail
;
5568 struct gcpro gcpro1
;
5570 /* In order to build the menus, we need to call the keymap
5571 accessors. They all call QUIT. But this function is called
5572 during redisplay, during which a quit is fatal. So inhibit
5573 quitting while building the menus.
5574 We do this instead of specbind because (1) errors will clear it anyway
5575 and (2) this avoids risk of specpdl overflow. */
5576 oquit
= Vinhibit_quit
;
5580 menu_bar_items_vector
= old
;
5582 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
5583 menu_bar_items_index
= 0;
5585 GCPRO1 (menu_bar_items_vector
);
5587 /* Build our list of keymaps.
5588 If we recognize a function key and replace its escape sequence in
5589 keybuf with its symbol, or if the sequence starts with a mouse
5590 click and we need to switch buffers, we jump back here to rebuild
5591 the initial keymaps from the current buffer. */
5595 /* Should overriding-terminal-local-map and overriding-local-map apply? */
5596 if (!NILP (Voverriding_local_map_menu_flag
))
5598 /* Yes, use them (if non-nil) as well as the global map. */
5599 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
5601 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5602 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5603 if (!NILP (Voverriding_local_map
))
5604 maps
[nmaps
++] = Voverriding_local_map
;
5608 /* No, so use major and minor mode keymaps. */
5609 nmaps
= current_minor_maps (NULL
, &tmaps
);
5610 maps
= (Lisp_Object
*) alloca ((nmaps
+ 2) * sizeof (maps
[0]));
5611 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
5612 #ifdef USE_TEXT_PROPERTIES
5613 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
5615 maps
[nmaps
++] = current_buffer
->keymap
;
5618 maps
[nmaps
++] = current_global_map
;
5621 /* Look up in each map the dummy prefix key `menu-bar'. */
5625 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
5627 if (! NILP (maps
[mapno
]))
5628 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0), 0);
5632 tem
= Fkeymapp (def
);
5634 menu_bar_one_keymap (def
);
5637 /* Move to the end those items that should be at the end. */
5639 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5642 int end
= menu_bar_items_index
;
5644 for (i
= 0; i
< end
; i
+= 4)
5645 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5647 Lisp_Object tem0
, tem1
, tem2
, tem3
;
5648 /* Move the item at index I to the end,
5649 shifting all the others forward. */
5650 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
5651 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
5652 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5653 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
5655 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5656 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5657 (end
- i
- 4) * sizeof (Lisp_Object
));
5658 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
5659 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
5660 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
5661 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
5666 /* Add nil, nil, nil, nil at the end. */
5667 i
= menu_bar_items_index
;
5668 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5671 int newsize
= 2 * i
;
5672 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5673 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5674 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5675 menu_bar_items_vector
= tem
;
5677 /* Add this item. */
5678 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5679 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5680 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5681 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5682 menu_bar_items_index
= i
;
5684 Vinhibit_quit
= oquit
;
5686 return menu_bar_items_vector
;
5689 /* Scan one map KEYMAP, accumulating any menu items it defines
5690 in menu_bar_items_vector. */
5693 menu_bar_one_keymap (keymap
)
5696 Lisp_Object tail
, item
, table
;
5698 /* Loop over all keymap entries that have menu strings. */
5699 for (tail
= keymap
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5701 item
= XCONS (tail
)->car
;
5703 menu_bar_item (XCONS (item
)->car
, XCONS (item
)->cdr
);
5704 else if (VECTORP (item
))
5706 /* Loop over the char values represented in the vector. */
5707 int len
= XVECTOR (item
)->size
;
5709 for (c
= 0; c
< len
; c
++)
5711 Lisp_Object character
;
5712 XSETFASTINT (character
, c
);
5713 menu_bar_item (character
, XVECTOR (item
)->contents
[c
]);
5719 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
5720 If there's already an item for KEY, add this DEF to it. */
5722 Lisp_Object item_properties
;
5725 menu_bar_item (key
, item
)
5726 Lisp_Object key
, item
;
5728 struct gcpro gcpro1
;
5731 if (EQ (item
, Qundefined
))
5733 /* If a map has an explicit `undefined' as definition,
5734 discard any previously made menu bar item. */
5736 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5737 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5739 if (menu_bar_items_index
> i
+ 4)
5740 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5741 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5742 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
5743 menu_bar_items_index
-= 4;
5747 /* If there's no definition for this key yet,
5748 just ignore `undefined'. */
5752 GCPRO1 (key
); /* Is this necessary? */
5753 i
= parse_menu_item (item
, 0, 1);
5758 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
5760 /* Find any existing item for this KEY. */
5761 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5762 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5765 /* If we did not find this KEY, add it at the end. */
5766 if (i
== menu_bar_items_index
)
5768 /* If vector is too small, get a bigger one. */
5769 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5772 int newsize
= 2 * i
;
5773 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5774 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5775 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5776 menu_bar_items_vector
= tem
;
5779 /* Add this item. */
5780 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
5781 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
5782 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
5783 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
5784 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
5785 menu_bar_items_index
= i
;
5787 /* We did find an item for this KEY. Add ITEM to its list of maps. */
5791 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5792 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (item
, old
);
5796 /* This is used as the handler when calling menu_item_eval_property. */
5798 menu_item_eval_property_1 (arg
)
5801 /* If we got a quit from within the menu computation,
5802 quit all the way out of it. This takes care of C-] in the debugger. */
5803 if (CONSP (arg
) && EQ (XCONS (arg
)->car
, Qquit
))
5804 Fsignal (Qquit
, Qnil
);
5809 /* Evaluate an expression and return the result (or nil if something
5810 went wrong). Used to evaluate dynamic parts of menu items. */
5812 menu_item_eval_property (sexpr
)
5815 int count
= specpdl_ptr
- specpdl
;
5817 specbind (Qinhibit_redisplay
, Qt
);
5818 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
5819 menu_item_eval_property_1
);
5820 return unbind_to (count
, val
);
5823 /* This function parses a menu item and leaves the result in the
5824 vector item_properties.
5825 ITEM is a key binding, a possible menu item.
5826 If NOTREAL is nonzero, only check for equivalent key bindings, don't
5827 evaluate dynamic expressions in the menu item.
5828 INMENUBAR is > 0 when this is considered for an entry in a menu bar
5830 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
5831 parse_menu_item returns true if the item is a menu item and false
5835 parse_menu_item (item
, notreal
, inmenubar
)
5837 int notreal
, inmenubar
;
5839 Lisp_Object def
, tem
, item_string
, start
;
5840 Lisp_Object cachelist
;
5842 Lisp_Object keyhint
;
5853 /* Create item_properties vector if necessary. */
5854 if (NILP (item_properties
))
5856 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
5858 /* Initialize optional entries. */
5859 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
5860 XVECTOR (item_properties
)->contents
[i
] = Qnil
;
5861 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
] = Qt
;
5863 /* Save the item here to protect it from GC. */
5864 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ITEM
] = item
;
5866 item_string
= XCONS (item
)->car
;
5869 item
= XCONS (item
)->cdr
;
5870 if (STRINGP (item_string
))
5872 /* Old format menu item. */
5873 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
] = item_string
;
5875 /* Maybe help string. */
5876 if (CONSP (item
) && STRINGP (XCONS (item
)->car
))
5878 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_HELP
]
5879 = XCONS (item
)->car
;
5881 item
= XCONS (item
)->cdr
;
5884 /* Maybee key binding cache. */
5885 if (CONSP (item
) && CONSP (XCONS (item
)->car
)
5886 && (NILP (XCONS (XCONS (item
)->car
)->car
)
5887 || VECTORP (XCONS (XCONS (item
)->car
)->car
)))
5889 cachelist
= XCONS (item
)->car
;
5890 item
= XCONS (item
)->cdr
;
5893 /* This is the real definition--the function to run. */
5894 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
] = item
;
5896 /* Get enable property, if any. */
5899 tem
= Fget (item
, Qmenu_enable
);
5901 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
] = tem
;
5904 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
5906 /* New format menu item. */
5907 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
]
5908 = XCONS (item
)->car
;
5909 start
= XCONS (item
)->cdr
;
5912 /* We have a real binding. */
5913 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
]
5914 = XCONS (start
)->car
;
5916 item
= XCONS (start
)->cdr
;
5917 /* Is there a cache list with key equivalences. */
5918 if (CONSP (item
) && CONSP (XCONS (item
)->car
))
5920 cachelist
= XCONS (item
)->car
;
5921 item
= XCONS (item
)->cdr
;
5924 /* Parse properties. */
5925 while (CONSP (item
) && CONSP (XCONS (item
)->cdr
))
5927 tem
= XCONS (item
)->car
;
5928 item
= XCONS (item
)->cdr
;
5930 if (EQ (tem
, QCenable
))
5931 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
]
5932 = XCONS (item
)->car
;
5933 else if (EQ (tem
, QCvisible
) && !notreal
)
5935 /* If got a visible property and that evaluates to nil
5936 then ignore this item. */
5937 tem
= menu_item_eval_property (XCONS (item
)->car
);
5941 else if (EQ (tem
, QChelp
))
5942 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_HELP
]
5943 = XCONS (item
)->car
;
5944 else if (EQ (tem
, QCfilter
))
5946 else if (EQ (tem
, QCkey_sequence
))
5948 tem
= XCONS (item
)->car
;
5949 if (NILP (cachelist
)
5950 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
5951 /* Be GC protected. Set keyhint to item instead of tem. */
5954 else if (EQ (tem
, QCkeys
))
5956 tem
= XCONS (item
)->car
;
5957 if (CONSP (tem
) || STRINGP (tem
) && NILP (cachelist
))
5958 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
]
5961 else if (EQ (tem
, QCbutton
) && CONSP (XCONS (item
)->car
))
5964 tem
= XCONS (item
)->car
;
5965 type
= XCONS (tem
)->car
;
5966 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
5968 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
]
5970 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
]
5974 item
= XCONS (item
)->cdr
;
5977 else if (inmenubar
|| !NILP (start
))
5981 return 0; /* not a menu item */
5983 /* If item string is not a string, evaluate it to get string.
5984 If we don't get a string, skip this item. */
5985 item_string
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
5986 if (!(STRINGP (item_string
) || notreal
))
5988 item_string
= menu_item_eval_property (item_string
);
5989 if (!STRINGP (item_string
))
5991 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
] = item_string
;
5994 /* If got a filter apply it on definition. */
5995 def
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
5998 def
= menu_item_eval_property (list2 (XCONS (filter
)->car
,
5999 list2 (Qquote
, def
)));
6001 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
] = def
;
6004 /* If we got no definition, this item is just unselectable text which
6005 is OK in a submenu but not in the menubar. */
6007 return (inmenubar
? 0 : 1);
6009 /* Enable or disable selection of item. */
6010 tem
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
];
6016 tem
= menu_item_eval_property (tem
);
6017 if (inmenubar
&& NILP (tem
))
6018 return 0; /* Ignore disabled items in menu bar. */
6019 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
] = tem
;
6022 /* See if this is a separate pane or a submenu. */
6023 def
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6024 tem
= get_keymap_1 (def
, 0, 1);
6025 /* For a subkeymap, just record its details and exit. */
6028 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_MAP
] = tem
;
6029 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
] = tem
;
6032 /* At the top level in the menu bar, do likewise for commands also.
6033 The menu bar does not display equivalent key bindings anyway.
6034 ITEM_PROPERTY_DEF is already set up properly. */
6038 /* This is a command. See if there is an equivalent key binding. */
6039 if (NILP (cachelist
))
6041 /* We have to create a cachelist. */
6042 CHECK_IMPURE (start
);
6043 XCONS (start
)->cdr
= Fcons (Fcons (Qnil
, Qnil
), XCONS (start
)->cdr
);
6044 cachelist
= XCONS (XCONS (start
)->cdr
)->car
;
6046 tem
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
6047 if (!NILP (keyhint
))
6049 XCONS (cachelist
)->car
= XCONS (keyhint
)->car
;
6052 else if (STRINGP (tem
))
6054 XCONS (cachelist
)->cdr
= Fsubstitute_command_keys (tem
);
6055 XCONS (cachelist
)->car
= Qt
;
6058 tem
= XCONS (cachelist
)->car
;
6065 tem
= Fkey_binding (tem
, Qnil
);
6067 prefix
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
6070 def
= XCONS (prefix
)->car
;
6071 prefix
= XCONS (prefix
)->cdr
;
6074 def
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6076 if (NILP (XCONS (cachelist
)->car
)) /* Have no saved key. */
6078 if (newcache
/* Always check first time. */
6079 /* Should we check everything when precomputing key
6082 /* If something had no key binding before, don't recheck it
6083 because that is too slow--except if we have a list of
6084 rebound commands in Vdefine_key_rebound_commands, do
6085 recheck any command that appears in that list. */
6086 || (CONSP (Vdefine_key_rebound_commands
)
6087 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
6090 /* We had a saved key. Is it still bound to the command? */
6093 /* If the command is an alias for another
6094 (such as lmenu.el set it up), check if the
6095 original command matches the cached command. */
6096 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
)))
6097 chkcache
= 1; /* Need to recompute key binding. */
6101 /* Recompute equivalent key binding. If the command is an alias
6102 for another (such as lmenu.el set it up), see if the original
6103 command name has equivalent keys. Otherwise look up the
6104 specified command itself. We don't try both, because that
6105 makes lmenu menus slow. */
6106 if (SYMBOLP (def
) && SYMBOLP (XSYMBOL (def
)->function
)
6107 && ! NILP (Fget (def
, Qmenu_alias
)))
6108 def
= XSYMBOL (def
)->function
;
6109 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
);
6110 XCONS (cachelist
)->car
= tem
;
6113 XCONS (cachelist
)->cdr
= Qnil
;
6117 else if (!NILP (keyhint
) && !NILP (XCONS (cachelist
)->car
))
6119 tem
= XCONS (cachelist
)->car
;
6123 newcache
= chkcache
;
6126 tem
= Fkey_description (tem
);
6129 if (STRINGP (XCONS (prefix
)->car
))
6130 tem
= concat2 (XCONS (prefix
)->car
, tem
);
6131 if (STRINGP (XCONS (prefix
)->cdr
))
6132 tem
= concat2 (tem
, XCONS (prefix
)->cdr
);
6134 XCONS (cachelist
)->cdr
= tem
;
6138 tem
= XCONS (cachelist
)->cdr
;
6139 if (newcache
&& !NILP (tem
))
6141 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
6142 XCONS (cachelist
)->cdr
= tem
;
6145 /* If we only want to precompute equivalent key bindings, stop here. */
6149 /* If we have an equivalent key binding, use that. */
6150 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
] = tem
;
6152 /* Include this when menu help is implemented.
6153 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
6154 if (!(NILP (tem) || STRINGP (tem)))
6156 tem = menu_item_eval_property (tem);
6159 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
6163 /* Handle radio buttons or toggle boxes. */
6164 tem
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
6166 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
]
6167 = menu_item_eval_property (tem
);
6172 /* Read a character using menus based on maps in the array MAPS.
6173 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
6174 Return t if we displayed a menu but the user rejected it.
6176 PREV_EVENT is the previous input event, or nil if we are reading
6177 the first event of a key sequence.
6179 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
6180 if we used a mouse menu to read the input, or zero otherwise. If
6181 USED_MOUSE_MENU is null, we don't dereference it.
6183 The prompting is done based on the prompt-string of the map
6184 and the strings associated with various map elements.
6186 This can be done with X menus or with menus put in the minibuf.
6187 These are done in different ways, depending on how the input will be read.
6188 Menus using X are done after auto-saving in read-char, getting the input
6189 event from Fx_popup_menu; menus using the minibuf use read_char recursively
6190 and do auto-saving in the inner call of read_char. */
6193 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
6196 Lisp_Object prev_event
;
6197 int *used_mouse_menu
;
6200 register Lisp_Object name
;
6201 Lisp_Object rest
, vector
;
6203 if (used_mouse_menu
)
6204 *used_mouse_menu
= 0;
6206 /* Use local over global Menu maps */
6208 if (! menu_prompting
)
6211 /* Optionally disregard all but the global map. */
6212 if (inhibit_local_menu_bar_menus
)
6214 maps
+= (nmaps
- 1);
6218 /* Get the menu name from the first map that has one (a prompt string). */
6219 for (mapno
= 0; mapno
< nmaps
; mapno
++)
6221 name
= map_prompt (maps
[mapno
]);
6226 /* If we don't have any menus, just read a character normally. */
6231 /* If we got to this point via a mouse click,
6232 use a real menu for mouse selection. */
6233 if (EVENT_HAS_PARAMETERS (prev_event
)
6234 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
))
6236 /* Display the menu and get the selection. */
6237 Lisp_Object
*realmaps
6238 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
6242 /* Use the maps that are not nil. */
6243 for (mapno
= 0; mapno
< nmaps
; mapno
++)
6244 if (!NILP (maps
[mapno
]))
6245 realmaps
[nmaps1
++] = maps
[mapno
];
6247 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
6252 record_menu_key (XCONS (value
)->car
);
6254 /* If we got multiple events, unread all but
6256 There is no way to prevent those unread events
6257 from showing up later in last_nonmenu_event.
6258 So turn symbol and integer events into lists,
6259 to indicate that they came from a mouse menu,
6260 so that when present in last_nonmenu_event
6261 they won't confuse things. */
6262 for (tem
= XCONS (value
)->cdr
; !NILP (tem
);
6263 tem
= XCONS (tem
)->cdr
)
6265 record_menu_key (XCONS (tem
)->car
);
6266 if (SYMBOLP (XCONS (tem
)->car
)
6267 || INTEGERP (XCONS (tem
)->car
))
6269 = Fcons (XCONS (tem
)->car
, Qnil
);
6272 /* If we got more than one event, put all but the first
6273 onto this list to be read later.
6274 Return just the first event now. */
6275 Vunread_command_events
6276 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
6277 value
= XCONS (value
)->car
;
6279 else if (NILP (value
))
6281 if (used_mouse_menu
)
6282 *used_mouse_menu
= 1;
6285 #endif /* HAVE_MENUS */
6289 /* Buffer in use so far for the minibuf prompts for menu keymaps.
6290 We make this bigger when necessary, and never free it. */
6291 static char *read_char_minibuf_menu_text
;
6292 /* Size of that buffer. */
6293 static int read_char_minibuf_menu_width
;
6296 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
6302 register Lisp_Object name
;
6304 int width
= FRAME_WIDTH (selected_frame
) - 4;
6307 Lisp_Object rest
, vector
;
6310 if (! menu_prompting
)
6313 /* Make sure we have a big enough buffer for the menu text. */
6314 if (read_char_minibuf_menu_text
== 0)
6316 read_char_minibuf_menu_width
= width
+ 4;
6317 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
6319 else if (width
+ 4 > read_char_minibuf_menu_width
)
6321 read_char_minibuf_menu_width
= width
+ 4;
6322 read_char_minibuf_menu_text
6323 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
6325 menu
= read_char_minibuf_menu_text
;
6327 /* Get the menu name from the first map that has one (a prompt string). */
6328 for (mapno
= 0; mapno
< nmaps
; mapno
++)
6330 name
= map_prompt (maps
[mapno
]);
6335 /* If we don't have any menus, just read a character normally. */
6339 /* Prompt string always starts with map's prompt, and a space. */
6340 strcpy (menu
, XSTRING (name
)->data
);
6341 nlength
= STRING_BYTES (XSTRING (name
));
6342 menu
[nlength
++] = ':';
6343 menu
[nlength
++] = ' ';
6346 /* Start prompting at start of first map. */
6350 /* Present the documented bindings, a line at a time. */
6357 Lisp_Object orig_defn_macro
;
6359 /* Loop over elements of map. */
6364 /* If reached end of map, start at beginning of next map. */
6368 /* At end of last map, wrap around to first map if just starting,
6369 or end this line if already have something on it. */
6373 if (notfirst
|| nobindings
) break;
6378 /* Look at the next element of the map. */
6380 elt
= XVECTOR (vector
)->contents
[idx
];
6382 elt
= Fcar_safe (rest
);
6384 if (idx
< 0 && VECTORP (elt
))
6386 /* If we found a dense table in the keymap,
6387 advanced past it, but start scanning its contents. */
6388 rest
= Fcdr_safe (rest
);
6394 /* An ordinary element. */
6395 Lisp_Object event
, tem
;
6399 event
= Fcar_safe (elt
); /* alist */
6400 elt
= Fcdr_safe (elt
);
6404 XSETINT (event
, idx
); /* vector */
6407 /* Ignore the element if it has no prompt string. */
6408 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
6410 /* 1 if the char to type matches the string. */
6412 Lisp_Object upcased_event
, downcased_event
;
6415 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
6417 upcased_event
= Fupcase (event
);
6418 downcased_event
= Fdowncase (event
);
6419 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
6420 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
6422 desc
= Fsingle_key_description (event
);
6425 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
6427 /* Insert equivalent keybinding. */
6428 s
= concat2 (s
, tem
);
6431 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
6432 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
6434 /* Insert button prefix. */
6435 Lisp_Object selected
6436 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
6437 if (EQ (tem
, QCradio
))
6438 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
6440 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
6441 s
= concat2 (tem
, s
);
6445 /* If we have room for the prompt string, add it to this line.
6446 If this is the first on the line, always add it. */
6447 if ((XSTRING (s
)->size
+ i
+ 2
6448 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
6454 /* Punctuate between strings. */
6457 strcpy (menu
+ i
, ", ");
6463 /* If the char to type doesn't match the string's
6464 first char, explicitly show what char to type. */
6467 /* Add as much of string as fits. */
6468 thiswidth
= XSTRING (desc
)->size
;
6469 if (thiswidth
+ i
> width
)
6470 thiswidth
= width
- i
;
6471 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
6473 strcpy (menu
+ i
, " = ");
6477 /* Add as much of string as fits. */
6478 thiswidth
= XSTRING (s
)->size
;
6479 if (thiswidth
+ i
> width
)
6480 thiswidth
= width
- i
;
6481 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
6487 /* If this element does not fit, end the line now,
6488 and save the element for the next line. */
6489 strcpy (menu
+ i
, "...");
6494 /* Move past this element. */
6495 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
6496 /* Handle reaching end of dense table. */
6501 rest
= Fcdr_safe (rest
);
6505 /* Prompt with that and read response. */
6506 message2_nolog (menu
, strlen (menu
),
6507 ! NILP (current_buffer
->enable_multibyte_characters
));
6509 /* Make believe its not a keyboard macro in case the help char
6510 is pressed. Help characters are not recorded because menu prompting
6511 is not used on replay.
6513 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
6514 current_kboard
->defining_kbd_macro
= Qnil
;
6516 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
6517 while (BUFFERP (obj
));
6518 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
6520 if (!INTEGERP (obj
))
6525 if (! EQ (obj
, menu_prompt_more_char
)
6526 && (!INTEGERP (menu_prompt_more_char
)
6527 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
6529 if (!NILP (current_kboard
->defining_kbd_macro
))
6530 store_kbd_macro_char (obj
);
6533 /* Help char - go round again */
6537 /* Reading key sequences. */
6539 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
6540 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
6541 keymap, or nil otherwise. Return the index of the first keymap in
6542 which KEY has any binding, or NMAPS if no map has a binding.
6544 If KEY is a meta ASCII character, treat it like meta-prefix-char
6545 followed by the corresponding non-meta character. Keymaps in
6546 CURRENT with non-prefix bindings for meta-prefix-char become nil in
6549 If KEY has no bindings in any of the CURRENT maps, NEXT is left
6552 NEXT may be the same array as CURRENT. */
6555 follow_key (key
, nmaps
, current
, defs
, next
)
6557 Lisp_Object
*current
, *defs
, *next
;
6560 int i
, first_binding
;
6563 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
6564 followed by the corresponding non-meta character.
6565 Put the results into DEFS, since we are going to alter that anyway.
6566 Do not alter CURRENT or NEXT. */
6567 if (INTEGERP (key
) && (XINT (key
) & CHAR_META
))
6569 for (i
= 0; i
< nmaps
; i
++)
6570 if (! NILP (current
[i
]))
6573 def
= get_keyelt (access_keymap (current
[i
],
6574 meta_prefix_char
, 1, 0), 0);
6576 /* Note that since we pass the resulting bindings through
6577 get_keymap_1, non-prefix bindings for meta-prefix-char
6579 defs
[i
] = get_keymap_1 (def
, 0, 1);
6585 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
6588 first_binding
= nmaps
;
6589 for (i
= nmaps
- 1; i
>= 0; i
--)
6591 if (! NILP (current
[i
]))
6599 defs
[i
] = get_keyelt (access_keymap (map
, key
, 1, 0), 0);
6600 if (! NILP (defs
[i
]))
6607 /* Given the set of bindings we've found, produce the next set of maps. */
6608 if (first_binding
< nmaps
)
6609 for (i
= 0; i
< nmaps
; i
++)
6610 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
6612 return first_binding
;
6615 /* Read a sequence of keys that ends with a non prefix character,
6616 storing it in KEYBUF, a buffer of size BUFSIZE.
6618 Return the length of the key sequence stored.
6619 Return -1 if the user rejected a command menu.
6621 Echo starting immediately unless `prompt' is 0.
6623 Where a key sequence ends depends on the currently active keymaps.
6624 These include any minor mode keymaps active in the current buffer,
6625 the current buffer's local map, and the global map.
6627 If a key sequence has no other bindings, we check Vfunction_key_map
6628 to see if some trailing subsequence might be the beginning of a
6629 function key's sequence. If so, we try to read the whole function
6630 key, and substitute its symbolic name into the key sequence.
6632 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
6633 `double-' events into similar click events, if that would make them
6634 bound. We try to turn `triple-' events first into `double-' events,
6637 If we get a mouse click in a mode line, vertical divider, or other
6638 non-text area, we treat the click as if it were prefixed by the
6639 symbol denoting that area - `mode-line', `vertical-line', or
6642 If the sequence starts with a mouse click, we read the key sequence
6643 with respect to the buffer clicked on, not the current buffer.
6645 If the user switches frames in the midst of a key sequence, we put
6646 off the switch-frame event until later; the next call to
6647 read_char will return it.
6649 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
6650 from the selected window's buffer. */
6653 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
6654 can_return_switch_frame
, fix_current_buffer
)
6655 Lisp_Object
*keybuf
;
6658 int dont_downcase_last
;
6659 int can_return_switch_frame
;
6660 int fix_current_buffer
;
6662 int count
= specpdl_ptr
- specpdl
;
6664 /* How many keys there are in the current key sequence. */
6667 /* The length of the echo buffer when we started reading, and
6668 the length of this_command_keys when we started reading. */
6672 /* The number of keymaps we're scanning right now, and the number of
6673 keymaps we have allocated space for. */
6675 int nmaps_allocated
= 0;
6677 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
6678 the current keymaps. */
6681 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6682 in the current keymaps, or nil where it is not a prefix. */
6683 Lisp_Object
*submaps
;
6685 /* The local map to start out with at start of key sequence. */
6686 Lisp_Object orig_local_map
;
6688 /* 1 if we have already considered switching to the local-map property
6689 of the place where a mouse click occurred. */
6690 int localized_local_map
= 0;
6692 /* The index in defs[] of the first keymap that has a binding for
6693 this key sequence. In other words, the lowest i such that
6694 defs[i] is non-nil. */
6697 /* If t < mock_input, then KEYBUF[t] should be read as the next
6700 We use this to recover after recognizing a function key. Once we
6701 realize that a suffix of the current key sequence is actually a
6702 function key's escape sequence, we replace the suffix with the
6703 function key's binding from Vfunction_key_map. Now keybuf
6704 contains a new and different key sequence, so the echo area,
6705 this_command_keys, and the submaps and defs arrays are wrong. In
6706 this situation, we set mock_input to t, set t to 0, and jump to
6707 restart_sequence; the loop will read keys from keybuf up until
6708 mock_input, thus rebuilding the state; and then it will resume
6709 reading characters from the keyboard. */
6712 /* If the sequence is unbound in submaps[], then
6713 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
6714 and fkey_map is its binding.
6716 These might be > t, indicating that all function key scanning
6717 should hold off until t reaches them. We do this when we've just
6718 recognized a function key, to avoid searching for the function
6719 key's again in Vfunction_key_map. */
6720 int fkey_start
= 0, fkey_end
= 0;
6721 Lisp_Object fkey_map
;
6723 /* Likewise, for key_translation_map. */
6724 int keytran_start
= 0, keytran_end
= 0;
6725 Lisp_Object keytran_map
;
6727 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
6728 we put it off for later. While we're reading, we keep the event here. */
6729 Lisp_Object delayed_switch_frame
;
6731 /* See the comment below... */
6732 #if defined (GOBBLE_FIRST_EVENT)
6733 Lisp_Object first_event
;
6736 Lisp_Object original_uppercase
;
6737 int original_uppercase_position
= -1;
6739 /* Gets around Microsoft compiler limitations. */
6742 struct buffer
*starting_buffer
;
6744 /* Nonzero if we seem to have got the beginning of a binding
6745 in function_key_map. */
6746 int function_key_possible
= 0;
6747 int key_translation_possible
= 0;
6749 /* Save the status of key translation before each step,
6750 so that we can restore this after downcasing. */
6751 Lisp_Object prev_fkey_map
;
6752 int prev_fkey_start
;
6755 Lisp_Object prev_keytran_map
;
6756 int prev_keytran_start
;
6757 int prev_keytran_end
;
6761 raw_keybuf_count
= 0;
6763 last_nonmenu_event
= Qnil
;
6765 delayed_switch_frame
= Qnil
;
6766 fkey_map
= Vfunction_key_map
;
6767 keytran_map
= Vkey_translation_map
;
6769 /* If there is no function-key-map, turn off function key scanning. */
6770 if (NILP (Fkeymapp (Vfunction_key_map
)))
6771 fkey_start
= fkey_end
= bufsize
+ 1;
6773 /* If there is no key-translation-map, turn off scanning. */
6774 if (NILP (Fkeymapp (Vkey_translation_map
)))
6775 keytran_start
= keytran_end
= bufsize
+ 1;
6780 echo_prompt (XSTRING (prompt
)->data
);
6781 else if (cursor_in_echo_area
&& echo_keystrokes
)
6782 /* This doesn't put in a dash if the echo buffer is empty, so
6783 you don't always see a dash hanging out in the minibuffer. */
6787 /* Record the initial state of the echo area and this_command_keys;
6788 we will need to restore them if we replay a key sequence. */
6790 echo_start
= echo_length ();
6791 keys_start
= this_command_key_count
;
6792 this_single_command_key_start
= keys_start
;
6794 #if defined (GOBBLE_FIRST_EVENT)
6795 /* This doesn't quite work, because some of the things that read_char
6796 does cannot safely be bypassed. It seems too risky to try to make
6799 /* Read the first char of the sequence specially, before setting
6800 up any keymaps, in case a filter runs and switches buffers on us. */
6801 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
6803 #endif /* GOBBLE_FIRST_EVENT */
6805 orig_local_map
= get_local_map (PT
, current_buffer
);
6807 /* We jump here when the key sequence has been thoroughly changed, and
6808 we need to rescan it starting from the beginning. When we jump here,
6809 keybuf[0..mock_input] holds the sequence we should reread. */
6812 starting_buffer
= current_buffer
;
6813 function_key_possible
= 0;
6814 key_translation_possible
= 0;
6816 /* Build our list of keymaps.
6817 If we recognize a function key and replace its escape sequence in
6818 keybuf with its symbol, or if the sequence starts with a mouse
6819 click and we need to switch buffers, we jump back here to rebuild
6820 the initial keymaps from the current buffer. */
6824 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
6825 || !NILP (Voverriding_local_map
))
6827 if (3 > nmaps_allocated
)
6829 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
6830 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
6831 nmaps_allocated
= 3;
6834 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6835 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6836 if (!NILP (Voverriding_local_map
))
6837 submaps
[nmaps
++] = Voverriding_local_map
;
6841 nmaps
= current_minor_maps (0, &maps
);
6842 if (nmaps
+ 2 > nmaps_allocated
)
6844 submaps
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (submaps
[0]));
6845 defs
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (defs
[0]));
6846 nmaps_allocated
= nmaps
+ 2;
6848 bcopy (maps
, submaps
, nmaps
* sizeof (submaps
[0]));
6849 #ifdef USE_TEXT_PROPERTIES
6850 submaps
[nmaps
++] = orig_local_map
;
6852 submaps
[nmaps
++] = current_buffer
->keymap
;
6855 submaps
[nmaps
++] = current_global_map
;
6858 /* Find an accurate initial value for first_binding. */
6859 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
6860 if (! NILP (submaps
[first_binding
]))
6863 /* Start from the beginning in keybuf. */
6866 /* These are no-ops the first time through, but if we restart, they
6867 revert the echo area and this_command_keys to their original state. */
6868 this_command_key_count
= keys_start
;
6869 if (INTERACTIVE
&& t
< mock_input
)
6870 echo_truncate (echo_start
);
6872 /* If the best binding for the current key sequence is a keymap, or
6873 we may be looking at a function key's escape sequence, keep on
6875 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
6876 || (first_binding
>= nmaps
6878 /* mock input is never part of a function key's sequence. */
6879 && mock_input
<= fkey_start
)
6880 || (first_binding
>= nmaps
6881 && keytran_start
< t
&& key_translation_possible
)
6882 /* Don't return in the middle of a possible function key sequence,
6883 if the only bindings we found were via case conversion.
6884 Thus, if ESC O a has a function-key-map translation
6885 and ESC o has a binding, don't return after ESC O,
6886 so that we can translate ESC O plus the next character. */
6890 int used_mouse_menu
= 0;
6892 /* Where the last real key started. If we need to throw away a
6893 key that has expanded into more than one element of keybuf
6894 (say, a mouse click on the mode line which is being treated
6895 as [mode-line (mouse-...)], then we backtrack to this point
6897 int last_real_key_start
;
6899 /* These variables are analogous to echo_start and keys_start;
6900 while those allow us to restart the entire key sequence,
6901 echo_local_start and keys_local_start allow us to throw away
6903 int echo_local_start
, keys_local_start
, local_first_binding
;
6906 error ("Key sequence too long");
6909 echo_local_start
= echo_length ();
6910 keys_local_start
= this_command_key_count
;
6911 local_first_binding
= first_binding
;
6914 /* These are no-ops, unless we throw away a keystroke below and
6915 jumped back up to replay_key; in that case, these restore the
6916 variables to their original state, allowing us to replay the
6918 if (INTERACTIVE
&& t
< mock_input
)
6919 echo_truncate (echo_local_start
);
6920 this_command_key_count
= keys_local_start
;
6921 first_binding
= local_first_binding
;
6923 /* By default, assume each event is "real". */
6924 last_real_key_start
= t
;
6926 /* Does mock_input indicate that we are re-reading a key sequence? */
6930 add_command_key (key
);
6931 if (echo_keystrokes
)
6935 /* If not, we should actually read a character. */
6938 struct buffer
*buf
= current_buffer
;
6942 KBOARD
*interrupted_kboard
= current_kboard
;
6943 struct frame
*interrupted_frame
= selected_frame
;
6944 if (setjmp (wrong_kboard_jmpbuf
))
6946 if (!NILP (delayed_switch_frame
))
6948 interrupted_kboard
->kbd_queue
6949 = Fcons (delayed_switch_frame
,
6950 interrupted_kboard
->kbd_queue
);
6951 delayed_switch_frame
= Qnil
;
6954 interrupted_kboard
->kbd_queue
6955 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
6957 /* If the side queue is non-empty, ensure it begins with a
6958 switch-frame, so we'll replay it in the right context. */
6959 if (CONSP (interrupted_kboard
->kbd_queue
)
6960 && (key
= XCONS (interrupted_kboard
->kbd_queue
)->car
,
6961 !(EVENT_HAS_PARAMETERS (key
)
6962 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
6966 XSETFRAME (frame
, interrupted_frame
);
6967 interrupted_kboard
->kbd_queue
6968 = Fcons (make_lispy_switch_frame (frame
),
6969 interrupted_kboard
->kbd_queue
);
6972 orig_local_map
= get_local_map (PT
, current_buffer
);
6973 goto replay_sequence
;
6976 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
6980 /* read_char returns t when it shows a menu and the user rejects it.
6984 unbind_to (count
, Qnil
);
6988 /* read_char returns -1 at the end of a macro.
6989 Emacs 18 handles this by returning immediately with a
6990 zero, so that's what we'll do. */
6991 if (INTEGERP (key
) && XINT (key
) == -1)
6994 /* The Microsoft C compiler can't handle the goto that
7000 /* If the current buffer has been changed from under us, the
7001 keymap may have changed, so replay the sequence. */
7005 /* Reset the current buffer from the selected window
7006 in case something changed the former and not the latter.
7007 This is to be more consistent with the behavior
7008 of the command_loop_1. */
7009 if (fix_current_buffer
)
7011 if (! FRAME_LIVE_P (selected_frame
))
7013 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
7014 Fset_buffer (XWINDOW (selected_window
)->buffer
);
7017 orig_local_map
= get_local_map (PT
, current_buffer
);
7018 goto replay_sequence
;
7021 /* If we have a quit that was typed in another frame, and
7022 quit_throw_to_read_char switched buffers,
7023 replay to get the right keymap. */
7024 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
7027 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
7031 orig_local_map
= get_local_map (PT
, current_buffer
);
7032 goto replay_sequence
;
7037 if (EVENT_HAS_PARAMETERS (key
)
7038 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
7040 /* If we're at the beginning of a key sequence, and the caller
7041 says it's okay, go ahead and return this event. If we're
7042 in the midst of a key sequence, delay it until the end. */
7043 if (t
> 0 || !can_return_switch_frame
)
7045 delayed_switch_frame
= key
;
7051 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
7054 /* Clicks in non-text areas get prefixed by the symbol
7055 in their CHAR-ADDRESS field. For example, a click on
7056 the mode line is prefixed by the symbol `mode-line'.
7058 Furthermore, key sequences beginning with mouse clicks
7059 are read using the keymaps of the buffer clicked on, not
7060 the current buffer. So we may have to switch the buffer
7063 When we turn one event into two events, we must make sure
7064 that neither of the two looks like the original--so that,
7065 if we replay the events, they won't be expanded again.
7066 If not for this, such reexpansion could happen either here
7067 or when user programs play with this-command-keys. */
7068 if (EVENT_HAS_PARAMETERS (key
))
7072 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
7073 if (EQ (kind
, Qmouse_click
))
7075 Lisp_Object window
, posn
;
7077 window
= POSN_WINDOW (EVENT_START (key
));
7078 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
7081 /* We're looking at the second event of a
7082 sequence which we expanded before. Set
7083 last_real_key_start appropriately. */
7085 last_real_key_start
= t
- 1;
7088 /* Key sequences beginning with mouse clicks are
7089 read using the keymaps in the buffer clicked on,
7090 not the current buffer. If we're at the
7091 beginning of a key sequence, switch buffers. */
7092 if (last_real_key_start
== 0
7094 && BUFFERP (XWINDOW (window
)->buffer
)
7095 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
7097 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
7101 /* Arrange to go back to the original buffer once we're
7102 done reading the key sequence. Note that we can't
7103 use save_excursion_{save,restore} here, because they
7104 save point as well as the current buffer; we don't
7105 want to save point, because redisplay may change it,
7106 to accommodate a Fset_window_start or something. We
7107 don't want to do this at the top of the function,
7108 because we may get input from a subprocess which
7109 wants to change the selected window and stuff (say,
7111 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
7113 if (! FRAME_LIVE_P (selected_frame
))
7115 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
7116 orig_local_map
= get_local_map (PT
, current_buffer
);
7117 goto replay_sequence
;
7119 /* For a mouse click, get the local text-property keymap
7120 of the place clicked on, rather than point. */
7121 if (last_real_key_start
== 0 && CONSP (XCONS (key
)->cdr
)
7122 && ! localized_local_map
)
7124 Lisp_Object map_here
, start
, pos
;
7126 localized_local_map
= 1;
7127 start
= EVENT_START (key
);
7128 if (CONSP (start
) && CONSP (XCONS (start
)->cdr
))
7130 pos
= POSN_BUFFER_POSN (start
);
7132 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
7134 map_here
= get_local_map (XINT (pos
), current_buffer
);
7135 if (!EQ (map_here
, orig_local_map
))
7137 orig_local_map
= map_here
;
7141 goto replay_sequence
;
7147 /* Expand mode-line and scroll-bar events into two events:
7148 use posn as a fake prefix key. */
7151 if (t
+ 1 >= bufsize
)
7152 error ("Key sequence too long");
7157 /* Zap the position in key, so we know that we've
7158 expanded it, and don't try to do so again. */
7159 POSN_BUFFER_POSN (EVENT_START (key
))
7160 = Fcons (posn
, Qnil
);
7164 else if (CONSP (XCONS (key
)->cdr
)
7165 && CONSP (EVENT_START (key
))
7166 && CONSP (XCONS (EVENT_START (key
))->cdr
))
7170 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
7171 /* Handle menu-bar events:
7172 insert the dummy prefix event `menu-bar'. */
7173 if (EQ (posn
, Qmenu_bar
))
7175 if (t
+ 1 >= bufsize
)
7176 error ("Key sequence too long");
7180 /* Zap the position in key, so we know that we've
7181 expanded it, and don't try to do so again. */
7182 POSN_BUFFER_POSN (EVENT_START (key
))
7183 = Fcons (posn
, Qnil
);
7186 goto replay_sequence
;
7188 else if (CONSP (posn
))
7190 /* We're looking at the second event of a
7191 sequence which we expanded before. Set
7192 last_real_key_start appropriately. */
7193 if (last_real_key_start
== t
&& t
> 0)
7194 last_real_key_start
= t
- 1;
7199 /* We have finally decided that KEY is something we might want
7201 first_binding
= (follow_key (key
,
7202 nmaps
- first_binding
,
7203 submaps
+ first_binding
,
7204 defs
+ first_binding
,
7205 submaps
+ first_binding
)
7208 /* If KEY wasn't bound, we'll try some fallbacks. */
7209 if (first_binding
>= nmaps
)
7213 head
= EVENT_HEAD (key
);
7214 if (help_char_p (head
) && t
> 0)
7216 read_key_sequence_cmd
= Vprefix_help_command
;
7218 last_nonmenu_event
= key
;
7219 /* The Microsoft C compiler can't handle the goto that
7227 Lisp_Object breakdown
;
7230 breakdown
= parse_modifiers (head
);
7231 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
7232 /* Attempt to reduce an unbound mouse event to a simpler
7233 event that is bound:
7234 Drags reduce to clicks.
7235 Double-clicks reduce to clicks.
7236 Triple-clicks reduce to double-clicks, then to clicks.
7237 Down-clicks are eliminated.
7238 Double-downs reduce to downs, then are eliminated.
7239 Triple-downs reduce to double-downs, then to downs,
7240 then are eliminated. */
7241 if (modifiers
& (down_modifier
| drag_modifier
7242 | double_modifier
| triple_modifier
))
7244 while (modifiers
& (down_modifier
| drag_modifier
7245 | double_modifier
| triple_modifier
))
7247 Lisp_Object new_head
, new_click
;
7248 if (modifiers
& triple_modifier
)
7249 modifiers
^= (double_modifier
| triple_modifier
);
7250 else if (modifiers
& double_modifier
)
7251 modifiers
&= ~double_modifier
;
7252 else if (modifiers
& drag_modifier
)
7253 modifiers
&= ~drag_modifier
;
7256 /* Dispose of this `down' event by simply jumping
7257 back to replay_key, to get another event.
7259 Note that if this event came from mock input,
7260 then just jumping back to replay_key will just
7261 hand it to us again. So we have to wipe out any
7264 We could delete keybuf[t] and shift everything
7265 after that to the left by one spot, but we'd also
7266 have to fix up any variable that points into
7267 keybuf, and shifting isn't really necessary
7270 Adding prefixes for non-textual mouse clicks
7271 creates two characters of mock input, and both
7272 must be thrown away. If we're only looking at
7273 the prefix now, we can just jump back to
7274 replay_key. On the other hand, if we've already
7275 processed the prefix, and now the actual click
7276 itself is giving us trouble, then we've lost the
7277 state of the keymaps we want to backtrack to, and
7278 we need to replay the whole sequence to rebuild
7281 Beyond that, only function key expansion could
7282 create more than two keys, but that should never
7283 generate mouse events, so it's okay to zero
7284 mock_input in that case too.
7286 Isn't this just the most wonderful code ever? */
7287 if (t
== last_real_key_start
)
7294 mock_input
= last_real_key_start
;
7295 goto replay_sequence
;
7300 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
7302 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
7304 /* Look for a binding for this new key. follow_key
7305 promises that it didn't munge submaps the
7306 last time we called it, since key was unbound. */
7308 = (follow_key (new_click
,
7309 nmaps
- local_first_binding
,
7310 submaps
+ local_first_binding
,
7311 defs
+ local_first_binding
,
7312 submaps
+ local_first_binding
)
7313 + local_first_binding
);
7315 /* If that click is bound, go for it. */
7316 if (first_binding
< nmaps
)
7321 /* Otherwise, we'll leave key set to the drag event. */
7328 /* Normally, last_nonmenu_event gets the previous key we read.
7329 But when a mouse popup menu is being used,
7330 we don't update last_nonmenu_event; it continues to hold the mouse
7331 event that preceded the first level of menu. */
7332 if (!used_mouse_menu
)
7333 last_nonmenu_event
= key
;
7335 /* Record what part of this_command_keys is the current key sequence. */
7336 this_single_command_key_start
= this_command_key_count
- t
;
7338 prev_fkey_map
= fkey_map
;
7339 prev_fkey_start
= fkey_start
;
7340 prev_fkey_end
= fkey_end
;
7342 prev_keytran_map
= keytran_map
;
7343 prev_keytran_start
= keytran_start
;
7344 prev_keytran_end
= keytran_end
;
7346 /* If the sequence is unbound, see if we can hang a function key
7347 off the end of it. We only want to scan real keyboard input
7348 for function key sequences, so if mock_input says that we're
7349 re-reading old events, don't examine it. */
7350 if (first_binding
>= nmaps
7353 Lisp_Object fkey_next
;
7355 /* Continue scan from fkey_end until we find a bound suffix.
7356 If we fail, increment fkey_start
7357 and start fkey_end from there. */
7358 while (fkey_end
< t
)
7362 key
= keybuf
[fkey_end
++];
7363 /* Look up meta-characters by prefixing them
7364 with meta_prefix_char. I hate this. */
7365 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
7370 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0), 0),
7372 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
7375 fkey_next
= fkey_map
;
7378 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0), 0);
7380 #if 0 /* I didn't turn this on, because it might cause trouble
7381 for the mapping of return into C-m and tab into C-i. */
7382 /* Optionally don't map function keys into other things.
7383 This enables the user to redefine kp- keys easily. */
7384 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
7388 /* If the function key map gives a function, not an
7389 array, then call the function with no args and use
7390 its value instead. */
7391 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
7394 struct gcpro gcpro1
, gcpro2
, gcpro3
;
7398 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
7399 fkey_next
= call1 (fkey_next
, prompt
);
7401 /* If the function returned something invalid,
7402 barf--don't ignore it.
7403 (To ignore it safely, we would need to gcpro a bunch of
7404 other variables.) */
7405 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
7406 error ("Function in key-translation-map returns invalid key sequence");
7409 function_key_possible
= ! NILP (fkey_next
);
7411 /* If keybuf[fkey_start..fkey_end] is bound in the
7412 function key map and it's a suffix of the current
7413 sequence (i.e. fkey_end == t), replace it with
7414 the binding and restart with fkey_start at the end. */
7415 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
7418 int len
= XFASTINT (Flength (fkey_next
));
7420 t
= fkey_start
+ len
;
7422 error ("Key sequence too long");
7424 if (VECTORP (fkey_next
))
7425 bcopy (XVECTOR (fkey_next
)->contents
,
7426 keybuf
+ fkey_start
,
7427 (t
- fkey_start
) * sizeof (keybuf
[0]));
7428 else if (STRINGP (fkey_next
))
7432 for (i
= 0; i
< len
; i
++)
7433 XSETFASTINT (keybuf
[fkey_start
+ i
],
7434 XSTRING (fkey_next
)->data
[i
]);
7438 fkey_start
= fkey_end
= t
;
7439 fkey_map
= Vfunction_key_map
;
7441 /* Do pass the results through key-translation-map. */
7442 keytran_start
= keytran_end
= 0;
7443 keytran_map
= Vkey_translation_map
;
7445 goto replay_sequence
;
7448 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
7450 /* If we no longer have a bound suffix, try a new positions for
7452 if (NILP (fkey_map
))
7454 fkey_end
= ++fkey_start
;
7455 fkey_map
= Vfunction_key_map
;
7456 function_key_possible
= 0;
7461 /* Look for this sequence in key-translation-map. */
7463 Lisp_Object keytran_next
;
7465 /* Scan from keytran_end until we find a bound suffix. */
7466 while (keytran_end
< t
)
7470 key
= keybuf
[keytran_end
++];
7471 /* Look up meta-characters by prefixing them
7472 with meta_prefix_char. I hate this. */
7473 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
7478 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0), 0),
7480 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
7483 keytran_next
= keytran_map
;
7486 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0), 0);
7488 /* If the key translation map gives a function, not an
7489 array, then call the function with no args and use
7490 its value instead. */
7491 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
7492 && keytran_end
== t
)
7494 struct gcpro gcpro1
, gcpro2
, gcpro3
;
7498 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
7499 keytran_next
= call1 (keytran_next
, prompt
);
7501 /* If the function returned something invalid,
7502 barf--don't ignore it.
7503 (To ignore it safely, we would need to gcpro a bunch of
7504 other variables.) */
7505 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
7506 error ("Function in key-translation-map returns invalid key sequence");
7509 key_translation_possible
= ! NILP (keytran_next
);
7511 /* If keybuf[keytran_start..keytran_end] is bound in the
7512 key translation map and it's a suffix of the current
7513 sequence (i.e. keytran_end == t), replace it with
7514 the binding and restart with keytran_start at the end. */
7515 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
7516 && keytran_end
== t
)
7518 int len
= XFASTINT (Flength (keytran_next
));
7520 t
= keytran_start
+ len
;
7522 error ("Key sequence too long");
7524 if (VECTORP (keytran_next
))
7525 bcopy (XVECTOR (keytran_next
)->contents
,
7526 keybuf
+ keytran_start
,
7527 (t
- keytran_start
) * sizeof (keybuf
[0]));
7528 else if (STRINGP (keytran_next
))
7532 for (i
= 0; i
< len
; i
++)
7533 XSETFASTINT (keybuf
[keytran_start
+ i
],
7534 XSTRING (keytran_next
)->data
[i
]);
7538 keytran_start
= keytran_end
= t
;
7539 keytran_map
= Vkey_translation_map
;
7541 /* Don't pass the results of key-translation-map
7542 through function-key-map. */
7543 fkey_start
= fkey_end
= t
;
7544 fkey_map
= Vkey_translation_map
;
7546 goto replay_sequence
;
7549 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
7551 /* If we no longer have a bound suffix, try a new positions for
7553 if (NILP (keytran_map
))
7555 keytran_end
= ++keytran_start
;
7556 keytran_map
= Vkey_translation_map
;
7557 key_translation_possible
= 0;
7562 /* If KEY is not defined in any of the keymaps,
7563 and cannot be part of a function key or translation,
7564 and is an upper case letter
7565 use the corresponding lower-case letter instead. */
7566 if (first_binding
== nmaps
&& ! function_key_possible
7567 && ! key_translation_possible
7569 && ((((XINT (key
) & 0x3ffff)
7570 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
7571 && UPPERCASEP (XINT (key
) & 0x3ffff))
7572 || (XINT (key
) & shift_modifier
)))
7574 Lisp_Object new_key
;
7576 original_uppercase
= key
;
7577 original_uppercase_position
= t
- 1;
7579 if (XINT (key
) & shift_modifier
)
7580 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
7582 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
7583 | (XINT (key
) & ~0x3ffff)));
7585 /* We have to do this unconditionally, regardless of whether
7586 the lower-case char is defined in the keymaps, because they
7587 might get translated through function-key-map. */
7588 keybuf
[t
- 1] = new_key
;
7591 fkey_map
= prev_fkey_map
;
7592 fkey_start
= prev_fkey_start
;
7593 fkey_end
= prev_fkey_end
;
7595 keytran_map
= prev_keytran_map
;
7596 keytran_start
= prev_keytran_start
;
7597 keytran_end
= prev_keytran_end
;
7599 goto replay_sequence
;
7601 /* If KEY is not defined in any of the keymaps,
7602 and cannot be part of a function key or translation,
7603 and is a shifted function key,
7604 use the corresponding unshifted function key instead. */
7605 if (first_binding
== nmaps
&& ! function_key_possible
7606 && ! key_translation_possible
7609 Lisp_Object breakdown
;
7612 breakdown
= parse_modifiers (key
);
7613 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
7614 if (modifiers
& shift_modifier
)
7616 Lisp_Object new_key
;
7618 original_uppercase
= key
;
7619 original_uppercase_position
= t
- 1;
7621 modifiers
&= ~shift_modifier
;
7622 new_key
= apply_modifiers (modifiers
,
7623 XCONS (breakdown
)->car
);
7625 keybuf
[t
- 1] = new_key
;
7628 fkey_map
= prev_fkey_map
;
7629 fkey_start
= prev_fkey_start
;
7630 fkey_end
= prev_fkey_end
;
7632 keytran_map
= prev_keytran_map
;
7633 keytran_start
= prev_keytran_start
;
7634 keytran_end
= prev_keytran_end
;
7636 goto replay_sequence
;
7642 read_key_sequence_cmd
= (first_binding
< nmaps
7643 ? defs
[first_binding
]
7646 unread_switch_frame
= delayed_switch_frame
;
7647 unbind_to (count
, Qnil
);
7649 /* Don't downcase the last character if the caller says don't.
7650 Don't downcase it if the result is undefined, either. */
7651 if ((dont_downcase_last
|| first_binding
>= nmaps
)
7652 && t
- 1 == original_uppercase_position
)
7653 keybuf
[t
- 1] = original_uppercase
;
7655 /* Occasionally we fabricate events, perhaps by expanding something
7656 according to function-key-map, or by adding a prefix symbol to a
7657 mouse click in the scroll bar or modeline. In this cases, return
7658 the entire generated key sequence, even if we hit an unbound
7659 prefix or a definition before the end. This means that you will
7660 be able to push back the event properly, and also means that
7661 read-key-sequence will always return a logical unit.
7664 for (; t
< mock_input
; t
++)
7666 if (echo_keystrokes
)
7667 echo_char (keybuf
[t
]);
7668 add_command_key (keybuf
[t
]);
7676 #if 0 /* This doc string is too long for some compilers.
7677 This commented-out definition serves for DOC. */
7678 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
7679 "Read a sequence of keystrokes and return as a string or vector.\n\
7680 The sequence is sufficient to specify a non-prefix command in the\n\
7681 current local and global maps.\n\
7683 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
7684 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
7685 as a continuation of the previous key.\n\
7687 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
7688 convert the last event to lower case. (Normally any upper case event\n\
7689 is converted to lower case if the original event is undefined and the lower\n\
7690 case equivalent is defined.) A non-nil value is appropriate for reading\n\
7691 a key sequence to be defined.\n\
7693 A C-g typed while in this function is treated like any other character,\n\
7694 and `quit-flag' is not set.\n\
7696 If the key sequence starts with a mouse click, then the sequence is read\n\
7697 using the keymaps of the buffer of the window clicked in, not the buffer\n\
7698 of the selected window as normal.\n\
7700 `read-key-sequence' drops unbound button-down events, since you normally\n\
7701 only care about the click or drag events which follow them. If a drag\n\
7702 or multi-click event is unbound, but the corresponding click event would\n\
7703 be bound, `read-key-sequence' turns the event into a click event at the\n\
7704 drag's starting position. This means that you don't have to distinguish\n\
7705 between click and drag, double, or triple events unless you want to.\n\
7707 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
7708 lines separating windows, and scroll bars with imaginary keys\n\
7709 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
7711 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
7712 function will process a switch-frame event if the user switches frames\n\
7713 before typing anything. If the user switches frames in the middle of a\n\
7714 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
7715 is nil, then the event will be put off until after the current key sequence.\n\
7717 `read-key-sequence' checks `function-key-map' for function key\n\
7718 sequences, where they wouldn't conflict with ordinary bindings. See\n\
7719 `function-key-map' for more details.\n\
7721 The optional fifth argument COMMAND-LOOP, if non-nil, means\n\
7722 that this key sequence is being read by something that will\n\
7723 read commands one after another. It should be nil if the caller\n\
7724 will read just one key sequence.")
7725 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
, command
-loop
)
7728 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
7730 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
7732 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
7733 Lisp_Object can_return_switch_frame
, command_loop
;
7735 Lisp_Object keybuf
[30];
7737 struct gcpro gcpro1
, gcpro2
;
7738 int count
= specpdl_ptr
- specpdl
;
7741 CHECK_STRING (prompt
, 0);
7744 specbind (Qinput_method_exit_on_first_char
,
7745 (NILP (command_loop
) ? Qt
: Qnil
));
7746 specbind (Qinput_method_use_echo_area
,
7747 (NILP (command_loop
) ? Qt
: Qnil
));
7749 bzero (keybuf
, sizeof keybuf
);
7751 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
7753 if (NILP (continue_echo
))
7755 this_command_key_count
= 0;
7756 this_single_command_key_start
= 0;
7759 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
7760 prompt
, ! NILP (dont_downcase_last
),
7761 ! NILP (can_return_switch_frame
), 0);
7769 return unbind_to (count
, make_event_array (i
, keybuf
));
7772 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
7773 Sread_key_sequence_vector
, 1, 5, 0,
7774 "Like `read-key-sequence' but always return a vector.")
7775 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
7777 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
7778 Lisp_Object can_return_switch_frame
, command_loop
;
7780 Lisp_Object keybuf
[30];
7782 struct gcpro gcpro1
, gcpro2
;
7783 int count
= specpdl_ptr
- specpdl
;
7786 CHECK_STRING (prompt
, 0);
7789 specbind (Qinput_method_exit_on_first_char
,
7790 (NILP (command_loop
) ? Qt
: Qnil
));
7791 specbind (Qinput_method_use_echo_area
,
7792 (NILP (command_loop
) ? Qt
: Qnil
));
7794 bzero (keybuf
, sizeof keybuf
);
7796 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
7798 if (NILP (continue_echo
))
7800 this_command_key_count
= 0;
7801 this_single_command_key_start
= 0;
7804 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
7805 prompt
, ! NILP (dont_downcase_last
),
7806 ! NILP (can_return_switch_frame
), 0);
7814 return unbind_to (count
, Fvector (i
, keybuf
));
7817 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
7818 "Execute CMD as an editor command.\n\
7819 CMD must be a symbol that satisfies the `commandp' predicate.\n\
7820 Optional second arg RECORD-FLAG non-nil\n\
7821 means unconditionally put this command in `command-history'.\n\
7822 Otherwise, that is done only if an arg is read using the minibuffer.\n\
7823 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
7824 when reading the arguments; if it is nil, (this-command-keys) is used.\n\
7825 The argument SPECIAL, if non-nil, means that this command is executing\n\
7826 a special event, so ignore the prefix argument and don't clear it.")
7827 (cmd
, record_flag
, keys
, special
)
7828 Lisp_Object cmd
, record_flag
, keys
, special
;
7830 register Lisp_Object final
;
7831 register Lisp_Object tem
;
7832 Lisp_Object prefixarg
;
7833 struct backtrace backtrace
;
7834 extern int debug_on_next_call
;
7836 debug_on_next_call
= 0;
7840 prefixarg
= current_kboard
->Vprefix_arg
;
7841 Vcurrent_prefix_arg
= prefixarg
;
7842 current_kboard
->Vprefix_arg
= Qnil
;
7849 tem
= Fget (cmd
, Qdisabled
);
7850 if (!NILP (tem
) && !NILP (Vrun_hooks
))
7852 tem
= Fsymbol_value (Qdisabled_command_hook
);
7854 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
7860 final
= Findirect_function (cmd
);
7862 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
7864 struct gcpro gcpro1
, gcpro2
;
7866 GCPRO2 (cmd
, prefixarg
);
7867 do_autoload (final
, cmd
);
7874 if (STRINGP (final
) || VECTORP (final
))
7876 /* If requested, place the macro in the command history. For
7877 other sorts of commands, call-interactively takes care of
7879 if (!NILP (record_flag
))
7882 = Fcons (Fcons (Qexecute_kbd_macro
,
7883 Fcons (final
, Fcons (prefixarg
, Qnil
))),
7886 /* Don't keep command history around forever. */
7887 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
7889 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
7891 XCONS (tem
)->cdr
= Qnil
;
7895 return Fexecute_kbd_macro (final
, prefixarg
);
7898 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
7900 backtrace
.next
= backtrace_list
;
7901 backtrace_list
= &backtrace
;
7902 backtrace
.function
= &Qcall_interactively
;
7903 backtrace
.args
= &cmd
;
7904 backtrace
.nargs
= 1;
7905 backtrace
.evalargs
= 0;
7907 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
7909 backtrace_list
= backtrace
.next
;
7915 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
7917 "Read function name, then read its arguments and call it.")
7919 Lisp_Object prefixarg
;
7921 Lisp_Object function
;
7923 Lisp_Object saved_keys
;
7924 Lisp_Object bindings
, value
;
7925 struct gcpro gcpro1
, gcpro2
;
7927 saved_keys
= Fvector (this_command_key_count
,
7928 XVECTOR (this_command_keys
)->contents
);
7930 GCPRO2 (saved_keys
, prefixarg
);
7932 if (EQ (prefixarg
, Qminus
))
7934 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
7935 strcpy (buf
, "C-u ");
7936 else if (CONSP (prefixarg
) && INTEGERP (XCONS (prefixarg
)->car
))
7938 if (sizeof (int) == sizeof (EMACS_INT
))
7939 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
7940 else if (sizeof (long) == sizeof (EMACS_INT
))
7941 sprintf (buf
, "%ld ", XINT (XCONS (prefixarg
)->car
));
7945 else if (INTEGERP (prefixarg
))
7947 if (sizeof (int) == sizeof (EMACS_INT
))
7948 sprintf (buf
, "%d ", XINT (prefixarg
));
7949 else if (sizeof (long) == sizeof (EMACS_INT
))
7950 sprintf (buf
, "%ld ", XINT (prefixarg
));
7955 /* This isn't strictly correct if execute-extended-command
7956 is bound to anything else. Perhaps it should use
7957 this_command_keys? */
7958 strcat (buf
, "M-x ");
7960 /* Prompt with buf, and then read a string, completing from and
7961 restricting to the set of all defined commands. Don't provide
7962 any initial input. Save the command read on the extended-command
7964 function
= Fcompleting_read (build_string (buf
),
7965 Vobarray
, Qcommandp
,
7966 Qt
, Qnil
, Qextended_command_history
, Qnil
,
7969 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
7970 error ("No command name given");
7972 /* Set this_command_keys to the concatenation of saved_keys and
7973 function, followed by a RET. */
7975 struct Lisp_String
*str
;
7979 this_command_key_count
= 0;
7980 this_single_command_key_start
= 0;
7982 keys
= XVECTOR (saved_keys
)->contents
;
7983 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
7984 add_command_key (keys
[i
]);
7986 str
= XSTRING (function
);
7987 for (i
= 0; i
< str
->size
; i
++)
7988 add_command_key (Faref (function
, make_number (i
)));
7990 add_command_key (make_number ('\015'));
7995 function
= Fintern (function
, Qnil
);
7996 current_kboard
->Vprefix_arg
= prefixarg
;
7997 Vthis_command
= function
;
7998 real_this_command
= function
;
8000 /* If enabled, show which key runs this command. */
8001 if (!NILP (Vsuggest_key_bindings
)
8002 && NILP (Vexecuting_macro
)
8003 && SYMBOLP (function
))
8004 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
8010 GCPRO2 (bindings
, value
);
8011 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
8013 /* If the command has a key binding, print it now. */
8014 if (!NILP (bindings
)
8015 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
8018 /* But first wait, and skip the message if there is input. */
8020 if (echo_area_glyphs
!= 0)
8021 /* This command displayed something in the echo area;
8022 so wait a few seconds, then display our suggestion message. */
8023 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
8024 ? XINT (Vsuggest_key_bindings
) : 2);
8026 /* This command left the echo area empty,
8027 so display our message immediately. */
8030 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
8031 && ! CONSP (Vunread_command_events
))
8033 Lisp_Object binding
;
8035 char *oldmessage
= echo_area_glyphs
;
8036 int oldmessage_len
= echo_area_glyphs_length
;
8037 int oldmultibyte
= message_enable_multibyte
;
8039 binding
= Fkey_description (bindings
);
8042 = (char *) alloca (XSYMBOL (function
)->name
->size
8043 + STRING_BYTES (XSTRING (binding
))
8045 sprintf (newmessage
, "You can run the command `%s' with %s",
8046 XSYMBOL (function
)->name
->data
,
8047 XSTRING (binding
)->data
);
8048 message2_nolog (newmessage
,
8049 strlen (newmessage
),
8050 STRING_MULTIBYTE (binding
));
8051 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
8052 ? Vsuggest_key_bindings
: make_number (2)),
8054 message2_nolog (oldmessage
, oldmessage_len
, oldmultibyte
);
8058 RETURN_UNGCPRO (value
);
8061 /* Find the set of keymaps now active.
8062 Store into *MAPS_P a vector holding the various maps
8063 and return the number of them. The vector was malloc'd
8064 and the caller should free it. */
8067 current_active_maps (maps_p
)
8068 Lisp_Object
**maps_p
;
8070 Lisp_Object
*tmaps
, *maps
;
8073 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8074 if (!NILP (Voverriding_local_map_menu_flag
))
8076 /* Yes, use them (if non-nil) as well as the global map. */
8077 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
8079 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8080 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8081 if (!NILP (Voverriding_local_map
))
8082 maps
[nmaps
++] = Voverriding_local_map
;
8086 /* No, so use major and minor mode keymaps. */
8087 nmaps
= current_minor_maps (NULL
, &tmaps
);
8088 maps
= (Lisp_Object
*) xmalloc ((nmaps
+ 2) * sizeof (maps
[0]));
8089 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
8090 #ifdef USE_TEXT_PROPERTIES
8091 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
8093 maps
[nmaps
++] = current_buffer
->keymap
;
8096 maps
[nmaps
++] = current_global_map
;
8102 /* Return nonzero if input events are pending. */
8105 detect_input_pending ()
8108 get_input_pending (&input_pending
, 0);
8110 return input_pending
;
8113 /* Return nonzero if input events are pending, and run any pending timers. */
8116 detect_input_pending_run_timers (do_display
)
8119 int old_timers_run
= timers_run
;
8122 get_input_pending (&input_pending
, 1);
8124 if (old_timers_run
!= timers_run
&& do_display
)
8125 redisplay_preserve_echo_area ();
8127 return input_pending
;
8130 /* This is called in some cases before a possible quit.
8131 It cases the next call to detect_input_pending to recompute input_pending.
8132 So calling this function unnecessarily can't do any harm. */
8135 clear_input_pending ()
8140 /* Return nonzero if there are pending requeued events.
8141 This isn't used yet. The hope is to make wait_reading_process_input
8142 call it, and return return if it runs Lisp code that unreads something.
8143 The problem is, kbd_buffer_get_event needs to be fixed to know what
8144 to do in that case. It isn't trivial. */
8147 requeued_events_pending_p ()
8149 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
8153 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
8154 "T if command input is currently available with no waiting.\n\
8155 Actually, the value is nil only if we can be sure that no input is available.")
8158 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
8161 get_input_pending (&input_pending
, 1);
8162 return input_pending
> 0 ? Qt
: Qnil
;
8165 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
8166 "Return vector of last 100 events, not counting those from keyboard macros.")
8169 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
8172 if (total_keys
< NUM_RECENT_KEYS
)
8173 return Fvector (total_keys
, keys
);
8176 val
= Fvector (NUM_RECENT_KEYS
, keys
);
8177 bcopy (keys
+ recent_keys_index
,
8178 XVECTOR (val
)->contents
,
8179 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
8181 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
8182 recent_keys_index
* sizeof (Lisp_Object
));
8187 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
8188 "Return the key sequence that invoked this command.\n\
8189 The value is a string or a vector.")
8192 return make_event_array (this_command_key_count
,
8193 XVECTOR (this_command_keys
)->contents
);
8196 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
8197 "Return the key sequence that invoked this command, as a vector.")
8200 return Fvector (this_command_key_count
,
8201 XVECTOR (this_command_keys
)->contents
);
8204 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
8205 Sthis_single_command_keys
, 0, 0, 0,
8206 "Return the key sequence that invoked this command.\n\
8207 Unlike `this-command-keys', this function's value\n\
8208 does not include prefix arguments.\n\
8209 The value is always a vector.")
8212 return Fvector (this_command_key_count
8213 - this_single_command_key_start
,
8214 (XVECTOR (this_command_keys
)->contents
8215 + this_single_command_key_start
));
8218 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
8219 Sthis_single_command_raw_keys
, 0, 0, 0,
8220 "Return the raw events that were read for this command.\n\
8221 Unlike `this-single-command-keys', this function's value\n\
8222 shows the events before all translations (except for input methods).\n\
8223 The value is always a vector.")
8226 return Fvector (raw_keybuf_count
,
8227 (XVECTOR (raw_keybuf
)->contents
));
8230 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
8231 Sreset_this_command_lengths
, 0, 0, 0,
8232 "Used for complicated reasons in `universal-argument-other-key'.\n\
8234 `universal-argument-other-key' rereads the event just typed.\n\
8235 It then gets translated through `function-key-map'.\n\
8236 The translated event gets included in the echo area and in\n\
8237 the value of `this-command-keys' in addition to the raw original event.\n\
8238 That is not right.\n\
8240 Calling this function directs the translated event to replace\n\
8241 the original event, so that only one version of the event actually\n\
8242 appears in the echo area and in the value of `this-command-keys.'.")
8245 before_command_restore_flag
= 1;
8246 before_command_key_count_1
= before_command_key_count
;
8247 before_command_echo_length_1
= before_command_echo_length
;
8251 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
8252 Sclear_this_command_keys
, 0, 0, 0,
8253 "Clear out the vector that `this-command-keys' returns.")
8256 this_command_key_count
= 0;
8260 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
8261 "Return the current depth in recursive edits.")
8265 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
8269 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
8270 "FOpen dribble file: ",
8271 "Start writing all keyboard characters to a dribble file called FILE.\n\
8272 If FILE is nil, close any open dribble file.")
8283 file
= Fexpand_file_name (file
, Qnil
);
8284 dribble
= fopen (XSTRING (file
)->data
, "w");
8286 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
8291 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
8292 "Discard the contents of the terminal input buffer.\n\
8293 Also cancel any kbd macro being defined.")
8296 current_kboard
->defining_kbd_macro
= Qnil
;
8297 update_mode_lines
++;
8299 Vunread_command_events
= Qnil
;
8300 unread_command_char
= -1;
8302 discard_tty_input ();
8304 /* Without the cast, GCC complains that this assignment loses the
8305 volatile qualifier of kbd_store_ptr. Is there anything wrong
8307 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
8308 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
8314 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
8315 "Stop Emacs and return to superior process. You can resume later.\n\
8316 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
8317 control, run a subshell instead.\n\n\
8318 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
8319 to be read as terminal input by Emacs's parent, after suspension.\n\
8321 Before suspending, run the normal hook `suspend-hook'.\n\
8322 After resumption run the normal hook `suspend-resume-hook'.\n\
8324 Some operating systems cannot stop the Emacs process and resume it later.\n\
8325 On such systems, Emacs starts a subshell instead of suspending.")
8327 Lisp_Object stuffstring
;
8330 int count
= specpdl_ptr
- specpdl
;
8331 int old_height
, old_width
;
8333 struct gcpro gcpro1
, gcpro2
;
8335 if (!NILP (stuffstring
))
8336 CHECK_STRING (stuffstring
, 0);
8338 /* Run the functions in suspend-hook. */
8339 if (!NILP (Vrun_hooks
))
8340 call1 (Vrun_hooks
, intern ("suspend-hook"));
8342 GCPRO1 (stuffstring
);
8343 get_frame_size (&old_width
, &old_height
);
8345 /* sys_suspend can get an error if it tries to fork a subshell
8346 and the system resources aren't available for that. */
8347 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
8349 stuff_buffered_input (stuffstring
);
8354 unbind_to (count
, Qnil
);
8356 /* Check if terminal/window size has changed.
8357 Note that this is not useful when we are running directly
8358 with a window system; but suspend should be disabled in that case. */
8359 get_frame_size (&width
, &height
);
8360 if (width
!= old_width
|| height
!= old_height
)
8361 change_frame_size (selected_frame
, height
, width
, 0, 0);
8363 /* Run suspend-resume-hook. */
8364 if (!NILP (Vrun_hooks
))
8365 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
8371 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
8372 Then in any case stuff anything Emacs has read ahead and not used. */
8375 stuff_buffered_input (stuffstring
)
8376 Lisp_Object stuffstring
;
8378 /* stuff_char works only in BSD, versions 4.2 and up. */
8381 register unsigned char *p
;
8383 if (STRINGP (stuffstring
))
8387 p
= XSTRING (stuffstring
)->data
;
8388 count
= STRING_BYTES (XSTRING (stuffstring
));
8393 /* Anything we have read ahead, put back for the shell to read. */
8394 /* ?? What should this do when we have multiple keyboards??
8395 Should we ignore anything that was typed in at the "wrong" kboard? */
8396 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
8398 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
8399 kbd_fetch_ptr
= kbd_buffer
;
8400 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
8401 stuff_char (kbd_fetch_ptr
->code
);
8402 kbd_fetch_ptr
->kind
= no_event
;
8403 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
8409 #endif /* BSD_SYSTEM and not BSD4_1 */
8413 set_waiting_for_input (time_to_clear
)
8414 EMACS_TIME
*time_to_clear
;
8416 input_available_clear_time
= time_to_clear
;
8418 /* Tell interrupt_signal to throw back to read_char, */
8419 waiting_for_input
= 1;
8421 /* If interrupt_signal was called before and buffered a C-g,
8422 make it run again now, to avoid timing error. */
8423 if (!NILP (Vquit_flag
))
8424 quit_throw_to_read_char ();
8428 clear_waiting_for_input ()
8430 /* Tell interrupt_signal not to throw back to read_char, */
8431 waiting_for_input
= 0;
8432 input_available_clear_time
= 0;
8435 /* This routine is called at interrupt level in response to C-G.
8436 If interrupt_input, this is the handler for SIGINT.
8437 Otherwise, it is called from kbd_buffer_store_event,
8438 in handling SIGIO or SIGTINT.
8440 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
8441 immediately throw back to read_char.
8443 Otherwise it sets the Lisp variable quit-flag not-nil.
8444 This causes eval to throw, when it gets a chance.
8445 If quit-flag is already non-nil, it stops the job right away. */
8448 interrupt_signal (signalnum
) /* If we don't have an argument, */
8449 int signalnum
; /* some compilers complain in signal calls. */
8452 /* Must preserve main program's value of errno. */
8453 int old_errno
= errno
;
8455 #if defined (USG) && !defined (POSIX_SIGNALS)
8456 if (!read_socket_hook
&& NILP (Vwindow_system
))
8458 /* USG systems forget handlers when they are used;
8459 must reestablish each time */
8460 signal (SIGINT
, interrupt_signal
);
8461 signal (SIGQUIT
, interrupt_signal
);
8467 if (!NILP (Vquit_flag
)
8468 && (FRAME_TERMCAP_P (selected_frame
) || FRAME_MSDOS_P (selected_frame
)))
8470 /* If SIGINT isn't blocked, don't let us be interrupted by
8471 another SIGINT, it might be harmful due to non-reentrancy
8472 in I/O functions. */
8473 sigblock (sigmask (SIGINT
));
8478 #ifdef SIGTSTP /* Support possible in later USG versions */
8480 * On systems which can suspend the current process and return to the original
8481 * shell, this command causes the user to end up back at the shell.
8482 * The "Auto-save" and "Abort" questions are not asked until
8483 * the user elects to return to emacs, at which point he can save the current
8484 * job and either dump core or continue.
8489 if (sys_suspend () == -1)
8491 printf ("Not running as a subprocess;\n");
8492 printf ("you can continue or abort.\n");
8495 /* Perhaps should really fork an inferior shell?
8496 But that would not provide any way to get back
8497 to the original shell, ever. */
8498 printf ("No support for stopping a process on this operating system;\n");
8499 printf ("you can continue or abort.\n");
8500 #endif /* not VMS */
8501 #endif /* not SIGTSTP */
8503 /* We must remain inside the screen area when the internal terminal
8504 is used. Note that [Enter] is not echoed by dos. */
8507 /* It doesn't work to autosave while GC is in progress;
8508 the code used for auto-saving doesn't cope with the mark bit. */
8509 if (!gc_in_progress
)
8511 printf ("Auto-save? (y or n) ");
8513 if (((c
= getchar ()) & ~040) == 'Y')
8515 Fdo_auto_save (Qt
, Qnil
);
8517 printf ("\r\nAuto-save done");
8518 #else /* not MSDOS */
8519 printf ("Auto-save done\n");
8520 #endif /* not MSDOS */
8522 while (c
!= '\n') c
= getchar ();
8526 /* During GC, it must be safe to reenable quitting again. */
8527 Vinhibit_quit
= Qnil
;
8530 #endif /* not MSDOS */
8531 printf ("Garbage collection in progress; cannot auto-save now\r\n");
8532 printf ("but will instead do a real quit after garbage collection ends\r\n");
8537 printf ("\r\nAbort? (y or n) ");
8538 #else /* not MSDOS */
8540 printf ("Abort (and enter debugger)? (y or n) ");
8542 printf ("Abort (and dump core)? (y or n) ");
8543 #endif /* not VMS */
8544 #endif /* not MSDOS */
8546 if (((c
= getchar ()) & ~040) == 'Y')
8548 while (c
!= '\n') c
= getchar ();
8550 printf ("\r\nContinuing...\r\n");
8551 #else /* not MSDOS */
8552 printf ("Continuing...\n");
8553 #endif /* not MSDOS */
8560 /* If executing a function that wants to be interrupted out of
8561 and the user has not deferred quitting by binding `inhibit-quit'
8562 then quit right away. */
8563 if (immediate_quit
&& NILP (Vinhibit_quit
))
8565 struct gl_state_s saved
;
8566 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8571 GCPRO4 (saved
.object
, saved
.global_code
,
8572 saved
.current_syntax_table
, saved
.old_prop
);
8573 Fsignal (Qquit
, Qnil
);
8578 /* Else request quit when it's safe */
8582 if (waiting_for_input
&& !echoing
)
8583 quit_throw_to_read_char ();
8588 /* Handle a C-g by making read_char return C-g. */
8591 quit_throw_to_read_char ()
8593 quit_error_check ();
8595 /* Prevent another signal from doing this before we finish. */
8596 clear_waiting_for_input ();
8599 Vunread_command_events
= Qnil
;
8600 unread_command_char
= -1;
8602 #if 0 /* Currently, sit_for is called from read_char without turning
8603 off polling. And that can call set_waiting_for_input.
8604 It seems to be harmless. */
8605 #ifdef POLL_FOR_INPUT
8606 /* May be > 1 if in recursive minibuffer. */
8607 if (poll_suppress_count
== 0)
8611 if (FRAMEP (internal_last_event_frame
)
8612 && XFRAME (internal_last_event_frame
) != selected_frame
)
8613 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
8616 _longjmp (getcjmp
, 1);
8619 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
8620 "Set mode of reading keyboard input.\n\
8621 First arg INTERRUPT non-nil means use input interrupts;\n\
8622 nil means use CBREAK mode.\n\
8623 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
8624 (no effect except in CBREAK mode).\n\
8625 Third arg META t means accept 8-bit input (for a Meta key).\n\
8626 META nil means ignore the top bit, on the assumption it is parity.\n\
8627 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
8628 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
8629 See also `current-input-mode'.")
8630 (interrupt
, flow
, meta
, quit
)
8631 Lisp_Object interrupt
, flow
, meta
, quit
;
8634 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
8635 error ("set-input-mode: QUIT must be an ASCII character");
8637 #ifdef POLL_FOR_INPUT
8642 /* this causes startup screen to be restored and messes with the mouse */
8647 /* Note SIGIO has been undef'd if FIONREAD is missing. */
8648 if (read_socket_hook
)
8650 /* When using X, don't give the user a real choice,
8651 because we haven't implemented the mechanisms to support it. */
8652 #ifdef NO_SOCK_SIGIO
8653 interrupt_input
= 0;
8654 #else /* not NO_SOCK_SIGIO */
8655 interrupt_input
= 1;
8656 #endif /* NO_SOCK_SIGIO */
8659 interrupt_input
= !NILP (interrupt
);
8660 #else /* not SIGIO */
8661 interrupt_input
= 0;
8662 #endif /* not SIGIO */
8664 /* Our VMS input only works by interrupts, as of now. */
8666 interrupt_input
= 1;
8669 flow_control
= !NILP (flow
);
8672 else if (EQ (meta
, Qt
))
8677 /* Don't let this value be out of range. */
8678 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
8684 #ifdef POLL_FOR_INPUT
8685 poll_suppress_count
= 1;
8691 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
8692 "Return information about the way Emacs currently reads keyboard input.\n\
8693 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
8694 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
8695 nil, Emacs is using CBREAK mode.\n\
8696 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
8697 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
8698 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
8699 META nil means ignoring the top bit, on the assumption it is parity.\n\
8700 META is neither t nor nil if accepting 8-bit input and using\n\
8701 all 8 bits as the character code.\n\
8702 QUIT is the character Emacs currently uses to quit.\n\
8703 The elements of this list correspond to the arguments of\n\
8709 val
[0] = interrupt_input
? Qt
: Qnil
;
8710 val
[1] = flow_control
? Qt
: Qnil
;
8711 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
8712 XSETFASTINT (val
[3], quit_char
);
8714 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
8719 * Set up a new kboard object with reasonable initial values.
8725 kb
->Voverriding_terminal_local_map
= Qnil
;
8726 kb
->Vlast_command
= Qnil
;
8727 kb
->Vreal_last_command
= Qnil
;
8728 kb
->Vprefix_arg
= Qnil
;
8729 kb
->Vlast_prefix_arg
= Qnil
;
8730 kb
->kbd_queue
= Qnil
;
8731 kb
->kbd_queue_has_data
= 0;
8732 kb
->immediate_echo
= 0;
8733 kb
->echoptr
= kb
->echobuf
;
8734 kb
->echo_after_prompt
= -1;
8735 kb
->kbd_macro_buffer
= 0;
8736 kb
->kbd_macro_bufsize
= 0;
8737 kb
->defining_kbd_macro
= Qnil
;
8738 kb
->Vlast_kbd_macro
= Qnil
;
8739 kb
->reference_count
= 0;
8740 kb
->Vsystem_key_alist
= Qnil
;
8741 kb
->system_key_syms
= Qnil
;
8742 kb
->Vdefault_minibuffer_frame
= Qnil
;
8746 * Destroy the contents of a kboard object, but not the object itself.
8747 * We use this just before deleting it, or if we're going to initialize
8754 if (kb
->kbd_macro_buffer
)
8755 xfree (kb
->kbd_macro_buffer
);
8764 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
8767 *kbp
= kb
->next_kboard
;
8776 /* This is correct before outermost invocation of the editor loop */
8777 command_loop_level
= -1;
8779 quit_char
= Ctl ('g');
8780 Vunread_command_events
= Qnil
;
8781 unread_command_char
= -1;
8782 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
8784 recent_keys_index
= 0;
8785 kbd_fetch_ptr
= kbd_buffer
;
8786 kbd_store_ptr
= kbd_buffer
;
8787 kbd_buffer_frame_or_window
8788 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8790 do_mouse_tracking
= Qnil
;
8794 /* This means that command_loop_1 won't try to select anything the first
8796 internal_last_event_frame
= Qnil
;
8797 Vlast_event_frame
= internal_last_event_frame
;
8800 current_kboard
= initial_kboard
;
8802 wipe_kboard (current_kboard
);
8803 init_kboard (current_kboard
);
8806 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
8808 kbd_buffer_frame_or_window
8809 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8810 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
8812 signal (SIGINT
, interrupt_signal
);
8813 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
8814 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
8815 SIGQUIT and we can't tell which one it will give us. */
8816 signal (SIGQUIT
, interrupt_signal
);
8817 #endif /* HAVE_TERMIO */
8819 /* Note SIGIO has been undef'd if FIONREAD is missing. */
8821 if (!noninteractive
)
8822 signal (SIGIO
, input_available_signal
);
8825 /* Use interrupt input by default, if it works and noninterrupt input
8826 has deficiencies. */
8828 #ifdef INTERRUPT_INPUT
8829 interrupt_input
= 1;
8831 interrupt_input
= 0;
8834 /* Our VMS input only works by interrupts, as of now. */
8836 interrupt_input
= 1;
8842 if (keyboard_init_hook
)
8843 (*keyboard_init_hook
) ();
8845 #ifdef POLL_FOR_INPUT
8846 poll_suppress_count
= 1;
8851 /* This type's only use is in syms_of_keyboard, to initialize the
8852 event header symbols and put properties on them. */
8859 struct event_head head_table
[] = {
8860 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
8861 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
8862 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
8863 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
8864 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
8865 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
8871 staticpro (&item_properties
);
8872 item_properties
= Qnil
;
8874 staticpro (&real_this_command
);
8875 real_this_command
= Qnil
;
8877 Qtimer_event_handler
= intern ("timer-event-handler");
8878 staticpro (&Qtimer_event_handler
);
8880 Qdisabled_command_hook
= intern ("disabled-command-hook");
8881 staticpro (&Qdisabled_command_hook
);
8883 Qself_insert_command
= intern ("self-insert-command");
8884 staticpro (&Qself_insert_command
);
8886 Qforward_char
= intern ("forward-char");
8887 staticpro (&Qforward_char
);
8889 Qbackward_char
= intern ("backward-char");
8890 staticpro (&Qbackward_char
);
8892 Qdisabled
= intern ("disabled");
8893 staticpro (&Qdisabled
);
8895 Qundefined
= intern ("undefined");
8896 staticpro (&Qundefined
);
8898 Qpre_command_hook
= intern ("pre-command-hook");
8899 staticpro (&Qpre_command_hook
);
8901 Qpost_command_hook
= intern ("post-command-hook");
8902 staticpro (&Qpost_command_hook
);
8904 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
8905 staticpro (&Qpost_command_idle_hook
);
8907 Qdeferred_action_function
= intern ("deferred-action-function");
8908 staticpro (&Qdeferred_action_function
);
8910 Qcommand_hook_internal
= intern ("command-hook-internal");
8911 staticpro (&Qcommand_hook_internal
);
8913 Qfunction_key
= intern ("function-key");
8914 staticpro (&Qfunction_key
);
8915 Qmouse_click
= intern ("mouse-click");
8916 staticpro (&Qmouse_click
);
8918 Qmouse_wheel
= intern ("mouse-wheel");
8919 staticpro (&Qmouse_wheel
);
8921 Qdrag_n_drop
= intern ("drag-n-drop");
8922 staticpro (&Qdrag_n_drop
);
8924 Qmenu_enable
= intern ("menu-enable");
8925 staticpro (&Qmenu_enable
);
8926 Qmenu_alias
= intern ("menu-alias");
8927 staticpro (&Qmenu_alias
);
8928 QCenable
= intern (":enable");
8929 staticpro (&QCenable
);
8930 QCvisible
= intern (":visible");
8931 staticpro (&QCvisible
);
8932 QCfilter
= intern (":filter");
8933 staticpro (&QCfilter
);
8934 QCbutton
= intern (":button");
8935 staticpro (&QCbutton
);
8936 QCkeys
= intern (":keys");
8937 staticpro (&QCkeys
);
8938 QCkey_sequence
= intern (":key-sequence");
8939 staticpro (&QCkey_sequence
);
8940 QCtoggle
= intern (":toggle");
8941 staticpro (&QCtoggle
);
8942 QCradio
= intern (":radio");
8943 staticpro (&QCradio
);
8945 Qmode_line
= intern ("mode-line");
8946 staticpro (&Qmode_line
);
8947 Qvertical_line
= intern ("vertical-line");
8948 staticpro (&Qvertical_line
);
8949 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
8950 staticpro (&Qvertical_scroll_bar
);
8951 Qmenu_bar
= intern ("menu-bar");
8952 staticpro (&Qmenu_bar
);
8954 Qabove_handle
= intern ("above-handle");
8955 staticpro (&Qabove_handle
);
8956 Qhandle
= intern ("handle");
8957 staticpro (&Qhandle
);
8958 Qbelow_handle
= intern ("below-handle");
8959 staticpro (&Qbelow_handle
);
8960 Qup
= intern ("up");
8962 Qdown
= intern ("down");
8965 Qevent_kind
= intern ("event-kind");
8966 staticpro (&Qevent_kind
);
8967 Qevent_symbol_elements
= intern ("event-symbol-elements");
8968 staticpro (&Qevent_symbol_elements
);
8969 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
8970 staticpro (&Qevent_symbol_element_mask
);
8971 Qmodifier_cache
= intern ("modifier-cache");
8972 staticpro (&Qmodifier_cache
);
8974 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
8975 staticpro (&Qrecompute_lucid_menubar
);
8976 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
8977 staticpro (&Qactivate_menubar_hook
);
8979 Qpolling_period
= intern ("polling-period");
8980 staticpro (&Qpolling_period
);
8982 Qinput_method_function
= intern ("input-method-function");
8983 staticpro (&Qinput_method_function
);
8985 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
8986 staticpro (&Qinput_method_exit_on_first_char
);
8987 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
8988 staticpro (&Qinput_method_use_echo_area
);
8990 Fset (Qinput_method_exit_on_first_char
, Qnil
);
8991 Fset (Qinput_method_use_echo_area
, Qnil
);
8994 struct event_head
*p
;
8996 for (p
= head_table
;
8997 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
9000 *p
->var
= intern (p
->name
);
9002 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
9003 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
9007 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
9008 staticpro (&button_down_location
);
9012 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
9014 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
9015 for (i
= 0; i
< len
; i
++)
9016 if (modifier_names
[i
])
9017 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
9018 staticpro (&modifier_symbols
);
9021 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
9022 staticpro (&recent_keys
);
9024 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
9025 staticpro (&this_command_keys
);
9027 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
9028 staticpro (&raw_keybuf
);
9030 Qextended_command_history
= intern ("extended-command-history");
9031 Fset (Qextended_command_history
, Qnil
);
9032 staticpro (&Qextended_command_history
);
9034 kbd_buffer_frame_or_window
9035 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
9036 staticpro (&kbd_buffer_frame_or_window
);
9038 accent_key_syms
= Qnil
;
9039 staticpro (&accent_key_syms
);
9041 func_key_syms
= Qnil
;
9042 staticpro (&func_key_syms
);
9045 staticpro (&mouse_syms
);
9048 mouse_wheel_syms
= Qnil
;
9049 staticpro (&mouse_wheel_syms
);
9051 drag_n_drop_syms
= Qnil
;
9052 staticpro (&drag_n_drop_syms
);
9055 unread_switch_frame
= Qnil
;
9056 staticpro (&unread_switch_frame
);
9058 internal_last_event_frame
= Qnil
;
9059 staticpro (&internal_last_event_frame
);
9061 read_key_sequence_cmd
= Qnil
;
9062 staticpro (&read_key_sequence_cmd
);
9064 defsubr (&Sevent_convert_list
);
9065 defsubr (&Sread_key_sequence
);
9066 defsubr (&Sread_key_sequence_vector
);
9067 defsubr (&Srecursive_edit
);
9069 defsubr (&Strack_mouse
);
9071 defsubr (&Sinput_pending_p
);
9072 defsubr (&Scommand_execute
);
9073 defsubr (&Srecent_keys
);
9074 defsubr (&Sthis_command_keys
);
9075 defsubr (&Sthis_command_keys_vector
);
9076 defsubr (&Sthis_single_command_keys
);
9077 defsubr (&Sthis_single_command_raw_keys
);
9078 defsubr (&Sreset_this_command_lengths
);
9079 defsubr (&Sclear_this_command_keys
);
9080 defsubr (&Ssuspend_emacs
);
9081 defsubr (&Sabort_recursive_edit
);
9082 defsubr (&Sexit_recursive_edit
);
9083 defsubr (&Srecursion_depth
);
9084 defsubr (&Stop_level
);
9085 defsubr (&Sdiscard_input
);
9086 defsubr (&Sopen_dribble_file
);
9087 defsubr (&Sset_input_mode
);
9088 defsubr (&Scurrent_input_mode
);
9089 defsubr (&Sexecute_extended_command
);
9091 DEFVAR_LISP ("last-command-char", &last_command_char
,
9092 "Last input event that was part of a command.");
9094 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
9095 "Last input event that was part of a command.");
9097 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
9098 "Last input event in a command, except for mouse menu events.\n\
9099 Mouse menus give back keys that don't look like mouse events;\n\
9100 this variable holds the actual mouse event that led to the menu,\n\
9101 so that you can determine whether the command was run by mouse or not.");
9103 DEFVAR_LISP ("last-input-char", &last_input_char
,
9104 "Last input event.");
9106 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
9107 "Last input event.");
9109 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
9110 "List of events to be read as the command input.\n\
9111 These events are processed first, before actual keyboard input.");
9112 Vunread_command_events
= Qnil
;
9114 DEFVAR_INT ("unread-command-char", &unread_command_char
,
9115 "If not -1, an object to be read as next command input event.");
9117 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
9118 "List of events to be processed as input by input methods.\n\
9119 These events are processed after `unread-command-events', but\n\
9120 before actual keyboard input.");
9121 Vunread_post_input_method_events
= Qnil
;
9123 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
9124 "List of events to be processed as input by input methods.\n\
9125 These events are processed after `unread-command-events', but\n\
9126 before actual keyboard input.");
9127 Vunread_input_method_events
= Qnil
;
9129 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
9130 "Meta-prefix character code. Meta-foo as command input\n\
9131 turns into this character followed by foo.");
9132 XSETINT (meta_prefix_char
, 033);
9134 DEFVAR_KBOARD ("last-command", Vlast_command
,
9135 "The last command executed. Normally a symbol with a function definition,\n\
9136 but can be whatever was found in the keymap, or whatever the variable\n\
9137 `this-command' was set to by that command.\n\
9139 The value `mode-exit' is special; it means that the previous command\n\
9140 read an event that told it to exit, and it did so and unread that event.\n\
9141 In other words, the present command is the event that made the previous\n\
9144 The value `kill-region' is special; it means that the previous command\n\
9145 was a kill command.");
9147 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
9148 "Same as `last-command', but never altered by Lisp code.");
9150 DEFVAR_LISP ("this-command", &Vthis_command
,
9151 "The command now being executed.\n\
9152 The command can set this variable; whatever is put here\n\
9153 will be in `last-command' during the following command.");
9154 Vthis_command
= Qnil
;
9156 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
9157 "*Number of keyboard input characters between auto-saves.\n\
9158 Zero means disable autosaving due to number of characters typed.");
9159 auto_save_interval
= 300;
9161 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
9162 "*Number of seconds idle time before auto-save.\n\
9163 Zero or nil means disable auto-saving due to idleness.\n\
9164 After auto-saving due to this many seconds of idle time,\n\
9165 Emacs also does a garbage collection if that seems to be warranted.");
9166 XSETFASTINT (Vauto_save_timeout
, 30);
9168 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
9169 "*Nonzero means echo unfinished commands after this many seconds of pause.");
9170 echo_keystrokes
= 1;
9172 DEFVAR_INT ("polling-period", &polling_period
,
9173 "*Interval between polling for input during Lisp execution.\n\
9174 The reason for polling is to make C-g work to stop a running program.\n\
9175 Polling is needed only when using X windows and SIGIO does not work.\n\
9176 Polling is automatically disabled in all other cases.");
9179 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
9180 "*Maximum time between mouse clicks to make a double-click.\n\
9181 Measured in milliseconds. nil means disable double-click recognition;\n\
9182 t means double-clicks have no time limit and are detected\n\
9183 by position only.");
9184 Vdouble_click_time
= make_number (500);
9186 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
9187 "*Non-nil means inhibit local map menu bar menus.");
9188 inhibit_local_menu_bar_menus
= 0;
9190 DEFVAR_INT ("num-input-keys", &num_input_keys
,
9191 "Number of complete key sequences read as input so far.\n\
9192 This includes key sequences read from keyboard macros.\n\
9193 The number is effectively the number of interactive command invocations.");
9196 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
9197 "Number of input events read from the keyboard so far.\n\
9198 This does not include events generated by keyboard macros.");
9199 num_nonmacro_input_events
= 0;
9201 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
9202 "The frame in which the most recently read event occurred.\n\
9203 If the last event came from a keyboard macro, this is set to `macro'.");
9204 Vlast_event_frame
= Qnil
;
9206 /* This variable is set up in sysdep.c. */
9207 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
9208 "The ERASE character as set by the user with stty.");
9210 DEFVAR_LISP ("help-char", &Vhelp_char
,
9211 "Character to recognize as meaning Help.\n\
9212 When it is read, do `(eval help-form)', and display result if it's a string.\n\
9213 If the value of `help-form' is nil, this char can be read normally.");
9214 XSETINT (Vhelp_char
, Ctl ('H'));
9216 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
9217 "List of input events to recognize as meaning Help.\n\
9218 These work just like the value of `help-char' (see that).");
9219 Vhelp_event_list
= Qnil
;
9221 DEFVAR_LISP ("help-form", &Vhelp_form
,
9222 "Form to execute when character `help-char' is read.\n\
9223 If the form returns a string, that string is displayed.\n\
9224 If `help-form' is nil, the help char is not recognized.");
9227 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
9228 "Command to run when `help-char' character follows a prefix key.\n\
9229 This command is used only when there is no actual binding\n\
9230 for that character after that prefix key.");
9231 Vprefix_help_command
= Qnil
;
9233 DEFVAR_LISP ("top-level", &Vtop_level
,
9234 "Form to evaluate when Emacs starts up.\n\
9235 Useful to set before you dump a modified Emacs.");
9238 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
9239 "Translate table for keyboard input, or nil.\n\
9240 Each character is looked up in this string and the contents used instead.\n\
9241 The value may be a string, a vector, or a char-table.\n\
9242 If it is a string or vector of length N,\n\
9243 character codes N and up are untranslated.\n\
9244 In a vector or a char-table, an element which is nil means \"no translation\".");
9245 Vkeyboard_translate_table
= Qnil
;
9247 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
9248 "Non-nil means to always spawn a subshell instead of suspending,\n\
9249 even if the operating system has support for stopping a process.");
9252 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
9253 "Non-nil means prompt with menus when appropriate.\n\
9254 This is done when reading from a keymap that has a prompt string,\n\
9255 for elements that have prompt strings.\n\
9256 The menu is displayed on the screen\n\
9257 if X menus were enabled at configuration\n\
9258 time and the previous event was a mouse click prefix key.\n\
9259 Otherwise, menu prompting uses the echo area.");
9262 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
9263 "Character to see next line of menu prompt.\n\
9264 Type this character while in a menu prompt to rotate around the lines of it.");
9265 XSETINT (menu_prompt_more_char
, ' ');
9267 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
9268 "A mask of additional modifier keys to use with every keyboard character.\n\
9269 Emacs applies the modifiers of the character stored here to each keyboard\n\
9270 character it reads. For example, after evaluating the expression\n\
9271 (setq extra-keyboard-modifiers ?\\C-x)\n\
9272 all input characters will have the control modifier applied to them.\n\
9274 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
9275 not count as a control character; rather, it counts as a character\n\
9276 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
9277 cancels any modification.");
9278 extra_keyboard_modifiers
= 0;
9280 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
9281 "If an editing command sets this to t, deactivate the mark afterward.\n\
9282 The command loop sets this to nil before each command,\n\
9283 and tests the value when the command returns.\n\
9284 Buffer modification stores t in this variable.");
9285 Vdeactivate_mark
= Qnil
;
9287 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
9288 "Temporary storage of pre-command-hook or post-command-hook.");
9289 Vcommand_hook_internal
= Qnil
;
9291 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
9292 "Normal hook run before each command is executed.\n\
9293 If an unhandled error happens in running this hook,\n\
9294 the hook value is set to nil, since otherwise the error\n\
9295 might happen repeatedly and make Emacs nonfunctional.");
9296 Vpre_command_hook
= Qnil
;
9298 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
9299 "Normal hook run after each command is executed.\n\
9300 If an unhandled error happens in running this hook,\n\
9301 the hook value is set to nil, since otherwise the error\n\
9302 might happen repeatedly and make Emacs nonfunctional.");
9303 Vpost_command_hook
= Qnil
;
9305 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
9306 "Normal hook run after each command is executed, if idle.\n\
9307 Errors running the hook are caught and ignored.\n\
9308 This feature is obsolete; use idle timers instead. See `etc/NEWS'.");
9309 Vpost_command_idle_hook
= Qnil
;
9311 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
9312 "Delay time before running `post-command-idle-hook'.\n\
9313 This is measured in microseconds.");
9314 post_command_idle_delay
= 100000;
9317 DEFVAR_LISP ("echo-area-clear-hook", ...,
9318 "Normal hook run when clearing the echo area.");
9320 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
9321 XSYMBOL (Qecho_area_clear_hook
)->value
= Qnil
;
9323 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
9324 "t means menu bar, specified Lucid style, needs to be recomputed.");
9325 Vlucid_menu_bar_dirty_flag
= Qnil
;
9327 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
9328 "List of menu bar items to move to the end of the menu bar.\n\
9329 The elements of the list are event types that may have menu bar bindings.");
9330 Vmenu_bar_final_items
= Qnil
;
9332 DEFVAR_KBOARD ("overriding-terminal-local-map",
9333 Voverriding_terminal_local_map
,
9334 "Per-terminal keymap that overrides all other local keymaps.\n\
9335 If this variable is non-nil, it is used as a keymap instead of the\n\
9336 buffer's local map, and the minor mode keymaps and text property keymaps.\n\
9337 This variable is intended to let commands such as `universal-argumemnt'\n\
9338 set up a different keymap for reading the next command.");
9340 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
9341 "Keymap that overrides all other local keymaps.\n\
9342 If this variable is non-nil, it is used as a keymap instead of the\n\
9343 buffer's local map, and the minor mode keymaps and text property keymaps.");
9344 Voverriding_local_map
= Qnil
;
9346 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
9347 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
9348 Otherwise, the menu bar continues to reflect the buffer's local map\n\
9349 and the minor mode maps regardless of `overriding-local-map'.");
9350 Voverriding_local_map_menu_flag
= Qnil
;
9352 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
9353 "Keymap defining bindings for special events to execute at low level.");
9354 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
9356 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
9357 "*Non-nil means generate motion events for mouse motion.");
9359 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
9360 "Alist of system-specific X windows key symbols.\n\
9361 Each element should have the form (N . SYMBOL) where N is the\n\
9362 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
9363 and SYMBOL is its name.");
9365 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
9366 "List of deferred actions to be performed at a later time.\n\
9367 The precise format isn't relevant here; we just check whether it is nil.");
9368 Vdeferred_action_list
= Qnil
;
9370 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
9371 "Function to call to handle deferred actions, after each command.\n\
9372 This function is called with no arguments after each command\n\
9373 whenever `deferred-action-list' is non-nil.");
9374 Vdeferred_action_function
= Qnil
;
9376 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
9377 "*Non-nil means show the equivalent key-binding when M-x command has one.\n\
9378 The value can be a length of time to show the message for.\n\
9379 If the value is non-nil and not a number, we wait 2 seconds.");
9380 Vsuggest_key_bindings
= Qt
;
9382 DEFVAR_LISP ("timer-list", &Vtimer_list
,
9383 "List of active absolute time timers in order of increasing time");
9386 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
9387 "List of active idle-time timers in order of increasing time");
9388 Vtimer_idle_list
= Qnil
;
9390 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
9391 "If non-nil, the function that implements the current input method.\n\
9392 It's called with one argument, a printing character that was just read.\n\
9393 \(That means a character with code 040...0176.)\n\
9394 Typically this function uses `read-event' to read additional events.\n\
9395 When it does so, it should first bind `input-method-function' to nil\n\
9396 so it will not be called recursively.\n\
9398 The function should return a list of zero or more events\n\
9399 to be used as input. If it wants to put back some events\n\
9400 to be reconsidered, separately, by the input method,\n\
9401 it can add them to the beginning of `unread-command-events'.\n\
9403 The input method function can find in `input-method-previous-method'\n\
9404 the previous echo area message.\n\
9406 The input method function should refer to the variables\n\
9407 `input-method-use-echo-area' and `input-method-exit-on-first-char'\n\
9408 for guidance on what to do.");
9409 Vinput_method_function
= Qnil
;
9411 DEFVAR_LISP ("input-method-previous-message",
9412 &Vinput_method_previous_message
,
9413 "When `input-method-function' is called, hold the previous echo area message.\n\
9414 This variable exists because `read-event' clears the echo area\n\
9415 before running the input method. It is nil if there was no message.");
9416 Vinput_method_previous_message
= Qnil
;
9422 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
9423 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
9424 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
9425 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
9426 initial_define_key (meta_map
, 'x', "execute-extended-command");
9428 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
9429 "handle-delete-frame");
9430 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
9432 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",