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"
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 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
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
), 0, 0, 0);
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
;
2406 int count
, jmpcount
;
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 jmpcount
= SPECPDL_INDEX ();
2633 if (_setjmp (local_getcjmp
))
2635 /* We must have saved the outer value of getcjmp here,
2636 so restore it now. */
2637 restore_getcjmp (save_jump
);
2638 unbind_to (jmpcount
, Qnil
);
2639 XSETINT (c
, quit_char
);
2640 internal_last_event_frame
= selected_frame
;
2641 Vlast_event_frame
= internal_last_event_frame
;
2642 /* If we report the quit char as an event,
2643 don't do so more than once. */
2644 if (!NILP (Vinhibit_quit
))
2649 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2650 if (kb
!= current_kboard
)
2652 Lisp_Object link
= kb
->kbd_queue
;
2653 /* We shouldn't get here if we were in single-kboard mode! */
2658 while (CONSP (XCDR (link
)))
2660 if (!NILP (XCDR (link
)))
2664 kb
->kbd_queue
= Fcons (c
, Qnil
);
2666 XSETCDR (link
, Fcons (c
, Qnil
));
2667 kb
->kbd_queue_has_data
= 1;
2668 current_kboard
= kb
;
2669 /* This is going to exit from read_char
2670 so we had better get rid of this frame's stuff. */
2672 longjmp (wrong_kboard_jmpbuf
, 1);
2679 timer_start_idle ();
2681 /* If in middle of key sequence and minibuffer not active,
2682 start echoing if enough time elapses. */
2684 if (minibuf_level
== 0
2686 && !current_kboard
->immediate_echo
2687 && this_command_key_count
> 0
2689 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2690 && NILP (Fzerop (Vecho_keystrokes
))
2691 && (/* No message. */
2692 NILP (echo_area_buffer
[0])
2693 /* Or empty message. */
2694 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2695 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2696 /* Or already echoing from same kboard. */
2697 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2698 /* Or not echoing before and echoing allowed. */
2699 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2701 /* After a mouse event, start echoing right away.
2702 This is because we are probably about to display a menu,
2703 and we don't want to delay before doing so. */
2704 if (EVENT_HAS_PARAMETERS (prev_event
))
2710 save_getcjmp (save_jump
);
2711 restore_getcjmp (local_getcjmp
);
2712 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2713 restore_getcjmp (save_jump
);
2715 && ! CONSP (Vunread_command_events
))
2720 /* Maybe auto save due to number of keystrokes. */
2722 if (commandflag
!= 0
2723 && auto_save_interval
> 0
2724 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2725 && !detect_input_pending_run_timers (0))
2727 Fdo_auto_save (Qnil
, Qnil
);
2728 /* Hooks can actually change some buffers in auto save. */
2732 /* Try reading using an X menu.
2733 This is never confused with reading using the minibuf
2734 because the recursive call of read_char in read_char_minibuf_menu_prompt
2735 does not pass on any keymaps. */
2737 if (nmaps
> 0 && INTERACTIVE
2738 && !NILP (prev_event
)
2739 && EVENT_HAS_PARAMETERS (prev_event
)
2740 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2741 && !EQ (XCAR (prev_event
), Qtool_bar
)
2742 /* Don't bring up a menu if we already have another event. */
2743 && NILP (Vunread_command_events
)
2744 && unread_command_char
< 0)
2746 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2748 /* Now that we have read an event, Emacs is not idle. */
2754 /* Maybe autosave and/or garbage collect due to idleness. */
2756 if (INTERACTIVE
&& NILP (c
))
2758 int delay_level
, buffer_size
;
2760 /* Slow down auto saves logarithmically in size of current buffer,
2761 and garbage collect while we're at it. */
2762 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2763 last_non_minibuf_size
= Z
- BEG
;
2764 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2766 while (buffer_size
> 64)
2767 delay_level
++, buffer_size
-= buffer_size
>> 2;
2768 if (delay_level
< 4) delay_level
= 4;
2769 /* delay_level is 4 for files under around 50k, 7 at 100k,
2770 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2772 /* Auto save if enough time goes by without input. */
2773 if (commandflag
!= 0
2774 && num_nonmacro_input_events
> last_auto_save
2775 && INTEGERP (Vauto_save_timeout
)
2776 && XINT (Vauto_save_timeout
) > 0)
2779 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2781 save_getcjmp (save_jump
);
2782 restore_getcjmp (local_getcjmp
);
2783 tem0
= sit_for (make_number (timeout
), 1, 1);
2784 restore_getcjmp (save_jump
);
2787 && ! CONSP (Vunread_command_events
))
2789 Fdo_auto_save (Qnil
, Qnil
);
2791 /* If we have auto-saved and there is still no input
2792 available, garbage collect if there has been enough
2793 consing going on to make it worthwhile. */
2794 if (!detect_input_pending_run_timers (0)
2795 && consing_since_gc
> gc_cons_threshold
/ 2)
2796 Fgarbage_collect ();
2803 /* If this has become non-nil here, it has been set by a timer
2804 or sentinel or filter. */
2805 if (CONSP (Vunread_command_events
))
2807 c
= XCAR (Vunread_command_events
);
2808 Vunread_command_events
= XCDR (Vunread_command_events
);
2811 /* Read something from current KBOARD's side queue, if possible. */
2815 if (current_kboard
->kbd_queue_has_data
)
2817 if (!CONSP (current_kboard
->kbd_queue
))
2819 c
= XCAR (current_kboard
->kbd_queue
);
2820 current_kboard
->kbd_queue
2821 = XCDR (current_kboard
->kbd_queue
);
2822 if (NILP (current_kboard
->kbd_queue
))
2823 current_kboard
->kbd_queue_has_data
= 0;
2824 input_pending
= readable_events (0);
2825 if (EVENT_HAS_PARAMETERS (c
)
2826 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2827 internal_last_event_frame
= XCAR (XCDR (c
));
2828 Vlast_event_frame
= internal_last_event_frame
;
2833 /* If current_kboard's side queue is empty check the other kboards.
2834 If one of them has data that we have not yet seen here,
2835 switch to it and process the data waiting for it.
2837 Note: if the events queued up for another kboard
2838 have already been seen here, and therefore are not a complete command,
2839 the kbd_queue_has_data field is 0, so we skip that kboard here.
2840 That's to avoid an infinite loop switching between kboards here. */
2841 if (NILP (c
) && !single_kboard
)
2844 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2845 if (kb
->kbd_queue_has_data
)
2847 current_kboard
= kb
;
2848 /* This is going to exit from read_char
2849 so we had better get rid of this frame's stuff. */
2851 longjmp (wrong_kboard_jmpbuf
, 1);
2860 /* Finally, we read from the main queue,
2861 and if that gives us something we can't use yet, we put it on the
2862 appropriate side queue and try again. */
2871 EMACS_GET_TIME (now
);
2872 if (EMACS_TIME_GE (now
, *end_time
))
2876 /* Actually read a character, waiting if necessary. */
2877 save_getcjmp (save_jump
);
2878 restore_getcjmp (local_getcjmp
);
2879 timer_start_idle ();
2880 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2881 restore_getcjmp (save_jump
);
2884 if (! NILP (c
) && (kb
!= current_kboard
))
2886 Lisp_Object link
= kb
->kbd_queue
;
2889 while (CONSP (XCDR (link
)))
2891 if (!NILP (XCDR (link
)))
2895 kb
->kbd_queue
= Fcons (c
, Qnil
);
2897 XSETCDR (link
, Fcons (c
, Qnil
));
2898 kb
->kbd_queue_has_data
= 1;
2902 current_kboard
= kb
;
2903 /* This is going to exit from read_char
2904 so we had better get rid of this frame's stuff. */
2906 longjmp (wrong_kboard_jmpbuf
, 1);
2911 /* Terminate Emacs in batch mode if at eof. */
2912 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2913 Fkill_emacs (make_number (1));
2917 /* Add in any extra modifiers, where appropriate. */
2918 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2919 || ((extra_keyboard_modifiers
& 0177) < ' '
2920 && (extra_keyboard_modifiers
& 0177) != 0))
2921 XSETINT (c
, make_ctrl_char (XINT (c
)));
2923 /* Transfer any other modifier bits directly from
2924 extra_keyboard_modifiers to c. Ignore the actual character code
2925 in the low 16 bits of extra_keyboard_modifiers. */
2926 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2936 if (commandflag
>= 0
2937 && !input_pending
&& !detect_input_pending_run_timers (0))
2945 /* Buffer switch events are only for internal wakeups
2946 so don't show them to the user.
2947 Also, don't record a key if we already did. */
2948 if (BUFFERP (c
) || key_already_recorded
)
2951 /* Process special events within read_char
2952 and loop around to read another event. */
2955 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2960 int was_locked
= single_kboard
;
2962 last_input_char
= c
;
2963 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2965 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2966 /* We stopped being idle for this event; undo that. This
2967 prevents automatic window selection (under
2968 mouse_autoselect_window from acting as a real input event, for
2969 example banishing the mouse under mouse-avoidance-mode. */
2970 timer_resume_idle ();
2972 /* Resume allowing input from any kboard, if that was true before. */
2974 any_kboard_state ();
2979 /* Handle things that only apply to characters. */
2982 /* If kbd_buffer_get_event gave us an EOF, return that. */
2986 if ((STRINGP (Vkeyboard_translate_table
)
2987 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2988 || (VECTORP (Vkeyboard_translate_table
)
2989 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2990 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2991 && CHAR_VALID_P (XINT (c
), 0)))
2994 d
= Faref (Vkeyboard_translate_table
, c
);
2995 /* nil in keyboard-translate-table means no translation. */
3001 /* If this event is a mouse click in the menu bar,
3002 return just menu-bar for now. Modify the mouse click event
3003 so we won't do this twice, then queue it up. */
3004 if (EVENT_HAS_PARAMETERS (c
)
3006 && CONSP (EVENT_START (c
))
3007 && CONSP (XCDR (EVENT_START (c
))))
3011 posn
= POSN_POSN (EVENT_START (c
));
3012 /* Handle menu-bar events:
3013 insert the dummy prefix event `menu-bar'. */
3014 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3016 /* Change menu-bar to (menu-bar) as the event "position". */
3017 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3020 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3025 /* Store these characters into recent_keys, the dribble file if any,
3026 and the keyboard macro being defined, if any. */
3028 if (! NILP (also_record
))
3029 record_char (also_record
);
3031 /* Wipe the echo area.
3032 But first, if we are about to use an input method,
3033 save the echo area contents for it to refer to. */
3035 && ! NILP (Vinput_method_function
)
3036 && (unsigned) XINT (c
) >= ' '
3037 && (unsigned) XINT (c
) != 127
3038 && (unsigned) XINT (c
) < 256)
3040 previous_echo_area_message
= Fcurrent_message ();
3041 Vinput_method_previous_message
= previous_echo_area_message
;
3044 /* Now wipe the echo area, except for help events which do their
3045 own stuff with the echo area. */
3047 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3048 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3050 if (!NILP (echo_area_buffer
[0]))
3051 safe_run_hooks (Qecho_area_clear_hook
);
3052 clear_message (1, 0);
3055 reread_for_input_method
:
3057 /* Pass this to the input method, if appropriate. */
3059 && ! NILP (Vinput_method_function
)
3060 /* Don't run the input method within a key sequence,
3061 after the first event of the key sequence. */
3062 && NILP (prev_event
)
3063 && (unsigned) XINT (c
) >= ' '
3064 && (unsigned) XINT (c
) != 127
3065 && (unsigned) XINT (c
) < 256)
3068 int key_count
, key_count_reset
;
3069 struct gcpro gcpro1
;
3070 int count
= SPECPDL_INDEX ();
3072 /* Save the echo status. */
3073 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3074 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3075 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3076 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3079 if (before_command_restore_flag
)
3081 this_command_key_count
= before_command_key_count_1
;
3082 if (this_command_key_count
< this_single_command_key_start
)
3083 this_single_command_key_start
= this_command_key_count
;
3084 echo_truncate (before_command_echo_length_1
);
3085 before_command_restore_flag
= 0;
3089 /* Save the this_command_keys status. */
3090 key_count
= this_command_key_count
;
3091 key_count_reset
= this_command_key_count_reset
;
3094 keys
= Fcopy_sequence (this_command_keys
);
3099 /* Clear out this_command_keys. */
3100 this_command_key_count
= 0;
3101 this_command_key_count_reset
= 0;
3103 /* Now wipe the echo area. */
3104 if (!NILP (echo_area_buffer
[0]))
3105 safe_run_hooks (Qecho_area_clear_hook
);
3106 clear_message (1, 0);
3109 /* If we are not reading a key sequence,
3110 never use the echo area. */
3113 specbind (Qinput_method_use_echo_area
, Qt
);
3116 /* Call the input method. */
3117 tem
= call1 (Vinput_method_function
, c
);
3119 tem
= unbind_to (count
, tem
);
3121 /* Restore the saved echoing state
3122 and this_command_keys state. */
3123 this_command_key_count
= key_count
;
3124 this_command_key_count_reset
= key_count_reset
;
3126 this_command_keys
= keys
;
3129 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3130 current_kboard
->echo_string
= saved_echo_string
;
3131 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3132 if (saved_immediate_echo
)
3137 /* The input method can return no events. */
3140 /* Bring back the previous message, if any. */
3141 if (! NILP (previous_echo_area_message
))
3142 message_with_string ("%s", previous_echo_area_message
, 0);
3145 /* It returned one event or more. */
3147 Vunread_post_input_method_events
3148 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3153 /* Display help if not echoing. */
3154 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3156 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3157 Lisp_Object help
, object
, position
, window
, tem
;
3159 tem
= Fcdr (XCDR (c
));
3162 window
= Fcar (tem
);
3164 object
= Fcar (tem
);
3166 position
= Fcar (tem
);
3168 show_help_echo (help
, window
, object
, position
, 0);
3170 /* We stopped being idle for this event; undo that. */
3171 timer_resume_idle ();
3175 if (! reread
|| this_command_key_count
== 0
3176 || this_command_key_count_reset
)
3179 /* Don't echo mouse motion events. */
3180 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3181 && NILP (Fzerop (Vecho_keystrokes
))
3182 && ! (EVENT_HAS_PARAMETERS (c
)
3183 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3186 if (! NILP (also_record
))
3187 echo_char (also_record
);
3188 /* Once we reread a character, echoing can happen
3189 the next time we pause to read a new one. */
3190 ok_to_echo_at_next_pause
= current_kboard
;
3193 /* Record this character as part of the current key. */
3194 add_command_key (c
);
3195 if (! NILP (also_record
))
3196 add_command_key (also_record
);
3199 last_input_char
= c
;
3202 /* Process the help character specially if enabled */
3203 if (!NILP (Vhelp_form
) && help_char_p (c
))
3206 count
= SPECPDL_INDEX ();
3208 record_unwind_protect (Fset_window_configuration
,
3209 Fcurrent_window_configuration (Qnil
));
3211 tem0
= Feval (Vhelp_form
);
3213 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3217 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3218 while (BUFFERP (c
));
3219 /* Remove the help from the frame */
3220 unbind_to (count
, Qnil
);
3223 if (EQ (c
, make_number (040)))
3227 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3228 while (BUFFERP (c
));
3237 /* Record a key that came from a mouse menu.
3238 Record it for echoing, for this-command-keys, and so on. */
3244 /* Wipe the echo area. */
3245 clear_message (1, 0);
3250 before_command_key_count
= this_command_key_count
;
3251 before_command_echo_length
= echo_length ();
3254 /* Don't echo mouse motion events. */
3255 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3256 && NILP (Fzerop (Vecho_keystrokes
)))
3260 /* Once we reread a character, echoing can happen
3261 the next time we pause to read a new one. */
3262 ok_to_echo_at_next_pause
= 0;
3265 /* Record this character as part of the current key. */
3266 add_command_key (c
);
3268 /* Re-reading in the middle of a command */
3269 last_input_char
= c
;
3273 /* Return 1 if should recognize C as "the help character". */
3281 if (EQ (c
, Vhelp_char
))
3283 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3284 if (EQ (c
, XCAR (tail
)))
3289 /* Record the input event C in various ways. */
3297 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3299 /* To avoid filling recent_keys with help-echo and mouse-movement
3300 events, we filter out repeated help-echo events, only store the
3301 first and last in a series of mouse-movement events, and don't
3302 store repeated help-echo events which are only separated by
3303 mouse-movement events. */
3305 Lisp_Object ev1
, ev2
, ev3
;
3308 if ((ix1
= recent_keys_index
- 1) < 0)
3309 ix1
= NUM_RECENT_KEYS
- 1;
3310 ev1
= AREF (recent_keys
, ix1
);
3312 if ((ix2
= ix1
- 1) < 0)
3313 ix2
= NUM_RECENT_KEYS
- 1;
3314 ev2
= AREF (recent_keys
, ix2
);
3316 if ((ix3
= ix2
- 1) < 0)
3317 ix3
= NUM_RECENT_KEYS
- 1;
3318 ev3
= AREF (recent_keys
, ix3
);
3320 if (EQ (XCAR (c
), Qhelp_echo
))
3322 /* Don't record `help-echo' in recent_keys unless it shows some help
3323 message, and a different help than the previously recorded
3325 Lisp_Object help
, last_help
;
3327 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3328 if (!STRINGP (help
))
3330 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3331 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3333 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3334 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3335 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3337 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3338 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3339 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3340 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3343 else if (EQ (XCAR (c
), Qmouse_movement
))
3345 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3346 So additional mouse movement events replace the last element. */
3347 Lisp_Object last_window
, window
;
3349 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3350 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3351 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3352 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3353 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3355 ASET (recent_keys
, ix1
, c
);
3361 store_kbd_macro_char (c
);
3366 ASET (recent_keys
, recent_keys_index
, c
);
3367 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3368 recent_keys_index
= 0;
3370 else if (recorded
< 0)
3372 /* We need to remove one or two events from recent_keys.
3373 To do this, we simply put nil at those events and move the
3374 recent_keys_index backwards over those events. Usually,
3375 users will never see those nil events, as they will be
3376 overwritten by the command keys entered to see recent_keys
3379 while (recorded
++ < 0 && total_keys
> 0)
3381 if (total_keys
< NUM_RECENT_KEYS
)
3383 if (--recent_keys_index
< 0)
3384 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3385 ASET (recent_keys
, recent_keys_index
, Qnil
);
3389 num_nonmacro_input_events
++;
3391 /* Write c to the dribble file. If c is a lispy event, write
3392 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3393 If you, dear reader, have a better idea, you've got the source. :-) */
3398 if (XUINT (c
) < 0x100)
3399 putc (XINT (c
), dribble
);
3401 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3405 Lisp_Object dribblee
;
3407 /* If it's a structured event, take the event header. */
3408 dribblee
= EVENT_HEAD (c
);
3410 if (SYMBOLP (dribblee
))
3412 putc ('<', dribble
);
3413 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3414 SBYTES (SYMBOL_NAME (dribblee
)),
3416 putc ('>', dribble
);
3428 struct buffer
*old
= current_buffer
;
3429 Fprinc (object
, Qnil
);
3430 set_buffer_internal (XBUFFER (Vstandard_output
));
3431 call0 (intern ("help-mode"));
3432 set_buffer_internal (old
);
3436 /* Copy out or in the info on where C-g should throw to.
3437 This is used when running Lisp code from within get_char,
3438 in case get_char is called recursively.
3439 See read_process_output. */
3445 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3449 restore_getcjmp (temp
)
3452 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3457 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3458 of this function. */
3461 tracking_off (old_value
)
3462 Lisp_Object old_value
;
3464 do_mouse_tracking
= old_value
;
3465 if (NILP (old_value
))
3467 /* Redisplay may have been preempted because there was input
3468 available, and it assumes it will be called again after the
3469 input has been processed. If the only input available was
3470 the sort that we have just disabled, then we need to call
3472 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
3474 redisplay_preserve_echo_area (6);
3475 get_input_pending (&input_pending
,
3476 READABLE_EVENTS_DO_TIMERS_NOW
);
3482 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3483 doc
: /* Evaluate BODY with mouse movement events enabled.
3484 Within a `track-mouse' form, mouse motion generates input events that
3485 you can read with `read-event'.
3486 Normally, mouse motion is ignored.
3487 usage: (track-mouse BODY ...) */)
3491 int count
= SPECPDL_INDEX ();
3494 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3496 do_mouse_tracking
= Qt
;
3498 val
= Fprogn (args
);
3499 return unbind_to (count
, val
);
3502 /* If mouse has moved on some frame, return one of those frames.
3503 Return 0 otherwise. */
3508 Lisp_Object tail
, frame
;
3510 FOR_EACH_FRAME (tail
, frame
)
3512 if (XFRAME (frame
)->mouse_moved
)
3513 return XFRAME (frame
);
3519 #endif /* HAVE_MOUSE */
3521 /* Low level keyboard/mouse input.
3522 kbd_buffer_store_event places events in kbd_buffer, and
3523 kbd_buffer_get_event retrieves them. */
3525 /* Return true iff there are any events in the queue that read-char
3526 would return. If this returns false, a read-char would block. */
3528 readable_events (flags
)
3531 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3534 /* If the buffer contains only FOCUS_IN_EVENT events, and
3535 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3536 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3538 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3539 #ifdef USE_TOOLKIT_SCROLL_BARS
3540 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3544 struct input_event
*event
;
3546 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3553 #ifdef USE_TOOLKIT_SCROLL_BARS
3554 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3556 event
->kind
== FOCUS_IN_EVENT
)
3557 #ifdef USE_TOOLKIT_SCROLL_BARS
3558 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3559 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3560 && event
->part
== scroll_bar_handle
3561 && event
->modifiers
== 0)
3566 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3569 while (event
!= kbd_store_ptr
);
3576 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3577 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3582 if (current_kboard
->kbd_queue_has_data
)
3588 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3589 if (kb
->kbd_queue_has_data
)
3595 /* Set this for debugging, to have a way to get out */
3600 event_to_kboard (event
)
3601 struct input_event
*event
;
3604 frame
= event
->frame_or_window
;
3606 frame
= XCAR (frame
);
3607 else if (WINDOWP (frame
))
3608 frame
= WINDOW_FRAME (XWINDOW (frame
));
3610 /* There are still some events that don't set this field.
3611 For now, just ignore the problem.
3612 Also ignore dead frames here. */
3613 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3616 return FRAME_KBOARD (XFRAME (frame
));
3621 Lisp_Object Vthrow_on_input
;
3623 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3626 kbd_buffer_store_event (event
)
3627 register struct input_event
*event
;
3629 kbd_buffer_store_event_hold (event
, 0);
3632 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3634 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3635 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3636 Else, if EVENT is a quit event, store the quit event
3637 in HOLD_QUIT, and return (thus ignoring further events).
3639 This is used in read_avail_input to postpone the processing
3640 of the quit event until all subsequent input events have been
3641 parsed (and discarded).
3645 kbd_buffer_store_event_hold (event
, hold_quit
)
3646 register struct input_event
*event
;
3647 struct input_event
*hold_quit
;
3649 if (event
->kind
== NO_EVENT
)
3652 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3655 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3657 register int c
= event
->code
& 0377;
3659 if (event
->modifiers
& ctrl_modifier
)
3660 c
= make_ctrl_char (c
);
3662 c
|= (event
->modifiers
3663 & (meta_modifier
| alt_modifier
3664 | hyper_modifier
| super_modifier
));
3670 struct input_event
*sp
;
3673 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3674 kb
!= current_kboard
))
3677 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3678 Fcons (make_number (c
), Qnil
));
3679 kb
->kbd_queue_has_data
= 1;
3680 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3682 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3685 if (event_to_kboard (sp
) == kb
)
3687 sp
->kind
= NO_EVENT
;
3688 sp
->frame_or_window
= Qnil
;
3698 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3702 /* If this results in a quit_char being returned to Emacs as
3703 input, set Vlast_event_frame properly. If this doesn't
3704 get returned to Emacs as an event, the next event read
3705 will set Vlast_event_frame again, so this is safe to do. */
3709 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3711 focus
= event
->frame_or_window
;
3712 internal_last_event_frame
= focus
;
3713 Vlast_event_frame
= focus
;
3716 last_event_timestamp
= event
->timestamp
;
3717 interrupt_signal (0 /* dummy */);
3721 if (c
&& c
== stop_character
)
3727 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3728 Just ignore the second one. */
3729 else if (event
->kind
== BUFFER_SWITCH_EVENT
3730 && kbd_fetch_ptr
!= kbd_store_ptr
3731 && ((kbd_store_ptr
== kbd_buffer
3732 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3733 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3736 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3737 kbd_store_ptr
= kbd_buffer
;
3739 /* Don't let the very last slot in the buffer become full,
3740 since that would make the two pointers equal,
3741 and that is indistinguishable from an empty buffer.
3742 Discard the event if it would fill the last slot. */
3743 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3745 *kbd_store_ptr
= *event
;
3749 /* If we're inside while-no-input, and this event qualifies
3750 as input, set quit-flag to cause an interrupt. */
3751 if (!NILP (Vthrow_on_input
)
3752 && event
->kind
!= FOCUS_IN_EVENT
3753 && event
->kind
!= HELP_EVENT
3754 && event
->kind
!= DEICONIFY_EVENT
)
3756 Vquit_flag
= Vthrow_on_input
;
3757 /* If we're inside a function that wants immediate quits,
3759 if (immediate_quit
&& NILP (Vinhibit_quit
))
3769 /* Put an input event back in the head of the event queue. */
3772 kbd_buffer_unget_event (event
)
3773 register struct input_event
*event
;
3775 if (kbd_fetch_ptr
== kbd_buffer
)
3776 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3778 /* Don't let the very last slot in the buffer become full, */
3779 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3782 *kbd_fetch_ptr
= *event
;
3787 /* Generate HELP_EVENT input_events in BUFP which has room for
3788 SIZE events. If there's not enough room in BUFP, ignore this
3791 HELP is the help form.
3793 FRAME is the frame on which the help is generated. OBJECT is the
3794 Lisp object where the help was found (a buffer, a string, an
3795 overlay, or nil if neither from a string nor from a buffer. POS is
3796 the position within OBJECT where the help was found.
3798 Value is the number of input_events generated. */
3801 gen_help_event (help
, frame
, window
, object
, pos
)
3802 Lisp_Object help
, frame
, object
, window
;
3805 struct input_event event
;
3809 event
.kind
= HELP_EVENT
;
3810 event
.frame_or_window
= frame
;
3812 event
.x
= WINDOWP (window
) ? window
: frame
;
3815 kbd_buffer_store_event (&event
);
3819 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3822 kbd_buffer_store_help_event (frame
, help
)
3823 Lisp_Object frame
, help
;
3825 struct input_event event
;
3827 event
.kind
= HELP_EVENT
;
3828 event
.frame_or_window
= frame
;
3833 kbd_buffer_store_event (&event
);
3837 /* Discard any mouse events in the event buffer by setting them to
3840 discard_mouse_events ()
3842 struct input_event
*sp
;
3843 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3845 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3848 if (sp
->kind
== MOUSE_CLICK_EVENT
3849 || sp
->kind
== WHEEL_EVENT
3851 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3853 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3855 sp
->kind
= NO_EVENT
;
3861 /* Return non-zero if there are any real events waiting in the event
3862 buffer, not counting `NO_EVENT's.
3864 If DISCARD is non-zero, discard NO_EVENT events at the front of
3865 the input queue, possibly leaving the input queue empty if there
3866 are no real input events. */
3869 kbd_buffer_events_waiting (discard
)
3872 struct input_event
*sp
;
3874 for (sp
= kbd_fetch_ptr
;
3875 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3878 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3885 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3889 /* Clear input event EVENT. */
3893 struct input_event
*event
;
3895 event
->kind
= NO_EVENT
;
3899 /* Read one event from the event buffer, waiting if necessary.
3900 The value is a Lisp object representing the event.
3901 The value is nil for an event that should be ignored,
3902 or that was handled here.
3903 We always read and discard one event. */
3906 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
3908 int *used_mouse_menu
;
3909 EMACS_TIME
*end_time
;
3918 *kbp
= current_kboard
;
3922 /* Wait until there is input available. */
3925 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3928 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3932 /* If the quit flag is set, then read_char will return
3933 quit_char, so that counts as "available input." */
3934 if (!NILP (Vquit_flag
))
3935 quit_throw_to_read_char ();
3937 /* One way or another, wait until input is available; then, if
3938 interrupt handlers have not read it, read it now. */
3941 wait_for_kbd_input ();
3943 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3947 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3950 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3955 EMACS_TIME duration
;
3956 EMACS_GET_TIME (duration
);
3957 if (EMACS_TIME_GE (duration
, *end_time
))
3958 return Qnil
; /* finished waiting */
3961 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3962 wait_reading_process_output (EMACS_SECS (duration
),
3963 EMACS_USECS (duration
),
3964 -1, 1, Qnil
, NULL
, 0);
3968 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3970 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3971 /* Pass 1 for EXPECT since we just waited to have input. */
3972 read_avail_input (1);
3973 #endif /* not VMS */
3976 if (CONSP (Vunread_command_events
))
3979 first
= XCAR (Vunread_command_events
);
3980 Vunread_command_events
= XCDR (Vunread_command_events
);
3981 *kbp
= current_kboard
;
3985 /* At this point, we know that there is a readable event available
3986 somewhere. If the event queue is empty, then there must be a
3987 mouse movement enabled and available. */
3988 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3990 struct input_event
*event
;
3992 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3996 last_event_timestamp
= event
->timestamp
;
3999 *kbp
= event_to_kboard (event
);
4001 *kbp
= current_kboard
; /* Better than returning null ptr? */
4003 *kbp
= &the_only_kboard
;
4008 /* These two kinds of events get special handling
4009 and don't actually appear to the command loop.
4010 We return nil for them. */
4011 if (event
->kind
== SELECTION_REQUEST_EVENT
4012 || event
->kind
== SELECTION_CLEAR_EVENT
)
4015 struct input_event copy
;
4017 /* Remove it from the buffer before processing it,
4018 since otherwise swallow_events will see it
4019 and process it again. */
4021 kbd_fetch_ptr
= event
+ 1;
4022 input_pending
= readable_events (0);
4023 x_handle_selection_event (©
);
4025 /* We're getting selection request events, but we don't have
4031 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4032 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4034 /* Make an event (delete-frame (FRAME)). */
4035 obj
= Fcons (event
->frame_or_window
, Qnil
);
4036 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4037 kbd_fetch_ptr
= event
+ 1;
4040 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4041 else if (event
->kind
== ICONIFY_EVENT
)
4043 /* Make an event (iconify-frame (FRAME)). */
4044 obj
= Fcons (event
->frame_or_window
, Qnil
);
4045 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4046 kbd_fetch_ptr
= event
+ 1;
4048 else if (event
->kind
== DEICONIFY_EVENT
)
4050 /* Make an event (make-frame-visible (FRAME)). */
4051 obj
= Fcons (event
->frame_or_window
, Qnil
);
4052 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4053 kbd_fetch_ptr
= event
+ 1;
4056 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4058 /* The value doesn't matter here; only the type is tested. */
4059 XSETBUFFER (obj
, current_buffer
);
4060 kbd_fetch_ptr
= event
+ 1;
4062 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4063 || defined (USE_GTK)
4064 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4066 kbd_fetch_ptr
= event
+ 1;
4067 input_pending
= readable_events (0);
4068 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4069 x_activate_menubar (XFRAME (event
->frame_or_window
));
4072 #if defined (WINDOWSNT) || defined (MAC_OS)
4073 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4076 /* Make an event (language-change (KEY_SCRIPT)). */
4077 obj
= Fcons (make_number (event
->code
), Qnil
);
4079 /* Make an event (language-change (FRAME CHARSET LCID)). */
4080 obj
= Fcons (event
->frame_or_window
, Qnil
);
4082 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4083 kbd_fetch_ptr
= event
+ 1;
4086 else if (event
->kind
== SAVE_SESSION_EVENT
)
4088 obj
= Fcons (Qsave_session
, Qnil
);
4089 kbd_fetch_ptr
= event
+ 1;
4091 /* Just discard these, by returning nil.
4092 With MULTI_KBOARD, these events are used as placeholders
4093 when we need to randomly delete events from the queue.
4094 (They shouldn't otherwise be found in the buffer,
4095 but on some machines it appears they do show up
4096 even without MULTI_KBOARD.) */
4097 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4098 mouse events during a popup-menu call. */
4099 else if (event
->kind
== NO_EVENT
)
4100 kbd_fetch_ptr
= event
+ 1;
4101 else if (event
->kind
== HELP_EVENT
)
4103 Lisp_Object object
, position
, help
, frame
, window
;
4105 frame
= event
->frame_or_window
;
4106 object
= event
->arg
;
4107 position
= make_number (event
->code
);
4110 clear_event (event
);
4112 kbd_fetch_ptr
= event
+ 1;
4113 if (!WINDOWP (window
))
4115 obj
= Fcons (Qhelp_echo
,
4116 list5 (frame
, help
, window
, object
, position
));
4118 else if (event
->kind
== FOCUS_IN_EVENT
)
4120 /* Notification of a FocusIn event. The frame receiving the
4121 focus is in event->frame_or_window. Generate a
4122 switch-frame event if necessary. */
4123 Lisp_Object frame
, focus
;
4125 frame
= event
->frame_or_window
;
4126 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4130 if (!EQ (frame
, internal_last_event_frame
)
4131 && !EQ (frame
, selected_frame
))
4132 obj
= make_lispy_switch_frame (frame
);
4133 internal_last_event_frame
= frame
;
4134 kbd_fetch_ptr
= event
+ 1;
4138 /* If this event is on a different frame, return a switch-frame this
4139 time, and leave the event in the queue for next time. */
4143 frame
= event
->frame_or_window
;
4145 frame
= XCAR (frame
);
4146 else if (WINDOWP (frame
))
4147 frame
= WINDOW_FRAME (XWINDOW (frame
));
4149 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4153 if (! EQ (frame
, internal_last_event_frame
)
4154 && !EQ (frame
, selected_frame
))
4155 obj
= make_lispy_switch_frame (frame
);
4156 internal_last_event_frame
= frame
;
4158 /* If we didn't decide to make a switch-frame event, go ahead
4159 and build a real event from the queue entry. */
4163 obj
= make_lispy_event (event
);
4165 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4166 || defined (USE_GTK)
4167 /* If this was a menu selection, then set the flag to inhibit
4168 writing to last_nonmenu_event. Don't do this if the event
4169 we're returning is (menu-bar), though; that indicates the
4170 beginning of the menu sequence, and we might as well leave
4171 that as the `event with parameters' for this selection. */
4173 && !EQ (event
->frame_or_window
, event
->arg
)
4174 && (event
->kind
== MENU_BAR_EVENT
4175 || event
->kind
== TOOL_BAR_EVENT
))
4176 *used_mouse_menu
= 1;
4179 /* Wipe out this event, to catch bugs. */
4180 clear_event (event
);
4181 kbd_fetch_ptr
= event
+ 1;
4186 /* Try generating a mouse motion event. */
4187 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4189 FRAME_PTR f
= some_mouse_moved ();
4190 Lisp_Object bar_window
;
4191 enum scroll_bar_part part
;
4195 *kbp
= current_kboard
;
4196 /* Note that this uses F to determine which display to look at.
4197 If there is no valid info, it does not store anything
4198 so x remains nil. */
4200 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4204 /* Decide if we should generate a switch-frame event. Don't
4205 generate switch-frame events for motion outside of all Emacs
4211 frame
= FRAME_FOCUS_FRAME (f
);
4213 XSETFRAME (frame
, f
);
4215 if (! EQ (frame
, internal_last_event_frame
)
4216 && !EQ (frame
, selected_frame
))
4217 obj
= make_lispy_switch_frame (frame
);
4218 internal_last_event_frame
= frame
;
4221 /* If we didn't decide to make a switch-frame event, go ahead and
4222 return a mouse-motion event. */
4223 if (!NILP (x
) && NILP (obj
))
4224 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4226 #endif /* HAVE_MOUSE */
4228 /* We were promised by the above while loop that there was
4229 something for us to read! */
4232 input_pending
= readable_events (0);
4234 Vlast_event_frame
= internal_last_event_frame
;
4239 /* Process any events that are not user-visible,
4240 then return, without reading any user-visible events. */
4243 swallow_events (do_display
)
4248 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4250 struct input_event
*event
;
4252 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4256 last_event_timestamp
= event
->timestamp
;
4258 /* These two kinds of events get special handling
4259 and don't actually appear to the command loop. */
4260 if (event
->kind
== SELECTION_REQUEST_EVENT
4261 || event
->kind
== SELECTION_CLEAR_EVENT
)
4264 struct input_event copy
;
4266 /* Remove it from the buffer before processing it,
4267 since otherwise swallow_events called recursively could see it
4268 and process it again. */
4270 kbd_fetch_ptr
= event
+ 1;
4271 input_pending
= readable_events (0);
4272 x_handle_selection_event (©
);
4274 /* We're getting selection request events, but we don't have
4283 old_timers_run
= timers_run
;
4284 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4286 if (timers_run
!= old_timers_run
&& do_display
)
4287 redisplay_preserve_echo_area (7);
4290 /* Record the start of when Emacs is idle,
4291 for the sake of running idle-time timers. */
4298 /* If we are already in the idle state, do nothing. */
4299 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4302 EMACS_GET_TIME (timer_idleness_start_time
);
4304 timer_last_idleness_start_time
= timer_idleness_start_time
;
4306 /* Mark all idle-time timers as once again candidates for running. */
4307 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4311 timer
= XCAR (timers
);
4313 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4315 XVECTOR (timer
)->contents
[0] = Qnil
;
4319 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4324 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4327 /* Resume idle timer from last idle start time. */
4330 timer_resume_idle ()
4332 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4335 timer_idleness_start_time
= timer_last_idleness_start_time
;
4338 /* This is only for debugging. */
4339 struct input_event last_timer_event
;
4341 /* Check whether a timer has fired. To prevent larger problems we simply
4342 disregard elements that are not proper timers. Do not make a circular
4343 timer list for the time being.
4345 Returns the number of seconds to wait until the next timer fires. If a
4346 timer is triggering now, return zero seconds.
4347 If no timer is active, return -1 seconds.
4349 If a timer is ripe, we run it, with quitting turned off.
4351 DO_IT_NOW is now ignored. It used to mean that we should
4352 run the timer directly instead of queueing a timer-event.
4353 Now we always run timers directly. */
4356 timer_check (do_it_now
)
4359 EMACS_TIME nexttime
;
4360 EMACS_TIME now
, idleness_now
;
4361 Lisp_Object timers
, idle_timers
, chosen_timer
;
4362 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4364 EMACS_SET_SECS (nexttime
, -1);
4365 EMACS_SET_USECS (nexttime
, -1);
4367 /* Always consider the ordinary timers. */
4368 timers
= Vtimer_list
;
4369 /* Consider the idle timers only if Emacs is idle. */
4370 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4371 idle_timers
= Vtimer_idle_list
;
4374 chosen_timer
= Qnil
;
4375 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4377 if (CONSP (timers
) || CONSP (idle_timers
))
4379 EMACS_GET_TIME (now
);
4380 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4381 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4384 while (CONSP (timers
) || CONSP (idle_timers
))
4386 Lisp_Object
*vector
;
4387 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4388 EMACS_TIME timer_time
, idle_timer_time
;
4389 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4391 /* Skip past invalid timers and timers already handled. */
4394 timer
= XCAR (timers
);
4395 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4397 timers
= XCDR (timers
);
4400 vector
= XVECTOR (timer
)->contents
;
4402 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4403 || !INTEGERP (vector
[3])
4404 || ! NILP (vector
[0]))
4406 timers
= XCDR (timers
);
4410 if (!NILP (idle_timers
))
4412 timer
= XCAR (idle_timers
);
4413 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4415 idle_timers
= XCDR (idle_timers
);
4418 vector
= XVECTOR (timer
)->contents
;
4420 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4421 || !INTEGERP (vector
[3])
4422 || ! NILP (vector
[0]))
4424 idle_timers
= XCDR (idle_timers
);
4429 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4430 based on the next ordinary timer.
4431 TIMER_DIFFERENCE is the distance in time from NOW to when
4432 this timer becomes ripe (negative if it's already ripe). */
4435 timer
= XCAR (timers
);
4436 vector
= XVECTOR (timer
)->contents
;
4437 EMACS_SET_SECS (timer_time
,
4438 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4439 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4440 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4443 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4444 based on the next idle timer. */
4445 if (!NILP (idle_timers
))
4447 idle_timer
= XCAR (idle_timers
);
4448 vector
= XVECTOR (idle_timer
)->contents
;
4449 EMACS_SET_SECS (idle_timer_time
,
4450 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4451 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4452 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4455 /* Decide which timer is the next timer,
4456 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4457 Also step down the list where we found that timer. */
4459 if (! NILP (timers
) && ! NILP (idle_timers
))
4462 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4463 if (EMACS_TIME_NEG_P (temp
))
4465 chosen_timer
= timer
;
4466 timers
= XCDR (timers
);
4467 difference
= timer_difference
;
4471 chosen_timer
= idle_timer
;
4472 idle_timers
= XCDR (idle_timers
);
4473 difference
= idle_timer_difference
;
4476 else if (! NILP (timers
))
4478 chosen_timer
= timer
;
4479 timers
= XCDR (timers
);
4480 difference
= timer_difference
;
4484 chosen_timer
= idle_timer
;
4485 idle_timers
= XCDR (idle_timers
);
4486 difference
= idle_timer_difference
;
4488 vector
= XVECTOR (chosen_timer
)->contents
;
4490 /* If timer is ripe, run it if it hasn't been run. */
4491 if (EMACS_TIME_NEG_P (difference
)
4492 || (EMACS_SECS (difference
) == 0
4493 && EMACS_USECS (difference
) == 0))
4495 if (NILP (vector
[0]))
4497 int was_locked
= single_kboard
;
4498 int count
= SPECPDL_INDEX ();
4499 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4501 /* Mark the timer as triggered to prevent problems if the lisp
4502 code fails to reschedule it right. */
4505 specbind (Qinhibit_quit
, Qt
);
4507 call1 (Qtimer_event_handler
, chosen_timer
);
4508 Vdeactivate_mark
= old_deactivate_mark
;
4510 unbind_to (count
, Qnil
);
4512 /* Resume allowing input from any kboard, if that was true before. */
4514 any_kboard_state ();
4516 /* Since we have handled the event,
4517 we don't need to tell the caller to wake up and do it. */
4521 /* When we encounter a timer that is still waiting,
4522 return the amount of time to wait before it is ripe. */
4529 /* No timers are pending in the future. */
4530 /* Return 0 if we generated an event, and -1 if not. */
4535 /* Caches for modify_event_symbol. */
4536 static Lisp_Object accent_key_syms
;
4537 static Lisp_Object func_key_syms
;
4538 static Lisp_Object mouse_syms
;
4539 static Lisp_Object wheel_syms
;
4540 static Lisp_Object drag_n_drop_syms
;
4542 /* This is a list of keysym codes for special "accent" characters.
4543 It parallels lispy_accent_keys. */
4545 static int lispy_accent_codes
[] =
4547 #ifdef XK_dead_circumflex
4552 #ifdef XK_dead_grave
4557 #ifdef XK_dead_tilde
4562 #ifdef XK_dead_diaeresis
4567 #ifdef XK_dead_macron
4572 #ifdef XK_dead_degree
4577 #ifdef XK_dead_acute
4582 #ifdef XK_dead_cedilla
4587 #ifdef XK_dead_breve
4592 #ifdef XK_dead_ogonek
4597 #ifdef XK_dead_caron
4602 #ifdef XK_dead_doubleacute
4603 XK_dead_doubleacute
,
4607 #ifdef XK_dead_abovedot
4612 #ifdef XK_dead_abovering
4622 #ifdef XK_dead_belowdot
4627 #ifdef XK_dead_voiced_sound
4628 XK_dead_voiced_sound
,
4632 #ifdef XK_dead_semivoiced_sound
4633 XK_dead_semivoiced_sound
,
4649 /* This is a list of Lisp names for special "accent" characters.
4650 It parallels lispy_accent_codes. */
4652 static char *lispy_accent_keys
[] =
4670 "dead-voiced-sound",
4671 "dead-semivoiced-sound",
4677 #define FUNCTION_KEY_OFFSET 0x0
4679 char *lispy_function_keys
[] =
4683 0, /* VK_LBUTTON 0x01 */
4684 0, /* VK_RBUTTON 0x02 */
4685 "cancel", /* VK_CANCEL 0x03 */
4686 0, /* VK_MBUTTON 0x04 */
4688 0, 0, 0, /* 0x05 .. 0x07 */
4690 "backspace", /* VK_BACK 0x08 */
4691 "tab", /* VK_TAB 0x09 */
4693 0, 0, /* 0x0A .. 0x0B */
4695 "clear", /* VK_CLEAR 0x0C */
4696 "return", /* VK_RETURN 0x0D */
4698 0, 0, /* 0x0E .. 0x0F */
4700 0, /* VK_SHIFT 0x10 */
4701 0, /* VK_CONTROL 0x11 */
4702 0, /* VK_MENU 0x12 */
4703 "pause", /* VK_PAUSE 0x13 */
4704 "capslock", /* VK_CAPITAL 0x14 */
4706 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4708 "escape", /* VK_ESCAPE 0x1B */
4710 0, 0, 0, 0, /* 0x1C .. 0x1F */
4712 0, /* VK_SPACE 0x20 */
4713 "prior", /* VK_PRIOR 0x21 */
4714 "next", /* VK_NEXT 0x22 */
4715 "end", /* VK_END 0x23 */
4716 "home", /* VK_HOME 0x24 */
4717 "left", /* VK_LEFT 0x25 */
4718 "up", /* VK_UP 0x26 */
4719 "right", /* VK_RIGHT 0x27 */
4720 "down", /* VK_DOWN 0x28 */
4721 "select", /* VK_SELECT 0x29 */
4722 "print", /* VK_PRINT 0x2A */
4723 "execute", /* VK_EXECUTE 0x2B */
4724 "snapshot", /* VK_SNAPSHOT 0x2C */
4725 "insert", /* VK_INSERT 0x2D */
4726 "delete", /* VK_DELETE 0x2E */
4727 "help", /* VK_HELP 0x2F */
4729 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4731 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4733 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4735 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4737 0, 0, 0, 0, 0, 0, 0, 0, 0,
4738 0, 0, 0, 0, 0, 0, 0, 0, 0,
4739 0, 0, 0, 0, 0, 0, 0, 0,
4741 "lwindow", /* VK_LWIN 0x5B */
4742 "rwindow", /* VK_RWIN 0x5C */
4743 "apps", /* VK_APPS 0x5D */
4745 0, 0, /* 0x5E .. 0x5F */
4747 "kp-0", /* VK_NUMPAD0 0x60 */
4748 "kp-1", /* VK_NUMPAD1 0x61 */
4749 "kp-2", /* VK_NUMPAD2 0x62 */
4750 "kp-3", /* VK_NUMPAD3 0x63 */
4751 "kp-4", /* VK_NUMPAD4 0x64 */
4752 "kp-5", /* VK_NUMPAD5 0x65 */
4753 "kp-6", /* VK_NUMPAD6 0x66 */
4754 "kp-7", /* VK_NUMPAD7 0x67 */
4755 "kp-8", /* VK_NUMPAD8 0x68 */
4756 "kp-9", /* VK_NUMPAD9 0x69 */
4757 "kp-multiply", /* VK_MULTIPLY 0x6A */
4758 "kp-add", /* VK_ADD 0x6B */
4759 "kp-separator", /* VK_SEPARATOR 0x6C */
4760 "kp-subtract", /* VK_SUBTRACT 0x6D */
4761 "kp-decimal", /* VK_DECIMAL 0x6E */
4762 "kp-divide", /* VK_DIVIDE 0x6F */
4763 "f1", /* VK_F1 0x70 */
4764 "f2", /* VK_F2 0x71 */
4765 "f3", /* VK_F3 0x72 */
4766 "f4", /* VK_F4 0x73 */
4767 "f5", /* VK_F5 0x74 */
4768 "f6", /* VK_F6 0x75 */
4769 "f7", /* VK_F7 0x76 */
4770 "f8", /* VK_F8 0x77 */
4771 "f9", /* VK_F9 0x78 */
4772 "f10", /* VK_F10 0x79 */
4773 "f11", /* VK_F11 0x7A */
4774 "f12", /* VK_F12 0x7B */
4775 "f13", /* VK_F13 0x7C */
4776 "f14", /* VK_F14 0x7D */
4777 "f15", /* VK_F15 0x7E */
4778 "f16", /* VK_F16 0x7F */
4779 "f17", /* VK_F17 0x80 */
4780 "f18", /* VK_F18 0x81 */
4781 "f19", /* VK_F19 0x82 */
4782 "f20", /* VK_F20 0x83 */
4783 "f21", /* VK_F21 0x84 */
4784 "f22", /* VK_F22 0x85 */
4785 "f23", /* VK_F23 0x86 */
4786 "f24", /* VK_F24 0x87 */
4788 0, 0, 0, 0, /* 0x88 .. 0x8B */
4789 0, 0, 0, 0, /* 0x8C .. 0x8F */
4791 "kp-numlock", /* VK_NUMLOCK 0x90 */
4792 "scroll", /* VK_SCROLL 0x91 */
4794 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4795 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4796 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4797 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4798 "kp-end", /* VK_NUMPAD_END 0x96 */
4799 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4800 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4801 "kp-up", /* VK_NUMPAD_UP 0x99 */
4802 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4803 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4804 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4805 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4807 0, 0, /* 0x9E .. 0x9F */
4810 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4811 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4812 * No other API or message will distinguish left and right keys this way.
4816 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4817 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4818 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4819 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4820 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4826 "attn", /* VK_ATTN 0xF6 */
4827 "crsel", /* VK_CRSEL 0xF7 */
4828 "exsel", /* VK_EXSEL 0xF8 */
4829 "ereof", /* VK_EREOF 0xF9 */
4830 "play", /* VK_PLAY 0xFA */
4831 "zoom", /* VK_ZOOM 0xFB */
4832 "noname", /* VK_NONAME 0xFC */
4833 "pa1", /* VK_PA1 0xFD */
4834 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4838 #else /* not HAVE_NTGUI */
4840 /* This should be dealt with in XTread_socket now, and that doesn't
4841 depend on the client system having the Kana syms defined. See also
4842 the XK_kana_A case below. */
4845 static char *lispy_kana_keys
[] =
4847 /* X Keysym value */
4848 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4849 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4850 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4851 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4852 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4853 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4854 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4855 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4856 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4857 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4858 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4859 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4860 "kana-i", "kana-u", "kana-e", "kana-o",
4861 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4862 "prolongedsound", "kana-A", "kana-I", "kana-U",
4863 "kana-E", "kana-O", "kana-KA", "kana-KI",
4864 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4865 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4866 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4867 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4868 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4869 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4870 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4871 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4872 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4873 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4874 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4875 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4877 #endif /* XK_kana_A */
4880 #define FUNCTION_KEY_OFFSET 0xff00
4882 /* You'll notice that this table is arranged to be conveniently
4883 indexed by X Windows keysym values. */
4884 static char *lispy_function_keys
[] =
4886 /* X Keysym value */
4888 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4889 "backspace", "tab", "linefeed", "clear",
4891 0, 0, 0, "pause", /* 0xff10...1f */
4892 0, 0, 0, 0, 0, 0, 0, "escape",
4894 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4895 "romaji", "hiragana", "katakana", "hiragana-katakana",
4896 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4897 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4898 "eisu-toggle", /* 0xff30...3f */
4899 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4900 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4902 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4903 "down", "prior", "next", "end",
4904 "begin", 0, 0, 0, 0, 0, 0, 0,
4905 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4916 "break", /* 0xff6b */
4919 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4920 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4921 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4922 0, 0, 0, 0, 0, 0, 0, 0,
4923 "kp-tab", /* 0xff89 */
4925 "kp-enter", /* 0xff8d */
4927 "kp-f1", /* 0xff91 */
4931 "kp-home", /* 0xff95 */
4936 "kp-prior", /* kp-page-up */
4937 "kp-next", /* kp-page-down */
4943 0, 0, 0, 0, 0, 0, 0, 0, 0,
4944 "kp-multiply", /* 0xffaa */
4949 "kp-divide", /* 0xffaf */
4950 "kp-0", /* 0xffb0 */
4951 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4954 "kp-equal", /* 0xffbd */
4955 "f1", /* 0xffbe */ /* IsFunctionKey */
4957 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4958 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4959 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4960 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4961 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4962 0, 0, 0, 0, 0, 0, 0, 0,
4963 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4964 0, 0, 0, 0, 0, 0, 0, "delete"
4967 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4968 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4970 static char *iso_lispy_function_keys
[] =
4972 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4973 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4974 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4975 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4976 "iso-lefttab", /* 0xfe20 */
4977 "iso-move-line-up", "iso-move-line-down",
4978 "iso-partial-line-up", "iso-partial-line-down",
4979 "iso-partial-space-left", "iso-partial-space-right",
4980 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4981 "iso-release-margin-left", "iso-release-margin-right",
4982 "iso-release-both-margins",
4983 "iso-fast-cursor-left", "iso-fast-cursor-right",
4984 "iso-fast-cursor-up", "iso-fast-cursor-down",
4985 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4986 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4989 #endif /* not HAVE_NTGUI */
4991 Lisp_Object Vlispy_mouse_stem
;
4993 static char *lispy_wheel_names
[] =
4995 "wheel-up", "wheel-down"
4998 /* drag-n-drop events are generated when a set of selected files are
4999 dragged from another application and dropped onto an Emacs window. */
5000 static char *lispy_drag_n_drop_names
[] =
5005 /* Scroll bar parts. */
5006 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5007 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5008 Lisp_Object Qtop
, Qratio
;
5010 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5011 Lisp_Object
*scroll_bar_parts
[] = {
5012 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5013 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5016 /* User signal events. */
5017 Lisp_Object Qusr1_signal
, Qusr2_signal
;
5019 Lisp_Object
*lispy_user_signals
[] =
5021 &Qusr1_signal
, &Qusr2_signal
5025 /* A vector, indexed by button number, giving the down-going location
5026 of currently depressed buttons, both scroll bar and non-scroll bar.
5028 The elements have the form
5029 (BUTTON-NUMBER MODIFIER-MASK . REST)
5030 where REST is the cdr of a position as it would be reported in the event.
5032 The make_lispy_event function stores positions here to tell the
5033 difference between click and drag events, and to store the starting
5034 location to be included in drag events. */
5036 static Lisp_Object button_down_location
;
5038 /* Information about the most recent up-going button event: Which
5039 button, what location, and what time. */
5041 static int last_mouse_button
;
5042 static int last_mouse_x
;
5043 static int last_mouse_y
;
5044 static unsigned long button_down_time
;
5046 /* The maximum time between clicks to make a double-click, or Qnil to
5047 disable double-click detection, or Qt for no time limit. */
5049 Lisp_Object Vdouble_click_time
;
5051 /* Maximum number of pixels the mouse may be moved between clicks
5052 to make a double-click. */
5054 EMACS_INT double_click_fuzz
;
5056 /* The number of clicks in this multiple-click. */
5058 int double_click_count
;
5060 /* Return position of a mouse click or wheel event */
5063 make_lispy_position (f
, x
, y
, time
)
5069 enum window_part part
;
5070 Lisp_Object posn
= Qnil
;
5071 Lisp_Object extra_info
= Qnil
;
5074 /* Set `window' to the window under frame pixel coordinates (x,y) */
5076 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5077 &part
, &wx
, &wy
, 0);
5081 if (WINDOWP (window
))
5083 /* It's a click in window window at frame coordinates (x,y) */
5084 struct window
*w
= XWINDOW (window
);
5085 Lisp_Object string_info
= Qnil
;
5086 int textpos
= -1, rx
= -1, ry
= -1;
5087 int dx
= -1, dy
= -1;
5088 int width
= -1, height
= -1;
5089 Lisp_Object object
= Qnil
;
5091 /* Set event coordinates to window-relative coordinates
5092 for constructing the Lisp event below. */
5096 if (part
== ON_TEXT
)
5098 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5100 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5102 /* Mode line or header line. Look for a string under
5103 the mouse that may have a `local-map' property. */
5107 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5109 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5110 &object
, &dx
, &dy
, &width
, &height
);
5111 if (STRINGP (string
))
5112 string_info
= Fcons (string
, make_number (charpos
));
5113 if (w
== XWINDOW (selected_window
))
5116 textpos
= XMARKER (w
->pointm
)->charpos
;
5118 else if (part
== ON_VERTICAL_BORDER
)
5120 posn
= Qvertical_line
;
5125 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5130 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5132 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5133 &object
, &dx
, &dy
, &width
, &height
);
5134 if (STRINGP (string
))
5135 string_info
= Fcons (string
, make_number (charpos
));
5136 if (part
== ON_LEFT_MARGIN
)
5139 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5141 else if (part
== ON_LEFT_FRINGE
)
5143 posn
= Qleft_fringe
;
5146 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5148 : window_box_width (w
, LEFT_MARGIN_AREA
));
5151 else if (part
== ON_RIGHT_FRINGE
)
5153 posn
= Qright_fringe
;
5156 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5157 + window_box_width (w
, TEXT_AREA
)
5158 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5159 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5165 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5166 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5171 Lisp_Object string2
, object2
= Qnil
;
5172 struct display_pos p
;
5174 int width2
, height2
;
5175 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5176 &object2
, &dx2
, &dy2
,
5178 textpos
= CHARPOS (p
.pos
);
5179 if (rx
< 0) rx
= wx
;
5180 if (ry
< 0) ry
= wy
;
5181 if (dx
< 0) dx
= dx2
;
5182 if (dy
< 0) dy
= dy2
;
5183 if (width
< 0) width
= width2
;
5184 if (height
< 0) height
= height2
;
5188 posn
= make_number (textpos
);
5189 if (STRINGP (string2
))
5190 string_info
= Fcons (string2
,
5191 make_number (CHARPOS (p
.string_pos
)));
5197 #ifdef HAVE_WINDOW_SYSTEM
5198 if (IMAGEP (object
))
5200 Lisp_Object image_map
, hotspot
;
5201 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5203 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5205 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5206 posn
= XCAR (hotspot
);
5211 extra_info
= Fcons (object
,
5212 Fcons (Fcons (make_number (dx
),
5214 Fcons (Fcons (make_number (width
),
5215 make_number (height
)),
5219 extra_info
= Fcons (string_info
,
5220 Fcons (make_number (textpos
),
5221 Fcons (Fcons (make_number (rx
),
5227 XSETFRAME (window
, f
);
5232 XSETFASTINT (*x
, 0);
5233 XSETFASTINT (*y
, 0);
5236 return Fcons (window
,
5238 Fcons (Fcons (*x
, *y
),
5239 Fcons (make_number (time
),
5243 /* Given a struct input_event, build the lisp event which represents
5244 it. If EVENT is 0, build a mouse movement event from the mouse
5245 movement buffer, which should have a movement event in it.
5247 Note that events must be passed to this function in the order they
5248 are received; this function stores the location of button presses
5249 in order to build drag events when the button is released. */
5252 make_lispy_event (event
)
5253 struct input_event
*event
;
5257 switch (SWITCH_ENUM_CAST (event
->kind
))
5259 /* A simple keystroke. */
5260 case ASCII_KEYSTROKE_EVENT
:
5262 Lisp_Object lispy_c
;
5263 int c
= event
->code
& 0377;
5264 /* Turn ASCII characters into control characters
5266 if (event
->modifiers
& ctrl_modifier
)
5267 c
= make_ctrl_char (c
);
5269 /* Add in the other modifier bits. We took care of ctrl_modifier
5270 just above, and the shift key was taken care of by the X code,
5271 and applied to control characters by make_ctrl_char. */
5272 c
|= (event
->modifiers
5273 & (meta_modifier
| alt_modifier
5274 | hyper_modifier
| super_modifier
));
5275 /* Distinguish Shift-SPC from SPC. */
5276 if ((event
->code
& 0377) == 040
5277 && event
->modifiers
& shift_modifier
)
5278 c
|= shift_modifier
;
5279 button_down_time
= 0;
5280 XSETFASTINT (lispy_c
, c
);
5284 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5286 Lisp_Object lispy_c
;
5287 int c
= event
->code
;
5289 /* Add in the other modifier bits. We took care of ctrl_modifier
5290 just above, and the shift key was taken care of by the X code,
5291 and applied to control characters by make_ctrl_char. */
5292 c
|= (event
->modifiers
5293 & (meta_modifier
| alt_modifier
5294 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5295 /* What about the `shift' modifier ? */
5296 button_down_time
= 0;
5297 XSETFASTINT (lispy_c
, c
);
5301 /* A function key. The symbol may need to have modifier prefixes
5303 case NON_ASCII_KEYSTROKE_EVENT
:
5304 button_down_time
= 0;
5306 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5307 if (event
->code
== lispy_accent_codes
[i
])
5308 return modify_event_symbol (i
,
5310 Qfunction_key
, Qnil
,
5311 lispy_accent_keys
, &accent_key_syms
,
5312 (sizeof (lispy_accent_keys
)
5313 / sizeof (lispy_accent_keys
[0])));
5317 if (event
->code
>= 0x400 && event
->code
< 0x500)
5318 return modify_event_symbol (event
->code
- 0x400,
5319 event
->modifiers
& ~shift_modifier
,
5320 Qfunction_key
, Qnil
,
5321 lispy_kana_keys
, &func_key_syms
,
5322 (sizeof (lispy_kana_keys
)
5323 / sizeof (lispy_kana_keys
[0])));
5324 #endif /* XK_kana_A */
5327 #ifdef ISO_FUNCTION_KEY_OFFSET
5328 if (event
->code
< FUNCTION_KEY_OFFSET
5329 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5330 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5332 Qfunction_key
, Qnil
,
5333 iso_lispy_function_keys
, &func_key_syms
,
5334 (sizeof (iso_lispy_function_keys
)
5335 / sizeof (iso_lispy_function_keys
[0])));
5338 /* Handle system-specific or unknown keysyms. */
5339 if (event
->code
& (1 << 28)
5340 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5341 || (event
->code
- FUNCTION_KEY_OFFSET
5342 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5343 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5345 /* We need to use an alist rather than a vector as the cache
5346 since we can't make a vector long enuf. */
5347 if (NILP (current_kboard
->system_key_syms
))
5348 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5349 return modify_event_symbol (event
->code
,
5352 current_kboard
->Vsystem_key_alist
,
5353 0, ¤t_kboard
->system_key_syms
,
5357 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5359 Qfunction_key
, Qnil
,
5360 lispy_function_keys
, &func_key_syms
,
5361 (sizeof (lispy_function_keys
)
5362 / sizeof (lispy_function_keys
[0])));
5365 /* A mouse click. Figure out where it is, decide whether it's
5366 a press, click or drag, and build the appropriate structure. */
5367 case MOUSE_CLICK_EVENT
:
5368 #ifndef USE_TOOLKIT_SCROLL_BARS
5369 case SCROLL_BAR_CLICK_EVENT
:
5372 int button
= event
->code
;
5374 Lisp_Object position
;
5375 Lisp_Object
*start_pos_ptr
;
5376 Lisp_Object start_pos
;
5380 /* Build the position as appropriate for this mouse click. */
5381 if (event
->kind
== MOUSE_CLICK_EVENT
)
5383 struct frame
*f
= XFRAME (event
->frame_or_window
);
5384 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5388 /* Ignore mouse events that were made on frame that
5389 have been deleted. */
5390 if (! FRAME_LIVE_P (f
))
5393 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5394 /* EVENT->x and EVENT->y are frame-relative pixel
5395 coordinates at this place. Under old redisplay, COLUMN
5396 and ROW are set to frame relative glyph coordinates
5397 which are then used to determine whether this click is
5398 in a menu (non-toolkit version). */
5399 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5400 &column
, &row
, NULL
, 1);
5402 /* In the non-toolkit version, clicks on the menu bar
5403 are ordinary button events in the event buffer.
5404 Distinguish them, and invoke the menu.
5406 (In the toolkit version, the toolkit handles the menu bar
5407 and Emacs doesn't know about it until after the user
5408 makes a selection.) */
5409 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5410 && (event
->modifiers
& down_modifier
))
5412 Lisp_Object items
, item
;
5417 /* Activate the menu bar on the down event. If the
5418 up event comes in before the menu code can deal with it,
5420 if (! (event
->modifiers
& down_modifier
))
5424 /* Find the menu bar item under `column'. */
5426 items
= FRAME_MENU_BAR_ITEMS (f
);
5427 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5429 Lisp_Object pos
, string
;
5430 string
= AREF (items
, i
+ 1);
5431 pos
= AREF (items
, i
+ 3);
5434 if (column
>= XINT (pos
)
5435 && column
< XINT (pos
) + SCHARS (string
))
5437 item
= AREF (items
, i
);
5442 /* ELisp manual 2.4b says (x y) are window relative but
5443 code says they are frame-relative. */
5445 = Fcons (event
->frame_or_window
,
5447 Fcons (Fcons (event
->x
, event
->y
),
5448 Fcons (make_number (event
->timestamp
),
5451 return Fcons (item
, Fcons (position
, Qnil
));
5453 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5455 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5458 #ifndef USE_TOOLKIT_SCROLL_BARS
5461 /* It's a scrollbar click. */
5463 Lisp_Object portion_whole
;
5466 window
= event
->frame_or_window
;
5467 portion_whole
= Fcons (event
->x
, event
->y
);
5468 part
= *scroll_bar_parts
[(int) event
->part
];
5472 Fcons (Qvertical_scroll_bar
,
5473 Fcons (portion_whole
,
5474 Fcons (make_number (event
->timestamp
),
5475 Fcons (part
, Qnil
)))));
5477 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5479 if (button
>= ASIZE (button_down_location
))
5481 button_down_location
= larger_vector (button_down_location
,
5483 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5486 start_pos_ptr
= &AREF (button_down_location
, button
);
5487 start_pos
= *start_pos_ptr
;
5488 *start_pos_ptr
= Qnil
;
5491 /* On window-system frames, use the value of
5492 double-click-fuzz as is. On other frames, interpret it
5493 as a multiple of 1/8 characters. */
5497 if (WINDOWP (event
->frame_or_window
))
5498 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5499 else if (FRAMEP (event
->frame_or_window
))
5500 f
= XFRAME (event
->frame_or_window
);
5504 if (FRAME_WINDOW_P (f
))
5505 fuzz
= double_click_fuzz
;
5507 fuzz
= double_click_fuzz
/ 8;
5509 is_double
= (button
== last_mouse_button
5510 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5511 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5512 && button_down_time
!= 0
5513 && (EQ (Vdouble_click_time
, Qt
)
5514 || (INTEGERP (Vdouble_click_time
)
5515 && ((int)(event
->timestamp
- button_down_time
)
5516 < XINT (Vdouble_click_time
)))));
5519 last_mouse_button
= button
;
5520 last_mouse_x
= XINT (event
->x
);
5521 last_mouse_y
= XINT (event
->y
);
5523 /* If this is a button press, squirrel away the location, so
5524 we can decide later whether it was a click or a drag. */
5525 if (event
->modifiers
& down_modifier
)
5529 double_click_count
++;
5530 event
->modifiers
|= ((double_click_count
> 2)
5535 double_click_count
= 1;
5536 button_down_time
= event
->timestamp
;
5537 *start_pos_ptr
= Fcopy_alist (position
);
5540 /* Now we're releasing a button - check the co-ordinates to
5541 see if this was a click or a drag. */
5542 else if (event
->modifiers
& up_modifier
)
5544 /* If we did not see a down before this up, ignore the up.
5545 Probably this happened because the down event chose a
5546 menu item. It would be an annoyance to treat the
5547 release of the button that chose the menu item as a
5550 if (!CONSP (start_pos
))
5553 event
->modifiers
&= ~up_modifier
;
5554 #if 0 /* Formerly we treated an up with no down as a click event. */
5555 if (!CONSP (start_pos
))
5556 event
->modifiers
|= click_modifier
;
5561 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5563 /* The third element of every position
5564 should be the (x,y) pair. */
5565 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5567 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5569 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5570 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5573 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5574 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5575 /* Maybe the mouse has moved a lot, caused scrolling, and
5576 eventually ended up at the same screen position (but
5577 not buffer position) in which case it is a drag, not
5579 /* FIXME: OTOH if the buffer position has changed
5580 because of a timer or process filter rather than
5581 because of mouse movement, it should be considered as
5582 a click. But mouse-drag-region completely ignores
5583 this case and it hasn't caused any real problem, so
5584 it's probably OK to ignore it as well. */
5585 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5586 /* Mouse hasn't moved (much). */
5587 event
->modifiers
|= click_modifier
;
5590 button_down_time
= 0;
5591 event
->modifiers
|= drag_modifier
;
5594 /* Don't check is_double; treat this as multiple
5595 if the down-event was multiple. */
5596 if (double_click_count
> 1)
5597 event
->modifiers
|= ((double_click_count
> 2)
5603 /* Every mouse event should either have the down_modifier or
5604 the up_modifier set. */
5608 /* Get the symbol we should use for the mouse click. */
5611 head
= modify_event_symbol (button
,
5613 Qmouse_click
, Vlispy_mouse_stem
,
5616 XVECTOR (mouse_syms
)->size
);
5617 if (event
->modifiers
& drag_modifier
)
5622 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5625 Fcons (make_number (double_click_count
),
5636 Lisp_Object position
;
5639 /* Build the position as appropriate for this mouse click. */
5640 struct frame
*f
= XFRAME (event
->frame_or_window
);
5642 /* Ignore wheel events that were made on frame that have been
5644 if (! FRAME_LIVE_P (f
))
5647 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5650 /* Set double or triple modifiers to indicate the wheel speed. */
5652 /* On window-system frames, use the value of
5653 double-click-fuzz as is. On other frames, interpret it
5654 as a multiple of 1/8 characters. */
5659 if (WINDOWP (event
->frame_or_window
))
5660 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5661 else if (FRAMEP (event
->frame_or_window
))
5662 f
= XFRAME (event
->frame_or_window
);
5666 if (FRAME_WINDOW_P (f
))
5667 fuzz
= double_click_fuzz
;
5669 fuzz
= double_click_fuzz
/ 8;
5671 is_double
= (last_mouse_button
< 0
5672 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5673 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5674 && button_down_time
!= 0
5675 && (EQ (Vdouble_click_time
, Qt
)
5676 || (INTEGERP (Vdouble_click_time
)
5677 && ((int)(event
->timestamp
- button_down_time
)
5678 < XINT (Vdouble_click_time
)))));
5681 double_click_count
++;
5682 event
->modifiers
|= ((double_click_count
> 2)
5688 double_click_count
= 1;
5689 event
->modifiers
|= click_modifier
;
5692 button_down_time
= event
->timestamp
;
5693 /* Use a negative value to distinguish wheel from mouse button. */
5694 last_mouse_button
= -1;
5695 last_mouse_x
= XINT (event
->x
);
5696 last_mouse_y
= XINT (event
->y
);
5702 if (event
->modifiers
& up_modifier
)
5704 /* Emit a wheel-up event. */
5705 event
->modifiers
&= ~up_modifier
;
5708 else if (event
->modifiers
& down_modifier
)
5710 /* Emit a wheel-down event. */
5711 event
->modifiers
&= ~down_modifier
;
5715 /* Every wheel event should either have the down_modifier or
5716 the up_modifier set. */
5719 /* Get the symbol we should use for the wheel event. */
5720 head
= modify_event_symbol (symbol_num
,
5726 ASIZE (wheel_syms
));
5729 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5732 Fcons (make_number (double_click_count
),
5741 #ifdef USE_TOOLKIT_SCROLL_BARS
5743 /* We don't have down and up events if using toolkit scroll bars,
5744 so make this always a click event. Store in the `part' of
5745 the Lisp event a symbol which maps to the following actions:
5747 `above_handle' page up
5748 `below_handle' page down
5752 `bottom' bottom of buffer
5753 `handle' thumb has been dragged.
5754 `end-scroll' end of interaction with scroll bar
5756 The incoming input_event contains in its `part' member an
5757 index of type `enum scroll_bar_part' which we can use as an
5758 index in scroll_bar_parts to get the appropriate symbol. */
5760 case SCROLL_BAR_CLICK_EVENT
:
5762 Lisp_Object position
, head
, window
, portion_whole
, part
;
5764 window
= event
->frame_or_window
;
5765 portion_whole
= Fcons (event
->x
, event
->y
);
5766 part
= *scroll_bar_parts
[(int) event
->part
];
5770 Fcons (Qvertical_scroll_bar
,
5771 Fcons (portion_whole
,
5772 Fcons (make_number (event
->timestamp
),
5773 Fcons (part
, Qnil
)))));
5775 /* Always treat scroll bar events as clicks. */
5776 event
->modifiers
|= click_modifier
;
5777 event
->modifiers
&= ~up_modifier
;
5779 if (event
->code
>= ASIZE (mouse_syms
))
5780 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5782 /* Get the symbol we should use for the mouse click. */
5783 head
= modify_event_symbol (event
->code
,
5788 XVECTOR (mouse_syms
)->size
);
5789 return Fcons (head
, Fcons (position
, Qnil
));
5792 #endif /* USE_TOOLKIT_SCROLL_BARS */
5795 case W32_SCROLL_BAR_CLICK_EVENT
:
5797 int button
= event
->code
;
5799 Lisp_Object position
;
5800 Lisp_Object
*start_pos_ptr
;
5801 Lisp_Object start_pos
;
5805 Lisp_Object portion_whole
;
5808 window
= event
->frame_or_window
;
5809 portion_whole
= Fcons (event
->x
, event
->y
);
5810 part
= *scroll_bar_parts
[(int) event
->part
];
5814 Fcons (Qvertical_scroll_bar
,
5815 Fcons (portion_whole
,
5816 Fcons (make_number (event
->timestamp
),
5817 Fcons (part
, Qnil
)))));
5820 /* Always treat W32 scroll bar events as clicks. */
5821 event
->modifiers
|= click_modifier
;
5824 /* Get the symbol we should use for the mouse click. */
5827 head
= modify_event_symbol (button
,
5832 XVECTOR (mouse_syms
)->size
);
5838 #endif /* WINDOWSNT */
5840 case DRAG_N_DROP_EVENT
:
5843 Lisp_Object head
, position
;
5846 f
= XFRAME (event
->frame_or_window
);
5849 /* Ignore mouse events that were made on frames that
5850 have been deleted. */
5851 if (! FRAME_LIVE_P (f
))
5854 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5857 head
= modify_event_symbol (0, event
->modifiers
,
5859 lispy_drag_n_drop_names
,
5860 &drag_n_drop_syms
, 1);
5866 #endif /* HAVE_MOUSE */
5868 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5869 || defined (USE_GTK)
5870 case MENU_BAR_EVENT
:
5871 if (EQ (event
->arg
, event
->frame_or_window
))
5872 /* This is the prefix key. We translate this to
5873 `(menu_bar)' because the code in keyboard.c for menu
5874 events, which we use, relies on this. */
5875 return Fcons (Qmenu_bar
, Qnil
);
5879 case SELECT_WINDOW_EVENT
:
5880 /* Make an event (select-window (WINDOW)). */
5881 return Fcons (Qselect_window
,
5882 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5885 case TOOL_BAR_EVENT
:
5886 if (EQ (event
->arg
, event
->frame_or_window
))
5887 /* This is the prefix key. We translate this to
5888 `(tool_bar)' because the code in keyboard.c for tool bar
5889 events, which we use, relies on this. */
5890 return Fcons (Qtool_bar
, Qnil
);
5891 else if (SYMBOLP (event
->arg
))
5892 return apply_modifiers (event
->modifiers
, event
->arg
);
5895 case USER_SIGNAL_EVENT
:
5896 /* A user signal. */
5897 return *lispy_user_signals
[event
->code
];
5899 case SAVE_SESSION_EVENT
:
5900 return Qsave_session
;
5903 case MAC_APPLE_EVENT
:
5905 Lisp_Object spec
[2];
5909 return Fcons (Qmac_apple_event
,
5910 Fcons (Fvector (2, spec
),
5911 Fcons (event
->arg
, Qnil
)));
5915 /* The 'kind' field of the event is something we don't recognize. */
5924 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5926 Lisp_Object bar_window
;
5927 enum scroll_bar_part part
;
5931 /* Is it a scroll bar movement? */
5932 if (frame
&& ! NILP (bar_window
))
5934 Lisp_Object part_sym
;
5936 part_sym
= *scroll_bar_parts
[(int) part
];
5937 return Fcons (Qscroll_bar_movement
,
5938 (Fcons (Fcons (bar_window
,
5939 Fcons (Qvertical_scroll_bar
,
5940 Fcons (Fcons (x
, y
),
5941 Fcons (make_number (time
),
5947 /* Or is it an ordinary mouse movement? */
5950 Lisp_Object position
;
5952 position
= make_lispy_position (frame
, &x
, &y
, time
);
5954 return Fcons (Qmouse_movement
,
5960 #endif /* HAVE_MOUSE */
5962 /* Construct a switch frame event. */
5964 make_lispy_switch_frame (frame
)
5967 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5970 /* Manipulating modifiers. */
5972 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5974 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5975 SYMBOL's name of the end of the modifiers; the string from this
5976 position is the unmodified symbol name.
5978 This doesn't use any caches. */
5981 parse_modifiers_uncached (symbol
, modifier_end
)
5989 CHECK_SYMBOL (symbol
);
5992 name
= SYMBOL_NAME (symbol
);
5994 for (i
= 0; i
+2 <= SBYTES (name
); )
5996 int this_mod_end
= 0;
5999 /* See if the name continues with a modifier word.
6000 Check that the word appears, but don't check what follows it.
6001 Set this_mod and this_mod_end to record what we find. */
6003 switch (SREF (name
, i
))
6005 #define SINGLE_LETTER_MOD(BIT) \
6006 (this_mod_end = i + 1, this_mod = BIT)
6009 SINGLE_LETTER_MOD (alt_modifier
);
6013 SINGLE_LETTER_MOD (ctrl_modifier
);
6017 SINGLE_LETTER_MOD (hyper_modifier
);
6021 SINGLE_LETTER_MOD (meta_modifier
);
6025 SINGLE_LETTER_MOD (shift_modifier
);
6029 SINGLE_LETTER_MOD (super_modifier
);
6032 #undef SINGLE_LETTER_MOD
6034 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6035 if (i + LEN + 1 <= SBYTES (name) \
6036 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6038 this_mod_end = i + LEN; \
6043 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6044 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6045 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6049 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6051 #undef MULTI_LETTER_MOD
6055 /* If we found no modifier, stop looking for them. */
6056 if (this_mod_end
== 0)
6059 /* Check there is a dash after the modifier, so that it
6060 really is a modifier. */
6061 if (this_mod_end
>= SBYTES (name
)
6062 || SREF (name
, this_mod_end
) != '-')
6065 /* This modifier is real; look for another. */
6066 modifiers
|= this_mod
;
6067 i
= this_mod_end
+ 1;
6070 /* Should we include the `click' modifier? */
6071 if (! (modifiers
& (down_modifier
| drag_modifier
6072 | double_modifier
| triple_modifier
))
6073 && i
+ 7 == SBYTES (name
)
6074 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6075 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6076 modifiers
|= click_modifier
;
6084 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6085 prepended to the string BASE[0..BASE_LEN-1].
6086 This doesn't use any caches. */
6088 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6091 int base_len
, base_len_byte
;
6093 /* Since BASE could contain nulls, we can't use intern here; we have
6094 to use Fintern, which expects a genuine Lisp_String, and keeps a
6097 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6103 /* Only the event queue may use the `up' modifier; it should always
6104 be turned into a click or drag event before presented to lisp code. */
6105 if (modifiers
& up_modifier
)
6108 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6109 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6110 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6111 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6112 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6113 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6114 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6115 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6116 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6117 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6118 /* The click modifier is denoted by the absence of other modifiers. */
6122 mod_len
= p
- new_mods
;
6126 Lisp_Object new_name
;
6128 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6129 mod_len
+ base_len_byte
);
6130 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6131 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6133 return Fintern (new_name
, Qnil
);
6138 static char *modifier_names
[] =
6140 "up", "down", "drag", "click", "double", "triple", 0, 0,
6141 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6142 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6144 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6146 static Lisp_Object modifier_symbols
;
6148 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6150 lispy_modifier_list (modifiers
)
6153 Lisp_Object modifier_list
;
6156 modifier_list
= Qnil
;
6157 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6158 if (modifiers
& (1<<i
))
6159 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6162 return modifier_list
;
6166 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6167 where UNMODIFIED is the unmodified form of SYMBOL,
6168 MASK is the set of modifiers present in SYMBOL's name.
6169 This is similar to parse_modifiers_uncached, but uses the cache in
6170 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6171 Qevent_symbol_elements property. */
6174 parse_modifiers (symbol
)
6177 Lisp_Object elements
;
6179 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6180 if (CONSP (elements
))
6185 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6186 Lisp_Object unmodified
;
6189 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6190 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6193 if (modifiers
& ~INTMASK
)
6195 XSETFASTINT (mask
, modifiers
);
6196 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6198 /* Cache the parsing results on SYMBOL. */
6199 Fput (symbol
, Qevent_symbol_element_mask
,
6201 Fput (symbol
, Qevent_symbol_elements
,
6202 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6204 /* Since we know that SYMBOL is modifiers applied to unmodified,
6205 it would be nice to put that in unmodified's cache.
6206 But we can't, since we're not sure that parse_modifiers is
6213 /* Apply the modifiers MODIFIERS to the symbol BASE.
6214 BASE must be unmodified.
6216 This is like apply_modifiers_uncached, but uses BASE's
6217 Qmodifier_cache property, if present. It also builds
6218 Qevent_symbol_elements properties, since it has that info anyway.
6220 apply_modifiers copies the value of BASE's Qevent_kind property to
6221 the modified symbol. */
6223 apply_modifiers (modifiers
, base
)
6227 Lisp_Object cache
, index
, entry
, new_symbol
;
6229 /* Mask out upper bits. We don't know where this value's been. */
6230 modifiers
&= INTMASK
;
6232 /* The click modifier never figures into cache indices. */
6233 cache
= Fget (base
, Qmodifier_cache
);
6234 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6235 entry
= assq_no_quit (index
, cache
);
6238 new_symbol
= XCDR (entry
);
6241 /* We have to create the symbol ourselves. */
6242 new_symbol
= apply_modifiers_uncached (modifiers
,
6243 SDATA (SYMBOL_NAME (base
)),
6244 SCHARS (SYMBOL_NAME (base
)),
6245 SBYTES (SYMBOL_NAME (base
)));
6247 /* Add the new symbol to the base's cache. */
6248 entry
= Fcons (index
, new_symbol
);
6249 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6251 /* We have the parsing info now for free, so we could add it to
6253 XSETFASTINT (index, modifiers);
6254 Fput (new_symbol, Qevent_symbol_element_mask,
6255 Fcons (base, Fcons (index, Qnil)));
6256 Fput (new_symbol, Qevent_symbol_elements,
6257 Fcons (base, lispy_modifier_list (modifiers)));
6258 Sadly, this is only correct if `base' is indeed a base event,
6259 which is not necessarily the case. -stef */
6262 /* Make sure this symbol is of the same kind as BASE.
6264 You'd think we could just set this once and for all when we
6265 intern the symbol above, but reorder_modifiers may call us when
6266 BASE's property isn't set right; we can't assume that just
6267 because it has a Qmodifier_cache property it must have its
6268 Qevent_kind set right as well. */
6269 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6273 kind
= Fget (base
, Qevent_kind
);
6275 Fput (new_symbol
, Qevent_kind
, kind
);
6282 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6283 return a symbol with the modifiers placed in the canonical order.
6284 Canonical order is alphabetical, except for down and drag, which
6285 always come last. The 'click' modifier is never written out.
6287 Fdefine_key calls this to make sure that (for example) C-M-foo
6288 and M-C-foo end up being equivalent in the keymap. */
6291 reorder_modifiers (symbol
)
6294 /* It's hopefully okay to write the code this way, since everything
6295 will soon be in caches, and no consing will be done at all. */
6298 parsed
= parse_modifiers (symbol
);
6299 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6304 /* For handling events, we often want to produce a symbol whose name
6305 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6306 to some base, like the name of a function key or mouse button.
6307 modify_event_symbol produces symbols of this sort.
6309 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6310 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6313 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6314 into symbol names, or a string specifying a name stem used to
6315 construct a symbol name or the form `STEM-N', where N is the decimal
6316 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6317 non-nil; otherwise NAME_TABLE is used.
6319 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6320 persist between calls to modify_event_symbol that it can use to
6321 store a cache of the symbols it's generated for this NAME_TABLE
6322 before. The object stored there may be a vector or an alist.
6324 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6326 MODIFIERS is a set of modifier bits (as given in struct input_events)
6327 whose prefixes should be applied to the symbol name.
6329 SYMBOL_KIND is the value to be placed in the event_kind property of
6330 the returned symbol.
6332 The symbols we create are supposed to have an
6333 `event-symbol-elements' property, which lists the modifiers present
6334 in the symbol's name. */
6337 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6338 name_table
, symbol_table
, table_size
)
6341 Lisp_Object symbol_kind
;
6342 Lisp_Object name_alist_or_stem
;
6344 Lisp_Object
*symbol_table
;
6345 unsigned int table_size
;
6348 Lisp_Object symbol_int
;
6350 /* Get rid of the "vendor-specific" bit here. */
6351 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6353 /* Is this a request for a valid symbol? */
6354 if (symbol_num
< 0 || symbol_num
>= table_size
)
6357 if (CONSP (*symbol_table
))
6358 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6360 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6361 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6362 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6363 we've never used that symbol before. */
6366 if (! VECTORP (*symbol_table
)
6367 || XVECTOR (*symbol_table
)->size
!= table_size
)
6371 XSETFASTINT (size
, table_size
);
6372 *symbol_table
= Fmake_vector (size
, Qnil
);
6375 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6378 /* Have we already used this symbol before? */
6381 /* No; let's create it. */
6382 if (CONSP (name_alist_or_stem
))
6383 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6384 else if (STRINGP (name_alist_or_stem
))
6386 int len
= SBYTES (name_alist_or_stem
);
6387 char *buf
= (char *) alloca (len
+ 50);
6388 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6389 (long) XINT (symbol_int
) + 1);
6390 value
= intern (buf
);
6392 else if (name_table
!= 0 && name_table
[symbol_num
])
6393 value
= intern (name_table
[symbol_num
]);
6395 #ifdef HAVE_WINDOW_SYSTEM
6398 char *name
= x_get_keysym_name (symbol_num
);
6400 value
= intern (name
);
6407 sprintf (buf
, "key-%d", symbol_num
);
6408 value
= intern (buf
);
6411 if (CONSP (*symbol_table
))
6412 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6414 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6416 /* Fill in the cache entries for this symbol; this also
6417 builds the Qevent_symbol_elements property, which the user
6419 apply_modifiers (modifiers
& click_modifier
, value
);
6420 Fput (value
, Qevent_kind
, symbol_kind
);
6423 /* Apply modifiers to that symbol. */
6424 return apply_modifiers (modifiers
, value
);
6427 /* Convert a list that represents an event type,
6428 such as (ctrl meta backspace), into the usual representation of that
6429 event type as a number or a symbol. */
6431 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6432 doc
: /* Convert the event description list EVENT-DESC to an event type.
6433 EVENT-DESC should contain one base event type (a character or symbol)
6434 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6435 drag, down, double or triple). The base must be last.
6436 The return value is an event type (a character or symbol) which
6437 has the same base event type and all the specified modifiers. */)
6439 Lisp_Object event_desc
;
6447 while (CONSP (rest
))
6455 /* Given a symbol, see if it is a modifier name. */
6456 if (SYMBOLP (elt
) && CONSP (rest
))
6457 this = parse_solitary_modifier (elt
);
6461 else if (!NILP (base
))
6462 error ("Two bases given in one event");
6468 /* Let the symbol A refer to the character A. */
6469 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6470 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6472 if (INTEGERP (base
))
6474 /* Turn (shift a) into A. */
6475 if ((modifiers
& shift_modifier
) != 0
6476 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6478 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6479 modifiers
&= ~shift_modifier
;
6482 /* Turn (control a) into C-a. */
6483 if (modifiers
& ctrl_modifier
)
6484 return make_number ((modifiers
& ~ctrl_modifier
)
6485 | make_ctrl_char (XINT (base
)));
6487 return make_number (modifiers
| XINT (base
));
6489 else if (SYMBOLP (base
))
6490 return apply_modifiers (modifiers
, base
);
6493 error ("Invalid base event");
6498 /* Try to recognize SYMBOL as a modifier name.
6499 Return the modifier flag bit, or 0 if not recognized. */
6502 parse_solitary_modifier (symbol
)
6505 Lisp_Object name
= SYMBOL_NAME (symbol
);
6507 switch (SREF (name
, 0))
6509 #define SINGLE_LETTER_MOD(BIT) \
6510 if (SBYTES (name) == 1) \
6513 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6514 if (LEN == SBYTES (name) \
6515 && ! strncmp (SDATA (name), NAME, LEN)) \
6519 SINGLE_LETTER_MOD (alt_modifier
);
6523 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6527 SINGLE_LETTER_MOD (ctrl_modifier
);
6531 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6532 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6536 SINGLE_LETTER_MOD (hyper_modifier
);
6540 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6544 SINGLE_LETTER_MOD (meta_modifier
);
6548 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6552 SINGLE_LETTER_MOD (shift_modifier
);
6556 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6557 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6558 SINGLE_LETTER_MOD (super_modifier
);
6562 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6563 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6564 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6568 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6571 #undef SINGLE_LETTER_MOD
6572 #undef MULTI_LETTER_MOD
6578 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6579 Such a list is not valid as an event,
6580 but it can be a Lucid-style event type list. */
6583 lucid_event_type_list_p (object
)
6588 if (! CONSP (object
))
6591 if (EQ (XCAR (object
), Qhelp_echo
)
6592 || EQ (XCAR (object
), Qvertical_line
)
6593 || EQ (XCAR (object
), Qmode_line
)
6594 || EQ (XCAR (object
), Qheader_line
))
6597 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6601 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6608 /* Store into *addr a value nonzero if terminal input chars are available.
6609 Serves the purpose of ioctl (0, FIONREAD, addr)
6610 but works even if FIONREAD does not exist.
6611 (In fact, this may actually read some input.)
6613 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6614 timer events that are ripe.
6615 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6616 events (FOCUS_IN_EVENT).
6617 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6618 movements and toolkit scroll bar thumb drags. */
6621 get_input_pending (addr
, flags
)
6625 /* First of all, have we already counted some input? */
6626 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6628 /* If input is being read as it arrives, and we have none, there is none. */
6629 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6632 /* Try to read some input and see how much we get. */
6634 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6637 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6640 gobble_input (expected
)
6645 if (interrupt_input
)
6648 mask
= sigblock (sigmask (SIGIO
));
6649 read_avail_input (expected
);
6653 #ifdef POLL_FOR_INPUT
6654 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6657 mask
= sigblock (sigmask (SIGALRM
));
6658 read_avail_input (expected
);
6664 read_avail_input (expected
);
6668 /* Put a BUFFER_SWITCH_EVENT in the buffer
6669 so that read_key_sequence will notice the new current buffer. */
6672 record_asynch_buffer_change ()
6674 struct input_event event
;
6678 event
.kind
= BUFFER_SWITCH_EVENT
;
6679 event
.frame_or_window
= Qnil
;
6683 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6684 The purpose of the event is to make read_key_sequence look up the
6685 keymaps again. If we aren't in read_key_sequence, we don't need one,
6686 and the event could cause trouble by messing up (input-pending-p). */
6687 tem
= Fwaiting_for_user_input_p ();
6691 /* We never need these events if we have no asynchronous subprocesses. */
6695 /* Make sure no interrupt happens while storing the event. */
6697 if (interrupt_input
)
6700 mask
= sigblock (sigmask (SIGIO
));
6701 kbd_buffer_store_event (&event
);
6708 kbd_buffer_store_event (&event
);
6715 /* Read any terminal input already buffered up by the system
6716 into the kbd_buffer, but do not wait.
6718 EXPECTED should be nonzero if the caller knows there is some input.
6720 Except on VMS, all input is read by this function.
6721 If interrupt_input is nonzero, this function MUST be called
6722 only when SIGIO is blocked.
6724 Returns the number of keyboard chars read, or -1 meaning
6725 this is a bad time to try to read input. */
6728 read_avail_input (expected
)
6734 if (read_socket_hook
)
6737 struct input_event hold_quit
;
6739 EVENT_INIT (hold_quit
);
6740 hold_quit
.kind
= NO_EVENT
;
6742 /* No need for FIONREAD or fcntl; just say don't wait. */
6743 while (nr
= (*read_socket_hook
) (input_fd
, expected
, &hold_quit
), nr
> 0)
6748 if (hold_quit
.kind
!= NO_EVENT
)
6749 kbd_buffer_store_event (&hold_quit
);
6753 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6754 the kbd_buffer can really hold. That may prevent loss
6755 of characters on some systems when input is stuffed at us. */
6756 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6759 /* Determine how many characters we should *try* to read. */
6762 #else /* not WINDOWSNT */
6764 n_to_read
= dos_keysns ();
6767 #else /* not MSDOS */
6769 /* Find out how much input is available. */
6770 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6771 /* Formerly simply reported no input, but that sometimes led to
6772 a failure of Emacs to terminate.
6773 SIGHUP seems appropriate if we can't reach the terminal. */
6774 /* ??? Is it really right to send the signal just to this process
6775 rather than to the whole process group?
6776 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6778 if (! noninteractive
)
6779 kill (getpid (), SIGHUP
);
6785 if (n_to_read
> sizeof cbuf
)
6786 n_to_read
= sizeof cbuf
;
6787 #else /* no FIONREAD */
6788 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6789 /* Read some input if available, but don't wait. */
6790 n_to_read
= sizeof cbuf
;
6791 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6796 #endif /* not MSDOS */
6797 #endif /* not WINDOWSNT */
6799 /* Now read; for one reason or another, this will not block.
6800 NREAD is set to the number of chars read. */
6804 cbuf
[0] = dos_keyread ();
6807 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6809 /* POSIX infers that processes which are not in the session leader's
6810 process group won't get SIGHUP's at logout time. BSDI adheres to
6811 this part standard and returns -1 from read (0) with errno==EIO
6812 when the control tty is taken away.
6813 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6814 if (nread
== -1 && errno
== EIO
)
6816 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6817 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6818 This looks incorrect, but it isn't, because _BSD causes
6819 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6820 and that causes a value other than 0 when there is no input. */
6826 /* We used to retry the read if it was interrupted.
6827 But this does the wrong thing when O_NDELAY causes
6828 an EAGAIN error. Does anybody know of a situation
6829 where a retry is actually needed? */
6831 nread
< 0 && (errno
== EAGAIN
6845 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6846 fcntl (input_fd
, F_SETFL
, 0);
6847 #endif /* USG or DGUX or CYGWIN */
6848 #endif /* no FIONREAD */
6849 for (i
= 0; i
< nread
; i
++)
6851 struct input_event buf
;
6853 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6855 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6856 buf
.modifiers
= meta_modifier
;
6861 buf
.frame_or_window
= selected_frame
;
6864 kbd_buffer_store_event (&buf
);
6865 /* Don't look at input that follows a C-g too closely.
6866 This reduces lossage due to autorepeat on C-g. */
6867 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6868 && buf
.code
== quit_char
)
6875 #endif /* not VMS */
6878 handle_async_input ()
6881 extern int select_alarmed
;
6884 interrupt_input_pending
= 0;
6889 nread
= read_avail_input (1);
6890 /* -1 means it's not ok to read the input now.
6891 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6892 0 means there was no keyboard input available. */
6897 select_alarmed
= 1; /* Force the select emulator back to life */
6902 #ifdef SIGIO /* for entire page */
6903 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6906 input_available_signal (signo
)
6909 /* Must preserve main program's value of errno. */
6910 int old_errno
= errno
;
6911 #if defined (USG) && !defined (POSIX_SIGNALS)
6912 /* USG systems forget handlers when they are used;
6913 must reestablish each time */
6914 signal (signo
, input_available_signal
);
6922 interrupt_input_pending
= 1;
6924 SIGNAL_THREAD_CHECK (signo
);
6927 if (input_available_clear_time
)
6928 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6931 handle_async_input ();
6941 /* Send ourselves a SIGIO.
6943 This function exists so that the UNBLOCK_INPUT macro in
6944 blockinput.h can have some way to take care of input we put off
6945 dealing with, without assuming that every file which uses
6946 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6948 reinvoke_input_signal ()
6951 handle_async_input ();
6957 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6958 static Lisp_Object menu_bar_one_keymap_changed_items
;
6960 /* These variables hold the vector under construction within
6961 menu_bar_items and its subroutines, and the current index
6962 for storing into that vector. */
6963 static Lisp_Object menu_bar_items_vector
;
6964 static int menu_bar_items_index
;
6966 /* Return a vector of menu items for a menu bar, appropriate
6967 to the current buffer. Each item has three elements in the vector:
6970 OLD is an old vector we can optionally reuse, or nil. */
6973 menu_bar_items (old
)
6976 /* The number of keymaps we're scanning right now, and the number of
6977 keymaps we have allocated space for. */
6980 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6981 in the current keymaps, or nil where it is not a prefix. */
6984 Lisp_Object def
, tail
;
6993 /* In order to build the menus, we need to call the keymap
6994 accessors. They all call QUIT. But this function is called
6995 during redisplay, during which a quit is fatal. So inhibit
6996 quitting while building the menus.
6997 We do this instead of specbind because (1) errors will clear it anyway
6998 and (2) this avoids risk of specpdl overflow. */
6999 oquit
= Vinhibit_quit
;
7003 menu_bar_items_vector
= old
;
7005 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7006 menu_bar_items_index
= 0;
7008 /* Build our list of keymaps.
7009 If we recognize a function key and replace its escape sequence in
7010 keybuf with its symbol, or if the sequence starts with a mouse
7011 click and we need to switch buffers, we jump back here to rebuild
7012 the initial keymaps from the current buffer. */
7016 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7017 if (!NILP (Voverriding_local_map_menu_flag
))
7019 /* Yes, use them (if non-nil) as well as the global map. */
7020 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7022 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7023 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7024 if (!NILP (Voverriding_local_map
))
7025 maps
[nmaps
++] = Voverriding_local_map
;
7029 /* No, so use major and minor mode keymaps and keymap property.
7030 Note that menu-bar bindings in the local-map and keymap
7031 properties may not work reliable, as they are only
7032 recognized when the menu-bar (or mode-line) is updated,
7033 which does not normally happen after every command. */
7036 nminor
= current_minor_maps (NULL
, &tmaps
);
7037 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7039 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7040 maps
[nmaps
++] = tem
;
7041 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7043 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7045 maps
[nmaps
++] = current_global_map
;
7048 /* Look up in each map the dummy prefix key `menu-bar'. */
7052 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7053 if (!NILP (maps
[mapno
]))
7055 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7059 menu_bar_one_keymap_changed_items
= Qnil
;
7060 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7064 /* Move to the end those items that should be at the end. */
7066 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7069 int end
= menu_bar_items_index
;
7071 for (i
= 0; i
< end
; i
+= 4)
7072 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7074 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7075 /* Move the item at index I to the end,
7076 shifting all the others forward. */
7077 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7078 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7079 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7080 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7082 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7083 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7084 (end
- i
- 4) * sizeof (Lisp_Object
));
7085 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7086 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7087 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7088 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7093 /* Add nil, nil, nil, nil at the end. */
7094 i
= menu_bar_items_index
;
7095 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7098 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7099 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7100 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7101 menu_bar_items_vector
= tem
;
7103 /* Add this item. */
7104 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7105 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7106 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7107 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7108 menu_bar_items_index
= i
;
7110 Vinhibit_quit
= oquit
;
7111 return menu_bar_items_vector
;
7114 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7115 If there's already an item for KEY, add this DEF to it. */
7117 Lisp_Object item_properties
;
7120 menu_bar_item (key
, item
, dummy1
, dummy2
)
7121 Lisp_Object key
, item
, dummy1
;
7124 struct gcpro gcpro1
;
7128 if (EQ (item
, Qundefined
))
7130 /* If a map has an explicit `undefined' as definition,
7131 discard any previously made menu bar item. */
7133 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7134 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7136 if (menu_bar_items_index
> i
+ 4)
7137 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7138 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7139 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7140 menu_bar_items_index
-= 4;
7144 /* If this keymap has already contributed to this KEY,
7145 don't contribute to it a second time. */
7146 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7147 if (!NILP (tem
) || NILP (item
))
7150 menu_bar_one_keymap_changed_items
7151 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7153 /* We add to menu_bar_one_keymap_changed_items before doing the
7154 parse_menu_item, so that if it turns out it wasn't a menu item,
7155 it still correctly hides any further menu item. */
7157 i
= parse_menu_item (item
, 0, 1);
7162 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7164 /* Find any existing item for this KEY. */
7165 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7166 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7169 /* If we did not find this KEY, add it at the end. */
7170 if (i
== menu_bar_items_index
)
7172 /* If vector is too small, get a bigger one. */
7173 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7176 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7177 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7178 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7179 menu_bar_items_vector
= tem
;
7182 /* Add this item. */
7183 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7184 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7185 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7186 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7187 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7188 menu_bar_items_index
= i
;
7190 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7194 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7195 /* If the new and the old items are not both keymaps,
7196 the lookup will only find `item'. */
7197 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7198 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7202 /* This is used as the handler when calling menu_item_eval_property. */
7204 menu_item_eval_property_1 (arg
)
7207 /* If we got a quit from within the menu computation,
7208 quit all the way out of it. This takes care of C-] in the debugger. */
7209 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7210 Fsignal (Qquit
, Qnil
);
7215 /* Evaluate an expression and return the result (or nil if something
7216 went wrong). Used to evaluate dynamic parts of menu items. */
7218 menu_item_eval_property (sexpr
)
7221 int count
= SPECPDL_INDEX ();
7223 specbind (Qinhibit_redisplay
, Qt
);
7224 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7225 menu_item_eval_property_1
);
7226 return unbind_to (count
, val
);
7229 /* This function parses a menu item and leaves the result in the
7230 vector item_properties.
7231 ITEM is a key binding, a possible menu item.
7232 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7233 evaluate dynamic expressions in the menu item.
7234 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7236 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7237 parse_menu_item returns true if the item is a menu item and false
7241 parse_menu_item (item
, notreal
, inmenubar
)
7243 int notreal
, inmenubar
;
7245 Lisp_Object def
, tem
, item_string
, start
;
7246 Lisp_Object cachelist
;
7248 Lisp_Object keyhint
;
7259 /* Create item_properties vector if necessary. */
7260 if (NILP (item_properties
))
7262 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7264 /* Initialize optional entries. */
7265 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7266 AREF (item_properties
, i
) = Qnil
;
7267 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7269 /* Save the item here to protect it from GC. */
7270 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7272 item_string
= XCAR (item
);
7276 if (STRINGP (item_string
))
7278 /* Old format menu item. */
7279 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7281 /* Maybe help string. */
7282 if (CONSP (item
) && STRINGP (XCAR (item
)))
7284 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7289 /* Maybe key binding cache. */
7290 if (CONSP (item
) && CONSP (XCAR (item
))
7291 && (NILP (XCAR (XCAR (item
)))
7292 || VECTORP (XCAR (XCAR (item
)))))
7294 cachelist
= XCAR (item
);
7298 /* This is the real definition--the function to run. */
7299 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7301 /* Get enable property, if any. */
7304 tem
= Fget (item
, Qmenu_enable
);
7305 if (!NILP (Venable_disabled_menus_and_buttons
))
7306 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7307 else if (!NILP (tem
))
7308 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7311 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7313 /* New format menu item. */
7314 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7315 start
= XCDR (item
);
7318 /* We have a real binding. */
7319 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7321 item
= XCDR (start
);
7322 /* Is there a cache list with key equivalences. */
7323 if (CONSP (item
) && CONSP (XCAR (item
)))
7325 cachelist
= XCAR (item
);
7329 /* Parse properties. */
7330 while (CONSP (item
) && CONSP (XCDR (item
)))
7335 if (EQ (tem
, QCenable
))
7337 if (!NILP (Venable_disabled_menus_and_buttons
))
7338 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7340 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7342 else if (EQ (tem
, QCvisible
) && !notreal
)
7344 /* If got a visible property and that evaluates to nil
7345 then ignore this item. */
7346 tem
= menu_item_eval_property (XCAR (item
));
7350 else if (EQ (tem
, QChelp
))
7351 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7352 else if (EQ (tem
, QCfilter
))
7354 else if (EQ (tem
, QCkey_sequence
))
7357 if (NILP (cachelist
)
7358 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7359 /* Be GC protected. Set keyhint to item instead of tem. */
7362 else if (EQ (tem
, QCkeys
))
7365 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7366 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7368 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7373 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7375 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7377 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7384 else if (inmenubar
|| !NILP (start
))
7388 return 0; /* not a menu item */
7390 /* If item string is not a string, evaluate it to get string.
7391 If we don't get a string, skip this item. */
7392 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7393 if (!(STRINGP (item_string
) || notreal
))
7395 item_string
= menu_item_eval_property (item_string
);
7396 if (!STRINGP (item_string
))
7398 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7401 /* If got a filter apply it on definition. */
7402 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7405 def
= menu_item_eval_property (list2 (XCAR (filter
),
7406 list2 (Qquote
, def
)));
7408 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7411 /* Enable or disable selection of item. */
7412 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7418 tem
= menu_item_eval_property (tem
);
7419 if (inmenubar
&& NILP (tem
))
7420 return 0; /* Ignore disabled items in menu bar. */
7421 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7424 /* If we got no definition, this item is just unselectable text which
7425 is OK in a submenu but not in the menubar. */
7427 return (inmenubar
? 0 : 1);
7429 /* See if this is a separate pane or a submenu. */
7430 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7431 tem
= get_keymap (def
, 0, 1);
7432 /* For a subkeymap, just record its details and exit. */
7435 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7436 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7440 /* At the top level in the menu bar, do likewise for commands also.
7441 The menu bar does not display equivalent key bindings anyway.
7442 ITEM_PROPERTY_DEF is already set up properly. */
7446 /* This is a command. See if there is an equivalent key binding. */
7447 if (NILP (cachelist
))
7449 /* We have to create a cachelist. */
7450 CHECK_IMPURE (start
);
7451 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7452 cachelist
= XCAR (XCDR (start
));
7454 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7455 if (!NILP (keyhint
))
7457 XSETCAR (cachelist
, XCAR (keyhint
));
7460 else if (STRINGP (tem
))
7462 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7463 XSETCAR (cachelist
, Qt
);
7467 tem
= XCAR (cachelist
);
7474 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7476 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7479 def
= XCAR (prefix
);
7480 prefix
= XCDR (prefix
);
7483 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7485 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7487 if (newcache
/* Always check first time. */
7488 /* Should we check everything when precomputing key
7490 /* If something had no key binding before, don't recheck it
7491 because that is too slow--except if we have a list of
7492 rebound commands in Vdefine_key_rebound_commands, do
7493 recheck any command that appears in that list. */
7494 || (CONSP (Vdefine_key_rebound_commands
)
7495 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7498 /* We had a saved key. Is it still bound to the command? */
7501 /* If the command is an alias for another
7502 (such as lmenu.el set it up), check if the
7503 original command matches the cached command. */
7504 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7505 chkcache
= 1; /* Need to recompute key binding. */
7509 /* Recompute equivalent key binding. If the command is an alias
7510 for another (such as lmenu.el set it up), see if the original
7511 command name has equivalent keys. Otherwise look up the
7512 specified command itself. We don't try both, because that
7513 makes lmenu menus slow. */
7515 && SYMBOLP (XSYMBOL (def
)->function
)
7516 && ! NILP (Fget (def
, Qmenu_alias
)))
7517 def
= XSYMBOL (def
)->function
;
7518 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7519 XSETCAR (cachelist
, tem
);
7522 XSETCDR (cachelist
, Qnil
);
7526 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7528 tem
= XCAR (cachelist
);
7532 newcache
= chkcache
;
7535 tem
= Fkey_description (tem
, Qnil
);
7538 if (STRINGP (XCAR (prefix
)))
7539 tem
= concat2 (XCAR (prefix
), tem
);
7540 if (STRINGP (XCDR (prefix
)))
7541 tem
= concat2 (tem
, XCDR (prefix
));
7543 XSETCDR (cachelist
, tem
);
7547 tem
= XCDR (cachelist
);
7548 if (newcache
&& !NILP (tem
))
7550 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7551 XSETCDR (cachelist
, tem
);
7554 /* If we only want to precompute equivalent key bindings, stop here. */
7558 /* If we have an equivalent key binding, use that. */
7559 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7561 /* Include this when menu help is implemented.
7562 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7563 if (!(NILP (tem) || STRINGP (tem)))
7565 tem = menu_item_eval_property (tem);
7568 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7572 /* Handle radio buttons or toggle boxes. */
7573 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7575 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7576 = menu_item_eval_property (tem
);
7583 /***********************************************************************
7585 ***********************************************************************/
7587 /* A vector holding tool bar items while they are parsed in function
7588 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7591 static Lisp_Object tool_bar_items_vector
;
7593 /* A vector holding the result of parse_tool_bar_item. Layout is like
7594 the one for a single item in tool_bar_items_vector. */
7596 static Lisp_Object tool_bar_item_properties
;
7598 /* Next free index in tool_bar_items_vector. */
7600 static int ntool_bar_items
;
7602 /* The symbols `tool-bar', and `:image'. */
7604 extern Lisp_Object Qtool_bar
;
7605 Lisp_Object QCimage
;
7607 /* Function prototypes. */
7609 static void init_tool_bar_items
P_ ((Lisp_Object
));
7610 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7611 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7612 static void append_tool_bar_item
P_ ((void));
7615 /* Return a vector of tool bar items for keymaps currently in effect.
7616 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7617 tool bar items found. */
7620 tool_bar_items (reuse
, nitems
)
7631 /* In order to build the menus, we need to call the keymap
7632 accessors. They all call QUIT. But this function is called
7633 during redisplay, during which a quit is fatal. So inhibit
7634 quitting while building the menus. We do this instead of
7635 specbind because (1) errors will clear it anyway and (2) this
7636 avoids risk of specpdl overflow. */
7637 oquit
= Vinhibit_quit
;
7640 /* Initialize tool_bar_items_vector and protect it from GC. */
7641 init_tool_bar_items (reuse
);
7643 /* Build list of keymaps in maps. Set nmaps to the number of maps
7646 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7647 if (!NILP (Voverriding_local_map_menu_flag
))
7649 /* Yes, use them (if non-nil) as well as the global map. */
7650 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7652 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7653 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7654 if (!NILP (Voverriding_local_map
))
7655 maps
[nmaps
++] = Voverriding_local_map
;
7659 /* No, so use major and minor mode keymaps and keymap property.
7660 Note that tool-bar bindings in the local-map and keymap
7661 properties may not work reliable, as they are only
7662 recognized when the tool-bar (or mode-line) is updated,
7663 which does not normally happen after every command. */
7666 nminor
= current_minor_maps (NULL
, &tmaps
);
7667 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7669 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7670 maps
[nmaps
++] = tem
;
7671 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7673 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7676 /* Add global keymap at the end. */
7677 maps
[nmaps
++] = current_global_map
;
7679 /* Process maps in reverse order and look up in each map the prefix
7681 for (i
= nmaps
- 1; i
>= 0; --i
)
7682 if (!NILP (maps
[i
]))
7686 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7688 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7691 Vinhibit_quit
= oquit
;
7692 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7693 return tool_bar_items_vector
;
7697 /* Process the definition of KEY which is DEF. */
7700 process_tool_bar_item (key
, def
, data
, args
)
7701 Lisp_Object key
, def
, data
;
7705 extern Lisp_Object Qundefined
;
7706 struct gcpro gcpro1
, gcpro2
;
7708 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7712 if (EQ (def
, Qundefined
))
7714 /* If a map has an explicit `undefined' as definition,
7715 discard any previously made item. */
7716 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7718 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7720 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7722 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7723 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7724 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7725 * sizeof (Lisp_Object
)));
7726 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7731 else if (parse_tool_bar_item (key
, def
))
7732 /* Append a new tool bar item to tool_bar_items_vector. Accept
7733 more than one definition for the same key. */
7734 append_tool_bar_item ();
7740 /* Parse a tool bar item specification ITEM for key KEY and return the
7741 result in tool_bar_item_properties. Value is zero if ITEM is
7744 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7746 CAPTION is the caption of the item, If it's not a string, it is
7747 evaluated to get a string.
7749 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7750 as binding are currently ignored.
7752 The following properties are recognized:
7756 FORM is evaluated and specifies whether the tool bar item is
7757 enabled or disabled.
7761 FORM is evaluated and specifies whether the tool bar item is visible.
7763 - `:filter FUNCTION'
7765 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7766 result is stored as the new binding.
7768 - `:button (TYPE SELECTED)'
7770 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7771 and specifies whether the button is selected (pressed) or not.
7775 IMAGES is either a single image specification or a vector of four
7776 image specifications. See enum tool_bar_item_images.
7778 - `:help HELP-STRING'.
7780 Gives a help string to display for the tool bar item. */
7783 parse_tool_bar_item (key
, item
)
7784 Lisp_Object key
, item
;
7786 /* Access slot with index IDX of vector tool_bar_item_properties. */
7787 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7789 Lisp_Object filter
= Qnil
;
7790 Lisp_Object caption
;
7793 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7794 Rule out items that aren't lists, don't start with
7795 `menu-item' or whose rest following `tool-bar-item' is not a
7798 || !EQ (XCAR (item
), Qmenu_item
)
7799 || (item
= XCDR (item
),
7803 /* Create tool_bar_item_properties vector if necessary. Reset it to
7805 if (VECTORP (tool_bar_item_properties
))
7807 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7811 tool_bar_item_properties
7812 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7815 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7816 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7818 /* Get the caption of the item. If the caption is not a string,
7819 evaluate it to get a string. If we don't get a string, skip this
7821 caption
= XCAR (item
);
7822 if (!STRINGP (caption
))
7824 caption
= menu_item_eval_property (caption
);
7825 if (!STRINGP (caption
))
7828 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7830 /* Give up if rest following the caption is not a list. */
7835 /* Store the binding. */
7836 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7839 /* Ignore cached key binding, if any. */
7840 if (CONSP (item
) && CONSP (XCAR (item
)))
7843 /* Process the rest of the properties. */
7844 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7846 Lisp_Object key
, value
;
7849 value
= XCAR (XCDR (item
));
7851 if (EQ (key
, QCenable
))
7853 /* `:enable FORM'. */
7854 if (!NILP (Venable_disabled_menus_and_buttons
))
7855 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7857 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7859 else if (EQ (key
, QCvisible
))
7861 /* `:visible FORM'. If got a visible property and that
7862 evaluates to nil then ignore this item. */
7863 if (NILP (menu_item_eval_property (value
)))
7866 else if (EQ (key
, QChelp
))
7867 /* `:help HELP-STRING'. */
7868 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7869 else if (EQ (key
, QCfilter
))
7870 /* ':filter FORM'. */
7872 else if (EQ (key
, QCbutton
) && CONSP (value
))
7874 /* `:button (TYPE . SELECTED)'. */
7875 Lisp_Object type
, selected
;
7877 type
= XCAR (value
);
7878 selected
= XCDR (value
);
7879 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7881 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7882 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7885 else if (EQ (key
, QCimage
)
7887 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7888 /* Value is either a single image specification or a vector
7889 of 4 such specifications for the different button states. */
7890 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7893 /* If got a filter apply it on binding. */
7895 PROP (TOOL_BAR_ITEM_BINDING
)
7896 = menu_item_eval_property (list2 (filter
,
7898 PROP (TOOL_BAR_ITEM_BINDING
))));
7900 /* See if the binding is a keymap. Give up if it is. */
7901 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7904 /* Enable or disable selection of item. */
7905 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7906 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7907 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7909 /* Handle radio buttons or toggle boxes. */
7910 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7911 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7912 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7920 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7921 that can be reused. */
7924 init_tool_bar_items (reuse
)
7927 if (VECTORP (reuse
))
7928 tool_bar_items_vector
= reuse
;
7930 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7931 ntool_bar_items
= 0;
7935 /* Append parsed tool bar item properties from
7936 tool_bar_item_properties */
7939 append_tool_bar_item ()
7941 Lisp_Object
*to
, *from
;
7943 /* Enlarge tool_bar_items_vector if necessary. */
7944 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7945 >= XVECTOR (tool_bar_items_vector
)->size
)
7947 Lisp_Object new_vector
;
7948 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7950 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7951 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7952 XVECTOR (new_vector
)->contents
,
7953 old_size
* sizeof (Lisp_Object
));
7954 tool_bar_items_vector
= new_vector
;
7957 /* Append entries from tool_bar_item_properties to the end of
7958 tool_bar_items_vector. */
7959 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7960 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7961 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7962 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7969 /* Read a character using menus based on maps in the array MAPS.
7970 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7971 Return t if we displayed a menu but the user rejected it.
7973 PREV_EVENT is the previous input event, or nil if we are reading
7974 the first event of a key sequence.
7976 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7977 if we used a mouse menu to read the input, or zero otherwise. If
7978 USED_MOUSE_MENU is null, we don't dereference it.
7980 The prompting is done based on the prompt-string of the map
7981 and the strings associated with various map elements.
7983 This can be done with X menus or with menus put in the minibuf.
7984 These are done in different ways, depending on how the input will be read.
7985 Menus using X are done after auto-saving in read-char, getting the input
7986 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7987 and do auto-saving in the inner call of read_char. */
7990 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7993 Lisp_Object prev_event
;
7994 int *used_mouse_menu
;
7997 register Lisp_Object name
= Qnil
;
7999 if (used_mouse_menu
)
8000 *used_mouse_menu
= 0;
8002 /* Use local over global Menu maps */
8004 if (! menu_prompting
)
8007 /* Optionally disregard all but the global map. */
8008 if (inhibit_local_menu_bar_menus
)
8010 maps
+= (nmaps
- 1);
8014 /* Get the menu name from the first map that has one (a prompt string). */
8015 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8017 name
= Fkeymap_prompt (maps
[mapno
]);
8022 /* If we don't have any menus, just read a character normally. */
8023 if (!STRINGP (name
))
8027 /* If we got to this point via a mouse click,
8028 use a real menu for mouse selection. */
8029 if (EVENT_HAS_PARAMETERS (prev_event
)
8030 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8031 && !EQ (XCAR (prev_event
), Qtool_bar
))
8033 /* Display the menu and get the selection. */
8034 Lisp_Object
*realmaps
8035 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8039 /* Use the maps that are not nil. */
8040 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8041 if (!NILP (maps
[mapno
]))
8042 realmaps
[nmaps1
++] = maps
[mapno
];
8044 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8049 record_menu_key (XCAR (value
));
8051 /* If we got multiple events, unread all but
8053 There is no way to prevent those unread events
8054 from showing up later in last_nonmenu_event.
8055 So turn symbol and integer events into lists,
8056 to indicate that they came from a mouse menu,
8057 so that when present in last_nonmenu_event
8058 they won't confuse things. */
8059 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8061 record_menu_key (XCAR (tem
));
8062 if (SYMBOLP (XCAR (tem
))
8063 || INTEGERP (XCAR (tem
)))
8064 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8067 /* If we got more than one event, put all but the first
8068 onto this list to be read later.
8069 Return just the first event now. */
8070 Vunread_command_events
8071 = nconc2 (XCDR (value
), Vunread_command_events
);
8072 value
= XCAR (value
);
8074 else if (NILP (value
))
8076 if (used_mouse_menu
)
8077 *used_mouse_menu
= 1;
8080 #endif /* HAVE_MENUS */
8084 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8085 We make this bigger when necessary, and never free it. */
8086 static char *read_char_minibuf_menu_text
;
8087 /* Size of that buffer. */
8088 static int read_char_minibuf_menu_width
;
8091 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8097 register Lisp_Object name
;
8099 /* FIXME: Use the minibuffer's frame width. */
8100 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8103 Lisp_Object rest
, vector
;
8109 if (! menu_prompting
)
8112 /* Make sure we have a big enough buffer for the menu text. */
8113 if (read_char_minibuf_menu_text
== 0)
8115 read_char_minibuf_menu_width
= width
+ 4;
8116 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8118 else if (width
+ 4 > read_char_minibuf_menu_width
)
8120 read_char_minibuf_menu_width
= width
+ 4;
8121 read_char_minibuf_menu_text
8122 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8124 menu
= read_char_minibuf_menu_text
;
8126 /* Get the menu name from the first map that has one (a prompt string). */
8127 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8129 name
= Fkeymap_prompt (maps
[mapno
]);
8134 /* If we don't have any menus, just read a character normally. */
8135 if (!STRINGP (name
))
8138 /* Prompt string always starts with map's prompt, and a space. */
8139 strcpy (menu
, SDATA (name
));
8140 nlength
= SBYTES (name
);
8141 menu
[nlength
++] = ':';
8142 menu
[nlength
++] = ' ';
8145 /* Start prompting at start of first map. */
8149 /* Present the documented bindings, a line at a time. */
8156 Lisp_Object orig_defn_macro
;
8158 /* Loop over elements of map. */
8163 /* If reached end of map, start at beginning of next map. */
8167 /* At end of last map, wrap around to first map if just starting,
8168 or end this line if already have something on it. */
8172 if (notfirst
|| nobindings
) break;
8177 /* Look at the next element of the map. */
8179 elt
= XVECTOR (vector
)->contents
[idx
];
8181 elt
= Fcar_safe (rest
);
8183 if (idx
< 0 && VECTORP (elt
))
8185 /* If we found a dense table in the keymap,
8186 advanced past it, but start scanning its contents. */
8187 rest
= Fcdr_safe (rest
);
8193 /* An ordinary element. */
8194 Lisp_Object event
, tem
;
8198 event
= Fcar_safe (elt
); /* alist */
8199 elt
= Fcdr_safe (elt
);
8203 XSETINT (event
, idx
); /* vector */
8206 /* Ignore the element if it has no prompt string. */
8207 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8209 /* 1 if the char to type matches the string. */
8211 Lisp_Object upcased_event
, downcased_event
;
8212 Lisp_Object desc
= Qnil
;
8214 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8216 upcased_event
= Fupcase (event
);
8217 downcased_event
= Fdowncase (event
);
8218 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8219 || XINT (downcased_event
) == SREF (s
, 0));
8221 desc
= Fsingle_key_description (event
, Qnil
);
8223 #if 0 /* It is redundant to list the equivalent key bindings because
8224 the prefix is what the user has already typed. */
8226 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8228 /* Insert equivalent keybinding. */
8229 s
= concat2 (s
, tem
);
8232 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8233 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8235 /* Insert button prefix. */
8236 Lisp_Object selected
8237 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8238 if (EQ (tem
, QCradio
))
8239 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8241 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8242 s
= concat2 (tem
, s
);
8246 /* If we have room for the prompt string, add it to this line.
8247 If this is the first on the line, always add it. */
8248 if ((SCHARS (s
) + i
+ 2
8249 + (char_matches
? 0 : SCHARS (desc
) + 3))
8255 /* Punctuate between strings. */
8258 strcpy (menu
+ i
, ", ");
8264 /* If the char to type doesn't match the string's
8265 first char, explicitly show what char to type. */
8268 /* Add as much of string as fits. */
8269 thiswidth
= SCHARS (desc
);
8270 if (thiswidth
+ i
> width
)
8271 thiswidth
= width
- i
;
8272 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8274 strcpy (menu
+ i
, " = ");
8278 /* Add as much of string as fits. */
8279 thiswidth
= SCHARS (s
);
8280 if (thiswidth
+ i
> width
)
8281 thiswidth
= width
- i
;
8282 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8288 /* If this element does not fit, end the line now,
8289 and save the element for the next line. */
8290 strcpy (menu
+ i
, "...");
8295 /* Move past this element. */
8296 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8297 /* Handle reaching end of dense table. */
8302 rest
= Fcdr_safe (rest
);
8306 /* Prompt with that and read response. */
8307 message2_nolog (menu
, strlen (menu
),
8308 ! NILP (current_buffer
->enable_multibyte_characters
));
8310 /* Make believe its not a keyboard macro in case the help char
8311 is pressed. Help characters are not recorded because menu prompting
8312 is not used on replay.
8314 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8315 current_kboard
->defining_kbd_macro
= Qnil
;
8317 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8318 while (BUFFERP (obj
));
8319 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8321 if (!INTEGERP (obj
))
8326 if (! EQ (obj
, menu_prompt_more_char
)
8327 && (!INTEGERP (menu_prompt_more_char
)
8328 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8330 if (!NILP (current_kboard
->defining_kbd_macro
))
8331 store_kbd_macro_char (obj
);
8334 /* Help char - go round again */
8338 /* Reading key sequences. */
8340 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8341 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8342 keymap, or nil otherwise. Return the index of the first keymap in
8343 which KEY has any binding, or NMAPS if no map has a binding.
8345 If KEY is a meta ASCII character, treat it like meta-prefix-char
8346 followed by the corresponding non-meta character. Keymaps in
8347 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8350 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8353 NEXT may be the same array as CURRENT. */
8356 follow_key (key
, nmaps
, current
, defs
, next
)
8358 Lisp_Object
*current
, *defs
, *next
;
8361 int i
, first_binding
;
8363 first_binding
= nmaps
;
8364 for (i
= nmaps
- 1; i
>= 0; i
--)
8366 if (! NILP (current
[i
]))
8368 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8369 if (! NILP (defs
[i
]))
8376 /* Given the set of bindings we've found, produce the next set of maps. */
8377 if (first_binding
< nmaps
)
8378 for (i
= 0; i
< nmaps
; i
++)
8379 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8381 return first_binding
;
8384 /* Structure used to keep track of partial application of key remapping
8385 such as Vfunction_key_map and Vkey_translation_map. */
8386 typedef struct keyremap
8388 Lisp_Object map
, parent
;
8392 /* Lookup KEY in MAP.
8393 MAP is a keymap mapping keys to key vectors or functions.
8394 If the mapping is a function and DO_FUNCTION is non-zero, then
8395 the function is called with PROMPT as parameter and its return
8396 value is used as the return value of this function (after checking
8397 that it is indeed a vector). */
8400 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8401 Lisp_Object map
, key
, prompt
;
8406 next
= access_keymap (map
, key
, 1, 0, 1);
8408 /* Handle symbol with autoload definition. */
8409 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8410 && CONSP (XSYMBOL (next
)->function
)
8411 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8412 do_autoload (XSYMBOL (next
)->function
, next
);
8414 /* Handle a symbol whose function definition is a keymap
8416 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8417 && (ARRAYP (XSYMBOL (next
)->function
)
8418 || KEYMAPP (XSYMBOL (next
)->function
)))
8419 next
= XSYMBOL (next
)->function
;
8421 /* If the keymap gives a function, not an
8422 array, then call the function with one arg and use
8423 its value instead. */
8424 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8429 next
= call1 (next
, prompt
);
8430 /* If the function returned something invalid,
8431 barf--don't ignore it.
8432 (To ignore it safely, we would need to gcpro a bunch of
8433 other variables.) */
8434 if (! (VECTORP (next
) || STRINGP (next
)))
8435 error ("Function %s returns invalid key sequence", tem
);
8440 /* Do one step of the key remapping used for function-key-map and
8441 key-translation-map:
8442 KEYBUF is the buffer holding the input events.
8443 BUFSIZE is its maximum size.
8444 FKEY is a pointer to the keyremap structure to use.
8445 INPUT is the index of the last element in KEYBUF.
8446 DOIT if non-zero says that the remapping can actually take place.
8447 DIFF is used to return the number of keys added/removed by the remapping.
8448 PARENT is the root of the keymap.
8449 PROMPT is the prompt to use if the remapping happens through a function.
8450 The return value is non-zero if the remapping actually took place. */
8453 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8454 Lisp_Object
*keybuf
, prompt
;
8456 int input
, doit
, *diff
, bufsize
;
8458 Lisp_Object next
, key
;
8460 key
= keybuf
[fkey
->end
++];
8461 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8463 /* If keybuf[fkey->start..fkey->end] is bound in the
8464 map and we're in a position to do the key remapping, replace it with
8465 the binding and restart with fkey->start at the end. */
8466 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8468 int len
= XFASTINT (Flength (next
));
8471 *diff
= len
- (fkey
->end
- fkey
->start
);
8473 if (input
+ *diff
>= bufsize
)
8474 error ("Key sequence too long");
8476 /* Shift the keys that follow fkey->end. */
8478 for (i
= fkey
->end
; i
< input
; i
++)
8479 keybuf
[i
+ *diff
] = keybuf
[i
];
8481 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8482 keybuf
[i
+ *diff
] = keybuf
[i
];
8483 /* Overwrite the old keys with the new ones. */
8484 for (i
= 0; i
< len
; i
++)
8485 keybuf
[fkey
->start
+ i
]
8486 = Faref (next
, make_number (i
));
8488 fkey
->start
= fkey
->end
+= *diff
;
8489 fkey
->map
= fkey
->parent
;
8494 fkey
->map
= get_keymap (next
, 0, 1);
8496 /* If we no longer have a bound suffix, try a new position for
8498 if (!CONSP (fkey
->map
))
8500 fkey
->end
= ++fkey
->start
;
8501 fkey
->map
= fkey
->parent
;
8506 /* Read a sequence of keys that ends with a non prefix character,
8507 storing it in KEYBUF, a buffer of size BUFSIZE.
8509 Return the length of the key sequence stored.
8510 Return -1 if the user rejected a command menu.
8512 Echo starting immediately unless `prompt' is 0.
8514 Where a key sequence ends depends on the currently active keymaps.
8515 These include any minor mode keymaps active in the current buffer,
8516 the current buffer's local map, and the global map.
8518 If a key sequence has no other bindings, we check Vfunction_key_map
8519 to see if some trailing subsequence might be the beginning of a
8520 function key's sequence. If so, we try to read the whole function
8521 key, and substitute its symbolic name into the key sequence.
8523 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8524 `double-' events into similar click events, if that would make them
8525 bound. We try to turn `triple-' events first into `double-' events,
8528 If we get a mouse click in a mode line, vertical divider, or other
8529 non-text area, we treat the click as if it were prefixed by the
8530 symbol denoting that area - `mode-line', `vertical-line', or
8533 If the sequence starts with a mouse click, we read the key sequence
8534 with respect to the buffer clicked on, not the current buffer.
8536 If the user switches frames in the midst of a key sequence, we put
8537 off the switch-frame event until later; the next call to
8538 read_char will return it.
8540 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8541 from the selected window's buffer. */
8544 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8545 can_return_switch_frame
, fix_current_buffer
)
8546 Lisp_Object
*keybuf
;
8549 int dont_downcase_last
;
8550 int can_return_switch_frame
;
8551 int fix_current_buffer
;
8553 volatile Lisp_Object from_string
;
8554 volatile int count
= SPECPDL_INDEX ();
8556 /* How many keys there are in the current key sequence. */
8559 /* The length of the echo buffer when we started reading, and
8560 the length of this_command_keys when we started reading. */
8561 volatile int echo_start
;
8562 volatile int keys_start
;
8564 /* The number of keymaps we're scanning right now, and the number of
8565 keymaps we have allocated space for. */
8567 volatile int nmaps_allocated
= 0;
8569 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8570 the current keymaps. */
8571 Lisp_Object
*volatile defs
= NULL
;
8573 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8574 in the current keymaps, or nil where it is not a prefix. */
8575 Lisp_Object
*volatile submaps
= NULL
;
8577 /* The local map to start out with at start of key sequence. */
8578 volatile Lisp_Object orig_local_map
;
8580 /* The map from the `keymap' property to start out with at start of
8582 volatile Lisp_Object orig_keymap
;
8584 /* 1 if we have already considered switching to the local-map property
8585 of the place where a mouse click occurred. */
8586 volatile int localized_local_map
= 0;
8588 /* The index in defs[] of the first keymap that has a binding for
8589 this key sequence. In other words, the lowest i such that
8590 defs[i] is non-nil. */
8591 volatile int first_binding
;
8592 /* Index of the first key that has no binding.
8593 It is useless to try fkey.start larger than that. */
8594 volatile int first_unbound
;
8596 /* If t < mock_input, then KEYBUF[t] should be read as the next
8599 We use this to recover after recognizing a function key. Once we
8600 realize that a suffix of the current key sequence is actually a
8601 function key's escape sequence, we replace the suffix with the
8602 function key's binding from Vfunction_key_map. Now keybuf
8603 contains a new and different key sequence, so the echo area,
8604 this_command_keys, and the submaps and defs arrays are wrong. In
8605 this situation, we set mock_input to t, set t to 0, and jump to
8606 restart_sequence; the loop will read keys from keybuf up until
8607 mock_input, thus rebuilding the state; and then it will resume
8608 reading characters from the keyboard. */
8609 volatile int mock_input
= 0;
8611 /* If the sequence is unbound in submaps[], then
8612 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8613 and fkey.map is its binding.
8615 These might be > t, indicating that all function key scanning
8616 should hold off until t reaches them. We do this when we've just
8617 recognized a function key, to avoid searching for the function
8618 key's again in Vfunction_key_map. */
8619 volatile keyremap fkey
;
8621 /* Likewise, for key_translation_map. */
8622 volatile keyremap keytran
;
8624 /* If we receive a `switch-frame' or `select-window' event in the middle of
8625 a key sequence, we put it off for later.
8626 While we're reading, we keep the event here. */
8627 volatile Lisp_Object delayed_switch_frame
;
8629 /* See the comment below... */
8630 #if defined (GOBBLE_FIRST_EVENT)
8631 Lisp_Object first_event
;
8634 volatile Lisp_Object original_uppercase
;
8635 volatile int original_uppercase_position
= -1;
8637 /* Gets around Microsoft compiler limitations. */
8640 struct buffer
*starting_buffer
;
8642 /* List of events for which a fake prefix key has been generated. */
8643 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8645 #if defined (GOBBLE_FIRST_EVENT)
8649 struct gcpro gcpro1
;
8651 GCPRO1 (fake_prefixed_keys
);
8652 raw_keybuf_count
= 0;
8654 last_nonmenu_event
= Qnil
;
8656 delayed_switch_frame
= Qnil
;
8657 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8658 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8659 /* If there is no translation-map, turn off scanning. */
8660 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8661 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8666 echo_prompt (prompt
);
8667 else if (cursor_in_echo_area
8668 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8669 && NILP (Fzerop (Vecho_keystrokes
)))
8670 /* This doesn't put in a dash if the echo buffer is empty, so
8671 you don't always see a dash hanging out in the minibuffer. */
8675 /* Record the initial state of the echo area and this_command_keys;
8676 we will need to restore them if we replay a key sequence. */
8678 echo_start
= echo_length ();
8679 keys_start
= this_command_key_count
;
8680 this_single_command_key_start
= keys_start
;
8682 #if defined (GOBBLE_FIRST_EVENT)
8683 /* This doesn't quite work, because some of the things that read_char
8684 does cannot safely be bypassed. It seems too risky to try to make
8687 /* Read the first char of the sequence specially, before setting
8688 up any keymaps, in case a filter runs and switches buffers on us. */
8689 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8691 #endif /* GOBBLE_FIRST_EVENT */
8693 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8694 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8697 /* We jump here when the key sequence has been thoroughly changed, and
8698 we need to rescan it starting from the beginning. When we jump here,
8699 keybuf[0..mock_input] holds the sequence we should reread. */
8702 starting_buffer
= current_buffer
;
8703 first_unbound
= bufsize
+ 1;
8705 /* Build our list of keymaps.
8706 If we recognize a function key and replace its escape sequence in
8707 keybuf with its symbol, or if the sequence starts with a mouse
8708 click and we need to switch buffers, we jump back here to rebuild
8709 the initial keymaps from the current buffer. */
8712 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8713 || !NILP (Voverriding_local_map
))
8715 if (3 > nmaps_allocated
)
8717 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8718 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8719 nmaps_allocated
= 3;
8721 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8722 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8723 if (!NILP (Voverriding_local_map
))
8724 submaps
[nmaps
++] = Voverriding_local_map
;
8732 nminor
= current_minor_maps (0, &maps
);
8733 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8735 if (total
> nmaps_allocated
)
8737 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8738 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8739 nmaps_allocated
= total
;
8742 if (!NILP (orig_keymap
))
8743 submaps
[nmaps
++] = orig_keymap
;
8745 bcopy (maps
, (void *) (submaps
+ nmaps
),
8746 nminor
* sizeof (submaps
[0]));
8750 submaps
[nmaps
++] = orig_local_map
;
8752 submaps
[nmaps
++] = current_global_map
;
8754 /* Find an accurate initial value for first_binding. */
8755 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8756 if (! NILP (submaps
[first_binding
]))
8759 /* Start from the beginning in keybuf. */
8762 /* These are no-ops the first time through, but if we restart, they
8763 revert the echo area and this_command_keys to their original state. */
8764 this_command_key_count
= keys_start
;
8765 if (INTERACTIVE
&& t
< mock_input
)
8766 echo_truncate (echo_start
);
8768 /* If the best binding for the current key sequence is a keymap, or
8769 we may be looking at a function key's escape sequence, keep on
8771 while (first_binding
< nmaps
8772 /* Keep reading as long as there's a prefix binding. */
8773 ? !NILP (submaps
[first_binding
])
8774 /* Don't return in the middle of a possible function key sequence,
8775 if the only bindings we found were via case conversion.
8776 Thus, if ESC O a has a function-key-map translation
8777 and ESC o has a binding, don't return after ESC O,
8778 so that we can translate ESC O plus the next character. */
8779 : (fkey
.start
< t
|| keytran
.start
< t
))
8782 int used_mouse_menu
= 0;
8784 /* Where the last real key started. If we need to throw away a
8785 key that has expanded into more than one element of keybuf
8786 (say, a mouse click on the mode line which is being treated
8787 as [mode-line (mouse-...)], then we backtrack to this point
8789 volatile int last_real_key_start
;
8791 /* These variables are analogous to echo_start and keys_start;
8792 while those allow us to restart the entire key sequence,
8793 echo_local_start and keys_local_start allow us to throw away
8795 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8797 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8798 eassert (fkey
.start
<= fkey
.end
);
8799 eassert (keytran
.start
<= keytran
.end
);
8800 /* key-translation-map is applied *after* function-key-map. */
8801 eassert (keytran
.end
<= fkey
.start
);
8803 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8804 { /* The prefix upto first_unbound has no binding and has
8805 no translation left to do either, so we know it's unbound.
8806 If we don't stop now, we risk staying here indefinitely
8807 (if the user keeps entering fkey or keytran prefixes
8808 like C-c ESC ESC ESC ESC ...) */
8810 for (i
= first_unbound
+ 1; i
< t
; i
++)
8811 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8812 mock_input
= t
- first_unbound
- 1;
8813 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8814 fkey
.map
= fkey
.parent
;
8815 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8816 keytran
.map
= keytran
.parent
;
8817 goto replay_sequence
;
8821 error ("Key sequence too long");
8824 echo_local_start
= echo_length ();
8825 keys_local_start
= this_command_key_count
;
8826 local_first_binding
= first_binding
;
8829 /* These are no-ops, unless we throw away a keystroke below and
8830 jumped back up to replay_key; in that case, these restore the
8831 variables to their original state, allowing us to replay the
8833 if (INTERACTIVE
&& t
< mock_input
)
8834 echo_truncate (echo_local_start
);
8835 this_command_key_count
= keys_local_start
;
8836 first_binding
= local_first_binding
;
8838 /* By default, assume each event is "real". */
8839 last_real_key_start
= t
;
8841 /* Does mock_input indicate that we are re-reading a key sequence? */
8845 add_command_key (key
);
8846 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8847 && NILP (Fzerop (Vecho_keystrokes
)))
8851 /* If not, we should actually read a character. */
8856 KBOARD
*interrupted_kboard
= current_kboard
;
8857 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8858 if (setjmp (wrong_kboard_jmpbuf
))
8860 if (!NILP (delayed_switch_frame
))
8862 interrupted_kboard
->kbd_queue
8863 = Fcons (delayed_switch_frame
,
8864 interrupted_kboard
->kbd_queue
);
8865 delayed_switch_frame
= Qnil
;
8868 interrupted_kboard
->kbd_queue
8869 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8871 /* If the side queue is non-empty, ensure it begins with a
8872 switch-frame, so we'll replay it in the right context. */
8873 if (CONSP (interrupted_kboard
->kbd_queue
)
8874 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8875 !(EVENT_HAS_PARAMETERS (key
)
8876 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8880 XSETFRAME (frame
, interrupted_frame
);
8881 interrupted_kboard
->kbd_queue
8882 = Fcons (make_lispy_switch_frame (frame
),
8883 interrupted_kboard
->kbd_queue
);
8886 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8887 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8888 goto replay_sequence
;
8891 key
= read_char (NILP (prompt
), nmaps
,
8892 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8893 &used_mouse_menu
, NULL
);
8896 /* read_char returns t when it shows a menu and the user rejects it.
8900 unbind_to (count
, Qnil
);
8905 /* read_char returns -1 at the end of a macro.
8906 Emacs 18 handles this by returning immediately with a
8907 zero, so that's what we'll do. */
8908 if (INTEGERP (key
) && XINT (key
) == -1)
8911 /* The Microsoft C compiler can't handle the goto that
8917 /* If the current buffer has been changed from under us, the
8918 keymap may have changed, so replay the sequence. */
8921 timer_resume_idle ();
8924 /* Reset the current buffer from the selected window
8925 in case something changed the former and not the latter.
8926 This is to be more consistent with the behavior
8927 of the command_loop_1. */
8928 if (fix_current_buffer
)
8930 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8932 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8933 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8936 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8937 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8938 goto replay_sequence
;
8941 /* If we have a quit that was typed in another frame, and
8942 quit_throw_to_read_char switched buffers,
8943 replay to get the right keymap. */
8945 && XINT (key
) == quit_char
8946 && current_buffer
!= starting_buffer
)
8949 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8953 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8954 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8955 goto replay_sequence
;
8960 if (EVENT_HAS_PARAMETERS (key
)
8961 /* Either a `switch-frame' or a `select-window' event. */
8962 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8964 /* If we're at the beginning of a key sequence, and the caller
8965 says it's okay, go ahead and return this event. If we're
8966 in the midst of a key sequence, delay it until the end. */
8967 if (t
> 0 || !can_return_switch_frame
)
8969 delayed_switch_frame
= key
;
8975 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8978 /* Clicks in non-text areas get prefixed by the symbol
8979 in their CHAR-ADDRESS field. For example, a click on
8980 the mode line is prefixed by the symbol `mode-line'.
8982 Furthermore, key sequences beginning with mouse clicks
8983 are read using the keymaps of the buffer clicked on, not
8984 the current buffer. So we may have to switch the buffer
8987 When we turn one event into two events, we must make sure
8988 that neither of the two looks like the original--so that,
8989 if we replay the events, they won't be expanded again.
8990 If not for this, such reexpansion could happen either here
8991 or when user programs play with this-command-keys. */
8992 if (EVENT_HAS_PARAMETERS (key
))
8997 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8998 if (EQ (kind
, Qmouse_click
))
9000 Lisp_Object window
, posn
;
9002 window
= POSN_WINDOW (EVENT_START (key
));
9003 posn
= POSN_POSN (EVENT_START (key
));
9006 || (!NILP (fake_prefixed_keys
)
9007 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9009 /* We're looking a second time at an event for which
9010 we generated a fake prefix key. Set
9011 last_real_key_start appropriately. */
9013 last_real_key_start
= t
- 1;
9016 /* Key sequences beginning with mouse clicks are
9017 read using the keymaps in the buffer clicked on,
9018 not the current buffer. If we're at the
9019 beginning of a key sequence, switch buffers. */
9020 if (last_real_key_start
== 0
9022 && BUFFERP (XWINDOW (window
)->buffer
)
9023 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9025 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9029 /* Arrange to go back to the original buffer once we're
9030 done reading the key sequence. Note that we can't
9031 use save_excursion_{save,restore} here, because they
9032 save point as well as the current buffer; we don't
9033 want to save point, because redisplay may change it,
9034 to accommodate a Fset_window_start or something. We
9035 don't want to do this at the top of the function,
9036 because we may get input from a subprocess which
9037 wants to change the selected window and stuff (say,
9039 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9041 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9043 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9044 orig_local_map
= get_local_map (PT
, current_buffer
,
9046 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9047 goto replay_sequence
;
9050 /* For a mouse click, get the local text-property keymap
9051 of the place clicked on, rather than point. */
9052 if (last_real_key_start
== 0
9053 && CONSP (XCDR (key
))
9054 && ! localized_local_map
)
9056 Lisp_Object map_here
, start
, pos
;
9058 localized_local_map
= 1;
9059 start
= EVENT_START (key
);
9061 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9063 pos
= POSN_BUFFER_POSN (start
);
9065 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9067 map_here
= get_local_map (XINT (pos
),
9068 current_buffer
, Qlocal_map
);
9069 if (!EQ (map_here
, orig_local_map
))
9071 orig_local_map
= map_here
;
9075 goto replay_sequence
;
9077 map_here
= get_local_map (XINT (pos
),
9078 current_buffer
, Qkeymap
);
9079 if (!EQ (map_here
, orig_keymap
))
9081 orig_keymap
= map_here
;
9085 goto replay_sequence
;
9091 /* Expand mode-line and scroll-bar events into two events:
9092 use posn as a fake prefix key. */
9094 && (NILP (fake_prefixed_keys
)
9095 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9097 if (t
+ 1 >= bufsize
)
9098 error ("Key sequence too long");
9101 keybuf
[t
+ 1] = key
;
9104 /* Record that a fake prefix key has been generated
9105 for KEY. Don't modify the event; this would
9106 prevent proper action when the event is pushed
9107 back into unread-command-events. */
9108 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9110 /* If on a mode line string with a local keymap,
9111 reconsider the key sequence with that keymap. */
9112 if (string
= POSN_STRING (EVENT_START (key
)),
9113 (CONSP (string
) && STRINGP (XCAR (string
))))
9115 Lisp_Object pos
, map
, map2
;
9117 pos
= XCDR (string
);
9118 string
= XCAR (string
);
9120 && XINT (pos
) < SCHARS (string
))
9122 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9124 orig_local_map
= map
;
9125 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9128 if (!NILP (map
) || !NILP (map2
))
9129 goto replay_sequence
;
9135 else if (NILP (from_string
)
9136 && (string
= POSN_STRING (EVENT_START (key
)),
9137 (CONSP (string
) && STRINGP (XCAR (string
)))))
9139 /* For a click on a string, i.e. overlay string or a
9140 string displayed via the `display' property,
9141 consider `local-map' and `keymap' properties of
9143 Lisp_Object pos
, map
, map2
;
9145 pos
= XCDR (string
);
9146 string
= XCAR (string
);
9148 && XINT (pos
) < SCHARS (string
))
9150 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9152 orig_local_map
= map
;
9153 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9157 if (!NILP (map
) || !NILP (map2
))
9159 from_string
= string
;
9160 goto replay_sequence
;
9165 else if (CONSP (XCDR (key
))
9166 && CONSP (EVENT_START (key
))
9167 && CONSP (XCDR (EVENT_START (key
))))
9171 posn
= POSN_POSN (EVENT_START (key
));
9172 /* Handle menu-bar events:
9173 insert the dummy prefix event `menu-bar'. */
9174 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9176 if (t
+ 1 >= bufsize
)
9177 error ("Key sequence too long");
9181 /* Zap the position in key, so we know that we've
9182 expanded it, and don't try to do so again. */
9183 POSN_SET_POSN (EVENT_START (key
),
9184 Fcons (posn
, Qnil
));
9187 goto replay_sequence
;
9189 else if (CONSP (posn
))
9191 /* We're looking at the second event of a
9192 sequence which we expanded before. Set
9193 last_real_key_start appropriately. */
9194 if (last_real_key_start
== t
&& t
> 0)
9195 last_real_key_start
= t
- 1;
9200 /* We have finally decided that KEY is something we might want
9202 first_binding
= (follow_key (key
,
9203 nmaps
- first_binding
,
9204 submaps
+ first_binding
,
9205 defs
+ first_binding
,
9206 submaps
+ first_binding
)
9209 /* If KEY wasn't bound, we'll try some fallbacks. */
9210 if (first_binding
< nmaps
)
9211 /* This is needed for the following scenario:
9212 event 0: a down-event that gets dropped by calling replay_key.
9213 event 1: some normal prefix like C-h.
9214 After event 0, first_unbound is 0, after event 1 fkey.start
9215 and keytran.start are both 1, so when we see that C-h is bound,
9216 we need to update first_unbound. */
9217 first_unbound
= max (t
+ 1, first_unbound
);
9222 /* Remember the position to put an upper bound on fkey.start. */
9223 first_unbound
= min (t
, first_unbound
);
9225 head
= EVENT_HEAD (key
);
9226 if (help_char_p (head
) && t
> 0)
9228 read_key_sequence_cmd
= Vprefix_help_command
;
9230 last_nonmenu_event
= key
;
9231 /* The Microsoft C compiler can't handle the goto that
9239 Lisp_Object breakdown
;
9242 breakdown
= parse_modifiers (head
);
9243 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9244 /* Attempt to reduce an unbound mouse event to a simpler
9245 event that is bound:
9246 Drags reduce to clicks.
9247 Double-clicks reduce to clicks.
9248 Triple-clicks reduce to double-clicks, then to clicks.
9249 Down-clicks are eliminated.
9250 Double-downs reduce to downs, then are eliminated.
9251 Triple-downs reduce to double-downs, then to downs,
9252 then are eliminated. */
9253 if (modifiers
& (down_modifier
| drag_modifier
9254 | double_modifier
| triple_modifier
))
9256 while (modifiers
& (down_modifier
| drag_modifier
9257 | double_modifier
| triple_modifier
))
9259 Lisp_Object new_head
, new_click
;
9260 if (modifiers
& triple_modifier
)
9261 modifiers
^= (double_modifier
| triple_modifier
);
9262 else if (modifiers
& double_modifier
)
9263 modifiers
&= ~double_modifier
;
9264 else if (modifiers
& drag_modifier
)
9265 modifiers
&= ~drag_modifier
;
9268 /* Dispose of this `down' event by simply jumping
9269 back to replay_key, to get another event.
9271 Note that if this event came from mock input,
9272 then just jumping back to replay_key will just
9273 hand it to us again. So we have to wipe out any
9276 We could delete keybuf[t] and shift everything
9277 after that to the left by one spot, but we'd also
9278 have to fix up any variable that points into
9279 keybuf, and shifting isn't really necessary
9282 Adding prefixes for non-textual mouse clicks
9283 creates two characters of mock input, and both
9284 must be thrown away. If we're only looking at
9285 the prefix now, we can just jump back to
9286 replay_key. On the other hand, if we've already
9287 processed the prefix, and now the actual click
9288 itself is giving us trouble, then we've lost the
9289 state of the keymaps we want to backtrack to, and
9290 we need to replay the whole sequence to rebuild
9293 Beyond that, only function key expansion could
9294 create more than two keys, but that should never
9295 generate mouse events, so it's okay to zero
9296 mock_input in that case too.
9298 FIXME: The above paragraph seems just plain
9299 wrong, if you consider things like
9300 xterm-mouse-mode. -stef
9302 Isn't this just the most wonderful code ever? */
9304 /* If mock_input > t + 1, the above simplification
9305 will actually end up dropping keys on the floor.
9306 This is probably OK for now, but even
9307 if mock_input <= t + 1, we need to adjust fkey
9309 Typical case [header-line down-mouse-N]:
9310 mock_input = 2, t = 1, fkey.end = 1,
9311 last_real_key_start = 0. */
9312 if (fkey
.end
> last_real_key_start
)
9314 fkey
.end
= fkey
.start
9315 = min (last_real_key_start
, fkey
.start
);
9316 fkey
.map
= fkey
.parent
;
9317 if (keytran
.end
> last_real_key_start
)
9319 keytran
.end
= keytran
.start
9320 = min (last_real_key_start
, keytran
.start
);
9321 keytran
.map
= keytran
.parent
;
9324 if (t
== last_real_key_start
)
9331 mock_input
= last_real_key_start
;
9332 goto replay_sequence
;
9337 = apply_modifiers (modifiers
, XCAR (breakdown
));
9339 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9341 /* Look for a binding for this new key. follow_key
9342 promises that it didn't munge submaps the
9343 last time we called it, since key was unbound. */
9345 = (follow_key (new_click
,
9346 nmaps
- local_first_binding
,
9347 submaps
+ local_first_binding
,
9348 defs
+ local_first_binding
,
9349 submaps
+ local_first_binding
)
9350 + local_first_binding
);
9352 /* If that click is bound, go for it. */
9353 if (first_binding
< nmaps
)
9358 /* Otherwise, we'll leave key set to the drag event. */
9365 /* Normally, last_nonmenu_event gets the previous key we read.
9366 But when a mouse popup menu is being used,
9367 we don't update last_nonmenu_event; it continues to hold the mouse
9368 event that preceded the first level of menu. */
9369 if (!used_mouse_menu
)
9370 last_nonmenu_event
= key
;
9372 /* Record what part of this_command_keys is the current key sequence. */
9373 this_single_command_key_start
= this_command_key_count
- t
;
9375 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9376 /* There is a binding and it's not a prefix.
9377 There is thus no function-key in this sequence.
9378 Moving fkey.start is important in this case to allow keytran.start
9379 to go over the sequence before we return (since we keep the
9380 invariant that keytran.end <= fkey.start). */
9383 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9386 /* If the sequence is unbound, see if we can hang a function key
9387 off the end of it. */
9388 /* Continue scan from fkey.end until we find a bound suffix. */
9389 while (fkey
.end
< t
)
9391 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9394 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9395 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9396 max (t
, mock_input
),
9397 /* If there's a binding (i.e.
9398 first_binding >= nmaps) we don't want
9399 to apply this function-key-mapping. */
9400 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9405 mock_input
= diff
+ max (t
, mock_input
);
9406 goto replay_sequence
;
9410 /* Look for this sequence in key-translation-map.
9411 Scan from keytran.end until we find a bound suffix. */
9412 while (keytran
.end
< fkey
.start
)
9414 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9417 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9418 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9423 mock_input
= diff
+ max (t
, mock_input
);
9424 /* Adjust the function-key-map counters. */
9428 goto replay_sequence
;
9432 /* If KEY is not defined in any of the keymaps,
9433 and cannot be part of a function key or translation,
9434 and is an upper case letter
9435 use the corresponding lower-case letter instead. */
9436 if (first_binding
>= nmaps
9437 && fkey
.start
>= t
&& keytran
.start
>= t
9439 && ((((XINT (key
) & 0x3ffff)
9440 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9441 && UPPERCASEP (XINT (key
) & 0x3ffff))
9442 || (XINT (key
) & shift_modifier
)))
9444 Lisp_Object new_key
;
9446 original_uppercase
= key
;
9447 original_uppercase_position
= t
- 1;
9449 if (XINT (key
) & shift_modifier
)
9450 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9452 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9453 | (XINT (key
) & ~0x3ffff)));
9455 /* We have to do this unconditionally, regardless of whether
9456 the lower-case char is defined in the keymaps, because they
9457 might get translated through function-key-map. */
9458 keybuf
[t
- 1] = new_key
;
9459 mock_input
= max (t
, mock_input
);
9461 goto replay_sequence
;
9463 /* If KEY is not defined in any of the keymaps,
9464 and cannot be part of a function key or translation,
9465 and is a shifted function key,
9466 use the corresponding unshifted function key instead. */
9467 if (first_binding
>= nmaps
9468 && fkey
.start
>= t
&& keytran
.start
>= t
9471 Lisp_Object breakdown
;
9474 breakdown
= parse_modifiers (key
);
9475 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9476 if (modifiers
& shift_modifier
)
9478 Lisp_Object new_key
;
9480 original_uppercase
= key
;
9481 original_uppercase_position
= t
- 1;
9483 modifiers
&= ~shift_modifier
;
9484 new_key
= apply_modifiers (modifiers
,
9487 keybuf
[t
- 1] = new_key
;
9488 mock_input
= max (t
, mock_input
);
9489 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9490 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9492 goto replay_sequence
;
9498 read_key_sequence_cmd
= (first_binding
< nmaps
9499 ? defs
[first_binding
]
9502 unread_switch_frame
= delayed_switch_frame
;
9503 unbind_to (count
, Qnil
);
9505 /* Don't downcase the last character if the caller says don't.
9506 Don't downcase it if the result is undefined, either. */
9507 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9509 && t
- 1 == original_uppercase_position
)
9510 keybuf
[t
- 1] = original_uppercase
;
9512 /* Occasionally we fabricate events, perhaps by expanding something
9513 according to function-key-map, or by adding a prefix symbol to a
9514 mouse click in the scroll bar or modeline. In this cases, return
9515 the entire generated key sequence, even if we hit an unbound
9516 prefix or a definition before the end. This means that you will
9517 be able to push back the event properly, and also means that
9518 read-key-sequence will always return a logical unit.
9521 for (; t
< mock_input
; t
++)
9523 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9524 && NILP (Fzerop (Vecho_keystrokes
)))
9525 echo_char (keybuf
[t
]);
9526 add_command_key (keybuf
[t
]);
9535 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9536 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9537 The sequence is sufficient to specify a non-prefix command in the
9538 current local and global maps.
9540 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9541 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9542 as a continuation of the previous key.
9544 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9545 convert the last event to lower case. (Normally any upper case event
9546 is converted to lower case if the original event is undefined and the lower
9547 case equivalent is defined.) A non-nil value is appropriate for reading
9548 a key sequence to be defined.
9550 A C-g typed while in this function is treated like any other character,
9551 and `quit-flag' is not set.
9553 If the key sequence starts with a mouse click, then the sequence is read
9554 using the keymaps of the buffer of the window clicked in, not the buffer
9555 of the selected window as normal.
9557 `read-key-sequence' drops unbound button-down events, since you normally
9558 only care about the click or drag events which follow them. If a drag
9559 or multi-click event is unbound, but the corresponding click event would
9560 be bound, `read-key-sequence' turns the event into a click event at the
9561 drag's starting position. This means that you don't have to distinguish
9562 between click and drag, double, or triple events unless you want to.
9564 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9565 lines separating windows, and scroll bars with imaginary keys
9566 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9568 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9569 function will process a switch-frame event if the user switches frames
9570 before typing anything. If the user switches frames in the middle of a
9571 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9572 is nil, then the event will be put off until after the current key sequence.
9574 `read-key-sequence' checks `function-key-map' for function key
9575 sequences, where they wouldn't conflict with ordinary bindings. See
9576 `function-key-map' for more details.
9578 The optional fifth argument COMMAND-LOOP, if non-nil, means
9579 that this key sequence is being read by something that will
9580 read commands one after another. It should be nil if the caller
9581 will read just one key sequence. */)
9582 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9584 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9585 Lisp_Object can_return_switch_frame
, command_loop
;
9587 Lisp_Object keybuf
[30];
9589 struct gcpro gcpro1
;
9590 int count
= SPECPDL_INDEX ();
9593 CHECK_STRING (prompt
);
9596 specbind (Qinput_method_exit_on_first_char
,
9597 (NILP (command_loop
) ? Qt
: Qnil
));
9598 specbind (Qinput_method_use_echo_area
,
9599 (NILP (command_loop
) ? Qt
: Qnil
));
9601 bzero (keybuf
, sizeof keybuf
);
9603 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9605 if (NILP (continue_echo
))
9607 this_command_key_count
= 0;
9608 this_command_key_count_reset
= 0;
9609 this_single_command_key_start
= 0;
9612 #ifdef HAVE_X_WINDOWS
9613 if (display_hourglass_p
)
9614 cancel_hourglass ();
9617 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9618 prompt
, ! NILP (dont_downcase_last
),
9619 ! NILP (can_return_switch_frame
), 0);
9621 #if 0 /* The following is fine for code reading a key sequence and
9622 then proceeding with a lenghty computation, but it's not good
9623 for code reading keys in a loop, like an input method. */
9624 #ifdef HAVE_X_WINDOWS
9625 if (display_hourglass_p
)
9636 return unbind_to (count
, make_event_array (i
, keybuf
));
9639 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9640 Sread_key_sequence_vector
, 1, 5, 0,
9641 doc
: /* Like `read-key-sequence' but always return a vector. */)
9642 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9644 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9645 Lisp_Object can_return_switch_frame
, command_loop
;
9647 Lisp_Object keybuf
[30];
9649 struct gcpro gcpro1
;
9650 int count
= SPECPDL_INDEX ();
9653 CHECK_STRING (prompt
);
9656 specbind (Qinput_method_exit_on_first_char
,
9657 (NILP (command_loop
) ? Qt
: Qnil
));
9658 specbind (Qinput_method_use_echo_area
,
9659 (NILP (command_loop
) ? Qt
: Qnil
));
9661 bzero (keybuf
, sizeof keybuf
);
9663 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9665 if (NILP (continue_echo
))
9667 this_command_key_count
= 0;
9668 this_command_key_count_reset
= 0;
9669 this_single_command_key_start
= 0;
9672 #ifdef HAVE_X_WINDOWS
9673 if (display_hourglass_p
)
9674 cancel_hourglass ();
9677 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9678 prompt
, ! NILP (dont_downcase_last
),
9679 ! NILP (can_return_switch_frame
), 0);
9681 #ifdef HAVE_X_WINDOWS
9682 if (display_hourglass_p
)
9692 return unbind_to (count
, Fvector (i
, keybuf
));
9695 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9696 doc
: /* Execute CMD as an editor command.
9697 CMD must be a symbol that satisfies the `commandp' predicate.
9698 Optional second arg RECORD-FLAG non-nil
9699 means unconditionally put this command in `command-history'.
9700 Otherwise, that is done only if an arg is read using the minibuffer.
9701 The argument KEYS specifies the value to use instead of (this-command-keys)
9702 when reading the arguments; if it is nil, (this-command-keys) is used.
9703 The argument SPECIAL, if non-nil, means that this command is executing
9704 a special event, so ignore the prefix argument and don't clear it. */)
9705 (cmd
, record_flag
, keys
, special
)
9706 Lisp_Object cmd
, record_flag
, keys
, special
;
9708 register Lisp_Object final
;
9709 register Lisp_Object tem
;
9710 Lisp_Object prefixarg
;
9711 struct backtrace backtrace
;
9712 extern int debug_on_next_call
;
9714 debug_on_next_call
= 0;
9718 prefixarg
= current_kboard
->Vprefix_arg
;
9719 Vcurrent_prefix_arg
= prefixarg
;
9720 current_kboard
->Vprefix_arg
= Qnil
;
9727 tem
= Fget (cmd
, Qdisabled
);
9728 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9730 tem
= Fsymbol_value (Qdisabled_command_function
);
9732 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9738 final
= Findirect_function (cmd
, Qnil
);
9740 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9742 struct gcpro gcpro1
, gcpro2
;
9744 GCPRO2 (cmd
, prefixarg
);
9745 do_autoload (final
, cmd
);
9752 if (STRINGP (final
) || VECTORP (final
))
9754 /* If requested, place the macro in the command history. For
9755 other sorts of commands, call-interactively takes care of
9757 if (!NILP (record_flag
))
9760 = Fcons (Fcons (Qexecute_kbd_macro
,
9761 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9764 /* Don't keep command history around forever. */
9765 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9767 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9769 XSETCDR (tem
, Qnil
);
9773 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9776 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9778 backtrace
.next
= backtrace_list
;
9779 backtrace_list
= &backtrace
;
9780 backtrace
.function
= &Qcall_interactively
;
9781 backtrace
.args
= &cmd
;
9782 backtrace
.nargs
= 1;
9783 backtrace
.evalargs
= 0;
9784 backtrace
.debug_on_exit
= 0;
9786 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9788 backtrace_list
= backtrace
.next
;
9796 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9798 doc
: /* Read function name, then read its arguments and call it.
9800 To pass a numeric argument to the command you are invoking with, specify
9801 the numeric argument to this command.
9803 Noninteractively, the argument PREFIXARG is the prefix argument to
9804 give to the command you invoke, if it asks for an argument. */)
9806 Lisp_Object prefixarg
;
9808 Lisp_Object function
;
9810 int saved_last_point_position
;
9811 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9812 Lisp_Object bindings
, value
;
9813 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9814 #ifdef HAVE_X_WINDOWS
9815 /* The call to Fcompleting_read wil start and cancel the hourglass,
9816 but if the hourglass was already scheduled, this means that no
9817 hourglass will be shown for the actual M-x command itself.
9818 So we restart it if it is already scheduled. Note that checking
9819 hourglass_shown_p is not enough, normally the hourglass is not shown,
9820 just scheduled to be shown. */
9821 int hstarted
= hourglass_started ();
9824 saved_keys
= Fvector (this_command_key_count
,
9825 XVECTOR (this_command_keys
)->contents
);
9826 saved_last_point_position_buffer
= last_point_position_buffer
;
9827 saved_last_point_position
= last_point_position
;
9829 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9831 if (EQ (prefixarg
, Qminus
))
9833 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9834 strcpy (buf
, "C-u ");
9835 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9836 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9837 else if (INTEGERP (prefixarg
))
9838 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9840 /* This isn't strictly correct if execute-extended-command
9841 is bound to anything else. Perhaps it should use
9842 this_command_keys? */
9843 strcat (buf
, "M-x ");
9845 /* Prompt with buf, and then read a string, completing from and
9846 restricting to the set of all defined commands. Don't provide
9847 any initial input. Save the command read on the extended-command
9849 function
= Fcompleting_read (build_string (buf
),
9850 Vobarray
, Qcommandp
,
9851 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9854 #ifdef HAVE_X_WINDOWS
9855 if (hstarted
) start_hourglass ();
9858 if (STRINGP (function
) && SCHARS (function
) == 0)
9859 error ("No command name given");
9861 /* Set this_command_keys to the concatenation of saved_keys and
9862 function, followed by a RET. */
9867 this_command_key_count
= 0;
9868 this_command_key_count_reset
= 0;
9869 this_single_command_key_start
= 0;
9871 keys
= XVECTOR (saved_keys
)->contents
;
9872 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9873 add_command_key (keys
[i
]);
9875 for (i
= 0; i
< SCHARS (function
); i
++)
9876 add_command_key (Faref (function
, make_number (i
)));
9878 add_command_key (make_number ('\015'));
9881 last_point_position
= saved_last_point_position
;
9882 last_point_position_buffer
= saved_last_point_position_buffer
;
9886 function
= Fintern (function
, Qnil
);
9887 current_kboard
->Vprefix_arg
= prefixarg
;
9888 Vthis_command
= function
;
9889 real_this_command
= function
;
9891 /* If enabled, show which key runs this command. */
9892 if (!NILP (Vsuggest_key_bindings
)
9893 && NILP (Vexecuting_kbd_macro
)
9894 && SYMBOLP (function
))
9895 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9901 GCPRO2 (bindings
, value
);
9902 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9904 /* If the command has a key binding, print it now. */
9905 if (!NILP (bindings
)
9906 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9909 /* But first wait, and skip the message if there is input. */
9912 /* If this command displayed something in the echo area;
9913 wait a few seconds, then display our suggestion message. */
9914 if (NILP (echo_area_buffer
[0]))
9915 waited
= sit_for (make_number (0), 0, 2);
9916 else if (NUMBERP (Vsuggest_key_bindings
))
9917 waited
= sit_for (Vminibuffer_message_timeout
, 0, 2);
9919 waited
= sit_for (make_number (2), 0, 2);
9921 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
9923 Lisp_Object binding
;
9925 int message_p
= push_message ();
9926 int count
= SPECPDL_INDEX ();
9928 record_unwind_protect (pop_message_unwind
, Qnil
);
9929 binding
= Fkey_description (bindings
, Qnil
);
9932 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9935 sprintf (newmessage
, "You can run the command `%s' with %s",
9936 SDATA (SYMBOL_NAME (function
)),
9938 message2_nolog (newmessage
,
9939 strlen (newmessage
),
9940 STRING_MULTIBYTE (binding
));
9941 if (NUMBERP (Vsuggest_key_bindings
))
9942 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
9944 waited
= sit_for (make_number (2), 0, 2);
9946 if (!NILP (waited
) && message_p
)
9949 unbind_to (count
, Qnil
);
9953 RETURN_UNGCPRO (value
);
9957 /* Return nonzero if input events are pending. */
9960 detect_input_pending ()
9963 get_input_pending (&input_pending
, 0);
9965 return input_pending
;
9968 /* Return nonzero if input events other than mouse movements are
9972 detect_input_pending_ignore_squeezables ()
9975 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9977 return input_pending
;
9980 /* Return nonzero if input events are pending, and run any pending timers. */
9983 detect_input_pending_run_timers (do_display
)
9986 int old_timers_run
= timers_run
;
9989 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
9991 if (old_timers_run
!= timers_run
&& do_display
)
9993 redisplay_preserve_echo_area (8);
9994 /* The following fixes a bug when using lazy-lock with
9995 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9996 from an idle timer function. The symptom of the bug is that
9997 the cursor sometimes doesn't become visible until the next X
9998 event is processed. --gerd. */
10000 rif
->flush_display (NULL
);
10003 return input_pending
;
10006 /* This is called in some cases before a possible quit.
10007 It cases the next call to detect_input_pending to recompute input_pending.
10008 So calling this function unnecessarily can't do any harm. */
10011 clear_input_pending ()
10016 /* Return nonzero if there are pending requeued events.
10017 This isn't used yet. The hope is to make wait_reading_process_output
10018 call it, and return if it runs Lisp code that unreads something.
10019 The problem is, kbd_buffer_get_event needs to be fixed to know what
10020 to do in that case. It isn't trivial. */
10023 requeued_events_pending_p ()
10025 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10029 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10030 doc
: /* Return t if command input is currently available with no wait.
10031 Actually, the value is nil only if we can be sure that no input is available;
10032 if there is a doubt, the value is t. */)
10035 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
10038 get_input_pending (&input_pending
,
10039 READABLE_EVENTS_DO_TIMERS_NOW
10040 | READABLE_EVENTS_FILTER_EVENTS
);
10041 return input_pending
> 0 ? Qt
: Qnil
;
10044 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10045 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10048 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10051 if (total_keys
< NUM_RECENT_KEYS
)
10052 return Fvector (total_keys
, keys
);
10055 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10056 bcopy (keys
+ recent_keys_index
,
10057 XVECTOR (val
)->contents
,
10058 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10060 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10061 recent_keys_index
* sizeof (Lisp_Object
));
10066 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10067 doc
: /* Return the key sequence that invoked this command.
10068 However, if the command has called `read-key-sequence', it returns
10069 the last key sequence that has been read.
10070 The value is a string or a vector. */)
10073 return make_event_array (this_command_key_count
,
10074 XVECTOR (this_command_keys
)->contents
);
10077 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10078 doc
: /* Return the key sequence that invoked this command, as a vector.
10079 However, if the command has called `read-key-sequence', it returns
10080 the last key sequence that has been read. */)
10083 return Fvector (this_command_key_count
,
10084 XVECTOR (this_command_keys
)->contents
);
10087 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10088 Sthis_single_command_keys
, 0, 0, 0,
10089 doc
: /* Return the key sequence that invoked this command.
10090 More generally, it returns the last key sequence read, either by
10091 the command loop or by `read-key-sequence'.
10092 Unlike `this-command-keys', this function's value
10093 does not include prefix arguments.
10094 The value is always a vector. */)
10097 return Fvector (this_command_key_count
10098 - this_single_command_key_start
,
10099 (XVECTOR (this_command_keys
)->contents
10100 + this_single_command_key_start
));
10103 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10104 Sthis_single_command_raw_keys
, 0, 0, 0,
10105 doc
: /* Return the raw events that were read for this command.
10106 More generally, it returns the last key sequence read, either by
10107 the command loop or by `read-key-sequence'.
10108 Unlike `this-single-command-keys', this function's value
10109 shows the events before all translations (except for input methods).
10110 The value is always a vector. */)
10113 return Fvector (raw_keybuf_count
,
10114 (XVECTOR (raw_keybuf
)->contents
));
10117 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10118 Sreset_this_command_lengths
, 0, 0, 0,
10119 doc
: /* Make the unread events replace the last command and echo.
10120 Used in `universal-argument-other-key'.
10122 `universal-argument-other-key' rereads the event just typed.
10123 It then gets translated through `function-key-map'.
10124 The translated event has to replace the real events,
10125 both in the value of (this-command-keys) and in echoing.
10126 To achieve this, `universal-argument-other-key' calls
10127 `reset-this-command-lengths', which discards the record of reading
10128 these events the first time. */)
10131 this_command_key_count
= before_command_key_count
;
10132 if (this_command_key_count
< this_single_command_key_start
)
10133 this_single_command_key_start
= this_command_key_count
;
10135 echo_truncate (before_command_echo_length
);
10137 /* Cause whatever we put into unread-command-events
10138 to echo as if it were being freshly read from the keyboard. */
10139 this_command_key_count_reset
= 1;
10144 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10145 Sclear_this_command_keys
, 0, 1, 0,
10146 doc
: /* Clear out the vector that `this-command-keys' returns.
10147 Also clear the record of the last 100 events, unless optional arg
10148 KEEP-RECORD is non-nil. */)
10150 Lisp_Object keep_record
;
10154 this_command_key_count
= 0;
10155 this_command_key_count_reset
= 0;
10157 if (NILP (keep_record
))
10159 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10160 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10162 recent_keys_index
= 0;
10167 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10168 doc
: /* Return the current depth in recursive edits. */)
10172 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10176 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10177 "FOpen dribble file: ",
10178 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10179 If FILE is nil, close any open dribble file. */)
10190 file
= Fexpand_file_name (file
, Qnil
);
10191 dribble
= fopen (SDATA (file
), "w");
10193 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10198 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10199 doc
: /* Discard the contents of the terminal input buffer.
10200 Also end any kbd macro being defined. */)
10203 if (!NILP (current_kboard
->defining_kbd_macro
))
10205 /* Discard the last command from the macro. */
10206 Fcancel_kbd_macro_events ();
10210 update_mode_lines
++;
10212 Vunread_command_events
= Qnil
;
10213 unread_command_char
= -1;
10215 discard_tty_input ();
10217 kbd_fetch_ptr
= kbd_store_ptr
;
10223 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10224 doc
: /* Stop Emacs and return to superior process. You can resume later.
10225 If `cannot-suspend' is non-nil, or if the system doesn't support job
10226 control, run a subshell instead.
10228 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10229 to be read as terminal input by Emacs's parent, after suspension.
10231 Before suspending, run the normal hook `suspend-hook'.
10232 After resumption run the normal hook `suspend-resume-hook'.
10234 Some operating systems cannot stop the Emacs process and resume it later.
10235 On such systems, Emacs starts a subshell instead of suspending. */)
10237 Lisp_Object stuffstring
;
10239 int count
= SPECPDL_INDEX ();
10240 int old_height
, old_width
;
10242 struct gcpro gcpro1
;
10244 if (!NILP (stuffstring
))
10245 CHECK_STRING (stuffstring
);
10247 /* Run the functions in suspend-hook. */
10248 if (!NILP (Vrun_hooks
))
10249 call1 (Vrun_hooks
, intern ("suspend-hook"));
10251 GCPRO1 (stuffstring
);
10252 get_frame_size (&old_width
, &old_height
);
10253 reset_sys_modes ();
10254 /* sys_suspend can get an error if it tries to fork a subshell
10255 and the system resources aren't available for that. */
10256 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10258 stuff_buffered_input (stuffstring
);
10259 if (cannot_suspend
)
10263 unbind_to (count
, Qnil
);
10265 /* Check if terminal/window size has changed.
10266 Note that this is not useful when we are running directly
10267 with a window system; but suspend should be disabled in that case. */
10268 get_frame_size (&width
, &height
);
10269 if (width
!= old_width
|| height
!= old_height
)
10270 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10272 /* Run suspend-resume-hook. */
10273 if (!NILP (Vrun_hooks
))
10274 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10280 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10281 Then in any case stuff anything Emacs has read ahead and not used. */
10284 stuff_buffered_input (stuffstring
)
10285 Lisp_Object stuffstring
;
10287 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10288 register unsigned char *p
;
10290 if (STRINGP (stuffstring
))
10292 register int count
;
10294 p
= SDATA (stuffstring
);
10295 count
= SBYTES (stuffstring
);
10296 while (count
-- > 0)
10301 /* Anything we have read ahead, put back for the shell to read. */
10302 /* ?? What should this do when we have multiple keyboards??
10303 Should we ignore anything that was typed in at the "wrong" kboard?
10305 rms: we should stuff everything back into the kboard
10307 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10310 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10311 kbd_fetch_ptr
= kbd_buffer
;
10312 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10313 stuff_char (kbd_fetch_ptr
->code
);
10315 clear_event (kbd_fetch_ptr
);
10319 #endif /* SIGTSTP */
10323 set_waiting_for_input (time_to_clear
)
10324 EMACS_TIME
*time_to_clear
;
10326 input_available_clear_time
= time_to_clear
;
10328 /* Tell interrupt_signal to throw back to read_char, */
10329 waiting_for_input
= 1;
10331 /* If interrupt_signal was called before and buffered a C-g,
10332 make it run again now, to avoid timing error. */
10333 if (!NILP (Vquit_flag
))
10334 quit_throw_to_read_char ();
10338 clear_waiting_for_input ()
10340 /* Tell interrupt_signal not to throw back to read_char, */
10341 waiting_for_input
= 0;
10342 input_available_clear_time
= 0;
10345 /* This routine is called at interrupt level in response to C-g.
10347 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10348 is called from kbd_buffer_store_event, in handling SIGIO or
10351 If `waiting_for_input' is non zero, then unless `echoing' is
10352 nonzero, immediately throw back to read_char.
10354 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10355 eval to throw, when it gets a chance. If quit-flag is already
10356 non-nil, it stops the job right away. */
10359 interrupt_signal (signalnum
) /* If we don't have an argument, */
10360 int signalnum
; /* some compilers complain in signal calls. */
10363 /* Must preserve main program's value of errno. */
10364 int old_errno
= errno
;
10365 struct frame
*sf
= SELECTED_FRAME ();
10367 #if defined (USG) && !defined (POSIX_SIGNALS)
10368 if (!read_socket_hook
&& NILP (Vwindow_system
))
10370 /* USG systems forget handlers when they are used;
10371 must reestablish each time */
10372 signal (SIGINT
, interrupt_signal
);
10373 signal (SIGQUIT
, interrupt_signal
);
10377 SIGNAL_THREAD_CHECK (signalnum
);
10380 if (!NILP (Vquit_flag
)
10381 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10383 /* If SIGINT isn't blocked, don't let us be interrupted by
10384 another SIGINT, it might be harmful due to non-reentrancy
10385 in I/O functions. */
10386 sigblock (sigmask (SIGINT
));
10389 reset_sys_modes ();
10391 #ifdef SIGTSTP /* Support possible in later USG versions */
10393 * On systems which can suspend the current process and return to the original
10394 * shell, this command causes the user to end up back at the shell.
10395 * The "Auto-save" and "Abort" questions are not asked until
10396 * the user elects to return to emacs, at which point he can save the current
10397 * job and either dump core or continue.
10402 if (sys_suspend () == -1)
10404 printf ("Not running as a subprocess;\n");
10405 printf ("you can continue or abort.\n");
10407 #else /* not VMS */
10408 /* Perhaps should really fork an inferior shell?
10409 But that would not provide any way to get back
10410 to the original shell, ever. */
10411 printf ("No support for stopping a process on this operating system;\n");
10412 printf ("you can continue or abort.\n");
10413 #endif /* not VMS */
10414 #endif /* not SIGTSTP */
10416 /* We must remain inside the screen area when the internal terminal
10417 is used. Note that [Enter] is not echoed by dos. */
10420 /* It doesn't work to autosave while GC is in progress;
10421 the code used for auto-saving doesn't cope with the mark bit. */
10422 if (!gc_in_progress
)
10424 printf ("Auto-save? (y or n) ");
10426 if (((c
= getchar ()) & ~040) == 'Y')
10428 Fdo_auto_save (Qt
, Qnil
);
10430 printf ("\r\nAuto-save done");
10431 #else /* not MSDOS */
10432 printf ("Auto-save done\n");
10433 #endif /* not MSDOS */
10435 while (c
!= '\n') c
= getchar ();
10439 /* During GC, it must be safe to reenable quitting again. */
10440 Vinhibit_quit
= Qnil
;
10443 #endif /* not MSDOS */
10444 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10445 printf ("but will instead do a real quit after garbage collection ends\r\n");
10450 printf ("\r\nAbort? (y or n) ");
10451 #else /* not MSDOS */
10453 printf ("Abort (and enter debugger)? (y or n) ");
10454 #else /* not VMS */
10455 printf ("Abort (and dump core)? (y or n) ");
10456 #endif /* not VMS */
10457 #endif /* not MSDOS */
10459 if (((c
= getchar ()) & ~040) == 'Y')
10461 while (c
!= '\n') c
= getchar ();
10463 printf ("\r\nContinuing...\r\n");
10464 #else /* not MSDOS */
10465 printf ("Continuing...\n");
10466 #endif /* not MSDOS */
10473 /* If executing a function that wants to be interrupted out of
10474 and the user has not deferred quitting by binding `inhibit-quit'
10475 then quit right away. */
10476 if (immediate_quit
&& NILP (Vinhibit_quit
))
10478 struct gl_state_s saved
;
10479 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10481 immediate_quit
= 0;
10484 GCPRO4 (saved
.object
, saved
.global_code
,
10485 saved
.current_syntax_table
, saved
.old_prop
);
10486 Fsignal (Qquit
, Qnil
);
10491 /* Else request quit when it's safe */
10495 if (waiting_for_input
&& !echoing
)
10496 quit_throw_to_read_char ();
10501 /* Handle a C-g by making read_char return C-g. */
10504 quit_throw_to_read_char ()
10507 /* Prevent another signal from doing this before we finish. */
10508 clear_waiting_for_input ();
10511 Vunread_command_events
= Qnil
;
10512 unread_command_char
= -1;
10514 #if 0 /* Currently, sit_for is called from read_char without turning
10515 off polling. And that can call set_waiting_for_input.
10516 It seems to be harmless. */
10517 #ifdef POLL_FOR_INPUT
10518 /* May be > 1 if in recursive minibuffer. */
10519 if (poll_suppress_count
== 0)
10523 if (FRAMEP (internal_last_event_frame
)
10524 && !EQ (internal_last_event_frame
, selected_frame
))
10525 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10528 _longjmp (getcjmp
, 1);
10531 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10532 doc
: /* Set mode of reading keyboard input.
10533 First arg INTERRUPT non-nil means use input interrupts;
10534 nil means use CBREAK mode.
10535 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10536 (no effect except in CBREAK mode).
10537 Third arg META t means accept 8-bit input (for a Meta key).
10538 META nil means ignore the top bit, on the assumption it is parity.
10539 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10540 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10541 See also `current-input-mode'. */)
10542 (interrupt
, flow
, meta
, quit
)
10543 Lisp_Object interrupt
, flow
, meta
, quit
;
10546 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10547 error ("set-input-mode: QUIT must be an ASCII character");
10549 #ifdef POLL_FOR_INPUT
10554 /* this causes startup screen to be restored and messes with the mouse */
10555 reset_sys_modes ();
10559 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10560 if (read_socket_hook
)
10562 /* When using X, don't give the user a real choice,
10563 because we haven't implemented the mechanisms to support it. */
10564 #ifdef NO_SOCK_SIGIO
10565 interrupt_input
= 0;
10566 #else /* not NO_SOCK_SIGIO */
10567 interrupt_input
= 1;
10568 #endif /* NO_SOCK_SIGIO */
10571 interrupt_input
= !NILP (interrupt
);
10572 #else /* not SIGIO */
10573 interrupt_input
= 0;
10574 #endif /* not SIGIO */
10576 /* Our VMS input only works by interrupts, as of now. */
10578 interrupt_input
= 1;
10581 flow_control
= !NILP (flow
);
10584 else if (EQ (meta
, Qt
))
10589 /* Don't let this value be out of range. */
10590 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10596 #ifdef POLL_FOR_INPUT
10597 poll_suppress_count
= 1;
10603 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10604 doc
: /* Return information about the way Emacs currently reads keyboard input.
10605 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10606 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10607 nil, Emacs is using CBREAK mode.
10608 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10609 terminal; this does not apply if Emacs uses interrupt-driven input.
10610 META is t if accepting 8-bit input with 8th bit as Meta flag.
10611 META nil means ignoring the top bit, on the assumption it is parity.
10612 META is neither t nor nil if accepting 8-bit input and using
10613 all 8 bits as the character code.
10614 QUIT is the character Emacs currently uses to quit.
10615 The elements of this list correspond to the arguments of
10616 `set-input-mode'. */)
10619 Lisp_Object val
[4];
10621 val
[0] = interrupt_input
? Qt
: Qnil
;
10622 val
[1] = flow_control
? Qt
: Qnil
;
10623 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10624 XSETFASTINT (val
[3], quit_char
);
10626 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10629 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10630 doc
: /* Return position information for pixel coordinates X and Y.
10631 By default, X and Y are relative to text area of the selected window.
10632 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10633 If optional fourth arg WHOLE is non-nil, X is relative to the left
10634 edge of the window.
10636 The return value is similar to a mouse click position:
10637 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10638 IMAGE (DX . DY) (WIDTH . HEIGHT))
10639 The `posn-' functions access elements of such lists. */)
10640 (x
, y
, frame_or_window
, whole
)
10641 Lisp_Object x
, y
, frame_or_window
, whole
;
10646 if (NILP (frame_or_window
))
10647 frame_or_window
= selected_window
;
10649 if (WINDOWP (frame_or_window
))
10653 CHECK_LIVE_WINDOW (frame_or_window
);
10655 w
= XWINDOW (frame_or_window
);
10656 XSETINT (x
, (XINT (x
)
10657 + WINDOW_LEFT_EDGE_X (w
)
10659 ? window_box_left_offset (w
, TEXT_AREA
)
10661 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10662 frame_or_window
= w
->frame
;
10665 CHECK_LIVE_FRAME (frame_or_window
);
10667 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10670 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10671 doc
: /* Return position information for buffer POS in WINDOW.
10672 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10674 Return nil if position is not visible in window. Otherwise,
10675 the return value is similar to that returned by `event-start' for
10676 a mouse click at the upper left corner of the glyph corresponding
10677 to the given buffer position:
10678 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10679 IMAGE (DX . DY) (WIDTH . HEIGHT))
10680 The `posn-' functions access elements of such lists. */)
10682 Lisp_Object pos
, window
;
10687 window
= selected_window
;
10689 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10692 Lisp_Object x
= XCAR (tem
);
10693 Lisp_Object y
= XCAR (XCDR (tem
));
10695 /* Point invisible due to hscrolling? */
10698 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10706 * Set up a new kboard object with reasonable initial values.
10712 kb
->Voverriding_terminal_local_map
= Qnil
;
10713 kb
->Vlast_command
= Qnil
;
10714 kb
->Vreal_last_command
= Qnil
;
10715 kb
->Vprefix_arg
= Qnil
;
10716 kb
->Vlast_prefix_arg
= Qnil
;
10717 kb
->kbd_queue
= Qnil
;
10718 kb
->kbd_queue_has_data
= 0;
10719 kb
->immediate_echo
= 0;
10720 kb
->echo_string
= Qnil
;
10721 kb
->echo_after_prompt
= -1;
10722 kb
->kbd_macro_buffer
= 0;
10723 kb
->kbd_macro_bufsize
= 0;
10724 kb
->defining_kbd_macro
= Qnil
;
10725 kb
->Vlast_kbd_macro
= Qnil
;
10726 kb
->reference_count
= 0;
10727 kb
->Vsystem_key_alist
= Qnil
;
10728 kb
->system_key_syms
= Qnil
;
10729 kb
->Vdefault_minibuffer_frame
= Qnil
;
10733 * Destroy the contents of a kboard object, but not the object itself.
10734 * We use this just before deleting it, or if we're going to initialize
10735 * it a second time.
10741 if (kb
->kbd_macro_buffer
)
10742 xfree (kb
->kbd_macro_buffer
);
10745 #ifdef MULTI_KBOARD
10747 /* Free KB and memory referenced from it. */
10755 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10758 *kbp
= kb
->next_kboard
;
10760 /* Prevent a dangling reference to KB. */
10761 if (kb
== current_kboard
10762 && FRAMEP (selected_frame
)
10763 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10765 current_kboard
= XFRAME (selected_frame
)->kboard
;
10766 if (current_kboard
== kb
)
10774 #endif /* MULTI_KBOARD */
10779 /* This is correct before outermost invocation of the editor loop */
10780 command_loop_level
= -1;
10781 immediate_quit
= 0;
10782 quit_char
= Ctl ('g');
10783 Vunread_command_events
= Qnil
;
10784 unread_command_char
= -1;
10785 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10787 recent_keys_index
= 0;
10788 kbd_fetch_ptr
= kbd_buffer
;
10789 kbd_store_ptr
= kbd_buffer
;
10791 do_mouse_tracking
= Qnil
;
10795 /* This means that command_loop_1 won't try to select anything the first
10797 internal_last_event_frame
= Qnil
;
10798 Vlast_event_frame
= internal_last_event_frame
;
10800 #ifdef MULTI_KBOARD
10801 current_kboard
= initial_kboard
;
10803 wipe_kboard (current_kboard
);
10804 init_kboard (current_kboard
);
10806 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10808 signal (SIGINT
, interrupt_signal
);
10809 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10810 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10811 SIGQUIT and we can't tell which one it will give us. */
10812 signal (SIGQUIT
, interrupt_signal
);
10813 #endif /* HAVE_TERMIO */
10815 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10817 if (!noninteractive
)
10818 signal (SIGIO
, input_available_signal
);
10821 /* Use interrupt input by default, if it works and noninterrupt input
10822 has deficiencies. */
10824 #ifdef INTERRUPT_INPUT
10825 interrupt_input
= 1;
10827 interrupt_input
= 0;
10830 /* Our VMS input only works by interrupts, as of now. */
10832 interrupt_input
= 1;
10838 if (keyboard_init_hook
)
10839 (*keyboard_init_hook
) ();
10841 #ifdef POLL_FOR_INPUT
10842 poll_suppress_count
= 1;
10847 /* This type's only use is in syms_of_keyboard, to initialize the
10848 event header symbols and put properties on them. */
10849 struct event_head
{
10855 struct event_head head_table
[] = {
10856 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10857 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10858 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10859 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10860 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10861 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10862 /* `select-window' should be handled just like `switch-frame'
10863 in read_key_sequence. */
10864 {&Qselect_window
, "select-window", &Qswitch_frame
}
10868 syms_of_keyboard ()
10870 Vpre_help_message
= Qnil
;
10871 staticpro (&Vpre_help_message
);
10873 Vlispy_mouse_stem
= build_string ("mouse");
10874 staticpro (&Vlispy_mouse_stem
);
10877 QCimage
= intern (":image");
10878 staticpro (&QCimage
);
10880 staticpro (&Qhelp_echo
);
10881 Qhelp_echo
= intern ("help-echo");
10883 staticpro (&item_properties
);
10884 item_properties
= Qnil
;
10886 staticpro (&tool_bar_item_properties
);
10887 tool_bar_item_properties
= Qnil
;
10888 staticpro (&tool_bar_items_vector
);
10889 tool_bar_items_vector
= Qnil
;
10891 staticpro (&real_this_command
);
10892 real_this_command
= Qnil
;
10894 Qtimer_event_handler
= intern ("timer-event-handler");
10895 staticpro (&Qtimer_event_handler
);
10897 Qdisabled_command_function
= intern ("disabled-command-function");
10898 staticpro (&Qdisabled_command_function
);
10900 Qself_insert_command
= intern ("self-insert-command");
10901 staticpro (&Qself_insert_command
);
10903 Qforward_char
= intern ("forward-char");
10904 staticpro (&Qforward_char
);
10906 Qbackward_char
= intern ("backward-char");
10907 staticpro (&Qbackward_char
);
10909 Qdisabled
= intern ("disabled");
10910 staticpro (&Qdisabled
);
10912 Qundefined
= intern ("undefined");
10913 staticpro (&Qundefined
);
10915 Qpre_command_hook
= intern ("pre-command-hook");
10916 staticpro (&Qpre_command_hook
);
10918 Qpost_command_hook
= intern ("post-command-hook");
10919 staticpro (&Qpost_command_hook
);
10921 Qdeferred_action_function
= intern ("deferred-action-function");
10922 staticpro (&Qdeferred_action_function
);
10924 Qcommand_hook_internal
= intern ("command-hook-internal");
10925 staticpro (&Qcommand_hook_internal
);
10927 Qfunction_key
= intern ("function-key");
10928 staticpro (&Qfunction_key
);
10929 Qmouse_click
= intern ("mouse-click");
10930 staticpro (&Qmouse_click
);
10931 #if defined (WINDOWSNT) || defined (MAC_OS)
10932 Qlanguage_change
= intern ("language-change");
10933 staticpro (&Qlanguage_change
);
10935 Qdrag_n_drop
= intern ("drag-n-drop");
10936 staticpro (&Qdrag_n_drop
);
10938 Qsave_session
= intern ("save-session");
10939 staticpro (&Qsave_session
);
10942 Qmac_apple_event
= intern ("mac-apple-event");
10943 staticpro (&Qmac_apple_event
);
10946 Qusr1_signal
= intern ("usr1-signal");
10947 staticpro (&Qusr1_signal
);
10948 Qusr2_signal
= intern ("usr2-signal");
10949 staticpro (&Qusr2_signal
);
10951 Qmenu_enable
= intern ("menu-enable");
10952 staticpro (&Qmenu_enable
);
10953 Qmenu_alias
= intern ("menu-alias");
10954 staticpro (&Qmenu_alias
);
10955 QCenable
= intern (":enable");
10956 staticpro (&QCenable
);
10957 QCvisible
= intern (":visible");
10958 staticpro (&QCvisible
);
10959 QChelp
= intern (":help");
10960 staticpro (&QChelp
);
10961 QCfilter
= intern (":filter");
10962 staticpro (&QCfilter
);
10963 QCbutton
= intern (":button");
10964 staticpro (&QCbutton
);
10965 QCkeys
= intern (":keys");
10966 staticpro (&QCkeys
);
10967 QCkey_sequence
= intern (":key-sequence");
10968 staticpro (&QCkey_sequence
);
10969 QCtoggle
= intern (":toggle");
10970 staticpro (&QCtoggle
);
10971 QCradio
= intern (":radio");
10972 staticpro (&QCradio
);
10974 Qmode_line
= intern ("mode-line");
10975 staticpro (&Qmode_line
);
10976 Qvertical_line
= intern ("vertical-line");
10977 staticpro (&Qvertical_line
);
10978 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10979 staticpro (&Qvertical_scroll_bar
);
10980 Qmenu_bar
= intern ("menu-bar");
10981 staticpro (&Qmenu_bar
);
10984 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
10985 staticpro (&Qmouse_fixup_help_message
);
10988 Qabove_handle
= intern ("above-handle");
10989 staticpro (&Qabove_handle
);
10990 Qhandle
= intern ("handle");
10991 staticpro (&Qhandle
);
10992 Qbelow_handle
= intern ("below-handle");
10993 staticpro (&Qbelow_handle
);
10994 Qup
= intern ("up");
10996 Qdown
= intern ("down");
10997 staticpro (&Qdown
);
10998 Qtop
= intern ("top");
11000 Qbottom
= intern ("bottom");
11001 staticpro (&Qbottom
);
11002 Qend_scroll
= intern ("end-scroll");
11003 staticpro (&Qend_scroll
);
11004 Qratio
= intern ("ratio");
11005 staticpro (&Qratio
);
11007 Qevent_kind
= intern ("event-kind");
11008 staticpro (&Qevent_kind
);
11009 Qevent_symbol_elements
= intern ("event-symbol-elements");
11010 staticpro (&Qevent_symbol_elements
);
11011 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11012 staticpro (&Qevent_symbol_element_mask
);
11013 Qmodifier_cache
= intern ("modifier-cache");
11014 staticpro (&Qmodifier_cache
);
11016 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11017 staticpro (&Qrecompute_lucid_menubar
);
11018 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11019 staticpro (&Qactivate_menubar_hook
);
11021 Qpolling_period
= intern ("polling-period");
11022 staticpro (&Qpolling_period
);
11024 Qinput_method_function
= intern ("input-method-function");
11025 staticpro (&Qinput_method_function
);
11027 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11028 staticpro (&Qinput_method_exit_on_first_char
);
11029 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11030 staticpro (&Qinput_method_use_echo_area
);
11032 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11033 Fset (Qinput_method_use_echo_area
, Qnil
);
11035 last_point_position_buffer
= Qnil
;
11036 last_point_position_window
= Qnil
;
11039 struct event_head
*p
;
11041 for (p
= head_table
;
11042 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11045 *p
->var
= intern (p
->name
);
11046 staticpro (p
->var
);
11047 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11048 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11052 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11053 staticpro (&button_down_location
);
11054 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11055 staticpro (&mouse_syms
);
11056 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11057 staticpro (&wheel_syms
);
11061 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11063 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11064 for (i
= 0; i
< len
; i
++)
11065 if (modifier_names
[i
])
11066 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11067 staticpro (&modifier_symbols
);
11070 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11071 staticpro (&recent_keys
);
11073 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11074 staticpro (&this_command_keys
);
11076 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11077 staticpro (&raw_keybuf
);
11079 Qextended_command_history
= intern ("extended-command-history");
11080 Fset (Qextended_command_history
, Qnil
);
11081 staticpro (&Qextended_command_history
);
11083 accent_key_syms
= Qnil
;
11084 staticpro (&accent_key_syms
);
11086 func_key_syms
= Qnil
;
11087 staticpro (&func_key_syms
);
11089 drag_n_drop_syms
= Qnil
;
11090 staticpro (&drag_n_drop_syms
);
11092 unread_switch_frame
= Qnil
;
11093 staticpro (&unread_switch_frame
);
11095 internal_last_event_frame
= Qnil
;
11096 staticpro (&internal_last_event_frame
);
11098 read_key_sequence_cmd
= Qnil
;
11099 staticpro (&read_key_sequence_cmd
);
11101 menu_bar_one_keymap_changed_items
= Qnil
;
11102 staticpro (&menu_bar_one_keymap_changed_items
);
11104 menu_bar_items_vector
= Qnil
;
11105 staticpro (&menu_bar_items_vector
);
11107 defsubr (&Sevent_convert_list
);
11108 defsubr (&Sread_key_sequence
);
11109 defsubr (&Sread_key_sequence_vector
);
11110 defsubr (&Srecursive_edit
);
11112 defsubr (&Strack_mouse
);
11114 defsubr (&Sinput_pending_p
);
11115 defsubr (&Scommand_execute
);
11116 defsubr (&Srecent_keys
);
11117 defsubr (&Sthis_command_keys
);
11118 defsubr (&Sthis_command_keys_vector
);
11119 defsubr (&Sthis_single_command_keys
);
11120 defsubr (&Sthis_single_command_raw_keys
);
11121 defsubr (&Sreset_this_command_lengths
);
11122 defsubr (&Sclear_this_command_keys
);
11123 defsubr (&Ssuspend_emacs
);
11124 defsubr (&Sabort_recursive_edit
);
11125 defsubr (&Sexit_recursive_edit
);
11126 defsubr (&Srecursion_depth
);
11127 defsubr (&Stop_level
);
11128 defsubr (&Sdiscard_input
);
11129 defsubr (&Sopen_dribble_file
);
11130 defsubr (&Sset_input_mode
);
11131 defsubr (&Scurrent_input_mode
);
11132 defsubr (&Sexecute_extended_command
);
11133 defsubr (&Sposn_at_point
);
11134 defsubr (&Sposn_at_x_y
);
11136 DEFVAR_LISP ("last-command-char", &last_command_char
,
11137 doc
: /* Last input event that was part of a command. */);
11139 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11140 doc
: /* Last input event that was part of a command. */);
11142 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11143 doc
: /* Last input event in a command, except for mouse menu events.
11144 Mouse menus give back keys that don't look like mouse events;
11145 this variable holds the actual mouse event that led to the menu,
11146 so that you can determine whether the command was run by mouse or not. */);
11148 DEFVAR_LISP ("last-input-char", &last_input_char
,
11149 doc
: /* Last input event. */);
11151 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11152 doc
: /* Last input event. */);
11154 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11155 doc
: /* List of events to be read as the command input.
11156 These events are processed first, before actual keyboard input. */);
11157 Vunread_command_events
= Qnil
;
11159 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11160 doc
: /* If not -1, an object to be read as next command input event. */);
11162 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11163 doc
: /* List of events to be processed as input by input methods.
11164 These events are processed after `unread-command-events', but
11165 before actual keyboard input. */);
11166 Vunread_post_input_method_events
= Qnil
;
11168 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11169 doc
: /* List of events to be processed as input by input methods.
11170 These events are processed after `unread-command-events', but
11171 before actual keyboard input. */);
11172 Vunread_input_method_events
= Qnil
;
11174 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11175 doc
: /* Meta-prefix character code.
11176 Meta-foo as command input turns into this character followed by foo. */);
11177 XSETINT (meta_prefix_char
, 033);
11179 DEFVAR_KBOARD ("last-command", Vlast_command
,
11180 doc
: /* The last command executed.
11181 Normally a symbol with a function definition, but can be whatever was found
11182 in the keymap, or whatever the variable `this-command' was set to by that
11185 The value `mode-exit' is special; it means that the previous command
11186 read an event that told it to exit, and it did so and unread that event.
11187 In other words, the present command is the event that made the previous
11190 The value `kill-region' is special; it means that the previous command
11191 was a kill command. */);
11193 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11194 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11196 DEFVAR_LISP ("this-command", &Vthis_command
,
11197 doc
: /* The command now being executed.
11198 The command can set this variable; whatever is put here
11199 will be in `last-command' during the following command. */);
11200 Vthis_command
= Qnil
;
11202 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11203 doc
: /* The command bound to the current key sequence before remapping.
11204 It equals `this-command' if the original command was not remapped through
11205 any of the active keymaps. Otherwise, the value of `this-command' is the
11206 result of looking up the original command in the active keymaps. */);
11207 Vthis_original_command
= Qnil
;
11209 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11210 doc
: /* *Number of input events between auto-saves.
11211 Zero means disable autosaving due to number of characters typed. */);
11212 auto_save_interval
= 300;
11214 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11215 doc
: /* *Number of seconds idle time before auto-save.
11216 Zero or nil means disable auto-saving due to idleness.
11217 After auto-saving due to this many seconds of idle time,
11218 Emacs also does a garbage collection if that seems to be warranted. */);
11219 XSETFASTINT (Vauto_save_timeout
, 30);
11221 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11222 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11223 The value may be integer or floating point. */);
11224 Vecho_keystrokes
= make_number (1);
11226 DEFVAR_INT ("polling-period", &polling_period
,
11227 doc
: /* *Interval between polling for input during Lisp execution.
11228 The reason for polling is to make C-g work to stop a running program.
11229 Polling is needed only when using X windows and SIGIO does not work.
11230 Polling is automatically disabled in all other cases. */);
11231 polling_period
= 2;
11233 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11234 doc
: /* *Maximum time between mouse clicks to make a double-click.
11235 Measured in milliseconds. nil means disable double-click recognition;
11236 t means double-clicks have no time limit and are detected
11237 by position only. */);
11238 Vdouble_click_time
= make_number (500);
11240 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11241 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11242 On window-system frames, value is the number of pixels the mouse may have
11243 moved horizontally or vertically between two clicks to make a double-click.
11244 On non window-system frames, value is interpreted in units of 1/8 characters
11247 This variable is also the threshold for motion of the mouse
11248 to count as a drag. */);
11249 double_click_fuzz
= 3;
11251 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11252 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11253 inhibit_local_menu_bar_menus
= 0;
11255 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11256 doc
: /* Number of complete key sequences read as input so far.
11257 This includes key sequences read from keyboard macros.
11258 The number is effectively the number of interactive command invocations. */);
11259 num_input_keys
= 0;
11261 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11262 doc
: /* Number of input events read from the keyboard so far.
11263 This does not include events generated by keyboard macros. */);
11264 num_nonmacro_input_events
= 0;
11266 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11267 doc
: /* The frame in which the most recently read event occurred.
11268 If the last event came from a keyboard macro, this is set to `macro'. */);
11269 Vlast_event_frame
= Qnil
;
11271 /* This variable is set up in sysdep.c. */
11272 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11273 doc
: /* The ERASE character as set by the user with stty. */);
11275 DEFVAR_LISP ("help-char", &Vhelp_char
,
11276 doc
: /* Character to recognize as meaning Help.
11277 When it is read, do `(eval help-form)', and display result if it's a string.
11278 If the value of `help-form' is nil, this char can be read normally. */);
11279 XSETINT (Vhelp_char
, Ctl ('H'));
11281 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11282 doc
: /* List of input events to recognize as meaning Help.
11283 These work just like the value of `help-char' (see that). */);
11284 Vhelp_event_list
= Qnil
;
11286 DEFVAR_LISP ("help-form", &Vhelp_form
,
11287 doc
: /* Form to execute when character `help-char' is read.
11288 If the form returns a string, that string is displayed.
11289 If `help-form' is nil, the help char is not recognized. */);
11292 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11293 doc
: /* Command to run when `help-char' character follows a prefix key.
11294 This command is used only when there is no actual binding
11295 for that character after that prefix key. */);
11296 Vprefix_help_command
= Qnil
;
11298 DEFVAR_LISP ("top-level", &Vtop_level
,
11299 doc
: /* Form to evaluate when Emacs starts up.
11300 Useful to set before you dump a modified Emacs. */);
11303 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11304 doc
: /* Translate table for keyboard input, or nil.
11305 If non-nil, the value should be a char-table. Each character read
11306 from the keyboard is looked up in this char-table. If the value found
11307 there is non-nil, then it is used instead of the actual input character.
11309 The value can also be a string or vector, but this is considered obsolete.
11310 If it is a string or vector of length N, character codes N and up are left
11311 untranslated. In a vector, an element which is nil means "no translation".
11313 This is applied to the characters supplied to input methods, not their
11314 output. See also `translation-table-for-input'. */);
11315 Vkeyboard_translate_table
= Qnil
;
11317 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11318 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11319 \(Even if the operating system has support for stopping a process.\) */);
11320 cannot_suspend
= 0;
11322 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11323 doc
: /* Non-nil means prompt with menus when appropriate.
11324 This is done when reading from a keymap that has a prompt string,
11325 for elements that have prompt strings.
11326 The menu is displayed on the screen
11327 if X menus were enabled at configuration
11328 time and the previous event was a mouse click prefix key.
11329 Otherwise, menu prompting uses the echo area. */);
11330 menu_prompting
= 1;
11332 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11333 doc
: /* Character to see next line of menu prompt.
11334 Type this character while in a menu prompt to rotate around the lines of it. */);
11335 XSETINT (menu_prompt_more_char
, ' ');
11337 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11338 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11339 Emacs applies the modifiers of the character stored here to each keyboard
11340 character it reads. For example, after evaluating the expression
11341 (setq extra-keyboard-modifiers ?\\C-x)
11342 all input characters will have the control modifier applied to them.
11344 Note that the character ?\\C-@, equivalent to the integer zero, does
11345 not count as a control character; rather, it counts as a character
11346 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11347 cancels any modification. */);
11348 extra_keyboard_modifiers
= 0;
11350 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11351 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11352 The command loop sets this to nil before each command,
11353 and tests the value when the command returns.
11354 Buffer modification stores t in this variable. */);
11355 Vdeactivate_mark
= Qnil
;
11357 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11358 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11359 Vcommand_hook_internal
= Qnil
;
11361 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11362 doc
: /* Normal hook run before each command is executed.
11363 If an unhandled error happens in running this hook,
11364 the hook value is set to nil, since otherwise the error
11365 might happen repeatedly and make Emacs nonfunctional. */);
11366 Vpre_command_hook
= Qnil
;
11368 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11369 doc
: /* Normal hook run after each command is executed.
11370 If an unhandled error happens in running this hook,
11371 the hook value is set to nil, since otherwise the error
11372 might happen repeatedly and make Emacs nonfunctional. */);
11373 Vpost_command_hook
= Qnil
;
11376 DEFVAR_LISP ("echo-area-clear-hook", ...,
11377 doc
: /* Normal hook run when clearing the echo area. */);
11379 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11380 staticpro (&Qecho_area_clear_hook
);
11381 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11383 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11384 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11385 Vlucid_menu_bar_dirty_flag
= Qnil
;
11387 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11388 doc
: /* List of menu bar items to move to the end of the menu bar.
11389 The elements of the list are event types that may have menu bar bindings. */);
11390 Vmenu_bar_final_items
= Qnil
;
11392 DEFVAR_KBOARD ("overriding-terminal-local-map",
11393 Voverriding_terminal_local_map
,
11394 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11395 If this variable is non-nil, it is used as a keymap instead of the
11396 buffer's local map, and the minor mode keymaps and text property keymaps.
11397 It also replaces `overriding-local-map'.
11399 This variable is intended to let commands such as `universal-argument'
11400 set up a different keymap for reading the next command. */);
11402 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11403 doc
: /* Keymap that overrides all other local keymaps.
11404 If this variable is non-nil, it is used as a keymap--replacing the
11405 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11406 Voverriding_local_map
= Qnil
;
11408 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11409 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11410 Otherwise, the menu bar continues to reflect the buffer's local map
11411 and the minor mode maps regardless of `overriding-local-map'. */);
11412 Voverriding_local_map_menu_flag
= Qnil
;
11414 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11415 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11416 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11418 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11419 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11421 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11422 doc
: /* Alist of system-specific X windows key symbols.
11423 Each element should have the form (N . SYMBOL) where N is the
11424 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11425 and SYMBOL is its name. */);
11427 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11428 doc
: /* List of deferred actions to be performed at a later time.
11429 The precise format isn't relevant here; we just check whether it is nil. */);
11430 Vdeferred_action_list
= Qnil
;
11432 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11433 doc
: /* Function to call to handle deferred actions, after each command.
11434 This function is called with no arguments after each command
11435 whenever `deferred-action-list' is non-nil. */);
11436 Vdeferred_action_function
= Qnil
;
11438 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11439 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11440 The value can be a length of time to show the message for.
11441 If the value is non-nil and not a number, we wait 2 seconds. */);
11442 Vsuggest_key_bindings
= Qt
;
11444 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11445 doc
: /* List of active absolute time timers in order of increasing time. */);
11446 Vtimer_list
= Qnil
;
11448 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11449 doc
: /* List of active idle-time timers in order of increasing time. */);
11450 Vtimer_idle_list
= Qnil
;
11452 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11453 doc
: /* If non-nil, the function that implements the current input method.
11454 It's called with one argument, a printing character that was just read.
11455 \(That means a character with code 040...0176.)
11456 Typically this function uses `read-event' to read additional events.
11457 When it does so, it should first bind `input-method-function' to nil
11458 so it will not be called recursively.
11460 The function should return a list of zero or more events
11461 to be used as input. If it wants to put back some events
11462 to be reconsidered, separately, by the input method,
11463 it can add them to the beginning of `unread-command-events'.
11465 The input method function can find in `input-method-previous-method'
11466 the previous echo area message.
11468 The input method function should refer to the variables
11469 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11470 for guidance on what to do. */);
11471 Vinput_method_function
= Qnil
;
11473 DEFVAR_LISP ("input-method-previous-message",
11474 &Vinput_method_previous_message
,
11475 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11476 This variable exists because `read-event' clears the echo area
11477 before running the input method. It is nil if there was no message. */);
11478 Vinput_method_previous_message
= Qnil
;
11480 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11481 doc
: /* If non-nil, the function that implements the display of help.
11482 It's called with one argument, the help string to display. */);
11483 Vshow_help_function
= Qnil
;
11485 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11486 doc
: /* If non-nil, suppress point adjustment after executing a command.
11488 After a command is executed, if point is moved into a region that has
11489 special properties (e.g. composition, display), we adjust point to
11490 the boundary of the region. But, when a command sets this variable to
11491 non-nil, we suppress the point adjustment.
11493 This variable is set to nil before reading a command, and is checked
11494 just after executing the command. */);
11495 Vdisable_point_adjustment
= Qnil
;
11497 DEFVAR_LISP ("global-disable-point-adjustment",
11498 &Vglobal_disable_point_adjustment
,
11499 doc
: /* *If non-nil, always suppress point adjustment.
11501 The default value is nil, in which case, point adjustment are
11502 suppressed only after special commands that set
11503 `disable-point-adjustment' (which see) to non-nil. */);
11504 Vglobal_disable_point_adjustment
= Qnil
;
11506 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11507 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11508 If the value is not a number, such messages don't time out. */);
11509 Vminibuffer_message_timeout
= make_number (2);
11511 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11512 doc
: /* If non-nil, any keyboard input throws to this symbol.
11513 The value of that variable is passed to `quit-flag' and later causes a
11514 peculiar kind of quitting. */);
11515 Vthrow_on_input
= Qnil
;
11517 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
11518 doc
: /* If non-nil, function to output error messages.
11519 The arguments are the error data, a list of the form
11520 (SIGNALED-CONDITIONS . SIGNAL-DATA)
11521 such as just as `condition-case' would bind its variable to,
11522 the context (a string which normally goes at the start of the message),
11523 and the Lisp function within which the error was signaled. */);
11524 Vcommand_error_function
= Qnil
;
11526 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11527 &Venable_disabled_menus_and_buttons
,
11528 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11530 Help functions bind this to allow help on disabled menu items
11531 and tool-bar buttons. */);
11532 Venable_disabled_menus_and_buttons
= Qnil
;
11536 keys_of_keyboard ()
11538 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11539 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11540 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11541 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11542 initial_define_key (meta_map
, 'x', "execute-extended-command");
11544 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11545 "handle-delete-frame");
11546 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11547 current-prefix-arg, as is done in `handle-switch-frame'.
11548 But `handle-switch-frame is not run from the special-map.
11549 Commands from that map are run in a special way that automatically
11550 preserves the prefix-arg. Restoring the prefix arg here is not just
11551 redundant but harmful:
11553 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11554 - after the first prompt, the exit-minibuffer-hook is run which may
11555 iconify a frame and thus push a `iconify-frame' event.
11556 - after running exit-minibuffer-hook, current-prefix-arg is
11557 restored to the non-nil value it had before the prompt.
11558 - we enter the second prompt.
11559 current-prefix-arg is non-nil, prefix-arg is nil.
11560 - before running the first real event, we run the special iconify-frame
11561 event, but we pass the `special' arg to execute-command so
11562 current-prefix-arg and prefix-arg are left untouched.
11563 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11564 - the next key event will have a spuriously non-nil current-prefix-arg. */
11565 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11567 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11569 /* Handling it at such a low-level causes read_key_sequence to get
11570 * confused because it doesn't realize that the current_buffer was
11571 * changed by read_char.
11573 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11574 * "handle-select-window"); */
11575 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11576 "handle-save-session");
11579 /* Mark the pointers in the kboard objects.
11580 Called by the Fgarbage_collector. */
11586 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11588 if (kb
->kbd_macro_buffer
)
11589 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11591 mark_object (kb
->Voverriding_terminal_local_map
);
11592 mark_object (kb
->Vlast_command
);
11593 mark_object (kb
->Vreal_last_command
);
11594 mark_object (kb
->Vprefix_arg
);
11595 mark_object (kb
->Vlast_prefix_arg
);
11596 mark_object (kb
->kbd_queue
);
11597 mark_object (kb
->defining_kbd_macro
);
11598 mark_object (kb
->Vlast_kbd_macro
);
11599 mark_object (kb
->Vsystem_key_alist
);
11600 mark_object (kb
->system_key_syms
);
11601 mark_object (kb
->Vdefault_minibuffer_frame
);
11602 mark_object (kb
->echo_string
);
11605 struct input_event
*event
;
11606 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11608 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11609 event
= kbd_buffer
;
11610 if (event
->kind
!= SELECTION_REQUEST_EVENT
11611 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11613 mark_object (event
->x
);
11614 mark_object (event
->y
);
11616 mark_object (event
->frame_or_window
);
11617 mark_object (event
->arg
);
11622 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11623 (do not change this comment) */