1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
3 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
29 #include "termhooks.h"
38 #include "dispextern.h"
40 #include "intervals.h"
42 #include "blockinput.h"
49 #ifdef HAVE_GTK_AND_PTHREAD
57 #include <sys/ioctl.h>
59 #endif /* not MSDOS */
61 #include "syssignal.h"
64 #include <sys/types.h>
73 /* This is to get the definitions of the XK_ symbols. */
80 #endif /* HAVE_NTGUI */
90 /* Variables for blockinput.h: */
92 /* Non-zero if interrupt input is blocked right now. */
93 volatile int interrupt_input_blocked
;
95 /* Nonzero means an input interrupt has arrived
96 during the current critical section. */
97 int interrupt_input_pending
;
100 /* File descriptor to use for input. */
103 #ifdef HAVE_WINDOW_SYSTEM
104 /* Make all keyboard buffers much bigger when using X windows. */
106 /* But not too big (local data > 32K error) if on Mac OS Classic. */
107 #define KBD_BUFFER_SIZE 512
109 #define KBD_BUFFER_SIZE 4096
111 #else /* No X-windows, character input */
112 #define KBD_BUFFER_SIZE 4096
113 #endif /* No X-windows */
115 #define abs(x) ((x) >= 0 ? (x) : -(x))
117 /* Following definition copied from eval.c */
121 struct backtrace
*next
;
122 Lisp_Object
*function
;
123 Lisp_Object
*args
; /* Points to vector of args. */
124 int nargs
; /* length of vector. If nargs is UNEVALLED,
125 args points to slot holding list of
128 /* Nonzero means call value of debugger when done with this operation. */
133 KBOARD
*initial_kboard
;
134 KBOARD
*current_kboard
;
138 KBOARD the_only_kboard
;
141 /* Non-nil disable property on a command means
142 do not execute it; call disabled-command-function's value instead. */
143 Lisp_Object Qdisabled
, Qdisabled_command_function
;
145 #define NUM_RECENT_KEYS (100)
146 int recent_keys_index
; /* Index for storing next element into recent_keys */
147 int total_keys
; /* Total number of elements stored into recent_keys */
148 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
150 /* Vector holding the key sequence that invoked the current command.
151 It is reused for each command, and it may be longer than the current
152 sequence; this_command_key_count indicates how many elements
153 actually mean something.
154 It's easier to staticpro a single Lisp_Object than an array. */
155 Lisp_Object this_command_keys
;
156 int this_command_key_count
;
158 /* 1 after calling Freset_this_command_lengths.
160 int this_command_key_count_reset
;
162 /* This vector is used as a buffer to record the events that were actually read
163 by read_key_sequence. */
164 Lisp_Object raw_keybuf
;
165 int raw_keybuf_count
;
167 #define GROW_RAW_KEYBUF \
168 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
170 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
172 new = Fmake_vector (make_number (newsize), Qnil); \
173 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
174 raw_keybuf_count * sizeof (Lisp_Object)); \
178 /* Number of elements of this_command_keys
179 that precede this key sequence. */
180 int this_single_command_key_start
;
182 /* Record values of this_command_key_count and echo_length ()
183 before this command was read. */
184 static int before_command_key_count
;
185 static int before_command_echo_length
;
187 extern int minbuf_level
;
189 extern int message_enable_multibyte
;
191 extern struct backtrace
*backtrace_list
;
193 /* If non-nil, the function that implements the display of help.
194 It's called with one argument, the help string to display. */
196 Lisp_Object Vshow_help_function
;
198 /* If a string, the message displayed before displaying a help-echo
201 Lisp_Object Vpre_help_message
;
203 /* Nonzero means do menu prompting. */
205 static int menu_prompting
;
207 /* Character to see next line of menu prompt. */
209 static Lisp_Object menu_prompt_more_char
;
211 /* For longjmp to where kbd input is being done. */
213 static jmp_buf getcjmp
;
215 /* True while doing kbd input. */
216 int waiting_for_input
;
218 /* True while displaying for echoing. Delays C-g throwing. */
222 /* Non-null means we can start echoing at the next input pause even
223 though there is something in the echo area. */
225 static struct kboard
*ok_to_echo_at_next_pause
;
227 /* The kboard last echoing, or null for none. Reset to 0 in
228 cancel_echoing. If non-null, and a current echo area message
229 exists, and echo_message_buffer is eq to the current message
230 buffer, we know that the message comes from echo_kboard. */
232 struct kboard
*echo_kboard
;
234 /* The buffer used for echoing. Set in echo_now, reset in
237 Lisp_Object echo_message_buffer
;
239 /* Nonzero means disregard local maps for the menu bar. */
240 static int inhibit_local_menu_bar_menus
;
242 /* Nonzero means C-g should cause immediate error-signal. */
245 /* The user's hook function for outputting an error message. */
246 Lisp_Object Vcommand_error_function
;
248 /* The user's ERASE setting. */
249 Lisp_Object Vtty_erase_char
;
251 /* Character to recognize as the help char. */
252 Lisp_Object Vhelp_char
;
254 /* List of other event types to recognize as meaning "help". */
255 Lisp_Object Vhelp_event_list
;
257 /* Form to execute when help char is typed. */
258 Lisp_Object Vhelp_form
;
260 /* Command to run when the help character follows a prefix key. */
261 Lisp_Object Vprefix_help_command
;
263 /* List of items that should move to the end of the menu bar. */
264 Lisp_Object Vmenu_bar_final_items
;
266 /* Non-nil means show the equivalent key-binding for
267 any M-x command that has one.
268 The value can be a length of time to show the message for.
269 If the value is non-nil and not a number, we wait 2 seconds. */
270 Lisp_Object Vsuggest_key_bindings
;
272 /* How long to display an echo-area message when the minibuffer is active.
273 If the value is not a number, such messages don't time out. */
274 Lisp_Object Vminibuffer_message_timeout
;
276 /* Character that causes a quit. Normally C-g.
278 If we are running on an ordinary terminal, this must be an ordinary
279 ASCII char, since we want to make it our interrupt character.
281 If we are not running on an ordinary terminal, it still needs to be
282 an ordinary ASCII char. This character needs to be recognized in
283 the input interrupt handler. At this point, the keystroke is
284 represented as a struct input_event, while the desired quit
285 character is specified as a lispy event. The mapping from struct
286 input_events to lispy events cannot run in an interrupt handler,
287 and the reverse mapping is difficult for anything but ASCII
290 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
294 extern Lisp_Object current_global_map
;
295 extern int minibuf_level
;
297 /* If non-nil, this is a map that overrides all other local maps. */
298 Lisp_Object Voverriding_local_map
;
300 /* If non-nil, Voverriding_local_map applies to the menu bar. */
301 Lisp_Object Voverriding_local_map_menu_flag
;
303 /* Keymap that defines special misc events that should
304 be processed immediately at a low level. */
305 Lisp_Object Vspecial_event_map
;
307 /* Current depth in recursive edits. */
308 int command_loop_level
;
310 /* Total number of times command_loop has read a key sequence. */
311 EMACS_INT num_input_keys
;
313 /* Last input character read as a command. */
314 Lisp_Object last_command_char
;
316 /* Last input character read as a command, not counting menus
317 reached by the mouse. */
318 Lisp_Object last_nonmenu_event
;
320 /* Last input character read for any purpose. */
321 Lisp_Object last_input_char
;
323 /* If not Qnil, a list of objects to be read as subsequent command input. */
324 Lisp_Object Vunread_command_events
;
326 /* If not Qnil, a list of objects to be read as subsequent command input
327 including input method processing. */
328 Lisp_Object Vunread_input_method_events
;
330 /* If not Qnil, a list of objects to be read as subsequent command input
331 but NOT including input method processing. */
332 Lisp_Object Vunread_post_input_method_events
;
334 /* If not -1, an event to be read as subsequent command input. */
335 EMACS_INT unread_command_char
;
337 /* If not Qnil, this is a switch-frame event which we decided to put
338 off until the end of a key sequence. This should be read as the
339 next command input, after any unread_command_events.
341 read_key_sequence uses this to delay switch-frame events until the
342 end of the key sequence; Fread_char uses it to put off switch-frame
343 events until a non-ASCII event is acceptable as input. */
344 Lisp_Object unread_switch_frame
;
346 /* A mask of extra modifier bits to put into every keyboard char. */
347 EMACS_INT extra_keyboard_modifiers
;
349 /* Char to use as prefix when a meta character is typed in.
350 This is bound on entry to minibuffer in case ESC is changed there. */
352 Lisp_Object meta_prefix_char
;
354 /* Last size recorded for a current buffer which is not a minibuffer. */
355 static int last_non_minibuf_size
;
357 /* Number of idle seconds before an auto-save and garbage collection. */
358 static Lisp_Object Vauto_save_timeout
;
360 /* Total number of times read_char has returned. */
361 int num_input_events
;
363 /* Total number of times read_char has returned, outside of macros. */
364 EMACS_INT num_nonmacro_input_events
;
366 /* Auto-save automatically when this many characters have been typed
367 since the last time. */
369 static EMACS_INT auto_save_interval
;
371 /* Value of num_nonmacro_input_events as of last auto save. */
375 /* The command being executed by the command loop.
376 Commands may set this, and the value set will be copied into
377 current_kboard->Vlast_command instead of the actual command. */
378 Lisp_Object Vthis_command
;
380 /* This is like Vthis_command, except that commands never set it. */
381 Lisp_Object real_this_command
;
383 /* If the lookup of the command returns a binding, the original
384 command is stored in this-original-command. It is nil otherwise. */
385 Lisp_Object Vthis_original_command
;
387 /* The value of point when the last command was started. */
388 int last_point_position
;
390 /* The buffer that was current when the last command was started. */
391 Lisp_Object last_point_position_buffer
;
393 /* The window that was selected when the last command was started. */
394 Lisp_Object last_point_position_window
;
396 /* The frame in which the last input event occurred, or Qmacro if the
397 last event came from a macro. We use this to determine when to
398 generate switch-frame events. This may be cleared by functions
399 like Fselect_frame, to make sure that a switch-frame event is
400 generated by the next character. */
401 Lisp_Object internal_last_event_frame
;
403 /* A user-visible version of the above, intended to allow users to
404 figure out where the last event came from, if the event doesn't
405 carry that information itself (i.e. if it was a character). */
406 Lisp_Object Vlast_event_frame
;
408 /* The timestamp of the last input event we received from the X server.
409 X Windows wants this for selection ownership. */
410 unsigned long last_event_timestamp
;
412 Lisp_Object Qself_insert_command
;
413 Lisp_Object Qforward_char
;
414 Lisp_Object Qbackward_char
;
415 Lisp_Object Qundefined
;
416 Lisp_Object Qtimer_event_handler
;
418 /* read_key_sequence stores here the command definition of the
419 key sequence that it reads. */
420 Lisp_Object read_key_sequence_cmd
;
422 /* Echo unfinished commands after this many seconds of pause. */
423 Lisp_Object Vecho_keystrokes
;
425 /* Form to evaluate (if non-nil) when Emacs is started. */
426 Lisp_Object Vtop_level
;
428 /* User-supplied table to translate input characters. */
429 Lisp_Object Vkeyboard_translate_table
;
431 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
432 extern Lisp_Object Vfunction_key_map
;
434 /* Another keymap that maps key sequences into key sequences.
435 This one takes precedence over ordinary definitions. */
436 extern Lisp_Object Vkey_translation_map
;
438 /* If non-nil, this implements the current input method. */
439 Lisp_Object Vinput_method_function
;
440 Lisp_Object Qinput_method_function
;
442 /* When we call Vinput_method_function,
443 this holds the echo area message that was just erased. */
444 Lisp_Object Vinput_method_previous_message
;
446 /* Non-nil means deactivate the mark at end of this command. */
447 Lisp_Object Vdeactivate_mark
;
449 /* Menu bar specified in Lucid Emacs fashion. */
451 Lisp_Object Vlucid_menu_bar_dirty_flag
;
452 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
454 Lisp_Object Qecho_area_clear_hook
;
456 /* Hooks to run before and after each command. */
457 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
458 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
459 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
461 /* List of deferred actions to be performed at a later time.
462 The precise format isn't relevant here; we just check whether it is nil. */
463 Lisp_Object Vdeferred_action_list
;
465 /* Function to call to handle deferred actions, when there are any. */
466 Lisp_Object Vdeferred_action_function
;
467 Lisp_Object Qdeferred_action_function
;
469 Lisp_Object Qinput_method_exit_on_first_char
;
470 Lisp_Object Qinput_method_use_echo_area
;
472 /* File in which we write all commands we read. */
475 /* Nonzero if input is available. */
478 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
479 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
483 extern char *pending_malloc_warning
;
485 /* Circular buffer for pre-read keyboard input. */
487 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
489 /* Pointer to next available character in kbd_buffer.
490 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
491 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
492 next available char is in kbd_buffer[0]. */
493 static struct input_event
*kbd_fetch_ptr
;
495 /* Pointer to next place to store character in kbd_buffer. This
496 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
497 character should go in kbd_buffer[0]. */
498 static struct input_event
* volatile kbd_store_ptr
;
500 /* The above pair of variables forms a "queue empty" flag. When we
501 enqueue a non-hook event, we increment kbd_store_ptr. When we
502 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
503 there is input available iff the two pointers are not equal.
505 Why not just have a flag set and cleared by the enqueuing and
506 dequeuing functions? Such a flag could be screwed up by interrupts
507 at inopportune times. */
509 /* If this flag is non-nil, we check mouse_moved to see when the
510 mouse moves, and motion events will appear in the input stream.
511 Otherwise, mouse motion is ignored. */
512 Lisp_Object do_mouse_tracking
;
514 /* Symbols to head events. */
515 Lisp_Object Qmouse_movement
;
516 Lisp_Object Qscroll_bar_movement
;
517 Lisp_Object Qswitch_frame
;
518 Lisp_Object Qdelete_frame
;
519 Lisp_Object Qiconify_frame
;
520 Lisp_Object Qmake_frame_visible
;
521 Lisp_Object Qselect_window
;
522 Lisp_Object Qhelp_echo
;
525 Lisp_Object Qmouse_fixup_help_message
;
528 /* Symbols to denote kinds of events. */
529 Lisp_Object Qfunction_key
;
530 Lisp_Object Qmouse_click
;
531 #if defined (WINDOWSNT) || defined (MAC_OS)
532 Lisp_Object Qlanguage_change
;
534 Lisp_Object Qdrag_n_drop
;
535 Lisp_Object Qsave_session
;
537 Lisp_Object Qmac_apple_event
;
540 /* Lisp_Object Qmouse_movement; - also an event header */
542 /* Properties of event headers. */
543 Lisp_Object Qevent_kind
;
544 Lisp_Object Qevent_symbol_elements
;
546 /* menu item parts */
547 Lisp_Object Qmenu_alias
;
548 Lisp_Object Qmenu_enable
;
549 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
550 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
551 extern Lisp_Object Vdefine_key_rebound_commands
;
552 extern Lisp_Object Qmenu_item
;
554 /* An event header symbol HEAD may have a property named
555 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
556 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
557 mask of modifiers applied to it. If present, this is used to help
558 speed up parse_modifiers. */
559 Lisp_Object Qevent_symbol_element_mask
;
561 /* An unmodified event header BASE may have a property named
562 Qmodifier_cache, which is an alist mapping modifier masks onto
563 modified versions of BASE. If present, this helps speed up
565 Lisp_Object Qmodifier_cache
;
567 /* Symbols to use for parts of windows. */
568 Lisp_Object Qmode_line
;
569 Lisp_Object Qvertical_line
;
570 Lisp_Object Qvertical_scroll_bar
;
571 Lisp_Object Qmenu_bar
;
572 extern Lisp_Object Qleft_margin
, Qright_margin
;
573 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
574 extern Lisp_Object QCmap
;
576 Lisp_Object
recursive_edit_unwind (), command_loop ();
577 Lisp_Object
Fthis_command_keys ();
578 Lisp_Object Qextended_command_history
;
579 EMACS_TIME
timer_check ();
581 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
583 extern char *x_get_keysym_name ();
585 static void record_menu_key ();
586 static int echo_length ();
588 Lisp_Object Qpolling_period
;
590 /* List of absolute timers. Appears in order of next scheduled event. */
591 Lisp_Object Vtimer_list
;
593 /* List of idle time timers. Appears in order of next scheduled event. */
594 Lisp_Object Vtimer_idle_list
;
596 /* Incremented whenever a timer is run. */
599 extern Lisp_Object Vprint_level
, Vprint_length
;
601 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
603 EMACS_TIME
*input_available_clear_time
;
605 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
606 Default is 1 if INTERRUPT_INPUT is defined. */
609 /* Nonzero while interrupts are temporarily deferred during redisplay. */
610 int interrupts_deferred
;
612 /* Nonzero means use ^S/^Q for flow control. */
615 /* Allow m- file to inhibit use of FIONREAD. */
616 #ifdef BROKEN_FIONREAD
620 /* We are unable to use interrupts if FIONREAD is not available,
621 so flush SIGIO so we won't try. */
622 #if !defined (FIONREAD)
628 /* If we support a window system, turn on the code to poll periodically
629 to detect C-g. It isn't actually used when doing interrupt input. */
630 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
631 #define POLL_FOR_INPUT
634 /* After a command is executed, if point is moved into a region that
635 has specific properties (e.g. composition, display), we adjust
636 point to the boundary of the region. But, if a command sets this
637 variable to non-nil, we suppress this point adjustment. This
638 variable is set to nil before reading a command. */
640 Lisp_Object Vdisable_point_adjustment
;
642 /* If non-nil, always disable point adjustment. */
644 Lisp_Object Vglobal_disable_point_adjustment
;
646 /* The time when Emacs started being idle. */
648 static EMACS_TIME timer_idleness_start_time
;
650 /* After Emacs stops being idle, this saves the last value
651 of timer_idleness_start_time from when it was idle. */
653 static EMACS_TIME timer_last_idleness_start_time
;
655 /* If non-nil, events produced by disabled menu items and tool-bar
656 buttons are not ignored. Help functions bind this to allow help on
657 those items and buttons. */
658 Lisp_Object Venable_disabled_menus_and_buttons
;
661 /* Global variable declarations. */
663 /* Flags for readable_events. */
664 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
665 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
666 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
668 /* Function for init_keyboard to call with no args (if nonzero). */
669 void (*keyboard_init_hook
) ();
671 static int read_avail_input
P_ ((int));
672 static void get_input_pending
P_ ((int *, int));
673 static int readable_events
P_ ((int));
674 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
675 Lisp_Object
, int *));
676 static Lisp_Object
read_char_x_menu_prompt ();
677 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
679 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
681 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
682 enum scroll_bar_part
,
683 Lisp_Object
, Lisp_Object
,
686 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
687 Lisp_Object
, char **,
688 Lisp_Object
*, unsigned));
689 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
690 static int parse_solitary_modifier
P_ ((Lisp_Object
));
691 static int parse_solitary_modifier ();
692 static void save_getcjmp
P_ ((jmp_buf));
693 static void save_getcjmp ();
694 static void restore_getcjmp
P_ ((jmp_buf));
695 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
696 static void clear_event
P_ ((struct input_event
*));
697 static void any_kboard_state
P_ ((void));
698 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
699 static void timer_start_idle
P_ ((void));
700 static void timer_stop_idle
P_ ((void));
701 static void timer_resume_idle
P_ ((void));
702 static SIGTYPE handle_user_signal
P_ ((int));
703 static char *find_user_signal_name
P_ ((int));
704 static int store_user_signal_events
P_ ((void));
706 /* Nonzero means don't try to suspend even if the operating system seems
708 static int cannot_suspend
;
710 extern Lisp_Object Qidentity
, Qonly
;
712 /* Install the string STR as the beginning of the string of echoing,
713 so that it serves as a prompt for the next character.
714 Also start echoing. */
720 current_kboard
->echo_string
= str
;
721 current_kboard
->echo_after_prompt
= SCHARS (str
);
725 /* Add C to the echo string, if echoing is going on.
726 C can be a character, which is printed prettily ("M-C-x" and all that
727 jazz), or a symbol, whose name is printed. */
733 if (current_kboard
->immediate_echo
)
735 int size
= KEY_DESCRIPTION_SIZE
+ 100;
736 char *buffer
= (char *) alloca (size
);
738 Lisp_Object echo_string
;
740 echo_string
= current_kboard
->echo_string
;
742 /* If someone has passed us a composite event, use its head symbol. */
747 ptr
= push_key_description (XINT (c
), ptr
, 1);
749 else if (SYMBOLP (c
))
751 Lisp_Object name
= SYMBOL_NAME (c
);
752 int nbytes
= SBYTES (name
);
754 if (size
- (ptr
- buffer
) < nbytes
)
756 int offset
= ptr
- buffer
;
757 size
= max (2 * size
, size
+ nbytes
);
758 buffer
= (char *) alloca (size
);
759 ptr
= buffer
+ offset
;
762 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
763 STRING_MULTIBYTE (name
), 1);
766 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
769 const char *text
= " (Type ? for further options)";
770 int len
= strlen (text
);
772 if (size
- (ptr
- buffer
) < len
)
774 int offset
= ptr
- buffer
;
776 buffer
= (char *) alloca (size
);
777 ptr
= buffer
+ offset
;
780 bcopy (text
, ptr
, len
);
784 /* Replace a dash from echo_dash with a space, otherwise
785 add a space at the end as a separator between keys. */
786 if (STRINGP (echo_string
)
787 && SCHARS (echo_string
) > 1)
789 Lisp_Object last_char
, prev_char
, idx
;
791 idx
= make_number (SCHARS (echo_string
) - 2);
792 prev_char
= Faref (echo_string
, idx
);
794 idx
= make_number (SCHARS (echo_string
) - 1);
795 last_char
= Faref (echo_string
, idx
);
797 /* We test PREV_CHAR to make sure this isn't the echoing
799 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
800 Faset (echo_string
, idx
, make_number (' '));
802 echo_string
= concat2 (echo_string
, build_string (" "));
804 else if (STRINGP (echo_string
))
805 echo_string
= concat2 (echo_string
, build_string (" "));
807 current_kboard
->echo_string
808 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
814 /* Temporarily add a dash to the end of the echo string if it's not
815 empty, so that it serves as a mini-prompt for the very next character. */
820 /* Do nothing if not echoing at all. */
821 if (NILP (current_kboard
->echo_string
))
824 if (!current_kboard
->immediate_echo
825 && SCHARS (current_kboard
->echo_string
) == 0)
828 /* Do nothing if we just printed a prompt. */
829 if (current_kboard
->echo_after_prompt
830 == SCHARS (current_kboard
->echo_string
))
833 /* Do nothing if we have already put a dash at the end. */
834 if (SCHARS (current_kboard
->echo_string
) > 1)
836 Lisp_Object last_char
, prev_char
, idx
;
838 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
839 prev_char
= Faref (current_kboard
->echo_string
, idx
);
841 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
842 last_char
= Faref (current_kboard
->echo_string
, idx
);
844 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
848 /* Put a dash at the end of the buffer temporarily,
849 but make it go away when the next character is added. */
850 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
855 /* Display the current echo string, and begin echoing if not already
861 if (!current_kboard
->immediate_echo
)
864 current_kboard
->immediate_echo
= 1;
866 for (i
= 0; i
< this_command_key_count
; i
++)
870 /* Set before_command_echo_length to the value that would
871 have been saved before the start of this subcommand in
872 command_loop_1, if we had already been echoing then. */
873 if (i
== this_single_command_key_start
)
874 before_command_echo_length
= echo_length ();
876 c
= XVECTOR (this_command_keys
)->contents
[i
];
877 if (! (EVENT_HAS_PARAMETERS (c
)
878 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
882 /* Set before_command_echo_length to the value that would
883 have been saved before the start of this subcommand in
884 command_loop_1, if we had already been echoing then. */
885 if (this_command_key_count
== this_single_command_key_start
)
886 before_command_echo_length
= echo_length ();
888 /* Put a dash at the end to invite the user to type more. */
893 message3_nolog (current_kboard
->echo_string
,
894 SBYTES (current_kboard
->echo_string
),
895 STRING_MULTIBYTE (current_kboard
->echo_string
));
898 /* Record in what buffer we echoed, and from which kboard. */
899 echo_message_buffer
= echo_area_buffer
[0];
900 echo_kboard
= current_kboard
;
902 if (waiting_for_input
&& !NILP (Vquit_flag
))
903 quit_throw_to_read_char ();
906 /* Turn off echoing, for the start of a new command. */
911 current_kboard
->immediate_echo
= 0;
912 current_kboard
->echo_after_prompt
= -1;
913 current_kboard
->echo_string
= Qnil
;
914 ok_to_echo_at_next_pause
= NULL
;
916 echo_message_buffer
= Qnil
;
919 /* Return the length of the current echo string. */
924 return (STRINGP (current_kboard
->echo_string
)
925 ? SCHARS (current_kboard
->echo_string
)
929 /* Truncate the current echo message to its first LEN chars.
930 This and echo_char get used by read_key_sequence when the user
931 switches frames while entering a key sequence. */
934 echo_truncate (nchars
)
937 if (STRINGP (current_kboard
->echo_string
))
938 current_kboard
->echo_string
939 = Fsubstring (current_kboard
->echo_string
,
940 make_number (0), make_number (nchars
));
941 truncate_echo_area (nchars
);
945 /* Functions for manipulating this_command_keys. */
947 add_command_key (key
)
950 #if 0 /* Not needed after we made Freset_this_command_lengths
951 do the job immediately. */
952 /* If reset-this-command-length was called recently, obey it now.
953 See the doc string of that function for an explanation of why. */
954 if (before_command_restore_flag
)
956 this_command_key_count
= before_command_key_count_1
;
957 if (this_command_key_count
< this_single_command_key_start
)
958 this_single_command_key_start
= this_command_key_count
;
959 echo_truncate (before_command_echo_length_1
);
960 before_command_restore_flag
= 0;
964 if (this_command_key_count
>= ASIZE (this_command_keys
))
965 this_command_keys
= larger_vector (this_command_keys
,
966 2 * ASIZE (this_command_keys
),
969 AREF (this_command_keys
, this_command_key_count
) = key
;
970 ++this_command_key_count
;
977 int count
= SPECPDL_INDEX ();
980 if (command_loop_level
> 0)
982 specbind (Qstandard_output
, Qt
);
983 specbind (Qstandard_input
, Qt
);
986 #ifdef HAVE_X_WINDOWS
987 /* The command loop has started an hourglass timer, so we have to
988 cancel it here, otherwise it will fire because the recursive edit
989 can take some time. Do not check for display_hourglass_p here,
990 because it could already be nil. */
994 /* This function may have been called from a debugger called from
995 within redisplay, for instance by Edebugging a function called
996 from fontification-functions. We want to allow redisplay in
997 the debugging session.
999 The recursive edit is left with a `(throw exit ...)'. The `exit'
1000 tag is not caught anywhere in redisplay, i.e. when we leave the
1001 recursive edit, the original redisplay leading to the recursive
1002 edit will be unwound. The outcome should therefore be safe. */
1003 specbind (Qinhibit_redisplay
, Qnil
);
1006 val
= command_loop ();
1008 Fsignal (Qquit
, Qnil
);
1009 /* Handle throw from read_minibuf when using minibuffer
1010 while it's active but we're in another window. */
1012 xsignal1 (Qerror
, val
);
1014 return unbind_to (count
, Qnil
);
1017 /* When an auto-save happens, record the "time", and don't do again soon. */
1022 last_auto_save
= num_nonmacro_input_events
;
1025 /* Make an auto save happen as soon as possible at command level. */
1028 force_auto_save_soon ()
1030 last_auto_save
= - auto_save_interval
- 1;
1032 record_asynch_buffer_change ();
1035 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1036 doc
: /* Invoke the editor command loop recursively.
1037 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1038 that tells this function to return.
1039 Alternatively, `(throw 'exit t)' makes this function signal an error.
1040 This function is called by the editor initialization to begin editing. */)
1043 int count
= SPECPDL_INDEX ();
1046 /* If we enter while input is blocked, don't lock up here.
1047 This may happen through the debugger during redisplay. */
1048 if (INPUT_BLOCKED_P
)
1051 command_loop_level
++;
1052 update_mode_lines
= 1;
1054 if (command_loop_level
1055 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1056 buffer
= Fcurrent_buffer ();
1060 /* If we leave recursive_edit_1 below with a `throw' for instance,
1061 like it is done in the splash screen display, we have to
1062 make sure that we restore single_kboard as command_loop_1
1063 would have done if it were left normally. */
1064 record_unwind_protect (recursive_edit_unwind
,
1065 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1067 recursive_edit_1 ();
1068 return unbind_to (count
, Qnil
);
1072 recursive_edit_unwind (info
)
1075 if (BUFFERP (XCAR (info
)))
1076 Fset_buffer (XCAR (info
));
1078 if (NILP (XCDR (info
)))
1079 any_kboard_state ();
1081 single_kboard_state ();
1083 command_loop_level
--;
1084 update_mode_lines
= 1;
1093 #if 0 /* Theory: if there's anything in Vunread_command_events,
1094 it will right away be read by read_key_sequence,
1095 and then if we do switch KBOARDS, it will go into the side
1096 queue then. So we don't need to do anything special here -- rms. */
1097 if (CONSP (Vunread_command_events
))
1099 current_kboard
->kbd_queue
1100 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1101 current_kboard
->kbd_queue_has_data
= 1;
1103 Vunread_command_events
= Qnil
;
1109 /* Switch to the single-kboard state, making current_kboard
1110 the only KBOARD from which further input is accepted. */
1113 single_kboard_state ()
1120 /* If we're in single_kboard state for kboard KBOARD,
1124 not_single_kboard_state (kboard
)
1128 if (kboard
== current_kboard
)
1133 /* Maintain a stack of kboards, so other parts of Emacs
1134 can switch temporarily to the kboard of a given frame
1135 and then revert to the previous status. */
1140 struct kboard_stack
*next
;
1143 static struct kboard_stack
*kboard_stack
;
1146 push_frame_kboard (f
)
1150 struct kboard_stack
*p
1151 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1153 p
->next
= kboard_stack
;
1154 p
->kboard
= current_kboard
;
1157 current_kboard
= FRAME_KBOARD (f
);
1165 struct kboard_stack
*p
= kboard_stack
;
1166 current_kboard
= p
->kboard
;
1167 kboard_stack
= p
->next
;
1172 /* Handle errors that are not handled at inner levels
1173 by printing an error message and returning to the editor command loop. */
1179 Lisp_Object old_level
, old_length
;
1180 char macroerror
[50];
1182 #ifdef HAVE_X_WINDOWS
1183 if (display_hourglass_p
)
1184 cancel_hourglass ();
1187 if (!NILP (executing_kbd_macro
))
1189 if (executing_kbd_macro_iterations
== 1)
1190 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1192 sprintf (macroerror
, "After %d kbd macro iterations: ",
1193 executing_kbd_macro_iterations
);
1198 Vstandard_output
= Qt
;
1199 Vstandard_input
= Qt
;
1200 Vexecuting_kbd_macro
= Qnil
;
1201 executing_kbd_macro
= Qnil
;
1202 current_kboard
->Vprefix_arg
= Qnil
;
1203 current_kboard
->Vlast_prefix_arg
= Qnil
;
1206 /* Avoid unquittable loop if data contains a circular list. */
1207 old_level
= Vprint_level
;
1208 old_length
= Vprint_length
;
1209 XSETFASTINT (Vprint_level
, 10);
1210 XSETFASTINT (Vprint_length
, 10);
1211 cmd_error_internal (data
, macroerror
);
1212 Vprint_level
= old_level
;
1213 Vprint_length
= old_length
;
1217 Vinhibit_quit
= Qnil
;
1219 if (command_loop_level
== 0 && minibuf_level
== 0)
1220 any_kboard_state ();
1223 return make_number (0);
1226 /* Take actions on handling an error. DATA is the data that describes
1229 CONTEXT is a C-string containing ASCII characters only which
1230 describes the context in which the error happened. If we need to
1231 generalize CONTEXT to allow multibyte characters, make it a Lisp
1235 cmd_error_internal (data
, context
)
1239 struct frame
*sf
= SELECTED_FRAME ();
1241 /* The immediate context is not interesting for Quits,
1242 since they are asyncronous. */
1243 if (EQ (XCAR (data
), Qquit
))
1244 Vsignaling_function
= Qnil
;
1249 /* Use user's specified output function if any. */
1250 if (!NILP (Vcommand_error_function
))
1251 call3 (Vcommand_error_function
, data
,
1252 build_string (context
? context
: ""),
1253 Vsignaling_function
);
1254 /* If the window system or terminal frame hasn't been initialized
1255 yet, or we're not interactive, write the message to stderr and exit. */
1256 else if (!sf
->glyphs_initialized_p
1257 /* This is the case of the frame dumped with Emacs, when we're
1258 running under a window system. */
1259 || (!NILP (Vwindow_system
)
1260 && !inhibit_window_system
1261 && FRAME_TERMCAP_P (sf
))
1264 print_error_message (data
, Qexternal_debugging_output
,
1265 context
, Vsignaling_function
);
1266 Fterpri (Qexternal_debugging_output
);
1267 Fkill_emacs (make_number (-1));
1271 clear_message (1, 0);
1273 message_log_maybe_newline ();
1276 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1279 Vsignaling_function
= Qnil
;
1282 Lisp_Object
command_loop_1 ();
1283 Lisp_Object
command_loop_2 ();
1284 Lisp_Object
top_level_1 ();
1286 /* Entry to editor-command-loop.
1287 This level has the catches for exiting/returning to editor command loop.
1288 It returns nil to exit recursive edit, t to abort it. */
1293 if (command_loop_level
> 0 || minibuf_level
> 0)
1296 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1297 executing_kbd_macro
= Qnil
;
1303 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1304 /* Reset single_kboard in case top-level set it while
1305 evaluating an -f option, or we are stuck there for some
1307 any_kboard_state ();
1308 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1309 executing_kbd_macro
= Qnil
;
1311 /* End of file in -batch run causes exit here. */
1317 /* Here we catch errors in execution of commands within the
1318 editing loop, and reenter the editing loop.
1319 When there is an error, cmd_error runs and returns a non-nil
1320 value to us. A value of nil means that command_loop_1 itself
1321 returned due to end of file (or end of kbd macro). */
1326 register Lisp_Object val
;
1329 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1330 while (!NILP (val
));
1338 return Feval (Vtop_level
);
1344 /* On entry to the outer level, run the startup file */
1345 if (!NILP (Vtop_level
))
1346 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1347 else if (!NILP (Vpurify_flag
))
1348 message ("Bare impure Emacs (standard Lisp code not loaded)");
1350 message ("Bare Emacs (standard Lisp code not loaded)");
1354 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1355 doc
: /* Exit all recursive editing levels. */)
1358 #ifdef HAVE_X_WINDOWS
1359 if (display_hourglass_p
)
1360 cancel_hourglass ();
1363 /* Unblock input if we enter with input blocked. This may happen if
1364 redisplay traps e.g. during tool-bar update with input blocked. */
1365 while (INPUT_BLOCKED_P
)
1368 return Fthrow (Qtop_level
, Qnil
);
1371 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1372 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1375 if (command_loop_level
> 0 || minibuf_level
> 0)
1376 Fthrow (Qexit
, Qnil
);
1378 error ("No recursive edit is in progress");
1382 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1383 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1386 if (command_loop_level
> 0 || minibuf_level
> 0)
1389 error ("No recursive edit is in progress");
1395 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1396 of this function. */
1399 tracking_off (old_value
)
1400 Lisp_Object old_value
;
1402 do_mouse_tracking
= old_value
;
1403 if (NILP (old_value
))
1405 /* Redisplay may have been preempted because there was input
1406 available, and it assumes it will be called again after the
1407 input has been processed. If the only input available was
1408 the sort that we have just disabled, then we need to call
1410 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1412 redisplay_preserve_echo_area (6);
1413 get_input_pending (&input_pending
,
1414 READABLE_EVENTS_DO_TIMERS_NOW
);
1420 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1421 doc
: /* Evaluate BODY with mouse movement events enabled.
1422 Within a `track-mouse' form, mouse motion generates input events that
1423 you can read with `read-event'.
1424 Normally, mouse motion is ignored.
1425 usage: (track-mouse BODY ...) */)
1429 int count
= SPECPDL_INDEX ();
1432 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1434 do_mouse_tracking
= Qt
;
1436 val
= Fprogn (args
);
1437 return unbind_to (count
, val
);
1440 /* If mouse has moved on some frame, return one of those frames.
1444 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1445 after resizing the tool-bar window. */
1447 int ignore_mouse_drag_p
;
1452 Lisp_Object tail
, frame
;
1454 if (ignore_mouse_drag_p
)
1456 /* ignore_mouse_drag_p = 0; */
1460 FOR_EACH_FRAME (tail
, frame
)
1462 if (XFRAME (frame
)->mouse_moved
)
1463 return XFRAME (frame
);
1469 #endif /* HAVE_MOUSE */
1471 /* This is the actual command reading loop,
1472 sans error-handling encapsulation. */
1474 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1476 void safe_run_hooks
P_ ((Lisp_Object
));
1477 static void adjust_point_for_property
P_ ((int, int));
1479 /* Cancel hourglass from protect_unwind.
1481 #ifdef HAVE_X_WINDOWS
1483 cancel_hourglass_unwind (arg
)
1486 cancel_hourglass ();
1497 Lisp_Object keybuf
[30];
1500 int prev_modiff
= 0;
1501 struct buffer
*prev_buffer
= NULL
;
1503 int was_locked
= single_kboard
;
1505 int already_adjusted
;
1507 current_kboard
->Vprefix_arg
= Qnil
;
1508 current_kboard
->Vlast_prefix_arg
= Qnil
;
1509 Vdeactivate_mark
= Qnil
;
1510 waiting_for_input
= 0;
1514 this_command_key_count
= 0;
1515 this_command_key_count_reset
= 0;
1516 this_single_command_key_start
= 0;
1518 if (NILP (Vmemory_full
))
1520 /* Make sure this hook runs after commands that get errors and
1521 throw to top level. */
1522 /* Note that the value cell will never directly contain nil
1523 if the symbol is a local variable. */
1524 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1525 safe_run_hooks (Qpost_command_hook
);
1527 /* If displaying a message, resize the echo area window to fit
1528 that message's size exactly. */
1529 if (!NILP (echo_area_buffer
[0]))
1530 resize_echo_area_exactly ();
1532 if (!NILP (Vdeferred_action_list
))
1533 safe_run_hooks (Qdeferred_action_function
);
1536 /* Do this after running Vpost_command_hook, for consistency. */
1537 current_kboard
->Vlast_command
= Vthis_command
;
1538 current_kboard
->Vreal_last_command
= real_this_command
;
1542 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1545 /* Make sure the current window's buffer is selected. */
1546 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1547 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1549 /* Display any malloc warning that just came out. Use while because
1550 displaying one warning can cause another. */
1552 while (pending_malloc_warning
)
1553 display_malloc_warning ();
1557 Vdeactivate_mark
= Qnil
;
1559 /* If minibuffer on and echo area in use,
1560 wait a short time and redraw minibuffer. */
1563 && !NILP (echo_area_buffer
[0])
1564 && EQ (minibuf_window
, echo_area_window
))
1566 /* Bind inhibit-quit to t so that C-g gets read in
1567 rather than quitting back to the minibuffer. */
1568 int count
= SPECPDL_INDEX ();
1569 specbind (Qinhibit_quit
, Qt
);
1571 if (NUMBERP (Vminibuffer_message_timeout
))
1572 sit_for (Vminibuffer_message_timeout
, 0, 2);
1576 /* Clear the echo area. */
1578 safe_run_hooks (Qecho_area_clear_hook
);
1580 unbind_to (count
, Qnil
);
1582 /* If a C-g came in before, treat it as input now. */
1583 if (!NILP (Vquit_flag
))
1586 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1591 alloca (0); /* Cause a garbage collection now */
1592 /* Since we can free the most stuff here. */
1593 #endif /* C_ALLOCA */
1596 /* Select the frame that the last event came from. Usually,
1597 switch-frame events will take care of this, but if some lisp
1598 code swallows a switch-frame event, we'll fix things up here.
1599 Is this a good idea? */
1600 if (FRAMEP (internal_last_event_frame
)
1601 && !EQ (internal_last_event_frame
, selected_frame
))
1602 Fselect_frame (internal_last_event_frame
);
1604 /* If it has changed current-menubar from previous value,
1605 really recompute the menubar from the value. */
1606 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1607 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1608 call0 (Qrecompute_lucid_menubar
);
1610 before_command_key_count
= this_command_key_count
;
1611 before_command_echo_length
= echo_length ();
1613 Vthis_command
= Qnil
;
1614 real_this_command
= Qnil
;
1615 Vthis_original_command
= Qnil
;
1617 /* Read next key sequence; i gets its length. */
1618 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1621 /* A filter may have run while we were reading the input. */
1622 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1624 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1625 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1629 /* Now we have read a key sequence of length I,
1630 or else I is 0 and we found end of file. */
1632 if (i
== 0) /* End of file -- happens only in */
1633 return Qnil
; /* a kbd macro, at the end. */
1634 /* -1 means read_key_sequence got a menu that was rejected.
1635 Just loop around and read another command. */
1639 this_command_key_count
= 0;
1640 this_command_key_count_reset
= 0;
1641 this_single_command_key_start
= 0;
1645 last_command_char
= keybuf
[i
- 1];
1647 /* If the previous command tried to force a specific window-start,
1648 forget about that, in case this command moves point far away
1649 from that position. But also throw away beg_unchanged and
1650 end_unchanged information in that case, so that redisplay will
1651 update the whole window properly. */
1652 if (!NILP (XWINDOW (selected_window
)->force_start
))
1655 XWINDOW (selected_window
)->force_start
= Qnil
;
1656 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1657 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1660 cmd
= read_key_sequence_cmd
;
1661 if (!NILP (Vexecuting_kbd_macro
))
1663 if (!NILP (Vquit_flag
))
1665 Vexecuting_kbd_macro
= Qt
;
1666 QUIT
; /* Make some noise. */
1667 /* Will return since macro now empty. */
1671 /* Do redisplay processing after this command except in special
1672 cases identified below. */
1673 prev_buffer
= current_buffer
;
1674 prev_modiff
= MODIFF
;
1675 last_point_position
= PT
;
1676 last_point_position_window
= selected_window
;
1677 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1679 /* By default, we adjust point to a boundary of a region that
1680 has such a property that should be treated intangible
1681 (e.g. composition, display). But, some commands will set
1682 this variable differently. */
1683 Vdisable_point_adjustment
= Qnil
;
1685 /* Process filters and timers may have messed with deactivate-mark.
1686 reset it before we execute the command. */
1687 Vdeactivate_mark
= Qnil
;
1689 /* Remap command through active keymaps */
1690 Vthis_original_command
= cmd
;
1694 if (cmd1
= Fcommand_remapping (cmd
, Qnil
), !NILP (cmd1
))
1698 /* Execute the command. */
1700 Vthis_command
= cmd
;
1701 real_this_command
= cmd
;
1702 /* Note that the value cell will never directly contain nil
1703 if the symbol is a local variable. */
1704 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1705 safe_run_hooks (Qpre_command_hook
);
1707 already_adjusted
= 0;
1709 if (NILP (Vthis_command
))
1711 /* nil means key is undefined. */
1712 Lisp_Object keys
= Fvector (i
, keybuf
);
1713 keys
= Fkey_description (keys
, Qnil
);
1715 message_with_string ("%s is undefined", keys
, 0);
1716 current_kboard
->defining_kbd_macro
= Qnil
;
1717 update_mode_lines
= 1;
1718 current_kboard
->Vprefix_arg
= Qnil
;
1722 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1724 /* In case we jump to directly_done. */
1725 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1727 /* Recognize some common commands in common situations and
1728 do them directly. */
1729 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1731 struct Lisp_Char_Table
*dp
1732 = window_display_table (XWINDOW (selected_window
));
1733 lose
= FETCH_CHAR (PT_BYTE
);
1735 if (! NILP (Vpost_command_hook
))
1736 /* Put this before calling adjust_point_for_property
1737 so it will only get called once in any case. */
1739 if (current_buffer
== prev_buffer
1740 && last_point_position
!= PT
1741 && NILP (Vdisable_point_adjustment
)
1742 && NILP (Vglobal_disable_point_adjustment
))
1743 adjust_point_for_property (last_point_position
, 0);
1744 already_adjusted
= 1;
1745 if (PT
== last_point_position
+ 1
1747 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1748 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1749 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1750 && (lose
>= 0x20 && lose
< 0x7f)))
1751 : (lose
>= 0x20 && lose
< 0x7f))
1752 /* To extract the case of continuation on
1753 wide-column characters. */
1754 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1755 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1757 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1759 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1761 && !windows_or_buffers_changed
1762 && EQ (current_buffer
->selective_display
, Qnil
)
1763 && !detect_input_pending ()
1764 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1765 && NILP (Vexecuting_kbd_macro
))
1766 direct_output_forward_char (1);
1769 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1771 struct Lisp_Char_Table
*dp
1772 = window_display_table (XWINDOW (selected_window
));
1774 lose
= FETCH_CHAR (PT_BYTE
);
1775 if (! NILP (Vpost_command_hook
))
1777 if (current_buffer
== prev_buffer
1778 && last_point_position
!= PT
1779 && NILP (Vdisable_point_adjustment
)
1780 && NILP (Vglobal_disable_point_adjustment
))
1781 adjust_point_for_property (last_point_position
, 0);
1782 already_adjusted
= 1;
1783 if (PT
== last_point_position
- 1
1785 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1786 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1787 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1788 && (lose
>= 0x20 && lose
< 0x7f)))
1789 : (lose
>= 0x20 && lose
< 0x7f))
1790 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1792 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1794 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1796 && !windows_or_buffers_changed
1797 && EQ (current_buffer
->selective_display
, Qnil
)
1798 && !detect_input_pending ()
1799 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1800 && NILP (Vexecuting_kbd_macro
))
1801 direct_output_forward_char (-1);
1804 else if (EQ (Vthis_command
, Qself_insert_command
)
1805 /* Try this optimization only on char keystrokes. */
1806 && NATNUMP (last_command_char
)
1807 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1810 = translate_char (Vtranslation_table_for_input
,
1811 XFASTINT (last_command_char
), 0, 0, 0);
1813 if (NILP (Vexecuting_kbd_macro
)
1814 && !EQ (minibuf_window
, selected_window
))
1816 if (!nonundocount
|| nonundocount
>= 20)
1824 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1826 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1828 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1830 || MODIFF
<= SAVE_MODIFF
1831 || windows_or_buffers_changed
1832 || !EQ (current_buffer
->selective_display
, Qnil
)
1833 || detect_input_pending ()
1834 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1835 || !NILP (Vexecuting_kbd_macro
));
1837 value
= internal_self_insert (c
, 0);
1842 if (! NILP (Vpost_command_hook
))
1843 /* Put this before calling adjust_point_for_property
1844 so it will only get called once in any case. */
1847 /* VALUE == 1 when AFTER-CHANGE functions are
1848 installed which is the case most of the time
1849 because FONT-LOCK installs one. */
1850 if (!lose
&& !value
)
1851 direct_output_for_insert (c
);
1856 /* Here for a command that isn't executed directly */
1859 #ifdef HAVE_X_WINDOWS
1860 int scount
= SPECPDL_INDEX ();
1862 if (display_hourglass_p
1863 && NILP (Vexecuting_kbd_macro
))
1865 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1871 if (NILP (current_kboard
->Vprefix_arg
))
1873 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1875 #ifdef HAVE_X_WINDOWS
1876 /* Do not check display_hourglass_p here, because
1877 Fcommand_execute could change it, but we should cancel
1878 hourglass cursor anyway.
1879 But don't cancel the hourglass within a macro
1880 just because a command in the macro finishes. */
1881 if (NILP (Vexecuting_kbd_macro
))
1882 unbind_to (scount
, Qnil
);
1887 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1889 /* Note that the value cell will never directly contain nil
1890 if the symbol is a local variable. */
1891 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1892 safe_run_hooks (Qpost_command_hook
);
1894 /* If displaying a message, resize the echo area window to fit
1895 that message's size exactly. */
1896 if (!NILP (echo_area_buffer
[0]))
1897 resize_echo_area_exactly ();
1899 if (!NILP (Vdeferred_action_list
))
1900 safe_run_hooks (Qdeferred_action_function
);
1902 /* If there is a prefix argument,
1903 1) We don't want Vlast_command to be ``universal-argument''
1904 (that would be dumb), so don't set Vlast_command,
1905 2) we want to leave echoing on so that the prefix will be
1906 echoed as part of this key sequence, so don't call
1908 3) we want to leave this_command_key_count non-zero, so that
1909 read_char will realize that it is re-reading a character, and
1910 not echo it a second time.
1912 If the command didn't actually create a prefix arg,
1913 but is merely a frame event that is transparent to prefix args,
1914 then the above doesn't apply. */
1915 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1917 current_kboard
->Vlast_command
= Vthis_command
;
1918 current_kboard
->Vreal_last_command
= real_this_command
;
1920 this_command_key_count
= 0;
1921 this_command_key_count_reset
= 0;
1922 this_single_command_key_start
= 0;
1925 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1927 /* Setting transient-mark-mode to `only' is a way of
1928 turning it on for just one command. */
1930 if (EQ (Vtransient_mark_mode
, Qidentity
))
1931 Vtransient_mark_mode
= Qnil
;
1932 if (EQ (Vtransient_mark_mode
, Qonly
))
1933 Vtransient_mark_mode
= Qidentity
;
1935 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1937 /* We could also call `deactivate'mark'. */
1938 if (EQ (Vtransient_mark_mode
, Qlambda
))
1939 Vtransient_mark_mode
= Qnil
;
1942 current_buffer
->mark_active
= Qnil
;
1943 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1946 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1947 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1952 if (current_buffer
== prev_buffer
1953 && last_point_position
!= PT
1954 && NILP (Vdisable_point_adjustment
)
1955 && NILP (Vglobal_disable_point_adjustment
)
1956 && !already_adjusted
)
1957 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1959 /* Install chars successfully executed in kbd macro. */
1961 if (!NILP (current_kboard
->defining_kbd_macro
)
1962 && NILP (current_kboard
->Vprefix_arg
))
1963 finalize_kbd_macro_chars ();
1967 any_kboard_state ();
1972 extern Lisp_Object Qcomposition
, Qdisplay
;
1974 /* Adjust point to a boundary of a region that has such a property
1975 that should be treated intangible. For the moment, we check
1976 `composition', `display' and `invisible' properties.
1977 LAST_PT is the last position of point. */
1979 extern Lisp_Object Qafter_string
, Qbefore_string
;
1980 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1983 adjust_point_for_property (last_pt
, modified
)
1988 Lisp_Object val
, overlay
, tmp
;
1989 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1992 /* FIXME: cycling is probably not necessary because these properties
1993 can't be usefully combined anyway. */
1994 while (check_composition
|| check_display
|| check_invisible
)
1996 if (check_composition
1997 && PT
> BEGV
&& PT
< ZV
1998 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1999 && COMPOSITION_VALID_P (beg
, end
, val
)
2000 && beg
< PT
/* && end > PT <- It's always the case. */
2001 && (last_pt
<= beg
|| last_pt
>= end
))
2004 SET_PT (PT
< last_pt
? beg
: end
);
2005 check_display
= check_invisible
= 1;
2007 check_composition
= 0;
2009 && PT
> BEGV
&& PT
< ZV
2010 && !NILP (val
= get_char_property_and_overlay
2011 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
2012 && display_prop_intangible_p (val
)
2013 && (!OVERLAYP (overlay
)
2014 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
2015 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
2016 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
2017 && (beg
< PT
/* && end > PT <- It's always the case. */
2018 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
2021 SET_PT (PT
< last_pt
2022 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
2024 check_composition
= check_invisible
= 1;
2027 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
2029 int inv
, ellipsis
= 0;
2032 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2034 && !NILP (val
= get_char_property_and_overlay
2035 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
2036 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2038 ellipsis
= ellipsis
|| inv
> 1
2039 || (OVERLAYP (overlay
)
2040 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2041 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2042 tmp
= Fnext_single_char_property_change
2043 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
2044 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
2047 && !NILP (val
= get_char_property_and_overlay
2048 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
2049 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2051 ellipsis
= ellipsis
|| inv
> 1
2052 || (OVERLAYP (overlay
)
2053 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2054 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2055 tmp
= Fprevious_single_char_property_change
2056 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2057 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2060 /* Move away from the inside area. */
2061 if (beg
< PT
&& end
> PT
)
2063 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2064 /* We haven't moved yet (so we don't need to fear
2065 infinite-looping) and we were outside the range
2066 before (so either end of the range still corresponds
2067 to a move in the right direction): pretend we moved
2068 less than we actually did, so that we still have
2069 more freedom below in choosing which end of the range
2071 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2072 /* We either have moved already or the last point
2073 was already in the range: we don't get to choose
2074 which end of the range we have to go to. */
2075 : (PT
< last_pt
? beg
: end
));
2076 check_composition
= check_display
= 1;
2078 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2079 the point to something other than its argument, due to
2080 point-motion hooks, intangibility, etc. */
2081 xassert (PT
== beg
|| PT
== end
);
2084 /* Pretend the area doesn't exist if the buffer is not
2086 if (!modified
&& !ellipsis
&& beg
< end
)
2088 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2089 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2090 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2091 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2092 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2093 /* We've already moved as far as we can. Trying to go
2094 to the other end would mean moving backwards and thus
2095 could lead to an infinite loop. */
2097 else if (val
= get_pos_property (make_number (PT
),
2099 TEXT_PROP_MEANS_INVISIBLE (val
)
2100 && (val
= get_pos_property
2101 (make_number (PT
== beg
? end
: beg
),
2103 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2104 (check_composition
= check_display
= 1,
2105 SET_PT (PT
== beg
? end
: beg
));
2108 check_invisible
= 0;
2112 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2115 safe_run_hooks_1 (hook
)
2118 if (NILP (Vrun_hooks
))
2120 return call1 (Vrun_hooks
, Vinhibit_quit
);
2123 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2126 safe_run_hooks_error (data
)
2129 Lisp_Object args
[3];
2130 args
[0] = build_string ("Error in %s: %s");
2131 args
[1] = Vinhibit_quit
;
2134 return Fset (Vinhibit_quit
, Qnil
);
2137 /* If we get an error while running the hook, cause the hook variable
2138 to be nil. Also inhibit quits, so that C-g won't cause the hook
2139 to mysteriously evaporate. */
2142 safe_run_hooks (hook
)
2145 int count
= SPECPDL_INDEX ();
2146 specbind (Qinhibit_quit
, hook
);
2148 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2150 unbind_to (count
, Qnil
);
2154 /* Number of seconds between polling for input. This is a Lisp
2155 variable that can be bound. */
2157 EMACS_INT polling_period
;
2159 /* Nonzero means polling for input is temporarily suppressed. */
2161 int poll_suppress_count
;
2163 /* Asynchronous timer for polling. */
2165 struct atimer
*poll_timer
;
2168 #ifdef POLL_FOR_INPUT
2170 /* Poll for input, so what we catch a C-g if it comes in. This
2171 function is called from x_make_frame_visible, see comment
2177 if (interrupt_input_blocked
== 0
2178 && !waiting_for_input
)
2179 read_avail_input (0);
2182 /* Timer callback function for poll_timer. TIMER is equal to
2186 poll_for_input (timer
)
2187 struct atimer
*timer
;
2189 if (poll_suppress_count
== 0)
2191 interrupt_input_pending
= 1;
2193 poll_for_input_1 ();
2197 #endif /* POLL_FOR_INPUT */
2199 /* Begin signals to poll for input, if they are appropriate.
2200 This function is called unconditionally from various places. */
2205 #ifdef POLL_FOR_INPUT
2206 if (read_socket_hook
&& !interrupt_input
)
2208 /* Turn alarm handling on unconditionally. It might have
2209 been turned off in process.c. */
2210 turn_on_atimers (1);
2212 /* If poll timer doesn't exist, are we need one with
2213 a different interval, start a new one. */
2214 if (poll_timer
== NULL
2215 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2217 EMACS_TIME interval
;
2220 cancel_atimer (poll_timer
);
2222 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2223 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2224 poll_for_input
, NULL
);
2227 /* Let the timer's callback function poll for input
2228 if this becomes zero. */
2229 --poll_suppress_count
;
2234 /* Nonzero if we are using polling to handle input asynchronously. */
2237 input_polling_used ()
2239 #ifdef POLL_FOR_INPUT
2240 return read_socket_hook
&& !interrupt_input
;
2246 /* Turn off polling. */
2251 #ifdef POLL_FOR_INPUT
2252 if (read_socket_hook
&& !interrupt_input
)
2253 ++poll_suppress_count
;
2257 /* Set the value of poll_suppress_count to COUNT
2258 and start or stop polling accordingly. */
2261 set_poll_suppress_count (count
)
2264 #ifdef POLL_FOR_INPUT
2265 if (count
== 0 && poll_suppress_count
!= 0)
2267 poll_suppress_count
= 1;
2270 else if (count
!= 0 && poll_suppress_count
== 0)
2274 poll_suppress_count
= count
;
2278 /* Bind polling_period to a value at least N.
2279 But don't decrease it. */
2282 bind_polling_period (n
)
2285 #ifdef POLL_FOR_INPUT
2286 int new = polling_period
;
2291 stop_other_atimers (poll_timer
);
2293 specbind (Qpolling_period
, make_number (new));
2294 /* Start a new alarm with the new period. */
2299 /* Apply the control modifier to CHARACTER. */
2305 /* Save the upper bits here. */
2306 int upper
= c
& ~0177;
2310 /* Everything in the columns containing the upper-case letters
2311 denotes a control character. */
2312 if (c
>= 0100 && c
< 0140)
2316 /* Set the shift modifier for a control char
2317 made from a shifted letter. But only for letters! */
2318 if (oc
>= 'A' && oc
<= 'Z')
2319 c
|= shift_modifier
;
2322 /* The lower-case letters denote control characters too. */
2323 else if (c
>= 'a' && c
<= 'z')
2326 /* Include the bits for control and shift
2327 only if the basic ASCII code can't indicate them. */
2331 /* Replace the high bits. */
2332 c
|= (upper
& ~ctrl_modifier
);
2337 /* Display the help-echo property of the character after the mouse pointer.
2338 Either show it in the echo area, or call show-help-function to display
2339 it by other means (maybe in a tooltip).
2341 If HELP is nil, that means clear the previous help echo.
2343 If HELP is a string, display that string. If HELP is a function,
2344 call it with OBJECT and POS as arguments; the function should
2345 return a help string or nil for none. For all other types of HELP,
2346 evaluate it to obtain a string.
2348 WINDOW is the window in which the help was generated, if any.
2349 It is nil if not in a window.
2351 If OBJECT is a buffer, POS is the position in the buffer where the
2352 `help-echo' text property was found.
2354 If OBJECT is an overlay, that overlay has a `help-echo' property,
2355 and POS is the position in the overlay's buffer under the mouse.
2357 If OBJECT is a string (an overlay string or a string displayed with
2358 the `display' property). POS is the position in that string under
2361 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2362 echo overwrites a keystroke echo currently displayed in the echo
2365 Note: this function may only be called with HELP nil or a string
2366 from X code running asynchronously. */
2369 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2370 Lisp_Object help
, window
, object
, pos
;
2371 int ok_to_overwrite_keystroke_echo
;
2373 if (!NILP (help
) && !STRINGP (help
))
2375 if (FUNCTIONP (help
))
2377 Lisp_Object args
[4];
2382 help
= safe_call (4, args
);
2385 help
= safe_eval (help
);
2387 if (!STRINGP (help
))
2392 if (!noninteractive
&& STRINGP (help
))
2394 /* The mouse-fixup-help-message Lisp function can call
2395 mouse_position_hook, which resets the mouse_moved flags.
2396 This causes trouble if we are trying to read a mouse motion
2397 event (i.e., if we are inside a `track-mouse' form), so we
2398 restore the mouse_moved flag. */
2399 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2400 help
= call1 (Qmouse_fixup_help_message
, help
);
2406 if (STRINGP (help
) || NILP (help
))
2408 if (!NILP (Vshow_help_function
))
2409 call1 (Vshow_help_function
, help
);
2410 else if (/* Don't overwrite minibuffer contents. */
2411 !MINI_WINDOW_P (XWINDOW (selected_window
))
2412 /* Don't overwrite a keystroke echo. */
2413 && (NILP (echo_message_buffer
)
2414 || ok_to_overwrite_keystroke_echo
)
2415 /* Don't overwrite a prompt. */
2416 && !cursor_in_echo_area
)
2420 int count
= SPECPDL_INDEX ();
2422 if (!help_echo_showing_p
)
2423 Vpre_help_message
= current_message ();
2425 specbind (Qmessage_truncate_lines
, Qt
);
2426 message3_nolog (help
, SBYTES (help
),
2427 STRING_MULTIBYTE (help
));
2428 unbind_to (count
, Qnil
);
2430 else if (STRINGP (Vpre_help_message
))
2432 message3_nolog (Vpre_help_message
,
2433 SBYTES (Vpre_help_message
),
2434 STRING_MULTIBYTE (Vpre_help_message
));
2435 Vpre_help_message
= Qnil
;
2441 help_echo_showing_p
= STRINGP (help
);
2447 /* Input of single characters from keyboard */
2449 Lisp_Object
print_help ();
2450 static Lisp_Object
kbd_buffer_get_event ();
2451 static void record_char ();
2453 static Lisp_Object help_form_saved_window_configs
;
2455 read_char_help_form_unwind (arg
)
2457 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2458 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2459 if (!NILP (window_config
))
2460 Fset_window_configuration (window_config
);
2465 static jmp_buf wrong_kboard_jmpbuf
;
2468 #define STOP_POLLING \
2469 do { if (! polling_stopped_here) stop_polling (); \
2470 polling_stopped_here = 1; } while (0)
2472 #define RESUME_POLLING \
2473 do { if (polling_stopped_here) start_polling (); \
2474 polling_stopped_here = 0; } while (0)
2476 /* read a character from the keyboard; call the redisplay if needed */
2477 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2478 -1 means do not do redisplay, but do do autosaving.
2481 /* The arguments MAPS and NMAPS are for menu prompting.
2482 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2484 PREV_EVENT is the previous input event, or nil if we are reading
2485 the first event of a key sequence (or not reading a key sequence).
2486 If PREV_EVENT is t, that is a "magic" value that says
2487 not to run input methods, but in other respects to act as if
2488 not reading a key sequence.
2490 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2491 if we used a mouse menu to read the input, or zero otherwise. If
2492 USED_MOUSE_MENU is null, we don't dereference it.
2494 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2495 specifying the maximum time to wait until. If no input arrives by
2496 that time, stop waiting and return nil.
2498 Value is t if we showed a menu and the user rejected it. */
2501 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2505 Lisp_Object prev_event
;
2506 int *used_mouse_menu
;
2507 EMACS_TIME
*end_time
;
2509 volatile Lisp_Object c
;
2510 int count
, jmpcount
;
2511 jmp_buf local_getcjmp
;
2513 volatile int key_already_recorded
= 0;
2514 Lisp_Object tem
, save
;
2515 volatile Lisp_Object previous_echo_area_message
;
2516 volatile Lisp_Object also_record
;
2517 volatile int reread
;
2518 struct gcpro gcpro1
, gcpro2
;
2519 int polling_stopped_here
= 0;
2523 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2524 before_command_key_count
= this_command_key_count
;
2525 before_command_echo_length
= echo_length ();
2528 previous_echo_area_message
= Qnil
;
2530 GCPRO2 (c
, previous_echo_area_message
);
2535 if (CONSP (Vunread_post_input_method_events
))
2537 c
= XCAR (Vunread_post_input_method_events
);
2538 Vunread_post_input_method_events
2539 = XCDR (Vunread_post_input_method_events
);
2541 /* Undo what read_char_x_menu_prompt did when it unread
2542 additional keys returned by Fx_popup_menu. */
2544 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2552 if (unread_command_char
!= -1)
2554 XSETINT (c
, unread_command_char
);
2555 unread_command_char
= -1;
2561 if (CONSP (Vunread_command_events
))
2563 c
= XCAR (Vunread_command_events
);
2564 Vunread_command_events
= XCDR (Vunread_command_events
);
2568 /* Undo what sit-for did when it unread additional keys
2569 inside universal-argument. */
2572 && EQ (XCAR (c
), Qt
))
2578 /* Undo what read_char_x_menu_prompt did when it unread
2579 additional keys returned by Fx_popup_menu. */
2581 && EQ (XCDR (c
), Qdisabled
)
2582 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2585 /* If the queued event is something that used the mouse,
2586 set used_mouse_menu accordingly. */
2588 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2589 *used_mouse_menu
= 1;
2591 goto reread_for_input_method
;
2594 if (CONSP (Vunread_input_method_events
))
2596 c
= XCAR (Vunread_input_method_events
);
2597 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2599 /* Undo what read_char_x_menu_prompt did when it unread
2600 additional keys returned by Fx_popup_menu. */
2602 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2606 goto reread_for_input_method
;
2609 this_command_key_count_reset
= 0;
2611 if (!NILP (Vexecuting_kbd_macro
))
2613 /* We set this to Qmacro; since that's not a frame, nobody will
2614 try to switch frames on us, and the selected window will
2617 Since this event came from a macro, it would be misleading to
2618 leave internal_last_event_frame set to wherever the last
2619 real event came from. Normally, a switch-frame event selects
2620 internal_last_event_frame after each command is read, but
2621 events read from a macro should never cause a new frame to be
2623 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2625 /* Exit the macro if we are at the end.
2626 Also, some things replace the macro with t
2627 to force an early exit. */
2628 if (EQ (Vexecuting_kbd_macro
, Qt
)
2629 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2635 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2636 if (STRINGP (Vexecuting_kbd_macro
)
2637 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2638 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2640 executing_kbd_macro_index
++;
2645 if (!NILP (unread_switch_frame
))
2647 c
= unread_switch_frame
;
2648 unread_switch_frame
= Qnil
;
2650 /* This event should make it into this_command_keys, and get echoed
2651 again, so we do not set `reread'. */
2655 /* if redisplay was requested */
2656 if (commandflag
>= 0)
2658 /* If there is pending input, process any events which are not
2659 user-visible, such as X selection_request events. */
2661 || detect_input_pending_run_timers (0))
2662 swallow_events (0); /* may clear input_pending */
2664 /* Redisplay if no pending input. */
2665 while (!input_pending
)
2667 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2668 redisplay_preserve_echo_area (5);
2673 /* Normal case: no input arrived during redisplay. */
2676 /* Input arrived and pre-empted redisplay.
2677 Process any events which are not user-visible. */
2679 /* If that cleared input_pending, try again to redisplay. */
2683 /* Message turns off echoing unless more keystrokes turn it on again.
2685 The code in 20.x for the condition was
2687 1. echo_area_glyphs && *echo_area_glyphs
2688 2. && echo_area_glyphs != current_kboard->echobuf
2689 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2691 (1) means there's a current message displayed
2693 (2) means it's not the message from echoing from the current
2696 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2697 is set to a non-null value. This is done in read_char and it is
2698 set to echo_area_glyphs after a call to echo_char. That means
2699 ok_to_echo_at_next_pause is either null or
2700 current_kboard->echobuf with the appropriate current_kboard at
2703 So, condition (3) means in clear text ok_to_echo_at_next_pause
2704 must be either null, or the current message isn't from echoing at
2705 all, or it's from echoing from a different kboard than the
2708 if (/* There currently is something in the echo area. */
2709 !NILP (echo_area_buffer
[0])
2710 && (/* And it's either not from echoing. */
2711 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2712 /* Or it's an echo from a different kboard. */
2713 || echo_kboard
!= current_kboard
2714 /* Or we explicitly allow overwriting whatever there is. */
2715 || ok_to_echo_at_next_pause
== NULL
))
2720 /* Try reading a character via menu prompting in the minibuf.
2721 Try this before the sit-for, because the sit-for
2722 would do the wrong thing if we are supposed to do
2723 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2724 after a mouse event so don't try a minibuf menu. */
2726 if (nmaps
> 0 && INTERACTIVE
2727 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2728 /* Don't bring up a menu if we already have another event. */
2729 && NILP (Vunread_command_events
)
2730 && unread_command_char
< 0
2731 && !detect_input_pending_run_timers (0))
2733 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2736 key_already_recorded
= 1;
2741 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2742 We will do that below, temporarily for short sections of code,
2743 when appropriate. local_getcjmp must be in effect
2744 around any call to sit_for or kbd_buffer_get_event;
2745 it *must not* be in effect when we call redisplay. */
2747 jmpcount
= SPECPDL_INDEX ();
2748 if (_setjmp (local_getcjmp
))
2750 /* We must have saved the outer value of getcjmp here,
2751 so restore it now. */
2752 restore_getcjmp (save_jump
);
2753 unbind_to (jmpcount
, Qnil
);
2754 XSETINT (c
, quit_char
);
2755 internal_last_event_frame
= selected_frame
;
2756 Vlast_event_frame
= internal_last_event_frame
;
2757 /* If we report the quit char as an event,
2758 don't do so more than once. */
2759 if (!NILP (Vinhibit_quit
))
2764 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2765 if (kb
!= current_kboard
)
2767 Lisp_Object link
= kb
->kbd_queue
;
2768 /* We shouldn't get here if we were in single-kboard mode! */
2773 while (CONSP (XCDR (link
)))
2775 if (!NILP (XCDR (link
)))
2779 kb
->kbd_queue
= Fcons (c
, Qnil
);
2781 XSETCDR (link
, Fcons (c
, Qnil
));
2782 kb
->kbd_queue_has_data
= 1;
2783 current_kboard
= kb
;
2784 /* This is going to exit from read_char
2785 so we had better get rid of this frame's stuff. */
2787 longjmp (wrong_kboard_jmpbuf
, 1);
2794 /* Start idle timers if no time limit is supplied. We don't do it
2795 if a time limit is supplied to avoid an infinite recursion in the
2796 situation where an idle timer calls `sit-for'. */
2799 timer_start_idle ();
2801 /* If in middle of key sequence and minibuffer not active,
2802 start echoing if enough time elapses. */
2804 if (minibuf_level
== 0
2806 && !current_kboard
->immediate_echo
2807 && this_command_key_count
> 0
2809 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2810 && NILP (Fzerop (Vecho_keystrokes
))
2811 && (/* No message. */
2812 NILP (echo_area_buffer
[0])
2813 /* Or empty message. */
2814 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2815 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2816 /* Or already echoing from same kboard. */
2817 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2818 /* Or not echoing before and echoing allowed. */
2819 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2821 /* After a mouse event, start echoing right away.
2822 This is because we are probably about to display a menu,
2823 and we don't want to delay before doing so. */
2824 if (EVENT_HAS_PARAMETERS (prev_event
))
2830 save_getcjmp (save_jump
);
2831 restore_getcjmp (local_getcjmp
);
2832 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2833 restore_getcjmp (save_jump
);
2835 && ! CONSP (Vunread_command_events
))
2840 /* Maybe auto save due to number of keystrokes. */
2842 if (commandflag
!= 0
2843 && auto_save_interval
> 0
2844 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2845 && !detect_input_pending_run_timers (0))
2847 Fdo_auto_save (Qnil
, Qnil
);
2848 /* Hooks can actually change some buffers in auto save. */
2852 /* Try reading using an X menu.
2853 This is never confused with reading using the minibuf
2854 because the recursive call of read_char in read_char_minibuf_menu_prompt
2855 does not pass on any keymaps. */
2857 if (nmaps
> 0 && INTERACTIVE
2858 && !NILP (prev_event
)
2859 && EVENT_HAS_PARAMETERS (prev_event
)
2860 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2861 && !EQ (XCAR (prev_event
), Qtool_bar
)
2862 /* Don't bring up a menu if we already have another event. */
2863 && NILP (Vunread_command_events
)
2864 && unread_command_char
< 0)
2866 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2868 /* Now that we have read an event, Emacs is not idle. */
2875 /* Maybe autosave and/or garbage collect due to idleness. */
2877 if (INTERACTIVE
&& NILP (c
))
2879 int delay_level
, buffer_size
;
2881 /* Slow down auto saves logarithmically in size of current buffer,
2882 and garbage collect while we're at it. */
2883 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2884 last_non_minibuf_size
= Z
- BEG
;
2885 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2887 while (buffer_size
> 64)
2888 delay_level
++, buffer_size
-= buffer_size
>> 2;
2889 if (delay_level
< 4) delay_level
= 4;
2890 /* delay_level is 4 for files under around 50k, 7 at 100k,
2891 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2893 /* Auto save if enough time goes by without input. */
2894 if (commandflag
!= 0
2895 && num_nonmacro_input_events
> last_auto_save
2896 && INTEGERP (Vauto_save_timeout
)
2897 && XINT (Vauto_save_timeout
) > 0)
2900 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2902 save_getcjmp (save_jump
);
2903 restore_getcjmp (local_getcjmp
);
2904 tem0
= sit_for (make_number (timeout
), 1, 1);
2905 restore_getcjmp (save_jump
);
2908 && ! CONSP (Vunread_command_events
))
2910 Fdo_auto_save (Qnil
, Qnil
);
2912 /* If we have auto-saved and there is still no input
2913 available, garbage collect if there has been enough
2914 consing going on to make it worthwhile. */
2915 if (!detect_input_pending_run_timers (0)
2916 && consing_since_gc
> gc_cons_threshold
/ 2)
2917 Fgarbage_collect ();
2924 /* If this has become non-nil here, it has been set by a timer
2925 or sentinel or filter. */
2926 if (CONSP (Vunread_command_events
))
2928 c
= XCAR (Vunread_command_events
);
2929 Vunread_command_events
= XCDR (Vunread_command_events
);
2932 /* Read something from current KBOARD's side queue, if possible. */
2936 if (current_kboard
->kbd_queue_has_data
)
2938 if (!CONSP (current_kboard
->kbd_queue
))
2940 c
= XCAR (current_kboard
->kbd_queue
);
2941 current_kboard
->kbd_queue
2942 = XCDR (current_kboard
->kbd_queue
);
2943 if (NILP (current_kboard
->kbd_queue
))
2944 current_kboard
->kbd_queue_has_data
= 0;
2945 input_pending
= readable_events (0);
2946 if (EVENT_HAS_PARAMETERS (c
)
2947 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2948 internal_last_event_frame
= XCAR (XCDR (c
));
2949 Vlast_event_frame
= internal_last_event_frame
;
2954 /* If current_kboard's side queue is empty check the other kboards.
2955 If one of them has data that we have not yet seen here,
2956 switch to it and process the data waiting for it.
2958 Note: if the events queued up for another kboard
2959 have already been seen here, and therefore are not a complete command,
2960 the kbd_queue_has_data field is 0, so we skip that kboard here.
2961 That's to avoid an infinite loop switching between kboards here. */
2962 if (NILP (c
) && !single_kboard
)
2965 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2966 if (kb
->kbd_queue_has_data
)
2968 current_kboard
= kb
;
2969 /* This is going to exit from read_char
2970 so we had better get rid of this frame's stuff. */
2972 longjmp (wrong_kboard_jmpbuf
, 1);
2981 /* Finally, we read from the main queue,
2982 and if that gives us something we can't use yet, we put it on the
2983 appropriate side queue and try again. */
2992 EMACS_GET_TIME (now
);
2993 if (EMACS_TIME_GE (now
, *end_time
))
2997 /* Actually read a character, waiting if necessary. */
2998 save_getcjmp (save_jump
);
2999 restore_getcjmp (local_getcjmp
);
3001 timer_start_idle ();
3002 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
3003 restore_getcjmp (save_jump
);
3006 if (! NILP (c
) && (kb
!= current_kboard
))
3008 Lisp_Object link
= kb
->kbd_queue
;
3011 while (CONSP (XCDR (link
)))
3013 if (!NILP (XCDR (link
)))
3017 kb
->kbd_queue
= Fcons (c
, Qnil
);
3019 XSETCDR (link
, Fcons (c
, Qnil
));
3020 kb
->kbd_queue_has_data
= 1;
3024 current_kboard
= kb
;
3025 /* This is going to exit from read_char
3026 so we had better get rid of this frame's stuff. */
3028 longjmp (wrong_kboard_jmpbuf
, 1);
3033 /* Terminate Emacs in batch mode if at eof. */
3034 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
3035 Fkill_emacs (make_number (1));
3039 /* Add in any extra modifiers, where appropriate. */
3040 if ((extra_keyboard_modifiers
& CHAR_CTL
)
3041 || ((extra_keyboard_modifiers
& 0177) < ' '
3042 && (extra_keyboard_modifiers
& 0177) != 0))
3043 XSETINT (c
, make_ctrl_char (XINT (c
)));
3045 /* Transfer any other modifier bits directly from
3046 extra_keyboard_modifiers to c. Ignore the actual character code
3047 in the low 16 bits of extra_keyboard_modifiers. */
3048 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
3059 if (commandflag
>= 0
3060 && !input_pending
&& !detect_input_pending_run_timers (0))
3068 /* Buffer switch events are only for internal wakeups
3069 so don't show them to the user.
3070 Also, don't record a key if we already did. */
3071 if (BUFFERP (c
) || key_already_recorded
)
3074 /* Process special events within read_char
3075 and loop around to read another event. */
3078 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3083 int was_locked
= single_kboard
;
3085 last_input_char
= c
;
3086 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
3088 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3089 /* We stopped being idle for this event; undo that. This
3090 prevents automatic window selection (under
3091 mouse_autoselect_window from acting as a real input event, for
3092 example banishing the mouse under mouse-avoidance-mode. */
3093 timer_resume_idle ();
3095 /* Resume allowing input from any kboard, if that was true before. */
3097 any_kboard_state ();
3102 /* Handle things that only apply to characters. */
3105 /* If kbd_buffer_get_event gave us an EOF, return that. */
3109 if ((STRINGP (Vkeyboard_translate_table
)
3110 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3111 || (VECTORP (Vkeyboard_translate_table
)
3112 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3113 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
3114 && CHAR_VALID_P (XINT (c
), 0)))
3117 d
= Faref (Vkeyboard_translate_table
, c
);
3118 /* nil in keyboard-translate-table means no translation. */
3124 /* If this event is a mouse click in the menu bar,
3125 return just menu-bar for now. Modify the mouse click event
3126 so we won't do this twice, then queue it up. */
3127 if (EVENT_HAS_PARAMETERS (c
)
3129 && CONSP (EVENT_START (c
))
3130 && CONSP (XCDR (EVENT_START (c
))))
3134 posn
= POSN_POSN (EVENT_START (c
));
3135 /* Handle menu-bar events:
3136 insert the dummy prefix event `menu-bar'. */
3137 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3139 /* Change menu-bar to (menu-bar) as the event "position". */
3140 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3143 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3148 /* Store these characters into recent_keys, the dribble file if any,
3149 and the keyboard macro being defined, if any. */
3151 if (! NILP (also_record
))
3152 record_char (also_record
);
3154 /* Wipe the echo area.
3155 But first, if we are about to use an input method,
3156 save the echo area contents for it to refer to. */
3158 && ! NILP (Vinput_method_function
)
3159 && (unsigned) XINT (c
) >= ' '
3160 && (unsigned) XINT (c
) != 127
3161 && (unsigned) XINT (c
) < 256)
3163 previous_echo_area_message
= Fcurrent_message ();
3164 Vinput_method_previous_message
= previous_echo_area_message
;
3167 /* Now wipe the echo area, except for help events which do their
3168 own stuff with the echo area. */
3170 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3171 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3173 if (!NILP (echo_area_buffer
[0]))
3174 safe_run_hooks (Qecho_area_clear_hook
);
3175 clear_message (1, 0);
3178 reread_for_input_method
:
3180 /* Pass this to the input method, if appropriate. */
3182 && ! NILP (Vinput_method_function
)
3183 /* Don't run the input method within a key sequence,
3184 after the first event of the key sequence. */
3185 && NILP (prev_event
)
3186 && (unsigned) XINT (c
) >= ' '
3187 && (unsigned) XINT (c
) != 127
3188 && (unsigned) XINT (c
) < 256)
3191 int key_count
, key_count_reset
;
3192 struct gcpro gcpro1
;
3193 int count
= SPECPDL_INDEX ();
3195 /* Save the echo status. */
3196 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3197 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3198 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3199 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3202 if (before_command_restore_flag
)
3204 this_command_key_count
= before_command_key_count_1
;
3205 if (this_command_key_count
< this_single_command_key_start
)
3206 this_single_command_key_start
= this_command_key_count
;
3207 echo_truncate (before_command_echo_length_1
);
3208 before_command_restore_flag
= 0;
3212 /* Save the this_command_keys status. */
3213 key_count
= this_command_key_count
;
3214 key_count_reset
= this_command_key_count_reset
;
3217 keys
= Fcopy_sequence (this_command_keys
);
3222 /* Clear out this_command_keys. */
3223 this_command_key_count
= 0;
3224 this_command_key_count_reset
= 0;
3226 /* Now wipe the echo area. */
3227 if (!NILP (echo_area_buffer
[0]))
3228 safe_run_hooks (Qecho_area_clear_hook
);
3229 clear_message (1, 0);
3232 /* If we are not reading a key sequence,
3233 never use the echo area. */
3236 specbind (Qinput_method_use_echo_area
, Qt
);
3239 /* Call the input method. */
3240 tem
= call1 (Vinput_method_function
, c
);
3242 tem
= unbind_to (count
, tem
);
3244 /* Restore the saved echoing state
3245 and this_command_keys state. */
3246 this_command_key_count
= key_count
;
3247 this_command_key_count_reset
= key_count_reset
;
3249 this_command_keys
= keys
;
3252 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3253 current_kboard
->echo_string
= saved_echo_string
;
3254 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3255 if (saved_immediate_echo
)
3260 /* The input method can return no events. */
3263 /* Bring back the previous message, if any. */
3264 if (! NILP (previous_echo_area_message
))
3265 message_with_string ("%s", previous_echo_area_message
, 0);
3268 /* It returned one event or more. */
3270 Vunread_post_input_method_events
3271 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3276 /* Display help if not echoing. */
3277 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3279 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3280 Lisp_Object help
, object
, position
, window
, tem
;
3282 tem
= Fcdr (XCDR (c
));
3285 window
= Fcar (tem
);
3287 object
= Fcar (tem
);
3289 position
= Fcar (tem
);
3291 show_help_echo (help
, window
, object
, position
, 0);
3293 /* We stopped being idle for this event; undo that. */
3295 timer_resume_idle ();
3299 if ((! reread
|| this_command_key_count
== 0
3300 || this_command_key_count_reset
)
3304 /* Don't echo mouse motion events. */
3305 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3306 && NILP (Fzerop (Vecho_keystrokes
))
3307 && ! (EVENT_HAS_PARAMETERS (c
)
3308 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3311 if (! NILP (also_record
))
3312 echo_char (also_record
);
3313 /* Once we reread a character, echoing can happen
3314 the next time we pause to read a new one. */
3315 ok_to_echo_at_next_pause
= current_kboard
;
3318 /* Record this character as part of the current key. */
3319 add_command_key (c
);
3320 if (! NILP (also_record
))
3321 add_command_key (also_record
);
3324 last_input_char
= c
;
3327 /* Process the help character specially if enabled */
3328 if (!NILP (Vhelp_form
) && help_char_p (c
))
3331 count
= SPECPDL_INDEX ();
3333 help_form_saved_window_configs
3334 = Fcons (Fcurrent_window_configuration (Qnil
),
3335 help_form_saved_window_configs
);
3336 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3338 tem0
= Feval (Vhelp_form
);
3340 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3345 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3346 if (EVENT_HAS_PARAMETERS (c
)
3347 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3348 XSETCAR (help_form_saved_window_configs
, Qnil
);
3350 while (BUFFERP (c
));
3351 /* Remove the help from the frame */
3352 unbind_to (count
, Qnil
);
3355 if (EQ (c
, make_number (040)))
3359 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3360 while (BUFFERP (c
));
3369 /* Record a key that came from a mouse menu.
3370 Record it for echoing, for this-command-keys, and so on. */
3376 /* Wipe the echo area. */
3377 clear_message (1, 0);
3382 before_command_key_count
= this_command_key_count
;
3383 before_command_echo_length
= echo_length ();
3386 /* Don't echo mouse motion events. */
3387 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3388 && NILP (Fzerop (Vecho_keystrokes
)))
3392 /* Once we reread a character, echoing can happen
3393 the next time we pause to read a new one. */
3394 ok_to_echo_at_next_pause
= 0;
3397 /* Record this character as part of the current key. */
3398 add_command_key (c
);
3400 /* Re-reading in the middle of a command */
3401 last_input_char
= c
;
3405 /* Return 1 if should recognize C as "the help character". */
3413 if (EQ (c
, Vhelp_char
))
3415 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3416 if (EQ (c
, XCAR (tail
)))
3421 /* Record the input event C in various ways. */
3429 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3431 /* To avoid filling recent_keys with help-echo and mouse-movement
3432 events, we filter out repeated help-echo events, only store the
3433 first and last in a series of mouse-movement events, and don't
3434 store repeated help-echo events which are only separated by
3435 mouse-movement events. */
3437 Lisp_Object ev1
, ev2
, ev3
;
3440 if ((ix1
= recent_keys_index
- 1) < 0)
3441 ix1
= NUM_RECENT_KEYS
- 1;
3442 ev1
= AREF (recent_keys
, ix1
);
3444 if ((ix2
= ix1
- 1) < 0)
3445 ix2
= NUM_RECENT_KEYS
- 1;
3446 ev2
= AREF (recent_keys
, ix2
);
3448 if ((ix3
= ix2
- 1) < 0)
3449 ix3
= NUM_RECENT_KEYS
- 1;
3450 ev3
= AREF (recent_keys
, ix3
);
3452 if (EQ (XCAR (c
), Qhelp_echo
))
3454 /* Don't record `help-echo' in recent_keys unless it shows some help
3455 message, and a different help than the previously recorded
3457 Lisp_Object help
, last_help
;
3459 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3460 if (!STRINGP (help
))
3462 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3463 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3465 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3466 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3467 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3469 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3470 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3471 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3472 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3475 else if (EQ (XCAR (c
), Qmouse_movement
))
3477 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3478 So additional mouse movement events replace the last element. */
3479 Lisp_Object last_window
, window
;
3481 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3482 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3483 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3484 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3485 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3487 ASET (recent_keys
, ix1
, c
);
3493 store_kbd_macro_char (c
);
3498 ASET (recent_keys
, recent_keys_index
, c
);
3499 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3500 recent_keys_index
= 0;
3502 else if (recorded
< 0)
3504 /* We need to remove one or two events from recent_keys.
3505 To do this, we simply put nil at those events and move the
3506 recent_keys_index backwards over those events. Usually,
3507 users will never see those nil events, as they will be
3508 overwritten by the command keys entered to see recent_keys
3511 while (recorded
++ < 0 && total_keys
> 0)
3513 if (total_keys
< NUM_RECENT_KEYS
)
3515 if (--recent_keys_index
< 0)
3516 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3517 ASET (recent_keys
, recent_keys_index
, Qnil
);
3521 num_nonmacro_input_events
++;
3523 /* Write c to the dribble file. If c is a lispy event, write
3524 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3525 If you, dear reader, have a better idea, you've got the source. :-) */
3530 if (XUINT (c
) < 0x100)
3531 putc (XINT (c
), dribble
);
3533 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3537 Lisp_Object dribblee
;
3539 /* If it's a structured event, take the event header. */
3540 dribblee
= EVENT_HEAD (c
);
3542 if (SYMBOLP (dribblee
))
3544 putc ('<', dribble
);
3545 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3546 SBYTES (SYMBOL_NAME (dribblee
)),
3548 putc ('>', dribble
);
3560 struct buffer
*old
= current_buffer
;
3561 Fprinc (object
, Qnil
);
3562 set_buffer_internal (XBUFFER (Vstandard_output
));
3563 call0 (intern ("help-mode"));
3564 set_buffer_internal (old
);
3568 /* Copy out or in the info on where C-g should throw to.
3569 This is used when running Lisp code from within get_char,
3570 in case get_char is called recursively.
3571 See read_process_output. */
3577 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3581 restore_getcjmp (temp
)
3584 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3587 /* Low level keyboard/mouse input.
3588 kbd_buffer_store_event places events in kbd_buffer, and
3589 kbd_buffer_get_event retrieves them. */
3591 /* Return true iff there are any events in the queue that read-char
3592 would return. If this returns false, a read-char would block. */
3594 readable_events (flags
)
3597 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3600 /* If the buffer contains only FOCUS_IN_EVENT events, and
3601 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3602 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3604 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3605 #ifdef USE_TOOLKIT_SCROLL_BARS
3606 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3610 struct input_event
*event
;
3612 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3619 #ifdef USE_TOOLKIT_SCROLL_BARS
3620 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3622 event
->kind
== FOCUS_IN_EVENT
)
3623 #ifdef USE_TOOLKIT_SCROLL_BARS
3624 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3625 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3626 && event
->part
== scroll_bar_handle
3627 && event
->modifiers
== 0)
3632 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3635 while (event
!= kbd_store_ptr
);
3642 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3643 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3648 if (current_kboard
->kbd_queue_has_data
)
3654 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3655 if (kb
->kbd_queue_has_data
)
3661 /* Set this for debugging, to have a way to get out */
3666 event_to_kboard (event
)
3667 struct input_event
*event
;
3670 frame
= event
->frame_or_window
;
3672 frame
= XCAR (frame
);
3673 else if (WINDOWP (frame
))
3674 frame
= WINDOW_FRAME (XWINDOW (frame
));
3676 /* There are still some events that don't set this field.
3677 For now, just ignore the problem.
3678 Also ignore dead frames here. */
3679 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3682 return FRAME_KBOARD (XFRAME (frame
));
3687 Lisp_Object Vthrow_on_input
;
3689 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3692 kbd_buffer_store_event (event
)
3693 register struct input_event
*event
;
3695 kbd_buffer_store_event_hold (event
, 0);
3698 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3700 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3701 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3702 Else, if EVENT is a quit event, store the quit event
3703 in HOLD_QUIT, and return (thus ignoring further events).
3705 This is used in read_avail_input to postpone the processing
3706 of the quit event until all subsequent input events have been
3707 parsed (and discarded).
3711 kbd_buffer_store_event_hold (event
, hold_quit
)
3712 register struct input_event
*event
;
3713 struct input_event
*hold_quit
;
3715 if (event
->kind
== NO_EVENT
)
3718 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3721 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3723 register int c
= event
->code
& 0377;
3725 if (event
->modifiers
& ctrl_modifier
)
3726 c
= make_ctrl_char (c
);
3728 c
|= (event
->modifiers
3729 & (meta_modifier
| alt_modifier
3730 | hyper_modifier
| super_modifier
));
3736 struct input_event
*sp
;
3739 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3740 kb
!= current_kboard
))
3743 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3744 Fcons (make_number (c
), Qnil
));
3745 kb
->kbd_queue_has_data
= 1;
3746 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3748 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3751 if (event_to_kboard (sp
) == kb
)
3753 sp
->kind
= NO_EVENT
;
3754 sp
->frame_or_window
= Qnil
;
3764 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3768 /* If this results in a quit_char being returned to Emacs as
3769 input, set Vlast_event_frame properly. If this doesn't
3770 get returned to Emacs as an event, the next event read
3771 will set Vlast_event_frame again, so this is safe to do. */
3775 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3777 focus
= event
->frame_or_window
;
3778 internal_last_event_frame
= focus
;
3779 Vlast_event_frame
= focus
;
3782 last_event_timestamp
= event
->timestamp
;
3783 interrupt_signal (0 /* dummy */);
3787 if (c
&& c
== stop_character
)
3793 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3794 Just ignore the second one. */
3795 else if (event
->kind
== BUFFER_SWITCH_EVENT
3796 && kbd_fetch_ptr
!= kbd_store_ptr
3797 && ((kbd_store_ptr
== kbd_buffer
3798 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3799 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3802 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3803 kbd_store_ptr
= kbd_buffer
;
3805 /* Don't let the very last slot in the buffer become full,
3806 since that would make the two pointers equal,
3807 and that is indistinguishable from an empty buffer.
3808 Discard the event if it would fill the last slot. */
3809 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3811 *kbd_store_ptr
= *event
;
3815 /* If we're inside while-no-input, and this event qualifies
3816 as input, set quit-flag to cause an interrupt. */
3817 if (!NILP (Vthrow_on_input
)
3818 && event
->kind
!= FOCUS_IN_EVENT
3819 && event
->kind
!= HELP_EVENT
3820 && event
->kind
!= DEICONIFY_EVENT
)
3822 Vquit_flag
= Vthrow_on_input
;
3823 /* If we're inside a function that wants immediate quits,
3825 if (immediate_quit
&& NILP (Vinhibit_quit
))
3835 /* Put an input event back in the head of the event queue. */
3838 kbd_buffer_unget_event (event
)
3839 register struct input_event
*event
;
3841 if (kbd_fetch_ptr
== kbd_buffer
)
3842 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3844 /* Don't let the very last slot in the buffer become full, */
3845 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3848 *kbd_fetch_ptr
= *event
;
3853 /* Generate HELP_EVENT input_events in BUFP which has room for
3854 SIZE events. If there's not enough room in BUFP, ignore this
3857 HELP is the help form.
3859 FRAME is the frame on which the help is generated. OBJECT is the
3860 Lisp object where the help was found (a buffer, a string, an
3861 overlay, or nil if neither from a string nor from a buffer. POS is
3862 the position within OBJECT where the help was found.
3864 Value is the number of input_events generated. */
3867 gen_help_event (help
, frame
, window
, object
, pos
)
3868 Lisp_Object help
, frame
, object
, window
;
3871 struct input_event event
;
3875 event
.kind
= HELP_EVENT
;
3876 event
.frame_or_window
= frame
;
3878 event
.x
= WINDOWP (window
) ? window
: frame
;
3881 kbd_buffer_store_event (&event
);
3885 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3888 kbd_buffer_store_help_event (frame
, help
)
3889 Lisp_Object frame
, help
;
3891 struct input_event event
;
3893 event
.kind
= HELP_EVENT
;
3894 event
.frame_or_window
= frame
;
3899 kbd_buffer_store_event (&event
);
3903 /* Discard any mouse events in the event buffer by setting them to
3906 discard_mouse_events ()
3908 struct input_event
*sp
;
3909 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3911 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3914 if (sp
->kind
== MOUSE_CLICK_EVENT
3915 || sp
->kind
== WHEEL_EVENT
3917 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3919 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3921 sp
->kind
= NO_EVENT
;
3927 /* Return non-zero if there are any real events waiting in the event
3928 buffer, not counting `NO_EVENT's.
3930 If DISCARD is non-zero, discard NO_EVENT events at the front of
3931 the input queue, possibly leaving the input queue empty if there
3932 are no real input events. */
3935 kbd_buffer_events_waiting (discard
)
3938 struct input_event
*sp
;
3940 for (sp
= kbd_fetch_ptr
;
3941 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3944 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3951 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3955 /* Clear input event EVENT. */
3959 struct input_event
*event
;
3961 event
->kind
= NO_EVENT
;
3965 /* Read one event from the event buffer, waiting if necessary.
3966 The value is a Lisp object representing the event.
3967 The value is nil for an event that should be ignored,
3968 or that was handled here.
3969 We always read and discard one event. */
3972 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
3974 int *used_mouse_menu
;
3975 EMACS_TIME
*end_time
;
3984 *kbp
= current_kboard
;
3988 /* Wait until there is input available. */
3991 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3994 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3998 /* If the quit flag is set, then read_char will return
3999 quit_char, so that counts as "available input." */
4000 if (!NILP (Vquit_flag
))
4001 quit_throw_to_read_char ();
4003 /* One way or another, wait until input is available; then, if
4004 interrupt handlers have not read it, read it now. */
4007 wait_for_kbd_input ();
4009 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4013 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4016 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4021 EMACS_TIME duration
;
4022 EMACS_GET_TIME (duration
);
4023 if (EMACS_TIME_GE (duration
, *end_time
))
4024 return Qnil
; /* finished waiting */
4027 EMACS_SUB_TIME (duration
, *end_time
, duration
);
4028 wait_reading_process_output (EMACS_SECS (duration
),
4029 EMACS_USECS (duration
),
4030 -1, 1, Qnil
, NULL
, 0);
4034 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
4036 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
4037 /* Pass 1 for EXPECT since we just waited to have input. */
4038 read_avail_input (1);
4039 #endif /* not VMS */
4042 if (CONSP (Vunread_command_events
))
4045 first
= XCAR (Vunread_command_events
);
4046 Vunread_command_events
= XCDR (Vunread_command_events
);
4047 *kbp
= current_kboard
;
4051 /* At this point, we know that there is a readable event available
4052 somewhere. If the event queue is empty, then there must be a
4053 mouse movement enabled and available. */
4054 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4056 struct input_event
*event
;
4058 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4062 last_event_timestamp
= event
->timestamp
;
4065 *kbp
= event_to_kboard (event
);
4067 *kbp
= current_kboard
; /* Better than returning null ptr? */
4069 *kbp
= &the_only_kboard
;
4074 /* These two kinds of events get special handling
4075 and don't actually appear to the command loop.
4076 We return nil for them. */
4077 if (event
->kind
== SELECTION_REQUEST_EVENT
4078 || event
->kind
== SELECTION_CLEAR_EVENT
)
4081 struct input_event copy
;
4083 /* Remove it from the buffer before processing it,
4084 since otherwise swallow_events will see it
4085 and process it again. */
4087 kbd_fetch_ptr
= event
+ 1;
4088 input_pending
= readable_events (0);
4089 x_handle_selection_event (©
);
4091 /* We're getting selection request events, but we don't have
4097 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4098 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4100 /* Make an event (delete-frame (FRAME)). */
4101 obj
= Fcons (event
->frame_or_window
, Qnil
);
4102 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4103 kbd_fetch_ptr
= event
+ 1;
4106 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4107 else if (event
->kind
== ICONIFY_EVENT
)
4109 /* Make an event (iconify-frame (FRAME)). */
4110 obj
= Fcons (event
->frame_or_window
, Qnil
);
4111 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4112 kbd_fetch_ptr
= event
+ 1;
4114 else if (event
->kind
== DEICONIFY_EVENT
)
4116 /* Make an event (make-frame-visible (FRAME)). */
4117 obj
= Fcons (event
->frame_or_window
, Qnil
);
4118 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4119 kbd_fetch_ptr
= event
+ 1;
4122 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4124 /* The value doesn't matter here; only the type is tested. */
4125 XSETBUFFER (obj
, current_buffer
);
4126 kbd_fetch_ptr
= event
+ 1;
4128 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4129 || defined (USE_GTK)
4130 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4132 kbd_fetch_ptr
= event
+ 1;
4133 input_pending
= readable_events (0);
4134 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4135 x_activate_menubar (XFRAME (event
->frame_or_window
));
4138 #if defined (WINDOWSNT) || defined (MAC_OS)
4139 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4142 /* Make an event (language-change (KEY_SCRIPT)). */
4143 obj
= Fcons (make_number (event
->code
), Qnil
);
4145 /* Make an event (language-change (FRAME CHARSET LCID)). */
4146 obj
= Fcons (event
->frame_or_window
, Qnil
);
4148 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4149 kbd_fetch_ptr
= event
+ 1;
4152 else if (event
->kind
== SAVE_SESSION_EVENT
)
4154 obj
= Fcons (Qsave_session
, Qnil
);
4155 kbd_fetch_ptr
= event
+ 1;
4157 /* Just discard these, by returning nil.
4158 With MULTI_KBOARD, these events are used as placeholders
4159 when we need to randomly delete events from the queue.
4160 (They shouldn't otherwise be found in the buffer,
4161 but on some machines it appears they do show up
4162 even without MULTI_KBOARD.) */
4163 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4164 mouse events during a popup-menu call. */
4165 else if (event
->kind
== NO_EVENT
)
4166 kbd_fetch_ptr
= event
+ 1;
4167 else if (event
->kind
== HELP_EVENT
)
4169 Lisp_Object object
, position
, help
, frame
, window
;
4171 frame
= event
->frame_or_window
;
4172 object
= event
->arg
;
4173 position
= make_number (event
->code
);
4176 clear_event (event
);
4178 kbd_fetch_ptr
= event
+ 1;
4179 if (!WINDOWP (window
))
4181 obj
= Fcons (Qhelp_echo
,
4182 list5 (frame
, help
, window
, object
, position
));
4184 else if (event
->kind
== FOCUS_IN_EVENT
)
4186 /* Notification of a FocusIn event. The frame receiving the
4187 focus is in event->frame_or_window. Generate a
4188 switch-frame event if necessary. */
4189 Lisp_Object frame
, focus
;
4191 frame
= event
->frame_or_window
;
4192 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4196 if (!EQ (frame
, internal_last_event_frame
)
4197 && !EQ (frame
, selected_frame
))
4198 obj
= make_lispy_switch_frame (frame
);
4199 internal_last_event_frame
= frame
;
4200 kbd_fetch_ptr
= event
+ 1;
4204 /* If this event is on a different frame, return a switch-frame this
4205 time, and leave the event in the queue for next time. */
4209 frame
= event
->frame_or_window
;
4211 frame
= XCAR (frame
);
4212 else if (WINDOWP (frame
))
4213 frame
= WINDOW_FRAME (XWINDOW (frame
));
4215 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4219 if (! EQ (frame
, internal_last_event_frame
)
4220 && !EQ (frame
, selected_frame
))
4221 obj
= make_lispy_switch_frame (frame
);
4222 internal_last_event_frame
= frame
;
4224 /* If we didn't decide to make a switch-frame event, go ahead
4225 and build a real event from the queue entry. */
4229 obj
= make_lispy_event (event
);
4231 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4232 || defined (USE_GTK)
4233 /* If this was a menu selection, then set the flag to inhibit
4234 writing to last_nonmenu_event. Don't do this if the event
4235 we're returning is (menu-bar), though; that indicates the
4236 beginning of the menu sequence, and we might as well leave
4237 that as the `event with parameters' for this selection. */
4239 && !EQ (event
->frame_or_window
, event
->arg
)
4240 && (event
->kind
== MENU_BAR_EVENT
4241 || event
->kind
== TOOL_BAR_EVENT
))
4242 *used_mouse_menu
= 1;
4245 /* Wipe out this event, to catch bugs. */
4246 clear_event (event
);
4247 kbd_fetch_ptr
= event
+ 1;
4252 /* Try generating a mouse motion event. */
4253 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4255 FRAME_PTR f
= some_mouse_moved ();
4256 Lisp_Object bar_window
;
4257 enum scroll_bar_part part
;
4261 *kbp
= current_kboard
;
4262 /* Note that this uses F to determine which display to look at.
4263 If there is no valid info, it does not store anything
4264 so x remains nil. */
4266 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4270 /* Decide if we should generate a switch-frame event. Don't
4271 generate switch-frame events for motion outside of all Emacs
4277 frame
= FRAME_FOCUS_FRAME (f
);
4279 XSETFRAME (frame
, f
);
4281 if (! EQ (frame
, internal_last_event_frame
)
4282 && !EQ (frame
, selected_frame
))
4283 obj
= make_lispy_switch_frame (frame
);
4284 internal_last_event_frame
= frame
;
4287 /* If we didn't decide to make a switch-frame event, go ahead and
4288 return a mouse-motion event. */
4289 if (!NILP (x
) && NILP (obj
))
4290 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4292 #endif /* HAVE_MOUSE */
4294 /* We were promised by the above while loop that there was
4295 something for us to read! */
4298 input_pending
= readable_events (0);
4300 Vlast_event_frame
= internal_last_event_frame
;
4305 /* Process any events that are not user-visible,
4306 then return, without reading any user-visible events. */
4309 swallow_events (do_display
)
4314 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4316 struct input_event
*event
;
4318 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4322 last_event_timestamp
= event
->timestamp
;
4324 /* These two kinds of events get special handling
4325 and don't actually appear to the command loop. */
4326 if (event
->kind
== SELECTION_REQUEST_EVENT
4327 || event
->kind
== SELECTION_CLEAR_EVENT
)
4330 struct input_event copy
;
4332 /* Remove it from the buffer before processing it,
4333 since otherwise swallow_events called recursively could see it
4334 and process it again. */
4336 kbd_fetch_ptr
= event
+ 1;
4337 input_pending
= readable_events (0);
4338 x_handle_selection_event (©
);
4340 /* We're getting selection request events, but we don't have
4349 old_timers_run
= timers_run
;
4350 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4352 if (timers_run
!= old_timers_run
&& do_display
)
4353 redisplay_preserve_echo_area (7);
4356 /* Record the start of when Emacs is idle,
4357 for the sake of running idle-time timers. */
4364 /* If we are already in the idle state, do nothing. */
4365 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4368 EMACS_GET_TIME (timer_idleness_start_time
);
4370 timer_last_idleness_start_time
= timer_idleness_start_time
;
4372 /* Mark all idle-time timers as once again candidates for running. */
4373 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4377 timer
= XCAR (timers
);
4379 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4381 XVECTOR (timer
)->contents
[0] = Qnil
;
4385 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4390 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4393 /* Resume idle timer from last idle start time. */
4396 timer_resume_idle ()
4398 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4401 timer_idleness_start_time
= timer_last_idleness_start_time
;
4404 /* This is only for debugging. */
4405 struct input_event last_timer_event
;
4407 /* Check whether a timer has fired. To prevent larger problems we simply
4408 disregard elements that are not proper timers. Do not make a circular
4409 timer list for the time being.
4411 Returns the number of seconds to wait until the next timer fires. If a
4412 timer is triggering now, return zero seconds.
4413 If no timer is active, return -1 seconds.
4415 If a timer is ripe, we run it, with quitting turned off.
4417 DO_IT_NOW is now ignored. It used to mean that we should
4418 run the timer directly instead of queueing a timer-event.
4419 Now we always run timers directly. */
4422 timer_check (do_it_now
)
4425 EMACS_TIME nexttime
;
4426 EMACS_TIME now
, idleness_now
;
4427 Lisp_Object timers
, idle_timers
, chosen_timer
;
4428 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4430 EMACS_SET_SECS (nexttime
, -1);
4431 EMACS_SET_USECS (nexttime
, -1);
4433 /* Always consider the ordinary timers. */
4434 timers
= Vtimer_list
;
4435 /* Consider the idle timers only if Emacs is idle. */
4436 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4437 idle_timers
= Vtimer_idle_list
;
4440 chosen_timer
= Qnil
;
4441 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4443 if (CONSP (timers
) || CONSP (idle_timers
))
4445 EMACS_GET_TIME (now
);
4446 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4447 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4450 while (CONSP (timers
) || CONSP (idle_timers
))
4452 Lisp_Object
*vector
;
4453 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4454 EMACS_TIME timer_time
, idle_timer_time
;
4455 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4457 /* Skip past invalid timers and timers already handled. */
4460 timer
= XCAR (timers
);
4461 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4463 timers
= XCDR (timers
);
4466 vector
= XVECTOR (timer
)->contents
;
4468 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4469 || !INTEGERP (vector
[3])
4470 || ! NILP (vector
[0]))
4472 timers
= XCDR (timers
);
4476 if (!NILP (idle_timers
))
4478 timer
= XCAR (idle_timers
);
4479 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4481 idle_timers
= XCDR (idle_timers
);
4484 vector
= XVECTOR (timer
)->contents
;
4486 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4487 || !INTEGERP (vector
[3])
4488 || ! NILP (vector
[0]))
4490 idle_timers
= XCDR (idle_timers
);
4495 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4496 based on the next ordinary timer.
4497 TIMER_DIFFERENCE is the distance in time from NOW to when
4498 this timer becomes ripe (negative if it's already ripe). */
4501 timer
= XCAR (timers
);
4502 vector
= XVECTOR (timer
)->contents
;
4503 EMACS_SET_SECS (timer_time
,
4504 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4505 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4506 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4509 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4510 based on the next idle timer. */
4511 if (!NILP (idle_timers
))
4513 idle_timer
= XCAR (idle_timers
);
4514 vector
= XVECTOR (idle_timer
)->contents
;
4515 EMACS_SET_SECS (idle_timer_time
,
4516 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4517 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4518 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4521 /* Decide which timer is the next timer,
4522 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4523 Also step down the list where we found that timer. */
4525 if (! NILP (timers
) && ! NILP (idle_timers
))
4528 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4529 if (EMACS_TIME_NEG_P (temp
))
4531 chosen_timer
= timer
;
4532 timers
= XCDR (timers
);
4533 difference
= timer_difference
;
4537 chosen_timer
= idle_timer
;
4538 idle_timers
= XCDR (idle_timers
);
4539 difference
= idle_timer_difference
;
4542 else if (! NILP (timers
))
4544 chosen_timer
= timer
;
4545 timers
= XCDR (timers
);
4546 difference
= timer_difference
;
4550 chosen_timer
= idle_timer
;
4551 idle_timers
= XCDR (idle_timers
);
4552 difference
= idle_timer_difference
;
4554 vector
= XVECTOR (chosen_timer
)->contents
;
4556 /* If timer is ripe, run it if it hasn't been run. */
4557 if (EMACS_TIME_NEG_P (difference
)
4558 || (EMACS_SECS (difference
) == 0
4559 && EMACS_USECS (difference
) == 0))
4561 if (NILP (vector
[0]))
4563 int was_locked
= single_kboard
;
4564 int count
= SPECPDL_INDEX ();
4565 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4567 /* Mark the timer as triggered to prevent problems if the lisp
4568 code fails to reschedule it right. */
4571 specbind (Qinhibit_quit
, Qt
);
4573 call1 (Qtimer_event_handler
, chosen_timer
);
4574 Vdeactivate_mark
= old_deactivate_mark
;
4576 unbind_to (count
, Qnil
);
4578 /* Resume allowing input from any kboard, if that was true before. */
4580 any_kboard_state ();
4582 /* Since we have handled the event,
4583 we don't need to tell the caller to wake up and do it. */
4587 /* When we encounter a timer that is still waiting,
4588 return the amount of time to wait before it is ripe. */
4595 /* No timers are pending in the future. */
4596 /* Return 0 if we generated an event, and -1 if not. */
4601 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4602 doc
: /* Return the current length of Emacs idleness.
4603 The value is returned as a list of three integers. The first has the
4604 most significant 16 bits of the seconds, while the second has the
4605 least significant 16 bits. The third integer gives the microsecond
4608 The microsecond count is zero on systems that do not provide
4609 resolution finer than a second. */)
4612 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4614 EMACS_TIME now
, idleness_now
;
4616 EMACS_GET_TIME (now
);
4617 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4619 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4620 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4621 make_number (EMACS_USECS (idleness_now
)));
4627 /* Caches for modify_event_symbol. */
4628 static Lisp_Object accent_key_syms
;
4629 static Lisp_Object func_key_syms
;
4630 static Lisp_Object mouse_syms
;
4631 static Lisp_Object wheel_syms
;
4632 static Lisp_Object drag_n_drop_syms
;
4634 /* This is a list of keysym codes for special "accent" characters.
4635 It parallels lispy_accent_keys. */
4637 static int lispy_accent_codes
[] =
4639 #ifdef XK_dead_circumflex
4644 #ifdef XK_dead_grave
4649 #ifdef XK_dead_tilde
4654 #ifdef XK_dead_diaeresis
4659 #ifdef XK_dead_macron
4664 #ifdef XK_dead_degree
4669 #ifdef XK_dead_acute
4674 #ifdef XK_dead_cedilla
4679 #ifdef XK_dead_breve
4684 #ifdef XK_dead_ogonek
4689 #ifdef XK_dead_caron
4694 #ifdef XK_dead_doubleacute
4695 XK_dead_doubleacute
,
4699 #ifdef XK_dead_abovedot
4704 #ifdef XK_dead_abovering
4714 #ifdef XK_dead_belowdot
4719 #ifdef XK_dead_voiced_sound
4720 XK_dead_voiced_sound
,
4724 #ifdef XK_dead_semivoiced_sound
4725 XK_dead_semivoiced_sound
,
4741 /* This is a list of Lisp names for special "accent" characters.
4742 It parallels lispy_accent_codes. */
4744 static char *lispy_accent_keys
[] =
4762 "dead-voiced-sound",
4763 "dead-semivoiced-sound",
4769 #define FUNCTION_KEY_OFFSET 0x0
4771 char *lispy_function_keys
[] =
4775 0, /* VK_LBUTTON 0x01 */
4776 0, /* VK_RBUTTON 0x02 */
4777 "cancel", /* VK_CANCEL 0x03 */
4778 0, /* VK_MBUTTON 0x04 */
4780 0, 0, 0, /* 0x05 .. 0x07 */
4782 "backspace", /* VK_BACK 0x08 */
4783 "tab", /* VK_TAB 0x09 */
4785 0, 0, /* 0x0A .. 0x0B */
4787 "clear", /* VK_CLEAR 0x0C */
4788 "return", /* VK_RETURN 0x0D */
4790 0, 0, /* 0x0E .. 0x0F */
4792 0, /* VK_SHIFT 0x10 */
4793 0, /* VK_CONTROL 0x11 */
4794 0, /* VK_MENU 0x12 */
4795 "pause", /* VK_PAUSE 0x13 */
4796 "capslock", /* VK_CAPITAL 0x14 */
4798 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4800 "escape", /* VK_ESCAPE 0x1B */
4802 0, 0, 0, 0, /* 0x1C .. 0x1F */
4804 0, /* VK_SPACE 0x20 */
4805 "prior", /* VK_PRIOR 0x21 */
4806 "next", /* VK_NEXT 0x22 */
4807 "end", /* VK_END 0x23 */
4808 "home", /* VK_HOME 0x24 */
4809 "left", /* VK_LEFT 0x25 */
4810 "up", /* VK_UP 0x26 */
4811 "right", /* VK_RIGHT 0x27 */
4812 "down", /* VK_DOWN 0x28 */
4813 "select", /* VK_SELECT 0x29 */
4814 "print", /* VK_PRINT 0x2A */
4815 "execute", /* VK_EXECUTE 0x2B */
4816 "snapshot", /* VK_SNAPSHOT 0x2C */
4817 "insert", /* VK_INSERT 0x2D */
4818 "delete", /* VK_DELETE 0x2E */
4819 "help", /* VK_HELP 0x2F */
4821 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4823 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4825 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4827 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4829 0, 0, 0, 0, 0, 0, 0, 0, 0,
4830 0, 0, 0, 0, 0, 0, 0, 0, 0,
4831 0, 0, 0, 0, 0, 0, 0, 0,
4833 "lwindow", /* VK_LWIN 0x5B */
4834 "rwindow", /* VK_RWIN 0x5C */
4835 "apps", /* VK_APPS 0x5D */
4837 0, 0, /* 0x5E .. 0x5F */
4839 "kp-0", /* VK_NUMPAD0 0x60 */
4840 "kp-1", /* VK_NUMPAD1 0x61 */
4841 "kp-2", /* VK_NUMPAD2 0x62 */
4842 "kp-3", /* VK_NUMPAD3 0x63 */
4843 "kp-4", /* VK_NUMPAD4 0x64 */
4844 "kp-5", /* VK_NUMPAD5 0x65 */
4845 "kp-6", /* VK_NUMPAD6 0x66 */
4846 "kp-7", /* VK_NUMPAD7 0x67 */
4847 "kp-8", /* VK_NUMPAD8 0x68 */
4848 "kp-9", /* VK_NUMPAD9 0x69 */
4849 "kp-multiply", /* VK_MULTIPLY 0x6A */
4850 "kp-add", /* VK_ADD 0x6B */
4851 "kp-separator", /* VK_SEPARATOR 0x6C */
4852 "kp-subtract", /* VK_SUBTRACT 0x6D */
4853 "kp-decimal", /* VK_DECIMAL 0x6E */
4854 "kp-divide", /* VK_DIVIDE 0x6F */
4855 "f1", /* VK_F1 0x70 */
4856 "f2", /* VK_F2 0x71 */
4857 "f3", /* VK_F3 0x72 */
4858 "f4", /* VK_F4 0x73 */
4859 "f5", /* VK_F5 0x74 */
4860 "f6", /* VK_F6 0x75 */
4861 "f7", /* VK_F7 0x76 */
4862 "f8", /* VK_F8 0x77 */
4863 "f9", /* VK_F9 0x78 */
4864 "f10", /* VK_F10 0x79 */
4865 "f11", /* VK_F11 0x7A */
4866 "f12", /* VK_F12 0x7B */
4867 "f13", /* VK_F13 0x7C */
4868 "f14", /* VK_F14 0x7D */
4869 "f15", /* VK_F15 0x7E */
4870 "f16", /* VK_F16 0x7F */
4871 "f17", /* VK_F17 0x80 */
4872 "f18", /* VK_F18 0x81 */
4873 "f19", /* VK_F19 0x82 */
4874 "f20", /* VK_F20 0x83 */
4875 "f21", /* VK_F21 0x84 */
4876 "f22", /* VK_F22 0x85 */
4877 "f23", /* VK_F23 0x86 */
4878 "f24", /* VK_F24 0x87 */
4880 0, 0, 0, 0, /* 0x88 .. 0x8B */
4881 0, 0, 0, 0, /* 0x8C .. 0x8F */
4883 "kp-numlock", /* VK_NUMLOCK 0x90 */
4884 "scroll", /* VK_SCROLL 0x91 */
4886 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4887 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4888 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4889 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4890 "kp-end", /* VK_NUMPAD_END 0x96 */
4891 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4892 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4893 "kp-up", /* VK_NUMPAD_UP 0x99 */
4894 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4895 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4896 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4897 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4899 0, 0, /* 0x9E .. 0x9F */
4902 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4903 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4904 * No other API or message will distinguish left and right keys this way.
4908 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4909 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4910 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4911 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4912 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4918 "attn", /* VK_ATTN 0xF6 */
4919 "crsel", /* VK_CRSEL 0xF7 */
4920 "exsel", /* VK_EXSEL 0xF8 */
4921 "ereof", /* VK_EREOF 0xF9 */
4922 "play", /* VK_PLAY 0xFA */
4923 "zoom", /* VK_ZOOM 0xFB */
4924 "noname", /* VK_NONAME 0xFC */
4925 "pa1", /* VK_PA1 0xFD */
4926 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4930 #else /* not HAVE_NTGUI */
4932 /* This should be dealt with in XTread_socket now, and that doesn't
4933 depend on the client system having the Kana syms defined. See also
4934 the XK_kana_A case below. */
4937 static char *lispy_kana_keys
[] =
4939 /* X Keysym value */
4940 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4941 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4942 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4943 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4944 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4945 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4946 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4947 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4948 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4949 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4950 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4951 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4952 "kana-i", "kana-u", "kana-e", "kana-o",
4953 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4954 "prolongedsound", "kana-A", "kana-I", "kana-U",
4955 "kana-E", "kana-O", "kana-KA", "kana-KI",
4956 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4957 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4958 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4959 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4960 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4961 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4962 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4963 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4964 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4965 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4966 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4967 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4969 #endif /* XK_kana_A */
4972 #define FUNCTION_KEY_OFFSET 0xff00
4974 /* You'll notice that this table is arranged to be conveniently
4975 indexed by X Windows keysym values. */
4976 static char *lispy_function_keys
[] =
4978 /* X Keysym value */
4980 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4981 "backspace", "tab", "linefeed", "clear",
4983 0, 0, 0, "pause", /* 0xff10...1f */
4984 0, 0, 0, 0, 0, 0, 0, "escape",
4986 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4987 "romaji", "hiragana", "katakana", "hiragana-katakana",
4988 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4989 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4990 "eisu-toggle", /* 0xff30...3f */
4991 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4992 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4994 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4995 "down", "prior", "next", "end",
4996 "begin", 0, 0, 0, 0, 0, 0, 0,
4997 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5008 "break", /* 0xff6b */
5011 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5012 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5013 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5014 0, 0, 0, 0, 0, 0, 0, 0,
5015 "kp-tab", /* 0xff89 */
5017 "kp-enter", /* 0xff8d */
5019 "kp-f1", /* 0xff91 */
5023 "kp-home", /* 0xff95 */
5028 "kp-prior", /* kp-page-up */
5029 "kp-next", /* kp-page-down */
5035 0, 0, 0, 0, 0, 0, 0, 0, 0,
5036 "kp-multiply", /* 0xffaa */
5041 "kp-divide", /* 0xffaf */
5042 "kp-0", /* 0xffb0 */
5043 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5046 "kp-equal", /* 0xffbd */
5047 "f1", /* 0xffbe */ /* IsFunctionKey */
5049 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5050 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5051 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5052 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5053 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5054 0, 0, 0, 0, 0, 0, 0, 0,
5055 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5056 0, 0, 0, 0, 0, 0, 0, "delete"
5059 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5060 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5062 static char *iso_lispy_function_keys
[] =
5064 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5065 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5066 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5067 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5068 "iso-lefttab", /* 0xfe20 */
5069 "iso-move-line-up", "iso-move-line-down",
5070 "iso-partial-line-up", "iso-partial-line-down",
5071 "iso-partial-space-left", "iso-partial-space-right",
5072 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5073 "iso-release-margin-left", "iso-release-margin-right",
5074 "iso-release-both-margins",
5075 "iso-fast-cursor-left", "iso-fast-cursor-right",
5076 "iso-fast-cursor-up", "iso-fast-cursor-down",
5077 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5078 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5081 #endif /* not HAVE_NTGUI */
5083 Lisp_Object Vlispy_mouse_stem
;
5085 static char *lispy_wheel_names
[] =
5087 "wheel-up", "wheel-down"
5090 /* drag-n-drop events are generated when a set of selected files are
5091 dragged from another application and dropped onto an Emacs window. */
5092 static char *lispy_drag_n_drop_names
[] =
5097 /* Scroll bar parts. */
5098 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5099 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5100 Lisp_Object Qtop
, Qratio
;
5102 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5103 Lisp_Object
*scroll_bar_parts
[] = {
5104 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5105 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5108 /* A vector, indexed by button number, giving the down-going location
5109 of currently depressed buttons, both scroll bar and non-scroll bar.
5111 The elements have the form
5112 (BUTTON-NUMBER MODIFIER-MASK . REST)
5113 where REST is the cdr of a position as it would be reported in the event.
5115 The make_lispy_event function stores positions here to tell the
5116 difference between click and drag events, and to store the starting
5117 location to be included in drag events. */
5119 static Lisp_Object button_down_location
;
5121 /* Information about the most recent up-going button event: Which
5122 button, what location, and what time. */
5124 static int last_mouse_button
;
5125 static int last_mouse_x
;
5126 static int last_mouse_y
;
5127 static unsigned long button_down_time
;
5129 /* The maximum time between clicks to make a double-click, or Qnil to
5130 disable double-click detection, or Qt for no time limit. */
5132 Lisp_Object Vdouble_click_time
;
5134 /* Maximum number of pixels the mouse may be moved between clicks
5135 to make a double-click. */
5137 EMACS_INT double_click_fuzz
;
5139 /* The number of clicks in this multiple-click. */
5141 int double_click_count
;
5143 /* Return position of a mouse click or wheel event */
5146 make_lispy_position (f
, x
, y
, time
)
5152 enum window_part part
;
5153 Lisp_Object posn
= Qnil
;
5154 Lisp_Object extra_info
= Qnil
;
5157 /* Set `window' to the window under frame pixel coordinates (x,y) */
5159 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5160 &part
, &wx
, &wy
, 0);
5164 if (WINDOWP (window
))
5166 /* It's a click in window window at frame coordinates (x,y) */
5167 struct window
*w
= XWINDOW (window
);
5168 Lisp_Object string_info
= Qnil
;
5169 int textpos
= -1, rx
= -1, ry
= -1;
5170 int dx
= -1, dy
= -1;
5171 int width
= -1, height
= -1;
5172 Lisp_Object object
= Qnil
;
5174 /* Set event coordinates to window-relative coordinates
5175 for constructing the Lisp event below. */
5179 if (part
== ON_TEXT
)
5181 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5183 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5185 /* Mode line or header line. Look for a string under
5186 the mouse that may have a `local-map' property. */
5190 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5192 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5193 &object
, &dx
, &dy
, &width
, &height
);
5194 if (STRINGP (string
))
5195 string_info
= Fcons (string
, make_number (charpos
));
5196 if (w
== XWINDOW (selected_window
))
5199 textpos
= XMARKER (w
->pointm
)->charpos
;
5201 else if (part
== ON_VERTICAL_BORDER
)
5203 posn
= Qvertical_line
;
5208 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5213 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5215 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5216 &object
, &dx
, &dy
, &width
, &height
);
5217 if (STRINGP (string
))
5218 string_info
= Fcons (string
, make_number (charpos
));
5219 if (part
== ON_LEFT_MARGIN
)
5222 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5224 else if (part
== ON_LEFT_FRINGE
)
5226 posn
= Qleft_fringe
;
5229 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5231 : window_box_width (w
, LEFT_MARGIN_AREA
));
5234 else if (part
== ON_RIGHT_FRINGE
)
5236 posn
= Qright_fringe
;
5239 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5240 + window_box_width (w
, TEXT_AREA
)
5241 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5242 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5248 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5249 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5254 Lisp_Object string2
, object2
= Qnil
;
5255 struct display_pos p
;
5257 int width2
, height2
;
5258 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5259 &object2
, &dx2
, &dy2
,
5261 textpos
= CHARPOS (p
.pos
);
5262 if (rx
< 0) rx
= wx
;
5263 if (ry
< 0) ry
= wy
;
5264 if (dx
< 0) dx
= dx2
;
5265 if (dy
< 0) dy
= dy2
;
5266 if (width
< 0) width
= width2
;
5267 if (height
< 0) height
= height2
;
5271 posn
= make_number (textpos
);
5272 if (STRINGP (string2
))
5273 string_info
= Fcons (string2
,
5274 make_number (CHARPOS (p
.string_pos
)));
5280 #ifdef HAVE_WINDOW_SYSTEM
5281 if (IMAGEP (object
))
5283 Lisp_Object image_map
, hotspot
;
5284 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5286 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5288 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5289 posn
= XCAR (hotspot
);
5294 extra_info
= Fcons (object
,
5295 Fcons (Fcons (make_number (dx
),
5297 Fcons (Fcons (make_number (width
),
5298 make_number (height
)),
5302 extra_info
= Fcons (string_info
,
5303 Fcons (make_number (textpos
),
5304 Fcons (Fcons (make_number (rx
),
5310 XSETFRAME (window
, f
);
5315 XSETFASTINT (*x
, 0);
5316 XSETFASTINT (*y
, 0);
5319 return Fcons (window
,
5321 Fcons (Fcons (*x
, *y
),
5322 Fcons (make_number (time
),
5326 /* Given a struct input_event, build the lisp event which represents
5327 it. If EVENT is 0, build a mouse movement event from the mouse
5328 movement buffer, which should have a movement event in it.
5330 Note that events must be passed to this function in the order they
5331 are received; this function stores the location of button presses
5332 in order to build drag events when the button is released. */
5335 make_lispy_event (event
)
5336 struct input_event
*event
;
5340 switch (SWITCH_ENUM_CAST (event
->kind
))
5342 /* A simple keystroke. */
5343 case ASCII_KEYSTROKE_EVENT
:
5345 Lisp_Object lispy_c
;
5346 int c
= event
->code
& 0377;
5347 /* Turn ASCII characters into control characters
5349 if (event
->modifiers
& ctrl_modifier
)
5350 c
= make_ctrl_char (c
);
5352 /* Add in the other modifier bits. We took care of ctrl_modifier
5353 just above, and the shift key was taken care of by the X code,
5354 and applied to control characters by make_ctrl_char. */
5355 c
|= (event
->modifiers
5356 & (meta_modifier
| alt_modifier
5357 | hyper_modifier
| super_modifier
));
5358 /* Distinguish Shift-SPC from SPC. */
5359 if ((event
->code
& 0377) == 040
5360 && event
->modifiers
& shift_modifier
)
5361 c
|= shift_modifier
;
5362 button_down_time
= 0;
5363 XSETFASTINT (lispy_c
, c
);
5367 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5369 Lisp_Object lispy_c
;
5370 int c
= event
->code
;
5372 /* Add in the other modifier bits. We took care of ctrl_modifier
5373 just above, and the shift key was taken care of by the X code,
5374 and applied to control characters by make_ctrl_char. */
5375 c
|= (event
->modifiers
5376 & (meta_modifier
| alt_modifier
5377 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5378 /* What about the `shift' modifier ? */
5379 button_down_time
= 0;
5380 XSETFASTINT (lispy_c
, c
);
5384 /* A function key. The symbol may need to have modifier prefixes
5386 case NON_ASCII_KEYSTROKE_EVENT
:
5387 button_down_time
= 0;
5389 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5390 if (event
->code
== lispy_accent_codes
[i
])
5391 return modify_event_symbol (i
,
5393 Qfunction_key
, Qnil
,
5394 lispy_accent_keys
, &accent_key_syms
,
5395 (sizeof (lispy_accent_keys
)
5396 / sizeof (lispy_accent_keys
[0])));
5400 if (event
->code
>= 0x400 && event
->code
< 0x500)
5401 return modify_event_symbol (event
->code
- 0x400,
5402 event
->modifiers
& ~shift_modifier
,
5403 Qfunction_key
, Qnil
,
5404 lispy_kana_keys
, &func_key_syms
,
5405 (sizeof (lispy_kana_keys
)
5406 / sizeof (lispy_kana_keys
[0])));
5407 #endif /* XK_kana_A */
5410 #ifdef ISO_FUNCTION_KEY_OFFSET
5411 if (event
->code
< FUNCTION_KEY_OFFSET
5412 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5413 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5415 Qfunction_key
, Qnil
,
5416 iso_lispy_function_keys
, &func_key_syms
,
5417 (sizeof (iso_lispy_function_keys
)
5418 / sizeof (iso_lispy_function_keys
[0])));
5421 /* Handle system-specific or unknown keysyms. */
5422 if (event
->code
& (1 << 28)
5423 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5424 || (event
->code
- FUNCTION_KEY_OFFSET
5425 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5426 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5428 /* We need to use an alist rather than a vector as the cache
5429 since we can't make a vector long enuf. */
5430 if (NILP (current_kboard
->system_key_syms
))
5431 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5432 return modify_event_symbol (event
->code
,
5435 current_kboard
->Vsystem_key_alist
,
5436 0, ¤t_kboard
->system_key_syms
,
5440 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5442 Qfunction_key
, Qnil
,
5443 lispy_function_keys
, &func_key_syms
,
5444 (sizeof (lispy_function_keys
)
5445 / sizeof (lispy_function_keys
[0])));
5448 /* A mouse click. Figure out where it is, decide whether it's
5449 a press, click or drag, and build the appropriate structure. */
5450 case MOUSE_CLICK_EVENT
:
5451 #ifndef USE_TOOLKIT_SCROLL_BARS
5452 case SCROLL_BAR_CLICK_EVENT
:
5455 int button
= event
->code
;
5457 Lisp_Object position
;
5458 Lisp_Object
*start_pos_ptr
;
5459 Lisp_Object start_pos
;
5463 /* Build the position as appropriate for this mouse click. */
5464 if (event
->kind
== MOUSE_CLICK_EVENT
)
5466 struct frame
*f
= XFRAME (event
->frame_or_window
);
5467 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5471 /* Ignore mouse events that were made on frame that
5472 have been deleted. */
5473 if (! FRAME_LIVE_P (f
))
5476 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5477 /* EVENT->x and EVENT->y are frame-relative pixel
5478 coordinates at this place. Under old redisplay, COLUMN
5479 and ROW are set to frame relative glyph coordinates
5480 which are then used to determine whether this click is
5481 in a menu (non-toolkit version). */
5482 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5483 &column
, &row
, NULL
, 1);
5485 /* In the non-toolkit version, clicks on the menu bar
5486 are ordinary button events in the event buffer.
5487 Distinguish them, and invoke the menu.
5489 (In the toolkit version, the toolkit handles the menu bar
5490 and Emacs doesn't know about it until after the user
5491 makes a selection.) */
5492 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5493 && (event
->modifiers
& down_modifier
))
5495 Lisp_Object items
, item
;
5500 /* Activate the menu bar on the down event. If the
5501 up event comes in before the menu code can deal with it,
5503 if (! (event
->modifiers
& down_modifier
))
5507 /* Find the menu bar item under `column'. */
5509 items
= FRAME_MENU_BAR_ITEMS (f
);
5510 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5512 Lisp_Object pos
, string
;
5513 string
= AREF (items
, i
+ 1);
5514 pos
= AREF (items
, i
+ 3);
5517 if (column
>= XINT (pos
)
5518 && column
< XINT (pos
) + SCHARS (string
))
5520 item
= AREF (items
, i
);
5525 /* ELisp manual 2.4b says (x y) are window relative but
5526 code says they are frame-relative. */
5528 = Fcons (event
->frame_or_window
,
5530 Fcons (Fcons (event
->x
, event
->y
),
5531 Fcons (make_number (event
->timestamp
),
5534 return Fcons (item
, Fcons (position
, Qnil
));
5536 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5538 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5541 #ifndef USE_TOOLKIT_SCROLL_BARS
5544 /* It's a scrollbar click. */
5546 Lisp_Object portion_whole
;
5549 window
= event
->frame_or_window
;
5550 portion_whole
= Fcons (event
->x
, event
->y
);
5551 part
= *scroll_bar_parts
[(int) event
->part
];
5555 Fcons (Qvertical_scroll_bar
,
5556 Fcons (portion_whole
,
5557 Fcons (make_number (event
->timestamp
),
5558 Fcons (part
, Qnil
)))));
5560 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5562 if (button
>= ASIZE (button_down_location
))
5564 button_down_location
= larger_vector (button_down_location
,
5566 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5569 start_pos_ptr
= &AREF (button_down_location
, button
);
5570 start_pos
= *start_pos_ptr
;
5571 *start_pos_ptr
= Qnil
;
5574 /* On window-system frames, use the value of
5575 double-click-fuzz as is. On other frames, interpret it
5576 as a multiple of 1/8 characters. */
5580 if (WINDOWP (event
->frame_or_window
))
5581 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5582 else if (FRAMEP (event
->frame_or_window
))
5583 f
= XFRAME (event
->frame_or_window
);
5587 if (FRAME_WINDOW_P (f
))
5588 fuzz
= double_click_fuzz
;
5590 fuzz
= double_click_fuzz
/ 8;
5592 is_double
= (button
== last_mouse_button
5593 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5594 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5595 && button_down_time
!= 0
5596 && (EQ (Vdouble_click_time
, Qt
)
5597 || (INTEGERP (Vdouble_click_time
)
5598 && ((int)(event
->timestamp
- button_down_time
)
5599 < XINT (Vdouble_click_time
)))));
5602 last_mouse_button
= button
;
5603 last_mouse_x
= XINT (event
->x
);
5604 last_mouse_y
= XINT (event
->y
);
5606 /* If this is a button press, squirrel away the location, so
5607 we can decide later whether it was a click or a drag. */
5608 if (event
->modifiers
& down_modifier
)
5612 double_click_count
++;
5613 event
->modifiers
|= ((double_click_count
> 2)
5618 double_click_count
= 1;
5619 button_down_time
= event
->timestamp
;
5620 *start_pos_ptr
= Fcopy_alist (position
);
5621 ignore_mouse_drag_p
= 0;
5624 /* Now we're releasing a button - check the co-ordinates to
5625 see if this was a click or a drag. */
5626 else if (event
->modifiers
& up_modifier
)
5628 /* If we did not see a down before this up, ignore the up.
5629 Probably this happened because the down event chose a
5630 menu item. It would be an annoyance to treat the
5631 release of the button that chose the menu item as a
5634 if (!CONSP (start_pos
))
5637 event
->modifiers
&= ~up_modifier
;
5638 #if 0 /* Formerly we treated an up with no down as a click event. */
5639 if (!CONSP (start_pos
))
5640 event
->modifiers
|= click_modifier
;
5645 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5647 /* The third element of every position
5648 should be the (x,y) pair. */
5649 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5651 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5653 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5654 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5657 if (ignore_mouse_drag_p
)
5659 event
->modifiers
|= click_modifier
;
5660 ignore_mouse_drag_p
= 0;
5662 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5663 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5664 /* Maybe the mouse has moved a lot, caused scrolling, and
5665 eventually ended up at the same screen position (but
5666 not buffer position) in which case it is a drag, not
5668 /* FIXME: OTOH if the buffer position has changed
5669 because of a timer or process filter rather than
5670 because of mouse movement, it should be considered as
5671 a click. But mouse-drag-region completely ignores
5672 this case and it hasn't caused any real problem, so
5673 it's probably OK to ignore it as well. */
5674 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5675 /* Mouse hasn't moved (much). */
5676 event
->modifiers
|= click_modifier
;
5679 button_down_time
= 0;
5680 event
->modifiers
|= drag_modifier
;
5683 /* Don't check is_double; treat this as multiple
5684 if the down-event was multiple. */
5685 if (double_click_count
> 1)
5686 event
->modifiers
|= ((double_click_count
> 2)
5692 /* Every mouse event should either have the down_modifier or
5693 the up_modifier set. */
5697 /* Get the symbol we should use for the mouse click. */
5700 head
= modify_event_symbol (button
,
5702 Qmouse_click
, Vlispy_mouse_stem
,
5705 XVECTOR (mouse_syms
)->size
);
5706 if (event
->modifiers
& drag_modifier
)
5711 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5714 Fcons (make_number (double_click_count
),
5725 Lisp_Object position
;
5728 /* Build the position as appropriate for this mouse click. */
5729 struct frame
*f
= XFRAME (event
->frame_or_window
);
5731 /* Ignore wheel events that were made on frame that have been
5733 if (! FRAME_LIVE_P (f
))
5736 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5739 /* Set double or triple modifiers to indicate the wheel speed. */
5741 /* On window-system frames, use the value of
5742 double-click-fuzz as is. On other frames, interpret it
5743 as a multiple of 1/8 characters. */
5748 if (WINDOWP (event
->frame_or_window
))
5749 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5750 else if (FRAMEP (event
->frame_or_window
))
5751 f
= XFRAME (event
->frame_or_window
);
5755 if (FRAME_WINDOW_P (f
))
5756 fuzz
= double_click_fuzz
;
5758 fuzz
= double_click_fuzz
/ 8;
5760 is_double
= (last_mouse_button
< 0
5761 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5762 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5763 && button_down_time
!= 0
5764 && (EQ (Vdouble_click_time
, Qt
)
5765 || (INTEGERP (Vdouble_click_time
)
5766 && ((int)(event
->timestamp
- button_down_time
)
5767 < XINT (Vdouble_click_time
)))));
5770 double_click_count
++;
5771 event
->modifiers
|= ((double_click_count
> 2)
5777 double_click_count
= 1;
5778 event
->modifiers
|= click_modifier
;
5781 button_down_time
= event
->timestamp
;
5782 /* Use a negative value to distinguish wheel from mouse button. */
5783 last_mouse_button
= -1;
5784 last_mouse_x
= XINT (event
->x
);
5785 last_mouse_y
= XINT (event
->y
);
5791 if (event
->modifiers
& up_modifier
)
5793 /* Emit a wheel-up event. */
5794 event
->modifiers
&= ~up_modifier
;
5797 else if (event
->modifiers
& down_modifier
)
5799 /* Emit a wheel-down event. */
5800 event
->modifiers
&= ~down_modifier
;
5804 /* Every wheel event should either have the down_modifier or
5805 the up_modifier set. */
5808 /* Get the symbol we should use for the wheel event. */
5809 head
= modify_event_symbol (symbol_num
,
5815 ASIZE (wheel_syms
));
5818 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5821 Fcons (make_number (double_click_count
),
5830 #ifdef USE_TOOLKIT_SCROLL_BARS
5832 /* We don't have down and up events if using toolkit scroll bars,
5833 so make this always a click event. Store in the `part' of
5834 the Lisp event a symbol which maps to the following actions:
5836 `above_handle' page up
5837 `below_handle' page down
5841 `bottom' bottom of buffer
5842 `handle' thumb has been dragged.
5843 `end-scroll' end of interaction with scroll bar
5845 The incoming input_event contains in its `part' member an
5846 index of type `enum scroll_bar_part' which we can use as an
5847 index in scroll_bar_parts to get the appropriate symbol. */
5849 case SCROLL_BAR_CLICK_EVENT
:
5851 Lisp_Object position
, head
, window
, portion_whole
, part
;
5853 window
= event
->frame_or_window
;
5854 portion_whole
= Fcons (event
->x
, event
->y
);
5855 part
= *scroll_bar_parts
[(int) event
->part
];
5859 Fcons (Qvertical_scroll_bar
,
5860 Fcons (portion_whole
,
5861 Fcons (make_number (event
->timestamp
),
5862 Fcons (part
, Qnil
)))));
5864 /* Always treat scroll bar events as clicks. */
5865 event
->modifiers
|= click_modifier
;
5866 event
->modifiers
&= ~up_modifier
;
5868 if (event
->code
>= ASIZE (mouse_syms
))
5869 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5871 /* Get the symbol we should use for the mouse click. */
5872 head
= modify_event_symbol (event
->code
,
5877 XVECTOR (mouse_syms
)->size
);
5878 return Fcons (head
, Fcons (position
, Qnil
));
5881 #endif /* USE_TOOLKIT_SCROLL_BARS */
5884 case W32_SCROLL_BAR_CLICK_EVENT
:
5886 int button
= event
->code
;
5888 Lisp_Object position
;
5889 Lisp_Object
*start_pos_ptr
;
5890 Lisp_Object start_pos
;
5894 Lisp_Object portion_whole
;
5897 window
= event
->frame_or_window
;
5898 portion_whole
= Fcons (event
->x
, event
->y
);
5899 part
= *scroll_bar_parts
[(int) event
->part
];
5903 Fcons (Qvertical_scroll_bar
,
5904 Fcons (portion_whole
,
5905 Fcons (make_number (event
->timestamp
),
5906 Fcons (part
, Qnil
)))));
5909 /* Always treat W32 scroll bar events as clicks. */
5910 event
->modifiers
|= click_modifier
;
5913 /* Get the symbol we should use for the mouse click. */
5916 head
= modify_event_symbol (button
,
5921 XVECTOR (mouse_syms
)->size
);
5927 #endif /* WINDOWSNT */
5929 case DRAG_N_DROP_EVENT
:
5932 Lisp_Object head
, position
;
5935 f
= XFRAME (event
->frame_or_window
);
5938 /* Ignore mouse events that were made on frames that
5939 have been deleted. */
5940 if (! FRAME_LIVE_P (f
))
5943 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5946 head
= modify_event_symbol (0, event
->modifiers
,
5948 lispy_drag_n_drop_names
,
5949 &drag_n_drop_syms
, 1);
5955 #endif /* HAVE_MOUSE */
5957 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5958 || defined (USE_GTK)
5959 case MENU_BAR_EVENT
:
5960 if (EQ (event
->arg
, event
->frame_or_window
))
5961 /* This is the prefix key. We translate this to
5962 `(menu_bar)' because the code in keyboard.c for menu
5963 events, which we use, relies on this. */
5964 return Fcons (Qmenu_bar
, Qnil
);
5968 case SELECT_WINDOW_EVENT
:
5969 /* Make an event (select-window (WINDOW)). */
5970 return Fcons (Qselect_window
,
5971 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5974 case TOOL_BAR_EVENT
:
5975 if (EQ (event
->arg
, event
->frame_or_window
))
5976 /* This is the prefix key. We translate this to
5977 `(tool_bar)' because the code in keyboard.c for tool bar
5978 events, which we use, relies on this. */
5979 return Fcons (Qtool_bar
, Qnil
);
5980 else if (SYMBOLP (event
->arg
))
5981 return apply_modifiers (event
->modifiers
, event
->arg
);
5984 case USER_SIGNAL_EVENT
:
5985 /* A user signal. */
5987 char *name
= find_user_signal_name (event
->code
);
5990 return intern (name
);
5993 case SAVE_SESSION_EVENT
:
5994 return Qsave_session
;
5997 case MAC_APPLE_EVENT
:
5999 Lisp_Object spec
[2];
6003 return Fcons (Qmac_apple_event
,
6004 Fcons (Fvector (2, spec
),
6005 Fcons (event
->arg
, Qnil
)));
6009 /* The 'kind' field of the event is something we don't recognize. */
6018 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6020 Lisp_Object bar_window
;
6021 enum scroll_bar_part part
;
6025 /* Is it a scroll bar movement? */
6026 if (frame
&& ! NILP (bar_window
))
6028 Lisp_Object part_sym
;
6030 part_sym
= *scroll_bar_parts
[(int) part
];
6031 return Fcons (Qscroll_bar_movement
,
6032 (Fcons (Fcons (bar_window
,
6033 Fcons (Qvertical_scroll_bar
,
6034 Fcons (Fcons (x
, y
),
6035 Fcons (make_number (time
),
6041 /* Or is it an ordinary mouse movement? */
6044 Lisp_Object position
;
6046 position
= make_lispy_position (frame
, &x
, &y
, time
);
6048 return Fcons (Qmouse_movement
,
6054 #endif /* HAVE_MOUSE */
6056 /* Construct a switch frame event. */
6058 make_lispy_switch_frame (frame
)
6061 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6064 /* Manipulating modifiers. */
6066 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6068 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6069 SYMBOL's name of the end of the modifiers; the string from this
6070 position is the unmodified symbol name.
6072 This doesn't use any caches. */
6075 parse_modifiers_uncached (symbol
, modifier_end
)
6083 CHECK_SYMBOL (symbol
);
6086 name
= SYMBOL_NAME (symbol
);
6088 for (i
= 0; i
+2 <= SBYTES (name
); )
6090 int this_mod_end
= 0;
6093 /* See if the name continues with a modifier word.
6094 Check that the word appears, but don't check what follows it.
6095 Set this_mod and this_mod_end to record what we find. */
6097 switch (SREF (name
, i
))
6099 #define SINGLE_LETTER_MOD(BIT) \
6100 (this_mod_end = i + 1, this_mod = BIT)
6103 SINGLE_LETTER_MOD (alt_modifier
);
6107 SINGLE_LETTER_MOD (ctrl_modifier
);
6111 SINGLE_LETTER_MOD (hyper_modifier
);
6115 SINGLE_LETTER_MOD (meta_modifier
);
6119 SINGLE_LETTER_MOD (shift_modifier
);
6123 SINGLE_LETTER_MOD (super_modifier
);
6126 #undef SINGLE_LETTER_MOD
6128 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6129 if (i + LEN + 1 <= SBYTES (name) \
6130 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6132 this_mod_end = i + LEN; \
6137 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6138 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6139 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6143 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6145 #undef MULTI_LETTER_MOD
6149 /* If we found no modifier, stop looking for them. */
6150 if (this_mod_end
== 0)
6153 /* Check there is a dash after the modifier, so that it
6154 really is a modifier. */
6155 if (this_mod_end
>= SBYTES (name
)
6156 || SREF (name
, this_mod_end
) != '-')
6159 /* This modifier is real; look for another. */
6160 modifiers
|= this_mod
;
6161 i
= this_mod_end
+ 1;
6164 /* Should we include the `click' modifier? */
6165 if (! (modifiers
& (down_modifier
| drag_modifier
6166 | double_modifier
| triple_modifier
))
6167 && i
+ 7 == SBYTES (name
)
6168 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6169 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6170 modifiers
|= click_modifier
;
6178 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6179 prepended to the string BASE[0..BASE_LEN-1].
6180 This doesn't use any caches. */
6182 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6185 int base_len
, base_len_byte
;
6187 /* Since BASE could contain nulls, we can't use intern here; we have
6188 to use Fintern, which expects a genuine Lisp_String, and keeps a
6191 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6197 /* Only the event queue may use the `up' modifier; it should always
6198 be turned into a click or drag event before presented to lisp code. */
6199 if (modifiers
& up_modifier
)
6202 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6203 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6204 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6205 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6206 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6207 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6208 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6209 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6210 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6211 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6212 /* The click modifier is denoted by the absence of other modifiers. */
6216 mod_len
= p
- new_mods
;
6220 Lisp_Object new_name
;
6222 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6223 mod_len
+ base_len_byte
);
6224 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6225 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6227 return Fintern (new_name
, Qnil
);
6232 static char *modifier_names
[] =
6234 "up", "down", "drag", "click", "double", "triple", 0, 0,
6235 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6236 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6238 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6240 static Lisp_Object modifier_symbols
;
6242 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6244 lispy_modifier_list (modifiers
)
6247 Lisp_Object modifier_list
;
6250 modifier_list
= Qnil
;
6251 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6252 if (modifiers
& (1<<i
))
6253 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6256 return modifier_list
;
6260 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6261 where UNMODIFIED is the unmodified form of SYMBOL,
6262 MASK is the set of modifiers present in SYMBOL's name.
6263 This is similar to parse_modifiers_uncached, but uses the cache in
6264 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6265 Qevent_symbol_elements property. */
6268 parse_modifiers (symbol
)
6271 Lisp_Object elements
;
6273 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6274 if (CONSP (elements
))
6279 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6280 Lisp_Object unmodified
;
6283 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6284 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6287 if (modifiers
& ~INTMASK
)
6289 XSETFASTINT (mask
, modifiers
);
6290 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6292 /* Cache the parsing results on SYMBOL. */
6293 Fput (symbol
, Qevent_symbol_element_mask
,
6295 Fput (symbol
, Qevent_symbol_elements
,
6296 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6298 /* Since we know that SYMBOL is modifiers applied to unmodified,
6299 it would be nice to put that in unmodified's cache.
6300 But we can't, since we're not sure that parse_modifiers is
6307 /* Apply the modifiers MODIFIERS to the symbol BASE.
6308 BASE must be unmodified.
6310 This is like apply_modifiers_uncached, but uses BASE's
6311 Qmodifier_cache property, if present. It also builds
6312 Qevent_symbol_elements properties, since it has that info anyway.
6314 apply_modifiers copies the value of BASE's Qevent_kind property to
6315 the modified symbol. */
6317 apply_modifiers (modifiers
, base
)
6321 Lisp_Object cache
, index
, entry
, new_symbol
;
6323 /* Mask out upper bits. We don't know where this value's been. */
6324 modifiers
&= INTMASK
;
6326 /* The click modifier never figures into cache indices. */
6327 cache
= Fget (base
, Qmodifier_cache
);
6328 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6329 entry
= assq_no_quit (index
, cache
);
6332 new_symbol
= XCDR (entry
);
6335 /* We have to create the symbol ourselves. */
6336 new_symbol
= apply_modifiers_uncached (modifiers
,
6337 SDATA (SYMBOL_NAME (base
)),
6338 SCHARS (SYMBOL_NAME (base
)),
6339 SBYTES (SYMBOL_NAME (base
)));
6341 /* Add the new symbol to the base's cache. */
6342 entry
= Fcons (index
, new_symbol
);
6343 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6345 /* We have the parsing info now for free, so we could add it to
6347 XSETFASTINT (index, modifiers);
6348 Fput (new_symbol, Qevent_symbol_element_mask,
6349 Fcons (base, Fcons (index, Qnil)));
6350 Fput (new_symbol, Qevent_symbol_elements,
6351 Fcons (base, lispy_modifier_list (modifiers)));
6352 Sadly, this is only correct if `base' is indeed a base event,
6353 which is not necessarily the case. -stef */
6356 /* Make sure this symbol is of the same kind as BASE.
6358 You'd think we could just set this once and for all when we
6359 intern the symbol above, but reorder_modifiers may call us when
6360 BASE's property isn't set right; we can't assume that just
6361 because it has a Qmodifier_cache property it must have its
6362 Qevent_kind set right as well. */
6363 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6367 kind
= Fget (base
, Qevent_kind
);
6369 Fput (new_symbol
, Qevent_kind
, kind
);
6376 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6377 return a symbol with the modifiers placed in the canonical order.
6378 Canonical order is alphabetical, except for down and drag, which
6379 always come last. The 'click' modifier is never written out.
6381 Fdefine_key calls this to make sure that (for example) C-M-foo
6382 and M-C-foo end up being equivalent in the keymap. */
6385 reorder_modifiers (symbol
)
6388 /* It's hopefully okay to write the code this way, since everything
6389 will soon be in caches, and no consing will be done at all. */
6392 parsed
= parse_modifiers (symbol
);
6393 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6398 /* For handling events, we often want to produce a symbol whose name
6399 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6400 to some base, like the name of a function key or mouse button.
6401 modify_event_symbol produces symbols of this sort.
6403 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6404 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6407 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6408 into symbol names, or a string specifying a name stem used to
6409 construct a symbol name or the form `STEM-N', where N is the decimal
6410 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6411 non-nil; otherwise NAME_TABLE is used.
6413 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6414 persist between calls to modify_event_symbol that it can use to
6415 store a cache of the symbols it's generated for this NAME_TABLE
6416 before. The object stored there may be a vector or an alist.
6418 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6420 MODIFIERS is a set of modifier bits (as given in struct input_events)
6421 whose prefixes should be applied to the symbol name.
6423 SYMBOL_KIND is the value to be placed in the event_kind property of
6424 the returned symbol.
6426 The symbols we create are supposed to have an
6427 `event-symbol-elements' property, which lists the modifiers present
6428 in the symbol's name. */
6431 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6432 name_table
, symbol_table
, table_size
)
6435 Lisp_Object symbol_kind
;
6436 Lisp_Object name_alist_or_stem
;
6438 Lisp_Object
*symbol_table
;
6439 unsigned int table_size
;
6442 Lisp_Object symbol_int
;
6444 /* Get rid of the "vendor-specific" bit here. */
6445 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6447 /* Is this a request for a valid symbol? */
6448 if (symbol_num
< 0 || symbol_num
>= table_size
)
6451 if (CONSP (*symbol_table
))
6452 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6454 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6455 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6456 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6457 we've never used that symbol before. */
6460 if (! VECTORP (*symbol_table
)
6461 || XVECTOR (*symbol_table
)->size
!= table_size
)
6465 XSETFASTINT (size
, table_size
);
6466 *symbol_table
= Fmake_vector (size
, Qnil
);
6469 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6472 /* Have we already used this symbol before? */
6475 /* No; let's create it. */
6476 if (CONSP (name_alist_or_stem
))
6477 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6478 else if (STRINGP (name_alist_or_stem
))
6480 int len
= SBYTES (name_alist_or_stem
);
6481 char *buf
= (char *) alloca (len
+ 50);
6482 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6483 (long) XINT (symbol_int
) + 1);
6484 value
= intern (buf
);
6486 else if (name_table
!= 0 && name_table
[symbol_num
])
6487 value
= intern (name_table
[symbol_num
]);
6489 #ifdef HAVE_WINDOW_SYSTEM
6492 char *name
= x_get_keysym_name (symbol_num
);
6494 value
= intern (name
);
6501 sprintf (buf
, "key-%d", symbol_num
);
6502 value
= intern (buf
);
6505 if (CONSP (*symbol_table
))
6506 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6508 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6510 /* Fill in the cache entries for this symbol; this also
6511 builds the Qevent_symbol_elements property, which the user
6513 apply_modifiers (modifiers
& click_modifier
, value
);
6514 Fput (value
, Qevent_kind
, symbol_kind
);
6517 /* Apply modifiers to that symbol. */
6518 return apply_modifiers (modifiers
, value
);
6521 /* Convert a list that represents an event type,
6522 such as (ctrl meta backspace), into the usual representation of that
6523 event type as a number or a symbol. */
6525 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6526 doc
: /* Convert the event description list EVENT-DESC to an event type.
6527 EVENT-DESC should contain one base event type (a character or symbol)
6528 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6529 drag, down, double or triple). The base must be last.
6530 The return value is an event type (a character or symbol) which
6531 has the same base event type and all the specified modifiers. */)
6533 Lisp_Object event_desc
;
6541 while (CONSP (rest
))
6549 /* Given a symbol, see if it is a modifier name. */
6550 if (SYMBOLP (elt
) && CONSP (rest
))
6551 this = parse_solitary_modifier (elt
);
6555 else if (!NILP (base
))
6556 error ("Two bases given in one event");
6562 /* Let the symbol A refer to the character A. */
6563 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6564 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6566 if (INTEGERP (base
))
6568 /* Turn (shift a) into A. */
6569 if ((modifiers
& shift_modifier
) != 0
6570 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6572 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6573 modifiers
&= ~shift_modifier
;
6576 /* Turn (control a) into C-a. */
6577 if (modifiers
& ctrl_modifier
)
6578 return make_number ((modifiers
& ~ctrl_modifier
)
6579 | make_ctrl_char (XINT (base
)));
6581 return make_number (modifiers
| XINT (base
));
6583 else if (SYMBOLP (base
))
6584 return apply_modifiers (modifiers
, base
);
6587 error ("Invalid base event");
6592 /* Try to recognize SYMBOL as a modifier name.
6593 Return the modifier flag bit, or 0 if not recognized. */
6596 parse_solitary_modifier (symbol
)
6599 Lisp_Object name
= SYMBOL_NAME (symbol
);
6601 switch (SREF (name
, 0))
6603 #define SINGLE_LETTER_MOD(BIT) \
6604 if (SBYTES (name) == 1) \
6607 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6608 if (LEN == SBYTES (name) \
6609 && ! strncmp (SDATA (name), NAME, LEN)) \
6613 SINGLE_LETTER_MOD (alt_modifier
);
6617 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6621 SINGLE_LETTER_MOD (ctrl_modifier
);
6625 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6626 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6630 SINGLE_LETTER_MOD (hyper_modifier
);
6634 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6638 SINGLE_LETTER_MOD (meta_modifier
);
6642 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6646 SINGLE_LETTER_MOD (shift_modifier
);
6650 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6651 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6652 SINGLE_LETTER_MOD (super_modifier
);
6656 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6657 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6658 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6662 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6665 #undef SINGLE_LETTER_MOD
6666 #undef MULTI_LETTER_MOD
6672 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6673 Such a list is not valid as an event,
6674 but it can be a Lucid-style event type list. */
6677 lucid_event_type_list_p (object
)
6682 if (! CONSP (object
))
6685 if (EQ (XCAR (object
), Qhelp_echo
)
6686 || EQ (XCAR (object
), Qvertical_line
)
6687 || EQ (XCAR (object
), Qmode_line
)
6688 || EQ (XCAR (object
), Qheader_line
))
6691 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6695 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6702 /* Store into *addr a value nonzero if terminal input chars are available.
6703 Serves the purpose of ioctl (0, FIONREAD, addr)
6704 but works even if FIONREAD does not exist.
6705 (In fact, this may actually read some input.)
6707 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6708 timer events that are ripe.
6709 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6710 events (FOCUS_IN_EVENT).
6711 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6712 movements and toolkit scroll bar thumb drags. */
6715 get_input_pending (addr
, flags
)
6719 /* First of all, have we already counted some input? */
6720 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6722 /* If input is being read as it arrives, and we have none, there is none. */
6723 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6726 /* Try to read some input and see how much we get. */
6728 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6731 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6734 gobble_input (expected
)
6739 if (interrupt_input
)
6742 mask
= sigblock (sigmask (SIGIO
));
6743 read_avail_input (expected
);
6747 #ifdef POLL_FOR_INPUT
6748 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6751 mask
= sigblock (sigmask (SIGALRM
));
6752 read_avail_input (expected
);
6758 read_avail_input (expected
);
6762 /* Put a BUFFER_SWITCH_EVENT in the buffer
6763 so that read_key_sequence will notice the new current buffer. */
6766 record_asynch_buffer_change ()
6768 struct input_event event
;
6772 event
.kind
= BUFFER_SWITCH_EVENT
;
6773 event
.frame_or_window
= Qnil
;
6777 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6778 The purpose of the event is to make read_key_sequence look up the
6779 keymaps again. If we aren't in read_key_sequence, we don't need one,
6780 and the event could cause trouble by messing up (input-pending-p). */
6781 tem
= Fwaiting_for_user_input_p ();
6785 /* We never need these events if we have no asynchronous subprocesses. */
6789 /* Make sure no interrupt happens while storing the event. */
6791 if (interrupt_input
)
6794 mask
= sigblock (sigmask (SIGIO
));
6795 kbd_buffer_store_event (&event
);
6802 kbd_buffer_store_event (&event
);
6809 /* Read any terminal input already buffered up by the system
6810 into the kbd_buffer, but do not wait.
6812 EXPECTED should be nonzero if the caller knows there is some input.
6814 Except on VMS, all input is read by this function.
6815 If interrupt_input is nonzero, this function MUST be called
6816 only when SIGIO is blocked.
6818 Returns the number of keyboard chars read, or -1 meaning
6819 this is a bad time to try to read input. */
6822 read_avail_input (expected
)
6828 /* Store pending user signal events, if any. */
6829 if (store_user_signal_events ())
6832 if (read_socket_hook
)
6835 struct input_event hold_quit
;
6837 EVENT_INIT (hold_quit
);
6838 hold_quit
.kind
= NO_EVENT
;
6840 /* No need for FIONREAD or fcntl; just say don't wait. */
6841 while (nr
= (*read_socket_hook
) (input_fd
, expected
, &hold_quit
), nr
> 0)
6846 if (hold_quit
.kind
!= NO_EVENT
)
6847 kbd_buffer_store_event (&hold_quit
);
6851 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6852 the kbd_buffer can really hold. That may prevent loss
6853 of characters on some systems when input is stuffed at us. */
6854 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6857 /* Determine how many characters we should *try* to read. */
6860 #else /* not WINDOWSNT */
6862 n_to_read
= dos_keysns ();
6865 #else /* not MSDOS */
6867 /* Find out how much input is available. */
6868 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6869 /* Formerly simply reported no input, but that sometimes led to
6870 a failure of Emacs to terminate.
6871 SIGHUP seems appropriate if we can't reach the terminal. */
6872 /* ??? Is it really right to send the signal just to this process
6873 rather than to the whole process group?
6874 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6876 if (! noninteractive
)
6877 kill (getpid (), SIGHUP
);
6883 if (n_to_read
> sizeof cbuf
)
6884 n_to_read
= sizeof cbuf
;
6885 #else /* no FIONREAD */
6886 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6887 /* Read some input if available, but don't wait. */
6888 n_to_read
= sizeof cbuf
;
6889 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6894 #endif /* not MSDOS */
6895 #endif /* not WINDOWSNT */
6897 /* Now read; for one reason or another, this will not block.
6898 NREAD is set to the number of chars read. */
6902 cbuf
[0] = dos_keyread ();
6905 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6907 /* POSIX infers that processes which are not in the session leader's
6908 process group won't get SIGHUP's at logout time. BSDI adheres to
6909 this part standard and returns -1 from read (0) with errno==EIO
6910 when the control tty is taken away.
6911 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6912 if (nread
== -1 && errno
== EIO
)
6914 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6915 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6916 This looks incorrect, but it isn't, because _BSD causes
6917 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6918 and that causes a value other than 0 when there is no input. */
6924 /* We used to retry the read if it was interrupted.
6925 But this does the wrong thing when O_NDELAY causes
6926 an EAGAIN error. Does anybody know of a situation
6927 where a retry is actually needed? */
6929 nread
< 0 && (errno
== EAGAIN
6943 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6944 fcntl (input_fd
, F_SETFL
, 0);
6945 #endif /* USG or DGUX or CYGWIN */
6946 #endif /* no FIONREAD */
6947 for (i
= 0; i
< nread
; i
++)
6949 struct input_event buf
;
6951 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6953 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6954 buf
.modifiers
= meta_modifier
;
6959 buf
.frame_or_window
= selected_frame
;
6962 kbd_buffer_store_event (&buf
);
6963 /* Don't look at input that follows a C-g too closely.
6964 This reduces lossage due to autorepeat on C-g. */
6965 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6966 && buf
.code
== quit_char
)
6973 #endif /* not VMS */
6976 handle_async_input ()
6979 extern int select_alarmed
;
6982 interrupt_input_pending
= 0;
6987 nread
= read_avail_input (1);
6988 /* -1 means it's not ok to read the input now.
6989 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6990 0 means there was no keyboard input available. */
6995 select_alarmed
= 1; /* Force the select emulator back to life */
7000 #ifdef SIGIO /* for entire page */
7001 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7004 input_available_signal (signo
)
7007 /* Must preserve main program's value of errno. */
7008 int old_errno
= errno
;
7009 #if defined (USG) && !defined (POSIX_SIGNALS)
7010 /* USG systems forget handlers when they are used;
7011 must reestablish each time */
7012 signal (signo
, input_available_signal
);
7020 interrupt_input_pending
= 1;
7022 SIGNAL_THREAD_CHECK (signo
);
7025 if (input_available_clear_time
)
7026 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7029 handle_async_input ();
7039 /* Send ourselves a SIGIO.
7041 This function exists so that the UNBLOCK_INPUT macro in
7042 blockinput.h can have some way to take care of input we put off
7043 dealing with, without assuming that every file which uses
7044 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7046 reinvoke_input_signal ()
7049 handle_async_input ();
7055 /* User signal events. */
7057 struct user_signal_info
7059 /* Signal number. */
7062 /* Name of the signal. */
7065 /* Number of pending signals. */
7068 struct user_signal_info
*next
;
7071 /* List of user signals. */
7072 static struct user_signal_info
*user_signals
= NULL
;
7075 add_user_signal (sig
, name
)
7079 struct user_signal_info
*p
;
7081 for (p
= user_signals
; p
; p
= p
->next
)
7083 /* Already added. */
7086 p
= xmalloc (sizeof (struct user_signal_info
));
7088 p
->name
= xstrdup (name
);
7090 p
->next
= user_signals
;
7093 signal (sig
, handle_user_signal
);
7097 handle_user_signal (sig
)
7100 int old_errno
= errno
;
7101 struct user_signal_info
*p
;
7103 #if defined (USG) && !defined (POSIX_SIGNALS)
7104 /* USG systems forget handlers when they are used;
7105 must reestablish each time */
7106 signal (sig
, handle_user_signal
);
7109 SIGNAL_THREAD_CHECK (sig
);
7111 for (p
= user_signals
; p
; p
= p
->next
)
7116 if (interrupt_input
)
7117 kill (getpid (), SIGIO
);
7121 /* Tell wait_reading_process_output that it needs to wake
7122 up and look around. */
7123 if (input_available_clear_time
)
7124 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7133 find_user_signal_name (sig
)
7136 struct user_signal_info
*p
;
7138 for (p
= user_signals
; p
; p
= p
->next
)
7146 store_user_signal_events ()
7148 struct user_signal_info
*p
;
7149 struct input_event buf
;
7152 for (p
= user_signals
; p
; p
= p
->next
)
7153 if (p
->npending
> 0)
7159 bzero (&buf
, sizeof buf
);
7160 buf
.kind
= USER_SIGNAL_EVENT
;
7161 buf
.frame_or_window
= selected_frame
;
7163 nstored
+= p
->npending
;
7165 mask
= sigblock (sigmask (p
->sig
));
7169 kbd_buffer_store_event (&buf
);
7172 while (p
->npending
> 0);
7180 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7181 static Lisp_Object menu_bar_one_keymap_changed_items
;
7183 /* These variables hold the vector under construction within
7184 menu_bar_items and its subroutines, and the current index
7185 for storing into that vector. */
7186 static Lisp_Object menu_bar_items_vector
;
7187 static int menu_bar_items_index
;
7189 /* Return a vector of menu items for a menu bar, appropriate
7190 to the current buffer. Each item has three elements in the vector:
7193 OLD is an old vector we can optionally reuse, or nil. */
7196 menu_bar_items (old
)
7199 /* The number of keymaps we're scanning right now, and the number of
7200 keymaps we have allocated space for. */
7203 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7204 in the current keymaps, or nil where it is not a prefix. */
7207 Lisp_Object def
, tail
;
7216 /* In order to build the menus, we need to call the keymap
7217 accessors. They all call QUIT. But this function is called
7218 during redisplay, during which a quit is fatal. So inhibit
7219 quitting while building the menus.
7220 We do this instead of specbind because (1) errors will clear it anyway
7221 and (2) this avoids risk of specpdl overflow. */
7222 oquit
= Vinhibit_quit
;
7226 menu_bar_items_vector
= old
;
7228 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7229 menu_bar_items_index
= 0;
7231 /* Build our list of keymaps.
7232 If we recognize a function key and replace its escape sequence in
7233 keybuf with its symbol, or if the sequence starts with a mouse
7234 click and we need to switch buffers, we jump back here to rebuild
7235 the initial keymaps from the current buffer. */
7239 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7240 if (!NILP (Voverriding_local_map_menu_flag
))
7242 /* Yes, use them (if non-nil) as well as the global map. */
7243 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7245 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7246 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7247 if (!NILP (Voverriding_local_map
))
7248 maps
[nmaps
++] = Voverriding_local_map
;
7252 /* No, so use major and minor mode keymaps and keymap property.
7253 Note that menu-bar bindings in the local-map and keymap
7254 properties may not work reliable, as they are only
7255 recognized when the menu-bar (or mode-line) is updated,
7256 which does not normally happen after every command. */
7259 nminor
= current_minor_maps (NULL
, &tmaps
);
7260 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7262 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7263 maps
[nmaps
++] = tem
;
7264 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7266 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7268 maps
[nmaps
++] = current_global_map
;
7271 /* Look up in each map the dummy prefix key `menu-bar'. */
7275 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7276 if (!NILP (maps
[mapno
]))
7278 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7282 menu_bar_one_keymap_changed_items
= Qnil
;
7283 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7287 /* Move to the end those items that should be at the end. */
7289 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7292 int end
= menu_bar_items_index
;
7294 for (i
= 0; i
< end
; i
+= 4)
7295 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7297 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7298 /* Move the item at index I to the end,
7299 shifting all the others forward. */
7300 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7301 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7302 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7303 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7305 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7306 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7307 (end
- i
- 4) * sizeof (Lisp_Object
));
7308 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7309 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7310 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7311 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7316 /* Add nil, nil, nil, nil at the end. */
7317 i
= menu_bar_items_index
;
7318 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7321 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7322 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7323 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7324 menu_bar_items_vector
= tem
;
7326 /* Add this item. */
7327 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7328 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7329 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7330 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7331 menu_bar_items_index
= i
;
7333 Vinhibit_quit
= oquit
;
7334 return menu_bar_items_vector
;
7337 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7338 If there's already an item for KEY, add this DEF to it. */
7340 Lisp_Object item_properties
;
7343 menu_bar_item (key
, item
, dummy1
, dummy2
)
7344 Lisp_Object key
, item
, dummy1
;
7347 struct gcpro gcpro1
;
7351 if (EQ (item
, Qundefined
))
7353 /* If a map has an explicit `undefined' as definition,
7354 discard any previously made menu bar item. */
7356 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7357 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7359 if (menu_bar_items_index
> i
+ 4)
7360 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7361 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7362 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7363 menu_bar_items_index
-= 4;
7367 /* If this keymap has already contributed to this KEY,
7368 don't contribute to it a second time. */
7369 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7370 if (!NILP (tem
) || NILP (item
))
7373 menu_bar_one_keymap_changed_items
7374 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7376 /* We add to menu_bar_one_keymap_changed_items before doing the
7377 parse_menu_item, so that if it turns out it wasn't a menu item,
7378 it still correctly hides any further menu item. */
7380 i
= parse_menu_item (item
, 0, 1);
7385 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7387 /* Find any existing item for this KEY. */
7388 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7389 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7392 /* If we did not find this KEY, add it at the end. */
7393 if (i
== menu_bar_items_index
)
7395 /* If vector is too small, get a bigger one. */
7396 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7399 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7400 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7401 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7402 menu_bar_items_vector
= tem
;
7405 /* Add this item. */
7406 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7407 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7408 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7409 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7410 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7411 menu_bar_items_index
= i
;
7413 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7417 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7418 /* If the new and the old items are not both keymaps,
7419 the lookup will only find `item'. */
7420 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7421 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7425 /* This is used as the handler when calling menu_item_eval_property. */
7427 menu_item_eval_property_1 (arg
)
7430 /* If we got a quit from within the menu computation,
7431 quit all the way out of it. This takes care of C-] in the debugger. */
7432 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7433 Fsignal (Qquit
, Qnil
);
7438 /* Evaluate an expression and return the result (or nil if something
7439 went wrong). Used to evaluate dynamic parts of menu items. */
7441 menu_item_eval_property (sexpr
)
7444 int count
= SPECPDL_INDEX ();
7446 specbind (Qinhibit_redisplay
, Qt
);
7447 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7448 menu_item_eval_property_1
);
7449 return unbind_to (count
, val
);
7452 /* This function parses a menu item and leaves the result in the
7453 vector item_properties.
7454 ITEM is a key binding, a possible menu item.
7455 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7456 evaluate dynamic expressions in the menu item.
7457 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7459 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7460 parse_menu_item returns true if the item is a menu item and false
7464 parse_menu_item (item
, notreal
, inmenubar
)
7466 int notreal
, inmenubar
;
7468 Lisp_Object def
, tem
, item_string
, start
;
7469 Lisp_Object cachelist
;
7471 Lisp_Object keyhint
;
7482 /* Create item_properties vector if necessary. */
7483 if (NILP (item_properties
))
7485 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7487 /* Initialize optional entries. */
7488 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7489 AREF (item_properties
, i
) = Qnil
;
7490 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7492 /* Save the item here to protect it from GC. */
7493 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7495 item_string
= XCAR (item
);
7499 if (STRINGP (item_string
))
7501 /* Old format menu item. */
7502 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7504 /* Maybe help string. */
7505 if (CONSP (item
) && STRINGP (XCAR (item
)))
7507 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7512 /* Maybe key binding cache. */
7513 if (CONSP (item
) && CONSP (XCAR (item
))
7514 && (NILP (XCAR (XCAR (item
)))
7515 || VECTORP (XCAR (XCAR (item
)))))
7517 cachelist
= XCAR (item
);
7521 /* This is the real definition--the function to run. */
7522 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7524 /* Get enable property, if any. */
7527 tem
= Fget (item
, Qmenu_enable
);
7528 if (!NILP (Venable_disabled_menus_and_buttons
))
7529 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7530 else if (!NILP (tem
))
7531 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7534 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7536 /* New format menu item. */
7537 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7538 start
= XCDR (item
);
7541 /* We have a real binding. */
7542 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7544 item
= XCDR (start
);
7545 /* Is there a cache list with key equivalences. */
7546 if (CONSP (item
) && CONSP (XCAR (item
)))
7548 cachelist
= XCAR (item
);
7552 /* Parse properties. */
7553 while (CONSP (item
) && CONSP (XCDR (item
)))
7558 if (EQ (tem
, QCenable
))
7560 if (!NILP (Venable_disabled_menus_and_buttons
))
7561 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7563 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7565 else if (EQ (tem
, QCvisible
) && !notreal
)
7567 /* If got a visible property and that evaluates to nil
7568 then ignore this item. */
7569 tem
= menu_item_eval_property (XCAR (item
));
7573 else if (EQ (tem
, QChelp
))
7574 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7575 else if (EQ (tem
, QCfilter
))
7577 else if (EQ (tem
, QCkey_sequence
))
7580 if (NILP (cachelist
)
7581 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7582 /* Be GC protected. Set keyhint to item instead of tem. */
7585 else if (EQ (tem
, QCkeys
))
7588 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7589 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7591 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7596 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7598 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7600 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7607 else if (inmenubar
|| !NILP (start
))
7611 return 0; /* not a menu item */
7613 /* If item string is not a string, evaluate it to get string.
7614 If we don't get a string, skip this item. */
7615 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7616 if (!(STRINGP (item_string
) || notreal
))
7618 item_string
= menu_item_eval_property (item_string
);
7619 if (!STRINGP (item_string
))
7621 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7624 /* If got a filter apply it on definition. */
7625 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7628 def
= menu_item_eval_property (list2 (XCAR (filter
),
7629 list2 (Qquote
, def
)));
7631 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7634 /* Enable or disable selection of item. */
7635 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7641 tem
= menu_item_eval_property (tem
);
7642 if (inmenubar
&& NILP (tem
))
7643 return 0; /* Ignore disabled items in menu bar. */
7644 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7647 /* If we got no definition, this item is just unselectable text which
7648 is OK in a submenu but not in the menubar. */
7650 return (inmenubar
? 0 : 1);
7652 /* See if this is a separate pane or a submenu. */
7653 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7654 tem
= get_keymap (def
, 0, 1);
7655 /* For a subkeymap, just record its details and exit. */
7658 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7659 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7663 /* At the top level in the menu bar, do likewise for commands also.
7664 The menu bar does not display equivalent key bindings anyway.
7665 ITEM_PROPERTY_DEF is already set up properly. */
7669 /* This is a command. See if there is an equivalent key binding. */
7670 if (NILP (cachelist
))
7672 /* We have to create a cachelist. */
7673 CHECK_IMPURE (start
);
7674 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7675 cachelist
= XCAR (XCDR (start
));
7677 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7678 if (!NILP (keyhint
))
7680 XSETCAR (cachelist
, XCAR (keyhint
));
7683 else if (STRINGP (tem
))
7685 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7686 XSETCAR (cachelist
, Qt
);
7690 tem
= XCAR (cachelist
);
7697 tem
= Fkey_binding (tem
, Qnil
, Qnil
, Qnil
);
7699 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7702 def
= XCAR (prefix
);
7703 prefix
= XCDR (prefix
);
7706 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7708 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7710 if (newcache
/* Always check first time. */
7711 /* Should we check everything when precomputing key
7713 /* If something had no key binding before, don't recheck it
7714 because that is too slow--except if we have a list of
7715 rebound commands in Vdefine_key_rebound_commands, do
7716 recheck any command that appears in that list. */
7717 || (CONSP (Vdefine_key_rebound_commands
)
7718 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7721 /* We had a saved key. Is it still bound to the command? */
7724 /* If the command is an alias for another
7725 (such as lmenu.el set it up), check if the
7726 original command matches the cached command. */
7727 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7728 chkcache
= 1; /* Need to recompute key binding. */
7732 /* Recompute equivalent key binding. If the command is an alias
7733 for another (such as lmenu.el set it up), see if the original
7734 command name has equivalent keys. Otherwise look up the
7735 specified command itself. We don't try both, because that
7736 makes lmenu menus slow. */
7738 && SYMBOLP (XSYMBOL (def
)->function
)
7739 && ! NILP (Fget (def
, Qmenu_alias
)))
7740 def
= XSYMBOL (def
)->function
;
7741 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7742 XSETCAR (cachelist
, tem
);
7745 XSETCDR (cachelist
, Qnil
);
7749 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7751 tem
= XCAR (cachelist
);
7755 newcache
= chkcache
;
7758 tem
= Fkey_description (tem
, Qnil
);
7761 if (STRINGP (XCAR (prefix
)))
7762 tem
= concat2 (XCAR (prefix
), tem
);
7763 if (STRINGP (XCDR (prefix
)))
7764 tem
= concat2 (tem
, XCDR (prefix
));
7766 XSETCDR (cachelist
, tem
);
7770 tem
= XCDR (cachelist
);
7771 if (newcache
&& !NILP (tem
))
7773 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7774 XSETCDR (cachelist
, tem
);
7777 /* If we only want to precompute equivalent key bindings, stop here. */
7781 /* If we have an equivalent key binding, use that. */
7782 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7784 /* Include this when menu help is implemented.
7785 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7786 if (!(NILP (tem) || STRINGP (tem)))
7788 tem = menu_item_eval_property (tem);
7791 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7795 /* Handle radio buttons or toggle boxes. */
7796 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7798 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7799 = menu_item_eval_property (tem
);
7806 /***********************************************************************
7808 ***********************************************************************/
7810 /* A vector holding tool bar items while they are parsed in function
7811 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7814 static Lisp_Object tool_bar_items_vector
;
7816 /* A vector holding the result of parse_tool_bar_item. Layout is like
7817 the one for a single item in tool_bar_items_vector. */
7819 static Lisp_Object tool_bar_item_properties
;
7821 /* Next free index in tool_bar_items_vector. */
7823 static int ntool_bar_items
;
7825 /* The symbols `tool-bar', and `:image'. */
7827 extern Lisp_Object Qtool_bar
;
7828 Lisp_Object QCimage
;
7830 /* Function prototypes. */
7832 static void init_tool_bar_items
P_ ((Lisp_Object
));
7833 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7834 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7835 static void append_tool_bar_item
P_ ((void));
7838 /* Return a vector of tool bar items for keymaps currently in effect.
7839 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7840 tool bar items found. */
7843 tool_bar_items (reuse
, nitems
)
7854 /* In order to build the menus, we need to call the keymap
7855 accessors. They all call QUIT. But this function is called
7856 during redisplay, during which a quit is fatal. So inhibit
7857 quitting while building the menus. We do this instead of
7858 specbind because (1) errors will clear it anyway and (2) this
7859 avoids risk of specpdl overflow. */
7860 oquit
= Vinhibit_quit
;
7863 /* Initialize tool_bar_items_vector and protect it from GC. */
7864 init_tool_bar_items (reuse
);
7866 /* Build list of keymaps in maps. Set nmaps to the number of maps
7869 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7870 if (!NILP (Voverriding_local_map_menu_flag
))
7872 /* Yes, use them (if non-nil) as well as the global map. */
7873 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7875 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7876 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7877 if (!NILP (Voverriding_local_map
))
7878 maps
[nmaps
++] = Voverriding_local_map
;
7882 /* No, so use major and minor mode keymaps and keymap property.
7883 Note that tool-bar bindings in the local-map and keymap
7884 properties may not work reliable, as they are only
7885 recognized when the tool-bar (or mode-line) is updated,
7886 which does not normally happen after every command. */
7889 nminor
= current_minor_maps (NULL
, &tmaps
);
7890 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7892 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7893 maps
[nmaps
++] = tem
;
7894 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7896 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7899 /* Add global keymap at the end. */
7900 maps
[nmaps
++] = current_global_map
;
7902 /* Process maps in reverse order and look up in each map the prefix
7904 for (i
= nmaps
- 1; i
>= 0; --i
)
7905 if (!NILP (maps
[i
]))
7909 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7911 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7914 Vinhibit_quit
= oquit
;
7915 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7916 return tool_bar_items_vector
;
7920 /* Process the definition of KEY which is DEF. */
7923 process_tool_bar_item (key
, def
, data
, args
)
7924 Lisp_Object key
, def
, data
;
7928 extern Lisp_Object Qundefined
;
7929 struct gcpro gcpro1
, gcpro2
;
7931 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7935 if (EQ (def
, Qundefined
))
7937 /* If a map has an explicit `undefined' as definition,
7938 discard any previously made item. */
7939 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7941 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7943 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7945 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7946 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7947 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7948 * sizeof (Lisp_Object
)));
7949 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7954 else if (parse_tool_bar_item (key
, def
))
7955 /* Append a new tool bar item to tool_bar_items_vector. Accept
7956 more than one definition for the same key. */
7957 append_tool_bar_item ();
7963 /* Parse a tool bar item specification ITEM for key KEY and return the
7964 result in tool_bar_item_properties. Value is zero if ITEM is
7967 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7969 CAPTION is the caption of the item, If it's not a string, it is
7970 evaluated to get a string.
7972 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7973 as binding are currently ignored.
7975 The following properties are recognized:
7979 FORM is evaluated and specifies whether the tool bar item is
7980 enabled or disabled.
7984 FORM is evaluated and specifies whether the tool bar item is visible.
7986 - `:filter FUNCTION'
7988 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7989 result is stored as the new binding.
7991 - `:button (TYPE SELECTED)'
7993 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7994 and specifies whether the button is selected (pressed) or not.
7998 IMAGES is either a single image specification or a vector of four
7999 image specifications. See enum tool_bar_item_images.
8001 - `:help HELP-STRING'.
8003 Gives a help string to display for the tool bar item. */
8006 parse_tool_bar_item (key
, item
)
8007 Lisp_Object key
, item
;
8009 /* Access slot with index IDX of vector tool_bar_item_properties. */
8010 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8012 Lisp_Object filter
= Qnil
;
8013 Lisp_Object caption
;
8016 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8017 Rule out items that aren't lists, don't start with
8018 `menu-item' or whose rest following `tool-bar-item' is not a
8021 || !EQ (XCAR (item
), Qmenu_item
)
8022 || (item
= XCDR (item
),
8026 /* Create tool_bar_item_properties vector if necessary. Reset it to
8028 if (VECTORP (tool_bar_item_properties
))
8030 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8034 tool_bar_item_properties
8035 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8038 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8039 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8041 /* Get the caption of the item. If the caption is not a string,
8042 evaluate it to get a string. If we don't get a string, skip this
8044 caption
= XCAR (item
);
8045 if (!STRINGP (caption
))
8047 caption
= menu_item_eval_property (caption
);
8048 if (!STRINGP (caption
))
8051 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8053 /* Give up if rest following the caption is not a list. */
8058 /* Store the binding. */
8059 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8062 /* Ignore cached key binding, if any. */
8063 if (CONSP (item
) && CONSP (XCAR (item
)))
8066 /* Process the rest of the properties. */
8067 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8069 Lisp_Object key
, value
;
8072 value
= XCAR (XCDR (item
));
8074 if (EQ (key
, QCenable
))
8076 /* `:enable FORM'. */
8077 if (!NILP (Venable_disabled_menus_and_buttons
))
8078 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8080 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8082 else if (EQ (key
, QCvisible
))
8084 /* `:visible FORM'. If got a visible property and that
8085 evaluates to nil then ignore this item. */
8086 if (NILP (menu_item_eval_property (value
)))
8089 else if (EQ (key
, QChelp
))
8090 /* `:help HELP-STRING'. */
8091 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8092 else if (EQ (key
, QCfilter
))
8093 /* ':filter FORM'. */
8095 else if (EQ (key
, QCbutton
) && CONSP (value
))
8097 /* `:button (TYPE . SELECTED)'. */
8098 Lisp_Object type
, selected
;
8100 type
= XCAR (value
);
8101 selected
= XCDR (value
);
8102 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8104 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8105 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8108 else if (EQ (key
, QCimage
)
8110 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8111 /* Value is either a single image specification or a vector
8112 of 4 such specifications for the different button states. */
8113 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8116 /* If got a filter apply it on binding. */
8118 PROP (TOOL_BAR_ITEM_BINDING
)
8119 = menu_item_eval_property (list2 (filter
,
8121 PROP (TOOL_BAR_ITEM_BINDING
))));
8123 /* See if the binding is a keymap. Give up if it is. */
8124 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8127 /* Enable or disable selection of item. */
8128 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8129 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8130 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8132 /* Handle radio buttons or toggle boxes. */
8133 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8134 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8135 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8143 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8144 that can be reused. */
8147 init_tool_bar_items (reuse
)
8150 if (VECTORP (reuse
))
8151 tool_bar_items_vector
= reuse
;
8153 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8154 ntool_bar_items
= 0;
8158 /* Append parsed tool bar item properties from
8159 tool_bar_item_properties */
8162 append_tool_bar_item ()
8164 Lisp_Object
*to
, *from
;
8166 /* Enlarge tool_bar_items_vector if necessary. */
8167 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8168 >= XVECTOR (tool_bar_items_vector
)->size
)
8170 Lisp_Object new_vector
;
8171 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
8173 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
8174 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
8175 XVECTOR (new_vector
)->contents
,
8176 old_size
* sizeof (Lisp_Object
));
8177 tool_bar_items_vector
= new_vector
;
8180 /* Append entries from tool_bar_item_properties to the end of
8181 tool_bar_items_vector. */
8182 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8183 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8184 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8185 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8192 /* Read a character using menus based on maps in the array MAPS.
8193 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8194 Return t if we displayed a menu but the user rejected it.
8196 PREV_EVENT is the previous input event, or nil if we are reading
8197 the first event of a key sequence.
8199 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8200 if we used a mouse menu to read the input, or zero otherwise. If
8201 USED_MOUSE_MENU is null, we don't dereference it.
8203 The prompting is done based on the prompt-string of the map
8204 and the strings associated with various map elements.
8206 This can be done with X menus or with menus put in the minibuf.
8207 These are done in different ways, depending on how the input will be read.
8208 Menus using X are done after auto-saving in read-char, getting the input
8209 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8210 and do auto-saving in the inner call of read_char. */
8213 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8216 Lisp_Object prev_event
;
8217 int *used_mouse_menu
;
8220 register Lisp_Object name
= Qnil
;
8222 if (used_mouse_menu
)
8223 *used_mouse_menu
= 0;
8225 /* Use local over global Menu maps */
8227 if (! menu_prompting
)
8230 /* Optionally disregard all but the global map. */
8231 if (inhibit_local_menu_bar_menus
)
8233 maps
+= (nmaps
- 1);
8237 /* Get the menu name from the first map that has one (a prompt string). */
8238 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8240 name
= Fkeymap_prompt (maps
[mapno
]);
8245 /* If we don't have any menus, just read a character normally. */
8246 if (!STRINGP (name
))
8250 /* If we got to this point via a mouse click,
8251 use a real menu for mouse selection. */
8252 if (EVENT_HAS_PARAMETERS (prev_event
)
8253 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8254 && !EQ (XCAR (prev_event
), Qtool_bar
))
8256 /* Display the menu and get the selection. */
8257 Lisp_Object
*realmaps
8258 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8262 /* Use the maps that are not nil. */
8263 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8264 if (!NILP (maps
[mapno
]))
8265 realmaps
[nmaps1
++] = maps
[mapno
];
8267 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8272 record_menu_key (XCAR (value
));
8274 /* If we got multiple events, unread all but
8276 There is no way to prevent those unread events
8277 from showing up later in last_nonmenu_event.
8278 So turn symbol and integer events into lists,
8279 to indicate that they came from a mouse menu,
8280 so that when present in last_nonmenu_event
8281 they won't confuse things. */
8282 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8284 record_menu_key (XCAR (tem
));
8285 if (SYMBOLP (XCAR (tem
))
8286 || INTEGERP (XCAR (tem
)))
8287 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8290 /* If we got more than one event, put all but the first
8291 onto this list to be read later.
8292 Return just the first event now. */
8293 Vunread_command_events
8294 = nconc2 (XCDR (value
), Vunread_command_events
);
8295 value
= XCAR (value
);
8297 else if (NILP (value
))
8299 if (used_mouse_menu
)
8300 *used_mouse_menu
= 1;
8303 #endif /* HAVE_MENUS */
8307 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8308 We make this bigger when necessary, and never free it. */
8309 static char *read_char_minibuf_menu_text
;
8310 /* Size of that buffer. */
8311 static int read_char_minibuf_menu_width
;
8314 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8320 register Lisp_Object name
;
8322 /* FIXME: Use the minibuffer's frame width. */
8323 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8326 Lisp_Object rest
, vector
;
8332 if (! menu_prompting
)
8335 /* Make sure we have a big enough buffer for the menu text. */
8336 if (read_char_minibuf_menu_text
== 0)
8338 read_char_minibuf_menu_width
= width
+ 4;
8339 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8341 else if (width
+ 4 > read_char_minibuf_menu_width
)
8343 read_char_minibuf_menu_width
= width
+ 4;
8344 read_char_minibuf_menu_text
8345 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8347 menu
= read_char_minibuf_menu_text
;
8349 /* Get the menu name from the first map that has one (a prompt string). */
8350 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8352 name
= Fkeymap_prompt (maps
[mapno
]);
8357 /* If we don't have any menus, just read a character normally. */
8358 if (!STRINGP (name
))
8361 /* Prompt string always starts with map's prompt, and a space. */
8362 strcpy (menu
, SDATA (name
));
8363 nlength
= SBYTES (name
);
8364 menu
[nlength
++] = ':';
8365 menu
[nlength
++] = ' ';
8368 /* Start prompting at start of first map. */
8372 /* Present the documented bindings, a line at a time. */
8379 Lisp_Object orig_defn_macro
;
8381 /* Loop over elements of map. */
8386 /* If reached end of map, start at beginning of next map. */
8390 /* At end of last map, wrap around to first map if just starting,
8391 or end this line if already have something on it. */
8395 if (notfirst
|| nobindings
) break;
8400 /* Look at the next element of the map. */
8402 elt
= XVECTOR (vector
)->contents
[idx
];
8404 elt
= Fcar_safe (rest
);
8406 if (idx
< 0 && VECTORP (elt
))
8408 /* If we found a dense table in the keymap,
8409 advanced past it, but start scanning its contents. */
8410 rest
= Fcdr_safe (rest
);
8416 /* An ordinary element. */
8417 Lisp_Object event
, tem
;
8421 event
= Fcar_safe (elt
); /* alist */
8422 elt
= Fcdr_safe (elt
);
8426 XSETINT (event
, idx
); /* vector */
8429 /* Ignore the element if it has no prompt string. */
8430 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8432 /* 1 if the char to type matches the string. */
8434 Lisp_Object upcased_event
, downcased_event
;
8435 Lisp_Object desc
= Qnil
;
8437 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8439 upcased_event
= Fupcase (event
);
8440 downcased_event
= Fdowncase (event
);
8441 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8442 || XINT (downcased_event
) == SREF (s
, 0));
8444 desc
= Fsingle_key_description (event
, Qnil
);
8446 #if 0 /* It is redundant to list the equivalent key bindings because
8447 the prefix is what the user has already typed. */
8449 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8451 /* Insert equivalent keybinding. */
8452 s
= concat2 (s
, tem
);
8455 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8456 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8458 /* Insert button prefix. */
8459 Lisp_Object selected
8460 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8461 if (EQ (tem
, QCradio
))
8462 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8464 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8465 s
= concat2 (tem
, s
);
8469 /* If we have room for the prompt string, add it to this line.
8470 If this is the first on the line, always add it. */
8471 if ((SCHARS (s
) + i
+ 2
8472 + (char_matches
? 0 : SCHARS (desc
) + 3))
8478 /* Punctuate between strings. */
8481 strcpy (menu
+ i
, ", ");
8487 /* If the char to type doesn't match the string's
8488 first char, explicitly show what char to type. */
8491 /* Add as much of string as fits. */
8492 thiswidth
= SCHARS (desc
);
8493 if (thiswidth
+ i
> width
)
8494 thiswidth
= width
- i
;
8495 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8497 strcpy (menu
+ i
, " = ");
8501 /* Add as much of string as fits. */
8502 thiswidth
= SCHARS (s
);
8503 if (thiswidth
+ i
> width
)
8504 thiswidth
= width
- i
;
8505 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8511 /* If this element does not fit, end the line now,
8512 and save the element for the next line. */
8513 strcpy (menu
+ i
, "...");
8518 /* Move past this element. */
8519 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8520 /* Handle reaching end of dense table. */
8525 rest
= Fcdr_safe (rest
);
8529 /* Prompt with that and read response. */
8530 message2_nolog (menu
, strlen (menu
),
8531 ! NILP (current_buffer
->enable_multibyte_characters
));
8533 /* Make believe its not a keyboard macro in case the help char
8534 is pressed. Help characters are not recorded because menu prompting
8535 is not used on replay.
8537 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8538 current_kboard
->defining_kbd_macro
= Qnil
;
8540 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8541 while (BUFFERP (obj
));
8542 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8544 if (!INTEGERP (obj
))
8549 if (! EQ (obj
, menu_prompt_more_char
)
8550 && (!INTEGERP (menu_prompt_more_char
)
8551 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8553 if (!NILP (current_kboard
->defining_kbd_macro
))
8554 store_kbd_macro_char (obj
);
8557 /* Help char - go round again */
8561 /* Reading key sequences. */
8563 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8564 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8565 keymap, or nil otherwise. Return the index of the first keymap in
8566 which KEY has any binding, or NMAPS if no map has a binding.
8568 If KEY is a meta ASCII character, treat it like meta-prefix-char
8569 followed by the corresponding non-meta character. Keymaps in
8570 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8573 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8576 NEXT may be the same array as CURRENT. */
8579 follow_key (key
, nmaps
, current
, defs
, next
)
8581 Lisp_Object
*current
, *defs
, *next
;
8584 int i
, first_binding
;
8586 first_binding
= nmaps
;
8587 for (i
= nmaps
- 1; i
>= 0; i
--)
8589 if (! NILP (current
[i
]))
8591 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8592 if (! NILP (defs
[i
]))
8599 /* Given the set of bindings we've found, produce the next set of maps. */
8600 if (first_binding
< nmaps
)
8601 for (i
= 0; i
< nmaps
; i
++)
8602 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8604 return first_binding
;
8607 /* Structure used to keep track of partial application of key remapping
8608 such as Vfunction_key_map and Vkey_translation_map. */
8609 typedef struct keyremap
8611 /* This is the map originally specified for this use. */
8613 /* This is a submap reached by looking up, in PARENT,
8614 the events from START to END. */
8616 /* Positions [START, END) in the key sequence buffer
8617 are the key that we have scanned so far.
8618 Those events are the ones that we will replace
8619 if PAREHT maps them into a key sequence. */
8623 /* Lookup KEY in MAP.
8624 MAP is a keymap mapping keys to key vectors or functions.
8625 If the mapping is a function and DO_FUNCTION is non-zero, then
8626 the function is called with PROMPT as parameter and its return
8627 value is used as the return value of this function (after checking
8628 that it is indeed a vector). */
8631 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8632 Lisp_Object map
, key
, prompt
;
8637 next
= access_keymap (map
, key
, 1, 0, 1);
8639 /* Handle symbol with autoload definition. */
8640 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8641 && CONSP (XSYMBOL (next
)->function
)
8642 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8643 do_autoload (XSYMBOL (next
)->function
, next
);
8645 /* Handle a symbol whose function definition is a keymap
8647 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8648 && (ARRAYP (XSYMBOL (next
)->function
)
8649 || KEYMAPP (XSYMBOL (next
)->function
)))
8650 next
= XSYMBOL (next
)->function
;
8652 /* If the keymap gives a function, not an
8653 array, then call the function with one arg and use
8654 its value instead. */
8655 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8660 next
= call1 (next
, prompt
);
8661 /* If the function returned something invalid,
8662 barf--don't ignore it.
8663 (To ignore it safely, we would need to gcpro a bunch of
8664 other variables.) */
8665 if (! (VECTORP (next
) || STRINGP (next
)))
8666 error ("Function %s returns invalid key sequence", tem
);
8671 /* Do one step of the key remapping used for function-key-map and
8672 key-translation-map:
8673 KEYBUF is the buffer holding the input events.
8674 BUFSIZE is its maximum size.
8675 FKEY is a pointer to the keyremap structure to use.
8676 INPUT is the index of the last element in KEYBUF.
8677 DOIT if non-zero says that the remapping can actually take place.
8678 DIFF is used to return the number of keys added/removed by the remapping.
8679 PARENT is the root of the keymap.
8680 PROMPT is the prompt to use if the remapping happens through a function.
8681 The return value is non-zero if the remapping actually took place. */
8684 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8685 Lisp_Object
*keybuf
, prompt
;
8687 int input
, doit
, *diff
, bufsize
;
8689 Lisp_Object next
, key
;
8691 key
= keybuf
[fkey
->end
++];
8693 if (KEYMAPP (fkey
->parent
))
8694 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8698 /* If keybuf[fkey->start..fkey->end] is bound in the
8699 map and we're in a position to do the key remapping, replace it with
8700 the binding and restart with fkey->start at the end. */
8701 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8703 int len
= XFASTINT (Flength (next
));
8706 *diff
= len
- (fkey
->end
- fkey
->start
);
8708 if (input
+ *diff
>= bufsize
)
8709 error ("Key sequence too long");
8711 /* Shift the keys that follow fkey->end. */
8713 for (i
= fkey
->end
; i
< input
; i
++)
8714 keybuf
[i
+ *diff
] = keybuf
[i
];
8716 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8717 keybuf
[i
+ *diff
] = keybuf
[i
];
8718 /* Overwrite the old keys with the new ones. */
8719 for (i
= 0; i
< len
; i
++)
8720 keybuf
[fkey
->start
+ i
]
8721 = Faref (next
, make_number (i
));
8723 fkey
->start
= fkey
->end
+= *diff
;
8724 fkey
->map
= fkey
->parent
;
8729 fkey
->map
= get_keymap (next
, 0, 1);
8731 /* If we no longer have a bound suffix, try a new position for
8733 if (!CONSP (fkey
->map
))
8735 fkey
->end
= ++fkey
->start
;
8736 fkey
->map
= fkey
->parent
;
8741 /* Read a sequence of keys that ends with a non prefix character,
8742 storing it in KEYBUF, a buffer of size BUFSIZE.
8744 Return the length of the key sequence stored.
8745 Return -1 if the user rejected a command menu.
8747 Echo starting immediately unless `prompt' is 0.
8749 Where a key sequence ends depends on the currently active keymaps.
8750 These include any minor mode keymaps active in the current buffer,
8751 the current buffer's local map, and the global map.
8753 If a key sequence has no other bindings, we check Vfunction_key_map
8754 to see if some trailing subsequence might be the beginning of a
8755 function key's sequence. If so, we try to read the whole function
8756 key, and substitute its symbolic name into the key sequence.
8758 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8759 `double-' events into similar click events, if that would make them
8760 bound. We try to turn `triple-' events first into `double-' events,
8763 If we get a mouse click in a mode line, vertical divider, or other
8764 non-text area, we treat the click as if it were prefixed by the
8765 symbol denoting that area - `mode-line', `vertical-line', or
8768 If the sequence starts with a mouse click, we read the key sequence
8769 with respect to the buffer clicked on, not the current buffer.
8771 If the user switches frames in the midst of a key sequence, we put
8772 off the switch-frame event until later; the next call to
8773 read_char will return it.
8775 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8776 from the selected window's buffer. */
8779 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8780 can_return_switch_frame
, fix_current_buffer
)
8781 Lisp_Object
*keybuf
;
8784 int dont_downcase_last
;
8785 int can_return_switch_frame
;
8786 int fix_current_buffer
;
8788 volatile Lisp_Object from_string
;
8789 volatile int count
= SPECPDL_INDEX ();
8791 /* How many keys there are in the current key sequence. */
8794 /* The length of the echo buffer when we started reading, and
8795 the length of this_command_keys when we started reading. */
8796 volatile int echo_start
;
8797 volatile int keys_start
;
8799 /* The number of keymaps we're scanning right now, and the number of
8800 keymaps we have allocated space for. */
8802 volatile int nmaps_allocated
= 0;
8804 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8805 the current keymaps. */
8806 Lisp_Object
*volatile defs
= NULL
;
8808 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8809 in the current keymaps, or nil where it is not a prefix. */
8810 Lisp_Object
*volatile submaps
= NULL
;
8812 /* The local map to start out with at start of key sequence. */
8813 volatile Lisp_Object orig_local_map
;
8815 /* The map from the `keymap' property to start out with at start of
8817 volatile Lisp_Object orig_keymap
;
8819 /* 1 if we have already considered switching to the local-map property
8820 of the place where a mouse click occurred. */
8821 volatile int localized_local_map
= 0;
8823 /* The index in defs[] of the first keymap that has a binding for
8824 this key sequence. In other words, the lowest i such that
8825 defs[i] is non-nil. */
8826 volatile int first_binding
;
8827 /* Index of the first key that has no binding.
8828 It is useless to try fkey.start larger than that. */
8829 volatile int first_unbound
;
8831 /* If t < mock_input, then KEYBUF[t] should be read as the next
8834 We use this to recover after recognizing a function key. Once we
8835 realize that a suffix of the current key sequence is actually a
8836 function key's escape sequence, we replace the suffix with the
8837 function key's binding from Vfunction_key_map. Now keybuf
8838 contains a new and different key sequence, so the echo area,
8839 this_command_keys, and the submaps and defs arrays are wrong. In
8840 this situation, we set mock_input to t, set t to 0, and jump to
8841 restart_sequence; the loop will read keys from keybuf up until
8842 mock_input, thus rebuilding the state; and then it will resume
8843 reading characters from the keyboard. */
8844 volatile int mock_input
= 0;
8846 /* If the sequence is unbound in submaps[], then
8847 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8848 and fkey.map is its binding.
8850 These might be > t, indicating that all function key scanning
8851 should hold off until t reaches them. We do this when we've just
8852 recognized a function key, to avoid searching for the function
8853 key's again in Vfunction_key_map. */
8854 volatile keyremap fkey
;
8856 /* Likewise, for key_translation_map. */
8857 volatile keyremap keytran
;
8859 /* If we receive a `switch-frame' or `select-window' event in the middle of
8860 a key sequence, we put it off for later.
8861 While we're reading, we keep the event here. */
8862 volatile Lisp_Object delayed_switch_frame
;
8864 /* See the comment below... */
8865 #if defined (GOBBLE_FIRST_EVENT)
8866 Lisp_Object first_event
;
8869 volatile Lisp_Object original_uppercase
;
8870 volatile int original_uppercase_position
= -1;
8872 /* Gets around Microsoft compiler limitations. */
8875 struct buffer
*starting_buffer
;
8877 /* List of events for which a fake prefix key has been generated. */
8878 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8880 #if defined (GOBBLE_FIRST_EVENT)
8884 struct gcpro gcpro1
;
8886 GCPRO1 (fake_prefixed_keys
);
8887 raw_keybuf_count
= 0;
8889 last_nonmenu_event
= Qnil
;
8891 delayed_switch_frame
= Qnil
;
8892 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8893 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8894 fkey
.start
= fkey
.end
= 0;
8895 keytran
.start
= keytran
.end
= 0;
8900 echo_prompt (prompt
);
8901 else if (cursor_in_echo_area
8902 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8903 && NILP (Fzerop (Vecho_keystrokes
)))
8904 /* This doesn't put in a dash if the echo buffer is empty, so
8905 you don't always see a dash hanging out in the minibuffer. */
8909 /* Record the initial state of the echo area and this_command_keys;
8910 we will need to restore them if we replay a key sequence. */
8912 echo_start
= echo_length ();
8913 keys_start
= this_command_key_count
;
8914 this_single_command_key_start
= keys_start
;
8916 #if defined (GOBBLE_FIRST_EVENT)
8917 /* This doesn't quite work, because some of the things that read_char
8918 does cannot safely be bypassed. It seems too risky to try to make
8921 /* Read the first char of the sequence specially, before setting
8922 up any keymaps, in case a filter runs and switches buffers on us. */
8923 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8925 #endif /* GOBBLE_FIRST_EVENT */
8927 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8928 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8931 /* We jump here when the key sequence has been thoroughly changed, and
8932 we need to rescan it starting from the beginning. When we jump here,
8933 keybuf[0..mock_input] holds the sequence we should reread. */
8936 starting_buffer
= current_buffer
;
8937 first_unbound
= bufsize
+ 1;
8939 /* Build our list of keymaps.
8940 If we recognize a function key and replace its escape sequence in
8941 keybuf with its symbol, or if the sequence starts with a mouse
8942 click and we need to switch buffers, we jump back here to rebuild
8943 the initial keymaps from the current buffer. */
8946 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8948 if (2 > nmaps_allocated
)
8950 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
8951 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
8952 nmaps_allocated
= 2;
8954 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8955 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8957 else if (!NILP (Voverriding_local_map
))
8959 if (2 > nmaps_allocated
)
8961 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
8962 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
8963 nmaps_allocated
= 2;
8965 if (!NILP (Voverriding_local_map
))
8966 submaps
[nmaps
++] = Voverriding_local_map
;
8974 nminor
= current_minor_maps (0, &maps
);
8975 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8977 if (total
> nmaps_allocated
)
8979 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8980 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8981 nmaps_allocated
= total
;
8984 if (!NILP (orig_keymap
))
8985 submaps
[nmaps
++] = orig_keymap
;
8987 bcopy (maps
, (void *) (submaps
+ nmaps
),
8988 nminor
* sizeof (submaps
[0]));
8992 submaps
[nmaps
++] = orig_local_map
;
8994 submaps
[nmaps
++] = current_global_map
;
8996 /* Find an accurate initial value for first_binding. */
8997 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8998 if (! NILP (submaps
[first_binding
]))
9001 /* Start from the beginning in keybuf. */
9004 /* These are no-ops the first time through, but if we restart, they
9005 revert the echo area and this_command_keys to their original state. */
9006 this_command_key_count
= keys_start
;
9007 if (INTERACTIVE
&& t
< mock_input
)
9008 echo_truncate (echo_start
);
9010 /* If the best binding for the current key sequence is a keymap, or
9011 we may be looking at a function key's escape sequence, keep on
9013 while (first_binding
< nmaps
9014 /* Keep reading as long as there's a prefix binding. */
9015 ? !NILP (submaps
[first_binding
])
9016 /* Don't return in the middle of a possible function key sequence,
9017 if the only bindings we found were via case conversion.
9018 Thus, if ESC O a has a function-key-map translation
9019 and ESC o has a binding, don't return after ESC O,
9020 so that we can translate ESC O plus the next character. */
9021 : (fkey
.start
< t
|| keytran
.start
< t
))
9024 int used_mouse_menu
= 0;
9026 /* Where the last real key started. If we need to throw away a
9027 key that has expanded into more than one element of keybuf
9028 (say, a mouse click on the mode line which is being treated
9029 as [mode-line (mouse-...)], then we backtrack to this point
9031 volatile int last_real_key_start
;
9033 /* These variables are analogous to echo_start and keys_start;
9034 while those allow us to restart the entire key sequence,
9035 echo_local_start and keys_local_start allow us to throw away
9037 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9039 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
9040 eassert (fkey
.start
<= fkey
.end
);
9041 eassert (keytran
.start
<= keytran
.end
);
9042 /* key-translation-map is applied *after* function-key-map. */
9043 eassert (keytran
.end
<= fkey
.start
);
9045 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
9046 { /* The prefix upto first_unbound has no binding and has
9047 no translation left to do either, so we know it's unbound.
9048 If we don't stop now, we risk staying here indefinitely
9049 (if the user keeps entering fkey or keytran prefixes
9050 like C-c ESC ESC ESC ESC ...) */
9052 for (i
= first_unbound
+ 1; i
< t
; i
++)
9053 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9054 mock_input
= t
- first_unbound
- 1;
9055 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9056 fkey
.map
= fkey
.parent
;
9057 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9058 keytran
.map
= keytran
.parent
;
9059 goto replay_sequence
;
9063 error ("Key sequence too long");
9066 echo_local_start
= echo_length ();
9067 keys_local_start
= this_command_key_count
;
9068 local_first_binding
= first_binding
;
9071 /* These are no-ops, unless we throw away a keystroke below and
9072 jumped back up to replay_key; in that case, these restore the
9073 variables to their original state, allowing us to replay the
9075 if (INTERACTIVE
&& t
< mock_input
)
9076 echo_truncate (echo_local_start
);
9077 this_command_key_count
= keys_local_start
;
9078 first_binding
= local_first_binding
;
9080 /* By default, assume each event is "real". */
9081 last_real_key_start
= t
;
9083 /* Does mock_input indicate that we are re-reading a key sequence? */
9087 add_command_key (key
);
9088 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9089 && NILP (Fzerop (Vecho_keystrokes
)))
9093 /* If not, we should actually read a character. */
9098 KBOARD
*interrupted_kboard
= current_kboard
;
9099 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9100 if (setjmp (wrong_kboard_jmpbuf
))
9102 if (!NILP (delayed_switch_frame
))
9104 interrupted_kboard
->kbd_queue
9105 = Fcons (delayed_switch_frame
,
9106 interrupted_kboard
->kbd_queue
);
9107 delayed_switch_frame
= Qnil
;
9110 interrupted_kboard
->kbd_queue
9111 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9113 /* If the side queue is non-empty, ensure it begins with a
9114 switch-frame, so we'll replay it in the right context. */
9115 if (CONSP (interrupted_kboard
->kbd_queue
)
9116 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9117 !(EVENT_HAS_PARAMETERS (key
)
9118 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9122 XSETFRAME (frame
, interrupted_frame
);
9123 interrupted_kboard
->kbd_queue
9124 = Fcons (make_lispy_switch_frame (frame
),
9125 interrupted_kboard
->kbd_queue
);
9128 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9129 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9130 goto replay_sequence
;
9133 key
= read_char (NILP (prompt
), nmaps
,
9134 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9135 &used_mouse_menu
, NULL
);
9138 /* read_char returns t when it shows a menu and the user rejects it.
9142 unbind_to (count
, Qnil
);
9147 /* read_char returns -1 at the end of a macro.
9148 Emacs 18 handles this by returning immediately with a
9149 zero, so that's what we'll do. */
9150 if (INTEGERP (key
) && XINT (key
) == -1)
9153 /* The Microsoft C compiler can't handle the goto that
9159 /* If the current buffer has been changed from under us, the
9160 keymap may have changed, so replay the sequence. */
9163 timer_resume_idle ();
9166 /* Reset the current buffer from the selected window
9167 in case something changed the former and not the latter.
9168 This is to be more consistent with the behavior
9169 of the command_loop_1. */
9170 if (fix_current_buffer
)
9172 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9174 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9175 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9178 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9179 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9180 goto replay_sequence
;
9183 /* If we have a quit that was typed in another frame, and
9184 quit_throw_to_read_char switched buffers,
9185 replay to get the right keymap. */
9187 && XINT (key
) == quit_char
9188 && current_buffer
!= starting_buffer
)
9191 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9195 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9196 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9197 goto replay_sequence
;
9202 if (EVENT_HAS_PARAMETERS (key
)
9203 /* Either a `switch-frame' or a `select-window' event. */
9204 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9206 /* If we're at the beginning of a key sequence, and the caller
9207 says it's okay, go ahead and return this event. If we're
9208 in the midst of a key sequence, delay it until the end. */
9209 if (t
> 0 || !can_return_switch_frame
)
9211 delayed_switch_frame
= key
;
9217 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9220 /* Clicks in non-text areas get prefixed by the symbol
9221 in their CHAR-ADDRESS field. For example, a click on
9222 the mode line is prefixed by the symbol `mode-line'.
9224 Furthermore, key sequences beginning with mouse clicks
9225 are read using the keymaps of the buffer clicked on, not
9226 the current buffer. So we may have to switch the buffer
9229 When we turn one event into two events, we must make sure
9230 that neither of the two looks like the original--so that,
9231 if we replay the events, they won't be expanded again.
9232 If not for this, such reexpansion could happen either here
9233 or when user programs play with this-command-keys. */
9234 if (EVENT_HAS_PARAMETERS (key
))
9239 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9240 if (EQ (kind
, Qmouse_click
))
9242 Lisp_Object window
, posn
;
9244 window
= POSN_WINDOW (EVENT_START (key
));
9245 posn
= POSN_POSN (EVENT_START (key
));
9248 || (!NILP (fake_prefixed_keys
)
9249 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9251 /* We're looking a second time at an event for which
9252 we generated a fake prefix key. Set
9253 last_real_key_start appropriately. */
9255 last_real_key_start
= t
- 1;
9258 /* Key sequences beginning with mouse clicks are
9259 read using the keymaps in the buffer clicked on,
9260 not the current buffer. If we're at the
9261 beginning of a key sequence, switch buffers. */
9262 if (last_real_key_start
== 0
9264 && BUFFERP (XWINDOW (window
)->buffer
)
9265 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9267 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9271 /* Arrange to go back to the original buffer once we're
9272 done reading the key sequence. Note that we can't
9273 use save_excursion_{save,restore} here, because they
9274 save point as well as the current buffer; we don't
9275 want to save point, because redisplay may change it,
9276 to accommodate a Fset_window_start or something. We
9277 don't want to do this at the top of the function,
9278 because we may get input from a subprocess which
9279 wants to change the selected window and stuff (say,
9281 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9283 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9285 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9286 orig_local_map
= get_local_map (PT
, current_buffer
,
9288 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9289 goto replay_sequence
;
9292 /* For a mouse click, get the local text-property keymap
9293 of the place clicked on, rather than point. */
9294 if (last_real_key_start
== 0
9295 && CONSP (XCDR (key
))
9296 && ! localized_local_map
)
9298 Lisp_Object map_here
, start
, pos
;
9300 localized_local_map
= 1;
9301 start
= EVENT_START (key
);
9303 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9305 pos
= POSN_BUFFER_POSN (start
);
9307 && XINT (pos
) >= BEGV
9308 && XINT (pos
) <= ZV
)
9310 map_here
= get_local_map (XINT (pos
),
9311 current_buffer
, Qlocal_map
);
9312 if (!EQ (map_here
, orig_local_map
))
9314 orig_local_map
= map_here
;
9315 ++localized_local_map
;
9318 map_here
= get_local_map (XINT (pos
),
9319 current_buffer
, Qkeymap
);
9320 if (!EQ (map_here
, orig_keymap
))
9322 orig_keymap
= map_here
;
9323 ++localized_local_map
;
9326 if (localized_local_map
> 1)
9331 goto replay_sequence
;
9337 /* Expand mode-line and scroll-bar events into two events:
9338 use posn as a fake prefix key. */
9340 && (NILP (fake_prefixed_keys
)
9341 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9343 if (t
+ 1 >= bufsize
)
9344 error ("Key sequence too long");
9347 keybuf
[t
+ 1] = key
;
9350 /* Record that a fake prefix key has been generated
9351 for KEY. Don't modify the event; this would
9352 prevent proper action when the event is pushed
9353 back into unread-command-events. */
9354 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9356 /* If on a mode line string with a local keymap,
9357 reconsider the key sequence with that keymap. */
9358 if (string
= POSN_STRING (EVENT_START (key
)),
9359 (CONSP (string
) && STRINGP (XCAR (string
))))
9361 Lisp_Object pos
, map
, map2
;
9363 pos
= XCDR (string
);
9364 string
= XCAR (string
);
9366 && XINT (pos
) < SCHARS (string
))
9368 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9370 orig_local_map
= map
;
9371 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9374 if (!NILP (map
) || !NILP (map2
))
9375 goto replay_sequence
;
9381 else if (NILP (from_string
)
9382 && (string
= POSN_STRING (EVENT_START (key
)),
9383 (CONSP (string
) && STRINGP (XCAR (string
)))))
9385 /* For a click on a string, i.e. overlay string or a
9386 string displayed via the `display' property,
9387 consider `local-map' and `keymap' properties of
9389 Lisp_Object pos
, map
, map2
;
9391 pos
= XCDR (string
);
9392 string
= XCAR (string
);
9394 && XINT (pos
) < SCHARS (string
))
9396 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9398 orig_local_map
= map
;
9399 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9403 if (!NILP (map
) || !NILP (map2
))
9405 from_string
= string
;
9408 goto replay_sequence
;
9413 else if (CONSP (XCDR (key
))
9414 && CONSP (EVENT_START (key
))
9415 && CONSP (XCDR (EVENT_START (key
))))
9419 posn
= POSN_POSN (EVENT_START (key
));
9420 /* Handle menu-bar events:
9421 insert the dummy prefix event `menu-bar'. */
9422 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9424 if (t
+ 1 >= bufsize
)
9425 error ("Key sequence too long");
9429 /* Zap the position in key, so we know that we've
9430 expanded it, and don't try to do so again. */
9431 POSN_SET_POSN (EVENT_START (key
),
9432 Fcons (posn
, Qnil
));
9435 goto replay_sequence
;
9437 else if (CONSP (posn
))
9439 /* We're looking at the second event of a
9440 sequence which we expanded before. Set
9441 last_real_key_start appropriately. */
9442 if (last_real_key_start
== t
&& t
> 0)
9443 last_real_key_start
= t
- 1;
9448 /* We have finally decided that KEY is something we might want
9450 first_binding
= (follow_key (key
,
9451 nmaps
- first_binding
,
9452 submaps
+ first_binding
,
9453 defs
+ first_binding
,
9454 submaps
+ first_binding
)
9457 /* If KEY wasn't bound, we'll try some fallbacks. */
9458 if (first_binding
< nmaps
)
9459 /* This is needed for the following scenario:
9460 event 0: a down-event that gets dropped by calling replay_key.
9461 event 1: some normal prefix like C-h.
9462 After event 0, first_unbound is 0, after event 1 fkey.start
9463 and keytran.start are both 1, so when we see that C-h is bound,
9464 we need to update first_unbound. */
9465 first_unbound
= max (t
+ 1, first_unbound
);
9470 /* Remember the position to put an upper bound on fkey.start. */
9471 first_unbound
= min (t
, first_unbound
);
9473 head
= EVENT_HEAD (key
);
9474 if (help_char_p (head
) && t
> 0)
9476 read_key_sequence_cmd
= Vprefix_help_command
;
9478 last_nonmenu_event
= key
;
9479 /* The Microsoft C compiler can't handle the goto that
9487 Lisp_Object breakdown
;
9490 breakdown
= parse_modifiers (head
);
9491 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9492 /* Attempt to reduce an unbound mouse event to a simpler
9493 event that is bound:
9494 Drags reduce to clicks.
9495 Double-clicks reduce to clicks.
9496 Triple-clicks reduce to double-clicks, then to clicks.
9497 Down-clicks are eliminated.
9498 Double-downs reduce to downs, then are eliminated.
9499 Triple-downs reduce to double-downs, then to downs,
9500 then are eliminated. */
9501 if (modifiers
& (down_modifier
| drag_modifier
9502 | double_modifier
| triple_modifier
))
9504 while (modifiers
& (down_modifier
| drag_modifier
9505 | double_modifier
| triple_modifier
))
9507 Lisp_Object new_head
, new_click
;
9508 if (modifiers
& triple_modifier
)
9509 modifiers
^= (double_modifier
| triple_modifier
);
9510 else if (modifiers
& double_modifier
)
9511 modifiers
&= ~double_modifier
;
9512 else if (modifiers
& drag_modifier
)
9513 modifiers
&= ~drag_modifier
;
9516 /* Dispose of this `down' event by simply jumping
9517 back to replay_key, to get another event.
9519 Note that if this event came from mock input,
9520 then just jumping back to replay_key will just
9521 hand it to us again. So we have to wipe out any
9524 We could delete keybuf[t] and shift everything
9525 after that to the left by one spot, but we'd also
9526 have to fix up any variable that points into
9527 keybuf, and shifting isn't really necessary
9530 Adding prefixes for non-textual mouse clicks
9531 creates two characters of mock input, and both
9532 must be thrown away. If we're only looking at
9533 the prefix now, we can just jump back to
9534 replay_key. On the other hand, if we've already
9535 processed the prefix, and now the actual click
9536 itself is giving us trouble, then we've lost the
9537 state of the keymaps we want to backtrack to, and
9538 we need to replay the whole sequence to rebuild
9541 Beyond that, only function key expansion could
9542 create more than two keys, but that should never
9543 generate mouse events, so it's okay to zero
9544 mock_input in that case too.
9546 FIXME: The above paragraph seems just plain
9547 wrong, if you consider things like
9548 xterm-mouse-mode. -stef
9550 Isn't this just the most wonderful code ever? */
9552 /* If mock_input > t + 1, the above simplification
9553 will actually end up dropping keys on the floor.
9554 This is probably OK for now, but even
9555 if mock_input <= t + 1, we need to adjust fkey
9557 Typical case [header-line down-mouse-N]:
9558 mock_input = 2, t = 1, fkey.end = 1,
9559 last_real_key_start = 0. */
9560 if (fkey
.end
> last_real_key_start
)
9562 fkey
.end
= fkey
.start
9563 = min (last_real_key_start
, fkey
.start
);
9564 fkey
.map
= fkey
.parent
;
9565 if (keytran
.end
> last_real_key_start
)
9567 keytran
.end
= keytran
.start
9568 = min (last_real_key_start
, keytran
.start
);
9569 keytran
.map
= keytran
.parent
;
9572 if (t
== last_real_key_start
)
9579 mock_input
= last_real_key_start
;
9580 goto replay_sequence
;
9585 = apply_modifiers (modifiers
, XCAR (breakdown
));
9587 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9589 /* Look for a binding for this new key. follow_key
9590 promises that it didn't munge submaps the
9591 last time we called it, since key was unbound. */
9593 = (follow_key (new_click
,
9594 nmaps
- local_first_binding
,
9595 submaps
+ local_first_binding
,
9596 defs
+ local_first_binding
,
9597 submaps
+ local_first_binding
)
9598 + local_first_binding
);
9600 /* If that click is bound, go for it. */
9601 if (first_binding
< nmaps
)
9606 /* Otherwise, we'll leave key set to the drag event. */
9613 /* Normally, last_nonmenu_event gets the previous key we read.
9614 But when a mouse popup menu is being used,
9615 we don't update last_nonmenu_event; it continues to hold the mouse
9616 event that preceded the first level of menu. */
9617 if (!used_mouse_menu
)
9618 last_nonmenu_event
= key
;
9620 /* Record what part of this_command_keys is the current key sequence. */
9621 this_single_command_key_start
= this_command_key_count
- t
;
9623 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9624 /* There is a binding and it's not a prefix.
9625 There is thus no function-key in this sequence.
9626 Moving fkey.start is important in this case to allow keytran.start
9627 to go over the sequence before we return (since we keep the
9628 invariant that keytran.end <= fkey.start). */
9631 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9634 /* If the sequence is unbound, see if we can hang a function key
9635 off the end of it. */
9636 /* Continue scan from fkey.end until we find a bound suffix. */
9637 while (fkey
.end
< t
)
9639 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9642 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9643 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9644 max (t
, mock_input
),
9645 /* If there's a binding (i.e.
9646 first_binding >= nmaps) we don't want
9647 to apply this function-key-mapping. */
9648 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9653 mock_input
= diff
+ max (t
, mock_input
);
9654 goto replay_sequence
;
9658 /* Look for this sequence in key-translation-map.
9659 Scan from keytran.end until we find a bound suffix. */
9660 while (keytran
.end
< fkey
.start
)
9662 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9665 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9666 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9671 mock_input
= diff
+ max (t
, mock_input
);
9672 /* Adjust the function-key-map counters. */
9676 goto replay_sequence
;
9680 /* If KEY is not defined in any of the keymaps,
9681 and cannot be part of a function key or translation,
9682 and is an upper case letter
9683 use the corresponding lower-case letter instead. */
9684 if (first_binding
>= nmaps
9685 && fkey
.start
>= t
&& keytran
.start
>= t
9687 && ((((XINT (key
) & 0x3ffff)
9688 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9689 && UPPERCASEP (XINT (key
) & 0x3ffff))
9690 || (XINT (key
) & shift_modifier
)))
9692 Lisp_Object new_key
;
9694 original_uppercase
= key
;
9695 original_uppercase_position
= t
- 1;
9697 if (XINT (key
) & shift_modifier
)
9698 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9700 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9701 | (XINT (key
) & ~0x3ffff)));
9703 /* We have to do this unconditionally, regardless of whether
9704 the lower-case char is defined in the keymaps, because they
9705 might get translated through function-key-map. */
9706 keybuf
[t
- 1] = new_key
;
9707 mock_input
= max (t
, mock_input
);
9709 goto replay_sequence
;
9711 /* If KEY is not defined in any of the keymaps,
9712 and cannot be part of a function key or translation,
9713 and is a shifted function key,
9714 use the corresponding unshifted function key instead. */
9715 if (first_binding
>= nmaps
9716 && fkey
.start
>= t
&& keytran
.start
>= t
9719 Lisp_Object breakdown
;
9722 breakdown
= parse_modifiers (key
);
9723 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9724 if (modifiers
& shift_modifier
)
9726 Lisp_Object new_key
;
9728 original_uppercase
= key
;
9729 original_uppercase_position
= t
- 1;
9731 modifiers
&= ~shift_modifier
;
9732 new_key
= apply_modifiers (modifiers
,
9735 keybuf
[t
- 1] = new_key
;
9736 mock_input
= max (t
, mock_input
);
9737 fkey
.start
= fkey
.end
= 0;
9738 keytran
.start
= keytran
.end
= 0;
9740 goto replay_sequence
;
9746 read_key_sequence_cmd
= (first_binding
< nmaps
9747 ? defs
[first_binding
]
9750 unread_switch_frame
= delayed_switch_frame
;
9751 unbind_to (count
, Qnil
);
9753 /* Don't downcase the last character if the caller says don't.
9754 Don't downcase it if the result is undefined, either. */
9755 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9757 && t
- 1 == original_uppercase_position
)
9758 keybuf
[t
- 1] = original_uppercase
;
9760 /* Occasionally we fabricate events, perhaps by expanding something
9761 according to function-key-map, or by adding a prefix symbol to a
9762 mouse click in the scroll bar or modeline. In this cases, return
9763 the entire generated key sequence, even if we hit an unbound
9764 prefix or a definition before the end. This means that you will
9765 be able to push back the event properly, and also means that
9766 read-key-sequence will always return a logical unit.
9769 for (; t
< mock_input
; t
++)
9771 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9772 && NILP (Fzerop (Vecho_keystrokes
)))
9773 echo_char (keybuf
[t
]);
9774 add_command_key (keybuf
[t
]);
9783 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9784 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9785 The sequence is sufficient to specify a non-prefix command in the
9786 current local and global maps.
9788 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9789 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9790 as a continuation of the previous key.
9792 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9793 convert the last event to lower case. (Normally any upper case event
9794 is converted to lower case if the original event is undefined and the lower
9795 case equivalent is defined.) A non-nil value is appropriate for reading
9796 a key sequence to be defined.
9798 A C-g typed while in this function is treated like any other character,
9799 and `quit-flag' is not set.
9801 If the key sequence starts with a mouse click, then the sequence is read
9802 using the keymaps of the buffer of the window clicked in, not the buffer
9803 of the selected window as normal.
9805 `read-key-sequence' drops unbound button-down events, since you normally
9806 only care about the click or drag events which follow them. If a drag
9807 or multi-click event is unbound, but the corresponding click event would
9808 be bound, `read-key-sequence' turns the event into a click event at the
9809 drag's starting position. This means that you don't have to distinguish
9810 between click and drag, double, or triple events unless you want to.
9812 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9813 lines separating windows, and scroll bars with imaginary keys
9814 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9816 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9817 function will process a switch-frame event if the user switches frames
9818 before typing anything. If the user switches frames in the middle of a
9819 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9820 is nil, then the event will be put off until after the current key sequence.
9822 `read-key-sequence' checks `function-key-map' for function key
9823 sequences, where they wouldn't conflict with ordinary bindings. See
9824 `function-key-map' for more details.
9826 The optional fifth argument COMMAND-LOOP, if non-nil, means
9827 that this key sequence is being read by something that will
9828 read commands one after another. It should be nil if the caller
9829 will read just one key sequence. */)
9830 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9832 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9833 Lisp_Object can_return_switch_frame
, command_loop
;
9835 Lisp_Object keybuf
[30];
9837 struct gcpro gcpro1
;
9838 int count
= SPECPDL_INDEX ();
9841 CHECK_STRING (prompt
);
9844 specbind (Qinput_method_exit_on_first_char
,
9845 (NILP (command_loop
) ? Qt
: Qnil
));
9846 specbind (Qinput_method_use_echo_area
,
9847 (NILP (command_loop
) ? Qt
: Qnil
));
9849 bzero (keybuf
, sizeof keybuf
);
9851 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9853 if (NILP (continue_echo
))
9855 this_command_key_count
= 0;
9856 this_command_key_count_reset
= 0;
9857 this_single_command_key_start
= 0;
9860 #ifdef HAVE_X_WINDOWS
9861 if (display_hourglass_p
)
9862 cancel_hourglass ();
9865 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9866 prompt
, ! NILP (dont_downcase_last
),
9867 ! NILP (can_return_switch_frame
), 0);
9869 #if 0 /* The following is fine for code reading a key sequence and
9870 then proceeding with a lenghty computation, but it's not good
9871 for code reading keys in a loop, like an input method. */
9872 #ifdef HAVE_X_WINDOWS
9873 if (display_hourglass_p
)
9884 return unbind_to (count
, make_event_array (i
, keybuf
));
9887 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9888 Sread_key_sequence_vector
, 1, 5, 0,
9889 doc
: /* Like `read-key-sequence' but always return a vector. */)
9890 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9892 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9893 Lisp_Object can_return_switch_frame
, command_loop
;
9895 Lisp_Object keybuf
[30];
9897 struct gcpro gcpro1
;
9898 int count
= SPECPDL_INDEX ();
9901 CHECK_STRING (prompt
);
9904 specbind (Qinput_method_exit_on_first_char
,
9905 (NILP (command_loop
) ? Qt
: Qnil
));
9906 specbind (Qinput_method_use_echo_area
,
9907 (NILP (command_loop
) ? Qt
: Qnil
));
9909 bzero (keybuf
, sizeof keybuf
);
9911 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9913 if (NILP (continue_echo
))
9915 this_command_key_count
= 0;
9916 this_command_key_count_reset
= 0;
9917 this_single_command_key_start
= 0;
9920 #ifdef HAVE_X_WINDOWS
9921 if (display_hourglass_p
)
9922 cancel_hourglass ();
9925 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9926 prompt
, ! NILP (dont_downcase_last
),
9927 ! NILP (can_return_switch_frame
), 0);
9929 #ifdef HAVE_X_WINDOWS
9930 if (display_hourglass_p
)
9940 return unbind_to (count
, Fvector (i
, keybuf
));
9943 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9944 doc
: /* Execute CMD as an editor command.
9945 CMD must be a symbol that satisfies the `commandp' predicate.
9946 Optional second arg RECORD-FLAG non-nil
9947 means unconditionally put this command in `command-history'.
9948 Otherwise, that is done only if an arg is read using the minibuffer.
9949 The argument KEYS specifies the value to use instead of (this-command-keys)
9950 when reading the arguments; if it is nil, (this-command-keys) is used.
9951 The argument SPECIAL, if non-nil, means that this command is executing
9952 a special event, so ignore the prefix argument and don't clear it. */)
9953 (cmd
, record_flag
, keys
, special
)
9954 Lisp_Object cmd
, record_flag
, keys
, special
;
9956 register Lisp_Object final
;
9957 register Lisp_Object tem
;
9958 Lisp_Object prefixarg
;
9959 struct backtrace backtrace
;
9960 extern int debug_on_next_call
;
9962 debug_on_next_call
= 0;
9966 prefixarg
= current_kboard
->Vprefix_arg
;
9967 Vcurrent_prefix_arg
= prefixarg
;
9968 current_kboard
->Vprefix_arg
= Qnil
;
9975 tem
= Fget (cmd
, Qdisabled
);
9976 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9978 tem
= Fsymbol_value (Qdisabled_command_function
);
9980 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9986 final
= Findirect_function (cmd
, Qnil
);
9988 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9990 struct gcpro gcpro1
, gcpro2
;
9992 GCPRO2 (cmd
, prefixarg
);
9993 do_autoload (final
, cmd
);
10000 if (STRINGP (final
) || VECTORP (final
))
10002 /* If requested, place the macro in the command history. For
10003 other sorts of commands, call-interactively takes care of
10005 if (!NILP (record_flag
))
10008 = Fcons (Fcons (Qexecute_kbd_macro
,
10009 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10012 /* Don't keep command history around forever. */
10013 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10015 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10017 XSETCDR (tem
, Qnil
);
10021 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10024 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10026 backtrace
.next
= backtrace_list
;
10027 backtrace_list
= &backtrace
;
10028 backtrace
.function
= &Qcall_interactively
;
10029 backtrace
.args
= &cmd
;
10030 backtrace
.nargs
= 1;
10031 backtrace
.evalargs
= 0;
10032 backtrace
.debug_on_exit
= 0;
10034 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
10036 backtrace_list
= backtrace
.next
;
10044 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10046 doc
: /* Read function name, then read its arguments and call it.
10048 To pass a numeric argument to the command you are invoking with, specify
10049 the numeric argument to this command.
10051 Noninteractively, the argument PREFIXARG is the prefix argument to
10052 give to the command you invoke, if it asks for an argument. */)
10054 Lisp_Object prefixarg
;
10056 Lisp_Object function
;
10058 int saved_last_point_position
;
10059 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10060 Lisp_Object bindings
, value
;
10061 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10062 #ifdef HAVE_X_WINDOWS
10063 /* The call to Fcompleting_read wil start and cancel the hourglass,
10064 but if the hourglass was already scheduled, this means that no
10065 hourglass will be shown for the actual M-x command itself.
10066 So we restart it if it is already scheduled. Note that checking
10067 hourglass_shown_p is not enough, normally the hourglass is not shown,
10068 just scheduled to be shown. */
10069 int hstarted
= hourglass_started ();
10072 saved_keys
= Fvector (this_command_key_count
,
10073 XVECTOR (this_command_keys
)->contents
);
10074 saved_last_point_position_buffer
= last_point_position_buffer
;
10075 saved_last_point_position
= last_point_position
;
10077 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10079 if (EQ (prefixarg
, Qminus
))
10080 strcpy (buf
, "- ");
10081 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10082 strcpy (buf
, "C-u ");
10083 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10084 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10085 else if (INTEGERP (prefixarg
))
10086 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10088 /* This isn't strictly correct if execute-extended-command
10089 is bound to anything else. Perhaps it should use
10090 this_command_keys? */
10091 strcat (buf
, "M-x ");
10093 /* Prompt with buf, and then read a string, completing from and
10094 restricting to the set of all defined commands. Don't provide
10095 any initial input. Save the command read on the extended-command
10097 function
= Fcompleting_read (build_string (buf
),
10098 Vobarray
, Qcommandp
,
10099 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10102 #ifdef HAVE_X_WINDOWS
10103 if (hstarted
) start_hourglass ();
10106 if (STRINGP (function
) && SCHARS (function
) == 0)
10107 error ("No command name given");
10109 /* Set this_command_keys to the concatenation of saved_keys and
10110 function, followed by a RET. */
10115 this_command_key_count
= 0;
10116 this_command_key_count_reset
= 0;
10117 this_single_command_key_start
= 0;
10119 keys
= XVECTOR (saved_keys
)->contents
;
10120 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10121 add_command_key (keys
[i
]);
10123 for (i
= 0; i
< SCHARS (function
); i
++)
10124 add_command_key (Faref (function
, make_number (i
)));
10126 add_command_key (make_number ('\015'));
10129 last_point_position
= saved_last_point_position
;
10130 last_point_position_buffer
= saved_last_point_position_buffer
;
10134 function
= Fintern (function
, Qnil
);
10135 current_kboard
->Vprefix_arg
= prefixarg
;
10136 Vthis_command
= function
;
10137 real_this_command
= function
;
10139 /* If enabled, show which key runs this command. */
10140 if (!NILP (Vsuggest_key_bindings
)
10141 && NILP (Vexecuting_kbd_macro
)
10142 && SYMBOLP (function
))
10143 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10149 GCPRO2 (bindings
, value
);
10150 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10152 /* If the command has a key binding, print it now. */
10153 if (!NILP (bindings
)
10154 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10157 /* But first wait, and skip the message if there is input. */
10158 Lisp_Object waited
;
10160 /* If this command displayed something in the echo area;
10161 wait a few seconds, then display our suggestion message. */
10162 if (NILP (echo_area_buffer
[0]))
10163 waited
= sit_for (make_number (0), 0, 2);
10164 else if (NUMBERP (Vsuggest_key_bindings
))
10165 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10167 waited
= sit_for (make_number (2), 0, 2);
10169 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10171 Lisp_Object binding
;
10173 int message_p
= push_message ();
10174 int count
= SPECPDL_INDEX ();
10176 record_unwind_protect (pop_message_unwind
, Qnil
);
10177 binding
= Fkey_description (bindings
, Qnil
);
10180 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10183 sprintf (newmessage
, "You can run the command `%s' with %s",
10184 SDATA (SYMBOL_NAME (function
)),
10186 message2_nolog (newmessage
,
10187 strlen (newmessage
),
10188 STRING_MULTIBYTE (binding
));
10189 if (NUMBERP (Vsuggest_key_bindings
))
10190 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10192 waited
= sit_for (make_number (2), 0, 2);
10194 if (!NILP (waited
) && message_p
)
10195 restore_message ();
10197 unbind_to (count
, Qnil
);
10201 RETURN_UNGCPRO (value
);
10205 /* Return nonzero if input events are pending. */
10208 detect_input_pending ()
10210 if (!input_pending
)
10211 get_input_pending (&input_pending
, 0);
10213 return input_pending
;
10216 /* Return nonzero if input events other than mouse movements are
10220 detect_input_pending_ignore_squeezables ()
10222 if (!input_pending
)
10223 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10225 return input_pending
;
10228 /* Return nonzero if input events are pending, and run any pending timers. */
10231 detect_input_pending_run_timers (do_display
)
10234 int old_timers_run
= timers_run
;
10236 if (!input_pending
)
10237 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10239 if (old_timers_run
!= timers_run
&& do_display
)
10241 redisplay_preserve_echo_area (8);
10242 /* The following fixes a bug when using lazy-lock with
10243 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10244 from an idle timer function. The symptom of the bug is that
10245 the cursor sometimes doesn't become visible until the next X
10246 event is processed. --gerd. */
10248 rif
->flush_display (NULL
);
10251 return input_pending
;
10254 /* This is called in some cases before a possible quit.
10255 It cases the next call to detect_input_pending to recompute input_pending.
10256 So calling this function unnecessarily can't do any harm. */
10259 clear_input_pending ()
10264 /* Return nonzero if there are pending requeued events.
10265 This isn't used yet. The hope is to make wait_reading_process_output
10266 call it, and return if it runs Lisp code that unreads something.
10267 The problem is, kbd_buffer_get_event needs to be fixed to know what
10268 to do in that case. It isn't trivial. */
10271 requeued_events_pending_p ()
10273 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10277 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10278 doc
: /* Return t if command input is currently available with no wait.
10279 Actually, the value is nil only if we can be sure that no input is available;
10280 if there is a doubt, the value is t. */)
10283 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10284 || !NILP (Vunread_post_input_method_events
)
10285 || !NILP (Vunread_input_method_events
))
10288 get_input_pending (&input_pending
,
10289 READABLE_EVENTS_DO_TIMERS_NOW
10290 | READABLE_EVENTS_FILTER_EVENTS
);
10291 return input_pending
> 0 ? Qt
: Qnil
;
10294 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10295 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10298 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10301 if (total_keys
< NUM_RECENT_KEYS
)
10302 return Fvector (total_keys
, keys
);
10305 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10306 bcopy (keys
+ recent_keys_index
,
10307 XVECTOR (val
)->contents
,
10308 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10310 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10311 recent_keys_index
* sizeof (Lisp_Object
));
10316 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10317 doc
: /* Return the key sequence that invoked this command.
10318 However, if the command has called `read-key-sequence', it returns
10319 the last key sequence that has been read.
10320 The value is a string or a vector.
10322 See also `this-command-keys-vector'. */)
10325 return make_event_array (this_command_key_count
,
10326 XVECTOR (this_command_keys
)->contents
);
10329 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10330 doc
: /* Return the key sequence that invoked this command, as a vector.
10331 However, if the command has called `read-key-sequence', it returns
10332 the last key sequence that has been read.
10334 See also `this-command-keys'. */)
10337 return Fvector (this_command_key_count
,
10338 XVECTOR (this_command_keys
)->contents
);
10341 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10342 Sthis_single_command_keys
, 0, 0, 0,
10343 doc
: /* Return the key sequence that invoked this command.
10344 More generally, it returns the last key sequence read, either by
10345 the command loop or by `read-key-sequence'.
10346 Unlike `this-command-keys', this function's value
10347 does not include prefix arguments.
10348 The value is always a vector. */)
10351 return Fvector (this_command_key_count
10352 - this_single_command_key_start
,
10353 (XVECTOR (this_command_keys
)->contents
10354 + this_single_command_key_start
));
10357 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10358 Sthis_single_command_raw_keys
, 0, 0, 0,
10359 doc
: /* Return the raw events that were read for this command.
10360 More generally, it returns the last key sequence read, either by
10361 the command loop or by `read-key-sequence'.
10362 Unlike `this-single-command-keys', this function's value
10363 shows the events before all translations (except for input methods).
10364 The value is always a vector. */)
10367 return Fvector (raw_keybuf_count
,
10368 (XVECTOR (raw_keybuf
)->contents
));
10371 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10372 Sreset_this_command_lengths
, 0, 0, 0,
10373 doc
: /* Make the unread events replace the last command and echo.
10374 Used in `universal-argument-other-key'.
10376 `universal-argument-other-key' rereads the event just typed.
10377 It then gets translated through `function-key-map'.
10378 The translated event has to replace the real events,
10379 both in the value of (this-command-keys) and in echoing.
10380 To achieve this, `universal-argument-other-key' calls
10381 `reset-this-command-lengths', which discards the record of reading
10382 these events the first time. */)
10385 this_command_key_count
= before_command_key_count
;
10386 if (this_command_key_count
< this_single_command_key_start
)
10387 this_single_command_key_start
= this_command_key_count
;
10389 echo_truncate (before_command_echo_length
);
10391 /* Cause whatever we put into unread-command-events
10392 to echo as if it were being freshly read from the keyboard. */
10393 this_command_key_count_reset
= 1;
10398 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10399 Sclear_this_command_keys
, 0, 1, 0,
10400 doc
: /* Clear out the vector that `this-command-keys' returns.
10401 Also clear the record of the last 100 events, unless optional arg
10402 KEEP-RECORD is non-nil. */)
10404 Lisp_Object keep_record
;
10408 this_command_key_count
= 0;
10409 this_command_key_count_reset
= 0;
10411 if (NILP (keep_record
))
10413 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10414 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10416 recent_keys_index
= 0;
10421 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10422 doc
: /* Return the current depth in recursive edits. */)
10426 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10430 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10431 "FOpen dribble file: ",
10432 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10433 If FILE is nil, close any open dribble file. */)
10444 file
= Fexpand_file_name (file
, Qnil
);
10445 dribble
= fopen (SDATA (file
), "w");
10447 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10452 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10453 doc
: /* Discard the contents of the terminal input buffer.
10454 Also end any kbd macro being defined. */)
10457 if (!NILP (current_kboard
->defining_kbd_macro
))
10459 /* Discard the last command from the macro. */
10460 Fcancel_kbd_macro_events ();
10464 update_mode_lines
++;
10466 Vunread_command_events
= Qnil
;
10467 unread_command_char
= -1;
10469 discard_tty_input ();
10471 kbd_fetch_ptr
= kbd_store_ptr
;
10477 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10478 doc
: /* Stop Emacs and return to superior process. You can resume later.
10479 If `cannot-suspend' is non-nil, or if the system doesn't support job
10480 control, run a subshell instead.
10482 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10483 to be read as terminal input by Emacs's parent, after suspension.
10485 Before suspending, run the normal hook `suspend-hook'.
10486 After resumption run the normal hook `suspend-resume-hook'.
10488 Some operating systems cannot stop the Emacs process and resume it later.
10489 On such systems, Emacs starts a subshell instead of suspending. */)
10491 Lisp_Object stuffstring
;
10493 int count
= SPECPDL_INDEX ();
10494 int old_height
, old_width
;
10496 struct gcpro gcpro1
;
10498 if (!NILP (stuffstring
))
10499 CHECK_STRING (stuffstring
);
10501 /* Run the functions in suspend-hook. */
10502 if (!NILP (Vrun_hooks
))
10503 call1 (Vrun_hooks
, intern ("suspend-hook"));
10505 GCPRO1 (stuffstring
);
10506 get_frame_size (&old_width
, &old_height
);
10507 reset_sys_modes ();
10508 /* sys_suspend can get an error if it tries to fork a subshell
10509 and the system resources aren't available for that. */
10510 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10512 stuff_buffered_input (stuffstring
);
10513 if (cannot_suspend
)
10517 unbind_to (count
, Qnil
);
10519 /* Check if terminal/window size has changed.
10520 Note that this is not useful when we are running directly
10521 with a window system; but suspend should be disabled in that case. */
10522 get_frame_size (&width
, &height
);
10523 if (width
!= old_width
|| height
!= old_height
)
10524 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10526 /* Run suspend-resume-hook. */
10527 if (!NILP (Vrun_hooks
))
10528 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10534 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10535 Then in any case stuff anything Emacs has read ahead and not used. */
10538 stuff_buffered_input (stuffstring
)
10539 Lisp_Object stuffstring
;
10541 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10542 register unsigned char *p
;
10544 if (STRINGP (stuffstring
))
10546 register int count
;
10548 p
= SDATA (stuffstring
);
10549 count
= SBYTES (stuffstring
);
10550 while (count
-- > 0)
10555 /* Anything we have read ahead, put back for the shell to read. */
10556 /* ?? What should this do when we have multiple keyboards??
10557 Should we ignore anything that was typed in at the "wrong" kboard?
10559 rms: we should stuff everything back into the kboard
10561 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10564 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10565 kbd_fetch_ptr
= kbd_buffer
;
10566 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10567 stuff_char (kbd_fetch_ptr
->code
);
10569 clear_event (kbd_fetch_ptr
);
10573 #endif /* SIGTSTP */
10577 set_waiting_for_input (time_to_clear
)
10578 EMACS_TIME
*time_to_clear
;
10580 input_available_clear_time
= time_to_clear
;
10582 /* Tell interrupt_signal to throw back to read_char, */
10583 waiting_for_input
= 1;
10585 /* If interrupt_signal was called before and buffered a C-g,
10586 make it run again now, to avoid timing error. */
10587 if (!NILP (Vquit_flag
))
10588 quit_throw_to_read_char ();
10592 clear_waiting_for_input ()
10594 /* Tell interrupt_signal not to throw back to read_char, */
10595 waiting_for_input
= 0;
10596 input_available_clear_time
= 0;
10599 /* This routine is called at interrupt level in response to C-g.
10601 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10602 is called from kbd_buffer_store_event, in handling SIGIO or
10605 If `waiting_for_input' is non zero, then unless `echoing' is
10606 nonzero, immediately throw back to read_char.
10608 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10609 eval to throw, when it gets a chance. If quit-flag is already
10610 non-nil, it stops the job right away. */
10613 interrupt_signal (signalnum
) /* If we don't have an argument, */
10614 int signalnum
; /* some compilers complain in signal calls. */
10617 /* Must preserve main program's value of errno. */
10618 int old_errno
= errno
;
10619 struct frame
*sf
= SELECTED_FRAME ();
10621 #if defined (USG) && !defined (POSIX_SIGNALS)
10622 if (!read_socket_hook
&& NILP (Vwindow_system
))
10624 /* USG systems forget handlers when they are used;
10625 must reestablish each time */
10626 signal (SIGINT
, interrupt_signal
);
10627 signal (SIGQUIT
, interrupt_signal
);
10631 SIGNAL_THREAD_CHECK (signalnum
);
10634 if (!NILP (Vquit_flag
)
10635 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10637 /* If SIGINT isn't blocked, don't let us be interrupted by
10638 another SIGINT, it might be harmful due to non-reentrancy
10639 in I/O functions. */
10640 sigblock (sigmask (SIGINT
));
10643 reset_sys_modes ();
10645 #ifdef SIGTSTP /* Support possible in later USG versions */
10647 * On systems which can suspend the current process and return to the original
10648 * shell, this command causes the user to end up back at the shell.
10649 * The "Auto-save" and "Abort" questions are not asked until
10650 * the user elects to return to emacs, at which point he can save the current
10651 * job and either dump core or continue.
10656 if (sys_suspend () == -1)
10658 printf ("Not running as a subprocess;\n");
10659 printf ("you can continue or abort.\n");
10661 #else /* not VMS */
10662 /* Perhaps should really fork an inferior shell?
10663 But that would not provide any way to get back
10664 to the original shell, ever. */
10665 printf ("No support for stopping a process on this operating system;\n");
10666 printf ("you can continue or abort.\n");
10667 #endif /* not VMS */
10668 #endif /* not SIGTSTP */
10670 /* We must remain inside the screen area when the internal terminal
10671 is used. Note that [Enter] is not echoed by dos. */
10674 /* It doesn't work to autosave while GC is in progress;
10675 the code used for auto-saving doesn't cope with the mark bit. */
10676 if (!gc_in_progress
)
10678 printf ("Auto-save? (y or n) ");
10680 if (((c
= getchar ()) & ~040) == 'Y')
10682 Fdo_auto_save (Qt
, Qnil
);
10684 printf ("\r\nAuto-save done");
10685 #else /* not MSDOS */
10686 printf ("Auto-save done\n");
10687 #endif /* not MSDOS */
10689 while (c
!= '\n') c
= getchar ();
10693 /* During GC, it must be safe to reenable quitting again. */
10694 Vinhibit_quit
= Qnil
;
10697 #endif /* not MSDOS */
10698 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10699 printf ("but will instead do a real quit after garbage collection ends\r\n");
10704 printf ("\r\nAbort? (y or n) ");
10705 #else /* not MSDOS */
10707 printf ("Abort (and enter debugger)? (y or n) ");
10708 #else /* not VMS */
10709 printf ("Abort (and dump core)? (y or n) ");
10710 #endif /* not VMS */
10711 #endif /* not MSDOS */
10713 if (((c
= getchar ()) & ~040) == 'Y')
10715 while (c
!= '\n') c
= getchar ();
10717 printf ("\r\nContinuing...\r\n");
10718 #else /* not MSDOS */
10719 printf ("Continuing...\n");
10720 #endif /* not MSDOS */
10727 /* If executing a function that wants to be interrupted out of
10728 and the user has not deferred quitting by binding `inhibit-quit'
10729 then quit right away. */
10730 if (immediate_quit
&& NILP (Vinhibit_quit
))
10732 struct gl_state_s saved
;
10733 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10735 immediate_quit
= 0;
10738 GCPRO4 (saved
.object
, saved
.global_code
,
10739 saved
.current_syntax_table
, saved
.old_prop
);
10740 Fsignal (Qquit
, Qnil
);
10745 /* Else request quit when it's safe */
10749 if (waiting_for_input
&& !echoing
)
10750 quit_throw_to_read_char ();
10755 /* Handle a C-g by making read_char return C-g. */
10758 quit_throw_to_read_char ()
10761 /* Prevent another signal from doing this before we finish. */
10762 clear_waiting_for_input ();
10765 Vunread_command_events
= Qnil
;
10766 unread_command_char
= -1;
10768 #if 0 /* Currently, sit_for is called from read_char without turning
10769 off polling. And that can call set_waiting_for_input.
10770 It seems to be harmless. */
10771 #ifdef POLL_FOR_INPUT
10772 /* May be > 1 if in recursive minibuffer. */
10773 if (poll_suppress_count
== 0)
10777 if (FRAMEP (internal_last_event_frame
)
10778 && !EQ (internal_last_event_frame
, selected_frame
))
10779 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10782 _longjmp (getcjmp
, 1);
10785 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10786 doc
: /* Set mode of reading keyboard input.
10787 First arg INTERRUPT non-nil means use input interrupts;
10788 nil means use CBREAK mode.
10789 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10790 (no effect except in CBREAK mode).
10791 Third arg META t means accept 8-bit input (for a Meta key).
10792 META nil means ignore the top bit, on the assumption it is parity.
10793 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10794 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10795 See also `current-input-mode'. */)
10796 (interrupt
, flow
, meta
, quit
)
10797 Lisp_Object interrupt
, flow
, meta
, quit
;
10800 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10801 error ("set-input-mode: QUIT must be an ASCII character");
10803 #ifdef POLL_FOR_INPUT
10808 /* this causes startup screen to be restored and messes with the mouse */
10809 reset_sys_modes ();
10813 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10814 if (read_socket_hook
)
10816 /* When using X, don't give the user a real choice,
10817 because we haven't implemented the mechanisms to support it. */
10818 #ifdef NO_SOCK_SIGIO
10819 interrupt_input
= 0;
10820 #else /* not NO_SOCK_SIGIO */
10821 interrupt_input
= 1;
10822 #endif /* NO_SOCK_SIGIO */
10825 interrupt_input
= !NILP (interrupt
);
10826 #else /* not SIGIO */
10827 interrupt_input
= 0;
10828 #endif /* not SIGIO */
10830 /* Our VMS input only works by interrupts, as of now. */
10832 interrupt_input
= 1;
10835 flow_control
= !NILP (flow
);
10838 else if (EQ (meta
, Qt
))
10843 /* Don't let this value be out of range. */
10844 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10850 #ifdef POLL_FOR_INPUT
10851 poll_suppress_count
= 1;
10857 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10858 doc
: /* Return information about the way Emacs currently reads keyboard input.
10859 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10860 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10861 nil, Emacs is using CBREAK mode.
10862 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10863 terminal; this does not apply if Emacs uses interrupt-driven input.
10864 META is t if accepting 8-bit input with 8th bit as Meta flag.
10865 META nil means ignoring the top bit, on the assumption it is parity.
10866 META is neither t nor nil if accepting 8-bit input and using
10867 all 8 bits as the character code.
10868 QUIT is the character Emacs currently uses to quit.
10869 The elements of this list correspond to the arguments of
10870 `set-input-mode'. */)
10873 Lisp_Object val
[4];
10875 val
[0] = interrupt_input
? Qt
: Qnil
;
10876 val
[1] = flow_control
? Qt
: Qnil
;
10877 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10878 XSETFASTINT (val
[3], quit_char
);
10880 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10883 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10884 doc
: /* Return position information for pixel coordinates X and Y.
10885 By default, X and Y are relative to text area of the selected window.
10886 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10887 If optional fourth arg WHOLE is non-nil, X is relative to the left
10888 edge of the window.
10890 The return value is similar to a mouse click position:
10891 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10892 IMAGE (DX . DY) (WIDTH . HEIGHT))
10893 The `posn-' functions access elements of such lists. */)
10894 (x
, y
, frame_or_window
, whole
)
10895 Lisp_Object x
, y
, frame_or_window
, whole
;
10900 if (NILP (frame_or_window
))
10901 frame_or_window
= selected_window
;
10903 if (WINDOWP (frame_or_window
))
10907 CHECK_LIVE_WINDOW (frame_or_window
);
10909 w
= XWINDOW (frame_or_window
);
10910 XSETINT (x
, (XINT (x
)
10911 + WINDOW_LEFT_EDGE_X (w
)
10913 ? window_box_left_offset (w
, TEXT_AREA
)
10915 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10916 frame_or_window
= w
->frame
;
10919 CHECK_LIVE_FRAME (frame_or_window
);
10921 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10924 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10925 doc
: /* Return position information for buffer POS in WINDOW.
10926 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10928 Return nil if position is not visible in window. Otherwise,
10929 the return value is similar to that returned by `event-start' for
10930 a mouse click at the upper left corner of the glyph corresponding
10931 to the given buffer position:
10932 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10933 IMAGE (DX . DY) (WIDTH . HEIGHT))
10934 The `posn-' functions access elements of such lists. */)
10936 Lisp_Object pos
, window
;
10941 window
= selected_window
;
10943 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10946 Lisp_Object x
= XCAR (tem
);
10947 Lisp_Object y
= XCAR (XCDR (tem
));
10949 /* Point invisible due to hscrolling? */
10952 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10960 * Set up a new kboard object with reasonable initial values.
10966 kb
->Voverriding_terminal_local_map
= Qnil
;
10967 kb
->Vlast_command
= Qnil
;
10968 kb
->Vreal_last_command
= Qnil
;
10969 kb
->Vprefix_arg
= Qnil
;
10970 kb
->Vlast_prefix_arg
= Qnil
;
10971 kb
->kbd_queue
= Qnil
;
10972 kb
->kbd_queue_has_data
= 0;
10973 kb
->immediate_echo
= 0;
10974 kb
->echo_string
= Qnil
;
10975 kb
->echo_after_prompt
= -1;
10976 kb
->kbd_macro_buffer
= 0;
10977 kb
->kbd_macro_bufsize
= 0;
10978 kb
->defining_kbd_macro
= Qnil
;
10979 kb
->Vlast_kbd_macro
= Qnil
;
10980 kb
->reference_count
= 0;
10981 kb
->Vsystem_key_alist
= Qnil
;
10982 kb
->system_key_syms
= Qnil
;
10983 kb
->Vdefault_minibuffer_frame
= Qnil
;
10987 * Destroy the contents of a kboard object, but not the object itself.
10988 * We use this just before deleting it, or if we're going to initialize
10989 * it a second time.
10995 if (kb
->kbd_macro_buffer
)
10996 xfree (kb
->kbd_macro_buffer
);
10999 #ifdef MULTI_KBOARD
11001 /* Free KB and memory referenced from it. */
11009 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11012 *kbp
= kb
->next_kboard
;
11014 /* Prevent a dangling reference to KB. */
11015 if (kb
== current_kboard
11016 && FRAMEP (selected_frame
)
11017 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11019 current_kboard
= XFRAME (selected_frame
)->kboard
;
11020 if (current_kboard
== kb
)
11028 #endif /* MULTI_KBOARD */
11033 /* This is correct before outermost invocation of the editor loop */
11034 command_loop_level
= -1;
11035 immediate_quit
= 0;
11036 quit_char
= Ctl ('g');
11037 Vunread_command_events
= Qnil
;
11038 unread_command_char
= -1;
11039 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11041 recent_keys_index
= 0;
11042 kbd_fetch_ptr
= kbd_buffer
;
11043 kbd_store_ptr
= kbd_buffer
;
11045 do_mouse_tracking
= Qnil
;
11048 interrupt_input_blocked
= 0;
11049 interrupt_input_pending
= 0;
11051 /* This means that command_loop_1 won't try to select anything the first
11053 internal_last_event_frame
= Qnil
;
11054 Vlast_event_frame
= internal_last_event_frame
;
11056 #ifdef MULTI_KBOARD
11057 current_kboard
= initial_kboard
;
11059 wipe_kboard (current_kboard
);
11060 init_kboard (current_kboard
);
11062 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
11064 signal (SIGINT
, interrupt_signal
);
11065 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11066 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11067 SIGQUIT and we can't tell which one it will give us. */
11068 signal (SIGQUIT
, interrupt_signal
);
11069 #endif /* HAVE_TERMIO */
11071 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11073 if (!noninteractive
)
11074 signal (SIGIO
, input_available_signal
);
11077 /* Use interrupt input by default, if it works and noninterrupt input
11078 has deficiencies. */
11080 #ifdef INTERRUPT_INPUT
11081 interrupt_input
= 1;
11083 interrupt_input
= 0;
11086 /* Our VMS input only works by interrupts, as of now. */
11088 interrupt_input
= 1;
11094 if (keyboard_init_hook
)
11095 (*keyboard_init_hook
) ();
11097 #ifdef POLL_FOR_INPUT
11098 poll_suppress_count
= 1;
11103 /* This type's only use is in syms_of_keyboard, to initialize the
11104 event header symbols and put properties on them. */
11105 struct event_head
{
11111 struct event_head head_table
[] = {
11112 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11113 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11114 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11115 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11116 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11117 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11118 /* `select-window' should be handled just like `switch-frame'
11119 in read_key_sequence. */
11120 {&Qselect_window
, "select-window", &Qswitch_frame
}
11124 syms_of_keyboard ()
11126 Vpre_help_message
= Qnil
;
11127 staticpro (&Vpre_help_message
);
11129 Vlispy_mouse_stem
= build_string ("mouse");
11130 staticpro (&Vlispy_mouse_stem
);
11133 QCimage
= intern (":image");
11134 staticpro (&QCimage
);
11136 staticpro (&Qhelp_echo
);
11137 Qhelp_echo
= intern ("help-echo");
11139 staticpro (&item_properties
);
11140 item_properties
= Qnil
;
11142 staticpro (&tool_bar_item_properties
);
11143 tool_bar_item_properties
= Qnil
;
11144 staticpro (&tool_bar_items_vector
);
11145 tool_bar_items_vector
= Qnil
;
11147 staticpro (&real_this_command
);
11148 real_this_command
= Qnil
;
11150 Qtimer_event_handler
= intern ("timer-event-handler");
11151 staticpro (&Qtimer_event_handler
);
11153 Qdisabled_command_function
= intern ("disabled-command-function");
11154 staticpro (&Qdisabled_command_function
);
11156 Qself_insert_command
= intern ("self-insert-command");
11157 staticpro (&Qself_insert_command
);
11159 Qforward_char
= intern ("forward-char");
11160 staticpro (&Qforward_char
);
11162 Qbackward_char
= intern ("backward-char");
11163 staticpro (&Qbackward_char
);
11165 Qdisabled
= intern ("disabled");
11166 staticpro (&Qdisabled
);
11168 Qundefined
= intern ("undefined");
11169 staticpro (&Qundefined
);
11171 Qpre_command_hook
= intern ("pre-command-hook");
11172 staticpro (&Qpre_command_hook
);
11174 Qpost_command_hook
= intern ("post-command-hook");
11175 staticpro (&Qpost_command_hook
);
11177 Qdeferred_action_function
= intern ("deferred-action-function");
11178 staticpro (&Qdeferred_action_function
);
11180 Qcommand_hook_internal
= intern ("command-hook-internal");
11181 staticpro (&Qcommand_hook_internal
);
11183 Qfunction_key
= intern ("function-key");
11184 staticpro (&Qfunction_key
);
11185 Qmouse_click
= intern ("mouse-click");
11186 staticpro (&Qmouse_click
);
11187 #if defined (WINDOWSNT) || defined (MAC_OS)
11188 Qlanguage_change
= intern ("language-change");
11189 staticpro (&Qlanguage_change
);
11191 Qdrag_n_drop
= intern ("drag-n-drop");
11192 staticpro (&Qdrag_n_drop
);
11194 Qsave_session
= intern ("save-session");
11195 staticpro (&Qsave_session
);
11198 Qmac_apple_event
= intern ("mac-apple-event");
11199 staticpro (&Qmac_apple_event
);
11202 Qmenu_enable
= intern ("menu-enable");
11203 staticpro (&Qmenu_enable
);
11204 Qmenu_alias
= intern ("menu-alias");
11205 staticpro (&Qmenu_alias
);
11206 QCenable
= intern (":enable");
11207 staticpro (&QCenable
);
11208 QCvisible
= intern (":visible");
11209 staticpro (&QCvisible
);
11210 QChelp
= intern (":help");
11211 staticpro (&QChelp
);
11212 QCfilter
= intern (":filter");
11213 staticpro (&QCfilter
);
11214 QCbutton
= intern (":button");
11215 staticpro (&QCbutton
);
11216 QCkeys
= intern (":keys");
11217 staticpro (&QCkeys
);
11218 QCkey_sequence
= intern (":key-sequence");
11219 staticpro (&QCkey_sequence
);
11220 QCtoggle
= intern (":toggle");
11221 staticpro (&QCtoggle
);
11222 QCradio
= intern (":radio");
11223 staticpro (&QCradio
);
11225 Qmode_line
= intern ("mode-line");
11226 staticpro (&Qmode_line
);
11227 Qvertical_line
= intern ("vertical-line");
11228 staticpro (&Qvertical_line
);
11229 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11230 staticpro (&Qvertical_scroll_bar
);
11231 Qmenu_bar
= intern ("menu-bar");
11232 staticpro (&Qmenu_bar
);
11235 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11236 staticpro (&Qmouse_fixup_help_message
);
11239 Qabove_handle
= intern ("above-handle");
11240 staticpro (&Qabove_handle
);
11241 Qhandle
= intern ("handle");
11242 staticpro (&Qhandle
);
11243 Qbelow_handle
= intern ("below-handle");
11244 staticpro (&Qbelow_handle
);
11245 Qup
= intern ("up");
11247 Qdown
= intern ("down");
11248 staticpro (&Qdown
);
11249 Qtop
= intern ("top");
11251 Qbottom
= intern ("bottom");
11252 staticpro (&Qbottom
);
11253 Qend_scroll
= intern ("end-scroll");
11254 staticpro (&Qend_scroll
);
11255 Qratio
= intern ("ratio");
11256 staticpro (&Qratio
);
11258 Qevent_kind
= intern ("event-kind");
11259 staticpro (&Qevent_kind
);
11260 Qevent_symbol_elements
= intern ("event-symbol-elements");
11261 staticpro (&Qevent_symbol_elements
);
11262 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11263 staticpro (&Qevent_symbol_element_mask
);
11264 Qmodifier_cache
= intern ("modifier-cache");
11265 staticpro (&Qmodifier_cache
);
11267 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11268 staticpro (&Qrecompute_lucid_menubar
);
11269 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11270 staticpro (&Qactivate_menubar_hook
);
11272 Qpolling_period
= intern ("polling-period");
11273 staticpro (&Qpolling_period
);
11275 Qinput_method_function
= intern ("input-method-function");
11276 staticpro (&Qinput_method_function
);
11278 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11279 staticpro (&Qinput_method_exit_on_first_char
);
11280 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11281 staticpro (&Qinput_method_use_echo_area
);
11283 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11284 Fset (Qinput_method_use_echo_area
, Qnil
);
11286 last_point_position_buffer
= Qnil
;
11287 last_point_position_window
= Qnil
;
11290 struct event_head
*p
;
11292 for (p
= head_table
;
11293 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11296 *p
->var
= intern (p
->name
);
11297 staticpro (p
->var
);
11298 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11299 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11303 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11304 staticpro (&button_down_location
);
11305 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11306 staticpro (&mouse_syms
);
11307 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11308 staticpro (&wheel_syms
);
11312 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11314 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11315 for (i
= 0; i
< len
; i
++)
11316 if (modifier_names
[i
])
11317 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11318 staticpro (&modifier_symbols
);
11321 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11322 staticpro (&recent_keys
);
11324 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11325 staticpro (&this_command_keys
);
11327 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11328 staticpro (&raw_keybuf
);
11330 Qextended_command_history
= intern ("extended-command-history");
11331 Fset (Qextended_command_history
, Qnil
);
11332 staticpro (&Qextended_command_history
);
11334 accent_key_syms
= Qnil
;
11335 staticpro (&accent_key_syms
);
11337 func_key_syms
= Qnil
;
11338 staticpro (&func_key_syms
);
11340 drag_n_drop_syms
= Qnil
;
11341 staticpro (&drag_n_drop_syms
);
11343 unread_switch_frame
= Qnil
;
11344 staticpro (&unread_switch_frame
);
11346 internal_last_event_frame
= Qnil
;
11347 staticpro (&internal_last_event_frame
);
11349 read_key_sequence_cmd
= Qnil
;
11350 staticpro (&read_key_sequence_cmd
);
11352 menu_bar_one_keymap_changed_items
= Qnil
;
11353 staticpro (&menu_bar_one_keymap_changed_items
);
11355 menu_bar_items_vector
= Qnil
;
11356 staticpro (&menu_bar_items_vector
);
11358 help_form_saved_window_configs
= Qnil
;
11359 staticpro (&help_form_saved_window_configs
);
11361 defsubr (&Scurrent_idle_time
);
11362 defsubr (&Sevent_convert_list
);
11363 defsubr (&Sread_key_sequence
);
11364 defsubr (&Sread_key_sequence_vector
);
11365 defsubr (&Srecursive_edit
);
11367 defsubr (&Strack_mouse
);
11369 defsubr (&Sinput_pending_p
);
11370 defsubr (&Scommand_execute
);
11371 defsubr (&Srecent_keys
);
11372 defsubr (&Sthis_command_keys
);
11373 defsubr (&Sthis_command_keys_vector
);
11374 defsubr (&Sthis_single_command_keys
);
11375 defsubr (&Sthis_single_command_raw_keys
);
11376 defsubr (&Sreset_this_command_lengths
);
11377 defsubr (&Sclear_this_command_keys
);
11378 defsubr (&Ssuspend_emacs
);
11379 defsubr (&Sabort_recursive_edit
);
11380 defsubr (&Sexit_recursive_edit
);
11381 defsubr (&Srecursion_depth
);
11382 defsubr (&Stop_level
);
11383 defsubr (&Sdiscard_input
);
11384 defsubr (&Sopen_dribble_file
);
11385 defsubr (&Sset_input_mode
);
11386 defsubr (&Scurrent_input_mode
);
11387 defsubr (&Sexecute_extended_command
);
11388 defsubr (&Sposn_at_point
);
11389 defsubr (&Sposn_at_x_y
);
11391 DEFVAR_LISP ("last-command-char", &last_command_char
,
11392 doc
: /* Last input event that was part of a command. */);
11394 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11395 doc
: /* Last input event that was part of a command. */);
11397 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11398 doc
: /* Last input event in a command, except for mouse menu events.
11399 Mouse menus give back keys that don't look like mouse events;
11400 this variable holds the actual mouse event that led to the menu,
11401 so that you can determine whether the command was run by mouse or not. */);
11403 DEFVAR_LISP ("last-input-char", &last_input_char
,
11404 doc
: /* Last input event. */);
11406 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11407 doc
: /* Last input event. */);
11409 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11410 doc
: /* List of events to be read as the command input.
11411 These events are processed first, before actual keyboard input.
11412 Events read from this list are not normally added to `this-command-keys',
11413 as they will already have been added once as they were read for the first time.
11414 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11415 Vunread_command_events
= Qnil
;
11417 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11418 doc
: /* If not -1, an object to be read as next command input event. */);
11420 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11421 doc
: /* List of events to be processed as input by input methods.
11422 These events are processed before `unread-command-events'
11423 and actual keyboard input, but are not given to `input-method-function'. */);
11424 Vunread_post_input_method_events
= Qnil
;
11426 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11427 doc
: /* List of events to be processed as input by input methods.
11428 These events are processed after `unread-command-events', but
11429 before actual keyboard input.
11430 If there's an active input method, the events are given to
11431 `input-method-function'. */);
11432 Vunread_input_method_events
= Qnil
;
11434 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11435 doc
: /* Meta-prefix character code.
11436 Meta-foo as command input turns into this character followed by foo. */);
11437 XSETINT (meta_prefix_char
, 033);
11439 DEFVAR_KBOARD ("last-command", Vlast_command
,
11440 doc
: /* The last command executed.
11441 Normally a symbol with a function definition, but can be whatever was found
11442 in the keymap, or whatever the variable `this-command' was set to by that
11445 The value `mode-exit' is special; it means that the previous command
11446 read an event that told it to exit, and it did so and unread that event.
11447 In other words, the present command is the event that made the previous
11450 The value `kill-region' is special; it means that the previous command
11451 was a kill command. */);
11453 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11454 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11456 DEFVAR_LISP ("this-command", &Vthis_command
,
11457 doc
: /* The command now being executed.
11458 The command can set this variable; whatever is put here
11459 will be in `last-command' during the following command. */);
11460 Vthis_command
= Qnil
;
11462 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11463 doc
: /* The command bound to the current key sequence before remapping.
11464 It equals `this-command' if the original command was not remapped through
11465 any of the active keymaps. Otherwise, the value of `this-command' is the
11466 result of looking up the original command in the active keymaps. */);
11467 Vthis_original_command
= Qnil
;
11469 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11470 doc
: /* *Number of input events between auto-saves.
11471 Zero means disable autosaving due to number of characters typed. */);
11472 auto_save_interval
= 300;
11474 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11475 doc
: /* *Number of seconds idle time before auto-save.
11476 Zero or nil means disable auto-saving due to idleness.
11477 After auto-saving due to this many seconds of idle time,
11478 Emacs also does a garbage collection if that seems to be warranted. */);
11479 XSETFASTINT (Vauto_save_timeout
, 30);
11481 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11482 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11483 The value may be integer or floating point. */);
11484 Vecho_keystrokes
= make_number (1);
11486 DEFVAR_INT ("polling-period", &polling_period
,
11487 doc
: /* *Interval between polling for input during Lisp execution.
11488 The reason for polling is to make C-g work to stop a running program.
11489 Polling is needed only when using X windows and SIGIO does not work.
11490 Polling is automatically disabled in all other cases. */);
11491 polling_period
= 2;
11493 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11494 doc
: /* *Maximum time between mouse clicks to make a double-click.
11495 Measured in milliseconds. The value nil means disable double-click
11496 recognition; t means double-clicks have no time limit and are detected
11497 by position only. */);
11498 Vdouble_click_time
= make_number (500);
11500 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11501 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11502 On window-system frames, value is the number of pixels the mouse may have
11503 moved horizontally or vertically between two clicks to make a double-click.
11504 On non window-system frames, value is interpreted in units of 1/8 characters
11507 This variable is also the threshold for motion of the mouse
11508 to count as a drag. */);
11509 double_click_fuzz
= 3;
11511 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11512 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11513 inhibit_local_menu_bar_menus
= 0;
11515 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11516 doc
: /* Number of complete key sequences read as input so far.
11517 This includes key sequences read from keyboard macros.
11518 The number is effectively the number of interactive command invocations. */);
11519 num_input_keys
= 0;
11521 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11522 doc
: /* Number of input events read from the keyboard so far.
11523 This does not include events generated by keyboard macros. */);
11524 num_nonmacro_input_events
= 0;
11526 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11527 doc
: /* The frame in which the most recently read event occurred.
11528 If the last event came from a keyboard macro, this is set to `macro'. */);
11529 Vlast_event_frame
= Qnil
;
11531 /* This variable is set up in sysdep.c. */
11532 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11533 doc
: /* The ERASE character as set by the user with stty. */);
11535 DEFVAR_LISP ("help-char", &Vhelp_char
,
11536 doc
: /* Character to recognize as meaning Help.
11537 When it is read, do `(eval help-form)', and display result if it's a string.
11538 If the value of `help-form' is nil, this char can be read normally. */);
11539 XSETINT (Vhelp_char
, Ctl ('H'));
11541 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11542 doc
: /* List of input events to recognize as meaning Help.
11543 These work just like the value of `help-char' (see that). */);
11544 Vhelp_event_list
= Qnil
;
11546 DEFVAR_LISP ("help-form", &Vhelp_form
,
11547 doc
: /* Form to execute when character `help-char' is read.
11548 If the form returns a string, that string is displayed.
11549 If `help-form' is nil, the help char is not recognized. */);
11552 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11553 doc
: /* Command to run when `help-char' character follows a prefix key.
11554 This command is used only when there is no actual binding
11555 for that character after that prefix key. */);
11556 Vprefix_help_command
= Qnil
;
11558 DEFVAR_LISP ("top-level", &Vtop_level
,
11559 doc
: /* Form to evaluate when Emacs starts up.
11560 Useful to set before you dump a modified Emacs. */);
11563 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11564 doc
: /* Translate table for keyboard input, or nil.
11565 If non-nil, the value should be a char-table. Each character read
11566 from the keyboard is looked up in this char-table. If the value found
11567 there is non-nil, then it is used instead of the actual input character.
11569 The value can also be a string or vector, but this is considered obsolete.
11570 If it is a string or vector of length N, character codes N and up are left
11571 untranslated. In a vector, an element which is nil means "no translation".
11573 This is applied to the characters supplied to input methods, not their
11574 output. See also `translation-table-for-input'. */);
11575 Vkeyboard_translate_table
= Qnil
;
11577 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11578 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11579 \(Even if the operating system has support for stopping a process.\) */);
11580 cannot_suspend
= 0;
11582 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11583 doc
: /* Non-nil means prompt with menus when appropriate.
11584 This is done when reading from a keymap that has a prompt string,
11585 for elements that have prompt strings.
11586 The menu is displayed on the screen
11587 if X menus were enabled at configuration
11588 time and the previous event was a mouse click prefix key.
11589 Otherwise, menu prompting uses the echo area. */);
11590 menu_prompting
= 1;
11592 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11593 doc
: /* Character to see next line of menu prompt.
11594 Type this character while in a menu prompt to rotate around the lines of it. */);
11595 XSETINT (menu_prompt_more_char
, ' ');
11597 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11598 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11599 Emacs applies the modifiers of the character stored here to each keyboard
11600 character it reads. For example, after evaluating the expression
11601 (setq extra-keyboard-modifiers ?\\C-x)
11602 all input characters will have the control modifier applied to them.
11604 Note that the character ?\\C-@, equivalent to the integer zero, does
11605 not count as a control character; rather, it counts as a character
11606 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11607 cancels any modification. */);
11608 extra_keyboard_modifiers
= 0;
11610 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11611 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11612 The command loop sets this to nil before each command,
11613 and tests the value when the command returns.
11614 Buffer modification stores t in this variable. */);
11615 Vdeactivate_mark
= Qnil
;
11617 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11618 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11619 Vcommand_hook_internal
= Qnil
;
11621 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11622 doc
: /* Normal hook run before each command is executed.
11623 If an unhandled error happens in running this hook,
11624 the hook value is set to nil, since otherwise the error
11625 might happen repeatedly and make Emacs nonfunctional. */);
11626 Vpre_command_hook
= Qnil
;
11628 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11629 doc
: /* Normal hook run after each command is executed.
11630 If an unhandled error happens in running this hook,
11631 the hook value is set to nil, since otherwise the error
11632 might happen repeatedly and make Emacs nonfunctional. */);
11633 Vpost_command_hook
= Qnil
;
11636 DEFVAR_LISP ("echo-area-clear-hook", ...,
11637 doc
: /* Normal hook run when clearing the echo area. */);
11639 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11640 staticpro (&Qecho_area_clear_hook
);
11641 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11643 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11644 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11645 Vlucid_menu_bar_dirty_flag
= Qnil
;
11647 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11648 doc
: /* List of menu bar items to move to the end of the menu bar.
11649 The elements of the list are event types that may have menu bar bindings. */);
11650 Vmenu_bar_final_items
= Qnil
;
11652 DEFVAR_KBOARD ("overriding-terminal-local-map",
11653 Voverriding_terminal_local_map
,
11654 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11655 If this variable is non-nil, it is used as a keymap instead of the
11656 buffer's local map, and the minor mode keymaps and text property keymaps.
11657 It also replaces `overriding-local-map'.
11659 This variable is intended to let commands such as `universal-argument'
11660 set up a different keymap for reading the next command. */);
11662 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11663 doc
: /* Keymap that overrides all other local keymaps.
11664 If this variable is non-nil, it is used as a keymap--replacing the
11665 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11666 Voverriding_local_map
= Qnil
;
11668 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11669 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11670 Otherwise, the menu bar continues to reflect the buffer's local map
11671 and the minor mode maps regardless of `overriding-local-map'. */);
11672 Voverriding_local_map_menu_flag
= Qnil
;
11674 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11675 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11676 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11678 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11679 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11681 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11682 doc
: /* Alist of system-specific X windows key symbols.
11683 Each element should have the form (N . SYMBOL) where N is the
11684 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11685 and SYMBOL is its name. */);
11687 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11688 doc
: /* List of deferred actions to be performed at a later time.
11689 The precise format isn't relevant here; we just check whether it is nil. */);
11690 Vdeferred_action_list
= Qnil
;
11692 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11693 doc
: /* Function to call to handle deferred actions, after each command.
11694 This function is called with no arguments after each command
11695 whenever `deferred-action-list' is non-nil. */);
11696 Vdeferred_action_function
= Qnil
;
11698 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11699 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11700 The value can be a length of time to show the message for.
11701 If the value is non-nil and not a number, we wait 2 seconds. */);
11702 Vsuggest_key_bindings
= Qt
;
11704 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11705 doc
: /* List of active absolute time timers in order of increasing time. */);
11706 Vtimer_list
= Qnil
;
11708 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11709 doc
: /* List of active idle-time timers in order of increasing time. */);
11710 Vtimer_idle_list
= Qnil
;
11712 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11713 doc
: /* If non-nil, the function that implements the current input method.
11714 It's called with one argument, a printing character that was just read.
11715 \(That means a character with code 040...0176.)
11716 Typically this function uses `read-event' to read additional events.
11717 When it does so, it should first bind `input-method-function' to nil
11718 so it will not be called recursively.
11720 The function should return a list of zero or more events
11721 to be used as input. If it wants to put back some events
11722 to be reconsidered, separately, by the input method,
11723 it can add them to the beginning of `unread-command-events'.
11725 The input method function can find in `input-method-previous-method'
11726 the previous echo area message.
11728 The input method function should refer to the variables
11729 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11730 for guidance on what to do. */);
11731 Vinput_method_function
= Qnil
;
11733 DEFVAR_LISP ("input-method-previous-message",
11734 &Vinput_method_previous_message
,
11735 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11736 This variable exists because `read-event' clears the echo area
11737 before running the input method. It is nil if there was no message. */);
11738 Vinput_method_previous_message
= Qnil
;
11740 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11741 doc
: /* If non-nil, the function that implements the display of help.
11742 It's called with one argument, the help string to display. */);
11743 Vshow_help_function
= Qnil
;
11745 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11746 doc
: /* If non-nil, suppress point adjustment after executing a command.
11748 After a command is executed, if point is moved into a region that has
11749 special properties (e.g. composition, display), we adjust point to
11750 the boundary of the region. But, when a command sets this variable to
11751 non-nil, we suppress the point adjustment.
11753 This variable is set to nil before reading a command, and is checked
11754 just after executing the command. */);
11755 Vdisable_point_adjustment
= Qnil
;
11757 DEFVAR_LISP ("global-disable-point-adjustment",
11758 &Vglobal_disable_point_adjustment
,
11759 doc
: /* *If non-nil, always suppress point adjustment.
11761 The default value is nil, in which case, point adjustment are
11762 suppressed only after special commands that set
11763 `disable-point-adjustment' (which see) to non-nil. */);
11764 Vglobal_disable_point_adjustment
= Qnil
;
11766 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11767 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11768 If the value is not a number, such messages don't time out. */);
11769 Vminibuffer_message_timeout
= make_number (2);
11771 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11772 doc
: /* If non-nil, any keyboard input throws to this symbol.
11773 The value of that variable is passed to `quit-flag' and later causes a
11774 peculiar kind of quitting. */);
11775 Vthrow_on_input
= Qnil
;
11777 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
11778 doc
: /* If non-nil, function to output error messages.
11779 The arguments are the error data, a list of the form
11780 (SIGNALED-CONDITIONS . SIGNAL-DATA)
11781 such as just as `condition-case' would bind its variable to,
11782 the context (a string which normally goes at the start of the message),
11783 and the Lisp function within which the error was signaled. */);
11784 Vcommand_error_function
= Qnil
;
11786 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11787 &Venable_disabled_menus_and_buttons
,
11788 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11790 Help functions bind this to allow help on disabled menu items
11791 and tool-bar buttons. */);
11792 Venable_disabled_menus_and_buttons
= Qnil
;
11796 keys_of_keyboard ()
11798 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11799 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11800 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11801 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11802 initial_define_key (meta_map
, 'x', "execute-extended-command");
11804 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11805 "handle-delete-frame");
11806 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11807 current-prefix-arg, as is done in `handle-switch-frame'.
11808 But `handle-switch-frame is not run from the special-map.
11809 Commands from that map are run in a special way that automatically
11810 preserves the prefix-arg. Restoring the prefix arg here is not just
11811 redundant but harmful:
11813 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11814 - after the first prompt, the exit-minibuffer-hook is run which may
11815 iconify a frame and thus push a `iconify-frame' event.
11816 - after running exit-minibuffer-hook, current-prefix-arg is
11817 restored to the non-nil value it had before the prompt.
11818 - we enter the second prompt.
11819 current-prefix-arg is non-nil, prefix-arg is nil.
11820 - before running the first real event, we run the special iconify-frame
11821 event, but we pass the `special' arg to execute-command so
11822 current-prefix-arg and prefix-arg are left untouched.
11823 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11824 - the next key event will have a spuriously non-nil current-prefix-arg. */
11825 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11827 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11829 /* Handling it at such a low-level causes read_key_sequence to get
11830 * confused because it doesn't realize that the current_buffer was
11831 * changed by read_char.
11833 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11834 * "handle-select-window"); */
11835 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11836 "handle-save-session");
11839 /* Mark the pointers in the kboard objects.
11840 Called by the Fgarbage_collector. */
11846 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11848 if (kb
->kbd_macro_buffer
)
11849 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11851 mark_object (kb
->Voverriding_terminal_local_map
);
11852 mark_object (kb
->Vlast_command
);
11853 mark_object (kb
->Vreal_last_command
);
11854 mark_object (kb
->Vprefix_arg
);
11855 mark_object (kb
->Vlast_prefix_arg
);
11856 mark_object (kb
->kbd_queue
);
11857 mark_object (kb
->defining_kbd_macro
);
11858 mark_object (kb
->Vlast_kbd_macro
);
11859 mark_object (kb
->Vsystem_key_alist
);
11860 mark_object (kb
->system_key_syms
);
11861 mark_object (kb
->Vdefault_minibuffer_frame
);
11862 mark_object (kb
->echo_string
);
11865 struct input_event
*event
;
11866 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11868 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11869 event
= kbd_buffer
;
11870 if (event
->kind
!= SELECTION_REQUEST_EVENT
11871 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11873 mark_object (event
->x
);
11874 mark_object (event
->y
);
11876 mark_object (event
->frame_or_window
);
11877 mark_object (event
->arg
);
11882 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11883 (do not change this comment) */