1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
3 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
29 #include "termhooks.h"
38 #include "dispextern.h"
40 #include "intervals.h"
42 #include "blockinput.h"
49 #ifdef HAVE_GTK_AND_PTHREAD
57 #include <sys/ioctl.h>
59 #endif /* not MSDOS */
61 #include "syssignal.h"
64 #include <sys/types.h>
73 /* This is to get the definitions of the XK_ symbols. */
80 #endif /* HAVE_NTGUI */
90 /* Variables for blockinput.h: */
92 /* Non-zero if interrupt input is blocked right now. */
93 volatile int interrupt_input_blocked
;
95 /* Nonzero means an input interrupt has arrived
96 during the current critical section. */
97 int interrupt_input_pending
;
100 /* File descriptor to use for input. */
103 #ifdef HAVE_WINDOW_SYSTEM
104 /* Make all keyboard buffers much bigger when using X windows. */
106 /* But not too big (local data > 32K error) if on Mac OS Classic. */
107 #define KBD_BUFFER_SIZE 512
109 #define KBD_BUFFER_SIZE 4096
111 #else /* No X-windows, character input */
112 #define KBD_BUFFER_SIZE 4096
113 #endif /* No X-windows */
115 #define abs(x) ((x) >= 0 ? (x) : -(x))
117 /* Following definition copied from eval.c */
121 struct backtrace
*next
;
122 Lisp_Object
*function
;
123 Lisp_Object
*args
; /* Points to vector of args. */
124 int nargs
; /* length of vector. If nargs is UNEVALLED,
125 args points to slot holding list of
128 /* Nonzero means call value of debugger when done with this operation. */
133 KBOARD
*initial_kboard
;
134 KBOARD
*current_kboard
;
138 KBOARD the_only_kboard
;
141 /* Non-nil disable property on a command means
142 do not execute it; call disabled-command-function's value instead. */
143 Lisp_Object Qdisabled
, Qdisabled_command_function
;
145 #define NUM_RECENT_KEYS (300)
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
; /* Vector holds the last NUM_RECENT_KEYS 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 if the two pointers are not equal.
505 Why not just have a flag set and cleared by the enqueuing and
506 dequeuing functions? Such a flag could be screwed up by interrupts
507 at inopportune times. */
509 /* If this flag is non-nil, we check mouse_moved to see when the
510 mouse moves, and motion events will appear in the input stream.
511 Otherwise, mouse motion is ignored. */
512 Lisp_Object do_mouse_tracking
;
514 /* Symbols to head events. */
515 Lisp_Object Qmouse_movement
;
516 Lisp_Object Qscroll_bar_movement
;
517 Lisp_Object Qswitch_frame
;
518 Lisp_Object Qdelete_frame
;
519 Lisp_Object Qiconify_frame
;
520 Lisp_Object Qmake_frame_visible
;
521 Lisp_Object Qselect_window
;
522 Lisp_Object Qhelp_echo
;
525 Lisp_Object Qmouse_fixup_help_message
;
528 /* Symbols to denote kinds of events. */
529 Lisp_Object Qfunction_key
;
530 Lisp_Object Qmouse_click
;
531 #if defined (WINDOWSNT) || defined (MAC_OS)
532 Lisp_Object Qlanguage_change
;
534 Lisp_Object Qdrag_n_drop
;
535 Lisp_Object Qsave_session
;
537 Lisp_Object Qmac_apple_event
;
540 /* Lisp_Object Qmouse_movement; - also an event header */
542 /* Properties of event headers. */
543 Lisp_Object Qevent_kind
;
544 Lisp_Object Qevent_symbol_elements
;
546 /* menu item parts */
547 Lisp_Object Qmenu_alias
;
548 Lisp_Object Qmenu_enable
;
549 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
550 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
551 extern Lisp_Object Vdefine_key_rebound_commands
;
552 extern Lisp_Object Qmenu_item
;
554 /* An event header symbol HEAD may have a property named
555 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
556 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
557 mask of modifiers applied to it. If present, this is used to help
558 speed up parse_modifiers. */
559 Lisp_Object Qevent_symbol_element_mask
;
561 /* An unmodified event header BASE may have a property named
562 Qmodifier_cache, which is an alist mapping modifier masks onto
563 modified versions of BASE. If present, this helps speed up
565 Lisp_Object Qmodifier_cache
;
567 /* Symbols to use for parts of windows. */
568 Lisp_Object Qmode_line
;
569 Lisp_Object Qvertical_line
;
570 Lisp_Object Qvertical_scroll_bar
;
571 Lisp_Object Qmenu_bar
;
572 extern Lisp_Object Qleft_margin
, Qright_margin
;
573 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
574 extern Lisp_Object QCmap
;
576 Lisp_Object
recursive_edit_unwind (), command_loop ();
577 Lisp_Object
Fthis_command_keys ();
578 Lisp_Object Qextended_command_history
;
579 EMACS_TIME
timer_check ();
581 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
583 extern char *x_get_keysym_name ();
585 static void record_menu_key ();
586 static int echo_length ();
588 Lisp_Object Qpolling_period
;
590 /* List of absolute timers. Appears in order of next scheduled event. */
591 Lisp_Object Vtimer_list
;
593 /* List of idle time timers. Appears in order of next scheduled event. */
594 Lisp_Object Vtimer_idle_list
;
596 /* Incremented whenever a timer is run. */
599 extern Lisp_Object Vprint_level
, Vprint_length
;
601 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
603 EMACS_TIME
*input_available_clear_time
;
605 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
606 Default is 1 if INTERRUPT_INPUT is defined. */
609 /* Nonzero while interrupts are temporarily deferred during redisplay. */
610 int interrupts_deferred
;
612 /* Nonzero means use ^S/^Q for flow control. */
615 /* Allow m- file to inhibit use of FIONREAD. */
616 #ifdef BROKEN_FIONREAD
620 /* We are unable to use interrupts if FIONREAD is not available,
621 so flush SIGIO so we won't try. */
622 #if !defined (FIONREAD)
628 /* If we support a window system, turn on the code to poll periodically
629 to detect C-g. It isn't actually used when doing interrupt input. */
630 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
631 #define POLL_FOR_INPUT
634 /* After a command is executed, if point is moved into a region that
635 has specific properties (e.g. composition, display), we adjust
636 point to the boundary of the region. But, if a command sets this
637 variable to non-nil, we suppress this point adjustment. This
638 variable is set to nil before reading a command. */
640 Lisp_Object Vdisable_point_adjustment
;
642 /* If non-nil, always disable point adjustment. */
644 Lisp_Object Vglobal_disable_point_adjustment
;
646 /* The time when Emacs started being idle. */
648 static EMACS_TIME timer_idleness_start_time
;
650 /* After Emacs stops being idle, this saves the last value
651 of timer_idleness_start_time from when it was idle. */
653 static EMACS_TIME timer_last_idleness_start_time
;
655 /* If non-nil, events produced by disabled menu items and tool-bar
656 buttons are not ignored. Help functions bind this to allow help on
657 those items and buttons. */
658 Lisp_Object Venable_disabled_menus_and_buttons
;
661 /* Global variable declarations. */
663 /* Flags for readable_events. */
664 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
665 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
666 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
668 /* Function for init_keyboard to call with no args (if nonzero). */
669 void (*keyboard_init_hook
) ();
671 static int read_avail_input
P_ ((int));
672 static void get_input_pending
P_ ((int *, int));
673 static int readable_events
P_ ((int));
674 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
675 Lisp_Object
, int *));
676 static Lisp_Object
read_char_x_menu_prompt ();
677 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
679 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
681 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
682 enum scroll_bar_part
,
683 Lisp_Object
, Lisp_Object
,
686 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
687 Lisp_Object
, char **,
688 Lisp_Object
*, unsigned));
689 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
690 static int parse_solitary_modifier
P_ ((Lisp_Object
));
691 static int parse_solitary_modifier ();
692 static void save_getcjmp
P_ ((jmp_buf));
693 static void save_getcjmp ();
694 static void restore_getcjmp
P_ ((jmp_buf));
695 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
696 static void clear_event
P_ ((struct input_event
*));
697 static void any_kboard_state
P_ ((void));
698 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
699 static void timer_start_idle
P_ ((void));
700 static void timer_stop_idle
P_ ((void));
701 static void timer_resume_idle
P_ ((void));
702 static SIGTYPE handle_user_signal
P_ ((int));
703 static char *find_user_signal_name
P_ ((int));
704 static int store_user_signal_events
P_ ((void));
706 /* Nonzero means don't try to suspend even if the operating system seems
708 static int cannot_suspend
;
710 extern Lisp_Object Qidentity
, Qonly
;
712 /* Install the string STR as the beginning of the string of echoing,
713 so that it serves as a prompt for the next character.
714 Also start echoing. */
720 current_kboard
->echo_string
= str
;
721 current_kboard
->echo_after_prompt
= SCHARS (str
);
725 /* Add C to the echo string, if echoing is going on.
726 C can be a character, which is printed prettily ("M-C-x" and all that
727 jazz), or a symbol, whose name is printed. */
733 if (current_kboard
->immediate_echo
)
735 int size
= KEY_DESCRIPTION_SIZE
+ 100;
736 char *buffer
= (char *) alloca (size
);
738 Lisp_Object echo_string
;
740 echo_string
= current_kboard
->echo_string
;
742 /* If someone has passed us a composite event, use its head symbol. */
747 ptr
= push_key_description (XINT (c
), ptr
, 1);
749 else if (SYMBOLP (c
))
751 Lisp_Object name
= SYMBOL_NAME (c
);
752 int nbytes
= SBYTES (name
);
754 if (size
- (ptr
- buffer
) < nbytes
)
756 int offset
= ptr
- buffer
;
757 size
= max (2 * size
, size
+ nbytes
);
758 buffer
= (char *) alloca (size
);
759 ptr
= buffer
+ offset
;
762 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
763 STRING_MULTIBYTE (name
), 1);
766 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
769 const char *text
= " (Type ? for further options)";
770 int len
= strlen (text
);
772 if (size
- (ptr
- buffer
) < len
)
774 int offset
= ptr
- buffer
;
776 buffer
= (char *) alloca (size
);
777 ptr
= buffer
+ offset
;
780 bcopy (text
, ptr
, len
);
784 /* Replace a dash from echo_dash with a space, otherwise
785 add a space at the end as a separator between keys. */
786 if (STRINGP (echo_string
)
787 && SCHARS (echo_string
) > 1)
789 Lisp_Object last_char
, prev_char
, idx
;
791 idx
= make_number (SCHARS (echo_string
) - 2);
792 prev_char
= Faref (echo_string
, idx
);
794 idx
= make_number (SCHARS (echo_string
) - 1);
795 last_char
= Faref (echo_string
, idx
);
797 /* We test PREV_CHAR to make sure this isn't the echoing
799 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
800 Faset (echo_string
, idx
, make_number (' '));
802 echo_string
= concat2 (echo_string
, build_string (" "));
804 else if (STRINGP (echo_string
))
805 echo_string
= concat2 (echo_string
, build_string (" "));
807 current_kboard
->echo_string
808 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
814 /* Temporarily add a dash to the end of the echo string if it's not
815 empty, so that it serves as a mini-prompt for the very next character. */
820 /* Do nothing if not echoing at all. */
821 if (NILP (current_kboard
->echo_string
))
824 if (!current_kboard
->immediate_echo
825 && SCHARS (current_kboard
->echo_string
) == 0)
828 /* Do nothing if we just printed a prompt. */
829 if (current_kboard
->echo_after_prompt
830 == SCHARS (current_kboard
->echo_string
))
833 /* Do nothing if we have already put a dash at the end. */
834 if (SCHARS (current_kboard
->echo_string
) > 1)
836 Lisp_Object last_char
, prev_char
, idx
;
838 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
839 prev_char
= Faref (current_kboard
->echo_string
, idx
);
841 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
842 last_char
= Faref (current_kboard
->echo_string
, idx
);
844 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
848 /* Put a dash at the end of the buffer temporarily,
849 but make it go away when the next character is added. */
850 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
855 /* Display the current echo string, and begin echoing if not already
861 if (!current_kboard
->immediate_echo
)
864 current_kboard
->immediate_echo
= 1;
866 for (i
= 0; i
< this_command_key_count
; i
++)
870 /* Set before_command_echo_length to the value that would
871 have been saved before the start of this subcommand in
872 command_loop_1, if we had already been echoing then. */
873 if (i
== this_single_command_key_start
)
874 before_command_echo_length
= echo_length ();
876 c
= XVECTOR (this_command_keys
)->contents
[i
];
877 if (! (EVENT_HAS_PARAMETERS (c
)
878 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
882 /* Set before_command_echo_length to the value that would
883 have been saved before the start of this subcommand in
884 command_loop_1, if we had already been echoing then. */
885 if (this_command_key_count
== this_single_command_key_start
)
886 before_command_echo_length
= echo_length ();
888 /* Put a dash at the end to invite the user to type more. */
893 message3_nolog (current_kboard
->echo_string
,
894 SBYTES (current_kboard
->echo_string
),
895 STRING_MULTIBYTE (current_kboard
->echo_string
));
898 /* Record in what buffer we echoed, and from which kboard. */
899 echo_message_buffer
= echo_area_buffer
[0];
900 echo_kboard
= current_kboard
;
902 if (waiting_for_input
&& !NILP (Vquit_flag
))
903 quit_throw_to_read_char ();
906 /* Turn off echoing, for the start of a new command. */
911 current_kboard
->immediate_echo
= 0;
912 current_kboard
->echo_after_prompt
= -1;
913 current_kboard
->echo_string
= Qnil
;
914 ok_to_echo_at_next_pause
= NULL
;
916 echo_message_buffer
= Qnil
;
919 /* Return the length of the current echo string. */
924 return (STRINGP (current_kboard
->echo_string
)
925 ? SCHARS (current_kboard
->echo_string
)
929 /* Truncate the current echo message to its first LEN chars.
930 This and echo_char get used by read_key_sequence when the user
931 switches frames while entering a key sequence. */
934 echo_truncate (nchars
)
937 if (STRINGP (current_kboard
->echo_string
))
938 current_kboard
->echo_string
939 = Fsubstring (current_kboard
->echo_string
,
940 make_number (0), make_number (nchars
));
941 truncate_echo_area (nchars
);
945 /* Functions for manipulating this_command_keys. */
947 add_command_key (key
)
950 #if 0 /* Not needed after we made Freset_this_command_lengths
951 do the job immediately. */
952 /* If reset-this-command-length was called recently, obey it now.
953 See the doc string of that function for an explanation of why. */
954 if (before_command_restore_flag
)
956 this_command_key_count
= before_command_key_count_1
;
957 if (this_command_key_count
< this_single_command_key_start
)
958 this_single_command_key_start
= this_command_key_count
;
959 echo_truncate (before_command_echo_length_1
);
960 before_command_restore_flag
= 0;
964 if (this_command_key_count
>= ASIZE (this_command_keys
))
965 this_command_keys
= larger_vector (this_command_keys
,
966 2 * ASIZE (this_command_keys
),
969 AREF (this_command_keys
, this_command_key_count
) = key
;
970 ++this_command_key_count
;
977 int count
= SPECPDL_INDEX ();
980 if (command_loop_level
> 0)
982 specbind (Qstandard_output
, Qt
);
983 specbind (Qstandard_input
, Qt
);
986 #ifdef HAVE_X_WINDOWS
987 /* The command loop has started an hourglass timer, so we have to
988 cancel it here, otherwise it will fire because the recursive edit
989 can take some time. Do not check for display_hourglass_p here,
990 because it could already be nil. */
994 /* This function may have been called from a debugger called from
995 within redisplay, for instance by Edebugging a function called
996 from fontification-functions. We want to allow redisplay in
997 the debugging session.
999 The recursive edit is left with a `(throw exit ...)'. The `exit'
1000 tag is not caught anywhere in redisplay, i.e. when we leave the
1001 recursive edit, the original redisplay leading to the recursive
1002 edit will be unwound. The outcome should therefore be safe. */
1003 specbind (Qinhibit_redisplay
, Qnil
);
1006 val
= command_loop ();
1008 Fsignal (Qquit
, Qnil
);
1009 /* Handle throw from read_minibuf when using minibuffer
1010 while it's active but we're in another window. */
1012 xsignal1 (Qerror
, val
);
1014 return unbind_to (count
, Qnil
);
1017 /* When an auto-save happens, record the "time", and don't do again soon. */
1022 last_auto_save
= num_nonmacro_input_events
;
1025 /* Make an auto save happen as soon as possible at command level. */
1028 force_auto_save_soon ()
1030 last_auto_save
= - auto_save_interval
- 1;
1032 record_asynch_buffer_change ();
1035 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1036 doc
: /* Invoke the editor command loop recursively.
1037 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1038 that tells this function to return.
1039 Alternatively, `(throw 'exit t)' makes this function signal an error.
1040 This function is called by the editor initialization to begin editing. */)
1043 int count
= SPECPDL_INDEX ();
1046 /* If we enter while input is blocked, don't lock up here.
1047 This may happen through the debugger during redisplay. */
1048 if (INPUT_BLOCKED_P
)
1051 command_loop_level
++;
1052 update_mode_lines
= 1;
1054 if (command_loop_level
1055 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1056 buffer
= Fcurrent_buffer ();
1060 /* If we leave recursive_edit_1 below with a `throw' for instance,
1061 like it is done in the splash screen display, we have to
1062 make sure that we restore single_kboard as command_loop_1
1063 would have done if it were left normally. */
1064 record_unwind_protect (recursive_edit_unwind
,
1065 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1067 recursive_edit_1 ();
1068 return unbind_to (count
, Qnil
);
1072 recursive_edit_unwind (info
)
1075 if (BUFFERP (XCAR (info
)))
1076 Fset_buffer (XCAR (info
));
1078 if (NILP (XCDR (info
)))
1079 any_kboard_state ();
1081 single_kboard_state ();
1083 command_loop_level
--;
1084 update_mode_lines
= 1;
1093 #if 0 /* Theory: if there's anything in Vunread_command_events,
1094 it will right away be read by read_key_sequence,
1095 and then if we do switch KBOARDS, it will go into the side
1096 queue then. So we don't need to do anything special here -- rms. */
1097 if (CONSP (Vunread_command_events
))
1099 current_kboard
->kbd_queue
1100 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1101 current_kboard
->kbd_queue_has_data
= 1;
1103 Vunread_command_events
= Qnil
;
1109 /* Switch to the single-kboard state, making current_kboard
1110 the only KBOARD from which further input is accepted. */
1113 single_kboard_state ()
1120 /* If we're in single_kboard state for kboard KBOARD,
1124 not_single_kboard_state (kboard
)
1128 if (kboard
== current_kboard
)
1133 /* Maintain a stack of kboards, so other parts of Emacs
1134 can switch temporarily to the kboard of a given frame
1135 and then revert to the previous status. */
1140 struct kboard_stack
*next
;
1143 static struct kboard_stack
*kboard_stack
;
1146 push_frame_kboard (f
)
1150 struct kboard_stack
*p
1151 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1153 p
->next
= kboard_stack
;
1154 p
->kboard
= current_kboard
;
1157 current_kboard
= FRAME_KBOARD (f
);
1165 struct kboard_stack
*p
= kboard_stack
;
1166 current_kboard
= p
->kboard
;
1167 kboard_stack
= p
->next
;
1172 /* Handle errors that are not handled at inner levels
1173 by printing an error message and returning to the editor command loop. */
1179 Lisp_Object old_level
, old_length
;
1180 char macroerror
[50];
1182 #ifdef HAVE_X_WINDOWS
1183 if (display_hourglass_p
)
1184 cancel_hourglass ();
1187 if (!NILP (executing_kbd_macro
))
1189 if (executing_kbd_macro_iterations
== 1)
1190 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1192 sprintf (macroerror
, "After %d kbd macro iterations: ",
1193 executing_kbd_macro_iterations
);
1198 Vstandard_output
= Qt
;
1199 Vstandard_input
= Qt
;
1200 Vexecuting_kbd_macro
= Qnil
;
1201 executing_kbd_macro
= Qnil
;
1202 current_kboard
->Vprefix_arg
= Qnil
;
1203 current_kboard
->Vlast_prefix_arg
= Qnil
;
1206 /* Avoid unquittable loop if data contains a circular list. */
1207 old_level
= Vprint_level
;
1208 old_length
= Vprint_length
;
1209 XSETFASTINT (Vprint_level
, 10);
1210 XSETFASTINT (Vprint_length
, 10);
1211 cmd_error_internal (data
, macroerror
);
1212 Vprint_level
= old_level
;
1213 Vprint_length
= old_length
;
1217 Vinhibit_quit
= Qnil
;
1219 if (command_loop_level
== 0 && minibuf_level
== 0)
1220 any_kboard_state ();
1223 return make_number (0);
1226 /* Take actions on handling an error. DATA is the data that describes
1229 CONTEXT is a C-string containing ASCII characters only which
1230 describes the context in which the error happened. If we need to
1231 generalize CONTEXT to allow multibyte characters, make it a Lisp
1235 cmd_error_internal (data
, context
)
1239 struct frame
*sf
= SELECTED_FRAME ();
1241 /* The immediate context is not interesting for Quits,
1242 since they are asyncronous. */
1243 if (EQ (XCAR (data
), Qquit
))
1244 Vsignaling_function
= Qnil
;
1249 /* Use user's specified output function if any. */
1250 if (!NILP (Vcommand_error_function
))
1251 call3 (Vcommand_error_function
, data
,
1252 build_string (context
? context
: ""),
1253 Vsignaling_function
);
1254 /* If the window system or terminal frame hasn't been initialized
1255 yet, or we're not interactive, write the message to stderr and exit. */
1256 else if (!sf
->glyphs_initialized_p
1257 /* This is the case of the frame dumped with Emacs, when we're
1258 running under a window system. */
1259 || (!NILP (Vwindow_system
)
1260 && !inhibit_window_system
1261 && FRAME_TERMCAP_P (sf
))
1264 print_error_message (data
, Qexternal_debugging_output
,
1265 context
, Vsignaling_function
);
1266 Fterpri (Qexternal_debugging_output
);
1267 Fkill_emacs (make_number (-1));
1271 clear_message (1, 0);
1273 message_log_maybe_newline ();
1276 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1279 Vsignaling_function
= Qnil
;
1282 Lisp_Object
command_loop_1 ();
1283 Lisp_Object
command_loop_2 ();
1284 Lisp_Object
top_level_1 ();
1286 /* Entry to editor-command-loop.
1287 This level has the catches for exiting/returning to editor command loop.
1288 It returns nil to exit recursive edit, t to abort it. */
1293 if (command_loop_level
> 0 || minibuf_level
> 0)
1296 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1297 executing_kbd_macro
= Qnil
;
1303 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1304 /* Reset single_kboard in case top-level set it while
1305 evaluating an -f option, or we are stuck there for some
1307 any_kboard_state ();
1308 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1309 executing_kbd_macro
= Qnil
;
1311 /* End of file in -batch run causes exit here. */
1317 /* Here we catch errors in execution of commands within the
1318 editing loop, and reenter the editing loop.
1319 When there is an error, cmd_error runs and returns a non-nil
1320 value to us. A value of nil means that command_loop_1 itself
1321 returned due to end of file (or end of kbd macro). */
1326 register Lisp_Object val
;
1329 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1330 while (!NILP (val
));
1338 return Feval (Vtop_level
);
1344 /* On entry to the outer level, run the startup file */
1345 if (!NILP (Vtop_level
))
1346 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1347 else if (!NILP (Vpurify_flag
))
1348 message ("Bare impure Emacs (standard Lisp code not loaded)");
1350 message ("Bare Emacs (standard Lisp code not loaded)");
1354 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1355 doc
: /* Exit all recursive editing levels. */)
1358 #ifdef HAVE_X_WINDOWS
1359 if (display_hourglass_p
)
1360 cancel_hourglass ();
1363 /* Unblock input if we enter with input blocked. This may happen if
1364 redisplay traps e.g. during tool-bar update with input blocked. */
1365 while (INPUT_BLOCKED_P
)
1368 return Fthrow (Qtop_level
, Qnil
);
1371 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1372 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1375 if (command_loop_level
> 0 || minibuf_level
> 0)
1376 Fthrow (Qexit
, Qnil
);
1378 error ("No recursive edit is in progress");
1382 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1383 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1386 if (command_loop_level
> 0 || minibuf_level
> 0)
1389 error ("No recursive edit is in progress");
1395 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1396 of this function. */
1399 tracking_off (old_value
)
1400 Lisp_Object old_value
;
1402 do_mouse_tracking
= old_value
;
1403 if (NILP (old_value
))
1405 /* Redisplay may have been preempted because there was input
1406 available, and it assumes it will be called again after the
1407 input has been processed. If the only input available was
1408 the sort that we have just disabled, then we need to call
1410 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1412 redisplay_preserve_echo_area (6);
1413 get_input_pending (&input_pending
,
1414 READABLE_EVENTS_DO_TIMERS_NOW
);
1420 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1421 doc
: /* Evaluate BODY with mouse movement events enabled.
1422 Within a `track-mouse' form, mouse motion generates input events that
1423 you can read with `read-event'.
1424 Normally, mouse motion is ignored.
1425 usage: (track-mouse BODY...) */)
1429 int count
= SPECPDL_INDEX ();
1432 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1434 do_mouse_tracking
= Qt
;
1436 val
= Fprogn (args
);
1437 return unbind_to (count
, val
);
1440 /* If mouse has moved on some frame, return one of those frames.
1444 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1445 after resizing the tool-bar window. */
1447 int ignore_mouse_drag_p
;
1452 Lisp_Object tail
, frame
;
1454 if (ignore_mouse_drag_p
)
1456 /* ignore_mouse_drag_p = 0; */
1460 FOR_EACH_FRAME (tail
, frame
)
1462 if (XFRAME (frame
)->mouse_moved
)
1463 return XFRAME (frame
);
1469 #endif /* HAVE_MOUSE */
1471 /* This is the actual command reading loop,
1472 sans error-handling encapsulation. */
1474 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1476 void safe_run_hooks
P_ ((Lisp_Object
));
1477 static void adjust_point_for_property
P_ ((int, int));
1479 /* Cancel hourglass from protect_unwind.
1481 #ifdef HAVE_X_WINDOWS
1483 cancel_hourglass_unwind (arg
)
1486 cancel_hourglass ();
1497 Lisp_Object keybuf
[30];
1500 int prev_modiff
= 0;
1501 struct buffer
*prev_buffer
= NULL
;
1503 int was_locked
= single_kboard
;
1505 int already_adjusted
;
1507 current_kboard
->Vprefix_arg
= Qnil
;
1508 current_kboard
->Vlast_prefix_arg
= Qnil
;
1509 Vdeactivate_mark
= Qnil
;
1510 waiting_for_input
= 0;
1514 this_command_key_count
= 0;
1515 this_command_key_count_reset
= 0;
1516 this_single_command_key_start
= 0;
1518 if (NILP (Vmemory_full
))
1520 /* Make sure this hook runs after commands that get errors and
1521 throw to top level. */
1522 /* Note that the value cell will never directly contain nil
1523 if the symbol is a local variable. */
1524 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1525 safe_run_hooks (Qpost_command_hook
);
1527 /* If displaying a message, resize the echo area window to fit
1528 that message's size exactly. */
1529 if (!NILP (echo_area_buffer
[0]))
1530 resize_echo_area_exactly ();
1532 if (!NILP (Vdeferred_action_list
))
1533 safe_run_hooks (Qdeferred_action_function
);
1536 /* Do this after running Vpost_command_hook, for consistency. */
1537 current_kboard
->Vlast_command
= Vthis_command
;
1538 current_kboard
->Vreal_last_command
= real_this_command
;
1539 if (!CONSP (last_command_char
))
1540 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1544 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1547 /* Make sure the current window's buffer is selected. */
1548 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1549 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1551 /* Display any malloc warning that just came out. Use while because
1552 displaying one warning can cause another. */
1554 while (pending_malloc_warning
)
1555 display_malloc_warning ();
1559 Vdeactivate_mark
= Qnil
;
1561 /* If minibuffer on and echo area in use,
1562 wait a short time and redraw minibuffer. */
1565 && !NILP (echo_area_buffer
[0])
1566 && EQ (minibuf_window
, echo_area_window
))
1568 /* Bind inhibit-quit to t so that C-g gets read in
1569 rather than quitting back to the minibuffer. */
1570 int count
= SPECPDL_INDEX ();
1571 specbind (Qinhibit_quit
, Qt
);
1573 if (NUMBERP (Vminibuffer_message_timeout
))
1574 sit_for (Vminibuffer_message_timeout
, 0, 2);
1578 /* Clear the echo area. */
1580 safe_run_hooks (Qecho_area_clear_hook
);
1582 unbind_to (count
, Qnil
);
1584 /* If a C-g came in before, treat it as input now. */
1585 if (!NILP (Vquit_flag
))
1588 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1593 alloca (0); /* Cause a garbage collection now */
1594 /* Since we can free the most stuff here. */
1595 #endif /* C_ALLOCA */
1598 /* Select the frame that the last event came from. Usually,
1599 switch-frame events will take care of this, but if some lisp
1600 code swallows a switch-frame event, we'll fix things up here.
1601 Is this a good idea? */
1602 if (FRAMEP (internal_last_event_frame
)
1603 && !EQ (internal_last_event_frame
, selected_frame
))
1604 Fselect_frame (internal_last_event_frame
);
1606 /* If it has changed current-menubar from previous value,
1607 really recompute the menubar from the value. */
1608 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1609 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1610 call0 (Qrecompute_lucid_menubar
);
1612 before_command_key_count
= this_command_key_count
;
1613 before_command_echo_length
= echo_length ();
1615 Vthis_command
= Qnil
;
1616 real_this_command
= Qnil
;
1617 Vthis_original_command
= Qnil
;
1619 /* Read next key sequence; i gets its length. */
1620 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1623 /* A filter may have run while we were reading the input. */
1624 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1626 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1627 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1631 /* Now we have read a key sequence of length I,
1632 or else I is 0 and we found end of file. */
1634 if (i
== 0) /* End of file -- happens only in */
1635 return Qnil
; /* a kbd macro, at the end. */
1636 /* -1 means read_key_sequence got a menu that was rejected.
1637 Just loop around and read another command. */
1641 this_command_key_count
= 0;
1642 this_command_key_count_reset
= 0;
1643 this_single_command_key_start
= 0;
1647 last_command_char
= keybuf
[i
- 1];
1649 /* If the previous command tried to force a specific window-start,
1650 forget about that, in case this command moves point far away
1651 from that position. But also throw away beg_unchanged and
1652 end_unchanged information in that case, so that redisplay will
1653 update the whole window properly. */
1654 if (!NILP (XWINDOW (selected_window
)->force_start
))
1657 XWINDOW (selected_window
)->force_start
= Qnil
;
1658 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1659 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1662 cmd
= read_key_sequence_cmd
;
1663 if (!NILP (Vexecuting_kbd_macro
))
1665 if (!NILP (Vquit_flag
))
1667 Vexecuting_kbd_macro
= Qt
;
1668 QUIT
; /* Make some noise. */
1669 /* Will return since macro now empty. */
1673 /* Do redisplay processing after this command except in special
1674 cases identified below. */
1675 prev_buffer
= current_buffer
;
1676 prev_modiff
= MODIFF
;
1677 last_point_position
= PT
;
1678 last_point_position_window
= selected_window
;
1679 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1681 /* By default, we adjust point to a boundary of a region that
1682 has such a property that should be treated intangible
1683 (e.g. composition, display). But, some commands will set
1684 this variable differently. */
1685 Vdisable_point_adjustment
= Qnil
;
1687 /* Process filters and timers may have messed with deactivate-mark.
1688 reset it before we execute the command. */
1689 Vdeactivate_mark
= Qnil
;
1691 /* Remap command through active keymaps */
1692 Vthis_original_command
= cmd
;
1696 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1700 /* Execute the command. */
1702 Vthis_command
= cmd
;
1703 real_this_command
= cmd
;
1704 /* Note that the value cell will never directly contain nil
1705 if the symbol is a local variable. */
1706 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1707 safe_run_hooks (Qpre_command_hook
);
1709 already_adjusted
= 0;
1711 if (NILP (Vthis_command
))
1713 /* nil means key is undefined. */
1714 Lisp_Object keys
= Fvector (i
, keybuf
);
1715 keys
= Fkey_description (keys
, Qnil
);
1717 message_with_string ("%s is undefined", keys
, 0);
1718 current_kboard
->defining_kbd_macro
= Qnil
;
1719 update_mode_lines
= 1;
1720 current_kboard
->Vprefix_arg
= Qnil
;
1724 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1726 /* In case we jump to directly_done. */
1727 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1729 /* Recognize some common commands in common situations and
1730 do them directly. */
1731 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1733 struct Lisp_Char_Table
*dp
1734 = window_display_table (XWINDOW (selected_window
));
1735 lose
= FETCH_CHAR (PT_BYTE
);
1737 if (! NILP (Vpost_command_hook
))
1738 /* Put this before calling adjust_point_for_property
1739 so it will only get called once in any case. */
1741 if (current_buffer
== prev_buffer
1742 && last_point_position
!= PT
1743 && NILP (Vdisable_point_adjustment
)
1744 && NILP (Vglobal_disable_point_adjustment
))
1745 adjust_point_for_property (last_point_position
, 0);
1746 already_adjusted
= 1;
1747 if (PT
== last_point_position
+ 1
1749 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1750 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1751 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1752 && (lose
>= 0x20 && lose
< 0x7f)))
1753 : (lose
>= 0x20 && lose
< 0x7f))
1754 /* To extract the case of continuation on
1755 wide-column characters. */
1756 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1757 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1759 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1761 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1763 && !windows_or_buffers_changed
1764 && EQ (current_buffer
->selective_display
, Qnil
)
1765 && !detect_input_pending ()
1766 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1767 && NILP (Vexecuting_kbd_macro
))
1768 direct_output_forward_char (1);
1771 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1773 struct Lisp_Char_Table
*dp
1774 = window_display_table (XWINDOW (selected_window
));
1776 lose
= FETCH_CHAR (PT_BYTE
);
1777 if (! NILP (Vpost_command_hook
))
1779 if (current_buffer
== prev_buffer
1780 && last_point_position
!= PT
1781 && NILP (Vdisable_point_adjustment
)
1782 && NILP (Vglobal_disable_point_adjustment
))
1783 adjust_point_for_property (last_point_position
, 0);
1784 already_adjusted
= 1;
1785 if (PT
== last_point_position
- 1
1787 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1788 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1789 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1790 && (lose
>= 0x20 && lose
< 0x7f)))
1791 : (lose
>= 0x20 && lose
< 0x7f))
1792 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1794 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1796 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1798 && !windows_or_buffers_changed
1799 && EQ (current_buffer
->selective_display
, Qnil
)
1800 && !detect_input_pending ()
1801 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1802 && NILP (Vexecuting_kbd_macro
))
1803 direct_output_forward_char (-1);
1806 else if (EQ (Vthis_command
, Qself_insert_command
)
1807 /* Try this optimization only on char keystrokes. */
1808 && NATNUMP (last_command_char
)
1809 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1812 = translate_char (Vtranslation_table_for_input
,
1813 XFASTINT (last_command_char
), 0, 0, 0);
1815 if (NILP (Vexecuting_kbd_macro
)
1816 && !EQ (minibuf_window
, selected_window
))
1818 if (!nonundocount
|| nonundocount
>= 20)
1826 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1828 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1830 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1832 || MODIFF
<= SAVE_MODIFF
1833 || windows_or_buffers_changed
1834 || !EQ (current_buffer
->selective_display
, Qnil
)
1835 || detect_input_pending ()
1836 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1837 || !NILP (Vexecuting_kbd_macro
));
1839 value
= internal_self_insert (c
, 0);
1844 if (! NILP (Vpost_command_hook
))
1845 /* Put this before calling adjust_point_for_property
1846 so it will only get called once in any case. */
1849 /* VALUE == 1 when AFTER-CHANGE functions are
1850 installed which is the case most of the time
1851 because FONT-LOCK installs one. */
1852 if (!lose
&& !value
)
1853 direct_output_for_insert (c
);
1858 /* Here for a command that isn't executed directly */
1861 #ifdef HAVE_X_WINDOWS
1862 int scount
= SPECPDL_INDEX ();
1864 if (display_hourglass_p
1865 && NILP (Vexecuting_kbd_macro
))
1867 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1873 if (NILP (current_kboard
->Vprefix_arg
))
1875 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1877 #ifdef HAVE_X_WINDOWS
1878 /* Do not check display_hourglass_p here, because
1879 Fcommand_execute could change it, but we should cancel
1880 hourglass cursor anyway.
1881 But don't cancel the hourglass within a macro
1882 just because a command in the macro finishes. */
1883 if (NILP (Vexecuting_kbd_macro
))
1884 unbind_to (scount
, Qnil
);
1889 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1891 /* Note that the value cell will never directly contain nil
1892 if the symbol is a local variable. */
1893 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1894 safe_run_hooks (Qpost_command_hook
);
1896 /* If displaying a message, resize the echo area window to fit
1897 that message's size exactly. */
1898 if (!NILP (echo_area_buffer
[0]))
1899 resize_echo_area_exactly ();
1901 if (!NILP (Vdeferred_action_list
))
1902 safe_run_hooks (Qdeferred_action_function
);
1904 /* If there is a prefix argument,
1905 1) We don't want Vlast_command to be ``universal-argument''
1906 (that would be dumb), so don't set Vlast_command,
1907 2) we want to leave echoing on so that the prefix will be
1908 echoed as part of this key sequence, so don't call
1910 3) we want to leave this_command_key_count non-zero, so that
1911 read_char will realize that it is re-reading a character, and
1912 not echo it a second time.
1914 If the command didn't actually create a prefix arg,
1915 but is merely a frame event that is transparent to prefix args,
1916 then the above doesn't apply. */
1917 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1919 current_kboard
->Vlast_command
= Vthis_command
;
1920 current_kboard
->Vreal_last_command
= real_this_command
;
1921 if (!CONSP (last_command_char
))
1922 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1924 this_command_key_count
= 0;
1925 this_command_key_count_reset
= 0;
1926 this_single_command_key_start
= 0;
1929 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1931 /* Setting transient-mark-mode to `only' is a way of
1932 turning it on for just one command. */
1934 if (EQ (Vtransient_mark_mode
, Qidentity
))
1935 Vtransient_mark_mode
= Qnil
;
1936 if (EQ (Vtransient_mark_mode
, Qonly
))
1937 Vtransient_mark_mode
= Qidentity
;
1939 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1941 /* We could also call `deactivate'mark'. */
1942 if (EQ (Vtransient_mark_mode
, Qlambda
))
1943 Vtransient_mark_mode
= Qnil
;
1946 current_buffer
->mark_active
= Qnil
;
1947 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1950 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1951 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1956 if (current_buffer
== prev_buffer
1957 && last_point_position
!= PT
1958 && NILP (Vdisable_point_adjustment
)
1959 && NILP (Vglobal_disable_point_adjustment
)
1960 && !already_adjusted
)
1961 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1963 /* Install chars successfully executed in kbd macro. */
1965 if (!NILP (current_kboard
->defining_kbd_macro
)
1966 && NILP (current_kboard
->Vprefix_arg
))
1967 finalize_kbd_macro_chars ();
1971 any_kboard_state ();
1976 extern Lisp_Object Qcomposition
, Qdisplay
;
1978 /* Adjust point to a boundary of a region that has such a property
1979 that should be treated intangible. For the moment, we check
1980 `composition', `display' and `invisible' properties.
1981 LAST_PT is the last position of point. */
1983 extern Lisp_Object Qafter_string
, Qbefore_string
;
1984 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1987 adjust_point_for_property (last_pt
, modified
)
1992 Lisp_Object val
, overlay
, tmp
;
1993 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1996 /* FIXME: cycling is probably not necessary because these properties
1997 can't be usefully combined anyway. */
1998 while (check_composition
|| check_display
|| check_invisible
)
2000 if (check_composition
2001 && PT
> BEGV
&& PT
< ZV
2002 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
2003 && COMPOSITION_VALID_P (beg
, end
, val
)
2004 && beg
< PT
/* && end > PT <- It's always the case. */
2005 && (last_pt
<= beg
|| last_pt
>= end
))
2008 SET_PT (PT
< last_pt
? beg
: end
);
2009 check_display
= check_invisible
= 1;
2011 check_composition
= 0;
2013 && PT
> BEGV
&& PT
< ZV
2014 && !NILP (val
= get_char_property_and_overlay
2015 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
2016 && display_prop_intangible_p (val
)
2017 && (!OVERLAYP (overlay
)
2018 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
2019 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
2020 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
2021 && (beg
< PT
/* && end > PT <- It's always the case. */
2022 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
2025 SET_PT (PT
< last_pt
2026 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
2028 check_composition
= check_invisible
= 1;
2031 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
2033 int inv
, ellipsis
= 0;
2036 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2038 && !NILP (val
= get_char_property_and_overlay
2039 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
2040 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2042 ellipsis
= ellipsis
|| inv
> 1
2043 || (OVERLAYP (overlay
)
2044 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2045 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2046 tmp
= Fnext_single_char_property_change
2047 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
2048 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
2051 && !NILP (val
= get_char_property_and_overlay
2052 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
2053 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2055 ellipsis
= ellipsis
|| inv
> 1
2056 || (OVERLAYP (overlay
)
2057 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2058 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2059 tmp
= Fprevious_single_char_property_change
2060 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2061 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2064 /* Move away from the inside area. */
2065 if (beg
< PT
&& end
> PT
)
2067 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2068 /* We haven't moved yet (so we don't need to fear
2069 infinite-looping) and we were outside the range
2070 before (so either end of the range still corresponds
2071 to a move in the right direction): pretend we moved
2072 less than we actually did, so that we still have
2073 more freedom below in choosing which end of the range
2075 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2076 /* We either have moved already or the last point
2077 was already in the range: we don't get to choose
2078 which end of the range we have to go to. */
2079 : (PT
< last_pt
? beg
: end
));
2080 check_composition
= check_display
= 1;
2082 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2083 the point to something other than its argument, due to
2084 point-motion hooks, intangibility, etc. */
2085 xassert (PT
== beg
|| PT
== end
);
2088 /* Pretend the area doesn't exist if the buffer is not
2090 if (!modified
&& !ellipsis
&& beg
< end
)
2092 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2093 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2094 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2095 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2096 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2097 /* We've already moved as far as we can. Trying to go
2098 to the other end would mean moving backwards and thus
2099 could lead to an infinite loop. */
2101 else if (val
= get_pos_property (make_number (PT
),
2103 TEXT_PROP_MEANS_INVISIBLE (val
)
2104 && (val
= get_pos_property
2105 (make_number (PT
== beg
? end
: beg
),
2107 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2108 (check_composition
= check_display
= 1,
2109 SET_PT (PT
== beg
? end
: beg
));
2112 check_invisible
= 0;
2116 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2119 safe_run_hooks_1 (hook
)
2122 if (NILP (Vrun_hooks
))
2124 return call1 (Vrun_hooks
, Vinhibit_quit
);
2127 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2130 safe_run_hooks_error (data
)
2133 Lisp_Object args
[3];
2134 args
[0] = build_string ("Error in %s: %s");
2135 args
[1] = Vinhibit_quit
;
2138 return Fset (Vinhibit_quit
, Qnil
);
2141 /* If we get an error while running the hook, cause the hook variable
2142 to be nil. Also inhibit quits, so that C-g won't cause the hook
2143 to mysteriously evaporate. */
2146 safe_run_hooks (hook
)
2149 int count
= SPECPDL_INDEX ();
2150 specbind (Qinhibit_quit
, hook
);
2152 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2154 unbind_to (count
, Qnil
);
2158 /* Number of seconds between polling for input. This is a Lisp
2159 variable that can be bound. */
2161 EMACS_INT polling_period
;
2163 /* Nonzero means polling for input is temporarily suppressed. */
2165 int poll_suppress_count
;
2167 /* Asynchronous timer for polling. */
2169 struct atimer
*poll_timer
;
2172 #ifdef POLL_FOR_INPUT
2174 /* Poll for input, so what we catch a C-g if it comes in. This
2175 function is called from x_make_frame_visible, see comment
2181 if (interrupt_input_blocked
== 0
2182 && !waiting_for_input
)
2183 read_avail_input (0);
2186 /* Timer callback function for poll_timer. TIMER is equal to
2190 poll_for_input (timer
)
2191 struct atimer
*timer
;
2193 if (poll_suppress_count
== 0)
2195 interrupt_input_pending
= 1;
2197 poll_for_input_1 ();
2201 #endif /* POLL_FOR_INPUT */
2203 /* Begin signals to poll for input, if they are appropriate.
2204 This function is called unconditionally from various places. */
2209 #ifdef POLL_FOR_INPUT
2210 if (read_socket_hook
&& !interrupt_input
)
2212 /* Turn alarm handling on unconditionally. It might have
2213 been turned off in process.c. */
2214 turn_on_atimers (1);
2216 /* If poll timer doesn't exist, are we need one with
2217 a different interval, start a new one. */
2218 if (poll_timer
== NULL
2219 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2221 EMACS_TIME interval
;
2224 cancel_atimer (poll_timer
);
2226 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2227 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2228 poll_for_input
, NULL
);
2231 /* Let the timer's callback function poll for input
2232 if this becomes zero. */
2233 --poll_suppress_count
;
2238 /* Nonzero if we are using polling to handle input asynchronously. */
2241 input_polling_used ()
2243 #ifdef POLL_FOR_INPUT
2244 return read_socket_hook
&& !interrupt_input
;
2250 /* Turn off polling. */
2255 #ifdef POLL_FOR_INPUT
2256 if (read_socket_hook
&& !interrupt_input
)
2257 ++poll_suppress_count
;
2261 /* Set the value of poll_suppress_count to COUNT
2262 and start or stop polling accordingly. */
2265 set_poll_suppress_count (count
)
2268 #ifdef POLL_FOR_INPUT
2269 if (count
== 0 && poll_suppress_count
!= 0)
2271 poll_suppress_count
= 1;
2274 else if (count
!= 0 && poll_suppress_count
== 0)
2278 poll_suppress_count
= count
;
2282 /* Bind polling_period to a value at least N.
2283 But don't decrease it. */
2286 bind_polling_period (n
)
2289 #ifdef POLL_FOR_INPUT
2290 int new = polling_period
;
2295 stop_other_atimers (poll_timer
);
2297 specbind (Qpolling_period
, make_number (new));
2298 /* Start a new alarm with the new period. */
2303 /* Apply the control modifier to CHARACTER. */
2309 /* Save the upper bits here. */
2310 int upper
= c
& ~0177;
2314 /* Everything in the columns containing the upper-case letters
2315 denotes a control character. */
2316 if (c
>= 0100 && c
< 0140)
2320 /* Set the shift modifier for a control char
2321 made from a shifted letter. But only for letters! */
2322 if (oc
>= 'A' && oc
<= 'Z')
2323 c
|= shift_modifier
;
2326 /* The lower-case letters denote control characters too. */
2327 else if (c
>= 'a' && c
<= 'z')
2330 /* Include the bits for control and shift
2331 only if the basic ASCII code can't indicate them. */
2335 /* Replace the high bits. */
2336 c
|= (upper
& ~ctrl_modifier
);
2341 /* Display the help-echo property of the character after the mouse pointer.
2342 Either show it in the echo area, or call show-help-function to display
2343 it by other means (maybe in a tooltip).
2345 If HELP is nil, that means clear the previous help echo.
2347 If HELP is a string, display that string. If HELP is a function,
2348 call it with OBJECT and POS as arguments; the function should
2349 return a help string or nil for none. For all other types of HELP,
2350 evaluate it to obtain a string.
2352 WINDOW is the window in which the help was generated, if any.
2353 It is nil if not in a window.
2355 If OBJECT is a buffer, POS is the position in the buffer where the
2356 `help-echo' text property was found.
2358 If OBJECT is an overlay, that overlay has a `help-echo' property,
2359 and POS is the position in the overlay's buffer under the mouse.
2361 If OBJECT is a string (an overlay string or a string displayed with
2362 the `display' property). POS is the position in that string under
2365 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2366 echo overwrites a keystroke echo currently displayed in the echo
2369 Note: this function may only be called with HELP nil or a string
2370 from X code running asynchronously. */
2373 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2374 Lisp_Object help
, window
, object
, pos
;
2375 int ok_to_overwrite_keystroke_echo
;
2377 if (!NILP (help
) && !STRINGP (help
))
2379 if (FUNCTIONP (help
))
2381 Lisp_Object args
[4];
2386 help
= safe_call (4, args
);
2389 help
= safe_eval (help
);
2391 if (!STRINGP (help
))
2396 if (!noninteractive
&& STRINGP (help
))
2398 /* The mouse-fixup-help-message Lisp function can call
2399 mouse_position_hook, which resets the mouse_moved flags.
2400 This causes trouble if we are trying to read a mouse motion
2401 event (i.e., if we are inside a `track-mouse' form), so we
2402 restore the mouse_moved flag. */
2403 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2404 help
= call1 (Qmouse_fixup_help_message
, help
);
2410 if (STRINGP (help
) || NILP (help
))
2412 if (!NILP (Vshow_help_function
))
2413 call1 (Vshow_help_function
, help
);
2414 else if (/* Don't overwrite minibuffer contents. */
2415 !MINI_WINDOW_P (XWINDOW (selected_window
))
2416 /* Don't overwrite a keystroke echo. */
2417 && (NILP (echo_message_buffer
)
2418 || ok_to_overwrite_keystroke_echo
)
2419 /* Don't overwrite a prompt. */
2420 && !cursor_in_echo_area
)
2424 int count
= SPECPDL_INDEX ();
2426 if (!help_echo_showing_p
)
2427 Vpre_help_message
= current_message ();
2429 specbind (Qmessage_truncate_lines
, Qt
);
2430 message3_nolog (help
, SBYTES (help
),
2431 STRING_MULTIBYTE (help
));
2432 unbind_to (count
, Qnil
);
2434 else if (STRINGP (Vpre_help_message
))
2436 message3_nolog (Vpre_help_message
,
2437 SBYTES (Vpre_help_message
),
2438 STRING_MULTIBYTE (Vpre_help_message
));
2439 Vpre_help_message
= Qnil
;
2445 help_echo_showing_p
= STRINGP (help
);
2451 /* Input of single characters from keyboard */
2453 Lisp_Object
print_help ();
2454 static Lisp_Object
kbd_buffer_get_event ();
2455 static void record_char ();
2457 static Lisp_Object help_form_saved_window_configs
;
2459 read_char_help_form_unwind (arg
)
2461 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2462 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2463 if (!NILP (window_config
))
2464 Fset_window_configuration (window_config
);
2469 static jmp_buf wrong_kboard_jmpbuf
;
2472 #define STOP_POLLING \
2473 do { if (! polling_stopped_here) stop_polling (); \
2474 polling_stopped_here = 1; } while (0)
2476 #define RESUME_POLLING \
2477 do { if (polling_stopped_here) start_polling (); \
2478 polling_stopped_here = 0; } while (0)
2480 /* read a character from the keyboard; call the redisplay if needed */
2481 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2482 -1 means do not do redisplay, but do do autosaving.
2485 /* The arguments MAPS and NMAPS are for menu prompting.
2486 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2488 PREV_EVENT is the previous input event, or nil if we are reading
2489 the first event of a key sequence (or not reading a key sequence).
2490 If PREV_EVENT is t, that is a "magic" value that says
2491 not to run input methods, but in other respects to act as if
2492 not reading a key sequence.
2494 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2495 if we used a mouse menu to read the input, or zero otherwise. If
2496 USED_MOUSE_MENU is null, we don't dereference it.
2498 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2499 specifying the maximum time to wait until. If no input arrives by
2500 that time, stop waiting and return nil.
2502 Value is t if we showed a menu and the user rejected it. */
2505 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2509 Lisp_Object prev_event
;
2510 int *used_mouse_menu
;
2511 EMACS_TIME
*end_time
;
2513 volatile Lisp_Object c
;
2514 int count
, jmpcount
;
2515 jmp_buf local_getcjmp
;
2517 volatile int key_already_recorded
= 0;
2518 Lisp_Object tem
, save
;
2519 volatile Lisp_Object previous_echo_area_message
;
2520 volatile Lisp_Object also_record
;
2521 volatile int reread
;
2522 struct gcpro gcpro1
, gcpro2
;
2523 int polling_stopped_here
= 0;
2527 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2528 before_command_key_count
= this_command_key_count
;
2529 before_command_echo_length
= echo_length ();
2532 previous_echo_area_message
= Qnil
;
2534 GCPRO2 (c
, previous_echo_area_message
);
2539 if (CONSP (Vunread_post_input_method_events
))
2541 c
= XCAR (Vunread_post_input_method_events
);
2542 Vunread_post_input_method_events
2543 = XCDR (Vunread_post_input_method_events
);
2545 /* Undo what read_char_x_menu_prompt did when it unread
2546 additional keys returned by Fx_popup_menu. */
2548 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2556 if (unread_command_char
!= -1)
2558 XSETINT (c
, unread_command_char
);
2559 unread_command_char
= -1;
2565 if (CONSP (Vunread_command_events
))
2567 c
= XCAR (Vunread_command_events
);
2568 Vunread_command_events
= XCDR (Vunread_command_events
);
2572 /* Undo what sit-for did when it unread additional keys
2573 inside universal-argument. */
2576 && EQ (XCAR (c
), Qt
))
2582 /* Undo what read_char_x_menu_prompt did when it unread
2583 additional keys returned by Fx_popup_menu. */
2585 && EQ (XCDR (c
), Qdisabled
)
2586 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2589 /* If the queued event is something that used the mouse,
2590 set used_mouse_menu accordingly. */
2592 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2593 *used_mouse_menu
= 1;
2595 goto reread_for_input_method
;
2598 if (CONSP (Vunread_input_method_events
))
2600 c
= XCAR (Vunread_input_method_events
);
2601 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2603 /* Undo what read_char_x_menu_prompt did when it unread
2604 additional keys returned by Fx_popup_menu. */
2606 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2610 goto reread_for_input_method
;
2613 this_command_key_count_reset
= 0;
2615 if (!NILP (Vexecuting_kbd_macro
))
2617 /* We set this to Qmacro; since that's not a frame, nobody will
2618 try to switch frames on us, and the selected window will
2621 Since this event came from a macro, it would be misleading to
2622 leave internal_last_event_frame set to wherever the last
2623 real event came from. Normally, a switch-frame event selects
2624 internal_last_event_frame after each command is read, but
2625 events read from a macro should never cause a new frame to be
2627 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2629 /* Exit the macro if we are at the end.
2630 Also, some things replace the macro with t
2631 to force an early exit. */
2632 if (EQ (Vexecuting_kbd_macro
, Qt
)
2633 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2639 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2640 if (STRINGP (Vexecuting_kbd_macro
)
2641 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2642 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2644 executing_kbd_macro_index
++;
2649 if (!NILP (unread_switch_frame
))
2651 c
= unread_switch_frame
;
2652 unread_switch_frame
= Qnil
;
2654 /* This event should make it into this_command_keys, and get echoed
2655 again, so we do not set `reread'. */
2659 /* if redisplay was requested */
2660 if (commandflag
>= 0)
2662 /* If there is pending input, process any events which are not
2663 user-visible, such as X selection_request events. */
2665 || detect_input_pending_run_timers (0))
2666 swallow_events (0); /* may clear input_pending */
2668 /* Redisplay if no pending input. */
2669 while (!input_pending
)
2671 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2672 redisplay_preserve_echo_area (5);
2677 /* Normal case: no input arrived during redisplay. */
2680 /* Input arrived and pre-empted redisplay.
2681 Process any events which are not user-visible. */
2683 /* If that cleared input_pending, try again to redisplay. */
2687 /* Message turns off echoing unless more keystrokes turn it on again.
2689 The code in 20.x for the condition was
2691 1. echo_area_glyphs && *echo_area_glyphs
2692 2. && echo_area_glyphs != current_kboard->echobuf
2693 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2695 (1) means there's a current message displayed
2697 (2) means it's not the message from echoing from the current
2700 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2701 is set to a non-null value. This is done in read_char and it is
2702 set to echo_area_glyphs after a call to echo_char. That means
2703 ok_to_echo_at_next_pause is either null or
2704 current_kboard->echobuf with the appropriate current_kboard at
2707 So, condition (3) means in clear text ok_to_echo_at_next_pause
2708 must be either null, or the current message isn't from echoing at
2709 all, or it's from echoing from a different kboard than the
2712 if (/* There currently is something in the echo area. */
2713 !NILP (echo_area_buffer
[0])
2714 && (/* And it's either not from echoing. */
2715 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2716 /* Or it's an echo from a different kboard. */
2717 || echo_kboard
!= current_kboard
2718 /* Or we explicitly allow overwriting whatever there is. */
2719 || ok_to_echo_at_next_pause
== NULL
))
2724 /* Try reading a character via menu prompting in the minibuf.
2725 Try this before the sit-for, because the sit-for
2726 would do the wrong thing if we are supposed to do
2727 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2728 after a mouse event so don't try a minibuf menu. */
2730 if (nmaps
> 0 && INTERACTIVE
2731 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2732 /* Don't bring up a menu if we already have another event. */
2733 && NILP (Vunread_command_events
)
2734 && unread_command_char
< 0
2735 && !detect_input_pending_run_timers (0))
2737 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2740 key_already_recorded
= 1;
2745 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2746 We will do that below, temporarily for short sections of code,
2747 when appropriate. local_getcjmp must be in effect
2748 around any call to sit_for or kbd_buffer_get_event;
2749 it *must not* be in effect when we call redisplay. */
2751 jmpcount
= SPECPDL_INDEX ();
2752 if (_setjmp (local_getcjmp
))
2754 /* We must have saved the outer value of getcjmp here,
2755 so restore it now. */
2756 restore_getcjmp (save_jump
);
2757 unbind_to (jmpcount
, Qnil
);
2758 XSETINT (c
, quit_char
);
2759 internal_last_event_frame
= selected_frame
;
2760 Vlast_event_frame
= internal_last_event_frame
;
2761 /* If we report the quit char as an event,
2762 don't do so more than once. */
2763 if (!NILP (Vinhibit_quit
))
2768 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2769 if (kb
!= current_kboard
)
2771 Lisp_Object link
= kb
->kbd_queue
;
2772 /* We shouldn't get here if we were in single-kboard mode! */
2777 while (CONSP (XCDR (link
)))
2779 if (!NILP (XCDR (link
)))
2783 kb
->kbd_queue
= Fcons (c
, Qnil
);
2785 XSETCDR (link
, Fcons (c
, Qnil
));
2786 kb
->kbd_queue_has_data
= 1;
2787 current_kboard
= kb
;
2788 /* This is going to exit from read_char
2789 so we had better get rid of this frame's stuff. */
2791 longjmp (wrong_kboard_jmpbuf
, 1);
2798 /* Start idle timers if no time limit is supplied. We don't do it
2799 if a time limit is supplied to avoid an infinite recursion in the
2800 situation where an idle timer calls `sit-for'. */
2803 timer_start_idle ();
2805 /* If in middle of key sequence and minibuffer not active,
2806 start echoing if enough time elapses. */
2808 if (minibuf_level
== 0
2810 && !current_kboard
->immediate_echo
2811 && this_command_key_count
> 0
2813 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2814 && NILP (Fzerop (Vecho_keystrokes
))
2815 && (/* No message. */
2816 NILP (echo_area_buffer
[0])
2817 /* Or empty message. */
2818 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2819 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2820 /* Or already echoing from same kboard. */
2821 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2822 /* Or not echoing before and echoing allowed. */
2823 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2825 /* After a mouse event, start echoing right away.
2826 This is because we are probably about to display a menu,
2827 and we don't want to delay before doing so. */
2828 if (EVENT_HAS_PARAMETERS (prev_event
))
2834 save_getcjmp (save_jump
);
2835 restore_getcjmp (local_getcjmp
);
2836 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2837 restore_getcjmp (save_jump
);
2839 && ! CONSP (Vunread_command_events
))
2844 /* Maybe auto save due to number of keystrokes. */
2846 if (commandflag
!= 0
2847 && auto_save_interval
> 0
2848 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2849 && !detect_input_pending_run_timers (0))
2851 Fdo_auto_save (Qnil
, Qnil
);
2852 /* Hooks can actually change some buffers in auto save. */
2856 /* Try reading using an X menu.
2857 This is never confused with reading using the minibuf
2858 because the recursive call of read_char in read_char_minibuf_menu_prompt
2859 does not pass on any keymaps. */
2861 if (nmaps
> 0 && INTERACTIVE
2862 && !NILP (prev_event
)
2863 && EVENT_HAS_PARAMETERS (prev_event
)
2864 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2865 && !EQ (XCAR (prev_event
), Qtool_bar
)
2866 /* Don't bring up a menu if we already have another event. */
2867 && NILP (Vunread_command_events
)
2868 && unread_command_char
< 0)
2870 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2872 /* Now that we have read an event, Emacs is not idle. */
2879 /* Maybe autosave and/or garbage collect due to idleness. */
2881 if (INTERACTIVE
&& NILP (c
))
2883 int delay_level
, buffer_size
;
2885 /* Slow down auto saves logarithmically in size of current buffer,
2886 and garbage collect while we're at it. */
2887 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2888 last_non_minibuf_size
= Z
- BEG
;
2889 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2891 while (buffer_size
> 64)
2892 delay_level
++, buffer_size
-= buffer_size
>> 2;
2893 if (delay_level
< 4) delay_level
= 4;
2894 /* delay_level is 4 for files under around 50k, 7 at 100k,
2895 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2897 /* Auto save if enough time goes by without input. */
2898 if (commandflag
!= 0
2899 && num_nonmacro_input_events
> last_auto_save
2900 && INTEGERP (Vauto_save_timeout
)
2901 && XINT (Vauto_save_timeout
) > 0)
2904 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2906 save_getcjmp (save_jump
);
2907 restore_getcjmp (local_getcjmp
);
2908 tem0
= sit_for (make_number (timeout
), 1, 1);
2909 restore_getcjmp (save_jump
);
2912 && ! CONSP (Vunread_command_events
))
2914 Fdo_auto_save (Qnil
, Qnil
);
2916 /* If we have auto-saved and there is still no input
2917 available, garbage collect if there has been enough
2918 consing going on to make it worthwhile. */
2919 if (!detect_input_pending_run_timers (0)
2920 && consing_since_gc
> gc_cons_threshold
/ 2)
2921 Fgarbage_collect ();
2928 /* If this has become non-nil here, it has been set by a timer
2929 or sentinel or filter. */
2930 if (CONSP (Vunread_command_events
))
2932 c
= XCAR (Vunread_command_events
);
2933 Vunread_command_events
= XCDR (Vunread_command_events
);
2936 /* Read something from current KBOARD's side queue, if possible. */
2940 if (current_kboard
->kbd_queue_has_data
)
2942 if (!CONSP (current_kboard
->kbd_queue
))
2944 c
= XCAR (current_kboard
->kbd_queue
);
2945 current_kboard
->kbd_queue
2946 = XCDR (current_kboard
->kbd_queue
);
2947 if (NILP (current_kboard
->kbd_queue
))
2948 current_kboard
->kbd_queue_has_data
= 0;
2949 input_pending
= readable_events (0);
2950 if (EVENT_HAS_PARAMETERS (c
)
2951 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2952 internal_last_event_frame
= XCAR (XCDR (c
));
2953 Vlast_event_frame
= internal_last_event_frame
;
2958 /* If current_kboard's side queue is empty check the other kboards.
2959 If one of them has data that we have not yet seen here,
2960 switch to it and process the data waiting for it.
2962 Note: if the events queued up for another kboard
2963 have already been seen here, and therefore are not a complete command,
2964 the kbd_queue_has_data field is 0, so we skip that kboard here.
2965 That's to avoid an infinite loop switching between kboards here. */
2966 if (NILP (c
) && !single_kboard
)
2969 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2970 if (kb
->kbd_queue_has_data
)
2972 current_kboard
= kb
;
2973 /* This is going to exit from read_char
2974 so we had better get rid of this frame's stuff. */
2976 longjmp (wrong_kboard_jmpbuf
, 1);
2985 /* Finally, we read from the main queue,
2986 and if that gives us something we can't use yet, we put it on the
2987 appropriate side queue and try again. */
2996 EMACS_GET_TIME (now
);
2997 if (EMACS_TIME_GE (now
, *end_time
))
3001 /* Actually read a character, waiting if necessary. */
3002 save_getcjmp (save_jump
);
3003 restore_getcjmp (local_getcjmp
);
3005 timer_start_idle ();
3006 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
3007 restore_getcjmp (save_jump
);
3010 if (! NILP (c
) && (kb
!= current_kboard
))
3012 Lisp_Object link
= kb
->kbd_queue
;
3015 while (CONSP (XCDR (link
)))
3017 if (!NILP (XCDR (link
)))
3021 kb
->kbd_queue
= Fcons (c
, Qnil
);
3023 XSETCDR (link
, Fcons (c
, Qnil
));
3024 kb
->kbd_queue_has_data
= 1;
3028 current_kboard
= kb
;
3029 /* This is going to exit from read_char
3030 so we had better get rid of this frame's stuff. */
3032 longjmp (wrong_kboard_jmpbuf
, 1);
3037 /* Terminate Emacs in batch mode if at eof. */
3038 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
3039 Fkill_emacs (make_number (1));
3043 /* Add in any extra modifiers, where appropriate. */
3044 if ((extra_keyboard_modifiers
& CHAR_CTL
)
3045 || ((extra_keyboard_modifiers
& 0177) < ' '
3046 && (extra_keyboard_modifiers
& 0177) != 0))
3047 XSETINT (c
, make_ctrl_char (XINT (c
)));
3049 /* Transfer any other modifier bits directly from
3050 extra_keyboard_modifiers to c. Ignore the actual character code
3051 in the low 16 bits of extra_keyboard_modifiers. */
3052 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
3063 if (commandflag
>= 0
3064 && !input_pending
&& !detect_input_pending_run_timers (0))
3072 /* Buffer switch events are only for internal wakeups
3073 so don't show them to the user.
3074 Also, don't record a key if we already did. */
3075 if (BUFFERP (c
) || key_already_recorded
)
3078 /* Process special events within read_char
3079 and loop around to read another event. */
3082 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3087 int was_locked
= single_kboard
;
3089 last_input_char
= c
;
3090 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
3092 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3093 /* We stopped being idle for this event; undo that. This
3094 prevents automatic window selection (under
3095 mouse_autoselect_window from acting as a real input event, for
3096 example banishing the mouse under mouse-avoidance-mode. */
3097 timer_resume_idle ();
3099 /* Resume allowing input from any kboard, if that was true before. */
3101 any_kboard_state ();
3106 /* Handle things that only apply to characters. */
3109 /* If kbd_buffer_get_event gave us an EOF, return that. */
3113 if ((STRINGP (Vkeyboard_translate_table
)
3114 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3115 || (VECTORP (Vkeyboard_translate_table
)
3116 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3117 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
3118 && CHAR_VALID_P (XINT (c
), 0)))
3121 d
= Faref (Vkeyboard_translate_table
, c
);
3122 /* nil in keyboard-translate-table means no translation. */
3128 /* If this event is a mouse click in the menu bar,
3129 return just menu-bar for now. Modify the mouse click event
3130 so we won't do this twice, then queue it up. */
3131 if (EVENT_HAS_PARAMETERS (c
)
3133 && CONSP (EVENT_START (c
))
3134 && CONSP (XCDR (EVENT_START (c
))))
3138 posn
= POSN_POSN (EVENT_START (c
));
3139 /* Handle menu-bar events:
3140 insert the dummy prefix event `menu-bar'. */
3141 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3143 /* Change menu-bar to (menu-bar) as the event "position". */
3144 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3147 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3152 /* Store these characters into recent_keys, the dribble file if any,
3153 and the keyboard macro being defined, if any. */
3155 if (! NILP (also_record
))
3156 record_char (also_record
);
3158 /* Wipe the echo area.
3159 But first, if we are about to use an input method,
3160 save the echo area contents for it to refer to. */
3162 && ! NILP (Vinput_method_function
)
3163 && (unsigned) XINT (c
) >= ' '
3164 && (unsigned) XINT (c
) != 127
3165 && (unsigned) XINT (c
) < 256)
3167 previous_echo_area_message
= Fcurrent_message ();
3168 Vinput_method_previous_message
= previous_echo_area_message
;
3171 /* Now wipe the echo area, except for help events which do their
3172 own stuff with the echo area. */
3174 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3175 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3177 if (!NILP (echo_area_buffer
[0]))
3178 safe_run_hooks (Qecho_area_clear_hook
);
3179 clear_message (1, 0);
3182 reread_for_input_method
:
3184 /* Pass this to the input method, if appropriate. */
3186 && ! NILP (Vinput_method_function
)
3187 /* Don't run the input method within a key sequence,
3188 after the first event of the key sequence. */
3189 && NILP (prev_event
)
3190 && (unsigned) XINT (c
) >= ' '
3191 && (unsigned) XINT (c
) != 127
3192 && (unsigned) XINT (c
) < 256)
3195 int key_count
, key_count_reset
;
3196 struct gcpro gcpro1
;
3197 int count
= SPECPDL_INDEX ();
3199 /* Save the echo status. */
3200 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3201 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3202 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3203 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3206 if (before_command_restore_flag
)
3208 this_command_key_count
= before_command_key_count_1
;
3209 if (this_command_key_count
< this_single_command_key_start
)
3210 this_single_command_key_start
= this_command_key_count
;
3211 echo_truncate (before_command_echo_length_1
);
3212 before_command_restore_flag
= 0;
3216 /* Save the this_command_keys status. */
3217 key_count
= this_command_key_count
;
3218 key_count_reset
= this_command_key_count_reset
;
3221 keys
= Fcopy_sequence (this_command_keys
);
3226 /* Clear out this_command_keys. */
3227 this_command_key_count
= 0;
3228 this_command_key_count_reset
= 0;
3230 /* Now wipe the echo area. */
3231 if (!NILP (echo_area_buffer
[0]))
3232 safe_run_hooks (Qecho_area_clear_hook
);
3233 clear_message (1, 0);
3236 /* If we are not reading a key sequence,
3237 never use the echo area. */
3240 specbind (Qinput_method_use_echo_area
, Qt
);
3243 /* Call the input method. */
3244 tem
= call1 (Vinput_method_function
, c
);
3246 tem
= unbind_to (count
, tem
);
3248 /* Restore the saved echoing state
3249 and this_command_keys state. */
3250 this_command_key_count
= key_count
;
3251 this_command_key_count_reset
= key_count_reset
;
3253 this_command_keys
= keys
;
3256 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3257 current_kboard
->echo_string
= saved_echo_string
;
3258 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3259 if (saved_immediate_echo
)
3264 /* The input method can return no events. */
3267 /* Bring back the previous message, if any. */
3268 if (! NILP (previous_echo_area_message
))
3269 message_with_string ("%s", previous_echo_area_message
, 0);
3272 /* It returned one event or more. */
3274 Vunread_post_input_method_events
3275 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3280 /* Display help if not echoing. */
3281 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3283 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3284 Lisp_Object help
, object
, position
, window
, tem
;
3286 tem
= Fcdr (XCDR (c
));
3289 window
= Fcar (tem
);
3291 object
= Fcar (tem
);
3293 position
= Fcar (tem
);
3295 show_help_echo (help
, window
, object
, position
, 0);
3297 /* We stopped being idle for this event; undo that. */
3299 timer_resume_idle ();
3303 if ((! reread
|| this_command_key_count
== 0
3304 || this_command_key_count_reset
)
3308 /* Don't echo mouse motion events. */
3309 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3310 && NILP (Fzerop (Vecho_keystrokes
))
3311 && ! (EVENT_HAS_PARAMETERS (c
)
3312 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3315 if (! NILP (also_record
))
3316 echo_char (also_record
);
3317 /* Once we reread a character, echoing can happen
3318 the next time we pause to read a new one. */
3319 ok_to_echo_at_next_pause
= current_kboard
;
3322 /* Record this character as part of the current key. */
3323 add_command_key (c
);
3324 if (! NILP (also_record
))
3325 add_command_key (also_record
);
3328 last_input_char
= c
;
3331 /* Process the help character specially if enabled */
3332 if (!NILP (Vhelp_form
) && help_char_p (c
))
3335 count
= SPECPDL_INDEX ();
3337 help_form_saved_window_configs
3338 = Fcons (Fcurrent_window_configuration (Qnil
),
3339 help_form_saved_window_configs
);
3340 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3342 tem0
= Feval (Vhelp_form
);
3344 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3349 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3350 if (EVENT_HAS_PARAMETERS (c
)
3351 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3352 XSETCAR (help_form_saved_window_configs
, Qnil
);
3354 while (BUFFERP (c
));
3355 /* Remove the help from the frame */
3356 unbind_to (count
, Qnil
);
3359 if (EQ (c
, make_number (040)))
3363 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3364 while (BUFFERP (c
));
3373 /* Record a key that came from a mouse menu.
3374 Record it for echoing, for this-command-keys, and so on. */
3380 /* Wipe the echo area. */
3381 clear_message (1, 0);
3386 before_command_key_count
= this_command_key_count
;
3387 before_command_echo_length
= echo_length ();
3390 /* Don't echo mouse motion events. */
3391 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3392 && NILP (Fzerop (Vecho_keystrokes
)))
3396 /* Once we reread a character, echoing can happen
3397 the next time we pause to read a new one. */
3398 ok_to_echo_at_next_pause
= 0;
3401 /* Record this character as part of the current key. */
3402 add_command_key (c
);
3404 /* Re-reading in the middle of a command */
3405 last_input_char
= c
;
3409 /* Return 1 if should recognize C as "the help character". */
3417 if (EQ (c
, Vhelp_char
))
3419 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3420 if (EQ (c
, XCAR (tail
)))
3425 /* Record the input event C in various ways. */
3433 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3435 /* To avoid filling recent_keys with help-echo and mouse-movement
3436 events, we filter out repeated help-echo events, only store the
3437 first and last in a series of mouse-movement events, and don't
3438 store repeated help-echo events which are only separated by
3439 mouse-movement events. */
3441 Lisp_Object ev1
, ev2
, ev3
;
3444 if ((ix1
= recent_keys_index
- 1) < 0)
3445 ix1
= NUM_RECENT_KEYS
- 1;
3446 ev1
= AREF (recent_keys
, ix1
);
3448 if ((ix2
= ix1
- 1) < 0)
3449 ix2
= NUM_RECENT_KEYS
- 1;
3450 ev2
= AREF (recent_keys
, ix2
);
3452 if ((ix3
= ix2
- 1) < 0)
3453 ix3
= NUM_RECENT_KEYS
- 1;
3454 ev3
= AREF (recent_keys
, ix3
);
3456 if (EQ (XCAR (c
), Qhelp_echo
))
3458 /* Don't record `help-echo' in recent_keys unless it shows some help
3459 message, and a different help than the previously recorded
3461 Lisp_Object help
, last_help
;
3463 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3464 if (!STRINGP (help
))
3466 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3467 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3469 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3470 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3471 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3473 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3474 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3475 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3476 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3479 else if (EQ (XCAR (c
), Qmouse_movement
))
3481 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3482 So additional mouse movement events replace the last element. */
3483 Lisp_Object last_window
, window
;
3485 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3486 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3487 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3488 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3489 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3491 ASET (recent_keys
, ix1
, c
);
3497 store_kbd_macro_char (c
);
3502 ASET (recent_keys
, recent_keys_index
, c
);
3503 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3504 recent_keys_index
= 0;
3506 else if (recorded
< 0)
3508 /* We need to remove one or two events from recent_keys.
3509 To do this, we simply put nil at those events and move the
3510 recent_keys_index backwards over those events. Usually,
3511 users will never see those nil events, as they will be
3512 overwritten by the command keys entered to see recent_keys
3515 while (recorded
++ < 0 && total_keys
> 0)
3517 if (total_keys
< NUM_RECENT_KEYS
)
3519 if (--recent_keys_index
< 0)
3520 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3521 ASET (recent_keys
, recent_keys_index
, Qnil
);
3525 num_nonmacro_input_events
++;
3527 /* Write c to the dribble file. If c is a lispy event, write
3528 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3529 If you, dear reader, have a better idea, you've got the source. :-) */
3535 if (XUINT (c
) < 0x100)
3536 putc (XINT (c
), dribble
);
3538 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3542 Lisp_Object dribblee
;
3544 /* If it's a structured event, take the event header. */
3545 dribblee
= EVENT_HEAD (c
);
3547 if (SYMBOLP (dribblee
))
3549 putc ('<', dribble
);
3550 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3551 SBYTES (SYMBOL_NAME (dribblee
)),
3553 putc ('>', dribble
);
3566 struct buffer
*old
= current_buffer
;
3567 Fprinc (object
, Qnil
);
3568 set_buffer_internal (XBUFFER (Vstandard_output
));
3569 call0 (intern ("help-mode"));
3570 set_buffer_internal (old
);
3574 /* Copy out or in the info on where C-g should throw to.
3575 This is used when running Lisp code from within get_char,
3576 in case get_char is called recursively.
3577 See read_process_output. */
3583 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3587 restore_getcjmp (temp
)
3590 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3593 /* Low level keyboard/mouse input.
3594 kbd_buffer_store_event places events in kbd_buffer, and
3595 kbd_buffer_get_event retrieves them. */
3597 /* Return true if there are any events in the queue that read-char
3598 would return. If this returns false, a read-char would block. */
3600 readable_events (flags
)
3603 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3606 /* If the buffer contains only FOCUS_IN_EVENT events, and
3607 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3608 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3610 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3611 #ifdef USE_TOOLKIT_SCROLL_BARS
3612 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3616 struct input_event
*event
;
3618 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3625 #ifdef USE_TOOLKIT_SCROLL_BARS
3626 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3628 event
->kind
== FOCUS_IN_EVENT
)
3629 #ifdef USE_TOOLKIT_SCROLL_BARS
3630 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3631 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3632 && event
->part
== scroll_bar_handle
3633 && event
->modifiers
== 0)
3638 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3641 while (event
!= kbd_store_ptr
);
3648 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3649 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3654 if (current_kboard
->kbd_queue_has_data
)
3660 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3661 if (kb
->kbd_queue_has_data
)
3667 /* Set this for debugging, to have a way to get out */
3672 event_to_kboard (event
)
3673 struct input_event
*event
;
3676 frame
= event
->frame_or_window
;
3678 frame
= XCAR (frame
);
3679 else if (WINDOWP (frame
))
3680 frame
= WINDOW_FRAME (XWINDOW (frame
));
3682 /* There are still some events that don't set this field.
3683 For now, just ignore the problem.
3684 Also ignore dead frames here. */
3685 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3688 return FRAME_KBOARD (XFRAME (frame
));
3693 Lisp_Object Vthrow_on_input
;
3695 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3698 kbd_buffer_store_event (event
)
3699 register struct input_event
*event
;
3701 kbd_buffer_store_event_hold (event
, 0);
3704 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3706 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3707 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3708 Else, if EVENT is a quit event, store the quit event
3709 in HOLD_QUIT, and return (thus ignoring further events).
3711 This is used in read_avail_input to postpone the processing
3712 of the quit event until all subsequent input events have been
3713 parsed (and discarded).
3717 kbd_buffer_store_event_hold (event
, hold_quit
)
3718 register struct input_event
*event
;
3719 struct input_event
*hold_quit
;
3721 if (event
->kind
== NO_EVENT
)
3724 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3727 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3729 register int c
= event
->code
& 0377;
3731 if (event
->modifiers
& ctrl_modifier
)
3732 c
= make_ctrl_char (c
);
3734 c
|= (event
->modifiers
3735 & (meta_modifier
| alt_modifier
3736 | hyper_modifier
| super_modifier
));
3742 struct input_event
*sp
;
3745 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3746 kb
!= current_kboard
))
3749 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3750 Fcons (make_number (c
), Qnil
));
3751 kb
->kbd_queue_has_data
= 1;
3752 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3754 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3757 if (event_to_kboard (sp
) == kb
)
3759 sp
->kind
= NO_EVENT
;
3760 sp
->frame_or_window
= Qnil
;
3770 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3774 /* If this results in a quit_char being returned to Emacs as
3775 input, set Vlast_event_frame properly. If this doesn't
3776 get returned to Emacs as an event, the next event read
3777 will set Vlast_event_frame again, so this is safe to do. */
3781 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3783 focus
= event
->frame_or_window
;
3784 internal_last_event_frame
= focus
;
3785 Vlast_event_frame
= focus
;
3788 last_event_timestamp
= event
->timestamp
;
3789 interrupt_signal (0 /* dummy */);
3793 if (c
&& c
== stop_character
)
3799 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3800 Just ignore the second one. */
3801 else if (event
->kind
== BUFFER_SWITCH_EVENT
3802 && kbd_fetch_ptr
!= kbd_store_ptr
3803 && ((kbd_store_ptr
== kbd_buffer
3804 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3805 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3808 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3809 kbd_store_ptr
= kbd_buffer
;
3811 /* Don't let the very last slot in the buffer become full,
3812 since that would make the two pointers equal,
3813 and that is indistinguishable from an empty buffer.
3814 Discard the event if it would fill the last slot. */
3815 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3817 *kbd_store_ptr
= *event
;
3821 /* If we're inside while-no-input, and this event qualifies
3822 as input, set quit-flag to cause an interrupt. */
3823 if (!NILP (Vthrow_on_input
)
3824 && event
->kind
!= FOCUS_IN_EVENT
3825 && event
->kind
!= HELP_EVENT
3826 && event
->kind
!= DEICONIFY_EVENT
)
3828 Vquit_flag
= Vthrow_on_input
;
3829 /* If we're inside a function that wants immediate quits,
3831 if (immediate_quit
&& NILP (Vinhibit_quit
))
3841 /* Put an input event back in the head of the event queue. */
3844 kbd_buffer_unget_event (event
)
3845 register struct input_event
*event
;
3847 if (kbd_fetch_ptr
== kbd_buffer
)
3848 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3850 /* Don't let the very last slot in the buffer become full, */
3851 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3854 *kbd_fetch_ptr
= *event
;
3859 /* Generate HELP_EVENT input_events in BUFP which has room for
3860 SIZE events. If there's not enough room in BUFP, ignore this
3863 HELP is the help form.
3865 FRAME is the frame on which the help is generated. OBJECT is the
3866 Lisp object where the help was found (a buffer, a string, an
3867 overlay, or nil if neither from a string nor from a buffer. POS is
3868 the position within OBJECT where the help was found.
3870 Value is the number of input_events generated. */
3873 gen_help_event (help
, frame
, window
, object
, pos
)
3874 Lisp_Object help
, frame
, object
, window
;
3877 struct input_event event
;
3881 event
.kind
= HELP_EVENT
;
3882 event
.frame_or_window
= frame
;
3884 event
.x
= WINDOWP (window
) ? window
: frame
;
3887 kbd_buffer_store_event (&event
);
3891 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3894 kbd_buffer_store_help_event (frame
, help
)
3895 Lisp_Object frame
, help
;
3897 struct input_event event
;
3899 event
.kind
= HELP_EVENT
;
3900 event
.frame_or_window
= frame
;
3905 kbd_buffer_store_event (&event
);
3909 /* Discard any mouse events in the event buffer by setting them to
3912 discard_mouse_events ()
3914 struct input_event
*sp
;
3915 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3917 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3920 if (sp
->kind
== MOUSE_CLICK_EVENT
3921 || sp
->kind
== WHEEL_EVENT
3923 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3925 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3927 sp
->kind
= NO_EVENT
;
3933 /* Return non-zero if there are any real events waiting in the event
3934 buffer, not counting `NO_EVENT's.
3936 If DISCARD is non-zero, discard NO_EVENT events at the front of
3937 the input queue, possibly leaving the input queue empty if there
3938 are no real input events. */
3941 kbd_buffer_events_waiting (discard
)
3944 struct input_event
*sp
;
3946 for (sp
= kbd_fetch_ptr
;
3947 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3950 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3957 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3961 /* Clear input event EVENT. */
3965 struct input_event
*event
;
3967 event
->kind
= NO_EVENT
;
3971 /* Read one event from the event buffer, waiting if necessary.
3972 The value is a Lisp object representing the event.
3973 The value is nil for an event that should be ignored,
3974 or that was handled here.
3975 We always read and discard one event. */
3978 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
3980 int *used_mouse_menu
;
3981 EMACS_TIME
*end_time
;
3990 *kbp
= current_kboard
;
3994 /* Wait until there is input available. */
3997 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4000 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4004 /* If the quit flag is set, then read_char will return
4005 quit_char, so that counts as "available input." */
4006 if (!NILP (Vquit_flag
))
4007 quit_throw_to_read_char ();
4009 /* One way or another, wait until input is available; then, if
4010 interrupt handlers have not read it, read it now. */
4013 wait_for_kbd_input ();
4015 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4019 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4022 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4027 EMACS_TIME duration
;
4028 EMACS_GET_TIME (duration
);
4029 if (EMACS_TIME_GE (duration
, *end_time
))
4030 return Qnil
; /* finished waiting */
4033 EMACS_SUB_TIME (duration
, *end_time
, duration
);
4034 wait_reading_process_output (EMACS_SECS (duration
),
4035 EMACS_USECS (duration
),
4036 -1, 1, Qnil
, NULL
, 0);
4040 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
4042 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
4043 /* Pass 1 for EXPECT since we just waited to have input. */
4044 read_avail_input (1);
4045 #endif /* not VMS */
4048 if (CONSP (Vunread_command_events
))
4051 first
= XCAR (Vunread_command_events
);
4052 Vunread_command_events
= XCDR (Vunread_command_events
);
4053 *kbp
= current_kboard
;
4057 /* At this point, we know that there is a readable event available
4058 somewhere. If the event queue is empty, then there must be a
4059 mouse movement enabled and available. */
4060 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4062 struct input_event
*event
;
4064 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4068 last_event_timestamp
= event
->timestamp
;
4071 *kbp
= event_to_kboard (event
);
4073 *kbp
= current_kboard
; /* Better than returning null ptr? */
4075 *kbp
= &the_only_kboard
;
4080 /* These two kinds of events get special handling
4081 and don't actually appear to the command loop.
4082 We return nil for them. */
4083 if (event
->kind
== SELECTION_REQUEST_EVENT
4084 || event
->kind
== SELECTION_CLEAR_EVENT
)
4087 struct input_event copy
;
4089 /* Remove it from the buffer before processing it,
4090 since otherwise swallow_events will see it
4091 and process it again. */
4093 kbd_fetch_ptr
= event
+ 1;
4094 input_pending
= readable_events (0);
4095 x_handle_selection_event (©
);
4097 /* We're getting selection request events, but we don't have
4103 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4104 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4106 /* Make an event (delete-frame (FRAME)). */
4107 obj
= Fcons (event
->frame_or_window
, Qnil
);
4108 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4109 kbd_fetch_ptr
= event
+ 1;
4112 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4113 else if (event
->kind
== ICONIFY_EVENT
)
4115 /* Make an event (iconify-frame (FRAME)). */
4116 obj
= Fcons (event
->frame_or_window
, Qnil
);
4117 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4118 kbd_fetch_ptr
= event
+ 1;
4120 else if (event
->kind
== DEICONIFY_EVENT
)
4122 /* Make an event (make-frame-visible (FRAME)). */
4123 obj
= Fcons (event
->frame_or_window
, Qnil
);
4124 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4125 kbd_fetch_ptr
= event
+ 1;
4128 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4130 /* The value doesn't matter here; only the type is tested. */
4131 XSETBUFFER (obj
, current_buffer
);
4132 kbd_fetch_ptr
= event
+ 1;
4134 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4135 || defined (USE_GTK)
4136 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4138 kbd_fetch_ptr
= event
+ 1;
4139 input_pending
= readable_events (0);
4140 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4141 x_activate_menubar (XFRAME (event
->frame_or_window
));
4144 #if defined (WINDOWSNT) || defined (MAC_OS)
4145 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4148 /* Make an event (language-change (KEY_SCRIPT)). */
4149 obj
= Fcons (make_number (event
->code
), Qnil
);
4151 /* Make an event (language-change (FRAME CHARSET LCID)). */
4152 obj
= Fcons (event
->frame_or_window
, Qnil
);
4154 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4155 kbd_fetch_ptr
= event
+ 1;
4158 else if (event
->kind
== SAVE_SESSION_EVENT
)
4160 obj
= Fcons (Qsave_session
, Qnil
);
4161 kbd_fetch_ptr
= event
+ 1;
4163 /* Just discard these, by returning nil.
4164 With MULTI_KBOARD, these events are used as placeholders
4165 when we need to randomly delete events from the queue.
4166 (They shouldn't otherwise be found in the buffer,
4167 but on some machines it appears they do show up
4168 even without MULTI_KBOARD.) */
4169 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4170 mouse events during a popup-menu call. */
4171 else if (event
->kind
== NO_EVENT
)
4172 kbd_fetch_ptr
= event
+ 1;
4173 else if (event
->kind
== HELP_EVENT
)
4175 Lisp_Object object
, position
, help
, frame
, window
;
4177 frame
= event
->frame_or_window
;
4178 object
= event
->arg
;
4179 position
= make_number (event
->code
);
4182 clear_event (event
);
4184 kbd_fetch_ptr
= event
+ 1;
4185 if (!WINDOWP (window
))
4187 obj
= Fcons (Qhelp_echo
,
4188 list5 (frame
, help
, window
, object
, position
));
4190 else if (event
->kind
== FOCUS_IN_EVENT
)
4192 /* Notification of a FocusIn event. The frame receiving the
4193 focus is in event->frame_or_window. Generate a
4194 switch-frame event if necessary. */
4195 Lisp_Object frame
, focus
;
4197 frame
= event
->frame_or_window
;
4198 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4202 if (!EQ (frame
, internal_last_event_frame
)
4203 && !EQ (frame
, selected_frame
))
4204 obj
= make_lispy_switch_frame (frame
);
4205 internal_last_event_frame
= frame
;
4206 kbd_fetch_ptr
= event
+ 1;
4210 /* If this event is on a different frame, return a switch-frame this
4211 time, and leave the event in the queue for next time. */
4215 frame
= event
->frame_or_window
;
4217 frame
= XCAR (frame
);
4218 else if (WINDOWP (frame
))
4219 frame
= WINDOW_FRAME (XWINDOW (frame
));
4221 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4225 if (! EQ (frame
, internal_last_event_frame
)
4226 && !EQ (frame
, selected_frame
))
4227 obj
= make_lispy_switch_frame (frame
);
4228 internal_last_event_frame
= frame
;
4230 /* If we didn't decide to make a switch-frame event, go ahead
4231 and build a real event from the queue entry. */
4235 obj
= make_lispy_event (event
);
4237 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4238 || defined (USE_GTK)
4239 /* If this was a menu selection, then set the flag to inhibit
4240 writing to last_nonmenu_event. Don't do this if the event
4241 we're returning is (menu-bar), though; that indicates the
4242 beginning of the menu sequence, and we might as well leave
4243 that as the `event with parameters' for this selection. */
4245 && !EQ (event
->frame_or_window
, event
->arg
)
4246 && (event
->kind
== MENU_BAR_EVENT
4247 || event
->kind
== TOOL_BAR_EVENT
))
4248 *used_mouse_menu
= 1;
4251 /* Wipe out this event, to catch bugs. */
4252 clear_event (event
);
4253 kbd_fetch_ptr
= event
+ 1;
4258 /* Try generating a mouse motion event. */
4259 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4261 FRAME_PTR f
= some_mouse_moved ();
4262 Lisp_Object bar_window
;
4263 enum scroll_bar_part part
;
4267 *kbp
= current_kboard
;
4268 /* Note that this uses F to determine which display to look at.
4269 If there is no valid info, it does not store anything
4270 so x remains nil. */
4272 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4276 /* Decide if we should generate a switch-frame event. Don't
4277 generate switch-frame events for motion outside of all Emacs
4283 frame
= FRAME_FOCUS_FRAME (f
);
4285 XSETFRAME (frame
, f
);
4287 if (! EQ (frame
, internal_last_event_frame
)
4288 && !EQ (frame
, selected_frame
))
4289 obj
= make_lispy_switch_frame (frame
);
4290 internal_last_event_frame
= frame
;
4293 /* If we didn't decide to make a switch-frame event, go ahead and
4294 return a mouse-motion event. */
4295 if (!NILP (x
) && NILP (obj
))
4296 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4298 #endif /* HAVE_MOUSE */
4300 /* We were promised by the above while loop that there was
4301 something for us to read! */
4304 input_pending
= readable_events (0);
4306 Vlast_event_frame
= internal_last_event_frame
;
4311 /* Process any events that are not user-visible,
4312 then return, without reading any user-visible events. */
4315 swallow_events (do_display
)
4320 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4322 struct input_event
*event
;
4324 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4328 last_event_timestamp
= event
->timestamp
;
4330 /* These two kinds of events get special handling
4331 and don't actually appear to the command loop. */
4332 if (event
->kind
== SELECTION_REQUEST_EVENT
4333 || event
->kind
== SELECTION_CLEAR_EVENT
)
4336 struct input_event copy
;
4338 /* Remove it from the buffer before processing it,
4339 since otherwise swallow_events called recursively could see it
4340 and process it again. */
4342 kbd_fetch_ptr
= event
+ 1;
4343 input_pending
= readable_events (0);
4344 x_handle_selection_event (©
);
4346 /* We're getting selection request events, but we don't have
4355 old_timers_run
= timers_run
;
4356 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4358 if (timers_run
!= old_timers_run
&& do_display
)
4359 redisplay_preserve_echo_area (7);
4362 /* Record the start of when Emacs is idle,
4363 for the sake of running idle-time timers. */
4370 /* If we are already in the idle state, do nothing. */
4371 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4374 EMACS_GET_TIME (timer_idleness_start_time
);
4376 timer_last_idleness_start_time
= timer_idleness_start_time
;
4378 /* Mark all idle-time timers as once again candidates for running. */
4379 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4383 timer
= XCAR (timers
);
4385 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4387 XVECTOR (timer
)->contents
[0] = Qnil
;
4391 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4396 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4399 /* Resume idle timer from last idle start time. */
4402 timer_resume_idle ()
4404 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4407 timer_idleness_start_time
= timer_last_idleness_start_time
;
4410 /* This is only for debugging. */
4411 struct input_event last_timer_event
;
4413 /* Check whether a timer has fired. To prevent larger problems we simply
4414 disregard elements that are not proper timers. Do not make a circular
4415 timer list for the time being.
4417 Returns the number of seconds to wait until the next timer fires. If a
4418 timer is triggering now, return zero seconds.
4419 If no timer is active, return -1 seconds.
4421 If a timer is ripe, we run it, with quitting turned off.
4423 DO_IT_NOW is now ignored. It used to mean that we should
4424 run the timer directly instead of queueing a timer-event.
4425 Now we always run timers directly. */
4428 timer_check (do_it_now
)
4431 EMACS_TIME nexttime
;
4432 EMACS_TIME now
, idleness_now
;
4433 Lisp_Object timers
, idle_timers
, chosen_timer
;
4434 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4436 EMACS_SET_SECS (nexttime
, -1);
4437 EMACS_SET_USECS (nexttime
, -1);
4439 /* Always consider the ordinary timers. */
4440 timers
= Vtimer_list
;
4441 /* Consider the idle timers only if Emacs is idle. */
4442 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4443 idle_timers
= Vtimer_idle_list
;
4446 chosen_timer
= Qnil
;
4447 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4449 if (CONSP (timers
) || CONSP (idle_timers
))
4451 EMACS_GET_TIME (now
);
4452 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4453 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4456 while (CONSP (timers
) || CONSP (idle_timers
))
4458 Lisp_Object
*vector
;
4459 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4460 EMACS_TIME timer_time
, idle_timer_time
;
4461 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4463 /* Skip past invalid timers and timers already handled. */
4466 timer
= XCAR (timers
);
4467 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4469 timers
= XCDR (timers
);
4472 vector
= XVECTOR (timer
)->contents
;
4474 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4475 || !INTEGERP (vector
[3])
4476 || ! NILP (vector
[0]))
4478 timers
= XCDR (timers
);
4482 if (!NILP (idle_timers
))
4484 timer
= XCAR (idle_timers
);
4485 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4487 idle_timers
= XCDR (idle_timers
);
4490 vector
= XVECTOR (timer
)->contents
;
4492 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4493 || !INTEGERP (vector
[3])
4494 || ! NILP (vector
[0]))
4496 idle_timers
= XCDR (idle_timers
);
4501 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4502 based on the next ordinary timer.
4503 TIMER_DIFFERENCE is the distance in time from NOW to when
4504 this timer becomes ripe (negative if it's already ripe). */
4507 timer
= XCAR (timers
);
4508 vector
= XVECTOR (timer
)->contents
;
4509 EMACS_SET_SECS (timer_time
,
4510 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4511 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4512 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4515 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4516 based on the next idle timer. */
4517 if (!NILP (idle_timers
))
4519 idle_timer
= XCAR (idle_timers
);
4520 vector
= XVECTOR (idle_timer
)->contents
;
4521 EMACS_SET_SECS (idle_timer_time
,
4522 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4523 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4524 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4527 /* Decide which timer is the next timer,
4528 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4529 Also step down the list where we found that timer. */
4531 if (! NILP (timers
) && ! NILP (idle_timers
))
4534 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4535 if (EMACS_TIME_NEG_P (temp
))
4537 chosen_timer
= timer
;
4538 timers
= XCDR (timers
);
4539 difference
= timer_difference
;
4543 chosen_timer
= idle_timer
;
4544 idle_timers
= XCDR (idle_timers
);
4545 difference
= idle_timer_difference
;
4548 else if (! NILP (timers
))
4550 chosen_timer
= timer
;
4551 timers
= XCDR (timers
);
4552 difference
= timer_difference
;
4556 chosen_timer
= idle_timer
;
4557 idle_timers
= XCDR (idle_timers
);
4558 difference
= idle_timer_difference
;
4560 vector
= XVECTOR (chosen_timer
)->contents
;
4562 /* If timer is ripe, run it if it hasn't been run. */
4563 if (EMACS_TIME_NEG_P (difference
)
4564 || (EMACS_SECS (difference
) == 0
4565 && EMACS_USECS (difference
) == 0))
4567 if (NILP (vector
[0]))
4569 int was_locked
= single_kboard
;
4570 int count
= SPECPDL_INDEX ();
4571 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4573 /* Mark the timer as triggered to prevent problems if the lisp
4574 code fails to reschedule it right. */
4577 specbind (Qinhibit_quit
, Qt
);
4579 call1 (Qtimer_event_handler
, chosen_timer
);
4580 Vdeactivate_mark
= old_deactivate_mark
;
4582 unbind_to (count
, Qnil
);
4584 /* Resume allowing input from any kboard, if that was true before. */
4586 any_kboard_state ();
4588 /* Since we have handled the event,
4589 we don't need to tell the caller to wake up and do it. */
4593 /* When we encounter a timer that is still waiting,
4594 return the amount of time to wait before it is ripe. */
4601 /* No timers are pending in the future. */
4602 /* Return 0 if we generated an event, and -1 if not. */
4607 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4608 doc
: /* Return the current length of Emacs idleness.
4609 The value is returned as a list of three integers. The first has the
4610 most significant 16 bits of the seconds, while the second has the
4611 least significant 16 bits. The third integer gives the microsecond
4614 The microsecond count is zero on systems that do not provide
4615 resolution finer than a second. */)
4618 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4620 EMACS_TIME now
, idleness_now
;
4622 EMACS_GET_TIME (now
);
4623 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4625 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4626 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4627 make_number (EMACS_USECS (idleness_now
)));
4633 /* Caches for modify_event_symbol. */
4634 static Lisp_Object accent_key_syms
;
4635 static Lisp_Object func_key_syms
;
4636 static Lisp_Object mouse_syms
;
4637 static Lisp_Object wheel_syms
;
4638 static Lisp_Object drag_n_drop_syms
;
4640 /* This is a list of keysym codes for special "accent" characters.
4641 It parallels lispy_accent_keys. */
4643 static int lispy_accent_codes
[] =
4645 #ifdef XK_dead_circumflex
4650 #ifdef XK_dead_grave
4655 #ifdef XK_dead_tilde
4660 #ifdef XK_dead_diaeresis
4665 #ifdef XK_dead_macron
4670 #ifdef XK_dead_degree
4675 #ifdef XK_dead_acute
4680 #ifdef XK_dead_cedilla
4685 #ifdef XK_dead_breve
4690 #ifdef XK_dead_ogonek
4695 #ifdef XK_dead_caron
4700 #ifdef XK_dead_doubleacute
4701 XK_dead_doubleacute
,
4705 #ifdef XK_dead_abovedot
4710 #ifdef XK_dead_abovering
4720 #ifdef XK_dead_belowdot
4725 #ifdef XK_dead_voiced_sound
4726 XK_dead_voiced_sound
,
4730 #ifdef XK_dead_semivoiced_sound
4731 XK_dead_semivoiced_sound
,
4747 /* This is a list of Lisp names for special "accent" characters.
4748 It parallels lispy_accent_codes. */
4750 static char *lispy_accent_keys
[] =
4768 "dead-voiced-sound",
4769 "dead-semivoiced-sound",
4775 #define FUNCTION_KEY_OFFSET 0x0
4777 char *lispy_function_keys
[] =
4781 0, /* VK_LBUTTON 0x01 */
4782 0, /* VK_RBUTTON 0x02 */
4783 "cancel", /* VK_CANCEL 0x03 */
4784 0, /* VK_MBUTTON 0x04 */
4786 0, 0, 0, /* 0x05 .. 0x07 */
4788 "backspace", /* VK_BACK 0x08 */
4789 "tab", /* VK_TAB 0x09 */
4791 0, 0, /* 0x0A .. 0x0B */
4793 "clear", /* VK_CLEAR 0x0C */
4794 "return", /* VK_RETURN 0x0D */
4796 0, 0, /* 0x0E .. 0x0F */
4798 0, /* VK_SHIFT 0x10 */
4799 0, /* VK_CONTROL 0x11 */
4800 0, /* VK_MENU 0x12 */
4801 "pause", /* VK_PAUSE 0x13 */
4802 "capslock", /* VK_CAPITAL 0x14 */
4804 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4806 "escape", /* VK_ESCAPE 0x1B */
4808 0, 0, 0, 0, /* 0x1C .. 0x1F */
4810 0, /* VK_SPACE 0x20 */
4811 "prior", /* VK_PRIOR 0x21 */
4812 "next", /* VK_NEXT 0x22 */
4813 "end", /* VK_END 0x23 */
4814 "home", /* VK_HOME 0x24 */
4815 "left", /* VK_LEFT 0x25 */
4816 "up", /* VK_UP 0x26 */
4817 "right", /* VK_RIGHT 0x27 */
4818 "down", /* VK_DOWN 0x28 */
4819 "select", /* VK_SELECT 0x29 */
4820 "print", /* VK_PRINT 0x2A */
4821 "execute", /* VK_EXECUTE 0x2B */
4822 "snapshot", /* VK_SNAPSHOT 0x2C */
4823 "insert", /* VK_INSERT 0x2D */
4824 "delete", /* VK_DELETE 0x2E */
4825 "help", /* VK_HELP 0x2F */
4827 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4829 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4831 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4833 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4835 0, 0, 0, 0, 0, 0, 0, 0, 0,
4836 0, 0, 0, 0, 0, 0, 0, 0, 0,
4837 0, 0, 0, 0, 0, 0, 0, 0,
4839 "lwindow", /* VK_LWIN 0x5B */
4840 "rwindow", /* VK_RWIN 0x5C */
4841 "apps", /* VK_APPS 0x5D */
4843 0, 0, /* 0x5E .. 0x5F */
4845 "kp-0", /* VK_NUMPAD0 0x60 */
4846 "kp-1", /* VK_NUMPAD1 0x61 */
4847 "kp-2", /* VK_NUMPAD2 0x62 */
4848 "kp-3", /* VK_NUMPAD3 0x63 */
4849 "kp-4", /* VK_NUMPAD4 0x64 */
4850 "kp-5", /* VK_NUMPAD5 0x65 */
4851 "kp-6", /* VK_NUMPAD6 0x66 */
4852 "kp-7", /* VK_NUMPAD7 0x67 */
4853 "kp-8", /* VK_NUMPAD8 0x68 */
4854 "kp-9", /* VK_NUMPAD9 0x69 */
4855 "kp-multiply", /* VK_MULTIPLY 0x6A */
4856 "kp-add", /* VK_ADD 0x6B */
4857 "kp-separator", /* VK_SEPARATOR 0x6C */
4858 "kp-subtract", /* VK_SUBTRACT 0x6D */
4859 "kp-decimal", /* VK_DECIMAL 0x6E */
4860 "kp-divide", /* VK_DIVIDE 0x6F */
4861 "f1", /* VK_F1 0x70 */
4862 "f2", /* VK_F2 0x71 */
4863 "f3", /* VK_F3 0x72 */
4864 "f4", /* VK_F4 0x73 */
4865 "f5", /* VK_F5 0x74 */
4866 "f6", /* VK_F6 0x75 */
4867 "f7", /* VK_F7 0x76 */
4868 "f8", /* VK_F8 0x77 */
4869 "f9", /* VK_F9 0x78 */
4870 "f10", /* VK_F10 0x79 */
4871 "f11", /* VK_F11 0x7A */
4872 "f12", /* VK_F12 0x7B */
4873 "f13", /* VK_F13 0x7C */
4874 "f14", /* VK_F14 0x7D */
4875 "f15", /* VK_F15 0x7E */
4876 "f16", /* VK_F16 0x7F */
4877 "f17", /* VK_F17 0x80 */
4878 "f18", /* VK_F18 0x81 */
4879 "f19", /* VK_F19 0x82 */
4880 "f20", /* VK_F20 0x83 */
4881 "f21", /* VK_F21 0x84 */
4882 "f22", /* VK_F22 0x85 */
4883 "f23", /* VK_F23 0x86 */
4884 "f24", /* VK_F24 0x87 */
4886 0, 0, 0, 0, /* 0x88 .. 0x8B */
4887 0, 0, 0, 0, /* 0x8C .. 0x8F */
4889 "kp-numlock", /* VK_NUMLOCK 0x90 */
4890 "scroll", /* VK_SCROLL 0x91 */
4892 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4893 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4894 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4895 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4896 "kp-end", /* VK_NUMPAD_END 0x96 */
4897 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4898 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4899 "kp-up", /* VK_NUMPAD_UP 0x99 */
4900 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4901 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4902 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4903 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4905 0, 0, /* 0x9E .. 0x9F */
4908 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4909 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4910 * No other API or message will distinguish left and right keys this way.
4914 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4915 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4916 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4917 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4918 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4924 "attn", /* VK_ATTN 0xF6 */
4925 "crsel", /* VK_CRSEL 0xF7 */
4926 "exsel", /* VK_EXSEL 0xF8 */
4927 "ereof", /* VK_EREOF 0xF9 */
4928 "play", /* VK_PLAY 0xFA */
4929 "zoom", /* VK_ZOOM 0xFB */
4930 "noname", /* VK_NONAME 0xFC */
4931 "pa1", /* VK_PA1 0xFD */
4932 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4936 #else /* not HAVE_NTGUI */
4938 /* This should be dealt with in XTread_socket now, and that doesn't
4939 depend on the client system having the Kana syms defined. See also
4940 the XK_kana_A case below. */
4943 static char *lispy_kana_keys
[] =
4945 /* X Keysym value */
4946 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4947 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4948 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4949 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4950 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4951 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4952 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4953 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4954 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4955 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4956 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4957 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4958 "kana-i", "kana-u", "kana-e", "kana-o",
4959 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4960 "prolongedsound", "kana-A", "kana-I", "kana-U",
4961 "kana-E", "kana-O", "kana-KA", "kana-KI",
4962 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4963 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4964 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4965 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4966 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4967 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4968 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4969 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4970 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4971 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4972 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4973 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4975 #endif /* XK_kana_A */
4978 #define FUNCTION_KEY_OFFSET 0xff00
4980 /* You'll notice that this table is arranged to be conveniently
4981 indexed by X Windows keysym values. */
4982 static char *lispy_function_keys
[] =
4984 /* X Keysym value */
4986 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4987 "backspace", "tab", "linefeed", "clear",
4989 0, 0, 0, "pause", /* 0xff10...1f */
4990 0, 0, 0, 0, 0, 0, 0, "escape",
4992 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4993 "romaji", "hiragana", "katakana", "hiragana-katakana",
4994 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4995 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4996 "eisu-toggle", /* 0xff30...3f */
4997 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4998 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5000 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5001 "down", "prior", "next", "end",
5002 "begin", 0, 0, 0, 0, 0, 0, 0,
5003 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5014 "break", /* 0xff6b */
5017 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5018 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5019 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5020 0, 0, 0, 0, 0, 0, 0, 0,
5021 "kp-tab", /* 0xff89 */
5023 "kp-enter", /* 0xff8d */
5025 "kp-f1", /* 0xff91 */
5029 "kp-home", /* 0xff95 */
5034 "kp-prior", /* kp-page-up */
5035 "kp-next", /* kp-page-down */
5041 0, 0, 0, 0, 0, 0, 0, 0, 0,
5042 "kp-multiply", /* 0xffaa */
5047 "kp-divide", /* 0xffaf */
5048 "kp-0", /* 0xffb0 */
5049 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5052 "kp-equal", /* 0xffbd */
5053 "f1", /* 0xffbe */ /* IsFunctionKey */
5055 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5056 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5057 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5058 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5059 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5060 0, 0, 0, 0, 0, 0, 0, 0,
5061 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5062 0, 0, 0, 0, 0, 0, 0, "delete"
5065 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5066 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5068 static char *iso_lispy_function_keys
[] =
5070 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5071 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5072 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5073 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5074 "iso-lefttab", /* 0xfe20 */
5075 "iso-move-line-up", "iso-move-line-down",
5076 "iso-partial-line-up", "iso-partial-line-down",
5077 "iso-partial-space-left", "iso-partial-space-right",
5078 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5079 "iso-release-margin-left", "iso-release-margin-right",
5080 "iso-release-both-margins",
5081 "iso-fast-cursor-left", "iso-fast-cursor-right",
5082 "iso-fast-cursor-up", "iso-fast-cursor-down",
5083 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5084 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5087 #endif /* not HAVE_NTGUI */
5089 Lisp_Object Vlispy_mouse_stem
;
5091 static char *lispy_wheel_names
[] =
5093 "wheel-up", "wheel-down"
5096 /* drag-n-drop events are generated when a set of selected files are
5097 dragged from another application and dropped onto an Emacs window. */
5098 static char *lispy_drag_n_drop_names
[] =
5103 /* Scroll bar parts. */
5104 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5105 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5106 Lisp_Object Qtop
, Qratio
;
5108 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5109 Lisp_Object
*scroll_bar_parts
[] = {
5110 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5111 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5114 /* A vector, indexed by button number, giving the down-going location
5115 of currently depressed buttons, both scroll bar and non-scroll bar.
5117 The elements have the form
5118 (BUTTON-NUMBER MODIFIER-MASK . REST)
5119 where REST is the cdr of a position as it would be reported in the event.
5121 The make_lispy_event function stores positions here to tell the
5122 difference between click and drag events, and to store the starting
5123 location to be included in drag events. */
5125 static Lisp_Object button_down_location
;
5127 /* Information about the most recent up-going button event: Which
5128 button, what location, and what time. */
5130 static int last_mouse_button
;
5131 static int last_mouse_x
;
5132 static int last_mouse_y
;
5133 static unsigned long button_down_time
;
5135 /* The maximum time between clicks to make a double-click, or Qnil to
5136 disable double-click detection, or Qt for no time limit. */
5138 Lisp_Object Vdouble_click_time
;
5140 /* Maximum number of pixels the mouse may be moved between clicks
5141 to make a double-click. */
5143 EMACS_INT double_click_fuzz
;
5145 /* The number of clicks in this multiple-click. */
5147 int double_click_count
;
5149 /* Return position of a mouse click or wheel event */
5152 make_lispy_position (f
, x
, y
, time
)
5158 enum window_part part
;
5159 Lisp_Object posn
= Qnil
;
5160 Lisp_Object extra_info
= Qnil
;
5163 /* Set `window' to the window under frame pixel coordinates (x,y) */
5165 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5166 &part
, &wx
, &wy
, 0);
5170 if (WINDOWP (window
))
5172 /* It's a click in window window at frame coordinates (x,y) */
5173 struct window
*w
= XWINDOW (window
);
5174 Lisp_Object string_info
= Qnil
;
5175 int textpos
= -1, rx
= -1, ry
= -1;
5176 int dx
= -1, dy
= -1;
5177 int width
= -1, height
= -1;
5178 Lisp_Object object
= Qnil
;
5180 /* Set event coordinates to window-relative coordinates
5181 for constructing the Lisp event below. */
5185 if (part
== ON_TEXT
)
5187 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5189 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5191 /* Mode line or header line. Look for a string under
5192 the mouse that may have a `local-map' property. */
5196 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5198 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5199 &object
, &dx
, &dy
, &width
, &height
);
5200 if (STRINGP (string
))
5201 string_info
= Fcons (string
, make_number (charpos
));
5202 if (w
== XWINDOW (selected_window
))
5205 textpos
= XMARKER (w
->pointm
)->charpos
;
5207 else if (part
== ON_VERTICAL_BORDER
)
5209 posn
= Qvertical_line
;
5214 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5219 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5221 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5222 &object
, &dx
, &dy
, &width
, &height
);
5223 if (STRINGP (string
))
5224 string_info
= Fcons (string
, make_number (charpos
));
5225 if (part
== ON_LEFT_MARGIN
)
5228 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5230 else if (part
== ON_LEFT_FRINGE
)
5232 posn
= Qleft_fringe
;
5235 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5237 : window_box_width (w
, LEFT_MARGIN_AREA
));
5240 else if (part
== ON_RIGHT_FRINGE
)
5242 posn
= Qright_fringe
;
5245 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5246 + window_box_width (w
, TEXT_AREA
)
5247 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5248 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5254 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5255 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5260 Lisp_Object string2
, object2
= Qnil
;
5261 struct display_pos p
;
5263 int width2
, height2
;
5264 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5265 &object2
, &dx2
, &dy2
,
5267 textpos
= CHARPOS (p
.pos
);
5268 if (rx
< 0) rx
= wx
;
5269 if (ry
< 0) ry
= wy
;
5270 if (dx
< 0) dx
= dx2
;
5271 if (dy
< 0) dy
= dy2
;
5272 if (width
< 0) width
= width2
;
5273 if (height
< 0) height
= height2
;
5277 posn
= make_number (textpos
);
5278 if (STRINGP (string2
))
5279 string_info
= Fcons (string2
,
5280 make_number (CHARPOS (p
.string_pos
)));
5286 #ifdef HAVE_WINDOW_SYSTEM
5287 if (IMAGEP (object
))
5289 Lisp_Object image_map
, hotspot
;
5290 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5292 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5294 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5295 posn
= XCAR (hotspot
);
5300 extra_info
= Fcons (object
,
5301 Fcons (Fcons (make_number (dx
),
5303 Fcons (Fcons (make_number (width
),
5304 make_number (height
)),
5308 extra_info
= Fcons (string_info
,
5309 Fcons (make_number (textpos
),
5310 Fcons (Fcons (make_number (rx
),
5316 XSETFRAME (window
, f
);
5321 XSETFASTINT (*x
, 0);
5322 XSETFASTINT (*y
, 0);
5325 return Fcons (window
,
5327 Fcons (Fcons (*x
, *y
),
5328 Fcons (make_number (time
),
5332 /* Given a struct input_event, build the lisp event which represents
5333 it. If EVENT is 0, build a mouse movement event from the mouse
5334 movement buffer, which should have a movement event in it.
5336 Note that events must be passed to this function in the order they
5337 are received; this function stores the location of button presses
5338 in order to build drag events when the button is released. */
5341 make_lispy_event (event
)
5342 struct input_event
*event
;
5346 switch (SWITCH_ENUM_CAST (event
->kind
))
5348 /* A simple keystroke. */
5349 case ASCII_KEYSTROKE_EVENT
:
5351 Lisp_Object lispy_c
;
5352 int c
= event
->code
& 0377;
5353 /* Turn ASCII characters into control characters
5355 if (event
->modifiers
& ctrl_modifier
)
5356 c
= make_ctrl_char (c
);
5358 /* Add in the other modifier bits. We took care of ctrl_modifier
5359 just above, and the shift key was taken care of by the X code,
5360 and applied to control characters by make_ctrl_char. */
5361 c
|= (event
->modifiers
5362 & (meta_modifier
| alt_modifier
5363 | hyper_modifier
| super_modifier
));
5364 /* Distinguish Shift-SPC from SPC. */
5365 if ((event
->code
& 0377) == 040
5366 && event
->modifiers
& shift_modifier
)
5367 c
|= shift_modifier
;
5368 button_down_time
= 0;
5369 XSETFASTINT (lispy_c
, c
);
5373 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5375 Lisp_Object lispy_c
;
5376 int c
= event
->code
;
5378 /* Add in the other modifier bits. We took care of ctrl_modifier
5379 just above, and the shift key was taken care of by the X code,
5380 and applied to control characters by make_ctrl_char. */
5381 c
|= (event
->modifiers
5382 & (meta_modifier
| alt_modifier
5383 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5384 /* What about the `shift' modifier ? */
5385 button_down_time
= 0;
5386 XSETFASTINT (lispy_c
, c
);
5390 /* A function key. The symbol may need to have modifier prefixes
5392 case NON_ASCII_KEYSTROKE_EVENT
:
5393 button_down_time
= 0;
5395 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5396 if (event
->code
== lispy_accent_codes
[i
])
5397 return modify_event_symbol (i
,
5399 Qfunction_key
, Qnil
,
5400 lispy_accent_keys
, &accent_key_syms
,
5401 (sizeof (lispy_accent_keys
)
5402 / sizeof (lispy_accent_keys
[0])));
5406 if (event
->code
>= 0x400 && event
->code
< 0x500)
5407 return modify_event_symbol (event
->code
- 0x400,
5408 event
->modifiers
& ~shift_modifier
,
5409 Qfunction_key
, Qnil
,
5410 lispy_kana_keys
, &func_key_syms
,
5411 (sizeof (lispy_kana_keys
)
5412 / sizeof (lispy_kana_keys
[0])));
5413 #endif /* XK_kana_A */
5416 #ifdef ISO_FUNCTION_KEY_OFFSET
5417 if (event
->code
< FUNCTION_KEY_OFFSET
5418 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5419 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5421 Qfunction_key
, Qnil
,
5422 iso_lispy_function_keys
, &func_key_syms
,
5423 (sizeof (iso_lispy_function_keys
)
5424 / sizeof (iso_lispy_function_keys
[0])));
5427 /* Handle system-specific or unknown keysyms. */
5428 if (event
->code
& (1 << 28)
5429 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5430 || (event
->code
- FUNCTION_KEY_OFFSET
5431 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5432 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5434 /* We need to use an alist rather than a vector as the cache
5435 since we can't make a vector long enuf. */
5436 if (NILP (current_kboard
->system_key_syms
))
5437 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5438 return modify_event_symbol (event
->code
,
5441 current_kboard
->Vsystem_key_alist
,
5442 0, ¤t_kboard
->system_key_syms
,
5446 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5448 Qfunction_key
, Qnil
,
5449 lispy_function_keys
, &func_key_syms
,
5450 (sizeof (lispy_function_keys
)
5451 / sizeof (lispy_function_keys
[0])));
5454 /* A mouse click. Figure out where it is, decide whether it's
5455 a press, click or drag, and build the appropriate structure. */
5456 case MOUSE_CLICK_EVENT
:
5457 #ifndef USE_TOOLKIT_SCROLL_BARS
5458 case SCROLL_BAR_CLICK_EVENT
:
5461 int button
= event
->code
;
5463 Lisp_Object position
;
5464 Lisp_Object
*start_pos_ptr
;
5465 Lisp_Object start_pos
;
5469 /* Build the position as appropriate for this mouse click. */
5470 if (event
->kind
== MOUSE_CLICK_EVENT
)
5472 struct frame
*f
= XFRAME (event
->frame_or_window
);
5473 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5477 /* Ignore mouse events that were made on frame that
5478 have been deleted. */
5479 if (! FRAME_LIVE_P (f
))
5482 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5483 /* EVENT->x and EVENT->y are frame-relative pixel
5484 coordinates at this place. Under old redisplay, COLUMN
5485 and ROW are set to frame relative glyph coordinates
5486 which are then used to determine whether this click is
5487 in a menu (non-toolkit version). */
5488 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5489 &column
, &row
, NULL
, 1);
5491 /* In the non-toolkit version, clicks on the menu bar
5492 are ordinary button events in the event buffer.
5493 Distinguish them, and invoke the menu.
5495 (In the toolkit version, the toolkit handles the menu bar
5496 and Emacs doesn't know about it until after the user
5497 makes a selection.) */
5498 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5499 && (event
->modifiers
& down_modifier
))
5501 Lisp_Object items
, item
;
5506 /* Activate the menu bar on the down event. If the
5507 up event comes in before the menu code can deal with it,
5509 if (! (event
->modifiers
& down_modifier
))
5513 /* Find the menu bar item under `column'. */
5515 items
= FRAME_MENU_BAR_ITEMS (f
);
5516 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5518 Lisp_Object pos
, string
;
5519 string
= AREF (items
, i
+ 1);
5520 pos
= AREF (items
, i
+ 3);
5523 if (column
>= XINT (pos
)
5524 && column
< XINT (pos
) + SCHARS (string
))
5526 item
= AREF (items
, i
);
5531 /* ELisp manual 2.4b says (x y) are window relative but
5532 code says they are frame-relative. */
5534 = Fcons (event
->frame_or_window
,
5536 Fcons (Fcons (event
->x
, event
->y
),
5537 Fcons (make_number (event
->timestamp
),
5540 return Fcons (item
, Fcons (position
, Qnil
));
5542 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5544 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5547 #ifndef USE_TOOLKIT_SCROLL_BARS
5550 /* It's a scrollbar click. */
5552 Lisp_Object portion_whole
;
5555 window
= event
->frame_or_window
;
5556 portion_whole
= Fcons (event
->x
, event
->y
);
5557 part
= *scroll_bar_parts
[(int) event
->part
];
5561 Fcons (Qvertical_scroll_bar
,
5562 Fcons (portion_whole
,
5563 Fcons (make_number (event
->timestamp
),
5564 Fcons (part
, Qnil
)))));
5566 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5568 if (button
>= ASIZE (button_down_location
))
5570 button_down_location
= larger_vector (button_down_location
,
5572 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5575 start_pos_ptr
= &AREF (button_down_location
, button
);
5576 start_pos
= *start_pos_ptr
;
5577 *start_pos_ptr
= Qnil
;
5580 /* On window-system frames, use the value of
5581 double-click-fuzz as is. On other frames, interpret it
5582 as a multiple of 1/8 characters. */
5586 if (WINDOWP (event
->frame_or_window
))
5587 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5588 else if (FRAMEP (event
->frame_or_window
))
5589 f
= XFRAME (event
->frame_or_window
);
5593 if (FRAME_WINDOW_P (f
))
5594 fuzz
= double_click_fuzz
;
5596 fuzz
= double_click_fuzz
/ 8;
5598 is_double
= (button
== last_mouse_button
5599 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5600 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5601 && button_down_time
!= 0
5602 && (EQ (Vdouble_click_time
, Qt
)
5603 || (INTEGERP (Vdouble_click_time
)
5604 && ((int)(event
->timestamp
- button_down_time
)
5605 < XINT (Vdouble_click_time
)))));
5608 last_mouse_button
= button
;
5609 last_mouse_x
= XINT (event
->x
);
5610 last_mouse_y
= XINT (event
->y
);
5612 /* If this is a button press, squirrel away the location, so
5613 we can decide later whether it was a click or a drag. */
5614 if (event
->modifiers
& down_modifier
)
5618 double_click_count
++;
5619 event
->modifiers
|= ((double_click_count
> 2)
5624 double_click_count
= 1;
5625 button_down_time
= event
->timestamp
;
5626 *start_pos_ptr
= Fcopy_alist (position
);
5627 ignore_mouse_drag_p
= 0;
5630 /* Now we're releasing a button - check the co-ordinates to
5631 see if this was a click or a drag. */
5632 else if (event
->modifiers
& up_modifier
)
5634 /* If we did not see a down before this up, ignore the up.
5635 Probably this happened because the down event chose a
5636 menu item. It would be an annoyance to treat the
5637 release of the button that chose the menu item as a
5640 if (!CONSP (start_pos
))
5643 event
->modifiers
&= ~up_modifier
;
5644 #if 0 /* Formerly we treated an up with no down as a click event. */
5645 if (!CONSP (start_pos
))
5646 event
->modifiers
|= click_modifier
;
5651 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5653 /* The third element of every position
5654 should be the (x,y) pair. */
5655 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5657 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5659 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5660 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5663 if (ignore_mouse_drag_p
)
5665 event
->modifiers
|= click_modifier
;
5666 ignore_mouse_drag_p
= 0;
5668 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5669 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5670 /* Maybe the mouse has moved a lot, caused scrolling, and
5671 eventually ended up at the same screen position (but
5672 not buffer position) in which case it is a drag, not
5674 /* FIXME: OTOH if the buffer position has changed
5675 because of a timer or process filter rather than
5676 because of mouse movement, it should be considered as
5677 a click. But mouse-drag-region completely ignores
5678 this case and it hasn't caused any real problem, so
5679 it's probably OK to ignore it as well. */
5680 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5681 /* Mouse hasn't moved (much). */
5682 event
->modifiers
|= click_modifier
;
5685 button_down_time
= 0;
5686 event
->modifiers
|= drag_modifier
;
5689 /* Don't check is_double; treat this as multiple
5690 if the down-event was multiple. */
5691 if (double_click_count
> 1)
5692 event
->modifiers
|= ((double_click_count
> 2)
5698 /* Every mouse event should either have the down_modifier or
5699 the up_modifier set. */
5703 /* Get the symbol we should use for the mouse click. */
5706 head
= modify_event_symbol (button
,
5708 Qmouse_click
, Vlispy_mouse_stem
,
5711 XVECTOR (mouse_syms
)->size
);
5712 if (event
->modifiers
& drag_modifier
)
5717 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5720 Fcons (make_number (double_click_count
),
5731 Lisp_Object position
;
5734 /* Build the position as appropriate for this mouse click. */
5735 struct frame
*f
= XFRAME (event
->frame_or_window
);
5737 /* Ignore wheel events that were made on frame that have been
5739 if (! FRAME_LIVE_P (f
))
5742 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5745 /* Set double or triple modifiers to indicate the wheel speed. */
5747 /* On window-system frames, use the value of
5748 double-click-fuzz as is. On other frames, interpret it
5749 as a multiple of 1/8 characters. */
5754 if (WINDOWP (event
->frame_or_window
))
5755 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5756 else if (FRAMEP (event
->frame_or_window
))
5757 f
= XFRAME (event
->frame_or_window
);
5761 if (FRAME_WINDOW_P (f
))
5762 fuzz
= double_click_fuzz
;
5764 fuzz
= double_click_fuzz
/ 8;
5766 is_double
= (last_mouse_button
< 0
5767 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5768 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5769 && button_down_time
!= 0
5770 && (EQ (Vdouble_click_time
, Qt
)
5771 || (INTEGERP (Vdouble_click_time
)
5772 && ((int)(event
->timestamp
- button_down_time
)
5773 < XINT (Vdouble_click_time
)))));
5776 double_click_count
++;
5777 event
->modifiers
|= ((double_click_count
> 2)
5783 double_click_count
= 1;
5784 event
->modifiers
|= click_modifier
;
5787 button_down_time
= event
->timestamp
;
5788 /* Use a negative value to distinguish wheel from mouse button. */
5789 last_mouse_button
= -1;
5790 last_mouse_x
= XINT (event
->x
);
5791 last_mouse_y
= XINT (event
->y
);
5797 if (event
->modifiers
& up_modifier
)
5799 /* Emit a wheel-up event. */
5800 event
->modifiers
&= ~up_modifier
;
5803 else if (event
->modifiers
& down_modifier
)
5805 /* Emit a wheel-down event. */
5806 event
->modifiers
&= ~down_modifier
;
5810 /* Every wheel event should either have the down_modifier or
5811 the up_modifier set. */
5814 /* Get the symbol we should use for the wheel event. */
5815 head
= modify_event_symbol (symbol_num
,
5821 ASIZE (wheel_syms
));
5824 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5827 Fcons (make_number (double_click_count
),
5836 #ifdef USE_TOOLKIT_SCROLL_BARS
5838 /* We don't have down and up events if using toolkit scroll bars,
5839 so make this always a click event. Store in the `part' of
5840 the Lisp event a symbol which maps to the following actions:
5842 `above_handle' page up
5843 `below_handle' page down
5847 `bottom' bottom of buffer
5848 `handle' thumb has been dragged.
5849 `end-scroll' end of interaction with scroll bar
5851 The incoming input_event contains in its `part' member an
5852 index of type `enum scroll_bar_part' which we can use as an
5853 index in scroll_bar_parts to get the appropriate symbol. */
5855 case SCROLL_BAR_CLICK_EVENT
:
5857 Lisp_Object position
, head
, window
, portion_whole
, part
;
5859 window
= event
->frame_or_window
;
5860 portion_whole
= Fcons (event
->x
, event
->y
);
5861 part
= *scroll_bar_parts
[(int) event
->part
];
5865 Fcons (Qvertical_scroll_bar
,
5866 Fcons (portion_whole
,
5867 Fcons (make_number (event
->timestamp
),
5868 Fcons (part
, Qnil
)))));
5870 /* Always treat scroll bar events as clicks. */
5871 event
->modifiers
|= click_modifier
;
5872 event
->modifiers
&= ~up_modifier
;
5874 if (event
->code
>= ASIZE (mouse_syms
))
5875 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5877 /* Get the symbol we should use for the mouse click. */
5878 head
= modify_event_symbol (event
->code
,
5883 XVECTOR (mouse_syms
)->size
);
5884 return Fcons (head
, Fcons (position
, Qnil
));
5887 #endif /* USE_TOOLKIT_SCROLL_BARS */
5890 case W32_SCROLL_BAR_CLICK_EVENT
:
5892 int button
= event
->code
;
5894 Lisp_Object position
;
5895 Lisp_Object
*start_pos_ptr
;
5896 Lisp_Object start_pos
;
5900 Lisp_Object portion_whole
;
5903 window
= event
->frame_or_window
;
5904 portion_whole
= Fcons (event
->x
, event
->y
);
5905 part
= *scroll_bar_parts
[(int) event
->part
];
5909 Fcons (Qvertical_scroll_bar
,
5910 Fcons (portion_whole
,
5911 Fcons (make_number (event
->timestamp
),
5912 Fcons (part
, Qnil
)))));
5915 /* Always treat W32 scroll bar events as clicks. */
5916 event
->modifiers
|= click_modifier
;
5919 /* Get the symbol we should use for the mouse click. */
5922 head
= modify_event_symbol (button
,
5927 XVECTOR (mouse_syms
)->size
);
5933 #endif /* WINDOWSNT */
5935 case DRAG_N_DROP_EVENT
:
5938 Lisp_Object head
, position
;
5941 f
= XFRAME (event
->frame_or_window
);
5944 /* Ignore mouse events that were made on frames that
5945 have been deleted. */
5946 if (! FRAME_LIVE_P (f
))
5949 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5952 head
= modify_event_symbol (0, event
->modifiers
,
5954 lispy_drag_n_drop_names
,
5955 &drag_n_drop_syms
, 1);
5961 #endif /* HAVE_MOUSE */
5963 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5964 || defined (USE_GTK)
5965 case MENU_BAR_EVENT
:
5966 if (EQ (event
->arg
, event
->frame_or_window
))
5967 /* This is the prefix key. We translate this to
5968 `(menu_bar)' because the code in keyboard.c for menu
5969 events, which we use, relies on this. */
5970 return Fcons (Qmenu_bar
, Qnil
);
5974 case SELECT_WINDOW_EVENT
:
5975 /* Make an event (select-window (WINDOW)). */
5976 return Fcons (Qselect_window
,
5977 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5980 case TOOL_BAR_EVENT
:
5981 if (EQ (event
->arg
, event
->frame_or_window
))
5982 /* This is the prefix key. We translate this to
5983 `(tool_bar)' because the code in keyboard.c for tool bar
5984 events, which we use, relies on this. */
5985 return Fcons (Qtool_bar
, Qnil
);
5986 else if (SYMBOLP (event
->arg
))
5987 return apply_modifiers (event
->modifiers
, event
->arg
);
5990 case USER_SIGNAL_EVENT
:
5991 /* A user signal. */
5993 char *name
= find_user_signal_name (event
->code
);
5996 return intern (name
);
5999 case SAVE_SESSION_EVENT
:
6000 return Qsave_session
;
6003 case MAC_APPLE_EVENT
:
6005 Lisp_Object spec
[2];
6009 return Fcons (Qmac_apple_event
,
6010 Fcons (Fvector (2, spec
),
6011 Fcons (event
->arg
, Qnil
)));
6015 /* The 'kind' field of the event is something we don't recognize. */
6024 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6026 Lisp_Object bar_window
;
6027 enum scroll_bar_part part
;
6031 /* Is it a scroll bar movement? */
6032 if (frame
&& ! NILP (bar_window
))
6034 Lisp_Object part_sym
;
6036 part_sym
= *scroll_bar_parts
[(int) part
];
6037 return Fcons (Qscroll_bar_movement
,
6038 (Fcons (Fcons (bar_window
,
6039 Fcons (Qvertical_scroll_bar
,
6040 Fcons (Fcons (x
, y
),
6041 Fcons (make_number (time
),
6047 /* Or is it an ordinary mouse movement? */
6050 Lisp_Object position
;
6052 position
= make_lispy_position (frame
, &x
, &y
, time
);
6054 return Fcons (Qmouse_movement
,
6060 #endif /* HAVE_MOUSE */
6062 /* Construct a switch frame event. */
6064 make_lispy_switch_frame (frame
)
6067 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6070 /* Manipulating modifiers. */
6072 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6074 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6075 SYMBOL's name of the end of the modifiers; the string from this
6076 position is the unmodified symbol name.
6078 This doesn't use any caches. */
6081 parse_modifiers_uncached (symbol
, modifier_end
)
6089 CHECK_SYMBOL (symbol
);
6092 name
= SYMBOL_NAME (symbol
);
6094 for (i
= 0; i
+2 <= SBYTES (name
); )
6096 int this_mod_end
= 0;
6099 /* See if the name continues with a modifier word.
6100 Check that the word appears, but don't check what follows it.
6101 Set this_mod and this_mod_end to record what we find. */
6103 switch (SREF (name
, i
))
6105 #define SINGLE_LETTER_MOD(BIT) \
6106 (this_mod_end = i + 1, this_mod = BIT)
6109 SINGLE_LETTER_MOD (alt_modifier
);
6113 SINGLE_LETTER_MOD (ctrl_modifier
);
6117 SINGLE_LETTER_MOD (hyper_modifier
);
6121 SINGLE_LETTER_MOD (meta_modifier
);
6125 SINGLE_LETTER_MOD (shift_modifier
);
6129 SINGLE_LETTER_MOD (super_modifier
);
6132 #undef SINGLE_LETTER_MOD
6134 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6135 if (i + LEN + 1 <= SBYTES (name) \
6136 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6138 this_mod_end = i + LEN; \
6143 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6144 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6145 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6149 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6151 #undef MULTI_LETTER_MOD
6155 /* If we found no modifier, stop looking for them. */
6156 if (this_mod_end
== 0)
6159 /* Check there is a dash after the modifier, so that it
6160 really is a modifier. */
6161 if (this_mod_end
>= SBYTES (name
)
6162 || SREF (name
, this_mod_end
) != '-')
6165 /* This modifier is real; look for another. */
6166 modifiers
|= this_mod
;
6167 i
= this_mod_end
+ 1;
6170 /* Should we include the `click' modifier? */
6171 if (! (modifiers
& (down_modifier
| drag_modifier
6172 | double_modifier
| triple_modifier
))
6173 && i
+ 7 == SBYTES (name
)
6174 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6175 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6176 modifiers
|= click_modifier
;
6184 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6185 prepended to the string BASE[0..BASE_LEN-1].
6186 This doesn't use any caches. */
6188 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6191 int base_len
, base_len_byte
;
6193 /* Since BASE could contain nulls, we can't use intern here; we have
6194 to use Fintern, which expects a genuine Lisp_String, and keeps a
6197 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6203 /* Only the event queue may use the `up' modifier; it should always
6204 be turned into a click or drag event before presented to lisp code. */
6205 if (modifiers
& up_modifier
)
6208 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6209 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6210 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6211 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6212 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6213 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6214 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6215 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6216 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6217 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6218 /* The click modifier is denoted by the absence of other modifiers. */
6222 mod_len
= p
- new_mods
;
6226 Lisp_Object new_name
;
6228 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6229 mod_len
+ base_len_byte
);
6230 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6231 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6233 return Fintern (new_name
, Qnil
);
6238 static char *modifier_names
[] =
6240 "up", "down", "drag", "click", "double", "triple", 0, 0,
6241 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6242 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6244 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6246 static Lisp_Object modifier_symbols
;
6248 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6250 lispy_modifier_list (modifiers
)
6253 Lisp_Object modifier_list
;
6256 modifier_list
= Qnil
;
6257 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6258 if (modifiers
& (1<<i
))
6259 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6262 return modifier_list
;
6266 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6267 where UNMODIFIED is the unmodified form of SYMBOL,
6268 MASK is the set of modifiers present in SYMBOL's name.
6269 This is similar to parse_modifiers_uncached, but uses the cache in
6270 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6271 Qevent_symbol_elements property. */
6274 parse_modifiers (symbol
)
6277 Lisp_Object elements
;
6279 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6280 if (CONSP (elements
))
6285 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6286 Lisp_Object unmodified
;
6289 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6290 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6293 if (modifiers
& ~INTMASK
)
6295 XSETFASTINT (mask
, modifiers
);
6296 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6298 /* Cache the parsing results on SYMBOL. */
6299 Fput (symbol
, Qevent_symbol_element_mask
,
6301 Fput (symbol
, Qevent_symbol_elements
,
6302 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6304 /* Since we know that SYMBOL is modifiers applied to unmodified,
6305 it would be nice to put that in unmodified's cache.
6306 But we can't, since we're not sure that parse_modifiers is
6313 /* Apply the modifiers MODIFIERS to the symbol BASE.
6314 BASE must be unmodified.
6316 This is like apply_modifiers_uncached, but uses BASE's
6317 Qmodifier_cache property, if present. It also builds
6318 Qevent_symbol_elements properties, since it has that info anyway.
6320 apply_modifiers copies the value of BASE's Qevent_kind property to
6321 the modified symbol. */
6323 apply_modifiers (modifiers
, base
)
6327 Lisp_Object cache
, index
, entry
, new_symbol
;
6329 /* Mask out upper bits. We don't know where this value's been. */
6330 modifiers
&= INTMASK
;
6332 /* The click modifier never figures into cache indices. */
6333 cache
= Fget (base
, Qmodifier_cache
);
6334 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6335 entry
= assq_no_quit (index
, cache
);
6338 new_symbol
= XCDR (entry
);
6341 /* We have to create the symbol ourselves. */
6342 new_symbol
= apply_modifiers_uncached (modifiers
,
6343 SDATA (SYMBOL_NAME (base
)),
6344 SCHARS (SYMBOL_NAME (base
)),
6345 SBYTES (SYMBOL_NAME (base
)));
6347 /* Add the new symbol to the base's cache. */
6348 entry
= Fcons (index
, new_symbol
);
6349 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6351 /* We have the parsing info now for free, so we could add it to
6353 XSETFASTINT (index, modifiers);
6354 Fput (new_symbol, Qevent_symbol_element_mask,
6355 Fcons (base, Fcons (index, Qnil)));
6356 Fput (new_symbol, Qevent_symbol_elements,
6357 Fcons (base, lispy_modifier_list (modifiers)));
6358 Sadly, this is only correct if `base' is indeed a base event,
6359 which is not necessarily the case. -stef */
6362 /* Make sure this symbol is of the same kind as BASE.
6364 You'd think we could just set this once and for all when we
6365 intern the symbol above, but reorder_modifiers may call us when
6366 BASE's property isn't set right; we can't assume that just
6367 because it has a Qmodifier_cache property it must have its
6368 Qevent_kind set right as well. */
6369 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6373 kind
= Fget (base
, Qevent_kind
);
6375 Fput (new_symbol
, Qevent_kind
, kind
);
6382 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6383 return a symbol with the modifiers placed in the canonical order.
6384 Canonical order is alphabetical, except for down and drag, which
6385 always come last. The 'click' modifier is never written out.
6387 Fdefine_key calls this to make sure that (for example) C-M-foo
6388 and M-C-foo end up being equivalent in the keymap. */
6391 reorder_modifiers (symbol
)
6394 /* It's hopefully okay to write the code this way, since everything
6395 will soon be in caches, and no consing will be done at all. */
6398 parsed
= parse_modifiers (symbol
);
6399 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6404 /* For handling events, we often want to produce a symbol whose name
6405 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6406 to some base, like the name of a function key or mouse button.
6407 modify_event_symbol produces symbols of this sort.
6409 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6410 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6413 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6414 into symbol names, or a string specifying a name stem used to
6415 construct a symbol name or the form `STEM-N', where N is the decimal
6416 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6417 non-nil; otherwise NAME_TABLE is used.
6419 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6420 persist between calls to modify_event_symbol that it can use to
6421 store a cache of the symbols it's generated for this NAME_TABLE
6422 before. The object stored there may be a vector or an alist.
6424 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6426 MODIFIERS is a set of modifier bits (as given in struct input_events)
6427 whose prefixes should be applied to the symbol name.
6429 SYMBOL_KIND is the value to be placed in the event_kind property of
6430 the returned symbol.
6432 The symbols we create are supposed to have an
6433 `event-symbol-elements' property, which lists the modifiers present
6434 in the symbol's name. */
6437 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6438 name_table
, symbol_table
, table_size
)
6441 Lisp_Object symbol_kind
;
6442 Lisp_Object name_alist_or_stem
;
6444 Lisp_Object
*symbol_table
;
6445 unsigned int table_size
;
6448 Lisp_Object symbol_int
;
6450 /* Get rid of the "vendor-specific" bit here. */
6451 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6453 /* Is this a request for a valid symbol? */
6454 if (symbol_num
< 0 || symbol_num
>= table_size
)
6457 if (CONSP (*symbol_table
))
6458 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6460 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6461 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6462 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6463 we've never used that symbol before. */
6466 if (! VECTORP (*symbol_table
)
6467 || XVECTOR (*symbol_table
)->size
!= table_size
)
6471 XSETFASTINT (size
, table_size
);
6472 *symbol_table
= Fmake_vector (size
, Qnil
);
6475 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6478 /* Have we already used this symbol before? */
6481 /* No; let's create it. */
6482 if (CONSP (name_alist_or_stem
))
6483 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6484 else if (STRINGP (name_alist_or_stem
))
6486 int len
= SBYTES (name_alist_or_stem
);
6487 char *buf
= (char *) alloca (len
+ 50);
6488 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6489 (long) XINT (symbol_int
) + 1);
6490 value
= intern (buf
);
6492 else if (name_table
!= 0 && name_table
[symbol_num
])
6493 value
= intern (name_table
[symbol_num
]);
6495 #ifdef HAVE_WINDOW_SYSTEM
6498 char *name
= x_get_keysym_name (symbol_num
);
6500 value
= intern (name
);
6507 sprintf (buf
, "key-%d", symbol_num
);
6508 value
= intern (buf
);
6511 if (CONSP (*symbol_table
))
6512 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6514 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6516 /* Fill in the cache entries for this symbol; this also
6517 builds the Qevent_symbol_elements property, which the user
6519 apply_modifiers (modifiers
& click_modifier
, value
);
6520 Fput (value
, Qevent_kind
, symbol_kind
);
6523 /* Apply modifiers to that symbol. */
6524 return apply_modifiers (modifiers
, value
);
6527 /* Convert a list that represents an event type,
6528 such as (ctrl meta backspace), into the usual representation of that
6529 event type as a number or a symbol. */
6531 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6532 doc
: /* Convert the event description list EVENT-DESC to an event type.
6533 EVENT-DESC should contain one base event type (a character or symbol)
6534 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6535 drag, down, double or triple). The base must be last.
6536 The return value is an event type (a character or symbol) which
6537 has the same base event type and all the specified modifiers. */)
6539 Lisp_Object event_desc
;
6547 while (CONSP (rest
))
6555 /* Given a symbol, see if it is a modifier name. */
6556 if (SYMBOLP (elt
) && CONSP (rest
))
6557 this = parse_solitary_modifier (elt
);
6561 else if (!NILP (base
))
6562 error ("Two bases given in one event");
6568 /* Let the symbol A refer to the character A. */
6569 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6570 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6572 if (INTEGERP (base
))
6574 /* Turn (shift a) into A. */
6575 if ((modifiers
& shift_modifier
) != 0
6576 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6578 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6579 modifiers
&= ~shift_modifier
;
6582 /* Turn (control a) into C-a. */
6583 if (modifiers
& ctrl_modifier
)
6584 return make_number ((modifiers
& ~ctrl_modifier
)
6585 | make_ctrl_char (XINT (base
)));
6587 return make_number (modifiers
| XINT (base
));
6589 else if (SYMBOLP (base
))
6590 return apply_modifiers (modifiers
, base
);
6593 error ("Invalid base event");
6598 /* Try to recognize SYMBOL as a modifier name.
6599 Return the modifier flag bit, or 0 if not recognized. */
6602 parse_solitary_modifier (symbol
)
6605 Lisp_Object name
= SYMBOL_NAME (symbol
);
6607 switch (SREF (name
, 0))
6609 #define SINGLE_LETTER_MOD(BIT) \
6610 if (SBYTES (name) == 1) \
6613 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6614 if (LEN == SBYTES (name) \
6615 && ! strncmp (SDATA (name), NAME, LEN)) \
6619 SINGLE_LETTER_MOD (alt_modifier
);
6623 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6627 SINGLE_LETTER_MOD (ctrl_modifier
);
6631 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6632 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6636 SINGLE_LETTER_MOD (hyper_modifier
);
6640 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6644 SINGLE_LETTER_MOD (meta_modifier
);
6648 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6652 SINGLE_LETTER_MOD (shift_modifier
);
6656 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6657 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6658 SINGLE_LETTER_MOD (super_modifier
);
6662 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6663 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6664 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6668 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6671 #undef SINGLE_LETTER_MOD
6672 #undef MULTI_LETTER_MOD
6678 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6679 Such a list is not valid as an event,
6680 but it can be a Lucid-style event type list. */
6683 lucid_event_type_list_p (object
)
6688 if (! CONSP (object
))
6691 if (EQ (XCAR (object
), Qhelp_echo
)
6692 || EQ (XCAR (object
), Qvertical_line
)
6693 || EQ (XCAR (object
), Qmode_line
)
6694 || EQ (XCAR (object
), Qheader_line
))
6697 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6701 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6708 /* Store into *addr a value nonzero if terminal input chars are available.
6709 Serves the purpose of ioctl (0, FIONREAD, addr)
6710 but works even if FIONREAD does not exist.
6711 (In fact, this may actually read some input.)
6713 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6714 timer events that are ripe.
6715 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6716 events (FOCUS_IN_EVENT).
6717 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6718 movements and toolkit scroll bar thumb drags. */
6721 get_input_pending (addr
, flags
)
6725 /* First of all, have we already counted some input? */
6726 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6728 /* If input is being read as it arrives, and we have none, there is none. */
6729 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6732 /* Try to read some input and see how much we get. */
6734 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6737 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6740 gobble_input (expected
)
6745 if (interrupt_input
)
6748 mask
= sigblock (sigmask (SIGIO
));
6749 read_avail_input (expected
);
6753 #ifdef POLL_FOR_INPUT
6754 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6757 mask
= sigblock (sigmask (SIGALRM
));
6758 read_avail_input (expected
);
6764 read_avail_input (expected
);
6768 /* Put a BUFFER_SWITCH_EVENT in the buffer
6769 so that read_key_sequence will notice the new current buffer. */
6772 record_asynch_buffer_change ()
6774 struct input_event event
;
6778 event
.kind
= BUFFER_SWITCH_EVENT
;
6779 event
.frame_or_window
= Qnil
;
6783 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6784 The purpose of the event is to make read_key_sequence look up the
6785 keymaps again. If we aren't in read_key_sequence, we don't need one,
6786 and the event could cause trouble by messing up (input-pending-p). */
6787 tem
= Fwaiting_for_user_input_p ();
6791 /* We never need these events if we have no asynchronous subprocesses. */
6795 /* Make sure no interrupt happens while storing the event. */
6797 if (interrupt_input
)
6800 mask
= sigblock (sigmask (SIGIO
));
6801 kbd_buffer_store_event (&event
);
6808 kbd_buffer_store_event (&event
);
6815 /* Read any terminal input already buffered up by the system
6816 into the kbd_buffer, but do not wait.
6818 EXPECTED should be nonzero if the caller knows there is some input.
6820 Except on VMS, all input is read by this function.
6821 If interrupt_input is nonzero, this function MUST be called
6822 only when SIGIO is blocked.
6824 Returns the number of keyboard chars read, or -1 meaning
6825 this is a bad time to try to read input. */
6828 read_avail_input (expected
)
6834 /* Store pending user signal events, if any. */
6835 if (store_user_signal_events ())
6838 if (read_socket_hook
)
6841 struct input_event hold_quit
;
6843 EVENT_INIT (hold_quit
);
6844 hold_quit
.kind
= NO_EVENT
;
6846 /* No need for FIONREAD or fcntl; just say don't wait. */
6847 while (nr
= (*read_socket_hook
) (input_fd
, expected
, &hold_quit
), nr
> 0)
6852 if (hold_quit
.kind
!= NO_EVENT
)
6853 kbd_buffer_store_event (&hold_quit
);
6857 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6858 the kbd_buffer can really hold. That may prevent loss
6859 of characters on some systems when input is stuffed at us. */
6860 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6863 /* Determine how many characters we should *try* to read. */
6866 #else /* not WINDOWSNT */
6868 n_to_read
= dos_keysns ();
6871 #else /* not MSDOS */
6873 /* Find out how much input is available. */
6874 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6875 /* Formerly simply reported no input, but that sometimes led to
6876 a failure of Emacs to terminate.
6877 SIGHUP seems appropriate if we can't reach the terminal. */
6878 /* ??? Is it really right to send the signal just to this process
6879 rather than to the whole process group?
6880 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6882 if (! noninteractive
)
6883 kill (getpid (), SIGHUP
);
6889 if (n_to_read
> sizeof cbuf
)
6890 n_to_read
= sizeof cbuf
;
6891 #else /* no FIONREAD */
6892 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6893 /* Read some input if available, but don't wait. */
6894 n_to_read
= sizeof cbuf
;
6895 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6900 #endif /* not MSDOS */
6901 #endif /* not WINDOWSNT */
6903 /* Now read; for one reason or another, this will not block.
6904 NREAD is set to the number of chars read. */
6908 cbuf
[0] = dos_keyread ();
6911 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6913 /* POSIX infers that processes which are not in the session leader's
6914 process group won't get SIGHUP's at logout time. BSDI adheres to
6915 this part standard and returns -1 from read (0) with errno==EIO
6916 when the control tty is taken away.
6917 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6918 if (nread
== -1 && errno
== EIO
)
6920 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6921 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6922 This looks incorrect, but it isn't, because _BSD causes
6923 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6924 and that causes a value other than 0 when there is no input. */
6930 /* We used to retry the read if it was interrupted.
6931 But this does the wrong thing when O_NDELAY causes
6932 an EAGAIN error. Does anybody know of a situation
6933 where a retry is actually needed? */
6935 nread
< 0 && (errno
== EAGAIN
6949 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6950 fcntl (input_fd
, F_SETFL
, 0);
6951 #endif /* USG or DGUX or CYGWIN */
6952 #endif /* no FIONREAD */
6953 for (i
= 0; i
< nread
; i
++)
6955 struct input_event buf
;
6957 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6959 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6960 buf
.modifiers
= meta_modifier
;
6965 buf
.frame_or_window
= selected_frame
;
6968 kbd_buffer_store_event (&buf
);
6969 /* Don't look at input that follows a C-g too closely.
6970 This reduces lossage due to autorepeat on C-g. */
6971 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6972 && buf
.code
== quit_char
)
6979 #endif /* not VMS */
6982 handle_async_input ()
6985 extern int select_alarmed
;
6988 interrupt_input_pending
= 0;
6993 nread
= read_avail_input (1);
6994 /* -1 means it's not ok to read the input now.
6995 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6996 0 means there was no keyboard input available. */
7001 select_alarmed
= 1; /* Force the select emulator back to life */
7006 #ifdef SIGIO /* for entire page */
7007 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7010 input_available_signal (signo
)
7013 /* Must preserve main program's value of errno. */
7014 int old_errno
= errno
;
7015 #if defined (USG) && !defined (POSIX_SIGNALS)
7016 /* USG systems forget handlers when they are used;
7017 must reestablish each time */
7018 signal (signo
, input_available_signal
);
7026 interrupt_input_pending
= 1;
7028 SIGNAL_THREAD_CHECK (signo
);
7031 if (input_available_clear_time
)
7032 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7035 handle_async_input ();
7045 /* Send ourselves a SIGIO.
7047 This function exists so that the UNBLOCK_INPUT macro in
7048 blockinput.h can have some way to take care of input we put off
7049 dealing with, without assuming that every file which uses
7050 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7052 reinvoke_input_signal ()
7055 handle_async_input ();
7061 /* User signal events. */
7063 struct user_signal_info
7065 /* Signal number. */
7068 /* Name of the signal. */
7071 /* Number of pending signals. */
7074 struct user_signal_info
*next
;
7077 /* List of user signals. */
7078 static struct user_signal_info
*user_signals
= NULL
;
7081 add_user_signal (sig
, name
)
7085 struct user_signal_info
*p
;
7087 for (p
= user_signals
; p
; p
= p
->next
)
7089 /* Already added. */
7092 p
= xmalloc (sizeof (struct user_signal_info
));
7094 p
->name
= xstrdup (name
);
7096 p
->next
= user_signals
;
7099 signal (sig
, handle_user_signal
);
7103 handle_user_signal (sig
)
7106 int old_errno
= errno
;
7107 struct user_signal_info
*p
;
7109 #if defined (USG) && !defined (POSIX_SIGNALS)
7110 /* USG systems forget handlers when they are used;
7111 must reestablish each time */
7112 signal (sig
, handle_user_signal
);
7115 SIGNAL_THREAD_CHECK (sig
);
7117 for (p
= user_signals
; p
; p
= p
->next
)
7122 if (interrupt_input
)
7123 kill (getpid (), SIGIO
);
7127 /* Tell wait_reading_process_output that it needs to wake
7128 up and look around. */
7129 if (input_available_clear_time
)
7130 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7139 find_user_signal_name (sig
)
7142 struct user_signal_info
*p
;
7144 for (p
= user_signals
; p
; p
= p
->next
)
7152 store_user_signal_events ()
7154 struct user_signal_info
*p
;
7155 struct input_event buf
;
7158 for (p
= user_signals
; p
; p
= p
->next
)
7159 if (p
->npending
> 0)
7165 bzero (&buf
, sizeof buf
);
7166 buf
.kind
= USER_SIGNAL_EVENT
;
7167 buf
.frame_or_window
= selected_frame
;
7169 nstored
+= p
->npending
;
7171 mask
= sigblock (sigmask (p
->sig
));
7175 kbd_buffer_store_event (&buf
);
7178 while (p
->npending
> 0);
7186 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7187 static Lisp_Object menu_bar_one_keymap_changed_items
;
7189 /* These variables hold the vector under construction within
7190 menu_bar_items and its subroutines, and the current index
7191 for storing into that vector. */
7192 static Lisp_Object menu_bar_items_vector
;
7193 static int menu_bar_items_index
;
7195 /* Return a vector of menu items for a menu bar, appropriate
7196 to the current buffer. Each item has three elements in the vector:
7199 OLD is an old vector we can optionally reuse, or nil. */
7202 menu_bar_items (old
)
7205 /* The number of keymaps we're scanning right now, and the number of
7206 keymaps we have allocated space for. */
7209 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7210 in the current keymaps, or nil where it is not a prefix. */
7213 Lisp_Object def
, tail
;
7222 /* In order to build the menus, we need to call the keymap
7223 accessors. They all call QUIT. But this function is called
7224 during redisplay, during which a quit is fatal. So inhibit
7225 quitting while building the menus.
7226 We do this instead of specbind because (1) errors will clear it anyway
7227 and (2) this avoids risk of specpdl overflow. */
7228 oquit
= Vinhibit_quit
;
7232 menu_bar_items_vector
= old
;
7234 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7235 menu_bar_items_index
= 0;
7237 /* Build our list of keymaps.
7238 If we recognize a function key and replace its escape sequence in
7239 keybuf with its symbol, or if the sequence starts with a mouse
7240 click and we need to switch buffers, we jump back here to rebuild
7241 the initial keymaps from the current buffer. */
7245 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7246 if (!NILP (Voverriding_local_map_menu_flag
))
7248 /* Yes, use them (if non-nil) as well as the global map. */
7249 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7251 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7252 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7253 if (!NILP (Voverriding_local_map
))
7254 maps
[nmaps
++] = Voverriding_local_map
;
7258 /* No, so use major and minor mode keymaps and keymap property.
7259 Note that menu-bar bindings in the local-map and keymap
7260 properties may not work reliable, as they are only
7261 recognized when the menu-bar (or mode-line) is updated,
7262 which does not normally happen after every command. */
7265 nminor
= current_minor_maps (NULL
, &tmaps
);
7266 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7268 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7269 maps
[nmaps
++] = tem
;
7270 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7272 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7274 maps
[nmaps
++] = current_global_map
;
7277 /* Look up in each map the dummy prefix key `menu-bar'. */
7281 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7282 if (!NILP (maps
[mapno
]))
7284 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7288 menu_bar_one_keymap_changed_items
= Qnil
;
7289 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7293 /* Move to the end those items that should be at the end. */
7295 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7298 int end
= menu_bar_items_index
;
7300 for (i
= 0; i
< end
; i
+= 4)
7301 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7303 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7304 /* Move the item at index I to the end,
7305 shifting all the others forward. */
7306 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7307 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7308 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7309 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7311 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7312 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7313 (end
- i
- 4) * sizeof (Lisp_Object
));
7314 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7315 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7316 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7317 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7322 /* Add nil, nil, nil, nil at the end. */
7323 i
= menu_bar_items_index
;
7324 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7327 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7328 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7329 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7330 menu_bar_items_vector
= tem
;
7332 /* Add this item. */
7333 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7334 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7335 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7336 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7337 menu_bar_items_index
= i
;
7339 Vinhibit_quit
= oquit
;
7340 return menu_bar_items_vector
;
7343 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7344 If there's already an item for KEY, add this DEF to it. */
7346 Lisp_Object item_properties
;
7349 menu_bar_item (key
, item
, dummy1
, dummy2
)
7350 Lisp_Object key
, item
, dummy1
;
7353 struct gcpro gcpro1
;
7357 if (EQ (item
, Qundefined
))
7359 /* If a map has an explicit `undefined' as definition,
7360 discard any previously made menu bar item. */
7362 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7363 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7365 if (menu_bar_items_index
> i
+ 4)
7366 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7367 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7368 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7369 menu_bar_items_index
-= 4;
7373 /* If this keymap has already contributed to this KEY,
7374 don't contribute to it a second time. */
7375 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7376 if (!NILP (tem
) || NILP (item
))
7379 menu_bar_one_keymap_changed_items
7380 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7382 /* We add to menu_bar_one_keymap_changed_items before doing the
7383 parse_menu_item, so that if it turns out it wasn't a menu item,
7384 it still correctly hides any further menu item. */
7386 i
= parse_menu_item (item
, 0, 1);
7391 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7393 /* Find any existing item for this KEY. */
7394 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7395 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7398 /* If we did not find this KEY, add it at the end. */
7399 if (i
== menu_bar_items_index
)
7401 /* If vector is too small, get a bigger one. */
7402 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7405 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7406 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7407 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7408 menu_bar_items_vector
= tem
;
7411 /* Add this item. */
7412 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7413 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7414 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7415 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7416 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7417 menu_bar_items_index
= i
;
7419 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7423 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7424 /* If the new and the old items are not both keymaps,
7425 the lookup will only find `item'. */
7426 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7427 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7431 /* This is used as the handler when calling menu_item_eval_property. */
7433 menu_item_eval_property_1 (arg
)
7436 /* If we got a quit from within the menu computation,
7437 quit all the way out of it. This takes care of C-] in the debugger. */
7438 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7439 Fsignal (Qquit
, Qnil
);
7444 /* Evaluate an expression and return the result (or nil if something
7445 went wrong). Used to evaluate dynamic parts of menu items. */
7447 menu_item_eval_property (sexpr
)
7450 int count
= SPECPDL_INDEX ();
7452 specbind (Qinhibit_redisplay
, Qt
);
7453 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7454 menu_item_eval_property_1
);
7455 return unbind_to (count
, val
);
7458 /* This function parses a menu item and leaves the result in the
7459 vector item_properties.
7460 ITEM is a key binding, a possible menu item.
7461 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7462 evaluate dynamic expressions in the menu item.
7463 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7465 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7466 parse_menu_item returns true if the item is a menu item and false
7470 parse_menu_item (item
, notreal
, inmenubar
)
7472 int notreal
, inmenubar
;
7474 Lisp_Object def
, tem
, item_string
, start
;
7475 Lisp_Object cachelist
;
7477 Lisp_Object keyhint
;
7488 /* Create item_properties vector if necessary. */
7489 if (NILP (item_properties
))
7491 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7493 /* Initialize optional entries. */
7494 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7495 AREF (item_properties
, i
) = Qnil
;
7496 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7498 /* Save the item here to protect it from GC. */
7499 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7501 item_string
= XCAR (item
);
7505 if (STRINGP (item_string
))
7507 /* Old format menu item. */
7508 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7510 /* Maybe help string. */
7511 if (CONSP (item
) && STRINGP (XCAR (item
)))
7513 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7518 /* Maybe key binding cache. */
7519 if (CONSP (item
) && CONSP (XCAR (item
))
7520 && (NILP (XCAR (XCAR (item
)))
7521 || VECTORP (XCAR (XCAR (item
)))))
7523 cachelist
= XCAR (item
);
7527 /* This is the real definition--the function to run. */
7528 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7530 /* Get enable property, if any. */
7533 tem
= Fget (item
, Qmenu_enable
);
7534 if (!NILP (Venable_disabled_menus_and_buttons
))
7535 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7536 else if (!NILP (tem
))
7537 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7540 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7542 /* New format menu item. */
7543 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7544 start
= XCDR (item
);
7547 /* We have a real binding. */
7548 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7550 item
= XCDR (start
);
7551 /* Is there a cache list with key equivalences. */
7552 if (CONSP (item
) && CONSP (XCAR (item
)))
7554 cachelist
= XCAR (item
);
7558 /* Parse properties. */
7559 while (CONSP (item
) && CONSP (XCDR (item
)))
7564 if (EQ (tem
, QCenable
))
7566 if (!NILP (Venable_disabled_menus_and_buttons
))
7567 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7569 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7571 else if (EQ (tem
, QCvisible
) && !notreal
)
7573 /* If got a visible property and that evaluates to nil
7574 then ignore this item. */
7575 tem
= menu_item_eval_property (XCAR (item
));
7579 else if (EQ (tem
, QChelp
))
7580 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7581 else if (EQ (tem
, QCfilter
))
7583 else if (EQ (tem
, QCkey_sequence
))
7586 if (NILP (cachelist
)
7587 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7588 /* Be GC protected. Set keyhint to item instead of tem. */
7591 else if (EQ (tem
, QCkeys
))
7594 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7595 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7597 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7602 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7604 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7606 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7613 else if (inmenubar
|| !NILP (start
))
7617 return 0; /* not a menu item */
7619 /* If item string is not a string, evaluate it to get string.
7620 If we don't get a string, skip this item. */
7621 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7622 if (!(STRINGP (item_string
) || notreal
))
7624 item_string
= menu_item_eval_property (item_string
);
7625 if (!STRINGP (item_string
))
7627 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7630 /* If got a filter apply it on definition. */
7631 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7634 def
= menu_item_eval_property (list2 (XCAR (filter
),
7635 list2 (Qquote
, def
)));
7637 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7640 /* Enable or disable selection of item. */
7641 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7647 tem
= menu_item_eval_property (tem
);
7648 if (inmenubar
&& NILP (tem
))
7649 return 0; /* Ignore disabled items in menu bar. */
7650 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7653 /* If we got no definition, this item is just unselectable text which
7654 is OK in a submenu but not in the menubar. */
7656 return (inmenubar
? 0 : 1);
7658 /* See if this is a separate pane or a submenu. */
7659 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7660 tem
= get_keymap (def
, 0, 1);
7661 /* For a subkeymap, just record its details and exit. */
7664 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7665 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7669 /* At the top level in the menu bar, do likewise for commands also.
7670 The menu bar does not display equivalent key bindings anyway.
7671 ITEM_PROPERTY_DEF is already set up properly. */
7675 /* This is a command. See if there is an equivalent key binding. */
7676 if (NILP (cachelist
))
7678 /* We have to create a cachelist. */
7679 CHECK_IMPURE (start
);
7680 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7681 cachelist
= XCAR (XCDR (start
));
7683 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7684 if (!NILP (keyhint
))
7686 XSETCAR (cachelist
, XCAR (keyhint
));
7689 else if (STRINGP (tem
))
7691 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7692 XSETCAR (cachelist
, Qt
);
7696 tem
= XCAR (cachelist
);
7703 tem
= Fkey_binding (tem
, Qnil
, Qnil
, Qnil
);
7705 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7708 def
= XCAR (prefix
);
7709 prefix
= XCDR (prefix
);
7712 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7714 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7716 if (newcache
/* Always check first time. */
7717 /* Should we check everything when precomputing key
7719 /* If something had no key binding before, don't recheck it
7720 because that is too slow--except if we have a list of
7721 rebound commands in Vdefine_key_rebound_commands, do
7722 recheck any command that appears in that list. */
7723 || (CONSP (Vdefine_key_rebound_commands
)
7724 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7727 /* We had a saved key. Is it still bound to the command? */
7730 /* If the command is an alias for another
7731 (such as lmenu.el set it up), check if the
7732 original command matches the cached command. */
7733 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7734 chkcache
= 1; /* Need to recompute key binding. */
7738 /* Recompute equivalent key binding. If the command is an alias
7739 for another (such as lmenu.el set it up), see if the original
7740 command name has equivalent keys. Otherwise look up the
7741 specified command itself. We don't try both, because that
7742 makes lmenu menus slow. */
7744 && SYMBOLP (XSYMBOL (def
)->function
)
7745 && ! NILP (Fget (def
, Qmenu_alias
)))
7746 def
= XSYMBOL (def
)->function
;
7747 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7748 XSETCAR (cachelist
, tem
);
7751 XSETCDR (cachelist
, Qnil
);
7755 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7757 tem
= XCAR (cachelist
);
7761 newcache
= chkcache
;
7764 tem
= Fkey_description (tem
, Qnil
);
7767 if (STRINGP (XCAR (prefix
)))
7768 tem
= concat2 (XCAR (prefix
), tem
);
7769 if (STRINGP (XCDR (prefix
)))
7770 tem
= concat2 (tem
, XCDR (prefix
));
7772 XSETCDR (cachelist
, tem
);
7776 tem
= XCDR (cachelist
);
7777 if (newcache
&& !NILP (tem
))
7779 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7780 XSETCDR (cachelist
, tem
);
7783 /* If we only want to precompute equivalent key bindings, stop here. */
7787 /* If we have an equivalent key binding, use that. */
7788 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7790 /* Include this when menu help is implemented.
7791 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7792 if (!(NILP (tem) || STRINGP (tem)))
7794 tem = menu_item_eval_property (tem);
7797 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7801 /* Handle radio buttons or toggle boxes. */
7802 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7804 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7805 = menu_item_eval_property (tem
);
7812 /***********************************************************************
7814 ***********************************************************************/
7816 /* A vector holding tool bar items while they are parsed in function
7817 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7820 static Lisp_Object tool_bar_items_vector
;
7822 /* A vector holding the result of parse_tool_bar_item. Layout is like
7823 the one for a single item in tool_bar_items_vector. */
7825 static Lisp_Object tool_bar_item_properties
;
7827 /* Next free index in tool_bar_items_vector. */
7829 static int ntool_bar_items
;
7831 /* The symbols `tool-bar', `:image' and `:rtl'. */
7833 extern Lisp_Object Qtool_bar
;
7834 Lisp_Object QCimage
;
7837 /* Function prototypes. */
7839 static void init_tool_bar_items
P_ ((Lisp_Object
));
7840 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7841 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7842 static void append_tool_bar_item
P_ ((void));
7845 /* Return a vector of tool bar items for keymaps currently in effect.
7846 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7847 tool bar items found. */
7850 tool_bar_items (reuse
, nitems
)
7861 /* In order to build the menus, we need to call the keymap
7862 accessors. They all call QUIT. But this function is called
7863 during redisplay, during which a quit is fatal. So inhibit
7864 quitting while building the menus. We do this instead of
7865 specbind because (1) errors will clear it anyway and (2) this
7866 avoids risk of specpdl overflow. */
7867 oquit
= Vinhibit_quit
;
7870 /* Initialize tool_bar_items_vector and protect it from GC. */
7871 init_tool_bar_items (reuse
);
7873 /* Build list of keymaps in maps. Set nmaps to the number of maps
7876 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7877 if (!NILP (Voverriding_local_map_menu_flag
))
7879 /* Yes, use them (if non-nil) as well as the global map. */
7880 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7882 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7883 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7884 if (!NILP (Voverriding_local_map
))
7885 maps
[nmaps
++] = Voverriding_local_map
;
7889 /* No, so use major and minor mode keymaps and keymap property.
7890 Note that tool-bar bindings in the local-map and keymap
7891 properties may not work reliable, as they are only
7892 recognized when the tool-bar (or mode-line) is updated,
7893 which does not normally happen after every command. */
7896 nminor
= current_minor_maps (NULL
, &tmaps
);
7897 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7899 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7900 maps
[nmaps
++] = tem
;
7901 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7903 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7906 /* Add global keymap at the end. */
7907 maps
[nmaps
++] = current_global_map
;
7909 /* Process maps in reverse order and look up in each map the prefix
7911 for (i
= nmaps
- 1; i
>= 0; --i
)
7912 if (!NILP (maps
[i
]))
7916 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7918 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7921 Vinhibit_quit
= oquit
;
7922 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7923 return tool_bar_items_vector
;
7927 /* Process the definition of KEY which is DEF. */
7930 process_tool_bar_item (key
, def
, data
, args
)
7931 Lisp_Object key
, def
, data
;
7935 extern Lisp_Object Qundefined
;
7936 struct gcpro gcpro1
, gcpro2
;
7938 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7942 if (EQ (def
, Qundefined
))
7944 /* If a map has an explicit `undefined' as definition,
7945 discard any previously made item. */
7946 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7948 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7950 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7952 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7953 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7954 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7955 * sizeof (Lisp_Object
)));
7956 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7961 else if (parse_tool_bar_item (key
, def
))
7962 /* Append a new tool bar item to tool_bar_items_vector. Accept
7963 more than one definition for the same key. */
7964 append_tool_bar_item ();
7970 /* Parse a tool bar item specification ITEM for key KEY and return the
7971 result in tool_bar_item_properties. Value is zero if ITEM is
7974 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7976 CAPTION is the caption of the item, If it's not a string, it is
7977 evaluated to get a string.
7979 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7980 as binding are currently ignored.
7982 The following properties are recognized:
7986 FORM is evaluated and specifies whether the tool bar item is
7987 enabled or disabled.
7991 FORM is evaluated and specifies whether the tool bar item is visible.
7993 - `:filter FUNCTION'
7995 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7996 result is stored as the new binding.
7998 - `:button (TYPE SELECTED)'
8000 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8001 and specifies whether the button is selected (pressed) or not.
8005 IMAGES is either a single image specification or a vector of four
8006 image specifications. See enum tool_bar_item_images.
8008 - `:help HELP-STRING'.
8010 Gives a help string to display for the tool bar item. */
8013 parse_tool_bar_item (key
, item
)
8014 Lisp_Object key
, item
;
8016 /* Access slot with index IDX of vector tool_bar_item_properties. */
8017 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8019 Lisp_Object filter
= Qnil
;
8020 Lisp_Object caption
;
8023 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8024 Rule out items that aren't lists, don't start with
8025 `menu-item' or whose rest following `tool-bar-item' is not a
8028 || !EQ (XCAR (item
), Qmenu_item
)
8029 || (item
= XCDR (item
),
8033 /* Create tool_bar_item_properties vector if necessary. Reset it to
8035 if (VECTORP (tool_bar_item_properties
))
8037 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8041 tool_bar_item_properties
8042 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8045 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8046 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8048 /* Get the caption of the item. If the caption is not a string,
8049 evaluate it to get a string. If we don't get a string, skip this
8051 caption
= XCAR (item
);
8052 if (!STRINGP (caption
))
8054 caption
= menu_item_eval_property (caption
);
8055 if (!STRINGP (caption
))
8058 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8060 /* Give up if rest following the caption is not a list. */
8065 /* Store the binding. */
8066 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8069 /* Ignore cached key binding, if any. */
8070 if (CONSP (item
) && CONSP (XCAR (item
)))
8073 /* Process the rest of the properties. */
8074 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8076 Lisp_Object key
, value
;
8079 value
= XCAR (XCDR (item
));
8081 if (EQ (key
, QCenable
))
8083 /* `:enable FORM'. */
8084 if (!NILP (Venable_disabled_menus_and_buttons
))
8085 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8087 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8089 else if (EQ (key
, QCvisible
))
8091 /* `:visible FORM'. If got a visible property and that
8092 evaluates to nil then ignore this item. */
8093 if (NILP (menu_item_eval_property (value
)))
8096 else if (EQ (key
, QChelp
))
8097 /* `:help HELP-STRING'. */
8098 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8099 else if (EQ (key
, QCfilter
))
8100 /* ':filter FORM'. */
8102 else if (EQ (key
, QCbutton
) && CONSP (value
))
8104 /* `:button (TYPE . SELECTED)'. */
8105 Lisp_Object type
, selected
;
8107 type
= XCAR (value
);
8108 selected
= XCDR (value
);
8109 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8111 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8112 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8115 else if (EQ (key
, QCimage
)
8117 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8118 /* Value is either a single image specification or a vector
8119 of 4 such specifications for the different button states. */
8120 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8121 else if (EQ (key
, Qrtl
))
8123 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8126 /* If got a filter apply it on binding. */
8128 PROP (TOOL_BAR_ITEM_BINDING
)
8129 = menu_item_eval_property (list2 (filter
,
8131 PROP (TOOL_BAR_ITEM_BINDING
))));
8133 /* See if the binding is a keymap. Give up if it is. */
8134 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8137 /* Enable or disable selection of item. */
8138 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8139 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8140 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8142 /* Handle radio buttons or toggle boxes. */
8143 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8144 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8145 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8153 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8154 that can be reused. */
8157 init_tool_bar_items (reuse
)
8160 if (VECTORP (reuse
))
8161 tool_bar_items_vector
= reuse
;
8163 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8164 ntool_bar_items
= 0;
8168 /* Append parsed tool bar item properties from
8169 tool_bar_item_properties */
8172 append_tool_bar_item ()
8174 Lisp_Object
*to
, *from
;
8176 /* Enlarge tool_bar_items_vector if necessary. */
8177 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8178 >= XVECTOR (tool_bar_items_vector
)->size
)
8180 Lisp_Object new_vector
;
8181 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
8183 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
8184 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
8185 XVECTOR (new_vector
)->contents
,
8186 old_size
* sizeof (Lisp_Object
));
8187 tool_bar_items_vector
= new_vector
;
8190 /* Append entries from tool_bar_item_properties to the end of
8191 tool_bar_items_vector. */
8192 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8193 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8194 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8195 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8202 /* Read a character using menus based on maps in the array MAPS.
8203 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8204 Return t if we displayed a menu but the user rejected it.
8206 PREV_EVENT is the previous input event, or nil if we are reading
8207 the first event of a key sequence.
8209 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8210 if we used a mouse menu to read the input, or zero otherwise. If
8211 USED_MOUSE_MENU is null, we don't dereference it.
8213 The prompting is done based on the prompt-string of the map
8214 and the strings associated with various map elements.
8216 This can be done with X menus or with menus put in the minibuf.
8217 These are done in different ways, depending on how the input will be read.
8218 Menus using X are done after auto-saving in read-char, getting the input
8219 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8220 and do auto-saving in the inner call of read_char. */
8223 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8226 Lisp_Object prev_event
;
8227 int *used_mouse_menu
;
8230 register Lisp_Object name
= Qnil
;
8232 if (used_mouse_menu
)
8233 *used_mouse_menu
= 0;
8235 /* Use local over global Menu maps */
8237 if (! menu_prompting
)
8240 /* Optionally disregard all but the global map. */
8241 if (inhibit_local_menu_bar_menus
)
8243 maps
+= (nmaps
- 1);
8247 /* Get the menu name from the first map that has one (a prompt string). */
8248 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8250 name
= Fkeymap_prompt (maps
[mapno
]);
8255 /* If we don't have any menus, just read a character normally. */
8256 if (!STRINGP (name
))
8260 /* If we got to this point via a mouse click,
8261 use a real menu for mouse selection. */
8262 if (EVENT_HAS_PARAMETERS (prev_event
)
8263 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8264 && !EQ (XCAR (prev_event
), Qtool_bar
))
8266 /* Display the menu and get the selection. */
8267 Lisp_Object
*realmaps
8268 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8272 /* Use the maps that are not nil. */
8273 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8274 if (!NILP (maps
[mapno
]))
8275 realmaps
[nmaps1
++] = maps
[mapno
];
8277 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8282 record_menu_key (XCAR (value
));
8284 /* If we got multiple events, unread all but
8286 There is no way to prevent those unread events
8287 from showing up later in last_nonmenu_event.
8288 So turn symbol and integer events into lists,
8289 to indicate that they came from a mouse menu,
8290 so that when present in last_nonmenu_event
8291 they won't confuse things. */
8292 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8294 record_menu_key (XCAR (tem
));
8295 if (SYMBOLP (XCAR (tem
))
8296 || INTEGERP (XCAR (tem
)))
8297 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8300 /* If we got more than one event, put all but the first
8301 onto this list to be read later.
8302 Return just the first event now. */
8303 Vunread_command_events
8304 = nconc2 (XCDR (value
), Vunread_command_events
);
8305 value
= XCAR (value
);
8307 else if (NILP (value
))
8309 if (used_mouse_menu
)
8310 *used_mouse_menu
= 1;
8313 #endif /* HAVE_MENUS */
8317 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8318 We make this bigger when necessary, and never free it. */
8319 static char *read_char_minibuf_menu_text
;
8320 /* Size of that buffer. */
8321 static int read_char_minibuf_menu_width
;
8324 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8330 register Lisp_Object name
;
8332 /* FIXME: Use the minibuffer's frame width. */
8333 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8336 Lisp_Object rest
, vector
;
8342 if (! menu_prompting
)
8345 /* Make sure we have a big enough buffer for the menu text. */
8346 if (read_char_minibuf_menu_text
== 0)
8348 read_char_minibuf_menu_width
= width
+ 4;
8349 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8351 else if (width
+ 4 > read_char_minibuf_menu_width
)
8353 read_char_minibuf_menu_width
= width
+ 4;
8354 read_char_minibuf_menu_text
8355 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8357 menu
= read_char_minibuf_menu_text
;
8359 /* Get the menu name from the first map that has one (a prompt string). */
8360 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8362 name
= Fkeymap_prompt (maps
[mapno
]);
8367 /* If we don't have any menus, just read a character normally. */
8368 if (!STRINGP (name
))
8371 /* Prompt string always starts with map's prompt, and a space. */
8372 strcpy (menu
, SDATA (name
));
8373 nlength
= SBYTES (name
);
8374 menu
[nlength
++] = ':';
8375 menu
[nlength
++] = ' ';
8378 /* Start prompting at start of first map. */
8382 /* Present the documented bindings, a line at a time. */
8389 Lisp_Object orig_defn_macro
;
8391 /* Loop over elements of map. */
8396 /* If reached end of map, start at beginning of next map. */
8400 /* At end of last map, wrap around to first map if just starting,
8401 or end this line if already have something on it. */
8405 if (notfirst
|| nobindings
) break;
8410 /* Look at the next element of the map. */
8412 elt
= XVECTOR (vector
)->contents
[idx
];
8414 elt
= Fcar_safe (rest
);
8416 if (idx
< 0 && VECTORP (elt
))
8418 /* If we found a dense table in the keymap,
8419 advanced past it, but start scanning its contents. */
8420 rest
= Fcdr_safe (rest
);
8426 /* An ordinary element. */
8427 Lisp_Object event
, tem
;
8431 event
= Fcar_safe (elt
); /* alist */
8432 elt
= Fcdr_safe (elt
);
8436 XSETINT (event
, idx
); /* vector */
8439 /* Ignore the element if it has no prompt string. */
8440 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8442 /* 1 if the char to type matches the string. */
8444 Lisp_Object upcased_event
, downcased_event
;
8445 Lisp_Object desc
= Qnil
;
8447 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8449 upcased_event
= Fupcase (event
);
8450 downcased_event
= Fdowncase (event
);
8451 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8452 || XINT (downcased_event
) == SREF (s
, 0));
8454 desc
= Fsingle_key_description (event
, Qnil
);
8456 #if 0 /* It is redundant to list the equivalent key bindings because
8457 the prefix is what the user has already typed. */
8459 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8461 /* Insert equivalent keybinding. */
8462 s
= concat2 (s
, tem
);
8465 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8466 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8468 /* Insert button prefix. */
8469 Lisp_Object selected
8470 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8471 if (EQ (tem
, QCradio
))
8472 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8474 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8475 s
= concat2 (tem
, s
);
8479 /* If we have room for the prompt string, add it to this line.
8480 If this is the first on the line, always add it. */
8481 if ((SCHARS (s
) + i
+ 2
8482 + (char_matches
? 0 : SCHARS (desc
) + 3))
8488 /* Punctuate between strings. */
8491 strcpy (menu
+ i
, ", ");
8497 /* If the char to type doesn't match the string's
8498 first char, explicitly show what char to type. */
8501 /* Add as much of string as fits. */
8502 thiswidth
= SCHARS (desc
);
8503 if (thiswidth
+ i
> width
)
8504 thiswidth
= width
- i
;
8505 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8507 strcpy (menu
+ i
, " = ");
8511 /* Add as much of string as fits. */
8512 thiswidth
= SCHARS (s
);
8513 if (thiswidth
+ i
> width
)
8514 thiswidth
= width
- i
;
8515 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8521 /* If this element does not fit, end the line now,
8522 and save the element for the next line. */
8523 strcpy (menu
+ i
, "...");
8528 /* Move past this element. */
8529 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8530 /* Handle reaching end of dense table. */
8535 rest
= Fcdr_safe (rest
);
8539 /* Prompt with that and read response. */
8540 message2_nolog (menu
, strlen (menu
),
8541 ! NILP (current_buffer
->enable_multibyte_characters
));
8543 /* Make believe its not a keyboard macro in case the help char
8544 is pressed. Help characters are not recorded because menu prompting
8545 is not used on replay.
8547 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8548 current_kboard
->defining_kbd_macro
= Qnil
;
8550 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8551 while (BUFFERP (obj
));
8552 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8554 if (!INTEGERP (obj
))
8559 if (! EQ (obj
, menu_prompt_more_char
)
8560 && (!INTEGERP (menu_prompt_more_char
)
8561 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8563 if (!NILP (current_kboard
->defining_kbd_macro
))
8564 store_kbd_macro_char (obj
);
8567 /* Help char - go round again */
8571 /* Reading key sequences. */
8573 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8574 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8575 keymap, or nil otherwise. Return the index of the first keymap in
8576 which KEY has any binding, or NMAPS if no map has a binding.
8578 If KEY is a meta ASCII character, treat it like meta-prefix-char
8579 followed by the corresponding non-meta character. Keymaps in
8580 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8583 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8586 NEXT may be the same array as CURRENT. */
8589 follow_key (key
, nmaps
, current
, defs
, next
)
8591 Lisp_Object
*current
, *defs
, *next
;
8594 int i
, first_binding
;
8596 first_binding
= nmaps
;
8597 for (i
= nmaps
- 1; i
>= 0; i
--)
8599 if (! NILP (current
[i
]))
8601 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8602 if (! NILP (defs
[i
]))
8609 /* Given the set of bindings we've found, produce the next set of maps. */
8610 if (first_binding
< nmaps
)
8611 for (i
= 0; i
< nmaps
; i
++)
8612 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8614 return first_binding
;
8617 /* Structure used to keep track of partial application of key remapping
8618 such as Vfunction_key_map and Vkey_translation_map. */
8619 typedef struct keyremap
8621 /* This is the map originally specified for this use. */
8623 /* This is a submap reached by looking up, in PARENT,
8624 the events from START to END. */
8626 /* Positions [START, END) in the key sequence buffer
8627 are the key that we have scanned so far.
8628 Those events are the ones that we will replace
8629 if PAREHT maps them into a key sequence. */
8633 /* Lookup KEY in MAP.
8634 MAP is a keymap mapping keys to key vectors or functions.
8635 If the mapping is a function and DO_FUNCTION is non-zero, then
8636 the function is called with PROMPT as parameter and its return
8637 value is used as the return value of this function (after checking
8638 that it is indeed a vector). */
8641 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8642 Lisp_Object map
, key
, prompt
;
8647 next
= access_keymap (map
, key
, 1, 0, 1);
8649 /* Handle symbol with autoload definition. */
8650 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8651 && CONSP (XSYMBOL (next
)->function
)
8652 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8653 do_autoload (XSYMBOL (next
)->function
, next
);
8655 /* Handle a symbol whose function definition is a keymap
8657 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8658 && (ARRAYP (XSYMBOL (next
)->function
)
8659 || KEYMAPP (XSYMBOL (next
)->function
)))
8660 next
= XSYMBOL (next
)->function
;
8662 /* If the keymap gives a function, not an
8663 array, then call the function with one arg and use
8664 its value instead. */
8665 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8670 next
= call1 (next
, prompt
);
8671 /* If the function returned something invalid,
8672 barf--don't ignore it.
8673 (To ignore it safely, we would need to gcpro a bunch of
8674 other variables.) */
8675 if (! (VECTORP (next
) || STRINGP (next
)))
8676 error ("Function %s returns invalid key sequence", tem
);
8681 /* Do one step of the key remapping used for function-key-map and
8682 key-translation-map:
8683 KEYBUF is the buffer holding the input events.
8684 BUFSIZE is its maximum size.
8685 FKEY is a pointer to the keyremap structure to use.
8686 INPUT is the index of the last element in KEYBUF.
8687 DOIT if non-zero says that the remapping can actually take place.
8688 DIFF is used to return the number of keys added/removed by the remapping.
8689 PARENT is the root of the keymap.
8690 PROMPT is the prompt to use if the remapping happens through a function.
8691 The return value is non-zero if the remapping actually took place. */
8694 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8695 Lisp_Object
*keybuf
, prompt
;
8697 int input
, doit
, *diff
, bufsize
;
8699 Lisp_Object next
, key
;
8701 key
= keybuf
[fkey
->end
++];
8703 if (KEYMAPP (fkey
->parent
))
8704 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8708 /* If keybuf[fkey->start..fkey->end] is bound in the
8709 map and we're in a position to do the key remapping, replace it with
8710 the binding and restart with fkey->start at the end. */
8711 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8713 int len
= XFASTINT (Flength (next
));
8716 *diff
= len
- (fkey
->end
- fkey
->start
);
8718 if (input
+ *diff
>= bufsize
)
8719 error ("Key sequence too long");
8721 /* Shift the keys that follow fkey->end. */
8723 for (i
= fkey
->end
; i
< input
; i
++)
8724 keybuf
[i
+ *diff
] = keybuf
[i
];
8726 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8727 keybuf
[i
+ *diff
] = keybuf
[i
];
8728 /* Overwrite the old keys with the new ones. */
8729 for (i
= 0; i
< len
; i
++)
8730 keybuf
[fkey
->start
+ i
]
8731 = Faref (next
, make_number (i
));
8733 fkey
->start
= fkey
->end
+= *diff
;
8734 fkey
->map
= fkey
->parent
;
8739 fkey
->map
= get_keymap (next
, 0, 1);
8741 /* If we no longer have a bound suffix, try a new position for
8743 if (!CONSP (fkey
->map
))
8745 fkey
->end
= ++fkey
->start
;
8746 fkey
->map
= fkey
->parent
;
8751 /* Read a sequence of keys that ends with a non prefix character,
8752 storing it in KEYBUF, a buffer of size BUFSIZE.
8754 Return the length of the key sequence stored.
8755 Return -1 if the user rejected a command menu.
8757 Echo starting immediately unless `prompt' is 0.
8759 Where a key sequence ends depends on the currently active keymaps.
8760 These include any minor mode keymaps active in the current buffer,
8761 the current buffer's local map, and the global map.
8763 If a key sequence has no other bindings, we check Vfunction_key_map
8764 to see if some trailing subsequence might be the beginning of a
8765 function key's sequence. If so, we try to read the whole function
8766 key, and substitute its symbolic name into the key sequence.
8768 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8769 `double-' events into similar click events, if that would make them
8770 bound. We try to turn `triple-' events first into `double-' events,
8773 If we get a mouse click in a mode line, vertical divider, or other
8774 non-text area, we treat the click as if it were prefixed by the
8775 symbol denoting that area - `mode-line', `vertical-line', or
8778 If the sequence starts with a mouse click, we read the key sequence
8779 with respect to the buffer clicked on, not the current buffer.
8781 If the user switches frames in the midst of a key sequence, we put
8782 off the switch-frame event until later; the next call to
8783 read_char will return it.
8785 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8786 from the selected window's buffer. */
8789 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8790 can_return_switch_frame
, fix_current_buffer
)
8791 Lisp_Object
*keybuf
;
8794 int dont_downcase_last
;
8795 int can_return_switch_frame
;
8796 int fix_current_buffer
;
8798 volatile Lisp_Object from_string
;
8799 volatile int count
= SPECPDL_INDEX ();
8801 /* How many keys there are in the current key sequence. */
8804 /* The length of the echo buffer when we started reading, and
8805 the length of this_command_keys when we started reading. */
8806 volatile int echo_start
;
8807 volatile int keys_start
;
8809 /* The number of keymaps we're scanning right now, and the number of
8810 keymaps we have allocated space for. */
8812 volatile int nmaps_allocated
= 0;
8814 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8815 the current keymaps. */
8816 Lisp_Object
*volatile defs
= NULL
;
8818 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8819 in the current keymaps, or nil where it is not a prefix. */
8820 Lisp_Object
*volatile submaps
= NULL
;
8822 /* The local map to start out with at start of key sequence. */
8823 volatile Lisp_Object orig_local_map
;
8825 /* The map from the `keymap' property to start out with at start of
8827 volatile Lisp_Object orig_keymap
;
8829 /* 1 if we have already considered switching to the local-map property
8830 of the place where a mouse click occurred. */
8831 volatile int localized_local_map
= 0;
8833 /* The index in submaps[] of the first keymap that has a binding for
8834 this key sequence. In other words, the lowest i such that
8835 submaps[i] is non-nil. */
8836 volatile int first_binding
;
8837 /* Index of the first key that has no binding.
8838 It is useless to try fkey.start larger than that. */
8839 volatile int first_unbound
;
8841 /* If t < mock_input, then KEYBUF[t] should be read as the next
8844 We use this to recover after recognizing a function key. Once we
8845 realize that a suffix of the current key sequence is actually a
8846 function key's escape sequence, we replace the suffix with the
8847 function key's binding from Vfunction_key_map. Now keybuf
8848 contains a new and different key sequence, so the echo area,
8849 this_command_keys, and the submaps and defs arrays are wrong. In
8850 this situation, we set mock_input to t, set t to 0, and jump to
8851 restart_sequence; the loop will read keys from keybuf up until
8852 mock_input, thus rebuilding the state; and then it will resume
8853 reading characters from the keyboard. */
8854 volatile int mock_input
= 0;
8856 /* If the sequence is unbound in submaps[], then
8857 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8858 and fkey.map is its binding.
8860 These might be > t, indicating that all function key scanning
8861 should hold off until t reaches them. We do this when we've just
8862 recognized a function key, to avoid searching for the function
8863 key's again in Vfunction_key_map. */
8864 volatile keyremap fkey
;
8866 /* Likewise, for key_translation_map. */
8867 volatile keyremap keytran
;
8869 /* If we receive a `switch-frame' or `select-window' event in the middle of
8870 a key sequence, we put it off for later.
8871 While we're reading, we keep the event here. */
8872 volatile Lisp_Object delayed_switch_frame
;
8874 /* See the comment below... */
8875 #if defined (GOBBLE_FIRST_EVENT)
8876 Lisp_Object first_event
;
8879 volatile Lisp_Object original_uppercase
;
8880 volatile int original_uppercase_position
= -1;
8882 /* Gets around Microsoft compiler limitations. */
8885 struct buffer
*starting_buffer
;
8887 /* List of events for which a fake prefix key has been generated. */
8888 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8890 #if defined (GOBBLE_FIRST_EVENT)
8894 struct gcpro gcpro1
;
8896 GCPRO1 (fake_prefixed_keys
);
8897 raw_keybuf_count
= 0;
8899 last_nonmenu_event
= Qnil
;
8901 delayed_switch_frame
= Qnil
;
8902 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8903 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8904 fkey
.start
= fkey
.end
= 0;
8905 keytran
.start
= keytran
.end
= 0;
8910 echo_prompt (prompt
);
8911 else if (cursor_in_echo_area
8912 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8913 && NILP (Fzerop (Vecho_keystrokes
)))
8914 /* This doesn't put in a dash if the echo buffer is empty, so
8915 you don't always see a dash hanging out in the minibuffer. */
8919 /* Record the initial state of the echo area and this_command_keys;
8920 we will need to restore them if we replay a key sequence. */
8922 echo_start
= echo_length ();
8923 keys_start
= this_command_key_count
;
8924 this_single_command_key_start
= keys_start
;
8926 #if defined (GOBBLE_FIRST_EVENT)
8927 /* This doesn't quite work, because some of the things that read_char
8928 does cannot safely be bypassed. It seems too risky to try to make
8931 /* Read the first char of the sequence specially, before setting
8932 up any keymaps, in case a filter runs and switches buffers on us. */
8933 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8935 #endif /* GOBBLE_FIRST_EVENT */
8937 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8938 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8941 /* We jump here when the key sequence has been thoroughly changed, and
8942 we need to rescan it starting from the beginning. When we jump here,
8943 keybuf[0..mock_input] holds the sequence we should reread. */
8946 starting_buffer
= current_buffer
;
8947 first_unbound
= bufsize
+ 1;
8949 /* Build our list of keymaps.
8950 If we recognize a function key and replace its escape sequence in
8951 keybuf with its symbol, or if the sequence starts with a mouse
8952 click and we need to switch buffers, we jump back here to rebuild
8953 the initial keymaps from the current buffer. */
8956 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8958 if (2 > nmaps_allocated
)
8960 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
8961 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
8962 nmaps_allocated
= 2;
8964 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8965 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8967 else if (!NILP (Voverriding_local_map
))
8969 if (2 > nmaps_allocated
)
8971 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
8972 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
8973 nmaps_allocated
= 2;
8975 if (!NILP (Voverriding_local_map
))
8976 submaps
[nmaps
++] = Voverriding_local_map
;
8984 nminor
= current_minor_maps (0, &maps
);
8985 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8987 if (total
> nmaps_allocated
)
8989 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8990 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8991 nmaps_allocated
= total
;
8994 if (!NILP (orig_keymap
))
8995 submaps
[nmaps
++] = orig_keymap
;
8997 bcopy (maps
, (void *) (submaps
+ nmaps
),
8998 nminor
* sizeof (submaps
[0]));
9002 submaps
[nmaps
++] = orig_local_map
;
9004 submaps
[nmaps
++] = current_global_map
;
9006 /* Find an accurate initial value for first_binding. */
9007 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9008 if (! NILP (submaps
[first_binding
]))
9011 /* Start from the beginning in keybuf. */
9014 /* These are no-ops the first time through, but if we restart, they
9015 revert the echo area and this_command_keys to their original state. */
9016 this_command_key_count
= keys_start
;
9017 if (INTERACTIVE
&& t
< mock_input
)
9018 echo_truncate (echo_start
);
9020 /* If the best binding for the current key sequence is a keymap, or
9021 we may be looking at a function key's escape sequence, keep on
9023 while (first_binding
< nmaps
9024 /* Keep reading as long as there's a prefix binding. */
9025 ? !NILP (submaps
[first_binding
])
9026 /* Don't return in the middle of a possible function key sequence,
9027 if the only bindings we found were via case conversion.
9028 Thus, if ESC O a has a function-key-map translation
9029 and ESC o has a binding, don't return after ESC O,
9030 so that we can translate ESC O plus the next character. */
9031 : (fkey
.start
< t
|| keytran
.start
< t
))
9034 int used_mouse_menu
= 0;
9036 /* Where the last real key started. If we need to throw away a
9037 key that has expanded into more than one element of keybuf
9038 (say, a mouse click on the mode line which is being treated
9039 as [mode-line (mouse-...)], then we backtrack to this point
9041 volatile int last_real_key_start
;
9043 /* These variables are analogous to echo_start and keys_start;
9044 while those allow us to restart the entire key sequence,
9045 echo_local_start and keys_local_start allow us to throw away
9047 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9049 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
9050 eassert (fkey
.start
<= fkey
.end
);
9051 eassert (keytran
.start
<= keytran
.end
);
9052 /* key-translation-map is applied *after* function-key-map. */
9053 eassert (keytran
.end
<= fkey
.start
);
9055 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
9056 { /* The prefix upto first_unbound has no binding and has
9057 no translation left to do either, so we know it's unbound.
9058 If we don't stop now, we risk staying here indefinitely
9059 (if the user keeps entering fkey or keytran prefixes
9060 like C-c ESC ESC ESC ESC ...) */
9062 for (i
= first_unbound
+ 1; i
< t
; i
++)
9063 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9064 mock_input
= t
- first_unbound
- 1;
9065 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9066 fkey
.map
= fkey
.parent
;
9067 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9068 keytran
.map
= keytran
.parent
;
9069 goto replay_sequence
;
9073 error ("Key sequence too long");
9076 echo_local_start
= echo_length ();
9077 keys_local_start
= this_command_key_count
;
9078 local_first_binding
= first_binding
;
9081 /* These are no-ops, unless we throw away a keystroke below and
9082 jumped back up to replay_key; in that case, these restore the
9083 variables to their original state, allowing us to replay the
9085 if (INTERACTIVE
&& t
< mock_input
)
9086 echo_truncate (echo_local_start
);
9087 this_command_key_count
= keys_local_start
;
9088 first_binding
= local_first_binding
;
9090 /* By default, assume each event is "real". */
9091 last_real_key_start
= t
;
9093 /* Does mock_input indicate that we are re-reading a key sequence? */
9097 add_command_key (key
);
9098 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9099 && NILP (Fzerop (Vecho_keystrokes
)))
9103 /* If not, we should actually read a character. */
9108 KBOARD
*interrupted_kboard
= current_kboard
;
9109 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9110 if (setjmp (wrong_kboard_jmpbuf
))
9112 if (!NILP (delayed_switch_frame
))
9114 interrupted_kboard
->kbd_queue
9115 = Fcons (delayed_switch_frame
,
9116 interrupted_kboard
->kbd_queue
);
9117 delayed_switch_frame
= Qnil
;
9120 interrupted_kboard
->kbd_queue
9121 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9123 /* If the side queue is non-empty, ensure it begins with a
9124 switch-frame, so we'll replay it in the right context. */
9125 if (CONSP (interrupted_kboard
->kbd_queue
)
9126 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9127 !(EVENT_HAS_PARAMETERS (key
)
9128 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9132 XSETFRAME (frame
, interrupted_frame
);
9133 interrupted_kboard
->kbd_queue
9134 = Fcons (make_lispy_switch_frame (frame
),
9135 interrupted_kboard
->kbd_queue
);
9138 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9139 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9140 goto replay_sequence
;
9143 key
= read_char (NILP (prompt
), nmaps
,
9144 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9145 &used_mouse_menu
, NULL
);
9148 /* read_char returns t when it shows a menu and the user rejects it.
9152 unbind_to (count
, Qnil
);
9157 /* read_char returns -1 at the end of a macro.
9158 Emacs 18 handles this by returning immediately with a
9159 zero, so that's what we'll do. */
9160 if (INTEGERP (key
) && XINT (key
) == -1)
9163 /* The Microsoft C compiler can't handle the goto that
9169 /* If the current buffer has been changed from under us, the
9170 keymap may have changed, so replay the sequence. */
9173 timer_resume_idle ();
9176 /* Reset the current buffer from the selected window
9177 in case something changed the former and not the latter.
9178 This is to be more consistent with the behavior
9179 of the command_loop_1. */
9180 if (fix_current_buffer
)
9182 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9184 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9185 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9188 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9189 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9190 goto replay_sequence
;
9193 /* If we have a quit that was typed in another frame, and
9194 quit_throw_to_read_char switched buffers,
9195 replay to get the right keymap. */
9197 && XINT (key
) == quit_char
9198 && current_buffer
!= starting_buffer
)
9201 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9205 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9206 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9207 goto replay_sequence
;
9212 if (EVENT_HAS_PARAMETERS (key
)
9213 /* Either a `switch-frame' or a `select-window' event. */
9214 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9216 /* If we're at the beginning of a key sequence, and the caller
9217 says it's okay, go ahead and return this event. If we're
9218 in the midst of a key sequence, delay it until the end. */
9219 if (t
> 0 || !can_return_switch_frame
)
9221 delayed_switch_frame
= key
;
9227 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9230 /* Clicks in non-text areas get prefixed by the symbol
9231 in their CHAR-ADDRESS field. For example, a click on
9232 the mode line is prefixed by the symbol `mode-line'.
9234 Furthermore, key sequences beginning with mouse clicks
9235 are read using the keymaps of the buffer clicked on, not
9236 the current buffer. So we may have to switch the buffer
9239 When we turn one event into two events, we must make sure
9240 that neither of the two looks like the original--so that,
9241 if we replay the events, they won't be expanded again.
9242 If not for this, such reexpansion could happen either here
9243 or when user programs play with this-command-keys. */
9244 if (EVENT_HAS_PARAMETERS (key
))
9249 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9250 if (EQ (kind
, Qmouse_click
))
9252 Lisp_Object window
, posn
;
9254 window
= POSN_WINDOW (EVENT_START (key
));
9255 posn
= POSN_POSN (EVENT_START (key
));
9258 || (!NILP (fake_prefixed_keys
)
9259 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9261 /* We're looking a second time at an event for which
9262 we generated a fake prefix key. Set
9263 last_real_key_start appropriately. */
9265 last_real_key_start
= t
- 1;
9268 /* Key sequences beginning with mouse clicks are
9269 read using the keymaps in the buffer clicked on,
9270 not the current buffer. If we're at the
9271 beginning of a key sequence, switch buffers. */
9272 if (last_real_key_start
== 0
9274 && BUFFERP (XWINDOW (window
)->buffer
)
9275 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9277 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9281 /* Arrange to go back to the original buffer once we're
9282 done reading the key sequence. Note that we can't
9283 use save_excursion_{save,restore} here, because they
9284 save point as well as the current buffer; we don't
9285 want to save point, because redisplay may change it,
9286 to accommodate a Fset_window_start or something. We
9287 don't want to do this at the top of the function,
9288 because we may get input from a subprocess which
9289 wants to change the selected window and stuff (say,
9291 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9293 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9295 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9296 orig_local_map
= get_local_map (PT
, current_buffer
,
9298 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9299 goto replay_sequence
;
9302 /* For a mouse click, get the local text-property keymap
9303 of the place clicked on, rather than point. */
9304 if (last_real_key_start
== 0
9305 && CONSP (XCDR (key
))
9306 && ! localized_local_map
)
9308 Lisp_Object map_here
, start
, pos
;
9310 localized_local_map
= 1;
9311 start
= EVENT_START (key
);
9313 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9315 pos
= POSN_BUFFER_POSN (start
);
9317 && XINT (pos
) >= BEGV
9318 && XINT (pos
) <= ZV
)
9320 map_here
= get_local_map (XINT (pos
),
9321 current_buffer
, Qlocal_map
);
9322 if (!EQ (map_here
, orig_local_map
))
9324 orig_local_map
= map_here
;
9325 ++localized_local_map
;
9328 map_here
= get_local_map (XINT (pos
),
9329 current_buffer
, Qkeymap
);
9330 if (!EQ (map_here
, orig_keymap
))
9332 orig_keymap
= map_here
;
9333 ++localized_local_map
;
9336 if (localized_local_map
> 1)
9341 goto replay_sequence
;
9347 /* Expand mode-line and scroll-bar events into two events:
9348 use posn as a fake prefix key. */
9350 && (NILP (fake_prefixed_keys
)
9351 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9353 if (t
+ 1 >= bufsize
)
9354 error ("Key sequence too long");
9357 keybuf
[t
+ 1] = key
;
9360 /* Record that a fake prefix key has been generated
9361 for KEY. Don't modify the event; this would
9362 prevent proper action when the event is pushed
9363 back into unread-command-events. */
9364 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9366 /* If on a mode line string with a local keymap,
9367 reconsider the key sequence with that keymap. */
9368 if (string
= POSN_STRING (EVENT_START (key
)),
9369 (CONSP (string
) && STRINGP (XCAR (string
))))
9371 Lisp_Object pos
, map
, map2
;
9373 pos
= XCDR (string
);
9374 string
= XCAR (string
);
9376 && XINT (pos
) < SCHARS (string
))
9378 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9380 orig_local_map
= map
;
9381 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9384 if (!NILP (map
) || !NILP (map2
))
9385 goto replay_sequence
;
9391 else if (NILP (from_string
)
9392 && (string
= POSN_STRING (EVENT_START (key
)),
9393 (CONSP (string
) && STRINGP (XCAR (string
)))))
9395 /* For a click on a string, i.e. overlay string or a
9396 string displayed via the `display' property,
9397 consider `local-map' and `keymap' properties of
9399 Lisp_Object pos
, map
, map2
;
9401 pos
= XCDR (string
);
9402 string
= XCAR (string
);
9404 && XINT (pos
) < SCHARS (string
))
9406 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9408 orig_local_map
= map
;
9409 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9413 if (!NILP (map
) || !NILP (map2
))
9415 from_string
= string
;
9418 goto replay_sequence
;
9423 else if (CONSP (XCDR (key
))
9424 && CONSP (EVENT_START (key
))
9425 && CONSP (XCDR (EVENT_START (key
))))
9429 posn
= POSN_POSN (EVENT_START (key
));
9430 /* Handle menu-bar events:
9431 insert the dummy prefix event `menu-bar'. */
9432 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9434 if (t
+ 1 >= bufsize
)
9435 error ("Key sequence too long");
9439 /* Zap the position in key, so we know that we've
9440 expanded it, and don't try to do so again. */
9441 POSN_SET_POSN (EVENT_START (key
),
9442 Fcons (posn
, Qnil
));
9445 goto replay_sequence
;
9447 else if (CONSP (posn
))
9449 /* We're looking at the second event of a
9450 sequence which we expanded before. Set
9451 last_real_key_start appropriately. */
9452 if (last_real_key_start
== t
&& t
> 0)
9453 last_real_key_start
= t
- 1;
9458 /* We have finally decided that KEY is something we might want
9460 first_binding
= (follow_key (key
,
9461 nmaps
- first_binding
,
9462 submaps
+ first_binding
,
9463 defs
+ first_binding
,
9464 submaps
+ first_binding
)
9467 /* If KEY wasn't bound, we'll try some fallbacks. */
9468 if (first_binding
< nmaps
)
9469 /* This is needed for the following scenario:
9470 event 0: a down-event that gets dropped by calling replay_key.
9471 event 1: some normal prefix like C-h.
9472 After event 0, first_unbound is 0, after event 1 fkey.start
9473 and keytran.start are both 1, so when we see that C-h is bound,
9474 we need to update first_unbound. */
9475 first_unbound
= max (t
+ 1, first_unbound
);
9480 /* Remember the position to put an upper bound on fkey.start. */
9481 first_unbound
= min (t
, first_unbound
);
9483 head
= EVENT_HEAD (key
);
9484 if (help_char_p (head
) && t
> 0)
9486 read_key_sequence_cmd
= Vprefix_help_command
;
9488 last_nonmenu_event
= key
;
9489 /* The Microsoft C compiler can't handle the goto that
9497 Lisp_Object breakdown
;
9500 breakdown
= parse_modifiers (head
);
9501 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9502 /* Attempt to reduce an unbound mouse event to a simpler
9503 event that is bound:
9504 Drags reduce to clicks.
9505 Double-clicks reduce to clicks.
9506 Triple-clicks reduce to double-clicks, then to clicks.
9507 Down-clicks are eliminated.
9508 Double-downs reduce to downs, then are eliminated.
9509 Triple-downs reduce to double-downs, then to downs,
9510 then are eliminated. */
9511 if (modifiers
& (down_modifier
| drag_modifier
9512 | double_modifier
| triple_modifier
))
9514 while (modifiers
& (down_modifier
| drag_modifier
9515 | double_modifier
| triple_modifier
))
9517 Lisp_Object new_head
, new_click
;
9518 if (modifiers
& triple_modifier
)
9519 modifiers
^= (double_modifier
| triple_modifier
);
9520 else if (modifiers
& double_modifier
)
9521 modifiers
&= ~double_modifier
;
9522 else if (modifiers
& drag_modifier
)
9523 modifiers
&= ~drag_modifier
;
9526 /* Dispose of this `down' event by simply jumping
9527 back to replay_key, to get another event.
9529 Note that if this event came from mock input,
9530 then just jumping back to replay_key will just
9531 hand it to us again. So we have to wipe out any
9534 We could delete keybuf[t] and shift everything
9535 after that to the left by one spot, but we'd also
9536 have to fix up any variable that points into
9537 keybuf, and shifting isn't really necessary
9540 Adding prefixes for non-textual mouse clicks
9541 creates two characters of mock input, and both
9542 must be thrown away. If we're only looking at
9543 the prefix now, we can just jump back to
9544 replay_key. On the other hand, if we've already
9545 processed the prefix, and now the actual click
9546 itself is giving us trouble, then we've lost the
9547 state of the keymaps we want to backtrack to, and
9548 we need to replay the whole sequence to rebuild
9551 Beyond that, only function key expansion could
9552 create more than two keys, but that should never
9553 generate mouse events, so it's okay to zero
9554 mock_input in that case too.
9556 FIXME: The above paragraph seems just plain
9557 wrong, if you consider things like
9558 xterm-mouse-mode. -stef
9560 Isn't this just the most wonderful code ever? */
9562 /* If mock_input > t + 1, the above simplification
9563 will actually end up dropping keys on the floor.
9564 This is probably OK for now, but even
9565 if mock_input <= t + 1, we need to adjust fkey
9567 Typical case [header-line down-mouse-N]:
9568 mock_input = 2, t = 1, fkey.end = 1,
9569 last_real_key_start = 0. */
9570 if (fkey
.end
> last_real_key_start
)
9572 fkey
.end
= fkey
.start
9573 = min (last_real_key_start
, fkey
.start
);
9574 fkey
.map
= fkey
.parent
;
9575 if (keytran
.end
> last_real_key_start
)
9577 keytran
.end
= keytran
.start
9578 = min (last_real_key_start
, keytran
.start
);
9579 keytran
.map
= keytran
.parent
;
9582 if (t
== last_real_key_start
)
9589 mock_input
= last_real_key_start
;
9590 goto replay_sequence
;
9595 = apply_modifiers (modifiers
, XCAR (breakdown
));
9597 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9599 /* Look for a binding for this new key. follow_key
9600 promises that it didn't munge submaps the
9601 last time we called it, since key was unbound. */
9603 = (follow_key (new_click
,
9604 nmaps
- local_first_binding
,
9605 submaps
+ local_first_binding
,
9606 defs
+ local_first_binding
,
9607 submaps
+ local_first_binding
)
9608 + local_first_binding
);
9610 /* If that click is bound, go for it. */
9611 if (first_binding
< nmaps
)
9616 /* Otherwise, we'll leave key set to the drag event. */
9623 /* Normally, last_nonmenu_event gets the previous key we read.
9624 But when a mouse popup menu is being used,
9625 we don't update last_nonmenu_event; it continues to hold the mouse
9626 event that preceded the first level of menu. */
9627 if (!used_mouse_menu
)
9628 last_nonmenu_event
= key
;
9630 /* Record what part of this_command_keys is the current key sequence. */
9631 this_single_command_key_start
= this_command_key_count
- t
;
9633 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9634 /* There is a binding and it's not a prefix.
9635 There is thus no function-key in this sequence.
9636 Moving fkey.start is important in this case to allow keytran.start
9637 to go over the sequence before we return (since we keep the
9638 invariant that keytran.end <= fkey.start). */
9641 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9644 /* If the sequence is unbound, see if we can hang a function key
9645 off the end of it. */
9646 /* Continue scan from fkey.end until we find a bound suffix. */
9647 while (fkey
.end
< t
)
9649 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9652 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9653 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9654 max (t
, mock_input
),
9655 /* If there's a binding (i.e.
9656 first_binding >= nmaps) we don't want
9657 to apply this function-key-mapping. */
9658 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9663 mock_input
= diff
+ max (t
, mock_input
);
9664 goto replay_sequence
;
9668 /* Look for this sequence in key-translation-map.
9669 Scan from keytran.end until we find a bound suffix. */
9670 while (keytran
.end
< fkey
.start
)
9672 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9675 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9676 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9681 mock_input
= diff
+ max (t
, mock_input
);
9682 /* Adjust the function-key-map counters. */
9686 goto replay_sequence
;
9690 /* If KEY is not defined in any of the keymaps,
9691 and cannot be part of a function key or translation,
9692 and is an upper case letter
9693 use the corresponding lower-case letter instead. */
9694 if (first_binding
>= nmaps
9695 && fkey
.start
>= t
&& keytran
.start
>= t
9697 && ((((XINT (key
) & 0x3ffff)
9698 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9699 && UPPERCASEP (XINT (key
) & 0x3ffff))
9700 || (XINT (key
) & shift_modifier
)))
9702 Lisp_Object new_key
;
9704 original_uppercase
= key
;
9705 original_uppercase_position
= t
- 1;
9707 if (XINT (key
) & shift_modifier
)
9708 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9710 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9711 | (XINT (key
) & ~0x3ffff)));
9713 /* We have to do this unconditionally, regardless of whether
9714 the lower-case char is defined in the keymaps, because they
9715 might get translated through function-key-map. */
9716 keybuf
[t
- 1] = new_key
;
9717 mock_input
= max (t
, mock_input
);
9719 goto replay_sequence
;
9721 /* If KEY is not defined in any of the keymaps,
9722 and cannot be part of a function key or translation,
9723 and is a shifted function key,
9724 use the corresponding unshifted function key instead. */
9725 if (first_binding
>= nmaps
9726 && fkey
.start
>= t
&& keytran
.start
>= t
9729 Lisp_Object breakdown
;
9732 breakdown
= parse_modifiers (key
);
9733 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9734 if (modifiers
& shift_modifier
)
9736 Lisp_Object new_key
;
9738 original_uppercase
= key
;
9739 original_uppercase_position
= t
- 1;
9741 modifiers
&= ~shift_modifier
;
9742 new_key
= apply_modifiers (modifiers
,
9745 keybuf
[t
- 1] = new_key
;
9746 mock_input
= max (t
, mock_input
);
9747 fkey
.start
= fkey
.end
= 0;
9748 keytran
.start
= keytran
.end
= 0;
9750 goto replay_sequence
;
9756 read_key_sequence_cmd
= (first_binding
< nmaps
9757 ? defs
[first_binding
]
9760 unread_switch_frame
= delayed_switch_frame
;
9761 unbind_to (count
, Qnil
);
9763 /* Don't downcase the last character if the caller says don't.
9764 Don't downcase it if the result is undefined, either. */
9765 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9767 && t
- 1 == original_uppercase_position
)
9768 keybuf
[t
- 1] = original_uppercase
;
9770 /* Occasionally we fabricate events, perhaps by expanding something
9771 according to function-key-map, or by adding a prefix symbol to a
9772 mouse click in the scroll bar or modeline. In this cases, return
9773 the entire generated key sequence, even if we hit an unbound
9774 prefix or a definition before the end. This means that you will
9775 be able to push back the event properly, and also means that
9776 read-key-sequence will always return a logical unit.
9779 for (; t
< mock_input
; t
++)
9781 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9782 && NILP (Fzerop (Vecho_keystrokes
)))
9783 echo_char (keybuf
[t
]);
9784 add_command_key (keybuf
[t
]);
9793 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9794 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9795 The sequence is sufficient to specify a non-prefix command in the
9796 current local and global maps.
9798 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9799 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9800 as a continuation of the previous key.
9802 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9803 convert the last event to lower case. (Normally any upper case event
9804 is converted to lower case if the original event is undefined and the lower
9805 case equivalent is defined.) A non-nil value is appropriate for reading
9806 a key sequence to be defined.
9808 A C-g typed while in this function is treated like any other character,
9809 and `quit-flag' is not set.
9811 If the key sequence starts with a mouse click, then the sequence is read
9812 using the keymaps of the buffer of the window clicked in, not the buffer
9813 of the selected window as normal.
9815 `read-key-sequence' drops unbound button-down events, since you normally
9816 only care about the click or drag events which follow them. If a drag
9817 or multi-click event is unbound, but the corresponding click event would
9818 be bound, `read-key-sequence' turns the event into a click event at the
9819 drag's starting position. This means that you don't have to distinguish
9820 between click and drag, double, or triple events unless you want to.
9822 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9823 lines separating windows, and scroll bars with imaginary keys
9824 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9826 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9827 function will process a switch-frame event if the user switches frames
9828 before typing anything. If the user switches frames in the middle of a
9829 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9830 is nil, then the event will be put off until after the current key sequence.
9832 `read-key-sequence' checks `function-key-map' for function key
9833 sequences, where they wouldn't conflict with ordinary bindings. See
9834 `function-key-map' for more details.
9836 The optional fifth argument COMMAND-LOOP, if non-nil, means
9837 that this key sequence is being read by something that will
9838 read commands one after another. It should be nil if the caller
9839 will read just one key sequence. */)
9840 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9842 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9843 Lisp_Object can_return_switch_frame
, command_loop
;
9845 Lisp_Object keybuf
[30];
9847 struct gcpro gcpro1
;
9848 int count
= SPECPDL_INDEX ();
9851 CHECK_STRING (prompt
);
9854 specbind (Qinput_method_exit_on_first_char
,
9855 (NILP (command_loop
) ? Qt
: Qnil
));
9856 specbind (Qinput_method_use_echo_area
,
9857 (NILP (command_loop
) ? Qt
: Qnil
));
9859 bzero (keybuf
, sizeof keybuf
);
9861 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9863 if (NILP (continue_echo
))
9865 this_command_key_count
= 0;
9866 this_command_key_count_reset
= 0;
9867 this_single_command_key_start
= 0;
9870 #ifdef HAVE_X_WINDOWS
9871 if (display_hourglass_p
)
9872 cancel_hourglass ();
9875 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9876 prompt
, ! NILP (dont_downcase_last
),
9877 ! NILP (can_return_switch_frame
), 0);
9879 #if 0 /* The following is fine for code reading a key sequence and
9880 then proceeding with a lenghty computation, but it's not good
9881 for code reading keys in a loop, like an input method. */
9882 #ifdef HAVE_X_WINDOWS
9883 if (display_hourglass_p
)
9894 return unbind_to (count
, make_event_array (i
, keybuf
));
9897 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9898 Sread_key_sequence_vector
, 1, 5, 0,
9899 doc
: /* Like `read-key-sequence' but always return a vector. */)
9900 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9902 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9903 Lisp_Object can_return_switch_frame
, command_loop
;
9905 Lisp_Object keybuf
[30];
9907 struct gcpro gcpro1
;
9908 int count
= SPECPDL_INDEX ();
9911 CHECK_STRING (prompt
);
9914 specbind (Qinput_method_exit_on_first_char
,
9915 (NILP (command_loop
) ? Qt
: Qnil
));
9916 specbind (Qinput_method_use_echo_area
,
9917 (NILP (command_loop
) ? Qt
: Qnil
));
9919 bzero (keybuf
, sizeof keybuf
);
9921 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9923 if (NILP (continue_echo
))
9925 this_command_key_count
= 0;
9926 this_command_key_count_reset
= 0;
9927 this_single_command_key_start
= 0;
9930 #ifdef HAVE_X_WINDOWS
9931 if (display_hourglass_p
)
9932 cancel_hourglass ();
9935 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9936 prompt
, ! NILP (dont_downcase_last
),
9937 ! NILP (can_return_switch_frame
), 0);
9939 #ifdef HAVE_X_WINDOWS
9940 if (display_hourglass_p
)
9950 return unbind_to (count
, Fvector (i
, keybuf
));
9953 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9954 doc
: /* Execute CMD as an editor command.
9955 CMD must be a symbol that satisfies the `commandp' predicate.
9956 Optional second arg RECORD-FLAG non-nil
9957 means unconditionally put this command in `command-history'.
9958 Otherwise, that is done only if an arg is read using the minibuffer.
9959 The argument KEYS specifies the value to use instead of (this-command-keys)
9960 when reading the arguments; if it is nil, (this-command-keys) is used.
9961 The argument SPECIAL, if non-nil, means that this command is executing
9962 a special event, so ignore the prefix argument and don't clear it. */)
9963 (cmd
, record_flag
, keys
, special
)
9964 Lisp_Object cmd
, record_flag
, keys
, special
;
9966 register Lisp_Object final
;
9967 register Lisp_Object tem
;
9968 Lisp_Object prefixarg
;
9969 struct backtrace backtrace
;
9970 extern int debug_on_next_call
;
9972 debug_on_next_call
= 0;
9976 prefixarg
= current_kboard
->Vprefix_arg
;
9977 Vcurrent_prefix_arg
= prefixarg
;
9978 current_kboard
->Vprefix_arg
= Qnil
;
9985 tem
= Fget (cmd
, Qdisabled
);
9986 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9988 tem
= Fsymbol_value (Qdisabled_command_function
);
9990 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9996 final
= Findirect_function (cmd
, Qnil
);
9998 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10000 struct gcpro gcpro1
, gcpro2
;
10002 GCPRO2 (cmd
, prefixarg
);
10003 do_autoload (final
, cmd
);
10010 if (STRINGP (final
) || VECTORP (final
))
10012 /* If requested, place the macro in the command history. For
10013 other sorts of commands, call-interactively takes care of
10015 if (!NILP (record_flag
))
10018 = Fcons (Fcons (Qexecute_kbd_macro
,
10019 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10022 /* Don't keep command history around forever. */
10023 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10025 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10027 XSETCDR (tem
, Qnil
);
10031 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10034 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10036 backtrace
.next
= backtrace_list
;
10037 backtrace_list
= &backtrace
;
10038 backtrace
.function
= &Qcall_interactively
;
10039 backtrace
.args
= &cmd
;
10040 backtrace
.nargs
= 1;
10041 backtrace
.evalargs
= 0;
10042 backtrace
.debug_on_exit
= 0;
10044 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
10046 backtrace_list
= backtrace
.next
;
10054 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10056 doc
: /* Read function name, then read its arguments and call it.
10058 To pass a numeric argument to the command you are invoking with, specify
10059 the numeric argument to this command.
10061 Noninteractively, the argument PREFIXARG is the prefix argument to
10062 give to the command you invoke, if it asks for an argument. */)
10064 Lisp_Object prefixarg
;
10066 Lisp_Object function
;
10068 int saved_last_point_position
;
10069 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10070 Lisp_Object bindings
, value
;
10071 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10072 #ifdef HAVE_X_WINDOWS
10073 /* The call to Fcompleting_read wil start and cancel the hourglass,
10074 but if the hourglass was already scheduled, this means that no
10075 hourglass will be shown for the actual M-x command itself.
10076 So we restart it if it is already scheduled. Note that checking
10077 hourglass_shown_p is not enough, normally the hourglass is not shown,
10078 just scheduled to be shown. */
10079 int hstarted
= hourglass_started ();
10082 saved_keys
= Fvector (this_command_key_count
,
10083 XVECTOR (this_command_keys
)->contents
);
10084 saved_last_point_position_buffer
= last_point_position_buffer
;
10085 saved_last_point_position
= last_point_position
;
10087 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10089 if (EQ (prefixarg
, Qminus
))
10090 strcpy (buf
, "- ");
10091 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10092 strcpy (buf
, "C-u ");
10093 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10094 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10095 else if (INTEGERP (prefixarg
))
10096 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10098 /* This isn't strictly correct if execute-extended-command
10099 is bound to anything else. Perhaps it should use
10100 this_command_keys? */
10101 strcat (buf
, "M-x ");
10103 /* Prompt with buf, and then read a string, completing from and
10104 restricting to the set of all defined commands. Don't provide
10105 any initial input. Save the command read on the extended-command
10107 function
= Fcompleting_read (build_string (buf
),
10108 Vobarray
, Qcommandp
,
10109 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10112 #ifdef HAVE_X_WINDOWS
10113 if (hstarted
) start_hourglass ();
10116 if (STRINGP (function
) && SCHARS (function
) == 0)
10117 error ("No command name given");
10119 /* Set this_command_keys to the concatenation of saved_keys and
10120 function, followed by a RET. */
10125 this_command_key_count
= 0;
10126 this_command_key_count_reset
= 0;
10127 this_single_command_key_start
= 0;
10129 keys
= XVECTOR (saved_keys
)->contents
;
10130 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10131 add_command_key (keys
[i
]);
10133 for (i
= 0; i
< SCHARS (function
); i
++)
10134 add_command_key (Faref (function
, make_number (i
)));
10136 add_command_key (make_number ('\015'));
10139 last_point_position
= saved_last_point_position
;
10140 last_point_position_buffer
= saved_last_point_position_buffer
;
10144 function
= Fintern (function
, Qnil
);
10145 current_kboard
->Vprefix_arg
= prefixarg
;
10146 Vthis_command
= function
;
10147 real_this_command
= function
;
10149 /* If enabled, show which key runs this command. */
10150 if (!NILP (Vsuggest_key_bindings
)
10151 && NILP (Vexecuting_kbd_macro
)
10152 && SYMBOLP (function
))
10153 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10159 GCPRO2 (bindings
, value
);
10160 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10162 /* If the command has a key binding, print it now. */
10163 if (!NILP (bindings
)
10164 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10167 /* But first wait, and skip the message if there is input. */
10168 Lisp_Object waited
;
10170 /* If this command displayed something in the echo area;
10171 wait a few seconds, then display our suggestion message. */
10172 if (NILP (echo_area_buffer
[0]))
10173 waited
= sit_for (make_number (0), 0, 2);
10174 else if (NUMBERP (Vsuggest_key_bindings
))
10175 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10177 waited
= sit_for (make_number (2), 0, 2);
10179 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10181 Lisp_Object binding
;
10183 int message_p
= push_message ();
10184 int count
= SPECPDL_INDEX ();
10186 record_unwind_protect (pop_message_unwind
, Qnil
);
10187 binding
= Fkey_description (bindings
, Qnil
);
10190 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10193 sprintf (newmessage
, "You can run the command `%s' with %s",
10194 SDATA (SYMBOL_NAME (function
)),
10196 message2_nolog (newmessage
,
10197 strlen (newmessage
),
10198 STRING_MULTIBYTE (binding
));
10199 if (NUMBERP (Vsuggest_key_bindings
))
10200 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10202 waited
= sit_for (make_number (2), 0, 2);
10204 if (!NILP (waited
) && message_p
)
10205 restore_message ();
10207 unbind_to (count
, Qnil
);
10211 RETURN_UNGCPRO (value
);
10215 /* Return nonzero if input events are pending. */
10218 detect_input_pending ()
10220 if (!input_pending
)
10221 get_input_pending (&input_pending
, 0);
10223 return input_pending
;
10226 /* Return nonzero if input events other than mouse movements are
10230 detect_input_pending_ignore_squeezables ()
10232 if (!input_pending
)
10233 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10235 return input_pending
;
10238 /* Return nonzero if input events are pending, and run any pending timers. */
10241 detect_input_pending_run_timers (do_display
)
10244 int old_timers_run
= timers_run
;
10246 if (!input_pending
)
10247 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10249 if (old_timers_run
!= timers_run
&& do_display
)
10251 redisplay_preserve_echo_area (8);
10252 /* The following fixes a bug when using lazy-lock with
10253 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10254 from an idle timer function. The symptom of the bug is that
10255 the cursor sometimes doesn't become visible until the next X
10256 event is processed. --gerd. */
10258 rif
->flush_display (NULL
);
10261 return input_pending
;
10264 /* This is called in some cases before a possible quit.
10265 It cases the next call to detect_input_pending to recompute input_pending.
10266 So calling this function unnecessarily can't do any harm. */
10269 clear_input_pending ()
10274 /* Return nonzero if there are pending requeued events.
10275 This isn't used yet. The hope is to make wait_reading_process_output
10276 call it, and return if it runs Lisp code that unreads something.
10277 The problem is, kbd_buffer_get_event needs to be fixed to know what
10278 to do in that case. It isn't trivial. */
10281 requeued_events_pending_p ()
10283 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10287 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10288 doc
: /* Return t if command input is currently available with no wait.
10289 Actually, the value is nil only if we can be sure that no input is available;
10290 if there is a doubt, the value is t. */)
10293 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10294 || !NILP (Vunread_post_input_method_events
)
10295 || !NILP (Vunread_input_method_events
))
10298 get_input_pending (&input_pending
,
10299 READABLE_EVENTS_DO_TIMERS_NOW
10300 | READABLE_EVENTS_FILTER_EVENTS
);
10301 return input_pending
> 0 ? Qt
: Qnil
;
10304 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10305 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10308 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10311 if (total_keys
< NUM_RECENT_KEYS
)
10312 return Fvector (total_keys
, keys
);
10315 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10316 bcopy (keys
+ recent_keys_index
,
10317 XVECTOR (val
)->contents
,
10318 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10320 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10321 recent_keys_index
* sizeof (Lisp_Object
));
10326 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10327 doc
: /* Return the key sequence that invoked this command.
10328 However, if the command has called `read-key-sequence', it returns
10329 the last key sequence that has been read.
10330 The value is a string or a vector.
10332 See also `this-command-keys-vector'. */)
10335 return make_event_array (this_command_key_count
,
10336 XVECTOR (this_command_keys
)->contents
);
10339 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10340 doc
: /* Return the key sequence that invoked this command, as a vector.
10341 However, if the command has called `read-key-sequence', it returns
10342 the last key sequence that has been read.
10344 See also `this-command-keys'. */)
10347 return Fvector (this_command_key_count
,
10348 XVECTOR (this_command_keys
)->contents
);
10351 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10352 Sthis_single_command_keys
, 0, 0, 0,
10353 doc
: /* Return the key sequence that invoked this command.
10354 More generally, it returns the last key sequence read, either by
10355 the command loop or by `read-key-sequence'.
10356 Unlike `this-command-keys', this function's value
10357 does not include prefix arguments.
10358 The value is always a vector. */)
10361 return Fvector (this_command_key_count
10362 - this_single_command_key_start
,
10363 (XVECTOR (this_command_keys
)->contents
10364 + this_single_command_key_start
));
10367 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10368 Sthis_single_command_raw_keys
, 0, 0, 0,
10369 doc
: /* Return the raw events that were read for this command.
10370 More generally, it returns the last key sequence read, either by
10371 the command loop or by `read-key-sequence'.
10372 Unlike `this-single-command-keys', this function's value
10373 shows the events before all translations (except for input methods).
10374 The value is always a vector. */)
10377 return Fvector (raw_keybuf_count
,
10378 (XVECTOR (raw_keybuf
)->contents
));
10381 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10382 Sreset_this_command_lengths
, 0, 0, 0,
10383 doc
: /* Make the unread events replace the last command and echo.
10384 Used in `universal-argument-other-key'.
10386 `universal-argument-other-key' rereads the event just typed.
10387 It then gets translated through `function-key-map'.
10388 The translated event has to replace the real events,
10389 both in the value of (this-command-keys) and in echoing.
10390 To achieve this, `universal-argument-other-key' calls
10391 `reset-this-command-lengths', which discards the record of reading
10392 these events the first time. */)
10395 this_command_key_count
= before_command_key_count
;
10396 if (this_command_key_count
< this_single_command_key_start
)
10397 this_single_command_key_start
= this_command_key_count
;
10399 echo_truncate (before_command_echo_length
);
10401 /* Cause whatever we put into unread-command-events
10402 to echo as if it were being freshly read from the keyboard. */
10403 this_command_key_count_reset
= 1;
10408 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10409 Sclear_this_command_keys
, 0, 1, 0,
10410 doc
: /* Clear out the vector that `this-command-keys' returns.
10411 Also clear the record of the last 100 events, unless optional arg
10412 KEEP-RECORD is non-nil. */)
10414 Lisp_Object keep_record
;
10418 this_command_key_count
= 0;
10419 this_command_key_count_reset
= 0;
10421 if (NILP (keep_record
))
10423 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10424 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10426 recent_keys_index
= 0;
10431 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10432 doc
: /* Return the current depth in recursive edits. */)
10436 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10440 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10441 "FOpen dribble file: ",
10442 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10443 If FILE is nil, close any open dribble file. */)
10456 file
= Fexpand_file_name (file
, Qnil
);
10457 dribble
= fopen (SDATA (file
), "w");
10459 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10464 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10465 doc
: /* Discard the contents of the terminal input buffer.
10466 Also end any kbd macro being defined. */)
10469 if (!NILP (current_kboard
->defining_kbd_macro
))
10471 /* Discard the last command from the macro. */
10472 Fcancel_kbd_macro_events ();
10476 update_mode_lines
++;
10478 Vunread_command_events
= Qnil
;
10479 unread_command_char
= -1;
10481 discard_tty_input ();
10483 kbd_fetch_ptr
= kbd_store_ptr
;
10489 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10490 doc
: /* Stop Emacs and return to superior process. You can resume later.
10491 If `cannot-suspend' is non-nil, or if the system doesn't support job
10492 control, run a subshell instead.
10494 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10495 to be read as terminal input by Emacs's parent, after suspension.
10497 Before suspending, run the normal hook `suspend-hook'.
10498 After resumption run the normal hook `suspend-resume-hook'.
10500 Some operating systems cannot stop the Emacs process and resume it later.
10501 On such systems, Emacs starts a subshell instead of suspending. */)
10503 Lisp_Object stuffstring
;
10505 int count
= SPECPDL_INDEX ();
10506 int old_height
, old_width
;
10508 struct gcpro gcpro1
;
10510 if (!NILP (stuffstring
))
10511 CHECK_STRING (stuffstring
);
10513 /* Run the functions in suspend-hook. */
10514 if (!NILP (Vrun_hooks
))
10515 call1 (Vrun_hooks
, intern ("suspend-hook"));
10517 GCPRO1 (stuffstring
);
10518 get_frame_size (&old_width
, &old_height
);
10519 reset_sys_modes ();
10520 /* sys_suspend can get an error if it tries to fork a subshell
10521 and the system resources aren't available for that. */
10522 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10524 stuff_buffered_input (stuffstring
);
10525 if (cannot_suspend
)
10529 unbind_to (count
, Qnil
);
10531 /* Check if terminal/window size has changed.
10532 Note that this is not useful when we are running directly
10533 with a window system; but suspend should be disabled in that case. */
10534 get_frame_size (&width
, &height
);
10535 if (width
!= old_width
|| height
!= old_height
)
10536 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10538 /* Run suspend-resume-hook. */
10539 if (!NILP (Vrun_hooks
))
10540 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10546 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10547 Then in any case stuff anything Emacs has read ahead and not used. */
10550 stuff_buffered_input (stuffstring
)
10551 Lisp_Object stuffstring
;
10553 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10554 register unsigned char *p
;
10556 if (STRINGP (stuffstring
))
10558 register int count
;
10560 p
= SDATA (stuffstring
);
10561 count
= SBYTES (stuffstring
);
10562 while (count
-- > 0)
10567 /* Anything we have read ahead, put back for the shell to read. */
10568 /* ?? What should this do when we have multiple keyboards??
10569 Should we ignore anything that was typed in at the "wrong" kboard?
10571 rms: we should stuff everything back into the kboard
10573 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10576 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10577 kbd_fetch_ptr
= kbd_buffer
;
10578 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10579 stuff_char (kbd_fetch_ptr
->code
);
10581 clear_event (kbd_fetch_ptr
);
10585 #endif /* SIGTSTP */
10589 set_waiting_for_input (time_to_clear
)
10590 EMACS_TIME
*time_to_clear
;
10592 input_available_clear_time
= time_to_clear
;
10594 /* Tell interrupt_signal to throw back to read_char, */
10595 waiting_for_input
= 1;
10597 /* If interrupt_signal was called before and buffered a C-g,
10598 make it run again now, to avoid timing error. */
10599 if (!NILP (Vquit_flag
))
10600 quit_throw_to_read_char ();
10604 clear_waiting_for_input ()
10606 /* Tell interrupt_signal not to throw back to read_char, */
10607 waiting_for_input
= 0;
10608 input_available_clear_time
= 0;
10611 /* This routine is called at interrupt level in response to C-g.
10613 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10614 is called from kbd_buffer_store_event, in handling SIGIO or
10617 If `waiting_for_input' is non zero, then unless `echoing' is
10618 nonzero, immediately throw back to read_char.
10620 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10621 eval to throw, when it gets a chance. If quit-flag is already
10622 non-nil, it stops the job right away. */
10625 interrupt_signal (signalnum
) /* If we don't have an argument, */
10626 int signalnum
; /* some compilers complain in signal calls. */
10629 /* Must preserve main program's value of errno. */
10630 int old_errno
= errno
;
10631 struct frame
*sf
= SELECTED_FRAME ();
10633 #if defined (USG) && !defined (POSIX_SIGNALS)
10634 if (!read_socket_hook
&& NILP (Vwindow_system
))
10636 /* USG systems forget handlers when they are used;
10637 must reestablish each time */
10638 signal (SIGINT
, interrupt_signal
);
10639 signal (SIGQUIT
, interrupt_signal
);
10643 SIGNAL_THREAD_CHECK (signalnum
);
10646 if (!NILP (Vquit_flag
)
10647 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10649 /* If SIGINT isn't blocked, don't let us be interrupted by
10650 another SIGINT, it might be harmful due to non-reentrancy
10651 in I/O functions. */
10652 sigblock (sigmask (SIGINT
));
10655 reset_sys_modes ();
10657 #ifdef SIGTSTP /* Support possible in later USG versions */
10659 * On systems which can suspend the current process and return to the original
10660 * shell, this command causes the user to end up back at the shell.
10661 * The "Auto-save" and "Abort" questions are not asked until
10662 * the user elects to return to emacs, at which point he can save the current
10663 * job and either dump core or continue.
10668 if (sys_suspend () == -1)
10670 printf ("Not running as a subprocess;\n");
10671 printf ("you can continue or abort.\n");
10673 #else /* not VMS */
10674 /* Perhaps should really fork an inferior shell?
10675 But that would not provide any way to get back
10676 to the original shell, ever. */
10677 printf ("No support for stopping a process on this operating system;\n");
10678 printf ("you can continue or abort.\n");
10679 #endif /* not VMS */
10680 #endif /* not SIGTSTP */
10682 /* We must remain inside the screen area when the internal terminal
10683 is used. Note that [Enter] is not echoed by dos. */
10686 /* It doesn't work to autosave while GC is in progress;
10687 the code used for auto-saving doesn't cope with the mark bit. */
10688 if (!gc_in_progress
)
10690 printf ("Auto-save? (y or n) ");
10692 if (((c
= getchar ()) & ~040) == 'Y')
10694 Fdo_auto_save (Qt
, Qnil
);
10696 printf ("\r\nAuto-save done");
10697 #else /* not MSDOS */
10698 printf ("Auto-save done\n");
10699 #endif /* not MSDOS */
10701 while (c
!= '\n') c
= getchar ();
10705 /* During GC, it must be safe to reenable quitting again. */
10706 Vinhibit_quit
= Qnil
;
10709 #endif /* not MSDOS */
10710 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10711 printf ("but will instead do a real quit after garbage collection ends\r\n");
10716 printf ("\r\nAbort? (y or n) ");
10717 #else /* not MSDOS */
10719 printf ("Abort (and enter debugger)? (y or n) ");
10720 #else /* not VMS */
10721 printf ("Abort (and dump core)? (y or n) ");
10722 #endif /* not VMS */
10723 #endif /* not MSDOS */
10725 if (((c
= getchar ()) & ~040) == 'Y')
10727 while (c
!= '\n') c
= getchar ();
10729 printf ("\r\nContinuing...\r\n");
10730 #else /* not MSDOS */
10731 printf ("Continuing...\n");
10732 #endif /* not MSDOS */
10739 /* If executing a function that wants to be interrupted out of
10740 and the user has not deferred quitting by binding `inhibit-quit'
10741 then quit right away. */
10742 if (immediate_quit
&& NILP (Vinhibit_quit
))
10744 struct gl_state_s saved
;
10745 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10747 immediate_quit
= 0;
10750 GCPRO4 (saved
.object
, saved
.global_code
,
10751 saved
.current_syntax_table
, saved
.old_prop
);
10752 Fsignal (Qquit
, Qnil
);
10757 /* Else request quit when it's safe */
10761 if (waiting_for_input
&& !echoing
)
10762 quit_throw_to_read_char ();
10767 /* Handle a C-g by making read_char return C-g. */
10770 quit_throw_to_read_char ()
10773 /* Prevent another signal from doing this before we finish. */
10774 clear_waiting_for_input ();
10777 Vunread_command_events
= Qnil
;
10778 unread_command_char
= -1;
10780 #if 0 /* Currently, sit_for is called from read_char without turning
10781 off polling. And that can call set_waiting_for_input.
10782 It seems to be harmless. */
10783 #ifdef POLL_FOR_INPUT
10784 /* May be > 1 if in recursive minibuffer. */
10785 if (poll_suppress_count
== 0)
10789 if (FRAMEP (internal_last_event_frame
)
10790 && !EQ (internal_last_event_frame
, selected_frame
))
10791 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10794 _longjmp (getcjmp
, 1);
10797 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10798 doc
: /* Set mode of reading keyboard input.
10799 First arg INTERRUPT non-nil means use input interrupts;
10800 nil means use CBREAK mode.
10801 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10802 (no effect except in CBREAK mode).
10803 Third arg META t means accept 8-bit input (for a Meta key).
10804 META nil means ignore the top bit, on the assumption it is parity.
10805 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10806 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10807 See also `current-input-mode'. */)
10808 (interrupt
, flow
, meta
, quit
)
10809 Lisp_Object interrupt
, flow
, meta
, quit
;
10812 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10813 error ("set-input-mode: QUIT must be an ASCII character");
10815 #ifdef POLL_FOR_INPUT
10820 /* this causes startup screen to be restored and messes with the mouse */
10821 reset_sys_modes ();
10825 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10826 if (read_socket_hook
)
10828 /* When using X, don't give the user a real choice,
10829 because we haven't implemented the mechanisms to support it. */
10830 #ifdef NO_SOCK_SIGIO
10831 interrupt_input
= 0;
10832 #else /* not NO_SOCK_SIGIO */
10833 interrupt_input
= 1;
10834 #endif /* NO_SOCK_SIGIO */
10837 interrupt_input
= !NILP (interrupt
);
10838 #else /* not SIGIO */
10839 interrupt_input
= 0;
10840 #endif /* not SIGIO */
10842 /* Our VMS input only works by interrupts, as of now. */
10844 interrupt_input
= 1;
10847 flow_control
= !NILP (flow
);
10850 else if (EQ (meta
, Qt
))
10855 /* Don't let this value be out of range. */
10856 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10862 #ifdef POLL_FOR_INPUT
10863 poll_suppress_count
= 1;
10869 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10870 doc
: /* Return information about the way Emacs currently reads keyboard input.
10871 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10872 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10873 nil, Emacs is using CBREAK mode.
10874 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10875 terminal; this does not apply if Emacs uses interrupt-driven input.
10876 META is t if accepting 8-bit input with 8th bit as Meta flag.
10877 META nil means ignoring the top bit, on the assumption it is parity.
10878 META is neither t nor nil if accepting 8-bit input and using
10879 all 8 bits as the character code.
10880 QUIT is the character Emacs currently uses to quit.
10881 The elements of this list correspond to the arguments of
10882 `set-input-mode'. */)
10885 Lisp_Object val
[4];
10887 val
[0] = interrupt_input
? Qt
: Qnil
;
10888 val
[1] = flow_control
? Qt
: Qnil
;
10889 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10890 XSETFASTINT (val
[3], quit_char
);
10892 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10895 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10896 doc
: /* Return position information for pixel coordinates X and Y.
10897 By default, X and Y are relative to text area of the selected window.
10898 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10899 If optional fourth arg WHOLE is non-nil, X is relative to the left
10900 edge of the window.
10902 The return value is similar to a mouse click position:
10903 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10904 IMAGE (DX . DY) (WIDTH . HEIGHT))
10905 The `posn-' functions access elements of such lists. */)
10906 (x
, y
, frame_or_window
, whole
)
10907 Lisp_Object x
, y
, frame_or_window
, whole
;
10912 if (NILP (frame_or_window
))
10913 frame_or_window
= selected_window
;
10915 if (WINDOWP (frame_or_window
))
10919 CHECK_LIVE_WINDOW (frame_or_window
);
10921 w
= XWINDOW (frame_or_window
);
10922 XSETINT (x
, (XINT (x
)
10923 + WINDOW_LEFT_EDGE_X (w
)
10925 ? window_box_left_offset (w
, TEXT_AREA
)
10927 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10928 frame_or_window
= w
->frame
;
10931 CHECK_LIVE_FRAME (frame_or_window
);
10933 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10936 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10937 doc
: /* Return position information for buffer POS in WINDOW.
10938 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10940 Return nil if position is not visible in window. Otherwise,
10941 the return value is similar to that returned by `event-start' for
10942 a mouse click at the upper left corner of the glyph corresponding
10943 to the given buffer position:
10944 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10945 IMAGE (DX . DY) (WIDTH . HEIGHT))
10946 The `posn-' functions access elements of such lists. */)
10948 Lisp_Object pos
, window
;
10953 window
= selected_window
;
10955 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10958 Lisp_Object x
= XCAR (tem
);
10959 Lisp_Object y
= XCAR (XCDR (tem
));
10961 /* Point invisible due to hscrolling? */
10964 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10972 * Set up a new kboard object with reasonable initial values.
10978 kb
->Voverriding_terminal_local_map
= Qnil
;
10979 kb
->Vlast_command
= Qnil
;
10980 kb
->Vreal_last_command
= Qnil
;
10981 kb
->Vlast_repeatable_command
= Qnil
;
10982 kb
->Vprefix_arg
= Qnil
;
10983 kb
->Vlast_prefix_arg
= Qnil
;
10984 kb
->kbd_queue
= Qnil
;
10985 kb
->kbd_queue_has_data
= 0;
10986 kb
->immediate_echo
= 0;
10987 kb
->echo_string
= Qnil
;
10988 kb
->echo_after_prompt
= -1;
10989 kb
->kbd_macro_buffer
= 0;
10990 kb
->kbd_macro_bufsize
= 0;
10991 kb
->defining_kbd_macro
= Qnil
;
10992 kb
->Vlast_kbd_macro
= Qnil
;
10993 kb
->reference_count
= 0;
10994 kb
->Vsystem_key_alist
= Qnil
;
10995 kb
->system_key_syms
= Qnil
;
10996 kb
->Vdefault_minibuffer_frame
= Qnil
;
11000 * Destroy the contents of a kboard object, but not the object itself.
11001 * We use this just before deleting it, or if we're going to initialize
11002 * it a second time.
11008 if (kb
->kbd_macro_buffer
)
11009 xfree (kb
->kbd_macro_buffer
);
11012 #ifdef MULTI_KBOARD
11014 /* Free KB and memory referenced from it. */
11022 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11025 *kbp
= kb
->next_kboard
;
11027 /* Prevent a dangling reference to KB. */
11028 if (kb
== current_kboard
11029 && FRAMEP (selected_frame
)
11030 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11032 current_kboard
= XFRAME (selected_frame
)->kboard
;
11033 if (current_kboard
== kb
)
11041 #endif /* MULTI_KBOARD */
11046 /* This is correct before outermost invocation of the editor loop */
11047 command_loop_level
= -1;
11048 immediate_quit
= 0;
11049 quit_char
= Ctl ('g');
11050 Vunread_command_events
= Qnil
;
11051 unread_command_char
= -1;
11052 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11054 recent_keys_index
= 0;
11055 kbd_fetch_ptr
= kbd_buffer
;
11056 kbd_store_ptr
= kbd_buffer
;
11058 do_mouse_tracking
= Qnil
;
11061 interrupt_input_blocked
= 0;
11062 interrupt_input_pending
= 0;
11064 /* This means that command_loop_1 won't try to select anything the first
11066 internal_last_event_frame
= Qnil
;
11067 Vlast_event_frame
= internal_last_event_frame
;
11069 #ifdef MULTI_KBOARD
11070 current_kboard
= initial_kboard
;
11072 wipe_kboard (current_kboard
);
11073 init_kboard (current_kboard
);
11075 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
11077 signal (SIGINT
, interrupt_signal
);
11078 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11079 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11080 SIGQUIT and we can't tell which one it will give us. */
11081 signal (SIGQUIT
, interrupt_signal
);
11082 #endif /* HAVE_TERMIO */
11084 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11086 if (!noninteractive
)
11087 signal (SIGIO
, input_available_signal
);
11090 /* Use interrupt input by default, if it works and noninterrupt input
11091 has deficiencies. */
11093 #ifdef INTERRUPT_INPUT
11094 interrupt_input
= 1;
11096 interrupt_input
= 0;
11099 /* Our VMS input only works by interrupts, as of now. */
11101 interrupt_input
= 1;
11107 if (keyboard_init_hook
)
11108 (*keyboard_init_hook
) ();
11110 #ifdef POLL_FOR_INPUT
11111 poll_suppress_count
= 1;
11116 /* This type's only use is in syms_of_keyboard, to initialize the
11117 event header symbols and put properties on them. */
11118 struct event_head
{
11124 struct event_head head_table
[] = {
11125 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11126 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11127 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11128 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11129 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11130 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11131 /* `select-window' should be handled just like `switch-frame'
11132 in read_key_sequence. */
11133 {&Qselect_window
, "select-window", &Qswitch_frame
}
11137 syms_of_keyboard ()
11139 Vpre_help_message
= Qnil
;
11140 staticpro (&Vpre_help_message
);
11142 Vlispy_mouse_stem
= build_string ("mouse");
11143 staticpro (&Vlispy_mouse_stem
);
11146 QCimage
= intern (":image");
11147 staticpro (&QCimage
);
11149 staticpro (&Qhelp_echo
);
11150 Qhelp_echo
= intern ("help-echo");
11153 Qrtl
= intern (":rtl");
11155 staticpro (&item_properties
);
11156 item_properties
= Qnil
;
11158 staticpro (&tool_bar_item_properties
);
11159 tool_bar_item_properties
= Qnil
;
11160 staticpro (&tool_bar_items_vector
);
11161 tool_bar_items_vector
= Qnil
;
11163 staticpro (&real_this_command
);
11164 real_this_command
= Qnil
;
11166 Qtimer_event_handler
= intern ("timer-event-handler");
11167 staticpro (&Qtimer_event_handler
);
11169 Qdisabled_command_function
= intern ("disabled-command-function");
11170 staticpro (&Qdisabled_command_function
);
11172 Qself_insert_command
= intern ("self-insert-command");
11173 staticpro (&Qself_insert_command
);
11175 Qforward_char
= intern ("forward-char");
11176 staticpro (&Qforward_char
);
11178 Qbackward_char
= intern ("backward-char");
11179 staticpro (&Qbackward_char
);
11181 Qdisabled
= intern ("disabled");
11182 staticpro (&Qdisabled
);
11184 Qundefined
= intern ("undefined");
11185 staticpro (&Qundefined
);
11187 Qpre_command_hook
= intern ("pre-command-hook");
11188 staticpro (&Qpre_command_hook
);
11190 Qpost_command_hook
= intern ("post-command-hook");
11191 staticpro (&Qpost_command_hook
);
11193 Qdeferred_action_function
= intern ("deferred-action-function");
11194 staticpro (&Qdeferred_action_function
);
11196 Qcommand_hook_internal
= intern ("command-hook-internal");
11197 staticpro (&Qcommand_hook_internal
);
11199 Qfunction_key
= intern ("function-key");
11200 staticpro (&Qfunction_key
);
11201 Qmouse_click
= intern ("mouse-click");
11202 staticpro (&Qmouse_click
);
11203 #if defined (WINDOWSNT) || defined (MAC_OS)
11204 Qlanguage_change
= intern ("language-change");
11205 staticpro (&Qlanguage_change
);
11207 Qdrag_n_drop
= intern ("drag-n-drop");
11208 staticpro (&Qdrag_n_drop
);
11210 Qsave_session
= intern ("save-session");
11211 staticpro (&Qsave_session
);
11214 Qmac_apple_event
= intern ("mac-apple-event");
11215 staticpro (&Qmac_apple_event
);
11218 Qmenu_enable
= intern ("menu-enable");
11219 staticpro (&Qmenu_enable
);
11220 Qmenu_alias
= intern ("menu-alias");
11221 staticpro (&Qmenu_alias
);
11222 QCenable
= intern (":enable");
11223 staticpro (&QCenable
);
11224 QCvisible
= intern (":visible");
11225 staticpro (&QCvisible
);
11226 QChelp
= intern (":help");
11227 staticpro (&QChelp
);
11228 QCfilter
= intern (":filter");
11229 staticpro (&QCfilter
);
11230 QCbutton
= intern (":button");
11231 staticpro (&QCbutton
);
11232 QCkeys
= intern (":keys");
11233 staticpro (&QCkeys
);
11234 QCkey_sequence
= intern (":key-sequence");
11235 staticpro (&QCkey_sequence
);
11236 QCtoggle
= intern (":toggle");
11237 staticpro (&QCtoggle
);
11238 QCradio
= intern (":radio");
11239 staticpro (&QCradio
);
11241 Qmode_line
= intern ("mode-line");
11242 staticpro (&Qmode_line
);
11243 Qvertical_line
= intern ("vertical-line");
11244 staticpro (&Qvertical_line
);
11245 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11246 staticpro (&Qvertical_scroll_bar
);
11247 Qmenu_bar
= intern ("menu-bar");
11248 staticpro (&Qmenu_bar
);
11251 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11252 staticpro (&Qmouse_fixup_help_message
);
11255 Qabove_handle
= intern ("above-handle");
11256 staticpro (&Qabove_handle
);
11257 Qhandle
= intern ("handle");
11258 staticpro (&Qhandle
);
11259 Qbelow_handle
= intern ("below-handle");
11260 staticpro (&Qbelow_handle
);
11261 Qup
= intern ("up");
11263 Qdown
= intern ("down");
11264 staticpro (&Qdown
);
11265 Qtop
= intern ("top");
11267 Qbottom
= intern ("bottom");
11268 staticpro (&Qbottom
);
11269 Qend_scroll
= intern ("end-scroll");
11270 staticpro (&Qend_scroll
);
11271 Qratio
= intern ("ratio");
11272 staticpro (&Qratio
);
11274 Qevent_kind
= intern ("event-kind");
11275 staticpro (&Qevent_kind
);
11276 Qevent_symbol_elements
= intern ("event-symbol-elements");
11277 staticpro (&Qevent_symbol_elements
);
11278 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11279 staticpro (&Qevent_symbol_element_mask
);
11280 Qmodifier_cache
= intern ("modifier-cache");
11281 staticpro (&Qmodifier_cache
);
11283 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11284 staticpro (&Qrecompute_lucid_menubar
);
11285 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11286 staticpro (&Qactivate_menubar_hook
);
11288 Qpolling_period
= intern ("polling-period");
11289 staticpro (&Qpolling_period
);
11291 Qinput_method_function
= intern ("input-method-function");
11292 staticpro (&Qinput_method_function
);
11294 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11295 staticpro (&Qinput_method_exit_on_first_char
);
11296 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11297 staticpro (&Qinput_method_use_echo_area
);
11299 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11300 Fset (Qinput_method_use_echo_area
, Qnil
);
11302 last_point_position_buffer
= Qnil
;
11303 last_point_position_window
= Qnil
;
11306 struct event_head
*p
;
11308 for (p
= head_table
;
11309 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11312 *p
->var
= intern (p
->name
);
11313 staticpro (p
->var
);
11314 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11315 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11319 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11320 staticpro (&button_down_location
);
11321 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11322 staticpro (&mouse_syms
);
11323 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11324 staticpro (&wheel_syms
);
11328 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11330 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11331 for (i
= 0; i
< len
; i
++)
11332 if (modifier_names
[i
])
11333 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11334 staticpro (&modifier_symbols
);
11337 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11338 staticpro (&recent_keys
);
11340 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11341 staticpro (&this_command_keys
);
11343 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11344 staticpro (&raw_keybuf
);
11346 Qextended_command_history
= intern ("extended-command-history");
11347 Fset (Qextended_command_history
, Qnil
);
11348 staticpro (&Qextended_command_history
);
11350 accent_key_syms
= Qnil
;
11351 staticpro (&accent_key_syms
);
11353 func_key_syms
= Qnil
;
11354 staticpro (&func_key_syms
);
11356 drag_n_drop_syms
= Qnil
;
11357 staticpro (&drag_n_drop_syms
);
11359 unread_switch_frame
= Qnil
;
11360 staticpro (&unread_switch_frame
);
11362 internal_last_event_frame
= Qnil
;
11363 staticpro (&internal_last_event_frame
);
11365 read_key_sequence_cmd
= Qnil
;
11366 staticpro (&read_key_sequence_cmd
);
11368 menu_bar_one_keymap_changed_items
= Qnil
;
11369 staticpro (&menu_bar_one_keymap_changed_items
);
11371 menu_bar_items_vector
= Qnil
;
11372 staticpro (&menu_bar_items_vector
);
11374 help_form_saved_window_configs
= Qnil
;
11375 staticpro (&help_form_saved_window_configs
);
11377 defsubr (&Scurrent_idle_time
);
11378 defsubr (&Sevent_convert_list
);
11379 defsubr (&Sread_key_sequence
);
11380 defsubr (&Sread_key_sequence_vector
);
11381 defsubr (&Srecursive_edit
);
11383 defsubr (&Strack_mouse
);
11385 defsubr (&Sinput_pending_p
);
11386 defsubr (&Scommand_execute
);
11387 defsubr (&Srecent_keys
);
11388 defsubr (&Sthis_command_keys
);
11389 defsubr (&Sthis_command_keys_vector
);
11390 defsubr (&Sthis_single_command_keys
);
11391 defsubr (&Sthis_single_command_raw_keys
);
11392 defsubr (&Sreset_this_command_lengths
);
11393 defsubr (&Sclear_this_command_keys
);
11394 defsubr (&Ssuspend_emacs
);
11395 defsubr (&Sabort_recursive_edit
);
11396 defsubr (&Sexit_recursive_edit
);
11397 defsubr (&Srecursion_depth
);
11398 defsubr (&Stop_level
);
11399 defsubr (&Sdiscard_input
);
11400 defsubr (&Sopen_dribble_file
);
11401 defsubr (&Sset_input_mode
);
11402 defsubr (&Scurrent_input_mode
);
11403 defsubr (&Sexecute_extended_command
);
11404 defsubr (&Sposn_at_point
);
11405 defsubr (&Sposn_at_x_y
);
11407 DEFVAR_LISP ("last-command-char", &last_command_char
,
11408 doc
: /* Last input event that was part of a command. */);
11410 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11411 doc
: /* Last input event that was part of a command. */);
11413 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11414 doc
: /* Last input event in a command, except for mouse menu events.
11415 Mouse menus give back keys that don't look like mouse events;
11416 this variable holds the actual mouse event that led to the menu,
11417 so that you can determine whether the command was run by mouse or not. */);
11419 DEFVAR_LISP ("last-input-char", &last_input_char
,
11420 doc
: /* Last input event. */);
11422 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11423 doc
: /* Last input event. */);
11425 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11426 doc
: /* List of events to be read as the command input.
11427 These events are processed first, before actual keyboard input.
11428 Events read from this list are not normally added to `this-command-keys',
11429 as they will already have been added once as they were read for the first time.
11430 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11431 Vunread_command_events
= Qnil
;
11433 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11434 doc
: /* If not -1, an object to be read as next command input event. */);
11436 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11437 doc
: /* List of events to be processed as input by input methods.
11438 These events are processed before `unread-command-events'
11439 and actual keyboard input, but are not given to `input-method-function'. */);
11440 Vunread_post_input_method_events
= Qnil
;
11442 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11443 doc
: /* List of events to be processed as input by input methods.
11444 These events are processed after `unread-command-events', but
11445 before actual keyboard input.
11446 If there's an active input method, the events are given to
11447 `input-method-function'. */);
11448 Vunread_input_method_events
= Qnil
;
11450 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11451 doc
: /* Meta-prefix character code.
11452 Meta-foo as command input turns into this character followed by foo. */);
11453 XSETINT (meta_prefix_char
, 033);
11455 DEFVAR_KBOARD ("last-command", Vlast_command
,
11456 doc
: /* The last command executed.
11457 Normally a symbol with a function definition, but can be whatever was found
11458 in the keymap, or whatever the variable `this-command' was set to by that
11461 The value `mode-exit' is special; it means that the previous command
11462 read an event that told it to exit, and it did so and unread that event.
11463 In other words, the present command is the event that made the previous
11466 The value `kill-region' is special; it means that the previous command
11467 was a kill command. */);
11469 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11470 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11472 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11473 doc
: /* Last command that may be repeated.
11474 The last command executed that was not bound to an input event.
11475 This is the command `repeat' will try to repeat. */);
11477 DEFVAR_LISP ("this-command", &Vthis_command
,
11478 doc
: /* The command now being executed.
11479 The command can set this variable; whatever is put here
11480 will be in `last-command' during the following command. */);
11481 Vthis_command
= Qnil
;
11483 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11484 doc
: /* The command bound to the current key sequence before remapping.
11485 It equals `this-command' if the original command was not remapped through
11486 any of the active keymaps. Otherwise, the value of `this-command' is the
11487 result of looking up the original command in the active keymaps. */);
11488 Vthis_original_command
= Qnil
;
11490 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11491 doc
: /* *Number of input events between auto-saves.
11492 Zero means disable autosaving due to number of characters typed. */);
11493 auto_save_interval
= 300;
11495 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11496 doc
: /* *Number of seconds idle time before auto-save.
11497 Zero or nil means disable auto-saving due to idleness.
11498 After auto-saving due to this many seconds of idle time,
11499 Emacs also does a garbage collection if that seems to be warranted. */);
11500 XSETFASTINT (Vauto_save_timeout
, 30);
11502 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11503 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11504 The value may be integer or floating point. */);
11505 Vecho_keystrokes
= make_number (1);
11507 DEFVAR_INT ("polling-period", &polling_period
,
11508 doc
: /* *Interval between polling for input during Lisp execution.
11509 The reason for polling is to make C-g work to stop a running program.
11510 Polling is needed only when using X windows and SIGIO does not work.
11511 Polling is automatically disabled in all other cases. */);
11512 polling_period
= 2;
11514 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11515 doc
: /* *Maximum time between mouse clicks to make a double-click.
11516 Measured in milliseconds. The value nil means disable double-click
11517 recognition; t means double-clicks have no time limit and are detected
11518 by position only. */);
11519 Vdouble_click_time
= make_number (500);
11521 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11522 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11523 On window-system frames, value is the number of pixels the mouse may have
11524 moved horizontally or vertically between two clicks to make a double-click.
11525 On non window-system frames, value is interpreted in units of 1/8 characters
11528 This variable is also the threshold for motion of the mouse
11529 to count as a drag. */);
11530 double_click_fuzz
= 3;
11532 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11533 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11534 inhibit_local_menu_bar_menus
= 0;
11536 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11537 doc
: /* Number of complete key sequences read as input so far.
11538 This includes key sequences read from keyboard macros.
11539 The number is effectively the number of interactive command invocations. */);
11540 num_input_keys
= 0;
11542 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11543 doc
: /* Number of input events read from the keyboard so far.
11544 This does not include events generated by keyboard macros. */);
11545 num_nonmacro_input_events
= 0;
11547 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11548 doc
: /* The frame in which the most recently read event occurred.
11549 If the last event came from a keyboard macro, this is set to `macro'. */);
11550 Vlast_event_frame
= Qnil
;
11552 /* This variable is set up in sysdep.c. */
11553 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11554 doc
: /* The ERASE character as set by the user with stty. */);
11556 DEFVAR_LISP ("help-char", &Vhelp_char
,
11557 doc
: /* Character to recognize as meaning Help.
11558 When it is read, do `(eval help-form)', and display result if it's a string.
11559 If the value of `help-form' is nil, this char can be read normally. */);
11560 XSETINT (Vhelp_char
, Ctl ('H'));
11562 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11563 doc
: /* List of input events to recognize as meaning Help.
11564 These work just like the value of `help-char' (see that). */);
11565 Vhelp_event_list
= Qnil
;
11567 DEFVAR_LISP ("help-form", &Vhelp_form
,
11568 doc
: /* Form to execute when character `help-char' is read.
11569 If the form returns a string, that string is displayed.
11570 If `help-form' is nil, the help char is not recognized. */);
11573 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11574 doc
: /* Command to run when `help-char' character follows a prefix key.
11575 This command is used only when there is no actual binding
11576 for that character after that prefix key. */);
11577 Vprefix_help_command
= Qnil
;
11579 DEFVAR_LISP ("top-level", &Vtop_level
,
11580 doc
: /* Form to evaluate when Emacs starts up.
11581 Useful to set before you dump a modified Emacs. */);
11584 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11585 doc
: /* Translate table for keyboard input, or nil.
11586 If non-nil, the value should be a char-table. Each character read
11587 from the keyboard is looked up in this char-table. If the value found
11588 there is non-nil, then it is used instead of the actual input character.
11590 The value can also be a string or vector, but this is considered obsolete.
11591 If it is a string or vector of length N, character codes N and up are left
11592 untranslated. In a vector, an element which is nil means "no translation".
11594 This is applied to the characters supplied to input methods, not their
11595 output. See also `translation-table-for-input'. */);
11596 Vkeyboard_translate_table
= Qnil
;
11598 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11599 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11600 \(Even if the operating system has support for stopping a process.\) */);
11601 cannot_suspend
= 0;
11603 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11604 doc
: /* Non-nil means prompt with menus when appropriate.
11605 This is done when reading from a keymap that has a prompt string,
11606 for elements that have prompt strings.
11607 The menu is displayed on the screen
11608 if X menus were enabled at configuration
11609 time and the previous event was a mouse click prefix key.
11610 Otherwise, menu prompting uses the echo area. */);
11611 menu_prompting
= 1;
11613 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11614 doc
: /* Character to see next line of menu prompt.
11615 Type this character while in a menu prompt to rotate around the lines of it. */);
11616 XSETINT (menu_prompt_more_char
, ' ');
11618 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11619 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11620 Emacs applies the modifiers of the character stored here to each keyboard
11621 character it reads. For example, after evaluating the expression
11622 (setq extra-keyboard-modifiers ?\\C-x)
11623 all input characters will have the control modifier applied to them.
11625 Note that the character ?\\C-@, equivalent to the integer zero, does
11626 not count as a control character; rather, it counts as a character
11627 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11628 cancels any modification. */);
11629 extra_keyboard_modifiers
= 0;
11631 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11632 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11633 The command loop sets this to nil before each command,
11634 and tests the value when the command returns.
11635 Buffer modification stores t in this variable. */);
11636 Vdeactivate_mark
= Qnil
;
11638 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11639 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11640 Vcommand_hook_internal
= Qnil
;
11642 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11643 doc
: /* Normal hook run before each command is executed.
11644 If an unhandled error happens in running this hook,
11645 the hook value is set to nil, since otherwise the error
11646 might happen repeatedly and make Emacs nonfunctional. */);
11647 Vpre_command_hook
= Qnil
;
11649 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11650 doc
: /* Normal hook run after each command is executed.
11651 If an unhandled error happens in running this hook,
11652 the hook value is set to nil, since otherwise the error
11653 might happen repeatedly and make Emacs nonfunctional. */);
11654 Vpost_command_hook
= Qnil
;
11657 DEFVAR_LISP ("echo-area-clear-hook", ...,
11658 doc
: /* Normal hook run when clearing the echo area. */);
11660 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11661 staticpro (&Qecho_area_clear_hook
);
11662 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11664 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11665 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11666 Vlucid_menu_bar_dirty_flag
= Qnil
;
11668 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11669 doc
: /* List of menu bar items to move to the end of the menu bar.
11670 The elements of the list are event types that may have menu bar bindings. */);
11671 Vmenu_bar_final_items
= Qnil
;
11673 DEFVAR_KBOARD ("overriding-terminal-local-map",
11674 Voverriding_terminal_local_map
,
11675 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11676 If this variable is non-nil, it is used as a keymap instead of the
11677 buffer's local map, and the minor mode keymaps and text property keymaps.
11678 It also replaces `overriding-local-map'.
11680 This variable is intended to let commands such as `universal-argument'
11681 set up a different keymap for reading the next command. */);
11683 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11684 doc
: /* Keymap that overrides all other local keymaps.
11685 If this variable is non-nil, it is used as a keymap--replacing the
11686 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11687 Voverriding_local_map
= Qnil
;
11689 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11690 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11691 Otherwise, the menu bar continues to reflect the buffer's local map
11692 and the minor mode maps regardless of `overriding-local-map'. */);
11693 Voverriding_local_map_menu_flag
= Qnil
;
11695 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11696 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11697 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11699 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11700 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11702 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11703 doc
: /* Alist of system-specific X windows key symbols.
11704 Each element should have the form (N . SYMBOL) where N is the
11705 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11706 and SYMBOL is its name. */);
11708 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11709 doc
: /* List of deferred actions to be performed at a later time.
11710 The precise format isn't relevant here; we just check whether it is nil. */);
11711 Vdeferred_action_list
= Qnil
;
11713 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11714 doc
: /* Function to call to handle deferred actions, after each command.
11715 This function is called with no arguments after each command
11716 whenever `deferred-action-list' is non-nil. */);
11717 Vdeferred_action_function
= Qnil
;
11719 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11720 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11721 The value can be a length of time to show the message for.
11722 If the value is non-nil and not a number, we wait 2 seconds. */);
11723 Vsuggest_key_bindings
= Qt
;
11725 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11726 doc
: /* List of active absolute time timers in order of increasing time. */);
11727 Vtimer_list
= Qnil
;
11729 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11730 doc
: /* List of active idle-time timers in order of increasing time. */);
11731 Vtimer_idle_list
= Qnil
;
11733 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11734 doc
: /* If non-nil, the function that implements the current input method.
11735 It's called with one argument, a printing character that was just read.
11736 \(That means a character with code 040...0176.)
11737 Typically this function uses `read-event' to read additional events.
11738 When it does so, it should first bind `input-method-function' to nil
11739 so it will not be called recursively.
11741 The function should return a list of zero or more events
11742 to be used as input. If it wants to put back some events
11743 to be reconsidered, separately, by the input method,
11744 it can add them to the beginning of `unread-command-events'.
11746 The input method function can find in `input-method-previous-method'
11747 the previous echo area message.
11749 The input method function should refer to the variables
11750 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11751 for guidance on what to do. */);
11752 Vinput_method_function
= Qnil
;
11754 DEFVAR_LISP ("input-method-previous-message",
11755 &Vinput_method_previous_message
,
11756 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11757 This variable exists because `read-event' clears the echo area
11758 before running the input method. It is nil if there was no message. */);
11759 Vinput_method_previous_message
= Qnil
;
11761 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11762 doc
: /* If non-nil, the function that implements the display of help.
11763 It's called with one argument, the help string to display. */);
11764 Vshow_help_function
= Qnil
;
11766 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11767 doc
: /* If non-nil, suppress point adjustment after executing a command.
11769 After a command is executed, if point is moved into a region that has
11770 special properties (e.g. composition, display), we adjust point to
11771 the boundary of the region. But, when a command sets this variable to
11772 non-nil, we suppress the point adjustment.
11774 This variable is set to nil before reading a command, and is checked
11775 just after executing the command. */);
11776 Vdisable_point_adjustment
= Qnil
;
11778 DEFVAR_LISP ("global-disable-point-adjustment",
11779 &Vglobal_disable_point_adjustment
,
11780 doc
: /* *If non-nil, always suppress point adjustment.
11782 The default value is nil, in which case, point adjustment are
11783 suppressed only after special commands that set
11784 `disable-point-adjustment' (which see) to non-nil. */);
11785 Vglobal_disable_point_adjustment
= Qnil
;
11787 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11788 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11789 If the value is not a number, such messages don't time out. */);
11790 Vminibuffer_message_timeout
= make_number (2);
11792 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11793 doc
: /* If non-nil, any keyboard input throws to this symbol.
11794 The value of that variable is passed to `quit-flag' and later causes a
11795 peculiar kind of quitting. */);
11796 Vthrow_on_input
= Qnil
;
11798 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
11799 doc
: /* If non-nil, function to output error messages.
11800 The arguments are the error data, a list of the form
11801 (SIGNALED-CONDITIONS . SIGNAL-DATA)
11802 such as just as `condition-case' would bind its variable to,
11803 the context (a string which normally goes at the start of the message),
11804 and the Lisp function within which the error was signaled. */);
11805 Vcommand_error_function
= Qnil
;
11807 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11808 &Venable_disabled_menus_and_buttons
,
11809 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11811 Help functions bind this to allow help on disabled menu items
11812 and tool-bar buttons. */);
11813 Venable_disabled_menus_and_buttons
= Qnil
;
11817 keys_of_keyboard ()
11819 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11820 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11821 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11822 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11823 initial_define_key (meta_map
, 'x', "execute-extended-command");
11825 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11826 "handle-delete-frame");
11827 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11828 current-prefix-arg, as is done in `handle-switch-frame'.
11829 But `handle-switch-frame is not run from the special-map.
11830 Commands from that map are run in a special way that automatically
11831 preserves the prefix-arg. Restoring the prefix arg here is not just
11832 redundant but harmful:
11834 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11835 - after the first prompt, the exit-minibuffer-hook is run which may
11836 iconify a frame and thus push a `iconify-frame' event.
11837 - after running exit-minibuffer-hook, current-prefix-arg is
11838 restored to the non-nil value it had before the prompt.
11839 - we enter the second prompt.
11840 current-prefix-arg is non-nil, prefix-arg is nil.
11841 - before running the first real event, we run the special iconify-frame
11842 event, but we pass the `special' arg to execute-command so
11843 current-prefix-arg and prefix-arg are left untouched.
11844 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11845 - the next key event will have a spuriously non-nil current-prefix-arg. */
11846 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11848 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11850 /* Handling it at such a low-level causes read_key_sequence to get
11851 * confused because it doesn't realize that the current_buffer was
11852 * changed by read_char.
11854 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11855 * "handle-select-window"); */
11856 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11857 "handle-save-session");
11860 /* Mark the pointers in the kboard objects.
11861 Called by the Fgarbage_collector. */
11867 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11869 if (kb
->kbd_macro_buffer
)
11870 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11872 mark_object (kb
->Voverriding_terminal_local_map
);
11873 mark_object (kb
->Vlast_command
);
11874 mark_object (kb
->Vreal_last_command
);
11875 mark_object (kb
->Vlast_repeatable_command
);
11876 mark_object (kb
->Vprefix_arg
);
11877 mark_object (kb
->Vlast_prefix_arg
);
11878 mark_object (kb
->kbd_queue
);
11879 mark_object (kb
->defining_kbd_macro
);
11880 mark_object (kb
->Vlast_kbd_macro
);
11881 mark_object (kb
->Vsystem_key_alist
);
11882 mark_object (kb
->system_key_syms
);
11883 mark_object (kb
->Vdefault_minibuffer_frame
);
11884 mark_object (kb
->echo_string
);
11887 struct input_event
*event
;
11888 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11890 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11891 event
= kbd_buffer
;
11892 if (event
->kind
!= SELECTION_REQUEST_EVENT
11893 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11895 mark_object (event
->x
);
11896 mark_object (event
->y
);
11898 mark_object (event
->frame_or_window
);
11899 mark_object (event
->arg
);
11904 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11905 (do not change this comment) */