1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
3 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
29 #include "termhooks.h"
38 #include "dispextern.h"
40 #include "intervals.h"
42 #include "blockinput.h"
49 #ifdef HAVE_GTK_AND_PTHREAD
57 #include <sys/ioctl.h>
59 #endif /* not MSDOS */
61 #include "syssignal.h"
64 #include <sys/types.h>
73 /* This is to get the definitions of the XK_ symbols. */
80 #endif /* HAVE_NTGUI */
90 /* Variables for blockinput.h: */
92 /* Non-zero if interrupt input is blocked right now. */
93 int interrupt_input_blocked
;
95 /* Nonzero means an input interrupt has arrived
96 during the current critical section. */
97 int interrupt_input_pending
;
100 /* File descriptor to use for input. */
103 #ifdef HAVE_WINDOW_SYSTEM
104 /* Make all keyboard buffers much bigger when using X windows. */
106 /* But not too big (local data > 32K error) if on Mac OS Classic. */
107 #define KBD_BUFFER_SIZE 512
109 #define KBD_BUFFER_SIZE 4096
111 #else /* No X-windows, character input */
112 #define KBD_BUFFER_SIZE 4096
113 #endif /* No X-windows */
115 #define abs(x) ((x) >= 0 ? (x) : -(x))
117 /* Following definition copied from eval.c */
121 struct backtrace
*next
;
122 Lisp_Object
*function
;
123 Lisp_Object
*args
; /* Points to vector of args. */
124 int nargs
; /* length of vector. If nargs is UNEVALLED,
125 args points to slot holding list of
128 /* Nonzero means call value of debugger when done with this operation. */
133 KBOARD
*initial_kboard
;
134 KBOARD
*current_kboard
;
138 KBOARD the_only_kboard
;
141 /* Non-nil disable property on a command means
142 do not execute it; call disabled-command-function's value instead. */
143 Lisp_Object Qdisabled
, Qdisabled_command_function
;
145 #define NUM_RECENT_KEYS (100)
146 int recent_keys_index
; /* Index for storing next element into recent_keys */
147 int total_keys
; /* Total number of elements stored into recent_keys */
148 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
150 /* Vector holding the key sequence that invoked the current command.
151 It is reused for each command, and it may be longer than the current
152 sequence; this_command_key_count indicates how many elements
153 actually mean something.
154 It's easier to staticpro a single Lisp_Object than an array. */
155 Lisp_Object this_command_keys
;
156 int this_command_key_count
;
158 /* 1 after calling Freset_this_command_lengths.
160 int this_command_key_count_reset
;
162 /* This vector is used as a buffer to record the events that were actually read
163 by read_key_sequence. */
164 Lisp_Object raw_keybuf
;
165 int raw_keybuf_count
;
167 #define GROW_RAW_KEYBUF \
168 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
170 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
172 new = Fmake_vector (make_number (newsize), Qnil); \
173 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
174 raw_keybuf_count * sizeof (Lisp_Object)); \
178 /* Number of elements of this_command_keys
179 that precede this key sequence. */
180 int this_single_command_key_start
;
182 /* Record values of this_command_key_count and echo_length ()
183 before this command was read. */
184 static int before_command_key_count
;
185 static int before_command_echo_length
;
187 extern int minbuf_level
;
189 extern int message_enable_multibyte
;
191 extern struct backtrace
*backtrace_list
;
193 /* If non-nil, the function that implements the display of help.
194 It's called with one argument, the help string to display. */
196 Lisp_Object Vshow_help_function
;
198 /* If a string, the message displayed before displaying a help-echo
201 Lisp_Object Vpre_help_message
;
203 /* Nonzero means do menu prompting. */
205 static int menu_prompting
;
207 /* Character to see next line of menu prompt. */
209 static Lisp_Object menu_prompt_more_char
;
211 /* For longjmp to where kbd input is being done. */
213 static jmp_buf getcjmp
;
215 /* True while doing kbd input. */
216 int waiting_for_input
;
218 /* True while displaying for echoing. Delays C-g throwing. */
222 /* Non-null means we can start echoing at the next input pause even
223 though there is something in the echo area. */
225 static struct kboard
*ok_to_echo_at_next_pause
;
227 /* The kboard last echoing, or null for none. Reset to 0 in
228 cancel_echoing. If non-null, and a current echo area message
229 exists, and echo_message_buffer is eq to the current message
230 buffer, we know that the message comes from echo_kboard. */
232 struct kboard
*echo_kboard
;
234 /* The buffer used for echoing. Set in echo_now, reset in
237 Lisp_Object echo_message_buffer
;
239 /* Nonzero means disregard local maps for the menu bar. */
240 static int inhibit_local_menu_bar_menus
;
242 /* Nonzero means C-g should cause immediate error-signal. */
245 /* The user's ERASE setting. */
246 Lisp_Object Vtty_erase_char
;
248 /* Character to recognize as the help char. */
249 Lisp_Object Vhelp_char
;
251 /* List of other event types to recognize as meaning "help". */
252 Lisp_Object Vhelp_event_list
;
254 /* Form to execute when help char is typed. */
255 Lisp_Object Vhelp_form
;
257 /* Command to run when the help character follows a prefix key. */
258 Lisp_Object Vprefix_help_command
;
260 /* List of items that should move to the end of the menu bar. */
261 Lisp_Object Vmenu_bar_final_items
;
263 /* Non-nil means show the equivalent key-binding for
264 any M-x command that has one.
265 The value can be a length of time to show the message for.
266 If the value is non-nil and not a number, we wait 2 seconds. */
267 Lisp_Object Vsuggest_key_bindings
;
269 /* How long to display an echo-area message when the minibuffer is active.
270 If the value is not a number, such messages don't time out. */
271 Lisp_Object Vminibuffer_message_timeout
;
273 /* Character that causes a quit. Normally C-g.
275 If we are running on an ordinary terminal, this must be an ordinary
276 ASCII char, since we want to make it our interrupt character.
278 If we are not running on an ordinary terminal, it still needs to be
279 an ordinary ASCII char. This character needs to be recognized in
280 the input interrupt handler. At this point, the keystroke is
281 represented as a struct input_event, while the desired quit
282 character is specified as a lispy event. The mapping from struct
283 input_events to lispy events cannot run in an interrupt handler,
284 and the reverse mapping is difficult for anything but ASCII
287 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
291 extern Lisp_Object current_global_map
;
292 extern int minibuf_level
;
294 /* If non-nil, this is a map that overrides all other local maps. */
295 Lisp_Object Voverriding_local_map
;
297 /* If non-nil, Voverriding_local_map applies to the menu bar. */
298 Lisp_Object Voverriding_local_map_menu_flag
;
300 /* Keymap that defines special misc events that should
301 be processed immediately at a low level. */
302 Lisp_Object Vspecial_event_map
;
304 /* Current depth in recursive edits. */
305 int command_loop_level
;
307 /* Total number of times command_loop has read a key sequence. */
308 EMACS_INT num_input_keys
;
310 /* Last input character read as a command. */
311 Lisp_Object last_command_char
;
313 /* Last input character read as a command, not counting menus
314 reached by the mouse. */
315 Lisp_Object last_nonmenu_event
;
317 /* Last input character read for any purpose. */
318 Lisp_Object last_input_char
;
320 /* If not Qnil, a list of objects to be read as subsequent command input. */
321 Lisp_Object Vunread_command_events
;
323 /* If not Qnil, a list of objects to be read as subsequent command input
324 including input method processing. */
325 Lisp_Object Vunread_input_method_events
;
327 /* If not Qnil, a list of objects to be read as subsequent command input
328 but NOT including input method processing. */
329 Lisp_Object Vunread_post_input_method_events
;
331 /* If not -1, an event to be read as subsequent command input. */
332 EMACS_INT unread_command_char
;
334 /* If not Qnil, this is a switch-frame event which we decided to put
335 off until the end of a key sequence. This should be read as the
336 next command input, after any unread_command_events.
338 read_key_sequence uses this to delay switch-frame events until the
339 end of the key sequence; Fread_char uses it to put off switch-frame
340 events until a non-ASCII event is acceptable as input. */
341 Lisp_Object unread_switch_frame
;
343 /* A mask of extra modifier bits to put into every keyboard char. */
344 EMACS_INT extra_keyboard_modifiers
;
346 /* Char to use as prefix when a meta character is typed in.
347 This is bound on entry to minibuffer in case ESC is changed there. */
349 Lisp_Object meta_prefix_char
;
351 /* Last size recorded for a current buffer which is not a minibuffer. */
352 static int last_non_minibuf_size
;
354 /* Number of idle seconds before an auto-save and garbage collection. */
355 static Lisp_Object Vauto_save_timeout
;
357 /* Total number of times read_char has returned. */
358 int num_input_events
;
360 /* Total number of times read_char has returned, outside of macros. */
361 EMACS_INT num_nonmacro_input_events
;
363 /* Auto-save automatically when this many characters have been typed
364 since the last time. */
366 static EMACS_INT auto_save_interval
;
368 /* Value of num_nonmacro_input_events as of last auto save. */
372 /* The command being executed by the command loop.
373 Commands may set this, and the value set will be copied into
374 current_kboard->Vlast_command instead of the actual command. */
375 Lisp_Object Vthis_command
;
377 /* This is like Vthis_command, except that commands never set it. */
378 Lisp_Object real_this_command
;
380 /* If the lookup of the command returns a binding, the original
381 command is stored in this-original-command. It is nil otherwise. */
382 Lisp_Object Vthis_original_command
;
384 /* The value of point when the last command was started. */
385 int last_point_position
;
387 /* The buffer that was current when the last command was started. */
388 Lisp_Object last_point_position_buffer
;
390 /* The window that was selected when the last command was started. */
391 Lisp_Object last_point_position_window
;
393 /* The frame in which the last input event occurred, or Qmacro if the
394 last event came from a macro. We use this to determine when to
395 generate switch-frame events. This may be cleared by functions
396 like Fselect_frame, to make sure that a switch-frame event is
397 generated by the next character. */
398 Lisp_Object internal_last_event_frame
;
400 /* A user-visible version of the above, intended to allow users to
401 figure out where the last event came from, if the event doesn't
402 carry that information itself (i.e. if it was a character). */
403 Lisp_Object Vlast_event_frame
;
405 /* The timestamp of the last input event we received from the X server.
406 X Windows wants this for selection ownership. */
407 unsigned long last_event_timestamp
;
409 Lisp_Object Qself_insert_command
;
410 Lisp_Object Qforward_char
;
411 Lisp_Object Qbackward_char
;
412 Lisp_Object Qundefined
;
413 Lisp_Object Qtimer_event_handler
;
415 /* read_key_sequence stores here the command definition of the
416 key sequence that it reads. */
417 Lisp_Object read_key_sequence_cmd
;
419 /* Echo unfinished commands after this many seconds of pause. */
420 Lisp_Object Vecho_keystrokes
;
422 /* Form to evaluate (if non-nil) when Emacs is started. */
423 Lisp_Object Vtop_level
;
425 /* User-supplied table to translate input characters. */
426 Lisp_Object Vkeyboard_translate_table
;
428 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
429 extern Lisp_Object Vfunction_key_map
;
431 /* Another keymap that maps key sequences into key sequences.
432 This one takes precedence over ordinary definitions. */
433 extern Lisp_Object Vkey_translation_map
;
435 /* If non-nil, this implements the current input method. */
436 Lisp_Object Vinput_method_function
;
437 Lisp_Object Qinput_method_function
;
439 /* When we call Vinput_method_function,
440 this holds the echo area message that was just erased. */
441 Lisp_Object Vinput_method_previous_message
;
443 /* Non-nil means deactivate the mark at end of this command. */
444 Lisp_Object Vdeactivate_mark
;
446 /* Menu bar specified in Lucid Emacs fashion. */
448 Lisp_Object Vlucid_menu_bar_dirty_flag
;
449 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
451 Lisp_Object Qecho_area_clear_hook
;
453 /* Hooks to run before and after each command. */
454 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
455 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
456 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
458 /* List of deferred actions to be performed at a later time.
459 The precise format isn't relevant here; we just check whether it is nil. */
460 Lisp_Object Vdeferred_action_list
;
462 /* Function to call to handle deferred actions, when there are any. */
463 Lisp_Object Vdeferred_action_function
;
464 Lisp_Object Qdeferred_action_function
;
466 Lisp_Object Qinput_method_exit_on_first_char
;
467 Lisp_Object Qinput_method_use_echo_area
;
469 /* File in which we write all commands we read. */
472 /* Nonzero if input is available. */
475 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
476 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
480 extern char *pending_malloc_warning
;
482 /* Circular buffer for pre-read keyboard input. */
484 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
486 /* Pointer to next available character in kbd_buffer.
487 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
488 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
489 next available char is in kbd_buffer[0]. */
490 static struct input_event
*kbd_fetch_ptr
;
492 /* Pointer to next place to store character in kbd_buffer. This
493 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
494 character should go in kbd_buffer[0]. */
495 static struct input_event
* volatile kbd_store_ptr
;
497 /* The above pair of variables forms a "queue empty" flag. When we
498 enqueue a non-hook event, we increment kbd_store_ptr. When we
499 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
500 there is input available iff the two pointers are not equal.
502 Why not just have a flag set and cleared by the enqueuing and
503 dequeuing functions? Such a flag could be screwed up by interrupts
504 at inopportune times. */
506 /* If this flag is non-nil, we check mouse_moved to see when the
507 mouse moves, and motion events will appear in the input stream.
508 Otherwise, mouse motion is ignored. */
509 Lisp_Object do_mouse_tracking
;
511 /* Symbols to head events. */
512 Lisp_Object Qmouse_movement
;
513 Lisp_Object Qscroll_bar_movement
;
514 Lisp_Object Qswitch_frame
;
515 Lisp_Object Qdelete_frame
;
516 Lisp_Object Qiconify_frame
;
517 Lisp_Object Qmake_frame_visible
;
518 Lisp_Object Qselect_window
;
519 Lisp_Object Qhelp_echo
;
522 Lisp_Object Qmouse_fixup_help_message
;
525 /* Symbols to denote kinds of events. */
526 Lisp_Object Qfunction_key
;
527 Lisp_Object Qmouse_click
;
528 #if defined (WINDOWSNT) || defined (MAC_OS)
529 Lisp_Object Qlanguage_change
;
531 Lisp_Object Qdrag_n_drop
;
532 Lisp_Object Qsave_session
;
534 Lisp_Object Qmac_apple_event
;
537 /* Lisp_Object Qmouse_movement; - also an event header */
539 /* Properties of event headers. */
540 Lisp_Object Qevent_kind
;
541 Lisp_Object Qevent_symbol_elements
;
543 /* menu item parts */
544 Lisp_Object Qmenu_alias
;
545 Lisp_Object Qmenu_enable
;
546 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
547 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
548 extern Lisp_Object Vdefine_key_rebound_commands
;
549 extern Lisp_Object Qmenu_item
;
551 /* An event header symbol HEAD may have a property named
552 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
553 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
554 mask of modifiers applied to it. If present, this is used to help
555 speed up parse_modifiers. */
556 Lisp_Object Qevent_symbol_element_mask
;
558 /* An unmodified event header BASE may have a property named
559 Qmodifier_cache, which is an alist mapping modifier masks onto
560 modified versions of BASE. If present, this helps speed up
562 Lisp_Object Qmodifier_cache
;
564 /* Symbols to use for parts of windows. */
565 Lisp_Object Qmode_line
;
566 Lisp_Object Qvertical_line
;
567 Lisp_Object Qvertical_scroll_bar
;
568 Lisp_Object Qmenu_bar
;
569 extern Lisp_Object Qleft_margin
, Qright_margin
;
570 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
571 extern Lisp_Object QCmap
;
573 Lisp_Object
recursive_edit_unwind (), command_loop ();
574 Lisp_Object
Fthis_command_keys ();
575 Lisp_Object Qextended_command_history
;
576 EMACS_TIME
timer_check ();
578 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
580 extern char *x_get_keysym_name ();
582 static void record_menu_key ();
583 static int echo_length ();
585 Lisp_Object Qpolling_period
;
587 /* List of absolute timers. Appears in order of next scheduled event. */
588 Lisp_Object Vtimer_list
;
590 /* List of idle time timers. Appears in order of next scheduled event. */
591 Lisp_Object Vtimer_idle_list
;
593 /* Incremented whenever a timer is run. */
596 extern Lisp_Object Vprint_level
, Vprint_length
;
598 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
600 EMACS_TIME
*input_available_clear_time
;
602 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
603 Default is 1 if INTERRUPT_INPUT is defined. */
606 /* Nonzero while interrupts are temporarily deferred during redisplay. */
607 int interrupts_deferred
;
609 /* Nonzero means use ^S/^Q for flow control. */
612 /* Allow m- file to inhibit use of FIONREAD. */
613 #ifdef BROKEN_FIONREAD
617 /* We are unable to use interrupts if FIONREAD is not available,
618 so flush SIGIO so we won't try. */
619 #if !defined (FIONREAD)
625 /* If we support a window system, turn on the code to poll periodically
626 to detect C-g. It isn't actually used when doing interrupt input. */
627 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
628 #define POLL_FOR_INPUT
631 /* After a command is executed, if point is moved into a region that
632 has specific properties (e.g. composition, display), we adjust
633 point to the boundary of the region. But, if a command sets this
634 variable to non-nil, we suppress this point adjustment. This
635 variable is set to nil before reading a command. */
637 Lisp_Object Vdisable_point_adjustment
;
639 /* If non-nil, always disable point adjustment. */
641 Lisp_Object Vglobal_disable_point_adjustment
;
643 /* The time when Emacs started being idle. */
645 static EMACS_TIME timer_idleness_start_time
;
647 /* After Emacs stops being idle, this saves the last value
648 of timer_idleness_start_time from when it was idle. */
650 static EMACS_TIME timer_last_idleness_start_time
;
652 /* If non-nil, events produced by disabled menu items and tool-bar
653 buttons are not ignored. Help functions bind this to allow help on
654 those items and buttons. */
655 Lisp_Object Venable_disabled_menus_and_buttons
;
658 /* Global variable declarations. */
660 /* Flags for readable_events. */
661 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
662 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
663 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
665 /* Function for init_keyboard to call with no args (if nonzero). */
666 void (*keyboard_init_hook
) ();
668 static int read_avail_input
P_ ((int));
669 static void get_input_pending
P_ ((int *, int));
670 static int readable_events
P_ ((int));
671 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
672 Lisp_Object
, int *));
673 static Lisp_Object
read_char_x_menu_prompt ();
674 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
676 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
678 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
679 enum scroll_bar_part
,
680 Lisp_Object
, Lisp_Object
,
683 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
684 Lisp_Object
, char **,
685 Lisp_Object
*, unsigned));
686 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
687 static int parse_solitary_modifier
P_ ((Lisp_Object
));
688 static int parse_solitary_modifier ();
689 static void save_getcjmp
P_ ((jmp_buf));
690 static void save_getcjmp ();
691 static void restore_getcjmp
P_ ((jmp_buf));
692 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
693 static void clear_event
P_ ((struct input_event
*));
694 static void any_kboard_state
P_ ((void));
695 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
696 static void timer_start_idle
P_ ((void));
697 static void timer_stop_idle
P_ ((void));
698 static void timer_resume_idle
P_ ((void));
700 /* Nonzero means don't try to suspend even if the operating system seems
702 static int cannot_suspend
;
704 extern Lisp_Object Qidentity
, Qonly
;
706 /* Install the string STR as the beginning of the string of echoing,
707 so that it serves as a prompt for the next character.
708 Also start echoing. */
714 current_kboard
->echo_string
= str
;
715 current_kboard
->echo_after_prompt
= SCHARS (str
);
719 /* Add C to the echo string, if echoing is going on.
720 C can be a character, which is printed prettily ("M-C-x" and all that
721 jazz), or a symbol, whose name is printed. */
727 if (current_kboard
->immediate_echo
)
729 int size
= KEY_DESCRIPTION_SIZE
+ 100;
730 char *buffer
= (char *) alloca (size
);
732 Lisp_Object echo_string
;
734 echo_string
= current_kboard
->echo_string
;
736 /* If someone has passed us a composite event, use its head symbol. */
741 ptr
= push_key_description (XINT (c
), ptr
, 1);
743 else if (SYMBOLP (c
))
745 Lisp_Object name
= SYMBOL_NAME (c
);
746 int nbytes
= SBYTES (name
);
748 if (size
- (ptr
- buffer
) < nbytes
)
750 int offset
= ptr
- buffer
;
751 size
= max (2 * size
, size
+ nbytes
);
752 buffer
= (char *) alloca (size
);
753 ptr
= buffer
+ offset
;
756 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
757 STRING_MULTIBYTE (name
), 1);
760 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
763 const char *text
= " (Type ? for further options)";
764 int len
= strlen (text
);
766 if (size
- (ptr
- buffer
) < len
)
768 int offset
= ptr
- buffer
;
770 buffer
= (char *) alloca (size
);
771 ptr
= buffer
+ offset
;
774 bcopy (text
, ptr
, len
);
778 /* Replace a dash from echo_dash with a space, otherwise
779 add a space at the end as a separator between keys. */
780 if (STRINGP (echo_string
)
781 && SCHARS (echo_string
) > 1)
783 Lisp_Object last_char
, prev_char
, idx
;
785 idx
= make_number (SCHARS (echo_string
) - 2);
786 prev_char
= Faref (echo_string
, idx
);
788 idx
= make_number (SCHARS (echo_string
) - 1);
789 last_char
= Faref (echo_string
, idx
);
791 /* We test PREV_CHAR to make sure this isn't the echoing
793 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
794 Faset (echo_string
, idx
, make_number (' '));
796 echo_string
= concat2 (echo_string
, build_string (" "));
798 else if (STRINGP (echo_string
))
799 echo_string
= concat2 (echo_string
, build_string (" "));
801 current_kboard
->echo_string
802 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
808 /* Temporarily add a dash to the end of the echo string if it's not
809 empty, so that it serves as a mini-prompt for the very next character. */
814 /* Do nothing if not echoing at all. */
815 if (NILP (current_kboard
->echo_string
))
818 if (!current_kboard
->immediate_echo
819 && SCHARS (current_kboard
->echo_string
) == 0)
822 /* Do nothing if we just printed a prompt. */
823 if (current_kboard
->echo_after_prompt
824 == SCHARS (current_kboard
->echo_string
))
827 /* Do nothing if we have already put a dash at the end. */
828 if (SCHARS (current_kboard
->echo_string
) > 1)
830 Lisp_Object last_char
, prev_char
, idx
;
832 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
833 prev_char
= Faref (current_kboard
->echo_string
, idx
);
835 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
836 last_char
= Faref (current_kboard
->echo_string
, idx
);
838 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
842 /* Put a dash at the end of the buffer temporarily,
843 but make it go away when the next character is added. */
844 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
849 /* Display the current echo string, and begin echoing if not already
855 if (!current_kboard
->immediate_echo
)
858 current_kboard
->immediate_echo
= 1;
860 for (i
= 0; i
< this_command_key_count
; i
++)
864 /* Set before_command_echo_length to the value that would
865 have been saved before the start of this subcommand in
866 command_loop_1, if we had already been echoing then. */
867 if (i
== this_single_command_key_start
)
868 before_command_echo_length
= echo_length ();
870 c
= XVECTOR (this_command_keys
)->contents
[i
];
871 if (! (EVENT_HAS_PARAMETERS (c
)
872 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
876 /* Set before_command_echo_length to the value that would
877 have been saved before the start of this subcommand in
878 command_loop_1, if we had already been echoing then. */
879 if (this_command_key_count
== this_single_command_key_start
)
880 before_command_echo_length
= echo_length ();
882 /* Put a dash at the end to invite the user to type more. */
887 message3_nolog (current_kboard
->echo_string
,
888 SBYTES (current_kboard
->echo_string
),
889 STRING_MULTIBYTE (current_kboard
->echo_string
));
892 /* Record in what buffer we echoed, and from which kboard. */
893 echo_message_buffer
= echo_area_buffer
[0];
894 echo_kboard
= current_kboard
;
896 if (waiting_for_input
&& !NILP (Vquit_flag
))
897 quit_throw_to_read_char ();
900 /* Turn off echoing, for the start of a new command. */
905 current_kboard
->immediate_echo
= 0;
906 current_kboard
->echo_after_prompt
= -1;
907 current_kboard
->echo_string
= Qnil
;
908 ok_to_echo_at_next_pause
= NULL
;
910 echo_message_buffer
= Qnil
;
913 /* Return the length of the current echo string. */
918 return (STRINGP (current_kboard
->echo_string
)
919 ? SCHARS (current_kboard
->echo_string
)
923 /* Truncate the current echo message to its first LEN chars.
924 This and echo_char get used by read_key_sequence when the user
925 switches frames while entering a key sequence. */
928 echo_truncate (nchars
)
931 if (STRINGP (current_kboard
->echo_string
))
932 current_kboard
->echo_string
933 = Fsubstring (current_kboard
->echo_string
,
934 make_number (0), make_number (nchars
));
935 truncate_echo_area (nchars
);
939 /* Functions for manipulating this_command_keys. */
941 add_command_key (key
)
944 #if 0 /* Not needed after we made Freset_this_command_lengths
945 do the job immediately. */
946 /* If reset-this-command-length was called recently, obey it now.
947 See the doc string of that function for an explanation of why. */
948 if (before_command_restore_flag
)
950 this_command_key_count
= before_command_key_count_1
;
951 if (this_command_key_count
< this_single_command_key_start
)
952 this_single_command_key_start
= this_command_key_count
;
953 echo_truncate (before_command_echo_length_1
);
954 before_command_restore_flag
= 0;
958 if (this_command_key_count
>= ASIZE (this_command_keys
))
959 this_command_keys
= larger_vector (this_command_keys
,
960 2 * ASIZE (this_command_keys
),
963 AREF (this_command_keys
, this_command_key_count
) = key
;
964 ++this_command_key_count
;
971 int count
= SPECPDL_INDEX ();
974 if (command_loop_level
> 0)
976 specbind (Qstandard_output
, Qt
);
977 specbind (Qstandard_input
, Qt
);
980 #ifdef HAVE_X_WINDOWS
981 /* The command loop has started an hourglass timer, so we have to
982 cancel it here, otherwise it will fire because the recursive edit
983 can take some time. Do not check for display_hourglass_p here,
984 because it could already be nil. */
988 /* This function may have been called from a debugger called from
989 within redisplay, for instance by Edebugging a function called
990 from fontification-functions. We want to allow redisplay in
991 the debugging session.
993 The recursive edit is left with a `(throw exit ...)'. The `exit'
994 tag is not caught anywhere in redisplay, i.e. when we leave the
995 recursive edit, the original redisplay leading to the recursive
996 edit will be unwound. The outcome should therefore be safe. */
997 specbind (Qinhibit_redisplay
, Qnil
);
1000 val
= command_loop ();
1002 Fsignal (Qquit
, Qnil
);
1003 /* Handle throw from read_minibuf when using minibuffer
1004 while it's active but we're in another window. */
1006 Fsignal (Qerror
, Fcons (val
, Qnil
));
1008 return unbind_to (count
, Qnil
);
1011 /* When an auto-save happens, record the "time", and don't do again soon. */
1016 last_auto_save
= num_nonmacro_input_events
;
1019 /* Make an auto save happen as soon as possible at command level. */
1022 force_auto_save_soon ()
1024 last_auto_save
= - auto_save_interval
- 1;
1026 record_asynch_buffer_change ();
1029 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1030 doc
: /* Invoke the editor command loop recursively.
1031 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1032 that tells this function to return.
1033 Alternatively, `(throw 'exit t)' makes this function signal an error.
1034 This function is called by the editor initialization to begin editing. */)
1037 int count
= SPECPDL_INDEX ();
1040 /* If we enter while input is blocked, don't lock up here.
1041 This may happen through the debugger during redisplay. */
1042 if (INPUT_BLOCKED_P
)
1045 command_loop_level
++;
1046 update_mode_lines
= 1;
1048 if (command_loop_level
1049 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1050 buffer
= Fcurrent_buffer ();
1054 /* If we leave recursive_edit_1 below with a `throw' for instance,
1055 like it is done in the splash screen display, we have to
1056 make sure that we restore single_kboard as command_loop_1
1057 would have done if it were left normally. */
1058 record_unwind_protect (recursive_edit_unwind
,
1059 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1061 recursive_edit_1 ();
1062 return unbind_to (count
, Qnil
);
1066 recursive_edit_unwind (info
)
1069 if (BUFFERP (XCAR (info
)))
1070 Fset_buffer (XCAR (info
));
1072 if (NILP (XCDR (info
)))
1073 any_kboard_state ();
1075 single_kboard_state ();
1077 command_loop_level
--;
1078 update_mode_lines
= 1;
1087 #if 0 /* Theory: if there's anything in Vunread_command_events,
1088 it will right away be read by read_key_sequence,
1089 and then if we do switch KBOARDS, it will go into the side
1090 queue then. So we don't need to do anything special here -- rms. */
1091 if (CONSP (Vunread_command_events
))
1093 current_kboard
->kbd_queue
1094 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1095 current_kboard
->kbd_queue_has_data
= 1;
1097 Vunread_command_events
= Qnil
;
1103 /* Switch to the single-kboard state, making current_kboard
1104 the only KBOARD from which further input is accepted. */
1107 single_kboard_state ()
1114 /* If we're in single_kboard state for kboard KBOARD,
1118 not_single_kboard_state (kboard
)
1122 if (kboard
== current_kboard
)
1127 /* Maintain a stack of kboards, so other parts of Emacs
1128 can switch temporarily to the kboard of a given frame
1129 and then revert to the previous status. */
1134 struct kboard_stack
*next
;
1137 static struct kboard_stack
*kboard_stack
;
1140 push_frame_kboard (f
)
1144 struct kboard_stack
*p
1145 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1147 p
->next
= kboard_stack
;
1148 p
->kboard
= current_kboard
;
1151 current_kboard
= FRAME_KBOARD (f
);
1159 struct kboard_stack
*p
= kboard_stack
;
1160 current_kboard
= p
->kboard
;
1161 kboard_stack
= p
->next
;
1166 /* Handle errors that are not handled at inner levels
1167 by printing an error message and returning to the editor command loop. */
1173 Lisp_Object old_level
, old_length
;
1174 char macroerror
[50];
1176 #ifdef HAVE_X_WINDOWS
1177 if (display_hourglass_p
)
1178 cancel_hourglass ();
1181 if (!NILP (executing_kbd_macro
))
1183 if (executing_kbd_macro_iterations
== 1)
1184 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1186 sprintf (macroerror
, "After %d kbd macro iterations: ",
1187 executing_kbd_macro_iterations
);
1192 Vstandard_output
= Qt
;
1193 Vstandard_input
= Qt
;
1194 Vexecuting_kbd_macro
= Qnil
;
1195 executing_kbd_macro
= Qnil
;
1196 current_kboard
->Vprefix_arg
= Qnil
;
1197 current_kboard
->Vlast_prefix_arg
= Qnil
;
1200 /* Avoid unquittable loop if data contains a circular list. */
1201 old_level
= Vprint_level
;
1202 old_length
= Vprint_length
;
1203 XSETFASTINT (Vprint_level
, 10);
1204 XSETFASTINT (Vprint_length
, 10);
1205 cmd_error_internal (data
, macroerror
);
1206 Vprint_level
= old_level
;
1207 Vprint_length
= old_length
;
1211 Vinhibit_quit
= Qnil
;
1213 if (command_loop_level
== 0 && minibuf_level
== 0)
1214 any_kboard_state ();
1217 return make_number (0);
1220 /* Take actions on handling an error. DATA is the data that describes
1223 CONTEXT is a C-string containing ASCII characters only which
1224 describes the context in which the error happened. If we need to
1225 generalize CONTEXT to allow multibyte characters, make it a Lisp
1229 cmd_error_internal (data
, context
)
1234 int kill_emacs_p
= 0;
1235 struct frame
*sf
= SELECTED_FRAME ();
1239 clear_message (1, 0);
1241 /* If the window system or terminal frame hasn't been initialized
1242 yet, or we're not interactive, it's best to dump this message out
1243 to stderr and exit. */
1244 if (!sf
->glyphs_initialized_p
1245 /* This is the case of the frame dumped with Emacs, when we're
1246 running under a window system. */
1247 || (!NILP (Vwindow_system
)
1248 && !inhibit_window_system
1249 && FRAME_TERMCAP_P (sf
))
1252 stream
= Qexternal_debugging_output
;
1258 message_log_maybe_newline ();
1263 /* The immediate context is not interesting for Quits,
1264 since they are asyncronous. */
1265 if (EQ (XCAR (data
), Qquit
))
1266 Vsignaling_function
= Qnil
;
1268 print_error_message (data
, stream
, context
, Vsignaling_function
);
1270 Vsignaling_function
= Qnil
;
1272 /* If the window system or terminal frame hasn't been initialized
1273 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1277 Fkill_emacs (make_number (-1));
1281 Lisp_Object
command_loop_1 ();
1282 Lisp_Object
command_loop_2 ();
1283 Lisp_Object
top_level_1 ();
1285 /* Entry to editor-command-loop.
1286 This level has the catches for exiting/returning to editor command loop.
1287 It returns nil to exit recursive edit, t to abort it. */
1292 if (command_loop_level
> 0 || minibuf_level
> 0)
1295 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1296 executing_kbd_macro
= Qnil
;
1302 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1303 /* Reset single_kboard in case top-level set it while
1304 evaluating an -f option, or we are stuck there for some
1306 any_kboard_state ();
1307 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1308 executing_kbd_macro
= Qnil
;
1310 /* End of file in -batch run causes exit here. */
1316 /* Here we catch errors in execution of commands within the
1317 editing loop, and reenter the editing loop.
1318 When there is an error, cmd_error runs and returns a non-nil
1319 value to us. A value of nil means that command_loop_1 itself
1320 returned due to end of file (or end of kbd macro). */
1325 register Lisp_Object val
;
1328 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1329 while (!NILP (val
));
1337 return Feval (Vtop_level
);
1343 /* On entry to the outer level, run the startup file */
1344 if (!NILP (Vtop_level
))
1345 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1346 else if (!NILP (Vpurify_flag
))
1347 message ("Bare impure Emacs (standard Lisp code not loaded)");
1349 message ("Bare Emacs (standard Lisp code not loaded)");
1353 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1354 doc
: /* Exit all recursive editing levels. */)
1357 #ifdef HAVE_X_WINDOWS
1358 if (display_hourglass_p
)
1359 cancel_hourglass ();
1362 /* Unblock input if we enter with input blocked. This may happen if
1363 redisplay traps e.g. during tool-bar update with input blocked. */
1364 while (INPUT_BLOCKED_P
)
1367 return Fthrow (Qtop_level
, Qnil
);
1370 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1371 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1374 if (command_loop_level
> 0 || minibuf_level
> 0)
1375 Fthrow (Qexit
, Qnil
);
1377 error ("No recursive edit is in progress");
1381 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1382 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1385 if (command_loop_level
> 0 || minibuf_level
> 0)
1388 error ("No recursive edit is in progress");
1392 /* This is the actual command reading loop,
1393 sans error-handling encapsulation. */
1395 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1397 void safe_run_hooks
P_ ((Lisp_Object
));
1398 static void adjust_point_for_property
P_ ((int, int));
1400 /* Cancel hourglass from protect_unwind.
1402 #ifdef HAVE_X_WINDOWS
1404 cancel_hourglass_unwind (arg
)
1407 cancel_hourglass ();
1418 Lisp_Object keybuf
[30];
1421 int prev_modiff
= 0;
1422 struct buffer
*prev_buffer
= NULL
;
1424 int was_locked
= single_kboard
;
1426 int already_adjusted
;
1428 current_kboard
->Vprefix_arg
= Qnil
;
1429 current_kboard
->Vlast_prefix_arg
= Qnil
;
1430 Vdeactivate_mark
= Qnil
;
1431 waiting_for_input
= 0;
1435 this_command_key_count
= 0;
1436 this_command_key_count_reset
= 0;
1437 this_single_command_key_start
= 0;
1439 if (NILP (Vmemory_full
))
1441 /* Make sure this hook runs after commands that get errors and
1442 throw to top level. */
1443 /* Note that the value cell will never directly contain nil
1444 if the symbol is a local variable. */
1445 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1446 safe_run_hooks (Qpost_command_hook
);
1448 /* If displaying a message, resize the echo area window to fit
1449 that message's size exactly. */
1450 if (!NILP (echo_area_buffer
[0]))
1451 resize_echo_area_exactly ();
1453 if (!NILP (Vdeferred_action_list
))
1454 safe_run_hooks (Qdeferred_action_function
);
1457 /* Do this after running Vpost_command_hook, for consistency. */
1458 current_kboard
->Vlast_command
= Vthis_command
;
1459 current_kboard
->Vreal_last_command
= real_this_command
;
1463 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1466 /* Make sure the current window's buffer is selected. */
1467 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1468 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1470 /* Display any malloc warning that just came out. Use while because
1471 displaying one warning can cause another. */
1473 while (pending_malloc_warning
)
1474 display_malloc_warning ();
1478 Vdeactivate_mark
= Qnil
;
1480 /* If minibuffer on and echo area in use,
1481 wait a short time and redraw minibuffer. */
1484 && !NILP (echo_area_buffer
[0])
1485 && EQ (minibuf_window
, echo_area_window
)
1486 && NUMBERP (Vminibuffer_message_timeout
))
1488 /* Bind inhibit-quit to t so that C-g gets read in
1489 rather than quitting back to the minibuffer. */
1490 int count
= SPECPDL_INDEX ();
1491 double duration
= extract_float (Vminibuffer_message_timeout
);
1492 specbind (Qinhibit_quit
, Qt
);
1494 sit_for ((int) duration
, (duration
- (int) duration
) * 1000000,
1496 /* Clear the echo area. */
1498 safe_run_hooks (Qecho_area_clear_hook
);
1500 unbind_to (count
, Qnil
);
1502 /* If a C-g came in before, treat it as input now. */
1503 if (!NILP (Vquit_flag
))
1506 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1511 alloca (0); /* Cause a garbage collection now */
1512 /* Since we can free the most stuff here. */
1513 #endif /* C_ALLOCA */
1516 /* Select the frame that the last event came from. Usually,
1517 switch-frame events will take care of this, but if some lisp
1518 code swallows a switch-frame event, we'll fix things up here.
1519 Is this a good idea? */
1520 if (FRAMEP (internal_last_event_frame
)
1521 && !EQ (internal_last_event_frame
, selected_frame
))
1522 Fselect_frame (internal_last_event_frame
);
1524 /* If it has changed current-menubar from previous value,
1525 really recompute the menubar from the value. */
1526 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1527 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1528 call0 (Qrecompute_lucid_menubar
);
1530 before_command_key_count
= this_command_key_count
;
1531 before_command_echo_length
= echo_length ();
1533 Vthis_command
= Qnil
;
1534 real_this_command
= Qnil
;
1535 Vthis_original_command
= Qnil
;
1537 /* Read next key sequence; i gets its length. */
1538 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1541 /* A filter may have run while we were reading the input. */
1542 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1544 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1545 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1549 /* Now we have read a key sequence of length I,
1550 or else I is 0 and we found end of file. */
1552 if (i
== 0) /* End of file -- happens only in */
1553 return Qnil
; /* a kbd macro, at the end. */
1554 /* -1 means read_key_sequence got a menu that was rejected.
1555 Just loop around and read another command. */
1559 this_command_key_count
= 0;
1560 this_command_key_count_reset
= 0;
1561 this_single_command_key_start
= 0;
1565 last_command_char
= keybuf
[i
- 1];
1567 /* If the previous command tried to force a specific window-start,
1568 forget about that, in case this command moves point far away
1569 from that position. But also throw away beg_unchanged and
1570 end_unchanged information in that case, so that redisplay will
1571 update the whole window properly. */
1572 if (!NILP (XWINDOW (selected_window
)->force_start
))
1575 XWINDOW (selected_window
)->force_start
= Qnil
;
1576 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1577 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1580 cmd
= read_key_sequence_cmd
;
1581 if (!NILP (Vexecuting_kbd_macro
))
1583 if (!NILP (Vquit_flag
))
1585 Vexecuting_kbd_macro
= Qt
;
1586 QUIT
; /* Make some noise. */
1587 /* Will return since macro now empty. */
1591 /* Do redisplay processing after this command except in special
1592 cases identified below. */
1593 prev_buffer
= current_buffer
;
1594 prev_modiff
= MODIFF
;
1595 last_point_position
= PT
;
1596 last_point_position_window
= selected_window
;
1597 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1599 /* By default, we adjust point to a boundary of a region that
1600 has such a property that should be treated intangible
1601 (e.g. composition, display). But, some commands will set
1602 this variable differently. */
1603 Vdisable_point_adjustment
= Qnil
;
1605 /* Process filters and timers may have messed with deactivate-mark.
1606 reset it before we execute the command. */
1607 Vdeactivate_mark
= Qnil
;
1609 /* Remap command through active keymaps */
1610 Vthis_original_command
= cmd
;
1614 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1618 /* Execute the command. */
1620 Vthis_command
= cmd
;
1621 real_this_command
= cmd
;
1622 /* Note that the value cell will never directly contain nil
1623 if the symbol is a local variable. */
1624 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1625 safe_run_hooks (Qpre_command_hook
);
1627 already_adjusted
= 0;
1629 if (NILP (Vthis_command
))
1631 /* nil means key is undefined. */
1632 Lisp_Object keys
= Fvector (i
, keybuf
);
1633 keys
= Fkey_description (keys
, Qnil
);
1635 message_with_string ("%s is undefined", keys
, 0);
1636 current_kboard
->defining_kbd_macro
= Qnil
;
1637 update_mode_lines
= 1;
1638 current_kboard
->Vprefix_arg
= Qnil
;
1642 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1644 /* In case we jump to directly_done. */
1645 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1647 /* Recognize some common commands in common situations and
1648 do them directly. */
1649 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1651 struct Lisp_Char_Table
*dp
1652 = window_display_table (XWINDOW (selected_window
));
1653 lose
= FETCH_CHAR (PT_BYTE
);
1655 if (! NILP (Vpost_command_hook
))
1656 /* Put this before calling adjust_point_for_property
1657 so it will only get called once in any case. */
1659 if (current_buffer
== prev_buffer
1660 && last_point_position
!= PT
1661 && NILP (Vdisable_point_adjustment
)
1662 && NILP (Vglobal_disable_point_adjustment
))
1663 adjust_point_for_property (last_point_position
, 0);
1664 already_adjusted
= 1;
1665 if (PT
== last_point_position
+ 1
1667 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1668 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1669 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1670 && (lose
>= 0x20 && lose
< 0x7f)))
1671 : (lose
>= 0x20 && lose
< 0x7f))
1672 /* To extract the case of continuation on
1673 wide-column characters. */
1674 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1675 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1677 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1679 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1681 && !windows_or_buffers_changed
1682 && EQ (current_buffer
->selective_display
, Qnil
)
1683 && !detect_input_pending ()
1684 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1685 && NILP (Vexecuting_kbd_macro
))
1686 direct_output_forward_char (1);
1689 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1691 struct Lisp_Char_Table
*dp
1692 = window_display_table (XWINDOW (selected_window
));
1694 lose
= FETCH_CHAR (PT_BYTE
);
1695 if (! NILP (Vpost_command_hook
))
1697 if (current_buffer
== prev_buffer
1698 && last_point_position
!= PT
1699 && NILP (Vdisable_point_adjustment
)
1700 && NILP (Vglobal_disable_point_adjustment
))
1701 adjust_point_for_property (last_point_position
, 0);
1702 already_adjusted
= 1;
1703 if (PT
== last_point_position
- 1
1705 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1706 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1707 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1708 && (lose
>= 0x20 && lose
< 0x7f)))
1709 : (lose
>= 0x20 && lose
< 0x7f))
1710 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1712 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1714 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1716 && !windows_or_buffers_changed
1717 && EQ (current_buffer
->selective_display
, Qnil
)
1718 && !detect_input_pending ()
1719 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1720 && NILP (Vexecuting_kbd_macro
))
1721 direct_output_forward_char (-1);
1724 else if (EQ (Vthis_command
, Qself_insert_command
)
1725 /* Try this optimization only on char keystrokes. */
1726 && NATNUMP (last_command_char
)
1727 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1730 = translate_char (Vtranslation_table_for_input
,
1731 XFASTINT (last_command_char
), 0, 0, 0);
1733 if (NILP (Vexecuting_kbd_macro
)
1734 && !EQ (minibuf_window
, selected_window
))
1736 if (!nonundocount
|| nonundocount
>= 20)
1744 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1746 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1748 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1750 || MODIFF
<= SAVE_MODIFF
1751 || windows_or_buffers_changed
1752 || !EQ (current_buffer
->selective_display
, Qnil
)
1753 || detect_input_pending ()
1754 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1755 || !NILP (Vexecuting_kbd_macro
));
1757 value
= internal_self_insert (c
, 0);
1762 if (! NILP (Vpost_command_hook
))
1763 /* Put this before calling adjust_point_for_property
1764 so it will only get called once in any case. */
1767 /* VALUE == 1 when AFTER-CHANGE functions are
1768 installed which is the case most of the time
1769 because FONT-LOCK installs one. */
1770 if (!lose
&& !value
)
1771 direct_output_for_insert (c
);
1776 /* Here for a command that isn't executed directly */
1779 #ifdef HAVE_X_WINDOWS
1780 int scount
= SPECPDL_INDEX ();
1782 if (display_hourglass_p
1783 && NILP (Vexecuting_kbd_macro
))
1785 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1791 if (NILP (current_kboard
->Vprefix_arg
))
1793 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1795 #ifdef HAVE_X_WINDOWS
1796 /* Do not check display_hourglass_p here, because
1797 Fcommand_execute could change it, but we should cancel
1798 hourglass cursor anyway.
1799 But don't cancel the hourglass within a macro
1800 just because a command in the macro finishes. */
1801 if (NILP (Vexecuting_kbd_macro
))
1802 unbind_to (scount
, Qnil
);
1807 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1809 /* Note that the value cell will never directly contain nil
1810 if the symbol is a local variable. */
1811 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1812 safe_run_hooks (Qpost_command_hook
);
1814 /* If displaying a message, resize the echo area window to fit
1815 that message's size exactly. */
1816 if (!NILP (echo_area_buffer
[0]))
1817 resize_echo_area_exactly ();
1819 if (!NILP (Vdeferred_action_list
))
1820 safe_run_hooks (Qdeferred_action_function
);
1822 /* If there is a prefix argument,
1823 1) We don't want Vlast_command to be ``universal-argument''
1824 (that would be dumb), so don't set Vlast_command,
1825 2) we want to leave echoing on so that the prefix will be
1826 echoed as part of this key sequence, so don't call
1828 3) we want to leave this_command_key_count non-zero, so that
1829 read_char will realize that it is re-reading a character, and
1830 not echo it a second time.
1832 If the command didn't actually create a prefix arg,
1833 but is merely a frame event that is transparent to prefix args,
1834 then the above doesn't apply. */
1835 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1837 current_kboard
->Vlast_command
= Vthis_command
;
1838 current_kboard
->Vreal_last_command
= real_this_command
;
1840 this_command_key_count
= 0;
1841 this_command_key_count_reset
= 0;
1842 this_single_command_key_start
= 0;
1845 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1847 /* Setting transient-mark-mode to `only' is a way of
1848 turning it on for just one command. */
1850 if (EQ (Vtransient_mark_mode
, Qidentity
))
1851 Vtransient_mark_mode
= Qnil
;
1852 if (EQ (Vtransient_mark_mode
, Qonly
))
1853 Vtransient_mark_mode
= Qidentity
;
1855 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1857 /* We could also call `deactivate'mark'. */
1858 if (EQ (Vtransient_mark_mode
, Qlambda
))
1859 Vtransient_mark_mode
= Qnil
;
1862 current_buffer
->mark_active
= Qnil
;
1863 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1866 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1867 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1872 if (current_buffer
== prev_buffer
1873 && last_point_position
!= PT
1874 && NILP (Vdisable_point_adjustment
)
1875 && NILP (Vglobal_disable_point_adjustment
)
1876 && !already_adjusted
)
1877 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1879 /* Install chars successfully executed in kbd macro. */
1881 if (!NILP (current_kboard
->defining_kbd_macro
)
1882 && NILP (current_kboard
->Vprefix_arg
))
1883 finalize_kbd_macro_chars ();
1887 any_kboard_state ();
1892 extern Lisp_Object Qcomposition
, Qdisplay
;
1894 /* Adjust point to a boundary of a region that has such a property
1895 that should be treated intangible. For the moment, we check
1896 `composition', `display' and `invisible' properties.
1897 LAST_PT is the last position of point. */
1899 extern Lisp_Object Qafter_string
, Qbefore_string
;
1900 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1903 adjust_point_for_property (last_pt
, modified
)
1908 Lisp_Object val
, overlay
, tmp
;
1909 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1912 /* FIXME: cycling is probably not necessary because these properties
1913 can't be usefully combined anyway. */
1914 while (check_composition
|| check_display
|| check_invisible
)
1916 if (check_composition
1917 && PT
> BEGV
&& PT
< ZV
1918 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1919 && COMPOSITION_VALID_P (beg
, end
, val
)
1920 && beg
< PT
/* && end > PT <- It's always the case. */
1921 && (last_pt
<= beg
|| last_pt
>= end
))
1924 SET_PT (PT
< last_pt
? beg
: end
);
1925 check_display
= check_invisible
= 1;
1927 check_composition
= 0;
1929 && PT
> BEGV
&& PT
< ZV
1930 && !NILP (val
= get_char_property_and_overlay
1931 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1932 && display_prop_intangible_p (val
)
1933 && (!OVERLAYP (overlay
)
1934 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1935 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1936 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1937 && (beg
< PT
/* && end > PT <- It's always the case. */
1938 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1941 SET_PT (PT
< last_pt
1942 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1944 check_composition
= check_invisible
= 1;
1947 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1949 int inv
, ellipsis
= 0;
1952 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1954 && !NILP (val
= get_char_property_and_overlay
1955 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1956 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1958 ellipsis
= ellipsis
|| inv
> 1
1959 || (OVERLAYP (overlay
)
1960 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1961 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1962 tmp
= Fnext_single_char_property_change
1963 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1964 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1967 && !NILP (val
= get_char_property_and_overlay
1968 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1969 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1971 ellipsis
= ellipsis
|| inv
> 1
1972 || (OVERLAYP (overlay
)
1973 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1974 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1975 tmp
= Fprevious_single_char_property_change
1976 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1977 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1980 /* Move away from the inside area. */
1981 if (beg
< PT
&& end
> PT
)
1983 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1984 /* We haven't moved yet (so we don't need to fear
1985 infinite-looping) and we were outside the range
1986 before (so either end of the range still corresponds
1987 to a move in the right direction): pretend we moved
1988 less than we actually did, so that we still have
1989 more freedom below in choosing which end of the range
1991 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1992 /* We either have moved already or the last point
1993 was already in the range: we don't get to choose
1994 which end of the range we have to go to. */
1995 : (PT
< last_pt
? beg
: end
));
1996 check_composition
= check_display
= 1;
1998 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1999 the point to something other than its argument, due to
2000 point-motion hooks, intangibility, etc. */
2001 xassert (PT
== beg
|| PT
== end
);
2004 /* Pretend the area doesn't exist if the buffer is not
2006 if (!modified
&& !ellipsis
&& beg
< end
)
2008 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2009 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2010 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2011 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2012 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2013 /* We've already moved as far as we can. Trying to go
2014 to the other end would mean moving backwards and thus
2015 could lead to an infinite loop. */
2017 else if (val
= get_pos_property (make_number (PT
),
2019 TEXT_PROP_MEANS_INVISIBLE (val
)
2020 && (val
= get_pos_property
2021 (make_number (PT
== beg
? end
: beg
),
2023 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2024 (check_composition
= check_display
= 1,
2025 SET_PT (PT
== beg
? end
: beg
));
2028 check_invisible
= 0;
2032 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2035 safe_run_hooks_1 (hook
)
2038 return call1 (Vrun_hooks
, Vinhibit_quit
);
2041 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2044 safe_run_hooks_error (data
)
2047 Lisp_Object args
[3];
2048 args
[0] = build_string ("Error in %s: %s");
2049 args
[1] = Vinhibit_quit
;
2052 return Fset (Vinhibit_quit
, Qnil
);
2055 /* If we get an error while running the hook, cause the hook variable
2056 to be nil. Also inhibit quits, so that C-g won't cause the hook
2057 to mysteriously evaporate. */
2060 safe_run_hooks (hook
)
2063 int count
= SPECPDL_INDEX ();
2064 specbind (Qinhibit_quit
, hook
);
2066 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2068 unbind_to (count
, Qnil
);
2072 /* Number of seconds between polling for input. This is a Lisp
2073 variable that can be bound. */
2075 EMACS_INT polling_period
;
2077 /* Nonzero means polling for input is temporarily suppressed. */
2079 int poll_suppress_count
;
2081 /* Asynchronous timer for polling. */
2083 struct atimer
*poll_timer
;
2086 #ifdef POLL_FOR_INPUT
2088 /* Poll for input, so what we catch a C-g if it comes in. This
2089 function is called from x_make_frame_visible, see comment
2095 if (interrupt_input_blocked
== 0
2096 && !waiting_for_input
)
2097 read_avail_input (0);
2100 /* Timer callback function for poll_timer. TIMER is equal to
2104 poll_for_input (timer
)
2105 struct atimer
*timer
;
2107 if (poll_suppress_count
== 0)
2109 interrupt_input_pending
= 1;
2111 poll_for_input_1 ();
2115 #endif /* POLL_FOR_INPUT */
2117 /* Begin signals to poll for input, if they are appropriate.
2118 This function is called unconditionally from various places. */
2123 #ifdef POLL_FOR_INPUT
2124 if (read_socket_hook
&& !interrupt_input
)
2126 /* Turn alarm handling on unconditionally. It might have
2127 been turned off in process.c. */
2128 turn_on_atimers (1);
2130 /* If poll timer doesn't exist, are we need one with
2131 a different interval, start a new one. */
2132 if (poll_timer
== NULL
2133 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2135 EMACS_TIME interval
;
2138 cancel_atimer (poll_timer
);
2140 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2141 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2142 poll_for_input
, NULL
);
2145 /* Let the timer's callback function poll for input
2146 if this becomes zero. */
2147 --poll_suppress_count
;
2152 /* Nonzero if we are using polling to handle input asynchronously. */
2155 input_polling_used ()
2157 #ifdef POLL_FOR_INPUT
2158 return read_socket_hook
&& !interrupt_input
;
2164 /* Turn off polling. */
2169 #ifdef POLL_FOR_INPUT
2170 if (read_socket_hook
&& !interrupt_input
)
2171 ++poll_suppress_count
;
2175 /* Set the value of poll_suppress_count to COUNT
2176 and start or stop polling accordingly. */
2179 set_poll_suppress_count (count
)
2182 #ifdef POLL_FOR_INPUT
2183 if (count
== 0 && poll_suppress_count
!= 0)
2185 poll_suppress_count
= 1;
2188 else if (count
!= 0 && poll_suppress_count
== 0)
2192 poll_suppress_count
= count
;
2196 /* Bind polling_period to a value at least N.
2197 But don't decrease it. */
2200 bind_polling_period (n
)
2203 #ifdef POLL_FOR_INPUT
2204 int new = polling_period
;
2209 stop_other_atimers (poll_timer
);
2211 specbind (Qpolling_period
, make_number (new));
2212 /* Start a new alarm with the new period. */
2217 /* Apply the control modifier to CHARACTER. */
2223 /* Save the upper bits here. */
2224 int upper
= c
& ~0177;
2228 /* Everything in the columns containing the upper-case letters
2229 denotes a control character. */
2230 if (c
>= 0100 && c
< 0140)
2234 /* Set the shift modifier for a control char
2235 made from a shifted letter. But only for letters! */
2236 if (oc
>= 'A' && oc
<= 'Z')
2237 c
|= shift_modifier
;
2240 /* The lower-case letters denote control characters too. */
2241 else if (c
>= 'a' && c
<= 'z')
2244 /* Include the bits for control and shift
2245 only if the basic ASCII code can't indicate them. */
2249 /* Replace the high bits. */
2250 c
|= (upper
& ~ctrl_modifier
);
2255 /* Display the help-echo property of the character after the mouse pointer.
2256 Either show it in the echo area, or call show-help-function to display
2257 it by other means (maybe in a tooltip).
2259 If HELP is nil, that means clear the previous help echo.
2261 If HELP is a string, display that string. If HELP is a function,
2262 call it with OBJECT and POS as arguments; the function should
2263 return a help string or nil for none. For all other types of HELP,
2264 evaluate it to obtain a string.
2266 WINDOW is the window in which the help was generated, if any.
2267 It is nil if not in a window.
2269 If OBJECT is a buffer, POS is the position in the buffer where the
2270 `help-echo' text property was found.
2272 If OBJECT is an overlay, that overlay has a `help-echo' property,
2273 and POS is the position in the overlay's buffer under the mouse.
2275 If OBJECT is a string (an overlay string or a string displayed with
2276 the `display' property). POS is the position in that string under
2279 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2280 echo overwrites a keystroke echo currently displayed in the echo
2283 Note: this function may only be called with HELP nil or a string
2284 from X code running asynchronously. */
2287 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2288 Lisp_Object help
, window
, object
, pos
;
2289 int ok_to_overwrite_keystroke_echo
;
2291 if (!NILP (help
) && !STRINGP (help
))
2293 if (FUNCTIONP (help
))
2295 Lisp_Object args
[4];
2300 help
= safe_call (4, args
);
2303 help
= safe_eval (help
);
2305 if (!STRINGP (help
))
2310 if (!noninteractive
&& STRINGP (help
))
2311 help
= call1 (Qmouse_fixup_help_message
, help
);
2314 if (STRINGP (help
) || NILP (help
))
2316 if (!NILP (Vshow_help_function
))
2317 call1 (Vshow_help_function
, help
);
2318 else if (/* Don't overwrite minibuffer contents. */
2319 !MINI_WINDOW_P (XWINDOW (selected_window
))
2320 /* Don't overwrite a keystroke echo. */
2321 && (NILP (echo_message_buffer
)
2322 || ok_to_overwrite_keystroke_echo
)
2323 /* Don't overwrite a prompt. */
2324 && !cursor_in_echo_area
)
2328 int count
= SPECPDL_INDEX ();
2330 if (!help_echo_showing_p
)
2331 Vpre_help_message
= current_message ();
2333 specbind (Qmessage_truncate_lines
, Qt
);
2334 message3_nolog (help
, SBYTES (help
),
2335 STRING_MULTIBYTE (help
));
2336 unbind_to (count
, Qnil
);
2338 else if (STRINGP (Vpre_help_message
))
2340 message3_nolog (Vpre_help_message
,
2341 SBYTES (Vpre_help_message
),
2342 STRING_MULTIBYTE (Vpre_help_message
));
2343 Vpre_help_message
= Qnil
;
2349 help_echo_showing_p
= STRINGP (help
);
2355 /* Input of single characters from keyboard */
2357 Lisp_Object
print_help ();
2358 static Lisp_Object
kbd_buffer_get_event ();
2359 static void record_char ();
2362 static jmp_buf wrong_kboard_jmpbuf
;
2365 #define STOP_POLLING \
2366 do { if (! polling_stopped_here) stop_polling (); \
2367 polling_stopped_here = 1; } while (0)
2369 #define RESUME_POLLING \
2370 do { if (polling_stopped_here) start_polling (); \
2371 polling_stopped_here = 0; } while (0)
2373 /* read a character from the keyboard; call the redisplay if needed */
2374 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2375 -1 means do not do redisplay, but do do autosaving.
2378 /* The arguments MAPS and NMAPS are for menu prompting.
2379 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2381 PREV_EVENT is the previous input event, or nil if we are reading
2382 the first event of a key sequence (or not reading a key sequence).
2383 If PREV_EVENT is t, that is a "magic" value that says
2384 not to run input methods, but in other respects to act as if
2385 not reading a key sequence.
2387 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2388 if we used a mouse menu to read the input, or zero otherwise. If
2389 USED_MOUSE_MENU is null, we don't dereference it.
2391 Value is t if we showed a menu and the user rejected it. */
2394 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2398 Lisp_Object prev_event
;
2399 int *used_mouse_menu
;
2401 volatile Lisp_Object c
;
2403 jmp_buf local_getcjmp
;
2405 volatile int key_already_recorded
= 0;
2406 Lisp_Object tem
, save
;
2407 volatile Lisp_Object previous_echo_area_message
;
2408 volatile Lisp_Object also_record
;
2409 volatile int reread
;
2410 struct gcpro gcpro1
, gcpro2
;
2411 int polling_stopped_here
= 0;
2415 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2416 before_command_key_count
= this_command_key_count
;
2417 before_command_echo_length
= echo_length ();
2420 previous_echo_area_message
= Qnil
;
2422 GCPRO2 (c
, previous_echo_area_message
);
2427 if (CONSP (Vunread_post_input_method_events
))
2429 c
= XCAR (Vunread_post_input_method_events
);
2430 Vunread_post_input_method_events
2431 = XCDR (Vunread_post_input_method_events
);
2433 /* Undo what read_char_x_menu_prompt did when it unread
2434 additional keys returned by Fx_popup_menu. */
2436 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2444 if (unread_command_char
!= -1)
2446 XSETINT (c
, unread_command_char
);
2447 unread_command_char
= -1;
2453 if (CONSP (Vunread_command_events
))
2455 c
= XCAR (Vunread_command_events
);
2456 Vunread_command_events
= XCDR (Vunread_command_events
);
2458 /* Undo what read_char_x_menu_prompt did when it unread
2459 additional keys returned by Fx_popup_menu. */
2461 && EQ (XCDR (c
), Qdisabled
)
2462 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2465 /* If the queued event is something that used the mouse,
2466 set used_mouse_menu accordingly. */
2468 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2469 *used_mouse_menu
= 1;
2472 goto reread_for_input_method
;
2475 if (CONSP (Vunread_input_method_events
))
2477 c
= XCAR (Vunread_input_method_events
);
2478 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2480 /* Undo what read_char_x_menu_prompt did when it unread
2481 additional keys returned by Fx_popup_menu. */
2483 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2487 goto reread_for_input_method
;
2490 this_command_key_count_reset
= 0;
2492 if (!NILP (Vexecuting_kbd_macro
))
2494 /* We set this to Qmacro; since that's not a frame, nobody will
2495 try to switch frames on us, and the selected window will
2498 Since this event came from a macro, it would be misleading to
2499 leave internal_last_event_frame set to wherever the last
2500 real event came from. Normally, a switch-frame event selects
2501 internal_last_event_frame after each command is read, but
2502 events read from a macro should never cause a new frame to be
2504 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2506 /* Exit the macro if we are at the end.
2507 Also, some things replace the macro with t
2508 to force an early exit. */
2509 if (EQ (Vexecuting_kbd_macro
, Qt
)
2510 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2516 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2517 if (STRINGP (Vexecuting_kbd_macro
)
2518 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2519 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2521 executing_kbd_macro_index
++;
2526 if (!NILP (unread_switch_frame
))
2528 c
= unread_switch_frame
;
2529 unread_switch_frame
= Qnil
;
2531 /* This event should make it into this_command_keys, and get echoed
2532 again, so we do not set `reread'. */
2536 /* if redisplay was requested */
2537 if (commandflag
>= 0)
2539 /* If there is pending input, process any events which are not
2540 user-visible, such as X selection_request events. */
2542 || detect_input_pending_run_timers (0))
2543 swallow_events (0); /* may clear input_pending */
2545 /* Redisplay if no pending input. */
2546 while (!input_pending
)
2548 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2549 redisplay_preserve_echo_area (5);
2554 /* Normal case: no input arrived during redisplay. */
2557 /* Input arrived and pre-empted redisplay.
2558 Process any events which are not user-visible. */
2560 /* If that cleared input_pending, try again to redisplay. */
2564 /* Message turns off echoing unless more keystrokes turn it on again.
2566 The code in 20.x for the condition was
2568 1. echo_area_glyphs && *echo_area_glyphs
2569 2. && echo_area_glyphs != current_kboard->echobuf
2570 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2572 (1) means there's a current message displayed
2574 (2) means it's not the message from echoing from the current
2577 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2578 is set to a non-null value. This is done in read_char and it is
2579 set to echo_area_glyphs after a call to echo_char. That means
2580 ok_to_echo_at_next_pause is either null or
2581 current_kboard->echobuf with the appropriate current_kboard at
2584 So, condition (3) means in clear text ok_to_echo_at_next_pause
2585 must be either null, or the current message isn't from echoing at
2586 all, or it's from echoing from a different kboard than the
2589 if (/* There currently is something in the echo area. */
2590 !NILP (echo_area_buffer
[0])
2591 && (/* And it's either not from echoing. */
2592 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2593 /* Or it's an echo from a different kboard. */
2594 || echo_kboard
!= current_kboard
2595 /* Or we explicitly allow overwriting whatever there is. */
2596 || ok_to_echo_at_next_pause
== NULL
))
2601 /* Try reading a character via menu prompting in the minibuf.
2602 Try this before the sit-for, because the sit-for
2603 would do the wrong thing if we are supposed to do
2604 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2605 after a mouse event so don't try a minibuf menu. */
2607 if (nmaps
> 0 && INTERACTIVE
2608 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2609 /* Don't bring up a menu if we already have another event. */
2610 && NILP (Vunread_command_events
)
2611 && unread_command_char
< 0
2612 && !detect_input_pending_run_timers (0))
2614 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2617 key_already_recorded
= 1;
2622 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2623 We will do that below, temporarily for short sections of code,
2624 when appropriate. local_getcjmp must be in effect
2625 around any call to sit_for or kbd_buffer_get_event;
2626 it *must not* be in effect when we call redisplay. */
2628 if (_setjmp (local_getcjmp
))
2630 /* We must have saved the outer value of getcjmp here,
2631 so restore it now. */
2632 restore_getcjmp (save_jump
);
2633 XSETINT (c
, quit_char
);
2634 internal_last_event_frame
= selected_frame
;
2635 Vlast_event_frame
= internal_last_event_frame
;
2636 /* If we report the quit char as an event,
2637 don't do so more than once. */
2638 if (!NILP (Vinhibit_quit
))
2643 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2644 if (kb
!= current_kboard
)
2646 Lisp_Object link
= kb
->kbd_queue
;
2647 /* We shouldn't get here if we were in single-kboard mode! */
2652 while (CONSP (XCDR (link
)))
2654 if (!NILP (XCDR (link
)))
2658 kb
->kbd_queue
= Fcons (c
, Qnil
);
2660 XSETCDR (link
, Fcons (c
, Qnil
));
2661 kb
->kbd_queue_has_data
= 1;
2662 current_kboard
= kb
;
2663 /* This is going to exit from read_char
2664 so we had better get rid of this frame's stuff. */
2666 longjmp (wrong_kboard_jmpbuf
, 1);
2673 timer_start_idle ();
2675 /* If in middle of key sequence and minibuffer not active,
2676 start echoing if enough time elapses. */
2678 if (minibuf_level
== 0
2679 && !current_kboard
->immediate_echo
2680 && this_command_key_count
> 0
2682 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2683 && NILP (Fzerop (Vecho_keystrokes
))
2684 && (/* No message. */
2685 NILP (echo_area_buffer
[0])
2686 /* Or empty message. */
2687 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2688 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2689 /* Or already echoing from same kboard. */
2690 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2691 /* Or not echoing before and echoing allowed. */
2692 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2696 /* After a mouse event, start echoing right away.
2697 This is because we are probably about to display a menu,
2698 and we don't want to delay before doing so. */
2699 if (EVENT_HAS_PARAMETERS (prev_event
))
2704 double duration
= extract_float (Vecho_keystrokes
);
2705 sec
= (int) duration
;
2706 usec
= (duration
- sec
) * 1000000;
2707 save_getcjmp (save_jump
);
2708 restore_getcjmp (local_getcjmp
);
2709 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2710 restore_getcjmp (save_jump
);
2712 && ! CONSP (Vunread_command_events
))
2717 /* Maybe auto save due to number of keystrokes. */
2719 if (commandflag
!= 0
2720 && auto_save_interval
> 0
2721 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2722 && !detect_input_pending_run_timers (0))
2724 Fdo_auto_save (Qnil
, Qnil
);
2725 /* Hooks can actually change some buffers in auto save. */
2729 /* Try reading using an X menu.
2730 This is never confused with reading using the minibuf
2731 because the recursive call of read_char in read_char_minibuf_menu_prompt
2732 does not pass on any keymaps. */
2734 if (nmaps
> 0 && INTERACTIVE
2735 && !NILP (prev_event
)
2736 && EVENT_HAS_PARAMETERS (prev_event
)
2737 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2738 && !EQ (XCAR (prev_event
), Qtool_bar
)
2739 /* Don't bring up a menu if we already have another event. */
2740 && NILP (Vunread_command_events
)
2741 && unread_command_char
< 0)
2743 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2745 /* Now that we have read an event, Emacs is not idle. */
2751 /* Maybe autosave and/or garbage collect due to idleness. */
2753 if (INTERACTIVE
&& NILP (c
))
2755 int delay_level
, buffer_size
;
2757 /* Slow down auto saves logarithmically in size of current buffer,
2758 and garbage collect while we're at it. */
2759 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2760 last_non_minibuf_size
= Z
- BEG
;
2761 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2763 while (buffer_size
> 64)
2764 delay_level
++, buffer_size
-= buffer_size
>> 2;
2765 if (delay_level
< 4) delay_level
= 4;
2766 /* delay_level is 4 for files under around 50k, 7 at 100k,
2767 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2769 /* Auto save if enough time goes by without input. */
2770 if (commandflag
!= 0
2771 && num_nonmacro_input_events
> last_auto_save
2772 && INTEGERP (Vauto_save_timeout
)
2773 && XINT (Vauto_save_timeout
) > 0)
2777 save_getcjmp (save_jump
);
2778 restore_getcjmp (local_getcjmp
);
2779 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2781 restore_getcjmp (save_jump
);
2784 && ! CONSP (Vunread_command_events
))
2786 Fdo_auto_save (Qnil
, Qnil
);
2788 /* If we have auto-saved and there is still no input
2789 available, garbage collect if there has been enough
2790 consing going on to make it worthwhile. */
2791 if (!detect_input_pending_run_timers (0)
2792 && consing_since_gc
> gc_cons_threshold
/ 2)
2793 Fgarbage_collect ();
2800 /* If this has become non-nil here, it has been set by a timer
2801 or sentinel or filter. */
2802 if (CONSP (Vunread_command_events
))
2804 c
= XCAR (Vunread_command_events
);
2805 Vunread_command_events
= XCDR (Vunread_command_events
);
2808 /* Read something from current KBOARD's side queue, if possible. */
2812 if (current_kboard
->kbd_queue_has_data
)
2814 if (!CONSP (current_kboard
->kbd_queue
))
2816 c
= XCAR (current_kboard
->kbd_queue
);
2817 current_kboard
->kbd_queue
2818 = XCDR (current_kboard
->kbd_queue
);
2819 if (NILP (current_kboard
->kbd_queue
))
2820 current_kboard
->kbd_queue_has_data
= 0;
2821 input_pending
= readable_events (0);
2822 if (EVENT_HAS_PARAMETERS (c
)
2823 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2824 internal_last_event_frame
= XCAR (XCDR (c
));
2825 Vlast_event_frame
= internal_last_event_frame
;
2830 /* If current_kboard's side queue is empty check the other kboards.
2831 If one of them has data that we have not yet seen here,
2832 switch to it and process the data waiting for it.
2834 Note: if the events queued up for another kboard
2835 have already been seen here, and therefore are not a complete command,
2836 the kbd_queue_has_data field is 0, so we skip that kboard here.
2837 That's to avoid an infinite loop switching between kboards here. */
2838 if (NILP (c
) && !single_kboard
)
2841 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2842 if (kb
->kbd_queue_has_data
)
2844 current_kboard
= kb
;
2845 /* This is going to exit from read_char
2846 so we had better get rid of this frame's stuff. */
2848 longjmp (wrong_kboard_jmpbuf
, 1);
2857 /* Finally, we read from the main queue,
2858 and if that gives us something we can't use yet, we put it on the
2859 appropriate side queue and try again. */
2865 /* Actually read a character, waiting if necessary. */
2866 save_getcjmp (save_jump
);
2867 restore_getcjmp (local_getcjmp
);
2868 timer_start_idle ();
2869 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2870 restore_getcjmp (save_jump
);
2873 if (! NILP (c
) && (kb
!= current_kboard
))
2875 Lisp_Object link
= kb
->kbd_queue
;
2878 while (CONSP (XCDR (link
)))
2880 if (!NILP (XCDR (link
)))
2884 kb
->kbd_queue
= Fcons (c
, Qnil
);
2886 XSETCDR (link
, Fcons (c
, Qnil
));
2887 kb
->kbd_queue_has_data
= 1;
2891 current_kboard
= kb
;
2892 /* This is going to exit from read_char
2893 so we had better get rid of this frame's stuff. */
2895 longjmp (wrong_kboard_jmpbuf
, 1);
2900 /* Terminate Emacs in batch mode if at eof. */
2901 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2902 Fkill_emacs (make_number (1));
2906 /* Add in any extra modifiers, where appropriate. */
2907 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2908 || ((extra_keyboard_modifiers
& 0177) < ' '
2909 && (extra_keyboard_modifiers
& 0177) != 0))
2910 XSETINT (c
, make_ctrl_char (XINT (c
)));
2912 /* Transfer any other modifier bits directly from
2913 extra_keyboard_modifiers to c. Ignore the actual character code
2914 in the low 16 bits of extra_keyboard_modifiers. */
2915 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2925 if (commandflag
>= 0
2926 && !input_pending
&& !detect_input_pending_run_timers (0))
2934 /* Buffer switch events are only for internal wakeups
2935 so don't show them to the user.
2936 Also, don't record a key if we already did. */
2937 if (BUFFERP (c
) || key_already_recorded
)
2940 /* Process special events within read_char
2941 and loop around to read another event. */
2944 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2949 int was_locked
= single_kboard
;
2951 last_input_char
= c
;
2952 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2954 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2955 /* We stopped being idle for this event; undo that. This
2956 prevents automatic window selection (under
2957 mouse_autoselect_window from acting as a real input event, for
2958 example banishing the mouse under mouse-avoidance-mode. */
2959 timer_resume_idle ();
2961 /* Resume allowing input from any kboard, if that was true before. */
2963 any_kboard_state ();
2968 /* Handle things that only apply to characters. */
2971 /* If kbd_buffer_get_event gave us an EOF, return that. */
2975 if ((STRINGP (Vkeyboard_translate_table
)
2976 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2977 || (VECTORP (Vkeyboard_translate_table
)
2978 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2979 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2980 && CHAR_VALID_P (XINT (c
), 0)))
2983 d
= Faref (Vkeyboard_translate_table
, c
);
2984 /* nil in keyboard-translate-table means no translation. */
2990 /* If this event is a mouse click in the menu bar,
2991 return just menu-bar for now. Modify the mouse click event
2992 so we won't do this twice, then queue it up. */
2993 if (EVENT_HAS_PARAMETERS (c
)
2995 && CONSP (EVENT_START (c
))
2996 && CONSP (XCDR (EVENT_START (c
))))
3000 posn
= POSN_POSN (EVENT_START (c
));
3001 /* Handle menu-bar events:
3002 insert the dummy prefix event `menu-bar'. */
3003 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3005 /* Change menu-bar to (menu-bar) as the event "position". */
3006 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3009 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3014 /* Store these characters into recent_keys, the dribble file if any,
3015 and the keyboard macro being defined, if any. */
3017 if (! NILP (also_record
))
3018 record_char (also_record
);
3020 /* Wipe the echo area.
3021 But first, if we are about to use an input method,
3022 save the echo area contents for it to refer to. */
3024 && ! NILP (Vinput_method_function
)
3025 && (unsigned) XINT (c
) >= ' '
3026 && (unsigned) XINT (c
) != 127
3027 && (unsigned) XINT (c
) < 256)
3029 previous_echo_area_message
= Fcurrent_message ();
3030 Vinput_method_previous_message
= previous_echo_area_message
;
3033 /* Now wipe the echo area, except for help events which do their
3034 own stuff with the echo area. */
3036 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3037 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3039 if (!NILP (echo_area_buffer
[0]))
3040 safe_run_hooks (Qecho_area_clear_hook
);
3041 clear_message (1, 0);
3044 reread_for_input_method
:
3046 /* Pass this to the input method, if appropriate. */
3048 && ! NILP (Vinput_method_function
)
3049 /* Don't run the input method within a key sequence,
3050 after the first event of the key sequence. */
3051 && NILP (prev_event
)
3052 && (unsigned) XINT (c
) >= ' '
3053 && (unsigned) XINT (c
) != 127
3054 && (unsigned) XINT (c
) < 256)
3057 int key_count
, key_count_reset
;
3058 struct gcpro gcpro1
;
3059 int count
= SPECPDL_INDEX ();
3061 /* Save the echo status. */
3062 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3063 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3064 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3065 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3068 if (before_command_restore_flag
)
3070 this_command_key_count
= before_command_key_count_1
;
3071 if (this_command_key_count
< this_single_command_key_start
)
3072 this_single_command_key_start
= this_command_key_count
;
3073 echo_truncate (before_command_echo_length_1
);
3074 before_command_restore_flag
= 0;
3078 /* Save the this_command_keys status. */
3079 key_count
= this_command_key_count
;
3080 key_count_reset
= this_command_key_count_reset
;
3083 keys
= Fcopy_sequence (this_command_keys
);
3088 /* Clear out this_command_keys. */
3089 this_command_key_count
= 0;
3090 this_command_key_count_reset
= 0;
3092 /* Now wipe the echo area. */
3093 if (!NILP (echo_area_buffer
[0]))
3094 safe_run_hooks (Qecho_area_clear_hook
);
3095 clear_message (1, 0);
3098 /* If we are not reading a key sequence,
3099 never use the echo area. */
3102 specbind (Qinput_method_use_echo_area
, Qt
);
3105 /* Call the input method. */
3106 tem
= call1 (Vinput_method_function
, c
);
3108 tem
= unbind_to (count
, tem
);
3110 /* Restore the saved echoing state
3111 and this_command_keys state. */
3112 this_command_key_count
= key_count
;
3113 this_command_key_count_reset
= key_count_reset
;
3115 this_command_keys
= keys
;
3118 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3119 current_kboard
->echo_string
= saved_echo_string
;
3120 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3121 if (saved_immediate_echo
)
3126 /* The input method can return no events. */
3129 /* Bring back the previous message, if any. */
3130 if (! NILP (previous_echo_area_message
))
3131 message_with_string ("%s", previous_echo_area_message
, 0);
3134 /* It returned one event or more. */
3136 Vunread_post_input_method_events
3137 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3142 /* Display help if not echoing. */
3143 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3145 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3146 Lisp_Object help
, object
, position
, window
, tem
;
3148 tem
= Fcdr (XCDR (c
));
3151 window
= Fcar (tem
);
3153 object
= Fcar (tem
);
3155 position
= Fcar (tem
);
3157 show_help_echo (help
, window
, object
, position
, 0);
3159 /* We stopped being idle for this event; undo that. */
3160 timer_resume_idle ();
3164 if (! reread
|| this_command_key_count
== 0
3165 || this_command_key_count_reset
)
3168 /* Don't echo mouse motion events. */
3169 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3170 && NILP (Fzerop (Vecho_keystrokes
))
3171 && ! (EVENT_HAS_PARAMETERS (c
)
3172 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3175 if (! NILP (also_record
))
3176 echo_char (also_record
);
3177 /* Once we reread a character, echoing can happen
3178 the next time we pause to read a new one. */
3179 ok_to_echo_at_next_pause
= current_kboard
;
3182 /* Record this character as part of the current key. */
3183 add_command_key (c
);
3184 if (! NILP (also_record
))
3185 add_command_key (also_record
);
3188 last_input_char
= c
;
3191 /* Process the help character specially if enabled */
3192 if (!NILP (Vhelp_form
) && help_char_p (c
))
3195 count
= SPECPDL_INDEX ();
3197 record_unwind_protect (Fset_window_configuration
,
3198 Fcurrent_window_configuration (Qnil
));
3200 tem0
= Feval (Vhelp_form
);
3202 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3206 c
= read_char (0, 0, 0, Qnil
, 0);
3207 while (BUFFERP (c
));
3208 /* Remove the help from the frame */
3209 unbind_to (count
, Qnil
);
3212 if (EQ (c
, make_number (040)))
3216 c
= read_char (0, 0, 0, Qnil
, 0);
3217 while (BUFFERP (c
));
3226 /* Record a key that came from a mouse menu.
3227 Record it for echoing, for this-command-keys, and so on. */
3233 /* Wipe the echo area. */
3234 clear_message (1, 0);
3239 before_command_key_count
= this_command_key_count
;
3240 before_command_echo_length
= echo_length ();
3243 /* Don't echo mouse motion events. */
3244 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3245 && NILP (Fzerop (Vecho_keystrokes
)))
3249 /* Once we reread a character, echoing can happen
3250 the next time we pause to read a new one. */
3251 ok_to_echo_at_next_pause
= 0;
3254 /* Record this character as part of the current key. */
3255 add_command_key (c
);
3257 /* Re-reading in the middle of a command */
3258 last_input_char
= c
;
3262 /* Return 1 if should recognize C as "the help character". */
3270 if (EQ (c
, Vhelp_char
))
3272 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3273 if (EQ (c
, XCAR (tail
)))
3278 /* Record the input event C in various ways. */
3286 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3288 /* To avoid filling recent_keys with help-echo and mouse-movement
3289 events, we filter out repeated help-echo events, only store the
3290 first and last in a series of mouse-movement events, and don't
3291 store repeated help-echo events which are only separated by
3292 mouse-movement events. */
3294 Lisp_Object ev1
, ev2
, ev3
;
3297 if ((ix1
= recent_keys_index
- 1) < 0)
3298 ix1
= NUM_RECENT_KEYS
- 1;
3299 ev1
= AREF (recent_keys
, ix1
);
3301 if ((ix2
= ix1
- 1) < 0)
3302 ix2
= NUM_RECENT_KEYS
- 1;
3303 ev2
= AREF (recent_keys
, ix2
);
3305 if ((ix3
= ix2
- 1) < 0)
3306 ix3
= NUM_RECENT_KEYS
- 1;
3307 ev3
= AREF (recent_keys
, ix3
);
3309 if (EQ (XCAR (c
), Qhelp_echo
))
3311 /* Don't record `help-echo' in recent_keys unless it shows some help
3312 message, and a different help than the previously recorded
3314 Lisp_Object help
, last_help
;
3316 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3317 if (!STRINGP (help
))
3319 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3320 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3322 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3323 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3324 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3326 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3327 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3328 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3329 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3332 else if (EQ (XCAR (c
), Qmouse_movement
))
3334 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3335 So additional mouse movement events replace the last element. */
3336 Lisp_Object last_window
, window
;
3338 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3339 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3340 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3341 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3342 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3344 ASET (recent_keys
, ix1
, c
);
3350 store_kbd_macro_char (c
);
3355 ASET (recent_keys
, recent_keys_index
, c
);
3356 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3357 recent_keys_index
= 0;
3359 else if (recorded
< 0)
3361 /* We need to remove one or two events from recent_keys.
3362 To do this, we simply put nil at those events and move the
3363 recent_keys_index backwards over those events. Usually,
3364 users will never see those nil events, as they will be
3365 overwritten by the command keys entered to see recent_keys
3368 while (recorded
++ < 0 && total_keys
> 0)
3370 if (total_keys
< NUM_RECENT_KEYS
)
3372 if (--recent_keys_index
< 0)
3373 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3374 ASET (recent_keys
, recent_keys_index
, Qnil
);
3378 num_nonmacro_input_events
++;
3380 /* Write c to the dribble file. If c is a lispy event, write
3381 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3382 If you, dear reader, have a better idea, you've got the source. :-) */
3387 if (XUINT (c
) < 0x100)
3388 putc (XINT (c
), dribble
);
3390 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3394 Lisp_Object dribblee
;
3396 /* If it's a structured event, take the event header. */
3397 dribblee
= EVENT_HEAD (c
);
3399 if (SYMBOLP (dribblee
))
3401 putc ('<', dribble
);
3402 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3403 SBYTES (SYMBOL_NAME (dribblee
)),
3405 putc ('>', dribble
);
3417 struct buffer
*old
= current_buffer
;
3418 Fprinc (object
, Qnil
);
3419 set_buffer_internal (XBUFFER (Vstandard_output
));
3420 call0 (intern ("help-mode"));
3421 set_buffer_internal (old
);
3425 /* Copy out or in the info on where C-g should throw to.
3426 This is used when running Lisp code from within get_char,
3427 in case get_char is called recursively.
3428 See read_process_output. */
3434 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3438 restore_getcjmp (temp
)
3441 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3446 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3447 of this function. */
3450 tracking_off (old_value
)
3451 Lisp_Object old_value
;
3453 do_mouse_tracking
= old_value
;
3454 if (NILP (old_value
))
3456 /* Redisplay may have been preempted because there was input
3457 available, and it assumes it will be called again after the
3458 input has been processed. If the only input available was
3459 the sort that we have just disabled, then we need to call
3461 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
3463 redisplay_preserve_echo_area (6);
3464 get_input_pending (&input_pending
,
3465 READABLE_EVENTS_DO_TIMERS_NOW
);
3471 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3472 doc
: /* Evaluate BODY with mouse movement events enabled.
3473 Within a `track-mouse' form, mouse motion generates input events that
3474 you can read with `read-event'.
3475 Normally, mouse motion is ignored.
3476 usage: (track-mouse BODY ...) */)
3480 int count
= SPECPDL_INDEX ();
3483 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3485 do_mouse_tracking
= Qt
;
3487 val
= Fprogn (args
);
3488 return unbind_to (count
, val
);
3491 /* If mouse has moved on some frame, return one of those frames.
3492 Return 0 otherwise. */
3497 Lisp_Object tail
, frame
;
3499 FOR_EACH_FRAME (tail
, frame
)
3501 if (XFRAME (frame
)->mouse_moved
)
3502 return XFRAME (frame
);
3508 #endif /* HAVE_MOUSE */
3510 /* Low level keyboard/mouse input.
3511 kbd_buffer_store_event places events in kbd_buffer, and
3512 kbd_buffer_get_event retrieves them. */
3514 /* Return true iff there are any events in the queue that read-char
3515 would return. If this returns false, a read-char would block. */
3517 readable_events (flags
)
3520 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3523 /* If the buffer contains only FOCUS_IN_EVENT events, and
3524 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3525 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3527 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3528 #ifdef USE_TOOLKIT_SCROLL_BARS
3529 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3533 struct input_event
*event
;
3535 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3542 #ifdef USE_TOOLKIT_SCROLL_BARS
3543 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3545 event
->kind
== FOCUS_IN_EVENT
)
3546 #ifdef USE_TOOLKIT_SCROLL_BARS
3547 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3548 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3549 && event
->part
== scroll_bar_handle
3550 && event
->modifiers
== 0)
3555 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3558 while (event
!= kbd_store_ptr
);
3565 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3566 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3571 if (current_kboard
->kbd_queue_has_data
)
3577 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3578 if (kb
->kbd_queue_has_data
)
3584 /* Set this for debugging, to have a way to get out */
3589 event_to_kboard (event
)
3590 struct input_event
*event
;
3593 frame
= event
->frame_or_window
;
3595 frame
= XCAR (frame
);
3596 else if (WINDOWP (frame
))
3597 frame
= WINDOW_FRAME (XWINDOW (frame
));
3599 /* There are still some events that don't set this field.
3600 For now, just ignore the problem.
3601 Also ignore dead frames here. */
3602 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3605 return FRAME_KBOARD (XFRAME (frame
));
3610 Lisp_Object Vthrow_on_input
;
3612 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3615 kbd_buffer_store_event (event
)
3616 register struct input_event
*event
;
3618 kbd_buffer_store_event_hold (event
, 0);
3621 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3623 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3624 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3625 Else, if EVENT is a quit event, store the quit event
3626 in HOLD_QUIT, and return (thus ignoring further events).
3628 This is used in read_avail_input to postpone the processing
3629 of the quit event until all subsequent input events have been
3630 parsed (and discarded).
3634 kbd_buffer_store_event_hold (event
, hold_quit
)
3635 register struct input_event
*event
;
3636 struct input_event
*hold_quit
;
3638 if (event
->kind
== NO_EVENT
)
3641 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3644 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3646 register int c
= event
->code
& 0377;
3648 if (event
->modifiers
& ctrl_modifier
)
3649 c
= make_ctrl_char (c
);
3651 c
|= (event
->modifiers
3652 & (meta_modifier
| alt_modifier
3653 | hyper_modifier
| super_modifier
));
3659 struct input_event
*sp
;
3662 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3663 kb
!= current_kboard
))
3666 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3667 Fcons (make_number (c
), Qnil
));
3668 kb
->kbd_queue_has_data
= 1;
3669 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3671 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3674 if (event_to_kboard (sp
) == kb
)
3676 sp
->kind
= NO_EVENT
;
3677 sp
->frame_or_window
= Qnil
;
3687 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3691 /* If this results in a quit_char being returned to Emacs as
3692 input, set Vlast_event_frame properly. If this doesn't
3693 get returned to Emacs as an event, the next event read
3694 will set Vlast_event_frame again, so this is safe to do. */
3698 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3700 focus
= event
->frame_or_window
;
3701 internal_last_event_frame
= focus
;
3702 Vlast_event_frame
= focus
;
3705 last_event_timestamp
= event
->timestamp
;
3706 interrupt_signal (0 /* dummy */);
3710 if (c
&& c
== stop_character
)
3716 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3717 Just ignore the second one. */
3718 else if (event
->kind
== BUFFER_SWITCH_EVENT
3719 && kbd_fetch_ptr
!= kbd_store_ptr
3720 && ((kbd_store_ptr
== kbd_buffer
3721 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3722 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3725 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3726 kbd_store_ptr
= kbd_buffer
;
3728 /* Don't let the very last slot in the buffer become full,
3729 since that would make the two pointers equal,
3730 and that is indistinguishable from an empty buffer.
3731 Discard the event if it would fill the last slot. */
3732 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3734 *kbd_store_ptr
= *event
;
3738 /* If we're inside while-no-input, and this event qualifies
3739 as input, set quit-flag to cause an interrupt. */
3740 if (!NILP (Vthrow_on_input
)
3741 && event
->kind
!= FOCUS_IN_EVENT
3742 && event
->kind
!= HELP_EVENT
3743 && event
->kind
!= DEICONIFY_EVENT
)
3745 Vquit_flag
= Vthrow_on_input
;
3746 /* If we're inside a function that wants immediate quits,
3748 if (immediate_quit
&& NILP (Vinhibit_quit
))
3758 /* Put an input event back in the head of the event queue. */
3761 kbd_buffer_unget_event (event
)
3762 register struct input_event
*event
;
3764 if (kbd_fetch_ptr
== kbd_buffer
)
3765 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3767 /* Don't let the very last slot in the buffer become full, */
3768 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3771 *kbd_fetch_ptr
= *event
;
3776 /* Generate HELP_EVENT input_events in BUFP which has room for
3777 SIZE events. If there's not enough room in BUFP, ignore this
3780 HELP is the help form.
3782 FRAME is the frame on which the help is generated. OBJECT is the
3783 Lisp object where the help was found (a buffer, a string, an
3784 overlay, or nil if neither from a string nor from a buffer. POS is
3785 the position within OBJECT where the help was found.
3787 Value is the number of input_events generated. */
3790 gen_help_event (help
, frame
, window
, object
, pos
)
3791 Lisp_Object help
, frame
, object
, window
;
3794 struct input_event event
;
3798 event
.kind
= HELP_EVENT
;
3799 event
.frame_or_window
= frame
;
3801 event
.x
= WINDOWP (window
) ? window
: frame
;
3804 kbd_buffer_store_event (&event
);
3808 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3811 kbd_buffer_store_help_event (frame
, help
)
3812 Lisp_Object frame
, help
;
3814 struct input_event event
;
3816 event
.kind
= HELP_EVENT
;
3817 event
.frame_or_window
= frame
;
3822 kbd_buffer_store_event (&event
);
3826 /* Discard any mouse events in the event buffer by setting them to
3829 discard_mouse_events ()
3831 struct input_event
*sp
;
3832 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3834 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3837 if (sp
->kind
== MOUSE_CLICK_EVENT
3838 || sp
->kind
== WHEEL_EVENT
3840 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3842 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3844 sp
->kind
= NO_EVENT
;
3850 /* Return non-zero if there are any real events waiting in the event
3851 buffer, not counting `NO_EVENT's.
3853 If DISCARD is non-zero, discard NO_EVENT events at the front of
3854 the input queue, possibly leaving the input queue empty if there
3855 are no real input events. */
3858 kbd_buffer_events_waiting (discard
)
3861 struct input_event
*sp
;
3863 for (sp
= kbd_fetch_ptr
;
3864 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3867 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3874 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3878 /* Clear input event EVENT. */
3882 struct input_event
*event
;
3884 event
->kind
= NO_EVENT
;
3888 /* Read one event from the event buffer, waiting if necessary.
3889 The value is a Lisp object representing the event.
3890 The value is nil for an event that should be ignored,
3891 or that was handled here.
3892 We always read and discard one event. */
3895 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3897 int *used_mouse_menu
;
3906 *kbp
= current_kboard
;
3910 /* Wait until there is input available. */
3913 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3916 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3920 /* If the quit flag is set, then read_char will return
3921 quit_char, so that counts as "available input." */
3922 if (!NILP (Vquit_flag
))
3923 quit_throw_to_read_char ();
3925 /* One way or another, wait until input is available; then, if
3926 interrupt handlers have not read it, read it now. */
3929 wait_for_kbd_input ();
3931 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3935 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3938 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3942 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3944 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3945 /* Pass 1 for EXPECT since we just waited to have input. */
3946 read_avail_input (1);
3948 #endif /* not VMS */
3951 if (CONSP (Vunread_command_events
))
3954 first
= XCAR (Vunread_command_events
);
3955 Vunread_command_events
= XCDR (Vunread_command_events
);
3956 *kbp
= current_kboard
;
3960 /* At this point, we know that there is a readable event available
3961 somewhere. If the event queue is empty, then there must be a
3962 mouse movement enabled and available. */
3963 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3965 struct input_event
*event
;
3967 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3971 last_event_timestamp
= event
->timestamp
;
3974 *kbp
= event_to_kboard (event
);
3976 *kbp
= current_kboard
; /* Better than returning null ptr? */
3978 *kbp
= &the_only_kboard
;
3983 /* These two kinds of events get special handling
3984 and don't actually appear to the command loop.
3985 We return nil for them. */
3986 if (event
->kind
== SELECTION_REQUEST_EVENT
3987 || event
->kind
== SELECTION_CLEAR_EVENT
)
3990 struct input_event copy
;
3992 /* Remove it from the buffer before processing it,
3993 since otherwise swallow_events will see it
3994 and process it again. */
3996 kbd_fetch_ptr
= event
+ 1;
3997 input_pending
= readable_events (0);
3998 x_handle_selection_event (©
);
4000 /* We're getting selection request events, but we don't have
4006 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4007 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4009 /* Make an event (delete-frame (FRAME)). */
4010 obj
= Fcons (event
->frame_or_window
, Qnil
);
4011 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4012 kbd_fetch_ptr
= event
+ 1;
4015 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4016 else if (event
->kind
== ICONIFY_EVENT
)
4018 /* Make an event (iconify-frame (FRAME)). */
4019 obj
= Fcons (event
->frame_or_window
, Qnil
);
4020 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4021 kbd_fetch_ptr
= event
+ 1;
4023 else if (event
->kind
== DEICONIFY_EVENT
)
4025 /* Make an event (make-frame-visible (FRAME)). */
4026 obj
= Fcons (event
->frame_or_window
, Qnil
);
4027 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4028 kbd_fetch_ptr
= event
+ 1;
4031 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4033 /* The value doesn't matter here; only the type is tested. */
4034 XSETBUFFER (obj
, current_buffer
);
4035 kbd_fetch_ptr
= event
+ 1;
4037 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4038 || defined (USE_GTK)
4039 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4041 kbd_fetch_ptr
= event
+ 1;
4042 input_pending
= readable_events (0);
4043 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4044 x_activate_menubar (XFRAME (event
->frame_or_window
));
4047 #if defined (WINDOWSNT) || defined (MAC_OS)
4048 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4051 /* Make an event (language-change (KEY_SCRIPT)). */
4052 obj
= Fcons (make_number (event
->code
), Qnil
);
4054 /* Make an event (language-change (FRAME CHARSET LCID)). */
4055 obj
= Fcons (event
->frame_or_window
, Qnil
);
4057 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4058 kbd_fetch_ptr
= event
+ 1;
4061 else if (event
->kind
== SAVE_SESSION_EVENT
)
4063 obj
= Fcons (Qsave_session
, Qnil
);
4064 kbd_fetch_ptr
= event
+ 1;
4066 /* Just discard these, by returning nil.
4067 With MULTI_KBOARD, these events are used as placeholders
4068 when we need to randomly delete events from the queue.
4069 (They shouldn't otherwise be found in the buffer,
4070 but on some machines it appears they do show up
4071 even without MULTI_KBOARD.) */
4072 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4073 mouse events during a popup-menu call. */
4074 else if (event
->kind
== NO_EVENT
)
4075 kbd_fetch_ptr
= event
+ 1;
4076 else if (event
->kind
== HELP_EVENT
)
4078 Lisp_Object object
, position
, help
, frame
, window
;
4080 frame
= event
->frame_or_window
;
4081 object
= event
->arg
;
4082 position
= make_number (event
->code
);
4085 clear_event (event
);
4087 kbd_fetch_ptr
= event
+ 1;
4088 if (!WINDOWP (window
))
4090 obj
= Fcons (Qhelp_echo
,
4091 list5 (frame
, help
, window
, object
, position
));
4093 else if (event
->kind
== FOCUS_IN_EVENT
)
4095 /* Notification of a FocusIn event. The frame receiving the
4096 focus is in event->frame_or_window. Generate a
4097 switch-frame event if necessary. */
4098 Lisp_Object frame
, focus
;
4100 frame
= event
->frame_or_window
;
4101 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4105 if (!EQ (frame
, internal_last_event_frame
)
4106 && !EQ (frame
, selected_frame
))
4107 obj
= make_lispy_switch_frame (frame
);
4108 internal_last_event_frame
= frame
;
4109 kbd_fetch_ptr
= event
+ 1;
4113 /* If this event is on a different frame, return a switch-frame this
4114 time, and leave the event in the queue for next time. */
4118 frame
= event
->frame_or_window
;
4120 frame
= XCAR (frame
);
4121 else if (WINDOWP (frame
))
4122 frame
= WINDOW_FRAME (XWINDOW (frame
));
4124 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4128 if (! EQ (frame
, internal_last_event_frame
)
4129 && !EQ (frame
, selected_frame
))
4130 obj
= make_lispy_switch_frame (frame
);
4131 internal_last_event_frame
= frame
;
4133 /* If we didn't decide to make a switch-frame event, go ahead
4134 and build a real event from the queue entry. */
4138 obj
= make_lispy_event (event
);
4140 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4141 || defined (USE_GTK)
4142 /* If this was a menu selection, then set the flag to inhibit
4143 writing to last_nonmenu_event. Don't do this if the event
4144 we're returning is (menu-bar), though; that indicates the
4145 beginning of the menu sequence, and we might as well leave
4146 that as the `event with parameters' for this selection. */
4148 && !EQ (event
->frame_or_window
, event
->arg
)
4149 && (event
->kind
== MENU_BAR_EVENT
4150 || event
->kind
== TOOL_BAR_EVENT
))
4151 *used_mouse_menu
= 1;
4154 /* Wipe out this event, to catch bugs. */
4155 clear_event (event
);
4156 kbd_fetch_ptr
= event
+ 1;
4161 /* Try generating a mouse motion event. */
4162 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4164 FRAME_PTR f
= some_mouse_moved ();
4165 Lisp_Object bar_window
;
4166 enum scroll_bar_part part
;
4170 *kbp
= current_kboard
;
4171 /* Note that this uses F to determine which display to look at.
4172 If there is no valid info, it does not store anything
4173 so x remains nil. */
4175 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4179 /* Decide if we should generate a switch-frame event. Don't
4180 generate switch-frame events for motion outside of all Emacs
4186 frame
= FRAME_FOCUS_FRAME (f
);
4188 XSETFRAME (frame
, f
);
4190 if (! EQ (frame
, internal_last_event_frame
)
4191 && !EQ (frame
, selected_frame
))
4192 obj
= make_lispy_switch_frame (frame
);
4193 internal_last_event_frame
= frame
;
4196 /* If we didn't decide to make a switch-frame event, go ahead and
4197 return a mouse-motion event. */
4198 if (!NILP (x
) && NILP (obj
))
4199 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4201 #endif /* HAVE_MOUSE */
4203 /* We were promised by the above while loop that there was
4204 something for us to read! */
4207 input_pending
= readable_events (0);
4209 Vlast_event_frame
= internal_last_event_frame
;
4214 /* Process any events that are not user-visible,
4215 then return, without reading any user-visible events. */
4218 swallow_events (do_display
)
4223 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4225 struct input_event
*event
;
4227 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4231 last_event_timestamp
= event
->timestamp
;
4233 /* These two kinds of events get special handling
4234 and don't actually appear to the command loop. */
4235 if (event
->kind
== SELECTION_REQUEST_EVENT
4236 || event
->kind
== SELECTION_CLEAR_EVENT
)
4239 struct input_event copy
;
4241 /* Remove it from the buffer before processing it,
4242 since otherwise swallow_events called recursively could see it
4243 and process it again. */
4245 kbd_fetch_ptr
= event
+ 1;
4246 input_pending
= readable_events (0);
4247 x_handle_selection_event (©
);
4249 /* We're getting selection request events, but we don't have
4258 old_timers_run
= timers_run
;
4259 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4261 if (timers_run
!= old_timers_run
&& do_display
)
4262 redisplay_preserve_echo_area (7);
4265 /* Record the start of when Emacs is idle,
4266 for the sake of running idle-time timers. */
4273 /* If we are already in the idle state, do nothing. */
4274 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4277 EMACS_GET_TIME (timer_idleness_start_time
);
4279 timer_last_idleness_start_time
= timer_idleness_start_time
;
4281 /* Mark all idle-time timers as once again candidates for running. */
4282 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4286 timer
= XCAR (timers
);
4288 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4290 XVECTOR (timer
)->contents
[0] = Qnil
;
4294 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4299 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4302 /* Resume idle timer from last idle start time. */
4305 timer_resume_idle ()
4307 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4310 timer_idleness_start_time
= timer_last_idleness_start_time
;
4313 /* This is only for debugging. */
4314 struct input_event last_timer_event
;
4316 /* Check whether a timer has fired. To prevent larger problems we simply
4317 disregard elements that are not proper timers. Do not make a circular
4318 timer list for the time being.
4320 Returns the number of seconds to wait until the next timer fires. If a
4321 timer is triggering now, return zero seconds.
4322 If no timer is active, return -1 seconds.
4324 If a timer is ripe, we run it, with quitting turned off.
4326 DO_IT_NOW is now ignored. It used to mean that we should
4327 run the timer directly instead of queueing a timer-event.
4328 Now we always run timers directly. */
4331 timer_check (do_it_now
)
4334 EMACS_TIME nexttime
;
4335 EMACS_TIME now
, idleness_now
;
4336 Lisp_Object timers
, idle_timers
, chosen_timer
;
4337 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4339 EMACS_SET_SECS (nexttime
, -1);
4340 EMACS_SET_USECS (nexttime
, -1);
4342 /* Always consider the ordinary timers. */
4343 timers
= Vtimer_list
;
4344 /* Consider the idle timers only if Emacs is idle. */
4345 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4346 idle_timers
= Vtimer_idle_list
;
4349 chosen_timer
= Qnil
;
4350 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4352 if (CONSP (timers
) || CONSP (idle_timers
))
4354 EMACS_GET_TIME (now
);
4355 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4356 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4359 while (CONSP (timers
) || CONSP (idle_timers
))
4361 Lisp_Object
*vector
;
4362 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4363 EMACS_TIME timer_time
, idle_timer_time
;
4364 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4366 /* Skip past invalid timers and timers already handled. */
4369 timer
= XCAR (timers
);
4370 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4372 timers
= XCDR (timers
);
4375 vector
= XVECTOR (timer
)->contents
;
4377 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4378 || !INTEGERP (vector
[3])
4379 || ! NILP (vector
[0]))
4381 timers
= XCDR (timers
);
4385 if (!NILP (idle_timers
))
4387 timer
= XCAR (idle_timers
);
4388 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4390 idle_timers
= XCDR (idle_timers
);
4393 vector
= XVECTOR (timer
)->contents
;
4395 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4396 || !INTEGERP (vector
[3])
4397 || ! NILP (vector
[0]))
4399 idle_timers
= XCDR (idle_timers
);
4404 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4405 based on the next ordinary timer.
4406 TIMER_DIFFERENCE is the distance in time from NOW to when
4407 this timer becomes ripe (negative if it's already ripe). */
4410 timer
= XCAR (timers
);
4411 vector
= XVECTOR (timer
)->contents
;
4412 EMACS_SET_SECS (timer_time
,
4413 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4414 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4415 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4418 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4419 based on the next idle timer. */
4420 if (!NILP (idle_timers
))
4422 idle_timer
= XCAR (idle_timers
);
4423 vector
= XVECTOR (idle_timer
)->contents
;
4424 EMACS_SET_SECS (idle_timer_time
,
4425 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4426 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4427 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4430 /* Decide which timer is the next timer,
4431 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4432 Also step down the list where we found that timer. */
4434 if (! NILP (timers
) && ! NILP (idle_timers
))
4437 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4438 if (EMACS_TIME_NEG_P (temp
))
4440 chosen_timer
= timer
;
4441 timers
= XCDR (timers
);
4442 difference
= timer_difference
;
4446 chosen_timer
= idle_timer
;
4447 idle_timers
= XCDR (idle_timers
);
4448 difference
= idle_timer_difference
;
4451 else if (! NILP (timers
))
4453 chosen_timer
= timer
;
4454 timers
= XCDR (timers
);
4455 difference
= timer_difference
;
4459 chosen_timer
= idle_timer
;
4460 idle_timers
= XCDR (idle_timers
);
4461 difference
= idle_timer_difference
;
4463 vector
= XVECTOR (chosen_timer
)->contents
;
4465 /* If timer is ripe, run it if it hasn't been run. */
4466 if (EMACS_TIME_NEG_P (difference
)
4467 || (EMACS_SECS (difference
) == 0
4468 && EMACS_USECS (difference
) == 0))
4470 if (NILP (vector
[0]))
4472 int was_locked
= single_kboard
;
4473 int count
= SPECPDL_INDEX ();
4474 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4476 /* Mark the timer as triggered to prevent problems if the lisp
4477 code fails to reschedule it right. */
4480 specbind (Qinhibit_quit
, Qt
);
4482 call1 (Qtimer_event_handler
, chosen_timer
);
4483 Vdeactivate_mark
= old_deactivate_mark
;
4485 unbind_to (count
, Qnil
);
4487 /* Resume allowing input from any kboard, if that was true before. */
4489 any_kboard_state ();
4491 /* Since we have handled the event,
4492 we don't need to tell the caller to wake up and do it. */
4496 /* When we encounter a timer that is still waiting,
4497 return the amount of time to wait before it is ripe. */
4504 /* No timers are pending in the future. */
4505 /* Return 0 if we generated an event, and -1 if not. */
4510 /* Caches for modify_event_symbol. */
4511 static Lisp_Object accent_key_syms
;
4512 static Lisp_Object func_key_syms
;
4513 static Lisp_Object mouse_syms
;
4514 static Lisp_Object wheel_syms
;
4515 static Lisp_Object drag_n_drop_syms
;
4517 /* This is a list of keysym codes for special "accent" characters.
4518 It parallels lispy_accent_keys. */
4520 static int lispy_accent_codes
[] =
4522 #ifdef XK_dead_circumflex
4527 #ifdef XK_dead_grave
4532 #ifdef XK_dead_tilde
4537 #ifdef XK_dead_diaeresis
4542 #ifdef XK_dead_macron
4547 #ifdef XK_dead_degree
4552 #ifdef XK_dead_acute
4557 #ifdef XK_dead_cedilla
4562 #ifdef XK_dead_breve
4567 #ifdef XK_dead_ogonek
4572 #ifdef XK_dead_caron
4577 #ifdef XK_dead_doubleacute
4578 XK_dead_doubleacute
,
4582 #ifdef XK_dead_abovedot
4587 #ifdef XK_dead_abovering
4597 #ifdef XK_dead_belowdot
4602 #ifdef XK_dead_voiced_sound
4603 XK_dead_voiced_sound
,
4607 #ifdef XK_dead_semivoiced_sound
4608 XK_dead_semivoiced_sound
,
4624 /* This is a list of Lisp names for special "accent" characters.
4625 It parallels lispy_accent_codes. */
4627 static char *lispy_accent_keys
[] =
4645 "dead-voiced-sound",
4646 "dead-semivoiced-sound",
4652 #define FUNCTION_KEY_OFFSET 0x0
4654 char *lispy_function_keys
[] =
4658 0, /* VK_LBUTTON 0x01 */
4659 0, /* VK_RBUTTON 0x02 */
4660 "cancel", /* VK_CANCEL 0x03 */
4661 0, /* VK_MBUTTON 0x04 */
4663 0, 0, 0, /* 0x05 .. 0x07 */
4665 "backspace", /* VK_BACK 0x08 */
4666 "tab", /* VK_TAB 0x09 */
4668 0, 0, /* 0x0A .. 0x0B */
4670 "clear", /* VK_CLEAR 0x0C */
4671 "return", /* VK_RETURN 0x0D */
4673 0, 0, /* 0x0E .. 0x0F */
4675 0, /* VK_SHIFT 0x10 */
4676 0, /* VK_CONTROL 0x11 */
4677 0, /* VK_MENU 0x12 */
4678 "pause", /* VK_PAUSE 0x13 */
4679 "capslock", /* VK_CAPITAL 0x14 */
4681 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4683 "escape", /* VK_ESCAPE 0x1B */
4685 0, 0, 0, 0, /* 0x1C .. 0x1F */
4687 0, /* VK_SPACE 0x20 */
4688 "prior", /* VK_PRIOR 0x21 */
4689 "next", /* VK_NEXT 0x22 */
4690 "end", /* VK_END 0x23 */
4691 "home", /* VK_HOME 0x24 */
4692 "left", /* VK_LEFT 0x25 */
4693 "up", /* VK_UP 0x26 */
4694 "right", /* VK_RIGHT 0x27 */
4695 "down", /* VK_DOWN 0x28 */
4696 "select", /* VK_SELECT 0x29 */
4697 "print", /* VK_PRINT 0x2A */
4698 "execute", /* VK_EXECUTE 0x2B */
4699 "snapshot", /* VK_SNAPSHOT 0x2C */
4700 "insert", /* VK_INSERT 0x2D */
4701 "delete", /* VK_DELETE 0x2E */
4702 "help", /* VK_HELP 0x2F */
4704 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4706 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4708 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4710 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4712 0, 0, 0, 0, 0, 0, 0, 0, 0,
4713 0, 0, 0, 0, 0, 0, 0, 0, 0,
4714 0, 0, 0, 0, 0, 0, 0, 0,
4716 "lwindow", /* VK_LWIN 0x5B */
4717 "rwindow", /* VK_RWIN 0x5C */
4718 "apps", /* VK_APPS 0x5D */
4720 0, 0, /* 0x5E .. 0x5F */
4722 "kp-0", /* VK_NUMPAD0 0x60 */
4723 "kp-1", /* VK_NUMPAD1 0x61 */
4724 "kp-2", /* VK_NUMPAD2 0x62 */
4725 "kp-3", /* VK_NUMPAD3 0x63 */
4726 "kp-4", /* VK_NUMPAD4 0x64 */
4727 "kp-5", /* VK_NUMPAD5 0x65 */
4728 "kp-6", /* VK_NUMPAD6 0x66 */
4729 "kp-7", /* VK_NUMPAD7 0x67 */
4730 "kp-8", /* VK_NUMPAD8 0x68 */
4731 "kp-9", /* VK_NUMPAD9 0x69 */
4732 "kp-multiply", /* VK_MULTIPLY 0x6A */
4733 "kp-add", /* VK_ADD 0x6B */
4734 "kp-separator", /* VK_SEPARATOR 0x6C */
4735 "kp-subtract", /* VK_SUBTRACT 0x6D */
4736 "kp-decimal", /* VK_DECIMAL 0x6E */
4737 "kp-divide", /* VK_DIVIDE 0x6F */
4738 "f1", /* VK_F1 0x70 */
4739 "f2", /* VK_F2 0x71 */
4740 "f3", /* VK_F3 0x72 */
4741 "f4", /* VK_F4 0x73 */
4742 "f5", /* VK_F5 0x74 */
4743 "f6", /* VK_F6 0x75 */
4744 "f7", /* VK_F7 0x76 */
4745 "f8", /* VK_F8 0x77 */
4746 "f9", /* VK_F9 0x78 */
4747 "f10", /* VK_F10 0x79 */
4748 "f11", /* VK_F11 0x7A */
4749 "f12", /* VK_F12 0x7B */
4750 "f13", /* VK_F13 0x7C */
4751 "f14", /* VK_F14 0x7D */
4752 "f15", /* VK_F15 0x7E */
4753 "f16", /* VK_F16 0x7F */
4754 "f17", /* VK_F17 0x80 */
4755 "f18", /* VK_F18 0x81 */
4756 "f19", /* VK_F19 0x82 */
4757 "f20", /* VK_F20 0x83 */
4758 "f21", /* VK_F21 0x84 */
4759 "f22", /* VK_F22 0x85 */
4760 "f23", /* VK_F23 0x86 */
4761 "f24", /* VK_F24 0x87 */
4763 0, 0, 0, 0, /* 0x88 .. 0x8B */
4764 0, 0, 0, 0, /* 0x8C .. 0x8F */
4766 "kp-numlock", /* VK_NUMLOCK 0x90 */
4767 "scroll", /* VK_SCROLL 0x91 */
4769 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4770 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4771 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4772 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4773 "kp-end", /* VK_NUMPAD_END 0x96 */
4774 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4775 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4776 "kp-up", /* VK_NUMPAD_UP 0x99 */
4777 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4778 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4779 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4780 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4782 0, 0, /* 0x9E .. 0x9F */
4785 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4786 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4787 * No other API or message will distinguish left and right keys this way.
4791 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4792 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4793 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4794 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4795 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4801 "attn", /* VK_ATTN 0xF6 */
4802 "crsel", /* VK_CRSEL 0xF7 */
4803 "exsel", /* VK_EXSEL 0xF8 */
4804 "ereof", /* VK_EREOF 0xF9 */
4805 "play", /* VK_PLAY 0xFA */
4806 "zoom", /* VK_ZOOM 0xFB */
4807 "noname", /* VK_NONAME 0xFC */
4808 "pa1", /* VK_PA1 0xFD */
4809 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4813 #else /* not HAVE_NTGUI */
4815 /* This should be dealt with in XTread_socket now, and that doesn't
4816 depend on the client system having the Kana syms defined. See also
4817 the XK_kana_A case below. */
4820 static char *lispy_kana_keys
[] =
4822 /* X Keysym value */
4823 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4824 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4825 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4826 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4827 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4828 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4829 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4830 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4831 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4832 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4833 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4834 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4835 "kana-i", "kana-u", "kana-e", "kana-o",
4836 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4837 "prolongedsound", "kana-A", "kana-I", "kana-U",
4838 "kana-E", "kana-O", "kana-KA", "kana-KI",
4839 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4840 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4841 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4842 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4843 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4844 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4845 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4846 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4847 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4848 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4849 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4850 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4852 #endif /* XK_kana_A */
4855 #define FUNCTION_KEY_OFFSET 0xff00
4857 /* You'll notice that this table is arranged to be conveniently
4858 indexed by X Windows keysym values. */
4859 static char *lispy_function_keys
[] =
4861 /* X Keysym value */
4863 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4864 "backspace", "tab", "linefeed", "clear",
4866 0, 0, 0, "pause", /* 0xff10...1f */
4867 0, 0, 0, 0, 0, 0, 0, "escape",
4869 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4870 "romaji", "hiragana", "katakana", "hiragana-katakana",
4871 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4872 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4873 "eisu-toggle", /* 0xff30...3f */
4874 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4875 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4877 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4878 "down", "prior", "next", "end",
4879 "begin", 0, 0, 0, 0, 0, 0, 0,
4880 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4891 "break", /* 0xff6b */
4894 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4895 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4896 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4897 0, 0, 0, 0, 0, 0, 0, 0,
4898 "kp-tab", /* 0xff89 */
4900 "kp-enter", /* 0xff8d */
4902 "kp-f1", /* 0xff91 */
4906 "kp-home", /* 0xff95 */
4911 "kp-prior", /* kp-page-up */
4912 "kp-next", /* kp-page-down */
4918 0, 0, 0, 0, 0, 0, 0, 0, 0,
4919 "kp-multiply", /* 0xffaa */
4924 "kp-divide", /* 0xffaf */
4925 "kp-0", /* 0xffb0 */
4926 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4929 "kp-equal", /* 0xffbd */
4930 "f1", /* 0xffbe */ /* IsFunctionKey */
4932 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4933 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4934 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4935 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4936 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4937 0, 0, 0, 0, 0, 0, 0, 0,
4938 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4939 0, 0, 0, 0, 0, 0, 0, "delete"
4942 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4943 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4945 static char *iso_lispy_function_keys
[] =
4947 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4948 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4949 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4950 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4951 "iso-lefttab", /* 0xfe20 */
4952 "iso-move-line-up", "iso-move-line-down",
4953 "iso-partial-line-up", "iso-partial-line-down",
4954 "iso-partial-space-left", "iso-partial-space-right",
4955 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4956 "iso-release-margin-left", "iso-release-margin-right",
4957 "iso-release-both-margins",
4958 "iso-fast-cursor-left", "iso-fast-cursor-right",
4959 "iso-fast-cursor-up", "iso-fast-cursor-down",
4960 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4961 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4964 #endif /* not HAVE_NTGUI */
4966 Lisp_Object Vlispy_mouse_stem
;
4968 static char *lispy_wheel_names
[] =
4970 "wheel-up", "wheel-down"
4973 /* drag-n-drop events are generated when a set of selected files are
4974 dragged from another application and dropped onto an Emacs window. */
4975 static char *lispy_drag_n_drop_names
[] =
4980 /* Scroll bar parts. */
4981 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4982 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4983 Lisp_Object Qtop
, Qratio
;
4985 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4986 Lisp_Object
*scroll_bar_parts
[] = {
4987 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4988 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4991 /* User signal events. */
4992 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4994 Lisp_Object
*lispy_user_signals
[] =
4996 &Qusr1_signal
, &Qusr2_signal
5000 /* A vector, indexed by button number, giving the down-going location
5001 of currently depressed buttons, both scroll bar and non-scroll bar.
5003 The elements have the form
5004 (BUTTON-NUMBER MODIFIER-MASK . REST)
5005 where REST is the cdr of a position as it would be reported in the event.
5007 The make_lispy_event function stores positions here to tell the
5008 difference between click and drag events, and to store the starting
5009 location to be included in drag events. */
5011 static Lisp_Object button_down_location
;
5013 /* Information about the most recent up-going button event: Which
5014 button, what location, and what time. */
5016 static int last_mouse_button
;
5017 static int last_mouse_x
;
5018 static int last_mouse_y
;
5019 static unsigned long button_down_time
;
5021 /* The maximum time between clicks to make a double-click, or Qnil to
5022 disable double-click detection, or Qt for no time limit. */
5024 Lisp_Object Vdouble_click_time
;
5026 /* Maximum number of pixels the mouse may be moved between clicks
5027 to make a double-click. */
5029 EMACS_INT double_click_fuzz
;
5031 /* The number of clicks in this multiple-click. */
5033 int double_click_count
;
5035 /* Return position of a mouse click or wheel event */
5038 make_lispy_position (f
, x
, y
, time
)
5044 enum window_part part
;
5045 Lisp_Object posn
= Qnil
;
5046 Lisp_Object extra_info
= Qnil
;
5049 /* Set `window' to the window under frame pixel coordinates (x,y) */
5051 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5052 &part
, &wx
, &wy
, 0);
5056 if (WINDOWP (window
))
5058 /* It's a click in window window at frame coordinates (x,y) */
5059 struct window
*w
= XWINDOW (window
);
5060 Lisp_Object string_info
= Qnil
;
5061 int textpos
= -1, rx
= -1, ry
= -1;
5062 int dx
= -1, dy
= -1;
5063 int width
= -1, height
= -1;
5064 Lisp_Object object
= Qnil
;
5066 /* Set event coordinates to window-relative coordinates
5067 for constructing the Lisp event below. */
5071 if (part
== ON_TEXT
)
5073 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5075 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5077 /* Mode line or header line. Look for a string under
5078 the mouse that may have a `local-map' property. */
5082 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5084 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5085 &object
, &dx
, &dy
, &width
, &height
);
5086 if (STRINGP (string
))
5087 string_info
= Fcons (string
, make_number (charpos
));
5088 if (w
== XWINDOW (selected_window
))
5091 textpos
= XMARKER (w
->pointm
)->charpos
;
5093 else if (part
== ON_VERTICAL_BORDER
)
5095 posn
= Qvertical_line
;
5100 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5105 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5107 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5108 &object
, &dx
, &dy
, &width
, &height
);
5109 if (STRINGP (string
))
5110 string_info
= Fcons (string
, make_number (charpos
));
5111 if (part
== ON_LEFT_MARGIN
)
5114 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5116 else if (part
== ON_LEFT_FRINGE
)
5118 posn
= Qleft_fringe
;
5121 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5123 : window_box_width (w
, LEFT_MARGIN_AREA
));
5126 else if (part
== ON_RIGHT_FRINGE
)
5128 posn
= Qright_fringe
;
5131 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5132 + window_box_width (w
, TEXT_AREA
)
5133 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5134 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5140 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5141 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5146 Lisp_Object string2
, object2
= Qnil
;
5147 struct display_pos p
;
5149 int width2
, height2
;
5150 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5151 &object2
, &dx2
, &dy2
,
5153 textpos
= CHARPOS (p
.pos
);
5154 if (rx
< 0) rx
= wx
;
5155 if (ry
< 0) ry
= wy
;
5156 if (dx
< 0) dx
= dx2
;
5157 if (dy
< 0) dy
= dy2
;
5158 if (width
< 0) width
= width2
;
5159 if (height
< 0) height
= height2
;
5163 posn
= make_number (textpos
);
5164 if (STRINGP (string2
))
5165 string_info
= Fcons (string2
,
5166 make_number (CHARPOS (p
.string_pos
)));
5172 #ifdef HAVE_WINDOW_SYSTEM
5173 if (IMAGEP (object
))
5175 Lisp_Object image_map
, hotspot
;
5176 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5178 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5180 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5181 posn
= XCAR (hotspot
);
5186 extra_info
= Fcons (object
,
5187 Fcons (Fcons (make_number (dx
),
5189 Fcons (Fcons (make_number (width
),
5190 make_number (height
)),
5194 extra_info
= Fcons (string_info
,
5195 Fcons (make_number (textpos
),
5196 Fcons (Fcons (make_number (rx
),
5202 XSETFRAME (window
, f
);
5207 XSETFASTINT (*x
, 0);
5208 XSETFASTINT (*y
, 0);
5211 return Fcons (window
,
5213 Fcons (Fcons (*x
, *y
),
5214 Fcons (make_number (time
),
5218 /* Given a struct input_event, build the lisp event which represents
5219 it. If EVENT is 0, build a mouse movement event from the mouse
5220 movement buffer, which should have a movement event in it.
5222 Note that events must be passed to this function in the order they
5223 are received; this function stores the location of button presses
5224 in order to build drag events when the button is released. */
5227 make_lispy_event (event
)
5228 struct input_event
*event
;
5232 switch (SWITCH_ENUM_CAST (event
->kind
))
5234 /* A simple keystroke. */
5235 case ASCII_KEYSTROKE_EVENT
:
5237 Lisp_Object lispy_c
;
5238 int c
= event
->code
& 0377;
5239 /* Turn ASCII characters into control characters
5241 if (event
->modifiers
& ctrl_modifier
)
5242 c
= make_ctrl_char (c
);
5244 /* Add in the other modifier bits. We took care of ctrl_modifier
5245 just above, and the shift key was taken care of by the X code,
5246 and applied to control characters by make_ctrl_char. */
5247 c
|= (event
->modifiers
5248 & (meta_modifier
| alt_modifier
5249 | hyper_modifier
| super_modifier
));
5250 /* Distinguish Shift-SPC from SPC. */
5251 if ((event
->code
& 0377) == 040
5252 && event
->modifiers
& shift_modifier
)
5253 c
|= shift_modifier
;
5254 button_down_time
= 0;
5255 XSETFASTINT (lispy_c
, c
);
5259 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5261 Lisp_Object lispy_c
;
5262 int c
= event
->code
;
5264 /* Add in the other modifier bits. We took care of ctrl_modifier
5265 just above, and the shift key was taken care of by the X code,
5266 and applied to control characters by make_ctrl_char. */
5267 c
|= (event
->modifiers
5268 & (meta_modifier
| alt_modifier
5269 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5270 /* What about the `shift' modifier ? */
5271 button_down_time
= 0;
5272 XSETFASTINT (lispy_c
, c
);
5276 /* A function key. The symbol may need to have modifier prefixes
5278 case NON_ASCII_KEYSTROKE_EVENT
:
5279 button_down_time
= 0;
5281 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5282 if (event
->code
== lispy_accent_codes
[i
])
5283 return modify_event_symbol (i
,
5285 Qfunction_key
, Qnil
,
5286 lispy_accent_keys
, &accent_key_syms
,
5287 (sizeof (lispy_accent_keys
)
5288 / sizeof (lispy_accent_keys
[0])));
5292 if (event
->code
>= 0x400 && event
->code
< 0x500)
5293 return modify_event_symbol (event
->code
- 0x400,
5294 event
->modifiers
& ~shift_modifier
,
5295 Qfunction_key
, Qnil
,
5296 lispy_kana_keys
, &func_key_syms
,
5297 (sizeof (lispy_kana_keys
)
5298 / sizeof (lispy_kana_keys
[0])));
5299 #endif /* XK_kana_A */
5302 #ifdef ISO_FUNCTION_KEY_OFFSET
5303 if (event
->code
< FUNCTION_KEY_OFFSET
5304 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5305 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5307 Qfunction_key
, Qnil
,
5308 iso_lispy_function_keys
, &func_key_syms
,
5309 (sizeof (iso_lispy_function_keys
)
5310 / sizeof (iso_lispy_function_keys
[0])));
5313 /* Handle system-specific or unknown keysyms. */
5314 if (event
->code
& (1 << 28)
5315 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5316 || (event
->code
- FUNCTION_KEY_OFFSET
5317 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5318 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5320 /* We need to use an alist rather than a vector as the cache
5321 since we can't make a vector long enuf. */
5322 if (NILP (current_kboard
->system_key_syms
))
5323 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5324 return modify_event_symbol (event
->code
,
5327 current_kboard
->Vsystem_key_alist
,
5328 0, ¤t_kboard
->system_key_syms
,
5332 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5334 Qfunction_key
, Qnil
,
5335 lispy_function_keys
, &func_key_syms
,
5336 (sizeof (lispy_function_keys
)
5337 / sizeof (lispy_function_keys
[0])));
5340 /* A mouse click. Figure out where it is, decide whether it's
5341 a press, click or drag, and build the appropriate structure. */
5342 case MOUSE_CLICK_EVENT
:
5343 #ifndef USE_TOOLKIT_SCROLL_BARS
5344 case SCROLL_BAR_CLICK_EVENT
:
5347 int button
= event
->code
;
5349 Lisp_Object position
;
5350 Lisp_Object
*start_pos_ptr
;
5351 Lisp_Object start_pos
;
5355 /* Build the position as appropriate for this mouse click. */
5356 if (event
->kind
== MOUSE_CLICK_EVENT
)
5358 struct frame
*f
= XFRAME (event
->frame_or_window
);
5359 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5363 /* Ignore mouse events that were made on frame that
5364 have been deleted. */
5365 if (! FRAME_LIVE_P (f
))
5368 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5369 /* EVENT->x and EVENT->y are frame-relative pixel
5370 coordinates at this place. Under old redisplay, COLUMN
5371 and ROW are set to frame relative glyph coordinates
5372 which are then used to determine whether this click is
5373 in a menu (non-toolkit version). */
5374 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5375 &column
, &row
, NULL
, 1);
5377 /* In the non-toolkit version, clicks on the menu bar
5378 are ordinary button events in the event buffer.
5379 Distinguish them, and invoke the menu.
5381 (In the toolkit version, the toolkit handles the menu bar
5382 and Emacs doesn't know about it until after the user
5383 makes a selection.) */
5384 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5385 && (event
->modifiers
& down_modifier
))
5387 Lisp_Object items
, item
;
5392 /* Activate the menu bar on the down event. If the
5393 up event comes in before the menu code can deal with it,
5395 if (! (event
->modifiers
& down_modifier
))
5399 /* Find the menu bar item under `column'. */
5401 items
= FRAME_MENU_BAR_ITEMS (f
);
5402 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5404 Lisp_Object pos
, string
;
5405 string
= AREF (items
, i
+ 1);
5406 pos
= AREF (items
, i
+ 3);
5409 if (column
>= XINT (pos
)
5410 && column
< XINT (pos
) + SCHARS (string
))
5412 item
= AREF (items
, i
);
5417 /* ELisp manual 2.4b says (x y) are window relative but
5418 code says they are frame-relative. */
5420 = Fcons (event
->frame_or_window
,
5422 Fcons (Fcons (event
->x
, event
->y
),
5423 Fcons (make_number (event
->timestamp
),
5426 return Fcons (item
, Fcons (position
, Qnil
));
5428 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5430 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5433 #ifndef USE_TOOLKIT_SCROLL_BARS
5436 /* It's a scrollbar click. */
5438 Lisp_Object portion_whole
;
5441 window
= event
->frame_or_window
;
5442 portion_whole
= Fcons (event
->x
, event
->y
);
5443 part
= *scroll_bar_parts
[(int) event
->part
];
5447 Fcons (Qvertical_scroll_bar
,
5448 Fcons (portion_whole
,
5449 Fcons (make_number (event
->timestamp
),
5450 Fcons (part
, Qnil
)))));
5452 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5454 if (button
>= ASIZE (button_down_location
))
5456 button_down_location
= larger_vector (button_down_location
,
5458 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5461 start_pos_ptr
= &AREF (button_down_location
, button
);
5462 start_pos
= *start_pos_ptr
;
5463 *start_pos_ptr
= Qnil
;
5466 /* On window-system frames, use the value of
5467 double-click-fuzz as is. On other frames, interpret it
5468 as a multiple of 1/8 characters. */
5472 if (WINDOWP (event
->frame_or_window
))
5473 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5474 else if (FRAMEP (event
->frame_or_window
))
5475 f
= XFRAME (event
->frame_or_window
);
5479 if (FRAME_WINDOW_P (f
))
5480 fuzz
= double_click_fuzz
;
5482 fuzz
= double_click_fuzz
/ 8;
5484 is_double
= (button
== last_mouse_button
5485 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5486 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5487 && button_down_time
!= 0
5488 && (EQ (Vdouble_click_time
, Qt
)
5489 || (INTEGERP (Vdouble_click_time
)
5490 && ((int)(event
->timestamp
- button_down_time
)
5491 < XINT (Vdouble_click_time
)))));
5494 last_mouse_button
= button
;
5495 last_mouse_x
= XINT (event
->x
);
5496 last_mouse_y
= XINT (event
->y
);
5498 /* If this is a button press, squirrel away the location, so
5499 we can decide later whether it was a click or a drag. */
5500 if (event
->modifiers
& down_modifier
)
5504 double_click_count
++;
5505 event
->modifiers
|= ((double_click_count
> 2)
5510 double_click_count
= 1;
5511 button_down_time
= event
->timestamp
;
5512 *start_pos_ptr
= Fcopy_alist (position
);
5515 /* Now we're releasing a button - check the co-ordinates to
5516 see if this was a click or a drag. */
5517 else if (event
->modifiers
& up_modifier
)
5519 /* If we did not see a down before this up, ignore the up.
5520 Probably this happened because the down event chose a
5521 menu item. It would be an annoyance to treat the
5522 release of the button that chose the menu item as a
5525 if (!CONSP (start_pos
))
5528 event
->modifiers
&= ~up_modifier
;
5529 #if 0 /* Formerly we treated an up with no down as a click event. */
5530 if (!CONSP (start_pos
))
5531 event
->modifiers
|= click_modifier
;
5536 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5538 /* The third element of every position
5539 should be the (x,y) pair. */
5540 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5542 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5544 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5545 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5548 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5549 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5550 /* Maybe the mouse has moved a lot, caused scrolling, and
5551 eventually ended up at the same screen position (but
5552 not buffer position) in which case it is a drag, not
5554 /* FIXME: OTOH if the buffer position has changed
5555 because of a timer or process filter rather than
5556 because of mouse movement, it should be considered as
5557 a click. But mouse-drag-region completely ignores
5558 this case and it hasn't caused any real problem, so
5559 it's probably OK to ignore it as well. */
5560 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5561 /* Mouse hasn't moved (much). */
5562 event
->modifiers
|= click_modifier
;
5565 button_down_time
= 0;
5566 event
->modifiers
|= drag_modifier
;
5569 /* Don't check is_double; treat this as multiple
5570 if the down-event was multiple. */
5571 if (double_click_count
> 1)
5572 event
->modifiers
|= ((double_click_count
> 2)
5578 /* Every mouse event should either have the down_modifier or
5579 the up_modifier set. */
5583 /* Get the symbol we should use for the mouse click. */
5586 head
= modify_event_symbol (button
,
5588 Qmouse_click
, Vlispy_mouse_stem
,
5591 XVECTOR (mouse_syms
)->size
);
5592 if (event
->modifiers
& drag_modifier
)
5597 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5600 Fcons (make_number (double_click_count
),
5611 Lisp_Object position
;
5614 /* Build the position as appropriate for this mouse click. */
5615 struct frame
*f
= XFRAME (event
->frame_or_window
);
5617 /* Ignore wheel events that were made on frame that have been
5619 if (! FRAME_LIVE_P (f
))
5622 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5625 /* Set double or triple modifiers to indicate the wheel speed. */
5627 /* On window-system frames, use the value of
5628 double-click-fuzz as is. On other frames, interpret it
5629 as a multiple of 1/8 characters. */
5634 if (WINDOWP (event
->frame_or_window
))
5635 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5636 else if (FRAMEP (event
->frame_or_window
))
5637 f
= XFRAME (event
->frame_or_window
);
5641 if (FRAME_WINDOW_P (f
))
5642 fuzz
= double_click_fuzz
;
5644 fuzz
= double_click_fuzz
/ 8;
5646 is_double
= (last_mouse_button
< 0
5647 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5648 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5649 && button_down_time
!= 0
5650 && (EQ (Vdouble_click_time
, Qt
)
5651 || (INTEGERP (Vdouble_click_time
)
5652 && ((int)(event
->timestamp
- button_down_time
)
5653 < XINT (Vdouble_click_time
)))));
5656 double_click_count
++;
5657 event
->modifiers
|= ((double_click_count
> 2)
5663 double_click_count
= 1;
5664 event
->modifiers
|= click_modifier
;
5667 button_down_time
= event
->timestamp
;
5668 /* Use a negative value to distinguish wheel from mouse button. */
5669 last_mouse_button
= -1;
5670 last_mouse_x
= XINT (event
->x
);
5671 last_mouse_y
= XINT (event
->y
);
5677 if (event
->modifiers
& up_modifier
)
5679 /* Emit a wheel-up event. */
5680 event
->modifiers
&= ~up_modifier
;
5683 else if (event
->modifiers
& down_modifier
)
5685 /* Emit a wheel-down event. */
5686 event
->modifiers
&= ~down_modifier
;
5690 /* Every wheel event should either have the down_modifier or
5691 the up_modifier set. */
5694 /* Get the symbol we should use for the wheel event. */
5695 head
= modify_event_symbol (symbol_num
,
5701 ASIZE (wheel_syms
));
5704 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5707 Fcons (make_number (double_click_count
),
5716 #ifdef USE_TOOLKIT_SCROLL_BARS
5718 /* We don't have down and up events if using toolkit scroll bars,
5719 so make this always a click event. Store in the `part' of
5720 the Lisp event a symbol which maps to the following actions:
5722 `above_handle' page up
5723 `below_handle' page down
5727 `bottom' bottom of buffer
5728 `handle' thumb has been dragged.
5729 `end-scroll' end of interaction with scroll bar
5731 The incoming input_event contains in its `part' member an
5732 index of type `enum scroll_bar_part' which we can use as an
5733 index in scroll_bar_parts to get the appropriate symbol. */
5735 case SCROLL_BAR_CLICK_EVENT
:
5737 Lisp_Object position
, head
, window
, portion_whole
, part
;
5739 window
= event
->frame_or_window
;
5740 portion_whole
= Fcons (event
->x
, event
->y
);
5741 part
= *scroll_bar_parts
[(int) event
->part
];
5745 Fcons (Qvertical_scroll_bar
,
5746 Fcons (portion_whole
,
5747 Fcons (make_number (event
->timestamp
),
5748 Fcons (part
, Qnil
)))));
5750 /* Always treat scroll bar events as clicks. */
5751 event
->modifiers
|= click_modifier
;
5752 event
->modifiers
&= ~up_modifier
;
5754 if (event
->code
>= ASIZE (mouse_syms
))
5755 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5757 /* Get the symbol we should use for the mouse click. */
5758 head
= modify_event_symbol (event
->code
,
5763 XVECTOR (mouse_syms
)->size
);
5764 return Fcons (head
, Fcons (position
, Qnil
));
5767 #endif /* USE_TOOLKIT_SCROLL_BARS */
5770 case W32_SCROLL_BAR_CLICK_EVENT
:
5772 int button
= event
->code
;
5774 Lisp_Object position
;
5775 Lisp_Object
*start_pos_ptr
;
5776 Lisp_Object start_pos
;
5780 Lisp_Object portion_whole
;
5783 window
= event
->frame_or_window
;
5784 portion_whole
= Fcons (event
->x
, event
->y
);
5785 part
= *scroll_bar_parts
[(int) event
->part
];
5789 Fcons (Qvertical_scroll_bar
,
5790 Fcons (portion_whole
,
5791 Fcons (make_number (event
->timestamp
),
5792 Fcons (part
, Qnil
)))));
5795 /* Always treat W32 scroll bar events as clicks. */
5796 event
->modifiers
|= click_modifier
;
5799 /* Get the symbol we should use for the mouse click. */
5802 head
= modify_event_symbol (button
,
5807 XVECTOR (mouse_syms
)->size
);
5813 #endif /* WINDOWSNT */
5815 case DRAG_N_DROP_EVENT
:
5818 Lisp_Object head
, position
;
5821 f
= XFRAME (event
->frame_or_window
);
5824 /* Ignore mouse events that were made on frames that
5825 have been deleted. */
5826 if (! FRAME_LIVE_P (f
))
5829 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5832 head
= modify_event_symbol (0, event
->modifiers
,
5834 lispy_drag_n_drop_names
,
5835 &drag_n_drop_syms
, 1);
5841 #endif /* HAVE_MOUSE */
5843 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5844 || defined (USE_GTK)
5845 case MENU_BAR_EVENT
:
5846 if (EQ (event
->arg
, event
->frame_or_window
))
5847 /* This is the prefix key. We translate this to
5848 `(menu_bar)' because the code in keyboard.c for menu
5849 events, which we use, relies on this. */
5850 return Fcons (Qmenu_bar
, Qnil
);
5854 case SELECT_WINDOW_EVENT
:
5855 /* Make an event (select-window (WINDOW)). */
5856 return Fcons (Qselect_window
,
5857 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5860 case TOOL_BAR_EVENT
:
5861 if (EQ (event
->arg
, event
->frame_or_window
))
5862 /* This is the prefix key. We translate this to
5863 `(tool_bar)' because the code in keyboard.c for tool bar
5864 events, which we use, relies on this. */
5865 return Fcons (Qtool_bar
, Qnil
);
5866 else if (SYMBOLP (event
->arg
))
5867 return apply_modifiers (event
->modifiers
, event
->arg
);
5870 case USER_SIGNAL_EVENT
:
5871 /* A user signal. */
5872 return *lispy_user_signals
[event
->code
];
5874 case SAVE_SESSION_EVENT
:
5875 return Qsave_session
;
5878 case MAC_APPLE_EVENT
:
5880 Lisp_Object spec
[2];
5884 return Fcons (Qmac_apple_event
,
5885 Fcons (Fvector (2, spec
),
5886 Fcons (event
->arg
, Qnil
)));
5890 /* The 'kind' field of the event is something we don't recognize. */
5899 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5901 Lisp_Object bar_window
;
5902 enum scroll_bar_part part
;
5906 /* Is it a scroll bar movement? */
5907 if (frame
&& ! NILP (bar_window
))
5909 Lisp_Object part_sym
;
5911 part_sym
= *scroll_bar_parts
[(int) part
];
5912 return Fcons (Qscroll_bar_movement
,
5913 (Fcons (Fcons (bar_window
,
5914 Fcons (Qvertical_scroll_bar
,
5915 Fcons (Fcons (x
, y
),
5916 Fcons (make_number (time
),
5922 /* Or is it an ordinary mouse movement? */
5925 Lisp_Object position
;
5927 position
= make_lispy_position (frame
, &x
, &y
, time
);
5929 return Fcons (Qmouse_movement
,
5935 #endif /* HAVE_MOUSE */
5937 /* Construct a switch frame event. */
5939 make_lispy_switch_frame (frame
)
5942 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5945 /* Manipulating modifiers. */
5947 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5949 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5950 SYMBOL's name of the end of the modifiers; the string from this
5951 position is the unmodified symbol name.
5953 This doesn't use any caches. */
5956 parse_modifiers_uncached (symbol
, modifier_end
)
5964 CHECK_SYMBOL (symbol
);
5967 name
= SYMBOL_NAME (symbol
);
5969 for (i
= 0; i
+2 <= SBYTES (name
); )
5971 int this_mod_end
= 0;
5974 /* See if the name continues with a modifier word.
5975 Check that the word appears, but don't check what follows it.
5976 Set this_mod and this_mod_end to record what we find. */
5978 switch (SREF (name
, i
))
5980 #define SINGLE_LETTER_MOD(BIT) \
5981 (this_mod_end = i + 1, this_mod = BIT)
5984 SINGLE_LETTER_MOD (alt_modifier
);
5988 SINGLE_LETTER_MOD (ctrl_modifier
);
5992 SINGLE_LETTER_MOD (hyper_modifier
);
5996 SINGLE_LETTER_MOD (meta_modifier
);
6000 SINGLE_LETTER_MOD (shift_modifier
);
6004 SINGLE_LETTER_MOD (super_modifier
);
6007 #undef SINGLE_LETTER_MOD
6009 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6010 if (i + LEN + 1 <= SBYTES (name) \
6011 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6013 this_mod_end = i + LEN; \
6018 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6019 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6020 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6024 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6026 #undef MULTI_LETTER_MOD
6030 /* If we found no modifier, stop looking for them. */
6031 if (this_mod_end
== 0)
6034 /* Check there is a dash after the modifier, so that it
6035 really is a modifier. */
6036 if (this_mod_end
>= SBYTES (name
)
6037 || SREF (name
, this_mod_end
) != '-')
6040 /* This modifier is real; look for another. */
6041 modifiers
|= this_mod
;
6042 i
= this_mod_end
+ 1;
6045 /* Should we include the `click' modifier? */
6046 if (! (modifiers
& (down_modifier
| drag_modifier
6047 | double_modifier
| triple_modifier
))
6048 && i
+ 7 == SBYTES (name
)
6049 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6050 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6051 modifiers
|= click_modifier
;
6059 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6060 prepended to the string BASE[0..BASE_LEN-1].
6061 This doesn't use any caches. */
6063 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6066 int base_len
, base_len_byte
;
6068 /* Since BASE could contain nulls, we can't use intern here; we have
6069 to use Fintern, which expects a genuine Lisp_String, and keeps a
6072 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6078 /* Only the event queue may use the `up' modifier; it should always
6079 be turned into a click or drag event before presented to lisp code. */
6080 if (modifiers
& up_modifier
)
6083 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6084 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6085 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6086 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6087 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6088 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6089 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6090 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6091 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6092 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6093 /* The click modifier is denoted by the absence of other modifiers. */
6097 mod_len
= p
- new_mods
;
6101 Lisp_Object new_name
;
6103 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6104 mod_len
+ base_len_byte
);
6105 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6106 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6108 return Fintern (new_name
, Qnil
);
6113 static char *modifier_names
[] =
6115 "up", "down", "drag", "click", "double", "triple", 0, 0,
6116 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6117 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6119 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6121 static Lisp_Object modifier_symbols
;
6123 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6125 lispy_modifier_list (modifiers
)
6128 Lisp_Object modifier_list
;
6131 modifier_list
= Qnil
;
6132 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6133 if (modifiers
& (1<<i
))
6134 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6137 return modifier_list
;
6141 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6142 where UNMODIFIED is the unmodified form of SYMBOL,
6143 MASK is the set of modifiers present in SYMBOL's name.
6144 This is similar to parse_modifiers_uncached, but uses the cache in
6145 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6146 Qevent_symbol_elements property. */
6149 parse_modifiers (symbol
)
6152 Lisp_Object elements
;
6154 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6155 if (CONSP (elements
))
6160 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6161 Lisp_Object unmodified
;
6164 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6165 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6168 if (modifiers
& ~INTMASK
)
6170 XSETFASTINT (mask
, modifiers
);
6171 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6173 /* Cache the parsing results on SYMBOL. */
6174 Fput (symbol
, Qevent_symbol_element_mask
,
6176 Fput (symbol
, Qevent_symbol_elements
,
6177 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6179 /* Since we know that SYMBOL is modifiers applied to unmodified,
6180 it would be nice to put that in unmodified's cache.
6181 But we can't, since we're not sure that parse_modifiers is
6188 /* Apply the modifiers MODIFIERS to the symbol BASE.
6189 BASE must be unmodified.
6191 This is like apply_modifiers_uncached, but uses BASE's
6192 Qmodifier_cache property, if present. It also builds
6193 Qevent_symbol_elements properties, since it has that info anyway.
6195 apply_modifiers copies the value of BASE's Qevent_kind property to
6196 the modified symbol. */
6198 apply_modifiers (modifiers
, base
)
6202 Lisp_Object cache
, index
, entry
, new_symbol
;
6204 /* Mask out upper bits. We don't know where this value's been. */
6205 modifiers
&= INTMASK
;
6207 /* The click modifier never figures into cache indices. */
6208 cache
= Fget (base
, Qmodifier_cache
);
6209 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6210 entry
= assq_no_quit (index
, cache
);
6213 new_symbol
= XCDR (entry
);
6216 /* We have to create the symbol ourselves. */
6217 new_symbol
= apply_modifiers_uncached (modifiers
,
6218 SDATA (SYMBOL_NAME (base
)),
6219 SCHARS (SYMBOL_NAME (base
)),
6220 SBYTES (SYMBOL_NAME (base
)));
6222 /* Add the new symbol to the base's cache. */
6223 entry
= Fcons (index
, new_symbol
);
6224 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6226 /* We have the parsing info now for free, so we could add it to
6228 XSETFASTINT (index, modifiers);
6229 Fput (new_symbol, Qevent_symbol_element_mask,
6230 Fcons (base, Fcons (index, Qnil)));
6231 Fput (new_symbol, Qevent_symbol_elements,
6232 Fcons (base, lispy_modifier_list (modifiers)));
6233 Sadly, this is only correct if `base' is indeed a base event,
6234 which is not necessarily the case. -stef */
6237 /* Make sure this symbol is of the same kind as BASE.
6239 You'd think we could just set this once and for all when we
6240 intern the symbol above, but reorder_modifiers may call us when
6241 BASE's property isn't set right; we can't assume that just
6242 because it has a Qmodifier_cache property it must have its
6243 Qevent_kind set right as well. */
6244 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6248 kind
= Fget (base
, Qevent_kind
);
6250 Fput (new_symbol
, Qevent_kind
, kind
);
6257 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6258 return a symbol with the modifiers placed in the canonical order.
6259 Canonical order is alphabetical, except for down and drag, which
6260 always come last. The 'click' modifier is never written out.
6262 Fdefine_key calls this to make sure that (for example) C-M-foo
6263 and M-C-foo end up being equivalent in the keymap. */
6266 reorder_modifiers (symbol
)
6269 /* It's hopefully okay to write the code this way, since everything
6270 will soon be in caches, and no consing will be done at all. */
6273 parsed
= parse_modifiers (symbol
);
6274 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6279 /* For handling events, we often want to produce a symbol whose name
6280 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6281 to some base, like the name of a function key or mouse button.
6282 modify_event_symbol produces symbols of this sort.
6284 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6285 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6288 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6289 into symbol names, or a string specifying a name stem used to
6290 construct a symbol name or the form `STEM-N', where N is the decimal
6291 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6292 non-nil; otherwise NAME_TABLE is used.
6294 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6295 persist between calls to modify_event_symbol that it can use to
6296 store a cache of the symbols it's generated for this NAME_TABLE
6297 before. The object stored there may be a vector or an alist.
6299 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6301 MODIFIERS is a set of modifier bits (as given in struct input_events)
6302 whose prefixes should be applied to the symbol name.
6304 SYMBOL_KIND is the value to be placed in the event_kind property of
6305 the returned symbol.
6307 The symbols we create are supposed to have an
6308 `event-symbol-elements' property, which lists the modifiers present
6309 in the symbol's name. */
6312 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6313 name_table
, symbol_table
, table_size
)
6316 Lisp_Object symbol_kind
;
6317 Lisp_Object name_alist_or_stem
;
6319 Lisp_Object
*symbol_table
;
6320 unsigned int table_size
;
6323 Lisp_Object symbol_int
;
6325 /* Get rid of the "vendor-specific" bit here. */
6326 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6328 /* Is this a request for a valid symbol? */
6329 if (symbol_num
< 0 || symbol_num
>= table_size
)
6332 if (CONSP (*symbol_table
))
6333 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6335 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6336 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6337 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6338 we've never used that symbol before. */
6341 if (! VECTORP (*symbol_table
)
6342 || XVECTOR (*symbol_table
)->size
!= table_size
)
6346 XSETFASTINT (size
, table_size
);
6347 *symbol_table
= Fmake_vector (size
, Qnil
);
6350 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6353 /* Have we already used this symbol before? */
6356 /* No; let's create it. */
6357 if (CONSP (name_alist_or_stem
))
6358 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6359 else if (STRINGP (name_alist_or_stem
))
6361 int len
= SBYTES (name_alist_or_stem
);
6362 char *buf
= (char *) alloca (len
+ 50);
6363 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6364 (long) XINT (symbol_int
) + 1);
6365 value
= intern (buf
);
6367 else if (name_table
!= 0 && name_table
[symbol_num
])
6368 value
= intern (name_table
[symbol_num
]);
6370 #ifdef HAVE_WINDOW_SYSTEM
6373 char *name
= x_get_keysym_name (symbol_num
);
6375 value
= intern (name
);
6382 sprintf (buf
, "key-%d", symbol_num
);
6383 value
= intern (buf
);
6386 if (CONSP (*symbol_table
))
6387 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6389 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6391 /* Fill in the cache entries for this symbol; this also
6392 builds the Qevent_symbol_elements property, which the user
6394 apply_modifiers (modifiers
& click_modifier
, value
);
6395 Fput (value
, Qevent_kind
, symbol_kind
);
6398 /* Apply modifiers to that symbol. */
6399 return apply_modifiers (modifiers
, value
);
6402 /* Convert a list that represents an event type,
6403 such as (ctrl meta backspace), into the usual representation of that
6404 event type as a number or a symbol. */
6406 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6407 doc
: /* Convert the event description list EVENT-DESC to an event type.
6408 EVENT-DESC should contain one base event type (a character or symbol)
6409 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6410 drag, down, double or triple). The base must be last.
6411 The return value is an event type (a character or symbol) which
6412 has the same base event type and all the specified modifiers. */)
6414 Lisp_Object event_desc
;
6422 while (CONSP (rest
))
6430 /* Given a symbol, see if it is a modifier name. */
6431 if (SYMBOLP (elt
) && CONSP (rest
))
6432 this = parse_solitary_modifier (elt
);
6436 else if (!NILP (base
))
6437 error ("Two bases given in one event");
6443 /* Let the symbol A refer to the character A. */
6444 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6445 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6447 if (INTEGERP (base
))
6449 /* Turn (shift a) into A. */
6450 if ((modifiers
& shift_modifier
) != 0
6451 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6453 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6454 modifiers
&= ~shift_modifier
;
6457 /* Turn (control a) into C-a. */
6458 if (modifiers
& ctrl_modifier
)
6459 return make_number ((modifiers
& ~ctrl_modifier
)
6460 | make_ctrl_char (XINT (base
)));
6462 return make_number (modifiers
| XINT (base
));
6464 else if (SYMBOLP (base
))
6465 return apply_modifiers (modifiers
, base
);
6468 error ("Invalid base event");
6473 /* Try to recognize SYMBOL as a modifier name.
6474 Return the modifier flag bit, or 0 if not recognized. */
6477 parse_solitary_modifier (symbol
)
6480 Lisp_Object name
= SYMBOL_NAME (symbol
);
6482 switch (SREF (name
, 0))
6484 #define SINGLE_LETTER_MOD(BIT) \
6485 if (SBYTES (name) == 1) \
6488 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6489 if (LEN == SBYTES (name) \
6490 && ! strncmp (SDATA (name), NAME, LEN)) \
6494 SINGLE_LETTER_MOD (alt_modifier
);
6498 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6502 SINGLE_LETTER_MOD (ctrl_modifier
);
6506 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6507 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6511 SINGLE_LETTER_MOD (hyper_modifier
);
6515 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6519 SINGLE_LETTER_MOD (meta_modifier
);
6523 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6527 SINGLE_LETTER_MOD (shift_modifier
);
6531 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6532 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6533 SINGLE_LETTER_MOD (super_modifier
);
6537 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6538 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6539 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6543 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6546 #undef SINGLE_LETTER_MOD
6547 #undef MULTI_LETTER_MOD
6553 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6554 Such a list is not valid as an event,
6555 but it can be a Lucid-style event type list. */
6558 lucid_event_type_list_p (object
)
6563 if (! CONSP (object
))
6566 if (EQ (XCAR (object
), Qhelp_echo
)
6567 || EQ (XCAR (object
), Qvertical_line
)
6568 || EQ (XCAR (object
), Qmode_line
)
6569 || EQ (XCAR (object
), Qheader_line
))
6572 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6576 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6583 /* Store into *addr a value nonzero if terminal input chars are available.
6584 Serves the purpose of ioctl (0, FIONREAD, addr)
6585 but works even if FIONREAD does not exist.
6586 (In fact, this may actually read some input.)
6588 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6589 timer events that are ripe.
6590 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6591 events (FOCUS_IN_EVENT).
6592 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6593 movements and toolkit scroll bar thumb drags. */
6596 get_input_pending (addr
, flags
)
6600 /* First of all, have we already counted some input? */
6601 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6603 /* If input is being read as it arrives, and we have none, there is none. */
6604 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6607 /* Try to read some input and see how much we get. */
6609 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6612 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6615 gobble_input (expected
)
6620 if (interrupt_input
)
6623 mask
= sigblock (sigmask (SIGIO
));
6624 read_avail_input (expected
);
6628 #ifdef POLL_FOR_INPUT
6629 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6632 mask
= sigblock (sigmask (SIGALRM
));
6633 read_avail_input (expected
);
6639 read_avail_input (expected
);
6643 /* Put a BUFFER_SWITCH_EVENT in the buffer
6644 so that read_key_sequence will notice the new current buffer. */
6647 record_asynch_buffer_change ()
6649 struct input_event event
;
6653 event
.kind
= BUFFER_SWITCH_EVENT
;
6654 event
.frame_or_window
= Qnil
;
6658 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6659 The purpose of the event is to make read_key_sequence look up the
6660 keymaps again. If we aren't in read_key_sequence, we don't need one,
6661 and the event could cause trouble by messing up (input-pending-p). */
6662 tem
= Fwaiting_for_user_input_p ();
6666 /* We never need these events if we have no asynchronous subprocesses. */
6670 /* Make sure no interrupt happens while storing the event. */
6672 if (interrupt_input
)
6675 mask
= sigblock (sigmask (SIGIO
));
6676 kbd_buffer_store_event (&event
);
6683 kbd_buffer_store_event (&event
);
6690 /* Read any terminal input already buffered up by the system
6691 into the kbd_buffer, but do not wait.
6693 EXPECTED should be nonzero if the caller knows there is some input.
6695 Except on VMS, all input is read by this function.
6696 If interrupt_input is nonzero, this function MUST be called
6697 only when SIGIO is blocked.
6699 Returns the number of keyboard chars read, or -1 meaning
6700 this is a bad time to try to read input. */
6703 read_avail_input (expected
)
6709 if (read_socket_hook
)
6712 struct input_event hold_quit
;
6714 EVENT_INIT (hold_quit
);
6715 hold_quit
.kind
= NO_EVENT
;
6717 /* No need for FIONREAD or fcntl; just say don't wait. */
6718 while (nr
= (*read_socket_hook
) (input_fd
, expected
, &hold_quit
), nr
> 0)
6723 if (hold_quit
.kind
!= NO_EVENT
)
6724 kbd_buffer_store_event (&hold_quit
);
6728 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6729 the kbd_buffer can really hold. That may prevent loss
6730 of characters on some systems when input is stuffed at us. */
6731 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6734 /* Determine how many characters we should *try* to read. */
6737 #else /* not WINDOWSNT */
6739 n_to_read
= dos_keysns ();
6742 #else /* not MSDOS */
6744 /* Find out how much input is available. */
6745 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6746 /* Formerly simply reported no input, but that sometimes led to
6747 a failure of Emacs to terminate.
6748 SIGHUP seems appropriate if we can't reach the terminal. */
6749 /* ??? Is it really right to send the signal just to this process
6750 rather than to the whole process group?
6751 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6753 if (! noninteractive
)
6754 kill (getpid (), SIGHUP
);
6760 if (n_to_read
> sizeof cbuf
)
6761 n_to_read
= sizeof cbuf
;
6762 #else /* no FIONREAD */
6763 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6764 /* Read some input if available, but don't wait. */
6765 n_to_read
= sizeof cbuf
;
6766 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6771 #endif /* not MSDOS */
6772 #endif /* not WINDOWSNT */
6774 /* Now read; for one reason or another, this will not block.
6775 NREAD is set to the number of chars read. */
6779 cbuf
[0] = dos_keyread ();
6782 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6784 /* POSIX infers that processes which are not in the session leader's
6785 process group won't get SIGHUP's at logout time. BSDI adheres to
6786 this part standard and returns -1 from read (0) with errno==EIO
6787 when the control tty is taken away.
6788 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6789 if (nread
== -1 && errno
== EIO
)
6791 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6792 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6793 This looks incorrect, but it isn't, because _BSD causes
6794 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6795 and that causes a value other than 0 when there is no input. */
6801 /* We used to retry the read if it was interrupted.
6802 But this does the wrong thing when O_NDELAY causes
6803 an EAGAIN error. Does anybody know of a situation
6804 where a retry is actually needed? */
6806 nread
< 0 && (errno
== EAGAIN
6820 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6821 fcntl (input_fd
, F_SETFL
, 0);
6822 #endif /* USG or DGUX or CYGWIN */
6823 #endif /* no FIONREAD */
6824 for (i
= 0; i
< nread
; i
++)
6826 struct input_event buf
;
6828 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6830 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6831 buf
.modifiers
= meta_modifier
;
6836 buf
.frame_or_window
= selected_frame
;
6839 kbd_buffer_store_event (&buf
);
6840 /* Don't look at input that follows a C-g too closely.
6841 This reduces lossage due to autorepeat on C-g. */
6842 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6843 && buf
.code
== quit_char
)
6850 #endif /* not VMS */
6853 handle_async_input ()
6856 extern int select_alarmed
;
6859 interrupt_input_pending
= 0;
6864 nread
= read_avail_input (1);
6865 /* -1 means it's not ok to read the input now.
6866 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6867 0 means there was no keyboard input available. */
6872 select_alarmed
= 1; /* Force the select emulator back to life */
6877 #ifdef SIGIO /* for entire page */
6878 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6881 input_available_signal (signo
)
6884 /* Must preserve main program's value of errno. */
6885 int old_errno
= errno
;
6886 #if defined (USG) && !defined (POSIX_SIGNALS)
6887 /* USG systems forget handlers when they are used;
6888 must reestablish each time */
6889 signal (signo
, input_available_signal
);
6897 interrupt_input_pending
= 1;
6899 SIGNAL_THREAD_CHECK (signo
);
6902 if (input_available_clear_time
)
6903 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6906 handle_async_input ();
6916 /* Send ourselves a SIGIO.
6918 This function exists so that the UNBLOCK_INPUT macro in
6919 blockinput.h can have some way to take care of input we put off
6920 dealing with, without assuming that every file which uses
6921 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6923 reinvoke_input_signal ()
6926 handle_async_input ();
6932 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6933 static Lisp_Object menu_bar_one_keymap_changed_items
;
6935 /* These variables hold the vector under construction within
6936 menu_bar_items and its subroutines, and the current index
6937 for storing into that vector. */
6938 static Lisp_Object menu_bar_items_vector
;
6939 static int menu_bar_items_index
;
6941 /* Return a vector of menu items for a menu bar, appropriate
6942 to the current buffer. Each item has three elements in the vector:
6945 OLD is an old vector we can optionally reuse, or nil. */
6948 menu_bar_items (old
)
6951 /* The number of keymaps we're scanning right now, and the number of
6952 keymaps we have allocated space for. */
6955 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6956 in the current keymaps, or nil where it is not a prefix. */
6959 Lisp_Object def
, tail
;
6968 /* In order to build the menus, we need to call the keymap
6969 accessors. They all call QUIT. But this function is called
6970 during redisplay, during which a quit is fatal. So inhibit
6971 quitting while building the menus.
6972 We do this instead of specbind because (1) errors will clear it anyway
6973 and (2) this avoids risk of specpdl overflow. */
6974 oquit
= Vinhibit_quit
;
6978 menu_bar_items_vector
= old
;
6980 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6981 menu_bar_items_index
= 0;
6983 /* Build our list of keymaps.
6984 If we recognize a function key and replace its escape sequence in
6985 keybuf with its symbol, or if the sequence starts with a mouse
6986 click and we need to switch buffers, we jump back here to rebuild
6987 the initial keymaps from the current buffer. */
6991 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6992 if (!NILP (Voverriding_local_map_menu_flag
))
6994 /* Yes, use them (if non-nil) as well as the global map. */
6995 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6997 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6998 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6999 if (!NILP (Voverriding_local_map
))
7000 maps
[nmaps
++] = Voverriding_local_map
;
7004 /* No, so use major and minor mode keymaps and keymap property.
7005 Note that menu-bar bindings in the local-map and keymap
7006 properties may not work reliable, as they are only
7007 recognized when the menu-bar (or mode-line) is updated,
7008 which does not normally happen after every command. */
7011 nminor
= current_minor_maps (NULL
, &tmaps
);
7012 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7014 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7015 maps
[nmaps
++] = tem
;
7016 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7018 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7020 maps
[nmaps
++] = current_global_map
;
7023 /* Look up in each map the dummy prefix key `menu-bar'. */
7027 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7028 if (!NILP (maps
[mapno
]))
7030 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7034 menu_bar_one_keymap_changed_items
= Qnil
;
7035 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7039 /* Move to the end those items that should be at the end. */
7041 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7044 int end
= menu_bar_items_index
;
7046 for (i
= 0; i
< end
; i
+= 4)
7047 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7049 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7050 /* Move the item at index I to the end,
7051 shifting all the others forward. */
7052 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7053 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7054 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7055 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7057 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7058 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7059 (end
- i
- 4) * sizeof (Lisp_Object
));
7060 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7061 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7062 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7063 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7068 /* Add nil, nil, nil, nil at the end. */
7069 i
= menu_bar_items_index
;
7070 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7073 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7074 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7075 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7076 menu_bar_items_vector
= tem
;
7078 /* Add this item. */
7079 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7080 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7081 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7082 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7083 menu_bar_items_index
= i
;
7085 Vinhibit_quit
= oquit
;
7086 return menu_bar_items_vector
;
7089 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7090 If there's already an item for KEY, add this DEF to it. */
7092 Lisp_Object item_properties
;
7095 menu_bar_item (key
, item
, dummy1
, dummy2
)
7096 Lisp_Object key
, item
, dummy1
;
7099 struct gcpro gcpro1
;
7103 if (EQ (item
, Qundefined
))
7105 /* If a map has an explicit `undefined' as definition,
7106 discard any previously made menu bar item. */
7108 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7109 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7111 if (menu_bar_items_index
> i
+ 4)
7112 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7113 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7114 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7115 menu_bar_items_index
-= 4;
7119 /* If this keymap has already contributed to this KEY,
7120 don't contribute to it a second time. */
7121 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7122 if (!NILP (tem
) || NILP (item
))
7125 menu_bar_one_keymap_changed_items
7126 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7128 /* We add to menu_bar_one_keymap_changed_items before doing the
7129 parse_menu_item, so that if it turns out it wasn't a menu item,
7130 it still correctly hides any further menu item. */
7132 i
= parse_menu_item (item
, 0, 1);
7137 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7139 /* Find any existing item for this KEY. */
7140 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7141 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7144 /* If we did not find this KEY, add it at the end. */
7145 if (i
== menu_bar_items_index
)
7147 /* If vector is too small, get a bigger one. */
7148 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7151 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7152 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7153 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7154 menu_bar_items_vector
= tem
;
7157 /* Add this item. */
7158 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7159 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7160 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7161 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7162 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7163 menu_bar_items_index
= i
;
7165 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7169 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7170 /* If the new and the old items are not both keymaps,
7171 the lookup will only find `item'. */
7172 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7173 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7177 /* This is used as the handler when calling menu_item_eval_property. */
7179 menu_item_eval_property_1 (arg
)
7182 /* If we got a quit from within the menu computation,
7183 quit all the way out of it. This takes care of C-] in the debugger. */
7184 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7185 Fsignal (Qquit
, Qnil
);
7190 /* Evaluate an expression and return the result (or nil if something
7191 went wrong). Used to evaluate dynamic parts of menu items. */
7193 menu_item_eval_property (sexpr
)
7196 int count
= SPECPDL_INDEX ();
7198 specbind (Qinhibit_redisplay
, Qt
);
7199 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7200 menu_item_eval_property_1
);
7201 return unbind_to (count
, val
);
7204 /* This function parses a menu item and leaves the result in the
7205 vector item_properties.
7206 ITEM is a key binding, a possible menu item.
7207 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7208 evaluate dynamic expressions in the menu item.
7209 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7211 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7212 parse_menu_item returns true if the item is a menu item and false
7216 parse_menu_item (item
, notreal
, inmenubar
)
7218 int notreal
, inmenubar
;
7220 Lisp_Object def
, tem
, item_string
, start
;
7221 Lisp_Object cachelist
;
7223 Lisp_Object keyhint
;
7234 /* Create item_properties vector if necessary. */
7235 if (NILP (item_properties
))
7237 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7239 /* Initialize optional entries. */
7240 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7241 AREF (item_properties
, i
) = Qnil
;
7242 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7244 /* Save the item here to protect it from GC. */
7245 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7247 item_string
= XCAR (item
);
7251 if (STRINGP (item_string
))
7253 /* Old format menu item. */
7254 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7256 /* Maybe help string. */
7257 if (CONSP (item
) && STRINGP (XCAR (item
)))
7259 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7264 /* Maybe key binding cache. */
7265 if (CONSP (item
) && CONSP (XCAR (item
))
7266 && (NILP (XCAR (XCAR (item
)))
7267 || VECTORP (XCAR (XCAR (item
)))))
7269 cachelist
= XCAR (item
);
7273 /* This is the real definition--the function to run. */
7274 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7276 /* Get enable property, if any. */
7279 tem
= Fget (item
, Qmenu_enable
);
7280 if (!NILP (Venable_disabled_menus_and_buttons
))
7281 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7282 else if (!NILP (tem
))
7283 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7286 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7288 /* New format menu item. */
7289 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7290 start
= XCDR (item
);
7293 /* We have a real binding. */
7294 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7296 item
= XCDR (start
);
7297 /* Is there a cache list with key equivalences. */
7298 if (CONSP (item
) && CONSP (XCAR (item
)))
7300 cachelist
= XCAR (item
);
7304 /* Parse properties. */
7305 while (CONSP (item
) && CONSP (XCDR (item
)))
7310 if (EQ (tem
, QCenable
))
7312 if (!NILP (Venable_disabled_menus_and_buttons
))
7313 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7315 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7317 else if (EQ (tem
, QCvisible
) && !notreal
)
7319 /* If got a visible property and that evaluates to nil
7320 then ignore this item. */
7321 tem
= menu_item_eval_property (XCAR (item
));
7325 else if (EQ (tem
, QChelp
))
7326 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7327 else if (EQ (tem
, QCfilter
))
7329 else if (EQ (tem
, QCkey_sequence
))
7332 if (NILP (cachelist
)
7333 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7334 /* Be GC protected. Set keyhint to item instead of tem. */
7337 else if (EQ (tem
, QCkeys
))
7340 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7341 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7343 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7348 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7350 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7352 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7359 else if (inmenubar
|| !NILP (start
))
7363 return 0; /* not a menu item */
7365 /* If item string is not a string, evaluate it to get string.
7366 If we don't get a string, skip this item. */
7367 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7368 if (!(STRINGP (item_string
) || notreal
))
7370 item_string
= menu_item_eval_property (item_string
);
7371 if (!STRINGP (item_string
))
7373 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7376 /* If got a filter apply it on definition. */
7377 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7380 def
= menu_item_eval_property (list2 (XCAR (filter
),
7381 list2 (Qquote
, def
)));
7383 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7386 /* Enable or disable selection of item. */
7387 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7393 tem
= menu_item_eval_property (tem
);
7394 if (inmenubar
&& NILP (tem
))
7395 return 0; /* Ignore disabled items in menu bar. */
7396 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7399 /* If we got no definition, this item is just unselectable text which
7400 is OK in a submenu but not in the menubar. */
7402 return (inmenubar
? 0 : 1);
7404 /* See if this is a separate pane or a submenu. */
7405 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7406 tem
= get_keymap (def
, 0, 1);
7407 /* For a subkeymap, just record its details and exit. */
7410 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7411 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7415 /* At the top level in the menu bar, do likewise for commands also.
7416 The menu bar does not display equivalent key bindings anyway.
7417 ITEM_PROPERTY_DEF is already set up properly. */
7421 /* This is a command. See if there is an equivalent key binding. */
7422 if (NILP (cachelist
))
7424 /* We have to create a cachelist. */
7425 CHECK_IMPURE (start
);
7426 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7427 cachelist
= XCAR (XCDR (start
));
7429 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7430 if (!NILP (keyhint
))
7432 XSETCAR (cachelist
, XCAR (keyhint
));
7435 else if (STRINGP (tem
))
7437 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7438 XSETCAR (cachelist
, Qt
);
7442 tem
= XCAR (cachelist
);
7449 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7451 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7454 def
= XCAR (prefix
);
7455 prefix
= XCDR (prefix
);
7458 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7460 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7462 if (newcache
/* Always check first time. */
7463 /* Should we check everything when precomputing key
7465 /* If something had no key binding before, don't recheck it
7466 because that is too slow--except if we have a list of
7467 rebound commands in Vdefine_key_rebound_commands, do
7468 recheck any command that appears in that list. */
7469 || (CONSP (Vdefine_key_rebound_commands
)
7470 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7473 /* We had a saved key. Is it still bound to the command? */
7476 /* If the command is an alias for another
7477 (such as lmenu.el set it up), check if the
7478 original command matches the cached command. */
7479 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7480 chkcache
= 1; /* Need to recompute key binding. */
7484 /* Recompute equivalent key binding. If the command is an alias
7485 for another (such as lmenu.el set it up), see if the original
7486 command name has equivalent keys. Otherwise look up the
7487 specified command itself. We don't try both, because that
7488 makes lmenu menus slow. */
7490 && SYMBOLP (XSYMBOL (def
)->function
)
7491 && ! NILP (Fget (def
, Qmenu_alias
)))
7492 def
= XSYMBOL (def
)->function
;
7493 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7494 XSETCAR (cachelist
, tem
);
7497 XSETCDR (cachelist
, Qnil
);
7501 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7503 tem
= XCAR (cachelist
);
7507 newcache
= chkcache
;
7510 tem
= Fkey_description (tem
, Qnil
);
7513 if (STRINGP (XCAR (prefix
)))
7514 tem
= concat2 (XCAR (prefix
), tem
);
7515 if (STRINGP (XCDR (prefix
)))
7516 tem
= concat2 (tem
, XCDR (prefix
));
7518 XSETCDR (cachelist
, tem
);
7522 tem
= XCDR (cachelist
);
7523 if (newcache
&& !NILP (tem
))
7525 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7526 XSETCDR (cachelist
, tem
);
7529 /* If we only want to precompute equivalent key bindings, stop here. */
7533 /* If we have an equivalent key binding, use that. */
7534 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7536 /* Include this when menu help is implemented.
7537 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7538 if (!(NILP (tem) || STRINGP (tem)))
7540 tem = menu_item_eval_property (tem);
7543 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7547 /* Handle radio buttons or toggle boxes. */
7548 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7550 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7551 = menu_item_eval_property (tem
);
7558 /***********************************************************************
7560 ***********************************************************************/
7562 /* A vector holding tool bar items while they are parsed in function
7563 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7566 static Lisp_Object tool_bar_items_vector
;
7568 /* A vector holding the result of parse_tool_bar_item. Layout is like
7569 the one for a single item in tool_bar_items_vector. */
7571 static Lisp_Object tool_bar_item_properties
;
7573 /* Next free index in tool_bar_items_vector. */
7575 static int ntool_bar_items
;
7577 /* The symbols `tool-bar', and `:image'. */
7579 extern Lisp_Object Qtool_bar
;
7580 Lisp_Object QCimage
;
7582 /* Function prototypes. */
7584 static void init_tool_bar_items
P_ ((Lisp_Object
));
7585 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7586 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7587 static void append_tool_bar_item
P_ ((void));
7590 /* Return a vector of tool bar items for keymaps currently in effect.
7591 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7592 tool bar items found. */
7595 tool_bar_items (reuse
, nitems
)
7606 /* In order to build the menus, we need to call the keymap
7607 accessors. They all call QUIT. But this function is called
7608 during redisplay, during which a quit is fatal. So inhibit
7609 quitting while building the menus. We do this instead of
7610 specbind because (1) errors will clear it anyway and (2) this
7611 avoids risk of specpdl overflow. */
7612 oquit
= Vinhibit_quit
;
7615 /* Initialize tool_bar_items_vector and protect it from GC. */
7616 init_tool_bar_items (reuse
);
7618 /* Build list of keymaps in maps. Set nmaps to the number of maps
7621 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7622 if (!NILP (Voverriding_local_map_menu_flag
))
7624 /* Yes, use them (if non-nil) as well as the global map. */
7625 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7627 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7628 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7629 if (!NILP (Voverriding_local_map
))
7630 maps
[nmaps
++] = Voverriding_local_map
;
7634 /* No, so use major and minor mode keymaps and keymap property.
7635 Note that tool-bar bindings in the local-map and keymap
7636 properties may not work reliable, as they are only
7637 recognized when the tool-bar (or mode-line) is updated,
7638 which does not normally happen after every command. */
7641 nminor
= current_minor_maps (NULL
, &tmaps
);
7642 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7644 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7645 maps
[nmaps
++] = tem
;
7646 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7648 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7651 /* Add global keymap at the end. */
7652 maps
[nmaps
++] = current_global_map
;
7654 /* Process maps in reverse order and look up in each map the prefix
7656 for (i
= nmaps
- 1; i
>= 0; --i
)
7657 if (!NILP (maps
[i
]))
7661 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7663 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7666 Vinhibit_quit
= oquit
;
7667 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7668 return tool_bar_items_vector
;
7672 /* Process the definition of KEY which is DEF. */
7675 process_tool_bar_item (key
, def
, data
, args
)
7676 Lisp_Object key
, def
, data
;
7680 extern Lisp_Object Qundefined
;
7681 struct gcpro gcpro1
, gcpro2
;
7683 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7687 if (EQ (def
, Qundefined
))
7689 /* If a map has an explicit `undefined' as definition,
7690 discard any previously made item. */
7691 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7693 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7695 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7697 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7698 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7699 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7700 * sizeof (Lisp_Object
)));
7701 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7706 else if (parse_tool_bar_item (key
, def
))
7707 /* Append a new tool bar item to tool_bar_items_vector. Accept
7708 more than one definition for the same key. */
7709 append_tool_bar_item ();
7715 /* Parse a tool bar item specification ITEM for key KEY and return the
7716 result in tool_bar_item_properties. Value is zero if ITEM is
7719 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7721 CAPTION is the caption of the item, If it's not a string, it is
7722 evaluated to get a string.
7724 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7725 as binding are currently ignored.
7727 The following properties are recognized:
7731 FORM is evaluated and specifies whether the tool bar item is
7732 enabled or disabled.
7736 FORM is evaluated and specifies whether the tool bar item is visible.
7738 - `:filter FUNCTION'
7740 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7741 result is stored as the new binding.
7743 - `:button (TYPE SELECTED)'
7745 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7746 and specifies whether the button is selected (pressed) or not.
7750 IMAGES is either a single image specification or a vector of four
7751 image specifications. See enum tool_bar_item_images.
7753 - `:help HELP-STRING'.
7755 Gives a help string to display for the tool bar item. */
7758 parse_tool_bar_item (key
, item
)
7759 Lisp_Object key
, item
;
7761 /* Access slot with index IDX of vector tool_bar_item_properties. */
7762 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7764 Lisp_Object filter
= Qnil
;
7765 Lisp_Object caption
;
7768 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7769 Rule out items that aren't lists, don't start with
7770 `menu-item' or whose rest following `tool-bar-item' is not a
7773 || !EQ (XCAR (item
), Qmenu_item
)
7774 || (item
= XCDR (item
),
7778 /* Create tool_bar_item_properties vector if necessary. Reset it to
7780 if (VECTORP (tool_bar_item_properties
))
7782 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7786 tool_bar_item_properties
7787 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7790 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7791 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7793 /* Get the caption of the item. If the caption is not a string,
7794 evaluate it to get a string. If we don't get a string, skip this
7796 caption
= XCAR (item
);
7797 if (!STRINGP (caption
))
7799 caption
= menu_item_eval_property (caption
);
7800 if (!STRINGP (caption
))
7803 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7805 /* Give up if rest following the caption is not a list. */
7810 /* Store the binding. */
7811 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7814 /* Ignore cached key binding, if any. */
7815 if (CONSP (item
) && CONSP (XCAR (item
)))
7818 /* Process the rest of the properties. */
7819 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7821 Lisp_Object key
, value
;
7824 value
= XCAR (XCDR (item
));
7826 if (EQ (key
, QCenable
))
7828 /* `:enable FORM'. */
7829 if (!NILP (Venable_disabled_menus_and_buttons
))
7830 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7832 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7834 else if (EQ (key
, QCvisible
))
7836 /* `:visible FORM'. If got a visible property and that
7837 evaluates to nil then ignore this item. */
7838 if (NILP (menu_item_eval_property (value
)))
7841 else if (EQ (key
, QChelp
))
7842 /* `:help HELP-STRING'. */
7843 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7844 else if (EQ (key
, QCfilter
))
7845 /* ':filter FORM'. */
7847 else if (EQ (key
, QCbutton
) && CONSP (value
))
7849 /* `:button (TYPE . SELECTED)'. */
7850 Lisp_Object type
, selected
;
7852 type
= XCAR (value
);
7853 selected
= XCDR (value
);
7854 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7856 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7857 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7860 else if (EQ (key
, QCimage
)
7862 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7863 /* Value is either a single image specification or a vector
7864 of 4 such specifications for the different button states. */
7865 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7868 /* If got a filter apply it on binding. */
7870 PROP (TOOL_BAR_ITEM_BINDING
)
7871 = menu_item_eval_property (list2 (filter
,
7873 PROP (TOOL_BAR_ITEM_BINDING
))));
7875 /* See if the binding is a keymap. Give up if it is. */
7876 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7879 /* Enable or disable selection of item. */
7880 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7881 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7882 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7884 /* Handle radio buttons or toggle boxes. */
7885 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7886 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7887 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7895 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7896 that can be reused. */
7899 init_tool_bar_items (reuse
)
7902 if (VECTORP (reuse
))
7903 tool_bar_items_vector
= reuse
;
7905 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7906 ntool_bar_items
= 0;
7910 /* Append parsed tool bar item properties from
7911 tool_bar_item_properties */
7914 append_tool_bar_item ()
7916 Lisp_Object
*to
, *from
;
7918 /* Enlarge tool_bar_items_vector if necessary. */
7919 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7920 >= XVECTOR (tool_bar_items_vector
)->size
)
7922 Lisp_Object new_vector
;
7923 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7925 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7926 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7927 XVECTOR (new_vector
)->contents
,
7928 old_size
* sizeof (Lisp_Object
));
7929 tool_bar_items_vector
= new_vector
;
7932 /* Append entries from tool_bar_item_properties to the end of
7933 tool_bar_items_vector. */
7934 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7935 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7936 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7937 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7944 /* Read a character using menus based on maps in the array MAPS.
7945 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7946 Return t if we displayed a menu but the user rejected it.
7948 PREV_EVENT is the previous input event, or nil if we are reading
7949 the first event of a key sequence.
7951 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7952 if we used a mouse menu to read the input, or zero otherwise. If
7953 USED_MOUSE_MENU is null, we don't dereference it.
7955 The prompting is done based on the prompt-string of the map
7956 and the strings associated with various map elements.
7958 This can be done with X menus or with menus put in the minibuf.
7959 These are done in different ways, depending on how the input will be read.
7960 Menus using X are done after auto-saving in read-char, getting the input
7961 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7962 and do auto-saving in the inner call of read_char. */
7965 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7968 Lisp_Object prev_event
;
7969 int *used_mouse_menu
;
7972 register Lisp_Object name
= Qnil
;
7974 if (used_mouse_menu
)
7975 *used_mouse_menu
= 0;
7977 /* Use local over global Menu maps */
7979 if (! menu_prompting
)
7982 /* Optionally disregard all but the global map. */
7983 if (inhibit_local_menu_bar_menus
)
7985 maps
+= (nmaps
- 1);
7989 /* Get the menu name from the first map that has one (a prompt string). */
7990 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7992 name
= Fkeymap_prompt (maps
[mapno
]);
7997 /* If we don't have any menus, just read a character normally. */
7998 if (!STRINGP (name
))
8002 /* If we got to this point via a mouse click,
8003 use a real menu for mouse selection. */
8004 if (EVENT_HAS_PARAMETERS (prev_event
)
8005 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8006 && !EQ (XCAR (prev_event
), Qtool_bar
))
8008 /* Display the menu and get the selection. */
8009 Lisp_Object
*realmaps
8010 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8014 /* Use the maps that are not nil. */
8015 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8016 if (!NILP (maps
[mapno
]))
8017 realmaps
[nmaps1
++] = maps
[mapno
];
8019 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8024 record_menu_key (XCAR (value
));
8026 /* If we got multiple events, unread all but
8028 There is no way to prevent those unread events
8029 from showing up later in last_nonmenu_event.
8030 So turn symbol and integer events into lists,
8031 to indicate that they came from a mouse menu,
8032 so that when present in last_nonmenu_event
8033 they won't confuse things. */
8034 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8036 record_menu_key (XCAR (tem
));
8037 if (SYMBOLP (XCAR (tem
))
8038 || INTEGERP (XCAR (tem
)))
8039 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8042 /* If we got more than one event, put all but the first
8043 onto this list to be read later.
8044 Return just the first event now. */
8045 Vunread_command_events
8046 = nconc2 (XCDR (value
), Vunread_command_events
);
8047 value
= XCAR (value
);
8049 else if (NILP (value
))
8051 if (used_mouse_menu
)
8052 *used_mouse_menu
= 1;
8055 #endif /* HAVE_MENUS */
8059 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8060 We make this bigger when necessary, and never free it. */
8061 static char *read_char_minibuf_menu_text
;
8062 /* Size of that buffer. */
8063 static int read_char_minibuf_menu_width
;
8066 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8072 register Lisp_Object name
;
8074 /* FIXME: Use the minibuffer's frame width. */
8075 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8078 Lisp_Object rest
, vector
;
8084 if (! menu_prompting
)
8087 /* Make sure we have a big enough buffer for the menu text. */
8088 if (read_char_minibuf_menu_text
== 0)
8090 read_char_minibuf_menu_width
= width
+ 4;
8091 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8093 else if (width
+ 4 > read_char_minibuf_menu_width
)
8095 read_char_minibuf_menu_width
= width
+ 4;
8096 read_char_minibuf_menu_text
8097 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8099 menu
= read_char_minibuf_menu_text
;
8101 /* Get the menu name from the first map that has one (a prompt string). */
8102 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8104 name
= Fkeymap_prompt (maps
[mapno
]);
8109 /* If we don't have any menus, just read a character normally. */
8110 if (!STRINGP (name
))
8113 /* Prompt string always starts with map's prompt, and a space. */
8114 strcpy (menu
, SDATA (name
));
8115 nlength
= SBYTES (name
);
8116 menu
[nlength
++] = ':';
8117 menu
[nlength
++] = ' ';
8120 /* Start prompting at start of first map. */
8124 /* Present the documented bindings, a line at a time. */
8131 Lisp_Object orig_defn_macro
;
8133 /* Loop over elements of map. */
8138 /* If reached end of map, start at beginning of next map. */
8142 /* At end of last map, wrap around to first map if just starting,
8143 or end this line if already have something on it. */
8147 if (notfirst
|| nobindings
) break;
8152 /* Look at the next element of the map. */
8154 elt
= XVECTOR (vector
)->contents
[idx
];
8156 elt
= Fcar_safe (rest
);
8158 if (idx
< 0 && VECTORP (elt
))
8160 /* If we found a dense table in the keymap,
8161 advanced past it, but start scanning its contents. */
8162 rest
= Fcdr_safe (rest
);
8168 /* An ordinary element. */
8169 Lisp_Object event
, tem
;
8173 event
= Fcar_safe (elt
); /* alist */
8174 elt
= Fcdr_safe (elt
);
8178 XSETINT (event
, idx
); /* vector */
8181 /* Ignore the element if it has no prompt string. */
8182 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8184 /* 1 if the char to type matches the string. */
8186 Lisp_Object upcased_event
, downcased_event
;
8187 Lisp_Object desc
= Qnil
;
8189 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8191 upcased_event
= Fupcase (event
);
8192 downcased_event
= Fdowncase (event
);
8193 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8194 || XINT (downcased_event
) == SREF (s
, 0));
8196 desc
= Fsingle_key_description (event
, Qnil
);
8198 #if 0 /* It is redundant to list the equivalent key bindings because
8199 the prefix is what the user has already typed. */
8201 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8203 /* Insert equivalent keybinding. */
8204 s
= concat2 (s
, tem
);
8207 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8208 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8210 /* Insert button prefix. */
8211 Lisp_Object selected
8212 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8213 if (EQ (tem
, QCradio
))
8214 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8216 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8217 s
= concat2 (tem
, s
);
8221 /* If we have room for the prompt string, add it to this line.
8222 If this is the first on the line, always add it. */
8223 if ((SCHARS (s
) + i
+ 2
8224 + (char_matches
? 0 : SCHARS (desc
) + 3))
8230 /* Punctuate between strings. */
8233 strcpy (menu
+ i
, ", ");
8239 /* If the char to type doesn't match the string's
8240 first char, explicitly show what char to type. */
8243 /* Add as much of string as fits. */
8244 thiswidth
= SCHARS (desc
);
8245 if (thiswidth
+ i
> width
)
8246 thiswidth
= width
- i
;
8247 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8249 strcpy (menu
+ i
, " = ");
8253 /* Add as much of string as fits. */
8254 thiswidth
= SCHARS (s
);
8255 if (thiswidth
+ i
> width
)
8256 thiswidth
= width
- i
;
8257 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8263 /* If this element does not fit, end the line now,
8264 and save the element for the next line. */
8265 strcpy (menu
+ i
, "...");
8270 /* Move past this element. */
8271 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8272 /* Handle reaching end of dense table. */
8277 rest
= Fcdr_safe (rest
);
8281 /* Prompt with that and read response. */
8282 message2_nolog (menu
, strlen (menu
),
8283 ! NILP (current_buffer
->enable_multibyte_characters
));
8285 /* Make believe its not a keyboard macro in case the help char
8286 is pressed. Help characters are not recorded because menu prompting
8287 is not used on replay.
8289 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8290 current_kboard
->defining_kbd_macro
= Qnil
;
8292 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8293 while (BUFFERP (obj
));
8294 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8296 if (!INTEGERP (obj
))
8301 if (! EQ (obj
, menu_prompt_more_char
)
8302 && (!INTEGERP (menu_prompt_more_char
)
8303 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8305 if (!NILP (current_kboard
->defining_kbd_macro
))
8306 store_kbd_macro_char (obj
);
8309 /* Help char - go round again */
8313 /* Reading key sequences. */
8315 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8316 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8317 keymap, or nil otherwise. Return the index of the first keymap in
8318 which KEY has any binding, or NMAPS if no map has a binding.
8320 If KEY is a meta ASCII character, treat it like meta-prefix-char
8321 followed by the corresponding non-meta character. Keymaps in
8322 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8325 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8328 NEXT may be the same array as CURRENT. */
8331 follow_key (key
, nmaps
, current
, defs
, next
)
8333 Lisp_Object
*current
, *defs
, *next
;
8336 int i
, first_binding
;
8338 first_binding
= nmaps
;
8339 for (i
= nmaps
- 1; i
>= 0; i
--)
8341 if (! NILP (current
[i
]))
8343 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8344 if (! NILP (defs
[i
]))
8351 /* Given the set of bindings we've found, produce the next set of maps. */
8352 if (first_binding
< nmaps
)
8353 for (i
= 0; i
< nmaps
; i
++)
8354 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8356 return first_binding
;
8359 /* Structure used to keep track of partial application of key remapping
8360 such as Vfunction_key_map and Vkey_translation_map. */
8361 typedef struct keyremap
8363 Lisp_Object map
, parent
;
8367 /* Lookup KEY in MAP.
8368 MAP is a keymap mapping keys to key vectors or functions.
8369 If the mapping is a function and DO_FUNCTION is non-zero, then
8370 the function is called with PROMPT as parameter and its return
8371 value is used as the return value of this function (after checking
8372 that it is indeed a vector). */
8375 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8376 Lisp_Object map
, key
, prompt
;
8381 next
= access_keymap (map
, key
, 1, 0, 1);
8383 /* Handle symbol with autoload definition. */
8384 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8385 && CONSP (XSYMBOL (next
)->function
)
8386 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8387 do_autoload (XSYMBOL (next
)->function
, next
);
8389 /* Handle a symbol whose function definition is a keymap
8391 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8392 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8393 || KEYMAPP (XSYMBOL (next
)->function
)))
8394 next
= XSYMBOL (next
)->function
;
8396 /* If the keymap gives a function, not an
8397 array, then call the function with one arg and use
8398 its value instead. */
8399 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8404 next
= call1 (next
, prompt
);
8405 /* If the function returned something invalid,
8406 barf--don't ignore it.
8407 (To ignore it safely, we would need to gcpro a bunch of
8408 other variables.) */
8409 if (! (VECTORP (next
) || STRINGP (next
)))
8410 error ("Function %s returns invalid key sequence", tem
);
8415 /* Do one step of the key remapping used for function-key-map and
8416 key-translation-map:
8417 KEYBUF is the buffer holding the input events.
8418 BUFSIZE is its maximum size.
8419 FKEY is a pointer to the keyremap structure to use.
8420 INPUT is the index of the last element in KEYBUF.
8421 DOIT if non-zero says that the remapping can actually take place.
8422 DIFF is used to return the number of keys added/removed by the remapping.
8423 PARENT is the root of the keymap.
8424 PROMPT is the prompt to use if the remapping happens through a function.
8425 The return value is non-zero if the remapping actually took place. */
8428 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8429 Lisp_Object
*keybuf
, prompt
;
8431 int input
, doit
, *diff
, bufsize
;
8433 Lisp_Object next
, key
;
8435 key
= keybuf
[fkey
->end
++];
8436 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8438 /* If keybuf[fkey->start..fkey->end] is bound in the
8439 map and we're in a position to do the key remapping, replace it with
8440 the binding and restart with fkey->start at the end. */
8441 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8443 int len
= XFASTINT (Flength (next
));
8446 *diff
= len
- (fkey
->end
- fkey
->start
);
8448 if (input
+ *diff
>= bufsize
)
8449 error ("Key sequence too long");
8451 /* Shift the keys that follow fkey->end. */
8453 for (i
= fkey
->end
; i
< input
; i
++)
8454 keybuf
[i
+ *diff
] = keybuf
[i
];
8456 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8457 keybuf
[i
+ *diff
] = keybuf
[i
];
8458 /* Overwrite the old keys with the new ones. */
8459 for (i
= 0; i
< len
; i
++)
8460 keybuf
[fkey
->start
+ i
]
8461 = Faref (next
, make_number (i
));
8463 fkey
->start
= fkey
->end
+= *diff
;
8464 fkey
->map
= fkey
->parent
;
8469 fkey
->map
= get_keymap (next
, 0, 1);
8471 /* If we no longer have a bound suffix, try a new position for
8473 if (!CONSP (fkey
->map
))
8475 fkey
->end
= ++fkey
->start
;
8476 fkey
->map
= fkey
->parent
;
8481 /* Read a sequence of keys that ends with a non prefix character,
8482 storing it in KEYBUF, a buffer of size BUFSIZE.
8484 Return the length of the key sequence stored.
8485 Return -1 if the user rejected a command menu.
8487 Echo starting immediately unless `prompt' is 0.
8489 Where a key sequence ends depends on the currently active keymaps.
8490 These include any minor mode keymaps active in the current buffer,
8491 the current buffer's local map, and the global map.
8493 If a key sequence has no other bindings, we check Vfunction_key_map
8494 to see if some trailing subsequence might be the beginning of a
8495 function key's sequence. If so, we try to read the whole function
8496 key, and substitute its symbolic name into the key sequence.
8498 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8499 `double-' events into similar click events, if that would make them
8500 bound. We try to turn `triple-' events first into `double-' events,
8503 If we get a mouse click in a mode line, vertical divider, or other
8504 non-text area, we treat the click as if it were prefixed by the
8505 symbol denoting that area - `mode-line', `vertical-line', or
8508 If the sequence starts with a mouse click, we read the key sequence
8509 with respect to the buffer clicked on, not the current buffer.
8511 If the user switches frames in the midst of a key sequence, we put
8512 off the switch-frame event until later; the next call to
8513 read_char will return it.
8515 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8516 from the selected window's buffer. */
8519 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8520 can_return_switch_frame
, fix_current_buffer
)
8521 Lisp_Object
*keybuf
;
8524 int dont_downcase_last
;
8525 int can_return_switch_frame
;
8526 int fix_current_buffer
;
8528 volatile Lisp_Object from_string
;
8529 volatile int count
= SPECPDL_INDEX ();
8531 /* How many keys there are in the current key sequence. */
8534 /* The length of the echo buffer when we started reading, and
8535 the length of this_command_keys when we started reading. */
8536 volatile int echo_start
;
8537 volatile int keys_start
;
8539 /* The number of keymaps we're scanning right now, and the number of
8540 keymaps we have allocated space for. */
8542 volatile int nmaps_allocated
= 0;
8544 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8545 the current keymaps. */
8546 Lisp_Object
*volatile defs
= NULL
;
8548 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8549 in the current keymaps, or nil where it is not a prefix. */
8550 Lisp_Object
*volatile submaps
= NULL
;
8552 /* The local map to start out with at start of key sequence. */
8553 volatile Lisp_Object orig_local_map
;
8555 /* The map from the `keymap' property to start out with at start of
8557 volatile Lisp_Object orig_keymap
;
8559 /* 1 if we have already considered switching to the local-map property
8560 of the place where a mouse click occurred. */
8561 volatile int localized_local_map
= 0;
8563 /* The index in defs[] of the first keymap that has a binding for
8564 this key sequence. In other words, the lowest i such that
8565 defs[i] is non-nil. */
8566 volatile int first_binding
;
8567 /* Index of the first key that has no binding.
8568 It is useless to try fkey.start larger than that. */
8569 volatile int first_unbound
;
8571 /* If t < mock_input, then KEYBUF[t] should be read as the next
8574 We use this to recover after recognizing a function key. Once we
8575 realize that a suffix of the current key sequence is actually a
8576 function key's escape sequence, we replace the suffix with the
8577 function key's binding from Vfunction_key_map. Now keybuf
8578 contains a new and different key sequence, so the echo area,
8579 this_command_keys, and the submaps and defs arrays are wrong. In
8580 this situation, we set mock_input to t, set t to 0, and jump to
8581 restart_sequence; the loop will read keys from keybuf up until
8582 mock_input, thus rebuilding the state; and then it will resume
8583 reading characters from the keyboard. */
8584 volatile int mock_input
= 0;
8586 /* If the sequence is unbound in submaps[], then
8587 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8588 and fkey.map is its binding.
8590 These might be > t, indicating that all function key scanning
8591 should hold off until t reaches them. We do this when we've just
8592 recognized a function key, to avoid searching for the function
8593 key's again in Vfunction_key_map. */
8594 volatile keyremap fkey
;
8596 /* Likewise, for key_translation_map. */
8597 volatile keyremap keytran
;
8599 /* If we receive a `switch-frame' or `select-window' event in the middle of
8600 a key sequence, we put it off for later.
8601 While we're reading, we keep the event here. */
8602 volatile Lisp_Object delayed_switch_frame
;
8604 /* See the comment below... */
8605 #if defined (GOBBLE_FIRST_EVENT)
8606 Lisp_Object first_event
;
8609 volatile Lisp_Object original_uppercase
;
8610 volatile int original_uppercase_position
= -1;
8612 /* Gets around Microsoft compiler limitations. */
8615 struct buffer
*starting_buffer
;
8617 /* List of events for which a fake prefix key has been generated. */
8618 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8620 #if defined (GOBBLE_FIRST_EVENT)
8624 struct gcpro gcpro1
;
8626 GCPRO1 (fake_prefixed_keys
);
8627 raw_keybuf_count
= 0;
8629 last_nonmenu_event
= Qnil
;
8631 delayed_switch_frame
= Qnil
;
8632 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8633 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8634 /* If there is no translation-map, turn off scanning. */
8635 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8636 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8641 echo_prompt (prompt
);
8642 else if (cursor_in_echo_area
8643 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8644 && NILP (Fzerop (Vecho_keystrokes
)))
8645 /* This doesn't put in a dash if the echo buffer is empty, so
8646 you don't always see a dash hanging out in the minibuffer. */
8650 /* Record the initial state of the echo area and this_command_keys;
8651 we will need to restore them if we replay a key sequence. */
8653 echo_start
= echo_length ();
8654 keys_start
= this_command_key_count
;
8655 this_single_command_key_start
= keys_start
;
8657 #if defined (GOBBLE_FIRST_EVENT)
8658 /* This doesn't quite work, because some of the things that read_char
8659 does cannot safely be bypassed. It seems too risky to try to make
8662 /* Read the first char of the sequence specially, before setting
8663 up any keymaps, in case a filter runs and switches buffers on us. */
8664 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8666 #endif /* GOBBLE_FIRST_EVENT */
8668 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8669 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8672 /* We jump here when the key sequence has been thoroughly changed, and
8673 we need to rescan it starting from the beginning. When we jump here,
8674 keybuf[0..mock_input] holds the sequence we should reread. */
8677 starting_buffer
= current_buffer
;
8678 first_unbound
= bufsize
+ 1;
8680 /* Build our list of keymaps.
8681 If we recognize a function key and replace its escape sequence in
8682 keybuf with its symbol, or if the sequence starts with a mouse
8683 click and we need to switch buffers, we jump back here to rebuild
8684 the initial keymaps from the current buffer. */
8687 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8688 || !NILP (Voverriding_local_map
))
8690 if (3 > nmaps_allocated
)
8692 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8693 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8694 nmaps_allocated
= 3;
8696 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8697 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8698 if (!NILP (Voverriding_local_map
))
8699 submaps
[nmaps
++] = Voverriding_local_map
;
8707 nminor
= current_minor_maps (0, &maps
);
8708 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8710 if (total
> nmaps_allocated
)
8712 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8713 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8714 nmaps_allocated
= total
;
8717 if (!NILP (orig_keymap
))
8718 submaps
[nmaps
++] = orig_keymap
;
8720 bcopy (maps
, (void *) (submaps
+ nmaps
),
8721 nminor
* sizeof (submaps
[0]));
8725 submaps
[nmaps
++] = orig_local_map
;
8727 submaps
[nmaps
++] = current_global_map
;
8729 /* Find an accurate initial value for first_binding. */
8730 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8731 if (! NILP (submaps
[first_binding
]))
8734 /* Start from the beginning in keybuf. */
8737 /* These are no-ops the first time through, but if we restart, they
8738 revert the echo area and this_command_keys to their original state. */
8739 this_command_key_count
= keys_start
;
8740 if (INTERACTIVE
&& t
< mock_input
)
8741 echo_truncate (echo_start
);
8743 /* If the best binding for the current key sequence is a keymap, or
8744 we may be looking at a function key's escape sequence, keep on
8746 while (first_binding
< nmaps
8747 /* Keep reading as long as there's a prefix binding. */
8748 ? !NILP (submaps
[first_binding
])
8749 /* Don't return in the middle of a possible function key sequence,
8750 if the only bindings we found were via case conversion.
8751 Thus, if ESC O a has a function-key-map translation
8752 and ESC o has a binding, don't return after ESC O,
8753 so that we can translate ESC O plus the next character. */
8754 : (fkey
.start
< t
|| keytran
.start
< t
))
8757 int used_mouse_menu
= 0;
8759 /* Where the last real key started. If we need to throw away a
8760 key that has expanded into more than one element of keybuf
8761 (say, a mouse click on the mode line which is being treated
8762 as [mode-line (mouse-...)], then we backtrack to this point
8764 volatile int last_real_key_start
;
8766 /* These variables are analogous to echo_start and keys_start;
8767 while those allow us to restart the entire key sequence,
8768 echo_local_start and keys_local_start allow us to throw away
8770 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8772 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8773 eassert (fkey
.start
<= fkey
.end
);
8774 eassert (keytran
.start
<= keytran
.end
);
8775 /* key-translation-map is applied *after* function-key-map. */
8776 eassert (keytran
.end
<= fkey
.start
);
8778 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8779 { /* The prefix upto first_unbound has no binding and has
8780 no translation left to do either, so we know it's unbound.
8781 If we don't stop now, we risk staying here indefinitely
8782 (if the user keeps entering fkey or keytran prefixes
8783 like C-c ESC ESC ESC ESC ...) */
8785 for (i
= first_unbound
+ 1; i
< t
; i
++)
8786 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8787 mock_input
= t
- first_unbound
- 1;
8788 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8789 fkey
.map
= fkey
.parent
;
8790 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8791 keytran
.map
= keytran
.parent
;
8792 goto replay_sequence
;
8796 error ("Key sequence too long");
8799 echo_local_start
= echo_length ();
8800 keys_local_start
= this_command_key_count
;
8801 local_first_binding
= first_binding
;
8804 /* These are no-ops, unless we throw away a keystroke below and
8805 jumped back up to replay_key; in that case, these restore the
8806 variables to their original state, allowing us to replay the
8808 if (INTERACTIVE
&& t
< mock_input
)
8809 echo_truncate (echo_local_start
);
8810 this_command_key_count
= keys_local_start
;
8811 first_binding
= local_first_binding
;
8813 /* By default, assume each event is "real". */
8814 last_real_key_start
= t
;
8816 /* Does mock_input indicate that we are re-reading a key sequence? */
8820 add_command_key (key
);
8821 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8822 && NILP (Fzerop (Vecho_keystrokes
)))
8826 /* If not, we should actually read a character. */
8831 KBOARD
*interrupted_kboard
= current_kboard
;
8832 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8833 if (setjmp (wrong_kboard_jmpbuf
))
8835 if (!NILP (delayed_switch_frame
))
8837 interrupted_kboard
->kbd_queue
8838 = Fcons (delayed_switch_frame
,
8839 interrupted_kboard
->kbd_queue
);
8840 delayed_switch_frame
= Qnil
;
8843 interrupted_kboard
->kbd_queue
8844 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8846 /* If the side queue is non-empty, ensure it begins with a
8847 switch-frame, so we'll replay it in the right context. */
8848 if (CONSP (interrupted_kboard
->kbd_queue
)
8849 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8850 !(EVENT_HAS_PARAMETERS (key
)
8851 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8855 XSETFRAME (frame
, interrupted_frame
);
8856 interrupted_kboard
->kbd_queue
8857 = Fcons (make_lispy_switch_frame (frame
),
8858 interrupted_kboard
->kbd_queue
);
8861 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8862 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8863 goto replay_sequence
;
8866 key
= read_char (NILP (prompt
), nmaps
,
8867 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8871 /* read_char returns t when it shows a menu and the user rejects it.
8875 unbind_to (count
, Qnil
);
8880 /* read_char returns -1 at the end of a macro.
8881 Emacs 18 handles this by returning immediately with a
8882 zero, so that's what we'll do. */
8883 if (INTEGERP (key
) && XINT (key
) == -1)
8886 /* The Microsoft C compiler can't handle the goto that
8892 /* If the current buffer has been changed from under us, the
8893 keymap may have changed, so replay the sequence. */
8896 timer_resume_idle ();
8899 /* Reset the current buffer from the selected window
8900 in case something changed the former and not the latter.
8901 This is to be more consistent with the behavior
8902 of the command_loop_1. */
8903 if (fix_current_buffer
)
8905 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8907 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8908 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8911 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8912 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8913 goto replay_sequence
;
8916 /* If we have a quit that was typed in another frame, and
8917 quit_throw_to_read_char switched buffers,
8918 replay to get the right keymap. */
8920 && XINT (key
) == quit_char
8921 && current_buffer
!= starting_buffer
)
8924 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8928 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8929 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8930 goto replay_sequence
;
8935 if (EVENT_HAS_PARAMETERS (key
)
8936 /* Either a `switch-frame' or a `select-window' event. */
8937 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8939 /* If we're at the beginning of a key sequence, and the caller
8940 says it's okay, go ahead and return this event. If we're
8941 in the midst of a key sequence, delay it until the end. */
8942 if (t
> 0 || !can_return_switch_frame
)
8944 delayed_switch_frame
= key
;
8950 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8953 /* Clicks in non-text areas get prefixed by the symbol
8954 in their CHAR-ADDRESS field. For example, a click on
8955 the mode line is prefixed by the symbol `mode-line'.
8957 Furthermore, key sequences beginning with mouse clicks
8958 are read using the keymaps of the buffer clicked on, not
8959 the current buffer. So we may have to switch the buffer
8962 When we turn one event into two events, we must make sure
8963 that neither of the two looks like the original--so that,
8964 if we replay the events, they won't be expanded again.
8965 If not for this, such reexpansion could happen either here
8966 or when user programs play with this-command-keys. */
8967 if (EVENT_HAS_PARAMETERS (key
))
8972 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8973 if (EQ (kind
, Qmouse_click
))
8975 Lisp_Object window
, posn
;
8977 window
= POSN_WINDOW (EVENT_START (key
));
8978 posn
= POSN_POSN (EVENT_START (key
));
8981 || (!NILP (fake_prefixed_keys
)
8982 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8984 /* We're looking a second time at an event for which
8985 we generated a fake prefix key. Set
8986 last_real_key_start appropriately. */
8988 last_real_key_start
= t
- 1;
8991 /* Key sequences beginning with mouse clicks are
8992 read using the keymaps in the buffer clicked on,
8993 not the current buffer. If we're at the
8994 beginning of a key sequence, switch buffers. */
8995 if (last_real_key_start
== 0
8997 && BUFFERP (XWINDOW (window
)->buffer
)
8998 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9000 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9004 /* Arrange to go back to the original buffer once we're
9005 done reading the key sequence. Note that we can't
9006 use save_excursion_{save,restore} here, because they
9007 save point as well as the current buffer; we don't
9008 want to save point, because redisplay may change it,
9009 to accommodate a Fset_window_start or something. We
9010 don't want to do this at the top of the function,
9011 because we may get input from a subprocess which
9012 wants to change the selected window and stuff (say,
9014 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9016 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9018 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9019 orig_local_map
= get_local_map (PT
, current_buffer
,
9021 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9022 goto replay_sequence
;
9025 /* For a mouse click, get the local text-property keymap
9026 of the place clicked on, rather than point. */
9027 if (last_real_key_start
== 0
9028 && CONSP (XCDR (key
))
9029 && ! localized_local_map
)
9031 Lisp_Object map_here
, start
, pos
;
9033 localized_local_map
= 1;
9034 start
= EVENT_START (key
);
9036 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9038 pos
= POSN_BUFFER_POSN (start
);
9040 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9042 map_here
= get_local_map (XINT (pos
),
9043 current_buffer
, Qlocal_map
);
9044 if (!EQ (map_here
, orig_local_map
))
9046 orig_local_map
= map_here
;
9050 goto replay_sequence
;
9052 map_here
= get_local_map (XINT (pos
),
9053 current_buffer
, Qkeymap
);
9054 if (!EQ (map_here
, orig_keymap
))
9056 orig_keymap
= map_here
;
9060 goto replay_sequence
;
9066 /* Expand mode-line and scroll-bar events into two events:
9067 use posn as a fake prefix key. */
9069 && (NILP (fake_prefixed_keys
)
9070 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9072 if (t
+ 1 >= bufsize
)
9073 error ("Key sequence too long");
9076 keybuf
[t
+ 1] = key
;
9079 /* Record that a fake prefix key has been generated
9080 for KEY. Don't modify the event; this would
9081 prevent proper action when the event is pushed
9082 back into unread-command-events. */
9083 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9085 /* If on a mode line string with a local keymap,
9086 reconsider the key sequence with that keymap. */
9087 if (string
= POSN_STRING (EVENT_START (key
)),
9088 (CONSP (string
) && STRINGP (XCAR (string
))))
9090 Lisp_Object pos
, map
, map2
;
9092 pos
= XCDR (string
);
9093 string
= XCAR (string
);
9095 && XINT (pos
) < SCHARS (string
))
9097 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9099 orig_local_map
= map
;
9100 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9103 if (!NILP (map
) || !NILP (map2
))
9104 goto replay_sequence
;
9110 else if (NILP (from_string
)
9111 && (string
= POSN_STRING (EVENT_START (key
)),
9112 (CONSP (string
) && STRINGP (XCAR (string
)))))
9114 /* For a click on a string, i.e. overlay string or a
9115 string displayed via the `display' property,
9116 consider `local-map' and `keymap' properties of
9118 Lisp_Object pos
, map
, map2
;
9120 pos
= XCDR (string
);
9121 string
= XCAR (string
);
9123 && XINT (pos
) < SCHARS (string
))
9125 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9127 orig_local_map
= map
;
9128 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9132 if (!NILP (map
) || !NILP (map2
))
9134 from_string
= string
;
9135 goto replay_sequence
;
9140 else if (CONSP (XCDR (key
))
9141 && CONSP (EVENT_START (key
))
9142 && CONSP (XCDR (EVENT_START (key
))))
9146 posn
= POSN_POSN (EVENT_START (key
));
9147 /* Handle menu-bar events:
9148 insert the dummy prefix event `menu-bar'. */
9149 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9151 if (t
+ 1 >= bufsize
)
9152 error ("Key sequence too long");
9156 /* Zap the position in key, so we know that we've
9157 expanded it, and don't try to do so again. */
9158 POSN_SET_POSN (EVENT_START (key
),
9159 Fcons (posn
, Qnil
));
9162 goto replay_sequence
;
9164 else if (CONSP (posn
))
9166 /* We're looking at the second event of a
9167 sequence which we expanded before. Set
9168 last_real_key_start appropriately. */
9169 if (last_real_key_start
== t
&& t
> 0)
9170 last_real_key_start
= t
- 1;
9175 /* We have finally decided that KEY is something we might want
9177 first_binding
= (follow_key (key
,
9178 nmaps
- first_binding
,
9179 submaps
+ first_binding
,
9180 defs
+ first_binding
,
9181 submaps
+ first_binding
)
9184 /* If KEY wasn't bound, we'll try some fallbacks. */
9185 if (first_binding
< nmaps
)
9186 /* This is needed for the following scenario:
9187 event 0: a down-event that gets dropped by calling replay_key.
9188 event 1: some normal prefix like C-h.
9189 After event 0, first_unbound is 0, after event 1 fkey.start
9190 and keytran.start are both 1, so when we see that C-h is bound,
9191 we need to update first_unbound. */
9192 first_unbound
= max (t
+ 1, first_unbound
);
9197 /* Remember the position to put an upper bound on fkey.start. */
9198 first_unbound
= min (t
, first_unbound
);
9200 head
= EVENT_HEAD (key
);
9201 if (help_char_p (head
) && t
> 0)
9203 read_key_sequence_cmd
= Vprefix_help_command
;
9205 last_nonmenu_event
= key
;
9206 /* The Microsoft C compiler can't handle the goto that
9214 Lisp_Object breakdown
;
9217 breakdown
= parse_modifiers (head
);
9218 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9219 /* Attempt to reduce an unbound mouse event to a simpler
9220 event that is bound:
9221 Drags reduce to clicks.
9222 Double-clicks reduce to clicks.
9223 Triple-clicks reduce to double-clicks, then to clicks.
9224 Down-clicks are eliminated.
9225 Double-downs reduce to downs, then are eliminated.
9226 Triple-downs reduce to double-downs, then to downs,
9227 then are eliminated. */
9228 if (modifiers
& (down_modifier
| drag_modifier
9229 | double_modifier
| triple_modifier
))
9231 while (modifiers
& (down_modifier
| drag_modifier
9232 | double_modifier
| triple_modifier
))
9234 Lisp_Object new_head
, new_click
;
9235 if (modifiers
& triple_modifier
)
9236 modifiers
^= (double_modifier
| triple_modifier
);
9237 else if (modifiers
& double_modifier
)
9238 modifiers
&= ~double_modifier
;
9239 else if (modifiers
& drag_modifier
)
9240 modifiers
&= ~drag_modifier
;
9243 /* Dispose of this `down' event by simply jumping
9244 back to replay_key, to get another event.
9246 Note that if this event came from mock input,
9247 then just jumping back to replay_key will just
9248 hand it to us again. So we have to wipe out any
9251 We could delete keybuf[t] and shift everything
9252 after that to the left by one spot, but we'd also
9253 have to fix up any variable that points into
9254 keybuf, and shifting isn't really necessary
9257 Adding prefixes for non-textual mouse clicks
9258 creates two characters of mock input, and both
9259 must be thrown away. If we're only looking at
9260 the prefix now, we can just jump back to
9261 replay_key. On the other hand, if we've already
9262 processed the prefix, and now the actual click
9263 itself is giving us trouble, then we've lost the
9264 state of the keymaps we want to backtrack to, and
9265 we need to replay the whole sequence to rebuild
9268 Beyond that, only function key expansion could
9269 create more than two keys, but that should never
9270 generate mouse events, so it's okay to zero
9271 mock_input in that case too.
9273 FIXME: The above paragraph seems just plain
9274 wrong, if you consider things like
9275 xterm-mouse-mode. -stef
9277 Isn't this just the most wonderful code ever? */
9279 /* If mock_input > t + 1, the above simplification
9280 will actually end up dropping keys on the floor.
9281 This is probably OK for now, but even
9282 if mock_input <= t + 1, we need to adjust fkey
9284 Typical case [header-line down-mouse-N]:
9285 mock_input = 2, t = 1, fkey.end = 1,
9286 last_real_key_start = 0. */
9287 if (fkey
.end
> last_real_key_start
)
9289 fkey
.end
= fkey
.start
9290 = min (last_real_key_start
, fkey
.start
);
9291 fkey
.map
= fkey
.parent
;
9292 if (keytran
.end
> last_real_key_start
)
9294 keytran
.end
= keytran
.start
9295 = min (last_real_key_start
, keytran
.start
);
9296 keytran
.map
= keytran
.parent
;
9299 if (t
== last_real_key_start
)
9306 mock_input
= last_real_key_start
;
9307 goto replay_sequence
;
9312 = apply_modifiers (modifiers
, XCAR (breakdown
));
9314 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9316 /* Look for a binding for this new key. follow_key
9317 promises that it didn't munge submaps the
9318 last time we called it, since key was unbound. */
9320 = (follow_key (new_click
,
9321 nmaps
- local_first_binding
,
9322 submaps
+ local_first_binding
,
9323 defs
+ local_first_binding
,
9324 submaps
+ local_first_binding
)
9325 + local_first_binding
);
9327 /* If that click is bound, go for it. */
9328 if (first_binding
< nmaps
)
9333 /* Otherwise, we'll leave key set to the drag event. */
9340 /* Normally, last_nonmenu_event gets the previous key we read.
9341 But when a mouse popup menu is being used,
9342 we don't update last_nonmenu_event; it continues to hold the mouse
9343 event that preceded the first level of menu. */
9344 if (!used_mouse_menu
)
9345 last_nonmenu_event
= key
;
9347 /* Record what part of this_command_keys is the current key sequence. */
9348 this_single_command_key_start
= this_command_key_count
- t
;
9350 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9351 /* There is a binding and it's not a prefix.
9352 There is thus no function-key in this sequence.
9353 Moving fkey.start is important in this case to allow keytran.start
9354 to go over the sequence before we return (since we keep the
9355 invariant that keytran.end <= fkey.start). */
9358 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9361 /* If the sequence is unbound, see if we can hang a function key
9362 off the end of it. */
9363 /* Continue scan from fkey.end until we find a bound suffix. */
9364 while (fkey
.end
< t
)
9366 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9369 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9370 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9371 max (t
, mock_input
),
9372 /* If there's a binding (i.e.
9373 first_binding >= nmaps) we don't want
9374 to apply this function-key-mapping. */
9375 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9380 mock_input
= diff
+ max (t
, mock_input
);
9381 goto replay_sequence
;
9385 /* Look for this sequence in key-translation-map.
9386 Scan from keytran.end until we find a bound suffix. */
9387 while (keytran
.end
< fkey
.start
)
9389 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9392 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9393 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9398 mock_input
= diff
+ max (t
, mock_input
);
9399 /* Adjust the function-key-map counters. */
9403 goto replay_sequence
;
9407 /* If KEY is not defined in any of the keymaps,
9408 and cannot be part of a function key or translation,
9409 and is an upper case letter
9410 use the corresponding lower-case letter instead. */
9411 if (first_binding
>= nmaps
9412 && fkey
.start
>= t
&& keytran
.start
>= t
9414 && ((((XINT (key
) & 0x3ffff)
9415 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9416 && UPPERCASEP (XINT (key
) & 0x3ffff))
9417 || (XINT (key
) & shift_modifier
)))
9419 Lisp_Object new_key
;
9421 original_uppercase
= key
;
9422 original_uppercase_position
= t
- 1;
9424 if (XINT (key
) & shift_modifier
)
9425 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9427 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9428 | (XINT (key
) & ~0x3ffff)));
9430 /* We have to do this unconditionally, regardless of whether
9431 the lower-case char is defined in the keymaps, because they
9432 might get translated through function-key-map. */
9433 keybuf
[t
- 1] = new_key
;
9434 mock_input
= max (t
, mock_input
);
9436 goto replay_sequence
;
9438 /* If KEY is not defined in any of the keymaps,
9439 and cannot be part of a function key or translation,
9440 and is a shifted function key,
9441 use the corresponding unshifted function key instead. */
9442 if (first_binding
>= nmaps
9443 && fkey
.start
>= t
&& keytran
.start
>= t
9446 Lisp_Object breakdown
;
9449 breakdown
= parse_modifiers (key
);
9450 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9451 if (modifiers
& shift_modifier
)
9453 Lisp_Object new_key
;
9455 original_uppercase
= key
;
9456 original_uppercase_position
= t
- 1;
9458 modifiers
&= ~shift_modifier
;
9459 new_key
= apply_modifiers (modifiers
,
9462 keybuf
[t
- 1] = new_key
;
9463 mock_input
= max (t
, mock_input
);
9464 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9465 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9467 goto replay_sequence
;
9473 read_key_sequence_cmd
= (first_binding
< nmaps
9474 ? defs
[first_binding
]
9477 unread_switch_frame
= delayed_switch_frame
;
9478 unbind_to (count
, Qnil
);
9480 /* Don't downcase the last character if the caller says don't.
9481 Don't downcase it if the result is undefined, either. */
9482 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9484 && t
- 1 == original_uppercase_position
)
9485 keybuf
[t
- 1] = original_uppercase
;
9487 /* Occasionally we fabricate events, perhaps by expanding something
9488 according to function-key-map, or by adding a prefix symbol to a
9489 mouse click in the scroll bar or modeline. In this cases, return
9490 the entire generated key sequence, even if we hit an unbound
9491 prefix or a definition before the end. This means that you will
9492 be able to push back the event properly, and also means that
9493 read-key-sequence will always return a logical unit.
9496 for (; t
< mock_input
; t
++)
9498 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9499 && NILP (Fzerop (Vecho_keystrokes
)))
9500 echo_char (keybuf
[t
]);
9501 add_command_key (keybuf
[t
]);
9510 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9511 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9512 The sequence is sufficient to specify a non-prefix command in the
9513 current local and global maps.
9515 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9516 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9517 as a continuation of the previous key.
9519 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9520 convert the last event to lower case. (Normally any upper case event
9521 is converted to lower case if the original event is undefined and the lower
9522 case equivalent is defined.) A non-nil value is appropriate for reading
9523 a key sequence to be defined.
9525 A C-g typed while in this function is treated like any other character,
9526 and `quit-flag' is not set.
9528 If the key sequence starts with a mouse click, then the sequence is read
9529 using the keymaps of the buffer of the window clicked in, not the buffer
9530 of the selected window as normal.
9532 `read-key-sequence' drops unbound button-down events, since you normally
9533 only care about the click or drag events which follow them. If a drag
9534 or multi-click event is unbound, but the corresponding click event would
9535 be bound, `read-key-sequence' turns the event into a click event at the
9536 drag's starting position. This means that you don't have to distinguish
9537 between click and drag, double, or triple events unless you want to.
9539 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9540 lines separating windows, and scroll bars with imaginary keys
9541 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9543 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9544 function will process a switch-frame event if the user switches frames
9545 before typing anything. If the user switches frames in the middle of a
9546 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9547 is nil, then the event will be put off until after the current key sequence.
9549 `read-key-sequence' checks `function-key-map' for function key
9550 sequences, where they wouldn't conflict with ordinary bindings. See
9551 `function-key-map' for more details.
9553 The optional fifth argument COMMAND-LOOP, if non-nil, means
9554 that this key sequence is being read by something that will
9555 read commands one after another. It should be nil if the caller
9556 will read just one key sequence. */)
9557 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9559 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9560 Lisp_Object can_return_switch_frame
, command_loop
;
9562 Lisp_Object keybuf
[30];
9564 struct gcpro gcpro1
;
9565 int count
= SPECPDL_INDEX ();
9568 CHECK_STRING (prompt
);
9571 specbind (Qinput_method_exit_on_first_char
,
9572 (NILP (command_loop
) ? Qt
: Qnil
));
9573 specbind (Qinput_method_use_echo_area
,
9574 (NILP (command_loop
) ? Qt
: Qnil
));
9576 bzero (keybuf
, sizeof keybuf
);
9578 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9580 if (NILP (continue_echo
))
9582 this_command_key_count
= 0;
9583 this_command_key_count_reset
= 0;
9584 this_single_command_key_start
= 0;
9587 #ifdef HAVE_X_WINDOWS
9588 if (display_hourglass_p
)
9589 cancel_hourglass ();
9592 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9593 prompt
, ! NILP (dont_downcase_last
),
9594 ! NILP (can_return_switch_frame
), 0);
9596 #if 0 /* The following is fine for code reading a key sequence and
9597 then proceeding with a lenghty computation, but it's not good
9598 for code reading keys in a loop, like an input method. */
9599 #ifdef HAVE_X_WINDOWS
9600 if (display_hourglass_p
)
9611 return unbind_to (count
, make_event_array (i
, keybuf
));
9614 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9615 Sread_key_sequence_vector
, 1, 5, 0,
9616 doc
: /* Like `read-key-sequence' but always return a vector. */)
9617 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9619 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9620 Lisp_Object can_return_switch_frame
, command_loop
;
9622 Lisp_Object keybuf
[30];
9624 struct gcpro gcpro1
;
9625 int count
= SPECPDL_INDEX ();
9628 CHECK_STRING (prompt
);
9631 specbind (Qinput_method_exit_on_first_char
,
9632 (NILP (command_loop
) ? Qt
: Qnil
));
9633 specbind (Qinput_method_use_echo_area
,
9634 (NILP (command_loop
) ? Qt
: Qnil
));
9636 bzero (keybuf
, sizeof keybuf
);
9638 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9640 if (NILP (continue_echo
))
9642 this_command_key_count
= 0;
9643 this_command_key_count_reset
= 0;
9644 this_single_command_key_start
= 0;
9647 #ifdef HAVE_X_WINDOWS
9648 if (display_hourglass_p
)
9649 cancel_hourglass ();
9652 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9653 prompt
, ! NILP (dont_downcase_last
),
9654 ! NILP (can_return_switch_frame
), 0);
9656 #ifdef HAVE_X_WINDOWS
9657 if (display_hourglass_p
)
9667 return unbind_to (count
, Fvector (i
, keybuf
));
9670 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9671 doc
: /* Execute CMD as an editor command.
9672 CMD must be a symbol that satisfies the `commandp' predicate.
9673 Optional second arg RECORD-FLAG non-nil
9674 means unconditionally put this command in `command-history'.
9675 Otherwise, that is done only if an arg is read using the minibuffer.
9676 The argument KEYS specifies the value to use instead of (this-command-keys)
9677 when reading the arguments; if it is nil, (this-command-keys) is used.
9678 The argument SPECIAL, if non-nil, means that this command is executing
9679 a special event, so ignore the prefix argument and don't clear it. */)
9680 (cmd
, record_flag
, keys
, special
)
9681 Lisp_Object cmd
, record_flag
, keys
, special
;
9683 register Lisp_Object final
;
9684 register Lisp_Object tem
;
9685 Lisp_Object prefixarg
;
9686 struct backtrace backtrace
;
9687 extern int debug_on_next_call
;
9689 debug_on_next_call
= 0;
9693 prefixarg
= current_kboard
->Vprefix_arg
;
9694 Vcurrent_prefix_arg
= prefixarg
;
9695 current_kboard
->Vprefix_arg
= Qnil
;
9702 tem
= Fget (cmd
, Qdisabled
);
9703 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9705 tem
= Fsymbol_value (Qdisabled_command_function
);
9707 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9713 final
= Findirect_function (cmd
, Qnil
);
9715 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9717 struct gcpro gcpro1
, gcpro2
;
9719 GCPRO2 (cmd
, prefixarg
);
9720 do_autoload (final
, cmd
);
9727 if (STRINGP (final
) || VECTORP (final
))
9729 /* If requested, place the macro in the command history. For
9730 other sorts of commands, call-interactively takes care of
9732 if (!NILP (record_flag
))
9735 = Fcons (Fcons (Qexecute_kbd_macro
,
9736 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9739 /* Don't keep command history around forever. */
9740 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9742 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9744 XSETCDR (tem
, Qnil
);
9748 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9751 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9753 backtrace
.next
= backtrace_list
;
9754 backtrace_list
= &backtrace
;
9755 backtrace
.function
= &Qcall_interactively
;
9756 backtrace
.args
= &cmd
;
9757 backtrace
.nargs
= 1;
9758 backtrace
.evalargs
= 0;
9759 backtrace
.debug_on_exit
= 0;
9761 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9763 backtrace_list
= backtrace
.next
;
9771 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9773 doc
: /* Read function name, then read its arguments and call it.
9775 To pass a numeric argument to the command you are invoking with, specify
9776 the numeric argument to this command.
9778 Noninteractively, the argument PREFIXARG is the prefix argument to
9779 give to the command you invoke, if it asks for an argument. */)
9781 Lisp_Object prefixarg
;
9783 Lisp_Object function
;
9785 int saved_last_point_position
;
9786 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9787 Lisp_Object bindings
, value
;
9788 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9789 #ifdef HAVE_X_WINDOWS
9790 /* The call to Fcompleting_read wil start and cancel the hourglass,
9791 but if the hourglass was already scheduled, this means that no
9792 hourglass will be shown for the actual M-x command itself.
9793 So we restart it if it is already scheduled. Note that checking
9794 hourglass_shown_p is not enough, normally the hourglass is not shown,
9795 just scheduled to be shown. */
9796 int hstarted
= hourglass_started ();
9799 saved_keys
= Fvector (this_command_key_count
,
9800 XVECTOR (this_command_keys
)->contents
);
9801 saved_last_point_position_buffer
= last_point_position_buffer
;
9802 saved_last_point_position
= last_point_position
;
9804 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9806 if (EQ (prefixarg
, Qminus
))
9808 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9809 strcpy (buf
, "C-u ");
9810 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9811 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9812 else if (INTEGERP (prefixarg
))
9813 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9815 /* This isn't strictly correct if execute-extended-command
9816 is bound to anything else. Perhaps it should use
9817 this_command_keys? */
9818 strcat (buf
, "M-x ");
9820 /* Prompt with buf, and then read a string, completing from and
9821 restricting to the set of all defined commands. Don't provide
9822 any initial input. Save the command read on the extended-command
9824 function
= Fcompleting_read (build_string (buf
),
9825 Vobarray
, Qcommandp
,
9826 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9829 #ifdef HAVE_X_WINDOWS
9830 if (hstarted
) start_hourglass ();
9833 if (STRINGP (function
) && SCHARS (function
) == 0)
9834 error ("No command name given");
9836 /* Set this_command_keys to the concatenation of saved_keys and
9837 function, followed by a RET. */
9842 this_command_key_count
= 0;
9843 this_command_key_count_reset
= 0;
9844 this_single_command_key_start
= 0;
9846 keys
= XVECTOR (saved_keys
)->contents
;
9847 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9848 add_command_key (keys
[i
]);
9850 for (i
= 0; i
< SCHARS (function
); i
++)
9851 add_command_key (Faref (function
, make_number (i
)));
9853 add_command_key (make_number ('\015'));
9856 last_point_position
= saved_last_point_position
;
9857 last_point_position_buffer
= saved_last_point_position_buffer
;
9861 function
= Fintern (function
, Qnil
);
9862 current_kboard
->Vprefix_arg
= prefixarg
;
9863 Vthis_command
= function
;
9864 real_this_command
= function
;
9866 /* If enabled, show which key runs this command. */
9867 if (!NILP (Vsuggest_key_bindings
)
9868 && NILP (Vexecuting_kbd_macro
)
9869 && SYMBOLP (function
))
9870 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9876 GCPRO2 (bindings
, value
);
9877 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9879 /* If the command has a key binding, print it now. */
9880 if (!NILP (bindings
)
9881 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9884 /* But first wait, and skip the message if there is input. */
9887 if (!NILP (echo_area_buffer
[0]))
9889 /* This command displayed something in the echo area;
9890 so wait a few seconds, then display our suggestion message. */
9891 if (NUMBERP (Vsuggest_key_bindings
))
9893 double duration
= extract_float (Vminibuffer_message_timeout
);
9894 waited
= sit_for ((int) duration
,
9895 (duration
- (int) duration
) * 1000000,
9899 waited
= sit_for (2, 0, 0, Qt
, Qt
);
9902 waited
= sit_for (0, 0, 0, Qt
, Qt
);
9904 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
9906 Lisp_Object binding
;
9908 int message_p
= push_message ();
9909 int count
= SPECPDL_INDEX ();
9911 record_unwind_protect (pop_message_unwind
, Qnil
);
9912 binding
= Fkey_description (bindings
, Qnil
);
9915 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9918 sprintf (newmessage
, "You can run the command `%s' with %s",
9919 SDATA (SYMBOL_NAME (function
)),
9921 message2_nolog (newmessage
,
9922 strlen (newmessage
),
9923 STRING_MULTIBYTE (binding
));
9924 if (NUMBERP (Vsuggest_key_bindings
))
9926 double duration
= extract_float (Vsuggest_key_bindings
);
9927 waited
= sit_for ((int) duration
,
9928 (duration
- (int) duration
) * 1000000,
9932 waited
= sit_for (2, 0, 0, Qt
, Qt
);
9934 if (!NILP (waited
) && message_p
)
9937 unbind_to (count
, Qnil
);
9941 RETURN_UNGCPRO (value
);
9945 /* Return nonzero if input events are pending. */
9948 detect_input_pending ()
9951 get_input_pending (&input_pending
, 0);
9953 return input_pending
;
9956 /* Return nonzero if input events other than mouse movements are
9960 detect_input_pending_ignore_squeezables ()
9963 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9965 return input_pending
;
9968 /* Return nonzero if input events are pending, and run any pending timers. */
9971 detect_input_pending_run_timers (do_display
)
9974 int old_timers_run
= timers_run
;
9977 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
9979 if (old_timers_run
!= timers_run
&& do_display
)
9981 redisplay_preserve_echo_area (8);
9982 /* The following fixes a bug when using lazy-lock with
9983 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9984 from an idle timer function. The symptom of the bug is that
9985 the cursor sometimes doesn't become visible until the next X
9986 event is processed. --gerd. */
9988 rif
->flush_display (NULL
);
9991 return input_pending
;
9994 /* This is called in some cases before a possible quit.
9995 It cases the next call to detect_input_pending to recompute input_pending.
9996 So calling this function unnecessarily can't do any harm. */
9999 clear_input_pending ()
10004 /* Return nonzero if there are pending requeued events.
10005 This isn't used yet. The hope is to make wait_reading_process_output
10006 call it, and return if it runs Lisp code that unreads something.
10007 The problem is, kbd_buffer_get_event needs to be fixed to know what
10008 to do in that case. It isn't trivial. */
10011 requeued_events_pending_p ()
10013 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10017 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10018 doc
: /* Return t if command input is currently available with no wait.
10019 Actually, the value is nil only if we can be sure that no input is available;
10020 if there is a doubt, the value is t. */)
10023 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
10026 get_input_pending (&input_pending
,
10027 READABLE_EVENTS_DO_TIMERS_NOW
10028 | READABLE_EVENTS_FILTER_EVENTS
);
10029 return input_pending
> 0 ? Qt
: Qnil
;
10032 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10033 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10036 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10039 if (total_keys
< NUM_RECENT_KEYS
)
10040 return Fvector (total_keys
, keys
);
10043 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10044 bcopy (keys
+ recent_keys_index
,
10045 XVECTOR (val
)->contents
,
10046 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10048 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10049 recent_keys_index
* sizeof (Lisp_Object
));
10054 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10055 doc
: /* Return the key sequence that invoked this command.
10056 However, if the command has called `read-key-sequence', it returns
10057 the last key sequence that has been read.
10058 The value is a string or a vector. */)
10061 return make_event_array (this_command_key_count
,
10062 XVECTOR (this_command_keys
)->contents
);
10065 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10066 doc
: /* Return the key sequence that invoked this command, as a vector.
10067 However, if the command has called `read-key-sequence', it returns
10068 the last key sequence that has been read. */)
10071 return Fvector (this_command_key_count
,
10072 XVECTOR (this_command_keys
)->contents
);
10075 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10076 Sthis_single_command_keys
, 0, 0, 0,
10077 doc
: /* Return the key sequence that invoked this command.
10078 More generally, it returns the last key sequence read, either by
10079 the command loop or by `read-key-sequence'.
10080 Unlike `this-command-keys', this function's value
10081 does not include prefix arguments.
10082 The value is always a vector. */)
10085 return Fvector (this_command_key_count
10086 - this_single_command_key_start
,
10087 (XVECTOR (this_command_keys
)->contents
10088 + this_single_command_key_start
));
10091 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10092 Sthis_single_command_raw_keys
, 0, 0, 0,
10093 doc
: /* Return the raw events that were read for this command.
10094 More generally, it returns the last key sequence read, either by
10095 the command loop or by `read-key-sequence'.
10096 Unlike `this-single-command-keys', this function's value
10097 shows the events before all translations (except for input methods).
10098 The value is always a vector. */)
10101 return Fvector (raw_keybuf_count
,
10102 (XVECTOR (raw_keybuf
)->contents
));
10105 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10106 Sreset_this_command_lengths
, 0, 0, 0,
10107 doc
: /* Make the unread events replace the last command and echo.
10108 Used in `universal-argument-other-key'.
10110 `universal-argument-other-key' rereads the event just typed.
10111 It then gets translated through `function-key-map'.
10112 The translated event has to replace the real events,
10113 both in the value of (this-command-keys) and in echoing.
10114 To achieve this, `universal-argument-other-key' calls
10115 `reset-this-command-lengths', which discards the record of reading
10116 these events the first time. */)
10119 this_command_key_count
= before_command_key_count
;
10120 if (this_command_key_count
< this_single_command_key_start
)
10121 this_single_command_key_start
= this_command_key_count
;
10123 echo_truncate (before_command_echo_length
);
10125 /* Cause whatever we put into unread-command-events
10126 to echo as if it were being freshly read from the keyboard. */
10127 this_command_key_count_reset
= 1;
10132 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10133 Sclear_this_command_keys
, 0, 1, 0,
10134 doc
: /* Clear out the vector that `this-command-keys' returns.
10135 Also clear the record of the last 100 events, unless optional arg
10136 KEEP-RECORD is non-nil. */)
10138 Lisp_Object keep_record
;
10142 this_command_key_count
= 0;
10143 this_command_key_count_reset
= 0;
10145 if (NILP (keep_record
))
10147 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10148 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10150 recent_keys_index
= 0;
10155 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10156 doc
: /* Return the current depth in recursive edits. */)
10160 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10164 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10165 "FOpen dribble file: ",
10166 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10167 If FILE is nil, close any open dribble file. */)
10178 file
= Fexpand_file_name (file
, Qnil
);
10179 dribble
= fopen (SDATA (file
), "w");
10181 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10186 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10187 doc
: /* Discard the contents of the terminal input buffer.
10188 Also end any kbd macro being defined. */)
10191 if (!NILP (current_kboard
->defining_kbd_macro
))
10193 /* Discard the last command from the macro. */
10194 Fcancel_kbd_macro_events ();
10198 update_mode_lines
++;
10200 Vunread_command_events
= Qnil
;
10201 unread_command_char
= -1;
10203 discard_tty_input ();
10205 kbd_fetch_ptr
= kbd_store_ptr
;
10211 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10212 doc
: /* Stop Emacs and return to superior process. You can resume later.
10213 If `cannot-suspend' is non-nil, or if the system doesn't support job
10214 control, run a subshell instead.
10216 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10217 to be read as terminal input by Emacs's parent, after suspension.
10219 Before suspending, run the normal hook `suspend-hook'.
10220 After resumption run the normal hook `suspend-resume-hook'.
10222 Some operating systems cannot stop the Emacs process and resume it later.
10223 On such systems, Emacs starts a subshell instead of suspending. */)
10225 Lisp_Object stuffstring
;
10227 int count
= SPECPDL_INDEX ();
10228 int old_height
, old_width
;
10230 struct gcpro gcpro1
;
10232 if (!NILP (stuffstring
))
10233 CHECK_STRING (stuffstring
);
10235 /* Run the functions in suspend-hook. */
10236 if (!NILP (Vrun_hooks
))
10237 call1 (Vrun_hooks
, intern ("suspend-hook"));
10239 GCPRO1 (stuffstring
);
10240 get_frame_size (&old_width
, &old_height
);
10241 reset_sys_modes ();
10242 /* sys_suspend can get an error if it tries to fork a subshell
10243 and the system resources aren't available for that. */
10244 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10246 stuff_buffered_input (stuffstring
);
10247 if (cannot_suspend
)
10251 unbind_to (count
, Qnil
);
10253 /* Check if terminal/window size has changed.
10254 Note that this is not useful when we are running directly
10255 with a window system; but suspend should be disabled in that case. */
10256 get_frame_size (&width
, &height
);
10257 if (width
!= old_width
|| height
!= old_height
)
10258 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10260 /* Run suspend-resume-hook. */
10261 if (!NILP (Vrun_hooks
))
10262 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10268 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10269 Then in any case stuff anything Emacs has read ahead and not used. */
10272 stuff_buffered_input (stuffstring
)
10273 Lisp_Object stuffstring
;
10275 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10276 register unsigned char *p
;
10278 if (STRINGP (stuffstring
))
10280 register int count
;
10282 p
= SDATA (stuffstring
);
10283 count
= SBYTES (stuffstring
);
10284 while (count
-- > 0)
10289 /* Anything we have read ahead, put back for the shell to read. */
10290 /* ?? What should this do when we have multiple keyboards??
10291 Should we ignore anything that was typed in at the "wrong" kboard?
10293 rms: we should stuff everything back into the kboard
10295 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10298 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10299 kbd_fetch_ptr
= kbd_buffer
;
10300 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10301 stuff_char (kbd_fetch_ptr
->code
);
10303 clear_event (kbd_fetch_ptr
);
10307 #endif /* SIGTSTP */
10311 set_waiting_for_input (time_to_clear
)
10312 EMACS_TIME
*time_to_clear
;
10314 input_available_clear_time
= time_to_clear
;
10316 /* Tell interrupt_signal to throw back to read_char, */
10317 waiting_for_input
= 1;
10319 /* If interrupt_signal was called before and buffered a C-g,
10320 make it run again now, to avoid timing error. */
10321 if (!NILP (Vquit_flag
))
10322 quit_throw_to_read_char ();
10326 clear_waiting_for_input ()
10328 /* Tell interrupt_signal not to throw back to read_char, */
10329 waiting_for_input
= 0;
10330 input_available_clear_time
= 0;
10333 /* This routine is called at interrupt level in response to C-g.
10335 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10336 is called from kbd_buffer_store_event, in handling SIGIO or
10339 If `waiting_for_input' is non zero, then unless `echoing' is
10340 nonzero, immediately throw back to read_char.
10342 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10343 eval to throw, when it gets a chance. If quit-flag is already
10344 non-nil, it stops the job right away. */
10347 interrupt_signal (signalnum
) /* If we don't have an argument, */
10348 int signalnum
; /* some compilers complain in signal calls. */
10351 /* Must preserve main program's value of errno. */
10352 int old_errno
= errno
;
10353 struct frame
*sf
= SELECTED_FRAME ();
10355 #if defined (USG) && !defined (POSIX_SIGNALS)
10356 if (!read_socket_hook
&& NILP (Vwindow_system
))
10358 /* USG systems forget handlers when they are used;
10359 must reestablish each time */
10360 signal (SIGINT
, interrupt_signal
);
10361 signal (SIGQUIT
, interrupt_signal
);
10365 SIGNAL_THREAD_CHECK (signalnum
);
10368 if (!NILP (Vquit_flag
)
10369 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10371 /* If SIGINT isn't blocked, don't let us be interrupted by
10372 another SIGINT, it might be harmful due to non-reentrancy
10373 in I/O functions. */
10374 sigblock (sigmask (SIGINT
));
10377 reset_sys_modes ();
10379 #ifdef SIGTSTP /* Support possible in later USG versions */
10381 * On systems which can suspend the current process and return to the original
10382 * shell, this command causes the user to end up back at the shell.
10383 * The "Auto-save" and "Abort" questions are not asked until
10384 * the user elects to return to emacs, at which point he can save the current
10385 * job and either dump core or continue.
10390 if (sys_suspend () == -1)
10392 printf ("Not running as a subprocess;\n");
10393 printf ("you can continue or abort.\n");
10395 #else /* not VMS */
10396 /* Perhaps should really fork an inferior shell?
10397 But that would not provide any way to get back
10398 to the original shell, ever. */
10399 printf ("No support for stopping a process on this operating system;\n");
10400 printf ("you can continue or abort.\n");
10401 #endif /* not VMS */
10402 #endif /* not SIGTSTP */
10404 /* We must remain inside the screen area when the internal terminal
10405 is used. Note that [Enter] is not echoed by dos. */
10408 /* It doesn't work to autosave while GC is in progress;
10409 the code used for auto-saving doesn't cope with the mark bit. */
10410 if (!gc_in_progress
)
10412 printf ("Auto-save? (y or n) ");
10414 if (((c
= getchar ()) & ~040) == 'Y')
10416 Fdo_auto_save (Qt
, Qnil
);
10418 printf ("\r\nAuto-save done");
10419 #else /* not MSDOS */
10420 printf ("Auto-save done\n");
10421 #endif /* not MSDOS */
10423 while (c
!= '\n') c
= getchar ();
10427 /* During GC, it must be safe to reenable quitting again. */
10428 Vinhibit_quit
= Qnil
;
10431 #endif /* not MSDOS */
10432 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10433 printf ("but will instead do a real quit after garbage collection ends\r\n");
10438 printf ("\r\nAbort? (y or n) ");
10439 #else /* not MSDOS */
10441 printf ("Abort (and enter debugger)? (y or n) ");
10442 #else /* not VMS */
10443 printf ("Abort (and dump core)? (y or n) ");
10444 #endif /* not VMS */
10445 #endif /* not MSDOS */
10447 if (((c
= getchar ()) & ~040) == 'Y')
10449 while (c
!= '\n') c
= getchar ();
10451 printf ("\r\nContinuing...\r\n");
10452 #else /* not MSDOS */
10453 printf ("Continuing...\n");
10454 #endif /* not MSDOS */
10461 /* If executing a function that wants to be interrupted out of
10462 and the user has not deferred quitting by binding `inhibit-quit'
10463 then quit right away. */
10464 if (immediate_quit
&& NILP (Vinhibit_quit
))
10466 struct gl_state_s saved
;
10467 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10469 immediate_quit
= 0;
10472 GCPRO4 (saved
.object
, saved
.global_code
,
10473 saved
.current_syntax_table
, saved
.old_prop
);
10474 Fsignal (Qquit
, Qnil
);
10479 /* Else request quit when it's safe */
10483 if (waiting_for_input
&& !echoing
)
10484 quit_throw_to_read_char ();
10489 /* Handle a C-g by making read_char return C-g. */
10492 quit_throw_to_read_char ()
10495 /* Prevent another signal from doing this before we finish. */
10496 clear_waiting_for_input ();
10499 Vunread_command_events
= Qnil
;
10500 unread_command_char
= -1;
10502 #if 0 /* Currently, sit_for is called from read_char without turning
10503 off polling. And that can call set_waiting_for_input.
10504 It seems to be harmless. */
10505 #ifdef POLL_FOR_INPUT
10506 /* May be > 1 if in recursive minibuffer. */
10507 if (poll_suppress_count
== 0)
10511 if (FRAMEP (internal_last_event_frame
)
10512 && !EQ (internal_last_event_frame
, selected_frame
))
10513 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10516 _longjmp (getcjmp
, 1);
10519 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10520 doc
: /* Set mode of reading keyboard input.
10521 First arg INTERRUPT non-nil means use input interrupts;
10522 nil means use CBREAK mode.
10523 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10524 (no effect except in CBREAK mode).
10525 Third arg META t means accept 8-bit input (for a Meta key).
10526 META nil means ignore the top bit, on the assumption it is parity.
10527 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10528 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10529 See also `current-input-mode'. */)
10530 (interrupt
, flow
, meta
, quit
)
10531 Lisp_Object interrupt
, flow
, meta
, quit
;
10534 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10535 error ("set-input-mode: QUIT must be an ASCII character");
10537 #ifdef POLL_FOR_INPUT
10542 /* this causes startup screen to be restored and messes with the mouse */
10543 reset_sys_modes ();
10547 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10548 if (read_socket_hook
)
10550 /* When using X, don't give the user a real choice,
10551 because we haven't implemented the mechanisms to support it. */
10552 #ifdef NO_SOCK_SIGIO
10553 interrupt_input
= 0;
10554 #else /* not NO_SOCK_SIGIO */
10555 interrupt_input
= 1;
10556 #endif /* NO_SOCK_SIGIO */
10559 interrupt_input
= !NILP (interrupt
);
10560 #else /* not SIGIO */
10561 interrupt_input
= 0;
10562 #endif /* not SIGIO */
10564 /* Our VMS input only works by interrupts, as of now. */
10566 interrupt_input
= 1;
10569 flow_control
= !NILP (flow
);
10572 else if (EQ (meta
, Qt
))
10577 /* Don't let this value be out of range. */
10578 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10584 #ifdef POLL_FOR_INPUT
10585 poll_suppress_count
= 1;
10591 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10592 doc
: /* Return information about the way Emacs currently reads keyboard input.
10593 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10594 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10595 nil, Emacs is using CBREAK mode.
10596 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10597 terminal; this does not apply if Emacs uses interrupt-driven input.
10598 META is t if accepting 8-bit input with 8th bit as Meta flag.
10599 META nil means ignoring the top bit, on the assumption it is parity.
10600 META is neither t nor nil if accepting 8-bit input and using
10601 all 8 bits as the character code.
10602 QUIT is the character Emacs currently uses to quit.
10603 The elements of this list correspond to the arguments of
10604 `set-input-mode'. */)
10607 Lisp_Object val
[4];
10609 val
[0] = interrupt_input
? Qt
: Qnil
;
10610 val
[1] = flow_control
? Qt
: Qnil
;
10611 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10612 XSETFASTINT (val
[3], quit_char
);
10614 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10617 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10618 doc
: /* Return position information for pixel coordinates X and Y.
10619 By default, X and Y are relative to text area of the selected window.
10620 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10621 If optional fourth arg WHOLE is non-nil, X is relative to the left
10622 edge of the window.
10624 The return value is similar to a mouse click position:
10625 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10626 IMAGE (DX . DY) (WIDTH . HEIGHT))
10627 The `posn-' functions access elements of such lists. */)
10628 (x
, y
, frame_or_window
, whole
)
10629 Lisp_Object x
, y
, frame_or_window
, whole
;
10634 if (NILP (frame_or_window
))
10635 frame_or_window
= selected_window
;
10637 if (WINDOWP (frame_or_window
))
10641 CHECK_LIVE_WINDOW (frame_or_window
);
10643 w
= XWINDOW (frame_or_window
);
10644 XSETINT (x
, (XINT (x
)
10645 + WINDOW_LEFT_EDGE_X (w
)
10647 ? window_box_left_offset (w
, TEXT_AREA
)
10649 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10650 frame_or_window
= w
->frame
;
10653 CHECK_LIVE_FRAME (frame_or_window
);
10655 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10658 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10659 doc
: /* Return position information for buffer POS in WINDOW.
10660 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10662 Return nil if position is not visible in window. Otherwise,
10663 the return value is similar to that returned by `event-start' for
10664 a mouse click at the upper left corner of the glyph corresponding
10665 to the given buffer position:
10666 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10667 IMAGE (DX . DY) (WIDTH . HEIGHT))
10668 The `posn-' functions access elements of such lists. */)
10670 Lisp_Object pos
, window
;
10675 window
= selected_window
;
10677 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10680 Lisp_Object x
= XCAR (tem
);
10681 Lisp_Object y
= XCAR (XCDR (tem
));
10683 /* Point invisible due to hscrolling? */
10686 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10694 * Set up a new kboard object with reasonable initial values.
10700 kb
->Voverriding_terminal_local_map
= Qnil
;
10701 kb
->Vlast_command
= Qnil
;
10702 kb
->Vreal_last_command
= Qnil
;
10703 kb
->Vprefix_arg
= Qnil
;
10704 kb
->Vlast_prefix_arg
= Qnil
;
10705 kb
->kbd_queue
= Qnil
;
10706 kb
->kbd_queue_has_data
= 0;
10707 kb
->immediate_echo
= 0;
10708 kb
->echo_string
= Qnil
;
10709 kb
->echo_after_prompt
= -1;
10710 kb
->kbd_macro_buffer
= 0;
10711 kb
->kbd_macro_bufsize
= 0;
10712 kb
->defining_kbd_macro
= Qnil
;
10713 kb
->Vlast_kbd_macro
= Qnil
;
10714 kb
->reference_count
= 0;
10715 kb
->Vsystem_key_alist
= Qnil
;
10716 kb
->system_key_syms
= Qnil
;
10717 kb
->Vdefault_minibuffer_frame
= Qnil
;
10721 * Destroy the contents of a kboard object, but not the object itself.
10722 * We use this just before deleting it, or if we're going to initialize
10723 * it a second time.
10729 if (kb
->kbd_macro_buffer
)
10730 xfree (kb
->kbd_macro_buffer
);
10733 #ifdef MULTI_KBOARD
10735 /* Free KB and memory referenced from it. */
10743 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10746 *kbp
= kb
->next_kboard
;
10748 /* Prevent a dangling reference to KB. */
10749 if (kb
== current_kboard
10750 && FRAMEP (selected_frame
)
10751 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10753 current_kboard
= XFRAME (selected_frame
)->kboard
;
10754 if (current_kboard
== kb
)
10762 #endif /* MULTI_KBOARD */
10767 /* This is correct before outermost invocation of the editor loop */
10768 command_loop_level
= -1;
10769 immediate_quit
= 0;
10770 quit_char
= Ctl ('g');
10771 Vunread_command_events
= Qnil
;
10772 unread_command_char
= -1;
10773 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10775 recent_keys_index
= 0;
10776 kbd_fetch_ptr
= kbd_buffer
;
10777 kbd_store_ptr
= kbd_buffer
;
10779 do_mouse_tracking
= Qnil
;
10783 /* This means that command_loop_1 won't try to select anything the first
10785 internal_last_event_frame
= Qnil
;
10786 Vlast_event_frame
= internal_last_event_frame
;
10788 #ifdef MULTI_KBOARD
10789 current_kboard
= initial_kboard
;
10791 wipe_kboard (current_kboard
);
10792 init_kboard (current_kboard
);
10794 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10796 signal (SIGINT
, interrupt_signal
);
10797 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10798 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10799 SIGQUIT and we can't tell which one it will give us. */
10800 signal (SIGQUIT
, interrupt_signal
);
10801 #endif /* HAVE_TERMIO */
10803 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10805 if (!noninteractive
)
10806 signal (SIGIO
, input_available_signal
);
10809 /* Use interrupt input by default, if it works and noninterrupt input
10810 has deficiencies. */
10812 #ifdef INTERRUPT_INPUT
10813 interrupt_input
= 1;
10815 interrupt_input
= 0;
10818 /* Our VMS input only works by interrupts, as of now. */
10820 interrupt_input
= 1;
10826 if (keyboard_init_hook
)
10827 (*keyboard_init_hook
) ();
10829 #ifdef POLL_FOR_INPUT
10830 poll_suppress_count
= 1;
10835 /* This type's only use is in syms_of_keyboard, to initialize the
10836 event header symbols and put properties on them. */
10837 struct event_head
{
10843 struct event_head head_table
[] = {
10844 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10845 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10846 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10847 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10848 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10849 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10850 /* `select-window' should be handled just like `switch-frame'
10851 in read_key_sequence. */
10852 {&Qselect_window
, "select-window", &Qswitch_frame
}
10856 syms_of_keyboard ()
10858 Vpre_help_message
= Qnil
;
10859 staticpro (&Vpre_help_message
);
10861 Vlispy_mouse_stem
= build_string ("mouse");
10862 staticpro (&Vlispy_mouse_stem
);
10865 QCimage
= intern (":image");
10866 staticpro (&QCimage
);
10868 staticpro (&Qhelp_echo
);
10869 Qhelp_echo
= intern ("help-echo");
10871 staticpro (&item_properties
);
10872 item_properties
= Qnil
;
10874 staticpro (&tool_bar_item_properties
);
10875 tool_bar_item_properties
= Qnil
;
10876 staticpro (&tool_bar_items_vector
);
10877 tool_bar_items_vector
= Qnil
;
10879 staticpro (&real_this_command
);
10880 real_this_command
= Qnil
;
10882 Qtimer_event_handler
= intern ("timer-event-handler");
10883 staticpro (&Qtimer_event_handler
);
10885 Qdisabled_command_function
= intern ("disabled-command-function");
10886 staticpro (&Qdisabled_command_function
);
10888 Qself_insert_command
= intern ("self-insert-command");
10889 staticpro (&Qself_insert_command
);
10891 Qforward_char
= intern ("forward-char");
10892 staticpro (&Qforward_char
);
10894 Qbackward_char
= intern ("backward-char");
10895 staticpro (&Qbackward_char
);
10897 Qdisabled
= intern ("disabled");
10898 staticpro (&Qdisabled
);
10900 Qundefined
= intern ("undefined");
10901 staticpro (&Qundefined
);
10903 Qpre_command_hook
= intern ("pre-command-hook");
10904 staticpro (&Qpre_command_hook
);
10906 Qpost_command_hook
= intern ("post-command-hook");
10907 staticpro (&Qpost_command_hook
);
10909 Qdeferred_action_function
= intern ("deferred-action-function");
10910 staticpro (&Qdeferred_action_function
);
10912 Qcommand_hook_internal
= intern ("command-hook-internal");
10913 staticpro (&Qcommand_hook_internal
);
10915 Qfunction_key
= intern ("function-key");
10916 staticpro (&Qfunction_key
);
10917 Qmouse_click
= intern ("mouse-click");
10918 staticpro (&Qmouse_click
);
10919 #if defined (WINDOWSNT) || defined (MAC_OS)
10920 Qlanguage_change
= intern ("language-change");
10921 staticpro (&Qlanguage_change
);
10923 Qdrag_n_drop
= intern ("drag-n-drop");
10924 staticpro (&Qdrag_n_drop
);
10926 Qsave_session
= intern ("save-session");
10927 staticpro (&Qsave_session
);
10930 Qmac_apple_event
= intern ("mac-apple-event");
10931 staticpro (&Qmac_apple_event
);
10934 Qusr1_signal
= intern ("usr1-signal");
10935 staticpro (&Qusr1_signal
);
10936 Qusr2_signal
= intern ("usr2-signal");
10937 staticpro (&Qusr2_signal
);
10939 Qmenu_enable
= intern ("menu-enable");
10940 staticpro (&Qmenu_enable
);
10941 Qmenu_alias
= intern ("menu-alias");
10942 staticpro (&Qmenu_alias
);
10943 QCenable
= intern (":enable");
10944 staticpro (&QCenable
);
10945 QCvisible
= intern (":visible");
10946 staticpro (&QCvisible
);
10947 QChelp
= intern (":help");
10948 staticpro (&QChelp
);
10949 QCfilter
= intern (":filter");
10950 staticpro (&QCfilter
);
10951 QCbutton
= intern (":button");
10952 staticpro (&QCbutton
);
10953 QCkeys
= intern (":keys");
10954 staticpro (&QCkeys
);
10955 QCkey_sequence
= intern (":key-sequence");
10956 staticpro (&QCkey_sequence
);
10957 QCtoggle
= intern (":toggle");
10958 staticpro (&QCtoggle
);
10959 QCradio
= intern (":radio");
10960 staticpro (&QCradio
);
10962 Qmode_line
= intern ("mode-line");
10963 staticpro (&Qmode_line
);
10964 Qvertical_line
= intern ("vertical-line");
10965 staticpro (&Qvertical_line
);
10966 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10967 staticpro (&Qvertical_scroll_bar
);
10968 Qmenu_bar
= intern ("menu-bar");
10969 staticpro (&Qmenu_bar
);
10972 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
10973 staticpro (&Qmouse_fixup_help_message
);
10976 Qabove_handle
= intern ("above-handle");
10977 staticpro (&Qabove_handle
);
10978 Qhandle
= intern ("handle");
10979 staticpro (&Qhandle
);
10980 Qbelow_handle
= intern ("below-handle");
10981 staticpro (&Qbelow_handle
);
10982 Qup
= intern ("up");
10984 Qdown
= intern ("down");
10985 staticpro (&Qdown
);
10986 Qtop
= intern ("top");
10988 Qbottom
= intern ("bottom");
10989 staticpro (&Qbottom
);
10990 Qend_scroll
= intern ("end-scroll");
10991 staticpro (&Qend_scroll
);
10992 Qratio
= intern ("ratio");
10993 staticpro (&Qratio
);
10995 Qevent_kind
= intern ("event-kind");
10996 staticpro (&Qevent_kind
);
10997 Qevent_symbol_elements
= intern ("event-symbol-elements");
10998 staticpro (&Qevent_symbol_elements
);
10999 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11000 staticpro (&Qevent_symbol_element_mask
);
11001 Qmodifier_cache
= intern ("modifier-cache");
11002 staticpro (&Qmodifier_cache
);
11004 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11005 staticpro (&Qrecompute_lucid_menubar
);
11006 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11007 staticpro (&Qactivate_menubar_hook
);
11009 Qpolling_period
= intern ("polling-period");
11010 staticpro (&Qpolling_period
);
11012 Qinput_method_function
= intern ("input-method-function");
11013 staticpro (&Qinput_method_function
);
11015 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11016 staticpro (&Qinput_method_exit_on_first_char
);
11017 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11018 staticpro (&Qinput_method_use_echo_area
);
11020 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11021 Fset (Qinput_method_use_echo_area
, Qnil
);
11023 last_point_position_buffer
= Qnil
;
11024 last_point_position_window
= Qnil
;
11027 struct event_head
*p
;
11029 for (p
= head_table
;
11030 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11033 *p
->var
= intern (p
->name
);
11034 staticpro (p
->var
);
11035 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11036 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11040 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11041 staticpro (&button_down_location
);
11042 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11043 staticpro (&mouse_syms
);
11044 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11045 staticpro (&wheel_syms
);
11049 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11051 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11052 for (i
= 0; i
< len
; i
++)
11053 if (modifier_names
[i
])
11054 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11055 staticpro (&modifier_symbols
);
11058 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11059 staticpro (&recent_keys
);
11061 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11062 staticpro (&this_command_keys
);
11064 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11065 staticpro (&raw_keybuf
);
11067 Qextended_command_history
= intern ("extended-command-history");
11068 Fset (Qextended_command_history
, Qnil
);
11069 staticpro (&Qextended_command_history
);
11071 accent_key_syms
= Qnil
;
11072 staticpro (&accent_key_syms
);
11074 func_key_syms
= Qnil
;
11075 staticpro (&func_key_syms
);
11077 drag_n_drop_syms
= Qnil
;
11078 staticpro (&drag_n_drop_syms
);
11080 unread_switch_frame
= Qnil
;
11081 staticpro (&unread_switch_frame
);
11083 internal_last_event_frame
= Qnil
;
11084 staticpro (&internal_last_event_frame
);
11086 read_key_sequence_cmd
= Qnil
;
11087 staticpro (&read_key_sequence_cmd
);
11089 menu_bar_one_keymap_changed_items
= Qnil
;
11090 staticpro (&menu_bar_one_keymap_changed_items
);
11092 menu_bar_items_vector
= Qnil
;
11093 staticpro (&menu_bar_items_vector
);
11095 defsubr (&Sevent_convert_list
);
11096 defsubr (&Sread_key_sequence
);
11097 defsubr (&Sread_key_sequence_vector
);
11098 defsubr (&Srecursive_edit
);
11100 defsubr (&Strack_mouse
);
11102 defsubr (&Sinput_pending_p
);
11103 defsubr (&Scommand_execute
);
11104 defsubr (&Srecent_keys
);
11105 defsubr (&Sthis_command_keys
);
11106 defsubr (&Sthis_command_keys_vector
);
11107 defsubr (&Sthis_single_command_keys
);
11108 defsubr (&Sthis_single_command_raw_keys
);
11109 defsubr (&Sreset_this_command_lengths
);
11110 defsubr (&Sclear_this_command_keys
);
11111 defsubr (&Ssuspend_emacs
);
11112 defsubr (&Sabort_recursive_edit
);
11113 defsubr (&Sexit_recursive_edit
);
11114 defsubr (&Srecursion_depth
);
11115 defsubr (&Stop_level
);
11116 defsubr (&Sdiscard_input
);
11117 defsubr (&Sopen_dribble_file
);
11118 defsubr (&Sset_input_mode
);
11119 defsubr (&Scurrent_input_mode
);
11120 defsubr (&Sexecute_extended_command
);
11121 defsubr (&Sposn_at_point
);
11122 defsubr (&Sposn_at_x_y
);
11124 DEFVAR_LISP ("last-command-char", &last_command_char
,
11125 doc
: /* Last input event that was part of a command. */);
11127 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11128 doc
: /* Last input event that was part of a command. */);
11130 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11131 doc
: /* Last input event in a command, except for mouse menu events.
11132 Mouse menus give back keys that don't look like mouse events;
11133 this variable holds the actual mouse event that led to the menu,
11134 so that you can determine whether the command was run by mouse or not. */);
11136 DEFVAR_LISP ("last-input-char", &last_input_char
,
11137 doc
: /* Last input event. */);
11139 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11140 doc
: /* Last input event. */);
11142 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11143 doc
: /* List of events to be read as the command input.
11144 These events are processed first, before actual keyboard input. */);
11145 Vunread_command_events
= Qnil
;
11147 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11148 doc
: /* If not -1, an object to be read as next command input event. */);
11150 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11151 doc
: /* List of events to be processed as input by input methods.
11152 These events are processed after `unread-command-events', but
11153 before actual keyboard input. */);
11154 Vunread_post_input_method_events
= Qnil
;
11156 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11157 doc
: /* List of events to be processed as input by input methods.
11158 These events are processed after `unread-command-events', but
11159 before actual keyboard input. */);
11160 Vunread_input_method_events
= Qnil
;
11162 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11163 doc
: /* Meta-prefix character code.
11164 Meta-foo as command input turns into this character followed by foo. */);
11165 XSETINT (meta_prefix_char
, 033);
11167 DEFVAR_KBOARD ("last-command", Vlast_command
,
11168 doc
: /* The last command executed.
11169 Normally a symbol with a function definition, but can be whatever was found
11170 in the keymap, or whatever the variable `this-command' was set to by that
11173 The value `mode-exit' is special; it means that the previous command
11174 read an event that told it to exit, and it did so and unread that event.
11175 In other words, the present command is the event that made the previous
11178 The value `kill-region' is special; it means that the previous command
11179 was a kill command. */);
11181 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11182 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11184 DEFVAR_LISP ("this-command", &Vthis_command
,
11185 doc
: /* The command now being executed.
11186 The command can set this variable; whatever is put here
11187 will be in `last-command' during the following command. */);
11188 Vthis_command
= Qnil
;
11190 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11191 doc
: /* The command bound to the current key sequence before remapping.
11192 It equals `this-command' if the original command was not remapped through
11193 any of the active keymaps. Otherwise, the value of `this-command' is the
11194 result of looking up the original command in the active keymaps. */);
11195 Vthis_original_command
= Qnil
;
11197 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11198 doc
: /* *Number of input events between auto-saves.
11199 Zero means disable autosaving due to number of characters typed. */);
11200 auto_save_interval
= 300;
11202 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11203 doc
: /* *Number of seconds idle time before auto-save.
11204 Zero or nil means disable auto-saving due to idleness.
11205 After auto-saving due to this many seconds of idle time,
11206 Emacs also does a garbage collection if that seems to be warranted. */);
11207 XSETFASTINT (Vauto_save_timeout
, 30);
11209 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11210 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11211 The value may be integer or floating point. */);
11212 Vecho_keystrokes
= make_number (1);
11214 DEFVAR_INT ("polling-period", &polling_period
,
11215 doc
: /* *Interval between polling for input during Lisp execution.
11216 The reason for polling is to make C-g work to stop a running program.
11217 Polling is needed only when using X windows and SIGIO does not work.
11218 Polling is automatically disabled in all other cases. */);
11219 polling_period
= 2;
11221 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11222 doc
: /* *Maximum time between mouse clicks to make a double-click.
11223 Measured in milliseconds. nil means disable double-click recognition;
11224 t means double-clicks have no time limit and are detected
11225 by position only. */);
11226 Vdouble_click_time
= make_number (500);
11228 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11229 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11230 On window-system frames, value is the number of pixels the mouse may have
11231 moved horizontally or vertically between two clicks to make a double-click.
11232 On non window-system frames, value is interpreted in units of 1/8 characters
11235 This variable is also the threshold for motion of the mouse
11236 to count as a drag. */);
11237 double_click_fuzz
= 3;
11239 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11240 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11241 inhibit_local_menu_bar_menus
= 0;
11243 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11244 doc
: /* Number of complete key sequences read as input so far.
11245 This includes key sequences read from keyboard macros.
11246 The number is effectively the number of interactive command invocations. */);
11247 num_input_keys
= 0;
11249 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11250 doc
: /* Number of input events read from the keyboard so far.
11251 This does not include events generated by keyboard macros. */);
11252 num_nonmacro_input_events
= 0;
11254 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11255 doc
: /* The frame in which the most recently read event occurred.
11256 If the last event came from a keyboard macro, this is set to `macro'. */);
11257 Vlast_event_frame
= Qnil
;
11259 /* This variable is set up in sysdep.c. */
11260 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11261 doc
: /* The ERASE character as set by the user with stty. */);
11263 DEFVAR_LISP ("help-char", &Vhelp_char
,
11264 doc
: /* Character to recognize as meaning Help.
11265 When it is read, do `(eval help-form)', and display result if it's a string.
11266 If the value of `help-form' is nil, this char can be read normally. */);
11267 XSETINT (Vhelp_char
, Ctl ('H'));
11269 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11270 doc
: /* List of input events to recognize as meaning Help.
11271 These work just like the value of `help-char' (see that). */);
11272 Vhelp_event_list
= Qnil
;
11274 DEFVAR_LISP ("help-form", &Vhelp_form
,
11275 doc
: /* Form to execute when character `help-char' is read.
11276 If the form returns a string, that string is displayed.
11277 If `help-form' is nil, the help char is not recognized. */);
11280 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11281 doc
: /* Command to run when `help-char' character follows a prefix key.
11282 This command is used only when there is no actual binding
11283 for that character after that prefix key. */);
11284 Vprefix_help_command
= Qnil
;
11286 DEFVAR_LISP ("top-level", &Vtop_level
,
11287 doc
: /* Form to evaluate when Emacs starts up.
11288 Useful to set before you dump a modified Emacs. */);
11291 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11292 doc
: /* Translate table for keyboard input, or nil.
11293 If non-nil, the value should be a char-table. Each character read
11294 from the keyboard is looked up in this char-table. If the value found
11295 there is non-nil, then it is used instead of the actual input character.
11297 The value can also be a string or vector, but this is considered obsolete.
11298 If it is a string or vector of length N, character codes N and up are left
11299 untranslated. In a vector, an element which is nil means "no translation".
11301 This is applied to the characters supplied to input methods, not their
11302 output. See also `translation-table-for-input'. */);
11303 Vkeyboard_translate_table
= Qnil
;
11305 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11306 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11307 \(Even if the operating system has support for stopping a process.\) */);
11308 cannot_suspend
= 0;
11310 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11311 doc
: /* Non-nil means prompt with menus when appropriate.
11312 This is done when reading from a keymap that has a prompt string,
11313 for elements that have prompt strings.
11314 The menu is displayed on the screen
11315 if X menus were enabled at configuration
11316 time and the previous event was a mouse click prefix key.
11317 Otherwise, menu prompting uses the echo area. */);
11318 menu_prompting
= 1;
11320 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11321 doc
: /* Character to see next line of menu prompt.
11322 Type this character while in a menu prompt to rotate around the lines of it. */);
11323 XSETINT (menu_prompt_more_char
, ' ');
11325 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11326 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11327 Emacs applies the modifiers of the character stored here to each keyboard
11328 character it reads. For example, after evaluating the expression
11329 (setq extra-keyboard-modifiers ?\\C-x)
11330 all input characters will have the control modifier applied to them.
11332 Note that the character ?\\C-@, equivalent to the integer zero, does
11333 not count as a control character; rather, it counts as a character
11334 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11335 cancels any modification. */);
11336 extra_keyboard_modifiers
= 0;
11338 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11339 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11340 The command loop sets this to nil before each command,
11341 and tests the value when the command returns.
11342 Buffer modification stores t in this variable. */);
11343 Vdeactivate_mark
= Qnil
;
11345 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11346 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11347 Vcommand_hook_internal
= Qnil
;
11349 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11350 doc
: /* Normal hook run before each command is executed.
11351 If an unhandled error happens in running this hook,
11352 the hook value is set to nil, since otherwise the error
11353 might happen repeatedly and make Emacs nonfunctional. */);
11354 Vpre_command_hook
= Qnil
;
11356 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11357 doc
: /* Normal hook run after each command is executed.
11358 If an unhandled error happens in running this hook,
11359 the hook value is set to nil, since otherwise the error
11360 might happen repeatedly and make Emacs nonfunctional. */);
11361 Vpost_command_hook
= Qnil
;
11364 DEFVAR_LISP ("echo-area-clear-hook", ...,
11365 doc
: /* Normal hook run when clearing the echo area. */);
11367 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11368 staticpro (&Qecho_area_clear_hook
);
11369 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11371 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11372 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11373 Vlucid_menu_bar_dirty_flag
= Qnil
;
11375 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11376 doc
: /* List of menu bar items to move to the end of the menu bar.
11377 The elements of the list are event types that may have menu bar bindings. */);
11378 Vmenu_bar_final_items
= Qnil
;
11380 DEFVAR_KBOARD ("overriding-terminal-local-map",
11381 Voverriding_terminal_local_map
,
11382 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11383 If this variable is non-nil, it is used as a keymap instead of the
11384 buffer's local map, and the minor mode keymaps and text property keymaps.
11385 It also replaces `overriding-local-map'.
11387 This variable is intended to let commands such as `universal-argument'
11388 set up a different keymap for reading the next command. */);
11390 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11391 doc
: /* Keymap that overrides all other local keymaps.
11392 If this variable is non-nil, it is used as a keymap--replacing the
11393 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11394 Voverriding_local_map
= Qnil
;
11396 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11397 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11398 Otherwise, the menu bar continues to reflect the buffer's local map
11399 and the minor mode maps regardless of `overriding-local-map'. */);
11400 Voverriding_local_map_menu_flag
= Qnil
;
11402 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11403 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11404 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11406 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11407 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11409 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11410 doc
: /* Alist of system-specific X windows key symbols.
11411 Each element should have the form (N . SYMBOL) where N is the
11412 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11413 and SYMBOL is its name. */);
11415 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11416 doc
: /* List of deferred actions to be performed at a later time.
11417 The precise format isn't relevant here; we just check whether it is nil. */);
11418 Vdeferred_action_list
= Qnil
;
11420 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11421 doc
: /* Function to call to handle deferred actions, after each command.
11422 This function is called with no arguments after each command
11423 whenever `deferred-action-list' is non-nil. */);
11424 Vdeferred_action_function
= Qnil
;
11426 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11427 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11428 The value can be a length of time to show the message for.
11429 If the value is non-nil and not a number, we wait 2 seconds. */);
11430 Vsuggest_key_bindings
= Qt
;
11432 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11433 doc
: /* List of active absolute time timers in order of increasing time. */);
11434 Vtimer_list
= Qnil
;
11436 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11437 doc
: /* List of active idle-time timers in order of increasing time. */);
11438 Vtimer_idle_list
= Qnil
;
11440 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11441 doc
: /* If non-nil, the function that implements the current input method.
11442 It's called with one argument, a printing character that was just read.
11443 \(That means a character with code 040...0176.)
11444 Typically this function uses `read-event' to read additional events.
11445 When it does so, it should first bind `input-method-function' to nil
11446 so it will not be called recursively.
11448 The function should return a list of zero or more events
11449 to be used as input. If it wants to put back some events
11450 to be reconsidered, separately, by the input method,
11451 it can add them to the beginning of `unread-command-events'.
11453 The input method function can find in `input-method-previous-method'
11454 the previous echo area message.
11456 The input method function should refer to the variables
11457 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11458 for guidance on what to do. */);
11459 Vinput_method_function
= Qnil
;
11461 DEFVAR_LISP ("input-method-previous-message",
11462 &Vinput_method_previous_message
,
11463 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11464 This variable exists because `read-event' clears the echo area
11465 before running the input method. It is nil if there was no message. */);
11466 Vinput_method_previous_message
= Qnil
;
11468 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11469 doc
: /* If non-nil, the function that implements the display of help.
11470 It's called with one argument, the help string to display. */);
11471 Vshow_help_function
= Qnil
;
11473 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11474 doc
: /* If non-nil, suppress point adjustment after executing a command.
11476 After a command is executed, if point is moved into a region that has
11477 special properties (e.g. composition, display), we adjust point to
11478 the boundary of the region. But, when a command sets this variable to
11479 non-nil, we suppress the point adjustment.
11481 This variable is set to nil before reading a command, and is checked
11482 just after executing the command. */);
11483 Vdisable_point_adjustment
= Qnil
;
11485 DEFVAR_LISP ("global-disable-point-adjustment",
11486 &Vglobal_disable_point_adjustment
,
11487 doc
: /* *If non-nil, always suppress point adjustment.
11489 The default value is nil, in which case, point adjustment are
11490 suppressed only after special commands that set
11491 `disable-point-adjustment' (which see) to non-nil. */);
11492 Vglobal_disable_point_adjustment
= Qnil
;
11494 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11495 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11496 If the value is not a number, such messages don't time out. */);
11497 Vminibuffer_message_timeout
= make_number (2);
11499 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11500 doc
: /* If non-nil, any keyboard input throws to this symbol.
11501 The value of that variable is passed to `quit-flag' and later causes a
11502 peculiar kind of quitting. */);
11503 Vthrow_on_input
= Qnil
;
11505 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11506 &Venable_disabled_menus_and_buttons
,
11507 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11509 Help functions bind this to allow help on disabled menu items
11510 and tool-bar buttons. */);
11511 Venable_disabled_menus_and_buttons
= Qnil
;
11515 keys_of_keyboard ()
11517 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11518 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11519 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11520 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11521 initial_define_key (meta_map
, 'x', "execute-extended-command");
11523 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11524 "handle-delete-frame");
11525 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11526 current-prefix-arg, as is done in `handle-switch-frame'.
11527 But `handle-switch-frame is not run from the special-map.
11528 Commands from that map are run in a special way that automatically
11529 preserves the prefix-arg. Restoring the prefix arg here is not just
11530 redundant but harmful:
11532 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11533 - after the first prompt, the exit-minibuffer-hook is run which may
11534 iconify a frame and thus push a `iconify-frame' event.
11535 - after running exit-minibuffer-hook, current-prefix-arg is
11536 restored to the non-nil value it had before the prompt.
11537 - we enter the second prompt.
11538 current-prefix-arg is non-nil, prefix-arg is nil.
11539 - before running the first real event, we run the special iconify-frame
11540 event, but we pass the `special' arg to execute-command so
11541 current-prefix-arg and prefix-arg are left untouched.
11542 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11543 - the next key event will have a spuriously non-nil current-prefix-arg. */
11544 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11546 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11548 /* Handling it at such a low-level causes read_key_sequence to get
11549 * confused because it doesn't realize that the current_buffer was
11550 * changed by read_char.
11552 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11553 * "handle-select-window"); */
11554 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11555 "handle-save-session");
11558 /* Mark the pointers in the kboard objects.
11559 Called by the Fgarbage_collector. */
11565 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11567 if (kb
->kbd_macro_buffer
)
11568 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11570 mark_object (kb
->Voverriding_terminal_local_map
);
11571 mark_object (kb
->Vlast_command
);
11572 mark_object (kb
->Vreal_last_command
);
11573 mark_object (kb
->Vprefix_arg
);
11574 mark_object (kb
->Vlast_prefix_arg
);
11575 mark_object (kb
->kbd_queue
);
11576 mark_object (kb
->defining_kbd_macro
);
11577 mark_object (kb
->Vlast_kbd_macro
);
11578 mark_object (kb
->Vsystem_key_alist
);
11579 mark_object (kb
->system_key_syms
);
11580 mark_object (kb
->Vdefault_minibuffer_frame
);
11581 mark_object (kb
->echo_string
);
11584 struct input_event
*event
;
11585 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11587 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11588 event
= kbd_buffer
;
11589 if (event
->kind
!= SELECTION_REQUEST_EVENT
11590 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11592 mark_object (event
->x
);
11593 mark_object (event
->y
);
11595 mark_object (event
->frame_or_window
);
11596 mark_object (event
->arg
);
11601 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11602 (do not change this comment) */