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 return call1 (Vrun_hooks
, Vinhibit_quit
);
2038 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2041 safe_run_hooks_error (data
)
2044 Lisp_Object args
[3];
2045 args
[0] = build_string ("Error in %s: %s");
2046 args
[1] = Vinhibit_quit
;
2049 return Fset (Vinhibit_quit
, Qnil
);
2052 /* If we get an error while running the hook, cause the hook variable
2053 to be nil. Also inhibit quits, so that C-g won't cause the hook
2054 to mysteriously evaporate. */
2057 safe_run_hooks (hook
)
2060 int count
= SPECPDL_INDEX ();
2061 specbind (Qinhibit_quit
, hook
);
2063 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2065 unbind_to (count
, Qnil
);
2069 /* Number of seconds between polling for input. This is a Lisp
2070 variable that can be bound. */
2072 EMACS_INT polling_period
;
2074 /* Nonzero means polling for input is temporarily suppressed. */
2076 int poll_suppress_count
;
2078 /* Asynchronous timer for polling. */
2080 struct atimer
*poll_timer
;
2083 #ifdef POLL_FOR_INPUT
2085 /* Poll for input, so what we catch a C-g if it comes in. This
2086 function is called from x_make_frame_visible, see comment
2092 if (interrupt_input_blocked
== 0
2093 && !waiting_for_input
)
2094 read_avail_input (0);
2097 /* Timer callback function for poll_timer. TIMER is equal to
2101 poll_for_input (timer
)
2102 struct atimer
*timer
;
2104 if (poll_suppress_count
== 0)
2106 interrupt_input_pending
= 1;
2108 poll_for_input_1 ();
2112 #endif /* POLL_FOR_INPUT */
2114 /* Begin signals to poll for input, if they are appropriate.
2115 This function is called unconditionally from various places. */
2120 #ifdef POLL_FOR_INPUT
2121 if (read_socket_hook
&& !interrupt_input
)
2123 /* Turn alarm handling on unconditionally. It might have
2124 been turned off in process.c. */
2125 turn_on_atimers (1);
2127 /* If poll timer doesn't exist, are we need one with
2128 a different interval, start a new one. */
2129 if (poll_timer
== NULL
2130 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2132 EMACS_TIME interval
;
2135 cancel_atimer (poll_timer
);
2137 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2138 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2139 poll_for_input
, NULL
);
2142 /* Let the timer's callback function poll for input
2143 if this becomes zero. */
2144 --poll_suppress_count
;
2149 /* Nonzero if we are using polling to handle input asynchronously. */
2152 input_polling_used ()
2154 #ifdef POLL_FOR_INPUT
2155 return read_socket_hook
&& !interrupt_input
;
2161 /* Turn off polling. */
2166 #ifdef POLL_FOR_INPUT
2167 if (read_socket_hook
&& !interrupt_input
)
2168 ++poll_suppress_count
;
2172 /* Set the value of poll_suppress_count to COUNT
2173 and start or stop polling accordingly. */
2176 set_poll_suppress_count (count
)
2179 #ifdef POLL_FOR_INPUT
2180 if (count
== 0 && poll_suppress_count
!= 0)
2182 poll_suppress_count
= 1;
2185 else if (count
!= 0 && poll_suppress_count
== 0)
2189 poll_suppress_count
= count
;
2193 /* Bind polling_period to a value at least N.
2194 But don't decrease it. */
2197 bind_polling_period (n
)
2200 #ifdef POLL_FOR_INPUT
2201 int new = polling_period
;
2206 stop_other_atimers (poll_timer
);
2208 specbind (Qpolling_period
, make_number (new));
2209 /* Start a new alarm with the new period. */
2214 /* Apply the control modifier to CHARACTER. */
2220 /* Save the upper bits here. */
2221 int upper
= c
& ~0177;
2225 /* Everything in the columns containing the upper-case letters
2226 denotes a control character. */
2227 if (c
>= 0100 && c
< 0140)
2231 /* Set the shift modifier for a control char
2232 made from a shifted letter. But only for letters! */
2233 if (oc
>= 'A' && oc
<= 'Z')
2234 c
|= shift_modifier
;
2237 /* The lower-case letters denote control characters too. */
2238 else if (c
>= 'a' && c
<= 'z')
2241 /* Include the bits for control and shift
2242 only if the basic ASCII code can't indicate them. */
2246 /* Replace the high bits. */
2247 c
|= (upper
& ~ctrl_modifier
);
2252 /* Display the help-echo property of the character after the mouse pointer.
2253 Either show it in the echo area, or call show-help-function to display
2254 it by other means (maybe in a tooltip).
2256 If HELP is nil, that means clear the previous help echo.
2258 If HELP is a string, display that string. If HELP is a function,
2259 call it with OBJECT and POS as arguments; the function should
2260 return a help string or nil for none. For all other types of HELP,
2261 evaluate it to obtain a string.
2263 WINDOW is the window in which the help was generated, if any.
2264 It is nil if not in a window.
2266 If OBJECT is a buffer, POS is the position in the buffer where the
2267 `help-echo' text property was found.
2269 If OBJECT is an overlay, that overlay has a `help-echo' property,
2270 and POS is the position in the overlay's buffer under the mouse.
2272 If OBJECT is a string (an overlay string or a string displayed with
2273 the `display' property). POS is the position in that string under
2276 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2277 echo overwrites a keystroke echo currently displayed in the echo
2280 Note: this function may only be called with HELP nil or a string
2281 from X code running asynchronously. */
2284 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2285 Lisp_Object help
, window
, object
, pos
;
2286 int ok_to_overwrite_keystroke_echo
;
2288 if (!NILP (help
) && !STRINGP (help
))
2290 if (FUNCTIONP (help
))
2292 Lisp_Object args
[4];
2297 help
= safe_call (4, args
);
2300 help
= safe_eval (help
);
2302 if (!STRINGP (help
))
2307 if (!noninteractive
&& STRINGP (help
))
2308 help
= call1 (Qmouse_fixup_help_message
, help
);
2311 if (STRINGP (help
) || NILP (help
))
2313 if (!NILP (Vshow_help_function
))
2314 call1 (Vshow_help_function
, help
);
2315 else if (/* Don't overwrite minibuffer contents. */
2316 !MINI_WINDOW_P (XWINDOW (selected_window
))
2317 /* Don't overwrite a keystroke echo. */
2318 && (NILP (echo_message_buffer
)
2319 || ok_to_overwrite_keystroke_echo
)
2320 /* Don't overwrite a prompt. */
2321 && !cursor_in_echo_area
)
2325 int count
= SPECPDL_INDEX ();
2327 if (!help_echo_showing_p
)
2328 Vpre_help_message
= current_message ();
2330 specbind (Qmessage_truncate_lines
, Qt
);
2331 message3_nolog (help
, SBYTES (help
),
2332 STRING_MULTIBYTE (help
));
2333 unbind_to (count
, Qnil
);
2335 else if (STRINGP (Vpre_help_message
))
2337 message3_nolog (Vpre_help_message
,
2338 SBYTES (Vpre_help_message
),
2339 STRING_MULTIBYTE (Vpre_help_message
));
2340 Vpre_help_message
= Qnil
;
2346 help_echo_showing_p
= STRINGP (help
);
2352 /* Input of single characters from keyboard */
2354 Lisp_Object
print_help ();
2355 static Lisp_Object
kbd_buffer_get_event ();
2356 static void record_char ();
2359 static jmp_buf wrong_kboard_jmpbuf
;
2362 #define STOP_POLLING \
2363 do { if (! polling_stopped_here) stop_polling (); \
2364 polling_stopped_here = 1; } while (0)
2366 #define RESUME_POLLING \
2367 do { if (polling_stopped_here) start_polling (); \
2368 polling_stopped_here = 0; } while (0)
2370 /* read a character from the keyboard; call the redisplay if needed */
2371 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2372 -1 means do not do redisplay, but do do autosaving.
2375 /* The arguments MAPS and NMAPS are for menu prompting.
2376 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2378 PREV_EVENT is the previous input event, or nil if we are reading
2379 the first event of a key sequence (or not reading a key sequence).
2380 If PREV_EVENT is t, that is a "magic" value that says
2381 not to run input methods, but in other respects to act as if
2382 not reading a key sequence.
2384 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2385 if we used a mouse menu to read the input, or zero otherwise. If
2386 USED_MOUSE_MENU is null, we don't dereference it.
2388 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2389 specifying the maximum time to wait until. If no input arrives by
2390 that time, stop waiting and return nil.
2392 Value is t if we showed a menu and the user rejected it. */
2395 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2399 Lisp_Object prev_event
;
2400 int *used_mouse_menu
;
2401 EMACS_TIME
*end_time
;
2403 volatile Lisp_Object c
;
2405 jmp_buf local_getcjmp
;
2407 volatile int key_already_recorded
= 0;
2408 Lisp_Object tem
, save
;
2409 volatile Lisp_Object previous_echo_area_message
;
2410 volatile Lisp_Object also_record
;
2411 volatile int reread
;
2412 struct gcpro gcpro1
, gcpro2
;
2413 int polling_stopped_here
= 0;
2417 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2418 before_command_key_count
= this_command_key_count
;
2419 before_command_echo_length
= echo_length ();
2422 previous_echo_area_message
= Qnil
;
2424 GCPRO2 (c
, previous_echo_area_message
);
2429 if (CONSP (Vunread_post_input_method_events
))
2431 c
= XCAR (Vunread_post_input_method_events
);
2432 Vunread_post_input_method_events
2433 = XCDR (Vunread_post_input_method_events
);
2435 /* Undo what read_char_x_menu_prompt did when it unread
2436 additional keys returned by Fx_popup_menu. */
2438 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2446 if (unread_command_char
!= -1)
2448 XSETINT (c
, unread_command_char
);
2449 unread_command_char
= -1;
2455 if (CONSP (Vunread_command_events
))
2457 c
= XCAR (Vunread_command_events
);
2458 Vunread_command_events
= XCDR (Vunread_command_events
);
2460 /* Undo what read_char_x_menu_prompt did when it unread
2461 additional keys returned by Fx_popup_menu. */
2463 && EQ (XCDR (c
), Qdisabled
)
2464 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2467 /* If the queued event is something that used the mouse,
2468 set used_mouse_menu accordingly. */
2470 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2471 *used_mouse_menu
= 1;
2474 goto reread_for_input_method
;
2477 if (CONSP (Vunread_input_method_events
))
2479 c
= XCAR (Vunread_input_method_events
);
2480 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2482 /* Undo what read_char_x_menu_prompt did when it unread
2483 additional keys returned by Fx_popup_menu. */
2485 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2489 goto reread_for_input_method
;
2492 this_command_key_count_reset
= 0;
2494 if (!NILP (Vexecuting_kbd_macro
))
2496 /* We set this to Qmacro; since that's not a frame, nobody will
2497 try to switch frames on us, and the selected window will
2500 Since this event came from a macro, it would be misleading to
2501 leave internal_last_event_frame set to wherever the last
2502 real event came from. Normally, a switch-frame event selects
2503 internal_last_event_frame after each command is read, but
2504 events read from a macro should never cause a new frame to be
2506 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2508 /* Exit the macro if we are at the end.
2509 Also, some things replace the macro with t
2510 to force an early exit. */
2511 if (EQ (Vexecuting_kbd_macro
, Qt
)
2512 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2518 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2519 if (STRINGP (Vexecuting_kbd_macro
)
2520 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2521 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2523 executing_kbd_macro_index
++;
2528 if (!NILP (unread_switch_frame
))
2530 c
= unread_switch_frame
;
2531 unread_switch_frame
= Qnil
;
2533 /* This event should make it into this_command_keys, and get echoed
2534 again, so we do not set `reread'. */
2538 /* if redisplay was requested */
2539 if (commandflag
>= 0)
2541 /* If there is pending input, process any events which are not
2542 user-visible, such as X selection_request events. */
2544 || detect_input_pending_run_timers (0))
2545 swallow_events (0); /* may clear input_pending */
2547 /* Redisplay if no pending input. */
2548 while (!input_pending
)
2550 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2551 redisplay_preserve_echo_area (5);
2556 /* Normal case: no input arrived during redisplay. */
2559 /* Input arrived and pre-empted redisplay.
2560 Process any events which are not user-visible. */
2562 /* If that cleared input_pending, try again to redisplay. */
2566 /* Message turns off echoing unless more keystrokes turn it on again.
2568 The code in 20.x for the condition was
2570 1. echo_area_glyphs && *echo_area_glyphs
2571 2. && echo_area_glyphs != current_kboard->echobuf
2572 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2574 (1) means there's a current message displayed
2576 (2) means it's not the message from echoing from the current
2579 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2580 is set to a non-null value. This is done in read_char and it is
2581 set to echo_area_glyphs after a call to echo_char. That means
2582 ok_to_echo_at_next_pause is either null or
2583 current_kboard->echobuf with the appropriate current_kboard at
2586 So, condition (3) means in clear text ok_to_echo_at_next_pause
2587 must be either null, or the current message isn't from echoing at
2588 all, or it's from echoing from a different kboard than the
2591 if (/* There currently is something in the echo area. */
2592 !NILP (echo_area_buffer
[0])
2593 && (/* And it's either not from echoing. */
2594 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2595 /* Or it's an echo from a different kboard. */
2596 || echo_kboard
!= current_kboard
2597 /* Or we explicitly allow overwriting whatever there is. */
2598 || ok_to_echo_at_next_pause
== NULL
))
2603 /* Try reading a character via menu prompting in the minibuf.
2604 Try this before the sit-for, because the sit-for
2605 would do the wrong thing if we are supposed to do
2606 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2607 after a mouse event so don't try a minibuf menu. */
2609 if (nmaps
> 0 && INTERACTIVE
2610 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2611 /* Don't bring up a menu if we already have another event. */
2612 && NILP (Vunread_command_events
)
2613 && unread_command_char
< 0
2614 && !detect_input_pending_run_timers (0))
2616 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2619 key_already_recorded
= 1;
2624 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2625 We will do that below, temporarily for short sections of code,
2626 when appropriate. local_getcjmp must be in effect
2627 around any call to sit_for or kbd_buffer_get_event;
2628 it *must not* be in effect when we call redisplay. */
2630 if (_setjmp (local_getcjmp
))
2632 /* We must have saved the outer value of getcjmp here,
2633 so restore it now. */
2634 restore_getcjmp (save_jump
);
2635 XSETINT (c
, quit_char
);
2636 internal_last_event_frame
= selected_frame
;
2637 Vlast_event_frame
= internal_last_event_frame
;
2638 /* If we report the quit char as an event,
2639 don't do so more than once. */
2640 if (!NILP (Vinhibit_quit
))
2645 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2646 if (kb
!= current_kboard
)
2648 Lisp_Object link
= kb
->kbd_queue
;
2649 /* We shouldn't get here if we were in single-kboard mode! */
2654 while (CONSP (XCDR (link
)))
2656 if (!NILP (XCDR (link
)))
2660 kb
->kbd_queue
= Fcons (c
, Qnil
);
2662 XSETCDR (link
, Fcons (c
, Qnil
));
2663 kb
->kbd_queue_has_data
= 1;
2664 current_kboard
= kb
;
2665 /* This is going to exit from read_char
2666 so we had better get rid of this frame's stuff. */
2668 longjmp (wrong_kboard_jmpbuf
, 1);
2675 timer_start_idle ();
2677 /* If in middle of key sequence and minibuffer not active,
2678 start echoing if enough time elapses. */
2680 if (minibuf_level
== 0
2682 && !current_kboard
->immediate_echo
2683 && this_command_key_count
> 0
2685 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2686 && NILP (Fzerop (Vecho_keystrokes
))
2687 && (/* No message. */
2688 NILP (echo_area_buffer
[0])
2689 /* Or empty message. */
2690 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2691 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2692 /* Or already echoing from same kboard. */
2693 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2694 /* Or not echoing before and echoing allowed. */
2695 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2697 /* After a mouse event, start echoing right away.
2698 This is because we are probably about to display a menu,
2699 and we don't want to delay before doing so. */
2700 if (EVENT_HAS_PARAMETERS (prev_event
))
2706 save_getcjmp (save_jump
);
2707 restore_getcjmp (local_getcjmp
);
2708 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2709 restore_getcjmp (save_jump
);
2711 && ! CONSP (Vunread_command_events
))
2716 /* Maybe auto save due to number of keystrokes. */
2718 if (commandflag
!= 0
2719 && auto_save_interval
> 0
2720 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2721 && !detect_input_pending_run_timers (0))
2723 Fdo_auto_save (Qnil
, Qnil
);
2724 /* Hooks can actually change some buffers in auto save. */
2728 /* Try reading using an X menu.
2729 This is never confused with reading using the minibuf
2730 because the recursive call of read_char in read_char_minibuf_menu_prompt
2731 does not pass on any keymaps. */
2733 if (nmaps
> 0 && INTERACTIVE
2734 && !NILP (prev_event
)
2735 && EVENT_HAS_PARAMETERS (prev_event
)
2736 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2737 && !EQ (XCAR (prev_event
), Qtool_bar
)
2738 /* Don't bring up a menu if we already have another event. */
2739 && NILP (Vunread_command_events
)
2740 && unread_command_char
< 0)
2742 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2744 /* Now that we have read an event, Emacs is not idle. */
2750 /* Maybe autosave and/or garbage collect due to idleness. */
2752 if (INTERACTIVE
&& NILP (c
))
2754 int delay_level
, buffer_size
;
2756 /* Slow down auto saves logarithmically in size of current buffer,
2757 and garbage collect while we're at it. */
2758 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2759 last_non_minibuf_size
= Z
- BEG
;
2760 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2762 while (buffer_size
> 64)
2763 delay_level
++, buffer_size
-= buffer_size
>> 2;
2764 if (delay_level
< 4) delay_level
= 4;
2765 /* delay_level is 4 for files under around 50k, 7 at 100k,
2766 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2768 /* Auto save if enough time goes by without input. */
2769 if (commandflag
!= 0
2770 && num_nonmacro_input_events
> last_auto_save
2771 && INTEGERP (Vauto_save_timeout
)
2772 && XINT (Vauto_save_timeout
) > 0)
2775 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2777 save_getcjmp (save_jump
);
2778 restore_getcjmp (local_getcjmp
);
2779 tem0
= sit_for (make_number (timeout
), 1, 1);
2780 restore_getcjmp (save_jump
);
2783 && ! CONSP (Vunread_command_events
))
2785 Fdo_auto_save (Qnil
, Qnil
);
2787 /* If we have auto-saved and there is still no input
2788 available, garbage collect if there has been enough
2789 consing going on to make it worthwhile. */
2790 if (!detect_input_pending_run_timers (0)
2791 && consing_since_gc
> gc_cons_threshold
/ 2)
2792 Fgarbage_collect ();
2799 /* If this has become non-nil here, it has been set by a timer
2800 or sentinel or filter. */
2801 if (CONSP (Vunread_command_events
))
2803 c
= XCAR (Vunread_command_events
);
2804 Vunread_command_events
= XCDR (Vunread_command_events
);
2807 /* Read something from current KBOARD's side queue, if possible. */
2811 if (current_kboard
->kbd_queue_has_data
)
2813 if (!CONSP (current_kboard
->kbd_queue
))
2815 c
= XCAR (current_kboard
->kbd_queue
);
2816 current_kboard
->kbd_queue
2817 = XCDR (current_kboard
->kbd_queue
);
2818 if (NILP (current_kboard
->kbd_queue
))
2819 current_kboard
->kbd_queue_has_data
= 0;
2820 input_pending
= readable_events (0);
2821 if (EVENT_HAS_PARAMETERS (c
)
2822 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2823 internal_last_event_frame
= XCAR (XCDR (c
));
2824 Vlast_event_frame
= internal_last_event_frame
;
2829 /* If current_kboard's side queue is empty check the other kboards.
2830 If one of them has data that we have not yet seen here,
2831 switch to it and process the data waiting for it.
2833 Note: if the events queued up for another kboard
2834 have already been seen here, and therefore are not a complete command,
2835 the kbd_queue_has_data field is 0, so we skip that kboard here.
2836 That's to avoid an infinite loop switching between kboards here. */
2837 if (NILP (c
) && !single_kboard
)
2840 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2841 if (kb
->kbd_queue_has_data
)
2843 current_kboard
= kb
;
2844 /* This is going to exit from read_char
2845 so we had better get rid of this frame's stuff. */
2847 longjmp (wrong_kboard_jmpbuf
, 1);
2856 /* Finally, we read from the main queue,
2857 and if that gives us something we can't use yet, we put it on the
2858 appropriate side queue and try again. */
2867 EMACS_GET_TIME (now
);
2868 if (EMACS_TIME_GE (now
, *end_time
))
2872 /* Actually read a character, waiting if necessary. */
2873 save_getcjmp (save_jump
);
2874 restore_getcjmp (local_getcjmp
);
2875 timer_start_idle ();
2876 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2877 restore_getcjmp (save_jump
);
2880 if (! NILP (c
) && (kb
!= current_kboard
))
2882 Lisp_Object link
= kb
->kbd_queue
;
2885 while (CONSP (XCDR (link
)))
2887 if (!NILP (XCDR (link
)))
2891 kb
->kbd_queue
= Fcons (c
, Qnil
);
2893 XSETCDR (link
, Fcons (c
, Qnil
));
2894 kb
->kbd_queue_has_data
= 1;
2898 current_kboard
= kb
;
2899 /* This is going to exit from read_char
2900 so we had better get rid of this frame's stuff. */
2902 longjmp (wrong_kboard_jmpbuf
, 1);
2907 /* Terminate Emacs in batch mode if at eof. */
2908 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2909 Fkill_emacs (make_number (1));
2913 /* Add in any extra modifiers, where appropriate. */
2914 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2915 || ((extra_keyboard_modifiers
& 0177) < ' '
2916 && (extra_keyboard_modifiers
& 0177) != 0))
2917 XSETINT (c
, make_ctrl_char (XINT (c
)));
2919 /* Transfer any other modifier bits directly from
2920 extra_keyboard_modifiers to c. Ignore the actual character code
2921 in the low 16 bits of extra_keyboard_modifiers. */
2922 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2932 if (commandflag
>= 0
2933 && !input_pending
&& !detect_input_pending_run_timers (0))
2941 /* Buffer switch events are only for internal wakeups
2942 so don't show them to the user.
2943 Also, don't record a key if we already did. */
2944 if (BUFFERP (c
) || key_already_recorded
)
2947 /* Process special events within read_char
2948 and loop around to read another event. */
2951 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2956 int was_locked
= single_kboard
;
2958 last_input_char
= c
;
2959 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2961 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2962 /* We stopped being idle for this event; undo that. This
2963 prevents automatic window selection (under
2964 mouse_autoselect_window from acting as a real input event, for
2965 example banishing the mouse under mouse-avoidance-mode. */
2966 timer_resume_idle ();
2968 /* Resume allowing input from any kboard, if that was true before. */
2970 any_kboard_state ();
2975 /* Handle things that only apply to characters. */
2978 /* If kbd_buffer_get_event gave us an EOF, return that. */
2982 if ((STRINGP (Vkeyboard_translate_table
)
2983 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2984 || (VECTORP (Vkeyboard_translate_table
)
2985 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2986 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2987 && CHAR_VALID_P (XINT (c
), 0)))
2990 d
= Faref (Vkeyboard_translate_table
, c
);
2991 /* nil in keyboard-translate-table means no translation. */
2997 /* If this event is a mouse click in the menu bar,
2998 return just menu-bar for now. Modify the mouse click event
2999 so we won't do this twice, then queue it up. */
3000 if (EVENT_HAS_PARAMETERS (c
)
3002 && CONSP (EVENT_START (c
))
3003 && CONSP (XCDR (EVENT_START (c
))))
3007 posn
= POSN_POSN (EVENT_START (c
));
3008 /* Handle menu-bar events:
3009 insert the dummy prefix event `menu-bar'. */
3010 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3012 /* Change menu-bar to (menu-bar) as the event "position". */
3013 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3016 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3021 /* Store these characters into recent_keys, the dribble file if any,
3022 and the keyboard macro being defined, if any. */
3024 if (! NILP (also_record
))
3025 record_char (also_record
);
3027 /* Wipe the echo area.
3028 But first, if we are about to use an input method,
3029 save the echo area contents for it to refer to. */
3031 && ! NILP (Vinput_method_function
)
3032 && (unsigned) XINT (c
) >= ' '
3033 && (unsigned) XINT (c
) != 127
3034 && (unsigned) XINT (c
) < 256)
3036 previous_echo_area_message
= Fcurrent_message ();
3037 Vinput_method_previous_message
= previous_echo_area_message
;
3040 /* Now wipe the echo area, except for help events which do their
3041 own stuff with the echo area. */
3043 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3044 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3046 if (!NILP (echo_area_buffer
[0]))
3047 safe_run_hooks (Qecho_area_clear_hook
);
3048 clear_message (1, 0);
3051 reread_for_input_method
:
3053 /* Pass this to the input method, if appropriate. */
3055 && ! NILP (Vinput_method_function
)
3056 /* Don't run the input method within a key sequence,
3057 after the first event of the key sequence. */
3058 && NILP (prev_event
)
3059 && (unsigned) XINT (c
) >= ' '
3060 && (unsigned) XINT (c
) != 127
3061 && (unsigned) XINT (c
) < 256)
3064 int key_count
, key_count_reset
;
3065 struct gcpro gcpro1
;
3066 int count
= SPECPDL_INDEX ();
3068 /* Save the echo status. */
3069 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3070 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3071 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3072 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3075 if (before_command_restore_flag
)
3077 this_command_key_count
= before_command_key_count_1
;
3078 if (this_command_key_count
< this_single_command_key_start
)
3079 this_single_command_key_start
= this_command_key_count
;
3080 echo_truncate (before_command_echo_length_1
);
3081 before_command_restore_flag
= 0;
3085 /* Save the this_command_keys status. */
3086 key_count
= this_command_key_count
;
3087 key_count_reset
= this_command_key_count_reset
;
3090 keys
= Fcopy_sequence (this_command_keys
);
3095 /* Clear out this_command_keys. */
3096 this_command_key_count
= 0;
3097 this_command_key_count_reset
= 0;
3099 /* Now wipe the echo area. */
3100 if (!NILP (echo_area_buffer
[0]))
3101 safe_run_hooks (Qecho_area_clear_hook
);
3102 clear_message (1, 0);
3105 /* If we are not reading a key sequence,
3106 never use the echo area. */
3109 specbind (Qinput_method_use_echo_area
, Qt
);
3112 /* Call the input method. */
3113 tem
= call1 (Vinput_method_function
, c
);
3115 tem
= unbind_to (count
, tem
);
3117 /* Restore the saved echoing state
3118 and this_command_keys state. */
3119 this_command_key_count
= key_count
;
3120 this_command_key_count_reset
= key_count_reset
;
3122 this_command_keys
= keys
;
3125 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3126 current_kboard
->echo_string
= saved_echo_string
;
3127 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3128 if (saved_immediate_echo
)
3133 /* The input method can return no events. */
3136 /* Bring back the previous message, if any. */
3137 if (! NILP (previous_echo_area_message
))
3138 message_with_string ("%s", previous_echo_area_message
, 0);
3141 /* It returned one event or more. */
3143 Vunread_post_input_method_events
3144 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3149 /* Display help if not echoing. */
3150 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3152 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3153 Lisp_Object help
, object
, position
, window
, tem
;
3155 tem
= Fcdr (XCDR (c
));
3158 window
= Fcar (tem
);
3160 object
= Fcar (tem
);
3162 position
= Fcar (tem
);
3164 show_help_echo (help
, window
, object
, position
, 0);
3166 /* We stopped being idle for this event; undo that. */
3167 timer_resume_idle ();
3171 if (! reread
|| this_command_key_count
== 0
3172 || this_command_key_count_reset
)
3175 /* Don't echo mouse motion events. */
3176 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3177 && NILP (Fzerop (Vecho_keystrokes
))
3178 && ! (EVENT_HAS_PARAMETERS (c
)
3179 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3182 if (! NILP (also_record
))
3183 echo_char (also_record
);
3184 /* Once we reread a character, echoing can happen
3185 the next time we pause to read a new one. */
3186 ok_to_echo_at_next_pause
= current_kboard
;
3189 /* Record this character as part of the current key. */
3190 add_command_key (c
);
3191 if (! NILP (also_record
))
3192 add_command_key (also_record
);
3195 last_input_char
= c
;
3198 /* Process the help character specially if enabled */
3199 if (!NILP (Vhelp_form
) && help_char_p (c
))
3202 count
= SPECPDL_INDEX ();
3204 record_unwind_protect (Fset_window_configuration
,
3205 Fcurrent_window_configuration (Qnil
));
3207 tem0
= Feval (Vhelp_form
);
3209 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3213 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3214 while (BUFFERP (c
));
3215 /* Remove the help from the frame */
3216 unbind_to (count
, Qnil
);
3219 if (EQ (c
, make_number (040)))
3223 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3224 while (BUFFERP (c
));
3233 /* Record a key that came from a mouse menu.
3234 Record it for echoing, for this-command-keys, and so on. */
3240 /* Wipe the echo area. */
3241 clear_message (1, 0);
3246 before_command_key_count
= this_command_key_count
;
3247 before_command_echo_length
= echo_length ();
3250 /* Don't echo mouse motion events. */
3251 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3252 && NILP (Fzerop (Vecho_keystrokes
)))
3256 /* Once we reread a character, echoing can happen
3257 the next time we pause to read a new one. */
3258 ok_to_echo_at_next_pause
= 0;
3261 /* Record this character as part of the current key. */
3262 add_command_key (c
);
3264 /* Re-reading in the middle of a command */
3265 last_input_char
= c
;
3269 /* Return 1 if should recognize C as "the help character". */
3277 if (EQ (c
, Vhelp_char
))
3279 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3280 if (EQ (c
, XCAR (tail
)))
3285 /* Record the input event C in various ways. */
3293 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3295 /* To avoid filling recent_keys with help-echo and mouse-movement
3296 events, we filter out repeated help-echo events, only store the
3297 first and last in a series of mouse-movement events, and don't
3298 store repeated help-echo events which are only separated by
3299 mouse-movement events. */
3301 Lisp_Object ev1
, ev2
, ev3
;
3304 if ((ix1
= recent_keys_index
- 1) < 0)
3305 ix1
= NUM_RECENT_KEYS
- 1;
3306 ev1
= AREF (recent_keys
, ix1
);
3308 if ((ix2
= ix1
- 1) < 0)
3309 ix2
= NUM_RECENT_KEYS
- 1;
3310 ev2
= AREF (recent_keys
, ix2
);
3312 if ((ix3
= ix2
- 1) < 0)
3313 ix3
= NUM_RECENT_KEYS
- 1;
3314 ev3
= AREF (recent_keys
, ix3
);
3316 if (EQ (XCAR (c
), Qhelp_echo
))
3318 /* Don't record `help-echo' in recent_keys unless it shows some help
3319 message, and a different help than the previously recorded
3321 Lisp_Object help
, last_help
;
3323 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3324 if (!STRINGP (help
))
3326 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3327 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3329 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3330 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3331 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3333 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3334 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3335 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3336 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3339 else if (EQ (XCAR (c
), Qmouse_movement
))
3341 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3342 So additional mouse movement events replace the last element. */
3343 Lisp_Object last_window
, window
;
3345 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3346 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3347 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3348 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3349 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3351 ASET (recent_keys
, ix1
, c
);
3357 store_kbd_macro_char (c
);
3362 ASET (recent_keys
, recent_keys_index
, c
);
3363 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3364 recent_keys_index
= 0;
3366 else if (recorded
< 0)
3368 /* We need to remove one or two events from recent_keys.
3369 To do this, we simply put nil at those events and move the
3370 recent_keys_index backwards over those events. Usually,
3371 users will never see those nil events, as they will be
3372 overwritten by the command keys entered to see recent_keys
3375 while (recorded
++ < 0 && total_keys
> 0)
3377 if (total_keys
< NUM_RECENT_KEYS
)
3379 if (--recent_keys_index
< 0)
3380 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3381 ASET (recent_keys
, recent_keys_index
, Qnil
);
3385 num_nonmacro_input_events
++;
3387 /* Write c to the dribble file. If c is a lispy event, write
3388 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3389 If you, dear reader, have a better idea, you've got the source. :-) */
3394 if (XUINT (c
) < 0x100)
3395 putc (XINT (c
), dribble
);
3397 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3401 Lisp_Object dribblee
;
3403 /* If it's a structured event, take the event header. */
3404 dribblee
= EVENT_HEAD (c
);
3406 if (SYMBOLP (dribblee
))
3408 putc ('<', dribble
);
3409 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3410 SBYTES (SYMBOL_NAME (dribblee
)),
3412 putc ('>', dribble
);
3424 struct buffer
*old
= current_buffer
;
3425 Fprinc (object
, Qnil
);
3426 set_buffer_internal (XBUFFER (Vstandard_output
));
3427 call0 (intern ("help-mode"));
3428 set_buffer_internal (old
);
3432 /* Copy out or in the info on where C-g should throw to.
3433 This is used when running Lisp code from within get_char,
3434 in case get_char is called recursively.
3435 See read_process_output. */
3441 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3445 restore_getcjmp (temp
)
3448 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3453 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3454 of this function. */
3457 tracking_off (old_value
)
3458 Lisp_Object old_value
;
3460 do_mouse_tracking
= old_value
;
3461 if (NILP (old_value
))
3463 /* Redisplay may have been preempted because there was input
3464 available, and it assumes it will be called again after the
3465 input has been processed. If the only input available was
3466 the sort that we have just disabled, then we need to call
3468 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
3470 redisplay_preserve_echo_area (6);
3471 get_input_pending (&input_pending
,
3472 READABLE_EVENTS_DO_TIMERS_NOW
);
3478 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3479 doc
: /* Evaluate BODY with mouse movement events enabled.
3480 Within a `track-mouse' form, mouse motion generates input events that
3481 you can read with `read-event'.
3482 Normally, mouse motion is ignored.
3483 usage: (track-mouse BODY ...) */)
3487 int count
= SPECPDL_INDEX ();
3490 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3492 do_mouse_tracking
= Qt
;
3494 val
= Fprogn (args
);
3495 return unbind_to (count
, val
);
3498 /* If mouse has moved on some frame, return one of those frames.
3499 Return 0 otherwise. */
3504 Lisp_Object tail
, frame
;
3506 FOR_EACH_FRAME (tail
, frame
)
3508 if (XFRAME (frame
)->mouse_moved
)
3509 return XFRAME (frame
);
3515 #endif /* HAVE_MOUSE */
3517 /* Low level keyboard/mouse input.
3518 kbd_buffer_store_event places events in kbd_buffer, and
3519 kbd_buffer_get_event retrieves them. */
3521 /* Return true iff there are any events in the queue that read-char
3522 would return. If this returns false, a read-char would block. */
3524 readable_events (flags
)
3527 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3530 /* If the buffer contains only FOCUS_IN_EVENT events, and
3531 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3532 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3534 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3535 #ifdef USE_TOOLKIT_SCROLL_BARS
3536 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3540 struct input_event
*event
;
3542 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3549 #ifdef USE_TOOLKIT_SCROLL_BARS
3550 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3552 event
->kind
== FOCUS_IN_EVENT
)
3553 #ifdef USE_TOOLKIT_SCROLL_BARS
3554 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3555 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3556 && event
->part
== scroll_bar_handle
3557 && event
->modifiers
== 0)
3562 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3565 while (event
!= kbd_store_ptr
);
3572 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3573 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3578 if (current_kboard
->kbd_queue_has_data
)
3584 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3585 if (kb
->kbd_queue_has_data
)
3591 /* Set this for debugging, to have a way to get out */
3596 event_to_kboard (event
)
3597 struct input_event
*event
;
3600 frame
= event
->frame_or_window
;
3602 frame
= XCAR (frame
);
3603 else if (WINDOWP (frame
))
3604 frame
= WINDOW_FRAME (XWINDOW (frame
));
3606 /* There are still some events that don't set this field.
3607 For now, just ignore the problem.
3608 Also ignore dead frames here. */
3609 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3612 return FRAME_KBOARD (XFRAME (frame
));
3617 Lisp_Object Vthrow_on_input
;
3619 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3622 kbd_buffer_store_event (event
)
3623 register struct input_event
*event
;
3625 kbd_buffer_store_event_hold (event
, 0);
3628 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3630 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3631 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3632 Else, if EVENT is a quit event, store the quit event
3633 in HOLD_QUIT, and return (thus ignoring further events).
3635 This is used in read_avail_input to postpone the processing
3636 of the quit event until all subsequent input events have been
3637 parsed (and discarded).
3641 kbd_buffer_store_event_hold (event
, hold_quit
)
3642 register struct input_event
*event
;
3643 struct input_event
*hold_quit
;
3645 if (event
->kind
== NO_EVENT
)
3648 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3651 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3653 register int c
= event
->code
& 0377;
3655 if (event
->modifiers
& ctrl_modifier
)
3656 c
= make_ctrl_char (c
);
3658 c
|= (event
->modifiers
3659 & (meta_modifier
| alt_modifier
3660 | hyper_modifier
| super_modifier
));
3666 struct input_event
*sp
;
3669 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3670 kb
!= current_kboard
))
3673 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3674 Fcons (make_number (c
), Qnil
));
3675 kb
->kbd_queue_has_data
= 1;
3676 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3678 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3681 if (event_to_kboard (sp
) == kb
)
3683 sp
->kind
= NO_EVENT
;
3684 sp
->frame_or_window
= Qnil
;
3694 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3698 /* If this results in a quit_char being returned to Emacs as
3699 input, set Vlast_event_frame properly. If this doesn't
3700 get returned to Emacs as an event, the next event read
3701 will set Vlast_event_frame again, so this is safe to do. */
3705 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3707 focus
= event
->frame_or_window
;
3708 internal_last_event_frame
= focus
;
3709 Vlast_event_frame
= focus
;
3712 last_event_timestamp
= event
->timestamp
;
3713 interrupt_signal (0 /* dummy */);
3717 if (c
&& c
== stop_character
)
3723 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3724 Just ignore the second one. */
3725 else if (event
->kind
== BUFFER_SWITCH_EVENT
3726 && kbd_fetch_ptr
!= kbd_store_ptr
3727 && ((kbd_store_ptr
== kbd_buffer
3728 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3729 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3732 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3733 kbd_store_ptr
= kbd_buffer
;
3735 /* Don't let the very last slot in the buffer become full,
3736 since that would make the two pointers equal,
3737 and that is indistinguishable from an empty buffer.
3738 Discard the event if it would fill the last slot. */
3739 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3741 *kbd_store_ptr
= *event
;
3745 /* If we're inside while-no-input, and this event qualifies
3746 as input, set quit-flag to cause an interrupt. */
3747 if (!NILP (Vthrow_on_input
)
3748 && event
->kind
!= FOCUS_IN_EVENT
3749 && event
->kind
!= HELP_EVENT
3750 && event
->kind
!= DEICONIFY_EVENT
)
3752 Vquit_flag
= Vthrow_on_input
;
3753 /* If we're inside a function that wants immediate quits,
3755 if (immediate_quit
&& NILP (Vinhibit_quit
))
3765 /* Put an input event back in the head of the event queue. */
3768 kbd_buffer_unget_event (event
)
3769 register struct input_event
*event
;
3771 if (kbd_fetch_ptr
== kbd_buffer
)
3772 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3774 /* Don't let the very last slot in the buffer become full, */
3775 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3778 *kbd_fetch_ptr
= *event
;
3783 /* Generate HELP_EVENT input_events in BUFP which has room for
3784 SIZE events. If there's not enough room in BUFP, ignore this
3787 HELP is the help form.
3789 FRAME is the frame on which the help is generated. OBJECT is the
3790 Lisp object where the help was found (a buffer, a string, an
3791 overlay, or nil if neither from a string nor from a buffer. POS is
3792 the position within OBJECT where the help was found.
3794 Value is the number of input_events generated. */
3797 gen_help_event (help
, frame
, window
, object
, pos
)
3798 Lisp_Object help
, frame
, object
, window
;
3801 struct input_event event
;
3805 event
.kind
= HELP_EVENT
;
3806 event
.frame_or_window
= frame
;
3808 event
.x
= WINDOWP (window
) ? window
: frame
;
3811 kbd_buffer_store_event (&event
);
3815 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3818 kbd_buffer_store_help_event (frame
, help
)
3819 Lisp_Object frame
, help
;
3821 struct input_event event
;
3823 event
.kind
= HELP_EVENT
;
3824 event
.frame_or_window
= frame
;
3829 kbd_buffer_store_event (&event
);
3833 /* Discard any mouse events in the event buffer by setting them to
3836 discard_mouse_events ()
3838 struct input_event
*sp
;
3839 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3841 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3844 if (sp
->kind
== MOUSE_CLICK_EVENT
3845 || sp
->kind
== WHEEL_EVENT
3847 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3849 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3851 sp
->kind
= NO_EVENT
;
3857 /* Return non-zero if there are any real events waiting in the event
3858 buffer, not counting `NO_EVENT's.
3860 If DISCARD is non-zero, discard NO_EVENT events at the front of
3861 the input queue, possibly leaving the input queue empty if there
3862 are no real input events. */
3865 kbd_buffer_events_waiting (discard
)
3868 struct input_event
*sp
;
3870 for (sp
= kbd_fetch_ptr
;
3871 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3874 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3881 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3885 /* Clear input event EVENT. */
3889 struct input_event
*event
;
3891 event
->kind
= NO_EVENT
;
3895 /* Read one event from the event buffer, waiting if necessary.
3896 The value is a Lisp object representing the event.
3897 The value is nil for an event that should be ignored,
3898 or that was handled here.
3899 We always read and discard one event. */
3902 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
3904 int *used_mouse_menu
;
3905 EMACS_TIME
*end_time
;
3914 *kbp
= current_kboard
;
3918 /* Wait until there is input available. */
3921 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3924 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3928 /* If the quit flag is set, then read_char will return
3929 quit_char, so that counts as "available input." */
3930 if (!NILP (Vquit_flag
))
3931 quit_throw_to_read_char ();
3933 /* One way or another, wait until input is available; then, if
3934 interrupt handlers have not read it, read it now. */
3937 wait_for_kbd_input ();
3939 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3943 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3946 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3951 EMACS_TIME duration
;
3952 EMACS_GET_TIME (duration
);
3953 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3954 if (EMACS_TIME_NEG_P (duration
))
3957 wait_reading_process_output (EMACS_SECS (duration
),
3958 EMACS_USECS (duration
),
3959 -1, 1, Qnil
, NULL
, 0);
3962 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3964 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3965 /* Pass 1 for EXPECT since we just waited to have input. */
3966 read_avail_input (1);
3967 #endif /* not VMS */
3970 if (CONSP (Vunread_command_events
))
3973 first
= XCAR (Vunread_command_events
);
3974 Vunread_command_events
= XCDR (Vunread_command_events
);
3975 *kbp
= current_kboard
;
3979 /* At this point, we know that there is a readable event available
3980 somewhere. If the event queue is empty, then there must be a
3981 mouse movement enabled and available. */
3982 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3984 struct input_event
*event
;
3986 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3990 last_event_timestamp
= event
->timestamp
;
3993 *kbp
= event_to_kboard (event
);
3995 *kbp
= current_kboard
; /* Better than returning null ptr? */
3997 *kbp
= &the_only_kboard
;
4002 /* These two kinds of events get special handling
4003 and don't actually appear to the command loop.
4004 We return nil for them. */
4005 if (event
->kind
== SELECTION_REQUEST_EVENT
4006 || event
->kind
== SELECTION_CLEAR_EVENT
)
4009 struct input_event copy
;
4011 /* Remove it from the buffer before processing it,
4012 since otherwise swallow_events will see it
4013 and process it again. */
4015 kbd_fetch_ptr
= event
+ 1;
4016 input_pending
= readable_events (0);
4017 x_handle_selection_event (©
);
4019 /* We're getting selection request events, but we don't have
4025 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4026 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4028 /* Make an event (delete-frame (FRAME)). */
4029 obj
= Fcons (event
->frame_or_window
, Qnil
);
4030 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4031 kbd_fetch_ptr
= event
+ 1;
4034 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4035 else if (event
->kind
== ICONIFY_EVENT
)
4037 /* Make an event (iconify-frame (FRAME)). */
4038 obj
= Fcons (event
->frame_or_window
, Qnil
);
4039 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4040 kbd_fetch_ptr
= event
+ 1;
4042 else if (event
->kind
== DEICONIFY_EVENT
)
4044 /* Make an event (make-frame-visible (FRAME)). */
4045 obj
= Fcons (event
->frame_or_window
, Qnil
);
4046 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4047 kbd_fetch_ptr
= event
+ 1;
4050 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4052 /* The value doesn't matter here; only the type is tested. */
4053 XSETBUFFER (obj
, current_buffer
);
4054 kbd_fetch_ptr
= event
+ 1;
4056 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4057 || defined (USE_GTK)
4058 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4060 kbd_fetch_ptr
= event
+ 1;
4061 input_pending
= readable_events (0);
4062 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4063 x_activate_menubar (XFRAME (event
->frame_or_window
));
4066 #if defined (WINDOWSNT) || defined (MAC_OS)
4067 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4070 /* Make an event (language-change (KEY_SCRIPT)). */
4071 obj
= Fcons (make_number (event
->code
), Qnil
);
4073 /* Make an event (language-change (FRAME CHARSET LCID)). */
4074 obj
= Fcons (event
->frame_or_window
, Qnil
);
4076 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4077 kbd_fetch_ptr
= event
+ 1;
4080 else if (event
->kind
== SAVE_SESSION_EVENT
)
4082 obj
= Fcons (Qsave_session
, Qnil
);
4083 kbd_fetch_ptr
= event
+ 1;
4085 /* Just discard these, by returning nil.
4086 With MULTI_KBOARD, these events are used as placeholders
4087 when we need to randomly delete events from the queue.
4088 (They shouldn't otherwise be found in the buffer,
4089 but on some machines it appears they do show up
4090 even without MULTI_KBOARD.) */
4091 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4092 mouse events during a popup-menu call. */
4093 else if (event
->kind
== NO_EVENT
)
4094 kbd_fetch_ptr
= event
+ 1;
4095 else if (event
->kind
== HELP_EVENT
)
4097 Lisp_Object object
, position
, help
, frame
, window
;
4099 frame
= event
->frame_or_window
;
4100 object
= event
->arg
;
4101 position
= make_number (event
->code
);
4104 clear_event (event
);
4106 kbd_fetch_ptr
= event
+ 1;
4107 if (!WINDOWP (window
))
4109 obj
= Fcons (Qhelp_echo
,
4110 list5 (frame
, help
, window
, object
, position
));
4112 else if (event
->kind
== FOCUS_IN_EVENT
)
4114 /* Notification of a FocusIn event. The frame receiving the
4115 focus is in event->frame_or_window. Generate a
4116 switch-frame event if necessary. */
4117 Lisp_Object frame
, focus
;
4119 frame
= event
->frame_or_window
;
4120 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4124 if (!EQ (frame
, internal_last_event_frame
)
4125 && !EQ (frame
, selected_frame
))
4126 obj
= make_lispy_switch_frame (frame
);
4127 internal_last_event_frame
= frame
;
4128 kbd_fetch_ptr
= event
+ 1;
4132 /* If this event is on a different frame, return a switch-frame this
4133 time, and leave the event in the queue for next time. */
4137 frame
= event
->frame_or_window
;
4139 frame
= XCAR (frame
);
4140 else if (WINDOWP (frame
))
4141 frame
= WINDOW_FRAME (XWINDOW (frame
));
4143 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4147 if (! EQ (frame
, internal_last_event_frame
)
4148 && !EQ (frame
, selected_frame
))
4149 obj
= make_lispy_switch_frame (frame
);
4150 internal_last_event_frame
= frame
;
4152 /* If we didn't decide to make a switch-frame event, go ahead
4153 and build a real event from the queue entry. */
4157 obj
= make_lispy_event (event
);
4159 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4160 || defined (USE_GTK)
4161 /* If this was a menu selection, then set the flag to inhibit
4162 writing to last_nonmenu_event. Don't do this if the event
4163 we're returning is (menu-bar), though; that indicates the
4164 beginning of the menu sequence, and we might as well leave
4165 that as the `event with parameters' for this selection. */
4167 && !EQ (event
->frame_or_window
, event
->arg
)
4168 && (event
->kind
== MENU_BAR_EVENT
4169 || event
->kind
== TOOL_BAR_EVENT
))
4170 *used_mouse_menu
= 1;
4173 /* Wipe out this event, to catch bugs. */
4174 clear_event (event
);
4175 kbd_fetch_ptr
= event
+ 1;
4180 /* Try generating a mouse motion event. */
4181 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4183 FRAME_PTR f
= some_mouse_moved ();
4184 Lisp_Object bar_window
;
4185 enum scroll_bar_part part
;
4189 *kbp
= current_kboard
;
4190 /* Note that this uses F to determine which display to look at.
4191 If there is no valid info, it does not store anything
4192 so x remains nil. */
4194 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4198 /* Decide if we should generate a switch-frame event. Don't
4199 generate switch-frame events for motion outside of all Emacs
4205 frame
= FRAME_FOCUS_FRAME (f
);
4207 XSETFRAME (frame
, f
);
4209 if (! EQ (frame
, internal_last_event_frame
)
4210 && !EQ (frame
, selected_frame
))
4211 obj
= make_lispy_switch_frame (frame
);
4212 internal_last_event_frame
= frame
;
4215 /* If we didn't decide to make a switch-frame event, go ahead and
4216 return a mouse-motion event. */
4217 if (!NILP (x
) && NILP (obj
))
4218 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4220 #endif /* HAVE_MOUSE */
4222 /* We were promised by the above while loop that there was
4223 something for us to read! */
4226 input_pending
= readable_events (0);
4228 Vlast_event_frame
= internal_last_event_frame
;
4233 /* Process any events that are not user-visible,
4234 then return, without reading any user-visible events. */
4237 swallow_events (do_display
)
4242 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4244 struct input_event
*event
;
4246 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4250 last_event_timestamp
= event
->timestamp
;
4252 /* These two kinds of events get special handling
4253 and don't actually appear to the command loop. */
4254 if (event
->kind
== SELECTION_REQUEST_EVENT
4255 || event
->kind
== SELECTION_CLEAR_EVENT
)
4258 struct input_event copy
;
4260 /* Remove it from the buffer before processing it,
4261 since otherwise swallow_events called recursively could see it
4262 and process it again. */
4264 kbd_fetch_ptr
= event
+ 1;
4265 input_pending
= readable_events (0);
4266 x_handle_selection_event (©
);
4268 /* We're getting selection request events, but we don't have
4277 old_timers_run
= timers_run
;
4278 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4280 if (timers_run
!= old_timers_run
&& do_display
)
4281 redisplay_preserve_echo_area (7);
4284 /* Record the start of when Emacs is idle,
4285 for the sake of running idle-time timers. */
4292 /* If we are already in the idle state, do nothing. */
4293 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4296 EMACS_GET_TIME (timer_idleness_start_time
);
4298 timer_last_idleness_start_time
= timer_idleness_start_time
;
4300 /* Mark all idle-time timers as once again candidates for running. */
4301 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4305 timer
= XCAR (timers
);
4307 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4309 XVECTOR (timer
)->contents
[0] = Qnil
;
4313 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4318 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4321 /* Resume idle timer from last idle start time. */
4324 timer_resume_idle ()
4326 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4329 timer_idleness_start_time
= timer_last_idleness_start_time
;
4332 /* This is only for debugging. */
4333 struct input_event last_timer_event
;
4335 /* Check whether a timer has fired. To prevent larger problems we simply
4336 disregard elements that are not proper timers. Do not make a circular
4337 timer list for the time being.
4339 Returns the number of seconds to wait until the next timer fires. If a
4340 timer is triggering now, return zero seconds.
4341 If no timer is active, return -1 seconds.
4343 If a timer is ripe, we run it, with quitting turned off.
4345 DO_IT_NOW is now ignored. It used to mean that we should
4346 run the timer directly instead of queueing a timer-event.
4347 Now we always run timers directly. */
4350 timer_check (do_it_now
)
4353 EMACS_TIME nexttime
;
4354 EMACS_TIME now
, idleness_now
;
4355 Lisp_Object timers
, idle_timers
, chosen_timer
;
4356 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4358 EMACS_SET_SECS (nexttime
, -1);
4359 EMACS_SET_USECS (nexttime
, -1);
4361 /* Always consider the ordinary timers. */
4362 timers
= Vtimer_list
;
4363 /* Consider the idle timers only if Emacs is idle. */
4364 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4365 idle_timers
= Vtimer_idle_list
;
4368 chosen_timer
= Qnil
;
4369 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4371 if (CONSP (timers
) || CONSP (idle_timers
))
4373 EMACS_GET_TIME (now
);
4374 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4375 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4378 while (CONSP (timers
) || CONSP (idle_timers
))
4380 Lisp_Object
*vector
;
4381 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4382 EMACS_TIME timer_time
, idle_timer_time
;
4383 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4385 /* Skip past invalid timers and timers already handled. */
4388 timer
= XCAR (timers
);
4389 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4391 timers
= XCDR (timers
);
4394 vector
= XVECTOR (timer
)->contents
;
4396 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4397 || !INTEGERP (vector
[3])
4398 || ! NILP (vector
[0]))
4400 timers
= XCDR (timers
);
4404 if (!NILP (idle_timers
))
4406 timer
= XCAR (idle_timers
);
4407 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4409 idle_timers
= XCDR (idle_timers
);
4412 vector
= XVECTOR (timer
)->contents
;
4414 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4415 || !INTEGERP (vector
[3])
4416 || ! NILP (vector
[0]))
4418 idle_timers
= XCDR (idle_timers
);
4423 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4424 based on the next ordinary timer.
4425 TIMER_DIFFERENCE is the distance in time from NOW to when
4426 this timer becomes ripe (negative if it's already ripe). */
4429 timer
= XCAR (timers
);
4430 vector
= XVECTOR (timer
)->contents
;
4431 EMACS_SET_SECS (timer_time
,
4432 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4433 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4434 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4437 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4438 based on the next idle timer. */
4439 if (!NILP (idle_timers
))
4441 idle_timer
= XCAR (idle_timers
);
4442 vector
= XVECTOR (idle_timer
)->contents
;
4443 EMACS_SET_SECS (idle_timer_time
,
4444 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4445 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4446 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4449 /* Decide which timer is the next timer,
4450 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4451 Also step down the list where we found that timer. */
4453 if (! NILP (timers
) && ! NILP (idle_timers
))
4456 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4457 if (EMACS_TIME_NEG_P (temp
))
4459 chosen_timer
= timer
;
4460 timers
= XCDR (timers
);
4461 difference
= timer_difference
;
4465 chosen_timer
= idle_timer
;
4466 idle_timers
= XCDR (idle_timers
);
4467 difference
= idle_timer_difference
;
4470 else if (! NILP (timers
))
4472 chosen_timer
= timer
;
4473 timers
= XCDR (timers
);
4474 difference
= timer_difference
;
4478 chosen_timer
= idle_timer
;
4479 idle_timers
= XCDR (idle_timers
);
4480 difference
= idle_timer_difference
;
4482 vector
= XVECTOR (chosen_timer
)->contents
;
4484 /* If timer is ripe, run it if it hasn't been run. */
4485 if (EMACS_TIME_NEG_P (difference
)
4486 || (EMACS_SECS (difference
) == 0
4487 && EMACS_USECS (difference
) == 0))
4489 if (NILP (vector
[0]))
4491 int was_locked
= single_kboard
;
4492 int count
= SPECPDL_INDEX ();
4493 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4495 /* Mark the timer as triggered to prevent problems if the lisp
4496 code fails to reschedule it right. */
4499 specbind (Qinhibit_quit
, Qt
);
4501 call1 (Qtimer_event_handler
, chosen_timer
);
4502 Vdeactivate_mark
= old_deactivate_mark
;
4504 unbind_to (count
, Qnil
);
4506 /* Resume allowing input from any kboard, if that was true before. */
4508 any_kboard_state ();
4510 /* Since we have handled the event,
4511 we don't need to tell the caller to wake up and do it. */
4515 /* When we encounter a timer that is still waiting,
4516 return the amount of time to wait before it is ripe. */
4523 /* No timers are pending in the future. */
4524 /* Return 0 if we generated an event, and -1 if not. */
4529 /* Caches for modify_event_symbol. */
4530 static Lisp_Object accent_key_syms
;
4531 static Lisp_Object func_key_syms
;
4532 static Lisp_Object mouse_syms
;
4533 static Lisp_Object wheel_syms
;
4534 static Lisp_Object drag_n_drop_syms
;
4536 /* This is a list of keysym codes for special "accent" characters.
4537 It parallels lispy_accent_keys. */
4539 static int lispy_accent_codes
[] =
4541 #ifdef XK_dead_circumflex
4546 #ifdef XK_dead_grave
4551 #ifdef XK_dead_tilde
4556 #ifdef XK_dead_diaeresis
4561 #ifdef XK_dead_macron
4566 #ifdef XK_dead_degree
4571 #ifdef XK_dead_acute
4576 #ifdef XK_dead_cedilla
4581 #ifdef XK_dead_breve
4586 #ifdef XK_dead_ogonek
4591 #ifdef XK_dead_caron
4596 #ifdef XK_dead_doubleacute
4597 XK_dead_doubleacute
,
4601 #ifdef XK_dead_abovedot
4606 #ifdef XK_dead_abovering
4616 #ifdef XK_dead_belowdot
4621 #ifdef XK_dead_voiced_sound
4622 XK_dead_voiced_sound
,
4626 #ifdef XK_dead_semivoiced_sound
4627 XK_dead_semivoiced_sound
,
4643 /* This is a list of Lisp names for special "accent" characters.
4644 It parallels lispy_accent_codes. */
4646 static char *lispy_accent_keys
[] =
4664 "dead-voiced-sound",
4665 "dead-semivoiced-sound",
4671 #define FUNCTION_KEY_OFFSET 0x0
4673 char *lispy_function_keys
[] =
4677 0, /* VK_LBUTTON 0x01 */
4678 0, /* VK_RBUTTON 0x02 */
4679 "cancel", /* VK_CANCEL 0x03 */
4680 0, /* VK_MBUTTON 0x04 */
4682 0, 0, 0, /* 0x05 .. 0x07 */
4684 "backspace", /* VK_BACK 0x08 */
4685 "tab", /* VK_TAB 0x09 */
4687 0, 0, /* 0x0A .. 0x0B */
4689 "clear", /* VK_CLEAR 0x0C */
4690 "return", /* VK_RETURN 0x0D */
4692 0, 0, /* 0x0E .. 0x0F */
4694 0, /* VK_SHIFT 0x10 */
4695 0, /* VK_CONTROL 0x11 */
4696 0, /* VK_MENU 0x12 */
4697 "pause", /* VK_PAUSE 0x13 */
4698 "capslock", /* VK_CAPITAL 0x14 */
4700 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4702 "escape", /* VK_ESCAPE 0x1B */
4704 0, 0, 0, 0, /* 0x1C .. 0x1F */
4706 0, /* VK_SPACE 0x20 */
4707 "prior", /* VK_PRIOR 0x21 */
4708 "next", /* VK_NEXT 0x22 */
4709 "end", /* VK_END 0x23 */
4710 "home", /* VK_HOME 0x24 */
4711 "left", /* VK_LEFT 0x25 */
4712 "up", /* VK_UP 0x26 */
4713 "right", /* VK_RIGHT 0x27 */
4714 "down", /* VK_DOWN 0x28 */
4715 "select", /* VK_SELECT 0x29 */
4716 "print", /* VK_PRINT 0x2A */
4717 "execute", /* VK_EXECUTE 0x2B */
4718 "snapshot", /* VK_SNAPSHOT 0x2C */
4719 "insert", /* VK_INSERT 0x2D */
4720 "delete", /* VK_DELETE 0x2E */
4721 "help", /* VK_HELP 0x2F */
4723 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4725 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4727 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4729 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4731 0, 0, 0, 0, 0, 0, 0, 0, 0,
4732 0, 0, 0, 0, 0, 0, 0, 0, 0,
4733 0, 0, 0, 0, 0, 0, 0, 0,
4735 "lwindow", /* VK_LWIN 0x5B */
4736 "rwindow", /* VK_RWIN 0x5C */
4737 "apps", /* VK_APPS 0x5D */
4739 0, 0, /* 0x5E .. 0x5F */
4741 "kp-0", /* VK_NUMPAD0 0x60 */
4742 "kp-1", /* VK_NUMPAD1 0x61 */
4743 "kp-2", /* VK_NUMPAD2 0x62 */
4744 "kp-3", /* VK_NUMPAD3 0x63 */
4745 "kp-4", /* VK_NUMPAD4 0x64 */
4746 "kp-5", /* VK_NUMPAD5 0x65 */
4747 "kp-6", /* VK_NUMPAD6 0x66 */
4748 "kp-7", /* VK_NUMPAD7 0x67 */
4749 "kp-8", /* VK_NUMPAD8 0x68 */
4750 "kp-9", /* VK_NUMPAD9 0x69 */
4751 "kp-multiply", /* VK_MULTIPLY 0x6A */
4752 "kp-add", /* VK_ADD 0x6B */
4753 "kp-separator", /* VK_SEPARATOR 0x6C */
4754 "kp-subtract", /* VK_SUBTRACT 0x6D */
4755 "kp-decimal", /* VK_DECIMAL 0x6E */
4756 "kp-divide", /* VK_DIVIDE 0x6F */
4757 "f1", /* VK_F1 0x70 */
4758 "f2", /* VK_F2 0x71 */
4759 "f3", /* VK_F3 0x72 */
4760 "f4", /* VK_F4 0x73 */
4761 "f5", /* VK_F5 0x74 */
4762 "f6", /* VK_F6 0x75 */
4763 "f7", /* VK_F7 0x76 */
4764 "f8", /* VK_F8 0x77 */
4765 "f9", /* VK_F9 0x78 */
4766 "f10", /* VK_F10 0x79 */
4767 "f11", /* VK_F11 0x7A */
4768 "f12", /* VK_F12 0x7B */
4769 "f13", /* VK_F13 0x7C */
4770 "f14", /* VK_F14 0x7D */
4771 "f15", /* VK_F15 0x7E */
4772 "f16", /* VK_F16 0x7F */
4773 "f17", /* VK_F17 0x80 */
4774 "f18", /* VK_F18 0x81 */
4775 "f19", /* VK_F19 0x82 */
4776 "f20", /* VK_F20 0x83 */
4777 "f21", /* VK_F21 0x84 */
4778 "f22", /* VK_F22 0x85 */
4779 "f23", /* VK_F23 0x86 */
4780 "f24", /* VK_F24 0x87 */
4782 0, 0, 0, 0, /* 0x88 .. 0x8B */
4783 0, 0, 0, 0, /* 0x8C .. 0x8F */
4785 "kp-numlock", /* VK_NUMLOCK 0x90 */
4786 "scroll", /* VK_SCROLL 0x91 */
4788 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4789 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4790 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4791 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4792 "kp-end", /* VK_NUMPAD_END 0x96 */
4793 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4794 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4795 "kp-up", /* VK_NUMPAD_UP 0x99 */
4796 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4797 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4798 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4799 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4801 0, 0, /* 0x9E .. 0x9F */
4804 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4805 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4806 * No other API or message will distinguish left and right keys this way.
4810 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4811 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4812 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4813 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4814 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4820 "attn", /* VK_ATTN 0xF6 */
4821 "crsel", /* VK_CRSEL 0xF7 */
4822 "exsel", /* VK_EXSEL 0xF8 */
4823 "ereof", /* VK_EREOF 0xF9 */
4824 "play", /* VK_PLAY 0xFA */
4825 "zoom", /* VK_ZOOM 0xFB */
4826 "noname", /* VK_NONAME 0xFC */
4827 "pa1", /* VK_PA1 0xFD */
4828 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4832 #else /* not HAVE_NTGUI */
4834 /* This should be dealt with in XTread_socket now, and that doesn't
4835 depend on the client system having the Kana syms defined. See also
4836 the XK_kana_A case below. */
4839 static char *lispy_kana_keys
[] =
4841 /* X Keysym value */
4842 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4843 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4844 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4845 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4846 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4847 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4848 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4849 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4850 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4851 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4852 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4853 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4854 "kana-i", "kana-u", "kana-e", "kana-o",
4855 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4856 "prolongedsound", "kana-A", "kana-I", "kana-U",
4857 "kana-E", "kana-O", "kana-KA", "kana-KI",
4858 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4859 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4860 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4861 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4862 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4863 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4864 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4865 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4866 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4867 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4868 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4869 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4871 #endif /* XK_kana_A */
4874 #define FUNCTION_KEY_OFFSET 0xff00
4876 /* You'll notice that this table is arranged to be conveniently
4877 indexed by X Windows keysym values. */
4878 static char *lispy_function_keys
[] =
4880 /* X Keysym value */
4882 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4883 "backspace", "tab", "linefeed", "clear",
4885 0, 0, 0, "pause", /* 0xff10...1f */
4886 0, 0, 0, 0, 0, 0, 0, "escape",
4888 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4889 "romaji", "hiragana", "katakana", "hiragana-katakana",
4890 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4891 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4892 "eisu-toggle", /* 0xff30...3f */
4893 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4894 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4896 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4897 "down", "prior", "next", "end",
4898 "begin", 0, 0, 0, 0, 0, 0, 0,
4899 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4910 "break", /* 0xff6b */
4913 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4914 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4915 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4916 0, 0, 0, 0, 0, 0, 0, 0,
4917 "kp-tab", /* 0xff89 */
4919 "kp-enter", /* 0xff8d */
4921 "kp-f1", /* 0xff91 */
4925 "kp-home", /* 0xff95 */
4930 "kp-prior", /* kp-page-up */
4931 "kp-next", /* kp-page-down */
4937 0, 0, 0, 0, 0, 0, 0, 0, 0,
4938 "kp-multiply", /* 0xffaa */
4943 "kp-divide", /* 0xffaf */
4944 "kp-0", /* 0xffb0 */
4945 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4948 "kp-equal", /* 0xffbd */
4949 "f1", /* 0xffbe */ /* IsFunctionKey */
4951 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4952 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4953 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4954 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4955 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4956 0, 0, 0, 0, 0, 0, 0, 0,
4957 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4958 0, 0, 0, 0, 0, 0, 0, "delete"
4961 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4962 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4964 static char *iso_lispy_function_keys
[] =
4966 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4967 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4968 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4969 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4970 "iso-lefttab", /* 0xfe20 */
4971 "iso-move-line-up", "iso-move-line-down",
4972 "iso-partial-line-up", "iso-partial-line-down",
4973 "iso-partial-space-left", "iso-partial-space-right",
4974 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4975 "iso-release-margin-left", "iso-release-margin-right",
4976 "iso-release-both-margins",
4977 "iso-fast-cursor-left", "iso-fast-cursor-right",
4978 "iso-fast-cursor-up", "iso-fast-cursor-down",
4979 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4980 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4983 #endif /* not HAVE_NTGUI */
4985 Lisp_Object Vlispy_mouse_stem
;
4987 static char *lispy_wheel_names
[] =
4989 "wheel-up", "wheel-down"
4992 /* drag-n-drop events are generated when a set of selected files are
4993 dragged from another application and dropped onto an Emacs window. */
4994 static char *lispy_drag_n_drop_names
[] =
4999 /* Scroll bar parts. */
5000 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5001 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5002 Lisp_Object Qtop
, Qratio
;
5004 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5005 Lisp_Object
*scroll_bar_parts
[] = {
5006 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5007 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5010 /* User signal events. */
5011 Lisp_Object Qusr1_signal
, Qusr2_signal
;
5013 Lisp_Object
*lispy_user_signals
[] =
5015 &Qusr1_signal
, &Qusr2_signal
5019 /* A vector, indexed by button number, giving the down-going location
5020 of currently depressed buttons, both scroll bar and non-scroll bar.
5022 The elements have the form
5023 (BUTTON-NUMBER MODIFIER-MASK . REST)
5024 where REST is the cdr of a position as it would be reported in the event.
5026 The make_lispy_event function stores positions here to tell the
5027 difference between click and drag events, and to store the starting
5028 location to be included in drag events. */
5030 static Lisp_Object button_down_location
;
5032 /* Information about the most recent up-going button event: Which
5033 button, what location, and what time. */
5035 static int last_mouse_button
;
5036 static int last_mouse_x
;
5037 static int last_mouse_y
;
5038 static unsigned long button_down_time
;
5040 /* The maximum time between clicks to make a double-click, or Qnil to
5041 disable double-click detection, or Qt for no time limit. */
5043 Lisp_Object Vdouble_click_time
;
5045 /* Maximum number of pixels the mouse may be moved between clicks
5046 to make a double-click. */
5048 EMACS_INT double_click_fuzz
;
5050 /* The number of clicks in this multiple-click. */
5052 int double_click_count
;
5054 /* Return position of a mouse click or wheel event */
5057 make_lispy_position (f
, x
, y
, time
)
5063 enum window_part part
;
5064 Lisp_Object posn
= Qnil
;
5065 Lisp_Object extra_info
= Qnil
;
5068 /* Set `window' to the window under frame pixel coordinates (x,y) */
5070 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5071 &part
, &wx
, &wy
, 0);
5075 if (WINDOWP (window
))
5077 /* It's a click in window window at frame coordinates (x,y) */
5078 struct window
*w
= XWINDOW (window
);
5079 Lisp_Object string_info
= Qnil
;
5080 int textpos
= -1, rx
= -1, ry
= -1;
5081 int dx
= -1, dy
= -1;
5082 int width
= -1, height
= -1;
5083 Lisp_Object object
= Qnil
;
5085 /* Set event coordinates to window-relative coordinates
5086 for constructing the Lisp event below. */
5090 if (part
== ON_TEXT
)
5092 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5094 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5096 /* Mode line or header line. Look for a string under
5097 the mouse that may have a `local-map' property. */
5101 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5103 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5104 &object
, &dx
, &dy
, &width
, &height
);
5105 if (STRINGP (string
))
5106 string_info
= Fcons (string
, make_number (charpos
));
5107 if (w
== XWINDOW (selected_window
))
5110 textpos
= XMARKER (w
->pointm
)->charpos
;
5112 else if (part
== ON_VERTICAL_BORDER
)
5114 posn
= Qvertical_line
;
5119 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5124 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5126 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5127 &object
, &dx
, &dy
, &width
, &height
);
5128 if (STRINGP (string
))
5129 string_info
= Fcons (string
, make_number (charpos
));
5130 if (part
== ON_LEFT_MARGIN
)
5133 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5135 else if (part
== ON_LEFT_FRINGE
)
5137 posn
= Qleft_fringe
;
5140 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5142 : window_box_width (w
, LEFT_MARGIN_AREA
));
5145 else if (part
== ON_RIGHT_FRINGE
)
5147 posn
= Qright_fringe
;
5150 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5151 + window_box_width (w
, TEXT_AREA
)
5152 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5153 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5159 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5160 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5165 Lisp_Object string2
, object2
= Qnil
;
5166 struct display_pos p
;
5168 int width2
, height2
;
5169 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5170 &object2
, &dx2
, &dy2
,
5172 textpos
= CHARPOS (p
.pos
);
5173 if (rx
< 0) rx
= wx
;
5174 if (ry
< 0) ry
= wy
;
5175 if (dx
< 0) dx
= dx2
;
5176 if (dy
< 0) dy
= dy2
;
5177 if (width
< 0) width
= width2
;
5178 if (height
< 0) height
= height2
;
5182 posn
= make_number (textpos
);
5183 if (STRINGP (string2
))
5184 string_info
= Fcons (string2
,
5185 make_number (CHARPOS (p
.string_pos
)));
5191 #ifdef HAVE_WINDOW_SYSTEM
5192 if (IMAGEP (object
))
5194 Lisp_Object image_map
, hotspot
;
5195 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5197 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5199 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5200 posn
= XCAR (hotspot
);
5205 extra_info
= Fcons (object
,
5206 Fcons (Fcons (make_number (dx
),
5208 Fcons (Fcons (make_number (width
),
5209 make_number (height
)),
5213 extra_info
= Fcons (string_info
,
5214 Fcons (make_number (textpos
),
5215 Fcons (Fcons (make_number (rx
),
5221 XSETFRAME (window
, f
);
5226 XSETFASTINT (*x
, 0);
5227 XSETFASTINT (*y
, 0);
5230 return Fcons (window
,
5232 Fcons (Fcons (*x
, *y
),
5233 Fcons (make_number (time
),
5237 /* Given a struct input_event, build the lisp event which represents
5238 it. If EVENT is 0, build a mouse movement event from the mouse
5239 movement buffer, which should have a movement event in it.
5241 Note that events must be passed to this function in the order they
5242 are received; this function stores the location of button presses
5243 in order to build drag events when the button is released. */
5246 make_lispy_event (event
)
5247 struct input_event
*event
;
5251 switch (SWITCH_ENUM_CAST (event
->kind
))
5253 /* A simple keystroke. */
5254 case ASCII_KEYSTROKE_EVENT
:
5256 Lisp_Object lispy_c
;
5257 int c
= event
->code
& 0377;
5258 /* Turn ASCII characters into control characters
5260 if (event
->modifiers
& ctrl_modifier
)
5261 c
= make_ctrl_char (c
);
5263 /* Add in the other modifier bits. We took care of ctrl_modifier
5264 just above, and the shift key was taken care of by the X code,
5265 and applied to control characters by make_ctrl_char. */
5266 c
|= (event
->modifiers
5267 & (meta_modifier
| alt_modifier
5268 | hyper_modifier
| super_modifier
));
5269 /* Distinguish Shift-SPC from SPC. */
5270 if ((event
->code
& 0377) == 040
5271 && event
->modifiers
& shift_modifier
)
5272 c
|= shift_modifier
;
5273 button_down_time
= 0;
5274 XSETFASTINT (lispy_c
, c
);
5278 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5280 Lisp_Object lispy_c
;
5281 int c
= event
->code
;
5283 /* Add in the other modifier bits. We took care of ctrl_modifier
5284 just above, and the shift key was taken care of by the X code,
5285 and applied to control characters by make_ctrl_char. */
5286 c
|= (event
->modifiers
5287 & (meta_modifier
| alt_modifier
5288 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5289 /* What about the `shift' modifier ? */
5290 button_down_time
= 0;
5291 XSETFASTINT (lispy_c
, c
);
5295 /* A function key. The symbol may need to have modifier prefixes
5297 case NON_ASCII_KEYSTROKE_EVENT
:
5298 button_down_time
= 0;
5300 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5301 if (event
->code
== lispy_accent_codes
[i
])
5302 return modify_event_symbol (i
,
5304 Qfunction_key
, Qnil
,
5305 lispy_accent_keys
, &accent_key_syms
,
5306 (sizeof (lispy_accent_keys
)
5307 / sizeof (lispy_accent_keys
[0])));
5311 if (event
->code
>= 0x400 && event
->code
< 0x500)
5312 return modify_event_symbol (event
->code
- 0x400,
5313 event
->modifiers
& ~shift_modifier
,
5314 Qfunction_key
, Qnil
,
5315 lispy_kana_keys
, &func_key_syms
,
5316 (sizeof (lispy_kana_keys
)
5317 / sizeof (lispy_kana_keys
[0])));
5318 #endif /* XK_kana_A */
5321 #ifdef ISO_FUNCTION_KEY_OFFSET
5322 if (event
->code
< FUNCTION_KEY_OFFSET
5323 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5324 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5326 Qfunction_key
, Qnil
,
5327 iso_lispy_function_keys
, &func_key_syms
,
5328 (sizeof (iso_lispy_function_keys
)
5329 / sizeof (iso_lispy_function_keys
[0])));
5332 /* Handle system-specific or unknown keysyms. */
5333 if (event
->code
& (1 << 28)
5334 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5335 || (event
->code
- FUNCTION_KEY_OFFSET
5336 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5337 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5339 /* We need to use an alist rather than a vector as the cache
5340 since we can't make a vector long enuf. */
5341 if (NILP (current_kboard
->system_key_syms
))
5342 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5343 return modify_event_symbol (event
->code
,
5346 current_kboard
->Vsystem_key_alist
,
5347 0, ¤t_kboard
->system_key_syms
,
5351 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5353 Qfunction_key
, Qnil
,
5354 lispy_function_keys
, &func_key_syms
,
5355 (sizeof (lispy_function_keys
)
5356 / sizeof (lispy_function_keys
[0])));
5359 /* A mouse click. Figure out where it is, decide whether it's
5360 a press, click or drag, and build the appropriate structure. */
5361 case MOUSE_CLICK_EVENT
:
5362 #ifndef USE_TOOLKIT_SCROLL_BARS
5363 case SCROLL_BAR_CLICK_EVENT
:
5366 int button
= event
->code
;
5368 Lisp_Object position
;
5369 Lisp_Object
*start_pos_ptr
;
5370 Lisp_Object start_pos
;
5374 /* Build the position as appropriate for this mouse click. */
5375 if (event
->kind
== MOUSE_CLICK_EVENT
)
5377 struct frame
*f
= XFRAME (event
->frame_or_window
);
5378 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5382 /* Ignore mouse events that were made on frame that
5383 have been deleted. */
5384 if (! FRAME_LIVE_P (f
))
5387 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5388 /* EVENT->x and EVENT->y are frame-relative pixel
5389 coordinates at this place. Under old redisplay, COLUMN
5390 and ROW are set to frame relative glyph coordinates
5391 which are then used to determine whether this click is
5392 in a menu (non-toolkit version). */
5393 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5394 &column
, &row
, NULL
, 1);
5396 /* In the non-toolkit version, clicks on the menu bar
5397 are ordinary button events in the event buffer.
5398 Distinguish them, and invoke the menu.
5400 (In the toolkit version, the toolkit handles the menu bar
5401 and Emacs doesn't know about it until after the user
5402 makes a selection.) */
5403 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5404 && (event
->modifiers
& down_modifier
))
5406 Lisp_Object items
, item
;
5411 /* Activate the menu bar on the down event. If the
5412 up event comes in before the menu code can deal with it,
5414 if (! (event
->modifiers
& down_modifier
))
5418 /* Find the menu bar item under `column'. */
5420 items
= FRAME_MENU_BAR_ITEMS (f
);
5421 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5423 Lisp_Object pos
, string
;
5424 string
= AREF (items
, i
+ 1);
5425 pos
= AREF (items
, i
+ 3);
5428 if (column
>= XINT (pos
)
5429 && column
< XINT (pos
) + SCHARS (string
))
5431 item
= AREF (items
, i
);
5436 /* ELisp manual 2.4b says (x y) are window relative but
5437 code says they are frame-relative. */
5439 = Fcons (event
->frame_or_window
,
5441 Fcons (Fcons (event
->x
, event
->y
),
5442 Fcons (make_number (event
->timestamp
),
5445 return Fcons (item
, Fcons (position
, Qnil
));
5447 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5449 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5452 #ifndef USE_TOOLKIT_SCROLL_BARS
5455 /* It's a scrollbar click. */
5457 Lisp_Object portion_whole
;
5460 window
= event
->frame_or_window
;
5461 portion_whole
= Fcons (event
->x
, event
->y
);
5462 part
= *scroll_bar_parts
[(int) event
->part
];
5466 Fcons (Qvertical_scroll_bar
,
5467 Fcons (portion_whole
,
5468 Fcons (make_number (event
->timestamp
),
5469 Fcons (part
, Qnil
)))));
5471 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5473 if (button
>= ASIZE (button_down_location
))
5475 button_down_location
= larger_vector (button_down_location
,
5477 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5480 start_pos_ptr
= &AREF (button_down_location
, button
);
5481 start_pos
= *start_pos_ptr
;
5482 *start_pos_ptr
= Qnil
;
5485 /* On window-system frames, use the value of
5486 double-click-fuzz as is. On other frames, interpret it
5487 as a multiple of 1/8 characters. */
5491 if (WINDOWP (event
->frame_or_window
))
5492 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5493 else if (FRAMEP (event
->frame_or_window
))
5494 f
= XFRAME (event
->frame_or_window
);
5498 if (FRAME_WINDOW_P (f
))
5499 fuzz
= double_click_fuzz
;
5501 fuzz
= double_click_fuzz
/ 8;
5503 is_double
= (button
== last_mouse_button
5504 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5505 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5506 && button_down_time
!= 0
5507 && (EQ (Vdouble_click_time
, Qt
)
5508 || (INTEGERP (Vdouble_click_time
)
5509 && ((int)(event
->timestamp
- button_down_time
)
5510 < XINT (Vdouble_click_time
)))));
5513 last_mouse_button
= button
;
5514 last_mouse_x
= XINT (event
->x
);
5515 last_mouse_y
= XINT (event
->y
);
5517 /* If this is a button press, squirrel away the location, so
5518 we can decide later whether it was a click or a drag. */
5519 if (event
->modifiers
& down_modifier
)
5523 double_click_count
++;
5524 event
->modifiers
|= ((double_click_count
> 2)
5529 double_click_count
= 1;
5530 button_down_time
= event
->timestamp
;
5531 *start_pos_ptr
= Fcopy_alist (position
);
5534 /* Now we're releasing a button - check the co-ordinates to
5535 see if this was a click or a drag. */
5536 else if (event
->modifiers
& up_modifier
)
5538 /* If we did not see a down before this up, ignore the up.
5539 Probably this happened because the down event chose a
5540 menu item. It would be an annoyance to treat the
5541 release of the button that chose the menu item as a
5544 if (!CONSP (start_pos
))
5547 event
->modifiers
&= ~up_modifier
;
5548 #if 0 /* Formerly we treated an up with no down as a click event. */
5549 if (!CONSP (start_pos
))
5550 event
->modifiers
|= click_modifier
;
5555 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5557 /* The third element of every position
5558 should be the (x,y) pair. */
5559 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5561 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5563 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5564 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5567 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5568 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5569 /* Maybe the mouse has moved a lot, caused scrolling, and
5570 eventually ended up at the same screen position (but
5571 not buffer position) in which case it is a drag, not
5573 /* FIXME: OTOH if the buffer position has changed
5574 because of a timer or process filter rather than
5575 because of mouse movement, it should be considered as
5576 a click. But mouse-drag-region completely ignores
5577 this case and it hasn't caused any real problem, so
5578 it's probably OK to ignore it as well. */
5579 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5580 /* Mouse hasn't moved (much). */
5581 event
->modifiers
|= click_modifier
;
5584 button_down_time
= 0;
5585 event
->modifiers
|= drag_modifier
;
5588 /* Don't check is_double; treat this as multiple
5589 if the down-event was multiple. */
5590 if (double_click_count
> 1)
5591 event
->modifiers
|= ((double_click_count
> 2)
5597 /* Every mouse event should either have the down_modifier or
5598 the up_modifier set. */
5602 /* Get the symbol we should use for the mouse click. */
5605 head
= modify_event_symbol (button
,
5607 Qmouse_click
, Vlispy_mouse_stem
,
5610 XVECTOR (mouse_syms
)->size
);
5611 if (event
->modifiers
& drag_modifier
)
5616 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5619 Fcons (make_number (double_click_count
),
5630 Lisp_Object position
;
5633 /* Build the position as appropriate for this mouse click. */
5634 struct frame
*f
= XFRAME (event
->frame_or_window
);
5636 /* Ignore wheel events that were made on frame that have been
5638 if (! FRAME_LIVE_P (f
))
5641 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5644 /* Set double or triple modifiers to indicate the wheel speed. */
5646 /* On window-system frames, use the value of
5647 double-click-fuzz as is. On other frames, interpret it
5648 as a multiple of 1/8 characters. */
5653 if (WINDOWP (event
->frame_or_window
))
5654 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5655 else if (FRAMEP (event
->frame_or_window
))
5656 f
= XFRAME (event
->frame_or_window
);
5660 if (FRAME_WINDOW_P (f
))
5661 fuzz
= double_click_fuzz
;
5663 fuzz
= double_click_fuzz
/ 8;
5665 is_double
= (last_mouse_button
< 0
5666 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5667 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5668 && button_down_time
!= 0
5669 && (EQ (Vdouble_click_time
, Qt
)
5670 || (INTEGERP (Vdouble_click_time
)
5671 && ((int)(event
->timestamp
- button_down_time
)
5672 < XINT (Vdouble_click_time
)))));
5675 double_click_count
++;
5676 event
->modifiers
|= ((double_click_count
> 2)
5682 double_click_count
= 1;
5683 event
->modifiers
|= click_modifier
;
5686 button_down_time
= event
->timestamp
;
5687 /* Use a negative value to distinguish wheel from mouse button. */
5688 last_mouse_button
= -1;
5689 last_mouse_x
= XINT (event
->x
);
5690 last_mouse_y
= XINT (event
->y
);
5696 if (event
->modifiers
& up_modifier
)
5698 /* Emit a wheel-up event. */
5699 event
->modifiers
&= ~up_modifier
;
5702 else if (event
->modifiers
& down_modifier
)
5704 /* Emit a wheel-down event. */
5705 event
->modifiers
&= ~down_modifier
;
5709 /* Every wheel event should either have the down_modifier or
5710 the up_modifier set. */
5713 /* Get the symbol we should use for the wheel event. */
5714 head
= modify_event_symbol (symbol_num
,
5720 ASIZE (wheel_syms
));
5723 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5726 Fcons (make_number (double_click_count
),
5735 #ifdef USE_TOOLKIT_SCROLL_BARS
5737 /* We don't have down and up events if using toolkit scroll bars,
5738 so make this always a click event. Store in the `part' of
5739 the Lisp event a symbol which maps to the following actions:
5741 `above_handle' page up
5742 `below_handle' page down
5746 `bottom' bottom of buffer
5747 `handle' thumb has been dragged.
5748 `end-scroll' end of interaction with scroll bar
5750 The incoming input_event contains in its `part' member an
5751 index of type `enum scroll_bar_part' which we can use as an
5752 index in scroll_bar_parts to get the appropriate symbol. */
5754 case SCROLL_BAR_CLICK_EVENT
:
5756 Lisp_Object position
, head
, window
, portion_whole
, part
;
5758 window
= event
->frame_or_window
;
5759 portion_whole
= Fcons (event
->x
, event
->y
);
5760 part
= *scroll_bar_parts
[(int) event
->part
];
5764 Fcons (Qvertical_scroll_bar
,
5765 Fcons (portion_whole
,
5766 Fcons (make_number (event
->timestamp
),
5767 Fcons (part
, Qnil
)))));
5769 /* Always treat scroll bar events as clicks. */
5770 event
->modifiers
|= click_modifier
;
5771 event
->modifiers
&= ~up_modifier
;
5773 if (event
->code
>= ASIZE (mouse_syms
))
5774 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5776 /* Get the symbol we should use for the mouse click. */
5777 head
= modify_event_symbol (event
->code
,
5782 XVECTOR (mouse_syms
)->size
);
5783 return Fcons (head
, Fcons (position
, Qnil
));
5786 #endif /* USE_TOOLKIT_SCROLL_BARS */
5789 case W32_SCROLL_BAR_CLICK_EVENT
:
5791 int button
= event
->code
;
5793 Lisp_Object position
;
5794 Lisp_Object
*start_pos_ptr
;
5795 Lisp_Object start_pos
;
5799 Lisp_Object portion_whole
;
5802 window
= event
->frame_or_window
;
5803 portion_whole
= Fcons (event
->x
, event
->y
);
5804 part
= *scroll_bar_parts
[(int) event
->part
];
5808 Fcons (Qvertical_scroll_bar
,
5809 Fcons (portion_whole
,
5810 Fcons (make_number (event
->timestamp
),
5811 Fcons (part
, Qnil
)))));
5814 /* Always treat W32 scroll bar events as clicks. */
5815 event
->modifiers
|= click_modifier
;
5818 /* Get the symbol we should use for the mouse click. */
5821 head
= modify_event_symbol (button
,
5826 XVECTOR (mouse_syms
)->size
);
5832 #endif /* WINDOWSNT */
5834 case DRAG_N_DROP_EVENT
:
5837 Lisp_Object head
, position
;
5840 f
= XFRAME (event
->frame_or_window
);
5843 /* Ignore mouse events that were made on frames that
5844 have been deleted. */
5845 if (! FRAME_LIVE_P (f
))
5848 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5851 head
= modify_event_symbol (0, event
->modifiers
,
5853 lispy_drag_n_drop_names
,
5854 &drag_n_drop_syms
, 1);
5860 #endif /* HAVE_MOUSE */
5862 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5863 || defined (USE_GTK)
5864 case MENU_BAR_EVENT
:
5865 if (EQ (event
->arg
, event
->frame_or_window
))
5866 /* This is the prefix key. We translate this to
5867 `(menu_bar)' because the code in keyboard.c for menu
5868 events, which we use, relies on this. */
5869 return Fcons (Qmenu_bar
, Qnil
);
5873 case SELECT_WINDOW_EVENT
:
5874 /* Make an event (select-window (WINDOW)). */
5875 return Fcons (Qselect_window
,
5876 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5879 case TOOL_BAR_EVENT
:
5880 if (EQ (event
->arg
, event
->frame_or_window
))
5881 /* This is the prefix key. We translate this to
5882 `(tool_bar)' because the code in keyboard.c for tool bar
5883 events, which we use, relies on this. */
5884 return Fcons (Qtool_bar
, Qnil
);
5885 else if (SYMBOLP (event
->arg
))
5886 return apply_modifiers (event
->modifiers
, event
->arg
);
5889 case USER_SIGNAL_EVENT
:
5890 /* A user signal. */
5891 return *lispy_user_signals
[event
->code
];
5893 case SAVE_SESSION_EVENT
:
5894 return Qsave_session
;
5897 case MAC_APPLE_EVENT
:
5899 Lisp_Object spec
[2];
5903 return Fcons (Qmac_apple_event
,
5904 Fcons (Fvector (2, spec
),
5905 Fcons (event
->arg
, Qnil
)));
5909 /* The 'kind' field of the event is something we don't recognize. */
5918 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5920 Lisp_Object bar_window
;
5921 enum scroll_bar_part part
;
5925 /* Is it a scroll bar movement? */
5926 if (frame
&& ! NILP (bar_window
))
5928 Lisp_Object part_sym
;
5930 part_sym
= *scroll_bar_parts
[(int) part
];
5931 return Fcons (Qscroll_bar_movement
,
5932 (Fcons (Fcons (bar_window
,
5933 Fcons (Qvertical_scroll_bar
,
5934 Fcons (Fcons (x
, y
),
5935 Fcons (make_number (time
),
5941 /* Or is it an ordinary mouse movement? */
5944 Lisp_Object position
;
5946 position
= make_lispy_position (frame
, &x
, &y
, time
);
5948 return Fcons (Qmouse_movement
,
5954 #endif /* HAVE_MOUSE */
5956 /* Construct a switch frame event. */
5958 make_lispy_switch_frame (frame
)
5961 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5964 /* Manipulating modifiers. */
5966 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5968 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5969 SYMBOL's name of the end of the modifiers; the string from this
5970 position is the unmodified symbol name.
5972 This doesn't use any caches. */
5975 parse_modifiers_uncached (symbol
, modifier_end
)
5983 CHECK_SYMBOL (symbol
);
5986 name
= SYMBOL_NAME (symbol
);
5988 for (i
= 0; i
+2 <= SBYTES (name
); )
5990 int this_mod_end
= 0;
5993 /* See if the name continues with a modifier word.
5994 Check that the word appears, but don't check what follows it.
5995 Set this_mod and this_mod_end to record what we find. */
5997 switch (SREF (name
, i
))
5999 #define SINGLE_LETTER_MOD(BIT) \
6000 (this_mod_end = i + 1, this_mod = BIT)
6003 SINGLE_LETTER_MOD (alt_modifier
);
6007 SINGLE_LETTER_MOD (ctrl_modifier
);
6011 SINGLE_LETTER_MOD (hyper_modifier
);
6015 SINGLE_LETTER_MOD (meta_modifier
);
6019 SINGLE_LETTER_MOD (shift_modifier
);
6023 SINGLE_LETTER_MOD (super_modifier
);
6026 #undef SINGLE_LETTER_MOD
6028 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6029 if (i + LEN + 1 <= SBYTES (name) \
6030 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6032 this_mod_end = i + LEN; \
6037 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6038 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6039 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6043 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6045 #undef MULTI_LETTER_MOD
6049 /* If we found no modifier, stop looking for them. */
6050 if (this_mod_end
== 0)
6053 /* Check there is a dash after the modifier, so that it
6054 really is a modifier. */
6055 if (this_mod_end
>= SBYTES (name
)
6056 || SREF (name
, this_mod_end
) != '-')
6059 /* This modifier is real; look for another. */
6060 modifiers
|= this_mod
;
6061 i
= this_mod_end
+ 1;
6064 /* Should we include the `click' modifier? */
6065 if (! (modifiers
& (down_modifier
| drag_modifier
6066 | double_modifier
| triple_modifier
))
6067 && i
+ 7 == SBYTES (name
)
6068 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6069 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6070 modifiers
|= click_modifier
;
6078 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6079 prepended to the string BASE[0..BASE_LEN-1].
6080 This doesn't use any caches. */
6082 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6085 int base_len
, base_len_byte
;
6087 /* Since BASE could contain nulls, we can't use intern here; we have
6088 to use Fintern, which expects a genuine Lisp_String, and keeps a
6091 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6097 /* Only the event queue may use the `up' modifier; it should always
6098 be turned into a click or drag event before presented to lisp code. */
6099 if (modifiers
& up_modifier
)
6102 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6103 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6104 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6105 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6106 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6107 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6108 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6109 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6110 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6111 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6112 /* The click modifier is denoted by the absence of other modifiers. */
6116 mod_len
= p
- new_mods
;
6120 Lisp_Object new_name
;
6122 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6123 mod_len
+ base_len_byte
);
6124 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6125 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6127 return Fintern (new_name
, Qnil
);
6132 static char *modifier_names
[] =
6134 "up", "down", "drag", "click", "double", "triple", 0, 0,
6135 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6136 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6138 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6140 static Lisp_Object modifier_symbols
;
6142 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6144 lispy_modifier_list (modifiers
)
6147 Lisp_Object modifier_list
;
6150 modifier_list
= Qnil
;
6151 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6152 if (modifiers
& (1<<i
))
6153 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6156 return modifier_list
;
6160 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6161 where UNMODIFIED is the unmodified form of SYMBOL,
6162 MASK is the set of modifiers present in SYMBOL's name.
6163 This is similar to parse_modifiers_uncached, but uses the cache in
6164 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6165 Qevent_symbol_elements property. */
6168 parse_modifiers (symbol
)
6171 Lisp_Object elements
;
6173 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6174 if (CONSP (elements
))
6179 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6180 Lisp_Object unmodified
;
6183 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6184 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6187 if (modifiers
& ~INTMASK
)
6189 XSETFASTINT (mask
, modifiers
);
6190 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6192 /* Cache the parsing results on SYMBOL. */
6193 Fput (symbol
, Qevent_symbol_element_mask
,
6195 Fput (symbol
, Qevent_symbol_elements
,
6196 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6198 /* Since we know that SYMBOL is modifiers applied to unmodified,
6199 it would be nice to put that in unmodified's cache.
6200 But we can't, since we're not sure that parse_modifiers is
6207 /* Apply the modifiers MODIFIERS to the symbol BASE.
6208 BASE must be unmodified.
6210 This is like apply_modifiers_uncached, but uses BASE's
6211 Qmodifier_cache property, if present. It also builds
6212 Qevent_symbol_elements properties, since it has that info anyway.
6214 apply_modifiers copies the value of BASE's Qevent_kind property to
6215 the modified symbol. */
6217 apply_modifiers (modifiers
, base
)
6221 Lisp_Object cache
, index
, entry
, new_symbol
;
6223 /* Mask out upper bits. We don't know where this value's been. */
6224 modifiers
&= INTMASK
;
6226 /* The click modifier never figures into cache indices. */
6227 cache
= Fget (base
, Qmodifier_cache
);
6228 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6229 entry
= assq_no_quit (index
, cache
);
6232 new_symbol
= XCDR (entry
);
6235 /* We have to create the symbol ourselves. */
6236 new_symbol
= apply_modifiers_uncached (modifiers
,
6237 SDATA (SYMBOL_NAME (base
)),
6238 SCHARS (SYMBOL_NAME (base
)),
6239 SBYTES (SYMBOL_NAME (base
)));
6241 /* Add the new symbol to the base's cache. */
6242 entry
= Fcons (index
, new_symbol
);
6243 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6245 /* We have the parsing info now for free, so we could add it to
6247 XSETFASTINT (index, modifiers);
6248 Fput (new_symbol, Qevent_symbol_element_mask,
6249 Fcons (base, Fcons (index, Qnil)));
6250 Fput (new_symbol, Qevent_symbol_elements,
6251 Fcons (base, lispy_modifier_list (modifiers)));
6252 Sadly, this is only correct if `base' is indeed a base event,
6253 which is not necessarily the case. -stef */
6256 /* Make sure this symbol is of the same kind as BASE.
6258 You'd think we could just set this once and for all when we
6259 intern the symbol above, but reorder_modifiers may call us when
6260 BASE's property isn't set right; we can't assume that just
6261 because it has a Qmodifier_cache property it must have its
6262 Qevent_kind set right as well. */
6263 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6267 kind
= Fget (base
, Qevent_kind
);
6269 Fput (new_symbol
, Qevent_kind
, kind
);
6276 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6277 return a symbol with the modifiers placed in the canonical order.
6278 Canonical order is alphabetical, except for down and drag, which
6279 always come last. The 'click' modifier is never written out.
6281 Fdefine_key calls this to make sure that (for example) C-M-foo
6282 and M-C-foo end up being equivalent in the keymap. */
6285 reorder_modifiers (symbol
)
6288 /* It's hopefully okay to write the code this way, since everything
6289 will soon be in caches, and no consing will be done at all. */
6292 parsed
= parse_modifiers (symbol
);
6293 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6298 /* For handling events, we often want to produce a symbol whose name
6299 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6300 to some base, like the name of a function key or mouse button.
6301 modify_event_symbol produces symbols of this sort.
6303 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6304 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6307 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6308 into symbol names, or a string specifying a name stem used to
6309 construct a symbol name or the form `STEM-N', where N is the decimal
6310 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6311 non-nil; otherwise NAME_TABLE is used.
6313 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6314 persist between calls to modify_event_symbol that it can use to
6315 store a cache of the symbols it's generated for this NAME_TABLE
6316 before. The object stored there may be a vector or an alist.
6318 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6320 MODIFIERS is a set of modifier bits (as given in struct input_events)
6321 whose prefixes should be applied to the symbol name.
6323 SYMBOL_KIND is the value to be placed in the event_kind property of
6324 the returned symbol.
6326 The symbols we create are supposed to have an
6327 `event-symbol-elements' property, which lists the modifiers present
6328 in the symbol's name. */
6331 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6332 name_table
, symbol_table
, table_size
)
6335 Lisp_Object symbol_kind
;
6336 Lisp_Object name_alist_or_stem
;
6338 Lisp_Object
*symbol_table
;
6339 unsigned int table_size
;
6342 Lisp_Object symbol_int
;
6344 /* Get rid of the "vendor-specific" bit here. */
6345 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6347 /* Is this a request for a valid symbol? */
6348 if (symbol_num
< 0 || symbol_num
>= table_size
)
6351 if (CONSP (*symbol_table
))
6352 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6354 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6355 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6356 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6357 we've never used that symbol before. */
6360 if (! VECTORP (*symbol_table
)
6361 || XVECTOR (*symbol_table
)->size
!= table_size
)
6365 XSETFASTINT (size
, table_size
);
6366 *symbol_table
= Fmake_vector (size
, Qnil
);
6369 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6372 /* Have we already used this symbol before? */
6375 /* No; let's create it. */
6376 if (CONSP (name_alist_or_stem
))
6377 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6378 else if (STRINGP (name_alist_or_stem
))
6380 int len
= SBYTES (name_alist_or_stem
);
6381 char *buf
= (char *) alloca (len
+ 50);
6382 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6383 (long) XINT (symbol_int
) + 1);
6384 value
= intern (buf
);
6386 else if (name_table
!= 0 && name_table
[symbol_num
])
6387 value
= intern (name_table
[symbol_num
]);
6389 #ifdef HAVE_WINDOW_SYSTEM
6392 char *name
= x_get_keysym_name (symbol_num
);
6394 value
= intern (name
);
6401 sprintf (buf
, "key-%d", symbol_num
);
6402 value
= intern (buf
);
6405 if (CONSP (*symbol_table
))
6406 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6408 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6410 /* Fill in the cache entries for this symbol; this also
6411 builds the Qevent_symbol_elements property, which the user
6413 apply_modifiers (modifiers
& click_modifier
, value
);
6414 Fput (value
, Qevent_kind
, symbol_kind
);
6417 /* Apply modifiers to that symbol. */
6418 return apply_modifiers (modifiers
, value
);
6421 /* Convert a list that represents an event type,
6422 such as (ctrl meta backspace), into the usual representation of that
6423 event type as a number or a symbol. */
6425 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6426 doc
: /* Convert the event description list EVENT-DESC to an event type.
6427 EVENT-DESC should contain one base event type (a character or symbol)
6428 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6429 drag, down, double or triple). The base must be last.
6430 The return value is an event type (a character or symbol) which
6431 has the same base event type and all the specified modifiers. */)
6433 Lisp_Object event_desc
;
6441 while (CONSP (rest
))
6449 /* Given a symbol, see if it is a modifier name. */
6450 if (SYMBOLP (elt
) && CONSP (rest
))
6451 this = parse_solitary_modifier (elt
);
6455 else if (!NILP (base
))
6456 error ("Two bases given in one event");
6462 /* Let the symbol A refer to the character A. */
6463 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6464 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6466 if (INTEGERP (base
))
6468 /* Turn (shift a) into A. */
6469 if ((modifiers
& shift_modifier
) != 0
6470 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6472 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6473 modifiers
&= ~shift_modifier
;
6476 /* Turn (control a) into C-a. */
6477 if (modifiers
& ctrl_modifier
)
6478 return make_number ((modifiers
& ~ctrl_modifier
)
6479 | make_ctrl_char (XINT (base
)));
6481 return make_number (modifiers
| XINT (base
));
6483 else if (SYMBOLP (base
))
6484 return apply_modifiers (modifiers
, base
);
6487 error ("Invalid base event");
6492 /* Try to recognize SYMBOL as a modifier name.
6493 Return the modifier flag bit, or 0 if not recognized. */
6496 parse_solitary_modifier (symbol
)
6499 Lisp_Object name
= SYMBOL_NAME (symbol
);
6501 switch (SREF (name
, 0))
6503 #define SINGLE_LETTER_MOD(BIT) \
6504 if (SBYTES (name) == 1) \
6507 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6508 if (LEN == SBYTES (name) \
6509 && ! strncmp (SDATA (name), NAME, LEN)) \
6513 SINGLE_LETTER_MOD (alt_modifier
);
6517 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6521 SINGLE_LETTER_MOD (ctrl_modifier
);
6525 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6526 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6530 SINGLE_LETTER_MOD (hyper_modifier
);
6534 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6538 SINGLE_LETTER_MOD (meta_modifier
);
6542 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6546 SINGLE_LETTER_MOD (shift_modifier
);
6550 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6551 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6552 SINGLE_LETTER_MOD (super_modifier
);
6556 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6557 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6558 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6562 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6565 #undef SINGLE_LETTER_MOD
6566 #undef MULTI_LETTER_MOD
6572 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6573 Such a list is not valid as an event,
6574 but it can be a Lucid-style event type list. */
6577 lucid_event_type_list_p (object
)
6582 if (! CONSP (object
))
6585 if (EQ (XCAR (object
), Qhelp_echo
)
6586 || EQ (XCAR (object
), Qvertical_line
)
6587 || EQ (XCAR (object
), Qmode_line
)
6588 || EQ (XCAR (object
), Qheader_line
))
6591 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6595 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6602 /* Store into *addr a value nonzero if terminal input chars are available.
6603 Serves the purpose of ioctl (0, FIONREAD, addr)
6604 but works even if FIONREAD does not exist.
6605 (In fact, this may actually read some input.)
6607 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6608 timer events that are ripe.
6609 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6610 events (FOCUS_IN_EVENT).
6611 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6612 movements and toolkit scroll bar thumb drags. */
6615 get_input_pending (addr
, flags
)
6619 /* First of all, have we already counted some input? */
6620 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6622 /* If input is being read as it arrives, and we have none, there is none. */
6623 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6626 /* Try to read some input and see how much we get. */
6628 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6631 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6634 gobble_input (expected
)
6639 if (interrupt_input
)
6642 mask
= sigblock (sigmask (SIGIO
));
6643 read_avail_input (expected
);
6647 #ifdef POLL_FOR_INPUT
6648 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6651 mask
= sigblock (sigmask (SIGALRM
));
6652 read_avail_input (expected
);
6658 read_avail_input (expected
);
6662 /* Put a BUFFER_SWITCH_EVENT in the buffer
6663 so that read_key_sequence will notice the new current buffer. */
6666 record_asynch_buffer_change ()
6668 struct input_event event
;
6672 event
.kind
= BUFFER_SWITCH_EVENT
;
6673 event
.frame_or_window
= Qnil
;
6677 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6678 The purpose of the event is to make read_key_sequence look up the
6679 keymaps again. If we aren't in read_key_sequence, we don't need one,
6680 and the event could cause trouble by messing up (input-pending-p). */
6681 tem
= Fwaiting_for_user_input_p ();
6685 /* We never need these events if we have no asynchronous subprocesses. */
6689 /* Make sure no interrupt happens while storing the event. */
6691 if (interrupt_input
)
6694 mask
= sigblock (sigmask (SIGIO
));
6695 kbd_buffer_store_event (&event
);
6702 kbd_buffer_store_event (&event
);
6709 /* Read any terminal input already buffered up by the system
6710 into the kbd_buffer, but do not wait.
6712 EXPECTED should be nonzero if the caller knows there is some input.
6714 Except on VMS, all input is read by this function.
6715 If interrupt_input is nonzero, this function MUST be called
6716 only when SIGIO is blocked.
6718 Returns the number of keyboard chars read, or -1 meaning
6719 this is a bad time to try to read input. */
6722 read_avail_input (expected
)
6728 if (read_socket_hook
)
6731 struct input_event hold_quit
;
6733 EVENT_INIT (hold_quit
);
6734 hold_quit
.kind
= NO_EVENT
;
6736 /* No need for FIONREAD or fcntl; just say don't wait. */
6737 while (nr
= (*read_socket_hook
) (input_fd
, expected
, &hold_quit
), nr
> 0)
6742 if (hold_quit
.kind
!= NO_EVENT
)
6743 kbd_buffer_store_event (&hold_quit
);
6747 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6748 the kbd_buffer can really hold. That may prevent loss
6749 of characters on some systems when input is stuffed at us. */
6750 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6753 /* Determine how many characters we should *try* to read. */
6756 #else /* not WINDOWSNT */
6758 n_to_read
= dos_keysns ();
6761 #else /* not MSDOS */
6763 /* Find out how much input is available. */
6764 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6765 /* Formerly simply reported no input, but that sometimes led to
6766 a failure of Emacs to terminate.
6767 SIGHUP seems appropriate if we can't reach the terminal. */
6768 /* ??? Is it really right to send the signal just to this process
6769 rather than to the whole process group?
6770 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6772 if (! noninteractive
)
6773 kill (getpid (), SIGHUP
);
6779 if (n_to_read
> sizeof cbuf
)
6780 n_to_read
= sizeof cbuf
;
6781 #else /* no FIONREAD */
6782 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6783 /* Read some input if available, but don't wait. */
6784 n_to_read
= sizeof cbuf
;
6785 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6790 #endif /* not MSDOS */
6791 #endif /* not WINDOWSNT */
6793 /* Now read; for one reason or another, this will not block.
6794 NREAD is set to the number of chars read. */
6798 cbuf
[0] = dos_keyread ();
6801 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6803 /* POSIX infers that processes which are not in the session leader's
6804 process group won't get SIGHUP's at logout time. BSDI adheres to
6805 this part standard and returns -1 from read (0) with errno==EIO
6806 when the control tty is taken away.
6807 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6808 if (nread
== -1 && errno
== EIO
)
6810 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6811 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6812 This looks incorrect, but it isn't, because _BSD causes
6813 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6814 and that causes a value other than 0 when there is no input. */
6820 /* We used to retry the read if it was interrupted.
6821 But this does the wrong thing when O_NDELAY causes
6822 an EAGAIN error. Does anybody know of a situation
6823 where a retry is actually needed? */
6825 nread
< 0 && (errno
== EAGAIN
6839 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6840 fcntl (input_fd
, F_SETFL
, 0);
6841 #endif /* USG or DGUX or CYGWIN */
6842 #endif /* no FIONREAD */
6843 for (i
= 0; i
< nread
; i
++)
6845 struct input_event buf
;
6847 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6849 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6850 buf
.modifiers
= meta_modifier
;
6855 buf
.frame_or_window
= selected_frame
;
6858 kbd_buffer_store_event (&buf
);
6859 /* Don't look at input that follows a C-g too closely.
6860 This reduces lossage due to autorepeat on C-g. */
6861 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6862 && buf
.code
== quit_char
)
6869 #endif /* not VMS */
6872 handle_async_input ()
6875 extern int select_alarmed
;
6878 interrupt_input_pending
= 0;
6883 nread
= read_avail_input (1);
6884 /* -1 means it's not ok to read the input now.
6885 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6886 0 means there was no keyboard input available. */
6891 select_alarmed
= 1; /* Force the select emulator back to life */
6896 #ifdef SIGIO /* for entire page */
6897 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6900 input_available_signal (signo
)
6903 /* Must preserve main program's value of errno. */
6904 int old_errno
= errno
;
6905 #if defined (USG) && !defined (POSIX_SIGNALS)
6906 /* USG systems forget handlers when they are used;
6907 must reestablish each time */
6908 signal (signo
, input_available_signal
);
6916 interrupt_input_pending
= 1;
6918 SIGNAL_THREAD_CHECK (signo
);
6921 if (input_available_clear_time
)
6922 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6925 handle_async_input ();
6935 /* Send ourselves a SIGIO.
6937 This function exists so that the UNBLOCK_INPUT macro in
6938 blockinput.h can have some way to take care of input we put off
6939 dealing with, without assuming that every file which uses
6940 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6942 reinvoke_input_signal ()
6945 handle_async_input ();
6951 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6952 static Lisp_Object menu_bar_one_keymap_changed_items
;
6954 /* These variables hold the vector under construction within
6955 menu_bar_items and its subroutines, and the current index
6956 for storing into that vector. */
6957 static Lisp_Object menu_bar_items_vector
;
6958 static int menu_bar_items_index
;
6960 /* Return a vector of menu items for a menu bar, appropriate
6961 to the current buffer. Each item has three elements in the vector:
6964 OLD is an old vector we can optionally reuse, or nil. */
6967 menu_bar_items (old
)
6970 /* The number of keymaps we're scanning right now, and the number of
6971 keymaps we have allocated space for. */
6974 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6975 in the current keymaps, or nil where it is not a prefix. */
6978 Lisp_Object def
, tail
;
6987 /* In order to build the menus, we need to call the keymap
6988 accessors. They all call QUIT. But this function is called
6989 during redisplay, during which a quit is fatal. So inhibit
6990 quitting while building the menus.
6991 We do this instead of specbind because (1) errors will clear it anyway
6992 and (2) this avoids risk of specpdl overflow. */
6993 oquit
= Vinhibit_quit
;
6997 menu_bar_items_vector
= old
;
6999 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7000 menu_bar_items_index
= 0;
7002 /* Build our list of keymaps.
7003 If we recognize a function key and replace its escape sequence in
7004 keybuf with its symbol, or if the sequence starts with a mouse
7005 click and we need to switch buffers, we jump back here to rebuild
7006 the initial keymaps from the current buffer. */
7010 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7011 if (!NILP (Voverriding_local_map_menu_flag
))
7013 /* Yes, use them (if non-nil) as well as the global map. */
7014 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7016 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7017 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7018 if (!NILP (Voverriding_local_map
))
7019 maps
[nmaps
++] = Voverriding_local_map
;
7023 /* No, so use major and minor mode keymaps and keymap property.
7024 Note that menu-bar bindings in the local-map and keymap
7025 properties may not work reliable, as they are only
7026 recognized when the menu-bar (or mode-line) is updated,
7027 which does not normally happen after every command. */
7030 nminor
= current_minor_maps (NULL
, &tmaps
);
7031 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7033 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7034 maps
[nmaps
++] = tem
;
7035 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7037 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7039 maps
[nmaps
++] = current_global_map
;
7042 /* Look up in each map the dummy prefix key `menu-bar'. */
7046 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7047 if (!NILP (maps
[mapno
]))
7049 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7053 menu_bar_one_keymap_changed_items
= Qnil
;
7054 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7058 /* Move to the end those items that should be at the end. */
7060 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7063 int end
= menu_bar_items_index
;
7065 for (i
= 0; i
< end
; i
+= 4)
7066 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7068 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7069 /* Move the item at index I to the end,
7070 shifting all the others forward. */
7071 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7072 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7073 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7074 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7076 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7077 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7078 (end
- i
- 4) * sizeof (Lisp_Object
));
7079 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7080 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7081 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7082 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7087 /* Add nil, nil, nil, nil at the end. */
7088 i
= menu_bar_items_index
;
7089 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7092 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7093 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7094 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7095 menu_bar_items_vector
= tem
;
7097 /* Add this item. */
7098 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7099 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7100 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7101 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7102 menu_bar_items_index
= i
;
7104 Vinhibit_quit
= oquit
;
7105 return menu_bar_items_vector
;
7108 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7109 If there's already an item for KEY, add this DEF to it. */
7111 Lisp_Object item_properties
;
7114 menu_bar_item (key
, item
, dummy1
, dummy2
)
7115 Lisp_Object key
, item
, dummy1
;
7118 struct gcpro gcpro1
;
7122 if (EQ (item
, Qundefined
))
7124 /* If a map has an explicit `undefined' as definition,
7125 discard any previously made menu bar item. */
7127 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7128 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7130 if (menu_bar_items_index
> i
+ 4)
7131 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7132 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7133 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7134 menu_bar_items_index
-= 4;
7138 /* If this keymap has already contributed to this KEY,
7139 don't contribute to it a second time. */
7140 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7141 if (!NILP (tem
) || NILP (item
))
7144 menu_bar_one_keymap_changed_items
7145 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7147 /* We add to menu_bar_one_keymap_changed_items before doing the
7148 parse_menu_item, so that if it turns out it wasn't a menu item,
7149 it still correctly hides any further menu item. */
7151 i
= parse_menu_item (item
, 0, 1);
7156 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7158 /* Find any existing item for this KEY. */
7159 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7160 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7163 /* If we did not find this KEY, add it at the end. */
7164 if (i
== menu_bar_items_index
)
7166 /* If vector is too small, get a bigger one. */
7167 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7170 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7171 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7172 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7173 menu_bar_items_vector
= tem
;
7176 /* Add this item. */
7177 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7178 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7179 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7180 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7181 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7182 menu_bar_items_index
= i
;
7184 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7188 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7189 /* If the new and the old items are not both keymaps,
7190 the lookup will only find `item'. */
7191 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7192 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7196 /* This is used as the handler when calling menu_item_eval_property. */
7198 menu_item_eval_property_1 (arg
)
7201 /* If we got a quit from within the menu computation,
7202 quit all the way out of it. This takes care of C-] in the debugger. */
7203 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7204 Fsignal (Qquit
, Qnil
);
7209 /* Evaluate an expression and return the result (or nil if something
7210 went wrong). Used to evaluate dynamic parts of menu items. */
7212 menu_item_eval_property (sexpr
)
7215 int count
= SPECPDL_INDEX ();
7217 specbind (Qinhibit_redisplay
, Qt
);
7218 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7219 menu_item_eval_property_1
);
7220 return unbind_to (count
, val
);
7223 /* This function parses a menu item and leaves the result in the
7224 vector item_properties.
7225 ITEM is a key binding, a possible menu item.
7226 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7227 evaluate dynamic expressions in the menu item.
7228 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7230 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7231 parse_menu_item returns true if the item is a menu item and false
7235 parse_menu_item (item
, notreal
, inmenubar
)
7237 int notreal
, inmenubar
;
7239 Lisp_Object def
, tem
, item_string
, start
;
7240 Lisp_Object cachelist
;
7242 Lisp_Object keyhint
;
7253 /* Create item_properties vector if necessary. */
7254 if (NILP (item_properties
))
7256 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7258 /* Initialize optional entries. */
7259 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7260 AREF (item_properties
, i
) = Qnil
;
7261 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7263 /* Save the item here to protect it from GC. */
7264 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7266 item_string
= XCAR (item
);
7270 if (STRINGP (item_string
))
7272 /* Old format menu item. */
7273 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7275 /* Maybe help string. */
7276 if (CONSP (item
) && STRINGP (XCAR (item
)))
7278 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7283 /* Maybe key binding cache. */
7284 if (CONSP (item
) && CONSP (XCAR (item
))
7285 && (NILP (XCAR (XCAR (item
)))
7286 || VECTORP (XCAR (XCAR (item
)))))
7288 cachelist
= XCAR (item
);
7292 /* This is the real definition--the function to run. */
7293 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7295 /* Get enable property, if any. */
7298 tem
= Fget (item
, Qmenu_enable
);
7299 if (!NILP (Venable_disabled_menus_and_buttons
))
7300 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7301 else if (!NILP (tem
))
7302 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7305 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7307 /* New format menu item. */
7308 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7309 start
= XCDR (item
);
7312 /* We have a real binding. */
7313 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7315 item
= XCDR (start
);
7316 /* Is there a cache list with key equivalences. */
7317 if (CONSP (item
) && CONSP (XCAR (item
)))
7319 cachelist
= XCAR (item
);
7323 /* Parse properties. */
7324 while (CONSP (item
) && CONSP (XCDR (item
)))
7329 if (EQ (tem
, QCenable
))
7331 if (!NILP (Venable_disabled_menus_and_buttons
))
7332 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7334 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7336 else if (EQ (tem
, QCvisible
) && !notreal
)
7338 /* If got a visible property and that evaluates to nil
7339 then ignore this item. */
7340 tem
= menu_item_eval_property (XCAR (item
));
7344 else if (EQ (tem
, QChelp
))
7345 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7346 else if (EQ (tem
, QCfilter
))
7348 else if (EQ (tem
, QCkey_sequence
))
7351 if (NILP (cachelist
)
7352 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7353 /* Be GC protected. Set keyhint to item instead of tem. */
7356 else if (EQ (tem
, QCkeys
))
7359 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7360 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7362 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7367 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7369 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7371 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7378 else if (inmenubar
|| !NILP (start
))
7382 return 0; /* not a menu item */
7384 /* If item string is not a string, evaluate it to get string.
7385 If we don't get a string, skip this item. */
7386 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7387 if (!(STRINGP (item_string
) || notreal
))
7389 item_string
= menu_item_eval_property (item_string
);
7390 if (!STRINGP (item_string
))
7392 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7395 /* If got a filter apply it on definition. */
7396 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7399 def
= menu_item_eval_property (list2 (XCAR (filter
),
7400 list2 (Qquote
, def
)));
7402 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7405 /* Enable or disable selection of item. */
7406 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7412 tem
= menu_item_eval_property (tem
);
7413 if (inmenubar
&& NILP (tem
))
7414 return 0; /* Ignore disabled items in menu bar. */
7415 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7418 /* If we got no definition, this item is just unselectable text which
7419 is OK in a submenu but not in the menubar. */
7421 return (inmenubar
? 0 : 1);
7423 /* See if this is a separate pane or a submenu. */
7424 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7425 tem
= get_keymap (def
, 0, 1);
7426 /* For a subkeymap, just record its details and exit. */
7429 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7430 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7434 /* At the top level in the menu bar, do likewise for commands also.
7435 The menu bar does not display equivalent key bindings anyway.
7436 ITEM_PROPERTY_DEF is already set up properly. */
7440 /* This is a command. See if there is an equivalent key binding. */
7441 if (NILP (cachelist
))
7443 /* We have to create a cachelist. */
7444 CHECK_IMPURE (start
);
7445 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7446 cachelist
= XCAR (XCDR (start
));
7448 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7449 if (!NILP (keyhint
))
7451 XSETCAR (cachelist
, XCAR (keyhint
));
7454 else if (STRINGP (tem
))
7456 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7457 XSETCAR (cachelist
, Qt
);
7461 tem
= XCAR (cachelist
);
7468 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7470 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7473 def
= XCAR (prefix
);
7474 prefix
= XCDR (prefix
);
7477 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7479 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7481 if (newcache
/* Always check first time. */
7482 /* Should we check everything when precomputing key
7484 /* If something had no key binding before, don't recheck it
7485 because that is too slow--except if we have a list of
7486 rebound commands in Vdefine_key_rebound_commands, do
7487 recheck any command that appears in that list. */
7488 || (CONSP (Vdefine_key_rebound_commands
)
7489 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7492 /* We had a saved key. Is it still bound to the command? */
7495 /* If the command is an alias for another
7496 (such as lmenu.el set it up), check if the
7497 original command matches the cached command. */
7498 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7499 chkcache
= 1; /* Need to recompute key binding. */
7503 /* Recompute equivalent key binding. If the command is an alias
7504 for another (such as lmenu.el set it up), see if the original
7505 command name has equivalent keys. Otherwise look up the
7506 specified command itself. We don't try both, because that
7507 makes lmenu menus slow. */
7509 && SYMBOLP (XSYMBOL (def
)->function
)
7510 && ! NILP (Fget (def
, Qmenu_alias
)))
7511 def
= XSYMBOL (def
)->function
;
7512 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7513 XSETCAR (cachelist
, tem
);
7516 XSETCDR (cachelist
, Qnil
);
7520 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7522 tem
= XCAR (cachelist
);
7526 newcache
= chkcache
;
7529 tem
= Fkey_description (tem
, Qnil
);
7532 if (STRINGP (XCAR (prefix
)))
7533 tem
= concat2 (XCAR (prefix
), tem
);
7534 if (STRINGP (XCDR (prefix
)))
7535 tem
= concat2 (tem
, XCDR (prefix
));
7537 XSETCDR (cachelist
, tem
);
7541 tem
= XCDR (cachelist
);
7542 if (newcache
&& !NILP (tem
))
7544 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7545 XSETCDR (cachelist
, tem
);
7548 /* If we only want to precompute equivalent key bindings, stop here. */
7552 /* If we have an equivalent key binding, use that. */
7553 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7555 /* Include this when menu help is implemented.
7556 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7557 if (!(NILP (tem) || STRINGP (tem)))
7559 tem = menu_item_eval_property (tem);
7562 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7566 /* Handle radio buttons or toggle boxes. */
7567 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7569 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7570 = menu_item_eval_property (tem
);
7577 /***********************************************************************
7579 ***********************************************************************/
7581 /* A vector holding tool bar items while they are parsed in function
7582 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7585 static Lisp_Object tool_bar_items_vector
;
7587 /* A vector holding the result of parse_tool_bar_item. Layout is like
7588 the one for a single item in tool_bar_items_vector. */
7590 static Lisp_Object tool_bar_item_properties
;
7592 /* Next free index in tool_bar_items_vector. */
7594 static int ntool_bar_items
;
7596 /* The symbols `tool-bar', and `:image'. */
7598 extern Lisp_Object Qtool_bar
;
7599 Lisp_Object QCimage
;
7601 /* Function prototypes. */
7603 static void init_tool_bar_items
P_ ((Lisp_Object
));
7604 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7605 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7606 static void append_tool_bar_item
P_ ((void));
7609 /* Return a vector of tool bar items for keymaps currently in effect.
7610 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7611 tool bar items found. */
7614 tool_bar_items (reuse
, nitems
)
7625 /* In order to build the menus, we need to call the keymap
7626 accessors. They all call QUIT. But this function is called
7627 during redisplay, during which a quit is fatal. So inhibit
7628 quitting while building the menus. We do this instead of
7629 specbind because (1) errors will clear it anyway and (2) this
7630 avoids risk of specpdl overflow. */
7631 oquit
= Vinhibit_quit
;
7634 /* Initialize tool_bar_items_vector and protect it from GC. */
7635 init_tool_bar_items (reuse
);
7637 /* Build list of keymaps in maps. Set nmaps to the number of maps
7640 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7641 if (!NILP (Voverriding_local_map_menu_flag
))
7643 /* Yes, use them (if non-nil) as well as the global map. */
7644 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7646 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7647 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7648 if (!NILP (Voverriding_local_map
))
7649 maps
[nmaps
++] = Voverriding_local_map
;
7653 /* No, so use major and minor mode keymaps and keymap property.
7654 Note that tool-bar bindings in the local-map and keymap
7655 properties may not work reliable, as they are only
7656 recognized when the tool-bar (or mode-line) is updated,
7657 which does not normally happen after every command. */
7660 nminor
= current_minor_maps (NULL
, &tmaps
);
7661 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7663 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7664 maps
[nmaps
++] = tem
;
7665 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7667 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7670 /* Add global keymap at the end. */
7671 maps
[nmaps
++] = current_global_map
;
7673 /* Process maps in reverse order and look up in each map the prefix
7675 for (i
= nmaps
- 1; i
>= 0; --i
)
7676 if (!NILP (maps
[i
]))
7680 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7682 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7685 Vinhibit_quit
= oquit
;
7686 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7687 return tool_bar_items_vector
;
7691 /* Process the definition of KEY which is DEF. */
7694 process_tool_bar_item (key
, def
, data
, args
)
7695 Lisp_Object key
, def
, data
;
7699 extern Lisp_Object Qundefined
;
7700 struct gcpro gcpro1
, gcpro2
;
7702 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7706 if (EQ (def
, Qundefined
))
7708 /* If a map has an explicit `undefined' as definition,
7709 discard any previously made item. */
7710 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7712 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7714 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7716 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7717 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7718 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7719 * sizeof (Lisp_Object
)));
7720 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7725 else if (parse_tool_bar_item (key
, def
))
7726 /* Append a new tool bar item to tool_bar_items_vector. Accept
7727 more than one definition for the same key. */
7728 append_tool_bar_item ();
7734 /* Parse a tool bar item specification ITEM for key KEY and return the
7735 result in tool_bar_item_properties. Value is zero if ITEM is
7738 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7740 CAPTION is the caption of the item, If it's not a string, it is
7741 evaluated to get a string.
7743 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7744 as binding are currently ignored.
7746 The following properties are recognized:
7750 FORM is evaluated and specifies whether the tool bar item is
7751 enabled or disabled.
7755 FORM is evaluated and specifies whether the tool bar item is visible.
7757 - `:filter FUNCTION'
7759 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7760 result is stored as the new binding.
7762 - `:button (TYPE SELECTED)'
7764 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7765 and specifies whether the button is selected (pressed) or not.
7769 IMAGES is either a single image specification or a vector of four
7770 image specifications. See enum tool_bar_item_images.
7772 - `:help HELP-STRING'.
7774 Gives a help string to display for the tool bar item. */
7777 parse_tool_bar_item (key
, item
)
7778 Lisp_Object key
, item
;
7780 /* Access slot with index IDX of vector tool_bar_item_properties. */
7781 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7783 Lisp_Object filter
= Qnil
;
7784 Lisp_Object caption
;
7787 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7788 Rule out items that aren't lists, don't start with
7789 `menu-item' or whose rest following `tool-bar-item' is not a
7792 || !EQ (XCAR (item
), Qmenu_item
)
7793 || (item
= XCDR (item
),
7797 /* Create tool_bar_item_properties vector if necessary. Reset it to
7799 if (VECTORP (tool_bar_item_properties
))
7801 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7805 tool_bar_item_properties
7806 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7809 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7810 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7812 /* Get the caption of the item. If the caption is not a string,
7813 evaluate it to get a string. If we don't get a string, skip this
7815 caption
= XCAR (item
);
7816 if (!STRINGP (caption
))
7818 caption
= menu_item_eval_property (caption
);
7819 if (!STRINGP (caption
))
7822 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7824 /* Give up if rest following the caption is not a list. */
7829 /* Store the binding. */
7830 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7833 /* Ignore cached key binding, if any. */
7834 if (CONSP (item
) && CONSP (XCAR (item
)))
7837 /* Process the rest of the properties. */
7838 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7840 Lisp_Object key
, value
;
7843 value
= XCAR (XCDR (item
));
7845 if (EQ (key
, QCenable
))
7847 /* `:enable FORM'. */
7848 if (!NILP (Venable_disabled_menus_and_buttons
))
7849 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7851 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7853 else if (EQ (key
, QCvisible
))
7855 /* `:visible FORM'. If got a visible property and that
7856 evaluates to nil then ignore this item. */
7857 if (NILP (menu_item_eval_property (value
)))
7860 else if (EQ (key
, QChelp
))
7861 /* `:help HELP-STRING'. */
7862 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7863 else if (EQ (key
, QCfilter
))
7864 /* ':filter FORM'. */
7866 else if (EQ (key
, QCbutton
) && CONSP (value
))
7868 /* `:button (TYPE . SELECTED)'. */
7869 Lisp_Object type
, selected
;
7871 type
= XCAR (value
);
7872 selected
= XCDR (value
);
7873 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7875 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7876 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7879 else if (EQ (key
, QCimage
)
7881 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7882 /* Value is either a single image specification or a vector
7883 of 4 such specifications for the different button states. */
7884 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7887 /* If got a filter apply it on binding. */
7889 PROP (TOOL_BAR_ITEM_BINDING
)
7890 = menu_item_eval_property (list2 (filter
,
7892 PROP (TOOL_BAR_ITEM_BINDING
))));
7894 /* See if the binding is a keymap. Give up if it is. */
7895 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7898 /* Enable or disable selection of item. */
7899 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7900 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7901 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7903 /* Handle radio buttons or toggle boxes. */
7904 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7905 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7906 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7914 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7915 that can be reused. */
7918 init_tool_bar_items (reuse
)
7921 if (VECTORP (reuse
))
7922 tool_bar_items_vector
= reuse
;
7924 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7925 ntool_bar_items
= 0;
7929 /* Append parsed tool bar item properties from
7930 tool_bar_item_properties */
7933 append_tool_bar_item ()
7935 Lisp_Object
*to
, *from
;
7937 /* Enlarge tool_bar_items_vector if necessary. */
7938 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7939 >= XVECTOR (tool_bar_items_vector
)->size
)
7941 Lisp_Object new_vector
;
7942 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7944 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7945 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7946 XVECTOR (new_vector
)->contents
,
7947 old_size
* sizeof (Lisp_Object
));
7948 tool_bar_items_vector
= new_vector
;
7951 /* Append entries from tool_bar_item_properties to the end of
7952 tool_bar_items_vector. */
7953 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7954 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7955 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7956 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7963 /* Read a character using menus based on maps in the array MAPS.
7964 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7965 Return t if we displayed a menu but the user rejected it.
7967 PREV_EVENT is the previous input event, or nil if we are reading
7968 the first event of a key sequence.
7970 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7971 if we used a mouse menu to read the input, or zero otherwise. If
7972 USED_MOUSE_MENU is null, we don't dereference it.
7974 The prompting is done based on the prompt-string of the map
7975 and the strings associated with various map elements.
7977 This can be done with X menus or with menus put in the minibuf.
7978 These are done in different ways, depending on how the input will be read.
7979 Menus using X are done after auto-saving in read-char, getting the input
7980 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7981 and do auto-saving in the inner call of read_char. */
7984 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7987 Lisp_Object prev_event
;
7988 int *used_mouse_menu
;
7991 register Lisp_Object name
= Qnil
;
7993 if (used_mouse_menu
)
7994 *used_mouse_menu
= 0;
7996 /* Use local over global Menu maps */
7998 if (! menu_prompting
)
8001 /* Optionally disregard all but the global map. */
8002 if (inhibit_local_menu_bar_menus
)
8004 maps
+= (nmaps
- 1);
8008 /* Get the menu name from the first map that has one (a prompt string). */
8009 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8011 name
= Fkeymap_prompt (maps
[mapno
]);
8016 /* If we don't have any menus, just read a character normally. */
8017 if (!STRINGP (name
))
8021 /* If we got to this point via a mouse click,
8022 use a real menu for mouse selection. */
8023 if (EVENT_HAS_PARAMETERS (prev_event
)
8024 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8025 && !EQ (XCAR (prev_event
), Qtool_bar
))
8027 /* Display the menu and get the selection. */
8028 Lisp_Object
*realmaps
8029 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8033 /* Use the maps that are not nil. */
8034 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8035 if (!NILP (maps
[mapno
]))
8036 realmaps
[nmaps1
++] = maps
[mapno
];
8038 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8043 record_menu_key (XCAR (value
));
8045 /* If we got multiple events, unread all but
8047 There is no way to prevent those unread events
8048 from showing up later in last_nonmenu_event.
8049 So turn symbol and integer events into lists,
8050 to indicate that they came from a mouse menu,
8051 so that when present in last_nonmenu_event
8052 they won't confuse things. */
8053 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8055 record_menu_key (XCAR (tem
));
8056 if (SYMBOLP (XCAR (tem
))
8057 || INTEGERP (XCAR (tem
)))
8058 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8061 /* If we got more than one event, put all but the first
8062 onto this list to be read later.
8063 Return just the first event now. */
8064 Vunread_command_events
8065 = nconc2 (XCDR (value
), Vunread_command_events
);
8066 value
= XCAR (value
);
8068 else if (NILP (value
))
8070 if (used_mouse_menu
)
8071 *used_mouse_menu
= 1;
8074 #endif /* HAVE_MENUS */
8078 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8079 We make this bigger when necessary, and never free it. */
8080 static char *read_char_minibuf_menu_text
;
8081 /* Size of that buffer. */
8082 static int read_char_minibuf_menu_width
;
8085 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8091 register Lisp_Object name
;
8093 /* FIXME: Use the minibuffer's frame width. */
8094 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8097 Lisp_Object rest
, vector
;
8103 if (! menu_prompting
)
8106 /* Make sure we have a big enough buffer for the menu text. */
8107 if (read_char_minibuf_menu_text
== 0)
8109 read_char_minibuf_menu_width
= width
+ 4;
8110 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8112 else if (width
+ 4 > read_char_minibuf_menu_width
)
8114 read_char_minibuf_menu_width
= width
+ 4;
8115 read_char_minibuf_menu_text
8116 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8118 menu
= read_char_minibuf_menu_text
;
8120 /* Get the menu name from the first map that has one (a prompt string). */
8121 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8123 name
= Fkeymap_prompt (maps
[mapno
]);
8128 /* If we don't have any menus, just read a character normally. */
8129 if (!STRINGP (name
))
8132 /* Prompt string always starts with map's prompt, and a space. */
8133 strcpy (menu
, SDATA (name
));
8134 nlength
= SBYTES (name
);
8135 menu
[nlength
++] = ':';
8136 menu
[nlength
++] = ' ';
8139 /* Start prompting at start of first map. */
8143 /* Present the documented bindings, a line at a time. */
8150 Lisp_Object orig_defn_macro
;
8152 /* Loop over elements of map. */
8157 /* If reached end of map, start at beginning of next map. */
8161 /* At end of last map, wrap around to first map if just starting,
8162 or end this line if already have something on it. */
8166 if (notfirst
|| nobindings
) break;
8171 /* Look at the next element of the map. */
8173 elt
= XVECTOR (vector
)->contents
[idx
];
8175 elt
= Fcar_safe (rest
);
8177 if (idx
< 0 && VECTORP (elt
))
8179 /* If we found a dense table in the keymap,
8180 advanced past it, but start scanning its contents. */
8181 rest
= Fcdr_safe (rest
);
8187 /* An ordinary element. */
8188 Lisp_Object event
, tem
;
8192 event
= Fcar_safe (elt
); /* alist */
8193 elt
= Fcdr_safe (elt
);
8197 XSETINT (event
, idx
); /* vector */
8200 /* Ignore the element if it has no prompt string. */
8201 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8203 /* 1 if the char to type matches the string. */
8205 Lisp_Object upcased_event
, downcased_event
;
8206 Lisp_Object desc
= Qnil
;
8208 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8210 upcased_event
= Fupcase (event
);
8211 downcased_event
= Fdowncase (event
);
8212 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8213 || XINT (downcased_event
) == SREF (s
, 0));
8215 desc
= Fsingle_key_description (event
, Qnil
);
8217 #if 0 /* It is redundant to list the equivalent key bindings because
8218 the prefix is what the user has already typed. */
8220 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8222 /* Insert equivalent keybinding. */
8223 s
= concat2 (s
, tem
);
8226 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8227 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8229 /* Insert button prefix. */
8230 Lisp_Object selected
8231 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8232 if (EQ (tem
, QCradio
))
8233 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8235 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8236 s
= concat2 (tem
, s
);
8240 /* If we have room for the prompt string, add it to this line.
8241 If this is the first on the line, always add it. */
8242 if ((SCHARS (s
) + i
+ 2
8243 + (char_matches
? 0 : SCHARS (desc
) + 3))
8249 /* Punctuate between strings. */
8252 strcpy (menu
+ i
, ", ");
8258 /* If the char to type doesn't match the string's
8259 first char, explicitly show what char to type. */
8262 /* Add as much of string as fits. */
8263 thiswidth
= SCHARS (desc
);
8264 if (thiswidth
+ i
> width
)
8265 thiswidth
= width
- i
;
8266 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8268 strcpy (menu
+ i
, " = ");
8272 /* Add as much of string as fits. */
8273 thiswidth
= SCHARS (s
);
8274 if (thiswidth
+ i
> width
)
8275 thiswidth
= width
- i
;
8276 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8282 /* If this element does not fit, end the line now,
8283 and save the element for the next line. */
8284 strcpy (menu
+ i
, "...");
8289 /* Move past this element. */
8290 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8291 /* Handle reaching end of dense table. */
8296 rest
= Fcdr_safe (rest
);
8300 /* Prompt with that and read response. */
8301 message2_nolog (menu
, strlen (menu
),
8302 ! NILP (current_buffer
->enable_multibyte_characters
));
8304 /* Make believe its not a keyboard macro in case the help char
8305 is pressed. Help characters are not recorded because menu prompting
8306 is not used on replay.
8308 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8309 current_kboard
->defining_kbd_macro
= Qnil
;
8311 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8312 while (BUFFERP (obj
));
8313 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8315 if (!INTEGERP (obj
))
8320 if (! EQ (obj
, menu_prompt_more_char
)
8321 && (!INTEGERP (menu_prompt_more_char
)
8322 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8324 if (!NILP (current_kboard
->defining_kbd_macro
))
8325 store_kbd_macro_char (obj
);
8328 /* Help char - go round again */
8332 /* Reading key sequences. */
8334 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8335 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8336 keymap, or nil otherwise. Return the index of the first keymap in
8337 which KEY has any binding, or NMAPS if no map has a binding.
8339 If KEY is a meta ASCII character, treat it like meta-prefix-char
8340 followed by the corresponding non-meta character. Keymaps in
8341 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8344 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8347 NEXT may be the same array as CURRENT. */
8350 follow_key (key
, nmaps
, current
, defs
, next
)
8352 Lisp_Object
*current
, *defs
, *next
;
8355 int i
, first_binding
;
8357 first_binding
= nmaps
;
8358 for (i
= nmaps
- 1; i
>= 0; i
--)
8360 if (! NILP (current
[i
]))
8362 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8363 if (! NILP (defs
[i
]))
8370 /* Given the set of bindings we've found, produce the next set of maps. */
8371 if (first_binding
< nmaps
)
8372 for (i
= 0; i
< nmaps
; i
++)
8373 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8375 return first_binding
;
8378 /* Structure used to keep track of partial application of key remapping
8379 such as Vfunction_key_map and Vkey_translation_map. */
8380 typedef struct keyremap
8382 Lisp_Object map
, parent
;
8386 /* Lookup KEY in MAP.
8387 MAP is a keymap mapping keys to key vectors or functions.
8388 If the mapping is a function and DO_FUNCTION is non-zero, then
8389 the function is called with PROMPT as parameter and its return
8390 value is used as the return value of this function (after checking
8391 that it is indeed a vector). */
8394 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8395 Lisp_Object map
, key
, prompt
;
8400 next
= access_keymap (map
, key
, 1, 0, 1);
8402 /* Handle symbol with autoload definition. */
8403 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8404 && CONSP (XSYMBOL (next
)->function
)
8405 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8406 do_autoload (XSYMBOL (next
)->function
, next
);
8408 /* Handle a symbol whose function definition is a keymap
8410 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8411 && (ARRAYP (XSYMBOL (next
)->function
)
8412 || KEYMAPP (XSYMBOL (next
)->function
)))
8413 next
= XSYMBOL (next
)->function
;
8415 /* If the keymap gives a function, not an
8416 array, then call the function with one arg and use
8417 its value instead. */
8418 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8423 next
= call1 (next
, prompt
);
8424 /* If the function returned something invalid,
8425 barf--don't ignore it.
8426 (To ignore it safely, we would need to gcpro a bunch of
8427 other variables.) */
8428 if (! (VECTORP (next
) || STRINGP (next
)))
8429 error ("Function %s returns invalid key sequence", tem
);
8434 /* Do one step of the key remapping used for function-key-map and
8435 key-translation-map:
8436 KEYBUF is the buffer holding the input events.
8437 BUFSIZE is its maximum size.
8438 FKEY is a pointer to the keyremap structure to use.
8439 INPUT is the index of the last element in KEYBUF.
8440 DOIT if non-zero says that the remapping can actually take place.
8441 DIFF is used to return the number of keys added/removed by the remapping.
8442 PARENT is the root of the keymap.
8443 PROMPT is the prompt to use if the remapping happens through a function.
8444 The return value is non-zero if the remapping actually took place. */
8447 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8448 Lisp_Object
*keybuf
, prompt
;
8450 int input
, doit
, *diff
, bufsize
;
8452 Lisp_Object next
, key
;
8454 key
= keybuf
[fkey
->end
++];
8455 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8457 /* If keybuf[fkey->start..fkey->end] is bound in the
8458 map and we're in a position to do the key remapping, replace it with
8459 the binding and restart with fkey->start at the end. */
8460 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8462 int len
= XFASTINT (Flength (next
));
8465 *diff
= len
- (fkey
->end
- fkey
->start
);
8467 if (input
+ *diff
>= bufsize
)
8468 error ("Key sequence too long");
8470 /* Shift the keys that follow fkey->end. */
8472 for (i
= fkey
->end
; i
< input
; i
++)
8473 keybuf
[i
+ *diff
] = keybuf
[i
];
8475 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8476 keybuf
[i
+ *diff
] = keybuf
[i
];
8477 /* Overwrite the old keys with the new ones. */
8478 for (i
= 0; i
< len
; i
++)
8479 keybuf
[fkey
->start
+ i
]
8480 = Faref (next
, make_number (i
));
8482 fkey
->start
= fkey
->end
+= *diff
;
8483 fkey
->map
= fkey
->parent
;
8488 fkey
->map
= get_keymap (next
, 0, 1);
8490 /* If we no longer have a bound suffix, try a new position for
8492 if (!CONSP (fkey
->map
))
8494 fkey
->end
= ++fkey
->start
;
8495 fkey
->map
= fkey
->parent
;
8500 /* Read a sequence of keys that ends with a non prefix character,
8501 storing it in KEYBUF, a buffer of size BUFSIZE.
8503 Return the length of the key sequence stored.
8504 Return -1 if the user rejected a command menu.
8506 Echo starting immediately unless `prompt' is 0.
8508 Where a key sequence ends depends on the currently active keymaps.
8509 These include any minor mode keymaps active in the current buffer,
8510 the current buffer's local map, and the global map.
8512 If a key sequence has no other bindings, we check Vfunction_key_map
8513 to see if some trailing subsequence might be the beginning of a
8514 function key's sequence. If so, we try to read the whole function
8515 key, and substitute its symbolic name into the key sequence.
8517 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8518 `double-' events into similar click events, if that would make them
8519 bound. We try to turn `triple-' events first into `double-' events,
8522 If we get a mouse click in a mode line, vertical divider, or other
8523 non-text area, we treat the click as if it were prefixed by the
8524 symbol denoting that area - `mode-line', `vertical-line', or
8527 If the sequence starts with a mouse click, we read the key sequence
8528 with respect to the buffer clicked on, not the current buffer.
8530 If the user switches frames in the midst of a key sequence, we put
8531 off the switch-frame event until later; the next call to
8532 read_char will return it.
8534 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8535 from the selected window's buffer. */
8538 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8539 can_return_switch_frame
, fix_current_buffer
)
8540 Lisp_Object
*keybuf
;
8543 int dont_downcase_last
;
8544 int can_return_switch_frame
;
8545 int fix_current_buffer
;
8547 volatile Lisp_Object from_string
;
8548 volatile int count
= SPECPDL_INDEX ();
8550 /* How many keys there are in the current key sequence. */
8553 /* The length of the echo buffer when we started reading, and
8554 the length of this_command_keys when we started reading. */
8555 volatile int echo_start
;
8556 volatile int keys_start
;
8558 /* The number of keymaps we're scanning right now, and the number of
8559 keymaps we have allocated space for. */
8561 volatile int nmaps_allocated
= 0;
8563 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8564 the current keymaps. */
8565 Lisp_Object
*volatile defs
= NULL
;
8567 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8568 in the current keymaps, or nil where it is not a prefix. */
8569 Lisp_Object
*volatile submaps
= NULL
;
8571 /* The local map to start out with at start of key sequence. */
8572 volatile Lisp_Object orig_local_map
;
8574 /* The map from the `keymap' property to start out with at start of
8576 volatile Lisp_Object orig_keymap
;
8578 /* 1 if we have already considered switching to the local-map property
8579 of the place where a mouse click occurred. */
8580 volatile int localized_local_map
= 0;
8582 /* The index in defs[] of the first keymap that has a binding for
8583 this key sequence. In other words, the lowest i such that
8584 defs[i] is non-nil. */
8585 volatile int first_binding
;
8586 /* Index of the first key that has no binding.
8587 It is useless to try fkey.start larger than that. */
8588 volatile int first_unbound
;
8590 /* If t < mock_input, then KEYBUF[t] should be read as the next
8593 We use this to recover after recognizing a function key. Once we
8594 realize that a suffix of the current key sequence is actually a
8595 function key's escape sequence, we replace the suffix with the
8596 function key's binding from Vfunction_key_map. Now keybuf
8597 contains a new and different key sequence, so the echo area,
8598 this_command_keys, and the submaps and defs arrays are wrong. In
8599 this situation, we set mock_input to t, set t to 0, and jump to
8600 restart_sequence; the loop will read keys from keybuf up until
8601 mock_input, thus rebuilding the state; and then it will resume
8602 reading characters from the keyboard. */
8603 volatile int mock_input
= 0;
8605 /* If the sequence is unbound in submaps[], then
8606 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8607 and fkey.map is its binding.
8609 These might be > t, indicating that all function key scanning
8610 should hold off until t reaches them. We do this when we've just
8611 recognized a function key, to avoid searching for the function
8612 key's again in Vfunction_key_map. */
8613 volatile keyremap fkey
;
8615 /* Likewise, for key_translation_map. */
8616 volatile keyremap keytran
;
8618 /* If we receive a `switch-frame' or `select-window' event in the middle of
8619 a key sequence, we put it off for later.
8620 While we're reading, we keep the event here. */
8621 volatile Lisp_Object delayed_switch_frame
;
8623 /* See the comment below... */
8624 #if defined (GOBBLE_FIRST_EVENT)
8625 Lisp_Object first_event
;
8628 volatile Lisp_Object original_uppercase
;
8629 volatile int original_uppercase_position
= -1;
8631 /* Gets around Microsoft compiler limitations. */
8634 struct buffer
*starting_buffer
;
8636 /* List of events for which a fake prefix key has been generated. */
8637 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8639 #if defined (GOBBLE_FIRST_EVENT)
8643 struct gcpro gcpro1
;
8645 GCPRO1 (fake_prefixed_keys
);
8646 raw_keybuf_count
= 0;
8648 last_nonmenu_event
= Qnil
;
8650 delayed_switch_frame
= Qnil
;
8651 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8652 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8653 /* If there is no translation-map, turn off scanning. */
8654 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8655 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8660 echo_prompt (prompt
);
8661 else if (cursor_in_echo_area
8662 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8663 && NILP (Fzerop (Vecho_keystrokes
)))
8664 /* This doesn't put in a dash if the echo buffer is empty, so
8665 you don't always see a dash hanging out in the minibuffer. */
8669 /* Record the initial state of the echo area and this_command_keys;
8670 we will need to restore them if we replay a key sequence. */
8672 echo_start
= echo_length ();
8673 keys_start
= this_command_key_count
;
8674 this_single_command_key_start
= keys_start
;
8676 #if defined (GOBBLE_FIRST_EVENT)
8677 /* This doesn't quite work, because some of the things that read_char
8678 does cannot safely be bypassed. It seems too risky to try to make
8681 /* Read the first char of the sequence specially, before setting
8682 up any keymaps, in case a filter runs and switches buffers on us. */
8683 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8685 #endif /* GOBBLE_FIRST_EVENT */
8687 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8688 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8691 /* We jump here when the key sequence has been thoroughly changed, and
8692 we need to rescan it starting from the beginning. When we jump here,
8693 keybuf[0..mock_input] holds the sequence we should reread. */
8696 starting_buffer
= current_buffer
;
8697 first_unbound
= bufsize
+ 1;
8699 /* Build our list of keymaps.
8700 If we recognize a function key and replace its escape sequence in
8701 keybuf with its symbol, or if the sequence starts with a mouse
8702 click and we need to switch buffers, we jump back here to rebuild
8703 the initial keymaps from the current buffer. */
8706 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8707 || !NILP (Voverriding_local_map
))
8709 if (3 > nmaps_allocated
)
8711 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8712 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8713 nmaps_allocated
= 3;
8715 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8716 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8717 if (!NILP (Voverriding_local_map
))
8718 submaps
[nmaps
++] = Voverriding_local_map
;
8726 nminor
= current_minor_maps (0, &maps
);
8727 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8729 if (total
> nmaps_allocated
)
8731 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8732 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8733 nmaps_allocated
= total
;
8736 if (!NILP (orig_keymap
))
8737 submaps
[nmaps
++] = orig_keymap
;
8739 bcopy (maps
, (void *) (submaps
+ nmaps
),
8740 nminor
* sizeof (submaps
[0]));
8744 submaps
[nmaps
++] = orig_local_map
;
8746 submaps
[nmaps
++] = current_global_map
;
8748 /* Find an accurate initial value for first_binding. */
8749 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8750 if (! NILP (submaps
[first_binding
]))
8753 /* Start from the beginning in keybuf. */
8756 /* These are no-ops the first time through, but if we restart, they
8757 revert the echo area and this_command_keys to their original state. */
8758 this_command_key_count
= keys_start
;
8759 if (INTERACTIVE
&& t
< mock_input
)
8760 echo_truncate (echo_start
);
8762 /* If the best binding for the current key sequence is a keymap, or
8763 we may be looking at a function key's escape sequence, keep on
8765 while (first_binding
< nmaps
8766 /* Keep reading as long as there's a prefix binding. */
8767 ? !NILP (submaps
[first_binding
])
8768 /* Don't return in the middle of a possible function key sequence,
8769 if the only bindings we found were via case conversion.
8770 Thus, if ESC O a has a function-key-map translation
8771 and ESC o has a binding, don't return after ESC O,
8772 so that we can translate ESC O plus the next character. */
8773 : (fkey
.start
< t
|| keytran
.start
< t
))
8776 int used_mouse_menu
= 0;
8778 /* Where the last real key started. If we need to throw away a
8779 key that has expanded into more than one element of keybuf
8780 (say, a mouse click on the mode line which is being treated
8781 as [mode-line (mouse-...)], then we backtrack to this point
8783 volatile int last_real_key_start
;
8785 /* These variables are analogous to echo_start and keys_start;
8786 while those allow us to restart the entire key sequence,
8787 echo_local_start and keys_local_start allow us to throw away
8789 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8791 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8792 eassert (fkey
.start
<= fkey
.end
);
8793 eassert (keytran
.start
<= keytran
.end
);
8794 /* key-translation-map is applied *after* function-key-map. */
8795 eassert (keytran
.end
<= fkey
.start
);
8797 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8798 { /* The prefix upto first_unbound has no binding and has
8799 no translation left to do either, so we know it's unbound.
8800 If we don't stop now, we risk staying here indefinitely
8801 (if the user keeps entering fkey or keytran prefixes
8802 like C-c ESC ESC ESC ESC ...) */
8804 for (i
= first_unbound
+ 1; i
< t
; i
++)
8805 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8806 mock_input
= t
- first_unbound
- 1;
8807 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8808 fkey
.map
= fkey
.parent
;
8809 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8810 keytran
.map
= keytran
.parent
;
8811 goto replay_sequence
;
8815 error ("Key sequence too long");
8818 echo_local_start
= echo_length ();
8819 keys_local_start
= this_command_key_count
;
8820 local_first_binding
= first_binding
;
8823 /* These are no-ops, unless we throw away a keystroke below and
8824 jumped back up to replay_key; in that case, these restore the
8825 variables to their original state, allowing us to replay the
8827 if (INTERACTIVE
&& t
< mock_input
)
8828 echo_truncate (echo_local_start
);
8829 this_command_key_count
= keys_local_start
;
8830 first_binding
= local_first_binding
;
8832 /* By default, assume each event is "real". */
8833 last_real_key_start
= t
;
8835 /* Does mock_input indicate that we are re-reading a key sequence? */
8839 add_command_key (key
);
8840 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8841 && NILP (Fzerop (Vecho_keystrokes
)))
8845 /* If not, we should actually read a character. */
8850 KBOARD
*interrupted_kboard
= current_kboard
;
8851 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8852 if (setjmp (wrong_kboard_jmpbuf
))
8854 if (!NILP (delayed_switch_frame
))
8856 interrupted_kboard
->kbd_queue
8857 = Fcons (delayed_switch_frame
,
8858 interrupted_kboard
->kbd_queue
);
8859 delayed_switch_frame
= Qnil
;
8862 interrupted_kboard
->kbd_queue
8863 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8865 /* If the side queue is non-empty, ensure it begins with a
8866 switch-frame, so we'll replay it in the right context. */
8867 if (CONSP (interrupted_kboard
->kbd_queue
)
8868 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8869 !(EVENT_HAS_PARAMETERS (key
)
8870 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8874 XSETFRAME (frame
, interrupted_frame
);
8875 interrupted_kboard
->kbd_queue
8876 = Fcons (make_lispy_switch_frame (frame
),
8877 interrupted_kboard
->kbd_queue
);
8880 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8881 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8882 goto replay_sequence
;
8885 key
= read_char (NILP (prompt
), nmaps
,
8886 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8887 &used_mouse_menu
, NULL
);
8890 /* read_char returns t when it shows a menu and the user rejects it.
8894 unbind_to (count
, Qnil
);
8899 /* read_char returns -1 at the end of a macro.
8900 Emacs 18 handles this by returning immediately with a
8901 zero, so that's what we'll do. */
8902 if (INTEGERP (key
) && XINT (key
) == -1)
8905 /* The Microsoft C compiler can't handle the goto that
8911 /* If the current buffer has been changed from under us, the
8912 keymap may have changed, so replay the sequence. */
8915 timer_resume_idle ();
8918 /* Reset the current buffer from the selected window
8919 in case something changed the former and not the latter.
8920 This is to be more consistent with the behavior
8921 of the command_loop_1. */
8922 if (fix_current_buffer
)
8924 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8926 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8927 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8930 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8931 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8932 goto replay_sequence
;
8935 /* If we have a quit that was typed in another frame, and
8936 quit_throw_to_read_char switched buffers,
8937 replay to get the right keymap. */
8939 && XINT (key
) == quit_char
8940 && current_buffer
!= starting_buffer
)
8943 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8947 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8948 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8949 goto replay_sequence
;
8954 if (EVENT_HAS_PARAMETERS (key
)
8955 /* Either a `switch-frame' or a `select-window' event. */
8956 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8958 /* If we're at the beginning of a key sequence, and the caller
8959 says it's okay, go ahead and return this event. If we're
8960 in the midst of a key sequence, delay it until the end. */
8961 if (t
> 0 || !can_return_switch_frame
)
8963 delayed_switch_frame
= key
;
8969 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8972 /* Clicks in non-text areas get prefixed by the symbol
8973 in their CHAR-ADDRESS field. For example, a click on
8974 the mode line is prefixed by the symbol `mode-line'.
8976 Furthermore, key sequences beginning with mouse clicks
8977 are read using the keymaps of the buffer clicked on, not
8978 the current buffer. So we may have to switch the buffer
8981 When we turn one event into two events, we must make sure
8982 that neither of the two looks like the original--so that,
8983 if we replay the events, they won't be expanded again.
8984 If not for this, such reexpansion could happen either here
8985 or when user programs play with this-command-keys. */
8986 if (EVENT_HAS_PARAMETERS (key
))
8991 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8992 if (EQ (kind
, Qmouse_click
))
8994 Lisp_Object window
, posn
;
8996 window
= POSN_WINDOW (EVENT_START (key
));
8997 posn
= POSN_POSN (EVENT_START (key
));
9000 || (!NILP (fake_prefixed_keys
)
9001 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9003 /* We're looking a second time at an event for which
9004 we generated a fake prefix key. Set
9005 last_real_key_start appropriately. */
9007 last_real_key_start
= t
- 1;
9010 /* Key sequences beginning with mouse clicks are
9011 read using the keymaps in the buffer clicked on,
9012 not the current buffer. If we're at the
9013 beginning of a key sequence, switch buffers. */
9014 if (last_real_key_start
== 0
9016 && BUFFERP (XWINDOW (window
)->buffer
)
9017 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9019 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9023 /* Arrange to go back to the original buffer once we're
9024 done reading the key sequence. Note that we can't
9025 use save_excursion_{save,restore} here, because they
9026 save point as well as the current buffer; we don't
9027 want to save point, because redisplay may change it,
9028 to accommodate a Fset_window_start or something. We
9029 don't want to do this at the top of the function,
9030 because we may get input from a subprocess which
9031 wants to change the selected window and stuff (say,
9033 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9035 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9037 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9038 orig_local_map
= get_local_map (PT
, current_buffer
,
9040 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9041 goto replay_sequence
;
9044 /* For a mouse click, get the local text-property keymap
9045 of the place clicked on, rather than point. */
9046 if (last_real_key_start
== 0
9047 && CONSP (XCDR (key
))
9048 && ! localized_local_map
)
9050 Lisp_Object map_here
, start
, pos
;
9052 localized_local_map
= 1;
9053 start
= EVENT_START (key
);
9055 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9057 pos
= POSN_BUFFER_POSN (start
);
9059 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9061 map_here
= get_local_map (XINT (pos
),
9062 current_buffer
, Qlocal_map
);
9063 if (!EQ (map_here
, orig_local_map
))
9065 orig_local_map
= map_here
;
9069 goto replay_sequence
;
9071 map_here
= get_local_map (XINT (pos
),
9072 current_buffer
, Qkeymap
);
9073 if (!EQ (map_here
, orig_keymap
))
9075 orig_keymap
= map_here
;
9079 goto replay_sequence
;
9085 /* Expand mode-line and scroll-bar events into two events:
9086 use posn as a fake prefix key. */
9088 && (NILP (fake_prefixed_keys
)
9089 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9091 if (t
+ 1 >= bufsize
)
9092 error ("Key sequence too long");
9095 keybuf
[t
+ 1] = key
;
9098 /* Record that a fake prefix key has been generated
9099 for KEY. Don't modify the event; this would
9100 prevent proper action when the event is pushed
9101 back into unread-command-events. */
9102 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9104 /* If on a mode line string with a local keymap,
9105 reconsider the key sequence with that keymap. */
9106 if (string
= POSN_STRING (EVENT_START (key
)),
9107 (CONSP (string
) && STRINGP (XCAR (string
))))
9109 Lisp_Object pos
, map
, map2
;
9111 pos
= XCDR (string
);
9112 string
= XCAR (string
);
9114 && XINT (pos
) < SCHARS (string
))
9116 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9118 orig_local_map
= map
;
9119 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9122 if (!NILP (map
) || !NILP (map2
))
9123 goto replay_sequence
;
9129 else if (NILP (from_string
)
9130 && (string
= POSN_STRING (EVENT_START (key
)),
9131 (CONSP (string
) && STRINGP (XCAR (string
)))))
9133 /* For a click on a string, i.e. overlay string or a
9134 string displayed via the `display' property,
9135 consider `local-map' and `keymap' properties of
9137 Lisp_Object pos
, map
, map2
;
9139 pos
= XCDR (string
);
9140 string
= XCAR (string
);
9142 && XINT (pos
) < SCHARS (string
))
9144 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9146 orig_local_map
= map
;
9147 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9151 if (!NILP (map
) || !NILP (map2
))
9153 from_string
= string
;
9154 goto replay_sequence
;
9159 else if (CONSP (XCDR (key
))
9160 && CONSP (EVENT_START (key
))
9161 && CONSP (XCDR (EVENT_START (key
))))
9165 posn
= POSN_POSN (EVENT_START (key
));
9166 /* Handle menu-bar events:
9167 insert the dummy prefix event `menu-bar'. */
9168 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9170 if (t
+ 1 >= bufsize
)
9171 error ("Key sequence too long");
9175 /* Zap the position in key, so we know that we've
9176 expanded it, and don't try to do so again. */
9177 POSN_SET_POSN (EVENT_START (key
),
9178 Fcons (posn
, Qnil
));
9181 goto replay_sequence
;
9183 else if (CONSP (posn
))
9185 /* We're looking at the second event of a
9186 sequence which we expanded before. Set
9187 last_real_key_start appropriately. */
9188 if (last_real_key_start
== t
&& t
> 0)
9189 last_real_key_start
= t
- 1;
9194 /* We have finally decided that KEY is something we might want
9196 first_binding
= (follow_key (key
,
9197 nmaps
- first_binding
,
9198 submaps
+ first_binding
,
9199 defs
+ first_binding
,
9200 submaps
+ first_binding
)
9203 /* If KEY wasn't bound, we'll try some fallbacks. */
9204 if (first_binding
< nmaps
)
9205 /* This is needed for the following scenario:
9206 event 0: a down-event that gets dropped by calling replay_key.
9207 event 1: some normal prefix like C-h.
9208 After event 0, first_unbound is 0, after event 1 fkey.start
9209 and keytran.start are both 1, so when we see that C-h is bound,
9210 we need to update first_unbound. */
9211 first_unbound
= max (t
+ 1, first_unbound
);
9216 /* Remember the position to put an upper bound on fkey.start. */
9217 first_unbound
= min (t
, first_unbound
);
9219 head
= EVENT_HEAD (key
);
9220 if (help_char_p (head
) && t
> 0)
9222 read_key_sequence_cmd
= Vprefix_help_command
;
9224 last_nonmenu_event
= key
;
9225 /* The Microsoft C compiler can't handle the goto that
9233 Lisp_Object breakdown
;
9236 breakdown
= parse_modifiers (head
);
9237 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9238 /* Attempt to reduce an unbound mouse event to a simpler
9239 event that is bound:
9240 Drags reduce to clicks.
9241 Double-clicks reduce to clicks.
9242 Triple-clicks reduce to double-clicks, then to clicks.
9243 Down-clicks are eliminated.
9244 Double-downs reduce to downs, then are eliminated.
9245 Triple-downs reduce to double-downs, then to downs,
9246 then are eliminated. */
9247 if (modifiers
& (down_modifier
| drag_modifier
9248 | double_modifier
| triple_modifier
))
9250 while (modifiers
& (down_modifier
| drag_modifier
9251 | double_modifier
| triple_modifier
))
9253 Lisp_Object new_head
, new_click
;
9254 if (modifiers
& triple_modifier
)
9255 modifiers
^= (double_modifier
| triple_modifier
);
9256 else if (modifiers
& double_modifier
)
9257 modifiers
&= ~double_modifier
;
9258 else if (modifiers
& drag_modifier
)
9259 modifiers
&= ~drag_modifier
;
9262 /* Dispose of this `down' event by simply jumping
9263 back to replay_key, to get another event.
9265 Note that if this event came from mock input,
9266 then just jumping back to replay_key will just
9267 hand it to us again. So we have to wipe out any
9270 We could delete keybuf[t] and shift everything
9271 after that to the left by one spot, but we'd also
9272 have to fix up any variable that points into
9273 keybuf, and shifting isn't really necessary
9276 Adding prefixes for non-textual mouse clicks
9277 creates two characters of mock input, and both
9278 must be thrown away. If we're only looking at
9279 the prefix now, we can just jump back to
9280 replay_key. On the other hand, if we've already
9281 processed the prefix, and now the actual click
9282 itself is giving us trouble, then we've lost the
9283 state of the keymaps we want to backtrack to, and
9284 we need to replay the whole sequence to rebuild
9287 Beyond that, only function key expansion could
9288 create more than two keys, but that should never
9289 generate mouse events, so it's okay to zero
9290 mock_input in that case too.
9292 FIXME: The above paragraph seems just plain
9293 wrong, if you consider things like
9294 xterm-mouse-mode. -stef
9296 Isn't this just the most wonderful code ever? */
9298 /* If mock_input > t + 1, the above simplification
9299 will actually end up dropping keys on the floor.
9300 This is probably OK for now, but even
9301 if mock_input <= t + 1, we need to adjust fkey
9303 Typical case [header-line down-mouse-N]:
9304 mock_input = 2, t = 1, fkey.end = 1,
9305 last_real_key_start = 0. */
9306 if (fkey
.end
> last_real_key_start
)
9308 fkey
.end
= fkey
.start
9309 = min (last_real_key_start
, fkey
.start
);
9310 fkey
.map
= fkey
.parent
;
9311 if (keytran
.end
> last_real_key_start
)
9313 keytran
.end
= keytran
.start
9314 = min (last_real_key_start
, keytran
.start
);
9315 keytran
.map
= keytran
.parent
;
9318 if (t
== last_real_key_start
)
9325 mock_input
= last_real_key_start
;
9326 goto replay_sequence
;
9331 = apply_modifiers (modifiers
, XCAR (breakdown
));
9333 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9335 /* Look for a binding for this new key. follow_key
9336 promises that it didn't munge submaps the
9337 last time we called it, since key was unbound. */
9339 = (follow_key (new_click
,
9340 nmaps
- local_first_binding
,
9341 submaps
+ local_first_binding
,
9342 defs
+ local_first_binding
,
9343 submaps
+ local_first_binding
)
9344 + local_first_binding
);
9346 /* If that click is bound, go for it. */
9347 if (first_binding
< nmaps
)
9352 /* Otherwise, we'll leave key set to the drag event. */
9359 /* Normally, last_nonmenu_event gets the previous key we read.
9360 But when a mouse popup menu is being used,
9361 we don't update last_nonmenu_event; it continues to hold the mouse
9362 event that preceded the first level of menu. */
9363 if (!used_mouse_menu
)
9364 last_nonmenu_event
= key
;
9366 /* Record what part of this_command_keys is the current key sequence. */
9367 this_single_command_key_start
= this_command_key_count
- t
;
9369 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9370 /* There is a binding and it's not a prefix.
9371 There is thus no function-key in this sequence.
9372 Moving fkey.start is important in this case to allow keytran.start
9373 to go over the sequence before we return (since we keep the
9374 invariant that keytran.end <= fkey.start). */
9377 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9380 /* If the sequence is unbound, see if we can hang a function key
9381 off the end of it. */
9382 /* Continue scan from fkey.end until we find a bound suffix. */
9383 while (fkey
.end
< t
)
9385 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9388 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9389 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9390 max (t
, mock_input
),
9391 /* If there's a binding (i.e.
9392 first_binding >= nmaps) we don't want
9393 to apply this function-key-mapping. */
9394 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9399 mock_input
= diff
+ max (t
, mock_input
);
9400 goto replay_sequence
;
9404 /* Look for this sequence in key-translation-map.
9405 Scan from keytran.end until we find a bound suffix. */
9406 while (keytran
.end
< fkey
.start
)
9408 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9411 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9412 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9417 mock_input
= diff
+ max (t
, mock_input
);
9418 /* Adjust the function-key-map counters. */
9422 goto replay_sequence
;
9426 /* If KEY is not defined in any of the keymaps,
9427 and cannot be part of a function key or translation,
9428 and is an upper case letter
9429 use the corresponding lower-case letter instead. */
9430 if (first_binding
>= nmaps
9431 && fkey
.start
>= t
&& keytran
.start
>= t
9433 && ((((XINT (key
) & 0x3ffff)
9434 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9435 && UPPERCASEP (XINT (key
) & 0x3ffff))
9436 || (XINT (key
) & shift_modifier
)))
9438 Lisp_Object new_key
;
9440 original_uppercase
= key
;
9441 original_uppercase_position
= t
- 1;
9443 if (XINT (key
) & shift_modifier
)
9444 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9446 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9447 | (XINT (key
) & ~0x3ffff)));
9449 /* We have to do this unconditionally, regardless of whether
9450 the lower-case char is defined in the keymaps, because they
9451 might get translated through function-key-map. */
9452 keybuf
[t
- 1] = new_key
;
9453 mock_input
= max (t
, mock_input
);
9455 goto replay_sequence
;
9457 /* If KEY is not defined in any of the keymaps,
9458 and cannot be part of a function key or translation,
9459 and is a shifted function key,
9460 use the corresponding unshifted function key instead. */
9461 if (first_binding
>= nmaps
9462 && fkey
.start
>= t
&& keytran
.start
>= t
9465 Lisp_Object breakdown
;
9468 breakdown
= parse_modifiers (key
);
9469 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9470 if (modifiers
& shift_modifier
)
9472 Lisp_Object new_key
;
9474 original_uppercase
= key
;
9475 original_uppercase_position
= t
- 1;
9477 modifiers
&= ~shift_modifier
;
9478 new_key
= apply_modifiers (modifiers
,
9481 keybuf
[t
- 1] = new_key
;
9482 mock_input
= max (t
, mock_input
);
9483 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9484 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9486 goto replay_sequence
;
9492 read_key_sequence_cmd
= (first_binding
< nmaps
9493 ? defs
[first_binding
]
9496 unread_switch_frame
= delayed_switch_frame
;
9497 unbind_to (count
, Qnil
);
9499 /* Don't downcase the last character if the caller says don't.
9500 Don't downcase it if the result is undefined, either. */
9501 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9503 && t
- 1 == original_uppercase_position
)
9504 keybuf
[t
- 1] = original_uppercase
;
9506 /* Occasionally we fabricate events, perhaps by expanding something
9507 according to function-key-map, or by adding a prefix symbol to a
9508 mouse click in the scroll bar or modeline. In this cases, return
9509 the entire generated key sequence, even if we hit an unbound
9510 prefix or a definition before the end. This means that you will
9511 be able to push back the event properly, and also means that
9512 read-key-sequence will always return a logical unit.
9515 for (; t
< mock_input
; t
++)
9517 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9518 && NILP (Fzerop (Vecho_keystrokes
)))
9519 echo_char (keybuf
[t
]);
9520 add_command_key (keybuf
[t
]);
9529 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9530 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9531 The sequence is sufficient to specify a non-prefix command in the
9532 current local and global maps.
9534 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9535 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9536 as a continuation of the previous key.
9538 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9539 convert the last event to lower case. (Normally any upper case event
9540 is converted to lower case if the original event is undefined and the lower
9541 case equivalent is defined.) A non-nil value is appropriate for reading
9542 a key sequence to be defined.
9544 A C-g typed while in this function is treated like any other character,
9545 and `quit-flag' is not set.
9547 If the key sequence starts with a mouse click, then the sequence is read
9548 using the keymaps of the buffer of the window clicked in, not the buffer
9549 of the selected window as normal.
9551 `read-key-sequence' drops unbound button-down events, since you normally
9552 only care about the click or drag events which follow them. If a drag
9553 or multi-click event is unbound, but the corresponding click event would
9554 be bound, `read-key-sequence' turns the event into a click event at the
9555 drag's starting position. This means that you don't have to distinguish
9556 between click and drag, double, or triple events unless you want to.
9558 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9559 lines separating windows, and scroll bars with imaginary keys
9560 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9562 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9563 function will process a switch-frame event if the user switches frames
9564 before typing anything. If the user switches frames in the middle of a
9565 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9566 is nil, then the event will be put off until after the current key sequence.
9568 `read-key-sequence' checks `function-key-map' for function key
9569 sequences, where they wouldn't conflict with ordinary bindings. See
9570 `function-key-map' for more details.
9572 The optional fifth argument COMMAND-LOOP, if non-nil, means
9573 that this key sequence is being read by something that will
9574 read commands one after another. It should be nil if the caller
9575 will read just one key sequence. */)
9576 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9578 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9579 Lisp_Object can_return_switch_frame
, command_loop
;
9581 Lisp_Object keybuf
[30];
9583 struct gcpro gcpro1
;
9584 int count
= SPECPDL_INDEX ();
9587 CHECK_STRING (prompt
);
9590 specbind (Qinput_method_exit_on_first_char
,
9591 (NILP (command_loop
) ? Qt
: Qnil
));
9592 specbind (Qinput_method_use_echo_area
,
9593 (NILP (command_loop
) ? Qt
: Qnil
));
9595 bzero (keybuf
, sizeof keybuf
);
9597 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9599 if (NILP (continue_echo
))
9601 this_command_key_count
= 0;
9602 this_command_key_count_reset
= 0;
9603 this_single_command_key_start
= 0;
9606 #ifdef HAVE_X_WINDOWS
9607 if (display_hourglass_p
)
9608 cancel_hourglass ();
9611 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9612 prompt
, ! NILP (dont_downcase_last
),
9613 ! NILP (can_return_switch_frame
), 0);
9615 #if 0 /* The following is fine for code reading a key sequence and
9616 then proceeding with a lenghty computation, but it's not good
9617 for code reading keys in a loop, like an input method. */
9618 #ifdef HAVE_X_WINDOWS
9619 if (display_hourglass_p
)
9630 return unbind_to (count
, make_event_array (i
, keybuf
));
9633 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9634 Sread_key_sequence_vector
, 1, 5, 0,
9635 doc
: /* Like `read-key-sequence' but always return a vector. */)
9636 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9638 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9639 Lisp_Object can_return_switch_frame
, command_loop
;
9641 Lisp_Object keybuf
[30];
9643 struct gcpro gcpro1
;
9644 int count
= SPECPDL_INDEX ();
9647 CHECK_STRING (prompt
);
9650 specbind (Qinput_method_exit_on_first_char
,
9651 (NILP (command_loop
) ? Qt
: Qnil
));
9652 specbind (Qinput_method_use_echo_area
,
9653 (NILP (command_loop
) ? Qt
: Qnil
));
9655 bzero (keybuf
, sizeof keybuf
);
9657 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9659 if (NILP (continue_echo
))
9661 this_command_key_count
= 0;
9662 this_command_key_count_reset
= 0;
9663 this_single_command_key_start
= 0;
9666 #ifdef HAVE_X_WINDOWS
9667 if (display_hourglass_p
)
9668 cancel_hourglass ();
9671 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9672 prompt
, ! NILP (dont_downcase_last
),
9673 ! NILP (can_return_switch_frame
), 0);
9675 #ifdef HAVE_X_WINDOWS
9676 if (display_hourglass_p
)
9686 return unbind_to (count
, Fvector (i
, keybuf
));
9689 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9690 doc
: /* Execute CMD as an editor command.
9691 CMD must be a symbol that satisfies the `commandp' predicate.
9692 Optional second arg RECORD-FLAG non-nil
9693 means unconditionally put this command in `command-history'.
9694 Otherwise, that is done only if an arg is read using the minibuffer.
9695 The argument KEYS specifies the value to use instead of (this-command-keys)
9696 when reading the arguments; if it is nil, (this-command-keys) is used.
9697 The argument SPECIAL, if non-nil, means that this command is executing
9698 a special event, so ignore the prefix argument and don't clear it. */)
9699 (cmd
, record_flag
, keys
, special
)
9700 Lisp_Object cmd
, record_flag
, keys
, special
;
9702 register Lisp_Object final
;
9703 register Lisp_Object tem
;
9704 Lisp_Object prefixarg
;
9705 struct backtrace backtrace
;
9706 extern int debug_on_next_call
;
9708 debug_on_next_call
= 0;
9712 prefixarg
= current_kboard
->Vprefix_arg
;
9713 Vcurrent_prefix_arg
= prefixarg
;
9714 current_kboard
->Vprefix_arg
= Qnil
;
9721 tem
= Fget (cmd
, Qdisabled
);
9722 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9724 tem
= Fsymbol_value (Qdisabled_command_function
);
9726 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9732 final
= Findirect_function (cmd
, Qnil
);
9734 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9736 struct gcpro gcpro1
, gcpro2
;
9738 GCPRO2 (cmd
, prefixarg
);
9739 do_autoload (final
, cmd
);
9746 if (STRINGP (final
) || VECTORP (final
))
9748 /* If requested, place the macro in the command history. For
9749 other sorts of commands, call-interactively takes care of
9751 if (!NILP (record_flag
))
9754 = Fcons (Fcons (Qexecute_kbd_macro
,
9755 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9758 /* Don't keep command history around forever. */
9759 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9761 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9763 XSETCDR (tem
, Qnil
);
9767 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9770 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9772 backtrace
.next
= backtrace_list
;
9773 backtrace_list
= &backtrace
;
9774 backtrace
.function
= &Qcall_interactively
;
9775 backtrace
.args
= &cmd
;
9776 backtrace
.nargs
= 1;
9777 backtrace
.evalargs
= 0;
9778 backtrace
.debug_on_exit
= 0;
9780 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9782 backtrace_list
= backtrace
.next
;
9790 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9792 doc
: /* Read function name, then read its arguments and call it.
9794 To pass a numeric argument to the command you are invoking with, specify
9795 the numeric argument to this command.
9797 Noninteractively, the argument PREFIXARG is the prefix argument to
9798 give to the command you invoke, if it asks for an argument. */)
9800 Lisp_Object prefixarg
;
9802 Lisp_Object function
;
9804 int saved_last_point_position
;
9805 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9806 Lisp_Object bindings
, value
;
9807 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9808 #ifdef HAVE_X_WINDOWS
9809 /* The call to Fcompleting_read wil start and cancel the hourglass,
9810 but if the hourglass was already scheduled, this means that no
9811 hourglass will be shown for the actual M-x command itself.
9812 So we restart it if it is already scheduled. Note that checking
9813 hourglass_shown_p is not enough, normally the hourglass is not shown,
9814 just scheduled to be shown. */
9815 int hstarted
= hourglass_started ();
9818 saved_keys
= Fvector (this_command_key_count
,
9819 XVECTOR (this_command_keys
)->contents
);
9820 saved_last_point_position_buffer
= last_point_position_buffer
;
9821 saved_last_point_position
= last_point_position
;
9823 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9825 if (EQ (prefixarg
, Qminus
))
9827 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9828 strcpy (buf
, "C-u ");
9829 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9830 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9831 else if (INTEGERP (prefixarg
))
9832 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9834 /* This isn't strictly correct if execute-extended-command
9835 is bound to anything else. Perhaps it should use
9836 this_command_keys? */
9837 strcat (buf
, "M-x ");
9839 /* Prompt with buf, and then read a string, completing from and
9840 restricting to the set of all defined commands. Don't provide
9841 any initial input. Save the command read on the extended-command
9843 function
= Fcompleting_read (build_string (buf
),
9844 Vobarray
, Qcommandp
,
9845 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9848 #ifdef HAVE_X_WINDOWS
9849 if (hstarted
) start_hourglass ();
9852 if (STRINGP (function
) && SCHARS (function
) == 0)
9853 error ("No command name given");
9855 /* Set this_command_keys to the concatenation of saved_keys and
9856 function, followed by a RET. */
9861 this_command_key_count
= 0;
9862 this_command_key_count_reset
= 0;
9863 this_single_command_key_start
= 0;
9865 keys
= XVECTOR (saved_keys
)->contents
;
9866 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9867 add_command_key (keys
[i
]);
9869 for (i
= 0; i
< SCHARS (function
); i
++)
9870 add_command_key (Faref (function
, make_number (i
)));
9872 add_command_key (make_number ('\015'));
9875 last_point_position
= saved_last_point_position
;
9876 last_point_position_buffer
= saved_last_point_position_buffer
;
9880 function
= Fintern (function
, Qnil
);
9881 current_kboard
->Vprefix_arg
= prefixarg
;
9882 Vthis_command
= function
;
9883 real_this_command
= function
;
9885 /* If enabled, show which key runs this command. */
9886 if (!NILP (Vsuggest_key_bindings
)
9887 && NILP (Vexecuting_kbd_macro
)
9888 && SYMBOLP (function
))
9889 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9895 GCPRO2 (bindings
, value
);
9896 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9898 /* If the command has a key binding, print it now. */
9899 if (!NILP (bindings
)
9900 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9903 /* But first wait, and skip the message if there is input. */
9906 /* If this command displayed something in the echo area;
9907 wait a few seconds, then display our suggestion message. */
9908 if (NILP (echo_area_buffer
[0]))
9909 waited
= sit_for (make_number (0), 0, 2);
9910 else if (NUMBERP (Vsuggest_key_bindings
))
9911 waited
= sit_for (Vminibuffer_message_timeout
, 0, 2);
9913 waited
= sit_for (make_number (2), 0, 2);
9915 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
9917 Lisp_Object binding
;
9919 int message_p
= push_message ();
9920 int count
= SPECPDL_INDEX ();
9922 record_unwind_protect (pop_message_unwind
, Qnil
);
9923 binding
= Fkey_description (bindings
, Qnil
);
9926 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9929 sprintf (newmessage
, "You can run the command `%s' with %s",
9930 SDATA (SYMBOL_NAME (function
)),
9932 message2_nolog (newmessage
,
9933 strlen (newmessage
),
9934 STRING_MULTIBYTE (binding
));
9935 if (NUMBERP (Vsuggest_key_bindings
))
9936 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
9938 waited
= sit_for (make_number (2), 0, 2);
9940 if (!NILP (waited
) && message_p
)
9943 unbind_to (count
, Qnil
);
9947 RETURN_UNGCPRO (value
);
9951 /* Return nonzero if input events are pending. */
9954 detect_input_pending ()
9957 get_input_pending (&input_pending
, 0);
9959 return input_pending
;
9962 /* Return nonzero if input events other than mouse movements are
9966 detect_input_pending_ignore_squeezables ()
9969 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9971 return input_pending
;
9974 /* Return nonzero if input events are pending, and run any pending timers. */
9977 detect_input_pending_run_timers (do_display
)
9980 int old_timers_run
= timers_run
;
9983 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
9985 if (old_timers_run
!= timers_run
&& do_display
)
9987 redisplay_preserve_echo_area (8);
9988 /* The following fixes a bug when using lazy-lock with
9989 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9990 from an idle timer function. The symptom of the bug is that
9991 the cursor sometimes doesn't become visible until the next X
9992 event is processed. --gerd. */
9994 rif
->flush_display (NULL
);
9997 return input_pending
;
10000 /* This is called in some cases before a possible quit.
10001 It cases the next call to detect_input_pending to recompute input_pending.
10002 So calling this function unnecessarily can't do any harm. */
10005 clear_input_pending ()
10010 /* Return nonzero if there are pending requeued events.
10011 This isn't used yet. The hope is to make wait_reading_process_output
10012 call it, and return if it runs Lisp code that unreads something.
10013 The problem is, kbd_buffer_get_event needs to be fixed to know what
10014 to do in that case. It isn't trivial. */
10017 requeued_events_pending_p ()
10019 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10023 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10024 doc
: /* Return t if command input is currently available with no wait.
10025 Actually, the value is nil only if we can be sure that no input is available;
10026 if there is a doubt, the value is t. */)
10029 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
10032 get_input_pending (&input_pending
,
10033 READABLE_EVENTS_DO_TIMERS_NOW
10034 | READABLE_EVENTS_FILTER_EVENTS
);
10035 return input_pending
> 0 ? Qt
: Qnil
;
10038 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10039 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10042 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10045 if (total_keys
< NUM_RECENT_KEYS
)
10046 return Fvector (total_keys
, keys
);
10049 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10050 bcopy (keys
+ recent_keys_index
,
10051 XVECTOR (val
)->contents
,
10052 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10054 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10055 recent_keys_index
* sizeof (Lisp_Object
));
10060 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10061 doc
: /* Return the key sequence that invoked this command.
10062 However, if the command has called `read-key-sequence', it returns
10063 the last key sequence that has been read.
10064 The value is a string or a vector. */)
10067 return make_event_array (this_command_key_count
,
10068 XVECTOR (this_command_keys
)->contents
);
10071 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10072 doc
: /* Return the key sequence that invoked this command, as a vector.
10073 However, if the command has called `read-key-sequence', it returns
10074 the last key sequence that has been read. */)
10077 return Fvector (this_command_key_count
,
10078 XVECTOR (this_command_keys
)->contents
);
10081 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10082 Sthis_single_command_keys
, 0, 0, 0,
10083 doc
: /* Return the key sequence that invoked this command.
10084 More generally, it returns the last key sequence read, either by
10085 the command loop or by `read-key-sequence'.
10086 Unlike `this-command-keys', this function's value
10087 does not include prefix arguments.
10088 The value is always a vector. */)
10091 return Fvector (this_command_key_count
10092 - this_single_command_key_start
,
10093 (XVECTOR (this_command_keys
)->contents
10094 + this_single_command_key_start
));
10097 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10098 Sthis_single_command_raw_keys
, 0, 0, 0,
10099 doc
: /* Return the raw events that were read for this command.
10100 More generally, it returns the last key sequence read, either by
10101 the command loop or by `read-key-sequence'.
10102 Unlike `this-single-command-keys', this function's value
10103 shows the events before all translations (except for input methods).
10104 The value is always a vector. */)
10107 return Fvector (raw_keybuf_count
,
10108 (XVECTOR (raw_keybuf
)->contents
));
10111 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10112 Sreset_this_command_lengths
, 0, 0, 0,
10113 doc
: /* Make the unread events replace the last command and echo.
10114 Used in `universal-argument-other-key'.
10116 `universal-argument-other-key' rereads the event just typed.
10117 It then gets translated through `function-key-map'.
10118 The translated event has to replace the real events,
10119 both in the value of (this-command-keys) and in echoing.
10120 To achieve this, `universal-argument-other-key' calls
10121 `reset-this-command-lengths', which discards the record of reading
10122 these events the first time. */)
10125 this_command_key_count
= before_command_key_count
;
10126 if (this_command_key_count
< this_single_command_key_start
)
10127 this_single_command_key_start
= this_command_key_count
;
10129 echo_truncate (before_command_echo_length
);
10131 /* Cause whatever we put into unread-command-events
10132 to echo as if it were being freshly read from the keyboard. */
10133 this_command_key_count_reset
= 1;
10138 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10139 Sclear_this_command_keys
, 0, 1, 0,
10140 doc
: /* Clear out the vector that `this-command-keys' returns.
10141 Also clear the record of the last 100 events, unless optional arg
10142 KEEP-RECORD is non-nil. */)
10144 Lisp_Object keep_record
;
10148 this_command_key_count
= 0;
10149 this_command_key_count_reset
= 0;
10151 if (NILP (keep_record
))
10153 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10154 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10156 recent_keys_index
= 0;
10161 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10162 doc
: /* Return the current depth in recursive edits. */)
10166 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10170 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10171 "FOpen dribble file: ",
10172 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10173 If FILE is nil, close any open dribble file. */)
10184 file
= Fexpand_file_name (file
, Qnil
);
10185 dribble
= fopen (SDATA (file
), "w");
10187 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10192 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10193 doc
: /* Discard the contents of the terminal input buffer.
10194 Also end any kbd macro being defined. */)
10197 if (!NILP (current_kboard
->defining_kbd_macro
))
10199 /* Discard the last command from the macro. */
10200 Fcancel_kbd_macro_events ();
10204 update_mode_lines
++;
10206 Vunread_command_events
= Qnil
;
10207 unread_command_char
= -1;
10209 discard_tty_input ();
10211 kbd_fetch_ptr
= kbd_store_ptr
;
10217 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10218 doc
: /* Stop Emacs and return to superior process. You can resume later.
10219 If `cannot-suspend' is non-nil, or if the system doesn't support job
10220 control, run a subshell instead.
10222 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10223 to be read as terminal input by Emacs's parent, after suspension.
10225 Before suspending, run the normal hook `suspend-hook'.
10226 After resumption run the normal hook `suspend-resume-hook'.
10228 Some operating systems cannot stop the Emacs process and resume it later.
10229 On such systems, Emacs starts a subshell instead of suspending. */)
10231 Lisp_Object stuffstring
;
10233 int count
= SPECPDL_INDEX ();
10234 int old_height
, old_width
;
10236 struct gcpro gcpro1
;
10238 if (!NILP (stuffstring
))
10239 CHECK_STRING (stuffstring
);
10241 /* Run the functions in suspend-hook. */
10242 if (!NILP (Vrun_hooks
))
10243 call1 (Vrun_hooks
, intern ("suspend-hook"));
10245 GCPRO1 (stuffstring
);
10246 get_frame_size (&old_width
, &old_height
);
10247 reset_sys_modes ();
10248 /* sys_suspend can get an error if it tries to fork a subshell
10249 and the system resources aren't available for that. */
10250 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10252 stuff_buffered_input (stuffstring
);
10253 if (cannot_suspend
)
10257 unbind_to (count
, Qnil
);
10259 /* Check if terminal/window size has changed.
10260 Note that this is not useful when we are running directly
10261 with a window system; but suspend should be disabled in that case. */
10262 get_frame_size (&width
, &height
);
10263 if (width
!= old_width
|| height
!= old_height
)
10264 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10266 /* Run suspend-resume-hook. */
10267 if (!NILP (Vrun_hooks
))
10268 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10274 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10275 Then in any case stuff anything Emacs has read ahead and not used. */
10278 stuff_buffered_input (stuffstring
)
10279 Lisp_Object stuffstring
;
10281 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10282 register unsigned char *p
;
10284 if (STRINGP (stuffstring
))
10286 register int count
;
10288 p
= SDATA (stuffstring
);
10289 count
= SBYTES (stuffstring
);
10290 while (count
-- > 0)
10295 /* Anything we have read ahead, put back for the shell to read. */
10296 /* ?? What should this do when we have multiple keyboards??
10297 Should we ignore anything that was typed in at the "wrong" kboard?
10299 rms: we should stuff everything back into the kboard
10301 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10304 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10305 kbd_fetch_ptr
= kbd_buffer
;
10306 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10307 stuff_char (kbd_fetch_ptr
->code
);
10309 clear_event (kbd_fetch_ptr
);
10313 #endif /* SIGTSTP */
10317 set_waiting_for_input (time_to_clear
)
10318 EMACS_TIME
*time_to_clear
;
10320 input_available_clear_time
= time_to_clear
;
10322 /* Tell interrupt_signal to throw back to read_char, */
10323 waiting_for_input
= 1;
10325 /* If interrupt_signal was called before and buffered a C-g,
10326 make it run again now, to avoid timing error. */
10327 if (!NILP (Vquit_flag
))
10328 quit_throw_to_read_char ();
10332 clear_waiting_for_input ()
10334 /* Tell interrupt_signal not to throw back to read_char, */
10335 waiting_for_input
= 0;
10336 input_available_clear_time
= 0;
10339 /* This routine is called at interrupt level in response to C-g.
10341 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10342 is called from kbd_buffer_store_event, in handling SIGIO or
10345 If `waiting_for_input' is non zero, then unless `echoing' is
10346 nonzero, immediately throw back to read_char.
10348 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10349 eval to throw, when it gets a chance. If quit-flag is already
10350 non-nil, it stops the job right away. */
10353 interrupt_signal (signalnum
) /* If we don't have an argument, */
10354 int signalnum
; /* some compilers complain in signal calls. */
10357 /* Must preserve main program's value of errno. */
10358 int old_errno
= errno
;
10359 struct frame
*sf
= SELECTED_FRAME ();
10361 #if defined (USG) && !defined (POSIX_SIGNALS)
10362 if (!read_socket_hook
&& NILP (Vwindow_system
))
10364 /* USG systems forget handlers when they are used;
10365 must reestablish each time */
10366 signal (SIGINT
, interrupt_signal
);
10367 signal (SIGQUIT
, interrupt_signal
);
10371 SIGNAL_THREAD_CHECK (signalnum
);
10374 if (!NILP (Vquit_flag
)
10375 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10377 /* If SIGINT isn't blocked, don't let us be interrupted by
10378 another SIGINT, it might be harmful due to non-reentrancy
10379 in I/O functions. */
10380 sigblock (sigmask (SIGINT
));
10383 reset_sys_modes ();
10385 #ifdef SIGTSTP /* Support possible in later USG versions */
10387 * On systems which can suspend the current process and return to the original
10388 * shell, this command causes the user to end up back at the shell.
10389 * The "Auto-save" and "Abort" questions are not asked until
10390 * the user elects to return to emacs, at which point he can save the current
10391 * job and either dump core or continue.
10396 if (sys_suspend () == -1)
10398 printf ("Not running as a subprocess;\n");
10399 printf ("you can continue or abort.\n");
10401 #else /* not VMS */
10402 /* Perhaps should really fork an inferior shell?
10403 But that would not provide any way to get back
10404 to the original shell, ever. */
10405 printf ("No support for stopping a process on this operating system;\n");
10406 printf ("you can continue or abort.\n");
10407 #endif /* not VMS */
10408 #endif /* not SIGTSTP */
10410 /* We must remain inside the screen area when the internal terminal
10411 is used. Note that [Enter] is not echoed by dos. */
10414 /* It doesn't work to autosave while GC is in progress;
10415 the code used for auto-saving doesn't cope with the mark bit. */
10416 if (!gc_in_progress
)
10418 printf ("Auto-save? (y or n) ");
10420 if (((c
= getchar ()) & ~040) == 'Y')
10422 Fdo_auto_save (Qt
, Qnil
);
10424 printf ("\r\nAuto-save done");
10425 #else /* not MSDOS */
10426 printf ("Auto-save done\n");
10427 #endif /* not MSDOS */
10429 while (c
!= '\n') c
= getchar ();
10433 /* During GC, it must be safe to reenable quitting again. */
10434 Vinhibit_quit
= Qnil
;
10437 #endif /* not MSDOS */
10438 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10439 printf ("but will instead do a real quit after garbage collection ends\r\n");
10444 printf ("\r\nAbort? (y or n) ");
10445 #else /* not MSDOS */
10447 printf ("Abort (and enter debugger)? (y or n) ");
10448 #else /* not VMS */
10449 printf ("Abort (and dump core)? (y or n) ");
10450 #endif /* not VMS */
10451 #endif /* not MSDOS */
10453 if (((c
= getchar ()) & ~040) == 'Y')
10455 while (c
!= '\n') c
= getchar ();
10457 printf ("\r\nContinuing...\r\n");
10458 #else /* not MSDOS */
10459 printf ("Continuing...\n");
10460 #endif /* not MSDOS */
10467 /* If executing a function that wants to be interrupted out of
10468 and the user has not deferred quitting by binding `inhibit-quit'
10469 then quit right away. */
10470 if (immediate_quit
&& NILP (Vinhibit_quit
))
10472 struct gl_state_s saved
;
10473 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10475 immediate_quit
= 0;
10478 GCPRO4 (saved
.object
, saved
.global_code
,
10479 saved
.current_syntax_table
, saved
.old_prop
);
10480 Fsignal (Qquit
, Qnil
);
10485 /* Else request quit when it's safe */
10489 if (waiting_for_input
&& !echoing
)
10490 quit_throw_to_read_char ();
10495 /* Handle a C-g by making read_char return C-g. */
10498 quit_throw_to_read_char ()
10501 /* Prevent another signal from doing this before we finish. */
10502 clear_waiting_for_input ();
10505 Vunread_command_events
= Qnil
;
10506 unread_command_char
= -1;
10508 #if 0 /* Currently, sit_for is called from read_char without turning
10509 off polling. And that can call set_waiting_for_input.
10510 It seems to be harmless. */
10511 #ifdef POLL_FOR_INPUT
10512 /* May be > 1 if in recursive minibuffer. */
10513 if (poll_suppress_count
== 0)
10517 if (FRAMEP (internal_last_event_frame
)
10518 && !EQ (internal_last_event_frame
, selected_frame
))
10519 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10522 _longjmp (getcjmp
, 1);
10525 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10526 doc
: /* Set mode of reading keyboard input.
10527 First arg INTERRUPT non-nil means use input interrupts;
10528 nil means use CBREAK mode.
10529 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10530 (no effect except in CBREAK mode).
10531 Third arg META t means accept 8-bit input (for a Meta key).
10532 META nil means ignore the top bit, on the assumption it is parity.
10533 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10534 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10535 See also `current-input-mode'. */)
10536 (interrupt
, flow
, meta
, quit
)
10537 Lisp_Object interrupt
, flow
, meta
, quit
;
10540 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10541 error ("set-input-mode: QUIT must be an ASCII character");
10543 #ifdef POLL_FOR_INPUT
10548 /* this causes startup screen to be restored and messes with the mouse */
10549 reset_sys_modes ();
10553 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10554 if (read_socket_hook
)
10556 /* When using X, don't give the user a real choice,
10557 because we haven't implemented the mechanisms to support it. */
10558 #ifdef NO_SOCK_SIGIO
10559 interrupt_input
= 0;
10560 #else /* not NO_SOCK_SIGIO */
10561 interrupt_input
= 1;
10562 #endif /* NO_SOCK_SIGIO */
10565 interrupt_input
= !NILP (interrupt
);
10566 #else /* not SIGIO */
10567 interrupt_input
= 0;
10568 #endif /* not SIGIO */
10570 /* Our VMS input only works by interrupts, as of now. */
10572 interrupt_input
= 1;
10575 flow_control
= !NILP (flow
);
10578 else if (EQ (meta
, Qt
))
10583 /* Don't let this value be out of range. */
10584 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10590 #ifdef POLL_FOR_INPUT
10591 poll_suppress_count
= 1;
10597 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10598 doc
: /* Return information about the way Emacs currently reads keyboard input.
10599 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10600 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10601 nil, Emacs is using CBREAK mode.
10602 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10603 terminal; this does not apply if Emacs uses interrupt-driven input.
10604 META is t if accepting 8-bit input with 8th bit as Meta flag.
10605 META nil means ignoring the top bit, on the assumption it is parity.
10606 META is neither t nor nil if accepting 8-bit input and using
10607 all 8 bits as the character code.
10608 QUIT is the character Emacs currently uses to quit.
10609 The elements of this list correspond to the arguments of
10610 `set-input-mode'. */)
10613 Lisp_Object val
[4];
10615 val
[0] = interrupt_input
? Qt
: Qnil
;
10616 val
[1] = flow_control
? Qt
: Qnil
;
10617 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10618 XSETFASTINT (val
[3], quit_char
);
10620 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10623 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10624 doc
: /* Return position information for pixel coordinates X and Y.
10625 By default, X and Y are relative to text area of the selected window.
10626 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10627 If optional fourth arg WHOLE is non-nil, X is relative to the left
10628 edge of the window.
10630 The return value is similar to a mouse click position:
10631 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10632 IMAGE (DX . DY) (WIDTH . HEIGHT))
10633 The `posn-' functions access elements of such lists. */)
10634 (x
, y
, frame_or_window
, whole
)
10635 Lisp_Object x
, y
, frame_or_window
, whole
;
10640 if (NILP (frame_or_window
))
10641 frame_or_window
= selected_window
;
10643 if (WINDOWP (frame_or_window
))
10647 CHECK_LIVE_WINDOW (frame_or_window
);
10649 w
= XWINDOW (frame_or_window
);
10650 XSETINT (x
, (XINT (x
)
10651 + WINDOW_LEFT_EDGE_X (w
)
10653 ? window_box_left_offset (w
, TEXT_AREA
)
10655 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10656 frame_or_window
= w
->frame
;
10659 CHECK_LIVE_FRAME (frame_or_window
);
10661 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10664 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10665 doc
: /* Return position information for buffer POS in WINDOW.
10666 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10668 Return nil if position is not visible in window. Otherwise,
10669 the return value is similar to that returned by `event-start' for
10670 a mouse click at the upper left corner of the glyph corresponding
10671 to the given buffer position:
10672 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10673 IMAGE (DX . DY) (WIDTH . HEIGHT))
10674 The `posn-' functions access elements of such lists. */)
10676 Lisp_Object pos
, window
;
10681 window
= selected_window
;
10683 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10686 Lisp_Object x
= XCAR (tem
);
10687 Lisp_Object y
= XCAR (XCDR (tem
));
10689 /* Point invisible due to hscrolling? */
10692 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10700 * Set up a new kboard object with reasonable initial values.
10706 kb
->Voverriding_terminal_local_map
= Qnil
;
10707 kb
->Vlast_command
= Qnil
;
10708 kb
->Vreal_last_command
= Qnil
;
10709 kb
->Vprefix_arg
= Qnil
;
10710 kb
->Vlast_prefix_arg
= Qnil
;
10711 kb
->kbd_queue
= Qnil
;
10712 kb
->kbd_queue_has_data
= 0;
10713 kb
->immediate_echo
= 0;
10714 kb
->echo_string
= Qnil
;
10715 kb
->echo_after_prompt
= -1;
10716 kb
->kbd_macro_buffer
= 0;
10717 kb
->kbd_macro_bufsize
= 0;
10718 kb
->defining_kbd_macro
= Qnil
;
10719 kb
->Vlast_kbd_macro
= Qnil
;
10720 kb
->reference_count
= 0;
10721 kb
->Vsystem_key_alist
= Qnil
;
10722 kb
->system_key_syms
= Qnil
;
10723 kb
->Vdefault_minibuffer_frame
= Qnil
;
10727 * Destroy the contents of a kboard object, but not the object itself.
10728 * We use this just before deleting it, or if we're going to initialize
10729 * it a second time.
10735 if (kb
->kbd_macro_buffer
)
10736 xfree (kb
->kbd_macro_buffer
);
10739 #ifdef MULTI_KBOARD
10741 /* Free KB and memory referenced from it. */
10749 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10752 *kbp
= kb
->next_kboard
;
10754 /* Prevent a dangling reference to KB. */
10755 if (kb
== current_kboard
10756 && FRAMEP (selected_frame
)
10757 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10759 current_kboard
= XFRAME (selected_frame
)->kboard
;
10760 if (current_kboard
== kb
)
10768 #endif /* MULTI_KBOARD */
10773 /* This is correct before outermost invocation of the editor loop */
10774 command_loop_level
= -1;
10775 immediate_quit
= 0;
10776 quit_char
= Ctl ('g');
10777 Vunread_command_events
= Qnil
;
10778 unread_command_char
= -1;
10779 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10781 recent_keys_index
= 0;
10782 kbd_fetch_ptr
= kbd_buffer
;
10783 kbd_store_ptr
= kbd_buffer
;
10785 do_mouse_tracking
= Qnil
;
10789 /* This means that command_loop_1 won't try to select anything the first
10791 internal_last_event_frame
= Qnil
;
10792 Vlast_event_frame
= internal_last_event_frame
;
10794 #ifdef MULTI_KBOARD
10795 current_kboard
= initial_kboard
;
10797 wipe_kboard (current_kboard
);
10798 init_kboard (current_kboard
);
10800 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10802 signal (SIGINT
, interrupt_signal
);
10803 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10804 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10805 SIGQUIT and we can't tell which one it will give us. */
10806 signal (SIGQUIT
, interrupt_signal
);
10807 #endif /* HAVE_TERMIO */
10809 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10811 if (!noninteractive
)
10812 signal (SIGIO
, input_available_signal
);
10815 /* Use interrupt input by default, if it works and noninterrupt input
10816 has deficiencies. */
10818 #ifdef INTERRUPT_INPUT
10819 interrupt_input
= 1;
10821 interrupt_input
= 0;
10824 /* Our VMS input only works by interrupts, as of now. */
10826 interrupt_input
= 1;
10832 if (keyboard_init_hook
)
10833 (*keyboard_init_hook
) ();
10835 #ifdef POLL_FOR_INPUT
10836 poll_suppress_count
= 1;
10841 /* This type's only use is in syms_of_keyboard, to initialize the
10842 event header symbols and put properties on them. */
10843 struct event_head
{
10849 struct event_head head_table
[] = {
10850 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10851 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10852 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10853 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10854 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10855 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10856 /* `select-window' should be handled just like `switch-frame'
10857 in read_key_sequence. */
10858 {&Qselect_window
, "select-window", &Qswitch_frame
}
10862 syms_of_keyboard ()
10864 Vpre_help_message
= Qnil
;
10865 staticpro (&Vpre_help_message
);
10867 Vlispy_mouse_stem
= build_string ("mouse");
10868 staticpro (&Vlispy_mouse_stem
);
10871 QCimage
= intern (":image");
10872 staticpro (&QCimage
);
10874 staticpro (&Qhelp_echo
);
10875 Qhelp_echo
= intern ("help-echo");
10877 staticpro (&item_properties
);
10878 item_properties
= Qnil
;
10880 staticpro (&tool_bar_item_properties
);
10881 tool_bar_item_properties
= Qnil
;
10882 staticpro (&tool_bar_items_vector
);
10883 tool_bar_items_vector
= Qnil
;
10885 staticpro (&real_this_command
);
10886 real_this_command
= Qnil
;
10888 Qtimer_event_handler
= intern ("timer-event-handler");
10889 staticpro (&Qtimer_event_handler
);
10891 Qdisabled_command_function
= intern ("disabled-command-function");
10892 staticpro (&Qdisabled_command_function
);
10894 Qself_insert_command
= intern ("self-insert-command");
10895 staticpro (&Qself_insert_command
);
10897 Qforward_char
= intern ("forward-char");
10898 staticpro (&Qforward_char
);
10900 Qbackward_char
= intern ("backward-char");
10901 staticpro (&Qbackward_char
);
10903 Qdisabled
= intern ("disabled");
10904 staticpro (&Qdisabled
);
10906 Qundefined
= intern ("undefined");
10907 staticpro (&Qundefined
);
10909 Qpre_command_hook
= intern ("pre-command-hook");
10910 staticpro (&Qpre_command_hook
);
10912 Qpost_command_hook
= intern ("post-command-hook");
10913 staticpro (&Qpost_command_hook
);
10915 Qdeferred_action_function
= intern ("deferred-action-function");
10916 staticpro (&Qdeferred_action_function
);
10918 Qcommand_hook_internal
= intern ("command-hook-internal");
10919 staticpro (&Qcommand_hook_internal
);
10921 Qfunction_key
= intern ("function-key");
10922 staticpro (&Qfunction_key
);
10923 Qmouse_click
= intern ("mouse-click");
10924 staticpro (&Qmouse_click
);
10925 #if defined (WINDOWSNT) || defined (MAC_OS)
10926 Qlanguage_change
= intern ("language-change");
10927 staticpro (&Qlanguage_change
);
10929 Qdrag_n_drop
= intern ("drag-n-drop");
10930 staticpro (&Qdrag_n_drop
);
10932 Qsave_session
= intern ("save-session");
10933 staticpro (&Qsave_session
);
10936 Qmac_apple_event
= intern ("mac-apple-event");
10937 staticpro (&Qmac_apple_event
);
10940 Qusr1_signal
= intern ("usr1-signal");
10941 staticpro (&Qusr1_signal
);
10942 Qusr2_signal
= intern ("usr2-signal");
10943 staticpro (&Qusr2_signal
);
10945 Qmenu_enable
= intern ("menu-enable");
10946 staticpro (&Qmenu_enable
);
10947 Qmenu_alias
= intern ("menu-alias");
10948 staticpro (&Qmenu_alias
);
10949 QCenable
= intern (":enable");
10950 staticpro (&QCenable
);
10951 QCvisible
= intern (":visible");
10952 staticpro (&QCvisible
);
10953 QChelp
= intern (":help");
10954 staticpro (&QChelp
);
10955 QCfilter
= intern (":filter");
10956 staticpro (&QCfilter
);
10957 QCbutton
= intern (":button");
10958 staticpro (&QCbutton
);
10959 QCkeys
= intern (":keys");
10960 staticpro (&QCkeys
);
10961 QCkey_sequence
= intern (":key-sequence");
10962 staticpro (&QCkey_sequence
);
10963 QCtoggle
= intern (":toggle");
10964 staticpro (&QCtoggle
);
10965 QCradio
= intern (":radio");
10966 staticpro (&QCradio
);
10968 Qmode_line
= intern ("mode-line");
10969 staticpro (&Qmode_line
);
10970 Qvertical_line
= intern ("vertical-line");
10971 staticpro (&Qvertical_line
);
10972 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10973 staticpro (&Qvertical_scroll_bar
);
10974 Qmenu_bar
= intern ("menu-bar");
10975 staticpro (&Qmenu_bar
);
10978 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
10979 staticpro (&Qmouse_fixup_help_message
);
10982 Qabove_handle
= intern ("above-handle");
10983 staticpro (&Qabove_handle
);
10984 Qhandle
= intern ("handle");
10985 staticpro (&Qhandle
);
10986 Qbelow_handle
= intern ("below-handle");
10987 staticpro (&Qbelow_handle
);
10988 Qup
= intern ("up");
10990 Qdown
= intern ("down");
10991 staticpro (&Qdown
);
10992 Qtop
= intern ("top");
10994 Qbottom
= intern ("bottom");
10995 staticpro (&Qbottom
);
10996 Qend_scroll
= intern ("end-scroll");
10997 staticpro (&Qend_scroll
);
10998 Qratio
= intern ("ratio");
10999 staticpro (&Qratio
);
11001 Qevent_kind
= intern ("event-kind");
11002 staticpro (&Qevent_kind
);
11003 Qevent_symbol_elements
= intern ("event-symbol-elements");
11004 staticpro (&Qevent_symbol_elements
);
11005 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11006 staticpro (&Qevent_symbol_element_mask
);
11007 Qmodifier_cache
= intern ("modifier-cache");
11008 staticpro (&Qmodifier_cache
);
11010 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11011 staticpro (&Qrecompute_lucid_menubar
);
11012 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11013 staticpro (&Qactivate_menubar_hook
);
11015 Qpolling_period
= intern ("polling-period");
11016 staticpro (&Qpolling_period
);
11018 Qinput_method_function
= intern ("input-method-function");
11019 staticpro (&Qinput_method_function
);
11021 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11022 staticpro (&Qinput_method_exit_on_first_char
);
11023 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11024 staticpro (&Qinput_method_use_echo_area
);
11026 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11027 Fset (Qinput_method_use_echo_area
, Qnil
);
11029 last_point_position_buffer
= Qnil
;
11030 last_point_position_window
= Qnil
;
11033 struct event_head
*p
;
11035 for (p
= head_table
;
11036 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11039 *p
->var
= intern (p
->name
);
11040 staticpro (p
->var
);
11041 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11042 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11046 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11047 staticpro (&button_down_location
);
11048 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11049 staticpro (&mouse_syms
);
11050 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11051 staticpro (&wheel_syms
);
11055 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11057 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11058 for (i
= 0; i
< len
; i
++)
11059 if (modifier_names
[i
])
11060 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11061 staticpro (&modifier_symbols
);
11064 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11065 staticpro (&recent_keys
);
11067 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11068 staticpro (&this_command_keys
);
11070 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11071 staticpro (&raw_keybuf
);
11073 Qextended_command_history
= intern ("extended-command-history");
11074 Fset (Qextended_command_history
, Qnil
);
11075 staticpro (&Qextended_command_history
);
11077 accent_key_syms
= Qnil
;
11078 staticpro (&accent_key_syms
);
11080 func_key_syms
= Qnil
;
11081 staticpro (&func_key_syms
);
11083 drag_n_drop_syms
= Qnil
;
11084 staticpro (&drag_n_drop_syms
);
11086 unread_switch_frame
= Qnil
;
11087 staticpro (&unread_switch_frame
);
11089 internal_last_event_frame
= Qnil
;
11090 staticpro (&internal_last_event_frame
);
11092 read_key_sequence_cmd
= Qnil
;
11093 staticpro (&read_key_sequence_cmd
);
11095 menu_bar_one_keymap_changed_items
= Qnil
;
11096 staticpro (&menu_bar_one_keymap_changed_items
);
11098 menu_bar_items_vector
= Qnil
;
11099 staticpro (&menu_bar_items_vector
);
11101 defsubr (&Sevent_convert_list
);
11102 defsubr (&Sread_key_sequence
);
11103 defsubr (&Sread_key_sequence_vector
);
11104 defsubr (&Srecursive_edit
);
11106 defsubr (&Strack_mouse
);
11108 defsubr (&Sinput_pending_p
);
11109 defsubr (&Scommand_execute
);
11110 defsubr (&Srecent_keys
);
11111 defsubr (&Sthis_command_keys
);
11112 defsubr (&Sthis_command_keys_vector
);
11113 defsubr (&Sthis_single_command_keys
);
11114 defsubr (&Sthis_single_command_raw_keys
);
11115 defsubr (&Sreset_this_command_lengths
);
11116 defsubr (&Sclear_this_command_keys
);
11117 defsubr (&Ssuspend_emacs
);
11118 defsubr (&Sabort_recursive_edit
);
11119 defsubr (&Sexit_recursive_edit
);
11120 defsubr (&Srecursion_depth
);
11121 defsubr (&Stop_level
);
11122 defsubr (&Sdiscard_input
);
11123 defsubr (&Sopen_dribble_file
);
11124 defsubr (&Sset_input_mode
);
11125 defsubr (&Scurrent_input_mode
);
11126 defsubr (&Sexecute_extended_command
);
11127 defsubr (&Sposn_at_point
);
11128 defsubr (&Sposn_at_x_y
);
11130 DEFVAR_LISP ("last-command-char", &last_command_char
,
11131 doc
: /* Last input event that was part of a command. */);
11133 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11134 doc
: /* Last input event that was part of a command. */);
11136 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11137 doc
: /* Last input event in a command, except for mouse menu events.
11138 Mouse menus give back keys that don't look like mouse events;
11139 this variable holds the actual mouse event that led to the menu,
11140 so that you can determine whether the command was run by mouse or not. */);
11142 DEFVAR_LISP ("last-input-char", &last_input_char
,
11143 doc
: /* Last input event. */);
11145 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11146 doc
: /* Last input event. */);
11148 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11149 doc
: /* List of events to be read as the command input.
11150 These events are processed first, before actual keyboard input. */);
11151 Vunread_command_events
= Qnil
;
11153 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11154 doc
: /* If not -1, an object to be read as next command input event. */);
11156 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11157 doc
: /* List of events to be processed as input by input methods.
11158 These events are processed after `unread-command-events', but
11159 before actual keyboard input. */);
11160 Vunread_post_input_method_events
= Qnil
;
11162 DEFVAR_LISP ("unread-input-method-events", &Vunread_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_input_method_events
= Qnil
;
11168 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11169 doc
: /* Meta-prefix character code.
11170 Meta-foo as command input turns into this character followed by foo. */);
11171 XSETINT (meta_prefix_char
, 033);
11173 DEFVAR_KBOARD ("last-command", Vlast_command
,
11174 doc
: /* The last command executed.
11175 Normally a symbol with a function definition, but can be whatever was found
11176 in the keymap, or whatever the variable `this-command' was set to by that
11179 The value `mode-exit' is special; it means that the previous command
11180 read an event that told it to exit, and it did so and unread that event.
11181 In other words, the present command is the event that made the previous
11184 The value `kill-region' is special; it means that the previous command
11185 was a kill command. */);
11187 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11188 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11190 DEFVAR_LISP ("this-command", &Vthis_command
,
11191 doc
: /* The command now being executed.
11192 The command can set this variable; whatever is put here
11193 will be in `last-command' during the following command. */);
11194 Vthis_command
= Qnil
;
11196 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11197 doc
: /* The command bound to the current key sequence before remapping.
11198 It equals `this-command' if the original command was not remapped through
11199 any of the active keymaps. Otherwise, the value of `this-command' is the
11200 result of looking up the original command in the active keymaps. */);
11201 Vthis_original_command
= Qnil
;
11203 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11204 doc
: /* *Number of input events between auto-saves.
11205 Zero means disable autosaving due to number of characters typed. */);
11206 auto_save_interval
= 300;
11208 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11209 doc
: /* *Number of seconds idle time before auto-save.
11210 Zero or nil means disable auto-saving due to idleness.
11211 After auto-saving due to this many seconds of idle time,
11212 Emacs also does a garbage collection if that seems to be warranted. */);
11213 XSETFASTINT (Vauto_save_timeout
, 30);
11215 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11216 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11217 The value may be integer or floating point. */);
11218 Vecho_keystrokes
= make_number (1);
11220 DEFVAR_INT ("polling-period", &polling_period
,
11221 doc
: /* *Interval between polling for input during Lisp execution.
11222 The reason for polling is to make C-g work to stop a running program.
11223 Polling is needed only when using X windows and SIGIO does not work.
11224 Polling is automatically disabled in all other cases. */);
11225 polling_period
= 2;
11227 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11228 doc
: /* *Maximum time between mouse clicks to make a double-click.
11229 Measured in milliseconds. nil means disable double-click recognition;
11230 t means double-clicks have no time limit and are detected
11231 by position only. */);
11232 Vdouble_click_time
= make_number (500);
11234 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11235 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11236 On window-system frames, value is the number of pixels the mouse may have
11237 moved horizontally or vertically between two clicks to make a double-click.
11238 On non window-system frames, value is interpreted in units of 1/8 characters
11241 This variable is also the threshold for motion of the mouse
11242 to count as a drag. */);
11243 double_click_fuzz
= 3;
11245 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11246 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11247 inhibit_local_menu_bar_menus
= 0;
11249 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11250 doc
: /* Number of complete key sequences read as input so far.
11251 This includes key sequences read from keyboard macros.
11252 The number is effectively the number of interactive command invocations. */);
11253 num_input_keys
= 0;
11255 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11256 doc
: /* Number of input events read from the keyboard so far.
11257 This does not include events generated by keyboard macros. */);
11258 num_nonmacro_input_events
= 0;
11260 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11261 doc
: /* The frame in which the most recently read event occurred.
11262 If the last event came from a keyboard macro, this is set to `macro'. */);
11263 Vlast_event_frame
= Qnil
;
11265 /* This variable is set up in sysdep.c. */
11266 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11267 doc
: /* The ERASE character as set by the user with stty. */);
11269 DEFVAR_LISP ("help-char", &Vhelp_char
,
11270 doc
: /* Character to recognize as meaning Help.
11271 When it is read, do `(eval help-form)', and display result if it's a string.
11272 If the value of `help-form' is nil, this char can be read normally. */);
11273 XSETINT (Vhelp_char
, Ctl ('H'));
11275 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11276 doc
: /* List of input events to recognize as meaning Help.
11277 These work just like the value of `help-char' (see that). */);
11278 Vhelp_event_list
= Qnil
;
11280 DEFVAR_LISP ("help-form", &Vhelp_form
,
11281 doc
: /* Form to execute when character `help-char' is read.
11282 If the form returns a string, that string is displayed.
11283 If `help-form' is nil, the help char is not recognized. */);
11286 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11287 doc
: /* Command to run when `help-char' character follows a prefix key.
11288 This command is used only when there is no actual binding
11289 for that character after that prefix key. */);
11290 Vprefix_help_command
= Qnil
;
11292 DEFVAR_LISP ("top-level", &Vtop_level
,
11293 doc
: /* Form to evaluate when Emacs starts up.
11294 Useful to set before you dump a modified Emacs. */);
11297 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11298 doc
: /* Translate table for keyboard input, or nil.
11299 If non-nil, the value should be a char-table. Each character read
11300 from the keyboard is looked up in this char-table. If the value found
11301 there is non-nil, then it is used instead of the actual input character.
11303 The value can also be a string or vector, but this is considered obsolete.
11304 If it is a string or vector of length N, character codes N and up are left
11305 untranslated. In a vector, an element which is nil means "no translation".
11307 This is applied to the characters supplied to input methods, not their
11308 output. See also `translation-table-for-input'. */);
11309 Vkeyboard_translate_table
= Qnil
;
11311 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11312 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11313 \(Even if the operating system has support for stopping a process.\) */);
11314 cannot_suspend
= 0;
11316 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11317 doc
: /* Non-nil means prompt with menus when appropriate.
11318 This is done when reading from a keymap that has a prompt string,
11319 for elements that have prompt strings.
11320 The menu is displayed on the screen
11321 if X menus were enabled at configuration
11322 time and the previous event was a mouse click prefix key.
11323 Otherwise, menu prompting uses the echo area. */);
11324 menu_prompting
= 1;
11326 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11327 doc
: /* Character to see next line of menu prompt.
11328 Type this character while in a menu prompt to rotate around the lines of it. */);
11329 XSETINT (menu_prompt_more_char
, ' ');
11331 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11332 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11333 Emacs applies the modifiers of the character stored here to each keyboard
11334 character it reads. For example, after evaluating the expression
11335 (setq extra-keyboard-modifiers ?\\C-x)
11336 all input characters will have the control modifier applied to them.
11338 Note that the character ?\\C-@, equivalent to the integer zero, does
11339 not count as a control character; rather, it counts as a character
11340 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11341 cancels any modification. */);
11342 extra_keyboard_modifiers
= 0;
11344 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11345 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11346 The command loop sets this to nil before each command,
11347 and tests the value when the command returns.
11348 Buffer modification stores t in this variable. */);
11349 Vdeactivate_mark
= Qnil
;
11351 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11352 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11353 Vcommand_hook_internal
= Qnil
;
11355 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11356 doc
: /* Normal hook run before each command is executed.
11357 If an unhandled error happens in running this hook,
11358 the hook value is set to nil, since otherwise the error
11359 might happen repeatedly and make Emacs nonfunctional. */);
11360 Vpre_command_hook
= Qnil
;
11362 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11363 doc
: /* Normal hook run after each command is executed.
11364 If an unhandled error happens in running this hook,
11365 the hook value is set to nil, since otherwise the error
11366 might happen repeatedly and make Emacs nonfunctional. */);
11367 Vpost_command_hook
= Qnil
;
11370 DEFVAR_LISP ("echo-area-clear-hook", ...,
11371 doc
: /* Normal hook run when clearing the echo area. */);
11373 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11374 staticpro (&Qecho_area_clear_hook
);
11375 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11377 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11378 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11379 Vlucid_menu_bar_dirty_flag
= Qnil
;
11381 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11382 doc
: /* List of menu bar items to move to the end of the menu bar.
11383 The elements of the list are event types that may have menu bar bindings. */);
11384 Vmenu_bar_final_items
= Qnil
;
11386 DEFVAR_KBOARD ("overriding-terminal-local-map",
11387 Voverriding_terminal_local_map
,
11388 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11389 If this variable is non-nil, it is used as a keymap instead of the
11390 buffer's local map, and the minor mode keymaps and text property keymaps.
11391 It also replaces `overriding-local-map'.
11393 This variable is intended to let commands such as `universal-argument'
11394 set up a different keymap for reading the next command. */);
11396 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11397 doc
: /* Keymap that overrides all other local keymaps.
11398 If this variable is non-nil, it is used as a keymap--replacing the
11399 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11400 Voverriding_local_map
= Qnil
;
11402 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11403 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11404 Otherwise, the menu bar continues to reflect the buffer's local map
11405 and the minor mode maps regardless of `overriding-local-map'. */);
11406 Voverriding_local_map_menu_flag
= Qnil
;
11408 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11409 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11410 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11412 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11413 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11415 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11416 doc
: /* Alist of system-specific X windows key symbols.
11417 Each element should have the form (N . SYMBOL) where N is the
11418 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11419 and SYMBOL is its name. */);
11421 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11422 doc
: /* List of deferred actions to be performed at a later time.
11423 The precise format isn't relevant here; we just check whether it is nil. */);
11424 Vdeferred_action_list
= Qnil
;
11426 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11427 doc
: /* Function to call to handle deferred actions, after each command.
11428 This function is called with no arguments after each command
11429 whenever `deferred-action-list' is non-nil. */);
11430 Vdeferred_action_function
= Qnil
;
11432 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11433 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11434 The value can be a length of time to show the message for.
11435 If the value is non-nil and not a number, we wait 2 seconds. */);
11436 Vsuggest_key_bindings
= Qt
;
11438 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11439 doc
: /* List of active absolute time timers in order of increasing time. */);
11440 Vtimer_list
= Qnil
;
11442 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11443 doc
: /* List of active idle-time timers in order of increasing time. */);
11444 Vtimer_idle_list
= Qnil
;
11446 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11447 doc
: /* If non-nil, the function that implements the current input method.
11448 It's called with one argument, a printing character that was just read.
11449 \(That means a character with code 040...0176.)
11450 Typically this function uses `read-event' to read additional events.
11451 When it does so, it should first bind `input-method-function' to nil
11452 so it will not be called recursively.
11454 The function should return a list of zero or more events
11455 to be used as input. If it wants to put back some events
11456 to be reconsidered, separately, by the input method,
11457 it can add them to the beginning of `unread-command-events'.
11459 The input method function can find in `input-method-previous-method'
11460 the previous echo area message.
11462 The input method function should refer to the variables
11463 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11464 for guidance on what to do. */);
11465 Vinput_method_function
= Qnil
;
11467 DEFVAR_LISP ("input-method-previous-message",
11468 &Vinput_method_previous_message
,
11469 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11470 This variable exists because `read-event' clears the echo area
11471 before running the input method. It is nil if there was no message. */);
11472 Vinput_method_previous_message
= Qnil
;
11474 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11475 doc
: /* If non-nil, the function that implements the display of help.
11476 It's called with one argument, the help string to display. */);
11477 Vshow_help_function
= Qnil
;
11479 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11480 doc
: /* If non-nil, suppress point adjustment after executing a command.
11482 After a command is executed, if point is moved into a region that has
11483 special properties (e.g. composition, display), we adjust point to
11484 the boundary of the region. But, when a command sets this variable to
11485 non-nil, we suppress the point adjustment.
11487 This variable is set to nil before reading a command, and is checked
11488 just after executing the command. */);
11489 Vdisable_point_adjustment
= Qnil
;
11491 DEFVAR_LISP ("global-disable-point-adjustment",
11492 &Vglobal_disable_point_adjustment
,
11493 doc
: /* *If non-nil, always suppress point adjustment.
11495 The default value is nil, in which case, point adjustment are
11496 suppressed only after special commands that set
11497 `disable-point-adjustment' (which see) to non-nil. */);
11498 Vglobal_disable_point_adjustment
= Qnil
;
11500 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11501 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11502 If the value is not a number, such messages don't time out. */);
11503 Vminibuffer_message_timeout
= make_number (2);
11505 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11506 doc
: /* If non-nil, any keyboard input throws to this symbol.
11507 The value of that variable is passed to `quit-flag' and later causes a
11508 peculiar kind of quitting. */);
11509 Vthrow_on_input
= Qnil
;
11511 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
11512 doc
: /* If non-nil, function to output error messages.
11513 The arguments are the error data, a list of the form
11514 (SIGNALED-CONDITIONS . SIGNAL-DATA)
11515 such as just as `condition-case' would bind its variable to,
11516 the context (a string which normally goes at the start of the message),
11517 and the Lisp function within which the error was signaled. */);
11518 Vcommand_error_function
= Qnil
;
11520 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11521 &Venable_disabled_menus_and_buttons
,
11522 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11524 Help functions bind this to allow help on disabled menu items
11525 and tool-bar buttons. */);
11526 Venable_disabled_menus_and_buttons
= Qnil
;
11530 keys_of_keyboard ()
11532 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11533 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11534 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11535 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11536 initial_define_key (meta_map
, 'x', "execute-extended-command");
11538 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11539 "handle-delete-frame");
11540 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11541 current-prefix-arg, as is done in `handle-switch-frame'.
11542 But `handle-switch-frame is not run from the special-map.
11543 Commands from that map are run in a special way that automatically
11544 preserves the prefix-arg. Restoring the prefix arg here is not just
11545 redundant but harmful:
11547 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11548 - after the first prompt, the exit-minibuffer-hook is run which may
11549 iconify a frame and thus push a `iconify-frame' event.
11550 - after running exit-minibuffer-hook, current-prefix-arg is
11551 restored to the non-nil value it had before the prompt.
11552 - we enter the second prompt.
11553 current-prefix-arg is non-nil, prefix-arg is nil.
11554 - before running the first real event, we run the special iconify-frame
11555 event, but we pass the `special' arg to execute-command so
11556 current-prefix-arg and prefix-arg are left untouched.
11557 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11558 - the next key event will have a spuriously non-nil current-prefix-arg. */
11559 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11561 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11563 /* Handling it at such a low-level causes read_key_sequence to get
11564 * confused because it doesn't realize that the current_buffer was
11565 * changed by read_char.
11567 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11568 * "handle-select-window"); */
11569 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11570 "handle-save-session");
11573 /* Mark the pointers in the kboard objects.
11574 Called by the Fgarbage_collector. */
11580 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11582 if (kb
->kbd_macro_buffer
)
11583 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11585 mark_object (kb
->Voverriding_terminal_local_map
);
11586 mark_object (kb
->Vlast_command
);
11587 mark_object (kb
->Vreal_last_command
);
11588 mark_object (kb
->Vprefix_arg
);
11589 mark_object (kb
->Vlast_prefix_arg
);
11590 mark_object (kb
->kbd_queue
);
11591 mark_object (kb
->defining_kbd_macro
);
11592 mark_object (kb
->Vlast_kbd_macro
);
11593 mark_object (kb
->Vsystem_key_alist
);
11594 mark_object (kb
->system_key_syms
);
11595 mark_object (kb
->Vdefault_minibuffer_frame
);
11596 mark_object (kb
->echo_string
);
11599 struct input_event
*event
;
11600 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11602 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11603 event
= kbd_buffer
;
11604 if (event
->kind
!= SELECTION_REQUEST_EVENT
11605 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11607 mark_object (event
->x
);
11608 mark_object (event
->y
);
11610 mark_object (event
->frame_or_window
);
11611 mark_object (event
->arg
);
11616 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11617 (do not change this comment) */