1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95,96,97,99, 2000, 2001
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
28 #include "termhooks.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
53 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
60 #include <sys/types.h>
65 /* This is to get the definitions of the XK_ symbols. */
72 #endif /* HAVE_NTGUI */
82 /* Variables for blockinput.h: */
84 /* Non-zero if interrupt input is blocked right now. */
85 int interrupt_input_blocked
;
87 /* Nonzero means an input interrupt has arrived
88 during the current critical section. */
89 int interrupt_input_pending
;
92 /* File descriptor to use for input. */
95 #ifdef HAVE_WINDOW_SYSTEM
96 /* Make all keyboard buffers much bigger when using X windows. */
98 /* But not too big (local data > 32K error) if on Mac OS Classic. */
99 #define KBD_BUFFER_SIZE 512
101 #define KBD_BUFFER_SIZE 4096
103 #else /* No X-windows, character input */
104 #define KBD_BUFFER_SIZE 4096
105 #endif /* No X-windows */
107 #define abs(x) ((x) >= 0 ? (x) : -(x))
109 /* Following definition copied from eval.c */
113 struct backtrace
*next
;
114 Lisp_Object
*function
;
115 Lisp_Object
*args
; /* Points to vector of args. */
116 int nargs
; /* length of vector. If nargs is UNEVALLED,
117 args points to slot holding list of
123 KBOARD
*initial_kboard
;
124 KBOARD
*current_kboard
;
128 KBOARD the_only_kboard
;
131 /* Non-nil disable property on a command means
132 do not execute it; call disabled-command-hook's value instead. */
133 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
135 #define NUM_RECENT_KEYS (100)
136 int recent_keys_index
; /* Index for storing next element into recent_keys */
137 int total_keys
; /* Total number of elements stored into recent_keys */
138 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
140 /* Vector holding the key sequence that invoked the current command.
141 It is reused for each command, and it may be longer than the current
142 sequence; this_command_key_count indicates how many elements
143 actually mean something.
144 It's easier to staticpro a single Lisp_Object than an array. */
145 Lisp_Object this_command_keys
;
146 int this_command_key_count
;
148 /* This vector is used as a buffer to record the events that were actually read
149 by read_key_sequence. */
150 Lisp_Object raw_keybuf
;
151 int raw_keybuf_count
;
153 #define GROW_RAW_KEYBUF \
154 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
156 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
158 new = Fmake_vector (make_number (newsize), Qnil); \
159 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
160 raw_keybuf_count * sizeof (Lisp_Object)); \
164 /* Number of elements of this_command_keys
165 that precede this key sequence. */
166 int this_single_command_key_start
;
168 /* Record values of this_command_key_count and echo_length ()
169 before this command was read. */
170 static int before_command_key_count
;
171 static int before_command_echo_length
;
172 /* Values of before_command_key_count and before_command_echo_length
173 saved by reset-this-command-lengths. */
174 static int before_command_key_count_1
;
175 static int before_command_echo_length_1
;
176 /* Flag set by reset-this-command-lengths,
177 saying to reset the lengths when add_command_key is called. */
178 static int before_command_restore_flag
;
180 extern int minbuf_level
;
182 extern int message_enable_multibyte
;
184 extern struct backtrace
*backtrace_list
;
186 /* If non-nil, the function that implements the display of help.
187 It's called with one argument, the help string to display. */
189 Lisp_Object Vshow_help_function
;
191 /* If a string, the message displayed before displaying a help-echo
194 Lisp_Object Vpre_help_message
;
196 /* Nonzero means do menu prompting. */
198 static int menu_prompting
;
200 /* Character to see next line of menu prompt. */
202 static Lisp_Object menu_prompt_more_char
;
204 /* For longjmp to where kbd input is being done. */
206 static jmp_buf getcjmp
;
208 /* True while doing kbd input. */
209 int waiting_for_input
;
211 /* True while displaying for echoing. Delays C-g throwing. */
215 /* Non-null means we can start echoing at the next input pause even
216 though there is something in the echo area. */
218 static struct kboard
*ok_to_echo_at_next_pause
;
220 /* The kboard last echoing, or null for none. Reset to 0 in
221 cancel_echoing. If non-null, and a current echo area message
222 exists, and echo_message_buffer is eq to the current message
223 buffer, we know that the message comes from echo_kboard. */
225 struct kboard
*echo_kboard
;
227 /* The buffer used for echoing. Set in echo_now, reset in
230 Lisp_Object echo_message_buffer
;
232 /* Nonzero means disregard local maps for the menu bar. */
233 static int inhibit_local_menu_bar_menus
;
235 /* Nonzero means C-g should cause immediate error-signal. */
238 /* The user's ERASE setting. */
239 Lisp_Object Vtty_erase_char
;
241 /* Character to recognize as the help char. */
242 Lisp_Object Vhelp_char
;
244 /* List of other event types to recognize as meaning "help". */
245 Lisp_Object Vhelp_event_list
;
247 /* Form to execute when help char is typed. */
248 Lisp_Object Vhelp_form
;
250 /* Command to run when the help character follows a prefix key. */
251 Lisp_Object Vprefix_help_command
;
253 /* List of items that should move to the end of the menu bar. */
254 Lisp_Object Vmenu_bar_final_items
;
256 /* Non-nil means show the equivalent key-binding for
257 any M-x command that has one.
258 The value can be a length of time to show the message for.
259 If the value is non-nil and not a number, we wait 2 seconds. */
260 Lisp_Object Vsuggest_key_bindings
;
262 /* How long to display an echo-area message when the minibuffer is active.
263 If the value is not a number, such messages don't time out. */
264 Lisp_Object Vminibuffer_message_timeout
;
266 /* Character that causes a quit. Normally C-g.
268 If we are running on an ordinary terminal, this must be an ordinary
269 ASCII char, since we want to make it our interrupt character.
271 If we are not running on an ordinary terminal, it still needs to be
272 an ordinary ASCII char. This character needs to be recognized in
273 the input interrupt handler. At this point, the keystroke is
274 represented as a struct input_event, while the desired quit
275 character is specified as a lispy event. The mapping from struct
276 input_events to lispy events cannot run in an interrupt handler,
277 and the reverse mapping is difficult for anything but ASCII
280 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
284 extern Lisp_Object current_global_map
;
285 extern int minibuf_level
;
287 /* If non-nil, this is a map that overrides all other local maps. */
288 Lisp_Object Voverriding_local_map
;
290 /* If non-nil, Voverriding_local_map applies to the menu bar. */
291 Lisp_Object Voverriding_local_map_menu_flag
;
293 /* Keymap that defines special misc events that should
294 be processed immediately at a low level. */
295 Lisp_Object Vspecial_event_map
;
297 /* Current depth in recursive edits. */
298 int command_loop_level
;
300 /* Total number of times command_loop has read a key sequence. */
301 EMACS_INT num_input_keys
;
303 /* Last input character read as a command. */
304 Lisp_Object last_command_char
;
306 /* Last input character read as a command, not counting menus
307 reached by the mouse. */
308 Lisp_Object last_nonmenu_event
;
310 /* Last input character read for any purpose. */
311 Lisp_Object last_input_char
;
313 /* If not Qnil, a list of objects to be read as subsequent command input. */
314 Lisp_Object Vunread_command_events
;
316 /* If not Qnil, a list of objects to be read as subsequent command input
317 including input method processing. */
318 Lisp_Object Vunread_input_method_events
;
320 /* If not Qnil, a list of objects to be read as subsequent command input
321 but NOT including input method processing. */
322 Lisp_Object Vunread_post_input_method_events
;
324 /* If not -1, an event to be read as subsequent command input. */
325 EMACS_INT unread_command_char
;
327 /* If not Qnil, this is a switch-frame event which we decided to put
328 off until the end of a key sequence. This should be read as the
329 next command input, after any unread_command_events.
331 read_key_sequence uses this to delay switch-frame events until the
332 end of the key sequence; Fread_char uses it to put off switch-frame
333 events until a non-ASCII event is acceptable as input. */
334 Lisp_Object unread_switch_frame
;
336 /* A mask of extra modifier bits to put into every keyboard char. */
337 EMACS_INT extra_keyboard_modifiers
;
339 /* Char to use as prefix when a meta character is typed in.
340 This is bound on entry to minibuffer in case ESC is changed there. */
342 Lisp_Object meta_prefix_char
;
344 /* Last size recorded for a current buffer which is not a minibuffer. */
345 static int last_non_minibuf_size
;
347 /* Number of idle seconds before an auto-save and garbage collection. */
348 static Lisp_Object Vauto_save_timeout
;
350 /* Total number of times read_char has returned. */
351 int num_input_events
;
353 /* Total number of times read_char has returned, outside of macros. */
354 EMACS_INT num_nonmacro_input_events
;
356 /* Auto-save automatically when this many characters have been typed
357 since the last time. */
359 static EMACS_INT auto_save_interval
;
361 /* Value of num_nonmacro_input_events as of last auto save. */
365 /* The command being executed by the command loop.
366 Commands may set this, and the value set will be copied into
367 current_kboard->Vlast_command instead of the actual command. */
368 Lisp_Object Vthis_command
;
370 /* This is like Vthis_command, except that commands never set it. */
371 Lisp_Object real_this_command
;
373 /* If the lookup of the command returns a binding, the original
374 command is stored in this-original-command. It is nil otherwise. */
375 Lisp_Object Vthis_original_command
;
377 /* The value of point when the last command was executed. */
378 int last_point_position
;
380 /* The buffer that was current when the last command was started. */
381 Lisp_Object last_point_position_buffer
;
383 /* The frame in which the last input event occurred, or Qmacro if the
384 last event came from a macro. We use this to determine when to
385 generate switch-frame events. This may be cleared by functions
386 like Fselect_frame, to make sure that a switch-frame event is
387 generated by the next character. */
388 Lisp_Object internal_last_event_frame
;
390 /* A user-visible version of the above, intended to allow users to
391 figure out where the last event came from, if the event doesn't
392 carry that information itself (i.e. if it was a character). */
393 Lisp_Object Vlast_event_frame
;
395 /* The timestamp of the last input event we received from the X server.
396 X Windows wants this for selection ownership. */
397 unsigned long last_event_timestamp
;
399 Lisp_Object Qself_insert_command
;
400 Lisp_Object Qforward_char
;
401 Lisp_Object Qbackward_char
;
402 Lisp_Object Qundefined
;
403 Lisp_Object Qtimer_event_handler
;
405 /* read_key_sequence stores here the command definition of the
406 key sequence that it reads. */
407 Lisp_Object read_key_sequence_cmd
;
409 /* Echo unfinished commands after this many seconds of pause. */
410 Lisp_Object Vecho_keystrokes
;
412 /* Form to evaluate (if non-nil) when Emacs is started. */
413 Lisp_Object Vtop_level
;
415 /* User-supplied string to translate input characters through. */
416 Lisp_Object Vkeyboard_translate_table
;
418 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
419 extern Lisp_Object Vfunction_key_map
;
421 /* Another keymap that maps key sequences into key sequences.
422 This one takes precedence over ordinary definitions. */
423 extern Lisp_Object Vkey_translation_map
;
425 /* If non-nil, this implements the current input method. */
426 Lisp_Object Vinput_method_function
;
427 Lisp_Object Qinput_method_function
;
429 /* When we call Vinput_method_function,
430 this holds the echo area message that was just erased. */
431 Lisp_Object Vinput_method_previous_message
;
433 /* Non-nil means deactivate the mark at end of this command. */
434 Lisp_Object Vdeactivate_mark
;
436 /* Menu bar specified in Lucid Emacs fashion. */
438 Lisp_Object Vlucid_menu_bar_dirty_flag
;
439 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
441 Lisp_Object Qecho_area_clear_hook
;
443 /* Hooks to run before and after each command. */
444 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
445 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
446 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
447 /* Hook run after a command if there's no more input soon. */
448 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
450 /* Delay time in microseconds before running post-command-idle-hook. */
451 EMACS_INT post_command_idle_delay
;
453 /* List of deferred actions to be performed at a later time.
454 The precise format isn't relevant here; we just check whether it is nil. */
455 Lisp_Object Vdeferred_action_list
;
457 /* Function to call to handle deferred actions, when there are any. */
458 Lisp_Object Vdeferred_action_function
;
459 Lisp_Object Qdeferred_action_function
;
461 Lisp_Object Qinput_method_exit_on_first_char
;
462 Lisp_Object Qinput_method_use_echo_area
;
464 /* File in which we write all commands we read. */
467 /* Nonzero if input is available. */
470 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
471 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
475 /* Non-zero means force key bindings update in parse_menu_item. */
477 int update_menu_bindings
;
479 extern char *pending_malloc_warning
;
481 /* Circular buffer for pre-read keyboard input. */
483 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
485 /* Vector to GCPRO the Lisp objects referenced from kbd_buffer.
487 The interrupt-level event handlers will never enqueue an event on a
488 frame which is not in Vframe_list, and once an event is dequeued,
489 internal_last_event_frame or the event itself points to the frame.
492 But while the event is sitting in the queue, it's completely
493 unprotected. Suppose the user types one command which will run for
494 a while and then delete a frame, and then types another event at
495 the frame that will be deleted, before the command gets around to
496 it. Suppose there are no references to this frame elsewhere in
497 Emacs, and a GC occurs before the second event is dequeued. Now we
498 have an event referring to a freed frame, which will crash Emacs
501 Similar things happen when an event on a scroll bar is enqueued; the
502 window may be deleted while the event is in the queue.
504 So, we use this vector to protect the Lisp_Objects in the event
505 queue. That way, they'll be dequeued as dead frames or windows,
506 but still valid Lisp objects.
508 If kbd_buffer[i].kind != NO_EVENT, then
510 AREF (kbd_buffer_gcpro, 2 * i) == kbd_buffer[i].frame_or_window.
511 AREF (kbd_buffer_gcpro, 2 * i + 1) == kbd_buffer[i].arg. */
513 static Lisp_Object kbd_buffer_gcpro
;
515 /* Pointer to next available character in kbd_buffer.
516 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
517 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
518 next available char is in kbd_buffer[0]. */
519 static struct input_event
*kbd_fetch_ptr
;
521 /* Pointer to next place to store character in kbd_buffer. This
522 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
523 character should go in kbd_buffer[0]. */
524 static struct input_event
* volatile kbd_store_ptr
;
526 /* The above pair of variables forms a "queue empty" flag. When we
527 enqueue a non-hook event, we increment kbd_store_ptr. When we
528 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
529 there is input available iff the two pointers are not equal.
531 Why not just have a flag set and cleared by the enqueuing and
532 dequeuing functions? Such a flag could be screwed up by interrupts
533 at inopportune times. */
535 /* If this flag is non-nil, we check mouse_moved to see when the
536 mouse moves, and motion events will appear in the input stream.
537 Otherwise, mouse motion is ignored. */
538 Lisp_Object do_mouse_tracking
;
540 /* Symbols to head events. */
541 Lisp_Object Qmouse_movement
;
542 Lisp_Object Qscroll_bar_movement
;
543 Lisp_Object Qswitch_frame
;
544 Lisp_Object Qdelete_frame
;
545 Lisp_Object Qiconify_frame
;
546 Lisp_Object Qmake_frame_visible
;
547 Lisp_Object Qselect_window
;
548 Lisp_Object Qhelp_echo
;
550 /* Symbols to denote kinds of events. */
551 Lisp_Object Qfunction_key
;
552 Lisp_Object Qmouse_click
;
554 Lisp_Object Qmouse_wheel
;
555 Lisp_Object Qlanguage_change
;
557 Lisp_Object Qdrag_n_drop
;
558 Lisp_Object Qsave_session
;
560 /* Lisp_Object Qmouse_movement; - also an event header */
562 /* Properties of event headers. */
563 Lisp_Object Qevent_kind
;
564 Lisp_Object Qevent_symbol_elements
;
566 /* menu item parts */
567 Lisp_Object Qmenu_alias
;
568 Lisp_Object Qmenu_enable
;
569 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
570 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
571 extern Lisp_Object Vdefine_key_rebound_commands
;
572 extern Lisp_Object Qmenu_item
;
574 /* An event header symbol HEAD may have a property named
575 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
576 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
577 mask of modifiers applied to it. If present, this is used to help
578 speed up parse_modifiers. */
579 Lisp_Object Qevent_symbol_element_mask
;
581 /* An unmodified event header BASE may have a property named
582 Qmodifier_cache, which is an alist mapping modifier masks onto
583 modified versions of BASE. If present, this helps speed up
585 Lisp_Object Qmodifier_cache
;
587 /* Symbols to use for parts of windows. */
588 Lisp_Object Qmode_line
;
589 Lisp_Object Qvertical_line
;
590 Lisp_Object Qvertical_scroll_bar
;
591 Lisp_Object Qmenu_bar
;
592 extern Lisp_Object Qleft_margin
, Qright_margin
;
594 Lisp_Object
recursive_edit_unwind (), command_loop ();
595 Lisp_Object
Fthis_command_keys ();
596 Lisp_Object Qextended_command_history
;
597 EMACS_TIME
timer_check ();
599 extern Lisp_Object Vhistory_length
;
601 extern char *x_get_keysym_name ();
603 static void record_menu_key ();
605 Lisp_Object Qpolling_period
;
607 /* List of absolute timers. Appears in order of next scheduled event. */
608 Lisp_Object Vtimer_list
;
610 /* List of idle time timers. Appears in order of next scheduled event. */
611 Lisp_Object Vtimer_idle_list
;
613 /* Incremented whenever a timer is run. */
616 extern Lisp_Object Vprint_level
, Vprint_length
;
618 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
620 EMACS_TIME
*input_available_clear_time
;
622 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
623 Default is 1 if INTERRUPT_INPUT is defined. */
626 /* Nonzero while interrupts are temporarily deferred during redisplay. */
627 int interrupts_deferred
;
629 /* Nonzero means use ^S/^Q for flow control. */
632 /* Allow m- file to inhibit use of FIONREAD. */
633 #ifdef BROKEN_FIONREAD
637 /* We are unable to use interrupts if FIONREAD is not available,
638 so flush SIGIO so we won't try. */
645 /* If we support a window system, turn on the code to poll periodically
646 to detect C-g. It isn't actually used when doing interrupt input. */
647 #ifdef HAVE_WINDOW_SYSTEM
648 #define POLL_FOR_INPUT
651 /* After a command is executed, if point is moved into a region that
652 has specific properties (e.g. composition, display), we adjust
653 point to the boundary of the region. But, if a command sets this
654 variable to non-nil, we suppress this point adjustment. This
655 variable is set to nil before reading a command. */
657 Lisp_Object Vdisable_point_adjustment
;
659 /* If non-nil, always disable point adjustment. */
661 Lisp_Object Vglobal_disable_point_adjustment
;
663 /* The time when Emacs started being idle. */
665 static EMACS_TIME timer_idleness_start_time
;
668 /* Global variable declarations. */
670 /* Function for init_keyboard to call with no args (if nonzero). */
671 void (*keyboard_init_hook
) ();
673 static int read_avail_input
P_ ((int));
674 static void get_input_pending
P_ ((int *, int));
675 static void get_filtered_input_pending
P_ ((int *, int, int));
676 static int readable_events
P_ ((int));
677 static int readable_filtered_events
P_ ((int, int));
678 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
679 Lisp_Object
, int *));
680 static Lisp_Object
read_char_x_menu_prompt ();
681 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
683 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
685 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
686 enum scroll_bar_part
,
687 Lisp_Object
, Lisp_Object
,
690 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
691 Lisp_Object
, char **,
692 Lisp_Object
*, unsigned));
693 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
694 static int parse_solitary_modifier
P_ ((Lisp_Object
));
695 static int parse_solitary_modifier ();
696 static void save_getcjmp
P_ ((jmp_buf));
697 static void save_getcjmp ();
698 static void restore_getcjmp
P_ ((jmp_buf));
699 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
700 static void clear_event
P_ ((struct input_event
*));
701 static void any_kboard_state
P_ ((void));
703 /* Nonzero means don't try to suspend even if the operating system seems
705 static int cannot_suspend
;
707 /* Install the string STR as the beginning of the string of echoing,
708 so that it serves as a prompt for the next character.
709 Also start echoing. */
715 current_kboard
->echo_string
= str
;
716 current_kboard
->echo_after_prompt
= SCHARS (str
);
720 /* Add C to the echo string, if echoing is going on.
721 C can be a character, which is printed prettily ("M-C-x" and all that
722 jazz), or a symbol, whose name is printed. */
728 if (current_kboard
->immediate_echo
)
730 int size
= KEY_DESCRIPTION_SIZE
+ 100;
731 char *buffer
= (char *) alloca (size
);
733 Lisp_Object echo_string
;
735 echo_string
= current_kboard
->echo_string
;
737 /* If someone has passed us a composite event, use its head symbol. */
742 ptr
= push_key_description (XINT (c
), ptr
, 1);
744 else if (SYMBOLP (c
))
746 struct Lisp_String
*name
= XSTRING (SYMBOL_NAME (c
));
747 int nbytes
= STRING_BYTES (name
);
749 if (size
- (ptr
- buffer
) < nbytes
)
751 int offset
= ptr
- buffer
;
752 size
= max (2 * size
, size
+ nbytes
);
753 buffer
= (char *) alloca (size
);
754 ptr
= buffer
+ offset
;
757 ptr
+= copy_text (name
->data
, ptr
, nbytes
,
758 name
->size_byte
>= 0, 1);
761 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
764 const char *text
= " (Type ? for further options)";
765 int len
= strlen (text
);
767 if (size
- (ptr
- buffer
) < len
)
769 int offset
= ptr
- buffer
;
771 buffer
= (char *) alloca (size
);
772 ptr
= buffer
+ offset
;
775 bcopy (text
, ptr
, len
);
779 /* Replace a dash from echo_dash with a space, otherwise
780 add a space at the end as a separator between keys. */
781 if (STRINGP (echo_string
)
782 && SCHARS (echo_string
) > 0)
784 Lisp_Object last_char
, idx
;
786 idx
= make_number (SCHARS (echo_string
) - 1);
787 last_char
= Faref (echo_string
, idx
);
789 if (XINT (last_char
) == '-')
790 Faset (echo_string
, idx
, make_number (' '));
792 echo_string
= concat2 (echo_string
, build_string (" "));
795 current_kboard
->echo_string
796 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
802 /* Temporarily add a dash to the end of the echo string if it's not
803 empty, so that it serves as a mini-prompt for the very next character. */
808 /* Do nothing if not echoing at all. */
809 if (NILP (current_kboard
->echo_string
))
812 if (!current_kboard
->immediate_echo
813 && SCHARS (current_kboard
->echo_string
) == 0)
816 /* Do nothing if we just printed a prompt. */
817 if (current_kboard
->echo_after_prompt
818 == SCHARS (current_kboard
->echo_string
))
821 /* Put a dash at the end of the buffer temporarily,
822 but make it go away when the next character is added. */
823 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
828 /* Display the current echo string, and begin echoing if not already
834 if (!current_kboard
->immediate_echo
)
837 current_kboard
->immediate_echo
= 1;
839 for (i
= 0; i
< this_command_key_count
; i
++)
842 c
= XVECTOR (this_command_keys
)->contents
[i
];
843 if (! (EVENT_HAS_PARAMETERS (c
)
844 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
851 message3_nolog (current_kboard
->echo_string
,
852 SBYTES (current_kboard
->echo_string
),
853 SMBP (current_kboard
->echo_string
));
856 /* Record in what buffer we echoed, and from which kboard. */
857 echo_message_buffer
= echo_area_buffer
[0];
858 echo_kboard
= current_kboard
;
860 if (waiting_for_input
&& !NILP (Vquit_flag
))
861 quit_throw_to_read_char ();
864 /* Turn off echoing, for the start of a new command. */
869 current_kboard
->immediate_echo
= 0;
870 current_kboard
->echo_after_prompt
= -1;
871 current_kboard
->echo_string
= Qnil
;
872 ok_to_echo_at_next_pause
= NULL
;
874 echo_message_buffer
= Qnil
;
877 /* Return the length of the current echo string. */
882 return (STRINGP (current_kboard
->echo_string
)
883 ? SCHARS (current_kboard
->echo_string
)
887 /* Truncate the current echo message to its first LEN chars.
888 This and echo_char get used by read_key_sequence when the user
889 switches frames while entering a key sequence. */
892 echo_truncate (nchars
)
895 if (STRINGP (current_kboard
->echo_string
))
896 current_kboard
->echo_string
897 = Fsubstring (current_kboard
->echo_string
,
898 make_number (0), make_number (nchars
));
899 truncate_echo_area (nchars
);
903 /* Functions for manipulating this_command_keys. */
905 add_command_key (key
)
908 /* If reset-this-command-length was called recently, obey it now.
909 See the doc string of that function for an explanation of why. */
910 if (before_command_restore_flag
)
912 this_command_key_count
= before_command_key_count_1
;
913 if (this_command_key_count
< this_single_command_key_start
)
914 this_single_command_key_start
= this_command_key_count
;
915 echo_truncate (before_command_echo_length_1
);
916 before_command_restore_flag
= 0;
919 if (this_command_key_count
>= ASIZE (this_command_keys
))
920 this_command_keys
= larger_vector (this_command_keys
,
921 2 * ASIZE (this_command_keys
),
924 AREF (this_command_keys
, this_command_key_count
) = key
;
925 ++this_command_key_count
;
932 int count
= specpdl_ptr
- specpdl
;
935 if (command_loop_level
> 0)
937 specbind (Qstandard_output
, Qt
);
938 specbind (Qstandard_input
, Qt
);
941 #ifdef HAVE_X_WINDOWS
942 /* The command loop has started an hourglass timer, so we have to
943 cancel it here, otherwise it will fire because the recursive edit
944 can take some time. Do not check for display_hourglass_p here,
945 because it could already be nil. */
949 /* This function may have been called from a debugger called from
950 within redisplay, for instance by Edebugging a function called
951 from fontification-functions. We want to allow redisplay in
952 the debugging session.
954 The recursive edit is left with a `(throw exit ...)'. The `exit'
955 tag is not caught anywhere in redisplay, i.e. when we leave the
956 recursive edit, the original redisplay leading to the recursive
957 edit will be unwound. The outcome should therefore be safe. */
958 specbind (Qinhibit_redisplay
, Qnil
);
961 val
= command_loop ();
963 Fsignal (Qquit
, Qnil
);
964 /* Handle throw from read_minibuf when using minibuffer
965 while it's active but we're in another window. */
967 Fsignal (Qerror
, Fcons (val
, Qnil
));
969 return unbind_to (count
, Qnil
);
972 /* When an auto-save happens, record the "time", and don't do again soon. */
977 last_auto_save
= num_nonmacro_input_events
;
980 /* Make an auto save happen as soon as possible at command level. */
983 force_auto_save_soon ()
985 last_auto_save
= - auto_save_interval
- 1;
987 record_asynch_buffer_change ();
990 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
991 doc
: /* Invoke the editor command loop recursively.
992 To get out of the recursive edit, a command can do `(throw 'exit nil)';
993 that tells this function to return.
994 Alternately, `(throw 'exit t)' makes this function signal an error.
995 This function is called by the editor initialization to begin editing. */)
998 int count
= specpdl_ptr
- specpdl
;
1001 command_loop_level
++;
1002 update_mode_lines
= 1;
1004 if (command_loop_level
1005 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1006 buffer
= Fcurrent_buffer ();
1010 /* If we leave recursive_edit_1 below with a `throw' for instance,
1011 like it is done in the splash screen display, we have to
1012 make sure that we restore single_kboard as command_loop_1
1013 would have done if it were left normally. */
1014 record_unwind_protect (recursive_edit_unwind
,
1015 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1017 recursive_edit_1 ();
1018 return unbind_to (count
, Qnil
);
1022 recursive_edit_unwind (info
)
1025 if (BUFFERP (XCAR (info
)))
1026 Fset_buffer (XCAR (info
));
1028 if (NILP (XCDR (info
)))
1029 any_kboard_state ();
1031 single_kboard_state ();
1033 command_loop_level
--;
1034 update_mode_lines
= 1;
1043 #if 0 /* Theory: if there's anything in Vunread_command_events,
1044 it will right away be read by read_key_sequence,
1045 and then if we do switch KBOARDS, it will go into the side
1046 queue then. So we don't need to do anything special here -- rms. */
1047 if (CONSP (Vunread_command_events
))
1049 current_kboard
->kbd_queue
1050 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1051 current_kboard
->kbd_queue_has_data
= 1;
1053 Vunread_command_events
= Qnil
;
1059 /* Switch to the single-kboard state, making current_kboard
1060 the only KBOARD from which further input is accepted. */
1063 single_kboard_state ()
1070 /* Maintain a stack of kboards, so other parts of Emacs
1071 can switch temporarily to the kboard of a given frame
1072 and then revert to the previous status. */
1077 struct kboard_stack
*next
;
1080 static struct kboard_stack
*kboard_stack
;
1083 push_frame_kboard (f
)
1087 struct kboard_stack
*p
1088 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1090 p
->next
= kboard_stack
;
1091 p
->kboard
= current_kboard
;
1094 current_kboard
= FRAME_KBOARD (f
);
1102 struct kboard_stack
*p
= kboard_stack
;
1103 current_kboard
= p
->kboard
;
1104 kboard_stack
= p
->next
;
1109 /* Handle errors that are not handled at inner levels
1110 by printing an error message and returning to the editor command loop. */
1116 Lisp_Object old_level
, old_length
;
1117 char macroerror
[50];
1119 if (!NILP (executing_macro
))
1121 if (executing_macro_iterations
== 1)
1122 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1124 sprintf (macroerror
, "After %d kbd macro iterations: ",
1125 executing_macro_iterations
);
1130 Vstandard_output
= Qt
;
1131 Vstandard_input
= Qt
;
1132 Vexecuting_macro
= Qnil
;
1133 executing_macro
= Qnil
;
1134 current_kboard
->Vprefix_arg
= Qnil
;
1135 current_kboard
->Vlast_prefix_arg
= Qnil
;
1138 /* Avoid unquittable loop if data contains a circular list. */
1139 old_level
= Vprint_level
;
1140 old_length
= Vprint_length
;
1141 XSETFASTINT (Vprint_level
, 10);
1142 XSETFASTINT (Vprint_length
, 10);
1143 cmd_error_internal (data
, macroerror
);
1144 Vprint_level
= old_level
;
1145 Vprint_length
= old_length
;
1149 Vinhibit_quit
= Qnil
;
1151 any_kboard_state ();
1154 return make_number (0);
1157 /* Take actions on handling an error. DATA is the data that describes
1160 CONTEXT is a C-string containing ASCII characters only which
1161 describes the context in which the error happened. If we need to
1162 generalize CONTEXT to allow multibyte characters, make it a Lisp
1166 cmd_error_internal (data
, context
)
1171 int kill_emacs_p
= 0;
1172 struct frame
*sf
= SELECTED_FRAME ();
1176 clear_message (1, 0);
1178 /* If the window system or terminal frame hasn't been initialized
1179 yet, or we're not interactive, it's best to dump this message out
1180 to stderr and exit. */
1181 if (!sf
->glyphs_initialized_p
1182 /* This is the case of the frame dumped with Emacs, when we're
1183 running under a window system. */
1184 || (!NILP (Vwindow_system
)
1185 && !inhibit_window_system
1186 && FRAME_TERMCAP_P (sf
))
1189 stream
= Qexternal_debugging_output
;
1200 write_string_1 (context
, -1, stream
);
1202 print_error_message (data
, stream
);
1204 /* If the window system or terminal frame hasn't been initialized
1205 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1209 Fkill_emacs (make_number (-1));
1213 Lisp_Object
command_loop_1 ();
1214 Lisp_Object
command_loop_2 ();
1215 Lisp_Object
top_level_1 ();
1217 /* Entry to editor-command-loop.
1218 This level has the catches for exiting/returning to editor command loop.
1219 It returns nil to exit recursive edit, t to abort it. */
1224 if (command_loop_level
> 0 || minibuf_level
> 0)
1227 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1228 executing_macro
= Qnil
;
1234 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1235 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1236 executing_macro
= Qnil
;
1238 /* End of file in -batch run causes exit here. */
1244 /* Here we catch errors in execution of commands within the
1245 editing loop, and reenter the editing loop.
1246 When there is an error, cmd_error runs and returns a non-nil
1247 value to us. A value of nil means that command_loop_1 itself
1248 returned due to end of file (or end of kbd macro). */
1253 register Lisp_Object val
;
1256 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1257 while (!NILP (val
));
1265 return Feval (Vtop_level
);
1271 /* On entry to the outer level, run the startup file */
1272 if (!NILP (Vtop_level
))
1273 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1274 else if (!NILP (Vpurify_flag
))
1275 message ("Bare impure Emacs (standard Lisp code not loaded)");
1277 message ("Bare Emacs (standard Lisp code not loaded)");
1281 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1282 doc
: /* Exit all recursive editing levels. */)
1285 #ifdef HAVE_X_WINDOWS
1286 if (display_hourglass_p
)
1287 cancel_hourglass ();
1289 return Fthrow (Qtop_level
, Qnil
);
1292 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1293 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1296 if (command_loop_level
> 0 || minibuf_level
> 0)
1297 Fthrow (Qexit
, Qnil
);
1299 error ("No recursive edit is in progress");
1303 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1304 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1307 if (command_loop_level
> 0 || minibuf_level
> 0)
1310 error ("No recursive edit is in progress");
1314 /* This is the actual command reading loop,
1315 sans error-handling encapsulation. */
1317 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1319 void safe_run_hooks
P_ ((Lisp_Object
));
1320 static void adjust_point_for_property
P_ ((int));
1328 Lisp_Object keybuf
[30];
1332 struct buffer
*prev_buffer
= NULL
;
1334 int was_locked
= single_kboard
;
1337 current_kboard
->Vprefix_arg
= Qnil
;
1338 current_kboard
->Vlast_prefix_arg
= Qnil
;
1339 Vdeactivate_mark
= Qnil
;
1340 waiting_for_input
= 0;
1344 this_command_key_count
= 0;
1345 this_single_command_key_start
= 0;
1347 /* Make sure this hook runs after commands that get errors and
1348 throw to top level. */
1349 /* Note that the value cell will never directly contain nil
1350 if the symbol is a local variable. */
1351 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1352 safe_run_hooks (Qpost_command_hook
);
1354 /* If displaying a message, resize the echo area window to fit
1355 that message's size exactly. */
1356 if (!NILP (echo_area_buffer
[0]))
1357 resize_echo_area_exactly ();
1359 if (!NILP (Vdeferred_action_list
))
1360 call0 (Vdeferred_action_function
);
1362 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1364 if (NILP (Vunread_command_events
)
1365 && NILP (Vunread_input_method_events
)
1366 && NILP (Vunread_post_input_method_events
)
1367 && NILP (Vexecuting_macro
)
1368 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1369 safe_run_hooks (Qpost_command_idle_hook
);
1372 /* Do this after running Vpost_command_hook, for consistency. */
1373 current_kboard
->Vlast_command
= Vthis_command
;
1374 current_kboard
->Vreal_last_command
= real_this_command
;
1378 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1381 /* Make sure the current window's buffer is selected. */
1382 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1383 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1385 /* Display any malloc warning that just came out. Use while because
1386 displaying one warning can cause another. */
1388 while (pending_malloc_warning
)
1389 display_malloc_warning ();
1393 Vdeactivate_mark
= Qnil
;
1395 /* If minibuffer on and echo area in use,
1396 wait a short time and redraw minibuffer. */
1399 && !NILP (echo_area_buffer
[0])
1400 && EQ (minibuf_window
, echo_area_window
)
1401 && NUMBERP (Vminibuffer_message_timeout
))
1403 /* Bind inhibit-quit to t so that C-g gets read in
1404 rather than quitting back to the minibuffer. */
1405 int count
= specpdl_ptr
- specpdl
;
1406 specbind (Qinhibit_quit
, Qt
);
1408 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1409 /* Clear the echo area. */
1411 safe_run_hooks (Qecho_area_clear_hook
);
1413 unbind_to (count
, Qnil
);
1415 /* If a C-g came in before, treat it as input now. */
1416 if (!NILP (Vquit_flag
))
1419 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1424 alloca (0); /* Cause a garbage collection now */
1425 /* Since we can free the most stuff here. */
1426 #endif /* C_ALLOCA */
1429 /* Select the frame that the last event came from. Usually,
1430 switch-frame events will take care of this, but if some lisp
1431 code swallows a switch-frame event, we'll fix things up here.
1432 Is this a good idea? */
1433 if (FRAMEP (internal_last_event_frame
)
1434 && !EQ (internal_last_event_frame
, selected_frame
))
1435 Fselect_frame (internal_last_event_frame
, Qnil
);
1437 /* If it has changed current-menubar from previous value,
1438 really recompute the menubar from the value. */
1439 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1440 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1441 call0 (Qrecompute_lucid_menubar
);
1443 before_command_key_count
= this_command_key_count
;
1444 before_command_echo_length
= echo_length ();
1446 Vthis_command
= Qnil
;
1447 real_this_command
= Qnil
;
1449 /* Read next key sequence; i gets its length. */
1450 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1453 /* A filter may have run while we were reading the input. */
1454 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1456 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1457 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1461 /* Now we have read a key sequence of length I,
1462 or else I is 0 and we found end of file. */
1464 if (i
== 0) /* End of file -- happens only in */
1465 return Qnil
; /* a kbd macro, at the end. */
1466 /* -1 means read_key_sequence got a menu that was rejected.
1467 Just loop around and read another command. */
1471 this_command_key_count
= 0;
1472 this_single_command_key_start
= 0;
1476 last_command_char
= keybuf
[i
- 1];
1478 /* If the previous command tried to force a specific window-start,
1479 forget about that, in case this command moves point far away
1480 from that position. But also throw away beg_unchanged and
1481 end_unchanged information in that case, so that redisplay will
1482 update the whole window properly. */
1483 if (!NILP (XWINDOW (selected_window
)->force_start
))
1486 XWINDOW (selected_window
)->force_start
= Qnil
;
1487 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1488 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1491 cmd
= read_key_sequence_cmd
;
1492 if (!NILP (Vexecuting_macro
))
1494 if (!NILP (Vquit_flag
))
1496 Vexecuting_macro
= Qt
;
1497 QUIT
; /* Make some noise. */
1498 /* Will return since macro now empty. */
1502 /* Do redisplay processing after this command except in special
1503 cases identified below. */
1504 prev_buffer
= current_buffer
;
1505 prev_modiff
= MODIFF
;
1506 last_point_position
= PT
;
1507 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1509 /* By default, we adjust point to a boundary of a region that
1510 has such a property that should be treated intangible
1511 (e.g. composition, display). But, some commands will set
1512 this variable differently. */
1513 Vdisable_point_adjustment
= Qnil
;
1515 /* Process filters and timers may have messed with deactivate-mark.
1516 reset it before we execute the command. */
1517 Vdeactivate_mark
= Qnil
;
1519 /* Remap command through active keymaps */
1520 Vthis_original_command
= cmd
;
1524 if (cmd1
= Fremap_command (cmd
), !NILP (cmd1
))
1528 /* Execute the command. */
1530 Vthis_command
= cmd
;
1531 real_this_command
= cmd
;
1532 /* Note that the value cell will never directly contain nil
1533 if the symbol is a local variable. */
1534 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1535 safe_run_hooks (Qpre_command_hook
);
1537 if (NILP (Vthis_command
))
1539 /* nil means key is undefined. */
1541 current_kboard
->defining_kbd_macro
= Qnil
;
1542 update_mode_lines
= 1;
1543 current_kboard
->Vprefix_arg
= Qnil
;
1547 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1549 /* In case we jump to directly_done. */
1550 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1552 /* Recognize some common commands in common situations and
1553 do them directly. */
1554 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1556 struct Lisp_Char_Table
*dp
1557 = window_display_table (XWINDOW (selected_window
));
1558 lose
= FETCH_CHAR (PT_BYTE
);
1561 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1562 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1563 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1564 && (lose
>= 0x20 && lose
< 0x7f)))
1565 : (lose
>= 0x20 && lose
< 0x7f))
1566 /* To extract the case of continuation on
1567 wide-column characters. */
1568 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1569 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1571 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1573 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1575 && !windows_or_buffers_changed
1576 && EQ (current_buffer
->selective_display
, Qnil
)
1577 && !detect_input_pending ()
1578 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1579 && NILP (Vexecuting_macro
))
1580 direct_output_forward_char (1);
1583 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1585 struct Lisp_Char_Table
*dp
1586 = window_display_table (XWINDOW (selected_window
));
1588 lose
= FETCH_CHAR (PT_BYTE
);
1590 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1591 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1592 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1593 && (lose
>= 0x20 && lose
< 0x7f)))
1594 : (lose
>= 0x20 && lose
< 0x7f))
1595 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1597 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1599 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1601 && !windows_or_buffers_changed
1602 && EQ (current_buffer
->selective_display
, Qnil
)
1603 && !detect_input_pending ()
1604 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1605 && NILP (Vexecuting_macro
))
1606 direct_output_forward_char (-1);
1609 else if (EQ (Vthis_command
, Qself_insert_command
)
1610 /* Try this optimization only on ascii keystrokes. */
1611 && INTEGERP (last_command_char
))
1613 unsigned int c
= XINT (last_command_char
);
1615 if (NILP (Vexecuting_macro
)
1616 && !EQ (minibuf_window
, selected_window
))
1618 if (!nonundocount
|| nonundocount
>= 20)
1626 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1628 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1630 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1632 || MODIFF
<= SAVE_MODIFF
1633 || windows_or_buffers_changed
1634 || !EQ (current_buffer
->selective_display
, Qnil
)
1635 || detect_input_pending ()
1636 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1637 || !NILP (Vexecuting_macro
));
1639 value
= internal_self_insert (c
, 0);
1644 /* VALUE == 1 when AFTER-CHANGE functions are
1645 installed which is the case most of the time
1646 because FONT-LOCK installs one. */
1647 if (!lose
&& !value
)
1648 direct_output_for_insert (c
);
1653 /* Here for a command that isn't executed directly */
1655 #ifdef HAVE_X_WINDOWS
1656 if (display_hourglass_p
1657 && NILP (Vexecuting_macro
))
1662 if (NILP (current_kboard
->Vprefix_arg
))
1664 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1666 #ifdef HAVE_X_WINDOWS
1667 /* Do not check display_hourglass_p here, because
1668 Fcommand_execute could change it, but we should cancel
1669 hourglass cursor anyway.
1670 But don't cancel the hourglass within a macro
1671 just because a command in the macro finishes. */
1672 if (NILP (Vexecuting_macro
))
1673 cancel_hourglass ();
1677 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1679 /* Note that the value cell will never directly contain nil
1680 if the symbol is a local variable. */
1681 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1682 safe_run_hooks (Qpost_command_hook
);
1684 /* If displaying a message, resize the echo area window to fit
1685 that message's size exactly. */
1686 if (!NILP (echo_area_buffer
[0]))
1687 resize_echo_area_exactly ();
1689 if (!NILP (Vdeferred_action_list
))
1690 safe_run_hooks (Qdeferred_action_function
);
1692 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1694 if (NILP (Vunread_command_events
)
1695 && NILP (Vunread_input_method_events
)
1696 && NILP (Vunread_post_input_method_events
)
1697 && NILP (Vexecuting_macro
)
1698 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1699 safe_run_hooks (Qpost_command_idle_hook
);
1702 /* If there is a prefix argument,
1703 1) We don't want Vlast_command to be ``universal-argument''
1704 (that would be dumb), so don't set Vlast_command,
1705 2) we want to leave echoing on so that the prefix will be
1706 echoed as part of this key sequence, so don't call
1708 3) we want to leave this_command_key_count non-zero, so that
1709 read_char will realize that it is re-reading a character, and
1710 not echo it a second time.
1712 If the command didn't actually create a prefix arg,
1713 but is merely a frame event that is transparent to prefix args,
1714 then the above doesn't apply. */
1715 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1717 current_kboard
->Vlast_command
= Vthis_command
;
1718 current_kboard
->Vreal_last_command
= real_this_command
;
1720 this_command_key_count
= 0;
1721 this_single_command_key_start
= 0;
1724 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1726 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1728 /* We could also call `deactivate'mark'. */
1729 if (EQ (Vtransient_mark_mode
, Qlambda
))
1730 Vtransient_mark_mode
= Qnil
;
1733 current_buffer
->mark_active
= Qnil
;
1734 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1737 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1738 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1743 if (current_buffer
== prev_buffer
1744 && last_point_position
!= PT
1745 && NILP (Vdisable_point_adjustment
)
1746 && NILP (Vglobal_disable_point_adjustment
))
1747 adjust_point_for_property (last_point_position
);
1749 /* Install chars successfully executed in kbd macro. */
1751 if (!NILP (current_kboard
->defining_kbd_macro
)
1752 && NILP (current_kboard
->Vprefix_arg
))
1753 finalize_kbd_macro_chars ();
1757 any_kboard_state ();
1762 extern Lisp_Object Qcomposition
, Qdisplay
;
1764 /* Adjust point to a boundary of a region that has such a property
1765 that should be treated intangible. For the moment, we check
1766 `composition' and `display' property. LAST_PT is the last position
1770 adjust_point_for_property (last_pt
)
1775 int check_composition
= 1, check_display
= 1;
1777 while (check_composition
|| check_display
)
1779 if (check_composition
1780 && PT
> BEGV
&& PT
< ZV
1781 && get_property_and_range (PT
, Qcomposition
, &val
, &start
, &end
, Qnil
)
1782 && COMPOSITION_VALID_P (start
, end
, val
)
1783 && start
< PT
&& end
> PT
1784 && (last_pt
<= start
|| last_pt
>= end
))
1792 check_composition
= 0;
1794 && PT
> BEGV
&& PT
< ZV
1795 && get_property_and_range (PT
, Qdisplay
, &val
, &start
, &end
, Qnil
)
1796 && display_prop_intangible_p (val
)
1797 && start
< PT
&& end
> PT
1798 && (last_pt
<= start
|| last_pt
>= end
))
1804 check_composition
= 1;
1810 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1813 safe_run_hooks_1 (hook
)
1816 return call1 (Vrun_hooks
, Vinhibit_quit
);
1819 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1822 safe_run_hooks_error (data
)
1825 return Fset (Vinhibit_quit
, Qnil
);
1828 /* If we get an error while running the hook, cause the hook variable
1829 to be nil. Also inhibit quits, so that C-g won't cause the hook
1830 to mysteriously evaporate. */
1833 safe_run_hooks (hook
)
1836 int count
= specpdl_ptr
- specpdl
;
1837 specbind (Qinhibit_quit
, hook
);
1839 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1841 unbind_to (count
, Qnil
);
1845 /* Number of seconds between polling for input. This is a Lisp
1846 variable that can be bound. */
1848 EMACS_INT polling_period
;
1850 /* Nonzero means polling for input is temporarily suppressed. */
1852 int poll_suppress_count
;
1854 /* Asynchronous timer for polling. */
1856 struct atimer
*poll_timer
;
1859 #ifdef POLL_FOR_INPUT
1861 /* Poll for input, so what we catch a C-g if it comes in. This
1862 function is called from x_make_frame_visible, see comment
1868 if (interrupt_input_blocked
== 0
1869 && !waiting_for_input
)
1870 read_avail_input (0);
1873 /* Timer callback function for poll_timer. TIMER is equal to
1877 poll_for_input (timer
)
1878 struct atimer
*timer
;
1880 if (poll_suppress_count
== 0)
1881 poll_for_input_1 ();
1884 #endif /* POLL_FOR_INPUT */
1886 /* Begin signals to poll for input, if they are appropriate.
1887 This function is called unconditionally from various places. */
1892 #ifdef POLL_FOR_INPUT
1893 if (read_socket_hook
&& !interrupt_input
)
1895 /* Turn alarm handling on unconditionally. It might have
1896 been turned off in process.c. */
1897 turn_on_atimers (1);
1899 /* If poll timer doesn't exist, are we need one with
1900 a different interval, start a new one. */
1901 if (poll_timer
== NULL
1902 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
1904 EMACS_TIME interval
;
1907 cancel_atimer (poll_timer
);
1909 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
1910 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1911 poll_for_input
, NULL
);
1914 /* Let the timer's callback function poll for input
1915 if this becomes zero. */
1916 --poll_suppress_count
;
1921 /* Nonzero if we are using polling to handle input asynchronously. */
1924 input_polling_used ()
1926 #ifdef POLL_FOR_INPUT
1927 return read_socket_hook
&& !interrupt_input
;
1933 /* Turn off polling. */
1938 #ifdef POLL_FOR_INPUT
1939 if (read_socket_hook
&& !interrupt_input
)
1940 ++poll_suppress_count
;
1944 /* Set the value of poll_suppress_count to COUNT
1945 and start or stop polling accordingly. */
1948 set_poll_suppress_count (count
)
1951 #ifdef POLL_FOR_INPUT
1952 if (count
== 0 && poll_suppress_count
!= 0)
1954 poll_suppress_count
= 1;
1957 else if (count
!= 0 && poll_suppress_count
== 0)
1961 poll_suppress_count
= count
;
1965 /* Bind polling_period to a value at least N.
1966 But don't decrease it. */
1969 bind_polling_period (n
)
1972 #ifdef POLL_FOR_INPUT
1973 int new = polling_period
;
1978 stop_other_atimers (poll_timer
);
1980 specbind (Qpolling_period
, make_number (new));
1981 /* Start a new alarm with the new period. */
1986 /* Apply the control modifier to CHARACTER. */
1992 /* Save the upper bits here. */
1993 int upper
= c
& ~0177;
1997 /* Everything in the columns containing the upper-case letters
1998 denotes a control character. */
1999 if (c
>= 0100 && c
< 0140)
2003 /* Set the shift modifier for a control char
2004 made from a shifted letter. But only for letters! */
2005 if (oc
>= 'A' && oc
<= 'Z')
2006 c
|= shift_modifier
;
2009 /* The lower-case letters denote control characters too. */
2010 else if (c
>= 'a' && c
<= 'z')
2013 /* Include the bits for control and shift
2014 only if the basic ASCII code can't indicate them. */
2018 /* Replace the high bits. */
2019 c
|= (upper
& ~ctrl_modifier
);
2024 /* Display help echo in the echo area.
2026 HELP a string means display that string, HELP nil means clear the
2027 help echo. If HELP is a function, call it with OBJECT and POS as
2028 arguments; the function should return a help string or nil for
2029 none. For all other types of HELP evaluate it to obtain a string.
2031 WINDOW is the window in which the help was generated, if any.
2032 It is nil if not in a window.
2034 If OBJECT is a buffer, POS is the position in the buffer where the
2035 `help-echo' text property was found.
2037 If OBJECT is an overlay, that overlay has a `help-echo' property,
2038 and POS is the position in the overlay's buffer under the mouse.
2040 If OBJECT is a string (an overlay string or a string displayed with
2041 the `display' property). POS is the position in that string under
2044 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2045 echo overwrites a keystroke echo currently displayed in the echo
2048 Note: this function may only be called with HELP nil or a string
2049 from X code running asynchronously. */
2052 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2053 Lisp_Object help
, window
, object
, pos
;
2054 int ok_to_overwrite_keystroke_echo
;
2056 if (!NILP (help
) && !STRINGP (help
))
2058 if (FUNCTIONP (help
))
2060 Lisp_Object args
[4];
2065 help
= safe_call (4, args
);
2068 help
= safe_eval (help
);
2070 if (!STRINGP (help
))
2074 if (STRINGP (help
) || NILP (help
))
2076 if (!NILP (Vshow_help_function
))
2077 call1 (Vshow_help_function
, help
);
2078 else if (/* Don't overwrite minibuffer contents. */
2079 !MINI_WINDOW_P (XWINDOW (selected_window
))
2080 /* Don't overwrite a keystroke echo. */
2081 && (NILP (echo_message_buffer
)
2082 || ok_to_overwrite_keystroke_echo
)
2083 /* Don't overwrite a prompt. */
2084 && !cursor_in_echo_area
)
2088 int count
= BINDING_STACK_SIZE ();
2090 if (!help_echo_showing_p
)
2091 Vpre_help_message
= current_message ();
2093 specbind (Qmessage_truncate_lines
, Qt
);
2094 message3_nolog (help
, STRING_BYTES (XSTRING (help
)),
2095 STRING_MULTIBYTE (help
));
2096 unbind_to (count
, Qnil
);
2098 else if (STRINGP (Vpre_help_message
))
2100 message3_nolog (Vpre_help_message
,
2101 STRING_BYTES (XSTRING (Vpre_help_message
)),
2102 STRING_MULTIBYTE (Vpre_help_message
));
2103 Vpre_help_message
= Qnil
;
2109 help_echo_showing_p
= STRINGP (help
);
2115 /* Input of single characters from keyboard */
2117 Lisp_Object
print_help ();
2118 static Lisp_Object
kbd_buffer_get_event ();
2119 static void record_char ();
2122 static jmp_buf wrong_kboard_jmpbuf
;
2125 /* read a character from the keyboard; call the redisplay if needed */
2126 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2127 -1 means do not do redisplay, but do do autosaving.
2130 /* The arguments MAPS and NMAPS are for menu prompting.
2131 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2133 PREV_EVENT is the previous input event, or nil if we are reading
2134 the first event of a key sequence (or not reading a key sequence).
2135 If PREV_EVENT is t, that is a "magic" value that says
2136 not to run input methods, but in other respects to act as if
2137 not reading a key sequence.
2139 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2140 if we used a mouse menu to read the input, or zero otherwise. If
2141 USED_MOUSE_MENU is null, we don't dereference it.
2143 Value is t if we showed a menu and the user rejected it. */
2146 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2150 Lisp_Object prev_event
;
2151 int *used_mouse_menu
;
2153 volatile Lisp_Object c
;
2155 jmp_buf local_getcjmp
;
2157 volatile int key_already_recorded
= 0;
2158 Lisp_Object tem
, save
;
2159 volatile Lisp_Object previous_echo_area_message
;
2160 volatile Lisp_Object also_record
;
2161 volatile int reread
;
2162 struct gcpro gcpro1
, gcpro2
;
2163 EMACS_TIME last_idle_start
;
2167 before_command_key_count
= this_command_key_count
;
2168 before_command_echo_length
= echo_length ();
2170 previous_echo_area_message
= Qnil
;
2172 GCPRO2 (c
, previous_echo_area_message
);
2177 if (CONSP (Vunread_post_input_method_events
))
2179 c
= XCAR (Vunread_post_input_method_events
);
2180 Vunread_post_input_method_events
2181 = XCDR (Vunread_post_input_method_events
);
2183 /* Undo what read_char_x_menu_prompt did when it unread
2184 additional keys returned by Fx_popup_menu. */
2186 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2194 if (unread_command_char
!= -1)
2196 XSETINT (c
, unread_command_char
);
2197 unread_command_char
= -1;
2203 if (CONSP (Vunread_command_events
))
2205 c
= XCAR (Vunread_command_events
);
2206 Vunread_command_events
= XCDR (Vunread_command_events
);
2208 /* Undo what read_char_x_menu_prompt did when it unread
2209 additional keys returned by Fx_popup_menu. */
2211 && EQ (XCDR (c
), Qdisabled
)
2212 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2215 /* If the queued event is something that used the mouse,
2216 set used_mouse_menu accordingly. */
2218 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2219 *used_mouse_menu
= 1;
2222 goto reread_for_input_method
;
2225 if (CONSP (Vunread_input_method_events
))
2227 c
= XCAR (Vunread_input_method_events
);
2228 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2230 /* Undo what read_char_x_menu_prompt did when it unread
2231 additional keys returned by Fx_popup_menu. */
2233 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2237 goto reread_for_input_method
;
2240 /* If there is no function key translated before
2241 reset-this-command-lengths takes effect, forget about it. */
2242 before_command_restore_flag
= 0;
2244 if (!NILP (Vexecuting_macro
))
2246 /* We set this to Qmacro; since that's not a frame, nobody will
2247 try to switch frames on us, and the selected window will
2250 Since this event came from a macro, it would be misleading to
2251 leave internal_last_event_frame set to wherever the last
2252 real event came from. Normally, a switch-frame event selects
2253 internal_last_event_frame after each command is read, but
2254 events read from a macro should never cause a new frame to be
2256 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2258 /* Exit the macro if we are at the end.
2259 Also, some things replace the macro with t
2260 to force an early exit. */
2261 if (EQ (Vexecuting_macro
, Qt
)
2262 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2268 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2269 if (STRINGP (Vexecuting_macro
)
2270 && (XINT (c
) & 0x80))
2271 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2273 executing_macro_index
++;
2278 if (!NILP (unread_switch_frame
))
2280 c
= unread_switch_frame
;
2281 unread_switch_frame
= Qnil
;
2283 /* This event should make it into this_command_keys, and get echoed
2284 again, so we do not set `reread'. */
2288 /* if redisplay was requested */
2289 if (commandflag
>= 0)
2291 /* If there is pending input, process any events which are not
2292 user-visible, such as X selection_request events. */
2294 || detect_input_pending_run_timers (0))
2295 swallow_events (0); /* may clear input_pending */
2297 /* Redisplay if no pending input. */
2298 while (!input_pending
)
2300 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2301 redisplay_preserve_echo_area (5);
2306 /* Normal case: no input arrived during redisplay. */
2309 /* Input arrived and pre-empted redisplay.
2310 Process any events which are not user-visible. */
2312 /* If that cleared input_pending, try again to redisplay. */
2316 /* Message turns off echoing unless more keystrokes turn it on again.
2318 The code in 20.x for the condition was
2320 1. echo_area_glyphs && *echo_area_glyphs
2321 2. && echo_area_glyphs != current_kboard->echobuf
2322 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2324 (1) means there's a current message displayed
2326 (2) means it's not the message from echoing from the current
2329 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2330 is set to a non-null value. This is done in read_char and it is
2331 set to echo_area_glyphs after a call to echo_char. That means
2332 ok_to_echo_at_next_pause is either null or
2333 current_kboard->echobuf with the appropriate current_kboard at
2336 So, condition (3) means in clear text ok_to_echo_at_next_pause
2337 must be either null, or the current message isn't from echoing at
2338 all, or it's from echoing from a different kboard than the
2341 if (/* There currently is something in the echo area. */
2342 !NILP (echo_area_buffer
[0])
2343 && (/* And it's either not from echoing. */
2344 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2345 /* Or it's an echo from a different kboard. */
2346 || echo_kboard
!= current_kboard
2347 /* Or we explicitly allow overwriting whatever there is. */
2348 || ok_to_echo_at_next_pause
== NULL
))
2353 /* Try reading a character via menu prompting in the minibuf.
2354 Try this before the sit-for, because the sit-for
2355 would do the wrong thing if we are supposed to do
2356 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2357 after a mouse event so don't try a minibuf menu. */
2359 if (nmaps
> 0 && INTERACTIVE
2360 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2361 /* Don't bring up a menu if we already have another event. */
2362 && NILP (Vunread_command_events
)
2363 && unread_command_char
< 0
2364 && !detect_input_pending_run_timers (0))
2366 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2369 key_already_recorded
= 1;
2374 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2375 We will do that below, temporarily for short sections of code,
2376 when appropriate. local_getcjmp must be in effect
2377 around any call to sit_for or kbd_buffer_get_event;
2378 it *must not* be in effect when we call redisplay. */
2380 if (_setjmp (local_getcjmp
))
2382 XSETINT (c
, quit_char
);
2383 internal_last_event_frame
= selected_frame
;
2384 Vlast_event_frame
= internal_last_event_frame
;
2385 /* If we report the quit char as an event,
2386 don't do so more than once. */
2387 if (!NILP (Vinhibit_quit
))
2392 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2393 if (kb
!= current_kboard
)
2395 Lisp_Object link
= kb
->kbd_queue
;
2396 /* We shouldn't get here if we were in single-kboard mode! */
2401 while (CONSP (XCDR (link
)))
2403 if (!NILP (XCDR (link
)))
2407 kb
->kbd_queue
= Fcons (c
, Qnil
);
2409 XSETCDR (link
, Fcons (c
, Qnil
));
2410 kb
->kbd_queue_has_data
= 1;
2411 current_kboard
= kb
;
2412 /* This is going to exit from read_char
2413 so we had better get rid of this frame's stuff. */
2415 longjmp (wrong_kboard_jmpbuf
, 1);
2422 timer_start_idle ();
2424 /* If in middle of key sequence and minibuffer not active,
2425 start echoing if enough time elapses. */
2427 if (minibuf_level
== 0
2428 && !current_kboard
->immediate_echo
2429 && this_command_key_count
> 0
2431 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2432 && NILP (Fzerop (Vecho_keystrokes
))
2433 && (/* No message. */
2434 NILP (echo_area_buffer
[0])
2435 /* Or empty message. */
2436 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2437 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2438 /* Or already echoing from same kboard. */
2439 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2440 /* Or not echoing before and echoing allowed. */
2441 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2445 /* After a mouse event, start echoing right away.
2446 This is because we are probably about to display a menu,
2447 and we don't want to delay before doing so. */
2448 if (EVENT_HAS_PARAMETERS (prev_event
))
2453 double duration
= extract_float (Vecho_keystrokes
);
2454 sec
= (int) duration
;
2455 usec
= (duration
- sec
) * 1000000;
2456 save_getcjmp (save_jump
);
2457 restore_getcjmp (local_getcjmp
);
2458 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2459 restore_getcjmp (save_jump
);
2461 && ! CONSP (Vunread_command_events
))
2466 /* Maybe auto save due to number of keystrokes. */
2468 if (commandflag
!= 0
2469 && auto_save_interval
> 0
2470 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2471 && !detect_input_pending_run_timers (0))
2473 Fdo_auto_save (Qnil
, Qnil
);
2474 /* Hooks can actually change some buffers in auto save. */
2478 /* Try reading using an X menu.
2479 This is never confused with reading using the minibuf
2480 because the recursive call of read_char in read_char_minibuf_menu_prompt
2481 does not pass on any keymaps. */
2483 if (nmaps
> 0 && INTERACTIVE
2484 && !NILP (prev_event
)
2485 && EVENT_HAS_PARAMETERS (prev_event
)
2486 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2487 && !EQ (XCAR (prev_event
), Qtool_bar
)
2488 /* Don't bring up a menu if we already have another event. */
2489 && NILP (Vunread_command_events
)
2490 && unread_command_char
< 0)
2492 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2494 /* Now that we have read an event, Emacs is not idle. */
2500 /* Maybe autosave and/or garbage collect due to idleness. */
2502 if (INTERACTIVE
&& NILP (c
))
2504 int delay_level
, buffer_size
;
2506 /* Slow down auto saves logarithmically in size of current buffer,
2507 and garbage collect while we're at it. */
2508 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2509 last_non_minibuf_size
= Z
- BEG
;
2510 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2512 while (buffer_size
> 64)
2513 delay_level
++, buffer_size
-= buffer_size
>> 2;
2514 if (delay_level
< 4) delay_level
= 4;
2515 /* delay_level is 4 for files under around 50k, 7 at 100k,
2516 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2518 /* Auto save if enough time goes by without input. */
2519 if (commandflag
!= 0
2520 && num_nonmacro_input_events
> last_auto_save
2521 && INTEGERP (Vauto_save_timeout
)
2522 && XINT (Vauto_save_timeout
) > 0)
2526 save_getcjmp (save_jump
);
2527 restore_getcjmp (local_getcjmp
);
2528 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2530 restore_getcjmp (save_jump
);
2533 && ! CONSP (Vunread_command_events
))
2535 Fdo_auto_save (Qnil
, Qnil
);
2537 /* If we have auto-saved and there is still no input
2538 available, garbage collect if there has been enough
2539 consing going on to make it worthwhile. */
2540 if (!detect_input_pending_run_timers (0)
2541 && consing_since_gc
> gc_cons_threshold
/ 2)
2542 Fgarbage_collect ();
2549 /* If this has become non-nil here, it has been set by a timer
2550 or sentinel or filter. */
2551 if (CONSP (Vunread_command_events
))
2553 c
= XCAR (Vunread_command_events
);
2554 Vunread_command_events
= XCDR (Vunread_command_events
);
2557 /* Read something from current KBOARD's side queue, if possible. */
2561 if (current_kboard
->kbd_queue_has_data
)
2563 if (!CONSP (current_kboard
->kbd_queue
))
2565 c
= XCAR (current_kboard
->kbd_queue
);
2566 current_kboard
->kbd_queue
2567 = XCDR (current_kboard
->kbd_queue
);
2568 if (NILP (current_kboard
->kbd_queue
))
2569 current_kboard
->kbd_queue_has_data
= 0;
2570 input_pending
= readable_events (0);
2571 if (EVENT_HAS_PARAMETERS (c
)
2572 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2573 internal_last_event_frame
= XCAR (XCDR (c
));
2574 Vlast_event_frame
= internal_last_event_frame
;
2579 /* If current_kboard's side queue is empty check the other kboards.
2580 If one of them has data that we have not yet seen here,
2581 switch to it and process the data waiting for it.
2583 Note: if the events queued up for another kboard
2584 have already been seen here, and therefore are not a complete command,
2585 the kbd_queue_has_data field is 0, so we skip that kboard here.
2586 That's to avoid an infinite loop switching between kboards here. */
2587 if (NILP (c
) && !single_kboard
)
2590 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2591 if (kb
->kbd_queue_has_data
)
2593 current_kboard
= kb
;
2594 /* This is going to exit from read_char
2595 so we had better get rid of this frame's stuff. */
2597 longjmp (wrong_kboard_jmpbuf
, 1);
2606 /* Finally, we read from the main queue,
2607 and if that gives us something we can't use yet, we put it on the
2608 appropriate side queue and try again. */
2614 /* Actually read a character, waiting if necessary. */
2615 save_getcjmp (save_jump
);
2616 restore_getcjmp (local_getcjmp
);
2617 timer_start_idle ();
2618 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2619 restore_getcjmp (save_jump
);
2622 if (! NILP (c
) && (kb
!= current_kboard
))
2624 Lisp_Object link
= kb
->kbd_queue
;
2627 while (CONSP (XCDR (link
)))
2629 if (!NILP (XCDR (link
)))
2633 kb
->kbd_queue
= Fcons (c
, Qnil
);
2635 XSETCDR (link
, Fcons (c
, Qnil
));
2636 kb
->kbd_queue_has_data
= 1;
2640 current_kboard
= kb
;
2641 /* This is going to exit from read_char
2642 so we had better get rid of this frame's stuff. */
2644 longjmp (wrong_kboard_jmpbuf
, 1);
2649 /* Terminate Emacs in batch mode if at eof. */
2650 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2651 Fkill_emacs (make_number (1));
2655 /* Add in any extra modifiers, where appropriate. */
2656 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2657 || ((extra_keyboard_modifiers
& 0177) < ' '
2658 && (extra_keyboard_modifiers
& 0177) != 0))
2659 XSETINT (c
, make_ctrl_char (XINT (c
)));
2661 /* Transfer any other modifier bits directly from
2662 extra_keyboard_modifiers to c. Ignore the actual character code
2663 in the low 16 bits of extra_keyboard_modifiers. */
2664 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2669 /* Record the last idle start time so that we can reset it
2670 should the next event read be a help-echo. */
2671 last_idle_start
= timer_idleness_start_time
;
2677 if (commandflag
>= 0
2678 && !input_pending
&& !detect_input_pending_run_timers (0))
2686 /* Buffer switch events are only for internal wakeups
2687 so don't show them to the user.
2688 Also, don't record a key if we already did. */
2689 if (BUFFERP (c
) || key_already_recorded
)
2692 /* Process special events within read_char
2693 and loop around to read another event. */
2696 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2701 int was_locked
= single_kboard
;
2703 last_input_char
= c
;
2704 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2706 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2707 /* We stopped being idle for this event; undo that. This
2708 prevents automatic window selection (under
2709 mouse_autoselect_window from acting as a real input event, for
2710 example banishing the mouse under mouse-avoidance-mode. */
2711 timer_idleness_start_time
= last_idle_start
;
2713 /* Resume allowing input from any kboard, if that was true before. */
2715 any_kboard_state ();
2720 /* Handle things that only apply to characters. */
2723 /* If kbd_buffer_get_event gave us an EOF, return that. */
2727 if ((STRINGP (Vkeyboard_translate_table
)
2728 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2729 || (VECTORP (Vkeyboard_translate_table
)
2730 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2731 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2732 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2735 d
= Faref (Vkeyboard_translate_table
, c
);
2736 /* nil in keyboard-translate-table means no translation. */
2742 /* If this event is a mouse click in the menu bar,
2743 return just menu-bar for now. Modify the mouse click event
2744 so we won't do this twice, then queue it up. */
2745 if (EVENT_HAS_PARAMETERS (c
)
2747 && CONSP (EVENT_START (c
))
2748 && CONSP (XCDR (EVENT_START (c
))))
2752 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2753 /* Handle menu-bar events:
2754 insert the dummy prefix event `menu-bar'. */
2755 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2757 /* Change menu-bar to (menu-bar) as the event "position". */
2758 POSN_BUFFER_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2761 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2766 /* Store these characters into recent_keys, the dribble file if any,
2767 and the keyboard macro being defined, if any. */
2769 if (! NILP (also_record
))
2770 record_char (also_record
);
2772 /* Wipe the echo area.
2773 But first, if we are about to use an input method,
2774 save the echo area contents for it to refer to. */
2776 && ! NILP (Vinput_method_function
)
2777 && (unsigned) XINT (c
) >= ' '
2778 && (unsigned) XINT (c
) != 127
2779 && (unsigned) XINT (c
) < 256)
2781 previous_echo_area_message
= Fcurrent_message ();
2782 Vinput_method_previous_message
= previous_echo_area_message
;
2785 /* Now wipe the echo area, except for help events which do their
2786 own stuff with the echo area. */
2788 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2789 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2791 if (!NILP (echo_area_buffer
[0]))
2792 safe_run_hooks (Qecho_area_clear_hook
);
2793 clear_message (1, 0);
2796 reread_for_input_method
:
2798 /* Pass this to the input method, if appropriate. */
2800 && ! NILP (Vinput_method_function
)
2801 /* Don't run the input method within a key sequence,
2802 after the first event of the key sequence. */
2803 && NILP (prev_event
)
2804 && (unsigned) XINT (c
) >= ' '
2805 && (unsigned) XINT (c
) != 127
2806 && (unsigned) XINT (c
) < 256)
2810 struct gcpro gcpro1
;
2811 int count
= specpdl_ptr
- specpdl
;
2813 /* Save the echo status. */
2814 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2815 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2816 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2818 if (before_command_restore_flag
)
2820 this_command_key_count
= before_command_key_count_1
;
2821 if (this_command_key_count
< this_single_command_key_start
)
2822 this_single_command_key_start
= this_command_key_count
;
2823 echo_truncate (before_command_echo_length_1
);
2824 before_command_restore_flag
= 0;
2827 /* Save the this_command_keys status. */
2828 key_count
= this_command_key_count
;
2831 keys
= Fcopy_sequence (this_command_keys
);
2836 /* Clear out this_command_keys. */
2837 this_command_key_count
= 0;
2839 /* Now wipe the echo area. */
2840 if (!NILP (echo_area_buffer
[0]))
2841 safe_run_hooks (Qecho_area_clear_hook
);
2842 clear_message (1, 0);
2845 /* If we are not reading a key sequence,
2846 never use the echo area. */
2849 specbind (Qinput_method_use_echo_area
, Qt
);
2852 /* Call the input method. */
2853 tem
= call1 (Vinput_method_function
, c
);
2855 tem
= unbind_to (count
, tem
);
2857 /* Restore the saved echoing state
2858 and this_command_keys state. */
2859 this_command_key_count
= key_count
;
2861 this_command_keys
= keys
;
2864 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
2865 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
2866 if (saved_immediate_echo
)
2871 /* The input method can return no events. */
2874 /* Bring back the previous message, if any. */
2875 if (! NILP (previous_echo_area_message
))
2876 message_with_string ("%s", previous_echo_area_message
, 0);
2879 /* It returned one event or more. */
2881 Vunread_post_input_method_events
2882 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
2887 /* Display help if not echoing. */
2888 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
2890 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
2891 Lisp_Object help
, object
, position
, window
, tem
;
2893 tem
= Fcdr (XCDR (c
));
2896 window
= Fcar (tem
);
2898 object
= Fcar (tem
);
2900 position
= Fcar (tem
);
2902 show_help_echo (help
, window
, object
, position
, 0);
2904 /* We stopped being idle for this event; undo that. */
2905 timer_idleness_start_time
= last_idle_start
;
2909 if (this_command_key_count
== 0 || ! reread
)
2911 before_command_key_count
= this_command_key_count
;
2912 before_command_echo_length
= echo_length ();
2914 /* Don't echo mouse motion events. */
2915 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2916 && NILP (Fzerop (Vecho_keystrokes
))
2917 && ! (EVENT_HAS_PARAMETERS (c
)
2918 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2921 if (! NILP (also_record
))
2922 echo_char (also_record
);
2923 /* Once we reread a character, echoing can happen
2924 the next time we pause to read a new one. */
2925 ok_to_echo_at_next_pause
= current_kboard
;
2928 /* Record this character as part of the current key. */
2929 add_command_key (c
);
2930 if (! NILP (also_record
))
2931 add_command_key (also_record
);
2934 last_input_char
= c
;
2937 /* Process the help character specially if enabled */
2938 if (!NILP (Vhelp_form
) && help_char_p (c
))
2941 count
= specpdl_ptr
- specpdl
;
2943 record_unwind_protect (Fset_window_configuration
,
2944 Fcurrent_window_configuration (Qnil
));
2946 tem0
= Feval (Vhelp_form
);
2948 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2952 c
= read_char (0, 0, 0, Qnil
, 0);
2953 while (BUFFERP (c
));
2954 /* Remove the help from the frame */
2955 unbind_to (count
, Qnil
);
2958 if (EQ (c
, make_number (040)))
2962 c
= read_char (0, 0, 0, Qnil
, 0);
2963 while (BUFFERP (c
));
2970 /* Record a key that came from a mouse menu.
2971 Record it for echoing, for this-command-keys, and so on. */
2977 /* Wipe the echo area. */
2978 clear_message (1, 0);
2982 before_command_key_count
= this_command_key_count
;
2983 before_command_echo_length
= echo_length ();
2985 /* Don't echo mouse motion events. */
2986 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2987 && NILP (Fzerop (Vecho_keystrokes
)))
2991 /* Once we reread a character, echoing can happen
2992 the next time we pause to read a new one. */
2993 ok_to_echo_at_next_pause
= 0;
2996 /* Record this character as part of the current key. */
2997 add_command_key (c
);
2999 /* Re-reading in the middle of a command */
3000 last_input_char
= c
;
3004 /* Return 1 if should recognize C as "the help character". */
3012 if (EQ (c
, Vhelp_char
))
3014 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3015 if (EQ (c
, XCAR (tail
)))
3020 /* Record the input event C in various ways. */
3028 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3030 /* To avoid filling recent_keys with help-echo and mouse-movement
3031 events, we filter out repeated help-echo events, only store the
3032 first and last in a series of mouse-movement events, and don't
3033 store repeated help-echo events which are only separated by
3034 mouse-movement events. */
3036 Lisp_Object ev1
, ev2
, ev3
;
3039 if ((ix1
= recent_keys_index
- 1) < 0)
3040 ix1
= NUM_RECENT_KEYS
- 1;
3041 ev1
= AREF (recent_keys
, ix1
);
3043 if ((ix2
= ix1
- 1) < 0)
3044 ix2
= NUM_RECENT_KEYS
- 1;
3045 ev2
= AREF (recent_keys
, ix2
);
3047 if ((ix3
= ix2
- 1) < 0)
3048 ix3
= NUM_RECENT_KEYS
- 1;
3049 ev3
= AREF (recent_keys
, ix3
);
3051 if (EQ (XCAR (c
), Qhelp_echo
))
3053 /* Don't record `help-echo' in recent_keys unless it shows some help
3054 message, and a different help than the previously recorded
3056 Lisp_Object help
, last_help
;
3058 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3059 if (!STRINGP (help
))
3061 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3062 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3064 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3065 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3066 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3068 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3069 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3070 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3071 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3074 else if (EQ (XCAR (c
), Qmouse_movement
))
3076 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3077 So additional mouse movement events replace the last element. */
3078 Lisp_Object last_window
, window
;
3080 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3081 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3082 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3083 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3084 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3086 ASET (recent_keys
, ix1
, c
);
3092 store_kbd_macro_char (c
);
3097 ASET (recent_keys
, recent_keys_index
, c
);
3098 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3099 recent_keys_index
= 0;
3101 else if (recorded
< 0)
3103 /* We need to remove one or two events from recent_keys.
3104 To do this, we simply put nil at those events and move the
3105 recent_keys_index backwards over those events. Usually,
3106 users will never see those nil events, as they will be
3107 overwritten by the command keys entered to see recent_keys
3110 while (recorded
++ < 0 && total_keys
> 0)
3112 if (total_keys
< NUM_RECENT_KEYS
)
3114 if (--recent_keys_index
< 0)
3115 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3116 ASET (recent_keys
, recent_keys_index
, Qnil
);
3120 num_nonmacro_input_events
++;
3122 /* Write c to the dribble file. If c is a lispy event, write
3123 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3124 If you, dear reader, have a better idea, you've got the source. :-) */
3129 if (XUINT (c
) < 0x100)
3130 putc (XINT (c
), dribble
);
3132 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3136 Lisp_Object dribblee
;
3138 /* If it's a structured event, take the event header. */
3139 dribblee
= EVENT_HEAD (c
);
3141 if (SYMBOLP (dribblee
))
3143 putc ('<', dribble
);
3144 fwrite (XSTRING (SYMBOL_NAME (dribblee
))->data
, sizeof (char),
3145 STRING_BYTES (XSTRING (SYMBOL_NAME (dribblee
))),
3147 putc ('>', dribble
);
3159 struct buffer
*old
= current_buffer
;
3160 Fprinc (object
, Qnil
);
3161 set_buffer_internal (XBUFFER (Vstandard_output
));
3162 call0 (intern ("help-mode"));
3163 set_buffer_internal (old
);
3167 /* Copy out or in the info on where C-g should throw to.
3168 This is used when running Lisp code from within get_char,
3169 in case get_char is called recursively.
3170 See read_process_output. */
3176 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3180 restore_getcjmp (temp
)
3183 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3188 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3189 of this function. */
3192 tracking_off (old_value
)
3193 Lisp_Object old_value
;
3195 do_mouse_tracking
= old_value
;
3196 if (NILP (old_value
))
3198 /* Redisplay may have been preempted because there was input
3199 available, and it assumes it will be called again after the
3200 input has been processed. If the only input available was
3201 the sort that we have just disabled, then we need to call
3203 if (!readable_events (1))
3205 redisplay_preserve_echo_area (6);
3206 get_input_pending (&input_pending
, 1);
3212 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3213 doc
: /* Evaluate BODY with mouse movement events enabled.
3214 Within a `track-mouse' form, mouse motion generates input events that
3215 you can read with `read-event'.
3216 Normally, mouse motion is ignored.
3217 usage: (track-mouse BODY ...) */)
3221 int count
= specpdl_ptr
- specpdl
;
3224 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3226 do_mouse_tracking
= Qt
;
3228 val
= Fprogn (args
);
3229 return unbind_to (count
, val
);
3232 /* If mouse has moved on some frame, return one of those frames.
3233 Return 0 otherwise. */
3238 Lisp_Object tail
, frame
;
3240 FOR_EACH_FRAME (tail
, frame
)
3242 if (XFRAME (frame
)->mouse_moved
)
3243 return XFRAME (frame
);
3249 #endif /* HAVE_MOUSE */
3251 /* Low level keyboard/mouse input.
3252 kbd_buffer_store_event places events in kbd_buffer, and
3253 kbd_buffer_get_event retrieves them. */
3255 /* Return true iff there are any events in the queue that read-char
3256 would return. If this returns false, a read-char would block. */
3258 readable_filtered_events (do_timers_now
, filter_events
)
3263 timer_check (do_timers_now
);
3265 /* If the buffer contains only FOCUS_IN_EVENT events,
3266 and FILTER_EVENTS is nonzero, report it as empty. */
3267 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3269 int have_live_event
= 1;
3273 struct input_event
*event
;
3275 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3279 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3282 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3284 if (event
== kbd_store_ptr
)
3285 have_live_event
= 0;
3288 if (have_live_event
) return 1;
3292 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3297 if (current_kboard
->kbd_queue_has_data
)
3303 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3304 if (kb
->kbd_queue_has_data
)
3310 /* Return true iff there are any events in the queue that read-char
3311 would return. If this returns false, a read-char would block. */
3313 readable_events (do_timers_now
)
3316 return readable_filtered_events (do_timers_now
, 0);
3319 /* Set this for debugging, to have a way to get out */
3324 event_to_kboard (event
)
3325 struct input_event
*event
;
3328 frame
= event
->frame_or_window
;
3330 frame
= XCAR (frame
);
3331 else if (WINDOWP (frame
))
3332 frame
= WINDOW_FRAME (XWINDOW (frame
));
3334 /* There are still some events that don't set this field.
3335 For now, just ignore the problem.
3336 Also ignore dead frames here. */
3337 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3340 return FRAME_KBOARD (XFRAME (frame
));
3344 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3347 kbd_buffer_store_event (event
)
3348 register struct input_event
*event
;
3350 if (event
->kind
== NO_EVENT
)
3353 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3355 register int c
= event
->code
& 0377;
3357 if (event
->modifiers
& ctrl_modifier
)
3358 c
= make_ctrl_char (c
);
3360 c
|= (event
->modifiers
3361 & (meta_modifier
| alt_modifier
3362 | hyper_modifier
| super_modifier
));
3366 static SIGTYPE
interrupt_signal (int);
3369 struct input_event
*sp
;
3372 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3373 kb
!= current_kboard
))
3376 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3377 Fcons (make_number (c
), Qnil
));
3378 kb
->kbd_queue_has_data
= 1;
3379 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3381 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3384 if (event_to_kboard (sp
) == kb
)
3386 sp
->kind
= NO_EVENT
;
3387 sp
->frame_or_window
= Qnil
;
3395 /* If this results in a quit_char being returned to Emacs as
3396 input, set Vlast_event_frame properly. If this doesn't
3397 get returned to Emacs as an event, the next event read
3398 will set Vlast_event_frame again, so this is safe to do. */
3402 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3404 focus
= event
->frame_or_window
;
3405 internal_last_event_frame
= focus
;
3406 Vlast_event_frame
= focus
;
3409 last_event_timestamp
= event
->timestamp
;
3410 interrupt_signal (0 /* dummy */);
3414 if (c
&& c
== stop_character
)
3420 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3421 Just ignore the second one. */
3422 else if (event
->kind
== BUFFER_SWITCH_EVENT
3423 && kbd_fetch_ptr
!= kbd_store_ptr
3424 && kbd_store_ptr
->kind
== BUFFER_SWITCH_EVENT
)
3427 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3428 kbd_store_ptr
= kbd_buffer
;
3430 /* Don't let the very last slot in the buffer become full,
3431 since that would make the two pointers equal,
3432 and that is indistinguishable from an empty buffer.
3433 Discard the event if it would fill the last slot. */
3434 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3438 #if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
3439 prone to assign individual members for other events, in case
3440 the input_event structure is changed. --2000-07-13, gerd. */
3441 struct input_event
*sp
= kbd_store_ptr
;
3442 sp
->kind
= event
->kind
;
3443 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3445 /* We must not use the ordinary copying code for this case,
3446 since `part' is an enum and copying it might not copy enough
3448 bcopy (event
, (char *) sp
, sizeof (*event
));
3453 sp
->code
= event
->code
;
3454 sp
->part
= event
->part
;
3455 sp
->frame_or_window
= event
->frame_or_window
;
3456 sp
->arg
= event
->arg
;
3457 sp
->modifiers
= event
->modifiers
;
3460 sp
->timestamp
= event
->timestamp
;
3463 *kbd_store_ptr
= *event
;
3466 idx
= 2 * (kbd_store_ptr
- kbd_buffer
);
3467 ASET (kbd_buffer_gcpro
, idx
, event
->frame_or_window
);
3468 ASET (kbd_buffer_gcpro
, idx
+ 1, event
->arg
);
3474 /* Generate HELP_EVENT input_events in BUFP which has room for
3475 SIZE events. If there's not enough room in BUFP, ignore this
3478 HELP is the help form.
3480 FRAME is the frame on which the help is generated. OBJECT is the
3481 Lisp object where the help was found (a buffer, a string, an
3482 overlay, or nil if neither from a string nor from a buffer. POS is
3483 the position within OBJECT where the help was found.
3485 Value is the number of input_events generated. */
3488 gen_help_event (bufp
, size
, help
, frame
, window
, object
, pos
)
3489 struct input_event
*bufp
;
3491 Lisp_Object help
, frame
, object
, window
;
3496 bufp
->kind
= HELP_EVENT
;
3497 bufp
->frame_or_window
= frame
;
3499 bufp
->x
= WINDOWP (window
) ? window
: frame
;
3508 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3511 kbd_buffer_store_help_event (frame
, help
)
3512 Lisp_Object frame
, help
;
3514 struct input_event event
;
3516 event
.kind
= HELP_EVENT
;
3517 event
.frame_or_window
= frame
;
3522 kbd_buffer_store_event (&event
);
3526 /* Discard any mouse events in the event buffer by setting them to
3529 discard_mouse_events ()
3531 struct input_event
*sp
;
3532 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3534 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3537 if (sp
->kind
== MOUSE_CLICK_EVENT
3539 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3541 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3543 sp
->kind
= NO_EVENT
;
3549 /* Return non-zero if there are any real events waiting in the event
3550 buffer, not counting `NO_EVENT's.
3552 If DISCARD is non-zero, discard NO_EVENT events at the front of
3553 the input queue, possibly leaving the input queue empty if there
3554 are no real input events. */
3557 kbd_buffer_events_waiting (discard
)
3560 struct input_event
*sp
;
3562 for (sp
= kbd_fetch_ptr
;
3563 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3566 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3573 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3577 /* Clear input event EVENT. */
3581 struct input_event
*event
;
3583 int idx
= 2 * (event
- kbd_buffer
);
3584 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
3585 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
3586 event
->kind
= NO_EVENT
;
3590 /* Read one event from the event buffer, waiting if necessary.
3591 The value is a Lisp object representing the event.
3592 The value is nil for an event that should be ignored,
3593 or that was handled here.
3594 We always read and discard one event. */
3597 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3599 int *used_mouse_menu
;
3608 *kbp
= current_kboard
;
3612 /* Wait until there is input available. */
3615 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3618 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3622 /* If the quit flag is set, then read_char will return
3623 quit_char, so that counts as "available input." */
3624 if (!NILP (Vquit_flag
))
3625 quit_throw_to_read_char ();
3627 /* One way or another, wait until input is available; then, if
3628 interrupt handlers have not read it, read it now. */
3631 wait_for_kbd_input ();
3633 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3637 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3640 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3644 Lisp_Object minus_one
;
3646 XSETINT (minus_one
, -1);
3647 wait_reading_process_input (0, 0, minus_one
, 1);
3649 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3650 /* Pass 1 for EXPECT since we just waited to have input. */
3651 read_avail_input (1);
3653 #endif /* not VMS */
3656 if (CONSP (Vunread_command_events
))
3659 first
= XCAR (Vunread_command_events
);
3660 Vunread_command_events
= XCDR (Vunread_command_events
);
3661 *kbp
= current_kboard
;
3665 /* At this point, we know that there is a readable event available
3666 somewhere. If the event queue is empty, then there must be a
3667 mouse movement enabled and available. */
3668 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3670 struct input_event
*event
;
3672 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3676 last_event_timestamp
= event
->timestamp
;
3679 *kbp
= event_to_kboard (event
);
3681 *kbp
= current_kboard
; /* Better than returning null ptr? */
3683 *kbp
= &the_only_kboard
;
3688 /* These two kinds of events get special handling
3689 and don't actually appear to the command loop.
3690 We return nil for them. */
3691 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3694 struct input_event copy
;
3696 /* Remove it from the buffer before processing it,
3697 since otherwise swallow_events will see it
3698 and process it again. */
3700 kbd_fetch_ptr
= event
+ 1;
3701 input_pending
= readable_events (0);
3702 x_handle_selection_request (©
);
3704 /* We're getting selection request events, but we don't have
3710 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3713 struct input_event copy
;
3715 /* Remove it from the buffer before processing it. */
3717 kbd_fetch_ptr
= event
+ 1;
3718 input_pending
= readable_events (0);
3719 x_handle_selection_clear (©
);
3721 /* We're getting selection request events, but we don't have
3726 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3727 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3729 /* Make an event (delete-frame (FRAME)). */
3730 obj
= Fcons (event
->frame_or_window
, Qnil
);
3731 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3732 kbd_fetch_ptr
= event
+ 1;
3735 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3736 else if (event
->kind
== ICONIFY_EVENT
)
3738 /* Make an event (iconify-frame (FRAME)). */
3739 obj
= Fcons (event
->frame_or_window
, Qnil
);
3740 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3741 kbd_fetch_ptr
= event
+ 1;
3743 else if (event
->kind
== DEICONIFY_EVENT
)
3745 /* Make an event (make-frame-visible (FRAME)). */
3746 obj
= Fcons (event
->frame_or_window
, Qnil
);
3747 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3748 kbd_fetch_ptr
= event
+ 1;
3751 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3753 /* The value doesn't matter here; only the type is tested. */
3754 XSETBUFFER (obj
, current_buffer
);
3755 kbd_fetch_ptr
= event
+ 1;
3757 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS)
3758 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3760 kbd_fetch_ptr
= event
+ 1;
3761 input_pending
= readable_events (0);
3762 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3763 x_activate_menubar (XFRAME (event
->frame_or_window
));
3767 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3769 /* Make an event (language-change (FRAME CHARSET LCID)). */
3770 obj
= Fcons (event
->modifiers
, Qnil
);
3771 obj
= Fcons (event
->code
, obj
);
3772 obj
= Fcons (event
->frame_or_window
, obj
);
3773 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3774 kbd_fetch_ptr
= event
+ 1;
3777 else if (event
->kind
== SAVE_SESSION_EVENT
)
3779 obj
= Fcons (Qsave_session
, Qnil
);
3780 kbd_fetch_ptr
= event
+ 1;
3782 /* Just discard these, by returning nil.
3783 With MULTI_KBOARD, these events are used as placeholders
3784 when we need to randomly delete events from the queue.
3785 (They shouldn't otherwise be found in the buffer,
3786 but on some machines it appears they do show up
3787 even without MULTI_KBOARD.) */
3788 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3789 mouse events during a popup-menu call. */
3790 else if (event
->kind
== NO_EVENT
)
3791 kbd_fetch_ptr
= event
+ 1;
3792 else if (event
->kind
== HELP_EVENT
)
3794 Lisp_Object object
, position
, help
, frame
, window
;
3796 frame
= event
->frame_or_window
;
3797 object
= event
->arg
;
3798 position
= make_number (event
->code
);
3801 clear_event (event
);
3803 kbd_fetch_ptr
= event
+ 1;
3804 if (!WINDOWP (window
))
3806 obj
= Fcons (Qhelp_echo
,
3807 list5 (frame
, help
, window
, object
, position
));
3809 else if (event
->kind
== FOCUS_IN_EVENT
)
3811 /* Notification of a FocusIn event. The frame receiving the
3812 focus is in event->frame_or_window. Generate a
3813 switch-frame event if necessary. */
3814 Lisp_Object frame
, focus
;
3816 frame
= event
->frame_or_window
;
3817 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3821 if (!EQ (frame
, internal_last_event_frame
)
3822 && !EQ (frame
, selected_frame
))
3823 obj
= make_lispy_switch_frame (frame
);
3824 internal_last_event_frame
= frame
;
3825 kbd_fetch_ptr
= event
+ 1;
3827 else if (event
->kind
== SELECT_WINDOW_EVENT
)
3829 /* Make an event (select-window (WINDOW)). */
3830 obj
= Fcons (event
->frame_or_window
, Qnil
);
3831 obj
= Fcons (Qselect_window
, Fcons (obj
, Qnil
));
3833 kbd_fetch_ptr
= event
+ 1;
3837 /* If this event is on a different frame, return a switch-frame this
3838 time, and leave the event in the queue for next time. */
3842 frame
= event
->frame_or_window
;
3844 frame
= XCAR (frame
);
3845 else if (WINDOWP (frame
))
3846 frame
= WINDOW_FRAME (XWINDOW (frame
));
3848 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3852 if (! EQ (frame
, internal_last_event_frame
)
3853 && !EQ (frame
, selected_frame
))
3854 obj
= make_lispy_switch_frame (frame
);
3855 internal_last_event_frame
= frame
;
3857 /* If we didn't decide to make a switch-frame event, go ahead
3858 and build a real event from the queue entry. */
3862 obj
= make_lispy_event (event
);
3864 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
3865 /* If this was a menu selection, then set the flag to inhibit
3866 writing to last_nonmenu_event. Don't do this if the event
3867 we're returning is (menu-bar), though; that indicates the
3868 beginning of the menu sequence, and we might as well leave
3869 that as the `event with parameters' for this selection. */
3871 && !EQ (event
->frame_or_window
, event
->arg
)
3872 && (event
->kind
== MENU_BAR_EVENT
3873 || event
->kind
== TOOL_BAR_EVENT
))
3874 *used_mouse_menu
= 1;
3877 /* Wipe out this event, to catch bugs. */
3878 clear_event (event
);
3879 kbd_fetch_ptr
= event
+ 1;
3884 /* Try generating a mouse motion event. */
3885 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3887 FRAME_PTR f
= some_mouse_moved ();
3888 Lisp_Object bar_window
;
3889 enum scroll_bar_part part
;
3893 *kbp
= current_kboard
;
3894 /* Note that this uses F to determine which display to look at.
3895 If there is no valid info, it does not store anything
3896 so x remains nil. */
3898 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
3902 /* Decide if we should generate a switch-frame event. Don't
3903 generate switch-frame events for motion outside of all Emacs
3909 frame
= FRAME_FOCUS_FRAME (f
);
3911 XSETFRAME (frame
, f
);
3913 if (! EQ (frame
, internal_last_event_frame
)
3914 && !EQ (frame
, selected_frame
))
3915 obj
= make_lispy_switch_frame (frame
);
3916 internal_last_event_frame
= frame
;
3919 /* If we didn't decide to make a switch-frame event, go ahead and
3920 return a mouse-motion event. */
3921 if (!NILP (x
) && NILP (obj
))
3922 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
3924 #endif /* HAVE_MOUSE */
3926 /* We were promised by the above while loop that there was
3927 something for us to read! */
3930 input_pending
= readable_events (0);
3932 Vlast_event_frame
= internal_last_event_frame
;
3937 /* Process any events that are not user-visible,
3938 then return, without reading any user-visible events. */
3941 swallow_events (do_display
)
3946 while (kbd_fetch_ptr
!= kbd_store_ptr
)
3948 struct input_event
*event
;
3950 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3954 last_event_timestamp
= event
->timestamp
;
3956 /* These two kinds of events get special handling
3957 and don't actually appear to the command loop. */
3958 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3961 struct input_event copy
;
3963 /* Remove it from the buffer before processing it,
3964 since otherwise swallow_events called recursively could see it
3965 and process it again. */
3967 kbd_fetch_ptr
= event
+ 1;
3968 input_pending
= readable_events (0);
3969 x_handle_selection_request (©
);
3971 /* We're getting selection request events, but we don't have
3977 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3980 struct input_event copy
;
3982 /* Remove it from the buffer before processing it, */
3985 kbd_fetch_ptr
= event
+ 1;
3986 input_pending
= readable_events (0);
3987 x_handle_selection_clear (©
);
3989 /* We're getting selection request events, but we don't have
3998 old_timers_run
= timers_run
;
3999 get_input_pending (&input_pending
, 1);
4001 if (timers_run
!= old_timers_run
&& do_display
)
4002 redisplay_preserve_echo_area (7);
4005 /* Record the start of when Emacs is idle,
4006 for the sake of running idle-time timers. */
4013 /* If we are already in the idle state, do nothing. */
4014 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4017 EMACS_GET_TIME (timer_idleness_start_time
);
4019 /* Mark all idle-time timers as once again candidates for running. */
4020 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4024 timer
= XCAR (timers
);
4026 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4028 XVECTOR (timer
)->contents
[0] = Qnil
;
4032 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4037 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4040 /* This is only for debugging. */
4041 struct input_event last_timer_event
;
4043 /* Check whether a timer has fired. To prevent larger problems we simply
4044 disregard elements that are not proper timers. Do not make a circular
4045 timer list for the time being.
4047 Returns the number of seconds to wait until the next timer fires. If a
4048 timer is triggering now, return zero seconds.
4049 If no timer is active, return -1 seconds.
4051 If a timer is ripe, we run it, with quitting turned off.
4053 DO_IT_NOW is now ignored. It used to mean that we should
4054 run the timer directly instead of queueing a timer-event.
4055 Now we always run timers directly. */
4058 timer_check (do_it_now
)
4061 EMACS_TIME nexttime
;
4062 EMACS_TIME now
, idleness_now
;
4063 Lisp_Object timers
, idle_timers
, chosen_timer
;
4064 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4066 EMACS_SET_SECS (nexttime
, -1);
4067 EMACS_SET_USECS (nexttime
, -1);
4069 /* Always consider the ordinary timers. */
4070 timers
= Vtimer_list
;
4071 /* Consider the idle timers only if Emacs is idle. */
4072 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4073 idle_timers
= Vtimer_idle_list
;
4076 chosen_timer
= Qnil
;
4077 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4079 if (CONSP (timers
) || CONSP (idle_timers
))
4081 EMACS_GET_TIME (now
);
4082 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4083 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4086 while (CONSP (timers
) || CONSP (idle_timers
))
4088 Lisp_Object
*vector
;
4089 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4090 EMACS_TIME timer_time
, idle_timer_time
;
4091 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4093 /* Skip past invalid timers and timers already handled. */
4096 timer
= XCAR (timers
);
4097 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4099 timers
= XCDR (timers
);
4102 vector
= XVECTOR (timer
)->contents
;
4104 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4105 || !INTEGERP (vector
[3])
4106 || ! NILP (vector
[0]))
4108 timers
= XCDR (timers
);
4112 if (!NILP (idle_timers
))
4114 timer
= XCAR (idle_timers
);
4115 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4117 idle_timers
= XCDR (idle_timers
);
4120 vector
= XVECTOR (timer
)->contents
;
4122 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4123 || !INTEGERP (vector
[3])
4124 || ! NILP (vector
[0]))
4126 idle_timers
= XCDR (idle_timers
);
4131 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4132 based on the next ordinary timer.
4133 TIMER_DIFFERENCE is the distance in time from NOW to when
4134 this timer becomes ripe (negative if it's already ripe). */
4137 timer
= XCAR (timers
);
4138 vector
= XVECTOR (timer
)->contents
;
4139 EMACS_SET_SECS (timer_time
,
4140 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4141 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4142 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4145 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4146 based on the next idle timer. */
4147 if (!NILP (idle_timers
))
4149 idle_timer
= XCAR (idle_timers
);
4150 vector
= XVECTOR (idle_timer
)->contents
;
4151 EMACS_SET_SECS (idle_timer_time
,
4152 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4153 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4154 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4157 /* Decide which timer is the next timer,
4158 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4159 Also step down the list where we found that timer. */
4161 if (! NILP (timers
) && ! NILP (idle_timers
))
4164 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4165 if (EMACS_TIME_NEG_P (temp
))
4167 chosen_timer
= timer
;
4168 timers
= XCDR (timers
);
4169 difference
= timer_difference
;
4173 chosen_timer
= idle_timer
;
4174 idle_timers
= XCDR (idle_timers
);
4175 difference
= idle_timer_difference
;
4178 else if (! NILP (timers
))
4180 chosen_timer
= timer
;
4181 timers
= XCDR (timers
);
4182 difference
= timer_difference
;
4186 chosen_timer
= idle_timer
;
4187 idle_timers
= XCDR (idle_timers
);
4188 difference
= idle_timer_difference
;
4190 vector
= XVECTOR (chosen_timer
)->contents
;
4192 /* If timer is ripe, run it if it hasn't been run. */
4193 if (EMACS_TIME_NEG_P (difference
)
4194 || (EMACS_SECS (difference
) == 0
4195 && EMACS_USECS (difference
) == 0))
4197 if (NILP (vector
[0]))
4199 int was_locked
= single_kboard
;
4200 int count
= BINDING_STACK_SIZE ();
4201 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4203 /* Mark the timer as triggered to prevent problems if the lisp
4204 code fails to reschedule it right. */
4207 specbind (Qinhibit_quit
, Qt
);
4209 call1 (Qtimer_event_handler
, chosen_timer
);
4210 Vdeactivate_mark
= old_deactivate_mark
;
4212 unbind_to (count
, Qnil
);
4214 /* Resume allowing input from any kboard, if that was true before. */
4216 any_kboard_state ();
4218 /* Since we have handled the event,
4219 we don't need to tell the caller to wake up and do it. */
4223 /* When we encounter a timer that is still waiting,
4224 return the amount of time to wait before it is ripe. */
4231 /* No timers are pending in the future. */
4232 /* Return 0 if we generated an event, and -1 if not. */
4237 /* Caches for modify_event_symbol. */
4238 static Lisp_Object accent_key_syms
;
4239 static Lisp_Object func_key_syms
;
4240 static Lisp_Object mouse_syms
;
4242 static Lisp_Object mouse_wheel_syms
;
4244 static Lisp_Object drag_n_drop_syms
;
4246 /* This is a list of keysym codes for special "accent" characters.
4247 It parallels lispy_accent_keys. */
4249 static int lispy_accent_codes
[] =
4251 #ifdef XK_dead_circumflex
4256 #ifdef XK_dead_grave
4261 #ifdef XK_dead_tilde
4266 #ifdef XK_dead_diaeresis
4271 #ifdef XK_dead_macron
4276 #ifdef XK_dead_degree
4281 #ifdef XK_dead_acute
4286 #ifdef XK_dead_cedilla
4291 #ifdef XK_dead_breve
4296 #ifdef XK_dead_ogonek
4301 #ifdef XK_dead_caron
4306 #ifdef XK_dead_doubleacute
4307 XK_dead_doubleacute
,
4311 #ifdef XK_dead_abovedot
4318 /* This is a list of Lisp names for special "accent" characters.
4319 It parallels lispy_accent_codes. */
4321 static char *lispy_accent_keys
[] =
4339 #define FUNCTION_KEY_OFFSET 0x0
4341 char *lispy_function_keys
[] =
4345 0, /* VK_LBUTTON 0x01 */
4346 0, /* VK_RBUTTON 0x02 */
4347 "cancel", /* VK_CANCEL 0x03 */
4348 0, /* VK_MBUTTON 0x04 */
4350 0, 0, 0, /* 0x05 .. 0x07 */
4352 "backspace", /* VK_BACK 0x08 */
4353 "tab", /* VK_TAB 0x09 */
4355 0, 0, /* 0x0A .. 0x0B */
4357 "clear", /* VK_CLEAR 0x0C */
4358 "return", /* VK_RETURN 0x0D */
4360 0, 0, /* 0x0E .. 0x0F */
4362 0, /* VK_SHIFT 0x10 */
4363 0, /* VK_CONTROL 0x11 */
4364 0, /* VK_MENU 0x12 */
4365 "pause", /* VK_PAUSE 0x13 */
4366 "capslock", /* VK_CAPITAL 0x14 */
4368 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4370 "escape", /* VK_ESCAPE 0x1B */
4372 0, 0, 0, 0, /* 0x1C .. 0x1F */
4374 0, /* VK_SPACE 0x20 */
4375 "prior", /* VK_PRIOR 0x21 */
4376 "next", /* VK_NEXT 0x22 */
4377 "end", /* VK_END 0x23 */
4378 "home", /* VK_HOME 0x24 */
4379 "left", /* VK_LEFT 0x25 */
4380 "up", /* VK_UP 0x26 */
4381 "right", /* VK_RIGHT 0x27 */
4382 "down", /* VK_DOWN 0x28 */
4383 "select", /* VK_SELECT 0x29 */
4384 "print", /* VK_PRINT 0x2A */
4385 "execute", /* VK_EXECUTE 0x2B */
4386 "snapshot", /* VK_SNAPSHOT 0x2C */
4387 "insert", /* VK_INSERT 0x2D */
4388 "delete", /* VK_DELETE 0x2E */
4389 "help", /* VK_HELP 0x2F */
4391 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4393 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4395 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4397 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4399 0, 0, 0, 0, 0, 0, 0, 0, 0,
4400 0, 0, 0, 0, 0, 0, 0, 0, 0,
4401 0, 0, 0, 0, 0, 0, 0, 0,
4403 "lwindow", /* VK_LWIN 0x5B */
4404 "rwindow", /* VK_RWIN 0x5C */
4405 "apps", /* VK_APPS 0x5D */
4407 0, 0, /* 0x5E .. 0x5F */
4409 "kp-0", /* VK_NUMPAD0 0x60 */
4410 "kp-1", /* VK_NUMPAD1 0x61 */
4411 "kp-2", /* VK_NUMPAD2 0x62 */
4412 "kp-3", /* VK_NUMPAD3 0x63 */
4413 "kp-4", /* VK_NUMPAD4 0x64 */
4414 "kp-5", /* VK_NUMPAD5 0x65 */
4415 "kp-6", /* VK_NUMPAD6 0x66 */
4416 "kp-7", /* VK_NUMPAD7 0x67 */
4417 "kp-8", /* VK_NUMPAD8 0x68 */
4418 "kp-9", /* VK_NUMPAD9 0x69 */
4419 "kp-multiply", /* VK_MULTIPLY 0x6A */
4420 "kp-add", /* VK_ADD 0x6B */
4421 "kp-separator", /* VK_SEPARATOR 0x6C */
4422 "kp-subtract", /* VK_SUBTRACT 0x6D */
4423 "kp-decimal", /* VK_DECIMAL 0x6E */
4424 "kp-divide", /* VK_DIVIDE 0x6F */
4425 "f1", /* VK_F1 0x70 */
4426 "f2", /* VK_F2 0x71 */
4427 "f3", /* VK_F3 0x72 */
4428 "f4", /* VK_F4 0x73 */
4429 "f5", /* VK_F5 0x74 */
4430 "f6", /* VK_F6 0x75 */
4431 "f7", /* VK_F7 0x76 */
4432 "f8", /* VK_F8 0x77 */
4433 "f9", /* VK_F9 0x78 */
4434 "f10", /* VK_F10 0x79 */
4435 "f11", /* VK_F11 0x7A */
4436 "f12", /* VK_F12 0x7B */
4437 "f13", /* VK_F13 0x7C */
4438 "f14", /* VK_F14 0x7D */
4439 "f15", /* VK_F15 0x7E */
4440 "f16", /* VK_F16 0x7F */
4441 "f17", /* VK_F17 0x80 */
4442 "f18", /* VK_F18 0x81 */
4443 "f19", /* VK_F19 0x82 */
4444 "f20", /* VK_F20 0x83 */
4445 "f21", /* VK_F21 0x84 */
4446 "f22", /* VK_F22 0x85 */
4447 "f23", /* VK_F23 0x86 */
4448 "f24", /* VK_F24 0x87 */
4450 0, 0, 0, 0, /* 0x88 .. 0x8B */
4451 0, 0, 0, 0, /* 0x8C .. 0x8F */
4453 "kp-numlock", /* VK_NUMLOCK 0x90 */
4454 "scroll", /* VK_SCROLL 0x91 */
4456 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4457 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4458 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4459 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4460 "kp-end", /* VK_NUMPAD_END 0x96 */
4461 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4462 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4463 "kp-up", /* VK_NUMPAD_UP 0x99 */
4464 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4465 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4466 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4467 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4469 0, 0, /* 0x9E .. 0x9F */
4472 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4473 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4474 * No other API or message will distinguish left and right keys this way.
4478 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4479 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4480 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4481 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4482 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4488 "attn", /* VK_ATTN 0xF6 */
4489 "crsel", /* VK_CRSEL 0xF7 */
4490 "exsel", /* VK_EXSEL 0xF8 */
4491 "ereof", /* VK_EREOF 0xF9 */
4492 "play", /* VK_PLAY 0xFA */
4493 "zoom", /* VK_ZOOM 0xFB */
4494 "noname", /* VK_NONAME 0xFC */
4495 "pa1", /* VK_PA1 0xFD */
4496 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4500 #else /* not HAVE_NTGUI */
4503 static char *lispy_kana_keys
[] =
4505 /* X Keysym value */
4506 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4507 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4508 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4509 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4510 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4511 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4512 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4513 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4514 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4515 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4516 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4517 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4518 "kana-i", "kana-u", "kana-e", "kana-o",
4519 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4520 "prolongedsound", "kana-A", "kana-I", "kana-U",
4521 "kana-E", "kana-O", "kana-KA", "kana-KI",
4522 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4523 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4524 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4525 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4526 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4527 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4528 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4529 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4530 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4531 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4532 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4533 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4535 #endif /* XK_kana_A */
4537 #define FUNCTION_KEY_OFFSET 0xff00
4539 /* You'll notice that this table is arranged to be conveniently
4540 indexed by X Windows keysym values. */
4541 static char *lispy_function_keys
[] =
4543 /* X Keysym value */
4545 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4546 "backspace", "tab", "linefeed", "clear",
4548 0, 0, 0, "pause", /* 0xff10...1f */
4549 0, 0, 0, 0, 0, 0, 0, "escape",
4551 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4552 "romaji", "hiragana", "katakana", "hiragana-katakana",
4553 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4554 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4555 "eisu-toggle", /* 0xff30...3f */
4556 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4557 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4559 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4560 "down", "prior", "next", "end",
4561 "begin", 0, 0, 0, 0, 0, 0, 0,
4562 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4573 "break", /* 0xff6b */
4576 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4577 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4578 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4579 0, 0, 0, 0, 0, 0, 0, 0,
4580 "kp-tab", /* 0xff89 */
4582 "kp-enter", /* 0xff8d */
4584 "kp-f1", /* 0xff91 */
4588 "kp-home", /* 0xff95 */
4593 "kp-prior", /* kp-page-up */
4594 "kp-next", /* kp-page-down */
4600 0, 0, 0, 0, 0, 0, 0, 0, 0,
4601 "kp-multiply", /* 0xffaa */
4606 "kp-divide", /* 0xffaf */
4607 "kp-0", /* 0xffb0 */
4608 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4611 "kp-equal", /* 0xffbd */
4612 "f1", /* 0xffbe */ /* IsFunctionKey */
4614 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4615 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4616 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4617 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4618 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4619 0, 0, 0, 0, 0, 0, 0, 0,
4620 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4621 0, 0, 0, 0, 0, 0, 0, "delete"
4624 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4625 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4627 static char *iso_lispy_function_keys
[] =
4629 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4630 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4631 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4632 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4633 "iso-lefttab", /* 0xfe20 */
4634 "iso-move-line-up", "iso-move-line-down",
4635 "iso-partial-line-up", "iso-partial-line-down",
4636 "iso-partial-space-left", "iso-partial-space-right",
4637 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4638 "iso-release-margin-left", "iso-release-margin-right",
4639 "iso-release-both-margins",
4640 "iso-fast-cursor-left", "iso-fast-cursor-right",
4641 "iso-fast-cursor-up", "iso-fast-cursor-down",
4642 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4643 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4646 #endif /* not HAVE_NTGUI */
4648 Lisp_Object Vlispy_mouse_stem
;
4651 /* mouse-wheel events are generated by the wheel on devices such as
4652 the MS Intellimouse. The wheel sits in between the left and right
4653 mouse buttons, and is typically used to scroll or zoom the window
4654 underneath the pointer. mouse-wheel events specify the object on
4655 which they operate, and a delta corresponding to the amount and
4656 direction that the wheel is rotated. Clicking the mouse-wheel
4657 generates a mouse-2 event. */
4658 static char *lispy_mouse_wheel_names
[] =
4663 #endif /* WINDOWSNT */
4665 /* drag-n-drop events are generated when a set of selected files are
4666 dragged from another application and dropped onto an Emacs window. */
4667 static char *lispy_drag_n_drop_names
[] =
4672 /* Scroll bar parts. */
4673 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4674 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4675 Lisp_Object Qtop
, Qratio
;
4677 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4678 Lisp_Object
*scroll_bar_parts
[] = {
4679 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4680 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4683 /* User signal events. */
4684 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4686 Lisp_Object
*lispy_user_signals
[] =
4688 &Qusr1_signal
, &Qusr2_signal
4692 /* A vector, indexed by button number, giving the down-going location
4693 of currently depressed buttons, both scroll bar and non-scroll bar.
4695 The elements have the form
4696 (BUTTON-NUMBER MODIFIER-MASK . REST)
4697 where REST is the cdr of a position as it would be reported in the event.
4699 The make_lispy_event function stores positions here to tell the
4700 difference between click and drag events, and to store the starting
4701 location to be included in drag events. */
4703 static Lisp_Object button_down_location
;
4705 /* Information about the most recent up-going button event: Which
4706 button, what location, and what time. */
4708 static int last_mouse_button
;
4709 static int last_mouse_x
;
4710 static int last_mouse_y
;
4711 static unsigned long button_down_time
;
4713 /* The maximum time between clicks to make a double-click, or Qnil to
4714 disable double-click detection, or Qt for no time limit. */
4716 Lisp_Object Vdouble_click_time
;
4718 /* Maximum number of pixels the mouse may be moved between clicks
4719 to make a double-click. */
4721 EMACS_INT double_click_fuzz
;
4723 /* The number of clicks in this multiple-click. */
4725 int double_click_count
;
4727 /* Given a struct input_event, build the lisp event which represents
4728 it. If EVENT is 0, build a mouse movement event from the mouse
4729 movement buffer, which should have a movement event in it.
4731 Note that events must be passed to this function in the order they
4732 are received; this function stores the location of button presses
4733 in order to build drag events when the button is released. */
4736 make_lispy_event (event
)
4737 struct input_event
*event
;
4741 switch (SWITCH_ENUM_CAST (event
->kind
))
4743 /* A simple keystroke. */
4744 case ASCII_KEYSTROKE_EVENT
:
4746 Lisp_Object lispy_c
;
4747 int c
= event
->code
& 0377;
4748 /* Turn ASCII characters into control characters
4750 if (event
->modifiers
& ctrl_modifier
)
4751 c
= make_ctrl_char (c
);
4753 /* Add in the other modifier bits. We took care of ctrl_modifier
4754 just above, and the shift key was taken care of by the X code,
4755 and applied to control characters by make_ctrl_char. */
4756 c
|= (event
->modifiers
4757 & (meta_modifier
| alt_modifier
4758 | hyper_modifier
| super_modifier
));
4759 /* Distinguish Shift-SPC from SPC. */
4760 if ((event
->code
& 0377) == 040
4761 && event
->modifiers
& shift_modifier
)
4762 c
|= shift_modifier
;
4763 button_down_time
= 0;
4764 XSETFASTINT (lispy_c
, c
);
4768 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
4770 Lisp_Object lispy_c
;
4772 XSETFASTINT (lispy_c
, event
->code
);
4776 /* A function key. The symbol may need to have modifier prefixes
4778 case NON_ASCII_KEYSTROKE_EVENT
:
4779 button_down_time
= 0;
4781 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
4782 if (event
->code
== lispy_accent_codes
[i
])
4783 return modify_event_symbol (i
,
4785 Qfunction_key
, Qnil
,
4786 lispy_accent_keys
, &accent_key_syms
,
4787 (sizeof (lispy_accent_keys
)
4788 / sizeof (lispy_accent_keys
[0])));
4791 if (event
->code
>= 0x400 && event
->code
< 0x500)
4792 return modify_event_symbol (event
->code
- 0x400,
4793 event
->modifiers
& ~shift_modifier
,
4794 Qfunction_key
, Qnil
,
4795 lispy_kana_keys
, &func_key_syms
,
4796 (sizeof (lispy_kana_keys
)
4797 / sizeof (lispy_kana_keys
[0])));
4798 #endif /* XK_kana_A */
4800 #ifdef ISO_FUNCTION_KEY_OFFSET
4801 if (event
->code
< FUNCTION_KEY_OFFSET
4802 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
4803 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
4805 Qfunction_key
, Qnil
,
4806 iso_lispy_function_keys
, &func_key_syms
,
4807 (sizeof (iso_lispy_function_keys
)
4808 / sizeof (iso_lispy_function_keys
[0])));
4811 /* Handle system-specific or unknown keysyms. */
4812 if (event
->code
& (1 << 28)
4813 || event
->code
- FUNCTION_KEY_OFFSET
< 0
4814 || (event
->code
- FUNCTION_KEY_OFFSET
4815 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
4816 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
4818 /* We need to use an alist rather than a vector as the cache
4819 since we can't make a vector long enuf. */
4820 if (NILP (current_kboard
->system_key_syms
))
4821 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
4822 return modify_event_symbol (event
->code
,
4825 current_kboard
->Vsystem_key_alist
,
4826 0, ¤t_kboard
->system_key_syms
,
4830 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
4832 Qfunction_key
, Qnil
,
4833 lispy_function_keys
, &func_key_syms
,
4834 (sizeof (lispy_function_keys
)
4835 / sizeof (lispy_function_keys
[0])));
4838 /* A mouse click. Figure out where it is, decide whether it's
4839 a press, click or drag, and build the appropriate structure. */
4840 case MOUSE_CLICK_EVENT
:
4841 #ifndef USE_TOOLKIT_SCROLL_BARS
4842 case SCROLL_BAR_CLICK_EVENT
:
4845 int button
= event
->code
;
4847 Lisp_Object position
;
4848 Lisp_Object
*start_pos_ptr
;
4849 Lisp_Object start_pos
;
4854 /* Build the position as appropriate for this mouse click. */
4855 if (event
->kind
== MOUSE_CLICK_EVENT
)
4858 struct frame
*f
= XFRAME (event
->frame_or_window
);
4860 Lisp_Object string_info
= Qnil
;
4863 /* Ignore mouse events that were made on frame that
4864 have been deleted. */
4865 if (! FRAME_LIVE_P (f
))
4868 /* EVENT->x and EVENT->y are frame-relative pixel
4869 coordinates at this place. Under old redisplay, COLUMN
4870 and ROW are set to frame relative glyph coordinates
4871 which are then used to determine whether this click is
4872 in a menu (non-toolkit version). */
4873 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4874 &column
, &row
, NULL
, 1);
4876 #ifndef USE_X_TOOLKIT
4877 /* In the non-toolkit version, clicks on the menu bar
4878 are ordinary button events in the event buffer.
4879 Distinguish them, and invoke the menu.
4881 (In the toolkit version, the toolkit handles the menu bar
4882 and Emacs doesn't know about it until after the user
4883 makes a selection.) */
4884 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
4885 && (event
->modifiers
& down_modifier
))
4887 Lisp_Object items
, item
;
4892 /* Activate the menu bar on the down event. If the
4893 up event comes in before the menu code can deal with it,
4895 if (! (event
->modifiers
& down_modifier
))
4899 /* Find the menu bar item under `column'. */
4901 items
= FRAME_MENU_BAR_ITEMS (f
);
4902 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
4904 Lisp_Object pos
, string
;
4905 string
= AREF (items
, i
+ 1);
4906 pos
= AREF (items
, i
+ 3);
4909 if (column
>= XINT (pos
)
4910 && column
< XINT (pos
) + XSTRING (string
)->size
)
4912 item
= AREF (items
, i
);
4917 /* ELisp manual 2.4b says (x y) are window relative but
4918 code says they are frame-relative. */
4920 = Fcons (event
->frame_or_window
,
4922 Fcons (Fcons (event
->x
, event
->y
),
4923 Fcons (make_number (event
->timestamp
),
4926 return Fcons (item
, Fcons (position
, Qnil
));
4928 #endif /* not USE_X_TOOLKIT */
4930 /* Set `window' to the window under frame pixel coordinates
4931 event->x/event->y. */
4932 window
= window_from_coordinates (f
, XINT (event
->x
),
4933 XINT (event
->y
), &part
, 0);
4935 if (!WINDOWP (window
))
4937 window
= event
->frame_or_window
;
4942 /* It's a click in window window at frame coordinates
4943 event->x/ event->y. */
4944 struct window
*w
= XWINDOW (window
);
4946 /* Get window relative coordinates. Original code
4947 `rounded' this to glyph boundaries. */
4948 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
4949 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
4951 /* Set event coordinates to window-relative coordinates
4952 for constructing the Lisp event below. */
4953 XSETINT (event
->x
, wx
);
4954 XSETINT (event
->y
, wy
);
4956 if (part
== 1 || part
== 3)
4958 /* Mode line or header line. Look for a string under
4959 the mouse that may have a `local-map' property. */
4963 posn
= part
== 1 ? Qmode_line
: Qheader_line
;
4964 string
= mode_line_string (w
, wx
, wy
, part
== 1, &charpos
);
4965 if (STRINGP (string
))
4966 string_info
= Fcons (string
, make_number (charpos
));
4969 posn
= Qvertical_line
;
4970 else if (part
== 6 || part
== 7)
4973 Lisp_Object object
= marginal_area_string (w
, wx
, wy
, part
,
4975 posn
= (part
== 6) ? Qleft_margin
: Qright_margin
;
4976 if (STRINGP (object
))
4977 string_info
= Fcons (object
, make_number (charpos
));
4982 struct display_pos p
;
4983 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
4984 posn
= make_number (CHARPOS (p
.pos
));
4985 if (STRINGP (object
))
4988 make_number (CHARPOS (p
.string_pos
)));
4995 Fcons (Fcons (event
->x
, event
->y
),
4996 Fcons (make_number (event
->timestamp
),
4999 : Fcons (string_info
, Qnil
))))));
5001 #ifndef USE_TOOLKIT_SCROLL_BARS
5004 /* It's a scrollbar click. */
5005 Lisp_Object portion_whole
;
5008 window
= event
->frame_or_window
;
5009 portion_whole
= Fcons (event
->x
, event
->y
);
5010 part
= *scroll_bar_parts
[(int) event
->part
];
5014 Fcons (Qvertical_scroll_bar
,
5015 Fcons (portion_whole
,
5016 Fcons (make_number (event
->timestamp
),
5017 Fcons (part
, Qnil
)))));
5019 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5021 if (button
>= ASIZE (button_down_location
))
5023 button_down_location
= larger_vector (button_down_location
,
5025 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5028 start_pos_ptr
= &AREF (button_down_location
, button
);
5029 start_pos
= *start_pos_ptr
;
5030 *start_pos_ptr
= Qnil
;
5033 /* On window-system frames, use the value of
5034 double-click-fuzz as is. On other frames, interpret it
5035 as a multiple of 1/8 characters. */
5039 if (WINDOWP (event
->frame_or_window
))
5040 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5041 else if (FRAMEP (event
->frame_or_window
))
5042 f
= XFRAME (event
->frame_or_window
);
5046 if (FRAME_WINDOW_P (f
))
5047 fuzz
= double_click_fuzz
;
5049 fuzz
= double_click_fuzz
/ 8;
5051 is_double
= (button
== last_mouse_button
5052 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5053 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5054 && button_down_time
!= 0
5055 && (EQ (Vdouble_click_time
, Qt
)
5056 || (INTEGERP (Vdouble_click_time
)
5057 && ((int)(event
->timestamp
- button_down_time
)
5058 < XINT (Vdouble_click_time
)))));
5061 last_mouse_button
= button
;
5062 last_mouse_x
= XINT (event
->x
);
5063 last_mouse_y
= XINT (event
->y
);
5065 /* If this is a button press, squirrel away the location, so
5066 we can decide later whether it was a click or a drag. */
5067 if (event
->modifiers
& down_modifier
)
5071 double_click_count
++;
5072 event
->modifiers
|= ((double_click_count
> 2)
5077 double_click_count
= 1;
5078 button_down_time
= event
->timestamp
;
5079 *start_pos_ptr
= Fcopy_alist (position
);
5082 /* Now we're releasing a button - check the co-ordinates to
5083 see if this was a click or a drag. */
5084 else if (event
->modifiers
& up_modifier
)
5086 /* If we did not see a down before this up, ignore the up.
5087 Probably this happened because the down event chose a
5088 menu item. It would be an annoyance to treat the
5089 release of the button that chose the menu item as a
5092 if (!CONSP (start_pos
))
5095 event
->modifiers
&= ~up_modifier
;
5096 #if 0 /* Formerly we treated an up with no down as a click event. */
5097 if (!CONSP (start_pos
))
5098 event
->modifiers
|= click_modifier
;
5103 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5105 /* The third element of every position
5106 should be the (x,y) pair. */
5107 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5109 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5111 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5112 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5115 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5116 && ydiff
< double_click_fuzz
5117 && ydiff
> - double_click_fuzz
)
5118 /* Mouse hasn't moved (much). */
5119 event
->modifiers
|= click_modifier
;
5122 button_down_time
= 0;
5123 event
->modifiers
|= drag_modifier
;
5126 /* Don't check is_double; treat this as multiple
5127 if the down-event was multiple. */
5128 if (double_click_count
> 1)
5129 event
->modifiers
|= ((double_click_count
> 2)
5135 /* Every mouse event should either have the down_modifier or
5136 the up_modifier set. */
5140 /* Get the symbol we should use for the mouse click. */
5143 head
= modify_event_symbol (button
,
5145 Qmouse_click
, Vlispy_mouse_stem
,
5148 XVECTOR (mouse_syms
)->size
);
5149 if (event
->modifiers
& drag_modifier
)
5154 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5157 Fcons (make_number (double_click_count
),
5166 #if USE_TOOLKIT_SCROLL_BARS
5168 /* We don't have down and up events if using toolkit scroll bars,
5169 so make this always a click event. Store in the `part' of
5170 the Lisp event a symbol which maps to the following actions:
5172 `above_handle' page up
5173 `below_handle' page down
5177 `bottom' bottom of buffer
5178 `handle' thumb has been dragged.
5179 `end-scroll' end of interaction with scroll bar
5181 The incoming input_event contains in its `part' member an
5182 index of type `enum scroll_bar_part' which we can use as an
5183 index in scroll_bar_parts to get the appropriate symbol. */
5185 case SCROLL_BAR_CLICK_EVENT
:
5187 Lisp_Object position
, head
, window
, portion_whole
, part
;
5189 window
= event
->frame_or_window
;
5190 portion_whole
= Fcons (event
->x
, event
->y
);
5191 part
= *scroll_bar_parts
[(int) event
->part
];
5195 Fcons (Qvertical_scroll_bar
,
5196 Fcons (portion_whole
,
5197 Fcons (make_number (event
->timestamp
),
5198 Fcons (part
, Qnil
)))));
5200 /* Always treat scroll bar events as clicks. */
5201 event
->modifiers
|= click_modifier
;
5203 /* Get the symbol we should use for the mouse click. */
5204 head
= modify_event_symbol (event
->code
,
5209 XVECTOR (mouse_syms
)->size
);
5210 return Fcons (head
, Fcons (position
, Qnil
));
5213 #endif /* USE_TOOLKIT_SCROLL_BARS */
5216 case W32_SCROLL_BAR_CLICK_EVENT
:
5218 int button
= event
->code
;
5220 Lisp_Object position
;
5221 Lisp_Object
*start_pos_ptr
;
5222 Lisp_Object start_pos
;
5226 Lisp_Object portion_whole
;
5229 window
= event
->frame_or_window
;
5230 portion_whole
= Fcons (event
->x
, event
->y
);
5231 part
= *scroll_bar_parts
[(int) event
->part
];
5235 Fcons (Qvertical_scroll_bar
,
5236 Fcons (portion_whole
,
5237 Fcons (make_number (event
->timestamp
),
5238 Fcons (part
, Qnil
)))));
5241 /* Always treat W32 scroll bar events as clicks. */
5242 event
->modifiers
|= click_modifier
;
5245 /* Get the symbol we should use for the mouse click. */
5248 head
= modify_event_symbol (button
,
5253 XVECTOR (mouse_syms
)->size
);
5259 case MOUSE_WHEEL_EVENT
:
5262 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5265 Lisp_Object head
, position
;
5268 /* Ignore mouse events that were made on frame that
5269 have been deleted. */
5270 if (! FRAME_LIVE_P (f
))
5272 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5273 &column
, &row
, NULL
, 1);
5274 window
= window_from_coordinates (f
, XINT (event
->x
),
5275 XINT (event
->y
), &part
, 0);
5277 if (!WINDOWP (window
))
5279 window
= event
->frame_or_window
;
5284 int pixcolumn
, pixrow
;
5285 column
-= XINT (XWINDOW (window
)->left
);
5286 row
-= XINT (XWINDOW (window
)->top
);
5287 glyph_to_pixel_coords (XWINDOW(window
), column
, row
,
5288 &pixcolumn
, &pixrow
);
5289 XSETINT (event
->x
, pixcolumn
);
5290 XSETINT (event
->y
, pixrow
);
5295 posn
= Qvertical_line
;
5297 posn
= Qheader_line
;
5301 struct display_pos p
;
5302 buffer_posn_from_coords (XWINDOW (window
), &column
, &row
,
5304 posn
= make_number (CHARPOS (p
.pos
));
5309 Lisp_Object head
, position
;
5314 Fcons (Fcons (event
->x
, event
->y
),
5315 Fcons (make_number (event
->timestamp
),
5318 head
= modify_event_symbol (0, event
->modifiers
,
5320 lispy_mouse_wheel_names
,
5321 &mouse_wheel_syms
, 1);
5324 /* Insert 1 here so event-click-count works. */
5325 Fcons (make_number (1),
5326 Fcons (make_number (event
->code
),
5330 #endif /* WINDOWSNT */
5332 case DRAG_N_DROP_EVENT
:
5340 /* The frame_or_window field should be a cons of the frame in
5341 which the event occurred and a list of the filenames
5343 if (! CONSP (event
->frame_or_window
))
5346 f
= XFRAME (XCAR (event
->frame_or_window
));
5347 files
= XCDR (event
->frame_or_window
);
5349 /* Ignore mouse events that were made on frames that
5350 have been deleted. */
5351 if (! FRAME_LIVE_P (f
))
5354 window
= window_from_coordinates (f
, XINT (event
->x
),
5355 XINT (event
->y
), &part
, 0);
5357 if (!WINDOWP (window
))
5359 window
= XCAR (event
->frame_or_window
);
5364 /* It's an event in window `window' at frame coordinates
5365 event->x/ event->y. */
5366 struct window
*w
= XWINDOW (window
);
5368 /* Get window relative coordinates. */
5369 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
5370 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
5372 /* Set event coordinates to window-relative coordinates
5373 for constructing the Lisp event below. */
5374 XSETINT (event
->x
, wx
);
5375 XSETINT (event
->y
, wy
);
5380 posn
= Qvertical_line
;
5382 posn
= Qheader_line
;
5386 struct display_pos p
;
5387 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5388 posn
= make_number (CHARPOS (p
.pos
));
5393 Lisp_Object head
, position
;
5398 Fcons (Fcons (event
->x
, event
->y
),
5399 Fcons (make_number (event
->timestamp
),
5402 head
= modify_event_symbol (0, event
->modifiers
,
5404 lispy_drag_n_drop_names
,
5405 &drag_n_drop_syms
, 1);
5412 #endif /* HAVE_MOUSE */
5414 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS)
5415 case MENU_BAR_EVENT
:
5416 if (EQ (event
->arg
, event
->frame_or_window
))
5417 /* This is the prefix key. We translate this to
5418 `(menu_bar)' because the code in keyboard.c for menu
5419 events, which we use, relies on this. */
5420 return Fcons (Qmenu_bar
, Qnil
);
5424 case TOOL_BAR_EVENT
:
5425 if (EQ (event
->arg
, event
->frame_or_window
))
5426 /* This is the prefix key. We translate this to
5427 `(tool_bar)' because the code in keyboard.c for tool bar
5428 events, which we use, relies on this. */
5429 return Fcons (Qtool_bar
, Qnil
);
5430 else if (SYMBOLP (event
->arg
))
5431 return apply_modifiers (event
->modifiers
, event
->arg
);
5434 case USER_SIGNAL_EVENT
:
5435 /* A user signal. */
5436 return *lispy_user_signals
[event
->code
];
5438 case SAVE_SESSION_EVENT
:
5439 return Qsave_session
;
5441 /* The 'kind' field of the event is something we don't recognize. */
5450 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5452 Lisp_Object bar_window
;
5453 enum scroll_bar_part part
;
5457 /* Is it a scroll bar movement? */
5458 if (frame
&& ! NILP (bar_window
))
5460 Lisp_Object part_sym
;
5462 part_sym
= *scroll_bar_parts
[(int) part
];
5463 return Fcons (Qscroll_bar_movement
,
5464 (Fcons (Fcons (bar_window
,
5465 Fcons (Qvertical_scroll_bar
,
5466 Fcons (Fcons (x
, y
),
5467 Fcons (make_number (time
),
5473 /* Or is it an ordinary mouse movement? */
5481 /* It's in a frame; which window on that frame? */
5482 window
= window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
, 0);
5486 if (WINDOWP (window
))
5488 struct window
*w
= XWINDOW (window
);
5491 /* Get window relative coordinates. */
5492 wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (x
));
5493 wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (y
));
5500 posn
= Qvertical_line
;
5502 posn
= Qheader_line
;
5506 struct display_pos p
;
5507 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5508 posn
= make_number (CHARPOS (p
.pos
));
5511 else if (frame
!= 0)
5513 XSETFRAME (window
, frame
);
5524 return Fcons (Qmouse_movement
,
5525 Fcons (Fcons (window
,
5527 Fcons (Fcons (x
, y
),
5528 Fcons (make_number (time
),
5534 #endif /* HAVE_MOUSE */
5536 /* Construct a switch frame event. */
5538 make_lispy_switch_frame (frame
)
5541 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5544 /* Manipulating modifiers. */
5546 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5548 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5549 SYMBOL's name of the end of the modifiers; the string from this
5550 position is the unmodified symbol name.
5552 This doesn't use any caches. */
5555 parse_modifiers_uncached (symbol
, modifier_end
)
5559 struct Lisp_String
*name
;
5563 CHECK_SYMBOL (symbol
);
5566 name
= XSTRING (SYMBOL_NAME (symbol
));
5568 for (i
= 0; i
+2 <= STRING_BYTES (name
); )
5570 int this_mod_end
= 0;
5573 /* See if the name continues with a modifier word.
5574 Check that the word appears, but don't check what follows it.
5575 Set this_mod and this_mod_end to record what we find. */
5577 switch (name
->data
[i
])
5579 #define SINGLE_LETTER_MOD(BIT) \
5580 (this_mod_end = i + 1, this_mod = BIT)
5583 SINGLE_LETTER_MOD (alt_modifier
);
5587 SINGLE_LETTER_MOD (ctrl_modifier
);
5591 SINGLE_LETTER_MOD (hyper_modifier
);
5595 SINGLE_LETTER_MOD (meta_modifier
);
5599 SINGLE_LETTER_MOD (shift_modifier
);
5603 SINGLE_LETTER_MOD (super_modifier
);
5606 #undef SINGLE_LETTER_MOD
5609 /* If we found no modifier, stop looking for them. */
5610 if (this_mod_end
== 0)
5613 /* Check there is a dash after the modifier, so that it
5614 really is a modifier. */
5615 if (this_mod_end
>= STRING_BYTES (name
)
5616 || name
->data
[this_mod_end
] != '-')
5619 /* This modifier is real; look for another. */
5620 modifiers
|= this_mod
;
5621 i
= this_mod_end
+ 1;
5624 /* Should we include the `click' modifier? */
5625 if (! (modifiers
& (down_modifier
| drag_modifier
5626 | double_modifier
| triple_modifier
))
5627 && i
+ 7 == STRING_BYTES (name
)
5628 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
5629 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
5630 modifiers
|= click_modifier
;
5638 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5639 prepended to the string BASE[0..BASE_LEN-1].
5640 This doesn't use any caches. */
5642 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5645 int base_len
, base_len_byte
;
5647 /* Since BASE could contain nulls, we can't use intern here; we have
5648 to use Fintern, which expects a genuine Lisp_String, and keeps a
5651 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5657 /* Only the event queue may use the `up' modifier; it should always
5658 be turned into a click or drag event before presented to lisp code. */
5659 if (modifiers
& up_modifier
)
5662 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5663 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5664 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5665 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5666 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5667 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5668 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5669 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5670 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5671 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5672 /* The click modifier is denoted by the absence of other modifiers. */
5676 mod_len
= p
- new_mods
;
5680 Lisp_Object new_name
;
5682 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
5683 mod_len
+ base_len_byte
);
5684 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
5685 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len_byte
);
5687 return Fintern (new_name
, Qnil
);
5692 static char *modifier_names
[] =
5694 "up", "down", "drag", "click", "double", "triple", 0, 0,
5695 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5696 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
5698 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
5700 static Lisp_Object modifier_symbols
;
5702 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5704 lispy_modifier_list (modifiers
)
5707 Lisp_Object modifier_list
;
5710 modifier_list
= Qnil
;
5711 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
5712 if (modifiers
& (1<<i
))
5713 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
5716 return modifier_list
;
5720 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
5721 where UNMODIFIED is the unmodified form of SYMBOL,
5722 MASK is the set of modifiers present in SYMBOL's name.
5723 This is similar to parse_modifiers_uncached, but uses the cache in
5724 SYMBOL's Qevent_symbol_element_mask property, and maintains the
5725 Qevent_symbol_elements property. */
5728 parse_modifiers (symbol
)
5731 Lisp_Object elements
;
5733 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
5734 if (CONSP (elements
))
5739 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
5740 Lisp_Object unmodified
;
5743 unmodified
= Fintern (make_string (XSTRING (SYMBOL_NAME (symbol
))->data
+ end
,
5744 STRING_BYTES (XSTRING (SYMBOL_NAME (symbol
))) - end
),
5747 if (modifiers
& ~VALMASK
)
5749 XSETFASTINT (mask
, modifiers
);
5750 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
5752 /* Cache the parsing results on SYMBOL. */
5753 Fput (symbol
, Qevent_symbol_element_mask
,
5755 Fput (symbol
, Qevent_symbol_elements
,
5756 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
5758 /* Since we know that SYMBOL is modifiers applied to unmodified,
5759 it would be nice to put that in unmodified's cache.
5760 But we can't, since we're not sure that parse_modifiers is
5767 /* Apply the modifiers MODIFIERS to the symbol BASE.
5768 BASE must be unmodified.
5770 This is like apply_modifiers_uncached, but uses BASE's
5771 Qmodifier_cache property, if present. It also builds
5772 Qevent_symbol_elements properties, since it has that info anyway.
5774 apply_modifiers copies the value of BASE's Qevent_kind property to
5775 the modified symbol. */
5777 apply_modifiers (modifiers
, base
)
5781 Lisp_Object cache
, index
, entry
, new_symbol
;
5783 /* Mask out upper bits. We don't know where this value's been. */
5784 modifiers
&= VALMASK
;
5786 /* The click modifier never figures into cache indices. */
5787 cache
= Fget (base
, Qmodifier_cache
);
5788 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
5789 entry
= assq_no_quit (index
, cache
);
5792 new_symbol
= XCDR (entry
);
5795 /* We have to create the symbol ourselves. */
5796 new_symbol
= apply_modifiers_uncached (modifiers
,
5797 XSTRING (SYMBOL_NAME (base
))->data
,
5798 XSTRING (SYMBOL_NAME (base
))->size
,
5799 STRING_BYTES (XSTRING (SYMBOL_NAME (base
))));
5801 /* Add the new symbol to the base's cache. */
5802 entry
= Fcons (index
, new_symbol
);
5803 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
5805 /* We have the parsing info now for free, so add it to the caches. */
5806 XSETFASTINT (index
, modifiers
);
5807 Fput (new_symbol
, Qevent_symbol_element_mask
,
5808 Fcons (base
, Fcons (index
, Qnil
)));
5809 Fput (new_symbol
, Qevent_symbol_elements
,
5810 Fcons (base
, lispy_modifier_list (modifiers
)));
5813 /* Make sure this symbol is of the same kind as BASE.
5815 You'd think we could just set this once and for all when we
5816 intern the symbol above, but reorder_modifiers may call us when
5817 BASE's property isn't set right; we can't assume that just
5818 because it has a Qmodifier_cache property it must have its
5819 Qevent_kind set right as well. */
5820 if (NILP (Fget (new_symbol
, Qevent_kind
)))
5824 kind
= Fget (base
, Qevent_kind
);
5826 Fput (new_symbol
, Qevent_kind
, kind
);
5833 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
5834 return a symbol with the modifiers placed in the canonical order.
5835 Canonical order is alphabetical, except for down and drag, which
5836 always come last. The 'click' modifier is never written out.
5838 Fdefine_key calls this to make sure that (for example) C-M-foo
5839 and M-C-foo end up being equivalent in the keymap. */
5842 reorder_modifiers (symbol
)
5845 /* It's hopefully okay to write the code this way, since everything
5846 will soon be in caches, and no consing will be done at all. */
5849 parsed
= parse_modifiers (symbol
);
5850 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
5855 /* For handling events, we often want to produce a symbol whose name
5856 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
5857 to some base, like the name of a function key or mouse button.
5858 modify_event_symbol produces symbols of this sort.
5860 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
5861 is the name of the i'th symbol. TABLE_SIZE is the number of elements
5864 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
5865 into symbol names, or a string specifying a name stem used to
5866 construct a symbol name or the form `STEM-N', where N is the decimal
5867 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
5868 non-nil; otherwise NAME_TABLE is used.
5870 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
5871 persist between calls to modify_event_symbol that it can use to
5872 store a cache of the symbols it's generated for this NAME_TABLE
5873 before. The object stored there may be a vector or an alist.
5875 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
5877 MODIFIERS is a set of modifier bits (as given in struct input_events)
5878 whose prefixes should be applied to the symbol name.
5880 SYMBOL_KIND is the value to be placed in the event_kind property of
5881 the returned symbol.
5883 The symbols we create are supposed to have an
5884 `event-symbol-elements' property, which lists the modifiers present
5885 in the symbol's name. */
5888 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
5889 name_table
, symbol_table
, table_size
)
5892 Lisp_Object symbol_kind
;
5893 Lisp_Object name_alist_or_stem
;
5895 Lisp_Object
*symbol_table
;
5896 unsigned int table_size
;
5899 Lisp_Object symbol_int
;
5901 /* Get rid of the "vendor-specific" bit here. */
5902 XSETINT (symbol_int
, symbol_num
& 0xffffff);
5904 /* Is this a request for a valid symbol? */
5905 if (symbol_num
< 0 || symbol_num
>= table_size
)
5908 if (CONSP (*symbol_table
))
5909 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
5911 /* If *symbol_table doesn't seem to be initialized properly, fix that.
5912 *symbol_table should be a lisp vector TABLE_SIZE elements long,
5913 where the Nth element is the symbol for NAME_TABLE[N], or nil if
5914 we've never used that symbol before. */
5917 if (! VECTORP (*symbol_table
)
5918 || XVECTOR (*symbol_table
)->size
!= table_size
)
5922 XSETFASTINT (size
, table_size
);
5923 *symbol_table
= Fmake_vector (size
, Qnil
);
5926 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
5929 /* Have we already used this symbol before? */
5932 /* No; let's create it. */
5933 if (CONSP (name_alist_or_stem
))
5934 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
5935 else if (STRINGP (name_alist_or_stem
))
5937 int len
= STRING_BYTES (XSTRING (name_alist_or_stem
));
5938 char *buf
= (char *) alloca (len
+ 50);
5939 sprintf (buf
, "%s-%d", XSTRING (name_alist_or_stem
)->data
,
5940 XINT (symbol_int
) + 1);
5941 value
= intern (buf
);
5943 else if (name_table
!= 0 && name_table
[symbol_num
])
5944 value
= intern (name_table
[symbol_num
]);
5946 #ifdef HAVE_WINDOW_SYSTEM
5949 char *name
= x_get_keysym_name (symbol_num
);
5951 value
= intern (name
);
5958 sprintf (buf
, "key-%d", symbol_num
);
5959 value
= intern (buf
);
5962 if (CONSP (*symbol_table
))
5963 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
5965 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
5967 /* Fill in the cache entries for this symbol; this also
5968 builds the Qevent_symbol_elements property, which the user
5970 apply_modifiers (modifiers
& click_modifier
, value
);
5971 Fput (value
, Qevent_kind
, symbol_kind
);
5974 /* Apply modifiers to that symbol. */
5975 return apply_modifiers (modifiers
, value
);
5978 /* Convert a list that represents an event type,
5979 such as (ctrl meta backspace), into the usual representation of that
5980 event type as a number or a symbol. */
5982 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
5983 doc
: /* Convert the event description list EVENT-DESC to an event type.
5984 EVENT-DESC should contain one base event type (a character or symbol)
5985 and zero or more modifier names (control, meta, hyper, super, shift, alt,
5986 drag, down, double or triple). The base must be last.
5987 The return value is an event type (a character or symbol) which
5988 has the same base event type and all the specified modifiers. */)
5990 Lisp_Object event_desc
;
5998 while (CONSP (rest
))
6006 /* Given a symbol, see if it is a modifier name. */
6007 if (SYMBOLP (elt
) && CONSP (rest
))
6008 this = parse_solitary_modifier (elt
);
6012 else if (!NILP (base
))
6013 error ("Two bases given in one event");
6019 /* Let the symbol A refer to the character A. */
6020 if (SYMBOLP (base
) && XSTRING (SYMBOL_NAME (base
))->size
== 1)
6021 XSETINT (base
, XSTRING (SYMBOL_NAME (base
))->data
[0]);
6023 if (INTEGERP (base
))
6025 /* Turn (shift a) into A. */
6026 if ((modifiers
& shift_modifier
) != 0
6027 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6029 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6030 modifiers
&= ~shift_modifier
;
6033 /* Turn (control a) into C-a. */
6034 if (modifiers
& ctrl_modifier
)
6035 return make_number ((modifiers
& ~ctrl_modifier
)
6036 | make_ctrl_char (XINT (base
)));
6038 return make_number (modifiers
| XINT (base
));
6040 else if (SYMBOLP (base
))
6041 return apply_modifiers (modifiers
, base
);
6044 error ("Invalid base event");
6049 /* Try to recognize SYMBOL as a modifier name.
6050 Return the modifier flag bit, or 0 if not recognized. */
6053 parse_solitary_modifier (symbol
)
6056 struct Lisp_String
*name
= XSTRING (SYMBOL_NAME (symbol
));
6058 switch (name
->data
[0])
6060 #define SINGLE_LETTER_MOD(BIT) \
6061 if (STRING_BYTES (name) == 1) \
6064 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6065 if (LEN == STRING_BYTES (name) \
6066 && ! strncmp (name->data, NAME, LEN)) \
6070 SINGLE_LETTER_MOD (alt_modifier
);
6074 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6078 SINGLE_LETTER_MOD (ctrl_modifier
);
6082 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6083 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6087 SINGLE_LETTER_MOD (hyper_modifier
);
6091 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6095 SINGLE_LETTER_MOD (meta_modifier
);
6099 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6103 SINGLE_LETTER_MOD (shift_modifier
);
6107 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6108 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6109 SINGLE_LETTER_MOD (super_modifier
);
6113 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6114 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6115 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6119 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6122 #undef SINGLE_LETTER_MOD
6123 #undef MULTI_LETTER_MOD
6129 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6130 Such a list is not valid as an event,
6131 but it can be a Lucid-style event type list. */
6134 lucid_event_type_list_p (object
)
6139 if (! CONSP (object
))
6142 if (EQ (XCAR (object
), Qhelp_echo
)
6143 || EQ (XCAR (object
), Qvertical_line
)
6144 || EQ (XCAR (object
), Qmode_line
)
6145 || EQ (XCAR (object
), Qheader_line
))
6148 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6152 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6159 /* Store into *addr a value nonzero if terminal input chars are available.
6160 Serves the purpose of ioctl (0, FIONREAD, addr)
6161 but works even if FIONREAD does not exist.
6162 (In fact, this may actually read some input.)
6164 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6165 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6168 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6173 /* First of all, have we already counted some input? */
6174 *addr
= (!NILP (Vquit_flag
)
6175 || readable_filtered_events (do_timers_now
, filter_events
));
6177 /* If input is being read as it arrives, and we have none, there is none. */
6178 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6181 /* Try to read some input and see how much we get. */
6183 *addr
= (!NILP (Vquit_flag
)
6184 || readable_filtered_events (do_timers_now
, filter_events
));
6187 /* Store into *addr a value nonzero if terminal input chars are available.
6188 Serves the purpose of ioctl (0, FIONREAD, addr)
6189 but works even if FIONREAD does not exist.
6190 (In fact, this may actually read some input.)
6192 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6195 get_input_pending (addr
, do_timers_now
)
6199 get_filtered_input_pending (addr
, do_timers_now
, 0);
6202 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6205 gobble_input (expected
)
6210 if (interrupt_input
)
6213 mask
= sigblock (sigmask (SIGIO
));
6214 read_avail_input (expected
);
6218 #ifdef POLL_FOR_INPUT
6219 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6222 mask
= sigblock (sigmask (SIGALRM
));
6223 read_avail_input (expected
);
6229 read_avail_input (expected
);
6233 /* Put a BUFFER_SWITCH_EVENT in the buffer
6234 so that read_key_sequence will notice the new current buffer. */
6237 record_asynch_buffer_change ()
6239 struct input_event event
;
6242 event
.kind
= BUFFER_SWITCH_EVENT
;
6243 event
.frame_or_window
= Qnil
;
6247 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6248 The purpose of the event is to make read_key_sequence look up the
6249 keymaps again. If we aren't in read_key_sequence, we don't need one,
6250 and the event could cause trouble by messing up (input-pending-p). */
6251 tem
= Fwaiting_for_user_input_p ();
6255 /* We never need these events if we have no asynchronous subprocesses. */
6259 /* Make sure no interrupt happens while storing the event. */
6261 if (interrupt_input
)
6264 mask
= sigblock (sigmask (SIGIO
));
6265 kbd_buffer_store_event (&event
);
6272 kbd_buffer_store_event (&event
);
6279 /* Read any terminal input already buffered up by the system
6280 into the kbd_buffer, but do not wait.
6282 EXPECTED should be nonzero if the caller knows there is some input.
6284 Except on VMS, all input is read by this function.
6285 If interrupt_input is nonzero, this function MUST be called
6286 only when SIGIO is blocked.
6288 Returns the number of keyboard chars read, or -1 meaning
6289 this is a bad time to try to read input. */
6292 read_avail_input (expected
)
6295 struct input_event buf
[KBD_BUFFER_SIZE
];
6299 if (read_socket_hook
)
6300 /* No need for FIONREAD or fcntl; just say don't wait. */
6301 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
6304 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6305 the kbd_buffer can really hold. That may prevent loss
6306 of characters on some systems when input is stuffed at us. */
6307 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6310 /* Determine how many characters we should *try* to read. */
6313 #else /* not WINDOWSNT */
6315 n_to_read
= dos_keysns ();
6318 #else /* not MSDOS */
6320 /* Find out how much input is available. */
6321 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6322 /* Formerly simply reported no input, but that sometimes led to
6323 a failure of Emacs to terminate.
6324 SIGHUP seems appropriate if we can't reach the terminal. */
6325 /* ??? Is it really right to send the signal just to this process
6326 rather than to the whole process group?
6327 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6328 kill (getpid (), SIGHUP
);
6331 if (n_to_read
> sizeof cbuf
)
6332 n_to_read
= sizeof cbuf
;
6333 #else /* no FIONREAD */
6334 #if defined (USG) || defined (DGUX)
6335 /* Read some input if available, but don't wait. */
6336 n_to_read
= sizeof cbuf
;
6337 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6342 #endif /* not MSDOS */
6343 #endif /* not WINDOWSNT */
6345 /* Now read; for one reason or another, this will not block.
6346 NREAD is set to the number of chars read. */
6350 cbuf
[0] = dos_keyread ();
6353 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6355 /* POSIX infers that processes which are not in the session leader's
6356 process group won't get SIGHUP's at logout time. BSDI adheres to
6357 this part standard and returns -1 from read (0) with errno==EIO
6358 when the control tty is taken away.
6359 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6360 if (nread
== -1 && errno
== EIO
)
6362 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6363 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6364 This looks incorrect, but it isn't, because _BSD causes
6365 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6366 and that causes a value other than 0 when there is no input. */
6372 /* We used to retry the read if it was interrupted.
6373 But this does the wrong thing when O_NDELAY causes
6374 an EAGAIN error. Does anybody know of a situation
6375 where a retry is actually needed? */
6377 nread
< 0 && (errno
== EAGAIN
6391 #if defined (USG) || defined (DGUX)
6392 fcntl (input_fd
, F_SETFL
, 0);
6393 #endif /* USG or DGUX */
6394 #endif /* no FIONREAD */
6395 for (i
= 0; i
< nread
; i
++)
6397 buf
[i
].kind
= ASCII_KEYSTROKE_EVENT
;
6398 buf
[i
].modifiers
= 0;
6399 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6400 buf
[i
].modifiers
= meta_modifier
;
6404 buf
[i
].code
= cbuf
[i
];
6405 buf
[i
].frame_or_window
= selected_frame
;
6410 /* Scan the chars for C-g and store them in kbd_buffer. */
6411 for (i
= 0; i
< nread
; i
++)
6413 kbd_buffer_store_event (&buf
[i
]);
6414 /* Don't look at input that follows a C-g too closely.
6415 This reduces lossage due to autorepeat on C-g. */
6416 if (buf
[i
].kind
== ASCII_KEYSTROKE_EVENT
6417 && buf
[i
].code
== quit_char
)
6423 #endif /* not VMS */
6425 #ifdef SIGIO /* for entire page */
6426 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6429 input_available_signal (signo
)
6432 /* Must preserve main program's value of errno. */
6433 int old_errno
= errno
;
6435 extern int select_alarmed
;
6438 #if defined (USG) && !defined (POSIX_SIGNALS)
6439 /* USG systems forget handlers when they are used;
6440 must reestablish each time */
6441 signal (signo
, input_available_signal
);
6448 if (input_available_clear_time
)
6449 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6454 nread
= read_avail_input (1);
6455 /* -1 means it's not ok to read the input now.
6456 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6457 0 means there was no keyboard input available. */
6462 select_alarmed
= 1; /* Force the select emulator back to life */
6473 /* Send ourselves a SIGIO.
6475 This function exists so that the UNBLOCK_INPUT macro in
6476 blockinput.h can have some way to take care of input we put off
6477 dealing with, without assuming that every file which uses
6478 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6480 reinvoke_input_signal ()
6483 kill (getpid (), SIGIO
);
6489 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
6490 static void menu_bar_one_keymap
P_ ((Lisp_Object
));
6492 /* These variables hold the vector under construction within
6493 menu_bar_items and its subroutines, and the current index
6494 for storing into that vector. */
6495 static Lisp_Object menu_bar_items_vector
;
6496 static int menu_bar_items_index
;
6498 /* Return a vector of menu items for a menu bar, appropriate
6499 to the current buffer. Each item has three elements in the vector:
6502 OLD is an old vector we can optionally reuse, or nil. */
6505 menu_bar_items (old
)
6508 /* The number of keymaps we're scanning right now, and the number of
6509 keymaps we have allocated space for. */
6512 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6513 in the current keymaps, or nil where it is not a prefix. */
6516 Lisp_Object def
, tail
;
6525 struct gcpro gcpro1
;
6527 /* In order to build the menus, we need to call the keymap
6528 accessors. They all call QUIT. But this function is called
6529 during redisplay, during which a quit is fatal. So inhibit
6530 quitting while building the menus.
6531 We do this instead of specbind because (1) errors will clear it anyway
6532 and (2) this avoids risk of specpdl overflow. */
6533 oquit
= Vinhibit_quit
;
6537 menu_bar_items_vector
= old
;
6539 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6540 menu_bar_items_index
= 0;
6542 GCPRO1 (menu_bar_items_vector
);
6544 /* Build our list of keymaps.
6545 If we recognize a function key and replace its escape sequence in
6546 keybuf with its symbol, or if the sequence starts with a mouse
6547 click and we need to switch buffers, we jump back here to rebuild
6548 the initial keymaps from the current buffer. */
6552 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6553 if (!NILP (Voverriding_local_map_menu_flag
))
6555 /* Yes, use them (if non-nil) as well as the global map. */
6556 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6558 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6559 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6560 if (!NILP (Voverriding_local_map
))
6561 maps
[nmaps
++] = Voverriding_local_map
;
6565 /* No, so use major and minor mode keymaps and keymap property.
6566 Note that menu-bar bindings in the local-map and keymap
6567 properties may not work reliable, as they are only
6568 recognized when the menu-bar (or mode-line) is updated,
6569 which does not normally happen after every command. */
6572 nminor
= current_minor_maps (NULL
, &tmaps
);
6573 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6575 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6576 maps
[nmaps
++] = tem
;
6577 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6579 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6581 maps
[nmaps
++] = current_global_map
;
6584 /* Look up in each map the dummy prefix key `menu-bar'. */
6588 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6589 if (!NILP (maps
[mapno
]))
6591 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6594 menu_bar_one_keymap (def
);
6597 /* Move to the end those items that should be at the end. */
6599 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6602 int end
= menu_bar_items_index
;
6604 for (i
= 0; i
< end
; i
+= 4)
6605 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6607 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6608 /* Move the item at index I to the end,
6609 shifting all the others forward. */
6610 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6611 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6612 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6613 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6615 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6616 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6617 (end
- i
- 4) * sizeof (Lisp_Object
));
6618 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6619 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6620 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6621 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6626 /* Add nil, nil, nil, nil at the end. */
6627 i
= menu_bar_items_index
;
6628 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6631 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6632 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6633 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6634 menu_bar_items_vector
= tem
;
6636 /* Add this item. */
6637 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6638 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6639 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6640 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6641 menu_bar_items_index
= i
;
6643 Vinhibit_quit
= oquit
;
6645 return menu_bar_items_vector
;
6648 /* Scan one map KEYMAP, accumulating any menu items it defines
6649 in menu_bar_items_vector. */
6651 static Lisp_Object menu_bar_one_keymap_changed_items
;
6654 menu_bar_one_keymap (keymap
)
6657 Lisp_Object tail
, item
;
6659 menu_bar_one_keymap_changed_items
= Qnil
;
6661 /* Loop over all keymap entries that have menu strings. */
6662 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
6666 menu_bar_item (XCAR (item
), XCDR (item
));
6667 else if (VECTORP (item
))
6669 /* Loop over the char values represented in the vector. */
6670 int len
= XVECTOR (item
)->size
;
6672 for (c
= 0; c
< len
; c
++)
6674 Lisp_Object character
;
6675 XSETFASTINT (character
, c
);
6676 menu_bar_item (character
, XVECTOR (item
)->contents
[c
]);
6682 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
6683 If there's already an item for KEY, add this DEF to it. */
6685 Lisp_Object item_properties
;
6688 menu_bar_item (key
, item
)
6689 Lisp_Object key
, item
;
6691 struct gcpro gcpro1
;
6695 if (EQ (item
, Qundefined
))
6697 /* If a map has an explicit `undefined' as definition,
6698 discard any previously made menu bar item. */
6700 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6701 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6703 if (menu_bar_items_index
> i
+ 4)
6704 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6705 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6706 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
6707 menu_bar_items_index
-= 4;
6711 /* If this keymap has already contributed to this KEY,
6712 don't contribute to it a second time. */
6713 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
6714 if (!NILP (tem
) || NILP (item
))
6717 menu_bar_one_keymap_changed_items
6718 = Fcons (key
, menu_bar_one_keymap_changed_items
);
6720 /* We add to menu_bar_one_keymap_changed_items before doing the
6721 parse_menu_item, so that if it turns out it wasn't a menu item,
6722 it still correctly hides any further menu item. */
6724 i
= parse_menu_item (item
, 0, 1);
6729 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6731 /* Find any existing item for this KEY. */
6732 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6733 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6736 /* If we did not find this KEY, add it at the end. */
6737 if (i
== menu_bar_items_index
)
6739 /* If vector is too small, get a bigger one. */
6740 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6743 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6744 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6745 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6746 menu_bar_items_vector
= tem
;
6749 /* Add this item. */
6750 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
6751 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
6752 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
6753 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
6754 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
6755 menu_bar_items_index
= i
;
6757 /* We did find an item for this KEY. Add ITEM to its list of maps. */
6761 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6762 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (item
, old
);
6766 /* This is used as the handler when calling menu_item_eval_property. */
6768 menu_item_eval_property_1 (arg
)
6771 /* If we got a quit from within the menu computation,
6772 quit all the way out of it. This takes care of C-] in the debugger. */
6773 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
6774 Fsignal (Qquit
, Qnil
);
6779 /* Evaluate an expression and return the result (or nil if something
6780 went wrong). Used to evaluate dynamic parts of menu items. */
6782 menu_item_eval_property (sexpr
)
6785 int count
= specpdl_ptr
- specpdl
;
6787 specbind (Qinhibit_redisplay
, Qt
);
6788 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
6789 menu_item_eval_property_1
);
6790 return unbind_to (count
, val
);
6793 /* This function parses a menu item and leaves the result in the
6794 vector item_properties.
6795 ITEM is a key binding, a possible menu item.
6796 If NOTREAL is nonzero, only check for equivalent key bindings, don't
6797 evaluate dynamic expressions in the menu item.
6798 INMENUBAR is > 0 when this is considered for an entry in a menu bar
6800 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
6801 parse_menu_item returns true if the item is a menu item and false
6805 parse_menu_item (item
, notreal
, inmenubar
)
6807 int notreal
, inmenubar
;
6809 Lisp_Object def
, tem
, item_string
, start
;
6810 Lisp_Object cachelist
;
6812 Lisp_Object keyhint
;
6823 /* Create item_properties vector if necessary. */
6824 if (NILP (item_properties
))
6826 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
6828 /* Initialize optional entries. */
6829 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
6830 AREF (item_properties
, i
) = Qnil
;
6831 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
6833 /* Save the item here to protect it from GC. */
6834 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
6836 item_string
= XCAR (item
);
6840 if (STRINGP (item_string
))
6842 /* Old format menu item. */
6843 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
6845 /* Maybe help string. */
6846 if (CONSP (item
) && STRINGP (XCAR (item
)))
6848 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
6853 /* Maybe key binding cache. */
6854 if (CONSP (item
) && CONSP (XCAR (item
))
6855 && (NILP (XCAR (XCAR (item
)))
6856 || VECTORP (XCAR (XCAR (item
)))))
6858 cachelist
= XCAR (item
);
6862 /* This is the real definition--the function to run. */
6863 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
6865 /* Get enable property, if any. */
6868 tem
= Fget (item
, Qmenu_enable
);
6870 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
6873 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
6875 /* New format menu item. */
6876 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
6877 start
= XCDR (item
);
6880 /* We have a real binding. */
6881 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
6883 item
= XCDR (start
);
6884 /* Is there a cache list with key equivalences. */
6885 if (CONSP (item
) && CONSP (XCAR (item
)))
6887 cachelist
= XCAR (item
);
6891 /* Parse properties. */
6892 while (CONSP (item
) && CONSP (XCDR (item
)))
6897 if (EQ (tem
, QCenable
))
6898 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
6899 else if (EQ (tem
, QCvisible
) && !notreal
)
6901 /* If got a visible property and that evaluates to nil
6902 then ignore this item. */
6903 tem
= menu_item_eval_property (XCAR (item
));
6907 else if (EQ (tem
, QChelp
))
6908 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
6909 else if (EQ (tem
, QCfilter
))
6911 else if (EQ (tem
, QCkey_sequence
))
6914 if (NILP (cachelist
)
6915 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
6916 /* Be GC protected. Set keyhint to item instead of tem. */
6919 else if (EQ (tem
, QCkeys
))
6922 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
6923 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
6925 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
6930 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
6932 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
6934 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
6941 else if (inmenubar
|| !NILP (start
))
6945 return 0; /* not a menu item */
6947 /* If item string is not a string, evaluate it to get string.
6948 If we don't get a string, skip this item. */
6949 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
6950 if (!(STRINGP (item_string
) || notreal
))
6952 item_string
= menu_item_eval_property (item_string
);
6953 if (!STRINGP (item_string
))
6955 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
6958 /* If got a filter apply it on definition. */
6959 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
6962 def
= menu_item_eval_property (list2 (XCAR (filter
),
6963 list2 (Qquote
, def
)));
6965 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
6968 /* Enable or disable selection of item. */
6969 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
6975 tem
= menu_item_eval_property (tem
);
6976 if (inmenubar
&& NILP (tem
))
6977 return 0; /* Ignore disabled items in menu bar. */
6978 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
6981 /* If we got no definition, this item is just unselectable text which
6982 is OK in a submenu but not in the menubar. */
6984 return (inmenubar
? 0 : 1);
6986 /* See if this is a separate pane or a submenu. */
6987 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
6988 tem
= get_keymap (def
, 0, 1);
6989 /* For a subkeymap, just record its details and exit. */
6992 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
6993 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
6997 /* At the top level in the menu bar, do likewise for commands also.
6998 The menu bar does not display equivalent key bindings anyway.
6999 ITEM_PROPERTY_DEF is already set up properly. */
7003 /* This is a command. See if there is an equivalent key binding. */
7004 if (NILP (cachelist
))
7006 /* We have to create a cachelist. */
7007 CHECK_IMPURE (start
);
7008 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7009 cachelist
= XCAR (XCDR (start
));
7011 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7012 if (!NILP (keyhint
))
7014 XSETCAR (cachelist
, XCAR (keyhint
));
7017 else if (STRINGP (tem
))
7019 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7020 XSETCAR (cachelist
, Qt
);
7024 tem
= XCAR (cachelist
);
7031 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7033 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7036 def
= XCAR (prefix
);
7037 prefix
= XCDR (prefix
);
7040 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7042 if (!update_menu_bindings
)
7044 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7046 if (newcache
/* Always check first time. */
7047 /* Should we check everything when precomputing key
7049 /* If something had no key binding before, don't recheck it
7050 because that is too slow--except if we have a list of
7051 rebound commands in Vdefine_key_rebound_commands, do
7052 recheck any command that appears in that list. */
7053 || (CONSP (Vdefine_key_rebound_commands
)
7054 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7057 /* We had a saved key. Is it still bound to the command? */
7060 /* If the command is an alias for another
7061 (such as lmenu.el set it up), check if the
7062 original command matches the cached command. */
7063 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7064 chkcache
= 1; /* Need to recompute key binding. */
7068 /* Recompute equivalent key binding. If the command is an alias
7069 for another (such as lmenu.el set it up), see if the original
7070 command name has equivalent keys. Otherwise look up the
7071 specified command itself. We don't try both, because that
7072 makes lmenu menus slow. */
7074 && SYMBOLP (XSYMBOL (def
)->function
)
7075 && ! NILP (Fget (def
, Qmenu_alias
)))
7076 def
= XSYMBOL (def
)->function
;
7077 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7078 XSETCAR (cachelist
, tem
);
7081 XSETCDR (cachelist
, Qnil
);
7085 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7087 tem
= XCAR (cachelist
);
7091 newcache
= chkcache
;
7094 tem
= Fkey_description (tem
);
7097 if (STRINGP (XCAR (prefix
)))
7098 tem
= concat2 (XCAR (prefix
), tem
);
7099 if (STRINGP (XCDR (prefix
)))
7100 tem
= concat2 (tem
, XCDR (prefix
));
7102 XSETCDR (cachelist
, tem
);
7106 tem
= XCDR (cachelist
);
7107 if (newcache
&& !NILP (tem
))
7109 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7110 XSETCDR (cachelist
, tem
);
7113 /* If we only want to precompute equivalent key bindings, stop here. */
7117 /* If we have an equivalent key binding, use that. */
7118 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7120 /* Include this when menu help is implemented.
7121 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7122 if (!(NILP (tem) || STRINGP (tem)))
7124 tem = menu_item_eval_property (tem);
7127 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7131 /* Handle radio buttons or toggle boxes. */
7132 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7134 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7135 = menu_item_eval_property (tem
);
7142 /***********************************************************************
7144 ***********************************************************************/
7146 /* A vector holding tool bar items while they are parsed in function
7147 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7150 static Lisp_Object tool_bar_items_vector
;
7152 /* A vector holding the result of parse_tool_bar_item. Layout is like
7153 the one for a single item in tool_bar_items_vector. */
7155 static Lisp_Object tool_bar_item_properties
;
7157 /* Next free index in tool_bar_items_vector. */
7159 static int ntool_bar_items
;
7161 /* The symbols `tool-bar', and `:image'. */
7163 extern Lisp_Object Qtool_bar
;
7164 Lisp_Object QCimage
;
7166 /* Function prototypes. */
7168 static void init_tool_bar_items
P_ ((Lisp_Object
));
7169 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7170 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7171 static void append_tool_bar_item
P_ ((void));
7174 /* Return a vector of tool bar items for keymaps currently in effect.
7175 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7176 tool bar items found. */
7179 tool_bar_items (reuse
, nitems
)
7190 /* In order to build the menus, we need to call the keymap
7191 accessors. They all call QUIT. But this function is called
7192 during redisplay, during which a quit is fatal. So inhibit
7193 quitting while building the menus. We do this instead of
7194 specbind because (1) errors will clear it anyway and (2) this
7195 avoids risk of specpdl overflow. */
7196 oquit
= Vinhibit_quit
;
7199 /* Initialize tool_bar_items_vector and protect it from GC. */
7200 init_tool_bar_items (reuse
);
7202 /* Build list of keymaps in maps. Set nmaps to the number of maps
7205 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7206 if (!NILP (Voverriding_local_map_menu_flag
))
7208 /* Yes, use them (if non-nil) as well as the global map. */
7209 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7211 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7212 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7213 if (!NILP (Voverriding_local_map
))
7214 maps
[nmaps
++] = Voverriding_local_map
;
7218 /* No, so use major and minor mode keymaps and keymap property.
7219 Note that tool-bar bindings in the local-map and keymap
7220 properties may not work reliable, as they are only
7221 recognized when the tool-bar (or mode-line) is updated,
7222 which does not normally happen after every command. */
7225 nminor
= current_minor_maps (NULL
, &tmaps
);
7226 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7228 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7229 maps
[nmaps
++] = tem
;
7230 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7232 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7235 /* Add global keymap at the end. */
7236 maps
[nmaps
++] = current_global_map
;
7238 /* Process maps in reverse order and look up in each map the prefix
7240 for (i
= nmaps
- 1; i
>= 0; --i
)
7241 if (!NILP (maps
[i
]))
7245 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7250 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7251 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7253 Lisp_Object keydef
= XCAR (tail
);
7255 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7260 Vinhibit_quit
= oquit
;
7261 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7262 return tool_bar_items_vector
;
7266 /* Process the definition of KEY which is DEF. */
7269 process_tool_bar_item (key
, def
)
7270 Lisp_Object key
, def
;
7273 extern Lisp_Object Qundefined
;
7274 struct gcpro gcpro1
, gcpro2
;
7276 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7280 if (EQ (def
, Qundefined
))
7282 /* If a map has an explicit `undefined' as definition,
7283 discard any previously made item. */
7284 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7286 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7288 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7290 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7291 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7292 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7293 * sizeof (Lisp_Object
)));
7294 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7299 else if (parse_tool_bar_item (key
, def
))
7300 /* Append a new tool bar item to tool_bar_items_vector. Accept
7301 more than one definition for the same key. */
7302 append_tool_bar_item ();
7308 /* Parse a tool bar item specification ITEM for key KEY and return the
7309 result in tool_bar_item_properties. Value is zero if ITEM is
7312 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7314 CAPTION is the caption of the item, If it's not a string, it is
7315 evaluated to get a string.
7317 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7318 as binding are currently ignored.
7320 The following properties are recognized:
7324 FORM is evaluated and specifies whether the tool bar item is
7325 enabled or disabled.
7329 FORM is evaluated and specifies whether the tool bar item is visible.
7331 - `:filter FUNCTION'
7333 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7334 result is stored as the new binding.
7336 - `:button (TYPE SELECTED)'
7338 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7339 and specifies whether the button is selected (pressed) or not.
7343 IMAGES is either a single image specification or a vector of four
7344 image specifications. See enum tool_bar_item_images.
7346 - `:help HELP-STRING'.
7348 Gives a help string to display for the tool bar item. */
7351 parse_tool_bar_item (key
, item
)
7352 Lisp_Object key
, item
;
7354 /* Access slot with index IDX of vector tool_bar_item_properties. */
7355 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7357 Lisp_Object filter
= Qnil
;
7358 Lisp_Object caption
;
7361 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7362 Rule out items that aren't lists, don't start with
7363 `menu-item' or whose rest following `tool-bar-item' is not a
7366 || !EQ (XCAR (item
), Qmenu_item
)
7367 || (item
= XCDR (item
),
7371 /* Create tool_bar_item_properties vector if necessary. Reset it to
7373 if (VECTORP (tool_bar_item_properties
))
7375 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7379 tool_bar_item_properties
7380 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7383 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7384 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7386 /* Get the caption of the item. If the caption is not a string,
7387 evaluate it to get a string. If we don't get a string, skip this
7389 caption
= XCAR (item
);
7390 if (!STRINGP (caption
))
7392 caption
= menu_item_eval_property (caption
);
7393 if (!STRINGP (caption
))
7396 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7398 /* Give up if rest following the caption is not a list. */
7403 /* Store the binding. */
7404 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7407 /* Ignore cached key binding, if any. */
7408 if (CONSP (item
) && CONSP (XCAR (item
)))
7411 /* Process the rest of the properties. */
7412 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7414 Lisp_Object key
, value
;
7417 value
= XCAR (XCDR (item
));
7419 if (EQ (key
, QCenable
))
7420 /* `:enable FORM'. */
7421 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7422 else if (EQ (key
, QCvisible
))
7424 /* `:visible FORM'. If got a visible property and that
7425 evaluates to nil then ignore this item. */
7426 if (NILP (menu_item_eval_property (value
)))
7429 else if (EQ (key
, QChelp
))
7430 /* `:help HELP-STRING'. */
7431 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7432 else if (EQ (key
, QCfilter
))
7433 /* ':filter FORM'. */
7435 else if (EQ (key
, QCbutton
) && CONSP (value
))
7437 /* `:button (TYPE . SELECTED)'. */
7438 Lisp_Object type
, selected
;
7440 type
= XCAR (value
);
7441 selected
= XCDR (value
);
7442 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7444 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7445 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7448 else if (EQ (key
, QCimage
)
7450 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7451 /* Value is either a single image specification or a vector
7452 of 4 such specifications for the different button states. */
7453 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7456 /* If got a filter apply it on binding. */
7458 PROP (TOOL_BAR_ITEM_BINDING
)
7459 = menu_item_eval_property (list2 (filter
,
7461 PROP (TOOL_BAR_ITEM_BINDING
))));
7463 /* See if the binding is a keymap. Give up if it is. */
7464 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7467 /* Enable or disable selection of item. */
7468 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7469 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7470 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7472 /* Handle radio buttons or toggle boxes. */
7473 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7474 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7475 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7483 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7484 that can be reused. */
7487 init_tool_bar_items (reuse
)
7490 if (VECTORP (reuse
))
7491 tool_bar_items_vector
= reuse
;
7493 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7494 ntool_bar_items
= 0;
7498 /* Append parsed tool bar item properties from
7499 tool_bar_item_properties */
7502 append_tool_bar_item ()
7504 Lisp_Object
*to
, *from
;
7506 /* Enlarge tool_bar_items_vector if necessary. */
7507 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7508 >= XVECTOR (tool_bar_items_vector
)->size
)
7510 Lisp_Object new_vector
;
7511 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7513 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7514 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7515 XVECTOR (new_vector
)->contents
,
7516 old_size
* sizeof (Lisp_Object
));
7517 tool_bar_items_vector
= new_vector
;
7520 /* Append entries from tool_bar_item_properties to the end of
7521 tool_bar_items_vector. */
7522 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7523 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7524 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7525 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7532 /* Read a character using menus based on maps in the array MAPS.
7533 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7534 Return t if we displayed a menu but the user rejected it.
7536 PREV_EVENT is the previous input event, or nil if we are reading
7537 the first event of a key sequence.
7539 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7540 if we used a mouse menu to read the input, or zero otherwise. If
7541 USED_MOUSE_MENU is null, we don't dereference it.
7543 The prompting is done based on the prompt-string of the map
7544 and the strings associated with various map elements.
7546 This can be done with X menus or with menus put in the minibuf.
7547 These are done in different ways, depending on how the input will be read.
7548 Menus using X are done after auto-saving in read-char, getting the input
7549 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7550 and do auto-saving in the inner call of read_char. */
7553 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7556 Lisp_Object prev_event
;
7557 int *used_mouse_menu
;
7560 register Lisp_Object name
;
7562 if (used_mouse_menu
)
7563 *used_mouse_menu
= 0;
7565 /* Use local over global Menu maps */
7567 if (! menu_prompting
)
7570 /* Optionally disregard all but the global map. */
7571 if (inhibit_local_menu_bar_menus
)
7573 maps
+= (nmaps
- 1);
7577 /* Get the menu name from the first map that has one (a prompt string). */
7578 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7580 name
= Fkeymap_prompt (maps
[mapno
]);
7585 /* If we don't have any menus, just read a character normally. */
7586 if (!STRINGP (name
))
7590 /* If we got to this point via a mouse click,
7591 use a real menu for mouse selection. */
7592 if (EVENT_HAS_PARAMETERS (prev_event
)
7593 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7594 && !EQ (XCAR (prev_event
), Qtool_bar
))
7596 /* Display the menu and get the selection. */
7597 Lisp_Object
*realmaps
7598 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7602 /* Use the maps that are not nil. */
7603 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7604 if (!NILP (maps
[mapno
]))
7605 realmaps
[nmaps1
++] = maps
[mapno
];
7607 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7612 record_menu_key (XCAR (value
));
7614 /* If we got multiple events, unread all but
7616 There is no way to prevent those unread events
7617 from showing up later in last_nonmenu_event.
7618 So turn symbol and integer events into lists,
7619 to indicate that they came from a mouse menu,
7620 so that when present in last_nonmenu_event
7621 they won't confuse things. */
7622 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7624 record_menu_key (XCAR (tem
));
7625 if (SYMBOLP (XCAR (tem
))
7626 || INTEGERP (XCAR (tem
)))
7627 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7630 /* If we got more than one event, put all but the first
7631 onto this list to be read later.
7632 Return just the first event now. */
7633 Vunread_command_events
7634 = nconc2 (XCDR (value
), Vunread_command_events
);
7635 value
= XCAR (value
);
7637 else if (NILP (value
))
7639 if (used_mouse_menu
)
7640 *used_mouse_menu
= 1;
7643 #endif /* HAVE_MENUS */
7647 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7648 We make this bigger when necessary, and never free it. */
7649 static char *read_char_minibuf_menu_text
;
7650 /* Size of that buffer. */
7651 static int read_char_minibuf_menu_width
;
7654 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7660 register Lisp_Object name
;
7662 int width
= FRAME_WIDTH (SELECTED_FRAME ()) - 4;
7665 Lisp_Object rest
, vector
;
7671 if (! menu_prompting
)
7674 /* Make sure we have a big enough buffer for the menu text. */
7675 if (read_char_minibuf_menu_text
== 0)
7677 read_char_minibuf_menu_width
= width
+ 4;
7678 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
7680 else if (width
+ 4 > read_char_minibuf_menu_width
)
7682 read_char_minibuf_menu_width
= width
+ 4;
7683 read_char_minibuf_menu_text
7684 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
7686 menu
= read_char_minibuf_menu_text
;
7688 /* Get the menu name from the first map that has one (a prompt string). */
7689 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7691 name
= Fkeymap_prompt (maps
[mapno
]);
7696 /* If we don't have any menus, just read a character normally. */
7697 if (!STRINGP (name
))
7700 /* Prompt string always starts with map's prompt, and a space. */
7701 strcpy (menu
, XSTRING (name
)->data
);
7702 nlength
= STRING_BYTES (XSTRING (name
));
7703 menu
[nlength
++] = ':';
7704 menu
[nlength
++] = ' ';
7707 /* Start prompting at start of first map. */
7711 /* Present the documented bindings, a line at a time. */
7718 Lisp_Object orig_defn_macro
;
7720 /* Loop over elements of map. */
7725 /* If reached end of map, start at beginning of next map. */
7729 /* At end of last map, wrap around to first map if just starting,
7730 or end this line if already have something on it. */
7734 if (notfirst
|| nobindings
) break;
7739 /* Look at the next element of the map. */
7741 elt
= XVECTOR (vector
)->contents
[idx
];
7743 elt
= Fcar_safe (rest
);
7745 if (idx
< 0 && VECTORP (elt
))
7747 /* If we found a dense table in the keymap,
7748 advanced past it, but start scanning its contents. */
7749 rest
= Fcdr_safe (rest
);
7755 /* An ordinary element. */
7756 Lisp_Object event
, tem
;
7760 event
= Fcar_safe (elt
); /* alist */
7761 elt
= Fcdr_safe (elt
);
7765 XSETINT (event
, idx
); /* vector */
7768 /* Ignore the element if it has no prompt string. */
7769 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
7771 /* 1 if the char to type matches the string. */
7773 Lisp_Object upcased_event
, downcased_event
;
7774 Lisp_Object desc
= Qnil
;
7776 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7778 upcased_event
= Fupcase (event
);
7779 downcased_event
= Fdowncase (event
);
7780 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
7781 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
7783 desc
= Fsingle_key_description (event
, Qnil
);
7785 #if 0 /* It is redundant to list the equivalent key bindings because
7786 the prefix is what the user has already typed. */
7788 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
7790 /* Insert equivalent keybinding. */
7791 s
= concat2 (s
, tem
);
7794 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
7795 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
7797 /* Insert button prefix. */
7798 Lisp_Object selected
7799 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
7800 if (EQ (tem
, QCradio
))
7801 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
7803 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
7804 s
= concat2 (tem
, s
);
7808 /* If we have room for the prompt string, add it to this line.
7809 If this is the first on the line, always add it. */
7810 if ((XSTRING (s
)->size
+ i
+ 2
7811 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
7817 /* Punctuate between strings. */
7820 strcpy (menu
+ i
, ", ");
7826 /* If the char to type doesn't match the string's
7827 first char, explicitly show what char to type. */
7830 /* Add as much of string as fits. */
7831 thiswidth
= XSTRING (desc
)->size
;
7832 if (thiswidth
+ i
> width
)
7833 thiswidth
= width
- i
;
7834 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
7836 strcpy (menu
+ i
, " = ");
7840 /* Add as much of string as fits. */
7841 thiswidth
= XSTRING (s
)->size
;
7842 if (thiswidth
+ i
> width
)
7843 thiswidth
= width
- i
;
7844 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
7850 /* If this element does not fit, end the line now,
7851 and save the element for the next line. */
7852 strcpy (menu
+ i
, "...");
7857 /* Move past this element. */
7858 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
7859 /* Handle reaching end of dense table. */
7864 rest
= Fcdr_safe (rest
);
7868 /* Prompt with that and read response. */
7869 message2_nolog (menu
, strlen (menu
),
7870 ! NILP (current_buffer
->enable_multibyte_characters
));
7872 /* Make believe its not a keyboard macro in case the help char
7873 is pressed. Help characters are not recorded because menu prompting
7874 is not used on replay.
7876 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
7877 current_kboard
->defining_kbd_macro
= Qnil
;
7879 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
7880 while (BUFFERP (obj
));
7881 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
7883 if (!INTEGERP (obj
))
7888 if (! EQ (obj
, menu_prompt_more_char
)
7889 && (!INTEGERP (menu_prompt_more_char
)
7890 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
7892 if (!NILP (current_kboard
->defining_kbd_macro
))
7893 store_kbd_macro_char (obj
);
7896 /* Help char - go round again */
7900 /* Reading key sequences. */
7902 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
7903 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
7904 keymap, or nil otherwise. Return the index of the first keymap in
7905 which KEY has any binding, or NMAPS if no map has a binding.
7907 If KEY is a meta ASCII character, treat it like meta-prefix-char
7908 followed by the corresponding non-meta character. Keymaps in
7909 CURRENT with non-prefix bindings for meta-prefix-char become nil in
7912 If KEY has no bindings in any of the CURRENT maps, NEXT is left
7915 NEXT may be the same array as CURRENT. */
7918 follow_key (key
, nmaps
, current
, defs
, next
)
7920 Lisp_Object
*current
, *defs
, *next
;
7923 int i
, first_binding
;
7926 first_binding
= nmaps
;
7927 for (i
= nmaps
- 1; i
>= 0; i
--)
7929 if (! NILP (current
[i
]))
7937 defs
[i
] = access_keymap (map
, key
, 1, 0, 1);
7938 if (! NILP (defs
[i
]))
7945 /* Given the set of bindings we've found, produce the next set of maps. */
7946 if (first_binding
< nmaps
)
7947 for (i
= 0; i
< nmaps
; i
++)
7948 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
7950 return first_binding
;
7953 /* Read a sequence of keys that ends with a non prefix character,
7954 storing it in KEYBUF, a buffer of size BUFSIZE.
7956 Return the length of the key sequence stored.
7957 Return -1 if the user rejected a command menu.
7959 Echo starting immediately unless `prompt' is 0.
7961 Where a key sequence ends depends on the currently active keymaps.
7962 These include any minor mode keymaps active in the current buffer,
7963 the current buffer's local map, and the global map.
7965 If a key sequence has no other bindings, we check Vfunction_key_map
7966 to see if some trailing subsequence might be the beginning of a
7967 function key's sequence. If so, we try to read the whole function
7968 key, and substitute its symbolic name into the key sequence.
7970 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
7971 `double-' events into similar click events, if that would make them
7972 bound. We try to turn `triple-' events first into `double-' events,
7975 If we get a mouse click in a mode line, vertical divider, or other
7976 non-text area, we treat the click as if it were prefixed by the
7977 symbol denoting that area - `mode-line', `vertical-line', or
7980 If the sequence starts with a mouse click, we read the key sequence
7981 with respect to the buffer clicked on, not the current buffer.
7983 If the user switches frames in the midst of a key sequence, we put
7984 off the switch-frame event until later; the next call to
7985 read_char will return it.
7987 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
7988 from the selected window's buffer. */
7991 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
7992 can_return_switch_frame
, fix_current_buffer
)
7993 Lisp_Object
*keybuf
;
7996 int dont_downcase_last
;
7997 int can_return_switch_frame
;
7998 int fix_current_buffer
;
8000 volatile Lisp_Object from_string
;
8001 volatile int count
= specpdl_ptr
- specpdl
;
8003 /* How many keys there are in the current key sequence. */
8006 /* The length of the echo buffer when we started reading, and
8007 the length of this_command_keys when we started reading. */
8008 volatile int echo_start
;
8009 volatile int keys_start
;
8011 /* The number of keymaps we're scanning right now, and the number of
8012 keymaps we have allocated space for. */
8014 volatile int nmaps_allocated
= 0;
8016 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8017 the current keymaps. */
8018 Lisp_Object
*volatile defs
= NULL
;
8020 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8021 in the current keymaps, or nil where it is not a prefix. */
8022 Lisp_Object
*volatile submaps
= NULL
;
8024 /* The local map to start out with at start of key sequence. */
8025 volatile Lisp_Object orig_local_map
;
8027 /* The map from the `keymap' property to start out with at start of
8029 volatile Lisp_Object orig_keymap
;
8031 /* 1 if we have already considered switching to the local-map property
8032 of the place where a mouse click occurred. */
8033 volatile int localized_local_map
= 0;
8035 /* The index in defs[] of the first keymap that has a binding for
8036 this key sequence. In other words, the lowest i such that
8037 defs[i] is non-nil. */
8038 volatile int first_binding
;
8039 /* Index of the first key that has no binding.
8040 It is useless to try fkey_start larger than that. */
8041 volatile int first_unbound
;
8043 /* If t < mock_input, then KEYBUF[t] should be read as the next
8046 We use this to recover after recognizing a function key. Once we
8047 realize that a suffix of the current key sequence is actually a
8048 function key's escape sequence, we replace the suffix with the
8049 function key's binding from Vfunction_key_map. Now keybuf
8050 contains a new and different key sequence, so the echo area,
8051 this_command_keys, and the submaps and defs arrays are wrong. In
8052 this situation, we set mock_input to t, set t to 0, and jump to
8053 restart_sequence; the loop will read keys from keybuf up until
8054 mock_input, thus rebuilding the state; and then it will resume
8055 reading characters from the keyboard. */
8056 volatile int mock_input
= 0;
8058 /* If the sequence is unbound in submaps[], then
8059 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
8060 and fkey_map is its binding.
8062 These might be > t, indicating that all function key scanning
8063 should hold off until t reaches them. We do this when we've just
8064 recognized a function key, to avoid searching for the function
8065 key's again in Vfunction_key_map. */
8066 volatile int fkey_start
= 0, fkey_end
= 0;
8067 volatile Lisp_Object fkey_map
;
8069 /* Likewise, for key_translation_map. */
8070 volatile int keytran_start
= 0, keytran_end
= 0;
8071 volatile Lisp_Object keytran_map
;
8073 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
8074 we put it off for later. While we're reading, we keep the event here. */
8075 volatile Lisp_Object delayed_switch_frame
;
8077 /* See the comment below... */
8078 #if defined (GOBBLE_FIRST_EVENT)
8079 Lisp_Object first_event
;
8082 volatile Lisp_Object original_uppercase
;
8083 volatile int original_uppercase_position
= -1;
8085 /* Gets around Microsoft compiler limitations. */
8088 struct buffer
*starting_buffer
;
8090 /* List of events for which a fake prefix key has been generated. */
8091 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8093 #if defined (GOBBLE_FIRST_EVENT)
8097 struct gcpro gcpro1
;
8099 GCPRO1 (fake_prefixed_keys
);
8100 raw_keybuf_count
= 0;
8102 last_nonmenu_event
= Qnil
;
8104 delayed_switch_frame
= Qnil
;
8105 fkey_map
= Vfunction_key_map
;
8106 keytran_map
= Vkey_translation_map
;
8108 /* If there is no function-key-map, turn off function key scanning. */
8109 if (!KEYMAPP (Vfunction_key_map
))
8110 fkey_start
= fkey_end
= bufsize
+ 1;
8112 /* If there is no key-translation-map, turn off scanning. */
8113 if (!KEYMAPP (Vkey_translation_map
))
8114 keytran_start
= keytran_end
= bufsize
+ 1;
8119 echo_prompt (prompt
);
8120 else if (cursor_in_echo_area
8121 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8122 && NILP (Fzerop (Vecho_keystrokes
)))
8123 /* This doesn't put in a dash if the echo buffer is empty, so
8124 you don't always see a dash hanging out in the minibuffer. */
8128 /* Record the initial state of the echo area and this_command_keys;
8129 we will need to restore them if we replay a key sequence. */
8131 echo_start
= echo_length ();
8132 keys_start
= this_command_key_count
;
8133 this_single_command_key_start
= keys_start
;
8135 #if defined (GOBBLE_FIRST_EVENT)
8136 /* This doesn't quite work, because some of the things that read_char
8137 does cannot safely be bypassed. It seems too risky to try to make
8140 /* Read the first char of the sequence specially, before setting
8141 up any keymaps, in case a filter runs and switches buffers on us. */
8142 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8144 #endif /* GOBBLE_FIRST_EVENT */
8146 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8147 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8150 /* We jump here when the key sequence has been thoroughly changed, and
8151 we need to rescan it starting from the beginning. When we jump here,
8152 keybuf[0..mock_input] holds the sequence we should reread. */
8155 starting_buffer
= current_buffer
;
8156 first_unbound
= bufsize
+ 1;
8158 /* Build our list of keymaps.
8159 If we recognize a function key and replace its escape sequence in
8160 keybuf with its symbol, or if the sequence starts with a mouse
8161 click and we need to switch buffers, we jump back here to rebuild
8162 the initial keymaps from the current buffer. */
8165 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8166 || !NILP (Voverriding_local_map
))
8168 if (3 > nmaps_allocated
)
8170 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8171 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8172 nmaps_allocated
= 3;
8174 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8175 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8176 if (!NILP (Voverriding_local_map
))
8177 submaps
[nmaps
++] = Voverriding_local_map
;
8185 nminor
= current_minor_maps (0, &maps
);
8186 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8188 if (total
> nmaps_allocated
)
8190 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8191 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8192 nmaps_allocated
= total
;
8195 if (!NILP (orig_keymap
))
8196 submaps
[nmaps
++] = orig_keymap
;
8198 bcopy (maps
, (void *) (submaps
+ nmaps
),
8199 nminor
* sizeof (submaps
[0]));
8203 submaps
[nmaps
++] = orig_local_map
;
8205 submaps
[nmaps
++] = current_global_map
;
8207 /* Find an accurate initial value for first_binding. */
8208 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8209 if (! NILP (submaps
[first_binding
]))
8212 /* Start from the beginning in keybuf. */
8215 /* These are no-ops the first time through, but if we restart, they
8216 revert the echo area and this_command_keys to their original state. */
8217 this_command_key_count
= keys_start
;
8218 if (INTERACTIVE
&& t
< mock_input
)
8219 echo_truncate (echo_start
);
8221 /* If the best binding for the current key sequence is a keymap, or
8222 we may be looking at a function key's escape sequence, keep on
8224 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
8225 || (first_binding
>= nmaps
&& fkey_start
< t
)
8226 || (first_binding
>= nmaps
&& keytran_start
< t
)
8227 /* Don't return in the middle of a possible function key sequence,
8228 if the only bindings we found were via case conversion.
8229 Thus, if ESC O a has a function-key-map translation
8230 and ESC o has a binding, don't return after ESC O,
8231 so that we can translate ESC O plus the next character. */
8235 int used_mouse_menu
= 0;
8237 /* Where the last real key started. If we need to throw away a
8238 key that has expanded into more than one element of keybuf
8239 (say, a mouse click on the mode line which is being treated
8240 as [mode-line (mouse-...)], then we backtrack to this point
8242 volatile int last_real_key_start
;
8244 /* These variables are analogous to echo_start and keys_start;
8245 while those allow us to restart the entire key sequence,
8246 echo_local_start and keys_local_start allow us to throw away
8248 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8250 /* key-translation-map is applied *after* function-key-map. */
8251 eassert (keytran_end
<= fkey_start
);
8253 if (first_unbound
< fkey_start
&& first_unbound
< keytran_start
)
8254 { /* The prefix upto first_unbound has no binding and has
8255 no translation left to do either, so we know it's unbound.
8256 If we don't stop now, we risk staying here indefinitely
8257 (if the user keeps entering fkey or keytran prefixes
8258 like C-c ESC ESC ESC ESC ...) */
8260 for (i
= first_unbound
+ 1; i
< t
; i
++)
8261 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8262 mock_input
= t
- first_unbound
- 1;
8263 fkey_end
= fkey_start
-= first_unbound
+ 1;
8264 fkey_map
= Vfunction_key_map
;
8265 keytran_end
= keytran_start
-= first_unbound
+ 1;
8266 keytran_map
= Vkey_translation_map
;
8267 goto replay_sequence
;
8271 error ("Key sequence too long");
8274 echo_local_start
= echo_length ();
8275 keys_local_start
= this_command_key_count
;
8276 local_first_binding
= first_binding
;
8279 /* These are no-ops, unless we throw away a keystroke below and
8280 jumped back up to replay_key; in that case, these restore the
8281 variables to their original state, allowing us to replay the
8283 if (INTERACTIVE
&& t
< mock_input
)
8284 echo_truncate (echo_local_start
);
8285 this_command_key_count
= keys_local_start
;
8286 first_binding
= local_first_binding
;
8288 /* By default, assume each event is "real". */
8289 last_real_key_start
= t
;
8291 /* Does mock_input indicate that we are re-reading a key sequence? */
8295 add_command_key (key
);
8296 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8297 && NILP (Fzerop (Vecho_keystrokes
)))
8301 /* If not, we should actually read a character. */
8306 KBOARD
*interrupted_kboard
= current_kboard
;
8307 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8308 if (setjmp (wrong_kboard_jmpbuf
))
8310 if (!NILP (delayed_switch_frame
))
8312 interrupted_kboard
->kbd_queue
8313 = Fcons (delayed_switch_frame
,
8314 interrupted_kboard
->kbd_queue
);
8315 delayed_switch_frame
= Qnil
;
8318 interrupted_kboard
->kbd_queue
8319 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8321 /* If the side queue is non-empty, ensure it begins with a
8322 switch-frame, so we'll replay it in the right context. */
8323 if (CONSP (interrupted_kboard
->kbd_queue
)
8324 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8325 !(EVENT_HAS_PARAMETERS (key
)
8326 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8330 XSETFRAME (frame
, interrupted_frame
);
8331 interrupted_kboard
->kbd_queue
8332 = Fcons (make_lispy_switch_frame (frame
),
8333 interrupted_kboard
->kbd_queue
);
8336 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8337 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8338 goto replay_sequence
;
8341 key
= read_char (NILP (prompt
), nmaps
,
8342 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8346 /* read_char returns t when it shows a menu and the user rejects it.
8350 unbind_to (count
, Qnil
);
8355 /* read_char returns -1 at the end of a macro.
8356 Emacs 18 handles this by returning immediately with a
8357 zero, so that's what we'll do. */
8358 if (INTEGERP (key
) && XINT (key
) == -1)
8361 /* The Microsoft C compiler can't handle the goto that
8367 /* If the current buffer has been changed from under us, the
8368 keymap may have changed, so replay the sequence. */
8372 /* Reset the current buffer from the selected window
8373 in case something changed the former and not the latter.
8374 This is to be more consistent with the behavior
8375 of the command_loop_1. */
8376 if (fix_current_buffer
)
8378 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8380 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8381 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8384 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8385 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8386 goto replay_sequence
;
8389 /* If we have a quit that was typed in another frame, and
8390 quit_throw_to_read_char switched buffers,
8391 replay to get the right keymap. */
8393 && XINT (key
) == quit_char
8394 && current_buffer
!= starting_buffer
)
8397 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8401 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8402 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8403 goto replay_sequence
;
8408 if (EVENT_HAS_PARAMETERS (key
)
8409 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8411 /* If we're at the beginning of a key sequence, and the caller
8412 says it's okay, go ahead and return this event. If we're
8413 in the midst of a key sequence, delay it until the end. */
8414 if (t
> 0 || !can_return_switch_frame
)
8416 delayed_switch_frame
= key
;
8422 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8425 /* Clicks in non-text areas get prefixed by the symbol
8426 in their CHAR-ADDRESS field. For example, a click on
8427 the mode line is prefixed by the symbol `mode-line'.
8429 Furthermore, key sequences beginning with mouse clicks
8430 are read using the keymaps of the buffer clicked on, not
8431 the current buffer. So we may have to switch the buffer
8434 When we turn one event into two events, we must make sure
8435 that neither of the two looks like the original--so that,
8436 if we replay the events, they won't be expanded again.
8437 If not for this, such reexpansion could happen either here
8438 or when user programs play with this-command-keys. */
8439 if (EVENT_HAS_PARAMETERS (key
))
8443 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8444 if (EQ (kind
, Qmouse_click
))
8446 Lisp_Object window
, posn
;
8448 window
= POSN_WINDOW (EVENT_START (key
));
8449 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8452 || (!NILP (fake_prefixed_keys
)
8453 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8455 /* We're looking a second time at an event for which
8456 we generated a fake prefix key. Set
8457 last_real_key_start appropriately. */
8459 last_real_key_start
= t
- 1;
8462 /* Key sequences beginning with mouse clicks are
8463 read using the keymaps in the buffer clicked on,
8464 not the current buffer. If we're at the
8465 beginning of a key sequence, switch buffers. */
8466 if (last_real_key_start
== 0
8468 && BUFFERP (XWINDOW (window
)->buffer
)
8469 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8471 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8475 /* Arrange to go back to the original buffer once we're
8476 done reading the key sequence. Note that we can't
8477 use save_excursion_{save,restore} here, because they
8478 save point as well as the current buffer; we don't
8479 want to save point, because redisplay may change it,
8480 to accommodate a Fset_window_start or something. We
8481 don't want to do this at the top of the function,
8482 because we may get input from a subprocess which
8483 wants to change the selected window and stuff (say,
8485 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8487 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8489 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8490 orig_local_map
= get_local_map (PT
, current_buffer
,
8492 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8493 goto replay_sequence
;
8496 /* For a mouse click, get the local text-property keymap
8497 of the place clicked on, rather than point. */
8498 if (last_real_key_start
== 0
8499 && CONSP (XCDR (key
))
8500 && ! localized_local_map
)
8502 Lisp_Object map_here
, start
, pos
;
8504 localized_local_map
= 1;
8505 start
= EVENT_START (key
);
8507 if (CONSP (start
) && CONSP (XCDR (start
)))
8509 pos
= POSN_BUFFER_POSN (start
);
8511 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8513 map_here
= get_local_map (XINT (pos
),
8514 current_buffer
, Qlocal_map
);
8515 if (!EQ (map_here
, orig_local_map
))
8517 orig_local_map
= map_here
;
8521 goto replay_sequence
;
8523 map_here
= get_local_map (XINT (pos
),
8524 current_buffer
, Qkeymap
);
8525 if (!EQ (map_here
, orig_keymap
))
8527 orig_keymap
= map_here
;
8531 goto replay_sequence
;
8537 /* Expand mode-line and scroll-bar events into two events:
8538 use posn as a fake prefix key. */
8540 && (NILP (fake_prefixed_keys
)
8541 || NILP (Fmemq (key
, fake_prefixed_keys
))))
8543 if (t
+ 1 >= bufsize
)
8544 error ("Key sequence too long");
8547 keybuf
[t
+ 1] = key
;
8550 /* Record that a fake prefix key has been generated
8551 for KEY. Don't modify the event; this would
8552 prevent proper action when the event is pushed
8553 back tino unread-command-events. */
8554 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
8556 /* If on a mode line string with a local keymap,
8557 reconsider the key sequence with that keymap. */
8558 if (CONSP (POSN_STRING (EVENT_START (key
))))
8560 Lisp_Object string
, pos
, map
, map2
;
8562 string
= POSN_STRING (EVENT_START (key
));
8563 pos
= XCDR (string
);
8564 string
= XCAR (string
);
8566 && XINT (pos
) < XSTRING (string
)->size
)
8568 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8570 orig_local_map
= map
;
8571 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8574 if (!NILP (map
) || !NILP (map2
))
8575 goto replay_sequence
;
8581 else if (CONSP (POSN_STRING (EVENT_START (key
)))
8582 && NILP (from_string
))
8584 /* For a click on a string, i.e. overlay string or a
8585 string displayed via the `display' property,
8586 consider `local-map' and `keymap' properties of
8588 Lisp_Object string
, pos
, map
, map2
;
8590 string
= POSN_STRING (EVENT_START (key
));
8591 pos
= XCDR (string
);
8592 string
= XCAR (string
);
8594 && XINT (pos
) < XSTRING (string
)->size
)
8596 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8598 orig_local_map
= map
;
8599 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8603 if (!NILP (map
) || !NILP (map2
))
8605 from_string
= string
;
8606 goto replay_sequence
;
8611 else if (CONSP (XCDR (key
))
8612 && CONSP (EVENT_START (key
))
8613 && CONSP (XCDR (EVENT_START (key
))))
8617 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8618 /* Handle menu-bar events:
8619 insert the dummy prefix event `menu-bar'. */
8620 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
8622 if (t
+ 1 >= bufsize
)
8623 error ("Key sequence too long");
8627 /* Zap the position in key, so we know that we've
8628 expanded it, and don't try to do so again. */
8629 POSN_BUFFER_SET_POSN (EVENT_START (key
),
8630 Fcons (posn
, Qnil
));
8633 goto replay_sequence
;
8635 else if (CONSP (posn
))
8637 /* We're looking at the second event of a
8638 sequence which we expanded before. Set
8639 last_real_key_start appropriately. */
8640 if (last_real_key_start
== t
&& t
> 0)
8641 last_real_key_start
= t
- 1;
8646 /* We have finally decided that KEY is something we might want
8648 first_binding
= (follow_key (key
,
8649 nmaps
- first_binding
,
8650 submaps
+ first_binding
,
8651 defs
+ first_binding
,
8652 submaps
+ first_binding
)
8655 /* If KEY wasn't bound, we'll try some fallbacks. */
8656 if (first_binding
< nmaps
)
8657 /* This is needed for the following scenario:
8658 event 0: a down-event that gets dropped by calling replay_key.
8659 event 1: some normal prefix like C-h.
8660 After event 0, first_unbound is 0, after event 1 fkey_start
8661 and keytran_start are both 1, so when we see that C-h is bound,
8662 we need to update first_unbound. */
8663 first_unbound
= max (t
+ 1, first_unbound
);
8668 /* Remember the position to put an upper bound on fkey_start. */
8669 first_unbound
= min (t
, first_unbound
);
8671 head
= EVENT_HEAD (key
);
8672 if (help_char_p (head
) && t
> 0)
8674 read_key_sequence_cmd
= Vprefix_help_command
;
8676 last_nonmenu_event
= key
;
8677 /* The Microsoft C compiler can't handle the goto that
8685 Lisp_Object breakdown
;
8688 breakdown
= parse_modifiers (head
);
8689 modifiers
= XINT (XCAR (XCDR (breakdown
)));
8690 /* Attempt to reduce an unbound mouse event to a simpler
8691 event that is bound:
8692 Drags reduce to clicks.
8693 Double-clicks reduce to clicks.
8694 Triple-clicks reduce to double-clicks, then to clicks.
8695 Down-clicks are eliminated.
8696 Double-downs reduce to downs, then are eliminated.
8697 Triple-downs reduce to double-downs, then to downs,
8698 then are eliminated. */
8699 if (modifiers
& (down_modifier
| drag_modifier
8700 | double_modifier
| triple_modifier
))
8702 while (modifiers
& (down_modifier
| drag_modifier
8703 | double_modifier
| triple_modifier
))
8705 Lisp_Object new_head
, new_click
;
8706 if (modifiers
& triple_modifier
)
8707 modifiers
^= (double_modifier
| triple_modifier
);
8708 else if (modifiers
& double_modifier
)
8709 modifiers
&= ~double_modifier
;
8710 else if (modifiers
& drag_modifier
)
8711 modifiers
&= ~drag_modifier
;
8714 /* Dispose of this `down' event by simply jumping
8715 back to replay_key, to get another event.
8717 Note that if this event came from mock input,
8718 then just jumping back to replay_key will just
8719 hand it to us again. So we have to wipe out any
8722 We could delete keybuf[t] and shift everything
8723 after that to the left by one spot, but we'd also
8724 have to fix up any variable that points into
8725 keybuf, and shifting isn't really necessary
8728 Adding prefixes for non-textual mouse clicks
8729 creates two characters of mock input, and both
8730 must be thrown away. If we're only looking at
8731 the prefix now, we can just jump back to
8732 replay_key. On the other hand, if we've already
8733 processed the prefix, and now the actual click
8734 itself is giving us trouble, then we've lost the
8735 state of the keymaps we want to backtrack to, and
8736 we need to replay the whole sequence to rebuild
8739 Beyond that, only function key expansion could
8740 create more than two keys, but that should never
8741 generate mouse events, so it's okay to zero
8742 mock_input in that case too.
8744 FIXME: The above paragraph seems just plain
8745 wrong, if you consider things like
8746 xterm-mouse-mode. -stef
8748 Isn't this just the most wonderful code ever? */
8749 if (t
== last_real_key_start
)
8756 mock_input
= last_real_key_start
;
8757 goto replay_sequence
;
8762 = apply_modifiers (modifiers
, XCAR (breakdown
));
8764 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
8766 /* Look for a binding for this new key. follow_key
8767 promises that it didn't munge submaps the
8768 last time we called it, since key was unbound. */
8770 = (follow_key (new_click
,
8771 nmaps
- local_first_binding
,
8772 submaps
+ local_first_binding
,
8773 defs
+ local_first_binding
,
8774 submaps
+ local_first_binding
)
8775 + local_first_binding
);
8777 /* If that click is bound, go for it. */
8778 if (first_binding
< nmaps
)
8783 /* Otherwise, we'll leave key set to the drag event. */
8790 /* Normally, last_nonmenu_event gets the previous key we read.
8791 But when a mouse popup menu is being used,
8792 we don't update last_nonmenu_event; it continues to hold the mouse
8793 event that preceded the first level of menu. */
8794 if (!used_mouse_menu
)
8795 last_nonmenu_event
= key
;
8797 /* Record what part of this_command_keys is the current key sequence. */
8798 this_single_command_key_start
= this_command_key_count
- t
;
8800 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
8801 /* There is a binding and it's not a prefix.
8802 There is thus no function-key in this sequence.
8803 Moving fkey.start is important in this case to allow keytran.start
8804 to go over the sequence before we return (since we keep the
8805 invariant that keytran.end <= fkey.start). */
8808 (fkey_start
= fkey_end
= t
, fkey_map
= Vfunction_key_map
);
8811 /* If the sequence is unbound, see if we can hang a function key
8812 off the end of it. */
8814 Lisp_Object fkey_next
;
8816 /* Continue scan from fkey_end until we find a bound suffix.
8817 If we fail, increment fkey_start and start over from there. */
8818 while (fkey_end
< t
)
8822 key
= keybuf
[fkey_end
++];
8823 fkey_next
= access_keymap (fkey_map
, key
, 1, 0, 1);
8825 /* Handle symbol with autoload definition. */
8826 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8827 && CONSP (XSYMBOL (fkey_next
)->function
)
8828 && EQ (XCAR (XSYMBOL (fkey_next
)->function
), Qautoload
))
8829 do_autoload (XSYMBOL (fkey_next
)->function
,
8832 /* Handle a symbol whose function definition is a keymap
8834 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8835 && (!NILP (Farrayp (XSYMBOL (fkey_next
)->function
))
8836 || KEYMAPP (XSYMBOL (fkey_next
)->function
)))
8837 fkey_next
= XSYMBOL (fkey_next
)->function
;
8839 #if 0 /* I didn't turn this on, because it might cause trouble
8840 for the mapping of return into C-m and tab into C-i. */
8841 /* Optionally don't map function keys into other things.
8842 This enables the user to redefine kp- keys easily. */
8843 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
8847 /* If the function key map gives a function, not an
8848 array, then call the function with no args and use
8849 its value instead. */
8850 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8851 /* If there's a binding (i.e. first_binding >= nmaps)
8852 we don't want to apply this function-key-mapping. */
8853 && fkey_end
== t
&& first_binding
>= nmaps
)
8855 struct gcpro gcpro1
, gcpro2
, gcpro3
;
8859 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
8860 fkey_next
= call1 (fkey_next
, prompt
);
8862 /* If the function returned something invalid,
8863 barf--don't ignore it.
8864 (To ignore it safely, we would need to gcpro a bunch of
8865 other variables.) */
8866 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
8867 error ("Function in key-translation-map returns invalid key sequence");
8870 /* If keybuf[fkey_start..fkey_end] is bound in the
8871 function key map and it's a suffix of the current
8872 sequence (i.e. fkey_end == t), replace it with
8873 the binding and restart with fkey_start at the end. */
8874 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
8875 /* If there's a binding (i.e. first_binding >= nmaps)
8876 we don't want to apply this function-key-mapping. */
8877 && fkey_end
== t
&& first_binding
>= nmaps
)
8879 int len
= XFASTINT (Flength (fkey_next
));
8881 t
= fkey_start
+ len
;
8883 error ("Key sequence too long");
8885 if (VECTORP (fkey_next
))
8886 bcopy (XVECTOR (fkey_next
)->contents
,
8887 keybuf
+ fkey_start
,
8888 (t
- fkey_start
) * sizeof (keybuf
[0]));
8889 else if (STRINGP (fkey_next
))
8893 for (i
= 0; i
< len
; i
++)
8894 XSETFASTINT (keybuf
[fkey_start
+ i
],
8895 XSTRING (fkey_next
)->data
[i
]);
8899 fkey_start
= fkey_end
= t
;
8900 fkey_map
= Vfunction_key_map
;
8902 /* Do pass the results through key-translation-map.
8903 But don't retranslate what key-translation-map
8904 has already translated. */
8905 keytran_end
= keytran_start
;
8906 keytran_map
= Vkey_translation_map
;
8908 goto replay_sequence
;
8911 fkey_map
= get_keymap (fkey_next
, 0, 1);
8913 /* If we no longer have a bound suffix, try a new positions for
8915 if (!CONSP (fkey_map
))
8917 fkey_end
= ++fkey_start
;
8918 fkey_map
= Vfunction_key_map
;
8923 /* Look for this sequence in key-translation-map. */
8925 Lisp_Object keytran_next
;
8927 /* Scan from keytran_end until we find a bound suffix. */
8928 while (keytran_end
< fkey_start
)
8932 key
= keybuf
[keytran_end
++];
8934 = access_keymap (keytran_map
, key
, 1, 0, 1);
8936 /* Handle symbol with autoload definition. */
8937 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8938 && CONSP (XSYMBOL (keytran_next
)->function
)
8939 && EQ (XCAR (XSYMBOL (keytran_next
)->function
), Qautoload
))
8940 do_autoload (XSYMBOL (keytran_next
)->function
,
8943 /* Handle a symbol whose function definition is a keymap
8945 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8946 && (!NILP (Farrayp (XSYMBOL (keytran_next
)->function
))
8947 || KEYMAPP (XSYMBOL (keytran_next
)->function
)))
8948 keytran_next
= XSYMBOL (keytran_next
)->function
;
8950 /* If the key translation map gives a function, not an
8951 array, then call the function with one arg and use
8952 its value instead. */
8953 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
)))
8955 struct gcpro gcpro1
, gcpro2
, gcpro3
;
8959 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
8960 keytran_next
= call1 (keytran_next
, prompt
);
8962 /* If the function returned something invalid,
8963 barf--don't ignore it.
8964 (To ignore it safely, we would need to gcpro a bunch of
8965 other variables.) */
8966 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
8967 error ("Function in key-translation-map returns invalid key sequence");
8970 /* If keybuf[keytran_start..keytran_end] is bound in the
8971 key translation map and it's a suffix of the current
8972 sequence (i.e. keytran_end == t), replace it with
8973 the binding and restart with keytran_start at the end. */
8974 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
)))
8976 int len
= XFASTINT (Flength (keytran_next
));
8977 int i
, diff
= len
- (keytran_end
- keytran_start
);
8979 mock_input
= max (t
, mock_input
);
8980 if (mock_input
+ diff
>= bufsize
)
8981 error ("Key sequence too long");
8983 /* Shift the keys that are after keytran_end. */
8985 for (i
= keytran_end
; i
< mock_input
; i
++)
8986 keybuf
[i
+ diff
] = keybuf
[i
];
8988 for (i
= mock_input
- 1; i
>= keytran_end
; i
--)
8989 keybuf
[i
+ diff
] = keybuf
[i
];
8990 /* Replace the keys between keytran_start and keytran_end
8991 with those from keytran_next. */
8992 for (i
= 0; i
< len
; i
++)
8993 keybuf
[keytran_start
+ i
]
8994 = Faref (keytran_next
, make_number (i
));
8997 keytran_start
= keytran_end
+= diff
;
8998 keytran_map
= Vkey_translation_map
;
9000 /* Adjust the function-key-map counters. */
9004 goto replay_sequence
;
9007 keytran_map
= get_keymap (keytran_next
, 0, 1);
9009 /* If we no longer have a bound suffix, try a new positions for
9011 if (!CONSP (keytran_map
))
9013 keytran_end
= ++keytran_start
;
9014 keytran_map
= Vkey_translation_map
;
9019 /* If KEY is not defined in any of the keymaps,
9020 and cannot be part of a function key or translation,
9021 and is an upper case letter
9022 use the corresponding lower-case letter instead. */
9023 if (first_binding
>= nmaps
9024 && fkey_start
>= t
&& keytran_start
>= t
9026 && ((((XINT (key
) & 0x3ffff)
9027 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9028 && UPPERCASEP (XINT (key
) & 0x3ffff))
9029 || (XINT (key
) & shift_modifier
)))
9031 Lisp_Object new_key
;
9033 original_uppercase
= key
;
9034 original_uppercase_position
= t
- 1;
9036 if (XINT (key
) & shift_modifier
)
9037 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9039 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9040 | (XINT (key
) & ~0x3ffff)));
9042 /* We have to do this unconditionally, regardless of whether
9043 the lower-case char is defined in the keymaps, because they
9044 might get translated through function-key-map. */
9045 keybuf
[t
- 1] = new_key
;
9046 mock_input
= max (t
, mock_input
);
9048 goto replay_sequence
;
9050 /* If KEY is not defined in any of the keymaps,
9051 and cannot be part of a function key or translation,
9052 and is a shifted function key,
9053 use the corresponding unshifted function key instead. */
9054 if (first_binding
>= nmaps
9055 && fkey_start
>= t
&& keytran_start
>= t
9058 Lisp_Object breakdown
;
9061 breakdown
= parse_modifiers (key
);
9062 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9063 if (modifiers
& shift_modifier
)
9065 Lisp_Object new_key
;
9067 original_uppercase
= key
;
9068 original_uppercase_position
= t
- 1;
9070 modifiers
&= ~shift_modifier
;
9071 new_key
= apply_modifiers (modifiers
,
9074 keybuf
[t
- 1] = new_key
;
9075 mock_input
= max (t
, mock_input
);
9077 goto replay_sequence
;
9083 read_key_sequence_cmd
= (first_binding
< nmaps
9084 ? defs
[first_binding
]
9087 unread_switch_frame
= delayed_switch_frame
;
9088 unbind_to (count
, Qnil
);
9090 /* Don't downcase the last character if the caller says don't.
9091 Don't downcase it if the result is undefined, either. */
9092 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9093 && t
- 1 == original_uppercase_position
)
9094 keybuf
[t
- 1] = original_uppercase
;
9096 /* Occasionally we fabricate events, perhaps by expanding something
9097 according to function-key-map, or by adding a prefix symbol to a
9098 mouse click in the scroll bar or modeline. In this cases, return
9099 the entire generated key sequence, even if we hit an unbound
9100 prefix or a definition before the end. This means that you will
9101 be able to push back the event properly, and also means that
9102 read-key-sequence will always return a logical unit.
9105 for (; t
< mock_input
; t
++)
9107 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9108 && NILP (Fzerop (Vecho_keystrokes
)))
9109 echo_char (keybuf
[t
]);
9110 add_command_key (keybuf
[t
]);
9119 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9120 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9121 The sequence is sufficient to specify a non-prefix command in the
9122 current local and global maps.
9124 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9125 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9126 as a continuation of the previous key.
9128 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9129 convert the last event to lower case. (Normally any upper case event
9130 is converted to lower case if the original event is undefined and the lower
9131 case equivalent is defined.) A non-nil value is appropriate for reading
9132 a key sequence to be defined.
9134 A C-g typed while in this function is treated like any other character,
9135 and `quit-flag' is not set.
9137 If the key sequence starts with a mouse click, then the sequence is read
9138 using the keymaps of the buffer of the window clicked in, not the buffer
9139 of the selected window as normal.
9141 `read-key-sequence' drops unbound button-down events, since you normally
9142 only care about the click or drag events which follow them. If a drag
9143 or multi-click event is unbound, but the corresponding click event would
9144 be bound, `read-key-sequence' turns the event into a click event at the
9145 drag's starting position. This means that you don't have to distinguish
9146 between click and drag, double, or triple events unless you want to.
9148 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9149 lines separating windows, and scroll bars with imaginary keys
9150 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9152 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9153 function will process a switch-frame event if the user switches frames
9154 before typing anything. If the user switches frames in the middle of a
9155 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9156 is nil, then the event will be put off until after the current key sequence.
9158 `read-key-sequence' checks `function-key-map' for function key
9159 sequences, where they wouldn't conflict with ordinary bindings. See
9160 `function-key-map' for more details.
9162 The optional fifth argument COMMAND-LOOP, if non-nil, means
9163 that this key sequence is being read by something that will
9164 read commands one after another. It should be nil if the caller
9165 will read just one key sequence. */)
9166 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9168 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9169 Lisp_Object can_return_switch_frame
, command_loop
;
9171 Lisp_Object keybuf
[30];
9173 struct gcpro gcpro1
;
9174 int count
= specpdl_ptr
- specpdl
;
9177 CHECK_STRING (prompt
);
9180 specbind (Qinput_method_exit_on_first_char
,
9181 (NILP (command_loop
) ? Qt
: Qnil
));
9182 specbind (Qinput_method_use_echo_area
,
9183 (NILP (command_loop
) ? Qt
: Qnil
));
9185 bzero (keybuf
, sizeof keybuf
);
9187 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9189 if (NILP (continue_echo
))
9191 this_command_key_count
= 0;
9192 this_single_command_key_start
= 0;
9195 #ifdef HAVE_X_WINDOWS
9196 if (display_hourglass_p
)
9197 cancel_hourglass ();
9200 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9201 prompt
, ! NILP (dont_downcase_last
),
9202 ! NILP (can_return_switch_frame
), 0);
9204 #if 0 /* The following is fine for code reading a key sequence and
9205 then proceeding with a lenghty computation, but it's not good
9206 for code reading keys in a loop, like an input method. */
9207 #ifdef HAVE_X_WINDOWS
9208 if (display_hourglass_p
)
9219 return unbind_to (count
, make_event_array (i
, keybuf
));
9222 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9223 Sread_key_sequence_vector
, 1, 5, 0,
9224 doc
: /* Like `read-key-sequence' but always return a vector. */)
9225 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9227 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9228 Lisp_Object can_return_switch_frame
, command_loop
;
9230 Lisp_Object keybuf
[30];
9232 struct gcpro gcpro1
;
9233 int count
= specpdl_ptr
- specpdl
;
9236 CHECK_STRING (prompt
);
9239 specbind (Qinput_method_exit_on_first_char
,
9240 (NILP (command_loop
) ? Qt
: Qnil
));
9241 specbind (Qinput_method_use_echo_area
,
9242 (NILP (command_loop
) ? Qt
: Qnil
));
9244 bzero (keybuf
, sizeof keybuf
);
9246 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9248 if (NILP (continue_echo
))
9250 this_command_key_count
= 0;
9251 this_single_command_key_start
= 0;
9254 #ifdef HAVE_X_WINDOWS
9255 if (display_hourglass_p
)
9256 cancel_hourglass ();
9259 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9260 prompt
, ! NILP (dont_downcase_last
),
9261 ! NILP (can_return_switch_frame
), 0);
9263 #ifdef HAVE_X_WINDOWS
9264 if (display_hourglass_p
)
9274 return unbind_to (count
, Fvector (i
, keybuf
));
9277 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9278 doc
: /* Execute CMD as an editor command.
9279 CMD must be a symbol that satisfies the `commandp' predicate.
9280 Optional second arg RECORD-FLAG non-nil
9281 means unconditionally put this command in `command-history'.
9282 Otherwise, that is done only if an arg is read using the minibuffer.
9283 The argument KEYS specifies the value to use instead of (this-command-keys)
9284 when reading the arguments; if it is nil, (this-command-keys) is used.
9285 The argument SPECIAL, if non-nil, means that this command is executing
9286 a special event, so ignore the prefix argument and don't clear it. */)
9287 (cmd
, record_flag
, keys
, special
)
9288 Lisp_Object cmd
, record_flag
, keys
, special
;
9290 register Lisp_Object final
;
9291 register Lisp_Object tem
;
9292 Lisp_Object prefixarg
;
9293 struct backtrace backtrace
;
9294 extern int debug_on_next_call
;
9296 debug_on_next_call
= 0;
9300 prefixarg
= current_kboard
->Vprefix_arg
;
9301 Vcurrent_prefix_arg
= prefixarg
;
9302 current_kboard
->Vprefix_arg
= Qnil
;
9309 tem
= Fget (cmd
, Qdisabled
);
9310 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9312 tem
= Fsymbol_value (Qdisabled_command_hook
);
9314 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9320 final
= Findirect_function (cmd
);
9322 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9324 struct gcpro gcpro1
, gcpro2
;
9326 GCPRO2 (cmd
, prefixarg
);
9327 do_autoload (final
, cmd
);
9334 if (STRINGP (final
) || VECTORP (final
))
9336 /* If requested, place the macro in the command history. For
9337 other sorts of commands, call-interactively takes care of
9339 if (!NILP (record_flag
))
9342 = Fcons (Fcons (Qexecute_kbd_macro
,
9343 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9346 /* Don't keep command history around forever. */
9347 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9349 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9351 XSETCDR (tem
, Qnil
);
9355 return Fexecute_kbd_macro (final
, prefixarg
);
9358 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9360 backtrace
.next
= backtrace_list
;
9361 backtrace_list
= &backtrace
;
9362 backtrace
.function
= &Qcall_interactively
;
9363 backtrace
.args
= &cmd
;
9364 backtrace
.nargs
= 1;
9365 backtrace
.evalargs
= 0;
9367 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9369 backtrace_list
= backtrace
.next
;
9377 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9379 doc
: /* Read function name, then read its arguments and call it. */)
9381 Lisp_Object prefixarg
;
9383 Lisp_Object function
;
9385 int saved_last_point_position
;
9386 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9387 Lisp_Object bindings
, value
;
9388 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9390 saved_keys
= Fvector (this_command_key_count
,
9391 XVECTOR (this_command_keys
)->contents
);
9392 saved_last_point_position_buffer
= last_point_position_buffer
;
9393 saved_last_point_position
= last_point_position
;
9395 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9397 if (EQ (prefixarg
, Qminus
))
9399 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9400 strcpy (buf
, "C-u ");
9401 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9403 if (sizeof (int) == sizeof (EMACS_INT
))
9404 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9405 else if (sizeof (long) == sizeof (EMACS_INT
))
9406 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9410 else if (INTEGERP (prefixarg
))
9412 if (sizeof (int) == sizeof (EMACS_INT
))
9413 sprintf (buf
, "%d ", XINT (prefixarg
));
9414 else if (sizeof (long) == sizeof (EMACS_INT
))
9415 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9420 /* This isn't strictly correct if execute-extended-command
9421 is bound to anything else. Perhaps it should use
9422 this_command_keys? */
9423 strcat (buf
, "M-x ");
9425 /* Prompt with buf, and then read a string, completing from and
9426 restricting to the set of all defined commands. Don't provide
9427 any initial input. Save the command read on the extended-command
9429 function
= Fcompleting_read (build_string (buf
),
9430 Vobarray
, Qcommandp
,
9431 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9434 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
9435 error ("No command name given");
9437 /* Set this_command_keys to the concatenation of saved_keys and
9438 function, followed by a RET. */
9440 struct Lisp_String
*str
;
9444 this_command_key_count
= 0;
9445 this_single_command_key_start
= 0;
9447 keys
= XVECTOR (saved_keys
)->contents
;
9448 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9449 add_command_key (keys
[i
]);
9451 str
= XSTRING (function
);
9452 for (i
= 0; i
< str
->size
; i
++)
9453 add_command_key (Faref (function
, make_number (i
)));
9455 add_command_key (make_number ('\015'));
9458 last_point_position
= saved_last_point_position
;
9459 last_point_position_buffer
= saved_last_point_position_buffer
;
9463 function
= Fintern (function
, Qnil
);
9464 current_kboard
->Vprefix_arg
= prefixarg
;
9465 Vthis_command
= function
;
9466 real_this_command
= function
;
9468 /* If enabled, show which key runs this command. */
9469 if (!NILP (Vsuggest_key_bindings
)
9470 && NILP (Vexecuting_macro
)
9471 && SYMBOLP (function
))
9472 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9478 GCPRO2 (bindings
, value
);
9479 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9481 /* If the command has a key binding, print it now. */
9482 if (!NILP (bindings
)
9483 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9486 /* But first wait, and skip the message if there is input. */
9488 if (!NILP (echo_area_buffer
[0]))
9489 /* This command displayed something in the echo area;
9490 so wait a few seconds, then display our suggestion message. */
9491 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9492 ? XINT (Vsuggest_key_bindings
) : 2);
9494 /* This command left the echo area empty,
9495 so display our message immediately. */
9498 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9499 && ! CONSP (Vunread_command_events
))
9501 Lisp_Object binding
;
9503 int message_p
= push_message ();
9504 int count
= BINDING_STACK_SIZE ();
9506 record_unwind_protect (push_message_unwind
, Qnil
);
9507 binding
= Fkey_description (bindings
);
9510 = (char *) alloca (XSTRING (SYMBOL_NAME (function
))->size
9511 + STRING_BYTES (XSTRING (binding
))
9513 sprintf (newmessage
, "You can run the command `%s' with %s",
9514 XSTRING (SYMBOL_NAME (function
))->data
,
9515 XSTRING (binding
)->data
);
9516 message2_nolog (newmessage
,
9517 strlen (newmessage
),
9518 STRING_MULTIBYTE (binding
));
9519 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9520 ? Vsuggest_key_bindings
: make_number (2)),
9525 unbind_to (count
, Qnil
);
9529 RETURN_UNGCPRO (value
);
9533 /* Return nonzero if input events are pending. */
9536 detect_input_pending ()
9539 get_input_pending (&input_pending
, 0);
9541 return input_pending
;
9544 /* Return nonzero if input events are pending, and run any pending timers. */
9547 detect_input_pending_run_timers (do_display
)
9550 int old_timers_run
= timers_run
;
9553 get_input_pending (&input_pending
, 1);
9555 if (old_timers_run
!= timers_run
&& do_display
)
9557 redisplay_preserve_echo_area (8);
9558 /* The following fixes a bug when using lazy-lock with
9559 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9560 from an idle timer function. The symptom of the bug is that
9561 the cursor sometimes doesn't become visible until the next X
9562 event is processed. --gerd. */
9564 rif
->flush_display (NULL
);
9567 return input_pending
;
9570 /* This is called in some cases before a possible quit.
9571 It cases the next call to detect_input_pending to recompute input_pending.
9572 So calling this function unnecessarily can't do any harm. */
9575 clear_input_pending ()
9580 /* Return nonzero if there are pending requeued events.
9581 This isn't used yet. The hope is to make wait_reading_process_input
9582 call it, and return if it runs Lisp code that unreads something.
9583 The problem is, kbd_buffer_get_event needs to be fixed to know what
9584 to do in that case. It isn't trivial. */
9587 requeued_events_pending_p ()
9589 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9593 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9594 doc
: /* Return t if command input is currently available with no wait.
9595 Actually, the value is nil only if we can be sure that no input is available;
9596 if there is a doubt, the value is t. */)
9599 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9602 get_filtered_input_pending (&input_pending
, 1, 1);
9603 return input_pending
> 0 ? Qt
: Qnil
;
9606 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9607 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9610 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9613 if (total_keys
< NUM_RECENT_KEYS
)
9614 return Fvector (total_keys
, keys
);
9617 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9618 bcopy (keys
+ recent_keys_index
,
9619 XVECTOR (val
)->contents
,
9620 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9622 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9623 recent_keys_index
* sizeof (Lisp_Object
));
9628 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9629 doc
: /* Return the key sequence that invoked this command.
9630 However, if the command has called `read-key-sequence', it returns
9631 the last key sequence that has been read.
9632 The value is a string or a vector. */)
9635 return make_event_array (this_command_key_count
,
9636 XVECTOR (this_command_keys
)->contents
);
9639 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9640 doc
: /* Return the key sequence that invoked this command, as a vector.
9641 However, if the command has called `read-key-sequence', it returns
9642 the last key sequence that has been read. */)
9645 return Fvector (this_command_key_count
,
9646 XVECTOR (this_command_keys
)->contents
);
9649 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9650 Sthis_single_command_keys
, 0, 0, 0,
9651 doc
: /* Return the key sequence that invoked this command.
9652 More generally, it returns the last key sequence read, either by
9653 the command loop or by `read-key-sequence'.
9654 Unlike `this-command-keys', this function's value
9655 does not include prefix arguments.
9656 The value is always a vector. */)
9659 return Fvector (this_command_key_count
9660 - this_single_command_key_start
,
9661 (XVECTOR (this_command_keys
)->contents
9662 + this_single_command_key_start
));
9665 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9666 Sthis_single_command_raw_keys
, 0, 0, 0,
9667 doc
: /* Return the raw events that were read for this command.
9668 More generally, it returns the last key sequence read, either by
9669 the command loop or by `read-key-sequence'.
9670 Unlike `this-single-command-keys', this function's value
9671 shows the events before all translations (except for input methods).
9672 The value is always a vector. */)
9675 return Fvector (raw_keybuf_count
,
9676 (XVECTOR (raw_keybuf
)->contents
));
9679 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9680 Sreset_this_command_lengths
, 0, 0, 0,
9681 doc
: /* Used for complicated reasons in `universal-argument-other-key'.
9683 `universal-argument-other-key' rereads the event just typed.
9684 It then gets translated through `function-key-map'.
9685 The translated event gets included in the echo area and in
9686 the value of `this-command-keys' in addition to the raw original event.
9689 Calling this function directs the translated event to replace
9690 the original event, so that only one version of the event actually
9691 appears in the echo area and in the value of `this-command-keys'. */)
9694 before_command_restore_flag
= 1;
9695 before_command_key_count_1
= before_command_key_count
;
9696 before_command_echo_length_1
= before_command_echo_length
;
9700 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
9701 Sclear_this_command_keys
, 0, 0, 0,
9702 doc
: /* Clear out the vector that `this-command-keys' returns.
9703 Also clear the record of the last 100 events. */)
9708 this_command_key_count
= 0;
9710 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
9711 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
9713 recent_keys_index
= 0;
9717 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
9718 doc
: /* Return the current depth in recursive edits. */)
9722 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
9726 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
9727 "FOpen dribble file: ",
9728 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
9729 If FILE is nil, close any open dribble file. */)
9740 file
= Fexpand_file_name (file
, Qnil
);
9741 dribble
= fopen (XSTRING (file
)->data
, "w");
9743 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
9748 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
9749 doc
: /* Discard the contents of the terminal input buffer.
9750 Also cancel any kbd macro being defined. */)
9753 current_kboard
->defining_kbd_macro
= Qnil
;
9754 update_mode_lines
++;
9756 Vunread_command_events
= Qnil
;
9757 unread_command_char
= -1;
9759 discard_tty_input ();
9761 kbd_fetch_ptr
= kbd_store_ptr
;
9762 Ffillarray (kbd_buffer_gcpro
, Qnil
);
9768 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
9769 doc
: /* Stop Emacs and return to superior process. You can resume later.
9770 If `cannot-suspend' is non-nil, or if the system doesn't support job
9771 control, run a subshell instead.
9773 If optional arg STUFFSTRING is non-nil, its characters are stuffed
9774 to be read as terminal input by Emacs's parent, after suspension.
9776 Before suspending, run the normal hook `suspend-hook'.
9777 After resumption run the normal hook `suspend-resume-hook'.
9779 Some operating systems cannot stop the Emacs process and resume it later.
9780 On such systems, Emacs starts a subshell instead of suspending. */)
9782 Lisp_Object stuffstring
;
9784 int count
= specpdl_ptr
- specpdl
;
9785 int old_height
, old_width
;
9787 struct gcpro gcpro1
;
9789 if (!NILP (stuffstring
))
9790 CHECK_STRING (stuffstring
);
9792 /* Run the functions in suspend-hook. */
9793 if (!NILP (Vrun_hooks
))
9794 call1 (Vrun_hooks
, intern ("suspend-hook"));
9796 GCPRO1 (stuffstring
);
9797 get_frame_size (&old_width
, &old_height
);
9799 /* sys_suspend can get an error if it tries to fork a subshell
9800 and the system resources aren't available for that. */
9801 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
9803 stuff_buffered_input (stuffstring
);
9808 unbind_to (count
, Qnil
);
9810 /* Check if terminal/window size has changed.
9811 Note that this is not useful when we are running directly
9812 with a window system; but suspend should be disabled in that case. */
9813 get_frame_size (&width
, &height
);
9814 if (width
!= old_width
|| height
!= old_height
)
9815 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
9817 /* Run suspend-resume-hook. */
9818 if (!NILP (Vrun_hooks
))
9819 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
9825 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
9826 Then in any case stuff anything Emacs has read ahead and not used. */
9829 stuff_buffered_input (stuffstring
)
9830 Lisp_Object stuffstring
;
9832 /* stuff_char works only in BSD, versions 4.2 and up. */
9835 register unsigned char *p
;
9837 if (STRINGP (stuffstring
))
9841 p
= XSTRING (stuffstring
)->data
;
9842 count
= STRING_BYTES (XSTRING (stuffstring
));
9848 /* Anything we have read ahead, put back for the shell to read. */
9849 /* ?? What should this do when we have multiple keyboards??
9850 Should we ignore anything that was typed in at the "wrong" kboard? */
9851 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
9855 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
9856 kbd_fetch_ptr
= kbd_buffer
;
9857 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
9858 stuff_char (kbd_fetch_ptr
->code
);
9860 kbd_fetch_ptr
->kind
= NO_EVENT
;
9861 idx
= 2 * (kbd_fetch_ptr
- kbd_buffer
);
9862 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
9863 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
9868 #endif /* BSD_SYSTEM and not BSD4_1 */
9872 set_waiting_for_input (time_to_clear
)
9873 EMACS_TIME
*time_to_clear
;
9875 input_available_clear_time
= time_to_clear
;
9877 /* Tell interrupt_signal to throw back to read_char, */
9878 waiting_for_input
= 1;
9880 /* If interrupt_signal was called before and buffered a C-g,
9881 make it run again now, to avoid timing error. */
9882 if (!NILP (Vquit_flag
))
9883 quit_throw_to_read_char ();
9887 clear_waiting_for_input ()
9889 /* Tell interrupt_signal not to throw back to read_char, */
9890 waiting_for_input
= 0;
9891 input_available_clear_time
= 0;
9894 /* This routine is called at interrupt level in response to C-g.
9896 If interrupt_input, this is the handler for SIGINT. Otherwise, it
9897 is called from kbd_buffer_store_event, in handling SIGIO or
9900 If `waiting_for_input' is non zero, then unless `echoing' is
9901 nonzero, immediately throw back to read_char.
9903 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
9904 eval to throw, when it gets a chance. If quit-flag is already
9905 non-nil, it stops the job right away. */
9908 interrupt_signal (signalnum
) /* If we don't have an argument, */
9909 int signalnum
; /* some compilers complain in signal calls. */
9912 /* Must preserve main program's value of errno. */
9913 int old_errno
= errno
;
9914 struct frame
*sf
= SELECTED_FRAME ();
9916 #if defined (USG) && !defined (POSIX_SIGNALS)
9917 if (!read_socket_hook
&& NILP (Vwindow_system
))
9919 /* USG systems forget handlers when they are used;
9920 must reestablish each time */
9921 signal (SIGINT
, interrupt_signal
);
9922 signal (SIGQUIT
, interrupt_signal
);
9928 if (!NILP (Vquit_flag
)
9929 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
9931 /* If SIGINT isn't blocked, don't let us be interrupted by
9932 another SIGINT, it might be harmful due to non-reentrancy
9933 in I/O functions. */
9934 sigblock (sigmask (SIGINT
));
9939 #ifdef SIGTSTP /* Support possible in later USG versions */
9941 * On systems which can suspend the current process and return to the original
9942 * shell, this command causes the user to end up back at the shell.
9943 * The "Auto-save" and "Abort" questions are not asked until
9944 * the user elects to return to emacs, at which point he can save the current
9945 * job and either dump core or continue.
9950 if (sys_suspend () == -1)
9952 printf ("Not running as a subprocess;\n");
9953 printf ("you can continue or abort.\n");
9956 /* Perhaps should really fork an inferior shell?
9957 But that would not provide any way to get back
9958 to the original shell, ever. */
9959 printf ("No support for stopping a process on this operating system;\n");
9960 printf ("you can continue or abort.\n");
9961 #endif /* not VMS */
9962 #endif /* not SIGTSTP */
9964 /* We must remain inside the screen area when the internal terminal
9965 is used. Note that [Enter] is not echoed by dos. */
9968 /* It doesn't work to autosave while GC is in progress;
9969 the code used for auto-saving doesn't cope with the mark bit. */
9970 if (!gc_in_progress
)
9972 printf ("Auto-save? (y or n) ");
9974 if (((c
= getchar ()) & ~040) == 'Y')
9976 Fdo_auto_save (Qt
, Qnil
);
9978 printf ("\r\nAuto-save done");
9979 #else /* not MSDOS */
9980 printf ("Auto-save done\n");
9981 #endif /* not MSDOS */
9983 while (c
!= '\n') c
= getchar ();
9987 /* During GC, it must be safe to reenable quitting again. */
9988 Vinhibit_quit
= Qnil
;
9991 #endif /* not MSDOS */
9992 printf ("Garbage collection in progress; cannot auto-save now\r\n");
9993 printf ("but will instead do a real quit after garbage collection ends\r\n");
9998 printf ("\r\nAbort? (y or n) ");
9999 #else /* not MSDOS */
10001 printf ("Abort (and enter debugger)? (y or n) ");
10002 #else /* not VMS */
10003 printf ("Abort (and dump core)? (y or n) ");
10004 #endif /* not VMS */
10005 #endif /* not MSDOS */
10007 if (((c
= getchar ()) & ~040) == 'Y')
10009 while (c
!= '\n') c
= getchar ();
10011 printf ("\r\nContinuing...\r\n");
10012 #else /* not MSDOS */
10013 printf ("Continuing...\n");
10014 #endif /* not MSDOS */
10021 /* If executing a function that wants to be interrupted out of
10022 and the user has not deferred quitting by binding `inhibit-quit'
10023 then quit right away. */
10024 if (immediate_quit
&& NILP (Vinhibit_quit
))
10026 struct gl_state_s saved
;
10027 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10029 immediate_quit
= 0;
10032 GCPRO4 (saved
.object
, saved
.global_code
,
10033 saved
.current_syntax_table
, saved
.old_prop
);
10034 Fsignal (Qquit
, Qnil
);
10039 /* Else request quit when it's safe */
10043 if (waiting_for_input
&& !echoing
)
10044 quit_throw_to_read_char ();
10049 /* Handle a C-g by making read_char return C-g. */
10052 quit_throw_to_read_char ()
10055 /* Prevent another signal from doing this before we finish. */
10056 clear_waiting_for_input ();
10059 Vunread_command_events
= Qnil
;
10060 unread_command_char
= -1;
10062 #if 0 /* Currently, sit_for is called from read_char without turning
10063 off polling. And that can call set_waiting_for_input.
10064 It seems to be harmless. */
10065 #ifdef POLL_FOR_INPUT
10066 /* May be > 1 if in recursive minibuffer. */
10067 if (poll_suppress_count
== 0)
10071 if (FRAMEP (internal_last_event_frame
)
10072 && !EQ (internal_last_event_frame
, selected_frame
))
10073 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10076 _longjmp (getcjmp
, 1);
10079 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10080 doc
: /* Set mode of reading keyboard input.
10081 First arg INTERRUPT non-nil means use input interrupts;
10082 nil means use CBREAK mode.
10083 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10084 (no effect except in CBREAK mode).
10085 Third arg META t means accept 8-bit input (for a Meta key).
10086 META nil means ignore the top bit, on the assumption it is parity.
10087 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10088 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10089 See also `current-input-mode'. */)
10090 (interrupt
, flow
, meta
, quit
)
10091 Lisp_Object interrupt
, flow
, meta
, quit
;
10094 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10095 error ("set-input-mode: QUIT must be an ASCII character");
10097 #ifdef POLL_FOR_INPUT
10102 /* this causes startup screen to be restored and messes with the mouse */
10103 reset_sys_modes ();
10107 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10108 if (read_socket_hook
)
10110 /* When using X, don't give the user a real choice,
10111 because we haven't implemented the mechanisms to support it. */
10112 #ifdef NO_SOCK_SIGIO
10113 interrupt_input
= 0;
10114 #else /* not NO_SOCK_SIGIO */
10115 interrupt_input
= 1;
10116 #endif /* NO_SOCK_SIGIO */
10119 interrupt_input
= !NILP (interrupt
);
10120 #else /* not SIGIO */
10121 interrupt_input
= 0;
10122 #endif /* not SIGIO */
10124 /* Our VMS input only works by interrupts, as of now. */
10126 interrupt_input
= 1;
10129 flow_control
= !NILP (flow
);
10132 else if (EQ (meta
, Qt
))
10137 /* Don't let this value be out of range. */
10138 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10144 #ifdef POLL_FOR_INPUT
10145 poll_suppress_count
= 1;
10151 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10152 doc
: /* Return information about the way Emacs currently reads keyboard input.
10153 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10154 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10155 nil, Emacs is using CBREAK mode.
10156 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10157 terminal; this does not apply if Emacs uses interrupt-driven input.
10158 META is t if accepting 8-bit input with 8th bit as Meta flag.
10159 META nil means ignoring the top bit, on the assumption it is parity.
10160 META is neither t nor nil if accepting 8-bit input and using
10161 all 8 bits as the character code.
10162 QUIT is the character Emacs currently uses to quit.
10163 The elements of this list correspond to the arguments of
10164 `set-input-mode'. */)
10167 Lisp_Object val
[4];
10169 val
[0] = interrupt_input
? Qt
: Qnil
;
10170 val
[1] = flow_control
? Qt
: Qnil
;
10171 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10172 XSETFASTINT (val
[3], quit_char
);
10174 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10179 * Set up a new kboard object with reasonable initial values.
10185 kb
->Voverriding_terminal_local_map
= Qnil
;
10186 kb
->Vlast_command
= Qnil
;
10187 kb
->Vreal_last_command
= Qnil
;
10188 kb
->Vprefix_arg
= Qnil
;
10189 kb
->Vlast_prefix_arg
= Qnil
;
10190 kb
->kbd_queue
= Qnil
;
10191 kb
->kbd_queue_has_data
= 0;
10192 kb
->immediate_echo
= 0;
10193 kb
->echo_string
= Qnil
;
10194 kb
->echo_after_prompt
= -1;
10195 kb
->kbd_macro_buffer
= 0;
10196 kb
->kbd_macro_bufsize
= 0;
10197 kb
->defining_kbd_macro
= Qnil
;
10198 kb
->Vlast_kbd_macro
= Qnil
;
10199 kb
->reference_count
= 0;
10200 kb
->Vsystem_key_alist
= Qnil
;
10201 kb
->system_key_syms
= Qnil
;
10202 kb
->Vdefault_minibuffer_frame
= Qnil
;
10206 * Destroy the contents of a kboard object, but not the object itself.
10207 * We use this just before deleting it, or if we're going to initialize
10208 * it a second time.
10214 if (kb
->kbd_macro_buffer
)
10215 xfree (kb
->kbd_macro_buffer
);
10218 #ifdef MULTI_KBOARD
10220 /* Free KB and memory referenced from it. */
10228 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10231 *kbp
= kb
->next_kboard
;
10233 /* Prevent a dangling reference to KB. */
10234 if (kb
== current_kboard
10235 && FRAMEP (selected_frame
)
10236 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10238 current_kboard
= XFRAME (selected_frame
)->kboard
;
10239 if (current_kboard
== kb
)
10247 #endif /* MULTI_KBOARD */
10252 /* This is correct before outermost invocation of the editor loop */
10253 command_loop_level
= -1;
10254 immediate_quit
= 0;
10255 quit_char
= Ctl ('g');
10256 Vunread_command_events
= Qnil
;
10257 unread_command_char
= -1;
10258 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10260 recent_keys_index
= 0;
10261 kbd_fetch_ptr
= kbd_buffer
;
10262 kbd_store_ptr
= kbd_buffer
;
10263 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10265 do_mouse_tracking
= Qnil
;
10269 /* This means that command_loop_1 won't try to select anything the first
10271 internal_last_event_frame
= Qnil
;
10272 Vlast_event_frame
= internal_last_event_frame
;
10274 #ifdef MULTI_KBOARD
10275 current_kboard
= initial_kboard
;
10277 wipe_kboard (current_kboard
);
10278 init_kboard (current_kboard
);
10280 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10282 signal (SIGINT
, interrupt_signal
);
10283 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10284 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10285 SIGQUIT and we can't tell which one it will give us. */
10286 signal (SIGQUIT
, interrupt_signal
);
10287 #endif /* HAVE_TERMIO */
10289 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10291 if (!noninteractive
)
10292 signal (SIGIO
, input_available_signal
);
10295 /* Use interrupt input by default, if it works and noninterrupt input
10296 has deficiencies. */
10298 #ifdef INTERRUPT_INPUT
10299 interrupt_input
= 1;
10301 interrupt_input
= 0;
10304 /* Our VMS input only works by interrupts, as of now. */
10306 interrupt_input
= 1;
10312 if (keyboard_init_hook
)
10313 (*keyboard_init_hook
) ();
10315 #ifdef POLL_FOR_INPUT
10316 poll_suppress_count
= 1;
10321 /* This type's only use is in syms_of_keyboard, to initialize the
10322 event header symbols and put properties on them. */
10323 struct event_head
{
10329 struct event_head head_table
[] = {
10330 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10331 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10332 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10333 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10334 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10335 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10336 {&Qselect_window
, "select-window", &Qselect_window
}
10340 syms_of_keyboard ()
10342 Vpre_help_message
= Qnil
;
10343 staticpro (&Vpre_help_message
);
10345 Vlispy_mouse_stem
= build_string ("mouse");
10346 staticpro (&Vlispy_mouse_stem
);
10349 QCimage
= intern (":image");
10350 staticpro (&QCimage
);
10352 staticpro (&Qhelp_echo
);
10353 Qhelp_echo
= intern ("help-echo");
10355 staticpro (&item_properties
);
10356 item_properties
= Qnil
;
10358 staticpro (&tool_bar_item_properties
);
10359 tool_bar_item_properties
= Qnil
;
10360 staticpro (&tool_bar_items_vector
);
10361 tool_bar_items_vector
= Qnil
;
10363 staticpro (&real_this_command
);
10364 real_this_command
= Qnil
;
10366 Qtimer_event_handler
= intern ("timer-event-handler");
10367 staticpro (&Qtimer_event_handler
);
10369 Qdisabled_command_hook
= intern ("disabled-command-hook");
10370 staticpro (&Qdisabled_command_hook
);
10372 Qself_insert_command
= intern ("self-insert-command");
10373 staticpro (&Qself_insert_command
);
10375 Qforward_char
= intern ("forward-char");
10376 staticpro (&Qforward_char
);
10378 Qbackward_char
= intern ("backward-char");
10379 staticpro (&Qbackward_char
);
10381 Qdisabled
= intern ("disabled");
10382 staticpro (&Qdisabled
);
10384 Qundefined
= intern ("undefined");
10385 staticpro (&Qundefined
);
10387 Qpre_command_hook
= intern ("pre-command-hook");
10388 staticpro (&Qpre_command_hook
);
10390 Qpost_command_hook
= intern ("post-command-hook");
10391 staticpro (&Qpost_command_hook
);
10393 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10394 staticpro (&Qpost_command_idle_hook
);
10396 Qdeferred_action_function
= intern ("deferred-action-function");
10397 staticpro (&Qdeferred_action_function
);
10399 Qcommand_hook_internal
= intern ("command-hook-internal");
10400 staticpro (&Qcommand_hook_internal
);
10402 Qfunction_key
= intern ("function-key");
10403 staticpro (&Qfunction_key
);
10404 Qmouse_click
= intern ("mouse-click");
10405 staticpro (&Qmouse_click
);
10407 Qmouse_wheel
= intern ("mouse-wheel");
10408 staticpro (&Qmouse_wheel
);
10409 Qlanguage_change
= intern ("language-change");
10410 staticpro (&Qlanguage_change
);
10412 Qdrag_n_drop
= intern ("drag-n-drop");
10413 staticpro (&Qdrag_n_drop
);
10415 Qsave_session
= intern ("save-session");
10416 staticpro(&Qsave_session
);
10418 Qusr1_signal
= intern ("usr1-signal");
10419 staticpro (&Qusr1_signal
);
10420 Qusr2_signal
= intern ("usr2-signal");
10421 staticpro (&Qusr2_signal
);
10423 Qmenu_enable
= intern ("menu-enable");
10424 staticpro (&Qmenu_enable
);
10425 Qmenu_alias
= intern ("menu-alias");
10426 staticpro (&Qmenu_alias
);
10427 QCenable
= intern (":enable");
10428 staticpro (&QCenable
);
10429 QCvisible
= intern (":visible");
10430 staticpro (&QCvisible
);
10431 QChelp
= intern (":help");
10432 staticpro (&QChelp
);
10433 QCfilter
= intern (":filter");
10434 staticpro (&QCfilter
);
10435 QCbutton
= intern (":button");
10436 staticpro (&QCbutton
);
10437 QCkeys
= intern (":keys");
10438 staticpro (&QCkeys
);
10439 QCkey_sequence
= intern (":key-sequence");
10440 staticpro (&QCkey_sequence
);
10441 QCtoggle
= intern (":toggle");
10442 staticpro (&QCtoggle
);
10443 QCradio
= intern (":radio");
10444 staticpro (&QCradio
);
10446 Qmode_line
= intern ("mode-line");
10447 staticpro (&Qmode_line
);
10448 Qvertical_line
= intern ("vertical-line");
10449 staticpro (&Qvertical_line
);
10450 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10451 staticpro (&Qvertical_scroll_bar
);
10452 Qmenu_bar
= intern ("menu-bar");
10453 staticpro (&Qmenu_bar
);
10455 Qabove_handle
= intern ("above-handle");
10456 staticpro (&Qabove_handle
);
10457 Qhandle
= intern ("handle");
10458 staticpro (&Qhandle
);
10459 Qbelow_handle
= intern ("below-handle");
10460 staticpro (&Qbelow_handle
);
10461 Qup
= intern ("up");
10463 Qdown
= intern ("down");
10464 staticpro (&Qdown
);
10465 Qtop
= intern ("top");
10467 Qbottom
= intern ("bottom");
10468 staticpro (&Qbottom
);
10469 Qend_scroll
= intern ("end-scroll");
10470 staticpro (&Qend_scroll
);
10471 Qratio
= intern ("ratio");
10472 staticpro (&Qratio
);
10474 Qevent_kind
= intern ("event-kind");
10475 staticpro (&Qevent_kind
);
10476 Qevent_symbol_elements
= intern ("event-symbol-elements");
10477 staticpro (&Qevent_symbol_elements
);
10478 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10479 staticpro (&Qevent_symbol_element_mask
);
10480 Qmodifier_cache
= intern ("modifier-cache");
10481 staticpro (&Qmodifier_cache
);
10483 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10484 staticpro (&Qrecompute_lucid_menubar
);
10485 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10486 staticpro (&Qactivate_menubar_hook
);
10488 Qpolling_period
= intern ("polling-period");
10489 staticpro (&Qpolling_period
);
10491 Qinput_method_function
= intern ("input-method-function");
10492 staticpro (&Qinput_method_function
);
10494 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10495 staticpro (&Qinput_method_exit_on_first_char
);
10496 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10497 staticpro (&Qinput_method_use_echo_area
);
10499 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10500 Fset (Qinput_method_use_echo_area
, Qnil
);
10502 last_point_position_buffer
= Qnil
;
10505 struct event_head
*p
;
10507 for (p
= head_table
;
10508 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10511 *p
->var
= intern (p
->name
);
10512 staticpro (p
->var
);
10513 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10514 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10518 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10519 staticpro (&button_down_location
);
10520 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10521 staticpro (&mouse_syms
);
10525 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10527 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10528 for (i
= 0; i
< len
; i
++)
10529 if (modifier_names
[i
])
10530 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10531 staticpro (&modifier_symbols
);
10534 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10535 staticpro (&recent_keys
);
10537 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10538 staticpro (&this_command_keys
);
10540 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10541 staticpro (&raw_keybuf
);
10543 Qextended_command_history
= intern ("extended-command-history");
10544 Fset (Qextended_command_history
, Qnil
);
10545 staticpro (&Qextended_command_history
);
10547 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10548 staticpro (&kbd_buffer_gcpro
);
10550 accent_key_syms
= Qnil
;
10551 staticpro (&accent_key_syms
);
10553 func_key_syms
= Qnil
;
10554 staticpro (&func_key_syms
);
10557 mouse_wheel_syms
= Qnil
;
10558 staticpro (&mouse_wheel_syms
);
10560 drag_n_drop_syms
= Qnil
;
10561 staticpro (&drag_n_drop_syms
);
10564 unread_switch_frame
= Qnil
;
10565 staticpro (&unread_switch_frame
);
10567 internal_last_event_frame
= Qnil
;
10568 staticpro (&internal_last_event_frame
);
10570 read_key_sequence_cmd
= Qnil
;
10571 staticpro (&read_key_sequence_cmd
);
10573 menu_bar_one_keymap_changed_items
= Qnil
;
10574 staticpro (&menu_bar_one_keymap_changed_items
);
10576 defsubr (&Sevent_convert_list
);
10577 defsubr (&Sread_key_sequence
);
10578 defsubr (&Sread_key_sequence_vector
);
10579 defsubr (&Srecursive_edit
);
10581 defsubr (&Strack_mouse
);
10583 defsubr (&Sinput_pending_p
);
10584 defsubr (&Scommand_execute
);
10585 defsubr (&Srecent_keys
);
10586 defsubr (&Sthis_command_keys
);
10587 defsubr (&Sthis_command_keys_vector
);
10588 defsubr (&Sthis_single_command_keys
);
10589 defsubr (&Sthis_single_command_raw_keys
);
10590 defsubr (&Sreset_this_command_lengths
);
10591 defsubr (&Sclear_this_command_keys
);
10592 defsubr (&Ssuspend_emacs
);
10593 defsubr (&Sabort_recursive_edit
);
10594 defsubr (&Sexit_recursive_edit
);
10595 defsubr (&Srecursion_depth
);
10596 defsubr (&Stop_level
);
10597 defsubr (&Sdiscard_input
);
10598 defsubr (&Sopen_dribble_file
);
10599 defsubr (&Sset_input_mode
);
10600 defsubr (&Scurrent_input_mode
);
10601 defsubr (&Sexecute_extended_command
);
10603 DEFVAR_LISP ("last-command-char", &last_command_char
,
10604 doc
: /* Last input event that was part of a command. */);
10606 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10607 doc
: /* Last input event that was part of a command. */);
10609 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10610 doc
: /* Last input event in a command, except for mouse menu events.
10611 Mouse menus give back keys that don't look like mouse events;
10612 this variable holds the actual mouse event that led to the menu,
10613 so that you can determine whether the command was run by mouse or not. */);
10615 DEFVAR_LISP ("last-input-char", &last_input_char
,
10616 doc
: /* Last input event. */);
10618 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10619 doc
: /* Last input event. */);
10621 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10622 doc
: /* List of events to be read as the command input.
10623 These events are processed first, before actual keyboard input. */);
10624 Vunread_command_events
= Qnil
;
10626 DEFVAR_INT ("unread-command-char", &unread_command_char
,
10627 doc
: /* If not -1, an object to be read as next command input event. */);
10629 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
10630 doc
: /* List of events to be processed as input by input methods.
10631 These events are processed after `unread-command-events', but
10632 before actual keyboard input. */);
10633 Vunread_post_input_method_events
= Qnil
;
10635 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
10636 doc
: /* List of events to be processed as input by input methods.
10637 These events are processed after `unread-command-events', but
10638 before actual keyboard input. */);
10639 Vunread_input_method_events
= Qnil
;
10641 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
10642 doc
: /* Meta-prefix character code.
10643 Meta-foo as command input turns into this character followed by foo. */);
10644 XSETINT (meta_prefix_char
, 033);
10646 DEFVAR_KBOARD ("last-command", Vlast_command
,
10647 doc
: /* The last command executed.
10648 Normally a symbol with a function definition, but can be whatever was found
10649 in the keymap, or whatever the variable `this-command' was set to by that
10652 The value `mode-exit' is special; it means that the previous command
10653 read an event that told it to exit, and it did so and unread that event.
10654 In other words, the present command is the event that made the previous
10657 The value `kill-region' is special; it means that the previous command
10658 was a kill command. */);
10660 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
10661 doc
: /* Same as `last-command', but never altered by Lisp code. */);
10663 DEFVAR_LISP ("this-command", &Vthis_command
,
10664 doc
: /* The command now being executed.
10665 The command can set this variable; whatever is put here
10666 will be in `last-command' during the following command. */);
10667 Vthis_command
= Qnil
;
10669 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
10670 doc
: /* If non-nil, the original command bound to the current key sequence.
10671 The value of `this-command' is the result of looking up the original
10672 command in the active keymaps. */);
10673 Vthis_original_command
= Qnil
;
10675 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
10676 doc
: /* *Number of input events between auto-saves.
10677 Zero means disable autosaving due to number of characters typed. */);
10678 auto_save_interval
= 300;
10680 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
10681 doc
: /* *Number of seconds idle time before auto-save.
10682 Zero or nil means disable auto-saving due to idleness.
10683 After auto-saving due to this many seconds of idle time,
10684 Emacs also does a garbage collection if that seems to be warranted. */);
10685 XSETFASTINT (Vauto_save_timeout
, 30);
10687 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
10688 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
10689 The value may be integer or floating point. */);
10690 Vecho_keystrokes
= make_number (1);
10692 DEFVAR_INT ("polling-period", &polling_period
,
10693 doc
: /* *Interval between polling for input during Lisp execution.
10694 The reason for polling is to make C-g work to stop a running program.
10695 Polling is needed only when using X windows and SIGIO does not work.
10696 Polling is automatically disabled in all other cases. */);
10697 polling_period
= 2;
10699 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
10700 doc
: /* *Maximum time between mouse clicks to make a double-click.
10701 Measured in milliseconds. nil means disable double-click recognition;
10702 t means double-clicks have no time limit and are detected
10703 by position only. */);
10704 Vdouble_click_time
= make_number (500);
10706 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
10707 doc
: /* *Maximum mouse movement between clicks to make a double-click.
10708 On window-system frames, value is the number of pixels the mouse may have
10709 moved horizontally or vertically between two clicks to make a double-click.
10710 On non window-system frames, value is interpreted in units of 1/8 characters
10713 This variable is also the threshold for motion of the mouse
10714 to count as a drag. */);
10715 double_click_fuzz
= 3;
10717 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
10718 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
10719 inhibit_local_menu_bar_menus
= 0;
10721 DEFVAR_INT ("num-input-keys", &num_input_keys
,
10722 doc
: /* Number of complete key sequences read as input so far.
10723 This includes key sequences read from keyboard macros.
10724 The number is effectively the number of interactive command invocations. */);
10725 num_input_keys
= 0;
10727 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
10728 doc
: /* Number of input events read from the keyboard so far.
10729 This does not include events generated by keyboard macros. */);
10730 num_nonmacro_input_events
= 0;
10732 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
10733 doc
: /* The frame in which the most recently read event occurred.
10734 If the last event came from a keyboard macro, this is set to `macro'. */);
10735 Vlast_event_frame
= Qnil
;
10737 /* This variable is set up in sysdep.c. */
10738 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
10739 doc
: /* The ERASE character as set by the user with stty. */);
10741 DEFVAR_LISP ("help-char", &Vhelp_char
,
10742 doc
: /* Character to recognize as meaning Help.
10743 When it is read, do `(eval help-form)', and display result if it's a string.
10744 If the value of `help-form' is nil, this char can be read normally. */);
10745 XSETINT (Vhelp_char
, Ctl ('H'));
10747 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
10748 doc
: /* List of input events to recognize as meaning Help.
10749 These work just like the value of `help-char' (see that). */);
10750 Vhelp_event_list
= Qnil
;
10752 DEFVAR_LISP ("help-form", &Vhelp_form
,
10753 doc
: /* Form to execute when character `help-char' is read.
10754 If the form returns a string, that string is displayed.
10755 If `help-form' is nil, the help char is not recognized. */);
10758 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
10759 doc
: /* Command to run when `help-char' character follows a prefix key.
10760 This command is used only when there is no actual binding
10761 for that character after that prefix key. */);
10762 Vprefix_help_command
= Qnil
;
10764 DEFVAR_LISP ("top-level", &Vtop_level
,
10765 doc
: /* Form to evaluate when Emacs starts up.
10766 Useful to set before you dump a modified Emacs. */);
10769 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
10770 doc
: /* Translate table for keyboard input, or nil.
10771 Each character is looked up in this string and the contents used instead.
10772 The value may be a string, a vector, or a char-table.
10773 If it is a string or vector of length N,
10774 character codes N and up are untranslated.
10775 In a vector or a char-table, an element which is nil means "no translation". */);
10776 Vkeyboard_translate_table
= Qnil
;
10778 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
10779 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
10780 \(Even if the operating system has support for stopping a process.\) */);
10781 cannot_suspend
= 0;
10783 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
10784 doc
: /* Non-nil means prompt with menus when appropriate.
10785 This is done when reading from a keymap that has a prompt string,
10786 for elements that have prompt strings.
10787 The menu is displayed on the screen
10788 if X menus were enabled at configuration
10789 time and the previous event was a mouse click prefix key.
10790 Otherwise, menu prompting uses the echo area. */);
10791 menu_prompting
= 1;
10793 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
10794 doc
: /* Character to see next line of menu prompt.
10795 Type this character while in a menu prompt to rotate around the lines of it. */);
10796 XSETINT (menu_prompt_more_char
, ' ');
10798 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
10799 doc
: /* A mask of additional modifier keys to use with every keyboard character.
10800 Emacs applies the modifiers of the character stored here to each keyboard
10801 character it reads. For example, after evaluating the expression
10802 (setq extra-keyboard-modifiers ?\\C-x)
10803 all input characters will have the control modifier applied to them.
10805 Note that the character ?\\C-@, equivalent to the integer zero, does
10806 not count as a control character; rather, it counts as a character
10807 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
10808 cancels any modification. */);
10809 extra_keyboard_modifiers
= 0;
10811 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
10812 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
10813 The command loop sets this to nil before each command,
10814 and tests the value when the command returns.
10815 Buffer modification stores t in this variable. */);
10816 Vdeactivate_mark
= Qnil
;
10818 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
10819 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
10820 Vcommand_hook_internal
= Qnil
;
10822 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
10823 doc
: /* Normal hook run before each command is executed.
10824 If an unhandled error happens in running this hook,
10825 the hook value is set to nil, since otherwise the error
10826 might happen repeatedly and make Emacs nonfunctional. */);
10827 Vpre_command_hook
= Qnil
;
10829 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
10830 doc
: /* Normal hook run after each command is executed.
10831 If an unhandled error happens in running this hook,
10832 the hook value is set to nil, since otherwise the error
10833 might happen repeatedly and make Emacs nonfunctional. */);
10834 Vpost_command_hook
= Qnil
;
10836 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
10837 doc
: /* Normal hook run after each command is executed, if idle.
10838 Errors running the hook are caught and ignored.
10839 This feature is obsolete; use idle timers instead. See `etc/NEWS'. */);
10840 Vpost_command_idle_hook
= Qnil
;
10842 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
10843 doc
: /* Delay time before running `post-command-idle-hook'.
10844 This is measured in microseconds. */);
10845 post_command_idle_delay
= 100000;
10848 DEFVAR_LISP ("echo-area-clear-hook", ...,
10849 doc
: /* Normal hook run when clearing the echo area. */);
10851 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
10852 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
10854 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
10855 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
10856 Vlucid_menu_bar_dirty_flag
= Qnil
;
10858 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
10859 doc
: /* List of menu bar items to move to the end of the menu bar.
10860 The elements of the list are event types that may have menu bar bindings. */);
10861 Vmenu_bar_final_items
= Qnil
;
10863 DEFVAR_KBOARD ("overriding-terminal-local-map",
10864 Voverriding_terminal_local_map
,
10865 doc
: /* Per-terminal keymap that overrides all other local keymaps.
10866 If this variable is non-nil, it is used as a keymap instead of the
10867 buffer's local map, and the minor mode keymaps and text property keymaps.
10868 This variable is intended to let commands such as `universal-argument'
10869 set up a different keymap for reading the next command. */);
10871 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
10872 doc
: /* Keymap that overrides all other local keymaps.
10873 If this variable is non-nil, it is used as a keymap instead of the
10874 buffer's local map, and the minor mode keymaps and text property keymaps. */);
10875 Voverriding_local_map
= Qnil
;
10877 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
10878 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
10879 Otherwise, the menu bar continues to reflect the buffer's local map
10880 and the minor mode maps regardless of `overriding-local-map'. */);
10881 Voverriding_local_map_menu_flag
= Qnil
;
10883 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
10884 doc
: /* Keymap defining bindings for special events to execute at low level. */);
10885 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
10887 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
10888 doc
: /* *Non-nil means generate motion events for mouse motion. */);
10890 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
10891 doc
: /* Alist of system-specific X windows key symbols.
10892 Each element should have the form (N . SYMBOL) where N is the
10893 numeric keysym code (sans the \"system-specific\" bit 1<<28)
10894 and SYMBOL is its name. */);
10896 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
10897 doc
: /* List of deferred actions to be performed at a later time.
10898 The precise format isn't relevant here; we just check whether it is nil. */);
10899 Vdeferred_action_list
= Qnil
;
10901 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
10902 doc
: /* Function to call to handle deferred actions, after each command.
10903 This function is called with no arguments after each command
10904 whenever `deferred-action-list' is non-nil. */);
10905 Vdeferred_action_function
= Qnil
;
10907 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
10908 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
10909 The value can be a length of time to show the message for.
10910 If the value is non-nil and not a number, we wait 2 seconds. */);
10911 Vsuggest_key_bindings
= Qt
;
10913 DEFVAR_LISP ("timer-list", &Vtimer_list
,
10914 doc
: /* List of active absolute time timers in order of increasing time. */);
10915 Vtimer_list
= Qnil
;
10917 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
10918 doc
: /* List of active idle-time timers in order of increasing time. */);
10919 Vtimer_idle_list
= Qnil
;
10921 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
10922 doc
: /* If non-nil, the function that implements the current input method.
10923 It's called with one argument, a printing character that was just read.
10924 \(That means a character with code 040...0176.)
10925 Typically this function uses `read-event' to read additional events.
10926 When it does so, it should first bind `input-method-function' to nil
10927 so it will not be called recursively.
10929 The function should return a list of zero or more events
10930 to be used as input. If it wants to put back some events
10931 to be reconsidered, separately, by the input method,
10932 it can add them to the beginning of `unread-command-events'.
10934 The input method function can find in `input-method-previous-method'
10935 the previous echo area message.
10937 The input method function should refer to the variables
10938 `input-method-use-echo-area' and `input-method-exit-on-first-char'
10939 for guidance on what to do. */);
10940 Vinput_method_function
= Qnil
;
10942 DEFVAR_LISP ("input-method-previous-message",
10943 &Vinput_method_previous_message
,
10944 doc
: /* When `input-method-function' is called, hold the previous echo area message.
10945 This variable exists because `read-event' clears the echo area
10946 before running the input method. It is nil if there was no message. */);
10947 Vinput_method_previous_message
= Qnil
;
10949 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
10950 doc
: /* If non-nil, the function that implements the display of help.
10951 It's called with one argument, the help string to display. */);
10952 Vshow_help_function
= Qnil
;
10954 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
10955 doc
: /* If non-nil, suppress point adjustment after executing a command.
10957 After a command is executed, if point is moved into a region that has
10958 special properties (e.g. composition, display), we adjust point to
10959 the boundary of the region. But, several special commands sets this
10960 variable to non-nil, then we suppress the point adjustment.
10962 This variable is set to nil before reading a command, and is checked
10963 just after executing the command. */);
10964 Vdisable_point_adjustment
= Qnil
;
10966 DEFVAR_LISP ("global-disable-point-adjustment",
10967 &Vglobal_disable_point_adjustment
,
10968 doc
: /* *If non-nil, always suppress point adjustment.
10970 The default value is nil, in which case, point adjustment are
10971 suppressed only after special commands that set
10972 `disable-point-adjustment' (which see) to non-nil. */);
10973 Vglobal_disable_point_adjustment
= Qnil
;
10975 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
10976 doc
: /* Non-nil means updating menu bindings is allowed.
10977 A value of nil means menu bindings should not be updated.
10978 Used during Emacs' startup. */);
10979 update_menu_bindings
= 1;
10981 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
10982 doc
: /* *How long to display an echo-area message when the minibuffer is active.
10983 If the value is not a number, such messages don't time out. */);
10984 Vminibuffer_message_timeout
= make_number (2);
10988 keys_of_keyboard ()
10990 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
10991 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
10992 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
10993 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
10994 initial_define_key (meta_map
, 'x', "execute-extended-command");
10996 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
10997 "handle-delete-frame");
10998 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11000 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11002 initial_define_lispy_key (Vspecial_event_map
, "select-window",
11003 "handle-select-window");
11004 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11005 "handle-save-session");