1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
3 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
29 #include "termhooks.h"
36 #include "character.h"
38 #include "dispextern.h"
40 #include "intervals.h"
42 #include "blockinput.h"
49 #ifdef HAVE_GTK_AND_PTHREAD
57 #include <sys/ioctl.h>
59 #endif /* not MSDOS */
61 #include "syssignal.h"
64 #include <sys/types.h>
73 /* This is to get the definitions of the XK_ symbols. */
80 #endif /* HAVE_NTGUI */
90 /* Variables for blockinput.h: */
92 /* Non-zero if interrupt input is blocked right now. */
93 int interrupt_input_blocked
;
95 /* Nonzero means an input interrupt has arrived
96 during the current critical section. */
97 int interrupt_input_pending
;
100 /* File descriptor to use for input. */
103 #ifdef HAVE_WINDOW_SYSTEM
104 /* Make all keyboard buffers much bigger when using X windows. */
106 /* But not too big (local data > 32K error) if on Mac OS Classic. */
107 #define KBD_BUFFER_SIZE 512
109 #define KBD_BUFFER_SIZE 4096
111 #else /* No X-windows, character input */
112 #define KBD_BUFFER_SIZE 4096
113 #endif /* No X-windows */
115 #define abs(x) ((x) >= 0 ? (x) : -(x))
117 /* Following definition copied from eval.c */
121 struct backtrace
*next
;
122 Lisp_Object
*function
;
123 Lisp_Object
*args
; /* Points to vector of args. */
124 int nargs
; /* length of vector. If nargs is UNEVALLED,
125 args points to slot holding list of
128 /* Nonzero means call value of debugger when done with this operation. */
133 KBOARD
*initial_kboard
;
134 KBOARD
*current_kboard
;
138 KBOARD the_only_kboard
;
141 /* Non-nil disable property on a command means
142 do not execute it; call disabled-command-function's value instead. */
143 Lisp_Object Qdisabled
, Qdisabled_command_function
;
145 #define NUM_RECENT_KEYS (100)
146 int recent_keys_index
; /* Index for storing next element into recent_keys */
147 int total_keys
; /* Total number of elements stored into recent_keys */
148 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
150 /* Vector holding the key sequence that invoked the current command.
151 It is reused for each command, and it may be longer than the current
152 sequence; this_command_key_count indicates how many elements
153 actually mean something.
154 It's easier to staticpro a single Lisp_Object than an array. */
155 Lisp_Object this_command_keys
;
156 int this_command_key_count
;
158 /* 1 after calling Freset_this_command_lengths.
160 int this_command_key_count_reset
;
162 /* This vector is used as a buffer to record the events that were actually read
163 by read_key_sequence. */
164 Lisp_Object raw_keybuf
;
165 int raw_keybuf_count
;
167 #define GROW_RAW_KEYBUF \
168 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
170 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
172 new = Fmake_vector (make_number (newsize), Qnil); \
173 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
174 raw_keybuf_count * sizeof (Lisp_Object)); \
178 /* Number of elements of this_command_keys
179 that precede this key sequence. */
180 int this_single_command_key_start
;
182 /* Record values of this_command_key_count and echo_length ()
183 before this command was read. */
184 static int before_command_key_count
;
185 static int before_command_echo_length
;
187 extern int minbuf_level
;
189 extern int message_enable_multibyte
;
191 extern struct backtrace
*backtrace_list
;
193 /* If non-nil, the function that implements the display of help.
194 It's called with one argument, the help string to display. */
196 Lisp_Object Vshow_help_function
;
198 /* If a string, the message displayed before displaying a help-echo
201 Lisp_Object Vpre_help_message
;
203 /* Nonzero means do menu prompting. */
205 static int menu_prompting
;
207 /* Character to see next line of menu prompt. */
209 static Lisp_Object menu_prompt_more_char
;
211 /* For longjmp to where kbd input is being done. */
213 static jmp_buf getcjmp
;
215 /* True while doing kbd input. */
216 int waiting_for_input
;
218 /* True while displaying for echoing. Delays C-g throwing. */
222 /* Non-null means we can start echoing at the next input pause even
223 though there is something in the echo area. */
225 static struct kboard
*ok_to_echo_at_next_pause
;
227 /* The kboard last echoing, or null for none. Reset to 0 in
228 cancel_echoing. If non-null, and a current echo area message
229 exists, and echo_message_buffer is eq to the current message
230 buffer, we know that the message comes from echo_kboard. */
232 struct kboard
*echo_kboard
;
234 /* The buffer used for echoing. Set in echo_now, reset in
237 Lisp_Object echo_message_buffer
;
239 /* Nonzero means disregard local maps for the menu bar. */
240 static int inhibit_local_menu_bar_menus
;
242 /* Nonzero means C-g should cause immediate error-signal. */
245 /* The user's hook function for outputting an error message. */
246 Lisp_Object Vcommand_error_function
;
248 /* The user's ERASE setting. */
249 Lisp_Object Vtty_erase_char
;
251 /* Character to recognize as the help char. */
252 Lisp_Object Vhelp_char
;
254 /* List of other event types to recognize as meaning "help". */
255 Lisp_Object Vhelp_event_list
;
257 /* Form to execute when help char is typed. */
258 Lisp_Object Vhelp_form
;
260 /* Command to run when the help character follows a prefix key. */
261 Lisp_Object Vprefix_help_command
;
263 /* List of items that should move to the end of the menu bar. */
264 Lisp_Object Vmenu_bar_final_items
;
266 /* Non-nil means show the equivalent key-binding for
267 any M-x command that has one.
268 The value can be a length of time to show the message for.
269 If the value is non-nil and not a number, we wait 2 seconds. */
270 Lisp_Object Vsuggest_key_bindings
;
272 /* How long to display an echo-area message when the minibuffer is active.
273 If the value is not a number, such messages don't time out. */
274 Lisp_Object Vminibuffer_message_timeout
;
276 /* Character that causes a quit. Normally C-g.
278 If we are running on an ordinary terminal, this must be an ordinary
279 ASCII char, since we want to make it our interrupt character.
281 If we are not running on an ordinary terminal, it still needs to be
282 an ordinary ASCII char. This character needs to be recognized in
283 the input interrupt handler. At this point, the keystroke is
284 represented as a struct input_event, while the desired quit
285 character is specified as a lispy event. The mapping from struct
286 input_events to lispy events cannot run in an interrupt handler,
287 and the reverse mapping is difficult for anything but ASCII
290 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
294 extern Lisp_Object current_global_map
;
295 extern int minibuf_level
;
297 /* If non-nil, this is a map that overrides all other local maps. */
298 Lisp_Object Voverriding_local_map
;
300 /* If non-nil, Voverriding_local_map applies to the menu bar. */
301 Lisp_Object Voverriding_local_map_menu_flag
;
303 /* Keymap that defines special misc events that should
304 be processed immediately at a low level. */
305 Lisp_Object Vspecial_event_map
;
307 /* Current depth in recursive edits. */
308 int command_loop_level
;
310 /* Total number of times command_loop has read a key sequence. */
311 EMACS_INT num_input_keys
;
313 /* Last input character read as a command. */
314 Lisp_Object last_command_char
;
316 /* Last input character read as a command, not counting menus
317 reached by the mouse. */
318 Lisp_Object last_nonmenu_event
;
320 /* Last input character read for any purpose. */
321 Lisp_Object last_input_char
;
323 /* If not Qnil, a list of objects to be read as subsequent command input. */
324 Lisp_Object Vunread_command_events
;
326 /* If not Qnil, a list of objects to be read as subsequent command input
327 including input method processing. */
328 Lisp_Object Vunread_input_method_events
;
330 /* If not Qnil, a list of objects to be read as subsequent command input
331 but NOT including input method processing. */
332 Lisp_Object Vunread_post_input_method_events
;
334 /* If not -1, an event to be read as subsequent command input. */
335 EMACS_INT unread_command_char
;
337 /* If not Qnil, this is a switch-frame event which we decided to put
338 off until the end of a key sequence. This should be read as the
339 next command input, after any unread_command_events.
341 read_key_sequence uses this to delay switch-frame events until the
342 end of the key sequence; Fread_char uses it to put off switch-frame
343 events until a non-ASCII event is acceptable as input. */
344 Lisp_Object unread_switch_frame
;
346 /* A mask of extra modifier bits to put into every keyboard char. */
347 EMACS_INT extra_keyboard_modifiers
;
349 /* Char to use as prefix when a meta character is typed in.
350 This is bound on entry to minibuffer in case ESC is changed there. */
352 Lisp_Object meta_prefix_char
;
354 /* Last size recorded for a current buffer which is not a minibuffer. */
355 static int last_non_minibuf_size
;
357 /* Number of idle seconds before an auto-save and garbage collection. */
358 static Lisp_Object Vauto_save_timeout
;
360 /* Total number of times read_char has returned. */
361 int num_input_events
;
363 /* Total number of times read_char has returned, outside of macros. */
364 EMACS_INT num_nonmacro_input_events
;
366 /* Auto-save automatically when this many characters have been typed
367 since the last time. */
369 static EMACS_INT auto_save_interval
;
371 /* Value of num_nonmacro_input_events as of last auto save. */
375 /* The command being executed by the command loop.
376 Commands may set this, and the value set will be copied into
377 current_kboard->Vlast_command instead of the actual command. */
378 Lisp_Object Vthis_command
;
380 /* This is like Vthis_command, except that commands never set it. */
381 Lisp_Object real_this_command
;
383 /* If the lookup of the command returns a binding, the original
384 command is stored in this-original-command. It is nil otherwise. */
385 Lisp_Object Vthis_original_command
;
387 /* The value of point when the last command was started. */
388 int last_point_position
;
390 /* The buffer that was current when the last command was started. */
391 Lisp_Object last_point_position_buffer
;
393 /* The window that was selected when the last command was started. */
394 Lisp_Object last_point_position_window
;
396 /* The frame in which the last input event occurred, or Qmacro if the
397 last event came from a macro. We use this to determine when to
398 generate switch-frame events. This may be cleared by functions
399 like Fselect_frame, to make sure that a switch-frame event is
400 generated by the next character. */
401 Lisp_Object internal_last_event_frame
;
403 /* A user-visible version of the above, intended to allow users to
404 figure out where the last event came from, if the event doesn't
405 carry that information itself (i.e. if it was a character). */
406 Lisp_Object Vlast_event_frame
;
408 /* The timestamp of the last input event we received from the X server.
409 X Windows wants this for selection ownership. */
410 unsigned long last_event_timestamp
;
412 Lisp_Object Qself_insert_command
;
413 Lisp_Object Qforward_char
;
414 Lisp_Object Qbackward_char
;
415 Lisp_Object Qundefined
;
416 Lisp_Object Qtimer_event_handler
;
418 /* read_key_sequence stores here the command definition of the
419 key sequence that it reads. */
420 Lisp_Object read_key_sequence_cmd
;
422 /* Echo unfinished commands after this many seconds of pause. */
423 Lisp_Object Vecho_keystrokes
;
425 /* Form to evaluate (if non-nil) when Emacs is started. */
426 Lisp_Object Vtop_level
;
428 /* User-supplied table to translate input characters. */
429 Lisp_Object Vkeyboard_translate_table
;
431 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
432 extern Lisp_Object Vfunction_key_map
;
434 /* Another keymap that maps key sequences into key sequences.
435 This one takes precedence over ordinary definitions. */
436 extern Lisp_Object Vkey_translation_map
;
438 /* If non-nil, this implements the current input method. */
439 Lisp_Object Vinput_method_function
;
440 Lisp_Object Qinput_method_function
;
442 /* When we call Vinput_method_function,
443 this holds the echo area message that was just erased. */
444 Lisp_Object Vinput_method_previous_message
;
446 /* Non-nil means deactivate the mark at end of this command. */
447 Lisp_Object Vdeactivate_mark
;
449 /* Menu bar specified in Lucid Emacs fashion. */
451 Lisp_Object Vlucid_menu_bar_dirty_flag
;
452 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
454 Lisp_Object Qecho_area_clear_hook
;
456 /* Hooks to run before and after each command. */
457 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
458 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
459 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
461 /* List of deferred actions to be performed at a later time.
462 The precise format isn't relevant here; we just check whether it is nil. */
463 Lisp_Object Vdeferred_action_list
;
465 /* Function to call to handle deferred actions, when there are any. */
466 Lisp_Object Vdeferred_action_function
;
467 Lisp_Object Qdeferred_action_function
;
469 Lisp_Object Qinput_method_exit_on_first_char
;
470 Lisp_Object Qinput_method_use_echo_area
;
472 /* File in which we write all commands we read. */
475 /* Nonzero if input is available. */
478 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
479 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
483 extern char *pending_malloc_warning
;
485 /* Circular buffer for pre-read keyboard input. */
487 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
489 /* Pointer to next available character in kbd_buffer.
490 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
491 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
492 next available char is in kbd_buffer[0]. */
493 static struct input_event
*kbd_fetch_ptr
;
495 /* Pointer to next place to store character in kbd_buffer. This
496 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
497 character should go in kbd_buffer[0]. */
498 static struct input_event
* volatile kbd_store_ptr
;
500 /* The above pair of variables forms a "queue empty" flag. When we
501 enqueue a non-hook event, we increment kbd_store_ptr. When we
502 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
503 there is input available iff the two pointers are not equal.
505 Why not just have a flag set and cleared by the enqueuing and
506 dequeuing functions? Such a flag could be screwed up by interrupts
507 at inopportune times. */
509 /* If this flag is non-nil, we check mouse_moved to see when the
510 mouse moves, and motion events will appear in the input stream.
511 Otherwise, mouse motion is ignored. */
512 Lisp_Object do_mouse_tracking
;
514 /* Symbols to head events. */
515 Lisp_Object Qmouse_movement
;
516 Lisp_Object Qscroll_bar_movement
;
517 Lisp_Object Qswitch_frame
;
518 Lisp_Object Qdelete_frame
;
519 Lisp_Object Qiconify_frame
;
520 Lisp_Object Qmake_frame_visible
;
521 Lisp_Object Qselect_window
;
522 Lisp_Object Qhelp_echo
;
525 Lisp_Object Qmouse_fixup_help_message
;
528 /* Symbols to denote kinds of events. */
529 Lisp_Object Qfunction_key
;
530 Lisp_Object Qmouse_click
;
531 #if defined (WINDOWSNT) || defined (MAC_OS)
532 Lisp_Object Qlanguage_change
;
534 Lisp_Object Qdrag_n_drop
;
535 Lisp_Object Qsave_session
;
537 Lisp_Object Qmac_apple_event
;
540 /* Lisp_Object Qmouse_movement; - also an event header */
542 /* Properties of event headers. */
543 Lisp_Object Qevent_kind
;
544 Lisp_Object Qevent_symbol_elements
;
546 /* menu item parts */
547 Lisp_Object Qmenu_alias
;
548 Lisp_Object Qmenu_enable
;
549 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
550 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
551 extern Lisp_Object Vdefine_key_rebound_commands
;
552 extern Lisp_Object Qmenu_item
;
554 /* An event header symbol HEAD may have a property named
555 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
556 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
557 mask of modifiers applied to it. If present, this is used to help
558 speed up parse_modifiers. */
559 Lisp_Object Qevent_symbol_element_mask
;
561 /* An unmodified event header BASE may have a property named
562 Qmodifier_cache, which is an alist mapping modifier masks onto
563 modified versions of BASE. If present, this helps speed up
565 Lisp_Object Qmodifier_cache
;
567 /* Symbols to use for parts of windows. */
568 Lisp_Object Qmode_line
;
569 Lisp_Object Qvertical_line
;
570 Lisp_Object Qvertical_scroll_bar
;
571 Lisp_Object Qmenu_bar
;
572 extern Lisp_Object Qleft_margin
, Qright_margin
;
573 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
574 extern Lisp_Object QCmap
;
576 Lisp_Object
recursive_edit_unwind (), command_loop ();
577 Lisp_Object
Fthis_command_keys ();
578 Lisp_Object Qextended_command_history
;
579 EMACS_TIME
timer_check ();
581 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
583 extern char *x_get_keysym_name ();
585 static void record_menu_key ();
586 static int echo_length ();
588 Lisp_Object Qpolling_period
;
590 /* List of absolute timers. Appears in order of next scheduled event. */
591 Lisp_Object Vtimer_list
;
593 /* List of idle time timers. Appears in order of next scheduled event. */
594 Lisp_Object Vtimer_idle_list
;
596 /* Incremented whenever a timer is run. */
599 extern Lisp_Object Vprint_level
, Vprint_length
;
601 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
603 EMACS_TIME
*input_available_clear_time
;
605 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
606 Default is 1 if INTERRUPT_INPUT is defined. */
609 /* Nonzero while interrupts are temporarily deferred during redisplay. */
610 int interrupts_deferred
;
612 /* Nonzero means use ^S/^Q for flow control. */
615 /* Allow m- file to inhibit use of FIONREAD. */
616 #ifdef BROKEN_FIONREAD
620 /* We are unable to use interrupts if FIONREAD is not available,
621 so flush SIGIO so we won't try. */
622 #if !defined (FIONREAD)
628 /* If we support a window system, turn on the code to poll periodically
629 to detect C-g. It isn't actually used when doing interrupt input. */
630 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
631 #define POLL_FOR_INPUT
634 /* After a command is executed, if point is moved into a region that
635 has specific properties (e.g. composition, display), we adjust
636 point to the boundary of the region. But, if a command sets this
637 variable to non-nil, we suppress this point adjustment. This
638 variable is set to nil before reading a command. */
640 Lisp_Object Vdisable_point_adjustment
;
642 /* If non-nil, always disable point adjustment. */
644 Lisp_Object Vglobal_disable_point_adjustment
;
646 /* The time when Emacs started being idle. */
648 static EMACS_TIME timer_idleness_start_time
;
650 /* After Emacs stops being idle, this saves the last value
651 of timer_idleness_start_time from when it was idle. */
653 static EMACS_TIME timer_last_idleness_start_time
;
655 /* If non-nil, events produced by disabled menu items and tool-bar
656 buttons are not ignored. Help functions bind this to allow help on
657 those items and buttons. */
658 Lisp_Object Venable_disabled_menus_and_buttons
;
661 /* Global variable declarations. */
663 /* Flags for readable_events. */
664 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
665 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
666 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
668 /* Function for init_keyboard to call with no args (if nonzero). */
669 void (*keyboard_init_hook
) ();
671 static int read_avail_input
P_ ((int));
672 static void get_input_pending
P_ ((int *, int));
673 static int readable_events
P_ ((int));
674 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
675 Lisp_Object
, int *));
676 static Lisp_Object
read_char_x_menu_prompt ();
677 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
679 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
681 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
682 enum scroll_bar_part
,
683 Lisp_Object
, Lisp_Object
,
686 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
687 Lisp_Object
, char **,
688 Lisp_Object
*, unsigned));
689 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
690 static int parse_solitary_modifier
P_ ((Lisp_Object
));
691 static int parse_solitary_modifier ();
692 static void save_getcjmp
P_ ((jmp_buf));
693 static void save_getcjmp ();
694 static void restore_getcjmp
P_ ((jmp_buf));
695 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
696 static void clear_event
P_ ((struct input_event
*));
697 static void any_kboard_state
P_ ((void));
698 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
699 static void timer_start_idle
P_ ((void));
700 static void timer_stop_idle
P_ ((void));
701 static void timer_resume_idle
P_ ((void));
703 /* Nonzero means don't try to suspend even if the operating system seems
705 static int cannot_suspend
;
707 extern Lisp_Object Qidentity
, Qonly
;
709 /* Install the string STR as the beginning of the string of echoing,
710 so that it serves as a prompt for the next character.
711 Also start echoing. */
717 current_kboard
->echo_string
= str
;
718 current_kboard
->echo_after_prompt
= SCHARS (str
);
722 /* Add C to the echo string, if echoing is going on.
723 C can be a character, which is printed prettily ("M-C-x" and all that
724 jazz), or a symbol, whose name is printed. */
730 if (current_kboard
->immediate_echo
)
732 int size
= KEY_DESCRIPTION_SIZE
+ 100;
733 char *buffer
= (char *) alloca (size
);
735 Lisp_Object echo_string
;
737 echo_string
= current_kboard
->echo_string
;
739 /* If someone has passed us a composite event, use its head symbol. */
744 ptr
= push_key_description (XINT (c
), ptr
, 1);
746 else if (SYMBOLP (c
))
748 Lisp_Object name
= SYMBOL_NAME (c
);
749 int nbytes
= SBYTES (name
);
751 if (size
- (ptr
- buffer
) < nbytes
)
753 int offset
= ptr
- buffer
;
754 size
= max (2 * size
, size
+ nbytes
);
755 buffer
= (char *) alloca (size
);
756 ptr
= buffer
+ offset
;
759 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
760 STRING_MULTIBYTE (name
), 1);
763 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
766 const char *text
= " (Type ? for further options)";
767 int len
= strlen (text
);
769 if (size
- (ptr
- buffer
) < len
)
771 int offset
= ptr
- buffer
;
773 buffer
= (char *) alloca (size
);
774 ptr
= buffer
+ offset
;
777 bcopy (text
, ptr
, len
);
781 /* Replace a dash from echo_dash with a space, otherwise
782 add a space at the end as a separator between keys. */
783 if (STRINGP (echo_string
)
784 && SCHARS (echo_string
) > 1)
786 Lisp_Object last_char
, prev_char
, idx
;
788 idx
= make_number (SCHARS (echo_string
) - 2);
789 prev_char
= Faref (echo_string
, idx
);
791 idx
= make_number (SCHARS (echo_string
) - 1);
792 last_char
= Faref (echo_string
, idx
);
794 /* We test PREV_CHAR to make sure this isn't the echoing
796 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
797 Faset (echo_string
, idx
, make_number (' '));
799 echo_string
= concat2 (echo_string
, build_string (" "));
801 else if (STRINGP (echo_string
))
802 echo_string
= concat2 (echo_string
, build_string (" "));
804 current_kboard
->echo_string
805 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
811 /* Temporarily add a dash to the end of the echo string if it's not
812 empty, so that it serves as a mini-prompt for the very next character. */
817 /* Do nothing if not echoing at all. */
818 if (NILP (current_kboard
->echo_string
))
821 if (!current_kboard
->immediate_echo
822 && SCHARS (current_kboard
->echo_string
) == 0)
825 /* Do nothing if we just printed a prompt. */
826 if (current_kboard
->echo_after_prompt
827 == SCHARS (current_kboard
->echo_string
))
830 /* Do nothing if we have already put a dash at the end. */
831 if (SCHARS (current_kboard
->echo_string
) > 1)
833 Lisp_Object last_char
, prev_char
, idx
;
835 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
836 prev_char
= Faref (current_kboard
->echo_string
, idx
);
838 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
839 last_char
= Faref (current_kboard
->echo_string
, idx
);
841 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
845 /* Put a dash at the end of the buffer temporarily,
846 but make it go away when the next character is added. */
847 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
852 /* Display the current echo string, and begin echoing if not already
858 if (!current_kboard
->immediate_echo
)
861 current_kboard
->immediate_echo
= 1;
863 for (i
= 0; i
< this_command_key_count
; i
++)
867 /* Set before_command_echo_length to the value that would
868 have been saved before the start of this subcommand in
869 command_loop_1, if we had already been echoing then. */
870 if (i
== this_single_command_key_start
)
871 before_command_echo_length
= echo_length ();
873 c
= XVECTOR (this_command_keys
)->contents
[i
];
874 if (! (EVENT_HAS_PARAMETERS (c
)
875 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
879 /* Set before_command_echo_length to the value that would
880 have been saved before the start of this subcommand in
881 command_loop_1, if we had already been echoing then. */
882 if (this_command_key_count
== this_single_command_key_start
)
883 before_command_echo_length
= echo_length ();
885 /* Put a dash at the end to invite the user to type more. */
890 message3_nolog (current_kboard
->echo_string
,
891 SBYTES (current_kboard
->echo_string
),
892 STRING_MULTIBYTE (current_kboard
->echo_string
));
895 /* Record in what buffer we echoed, and from which kboard. */
896 echo_message_buffer
= echo_area_buffer
[0];
897 echo_kboard
= current_kboard
;
899 if (waiting_for_input
&& !NILP (Vquit_flag
))
900 quit_throw_to_read_char ();
903 /* Turn off echoing, for the start of a new command. */
908 current_kboard
->immediate_echo
= 0;
909 current_kboard
->echo_after_prompt
= -1;
910 current_kboard
->echo_string
= Qnil
;
911 ok_to_echo_at_next_pause
= NULL
;
913 echo_message_buffer
= Qnil
;
916 /* Return the length of the current echo string. */
921 return (STRINGP (current_kboard
->echo_string
)
922 ? SCHARS (current_kboard
->echo_string
)
926 /* Truncate the current echo message to its first LEN chars.
927 This and echo_char get used by read_key_sequence when the user
928 switches frames while entering a key sequence. */
931 echo_truncate (nchars
)
934 if (STRINGP (current_kboard
->echo_string
))
935 current_kboard
->echo_string
936 = Fsubstring (current_kboard
->echo_string
,
937 make_number (0), make_number (nchars
));
938 truncate_echo_area (nchars
);
942 /* Functions for manipulating this_command_keys. */
944 add_command_key (key
)
947 #if 0 /* Not needed after we made Freset_this_command_lengths
948 do the job immediately. */
949 /* If reset-this-command-length was called recently, obey it now.
950 See the doc string of that function for an explanation of why. */
951 if (before_command_restore_flag
)
953 this_command_key_count
= before_command_key_count_1
;
954 if (this_command_key_count
< this_single_command_key_start
)
955 this_single_command_key_start
= this_command_key_count
;
956 echo_truncate (before_command_echo_length_1
);
957 before_command_restore_flag
= 0;
961 if (this_command_key_count
>= ASIZE (this_command_keys
))
962 this_command_keys
= larger_vector (this_command_keys
,
963 2 * ASIZE (this_command_keys
),
966 AREF (this_command_keys
, this_command_key_count
) = key
;
967 ++this_command_key_count
;
974 int count
= SPECPDL_INDEX ();
977 if (command_loop_level
> 0)
979 specbind (Qstandard_output
, Qt
);
980 specbind (Qstandard_input
, Qt
);
983 #ifdef HAVE_X_WINDOWS
984 /* The command loop has started an hourglass timer, so we have to
985 cancel it here, otherwise it will fire because the recursive edit
986 can take some time. Do not check for display_hourglass_p here,
987 because it could already be nil. */
991 /* This function may have been called from a debugger called from
992 within redisplay, for instance by Edebugging a function called
993 from fontification-functions. We want to allow redisplay in
994 the debugging session.
996 The recursive edit is left with a `(throw exit ...)'. The `exit'
997 tag is not caught anywhere in redisplay, i.e. when we leave the
998 recursive edit, the original redisplay leading to the recursive
999 edit will be unwound. The outcome should therefore be safe. */
1000 specbind (Qinhibit_redisplay
, Qnil
);
1003 val
= command_loop ();
1005 Fsignal (Qquit
, Qnil
);
1006 /* Handle throw from read_minibuf when using minibuffer
1007 while it's active but we're in another window. */
1009 xsignal1 (Qerror
, val
);
1011 return unbind_to (count
, Qnil
);
1014 /* When an auto-save happens, record the "time", and don't do again soon. */
1019 last_auto_save
= num_nonmacro_input_events
;
1022 /* Make an auto save happen as soon as possible at command level. */
1025 force_auto_save_soon ()
1027 last_auto_save
= - auto_save_interval
- 1;
1029 record_asynch_buffer_change ();
1032 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1033 doc
: /* Invoke the editor command loop recursively.
1034 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1035 that tells this function to return.
1036 Alternatively, `(throw 'exit t)' makes this function signal an error.
1037 This function is called by the editor initialization to begin editing. */)
1040 int count
= SPECPDL_INDEX ();
1043 /* If we enter while input is blocked, don't lock up here.
1044 This may happen through the debugger during redisplay. */
1045 if (INPUT_BLOCKED_P
)
1048 command_loop_level
++;
1049 update_mode_lines
= 1;
1051 if (command_loop_level
1052 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1053 buffer
= Fcurrent_buffer ();
1057 /* If we leave recursive_edit_1 below with a `throw' for instance,
1058 like it is done in the splash screen display, we have to
1059 make sure that we restore single_kboard as command_loop_1
1060 would have done if it were left normally. */
1061 record_unwind_protect (recursive_edit_unwind
,
1062 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1064 recursive_edit_1 ();
1065 return unbind_to (count
, Qnil
);
1069 recursive_edit_unwind (info
)
1072 if (BUFFERP (XCAR (info
)))
1073 Fset_buffer (XCAR (info
));
1075 if (NILP (XCDR (info
)))
1076 any_kboard_state ();
1078 single_kboard_state ();
1080 command_loop_level
--;
1081 update_mode_lines
= 1;
1090 #if 0 /* Theory: if there's anything in Vunread_command_events,
1091 it will right away be read by read_key_sequence,
1092 and then if we do switch KBOARDS, it will go into the side
1093 queue then. So we don't need to do anything special here -- rms. */
1094 if (CONSP (Vunread_command_events
))
1096 current_kboard
->kbd_queue
1097 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1098 current_kboard
->kbd_queue_has_data
= 1;
1100 Vunread_command_events
= Qnil
;
1106 /* Switch to the single-kboard state, making current_kboard
1107 the only KBOARD from which further input is accepted. */
1110 single_kboard_state ()
1117 /* If we're in single_kboard state for kboard KBOARD,
1121 not_single_kboard_state (kboard
)
1125 if (kboard
== current_kboard
)
1130 /* Maintain a stack of kboards, so other parts of Emacs
1131 can switch temporarily to the kboard of a given frame
1132 and then revert to the previous status. */
1137 struct kboard_stack
*next
;
1140 static struct kboard_stack
*kboard_stack
;
1143 push_frame_kboard (f
)
1147 struct kboard_stack
*p
1148 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1150 p
->next
= kboard_stack
;
1151 p
->kboard
= current_kboard
;
1154 current_kboard
= FRAME_KBOARD (f
);
1162 struct kboard_stack
*p
= kboard_stack
;
1163 current_kboard
= p
->kboard
;
1164 kboard_stack
= p
->next
;
1169 /* Handle errors that are not handled at inner levels
1170 by printing an error message and returning to the editor command loop. */
1176 Lisp_Object old_level
, old_length
;
1177 char macroerror
[50];
1179 #ifdef HAVE_X_WINDOWS
1180 if (display_hourglass_p
)
1181 cancel_hourglass ();
1184 if (!NILP (executing_kbd_macro
))
1186 if (executing_kbd_macro_iterations
== 1)
1187 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1189 sprintf (macroerror
, "After %d kbd macro iterations: ",
1190 executing_kbd_macro_iterations
);
1195 Vstandard_output
= Qt
;
1196 Vstandard_input
= Qt
;
1197 Vexecuting_kbd_macro
= Qnil
;
1198 executing_kbd_macro
= Qnil
;
1199 current_kboard
->Vprefix_arg
= Qnil
;
1200 current_kboard
->Vlast_prefix_arg
= Qnil
;
1203 /* Avoid unquittable loop if data contains a circular list. */
1204 old_level
= Vprint_level
;
1205 old_length
= Vprint_length
;
1206 XSETFASTINT (Vprint_level
, 10);
1207 XSETFASTINT (Vprint_length
, 10);
1208 cmd_error_internal (data
, macroerror
);
1209 Vprint_level
= old_level
;
1210 Vprint_length
= old_length
;
1214 Vinhibit_quit
= Qnil
;
1216 if (command_loop_level
== 0 && minibuf_level
== 0)
1217 any_kboard_state ();
1220 return make_number (0);
1223 /* Take actions on handling an error. DATA is the data that describes
1226 CONTEXT is a C-string containing ASCII characters only which
1227 describes the context in which the error happened. If we need to
1228 generalize CONTEXT to allow multibyte characters, make it a Lisp
1232 cmd_error_internal (data
, context
)
1236 struct frame
*sf
= SELECTED_FRAME ();
1238 /* The immediate context is not interesting for Quits,
1239 since they are asyncronous. */
1240 if (EQ (XCAR (data
), Qquit
))
1241 Vsignaling_function
= Qnil
;
1246 /* Use user's specified output function if any. */
1247 if (!NILP (Vcommand_error_function
))
1248 call3 (Vcommand_error_function
, data
,
1249 build_string (context
? context
: ""),
1250 Vsignaling_function
);
1251 /* If the window system or terminal frame hasn't been initialized
1252 yet, or we're not interactive, write the message to stderr and exit. */
1253 else if (!sf
->glyphs_initialized_p
1254 /* This is the case of the frame dumped with Emacs, when we're
1255 running under a window system. */
1256 || (!NILP (Vwindow_system
)
1257 && !inhibit_window_system
1258 && FRAME_TERMCAP_P (sf
))
1261 print_error_message (data
, Qexternal_debugging_output
,
1262 context
, Vsignaling_function
);
1263 Fterpri (Qexternal_debugging_output
);
1264 Fkill_emacs (make_number (-1));
1268 clear_message (1, 0);
1270 message_log_maybe_newline ();
1273 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1276 Vsignaling_function
= Qnil
;
1279 Lisp_Object
command_loop_1 ();
1280 Lisp_Object
command_loop_2 ();
1281 Lisp_Object
top_level_1 ();
1283 /* Entry to editor-command-loop.
1284 This level has the catches for exiting/returning to editor command loop.
1285 It returns nil to exit recursive edit, t to abort it. */
1290 if (command_loop_level
> 0 || minibuf_level
> 0)
1293 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1294 executing_kbd_macro
= Qnil
;
1300 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1301 /* Reset single_kboard in case top-level set it while
1302 evaluating an -f option, or we are stuck there for some
1304 any_kboard_state ();
1305 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1306 executing_kbd_macro
= Qnil
;
1308 /* End of file in -batch run causes exit here. */
1314 /* Here we catch errors in execution of commands within the
1315 editing loop, and reenter the editing loop.
1316 When there is an error, cmd_error runs and returns a non-nil
1317 value to us. A value of nil means that command_loop_1 itself
1318 returned due to end of file (or end of kbd macro). */
1323 register Lisp_Object val
;
1326 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1327 while (!NILP (val
));
1335 return Feval (Vtop_level
);
1341 /* On entry to the outer level, run the startup file */
1342 if (!NILP (Vtop_level
))
1343 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1344 else if (!NILP (Vpurify_flag
))
1345 message ("Bare impure Emacs (standard Lisp code not loaded)");
1347 message ("Bare Emacs (standard Lisp code not loaded)");
1351 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1352 doc
: /* Exit all recursive editing levels. */)
1355 #ifdef HAVE_X_WINDOWS
1356 if (display_hourglass_p
)
1357 cancel_hourglass ();
1360 /* Unblock input if we enter with input blocked. This may happen if
1361 redisplay traps e.g. during tool-bar update with input blocked. */
1362 while (INPUT_BLOCKED_P
)
1365 return Fthrow (Qtop_level
, Qnil
);
1368 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1369 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1372 if (command_loop_level
> 0 || minibuf_level
> 0)
1373 Fthrow (Qexit
, Qnil
);
1375 error ("No recursive edit is in progress");
1379 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1380 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1383 if (command_loop_level
> 0 || minibuf_level
> 0)
1386 error ("No recursive edit is in progress");
1390 /* This is the actual command reading loop,
1391 sans error-handling encapsulation. */
1393 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1395 void safe_run_hooks
P_ ((Lisp_Object
));
1396 static void adjust_point_for_property
P_ ((int, int));
1398 /* Cancel hourglass from protect_unwind.
1400 #ifdef HAVE_X_WINDOWS
1402 cancel_hourglass_unwind (arg
)
1405 cancel_hourglass ();
1416 Lisp_Object keybuf
[30];
1419 int prev_modiff
= 0;
1420 struct buffer
*prev_buffer
= NULL
;
1422 int was_locked
= single_kboard
;
1424 int already_adjusted
;
1426 current_kboard
->Vprefix_arg
= Qnil
;
1427 current_kboard
->Vlast_prefix_arg
= Qnil
;
1428 Vdeactivate_mark
= Qnil
;
1429 waiting_for_input
= 0;
1433 this_command_key_count
= 0;
1434 this_command_key_count_reset
= 0;
1435 this_single_command_key_start
= 0;
1437 if (NILP (Vmemory_full
))
1439 /* Make sure this hook runs after commands that get errors and
1440 throw to top level. */
1441 /* Note that the value cell will never directly contain nil
1442 if the symbol is a local variable. */
1443 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1444 safe_run_hooks (Qpost_command_hook
);
1446 /* If displaying a message, resize the echo area window to fit
1447 that message's size exactly. */
1448 if (!NILP (echo_area_buffer
[0]))
1449 resize_echo_area_exactly ();
1451 if (!NILP (Vdeferred_action_list
))
1452 safe_run_hooks (Qdeferred_action_function
);
1455 /* Do this after running Vpost_command_hook, for consistency. */
1456 current_kboard
->Vlast_command
= Vthis_command
;
1457 current_kboard
->Vreal_last_command
= real_this_command
;
1461 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1464 /* Make sure the current window's buffer is selected. */
1465 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1466 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1468 /* Display any malloc warning that just came out. Use while because
1469 displaying one warning can cause another. */
1471 while (pending_malloc_warning
)
1472 display_malloc_warning ();
1476 Vdeactivate_mark
= Qnil
;
1478 /* If minibuffer on and echo area in use,
1479 wait a short time and redraw minibuffer. */
1482 && !NILP (echo_area_buffer
[0])
1483 && EQ (minibuf_window
, echo_area_window
)
1484 && NUMBERP (Vminibuffer_message_timeout
))
1486 /* Bind inhibit-quit to t so that C-g gets read in
1487 rather than quitting back to the minibuffer. */
1488 int count
= SPECPDL_INDEX ();
1489 specbind (Qinhibit_quit
, Qt
);
1491 sit_for (Vminibuffer_message_timeout
, 0, 2);
1493 /* Clear the echo area. */
1495 safe_run_hooks (Qecho_area_clear_hook
);
1497 unbind_to (count
, Qnil
);
1499 /* If a C-g came in before, treat it as input now. */
1500 if (!NILP (Vquit_flag
))
1503 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1508 alloca (0); /* Cause a garbage collection now */
1509 /* Since we can free the most stuff here. */
1510 #endif /* C_ALLOCA */
1513 /* Select the frame that the last event came from. Usually,
1514 switch-frame events will take care of this, but if some lisp
1515 code swallows a switch-frame event, we'll fix things up here.
1516 Is this a good idea? */
1517 if (FRAMEP (internal_last_event_frame
)
1518 && !EQ (internal_last_event_frame
, selected_frame
))
1519 Fselect_frame (internal_last_event_frame
);
1521 /* If it has changed current-menubar from previous value,
1522 really recompute the menubar from the value. */
1523 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1524 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1525 call0 (Qrecompute_lucid_menubar
);
1527 before_command_key_count
= this_command_key_count
;
1528 before_command_echo_length
= echo_length ();
1530 Vthis_command
= Qnil
;
1531 real_this_command
= Qnil
;
1532 Vthis_original_command
= Qnil
;
1534 /* Read next key sequence; i gets its length. */
1535 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1538 /* A filter may have run while we were reading the input. */
1539 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1541 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1542 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1546 /* Now we have read a key sequence of length I,
1547 or else I is 0 and we found end of file. */
1549 if (i
== 0) /* End of file -- happens only in */
1550 return Qnil
; /* a kbd macro, at the end. */
1551 /* -1 means read_key_sequence got a menu that was rejected.
1552 Just loop around and read another command. */
1556 this_command_key_count
= 0;
1557 this_command_key_count_reset
= 0;
1558 this_single_command_key_start
= 0;
1562 last_command_char
= keybuf
[i
- 1];
1564 /* If the previous command tried to force a specific window-start,
1565 forget about that, in case this command moves point far away
1566 from that position. But also throw away beg_unchanged and
1567 end_unchanged information in that case, so that redisplay will
1568 update the whole window properly. */
1569 if (!NILP (XWINDOW (selected_window
)->force_start
))
1572 XWINDOW (selected_window
)->force_start
= Qnil
;
1573 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1574 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1577 cmd
= read_key_sequence_cmd
;
1578 if (!NILP (Vexecuting_kbd_macro
))
1580 if (!NILP (Vquit_flag
))
1582 Vexecuting_kbd_macro
= Qt
;
1583 QUIT
; /* Make some noise. */
1584 /* Will return since macro now empty. */
1588 /* Do redisplay processing after this command except in special
1589 cases identified below. */
1590 prev_buffer
= current_buffer
;
1591 prev_modiff
= MODIFF
;
1592 last_point_position
= PT
;
1593 last_point_position_window
= selected_window
;
1594 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1596 /* By default, we adjust point to a boundary of a region that
1597 has such a property that should be treated intangible
1598 (e.g. composition, display). But, some commands will set
1599 this variable differently. */
1600 Vdisable_point_adjustment
= Qnil
;
1602 /* Process filters and timers may have messed with deactivate-mark.
1603 reset it before we execute the command. */
1604 Vdeactivate_mark
= Qnil
;
1606 /* Remap command through active keymaps */
1607 Vthis_original_command
= cmd
;
1611 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1615 /* Execute the command. */
1617 Vthis_command
= cmd
;
1618 real_this_command
= cmd
;
1619 /* Note that the value cell will never directly contain nil
1620 if the symbol is a local variable. */
1621 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1622 safe_run_hooks (Qpre_command_hook
);
1624 already_adjusted
= 0;
1626 if (NILP (Vthis_command
))
1628 /* nil means key is undefined. */
1629 Lisp_Object keys
= Fvector (i
, keybuf
);
1630 keys
= Fkey_description (keys
, Qnil
);
1632 message_with_string ("%s is undefined", keys
, 0);
1633 current_kboard
->defining_kbd_macro
= Qnil
;
1634 update_mode_lines
= 1;
1635 current_kboard
->Vprefix_arg
= Qnil
;
1639 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1641 /* In case we jump to directly_done. */
1642 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1644 /* Recognize some common commands in common situations and
1645 do them directly. */
1646 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1648 struct Lisp_Char_Table
*dp
1649 = window_display_table (XWINDOW (selected_window
));
1650 lose
= FETCH_CHAR (PT_BYTE
);
1652 if (! NILP (Vpost_command_hook
))
1653 /* Put this before calling adjust_point_for_property
1654 so it will only get called once in any case. */
1656 if (current_buffer
== prev_buffer
1657 && last_point_position
!= PT
1658 && NILP (Vdisable_point_adjustment
)
1659 && NILP (Vglobal_disable_point_adjustment
))
1660 adjust_point_for_property (last_point_position
, 0);
1661 already_adjusted
= 1;
1662 if (PT
== last_point_position
+ 1
1664 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1665 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1666 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1667 && (lose
>= 0x20 && lose
< 0x7f)))
1668 : (lose
>= 0x20 && lose
< 0x7f))
1669 /* To extract the case of continuation on
1670 wide-column characters. */
1671 && ASCII_BYTE_P (lose
)
1672 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1674 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1676 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1678 && !windows_or_buffers_changed
1679 && EQ (current_buffer
->selective_display
, Qnil
)
1680 && !detect_input_pending ()
1681 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1682 && NILP (Vexecuting_kbd_macro
))
1683 direct_output_forward_char (1);
1686 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1688 struct Lisp_Char_Table
*dp
1689 = window_display_table (XWINDOW (selected_window
));
1691 lose
= FETCH_CHAR (PT_BYTE
);
1692 if (! NILP (Vpost_command_hook
))
1694 if (current_buffer
== prev_buffer
1695 && last_point_position
!= PT
1696 && NILP (Vdisable_point_adjustment
)
1697 && NILP (Vglobal_disable_point_adjustment
))
1698 adjust_point_for_property (last_point_position
, 0);
1699 already_adjusted
= 1;
1700 if (PT
== last_point_position
- 1
1702 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1703 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1704 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1705 && (lose
>= 0x20 && lose
< 0x7f)))
1706 : (lose
>= 0x20 && lose
< 0x7f))
1707 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1709 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1711 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1713 && !windows_or_buffers_changed
1714 && EQ (current_buffer
->selective_display
, Qnil
)
1715 && !detect_input_pending ()
1716 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1717 && NILP (Vexecuting_kbd_macro
))
1718 direct_output_forward_char (-1);
1721 else if (EQ (Vthis_command
, Qself_insert_command
)
1722 /* Try this optimization only on char keystrokes. */
1723 && NATNUMP (last_command_char
)
1724 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1727 = translate_char (Vtranslation_table_for_input
,
1728 XFASTINT (last_command_char
));
1730 if (NILP (Vexecuting_kbd_macro
)
1731 && !EQ (minibuf_window
, selected_window
))
1733 if (!nonundocount
|| nonundocount
>= 20)
1741 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1743 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1745 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1747 || MODIFF
<= SAVE_MODIFF
1748 || windows_or_buffers_changed
1749 || !EQ (current_buffer
->selective_display
, Qnil
)
1750 || detect_input_pending ()
1751 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1752 || !NILP (Vexecuting_kbd_macro
));
1754 value
= internal_self_insert (c
, 0);
1759 if (! NILP (Vpost_command_hook
))
1760 /* Put this before calling adjust_point_for_property
1761 so it will only get called once in any case. */
1764 /* VALUE == 1 when AFTER-CHANGE functions are
1765 installed which is the case most of the time
1766 because FONT-LOCK installs one. */
1767 if (!lose
&& !value
)
1768 direct_output_for_insert (c
);
1773 /* Here for a command that isn't executed directly */
1776 #ifdef HAVE_X_WINDOWS
1777 int scount
= SPECPDL_INDEX ();
1779 if (display_hourglass_p
1780 && NILP (Vexecuting_kbd_macro
))
1782 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1788 if (NILP (current_kboard
->Vprefix_arg
))
1790 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1792 #ifdef HAVE_X_WINDOWS
1793 /* Do not check display_hourglass_p here, because
1794 Fcommand_execute could change it, but we should cancel
1795 hourglass cursor anyway.
1796 But don't cancel the hourglass within a macro
1797 just because a command in the macro finishes. */
1798 if (NILP (Vexecuting_kbd_macro
))
1799 unbind_to (scount
, Qnil
);
1804 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1806 /* Note that the value cell will never directly contain nil
1807 if the symbol is a local variable. */
1808 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1809 safe_run_hooks (Qpost_command_hook
);
1811 /* If displaying a message, resize the echo area window to fit
1812 that message's size exactly. */
1813 if (!NILP (echo_area_buffer
[0]))
1814 resize_echo_area_exactly ();
1816 if (!NILP (Vdeferred_action_list
))
1817 safe_run_hooks (Qdeferred_action_function
);
1819 /* If there is a prefix argument,
1820 1) We don't want Vlast_command to be ``universal-argument''
1821 (that would be dumb), so don't set Vlast_command,
1822 2) we want to leave echoing on so that the prefix will be
1823 echoed as part of this key sequence, so don't call
1825 3) we want to leave this_command_key_count non-zero, so that
1826 read_char will realize that it is re-reading a character, and
1827 not echo it a second time.
1829 If the command didn't actually create a prefix arg,
1830 but is merely a frame event that is transparent to prefix args,
1831 then the above doesn't apply. */
1832 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1834 current_kboard
->Vlast_command
= Vthis_command
;
1835 current_kboard
->Vreal_last_command
= real_this_command
;
1837 this_command_key_count
= 0;
1838 this_command_key_count_reset
= 0;
1839 this_single_command_key_start
= 0;
1842 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1844 /* Setting transient-mark-mode to `only' is a way of
1845 turning it on for just one command. */
1847 if (EQ (Vtransient_mark_mode
, Qidentity
))
1848 Vtransient_mark_mode
= Qnil
;
1849 if (EQ (Vtransient_mark_mode
, Qonly
))
1850 Vtransient_mark_mode
= Qidentity
;
1852 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1854 /* We could also call `deactivate'mark'. */
1855 if (EQ (Vtransient_mark_mode
, Qlambda
))
1856 Vtransient_mark_mode
= Qnil
;
1859 current_buffer
->mark_active
= Qnil
;
1860 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1863 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1864 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1869 if (current_buffer
== prev_buffer
1870 && last_point_position
!= PT
1871 && NILP (Vdisable_point_adjustment
)
1872 && NILP (Vglobal_disable_point_adjustment
)
1873 && !already_adjusted
)
1874 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1876 /* Install chars successfully executed in kbd macro. */
1878 if (!NILP (current_kboard
->defining_kbd_macro
)
1879 && NILP (current_kboard
->Vprefix_arg
))
1880 finalize_kbd_macro_chars ();
1884 any_kboard_state ();
1889 extern Lisp_Object Qcomposition
, Qdisplay
;
1891 /* Adjust point to a boundary of a region that has such a property
1892 that should be treated intangible. For the moment, we check
1893 `composition', `display' and `invisible' properties.
1894 LAST_PT is the last position of point. */
1896 extern Lisp_Object Qafter_string
, Qbefore_string
;
1897 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1900 adjust_point_for_property (last_pt
, modified
)
1905 Lisp_Object val
, overlay
, tmp
;
1906 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1909 /* FIXME: cycling is probably not necessary because these properties
1910 can't be usefully combined anyway. */
1911 while (check_composition
|| check_display
|| check_invisible
)
1913 if (check_composition
1914 && PT
> BEGV
&& PT
< ZV
1915 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1916 && COMPOSITION_VALID_P (beg
, end
, val
)
1917 && beg
< PT
/* && end > PT <- It's always the case. */
1918 && (last_pt
<= beg
|| last_pt
>= end
))
1921 SET_PT (PT
< last_pt
? beg
: end
);
1922 check_display
= check_invisible
= 1;
1924 check_composition
= 0;
1926 && PT
> BEGV
&& PT
< ZV
1927 && !NILP (val
= get_char_property_and_overlay
1928 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1929 && display_prop_intangible_p (val
)
1930 && (!OVERLAYP (overlay
)
1931 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1932 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1933 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1934 && (beg
< PT
/* && end > PT <- It's always the case. */
1935 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1938 SET_PT (PT
< last_pt
1939 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1941 check_composition
= check_invisible
= 1;
1944 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1946 int inv
, ellipsis
= 0;
1949 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1951 && !NILP (val
= get_char_property_and_overlay
1952 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1953 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1955 ellipsis
= ellipsis
|| inv
> 1
1956 || (OVERLAYP (overlay
)
1957 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1958 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1959 tmp
= Fnext_single_char_property_change
1960 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1961 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1964 && !NILP (val
= get_char_property_and_overlay
1965 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1966 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1968 ellipsis
= ellipsis
|| inv
> 1
1969 || (OVERLAYP (overlay
)
1970 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1971 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1972 tmp
= Fprevious_single_char_property_change
1973 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1974 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1977 /* Move away from the inside area. */
1978 if (beg
< PT
&& end
> PT
)
1980 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1981 /* We haven't moved yet (so we don't need to fear
1982 infinite-looping) and we were outside the range
1983 before (so either end of the range still corresponds
1984 to a move in the right direction): pretend we moved
1985 less than we actually did, so that we still have
1986 more freedom below in choosing which end of the range
1988 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1989 /* We either have moved already or the last point
1990 was already in the range: we don't get to choose
1991 which end of the range we have to go to. */
1992 : (PT
< last_pt
? beg
: end
));
1993 check_composition
= check_display
= 1;
1995 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1996 the point to something other than its argument, due to
1997 point-motion hooks, intangibility, etc. */
1998 xassert (PT
== beg
|| PT
== end
);
2001 /* Pretend the area doesn't exist if the buffer is not
2003 if (!modified
&& !ellipsis
&& beg
< end
)
2005 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2006 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2007 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2008 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2009 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2010 /* We've already moved as far as we can. Trying to go
2011 to the other end would mean moving backwards and thus
2012 could lead to an infinite loop. */
2014 else if (val
= get_pos_property (make_number (PT
),
2016 TEXT_PROP_MEANS_INVISIBLE (val
)
2017 && (val
= get_pos_property
2018 (make_number (PT
== beg
? end
: beg
),
2020 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2021 (check_composition
= check_display
= 1,
2022 SET_PT (PT
== beg
? end
: beg
));
2025 check_invisible
= 0;
2029 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2032 safe_run_hooks_1 (hook
)
2035 return call1 (Vrun_hooks
, Vinhibit_quit
);
2038 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2041 safe_run_hooks_error (data
)
2044 Lisp_Object args
[3];
2045 args
[0] = build_string ("Error in %s: %s");
2046 args
[1] = Vinhibit_quit
;
2049 return Fset (Vinhibit_quit
, Qnil
);
2052 /* If we get an error while running the hook, cause the hook variable
2053 to be nil. Also inhibit quits, so that C-g won't cause the hook
2054 to mysteriously evaporate. */
2057 safe_run_hooks (hook
)
2060 int count
= SPECPDL_INDEX ();
2061 specbind (Qinhibit_quit
, hook
);
2063 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2065 unbind_to (count
, Qnil
);
2069 /* Number of seconds between polling for input. This is a Lisp
2070 variable that can be bound. */
2072 EMACS_INT polling_period
;
2074 /* Nonzero means polling for input is temporarily suppressed. */
2076 int poll_suppress_count
;
2078 /* Asynchronous timer for polling. */
2080 struct atimer
*poll_timer
;
2083 #ifdef POLL_FOR_INPUT
2085 /* Poll for input, so what we catch a C-g if it comes in. This
2086 function is called from x_make_frame_visible, see comment
2092 if (interrupt_input_blocked
== 0
2093 && !waiting_for_input
)
2094 read_avail_input (0);
2097 /* Timer callback function for poll_timer. TIMER is equal to
2101 poll_for_input (timer
)
2102 struct atimer
*timer
;
2104 if (poll_suppress_count
== 0)
2106 interrupt_input_pending
= 1;
2108 poll_for_input_1 ();
2112 #endif /* POLL_FOR_INPUT */
2114 /* Begin signals to poll for input, if they are appropriate.
2115 This function is called unconditionally from various places. */
2120 #ifdef POLL_FOR_INPUT
2121 if (read_socket_hook
&& !interrupt_input
)
2123 /* Turn alarm handling on unconditionally. It might have
2124 been turned off in process.c. */
2125 turn_on_atimers (1);
2127 /* If poll timer doesn't exist, are we need one with
2128 a different interval, start a new one. */
2129 if (poll_timer
== NULL
2130 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2132 EMACS_TIME interval
;
2135 cancel_atimer (poll_timer
);
2137 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2138 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2139 poll_for_input
, NULL
);
2142 /* Let the timer's callback function poll for input
2143 if this becomes zero. */
2144 --poll_suppress_count
;
2149 /* Nonzero if we are using polling to handle input asynchronously. */
2152 input_polling_used ()
2154 #ifdef POLL_FOR_INPUT
2155 return read_socket_hook
&& !interrupt_input
;
2161 /* Turn off polling. */
2166 #ifdef POLL_FOR_INPUT
2167 if (read_socket_hook
&& !interrupt_input
)
2168 ++poll_suppress_count
;
2172 /* Set the value of poll_suppress_count to COUNT
2173 and start or stop polling accordingly. */
2176 set_poll_suppress_count (count
)
2179 #ifdef POLL_FOR_INPUT
2180 if (count
== 0 && poll_suppress_count
!= 0)
2182 poll_suppress_count
= 1;
2185 else if (count
!= 0 && poll_suppress_count
== 0)
2189 poll_suppress_count
= count
;
2193 /* Bind polling_period to a value at least N.
2194 But don't decrease it. */
2197 bind_polling_period (n
)
2200 #ifdef POLL_FOR_INPUT
2201 int new = polling_period
;
2206 stop_other_atimers (poll_timer
);
2208 specbind (Qpolling_period
, make_number (new));
2209 /* Start a new alarm with the new period. */
2214 /* Apply the control modifier to CHARACTER. */
2220 /* Save the upper bits here. */
2221 int upper
= c
& ~0177;
2225 /* Everything in the columns containing the upper-case letters
2226 denotes a control character. */
2227 if (c
>= 0100 && c
< 0140)
2231 /* Set the shift modifier for a control char
2232 made from a shifted letter. But only for letters! */
2233 if (oc
>= 'A' && oc
<= 'Z')
2234 c
|= shift_modifier
;
2237 /* The lower-case letters denote control characters too. */
2238 else if (c
>= 'a' && c
<= 'z')
2241 /* Include the bits for control and shift
2242 only if the basic ASCII code can't indicate them. */
2246 /* Replace the high bits. */
2247 c
|= (upper
& ~ctrl_modifier
);
2252 /* Display the help-echo property of the character after the mouse pointer.
2253 Either show it in the echo area, or call show-help-function to display
2254 it by other means (maybe in a tooltip).
2256 If HELP is nil, that means clear the previous help echo.
2258 If HELP is a string, display that string. If HELP is a function,
2259 call it with OBJECT and POS as arguments; the function should
2260 return a help string or nil for none. For all other types of HELP,
2261 evaluate it to obtain a string.
2263 WINDOW is the window in which the help was generated, if any.
2264 It is nil if not in a window.
2266 If OBJECT is a buffer, POS is the position in the buffer where the
2267 `help-echo' text property was found.
2269 If OBJECT is an overlay, that overlay has a `help-echo' property,
2270 and POS is the position in the overlay's buffer under the mouse.
2272 If OBJECT is a string (an overlay string or a string displayed with
2273 the `display' property). POS is the position in that string under
2276 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2277 echo overwrites a keystroke echo currently displayed in the echo
2280 Note: this function may only be called with HELP nil or a string
2281 from X code running asynchronously. */
2284 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2285 Lisp_Object help
, window
, object
, pos
;
2286 int ok_to_overwrite_keystroke_echo
;
2288 if (!NILP (help
) && !STRINGP (help
))
2290 if (FUNCTIONP (help
))
2292 Lisp_Object args
[4];
2297 help
= safe_call (4, args
);
2300 help
= safe_eval (help
);
2302 if (!STRINGP (help
))
2307 if (!noninteractive
&& STRINGP (help
))
2308 help
= call1 (Qmouse_fixup_help_message
, help
);
2311 if (STRINGP (help
) || NILP (help
))
2313 if (!NILP (Vshow_help_function
))
2314 call1 (Vshow_help_function
, help
);
2315 else if (/* Don't overwrite minibuffer contents. */
2316 !MINI_WINDOW_P (XWINDOW (selected_window
))
2317 /* Don't overwrite a keystroke echo. */
2318 && (NILP (echo_message_buffer
)
2319 || ok_to_overwrite_keystroke_echo
)
2320 /* Don't overwrite a prompt. */
2321 && !cursor_in_echo_area
)
2325 int count
= SPECPDL_INDEX ();
2327 if (!help_echo_showing_p
)
2328 Vpre_help_message
= current_message ();
2330 specbind (Qmessage_truncate_lines
, Qt
);
2331 message3_nolog (help
, SBYTES (help
),
2332 STRING_MULTIBYTE (help
));
2333 unbind_to (count
, Qnil
);
2335 else if (STRINGP (Vpre_help_message
))
2337 message3_nolog (Vpre_help_message
,
2338 SBYTES (Vpre_help_message
),
2339 STRING_MULTIBYTE (Vpre_help_message
));
2340 Vpre_help_message
= Qnil
;
2346 help_echo_showing_p
= STRINGP (help
);
2352 /* Input of single characters from keyboard */
2354 Lisp_Object
print_help ();
2355 static Lisp_Object
kbd_buffer_get_event ();
2356 static void record_char ();
2359 static jmp_buf wrong_kboard_jmpbuf
;
2362 #define STOP_POLLING \
2363 do { if (! polling_stopped_here) stop_polling (); \
2364 polling_stopped_here = 1; } while (0)
2366 #define RESUME_POLLING \
2367 do { if (polling_stopped_here) start_polling (); \
2368 polling_stopped_here = 0; } while (0)
2370 /* read a character from the keyboard; call the redisplay if needed */
2371 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2372 -1 means do not do redisplay, but do do autosaving.
2375 /* The arguments MAPS and NMAPS are for menu prompting.
2376 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2378 PREV_EVENT is the previous input event, or nil if we are reading
2379 the first event of a key sequence (or not reading a key sequence).
2380 If PREV_EVENT is t, that is a "magic" value that says
2381 not to run input methods, but in other respects to act as if
2382 not reading a key sequence.
2384 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2385 if we used a mouse menu to read the input, or zero otherwise. If
2386 USED_MOUSE_MENU is null, we don't dereference it.
2388 Value is t if we showed a menu and the user rejected it. */
2391 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2395 Lisp_Object prev_event
;
2396 int *used_mouse_menu
;
2398 volatile Lisp_Object c
;
2400 jmp_buf local_getcjmp
;
2402 volatile int key_already_recorded
= 0;
2403 Lisp_Object tem
, save
;
2404 volatile Lisp_Object previous_echo_area_message
;
2405 volatile Lisp_Object also_record
;
2406 volatile int reread
;
2407 struct gcpro gcpro1
, gcpro2
;
2408 int polling_stopped_here
= 0;
2412 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2413 before_command_key_count
= this_command_key_count
;
2414 before_command_echo_length
= echo_length ();
2417 previous_echo_area_message
= Qnil
;
2419 GCPRO2 (c
, previous_echo_area_message
);
2424 if (CONSP (Vunread_post_input_method_events
))
2426 c
= XCAR (Vunread_post_input_method_events
);
2427 Vunread_post_input_method_events
2428 = XCDR (Vunread_post_input_method_events
);
2430 /* Undo what read_char_x_menu_prompt did when it unread
2431 additional keys returned by Fx_popup_menu. */
2433 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2441 if (unread_command_char
!= -1)
2443 XSETINT (c
, unread_command_char
);
2444 unread_command_char
= -1;
2450 if (CONSP (Vunread_command_events
))
2452 c
= XCAR (Vunread_command_events
);
2453 Vunread_command_events
= XCDR (Vunread_command_events
);
2455 /* Undo what read_char_x_menu_prompt did when it unread
2456 additional keys returned by Fx_popup_menu. */
2458 && EQ (XCDR (c
), Qdisabled
)
2459 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2462 /* If the queued event is something that used the mouse,
2463 set used_mouse_menu accordingly. */
2465 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2466 *used_mouse_menu
= 1;
2469 goto reread_for_input_method
;
2472 if (CONSP (Vunread_input_method_events
))
2474 c
= XCAR (Vunread_input_method_events
);
2475 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2477 /* Undo what read_char_x_menu_prompt did when it unread
2478 additional keys returned by Fx_popup_menu. */
2480 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2484 goto reread_for_input_method
;
2487 this_command_key_count_reset
= 0;
2489 if (!NILP (Vexecuting_kbd_macro
))
2491 /* We set this to Qmacro; since that's not a frame, nobody will
2492 try to switch frames on us, and the selected window will
2495 Since this event came from a macro, it would be misleading to
2496 leave internal_last_event_frame set to wherever the last
2497 real event came from. Normally, a switch-frame event selects
2498 internal_last_event_frame after each command is read, but
2499 events read from a macro should never cause a new frame to be
2501 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2503 /* Exit the macro if we are at the end.
2504 Also, some things replace the macro with t
2505 to force an early exit. */
2506 if (EQ (Vexecuting_kbd_macro
, Qt
)
2507 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2513 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2514 if (STRINGP (Vexecuting_kbd_macro
)
2515 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2516 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2518 executing_kbd_macro_index
++;
2523 if (!NILP (unread_switch_frame
))
2525 c
= unread_switch_frame
;
2526 unread_switch_frame
= Qnil
;
2528 /* This event should make it into this_command_keys, and get echoed
2529 again, so we do not set `reread'. */
2533 /* if redisplay was requested */
2534 if (commandflag
>= 0)
2536 /* If there is pending input, process any events which are not
2537 user-visible, such as X selection_request events. */
2539 || detect_input_pending_run_timers (0))
2540 swallow_events (0); /* may clear input_pending */
2542 /* Redisplay if no pending input. */
2543 while (!input_pending
)
2545 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2546 redisplay_preserve_echo_area (5);
2551 /* Normal case: no input arrived during redisplay. */
2554 /* Input arrived and pre-empted redisplay.
2555 Process any events which are not user-visible. */
2557 /* If that cleared input_pending, try again to redisplay. */
2561 /* Message turns off echoing unless more keystrokes turn it on again.
2563 The code in 20.x for the condition was
2565 1. echo_area_glyphs && *echo_area_glyphs
2566 2. && echo_area_glyphs != current_kboard->echobuf
2567 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2569 (1) means there's a current message displayed
2571 (2) means it's not the message from echoing from the current
2574 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2575 is set to a non-null value. This is done in read_char and it is
2576 set to echo_area_glyphs after a call to echo_char. That means
2577 ok_to_echo_at_next_pause is either null or
2578 current_kboard->echobuf with the appropriate current_kboard at
2581 So, condition (3) means in clear text ok_to_echo_at_next_pause
2582 must be either null, or the current message isn't from echoing at
2583 all, or it's from echoing from a different kboard than the
2586 if (/* There currently is something in the echo area. */
2587 !NILP (echo_area_buffer
[0])
2588 && (/* And it's either not from echoing. */
2589 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2590 /* Or it's an echo from a different kboard. */
2591 || echo_kboard
!= current_kboard
2592 /* Or we explicitly allow overwriting whatever there is. */
2593 || ok_to_echo_at_next_pause
== NULL
))
2598 /* Try reading a character via menu prompting in the minibuf.
2599 Try this before the sit-for, because the sit-for
2600 would do the wrong thing if we are supposed to do
2601 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2602 after a mouse event so don't try a minibuf menu. */
2604 if (nmaps
> 0 && INTERACTIVE
2605 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2606 /* Don't bring up a menu if we already have another event. */
2607 && NILP (Vunread_command_events
)
2608 && unread_command_char
< 0
2609 && !detect_input_pending_run_timers (0))
2611 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2614 key_already_recorded
= 1;
2619 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2620 We will do that below, temporarily for short sections of code,
2621 when appropriate. local_getcjmp must be in effect
2622 around any call to sit_for or kbd_buffer_get_event;
2623 it *must not* be in effect when we call redisplay. */
2625 if (_setjmp (local_getcjmp
))
2627 /* We must have saved the outer value of getcjmp here,
2628 so restore it now. */
2629 restore_getcjmp (save_jump
);
2630 XSETINT (c
, quit_char
);
2631 internal_last_event_frame
= selected_frame
;
2632 Vlast_event_frame
= internal_last_event_frame
;
2633 /* If we report the quit char as an event,
2634 don't do so more than once. */
2635 if (!NILP (Vinhibit_quit
))
2640 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2641 if (kb
!= current_kboard
)
2643 Lisp_Object link
= kb
->kbd_queue
;
2644 /* We shouldn't get here if we were in single-kboard mode! */
2649 while (CONSP (XCDR (link
)))
2651 if (!NILP (XCDR (link
)))
2655 kb
->kbd_queue
= Fcons (c
, Qnil
);
2657 XSETCDR (link
, Fcons (c
, Qnil
));
2658 kb
->kbd_queue_has_data
= 1;
2659 current_kboard
= kb
;
2660 /* This is going to exit from read_char
2661 so we had better get rid of this frame's stuff. */
2663 longjmp (wrong_kboard_jmpbuf
, 1);
2670 timer_start_idle ();
2672 /* If in middle of key sequence and minibuffer not active,
2673 start echoing if enough time elapses. */
2675 if (minibuf_level
== 0
2676 && !current_kboard
->immediate_echo
2677 && this_command_key_count
> 0
2679 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2680 && NILP (Fzerop (Vecho_keystrokes
))
2681 && (/* No message. */
2682 NILP (echo_area_buffer
[0])
2683 /* Or empty message. */
2684 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2685 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2686 /* Or already echoing from same kboard. */
2687 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2688 /* Or not echoing before and echoing allowed. */
2689 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2691 /* After a mouse event, start echoing right away.
2692 This is because we are probably about to display a menu,
2693 and we don't want to delay before doing so. */
2694 if (EVENT_HAS_PARAMETERS (prev_event
))
2700 save_getcjmp (save_jump
);
2701 restore_getcjmp (local_getcjmp
);
2702 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2703 restore_getcjmp (save_jump
);
2705 && ! CONSP (Vunread_command_events
))
2710 /* Maybe auto save due to number of keystrokes. */
2712 if (commandflag
!= 0
2713 && auto_save_interval
> 0
2714 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2715 && !detect_input_pending_run_timers (0))
2717 Fdo_auto_save (Qnil
, Qnil
);
2718 /* Hooks can actually change some buffers in auto save. */
2722 /* Try reading using an X menu.
2723 This is never confused with reading using the minibuf
2724 because the recursive call of read_char in read_char_minibuf_menu_prompt
2725 does not pass on any keymaps. */
2727 if (nmaps
> 0 && INTERACTIVE
2728 && !NILP (prev_event
)
2729 && EVENT_HAS_PARAMETERS (prev_event
)
2730 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2731 && !EQ (XCAR (prev_event
), Qtool_bar
)
2732 /* Don't bring up a menu if we already have another event. */
2733 && NILP (Vunread_command_events
)
2734 && unread_command_char
< 0)
2736 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2738 /* Now that we have read an event, Emacs is not idle. */
2744 /* Maybe autosave and/or garbage collect due to idleness. */
2746 if (INTERACTIVE
&& NILP (c
))
2748 int delay_level
, buffer_size
;
2750 /* Slow down auto saves logarithmically in size of current buffer,
2751 and garbage collect while we're at it. */
2752 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2753 last_non_minibuf_size
= Z
- BEG
;
2754 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2756 while (buffer_size
> 64)
2757 delay_level
++, buffer_size
-= buffer_size
>> 2;
2758 if (delay_level
< 4) delay_level
= 4;
2759 /* delay_level is 4 for files under around 50k, 7 at 100k,
2760 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2762 /* Auto save if enough time goes by without input. */
2763 if (commandflag
!= 0
2764 && num_nonmacro_input_events
> last_auto_save
2765 && INTEGERP (Vauto_save_timeout
)
2766 && XINT (Vauto_save_timeout
) > 0)
2769 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2771 save_getcjmp (save_jump
);
2772 restore_getcjmp (local_getcjmp
);
2773 tem0
= sit_for (make_number (timeout
), 1, 1);
2774 restore_getcjmp (save_jump
);
2777 && ! CONSP (Vunread_command_events
))
2779 Fdo_auto_save (Qnil
, Qnil
);
2781 /* If we have auto-saved and there is still no input
2782 available, garbage collect if there has been enough
2783 consing going on to make it worthwhile. */
2784 if (!detect_input_pending_run_timers (0)
2785 && consing_since_gc
> gc_cons_threshold
/ 2)
2786 Fgarbage_collect ();
2793 /* If this has become non-nil here, it has been set by a timer
2794 or sentinel or filter. */
2795 if (CONSP (Vunread_command_events
))
2797 c
= XCAR (Vunread_command_events
);
2798 Vunread_command_events
= XCDR (Vunread_command_events
);
2801 /* Read something from current KBOARD's side queue, if possible. */
2805 if (current_kboard
->kbd_queue_has_data
)
2807 if (!CONSP (current_kboard
->kbd_queue
))
2809 c
= XCAR (current_kboard
->kbd_queue
);
2810 current_kboard
->kbd_queue
2811 = XCDR (current_kboard
->kbd_queue
);
2812 if (NILP (current_kboard
->kbd_queue
))
2813 current_kboard
->kbd_queue_has_data
= 0;
2814 input_pending
= readable_events (0);
2815 if (EVENT_HAS_PARAMETERS (c
)
2816 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2817 internal_last_event_frame
= XCAR (XCDR (c
));
2818 Vlast_event_frame
= internal_last_event_frame
;
2823 /* If current_kboard's side queue is empty check the other kboards.
2824 If one of them has data that we have not yet seen here,
2825 switch to it and process the data waiting for it.
2827 Note: if the events queued up for another kboard
2828 have already been seen here, and therefore are not a complete command,
2829 the kbd_queue_has_data field is 0, so we skip that kboard here.
2830 That's to avoid an infinite loop switching between kboards here. */
2831 if (NILP (c
) && !single_kboard
)
2834 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2835 if (kb
->kbd_queue_has_data
)
2837 current_kboard
= kb
;
2838 /* This is going to exit from read_char
2839 so we had better get rid of this frame's stuff. */
2841 longjmp (wrong_kboard_jmpbuf
, 1);
2850 /* Finally, we read from the main queue,
2851 and if that gives us something we can't use yet, we put it on the
2852 appropriate side queue and try again. */
2858 /* Actually read a character, waiting if necessary. */
2859 save_getcjmp (save_jump
);
2860 restore_getcjmp (local_getcjmp
);
2861 timer_start_idle ();
2862 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2863 restore_getcjmp (save_jump
);
2866 if (! NILP (c
) && (kb
!= current_kboard
))
2868 Lisp_Object link
= kb
->kbd_queue
;
2871 while (CONSP (XCDR (link
)))
2873 if (!NILP (XCDR (link
)))
2877 kb
->kbd_queue
= Fcons (c
, Qnil
);
2879 XSETCDR (link
, Fcons (c
, Qnil
));
2880 kb
->kbd_queue_has_data
= 1;
2884 current_kboard
= kb
;
2885 /* This is going to exit from read_char
2886 so we had better get rid of this frame's stuff. */
2888 longjmp (wrong_kboard_jmpbuf
, 1);
2893 /* Terminate Emacs in batch mode if at eof. */
2894 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2895 Fkill_emacs (make_number (1));
2899 /* Add in any extra modifiers, where appropriate. */
2900 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2901 || ((extra_keyboard_modifiers
& 0177) < ' '
2902 && (extra_keyboard_modifiers
& 0177) != 0))
2903 XSETINT (c
, make_ctrl_char (XINT (c
)));
2905 /* Transfer any other modifier bits directly from
2906 extra_keyboard_modifiers to c. Ignore the actual character code
2907 in the low 16 bits of extra_keyboard_modifiers. */
2908 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2918 if (commandflag
>= 0
2919 && !input_pending
&& !detect_input_pending_run_timers (0))
2927 /* Buffer switch events are only for internal wakeups
2928 so don't show them to the user.
2929 Also, don't record a key if we already did. */
2930 if (BUFFERP (c
) || key_already_recorded
)
2933 /* Process special events within read_char
2934 and loop around to read another event. */
2937 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2942 int was_locked
= single_kboard
;
2944 last_input_char
= c
;
2945 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2947 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2948 /* We stopped being idle for this event; undo that. This
2949 prevents automatic window selection (under
2950 mouse_autoselect_window from acting as a real input event, for
2951 example banishing the mouse under mouse-avoidance-mode. */
2952 timer_resume_idle ();
2954 /* Resume allowing input from any kboard, if that was true before. */
2956 any_kboard_state ();
2961 /* Handle things that only apply to characters. */
2964 /* If kbd_buffer_get_event gave us an EOF, return that. */
2968 if ((STRINGP (Vkeyboard_translate_table
)
2969 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2970 || (VECTORP (Vkeyboard_translate_table
)
2971 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2972 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2976 d
= Faref (Vkeyboard_translate_table
, c
);
2977 /* nil in keyboard-translate-table means no translation. */
2983 /* If this event is a mouse click in the menu bar,
2984 return just menu-bar for now. Modify the mouse click event
2985 so we won't do this twice, then queue it up. */
2986 if (EVENT_HAS_PARAMETERS (c
)
2988 && CONSP (EVENT_START (c
))
2989 && CONSP (XCDR (EVENT_START (c
))))
2993 posn
= POSN_POSN (EVENT_START (c
));
2994 /* Handle menu-bar events:
2995 insert the dummy prefix event `menu-bar'. */
2996 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2998 /* Change menu-bar to (menu-bar) as the event "position". */
2999 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3002 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3007 /* Store these characters into recent_keys, the dribble file if any,
3008 and the keyboard macro being defined, if any. */
3010 if (! NILP (also_record
))
3011 record_char (also_record
);
3013 /* Wipe the echo area.
3014 But first, if we are about to use an input method,
3015 save the echo area contents for it to refer to. */
3017 && ! NILP (Vinput_method_function
)
3018 && (unsigned) XINT (c
) >= ' '
3019 && (unsigned) XINT (c
) != 127
3020 && (unsigned) XINT (c
) < 256)
3022 previous_echo_area_message
= Fcurrent_message ();
3023 Vinput_method_previous_message
= previous_echo_area_message
;
3026 /* Now wipe the echo area, except for help events which do their
3027 own stuff with the echo area. */
3029 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3030 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3032 if (!NILP (echo_area_buffer
[0]))
3033 safe_run_hooks (Qecho_area_clear_hook
);
3034 clear_message (1, 0);
3037 reread_for_input_method
:
3039 /* Pass this to the input method, if appropriate. */
3041 && ! NILP (Vinput_method_function
)
3042 /* Don't run the input method within a key sequence,
3043 after the first event of the key sequence. */
3044 && NILP (prev_event
)
3045 && (unsigned) XINT (c
) >= ' '
3046 && (unsigned) XINT (c
) != 127
3047 && (unsigned) XINT (c
) < 256)
3050 int key_count
, key_count_reset
;
3051 struct gcpro gcpro1
;
3052 int count
= SPECPDL_INDEX ();
3054 /* Save the echo status. */
3055 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3056 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3057 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3058 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3061 if (before_command_restore_flag
)
3063 this_command_key_count
= before_command_key_count_1
;
3064 if (this_command_key_count
< this_single_command_key_start
)
3065 this_single_command_key_start
= this_command_key_count
;
3066 echo_truncate (before_command_echo_length_1
);
3067 before_command_restore_flag
= 0;
3071 /* Save the this_command_keys status. */
3072 key_count
= this_command_key_count
;
3073 key_count_reset
= this_command_key_count_reset
;
3076 keys
= Fcopy_sequence (this_command_keys
);
3081 /* Clear out this_command_keys. */
3082 this_command_key_count
= 0;
3083 this_command_key_count_reset
= 0;
3085 /* Now wipe the echo area. */
3086 if (!NILP (echo_area_buffer
[0]))
3087 safe_run_hooks (Qecho_area_clear_hook
);
3088 clear_message (1, 0);
3091 /* If we are not reading a key sequence,
3092 never use the echo area. */
3095 specbind (Qinput_method_use_echo_area
, Qt
);
3098 /* Call the input method. */
3099 tem
= call1 (Vinput_method_function
, c
);
3101 tem
= unbind_to (count
, tem
);
3103 /* Restore the saved echoing state
3104 and this_command_keys state. */
3105 this_command_key_count
= key_count
;
3106 this_command_key_count_reset
= key_count_reset
;
3108 this_command_keys
= keys
;
3111 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3112 current_kboard
->echo_string
= saved_echo_string
;
3113 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3114 if (saved_immediate_echo
)
3119 /* The input method can return no events. */
3122 /* Bring back the previous message, if any. */
3123 if (! NILP (previous_echo_area_message
))
3124 message_with_string ("%s", previous_echo_area_message
, 0);
3127 /* It returned one event or more. */
3129 Vunread_post_input_method_events
3130 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3135 /* Display help if not echoing. */
3136 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3138 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3139 Lisp_Object help
, object
, position
, window
, tem
;
3141 tem
= Fcdr (XCDR (c
));
3144 window
= Fcar (tem
);
3146 object
= Fcar (tem
);
3148 position
= Fcar (tem
);
3150 show_help_echo (help
, window
, object
, position
, 0);
3152 /* We stopped being idle for this event; undo that. */
3153 timer_resume_idle ();
3157 if (! reread
|| this_command_key_count
== 0
3158 || this_command_key_count_reset
)
3161 /* Don't echo mouse motion events. */
3162 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3163 && NILP (Fzerop (Vecho_keystrokes
))
3164 && ! (EVENT_HAS_PARAMETERS (c
)
3165 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3168 if (! NILP (also_record
))
3169 echo_char (also_record
);
3170 /* Once we reread a character, echoing can happen
3171 the next time we pause to read a new one. */
3172 ok_to_echo_at_next_pause
= current_kboard
;
3175 /* Record this character as part of the current key. */
3176 add_command_key (c
);
3177 if (! NILP (also_record
))
3178 add_command_key (also_record
);
3181 last_input_char
= c
;
3184 /* Process the help character specially if enabled */
3185 if (!NILP (Vhelp_form
) && help_char_p (c
))
3188 count
= SPECPDL_INDEX ();
3190 record_unwind_protect (Fset_window_configuration
,
3191 Fcurrent_window_configuration (Qnil
));
3193 tem0
= Feval (Vhelp_form
);
3195 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3199 c
= read_char (0, 0, 0, Qnil
, 0);
3200 while (BUFFERP (c
));
3201 /* Remove the help from the frame */
3202 unbind_to (count
, Qnil
);
3205 if (EQ (c
, make_number (040)))
3209 c
= read_char (0, 0, 0, Qnil
, 0);
3210 while (BUFFERP (c
));
3219 /* Record a key that came from a mouse menu.
3220 Record it for echoing, for this-command-keys, and so on. */
3226 /* Wipe the echo area. */
3227 clear_message (1, 0);
3232 before_command_key_count
= this_command_key_count
;
3233 before_command_echo_length
= echo_length ();
3236 /* Don't echo mouse motion events. */
3237 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3238 && NILP (Fzerop (Vecho_keystrokes
)))
3242 /* Once we reread a character, echoing can happen
3243 the next time we pause to read a new one. */
3244 ok_to_echo_at_next_pause
= 0;
3247 /* Record this character as part of the current key. */
3248 add_command_key (c
);
3250 /* Re-reading in the middle of a command */
3251 last_input_char
= c
;
3255 /* Return 1 if should recognize C as "the help character". */
3263 if (EQ (c
, Vhelp_char
))
3265 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3266 if (EQ (c
, XCAR (tail
)))
3271 /* Record the input event C in various ways. */
3279 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3281 /* To avoid filling recent_keys with help-echo and mouse-movement
3282 events, we filter out repeated help-echo events, only store the
3283 first and last in a series of mouse-movement events, and don't
3284 store repeated help-echo events which are only separated by
3285 mouse-movement events. */
3287 Lisp_Object ev1
, ev2
, ev3
;
3290 if ((ix1
= recent_keys_index
- 1) < 0)
3291 ix1
= NUM_RECENT_KEYS
- 1;
3292 ev1
= AREF (recent_keys
, ix1
);
3294 if ((ix2
= ix1
- 1) < 0)
3295 ix2
= NUM_RECENT_KEYS
- 1;
3296 ev2
= AREF (recent_keys
, ix2
);
3298 if ((ix3
= ix2
- 1) < 0)
3299 ix3
= NUM_RECENT_KEYS
- 1;
3300 ev3
= AREF (recent_keys
, ix3
);
3302 if (EQ (XCAR (c
), Qhelp_echo
))
3304 /* Don't record `help-echo' in recent_keys unless it shows some help
3305 message, and a different help than the previously recorded
3307 Lisp_Object help
, last_help
;
3309 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3310 if (!STRINGP (help
))
3312 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3313 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3315 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3316 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3317 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3319 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3320 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3321 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3322 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3325 else if (EQ (XCAR (c
), Qmouse_movement
))
3327 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3328 So additional mouse movement events replace the last element. */
3329 Lisp_Object last_window
, window
;
3331 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3332 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3333 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3334 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3335 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3337 ASET (recent_keys
, ix1
, c
);
3343 store_kbd_macro_char (c
);
3348 ASET (recent_keys
, recent_keys_index
, c
);
3349 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3350 recent_keys_index
= 0;
3352 else if (recorded
< 0)
3354 /* We need to remove one or two events from recent_keys.
3355 To do this, we simply put nil at those events and move the
3356 recent_keys_index backwards over those events. Usually,
3357 users will never see those nil events, as they will be
3358 overwritten by the command keys entered to see recent_keys
3361 while (recorded
++ < 0 && total_keys
> 0)
3363 if (total_keys
< NUM_RECENT_KEYS
)
3365 if (--recent_keys_index
< 0)
3366 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3367 ASET (recent_keys
, recent_keys_index
, Qnil
);
3371 num_nonmacro_input_events
++;
3373 /* Write c to the dribble file. If c is a lispy event, write
3374 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3375 If you, dear reader, have a better idea, you've got the source. :-) */
3380 if (XUINT (c
) < 0x100)
3381 putc (XINT (c
), dribble
);
3383 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3387 Lisp_Object dribblee
;
3389 /* If it's a structured event, take the event header. */
3390 dribblee
= EVENT_HEAD (c
);
3392 if (SYMBOLP (dribblee
))
3394 putc ('<', dribble
);
3395 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3396 SBYTES (SYMBOL_NAME (dribblee
)),
3398 putc ('>', dribble
);
3410 struct buffer
*old
= current_buffer
;
3411 Fprinc (object
, Qnil
);
3412 set_buffer_internal (XBUFFER (Vstandard_output
));
3413 call0 (intern ("help-mode"));
3414 set_buffer_internal (old
);
3418 /* Copy out or in the info on where C-g should throw to.
3419 This is used when running Lisp code from within get_char,
3420 in case get_char is called recursively.
3421 See read_process_output. */
3427 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3431 restore_getcjmp (temp
)
3434 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3439 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3440 of this function. */
3443 tracking_off (old_value
)
3444 Lisp_Object old_value
;
3446 do_mouse_tracking
= old_value
;
3447 if (NILP (old_value
))
3449 /* Redisplay may have been preempted because there was input
3450 available, and it assumes it will be called again after the
3451 input has been processed. If the only input available was
3452 the sort that we have just disabled, then we need to call
3454 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
3456 redisplay_preserve_echo_area (6);
3457 get_input_pending (&input_pending
,
3458 READABLE_EVENTS_DO_TIMERS_NOW
);
3464 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3465 doc
: /* Evaluate BODY with mouse movement events enabled.
3466 Within a `track-mouse' form, mouse motion generates input events that
3467 you can read with `read-event'.
3468 Normally, mouse motion is ignored.
3469 usage: (track-mouse BODY ...) */)
3473 int count
= SPECPDL_INDEX ();
3476 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3478 do_mouse_tracking
= Qt
;
3480 val
= Fprogn (args
);
3481 return unbind_to (count
, val
);
3484 /* If mouse has moved on some frame, return one of those frames.
3485 Return 0 otherwise. */
3490 Lisp_Object tail
, frame
;
3492 FOR_EACH_FRAME (tail
, frame
)
3494 if (XFRAME (frame
)->mouse_moved
)
3495 return XFRAME (frame
);
3501 #endif /* HAVE_MOUSE */
3503 /* Low level keyboard/mouse input.
3504 kbd_buffer_store_event places events in kbd_buffer, and
3505 kbd_buffer_get_event retrieves them. */
3507 /* Return true iff there are any events in the queue that read-char
3508 would return. If this returns false, a read-char would block. */
3510 readable_events (flags
)
3513 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3516 /* If the buffer contains only FOCUS_IN_EVENT events, and
3517 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3518 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3520 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3521 #ifdef USE_TOOLKIT_SCROLL_BARS
3522 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3526 struct input_event
*event
;
3528 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3535 #ifdef USE_TOOLKIT_SCROLL_BARS
3536 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3538 event
->kind
== FOCUS_IN_EVENT
)
3539 #ifdef USE_TOOLKIT_SCROLL_BARS
3540 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3541 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3542 && event
->part
== scroll_bar_handle
3543 && event
->modifiers
== 0)
3548 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3551 while (event
!= kbd_store_ptr
);
3558 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3559 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3564 if (current_kboard
->kbd_queue_has_data
)
3570 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3571 if (kb
->kbd_queue_has_data
)
3577 /* Set this for debugging, to have a way to get out */
3582 event_to_kboard (event
)
3583 struct input_event
*event
;
3586 frame
= event
->frame_or_window
;
3588 frame
= XCAR (frame
);
3589 else if (WINDOWP (frame
))
3590 frame
= WINDOW_FRAME (XWINDOW (frame
));
3592 /* There are still some events that don't set this field.
3593 For now, just ignore the problem.
3594 Also ignore dead frames here. */
3595 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3598 return FRAME_KBOARD (XFRAME (frame
));
3603 Lisp_Object Vthrow_on_input
;
3605 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3608 kbd_buffer_store_event (event
)
3609 register struct input_event
*event
;
3611 kbd_buffer_store_event_hold (event
, 0);
3614 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3616 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3617 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3618 Else, if EVENT is a quit event, store the quit event
3619 in HOLD_QUIT, and return (thus ignoring further events).
3621 This is used in read_avail_input to postpone the processing
3622 of the quit event until all subsequent input events have been
3623 parsed (and discarded).
3627 kbd_buffer_store_event_hold (event
, hold_quit
)
3628 register struct input_event
*event
;
3629 struct input_event
*hold_quit
;
3631 if (event
->kind
== NO_EVENT
)
3634 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3637 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3639 register int c
= event
->code
& 0377;
3641 if (event
->modifiers
& ctrl_modifier
)
3642 c
= make_ctrl_char (c
);
3644 c
|= (event
->modifiers
3645 & (meta_modifier
| alt_modifier
3646 | hyper_modifier
| super_modifier
));
3652 struct input_event
*sp
;
3655 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3656 kb
!= current_kboard
))
3659 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3660 Fcons (make_number (c
), Qnil
));
3661 kb
->kbd_queue_has_data
= 1;
3662 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3664 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3667 if (event_to_kboard (sp
) == kb
)
3669 sp
->kind
= NO_EVENT
;
3670 sp
->frame_or_window
= Qnil
;
3680 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3684 /* If this results in a quit_char being returned to Emacs as
3685 input, set Vlast_event_frame properly. If this doesn't
3686 get returned to Emacs as an event, the next event read
3687 will set Vlast_event_frame again, so this is safe to do. */
3691 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3693 focus
= event
->frame_or_window
;
3694 internal_last_event_frame
= focus
;
3695 Vlast_event_frame
= focus
;
3698 last_event_timestamp
= event
->timestamp
;
3699 interrupt_signal (0 /* dummy */);
3703 if (c
&& c
== stop_character
)
3709 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3710 Just ignore the second one. */
3711 else if (event
->kind
== BUFFER_SWITCH_EVENT
3712 && kbd_fetch_ptr
!= kbd_store_ptr
3713 && ((kbd_store_ptr
== kbd_buffer
3714 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3715 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3718 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3719 kbd_store_ptr
= kbd_buffer
;
3721 /* Don't let the very last slot in the buffer become full,
3722 since that would make the two pointers equal,
3723 and that is indistinguishable from an empty buffer.
3724 Discard the event if it would fill the last slot. */
3725 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3727 *kbd_store_ptr
= *event
;
3731 /* If we're inside while-no-input, and this event qualifies
3732 as input, set quit-flag to cause an interrupt. */
3733 if (!NILP (Vthrow_on_input
)
3734 && event
->kind
!= FOCUS_IN_EVENT
3735 && event
->kind
!= HELP_EVENT
3736 && event
->kind
!= DEICONIFY_EVENT
)
3738 Vquit_flag
= Vthrow_on_input
;
3739 /* If we're inside a function that wants immediate quits,
3741 if (immediate_quit
&& NILP (Vinhibit_quit
))
3751 /* Put an input event back in the head of the event queue. */
3754 kbd_buffer_unget_event (event
)
3755 register struct input_event
*event
;
3757 if (kbd_fetch_ptr
== kbd_buffer
)
3758 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3760 /* Don't let the very last slot in the buffer become full, */
3761 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3764 *kbd_fetch_ptr
= *event
;
3769 /* Generate HELP_EVENT input_events in BUFP which has room for
3770 SIZE events. If there's not enough room in BUFP, ignore this
3773 HELP is the help form.
3775 FRAME is the frame on which the help is generated. OBJECT is the
3776 Lisp object where the help was found (a buffer, a string, an
3777 overlay, or nil if neither from a string nor from a buffer. POS is
3778 the position within OBJECT where the help was found.
3780 Value is the number of input_events generated. */
3783 gen_help_event (help
, frame
, window
, object
, pos
)
3784 Lisp_Object help
, frame
, object
, window
;
3787 struct input_event event
;
3791 event
.kind
= HELP_EVENT
;
3792 event
.frame_or_window
= frame
;
3794 event
.x
= WINDOWP (window
) ? window
: frame
;
3797 kbd_buffer_store_event (&event
);
3801 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3804 kbd_buffer_store_help_event (frame
, help
)
3805 Lisp_Object frame
, help
;
3807 struct input_event event
;
3809 event
.kind
= HELP_EVENT
;
3810 event
.frame_or_window
= frame
;
3815 kbd_buffer_store_event (&event
);
3819 /* Discard any mouse events in the event buffer by setting them to
3822 discard_mouse_events ()
3824 struct input_event
*sp
;
3825 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3827 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3830 if (sp
->kind
== MOUSE_CLICK_EVENT
3831 || sp
->kind
== WHEEL_EVENT
3833 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3835 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3837 sp
->kind
= NO_EVENT
;
3843 /* Return non-zero if there are any real events waiting in the event
3844 buffer, not counting `NO_EVENT's.
3846 If DISCARD is non-zero, discard NO_EVENT events at the front of
3847 the input queue, possibly leaving the input queue empty if there
3848 are no real input events. */
3851 kbd_buffer_events_waiting (discard
)
3854 struct input_event
*sp
;
3856 for (sp
= kbd_fetch_ptr
;
3857 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3860 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3867 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3871 /* Clear input event EVENT. */
3875 struct input_event
*event
;
3877 event
->kind
= NO_EVENT
;
3881 /* Read one event from the event buffer, waiting if necessary.
3882 The value is a Lisp object representing the event.
3883 The value is nil for an event that should be ignored,
3884 or that was handled here.
3885 We always read and discard one event. */
3888 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3890 int *used_mouse_menu
;
3899 *kbp
= current_kboard
;
3903 /* Wait until there is input available. */
3906 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3909 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3913 /* If the quit flag is set, then read_char will return
3914 quit_char, so that counts as "available input." */
3915 if (!NILP (Vquit_flag
))
3916 quit_throw_to_read_char ();
3918 /* One way or another, wait until input is available; then, if
3919 interrupt handlers have not read it, read it now. */
3922 wait_for_kbd_input ();
3924 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3928 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3931 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3935 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3937 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3938 /* Pass 1 for EXPECT since we just waited to have input. */
3939 read_avail_input (1);
3941 #endif /* not VMS */
3944 if (CONSP (Vunread_command_events
))
3947 first
= XCAR (Vunread_command_events
);
3948 Vunread_command_events
= XCDR (Vunread_command_events
);
3949 *kbp
= current_kboard
;
3953 /* At this point, we know that there is a readable event available
3954 somewhere. If the event queue is empty, then there must be a
3955 mouse movement enabled and available. */
3956 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3958 struct input_event
*event
;
3960 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3964 last_event_timestamp
= event
->timestamp
;
3967 *kbp
= event_to_kboard (event
);
3969 *kbp
= current_kboard
; /* Better than returning null ptr? */
3971 *kbp
= &the_only_kboard
;
3976 /* These two kinds of events get special handling
3977 and don't actually appear to the command loop.
3978 We return nil for them. */
3979 if (event
->kind
== SELECTION_REQUEST_EVENT
3980 || event
->kind
== SELECTION_CLEAR_EVENT
)
3983 struct input_event copy
;
3985 /* Remove it from the buffer before processing it,
3986 since otherwise swallow_events will see it
3987 and process it again. */
3989 kbd_fetch_ptr
= event
+ 1;
3990 input_pending
= readable_events (0);
3991 x_handle_selection_event (©
);
3993 /* We're getting selection request events, but we don't have
3999 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4000 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4002 /* Make an event (delete-frame (FRAME)). */
4003 obj
= Fcons (event
->frame_or_window
, Qnil
);
4004 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4005 kbd_fetch_ptr
= event
+ 1;
4008 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4009 else if (event
->kind
== ICONIFY_EVENT
)
4011 /* Make an event (iconify-frame (FRAME)). */
4012 obj
= Fcons (event
->frame_or_window
, Qnil
);
4013 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4014 kbd_fetch_ptr
= event
+ 1;
4016 else if (event
->kind
== DEICONIFY_EVENT
)
4018 /* Make an event (make-frame-visible (FRAME)). */
4019 obj
= Fcons (event
->frame_or_window
, Qnil
);
4020 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4021 kbd_fetch_ptr
= event
+ 1;
4024 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4026 /* The value doesn't matter here; only the type is tested. */
4027 XSETBUFFER (obj
, current_buffer
);
4028 kbd_fetch_ptr
= event
+ 1;
4030 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4031 || defined (USE_GTK)
4032 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4034 kbd_fetch_ptr
= event
+ 1;
4035 input_pending
= readable_events (0);
4036 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4037 x_activate_menubar (XFRAME (event
->frame_or_window
));
4040 #if defined (WINDOWSNT) || defined (MAC_OS)
4041 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4044 /* Make an event (language-change (KEY_SCRIPT)). */
4045 obj
= Fcons (make_number (event
->code
), Qnil
);
4047 /* Make an event (language-change (FRAME CHARSET LCID)). */
4048 obj
= Fcons (event
->frame_or_window
, Qnil
);
4050 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4051 kbd_fetch_ptr
= event
+ 1;
4054 else if (event
->kind
== SAVE_SESSION_EVENT
)
4056 obj
= Fcons (Qsave_session
, Qnil
);
4057 kbd_fetch_ptr
= event
+ 1;
4059 /* Just discard these, by returning nil.
4060 With MULTI_KBOARD, these events are used as placeholders
4061 when we need to randomly delete events from the queue.
4062 (They shouldn't otherwise be found in the buffer,
4063 but on some machines it appears they do show up
4064 even without MULTI_KBOARD.) */
4065 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4066 mouse events during a popup-menu call. */
4067 else if (event
->kind
== NO_EVENT
)
4068 kbd_fetch_ptr
= event
+ 1;
4069 else if (event
->kind
== HELP_EVENT
)
4071 Lisp_Object object
, position
, help
, frame
, window
;
4073 frame
= event
->frame_or_window
;
4074 object
= event
->arg
;
4075 position
= make_number (event
->code
);
4078 clear_event (event
);
4080 kbd_fetch_ptr
= event
+ 1;
4081 if (!WINDOWP (window
))
4083 obj
= Fcons (Qhelp_echo
,
4084 list5 (frame
, help
, window
, object
, position
));
4086 else if (event
->kind
== FOCUS_IN_EVENT
)
4088 /* Notification of a FocusIn event. The frame receiving the
4089 focus is in event->frame_or_window. Generate a
4090 switch-frame event if necessary. */
4091 Lisp_Object frame
, focus
;
4093 frame
= event
->frame_or_window
;
4094 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4098 if (!EQ (frame
, internal_last_event_frame
)
4099 && !EQ (frame
, selected_frame
))
4100 obj
= make_lispy_switch_frame (frame
);
4101 internal_last_event_frame
= frame
;
4102 kbd_fetch_ptr
= event
+ 1;
4106 /* If this event is on a different frame, return a switch-frame this
4107 time, and leave the event in the queue for next time. */
4111 frame
= event
->frame_or_window
;
4113 frame
= XCAR (frame
);
4114 else if (WINDOWP (frame
))
4115 frame
= WINDOW_FRAME (XWINDOW (frame
));
4117 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4121 if (! EQ (frame
, internal_last_event_frame
)
4122 && !EQ (frame
, selected_frame
))
4123 obj
= make_lispy_switch_frame (frame
);
4124 internal_last_event_frame
= frame
;
4126 /* If we didn't decide to make a switch-frame event, go ahead
4127 and build a real event from the queue entry. */
4131 obj
= make_lispy_event (event
);
4133 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4134 || defined (USE_GTK)
4135 /* If this was a menu selection, then set the flag to inhibit
4136 writing to last_nonmenu_event. Don't do this if the event
4137 we're returning is (menu-bar), though; that indicates the
4138 beginning of the menu sequence, and we might as well leave
4139 that as the `event with parameters' for this selection. */
4141 && !EQ (event
->frame_or_window
, event
->arg
)
4142 && (event
->kind
== MENU_BAR_EVENT
4143 || event
->kind
== TOOL_BAR_EVENT
))
4144 *used_mouse_menu
= 1;
4147 /* Wipe out this event, to catch bugs. */
4148 clear_event (event
);
4149 kbd_fetch_ptr
= event
+ 1;
4154 /* Try generating a mouse motion event. */
4155 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4157 FRAME_PTR f
= some_mouse_moved ();
4158 Lisp_Object bar_window
;
4159 enum scroll_bar_part part
;
4163 *kbp
= current_kboard
;
4164 /* Note that this uses F to determine which display to look at.
4165 If there is no valid info, it does not store anything
4166 so x remains nil. */
4168 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4172 /* Decide if we should generate a switch-frame event. Don't
4173 generate switch-frame events for motion outside of all Emacs
4179 frame
= FRAME_FOCUS_FRAME (f
);
4181 XSETFRAME (frame
, f
);
4183 if (! EQ (frame
, internal_last_event_frame
)
4184 && !EQ (frame
, selected_frame
))
4185 obj
= make_lispy_switch_frame (frame
);
4186 internal_last_event_frame
= frame
;
4189 /* If we didn't decide to make a switch-frame event, go ahead and
4190 return a mouse-motion event. */
4191 if (!NILP (x
) && NILP (obj
))
4192 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4194 #endif /* HAVE_MOUSE */
4196 /* We were promised by the above while loop that there was
4197 something for us to read! */
4200 input_pending
= readable_events (0);
4202 Vlast_event_frame
= internal_last_event_frame
;
4207 /* Process any events that are not user-visible,
4208 then return, without reading any user-visible events. */
4211 swallow_events (do_display
)
4216 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4218 struct input_event
*event
;
4220 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4224 last_event_timestamp
= event
->timestamp
;
4226 /* These two kinds of events get special handling
4227 and don't actually appear to the command loop. */
4228 if (event
->kind
== SELECTION_REQUEST_EVENT
4229 || event
->kind
== SELECTION_CLEAR_EVENT
)
4232 struct input_event copy
;
4234 /* Remove it from the buffer before processing it,
4235 since otherwise swallow_events called recursively could see it
4236 and process it again. */
4238 kbd_fetch_ptr
= event
+ 1;
4239 input_pending
= readable_events (0);
4240 x_handle_selection_event (©
);
4242 /* We're getting selection request events, but we don't have
4251 old_timers_run
= timers_run
;
4252 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4254 if (timers_run
!= old_timers_run
&& do_display
)
4255 redisplay_preserve_echo_area (7);
4258 /* Record the start of when Emacs is idle,
4259 for the sake of running idle-time timers. */
4266 /* If we are already in the idle state, do nothing. */
4267 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4270 EMACS_GET_TIME (timer_idleness_start_time
);
4272 timer_last_idleness_start_time
= timer_idleness_start_time
;
4274 /* Mark all idle-time timers as once again candidates for running. */
4275 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4279 timer
= XCAR (timers
);
4281 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4283 XVECTOR (timer
)->contents
[0] = Qnil
;
4287 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4292 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4295 /* Resume idle timer from last idle start time. */
4298 timer_resume_idle ()
4300 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4303 timer_idleness_start_time
= timer_last_idleness_start_time
;
4306 /* This is only for debugging. */
4307 struct input_event last_timer_event
;
4309 /* Check whether a timer has fired. To prevent larger problems we simply
4310 disregard elements that are not proper timers. Do not make a circular
4311 timer list for the time being.
4313 Returns the number of seconds to wait until the next timer fires. If a
4314 timer is triggering now, return zero seconds.
4315 If no timer is active, return -1 seconds.
4317 If a timer is ripe, we run it, with quitting turned off.
4319 DO_IT_NOW is now ignored. It used to mean that we should
4320 run the timer directly instead of queueing a timer-event.
4321 Now we always run timers directly. */
4324 timer_check (do_it_now
)
4327 EMACS_TIME nexttime
;
4328 EMACS_TIME now
, idleness_now
;
4329 Lisp_Object timers
, idle_timers
, chosen_timer
;
4330 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4332 EMACS_SET_SECS (nexttime
, -1);
4333 EMACS_SET_USECS (nexttime
, -1);
4335 /* Always consider the ordinary timers. */
4336 timers
= Vtimer_list
;
4337 /* Consider the idle timers only if Emacs is idle. */
4338 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4339 idle_timers
= Vtimer_idle_list
;
4342 chosen_timer
= Qnil
;
4343 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4345 if (CONSP (timers
) || CONSP (idle_timers
))
4347 EMACS_GET_TIME (now
);
4348 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4349 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4352 while (CONSP (timers
) || CONSP (idle_timers
))
4354 Lisp_Object
*vector
;
4355 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4356 EMACS_TIME timer_time
, idle_timer_time
;
4357 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4359 /* Skip past invalid timers and timers already handled. */
4362 timer
= XCAR (timers
);
4363 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4365 timers
= XCDR (timers
);
4368 vector
= XVECTOR (timer
)->contents
;
4370 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4371 || !INTEGERP (vector
[3])
4372 || ! NILP (vector
[0]))
4374 timers
= XCDR (timers
);
4378 if (!NILP (idle_timers
))
4380 timer
= XCAR (idle_timers
);
4381 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4383 idle_timers
= XCDR (idle_timers
);
4386 vector
= XVECTOR (timer
)->contents
;
4388 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4389 || !INTEGERP (vector
[3])
4390 || ! NILP (vector
[0]))
4392 idle_timers
= XCDR (idle_timers
);
4397 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4398 based on the next ordinary timer.
4399 TIMER_DIFFERENCE is the distance in time from NOW to when
4400 this timer becomes ripe (negative if it's already ripe). */
4403 timer
= XCAR (timers
);
4404 vector
= XVECTOR (timer
)->contents
;
4405 EMACS_SET_SECS (timer_time
,
4406 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4407 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4408 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4411 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4412 based on the next idle timer. */
4413 if (!NILP (idle_timers
))
4415 idle_timer
= XCAR (idle_timers
);
4416 vector
= XVECTOR (idle_timer
)->contents
;
4417 EMACS_SET_SECS (idle_timer_time
,
4418 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4419 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4420 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4423 /* Decide which timer is the next timer,
4424 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4425 Also step down the list where we found that timer. */
4427 if (! NILP (timers
) && ! NILP (idle_timers
))
4430 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4431 if (EMACS_TIME_NEG_P (temp
))
4433 chosen_timer
= timer
;
4434 timers
= XCDR (timers
);
4435 difference
= timer_difference
;
4439 chosen_timer
= idle_timer
;
4440 idle_timers
= XCDR (idle_timers
);
4441 difference
= idle_timer_difference
;
4444 else if (! NILP (timers
))
4446 chosen_timer
= timer
;
4447 timers
= XCDR (timers
);
4448 difference
= timer_difference
;
4452 chosen_timer
= idle_timer
;
4453 idle_timers
= XCDR (idle_timers
);
4454 difference
= idle_timer_difference
;
4456 vector
= XVECTOR (chosen_timer
)->contents
;
4458 /* If timer is ripe, run it if it hasn't been run. */
4459 if (EMACS_TIME_NEG_P (difference
)
4460 || (EMACS_SECS (difference
) == 0
4461 && EMACS_USECS (difference
) == 0))
4463 if (NILP (vector
[0]))
4465 int was_locked
= single_kboard
;
4466 int count
= SPECPDL_INDEX ();
4467 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4469 /* Mark the timer as triggered to prevent problems if the lisp
4470 code fails to reschedule it right. */
4473 specbind (Qinhibit_quit
, Qt
);
4475 call1 (Qtimer_event_handler
, chosen_timer
);
4476 Vdeactivate_mark
= old_deactivate_mark
;
4478 unbind_to (count
, Qnil
);
4480 /* Resume allowing input from any kboard, if that was true before. */
4482 any_kboard_state ();
4484 /* Since we have handled the event,
4485 we don't need to tell the caller to wake up and do it. */
4489 /* When we encounter a timer that is still waiting,
4490 return the amount of time to wait before it is ripe. */
4497 /* No timers are pending in the future. */
4498 /* Return 0 if we generated an event, and -1 if not. */
4503 /* Caches for modify_event_symbol. */
4504 static Lisp_Object accent_key_syms
;
4505 static Lisp_Object func_key_syms
;
4506 static Lisp_Object mouse_syms
;
4507 static Lisp_Object wheel_syms
;
4508 static Lisp_Object drag_n_drop_syms
;
4510 /* This is a list of keysym codes for special "accent" characters.
4511 It parallels lispy_accent_keys. */
4513 static int lispy_accent_codes
[] =
4515 #ifdef XK_dead_circumflex
4520 #ifdef XK_dead_grave
4525 #ifdef XK_dead_tilde
4530 #ifdef XK_dead_diaeresis
4535 #ifdef XK_dead_macron
4540 #ifdef XK_dead_degree
4545 #ifdef XK_dead_acute
4550 #ifdef XK_dead_cedilla
4555 #ifdef XK_dead_breve
4560 #ifdef XK_dead_ogonek
4565 #ifdef XK_dead_caron
4570 #ifdef XK_dead_doubleacute
4571 XK_dead_doubleacute
,
4575 #ifdef XK_dead_abovedot
4580 #ifdef XK_dead_abovering
4590 #ifdef XK_dead_belowdot
4595 #ifdef XK_dead_voiced_sound
4596 XK_dead_voiced_sound
,
4600 #ifdef XK_dead_semivoiced_sound
4601 XK_dead_semivoiced_sound
,
4617 /* This is a list of Lisp names for special "accent" characters.
4618 It parallels lispy_accent_codes. */
4620 static char *lispy_accent_keys
[] =
4638 "dead-voiced-sound",
4639 "dead-semivoiced-sound",
4645 #define FUNCTION_KEY_OFFSET 0x0
4647 char *lispy_function_keys
[] =
4651 0, /* VK_LBUTTON 0x01 */
4652 0, /* VK_RBUTTON 0x02 */
4653 "cancel", /* VK_CANCEL 0x03 */
4654 0, /* VK_MBUTTON 0x04 */
4656 0, 0, 0, /* 0x05 .. 0x07 */
4658 "backspace", /* VK_BACK 0x08 */
4659 "tab", /* VK_TAB 0x09 */
4661 0, 0, /* 0x0A .. 0x0B */
4663 "clear", /* VK_CLEAR 0x0C */
4664 "return", /* VK_RETURN 0x0D */
4666 0, 0, /* 0x0E .. 0x0F */
4668 0, /* VK_SHIFT 0x10 */
4669 0, /* VK_CONTROL 0x11 */
4670 0, /* VK_MENU 0x12 */
4671 "pause", /* VK_PAUSE 0x13 */
4672 "capslock", /* VK_CAPITAL 0x14 */
4674 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4676 "escape", /* VK_ESCAPE 0x1B */
4678 0, 0, 0, 0, /* 0x1C .. 0x1F */
4680 0, /* VK_SPACE 0x20 */
4681 "prior", /* VK_PRIOR 0x21 */
4682 "next", /* VK_NEXT 0x22 */
4683 "end", /* VK_END 0x23 */
4684 "home", /* VK_HOME 0x24 */
4685 "left", /* VK_LEFT 0x25 */
4686 "up", /* VK_UP 0x26 */
4687 "right", /* VK_RIGHT 0x27 */
4688 "down", /* VK_DOWN 0x28 */
4689 "select", /* VK_SELECT 0x29 */
4690 "print", /* VK_PRINT 0x2A */
4691 "execute", /* VK_EXECUTE 0x2B */
4692 "snapshot", /* VK_SNAPSHOT 0x2C */
4693 "insert", /* VK_INSERT 0x2D */
4694 "delete", /* VK_DELETE 0x2E */
4695 "help", /* VK_HELP 0x2F */
4697 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4699 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4701 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4703 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4705 0, 0, 0, 0, 0, 0, 0, 0, 0,
4706 0, 0, 0, 0, 0, 0, 0, 0, 0,
4707 0, 0, 0, 0, 0, 0, 0, 0,
4709 "lwindow", /* VK_LWIN 0x5B */
4710 "rwindow", /* VK_RWIN 0x5C */
4711 "apps", /* VK_APPS 0x5D */
4713 0, 0, /* 0x5E .. 0x5F */
4715 "kp-0", /* VK_NUMPAD0 0x60 */
4716 "kp-1", /* VK_NUMPAD1 0x61 */
4717 "kp-2", /* VK_NUMPAD2 0x62 */
4718 "kp-3", /* VK_NUMPAD3 0x63 */
4719 "kp-4", /* VK_NUMPAD4 0x64 */
4720 "kp-5", /* VK_NUMPAD5 0x65 */
4721 "kp-6", /* VK_NUMPAD6 0x66 */
4722 "kp-7", /* VK_NUMPAD7 0x67 */
4723 "kp-8", /* VK_NUMPAD8 0x68 */
4724 "kp-9", /* VK_NUMPAD9 0x69 */
4725 "kp-multiply", /* VK_MULTIPLY 0x6A */
4726 "kp-add", /* VK_ADD 0x6B */
4727 "kp-separator", /* VK_SEPARATOR 0x6C */
4728 "kp-subtract", /* VK_SUBTRACT 0x6D */
4729 "kp-decimal", /* VK_DECIMAL 0x6E */
4730 "kp-divide", /* VK_DIVIDE 0x6F */
4731 "f1", /* VK_F1 0x70 */
4732 "f2", /* VK_F2 0x71 */
4733 "f3", /* VK_F3 0x72 */
4734 "f4", /* VK_F4 0x73 */
4735 "f5", /* VK_F5 0x74 */
4736 "f6", /* VK_F6 0x75 */
4737 "f7", /* VK_F7 0x76 */
4738 "f8", /* VK_F8 0x77 */
4739 "f9", /* VK_F9 0x78 */
4740 "f10", /* VK_F10 0x79 */
4741 "f11", /* VK_F11 0x7A */
4742 "f12", /* VK_F12 0x7B */
4743 "f13", /* VK_F13 0x7C */
4744 "f14", /* VK_F14 0x7D */
4745 "f15", /* VK_F15 0x7E */
4746 "f16", /* VK_F16 0x7F */
4747 "f17", /* VK_F17 0x80 */
4748 "f18", /* VK_F18 0x81 */
4749 "f19", /* VK_F19 0x82 */
4750 "f20", /* VK_F20 0x83 */
4751 "f21", /* VK_F21 0x84 */
4752 "f22", /* VK_F22 0x85 */
4753 "f23", /* VK_F23 0x86 */
4754 "f24", /* VK_F24 0x87 */
4756 0, 0, 0, 0, /* 0x88 .. 0x8B */
4757 0, 0, 0, 0, /* 0x8C .. 0x8F */
4759 "kp-numlock", /* VK_NUMLOCK 0x90 */
4760 "scroll", /* VK_SCROLL 0x91 */
4762 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4763 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4764 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4765 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4766 "kp-end", /* VK_NUMPAD_END 0x96 */
4767 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4768 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4769 "kp-up", /* VK_NUMPAD_UP 0x99 */
4770 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4771 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4772 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4773 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4775 0, 0, /* 0x9E .. 0x9F */
4778 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4779 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4780 * No other API or message will distinguish left and right keys this way.
4784 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4785 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4786 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4787 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4788 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4794 "attn", /* VK_ATTN 0xF6 */
4795 "crsel", /* VK_CRSEL 0xF7 */
4796 "exsel", /* VK_EXSEL 0xF8 */
4797 "ereof", /* VK_EREOF 0xF9 */
4798 "play", /* VK_PLAY 0xFA */
4799 "zoom", /* VK_ZOOM 0xFB */
4800 "noname", /* VK_NONAME 0xFC */
4801 "pa1", /* VK_PA1 0xFD */
4802 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4806 #else /* not HAVE_NTGUI */
4808 /* This should be dealt with in XTread_socket now, and that doesn't
4809 depend on the client system having the Kana syms defined. See also
4810 the XK_kana_A case below. */
4813 static char *lispy_kana_keys
[] =
4815 /* X Keysym value */
4816 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4817 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4818 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4819 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4820 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4821 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4822 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4823 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4824 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4825 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4826 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4827 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4828 "kana-i", "kana-u", "kana-e", "kana-o",
4829 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4830 "prolongedsound", "kana-A", "kana-I", "kana-U",
4831 "kana-E", "kana-O", "kana-KA", "kana-KI",
4832 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4833 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4834 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4835 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4836 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4837 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4838 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4839 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4840 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4841 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4842 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4843 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4845 #endif /* XK_kana_A */
4848 #define FUNCTION_KEY_OFFSET 0xff00
4850 /* You'll notice that this table is arranged to be conveniently
4851 indexed by X Windows keysym values. */
4852 static char *lispy_function_keys
[] =
4854 /* X Keysym value */
4856 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4857 "backspace", "tab", "linefeed", "clear",
4859 0, 0, 0, "pause", /* 0xff10...1f */
4860 0, 0, 0, 0, 0, 0, 0, "escape",
4862 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4863 "romaji", "hiragana", "katakana", "hiragana-katakana",
4864 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4865 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4866 "eisu-toggle", /* 0xff30...3f */
4867 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4868 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4870 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4871 "down", "prior", "next", "end",
4872 "begin", 0, 0, 0, 0, 0, 0, 0,
4873 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4884 "break", /* 0xff6b */
4887 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4888 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4889 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4890 0, 0, 0, 0, 0, 0, 0, 0,
4891 "kp-tab", /* 0xff89 */
4893 "kp-enter", /* 0xff8d */
4895 "kp-f1", /* 0xff91 */
4899 "kp-home", /* 0xff95 */
4904 "kp-prior", /* kp-page-up */
4905 "kp-next", /* kp-page-down */
4911 0, 0, 0, 0, 0, 0, 0, 0, 0,
4912 "kp-multiply", /* 0xffaa */
4917 "kp-divide", /* 0xffaf */
4918 "kp-0", /* 0xffb0 */
4919 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4922 "kp-equal", /* 0xffbd */
4923 "f1", /* 0xffbe */ /* IsFunctionKey */
4925 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4926 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4927 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4928 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4929 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4930 0, 0, 0, 0, 0, 0, 0, 0,
4931 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4932 0, 0, 0, 0, 0, 0, 0, "delete"
4935 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4936 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4938 static char *iso_lispy_function_keys
[] =
4940 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4941 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4942 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4943 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4944 "iso-lefttab", /* 0xfe20 */
4945 "iso-move-line-up", "iso-move-line-down",
4946 "iso-partial-line-up", "iso-partial-line-down",
4947 "iso-partial-space-left", "iso-partial-space-right",
4948 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4949 "iso-release-margin-left", "iso-release-margin-right",
4950 "iso-release-both-margins",
4951 "iso-fast-cursor-left", "iso-fast-cursor-right",
4952 "iso-fast-cursor-up", "iso-fast-cursor-down",
4953 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4954 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4957 #endif /* not HAVE_NTGUI */
4959 Lisp_Object Vlispy_mouse_stem
;
4961 static char *lispy_wheel_names
[] =
4963 "wheel-up", "wheel-down"
4966 /* drag-n-drop events are generated when a set of selected files are
4967 dragged from another application and dropped onto an Emacs window. */
4968 static char *lispy_drag_n_drop_names
[] =
4973 /* Scroll bar parts. */
4974 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4975 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4976 Lisp_Object Qtop
, Qratio
;
4978 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4979 Lisp_Object
*scroll_bar_parts
[] = {
4980 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4981 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4984 /* User signal events. */
4985 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4987 Lisp_Object
*lispy_user_signals
[] =
4989 &Qusr1_signal
, &Qusr2_signal
4993 /* A vector, indexed by button number, giving the down-going location
4994 of currently depressed buttons, both scroll bar and non-scroll bar.
4996 The elements have the form
4997 (BUTTON-NUMBER MODIFIER-MASK . REST)
4998 where REST is the cdr of a position as it would be reported in the event.
5000 The make_lispy_event function stores positions here to tell the
5001 difference between click and drag events, and to store the starting
5002 location to be included in drag events. */
5004 static Lisp_Object button_down_location
;
5006 /* Information about the most recent up-going button event: Which
5007 button, what location, and what time. */
5009 static int last_mouse_button
;
5010 static int last_mouse_x
;
5011 static int last_mouse_y
;
5012 static unsigned long button_down_time
;
5014 /* The maximum time between clicks to make a double-click, or Qnil to
5015 disable double-click detection, or Qt for no time limit. */
5017 Lisp_Object Vdouble_click_time
;
5019 /* Maximum number of pixels the mouse may be moved between clicks
5020 to make a double-click. */
5022 EMACS_INT double_click_fuzz
;
5024 /* The number of clicks in this multiple-click. */
5026 int double_click_count
;
5028 /* Return position of a mouse click or wheel event */
5031 make_lispy_position (f
, x
, y
, time
)
5037 enum window_part part
;
5038 Lisp_Object posn
= Qnil
;
5039 Lisp_Object extra_info
= Qnil
;
5042 /* Set `window' to the window under frame pixel coordinates (x,y) */
5044 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5045 &part
, &wx
, &wy
, 0);
5049 if (WINDOWP (window
))
5051 /* It's a click in window window at frame coordinates (x,y) */
5052 struct window
*w
= XWINDOW (window
);
5053 Lisp_Object string_info
= Qnil
;
5054 int textpos
= -1, rx
= -1, ry
= -1;
5055 int dx
= -1, dy
= -1;
5056 int width
= -1, height
= -1;
5057 Lisp_Object object
= Qnil
;
5059 /* Set event coordinates to window-relative coordinates
5060 for constructing the Lisp event below. */
5064 if (part
== ON_TEXT
)
5066 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5068 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5070 /* Mode line or header line. Look for a string under
5071 the mouse that may have a `local-map' property. */
5075 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5077 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5078 &object
, &dx
, &dy
, &width
, &height
);
5079 if (STRINGP (string
))
5080 string_info
= Fcons (string
, make_number (charpos
));
5081 if (w
== XWINDOW (selected_window
))
5084 textpos
= XMARKER (w
->pointm
)->charpos
;
5086 else if (part
== ON_VERTICAL_BORDER
)
5088 posn
= Qvertical_line
;
5093 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5098 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5100 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5101 &object
, &dx
, &dy
, &width
, &height
);
5102 if (STRINGP (string
))
5103 string_info
= Fcons (string
, make_number (charpos
));
5104 if (part
== ON_LEFT_MARGIN
)
5107 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5109 else if (part
== ON_LEFT_FRINGE
)
5111 posn
= Qleft_fringe
;
5114 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5116 : window_box_width (w
, LEFT_MARGIN_AREA
));
5119 else if (part
== ON_RIGHT_FRINGE
)
5121 posn
= Qright_fringe
;
5124 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5125 + window_box_width (w
, TEXT_AREA
)
5126 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5127 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5133 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5134 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5139 Lisp_Object string2
, object2
= Qnil
;
5140 struct display_pos p
;
5142 int width2
, height2
;
5143 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5144 &object2
, &dx2
, &dy2
,
5146 textpos
= CHARPOS (p
.pos
);
5147 if (rx
< 0) rx
= wx
;
5148 if (ry
< 0) ry
= wy
;
5149 if (dx
< 0) dx
= dx2
;
5150 if (dy
< 0) dy
= dy2
;
5151 if (width
< 0) width
= width2
;
5152 if (height
< 0) height
= height2
;
5156 posn
= make_number (textpos
);
5157 if (STRINGP (string2
))
5158 string_info
= Fcons (string2
,
5159 make_number (CHARPOS (p
.string_pos
)));
5165 #ifdef HAVE_WINDOW_SYSTEM
5166 if (IMAGEP (object
))
5168 Lisp_Object image_map
, hotspot
;
5169 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5171 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5173 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5174 posn
= XCAR (hotspot
);
5179 extra_info
= Fcons (object
,
5180 Fcons (Fcons (make_number (dx
),
5182 Fcons (Fcons (make_number (width
),
5183 make_number (height
)),
5187 extra_info
= Fcons (string_info
,
5188 Fcons (make_number (textpos
),
5189 Fcons (Fcons (make_number (rx
),
5195 XSETFRAME (window
, f
);
5200 XSETFASTINT (*x
, 0);
5201 XSETFASTINT (*y
, 0);
5204 return Fcons (window
,
5206 Fcons (Fcons (*x
, *y
),
5207 Fcons (make_number (time
),
5211 /* Given a struct input_event, build the lisp event which represents
5212 it. If EVENT is 0, build a mouse movement event from the mouse
5213 movement buffer, which should have a movement event in it.
5215 Note that events must be passed to this function in the order they
5216 are received; this function stores the location of button presses
5217 in order to build drag events when the button is released. */
5220 make_lispy_event (event
)
5221 struct input_event
*event
;
5225 switch (SWITCH_ENUM_CAST (event
->kind
))
5227 /* A simple keystroke. */
5228 case ASCII_KEYSTROKE_EVENT
:
5230 Lisp_Object lispy_c
;
5231 int c
= event
->code
& 0377;
5232 /* Turn ASCII characters into control characters
5234 if (event
->modifiers
& ctrl_modifier
)
5235 c
= make_ctrl_char (c
);
5237 /* Add in the other modifier bits. We took care of ctrl_modifier
5238 just above, and the shift key was taken care of by the X code,
5239 and applied to control characters by make_ctrl_char. */
5240 c
|= (event
->modifiers
5241 & (meta_modifier
| alt_modifier
5242 | hyper_modifier
| super_modifier
));
5243 /* Distinguish Shift-SPC from SPC. */
5244 if ((event
->code
& 0377) == 040
5245 && event
->modifiers
& shift_modifier
)
5246 c
|= shift_modifier
;
5247 button_down_time
= 0;
5248 XSETFASTINT (lispy_c
, c
);
5252 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5254 Lisp_Object lispy_c
;
5255 int c
= event
->code
;
5257 /* Add in the other modifier bits. We took care of ctrl_modifier
5258 just above, and the shift key was taken care of by the X code,
5259 and applied to control characters by make_ctrl_char. */
5260 c
|= (event
->modifiers
5261 & (meta_modifier
| alt_modifier
5262 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5263 /* What about the `shift' modifier ? */
5264 button_down_time
= 0;
5265 XSETFASTINT (lispy_c
, c
);
5269 /* A function key. The symbol may need to have modifier prefixes
5271 case NON_ASCII_KEYSTROKE_EVENT
:
5272 button_down_time
= 0;
5274 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5275 if (event
->code
== lispy_accent_codes
[i
])
5276 return modify_event_symbol (i
,
5278 Qfunction_key
, Qnil
,
5279 lispy_accent_keys
, &accent_key_syms
,
5280 (sizeof (lispy_accent_keys
)
5281 / sizeof (lispy_accent_keys
[0])));
5285 if (event
->code
>= 0x400 && event
->code
< 0x500)
5286 return modify_event_symbol (event
->code
- 0x400,
5287 event
->modifiers
& ~shift_modifier
,
5288 Qfunction_key
, Qnil
,
5289 lispy_kana_keys
, &func_key_syms
,
5290 (sizeof (lispy_kana_keys
)
5291 / sizeof (lispy_kana_keys
[0])));
5292 #endif /* XK_kana_A */
5295 #ifdef ISO_FUNCTION_KEY_OFFSET
5296 if (event
->code
< FUNCTION_KEY_OFFSET
5297 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5298 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5300 Qfunction_key
, Qnil
,
5301 iso_lispy_function_keys
, &func_key_syms
,
5302 (sizeof (iso_lispy_function_keys
)
5303 / sizeof (iso_lispy_function_keys
[0])));
5306 /* Handle system-specific or unknown keysyms. */
5307 if (event
->code
& (1 << 28)
5308 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5309 || (event
->code
- FUNCTION_KEY_OFFSET
5310 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5311 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5313 /* We need to use an alist rather than a vector as the cache
5314 since we can't make a vector long enuf. */
5315 if (NILP (current_kboard
->system_key_syms
))
5316 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5317 return modify_event_symbol (event
->code
,
5320 current_kboard
->Vsystem_key_alist
,
5321 0, ¤t_kboard
->system_key_syms
,
5325 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5327 Qfunction_key
, Qnil
,
5328 lispy_function_keys
, &func_key_syms
,
5329 (sizeof (lispy_function_keys
)
5330 / sizeof (lispy_function_keys
[0])));
5333 /* A mouse click. Figure out where it is, decide whether it's
5334 a press, click or drag, and build the appropriate structure. */
5335 case MOUSE_CLICK_EVENT
:
5336 #ifndef USE_TOOLKIT_SCROLL_BARS
5337 case SCROLL_BAR_CLICK_EVENT
:
5340 int button
= event
->code
;
5342 Lisp_Object position
;
5343 Lisp_Object
*start_pos_ptr
;
5344 Lisp_Object start_pos
;
5348 /* Build the position as appropriate for this mouse click. */
5349 if (event
->kind
== MOUSE_CLICK_EVENT
)
5351 struct frame
*f
= XFRAME (event
->frame_or_window
);
5352 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5356 /* Ignore mouse events that were made on frame that
5357 have been deleted. */
5358 if (! FRAME_LIVE_P (f
))
5361 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5362 /* EVENT->x and EVENT->y are frame-relative pixel
5363 coordinates at this place. Under old redisplay, COLUMN
5364 and ROW are set to frame relative glyph coordinates
5365 which are then used to determine whether this click is
5366 in a menu (non-toolkit version). */
5367 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5368 &column
, &row
, NULL
, 1);
5370 /* In the non-toolkit version, clicks on the menu bar
5371 are ordinary button events in the event buffer.
5372 Distinguish them, and invoke the menu.
5374 (In the toolkit version, the toolkit handles the menu bar
5375 and Emacs doesn't know about it until after the user
5376 makes a selection.) */
5377 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5378 && (event
->modifiers
& down_modifier
))
5380 Lisp_Object items
, item
;
5385 /* Activate the menu bar on the down event. If the
5386 up event comes in before the menu code can deal with it,
5388 if (! (event
->modifiers
& down_modifier
))
5392 /* Find the menu bar item under `column'. */
5394 items
= FRAME_MENU_BAR_ITEMS (f
);
5395 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5397 Lisp_Object pos
, string
;
5398 string
= AREF (items
, i
+ 1);
5399 pos
= AREF (items
, i
+ 3);
5402 if (column
>= XINT (pos
)
5403 && column
< XINT (pos
) + SCHARS (string
))
5405 item
= AREF (items
, i
);
5410 /* ELisp manual 2.4b says (x y) are window relative but
5411 code says they are frame-relative. */
5413 = Fcons (event
->frame_or_window
,
5415 Fcons (Fcons (event
->x
, event
->y
),
5416 Fcons (make_number (event
->timestamp
),
5419 return Fcons (item
, Fcons (position
, Qnil
));
5421 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5423 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5426 #ifndef USE_TOOLKIT_SCROLL_BARS
5429 /* It's a scrollbar click. */
5431 Lisp_Object portion_whole
;
5434 window
= event
->frame_or_window
;
5435 portion_whole
= Fcons (event
->x
, event
->y
);
5436 part
= *scroll_bar_parts
[(int) event
->part
];
5440 Fcons (Qvertical_scroll_bar
,
5441 Fcons (portion_whole
,
5442 Fcons (make_number (event
->timestamp
),
5443 Fcons (part
, Qnil
)))));
5445 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5447 if (button
>= ASIZE (button_down_location
))
5449 button_down_location
= larger_vector (button_down_location
,
5451 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5454 start_pos_ptr
= &AREF (button_down_location
, button
);
5455 start_pos
= *start_pos_ptr
;
5456 *start_pos_ptr
= Qnil
;
5459 /* On window-system frames, use the value of
5460 double-click-fuzz as is. On other frames, interpret it
5461 as a multiple of 1/8 characters. */
5465 if (WINDOWP (event
->frame_or_window
))
5466 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5467 else if (FRAMEP (event
->frame_or_window
))
5468 f
= XFRAME (event
->frame_or_window
);
5472 if (FRAME_WINDOW_P (f
))
5473 fuzz
= double_click_fuzz
;
5475 fuzz
= double_click_fuzz
/ 8;
5477 is_double
= (button
== last_mouse_button
5478 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5479 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5480 && button_down_time
!= 0
5481 && (EQ (Vdouble_click_time
, Qt
)
5482 || (INTEGERP (Vdouble_click_time
)
5483 && ((int)(event
->timestamp
- button_down_time
)
5484 < XINT (Vdouble_click_time
)))));
5487 last_mouse_button
= button
;
5488 last_mouse_x
= XINT (event
->x
);
5489 last_mouse_y
= XINT (event
->y
);
5491 /* If this is a button press, squirrel away the location, so
5492 we can decide later whether it was a click or a drag. */
5493 if (event
->modifiers
& down_modifier
)
5497 double_click_count
++;
5498 event
->modifiers
|= ((double_click_count
> 2)
5503 double_click_count
= 1;
5504 button_down_time
= event
->timestamp
;
5505 *start_pos_ptr
= Fcopy_alist (position
);
5508 /* Now we're releasing a button - check the co-ordinates to
5509 see if this was a click or a drag. */
5510 else if (event
->modifiers
& up_modifier
)
5512 /* If we did not see a down before this up, ignore the up.
5513 Probably this happened because the down event chose a
5514 menu item. It would be an annoyance to treat the
5515 release of the button that chose the menu item as a
5518 if (!CONSP (start_pos
))
5521 event
->modifiers
&= ~up_modifier
;
5522 #if 0 /* Formerly we treated an up with no down as a click event. */
5523 if (!CONSP (start_pos
))
5524 event
->modifiers
|= click_modifier
;
5529 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5531 /* The third element of every position
5532 should be the (x,y) pair. */
5533 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5535 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5537 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5538 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5541 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5542 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5543 /* Maybe the mouse has moved a lot, caused scrolling, and
5544 eventually ended up at the same screen position (but
5545 not buffer position) in which case it is a drag, not
5547 /* FIXME: OTOH if the buffer position has changed
5548 because of a timer or process filter rather than
5549 because of mouse movement, it should be considered as
5550 a click. But mouse-drag-region completely ignores
5551 this case and it hasn't caused any real problem, so
5552 it's probably OK to ignore it as well. */
5553 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5554 /* Mouse hasn't moved (much). */
5555 event
->modifiers
|= click_modifier
;
5558 button_down_time
= 0;
5559 event
->modifiers
|= drag_modifier
;
5562 /* Don't check is_double; treat this as multiple
5563 if the down-event was multiple. */
5564 if (double_click_count
> 1)
5565 event
->modifiers
|= ((double_click_count
> 2)
5571 /* Every mouse event should either have the down_modifier or
5572 the up_modifier set. */
5576 /* Get the symbol we should use for the mouse click. */
5579 head
= modify_event_symbol (button
,
5581 Qmouse_click
, Vlispy_mouse_stem
,
5584 XVECTOR (mouse_syms
)->size
);
5585 if (event
->modifiers
& drag_modifier
)
5590 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5593 Fcons (make_number (double_click_count
),
5604 Lisp_Object position
;
5607 /* Build the position as appropriate for this mouse click. */
5608 struct frame
*f
= XFRAME (event
->frame_or_window
);
5610 /* Ignore wheel events that were made on frame that have been
5612 if (! FRAME_LIVE_P (f
))
5615 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5618 /* Set double or triple modifiers to indicate the wheel speed. */
5620 /* On window-system frames, use the value of
5621 double-click-fuzz as is. On other frames, interpret it
5622 as a multiple of 1/8 characters. */
5627 if (WINDOWP (event
->frame_or_window
))
5628 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5629 else if (FRAMEP (event
->frame_or_window
))
5630 f
= XFRAME (event
->frame_or_window
);
5634 if (FRAME_WINDOW_P (f
))
5635 fuzz
= double_click_fuzz
;
5637 fuzz
= double_click_fuzz
/ 8;
5639 is_double
= (last_mouse_button
< 0
5640 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5641 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5642 && button_down_time
!= 0
5643 && (EQ (Vdouble_click_time
, Qt
)
5644 || (INTEGERP (Vdouble_click_time
)
5645 && ((int)(event
->timestamp
- button_down_time
)
5646 < XINT (Vdouble_click_time
)))));
5649 double_click_count
++;
5650 event
->modifiers
|= ((double_click_count
> 2)
5656 double_click_count
= 1;
5657 event
->modifiers
|= click_modifier
;
5660 button_down_time
= event
->timestamp
;
5661 /* Use a negative value to distinguish wheel from mouse button. */
5662 last_mouse_button
= -1;
5663 last_mouse_x
= XINT (event
->x
);
5664 last_mouse_y
= XINT (event
->y
);
5670 if (event
->modifiers
& up_modifier
)
5672 /* Emit a wheel-up event. */
5673 event
->modifiers
&= ~up_modifier
;
5676 else if (event
->modifiers
& down_modifier
)
5678 /* Emit a wheel-down event. */
5679 event
->modifiers
&= ~down_modifier
;
5683 /* Every wheel event should either have the down_modifier or
5684 the up_modifier set. */
5687 /* Get the symbol we should use for the wheel event. */
5688 head
= modify_event_symbol (symbol_num
,
5694 ASIZE (wheel_syms
));
5697 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5700 Fcons (make_number (double_click_count
),
5709 #ifdef USE_TOOLKIT_SCROLL_BARS
5711 /* We don't have down and up events if using toolkit scroll bars,
5712 so make this always a click event. Store in the `part' of
5713 the Lisp event a symbol which maps to the following actions:
5715 `above_handle' page up
5716 `below_handle' page down
5720 `bottom' bottom of buffer
5721 `handle' thumb has been dragged.
5722 `end-scroll' end of interaction with scroll bar
5724 The incoming input_event contains in its `part' member an
5725 index of type `enum scroll_bar_part' which we can use as an
5726 index in scroll_bar_parts to get the appropriate symbol. */
5728 case SCROLL_BAR_CLICK_EVENT
:
5730 Lisp_Object position
, head
, window
, portion_whole
, part
;
5732 window
= event
->frame_or_window
;
5733 portion_whole
= Fcons (event
->x
, event
->y
);
5734 part
= *scroll_bar_parts
[(int) event
->part
];
5738 Fcons (Qvertical_scroll_bar
,
5739 Fcons (portion_whole
,
5740 Fcons (make_number (event
->timestamp
),
5741 Fcons (part
, Qnil
)))));
5743 /* Always treat scroll bar events as clicks. */
5744 event
->modifiers
|= click_modifier
;
5745 event
->modifiers
&= ~up_modifier
;
5747 if (event
->code
>= ASIZE (mouse_syms
))
5748 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5750 /* Get the symbol we should use for the mouse click. */
5751 head
= modify_event_symbol (event
->code
,
5756 XVECTOR (mouse_syms
)->size
);
5757 return Fcons (head
, Fcons (position
, Qnil
));
5760 #endif /* USE_TOOLKIT_SCROLL_BARS */
5763 case W32_SCROLL_BAR_CLICK_EVENT
:
5765 int button
= event
->code
;
5767 Lisp_Object position
;
5768 Lisp_Object
*start_pos_ptr
;
5769 Lisp_Object start_pos
;
5773 Lisp_Object portion_whole
;
5776 window
= event
->frame_or_window
;
5777 portion_whole
= Fcons (event
->x
, event
->y
);
5778 part
= *scroll_bar_parts
[(int) event
->part
];
5782 Fcons (Qvertical_scroll_bar
,
5783 Fcons (portion_whole
,
5784 Fcons (make_number (event
->timestamp
),
5785 Fcons (part
, Qnil
)))));
5788 /* Always treat W32 scroll bar events as clicks. */
5789 event
->modifiers
|= click_modifier
;
5792 /* Get the symbol we should use for the mouse click. */
5795 head
= modify_event_symbol (button
,
5800 XVECTOR (mouse_syms
)->size
);
5806 #endif /* WINDOWSNT */
5808 case DRAG_N_DROP_EVENT
:
5811 Lisp_Object head
, position
;
5814 f
= XFRAME (event
->frame_or_window
);
5817 /* Ignore mouse events that were made on frames that
5818 have been deleted. */
5819 if (! FRAME_LIVE_P (f
))
5822 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5825 head
= modify_event_symbol (0, event
->modifiers
,
5827 lispy_drag_n_drop_names
,
5828 &drag_n_drop_syms
, 1);
5834 #endif /* HAVE_MOUSE */
5836 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5837 || defined (USE_GTK)
5838 case MENU_BAR_EVENT
:
5839 if (EQ (event
->arg
, event
->frame_or_window
))
5840 /* This is the prefix key. We translate this to
5841 `(menu_bar)' because the code in keyboard.c for menu
5842 events, which we use, relies on this. */
5843 return Fcons (Qmenu_bar
, Qnil
);
5847 case SELECT_WINDOW_EVENT
:
5848 /* Make an event (select-window (WINDOW)). */
5849 return Fcons (Qselect_window
,
5850 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5853 case TOOL_BAR_EVENT
:
5854 if (EQ (event
->arg
, event
->frame_or_window
))
5855 /* This is the prefix key. We translate this to
5856 `(tool_bar)' because the code in keyboard.c for tool bar
5857 events, which we use, relies on this. */
5858 return Fcons (Qtool_bar
, Qnil
);
5859 else if (SYMBOLP (event
->arg
))
5860 return apply_modifiers (event
->modifiers
, event
->arg
);
5863 case USER_SIGNAL_EVENT
:
5864 /* A user signal. */
5865 return *lispy_user_signals
[event
->code
];
5867 case SAVE_SESSION_EVENT
:
5868 return Qsave_session
;
5871 case MAC_APPLE_EVENT
:
5873 Lisp_Object spec
[2];
5877 return Fcons (Qmac_apple_event
,
5878 Fcons (Fvector (2, spec
),
5879 Fcons (event
->arg
, Qnil
)));
5883 /* The 'kind' field of the event is something we don't recognize. */
5892 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5894 Lisp_Object bar_window
;
5895 enum scroll_bar_part part
;
5899 /* Is it a scroll bar movement? */
5900 if (frame
&& ! NILP (bar_window
))
5902 Lisp_Object part_sym
;
5904 part_sym
= *scroll_bar_parts
[(int) part
];
5905 return Fcons (Qscroll_bar_movement
,
5906 (Fcons (Fcons (bar_window
,
5907 Fcons (Qvertical_scroll_bar
,
5908 Fcons (Fcons (x
, y
),
5909 Fcons (make_number (time
),
5915 /* Or is it an ordinary mouse movement? */
5918 Lisp_Object position
;
5920 position
= make_lispy_position (frame
, &x
, &y
, time
);
5922 return Fcons (Qmouse_movement
,
5928 #endif /* HAVE_MOUSE */
5930 /* Construct a switch frame event. */
5932 make_lispy_switch_frame (frame
)
5935 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5938 /* Manipulating modifiers. */
5940 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5942 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5943 SYMBOL's name of the end of the modifiers; the string from this
5944 position is the unmodified symbol name.
5946 This doesn't use any caches. */
5949 parse_modifiers_uncached (symbol
, modifier_end
)
5957 CHECK_SYMBOL (symbol
);
5960 name
= SYMBOL_NAME (symbol
);
5962 for (i
= 0; i
+2 <= SBYTES (name
); )
5964 int this_mod_end
= 0;
5967 /* See if the name continues with a modifier word.
5968 Check that the word appears, but don't check what follows it.
5969 Set this_mod and this_mod_end to record what we find. */
5971 switch (SREF (name
, i
))
5973 #define SINGLE_LETTER_MOD(BIT) \
5974 (this_mod_end = i + 1, this_mod = BIT)
5977 SINGLE_LETTER_MOD (alt_modifier
);
5981 SINGLE_LETTER_MOD (ctrl_modifier
);
5985 SINGLE_LETTER_MOD (hyper_modifier
);
5989 SINGLE_LETTER_MOD (meta_modifier
);
5993 SINGLE_LETTER_MOD (shift_modifier
);
5997 SINGLE_LETTER_MOD (super_modifier
);
6000 #undef SINGLE_LETTER_MOD
6002 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6003 if (i + LEN + 1 <= SBYTES (name) \
6004 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6006 this_mod_end = i + LEN; \
6011 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6012 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6013 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6017 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6019 #undef MULTI_LETTER_MOD
6023 /* If we found no modifier, stop looking for them. */
6024 if (this_mod_end
== 0)
6027 /* Check there is a dash after the modifier, so that it
6028 really is a modifier. */
6029 if (this_mod_end
>= SBYTES (name
)
6030 || SREF (name
, this_mod_end
) != '-')
6033 /* This modifier is real; look for another. */
6034 modifiers
|= this_mod
;
6035 i
= this_mod_end
+ 1;
6038 /* Should we include the `click' modifier? */
6039 if (! (modifiers
& (down_modifier
| drag_modifier
6040 | double_modifier
| triple_modifier
))
6041 && i
+ 7 == SBYTES (name
)
6042 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6043 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6044 modifiers
|= click_modifier
;
6052 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6053 prepended to the string BASE[0..BASE_LEN-1].
6054 This doesn't use any caches. */
6056 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6059 int base_len
, base_len_byte
;
6061 /* Since BASE could contain nulls, we can't use intern here; we have
6062 to use Fintern, which expects a genuine Lisp_String, and keeps a
6065 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6071 /* Only the event queue may use the `up' modifier; it should always
6072 be turned into a click or drag event before presented to lisp code. */
6073 if (modifiers
& up_modifier
)
6076 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6077 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6078 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6079 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6080 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6081 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6082 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6083 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6084 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6085 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6086 /* The click modifier is denoted by the absence of other modifiers. */
6090 mod_len
= p
- new_mods
;
6094 Lisp_Object new_name
;
6096 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6097 mod_len
+ base_len_byte
);
6098 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6099 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6101 return Fintern (new_name
, Qnil
);
6106 static char *modifier_names
[] =
6108 "up", "down", "drag", "click", "double", "triple", 0, 0,
6109 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6110 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6112 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6114 static Lisp_Object modifier_symbols
;
6116 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6118 lispy_modifier_list (modifiers
)
6121 Lisp_Object modifier_list
;
6124 modifier_list
= Qnil
;
6125 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6126 if (modifiers
& (1<<i
))
6127 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6130 return modifier_list
;
6134 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6135 where UNMODIFIED is the unmodified form of SYMBOL,
6136 MASK is the set of modifiers present in SYMBOL's name.
6137 This is similar to parse_modifiers_uncached, but uses the cache in
6138 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6139 Qevent_symbol_elements property. */
6142 parse_modifiers (symbol
)
6145 Lisp_Object elements
;
6147 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6148 if (CONSP (elements
))
6153 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6154 Lisp_Object unmodified
;
6157 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6158 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6161 if (modifiers
& ~INTMASK
)
6163 XSETFASTINT (mask
, modifiers
);
6164 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6166 /* Cache the parsing results on SYMBOL. */
6167 Fput (symbol
, Qevent_symbol_element_mask
,
6169 Fput (symbol
, Qevent_symbol_elements
,
6170 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6172 /* Since we know that SYMBOL is modifiers applied to unmodified,
6173 it would be nice to put that in unmodified's cache.
6174 But we can't, since we're not sure that parse_modifiers is
6181 /* Apply the modifiers MODIFIERS to the symbol BASE.
6182 BASE must be unmodified.
6184 This is like apply_modifiers_uncached, but uses BASE's
6185 Qmodifier_cache property, if present. It also builds
6186 Qevent_symbol_elements properties, since it has that info anyway.
6188 apply_modifiers copies the value of BASE's Qevent_kind property to
6189 the modified symbol. */
6191 apply_modifiers (modifiers
, base
)
6195 Lisp_Object cache
, index
, entry
, new_symbol
;
6197 /* Mask out upper bits. We don't know where this value's been. */
6198 modifiers
&= INTMASK
;
6200 /* The click modifier never figures into cache indices. */
6201 cache
= Fget (base
, Qmodifier_cache
);
6202 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6203 entry
= assq_no_quit (index
, cache
);
6206 new_symbol
= XCDR (entry
);
6209 /* We have to create the symbol ourselves. */
6210 new_symbol
= apply_modifiers_uncached (modifiers
,
6211 SDATA (SYMBOL_NAME (base
)),
6212 SCHARS (SYMBOL_NAME (base
)),
6213 SBYTES (SYMBOL_NAME (base
)));
6215 /* Add the new symbol to the base's cache. */
6216 entry
= Fcons (index
, new_symbol
);
6217 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6219 /* We have the parsing info now for free, so we could add it to
6221 XSETFASTINT (index, modifiers);
6222 Fput (new_symbol, Qevent_symbol_element_mask,
6223 Fcons (base, Fcons (index, Qnil)));
6224 Fput (new_symbol, Qevent_symbol_elements,
6225 Fcons (base, lispy_modifier_list (modifiers)));
6226 Sadly, this is only correct if `base' is indeed a base event,
6227 which is not necessarily the case. -stef */
6230 /* Make sure this symbol is of the same kind as BASE.
6232 You'd think we could just set this once and for all when we
6233 intern the symbol above, but reorder_modifiers may call us when
6234 BASE's property isn't set right; we can't assume that just
6235 because it has a Qmodifier_cache property it must have its
6236 Qevent_kind set right as well. */
6237 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6241 kind
= Fget (base
, Qevent_kind
);
6243 Fput (new_symbol
, Qevent_kind
, kind
);
6250 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6251 return a symbol with the modifiers placed in the canonical order.
6252 Canonical order is alphabetical, except for down and drag, which
6253 always come last. The 'click' modifier is never written out.
6255 Fdefine_key calls this to make sure that (for example) C-M-foo
6256 and M-C-foo end up being equivalent in the keymap. */
6259 reorder_modifiers (symbol
)
6262 /* It's hopefully okay to write the code this way, since everything
6263 will soon be in caches, and no consing will be done at all. */
6266 parsed
= parse_modifiers (symbol
);
6267 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6272 /* For handling events, we often want to produce a symbol whose name
6273 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6274 to some base, like the name of a function key or mouse button.
6275 modify_event_symbol produces symbols of this sort.
6277 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6278 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6281 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6282 into symbol names, or a string specifying a name stem used to
6283 construct a symbol name or the form `STEM-N', where N is the decimal
6284 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6285 non-nil; otherwise NAME_TABLE is used.
6287 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6288 persist between calls to modify_event_symbol that it can use to
6289 store a cache of the symbols it's generated for this NAME_TABLE
6290 before. The object stored there may be a vector or an alist.
6292 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6294 MODIFIERS is a set of modifier bits (as given in struct input_events)
6295 whose prefixes should be applied to the symbol name.
6297 SYMBOL_KIND is the value to be placed in the event_kind property of
6298 the returned symbol.
6300 The symbols we create are supposed to have an
6301 `event-symbol-elements' property, which lists the modifiers present
6302 in the symbol's name. */
6305 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6306 name_table
, symbol_table
, table_size
)
6309 Lisp_Object symbol_kind
;
6310 Lisp_Object name_alist_or_stem
;
6312 Lisp_Object
*symbol_table
;
6313 unsigned int table_size
;
6316 Lisp_Object symbol_int
;
6318 /* Get rid of the "vendor-specific" bit here. */
6319 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6321 /* Is this a request for a valid symbol? */
6322 if (symbol_num
< 0 || symbol_num
>= table_size
)
6325 if (CONSP (*symbol_table
))
6326 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6328 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6329 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6330 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6331 we've never used that symbol before. */
6334 if (! VECTORP (*symbol_table
)
6335 || XVECTOR (*symbol_table
)->size
!= table_size
)
6339 XSETFASTINT (size
, table_size
);
6340 *symbol_table
= Fmake_vector (size
, Qnil
);
6343 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6346 /* Have we already used this symbol before? */
6349 /* No; let's create it. */
6350 if (CONSP (name_alist_or_stem
))
6351 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6352 else if (STRINGP (name_alist_or_stem
))
6354 int len
= SBYTES (name_alist_or_stem
);
6355 char *buf
= (char *) alloca (len
+ 50);
6356 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6357 (long) XINT (symbol_int
) + 1);
6358 value
= intern (buf
);
6360 else if (name_table
!= 0 && name_table
[symbol_num
])
6361 value
= intern (name_table
[symbol_num
]);
6363 #ifdef HAVE_WINDOW_SYSTEM
6366 char *name
= x_get_keysym_name (symbol_num
);
6368 value
= intern (name
);
6375 sprintf (buf
, "key-%d", symbol_num
);
6376 value
= intern (buf
);
6379 if (CONSP (*symbol_table
))
6380 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6382 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6384 /* Fill in the cache entries for this symbol; this also
6385 builds the Qevent_symbol_elements property, which the user
6387 apply_modifiers (modifiers
& click_modifier
, value
);
6388 Fput (value
, Qevent_kind
, symbol_kind
);
6391 /* Apply modifiers to that symbol. */
6392 return apply_modifiers (modifiers
, value
);
6395 /* Convert a list that represents an event type,
6396 such as (ctrl meta backspace), into the usual representation of that
6397 event type as a number or a symbol. */
6399 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6400 doc
: /* Convert the event description list EVENT-DESC to an event type.
6401 EVENT-DESC should contain one base event type (a character or symbol)
6402 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6403 drag, down, double or triple). The base must be last.
6404 The return value is an event type (a character or symbol) which
6405 has the same base event type and all the specified modifiers. */)
6407 Lisp_Object event_desc
;
6415 while (CONSP (rest
))
6423 /* Given a symbol, see if it is a modifier name. */
6424 if (SYMBOLP (elt
) && CONSP (rest
))
6425 this = parse_solitary_modifier (elt
);
6429 else if (!NILP (base
))
6430 error ("Two bases given in one event");
6436 /* Let the symbol A refer to the character A. */
6437 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6438 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6440 if (INTEGERP (base
))
6442 /* Turn (shift a) into A. */
6443 if ((modifiers
& shift_modifier
) != 0
6444 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6446 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6447 modifiers
&= ~shift_modifier
;
6450 /* Turn (control a) into C-a. */
6451 if (modifiers
& ctrl_modifier
)
6452 return make_number ((modifiers
& ~ctrl_modifier
)
6453 | make_ctrl_char (XINT (base
)));
6455 return make_number (modifiers
| XINT (base
));
6457 else if (SYMBOLP (base
))
6458 return apply_modifiers (modifiers
, base
);
6461 error ("Invalid base event");
6466 /* Try to recognize SYMBOL as a modifier name.
6467 Return the modifier flag bit, or 0 if not recognized. */
6470 parse_solitary_modifier (symbol
)
6473 Lisp_Object name
= SYMBOL_NAME (symbol
);
6475 switch (SREF (name
, 0))
6477 #define SINGLE_LETTER_MOD(BIT) \
6478 if (SBYTES (name) == 1) \
6481 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6482 if (LEN == SBYTES (name) \
6483 && ! strncmp (SDATA (name), NAME, LEN)) \
6487 SINGLE_LETTER_MOD (alt_modifier
);
6491 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6495 SINGLE_LETTER_MOD (ctrl_modifier
);
6499 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6500 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6504 SINGLE_LETTER_MOD (hyper_modifier
);
6508 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6512 SINGLE_LETTER_MOD (meta_modifier
);
6516 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6520 SINGLE_LETTER_MOD (shift_modifier
);
6524 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6525 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6526 SINGLE_LETTER_MOD (super_modifier
);
6530 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6531 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6532 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6536 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6539 #undef SINGLE_LETTER_MOD
6540 #undef MULTI_LETTER_MOD
6546 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6547 Such a list is not valid as an event,
6548 but it can be a Lucid-style event type list. */
6551 lucid_event_type_list_p (object
)
6556 if (! CONSP (object
))
6559 if (EQ (XCAR (object
), Qhelp_echo
)
6560 || EQ (XCAR (object
), Qvertical_line
)
6561 || EQ (XCAR (object
), Qmode_line
)
6562 || EQ (XCAR (object
), Qheader_line
))
6565 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6569 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6576 /* Store into *addr a value nonzero if terminal input chars are available.
6577 Serves the purpose of ioctl (0, FIONREAD, addr)
6578 but works even if FIONREAD does not exist.
6579 (In fact, this may actually read some input.)
6581 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6582 timer events that are ripe.
6583 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6584 events (FOCUS_IN_EVENT).
6585 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6586 movements and toolkit scroll bar thumb drags. */
6589 get_input_pending (addr
, flags
)
6593 /* First of all, have we already counted some input? */
6594 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6596 /* If input is being read as it arrives, and we have none, there is none. */
6597 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6600 /* Try to read some input and see how much we get. */
6602 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6605 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6608 gobble_input (expected
)
6613 if (interrupt_input
)
6616 mask
= sigblock (sigmask (SIGIO
));
6617 read_avail_input (expected
);
6621 #ifdef POLL_FOR_INPUT
6622 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6625 mask
= sigblock (sigmask (SIGALRM
));
6626 read_avail_input (expected
);
6632 read_avail_input (expected
);
6636 /* Put a BUFFER_SWITCH_EVENT in the buffer
6637 so that read_key_sequence will notice the new current buffer. */
6640 record_asynch_buffer_change ()
6642 struct input_event event
;
6646 event
.kind
= BUFFER_SWITCH_EVENT
;
6647 event
.frame_or_window
= Qnil
;
6651 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6652 The purpose of the event is to make read_key_sequence look up the
6653 keymaps again. If we aren't in read_key_sequence, we don't need one,
6654 and the event could cause trouble by messing up (input-pending-p). */
6655 tem
= Fwaiting_for_user_input_p ();
6659 /* We never need these events if we have no asynchronous subprocesses. */
6663 /* Make sure no interrupt happens while storing the event. */
6665 if (interrupt_input
)
6668 mask
= sigblock (sigmask (SIGIO
));
6669 kbd_buffer_store_event (&event
);
6676 kbd_buffer_store_event (&event
);
6683 /* Read any terminal input already buffered up by the system
6684 into the kbd_buffer, but do not wait.
6686 EXPECTED should be nonzero if the caller knows there is some input.
6688 Except on VMS, all input is read by this function.
6689 If interrupt_input is nonzero, this function MUST be called
6690 only when SIGIO is blocked.
6692 Returns the number of keyboard chars read, or -1 meaning
6693 this is a bad time to try to read input. */
6696 read_avail_input (expected
)
6702 if (read_socket_hook
)
6705 struct input_event hold_quit
;
6707 EVENT_INIT (hold_quit
);
6708 hold_quit
.kind
= NO_EVENT
;
6710 /* No need for FIONREAD or fcntl; just say don't wait. */
6711 while (nr
= (*read_socket_hook
) (input_fd
, expected
, &hold_quit
), nr
> 0)
6716 if (hold_quit
.kind
!= NO_EVENT
)
6717 kbd_buffer_store_event (&hold_quit
);
6721 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6722 the kbd_buffer can really hold. That may prevent loss
6723 of characters on some systems when input is stuffed at us. */
6724 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6727 /* Determine how many characters we should *try* to read. */
6730 #else /* not WINDOWSNT */
6732 n_to_read
= dos_keysns ();
6735 #else /* not MSDOS */
6737 /* Find out how much input is available. */
6738 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6739 /* Formerly simply reported no input, but that sometimes led to
6740 a failure of Emacs to terminate.
6741 SIGHUP seems appropriate if we can't reach the terminal. */
6742 /* ??? Is it really right to send the signal just to this process
6743 rather than to the whole process group?
6744 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6746 if (! noninteractive
)
6747 kill (getpid (), SIGHUP
);
6753 if (n_to_read
> sizeof cbuf
)
6754 n_to_read
= sizeof cbuf
;
6755 #else /* no FIONREAD */
6756 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6757 /* Read some input if available, but don't wait. */
6758 n_to_read
= sizeof cbuf
;
6759 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6764 #endif /* not MSDOS */
6765 #endif /* not WINDOWSNT */
6767 /* Now read; for one reason or another, this will not block.
6768 NREAD is set to the number of chars read. */
6772 cbuf
[0] = dos_keyread ();
6775 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6777 /* POSIX infers that processes which are not in the session leader's
6778 process group won't get SIGHUP's at logout time. BSDI adheres to
6779 this part standard and returns -1 from read (0) with errno==EIO
6780 when the control tty is taken away.
6781 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6782 if (nread
== -1 && errno
== EIO
)
6784 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6785 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6786 This looks incorrect, but it isn't, because _BSD causes
6787 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6788 and that causes a value other than 0 when there is no input. */
6794 /* We used to retry the read if it was interrupted.
6795 But this does the wrong thing when O_NDELAY causes
6796 an EAGAIN error. Does anybody know of a situation
6797 where a retry is actually needed? */
6799 nread
< 0 && (errno
== EAGAIN
6813 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6814 fcntl (input_fd
, F_SETFL
, 0);
6815 #endif /* USG or DGUX or CYGWIN */
6816 #endif /* no FIONREAD */
6817 for (i
= 0; i
< nread
; i
++)
6819 struct input_event buf
;
6821 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6823 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6824 buf
.modifiers
= meta_modifier
;
6829 buf
.frame_or_window
= selected_frame
;
6832 kbd_buffer_store_event (&buf
);
6833 /* Don't look at input that follows a C-g too closely.
6834 This reduces lossage due to autorepeat on C-g. */
6835 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6836 && buf
.code
== quit_char
)
6843 #endif /* not VMS */
6846 handle_async_input ()
6849 extern int select_alarmed
;
6852 interrupt_input_pending
= 0;
6857 nread
= read_avail_input (1);
6858 /* -1 means it's not ok to read the input now.
6859 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6860 0 means there was no keyboard input available. */
6865 select_alarmed
= 1; /* Force the select emulator back to life */
6870 #ifdef SIGIO /* for entire page */
6871 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6874 input_available_signal (signo
)
6877 /* Must preserve main program's value of errno. */
6878 int old_errno
= errno
;
6879 #if defined (USG) && !defined (POSIX_SIGNALS)
6880 /* USG systems forget handlers when they are used;
6881 must reestablish each time */
6882 signal (signo
, input_available_signal
);
6890 interrupt_input_pending
= 1;
6892 SIGNAL_THREAD_CHECK (signo
);
6895 if (input_available_clear_time
)
6896 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6899 handle_async_input ();
6909 /* Send ourselves a SIGIO.
6911 This function exists so that the UNBLOCK_INPUT macro in
6912 blockinput.h can have some way to take care of input we put off
6913 dealing with, without assuming that every file which uses
6914 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6916 reinvoke_input_signal ()
6919 handle_async_input ();
6925 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6926 static Lisp_Object menu_bar_one_keymap_changed_items
;
6928 /* These variables hold the vector under construction within
6929 menu_bar_items and its subroutines, and the current index
6930 for storing into that vector. */
6931 static Lisp_Object menu_bar_items_vector
;
6932 static int menu_bar_items_index
;
6934 /* Return a vector of menu items for a menu bar, appropriate
6935 to the current buffer. Each item has three elements in the vector:
6938 OLD is an old vector we can optionally reuse, or nil. */
6941 menu_bar_items (old
)
6944 /* The number of keymaps we're scanning right now, and the number of
6945 keymaps we have allocated space for. */
6948 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6949 in the current keymaps, or nil where it is not a prefix. */
6952 Lisp_Object def
, tail
;
6961 /* In order to build the menus, we need to call the keymap
6962 accessors. They all call QUIT. But this function is called
6963 during redisplay, during which a quit is fatal. So inhibit
6964 quitting while building the menus.
6965 We do this instead of specbind because (1) errors will clear it anyway
6966 and (2) this avoids risk of specpdl overflow. */
6967 oquit
= Vinhibit_quit
;
6971 menu_bar_items_vector
= old
;
6973 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6974 menu_bar_items_index
= 0;
6976 /* Build our list of keymaps.
6977 If we recognize a function key and replace its escape sequence in
6978 keybuf with its symbol, or if the sequence starts with a mouse
6979 click and we need to switch buffers, we jump back here to rebuild
6980 the initial keymaps from the current buffer. */
6984 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6985 if (!NILP (Voverriding_local_map_menu_flag
))
6987 /* Yes, use them (if non-nil) as well as the global map. */
6988 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6990 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6991 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6992 if (!NILP (Voverriding_local_map
))
6993 maps
[nmaps
++] = Voverriding_local_map
;
6997 /* No, so use major and minor mode keymaps and keymap property.
6998 Note that menu-bar bindings in the local-map and keymap
6999 properties may not work reliable, as they are only
7000 recognized when the menu-bar (or mode-line) is updated,
7001 which does not normally happen after every command. */
7004 nminor
= current_minor_maps (NULL
, &tmaps
);
7005 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7007 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7008 maps
[nmaps
++] = tem
;
7009 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7011 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7013 maps
[nmaps
++] = current_global_map
;
7016 /* Look up in each map the dummy prefix key `menu-bar'. */
7020 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7021 if (!NILP (maps
[mapno
]))
7023 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7027 menu_bar_one_keymap_changed_items
= Qnil
;
7028 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7032 /* Move to the end those items that should be at the end. */
7034 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7037 int end
= menu_bar_items_index
;
7039 for (i
= 0; i
< end
; i
+= 4)
7040 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7042 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7043 /* Move the item at index I to the end,
7044 shifting all the others forward. */
7045 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7046 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7047 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7048 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7050 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7051 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7052 (end
- i
- 4) * sizeof (Lisp_Object
));
7053 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7054 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7055 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7056 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7061 /* Add nil, nil, nil, nil at the end. */
7062 i
= menu_bar_items_index
;
7063 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7066 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7067 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7068 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7069 menu_bar_items_vector
= tem
;
7071 /* Add this item. */
7072 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7073 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7074 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7075 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7076 menu_bar_items_index
= i
;
7078 Vinhibit_quit
= oquit
;
7079 return menu_bar_items_vector
;
7082 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7083 If there's already an item for KEY, add this DEF to it. */
7085 Lisp_Object item_properties
;
7088 menu_bar_item (key
, item
, dummy1
, dummy2
)
7089 Lisp_Object key
, item
, dummy1
;
7092 struct gcpro gcpro1
;
7096 if (EQ (item
, Qundefined
))
7098 /* If a map has an explicit `undefined' as definition,
7099 discard any previously made menu bar item. */
7101 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7102 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7104 if (menu_bar_items_index
> i
+ 4)
7105 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7106 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7107 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7108 menu_bar_items_index
-= 4;
7112 /* If this keymap has already contributed to this KEY,
7113 don't contribute to it a second time. */
7114 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7115 if (!NILP (tem
) || NILP (item
))
7118 menu_bar_one_keymap_changed_items
7119 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7121 /* We add to menu_bar_one_keymap_changed_items before doing the
7122 parse_menu_item, so that if it turns out it wasn't a menu item,
7123 it still correctly hides any further menu item. */
7125 i
= parse_menu_item (item
, 0, 1);
7130 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7132 /* Find any existing item for this KEY. */
7133 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7134 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7137 /* If we did not find this KEY, add it at the end. */
7138 if (i
== menu_bar_items_index
)
7140 /* If vector is too small, get a bigger one. */
7141 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7144 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7145 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7146 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7147 menu_bar_items_vector
= tem
;
7150 /* Add this item. */
7151 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7152 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7153 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7154 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7155 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7156 menu_bar_items_index
= i
;
7158 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7162 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7163 /* If the new and the old items are not both keymaps,
7164 the lookup will only find `item'. */
7165 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7166 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7170 /* This is used as the handler when calling menu_item_eval_property. */
7172 menu_item_eval_property_1 (arg
)
7175 /* If we got a quit from within the menu computation,
7176 quit all the way out of it. This takes care of C-] in the debugger. */
7177 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7178 Fsignal (Qquit
, Qnil
);
7183 /* Evaluate an expression and return the result (or nil if something
7184 went wrong). Used to evaluate dynamic parts of menu items. */
7186 menu_item_eval_property (sexpr
)
7189 int count
= SPECPDL_INDEX ();
7191 specbind (Qinhibit_redisplay
, Qt
);
7192 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7193 menu_item_eval_property_1
);
7194 return unbind_to (count
, val
);
7197 /* This function parses a menu item and leaves the result in the
7198 vector item_properties.
7199 ITEM is a key binding, a possible menu item.
7200 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7201 evaluate dynamic expressions in the menu item.
7202 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7204 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7205 parse_menu_item returns true if the item is a menu item and false
7209 parse_menu_item (item
, notreal
, inmenubar
)
7211 int notreal
, inmenubar
;
7213 Lisp_Object def
, tem
, item_string
, start
;
7214 Lisp_Object cachelist
;
7216 Lisp_Object keyhint
;
7227 /* Create item_properties vector if necessary. */
7228 if (NILP (item_properties
))
7230 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7232 /* Initialize optional entries. */
7233 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7234 AREF (item_properties
, i
) = Qnil
;
7235 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7237 /* Save the item here to protect it from GC. */
7238 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7240 item_string
= XCAR (item
);
7244 if (STRINGP (item_string
))
7246 /* Old format menu item. */
7247 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7249 /* Maybe help string. */
7250 if (CONSP (item
) && STRINGP (XCAR (item
)))
7252 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7257 /* Maybe key binding cache. */
7258 if (CONSP (item
) && CONSP (XCAR (item
))
7259 && (NILP (XCAR (XCAR (item
)))
7260 || VECTORP (XCAR (XCAR (item
)))))
7262 cachelist
= XCAR (item
);
7266 /* This is the real definition--the function to run. */
7267 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7269 /* Get enable property, if any. */
7272 tem
= Fget (item
, Qmenu_enable
);
7273 if (!NILP (Venable_disabled_menus_and_buttons
))
7274 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7275 else if (!NILP (tem
))
7276 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7279 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7281 /* New format menu item. */
7282 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7283 start
= XCDR (item
);
7286 /* We have a real binding. */
7287 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7289 item
= XCDR (start
);
7290 /* Is there a cache list with key equivalences. */
7291 if (CONSP (item
) && CONSP (XCAR (item
)))
7293 cachelist
= XCAR (item
);
7297 /* Parse properties. */
7298 while (CONSP (item
) && CONSP (XCDR (item
)))
7303 if (EQ (tem
, QCenable
))
7305 if (!NILP (Venable_disabled_menus_and_buttons
))
7306 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7308 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7310 else if (EQ (tem
, QCvisible
) && !notreal
)
7312 /* If got a visible property and that evaluates to nil
7313 then ignore this item. */
7314 tem
= menu_item_eval_property (XCAR (item
));
7318 else if (EQ (tem
, QChelp
))
7319 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7320 else if (EQ (tem
, QCfilter
))
7322 else if (EQ (tem
, QCkey_sequence
))
7325 if (NILP (cachelist
)
7326 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7327 /* Be GC protected. Set keyhint to item instead of tem. */
7330 else if (EQ (tem
, QCkeys
))
7333 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7334 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7336 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7341 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7343 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7345 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7352 else if (inmenubar
|| !NILP (start
))
7356 return 0; /* not a menu item */
7358 /* If item string is not a string, evaluate it to get string.
7359 If we don't get a string, skip this item. */
7360 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7361 if (!(STRINGP (item_string
) || notreal
))
7363 item_string
= menu_item_eval_property (item_string
);
7364 if (!STRINGP (item_string
))
7366 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7369 /* If got a filter apply it on definition. */
7370 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7373 def
= menu_item_eval_property (list2 (XCAR (filter
),
7374 list2 (Qquote
, def
)));
7376 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7379 /* Enable or disable selection of item. */
7380 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7386 tem
= menu_item_eval_property (tem
);
7387 if (inmenubar
&& NILP (tem
))
7388 return 0; /* Ignore disabled items in menu bar. */
7389 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7392 /* If we got no definition, this item is just unselectable text which
7393 is OK in a submenu but not in the menubar. */
7395 return (inmenubar
? 0 : 1);
7397 /* See if this is a separate pane or a submenu. */
7398 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7399 tem
= get_keymap (def
, 0, 1);
7400 /* For a subkeymap, just record its details and exit. */
7403 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7404 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7408 /* At the top level in the menu bar, do likewise for commands also.
7409 The menu bar does not display equivalent key bindings anyway.
7410 ITEM_PROPERTY_DEF is already set up properly. */
7414 /* This is a command. See if there is an equivalent key binding. */
7415 if (NILP (cachelist
))
7417 /* We have to create a cachelist. */
7418 CHECK_IMPURE (start
);
7419 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7420 cachelist
= XCAR (XCDR (start
));
7422 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7423 if (!NILP (keyhint
))
7425 XSETCAR (cachelist
, XCAR (keyhint
));
7428 else if (STRINGP (tem
))
7430 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7431 XSETCAR (cachelist
, Qt
);
7435 tem
= XCAR (cachelist
);
7442 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7444 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7447 def
= XCAR (prefix
);
7448 prefix
= XCDR (prefix
);
7451 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7453 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7455 if (newcache
/* Always check first time. */
7456 /* Should we check everything when precomputing key
7458 /* If something had no key binding before, don't recheck it
7459 because that is too slow--except if we have a list of
7460 rebound commands in Vdefine_key_rebound_commands, do
7461 recheck any command that appears in that list. */
7462 || (CONSP (Vdefine_key_rebound_commands
)
7463 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7466 /* We had a saved key. Is it still bound to the command? */
7469 /* If the command is an alias for another
7470 (such as lmenu.el set it up), check if the
7471 original command matches the cached command. */
7472 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7473 chkcache
= 1; /* Need to recompute key binding. */
7477 /* Recompute equivalent key binding. If the command is an alias
7478 for another (such as lmenu.el set it up), see if the original
7479 command name has equivalent keys. Otherwise look up the
7480 specified command itself. We don't try both, because that
7481 makes lmenu menus slow. */
7483 && SYMBOLP (XSYMBOL (def
)->function
)
7484 && ! NILP (Fget (def
, Qmenu_alias
)))
7485 def
= XSYMBOL (def
)->function
;
7486 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7487 XSETCAR (cachelist
, tem
);
7490 XSETCDR (cachelist
, Qnil
);
7494 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7496 tem
= XCAR (cachelist
);
7500 newcache
= chkcache
;
7503 tem
= Fkey_description (tem
, Qnil
);
7506 if (STRINGP (XCAR (prefix
)))
7507 tem
= concat2 (XCAR (prefix
), tem
);
7508 if (STRINGP (XCDR (prefix
)))
7509 tem
= concat2 (tem
, XCDR (prefix
));
7511 XSETCDR (cachelist
, tem
);
7515 tem
= XCDR (cachelist
);
7516 if (newcache
&& !NILP (tem
))
7518 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7519 XSETCDR (cachelist
, tem
);
7522 /* If we only want to precompute equivalent key bindings, stop here. */
7526 /* If we have an equivalent key binding, use that. */
7527 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7529 /* Include this when menu help is implemented.
7530 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7531 if (!(NILP (tem) || STRINGP (tem)))
7533 tem = menu_item_eval_property (tem);
7536 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7540 /* Handle radio buttons or toggle boxes. */
7541 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7543 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7544 = menu_item_eval_property (tem
);
7551 /***********************************************************************
7553 ***********************************************************************/
7555 /* A vector holding tool bar items while they are parsed in function
7556 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7559 static Lisp_Object tool_bar_items_vector
;
7561 /* A vector holding the result of parse_tool_bar_item. Layout is like
7562 the one for a single item in tool_bar_items_vector. */
7564 static Lisp_Object tool_bar_item_properties
;
7566 /* Next free index in tool_bar_items_vector. */
7568 static int ntool_bar_items
;
7570 /* The symbols `tool-bar', and `:image'. */
7572 extern Lisp_Object Qtool_bar
;
7573 Lisp_Object QCimage
;
7575 /* Function prototypes. */
7577 static void init_tool_bar_items
P_ ((Lisp_Object
));
7578 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7579 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7580 static void append_tool_bar_item
P_ ((void));
7583 /* Return a vector of tool bar items for keymaps currently in effect.
7584 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7585 tool bar items found. */
7588 tool_bar_items (reuse
, nitems
)
7599 /* In order to build the menus, we need to call the keymap
7600 accessors. They all call QUIT. But this function is called
7601 during redisplay, during which a quit is fatal. So inhibit
7602 quitting while building the menus. We do this instead of
7603 specbind because (1) errors will clear it anyway and (2) this
7604 avoids risk of specpdl overflow. */
7605 oquit
= Vinhibit_quit
;
7608 /* Initialize tool_bar_items_vector and protect it from GC. */
7609 init_tool_bar_items (reuse
);
7611 /* Build list of keymaps in maps. Set nmaps to the number of maps
7614 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7615 if (!NILP (Voverriding_local_map_menu_flag
))
7617 /* Yes, use them (if non-nil) as well as the global map. */
7618 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7620 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7621 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7622 if (!NILP (Voverriding_local_map
))
7623 maps
[nmaps
++] = Voverriding_local_map
;
7627 /* No, so use major and minor mode keymaps and keymap property.
7628 Note that tool-bar bindings in the local-map and keymap
7629 properties may not work reliable, as they are only
7630 recognized when the tool-bar (or mode-line) is updated,
7631 which does not normally happen after every command. */
7634 nminor
= current_minor_maps (NULL
, &tmaps
);
7635 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7637 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7638 maps
[nmaps
++] = tem
;
7639 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7641 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7644 /* Add global keymap at the end. */
7645 maps
[nmaps
++] = current_global_map
;
7647 /* Process maps in reverse order and look up in each map the prefix
7649 for (i
= nmaps
- 1; i
>= 0; --i
)
7650 if (!NILP (maps
[i
]))
7654 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7656 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7659 Vinhibit_quit
= oquit
;
7660 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7661 return tool_bar_items_vector
;
7665 /* Process the definition of KEY which is DEF. */
7668 process_tool_bar_item (key
, def
, data
, args
)
7669 Lisp_Object key
, def
, data
;
7673 extern Lisp_Object Qundefined
;
7674 struct gcpro gcpro1
, gcpro2
;
7676 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7680 if (EQ (def
, Qundefined
))
7682 /* If a map has an explicit `undefined' as definition,
7683 discard any previously made item. */
7684 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7686 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7688 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7690 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7691 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7692 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7693 * sizeof (Lisp_Object
)));
7694 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7699 else if (parse_tool_bar_item (key
, def
))
7700 /* Append a new tool bar item to tool_bar_items_vector. Accept
7701 more than one definition for the same key. */
7702 append_tool_bar_item ();
7708 /* Parse a tool bar item specification ITEM for key KEY and return the
7709 result in tool_bar_item_properties. Value is zero if ITEM is
7712 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7714 CAPTION is the caption of the item, If it's not a string, it is
7715 evaluated to get a string.
7717 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7718 as binding are currently ignored.
7720 The following properties are recognized:
7724 FORM is evaluated and specifies whether the tool bar item is
7725 enabled or disabled.
7729 FORM is evaluated and specifies whether the tool bar item is visible.
7731 - `:filter FUNCTION'
7733 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7734 result is stored as the new binding.
7736 - `:button (TYPE SELECTED)'
7738 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7739 and specifies whether the button is selected (pressed) or not.
7743 IMAGES is either a single image specification or a vector of four
7744 image specifications. See enum tool_bar_item_images.
7746 - `:help HELP-STRING'.
7748 Gives a help string to display for the tool bar item. */
7751 parse_tool_bar_item (key
, item
)
7752 Lisp_Object key
, item
;
7754 /* Access slot with index IDX of vector tool_bar_item_properties. */
7755 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7757 Lisp_Object filter
= Qnil
;
7758 Lisp_Object caption
;
7761 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7762 Rule out items that aren't lists, don't start with
7763 `menu-item' or whose rest following `tool-bar-item' is not a
7766 || !EQ (XCAR (item
), Qmenu_item
)
7767 || (item
= XCDR (item
),
7771 /* Create tool_bar_item_properties vector if necessary. Reset it to
7773 if (VECTORP (tool_bar_item_properties
))
7775 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7779 tool_bar_item_properties
7780 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7783 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7784 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7786 /* Get the caption of the item. If the caption is not a string,
7787 evaluate it to get a string. If we don't get a string, skip this
7789 caption
= XCAR (item
);
7790 if (!STRINGP (caption
))
7792 caption
= menu_item_eval_property (caption
);
7793 if (!STRINGP (caption
))
7796 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7798 /* Give up if rest following the caption is not a list. */
7803 /* Store the binding. */
7804 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7807 /* Ignore cached key binding, if any. */
7808 if (CONSP (item
) && CONSP (XCAR (item
)))
7811 /* Process the rest of the properties. */
7812 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7814 Lisp_Object key
, value
;
7817 value
= XCAR (XCDR (item
));
7819 if (EQ (key
, QCenable
))
7821 /* `:enable FORM'. */
7822 if (!NILP (Venable_disabled_menus_and_buttons
))
7823 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7825 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7827 else if (EQ (key
, QCvisible
))
7829 /* `:visible FORM'. If got a visible property and that
7830 evaluates to nil then ignore this item. */
7831 if (NILP (menu_item_eval_property (value
)))
7834 else if (EQ (key
, QChelp
))
7835 /* `:help HELP-STRING'. */
7836 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7837 else if (EQ (key
, QCfilter
))
7838 /* ':filter FORM'. */
7840 else if (EQ (key
, QCbutton
) && CONSP (value
))
7842 /* `:button (TYPE . SELECTED)'. */
7843 Lisp_Object type
, selected
;
7845 type
= XCAR (value
);
7846 selected
= XCDR (value
);
7847 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7849 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7850 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7853 else if (EQ (key
, QCimage
)
7855 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7856 /* Value is either a single image specification or a vector
7857 of 4 such specifications for the different button states. */
7858 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7861 /* If got a filter apply it on binding. */
7863 PROP (TOOL_BAR_ITEM_BINDING
)
7864 = menu_item_eval_property (list2 (filter
,
7866 PROP (TOOL_BAR_ITEM_BINDING
))));
7868 /* See if the binding is a keymap. Give up if it is. */
7869 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7872 /* Enable or disable selection of item. */
7873 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7874 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7875 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7877 /* Handle radio buttons or toggle boxes. */
7878 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7879 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7880 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7888 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7889 that can be reused. */
7892 init_tool_bar_items (reuse
)
7895 if (VECTORP (reuse
))
7896 tool_bar_items_vector
= reuse
;
7898 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7899 ntool_bar_items
= 0;
7903 /* Append parsed tool bar item properties from
7904 tool_bar_item_properties */
7907 append_tool_bar_item ()
7909 Lisp_Object
*to
, *from
;
7911 /* Enlarge tool_bar_items_vector if necessary. */
7912 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7913 >= XVECTOR (tool_bar_items_vector
)->size
)
7915 Lisp_Object new_vector
;
7916 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7918 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7919 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7920 XVECTOR (new_vector
)->contents
,
7921 old_size
* sizeof (Lisp_Object
));
7922 tool_bar_items_vector
= new_vector
;
7925 /* Append entries from tool_bar_item_properties to the end of
7926 tool_bar_items_vector. */
7927 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7928 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7929 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7930 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7937 /* Read a character using menus based on maps in the array MAPS.
7938 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7939 Return t if we displayed a menu but the user rejected it.
7941 PREV_EVENT is the previous input event, or nil if we are reading
7942 the first event of a key sequence.
7944 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7945 if we used a mouse menu to read the input, or zero otherwise. If
7946 USED_MOUSE_MENU is null, we don't dereference it.
7948 The prompting is done based on the prompt-string of the map
7949 and the strings associated with various map elements.
7951 This can be done with X menus or with menus put in the minibuf.
7952 These are done in different ways, depending on how the input will be read.
7953 Menus using X are done after auto-saving in read-char, getting the input
7954 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7955 and do auto-saving in the inner call of read_char. */
7958 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7961 Lisp_Object prev_event
;
7962 int *used_mouse_menu
;
7965 register Lisp_Object name
= Qnil
;
7967 if (used_mouse_menu
)
7968 *used_mouse_menu
= 0;
7970 /* Use local over global Menu maps */
7972 if (! menu_prompting
)
7975 /* Optionally disregard all but the global map. */
7976 if (inhibit_local_menu_bar_menus
)
7978 maps
+= (nmaps
- 1);
7982 /* Get the menu name from the first map that has one (a prompt string). */
7983 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7985 name
= Fkeymap_prompt (maps
[mapno
]);
7990 /* If we don't have any menus, just read a character normally. */
7991 if (!STRINGP (name
))
7995 /* If we got to this point via a mouse click,
7996 use a real menu for mouse selection. */
7997 if (EVENT_HAS_PARAMETERS (prev_event
)
7998 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7999 && !EQ (XCAR (prev_event
), Qtool_bar
))
8001 /* Display the menu and get the selection. */
8002 Lisp_Object
*realmaps
8003 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8007 /* Use the maps that are not nil. */
8008 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8009 if (!NILP (maps
[mapno
]))
8010 realmaps
[nmaps1
++] = maps
[mapno
];
8012 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8017 record_menu_key (XCAR (value
));
8019 /* If we got multiple events, unread all but
8021 There is no way to prevent those unread events
8022 from showing up later in last_nonmenu_event.
8023 So turn symbol and integer events into lists,
8024 to indicate that they came from a mouse menu,
8025 so that when present in last_nonmenu_event
8026 they won't confuse things. */
8027 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8029 record_menu_key (XCAR (tem
));
8030 if (SYMBOLP (XCAR (tem
))
8031 || INTEGERP (XCAR (tem
)))
8032 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8035 /* If we got more than one event, put all but the first
8036 onto this list to be read later.
8037 Return just the first event now. */
8038 Vunread_command_events
8039 = nconc2 (XCDR (value
), Vunread_command_events
);
8040 value
= XCAR (value
);
8042 else if (NILP (value
))
8044 if (used_mouse_menu
)
8045 *used_mouse_menu
= 1;
8048 #endif /* HAVE_MENUS */
8052 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8053 We make this bigger when necessary, and never free it. */
8054 static char *read_char_minibuf_menu_text
;
8055 /* Size of that buffer. */
8056 static int read_char_minibuf_menu_width
;
8059 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8065 register Lisp_Object name
;
8067 /* FIXME: Use the minibuffer's frame width. */
8068 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8071 Lisp_Object rest
, vector
;
8077 if (! menu_prompting
)
8080 /* Make sure we have a big enough buffer for the menu text. */
8081 if (read_char_minibuf_menu_text
== 0)
8083 read_char_minibuf_menu_width
= width
+ 4;
8084 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8086 else if (width
+ 4 > read_char_minibuf_menu_width
)
8088 read_char_minibuf_menu_width
= width
+ 4;
8089 read_char_minibuf_menu_text
8090 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8092 menu
= read_char_minibuf_menu_text
;
8094 /* Get the menu name from the first map that has one (a prompt string). */
8095 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8097 name
= Fkeymap_prompt (maps
[mapno
]);
8102 /* If we don't have any menus, just read a character normally. */
8103 if (!STRINGP (name
))
8106 /* Prompt string always starts with map's prompt, and a space. */
8107 strcpy (menu
, SDATA (name
));
8108 nlength
= SBYTES (name
);
8109 menu
[nlength
++] = ':';
8110 menu
[nlength
++] = ' ';
8113 /* Start prompting at start of first map. */
8117 /* Present the documented bindings, a line at a time. */
8124 Lisp_Object orig_defn_macro
;
8126 /* Loop over elements of map. */
8131 /* If reached end of map, start at beginning of next map. */
8135 /* At end of last map, wrap around to first map if just starting,
8136 or end this line if already have something on it. */
8140 if (notfirst
|| nobindings
) break;
8145 /* Look at the next element of the map. */
8147 elt
= XVECTOR (vector
)->contents
[idx
];
8149 elt
= Fcar_safe (rest
);
8151 if (idx
< 0 && VECTORP (elt
))
8153 /* If we found a dense table in the keymap,
8154 advanced past it, but start scanning its contents. */
8155 rest
= Fcdr_safe (rest
);
8161 /* An ordinary element. */
8162 Lisp_Object event
, tem
;
8166 event
= Fcar_safe (elt
); /* alist */
8167 elt
= Fcdr_safe (elt
);
8171 XSETINT (event
, idx
); /* vector */
8174 /* Ignore the element if it has no prompt string. */
8175 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8177 /* 1 if the char to type matches the string. */
8179 Lisp_Object upcased_event
, downcased_event
;
8180 Lisp_Object desc
= Qnil
;
8182 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8184 upcased_event
= Fupcase (event
);
8185 downcased_event
= Fdowncase (event
);
8186 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8187 || XINT (downcased_event
) == SREF (s
, 0));
8189 desc
= Fsingle_key_description (event
, Qnil
);
8191 #if 0 /* It is redundant to list the equivalent key bindings because
8192 the prefix is what the user has already typed. */
8194 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8196 /* Insert equivalent keybinding. */
8197 s
= concat2 (s
, tem
);
8200 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8201 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8203 /* Insert button prefix. */
8204 Lisp_Object selected
8205 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8206 if (EQ (tem
, QCradio
))
8207 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8209 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8210 s
= concat2 (tem
, s
);
8214 /* If we have room for the prompt string, add it to this line.
8215 If this is the first on the line, always add it. */
8216 if ((SCHARS (s
) + i
+ 2
8217 + (char_matches
? 0 : SCHARS (desc
) + 3))
8223 /* Punctuate between strings. */
8226 strcpy (menu
+ i
, ", ");
8232 /* If the char to type doesn't match the string's
8233 first char, explicitly show what char to type. */
8236 /* Add as much of string as fits. */
8237 thiswidth
= SCHARS (desc
);
8238 if (thiswidth
+ i
> width
)
8239 thiswidth
= width
- i
;
8240 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8242 strcpy (menu
+ i
, " = ");
8246 /* Add as much of string as fits. */
8247 thiswidth
= SCHARS (s
);
8248 if (thiswidth
+ i
> width
)
8249 thiswidth
= width
- i
;
8250 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8256 /* If this element does not fit, end the line now,
8257 and save the element for the next line. */
8258 strcpy (menu
+ i
, "...");
8263 /* Move past this element. */
8264 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8265 /* Handle reaching end of dense table. */
8270 rest
= Fcdr_safe (rest
);
8274 /* Prompt with that and read response. */
8275 message2_nolog (menu
, strlen (menu
),
8276 ! NILP (current_buffer
->enable_multibyte_characters
));
8278 /* Make believe its not a keyboard macro in case the help char
8279 is pressed. Help characters are not recorded because menu prompting
8280 is not used on replay.
8282 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8283 current_kboard
->defining_kbd_macro
= Qnil
;
8285 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8286 while (BUFFERP (obj
));
8287 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8289 if (!INTEGERP (obj
))
8294 if (! EQ (obj
, menu_prompt_more_char
)
8295 && (!INTEGERP (menu_prompt_more_char
)
8296 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8298 if (!NILP (current_kboard
->defining_kbd_macro
))
8299 store_kbd_macro_char (obj
);
8302 /* Help char - go round again */
8306 /* Reading key sequences. */
8308 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8309 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8310 keymap, or nil otherwise. Return the index of the first keymap in
8311 which KEY has any binding, or NMAPS if no map has a binding.
8313 If KEY is a meta ASCII character, treat it like meta-prefix-char
8314 followed by the corresponding non-meta character. Keymaps in
8315 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8318 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8321 NEXT may be the same array as CURRENT. */
8324 follow_key (key
, nmaps
, current
, defs
, next
)
8326 Lisp_Object
*current
, *defs
, *next
;
8329 int i
, first_binding
;
8331 first_binding
= nmaps
;
8332 for (i
= nmaps
- 1; i
>= 0; i
--)
8334 if (! NILP (current
[i
]))
8336 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8337 if (! NILP (defs
[i
]))
8344 /* Given the set of bindings we've found, produce the next set of maps. */
8345 if (first_binding
< nmaps
)
8346 for (i
= 0; i
< nmaps
; i
++)
8347 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8349 return first_binding
;
8352 /* Structure used to keep track of partial application of key remapping
8353 such as Vfunction_key_map and Vkey_translation_map. */
8354 typedef struct keyremap
8356 Lisp_Object map
, parent
;
8360 /* Lookup KEY in MAP.
8361 MAP is a keymap mapping keys to key vectors or functions.
8362 If the mapping is a function and DO_FUNCTION is non-zero, then
8363 the function is called with PROMPT as parameter and its return
8364 value is used as the return value of this function (after checking
8365 that it is indeed a vector). */
8368 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8369 Lisp_Object map
, key
, prompt
;
8374 next
= access_keymap (map
, key
, 1, 0, 1);
8376 /* Handle symbol with autoload definition. */
8377 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8378 && CONSP (XSYMBOL (next
)->function
)
8379 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8380 do_autoload (XSYMBOL (next
)->function
, next
);
8382 /* Handle a symbol whose function definition is a keymap
8384 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8385 && (ARRAYP (XSYMBOL (next
)->function
)
8386 || KEYMAPP (XSYMBOL (next
)->function
)))
8387 next
= XSYMBOL (next
)->function
;
8389 /* If the keymap gives a function, not an
8390 array, then call the function with one arg and use
8391 its value instead. */
8392 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8397 next
= call1 (next
, prompt
);
8398 /* If the function returned something invalid,
8399 barf--don't ignore it.
8400 (To ignore it safely, we would need to gcpro a bunch of
8401 other variables.) */
8402 if (! (VECTORP (next
) || STRINGP (next
)))
8403 error ("Function %s returns invalid key sequence", tem
);
8408 /* Do one step of the key remapping used for function-key-map and
8409 key-translation-map:
8410 KEYBUF is the buffer holding the input events.
8411 BUFSIZE is its maximum size.
8412 FKEY is a pointer to the keyremap structure to use.
8413 INPUT is the index of the last element in KEYBUF.
8414 DOIT if non-zero says that the remapping can actually take place.
8415 DIFF is used to return the number of keys added/removed by the remapping.
8416 PARENT is the root of the keymap.
8417 PROMPT is the prompt to use if the remapping happens through a function.
8418 The return value is non-zero if the remapping actually took place. */
8421 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8422 Lisp_Object
*keybuf
, prompt
;
8424 int input
, doit
, *diff
, bufsize
;
8426 Lisp_Object next
, key
;
8428 key
= keybuf
[fkey
->end
++];
8429 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8431 /* If keybuf[fkey->start..fkey->end] is bound in the
8432 map and we're in a position to do the key remapping, replace it with
8433 the binding and restart with fkey->start at the end. */
8434 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8436 int len
= XFASTINT (Flength (next
));
8439 *diff
= len
- (fkey
->end
- fkey
->start
);
8441 if (input
+ *diff
>= bufsize
)
8442 error ("Key sequence too long");
8444 /* Shift the keys that follow fkey->end. */
8446 for (i
= fkey
->end
; i
< input
; i
++)
8447 keybuf
[i
+ *diff
] = keybuf
[i
];
8449 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8450 keybuf
[i
+ *diff
] = keybuf
[i
];
8451 /* Overwrite the old keys with the new ones. */
8452 for (i
= 0; i
< len
; i
++)
8453 keybuf
[fkey
->start
+ i
]
8454 = Faref (next
, make_number (i
));
8456 fkey
->start
= fkey
->end
+= *diff
;
8457 fkey
->map
= fkey
->parent
;
8462 fkey
->map
= get_keymap (next
, 0, 1);
8464 /* If we no longer have a bound suffix, try a new position for
8466 if (!CONSP (fkey
->map
))
8468 fkey
->end
= ++fkey
->start
;
8469 fkey
->map
= fkey
->parent
;
8474 /* Read a sequence of keys that ends with a non prefix character,
8475 storing it in KEYBUF, a buffer of size BUFSIZE.
8477 Return the length of the key sequence stored.
8478 Return -1 if the user rejected a command menu.
8480 Echo starting immediately unless `prompt' is 0.
8482 Where a key sequence ends depends on the currently active keymaps.
8483 These include any minor mode keymaps active in the current buffer,
8484 the current buffer's local map, and the global map.
8486 If a key sequence has no other bindings, we check Vfunction_key_map
8487 to see if some trailing subsequence might be the beginning of a
8488 function key's sequence. If so, we try to read the whole function
8489 key, and substitute its symbolic name into the key sequence.
8491 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8492 `double-' events into similar click events, if that would make them
8493 bound. We try to turn `triple-' events first into `double-' events,
8496 If we get a mouse click in a mode line, vertical divider, or other
8497 non-text area, we treat the click as if it were prefixed by the
8498 symbol denoting that area - `mode-line', `vertical-line', or
8501 If the sequence starts with a mouse click, we read the key sequence
8502 with respect to the buffer clicked on, not the current buffer.
8504 If the user switches frames in the midst of a key sequence, we put
8505 off the switch-frame event until later; the next call to
8506 read_char will return it.
8508 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8509 from the selected window's buffer. */
8512 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8513 can_return_switch_frame
, fix_current_buffer
)
8514 Lisp_Object
*keybuf
;
8517 int dont_downcase_last
;
8518 int can_return_switch_frame
;
8519 int fix_current_buffer
;
8521 volatile Lisp_Object from_string
;
8522 volatile int count
= SPECPDL_INDEX ();
8524 /* How many keys there are in the current key sequence. */
8527 /* The length of the echo buffer when we started reading, and
8528 the length of this_command_keys when we started reading. */
8529 volatile int echo_start
;
8530 volatile int keys_start
;
8532 /* The number of keymaps we're scanning right now, and the number of
8533 keymaps we have allocated space for. */
8535 volatile int nmaps_allocated
= 0;
8537 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8538 the current keymaps. */
8539 Lisp_Object
*volatile defs
= NULL
;
8541 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8542 in the current keymaps, or nil where it is not a prefix. */
8543 Lisp_Object
*volatile submaps
= NULL
;
8545 /* The local map to start out with at start of key sequence. */
8546 volatile Lisp_Object orig_local_map
;
8548 /* The map from the `keymap' property to start out with at start of
8550 volatile Lisp_Object orig_keymap
;
8552 /* 1 if we have already considered switching to the local-map property
8553 of the place where a mouse click occurred. */
8554 volatile int localized_local_map
= 0;
8556 /* The index in defs[] of the first keymap that has a binding for
8557 this key sequence. In other words, the lowest i such that
8558 defs[i] is non-nil. */
8559 volatile int first_binding
;
8560 /* Index of the first key that has no binding.
8561 It is useless to try fkey.start larger than that. */
8562 volatile int first_unbound
;
8564 /* If t < mock_input, then KEYBUF[t] should be read as the next
8567 We use this to recover after recognizing a function key. Once we
8568 realize that a suffix of the current key sequence is actually a
8569 function key's escape sequence, we replace the suffix with the
8570 function key's binding from Vfunction_key_map. Now keybuf
8571 contains a new and different key sequence, so the echo area,
8572 this_command_keys, and the submaps and defs arrays are wrong. In
8573 this situation, we set mock_input to t, set t to 0, and jump to
8574 restart_sequence; the loop will read keys from keybuf up until
8575 mock_input, thus rebuilding the state; and then it will resume
8576 reading characters from the keyboard. */
8577 volatile int mock_input
= 0;
8579 /* If the sequence is unbound in submaps[], then
8580 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8581 and fkey.map is its binding.
8583 These might be > t, indicating that all function key scanning
8584 should hold off until t reaches them. We do this when we've just
8585 recognized a function key, to avoid searching for the function
8586 key's again in Vfunction_key_map. */
8587 volatile keyremap fkey
;
8589 /* Likewise, for key_translation_map. */
8590 volatile keyremap keytran
;
8592 /* If we receive a `switch-frame' or `select-window' event in the middle of
8593 a key sequence, we put it off for later.
8594 While we're reading, we keep the event here. */
8595 volatile Lisp_Object delayed_switch_frame
;
8597 /* See the comment below... */
8598 #if defined (GOBBLE_FIRST_EVENT)
8599 Lisp_Object first_event
;
8602 volatile Lisp_Object original_uppercase
;
8603 volatile int original_uppercase_position
= -1;
8605 /* Gets around Microsoft compiler limitations. */
8608 struct buffer
*starting_buffer
;
8610 /* List of events for which a fake prefix key has been generated. */
8611 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8613 #if defined (GOBBLE_FIRST_EVENT)
8617 struct gcpro gcpro1
;
8619 GCPRO1 (fake_prefixed_keys
);
8620 raw_keybuf_count
= 0;
8622 last_nonmenu_event
= Qnil
;
8624 delayed_switch_frame
= Qnil
;
8625 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8626 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8627 /* If there is no translation-map, turn off scanning. */
8628 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8629 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8634 echo_prompt (prompt
);
8635 else if (cursor_in_echo_area
8636 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8637 && NILP (Fzerop (Vecho_keystrokes
)))
8638 /* This doesn't put in a dash if the echo buffer is empty, so
8639 you don't always see a dash hanging out in the minibuffer. */
8643 /* Record the initial state of the echo area and this_command_keys;
8644 we will need to restore them if we replay a key sequence. */
8646 echo_start
= echo_length ();
8647 keys_start
= this_command_key_count
;
8648 this_single_command_key_start
= keys_start
;
8650 #if defined (GOBBLE_FIRST_EVENT)
8651 /* This doesn't quite work, because some of the things that read_char
8652 does cannot safely be bypassed. It seems too risky to try to make
8655 /* Read the first char of the sequence specially, before setting
8656 up any keymaps, in case a filter runs and switches buffers on us. */
8657 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8659 #endif /* GOBBLE_FIRST_EVENT */
8661 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8662 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8665 /* We jump here when the key sequence has been thoroughly changed, and
8666 we need to rescan it starting from the beginning. When we jump here,
8667 keybuf[0..mock_input] holds the sequence we should reread. */
8670 starting_buffer
= current_buffer
;
8671 first_unbound
= bufsize
+ 1;
8673 /* Build our list of keymaps.
8674 If we recognize a function key and replace its escape sequence in
8675 keybuf with its symbol, or if the sequence starts with a mouse
8676 click and we need to switch buffers, we jump back here to rebuild
8677 the initial keymaps from the current buffer. */
8680 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8681 || !NILP (Voverriding_local_map
))
8683 if (3 > nmaps_allocated
)
8685 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8686 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8687 nmaps_allocated
= 3;
8689 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8690 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8691 if (!NILP (Voverriding_local_map
))
8692 submaps
[nmaps
++] = Voverriding_local_map
;
8700 nminor
= current_minor_maps (0, &maps
);
8701 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8703 if (total
> nmaps_allocated
)
8705 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8706 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8707 nmaps_allocated
= total
;
8710 if (!NILP (orig_keymap
))
8711 submaps
[nmaps
++] = orig_keymap
;
8713 bcopy (maps
, (void *) (submaps
+ nmaps
),
8714 nminor
* sizeof (submaps
[0]));
8718 submaps
[nmaps
++] = orig_local_map
;
8720 submaps
[nmaps
++] = current_global_map
;
8722 /* Find an accurate initial value for first_binding. */
8723 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8724 if (! NILP (submaps
[first_binding
]))
8727 /* Start from the beginning in keybuf. */
8730 /* These are no-ops the first time through, but if we restart, they
8731 revert the echo area and this_command_keys to their original state. */
8732 this_command_key_count
= keys_start
;
8733 if (INTERACTIVE
&& t
< mock_input
)
8734 echo_truncate (echo_start
);
8736 /* If the best binding for the current key sequence is a keymap, or
8737 we may be looking at a function key's escape sequence, keep on
8739 while (first_binding
< nmaps
8740 /* Keep reading as long as there's a prefix binding. */
8741 ? !NILP (submaps
[first_binding
])
8742 /* Don't return in the middle of a possible function key sequence,
8743 if the only bindings we found were via case conversion.
8744 Thus, if ESC O a has a function-key-map translation
8745 and ESC o has a binding, don't return after ESC O,
8746 so that we can translate ESC O plus the next character. */
8747 : (fkey
.start
< t
|| keytran
.start
< t
))
8750 int used_mouse_menu
= 0;
8752 /* Where the last real key started. If we need to throw away a
8753 key that has expanded into more than one element of keybuf
8754 (say, a mouse click on the mode line which is being treated
8755 as [mode-line (mouse-...)], then we backtrack to this point
8757 volatile int last_real_key_start
;
8759 /* These variables are analogous to echo_start and keys_start;
8760 while those allow us to restart the entire key sequence,
8761 echo_local_start and keys_local_start allow us to throw away
8763 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8765 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8766 eassert (fkey
.start
<= fkey
.end
);
8767 eassert (keytran
.start
<= keytran
.end
);
8768 /* key-translation-map is applied *after* function-key-map. */
8769 eassert (keytran
.end
<= fkey
.start
);
8771 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8772 { /* The prefix upto first_unbound has no binding and has
8773 no translation left to do either, so we know it's unbound.
8774 If we don't stop now, we risk staying here indefinitely
8775 (if the user keeps entering fkey or keytran prefixes
8776 like C-c ESC ESC ESC ESC ...) */
8778 for (i
= first_unbound
+ 1; i
< t
; i
++)
8779 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8780 mock_input
= t
- first_unbound
- 1;
8781 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8782 fkey
.map
= fkey
.parent
;
8783 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8784 keytran
.map
= keytran
.parent
;
8785 goto replay_sequence
;
8789 error ("Key sequence too long");
8792 echo_local_start
= echo_length ();
8793 keys_local_start
= this_command_key_count
;
8794 local_first_binding
= first_binding
;
8797 /* These are no-ops, unless we throw away a keystroke below and
8798 jumped back up to replay_key; in that case, these restore the
8799 variables to their original state, allowing us to replay the
8801 if (INTERACTIVE
&& t
< mock_input
)
8802 echo_truncate (echo_local_start
);
8803 this_command_key_count
= keys_local_start
;
8804 first_binding
= local_first_binding
;
8806 /* By default, assume each event is "real". */
8807 last_real_key_start
= t
;
8809 /* Does mock_input indicate that we are re-reading a key sequence? */
8813 add_command_key (key
);
8814 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8815 && NILP (Fzerop (Vecho_keystrokes
)))
8819 /* If not, we should actually read a character. */
8824 KBOARD
*interrupted_kboard
= current_kboard
;
8825 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8826 if (setjmp (wrong_kboard_jmpbuf
))
8828 if (!NILP (delayed_switch_frame
))
8830 interrupted_kboard
->kbd_queue
8831 = Fcons (delayed_switch_frame
,
8832 interrupted_kboard
->kbd_queue
);
8833 delayed_switch_frame
= Qnil
;
8836 interrupted_kboard
->kbd_queue
8837 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8839 /* If the side queue is non-empty, ensure it begins with a
8840 switch-frame, so we'll replay it in the right context. */
8841 if (CONSP (interrupted_kboard
->kbd_queue
)
8842 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8843 !(EVENT_HAS_PARAMETERS (key
)
8844 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8848 XSETFRAME (frame
, interrupted_frame
);
8849 interrupted_kboard
->kbd_queue
8850 = Fcons (make_lispy_switch_frame (frame
),
8851 interrupted_kboard
->kbd_queue
);
8854 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8855 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8856 goto replay_sequence
;
8859 key
= read_char (NILP (prompt
), nmaps
,
8860 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8864 /* read_char returns t when it shows a menu and the user rejects it.
8868 unbind_to (count
, Qnil
);
8873 /* read_char returns -1 at the end of a macro.
8874 Emacs 18 handles this by returning immediately with a
8875 zero, so that's what we'll do. */
8876 if (INTEGERP (key
) && XINT (key
) == -1)
8879 /* The Microsoft C compiler can't handle the goto that
8885 /* If the current buffer has been changed from under us, the
8886 keymap may have changed, so replay the sequence. */
8889 timer_resume_idle ();
8892 /* Reset the current buffer from the selected window
8893 in case something changed the former and not the latter.
8894 This is to be more consistent with the behavior
8895 of the command_loop_1. */
8896 if (fix_current_buffer
)
8898 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8900 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8901 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8904 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8905 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8906 goto replay_sequence
;
8909 /* If we have a quit that was typed in another frame, and
8910 quit_throw_to_read_char switched buffers,
8911 replay to get the right keymap. */
8913 && XINT (key
) == quit_char
8914 && current_buffer
!= starting_buffer
)
8917 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8921 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8922 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8923 goto replay_sequence
;
8928 if (EVENT_HAS_PARAMETERS (key
)
8929 /* Either a `switch-frame' or a `select-window' event. */
8930 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8932 /* If we're at the beginning of a key sequence, and the caller
8933 says it's okay, go ahead and return this event. If we're
8934 in the midst of a key sequence, delay it until the end. */
8935 if (t
> 0 || !can_return_switch_frame
)
8937 delayed_switch_frame
= key
;
8943 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8946 /* Clicks in non-text areas get prefixed by the symbol
8947 in their CHAR-ADDRESS field. For example, a click on
8948 the mode line is prefixed by the symbol `mode-line'.
8950 Furthermore, key sequences beginning with mouse clicks
8951 are read using the keymaps of the buffer clicked on, not
8952 the current buffer. So we may have to switch the buffer
8955 When we turn one event into two events, we must make sure
8956 that neither of the two looks like the original--so that,
8957 if we replay the events, they won't be expanded again.
8958 If not for this, such reexpansion could happen either here
8959 or when user programs play with this-command-keys. */
8960 if (EVENT_HAS_PARAMETERS (key
))
8965 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8966 if (EQ (kind
, Qmouse_click
))
8968 Lisp_Object window
, posn
;
8970 window
= POSN_WINDOW (EVENT_START (key
));
8971 posn
= POSN_POSN (EVENT_START (key
));
8974 || (!NILP (fake_prefixed_keys
)
8975 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8977 /* We're looking a second time at an event for which
8978 we generated a fake prefix key. Set
8979 last_real_key_start appropriately. */
8981 last_real_key_start
= t
- 1;
8984 /* Key sequences beginning with mouse clicks are
8985 read using the keymaps in the buffer clicked on,
8986 not the current buffer. If we're at the
8987 beginning of a key sequence, switch buffers. */
8988 if (last_real_key_start
== 0
8990 && BUFFERP (XWINDOW (window
)->buffer
)
8991 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8993 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8997 /* Arrange to go back to the original buffer once we're
8998 done reading the key sequence. Note that we can't
8999 use save_excursion_{save,restore} here, because they
9000 save point as well as the current buffer; we don't
9001 want to save point, because redisplay may change it,
9002 to accommodate a Fset_window_start or something. We
9003 don't want to do this at the top of the function,
9004 because we may get input from a subprocess which
9005 wants to change the selected window and stuff (say,
9007 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9009 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9011 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9012 orig_local_map
= get_local_map (PT
, current_buffer
,
9014 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9015 goto replay_sequence
;
9018 /* For a mouse click, get the local text-property keymap
9019 of the place clicked on, rather than point. */
9020 if (last_real_key_start
== 0
9021 && CONSP (XCDR (key
))
9022 && ! localized_local_map
)
9024 Lisp_Object map_here
, start
, pos
;
9026 localized_local_map
= 1;
9027 start
= EVENT_START (key
);
9029 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9031 pos
= POSN_BUFFER_POSN (start
);
9033 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9035 map_here
= get_local_map (XINT (pos
),
9036 current_buffer
, Qlocal_map
);
9037 if (!EQ (map_here
, orig_local_map
))
9039 orig_local_map
= map_here
;
9043 goto replay_sequence
;
9045 map_here
= get_local_map (XINT (pos
),
9046 current_buffer
, Qkeymap
);
9047 if (!EQ (map_here
, orig_keymap
))
9049 orig_keymap
= map_here
;
9053 goto replay_sequence
;
9059 /* Expand mode-line and scroll-bar events into two events:
9060 use posn as a fake prefix key. */
9062 && (NILP (fake_prefixed_keys
)
9063 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9065 if (t
+ 1 >= bufsize
)
9066 error ("Key sequence too long");
9069 keybuf
[t
+ 1] = key
;
9072 /* Record that a fake prefix key has been generated
9073 for KEY. Don't modify the event; this would
9074 prevent proper action when the event is pushed
9075 back into unread-command-events. */
9076 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9078 /* If on a mode line string with a local keymap,
9079 reconsider the key sequence with that keymap. */
9080 if (string
= POSN_STRING (EVENT_START (key
)),
9081 (CONSP (string
) && STRINGP (XCAR (string
))))
9083 Lisp_Object pos
, map
, map2
;
9085 pos
= XCDR (string
);
9086 string
= XCAR (string
);
9088 && XINT (pos
) < SCHARS (string
))
9090 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9092 orig_local_map
= map
;
9093 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9096 if (!NILP (map
) || !NILP (map2
))
9097 goto replay_sequence
;
9103 else if (NILP (from_string
)
9104 && (string
= POSN_STRING (EVENT_START (key
)),
9105 (CONSP (string
) && STRINGP (XCAR (string
)))))
9107 /* For a click on a string, i.e. overlay string or a
9108 string displayed via the `display' property,
9109 consider `local-map' and `keymap' properties of
9111 Lisp_Object pos
, map
, map2
;
9113 pos
= XCDR (string
);
9114 string
= XCAR (string
);
9116 && XINT (pos
) < SCHARS (string
))
9118 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9120 orig_local_map
= map
;
9121 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9125 if (!NILP (map
) || !NILP (map2
))
9127 from_string
= string
;
9128 goto replay_sequence
;
9133 else if (CONSP (XCDR (key
))
9134 && CONSP (EVENT_START (key
))
9135 && CONSP (XCDR (EVENT_START (key
))))
9139 posn
= POSN_POSN (EVENT_START (key
));
9140 /* Handle menu-bar events:
9141 insert the dummy prefix event `menu-bar'. */
9142 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9144 if (t
+ 1 >= bufsize
)
9145 error ("Key sequence too long");
9149 /* Zap the position in key, so we know that we've
9150 expanded it, and don't try to do so again. */
9151 POSN_SET_POSN (EVENT_START (key
),
9152 Fcons (posn
, Qnil
));
9155 goto replay_sequence
;
9157 else if (CONSP (posn
))
9159 /* We're looking at the second event of a
9160 sequence which we expanded before. Set
9161 last_real_key_start appropriately. */
9162 if (last_real_key_start
== t
&& t
> 0)
9163 last_real_key_start
= t
- 1;
9168 /* We have finally decided that KEY is something we might want
9170 first_binding
= (follow_key (key
,
9171 nmaps
- first_binding
,
9172 submaps
+ first_binding
,
9173 defs
+ first_binding
,
9174 submaps
+ first_binding
)
9177 /* If KEY wasn't bound, we'll try some fallbacks. */
9178 if (first_binding
< nmaps
)
9179 /* This is needed for the following scenario:
9180 event 0: a down-event that gets dropped by calling replay_key.
9181 event 1: some normal prefix like C-h.
9182 After event 0, first_unbound is 0, after event 1 fkey.start
9183 and keytran.start are both 1, so when we see that C-h is bound,
9184 we need to update first_unbound. */
9185 first_unbound
= max (t
+ 1, first_unbound
);
9190 /* Remember the position to put an upper bound on fkey.start. */
9191 first_unbound
= min (t
, first_unbound
);
9193 head
= EVENT_HEAD (key
);
9194 if (help_char_p (head
) && t
> 0)
9196 read_key_sequence_cmd
= Vprefix_help_command
;
9198 last_nonmenu_event
= key
;
9199 /* The Microsoft C compiler can't handle the goto that
9207 Lisp_Object breakdown
;
9210 breakdown
= parse_modifiers (head
);
9211 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9212 /* Attempt to reduce an unbound mouse event to a simpler
9213 event that is bound:
9214 Drags reduce to clicks.
9215 Double-clicks reduce to clicks.
9216 Triple-clicks reduce to double-clicks, then to clicks.
9217 Down-clicks are eliminated.
9218 Double-downs reduce to downs, then are eliminated.
9219 Triple-downs reduce to double-downs, then to downs,
9220 then are eliminated. */
9221 if (modifiers
& (down_modifier
| drag_modifier
9222 | double_modifier
| triple_modifier
))
9224 while (modifiers
& (down_modifier
| drag_modifier
9225 | double_modifier
| triple_modifier
))
9227 Lisp_Object new_head
, new_click
;
9228 if (modifiers
& triple_modifier
)
9229 modifiers
^= (double_modifier
| triple_modifier
);
9230 else if (modifiers
& double_modifier
)
9231 modifiers
&= ~double_modifier
;
9232 else if (modifiers
& drag_modifier
)
9233 modifiers
&= ~drag_modifier
;
9236 /* Dispose of this `down' event by simply jumping
9237 back to replay_key, to get another event.
9239 Note that if this event came from mock input,
9240 then just jumping back to replay_key will just
9241 hand it to us again. So we have to wipe out any
9244 We could delete keybuf[t] and shift everything
9245 after that to the left by one spot, but we'd also
9246 have to fix up any variable that points into
9247 keybuf, and shifting isn't really necessary
9250 Adding prefixes for non-textual mouse clicks
9251 creates two characters of mock input, and both
9252 must be thrown away. If we're only looking at
9253 the prefix now, we can just jump back to
9254 replay_key. On the other hand, if we've already
9255 processed the prefix, and now the actual click
9256 itself is giving us trouble, then we've lost the
9257 state of the keymaps we want to backtrack to, and
9258 we need to replay the whole sequence to rebuild
9261 Beyond that, only function key expansion could
9262 create more than two keys, but that should never
9263 generate mouse events, so it's okay to zero
9264 mock_input in that case too.
9266 FIXME: The above paragraph seems just plain
9267 wrong, if you consider things like
9268 xterm-mouse-mode. -stef
9270 Isn't this just the most wonderful code ever? */
9272 /* If mock_input > t + 1, the above simplification
9273 will actually end up dropping keys on the floor.
9274 This is probably OK for now, but even
9275 if mock_input <= t + 1, we need to adjust fkey
9277 Typical case [header-line down-mouse-N]:
9278 mock_input = 2, t = 1, fkey.end = 1,
9279 last_real_key_start = 0. */
9280 if (fkey
.end
> last_real_key_start
)
9282 fkey
.end
= fkey
.start
9283 = min (last_real_key_start
, fkey
.start
);
9284 fkey
.map
= fkey
.parent
;
9285 if (keytran
.end
> last_real_key_start
)
9287 keytran
.end
= keytran
.start
9288 = min (last_real_key_start
, keytran
.start
);
9289 keytran
.map
= keytran
.parent
;
9292 if (t
== last_real_key_start
)
9299 mock_input
= last_real_key_start
;
9300 goto replay_sequence
;
9305 = apply_modifiers (modifiers
, XCAR (breakdown
));
9307 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9309 /* Look for a binding for this new key. follow_key
9310 promises that it didn't munge submaps the
9311 last time we called it, since key was unbound. */
9313 = (follow_key (new_click
,
9314 nmaps
- local_first_binding
,
9315 submaps
+ local_first_binding
,
9316 defs
+ local_first_binding
,
9317 submaps
+ local_first_binding
)
9318 + local_first_binding
);
9320 /* If that click is bound, go for it. */
9321 if (first_binding
< nmaps
)
9326 /* Otherwise, we'll leave key set to the drag event. */
9333 /* Normally, last_nonmenu_event gets the previous key we read.
9334 But when a mouse popup menu is being used,
9335 we don't update last_nonmenu_event; it continues to hold the mouse
9336 event that preceded the first level of menu. */
9337 if (!used_mouse_menu
)
9338 last_nonmenu_event
= key
;
9340 /* Record what part of this_command_keys is the current key sequence. */
9341 this_single_command_key_start
= this_command_key_count
- t
;
9343 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9344 /* There is a binding and it's not a prefix.
9345 There is thus no function-key in this sequence.
9346 Moving fkey.start is important in this case to allow keytran.start
9347 to go over the sequence before we return (since we keep the
9348 invariant that keytran.end <= fkey.start). */
9351 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9354 /* If the sequence is unbound, see if we can hang a function key
9355 off the end of it. */
9356 /* Continue scan from fkey.end until we find a bound suffix. */
9357 while (fkey
.end
< t
)
9359 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9362 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9363 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9364 max (t
, mock_input
),
9365 /* If there's a binding (i.e.
9366 first_binding >= nmaps) we don't want
9367 to apply this function-key-mapping. */
9368 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9373 mock_input
= diff
+ max (t
, mock_input
);
9374 goto replay_sequence
;
9378 /* Look for this sequence in key-translation-map.
9379 Scan from keytran.end until we find a bound suffix. */
9380 while (keytran
.end
< fkey
.start
)
9382 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9385 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9386 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9391 mock_input
= diff
+ max (t
, mock_input
);
9392 /* Adjust the function-key-map counters. */
9396 goto replay_sequence
;
9400 /* If KEY is not defined in any of the keymaps,
9401 and cannot be part of a function key or translation,
9402 and is an upper case letter
9403 use the corresponding lower-case letter instead. */
9404 if (first_binding
>= nmaps
9405 && fkey
.start
>= t
&& keytran
.start
>= t
9407 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9408 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9409 || (XINT (key
) & shift_modifier
)))
9411 Lisp_Object new_key
;
9413 original_uppercase
= key
;
9414 original_uppercase_position
= t
- 1;
9416 if (XINT (key
) & shift_modifier
)
9417 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9419 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9420 | (XINT (key
) & ~CHAR_MODIFIER_MASK
)));
9422 /* We have to do this unconditionally, regardless of whether
9423 the lower-case char is defined in the keymaps, because they
9424 might get translated through function-key-map. */
9425 keybuf
[t
- 1] = new_key
;
9426 mock_input
= max (t
, mock_input
);
9428 goto replay_sequence
;
9430 /* If KEY is not defined in any of the keymaps,
9431 and cannot be part of a function key or translation,
9432 and is a shifted function key,
9433 use the corresponding unshifted function key instead. */
9434 if (first_binding
>= nmaps
9435 && fkey
.start
>= t
&& keytran
.start
>= t
9438 Lisp_Object breakdown
;
9441 breakdown
= parse_modifiers (key
);
9442 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9443 if (modifiers
& shift_modifier
)
9445 Lisp_Object new_key
;
9447 original_uppercase
= key
;
9448 original_uppercase_position
= t
- 1;
9450 modifiers
&= ~shift_modifier
;
9451 new_key
= apply_modifiers (modifiers
,
9454 keybuf
[t
- 1] = new_key
;
9455 mock_input
= max (t
, mock_input
);
9456 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9457 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9459 goto replay_sequence
;
9465 read_key_sequence_cmd
= (first_binding
< nmaps
9466 ? defs
[first_binding
]
9469 unread_switch_frame
= delayed_switch_frame
;
9470 unbind_to (count
, Qnil
);
9472 /* Don't downcase the last character if the caller says don't.
9473 Don't downcase it if the result is undefined, either. */
9474 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9476 && t
- 1 == original_uppercase_position
)
9477 keybuf
[t
- 1] = original_uppercase
;
9479 /* Occasionally we fabricate events, perhaps by expanding something
9480 according to function-key-map, or by adding a prefix symbol to a
9481 mouse click in the scroll bar or modeline. In this cases, return
9482 the entire generated key sequence, even if we hit an unbound
9483 prefix or a definition before the end. This means that you will
9484 be able to push back the event properly, and also means that
9485 read-key-sequence will always return a logical unit.
9488 for (; t
< mock_input
; t
++)
9490 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9491 && NILP (Fzerop (Vecho_keystrokes
)))
9492 echo_char (keybuf
[t
]);
9493 add_command_key (keybuf
[t
]);
9502 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9503 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9504 The sequence is sufficient to specify a non-prefix command in the
9505 current local and global maps.
9507 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9508 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9509 as a continuation of the previous key.
9511 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9512 convert the last event to lower case. (Normally any upper case event
9513 is converted to lower case if the original event is undefined and the lower
9514 case equivalent is defined.) A non-nil value is appropriate for reading
9515 a key sequence to be defined.
9517 A C-g typed while in this function is treated like any other character,
9518 and `quit-flag' is not set.
9520 If the key sequence starts with a mouse click, then the sequence is read
9521 using the keymaps of the buffer of the window clicked in, not the buffer
9522 of the selected window as normal.
9524 `read-key-sequence' drops unbound button-down events, since you normally
9525 only care about the click or drag events which follow them. If a drag
9526 or multi-click event is unbound, but the corresponding click event would
9527 be bound, `read-key-sequence' turns the event into a click event at the
9528 drag's starting position. This means that you don't have to distinguish
9529 between click and drag, double, or triple events unless you want to.
9531 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9532 lines separating windows, and scroll bars with imaginary keys
9533 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9535 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9536 function will process a switch-frame event if the user switches frames
9537 before typing anything. If the user switches frames in the middle of a
9538 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9539 is nil, then the event will be put off until after the current key sequence.
9541 `read-key-sequence' checks `function-key-map' for function key
9542 sequences, where they wouldn't conflict with ordinary bindings. See
9543 `function-key-map' for more details.
9545 The optional fifth argument COMMAND-LOOP, if non-nil, means
9546 that this key sequence is being read by something that will
9547 read commands one after another. It should be nil if the caller
9548 will read just one key sequence. */)
9549 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9551 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9552 Lisp_Object can_return_switch_frame
, command_loop
;
9554 Lisp_Object keybuf
[30];
9556 struct gcpro gcpro1
;
9557 int count
= SPECPDL_INDEX ();
9560 CHECK_STRING (prompt
);
9563 specbind (Qinput_method_exit_on_first_char
,
9564 (NILP (command_loop
) ? Qt
: Qnil
));
9565 specbind (Qinput_method_use_echo_area
,
9566 (NILP (command_loop
) ? Qt
: Qnil
));
9568 bzero (keybuf
, sizeof keybuf
);
9570 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9572 if (NILP (continue_echo
))
9574 this_command_key_count
= 0;
9575 this_command_key_count_reset
= 0;
9576 this_single_command_key_start
= 0;
9579 #ifdef HAVE_X_WINDOWS
9580 if (display_hourglass_p
)
9581 cancel_hourglass ();
9584 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9585 prompt
, ! NILP (dont_downcase_last
),
9586 ! NILP (can_return_switch_frame
), 0);
9588 #if 0 /* The following is fine for code reading a key sequence and
9589 then proceeding with a lenghty computation, but it's not good
9590 for code reading keys in a loop, like an input method. */
9591 #ifdef HAVE_X_WINDOWS
9592 if (display_hourglass_p
)
9603 return unbind_to (count
, make_event_array (i
, keybuf
));
9606 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9607 Sread_key_sequence_vector
, 1, 5, 0,
9608 doc
: /* Like `read-key-sequence' but always return a vector. */)
9609 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9611 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9612 Lisp_Object can_return_switch_frame
, command_loop
;
9614 Lisp_Object keybuf
[30];
9616 struct gcpro gcpro1
;
9617 int count
= SPECPDL_INDEX ();
9620 CHECK_STRING (prompt
);
9623 specbind (Qinput_method_exit_on_first_char
,
9624 (NILP (command_loop
) ? Qt
: Qnil
));
9625 specbind (Qinput_method_use_echo_area
,
9626 (NILP (command_loop
) ? Qt
: Qnil
));
9628 bzero (keybuf
, sizeof keybuf
);
9630 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9632 if (NILP (continue_echo
))
9634 this_command_key_count
= 0;
9635 this_command_key_count_reset
= 0;
9636 this_single_command_key_start
= 0;
9639 #ifdef HAVE_X_WINDOWS
9640 if (display_hourglass_p
)
9641 cancel_hourglass ();
9644 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9645 prompt
, ! NILP (dont_downcase_last
),
9646 ! NILP (can_return_switch_frame
), 0);
9648 #ifdef HAVE_X_WINDOWS
9649 if (display_hourglass_p
)
9659 return unbind_to (count
, Fvector (i
, keybuf
));
9662 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9663 doc
: /* Execute CMD as an editor command.
9664 CMD must be a symbol that satisfies the `commandp' predicate.
9665 Optional second arg RECORD-FLAG non-nil
9666 means unconditionally put this command in `command-history'.
9667 Otherwise, that is done only if an arg is read using the minibuffer.
9668 The argument KEYS specifies the value to use instead of (this-command-keys)
9669 when reading the arguments; if it is nil, (this-command-keys) is used.
9670 The argument SPECIAL, if non-nil, means that this command is executing
9671 a special event, so ignore the prefix argument and don't clear it. */)
9672 (cmd
, record_flag
, keys
, special
)
9673 Lisp_Object cmd
, record_flag
, keys
, special
;
9675 register Lisp_Object final
;
9676 register Lisp_Object tem
;
9677 Lisp_Object prefixarg
;
9678 struct backtrace backtrace
;
9679 extern int debug_on_next_call
;
9681 debug_on_next_call
= 0;
9685 prefixarg
= current_kboard
->Vprefix_arg
;
9686 Vcurrent_prefix_arg
= prefixarg
;
9687 current_kboard
->Vprefix_arg
= Qnil
;
9694 tem
= Fget (cmd
, Qdisabled
);
9695 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9697 tem
= Fsymbol_value (Qdisabled_command_function
);
9699 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9705 final
= Findirect_function (cmd
, Qnil
);
9707 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9709 struct gcpro gcpro1
, gcpro2
;
9711 GCPRO2 (cmd
, prefixarg
);
9712 do_autoload (final
, cmd
);
9719 if (STRINGP (final
) || VECTORP (final
))
9721 /* If requested, place the macro in the command history. For
9722 other sorts of commands, call-interactively takes care of
9724 if (!NILP (record_flag
))
9727 = Fcons (Fcons (Qexecute_kbd_macro
,
9728 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9731 /* Don't keep command history around forever. */
9732 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9734 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9736 XSETCDR (tem
, Qnil
);
9740 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9743 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9745 backtrace
.next
= backtrace_list
;
9746 backtrace_list
= &backtrace
;
9747 backtrace
.function
= &Qcall_interactively
;
9748 backtrace
.args
= &cmd
;
9749 backtrace
.nargs
= 1;
9750 backtrace
.evalargs
= 0;
9751 backtrace
.debug_on_exit
= 0;
9753 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9755 backtrace_list
= backtrace
.next
;
9763 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9765 doc
: /* Read function name, then read its arguments and call it.
9767 To pass a numeric argument to the command you are invoking with, specify
9768 the numeric argument to this command.
9770 Noninteractively, the argument PREFIXARG is the prefix argument to
9771 give to the command you invoke, if it asks for an argument. */)
9773 Lisp_Object prefixarg
;
9775 Lisp_Object function
;
9777 int saved_last_point_position
;
9778 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9779 Lisp_Object bindings
, value
;
9780 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9781 #ifdef HAVE_X_WINDOWS
9782 /* The call to Fcompleting_read wil start and cancel the hourglass,
9783 but if the hourglass was already scheduled, this means that no
9784 hourglass will be shown for the actual M-x command itself.
9785 So we restart it if it is already scheduled. Note that checking
9786 hourglass_shown_p is not enough, normally the hourglass is not shown,
9787 just scheduled to be shown. */
9788 int hstarted
= hourglass_started ();
9791 saved_keys
= Fvector (this_command_key_count
,
9792 XVECTOR (this_command_keys
)->contents
);
9793 saved_last_point_position_buffer
= last_point_position_buffer
;
9794 saved_last_point_position
= last_point_position
;
9796 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9798 if (EQ (prefixarg
, Qminus
))
9800 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9801 strcpy (buf
, "C-u ");
9802 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9803 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9804 else if (INTEGERP (prefixarg
))
9805 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9807 /* This isn't strictly correct if execute-extended-command
9808 is bound to anything else. Perhaps it should use
9809 this_command_keys? */
9810 strcat (buf
, "M-x ");
9812 /* Prompt with buf, and then read a string, completing from and
9813 restricting to the set of all defined commands. Don't provide
9814 any initial input. Save the command read on the extended-command
9816 function
= Fcompleting_read (build_string (buf
),
9817 Vobarray
, Qcommandp
,
9818 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9821 #ifdef HAVE_X_WINDOWS
9822 if (hstarted
) start_hourglass ();
9825 if (STRINGP (function
) && SCHARS (function
) == 0)
9826 error ("No command name given");
9828 /* Set this_command_keys to the concatenation of saved_keys and
9829 function, followed by a RET. */
9834 this_command_key_count
= 0;
9835 this_command_key_count_reset
= 0;
9836 this_single_command_key_start
= 0;
9838 keys
= XVECTOR (saved_keys
)->contents
;
9839 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9840 add_command_key (keys
[i
]);
9842 for (i
= 0; i
< SCHARS (function
); i
++)
9843 add_command_key (Faref (function
, make_number (i
)));
9845 add_command_key (make_number ('\015'));
9848 last_point_position
= saved_last_point_position
;
9849 last_point_position_buffer
= saved_last_point_position_buffer
;
9853 function
= Fintern (function
, Qnil
);
9854 current_kboard
->Vprefix_arg
= prefixarg
;
9855 Vthis_command
= function
;
9856 real_this_command
= function
;
9858 /* If enabled, show which key runs this command. */
9859 if (!NILP (Vsuggest_key_bindings
)
9860 && NILP (Vexecuting_kbd_macro
)
9861 && SYMBOLP (function
))
9862 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9868 GCPRO2 (bindings
, value
);
9869 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9871 /* If the command has a key binding, print it now. */
9872 if (!NILP (bindings
)
9873 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9876 /* But first wait, and skip the message if there is input. */
9879 /* If this command displayed something in the echo area;
9880 wait a few seconds, then display our suggestion message. */
9881 if (NILP (echo_area_buffer
[0]))
9882 waited
= sit_for (make_number (0), 0, 2);
9883 else if (NUMBERP (Vsuggest_key_bindings
))
9884 waited
= sit_for (Vminibuffer_message_timeout
, 0, 2);
9886 waited
= sit_for (make_number (2), 0, 2);
9888 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
9890 Lisp_Object binding
;
9892 int message_p
= push_message ();
9893 int count
= SPECPDL_INDEX ();
9895 record_unwind_protect (pop_message_unwind
, Qnil
);
9896 binding
= Fkey_description (bindings
, Qnil
);
9899 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9902 sprintf (newmessage
, "You can run the command `%s' with %s",
9903 SDATA (SYMBOL_NAME (function
)),
9905 message2_nolog (newmessage
,
9906 strlen (newmessage
),
9907 STRING_MULTIBYTE (binding
));
9908 if (NUMBERP (Vsuggest_key_bindings
))
9909 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
9911 waited
= sit_for (make_number (2), 0, 2);
9913 if (!NILP (waited
) && message_p
)
9916 unbind_to (count
, Qnil
);
9920 RETURN_UNGCPRO (value
);
9924 /* Return nonzero if input events are pending. */
9927 detect_input_pending ()
9930 get_input_pending (&input_pending
, 0);
9932 return input_pending
;
9935 /* Return nonzero if input events other than mouse movements are
9939 detect_input_pending_ignore_squeezables ()
9942 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9944 return input_pending
;
9947 /* Return nonzero if input events are pending, and run any pending timers. */
9950 detect_input_pending_run_timers (do_display
)
9953 int old_timers_run
= timers_run
;
9956 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
9958 if (old_timers_run
!= timers_run
&& do_display
)
9960 redisplay_preserve_echo_area (8);
9961 /* The following fixes a bug when using lazy-lock with
9962 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9963 from an idle timer function. The symptom of the bug is that
9964 the cursor sometimes doesn't become visible until the next X
9965 event is processed. --gerd. */
9967 rif
->flush_display (NULL
);
9970 return input_pending
;
9973 /* This is called in some cases before a possible quit.
9974 It cases the next call to detect_input_pending to recompute input_pending.
9975 So calling this function unnecessarily can't do any harm. */
9978 clear_input_pending ()
9983 /* Return nonzero if there are pending requeued events.
9984 This isn't used yet. The hope is to make wait_reading_process_output
9985 call it, and return if it runs Lisp code that unreads something.
9986 The problem is, kbd_buffer_get_event needs to be fixed to know what
9987 to do in that case. It isn't trivial. */
9990 requeued_events_pending_p ()
9992 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9996 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9997 doc
: /* Return t if command input is currently available with no wait.
9998 Actually, the value is nil only if we can be sure that no input is available;
9999 if there is a doubt, the value is t. */)
10002 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
10005 get_input_pending (&input_pending
,
10006 READABLE_EVENTS_DO_TIMERS_NOW
10007 | READABLE_EVENTS_FILTER_EVENTS
);
10008 return input_pending
> 0 ? Qt
: Qnil
;
10011 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10012 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10015 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10018 if (total_keys
< NUM_RECENT_KEYS
)
10019 return Fvector (total_keys
, keys
);
10022 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10023 bcopy (keys
+ recent_keys_index
,
10024 XVECTOR (val
)->contents
,
10025 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10027 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10028 recent_keys_index
* sizeof (Lisp_Object
));
10033 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10034 doc
: /* Return the key sequence that invoked this command.
10035 However, if the command has called `read-key-sequence', it returns
10036 the last key sequence that has been read.
10037 The value is a string or a vector. */)
10040 return make_event_array (this_command_key_count
,
10041 XVECTOR (this_command_keys
)->contents
);
10044 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10045 doc
: /* Return the key sequence that invoked this command, as a vector.
10046 However, if the command has called `read-key-sequence', it returns
10047 the last key sequence that has been read. */)
10050 return Fvector (this_command_key_count
,
10051 XVECTOR (this_command_keys
)->contents
);
10054 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10055 Sthis_single_command_keys
, 0, 0, 0,
10056 doc
: /* Return the key sequence that invoked this command.
10057 More generally, it returns the last key sequence read, either by
10058 the command loop or by `read-key-sequence'.
10059 Unlike `this-command-keys', this function's value
10060 does not include prefix arguments.
10061 The value is always a vector. */)
10064 return Fvector (this_command_key_count
10065 - this_single_command_key_start
,
10066 (XVECTOR (this_command_keys
)->contents
10067 + this_single_command_key_start
));
10070 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10071 Sthis_single_command_raw_keys
, 0, 0, 0,
10072 doc
: /* Return the raw events that were read for this command.
10073 More generally, it returns the last key sequence read, either by
10074 the command loop or by `read-key-sequence'.
10075 Unlike `this-single-command-keys', this function's value
10076 shows the events before all translations (except for input methods).
10077 The value is always a vector. */)
10080 return Fvector (raw_keybuf_count
,
10081 (XVECTOR (raw_keybuf
)->contents
));
10084 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10085 Sreset_this_command_lengths
, 0, 0, 0,
10086 doc
: /* Make the unread events replace the last command and echo.
10087 Used in `universal-argument-other-key'.
10089 `universal-argument-other-key' rereads the event just typed.
10090 It then gets translated through `function-key-map'.
10091 The translated event has to replace the real events,
10092 both in the value of (this-command-keys) and in echoing.
10093 To achieve this, `universal-argument-other-key' calls
10094 `reset-this-command-lengths', which discards the record of reading
10095 these events the first time. */)
10098 this_command_key_count
= before_command_key_count
;
10099 if (this_command_key_count
< this_single_command_key_start
)
10100 this_single_command_key_start
= this_command_key_count
;
10102 echo_truncate (before_command_echo_length
);
10104 /* Cause whatever we put into unread-command-events
10105 to echo as if it were being freshly read from the keyboard. */
10106 this_command_key_count_reset
= 1;
10111 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10112 Sclear_this_command_keys
, 0, 1, 0,
10113 doc
: /* Clear out the vector that `this-command-keys' returns.
10114 Also clear the record of the last 100 events, unless optional arg
10115 KEEP-RECORD is non-nil. */)
10117 Lisp_Object keep_record
;
10121 this_command_key_count
= 0;
10122 this_command_key_count_reset
= 0;
10124 if (NILP (keep_record
))
10126 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10127 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10129 recent_keys_index
= 0;
10134 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10135 doc
: /* Return the current depth in recursive edits. */)
10139 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10143 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10144 "FOpen dribble file: ",
10145 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10146 If FILE is nil, close any open dribble file. */)
10157 file
= Fexpand_file_name (file
, Qnil
);
10158 dribble
= fopen (SDATA (file
), "w");
10160 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10165 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10166 doc
: /* Discard the contents of the terminal input buffer.
10167 Also end any kbd macro being defined. */)
10170 if (!NILP (current_kboard
->defining_kbd_macro
))
10172 /* Discard the last command from the macro. */
10173 Fcancel_kbd_macro_events ();
10177 update_mode_lines
++;
10179 Vunread_command_events
= Qnil
;
10180 unread_command_char
= -1;
10182 discard_tty_input ();
10184 kbd_fetch_ptr
= kbd_store_ptr
;
10190 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10191 doc
: /* Stop Emacs and return to superior process. You can resume later.
10192 If `cannot-suspend' is non-nil, or if the system doesn't support job
10193 control, run a subshell instead.
10195 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10196 to be read as terminal input by Emacs's parent, after suspension.
10198 Before suspending, run the normal hook `suspend-hook'.
10199 After resumption run the normal hook `suspend-resume-hook'.
10201 Some operating systems cannot stop the Emacs process and resume it later.
10202 On such systems, Emacs starts a subshell instead of suspending. */)
10204 Lisp_Object stuffstring
;
10206 int count
= SPECPDL_INDEX ();
10207 int old_height
, old_width
;
10209 struct gcpro gcpro1
;
10211 if (!NILP (stuffstring
))
10212 CHECK_STRING (stuffstring
);
10214 /* Run the functions in suspend-hook. */
10215 if (!NILP (Vrun_hooks
))
10216 call1 (Vrun_hooks
, intern ("suspend-hook"));
10218 GCPRO1 (stuffstring
);
10219 get_frame_size (&old_width
, &old_height
);
10220 reset_sys_modes ();
10221 /* sys_suspend can get an error if it tries to fork a subshell
10222 and the system resources aren't available for that. */
10223 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10225 stuff_buffered_input (stuffstring
);
10226 if (cannot_suspend
)
10230 unbind_to (count
, Qnil
);
10232 /* Check if terminal/window size has changed.
10233 Note that this is not useful when we are running directly
10234 with a window system; but suspend should be disabled in that case. */
10235 get_frame_size (&width
, &height
);
10236 if (width
!= old_width
|| height
!= old_height
)
10237 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10239 /* Run suspend-resume-hook. */
10240 if (!NILP (Vrun_hooks
))
10241 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10247 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10248 Then in any case stuff anything Emacs has read ahead and not used. */
10251 stuff_buffered_input (stuffstring
)
10252 Lisp_Object stuffstring
;
10254 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10255 register unsigned char *p
;
10257 if (STRINGP (stuffstring
))
10259 register int count
;
10261 p
= SDATA (stuffstring
);
10262 count
= SBYTES (stuffstring
);
10263 while (count
-- > 0)
10268 /* Anything we have read ahead, put back for the shell to read. */
10269 /* ?? What should this do when we have multiple keyboards??
10270 Should we ignore anything that was typed in at the "wrong" kboard?
10272 rms: we should stuff everything back into the kboard
10274 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10277 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10278 kbd_fetch_ptr
= kbd_buffer
;
10279 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10280 stuff_char (kbd_fetch_ptr
->code
);
10282 clear_event (kbd_fetch_ptr
);
10286 #endif /* SIGTSTP */
10290 set_waiting_for_input (time_to_clear
)
10291 EMACS_TIME
*time_to_clear
;
10293 input_available_clear_time
= time_to_clear
;
10295 /* Tell interrupt_signal to throw back to read_char, */
10296 waiting_for_input
= 1;
10298 /* If interrupt_signal was called before and buffered a C-g,
10299 make it run again now, to avoid timing error. */
10300 if (!NILP (Vquit_flag
))
10301 quit_throw_to_read_char ();
10305 clear_waiting_for_input ()
10307 /* Tell interrupt_signal not to throw back to read_char, */
10308 waiting_for_input
= 0;
10309 input_available_clear_time
= 0;
10312 /* This routine is called at interrupt level in response to C-g.
10314 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10315 is called from kbd_buffer_store_event, in handling SIGIO or
10318 If `waiting_for_input' is non zero, then unless `echoing' is
10319 nonzero, immediately throw back to read_char.
10321 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10322 eval to throw, when it gets a chance. If quit-flag is already
10323 non-nil, it stops the job right away. */
10326 interrupt_signal (signalnum
) /* If we don't have an argument, */
10327 int signalnum
; /* some compilers complain in signal calls. */
10330 /* Must preserve main program's value of errno. */
10331 int old_errno
= errno
;
10332 struct frame
*sf
= SELECTED_FRAME ();
10334 #if defined (USG) && !defined (POSIX_SIGNALS)
10335 if (!read_socket_hook
&& NILP (Vwindow_system
))
10337 /* USG systems forget handlers when they are used;
10338 must reestablish each time */
10339 signal (SIGINT
, interrupt_signal
);
10340 signal (SIGQUIT
, interrupt_signal
);
10344 SIGNAL_THREAD_CHECK (signalnum
);
10347 if (!NILP (Vquit_flag
)
10348 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10350 /* If SIGINT isn't blocked, don't let us be interrupted by
10351 another SIGINT, it might be harmful due to non-reentrancy
10352 in I/O functions. */
10353 sigblock (sigmask (SIGINT
));
10356 reset_sys_modes ();
10358 #ifdef SIGTSTP /* Support possible in later USG versions */
10360 * On systems which can suspend the current process and return to the original
10361 * shell, this command causes the user to end up back at the shell.
10362 * The "Auto-save" and "Abort" questions are not asked until
10363 * the user elects to return to emacs, at which point he can save the current
10364 * job and either dump core or continue.
10369 if (sys_suspend () == -1)
10371 printf ("Not running as a subprocess;\n");
10372 printf ("you can continue or abort.\n");
10374 #else /* not VMS */
10375 /* Perhaps should really fork an inferior shell?
10376 But that would not provide any way to get back
10377 to the original shell, ever. */
10378 printf ("No support for stopping a process on this operating system;\n");
10379 printf ("you can continue or abort.\n");
10380 #endif /* not VMS */
10381 #endif /* not SIGTSTP */
10383 /* We must remain inside the screen area when the internal terminal
10384 is used. Note that [Enter] is not echoed by dos. */
10387 /* It doesn't work to autosave while GC is in progress;
10388 the code used for auto-saving doesn't cope with the mark bit. */
10389 if (!gc_in_progress
)
10391 printf ("Auto-save? (y or n) ");
10393 if (((c
= getchar ()) & ~040) == 'Y')
10395 Fdo_auto_save (Qt
, Qnil
);
10397 printf ("\r\nAuto-save done");
10398 #else /* not MSDOS */
10399 printf ("Auto-save done\n");
10400 #endif /* not MSDOS */
10402 while (c
!= '\n') c
= getchar ();
10406 /* During GC, it must be safe to reenable quitting again. */
10407 Vinhibit_quit
= Qnil
;
10410 #endif /* not MSDOS */
10411 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10412 printf ("but will instead do a real quit after garbage collection ends\r\n");
10417 printf ("\r\nAbort? (y or n) ");
10418 #else /* not MSDOS */
10420 printf ("Abort (and enter debugger)? (y or n) ");
10421 #else /* not VMS */
10422 printf ("Abort (and dump core)? (y or n) ");
10423 #endif /* not VMS */
10424 #endif /* not MSDOS */
10426 if (((c
= getchar ()) & ~040) == 'Y')
10428 while (c
!= '\n') c
= getchar ();
10430 printf ("\r\nContinuing...\r\n");
10431 #else /* not MSDOS */
10432 printf ("Continuing...\n");
10433 #endif /* not MSDOS */
10440 /* If executing a function that wants to be interrupted out of
10441 and the user has not deferred quitting by binding `inhibit-quit'
10442 then quit right away. */
10443 if (immediate_quit
&& NILP (Vinhibit_quit
))
10445 struct gl_state_s saved
;
10446 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10448 immediate_quit
= 0;
10451 GCPRO4 (saved
.object
, saved
.global_code
,
10452 saved
.current_syntax_table
, saved
.old_prop
);
10453 Fsignal (Qquit
, Qnil
);
10458 /* Else request quit when it's safe */
10462 if (waiting_for_input
&& !echoing
)
10463 quit_throw_to_read_char ();
10468 /* Handle a C-g by making read_char return C-g. */
10471 quit_throw_to_read_char ()
10474 /* Prevent another signal from doing this before we finish. */
10475 clear_waiting_for_input ();
10478 Vunread_command_events
= Qnil
;
10479 unread_command_char
= -1;
10481 #if 0 /* Currently, sit_for is called from read_char without turning
10482 off polling. And that can call set_waiting_for_input.
10483 It seems to be harmless. */
10484 #ifdef POLL_FOR_INPUT
10485 /* May be > 1 if in recursive minibuffer. */
10486 if (poll_suppress_count
== 0)
10490 if (FRAMEP (internal_last_event_frame
)
10491 && !EQ (internal_last_event_frame
, selected_frame
))
10492 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10495 _longjmp (getcjmp
, 1);
10498 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10499 doc
: /* Set mode of reading keyboard input.
10500 First arg INTERRUPT non-nil means use input interrupts;
10501 nil means use CBREAK mode.
10502 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10503 (no effect except in CBREAK mode).
10504 Third arg META t means accept 8-bit input (for a Meta key).
10505 META nil means ignore the top bit, on the assumption it is parity.
10506 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10507 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10508 See also `current-input-mode'. */)
10509 (interrupt
, flow
, meta
, quit
)
10510 Lisp_Object interrupt
, flow
, meta
, quit
;
10513 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10514 error ("set-input-mode: QUIT must be an ASCII character");
10516 #ifdef POLL_FOR_INPUT
10521 /* this causes startup screen to be restored and messes with the mouse */
10522 reset_sys_modes ();
10526 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10527 if (read_socket_hook
)
10529 /* When using X, don't give the user a real choice,
10530 because we haven't implemented the mechanisms to support it. */
10531 #ifdef NO_SOCK_SIGIO
10532 interrupt_input
= 0;
10533 #else /* not NO_SOCK_SIGIO */
10534 interrupt_input
= 1;
10535 #endif /* NO_SOCK_SIGIO */
10538 interrupt_input
= !NILP (interrupt
);
10539 #else /* not SIGIO */
10540 interrupt_input
= 0;
10541 #endif /* not SIGIO */
10543 /* Our VMS input only works by interrupts, as of now. */
10545 interrupt_input
= 1;
10548 flow_control
= !NILP (flow
);
10551 else if (EQ (meta
, Qt
))
10556 /* Don't let this value be out of range. */
10557 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10563 #ifdef POLL_FOR_INPUT
10564 poll_suppress_count
= 1;
10570 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10571 doc
: /* Return information about the way Emacs currently reads keyboard input.
10572 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10573 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10574 nil, Emacs is using CBREAK mode.
10575 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10576 terminal; this does not apply if Emacs uses interrupt-driven input.
10577 META is t if accepting 8-bit input with 8th bit as Meta flag.
10578 META nil means ignoring the top bit, on the assumption it is parity.
10579 META is neither t nor nil if accepting 8-bit input and using
10580 all 8 bits as the character code.
10581 QUIT is the character Emacs currently uses to quit.
10582 The elements of this list correspond to the arguments of
10583 `set-input-mode'. */)
10586 Lisp_Object val
[4];
10588 val
[0] = interrupt_input
? Qt
: Qnil
;
10589 val
[1] = flow_control
? Qt
: Qnil
;
10590 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10591 XSETFASTINT (val
[3], quit_char
);
10593 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10596 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10597 doc
: /* Return position information for pixel coordinates X and Y.
10598 By default, X and Y are relative to text area of the selected window.
10599 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10600 If optional fourth arg WHOLE is non-nil, X is relative to the left
10601 edge of the window.
10603 The return value is similar to a mouse click position:
10604 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10605 IMAGE (DX . DY) (WIDTH . HEIGHT))
10606 The `posn-' functions access elements of such lists. */)
10607 (x
, y
, frame_or_window
, whole
)
10608 Lisp_Object x
, y
, frame_or_window
, whole
;
10613 if (NILP (frame_or_window
))
10614 frame_or_window
= selected_window
;
10616 if (WINDOWP (frame_or_window
))
10620 CHECK_LIVE_WINDOW (frame_or_window
);
10622 w
= XWINDOW (frame_or_window
);
10623 XSETINT (x
, (XINT (x
)
10624 + WINDOW_LEFT_EDGE_X (w
)
10626 ? window_box_left_offset (w
, TEXT_AREA
)
10628 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10629 frame_or_window
= w
->frame
;
10632 CHECK_LIVE_FRAME (frame_or_window
);
10634 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10637 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10638 doc
: /* Return position information for buffer POS in WINDOW.
10639 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10641 Return nil if position is not visible in window. Otherwise,
10642 the return value is similar to that returned by `event-start' for
10643 a mouse click at the upper left corner of the glyph corresponding
10644 to the given buffer position:
10645 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10646 IMAGE (DX . DY) (WIDTH . HEIGHT))
10647 The `posn-' functions access elements of such lists. */)
10649 Lisp_Object pos
, window
;
10654 window
= selected_window
;
10656 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10659 Lisp_Object x
= XCAR (tem
);
10660 Lisp_Object y
= XCAR (XCDR (tem
));
10662 /* Point invisible due to hscrolling? */
10665 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10673 * Set up a new kboard object with reasonable initial values.
10679 kb
->Voverriding_terminal_local_map
= Qnil
;
10680 kb
->Vlast_command
= Qnil
;
10681 kb
->Vreal_last_command
= Qnil
;
10682 kb
->Vprefix_arg
= Qnil
;
10683 kb
->Vlast_prefix_arg
= Qnil
;
10684 kb
->kbd_queue
= Qnil
;
10685 kb
->kbd_queue_has_data
= 0;
10686 kb
->immediate_echo
= 0;
10687 kb
->echo_string
= Qnil
;
10688 kb
->echo_after_prompt
= -1;
10689 kb
->kbd_macro_buffer
= 0;
10690 kb
->kbd_macro_bufsize
= 0;
10691 kb
->defining_kbd_macro
= Qnil
;
10692 kb
->Vlast_kbd_macro
= Qnil
;
10693 kb
->reference_count
= 0;
10694 kb
->Vsystem_key_alist
= Qnil
;
10695 kb
->system_key_syms
= Qnil
;
10696 kb
->Vdefault_minibuffer_frame
= Qnil
;
10700 * Destroy the contents of a kboard object, but not the object itself.
10701 * We use this just before deleting it, or if we're going to initialize
10702 * it a second time.
10708 if (kb
->kbd_macro_buffer
)
10709 xfree (kb
->kbd_macro_buffer
);
10712 #ifdef MULTI_KBOARD
10714 /* Free KB and memory referenced from it. */
10722 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10725 *kbp
= kb
->next_kboard
;
10727 /* Prevent a dangling reference to KB. */
10728 if (kb
== current_kboard
10729 && FRAMEP (selected_frame
)
10730 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10732 current_kboard
= XFRAME (selected_frame
)->kboard
;
10733 if (current_kboard
== kb
)
10741 #endif /* MULTI_KBOARD */
10746 /* This is correct before outermost invocation of the editor loop */
10747 command_loop_level
= -1;
10748 immediate_quit
= 0;
10749 quit_char
= Ctl ('g');
10750 Vunread_command_events
= Qnil
;
10751 unread_command_char
= -1;
10752 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10754 recent_keys_index
= 0;
10755 kbd_fetch_ptr
= kbd_buffer
;
10756 kbd_store_ptr
= kbd_buffer
;
10758 do_mouse_tracking
= Qnil
;
10762 /* This means that command_loop_1 won't try to select anything the first
10764 internal_last_event_frame
= Qnil
;
10765 Vlast_event_frame
= internal_last_event_frame
;
10767 #ifdef MULTI_KBOARD
10768 current_kboard
= initial_kboard
;
10770 wipe_kboard (current_kboard
);
10771 init_kboard (current_kboard
);
10773 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10775 signal (SIGINT
, interrupt_signal
);
10776 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10777 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10778 SIGQUIT and we can't tell which one it will give us. */
10779 signal (SIGQUIT
, interrupt_signal
);
10780 #endif /* HAVE_TERMIO */
10782 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10784 if (!noninteractive
)
10785 signal (SIGIO
, input_available_signal
);
10788 /* Use interrupt input by default, if it works and noninterrupt input
10789 has deficiencies. */
10791 #ifdef INTERRUPT_INPUT
10792 interrupt_input
= 1;
10794 interrupt_input
= 0;
10797 /* Our VMS input only works by interrupts, as of now. */
10799 interrupt_input
= 1;
10805 if (keyboard_init_hook
)
10806 (*keyboard_init_hook
) ();
10808 #ifdef POLL_FOR_INPUT
10809 poll_suppress_count
= 1;
10814 /* This type's only use is in syms_of_keyboard, to initialize the
10815 event header symbols and put properties on them. */
10816 struct event_head
{
10822 struct event_head head_table
[] = {
10823 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10824 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10825 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10826 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10827 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10828 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10829 /* `select-window' should be handled just like `switch-frame'
10830 in read_key_sequence. */
10831 {&Qselect_window
, "select-window", &Qswitch_frame
}
10835 syms_of_keyboard ()
10837 Vpre_help_message
= Qnil
;
10838 staticpro (&Vpre_help_message
);
10840 Vlispy_mouse_stem
= build_string ("mouse");
10841 staticpro (&Vlispy_mouse_stem
);
10844 QCimage
= intern (":image");
10845 staticpro (&QCimage
);
10847 staticpro (&Qhelp_echo
);
10848 Qhelp_echo
= intern ("help-echo");
10850 staticpro (&item_properties
);
10851 item_properties
= Qnil
;
10853 staticpro (&tool_bar_item_properties
);
10854 tool_bar_item_properties
= Qnil
;
10855 staticpro (&tool_bar_items_vector
);
10856 tool_bar_items_vector
= Qnil
;
10858 staticpro (&real_this_command
);
10859 real_this_command
= Qnil
;
10861 Qtimer_event_handler
= intern ("timer-event-handler");
10862 staticpro (&Qtimer_event_handler
);
10864 Qdisabled_command_function
= intern ("disabled-command-function");
10865 staticpro (&Qdisabled_command_function
);
10867 Qself_insert_command
= intern ("self-insert-command");
10868 staticpro (&Qself_insert_command
);
10870 Qforward_char
= intern ("forward-char");
10871 staticpro (&Qforward_char
);
10873 Qbackward_char
= intern ("backward-char");
10874 staticpro (&Qbackward_char
);
10876 Qdisabled
= intern ("disabled");
10877 staticpro (&Qdisabled
);
10879 Qundefined
= intern ("undefined");
10880 staticpro (&Qundefined
);
10882 Qpre_command_hook
= intern ("pre-command-hook");
10883 staticpro (&Qpre_command_hook
);
10885 Qpost_command_hook
= intern ("post-command-hook");
10886 staticpro (&Qpost_command_hook
);
10888 Qdeferred_action_function
= intern ("deferred-action-function");
10889 staticpro (&Qdeferred_action_function
);
10891 Qcommand_hook_internal
= intern ("command-hook-internal");
10892 staticpro (&Qcommand_hook_internal
);
10894 Qfunction_key
= intern ("function-key");
10895 staticpro (&Qfunction_key
);
10896 Qmouse_click
= intern ("mouse-click");
10897 staticpro (&Qmouse_click
);
10898 #if defined (WINDOWSNT) || defined (MAC_OS)
10899 Qlanguage_change
= intern ("language-change");
10900 staticpro (&Qlanguage_change
);
10902 Qdrag_n_drop
= intern ("drag-n-drop");
10903 staticpro (&Qdrag_n_drop
);
10905 Qsave_session
= intern ("save-session");
10906 staticpro (&Qsave_session
);
10909 Qmac_apple_event
= intern ("mac-apple-event");
10910 staticpro (&Qmac_apple_event
);
10913 Qusr1_signal
= intern ("usr1-signal");
10914 staticpro (&Qusr1_signal
);
10915 Qusr2_signal
= intern ("usr2-signal");
10916 staticpro (&Qusr2_signal
);
10918 Qmenu_enable
= intern ("menu-enable");
10919 staticpro (&Qmenu_enable
);
10920 Qmenu_alias
= intern ("menu-alias");
10921 staticpro (&Qmenu_alias
);
10922 QCenable
= intern (":enable");
10923 staticpro (&QCenable
);
10924 QCvisible
= intern (":visible");
10925 staticpro (&QCvisible
);
10926 QChelp
= intern (":help");
10927 staticpro (&QChelp
);
10928 QCfilter
= intern (":filter");
10929 staticpro (&QCfilter
);
10930 QCbutton
= intern (":button");
10931 staticpro (&QCbutton
);
10932 QCkeys
= intern (":keys");
10933 staticpro (&QCkeys
);
10934 QCkey_sequence
= intern (":key-sequence");
10935 staticpro (&QCkey_sequence
);
10936 QCtoggle
= intern (":toggle");
10937 staticpro (&QCtoggle
);
10938 QCradio
= intern (":radio");
10939 staticpro (&QCradio
);
10941 Qmode_line
= intern ("mode-line");
10942 staticpro (&Qmode_line
);
10943 Qvertical_line
= intern ("vertical-line");
10944 staticpro (&Qvertical_line
);
10945 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10946 staticpro (&Qvertical_scroll_bar
);
10947 Qmenu_bar
= intern ("menu-bar");
10948 staticpro (&Qmenu_bar
);
10951 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
10952 staticpro (&Qmouse_fixup_help_message
);
10955 Qabove_handle
= intern ("above-handle");
10956 staticpro (&Qabove_handle
);
10957 Qhandle
= intern ("handle");
10958 staticpro (&Qhandle
);
10959 Qbelow_handle
= intern ("below-handle");
10960 staticpro (&Qbelow_handle
);
10961 Qup
= intern ("up");
10963 Qdown
= intern ("down");
10964 staticpro (&Qdown
);
10965 Qtop
= intern ("top");
10967 Qbottom
= intern ("bottom");
10968 staticpro (&Qbottom
);
10969 Qend_scroll
= intern ("end-scroll");
10970 staticpro (&Qend_scroll
);
10971 Qratio
= intern ("ratio");
10972 staticpro (&Qratio
);
10974 Qevent_kind
= intern ("event-kind");
10975 staticpro (&Qevent_kind
);
10976 Qevent_symbol_elements
= intern ("event-symbol-elements");
10977 staticpro (&Qevent_symbol_elements
);
10978 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10979 staticpro (&Qevent_symbol_element_mask
);
10980 Qmodifier_cache
= intern ("modifier-cache");
10981 staticpro (&Qmodifier_cache
);
10983 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10984 staticpro (&Qrecompute_lucid_menubar
);
10985 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10986 staticpro (&Qactivate_menubar_hook
);
10988 Qpolling_period
= intern ("polling-period");
10989 staticpro (&Qpolling_period
);
10991 Qinput_method_function
= intern ("input-method-function");
10992 staticpro (&Qinput_method_function
);
10994 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10995 staticpro (&Qinput_method_exit_on_first_char
);
10996 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10997 staticpro (&Qinput_method_use_echo_area
);
10999 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11000 Fset (Qinput_method_use_echo_area
, Qnil
);
11002 last_point_position_buffer
= Qnil
;
11003 last_point_position_window
= Qnil
;
11006 struct event_head
*p
;
11008 for (p
= head_table
;
11009 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11012 *p
->var
= intern (p
->name
);
11013 staticpro (p
->var
);
11014 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11015 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11019 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11020 staticpro (&button_down_location
);
11021 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11022 staticpro (&mouse_syms
);
11023 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11024 staticpro (&wheel_syms
);
11028 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11030 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11031 for (i
= 0; i
< len
; i
++)
11032 if (modifier_names
[i
])
11033 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11034 staticpro (&modifier_symbols
);
11037 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11038 staticpro (&recent_keys
);
11040 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11041 staticpro (&this_command_keys
);
11043 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11044 staticpro (&raw_keybuf
);
11046 Qextended_command_history
= intern ("extended-command-history");
11047 Fset (Qextended_command_history
, Qnil
);
11048 staticpro (&Qextended_command_history
);
11050 accent_key_syms
= Qnil
;
11051 staticpro (&accent_key_syms
);
11053 func_key_syms
= Qnil
;
11054 staticpro (&func_key_syms
);
11056 drag_n_drop_syms
= Qnil
;
11057 staticpro (&drag_n_drop_syms
);
11059 unread_switch_frame
= Qnil
;
11060 staticpro (&unread_switch_frame
);
11062 internal_last_event_frame
= Qnil
;
11063 staticpro (&internal_last_event_frame
);
11065 read_key_sequence_cmd
= Qnil
;
11066 staticpro (&read_key_sequence_cmd
);
11068 menu_bar_one_keymap_changed_items
= Qnil
;
11069 staticpro (&menu_bar_one_keymap_changed_items
);
11071 menu_bar_items_vector
= Qnil
;
11072 staticpro (&menu_bar_items_vector
);
11074 defsubr (&Sevent_convert_list
);
11075 defsubr (&Sread_key_sequence
);
11076 defsubr (&Sread_key_sequence_vector
);
11077 defsubr (&Srecursive_edit
);
11079 defsubr (&Strack_mouse
);
11081 defsubr (&Sinput_pending_p
);
11082 defsubr (&Scommand_execute
);
11083 defsubr (&Srecent_keys
);
11084 defsubr (&Sthis_command_keys
);
11085 defsubr (&Sthis_command_keys_vector
);
11086 defsubr (&Sthis_single_command_keys
);
11087 defsubr (&Sthis_single_command_raw_keys
);
11088 defsubr (&Sreset_this_command_lengths
);
11089 defsubr (&Sclear_this_command_keys
);
11090 defsubr (&Ssuspend_emacs
);
11091 defsubr (&Sabort_recursive_edit
);
11092 defsubr (&Sexit_recursive_edit
);
11093 defsubr (&Srecursion_depth
);
11094 defsubr (&Stop_level
);
11095 defsubr (&Sdiscard_input
);
11096 defsubr (&Sopen_dribble_file
);
11097 defsubr (&Sset_input_mode
);
11098 defsubr (&Scurrent_input_mode
);
11099 defsubr (&Sexecute_extended_command
);
11100 defsubr (&Sposn_at_point
);
11101 defsubr (&Sposn_at_x_y
);
11103 DEFVAR_LISP ("last-command-char", &last_command_char
,
11104 doc
: /* Last input event that was part of a command. */);
11106 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11107 doc
: /* Last input event that was part of a command. */);
11109 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11110 doc
: /* Last input event in a command, except for mouse menu events.
11111 Mouse menus give back keys that don't look like mouse events;
11112 this variable holds the actual mouse event that led to the menu,
11113 so that you can determine whether the command was run by mouse or not. */);
11115 DEFVAR_LISP ("last-input-char", &last_input_char
,
11116 doc
: /* Last input event. */);
11118 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11119 doc
: /* Last input event. */);
11121 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11122 doc
: /* List of events to be read as the command input.
11123 These events are processed first, before actual keyboard input. */);
11124 Vunread_command_events
= Qnil
;
11126 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11127 doc
: /* If not -1, an object to be read as next command input event. */);
11129 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11130 doc
: /* List of events to be processed as input by input methods.
11131 These events are processed after `unread-command-events', but
11132 before actual keyboard input. */);
11133 Vunread_post_input_method_events
= Qnil
;
11135 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11136 doc
: /* List of events to be processed as input by input methods.
11137 These events are processed after `unread-command-events', but
11138 before actual keyboard input. */);
11139 Vunread_input_method_events
= Qnil
;
11141 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11142 doc
: /* Meta-prefix character code.
11143 Meta-foo as command input turns into this character followed by foo. */);
11144 XSETINT (meta_prefix_char
, 033);
11146 DEFVAR_KBOARD ("last-command", Vlast_command
,
11147 doc
: /* The last command executed.
11148 Normally a symbol with a function definition, but can be whatever was found
11149 in the keymap, or whatever the variable `this-command' was set to by that
11152 The value `mode-exit' is special; it means that the previous command
11153 read an event that told it to exit, and it did so and unread that event.
11154 In other words, the present command is the event that made the previous
11157 The value `kill-region' is special; it means that the previous command
11158 was a kill command. */);
11160 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11161 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11163 DEFVAR_LISP ("this-command", &Vthis_command
,
11164 doc
: /* The command now being executed.
11165 The command can set this variable; whatever is put here
11166 will be in `last-command' during the following command. */);
11167 Vthis_command
= Qnil
;
11169 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11170 doc
: /* The command bound to the current key sequence before remapping.
11171 It equals `this-command' if the original command was not remapped through
11172 any of the active keymaps. Otherwise, the value of `this-command' is the
11173 result of looking up the original command in the active keymaps. */);
11174 Vthis_original_command
= Qnil
;
11176 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11177 doc
: /* *Number of input events between auto-saves.
11178 Zero means disable autosaving due to number of characters typed. */);
11179 auto_save_interval
= 300;
11181 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11182 doc
: /* *Number of seconds idle time before auto-save.
11183 Zero or nil means disable auto-saving due to idleness.
11184 After auto-saving due to this many seconds of idle time,
11185 Emacs also does a garbage collection if that seems to be warranted. */);
11186 XSETFASTINT (Vauto_save_timeout
, 30);
11188 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11189 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11190 The value may be integer or floating point. */);
11191 Vecho_keystrokes
= make_number (1);
11193 DEFVAR_INT ("polling-period", &polling_period
,
11194 doc
: /* *Interval between polling for input during Lisp execution.
11195 The reason for polling is to make C-g work to stop a running program.
11196 Polling is needed only when using X windows and SIGIO does not work.
11197 Polling is automatically disabled in all other cases. */);
11198 polling_period
= 2;
11200 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11201 doc
: /* *Maximum time between mouse clicks to make a double-click.
11202 Measured in milliseconds. nil means disable double-click recognition;
11203 t means double-clicks have no time limit and are detected
11204 by position only. */);
11205 Vdouble_click_time
= make_number (500);
11207 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11208 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11209 On window-system frames, value is the number of pixels the mouse may have
11210 moved horizontally or vertically between two clicks to make a double-click.
11211 On non window-system frames, value is interpreted in units of 1/8 characters
11214 This variable is also the threshold for motion of the mouse
11215 to count as a drag. */);
11216 double_click_fuzz
= 3;
11218 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11219 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11220 inhibit_local_menu_bar_menus
= 0;
11222 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11223 doc
: /* Number of complete key sequences read as input so far.
11224 This includes key sequences read from keyboard macros.
11225 The number is effectively the number of interactive command invocations. */);
11226 num_input_keys
= 0;
11228 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11229 doc
: /* Number of input events read from the keyboard so far.
11230 This does not include events generated by keyboard macros. */);
11231 num_nonmacro_input_events
= 0;
11233 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11234 doc
: /* The frame in which the most recently read event occurred.
11235 If the last event came from a keyboard macro, this is set to `macro'. */);
11236 Vlast_event_frame
= Qnil
;
11238 /* This variable is set up in sysdep.c. */
11239 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11240 doc
: /* The ERASE character as set by the user with stty. */);
11242 DEFVAR_LISP ("help-char", &Vhelp_char
,
11243 doc
: /* Character to recognize as meaning Help.
11244 When it is read, do `(eval help-form)', and display result if it's a string.
11245 If the value of `help-form' is nil, this char can be read normally. */);
11246 XSETINT (Vhelp_char
, Ctl ('H'));
11248 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11249 doc
: /* List of input events to recognize as meaning Help.
11250 These work just like the value of `help-char' (see that). */);
11251 Vhelp_event_list
= Qnil
;
11253 DEFVAR_LISP ("help-form", &Vhelp_form
,
11254 doc
: /* Form to execute when character `help-char' is read.
11255 If the form returns a string, that string is displayed.
11256 If `help-form' is nil, the help char is not recognized. */);
11259 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11260 doc
: /* Command to run when `help-char' character follows a prefix key.
11261 This command is used only when there is no actual binding
11262 for that character after that prefix key. */);
11263 Vprefix_help_command
= Qnil
;
11265 DEFVAR_LISP ("top-level", &Vtop_level
,
11266 doc
: /* Form to evaluate when Emacs starts up.
11267 Useful to set before you dump a modified Emacs. */);
11270 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11271 doc
: /* Translate table for keyboard input, or nil.
11272 If non-nil, the value should be a char-table. Each character read
11273 from the keyboard is looked up in this char-table. If the value found
11274 there is non-nil, then it is used instead of the actual input character.
11276 The value can also be a string or vector, but this is considered obsolete.
11277 If it is a string or vector of length N, character codes N and up are left
11278 untranslated. In a vector, an element which is nil means "no translation".
11280 This is applied to the characters supplied to input methods, not their
11281 output. See also `translation-table-for-input'. */);
11282 Vkeyboard_translate_table
= Qnil
;
11284 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11285 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11286 \(Even if the operating system has support for stopping a process.\) */);
11287 cannot_suspend
= 0;
11289 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11290 doc
: /* Non-nil means prompt with menus when appropriate.
11291 This is done when reading from a keymap that has a prompt string,
11292 for elements that have prompt strings.
11293 The menu is displayed on the screen
11294 if X menus were enabled at configuration
11295 time and the previous event was a mouse click prefix key.
11296 Otherwise, menu prompting uses the echo area. */);
11297 menu_prompting
= 1;
11299 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11300 doc
: /* Character to see next line of menu prompt.
11301 Type this character while in a menu prompt to rotate around the lines of it. */);
11302 XSETINT (menu_prompt_more_char
, ' ');
11304 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11305 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11306 Emacs applies the modifiers of the character stored here to each keyboard
11307 character it reads. For example, after evaluating the expression
11308 (setq extra-keyboard-modifiers ?\\C-x)
11309 all input characters will have the control modifier applied to them.
11311 Note that the character ?\\C-@, equivalent to the integer zero, does
11312 not count as a control character; rather, it counts as a character
11313 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11314 cancels any modification. */);
11315 extra_keyboard_modifiers
= 0;
11317 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11318 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11319 The command loop sets this to nil before each command,
11320 and tests the value when the command returns.
11321 Buffer modification stores t in this variable. */);
11322 Vdeactivate_mark
= Qnil
;
11324 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11325 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11326 Vcommand_hook_internal
= Qnil
;
11328 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11329 doc
: /* Normal hook run before each command is executed.
11330 If an unhandled error happens in running this hook,
11331 the hook value is set to nil, since otherwise the error
11332 might happen repeatedly and make Emacs nonfunctional. */);
11333 Vpre_command_hook
= Qnil
;
11335 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11336 doc
: /* Normal hook run after each command is executed.
11337 If an unhandled error happens in running this hook,
11338 the hook value is set to nil, since otherwise the error
11339 might happen repeatedly and make Emacs nonfunctional. */);
11340 Vpost_command_hook
= Qnil
;
11343 DEFVAR_LISP ("echo-area-clear-hook", ...,
11344 doc
: /* Normal hook run when clearing the echo area. */);
11346 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11347 staticpro (&Qecho_area_clear_hook
);
11348 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11350 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11351 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11352 Vlucid_menu_bar_dirty_flag
= Qnil
;
11354 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11355 doc
: /* List of menu bar items to move to the end of the menu bar.
11356 The elements of the list are event types that may have menu bar bindings. */);
11357 Vmenu_bar_final_items
= Qnil
;
11359 DEFVAR_KBOARD ("overriding-terminal-local-map",
11360 Voverriding_terminal_local_map
,
11361 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11362 If this variable is non-nil, it is used as a keymap instead of the
11363 buffer's local map, and the minor mode keymaps and text property keymaps.
11364 It also replaces `overriding-local-map'.
11366 This variable is intended to let commands such as `universal-argument'
11367 set up a different keymap for reading the next command. */);
11369 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11370 doc
: /* Keymap that overrides all other local keymaps.
11371 If this variable is non-nil, it is used as a keymap--replacing the
11372 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11373 Voverriding_local_map
= Qnil
;
11375 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11376 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11377 Otherwise, the menu bar continues to reflect the buffer's local map
11378 and the minor mode maps regardless of `overriding-local-map'. */);
11379 Voverriding_local_map_menu_flag
= Qnil
;
11381 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11382 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11383 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11385 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11386 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11388 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11389 doc
: /* Alist of system-specific X windows key symbols.
11390 Each element should have the form (N . SYMBOL) where N is the
11391 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11392 and SYMBOL is its name. */);
11394 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11395 doc
: /* List of deferred actions to be performed at a later time.
11396 The precise format isn't relevant here; we just check whether it is nil. */);
11397 Vdeferred_action_list
= Qnil
;
11399 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11400 doc
: /* Function to call to handle deferred actions, after each command.
11401 This function is called with no arguments after each command
11402 whenever `deferred-action-list' is non-nil. */);
11403 Vdeferred_action_function
= Qnil
;
11405 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11406 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11407 The value can be a length of time to show the message for.
11408 If the value is non-nil and not a number, we wait 2 seconds. */);
11409 Vsuggest_key_bindings
= Qt
;
11411 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11412 doc
: /* List of active absolute time timers in order of increasing time. */);
11413 Vtimer_list
= Qnil
;
11415 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11416 doc
: /* List of active idle-time timers in order of increasing time. */);
11417 Vtimer_idle_list
= Qnil
;
11419 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11420 doc
: /* If non-nil, the function that implements the current input method.
11421 It's called with one argument, a printing character that was just read.
11422 \(That means a character with code 040...0176.)
11423 Typically this function uses `read-event' to read additional events.
11424 When it does so, it should first bind `input-method-function' to nil
11425 so it will not be called recursively.
11427 The function should return a list of zero or more events
11428 to be used as input. If it wants to put back some events
11429 to be reconsidered, separately, by the input method,
11430 it can add them to the beginning of `unread-command-events'.
11432 The input method function can find in `input-method-previous-method'
11433 the previous echo area message.
11435 The input method function should refer to the variables
11436 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11437 for guidance on what to do. */);
11438 Vinput_method_function
= Qnil
;
11440 DEFVAR_LISP ("input-method-previous-message",
11441 &Vinput_method_previous_message
,
11442 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11443 This variable exists because `read-event' clears the echo area
11444 before running the input method. It is nil if there was no message. */);
11445 Vinput_method_previous_message
= Qnil
;
11447 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11448 doc
: /* If non-nil, the function that implements the display of help.
11449 It's called with one argument, the help string to display. */);
11450 Vshow_help_function
= Qnil
;
11452 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11453 doc
: /* If non-nil, suppress point adjustment after executing a command.
11455 After a command is executed, if point is moved into a region that has
11456 special properties (e.g. composition, display), we adjust point to
11457 the boundary of the region. But, when a command sets this variable to
11458 non-nil, we suppress the point adjustment.
11460 This variable is set to nil before reading a command, and is checked
11461 just after executing the command. */);
11462 Vdisable_point_adjustment
= Qnil
;
11464 DEFVAR_LISP ("global-disable-point-adjustment",
11465 &Vglobal_disable_point_adjustment
,
11466 doc
: /* *If non-nil, always suppress point adjustment.
11468 The default value is nil, in which case, point adjustment are
11469 suppressed only after special commands that set
11470 `disable-point-adjustment' (which see) to non-nil. */);
11471 Vglobal_disable_point_adjustment
= Qnil
;
11473 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11474 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11475 If the value is not a number, such messages don't time out. */);
11476 Vminibuffer_message_timeout
= make_number (2);
11478 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11479 doc
: /* If non-nil, any keyboard input throws to this symbol.
11480 The value of that variable is passed to `quit-flag' and later causes a
11481 peculiar kind of quitting. */);
11482 Vthrow_on_input
= Qnil
;
11484 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
11485 doc
: /* If non-nil, function to output error messages.
11486 The arguments are the error data, a list of the form
11487 (SIGNALED-CONDITIONS . SIGNAL-DATA)
11488 such as just as `condition-case' would bind its variable to,
11489 the context (a string which normally goes at the start of the message),
11490 and the Lisp function within which the error was signaled. */);
11491 Vcommand_error_function
= Qnil
;
11493 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11494 &Venable_disabled_menus_and_buttons
,
11495 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11497 Help functions bind this to allow help on disabled menu items
11498 and tool-bar buttons. */);
11499 Venable_disabled_menus_and_buttons
= Qnil
;
11503 keys_of_keyboard ()
11505 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11506 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11507 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11508 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11509 initial_define_key (meta_map
, 'x', "execute-extended-command");
11511 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11512 "handle-delete-frame");
11513 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11514 current-prefix-arg, as is done in `handle-switch-frame'.
11515 But `handle-switch-frame is not run from the special-map.
11516 Commands from that map are run in a special way that automatically
11517 preserves the prefix-arg. Restoring the prefix arg here is not just
11518 redundant but harmful:
11520 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11521 - after the first prompt, the exit-minibuffer-hook is run which may
11522 iconify a frame and thus push a `iconify-frame' event.
11523 - after running exit-minibuffer-hook, current-prefix-arg is
11524 restored to the non-nil value it had before the prompt.
11525 - we enter the second prompt.
11526 current-prefix-arg is non-nil, prefix-arg is nil.
11527 - before running the first real event, we run the special iconify-frame
11528 event, but we pass the `special' arg to execute-command so
11529 current-prefix-arg and prefix-arg are left untouched.
11530 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11531 - the next key event will have a spuriously non-nil current-prefix-arg. */
11532 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11534 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11536 /* Handling it at such a low-level causes read_key_sequence to get
11537 * confused because it doesn't realize that the current_buffer was
11538 * changed by read_char.
11540 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11541 * "handle-select-window"); */
11542 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11543 "handle-save-session");
11546 /* Mark the pointers in the kboard objects.
11547 Called by the Fgarbage_collector. */
11553 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11555 if (kb
->kbd_macro_buffer
)
11556 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11558 mark_object (kb
->Voverriding_terminal_local_map
);
11559 mark_object (kb
->Vlast_command
);
11560 mark_object (kb
->Vreal_last_command
);
11561 mark_object (kb
->Vprefix_arg
);
11562 mark_object (kb
->Vlast_prefix_arg
);
11563 mark_object (kb
->kbd_queue
);
11564 mark_object (kb
->defining_kbd_macro
);
11565 mark_object (kb
->Vlast_kbd_macro
);
11566 mark_object (kb
->Vsystem_key_alist
);
11567 mark_object (kb
->system_key_syms
);
11568 mark_object (kb
->Vdefault_minibuffer_frame
);
11569 mark_object (kb
->echo_string
);
11572 struct input_event
*event
;
11573 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11575 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11576 event
= kbd_buffer
;
11577 if (event
->kind
!= SELECTION_REQUEST_EVENT
11578 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11580 mark_object (event
->x
);
11581 mark_object (event
->y
);
11583 mark_object (event
->frame_or_window
);
11584 mark_object (event
->arg
);
11589 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11590 (do not change this comment) */