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
;
491 Lisp_Object Qlanguage_change
;
493 Lisp_Object Qdrag_n_drop
;
494 /* Lisp_Object Qmouse_movement; - also an event header */
496 /* Properties of event headers. */
497 Lisp_Object Qevent_kind
;
498 Lisp_Object Qevent_symbol_elements
;
500 /* menu item parts */
501 Lisp_Object Qmenu_alias
;
502 Lisp_Object Qmenu_enable
;
503 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
504 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
505 extern Lisp_Object Vdefine_key_rebound_commands
;
506 extern Lisp_Object Qmenu_item
;
508 /* An event header symbol HEAD may have a property named
509 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
510 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
511 mask of modifiers applied to it. If present, this is used to help
512 speed up parse_modifiers. */
513 Lisp_Object Qevent_symbol_element_mask
;
515 /* An unmodified event header BASE may have a property named
516 Qmodifier_cache, which is an alist mapping modifier masks onto
517 modified versions of BASE. If present, this helps speed up
519 Lisp_Object Qmodifier_cache
;
521 /* Symbols to use for parts of windows. */
522 Lisp_Object Qmode_line
;
523 Lisp_Object Qvertical_line
;
524 Lisp_Object Qvertical_scroll_bar
;
525 Lisp_Object Qmenu_bar
;
527 Lisp_Object
recursive_edit_unwind (), command_loop ();
528 Lisp_Object
Fthis_command_keys ();
529 Lisp_Object Qextended_command_history
;
530 EMACS_TIME
timer_check ();
532 extern Lisp_Object Vhistory_length
;
534 extern char *x_get_keysym_name ();
536 static void record_menu_key ();
538 Lisp_Object Qpolling_period
;
540 /* List of absolute timers. Appears in order of next scheduled event. */
541 Lisp_Object Vtimer_list
;
543 /* List of idle time timers. Appears in order of next scheduled event. */
544 Lisp_Object Vtimer_idle_list
;
546 /* Incremented whenever a timer is run. */
549 extern Lisp_Object Vprint_level
, Vprint_length
;
551 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
553 EMACS_TIME
*input_available_clear_time
;
555 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
556 Default is 1 if INTERRUPT_INPUT is defined. */
559 /* Nonzero while interrupts are temporarily deferred during redisplay. */
560 int interrupts_deferred
;
562 /* Nonzero means use ^S/^Q for flow control. */
565 /* Allow m- file to inhibit use of FIONREAD. */
566 #ifdef BROKEN_FIONREAD
570 /* We are unable to use interrupts if FIONREAD is not available,
571 so flush SIGIO so we won't try. */
578 /* If we support a window system, turn on the code to poll periodically
579 to detect C-g. It isn't actually used when doing interrupt input. */
580 #ifdef HAVE_WINDOW_SYSTEM
581 #define POLL_FOR_INPUT
584 /* Global variable declarations. */
586 /* Function for init_keyboard to call with no args (if nonzero). */
587 void (*keyboard_init_hook
) ();
589 static int read_avail_input ();
590 static void get_input_pending ();
591 static int readable_events ();
592 static Lisp_Object
read_char_x_menu_prompt ();
593 static Lisp_Object
read_char_minibuf_menu_prompt ();
594 static Lisp_Object
make_lispy_event ();
596 static Lisp_Object
make_lispy_movement ();
598 static Lisp_Object
modify_event_symbol ();
599 static Lisp_Object
make_lispy_switch_frame ();
600 static int parse_solitary_modifier ();
601 static void save_getcjmp ();
602 static void restore_getcjmp ();
604 /* > 0 if we are to echo keystrokes. */
605 static int echo_keystrokes
;
607 /* Nonzero means don't try to suspend even if the operating system seems
609 static int cannot_suspend
;
611 #define min(a,b) ((a)<(b)?(a):(b))
612 #define max(a,b) ((a)>(b)?(a):(b))
614 /* Install the string STR as the beginning of the string of echoing,
615 so that it serves as a prompt for the next character.
616 Also start echoing. */
622 int len
= strlen (str
);
624 if (len
> ECHOBUFSIZE
- 4)
625 len
= ECHOBUFSIZE
- 4;
626 bcopy (str
, current_kboard
->echobuf
, len
);
627 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
628 *current_kboard
->echoptr
= '\0';
630 current_kboard
->echo_after_prompt
= len
;
635 /* Add C to the echo string, if echoing is going on.
636 C can be a character, which is printed prettily ("M-C-x" and all that
637 jazz), or a symbol, whose name is printed. */
643 extern char *push_key_description ();
645 if (current_kboard
->immediate_echo
)
647 char *ptr
= current_kboard
->echoptr
;
649 if (ptr
!= current_kboard
->echobuf
)
652 /* If someone has passed us a composite event, use its head symbol. */
657 if (ptr
- current_kboard
->echobuf
> ECHOBUFSIZE
- 6)
660 ptr
= push_key_description (XINT (c
), ptr
);
662 else if (SYMBOLP (c
))
664 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
665 if ((ptr
- current_kboard
->echobuf
) + STRING_BYTES (name
) + 4
668 bcopy (name
->data
, ptr
, STRING_BYTES (name
));
669 ptr
+= STRING_BYTES (name
);
672 if (current_kboard
->echoptr
== current_kboard
->echobuf
675 strcpy (ptr
, " (Type ? for further options)");
680 current_kboard
->echoptr
= ptr
;
686 /* Temporarily add a dash to the end of the echo string if it's not
687 empty, so that it serves as a mini-prompt for the very next character. */
692 if (!current_kboard
->immediate_echo
693 && current_kboard
->echoptr
== current_kboard
->echobuf
)
695 /* Do nothing if we just printed a prompt. */
696 if (current_kboard
->echo_after_prompt
697 == current_kboard
->echoptr
- current_kboard
->echobuf
)
699 /* Do nothing if not echoing at all. */
700 if (current_kboard
->echoptr
== 0)
703 /* Put a dash at the end of the buffer temporarily,
704 but make it go away when the next character is added. */
705 current_kboard
->echoptr
[0] = '-';
706 current_kboard
->echoptr
[1] = 0;
711 /* Display the current echo string, and begin echoing if not already
717 if (!current_kboard
->immediate_echo
)
720 current_kboard
->immediate_echo
= 1;
722 for (i
= 0; i
< this_command_key_count
; i
++)
725 c
= XVECTOR (this_command_keys
)->contents
[i
];
726 if (! (EVENT_HAS_PARAMETERS (c
)
727 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
734 message2_nolog (current_kboard
->echobuf
, strlen (current_kboard
->echobuf
),
735 ! NILP (current_buffer
->enable_multibyte_characters
));
739 if (waiting_for_input
&& !NILP (Vquit_flag
))
740 quit_throw_to_read_char ();
743 /* Turn off echoing, for the start of a new command. */
748 current_kboard
->immediate_echo
= 0;
749 current_kboard
->echoptr
= current_kboard
->echobuf
;
750 current_kboard
->echo_after_prompt
= -1;
751 ok_to_echo_at_next_pause
= 0;
754 /* Return the length of the current echo string. */
759 return current_kboard
->echoptr
- current_kboard
->echobuf
;
762 /* Truncate the current echo message to its first LEN chars.
763 This and echo_char get used by read_key_sequence when the user
764 switches frames while entering a key sequence. */
770 current_kboard
->echobuf
[len
] = '\0';
771 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
772 truncate_echo_area (len
);
776 /* Functions for manipulating this_command_keys. */
778 add_command_key (key
)
781 int size
= XVECTOR (this_command_keys
)->size
;
783 /* If reset-this-command-length was called recently, obey it now.
784 See the doc string of that function for an explanation of why. */
785 if (before_command_restore_flag
)
787 this_command_key_count
= before_command_key_count_1
;
788 if (this_command_key_count
< this_single_command_key_start
)
789 this_single_command_key_start
= this_command_key_count
;
790 echo_truncate (before_command_echo_length_1
);
791 before_command_restore_flag
= 0;
794 if (this_command_key_count
>= size
)
796 Lisp_Object new_keys
;
798 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
799 bcopy (XVECTOR (this_command_keys
)->contents
,
800 XVECTOR (new_keys
)->contents
,
801 size
* sizeof (Lisp_Object
));
803 this_command_keys
= new_keys
;
806 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
812 int count
= specpdl_ptr
- specpdl
;
815 if (command_loop_level
> 0)
817 specbind (Qstandard_output
, Qt
);
818 specbind (Qstandard_input
, Qt
);
821 val
= command_loop ();
823 Fsignal (Qquit
, Qnil
);
824 /* Handle throw from read_minibuf when using minibuffer
825 while it's active but we're in another window. */
827 Fsignal (Qerror
, Fcons (val
, Qnil
));
829 return unbind_to (count
, Qnil
);
832 /* When an auto-save happens, record the "time", and don't do again soon. */
837 last_auto_save
= num_nonmacro_input_events
;
840 /* Make an auto save happen as soon as possible at command level. */
843 force_auto_save_soon ()
845 last_auto_save
= - auto_save_interval
- 1;
847 record_asynch_buffer_change ();
850 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
851 "Invoke the editor command loop recursively.\n\
852 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
853 that tells this function to return.\n\
854 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
855 This function is called by the editor initialization to begin editing.")
858 int count
= specpdl_ptr
- specpdl
;
861 command_loop_level
++;
862 update_mode_lines
= 1;
864 record_unwind_protect (recursive_edit_unwind
,
866 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
870 return unbind_to (count
, Qnil
);
874 recursive_edit_unwind (buffer
)
878 Fset_buffer (buffer
);
880 command_loop_level
--;
881 update_mode_lines
= 1;
889 #if 0 /* Theory: if there's anything in Vunread_command_events,
890 it will right away be read by read_key_sequence,
891 and then if we do switch KBOARDS, it will go into the side
892 queue then. So we don't need to do anything special here -- rms. */
893 if (CONSP (Vunread_command_events
))
895 current_kboard
->kbd_queue
896 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
897 current_kboard
->kbd_queue_has_data
= 1;
899 Vunread_command_events
= Qnil
;
905 /* Switch to the single-kboard state, making current_kboard
906 the only KBOARD from which further input is accepted. */
909 single_kboard_state ()
916 /* Maintain a stack of kboards, so other parts of Emacs
917 can switch temporarily to the kboard of a given frame
918 and then revert to the previous status. */
923 struct kboard_stack
*next
;
926 static struct kboard_stack
*kboard_stack
;
929 push_frame_kboard (f
)
933 struct kboard_stack
*p
934 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
936 p
->next
= kboard_stack
;
937 p
->kboard
= current_kboard
;
940 current_kboard
= FRAME_KBOARD (f
);
948 struct kboard_stack
*p
= kboard_stack
;
949 current_kboard
= p
->kboard
;
950 kboard_stack
= p
->next
;
955 /* Handle errors that are not handled at inner levels
956 by printing an error message and returning to the editor command loop. */
962 Lisp_Object old_level
, old_length
;
965 if (!NILP (executing_macro
))
967 if (executing_macro_iterations
== 1)
968 sprintf (macroerror
, "After 1 kbd macro iteration: ");
970 sprintf (macroerror
, "After %d kbd macro iterations: ",
971 executing_macro_iterations
);
976 Vstandard_output
= Qt
;
977 Vstandard_input
= Qt
;
978 Vexecuting_macro
= Qnil
;
979 executing_macro
= Qnil
;
980 current_kboard
->Vprefix_arg
= Qnil
;
981 current_kboard
->Vlast_prefix_arg
= Qnil
;
984 /* Avoid unquittable loop if data contains a circular list. */
985 old_level
= Vprint_level
;
986 old_length
= Vprint_length
;
987 XSETFASTINT (Vprint_level
, 10);
988 XSETFASTINT (Vprint_length
, 10);
989 cmd_error_internal (data
, macroerror
);
990 Vprint_level
= old_level
;
991 Vprint_length
= old_length
;
995 Vinhibit_quit
= Qnil
;
1000 return make_number (0);
1003 /* Take actions on handling an error. DATA is the data that describes
1006 CONTEXT is a C-string containing ASCII characters only which
1007 describes the context in which the error happened. If we need to
1008 generalize CONTEXT to allow multibyte characters, make it a Lisp
1012 cmd_error_internal (data
, context
)
1020 echo_area_glyphs
= 0;
1022 /* If the window system or terminal frame hasn't been initialized
1023 yet, or we're not interactive, it's best to dump this message out
1024 to stderr and exit. */
1025 if (! FRAME_MESSAGE_BUF (selected_frame
)
1027 stream
= Qexternal_debugging_output
;
1036 write_string_1 (context
, -1, stream
);
1038 print_error_message (data
, stream
);
1040 /* If the window system or terminal frame hasn't been initialized
1041 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1042 if (! FRAME_MESSAGE_BUF (selected_frame
)
1046 Fkill_emacs (make_number (-1));
1050 Lisp_Object
command_loop_1 ();
1051 Lisp_Object
command_loop_2 ();
1052 Lisp_Object
top_level_1 ();
1054 /* Entry to editor-command-loop.
1055 This level has the catches for exiting/returning to editor command loop.
1056 It returns nil to exit recursive edit, t to abort it. */
1061 if (command_loop_level
> 0 || minibuf_level
> 0)
1064 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1065 executing_macro
= Qnil
;
1071 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1072 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1073 executing_macro
= Qnil
;
1075 /* End of file in -batch run causes exit here. */
1081 /* Here we catch errors in execution of commands within the
1082 editing loop, and reenter the editing loop.
1083 When there is an error, cmd_error runs and returns a non-nil
1084 value to us. A value of nil means that cmd_loop_1 itself
1085 returned due to end of file (or end of kbd macro). */
1090 register Lisp_Object val
;
1093 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1094 while (!NILP (val
));
1102 return Feval (Vtop_level
);
1108 /* On entry to the outer level, run the startup file */
1109 if (!NILP (Vtop_level
))
1110 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1111 else if (!NILP (Vpurify_flag
))
1112 message ("Bare impure Emacs (standard Lisp code not loaded)");
1114 message ("Bare Emacs (standard Lisp code not loaded)");
1118 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1119 "Exit all recursive editing levels.")
1122 Fthrow (Qtop_level
, Qnil
);
1125 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1126 "Exit from the innermost recursive edit or minibuffer.")
1129 if (command_loop_level
> 0 || minibuf_level
> 0)
1130 Fthrow (Qexit
, Qnil
);
1132 error ("No recursive edit is in progress");
1135 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1136 "Abort the command that requested this recursive edit or minibuffer input.")
1139 if (command_loop_level
> 0 || minibuf_level
> 0)
1142 error ("No recursive edit is in progress");
1145 /* This is the actual command reading loop,
1146 sans error-handling encapsulation. */
1148 Lisp_Object
Fcommand_execute ();
1149 static int read_key_sequence ();
1150 void safe_run_hooks ();
1155 Lisp_Object cmd
, tem
;
1158 Lisp_Object keybuf
[30];
1163 struct buffer
*prev_buffer
;
1165 int was_locked
= single_kboard
;
1168 current_kboard
->Vprefix_arg
= Qnil
;
1169 current_kboard
->Vlast_prefix_arg
= Qnil
;
1170 Vdeactivate_mark
= Qnil
;
1171 waiting_for_input
= 0;
1176 this_command_key_count
= 0;
1177 this_single_command_key_start
= 0;
1179 /* Make sure this hook runs after commands that get errors and
1180 throw to top level. */
1181 /* Note that the value cell will never directly contain nil
1182 if the symbol is a local variable. */
1183 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1184 safe_run_hooks (Qpost_command_hook
);
1186 if (!NILP (Vdeferred_action_list
))
1187 call0 (Vdeferred_action_function
);
1189 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1191 if (NILP (Vunread_command_events
)
1192 && NILP (Vunread_input_method_events
)
1193 && NILP (Vunread_post_input_method_events
)
1194 && NILP (Vexecuting_macro
)
1195 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1196 safe_run_hooks (Qpost_command_idle_hook
);
1199 /* Do this after running Vpost_command_hook, for consistency. */
1200 current_kboard
->Vlast_command
= Vthis_command
;
1201 current_kboard
->Vreal_last_command
= real_this_command
;
1205 if (! FRAME_LIVE_P (selected_frame
))
1208 /* Make sure the current window's buffer is selected. */
1209 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1210 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1212 /* Display any malloc warning that just came out. Use while because
1213 displaying one warning can cause another. */
1215 while (pending_malloc_warning
)
1216 display_malloc_warning ();
1220 Vdeactivate_mark
= Qnil
;
1222 /* If minibuffer on and echo area in use,
1223 wait 2 sec and redraw minibuffer. */
1225 if (minibuf_level
&& echo_area_glyphs
1226 && EQ (minibuf_window
, echo_area_window
))
1228 /* Bind inhibit-quit to t so that C-g gets read in
1229 rather than quitting back to the minibuffer. */
1230 int count
= specpdl_ptr
- specpdl
;
1231 specbind (Qinhibit_quit
, Qt
);
1233 Fsit_for (make_number (2), Qnil
, Qnil
);
1234 /* Clear the echo area. */
1236 safe_run_hooks (Qecho_area_clear_hook
);
1238 unbind_to (count
, Qnil
);
1240 /* If a C-g came in before, treat it as input now. */
1241 if (!NILP (Vquit_flag
))
1244 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1249 alloca (0); /* Cause a garbage collection now */
1250 /* Since we can free the most stuff here. */
1251 #endif /* C_ALLOCA */
1254 /* Select the frame that the last event came from. Usually,
1255 switch-frame events will take care of this, but if some lisp
1256 code swallows a switch-frame event, we'll fix things up here.
1257 Is this a good idea? */
1258 if (FRAMEP (internal_last_event_frame
)
1259 && XFRAME (internal_last_event_frame
) != selected_frame
)
1260 Fselect_frame (internal_last_event_frame
, Qnil
);
1262 /* If it has changed current-menubar from previous value,
1263 really recompute the menubar from the value. */
1264 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1265 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1266 call0 (Qrecompute_lucid_menubar
);
1268 before_command_key_count
= this_command_key_count
;
1269 before_command_echo_length
= echo_length ();
1271 Vthis_command
= Qnil
;
1272 real_this_command
= Qnil
;
1274 /* Read next key sequence; i gets its length. */
1275 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1278 /* A filter may have run while we were reading the input. */
1279 if (! FRAME_LIVE_P (selected_frame
))
1281 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1282 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1286 /* Now we have read a key sequence of length I,
1287 or else I is 0 and we found end of file. */
1289 if (i
== 0) /* End of file -- happens only in */
1290 return Qnil
; /* a kbd macro, at the end. */
1291 /* -1 means read_key_sequence got a menu that was rejected.
1292 Just loop around and read another command. */
1296 this_command_key_count
= 0;
1297 this_single_command_key_start
= 0;
1301 last_command_char
= keybuf
[i
- 1];
1303 /* If the previous command tried to force a specific window-start,
1304 forget about that, in case this command moves point far away
1305 from that position. But also throw away beg_unchanged and
1306 end_unchanged information in that case, so that redisplay will
1307 update the whole window properly. */
1308 if (!NILP (XWINDOW (selected_window
)->force_start
))
1310 XWINDOW (selected_window
)->force_start
= Qnil
;
1311 beg_unchanged
= end_unchanged
= 0;
1314 cmd
= read_key_sequence_cmd
;
1315 if (!NILP (Vexecuting_macro
))
1317 if (!NILP (Vquit_flag
))
1319 Vexecuting_macro
= Qt
;
1320 QUIT
; /* Make some noise. */
1321 /* Will return since macro now empty. */
1325 /* Do redisplay processing after this command except in special
1326 cases identified below that set no_redisplay to 1.
1327 (actually, there's currently no way to prevent the redisplay,
1328 and no_redisplay is ignored.
1329 Perhaps someday we will really implement it.) */
1332 prev_buffer
= current_buffer
;
1333 prev_modiff
= MODIFF
;
1334 last_point_position
= PT
;
1335 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1337 /* Execute the command. */
1339 Vthis_command
= cmd
;
1340 real_this_command
= cmd
;
1341 /* Note that the value cell will never directly contain nil
1342 if the symbol is a local variable. */
1343 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1344 safe_run_hooks (Qpre_command_hook
);
1346 if (NILP (Vthis_command
))
1348 /* nil means key is undefined. */
1350 current_kboard
->defining_kbd_macro
= Qnil
;
1351 update_mode_lines
= 1;
1352 current_kboard
->Vprefix_arg
= Qnil
;
1356 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1358 /* In case we jump to directly_done. */
1359 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1361 /* Recognize some common commands in common situations and
1362 do them directly. */
1363 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1365 struct Lisp_Char_Table
*dp
1366 = window_display_table (XWINDOW (selected_window
));
1367 lose
= FETCH_CHAR (PT_BYTE
);
1370 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1371 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1372 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1373 && (lose
>= 0x20 && lose
< 0x7f)))
1374 : (lose
>= 0x20 && lose
< 0x7f))
1375 /* To extract the case of continuation on
1376 wide-column characters. */
1377 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1378 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1380 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1382 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1384 && !windows_or_buffers_changed
1385 && EQ (current_buffer
->selective_display
, Qnil
)
1386 && !detect_input_pending ()
1387 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1388 && NILP (Vexecuting_macro
))
1389 no_redisplay
= direct_output_forward_char (1);
1392 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1394 struct Lisp_Char_Table
*dp
1395 = window_display_table (XWINDOW (selected_window
));
1397 lose
= FETCH_CHAR (PT_BYTE
);
1399 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1400 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1401 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1402 && (lose
>= 0x20 && lose
< 0x7f)))
1403 : (lose
>= 0x20 && lose
< 0x7f))
1404 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1406 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1408 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1410 && !windows_or_buffers_changed
1411 && EQ (current_buffer
->selective_display
, Qnil
)
1412 && !detect_input_pending ()
1413 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1414 && NILP (Vexecuting_macro
))
1415 no_redisplay
= direct_output_forward_char (-1);
1418 else if (EQ (Vthis_command
, Qself_insert_command
)
1419 /* Try this optimization only on ascii keystrokes. */
1420 && INTEGERP (last_command_char
))
1422 unsigned int c
= XINT (last_command_char
);
1425 if (NILP (Vexecuting_macro
)
1426 && !EQ (minibuf_window
, selected_window
))
1428 if (!nonundocount
|| nonundocount
>= 20)
1435 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1437 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1439 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1441 || MODIFF
<= SAVE_MODIFF
1442 || windows_or_buffers_changed
1443 || !EQ (current_buffer
->selective_display
, Qnil
)
1444 || detect_input_pending ()
1445 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1446 || !NILP (Vexecuting_macro
));
1447 value
= internal_self_insert (c
, 0);
1454 && (PT
== ZV
|| FETCH_BYTE (PT_BYTE
) == '\n'))
1456 struct Lisp_Char_Table
*dp
1457 = window_display_table (XWINDOW (selected_window
));
1460 /* Add the offset to the character, for Finsert_char.
1461 We pass internal_self_insert the unmodified character
1462 because it itself does this offsetting. */
1463 if (! NILP (current_buffer
->enable_multibyte_characters
))
1464 lose
= unibyte_char_to_multibyte (lose
);
1470 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1473 /* Do it only for char codes
1474 that by default display as themselves. */
1475 if (lose
>= 0x20 && lose
<= 0x7e)
1476 no_redisplay
= direct_output_for_insert (lose
);
1478 else if (VECTORP (obj
)
1479 && XVECTOR (obj
)->size
== 1
1480 && (obj
= XVECTOR (obj
)->contents
[0],
1482 /* Insist face not specified in glyph. */
1483 && (XINT (obj
) & ((-1) << 8)) == 0)
1485 = direct_output_for_insert (XINT (obj
));
1489 if (lose
>= 0x20 && lose
<= 0x7e)
1490 no_redisplay
= direct_output_for_insert (lose
);
1497 /* Here for a command that isn't executed directly */
1500 if (NILP (current_kboard
->Vprefix_arg
))
1502 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1505 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1507 /* Note that the value cell will never directly contain nil
1508 if the symbol is a local variable. */
1509 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1510 safe_run_hooks (Qpost_command_hook
);
1512 if (!NILP (Vdeferred_action_list
))
1513 safe_run_hooks (Qdeferred_action_function
);
1515 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1517 if (NILP (Vunread_command_events
)
1518 && NILP (Vunread_input_method_events
)
1519 && NILP (Vunread_post_input_method_events
)
1520 && NILP (Vexecuting_macro
)
1521 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1522 safe_run_hooks (Qpost_command_idle_hook
);
1525 /* If there is a prefix argument,
1526 1) We don't want Vlast_command to be ``universal-argument''
1527 (that would be dumb), so don't set Vlast_command,
1528 2) we want to leave echoing on so that the prefix will be
1529 echoed as part of this key sequence, so don't call
1531 3) we want to leave this_command_key_count non-zero, so that
1532 read_char will realize that it is re-reading a character, and
1533 not echo it a second time.
1535 If the command didn't actually create a prefix arg,
1536 but is merely a frame event that is transparent to prefix args,
1537 then the above doesn't apply. */
1538 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1540 current_kboard
->Vlast_command
= Vthis_command
;
1541 current_kboard
->Vreal_last_command
= real_this_command
;
1543 this_command_key_count
= 0;
1544 this_single_command_key_start
= 0;
1547 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1549 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1551 current_buffer
->mark_active
= Qnil
;
1552 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1554 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1555 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1559 /* Install chars successfully executed in kbd macro. */
1561 if (!NILP (current_kboard
->defining_kbd_macro
)
1562 && NILP (current_kboard
->Vprefix_arg
))
1563 finalize_kbd_macro_chars ();
1567 any_kboard_state ();
1572 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1575 safe_run_hooks_1 (hook
)
1578 return call1 (Vrun_hooks
, Vinhibit_quit
);
1581 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1584 safe_run_hooks_error (data
)
1587 Fset (Vinhibit_quit
, Qnil
);
1590 /* If we get an error while running the hook, cause the hook variable
1591 to be nil. Also inhibit quits, so that C-g won't cause the hook
1592 to mysteriously evaporate. */
1595 safe_run_hooks (hook
)
1599 int count
= specpdl_ptr
- specpdl
;
1600 specbind (Qinhibit_quit
, hook
);
1602 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1604 unbind_to (count
, Qnil
);
1607 /* Number of seconds between polling for input. */
1610 /* Nonzero means polling for input is temporarily suppressed. */
1611 int poll_suppress_count
;
1613 /* Nonzero if polling_for_input is actually being used. */
1614 int polling_for_input
;
1616 #ifdef POLL_FOR_INPUT
1618 /* Handle an alarm once each second and read pending input
1619 so as to handle a C-g if it comces in. */
1622 input_poll_signal (signalnum
) /* If we don't have an argument, */
1623 int signalnum
; /* some compilers complain in signal calls. */
1625 /* This causes the call to start_polling at the end
1626 to do its job. It also arranges for a quit or error
1627 from within read_avail_input to resume polling. */
1628 poll_suppress_count
++;
1629 if (interrupt_input_blocked
== 0
1630 && !waiting_for_input
)
1631 read_avail_input (0);
1632 /* Turn on the SIGALRM handler and request another alarm. */
1638 /* Begin signals to poll for input, if they are appropriate.
1639 This function is called unconditionally from various places. */
1644 #ifdef POLL_FOR_INPUT
1645 if (read_socket_hook
&& !interrupt_input
)
1647 poll_suppress_count
--;
1648 if (poll_suppress_count
== 0)
1650 signal (SIGALRM
, input_poll_signal
);
1651 polling_for_input
= 1;
1652 alarm (polling_period
);
1658 /* Nonzero if we are using polling to handle input asynchronously. */
1661 input_polling_used ()
1663 #ifdef POLL_FOR_INPUT
1664 return read_socket_hook
&& !interrupt_input
;
1670 /* Turn off polling. */
1675 #ifdef POLL_FOR_INPUT
1676 if (read_socket_hook
&& !interrupt_input
)
1678 if (poll_suppress_count
== 0)
1680 polling_for_input
= 0;
1683 poll_suppress_count
++;
1688 /* Set the value of poll_suppress_count to COUNT
1689 and start or stop polling accordingly. */
1692 set_poll_suppress_count (count
)
1695 #ifdef POLL_FOR_INPUT
1696 if (count
== 0 && poll_suppress_count
!= 0)
1698 poll_suppress_count
= 1;
1701 else if (count
!= 0 && poll_suppress_count
== 0)
1705 poll_suppress_count
= count
;
1709 /* Bind polling_period to a value at least N.
1710 But don't decrease it. */
1713 bind_polling_period (n
)
1716 #ifdef POLL_FOR_INPUT
1717 int new = polling_period
;
1723 specbind (Qpolling_period
, make_number (new));
1724 /* Start a new alarm with the new period. */
1729 /* Apply the control modifier to CHARACTER. */
1735 /* Save the upper bits here. */
1736 int upper
= c
& ~0177;
1740 /* Everything in the columns containing the upper-case letters
1741 denotes a control character. */
1742 if (c
>= 0100 && c
< 0140)
1746 /* Set the shift modifier for a control char
1747 made from a shifted letter. But only for letters! */
1748 if (oc
>= 'A' && oc
<= 'Z')
1749 c
|= shift_modifier
;
1752 /* The lower-case letters denote control characters too. */
1753 else if (c
>= 'a' && c
<= 'z')
1756 /* Include the bits for control and shift
1757 only if the basic ASCII code can't indicate them. */
1761 /* Replace the high bits. */
1762 c
|= (upper
& ~ctrl_modifier
);
1769 /* Input of single characters from keyboard */
1771 Lisp_Object
print_help ();
1772 static Lisp_Object
kbd_buffer_get_event ();
1773 static void record_char ();
1776 static jmp_buf wrong_kboard_jmpbuf
;
1779 /* read a character from the keyboard; call the redisplay if needed */
1780 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1781 -1 means do not do redisplay, but do do autosaving.
1784 /* The arguments MAPS and NMAPS are for menu prompting.
1785 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1787 PREV_EVENT is the previous input event, or nil if we are reading
1788 the first event of a key sequence (or not reading a key sequence).
1789 If PREV_EVENT is t, that is a "magic" value that says
1790 not to run input methods, but in other respects to act as if
1791 not reading a key sequence.
1793 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
1794 if we used a mouse menu to read the input, or zero otherwise. If
1795 USED_MOUSE_MENU is null, we don't dereference it.
1797 Value is t if we showed a menu and the user rejected it. */
1800 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1804 Lisp_Object prev_event
;
1805 int *used_mouse_menu
;
1809 jmp_buf local_getcjmp
;
1811 int key_already_recorded
= 0;
1812 Lisp_Object tem
, save
;
1813 Lisp_Object echo_area_message
;
1814 Lisp_Object also_record
;
1816 struct gcpro gcpro1
, gcpro2
;
1820 before_command_key_count
= this_command_key_count
;
1821 before_command_echo_length
= echo_length ();
1823 echo_area_message
= Qnil
;
1825 GCPRO2 (c
, echo_area_message
);
1830 if (CONSP (Vunread_post_input_method_events
))
1832 c
= XCONS (Vunread_post_input_method_events
)->car
;
1833 Vunread_post_input_method_events
1834 = XCONS (Vunread_post_input_method_events
)->cdr
;
1836 /* Undo what read_char_x_menu_prompt did when it unread
1837 additional keys returned by Fx_popup_menu. */
1839 && (SYMBOLP (XCONS (c
)->car
) || INTEGERP (XCONS (c
)->car
))
1840 && NILP (XCONS (c
)->cdr
))
1847 if (unread_command_char
!= -1)
1849 XSETINT (c
, unread_command_char
);
1850 unread_command_char
= -1;
1856 if (CONSP (Vunread_command_events
))
1858 c
= XCONS (Vunread_command_events
)->car
;
1859 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1861 /* Undo what read_char_x_menu_prompt did when it unread
1862 additional keys returned by Fx_popup_menu. */
1864 && (SYMBOLP (XCONS (c
)->car
) || INTEGERP (XCONS (c
)->car
))
1865 && NILP (XCONS (c
)->cdr
))
1869 goto reread_for_input_method
;
1872 if (CONSP (Vunread_input_method_events
))
1874 c
= XCONS (Vunread_input_method_events
)->car
;
1875 Vunread_input_method_events
= XCONS (Vunread_input_method_events
)->cdr
;
1877 /* Undo what read_char_x_menu_prompt did when it unread
1878 additional keys returned by Fx_popup_menu. */
1880 && (SYMBOLP (XCONS (c
)->car
) || INTEGERP (XCONS (c
)->car
))
1881 && NILP (XCONS (c
)->cdr
))
1884 goto reread_for_input_method
;
1887 /* If there is no function key translated before
1888 reset-this-command-lengths takes effect, forget about it. */
1889 before_command_restore_flag
= 0;
1891 if (!NILP (Vexecuting_macro
))
1893 /* We set this to Qmacro; since that's not a frame, nobody will
1894 try to switch frames on us, and the selected window will
1897 Since this event came from a macro, it would be misleading to
1898 leave internal_last_event_frame set to wherever the last
1899 real event came from. Normally, a switch-frame event selects
1900 internal_last_event_frame after each command is read, but
1901 events read from a macro should never cause a new frame to be
1903 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1905 /* Exit the macro if we are at the end.
1906 Also, some things replace the macro with t
1907 to force an early exit. */
1908 if (EQ (Vexecuting_macro
, Qt
)
1909 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1915 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1916 if (STRINGP (Vexecuting_macro
)
1917 && (XINT (c
) & 0x80))
1918 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
1920 executing_macro_index
++;
1925 if (!NILP (unread_switch_frame
))
1927 c
= unread_switch_frame
;
1928 unread_switch_frame
= Qnil
;
1930 /* This event should make it into this_command_keys, and get echoed
1931 again, so we do not set `reread'. */
1935 /* if redisplay was requested */
1936 if (commandflag
>= 0)
1938 /* If there is pending input, process any events which are not
1939 user-visible, such as X selection_request events. */
1941 || detect_input_pending_run_timers (0))
1942 swallow_events (0); /* may clear input_pending */
1944 /* Redisplay if no pending input. */
1945 while (!input_pending
)
1950 /* Normal case: no input arrived during redisplay. */
1953 /* Input arrived and pre-empted redisplay.
1954 Process any events which are not user-visible. */
1956 /* If that cleared input_pending, try again to redisplay. */
1960 /* Message turns off echoing unless more keystrokes turn it on again. */
1961 if (echo_area_glyphs
&& *echo_area_glyphs
1962 && echo_area_glyphs
!= current_kboard
->echobuf
1963 && ok_to_echo_at_next_pause
!= echo_area_glyphs
)
1966 /* If already echoing, continue. */
1969 /* Try reading a character via menu prompting in the minibuf.
1970 Try this before the sit-for, because the sit-for
1971 would do the wrong thing if we are supposed to do
1972 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1973 after a mouse event so don't try a minibuf menu. */
1975 if (nmaps
> 0 && INTERACTIVE
1976 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1977 /* Don't bring up a menu if we already have another event. */
1978 && NILP (Vunread_command_events
)
1979 && unread_command_char
< 0
1980 && !detect_input_pending_run_timers (0))
1982 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1985 key_already_recorded
= 1;
1990 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
1991 We will do that below, temporarily for short sections of code,
1992 when appropriate. local_getcjmp must be in effect
1993 around any call to sit_for or kbd_buffer_get_event;
1994 it *must not* be in effect when we call redisplay. */
1996 if (_setjmp (local_getcjmp
))
1998 XSETINT (c
, quit_char
);
1999 XSETFRAME (internal_last_event_frame
, selected_frame
);
2000 Vlast_event_frame
= internal_last_event_frame
;
2001 /* If we report the quit char as an event,
2002 don't do so more than once. */
2003 if (!NILP (Vinhibit_quit
))
2008 KBOARD
*kb
= FRAME_KBOARD (selected_frame
);
2009 if (kb
!= current_kboard
)
2011 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2012 /* We shouldn't get here if we were in single-kboard mode! */
2015 while (CONSP (*tailp
))
2016 tailp
= &XCONS (*tailp
)->cdr
;
2019 *tailp
= Fcons (c
, Qnil
);
2020 kb
->kbd_queue_has_data
= 1;
2021 current_kboard
= kb
;
2022 /* This is going to exit from read_char
2023 so we had better get rid of this frame's stuff. */
2025 longjmp (wrong_kboard_jmpbuf
, 1);
2032 timer_start_idle ();
2034 /* If in middle of key sequence and minibuffer not active,
2035 start echoing if enough time elapses. */
2037 if (minibuf_level
== 0 && !current_kboard
->immediate_echo
2038 && this_command_key_count
> 0
2040 && echo_keystrokes
> 0
2041 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0
2042 || ok_to_echo_at_next_pause
== echo_area_glyphs
))
2046 /* After a mouse event, start echoing right away.
2047 This is because we are probably about to display a menu,
2048 and we don't want to delay before doing so. */
2049 if (EVENT_HAS_PARAMETERS (prev_event
))
2053 save_getcjmp (save_jump
);
2054 restore_getcjmp (local_getcjmp
);
2055 tem0
= sit_for (echo_keystrokes
, 0, 1, 1, 0);
2056 restore_getcjmp (save_jump
);
2058 && ! CONSP (Vunread_command_events
))
2063 /* Maybe auto save due to number of keystrokes. */
2065 if (commandflag
!= 0
2066 && auto_save_interval
> 0
2067 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2068 && !detect_input_pending_run_timers (0))
2070 Fdo_auto_save (Qnil
, Qnil
);
2071 /* Hooks can actually change some buffers in auto save. */
2075 /* Try reading using an X menu.
2076 This is never confused with reading using the minibuf
2077 because the recursive call of read_char in read_char_minibuf_menu_prompt
2078 does not pass on any keymaps. */
2080 if (nmaps
> 0 && INTERACTIVE
2081 && !NILP (prev_event
)
2082 && EVENT_HAS_PARAMETERS (prev_event
)
2083 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
)
2084 /* Don't bring up a menu if we already have another event. */
2085 && NILP (Vunread_command_events
)
2086 && unread_command_char
< 0)
2088 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2090 /* Now that we have read an event, Emacs is not idle. */
2096 /* Maybe autosave and/or garbage collect due to idleness. */
2098 if (INTERACTIVE
&& NILP (c
))
2100 int delay_level
, buffer_size
;
2102 /* Slow down auto saves logarithmically in size of current buffer,
2103 and garbage collect while we're at it. */
2104 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2105 last_non_minibuf_size
= Z
- BEG
;
2106 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2108 while (buffer_size
> 64)
2109 delay_level
++, buffer_size
-= buffer_size
>> 2;
2110 if (delay_level
< 4) delay_level
= 4;
2111 /* delay_level is 4 for files under around 50k, 7 at 100k,
2112 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2114 /* Auto save if enough time goes by without input. */
2115 if (commandflag
!= 0
2116 && num_nonmacro_input_events
> last_auto_save
2117 && INTEGERP (Vauto_save_timeout
)
2118 && XINT (Vauto_save_timeout
) > 0)
2122 save_getcjmp (save_jump
);
2123 restore_getcjmp (local_getcjmp
);
2124 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2126 restore_getcjmp (save_jump
);
2129 && ! CONSP (Vunread_command_events
))
2131 Fdo_auto_save (Qnil
, Qnil
);
2133 /* If we have auto-saved and there is still no input
2134 available, garbage collect if there has been enough
2135 consing going on to make it worthwhile. */
2136 if (!detect_input_pending_run_timers (0)
2137 && consing_since_gc
> gc_cons_threshold
/ 2)
2138 Fgarbage_collect ();
2145 /* If this has become non-nil here, it has been set by a timer
2146 or sentinel or filter. */
2147 if (CONSP (Vunread_command_events
))
2149 c
= XCONS (Vunread_command_events
)->car
;
2150 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
2153 /* Read something from current KBOARD's side queue, if possible. */
2157 if (current_kboard
->kbd_queue_has_data
)
2159 if (!CONSP (current_kboard
->kbd_queue
))
2161 c
= XCONS (current_kboard
->kbd_queue
)->car
;
2162 current_kboard
->kbd_queue
2163 = XCONS (current_kboard
->kbd_queue
)->cdr
;
2164 if (NILP (current_kboard
->kbd_queue
))
2165 current_kboard
->kbd_queue_has_data
= 0;
2166 input_pending
= readable_events (0);
2167 if (EVENT_HAS_PARAMETERS (c
)
2168 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2169 internal_last_event_frame
= XCONS (XCONS (c
)->cdr
)->car
;
2170 Vlast_event_frame
= internal_last_event_frame
;
2175 /* If current_kboard's side queue is empty check the other kboards.
2176 If one of them has data that we have not yet seen here,
2177 switch to it and process the data waiting for it.
2179 Note: if the events queued up for another kboard
2180 have already been seen here, and therefore are not a complete command,
2181 the kbd_queue_has_data field is 0, so we skip that kboard here.
2182 That's to avoid an infinite loop switching between kboards here. */
2183 if (NILP (c
) && !single_kboard
)
2186 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2187 if (kb
->kbd_queue_has_data
)
2189 current_kboard
= kb
;
2190 /* This is going to exit from read_char
2191 so we had better get rid of this frame's stuff. */
2193 longjmp (wrong_kboard_jmpbuf
, 1);
2202 /* Finally, we read from the main queue,
2203 and if that gives us something we can't use yet, we put it on the
2204 appropriate side queue and try again. */
2210 /* Actually read a character, waiting if necessary. */
2211 save_getcjmp (save_jump
);
2212 restore_getcjmp (local_getcjmp
);
2213 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2214 restore_getcjmp (save_jump
);
2217 if (! NILP (c
) && (kb
!= current_kboard
))
2219 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2220 while (CONSP (*tailp
))
2221 tailp
= &XCONS (*tailp
)->cdr
;
2224 *tailp
= Fcons (c
, Qnil
);
2225 kb
->kbd_queue_has_data
= 1;
2229 current_kboard
= kb
;
2230 /* This is going to exit from read_char
2231 so we had better get rid of this frame's stuff. */
2233 longjmp (wrong_kboard_jmpbuf
, 1);
2238 /* Terminate Emacs in batch mode if at eof. */
2239 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2240 Fkill_emacs (make_number (1));
2244 /* Add in any extra modifiers, where appropriate. */
2245 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2246 || ((extra_keyboard_modifiers
& 0177) < ' '
2247 && (extra_keyboard_modifiers
& 0177) != 0))
2248 XSETINT (c
, make_ctrl_char (XINT (c
)));
2250 /* Transfer any other modifier bits directly from
2251 extra_keyboard_modifiers to c. Ignore the actual character code
2252 in the low 16 bits of extra_keyboard_modifiers. */
2253 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2264 if (commandflag
>= 0
2265 && !input_pending
&& !detect_input_pending_run_timers (0))
2273 /* Buffer switch events are only for internal wakeups
2274 so don't show them to the user.
2275 Also, don't record a key if we already did. */
2276 if (BUFFERP (c
) || key_already_recorded
)
2279 /* Process special events within read_char
2280 and loop around to read another event. */
2283 tem
= get_keyelt (access_keymap (get_keymap_1 (Vspecial_event_map
, 0, 0),
2289 int was_locked
= single_kboard
;
2291 last_input_char
= c
;
2292 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2294 /* Resume allowing input from any kboard, if that was true before. */
2296 any_kboard_state ();
2301 /* Handle things that only apply to characters. */
2304 /* If kbd_buffer_get_event gave us an EOF, return that. */
2308 if ((STRINGP (Vkeyboard_translate_table
)
2309 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2310 || (VECTORP (Vkeyboard_translate_table
)
2311 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2312 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2313 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2316 d
= Faref (Vkeyboard_translate_table
, c
);
2317 /* nil in keyboard-translate-table means no translation. */
2323 /* If this event is a mouse click in the menu bar,
2324 return just menu-bar for now. Modify the mouse click event
2325 so we won't do this twice, then queue it up. */
2326 if (EVENT_HAS_PARAMETERS (c
)
2327 && CONSP (XCONS (c
)->cdr
)
2328 && CONSP (EVENT_START (c
))
2329 && CONSP (XCONS (EVENT_START (c
))->cdr
))
2333 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2334 /* Handle menu-bar events:
2335 insert the dummy prefix event `menu-bar'. */
2336 if (EQ (posn
, Qmenu_bar
))
2338 /* Change menu-bar to (menu-bar) as the event "position". */
2339 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2342 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2347 /* Store these characters into recent_keys, the dribble file if any,
2348 and the keyboard macro being defined, if any. */
2350 if (! NILP (also_record
))
2351 record_char (also_record
);
2353 /* Wipe the echo area.
2354 But first, if we are about to use an input method,
2355 save the echo area contents for it to refer to. */
2357 && ! NILP (Vinput_method_function
)
2358 && (unsigned) XINT (c
) >= ' '
2359 && (unsigned) XINT (c
) < 127)
2360 Vinput_method_previous_message
= echo_area_message
= Fcurrent_message ();
2362 /* Now wipe the echo area. */
2363 if (echo_area_glyphs
)
2364 safe_run_hooks (Qecho_area_clear_hook
);
2365 echo_area_glyphs
= 0;
2367 reread_for_input_method
:
2369 /* Pass this to the input method, if appropriate. */
2371 && ! NILP (Vinput_method_function
)
2372 /* Don't run the input method within a key sequence,
2373 after the first event of the key sequence. */
2374 && NILP (prev_event
)
2375 && (unsigned) XINT (c
) >= ' '
2376 && (unsigned) XINT (c
) < 127)
2380 struct gcpro gcpro1
;
2381 int count
= specpdl_ptr
- specpdl
;
2383 /* Save the echo status. */
2384 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2385 char *saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2386 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2388 if (before_command_restore_flag
)
2390 this_command_key_count
= before_command_key_count_1
;
2391 if (this_command_key_count
< this_single_command_key_start
)
2392 this_single_command_key_start
= this_command_key_count
;
2393 echo_truncate (before_command_echo_length_1
);
2394 before_command_restore_flag
= 0;
2397 /* Save the this_command_keys status. */
2398 key_count
= this_command_key_count
;
2401 keys
= Fcopy_sequence (this_command_keys
);
2406 /* Clear out this_command_keys. */
2407 this_command_key_count
= 0;
2409 /* Now wipe the echo area. */
2410 if (echo_area_glyphs
)
2411 safe_run_hooks (Qecho_area_clear_hook
);
2412 echo_area_glyphs
= 0;
2415 /* If we are not reading a key sequence,
2416 never use the echo area. */
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
));
3083 else if (event
->kind
== language_change_event
)
3085 /* Make an event (language-change (FRAME CHARSET LCID)). */
3086 obj
= Fcons (event
->modifiers
, Qnil
);
3087 obj
= Fcons (event
->code
, Qnil
);
3088 obj
= Fcons (event
->frame_or_window
, obj
);
3089 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3090 kbd_fetch_ptr
= event
+ 1;
3093 /* Just discard these, by returning nil.
3094 With MULTI_KBOARD, these events are used as placeholders
3095 when we need to randomly delete events from the queue.
3096 (They shouldn't otherwise be found in the buffer,
3097 but on some machines it appears they do show up
3098 even without MULTI_KBOARD.) */
3099 /* On Windows NT/9X, no_event is used to delete extraneous
3100 mouse events during a popup-menu call. */
3101 else if (event
->kind
== no_event
)
3102 kbd_fetch_ptr
= event
+ 1;
3104 /* If this event is on a different frame, return a switch-frame this
3105 time, and leave the event in the queue for next time. */
3111 frame
= event
->frame_or_window
;
3113 frame
= XCONS (frame
)->car
;
3114 else if (WINDOWP (frame
))
3115 frame
= WINDOW_FRAME (XWINDOW (frame
));
3117 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3121 if (! EQ (frame
, internal_last_event_frame
)
3122 && XFRAME (frame
) != selected_frame
)
3123 obj
= make_lispy_switch_frame (frame
);
3124 internal_last_event_frame
= frame
;
3126 /* If we didn't decide to make a switch-frame event, go ahead
3127 and build a real event from the queue entry. */
3131 obj
= make_lispy_event (event
);
3132 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
3133 /* If this was a menu selection, then set the flag to inhibit
3134 writing to last_nonmenu_event. Don't do this if the event
3135 we're returning is (menu-bar), though; that indicates the
3136 beginning of the menu sequence, and we might as well leave
3137 that as the `event with parameters' for this selection. */
3138 if (event
->kind
== menu_bar_event
3139 && !(CONSP (obj
) && EQ (XCONS (obj
)->car
, Qmenu_bar
))
3141 *used_mouse_menu
= 1;
3144 /* Wipe out this event, to catch bugs. */
3145 event
->kind
= no_event
;
3146 XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
] = Qnil
;
3148 kbd_fetch_ptr
= event
+ 1;
3153 /* Try generating a mouse motion event. */
3154 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3156 FRAME_PTR f
= some_mouse_moved ();
3157 Lisp_Object bar_window
;
3158 enum scroll_bar_part part
;
3162 *kbp
= current_kboard
;
3163 /* Note that this uses F to determine which display to look at.
3164 If there is no valid info, it does not store anything
3165 so x remains nil. */
3167 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
3171 /* Decide if we should generate a switch-frame event. Don't
3172 generate switch-frame events for motion outside of all Emacs
3178 frame
= FRAME_FOCUS_FRAME (f
);
3180 XSETFRAME (frame
, f
);
3182 if (! EQ (frame
, internal_last_event_frame
)
3183 && XFRAME (frame
) != selected_frame
)
3184 obj
= make_lispy_switch_frame (frame
);
3185 internal_last_event_frame
= frame
;
3188 /* If we didn't decide to make a switch-frame event, go ahead and
3189 return a mouse-motion event. */
3190 if (!NILP (x
) && NILP (obj
))
3191 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
3193 #endif /* HAVE_MOUSE */
3195 /* We were promised by the above while loop that there was
3196 something for us to read! */
3199 input_pending
= readable_events (0);
3201 Vlast_event_frame
= internal_last_event_frame
;
3206 /* Process any events that are not user-visible,
3207 then return, without reading any user-visible events. */
3210 swallow_events (do_display
)
3215 while (kbd_fetch_ptr
!= kbd_store_ptr
)
3217 struct input_event
*event
;
3219 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3223 last_event_timestamp
= event
->timestamp
;
3225 /* These two kinds of events get special handling
3226 and don't actually appear to the command loop. */
3227 if (event
->kind
== selection_request_event
)
3230 struct input_event copy
;
3232 /* Remove it from the buffer before processing it,
3233 since otherwise swallow_events called recursively could see it
3234 and process it again. */
3236 kbd_fetch_ptr
= event
+ 1;
3237 input_pending
= readable_events (0);
3238 x_handle_selection_request (©
);
3240 /* We're getting selection request events, but we don't have
3246 else if (event
->kind
== selection_clear_event
)
3249 struct input_event copy
;
3251 /* Remove it from the buffer before processing it, */
3254 kbd_fetch_ptr
= event
+ 1;
3255 input_pending
= readable_events (0);
3256 x_handle_selection_clear (©
);
3258 /* We're getting selection request events, but we don't have
3267 old_timers_run
= timers_run
;
3268 get_input_pending (&input_pending
, 1);
3270 if (timers_run
!= old_timers_run
&& do_display
)
3271 redisplay_preserve_echo_area ();
3274 static EMACS_TIME timer_idleness_start_time
;
3276 /* Record the start of when Emacs is idle,
3277 for the sake of running idle-time timers. */
3284 /* If we are already in the idle state, do nothing. */
3285 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3288 EMACS_GET_TIME (timer_idleness_start_time
);
3290 /* Mark all idle-time timers as once again candidates for running. */
3291 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCONS (timers
)->cdr
)
3295 timer
= XCONS (timers
)->car
;
3297 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3299 XVECTOR (timer
)->contents
[0] = Qnil
;
3303 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
3308 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
3311 /* This is only for debugging. */
3312 struct input_event last_timer_event
;
3314 /* Check whether a timer has fired. To prevent larger problems we simply
3315 disregard elements that are not proper timers. Do not make a circular
3316 timer list for the time being.
3318 Returns the number of seconds to wait until the next timer fires. If a
3319 timer is triggering now, return zero seconds.
3320 If no timer is active, return -1 seconds.
3322 If a timer is ripe, we run it, with quitting turned off.
3324 DO_IT_NOW is now ignored. It used to mean that we should
3325 run the timer directly instead of queueing a timer-event.
3326 Now we always run timers directly. */
3329 timer_check (do_it_now
)
3332 EMACS_TIME nexttime
;
3333 EMACS_TIME now
, idleness_now
;
3334 Lisp_Object timers
, idle_timers
, chosen_timer
;
3335 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3337 EMACS_SET_SECS (nexttime
, -1);
3338 EMACS_SET_USECS (nexttime
, -1);
3340 /* Always consider the ordinary timers. */
3341 timers
= Vtimer_list
;
3342 /* Consider the idle timers only if Emacs is idle. */
3343 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3344 idle_timers
= Vtimer_idle_list
;
3347 chosen_timer
= Qnil
;
3348 GCPRO3 (timers
, idle_timers
, chosen_timer
);
3350 if (CONSP (timers
) || CONSP (idle_timers
))
3352 EMACS_GET_TIME (now
);
3353 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3354 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
3357 while (CONSP (timers
) || CONSP (idle_timers
))
3359 int triggertime
= EMACS_SECS (now
);
3360 Lisp_Object
*vector
;
3361 Lisp_Object timer
, idle_timer
;
3362 EMACS_TIME timer_time
, idle_timer_time
;
3363 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
3365 /* Skip past invalid timers and timers already handled. */
3368 timer
= XCONS (timers
)->car
;
3369 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3371 timers
= XCONS (timers
)->cdr
;
3374 vector
= XVECTOR (timer
)->contents
;
3376 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3377 || !INTEGERP (vector
[3])
3378 || ! NILP (vector
[0]))
3380 timers
= XCONS (timers
)->cdr
;
3384 if (!NILP (idle_timers
))
3386 timer
= XCONS (idle_timers
)->car
;
3387 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3389 idle_timers
= XCONS (idle_timers
)->cdr
;
3392 vector
= XVECTOR (timer
)->contents
;
3394 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3395 || !INTEGERP (vector
[3])
3396 || ! NILP (vector
[0]))
3398 idle_timers
= XCONS (idle_timers
)->cdr
;
3403 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
3404 based on the next ordinary timer.
3405 TIMER_DIFFERENCE is the distance in time from NOW to when
3406 this timer becomes ripe (negative if it's already ripe). */
3409 timer
= XCONS (timers
)->car
;
3410 vector
= XVECTOR (timer
)->contents
;
3411 EMACS_SET_SECS (timer_time
,
3412 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3413 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
3414 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
3417 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
3418 based on the next idle timer. */
3419 if (!NILP (idle_timers
))
3421 idle_timer
= XCONS (idle_timers
)->car
;
3422 vector
= XVECTOR (idle_timer
)->contents
;
3423 EMACS_SET_SECS (idle_timer_time
,
3424 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3425 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
3426 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
3429 /* Decide which timer is the next timer,
3430 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
3431 Also step down the list where we found that timer. */
3433 if (! NILP (timers
) && ! NILP (idle_timers
))
3436 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
3437 if (EMACS_TIME_NEG_P (temp
))
3439 chosen_timer
= timer
;
3440 timers
= XCONS (timers
)->cdr
;
3441 difference
= timer_difference
;
3445 chosen_timer
= idle_timer
;
3446 idle_timers
= XCONS (idle_timers
)->cdr
;
3447 difference
= idle_timer_difference
;
3450 else if (! NILP (timers
))
3452 chosen_timer
= timer
;
3453 timers
= XCONS (timers
)->cdr
;
3454 difference
= timer_difference
;
3458 chosen_timer
= idle_timer
;
3459 idle_timers
= XCONS (idle_timers
)->cdr
;
3460 difference
= idle_timer_difference
;
3462 vector
= XVECTOR (chosen_timer
)->contents
;
3464 /* If timer is rupe, run it if it hasn't been run. */
3465 if (EMACS_TIME_NEG_P (difference
)
3466 || (EMACS_SECS (difference
) == 0
3467 && EMACS_USECS (difference
) == 0))
3469 if (NILP (vector
[0]))
3472 int was_locked
= single_kboard
;
3473 int count
= specpdl_ptr
- specpdl
;
3475 /* Mark the timer as triggered to prevent problems if the lisp
3476 code fails to reschedule it right. */
3479 specbind (Qinhibit_quit
, Qt
);
3481 call1 (Qtimer_event_handler
, chosen_timer
);
3484 unbind_to (count
, Qnil
);
3486 /* Resume allowing input from any kboard, if that was true before. */
3488 any_kboard_state ();
3490 /* Since we have handled the event,
3491 we don't need to tell the caller to wake up and do it. */
3495 /* When we encounter a timer that is still waiting,
3496 return the amount of time to wait before it is ripe. */
3503 /* No timers are pending in the future. */
3504 /* Return 0 if we generated an event, and -1 if not. */
3509 /* Caches for modify_event_symbol. */
3510 static Lisp_Object accent_key_syms
;
3511 static Lisp_Object func_key_syms
;
3512 static Lisp_Object mouse_syms
;
3514 static Lisp_Object mouse_wheel_syms
;
3516 static Lisp_Object drag_n_drop_syms
;
3518 /* This is a list of keysym codes for special "accent" characters.
3519 It parallels lispy_accent_keys. */
3521 static int lispy_accent_codes
[] =
3523 #ifdef XK_dead_circumflex
3528 #ifdef XK_dead_grave
3533 #ifdef XK_dead_tilde
3538 #ifdef XK_dead_diaeresis
3543 #ifdef XK_dead_macron
3548 #ifdef XK_dead_degree
3553 #ifdef XK_dead_acute
3558 #ifdef XK_dead_cedilla
3563 #ifdef XK_dead_breve
3568 #ifdef XK_dead_ogonek
3573 #ifdef XK_dead_caron
3578 #ifdef XK_dead_doubleacute
3579 XK_dead_doubleacute
,
3583 #ifdef XK_dead_abovedot
3590 /* This is a list of Lisp names for special "accent" characters.
3591 It parallels lispy_accent_codes. */
3593 static char *lispy_accent_keys
[] =
3611 #define FUNCTION_KEY_OFFSET 0x0
3613 char *lispy_function_keys
[] =
3617 0, /* VK_LBUTTON 0x01 */
3618 0, /* VK_RBUTTON 0x02 */
3619 "cancel", /* VK_CANCEL 0x03 */
3620 0, /* VK_MBUTTON 0x04 */
3622 0, 0, 0, /* 0x05 .. 0x07 */
3624 "backspace", /* VK_BACK 0x08 */
3625 "tab", /* VK_TAB 0x09 */
3627 0, 0, /* 0x0A .. 0x0B */
3629 "clear", /* VK_CLEAR 0x0C */
3630 "return", /* VK_RETURN 0x0D */
3632 0, 0, /* 0x0E .. 0x0F */
3634 0, /* VK_SHIFT 0x10 */
3635 0, /* VK_CONTROL 0x11 */
3636 0, /* VK_MENU 0x12 */
3637 "pause", /* VK_PAUSE 0x13 */
3638 "capslock", /* VK_CAPITAL 0x14 */
3640 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
3642 "escape", /* VK_ESCAPE 0x1B */
3644 0, 0, 0, 0, /* 0x1C .. 0x1F */
3646 0, /* VK_SPACE 0x20 */
3647 "prior", /* VK_PRIOR 0x21 */
3648 "next", /* VK_NEXT 0x22 */
3649 "end", /* VK_END 0x23 */
3650 "home", /* VK_HOME 0x24 */
3651 "left", /* VK_LEFT 0x25 */
3652 "up", /* VK_UP 0x26 */
3653 "right", /* VK_RIGHT 0x27 */
3654 "down", /* VK_DOWN 0x28 */
3655 "select", /* VK_SELECT 0x29 */
3656 "print", /* VK_PRINT 0x2A */
3657 "execute", /* VK_EXECUTE 0x2B */
3658 "snapshot", /* VK_SNAPSHOT 0x2C */
3659 "insert", /* VK_INSERT 0x2D */
3660 "delete", /* VK_DELETE 0x2E */
3661 "help", /* VK_HELP 0x2F */
3663 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
3665 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3667 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
3669 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
3671 0, 0, 0, 0, 0, 0, 0, 0, 0,
3672 0, 0, 0, 0, 0, 0, 0, 0, 0,
3673 0, 0, 0, 0, 0, 0, 0, 0,
3675 "lwindow", /* VK_LWIN 0x5B */
3676 "rwindow", /* VK_RWIN 0x5C */
3677 "apps", /* VK_APPS 0x5D */
3679 0, 0, /* 0x5E .. 0x5F */
3681 "kp-0", /* VK_NUMPAD0 0x60 */
3682 "kp-1", /* VK_NUMPAD1 0x61 */
3683 "kp-2", /* VK_NUMPAD2 0x62 */
3684 "kp-3", /* VK_NUMPAD3 0x63 */
3685 "kp-4", /* VK_NUMPAD4 0x64 */
3686 "kp-5", /* VK_NUMPAD5 0x65 */
3687 "kp-6", /* VK_NUMPAD6 0x66 */
3688 "kp-7", /* VK_NUMPAD7 0x67 */
3689 "kp-8", /* VK_NUMPAD8 0x68 */
3690 "kp-9", /* VK_NUMPAD9 0x69 */
3691 "kp-multiply", /* VK_MULTIPLY 0x6A */
3692 "kp-add", /* VK_ADD 0x6B */
3693 "kp-separator", /* VK_SEPARATOR 0x6C */
3694 "kp-subtract", /* VK_SUBTRACT 0x6D */
3695 "kp-decimal", /* VK_DECIMAL 0x6E */
3696 "kp-divide", /* VK_DIVIDE 0x6F */
3697 "f1", /* VK_F1 0x70 */
3698 "f2", /* VK_F2 0x71 */
3699 "f3", /* VK_F3 0x72 */
3700 "f4", /* VK_F4 0x73 */
3701 "f5", /* VK_F5 0x74 */
3702 "f6", /* VK_F6 0x75 */
3703 "f7", /* VK_F7 0x76 */
3704 "f8", /* VK_F8 0x77 */
3705 "f9", /* VK_F9 0x78 */
3706 "f10", /* VK_F10 0x79 */
3707 "f11", /* VK_F11 0x7A */
3708 "f12", /* VK_F12 0x7B */
3709 "f13", /* VK_F13 0x7C */
3710 "f14", /* VK_F14 0x7D */
3711 "f15", /* VK_F15 0x7E */
3712 "f16", /* VK_F16 0x7F */
3713 "f17", /* VK_F17 0x80 */
3714 "f18", /* VK_F18 0x81 */
3715 "f19", /* VK_F19 0x82 */
3716 "f20", /* VK_F20 0x83 */
3717 "f21", /* VK_F21 0x84 */
3718 "f22", /* VK_F22 0x85 */
3719 "f23", /* VK_F23 0x86 */
3720 "f24", /* VK_F24 0x87 */
3722 0, 0, 0, 0, /* 0x88 .. 0x8B */
3723 0, 0, 0, 0, /* 0x8C .. 0x8F */
3725 "kp-numlock", /* VK_NUMLOCK 0x90 */
3726 "scroll", /* VK_SCROLL 0x91 */
3728 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
3729 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
3730 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
3731 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
3732 "kp-end", /* VK_NUMPAD_END 0x96 */
3733 "kp-home", /* VK_NUMPAD_HOME 0x97 */
3734 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
3735 "kp-up", /* VK_NUMPAD_UP 0x99 */
3736 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
3737 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
3738 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
3739 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
3741 0, 0, /* 0x9E .. 0x9F */
3744 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
3745 * Used only as parameters to GetAsyncKeyState and GetKeyState.
3746 * No other API or message will distinguish left and right keys this way.
3750 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3751 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3752 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3753 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3754 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3760 "attn", /* VK_ATTN 0xF6 */
3761 "crsel", /* VK_CRSEL 0xF7 */
3762 "exsel", /* VK_EXSEL 0xF8 */
3763 "ereof", /* VK_EREOF 0xF9 */
3764 "play", /* VK_PLAY 0xFA */
3765 "zoom", /* VK_ZOOM 0xFB */
3766 "noname", /* VK_NONAME 0xFC */
3767 "pa1", /* VK_PA1 0xFD */
3768 "oem_clear", /* VK_OEM_CLEAR 0xFE */
3772 #else /* not HAVE_NTGUI */
3775 static char *lispy_kana_keys
[] =
3777 /* X Keysym value */
3778 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
3779 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
3780 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
3781 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
3782 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
3783 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
3784 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
3785 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
3786 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
3787 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
3788 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
3789 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
3790 "kana-i", "kana-u", "kana-e", "kana-o",
3791 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
3792 "prolongedsound", "kana-A", "kana-I", "kana-U",
3793 "kana-E", "kana-O", "kana-KA", "kana-KI",
3794 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
3795 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
3796 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
3797 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
3798 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
3799 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
3800 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
3801 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
3802 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
3803 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
3804 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
3805 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
3807 #endif /* XK_kana_A */
3809 #define FUNCTION_KEY_OFFSET 0xff00
3811 /* You'll notice that this table is arranged to be conveniently
3812 indexed by X Windows keysym values. */
3813 static char *lispy_function_keys
[] =
3815 /* X Keysym value */
3817 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
3818 "backspace", "tab", "linefeed", "clear",
3820 0, 0, 0, "pause", /* 0xff10...1f */
3821 0, 0, 0, 0, 0, 0, 0, "escape",
3823 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
3824 "romaji", "hiragana", "katakana", "hiragana-katakana",
3825 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
3826 "massyo", "kana-lock", "kana-shift", "eisu-shift",
3827 "eisu-toggle", /* 0xff30...3f */
3828 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3829 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
3831 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
3832 "down", "prior", "next", "end",
3833 "begin", 0, 0, 0, 0, 0, 0, 0,
3834 "select", /* 0xff60 */ /* IsMiscFunctionKey */
3845 "break", /* 0xff6b */
3848 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
3849 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
3850 "kp-space", /* 0xff80 */ /* IsKeypadKey */
3851 0, 0, 0, 0, 0, 0, 0, 0,
3852 "kp-tab", /* 0xff89 */
3854 "kp-enter", /* 0xff8d */
3856 "kp-f1", /* 0xff91 */
3860 "kp-home", /* 0xff95 */
3865 "kp-prior", /* kp-page-up */
3866 "kp-next", /* kp-page-down */
3872 0, 0, 0, 0, 0, 0, 0, 0, 0,
3873 "kp-multiply", /* 0xffaa */
3878 "kp-divide", /* 0xffaf */
3879 "kp-0", /* 0xffb0 */
3880 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
3883 "kp-equal", /* 0xffbd */
3884 "f1", /* 0xffbe */ /* IsFunctionKey */
3886 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
3887 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
3888 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
3889 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
3890 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
3891 0, 0, 0, 0, 0, 0, 0, 0,
3892 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
3893 0, 0, 0, 0, 0, 0, 0, "delete"
3896 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
3897 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
3899 static char *iso_lispy_function_keys
[] =
3901 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
3902 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
3903 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
3904 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
3905 "iso-lefttab", /* 0xfe20 */
3906 "iso-move-line-up", "iso-move-line-down",
3907 "iso-partial-line-up", "iso-partial-line-down",
3908 "iso-partial-space-left", "iso-partial-space-right",
3909 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
3910 "iso-release-margin-left", "iso-release-margin-right",
3911 "iso-release-both-margins",
3912 "iso-fast-cursor-left", "iso-fast-cursor-right",
3913 "iso-fast-cursor-up", "iso-fast-cursor-down",
3914 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
3915 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
3918 #endif /* not HAVE_NTGUI */
3920 static char *lispy_mouse_names
[] =
3922 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
3926 /* mouse-wheel events are generated by the wheel on devices such as
3927 the MS Intellimouse. The wheel sits in between the left and right
3928 mouse buttons, and is typically used to scroll or zoom the window
3929 underneath the pointer. mouse-wheel events specify the object on
3930 which they operate, and a delta corresponding to the amount and
3931 direction that the wheel is rotated. Clicking the mouse-wheel
3932 generates a mouse-2 event. */
3933 static char *lispy_mouse_wheel_names
[] =
3938 #endif /* WINDOWSNT */
3940 /* drag-n-drop events are generated when a set of selected files are
3941 dragged from another application and dropped onto an Emacs window. */
3942 static char *lispy_drag_n_drop_names
[] =
3947 /* Scroll bar parts. */
3948 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
3949 Lisp_Object Qup
, Qdown
;
3951 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
3952 Lisp_Object
*scroll_bar_parts
[] = {
3953 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
3958 /* A vector, indexed by button number, giving the down-going location
3959 of currently depressed buttons, both scroll bar and non-scroll bar.
3961 The elements have the form
3962 (BUTTON-NUMBER MODIFIER-MASK . REST)
3963 where REST is the cdr of a position as it would be reported in the event.
3965 The make_lispy_event function stores positions here to tell the
3966 difference between click and drag events, and to store the starting
3967 location to be included in drag events. */
3969 static Lisp_Object button_down_location
;
3971 /* Information about the most recent up-going button event: Which
3972 button, what location, and what time. */
3974 static int last_mouse_button
;
3975 static int last_mouse_x
;
3976 static int last_mouse_y
;
3977 static unsigned long button_down_time
;
3979 /* The maximum time between clicks to make a double-click,
3980 or Qnil to disable double-click detection,
3981 or Qt for no time limit. */
3982 Lisp_Object Vdouble_click_time
;
3984 /* The number of clicks in this multiple-click. */
3986 int double_click_count
;
3988 /* Given a struct input_event, build the lisp event which represents
3989 it. If EVENT is 0, build a mouse movement event from the mouse
3990 movement buffer, which should have a movement event in it.
3992 Note that events must be passed to this function in the order they
3993 are received; this function stores the location of button presses
3994 in order to build drag events when the button is released. */
3997 make_lispy_event (event
)
3998 struct input_event
*event
;
4002 switch (SWITCH_ENUM_CAST (event
->kind
))
4004 /* A simple keystroke. */
4005 case ascii_keystroke
:
4007 Lisp_Object lispy_c
;
4008 int c
= event
->code
& 0377;
4009 /* Turn ASCII characters into control characters
4011 if (event
->modifiers
& ctrl_modifier
)
4012 c
= make_ctrl_char (c
);
4014 /* Add in the other modifier bits. We took care of ctrl_modifier
4015 just above, and the shift key was taken care of by the X code,
4016 and applied to control characters by make_ctrl_char. */
4017 c
|= (event
->modifiers
4018 & (meta_modifier
| alt_modifier
4019 | hyper_modifier
| super_modifier
));
4020 /* Distinguish Shift-SPC from SPC. */
4021 if ((event
->code
& 0377) == 040
4022 && event
->modifiers
& shift_modifier
)
4023 c
|= shift_modifier
;
4024 button_down_time
= 0;
4025 XSETFASTINT (lispy_c
, c
);
4029 /* A function key. The symbol may need to have modifier prefixes
4031 case non_ascii_keystroke
:
4032 button_down_time
= 0;
4034 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
4035 if (event
->code
== lispy_accent_codes
[i
])
4036 return modify_event_symbol (i
,
4038 Qfunction_key
, Qnil
,
4039 lispy_accent_keys
, &accent_key_syms
,
4040 (sizeof (lispy_accent_keys
)
4041 / sizeof (lispy_accent_keys
[0])));
4043 /* Handle system-specific keysyms. */
4044 if (event
->code
& (1 << 28))
4046 /* We need to use an alist rather than a vector as the cache
4047 since we can't make a vector long enuf. */
4048 if (NILP (current_kboard
->system_key_syms
))
4049 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
4050 return modify_event_symbol (event
->code
,
4053 current_kboard
->Vsystem_key_alist
,
4054 0, ¤t_kboard
->system_key_syms
,
4059 if (event
->code
>= 0x400 && event
->code
< 0x500)
4060 return modify_event_symbol (event
->code
- 0x400,
4061 event
->modifiers
& ~shift_modifier
,
4062 Qfunction_key
, Qnil
,
4063 lispy_kana_keys
, &func_key_syms
,
4064 (sizeof (lispy_kana_keys
)
4065 / sizeof (lispy_kana_keys
[0])));
4066 #endif /* XK_kana_A */
4068 #ifdef ISO_FUNCTION_KEY_OFFSET
4069 if (event
->code
< FUNCTION_KEY_OFFSET
4070 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
4071 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
4073 Qfunction_key
, Qnil
,
4074 iso_lispy_function_keys
, &func_key_syms
,
4075 (sizeof (iso_lispy_function_keys
)
4076 / sizeof (iso_lispy_function_keys
[0])));
4079 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
4081 Qfunction_key
, Qnil
,
4082 lispy_function_keys
, &func_key_syms
,
4083 (sizeof (lispy_function_keys
)
4084 / sizeof (lispy_function_keys
[0])));
4087 /* A mouse click. Figure out where it is, decide whether it's
4088 a press, click or drag, and build the appropriate structure. */
4090 case scroll_bar_click
:
4092 int button
= event
->code
;
4094 Lisp_Object position
;
4095 Lisp_Object
*start_pos_ptr
;
4096 Lisp_Object start_pos
;
4098 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
4101 /* Build the position as appropriate for this mouse click. */
4102 if (event
->kind
== mouse_click
)
4105 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
4110 /* Ignore mouse events that were made on frame that
4111 have been deleted. */
4112 if (! FRAME_LIVE_P (f
))
4115 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4116 &column
, &row
, NULL
, 1);
4118 #ifndef USE_X_TOOLKIT
4119 /* In the non-toolkit version, clicks on the menu bar
4120 are ordinary button events in the event buffer.
4121 Distinguish them, and invoke the menu.
4123 (In the toolkit version, the toolkit handles the menu bar
4124 and Emacs doesn't know about it until after the user
4125 makes a selection.) */
4126 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
4127 && (event
->modifiers
& down_modifier
))
4129 Lisp_Object items
, item
;
4134 /* Activate the menu bar on the down event. If the
4135 up event comes in before the menu code can deal with it,
4137 if (! (event
->modifiers
& down_modifier
))
4142 items
= FRAME_MENU_BAR_ITEMS (f
);
4143 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
4145 Lisp_Object pos
, string
;
4146 string
= XVECTOR (items
)->contents
[i
+ 1];
4147 pos
= XVECTOR (items
)->contents
[i
+ 3];
4150 if (column
>= XINT (pos
)
4151 && column
< XINT (pos
) + XSTRING (string
)->size
)
4153 item
= XVECTOR (items
)->contents
[i
];
4159 = Fcons (event
->frame_or_window
,
4161 Fcons (Fcons (event
->x
, event
->y
),
4162 Fcons (make_number (event
->timestamp
),
4165 return Fcons (item
, Fcons (position
, Qnil
));
4167 #endif /* not USE_X_TOOLKIT */
4169 window
= window_from_coordinates (f
, column
, row
, &part
);
4171 if (!WINDOWP (window
))
4173 window
= event
->frame_or_window
;
4178 int pixcolumn
, pixrow
;
4179 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
4180 row
-= XINT (XWINDOW (window
)->top
);
4181 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
4182 XSETINT (event
->x
, pixcolumn
);
4183 XSETINT (event
->y
, pixrow
);
4188 posn
= Qvertical_line
;
4191 buffer_posn_from_coords (XWINDOW (window
),
4198 Fcons (Fcons (event
->x
, event
->y
),
4199 Fcons (make_number (event
->timestamp
),
4205 Lisp_Object portion_whole
;
4208 window
= event
->frame_or_window
;
4209 portion_whole
= Fcons (event
->x
, event
->y
);
4210 part
= *scroll_bar_parts
[(int) event
->part
];
4214 Fcons (Qvertical_scroll_bar
,
4215 Fcons (portion_whole
,
4216 Fcons (make_number (event
->timestamp
),
4217 Fcons (part
, Qnil
)))));
4220 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
4222 start_pos
= *start_pos_ptr
;
4223 *start_pos_ptr
= Qnil
;
4225 is_double
= (button
== last_mouse_button
4226 && XINT (event
->x
) == last_mouse_x
4227 && XINT (event
->y
) == last_mouse_y
4228 && button_down_time
!= 0
4229 && (EQ (Vdouble_click_time
, Qt
)
4230 || (INTEGERP (Vdouble_click_time
)
4231 && ((int)(event
->timestamp
- button_down_time
)
4232 < XINT (Vdouble_click_time
)))));
4233 last_mouse_button
= button
;
4234 last_mouse_x
= XINT (event
->x
);
4235 last_mouse_y
= XINT (event
->y
);
4237 /* If this is a button press, squirrel away the location, so
4238 we can decide later whether it was a click or a drag. */
4239 if (event
->modifiers
& down_modifier
)
4243 double_click_count
++;
4244 event
->modifiers
|= ((double_click_count
> 2)
4249 double_click_count
= 1;
4250 button_down_time
= event
->timestamp
;
4251 *start_pos_ptr
= Fcopy_alist (position
);
4254 /* Now we're releasing a button - check the co-ordinates to
4255 see if this was a click or a drag. */
4256 else if (event
->modifiers
& up_modifier
)
4258 /* If we did not see a down before this up,
4259 ignore the up. Probably this happened because
4260 the down event chose a menu item.
4261 It would be an annoyance to treat the release
4262 of the button that chose the menu item
4263 as a separate event. */
4265 if (!CONSP (start_pos
))
4268 event
->modifiers
&= ~up_modifier
;
4269 #if 0 /* Formerly we treated an up with no down as a click event. */
4270 if (!CONSP (start_pos
))
4271 event
->modifiers
|= click_modifier
;
4275 /* The third element of every position should be the (x,y)
4279 down
= Fnth (make_number (2), start_pos
);
4280 if (EQ (event
->x
, XCONS (down
)->car
)
4281 && EQ (event
->y
, XCONS (down
)->cdr
))
4283 event
->modifiers
|= click_modifier
;
4287 button_down_time
= 0;
4288 event
->modifiers
|= drag_modifier
;
4290 /* Don't check is_double; treat this as multiple
4291 if the down-event was multiple. */
4292 if (double_click_count
> 1)
4293 event
->modifiers
|= ((double_click_count
> 2)
4299 /* Every mouse event should either have the down_modifier or
4300 the up_modifier set. */
4304 /* Get the symbol we should use for the mouse click. */
4307 head
= modify_event_symbol (button
,
4310 lispy_mouse_names
, &mouse_syms
,
4311 (sizeof (lispy_mouse_names
)
4312 / sizeof (lispy_mouse_names
[0])));
4313 if (event
->modifiers
& drag_modifier
)
4318 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
4321 Fcons (make_number (double_click_count
),
4331 case w32_scroll_bar_click
:
4333 int button
= event
->code
;
4335 Lisp_Object position
;
4336 Lisp_Object
*start_pos_ptr
;
4337 Lisp_Object start_pos
;
4339 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
4344 Lisp_Object portion_whole
;
4347 window
= event
->frame_or_window
;
4348 portion_whole
= Fcons (event
->x
, event
->y
);
4349 part
= *scroll_bar_parts
[(int) event
->part
];
4353 Fcons (Qvertical_scroll_bar
,
4354 Fcons (portion_whole
,
4355 Fcons (make_number (event
->timestamp
),
4356 Fcons (part
, Qnil
)))));
4359 /* Always treat W32 scroll bar events as clicks. */
4360 event
->modifiers
|= click_modifier
;
4363 /* Get the symbol we should use for the mouse click. */
4366 head
= modify_event_symbol (button
,
4369 lispy_mouse_names
, &mouse_syms
,
4370 (sizeof (lispy_mouse_names
)
4371 / sizeof (lispy_mouse_names
[0])));
4380 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
4383 Lisp_Object head
, position
;
4386 /* Ignore mouse events that were made on frame that
4387 have been deleted. */
4388 if (! FRAME_LIVE_P (f
))
4390 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4391 &column
, &row
, NULL
, 1);
4392 window
= window_from_coordinates (f
, column
, row
, &part
);
4394 if (!WINDOWP (window
))
4396 window
= event
->frame_or_window
;
4401 int pixcolumn
, pixrow
;
4402 column
-= XINT (XWINDOW (window
)->left
);
4403 row
-= XINT (XWINDOW (window
)->top
);
4404 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
4405 XSETINT (event
->x
, pixcolumn
);
4406 XSETINT (event
->y
, pixrow
);
4411 posn
= Qvertical_line
;
4414 buffer_posn_from_coords (XWINDOW (window
),
4419 Lisp_Object head
, position
;
4424 Fcons (Fcons (event
->x
, event
->y
),
4425 Fcons (make_number (event
->timestamp
),
4428 head
= modify_event_symbol (0, event
->modifiers
,
4430 lispy_mouse_wheel_names
,
4431 &mouse_wheel_syms
, 1);
4434 Fcons (make_number (event
->code
),
4438 #endif /* WINDOWSNT */
4446 Lisp_Object head
, position
;
4450 /* The frame_or_window field should be a cons of the frame in
4451 which the event occurred and a list of the filenames
4453 if (! CONSP (event
->frame_or_window
))
4456 f
= XFRAME (XCONS (event
->frame_or_window
)->car
);
4457 files
= XCONS (event
->frame_or_window
)->cdr
;
4459 /* Ignore mouse events that were made on frames that
4460 have been deleted. */
4461 if (! FRAME_LIVE_P (f
))
4463 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4464 &column
, &row
, NULL
, 1);
4465 window
= window_from_coordinates (f
, column
, row
, &part
);
4467 if (!WINDOWP (window
))
4469 window
= XCONS (event
->frame_or_window
)->car
;
4474 int pixcolumn
, pixrow
;
4475 column
-= XINT (XWINDOW (window
)->left
);
4476 row
-= XINT (XWINDOW (window
)->top
);
4477 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
4478 XSETINT (event
->x
, pixcolumn
);
4479 XSETINT (event
->y
, pixrow
);
4484 posn
= Qvertical_line
;
4487 buffer_posn_from_coords (XWINDOW (window
),
4492 Lisp_Object head
, position
;
4497 Fcons (Fcons (event
->x
, event
->y
),
4498 Fcons (make_number (event
->timestamp
),
4501 head
= modify_event_symbol (0, event
->modifiers
,
4503 lispy_drag_n_drop_names
,
4504 &drag_n_drop_syms
, 1);
4511 #endif /* HAVE_MOUSE */
4513 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
4514 case menu_bar_event
:
4515 /* The event value is in the cdr of the frame_or_window slot. */
4516 if (!CONSP (event
->frame_or_window
))
4518 return XCONS (event
->frame_or_window
)->cdr
;
4521 /* The 'kind' field of the event is something we don't recognize. */
4530 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
4532 Lisp_Object bar_window
;
4533 enum scroll_bar_part part
;
4537 /* Is it a scroll bar movement? */
4538 if (frame
&& ! NILP (bar_window
))
4540 Lisp_Object part_sym
;
4542 part_sym
= *scroll_bar_parts
[(int) part
];
4543 return Fcons (Qscroll_bar_movement
,
4544 (Fcons (Fcons (bar_window
,
4545 Fcons (Qvertical_scroll_bar
,
4546 Fcons (Fcons (x
, y
),
4547 Fcons (make_number (time
),
4553 /* Or is it an ordinary mouse movement? */
4563 /* It's in a frame; which window on that frame? */
4564 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
,
4566 window
= window_from_coordinates (frame
, column
, row
, &area
);
4571 if (WINDOWP (window
))
4573 int pixcolumn
, pixrow
;
4574 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
4575 row
-= XINT (XWINDOW (window
)->top
);
4576 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
4577 XSETINT (x
, pixcolumn
);
4578 XSETINT (y
, pixrow
);
4583 posn
= Qvertical_line
;
4586 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
4588 else if (frame
!= 0)
4590 XSETFRAME (window
, frame
);
4601 return Fcons (Qmouse_movement
,
4602 Fcons (Fcons (window
,
4604 Fcons (Fcons (x
, y
),
4605 Fcons (make_number (time
),
4611 #endif /* HAVE_MOUSE */
4613 /* Construct a switch frame event. */
4615 make_lispy_switch_frame (frame
)
4618 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
4621 /* Manipulating modifiers. */
4623 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
4625 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
4626 SYMBOL's name of the end of the modifiers; the string from this
4627 position is the unmodified symbol name.
4629 This doesn't use any caches. */
4632 parse_modifiers_uncached (symbol
, modifier_end
)
4636 struct Lisp_String
*name
;
4640 CHECK_SYMBOL (symbol
, 1);
4643 name
= XSYMBOL (symbol
)->name
;
4645 for (i
= 0; i
+2 <= STRING_BYTES (name
); )
4647 int this_mod_end
= 0;
4650 /* See if the name continues with a modifier word.
4651 Check that the word appears, but don't check what follows it.
4652 Set this_mod and this_mod_end to record what we find. */
4654 switch (name
->data
[i
])
4656 #define SINGLE_LETTER_MOD(BIT) \
4657 (this_mod_end = i + 1, this_mod = BIT)
4660 SINGLE_LETTER_MOD (alt_modifier
);
4664 SINGLE_LETTER_MOD (ctrl_modifier
);
4668 SINGLE_LETTER_MOD (hyper_modifier
);
4672 SINGLE_LETTER_MOD (meta_modifier
);
4676 SINGLE_LETTER_MOD (shift_modifier
);
4680 SINGLE_LETTER_MOD (super_modifier
);
4683 #undef SINGLE_LETTER_MOD
4686 /* If we found no modifier, stop looking for them. */
4687 if (this_mod_end
== 0)
4690 /* Check there is a dash after the modifier, so that it
4691 really is a modifier. */
4692 if (this_mod_end
>= STRING_BYTES (name
)
4693 || name
->data
[this_mod_end
] != '-')
4696 /* This modifier is real; look for another. */
4697 modifiers
|= this_mod
;
4698 i
= this_mod_end
+ 1;
4701 /* Should we include the `click' modifier? */
4702 if (! (modifiers
& (down_modifier
| drag_modifier
4703 | double_modifier
| triple_modifier
))
4704 && i
+ 7 == STRING_BYTES (name
)
4705 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
4706 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
4707 modifiers
|= click_modifier
;
4715 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
4716 prepended to the string BASE[0..BASE_LEN-1].
4717 This doesn't use any caches. */
4719 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
4722 int base_len
, base_len_byte
;
4724 /* Since BASE could contain nulls, we can't use intern here; we have
4725 to use Fintern, which expects a genuine Lisp_String, and keeps a
4728 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
4734 /* Only the event queue may use the `up' modifier; it should always
4735 be turned into a click or drag event before presented to lisp code. */
4736 if (modifiers
& up_modifier
)
4739 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
4740 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
4741 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
4742 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
4743 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
4744 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
4745 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
4746 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
4747 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
4748 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
4749 /* The click modifier is denoted by the absence of other modifiers. */
4753 mod_len
= p
- new_mods
;
4757 Lisp_Object new_name
;
4759 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
4760 mod_len
+ base_len_byte
);
4761 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
4762 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len_byte
);
4764 return Fintern (new_name
, Qnil
);
4769 static char *modifier_names
[] =
4771 "up", "down", "drag", "click", "double", "triple", 0, 0,
4772 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4773 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
4775 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
4777 static Lisp_Object modifier_symbols
;
4779 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
4781 lispy_modifier_list (modifiers
)
4784 Lisp_Object modifier_list
;
4787 modifier_list
= Qnil
;
4788 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
4789 if (modifiers
& (1<<i
))
4790 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
4793 return modifier_list
;
4797 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
4798 where UNMODIFIED is the unmodified form of SYMBOL,
4799 MASK is the set of modifiers present in SYMBOL's name.
4800 This is similar to parse_modifiers_uncached, but uses the cache in
4801 SYMBOL's Qevent_symbol_element_mask property, and maintains the
4802 Qevent_symbol_elements property. */
4805 parse_modifiers (symbol
)
4808 Lisp_Object elements
;
4810 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
4811 if (CONSP (elements
))
4816 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
4817 Lisp_Object unmodified
;
4820 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
4821 STRING_BYTES (XSYMBOL (symbol
)->name
) - end
),
4824 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
4826 XSETFASTINT (mask
, modifiers
);
4827 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
4829 /* Cache the parsing results on SYMBOL. */
4830 Fput (symbol
, Qevent_symbol_element_mask
,
4832 Fput (symbol
, Qevent_symbol_elements
,
4833 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
4835 /* Since we know that SYMBOL is modifiers applied to unmodified,
4836 it would be nice to put that in unmodified's cache.
4837 But we can't, since we're not sure that parse_modifiers is
4844 /* Apply the modifiers MODIFIERS to the symbol BASE.
4845 BASE must be unmodified.
4847 This is like apply_modifiers_uncached, but uses BASE's
4848 Qmodifier_cache property, if present. It also builds
4849 Qevent_symbol_elements properties, since it has that info anyway.
4851 apply_modifiers copies the value of BASE's Qevent_kind property to
4852 the modified symbol. */
4854 apply_modifiers (modifiers
, base
)
4858 Lisp_Object cache
, index
, entry
, new_symbol
;
4860 /* Mask out upper bits. We don't know where this value's been. */
4861 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
4863 /* The click modifier never figures into cache indices. */
4864 cache
= Fget (base
, Qmodifier_cache
);
4865 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
4866 entry
= assq_no_quit (index
, cache
);
4869 new_symbol
= XCONS (entry
)->cdr
;
4872 /* We have to create the symbol ourselves. */
4873 new_symbol
= apply_modifiers_uncached (modifiers
,
4874 XSYMBOL (base
)->name
->data
,
4875 XSYMBOL (base
)->name
->size
,
4876 STRING_BYTES (XSYMBOL (base
)->name
));
4878 /* Add the new symbol to the base's cache. */
4879 entry
= Fcons (index
, new_symbol
);
4880 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
4882 /* We have the parsing info now for free, so add it to the caches. */
4883 XSETFASTINT (index
, modifiers
);
4884 Fput (new_symbol
, Qevent_symbol_element_mask
,
4885 Fcons (base
, Fcons (index
, Qnil
)));
4886 Fput (new_symbol
, Qevent_symbol_elements
,
4887 Fcons (base
, lispy_modifier_list (modifiers
)));
4890 /* Make sure this symbol is of the same kind as BASE.
4892 You'd think we could just set this once and for all when we
4893 intern the symbol above, but reorder_modifiers may call us when
4894 BASE's property isn't set right; we can't assume that just
4895 because it has a Qmodifier_cache property it must have its
4896 Qevent_kind set right as well. */
4897 if (NILP (Fget (new_symbol
, Qevent_kind
)))
4901 kind
= Fget (base
, Qevent_kind
);
4903 Fput (new_symbol
, Qevent_kind
, kind
);
4910 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
4911 return a symbol with the modifiers placed in the canonical order.
4912 Canonical order is alphabetical, except for down and drag, which
4913 always come last. The 'click' modifier is never written out.
4915 Fdefine_key calls this to make sure that (for example) C-M-foo
4916 and M-C-foo end up being equivalent in the keymap. */
4919 reorder_modifiers (symbol
)
4922 /* It's hopefully okay to write the code this way, since everything
4923 will soon be in caches, and no consing will be done at all. */
4926 parsed
= parse_modifiers (symbol
);
4927 return apply_modifiers ((int) XINT (XCONS (XCONS (parsed
)->cdr
)->car
),
4928 XCONS (parsed
)->car
);
4932 /* For handling events, we often want to produce a symbol whose name
4933 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
4934 to some base, like the name of a function key or mouse button.
4935 modify_event_symbol produces symbols of this sort.
4937 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
4938 is the name of the i'th symbol. TABLE_SIZE is the number of elements
4941 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
4942 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
4944 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
4945 persist between calls to modify_event_symbol that it can use to
4946 store a cache of the symbols it's generated for this NAME_TABLE
4947 before. The object stored there may be a vector or an alist.
4949 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
4951 MODIFIERS is a set of modifier bits (as given in struct input_events)
4952 whose prefixes should be applied to the symbol name.
4954 SYMBOL_KIND is the value to be placed in the event_kind property of
4955 the returned symbol.
4957 The symbols we create are supposed to have an
4958 `event-symbol-elements' property, which lists the modifiers present
4959 in the symbol's name. */
4962 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
4963 name_table
, symbol_table
, table_size
)
4966 Lisp_Object symbol_kind
;
4967 Lisp_Object name_alist
;
4969 Lisp_Object
*symbol_table
;
4970 unsigned int table_size
;
4973 Lisp_Object symbol_int
;
4975 /* Get rid of the "vendor-specific" bit here. */
4976 XSETINT (symbol_int
, symbol_num
& 0xffffff);
4978 /* Is this a request for a valid symbol? */
4979 if (symbol_num
< 0 || symbol_num
>= table_size
)
4982 if (CONSP (*symbol_table
))
4983 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
4985 /* If *symbol_table doesn't seem to be initialized properly, fix that.
4986 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4987 where the Nth element is the symbol for NAME_TABLE[N], or nil if
4988 we've never used that symbol before. */
4991 if (! VECTORP (*symbol_table
)
4992 || XVECTOR (*symbol_table
)->size
!= table_size
)
4996 XSETFASTINT (size
, table_size
);
4997 *symbol_table
= Fmake_vector (size
, Qnil
);
5000 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
5003 /* Have we already used this symbol before? */
5006 /* No; let's create it. */
5007 if (!NILP (name_alist
))
5008 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
5009 else if (name_table
!= 0 && name_table
[symbol_num
])
5010 value
= intern (name_table
[symbol_num
]);
5012 #ifdef HAVE_WINDOW_SYSTEM
5015 char *name
= x_get_keysym_name (symbol_num
);
5017 value
= intern (name
);
5024 sprintf (buf
, "key-%d", symbol_num
);
5025 value
= intern (buf
);
5028 if (CONSP (*symbol_table
))
5029 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
5031 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
5033 /* Fill in the cache entries for this symbol; this also
5034 builds the Qevent_symbol_elements property, which the user
5036 apply_modifiers (modifiers
& click_modifier
, value
);
5037 Fput (value
, Qevent_kind
, symbol_kind
);
5040 /* Apply modifiers to that symbol. */
5041 return apply_modifiers (modifiers
, value
);
5044 /* Convert a list that represents an event type,
5045 such as (ctrl meta backspace), into the usual representation of that
5046 event type as a number or a symbol. */
5048 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
5049 "Convert the event description list EVENT-DESC to an event type.\n\
5050 EVENT-DESC should contain one base event type (a character or symbol)\n\
5051 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
5052 drag, down, double or triple). The base must be last.\n\
5053 The return value is an event type (a character or symbol) which\n\
5054 has the same base event type and all the specified modifiers.")
5056 Lisp_Object event_desc
;
5064 while (CONSP (rest
))
5069 elt
= XCONS (rest
)->car
;
5070 rest
= XCONS (rest
)->cdr
;
5072 /* Given a symbol, see if it is a modifier name. */
5073 if (SYMBOLP (elt
) && CONSP (rest
))
5074 this = parse_solitary_modifier (elt
);
5078 else if (!NILP (base
))
5079 error ("Two bases given in one event");
5085 /* Let the symbol A refer to the character A. */
5086 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
5087 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
5089 if (INTEGERP (base
))
5091 /* Turn (shift a) into A. */
5092 if ((modifiers
& shift_modifier
) != 0
5093 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
5095 XSETINT (base
, XINT (base
) - ('a' - 'A'));
5096 modifiers
&= ~shift_modifier
;
5099 /* Turn (control a) into C-a. */
5100 if (modifiers
& ctrl_modifier
)
5101 return make_number ((modifiers
& ~ctrl_modifier
)
5102 | make_ctrl_char (XINT (base
)));
5104 return make_number (modifiers
| XINT (base
));
5106 else if (SYMBOLP (base
))
5107 return apply_modifiers (modifiers
, base
);
5109 error ("Invalid base event");
5112 /* Try to recognize SYMBOL as a modifier name.
5113 Return the modifier flag bit, or 0 if not recognized. */
5116 parse_solitary_modifier (symbol
)
5119 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
5121 switch (name
->data
[0])
5123 #define SINGLE_LETTER_MOD(BIT) \
5124 if (STRING_BYTES (name) == 1) \
5127 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5128 if (LEN == STRING_BYTES (name) \
5129 && ! strncmp (name->data, NAME, LEN)) \
5133 SINGLE_LETTER_MOD (alt_modifier
);
5137 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
5141 SINGLE_LETTER_MOD (ctrl_modifier
);
5145 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
5146 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
5150 SINGLE_LETTER_MOD (hyper_modifier
);
5154 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
5158 SINGLE_LETTER_MOD (meta_modifier
);
5162 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
5166 SINGLE_LETTER_MOD (shift_modifier
);
5170 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
5171 MULTI_LETTER_MOD (super_modifier
, "super", 5);
5172 SINGLE_LETTER_MOD (super_modifier
);
5176 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5177 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5178 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5182 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5185 #undef SINGLE_LETTER_MOD
5186 #undef MULTI_LETTER_MOD
5192 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
5193 Such a list is not valid as an event,
5194 but it can be a Lucid-style event type list. */
5197 lucid_event_type_list_p (object
)
5202 if (! CONSP (object
))
5205 for (tail
= object
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5208 elt
= XCONS (tail
)->car
;
5209 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
5216 /* Store into *addr a value nonzero if terminal input chars are available.
5217 Serves the purpose of ioctl (0, FIONREAD, addr)
5218 but works even if FIONREAD does not exist.
5219 (In fact, this may actually read some input.)
5221 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
5224 get_input_pending (addr
, do_timers_now
)
5228 /* First of all, have we already counted some input? */
5229 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
5231 /* If input is being read as it arrives, and we have none, there is none. */
5232 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
5235 /* Try to read some input and see how much we get. */
5237 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
5240 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
5243 gobble_input (expected
)
5248 if (interrupt_input
)
5251 mask
= sigblock (sigmask (SIGIO
));
5252 read_avail_input (expected
);
5256 #ifdef POLL_FOR_INPUT
5257 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
5260 mask
= sigblock (sigmask (SIGALRM
));
5261 read_avail_input (expected
);
5267 read_avail_input (expected
);
5271 /* Put a buffer_switch_event in the buffer
5272 so that read_key_sequence will notice the new current buffer. */
5275 record_asynch_buffer_change ()
5277 struct input_event event
;
5280 event
.kind
= buffer_switch_event
;
5281 event
.frame_or_window
= Qnil
;
5284 /* We don't need a buffer-switch event unless Emacs is waiting for input.
5285 The purpose of the event is to make read_key_sequence look up the
5286 keymaps again. If we aren't in read_key_sequence, we don't need one,
5287 and the event could cause trouble by messing up (input-pending-p). */
5288 tem
= Fwaiting_for_user_input_p ();
5292 /* We never need these events if we have no asynchronous subprocesses. */
5296 /* Make sure no interrupt happens while storing the event. */
5298 if (interrupt_input
)
5301 mask
= sigblock (sigmask (SIGIO
));
5302 kbd_buffer_store_event (&event
);
5309 kbd_buffer_store_event (&event
);
5316 /* Read any terminal input already buffered up by the system
5317 into the kbd_buffer, but do not wait.
5319 EXPECTED should be nonzero if the caller knows there is some input.
5321 Except on VMS, all input is read by this function.
5322 If interrupt_input is nonzero, this function MUST be called
5323 only when SIGIO is blocked.
5325 Returns the number of keyboard chars read, or -1 meaning
5326 this is a bad time to try to read input. */
5329 read_avail_input (expected
)
5332 struct input_event buf
[KBD_BUFFER_SIZE
];
5336 if (read_socket_hook
)
5337 /* No need for FIONREAD or fcntl; just say don't wait. */
5338 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
5341 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
5342 the kbd_buffer can really hold. That may prevent loss
5343 of characters on some systems when input is stuffed at us. */
5344 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
5347 /* Determine how many characters we should *try* to read. */
5350 #else /* not WINDOWSNT */
5352 n_to_read
= dos_keysns ();
5355 #else /* not MSDOS */
5357 /* Find out how much input is available. */
5358 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
5359 /* Formerly simply reported no input, but that sometimes led to
5360 a failure of Emacs to terminate.
5361 SIGHUP seems appropriate if we can't reach the terminal. */
5362 /* ??? Is it really right to send the signal just to this process
5363 rather than to the whole process group?
5364 Perhaps on systems with FIONREAD Emacs is alone in its group. */
5365 kill (getpid (), SIGHUP
);
5368 if (n_to_read
> sizeof cbuf
)
5369 n_to_read
= sizeof cbuf
;
5370 #else /* no FIONREAD */
5371 #if defined (USG) || defined (DGUX)
5372 /* Read some input if available, but don't wait. */
5373 n_to_read
= sizeof cbuf
;
5374 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
5379 #endif /* not MSDOS */
5380 #endif /* not WINDOWSNT */
5382 /* Now read; for one reason or another, this will not block.
5383 NREAD is set to the number of chars read. */
5387 cbuf
[0] = dos_keyread ();
5390 nread
= read (input_fd
, cbuf
, n_to_read
);
5392 /* POSIX infers that processes which are not in the session leader's
5393 process group won't get SIGHUP's at logout time. BSDI adheres to
5394 this part standard and returns -1 from read (0) with errno==EIO
5395 when the control tty is taken away.
5396 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
5397 if (nread
== -1 && errno
== EIO
)
5399 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
5400 /* The kernel sometimes fails to deliver SIGHUP for ptys.
5401 This looks incorrect, but it isn't, because _BSD causes
5402 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
5403 and that causes a value other than 0 when there is no input. */
5409 /* We used to retry the read if it was interrupted.
5410 But this does the wrong thing when O_NDELAY causes
5411 an EAGAIN error. Does anybody know of a situation
5412 where a retry is actually needed? */
5414 nread
< 0 && (errno
== EAGAIN
5428 #if defined (USG) || defined (DGUX)
5429 fcntl (input_fd
, F_SETFL
, 0);
5430 #endif /* USG or DGUX */
5431 #endif /* no FIONREAD */
5432 for (i
= 0; i
< nread
; i
++)
5434 buf
[i
].kind
= ascii_keystroke
;
5435 buf
[i
].modifiers
= 0;
5436 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
5437 buf
[i
].modifiers
= meta_modifier
;
5441 buf
[i
].code
= cbuf
[i
];
5442 XSETFRAME (buf
[i
].frame_or_window
, selected_frame
);
5446 /* Scan the chars for C-g and store them in kbd_buffer. */
5447 for (i
= 0; i
< nread
; i
++)
5449 kbd_buffer_store_event (&buf
[i
]);
5450 /* Don't look at input that follows a C-g too closely.
5451 This reduces lossage due to autorepeat on C-g. */
5452 if (buf
[i
].kind
== ascii_keystroke
5453 && buf
[i
].code
== quit_char
)
5459 #endif /* not VMS */
5461 #ifdef SIGIO /* for entire page */
5462 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5465 input_available_signal (signo
)
5468 /* Must preserve main program's value of errno. */
5469 int old_errno
= errno
;
5471 extern int select_alarmed
;
5474 #if defined (USG) && !defined (POSIX_SIGNALS)
5475 /* USG systems forget handlers when they are used;
5476 must reestablish each time */
5477 signal (signo
, input_available_signal
);
5484 if (input_available_clear_time
)
5485 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
5490 nread
= read_avail_input (1);
5491 /* -1 means it's not ok to read the input now.
5492 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
5493 0 means there was no keyboard input available. */
5498 select_alarmed
= 1; /* Force the select emulator back to life */
5509 /* Send ourselves a SIGIO.
5511 This function exists so that the UNBLOCK_INPUT macro in
5512 blockinput.h can have some way to take care of input we put off
5513 dealing with, without assuming that every file which uses
5514 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
5516 reinvoke_input_signal ()
5519 kill (getpid (), SIGIO
);
5525 /* Return the prompt-string of a sparse keymap.
5526 This is the first element which is a string.
5527 Return nil if there is none. */
5535 register Lisp_Object tem
;
5544 static void menu_bar_item ();
5545 static void menu_bar_one_keymap ();
5547 /* These variables hold the vector under construction within
5548 menu_bar_items and its subroutines, and the current index
5549 for storing into that vector. */
5550 static Lisp_Object menu_bar_items_vector
;
5551 static int menu_bar_items_index
;
5553 /* Return a vector of menu items for a menu bar, appropriate
5554 to the current buffer. Each item has three elements in the vector:
5557 OLD is an old vector we can optionally reuse, or nil. */
5560 menu_bar_items (old
)
5563 /* The number of keymaps we're scanning right now, and the number of
5564 keymaps we have allocated space for. */
5567 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5568 in the current keymaps, or nil where it is not a prefix. */
5571 Lisp_Object def
, tem
, tail
;
5580 struct gcpro gcpro1
;
5582 /* In order to build the menus, we need to call the keymap
5583 accessors. They all call QUIT. But this function is called
5584 during redisplay, during which a quit is fatal. So inhibit
5585 quitting while building the menus.
5586 We do this instead of specbind because (1) errors will clear it anyway
5587 and (2) this avoids risk of specpdl overflow. */
5588 oquit
= Vinhibit_quit
;
5592 menu_bar_items_vector
= old
;
5594 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
5595 menu_bar_items_index
= 0;
5597 GCPRO1 (menu_bar_items_vector
);
5599 /* Build our list of keymaps.
5600 If we recognize a function key and replace its escape sequence in
5601 keybuf with its symbol, or if the sequence starts with a mouse
5602 click and we need to switch buffers, we jump back here to rebuild
5603 the initial keymaps from the current buffer. */
5607 /* Should overriding-terminal-local-map and overriding-local-map apply? */
5608 if (!NILP (Voverriding_local_map_menu_flag
))
5610 /* Yes, use them (if non-nil) as well as the global map. */
5611 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
5613 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5614 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5615 if (!NILP (Voverriding_local_map
))
5616 maps
[nmaps
++] = Voverriding_local_map
;
5620 /* No, so use major and minor mode keymaps. */
5621 nmaps
= current_minor_maps (NULL
, &tmaps
);
5622 maps
= (Lisp_Object
*) alloca ((nmaps
+ 2) * sizeof (maps
[0]));
5623 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
5624 #ifdef USE_TEXT_PROPERTIES
5625 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
5627 maps
[nmaps
++] = current_buffer
->keymap
;
5630 maps
[nmaps
++] = current_global_map
;
5633 /* Look up in each map the dummy prefix key `menu-bar'. */
5637 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
5639 if (! NILP (maps
[mapno
]))
5640 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0), 0);
5644 tem
= Fkeymapp (def
);
5646 menu_bar_one_keymap (def
);
5649 /* Move to the end those items that should be at the end. */
5651 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5654 int end
= menu_bar_items_index
;
5656 for (i
= 0; i
< end
; i
+= 4)
5657 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5659 Lisp_Object tem0
, tem1
, tem2
, tem3
;
5660 /* Move the item at index I to the end,
5661 shifting all the others forward. */
5662 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
5663 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
5664 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5665 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
5667 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5668 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5669 (end
- i
- 4) * sizeof (Lisp_Object
));
5670 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
5671 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
5672 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
5673 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
5678 /* Add nil, nil, nil, nil at the end. */
5679 i
= menu_bar_items_index
;
5680 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5683 int newsize
= 2 * i
;
5684 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5685 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5686 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5687 menu_bar_items_vector
= tem
;
5689 /* Add this item. */
5690 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5691 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5692 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5693 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5694 menu_bar_items_index
= i
;
5696 Vinhibit_quit
= oquit
;
5698 return menu_bar_items_vector
;
5701 /* Scan one map KEYMAP, accumulating any menu items it defines
5702 in menu_bar_items_vector. */
5704 static Lisp_Object menu_bar_one_keymap_changed_items
;
5707 menu_bar_one_keymap (keymap
)
5710 Lisp_Object tail
, item
, table
;
5712 menu_bar_one_keymap_changed_items
= Qnil
;
5714 /* Loop over all keymap entries that have menu strings. */
5715 for (tail
= keymap
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5717 item
= XCONS (tail
)->car
;
5719 menu_bar_item (XCONS (item
)->car
, XCONS (item
)->cdr
);
5720 else if (VECTORP (item
))
5722 /* Loop over the char values represented in the vector. */
5723 int len
= XVECTOR (item
)->size
;
5725 for (c
= 0; c
< len
; c
++)
5727 Lisp_Object character
;
5728 XSETFASTINT (character
, c
);
5729 menu_bar_item (character
, XVECTOR (item
)->contents
[c
]);
5735 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
5736 If there's already an item for KEY, add this DEF to it. */
5738 Lisp_Object item_properties
;
5741 menu_bar_item (key
, item
)
5742 Lisp_Object key
, item
;
5744 struct gcpro gcpro1
;
5748 if (EQ (item
, Qundefined
))
5750 /* If a map has an explicit `undefined' as definition,
5751 discard any previously made menu bar item. */
5753 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5754 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5756 if (menu_bar_items_index
> i
+ 4)
5757 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5758 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5759 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
5760 menu_bar_items_index
-= 4;
5764 /* If there's no definition for this key yet,
5765 just ignore `undefined'. */
5769 GCPRO1 (key
); /* Is this necessary? */
5770 i
= parse_menu_item (item
, 0, 1);
5775 /* If this keymap has already contributed to this KEY,
5776 don't contribute to it a second time. */
5777 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
5781 menu_bar_one_keymap_changed_items
5782 = Fcons (key
, menu_bar_one_keymap_changed_items
);
5784 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
5786 /* Find any existing item for this KEY. */
5787 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5788 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5791 /* If we did not find this KEY, add it at the end. */
5792 if (i
== menu_bar_items_index
)
5794 /* If vector is too small, get a bigger one. */
5795 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5798 int newsize
= 2 * i
;
5799 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5800 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5801 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5802 menu_bar_items_vector
= tem
;
5805 /* Add this item. */
5806 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
5807 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
5808 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
5809 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
5810 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
5811 menu_bar_items_index
= i
;
5813 /* We did find an item for this KEY. Add ITEM to its list of maps. */
5817 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5818 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (item
, old
);
5822 /* This is used as the handler when calling menu_item_eval_property. */
5824 menu_item_eval_property_1 (arg
)
5827 /* If we got a quit from within the menu computation,
5828 quit all the way out of it. This takes care of C-] in the debugger. */
5829 if (CONSP (arg
) && EQ (XCONS (arg
)->car
, Qquit
))
5830 Fsignal (Qquit
, Qnil
);
5835 /* Evaluate an expression and return the result (or nil if something
5836 went wrong). Used to evaluate dynamic parts of menu items. */
5838 menu_item_eval_property (sexpr
)
5841 int count
= specpdl_ptr
- specpdl
;
5843 specbind (Qinhibit_redisplay
, Qt
);
5844 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
5845 menu_item_eval_property_1
);
5846 return unbind_to (count
, val
);
5849 /* This function parses a menu item and leaves the result in the
5850 vector item_properties.
5851 ITEM is a key binding, a possible menu item.
5852 If NOTREAL is nonzero, only check for equivalent key bindings, don't
5853 evaluate dynamic expressions in the menu item.
5854 INMENUBAR is > 0 when this is considered for an entry in a menu bar
5856 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
5857 parse_menu_item returns true if the item is a menu item and false
5861 parse_menu_item (item
, notreal
, inmenubar
)
5863 int notreal
, inmenubar
;
5865 Lisp_Object def
, tem
, item_string
, start
;
5866 Lisp_Object cachelist
;
5868 Lisp_Object keyhint
;
5879 /* Create item_properties vector if necessary. */
5880 if (NILP (item_properties
))
5882 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
5884 /* Initialize optional entries. */
5885 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
5886 XVECTOR (item_properties
)->contents
[i
] = Qnil
;
5887 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
] = Qt
;
5889 /* Save the item here to protect it from GC. */
5890 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ITEM
] = item
;
5892 item_string
= XCONS (item
)->car
;
5895 item
= XCONS (item
)->cdr
;
5896 if (STRINGP (item_string
))
5898 /* Old format menu item. */
5899 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
] = item_string
;
5901 /* Maybe help string. */
5902 if (CONSP (item
) && STRINGP (XCONS (item
)->car
))
5904 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_HELP
]
5905 = XCONS (item
)->car
;
5907 item
= XCONS (item
)->cdr
;
5910 /* Maybee key binding cache. */
5911 if (CONSP (item
) && CONSP (XCONS (item
)->car
)
5912 && (NILP (XCONS (XCONS (item
)->car
)->car
)
5913 || VECTORP (XCONS (XCONS (item
)->car
)->car
)))
5915 cachelist
= XCONS (item
)->car
;
5916 item
= XCONS (item
)->cdr
;
5919 /* This is the real definition--the function to run. */
5920 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
] = item
;
5922 /* Get enable property, if any. */
5925 tem
= Fget (item
, Qmenu_enable
);
5927 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
] = tem
;
5930 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
5932 /* New format menu item. */
5933 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
]
5934 = XCONS (item
)->car
;
5935 start
= XCONS (item
)->cdr
;
5938 /* We have a real binding. */
5939 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
]
5940 = XCONS (start
)->car
;
5942 item
= XCONS (start
)->cdr
;
5943 /* Is there a cache list with key equivalences. */
5944 if (CONSP (item
) && CONSP (XCONS (item
)->car
))
5946 cachelist
= XCONS (item
)->car
;
5947 item
= XCONS (item
)->cdr
;
5950 /* Parse properties. */
5951 while (CONSP (item
) && CONSP (XCONS (item
)->cdr
))
5953 tem
= XCONS (item
)->car
;
5954 item
= XCONS (item
)->cdr
;
5956 if (EQ (tem
, QCenable
))
5957 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
]
5958 = XCONS (item
)->car
;
5959 else if (EQ (tem
, QCvisible
) && !notreal
)
5961 /* If got a visible property and that evaluates to nil
5962 then ignore this item. */
5963 tem
= menu_item_eval_property (XCONS (item
)->car
);
5967 else if (EQ (tem
, QChelp
))
5968 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_HELP
]
5969 = XCONS (item
)->car
;
5970 else if (EQ (tem
, QCfilter
))
5972 else if (EQ (tem
, QCkey_sequence
))
5974 tem
= XCONS (item
)->car
;
5975 if (NILP (cachelist
)
5976 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
5977 /* Be GC protected. Set keyhint to item instead of tem. */
5980 else if (EQ (tem
, QCkeys
))
5982 tem
= XCONS (item
)->car
;
5983 if (CONSP (tem
) || STRINGP (tem
) && NILP (cachelist
))
5984 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
]
5987 else if (EQ (tem
, QCbutton
) && CONSP (XCONS (item
)->car
))
5990 tem
= XCONS (item
)->car
;
5991 type
= XCONS (tem
)->car
;
5992 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
5994 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
]
5996 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
]
6000 item
= XCONS (item
)->cdr
;
6003 else if (inmenubar
|| !NILP (start
))
6007 return 0; /* not a menu item */
6009 /* If item string is not a string, evaluate it to get string.
6010 If we don't get a string, skip this item. */
6011 item_string
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
6012 if (!(STRINGP (item_string
) || notreal
))
6014 item_string
= menu_item_eval_property (item_string
);
6015 if (!STRINGP (item_string
))
6017 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
] = item_string
;
6020 /* If got a filter apply it on definition. */
6021 def
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6024 def
= menu_item_eval_property (list2 (XCONS (filter
)->car
,
6025 list2 (Qquote
, def
)));
6027 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
] = def
;
6030 /* If we got no definition, this item is just unselectable text which
6031 is OK in a submenu but not in the menubar. */
6033 return (inmenubar
? 0 : 1);
6035 /* Enable or disable selection of item. */
6036 tem
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
];
6042 tem
= menu_item_eval_property (tem
);
6043 if (inmenubar
&& NILP (tem
))
6044 return 0; /* Ignore disabled items in menu bar. */
6045 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
] = tem
;
6048 /* See if this is a separate pane or a submenu. */
6049 def
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6050 tem
= get_keymap_1 (def
, 0, 1);
6051 /* For a subkeymap, just record its details and exit. */
6054 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_MAP
] = tem
;
6055 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
] = tem
;
6058 /* At the top level in the menu bar, do likewise for commands also.
6059 The menu bar does not display equivalent key bindings anyway.
6060 ITEM_PROPERTY_DEF is already set up properly. */
6064 /* This is a command. See if there is an equivalent key binding. */
6065 if (NILP (cachelist
))
6067 /* We have to create a cachelist. */
6068 CHECK_IMPURE (start
);
6069 XCONS (start
)->cdr
= Fcons (Fcons (Qnil
, Qnil
), XCONS (start
)->cdr
);
6070 cachelist
= XCONS (XCONS (start
)->cdr
)->car
;
6072 tem
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
6073 if (!NILP (keyhint
))
6075 XCONS (cachelist
)->car
= XCONS (keyhint
)->car
;
6078 else if (STRINGP (tem
))
6080 XCONS (cachelist
)->cdr
= Fsubstitute_command_keys (tem
);
6081 XCONS (cachelist
)->car
= Qt
;
6084 tem
= XCONS (cachelist
)->car
;
6091 tem
= Fkey_binding (tem
, Qnil
);
6093 prefix
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
6096 def
= XCONS (prefix
)->car
;
6097 prefix
= XCONS (prefix
)->cdr
;
6100 def
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6102 if (NILP (XCONS (cachelist
)->car
)) /* Have no saved key. */
6104 if (newcache
/* Always check first time. */
6105 /* Should we check everything when precomputing key
6108 /* If something had no key binding before, don't recheck it
6109 because that is too slow--except if we have a list of
6110 rebound commands in Vdefine_key_rebound_commands, do
6111 recheck any command that appears in that list. */
6112 || (CONSP (Vdefine_key_rebound_commands
)
6113 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
6116 /* We had a saved key. Is it still bound to the command? */
6119 /* If the command is an alias for another
6120 (such as lmenu.el set it up), check if the
6121 original command matches the cached command. */
6122 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
)))
6123 chkcache
= 1; /* Need to recompute key binding. */
6127 /* Recompute equivalent key binding. If the command is an alias
6128 for another (such as lmenu.el set it up), see if the original
6129 command name has equivalent keys. Otherwise look up the
6130 specified command itself. We don't try both, because that
6131 makes lmenu menus slow. */
6132 if (SYMBOLP (def
) && SYMBOLP (XSYMBOL (def
)->function
)
6133 && ! NILP (Fget (def
, Qmenu_alias
)))
6134 def
= XSYMBOL (def
)->function
;
6135 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
);
6136 XCONS (cachelist
)->car
= tem
;
6139 XCONS (cachelist
)->cdr
= Qnil
;
6143 else if (!NILP (keyhint
) && !NILP (XCONS (cachelist
)->car
))
6145 tem
= XCONS (cachelist
)->car
;
6149 newcache
= chkcache
;
6152 tem
= Fkey_description (tem
);
6155 if (STRINGP (XCONS (prefix
)->car
))
6156 tem
= concat2 (XCONS (prefix
)->car
, tem
);
6157 if (STRINGP (XCONS (prefix
)->cdr
))
6158 tem
= concat2 (tem
, XCONS (prefix
)->cdr
);
6160 XCONS (cachelist
)->cdr
= tem
;
6164 tem
= XCONS (cachelist
)->cdr
;
6165 if (newcache
&& !NILP (tem
))
6167 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
6168 XCONS (cachelist
)->cdr
= tem
;
6171 /* If we only want to precompute equivalent key bindings, stop here. */
6175 /* If we have an equivalent key binding, use that. */
6176 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
] = tem
;
6178 /* Include this when menu help is implemented.
6179 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
6180 if (!(NILP (tem) || STRINGP (tem)))
6182 tem = menu_item_eval_property (tem);
6185 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
6189 /* Handle radio buttons or toggle boxes. */
6190 tem
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
6192 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
]
6193 = menu_item_eval_property (tem
);
6198 /* Read a character using menus based on maps in the array MAPS.
6199 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
6200 Return t if we displayed a menu but the user rejected it.
6202 PREV_EVENT is the previous input event, or nil if we are reading
6203 the first event of a key sequence.
6205 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
6206 if we used a mouse menu to read the input, or zero otherwise. If
6207 USED_MOUSE_MENU is null, we don't dereference it.
6209 The prompting is done based on the prompt-string of the map
6210 and the strings associated with various map elements.
6212 This can be done with X menus or with menus put in the minibuf.
6213 These are done in different ways, depending on how the input will be read.
6214 Menus using X are done after auto-saving in read-char, getting the input
6215 event from Fx_popup_menu; menus using the minibuf use read_char recursively
6216 and do auto-saving in the inner call of read_char. */
6219 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
6222 Lisp_Object prev_event
;
6223 int *used_mouse_menu
;
6226 register Lisp_Object name
;
6227 Lisp_Object rest
, vector
;
6229 if (used_mouse_menu
)
6230 *used_mouse_menu
= 0;
6232 /* Use local over global Menu maps */
6234 if (! menu_prompting
)
6237 /* Optionally disregard all but the global map. */
6238 if (inhibit_local_menu_bar_menus
)
6240 maps
+= (nmaps
- 1);
6244 /* Get the menu name from the first map that has one (a prompt string). */
6245 for (mapno
= 0; mapno
< nmaps
; mapno
++)
6247 name
= map_prompt (maps
[mapno
]);
6252 /* If we don't have any menus, just read a character normally. */
6257 /* If we got to this point via a mouse click,
6258 use a real menu for mouse selection. */
6259 if (EVENT_HAS_PARAMETERS (prev_event
)
6260 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
))
6262 /* Display the menu and get the selection. */
6263 Lisp_Object
*realmaps
6264 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
6268 /* Use the maps that are not nil. */
6269 for (mapno
= 0; mapno
< nmaps
; mapno
++)
6270 if (!NILP (maps
[mapno
]))
6271 realmaps
[nmaps1
++] = maps
[mapno
];
6273 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
6278 record_menu_key (XCONS (value
)->car
);
6280 /* If we got multiple events, unread all but
6282 There is no way to prevent those unread events
6283 from showing up later in last_nonmenu_event.
6284 So turn symbol and integer events into lists,
6285 to indicate that they came from a mouse menu,
6286 so that when present in last_nonmenu_event
6287 they won't confuse things. */
6288 for (tem
= XCONS (value
)->cdr
; !NILP (tem
);
6289 tem
= XCONS (tem
)->cdr
)
6291 record_menu_key (XCONS (tem
)->car
);
6292 if (SYMBOLP (XCONS (tem
)->car
)
6293 || INTEGERP (XCONS (tem
)->car
))
6295 = Fcons (XCONS (tem
)->car
, Qnil
);
6298 /* If we got more than one event, put all but the first
6299 onto this list to be read later.
6300 Return just the first event now. */
6301 Vunread_command_events
6302 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
6303 value
= XCONS (value
)->car
;
6305 else if (NILP (value
))
6307 if (used_mouse_menu
)
6308 *used_mouse_menu
= 1;
6311 #endif /* HAVE_MENUS */
6315 /* Buffer in use so far for the minibuf prompts for menu keymaps.
6316 We make this bigger when necessary, and never free it. */
6317 static char *read_char_minibuf_menu_text
;
6318 /* Size of that buffer. */
6319 static int read_char_minibuf_menu_width
;
6322 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
6328 register Lisp_Object name
;
6330 int width
= FRAME_WIDTH (selected_frame
) - 4;
6333 Lisp_Object rest
, vector
;
6336 if (! menu_prompting
)
6339 /* Make sure we have a big enough buffer for the menu text. */
6340 if (read_char_minibuf_menu_text
== 0)
6342 read_char_minibuf_menu_width
= width
+ 4;
6343 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
6345 else if (width
+ 4 > read_char_minibuf_menu_width
)
6347 read_char_minibuf_menu_width
= width
+ 4;
6348 read_char_minibuf_menu_text
6349 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
6351 menu
= read_char_minibuf_menu_text
;
6353 /* Get the menu name from the first map that has one (a prompt string). */
6354 for (mapno
= 0; mapno
< nmaps
; mapno
++)
6356 name
= map_prompt (maps
[mapno
]);
6361 /* If we don't have any menus, just read a character normally. */
6365 /* Prompt string always starts with map's prompt, and a space. */
6366 strcpy (menu
, XSTRING (name
)->data
);
6367 nlength
= STRING_BYTES (XSTRING (name
));
6368 menu
[nlength
++] = ':';
6369 menu
[nlength
++] = ' ';
6372 /* Start prompting at start of first map. */
6376 /* Present the documented bindings, a line at a time. */
6383 Lisp_Object orig_defn_macro
;
6385 /* Loop over elements of map. */
6390 /* If reached end of map, start at beginning of next map. */
6394 /* At end of last map, wrap around to first map if just starting,
6395 or end this line if already have something on it. */
6399 if (notfirst
|| nobindings
) break;
6404 /* Look at the next element of the map. */
6406 elt
= XVECTOR (vector
)->contents
[idx
];
6408 elt
= Fcar_safe (rest
);
6410 if (idx
< 0 && VECTORP (elt
))
6412 /* If we found a dense table in the keymap,
6413 advanced past it, but start scanning its contents. */
6414 rest
= Fcdr_safe (rest
);
6420 /* An ordinary element. */
6421 Lisp_Object event
, tem
;
6425 event
= Fcar_safe (elt
); /* alist */
6426 elt
= Fcdr_safe (elt
);
6430 XSETINT (event
, idx
); /* vector */
6433 /* Ignore the element if it has no prompt string. */
6434 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
6436 /* 1 if the char to type matches the string. */
6438 Lisp_Object upcased_event
, downcased_event
;
6441 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
6443 upcased_event
= Fupcase (event
);
6444 downcased_event
= Fdowncase (event
);
6445 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
6446 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
6448 desc
= Fsingle_key_description (event
);
6451 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
6453 /* Insert equivalent keybinding. */
6454 s
= concat2 (s
, tem
);
6457 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
6458 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
6460 /* Insert button prefix. */
6461 Lisp_Object selected
6462 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
6463 if (EQ (tem
, QCradio
))
6464 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
6466 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
6467 s
= concat2 (tem
, s
);
6471 /* If we have room for the prompt string, add it to this line.
6472 If this is the first on the line, always add it. */
6473 if ((XSTRING (s
)->size
+ i
+ 2
6474 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
6480 /* Punctuate between strings. */
6483 strcpy (menu
+ i
, ", ");
6489 /* If the char to type doesn't match the string's
6490 first char, explicitly show what char to type. */
6493 /* Add as much of string as fits. */
6494 thiswidth
= XSTRING (desc
)->size
;
6495 if (thiswidth
+ i
> width
)
6496 thiswidth
= width
- i
;
6497 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
6499 strcpy (menu
+ i
, " = ");
6503 /* Add as much of string as fits. */
6504 thiswidth
= XSTRING (s
)->size
;
6505 if (thiswidth
+ i
> width
)
6506 thiswidth
= width
- i
;
6507 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
6513 /* If this element does not fit, end the line now,
6514 and save the element for the next line. */
6515 strcpy (menu
+ i
, "...");
6520 /* Move past this element. */
6521 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
6522 /* Handle reaching end of dense table. */
6527 rest
= Fcdr_safe (rest
);
6531 /* Prompt with that and read response. */
6532 message2_nolog (menu
, strlen (menu
),
6533 ! NILP (current_buffer
->enable_multibyte_characters
));
6535 /* Make believe its not a keyboard macro in case the help char
6536 is pressed. Help characters are not recorded because menu prompting
6537 is not used on replay.
6539 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
6540 current_kboard
->defining_kbd_macro
= Qnil
;
6542 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
6543 while (BUFFERP (obj
));
6544 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
6546 if (!INTEGERP (obj
))
6551 if (! EQ (obj
, menu_prompt_more_char
)
6552 && (!INTEGERP (menu_prompt_more_char
)
6553 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
6555 if (!NILP (current_kboard
->defining_kbd_macro
))
6556 store_kbd_macro_char (obj
);
6559 /* Help char - go round again */
6563 /* Reading key sequences. */
6565 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
6566 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
6567 keymap, or nil otherwise. Return the index of the first keymap in
6568 which KEY has any binding, or NMAPS if no map has a binding.
6570 If KEY is a meta ASCII character, treat it like meta-prefix-char
6571 followed by the corresponding non-meta character. Keymaps in
6572 CURRENT with non-prefix bindings for meta-prefix-char become nil in
6575 If KEY has no bindings in any of the CURRENT maps, NEXT is left
6578 NEXT may be the same array as CURRENT. */
6581 follow_key (key
, nmaps
, current
, defs
, next
)
6583 Lisp_Object
*current
, *defs
, *next
;
6586 int i
, first_binding
;
6589 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
6590 followed by the corresponding non-meta character.
6591 Put the results into DEFS, since we are going to alter that anyway.
6592 Do not alter CURRENT or NEXT. */
6593 if (INTEGERP (key
) && (XINT (key
) & CHAR_META
))
6595 for (i
= 0; i
< nmaps
; i
++)
6596 if (! NILP (current
[i
]))
6599 def
= get_keyelt (access_keymap (current
[i
],
6600 meta_prefix_char
, 1, 0), 0);
6602 /* Note that since we pass the resulting bindings through
6603 get_keymap_1, non-prefix bindings for meta-prefix-char
6605 defs
[i
] = get_keymap_1 (def
, 0, 1);
6611 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
6614 first_binding
= nmaps
;
6615 for (i
= nmaps
- 1; i
>= 0; i
--)
6617 if (! NILP (current
[i
]))
6625 defs
[i
] = get_keyelt (access_keymap (map
, key
, 1, 0), 0);
6626 if (! NILP (defs
[i
]))
6633 /* Given the set of bindings we've found, produce the next set of maps. */
6634 if (first_binding
< nmaps
)
6635 for (i
= 0; i
< nmaps
; i
++)
6636 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
6638 return first_binding
;
6641 /* Read a sequence of keys that ends with a non prefix character,
6642 storing it in KEYBUF, a buffer of size BUFSIZE.
6644 Return the length of the key sequence stored.
6645 Return -1 if the user rejected a command menu.
6647 Echo starting immediately unless `prompt' is 0.
6649 Where a key sequence ends depends on the currently active keymaps.
6650 These include any minor mode keymaps active in the current buffer,
6651 the current buffer's local map, and the global map.
6653 If a key sequence has no other bindings, we check Vfunction_key_map
6654 to see if some trailing subsequence might be the beginning of a
6655 function key's sequence. If so, we try to read the whole function
6656 key, and substitute its symbolic name into the key sequence.
6658 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
6659 `double-' events into similar click events, if that would make them
6660 bound. We try to turn `triple-' events first into `double-' events,
6663 If we get a mouse click in a mode line, vertical divider, or other
6664 non-text area, we treat the click as if it were prefixed by the
6665 symbol denoting that area - `mode-line', `vertical-line', or
6668 If the sequence starts with a mouse click, we read the key sequence
6669 with respect to the buffer clicked on, not the current buffer.
6671 If the user switches frames in the midst of a key sequence, we put
6672 off the switch-frame event until later; the next call to
6673 read_char will return it.
6675 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
6676 from the selected window's buffer. */
6679 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
6680 can_return_switch_frame
, fix_current_buffer
)
6681 Lisp_Object
*keybuf
;
6684 int dont_downcase_last
;
6685 int can_return_switch_frame
;
6686 int fix_current_buffer
;
6688 int count
= specpdl_ptr
- specpdl
;
6690 /* How many keys there are in the current key sequence. */
6693 /* The length of the echo buffer when we started reading, and
6694 the length of this_command_keys when we started reading. */
6698 /* The number of keymaps we're scanning right now, and the number of
6699 keymaps we have allocated space for. */
6701 int nmaps_allocated
= 0;
6703 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
6704 the current keymaps. */
6707 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6708 in the current keymaps, or nil where it is not a prefix. */
6709 Lisp_Object
*submaps
;
6711 /* The local map to start out with at start of key sequence. */
6712 Lisp_Object orig_local_map
;
6714 /* 1 if we have already considered switching to the local-map property
6715 of the place where a mouse click occurred. */
6716 int localized_local_map
= 0;
6718 /* The index in defs[] of the first keymap that has a binding for
6719 this key sequence. In other words, the lowest i such that
6720 defs[i] is non-nil. */
6723 /* If t < mock_input, then KEYBUF[t] should be read as the next
6726 We use this to recover after recognizing a function key. Once we
6727 realize that a suffix of the current key sequence is actually a
6728 function key's escape sequence, we replace the suffix with the
6729 function key's binding from Vfunction_key_map. Now keybuf
6730 contains a new and different key sequence, so the echo area,
6731 this_command_keys, and the submaps and defs arrays are wrong. In
6732 this situation, we set mock_input to t, set t to 0, and jump to
6733 restart_sequence; the loop will read keys from keybuf up until
6734 mock_input, thus rebuilding the state; and then it will resume
6735 reading characters from the keyboard. */
6738 /* If the sequence is unbound in submaps[], then
6739 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
6740 and fkey_map is its binding.
6742 These might be > t, indicating that all function key scanning
6743 should hold off until t reaches them. We do this when we've just
6744 recognized a function key, to avoid searching for the function
6745 key's again in Vfunction_key_map. */
6746 int fkey_start
= 0, fkey_end
= 0;
6747 Lisp_Object fkey_map
;
6749 /* Likewise, for key_translation_map. */
6750 int keytran_start
= 0, keytran_end
= 0;
6751 Lisp_Object keytran_map
;
6753 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
6754 we put it off for later. While we're reading, we keep the event here. */
6755 Lisp_Object delayed_switch_frame
;
6757 /* See the comment below... */
6758 #if defined (GOBBLE_FIRST_EVENT)
6759 Lisp_Object first_event
;
6762 Lisp_Object original_uppercase
;
6763 int original_uppercase_position
= -1;
6765 /* Gets around Microsoft compiler limitations. */
6768 struct buffer
*starting_buffer
;
6770 /* Nonzero if we seem to have got the beginning of a binding
6771 in function_key_map. */
6772 int function_key_possible
= 0;
6773 int key_translation_possible
= 0;
6775 /* Save the status of key translation before each step,
6776 so that we can restore this after downcasing. */
6777 Lisp_Object prev_fkey_map
;
6778 int prev_fkey_start
;
6781 Lisp_Object prev_keytran_map
;
6782 int prev_keytran_start
;
6783 int prev_keytran_end
;
6787 raw_keybuf_count
= 0;
6789 last_nonmenu_event
= Qnil
;
6791 delayed_switch_frame
= Qnil
;
6792 fkey_map
= Vfunction_key_map
;
6793 keytran_map
= Vkey_translation_map
;
6795 /* If there is no function-key-map, turn off function key scanning. */
6796 if (NILP (Fkeymapp (Vfunction_key_map
)))
6797 fkey_start
= fkey_end
= bufsize
+ 1;
6799 /* If there is no key-translation-map, turn off scanning. */
6800 if (NILP (Fkeymapp (Vkey_translation_map
)))
6801 keytran_start
= keytran_end
= bufsize
+ 1;
6806 echo_prompt (XSTRING (prompt
)->data
);
6807 else if (cursor_in_echo_area
&& echo_keystrokes
)
6808 /* This doesn't put in a dash if the echo buffer is empty, so
6809 you don't always see a dash hanging out in the minibuffer. */
6813 /* Record the initial state of the echo area and this_command_keys;
6814 we will need to restore them if we replay a key sequence. */
6816 echo_start
= echo_length ();
6817 keys_start
= this_command_key_count
;
6818 this_single_command_key_start
= keys_start
;
6820 #if defined (GOBBLE_FIRST_EVENT)
6821 /* This doesn't quite work, because some of the things that read_char
6822 does cannot safely be bypassed. It seems too risky to try to make
6825 /* Read the first char of the sequence specially, before setting
6826 up any keymaps, in case a filter runs and switches buffers on us. */
6827 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
6829 #endif /* GOBBLE_FIRST_EVENT */
6831 orig_local_map
= get_local_map (PT
, current_buffer
);
6833 /* We jump here when the key sequence has been thoroughly changed, and
6834 we need to rescan it starting from the beginning. When we jump here,
6835 keybuf[0..mock_input] holds the sequence we should reread. */
6838 starting_buffer
= current_buffer
;
6839 function_key_possible
= 0;
6840 key_translation_possible
= 0;
6842 /* Build our list of keymaps.
6843 If we recognize a function key and replace its escape sequence in
6844 keybuf with its symbol, or if the sequence starts with a mouse
6845 click and we need to switch buffers, we jump back here to rebuild
6846 the initial keymaps from the current buffer. */
6850 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
6851 || !NILP (Voverriding_local_map
))
6853 if (3 > nmaps_allocated
)
6855 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
6856 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
6857 nmaps_allocated
= 3;
6860 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6861 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6862 if (!NILP (Voverriding_local_map
))
6863 submaps
[nmaps
++] = Voverriding_local_map
;
6867 nmaps
= current_minor_maps (0, &maps
);
6868 if (nmaps
+ 2 > nmaps_allocated
)
6870 submaps
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (submaps
[0]));
6871 defs
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (defs
[0]));
6872 nmaps_allocated
= nmaps
+ 2;
6874 bcopy (maps
, submaps
, nmaps
* sizeof (submaps
[0]));
6875 #ifdef USE_TEXT_PROPERTIES
6876 submaps
[nmaps
++] = orig_local_map
;
6878 submaps
[nmaps
++] = current_buffer
->keymap
;
6881 submaps
[nmaps
++] = current_global_map
;
6884 /* Find an accurate initial value for first_binding. */
6885 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
6886 if (! NILP (submaps
[first_binding
]))
6889 /* Start from the beginning in keybuf. */
6892 /* These are no-ops the first time through, but if we restart, they
6893 revert the echo area and this_command_keys to their original state. */
6894 this_command_key_count
= keys_start
;
6895 if (INTERACTIVE
&& t
< mock_input
)
6896 echo_truncate (echo_start
);
6898 /* If the best binding for the current key sequence is a keymap, or
6899 we may be looking at a function key's escape sequence, keep on
6901 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
6902 || (first_binding
>= nmaps
6904 /* mock input is never part of a function key's sequence. */
6905 && mock_input
<= fkey_start
)
6906 || (first_binding
>= nmaps
6907 && keytran_start
< t
&& key_translation_possible
)
6908 /* Don't return in the middle of a possible function key sequence,
6909 if the only bindings we found were via case conversion.
6910 Thus, if ESC O a has a function-key-map translation
6911 and ESC o has a binding, don't return after ESC O,
6912 so that we can translate ESC O plus the next character. */
6916 int used_mouse_menu
= 0;
6918 /* Where the last real key started. If we need to throw away a
6919 key that has expanded into more than one element of keybuf
6920 (say, a mouse click on the mode line which is being treated
6921 as [mode-line (mouse-...)], then we backtrack to this point
6923 int last_real_key_start
;
6925 /* These variables are analogous to echo_start and keys_start;
6926 while those allow us to restart the entire key sequence,
6927 echo_local_start and keys_local_start allow us to throw away
6929 int echo_local_start
, keys_local_start
, local_first_binding
;
6932 error ("Key sequence too long");
6935 echo_local_start
= echo_length ();
6936 keys_local_start
= this_command_key_count
;
6937 local_first_binding
= first_binding
;
6940 /* These are no-ops, unless we throw away a keystroke below and
6941 jumped back up to replay_key; in that case, these restore the
6942 variables to their original state, allowing us to replay the
6944 if (INTERACTIVE
&& t
< mock_input
)
6945 echo_truncate (echo_local_start
);
6946 this_command_key_count
= keys_local_start
;
6947 first_binding
= local_first_binding
;
6949 /* By default, assume each event is "real". */
6950 last_real_key_start
= t
;
6952 /* Does mock_input indicate that we are re-reading a key sequence? */
6956 add_command_key (key
);
6957 if (echo_keystrokes
)
6961 /* If not, we should actually read a character. */
6964 struct buffer
*buf
= current_buffer
;
6968 KBOARD
*interrupted_kboard
= current_kboard
;
6969 struct frame
*interrupted_frame
= selected_frame
;
6970 if (setjmp (wrong_kboard_jmpbuf
))
6972 if (!NILP (delayed_switch_frame
))
6974 interrupted_kboard
->kbd_queue
6975 = Fcons (delayed_switch_frame
,
6976 interrupted_kboard
->kbd_queue
);
6977 delayed_switch_frame
= Qnil
;
6980 interrupted_kboard
->kbd_queue
6981 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
6983 /* If the side queue is non-empty, ensure it begins with a
6984 switch-frame, so we'll replay it in the right context. */
6985 if (CONSP (interrupted_kboard
->kbd_queue
)
6986 && (key
= XCONS (interrupted_kboard
->kbd_queue
)->car
,
6987 !(EVENT_HAS_PARAMETERS (key
)
6988 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
6992 XSETFRAME (frame
, interrupted_frame
);
6993 interrupted_kboard
->kbd_queue
6994 = Fcons (make_lispy_switch_frame (frame
),
6995 interrupted_kboard
->kbd_queue
);
6998 orig_local_map
= get_local_map (PT
, current_buffer
);
6999 goto replay_sequence
;
7002 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
7006 /* read_char returns t when it shows a menu and the user rejects it.
7010 unbind_to (count
, Qnil
);
7014 /* read_char returns -1 at the end of a macro.
7015 Emacs 18 handles this by returning immediately with a
7016 zero, so that's what we'll do. */
7017 if (INTEGERP (key
) && XINT (key
) == -1)
7020 /* The Microsoft C compiler can't handle the goto that
7026 /* If the current buffer has been changed from under us, the
7027 keymap may have changed, so replay the sequence. */
7031 /* Reset the current buffer from the selected window
7032 in case something changed the former and not the latter.
7033 This is to be more consistent with the behavior
7034 of the command_loop_1. */
7035 if (fix_current_buffer
)
7037 if (! FRAME_LIVE_P (selected_frame
))
7039 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
7040 Fset_buffer (XWINDOW (selected_window
)->buffer
);
7043 orig_local_map
= get_local_map (PT
, current_buffer
);
7044 goto replay_sequence
;
7047 /* If we have a quit that was typed in another frame, and
7048 quit_throw_to_read_char switched buffers,
7049 replay to get the right keymap. */
7050 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
7053 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
7057 orig_local_map
= get_local_map (PT
, current_buffer
);
7058 goto replay_sequence
;
7063 if (EVENT_HAS_PARAMETERS (key
)
7064 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
7066 /* If we're at the beginning of a key sequence, and the caller
7067 says it's okay, go ahead and return this event. If we're
7068 in the midst of a key sequence, delay it until the end. */
7069 if (t
> 0 || !can_return_switch_frame
)
7071 delayed_switch_frame
= key
;
7077 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
7080 /* Clicks in non-text areas get prefixed by the symbol
7081 in their CHAR-ADDRESS field. For example, a click on
7082 the mode line is prefixed by the symbol `mode-line'.
7084 Furthermore, key sequences beginning with mouse clicks
7085 are read using the keymaps of the buffer clicked on, not
7086 the current buffer. So we may have to switch the buffer
7089 When we turn one event into two events, we must make sure
7090 that neither of the two looks like the original--so that,
7091 if we replay the events, they won't be expanded again.
7092 If not for this, such reexpansion could happen either here
7093 or when user programs play with this-command-keys. */
7094 if (EVENT_HAS_PARAMETERS (key
))
7098 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
7099 if (EQ (kind
, Qmouse_click
))
7101 Lisp_Object window
, posn
;
7103 window
= POSN_WINDOW (EVENT_START (key
));
7104 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
7107 /* We're looking at the second event of a
7108 sequence which we expanded before. Set
7109 last_real_key_start appropriately. */
7111 last_real_key_start
= t
- 1;
7114 /* Key sequences beginning with mouse clicks are
7115 read using the keymaps in the buffer clicked on,
7116 not the current buffer. If we're at the
7117 beginning of a key sequence, switch buffers. */
7118 if (last_real_key_start
== 0
7120 && BUFFERP (XWINDOW (window
)->buffer
)
7121 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
7123 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
7127 /* Arrange to go back to the original buffer once we're
7128 done reading the key sequence. Note that we can't
7129 use save_excursion_{save,restore} here, because they
7130 save point as well as the current buffer; we don't
7131 want to save point, because redisplay may change it,
7132 to accommodate a Fset_window_start or something. We
7133 don't want to do this at the top of the function,
7134 because we may get input from a subprocess which
7135 wants to change the selected window and stuff (say,
7137 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
7139 if (! FRAME_LIVE_P (selected_frame
))
7141 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
7142 orig_local_map
= get_local_map (PT
, current_buffer
);
7143 goto replay_sequence
;
7145 /* For a mouse click, get the local text-property keymap
7146 of the place clicked on, rather than point. */
7147 if (last_real_key_start
== 0 && CONSP (XCONS (key
)->cdr
)
7148 && ! localized_local_map
)
7150 Lisp_Object map_here
, start
, pos
;
7152 localized_local_map
= 1;
7153 start
= EVENT_START (key
);
7154 if (CONSP (start
) && CONSP (XCONS (start
)->cdr
))
7156 pos
= POSN_BUFFER_POSN (start
);
7158 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
7160 map_here
= get_local_map (XINT (pos
), current_buffer
);
7161 if (!EQ (map_here
, orig_local_map
))
7163 orig_local_map
= map_here
;
7167 goto replay_sequence
;
7173 /* Expand mode-line and scroll-bar events into two events:
7174 use posn as a fake prefix key. */
7177 if (t
+ 1 >= bufsize
)
7178 error ("Key sequence too long");
7183 /* Zap the position in key, so we know that we've
7184 expanded it, and don't try to do so again. */
7185 POSN_BUFFER_POSN (EVENT_START (key
))
7186 = Fcons (posn
, Qnil
);
7190 else if (CONSP (XCONS (key
)->cdr
)
7191 && CONSP (EVENT_START (key
))
7192 && CONSP (XCONS (EVENT_START (key
))->cdr
))
7196 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
7197 /* Handle menu-bar events:
7198 insert the dummy prefix event `menu-bar'. */
7199 if (EQ (posn
, Qmenu_bar
))
7201 if (t
+ 1 >= bufsize
)
7202 error ("Key sequence too long");
7206 /* Zap the position in key, so we know that we've
7207 expanded it, and don't try to do so again. */
7208 POSN_BUFFER_POSN (EVENT_START (key
))
7209 = Fcons (posn
, Qnil
);
7212 goto replay_sequence
;
7214 else if (CONSP (posn
))
7216 /* We're looking at the second event of a
7217 sequence which we expanded before. Set
7218 last_real_key_start appropriately. */
7219 if (last_real_key_start
== t
&& t
> 0)
7220 last_real_key_start
= t
- 1;
7225 /* We have finally decided that KEY is something we might want
7227 first_binding
= (follow_key (key
,
7228 nmaps
- first_binding
,
7229 submaps
+ first_binding
,
7230 defs
+ first_binding
,
7231 submaps
+ first_binding
)
7234 /* If KEY wasn't bound, we'll try some fallbacks. */
7235 if (first_binding
>= nmaps
)
7239 head
= EVENT_HEAD (key
);
7240 if (help_char_p (head
) && t
> 0)
7242 read_key_sequence_cmd
= Vprefix_help_command
;
7244 last_nonmenu_event
= key
;
7245 /* The Microsoft C compiler can't handle the goto that
7253 Lisp_Object breakdown
;
7256 breakdown
= parse_modifiers (head
);
7257 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
7258 /* Attempt to reduce an unbound mouse event to a simpler
7259 event that is bound:
7260 Drags reduce to clicks.
7261 Double-clicks reduce to clicks.
7262 Triple-clicks reduce to double-clicks, then to clicks.
7263 Down-clicks are eliminated.
7264 Double-downs reduce to downs, then are eliminated.
7265 Triple-downs reduce to double-downs, then to downs,
7266 then are eliminated. */
7267 if (modifiers
& (down_modifier
| drag_modifier
7268 | double_modifier
| triple_modifier
))
7270 while (modifiers
& (down_modifier
| drag_modifier
7271 | double_modifier
| triple_modifier
))
7273 Lisp_Object new_head
, new_click
;
7274 if (modifiers
& triple_modifier
)
7275 modifiers
^= (double_modifier
| triple_modifier
);
7276 else if (modifiers
& double_modifier
)
7277 modifiers
&= ~double_modifier
;
7278 else if (modifiers
& drag_modifier
)
7279 modifiers
&= ~drag_modifier
;
7282 /* Dispose of this `down' event by simply jumping
7283 back to replay_key, to get another event.
7285 Note that if this event came from mock input,
7286 then just jumping back to replay_key will just
7287 hand it to us again. So we have to wipe out any
7290 We could delete keybuf[t] and shift everything
7291 after that to the left by one spot, but we'd also
7292 have to fix up any variable that points into
7293 keybuf, and shifting isn't really necessary
7296 Adding prefixes for non-textual mouse clicks
7297 creates two characters of mock input, and both
7298 must be thrown away. If we're only looking at
7299 the prefix now, we can just jump back to
7300 replay_key. On the other hand, if we've already
7301 processed the prefix, and now the actual click
7302 itself is giving us trouble, then we've lost the
7303 state of the keymaps we want to backtrack to, and
7304 we need to replay the whole sequence to rebuild
7307 Beyond that, only function key expansion could
7308 create more than two keys, but that should never
7309 generate mouse events, so it's okay to zero
7310 mock_input in that case too.
7312 Isn't this just the most wonderful code ever? */
7313 if (t
== last_real_key_start
)
7320 mock_input
= last_real_key_start
;
7321 goto replay_sequence
;
7326 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
7328 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
7330 /* Look for a binding for this new key. follow_key
7331 promises that it didn't munge submaps the
7332 last time we called it, since key was unbound. */
7334 = (follow_key (new_click
,
7335 nmaps
- local_first_binding
,
7336 submaps
+ local_first_binding
,
7337 defs
+ local_first_binding
,
7338 submaps
+ local_first_binding
)
7339 + local_first_binding
);
7341 /* If that click is bound, go for it. */
7342 if (first_binding
< nmaps
)
7347 /* Otherwise, we'll leave key set to the drag event. */
7354 /* Normally, last_nonmenu_event gets the previous key we read.
7355 But when a mouse popup menu is being used,
7356 we don't update last_nonmenu_event; it continues to hold the mouse
7357 event that preceded the first level of menu. */
7358 if (!used_mouse_menu
)
7359 last_nonmenu_event
= key
;
7361 /* Record what part of this_command_keys is the current key sequence. */
7362 this_single_command_key_start
= this_command_key_count
- t
;
7364 prev_fkey_map
= fkey_map
;
7365 prev_fkey_start
= fkey_start
;
7366 prev_fkey_end
= fkey_end
;
7368 prev_keytran_map
= keytran_map
;
7369 prev_keytran_start
= keytran_start
;
7370 prev_keytran_end
= keytran_end
;
7372 /* If the sequence is unbound, see if we can hang a function key
7373 off the end of it. We only want to scan real keyboard input
7374 for function key sequences, so if mock_input says that we're
7375 re-reading old events, don't examine it. */
7376 if (first_binding
>= nmaps
7379 Lisp_Object fkey_next
;
7381 /* Continue scan from fkey_end until we find a bound suffix.
7382 If we fail, increment fkey_start
7383 and start fkey_end from there. */
7384 while (fkey_end
< t
)
7388 key
= keybuf
[fkey_end
++];
7389 /* Look up meta-characters by prefixing them
7390 with meta_prefix_char. I hate this. */
7391 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
7396 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0), 0),
7398 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
7401 fkey_next
= fkey_map
;
7404 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0), 0);
7406 #if 0 /* I didn't turn this on, because it might cause trouble
7407 for the mapping of return into C-m and tab into C-i. */
7408 /* Optionally don't map function keys into other things.
7409 This enables the user to redefine kp- keys easily. */
7410 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
7414 /* If the function key map gives a function, not an
7415 array, then call the function with no args and use
7416 its value instead. */
7417 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
7420 struct gcpro gcpro1
, gcpro2
, gcpro3
;
7424 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
7425 fkey_next
= call1 (fkey_next
, prompt
);
7427 /* If the function returned something invalid,
7428 barf--don't ignore it.
7429 (To ignore it safely, we would need to gcpro a bunch of
7430 other variables.) */
7431 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
7432 error ("Function in key-translation-map returns invalid key sequence");
7435 function_key_possible
= ! NILP (fkey_next
);
7437 /* If keybuf[fkey_start..fkey_end] is bound in the
7438 function key map and it's a suffix of the current
7439 sequence (i.e. fkey_end == t), replace it with
7440 the binding and restart with fkey_start at the end. */
7441 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
7444 int len
= XFASTINT (Flength (fkey_next
));
7446 t
= fkey_start
+ len
;
7448 error ("Key sequence too long");
7450 if (VECTORP (fkey_next
))
7451 bcopy (XVECTOR (fkey_next
)->contents
,
7452 keybuf
+ fkey_start
,
7453 (t
- fkey_start
) * sizeof (keybuf
[0]));
7454 else if (STRINGP (fkey_next
))
7458 for (i
= 0; i
< len
; i
++)
7459 XSETFASTINT (keybuf
[fkey_start
+ i
],
7460 XSTRING (fkey_next
)->data
[i
]);
7464 fkey_start
= fkey_end
= t
;
7465 fkey_map
= Vfunction_key_map
;
7467 /* Do pass the results through key-translation-map. */
7468 keytran_start
= keytran_end
= 0;
7469 keytran_map
= Vkey_translation_map
;
7471 goto replay_sequence
;
7474 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
7476 /* If we no longer have a bound suffix, try a new positions for
7478 if (NILP (fkey_map
))
7480 fkey_end
= ++fkey_start
;
7481 fkey_map
= Vfunction_key_map
;
7482 function_key_possible
= 0;
7487 /* Look for this sequence in key-translation-map. */
7489 Lisp_Object keytran_next
;
7491 /* Scan from keytran_end until we find a bound suffix. */
7492 while (keytran_end
< t
)
7496 key
= keybuf
[keytran_end
++];
7497 /* Look up meta-characters by prefixing them
7498 with meta_prefix_char. I hate this. */
7499 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
7504 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0), 0),
7506 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
7509 keytran_next
= keytran_map
;
7512 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0), 1);
7514 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
7515 && CONSP (XSYMBOL (keytran_next
)->function
)
7516 && EQ (XCONS (XSYMBOL (keytran_next
)->function
)->car
, Qautoload
))
7517 do_autoload (XSYMBOL (keytran_next
)->function
,
7520 /* Handle a symbol whose function definition is a keymap. */
7521 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
7522 && !NILP (Fkeymapp (XSYMBOL (keytran_next
)->function
)))
7523 keytran_next
= XSYMBOL (keytran_next
)->function
;
7525 /* If the key translation map gives a function, not an
7526 array, then call the function with one arg and use
7527 its value instead. */
7528 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
7529 && keytran_end
== t
)
7531 struct gcpro gcpro1
, gcpro2
, gcpro3
;
7535 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
7536 keytran_next
= call1 (keytran_next
, prompt
);
7538 /* If the function returned something invalid,
7539 barf--don't ignore it.
7540 (To ignore it safely, we would need to gcpro a bunch of
7541 other variables.) */
7542 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
7543 error ("Function in key-translation-map returns invalid key sequence");
7546 key_translation_possible
= ! NILP (keytran_next
);
7548 /* If keybuf[keytran_start..keytran_end] is bound in the
7549 key translation map and it's a suffix of the current
7550 sequence (i.e. keytran_end == t), replace it with
7551 the binding and restart with keytran_start at the end. */
7552 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
7553 && keytran_end
== t
)
7555 int len
= XFASTINT (Flength (keytran_next
));
7557 t
= keytran_start
+ len
;
7559 error ("Key sequence too long");
7561 if (VECTORP (keytran_next
))
7562 bcopy (XVECTOR (keytran_next
)->contents
,
7563 keybuf
+ keytran_start
,
7564 (t
- keytran_start
) * sizeof (keybuf
[0]));
7565 else if (STRINGP (keytran_next
))
7569 for (i
= 0; i
< len
; i
++)
7570 XSETFASTINT (keybuf
[keytran_start
+ i
],
7571 XSTRING (keytran_next
)->data
[i
]);
7575 keytran_start
= keytran_end
= t
;
7576 keytran_map
= Vkey_translation_map
;
7578 /* Don't pass the results of key-translation-map
7579 through function-key-map. */
7580 fkey_start
= fkey_end
= t
;
7581 fkey_map
= Vkey_translation_map
;
7583 goto replay_sequence
;
7586 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
7588 /* If we no longer have a bound suffix, try a new positions for
7590 if (NILP (keytran_map
))
7592 keytran_end
= ++keytran_start
;
7593 keytran_map
= Vkey_translation_map
;
7594 key_translation_possible
= 0;
7599 /* If KEY is not defined in any of the keymaps,
7600 and cannot be part of a function key or translation,
7601 and is an upper case letter
7602 use the corresponding lower-case letter instead. */
7603 if (first_binding
== nmaps
&& ! function_key_possible
7604 && ! key_translation_possible
7606 && ((((XINT (key
) & 0x3ffff)
7607 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
7608 && UPPERCASEP (XINT (key
) & 0x3ffff))
7609 || (XINT (key
) & shift_modifier
)))
7611 Lisp_Object new_key
;
7613 original_uppercase
= key
;
7614 original_uppercase_position
= t
- 1;
7616 if (XINT (key
) & shift_modifier
)
7617 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
7619 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
7620 | (XINT (key
) & ~0x3ffff)));
7622 /* We have to do this unconditionally, regardless of whether
7623 the lower-case char is defined in the keymaps, because they
7624 might get translated through function-key-map. */
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
;
7638 /* If KEY is not defined in any of the keymaps,
7639 and cannot be part of a function key or translation,
7640 and is a shifted function key,
7641 use the corresponding unshifted function key instead. */
7642 if (first_binding
== nmaps
&& ! function_key_possible
7643 && ! key_translation_possible
7646 Lisp_Object breakdown
;
7649 breakdown
= parse_modifiers (key
);
7650 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
7651 if (modifiers
& shift_modifier
)
7653 Lisp_Object new_key
;
7655 original_uppercase
= key
;
7656 original_uppercase_position
= t
- 1;
7658 modifiers
&= ~shift_modifier
;
7659 new_key
= apply_modifiers (modifiers
,
7660 XCONS (breakdown
)->car
);
7662 keybuf
[t
- 1] = new_key
;
7665 fkey_map
= prev_fkey_map
;
7666 fkey_start
= prev_fkey_start
;
7667 fkey_end
= prev_fkey_end
;
7669 keytran_map
= prev_keytran_map
;
7670 keytran_start
= prev_keytran_start
;
7671 keytran_end
= prev_keytran_end
;
7673 goto replay_sequence
;
7679 read_key_sequence_cmd
= (first_binding
< nmaps
7680 ? defs
[first_binding
]
7683 unread_switch_frame
= delayed_switch_frame
;
7684 unbind_to (count
, Qnil
);
7686 /* Don't downcase the last character if the caller says don't.
7687 Don't downcase it if the result is undefined, either. */
7688 if ((dont_downcase_last
|| first_binding
>= nmaps
)
7689 && t
- 1 == original_uppercase_position
)
7690 keybuf
[t
- 1] = original_uppercase
;
7692 /* Occasionally we fabricate events, perhaps by expanding something
7693 according to function-key-map, or by adding a prefix symbol to a
7694 mouse click in the scroll bar or modeline. In this cases, return
7695 the entire generated key sequence, even if we hit an unbound
7696 prefix or a definition before the end. This means that you will
7697 be able to push back the event properly, and also means that
7698 read-key-sequence will always return a logical unit.
7701 for (; t
< mock_input
; t
++)
7703 if (echo_keystrokes
)
7704 echo_char (keybuf
[t
]);
7705 add_command_key (keybuf
[t
]);
7713 #if 0 /* This doc string is too long for some compilers.
7714 This commented-out definition serves for DOC. */
7715 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
7716 "Read a sequence of keystrokes and return as a string or vector.\n\
7717 The sequence is sufficient to specify a non-prefix command in the\n\
7718 current local and global maps.\n\
7720 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
7721 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
7722 as a continuation of the previous key.\n\
7724 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
7725 convert the last event to lower case. (Normally any upper case event\n\
7726 is converted to lower case if the original event is undefined and the lower\n\
7727 case equivalent is defined.) A non-nil value is appropriate for reading\n\
7728 a key sequence to be defined.\n\
7730 A C-g typed while in this function is treated like any other character,\n\
7731 and `quit-flag' is not set.\n\
7733 If the key sequence starts with a mouse click, then the sequence is read\n\
7734 using the keymaps of the buffer of the window clicked in, not the buffer\n\
7735 of the selected window as normal.\n\
7737 `read-key-sequence' drops unbound button-down events, since you normally\n\
7738 only care about the click or drag events which follow them. If a drag\n\
7739 or multi-click event is unbound, but the corresponding click event would\n\
7740 be bound, `read-key-sequence' turns the event into a click event at the\n\
7741 drag's starting position. This means that you don't have to distinguish\n\
7742 between click and drag, double, or triple events unless you want to.\n\
7744 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
7745 lines separating windows, and scroll bars with imaginary keys\n\
7746 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
7748 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
7749 function will process a switch-frame event if the user switches frames\n\
7750 before typing anything. If the user switches frames in the middle of a\n\
7751 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
7752 is nil, then the event will be put off until after the current key sequence.\n\
7754 `read-key-sequence' checks `function-key-map' for function key\n\
7755 sequences, where they wouldn't conflict with ordinary bindings. See\n\
7756 `function-key-map' for more details.\n\
7758 The optional fifth argument COMMAND-LOOP, if non-nil, means\n\
7759 that this key sequence is being read by something that will\n\
7760 read commands one after another. It should be nil if the caller\n\
7761 will read just one key sequence.")
7762 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
, command
-loop
)
7765 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
7767 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
7769 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
7770 Lisp_Object can_return_switch_frame
, command_loop
;
7772 Lisp_Object keybuf
[30];
7774 struct gcpro gcpro1
, gcpro2
;
7775 int count
= specpdl_ptr
- specpdl
;
7778 CHECK_STRING (prompt
, 0);
7781 specbind (Qinput_method_exit_on_first_char
,
7782 (NILP (command_loop
) ? Qt
: Qnil
));
7783 specbind (Qinput_method_use_echo_area
,
7784 (NILP (command_loop
) ? Qt
: Qnil
));
7786 bzero (keybuf
, sizeof keybuf
);
7788 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
7790 if (NILP (continue_echo
))
7792 this_command_key_count
= 0;
7793 this_single_command_key_start
= 0;
7796 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
7797 prompt
, ! NILP (dont_downcase_last
),
7798 ! NILP (can_return_switch_frame
), 0);
7806 return unbind_to (count
, make_event_array (i
, keybuf
));
7809 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
7810 Sread_key_sequence_vector
, 1, 5, 0,
7811 "Like `read-key-sequence' but always return a vector.")
7812 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
7814 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
7815 Lisp_Object can_return_switch_frame
, command_loop
;
7817 Lisp_Object keybuf
[30];
7819 struct gcpro gcpro1
, gcpro2
;
7820 int count
= specpdl_ptr
- specpdl
;
7823 CHECK_STRING (prompt
, 0);
7826 specbind (Qinput_method_exit_on_first_char
,
7827 (NILP (command_loop
) ? Qt
: Qnil
));
7828 specbind (Qinput_method_use_echo_area
,
7829 (NILP (command_loop
) ? Qt
: Qnil
));
7831 bzero (keybuf
, sizeof keybuf
);
7833 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
7835 if (NILP (continue_echo
))
7837 this_command_key_count
= 0;
7838 this_single_command_key_start
= 0;
7841 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
7842 prompt
, ! NILP (dont_downcase_last
),
7843 ! NILP (can_return_switch_frame
), 0);
7851 return unbind_to (count
, Fvector (i
, keybuf
));
7854 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
7855 "Execute CMD as an editor command.\n\
7856 CMD must be a symbol that satisfies the `commandp' predicate.\n\
7857 Optional second arg RECORD-FLAG non-nil\n\
7858 means unconditionally put this command in `command-history'.\n\
7859 Otherwise, that is done only if an arg is read using the minibuffer.\n\
7860 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
7861 when reading the arguments; if it is nil, (this-command-keys) is used.\n\
7862 The argument SPECIAL, if non-nil, means that this command is executing\n\
7863 a special event, so ignore the prefix argument and don't clear it.")
7864 (cmd
, record_flag
, keys
, special
)
7865 Lisp_Object cmd
, record_flag
, keys
, special
;
7867 register Lisp_Object final
;
7868 register Lisp_Object tem
;
7869 Lisp_Object prefixarg
;
7870 struct backtrace backtrace
;
7871 extern int debug_on_next_call
;
7873 debug_on_next_call
= 0;
7877 prefixarg
= current_kboard
->Vprefix_arg
;
7878 Vcurrent_prefix_arg
= prefixarg
;
7879 current_kboard
->Vprefix_arg
= Qnil
;
7886 tem
= Fget (cmd
, Qdisabled
);
7887 if (!NILP (tem
) && !NILP (Vrun_hooks
))
7889 tem
= Fsymbol_value (Qdisabled_command_hook
);
7891 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
7897 final
= Findirect_function (cmd
);
7899 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
7901 struct gcpro gcpro1
, gcpro2
;
7903 GCPRO2 (cmd
, prefixarg
);
7904 do_autoload (final
, cmd
);
7911 if (STRINGP (final
) || VECTORP (final
))
7913 /* If requested, place the macro in the command history. For
7914 other sorts of commands, call-interactively takes care of
7916 if (!NILP (record_flag
))
7919 = Fcons (Fcons (Qexecute_kbd_macro
,
7920 Fcons (final
, Fcons (prefixarg
, Qnil
))),
7923 /* Don't keep command history around forever. */
7924 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
7926 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
7928 XCONS (tem
)->cdr
= Qnil
;
7932 return Fexecute_kbd_macro (final
, prefixarg
);
7935 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
7937 backtrace
.next
= backtrace_list
;
7938 backtrace_list
= &backtrace
;
7939 backtrace
.function
= &Qcall_interactively
;
7940 backtrace
.args
= &cmd
;
7941 backtrace
.nargs
= 1;
7942 backtrace
.evalargs
= 0;
7944 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
7946 backtrace_list
= backtrace
.next
;
7952 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
7954 "Read function name, then read its arguments and call it.")
7956 Lisp_Object prefixarg
;
7958 Lisp_Object function
;
7960 Lisp_Object saved_keys
;
7961 Lisp_Object bindings
, value
;
7962 struct gcpro gcpro1
, gcpro2
;
7964 saved_keys
= Fvector (this_command_key_count
,
7965 XVECTOR (this_command_keys
)->contents
);
7967 GCPRO2 (saved_keys
, prefixarg
);
7969 if (EQ (prefixarg
, Qminus
))
7971 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
7972 strcpy (buf
, "C-u ");
7973 else if (CONSP (prefixarg
) && INTEGERP (XCONS (prefixarg
)->car
))
7975 if (sizeof (int) == sizeof (EMACS_INT
))
7976 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
7977 else if (sizeof (long) == sizeof (EMACS_INT
))
7978 sprintf (buf
, "%ld ", XINT (XCONS (prefixarg
)->car
));
7982 else if (INTEGERP (prefixarg
))
7984 if (sizeof (int) == sizeof (EMACS_INT
))
7985 sprintf (buf
, "%d ", XINT (prefixarg
));
7986 else if (sizeof (long) == sizeof (EMACS_INT
))
7987 sprintf (buf
, "%ld ", XINT (prefixarg
));
7992 /* This isn't strictly correct if execute-extended-command
7993 is bound to anything else. Perhaps it should use
7994 this_command_keys? */
7995 strcat (buf
, "M-x ");
7997 /* Prompt with buf, and then read a string, completing from and
7998 restricting to the set of all defined commands. Don't provide
7999 any initial input. Save the command read on the extended-command
8001 function
= Fcompleting_read (build_string (buf
),
8002 Vobarray
, Qcommandp
,
8003 Qt
, Qnil
, Qextended_command_history
, Qnil
,
8006 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
8007 error ("No command name given");
8009 /* Set this_command_keys to the concatenation of saved_keys and
8010 function, followed by a RET. */
8012 struct Lisp_String
*str
;
8016 this_command_key_count
= 0;
8017 this_single_command_key_start
= 0;
8019 keys
= XVECTOR (saved_keys
)->contents
;
8020 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
8021 add_command_key (keys
[i
]);
8023 str
= XSTRING (function
);
8024 for (i
= 0; i
< str
->size
; i
++)
8025 add_command_key (Faref (function
, make_number (i
)));
8027 add_command_key (make_number ('\015'));
8032 function
= Fintern (function
, Qnil
);
8033 current_kboard
->Vprefix_arg
= prefixarg
;
8034 Vthis_command
= function
;
8035 real_this_command
= function
;
8037 /* If enabled, show which key runs this command. */
8038 if (!NILP (Vsuggest_key_bindings
)
8039 && NILP (Vexecuting_macro
)
8040 && SYMBOLP (function
))
8041 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
8047 GCPRO2 (bindings
, value
);
8048 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
8050 /* If the command has a key binding, print it now. */
8051 if (!NILP (bindings
)
8052 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
8055 /* But first wait, and skip the message if there is input. */
8057 if (echo_area_glyphs
!= 0)
8058 /* This command displayed something in the echo area;
8059 so wait a few seconds, then display our suggestion message. */
8060 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
8061 ? XINT (Vsuggest_key_bindings
) : 2);
8063 /* This command left the echo area empty,
8064 so display our message immediately. */
8067 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
8068 && ! CONSP (Vunread_command_events
))
8070 Lisp_Object binding
;
8072 char *oldmessage
= echo_area_glyphs
;
8073 int oldmessage_len
= echo_area_glyphs_length
;
8074 int oldmultibyte
= message_enable_multibyte
;
8076 binding
= Fkey_description (bindings
);
8079 = (char *) alloca (XSYMBOL (function
)->name
->size
8080 + STRING_BYTES (XSTRING (binding
))
8082 sprintf (newmessage
, "You can run the command `%s' with %s",
8083 XSYMBOL (function
)->name
->data
,
8084 XSTRING (binding
)->data
);
8085 message2_nolog (newmessage
,
8086 strlen (newmessage
),
8087 STRING_MULTIBYTE (binding
));
8088 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
8089 ? Vsuggest_key_bindings
: make_number (2)),
8091 message2_nolog (oldmessage
, oldmessage_len
, oldmultibyte
);
8095 RETURN_UNGCPRO (value
);
8098 /* Find the set of keymaps now active.
8099 Store into *MAPS_P a vector holding the various maps
8100 and return the number of them. The vector was malloc'd
8101 and the caller should free it. */
8104 current_active_maps (maps_p
)
8105 Lisp_Object
**maps_p
;
8107 Lisp_Object
*tmaps
, *maps
;
8110 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8111 if (!NILP (Voverriding_local_map_menu_flag
))
8113 /* Yes, use them (if non-nil) as well as the global map. */
8114 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
8116 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8117 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8118 if (!NILP (Voverriding_local_map
))
8119 maps
[nmaps
++] = Voverriding_local_map
;
8123 /* No, so use major and minor mode keymaps. */
8124 nmaps
= current_minor_maps (NULL
, &tmaps
);
8125 maps
= (Lisp_Object
*) xmalloc ((nmaps
+ 2) * sizeof (maps
[0]));
8126 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
8127 #ifdef USE_TEXT_PROPERTIES
8128 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
8130 maps
[nmaps
++] = current_buffer
->keymap
;
8133 maps
[nmaps
++] = current_global_map
;
8139 /* Return nonzero if input events are pending. */
8142 detect_input_pending ()
8145 get_input_pending (&input_pending
, 0);
8147 return input_pending
;
8150 /* Return nonzero if input events are pending, and run any pending timers. */
8153 detect_input_pending_run_timers (do_display
)
8156 int old_timers_run
= timers_run
;
8159 get_input_pending (&input_pending
, 1);
8161 if (old_timers_run
!= timers_run
&& do_display
)
8162 redisplay_preserve_echo_area ();
8164 return input_pending
;
8167 /* This is called in some cases before a possible quit.
8168 It cases the next call to detect_input_pending to recompute input_pending.
8169 So calling this function unnecessarily can't do any harm. */
8172 clear_input_pending ()
8177 /* Return nonzero if there are pending requeued events.
8178 This isn't used yet. The hope is to make wait_reading_process_input
8179 call it, and return return if it runs Lisp code that unreads something.
8180 The problem is, kbd_buffer_get_event needs to be fixed to know what
8181 to do in that case. It isn't trivial. */
8184 requeued_events_pending_p ()
8186 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
8190 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
8191 "T if command input is currently available with no waiting.\n\
8192 Actually, the value is nil only if we can be sure that no input is available.")
8195 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
8198 get_input_pending (&input_pending
, 1);
8199 return input_pending
> 0 ? Qt
: Qnil
;
8202 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
8203 "Return vector of last 100 events, not counting those from keyboard macros.")
8206 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
8209 if (total_keys
< NUM_RECENT_KEYS
)
8210 return Fvector (total_keys
, keys
);
8213 val
= Fvector (NUM_RECENT_KEYS
, keys
);
8214 bcopy (keys
+ recent_keys_index
,
8215 XVECTOR (val
)->contents
,
8216 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
8218 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
8219 recent_keys_index
* sizeof (Lisp_Object
));
8224 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
8225 "Return the key sequence that invoked this command.\n\
8226 The value is a string or a vector.")
8229 return make_event_array (this_command_key_count
,
8230 XVECTOR (this_command_keys
)->contents
);
8233 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
8234 "Return the key sequence that invoked this command, as a vector.")
8237 return Fvector (this_command_key_count
,
8238 XVECTOR (this_command_keys
)->contents
);
8241 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
8242 Sthis_single_command_keys
, 0, 0, 0,
8243 "Return the key sequence that invoked this command.\n\
8244 Unlike `this-command-keys', this function's value\n\
8245 does not include prefix arguments.\n\
8246 The value is always a vector.")
8249 return Fvector (this_command_key_count
8250 - this_single_command_key_start
,
8251 (XVECTOR (this_command_keys
)->contents
8252 + this_single_command_key_start
));
8255 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
8256 Sthis_single_command_raw_keys
, 0, 0, 0,
8257 "Return the raw events that were read for this command.\n\
8258 Unlike `this-single-command-keys', this function's value\n\
8259 shows the events before all translations (except for input methods).\n\
8260 The value is always a vector.")
8263 return Fvector (raw_keybuf_count
,
8264 (XVECTOR (raw_keybuf
)->contents
));
8267 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
8268 Sreset_this_command_lengths
, 0, 0, 0,
8269 "Used for complicated reasons in `universal-argument-other-key'.\n\
8271 `universal-argument-other-key' rereads the event just typed.\n\
8272 It then gets translated through `function-key-map'.\n\
8273 The translated event gets included in the echo area and in\n\
8274 the value of `this-command-keys' in addition to the raw original event.\n\
8275 That is not right.\n\
8277 Calling this function directs the translated event to replace\n\
8278 the original event, so that only one version of the event actually\n\
8279 appears in the echo area and in the value of `this-command-keys.'.")
8282 before_command_restore_flag
= 1;
8283 before_command_key_count_1
= before_command_key_count
;
8284 before_command_echo_length_1
= before_command_echo_length
;
8288 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
8289 Sclear_this_command_keys
, 0, 0, 0,
8290 "Clear out the vector that `this-command-keys' returns.")
8293 this_command_key_count
= 0;
8297 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
8298 "Return the current depth in recursive edits.")
8302 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
8306 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
8307 "FOpen dribble file: ",
8308 "Start writing all keyboard characters to a dribble file called FILE.\n\
8309 If FILE is nil, close any open dribble file.")
8320 file
= Fexpand_file_name (file
, Qnil
);
8321 dribble
= fopen (XSTRING (file
)->data
, "w");
8323 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
8328 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
8329 "Discard the contents of the terminal input buffer.\n\
8330 Also cancel any kbd macro being defined.")
8333 current_kboard
->defining_kbd_macro
= Qnil
;
8334 update_mode_lines
++;
8336 Vunread_command_events
= Qnil
;
8337 unread_command_char
= -1;
8339 discard_tty_input ();
8341 /* Without the cast, GCC complains that this assignment loses the
8342 volatile qualifier of kbd_store_ptr. Is there anything wrong
8344 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
8345 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
8351 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
8352 "Stop Emacs and return to superior process. You can resume later.\n\
8353 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
8354 control, run a subshell instead.\n\n\
8355 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
8356 to be read as terminal input by Emacs's parent, after suspension.\n\
8358 Before suspending, run the normal hook `suspend-hook'.\n\
8359 After resumption run the normal hook `suspend-resume-hook'.\n\
8361 Some operating systems cannot stop the Emacs process and resume it later.\n\
8362 On such systems, Emacs starts a subshell instead of suspending.")
8364 Lisp_Object stuffstring
;
8367 int count
= specpdl_ptr
- specpdl
;
8368 int old_height
, old_width
;
8370 struct gcpro gcpro1
, gcpro2
;
8372 if (!NILP (stuffstring
))
8373 CHECK_STRING (stuffstring
, 0);
8375 /* Run the functions in suspend-hook. */
8376 if (!NILP (Vrun_hooks
))
8377 call1 (Vrun_hooks
, intern ("suspend-hook"));
8379 GCPRO1 (stuffstring
);
8380 get_frame_size (&old_width
, &old_height
);
8382 /* sys_suspend can get an error if it tries to fork a subshell
8383 and the system resources aren't available for that. */
8384 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
8386 stuff_buffered_input (stuffstring
);
8391 unbind_to (count
, Qnil
);
8393 /* Check if terminal/window size has changed.
8394 Note that this is not useful when we are running directly
8395 with a window system; but suspend should be disabled in that case. */
8396 get_frame_size (&width
, &height
);
8397 if (width
!= old_width
|| height
!= old_height
)
8398 change_frame_size (selected_frame
, height
, width
, 0, 0);
8400 /* Run suspend-resume-hook. */
8401 if (!NILP (Vrun_hooks
))
8402 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
8408 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
8409 Then in any case stuff anything Emacs has read ahead and not used. */
8412 stuff_buffered_input (stuffstring
)
8413 Lisp_Object stuffstring
;
8415 /* stuff_char works only in BSD, versions 4.2 and up. */
8418 register unsigned char *p
;
8420 if (STRINGP (stuffstring
))
8424 p
= XSTRING (stuffstring
)->data
;
8425 count
= STRING_BYTES (XSTRING (stuffstring
));
8430 /* Anything we have read ahead, put back for the shell to read. */
8431 /* ?? What should this do when we have multiple keyboards??
8432 Should we ignore anything that was typed in at the "wrong" kboard? */
8433 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
8435 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
8436 kbd_fetch_ptr
= kbd_buffer
;
8437 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
8438 stuff_char (kbd_fetch_ptr
->code
);
8439 kbd_fetch_ptr
->kind
= no_event
;
8440 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
8446 #endif /* BSD_SYSTEM and not BSD4_1 */
8450 set_waiting_for_input (time_to_clear
)
8451 EMACS_TIME
*time_to_clear
;
8453 input_available_clear_time
= time_to_clear
;
8455 /* Tell interrupt_signal to throw back to read_char, */
8456 waiting_for_input
= 1;
8458 /* If interrupt_signal was called before and buffered a C-g,
8459 make it run again now, to avoid timing error. */
8460 if (!NILP (Vquit_flag
))
8461 quit_throw_to_read_char ();
8465 clear_waiting_for_input ()
8467 /* Tell interrupt_signal not to throw back to read_char, */
8468 waiting_for_input
= 0;
8469 input_available_clear_time
= 0;
8472 /* This routine is called at interrupt level in response to C-G.
8473 If interrupt_input, this is the handler for SIGINT.
8474 Otherwise, it is called from kbd_buffer_store_event,
8475 in handling SIGIO or SIGTINT.
8477 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
8478 immediately throw back to read_char.
8480 Otherwise it sets the Lisp variable quit-flag not-nil.
8481 This causes eval to throw, when it gets a chance.
8482 If quit-flag is already non-nil, it stops the job right away. */
8485 interrupt_signal (signalnum
) /* If we don't have an argument, */
8486 int signalnum
; /* some compilers complain in signal calls. */
8489 /* Must preserve main program's value of errno. */
8490 int old_errno
= errno
;
8492 #if defined (USG) && !defined (POSIX_SIGNALS)
8493 if (!read_socket_hook
&& NILP (Vwindow_system
))
8495 /* USG systems forget handlers when they are used;
8496 must reestablish each time */
8497 signal (SIGINT
, interrupt_signal
);
8498 signal (SIGQUIT
, interrupt_signal
);
8504 if (!NILP (Vquit_flag
)
8505 && (FRAME_TERMCAP_P (selected_frame
) || FRAME_MSDOS_P (selected_frame
)))
8507 /* If SIGINT isn't blocked, don't let us be interrupted by
8508 another SIGINT, it might be harmful due to non-reentrancy
8509 in I/O functions. */
8510 sigblock (sigmask (SIGINT
));
8515 #ifdef SIGTSTP /* Support possible in later USG versions */
8517 * On systems which can suspend the current process and return to the original
8518 * shell, this command causes the user to end up back at the shell.
8519 * The "Auto-save" and "Abort" questions are not asked until
8520 * the user elects to return to emacs, at which point he can save the current
8521 * job and either dump core or continue.
8526 if (sys_suspend () == -1)
8528 printf ("Not running as a subprocess;\n");
8529 printf ("you can continue or abort.\n");
8532 /* Perhaps should really fork an inferior shell?
8533 But that would not provide any way to get back
8534 to the original shell, ever. */
8535 printf ("No support for stopping a process on this operating system;\n");
8536 printf ("you can continue or abort.\n");
8537 #endif /* not VMS */
8538 #endif /* not SIGTSTP */
8540 /* We must remain inside the screen area when the internal terminal
8541 is used. Note that [Enter] is not echoed by dos. */
8544 /* It doesn't work to autosave while GC is in progress;
8545 the code used for auto-saving doesn't cope with the mark bit. */
8546 if (!gc_in_progress
)
8548 printf ("Auto-save? (y or n) ");
8550 if (((c
= getchar ()) & ~040) == 'Y')
8552 Fdo_auto_save (Qt
, Qnil
);
8554 printf ("\r\nAuto-save done");
8555 #else /* not MSDOS */
8556 printf ("Auto-save done\n");
8557 #endif /* not MSDOS */
8559 while (c
!= '\n') c
= getchar ();
8563 /* During GC, it must be safe to reenable quitting again. */
8564 Vinhibit_quit
= Qnil
;
8567 #endif /* not MSDOS */
8568 printf ("Garbage collection in progress; cannot auto-save now\r\n");
8569 printf ("but will instead do a real quit after garbage collection ends\r\n");
8574 printf ("\r\nAbort? (y or n) ");
8575 #else /* not MSDOS */
8577 printf ("Abort (and enter debugger)? (y or n) ");
8579 printf ("Abort (and dump core)? (y or n) ");
8580 #endif /* not VMS */
8581 #endif /* not MSDOS */
8583 if (((c
= getchar ()) & ~040) == 'Y')
8585 while (c
!= '\n') c
= getchar ();
8587 printf ("\r\nContinuing...\r\n");
8588 #else /* not MSDOS */
8589 printf ("Continuing...\n");
8590 #endif /* not MSDOS */
8597 /* If executing a function that wants to be interrupted out of
8598 and the user has not deferred quitting by binding `inhibit-quit'
8599 then quit right away. */
8600 if (immediate_quit
&& NILP (Vinhibit_quit
))
8602 struct gl_state_s saved
;
8603 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8608 GCPRO4 (saved
.object
, saved
.global_code
,
8609 saved
.current_syntax_table
, saved
.old_prop
);
8610 Fsignal (Qquit
, Qnil
);
8615 /* Else request quit when it's safe */
8619 if (waiting_for_input
&& !echoing
)
8620 quit_throw_to_read_char ();
8625 /* Handle a C-g by making read_char return C-g. */
8628 quit_throw_to_read_char ()
8630 quit_error_check ();
8632 /* Prevent another signal from doing this before we finish. */
8633 clear_waiting_for_input ();
8636 Vunread_command_events
= Qnil
;
8637 unread_command_char
= -1;
8639 #if 0 /* Currently, sit_for is called from read_char without turning
8640 off polling. And that can call set_waiting_for_input.
8641 It seems to be harmless. */
8642 #ifdef POLL_FOR_INPUT
8643 /* May be > 1 if in recursive minibuffer. */
8644 if (poll_suppress_count
== 0)
8648 if (FRAMEP (internal_last_event_frame
)
8649 && XFRAME (internal_last_event_frame
) != selected_frame
)
8650 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
8653 _longjmp (getcjmp
, 1);
8656 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
8657 "Set mode of reading keyboard input.\n\
8658 First arg INTERRUPT non-nil means use input interrupts;\n\
8659 nil means use CBREAK mode.\n\
8660 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
8661 (no effect except in CBREAK mode).\n\
8662 Third arg META t means accept 8-bit input (for a Meta key).\n\
8663 META nil means ignore the top bit, on the assumption it is parity.\n\
8664 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
8665 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
8666 See also `current-input-mode'.")
8667 (interrupt
, flow
, meta
, quit
)
8668 Lisp_Object interrupt
, flow
, meta
, quit
;
8671 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
8672 error ("set-input-mode: QUIT must be an ASCII character");
8674 #ifdef POLL_FOR_INPUT
8679 /* this causes startup screen to be restored and messes with the mouse */
8684 /* Note SIGIO has been undef'd if FIONREAD is missing. */
8685 if (read_socket_hook
)
8687 /* When using X, don't give the user a real choice,
8688 because we haven't implemented the mechanisms to support it. */
8689 #ifdef NO_SOCK_SIGIO
8690 interrupt_input
= 0;
8691 #else /* not NO_SOCK_SIGIO */
8692 interrupt_input
= 1;
8693 #endif /* NO_SOCK_SIGIO */
8696 interrupt_input
= !NILP (interrupt
);
8697 #else /* not SIGIO */
8698 interrupt_input
= 0;
8699 #endif /* not SIGIO */
8701 /* Our VMS input only works by interrupts, as of now. */
8703 interrupt_input
= 1;
8706 flow_control
= !NILP (flow
);
8709 else if (EQ (meta
, Qt
))
8714 /* Don't let this value be out of range. */
8715 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
8721 #ifdef POLL_FOR_INPUT
8722 poll_suppress_count
= 1;
8728 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
8729 "Return information about the way Emacs currently reads keyboard input.\n\
8730 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
8731 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
8732 nil, Emacs is using CBREAK mode.\n\
8733 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
8734 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
8735 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
8736 META nil means ignoring the top bit, on the assumption it is parity.\n\
8737 META is neither t nor nil if accepting 8-bit input and using\n\
8738 all 8 bits as the character code.\n\
8739 QUIT is the character Emacs currently uses to quit.\n\
8740 The elements of this list correspond to the arguments of\n\
8746 val
[0] = interrupt_input
? Qt
: Qnil
;
8747 val
[1] = flow_control
? Qt
: Qnil
;
8748 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
8749 XSETFASTINT (val
[3], quit_char
);
8751 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
8756 * Set up a new kboard object with reasonable initial values.
8762 kb
->Voverriding_terminal_local_map
= Qnil
;
8763 kb
->Vlast_command
= Qnil
;
8764 kb
->Vreal_last_command
= Qnil
;
8765 kb
->Vprefix_arg
= Qnil
;
8766 kb
->Vlast_prefix_arg
= Qnil
;
8767 kb
->kbd_queue
= Qnil
;
8768 kb
->kbd_queue_has_data
= 0;
8769 kb
->immediate_echo
= 0;
8770 kb
->echoptr
= kb
->echobuf
;
8771 kb
->echo_after_prompt
= -1;
8772 kb
->kbd_macro_buffer
= 0;
8773 kb
->kbd_macro_bufsize
= 0;
8774 kb
->defining_kbd_macro
= Qnil
;
8775 kb
->Vlast_kbd_macro
= Qnil
;
8776 kb
->reference_count
= 0;
8777 kb
->Vsystem_key_alist
= Qnil
;
8778 kb
->system_key_syms
= Qnil
;
8779 kb
->Vdefault_minibuffer_frame
= Qnil
;
8783 * Destroy the contents of a kboard object, but not the object itself.
8784 * We use this just before deleting it, or if we're going to initialize
8791 if (kb
->kbd_macro_buffer
)
8792 xfree (kb
->kbd_macro_buffer
);
8801 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
8804 *kbp
= kb
->next_kboard
;
8813 /* This is correct before outermost invocation of the editor loop */
8814 command_loop_level
= -1;
8816 quit_char
= Ctl ('g');
8817 Vunread_command_events
= Qnil
;
8818 unread_command_char
= -1;
8819 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
8821 recent_keys_index
= 0;
8822 kbd_fetch_ptr
= kbd_buffer
;
8823 kbd_store_ptr
= kbd_buffer
;
8824 kbd_buffer_frame_or_window
8825 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8827 do_mouse_tracking
= Qnil
;
8831 /* This means that command_loop_1 won't try to select anything the first
8833 internal_last_event_frame
= Qnil
;
8834 Vlast_event_frame
= internal_last_event_frame
;
8837 current_kboard
= initial_kboard
;
8839 wipe_kboard (current_kboard
);
8840 init_kboard (current_kboard
);
8843 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
8845 kbd_buffer_frame_or_window
8846 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8847 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
8849 signal (SIGINT
, interrupt_signal
);
8850 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
8851 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
8852 SIGQUIT and we can't tell which one it will give us. */
8853 signal (SIGQUIT
, interrupt_signal
);
8854 #endif /* HAVE_TERMIO */
8856 /* Note SIGIO has been undef'd if FIONREAD is missing. */
8858 if (!noninteractive
)
8859 signal (SIGIO
, input_available_signal
);
8862 /* Use interrupt input by default, if it works and noninterrupt input
8863 has deficiencies. */
8865 #ifdef INTERRUPT_INPUT
8866 interrupt_input
= 1;
8868 interrupt_input
= 0;
8871 /* Our VMS input only works by interrupts, as of now. */
8873 interrupt_input
= 1;
8879 if (keyboard_init_hook
)
8880 (*keyboard_init_hook
) ();
8882 #ifdef POLL_FOR_INPUT
8883 poll_suppress_count
= 1;
8888 /* This type's only use is in syms_of_keyboard, to initialize the
8889 event header symbols and put properties on them. */
8896 struct event_head head_table
[] = {
8897 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
8898 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
8899 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
8900 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
8901 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
8902 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
8908 staticpro (&item_properties
);
8909 item_properties
= Qnil
;
8911 staticpro (&real_this_command
);
8912 real_this_command
= Qnil
;
8914 Qtimer_event_handler
= intern ("timer-event-handler");
8915 staticpro (&Qtimer_event_handler
);
8917 Qdisabled_command_hook
= intern ("disabled-command-hook");
8918 staticpro (&Qdisabled_command_hook
);
8920 Qself_insert_command
= intern ("self-insert-command");
8921 staticpro (&Qself_insert_command
);
8923 Qforward_char
= intern ("forward-char");
8924 staticpro (&Qforward_char
);
8926 Qbackward_char
= intern ("backward-char");
8927 staticpro (&Qbackward_char
);
8929 Qdisabled
= intern ("disabled");
8930 staticpro (&Qdisabled
);
8932 Qundefined
= intern ("undefined");
8933 staticpro (&Qundefined
);
8935 Qpre_command_hook
= intern ("pre-command-hook");
8936 staticpro (&Qpre_command_hook
);
8938 Qpost_command_hook
= intern ("post-command-hook");
8939 staticpro (&Qpost_command_hook
);
8941 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
8942 staticpro (&Qpost_command_idle_hook
);
8944 Qdeferred_action_function
= intern ("deferred-action-function");
8945 staticpro (&Qdeferred_action_function
);
8947 Qcommand_hook_internal
= intern ("command-hook-internal");
8948 staticpro (&Qcommand_hook_internal
);
8950 Qfunction_key
= intern ("function-key");
8951 staticpro (&Qfunction_key
);
8952 Qmouse_click
= intern ("mouse-click");
8953 staticpro (&Qmouse_click
);
8955 Qmouse_wheel
= intern ("mouse-wheel");
8956 staticpro (&Qmouse_wheel
);
8957 Qlanguage_change
= intern ("language-change");
8958 staticpro (&Qlanguage_change
);
8960 Qdrag_n_drop
= intern ("drag-n-drop");
8961 staticpro (&Qdrag_n_drop
);
8963 Qmenu_enable
= intern ("menu-enable");
8964 staticpro (&Qmenu_enable
);
8965 Qmenu_alias
= intern ("menu-alias");
8966 staticpro (&Qmenu_alias
);
8967 QCenable
= intern (":enable");
8968 staticpro (&QCenable
);
8969 QCvisible
= intern (":visible");
8970 staticpro (&QCvisible
);
8971 QCfilter
= intern (":filter");
8972 staticpro (&QCfilter
);
8973 QCbutton
= intern (":button");
8974 staticpro (&QCbutton
);
8975 QCkeys
= intern (":keys");
8976 staticpro (&QCkeys
);
8977 QCkey_sequence
= intern (":key-sequence");
8978 staticpro (&QCkey_sequence
);
8979 QCtoggle
= intern (":toggle");
8980 staticpro (&QCtoggle
);
8981 QCradio
= intern (":radio");
8982 staticpro (&QCradio
);
8984 Qmode_line
= intern ("mode-line");
8985 staticpro (&Qmode_line
);
8986 Qvertical_line
= intern ("vertical-line");
8987 staticpro (&Qvertical_line
);
8988 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
8989 staticpro (&Qvertical_scroll_bar
);
8990 Qmenu_bar
= intern ("menu-bar");
8991 staticpro (&Qmenu_bar
);
8993 Qabove_handle
= intern ("above-handle");
8994 staticpro (&Qabove_handle
);
8995 Qhandle
= intern ("handle");
8996 staticpro (&Qhandle
);
8997 Qbelow_handle
= intern ("below-handle");
8998 staticpro (&Qbelow_handle
);
8999 Qup
= intern ("up");
9001 Qdown
= intern ("down");
9004 Qevent_kind
= intern ("event-kind");
9005 staticpro (&Qevent_kind
);
9006 Qevent_symbol_elements
= intern ("event-symbol-elements");
9007 staticpro (&Qevent_symbol_elements
);
9008 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
9009 staticpro (&Qevent_symbol_element_mask
);
9010 Qmodifier_cache
= intern ("modifier-cache");
9011 staticpro (&Qmodifier_cache
);
9013 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
9014 staticpro (&Qrecompute_lucid_menubar
);
9015 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
9016 staticpro (&Qactivate_menubar_hook
);
9018 Qpolling_period
= intern ("polling-period");
9019 staticpro (&Qpolling_period
);
9021 Qinput_method_function
= intern ("input-method-function");
9022 staticpro (&Qinput_method_function
);
9024 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
9025 staticpro (&Qinput_method_exit_on_first_char
);
9026 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
9027 staticpro (&Qinput_method_use_echo_area
);
9029 Fset (Qinput_method_exit_on_first_char
, Qnil
);
9030 Fset (Qinput_method_use_echo_area
, Qnil
);
9033 struct event_head
*p
;
9035 for (p
= head_table
;
9036 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
9039 *p
->var
= intern (p
->name
);
9041 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
9042 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
9046 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
9047 staticpro (&button_down_location
);
9051 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
9053 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
9054 for (i
= 0; i
< len
; i
++)
9055 if (modifier_names
[i
])
9056 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
9057 staticpro (&modifier_symbols
);
9060 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
9061 staticpro (&recent_keys
);
9063 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
9064 staticpro (&this_command_keys
);
9066 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
9067 staticpro (&raw_keybuf
);
9069 Qextended_command_history
= intern ("extended-command-history");
9070 Fset (Qextended_command_history
, Qnil
);
9071 staticpro (&Qextended_command_history
);
9073 kbd_buffer_frame_or_window
9074 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
9075 staticpro (&kbd_buffer_frame_or_window
);
9077 accent_key_syms
= Qnil
;
9078 staticpro (&accent_key_syms
);
9080 func_key_syms
= Qnil
;
9081 staticpro (&func_key_syms
);
9084 staticpro (&mouse_syms
);
9087 mouse_wheel_syms
= Qnil
;
9088 staticpro (&mouse_wheel_syms
);
9090 drag_n_drop_syms
= Qnil
;
9091 staticpro (&drag_n_drop_syms
);
9094 unread_switch_frame
= Qnil
;
9095 staticpro (&unread_switch_frame
);
9097 internal_last_event_frame
= Qnil
;
9098 staticpro (&internal_last_event_frame
);
9100 read_key_sequence_cmd
= Qnil
;
9101 staticpro (&read_key_sequence_cmd
);
9103 menu_bar_one_keymap_changed_items
= Qnil
;
9104 staticpro (&menu_bar_one_keymap_changed_items
);
9106 defsubr (&Sevent_convert_list
);
9107 defsubr (&Sread_key_sequence
);
9108 defsubr (&Sread_key_sequence_vector
);
9109 defsubr (&Srecursive_edit
);
9111 defsubr (&Strack_mouse
);
9113 defsubr (&Sinput_pending_p
);
9114 defsubr (&Scommand_execute
);
9115 defsubr (&Srecent_keys
);
9116 defsubr (&Sthis_command_keys
);
9117 defsubr (&Sthis_command_keys_vector
);
9118 defsubr (&Sthis_single_command_keys
);
9119 defsubr (&Sthis_single_command_raw_keys
);
9120 defsubr (&Sreset_this_command_lengths
);
9121 defsubr (&Sclear_this_command_keys
);
9122 defsubr (&Ssuspend_emacs
);
9123 defsubr (&Sabort_recursive_edit
);
9124 defsubr (&Sexit_recursive_edit
);
9125 defsubr (&Srecursion_depth
);
9126 defsubr (&Stop_level
);
9127 defsubr (&Sdiscard_input
);
9128 defsubr (&Sopen_dribble_file
);
9129 defsubr (&Sset_input_mode
);
9130 defsubr (&Scurrent_input_mode
);
9131 defsubr (&Sexecute_extended_command
);
9133 DEFVAR_LISP ("last-command-char", &last_command_char
,
9134 "Last input event that was part of a command.");
9136 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
9137 "Last input event that was part of a command.");
9139 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
9140 "Last input event in a command, except for mouse menu events.\n\
9141 Mouse menus give back keys that don't look like mouse events;\n\
9142 this variable holds the actual mouse event that led to the menu,\n\
9143 so that you can determine whether the command was run by mouse or not.");
9145 DEFVAR_LISP ("last-input-char", &last_input_char
,
9146 "Last input event.");
9148 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
9149 "Last input event.");
9151 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
9152 "List of events to be read as the command input.\n\
9153 These events are processed first, before actual keyboard input.");
9154 Vunread_command_events
= Qnil
;
9156 DEFVAR_INT ("unread-command-char", &unread_command_char
,
9157 "If not -1, an object to be read as next command input event.");
9159 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
9160 "List of events to be processed as input by input methods.\n\
9161 These events are processed after `unread-command-events', but\n\
9162 before actual keyboard input.");
9163 Vunread_post_input_method_events
= Qnil
;
9165 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
9166 "List of events to be processed as input by input methods.\n\
9167 These events are processed after `unread-command-events', but\n\
9168 before actual keyboard input.");
9169 Vunread_input_method_events
= Qnil
;
9171 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
9172 "Meta-prefix character code.\n\
9173 Meta-foo as command input turns into this character followed by foo.");
9174 XSETINT (meta_prefix_char
, 033);
9176 DEFVAR_KBOARD ("last-command", Vlast_command
,
9177 "The last command executed.\n\
9178 Normally a symbol with a function definition, but can be whatever was found\n\
9179 in the keymap, or whatever the variable `this-command' was set to by that\n\
9182 The value `mode-exit' is special; it means that the previous command\n\
9183 read an event that told it to exit, and it did so and unread that event.\n\
9184 In other words, the present command is the event that made the previous\n\
9187 The value `kill-region' is special; it means that the previous command\n\
9188 was a kill command.");
9190 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
9191 "Same as `last-command', but never altered by Lisp code.");
9193 DEFVAR_LISP ("this-command", &Vthis_command
,
9194 "The command now being executed.\n\
9195 The command can set this variable; whatever is put here\n\
9196 will be in `last-command' during the following command.");
9197 Vthis_command
= Qnil
;
9199 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
9200 "*Number of keyboard input characters between auto-saves.\n\
9201 Zero means disable autosaving due to number of characters typed.");
9202 auto_save_interval
= 300;
9204 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
9205 "*Number of seconds idle time before auto-save.\n\
9206 Zero or nil means disable auto-saving due to idleness.\n\
9207 After auto-saving due to this many seconds of idle time,\n\
9208 Emacs also does a garbage collection if that seems to be warranted.");
9209 XSETFASTINT (Vauto_save_timeout
, 30);
9211 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
9212 "*Nonzero means echo unfinished commands after this many seconds of pause.");
9213 echo_keystrokes
= 1;
9215 DEFVAR_INT ("polling-period", &polling_period
,
9216 "*Interval between polling for input during Lisp execution.\n\
9217 The reason for polling is to make C-g work to stop a running program.\n\
9218 Polling is needed only when using X windows and SIGIO does not work.\n\
9219 Polling is automatically disabled in all other cases.");
9222 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
9223 "*Maximum time between mouse clicks to make a double-click.\n\
9224 Measured in milliseconds. nil means disable double-click recognition;\n\
9225 t means double-clicks have no time limit and are detected\n\
9226 by position only.");
9227 Vdouble_click_time
= make_number (500);
9229 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
9230 "*Non-nil means inhibit local map menu bar menus.");
9231 inhibit_local_menu_bar_menus
= 0;
9233 DEFVAR_INT ("num-input-keys", &num_input_keys
,
9234 "Number of complete key sequences read as input so far.\n\
9235 This includes key sequences read from keyboard macros.\n\
9236 The number is effectively the number of interactive command invocations.");
9239 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
9240 "Number of input events read from the keyboard so far.\n\
9241 This does not include events generated by keyboard macros.");
9242 num_nonmacro_input_events
= 0;
9244 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
9245 "The frame in which the most recently read event occurred.\n\
9246 If the last event came from a keyboard macro, this is set to `macro'.");
9247 Vlast_event_frame
= Qnil
;
9249 /* This variable is set up in sysdep.c. */
9250 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
9251 "The ERASE character as set by the user with stty.");
9253 DEFVAR_LISP ("help-char", &Vhelp_char
,
9254 "Character to recognize as meaning Help.\n\
9255 When it is read, do `(eval help-form)', and display result if it's a string.\n\
9256 If the value of `help-form' is nil, this char can be read normally.");
9257 XSETINT (Vhelp_char
, Ctl ('H'));
9259 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
9260 "List of input events to recognize as meaning Help.\n\
9261 These work just like the value of `help-char' (see that).");
9262 Vhelp_event_list
= Qnil
;
9264 DEFVAR_LISP ("help-form", &Vhelp_form
,
9265 "Form to execute when character `help-char' is read.\n\
9266 If the form returns a string, that string is displayed.\n\
9267 If `help-form' is nil, the help char is not recognized.");
9270 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
9271 "Command to run when `help-char' character follows a prefix key.\n\
9272 This command is used only when there is no actual binding\n\
9273 for that character after that prefix key.");
9274 Vprefix_help_command
= Qnil
;
9276 DEFVAR_LISP ("top-level", &Vtop_level
,
9277 "Form to evaluate when Emacs starts up.\n\
9278 Useful to set before you dump a modified Emacs.");
9281 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
9282 "Translate table for keyboard input, or nil.\n\
9283 Each character is looked up in this string and the contents used instead.\n\
9284 The value may be a string, a vector, or a char-table.\n\
9285 If it is a string or vector of length N,\n\
9286 character codes N and up are untranslated.\n\
9287 In a vector or a char-table, an element which is nil means \"no translation\".");
9288 Vkeyboard_translate_table
= Qnil
;
9290 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
9291 "Non-nil means to always spawn a subshell instead of suspending.\n\
9292 \(Even if the operating system has support for stopping a process.\)");
9295 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
9296 "Non-nil means prompt with menus when appropriate.\n\
9297 This is done when reading from a keymap that has a prompt string,\n\
9298 for elements that have prompt strings.\n\
9299 The menu is displayed on the screen\n\
9300 if X menus were enabled at configuration\n\
9301 time and the previous event was a mouse click prefix key.\n\
9302 Otherwise, menu prompting uses the echo area.");
9305 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
9306 "Character to see next line of menu prompt.\n\
9307 Type this character while in a menu prompt to rotate around the lines of it.");
9308 XSETINT (menu_prompt_more_char
, ' ');
9310 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
9311 "A mask of additional modifier keys to use with every keyboard character.\n\
9312 Emacs applies the modifiers of the character stored here to each keyboard\n\
9313 character it reads. For example, after evaluating the expression\n\
9314 (setq extra-keyboard-modifiers ?\\C-x)\n\
9315 all input characters will have the control modifier applied to them.\n\
9317 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
9318 not count as a control character; rather, it counts as a character\n\
9319 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
9320 cancels any modification.");
9321 extra_keyboard_modifiers
= 0;
9323 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
9324 "If an editing command sets this to t, deactivate the mark afterward.\n\
9325 The command loop sets this to nil before each command,\n\
9326 and tests the value when the command returns.\n\
9327 Buffer modification stores t in this variable.");
9328 Vdeactivate_mark
= Qnil
;
9330 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
9331 "Temporary storage of pre-command-hook or post-command-hook.");
9332 Vcommand_hook_internal
= Qnil
;
9334 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
9335 "Normal hook run before each command is executed.\n\
9336 If an unhandled error happens in running this hook,\n\
9337 the hook value is set to nil, since otherwise the error\n\
9338 might happen repeatedly and make Emacs nonfunctional.");
9339 Vpre_command_hook
= Qnil
;
9341 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
9342 "Normal hook run after each command is executed.\n\
9343 If an unhandled error happens in running this hook,\n\
9344 the hook value is set to nil, since otherwise the error\n\
9345 might happen repeatedly and make Emacs nonfunctional.");
9346 Vpost_command_hook
= Qnil
;
9348 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
9349 "Normal hook run after each command is executed, if idle.\n\
9350 Errors running the hook are caught and ignored.\n\
9351 This feature is obsolete; use idle timers instead. See `etc/NEWS'.");
9352 Vpost_command_idle_hook
= Qnil
;
9354 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
9355 "Delay time before running `post-command-idle-hook'.\n\
9356 This is measured in microseconds.");
9357 post_command_idle_delay
= 100000;
9360 DEFVAR_LISP ("echo-area-clear-hook", ...,
9361 "Normal hook run when clearing the echo area.");
9363 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
9364 XSYMBOL (Qecho_area_clear_hook
)->value
= Qnil
;
9366 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
9367 "t means menu bar, specified Lucid style, needs to be recomputed.");
9368 Vlucid_menu_bar_dirty_flag
= Qnil
;
9370 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
9371 "List of menu bar items to move to the end of the menu bar.\n\
9372 The elements of the list are event types that may have menu bar bindings.");
9373 Vmenu_bar_final_items
= Qnil
;
9375 DEFVAR_KBOARD ("overriding-terminal-local-map",
9376 Voverriding_terminal_local_map
,
9377 "Per-terminal keymap that overrides all other local keymaps.\n\
9378 If this variable is non-nil, it is used as a keymap instead of the\n\
9379 buffer's local map, and the minor mode keymaps and text property keymaps.\n\
9380 This variable is intended to let commands such as `universal-argumemnt'\n\
9381 set up a different keymap for reading the next command.");
9383 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
9384 "Keymap that overrides all other local keymaps.\n\
9385 If this variable is non-nil, it is used as a keymap instead of the\n\
9386 buffer's local map, and the minor mode keymaps and text property keymaps.");
9387 Voverriding_local_map
= Qnil
;
9389 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
9390 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
9391 Otherwise, the menu bar continues to reflect the buffer's local map\n\
9392 and the minor mode maps regardless of `overriding-local-map'.");
9393 Voverriding_local_map_menu_flag
= Qnil
;
9395 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
9396 "Keymap defining bindings for special events to execute at low level.");
9397 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
9399 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
9400 "*Non-nil means generate motion events for mouse motion.");
9402 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
9403 "Alist of system-specific X windows key symbols.\n\
9404 Each element should have the form (N . SYMBOL) where N is the\n\
9405 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
9406 and SYMBOL is its name.");
9408 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
9409 "List of deferred actions to be performed at a later time.\n\
9410 The precise format isn't relevant here; we just check whether it is nil.");
9411 Vdeferred_action_list
= Qnil
;
9413 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
9414 "Function to call to handle deferred actions, after each command.\n\
9415 This function is called with no arguments after each command\n\
9416 whenever `deferred-action-list' is non-nil.");
9417 Vdeferred_action_function
= Qnil
;
9419 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
9420 "*Non-nil means show the equivalent key-binding when M-x command has one.\n\
9421 The value can be a length of time to show the message for.\n\
9422 If the value is non-nil and not a number, we wait 2 seconds.");
9423 Vsuggest_key_bindings
= Qt
;
9425 DEFVAR_LISP ("timer-list", &Vtimer_list
,
9426 "List of active absolute time timers in order of increasing time");
9429 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
9430 "List of active idle-time timers in order of increasing time");
9431 Vtimer_idle_list
= Qnil
;
9433 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
9434 "If non-nil, the function that implements the current input method.\n\
9435 It's called with one argument, a printing character that was just read.\n\
9436 \(That means a character with code 040...0176.)\n\
9437 Typically this function uses `read-event' to read additional events.\n\
9438 When it does so, it should first bind `input-method-function' to nil\n\
9439 so it will not be called recursively.\n\
9441 The function should return a list of zero or more events\n\
9442 to be used as input. If it wants to put back some events\n\
9443 to be reconsidered, separately, by the input method,\n\
9444 it can add them to the beginning of `unread-command-events'.\n\
9446 The input method function can find in `input-method-previous-method'\n\
9447 the previous echo area message.\n\
9449 The input method function should refer to the variables\n\
9450 `input-method-use-echo-area' and `input-method-exit-on-first-char'\n\
9451 for guidance on what to do.");
9452 Vinput_method_function
= Qnil
;
9454 DEFVAR_LISP ("input-method-previous-message",
9455 &Vinput_method_previous_message
,
9456 "When `input-method-function' is called, hold the previous echo area message.\n\
9457 This variable exists because `read-event' clears the echo area\n\
9458 before running the input method. It is nil if there was no message.");
9459 Vinput_method_previous_message
= Qnil
;
9465 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
9466 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
9467 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
9468 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
9469 initial_define_key (meta_map
, 'x', "execute-extended-command");
9471 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
9472 "handle-delete-frame");
9473 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
9475 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",