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 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"
36 #include "character.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 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));
703 /* Nonzero means don't try to suspend even if the operating system seems
705 static int cannot_suspend
;
707 extern Lisp_Object Qidentity
, Qonly
;
709 /* Install the string STR as the beginning of the string of echoing,
710 so that it serves as a prompt for the next character.
711 Also start echoing. */
717 current_kboard
->echo_string
= str
;
718 current_kboard
->echo_after_prompt
= SCHARS (str
);
722 /* Add C to the echo string, if echoing is going on.
723 C can be a character, which is printed prettily ("M-C-x" and all that
724 jazz), or a symbol, whose name is printed. */
730 if (current_kboard
->immediate_echo
)
732 int size
= KEY_DESCRIPTION_SIZE
+ 100;
733 char *buffer
= (char *) alloca (size
);
735 Lisp_Object echo_string
;
737 echo_string
= current_kboard
->echo_string
;
739 /* If someone has passed us a composite event, use its head symbol. */
744 ptr
= push_key_description (XINT (c
), ptr
, 1);
746 else if (SYMBOLP (c
))
748 Lisp_Object name
= SYMBOL_NAME (c
);
749 int nbytes
= SBYTES (name
);
751 if (size
- (ptr
- buffer
) < nbytes
)
753 int offset
= ptr
- buffer
;
754 size
= max (2 * size
, size
+ nbytes
);
755 buffer
= (char *) alloca (size
);
756 ptr
= buffer
+ offset
;
759 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
760 STRING_MULTIBYTE (name
), 1);
763 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
766 const char *text
= " (Type ? for further options)";
767 int len
= strlen (text
);
769 if (size
- (ptr
- buffer
) < len
)
771 int offset
= ptr
- buffer
;
773 buffer
= (char *) alloca (size
);
774 ptr
= buffer
+ offset
;
777 bcopy (text
, ptr
, len
);
781 /* Replace a dash from echo_dash with a space, otherwise
782 add a space at the end as a separator between keys. */
783 if (STRINGP (echo_string
)
784 && SCHARS (echo_string
) > 1)
786 Lisp_Object last_char
, prev_char
, idx
;
788 idx
= make_number (SCHARS (echo_string
) - 2);
789 prev_char
= Faref (echo_string
, idx
);
791 idx
= make_number (SCHARS (echo_string
) - 1);
792 last_char
= Faref (echo_string
, idx
);
794 /* We test PREV_CHAR to make sure this isn't the echoing
796 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
797 Faset (echo_string
, idx
, make_number (' '));
799 echo_string
= concat2 (echo_string
, build_string (" "));
801 else if (STRINGP (echo_string
))
802 echo_string
= concat2 (echo_string
, build_string (" "));
804 current_kboard
->echo_string
805 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
811 /* Temporarily add a dash to the end of the echo string if it's not
812 empty, so that it serves as a mini-prompt for the very next character. */
817 /* Do nothing if not echoing at all. */
818 if (NILP (current_kboard
->echo_string
))
821 if (!current_kboard
->immediate_echo
822 && SCHARS (current_kboard
->echo_string
) == 0)
825 /* Do nothing if we just printed a prompt. */
826 if (current_kboard
->echo_after_prompt
827 == SCHARS (current_kboard
->echo_string
))
830 /* Do nothing if we have already put a dash at the end. */
831 if (SCHARS (current_kboard
->echo_string
) > 1)
833 Lisp_Object last_char
, prev_char
, idx
;
835 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
836 prev_char
= Faref (current_kboard
->echo_string
, idx
);
838 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
839 last_char
= Faref (current_kboard
->echo_string
, idx
);
841 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
845 /* Put a dash at the end of the buffer temporarily,
846 but make it go away when the next character is added. */
847 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
852 /* Display the current echo string, and begin echoing if not already
858 if (!current_kboard
->immediate_echo
)
861 current_kboard
->immediate_echo
= 1;
863 for (i
= 0; i
< this_command_key_count
; i
++)
867 /* Set before_command_echo_length to the value that would
868 have been saved before the start of this subcommand in
869 command_loop_1, if we had already been echoing then. */
870 if (i
== this_single_command_key_start
)
871 before_command_echo_length
= echo_length ();
873 c
= XVECTOR (this_command_keys
)->contents
[i
];
874 if (! (EVENT_HAS_PARAMETERS (c
)
875 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
879 /* Set before_command_echo_length to the value that would
880 have been saved before the start of this subcommand in
881 command_loop_1, if we had already been echoing then. */
882 if (this_command_key_count
== this_single_command_key_start
)
883 before_command_echo_length
= echo_length ();
885 /* Put a dash at the end to invite the user to type more. */
890 message3_nolog (current_kboard
->echo_string
,
891 SBYTES (current_kboard
->echo_string
),
892 STRING_MULTIBYTE (current_kboard
->echo_string
));
895 /* Record in what buffer we echoed, and from which kboard. */
896 echo_message_buffer
= echo_area_buffer
[0];
897 echo_kboard
= current_kboard
;
899 if (waiting_for_input
&& !NILP (Vquit_flag
))
900 quit_throw_to_read_char ();
903 /* Turn off echoing, for the start of a new command. */
908 current_kboard
->immediate_echo
= 0;
909 current_kboard
->echo_after_prompt
= -1;
910 current_kboard
->echo_string
= Qnil
;
911 ok_to_echo_at_next_pause
= NULL
;
913 echo_message_buffer
= Qnil
;
916 /* Return the length of the current echo string. */
921 return (STRINGP (current_kboard
->echo_string
)
922 ? SCHARS (current_kboard
->echo_string
)
926 /* Truncate the current echo message to its first LEN chars.
927 This and echo_char get used by read_key_sequence when the user
928 switches frames while entering a key sequence. */
931 echo_truncate (nchars
)
934 if (STRINGP (current_kboard
->echo_string
))
935 current_kboard
->echo_string
936 = Fsubstring (current_kboard
->echo_string
,
937 make_number (0), make_number (nchars
));
938 truncate_echo_area (nchars
);
942 /* Functions for manipulating this_command_keys. */
944 add_command_key (key
)
947 #if 0 /* Not needed after we made Freset_this_command_lengths
948 do the job immediately. */
949 /* If reset-this-command-length was called recently, obey it now.
950 See the doc string of that function for an explanation of why. */
951 if (before_command_restore_flag
)
953 this_command_key_count
= before_command_key_count_1
;
954 if (this_command_key_count
< this_single_command_key_start
)
955 this_single_command_key_start
= this_command_key_count
;
956 echo_truncate (before_command_echo_length_1
);
957 before_command_restore_flag
= 0;
961 if (this_command_key_count
>= ASIZE (this_command_keys
))
962 this_command_keys
= larger_vector (this_command_keys
,
963 2 * ASIZE (this_command_keys
),
966 AREF (this_command_keys
, this_command_key_count
) = key
;
967 ++this_command_key_count
;
974 int count
= SPECPDL_INDEX ();
977 if (command_loop_level
> 0)
979 specbind (Qstandard_output
, Qt
);
980 specbind (Qstandard_input
, Qt
);
983 #ifdef HAVE_X_WINDOWS
984 /* The command loop has started an hourglass timer, so we have to
985 cancel it here, otherwise it will fire because the recursive edit
986 can take some time. Do not check for display_hourglass_p here,
987 because it could already be nil. */
991 /* This function may have been called from a debugger called from
992 within redisplay, for instance by Edebugging a function called
993 from fontification-functions. We want to allow redisplay in
994 the debugging session.
996 The recursive edit is left with a `(throw exit ...)'. The `exit'
997 tag is not caught anywhere in redisplay, i.e. when we leave the
998 recursive edit, the original redisplay leading to the recursive
999 edit will be unwound. The outcome should therefore be safe. */
1000 specbind (Qinhibit_redisplay
, Qnil
);
1003 val
= command_loop ();
1005 Fsignal (Qquit
, Qnil
);
1006 /* Handle throw from read_minibuf when using minibuffer
1007 while it's active but we're in another window. */
1009 xsignal1 (Qerror
, val
);
1011 return unbind_to (count
, Qnil
);
1014 /* When an auto-save happens, record the "time", and don't do again soon. */
1019 last_auto_save
= num_nonmacro_input_events
;
1022 /* Make an auto save happen as soon as possible at command level. */
1025 force_auto_save_soon ()
1027 last_auto_save
= - auto_save_interval
- 1;
1029 record_asynch_buffer_change ();
1032 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1033 doc
: /* Invoke the editor command loop recursively.
1034 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1035 that tells this function to return.
1036 Alternatively, `(throw 'exit t)' makes this function signal an error.
1037 This function is called by the editor initialization to begin editing. */)
1040 int count
= SPECPDL_INDEX ();
1043 /* If we enter while input is blocked, don't lock up here.
1044 This may happen through the debugger during redisplay. */
1045 if (INPUT_BLOCKED_P
)
1048 command_loop_level
++;
1049 update_mode_lines
= 1;
1051 if (command_loop_level
1052 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1053 buffer
= Fcurrent_buffer ();
1057 /* If we leave recursive_edit_1 below with a `throw' for instance,
1058 like it is done in the splash screen display, we have to
1059 make sure that we restore single_kboard as command_loop_1
1060 would have done if it were left normally. */
1061 record_unwind_protect (recursive_edit_unwind
,
1062 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1064 recursive_edit_1 ();
1065 return unbind_to (count
, Qnil
);
1069 recursive_edit_unwind (info
)
1072 if (BUFFERP (XCAR (info
)))
1073 Fset_buffer (XCAR (info
));
1075 if (NILP (XCDR (info
)))
1076 any_kboard_state ();
1078 single_kboard_state ();
1080 command_loop_level
--;
1081 update_mode_lines
= 1;
1090 #if 0 /* Theory: if there's anything in Vunread_command_events,
1091 it will right away be read by read_key_sequence,
1092 and then if we do switch KBOARDS, it will go into the side
1093 queue then. So we don't need to do anything special here -- rms. */
1094 if (CONSP (Vunread_command_events
))
1096 current_kboard
->kbd_queue
1097 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1098 current_kboard
->kbd_queue_has_data
= 1;
1100 Vunread_command_events
= Qnil
;
1106 /* Switch to the single-kboard state, making current_kboard
1107 the only KBOARD from which further input is accepted. */
1110 single_kboard_state ()
1117 /* If we're in single_kboard state for kboard KBOARD,
1121 not_single_kboard_state (kboard
)
1125 if (kboard
== current_kboard
)
1130 /* Maintain a stack of kboards, so other parts of Emacs
1131 can switch temporarily to the kboard of a given frame
1132 and then revert to the previous status. */
1137 struct kboard_stack
*next
;
1140 static struct kboard_stack
*kboard_stack
;
1143 push_frame_kboard (f
)
1147 struct kboard_stack
*p
1148 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1150 p
->next
= kboard_stack
;
1151 p
->kboard
= current_kboard
;
1154 current_kboard
= FRAME_KBOARD (f
);
1162 struct kboard_stack
*p
= kboard_stack
;
1163 current_kboard
= p
->kboard
;
1164 kboard_stack
= p
->next
;
1169 /* Handle errors that are not handled at inner levels
1170 by printing an error message and returning to the editor command loop. */
1176 Lisp_Object old_level
, old_length
;
1177 char macroerror
[50];
1179 #ifdef HAVE_X_WINDOWS
1180 if (display_hourglass_p
)
1181 cancel_hourglass ();
1184 if (!NILP (executing_kbd_macro
))
1186 if (executing_kbd_macro_iterations
== 1)
1187 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1189 sprintf (macroerror
, "After %d kbd macro iterations: ",
1190 executing_kbd_macro_iterations
);
1195 Vstandard_output
= Qt
;
1196 Vstandard_input
= Qt
;
1197 Vexecuting_kbd_macro
= Qnil
;
1198 executing_kbd_macro
= Qnil
;
1199 current_kboard
->Vprefix_arg
= Qnil
;
1200 current_kboard
->Vlast_prefix_arg
= Qnil
;
1203 /* Avoid unquittable loop if data contains a circular list. */
1204 old_level
= Vprint_level
;
1205 old_length
= Vprint_length
;
1206 XSETFASTINT (Vprint_level
, 10);
1207 XSETFASTINT (Vprint_length
, 10);
1208 cmd_error_internal (data
, macroerror
);
1209 Vprint_level
= old_level
;
1210 Vprint_length
= old_length
;
1214 Vinhibit_quit
= Qnil
;
1216 if (command_loop_level
== 0 && minibuf_level
== 0)
1217 any_kboard_state ();
1220 return make_number (0);
1223 /* Take actions on handling an error. DATA is the data that describes
1226 CONTEXT is a C-string containing ASCII characters only which
1227 describes the context in which the error happened. If we need to
1228 generalize CONTEXT to allow multibyte characters, make it a Lisp
1232 cmd_error_internal (data
, context
)
1236 struct frame
*sf
= SELECTED_FRAME ();
1238 /* The immediate context is not interesting for Quits,
1239 since they are asyncronous. */
1240 if (EQ (XCAR (data
), Qquit
))
1241 Vsignaling_function
= Qnil
;
1246 /* Use user's specified output function if any. */
1247 if (!NILP (Vcommand_error_function
))
1248 call3 (Vcommand_error_function
, data
,
1249 build_string (context
? context
: ""),
1250 Vsignaling_function
);
1251 /* If the window system or terminal frame hasn't been initialized
1252 yet, or we're not interactive, write the message to stderr and exit. */
1253 else if (!sf
->glyphs_initialized_p
1254 /* This is the case of the frame dumped with Emacs, when we're
1255 running under a window system. */
1256 || (!NILP (Vwindow_system
)
1257 && !inhibit_window_system
1258 && FRAME_TERMCAP_P (sf
))
1261 print_error_message (data
, Qexternal_debugging_output
,
1262 context
, Vsignaling_function
);
1263 Fterpri (Qexternal_debugging_output
);
1264 Fkill_emacs (make_number (-1));
1268 clear_message (1, 0);
1270 message_log_maybe_newline ();
1273 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1276 Vsignaling_function
= Qnil
;
1279 Lisp_Object
command_loop_1 ();
1280 Lisp_Object
command_loop_2 ();
1281 Lisp_Object
top_level_1 ();
1283 /* Entry to editor-command-loop.
1284 This level has the catches for exiting/returning to editor command loop.
1285 It returns nil to exit recursive edit, t to abort it. */
1290 if (command_loop_level
> 0 || minibuf_level
> 0)
1293 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1294 executing_kbd_macro
= Qnil
;
1300 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1301 /* Reset single_kboard in case top-level set it while
1302 evaluating an -f option, or we are stuck there for some
1304 any_kboard_state ();
1305 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1306 executing_kbd_macro
= Qnil
;
1308 /* End of file in -batch run causes exit here. */
1314 /* Here we catch errors in execution of commands within the
1315 editing loop, and reenter the editing loop.
1316 When there is an error, cmd_error runs and returns a non-nil
1317 value to us. A value of nil means that command_loop_1 itself
1318 returned due to end of file (or end of kbd macro). */
1323 register Lisp_Object val
;
1326 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1327 while (!NILP (val
));
1335 return Feval (Vtop_level
);
1341 /* On entry to the outer level, run the startup file */
1342 if (!NILP (Vtop_level
))
1343 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1344 else if (!NILP (Vpurify_flag
))
1345 message ("Bare impure Emacs (standard Lisp code not loaded)");
1347 message ("Bare Emacs (standard Lisp code not loaded)");
1351 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1352 doc
: /* Exit all recursive editing levels. */)
1355 #ifdef HAVE_X_WINDOWS
1356 if (display_hourglass_p
)
1357 cancel_hourglass ();
1360 /* Unblock input if we enter with input blocked. This may happen if
1361 redisplay traps e.g. during tool-bar update with input blocked. */
1362 while (INPUT_BLOCKED_P
)
1365 return Fthrow (Qtop_level
, Qnil
);
1368 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1369 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1372 if (command_loop_level
> 0 || minibuf_level
> 0)
1373 Fthrow (Qexit
, Qnil
);
1375 error ("No recursive edit is in progress");
1379 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1380 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1383 if (command_loop_level
> 0 || minibuf_level
> 0)
1386 error ("No recursive edit is in progress");
1390 /* This is the actual command reading loop,
1391 sans error-handling encapsulation. */
1393 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1395 void safe_run_hooks
P_ ((Lisp_Object
));
1396 static void adjust_point_for_property
P_ ((int, int));
1398 /* Cancel hourglass from protect_unwind.
1400 #ifdef HAVE_X_WINDOWS
1402 cancel_hourglass_unwind (arg
)
1405 cancel_hourglass ();
1416 Lisp_Object keybuf
[30];
1419 int prev_modiff
= 0;
1420 struct buffer
*prev_buffer
= NULL
;
1422 int was_locked
= single_kboard
;
1424 int already_adjusted
;
1426 current_kboard
->Vprefix_arg
= Qnil
;
1427 current_kboard
->Vlast_prefix_arg
= Qnil
;
1428 Vdeactivate_mark
= Qnil
;
1429 waiting_for_input
= 0;
1433 this_command_key_count
= 0;
1434 this_command_key_count_reset
= 0;
1435 this_single_command_key_start
= 0;
1437 if (NILP (Vmemory_full
))
1439 /* Make sure this hook runs after commands that get errors and
1440 throw to top level. */
1441 /* Note that the value cell will never directly contain nil
1442 if the symbol is a local variable. */
1443 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1444 safe_run_hooks (Qpost_command_hook
);
1446 /* If displaying a message, resize the echo area window to fit
1447 that message's size exactly. */
1448 if (!NILP (echo_area_buffer
[0]))
1449 resize_echo_area_exactly ();
1451 if (!NILP (Vdeferred_action_list
))
1452 safe_run_hooks (Qdeferred_action_function
);
1455 /* Do this after running Vpost_command_hook, for consistency. */
1456 current_kboard
->Vlast_command
= Vthis_command
;
1457 current_kboard
->Vreal_last_command
= real_this_command
;
1461 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1464 /* Make sure the current window's buffer is selected. */
1465 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1466 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1468 /* Display any malloc warning that just came out. Use while because
1469 displaying one warning can cause another. */
1471 while (pending_malloc_warning
)
1472 display_malloc_warning ();
1476 Vdeactivate_mark
= Qnil
;
1478 /* If minibuffer on and echo area in use,
1479 wait a short time and redraw minibuffer. */
1482 && !NILP (echo_area_buffer
[0])
1483 && EQ (minibuf_window
, echo_area_window
)
1484 && NUMBERP (Vminibuffer_message_timeout
))
1486 /* Bind inhibit-quit to t so that C-g gets read in
1487 rather than quitting back to the minibuffer. */
1488 int count
= SPECPDL_INDEX ();
1489 specbind (Qinhibit_quit
, Qt
);
1491 sit_for (Vminibuffer_message_timeout
, 0, 2);
1493 /* Clear the echo area. */
1495 safe_run_hooks (Qecho_area_clear_hook
);
1497 unbind_to (count
, Qnil
);
1499 /* If a C-g came in before, treat it as input now. */
1500 if (!NILP (Vquit_flag
))
1503 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1508 alloca (0); /* Cause a garbage collection now */
1509 /* Since we can free the most stuff here. */
1510 #endif /* C_ALLOCA */
1513 /* Select the frame that the last event came from. Usually,
1514 switch-frame events will take care of this, but if some lisp
1515 code swallows a switch-frame event, we'll fix things up here.
1516 Is this a good idea? */
1517 if (FRAMEP (internal_last_event_frame
)
1518 && !EQ (internal_last_event_frame
, selected_frame
))
1519 Fselect_frame (internal_last_event_frame
);
1521 /* If it has changed current-menubar from previous value,
1522 really recompute the menubar from the value. */
1523 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1524 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1525 call0 (Qrecompute_lucid_menubar
);
1527 before_command_key_count
= this_command_key_count
;
1528 before_command_echo_length
= echo_length ();
1530 Vthis_command
= Qnil
;
1531 real_this_command
= Qnil
;
1532 Vthis_original_command
= Qnil
;
1534 /* Read next key sequence; i gets its length. */
1535 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1538 /* A filter may have run while we were reading the input. */
1539 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1541 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1542 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1546 /* Now we have read a key sequence of length I,
1547 or else I is 0 and we found end of file. */
1549 if (i
== 0) /* End of file -- happens only in */
1550 return Qnil
; /* a kbd macro, at the end. */
1551 /* -1 means read_key_sequence got a menu that was rejected.
1552 Just loop around and read another command. */
1556 this_command_key_count
= 0;
1557 this_command_key_count_reset
= 0;
1558 this_single_command_key_start
= 0;
1562 last_command_char
= keybuf
[i
- 1];
1564 /* If the previous command tried to force a specific window-start,
1565 forget about that, in case this command moves point far away
1566 from that position. But also throw away beg_unchanged and
1567 end_unchanged information in that case, so that redisplay will
1568 update the whole window properly. */
1569 if (!NILP (XWINDOW (selected_window
)->force_start
))
1572 XWINDOW (selected_window
)->force_start
= Qnil
;
1573 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1574 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1577 cmd
= read_key_sequence_cmd
;
1578 if (!NILP (Vexecuting_kbd_macro
))
1580 if (!NILP (Vquit_flag
))
1582 Vexecuting_kbd_macro
= Qt
;
1583 QUIT
; /* Make some noise. */
1584 /* Will return since macro now empty. */
1588 /* Do redisplay processing after this command except in special
1589 cases identified below. */
1590 prev_buffer
= current_buffer
;
1591 prev_modiff
= MODIFF
;
1592 last_point_position
= PT
;
1593 last_point_position_window
= selected_window
;
1594 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1596 /* By default, we adjust point to a boundary of a region that
1597 has such a property that should be treated intangible
1598 (e.g. composition, display). But, some commands will set
1599 this variable differently. */
1600 Vdisable_point_adjustment
= Qnil
;
1602 /* Process filters and timers may have messed with deactivate-mark.
1603 reset it before we execute the command. */
1604 Vdeactivate_mark
= Qnil
;
1606 /* Remap command through active keymaps */
1607 Vthis_original_command
= cmd
;
1611 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1615 /* Execute the command. */
1617 Vthis_command
= cmd
;
1618 real_this_command
= cmd
;
1619 /* Note that the value cell will never directly contain nil
1620 if the symbol is a local variable. */
1621 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1622 safe_run_hooks (Qpre_command_hook
);
1624 already_adjusted
= 0;
1626 if (NILP (Vthis_command
))
1628 /* nil means key is undefined. */
1629 Lisp_Object keys
= Fvector (i
, keybuf
);
1630 keys
= Fkey_description (keys
, Qnil
);
1632 message_with_string ("%s is undefined", keys
, 0);
1633 current_kboard
->defining_kbd_macro
= Qnil
;
1634 update_mode_lines
= 1;
1635 current_kboard
->Vprefix_arg
= Qnil
;
1639 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1641 /* In case we jump to directly_done. */
1642 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1644 /* Recognize some common commands in common situations and
1645 do them directly. */
1646 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1648 struct Lisp_Char_Table
*dp
1649 = window_display_table (XWINDOW (selected_window
));
1650 lose
= FETCH_CHAR (PT_BYTE
);
1652 if (! NILP (Vpost_command_hook
))
1653 /* Put this before calling adjust_point_for_property
1654 so it will only get called once in any case. */
1656 if (current_buffer
== prev_buffer
1657 && last_point_position
!= PT
1658 && NILP (Vdisable_point_adjustment
)
1659 && NILP (Vglobal_disable_point_adjustment
))
1660 adjust_point_for_property (last_point_position
, 0);
1661 already_adjusted
= 1;
1662 if (PT
== last_point_position
+ 1
1664 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1665 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1666 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1667 && (lose
>= 0x20 && lose
< 0x7f)))
1668 : (lose
>= 0x20 && lose
< 0x7f))
1669 /* To extract the case of continuation on
1670 wide-column characters. */
1671 && ASCII_BYTE_P (lose
)
1672 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1674 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1676 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1678 && !windows_or_buffers_changed
1679 && EQ (current_buffer
->selective_display
, Qnil
)
1680 && !detect_input_pending ()
1681 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1682 && NILP (Vexecuting_kbd_macro
))
1683 direct_output_forward_char (1);
1686 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1688 struct Lisp_Char_Table
*dp
1689 = window_display_table (XWINDOW (selected_window
));
1691 lose
= FETCH_CHAR (PT_BYTE
);
1692 if (! NILP (Vpost_command_hook
))
1694 if (current_buffer
== prev_buffer
1695 && last_point_position
!= PT
1696 && NILP (Vdisable_point_adjustment
)
1697 && NILP (Vglobal_disable_point_adjustment
))
1698 adjust_point_for_property (last_point_position
, 0);
1699 already_adjusted
= 1;
1700 if (PT
== last_point_position
- 1
1702 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1703 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1704 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1705 && (lose
>= 0x20 && lose
< 0x7f)))
1706 : (lose
>= 0x20 && lose
< 0x7f))
1707 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1709 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1711 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1713 && !windows_or_buffers_changed
1714 && EQ (current_buffer
->selective_display
, Qnil
)
1715 && !detect_input_pending ()
1716 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1717 && NILP (Vexecuting_kbd_macro
))
1718 direct_output_forward_char (-1);
1721 else if (EQ (Vthis_command
, Qself_insert_command
)
1722 /* Try this optimization only on char keystrokes. */
1723 && NATNUMP (last_command_char
)
1724 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1727 = translate_char (Vtranslation_table_for_input
,
1728 XFASTINT (last_command_char
));
1730 if (NILP (Vexecuting_kbd_macro
)
1731 && !EQ (minibuf_window
, selected_window
))
1733 if (!nonundocount
|| nonundocount
>= 20)
1741 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1743 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1745 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1747 || MODIFF
<= SAVE_MODIFF
1748 || windows_or_buffers_changed
1749 || !EQ (current_buffer
->selective_display
, Qnil
)
1750 || detect_input_pending ()
1751 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1752 || !NILP (Vexecuting_kbd_macro
));
1754 value
= internal_self_insert (c
, 0);
1759 if (! NILP (Vpost_command_hook
))
1760 /* Put this before calling adjust_point_for_property
1761 so it will only get called once in any case. */
1764 /* VALUE == 1 when AFTER-CHANGE functions are
1765 installed which is the case most of the time
1766 because FONT-LOCK installs one. */
1767 if (!lose
&& !value
)
1768 direct_output_for_insert (c
);
1773 /* Here for a command that isn't executed directly */
1776 #ifdef HAVE_X_WINDOWS
1777 int scount
= SPECPDL_INDEX ();
1779 if (display_hourglass_p
1780 && NILP (Vexecuting_kbd_macro
))
1782 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1788 if (NILP (current_kboard
->Vprefix_arg
))
1790 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1792 #ifdef HAVE_X_WINDOWS
1793 /* Do not check display_hourglass_p here, because
1794 Fcommand_execute could change it, but we should cancel
1795 hourglass cursor anyway.
1796 But don't cancel the hourglass within a macro
1797 just because a command in the macro finishes. */
1798 if (NILP (Vexecuting_kbd_macro
))
1799 unbind_to (scount
, Qnil
);
1804 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1806 /* Note that the value cell will never directly contain nil
1807 if the symbol is a local variable. */
1808 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1809 safe_run_hooks (Qpost_command_hook
);
1811 /* If displaying a message, resize the echo area window to fit
1812 that message's size exactly. */
1813 if (!NILP (echo_area_buffer
[0]))
1814 resize_echo_area_exactly ();
1816 if (!NILP (Vdeferred_action_list
))
1817 safe_run_hooks (Qdeferred_action_function
);
1819 /* If there is a prefix argument,
1820 1) We don't want Vlast_command to be ``universal-argument''
1821 (that would be dumb), so don't set Vlast_command,
1822 2) we want to leave echoing on so that the prefix will be
1823 echoed as part of this key sequence, so don't call
1825 3) we want to leave this_command_key_count non-zero, so that
1826 read_char will realize that it is re-reading a character, and
1827 not echo it a second time.
1829 If the command didn't actually create a prefix arg,
1830 but is merely a frame event that is transparent to prefix args,
1831 then the above doesn't apply. */
1832 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1834 current_kboard
->Vlast_command
= Vthis_command
;
1835 current_kboard
->Vreal_last_command
= real_this_command
;
1837 this_command_key_count
= 0;
1838 this_command_key_count_reset
= 0;
1839 this_single_command_key_start
= 0;
1842 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1844 /* Setting transient-mark-mode to `only' is a way of
1845 turning it on for just one command. */
1847 if (EQ (Vtransient_mark_mode
, Qidentity
))
1848 Vtransient_mark_mode
= Qnil
;
1849 if (EQ (Vtransient_mark_mode
, Qonly
))
1850 Vtransient_mark_mode
= Qidentity
;
1852 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1854 /* We could also call `deactivate'mark'. */
1855 if (EQ (Vtransient_mark_mode
, Qlambda
))
1856 Vtransient_mark_mode
= Qnil
;
1859 current_buffer
->mark_active
= Qnil
;
1860 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1863 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1864 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1869 if (current_buffer
== prev_buffer
1870 && last_point_position
!= PT
1871 && NILP (Vdisable_point_adjustment
)
1872 && NILP (Vglobal_disable_point_adjustment
)
1873 && !already_adjusted
)
1874 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1876 /* Install chars successfully executed in kbd macro. */
1878 if (!NILP (current_kboard
->defining_kbd_macro
)
1879 && NILP (current_kboard
->Vprefix_arg
))
1880 finalize_kbd_macro_chars ();
1884 any_kboard_state ();
1889 extern Lisp_Object Qcomposition
, Qdisplay
;
1891 /* Adjust point to a boundary of a region that has such a property
1892 that should be treated intangible. For the moment, we check
1893 `composition', `display' and `invisible' properties.
1894 LAST_PT is the last position of point. */
1896 extern Lisp_Object Qafter_string
, Qbefore_string
;
1897 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1900 adjust_point_for_property (last_pt
, modified
)
1905 Lisp_Object val
, overlay
, tmp
;
1906 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1909 /* FIXME: cycling is probably not necessary because these properties
1910 can't be usefully combined anyway. */
1911 while (check_composition
|| check_display
|| check_invisible
)
1913 if (check_composition
1914 && PT
> BEGV
&& PT
< ZV
1915 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1916 && COMPOSITION_VALID_P (beg
, end
, val
)
1917 && beg
< PT
/* && end > PT <- It's always the case. */
1918 && (last_pt
<= beg
|| last_pt
>= end
))
1921 SET_PT (PT
< last_pt
? beg
: end
);
1922 check_display
= check_invisible
= 1;
1924 check_composition
= 0;
1926 && PT
> BEGV
&& PT
< ZV
1927 && !NILP (val
= get_char_property_and_overlay
1928 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1929 && display_prop_intangible_p (val
)
1930 && (!OVERLAYP (overlay
)
1931 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1932 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1933 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1934 && (beg
< PT
/* && end > PT <- It's always the case. */
1935 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1938 SET_PT (PT
< last_pt
1939 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1941 check_composition
= check_invisible
= 1;
1944 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1946 int inv
, ellipsis
= 0;
1949 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1951 && !NILP (val
= get_char_property_and_overlay
1952 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1953 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1955 ellipsis
= ellipsis
|| inv
> 1
1956 || (OVERLAYP (overlay
)
1957 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1958 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1959 tmp
= Fnext_single_char_property_change
1960 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1961 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1964 && !NILP (val
= get_char_property_and_overlay
1965 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1966 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1968 ellipsis
= ellipsis
|| inv
> 1
1969 || (OVERLAYP (overlay
)
1970 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1971 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1972 tmp
= Fprevious_single_char_property_change
1973 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1974 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1977 /* Move away from the inside area. */
1978 if (beg
< PT
&& end
> PT
)
1980 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1981 /* We haven't moved yet (so we don't need to fear
1982 infinite-looping) and we were outside the range
1983 before (so either end of the range still corresponds
1984 to a move in the right direction): pretend we moved
1985 less than we actually did, so that we still have
1986 more freedom below in choosing which end of the range
1988 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1989 /* We either have moved already or the last point
1990 was already in the range: we don't get to choose
1991 which end of the range we have to go to. */
1992 : (PT
< last_pt
? beg
: end
));
1993 check_composition
= check_display
= 1;
1995 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1996 the point to something other than its argument, due to
1997 point-motion hooks, intangibility, etc. */
1998 xassert (PT
== beg
|| PT
== end
);
2001 /* Pretend the area doesn't exist if the buffer is not
2003 if (!modified
&& !ellipsis
&& beg
< end
)
2005 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2006 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2007 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2008 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2009 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2010 /* We've already moved as far as we can. Trying to go
2011 to the other end would mean moving backwards and thus
2012 could lead to an infinite loop. */
2014 else if (val
= get_pos_property (make_number (PT
),
2016 TEXT_PROP_MEANS_INVISIBLE (val
)
2017 && (val
= get_pos_property
2018 (make_number (PT
== beg
? end
: beg
),
2020 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2021 (check_composition
= check_display
= 1,
2022 SET_PT (PT
== beg
? end
: beg
));
2025 check_invisible
= 0;
2029 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2032 safe_run_hooks_1 (hook
)
2035 if (NILP (Vrun_hooks
))
2037 return call1 (Vrun_hooks
, Vinhibit_quit
);
2040 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2043 safe_run_hooks_error (data
)
2046 Lisp_Object args
[3];
2047 args
[0] = build_string ("Error in %s: %s");
2048 args
[1] = Vinhibit_quit
;
2051 return Fset (Vinhibit_quit
, Qnil
);
2054 /* If we get an error while running the hook, cause the hook variable
2055 to be nil. Also inhibit quits, so that C-g won't cause the hook
2056 to mysteriously evaporate. */
2059 safe_run_hooks (hook
)
2062 int count
= SPECPDL_INDEX ();
2063 specbind (Qinhibit_quit
, hook
);
2065 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2067 unbind_to (count
, Qnil
);
2071 /* Number of seconds between polling for input. This is a Lisp
2072 variable that can be bound. */
2074 EMACS_INT polling_period
;
2076 /* Nonzero means polling for input is temporarily suppressed. */
2078 int poll_suppress_count
;
2080 /* Asynchronous timer for polling. */
2082 struct atimer
*poll_timer
;
2085 #ifdef POLL_FOR_INPUT
2087 /* Poll for input, so what we catch a C-g if it comes in. This
2088 function is called from x_make_frame_visible, see comment
2094 if (interrupt_input_blocked
== 0
2095 && !waiting_for_input
)
2096 read_avail_input (0);
2099 /* Timer callback function for poll_timer. TIMER is equal to
2103 poll_for_input (timer
)
2104 struct atimer
*timer
;
2106 if (poll_suppress_count
== 0)
2108 interrupt_input_pending
= 1;
2110 poll_for_input_1 ();
2114 #endif /* POLL_FOR_INPUT */
2116 /* Begin signals to poll for input, if they are appropriate.
2117 This function is called unconditionally from various places. */
2122 #ifdef POLL_FOR_INPUT
2123 if (read_socket_hook
&& !interrupt_input
)
2125 /* Turn alarm handling on unconditionally. It might have
2126 been turned off in process.c. */
2127 turn_on_atimers (1);
2129 /* If poll timer doesn't exist, are we need one with
2130 a different interval, start a new one. */
2131 if (poll_timer
== NULL
2132 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2134 EMACS_TIME interval
;
2137 cancel_atimer (poll_timer
);
2139 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2140 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2141 poll_for_input
, NULL
);
2144 /* Let the timer's callback function poll for input
2145 if this becomes zero. */
2146 --poll_suppress_count
;
2151 /* Nonzero if we are using polling to handle input asynchronously. */
2154 input_polling_used ()
2156 #ifdef POLL_FOR_INPUT
2157 return read_socket_hook
&& !interrupt_input
;
2163 /* Turn off polling. */
2168 #ifdef POLL_FOR_INPUT
2169 if (read_socket_hook
&& !interrupt_input
)
2170 ++poll_suppress_count
;
2174 /* Set the value of poll_suppress_count to COUNT
2175 and start or stop polling accordingly. */
2178 set_poll_suppress_count (count
)
2181 #ifdef POLL_FOR_INPUT
2182 if (count
== 0 && poll_suppress_count
!= 0)
2184 poll_suppress_count
= 1;
2187 else if (count
!= 0 && poll_suppress_count
== 0)
2191 poll_suppress_count
= count
;
2195 /* Bind polling_period to a value at least N.
2196 But don't decrease it. */
2199 bind_polling_period (n
)
2202 #ifdef POLL_FOR_INPUT
2203 int new = polling_period
;
2208 stop_other_atimers (poll_timer
);
2210 specbind (Qpolling_period
, make_number (new));
2211 /* Start a new alarm with the new period. */
2216 /* Apply the control modifier to CHARACTER. */
2222 /* Save the upper bits here. */
2223 int upper
= c
& ~0177;
2227 /* Everything in the columns containing the upper-case letters
2228 denotes a control character. */
2229 if (c
>= 0100 && c
< 0140)
2233 /* Set the shift modifier for a control char
2234 made from a shifted letter. But only for letters! */
2235 if (oc
>= 'A' && oc
<= 'Z')
2236 c
|= shift_modifier
;
2239 /* The lower-case letters denote control characters too. */
2240 else if (c
>= 'a' && c
<= 'z')
2243 /* Include the bits for control and shift
2244 only if the basic ASCII code can't indicate them. */
2248 /* Replace the high bits. */
2249 c
|= (upper
& ~ctrl_modifier
);
2254 /* Display the help-echo property of the character after the mouse pointer.
2255 Either show it in the echo area, or call show-help-function to display
2256 it by other means (maybe in a tooltip).
2258 If HELP is nil, that means clear the previous help echo.
2260 If HELP is a string, display that string. If HELP is a function,
2261 call it with OBJECT and POS as arguments; the function should
2262 return a help string or nil for none. For all other types of HELP,
2263 evaluate it to obtain a string.
2265 WINDOW is the window in which the help was generated, if any.
2266 It is nil if not in a window.
2268 If OBJECT is a buffer, POS is the position in the buffer where the
2269 `help-echo' text property was found.
2271 If OBJECT is an overlay, that overlay has a `help-echo' property,
2272 and POS is the position in the overlay's buffer under the mouse.
2274 If OBJECT is a string (an overlay string or a string displayed with
2275 the `display' property). POS is the position in that string under
2278 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2279 echo overwrites a keystroke echo currently displayed in the echo
2282 Note: this function may only be called with HELP nil or a string
2283 from X code running asynchronously. */
2286 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2287 Lisp_Object help
, window
, object
, pos
;
2288 int ok_to_overwrite_keystroke_echo
;
2290 if (!NILP (help
) && !STRINGP (help
))
2292 if (FUNCTIONP (help
))
2294 Lisp_Object args
[4];
2299 help
= safe_call (4, args
);
2302 help
= safe_eval (help
);
2304 if (!STRINGP (help
))
2309 if (!noninteractive
&& STRINGP (help
))
2310 help
= call1 (Qmouse_fixup_help_message
, help
);
2313 if (STRINGP (help
) || NILP (help
))
2315 if (!NILP (Vshow_help_function
))
2316 call1 (Vshow_help_function
, help
);
2317 else if (/* Don't overwrite minibuffer contents. */
2318 !MINI_WINDOW_P (XWINDOW (selected_window
))
2319 /* Don't overwrite a keystroke echo. */
2320 && (NILP (echo_message_buffer
)
2321 || ok_to_overwrite_keystroke_echo
)
2322 /* Don't overwrite a prompt. */
2323 && !cursor_in_echo_area
)
2327 int count
= SPECPDL_INDEX ();
2329 if (!help_echo_showing_p
)
2330 Vpre_help_message
= current_message ();
2332 specbind (Qmessage_truncate_lines
, Qt
);
2333 message3_nolog (help
, SBYTES (help
),
2334 STRING_MULTIBYTE (help
));
2335 unbind_to (count
, Qnil
);
2337 else if (STRINGP (Vpre_help_message
))
2339 message3_nolog (Vpre_help_message
,
2340 SBYTES (Vpre_help_message
),
2341 STRING_MULTIBYTE (Vpre_help_message
));
2342 Vpre_help_message
= Qnil
;
2348 help_echo_showing_p
= STRINGP (help
);
2354 /* Input of single characters from keyboard */
2356 Lisp_Object
print_help ();
2357 static Lisp_Object
kbd_buffer_get_event ();
2358 static void record_char ();
2361 static jmp_buf wrong_kboard_jmpbuf
;
2364 #define STOP_POLLING \
2365 do { if (! polling_stopped_here) stop_polling (); \
2366 polling_stopped_here = 1; } while (0)
2368 #define RESUME_POLLING \
2369 do { if (polling_stopped_here) start_polling (); \
2370 polling_stopped_here = 0; } while (0)
2372 /* read a character from the keyboard; call the redisplay if needed */
2373 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2374 -1 means do not do redisplay, but do do autosaving.
2377 /* The arguments MAPS and NMAPS are for menu prompting.
2378 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2380 PREV_EVENT is the previous input event, or nil if we are reading
2381 the first event of a key sequence (or not reading a key sequence).
2382 If PREV_EVENT is t, that is a "magic" value that says
2383 not to run input methods, but in other respects to act as if
2384 not reading a key sequence.
2386 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2387 if we used a mouse menu to read the input, or zero otherwise. If
2388 USED_MOUSE_MENU is null, we don't dereference it.
2390 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2391 specifying the maximum time to wait until. If no input arrives by
2392 that time, stop waiting and return nil.
2394 Value is t if we showed a menu and the user rejected it. */
2397 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2401 Lisp_Object prev_event
;
2402 int *used_mouse_menu
;
2403 EMACS_TIME
*end_time
;
2405 volatile Lisp_Object c
;
2407 jmp_buf local_getcjmp
;
2409 volatile int key_already_recorded
= 0;
2410 Lisp_Object tem
, save
;
2411 volatile Lisp_Object previous_echo_area_message
;
2412 volatile Lisp_Object also_record
;
2413 volatile int reread
;
2414 struct gcpro gcpro1
, gcpro2
;
2415 int polling_stopped_here
= 0;
2419 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2420 before_command_key_count
= this_command_key_count
;
2421 before_command_echo_length
= echo_length ();
2424 previous_echo_area_message
= Qnil
;
2426 GCPRO2 (c
, previous_echo_area_message
);
2431 if (CONSP (Vunread_post_input_method_events
))
2433 c
= XCAR (Vunread_post_input_method_events
);
2434 Vunread_post_input_method_events
2435 = XCDR (Vunread_post_input_method_events
);
2437 /* Undo what read_char_x_menu_prompt did when it unread
2438 additional keys returned by Fx_popup_menu. */
2440 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2448 if (unread_command_char
!= -1)
2450 XSETINT (c
, unread_command_char
);
2451 unread_command_char
= -1;
2457 if (CONSP (Vunread_command_events
))
2459 c
= XCAR (Vunread_command_events
);
2460 Vunread_command_events
= XCDR (Vunread_command_events
);
2462 /* Undo what read_char_x_menu_prompt did when it unread
2463 additional keys returned by Fx_popup_menu. */
2465 && EQ (XCDR (c
), Qdisabled
)
2466 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2469 /* If the queued event is something that used the mouse,
2470 set used_mouse_menu accordingly. */
2472 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2473 *used_mouse_menu
= 1;
2476 goto reread_for_input_method
;
2479 if (CONSP (Vunread_input_method_events
))
2481 c
= XCAR (Vunread_input_method_events
);
2482 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2484 /* Undo what read_char_x_menu_prompt did when it unread
2485 additional keys returned by Fx_popup_menu. */
2487 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2491 goto reread_for_input_method
;
2494 this_command_key_count_reset
= 0;
2496 if (!NILP (Vexecuting_kbd_macro
))
2498 /* We set this to Qmacro; since that's not a frame, nobody will
2499 try to switch frames on us, and the selected window will
2502 Since this event came from a macro, it would be misleading to
2503 leave internal_last_event_frame set to wherever the last
2504 real event came from. Normally, a switch-frame event selects
2505 internal_last_event_frame after each command is read, but
2506 events read from a macro should never cause a new frame to be
2508 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2510 /* Exit the macro if we are at the end.
2511 Also, some things replace the macro with t
2512 to force an early exit. */
2513 if (EQ (Vexecuting_kbd_macro
, Qt
)
2514 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2520 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2521 if (STRINGP (Vexecuting_kbd_macro
)
2522 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2523 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2525 executing_kbd_macro_index
++;
2530 if (!NILP (unread_switch_frame
))
2532 c
= unread_switch_frame
;
2533 unread_switch_frame
= Qnil
;
2535 /* This event should make it into this_command_keys, and get echoed
2536 again, so we do not set `reread'. */
2540 /* if redisplay was requested */
2541 if (commandflag
>= 0)
2543 /* If there is pending input, process any events which are not
2544 user-visible, such as X selection_request events. */
2546 || detect_input_pending_run_timers (0))
2547 swallow_events (0); /* may clear input_pending */
2549 /* Redisplay if no pending input. */
2550 while (!input_pending
)
2552 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2553 redisplay_preserve_echo_area (5);
2558 /* Normal case: no input arrived during redisplay. */
2561 /* Input arrived and pre-empted redisplay.
2562 Process any events which are not user-visible. */
2564 /* If that cleared input_pending, try again to redisplay. */
2568 /* Message turns off echoing unless more keystrokes turn it on again.
2570 The code in 20.x for the condition was
2572 1. echo_area_glyphs && *echo_area_glyphs
2573 2. && echo_area_glyphs != current_kboard->echobuf
2574 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2576 (1) means there's a current message displayed
2578 (2) means it's not the message from echoing from the current
2581 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2582 is set to a non-null value. This is done in read_char and it is
2583 set to echo_area_glyphs after a call to echo_char. That means
2584 ok_to_echo_at_next_pause is either null or
2585 current_kboard->echobuf with the appropriate current_kboard at
2588 So, condition (3) means in clear text ok_to_echo_at_next_pause
2589 must be either null, or the current message isn't from echoing at
2590 all, or it's from echoing from a different kboard than the
2593 if (/* There currently is something in the echo area. */
2594 !NILP (echo_area_buffer
[0])
2595 && (/* And it's either not from echoing. */
2596 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2597 /* Or it's an echo from a different kboard. */
2598 || echo_kboard
!= current_kboard
2599 /* Or we explicitly allow overwriting whatever there is. */
2600 || ok_to_echo_at_next_pause
== NULL
))
2605 /* Try reading a character via menu prompting in the minibuf.
2606 Try this before the sit-for, because the sit-for
2607 would do the wrong thing if we are supposed to do
2608 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2609 after a mouse event so don't try a minibuf menu. */
2611 if (nmaps
> 0 && INTERACTIVE
2612 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2613 /* Don't bring up a menu if we already have another event. */
2614 && NILP (Vunread_command_events
)
2615 && unread_command_char
< 0
2616 && !detect_input_pending_run_timers (0))
2618 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2621 key_already_recorded
= 1;
2626 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2627 We will do that below, temporarily for short sections of code,
2628 when appropriate. local_getcjmp must be in effect
2629 around any call to sit_for or kbd_buffer_get_event;
2630 it *must not* be in effect when we call redisplay. */
2632 if (_setjmp (local_getcjmp
))
2634 /* We must have saved the outer value of getcjmp here,
2635 so restore it now. */
2636 restore_getcjmp (save_jump
);
2637 XSETINT (c
, quit_char
);
2638 internal_last_event_frame
= selected_frame
;
2639 Vlast_event_frame
= internal_last_event_frame
;
2640 /* If we report the quit char as an event,
2641 don't do so more than once. */
2642 if (!NILP (Vinhibit_quit
))
2647 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2648 if (kb
!= current_kboard
)
2650 Lisp_Object link
= kb
->kbd_queue
;
2651 /* We shouldn't get here if we were in single-kboard mode! */
2656 while (CONSP (XCDR (link
)))
2658 if (!NILP (XCDR (link
)))
2662 kb
->kbd_queue
= Fcons (c
, Qnil
);
2664 XSETCDR (link
, Fcons (c
, Qnil
));
2665 kb
->kbd_queue_has_data
= 1;
2666 current_kboard
= kb
;
2667 /* This is going to exit from read_char
2668 so we had better get rid of this frame's stuff. */
2670 longjmp (wrong_kboard_jmpbuf
, 1);
2677 timer_start_idle ();
2679 /* If in middle of key sequence and minibuffer not active,
2680 start echoing if enough time elapses. */
2682 if (minibuf_level
== 0
2684 && !current_kboard
->immediate_echo
2685 && this_command_key_count
> 0
2687 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2688 && NILP (Fzerop (Vecho_keystrokes
))
2689 && (/* No message. */
2690 NILP (echo_area_buffer
[0])
2691 /* Or empty message. */
2692 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2693 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2694 /* Or already echoing from same kboard. */
2695 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2696 /* Or not echoing before and echoing allowed. */
2697 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2699 /* After a mouse event, start echoing right away.
2700 This is because we are probably about to display a menu,
2701 and we don't want to delay before doing so. */
2702 if (EVENT_HAS_PARAMETERS (prev_event
))
2708 save_getcjmp (save_jump
);
2709 restore_getcjmp (local_getcjmp
);
2710 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2711 restore_getcjmp (save_jump
);
2713 && ! CONSP (Vunread_command_events
))
2718 /* Maybe auto save due to number of keystrokes. */
2720 if (commandflag
!= 0
2721 && auto_save_interval
> 0
2722 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2723 && !detect_input_pending_run_timers (0))
2725 Fdo_auto_save (Qnil
, Qnil
);
2726 /* Hooks can actually change some buffers in auto save. */
2730 /* Try reading using an X menu.
2731 This is never confused with reading using the minibuf
2732 because the recursive call of read_char in read_char_minibuf_menu_prompt
2733 does not pass on any keymaps. */
2735 if (nmaps
> 0 && INTERACTIVE
2736 && !NILP (prev_event
)
2737 && EVENT_HAS_PARAMETERS (prev_event
)
2738 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2739 && !EQ (XCAR (prev_event
), Qtool_bar
)
2740 /* Don't bring up a menu if we already have another event. */
2741 && NILP (Vunread_command_events
)
2742 && unread_command_char
< 0)
2744 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2746 /* Now that we have read an event, Emacs is not idle. */
2752 /* Maybe autosave and/or garbage collect due to idleness. */
2754 if (INTERACTIVE
&& NILP (c
))
2756 int delay_level
, buffer_size
;
2758 /* Slow down auto saves logarithmically in size of current buffer,
2759 and garbage collect while we're at it. */
2760 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2761 last_non_minibuf_size
= Z
- BEG
;
2762 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2764 while (buffer_size
> 64)
2765 delay_level
++, buffer_size
-= buffer_size
>> 2;
2766 if (delay_level
< 4) delay_level
= 4;
2767 /* delay_level is 4 for files under around 50k, 7 at 100k,
2768 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2770 /* Auto save if enough time goes by without input. */
2771 if (commandflag
!= 0
2772 && num_nonmacro_input_events
> last_auto_save
2773 && INTEGERP (Vauto_save_timeout
)
2774 && XINT (Vauto_save_timeout
) > 0)
2777 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2779 save_getcjmp (save_jump
);
2780 restore_getcjmp (local_getcjmp
);
2781 tem0
= sit_for (make_number (timeout
), 1, 1);
2782 restore_getcjmp (save_jump
);
2785 && ! CONSP (Vunread_command_events
))
2787 Fdo_auto_save (Qnil
, Qnil
);
2789 /* If we have auto-saved and there is still no input
2790 available, garbage collect if there has been enough
2791 consing going on to make it worthwhile. */
2792 if (!detect_input_pending_run_timers (0)
2793 && consing_since_gc
> gc_cons_threshold
/ 2)
2794 Fgarbage_collect ();
2801 /* If this has become non-nil here, it has been set by a timer
2802 or sentinel or filter. */
2803 if (CONSP (Vunread_command_events
))
2805 c
= XCAR (Vunread_command_events
);
2806 Vunread_command_events
= XCDR (Vunread_command_events
);
2809 /* Read something from current KBOARD's side queue, if possible. */
2813 if (current_kboard
->kbd_queue_has_data
)
2815 if (!CONSP (current_kboard
->kbd_queue
))
2817 c
= XCAR (current_kboard
->kbd_queue
);
2818 current_kboard
->kbd_queue
2819 = XCDR (current_kboard
->kbd_queue
);
2820 if (NILP (current_kboard
->kbd_queue
))
2821 current_kboard
->kbd_queue_has_data
= 0;
2822 input_pending
= readable_events (0);
2823 if (EVENT_HAS_PARAMETERS (c
)
2824 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2825 internal_last_event_frame
= XCAR (XCDR (c
));
2826 Vlast_event_frame
= internal_last_event_frame
;
2831 /* If current_kboard's side queue is empty check the other kboards.
2832 If one of them has data that we have not yet seen here,
2833 switch to it and process the data waiting for it.
2835 Note: if the events queued up for another kboard
2836 have already been seen here, and therefore are not a complete command,
2837 the kbd_queue_has_data field is 0, so we skip that kboard here.
2838 That's to avoid an infinite loop switching between kboards here. */
2839 if (NILP (c
) && !single_kboard
)
2842 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2843 if (kb
->kbd_queue_has_data
)
2845 current_kboard
= kb
;
2846 /* This is going to exit from read_char
2847 so we had better get rid of this frame's stuff. */
2849 longjmp (wrong_kboard_jmpbuf
, 1);
2858 /* Finally, we read from the main queue,
2859 and if that gives us something we can't use yet, we put it on the
2860 appropriate side queue and try again. */
2869 EMACS_GET_TIME (now
);
2870 if (EMACS_TIME_GE (now
, *end_time
))
2874 /* Actually read a character, waiting if necessary. */
2875 save_getcjmp (save_jump
);
2876 restore_getcjmp (local_getcjmp
);
2877 timer_start_idle ();
2878 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2879 restore_getcjmp (save_jump
);
2882 if (! NILP (c
) && (kb
!= current_kboard
))
2884 Lisp_Object link
= kb
->kbd_queue
;
2887 while (CONSP (XCDR (link
)))
2889 if (!NILP (XCDR (link
)))
2893 kb
->kbd_queue
= Fcons (c
, Qnil
);
2895 XSETCDR (link
, Fcons (c
, Qnil
));
2896 kb
->kbd_queue_has_data
= 1;
2900 current_kboard
= kb
;
2901 /* This is going to exit from read_char
2902 so we had better get rid of this frame's stuff. */
2904 longjmp (wrong_kboard_jmpbuf
, 1);
2909 /* Terminate Emacs in batch mode if at eof. */
2910 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2911 Fkill_emacs (make_number (1));
2915 /* Add in any extra modifiers, where appropriate. */
2916 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2917 || ((extra_keyboard_modifiers
& 0177) < ' '
2918 && (extra_keyboard_modifiers
& 0177) != 0))
2919 XSETINT (c
, make_ctrl_char (XINT (c
)));
2921 /* Transfer any other modifier bits directly from
2922 extra_keyboard_modifiers to c. Ignore the actual character code
2923 in the low 16 bits of extra_keyboard_modifiers. */
2924 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2934 if (commandflag
>= 0
2935 && !input_pending
&& !detect_input_pending_run_timers (0))
2943 /* Buffer switch events are only for internal wakeups
2944 so don't show them to the user.
2945 Also, don't record a key if we already did. */
2946 if (BUFFERP (c
) || key_already_recorded
)
2949 /* Process special events within read_char
2950 and loop around to read another event. */
2953 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2958 int was_locked
= single_kboard
;
2960 last_input_char
= c
;
2961 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2963 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2964 /* We stopped being idle for this event; undo that. This
2965 prevents automatic window selection (under
2966 mouse_autoselect_window from acting as a real input event, for
2967 example banishing the mouse under mouse-avoidance-mode. */
2968 timer_resume_idle ();
2970 /* Resume allowing input from any kboard, if that was true before. */
2972 any_kboard_state ();
2977 /* Handle things that only apply to characters. */
2980 /* If kbd_buffer_get_event gave us an EOF, return that. */
2984 if ((STRINGP (Vkeyboard_translate_table
)
2985 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2986 || (VECTORP (Vkeyboard_translate_table
)
2987 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2988 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2992 d
= Faref (Vkeyboard_translate_table
, c
);
2993 /* nil in keyboard-translate-table means no translation. */
2999 /* If this event is a mouse click in the menu bar,
3000 return just menu-bar for now. Modify the mouse click event
3001 so we won't do this twice, then queue it up. */
3002 if (EVENT_HAS_PARAMETERS (c
)
3004 && CONSP (EVENT_START (c
))
3005 && CONSP (XCDR (EVENT_START (c
))))
3009 posn
= POSN_POSN (EVENT_START (c
));
3010 /* Handle menu-bar events:
3011 insert the dummy prefix event `menu-bar'. */
3012 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3014 /* Change menu-bar to (menu-bar) as the event "position". */
3015 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3018 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3023 /* Store these characters into recent_keys, the dribble file if any,
3024 and the keyboard macro being defined, if any. */
3026 if (! NILP (also_record
))
3027 record_char (also_record
);
3029 /* Wipe the echo area.
3030 But first, if we are about to use an input method,
3031 save the echo area contents for it to refer to. */
3033 && ! NILP (Vinput_method_function
)
3034 && (unsigned) XINT (c
) >= ' '
3035 && (unsigned) XINT (c
) != 127
3036 && (unsigned) XINT (c
) < 256)
3038 previous_echo_area_message
= Fcurrent_message ();
3039 Vinput_method_previous_message
= previous_echo_area_message
;
3042 /* Now wipe the echo area, except for help events which do their
3043 own stuff with the echo area. */
3045 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3046 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3048 if (!NILP (echo_area_buffer
[0]))
3049 safe_run_hooks (Qecho_area_clear_hook
);
3050 clear_message (1, 0);
3053 reread_for_input_method
:
3055 /* Pass this to the input method, if appropriate. */
3057 && ! NILP (Vinput_method_function
)
3058 /* Don't run the input method within a key sequence,
3059 after the first event of the key sequence. */
3060 && NILP (prev_event
)
3061 && (unsigned) XINT (c
) >= ' '
3062 && (unsigned) XINT (c
) != 127
3063 && (unsigned) XINT (c
) < 256)
3066 int key_count
, key_count_reset
;
3067 struct gcpro gcpro1
;
3068 int count
= SPECPDL_INDEX ();
3070 /* Save the echo status. */
3071 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3072 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3073 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3074 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3077 if (before_command_restore_flag
)
3079 this_command_key_count
= before_command_key_count_1
;
3080 if (this_command_key_count
< this_single_command_key_start
)
3081 this_single_command_key_start
= this_command_key_count
;
3082 echo_truncate (before_command_echo_length_1
);
3083 before_command_restore_flag
= 0;
3087 /* Save the this_command_keys status. */
3088 key_count
= this_command_key_count
;
3089 key_count_reset
= this_command_key_count_reset
;
3092 keys
= Fcopy_sequence (this_command_keys
);
3097 /* Clear out this_command_keys. */
3098 this_command_key_count
= 0;
3099 this_command_key_count_reset
= 0;
3101 /* Now wipe the echo area. */
3102 if (!NILP (echo_area_buffer
[0]))
3103 safe_run_hooks (Qecho_area_clear_hook
);
3104 clear_message (1, 0);
3107 /* If we are not reading a key sequence,
3108 never use the echo area. */
3111 specbind (Qinput_method_use_echo_area
, Qt
);
3114 /* Call the input method. */
3115 tem
= call1 (Vinput_method_function
, c
);
3117 tem
= unbind_to (count
, tem
);
3119 /* Restore the saved echoing state
3120 and this_command_keys state. */
3121 this_command_key_count
= key_count
;
3122 this_command_key_count_reset
= key_count_reset
;
3124 this_command_keys
= keys
;
3127 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3128 current_kboard
->echo_string
= saved_echo_string
;
3129 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3130 if (saved_immediate_echo
)
3135 /* The input method can return no events. */
3138 /* Bring back the previous message, if any. */
3139 if (! NILP (previous_echo_area_message
))
3140 message_with_string ("%s", previous_echo_area_message
, 0);
3143 /* It returned one event or more. */
3145 Vunread_post_input_method_events
3146 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3151 /* Display help if not echoing. */
3152 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3154 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3155 Lisp_Object help
, object
, position
, window
, tem
;
3157 tem
= Fcdr (XCDR (c
));
3160 window
= Fcar (tem
);
3162 object
= Fcar (tem
);
3164 position
= Fcar (tem
);
3166 show_help_echo (help
, window
, object
, position
, 0);
3168 /* We stopped being idle for this event; undo that. */
3169 timer_resume_idle ();
3173 if (! reread
|| this_command_key_count
== 0
3174 || this_command_key_count_reset
)
3177 /* Don't echo mouse motion events. */
3178 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3179 && NILP (Fzerop (Vecho_keystrokes
))
3180 && ! (EVENT_HAS_PARAMETERS (c
)
3181 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3184 if (! NILP (also_record
))
3185 echo_char (also_record
);
3186 /* Once we reread a character, echoing can happen
3187 the next time we pause to read a new one. */
3188 ok_to_echo_at_next_pause
= current_kboard
;
3191 /* Record this character as part of the current key. */
3192 add_command_key (c
);
3193 if (! NILP (also_record
))
3194 add_command_key (also_record
);
3197 last_input_char
= c
;
3200 /* Process the help character specially if enabled */
3201 if (!NILP (Vhelp_form
) && help_char_p (c
))
3204 count
= SPECPDL_INDEX ();
3206 record_unwind_protect (Fset_window_configuration
,
3207 Fcurrent_window_configuration (Qnil
));
3209 tem0
= Feval (Vhelp_form
);
3211 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3215 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3216 while (BUFFERP (c
));
3217 /* Remove the help from the frame */
3218 unbind_to (count
, Qnil
);
3221 if (EQ (c
, make_number (040)))
3225 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3226 while (BUFFERP (c
));
3235 /* Record a key that came from a mouse menu.
3236 Record it for echoing, for this-command-keys, and so on. */
3242 /* Wipe the echo area. */
3243 clear_message (1, 0);
3248 before_command_key_count
= this_command_key_count
;
3249 before_command_echo_length
= echo_length ();
3252 /* Don't echo mouse motion events. */
3253 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3254 && NILP (Fzerop (Vecho_keystrokes
)))
3258 /* Once we reread a character, echoing can happen
3259 the next time we pause to read a new one. */
3260 ok_to_echo_at_next_pause
= 0;
3263 /* Record this character as part of the current key. */
3264 add_command_key (c
);
3266 /* Re-reading in the middle of a command */
3267 last_input_char
= c
;
3271 /* Return 1 if should recognize C as "the help character". */
3279 if (EQ (c
, Vhelp_char
))
3281 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3282 if (EQ (c
, XCAR (tail
)))
3287 /* Record the input event C in various ways. */
3295 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3297 /* To avoid filling recent_keys with help-echo and mouse-movement
3298 events, we filter out repeated help-echo events, only store the
3299 first and last in a series of mouse-movement events, and don't
3300 store repeated help-echo events which are only separated by
3301 mouse-movement events. */
3303 Lisp_Object ev1
, ev2
, ev3
;
3306 if ((ix1
= recent_keys_index
- 1) < 0)
3307 ix1
= NUM_RECENT_KEYS
- 1;
3308 ev1
= AREF (recent_keys
, ix1
);
3310 if ((ix2
= ix1
- 1) < 0)
3311 ix2
= NUM_RECENT_KEYS
- 1;
3312 ev2
= AREF (recent_keys
, ix2
);
3314 if ((ix3
= ix2
- 1) < 0)
3315 ix3
= NUM_RECENT_KEYS
- 1;
3316 ev3
= AREF (recent_keys
, ix3
);
3318 if (EQ (XCAR (c
), Qhelp_echo
))
3320 /* Don't record `help-echo' in recent_keys unless it shows some help
3321 message, and a different help than the previously recorded
3323 Lisp_Object help
, last_help
;
3325 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3326 if (!STRINGP (help
))
3328 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3329 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3331 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3332 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3333 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3335 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3336 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3337 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3338 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3341 else if (EQ (XCAR (c
), Qmouse_movement
))
3343 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3344 So additional mouse movement events replace the last element. */
3345 Lisp_Object last_window
, window
;
3347 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3348 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3349 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3350 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3351 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3353 ASET (recent_keys
, ix1
, c
);
3359 store_kbd_macro_char (c
);
3364 ASET (recent_keys
, recent_keys_index
, c
);
3365 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3366 recent_keys_index
= 0;
3368 else if (recorded
< 0)
3370 /* We need to remove one or two events from recent_keys.
3371 To do this, we simply put nil at those events and move the
3372 recent_keys_index backwards over those events. Usually,
3373 users will never see those nil events, as they will be
3374 overwritten by the command keys entered to see recent_keys
3377 while (recorded
++ < 0 && total_keys
> 0)
3379 if (total_keys
< NUM_RECENT_KEYS
)
3381 if (--recent_keys_index
< 0)
3382 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3383 ASET (recent_keys
, recent_keys_index
, Qnil
);
3387 num_nonmacro_input_events
++;
3389 /* Write c to the dribble file. If c is a lispy event, write
3390 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3391 If you, dear reader, have a better idea, you've got the source. :-) */
3396 if (XUINT (c
) < 0x100)
3397 putc (XINT (c
), dribble
);
3399 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3403 Lisp_Object dribblee
;
3405 /* If it's a structured event, take the event header. */
3406 dribblee
= EVENT_HEAD (c
);
3408 if (SYMBOLP (dribblee
))
3410 putc ('<', dribble
);
3411 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3412 SBYTES (SYMBOL_NAME (dribblee
)),
3414 putc ('>', dribble
);
3426 struct buffer
*old
= current_buffer
;
3427 Fprinc (object
, Qnil
);
3428 set_buffer_internal (XBUFFER (Vstandard_output
));
3429 call0 (intern ("help-mode"));
3430 set_buffer_internal (old
);
3434 /* Copy out or in the info on where C-g should throw to.
3435 This is used when running Lisp code from within get_char,
3436 in case get_char is called recursively.
3437 See read_process_output. */
3443 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3447 restore_getcjmp (temp
)
3450 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3455 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3456 of this function. */
3459 tracking_off (old_value
)
3460 Lisp_Object old_value
;
3462 do_mouse_tracking
= old_value
;
3463 if (NILP (old_value
))
3465 /* Redisplay may have been preempted because there was input
3466 available, and it assumes it will be called again after the
3467 input has been processed. If the only input available was
3468 the sort that we have just disabled, then we need to call
3470 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
3472 redisplay_preserve_echo_area (6);
3473 get_input_pending (&input_pending
,
3474 READABLE_EVENTS_DO_TIMERS_NOW
);
3480 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3481 doc
: /* Evaluate BODY with mouse movement events enabled.
3482 Within a `track-mouse' form, mouse motion generates input events that
3483 you can read with `read-event'.
3484 Normally, mouse motion is ignored.
3485 usage: (track-mouse BODY ...) */)
3489 int count
= SPECPDL_INDEX ();
3492 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3494 do_mouse_tracking
= Qt
;
3496 val
= Fprogn (args
);
3497 return unbind_to (count
, val
);
3500 /* If mouse has moved on some frame, return one of those frames.
3501 Return 0 otherwise. */
3506 Lisp_Object tail
, frame
;
3508 FOR_EACH_FRAME (tail
, frame
)
3510 if (XFRAME (frame
)->mouse_moved
)
3511 return XFRAME (frame
);
3517 #endif /* HAVE_MOUSE */
3519 /* Low level keyboard/mouse input.
3520 kbd_buffer_store_event places events in kbd_buffer, and
3521 kbd_buffer_get_event retrieves them. */
3523 /* Return true iff there are any events in the queue that read-char
3524 would return. If this returns false, a read-char would block. */
3526 readable_events (flags
)
3529 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3532 /* If the buffer contains only FOCUS_IN_EVENT events, and
3533 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3534 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3536 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3537 #ifdef USE_TOOLKIT_SCROLL_BARS
3538 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3542 struct input_event
*event
;
3544 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3551 #ifdef USE_TOOLKIT_SCROLL_BARS
3552 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3554 event
->kind
== FOCUS_IN_EVENT
)
3555 #ifdef USE_TOOLKIT_SCROLL_BARS
3556 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3557 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3558 && event
->part
== scroll_bar_handle
3559 && event
->modifiers
== 0)
3564 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3567 while (event
!= kbd_store_ptr
);
3574 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3575 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3580 if (current_kboard
->kbd_queue_has_data
)
3586 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3587 if (kb
->kbd_queue_has_data
)
3593 /* Set this for debugging, to have a way to get out */
3598 event_to_kboard (event
)
3599 struct input_event
*event
;
3602 frame
= event
->frame_or_window
;
3604 frame
= XCAR (frame
);
3605 else if (WINDOWP (frame
))
3606 frame
= WINDOW_FRAME (XWINDOW (frame
));
3608 /* There are still some events that don't set this field.
3609 For now, just ignore the problem.
3610 Also ignore dead frames here. */
3611 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3614 return FRAME_KBOARD (XFRAME (frame
));
3619 Lisp_Object Vthrow_on_input
;
3621 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3624 kbd_buffer_store_event (event
)
3625 register struct input_event
*event
;
3627 kbd_buffer_store_event_hold (event
, 0);
3630 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3632 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3633 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3634 Else, if EVENT is a quit event, store the quit event
3635 in HOLD_QUIT, and return (thus ignoring further events).
3637 This is used in read_avail_input to postpone the processing
3638 of the quit event until all subsequent input events have been
3639 parsed (and discarded).
3643 kbd_buffer_store_event_hold (event
, hold_quit
)
3644 register struct input_event
*event
;
3645 struct input_event
*hold_quit
;
3647 if (event
->kind
== NO_EVENT
)
3650 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3653 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3655 register int c
= event
->code
& 0377;
3657 if (event
->modifiers
& ctrl_modifier
)
3658 c
= make_ctrl_char (c
);
3660 c
|= (event
->modifiers
3661 & (meta_modifier
| alt_modifier
3662 | hyper_modifier
| super_modifier
));
3668 struct input_event
*sp
;
3671 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3672 kb
!= current_kboard
))
3675 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3676 Fcons (make_number (c
), Qnil
));
3677 kb
->kbd_queue_has_data
= 1;
3678 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3680 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3683 if (event_to_kboard (sp
) == kb
)
3685 sp
->kind
= NO_EVENT
;
3686 sp
->frame_or_window
= Qnil
;
3696 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3700 /* If this results in a quit_char being returned to Emacs as
3701 input, set Vlast_event_frame properly. If this doesn't
3702 get returned to Emacs as an event, the next event read
3703 will set Vlast_event_frame again, so this is safe to do. */
3707 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3709 focus
= event
->frame_or_window
;
3710 internal_last_event_frame
= focus
;
3711 Vlast_event_frame
= focus
;
3714 last_event_timestamp
= event
->timestamp
;
3715 interrupt_signal (0 /* dummy */);
3719 if (c
&& c
== stop_character
)
3725 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3726 Just ignore the second one. */
3727 else if (event
->kind
== BUFFER_SWITCH_EVENT
3728 && kbd_fetch_ptr
!= kbd_store_ptr
3729 && ((kbd_store_ptr
== kbd_buffer
3730 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3731 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3734 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3735 kbd_store_ptr
= kbd_buffer
;
3737 /* Don't let the very last slot in the buffer become full,
3738 since that would make the two pointers equal,
3739 and that is indistinguishable from an empty buffer.
3740 Discard the event if it would fill the last slot. */
3741 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3743 *kbd_store_ptr
= *event
;
3747 /* If we're inside while-no-input, and this event qualifies
3748 as input, set quit-flag to cause an interrupt. */
3749 if (!NILP (Vthrow_on_input
)
3750 && event
->kind
!= FOCUS_IN_EVENT
3751 && event
->kind
!= HELP_EVENT
3752 && event
->kind
!= DEICONIFY_EVENT
)
3754 Vquit_flag
= Vthrow_on_input
;
3755 /* If we're inside a function that wants immediate quits,
3757 if (immediate_quit
&& NILP (Vinhibit_quit
))
3767 /* Put an input event back in the head of the event queue. */
3770 kbd_buffer_unget_event (event
)
3771 register struct input_event
*event
;
3773 if (kbd_fetch_ptr
== kbd_buffer
)
3774 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3776 /* Don't let the very last slot in the buffer become full, */
3777 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3780 *kbd_fetch_ptr
= *event
;
3785 /* Generate HELP_EVENT input_events in BUFP which has room for
3786 SIZE events. If there's not enough room in BUFP, ignore this
3789 HELP is the help form.
3791 FRAME is the frame on which the help is generated. OBJECT is the
3792 Lisp object where the help was found (a buffer, a string, an
3793 overlay, or nil if neither from a string nor from a buffer. POS is
3794 the position within OBJECT where the help was found.
3796 Value is the number of input_events generated. */
3799 gen_help_event (help
, frame
, window
, object
, pos
)
3800 Lisp_Object help
, frame
, object
, window
;
3803 struct input_event event
;
3807 event
.kind
= HELP_EVENT
;
3808 event
.frame_or_window
= frame
;
3810 event
.x
= WINDOWP (window
) ? window
: frame
;
3813 kbd_buffer_store_event (&event
);
3817 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3820 kbd_buffer_store_help_event (frame
, help
)
3821 Lisp_Object frame
, help
;
3823 struct input_event event
;
3825 event
.kind
= HELP_EVENT
;
3826 event
.frame_or_window
= frame
;
3831 kbd_buffer_store_event (&event
);
3835 /* Discard any mouse events in the event buffer by setting them to
3838 discard_mouse_events ()
3840 struct input_event
*sp
;
3841 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3843 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3846 if (sp
->kind
== MOUSE_CLICK_EVENT
3847 || sp
->kind
== WHEEL_EVENT
3849 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3851 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3853 sp
->kind
= NO_EVENT
;
3859 /* Return non-zero if there are any real events waiting in the event
3860 buffer, not counting `NO_EVENT's.
3862 If DISCARD is non-zero, discard NO_EVENT events at the front of
3863 the input queue, possibly leaving the input queue empty if there
3864 are no real input events. */
3867 kbd_buffer_events_waiting (discard
)
3870 struct input_event
*sp
;
3872 for (sp
= kbd_fetch_ptr
;
3873 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3876 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3883 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3887 /* Clear input event EVENT. */
3891 struct input_event
*event
;
3893 event
->kind
= NO_EVENT
;
3897 /* Read one event from the event buffer, waiting if necessary.
3898 The value is a Lisp object representing the event.
3899 The value is nil for an event that should be ignored,
3900 or that was handled here.
3901 We always read and discard one event. */
3904 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
3906 int *used_mouse_menu
;
3907 EMACS_TIME
*end_time
;
3916 *kbp
= current_kboard
;
3920 /* Wait until there is input available. */
3923 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3926 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3930 /* If the quit flag is set, then read_char will return
3931 quit_char, so that counts as "available input." */
3932 if (!NILP (Vquit_flag
))
3933 quit_throw_to_read_char ();
3935 /* One way or another, wait until input is available; then, if
3936 interrupt handlers have not read it, read it now. */
3939 wait_for_kbd_input ();
3941 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3945 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3948 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3953 EMACS_TIME duration
;
3954 EMACS_GET_TIME (duration
);
3955 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3956 if (EMACS_TIME_NEG_P (duration
))
3959 wait_reading_process_output (EMACS_SECS (duration
),
3960 EMACS_USECS (duration
),
3961 -1, 1, Qnil
, NULL
, 0);
3964 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3966 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3967 /* Pass 1 for EXPECT since we just waited to have input. */
3968 read_avail_input (1);
3969 #endif /* not VMS */
3972 if (CONSP (Vunread_command_events
))
3975 first
= XCAR (Vunread_command_events
);
3976 Vunread_command_events
= XCDR (Vunread_command_events
);
3977 *kbp
= current_kboard
;
3981 /* At this point, we know that there is a readable event available
3982 somewhere. If the event queue is empty, then there must be a
3983 mouse movement enabled and available. */
3984 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3986 struct input_event
*event
;
3988 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3992 last_event_timestamp
= event
->timestamp
;
3995 *kbp
= event_to_kboard (event
);
3997 *kbp
= current_kboard
; /* Better than returning null ptr? */
3999 *kbp
= &the_only_kboard
;
4004 /* These two kinds of events get special handling
4005 and don't actually appear to the command loop.
4006 We return nil for them. */
4007 if (event
->kind
== SELECTION_REQUEST_EVENT
4008 || event
->kind
== SELECTION_CLEAR_EVENT
)
4011 struct input_event copy
;
4013 /* Remove it from the buffer before processing it,
4014 since otherwise swallow_events will see it
4015 and process it again. */
4017 kbd_fetch_ptr
= event
+ 1;
4018 input_pending
= readable_events (0);
4019 x_handle_selection_event (©
);
4021 /* We're getting selection request events, but we don't have
4027 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4028 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4030 /* Make an event (delete-frame (FRAME)). */
4031 obj
= Fcons (event
->frame_or_window
, Qnil
);
4032 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4033 kbd_fetch_ptr
= event
+ 1;
4036 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4037 else if (event
->kind
== ICONIFY_EVENT
)
4039 /* Make an event (iconify-frame (FRAME)). */
4040 obj
= Fcons (event
->frame_or_window
, Qnil
);
4041 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4042 kbd_fetch_ptr
= event
+ 1;
4044 else if (event
->kind
== DEICONIFY_EVENT
)
4046 /* Make an event (make-frame-visible (FRAME)). */
4047 obj
= Fcons (event
->frame_or_window
, Qnil
);
4048 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4049 kbd_fetch_ptr
= event
+ 1;
4052 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4054 /* The value doesn't matter here; only the type is tested. */
4055 XSETBUFFER (obj
, current_buffer
);
4056 kbd_fetch_ptr
= event
+ 1;
4058 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4059 || defined (USE_GTK)
4060 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4062 kbd_fetch_ptr
= event
+ 1;
4063 input_pending
= readable_events (0);
4064 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4065 x_activate_menubar (XFRAME (event
->frame_or_window
));
4068 #if defined (WINDOWSNT) || defined (MAC_OS)
4069 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4072 /* Make an event (language-change (KEY_SCRIPT)). */
4073 obj
= Fcons (make_number (event
->code
), Qnil
);
4075 /* Make an event (language-change (FRAME CHARSET LCID)). */
4076 obj
= Fcons (event
->frame_or_window
, Qnil
);
4078 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4079 kbd_fetch_ptr
= event
+ 1;
4082 else if (event
->kind
== SAVE_SESSION_EVENT
)
4084 obj
= Fcons (Qsave_session
, Qnil
);
4085 kbd_fetch_ptr
= event
+ 1;
4087 /* Just discard these, by returning nil.
4088 With MULTI_KBOARD, these events are used as placeholders
4089 when we need to randomly delete events from the queue.
4090 (They shouldn't otherwise be found in the buffer,
4091 but on some machines it appears they do show up
4092 even without MULTI_KBOARD.) */
4093 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4094 mouse events during a popup-menu call. */
4095 else if (event
->kind
== NO_EVENT
)
4096 kbd_fetch_ptr
= event
+ 1;
4097 else if (event
->kind
== HELP_EVENT
)
4099 Lisp_Object object
, position
, help
, frame
, window
;
4101 frame
= event
->frame_or_window
;
4102 object
= event
->arg
;
4103 position
= make_number (event
->code
);
4106 clear_event (event
);
4108 kbd_fetch_ptr
= event
+ 1;
4109 if (!WINDOWP (window
))
4111 obj
= Fcons (Qhelp_echo
,
4112 list5 (frame
, help
, window
, object
, position
));
4114 else if (event
->kind
== FOCUS_IN_EVENT
)
4116 /* Notification of a FocusIn event. The frame receiving the
4117 focus is in event->frame_or_window. Generate a
4118 switch-frame event if necessary. */
4119 Lisp_Object frame
, focus
;
4121 frame
= event
->frame_or_window
;
4122 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4126 if (!EQ (frame
, internal_last_event_frame
)
4127 && !EQ (frame
, selected_frame
))
4128 obj
= make_lispy_switch_frame (frame
);
4129 internal_last_event_frame
= frame
;
4130 kbd_fetch_ptr
= event
+ 1;
4134 /* If this event is on a different frame, return a switch-frame this
4135 time, and leave the event in the queue for next time. */
4139 frame
= event
->frame_or_window
;
4141 frame
= XCAR (frame
);
4142 else if (WINDOWP (frame
))
4143 frame
= WINDOW_FRAME (XWINDOW (frame
));
4145 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4149 if (! EQ (frame
, internal_last_event_frame
)
4150 && !EQ (frame
, selected_frame
))
4151 obj
= make_lispy_switch_frame (frame
);
4152 internal_last_event_frame
= frame
;
4154 /* If we didn't decide to make a switch-frame event, go ahead
4155 and build a real event from the queue entry. */
4159 obj
= make_lispy_event (event
);
4161 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4162 || defined (USE_GTK)
4163 /* If this was a menu selection, then set the flag to inhibit
4164 writing to last_nonmenu_event. Don't do this if the event
4165 we're returning is (menu-bar), though; that indicates the
4166 beginning of the menu sequence, and we might as well leave
4167 that as the `event with parameters' for this selection. */
4169 && !EQ (event
->frame_or_window
, event
->arg
)
4170 && (event
->kind
== MENU_BAR_EVENT
4171 || event
->kind
== TOOL_BAR_EVENT
))
4172 *used_mouse_menu
= 1;
4175 /* Wipe out this event, to catch bugs. */
4176 clear_event (event
);
4177 kbd_fetch_ptr
= event
+ 1;
4182 /* Try generating a mouse motion event. */
4183 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4185 FRAME_PTR f
= some_mouse_moved ();
4186 Lisp_Object bar_window
;
4187 enum scroll_bar_part part
;
4191 *kbp
= current_kboard
;
4192 /* Note that this uses F to determine which display to look at.
4193 If there is no valid info, it does not store anything
4194 so x remains nil. */
4196 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4200 /* Decide if we should generate a switch-frame event. Don't
4201 generate switch-frame events for motion outside of all Emacs
4207 frame
= FRAME_FOCUS_FRAME (f
);
4209 XSETFRAME (frame
, f
);
4211 if (! EQ (frame
, internal_last_event_frame
)
4212 && !EQ (frame
, selected_frame
))
4213 obj
= make_lispy_switch_frame (frame
);
4214 internal_last_event_frame
= frame
;
4217 /* If we didn't decide to make a switch-frame event, go ahead and
4218 return a mouse-motion event. */
4219 if (!NILP (x
) && NILP (obj
))
4220 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4222 #endif /* HAVE_MOUSE */
4224 /* We were promised by the above while loop that there was
4225 something for us to read! */
4228 input_pending
= readable_events (0);
4230 Vlast_event_frame
= internal_last_event_frame
;
4235 /* Process any events that are not user-visible,
4236 then return, without reading any user-visible events. */
4239 swallow_events (do_display
)
4244 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4246 struct input_event
*event
;
4248 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4252 last_event_timestamp
= event
->timestamp
;
4254 /* These two kinds of events get special handling
4255 and don't actually appear to the command loop. */
4256 if (event
->kind
== SELECTION_REQUEST_EVENT
4257 || event
->kind
== SELECTION_CLEAR_EVENT
)
4260 struct input_event copy
;
4262 /* Remove it from the buffer before processing it,
4263 since otherwise swallow_events called recursively could see it
4264 and process it again. */
4266 kbd_fetch_ptr
= event
+ 1;
4267 input_pending
= readable_events (0);
4268 x_handle_selection_event (©
);
4270 /* We're getting selection request events, but we don't have
4279 old_timers_run
= timers_run
;
4280 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4282 if (timers_run
!= old_timers_run
&& do_display
)
4283 redisplay_preserve_echo_area (7);
4286 /* Record the start of when Emacs is idle,
4287 for the sake of running idle-time timers. */
4294 /* If we are already in the idle state, do nothing. */
4295 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4298 EMACS_GET_TIME (timer_idleness_start_time
);
4300 timer_last_idleness_start_time
= timer_idleness_start_time
;
4302 /* Mark all idle-time timers as once again candidates for running. */
4303 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4307 timer
= XCAR (timers
);
4309 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4311 XVECTOR (timer
)->contents
[0] = Qnil
;
4315 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4320 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4323 /* Resume idle timer from last idle start time. */
4326 timer_resume_idle ()
4328 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4331 timer_idleness_start_time
= timer_last_idleness_start_time
;
4334 /* This is only for debugging. */
4335 struct input_event last_timer_event
;
4337 /* Check whether a timer has fired. To prevent larger problems we simply
4338 disregard elements that are not proper timers. Do not make a circular
4339 timer list for the time being.
4341 Returns the number of seconds to wait until the next timer fires. If a
4342 timer is triggering now, return zero seconds.
4343 If no timer is active, return -1 seconds.
4345 If a timer is ripe, we run it, with quitting turned off.
4347 DO_IT_NOW is now ignored. It used to mean that we should
4348 run the timer directly instead of queueing a timer-event.
4349 Now we always run timers directly. */
4352 timer_check (do_it_now
)
4355 EMACS_TIME nexttime
;
4356 EMACS_TIME now
, idleness_now
;
4357 Lisp_Object timers
, idle_timers
, chosen_timer
;
4358 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4360 EMACS_SET_SECS (nexttime
, -1);
4361 EMACS_SET_USECS (nexttime
, -1);
4363 /* Always consider the ordinary timers. */
4364 timers
= Vtimer_list
;
4365 /* Consider the idle timers only if Emacs is idle. */
4366 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4367 idle_timers
= Vtimer_idle_list
;
4370 chosen_timer
= Qnil
;
4371 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4373 if (CONSP (timers
) || CONSP (idle_timers
))
4375 EMACS_GET_TIME (now
);
4376 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4377 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4380 while (CONSP (timers
) || CONSP (idle_timers
))
4382 Lisp_Object
*vector
;
4383 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4384 EMACS_TIME timer_time
, idle_timer_time
;
4385 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4387 /* Skip past invalid timers and timers already handled. */
4390 timer
= XCAR (timers
);
4391 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4393 timers
= XCDR (timers
);
4396 vector
= XVECTOR (timer
)->contents
;
4398 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4399 || !INTEGERP (vector
[3])
4400 || ! NILP (vector
[0]))
4402 timers
= XCDR (timers
);
4406 if (!NILP (idle_timers
))
4408 timer
= XCAR (idle_timers
);
4409 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4411 idle_timers
= XCDR (idle_timers
);
4414 vector
= XVECTOR (timer
)->contents
;
4416 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4417 || !INTEGERP (vector
[3])
4418 || ! NILP (vector
[0]))
4420 idle_timers
= XCDR (idle_timers
);
4425 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4426 based on the next ordinary timer.
4427 TIMER_DIFFERENCE is the distance in time from NOW to when
4428 this timer becomes ripe (negative if it's already ripe). */
4431 timer
= XCAR (timers
);
4432 vector
= XVECTOR (timer
)->contents
;
4433 EMACS_SET_SECS (timer_time
,
4434 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4435 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4436 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4439 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4440 based on the next idle timer. */
4441 if (!NILP (idle_timers
))
4443 idle_timer
= XCAR (idle_timers
);
4444 vector
= XVECTOR (idle_timer
)->contents
;
4445 EMACS_SET_SECS (idle_timer_time
,
4446 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4447 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4448 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4451 /* Decide which timer is the next timer,
4452 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4453 Also step down the list where we found that timer. */
4455 if (! NILP (timers
) && ! NILP (idle_timers
))
4458 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4459 if (EMACS_TIME_NEG_P (temp
))
4461 chosen_timer
= timer
;
4462 timers
= XCDR (timers
);
4463 difference
= timer_difference
;
4467 chosen_timer
= idle_timer
;
4468 idle_timers
= XCDR (idle_timers
);
4469 difference
= idle_timer_difference
;
4472 else if (! NILP (timers
))
4474 chosen_timer
= timer
;
4475 timers
= XCDR (timers
);
4476 difference
= timer_difference
;
4480 chosen_timer
= idle_timer
;
4481 idle_timers
= XCDR (idle_timers
);
4482 difference
= idle_timer_difference
;
4484 vector
= XVECTOR (chosen_timer
)->contents
;
4486 /* If timer is ripe, run it if it hasn't been run. */
4487 if (EMACS_TIME_NEG_P (difference
)
4488 || (EMACS_SECS (difference
) == 0
4489 && EMACS_USECS (difference
) == 0))
4491 if (NILP (vector
[0]))
4493 int was_locked
= single_kboard
;
4494 int count
= SPECPDL_INDEX ();
4495 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4497 /* Mark the timer as triggered to prevent problems if the lisp
4498 code fails to reschedule it right. */
4501 specbind (Qinhibit_quit
, Qt
);
4503 call1 (Qtimer_event_handler
, chosen_timer
);
4504 Vdeactivate_mark
= old_deactivate_mark
;
4506 unbind_to (count
, Qnil
);
4508 /* Resume allowing input from any kboard, if that was true before. */
4510 any_kboard_state ();
4512 /* Since we have handled the event,
4513 we don't need to tell the caller to wake up and do it. */
4517 /* When we encounter a timer that is still waiting,
4518 return the amount of time to wait before it is ripe. */
4525 /* No timers are pending in the future. */
4526 /* Return 0 if we generated an event, and -1 if not. */
4531 /* Caches for modify_event_symbol. */
4532 static Lisp_Object accent_key_syms
;
4533 static Lisp_Object func_key_syms
;
4534 static Lisp_Object mouse_syms
;
4535 static Lisp_Object wheel_syms
;
4536 static Lisp_Object drag_n_drop_syms
;
4538 /* This is a list of keysym codes for special "accent" characters.
4539 It parallels lispy_accent_keys. */
4541 static int lispy_accent_codes
[] =
4543 #ifdef XK_dead_circumflex
4548 #ifdef XK_dead_grave
4553 #ifdef XK_dead_tilde
4558 #ifdef XK_dead_diaeresis
4563 #ifdef XK_dead_macron
4568 #ifdef XK_dead_degree
4573 #ifdef XK_dead_acute
4578 #ifdef XK_dead_cedilla
4583 #ifdef XK_dead_breve
4588 #ifdef XK_dead_ogonek
4593 #ifdef XK_dead_caron
4598 #ifdef XK_dead_doubleacute
4599 XK_dead_doubleacute
,
4603 #ifdef XK_dead_abovedot
4608 #ifdef XK_dead_abovering
4618 #ifdef XK_dead_belowdot
4623 #ifdef XK_dead_voiced_sound
4624 XK_dead_voiced_sound
,
4628 #ifdef XK_dead_semivoiced_sound
4629 XK_dead_semivoiced_sound
,
4645 /* This is a list of Lisp names for special "accent" characters.
4646 It parallels lispy_accent_codes. */
4648 static char *lispy_accent_keys
[] =
4666 "dead-voiced-sound",
4667 "dead-semivoiced-sound",
4673 #define FUNCTION_KEY_OFFSET 0x0
4675 char *lispy_function_keys
[] =
4679 0, /* VK_LBUTTON 0x01 */
4680 0, /* VK_RBUTTON 0x02 */
4681 "cancel", /* VK_CANCEL 0x03 */
4682 0, /* VK_MBUTTON 0x04 */
4684 0, 0, 0, /* 0x05 .. 0x07 */
4686 "backspace", /* VK_BACK 0x08 */
4687 "tab", /* VK_TAB 0x09 */
4689 0, 0, /* 0x0A .. 0x0B */
4691 "clear", /* VK_CLEAR 0x0C */
4692 "return", /* VK_RETURN 0x0D */
4694 0, 0, /* 0x0E .. 0x0F */
4696 0, /* VK_SHIFT 0x10 */
4697 0, /* VK_CONTROL 0x11 */
4698 0, /* VK_MENU 0x12 */
4699 "pause", /* VK_PAUSE 0x13 */
4700 "capslock", /* VK_CAPITAL 0x14 */
4702 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4704 "escape", /* VK_ESCAPE 0x1B */
4706 0, 0, 0, 0, /* 0x1C .. 0x1F */
4708 0, /* VK_SPACE 0x20 */
4709 "prior", /* VK_PRIOR 0x21 */
4710 "next", /* VK_NEXT 0x22 */
4711 "end", /* VK_END 0x23 */
4712 "home", /* VK_HOME 0x24 */
4713 "left", /* VK_LEFT 0x25 */
4714 "up", /* VK_UP 0x26 */
4715 "right", /* VK_RIGHT 0x27 */
4716 "down", /* VK_DOWN 0x28 */
4717 "select", /* VK_SELECT 0x29 */
4718 "print", /* VK_PRINT 0x2A */
4719 "execute", /* VK_EXECUTE 0x2B */
4720 "snapshot", /* VK_SNAPSHOT 0x2C */
4721 "insert", /* VK_INSERT 0x2D */
4722 "delete", /* VK_DELETE 0x2E */
4723 "help", /* VK_HELP 0x2F */
4725 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4727 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4729 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4731 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4733 0, 0, 0, 0, 0, 0, 0, 0, 0,
4734 0, 0, 0, 0, 0, 0, 0, 0, 0,
4735 0, 0, 0, 0, 0, 0, 0, 0,
4737 "lwindow", /* VK_LWIN 0x5B */
4738 "rwindow", /* VK_RWIN 0x5C */
4739 "apps", /* VK_APPS 0x5D */
4741 0, 0, /* 0x5E .. 0x5F */
4743 "kp-0", /* VK_NUMPAD0 0x60 */
4744 "kp-1", /* VK_NUMPAD1 0x61 */
4745 "kp-2", /* VK_NUMPAD2 0x62 */
4746 "kp-3", /* VK_NUMPAD3 0x63 */
4747 "kp-4", /* VK_NUMPAD4 0x64 */
4748 "kp-5", /* VK_NUMPAD5 0x65 */
4749 "kp-6", /* VK_NUMPAD6 0x66 */
4750 "kp-7", /* VK_NUMPAD7 0x67 */
4751 "kp-8", /* VK_NUMPAD8 0x68 */
4752 "kp-9", /* VK_NUMPAD9 0x69 */
4753 "kp-multiply", /* VK_MULTIPLY 0x6A */
4754 "kp-add", /* VK_ADD 0x6B */
4755 "kp-separator", /* VK_SEPARATOR 0x6C */
4756 "kp-subtract", /* VK_SUBTRACT 0x6D */
4757 "kp-decimal", /* VK_DECIMAL 0x6E */
4758 "kp-divide", /* VK_DIVIDE 0x6F */
4759 "f1", /* VK_F1 0x70 */
4760 "f2", /* VK_F2 0x71 */
4761 "f3", /* VK_F3 0x72 */
4762 "f4", /* VK_F4 0x73 */
4763 "f5", /* VK_F5 0x74 */
4764 "f6", /* VK_F6 0x75 */
4765 "f7", /* VK_F7 0x76 */
4766 "f8", /* VK_F8 0x77 */
4767 "f9", /* VK_F9 0x78 */
4768 "f10", /* VK_F10 0x79 */
4769 "f11", /* VK_F11 0x7A */
4770 "f12", /* VK_F12 0x7B */
4771 "f13", /* VK_F13 0x7C */
4772 "f14", /* VK_F14 0x7D */
4773 "f15", /* VK_F15 0x7E */
4774 "f16", /* VK_F16 0x7F */
4775 "f17", /* VK_F17 0x80 */
4776 "f18", /* VK_F18 0x81 */
4777 "f19", /* VK_F19 0x82 */
4778 "f20", /* VK_F20 0x83 */
4779 "f21", /* VK_F21 0x84 */
4780 "f22", /* VK_F22 0x85 */
4781 "f23", /* VK_F23 0x86 */
4782 "f24", /* VK_F24 0x87 */
4784 0, 0, 0, 0, /* 0x88 .. 0x8B */
4785 0, 0, 0, 0, /* 0x8C .. 0x8F */
4787 "kp-numlock", /* VK_NUMLOCK 0x90 */
4788 "scroll", /* VK_SCROLL 0x91 */
4790 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4791 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4792 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4793 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4794 "kp-end", /* VK_NUMPAD_END 0x96 */
4795 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4796 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4797 "kp-up", /* VK_NUMPAD_UP 0x99 */
4798 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4799 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4800 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4801 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4803 0, 0, /* 0x9E .. 0x9F */
4806 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4807 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4808 * No other API or message will distinguish left and right keys this way.
4812 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4813 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4814 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4815 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4816 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4822 "attn", /* VK_ATTN 0xF6 */
4823 "crsel", /* VK_CRSEL 0xF7 */
4824 "exsel", /* VK_EXSEL 0xF8 */
4825 "ereof", /* VK_EREOF 0xF9 */
4826 "play", /* VK_PLAY 0xFA */
4827 "zoom", /* VK_ZOOM 0xFB */
4828 "noname", /* VK_NONAME 0xFC */
4829 "pa1", /* VK_PA1 0xFD */
4830 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4834 #else /* not HAVE_NTGUI */
4836 /* This should be dealt with in XTread_socket now, and that doesn't
4837 depend on the client system having the Kana syms defined. See also
4838 the XK_kana_A case below. */
4841 static char *lispy_kana_keys
[] =
4843 /* X Keysym value */
4844 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4845 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4846 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4847 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4848 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4849 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4850 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4851 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4852 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4853 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4854 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4855 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4856 "kana-i", "kana-u", "kana-e", "kana-o",
4857 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4858 "prolongedsound", "kana-A", "kana-I", "kana-U",
4859 "kana-E", "kana-O", "kana-KA", "kana-KI",
4860 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4861 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4862 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4863 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4864 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4865 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4866 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4867 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4868 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4869 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4870 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4871 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4873 #endif /* XK_kana_A */
4876 #define FUNCTION_KEY_OFFSET 0xff00
4878 /* You'll notice that this table is arranged to be conveniently
4879 indexed by X Windows keysym values. */
4880 static char *lispy_function_keys
[] =
4882 /* X Keysym value */
4884 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4885 "backspace", "tab", "linefeed", "clear",
4887 0, 0, 0, "pause", /* 0xff10...1f */
4888 0, 0, 0, 0, 0, 0, 0, "escape",
4890 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4891 "romaji", "hiragana", "katakana", "hiragana-katakana",
4892 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4893 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4894 "eisu-toggle", /* 0xff30...3f */
4895 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4896 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4898 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4899 "down", "prior", "next", "end",
4900 "begin", 0, 0, 0, 0, 0, 0, 0,
4901 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4912 "break", /* 0xff6b */
4915 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4916 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4917 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4918 0, 0, 0, 0, 0, 0, 0, 0,
4919 "kp-tab", /* 0xff89 */
4921 "kp-enter", /* 0xff8d */
4923 "kp-f1", /* 0xff91 */
4927 "kp-home", /* 0xff95 */
4932 "kp-prior", /* kp-page-up */
4933 "kp-next", /* kp-page-down */
4939 0, 0, 0, 0, 0, 0, 0, 0, 0,
4940 "kp-multiply", /* 0xffaa */
4945 "kp-divide", /* 0xffaf */
4946 "kp-0", /* 0xffb0 */
4947 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4950 "kp-equal", /* 0xffbd */
4951 "f1", /* 0xffbe */ /* IsFunctionKey */
4953 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4954 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4955 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4956 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4957 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4958 0, 0, 0, 0, 0, 0, 0, 0,
4959 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4960 0, 0, 0, 0, 0, 0, 0, "delete"
4963 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4964 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4966 static char *iso_lispy_function_keys
[] =
4968 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4969 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4970 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4971 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4972 "iso-lefttab", /* 0xfe20 */
4973 "iso-move-line-up", "iso-move-line-down",
4974 "iso-partial-line-up", "iso-partial-line-down",
4975 "iso-partial-space-left", "iso-partial-space-right",
4976 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4977 "iso-release-margin-left", "iso-release-margin-right",
4978 "iso-release-both-margins",
4979 "iso-fast-cursor-left", "iso-fast-cursor-right",
4980 "iso-fast-cursor-up", "iso-fast-cursor-down",
4981 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4982 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4985 #endif /* not HAVE_NTGUI */
4987 Lisp_Object Vlispy_mouse_stem
;
4989 static char *lispy_wheel_names
[] =
4991 "wheel-up", "wheel-down"
4994 /* drag-n-drop events are generated when a set of selected files are
4995 dragged from another application and dropped onto an Emacs window. */
4996 static char *lispy_drag_n_drop_names
[] =
5001 /* Scroll bar parts. */
5002 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5003 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5004 Lisp_Object Qtop
, Qratio
;
5006 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5007 Lisp_Object
*scroll_bar_parts
[] = {
5008 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5009 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5012 /* User signal events. */
5013 Lisp_Object Qusr1_signal
, Qusr2_signal
;
5015 Lisp_Object
*lispy_user_signals
[] =
5017 &Qusr1_signal
, &Qusr2_signal
5021 /* A vector, indexed by button number, giving the down-going location
5022 of currently depressed buttons, both scroll bar and non-scroll bar.
5024 The elements have the form
5025 (BUTTON-NUMBER MODIFIER-MASK . REST)
5026 where REST is the cdr of a position as it would be reported in the event.
5028 The make_lispy_event function stores positions here to tell the
5029 difference between click and drag events, and to store the starting
5030 location to be included in drag events. */
5032 static Lisp_Object button_down_location
;
5034 /* Information about the most recent up-going button event: Which
5035 button, what location, and what time. */
5037 static int last_mouse_button
;
5038 static int last_mouse_x
;
5039 static int last_mouse_y
;
5040 static unsigned long button_down_time
;
5042 /* The maximum time between clicks to make a double-click, or Qnil to
5043 disable double-click detection, or Qt for no time limit. */
5045 Lisp_Object Vdouble_click_time
;
5047 /* Maximum number of pixels the mouse may be moved between clicks
5048 to make a double-click. */
5050 EMACS_INT double_click_fuzz
;
5052 /* The number of clicks in this multiple-click. */
5054 int double_click_count
;
5056 /* Return position of a mouse click or wheel event */
5059 make_lispy_position (f
, x
, y
, time
)
5065 enum window_part part
;
5066 Lisp_Object posn
= Qnil
;
5067 Lisp_Object extra_info
= Qnil
;
5070 /* Set `window' to the window under frame pixel coordinates (x,y) */
5072 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5073 &part
, &wx
, &wy
, 0);
5077 if (WINDOWP (window
))
5079 /* It's a click in window window at frame coordinates (x,y) */
5080 struct window
*w
= XWINDOW (window
);
5081 Lisp_Object string_info
= Qnil
;
5082 int textpos
= -1, rx
= -1, ry
= -1;
5083 int dx
= -1, dy
= -1;
5084 int width
= -1, height
= -1;
5085 Lisp_Object object
= Qnil
;
5087 /* Set event coordinates to window-relative coordinates
5088 for constructing the Lisp event below. */
5092 if (part
== ON_TEXT
)
5094 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5096 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5098 /* Mode line or header line. Look for a string under
5099 the mouse that may have a `local-map' property. */
5103 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5105 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5106 &object
, &dx
, &dy
, &width
, &height
);
5107 if (STRINGP (string
))
5108 string_info
= Fcons (string
, make_number (charpos
));
5109 if (w
== XWINDOW (selected_window
))
5112 textpos
= XMARKER (w
->pointm
)->charpos
;
5114 else if (part
== ON_VERTICAL_BORDER
)
5116 posn
= Qvertical_line
;
5121 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5126 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5128 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5129 &object
, &dx
, &dy
, &width
, &height
);
5130 if (STRINGP (string
))
5131 string_info
= Fcons (string
, make_number (charpos
));
5132 if (part
== ON_LEFT_MARGIN
)
5135 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5137 else if (part
== ON_LEFT_FRINGE
)
5139 posn
= Qleft_fringe
;
5142 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5144 : window_box_width (w
, LEFT_MARGIN_AREA
));
5147 else if (part
== ON_RIGHT_FRINGE
)
5149 posn
= Qright_fringe
;
5152 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5153 + window_box_width (w
, TEXT_AREA
)
5154 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5155 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5161 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5162 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5167 Lisp_Object string2
, object2
= Qnil
;
5168 struct display_pos p
;
5170 int width2
, height2
;
5171 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5172 &object2
, &dx2
, &dy2
,
5174 textpos
= CHARPOS (p
.pos
);
5175 if (rx
< 0) rx
= wx
;
5176 if (ry
< 0) ry
= wy
;
5177 if (dx
< 0) dx
= dx2
;
5178 if (dy
< 0) dy
= dy2
;
5179 if (width
< 0) width
= width2
;
5180 if (height
< 0) height
= height2
;
5184 posn
= make_number (textpos
);
5185 if (STRINGP (string2
))
5186 string_info
= Fcons (string2
,
5187 make_number (CHARPOS (p
.string_pos
)));
5193 #ifdef HAVE_WINDOW_SYSTEM
5194 if (IMAGEP (object
))
5196 Lisp_Object image_map
, hotspot
;
5197 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5199 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5201 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5202 posn
= XCAR (hotspot
);
5207 extra_info
= Fcons (object
,
5208 Fcons (Fcons (make_number (dx
),
5210 Fcons (Fcons (make_number (width
),
5211 make_number (height
)),
5215 extra_info
= Fcons (string_info
,
5216 Fcons (make_number (textpos
),
5217 Fcons (Fcons (make_number (rx
),
5223 XSETFRAME (window
, f
);
5228 XSETFASTINT (*x
, 0);
5229 XSETFASTINT (*y
, 0);
5232 return Fcons (window
,
5234 Fcons (Fcons (*x
, *y
),
5235 Fcons (make_number (time
),
5239 /* Given a struct input_event, build the lisp event which represents
5240 it. If EVENT is 0, build a mouse movement event from the mouse
5241 movement buffer, which should have a movement event in it.
5243 Note that events must be passed to this function in the order they
5244 are received; this function stores the location of button presses
5245 in order to build drag events when the button is released. */
5248 make_lispy_event (event
)
5249 struct input_event
*event
;
5253 switch (SWITCH_ENUM_CAST (event
->kind
))
5255 /* A simple keystroke. */
5256 case ASCII_KEYSTROKE_EVENT
:
5258 Lisp_Object lispy_c
;
5259 int c
= event
->code
& 0377;
5260 /* Turn ASCII characters into control characters
5262 if (event
->modifiers
& ctrl_modifier
)
5263 c
= make_ctrl_char (c
);
5265 /* Add in the other modifier bits. We took care of ctrl_modifier
5266 just above, and the shift key was taken care of by the X code,
5267 and applied to control characters by make_ctrl_char. */
5268 c
|= (event
->modifiers
5269 & (meta_modifier
| alt_modifier
5270 | hyper_modifier
| super_modifier
));
5271 /* Distinguish Shift-SPC from SPC. */
5272 if ((event
->code
& 0377) == 040
5273 && event
->modifiers
& shift_modifier
)
5274 c
|= shift_modifier
;
5275 button_down_time
= 0;
5276 XSETFASTINT (lispy_c
, c
);
5280 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5282 Lisp_Object lispy_c
;
5283 int c
= event
->code
;
5285 /* Add in the other modifier bits. We took care of ctrl_modifier
5286 just above, and the shift key was taken care of by the X code,
5287 and applied to control characters by make_ctrl_char. */
5288 c
|= (event
->modifiers
5289 & (meta_modifier
| alt_modifier
5290 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5291 /* What about the `shift' modifier ? */
5292 button_down_time
= 0;
5293 XSETFASTINT (lispy_c
, c
);
5297 /* A function key. The symbol may need to have modifier prefixes
5299 case NON_ASCII_KEYSTROKE_EVENT
:
5300 button_down_time
= 0;
5302 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5303 if (event
->code
== lispy_accent_codes
[i
])
5304 return modify_event_symbol (i
,
5306 Qfunction_key
, Qnil
,
5307 lispy_accent_keys
, &accent_key_syms
,
5308 (sizeof (lispy_accent_keys
)
5309 / sizeof (lispy_accent_keys
[0])));
5313 if (event
->code
>= 0x400 && event
->code
< 0x500)
5314 return modify_event_symbol (event
->code
- 0x400,
5315 event
->modifiers
& ~shift_modifier
,
5316 Qfunction_key
, Qnil
,
5317 lispy_kana_keys
, &func_key_syms
,
5318 (sizeof (lispy_kana_keys
)
5319 / sizeof (lispy_kana_keys
[0])));
5320 #endif /* XK_kana_A */
5323 #ifdef ISO_FUNCTION_KEY_OFFSET
5324 if (event
->code
< FUNCTION_KEY_OFFSET
5325 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5326 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5328 Qfunction_key
, Qnil
,
5329 iso_lispy_function_keys
, &func_key_syms
,
5330 (sizeof (iso_lispy_function_keys
)
5331 / sizeof (iso_lispy_function_keys
[0])));
5334 /* Handle system-specific or unknown keysyms. */
5335 if (event
->code
& (1 << 28)
5336 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5337 || (event
->code
- FUNCTION_KEY_OFFSET
5338 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5339 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5341 /* We need to use an alist rather than a vector as the cache
5342 since we can't make a vector long enuf. */
5343 if (NILP (current_kboard
->system_key_syms
))
5344 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5345 return modify_event_symbol (event
->code
,
5348 current_kboard
->Vsystem_key_alist
,
5349 0, ¤t_kboard
->system_key_syms
,
5353 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5355 Qfunction_key
, Qnil
,
5356 lispy_function_keys
, &func_key_syms
,
5357 (sizeof (lispy_function_keys
)
5358 / sizeof (lispy_function_keys
[0])));
5361 /* A mouse click. Figure out where it is, decide whether it's
5362 a press, click or drag, and build the appropriate structure. */
5363 case MOUSE_CLICK_EVENT
:
5364 #ifndef USE_TOOLKIT_SCROLL_BARS
5365 case SCROLL_BAR_CLICK_EVENT
:
5368 int button
= event
->code
;
5370 Lisp_Object position
;
5371 Lisp_Object
*start_pos_ptr
;
5372 Lisp_Object start_pos
;
5376 /* Build the position as appropriate for this mouse click. */
5377 if (event
->kind
== MOUSE_CLICK_EVENT
)
5379 struct frame
*f
= XFRAME (event
->frame_or_window
);
5380 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5384 /* Ignore mouse events that were made on frame that
5385 have been deleted. */
5386 if (! FRAME_LIVE_P (f
))
5389 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5390 /* EVENT->x and EVENT->y are frame-relative pixel
5391 coordinates at this place. Under old redisplay, COLUMN
5392 and ROW are set to frame relative glyph coordinates
5393 which are then used to determine whether this click is
5394 in a menu (non-toolkit version). */
5395 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5396 &column
, &row
, NULL
, 1);
5398 /* In the non-toolkit version, clicks on the menu bar
5399 are ordinary button events in the event buffer.
5400 Distinguish them, and invoke the menu.
5402 (In the toolkit version, the toolkit handles the menu bar
5403 and Emacs doesn't know about it until after the user
5404 makes a selection.) */
5405 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5406 && (event
->modifiers
& down_modifier
))
5408 Lisp_Object items
, item
;
5413 /* Activate the menu bar on the down event. If the
5414 up event comes in before the menu code can deal with it,
5416 if (! (event
->modifiers
& down_modifier
))
5420 /* Find the menu bar item under `column'. */
5422 items
= FRAME_MENU_BAR_ITEMS (f
);
5423 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5425 Lisp_Object pos
, string
;
5426 string
= AREF (items
, i
+ 1);
5427 pos
= AREF (items
, i
+ 3);
5430 if (column
>= XINT (pos
)
5431 && column
< XINT (pos
) + SCHARS (string
))
5433 item
= AREF (items
, i
);
5438 /* ELisp manual 2.4b says (x y) are window relative but
5439 code says they are frame-relative. */
5441 = Fcons (event
->frame_or_window
,
5443 Fcons (Fcons (event
->x
, event
->y
),
5444 Fcons (make_number (event
->timestamp
),
5447 return Fcons (item
, Fcons (position
, Qnil
));
5449 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5451 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5454 #ifndef USE_TOOLKIT_SCROLL_BARS
5457 /* It's a scrollbar click. */
5459 Lisp_Object portion_whole
;
5462 window
= event
->frame_or_window
;
5463 portion_whole
= Fcons (event
->x
, event
->y
);
5464 part
= *scroll_bar_parts
[(int) event
->part
];
5468 Fcons (Qvertical_scroll_bar
,
5469 Fcons (portion_whole
,
5470 Fcons (make_number (event
->timestamp
),
5471 Fcons (part
, Qnil
)))));
5473 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5475 if (button
>= ASIZE (button_down_location
))
5477 button_down_location
= larger_vector (button_down_location
,
5479 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5482 start_pos_ptr
= &AREF (button_down_location
, button
);
5483 start_pos
= *start_pos_ptr
;
5484 *start_pos_ptr
= Qnil
;
5487 /* On window-system frames, use the value of
5488 double-click-fuzz as is. On other frames, interpret it
5489 as a multiple of 1/8 characters. */
5493 if (WINDOWP (event
->frame_or_window
))
5494 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5495 else if (FRAMEP (event
->frame_or_window
))
5496 f
= XFRAME (event
->frame_or_window
);
5500 if (FRAME_WINDOW_P (f
))
5501 fuzz
= double_click_fuzz
;
5503 fuzz
= double_click_fuzz
/ 8;
5505 is_double
= (button
== last_mouse_button
5506 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5507 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5508 && button_down_time
!= 0
5509 && (EQ (Vdouble_click_time
, Qt
)
5510 || (INTEGERP (Vdouble_click_time
)
5511 && ((int)(event
->timestamp
- button_down_time
)
5512 < XINT (Vdouble_click_time
)))));
5515 last_mouse_button
= button
;
5516 last_mouse_x
= XINT (event
->x
);
5517 last_mouse_y
= XINT (event
->y
);
5519 /* If this is a button press, squirrel away the location, so
5520 we can decide later whether it was a click or a drag. */
5521 if (event
->modifiers
& down_modifier
)
5525 double_click_count
++;
5526 event
->modifiers
|= ((double_click_count
> 2)
5531 double_click_count
= 1;
5532 button_down_time
= event
->timestamp
;
5533 *start_pos_ptr
= Fcopy_alist (position
);
5536 /* Now we're releasing a button - check the co-ordinates to
5537 see if this was a click or a drag. */
5538 else if (event
->modifiers
& up_modifier
)
5540 /* If we did not see a down before this up, ignore the up.
5541 Probably this happened because the down event chose a
5542 menu item. It would be an annoyance to treat the
5543 release of the button that chose the menu item as a
5546 if (!CONSP (start_pos
))
5549 event
->modifiers
&= ~up_modifier
;
5550 #if 0 /* Formerly we treated an up with no down as a click event. */
5551 if (!CONSP (start_pos
))
5552 event
->modifiers
|= click_modifier
;
5557 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5559 /* The third element of every position
5560 should be the (x,y) pair. */
5561 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5563 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5565 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5566 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5569 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5570 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5571 /* Maybe the mouse has moved a lot, caused scrolling, and
5572 eventually ended up at the same screen position (but
5573 not buffer position) in which case it is a drag, not
5575 /* FIXME: OTOH if the buffer position has changed
5576 because of a timer or process filter rather than
5577 because of mouse movement, it should be considered as
5578 a click. But mouse-drag-region completely ignores
5579 this case and it hasn't caused any real problem, so
5580 it's probably OK to ignore it as well. */
5581 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5582 /* Mouse hasn't moved (much). */
5583 event
->modifiers
|= click_modifier
;
5586 button_down_time
= 0;
5587 event
->modifiers
|= drag_modifier
;
5590 /* Don't check is_double; treat this as multiple
5591 if the down-event was multiple. */
5592 if (double_click_count
> 1)
5593 event
->modifiers
|= ((double_click_count
> 2)
5599 /* Every mouse event should either have the down_modifier or
5600 the up_modifier set. */
5604 /* Get the symbol we should use for the mouse click. */
5607 head
= modify_event_symbol (button
,
5609 Qmouse_click
, Vlispy_mouse_stem
,
5612 XVECTOR (mouse_syms
)->size
);
5613 if (event
->modifiers
& drag_modifier
)
5618 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5621 Fcons (make_number (double_click_count
),
5632 Lisp_Object position
;
5635 /* Build the position as appropriate for this mouse click. */
5636 struct frame
*f
= XFRAME (event
->frame_or_window
);
5638 /* Ignore wheel events that were made on frame that have been
5640 if (! FRAME_LIVE_P (f
))
5643 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5646 /* Set double or triple modifiers to indicate the wheel speed. */
5648 /* On window-system frames, use the value of
5649 double-click-fuzz as is. On other frames, interpret it
5650 as a multiple of 1/8 characters. */
5655 if (WINDOWP (event
->frame_or_window
))
5656 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5657 else if (FRAMEP (event
->frame_or_window
))
5658 f
= XFRAME (event
->frame_or_window
);
5662 if (FRAME_WINDOW_P (f
))
5663 fuzz
= double_click_fuzz
;
5665 fuzz
= double_click_fuzz
/ 8;
5667 is_double
= (last_mouse_button
< 0
5668 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5669 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5670 && button_down_time
!= 0
5671 && (EQ (Vdouble_click_time
, Qt
)
5672 || (INTEGERP (Vdouble_click_time
)
5673 && ((int)(event
->timestamp
- button_down_time
)
5674 < XINT (Vdouble_click_time
)))));
5677 double_click_count
++;
5678 event
->modifiers
|= ((double_click_count
> 2)
5684 double_click_count
= 1;
5685 event
->modifiers
|= click_modifier
;
5688 button_down_time
= event
->timestamp
;
5689 /* Use a negative value to distinguish wheel from mouse button. */
5690 last_mouse_button
= -1;
5691 last_mouse_x
= XINT (event
->x
);
5692 last_mouse_y
= XINT (event
->y
);
5698 if (event
->modifiers
& up_modifier
)
5700 /* Emit a wheel-up event. */
5701 event
->modifiers
&= ~up_modifier
;
5704 else if (event
->modifiers
& down_modifier
)
5706 /* Emit a wheel-down event. */
5707 event
->modifiers
&= ~down_modifier
;
5711 /* Every wheel event should either have the down_modifier or
5712 the up_modifier set. */
5715 /* Get the symbol we should use for the wheel event. */
5716 head
= modify_event_symbol (symbol_num
,
5722 ASIZE (wheel_syms
));
5725 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5728 Fcons (make_number (double_click_count
),
5737 #ifdef USE_TOOLKIT_SCROLL_BARS
5739 /* We don't have down and up events if using toolkit scroll bars,
5740 so make this always a click event. Store in the `part' of
5741 the Lisp event a symbol which maps to the following actions:
5743 `above_handle' page up
5744 `below_handle' page down
5748 `bottom' bottom of buffer
5749 `handle' thumb has been dragged.
5750 `end-scroll' end of interaction with scroll bar
5752 The incoming input_event contains in its `part' member an
5753 index of type `enum scroll_bar_part' which we can use as an
5754 index in scroll_bar_parts to get the appropriate symbol. */
5756 case SCROLL_BAR_CLICK_EVENT
:
5758 Lisp_Object position
, head
, window
, portion_whole
, part
;
5760 window
= event
->frame_or_window
;
5761 portion_whole
= Fcons (event
->x
, event
->y
);
5762 part
= *scroll_bar_parts
[(int) event
->part
];
5766 Fcons (Qvertical_scroll_bar
,
5767 Fcons (portion_whole
,
5768 Fcons (make_number (event
->timestamp
),
5769 Fcons (part
, Qnil
)))));
5771 /* Always treat scroll bar events as clicks. */
5772 event
->modifiers
|= click_modifier
;
5773 event
->modifiers
&= ~up_modifier
;
5775 if (event
->code
>= ASIZE (mouse_syms
))
5776 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5778 /* Get the symbol we should use for the mouse click. */
5779 head
= modify_event_symbol (event
->code
,
5784 XVECTOR (mouse_syms
)->size
);
5785 return Fcons (head
, Fcons (position
, Qnil
));
5788 #endif /* USE_TOOLKIT_SCROLL_BARS */
5791 case W32_SCROLL_BAR_CLICK_EVENT
:
5793 int button
= event
->code
;
5795 Lisp_Object position
;
5796 Lisp_Object
*start_pos_ptr
;
5797 Lisp_Object start_pos
;
5801 Lisp_Object portion_whole
;
5804 window
= event
->frame_or_window
;
5805 portion_whole
= Fcons (event
->x
, event
->y
);
5806 part
= *scroll_bar_parts
[(int) event
->part
];
5810 Fcons (Qvertical_scroll_bar
,
5811 Fcons (portion_whole
,
5812 Fcons (make_number (event
->timestamp
),
5813 Fcons (part
, Qnil
)))));
5816 /* Always treat W32 scroll bar events as clicks. */
5817 event
->modifiers
|= click_modifier
;
5820 /* Get the symbol we should use for the mouse click. */
5823 head
= modify_event_symbol (button
,
5828 XVECTOR (mouse_syms
)->size
);
5834 #endif /* WINDOWSNT */
5836 case DRAG_N_DROP_EVENT
:
5839 Lisp_Object head
, position
;
5842 f
= XFRAME (event
->frame_or_window
);
5845 /* Ignore mouse events that were made on frames that
5846 have been deleted. */
5847 if (! FRAME_LIVE_P (f
))
5850 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5853 head
= modify_event_symbol (0, event
->modifiers
,
5855 lispy_drag_n_drop_names
,
5856 &drag_n_drop_syms
, 1);
5862 #endif /* HAVE_MOUSE */
5864 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5865 || defined (USE_GTK)
5866 case MENU_BAR_EVENT
:
5867 if (EQ (event
->arg
, event
->frame_or_window
))
5868 /* This is the prefix key. We translate this to
5869 `(menu_bar)' because the code in keyboard.c for menu
5870 events, which we use, relies on this. */
5871 return Fcons (Qmenu_bar
, Qnil
);
5875 case SELECT_WINDOW_EVENT
:
5876 /* Make an event (select-window (WINDOW)). */
5877 return Fcons (Qselect_window
,
5878 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5881 case TOOL_BAR_EVENT
:
5882 if (EQ (event
->arg
, event
->frame_or_window
))
5883 /* This is the prefix key. We translate this to
5884 `(tool_bar)' because the code in keyboard.c for tool bar
5885 events, which we use, relies on this. */
5886 return Fcons (Qtool_bar
, Qnil
);
5887 else if (SYMBOLP (event
->arg
))
5888 return apply_modifiers (event
->modifiers
, event
->arg
);
5891 case USER_SIGNAL_EVENT
:
5892 /* A user signal. */
5893 return *lispy_user_signals
[event
->code
];
5895 case SAVE_SESSION_EVENT
:
5896 return Qsave_session
;
5899 case MAC_APPLE_EVENT
:
5901 Lisp_Object spec
[2];
5905 return Fcons (Qmac_apple_event
,
5906 Fcons (Fvector (2, spec
),
5907 Fcons (event
->arg
, Qnil
)));
5911 /* The 'kind' field of the event is something we don't recognize. */
5920 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5922 Lisp_Object bar_window
;
5923 enum scroll_bar_part part
;
5927 /* Is it a scroll bar movement? */
5928 if (frame
&& ! NILP (bar_window
))
5930 Lisp_Object part_sym
;
5932 part_sym
= *scroll_bar_parts
[(int) part
];
5933 return Fcons (Qscroll_bar_movement
,
5934 (Fcons (Fcons (bar_window
,
5935 Fcons (Qvertical_scroll_bar
,
5936 Fcons (Fcons (x
, y
),
5937 Fcons (make_number (time
),
5943 /* Or is it an ordinary mouse movement? */
5946 Lisp_Object position
;
5948 position
= make_lispy_position (frame
, &x
, &y
, time
);
5950 return Fcons (Qmouse_movement
,
5956 #endif /* HAVE_MOUSE */
5958 /* Construct a switch frame event. */
5960 make_lispy_switch_frame (frame
)
5963 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5966 /* Manipulating modifiers. */
5968 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5970 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5971 SYMBOL's name of the end of the modifiers; the string from this
5972 position is the unmodified symbol name.
5974 This doesn't use any caches. */
5977 parse_modifiers_uncached (symbol
, modifier_end
)
5985 CHECK_SYMBOL (symbol
);
5988 name
= SYMBOL_NAME (symbol
);
5990 for (i
= 0; i
+2 <= SBYTES (name
); )
5992 int this_mod_end
= 0;
5995 /* See if the name continues with a modifier word.
5996 Check that the word appears, but don't check what follows it.
5997 Set this_mod and this_mod_end to record what we find. */
5999 switch (SREF (name
, i
))
6001 #define SINGLE_LETTER_MOD(BIT) \
6002 (this_mod_end = i + 1, this_mod = BIT)
6005 SINGLE_LETTER_MOD (alt_modifier
);
6009 SINGLE_LETTER_MOD (ctrl_modifier
);
6013 SINGLE_LETTER_MOD (hyper_modifier
);
6017 SINGLE_LETTER_MOD (meta_modifier
);
6021 SINGLE_LETTER_MOD (shift_modifier
);
6025 SINGLE_LETTER_MOD (super_modifier
);
6028 #undef SINGLE_LETTER_MOD
6030 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6031 if (i + LEN + 1 <= SBYTES (name) \
6032 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6034 this_mod_end = i + LEN; \
6039 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6040 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6041 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6045 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6047 #undef MULTI_LETTER_MOD
6051 /* If we found no modifier, stop looking for them. */
6052 if (this_mod_end
== 0)
6055 /* Check there is a dash after the modifier, so that it
6056 really is a modifier. */
6057 if (this_mod_end
>= SBYTES (name
)
6058 || SREF (name
, this_mod_end
) != '-')
6061 /* This modifier is real; look for another. */
6062 modifiers
|= this_mod
;
6063 i
= this_mod_end
+ 1;
6066 /* Should we include the `click' modifier? */
6067 if (! (modifiers
& (down_modifier
| drag_modifier
6068 | double_modifier
| triple_modifier
))
6069 && i
+ 7 == SBYTES (name
)
6070 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6071 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6072 modifiers
|= click_modifier
;
6080 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6081 prepended to the string BASE[0..BASE_LEN-1].
6082 This doesn't use any caches. */
6084 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6087 int base_len
, base_len_byte
;
6089 /* Since BASE could contain nulls, we can't use intern here; we have
6090 to use Fintern, which expects a genuine Lisp_String, and keeps a
6093 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6099 /* Only the event queue may use the `up' modifier; it should always
6100 be turned into a click or drag event before presented to lisp code. */
6101 if (modifiers
& up_modifier
)
6104 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6105 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6106 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6107 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6108 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6109 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6110 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6111 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6112 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6113 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6114 /* The click modifier is denoted by the absence of other modifiers. */
6118 mod_len
= p
- new_mods
;
6122 Lisp_Object new_name
;
6124 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6125 mod_len
+ base_len_byte
);
6126 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6127 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6129 return Fintern (new_name
, Qnil
);
6134 static char *modifier_names
[] =
6136 "up", "down", "drag", "click", "double", "triple", 0, 0,
6137 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6138 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6140 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6142 static Lisp_Object modifier_symbols
;
6144 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6146 lispy_modifier_list (modifiers
)
6149 Lisp_Object modifier_list
;
6152 modifier_list
= Qnil
;
6153 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6154 if (modifiers
& (1<<i
))
6155 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6158 return modifier_list
;
6162 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6163 where UNMODIFIED is the unmodified form of SYMBOL,
6164 MASK is the set of modifiers present in SYMBOL's name.
6165 This is similar to parse_modifiers_uncached, but uses the cache in
6166 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6167 Qevent_symbol_elements property. */
6170 parse_modifiers (symbol
)
6173 Lisp_Object elements
;
6175 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6176 if (CONSP (elements
))
6181 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6182 Lisp_Object unmodified
;
6185 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6186 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6189 if (modifiers
& ~INTMASK
)
6191 XSETFASTINT (mask
, modifiers
);
6192 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6194 /* Cache the parsing results on SYMBOL. */
6195 Fput (symbol
, Qevent_symbol_element_mask
,
6197 Fput (symbol
, Qevent_symbol_elements
,
6198 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6200 /* Since we know that SYMBOL is modifiers applied to unmodified,
6201 it would be nice to put that in unmodified's cache.
6202 But we can't, since we're not sure that parse_modifiers is
6209 /* Apply the modifiers MODIFIERS to the symbol BASE.
6210 BASE must be unmodified.
6212 This is like apply_modifiers_uncached, but uses BASE's
6213 Qmodifier_cache property, if present. It also builds
6214 Qevent_symbol_elements properties, since it has that info anyway.
6216 apply_modifiers copies the value of BASE's Qevent_kind property to
6217 the modified symbol. */
6219 apply_modifiers (modifiers
, base
)
6223 Lisp_Object cache
, index
, entry
, new_symbol
;
6225 /* Mask out upper bits. We don't know where this value's been. */
6226 modifiers
&= INTMASK
;
6228 /* The click modifier never figures into cache indices. */
6229 cache
= Fget (base
, Qmodifier_cache
);
6230 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6231 entry
= assq_no_quit (index
, cache
);
6234 new_symbol
= XCDR (entry
);
6237 /* We have to create the symbol ourselves. */
6238 new_symbol
= apply_modifiers_uncached (modifiers
,
6239 SDATA (SYMBOL_NAME (base
)),
6240 SCHARS (SYMBOL_NAME (base
)),
6241 SBYTES (SYMBOL_NAME (base
)));
6243 /* Add the new symbol to the base's cache. */
6244 entry
= Fcons (index
, new_symbol
);
6245 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6247 /* We have the parsing info now for free, so we could add it to
6249 XSETFASTINT (index, modifiers);
6250 Fput (new_symbol, Qevent_symbol_element_mask,
6251 Fcons (base, Fcons (index, Qnil)));
6252 Fput (new_symbol, Qevent_symbol_elements,
6253 Fcons (base, lispy_modifier_list (modifiers)));
6254 Sadly, this is only correct if `base' is indeed a base event,
6255 which is not necessarily the case. -stef */
6258 /* Make sure this symbol is of the same kind as BASE.
6260 You'd think we could just set this once and for all when we
6261 intern the symbol above, but reorder_modifiers may call us when
6262 BASE's property isn't set right; we can't assume that just
6263 because it has a Qmodifier_cache property it must have its
6264 Qevent_kind set right as well. */
6265 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6269 kind
= Fget (base
, Qevent_kind
);
6271 Fput (new_symbol
, Qevent_kind
, kind
);
6278 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6279 return a symbol with the modifiers placed in the canonical order.
6280 Canonical order is alphabetical, except for down and drag, which
6281 always come last. The 'click' modifier is never written out.
6283 Fdefine_key calls this to make sure that (for example) C-M-foo
6284 and M-C-foo end up being equivalent in the keymap. */
6287 reorder_modifiers (symbol
)
6290 /* It's hopefully okay to write the code this way, since everything
6291 will soon be in caches, and no consing will be done at all. */
6294 parsed
= parse_modifiers (symbol
);
6295 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6300 /* For handling events, we often want to produce a symbol whose name
6301 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6302 to some base, like the name of a function key or mouse button.
6303 modify_event_symbol produces symbols of this sort.
6305 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6306 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6309 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6310 into symbol names, or a string specifying a name stem used to
6311 construct a symbol name or the form `STEM-N', where N is the decimal
6312 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6313 non-nil; otherwise NAME_TABLE is used.
6315 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6316 persist between calls to modify_event_symbol that it can use to
6317 store a cache of the symbols it's generated for this NAME_TABLE
6318 before. The object stored there may be a vector or an alist.
6320 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6322 MODIFIERS is a set of modifier bits (as given in struct input_events)
6323 whose prefixes should be applied to the symbol name.
6325 SYMBOL_KIND is the value to be placed in the event_kind property of
6326 the returned symbol.
6328 The symbols we create are supposed to have an
6329 `event-symbol-elements' property, which lists the modifiers present
6330 in the symbol's name. */
6333 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6334 name_table
, symbol_table
, table_size
)
6337 Lisp_Object symbol_kind
;
6338 Lisp_Object name_alist_or_stem
;
6340 Lisp_Object
*symbol_table
;
6341 unsigned int table_size
;
6344 Lisp_Object symbol_int
;
6346 /* Get rid of the "vendor-specific" bit here. */
6347 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6349 /* Is this a request for a valid symbol? */
6350 if (symbol_num
< 0 || symbol_num
>= table_size
)
6353 if (CONSP (*symbol_table
))
6354 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6356 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6357 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6358 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6359 we've never used that symbol before. */
6362 if (! VECTORP (*symbol_table
)
6363 || XVECTOR (*symbol_table
)->size
!= table_size
)
6367 XSETFASTINT (size
, table_size
);
6368 *symbol_table
= Fmake_vector (size
, Qnil
);
6371 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6374 /* Have we already used this symbol before? */
6377 /* No; let's create it. */
6378 if (CONSP (name_alist_or_stem
))
6379 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6380 else if (STRINGP (name_alist_or_stem
))
6382 int len
= SBYTES (name_alist_or_stem
);
6383 char *buf
= (char *) alloca (len
+ 50);
6384 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6385 (long) XINT (symbol_int
) + 1);
6386 value
= intern (buf
);
6388 else if (name_table
!= 0 && name_table
[symbol_num
])
6389 value
= intern (name_table
[symbol_num
]);
6391 #ifdef HAVE_WINDOW_SYSTEM
6394 char *name
= x_get_keysym_name (symbol_num
);
6396 value
= intern (name
);
6403 sprintf (buf
, "key-%d", symbol_num
);
6404 value
= intern (buf
);
6407 if (CONSP (*symbol_table
))
6408 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6410 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6412 /* Fill in the cache entries for this symbol; this also
6413 builds the Qevent_symbol_elements property, which the user
6415 apply_modifiers (modifiers
& click_modifier
, value
);
6416 Fput (value
, Qevent_kind
, symbol_kind
);
6419 /* Apply modifiers to that symbol. */
6420 return apply_modifiers (modifiers
, value
);
6423 /* Convert a list that represents an event type,
6424 such as (ctrl meta backspace), into the usual representation of that
6425 event type as a number or a symbol. */
6427 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6428 doc
: /* Convert the event description list EVENT-DESC to an event type.
6429 EVENT-DESC should contain one base event type (a character or symbol)
6430 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6431 drag, down, double or triple). The base must be last.
6432 The return value is an event type (a character or symbol) which
6433 has the same base event type and all the specified modifiers. */)
6435 Lisp_Object event_desc
;
6443 while (CONSP (rest
))
6451 /* Given a symbol, see if it is a modifier name. */
6452 if (SYMBOLP (elt
) && CONSP (rest
))
6453 this = parse_solitary_modifier (elt
);
6457 else if (!NILP (base
))
6458 error ("Two bases given in one event");
6464 /* Let the symbol A refer to the character A. */
6465 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6466 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6468 if (INTEGERP (base
))
6470 /* Turn (shift a) into A. */
6471 if ((modifiers
& shift_modifier
) != 0
6472 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6474 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6475 modifiers
&= ~shift_modifier
;
6478 /* Turn (control a) into C-a. */
6479 if (modifiers
& ctrl_modifier
)
6480 return make_number ((modifiers
& ~ctrl_modifier
)
6481 | make_ctrl_char (XINT (base
)));
6483 return make_number (modifiers
| XINT (base
));
6485 else if (SYMBOLP (base
))
6486 return apply_modifiers (modifiers
, base
);
6489 error ("Invalid base event");
6494 /* Try to recognize SYMBOL as a modifier name.
6495 Return the modifier flag bit, or 0 if not recognized. */
6498 parse_solitary_modifier (symbol
)
6501 Lisp_Object name
= SYMBOL_NAME (symbol
);
6503 switch (SREF (name
, 0))
6505 #define SINGLE_LETTER_MOD(BIT) \
6506 if (SBYTES (name) == 1) \
6509 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6510 if (LEN == SBYTES (name) \
6511 && ! strncmp (SDATA (name), NAME, LEN)) \
6515 SINGLE_LETTER_MOD (alt_modifier
);
6519 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6523 SINGLE_LETTER_MOD (ctrl_modifier
);
6527 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6528 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6532 SINGLE_LETTER_MOD (hyper_modifier
);
6536 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6540 SINGLE_LETTER_MOD (meta_modifier
);
6544 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6548 SINGLE_LETTER_MOD (shift_modifier
);
6552 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6553 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6554 SINGLE_LETTER_MOD (super_modifier
);
6558 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6559 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6560 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6564 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6567 #undef SINGLE_LETTER_MOD
6568 #undef MULTI_LETTER_MOD
6574 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6575 Such a list is not valid as an event,
6576 but it can be a Lucid-style event type list. */
6579 lucid_event_type_list_p (object
)
6584 if (! CONSP (object
))
6587 if (EQ (XCAR (object
), Qhelp_echo
)
6588 || EQ (XCAR (object
), Qvertical_line
)
6589 || EQ (XCAR (object
), Qmode_line
)
6590 || EQ (XCAR (object
), Qheader_line
))
6593 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6597 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6604 /* Store into *addr a value nonzero if terminal input chars are available.
6605 Serves the purpose of ioctl (0, FIONREAD, addr)
6606 but works even if FIONREAD does not exist.
6607 (In fact, this may actually read some input.)
6609 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6610 timer events that are ripe.
6611 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6612 events (FOCUS_IN_EVENT).
6613 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6614 movements and toolkit scroll bar thumb drags. */
6617 get_input_pending (addr
, flags
)
6621 /* First of all, have we already counted some input? */
6622 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6624 /* If input is being read as it arrives, and we have none, there is none. */
6625 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6628 /* Try to read some input and see how much we get. */
6630 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6633 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6636 gobble_input (expected
)
6641 if (interrupt_input
)
6644 mask
= sigblock (sigmask (SIGIO
));
6645 read_avail_input (expected
);
6649 #ifdef POLL_FOR_INPUT
6650 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6653 mask
= sigblock (sigmask (SIGALRM
));
6654 read_avail_input (expected
);
6660 read_avail_input (expected
);
6664 /* Put a BUFFER_SWITCH_EVENT in the buffer
6665 so that read_key_sequence will notice the new current buffer. */
6668 record_asynch_buffer_change ()
6670 struct input_event event
;
6674 event
.kind
= BUFFER_SWITCH_EVENT
;
6675 event
.frame_or_window
= Qnil
;
6679 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6680 The purpose of the event is to make read_key_sequence look up the
6681 keymaps again. If we aren't in read_key_sequence, we don't need one,
6682 and the event could cause trouble by messing up (input-pending-p). */
6683 tem
= Fwaiting_for_user_input_p ();
6687 /* We never need these events if we have no asynchronous subprocesses. */
6691 /* Make sure no interrupt happens while storing the event. */
6693 if (interrupt_input
)
6696 mask
= sigblock (sigmask (SIGIO
));
6697 kbd_buffer_store_event (&event
);
6704 kbd_buffer_store_event (&event
);
6711 /* Read any terminal input already buffered up by the system
6712 into the kbd_buffer, but do not wait.
6714 EXPECTED should be nonzero if the caller knows there is some input.
6716 Except on VMS, all input is read by this function.
6717 If interrupt_input is nonzero, this function MUST be called
6718 only when SIGIO is blocked.
6720 Returns the number of keyboard chars read, or -1 meaning
6721 this is a bad time to try to read input. */
6724 read_avail_input (expected
)
6730 if (read_socket_hook
)
6733 struct input_event hold_quit
;
6735 EVENT_INIT (hold_quit
);
6736 hold_quit
.kind
= NO_EVENT
;
6738 /* No need for FIONREAD or fcntl; just say don't wait. */
6739 while (nr
= (*read_socket_hook
) (input_fd
, expected
, &hold_quit
), nr
> 0)
6744 if (hold_quit
.kind
!= NO_EVENT
)
6745 kbd_buffer_store_event (&hold_quit
);
6749 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6750 the kbd_buffer can really hold. That may prevent loss
6751 of characters on some systems when input is stuffed at us. */
6752 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6755 /* Determine how many characters we should *try* to read. */
6758 #else /* not WINDOWSNT */
6760 n_to_read
= dos_keysns ();
6763 #else /* not MSDOS */
6765 /* Find out how much input is available. */
6766 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6767 /* Formerly simply reported no input, but that sometimes led to
6768 a failure of Emacs to terminate.
6769 SIGHUP seems appropriate if we can't reach the terminal. */
6770 /* ??? Is it really right to send the signal just to this process
6771 rather than to the whole process group?
6772 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6774 if (! noninteractive
)
6775 kill (getpid (), SIGHUP
);
6781 if (n_to_read
> sizeof cbuf
)
6782 n_to_read
= sizeof cbuf
;
6783 #else /* no FIONREAD */
6784 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6785 /* Read some input if available, but don't wait. */
6786 n_to_read
= sizeof cbuf
;
6787 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6792 #endif /* not MSDOS */
6793 #endif /* not WINDOWSNT */
6795 /* Now read; for one reason or another, this will not block.
6796 NREAD is set to the number of chars read. */
6800 cbuf
[0] = dos_keyread ();
6803 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6805 /* POSIX infers that processes which are not in the session leader's
6806 process group won't get SIGHUP's at logout time. BSDI adheres to
6807 this part standard and returns -1 from read (0) with errno==EIO
6808 when the control tty is taken away.
6809 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6810 if (nread
== -1 && errno
== EIO
)
6812 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6813 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6814 This looks incorrect, but it isn't, because _BSD causes
6815 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6816 and that causes a value other than 0 when there is no input. */
6822 /* We used to retry the read if it was interrupted.
6823 But this does the wrong thing when O_NDELAY causes
6824 an EAGAIN error. Does anybody know of a situation
6825 where a retry is actually needed? */
6827 nread
< 0 && (errno
== EAGAIN
6841 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6842 fcntl (input_fd
, F_SETFL
, 0);
6843 #endif /* USG or DGUX or CYGWIN */
6844 #endif /* no FIONREAD */
6845 for (i
= 0; i
< nread
; i
++)
6847 struct input_event buf
;
6849 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6851 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6852 buf
.modifiers
= meta_modifier
;
6857 buf
.frame_or_window
= selected_frame
;
6860 kbd_buffer_store_event (&buf
);
6861 /* Don't look at input that follows a C-g too closely.
6862 This reduces lossage due to autorepeat on C-g. */
6863 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6864 && buf
.code
== quit_char
)
6871 #endif /* not VMS */
6874 handle_async_input ()
6877 extern int select_alarmed
;
6880 interrupt_input_pending
= 0;
6885 nread
= read_avail_input (1);
6886 /* -1 means it's not ok to read the input now.
6887 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6888 0 means there was no keyboard input available. */
6893 select_alarmed
= 1; /* Force the select emulator back to life */
6898 #ifdef SIGIO /* for entire page */
6899 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6902 input_available_signal (signo
)
6905 /* Must preserve main program's value of errno. */
6906 int old_errno
= errno
;
6907 #if defined (USG) && !defined (POSIX_SIGNALS)
6908 /* USG systems forget handlers when they are used;
6909 must reestablish each time */
6910 signal (signo
, input_available_signal
);
6918 interrupt_input_pending
= 1;
6920 SIGNAL_THREAD_CHECK (signo
);
6923 if (input_available_clear_time
)
6924 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6927 handle_async_input ();
6937 /* Send ourselves a SIGIO.
6939 This function exists so that the UNBLOCK_INPUT macro in
6940 blockinput.h can have some way to take care of input we put off
6941 dealing with, without assuming that every file which uses
6942 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6944 reinvoke_input_signal ()
6947 handle_async_input ();
6953 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6954 static Lisp_Object menu_bar_one_keymap_changed_items
;
6956 /* These variables hold the vector under construction within
6957 menu_bar_items and its subroutines, and the current index
6958 for storing into that vector. */
6959 static Lisp_Object menu_bar_items_vector
;
6960 static int menu_bar_items_index
;
6962 /* Return a vector of menu items for a menu bar, appropriate
6963 to the current buffer. Each item has three elements in the vector:
6966 OLD is an old vector we can optionally reuse, or nil. */
6969 menu_bar_items (old
)
6972 /* The number of keymaps we're scanning right now, and the number of
6973 keymaps we have allocated space for. */
6976 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6977 in the current keymaps, or nil where it is not a prefix. */
6980 Lisp_Object def
, tail
;
6989 /* In order to build the menus, we need to call the keymap
6990 accessors. They all call QUIT. But this function is called
6991 during redisplay, during which a quit is fatal. So inhibit
6992 quitting while building the menus.
6993 We do this instead of specbind because (1) errors will clear it anyway
6994 and (2) this avoids risk of specpdl overflow. */
6995 oquit
= Vinhibit_quit
;
6999 menu_bar_items_vector
= old
;
7001 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7002 menu_bar_items_index
= 0;
7004 /* Build our list of keymaps.
7005 If we recognize a function key and replace its escape sequence in
7006 keybuf with its symbol, or if the sequence starts with a mouse
7007 click and we need to switch buffers, we jump back here to rebuild
7008 the initial keymaps from the current buffer. */
7012 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7013 if (!NILP (Voverriding_local_map_menu_flag
))
7015 /* Yes, use them (if non-nil) as well as the global map. */
7016 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7018 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7019 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7020 if (!NILP (Voverriding_local_map
))
7021 maps
[nmaps
++] = Voverriding_local_map
;
7025 /* No, so use major and minor mode keymaps and keymap property.
7026 Note that menu-bar bindings in the local-map and keymap
7027 properties may not work reliable, as they are only
7028 recognized when the menu-bar (or mode-line) is updated,
7029 which does not normally happen after every command. */
7032 nminor
= current_minor_maps (NULL
, &tmaps
);
7033 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7035 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7036 maps
[nmaps
++] = tem
;
7037 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7039 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7041 maps
[nmaps
++] = current_global_map
;
7044 /* Look up in each map the dummy prefix key `menu-bar'. */
7048 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7049 if (!NILP (maps
[mapno
]))
7051 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7055 menu_bar_one_keymap_changed_items
= Qnil
;
7056 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7060 /* Move to the end those items that should be at the end. */
7062 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7065 int end
= menu_bar_items_index
;
7067 for (i
= 0; i
< end
; i
+= 4)
7068 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7070 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7071 /* Move the item at index I to the end,
7072 shifting all the others forward. */
7073 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7074 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7075 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7076 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7078 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7079 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7080 (end
- i
- 4) * sizeof (Lisp_Object
));
7081 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7082 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7083 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7084 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7089 /* Add nil, nil, nil, nil at the end. */
7090 i
= menu_bar_items_index
;
7091 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7094 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7095 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7096 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7097 menu_bar_items_vector
= tem
;
7099 /* Add this item. */
7100 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7101 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7102 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7103 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7104 menu_bar_items_index
= i
;
7106 Vinhibit_quit
= oquit
;
7107 return menu_bar_items_vector
;
7110 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7111 If there's already an item for KEY, add this DEF to it. */
7113 Lisp_Object item_properties
;
7116 menu_bar_item (key
, item
, dummy1
, dummy2
)
7117 Lisp_Object key
, item
, dummy1
;
7120 struct gcpro gcpro1
;
7124 if (EQ (item
, Qundefined
))
7126 /* If a map has an explicit `undefined' as definition,
7127 discard any previously made menu bar item. */
7129 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7130 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7132 if (menu_bar_items_index
> i
+ 4)
7133 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7134 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7135 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7136 menu_bar_items_index
-= 4;
7140 /* If this keymap has already contributed to this KEY,
7141 don't contribute to it a second time. */
7142 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7143 if (!NILP (tem
) || NILP (item
))
7146 menu_bar_one_keymap_changed_items
7147 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7149 /* We add to menu_bar_one_keymap_changed_items before doing the
7150 parse_menu_item, so that if it turns out it wasn't a menu item,
7151 it still correctly hides any further menu item. */
7153 i
= parse_menu_item (item
, 0, 1);
7158 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7160 /* Find any existing item for this KEY. */
7161 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7162 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7165 /* If we did not find this KEY, add it at the end. */
7166 if (i
== menu_bar_items_index
)
7168 /* If vector is too small, get a bigger one. */
7169 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7172 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7173 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7174 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7175 menu_bar_items_vector
= tem
;
7178 /* Add this item. */
7179 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7180 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7181 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7182 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7183 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7184 menu_bar_items_index
= i
;
7186 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7190 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7191 /* If the new and the old items are not both keymaps,
7192 the lookup will only find `item'. */
7193 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7194 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7198 /* This is used as the handler when calling menu_item_eval_property. */
7200 menu_item_eval_property_1 (arg
)
7203 /* If we got a quit from within the menu computation,
7204 quit all the way out of it. This takes care of C-] in the debugger. */
7205 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7206 Fsignal (Qquit
, Qnil
);
7211 /* Evaluate an expression and return the result (or nil if something
7212 went wrong). Used to evaluate dynamic parts of menu items. */
7214 menu_item_eval_property (sexpr
)
7217 int count
= SPECPDL_INDEX ();
7219 specbind (Qinhibit_redisplay
, Qt
);
7220 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7221 menu_item_eval_property_1
);
7222 return unbind_to (count
, val
);
7225 /* This function parses a menu item and leaves the result in the
7226 vector item_properties.
7227 ITEM is a key binding, a possible menu item.
7228 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7229 evaluate dynamic expressions in the menu item.
7230 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7232 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7233 parse_menu_item returns true if the item is a menu item and false
7237 parse_menu_item (item
, notreal
, inmenubar
)
7239 int notreal
, inmenubar
;
7241 Lisp_Object def
, tem
, item_string
, start
;
7242 Lisp_Object cachelist
;
7244 Lisp_Object keyhint
;
7255 /* Create item_properties vector if necessary. */
7256 if (NILP (item_properties
))
7258 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7260 /* Initialize optional entries. */
7261 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7262 AREF (item_properties
, i
) = Qnil
;
7263 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7265 /* Save the item here to protect it from GC. */
7266 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7268 item_string
= XCAR (item
);
7272 if (STRINGP (item_string
))
7274 /* Old format menu item. */
7275 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7277 /* Maybe help string. */
7278 if (CONSP (item
) && STRINGP (XCAR (item
)))
7280 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7285 /* Maybe key binding cache. */
7286 if (CONSP (item
) && CONSP (XCAR (item
))
7287 && (NILP (XCAR (XCAR (item
)))
7288 || VECTORP (XCAR (XCAR (item
)))))
7290 cachelist
= XCAR (item
);
7294 /* This is the real definition--the function to run. */
7295 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7297 /* Get enable property, if any. */
7300 tem
= Fget (item
, Qmenu_enable
);
7301 if (!NILP (Venable_disabled_menus_and_buttons
))
7302 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7303 else if (!NILP (tem
))
7304 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7307 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7309 /* New format menu item. */
7310 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7311 start
= XCDR (item
);
7314 /* We have a real binding. */
7315 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7317 item
= XCDR (start
);
7318 /* Is there a cache list with key equivalences. */
7319 if (CONSP (item
) && CONSP (XCAR (item
)))
7321 cachelist
= XCAR (item
);
7325 /* Parse properties. */
7326 while (CONSP (item
) && CONSP (XCDR (item
)))
7331 if (EQ (tem
, QCenable
))
7333 if (!NILP (Venable_disabled_menus_and_buttons
))
7334 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7336 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7338 else if (EQ (tem
, QCvisible
) && !notreal
)
7340 /* If got a visible property and that evaluates to nil
7341 then ignore this item. */
7342 tem
= menu_item_eval_property (XCAR (item
));
7346 else if (EQ (tem
, QChelp
))
7347 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7348 else if (EQ (tem
, QCfilter
))
7350 else if (EQ (tem
, QCkey_sequence
))
7353 if (NILP (cachelist
)
7354 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7355 /* Be GC protected. Set keyhint to item instead of tem. */
7358 else if (EQ (tem
, QCkeys
))
7361 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7362 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7364 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7369 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7371 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7373 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7380 else if (inmenubar
|| !NILP (start
))
7384 return 0; /* not a menu item */
7386 /* If item string is not a string, evaluate it to get string.
7387 If we don't get a string, skip this item. */
7388 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7389 if (!(STRINGP (item_string
) || notreal
))
7391 item_string
= menu_item_eval_property (item_string
);
7392 if (!STRINGP (item_string
))
7394 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7397 /* If got a filter apply it on definition. */
7398 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7401 def
= menu_item_eval_property (list2 (XCAR (filter
),
7402 list2 (Qquote
, def
)));
7404 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7407 /* Enable or disable selection of item. */
7408 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7414 tem
= menu_item_eval_property (tem
);
7415 if (inmenubar
&& NILP (tem
))
7416 return 0; /* Ignore disabled items in menu bar. */
7417 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7420 /* If we got no definition, this item is just unselectable text which
7421 is OK in a submenu but not in the menubar. */
7423 return (inmenubar
? 0 : 1);
7425 /* See if this is a separate pane or a submenu. */
7426 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7427 tem
= get_keymap (def
, 0, 1);
7428 /* For a subkeymap, just record its details and exit. */
7431 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7432 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7436 /* At the top level in the menu bar, do likewise for commands also.
7437 The menu bar does not display equivalent key bindings anyway.
7438 ITEM_PROPERTY_DEF is already set up properly. */
7442 /* This is a command. See if there is an equivalent key binding. */
7443 if (NILP (cachelist
))
7445 /* We have to create a cachelist. */
7446 CHECK_IMPURE (start
);
7447 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7448 cachelist
= XCAR (XCDR (start
));
7450 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7451 if (!NILP (keyhint
))
7453 XSETCAR (cachelist
, XCAR (keyhint
));
7456 else if (STRINGP (tem
))
7458 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7459 XSETCAR (cachelist
, Qt
);
7463 tem
= XCAR (cachelist
);
7470 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7472 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7475 def
= XCAR (prefix
);
7476 prefix
= XCDR (prefix
);
7479 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7481 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7483 if (newcache
/* Always check first time. */
7484 /* Should we check everything when precomputing key
7486 /* If something had no key binding before, don't recheck it
7487 because that is too slow--except if we have a list of
7488 rebound commands in Vdefine_key_rebound_commands, do
7489 recheck any command that appears in that list. */
7490 || (CONSP (Vdefine_key_rebound_commands
)
7491 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7494 /* We had a saved key. Is it still bound to the command? */
7497 /* If the command is an alias for another
7498 (such as lmenu.el set it up), check if the
7499 original command matches the cached command. */
7500 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7501 chkcache
= 1; /* Need to recompute key binding. */
7505 /* Recompute equivalent key binding. If the command is an alias
7506 for another (such as lmenu.el set it up), see if the original
7507 command name has equivalent keys. Otherwise look up the
7508 specified command itself. We don't try both, because that
7509 makes lmenu menus slow. */
7511 && SYMBOLP (XSYMBOL (def
)->function
)
7512 && ! NILP (Fget (def
, Qmenu_alias
)))
7513 def
= XSYMBOL (def
)->function
;
7514 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7515 XSETCAR (cachelist
, tem
);
7518 XSETCDR (cachelist
, Qnil
);
7522 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7524 tem
= XCAR (cachelist
);
7528 newcache
= chkcache
;
7531 tem
= Fkey_description (tem
, Qnil
);
7534 if (STRINGP (XCAR (prefix
)))
7535 tem
= concat2 (XCAR (prefix
), tem
);
7536 if (STRINGP (XCDR (prefix
)))
7537 tem
= concat2 (tem
, XCDR (prefix
));
7539 XSETCDR (cachelist
, tem
);
7543 tem
= XCDR (cachelist
);
7544 if (newcache
&& !NILP (tem
))
7546 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7547 XSETCDR (cachelist
, tem
);
7550 /* If we only want to precompute equivalent key bindings, stop here. */
7554 /* If we have an equivalent key binding, use that. */
7555 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7557 /* Include this when menu help is implemented.
7558 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7559 if (!(NILP (tem) || STRINGP (tem)))
7561 tem = menu_item_eval_property (tem);
7564 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7568 /* Handle radio buttons or toggle boxes. */
7569 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7571 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7572 = menu_item_eval_property (tem
);
7579 /***********************************************************************
7581 ***********************************************************************/
7583 /* A vector holding tool bar items while they are parsed in function
7584 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7587 static Lisp_Object tool_bar_items_vector
;
7589 /* A vector holding the result of parse_tool_bar_item. Layout is like
7590 the one for a single item in tool_bar_items_vector. */
7592 static Lisp_Object tool_bar_item_properties
;
7594 /* Next free index in tool_bar_items_vector. */
7596 static int ntool_bar_items
;
7598 /* The symbols `tool-bar', and `:image'. */
7600 extern Lisp_Object Qtool_bar
;
7601 Lisp_Object QCimage
;
7603 /* Function prototypes. */
7605 static void init_tool_bar_items
P_ ((Lisp_Object
));
7606 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7607 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7608 static void append_tool_bar_item
P_ ((void));
7611 /* Return a vector of tool bar items for keymaps currently in effect.
7612 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7613 tool bar items found. */
7616 tool_bar_items (reuse
, nitems
)
7627 /* In order to build the menus, we need to call the keymap
7628 accessors. They all call QUIT. But this function is called
7629 during redisplay, during which a quit is fatal. So inhibit
7630 quitting while building the menus. We do this instead of
7631 specbind because (1) errors will clear it anyway and (2) this
7632 avoids risk of specpdl overflow. */
7633 oquit
= Vinhibit_quit
;
7636 /* Initialize tool_bar_items_vector and protect it from GC. */
7637 init_tool_bar_items (reuse
);
7639 /* Build list of keymaps in maps. Set nmaps to the number of maps
7642 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7643 if (!NILP (Voverriding_local_map_menu_flag
))
7645 /* Yes, use them (if non-nil) as well as the global map. */
7646 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7648 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7649 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7650 if (!NILP (Voverriding_local_map
))
7651 maps
[nmaps
++] = Voverriding_local_map
;
7655 /* No, so use major and minor mode keymaps and keymap property.
7656 Note that tool-bar bindings in the local-map and keymap
7657 properties may not work reliable, as they are only
7658 recognized when the tool-bar (or mode-line) is updated,
7659 which does not normally happen after every command. */
7662 nminor
= current_minor_maps (NULL
, &tmaps
);
7663 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7665 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7666 maps
[nmaps
++] = tem
;
7667 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7669 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7672 /* Add global keymap at the end. */
7673 maps
[nmaps
++] = current_global_map
;
7675 /* Process maps in reverse order and look up in each map the prefix
7677 for (i
= nmaps
- 1; i
>= 0; --i
)
7678 if (!NILP (maps
[i
]))
7682 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7684 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7687 Vinhibit_quit
= oquit
;
7688 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7689 return tool_bar_items_vector
;
7693 /* Process the definition of KEY which is DEF. */
7696 process_tool_bar_item (key
, def
, data
, args
)
7697 Lisp_Object key
, def
, data
;
7701 extern Lisp_Object Qundefined
;
7702 struct gcpro gcpro1
, gcpro2
;
7704 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7708 if (EQ (def
, Qundefined
))
7710 /* If a map has an explicit `undefined' as definition,
7711 discard any previously made item. */
7712 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7714 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7716 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7718 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7719 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7720 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7721 * sizeof (Lisp_Object
)));
7722 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7727 else if (parse_tool_bar_item (key
, def
))
7728 /* Append a new tool bar item to tool_bar_items_vector. Accept
7729 more than one definition for the same key. */
7730 append_tool_bar_item ();
7736 /* Parse a tool bar item specification ITEM for key KEY and return the
7737 result in tool_bar_item_properties. Value is zero if ITEM is
7740 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7742 CAPTION is the caption of the item, If it's not a string, it is
7743 evaluated to get a string.
7745 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7746 as binding are currently ignored.
7748 The following properties are recognized:
7752 FORM is evaluated and specifies whether the tool bar item is
7753 enabled or disabled.
7757 FORM is evaluated and specifies whether the tool bar item is visible.
7759 - `:filter FUNCTION'
7761 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7762 result is stored as the new binding.
7764 - `:button (TYPE SELECTED)'
7766 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7767 and specifies whether the button is selected (pressed) or not.
7771 IMAGES is either a single image specification or a vector of four
7772 image specifications. See enum tool_bar_item_images.
7774 - `:help HELP-STRING'.
7776 Gives a help string to display for the tool bar item. */
7779 parse_tool_bar_item (key
, item
)
7780 Lisp_Object key
, item
;
7782 /* Access slot with index IDX of vector tool_bar_item_properties. */
7783 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7785 Lisp_Object filter
= Qnil
;
7786 Lisp_Object caption
;
7789 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7790 Rule out items that aren't lists, don't start with
7791 `menu-item' or whose rest following `tool-bar-item' is not a
7794 || !EQ (XCAR (item
), Qmenu_item
)
7795 || (item
= XCDR (item
),
7799 /* Create tool_bar_item_properties vector if necessary. Reset it to
7801 if (VECTORP (tool_bar_item_properties
))
7803 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7807 tool_bar_item_properties
7808 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7811 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7812 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7814 /* Get the caption of the item. If the caption is not a string,
7815 evaluate it to get a string. If we don't get a string, skip this
7817 caption
= XCAR (item
);
7818 if (!STRINGP (caption
))
7820 caption
= menu_item_eval_property (caption
);
7821 if (!STRINGP (caption
))
7824 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7826 /* Give up if rest following the caption is not a list. */
7831 /* Store the binding. */
7832 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7835 /* Ignore cached key binding, if any. */
7836 if (CONSP (item
) && CONSP (XCAR (item
)))
7839 /* Process the rest of the properties. */
7840 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7842 Lisp_Object key
, value
;
7845 value
= XCAR (XCDR (item
));
7847 if (EQ (key
, QCenable
))
7849 /* `:enable FORM'. */
7850 if (!NILP (Venable_disabled_menus_and_buttons
))
7851 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7853 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7855 else if (EQ (key
, QCvisible
))
7857 /* `:visible FORM'. If got a visible property and that
7858 evaluates to nil then ignore this item. */
7859 if (NILP (menu_item_eval_property (value
)))
7862 else if (EQ (key
, QChelp
))
7863 /* `:help HELP-STRING'. */
7864 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7865 else if (EQ (key
, QCfilter
))
7866 /* ':filter FORM'. */
7868 else if (EQ (key
, QCbutton
) && CONSP (value
))
7870 /* `:button (TYPE . SELECTED)'. */
7871 Lisp_Object type
, selected
;
7873 type
= XCAR (value
);
7874 selected
= XCDR (value
);
7875 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7877 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7878 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7881 else if (EQ (key
, QCimage
)
7883 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7884 /* Value is either a single image specification or a vector
7885 of 4 such specifications for the different button states. */
7886 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7889 /* If got a filter apply it on binding. */
7891 PROP (TOOL_BAR_ITEM_BINDING
)
7892 = menu_item_eval_property (list2 (filter
,
7894 PROP (TOOL_BAR_ITEM_BINDING
))));
7896 /* See if the binding is a keymap. Give up if it is. */
7897 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7900 /* Enable or disable selection of item. */
7901 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7902 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7903 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7905 /* Handle radio buttons or toggle boxes. */
7906 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7907 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7908 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7916 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7917 that can be reused. */
7920 init_tool_bar_items (reuse
)
7923 if (VECTORP (reuse
))
7924 tool_bar_items_vector
= reuse
;
7926 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7927 ntool_bar_items
= 0;
7931 /* Append parsed tool bar item properties from
7932 tool_bar_item_properties */
7935 append_tool_bar_item ()
7937 Lisp_Object
*to
, *from
;
7939 /* Enlarge tool_bar_items_vector if necessary. */
7940 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7941 >= XVECTOR (tool_bar_items_vector
)->size
)
7943 Lisp_Object new_vector
;
7944 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7946 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7947 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7948 XVECTOR (new_vector
)->contents
,
7949 old_size
* sizeof (Lisp_Object
));
7950 tool_bar_items_vector
= new_vector
;
7953 /* Append entries from tool_bar_item_properties to the end of
7954 tool_bar_items_vector. */
7955 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7956 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7957 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7958 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7965 /* Read a character using menus based on maps in the array MAPS.
7966 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7967 Return t if we displayed a menu but the user rejected it.
7969 PREV_EVENT is the previous input event, or nil if we are reading
7970 the first event of a key sequence.
7972 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7973 if we used a mouse menu to read the input, or zero otherwise. If
7974 USED_MOUSE_MENU is null, we don't dereference it.
7976 The prompting is done based on the prompt-string of the map
7977 and the strings associated with various map elements.
7979 This can be done with X menus or with menus put in the minibuf.
7980 These are done in different ways, depending on how the input will be read.
7981 Menus using X are done after auto-saving in read-char, getting the input
7982 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7983 and do auto-saving in the inner call of read_char. */
7986 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7989 Lisp_Object prev_event
;
7990 int *used_mouse_menu
;
7993 register Lisp_Object name
= Qnil
;
7995 if (used_mouse_menu
)
7996 *used_mouse_menu
= 0;
7998 /* Use local over global Menu maps */
8000 if (! menu_prompting
)
8003 /* Optionally disregard all but the global map. */
8004 if (inhibit_local_menu_bar_menus
)
8006 maps
+= (nmaps
- 1);
8010 /* Get the menu name from the first map that has one (a prompt string). */
8011 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8013 name
= Fkeymap_prompt (maps
[mapno
]);
8018 /* If we don't have any menus, just read a character normally. */
8019 if (!STRINGP (name
))
8023 /* If we got to this point via a mouse click,
8024 use a real menu for mouse selection. */
8025 if (EVENT_HAS_PARAMETERS (prev_event
)
8026 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8027 && !EQ (XCAR (prev_event
), Qtool_bar
))
8029 /* Display the menu and get the selection. */
8030 Lisp_Object
*realmaps
8031 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8035 /* Use the maps that are not nil. */
8036 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8037 if (!NILP (maps
[mapno
]))
8038 realmaps
[nmaps1
++] = maps
[mapno
];
8040 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8045 record_menu_key (XCAR (value
));
8047 /* If we got multiple events, unread all but
8049 There is no way to prevent those unread events
8050 from showing up later in last_nonmenu_event.
8051 So turn symbol and integer events into lists,
8052 to indicate that they came from a mouse menu,
8053 so that when present in last_nonmenu_event
8054 they won't confuse things. */
8055 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8057 record_menu_key (XCAR (tem
));
8058 if (SYMBOLP (XCAR (tem
))
8059 || INTEGERP (XCAR (tem
)))
8060 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8063 /* If we got more than one event, put all but the first
8064 onto this list to be read later.
8065 Return just the first event now. */
8066 Vunread_command_events
8067 = nconc2 (XCDR (value
), Vunread_command_events
);
8068 value
= XCAR (value
);
8070 else if (NILP (value
))
8072 if (used_mouse_menu
)
8073 *used_mouse_menu
= 1;
8076 #endif /* HAVE_MENUS */
8080 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8081 We make this bigger when necessary, and never free it. */
8082 static char *read_char_minibuf_menu_text
;
8083 /* Size of that buffer. */
8084 static int read_char_minibuf_menu_width
;
8087 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8093 register Lisp_Object name
;
8095 /* FIXME: Use the minibuffer's frame width. */
8096 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8099 Lisp_Object rest
, vector
;
8105 if (! menu_prompting
)
8108 /* Make sure we have a big enough buffer for the menu text. */
8109 if (read_char_minibuf_menu_text
== 0)
8111 read_char_minibuf_menu_width
= width
+ 4;
8112 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8114 else if (width
+ 4 > read_char_minibuf_menu_width
)
8116 read_char_minibuf_menu_width
= width
+ 4;
8117 read_char_minibuf_menu_text
8118 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8120 menu
= read_char_minibuf_menu_text
;
8122 /* Get the menu name from the first map that has one (a prompt string). */
8123 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8125 name
= Fkeymap_prompt (maps
[mapno
]);
8130 /* If we don't have any menus, just read a character normally. */
8131 if (!STRINGP (name
))
8134 /* Prompt string always starts with map's prompt, and a space. */
8135 strcpy (menu
, SDATA (name
));
8136 nlength
= SBYTES (name
);
8137 menu
[nlength
++] = ':';
8138 menu
[nlength
++] = ' ';
8141 /* Start prompting at start of first map. */
8145 /* Present the documented bindings, a line at a time. */
8152 Lisp_Object orig_defn_macro
;
8154 /* Loop over elements of map. */
8159 /* If reached end of map, start at beginning of next map. */
8163 /* At end of last map, wrap around to first map if just starting,
8164 or end this line if already have something on it. */
8168 if (notfirst
|| nobindings
) break;
8173 /* Look at the next element of the map. */
8175 elt
= XVECTOR (vector
)->contents
[idx
];
8177 elt
= Fcar_safe (rest
);
8179 if (idx
< 0 && VECTORP (elt
))
8181 /* If we found a dense table in the keymap,
8182 advanced past it, but start scanning its contents. */
8183 rest
= Fcdr_safe (rest
);
8189 /* An ordinary element. */
8190 Lisp_Object event
, tem
;
8194 event
= Fcar_safe (elt
); /* alist */
8195 elt
= Fcdr_safe (elt
);
8199 XSETINT (event
, idx
); /* vector */
8202 /* Ignore the element if it has no prompt string. */
8203 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8205 /* 1 if the char to type matches the string. */
8207 Lisp_Object upcased_event
, downcased_event
;
8208 Lisp_Object desc
= Qnil
;
8210 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8212 upcased_event
= Fupcase (event
);
8213 downcased_event
= Fdowncase (event
);
8214 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8215 || XINT (downcased_event
) == SREF (s
, 0));
8217 desc
= Fsingle_key_description (event
, Qnil
);
8219 #if 0 /* It is redundant to list the equivalent key bindings because
8220 the prefix is what the user has already typed. */
8222 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8224 /* Insert equivalent keybinding. */
8225 s
= concat2 (s
, tem
);
8228 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8229 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8231 /* Insert button prefix. */
8232 Lisp_Object selected
8233 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8234 if (EQ (tem
, QCradio
))
8235 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8237 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8238 s
= concat2 (tem
, s
);
8242 /* If we have room for the prompt string, add it to this line.
8243 If this is the first on the line, always add it. */
8244 if ((SCHARS (s
) + i
+ 2
8245 + (char_matches
? 0 : SCHARS (desc
) + 3))
8251 /* Punctuate between strings. */
8254 strcpy (menu
+ i
, ", ");
8260 /* If the char to type doesn't match the string's
8261 first char, explicitly show what char to type. */
8264 /* Add as much of string as fits. */
8265 thiswidth
= SCHARS (desc
);
8266 if (thiswidth
+ i
> width
)
8267 thiswidth
= width
- i
;
8268 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8270 strcpy (menu
+ i
, " = ");
8274 /* Add as much of string as fits. */
8275 thiswidth
= SCHARS (s
);
8276 if (thiswidth
+ i
> width
)
8277 thiswidth
= width
- i
;
8278 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8284 /* If this element does not fit, end the line now,
8285 and save the element for the next line. */
8286 strcpy (menu
+ i
, "...");
8291 /* Move past this element. */
8292 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8293 /* Handle reaching end of dense table. */
8298 rest
= Fcdr_safe (rest
);
8302 /* Prompt with that and read response. */
8303 message2_nolog (menu
, strlen (menu
),
8304 ! NILP (current_buffer
->enable_multibyte_characters
));
8306 /* Make believe its not a keyboard macro in case the help char
8307 is pressed. Help characters are not recorded because menu prompting
8308 is not used on replay.
8310 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8311 current_kboard
->defining_kbd_macro
= Qnil
;
8313 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8314 while (BUFFERP (obj
));
8315 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8317 if (!INTEGERP (obj
))
8322 if (! EQ (obj
, menu_prompt_more_char
)
8323 && (!INTEGERP (menu_prompt_more_char
)
8324 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8326 if (!NILP (current_kboard
->defining_kbd_macro
))
8327 store_kbd_macro_char (obj
);
8330 /* Help char - go round again */
8334 /* Reading key sequences. */
8336 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8337 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8338 keymap, or nil otherwise. Return the index of the first keymap in
8339 which KEY has any binding, or NMAPS if no map has a binding.
8341 If KEY is a meta ASCII character, treat it like meta-prefix-char
8342 followed by the corresponding non-meta character. Keymaps in
8343 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8346 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8349 NEXT may be the same array as CURRENT. */
8352 follow_key (key
, nmaps
, current
, defs
, next
)
8354 Lisp_Object
*current
, *defs
, *next
;
8357 int i
, first_binding
;
8359 first_binding
= nmaps
;
8360 for (i
= nmaps
- 1; i
>= 0; i
--)
8362 if (! NILP (current
[i
]))
8364 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8365 if (! NILP (defs
[i
]))
8372 /* Given the set of bindings we've found, produce the next set of maps. */
8373 if (first_binding
< nmaps
)
8374 for (i
= 0; i
< nmaps
; i
++)
8375 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8377 return first_binding
;
8380 /* Structure used to keep track of partial application of key remapping
8381 such as Vfunction_key_map and Vkey_translation_map. */
8382 typedef struct keyremap
8384 Lisp_Object map
, parent
;
8388 /* Lookup KEY in MAP.
8389 MAP is a keymap mapping keys to key vectors or functions.
8390 If the mapping is a function and DO_FUNCTION is non-zero, then
8391 the function is called with PROMPT as parameter and its return
8392 value is used as the return value of this function (after checking
8393 that it is indeed a vector). */
8396 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8397 Lisp_Object map
, key
, prompt
;
8402 next
= access_keymap (map
, key
, 1, 0, 1);
8404 /* Handle symbol with autoload definition. */
8405 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8406 && CONSP (XSYMBOL (next
)->function
)
8407 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8408 do_autoload (XSYMBOL (next
)->function
, next
);
8410 /* Handle a symbol whose function definition is a keymap
8412 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8413 && (ARRAYP (XSYMBOL (next
)->function
)
8414 || KEYMAPP (XSYMBOL (next
)->function
)))
8415 next
= XSYMBOL (next
)->function
;
8417 /* If the keymap gives a function, not an
8418 array, then call the function with one arg and use
8419 its value instead. */
8420 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8425 next
= call1 (next
, prompt
);
8426 /* If the function returned something invalid,
8427 barf--don't ignore it.
8428 (To ignore it safely, we would need to gcpro a bunch of
8429 other variables.) */
8430 if (! (VECTORP (next
) || STRINGP (next
)))
8431 error ("Function %s returns invalid key sequence", tem
);
8436 /* Do one step of the key remapping used for function-key-map and
8437 key-translation-map:
8438 KEYBUF is the buffer holding the input events.
8439 BUFSIZE is its maximum size.
8440 FKEY is a pointer to the keyremap structure to use.
8441 INPUT is the index of the last element in KEYBUF.
8442 DOIT if non-zero says that the remapping can actually take place.
8443 DIFF is used to return the number of keys added/removed by the remapping.
8444 PARENT is the root of the keymap.
8445 PROMPT is the prompt to use if the remapping happens through a function.
8446 The return value is non-zero if the remapping actually took place. */
8449 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8450 Lisp_Object
*keybuf
, prompt
;
8452 int input
, doit
, *diff
, bufsize
;
8454 Lisp_Object next
, key
;
8456 key
= keybuf
[fkey
->end
++];
8457 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8459 /* If keybuf[fkey->start..fkey->end] is bound in the
8460 map and we're in a position to do the key remapping, replace it with
8461 the binding and restart with fkey->start at the end. */
8462 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8464 int len
= XFASTINT (Flength (next
));
8467 *diff
= len
- (fkey
->end
- fkey
->start
);
8469 if (input
+ *diff
>= bufsize
)
8470 error ("Key sequence too long");
8472 /* Shift the keys that follow fkey->end. */
8474 for (i
= fkey
->end
; i
< input
; i
++)
8475 keybuf
[i
+ *diff
] = keybuf
[i
];
8477 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8478 keybuf
[i
+ *diff
] = keybuf
[i
];
8479 /* Overwrite the old keys with the new ones. */
8480 for (i
= 0; i
< len
; i
++)
8481 keybuf
[fkey
->start
+ i
]
8482 = Faref (next
, make_number (i
));
8484 fkey
->start
= fkey
->end
+= *diff
;
8485 fkey
->map
= fkey
->parent
;
8490 fkey
->map
= get_keymap (next
, 0, 1);
8492 /* If we no longer have a bound suffix, try a new position for
8494 if (!CONSP (fkey
->map
))
8496 fkey
->end
= ++fkey
->start
;
8497 fkey
->map
= fkey
->parent
;
8502 /* Read a sequence of keys that ends with a non prefix character,
8503 storing it in KEYBUF, a buffer of size BUFSIZE.
8505 Return the length of the key sequence stored.
8506 Return -1 if the user rejected a command menu.
8508 Echo starting immediately unless `prompt' is 0.
8510 Where a key sequence ends depends on the currently active keymaps.
8511 These include any minor mode keymaps active in the current buffer,
8512 the current buffer's local map, and the global map.
8514 If a key sequence has no other bindings, we check Vfunction_key_map
8515 to see if some trailing subsequence might be the beginning of a
8516 function key's sequence. If so, we try to read the whole function
8517 key, and substitute its symbolic name into the key sequence.
8519 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8520 `double-' events into similar click events, if that would make them
8521 bound. We try to turn `triple-' events first into `double-' events,
8524 If we get a mouse click in a mode line, vertical divider, or other
8525 non-text area, we treat the click as if it were prefixed by the
8526 symbol denoting that area - `mode-line', `vertical-line', or
8529 If the sequence starts with a mouse click, we read the key sequence
8530 with respect to the buffer clicked on, not the current buffer.
8532 If the user switches frames in the midst of a key sequence, we put
8533 off the switch-frame event until later; the next call to
8534 read_char will return it.
8536 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8537 from the selected window's buffer. */
8540 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8541 can_return_switch_frame
, fix_current_buffer
)
8542 Lisp_Object
*keybuf
;
8545 int dont_downcase_last
;
8546 int can_return_switch_frame
;
8547 int fix_current_buffer
;
8549 volatile Lisp_Object from_string
;
8550 volatile int count
= SPECPDL_INDEX ();
8552 /* How many keys there are in the current key sequence. */
8555 /* The length of the echo buffer when we started reading, and
8556 the length of this_command_keys when we started reading. */
8557 volatile int echo_start
;
8558 volatile int keys_start
;
8560 /* The number of keymaps we're scanning right now, and the number of
8561 keymaps we have allocated space for. */
8563 volatile int nmaps_allocated
= 0;
8565 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8566 the current keymaps. */
8567 Lisp_Object
*volatile defs
= NULL
;
8569 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8570 in the current keymaps, or nil where it is not a prefix. */
8571 Lisp_Object
*volatile submaps
= NULL
;
8573 /* The local map to start out with at start of key sequence. */
8574 volatile Lisp_Object orig_local_map
;
8576 /* The map from the `keymap' property to start out with at start of
8578 volatile Lisp_Object orig_keymap
;
8580 /* 1 if we have already considered switching to the local-map property
8581 of the place where a mouse click occurred. */
8582 volatile int localized_local_map
= 0;
8584 /* The index in defs[] of the first keymap that has a binding for
8585 this key sequence. In other words, the lowest i such that
8586 defs[i] is non-nil. */
8587 volatile int first_binding
;
8588 /* Index of the first key that has no binding.
8589 It is useless to try fkey.start larger than that. */
8590 volatile int first_unbound
;
8592 /* If t < mock_input, then KEYBUF[t] should be read as the next
8595 We use this to recover after recognizing a function key. Once we
8596 realize that a suffix of the current key sequence is actually a
8597 function key's escape sequence, we replace the suffix with the
8598 function key's binding from Vfunction_key_map. Now keybuf
8599 contains a new and different key sequence, so the echo area,
8600 this_command_keys, and the submaps and defs arrays are wrong. In
8601 this situation, we set mock_input to t, set t to 0, and jump to
8602 restart_sequence; the loop will read keys from keybuf up until
8603 mock_input, thus rebuilding the state; and then it will resume
8604 reading characters from the keyboard. */
8605 volatile int mock_input
= 0;
8607 /* If the sequence is unbound in submaps[], then
8608 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8609 and fkey.map is its binding.
8611 These might be > t, indicating that all function key scanning
8612 should hold off until t reaches them. We do this when we've just
8613 recognized a function key, to avoid searching for the function
8614 key's again in Vfunction_key_map. */
8615 volatile keyremap fkey
;
8617 /* Likewise, for key_translation_map. */
8618 volatile keyremap keytran
;
8620 /* If we receive a `switch-frame' or `select-window' event in the middle of
8621 a key sequence, we put it off for later.
8622 While we're reading, we keep the event here. */
8623 volatile Lisp_Object delayed_switch_frame
;
8625 /* See the comment below... */
8626 #if defined (GOBBLE_FIRST_EVENT)
8627 Lisp_Object first_event
;
8630 volatile Lisp_Object original_uppercase
;
8631 volatile int original_uppercase_position
= -1;
8633 /* Gets around Microsoft compiler limitations. */
8636 struct buffer
*starting_buffer
;
8638 /* List of events for which a fake prefix key has been generated. */
8639 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8641 #if defined (GOBBLE_FIRST_EVENT)
8645 struct gcpro gcpro1
;
8647 GCPRO1 (fake_prefixed_keys
);
8648 raw_keybuf_count
= 0;
8650 last_nonmenu_event
= Qnil
;
8652 delayed_switch_frame
= Qnil
;
8653 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8654 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8655 /* If there is no translation-map, turn off scanning. */
8656 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8657 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8662 echo_prompt (prompt
);
8663 else if (cursor_in_echo_area
8664 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8665 && NILP (Fzerop (Vecho_keystrokes
)))
8666 /* This doesn't put in a dash if the echo buffer is empty, so
8667 you don't always see a dash hanging out in the minibuffer. */
8671 /* Record the initial state of the echo area and this_command_keys;
8672 we will need to restore them if we replay a key sequence. */
8674 echo_start
= echo_length ();
8675 keys_start
= this_command_key_count
;
8676 this_single_command_key_start
= keys_start
;
8678 #if defined (GOBBLE_FIRST_EVENT)
8679 /* This doesn't quite work, because some of the things that read_char
8680 does cannot safely be bypassed. It seems too risky to try to make
8683 /* Read the first char of the sequence specially, before setting
8684 up any keymaps, in case a filter runs and switches buffers on us. */
8685 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8687 #endif /* GOBBLE_FIRST_EVENT */
8689 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8690 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8693 /* We jump here when the key sequence has been thoroughly changed, and
8694 we need to rescan it starting from the beginning. When we jump here,
8695 keybuf[0..mock_input] holds the sequence we should reread. */
8698 starting_buffer
= current_buffer
;
8699 first_unbound
= bufsize
+ 1;
8701 /* Build our list of keymaps.
8702 If we recognize a function key and replace its escape sequence in
8703 keybuf with its symbol, or if the sequence starts with a mouse
8704 click and we need to switch buffers, we jump back here to rebuild
8705 the initial keymaps from the current buffer. */
8708 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8709 || !NILP (Voverriding_local_map
))
8711 if (3 > nmaps_allocated
)
8713 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8714 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8715 nmaps_allocated
= 3;
8717 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8718 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8719 if (!NILP (Voverriding_local_map
))
8720 submaps
[nmaps
++] = Voverriding_local_map
;
8728 nminor
= current_minor_maps (0, &maps
);
8729 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8731 if (total
> nmaps_allocated
)
8733 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8734 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8735 nmaps_allocated
= total
;
8738 if (!NILP (orig_keymap
))
8739 submaps
[nmaps
++] = orig_keymap
;
8741 bcopy (maps
, (void *) (submaps
+ nmaps
),
8742 nminor
* sizeof (submaps
[0]));
8746 submaps
[nmaps
++] = orig_local_map
;
8748 submaps
[nmaps
++] = current_global_map
;
8750 /* Find an accurate initial value for first_binding. */
8751 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8752 if (! NILP (submaps
[first_binding
]))
8755 /* Start from the beginning in keybuf. */
8758 /* These are no-ops the first time through, but if we restart, they
8759 revert the echo area and this_command_keys to their original state. */
8760 this_command_key_count
= keys_start
;
8761 if (INTERACTIVE
&& t
< mock_input
)
8762 echo_truncate (echo_start
);
8764 /* If the best binding for the current key sequence is a keymap, or
8765 we may be looking at a function key's escape sequence, keep on
8767 while (first_binding
< nmaps
8768 /* Keep reading as long as there's a prefix binding. */
8769 ? !NILP (submaps
[first_binding
])
8770 /* Don't return in the middle of a possible function key sequence,
8771 if the only bindings we found were via case conversion.
8772 Thus, if ESC O a has a function-key-map translation
8773 and ESC o has a binding, don't return after ESC O,
8774 so that we can translate ESC O plus the next character. */
8775 : (fkey
.start
< t
|| keytran
.start
< t
))
8778 int used_mouse_menu
= 0;
8780 /* Where the last real key started. If we need to throw away a
8781 key that has expanded into more than one element of keybuf
8782 (say, a mouse click on the mode line which is being treated
8783 as [mode-line (mouse-...)], then we backtrack to this point
8785 volatile int last_real_key_start
;
8787 /* These variables are analogous to echo_start and keys_start;
8788 while those allow us to restart the entire key sequence,
8789 echo_local_start and keys_local_start allow us to throw away
8791 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8793 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8794 eassert (fkey
.start
<= fkey
.end
);
8795 eassert (keytran
.start
<= keytran
.end
);
8796 /* key-translation-map is applied *after* function-key-map. */
8797 eassert (keytran
.end
<= fkey
.start
);
8799 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8800 { /* The prefix upto first_unbound has no binding and has
8801 no translation left to do either, so we know it's unbound.
8802 If we don't stop now, we risk staying here indefinitely
8803 (if the user keeps entering fkey or keytran prefixes
8804 like C-c ESC ESC ESC ESC ...) */
8806 for (i
= first_unbound
+ 1; i
< t
; i
++)
8807 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8808 mock_input
= t
- first_unbound
- 1;
8809 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8810 fkey
.map
= fkey
.parent
;
8811 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8812 keytran
.map
= keytran
.parent
;
8813 goto replay_sequence
;
8817 error ("Key sequence too long");
8820 echo_local_start
= echo_length ();
8821 keys_local_start
= this_command_key_count
;
8822 local_first_binding
= first_binding
;
8825 /* These are no-ops, unless we throw away a keystroke below and
8826 jumped back up to replay_key; in that case, these restore the
8827 variables to their original state, allowing us to replay the
8829 if (INTERACTIVE
&& t
< mock_input
)
8830 echo_truncate (echo_local_start
);
8831 this_command_key_count
= keys_local_start
;
8832 first_binding
= local_first_binding
;
8834 /* By default, assume each event is "real". */
8835 last_real_key_start
= t
;
8837 /* Does mock_input indicate that we are re-reading a key sequence? */
8841 add_command_key (key
);
8842 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8843 && NILP (Fzerop (Vecho_keystrokes
)))
8847 /* If not, we should actually read a character. */
8852 KBOARD
*interrupted_kboard
= current_kboard
;
8853 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8854 if (setjmp (wrong_kboard_jmpbuf
))
8856 if (!NILP (delayed_switch_frame
))
8858 interrupted_kboard
->kbd_queue
8859 = Fcons (delayed_switch_frame
,
8860 interrupted_kboard
->kbd_queue
);
8861 delayed_switch_frame
= Qnil
;
8864 interrupted_kboard
->kbd_queue
8865 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8867 /* If the side queue is non-empty, ensure it begins with a
8868 switch-frame, so we'll replay it in the right context. */
8869 if (CONSP (interrupted_kboard
->kbd_queue
)
8870 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8871 !(EVENT_HAS_PARAMETERS (key
)
8872 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8876 XSETFRAME (frame
, interrupted_frame
);
8877 interrupted_kboard
->kbd_queue
8878 = Fcons (make_lispy_switch_frame (frame
),
8879 interrupted_kboard
->kbd_queue
);
8882 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8883 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8884 goto replay_sequence
;
8887 key
= read_char (NILP (prompt
), nmaps
,
8888 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8889 &used_mouse_menu
, NULL
);
8892 /* read_char returns t when it shows a menu and the user rejects it.
8896 unbind_to (count
, Qnil
);
8901 /* read_char returns -1 at the end of a macro.
8902 Emacs 18 handles this by returning immediately with a
8903 zero, so that's what we'll do. */
8904 if (INTEGERP (key
) && XINT (key
) == -1)
8907 /* The Microsoft C compiler can't handle the goto that
8913 /* If the current buffer has been changed from under us, the
8914 keymap may have changed, so replay the sequence. */
8917 timer_resume_idle ();
8920 /* Reset the current buffer from the selected window
8921 in case something changed the former and not the latter.
8922 This is to be more consistent with the behavior
8923 of the command_loop_1. */
8924 if (fix_current_buffer
)
8926 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8928 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8929 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8932 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8933 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8934 goto replay_sequence
;
8937 /* If we have a quit that was typed in another frame, and
8938 quit_throw_to_read_char switched buffers,
8939 replay to get the right keymap. */
8941 && XINT (key
) == quit_char
8942 && current_buffer
!= starting_buffer
)
8945 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8949 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8950 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8951 goto replay_sequence
;
8956 if (EVENT_HAS_PARAMETERS (key
)
8957 /* Either a `switch-frame' or a `select-window' event. */
8958 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8960 /* If we're at the beginning of a key sequence, and the caller
8961 says it's okay, go ahead and return this event. If we're
8962 in the midst of a key sequence, delay it until the end. */
8963 if (t
> 0 || !can_return_switch_frame
)
8965 delayed_switch_frame
= key
;
8971 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8974 /* Clicks in non-text areas get prefixed by the symbol
8975 in their CHAR-ADDRESS field. For example, a click on
8976 the mode line is prefixed by the symbol `mode-line'.
8978 Furthermore, key sequences beginning with mouse clicks
8979 are read using the keymaps of the buffer clicked on, not
8980 the current buffer. So we may have to switch the buffer
8983 When we turn one event into two events, we must make sure
8984 that neither of the two looks like the original--so that,
8985 if we replay the events, they won't be expanded again.
8986 If not for this, such reexpansion could happen either here
8987 or when user programs play with this-command-keys. */
8988 if (EVENT_HAS_PARAMETERS (key
))
8993 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8994 if (EQ (kind
, Qmouse_click
))
8996 Lisp_Object window
, posn
;
8998 window
= POSN_WINDOW (EVENT_START (key
));
8999 posn
= POSN_POSN (EVENT_START (key
));
9002 || (!NILP (fake_prefixed_keys
)
9003 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9005 /* We're looking a second time at an event for which
9006 we generated a fake prefix key. Set
9007 last_real_key_start appropriately. */
9009 last_real_key_start
= t
- 1;
9012 /* Key sequences beginning with mouse clicks are
9013 read using the keymaps in the buffer clicked on,
9014 not the current buffer. If we're at the
9015 beginning of a key sequence, switch buffers. */
9016 if (last_real_key_start
== 0
9018 && BUFFERP (XWINDOW (window
)->buffer
)
9019 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9021 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9025 /* Arrange to go back to the original buffer once we're
9026 done reading the key sequence. Note that we can't
9027 use save_excursion_{save,restore} here, because they
9028 save point as well as the current buffer; we don't
9029 want to save point, because redisplay may change it,
9030 to accommodate a Fset_window_start or something. We
9031 don't want to do this at the top of the function,
9032 because we may get input from a subprocess which
9033 wants to change the selected window and stuff (say,
9035 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9037 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9039 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9040 orig_local_map
= get_local_map (PT
, current_buffer
,
9042 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9043 goto replay_sequence
;
9046 /* For a mouse click, get the local text-property keymap
9047 of the place clicked on, rather than point. */
9048 if (last_real_key_start
== 0
9049 && CONSP (XCDR (key
))
9050 && ! localized_local_map
)
9052 Lisp_Object map_here
, start
, pos
;
9054 localized_local_map
= 1;
9055 start
= EVENT_START (key
);
9057 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9059 pos
= POSN_BUFFER_POSN (start
);
9061 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9063 map_here
= get_local_map (XINT (pos
),
9064 current_buffer
, Qlocal_map
);
9065 if (!EQ (map_here
, orig_local_map
))
9067 orig_local_map
= map_here
;
9071 goto replay_sequence
;
9073 map_here
= get_local_map (XINT (pos
),
9074 current_buffer
, Qkeymap
);
9075 if (!EQ (map_here
, orig_keymap
))
9077 orig_keymap
= map_here
;
9081 goto replay_sequence
;
9087 /* Expand mode-line and scroll-bar events into two events:
9088 use posn as a fake prefix key. */
9090 && (NILP (fake_prefixed_keys
)
9091 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9093 if (t
+ 1 >= bufsize
)
9094 error ("Key sequence too long");
9097 keybuf
[t
+ 1] = key
;
9100 /* Record that a fake prefix key has been generated
9101 for KEY. Don't modify the event; this would
9102 prevent proper action when the event is pushed
9103 back into unread-command-events. */
9104 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9106 /* If on a mode line string with a local keymap,
9107 reconsider the key sequence with that keymap. */
9108 if (string
= POSN_STRING (EVENT_START (key
)),
9109 (CONSP (string
) && STRINGP (XCAR (string
))))
9111 Lisp_Object pos
, map
, map2
;
9113 pos
= XCDR (string
);
9114 string
= XCAR (string
);
9116 && XINT (pos
) < SCHARS (string
))
9118 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9120 orig_local_map
= map
;
9121 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9124 if (!NILP (map
) || !NILP (map2
))
9125 goto replay_sequence
;
9131 else if (NILP (from_string
)
9132 && (string
= POSN_STRING (EVENT_START (key
)),
9133 (CONSP (string
) && STRINGP (XCAR (string
)))))
9135 /* For a click on a string, i.e. overlay string or a
9136 string displayed via the `display' property,
9137 consider `local-map' and `keymap' properties of
9139 Lisp_Object pos
, map
, map2
;
9141 pos
= XCDR (string
);
9142 string
= XCAR (string
);
9144 && XINT (pos
) < SCHARS (string
))
9146 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9148 orig_local_map
= map
;
9149 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9153 if (!NILP (map
) || !NILP (map2
))
9155 from_string
= string
;
9156 goto replay_sequence
;
9161 else if (CONSP (XCDR (key
))
9162 && CONSP (EVENT_START (key
))
9163 && CONSP (XCDR (EVENT_START (key
))))
9167 posn
= POSN_POSN (EVENT_START (key
));
9168 /* Handle menu-bar events:
9169 insert the dummy prefix event `menu-bar'. */
9170 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9172 if (t
+ 1 >= bufsize
)
9173 error ("Key sequence too long");
9177 /* Zap the position in key, so we know that we've
9178 expanded it, and don't try to do so again. */
9179 POSN_SET_POSN (EVENT_START (key
),
9180 Fcons (posn
, Qnil
));
9183 goto replay_sequence
;
9185 else if (CONSP (posn
))
9187 /* We're looking at the second event of a
9188 sequence which we expanded before. Set
9189 last_real_key_start appropriately. */
9190 if (last_real_key_start
== t
&& t
> 0)
9191 last_real_key_start
= t
- 1;
9196 /* We have finally decided that KEY is something we might want
9198 first_binding
= (follow_key (key
,
9199 nmaps
- first_binding
,
9200 submaps
+ first_binding
,
9201 defs
+ first_binding
,
9202 submaps
+ first_binding
)
9205 /* If KEY wasn't bound, we'll try some fallbacks. */
9206 if (first_binding
< nmaps
)
9207 /* This is needed for the following scenario:
9208 event 0: a down-event that gets dropped by calling replay_key.
9209 event 1: some normal prefix like C-h.
9210 After event 0, first_unbound is 0, after event 1 fkey.start
9211 and keytran.start are both 1, so when we see that C-h is bound,
9212 we need to update first_unbound. */
9213 first_unbound
= max (t
+ 1, first_unbound
);
9218 /* Remember the position to put an upper bound on fkey.start. */
9219 first_unbound
= min (t
, first_unbound
);
9221 head
= EVENT_HEAD (key
);
9222 if (help_char_p (head
) && t
> 0)
9224 read_key_sequence_cmd
= Vprefix_help_command
;
9226 last_nonmenu_event
= key
;
9227 /* The Microsoft C compiler can't handle the goto that
9235 Lisp_Object breakdown
;
9238 breakdown
= parse_modifiers (head
);
9239 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9240 /* Attempt to reduce an unbound mouse event to a simpler
9241 event that is bound:
9242 Drags reduce to clicks.
9243 Double-clicks reduce to clicks.
9244 Triple-clicks reduce to double-clicks, then to clicks.
9245 Down-clicks are eliminated.
9246 Double-downs reduce to downs, then are eliminated.
9247 Triple-downs reduce to double-downs, then to downs,
9248 then are eliminated. */
9249 if (modifiers
& (down_modifier
| drag_modifier
9250 | double_modifier
| triple_modifier
))
9252 while (modifiers
& (down_modifier
| drag_modifier
9253 | double_modifier
| triple_modifier
))
9255 Lisp_Object new_head
, new_click
;
9256 if (modifiers
& triple_modifier
)
9257 modifiers
^= (double_modifier
| triple_modifier
);
9258 else if (modifiers
& double_modifier
)
9259 modifiers
&= ~double_modifier
;
9260 else if (modifiers
& drag_modifier
)
9261 modifiers
&= ~drag_modifier
;
9264 /* Dispose of this `down' event by simply jumping
9265 back to replay_key, to get another event.
9267 Note that if this event came from mock input,
9268 then just jumping back to replay_key will just
9269 hand it to us again. So we have to wipe out any
9272 We could delete keybuf[t] and shift everything
9273 after that to the left by one spot, but we'd also
9274 have to fix up any variable that points into
9275 keybuf, and shifting isn't really necessary
9278 Adding prefixes for non-textual mouse clicks
9279 creates two characters of mock input, and both
9280 must be thrown away. If we're only looking at
9281 the prefix now, we can just jump back to
9282 replay_key. On the other hand, if we've already
9283 processed the prefix, and now the actual click
9284 itself is giving us trouble, then we've lost the
9285 state of the keymaps we want to backtrack to, and
9286 we need to replay the whole sequence to rebuild
9289 Beyond that, only function key expansion could
9290 create more than two keys, but that should never
9291 generate mouse events, so it's okay to zero
9292 mock_input in that case too.
9294 FIXME: The above paragraph seems just plain
9295 wrong, if you consider things like
9296 xterm-mouse-mode. -stef
9298 Isn't this just the most wonderful code ever? */
9300 /* If mock_input > t + 1, the above simplification
9301 will actually end up dropping keys on the floor.
9302 This is probably OK for now, but even
9303 if mock_input <= t + 1, we need to adjust fkey
9305 Typical case [header-line down-mouse-N]:
9306 mock_input = 2, t = 1, fkey.end = 1,
9307 last_real_key_start = 0. */
9308 if (fkey
.end
> last_real_key_start
)
9310 fkey
.end
= fkey
.start
9311 = min (last_real_key_start
, fkey
.start
);
9312 fkey
.map
= fkey
.parent
;
9313 if (keytran
.end
> last_real_key_start
)
9315 keytran
.end
= keytran
.start
9316 = min (last_real_key_start
, keytran
.start
);
9317 keytran
.map
= keytran
.parent
;
9320 if (t
== last_real_key_start
)
9327 mock_input
= last_real_key_start
;
9328 goto replay_sequence
;
9333 = apply_modifiers (modifiers
, XCAR (breakdown
));
9335 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9337 /* Look for a binding for this new key. follow_key
9338 promises that it didn't munge submaps the
9339 last time we called it, since key was unbound. */
9341 = (follow_key (new_click
,
9342 nmaps
- local_first_binding
,
9343 submaps
+ local_first_binding
,
9344 defs
+ local_first_binding
,
9345 submaps
+ local_first_binding
)
9346 + local_first_binding
);
9348 /* If that click is bound, go for it. */
9349 if (first_binding
< nmaps
)
9354 /* Otherwise, we'll leave key set to the drag event. */
9361 /* Normally, last_nonmenu_event gets the previous key we read.
9362 But when a mouse popup menu is being used,
9363 we don't update last_nonmenu_event; it continues to hold the mouse
9364 event that preceded the first level of menu. */
9365 if (!used_mouse_menu
)
9366 last_nonmenu_event
= key
;
9368 /* Record what part of this_command_keys is the current key sequence. */
9369 this_single_command_key_start
= this_command_key_count
- t
;
9371 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9372 /* There is a binding and it's not a prefix.
9373 There is thus no function-key in this sequence.
9374 Moving fkey.start is important in this case to allow keytran.start
9375 to go over the sequence before we return (since we keep the
9376 invariant that keytran.end <= fkey.start). */
9379 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9382 /* If the sequence is unbound, see if we can hang a function key
9383 off the end of it. */
9384 /* Continue scan from fkey.end until we find a bound suffix. */
9385 while (fkey
.end
< t
)
9387 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9390 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9391 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9392 max (t
, mock_input
),
9393 /* If there's a binding (i.e.
9394 first_binding >= nmaps) we don't want
9395 to apply this function-key-mapping. */
9396 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9401 mock_input
= diff
+ max (t
, mock_input
);
9402 goto replay_sequence
;
9406 /* Look for this sequence in key-translation-map.
9407 Scan from keytran.end until we find a bound suffix. */
9408 while (keytran
.end
< fkey
.start
)
9410 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9413 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9414 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9419 mock_input
= diff
+ max (t
, mock_input
);
9420 /* Adjust the function-key-map counters. */
9424 goto replay_sequence
;
9428 /* If KEY is not defined in any of the keymaps,
9429 and cannot be part of a function key or translation,
9430 and is an upper case letter
9431 use the corresponding lower-case letter instead. */
9432 if (first_binding
>= nmaps
9433 && fkey
.start
>= t
&& keytran
.start
>= t
9435 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9436 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9437 || (XINT (key
) & shift_modifier
)))
9439 Lisp_Object new_key
;
9441 original_uppercase
= key
;
9442 original_uppercase_position
= t
- 1;
9444 if (XINT (key
) & shift_modifier
)
9445 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9447 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9448 | (XINT (key
) & ~CHAR_MODIFIER_MASK
)));
9450 /* We have to do this unconditionally, regardless of whether
9451 the lower-case char is defined in the keymaps, because they
9452 might get translated through function-key-map. */
9453 keybuf
[t
- 1] = new_key
;
9454 mock_input
= max (t
, mock_input
);
9456 goto replay_sequence
;
9458 /* If KEY is not defined in any of the keymaps,
9459 and cannot be part of a function key or translation,
9460 and is a shifted function key,
9461 use the corresponding unshifted function key instead. */
9462 if (first_binding
>= nmaps
9463 && fkey
.start
>= t
&& keytran
.start
>= t
9466 Lisp_Object breakdown
;
9469 breakdown
= parse_modifiers (key
);
9470 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9471 if (modifiers
& shift_modifier
)
9473 Lisp_Object new_key
;
9475 original_uppercase
= key
;
9476 original_uppercase_position
= t
- 1;
9478 modifiers
&= ~shift_modifier
;
9479 new_key
= apply_modifiers (modifiers
,
9482 keybuf
[t
- 1] = new_key
;
9483 mock_input
= max (t
, mock_input
);
9484 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9485 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9487 goto replay_sequence
;
9493 read_key_sequence_cmd
= (first_binding
< nmaps
9494 ? defs
[first_binding
]
9497 unread_switch_frame
= delayed_switch_frame
;
9498 unbind_to (count
, Qnil
);
9500 /* Don't downcase the last character if the caller says don't.
9501 Don't downcase it if the result is undefined, either. */
9502 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9504 && t
- 1 == original_uppercase_position
)
9505 keybuf
[t
- 1] = original_uppercase
;
9507 /* Occasionally we fabricate events, perhaps by expanding something
9508 according to function-key-map, or by adding a prefix symbol to a
9509 mouse click in the scroll bar or modeline. In this cases, return
9510 the entire generated key sequence, even if we hit an unbound
9511 prefix or a definition before the end. This means that you will
9512 be able to push back the event properly, and also means that
9513 read-key-sequence will always return a logical unit.
9516 for (; t
< mock_input
; t
++)
9518 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9519 && NILP (Fzerop (Vecho_keystrokes
)))
9520 echo_char (keybuf
[t
]);
9521 add_command_key (keybuf
[t
]);
9530 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9531 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9532 The sequence is sufficient to specify a non-prefix command in the
9533 current local and global maps.
9535 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9536 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9537 as a continuation of the previous key.
9539 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9540 convert the last event to lower case. (Normally any upper case event
9541 is converted to lower case if the original event is undefined and the lower
9542 case equivalent is defined.) A non-nil value is appropriate for reading
9543 a key sequence to be defined.
9545 A C-g typed while in this function is treated like any other character,
9546 and `quit-flag' is not set.
9548 If the key sequence starts with a mouse click, then the sequence is read
9549 using the keymaps of the buffer of the window clicked in, not the buffer
9550 of the selected window as normal.
9552 `read-key-sequence' drops unbound button-down events, since you normally
9553 only care about the click or drag events which follow them. If a drag
9554 or multi-click event is unbound, but the corresponding click event would
9555 be bound, `read-key-sequence' turns the event into a click event at the
9556 drag's starting position. This means that you don't have to distinguish
9557 between click and drag, double, or triple events unless you want to.
9559 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9560 lines separating windows, and scroll bars with imaginary keys
9561 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9563 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9564 function will process a switch-frame event if the user switches frames
9565 before typing anything. If the user switches frames in the middle of a
9566 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9567 is nil, then the event will be put off until after the current key sequence.
9569 `read-key-sequence' checks `function-key-map' for function key
9570 sequences, where they wouldn't conflict with ordinary bindings. See
9571 `function-key-map' for more details.
9573 The optional fifth argument COMMAND-LOOP, if non-nil, means
9574 that this key sequence is being read by something that will
9575 read commands one after another. It should be nil if the caller
9576 will read just one key sequence. */)
9577 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9579 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9580 Lisp_Object can_return_switch_frame
, command_loop
;
9582 Lisp_Object keybuf
[30];
9584 struct gcpro gcpro1
;
9585 int count
= SPECPDL_INDEX ();
9588 CHECK_STRING (prompt
);
9591 specbind (Qinput_method_exit_on_first_char
,
9592 (NILP (command_loop
) ? Qt
: Qnil
));
9593 specbind (Qinput_method_use_echo_area
,
9594 (NILP (command_loop
) ? Qt
: Qnil
));
9596 bzero (keybuf
, sizeof keybuf
);
9598 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9600 if (NILP (continue_echo
))
9602 this_command_key_count
= 0;
9603 this_command_key_count_reset
= 0;
9604 this_single_command_key_start
= 0;
9607 #ifdef HAVE_X_WINDOWS
9608 if (display_hourglass_p
)
9609 cancel_hourglass ();
9612 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9613 prompt
, ! NILP (dont_downcase_last
),
9614 ! NILP (can_return_switch_frame
), 0);
9616 #if 0 /* The following is fine for code reading a key sequence and
9617 then proceeding with a lenghty computation, but it's not good
9618 for code reading keys in a loop, like an input method. */
9619 #ifdef HAVE_X_WINDOWS
9620 if (display_hourglass_p
)
9631 return unbind_to (count
, make_event_array (i
, keybuf
));
9634 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9635 Sread_key_sequence_vector
, 1, 5, 0,
9636 doc
: /* Like `read-key-sequence' but always return a vector. */)
9637 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9639 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9640 Lisp_Object can_return_switch_frame
, command_loop
;
9642 Lisp_Object keybuf
[30];
9644 struct gcpro gcpro1
;
9645 int count
= SPECPDL_INDEX ();
9648 CHECK_STRING (prompt
);
9651 specbind (Qinput_method_exit_on_first_char
,
9652 (NILP (command_loop
) ? Qt
: Qnil
));
9653 specbind (Qinput_method_use_echo_area
,
9654 (NILP (command_loop
) ? Qt
: Qnil
));
9656 bzero (keybuf
, sizeof keybuf
);
9658 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9660 if (NILP (continue_echo
))
9662 this_command_key_count
= 0;
9663 this_command_key_count_reset
= 0;
9664 this_single_command_key_start
= 0;
9667 #ifdef HAVE_X_WINDOWS
9668 if (display_hourglass_p
)
9669 cancel_hourglass ();
9672 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9673 prompt
, ! NILP (dont_downcase_last
),
9674 ! NILP (can_return_switch_frame
), 0);
9676 #ifdef HAVE_X_WINDOWS
9677 if (display_hourglass_p
)
9687 return unbind_to (count
, Fvector (i
, keybuf
));
9690 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9691 doc
: /* Execute CMD as an editor command.
9692 CMD must be a symbol that satisfies the `commandp' predicate.
9693 Optional second arg RECORD-FLAG non-nil
9694 means unconditionally put this command in `command-history'.
9695 Otherwise, that is done only if an arg is read using the minibuffer.
9696 The argument KEYS specifies the value to use instead of (this-command-keys)
9697 when reading the arguments; if it is nil, (this-command-keys) is used.
9698 The argument SPECIAL, if non-nil, means that this command is executing
9699 a special event, so ignore the prefix argument and don't clear it. */)
9700 (cmd
, record_flag
, keys
, special
)
9701 Lisp_Object cmd
, record_flag
, keys
, special
;
9703 register Lisp_Object final
;
9704 register Lisp_Object tem
;
9705 Lisp_Object prefixarg
;
9706 struct backtrace backtrace
;
9707 extern int debug_on_next_call
;
9709 debug_on_next_call
= 0;
9713 prefixarg
= current_kboard
->Vprefix_arg
;
9714 Vcurrent_prefix_arg
= prefixarg
;
9715 current_kboard
->Vprefix_arg
= Qnil
;
9722 tem
= Fget (cmd
, Qdisabled
);
9723 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9725 tem
= Fsymbol_value (Qdisabled_command_function
);
9727 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9733 final
= Findirect_function (cmd
, Qnil
);
9735 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9737 struct gcpro gcpro1
, gcpro2
;
9739 GCPRO2 (cmd
, prefixarg
);
9740 do_autoload (final
, cmd
);
9747 if (STRINGP (final
) || VECTORP (final
))
9749 /* If requested, place the macro in the command history. For
9750 other sorts of commands, call-interactively takes care of
9752 if (!NILP (record_flag
))
9755 = Fcons (Fcons (Qexecute_kbd_macro
,
9756 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9759 /* Don't keep command history around forever. */
9760 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9762 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9764 XSETCDR (tem
, Qnil
);
9768 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9771 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9773 backtrace
.next
= backtrace_list
;
9774 backtrace_list
= &backtrace
;
9775 backtrace
.function
= &Qcall_interactively
;
9776 backtrace
.args
= &cmd
;
9777 backtrace
.nargs
= 1;
9778 backtrace
.evalargs
= 0;
9779 backtrace
.debug_on_exit
= 0;
9781 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9783 backtrace_list
= backtrace
.next
;
9791 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9793 doc
: /* Read function name, then read its arguments and call it.
9795 To pass a numeric argument to the command you are invoking with, specify
9796 the numeric argument to this command.
9798 Noninteractively, the argument PREFIXARG is the prefix argument to
9799 give to the command you invoke, if it asks for an argument. */)
9801 Lisp_Object prefixarg
;
9803 Lisp_Object function
;
9805 int saved_last_point_position
;
9806 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9807 Lisp_Object bindings
, value
;
9808 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9809 #ifdef HAVE_X_WINDOWS
9810 /* The call to Fcompleting_read wil start and cancel the hourglass,
9811 but if the hourglass was already scheduled, this means that no
9812 hourglass will be shown for the actual M-x command itself.
9813 So we restart it if it is already scheduled. Note that checking
9814 hourglass_shown_p is not enough, normally the hourglass is not shown,
9815 just scheduled to be shown. */
9816 int hstarted
= hourglass_started ();
9819 saved_keys
= Fvector (this_command_key_count
,
9820 XVECTOR (this_command_keys
)->contents
);
9821 saved_last_point_position_buffer
= last_point_position_buffer
;
9822 saved_last_point_position
= last_point_position
;
9824 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9826 if (EQ (prefixarg
, Qminus
))
9828 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9829 strcpy (buf
, "C-u ");
9830 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9831 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9832 else if (INTEGERP (prefixarg
))
9833 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9835 /* This isn't strictly correct if execute-extended-command
9836 is bound to anything else. Perhaps it should use
9837 this_command_keys? */
9838 strcat (buf
, "M-x ");
9840 /* Prompt with buf, and then read a string, completing from and
9841 restricting to the set of all defined commands. Don't provide
9842 any initial input. Save the command read on the extended-command
9844 function
= Fcompleting_read (build_string (buf
),
9845 Vobarray
, Qcommandp
,
9846 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9849 #ifdef HAVE_X_WINDOWS
9850 if (hstarted
) start_hourglass ();
9853 if (STRINGP (function
) && SCHARS (function
) == 0)
9854 error ("No command name given");
9856 /* Set this_command_keys to the concatenation of saved_keys and
9857 function, followed by a RET. */
9862 this_command_key_count
= 0;
9863 this_command_key_count_reset
= 0;
9864 this_single_command_key_start
= 0;
9866 keys
= XVECTOR (saved_keys
)->contents
;
9867 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9868 add_command_key (keys
[i
]);
9870 for (i
= 0; i
< SCHARS (function
); i
++)
9871 add_command_key (Faref (function
, make_number (i
)));
9873 add_command_key (make_number ('\015'));
9876 last_point_position
= saved_last_point_position
;
9877 last_point_position_buffer
= saved_last_point_position_buffer
;
9881 function
= Fintern (function
, Qnil
);
9882 current_kboard
->Vprefix_arg
= prefixarg
;
9883 Vthis_command
= function
;
9884 real_this_command
= function
;
9886 /* If enabled, show which key runs this command. */
9887 if (!NILP (Vsuggest_key_bindings
)
9888 && NILP (Vexecuting_kbd_macro
)
9889 && SYMBOLP (function
))
9890 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9896 GCPRO2 (bindings
, value
);
9897 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9899 /* If the command has a key binding, print it now. */
9900 if (!NILP (bindings
)
9901 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9904 /* But first wait, and skip the message if there is input. */
9907 /* If this command displayed something in the echo area;
9908 wait a few seconds, then display our suggestion message. */
9909 if (NILP (echo_area_buffer
[0]))
9910 waited
= sit_for (make_number (0), 0, 2);
9911 else if (NUMBERP (Vsuggest_key_bindings
))
9912 waited
= sit_for (Vminibuffer_message_timeout
, 0, 2);
9914 waited
= sit_for (make_number (2), 0, 2);
9916 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
9918 Lisp_Object binding
;
9920 int message_p
= push_message ();
9921 int count
= SPECPDL_INDEX ();
9923 record_unwind_protect (pop_message_unwind
, Qnil
);
9924 binding
= Fkey_description (bindings
, Qnil
);
9927 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9930 sprintf (newmessage
, "You can run the command `%s' with %s",
9931 SDATA (SYMBOL_NAME (function
)),
9933 message2_nolog (newmessage
,
9934 strlen (newmessage
),
9935 STRING_MULTIBYTE (binding
));
9936 if (NUMBERP (Vsuggest_key_bindings
))
9937 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
9939 waited
= sit_for (make_number (2), 0, 2);
9941 if (!NILP (waited
) && message_p
)
9944 unbind_to (count
, Qnil
);
9948 RETURN_UNGCPRO (value
);
9952 /* Return nonzero if input events are pending. */
9955 detect_input_pending ()
9958 get_input_pending (&input_pending
, 0);
9960 return input_pending
;
9963 /* Return nonzero if input events other than mouse movements are
9967 detect_input_pending_ignore_squeezables ()
9970 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9972 return input_pending
;
9975 /* Return nonzero if input events are pending, and run any pending timers. */
9978 detect_input_pending_run_timers (do_display
)
9981 int old_timers_run
= timers_run
;
9984 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
9986 if (old_timers_run
!= timers_run
&& do_display
)
9988 redisplay_preserve_echo_area (8);
9989 /* The following fixes a bug when using lazy-lock with
9990 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9991 from an idle timer function. The symptom of the bug is that
9992 the cursor sometimes doesn't become visible until the next X
9993 event is processed. --gerd. */
9995 rif
->flush_display (NULL
);
9998 return input_pending
;
10001 /* This is called in some cases before a possible quit.
10002 It cases the next call to detect_input_pending to recompute input_pending.
10003 So calling this function unnecessarily can't do any harm. */
10006 clear_input_pending ()
10011 /* Return nonzero if there are pending requeued events.
10012 This isn't used yet. The hope is to make wait_reading_process_output
10013 call it, and return if it runs Lisp code that unreads something.
10014 The problem is, kbd_buffer_get_event needs to be fixed to know what
10015 to do in that case. It isn't trivial. */
10018 requeued_events_pending_p ()
10020 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10024 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10025 doc
: /* Return t if command input is currently available with no wait.
10026 Actually, the value is nil only if we can be sure that no input is available;
10027 if there is a doubt, the value is t. */)
10030 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
10033 get_input_pending (&input_pending
,
10034 READABLE_EVENTS_DO_TIMERS_NOW
10035 | READABLE_EVENTS_FILTER_EVENTS
);
10036 return input_pending
> 0 ? Qt
: Qnil
;
10039 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10040 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10043 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10046 if (total_keys
< NUM_RECENT_KEYS
)
10047 return Fvector (total_keys
, keys
);
10050 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10051 bcopy (keys
+ recent_keys_index
,
10052 XVECTOR (val
)->contents
,
10053 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10055 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10056 recent_keys_index
* sizeof (Lisp_Object
));
10061 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10062 doc
: /* Return the key sequence that invoked this command.
10063 However, if the command has called `read-key-sequence', it returns
10064 the last key sequence that has been read.
10065 The value is a string or a vector. */)
10068 return make_event_array (this_command_key_count
,
10069 XVECTOR (this_command_keys
)->contents
);
10072 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10073 doc
: /* Return the key sequence that invoked this command, as a vector.
10074 However, if the command has called `read-key-sequence', it returns
10075 the last key sequence that has been read. */)
10078 return Fvector (this_command_key_count
,
10079 XVECTOR (this_command_keys
)->contents
);
10082 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10083 Sthis_single_command_keys
, 0, 0, 0,
10084 doc
: /* Return the key sequence that invoked this command.
10085 More generally, it returns the last key sequence read, either by
10086 the command loop or by `read-key-sequence'.
10087 Unlike `this-command-keys', this function's value
10088 does not include prefix arguments.
10089 The value is always a vector. */)
10092 return Fvector (this_command_key_count
10093 - this_single_command_key_start
,
10094 (XVECTOR (this_command_keys
)->contents
10095 + this_single_command_key_start
));
10098 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10099 Sthis_single_command_raw_keys
, 0, 0, 0,
10100 doc
: /* Return the raw events that were read for this command.
10101 More generally, it returns the last key sequence read, either by
10102 the command loop or by `read-key-sequence'.
10103 Unlike `this-single-command-keys', this function's value
10104 shows the events before all translations (except for input methods).
10105 The value is always a vector. */)
10108 return Fvector (raw_keybuf_count
,
10109 (XVECTOR (raw_keybuf
)->contents
));
10112 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10113 Sreset_this_command_lengths
, 0, 0, 0,
10114 doc
: /* Make the unread events replace the last command and echo.
10115 Used in `universal-argument-other-key'.
10117 `universal-argument-other-key' rereads the event just typed.
10118 It then gets translated through `function-key-map'.
10119 The translated event has to replace the real events,
10120 both in the value of (this-command-keys) and in echoing.
10121 To achieve this, `universal-argument-other-key' calls
10122 `reset-this-command-lengths', which discards the record of reading
10123 these events the first time. */)
10126 this_command_key_count
= before_command_key_count
;
10127 if (this_command_key_count
< this_single_command_key_start
)
10128 this_single_command_key_start
= this_command_key_count
;
10130 echo_truncate (before_command_echo_length
);
10132 /* Cause whatever we put into unread-command-events
10133 to echo as if it were being freshly read from the keyboard. */
10134 this_command_key_count_reset
= 1;
10139 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10140 Sclear_this_command_keys
, 0, 1, 0,
10141 doc
: /* Clear out the vector that `this-command-keys' returns.
10142 Also clear the record of the last 100 events, unless optional arg
10143 KEEP-RECORD is non-nil. */)
10145 Lisp_Object keep_record
;
10149 this_command_key_count
= 0;
10150 this_command_key_count_reset
= 0;
10152 if (NILP (keep_record
))
10154 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10155 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10157 recent_keys_index
= 0;
10162 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10163 doc
: /* Return the current depth in recursive edits. */)
10167 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10171 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10172 "FOpen dribble file: ",
10173 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10174 If FILE is nil, close any open dribble file. */)
10185 file
= Fexpand_file_name (file
, Qnil
);
10186 dribble
= fopen (SDATA (file
), "w");
10188 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10193 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10194 doc
: /* Discard the contents of the terminal input buffer.
10195 Also end any kbd macro being defined. */)
10198 if (!NILP (current_kboard
->defining_kbd_macro
))
10200 /* Discard the last command from the macro. */
10201 Fcancel_kbd_macro_events ();
10205 update_mode_lines
++;
10207 Vunread_command_events
= Qnil
;
10208 unread_command_char
= -1;
10210 discard_tty_input ();
10212 kbd_fetch_ptr
= kbd_store_ptr
;
10218 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10219 doc
: /* Stop Emacs and return to superior process. You can resume later.
10220 If `cannot-suspend' is non-nil, or if the system doesn't support job
10221 control, run a subshell instead.
10223 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10224 to be read as terminal input by Emacs's parent, after suspension.
10226 Before suspending, run the normal hook `suspend-hook'.
10227 After resumption run the normal hook `suspend-resume-hook'.
10229 Some operating systems cannot stop the Emacs process and resume it later.
10230 On such systems, Emacs starts a subshell instead of suspending. */)
10232 Lisp_Object stuffstring
;
10234 int count
= SPECPDL_INDEX ();
10235 int old_height
, old_width
;
10237 struct gcpro gcpro1
;
10239 if (!NILP (stuffstring
))
10240 CHECK_STRING (stuffstring
);
10242 /* Run the functions in suspend-hook. */
10243 if (!NILP (Vrun_hooks
))
10244 call1 (Vrun_hooks
, intern ("suspend-hook"));
10246 GCPRO1 (stuffstring
);
10247 get_frame_size (&old_width
, &old_height
);
10248 reset_sys_modes ();
10249 /* sys_suspend can get an error if it tries to fork a subshell
10250 and the system resources aren't available for that. */
10251 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10253 stuff_buffered_input (stuffstring
);
10254 if (cannot_suspend
)
10258 unbind_to (count
, Qnil
);
10260 /* Check if terminal/window size has changed.
10261 Note that this is not useful when we are running directly
10262 with a window system; but suspend should be disabled in that case. */
10263 get_frame_size (&width
, &height
);
10264 if (width
!= old_width
|| height
!= old_height
)
10265 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10267 /* Run suspend-resume-hook. */
10268 if (!NILP (Vrun_hooks
))
10269 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10275 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10276 Then in any case stuff anything Emacs has read ahead and not used. */
10279 stuff_buffered_input (stuffstring
)
10280 Lisp_Object stuffstring
;
10282 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10283 register unsigned char *p
;
10285 if (STRINGP (stuffstring
))
10287 register int count
;
10289 p
= SDATA (stuffstring
);
10290 count
= SBYTES (stuffstring
);
10291 while (count
-- > 0)
10296 /* Anything we have read ahead, put back for the shell to read. */
10297 /* ?? What should this do when we have multiple keyboards??
10298 Should we ignore anything that was typed in at the "wrong" kboard?
10300 rms: we should stuff everything back into the kboard
10302 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10305 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10306 kbd_fetch_ptr
= kbd_buffer
;
10307 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10308 stuff_char (kbd_fetch_ptr
->code
);
10310 clear_event (kbd_fetch_ptr
);
10314 #endif /* SIGTSTP */
10318 set_waiting_for_input (time_to_clear
)
10319 EMACS_TIME
*time_to_clear
;
10321 input_available_clear_time
= time_to_clear
;
10323 /* Tell interrupt_signal to throw back to read_char, */
10324 waiting_for_input
= 1;
10326 /* If interrupt_signal was called before and buffered a C-g,
10327 make it run again now, to avoid timing error. */
10328 if (!NILP (Vquit_flag
))
10329 quit_throw_to_read_char ();
10333 clear_waiting_for_input ()
10335 /* Tell interrupt_signal not to throw back to read_char, */
10336 waiting_for_input
= 0;
10337 input_available_clear_time
= 0;
10340 /* This routine is called at interrupt level in response to C-g.
10342 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10343 is called from kbd_buffer_store_event, in handling SIGIO or
10346 If `waiting_for_input' is non zero, then unless `echoing' is
10347 nonzero, immediately throw back to read_char.
10349 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10350 eval to throw, when it gets a chance. If quit-flag is already
10351 non-nil, it stops the job right away. */
10354 interrupt_signal (signalnum
) /* If we don't have an argument, */
10355 int signalnum
; /* some compilers complain in signal calls. */
10358 /* Must preserve main program's value of errno. */
10359 int old_errno
= errno
;
10360 struct frame
*sf
= SELECTED_FRAME ();
10362 #if defined (USG) && !defined (POSIX_SIGNALS)
10363 if (!read_socket_hook
&& NILP (Vwindow_system
))
10365 /* USG systems forget handlers when they are used;
10366 must reestablish each time */
10367 signal (SIGINT
, interrupt_signal
);
10368 signal (SIGQUIT
, interrupt_signal
);
10372 SIGNAL_THREAD_CHECK (signalnum
);
10375 if (!NILP (Vquit_flag
)
10376 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10378 /* If SIGINT isn't blocked, don't let us be interrupted by
10379 another SIGINT, it might be harmful due to non-reentrancy
10380 in I/O functions. */
10381 sigblock (sigmask (SIGINT
));
10384 reset_sys_modes ();
10386 #ifdef SIGTSTP /* Support possible in later USG versions */
10388 * On systems which can suspend the current process and return to the original
10389 * shell, this command causes the user to end up back at the shell.
10390 * The "Auto-save" and "Abort" questions are not asked until
10391 * the user elects to return to emacs, at which point he can save the current
10392 * job and either dump core or continue.
10397 if (sys_suspend () == -1)
10399 printf ("Not running as a subprocess;\n");
10400 printf ("you can continue or abort.\n");
10402 #else /* not VMS */
10403 /* Perhaps should really fork an inferior shell?
10404 But that would not provide any way to get back
10405 to the original shell, ever. */
10406 printf ("No support for stopping a process on this operating system;\n");
10407 printf ("you can continue or abort.\n");
10408 #endif /* not VMS */
10409 #endif /* not SIGTSTP */
10411 /* We must remain inside the screen area when the internal terminal
10412 is used. Note that [Enter] is not echoed by dos. */
10415 /* It doesn't work to autosave while GC is in progress;
10416 the code used for auto-saving doesn't cope with the mark bit. */
10417 if (!gc_in_progress
)
10419 printf ("Auto-save? (y or n) ");
10421 if (((c
= getchar ()) & ~040) == 'Y')
10423 Fdo_auto_save (Qt
, Qnil
);
10425 printf ("\r\nAuto-save done");
10426 #else /* not MSDOS */
10427 printf ("Auto-save done\n");
10428 #endif /* not MSDOS */
10430 while (c
!= '\n') c
= getchar ();
10434 /* During GC, it must be safe to reenable quitting again. */
10435 Vinhibit_quit
= Qnil
;
10438 #endif /* not MSDOS */
10439 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10440 printf ("but will instead do a real quit after garbage collection ends\r\n");
10445 printf ("\r\nAbort? (y or n) ");
10446 #else /* not MSDOS */
10448 printf ("Abort (and enter debugger)? (y or n) ");
10449 #else /* not VMS */
10450 printf ("Abort (and dump core)? (y or n) ");
10451 #endif /* not VMS */
10452 #endif /* not MSDOS */
10454 if (((c
= getchar ()) & ~040) == 'Y')
10456 while (c
!= '\n') c
= getchar ();
10458 printf ("\r\nContinuing...\r\n");
10459 #else /* not MSDOS */
10460 printf ("Continuing...\n");
10461 #endif /* not MSDOS */
10468 /* If executing a function that wants to be interrupted out of
10469 and the user has not deferred quitting by binding `inhibit-quit'
10470 then quit right away. */
10471 if (immediate_quit
&& NILP (Vinhibit_quit
))
10473 struct gl_state_s saved
;
10474 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10476 immediate_quit
= 0;
10479 GCPRO4 (saved
.object
, saved
.global_code
,
10480 saved
.current_syntax_table
, saved
.old_prop
);
10481 Fsignal (Qquit
, Qnil
);
10486 /* Else request quit when it's safe */
10490 if (waiting_for_input
&& !echoing
)
10491 quit_throw_to_read_char ();
10496 /* Handle a C-g by making read_char return C-g. */
10499 quit_throw_to_read_char ()
10502 /* Prevent another signal from doing this before we finish. */
10503 clear_waiting_for_input ();
10506 Vunread_command_events
= Qnil
;
10507 unread_command_char
= -1;
10509 #if 0 /* Currently, sit_for is called from read_char without turning
10510 off polling. And that can call set_waiting_for_input.
10511 It seems to be harmless. */
10512 #ifdef POLL_FOR_INPUT
10513 /* May be > 1 if in recursive minibuffer. */
10514 if (poll_suppress_count
== 0)
10518 if (FRAMEP (internal_last_event_frame
)
10519 && !EQ (internal_last_event_frame
, selected_frame
))
10520 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10523 _longjmp (getcjmp
, 1);
10526 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10527 doc
: /* Set mode of reading keyboard input.
10528 First arg INTERRUPT non-nil means use input interrupts;
10529 nil means use CBREAK mode.
10530 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10531 (no effect except in CBREAK mode).
10532 Third arg META t means accept 8-bit input (for a Meta key).
10533 META nil means ignore the top bit, on the assumption it is parity.
10534 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10535 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10536 See also `current-input-mode'. */)
10537 (interrupt
, flow
, meta
, quit
)
10538 Lisp_Object interrupt
, flow
, meta
, quit
;
10541 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10542 error ("set-input-mode: QUIT must be an ASCII character");
10544 #ifdef POLL_FOR_INPUT
10549 /* this causes startup screen to be restored and messes with the mouse */
10550 reset_sys_modes ();
10554 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10555 if (read_socket_hook
)
10557 /* When using X, don't give the user a real choice,
10558 because we haven't implemented the mechanisms to support it. */
10559 #ifdef NO_SOCK_SIGIO
10560 interrupt_input
= 0;
10561 #else /* not NO_SOCK_SIGIO */
10562 interrupt_input
= 1;
10563 #endif /* NO_SOCK_SIGIO */
10566 interrupt_input
= !NILP (interrupt
);
10567 #else /* not SIGIO */
10568 interrupt_input
= 0;
10569 #endif /* not SIGIO */
10571 /* Our VMS input only works by interrupts, as of now. */
10573 interrupt_input
= 1;
10576 flow_control
= !NILP (flow
);
10579 else if (EQ (meta
, Qt
))
10584 /* Don't let this value be out of range. */
10585 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10591 #ifdef POLL_FOR_INPUT
10592 poll_suppress_count
= 1;
10598 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10599 doc
: /* Return information about the way Emacs currently reads keyboard input.
10600 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10601 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10602 nil, Emacs is using CBREAK mode.
10603 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10604 terminal; this does not apply if Emacs uses interrupt-driven input.
10605 META is t if accepting 8-bit input with 8th bit as Meta flag.
10606 META nil means ignoring the top bit, on the assumption it is parity.
10607 META is neither t nor nil if accepting 8-bit input and using
10608 all 8 bits as the character code.
10609 QUIT is the character Emacs currently uses to quit.
10610 The elements of this list correspond to the arguments of
10611 `set-input-mode'. */)
10614 Lisp_Object val
[4];
10616 val
[0] = interrupt_input
? Qt
: Qnil
;
10617 val
[1] = flow_control
? Qt
: Qnil
;
10618 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10619 XSETFASTINT (val
[3], quit_char
);
10621 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10624 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10625 doc
: /* Return position information for pixel coordinates X and Y.
10626 By default, X and Y are relative to text area of the selected window.
10627 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10628 If optional fourth arg WHOLE is non-nil, X is relative to the left
10629 edge of the window.
10631 The return value is similar to a mouse click position:
10632 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10633 IMAGE (DX . DY) (WIDTH . HEIGHT))
10634 The `posn-' functions access elements of such lists. */)
10635 (x
, y
, frame_or_window
, whole
)
10636 Lisp_Object x
, y
, frame_or_window
, whole
;
10641 if (NILP (frame_or_window
))
10642 frame_or_window
= selected_window
;
10644 if (WINDOWP (frame_or_window
))
10648 CHECK_LIVE_WINDOW (frame_or_window
);
10650 w
= XWINDOW (frame_or_window
);
10651 XSETINT (x
, (XINT (x
)
10652 + WINDOW_LEFT_EDGE_X (w
)
10654 ? window_box_left_offset (w
, TEXT_AREA
)
10656 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10657 frame_or_window
= w
->frame
;
10660 CHECK_LIVE_FRAME (frame_or_window
);
10662 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10665 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10666 doc
: /* Return position information for buffer POS in WINDOW.
10667 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10669 Return nil if position is not visible in window. Otherwise,
10670 the return value is similar to that returned by `event-start' for
10671 a mouse click at the upper left corner of the glyph corresponding
10672 to the given buffer position:
10673 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10674 IMAGE (DX . DY) (WIDTH . HEIGHT))
10675 The `posn-' functions access elements of such lists. */)
10677 Lisp_Object pos
, window
;
10682 window
= selected_window
;
10684 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10687 Lisp_Object x
= XCAR (tem
);
10688 Lisp_Object y
= XCAR (XCDR (tem
));
10690 /* Point invisible due to hscrolling? */
10693 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10701 * Set up a new kboard object with reasonable initial values.
10707 kb
->Voverriding_terminal_local_map
= Qnil
;
10708 kb
->Vlast_command
= Qnil
;
10709 kb
->Vreal_last_command
= Qnil
;
10710 kb
->Vprefix_arg
= Qnil
;
10711 kb
->Vlast_prefix_arg
= Qnil
;
10712 kb
->kbd_queue
= Qnil
;
10713 kb
->kbd_queue_has_data
= 0;
10714 kb
->immediate_echo
= 0;
10715 kb
->echo_string
= Qnil
;
10716 kb
->echo_after_prompt
= -1;
10717 kb
->kbd_macro_buffer
= 0;
10718 kb
->kbd_macro_bufsize
= 0;
10719 kb
->defining_kbd_macro
= Qnil
;
10720 kb
->Vlast_kbd_macro
= Qnil
;
10721 kb
->reference_count
= 0;
10722 kb
->Vsystem_key_alist
= Qnil
;
10723 kb
->system_key_syms
= Qnil
;
10724 kb
->Vdefault_minibuffer_frame
= Qnil
;
10728 * Destroy the contents of a kboard object, but not the object itself.
10729 * We use this just before deleting it, or if we're going to initialize
10730 * it a second time.
10736 if (kb
->kbd_macro_buffer
)
10737 xfree (kb
->kbd_macro_buffer
);
10740 #ifdef MULTI_KBOARD
10742 /* Free KB and memory referenced from it. */
10750 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10753 *kbp
= kb
->next_kboard
;
10755 /* Prevent a dangling reference to KB. */
10756 if (kb
== current_kboard
10757 && FRAMEP (selected_frame
)
10758 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10760 current_kboard
= XFRAME (selected_frame
)->kboard
;
10761 if (current_kboard
== kb
)
10769 #endif /* MULTI_KBOARD */
10774 /* This is correct before outermost invocation of the editor loop */
10775 command_loop_level
= -1;
10776 immediate_quit
= 0;
10777 quit_char
= Ctl ('g');
10778 Vunread_command_events
= Qnil
;
10779 unread_command_char
= -1;
10780 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10782 recent_keys_index
= 0;
10783 kbd_fetch_ptr
= kbd_buffer
;
10784 kbd_store_ptr
= kbd_buffer
;
10786 do_mouse_tracking
= Qnil
;
10790 /* This means that command_loop_1 won't try to select anything the first
10792 internal_last_event_frame
= Qnil
;
10793 Vlast_event_frame
= internal_last_event_frame
;
10795 #ifdef MULTI_KBOARD
10796 current_kboard
= initial_kboard
;
10798 wipe_kboard (current_kboard
);
10799 init_kboard (current_kboard
);
10801 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10803 signal (SIGINT
, interrupt_signal
);
10804 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10805 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10806 SIGQUIT and we can't tell which one it will give us. */
10807 signal (SIGQUIT
, interrupt_signal
);
10808 #endif /* HAVE_TERMIO */
10810 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10812 if (!noninteractive
)
10813 signal (SIGIO
, input_available_signal
);
10816 /* Use interrupt input by default, if it works and noninterrupt input
10817 has deficiencies. */
10819 #ifdef INTERRUPT_INPUT
10820 interrupt_input
= 1;
10822 interrupt_input
= 0;
10825 /* Our VMS input only works by interrupts, as of now. */
10827 interrupt_input
= 1;
10833 if (keyboard_init_hook
)
10834 (*keyboard_init_hook
) ();
10836 #ifdef POLL_FOR_INPUT
10837 poll_suppress_count
= 1;
10842 /* This type's only use is in syms_of_keyboard, to initialize the
10843 event header symbols and put properties on them. */
10844 struct event_head
{
10850 struct event_head head_table
[] = {
10851 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10852 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10853 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10854 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10855 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10856 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10857 /* `select-window' should be handled just like `switch-frame'
10858 in read_key_sequence. */
10859 {&Qselect_window
, "select-window", &Qswitch_frame
}
10863 syms_of_keyboard ()
10865 Vpre_help_message
= Qnil
;
10866 staticpro (&Vpre_help_message
);
10868 Vlispy_mouse_stem
= build_string ("mouse");
10869 staticpro (&Vlispy_mouse_stem
);
10872 QCimage
= intern (":image");
10873 staticpro (&QCimage
);
10875 staticpro (&Qhelp_echo
);
10876 Qhelp_echo
= intern ("help-echo");
10878 staticpro (&item_properties
);
10879 item_properties
= Qnil
;
10881 staticpro (&tool_bar_item_properties
);
10882 tool_bar_item_properties
= Qnil
;
10883 staticpro (&tool_bar_items_vector
);
10884 tool_bar_items_vector
= Qnil
;
10886 staticpro (&real_this_command
);
10887 real_this_command
= Qnil
;
10889 Qtimer_event_handler
= intern ("timer-event-handler");
10890 staticpro (&Qtimer_event_handler
);
10892 Qdisabled_command_function
= intern ("disabled-command-function");
10893 staticpro (&Qdisabled_command_function
);
10895 Qself_insert_command
= intern ("self-insert-command");
10896 staticpro (&Qself_insert_command
);
10898 Qforward_char
= intern ("forward-char");
10899 staticpro (&Qforward_char
);
10901 Qbackward_char
= intern ("backward-char");
10902 staticpro (&Qbackward_char
);
10904 Qdisabled
= intern ("disabled");
10905 staticpro (&Qdisabled
);
10907 Qundefined
= intern ("undefined");
10908 staticpro (&Qundefined
);
10910 Qpre_command_hook
= intern ("pre-command-hook");
10911 staticpro (&Qpre_command_hook
);
10913 Qpost_command_hook
= intern ("post-command-hook");
10914 staticpro (&Qpost_command_hook
);
10916 Qdeferred_action_function
= intern ("deferred-action-function");
10917 staticpro (&Qdeferred_action_function
);
10919 Qcommand_hook_internal
= intern ("command-hook-internal");
10920 staticpro (&Qcommand_hook_internal
);
10922 Qfunction_key
= intern ("function-key");
10923 staticpro (&Qfunction_key
);
10924 Qmouse_click
= intern ("mouse-click");
10925 staticpro (&Qmouse_click
);
10926 #if defined (WINDOWSNT) || defined (MAC_OS)
10927 Qlanguage_change
= intern ("language-change");
10928 staticpro (&Qlanguage_change
);
10930 Qdrag_n_drop
= intern ("drag-n-drop");
10931 staticpro (&Qdrag_n_drop
);
10933 Qsave_session
= intern ("save-session");
10934 staticpro (&Qsave_session
);
10937 Qmac_apple_event
= intern ("mac-apple-event");
10938 staticpro (&Qmac_apple_event
);
10941 Qusr1_signal
= intern ("usr1-signal");
10942 staticpro (&Qusr1_signal
);
10943 Qusr2_signal
= intern ("usr2-signal");
10944 staticpro (&Qusr2_signal
);
10946 Qmenu_enable
= intern ("menu-enable");
10947 staticpro (&Qmenu_enable
);
10948 Qmenu_alias
= intern ("menu-alias");
10949 staticpro (&Qmenu_alias
);
10950 QCenable
= intern (":enable");
10951 staticpro (&QCenable
);
10952 QCvisible
= intern (":visible");
10953 staticpro (&QCvisible
);
10954 QChelp
= intern (":help");
10955 staticpro (&QChelp
);
10956 QCfilter
= intern (":filter");
10957 staticpro (&QCfilter
);
10958 QCbutton
= intern (":button");
10959 staticpro (&QCbutton
);
10960 QCkeys
= intern (":keys");
10961 staticpro (&QCkeys
);
10962 QCkey_sequence
= intern (":key-sequence");
10963 staticpro (&QCkey_sequence
);
10964 QCtoggle
= intern (":toggle");
10965 staticpro (&QCtoggle
);
10966 QCradio
= intern (":radio");
10967 staticpro (&QCradio
);
10969 Qmode_line
= intern ("mode-line");
10970 staticpro (&Qmode_line
);
10971 Qvertical_line
= intern ("vertical-line");
10972 staticpro (&Qvertical_line
);
10973 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10974 staticpro (&Qvertical_scroll_bar
);
10975 Qmenu_bar
= intern ("menu-bar");
10976 staticpro (&Qmenu_bar
);
10979 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
10980 staticpro (&Qmouse_fixup_help_message
);
10983 Qabove_handle
= intern ("above-handle");
10984 staticpro (&Qabove_handle
);
10985 Qhandle
= intern ("handle");
10986 staticpro (&Qhandle
);
10987 Qbelow_handle
= intern ("below-handle");
10988 staticpro (&Qbelow_handle
);
10989 Qup
= intern ("up");
10991 Qdown
= intern ("down");
10992 staticpro (&Qdown
);
10993 Qtop
= intern ("top");
10995 Qbottom
= intern ("bottom");
10996 staticpro (&Qbottom
);
10997 Qend_scroll
= intern ("end-scroll");
10998 staticpro (&Qend_scroll
);
10999 Qratio
= intern ("ratio");
11000 staticpro (&Qratio
);
11002 Qevent_kind
= intern ("event-kind");
11003 staticpro (&Qevent_kind
);
11004 Qevent_symbol_elements
= intern ("event-symbol-elements");
11005 staticpro (&Qevent_symbol_elements
);
11006 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11007 staticpro (&Qevent_symbol_element_mask
);
11008 Qmodifier_cache
= intern ("modifier-cache");
11009 staticpro (&Qmodifier_cache
);
11011 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11012 staticpro (&Qrecompute_lucid_menubar
);
11013 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11014 staticpro (&Qactivate_menubar_hook
);
11016 Qpolling_period
= intern ("polling-period");
11017 staticpro (&Qpolling_period
);
11019 Qinput_method_function
= intern ("input-method-function");
11020 staticpro (&Qinput_method_function
);
11022 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11023 staticpro (&Qinput_method_exit_on_first_char
);
11024 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11025 staticpro (&Qinput_method_use_echo_area
);
11027 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11028 Fset (Qinput_method_use_echo_area
, Qnil
);
11030 last_point_position_buffer
= Qnil
;
11031 last_point_position_window
= Qnil
;
11034 struct event_head
*p
;
11036 for (p
= head_table
;
11037 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11040 *p
->var
= intern (p
->name
);
11041 staticpro (p
->var
);
11042 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11043 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11047 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11048 staticpro (&button_down_location
);
11049 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11050 staticpro (&mouse_syms
);
11051 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11052 staticpro (&wheel_syms
);
11056 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11058 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11059 for (i
= 0; i
< len
; i
++)
11060 if (modifier_names
[i
])
11061 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11062 staticpro (&modifier_symbols
);
11065 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11066 staticpro (&recent_keys
);
11068 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11069 staticpro (&this_command_keys
);
11071 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11072 staticpro (&raw_keybuf
);
11074 Qextended_command_history
= intern ("extended-command-history");
11075 Fset (Qextended_command_history
, Qnil
);
11076 staticpro (&Qextended_command_history
);
11078 accent_key_syms
= Qnil
;
11079 staticpro (&accent_key_syms
);
11081 func_key_syms
= Qnil
;
11082 staticpro (&func_key_syms
);
11084 drag_n_drop_syms
= Qnil
;
11085 staticpro (&drag_n_drop_syms
);
11087 unread_switch_frame
= Qnil
;
11088 staticpro (&unread_switch_frame
);
11090 internal_last_event_frame
= Qnil
;
11091 staticpro (&internal_last_event_frame
);
11093 read_key_sequence_cmd
= Qnil
;
11094 staticpro (&read_key_sequence_cmd
);
11096 menu_bar_one_keymap_changed_items
= Qnil
;
11097 staticpro (&menu_bar_one_keymap_changed_items
);
11099 menu_bar_items_vector
= Qnil
;
11100 staticpro (&menu_bar_items_vector
);
11102 defsubr (&Sevent_convert_list
);
11103 defsubr (&Sread_key_sequence
);
11104 defsubr (&Sread_key_sequence_vector
);
11105 defsubr (&Srecursive_edit
);
11107 defsubr (&Strack_mouse
);
11109 defsubr (&Sinput_pending_p
);
11110 defsubr (&Scommand_execute
);
11111 defsubr (&Srecent_keys
);
11112 defsubr (&Sthis_command_keys
);
11113 defsubr (&Sthis_command_keys_vector
);
11114 defsubr (&Sthis_single_command_keys
);
11115 defsubr (&Sthis_single_command_raw_keys
);
11116 defsubr (&Sreset_this_command_lengths
);
11117 defsubr (&Sclear_this_command_keys
);
11118 defsubr (&Ssuspend_emacs
);
11119 defsubr (&Sabort_recursive_edit
);
11120 defsubr (&Sexit_recursive_edit
);
11121 defsubr (&Srecursion_depth
);
11122 defsubr (&Stop_level
);
11123 defsubr (&Sdiscard_input
);
11124 defsubr (&Sopen_dribble_file
);
11125 defsubr (&Sset_input_mode
);
11126 defsubr (&Scurrent_input_mode
);
11127 defsubr (&Sexecute_extended_command
);
11128 defsubr (&Sposn_at_point
);
11129 defsubr (&Sposn_at_x_y
);
11131 DEFVAR_LISP ("last-command-char", &last_command_char
,
11132 doc
: /* Last input event that was part of a command. */);
11134 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11135 doc
: /* Last input event that was part of a command. */);
11137 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11138 doc
: /* Last input event in a command, except for mouse menu events.
11139 Mouse menus give back keys that don't look like mouse events;
11140 this variable holds the actual mouse event that led to the menu,
11141 so that you can determine whether the command was run by mouse or not. */);
11143 DEFVAR_LISP ("last-input-char", &last_input_char
,
11144 doc
: /* Last input event. */);
11146 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11147 doc
: /* Last input event. */);
11149 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11150 doc
: /* List of events to be read as the command input.
11151 These events are processed first, before actual keyboard input. */);
11152 Vunread_command_events
= Qnil
;
11154 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11155 doc
: /* If not -1, an object to be read as next command input event. */);
11157 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11158 doc
: /* List of events to be processed as input by input methods.
11159 These events are processed after `unread-command-events', but
11160 before actual keyboard input. */);
11161 Vunread_post_input_method_events
= Qnil
;
11163 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11164 doc
: /* List of events to be processed as input by input methods.
11165 These events are processed after `unread-command-events', but
11166 before actual keyboard input. */);
11167 Vunread_input_method_events
= Qnil
;
11169 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11170 doc
: /* Meta-prefix character code.
11171 Meta-foo as command input turns into this character followed by foo. */);
11172 XSETINT (meta_prefix_char
, 033);
11174 DEFVAR_KBOARD ("last-command", Vlast_command
,
11175 doc
: /* The last command executed.
11176 Normally a symbol with a function definition, but can be whatever was found
11177 in the keymap, or whatever the variable `this-command' was set to by that
11180 The value `mode-exit' is special; it means that the previous command
11181 read an event that told it to exit, and it did so and unread that event.
11182 In other words, the present command is the event that made the previous
11185 The value `kill-region' is special; it means that the previous command
11186 was a kill command. */);
11188 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11189 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11191 DEFVAR_LISP ("this-command", &Vthis_command
,
11192 doc
: /* The command now being executed.
11193 The command can set this variable; whatever is put here
11194 will be in `last-command' during the following command. */);
11195 Vthis_command
= Qnil
;
11197 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11198 doc
: /* The command bound to the current key sequence before remapping.
11199 It equals `this-command' if the original command was not remapped through
11200 any of the active keymaps. Otherwise, the value of `this-command' is the
11201 result of looking up the original command in the active keymaps. */);
11202 Vthis_original_command
= Qnil
;
11204 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11205 doc
: /* *Number of input events between auto-saves.
11206 Zero means disable autosaving due to number of characters typed. */);
11207 auto_save_interval
= 300;
11209 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11210 doc
: /* *Number of seconds idle time before auto-save.
11211 Zero or nil means disable auto-saving due to idleness.
11212 After auto-saving due to this many seconds of idle time,
11213 Emacs also does a garbage collection if that seems to be warranted. */);
11214 XSETFASTINT (Vauto_save_timeout
, 30);
11216 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11217 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11218 The value may be integer or floating point. */);
11219 Vecho_keystrokes
= make_number (1);
11221 DEFVAR_INT ("polling-period", &polling_period
,
11222 doc
: /* *Interval between polling for input during Lisp execution.
11223 The reason for polling is to make C-g work to stop a running program.
11224 Polling is needed only when using X windows and SIGIO does not work.
11225 Polling is automatically disabled in all other cases. */);
11226 polling_period
= 2;
11228 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11229 doc
: /* *Maximum time between mouse clicks to make a double-click.
11230 Measured in milliseconds. nil means disable double-click recognition;
11231 t means double-clicks have no time limit and are detected
11232 by position only. */);
11233 Vdouble_click_time
= make_number (500);
11235 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11236 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11237 On window-system frames, value is the number of pixels the mouse may have
11238 moved horizontally or vertically between two clicks to make a double-click.
11239 On non window-system frames, value is interpreted in units of 1/8 characters
11242 This variable is also the threshold for motion of the mouse
11243 to count as a drag. */);
11244 double_click_fuzz
= 3;
11246 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11247 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11248 inhibit_local_menu_bar_menus
= 0;
11250 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11251 doc
: /* Number of complete key sequences read as input so far.
11252 This includes key sequences read from keyboard macros.
11253 The number is effectively the number of interactive command invocations. */);
11254 num_input_keys
= 0;
11256 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11257 doc
: /* Number of input events read from the keyboard so far.
11258 This does not include events generated by keyboard macros. */);
11259 num_nonmacro_input_events
= 0;
11261 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11262 doc
: /* The frame in which the most recently read event occurred.
11263 If the last event came from a keyboard macro, this is set to `macro'. */);
11264 Vlast_event_frame
= Qnil
;
11266 /* This variable is set up in sysdep.c. */
11267 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11268 doc
: /* The ERASE character as set by the user with stty. */);
11270 DEFVAR_LISP ("help-char", &Vhelp_char
,
11271 doc
: /* Character to recognize as meaning Help.
11272 When it is read, do `(eval help-form)', and display result if it's a string.
11273 If the value of `help-form' is nil, this char can be read normally. */);
11274 XSETINT (Vhelp_char
, Ctl ('H'));
11276 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11277 doc
: /* List of input events to recognize as meaning Help.
11278 These work just like the value of `help-char' (see that). */);
11279 Vhelp_event_list
= Qnil
;
11281 DEFVAR_LISP ("help-form", &Vhelp_form
,
11282 doc
: /* Form to execute when character `help-char' is read.
11283 If the form returns a string, that string is displayed.
11284 If `help-form' is nil, the help char is not recognized. */);
11287 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11288 doc
: /* Command to run when `help-char' character follows a prefix key.
11289 This command is used only when there is no actual binding
11290 for that character after that prefix key. */);
11291 Vprefix_help_command
= Qnil
;
11293 DEFVAR_LISP ("top-level", &Vtop_level
,
11294 doc
: /* Form to evaluate when Emacs starts up.
11295 Useful to set before you dump a modified Emacs. */);
11298 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11299 doc
: /* Translate table for keyboard input, or nil.
11300 If non-nil, the value should be a char-table. Each character read
11301 from the keyboard is looked up in this char-table. If the value found
11302 there is non-nil, then it is used instead of the actual input character.
11304 The value can also be a string or vector, but this is considered obsolete.
11305 If it is a string or vector of length N, character codes N and up are left
11306 untranslated. In a vector, an element which is nil means "no translation".
11308 This is applied to the characters supplied to input methods, not their
11309 output. See also `translation-table-for-input'. */);
11310 Vkeyboard_translate_table
= Qnil
;
11312 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11313 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11314 \(Even if the operating system has support for stopping a process.\) */);
11315 cannot_suspend
= 0;
11317 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11318 doc
: /* Non-nil means prompt with menus when appropriate.
11319 This is done when reading from a keymap that has a prompt string,
11320 for elements that have prompt strings.
11321 The menu is displayed on the screen
11322 if X menus were enabled at configuration
11323 time and the previous event was a mouse click prefix key.
11324 Otherwise, menu prompting uses the echo area. */);
11325 menu_prompting
= 1;
11327 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11328 doc
: /* Character to see next line of menu prompt.
11329 Type this character while in a menu prompt to rotate around the lines of it. */);
11330 XSETINT (menu_prompt_more_char
, ' ');
11332 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11333 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11334 Emacs applies the modifiers of the character stored here to each keyboard
11335 character it reads. For example, after evaluating the expression
11336 (setq extra-keyboard-modifiers ?\\C-x)
11337 all input characters will have the control modifier applied to them.
11339 Note that the character ?\\C-@, equivalent to the integer zero, does
11340 not count as a control character; rather, it counts as a character
11341 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11342 cancels any modification. */);
11343 extra_keyboard_modifiers
= 0;
11345 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11346 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11347 The command loop sets this to nil before each command,
11348 and tests the value when the command returns.
11349 Buffer modification stores t in this variable. */);
11350 Vdeactivate_mark
= Qnil
;
11352 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11353 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11354 Vcommand_hook_internal
= Qnil
;
11356 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11357 doc
: /* Normal hook run before each command is executed.
11358 If an unhandled error happens in running this hook,
11359 the hook value is set to nil, since otherwise the error
11360 might happen repeatedly and make Emacs nonfunctional. */);
11361 Vpre_command_hook
= Qnil
;
11363 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11364 doc
: /* Normal hook run after each command is executed.
11365 If an unhandled error happens in running this hook,
11366 the hook value is set to nil, since otherwise the error
11367 might happen repeatedly and make Emacs nonfunctional. */);
11368 Vpost_command_hook
= Qnil
;
11371 DEFVAR_LISP ("echo-area-clear-hook", ...,
11372 doc
: /* Normal hook run when clearing the echo area. */);
11374 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11375 staticpro (&Qecho_area_clear_hook
);
11376 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11378 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11379 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11380 Vlucid_menu_bar_dirty_flag
= Qnil
;
11382 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11383 doc
: /* List of menu bar items to move to the end of the menu bar.
11384 The elements of the list are event types that may have menu bar bindings. */);
11385 Vmenu_bar_final_items
= Qnil
;
11387 DEFVAR_KBOARD ("overriding-terminal-local-map",
11388 Voverriding_terminal_local_map
,
11389 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11390 If this variable is non-nil, it is used as a keymap instead of the
11391 buffer's local map, and the minor mode keymaps and text property keymaps.
11392 It also replaces `overriding-local-map'.
11394 This variable is intended to let commands such as `universal-argument'
11395 set up a different keymap for reading the next command. */);
11397 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11398 doc
: /* Keymap that overrides all other local keymaps.
11399 If this variable is non-nil, it is used as a keymap--replacing the
11400 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11401 Voverriding_local_map
= Qnil
;
11403 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11404 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11405 Otherwise, the menu bar continues to reflect the buffer's local map
11406 and the minor mode maps regardless of `overriding-local-map'. */);
11407 Voverriding_local_map_menu_flag
= Qnil
;
11409 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11410 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11411 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11413 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11414 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11416 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11417 doc
: /* Alist of system-specific X windows key symbols.
11418 Each element should have the form (N . SYMBOL) where N is the
11419 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11420 and SYMBOL is its name. */);
11422 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11423 doc
: /* List of deferred actions to be performed at a later time.
11424 The precise format isn't relevant here; we just check whether it is nil. */);
11425 Vdeferred_action_list
= Qnil
;
11427 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11428 doc
: /* Function to call to handle deferred actions, after each command.
11429 This function is called with no arguments after each command
11430 whenever `deferred-action-list' is non-nil. */);
11431 Vdeferred_action_function
= Qnil
;
11433 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11434 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11435 The value can be a length of time to show the message for.
11436 If the value is non-nil and not a number, we wait 2 seconds. */);
11437 Vsuggest_key_bindings
= Qt
;
11439 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11440 doc
: /* List of active absolute time timers in order of increasing time. */);
11441 Vtimer_list
= Qnil
;
11443 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11444 doc
: /* List of active idle-time timers in order of increasing time. */);
11445 Vtimer_idle_list
= Qnil
;
11447 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11448 doc
: /* If non-nil, the function that implements the current input method.
11449 It's called with one argument, a printing character that was just read.
11450 \(That means a character with code 040...0176.)
11451 Typically this function uses `read-event' to read additional events.
11452 When it does so, it should first bind `input-method-function' to nil
11453 so it will not be called recursively.
11455 The function should return a list of zero or more events
11456 to be used as input. If it wants to put back some events
11457 to be reconsidered, separately, by the input method,
11458 it can add them to the beginning of `unread-command-events'.
11460 The input method function can find in `input-method-previous-method'
11461 the previous echo area message.
11463 The input method function should refer to the variables
11464 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11465 for guidance on what to do. */);
11466 Vinput_method_function
= Qnil
;
11468 DEFVAR_LISP ("input-method-previous-message",
11469 &Vinput_method_previous_message
,
11470 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11471 This variable exists because `read-event' clears the echo area
11472 before running the input method. It is nil if there was no message. */);
11473 Vinput_method_previous_message
= Qnil
;
11475 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11476 doc
: /* If non-nil, the function that implements the display of help.
11477 It's called with one argument, the help string to display. */);
11478 Vshow_help_function
= Qnil
;
11480 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11481 doc
: /* If non-nil, suppress point adjustment after executing a command.
11483 After a command is executed, if point is moved into a region that has
11484 special properties (e.g. composition, display), we adjust point to
11485 the boundary of the region. But, when a command sets this variable to
11486 non-nil, we suppress the point adjustment.
11488 This variable is set to nil before reading a command, and is checked
11489 just after executing the command. */);
11490 Vdisable_point_adjustment
= Qnil
;
11492 DEFVAR_LISP ("global-disable-point-adjustment",
11493 &Vglobal_disable_point_adjustment
,
11494 doc
: /* *If non-nil, always suppress point adjustment.
11496 The default value is nil, in which case, point adjustment are
11497 suppressed only after special commands that set
11498 `disable-point-adjustment' (which see) to non-nil. */);
11499 Vglobal_disable_point_adjustment
= Qnil
;
11501 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11502 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11503 If the value is not a number, such messages don't time out. */);
11504 Vminibuffer_message_timeout
= make_number (2);
11506 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11507 doc
: /* If non-nil, any keyboard input throws to this symbol.
11508 The value of that variable is passed to `quit-flag' and later causes a
11509 peculiar kind of quitting. */);
11510 Vthrow_on_input
= Qnil
;
11512 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
11513 doc
: /* If non-nil, function to output error messages.
11514 The arguments are the error data, a list of the form
11515 (SIGNALED-CONDITIONS . SIGNAL-DATA)
11516 such as just as `condition-case' would bind its variable to,
11517 the context (a string which normally goes at the start of the message),
11518 and the Lisp function within which the error was signaled. */);
11519 Vcommand_error_function
= Qnil
;
11521 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11522 &Venable_disabled_menus_and_buttons
,
11523 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11525 Help functions bind this to allow help on disabled menu items
11526 and tool-bar buttons. */);
11527 Venable_disabled_menus_and_buttons
= Qnil
;
11531 keys_of_keyboard ()
11533 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11534 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11535 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11536 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11537 initial_define_key (meta_map
, 'x', "execute-extended-command");
11539 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11540 "handle-delete-frame");
11541 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11542 current-prefix-arg, as is done in `handle-switch-frame'.
11543 But `handle-switch-frame is not run from the special-map.
11544 Commands from that map are run in a special way that automatically
11545 preserves the prefix-arg. Restoring the prefix arg here is not just
11546 redundant but harmful:
11548 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11549 - after the first prompt, the exit-minibuffer-hook is run which may
11550 iconify a frame and thus push a `iconify-frame' event.
11551 - after running exit-minibuffer-hook, current-prefix-arg is
11552 restored to the non-nil value it had before the prompt.
11553 - we enter the second prompt.
11554 current-prefix-arg is non-nil, prefix-arg is nil.
11555 - before running the first real event, we run the special iconify-frame
11556 event, but we pass the `special' arg to execute-command so
11557 current-prefix-arg and prefix-arg are left untouched.
11558 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11559 - the next key event will have a spuriously non-nil current-prefix-arg. */
11560 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11562 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11564 /* Handling it at such a low-level causes read_key_sequence to get
11565 * confused because it doesn't realize that the current_buffer was
11566 * changed by read_char.
11568 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11569 * "handle-select-window"); */
11570 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11571 "handle-save-session");
11574 /* Mark the pointers in the kboard objects.
11575 Called by the Fgarbage_collector. */
11581 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11583 if (kb
->kbd_macro_buffer
)
11584 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11586 mark_object (kb
->Voverriding_terminal_local_map
);
11587 mark_object (kb
->Vlast_command
);
11588 mark_object (kb
->Vreal_last_command
);
11589 mark_object (kb
->Vprefix_arg
);
11590 mark_object (kb
->Vlast_prefix_arg
);
11591 mark_object (kb
->kbd_queue
);
11592 mark_object (kb
->defining_kbd_macro
);
11593 mark_object (kb
->Vlast_kbd_macro
);
11594 mark_object (kb
->Vsystem_key_alist
);
11595 mark_object (kb
->system_key_syms
);
11596 mark_object (kb
->Vdefault_minibuffer_frame
);
11597 mark_object (kb
->echo_string
);
11600 struct input_event
*event
;
11601 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11603 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11604 event
= kbd_buffer
;
11605 if (event
->kind
!= SELECTION_REQUEST_EVENT
11606 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11608 mark_object (event
->x
);
11609 mark_object (event
->y
);
11611 mark_object (event
->frame_or_window
);
11612 mark_object (event
->arg
);
11617 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11618 (do not change this comment) */