1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
3 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>. */
29 #include "termhooks.h"
35 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
48 #ifdef HAVE_GTK_AND_PTHREAD
55 #include <sys/ioctl.h>
56 #endif /* not MSDOS */
58 #include "syssignal.h"
60 #include <sys/types.h>
69 /* This is to get the definitions of the XK_ symbols. */
76 #endif /* HAVE_NTGUI */
86 /* Variables for blockinput.h: */
88 /* Non-zero if interrupt input is blocked right now. */
89 volatile int interrupt_input_blocked
;
91 /* Nonzero means an input interrupt has arrived
92 during the current critical section. */
93 int interrupt_input_pending
;
95 /* This var should be (interrupt_input_pending || pending_atimers).
96 The QUIT macro checks this instead of interrupt_input_pending and
97 pending_atimers separately, to reduce code size. So, any code that
98 changes interrupt_input_pending or pending_atimers should update
104 #define KBD_BUFFER_SIZE 4096
106 KBOARD
*initial_kboard
;
107 KBOARD
*current_kboard
;
111 /* Non-nil disable property on a command means
112 do not execute it; call disabled-command-function's value instead. */
113 Lisp_Object Qdisabled
, Qdisabled_command_function
;
115 #define NUM_RECENT_KEYS (300)
116 int recent_keys_index
; /* Index for storing next element into recent_keys */
117 int total_keys
; /* Total number of elements stored into recent_keys */
118 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
120 /* Vector holding the key sequence that invoked the current command.
121 It is reused for each command, and it may be longer than the current
122 sequence; this_command_key_count indicates how many elements
123 actually mean something.
124 It's easier to staticpro a single Lisp_Object than an array. */
125 Lisp_Object this_command_keys
;
126 int this_command_key_count
;
128 /* 1 after calling Freset_this_command_lengths.
130 int this_command_key_count_reset
;
132 /* This vector is used as a buffer to record the events that were actually read
133 by read_key_sequence. */
134 Lisp_Object raw_keybuf
;
135 int raw_keybuf_count
;
137 /* Non-nil if the present key sequence was obtained by shift translation. */
138 Lisp_Object Vthis_command_keys_shift_translated
;
140 #define GROW_RAW_KEYBUF \
141 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
142 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
144 /* Number of elements of this_command_keys
145 that precede this key sequence. */
146 int this_single_command_key_start
;
148 /* Record values of this_command_key_count and echo_length ()
149 before this command was read. */
150 static int before_command_key_count
;
151 static int before_command_echo_length
;
153 extern int minbuf_level
;
155 extern int message_enable_multibyte
;
157 /* If non-nil, the function that implements the display of help.
158 It's called with one argument, the help string to display. */
160 Lisp_Object Vshow_help_function
;
162 /* Nonzero means do menu prompting. */
164 static int menu_prompting
;
166 /* Character to see next line of menu prompt. */
168 static Lisp_Object menu_prompt_more_char
;
170 /* For longjmp to where kbd input is being done. */
172 static jmp_buf getcjmp
;
174 /* True while doing kbd input. */
175 int waiting_for_input
;
177 /* True while displaying for echoing. Delays C-g throwing. */
181 /* Non-null means we can start echoing at the next input pause even
182 though there is something in the echo area. */
184 static struct kboard
*ok_to_echo_at_next_pause
;
186 /* The kboard last echoing, or null for none. Reset to 0 in
187 cancel_echoing. If non-null, and a current echo area message
188 exists, and echo_message_buffer is eq to the current message
189 buffer, we know that the message comes from echo_kboard. */
191 struct kboard
*echo_kboard
;
193 /* The buffer used for echoing. Set in echo_now, reset in
196 Lisp_Object echo_message_buffer
;
198 /* Nonzero means disregard local maps for the menu bar. */
199 static int inhibit_local_menu_bar_menus
;
201 /* Nonzero means C-g should cause immediate error-signal. */
204 /* The user's hook function for outputting an error message. */
205 Lisp_Object Vcommand_error_function
;
207 /* The user's ERASE setting. */
208 Lisp_Object Vtty_erase_char
;
210 /* Character to recognize as the help char. */
211 Lisp_Object Vhelp_char
;
213 /* List of other event types to recognize as meaning "help". */
214 Lisp_Object Vhelp_event_list
;
216 /* Form to execute when help char is typed. */
217 Lisp_Object Vhelp_form
;
219 /* Command to run when the help character follows a prefix key. */
220 Lisp_Object Vprefix_help_command
;
222 /* List of items that should move to the end of the menu bar. */
223 Lisp_Object Vmenu_bar_final_items
;
225 /* Non-nil means show the equivalent key-binding for
226 any M-x command that has one.
227 The value can be a length of time to show the message for.
228 If the value is non-nil and not a number, we wait 2 seconds. */
229 Lisp_Object Vsuggest_key_bindings
;
231 /* How long to display an echo-area message when the minibuffer is active.
232 If the value is not a number, such messages don't time out. */
233 Lisp_Object Vminibuffer_message_timeout
;
235 /* Character that causes a quit. Normally C-g.
237 If we are running on an ordinary terminal, this must be an ordinary
238 ASCII char, since we want to make it our interrupt character.
240 If we are not running on an ordinary terminal, it still needs to be
241 an ordinary ASCII char. This character needs to be recognized in
242 the input interrupt handler. At this point, the keystroke is
243 represented as a struct input_event, while the desired quit
244 character is specified as a lispy event. The mapping from struct
245 input_events to lispy events cannot run in an interrupt handler,
246 and the reverse mapping is difficult for anything but ASCII
249 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
253 extern Lisp_Object current_global_map
;
254 extern int minibuf_level
;
256 /* If non-nil, this is a map that overrides all other local maps. */
257 Lisp_Object Voverriding_local_map
;
259 /* If non-nil, Voverriding_local_map applies to the menu bar. */
260 Lisp_Object Voverriding_local_map_menu_flag
;
262 /* Keymap that defines special misc events that should
263 be processed immediately at a low level. */
264 Lisp_Object Vspecial_event_map
;
266 /* Current depth in recursive edits. */
267 int command_loop_level
;
269 /* Total number of times command_loop has read a key sequence. */
270 EMACS_INT num_input_keys
;
272 /* Last input event read as a command. */
273 Lisp_Object last_command_event
;
275 /* Last input character read as a command, not counting menus
276 reached by the mouse. */
277 Lisp_Object last_nonmenu_event
;
279 /* Last input event read for any purpose. */
280 Lisp_Object last_input_event
;
282 /* If not Qnil, a list of objects to be read as subsequent command input. */
283 Lisp_Object Vunread_command_events
;
285 /* If not Qnil, a list of objects to be read as subsequent command input
286 including input method processing. */
287 Lisp_Object Vunread_input_method_events
;
289 /* If not Qnil, a list of objects to be read as subsequent command input
290 but NOT including input method processing. */
291 Lisp_Object Vunread_post_input_method_events
;
293 /* If not -1, an event to be read as subsequent command input. */
294 EMACS_INT unread_command_char
;
296 /* If not Qnil, this is a switch-frame event which we decided to put
297 off until the end of a key sequence. This should be read as the
298 next command input, after any unread_command_events.
300 read_key_sequence uses this to delay switch-frame events until the
301 end of the key sequence; Fread_char uses it to put off switch-frame
302 events until a non-ASCII event is acceptable as input. */
303 Lisp_Object unread_switch_frame
;
305 /* A mask of extra modifier bits to put into every keyboard char. */
306 EMACS_INT extra_keyboard_modifiers
;
308 /* Char to use as prefix when a meta character is typed in.
309 This is bound on entry to minibuffer in case ESC is changed there. */
311 Lisp_Object meta_prefix_char
;
313 /* Last size recorded for a current buffer which is not a minibuffer. */
314 static int last_non_minibuf_size
;
316 /* Number of idle seconds before an auto-save and garbage collection. */
317 static Lisp_Object Vauto_save_timeout
;
319 /* Total number of times read_char has returned. */
320 int num_input_events
;
322 /* Total number of times read_char has returned, outside of macros. */
323 EMACS_INT num_nonmacro_input_events
;
325 /* Auto-save automatically when this many characters have been typed
326 since the last time. */
328 static EMACS_INT auto_save_interval
;
330 /* Value of num_nonmacro_input_events as of last auto save. */
334 /* The command being executed by the command loop.
335 Commands may set this, and the value set will be copied into
336 current_kboard->Vlast_command instead of the actual command. */
337 Lisp_Object Vthis_command
;
339 /* This is like Vthis_command, except that commands never set it. */
340 Lisp_Object real_this_command
;
342 /* If the lookup of the command returns a binding, the original
343 command is stored in this-original-command. It is nil otherwise. */
344 Lisp_Object Vthis_original_command
;
346 /* The value of point when the last command was started. */
347 int last_point_position
;
349 /* The buffer that was current when the last command was started. */
350 Lisp_Object last_point_position_buffer
;
352 /* The window that was selected when the last command was started. */
353 Lisp_Object last_point_position_window
;
355 /* The frame in which the last input event occurred, or Qmacro if the
356 last event came from a macro. We use this to determine when to
357 generate switch-frame events. This may be cleared by functions
358 like Fselect_frame, to make sure that a switch-frame event is
359 generated by the next character. */
360 Lisp_Object internal_last_event_frame
;
362 /* A user-visible version of the above, intended to allow users to
363 figure out where the last event came from, if the event doesn't
364 carry that information itself (i.e. if it was a character). */
365 Lisp_Object Vlast_event_frame
;
367 /* The timestamp of the last input event we received from the X server.
368 X Windows wants this for selection ownership. */
369 unsigned long last_event_timestamp
;
371 Lisp_Object Qself_insert_command
;
372 Lisp_Object Qforward_char
;
373 Lisp_Object Qbackward_char
;
374 Lisp_Object Qundefined
;
375 Lisp_Object Qtimer_event_handler
;
377 /* read_key_sequence stores here the command definition of the
378 key sequence that it reads. */
379 Lisp_Object read_key_sequence_cmd
;
381 /* Echo unfinished commands after this many seconds of pause. */
382 Lisp_Object Vecho_keystrokes
;
384 /* Form to evaluate (if non-nil) when Emacs is started. */
385 Lisp_Object Vtop_level
;
387 /* If non-nil, this implements the current input method. */
388 Lisp_Object Vinput_method_function
;
389 Lisp_Object Qinput_method_function
;
391 /* When we call Vinput_method_function,
392 this holds the echo area message that was just erased. */
393 Lisp_Object Vinput_method_previous_message
;
395 /* Non-nil means deactivate the mark at end of this command. */
396 Lisp_Object Vdeactivate_mark
;
397 Lisp_Object Qdeactivate_mark
;
399 /* Menu bar specified in Lucid Emacs fashion. */
401 Lisp_Object Vlucid_menu_bar_dirty_flag
;
402 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
404 Lisp_Object Qecho_area_clear_hook
;
406 /* Hooks to run before and after each command. */
407 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
408 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
409 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
411 /* Parent keymap of terminal-local function-key-map instances. */
412 Lisp_Object Vfunction_key_map
;
414 /* Keymap of key translations that can override keymaps. */
415 Lisp_Object Vkey_translation_map
;
417 /* List of deferred actions to be performed at a later time.
418 The precise format isn't relevant here; we just check whether it is nil. */
419 Lisp_Object Vdeferred_action_list
;
421 /* Function to call to handle deferred actions, when there are any. */
422 Lisp_Object Vdeferred_action_function
;
423 Lisp_Object Qdeferred_action_function
;
425 Lisp_Object Qinput_method_exit_on_first_char
;
426 Lisp_Object Qinput_method_use_echo_area
;
428 /* File in which we write all commands we read. */
431 /* Nonzero if input is available. */
434 extern char *pending_malloc_warning
;
436 /* Circular buffer for pre-read keyboard input. */
438 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
440 /* Pointer to next available character in kbd_buffer.
441 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
442 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
443 next available char is in kbd_buffer[0]. */
444 static struct input_event
*kbd_fetch_ptr
;
446 /* Pointer to next place to store character in kbd_buffer. This
447 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
448 character should go in kbd_buffer[0]. */
449 static struct input_event
* volatile kbd_store_ptr
;
451 /* The above pair of variables forms a "queue empty" flag. When we
452 enqueue a non-hook event, we increment kbd_store_ptr. When we
453 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
454 there is input available if the two pointers are not equal.
456 Why not just have a flag set and cleared by the enqueuing and
457 dequeuing functions? Such a flag could be screwed up by interrupts
458 at inopportune times. */
460 /* If this flag is non-nil, we check mouse_moved to see when the
461 mouse moves, and motion events will appear in the input stream.
462 Otherwise, mouse motion is ignored. */
463 Lisp_Object do_mouse_tracking
;
465 /* Symbols to head events. */
466 Lisp_Object Qmouse_movement
;
467 Lisp_Object Qscroll_bar_movement
;
468 Lisp_Object Qswitch_frame
;
469 Lisp_Object Qdelete_frame
;
470 Lisp_Object Qiconify_frame
;
471 Lisp_Object Qmake_frame_visible
;
472 Lisp_Object Qselect_window
;
473 Lisp_Object Qhelp_echo
;
475 extern Lisp_Object Qremap
;
477 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
478 Lisp_Object Qmouse_fixup_help_message
;
481 /* Symbols to denote kinds of events. */
482 Lisp_Object Qfunction_key
;
483 Lisp_Object Qmouse_click
;
484 #if defined (WINDOWSNT)
485 Lisp_Object Qlanguage_change
;
487 Lisp_Object Qdrag_n_drop
;
488 Lisp_Object Qsave_session
;
490 Lisp_Object Qdbus_event
;
492 /* Lisp_Object Qmouse_movement; - also an event header */
494 /* Properties of event headers. */
495 Lisp_Object Qevent_kind
;
496 Lisp_Object Qevent_symbol_elements
;
498 /* menu item parts */
499 Lisp_Object Qmenu_enable
;
500 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
501 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
502 extern Lisp_Object Qmenu_item
;
504 /* An event header symbol HEAD may have a property named
505 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
506 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
507 mask of modifiers applied to it. If present, this is used to help
508 speed up parse_modifiers. */
509 Lisp_Object Qevent_symbol_element_mask
;
511 /* An unmodified event header BASE may have a property named
512 Qmodifier_cache, which is an alist mapping modifier masks onto
513 modified versions of BASE. If present, this helps speed up
515 Lisp_Object Qmodifier_cache
;
517 /* Symbols to use for parts of windows. */
518 Lisp_Object Qmode_line
;
519 Lisp_Object Qvertical_line
;
520 Lisp_Object Qvertical_scroll_bar
;
521 Lisp_Object Qmenu_bar
;
522 extern Lisp_Object Qleft_margin
, Qright_margin
;
523 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
524 extern Lisp_Object QCmap
;
526 Lisp_Object
recursive_edit_unwind (), command_loop ();
527 Lisp_Object
Fthis_command_keys ();
528 Lisp_Object Qextended_command_history
;
529 EMACS_TIME
timer_check ();
531 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
533 extern char *x_get_keysym_name ();
535 static void record_menu_key ();
536 static int echo_length ();
538 Lisp_Object Qpolling_period
;
540 /* List of absolute timers. Appears in order of next scheduled event. */
541 Lisp_Object Vtimer_list
;
543 /* List of idle time timers. Appears in order of next scheduled event. */
544 Lisp_Object Vtimer_idle_list
;
546 /* Incremented whenever a timer is run. */
549 extern Lisp_Object Vprint_level
, Vprint_length
;
551 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
553 EMACS_TIME
*input_available_clear_time
;
555 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
556 Default is 1 if INTERRUPT_INPUT is defined. */
559 /* Nonzero while interrupts are temporarily deferred during redisplay. */
560 int interrupts_deferred
;
562 /* Allow m- file to inhibit use of FIONREAD. */
563 #ifdef BROKEN_FIONREAD
567 /* We are unable to use interrupts if FIONREAD is not available,
568 so flush SIGIO so we won't try. */
569 #if !defined (FIONREAD)
575 /* If we support a window system, turn on the code to poll periodically
576 to detect C-g. It isn't actually used when doing interrupt input. */
577 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
578 #define POLL_FOR_INPUT
581 /* After a command is executed, if point is moved into a region that
582 has specific properties (e.g. composition, display), we adjust
583 point to the boundary of the region. But, if a command sets this
584 variable to non-nil, we suppress this point adjustment. This
585 variable is set to nil before reading a command. */
587 Lisp_Object Vdisable_point_adjustment
;
589 /* If non-nil, always disable point adjustment. */
591 Lisp_Object Vglobal_disable_point_adjustment
;
593 /* The time when Emacs started being idle. */
595 static EMACS_TIME timer_idleness_start_time
;
597 /* After Emacs stops being idle, this saves the last value
598 of timer_idleness_start_time from when it was idle. */
600 static EMACS_TIME timer_last_idleness_start_time
;
602 /* If non-nil, events produced by disabled menu items and tool-bar
603 buttons are not ignored. Help functions bind this to allow help on
604 those items and buttons. */
605 Lisp_Object Venable_disabled_menus_and_buttons
;
608 /* Global variable declarations. */
610 /* Flags for readable_events. */
611 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
612 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
613 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
615 /* Function for init_keyboard to call with no args (if nonzero). */
616 void (*keyboard_init_hook
) ();
618 static int read_avail_input
P_ ((int));
619 static void get_input_pending
P_ ((int *, int));
620 static int readable_events
P_ ((int));
621 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
622 Lisp_Object
, int *));
623 static Lisp_Object
read_char_x_menu_prompt ();
624 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
626 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
627 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
628 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
629 enum scroll_bar_part
,
630 Lisp_Object
, Lisp_Object
,
633 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
634 Lisp_Object
, char **,
635 Lisp_Object
*, unsigned));
636 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
637 static void save_getcjmp
P_ ((jmp_buf));
638 static void save_getcjmp ();
639 static void restore_getcjmp
P_ ((jmp_buf));
640 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
641 static void clear_event
P_ ((struct input_event
*));
642 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
643 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
644 static void handle_interrupt
P_ ((void));
645 static void timer_start_idle
P_ ((void));
646 static void timer_stop_idle
P_ ((void));
647 static void timer_resume_idle
P_ ((void));
648 static SIGTYPE handle_user_signal
P_ ((int));
649 static char *find_user_signal_name
P_ ((int));
650 static int store_user_signal_events
P_ ((void));
652 /* Nonzero means don't try to suspend even if the operating system seems
654 static int cannot_suspend
;
656 extern Lisp_Object Qidentity
, Qonly
;
658 /* Install the string STR as the beginning of the string of echoing,
659 so that it serves as a prompt for the next character.
660 Also start echoing. */
666 current_kboard
->echo_string
= str
;
667 current_kboard
->echo_after_prompt
= SCHARS (str
);
671 /* Add C to the echo string, if echoing is going on.
672 C can be a character, which is printed prettily ("M-C-x" and all that
673 jazz), or a symbol, whose name is printed. */
679 if (current_kboard
->immediate_echo
)
681 int size
= KEY_DESCRIPTION_SIZE
+ 100;
682 char *buffer
= (char *) alloca (size
);
684 Lisp_Object echo_string
;
686 echo_string
= current_kboard
->echo_string
;
688 /* If someone has passed us a composite event, use its head symbol. */
693 ptr
= push_key_description (XINT (c
), ptr
, 1);
695 else if (SYMBOLP (c
))
697 Lisp_Object name
= SYMBOL_NAME (c
);
698 int nbytes
= SBYTES (name
);
700 if (size
- (ptr
- buffer
) < nbytes
)
702 int offset
= ptr
- buffer
;
703 size
= max (2 * size
, size
+ nbytes
);
704 buffer
= (char *) alloca (size
);
705 ptr
= buffer
+ offset
;
708 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
709 STRING_MULTIBYTE (name
), 1);
712 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
715 const char *text
= " (Type ? for further options)";
716 int len
= strlen (text
);
718 if (size
- (ptr
- buffer
) < len
)
720 int offset
= ptr
- buffer
;
722 buffer
= (char *) alloca (size
);
723 ptr
= buffer
+ offset
;
726 bcopy (text
, ptr
, len
);
730 /* Replace a dash from echo_dash with a space, otherwise
731 add a space at the end as a separator between keys. */
732 if (STRINGP (echo_string
)
733 && SCHARS (echo_string
) > 1)
735 Lisp_Object last_char
, prev_char
, idx
;
737 idx
= make_number (SCHARS (echo_string
) - 2);
738 prev_char
= Faref (echo_string
, idx
);
740 idx
= make_number (SCHARS (echo_string
) - 1);
741 last_char
= Faref (echo_string
, idx
);
743 /* We test PREV_CHAR to make sure this isn't the echoing
745 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
746 Faset (echo_string
, idx
, make_number (' '));
748 echo_string
= concat2 (echo_string
, build_string (" "));
750 else if (STRINGP (echo_string
))
751 echo_string
= concat2 (echo_string
, build_string (" "));
753 current_kboard
->echo_string
754 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
760 /* Temporarily add a dash to the end of the echo string if it's not
761 empty, so that it serves as a mini-prompt for the very next character. */
766 /* Do nothing if not echoing at all. */
767 if (NILP (current_kboard
->echo_string
))
770 if (!current_kboard
->immediate_echo
771 && SCHARS (current_kboard
->echo_string
) == 0)
774 /* Do nothing if we just printed a prompt. */
775 if (current_kboard
->echo_after_prompt
776 == SCHARS (current_kboard
->echo_string
))
779 /* Do nothing if we have already put a dash at the end. */
780 if (SCHARS (current_kboard
->echo_string
) > 1)
782 Lisp_Object last_char
, prev_char
, idx
;
784 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
785 prev_char
= Faref (current_kboard
->echo_string
, idx
);
787 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
788 last_char
= Faref (current_kboard
->echo_string
, idx
);
790 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
794 /* Put a dash at the end of the buffer temporarily,
795 but make it go away when the next character is added. */
796 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
801 /* Display the current echo string, and begin echoing if not already
807 if (!current_kboard
->immediate_echo
)
810 current_kboard
->immediate_echo
= 1;
812 for (i
= 0; i
< this_command_key_count
; i
++)
816 /* Set before_command_echo_length to the value that would
817 have been saved before the start of this subcommand in
818 command_loop_1, if we had already been echoing then. */
819 if (i
== this_single_command_key_start
)
820 before_command_echo_length
= echo_length ();
822 c
= XVECTOR (this_command_keys
)->contents
[i
];
823 if (! (EVENT_HAS_PARAMETERS (c
)
824 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
828 /* Set before_command_echo_length to the value that would
829 have been saved before the start of this subcommand in
830 command_loop_1, if we had already been echoing then. */
831 if (this_command_key_count
== this_single_command_key_start
)
832 before_command_echo_length
= echo_length ();
834 /* Put a dash at the end to invite the user to type more. */
839 message3_nolog (current_kboard
->echo_string
,
840 SBYTES (current_kboard
->echo_string
),
841 STRING_MULTIBYTE (current_kboard
->echo_string
));
844 /* Record in what buffer we echoed, and from which kboard. */
845 echo_message_buffer
= echo_area_buffer
[0];
846 echo_kboard
= current_kboard
;
848 if (waiting_for_input
&& !NILP (Vquit_flag
))
849 quit_throw_to_read_char ();
852 /* Turn off echoing, for the start of a new command. */
857 current_kboard
->immediate_echo
= 0;
858 current_kboard
->echo_after_prompt
= -1;
859 current_kboard
->echo_string
= Qnil
;
860 ok_to_echo_at_next_pause
= NULL
;
862 echo_message_buffer
= Qnil
;
865 /* Return the length of the current echo string. */
870 return (STRINGP (current_kboard
->echo_string
)
871 ? SCHARS (current_kboard
->echo_string
)
875 /* Truncate the current echo message to its first LEN chars.
876 This and echo_char get used by read_key_sequence when the user
877 switches frames while entering a key sequence. */
880 echo_truncate (nchars
)
883 if (STRINGP (current_kboard
->echo_string
))
884 current_kboard
->echo_string
885 = Fsubstring (current_kboard
->echo_string
,
886 make_number (0), make_number (nchars
));
887 truncate_echo_area (nchars
);
891 /* Functions for manipulating this_command_keys. */
893 add_command_key (key
)
896 #if 0 /* Not needed after we made Freset_this_command_lengths
897 do the job immediately. */
898 /* If reset-this-command-length was called recently, obey it now.
899 See the doc string of that function for an explanation of why. */
900 if (before_command_restore_flag
)
902 this_command_key_count
= before_command_key_count_1
;
903 if (this_command_key_count
< this_single_command_key_start
)
904 this_single_command_key_start
= this_command_key_count
;
905 echo_truncate (before_command_echo_length_1
);
906 before_command_restore_flag
= 0;
910 if (this_command_key_count
>= ASIZE (this_command_keys
))
911 this_command_keys
= larger_vector (this_command_keys
,
912 2 * ASIZE (this_command_keys
),
915 ASET (this_command_keys
, this_command_key_count
, key
);
916 ++this_command_key_count
;
923 int count
= SPECPDL_INDEX ();
926 if (command_loop_level
> 0)
928 specbind (Qstandard_output
, Qt
);
929 specbind (Qstandard_input
, Qt
);
932 #ifdef HAVE_WINDOW_SYSTEM
933 /* The command loop has started an hourglass timer, so we have to
934 cancel it here, otherwise it will fire because the recursive edit
935 can take some time. Do not check for display_hourglass_p here,
936 because it could already be nil. */
940 /* This function may have been called from a debugger called from
941 within redisplay, for instance by Edebugging a function called
942 from fontification-functions. We want to allow redisplay in
943 the debugging session.
945 The recursive edit is left with a `(throw exit ...)'. The `exit'
946 tag is not caught anywhere in redisplay, i.e. when we leave the
947 recursive edit, the original redisplay leading to the recursive
948 edit will be unwound. The outcome should therefore be safe. */
949 specbind (Qinhibit_redisplay
, Qnil
);
952 val
= command_loop ();
954 Fsignal (Qquit
, Qnil
);
955 /* Handle throw from read_minibuf when using minibuffer
956 while it's active but we're in another window. */
958 xsignal1 (Qerror
, val
);
960 return unbind_to (count
, Qnil
);
963 /* When an auto-save happens, record the "time", and don't do again soon. */
968 last_auto_save
= num_nonmacro_input_events
;
971 /* Make an auto save happen as soon as possible at command level. */
974 force_auto_save_soon ()
976 last_auto_save
= - auto_save_interval
- 1;
978 record_asynch_buffer_change ();
981 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
982 doc
: /* Invoke the editor command loop recursively.
983 To get out of the recursive edit, a command can do `(throw 'exit nil)';
984 that tells this function to return.
985 Alternatively, `(throw 'exit t)' makes this function signal an error.
986 This function is called by the editor initialization to begin editing. */)
989 int count
= SPECPDL_INDEX ();
992 /* If we enter while input is blocked, don't lock up here.
993 This may happen through the debugger during redisplay. */
997 command_loop_level
++;
998 update_mode_lines
= 1;
1000 if (command_loop_level
1001 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1002 buffer
= Fcurrent_buffer ();
1006 /* If we leave recursive_edit_1 below with a `throw' for instance,
1007 like it is done in the splash screen display, we have to
1008 make sure that we restore single_kboard as command_loop_1
1009 would have done if it were left normally. */
1010 if (command_loop_level
> 0)
1011 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1012 record_unwind_protect (recursive_edit_unwind
, buffer
);
1014 recursive_edit_1 ();
1015 return unbind_to (count
, Qnil
);
1019 recursive_edit_unwind (buffer
)
1022 if (BUFFERP (buffer
))
1023 Fset_buffer (buffer
);
1025 command_loop_level
--;
1026 update_mode_lines
= 1;
1031 #if 0 /* These two functions are now replaced with
1032 temporarily_switch_to_single_kboard. */
1036 #if 0 /* Theory: if there's anything in Vunread_command_events,
1037 it will right away be read by read_key_sequence,
1038 and then if we do switch KBOARDS, it will go into the side
1039 queue then. So we don't need to do anything special here -- rms. */
1040 if (CONSP (Vunread_command_events
))
1042 current_kboard
->kbd_queue
1043 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1044 current_kboard
->kbd_queue_has_data
= 1;
1046 Vunread_command_events
= Qnil
;
1051 /* Switch to the single-kboard state, making current_kboard
1052 the only KBOARD from which further input is accepted. */
1055 single_kboard_state ()
1061 /* If we're in single_kboard state for kboard KBOARD,
1065 not_single_kboard_state (kboard
)
1068 if (kboard
== current_kboard
)
1072 /* Maintain a stack of kboards, so other parts of Emacs
1073 can switch temporarily to the kboard of a given frame
1074 and then revert to the previous status. */
1079 struct kboard_stack
*next
;
1082 static struct kboard_stack
*kboard_stack
;
1088 struct kboard_stack
*p
1089 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1091 p
->next
= kboard_stack
;
1092 p
->kboard
= current_kboard
;
1102 struct kboard_stack
*p
= kboard_stack
;
1104 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1106 if (t
->kboard
== p
->kboard
)
1108 current_kboard
= p
->kboard
;
1115 /* The terminal we remembered has been deleted. */
1116 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1119 kboard_stack
= p
->next
;
1123 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1124 from which further input is accepted. If F is non-nil, set its
1125 KBOARD as the current keyboard.
1127 This function uses record_unwind_protect to return to the previous
1130 If Emacs is already in single_kboard mode, and F's keyboard is
1131 locked, then this function will throw an errow. */
1134 temporarily_switch_to_single_kboard (f
)
1137 int was_locked
= single_kboard
;
1140 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1141 /* We can not switch keyboards while in single_kboard mode.
1142 In rare cases, Lisp code may call `recursive-edit' (or
1143 `read-minibuffer' or `y-or-n-p') after it switched to a
1144 locked frame. For example, this is likely to happen
1145 when server.el connects to a new terminal while Emacs is in
1146 single_kboard mode. It is best to throw an error instead
1147 of presenting the user with a frozen screen. */
1148 error ("Terminal %d is locked, cannot read from it",
1149 FRAME_TERMINAL (f
)->id
);
1151 /* This call is unnecessary, but helps
1152 `restore_kboard_configuration' discover if somebody changed
1153 `current_kboard' behind our back. */
1154 push_kboard (current_kboard
);
1157 current_kboard
= FRAME_KBOARD (f
);
1159 record_unwind_protect (restore_kboard_configuration
,
1160 (was_locked
? Qt
: Qnil
));
1163 #if 0 /* This function is not needed anymore. */
1165 record_single_kboard_state ()
1168 push_kboard (current_kboard
);
1169 record_unwind_protect (restore_kboard_configuration
,
1170 (single_kboard
? Qt
: Qnil
));
1175 restore_kboard_configuration (was_locked
)
1176 Lisp_Object was_locked
;
1178 if (NILP (was_locked
))
1182 struct kboard
*prev
= current_kboard
;
1185 /* The pop should not change the kboard. */
1186 if (single_kboard
&& current_kboard
!= prev
)
1193 /* Handle errors that are not handled at inner levels
1194 by printing an error message and returning to the editor command loop. */
1200 Lisp_Object old_level
, old_length
;
1201 char macroerror
[50];
1203 #ifdef HAVE_WINDOW_SYSTEM
1204 if (display_hourglass_p
)
1205 cancel_hourglass ();
1208 if (!NILP (executing_kbd_macro
))
1210 if (executing_kbd_macro_iterations
== 1)
1211 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1213 sprintf (macroerror
, "After %d kbd macro iterations: ",
1214 executing_kbd_macro_iterations
);
1219 Vstandard_output
= Qt
;
1220 Vstandard_input
= Qt
;
1221 Vexecuting_kbd_macro
= Qnil
;
1222 executing_kbd_macro
= Qnil
;
1223 current_kboard
->Vprefix_arg
= Qnil
;
1224 current_kboard
->Vlast_prefix_arg
= Qnil
;
1227 /* Avoid unquittable loop if data contains a circular list. */
1228 old_level
= Vprint_level
;
1229 old_length
= Vprint_length
;
1230 XSETFASTINT (Vprint_level
, 10);
1231 XSETFASTINT (Vprint_length
, 10);
1232 cmd_error_internal (data
, macroerror
);
1233 Vprint_level
= old_level
;
1234 Vprint_length
= old_length
;
1238 Vinhibit_quit
= Qnil
;
1239 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1240 if (command_loop_level
== 0 && minibuf_level
== 0)
1241 any_kboard_state ();
1244 return make_number (0);
1247 /* Take actions on handling an error. DATA is the data that describes
1250 CONTEXT is a C-string containing ASCII characters only which
1251 describes the context in which the error happened. If we need to
1252 generalize CONTEXT to allow multibyte characters, make it a Lisp
1256 cmd_error_internal (data
, context
)
1260 struct frame
*sf
= SELECTED_FRAME ();
1262 /* The immediate context is not interesting for Quits,
1263 since they are asyncronous. */
1264 if (EQ (XCAR (data
), Qquit
))
1265 Vsignaling_function
= Qnil
;
1270 /* Use user's specified output function if any. */
1271 if (!NILP (Vcommand_error_function
))
1272 call3 (Vcommand_error_function
, data
,
1273 context
? build_string (context
) : empty_unibyte_string
,
1274 Vsignaling_function
);
1275 /* If the window system or terminal frame hasn't been initialized
1276 yet, or we're not interactive, write the message to stderr and exit. */
1277 else if (!sf
->glyphs_initialized_p
1278 /* The initial frame is a special non-displaying frame. It
1279 will be current in daemon mode when there are no frames
1280 to display, and in non-daemon mode before the real frame
1281 has finished initializing. If an error is thrown in the
1282 latter case while creating the frame, then the frame
1283 will never be displayed, so the safest thing to do is
1284 write to stderr and quit. In daemon mode, there are
1285 many other potential errors that do not prevent frames
1286 from being created, so continuing as normal is better in
1288 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1291 print_error_message (data
, Qexternal_debugging_output
,
1292 context
, Vsignaling_function
);
1293 Fterpri (Qexternal_debugging_output
);
1294 Fkill_emacs (make_number (-1));
1298 clear_message (1, 0);
1300 message_log_maybe_newline ();
1303 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1306 Vsignaling_function
= Qnil
;
1309 Lisp_Object
command_loop_1 ();
1310 Lisp_Object
command_loop_2 ();
1311 Lisp_Object
top_level_1 ();
1313 /* Entry to editor-command-loop.
1314 This level has the catches for exiting/returning to editor command loop.
1315 It returns nil to exit recursive edit, t to abort it. */
1320 if (command_loop_level
> 0 || minibuf_level
> 0)
1323 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1324 executing_kbd_macro
= Qnil
;
1330 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1331 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1332 /* Reset single_kboard in case top-level set it while
1333 evaluating an -f option, or we are stuck there for some
1335 any_kboard_state ();
1337 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1338 executing_kbd_macro
= Qnil
;
1340 /* End of file in -batch run causes exit here. */
1346 /* Here we catch errors in execution of commands within the
1347 editing loop, and reenter the editing loop.
1348 When there is an error, cmd_error runs and returns a non-nil
1349 value to us. A value of nil means that command_loop_1 itself
1350 returned due to end of file (or end of kbd macro). */
1355 register Lisp_Object val
;
1358 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1359 while (!NILP (val
));
1367 return Feval (Vtop_level
);
1373 /* On entry to the outer level, run the startup file */
1374 if (!NILP (Vtop_level
))
1375 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1376 else if (!NILP (Vpurify_flag
))
1377 message ("Bare impure Emacs (standard Lisp code not loaded)");
1379 message ("Bare Emacs (standard Lisp code not loaded)");
1383 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1384 doc
: /* Exit all recursive editing levels.
1385 This also exits all active minibuffers. */)
1388 #ifdef HAVE_WINDOW_SYSTEM
1389 if (display_hourglass_p
)
1390 cancel_hourglass ();
1393 /* Unblock input if we enter with input blocked. This may happen if
1394 redisplay traps e.g. during tool-bar update with input blocked. */
1395 while (INPUT_BLOCKED_P
)
1398 return Fthrow (Qtop_level
, Qnil
);
1401 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1402 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1405 if (command_loop_level
> 0 || minibuf_level
> 0)
1406 Fthrow (Qexit
, Qnil
);
1408 error ("No recursive edit is in progress");
1412 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1413 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1416 if (command_loop_level
> 0 || minibuf_level
> 0)
1419 error ("No recursive edit is in progress");
1423 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1425 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1426 of this function. */
1429 tracking_off (old_value
)
1430 Lisp_Object old_value
;
1432 do_mouse_tracking
= old_value
;
1433 if (NILP (old_value
))
1435 /* Redisplay may have been preempted because there was input
1436 available, and it assumes it will be called again after the
1437 input has been processed. If the only input available was
1438 the sort that we have just disabled, then we need to call
1440 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1442 redisplay_preserve_echo_area (6);
1443 get_input_pending (&input_pending
,
1444 READABLE_EVENTS_DO_TIMERS_NOW
);
1450 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1451 doc
: /* Evaluate BODY with mouse movement events enabled.
1452 Within a `track-mouse' form, mouse motion generates input events that
1453 you can read with `read-event'.
1454 Normally, mouse motion is ignored.
1455 usage: (track-mouse BODY...) */)
1459 int count
= SPECPDL_INDEX ();
1462 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1464 do_mouse_tracking
= Qt
;
1466 val
= Fprogn (args
);
1467 return unbind_to (count
, val
);
1470 /* If mouse has moved on some frame, return one of those frames.
1474 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1475 after resizing the tool-bar window. */
1477 int ignore_mouse_drag_p
;
1482 Lisp_Object tail
, frame
;
1484 if (ignore_mouse_drag_p
)
1486 /* ignore_mouse_drag_p = 0; */
1490 FOR_EACH_FRAME (tail
, frame
)
1492 if (XFRAME (frame
)->mouse_moved
)
1493 return XFRAME (frame
);
1499 #endif /* HAVE_MOUSE || HAVE_GPM */
1501 /* This is the actual command reading loop,
1502 sans error-handling encapsulation. */
1504 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1506 void safe_run_hooks
P_ ((Lisp_Object
));
1507 static void adjust_point_for_property
P_ ((int, int));
1509 /* Cancel hourglass from protect_unwind.
1511 #ifdef HAVE_WINDOW_SYSTEM
1513 cancel_hourglass_unwind (arg
)
1516 cancel_hourglass ();
1521 extern int nonundocount
; /* Declared in cmds.c. */
1528 Lisp_Object keybuf
[30];
1530 int prev_modiff
= 0;
1531 struct buffer
*prev_buffer
= NULL
;
1532 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1533 int was_locked
= single_kboard
;
1535 int already_adjusted
= 0;
1537 current_kboard
->Vprefix_arg
= Qnil
;
1538 current_kboard
->Vlast_prefix_arg
= Qnil
;
1539 Vdeactivate_mark
= Qnil
;
1540 waiting_for_input
= 0;
1543 this_command_key_count
= 0;
1544 this_command_key_count_reset
= 0;
1545 this_single_command_key_start
= 0;
1547 if (NILP (Vmemory_full
))
1549 /* Make sure this hook runs after commands that get errors and
1550 throw to top level. */
1551 /* Note that the value cell will never directly contain nil
1552 if the symbol is a local variable. */
1553 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1554 safe_run_hooks (Qpost_command_hook
);
1556 /* If displaying a message, resize the echo area window to fit
1557 that message's size exactly. */
1558 if (!NILP (echo_area_buffer
[0]))
1559 resize_echo_area_exactly ();
1561 if (!NILP (Vdeferred_action_list
))
1562 safe_run_hooks (Qdeferred_action_function
);
1565 /* Do this after running Vpost_command_hook, for consistency. */
1566 current_kboard
->Vlast_command
= Vthis_command
;
1567 current_kboard
->Vreal_last_command
= real_this_command
;
1568 if (!CONSP (last_command_event
))
1569 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1573 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1576 /* Make sure the current window's buffer is selected. */
1577 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1578 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1580 /* Display any malloc warning that just came out. Use while because
1581 displaying one warning can cause another. */
1583 while (pending_malloc_warning
)
1584 display_malloc_warning ();
1586 Vdeactivate_mark
= Qnil
;
1588 /* If minibuffer on and echo area in use,
1589 wait a short time and redraw minibuffer. */
1592 && !NILP (echo_area_buffer
[0])
1593 && EQ (minibuf_window
, echo_area_window
)
1594 && NUMBERP (Vminibuffer_message_timeout
))
1596 /* Bind inhibit-quit to t so that C-g gets read in
1597 rather than quitting back to the minibuffer. */
1598 int count
= SPECPDL_INDEX ();
1599 specbind (Qinhibit_quit
, Qt
);
1601 sit_for (Vminibuffer_message_timeout
, 0, 2);
1603 /* Clear the echo area. */
1605 safe_run_hooks (Qecho_area_clear_hook
);
1607 unbind_to (count
, Qnil
);
1609 /* If a C-g came in before, treat it as input now. */
1610 if (!NILP (Vquit_flag
))
1613 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1618 /* Select the frame that the last event came from. Usually,
1619 switch-frame events will take care of this, but if some lisp
1620 code swallows a switch-frame event, we'll fix things up here.
1621 Is this a good idea? */
1622 if (FRAMEP (internal_last_event_frame
)
1623 && !EQ (internal_last_event_frame
, selected_frame
))
1624 Fselect_frame (internal_last_event_frame
, Qnil
);
1626 /* If it has changed current-menubar from previous value,
1627 really recompute the menubar from the value. */
1628 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1629 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1630 call0 (Qrecompute_lucid_menubar
);
1632 before_command_key_count
= this_command_key_count
;
1633 before_command_echo_length
= echo_length ();
1635 Vthis_command
= Qnil
;
1636 real_this_command
= Qnil
;
1637 Vthis_original_command
= Qnil
;
1638 Vthis_command_keys_shift_translated
= Qnil
;
1640 /* Read next key sequence; i gets its length. */
1641 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1644 /* A filter may have run while we were reading the input. */
1645 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1647 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1648 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1652 /* Now we have read a key sequence of length I,
1653 or else I is 0 and we found end of file. */
1655 if (i
== 0) /* End of file -- happens only in */
1656 return Qnil
; /* a kbd macro, at the end. */
1657 /* -1 means read_key_sequence got a menu that was rejected.
1658 Just loop around and read another command. */
1662 this_command_key_count
= 0;
1663 this_command_key_count_reset
= 0;
1664 this_single_command_key_start
= 0;
1668 last_command_event
= keybuf
[i
- 1];
1670 /* If the previous command tried to force a specific window-start,
1671 forget about that, in case this command moves point far away
1672 from that position. But also throw away beg_unchanged and
1673 end_unchanged information in that case, so that redisplay will
1674 update the whole window properly. */
1675 if (!NILP (XWINDOW (selected_window
)->force_start
))
1678 XWINDOW (selected_window
)->force_start
= Qnil
;
1679 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1680 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1683 cmd
= read_key_sequence_cmd
;
1684 if (!NILP (Vexecuting_kbd_macro
))
1686 if (!NILP (Vquit_flag
))
1688 Vexecuting_kbd_macro
= Qt
;
1689 QUIT
; /* Make some noise. */
1690 /* Will return since macro now empty. */
1694 /* Do redisplay processing after this command except in special
1695 cases identified below. */
1696 prev_buffer
= current_buffer
;
1697 prev_modiff
= MODIFF
;
1698 last_point_position
= PT
;
1699 last_point_position_window
= selected_window
;
1700 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1702 /* By default, we adjust point to a boundary of a region that
1703 has such a property that should be treated intangible
1704 (e.g. composition, display). But, some commands will set
1705 this variable differently. */
1706 Vdisable_point_adjustment
= Qnil
;
1708 /* Process filters and timers may have messed with deactivate-mark.
1709 reset it before we execute the command. */
1710 Vdeactivate_mark
= Qnil
;
1712 /* Remap command through active keymaps */
1713 Vthis_original_command
= cmd
;
1717 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1721 /* Execute the command. */
1723 Vthis_command
= cmd
;
1724 real_this_command
= cmd
;
1725 /* Note that the value cell will never directly contain nil
1726 if the symbol is a local variable. */
1727 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1728 safe_run_hooks (Qpre_command_hook
);
1730 already_adjusted
= 0;
1732 if (NILP (Vthis_command
))
1734 /* nil means key is undefined. */
1735 Lisp_Object keys
= Fvector (i
, keybuf
);
1736 keys
= Fkey_description (keys
, Qnil
);
1738 message_with_string ("%s is undefined", keys
, 0);
1739 current_kboard
->defining_kbd_macro
= Qnil
;
1740 update_mode_lines
= 1;
1741 current_kboard
->Vprefix_arg
= Qnil
;
1745 if (NILP (current_kboard
->Vprefix_arg
))
1747 /* In case we jump to directly_done. */
1748 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1750 /* Recognize some common commands in common situations and
1751 do them directly. */
1752 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
1753 && NILP (Vthis_command_keys_shift_translated
)
1754 && !CONSP (Vtransient_mark_mode
))
1756 struct Lisp_Char_Table
*dp
1757 = window_display_table (XWINDOW (selected_window
));
1758 lose
= FETCH_CHAR (PT_BYTE
);
1760 if (! NILP (Vpost_command_hook
))
1761 /* Put this before calling adjust_point_for_property
1762 so it will only get called once in any case. */
1764 if (current_buffer
== prev_buffer
1765 && last_point_position
!= PT
1766 && NILP (Vdisable_point_adjustment
)
1767 && NILP (Vglobal_disable_point_adjustment
))
1768 adjust_point_for_property (last_point_position
, 0);
1769 already_adjusted
= 1;
1770 if (PT
== last_point_position
+ 1
1772 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1773 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1774 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1775 && (lose
>= 0x20 && lose
< 0x7f)))
1776 : (lose
>= 0x20 && lose
< 0x7f))
1777 /* To extract the case of continuation on
1778 wide-column characters. */
1779 && ASCII_BYTE_P (lose
)
1780 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1782 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1784 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1786 && !windows_or_buffers_changed
1787 && EQ (current_buffer
->selective_display
, Qnil
)
1788 && !detect_input_pending ()
1789 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1790 && NILP (Vexecuting_kbd_macro
))
1791 direct_output_forward_char (1);
1794 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
1795 && NILP (Vthis_command_keys_shift_translated
)
1796 && !CONSP (Vtransient_mark_mode
))
1798 struct Lisp_Char_Table
*dp
1799 = window_display_table (XWINDOW (selected_window
));
1801 lose
= FETCH_CHAR (PT_BYTE
);
1802 if (! NILP (Vpost_command_hook
))
1804 if (current_buffer
== prev_buffer
1805 && last_point_position
!= PT
1806 && NILP (Vdisable_point_adjustment
)
1807 && NILP (Vglobal_disable_point_adjustment
))
1808 adjust_point_for_property (last_point_position
, 0);
1809 already_adjusted
= 1;
1810 if (PT
== last_point_position
- 1
1812 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1813 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1814 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1815 && (lose
>= 0x20 && lose
< 0x7f)))
1816 : (lose
>= 0x20 && lose
< 0x7f))
1817 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1819 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1821 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1823 && !windows_or_buffers_changed
1824 && EQ (current_buffer
->selective_display
, Qnil
)
1825 && !detect_input_pending ()
1826 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1827 && NILP (Vexecuting_kbd_macro
))
1828 direct_output_forward_char (-1);
1831 else if (EQ (Vthis_command
, Qself_insert_command
)
1832 /* Try this optimization only on char keystrokes. */
1833 && NATNUMP (last_command_event
)
1834 && CHAR_VALID_P (XFASTINT (last_command_event
), 0))
1837 = translate_char (Vtranslation_table_for_input
,
1838 XFASTINT (last_command_event
));
1840 if (NILP (Vexecuting_kbd_macro
)
1841 && !EQ (minibuf_window
, selected_window
))
1843 if (!nonundocount
|| nonundocount
>= 20)
1851 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1853 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1855 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1857 || MODIFF
<= SAVE_MODIFF
1858 || windows_or_buffers_changed
1859 || !EQ (current_buffer
->selective_display
, Qnil
)
1860 || detect_input_pending ()
1861 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1862 || !NILP (Vexecuting_kbd_macro
));
1864 value
= internal_self_insert (c
, 0);
1869 frame_make_pointer_invisible ();
1871 if (! NILP (Vpost_command_hook
))
1872 /* Put this before calling adjust_point_for_property
1873 so it will only get called once in any case. */
1876 /* VALUE == 1 when AFTER-CHANGE functions are
1877 installed which is the case most of the time
1878 because FONT-LOCK installs one. */
1879 if (!lose
&& !value
)
1880 direct_output_for_insert (c
);
1885 /* Here for a command that isn't executed directly */
1888 #ifdef HAVE_WINDOW_SYSTEM
1889 int scount
= SPECPDL_INDEX ();
1891 if (display_hourglass_p
1892 && NILP (Vexecuting_kbd_macro
))
1894 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1900 if (NILP (current_kboard
->Vprefix_arg
)) /* FIXME: Why? --Stef */
1902 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1904 #ifdef HAVE_WINDOW_SYSTEM
1905 /* Do not check display_hourglass_p here, because
1906 Fcommand_execute could change it, but we should cancel
1907 hourglass cursor anyway.
1908 But don't cancel the hourglass within a macro
1909 just because a command in the macro finishes. */
1910 if (NILP (Vexecuting_kbd_macro
))
1911 unbind_to (scount
, Qnil
);
1916 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1918 /* Note that the value cell will never directly contain nil
1919 if the symbol is a local variable. */
1920 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1921 safe_run_hooks (Qpost_command_hook
);
1923 /* If displaying a message, resize the echo area window to fit
1924 that message's size exactly. */
1925 if (!NILP (echo_area_buffer
[0]))
1926 resize_echo_area_exactly ();
1928 if (!NILP (Vdeferred_action_list
))
1929 safe_run_hooks (Qdeferred_action_function
);
1931 /* If there is a prefix argument,
1932 1) We don't want Vlast_command to be ``universal-argument''
1933 (that would be dumb), so don't set Vlast_command,
1934 2) we want to leave echoing on so that the prefix will be
1935 echoed as part of this key sequence, so don't call
1937 3) we want to leave this_command_key_count non-zero, so that
1938 read_char will realize that it is re-reading a character, and
1939 not echo it a second time.
1941 If the command didn't actually create a prefix arg,
1942 but is merely a frame event that is transparent to prefix args,
1943 then the above doesn't apply. */
1944 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_event
))
1946 current_kboard
->Vlast_command
= Vthis_command
;
1947 current_kboard
->Vreal_last_command
= real_this_command
;
1948 if (!CONSP (last_command_event
))
1949 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1951 this_command_key_count
= 0;
1952 this_command_key_count_reset
= 0;
1953 this_single_command_key_start
= 0;
1956 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1958 /* In Emacs 22, setting transient-mark-mode to `only' was a
1959 way of turning it on for just one command. This usage is
1960 obsolete, but support it anyway. */
1961 if (EQ (Vtransient_mark_mode
, Qidentity
))
1962 Vtransient_mark_mode
= Qnil
;
1963 else if (EQ (Vtransient_mark_mode
, Qonly
))
1964 Vtransient_mark_mode
= Qidentity
;
1966 if (!NILP (Vdeactivate_mark
))
1967 call0 (Qdeactivate_mark
);
1968 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1969 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1974 if (current_buffer
== prev_buffer
1975 && last_point_position
!= PT
1976 && NILP (Vdisable_point_adjustment
)
1977 && NILP (Vglobal_disable_point_adjustment
)
1978 && !already_adjusted
)
1979 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1981 /* Install chars successfully executed in kbd macro. */
1983 if (!NILP (current_kboard
->defining_kbd_macro
)
1984 && NILP (current_kboard
->Vprefix_arg
))
1985 finalize_kbd_macro_chars ();
1986 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1988 any_kboard_state ();
1993 extern Lisp_Object Qcomposition
, Qdisplay
;
1995 /* Adjust point to a boundary of a region that has such a property
1996 that should be treated intangible. For the moment, we check
1997 `composition', `display' and `invisible' properties.
1998 LAST_PT is the last position of point. */
2000 extern Lisp_Object Qafter_string
, Qbefore_string
;
2001 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2004 adjust_point_for_property (last_pt
, modified
)
2009 Lisp_Object val
, overlay
, tmp
;
2010 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
2013 /* FIXME: cycling is probably not necessary because these properties
2014 can't be usefully combined anyway. */
2015 while (check_composition
|| check_display
|| check_invisible
)
2017 /* FIXME: check `intangible'. */
2018 if (check_composition
2019 && PT
> BEGV
&& PT
< ZV
2020 && (beg
= composition_adjust_point (last_pt
)) != PT
)
2023 check_display
= check_invisible
= 1;
2025 check_composition
= 0;
2027 && PT
> BEGV
&& PT
< ZV
2028 && !NILP (val
= get_char_property_and_overlay
2029 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
2030 && display_prop_intangible_p (val
)
2031 && (!OVERLAYP (overlay
)
2032 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
2033 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
2034 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
2035 && (beg
< PT
/* && end > PT <- It's always the case. */
2036 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
2039 SET_PT (PT
< last_pt
2040 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
2042 check_composition
= check_invisible
= 1;
2045 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
2047 int inv
, ellipsis
= 0;
2050 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2053 /* FIXME: We should stop if we find a spot between
2054 two runs of `invisible' where inserted text would
2055 be visible. This is important when we have two
2056 invisible boundaries that enclose an area: if the
2057 area is empty, we need this test in order to make
2058 it possible to place point in the middle rather
2059 than skip both boundaries. However, this code
2060 also stops anywhere in a non-sticky text-property,
2061 which breaks (e.g.) Org mode. */
2062 && (val
= get_pos_property (make_number (end
),
2064 TEXT_PROP_MEANS_INVISIBLE (val
))
2066 && !NILP (val
= get_char_property_and_overlay
2067 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
2068 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2070 ellipsis
= ellipsis
|| inv
> 1
2071 || (OVERLAYP (overlay
)
2072 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2073 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2074 tmp
= Fnext_single_char_property_change
2075 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
2076 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
2080 && (val
= get_pos_property (make_number (beg
),
2082 TEXT_PROP_MEANS_INVISIBLE (val
))
2084 && !NILP (val
= get_char_property_and_overlay
2085 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
2086 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2088 ellipsis
= ellipsis
|| inv
> 1
2089 || (OVERLAYP (overlay
)
2090 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2091 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2092 tmp
= Fprevious_single_char_property_change
2093 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2094 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2097 /* Move away from the inside area. */
2098 if (beg
< PT
&& end
> PT
)
2100 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2101 /* We haven't moved yet (so we don't need to fear
2102 infinite-looping) and we were outside the range
2103 before (so either end of the range still corresponds
2104 to a move in the right direction): pretend we moved
2105 less than we actually did, so that we still have
2106 more freedom below in choosing which end of the range
2108 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2109 /* We either have moved already or the last point
2110 was already in the range: we don't get to choose
2111 which end of the range we have to go to. */
2112 : (PT
< last_pt
? beg
: end
));
2113 check_composition
= check_display
= 1;
2115 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2116 the point to something other than its argument, due to
2117 point-motion hooks, intangibility, etc. */
2118 xassert (PT
== beg
|| PT
== end
);
2121 /* Pretend the area doesn't exist if the buffer is not
2123 if (!modified
&& !ellipsis
&& beg
< end
)
2125 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2126 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2127 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2128 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2129 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2130 /* We've already moved as far as we can. Trying to go
2131 to the other end would mean moving backwards and thus
2132 could lead to an infinite loop. */
2134 else if (val
= get_pos_property (make_number (PT
),
2136 TEXT_PROP_MEANS_INVISIBLE (val
)
2137 && (val
= get_pos_property
2138 (make_number (PT
== beg
? end
: beg
),
2140 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2141 (check_composition
= check_display
= 1,
2142 SET_PT (PT
== beg
? end
: beg
));
2145 check_invisible
= 0;
2149 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2152 safe_run_hooks_1 (hook
)
2155 if (NILP (Vrun_hooks
))
2157 return call1 (Vrun_hooks
, Vinhibit_quit
);
2160 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2163 safe_run_hooks_error (data
)
2166 Lisp_Object args
[3];
2167 args
[0] = build_string ("Error in %s: %s");
2168 args
[1] = Vinhibit_quit
;
2171 return Fset (Vinhibit_quit
, Qnil
);
2174 /* If we get an error while running the hook, cause the hook variable
2175 to be nil. Also inhibit quits, so that C-g won't cause the hook
2176 to mysteriously evaporate. */
2179 safe_run_hooks (hook
)
2182 int count
= SPECPDL_INDEX ();
2183 specbind (Qinhibit_quit
, hook
);
2185 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2187 unbind_to (count
, Qnil
);
2191 /* Number of seconds between polling for input. This is a Lisp
2192 variable that can be bound. */
2194 EMACS_INT polling_period
;
2196 /* Nonzero means polling for input is temporarily suppressed. */
2198 int poll_suppress_count
;
2200 /* Asynchronous timer for polling. */
2202 struct atimer
*poll_timer
;
2205 #ifdef POLL_FOR_INPUT
2207 /* Poll for input, so that we catch a C-g if it comes in. This
2208 function is called from x_make_frame_visible, see comment
2214 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
2215 doing anything dangerous. */
2219 if (interrupt_input_blocked
== 0
2220 && !waiting_for_input
)
2221 read_avail_input (0);
2227 /* Timer callback function for poll_timer. TIMER is equal to
2231 poll_for_input (timer
)
2232 struct atimer
*timer
;
2234 if (poll_suppress_count
== 0)
2237 interrupt_input_pending
= 1;
2238 pending_signals
= 1;
2240 poll_for_input_1 ();
2245 #endif /* POLL_FOR_INPUT */
2247 /* Begin signals to poll for input, if they are appropriate.
2248 This function is called unconditionally from various places. */
2253 #ifdef POLL_FOR_INPUT
2254 /* XXX This condition was (read_socket_hook && !interrupt_input),
2255 but read_socket_hook is not global anymore. Let's pretend that
2257 if (!interrupt_input
)
2259 /* Turn alarm handling on unconditionally. It might have
2260 been turned off in process.c. */
2261 turn_on_atimers (1);
2263 /* If poll timer doesn't exist, are we need one with
2264 a different interval, start a new one. */
2265 if (poll_timer
== NULL
2266 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2268 EMACS_TIME interval
;
2271 cancel_atimer (poll_timer
);
2273 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2274 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2275 poll_for_input
, NULL
);
2278 /* Let the timer's callback function poll for input
2279 if this becomes zero. */
2280 --poll_suppress_count
;
2285 /* Nonzero if we are using polling to handle input asynchronously. */
2288 input_polling_used ()
2290 #ifdef POLL_FOR_INPUT
2291 /* XXX This condition was (read_socket_hook && !interrupt_input),
2292 but read_socket_hook is not global anymore. Let's pretend that
2294 return !interrupt_input
;
2300 /* Turn off polling. */
2305 #ifdef POLL_FOR_INPUT
2306 /* XXX This condition was (read_socket_hook && !interrupt_input),
2307 but read_socket_hook is not global anymore. Let's pretend that
2309 if (!interrupt_input
)
2310 ++poll_suppress_count
;
2314 /* Set the value of poll_suppress_count to COUNT
2315 and start or stop polling accordingly. */
2318 set_poll_suppress_count (count
)
2321 #ifdef POLL_FOR_INPUT
2322 if (count
== 0 && poll_suppress_count
!= 0)
2324 poll_suppress_count
= 1;
2327 else if (count
!= 0 && poll_suppress_count
== 0)
2331 poll_suppress_count
= count
;
2335 /* Bind polling_period to a value at least N.
2336 But don't decrease it. */
2339 bind_polling_period (n
)
2342 #ifdef POLL_FOR_INPUT
2343 int new = polling_period
;
2348 stop_other_atimers (poll_timer
);
2350 specbind (Qpolling_period
, make_number (new));
2351 /* Start a new alarm with the new period. */
2356 /* Apply the control modifier to CHARACTER. */
2362 /* Save the upper bits here. */
2363 int upper
= c
& ~0177;
2365 if (! ASCII_BYTE_P (c
))
2366 return c
|= ctrl_modifier
;
2370 /* Everything in the columns containing the upper-case letters
2371 denotes a control character. */
2372 if (c
>= 0100 && c
< 0140)
2376 /* Set the shift modifier for a control char
2377 made from a shifted letter. But only for letters! */
2378 if (oc
>= 'A' && oc
<= 'Z')
2379 c
|= shift_modifier
;
2382 /* The lower-case letters denote control characters too. */
2383 else if (c
>= 'a' && c
<= 'z')
2386 /* Include the bits for control and shift
2387 only if the basic ASCII code can't indicate them. */
2391 /* Replace the high bits. */
2392 c
|= (upper
& ~ctrl_modifier
);
2397 /* Display the help-echo property of the character after the mouse pointer.
2398 Either show it in the echo area, or call show-help-function to display
2399 it by other means (maybe in a tooltip).
2401 If HELP is nil, that means clear the previous help echo.
2403 If HELP is a string, display that string. If HELP is a function,
2404 call it with OBJECT and POS as arguments; the function should
2405 return a help string or nil for none. For all other types of HELP,
2406 evaluate it to obtain a string.
2408 WINDOW is the window in which the help was generated, if any.
2409 It is nil if not in a window.
2411 If OBJECT is a buffer, POS is the position in the buffer where the
2412 `help-echo' text property was found.
2414 If OBJECT is an overlay, that overlay has a `help-echo' property,
2415 and POS is the position in the overlay's buffer under the mouse.
2417 If OBJECT is a string (an overlay string or a string displayed with
2418 the `display' property). POS is the position in that string under
2421 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2422 echo overwrites a keystroke echo currently displayed in the echo
2425 Note: this function may only be called with HELP nil or a string
2426 from X code running asynchronously. */
2429 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2430 Lisp_Object help
, window
, object
, pos
;
2431 int ok_to_overwrite_keystroke_echo
;
2433 if (!NILP (help
) && !STRINGP (help
))
2435 if (FUNCTIONP (help
))
2437 Lisp_Object args
[4];
2442 help
= safe_call (4, args
);
2445 help
= safe_eval (help
);
2447 if (!STRINGP (help
))
2451 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2452 if (!noninteractive
&& STRINGP (help
))
2454 /* The mouse-fixup-help-message Lisp function can call
2455 mouse_position_hook, which resets the mouse_moved flags.
2456 This causes trouble if we are trying to read a mouse motion
2457 event (i.e., if we are inside a `track-mouse' form), so we
2458 restore the mouse_moved flag. */
2459 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2460 help
= call1 (Qmouse_fixup_help_message
, help
);
2466 if (STRINGP (help
) || NILP (help
))
2468 if (!NILP (Vshow_help_function
))
2469 call1 (Vshow_help_function
, help
);
2470 help_echo_showing_p
= STRINGP (help
);
2476 /* Input of single characters from keyboard */
2478 Lisp_Object
print_help ();
2479 static Lisp_Object
kbd_buffer_get_event ();
2480 static void record_char ();
2482 static Lisp_Object help_form_saved_window_configs
;
2484 read_char_help_form_unwind (Lisp_Object arg
)
2486 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2487 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2488 if (!NILP (window_config
))
2489 Fset_window_configuration (window_config
);
2493 #define STOP_POLLING \
2494 do { if (! polling_stopped_here) stop_polling (); \
2495 polling_stopped_here = 1; } while (0)
2497 #define RESUME_POLLING \
2498 do { if (polling_stopped_here) start_polling (); \
2499 polling_stopped_here = 0; } while (0)
2501 /* read a character from the keyboard; call the redisplay if needed */
2502 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2503 -1 means do not do redisplay, but do do autosaving.
2506 /* The arguments MAPS and NMAPS are for menu prompting.
2507 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2509 PREV_EVENT is the previous input event, or nil if we are reading
2510 the first event of a key sequence (or not reading a key sequence).
2511 If PREV_EVENT is t, that is a "magic" value that says
2512 not to run input methods, but in other respects to act as if
2513 not reading a key sequence.
2515 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2516 if we used a mouse menu to read the input, or zero otherwise. If
2517 USED_MOUSE_MENU is null, we don't dereference it.
2519 Value is -2 when we find input on another keyboard. A second call
2520 to read_char will read it.
2522 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2523 specifying the maximum time to wait until. If no input arrives by
2524 that time, stop waiting and return nil.
2526 Value is t if we showed a menu and the user rejected it. */
2529 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2533 Lisp_Object prev_event
;
2534 int *used_mouse_menu
;
2535 EMACS_TIME
*end_time
;
2537 volatile Lisp_Object c
;
2538 int count
, jmpcount
;
2539 jmp_buf local_getcjmp
;
2541 volatile int key_already_recorded
= 0;
2542 Lisp_Object tem
, save
;
2543 volatile Lisp_Object previous_echo_area_message
;
2544 volatile Lisp_Object also_record
;
2545 volatile int reread
;
2546 struct gcpro gcpro1
, gcpro2
;
2547 int polling_stopped_here
= 0;
2548 struct kboard
*orig_kboard
= current_kboard
;
2552 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2553 before_command_key_count
= this_command_key_count
;
2554 before_command_echo_length
= echo_length ();
2557 previous_echo_area_message
= Qnil
;
2559 GCPRO2 (c
, previous_echo_area_message
);
2564 if (CONSP (Vunread_post_input_method_events
))
2566 c
= XCAR (Vunread_post_input_method_events
);
2567 Vunread_post_input_method_events
2568 = XCDR (Vunread_post_input_method_events
);
2570 /* Undo what read_char_x_menu_prompt did when it unread
2571 additional keys returned by Fx_popup_menu. */
2573 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2581 if (unread_command_char
!= -1)
2583 XSETINT (c
, unread_command_char
);
2584 unread_command_char
= -1;
2590 if (CONSP (Vunread_command_events
))
2592 int was_disabled
= 0;
2594 c
= XCAR (Vunread_command_events
);
2595 Vunread_command_events
= XCDR (Vunread_command_events
);
2599 /* Undo what sit-for did when it unread additional keys
2600 inside universal-argument. */
2603 && EQ (XCAR (c
), Qt
))
2609 /* Undo what read_char_x_menu_prompt did when it unread
2610 additional keys returned by Fx_popup_menu. */
2612 && EQ (XCDR (c
), Qdisabled
)
2613 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2619 /* If the queued event is something that used the mouse,
2620 set used_mouse_menu accordingly. */
2622 /* Also check was_disabled so last-nonmenu-event won't return
2623 a bad value when submenus are involved. (Bug#447) */
2624 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2625 *used_mouse_menu
= 1;
2627 goto reread_for_input_method
;
2630 if (CONSP (Vunread_input_method_events
))
2632 c
= XCAR (Vunread_input_method_events
);
2633 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2635 /* Undo what read_char_x_menu_prompt did when it unread
2636 additional keys returned by Fx_popup_menu. */
2638 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2642 goto reread_for_input_method
;
2645 this_command_key_count_reset
= 0;
2647 if (!NILP (Vexecuting_kbd_macro
))
2649 /* We set this to Qmacro; since that's not a frame, nobody will
2650 try to switch frames on us, and the selected window will
2653 Since this event came from a macro, it would be misleading to
2654 leave internal_last_event_frame set to wherever the last
2655 real event came from. Normally, a switch-frame event selects
2656 internal_last_event_frame after each command is read, but
2657 events read from a macro should never cause a new frame to be
2659 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2661 /* Exit the macro if we are at the end.
2662 Also, some things replace the macro with t
2663 to force an early exit. */
2664 if (EQ (Vexecuting_kbd_macro
, Qt
)
2665 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2671 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2672 if (STRINGP (Vexecuting_kbd_macro
)
2673 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2674 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2676 executing_kbd_macro_index
++;
2681 if (!NILP (unread_switch_frame
))
2683 c
= unread_switch_frame
;
2684 unread_switch_frame
= Qnil
;
2686 /* This event should make it into this_command_keys, and get echoed
2687 again, so we do not set `reread'. */
2691 /* if redisplay was requested */
2692 if (commandflag
>= 0)
2694 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2696 /* If there is pending input, process any events which are not
2697 user-visible, such as X selection_request events. */
2699 || detect_input_pending_run_timers (0))
2700 swallow_events (0); /* may clear input_pending */
2702 /* Redisplay if no pending input. */
2703 while (!input_pending
)
2705 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2706 redisplay_preserve_echo_area (5);
2711 /* Normal case: no input arrived during redisplay. */
2714 /* Input arrived and pre-empted redisplay.
2715 Process any events which are not user-visible. */
2717 /* If that cleared input_pending, try again to redisplay. */
2720 /* Prevent the redisplay we just did
2721 from messing up echoing of the input after the prompt. */
2722 if (commandflag
== 0 && echo_current
)
2723 echo_message_buffer
= echo_area_buffer
[0];
2727 /* Message turns off echoing unless more keystrokes turn it on again.
2729 The code in 20.x for the condition was
2731 1. echo_area_glyphs && *echo_area_glyphs
2732 2. && echo_area_glyphs != current_kboard->echobuf
2733 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2735 (1) means there's a current message displayed
2737 (2) means it's not the message from echoing from the current
2740 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2741 is set to a non-null value. This is done in read_char and it is
2742 set to echo_area_glyphs after a call to echo_char. That means
2743 ok_to_echo_at_next_pause is either null or
2744 current_kboard->echobuf with the appropriate current_kboard at
2747 So, condition (3) means in clear text ok_to_echo_at_next_pause
2748 must be either null, or the current message isn't from echoing at
2749 all, or it's from echoing from a different kboard than the
2752 if (/* There currently is something in the echo area. */
2753 !NILP (echo_area_buffer
[0])
2754 && (/* And it's either not from echoing. */
2755 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2756 /* Or it's an echo from a different kboard. */
2757 || echo_kboard
!= current_kboard
2758 /* Or we explicitly allow overwriting whatever there is. */
2759 || ok_to_echo_at_next_pause
== NULL
))
2764 /* Try reading a character via menu prompting in the minibuf.
2765 Try this before the sit-for, because the sit-for
2766 would do the wrong thing if we are supposed to do
2767 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2768 after a mouse event so don't try a minibuf menu. */
2770 if (nmaps
> 0 && INTERACTIVE
2771 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2772 /* Don't bring up a menu if we already have another event. */
2773 && NILP (Vunread_command_events
)
2774 && unread_command_char
< 0
2775 && !detect_input_pending_run_timers (0))
2777 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2779 if (INTEGERP (c
) && XINT (c
) == -2)
2780 return c
; /* wrong_kboard_jmpbuf */
2784 key_already_recorded
= 1;
2789 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2790 We will do that below, temporarily for short sections of code,
2791 when appropriate. local_getcjmp must be in effect
2792 around any call to sit_for or kbd_buffer_get_event;
2793 it *must not* be in effect when we call redisplay. */
2795 jmpcount
= SPECPDL_INDEX ();
2796 if (_setjmp (local_getcjmp
))
2798 /* Handle quits while reading the keyboard. */
2799 /* We must have saved the outer value of getcjmp here,
2800 so restore it now. */
2801 restore_getcjmp (save_jump
);
2802 unbind_to (jmpcount
, Qnil
);
2803 XSETINT (c
, quit_char
);
2804 internal_last_event_frame
= selected_frame
;
2805 Vlast_event_frame
= internal_last_event_frame
;
2806 /* If we report the quit char as an event,
2807 don't do so more than once. */
2808 if (!NILP (Vinhibit_quit
))
2812 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2813 if (kb
!= current_kboard
)
2815 Lisp_Object link
= kb
->kbd_queue
;
2816 /* We shouldn't get here if we were in single-kboard mode! */
2821 while (CONSP (XCDR (link
)))
2823 if (!NILP (XCDR (link
)))
2827 kb
->kbd_queue
= Fcons (c
, Qnil
);
2829 XSETCDR (link
, Fcons (c
, Qnil
));
2830 kb
->kbd_queue_has_data
= 1;
2831 current_kboard
= kb
;
2832 /* This is going to exit from read_char
2833 so we had better get rid of this frame's stuff. */
2835 return make_number (-2); /* wrong_kboard_jmpbuf */
2841 /* Start idle timers if no time limit is supplied. We don't do it
2842 if a time limit is supplied to avoid an infinite recursion in the
2843 situation where an idle timer calls `sit-for'. */
2846 timer_start_idle ();
2848 /* If in middle of key sequence and minibuffer not active,
2849 start echoing if enough time elapses. */
2851 if (minibuf_level
== 0
2853 && !current_kboard
->immediate_echo
2854 && this_command_key_count
> 0
2856 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2857 && NILP (Fzerop (Vecho_keystrokes
))
2858 && (/* No message. */
2859 NILP (echo_area_buffer
[0])
2860 /* Or empty message. */
2861 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2862 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2863 /* Or already echoing from same kboard. */
2864 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2865 /* Or not echoing before and echoing allowed. */
2866 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2868 /* After a mouse event, start echoing right away.
2869 This is because we are probably about to display a menu,
2870 and we don't want to delay before doing so. */
2871 if (EVENT_HAS_PARAMETERS (prev_event
))
2877 save_getcjmp (save_jump
);
2878 restore_getcjmp (local_getcjmp
);
2879 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2880 restore_getcjmp (save_jump
);
2882 && ! CONSP (Vunread_command_events
))
2887 /* Maybe auto save due to number of keystrokes. */
2889 if (commandflag
!= 0
2890 && auto_save_interval
> 0
2891 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2892 && !detect_input_pending_run_timers (0))
2894 Fdo_auto_save (Qnil
, Qnil
);
2895 /* Hooks can actually change some buffers in auto save. */
2899 /* Try reading using an X menu.
2900 This is never confused with reading using the minibuf
2901 because the recursive call of read_char in read_char_minibuf_menu_prompt
2902 does not pass on any keymaps. */
2904 if (nmaps
> 0 && INTERACTIVE
2905 && !NILP (prev_event
)
2906 && EVENT_HAS_PARAMETERS (prev_event
)
2907 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2908 && !EQ (XCAR (prev_event
), Qtool_bar
)
2909 /* Don't bring up a menu if we already have another event. */
2910 && NILP (Vunread_command_events
)
2911 && unread_command_char
< 0)
2913 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2915 /* Now that we have read an event, Emacs is not idle. */
2922 /* Maybe autosave and/or garbage collect due to idleness. */
2924 if (INTERACTIVE
&& NILP (c
))
2926 int delay_level
, buffer_size
;
2928 /* Slow down auto saves logarithmically in size of current buffer,
2929 and garbage collect while we're at it. */
2930 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2931 last_non_minibuf_size
= Z
- BEG
;
2932 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2934 while (buffer_size
> 64)
2935 delay_level
++, buffer_size
-= buffer_size
>> 2;
2936 if (delay_level
< 4) delay_level
= 4;
2937 /* delay_level is 4 for files under around 50k, 7 at 100k,
2938 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2940 /* Auto save if enough time goes by without input. */
2941 if (commandflag
!= 0
2942 && num_nonmacro_input_events
> last_auto_save
2943 && INTEGERP (Vauto_save_timeout
)
2944 && XINT (Vauto_save_timeout
) > 0)
2947 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2949 save_getcjmp (save_jump
);
2950 restore_getcjmp (local_getcjmp
);
2951 tem0
= sit_for (make_number (timeout
), 1, 1);
2952 restore_getcjmp (save_jump
);
2955 && ! CONSP (Vunread_command_events
))
2957 Fdo_auto_save (Qnil
, Qnil
);
2959 /* If we have auto-saved and there is still no input
2960 available, garbage collect if there has been enough
2961 consing going on to make it worthwhile. */
2962 if (!detect_input_pending_run_timers (0)
2963 && consing_since_gc
> gc_cons_threshold
/ 2)
2964 Fgarbage_collect ();
2971 /* Notify the caller if an autosave hook, or a timer, sentinel or
2972 filter in the sit_for calls above have changed the current
2973 kboard. This could happen if they use the minibuffer or start a
2974 recursive edit, like the fancy splash screen in server.el's
2975 filter. If this longjmp wasn't here, read_key_sequence would
2976 interpret the next key sequence using the wrong translation
2977 tables and function keymaps. */
2978 if (NILP (c
) && current_kboard
!= orig_kboard
)
2981 return make_number (-2); /* wrong_kboard_jmpbuf */
2984 /* If this has become non-nil here, it has been set by a timer
2985 or sentinel or filter. */
2986 if (CONSP (Vunread_command_events
))
2988 c
= XCAR (Vunread_command_events
);
2989 Vunread_command_events
= XCDR (Vunread_command_events
);
2992 /* Read something from current KBOARD's side queue, if possible. */
2996 if (current_kboard
->kbd_queue_has_data
)
2998 if (!CONSP (current_kboard
->kbd_queue
))
3000 c
= XCAR (current_kboard
->kbd_queue
);
3001 current_kboard
->kbd_queue
3002 = XCDR (current_kboard
->kbd_queue
);
3003 if (NILP (current_kboard
->kbd_queue
))
3004 current_kboard
->kbd_queue_has_data
= 0;
3005 input_pending
= readable_events (0);
3006 if (EVENT_HAS_PARAMETERS (c
)
3007 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
3008 internal_last_event_frame
= XCAR (XCDR (c
));
3009 Vlast_event_frame
= internal_last_event_frame
;
3013 /* If current_kboard's side queue is empty check the other kboards.
3014 If one of them has data that we have not yet seen here,
3015 switch to it and process the data waiting for it.
3017 Note: if the events queued up for another kboard
3018 have already been seen here, and therefore are not a complete command,
3019 the kbd_queue_has_data field is 0, so we skip that kboard here.
3020 That's to avoid an infinite loop switching between kboards here. */
3021 if (NILP (c
) && !single_kboard
)
3024 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3025 if (kb
->kbd_queue_has_data
)
3027 current_kboard
= kb
;
3028 /* This is going to exit from read_char
3029 so we had better get rid of this frame's stuff. */
3031 return make_number (-2); /* wrong_kboard_jmpbuf */
3039 /* Finally, we read from the main queue,
3040 and if that gives us something we can't use yet, we put it on the
3041 appropriate side queue and try again. */
3050 EMACS_GET_TIME (now
);
3051 if (EMACS_TIME_GE (now
, *end_time
))
3055 /* Actually read a character, waiting if necessary. */
3056 save_getcjmp (save_jump
);
3057 restore_getcjmp (local_getcjmp
);
3059 timer_start_idle ();
3060 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
3061 restore_getcjmp (save_jump
);
3063 if (! NILP (c
) && (kb
!= current_kboard
))
3065 Lisp_Object link
= kb
->kbd_queue
;
3068 while (CONSP (XCDR (link
)))
3070 if (!NILP (XCDR (link
)))
3074 kb
->kbd_queue
= Fcons (c
, Qnil
);
3076 XSETCDR (link
, Fcons (c
, Qnil
));
3077 kb
->kbd_queue_has_data
= 1;
3081 current_kboard
= kb
;
3082 /* This is going to exit from read_char
3083 so we had better get rid of this frame's stuff. */
3085 return make_number (-2);
3089 /* Terminate Emacs in batch mode if at eof. */
3090 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
3091 Fkill_emacs (make_number (1));
3095 /* Add in any extra modifiers, where appropriate. */
3096 if ((extra_keyboard_modifiers
& CHAR_CTL
)
3097 || ((extra_keyboard_modifiers
& 0177) < ' '
3098 && (extra_keyboard_modifiers
& 0177) != 0))
3099 XSETINT (c
, make_ctrl_char (XINT (c
)));
3101 /* Transfer any other modifier bits directly from
3102 extra_keyboard_modifiers to c. Ignore the actual character code
3103 in the low 16 bits of extra_keyboard_modifiers. */
3104 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
3115 if (commandflag
>= 0
3116 && !input_pending
&& !detect_input_pending_run_timers (0))
3124 /* Buffer switch events are only for internal wakeups
3125 so don't show them to the user.
3126 Also, don't record a key if we already did. */
3127 if (BUFFERP (c
) || key_already_recorded
)
3130 /* Process special events within read_char
3131 and loop around to read another event. */
3134 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3139 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3140 int was_locked
= single_kboard
;
3141 int count
= SPECPDL_INDEX ();
3142 record_single_kboard_state ();
3145 last_input_event
= c
;
3146 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
3148 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3149 /* We stopped being idle for this event; undo that. This
3150 prevents automatic window selection (under
3151 mouse_autoselect_window from acting as a real input event, for
3152 example banishing the mouse under mouse-avoidance-mode. */
3153 timer_resume_idle ();
3155 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3156 /* Resume allowing input from any kboard, if that was true before. */
3158 any_kboard_state ();
3159 unbind_to (count
, Qnil
);
3165 /* Handle things that only apply to characters. */
3168 /* If kbd_buffer_get_event gave us an EOF, return that. */
3172 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3173 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3174 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3175 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3176 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3180 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3181 /* nil in keyboard-translate-table means no translation. */
3187 /* If this event is a mouse click in the menu bar,
3188 return just menu-bar for now. Modify the mouse click event
3189 so we won't do this twice, then queue it up. */
3190 if (EVENT_HAS_PARAMETERS (c
)
3192 && CONSP (EVENT_START (c
))
3193 && CONSP (XCDR (EVENT_START (c
))))
3197 posn
= POSN_POSN (EVENT_START (c
));
3198 /* Handle menu-bar events:
3199 insert the dummy prefix event `menu-bar'. */
3200 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3202 /* Change menu-bar to (menu-bar) as the event "position". */
3203 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3206 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3211 /* Store these characters into recent_keys, the dribble file if any,
3212 and the keyboard macro being defined, if any. */
3214 if (! NILP (also_record
))
3215 record_char (also_record
);
3217 /* Wipe the echo area.
3218 But first, if we are about to use an input method,
3219 save the echo area contents for it to refer to. */
3221 && ! NILP (Vinput_method_function
)
3222 && (unsigned) XINT (c
) >= ' '
3223 && (unsigned) XINT (c
) != 127
3224 && (unsigned) XINT (c
) < 256)
3226 previous_echo_area_message
= Fcurrent_message ();
3227 Vinput_method_previous_message
= previous_echo_area_message
;
3230 /* Now wipe the echo area, except for help events which do their
3231 own stuff with the echo area. */
3233 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3234 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3236 if (!NILP (echo_area_buffer
[0]))
3237 safe_run_hooks (Qecho_area_clear_hook
);
3238 clear_message (1, 0);
3241 reread_for_input_method
:
3243 /* Pass this to the input method, if appropriate. */
3245 && ! NILP (Vinput_method_function
)
3246 /* Don't run the input method within a key sequence,
3247 after the first event of the key sequence. */
3248 && NILP (prev_event
)
3249 && (unsigned) XINT (c
) >= ' '
3250 && (unsigned) XINT (c
) != 127
3251 && (unsigned) XINT (c
) < 256)
3254 int key_count
, key_count_reset
;
3255 struct gcpro gcpro1
;
3256 int count
= SPECPDL_INDEX ();
3258 /* Save the echo status. */
3259 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3260 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3261 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3262 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3265 if (before_command_restore_flag
)
3267 this_command_key_count
= before_command_key_count_1
;
3268 if (this_command_key_count
< this_single_command_key_start
)
3269 this_single_command_key_start
= this_command_key_count
;
3270 echo_truncate (before_command_echo_length_1
);
3271 before_command_restore_flag
= 0;
3275 /* Save the this_command_keys status. */
3276 key_count
= this_command_key_count
;
3277 key_count_reset
= this_command_key_count_reset
;
3280 keys
= Fcopy_sequence (this_command_keys
);
3285 /* Clear out this_command_keys. */
3286 this_command_key_count
= 0;
3287 this_command_key_count_reset
= 0;
3289 /* Now wipe the echo area. */
3290 if (!NILP (echo_area_buffer
[0]))
3291 safe_run_hooks (Qecho_area_clear_hook
);
3292 clear_message (1, 0);
3295 /* If we are not reading a key sequence,
3296 never use the echo area. */
3299 specbind (Qinput_method_use_echo_area
, Qt
);
3302 /* Call the input method. */
3303 tem
= call1 (Vinput_method_function
, c
);
3305 tem
= unbind_to (count
, tem
);
3307 /* Restore the saved echoing state
3308 and this_command_keys state. */
3309 this_command_key_count
= key_count
;
3310 this_command_key_count_reset
= key_count_reset
;
3312 this_command_keys
= keys
;
3315 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3316 current_kboard
->echo_string
= saved_echo_string
;
3317 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3318 if (saved_immediate_echo
)
3323 /* The input method can return no events. */
3326 /* Bring back the previous message, if any. */
3327 if (! NILP (previous_echo_area_message
))
3328 message_with_string ("%s", previous_echo_area_message
, 0);
3331 /* It returned one event or more. */
3333 Vunread_post_input_method_events
3334 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3339 /* Display help if not echoing. */
3340 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3342 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3343 Lisp_Object help
, object
, position
, window
, tem
;
3345 tem
= Fcdr (XCDR (c
));
3348 window
= Fcar (tem
);
3350 object
= Fcar (tem
);
3352 position
= Fcar (tem
);
3354 show_help_echo (help
, window
, object
, position
, 0);
3356 /* We stopped being idle for this event; undo that. */
3358 timer_resume_idle ();
3362 if ((! reread
|| this_command_key_count
== 0
3363 || this_command_key_count_reset
)
3367 /* Don't echo mouse motion events. */
3368 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3369 && NILP (Fzerop (Vecho_keystrokes
))
3370 && ! (EVENT_HAS_PARAMETERS (c
)
3371 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3374 if (! NILP (also_record
))
3375 echo_char (also_record
);
3376 /* Once we reread a character, echoing can happen
3377 the next time we pause to read a new one. */
3378 ok_to_echo_at_next_pause
= current_kboard
;
3381 /* Record this character as part of the current key. */
3382 add_command_key (c
);
3383 if (! NILP (also_record
))
3384 add_command_key (also_record
);
3387 last_input_event
= c
;
3390 /* Process the help character specially if enabled */
3391 if (!NILP (Vhelp_form
) && help_char_p (c
))
3394 count
= SPECPDL_INDEX ();
3396 help_form_saved_window_configs
3397 = Fcons (Fcurrent_window_configuration (Qnil
),
3398 help_form_saved_window_configs
);
3399 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3401 tem0
= Feval (Vhelp_form
);
3403 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3408 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3409 if (EVENT_HAS_PARAMETERS (c
)
3410 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3411 XSETCAR (help_form_saved_window_configs
, Qnil
);
3413 while (BUFFERP (c
));
3414 /* Remove the help from the frame */
3415 unbind_to (count
, Qnil
);
3418 if (EQ (c
, make_number (040)))
3422 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3423 while (BUFFERP (c
));
3432 /* Record a key that came from a mouse menu.
3433 Record it for echoing, for this-command-keys, and so on. */
3439 /* Wipe the echo area. */
3440 clear_message (1, 0);
3445 before_command_key_count
= this_command_key_count
;
3446 before_command_echo_length
= echo_length ();
3449 /* Don't echo mouse motion events. */
3450 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3451 && NILP (Fzerop (Vecho_keystrokes
)))
3455 /* Once we reread a character, echoing can happen
3456 the next time we pause to read a new one. */
3457 ok_to_echo_at_next_pause
= 0;
3460 /* Record this character as part of the current key. */
3461 add_command_key (c
);
3463 /* Re-reading in the middle of a command */
3464 last_input_event
= c
;
3468 /* Return 1 if should recognize C as "the help character". */
3476 if (EQ (c
, Vhelp_char
))
3478 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3479 if (EQ (c
, XCAR (tail
)))
3484 /* Record the input event C in various ways. */
3492 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3494 /* To avoid filling recent_keys with help-echo and mouse-movement
3495 events, we filter out repeated help-echo events, only store the
3496 first and last in a series of mouse-movement events, and don't
3497 store repeated help-echo events which are only separated by
3498 mouse-movement events. */
3500 Lisp_Object ev1
, ev2
, ev3
;
3503 if ((ix1
= recent_keys_index
- 1) < 0)
3504 ix1
= NUM_RECENT_KEYS
- 1;
3505 ev1
= AREF (recent_keys
, ix1
);
3507 if ((ix2
= ix1
- 1) < 0)
3508 ix2
= NUM_RECENT_KEYS
- 1;
3509 ev2
= AREF (recent_keys
, ix2
);
3511 if ((ix3
= ix2
- 1) < 0)
3512 ix3
= NUM_RECENT_KEYS
- 1;
3513 ev3
= AREF (recent_keys
, ix3
);
3515 if (EQ (XCAR (c
), Qhelp_echo
))
3517 /* Don't record `help-echo' in recent_keys unless it shows some help
3518 message, and a different help than the previously recorded
3520 Lisp_Object help
, last_help
;
3522 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3523 if (!STRINGP (help
))
3525 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3526 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3528 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3529 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3530 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3532 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3533 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3534 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3535 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3538 else if (EQ (XCAR (c
), Qmouse_movement
))
3540 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3541 So additional mouse movement events replace the last element. */
3542 Lisp_Object last_window
, window
;
3544 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3545 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3546 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3547 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3548 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3550 ASET (recent_keys
, ix1
, c
);
3556 store_kbd_macro_char (c
);
3561 ASET (recent_keys
, recent_keys_index
, c
);
3562 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3563 recent_keys_index
= 0;
3565 else if (recorded
< 0)
3567 /* We need to remove one or two events from recent_keys.
3568 To do this, we simply put nil at those events and move the
3569 recent_keys_index backwards over those events. Usually,
3570 users will never see those nil events, as they will be
3571 overwritten by the command keys entered to see recent_keys
3574 while (recorded
++ < 0 && total_keys
> 0)
3576 if (total_keys
< NUM_RECENT_KEYS
)
3578 if (--recent_keys_index
< 0)
3579 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3580 ASET (recent_keys
, recent_keys_index
, Qnil
);
3584 num_nonmacro_input_events
++;
3586 /* Write c to the dribble file. If c is a lispy event, write
3587 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3588 If you, dear reader, have a better idea, you've got the source. :-) */
3594 if (XUINT (c
) < 0x100)
3595 putc (XINT (c
), dribble
);
3597 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3601 Lisp_Object dribblee
;
3603 /* If it's a structured event, take the event header. */
3604 dribblee
= EVENT_HEAD (c
);
3606 if (SYMBOLP (dribblee
))
3608 putc ('<', dribble
);
3609 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3610 SBYTES (SYMBOL_NAME (dribblee
)),
3612 putc ('>', dribble
);
3625 struct buffer
*old
= current_buffer
;
3626 Fprinc (object
, Qnil
);
3627 set_buffer_internal (XBUFFER (Vstandard_output
));
3628 call0 (intern ("help-mode"));
3629 set_buffer_internal (old
);
3633 /* Copy out or in the info on where C-g should throw to.
3634 This is used when running Lisp code from within get_char,
3635 in case get_char is called recursively.
3636 See read_process_output. */
3642 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3646 restore_getcjmp (temp
)
3649 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3652 /* Low level keyboard/mouse input.
3653 kbd_buffer_store_event places events in kbd_buffer, and
3654 kbd_buffer_get_event retrieves them. */
3656 /* Return true if there are any events in the queue that read-char
3657 would return. If this returns false, a read-char would block. */
3659 readable_events (flags
)
3663 /* Check whether a D-Bus message has arrived. */
3664 if (xd_pending_messages () > 0)
3666 #endif /* HAVE_DBUS */
3668 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3671 /* If the buffer contains only FOCUS_IN_EVENT events, and
3672 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3673 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3675 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3676 #ifdef USE_TOOLKIT_SCROLL_BARS
3677 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3681 struct input_event
*event
;
3683 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3690 #ifdef USE_TOOLKIT_SCROLL_BARS
3691 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3693 event
->kind
== FOCUS_IN_EVENT
)
3694 #ifdef USE_TOOLKIT_SCROLL_BARS
3695 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3696 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3697 && event
->part
== scroll_bar_handle
3698 && event
->modifiers
== 0)
3703 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3706 while (event
!= kbd_store_ptr
);
3712 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3713 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3714 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3719 if (current_kboard
->kbd_queue_has_data
)
3725 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3726 if (kb
->kbd_queue_has_data
)
3732 /* Set this for debugging, to have a way to get out */
3736 event_to_kboard (event
)
3737 struct input_event
*event
;
3740 frame
= event
->frame_or_window
;
3742 frame
= XCAR (frame
);
3743 else if (WINDOWP (frame
))
3744 frame
= WINDOW_FRAME (XWINDOW (frame
));
3746 /* There are still some events that don't set this field.
3747 For now, just ignore the problem.
3748 Also ignore dead frames here. */
3749 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3752 return FRAME_KBOARD (XFRAME (frame
));
3756 Lisp_Object Vthrow_on_input
;
3758 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3761 kbd_buffer_store_event (event
)
3762 register struct input_event
*event
;
3764 kbd_buffer_store_event_hold (event
, 0);
3767 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3769 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3770 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3771 Else, if EVENT is a quit event, store the quit event
3772 in HOLD_QUIT, and return (thus ignoring further events).
3774 This is used in read_avail_input to postpone the processing
3775 of the quit event until all subsequent input events have been
3776 parsed (and discarded).
3780 kbd_buffer_store_event_hold (event
, hold_quit
)
3781 register struct input_event
*event
;
3782 struct input_event
*hold_quit
;
3784 if (event
->kind
== NO_EVENT
)
3787 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3790 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3792 register int c
= event
->code
& 0377;
3794 if (event
->modifiers
& ctrl_modifier
)
3795 c
= make_ctrl_char (c
);
3797 c
|= (event
->modifiers
3798 & (meta_modifier
| alt_modifier
3799 | hyper_modifier
| super_modifier
));
3803 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3804 struct input_event
*sp
;
3806 if (single_kboard
&& kb
!= current_kboard
)
3809 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3810 Fcons (make_number (c
), Qnil
));
3811 kb
->kbd_queue_has_data
= 1;
3812 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3814 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3817 if (event_to_kboard (sp
) == kb
)
3819 sp
->kind
= NO_EVENT
;
3820 sp
->frame_or_window
= Qnil
;
3829 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3833 /* If this results in a quit_char being returned to Emacs as
3834 input, set Vlast_event_frame properly. If this doesn't
3835 get returned to Emacs as an event, the next event read
3836 will set Vlast_event_frame again, so this is safe to do. */
3840 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3842 focus
= event
->frame_or_window
;
3843 internal_last_event_frame
= focus
;
3844 Vlast_event_frame
= focus
;
3847 last_event_timestamp
= event
->timestamp
;
3848 handle_interrupt ();
3852 if (c
&& c
== stop_character
)
3858 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3859 Just ignore the second one. */
3860 else if (event
->kind
== BUFFER_SWITCH_EVENT
3861 && kbd_fetch_ptr
!= kbd_store_ptr
3862 && ((kbd_store_ptr
== kbd_buffer
3863 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3864 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3867 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3868 kbd_store_ptr
= kbd_buffer
;
3870 /* Don't let the very last slot in the buffer become full,
3871 since that would make the two pointers equal,
3872 and that is indistinguishable from an empty buffer.
3873 Discard the event if it would fill the last slot. */
3874 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3876 *kbd_store_ptr
= *event
;
3880 /* If we're inside while-no-input, and this event qualifies
3881 as input, set quit-flag to cause an interrupt. */
3882 if (!NILP (Vthrow_on_input
)
3883 && event
->kind
!= FOCUS_IN_EVENT
3884 && event
->kind
!= HELP_EVENT
3885 && event
->kind
!= DEICONIFY_EVENT
)
3887 Vquit_flag
= Vthrow_on_input
;
3888 /* If we're inside a function that wants immediate quits,
3890 if (immediate_quit
&& NILP (Vinhibit_quit
))
3900 /* Put an input event back in the head of the event queue. */
3903 kbd_buffer_unget_event (event
)
3904 register struct input_event
*event
;
3906 if (kbd_fetch_ptr
== kbd_buffer
)
3907 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3909 /* Don't let the very last slot in the buffer become full, */
3910 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3913 *kbd_fetch_ptr
= *event
;
3918 /* Generate HELP_EVENT input_events in BUFP which has room for
3919 SIZE events. If there's not enough room in BUFP, ignore this
3922 HELP is the help form.
3924 FRAME is the frame on which the help is generated. OBJECT is the
3925 Lisp object where the help was found (a buffer, a string, an
3926 overlay, or nil if neither from a string nor from a buffer. POS is
3927 the position within OBJECT where the help was found.
3929 Value is the number of input_events generated. */
3932 gen_help_event (help
, frame
, window
, object
, pos
)
3933 Lisp_Object help
, frame
, object
, window
;
3936 struct input_event event
;
3940 event
.kind
= HELP_EVENT
;
3941 event
.frame_or_window
= frame
;
3943 event
.x
= WINDOWP (window
) ? window
: frame
;
3946 kbd_buffer_store_event (&event
);
3950 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3953 kbd_buffer_store_help_event (frame
, help
)
3954 Lisp_Object frame
, help
;
3956 struct input_event event
;
3958 event
.kind
= HELP_EVENT
;
3959 event
.frame_or_window
= frame
;
3964 kbd_buffer_store_event (&event
);
3968 /* Discard any mouse events in the event buffer by setting them to
3971 discard_mouse_events ()
3973 struct input_event
*sp
;
3974 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3976 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3979 if (sp
->kind
== MOUSE_CLICK_EVENT
3980 || sp
->kind
== WHEEL_EVENT
3981 || sp
->kind
== HORIZ_WHEEL_EVENT
3983 || sp
->kind
== GPM_CLICK_EVENT
3985 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3987 sp
->kind
= NO_EVENT
;
3993 /* Return non-zero if there are any real events waiting in the event
3994 buffer, not counting `NO_EVENT's.
3996 If DISCARD is non-zero, discard NO_EVENT events at the front of
3997 the input queue, possibly leaving the input queue empty if there
3998 are no real input events. */
4001 kbd_buffer_events_waiting (discard
)
4004 struct input_event
*sp
;
4006 for (sp
= kbd_fetch_ptr
;
4007 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
4010 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4017 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
4021 /* Clear input event EVENT. */
4025 struct input_event
*event
;
4027 event
->kind
= NO_EVENT
;
4031 /* Read one event from the event buffer, waiting if necessary.
4032 The value is a Lisp object representing the event.
4033 The value is nil for an event that should be ignored,
4034 or that was handled here.
4035 We always read and discard one event. */
4038 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
4040 int *used_mouse_menu
;
4041 EMACS_TIME
*end_time
;
4047 /* In case we are running as a daemon, only do this before
4048 detaching from the terminal. */
4049 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
4053 *kbp
= current_kboard
;
4057 /* Wait until there is input available. */
4060 /* Break loop if there's an unread command event. Needed in
4061 moused window autoselection which uses a timer to insert such
4063 if (CONSP (Vunread_command_events
))
4066 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4068 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4069 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4073 /* If the quit flag is set, then read_char will return
4074 quit_char, so that counts as "available input." */
4075 if (!NILP (Vquit_flag
))
4076 quit_throw_to_read_char ();
4078 /* One way or another, wait until input is available; then, if
4079 interrupt handlers have not read it, read it now. */
4081 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4085 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4087 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4088 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4093 EMACS_TIME duration
;
4094 EMACS_GET_TIME (duration
);
4095 if (EMACS_TIME_GE (duration
, *end_time
))
4096 return Qnil
; /* finished waiting */
4099 EMACS_SUB_TIME (duration
, *end_time
, duration
);
4100 wait_reading_process_output (EMACS_SECS (duration
),
4101 EMACS_USECS (duration
),
4102 -1, 1, Qnil
, NULL
, 0);
4106 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
4108 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
4109 /* Pass 1 for EXPECT since we just waited to have input. */
4110 read_avail_input (1);
4113 if (CONSP (Vunread_command_events
))
4116 first
= XCAR (Vunread_command_events
);
4117 Vunread_command_events
= XCDR (Vunread_command_events
);
4118 *kbp
= current_kboard
;
4122 /* At this point, we know that there is a readable event available
4123 somewhere. If the event queue is empty, then there must be a
4124 mouse movement enabled and available. */
4125 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4127 struct input_event
*event
;
4129 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4133 last_event_timestamp
= event
->timestamp
;
4135 *kbp
= event_to_kboard (event
);
4137 *kbp
= current_kboard
; /* Better than returning null ptr? */
4141 /* These two kinds of events get special handling
4142 and don't actually appear to the command loop.
4143 We return nil for them. */
4144 if (event
->kind
== SELECTION_REQUEST_EVENT
4145 || event
->kind
== SELECTION_CLEAR_EVENT
)
4148 struct input_event copy
;
4150 /* Remove it from the buffer before processing it,
4151 since otherwise swallow_events will see it
4152 and process it again. */
4154 kbd_fetch_ptr
= event
+ 1;
4155 input_pending
= readable_events (0);
4156 x_handle_selection_event (©
);
4158 /* We're getting selection request events, but we don't have
4164 #if defined (HAVE_NS)
4165 else if (event
->kind
== NS_TEXT_EVENT
)
4167 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
4168 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
4170 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
4171 kbd_fetch_ptr
= event
+ 1;
4172 if (used_mouse_menu
)
4173 *used_mouse_menu
= 1;
4177 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4178 || defined (HAVE_NS)
4179 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4181 /* Make an event (delete-frame (FRAME)). */
4182 obj
= Fcons (event
->frame_or_window
, Qnil
);
4183 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4184 kbd_fetch_ptr
= event
+ 1;
4187 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4188 || defined (HAVE_NS)
4189 else if (event
->kind
== ICONIFY_EVENT
)
4191 /* Make an event (iconify-frame (FRAME)). */
4192 obj
= Fcons (event
->frame_or_window
, Qnil
);
4193 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4194 kbd_fetch_ptr
= event
+ 1;
4196 else if (event
->kind
== DEICONIFY_EVENT
)
4198 /* Make an event (make-frame-visible (FRAME)). */
4199 obj
= Fcons (event
->frame_or_window
, Qnil
);
4200 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4201 kbd_fetch_ptr
= event
+ 1;
4204 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4206 /* The value doesn't matter here; only the type is tested. */
4207 XSETBUFFER (obj
, current_buffer
);
4208 kbd_fetch_ptr
= event
+ 1;
4210 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4211 || defined(HAVE_NS) || defined (USE_GTK)
4212 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4214 kbd_fetch_ptr
= event
+ 1;
4215 input_pending
= readable_events (0);
4216 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4217 x_activate_menubar (XFRAME (event
->frame_or_window
));
4220 #if defined (WINDOWSNT)
4221 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4223 /* Make an event (language-change (FRAME CHARSET LCID)). */
4224 obj
= Fcons (event
->frame_or_window
, Qnil
);
4225 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4226 kbd_fetch_ptr
= event
+ 1;
4229 else if (event
->kind
== SAVE_SESSION_EVENT
)
4231 obj
= Fcons (Qsave_session
, Qnil
);
4232 kbd_fetch_ptr
= event
+ 1;
4234 /* Just discard these, by returning nil.
4235 With MULTI_KBOARD, these events are used as placeholders
4236 when we need to randomly delete events from the queue.
4237 (They shouldn't otherwise be found in the buffer,
4238 but on some machines it appears they do show up
4239 even without MULTI_KBOARD.) */
4240 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4241 mouse events during a popup-menu call. */
4242 else if (event
->kind
== NO_EVENT
)
4243 kbd_fetch_ptr
= event
+ 1;
4244 else if (event
->kind
== HELP_EVENT
)
4246 Lisp_Object object
, position
, help
, frame
, window
;
4248 frame
= event
->frame_or_window
;
4249 object
= event
->arg
;
4250 position
= make_number (event
->code
);
4253 clear_event (event
);
4255 kbd_fetch_ptr
= event
+ 1;
4256 if (!WINDOWP (window
))
4258 obj
= Fcons (Qhelp_echo
,
4259 list5 (frame
, help
, window
, object
, position
));
4261 else if (event
->kind
== FOCUS_IN_EVENT
)
4263 /* Notification of a FocusIn event. The frame receiving the
4264 focus is in event->frame_or_window. Generate a
4265 switch-frame event if necessary. */
4266 Lisp_Object frame
, focus
;
4268 frame
= event
->frame_or_window
;
4269 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4273 if (!EQ (frame
, internal_last_event_frame
)
4274 && !EQ (frame
, selected_frame
))
4275 obj
= make_lispy_switch_frame (frame
);
4276 internal_last_event_frame
= frame
;
4277 kbd_fetch_ptr
= event
+ 1;
4280 else if (event
->kind
== DBUS_EVENT
)
4282 obj
= make_lispy_event (event
);
4283 kbd_fetch_ptr
= event
+ 1;
4288 /* If this event is on a different frame, return a switch-frame this
4289 time, and leave the event in the queue for next time. */
4293 frame
= event
->frame_or_window
;
4295 frame
= XCAR (frame
);
4296 else if (WINDOWP (frame
))
4297 frame
= WINDOW_FRAME (XWINDOW (frame
));
4299 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4303 if (! EQ (frame
, internal_last_event_frame
)
4304 && !EQ (frame
, selected_frame
))
4305 obj
= make_lispy_switch_frame (frame
);
4306 internal_last_event_frame
= frame
;
4308 /* If we didn't decide to make a switch-frame event, go ahead
4309 and build a real event from the queue entry. */
4313 obj
= make_lispy_event (event
);
4315 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4316 || defined(HAVE_NS) || defined (USE_GTK)
4317 /* If this was a menu selection, then set the flag to inhibit
4318 writing to last_nonmenu_event. Don't do this if the event
4319 we're returning is (menu-bar), though; that indicates the
4320 beginning of the menu sequence, and we might as well leave
4321 that as the `event with parameters' for this selection. */
4323 && !EQ (event
->frame_or_window
, event
->arg
)
4324 && (event
->kind
== MENU_BAR_EVENT
4325 || event
->kind
== TOOL_BAR_EVENT
))
4326 *used_mouse_menu
= 1;
4329 /* certain system events are non-key events */
4331 && event
->kind
== NS_NONKEY_EVENT
)
4332 *used_mouse_menu
= 1;
4335 /* Wipe out this event, to catch bugs. */
4336 clear_event (event
);
4337 kbd_fetch_ptr
= event
+ 1;
4341 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4342 /* Try generating a mouse motion event. */
4343 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4345 FRAME_PTR f
= some_mouse_moved ();
4346 Lisp_Object bar_window
;
4347 enum scroll_bar_part part
;
4351 *kbp
= current_kboard
;
4352 /* Note that this uses F to determine which terminal to look at.
4353 If there is no valid info, it does not store anything
4354 so x remains nil. */
4357 /* XXX Can f or mouse_position_hook be NULL here? */
4358 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4359 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4360 &part
, &x
, &y
, &time
);
4364 /* Decide if we should generate a switch-frame event. Don't
4365 generate switch-frame events for motion outside of all Emacs
4371 frame
= FRAME_FOCUS_FRAME (f
);
4373 XSETFRAME (frame
, f
);
4375 if (! EQ (frame
, internal_last_event_frame
)
4376 && !EQ (frame
, selected_frame
))
4377 obj
= make_lispy_switch_frame (frame
);
4378 internal_last_event_frame
= frame
;
4381 /* If we didn't decide to make a switch-frame event, go ahead and
4382 return a mouse-motion event. */
4383 if (!NILP (x
) && NILP (obj
))
4384 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4386 #endif /* HAVE_MOUSE || HAVE GPM */
4388 /* We were promised by the above while loop that there was
4389 something for us to read! */
4392 input_pending
= readable_events (0);
4394 Vlast_event_frame
= internal_last_event_frame
;
4399 /* Process any events that are not user-visible,
4400 then return, without reading any user-visible events. */
4403 swallow_events (do_display
)
4408 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4410 struct input_event
*event
;
4412 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4416 last_event_timestamp
= event
->timestamp
;
4418 /* These two kinds of events get special handling
4419 and don't actually appear to the command loop. */
4420 if (event
->kind
== SELECTION_REQUEST_EVENT
4421 || event
->kind
== SELECTION_CLEAR_EVENT
)
4424 struct input_event copy
;
4426 /* Remove it from the buffer before processing it,
4427 since otherwise swallow_events called recursively could see it
4428 and process it again. */
4430 kbd_fetch_ptr
= event
+ 1;
4431 input_pending
= readable_events (0);
4432 x_handle_selection_event (©
);
4434 /* We're getting selection request events, but we don't have
4443 old_timers_run
= timers_run
;
4444 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4446 if (timers_run
!= old_timers_run
&& do_display
)
4447 redisplay_preserve_echo_area (7);
4450 /* Record the start of when Emacs is idle,
4451 for the sake of running idle-time timers. */
4458 /* If we are already in the idle state, do nothing. */
4459 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4462 EMACS_GET_TIME (timer_idleness_start_time
);
4464 timer_last_idleness_start_time
= timer_idleness_start_time
;
4466 /* Mark all idle-time timers as once again candidates for running. */
4467 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4471 timer
= XCAR (timers
);
4473 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4475 XVECTOR (timer
)->contents
[0] = Qnil
;
4479 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4484 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4487 /* Resume idle timer from last idle start time. */
4490 timer_resume_idle ()
4492 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4495 timer_idleness_start_time
= timer_last_idleness_start_time
;
4498 /* This is only for debugging. */
4499 struct input_event last_timer_event
;
4501 /* List of elisp functions to call, delayed because they were generated in
4502 a context where Elisp could not be safely run (e.g. redisplay, signal,
4503 ...). Each element has the form (FUN . ARGS). */
4504 Lisp_Object pending_funcalls
;
4506 extern Lisp_Object Qapply
;
4508 /* Check whether a timer has fired. To prevent larger problems we simply
4509 disregard elements that are not proper timers. Do not make a circular
4510 timer list for the time being.
4512 Returns the number of seconds to wait until the next timer fires. If a
4513 timer is triggering now, return zero seconds.
4514 If no timer is active, return -1 seconds.
4516 If a timer is ripe, we run it, with quitting turned off.
4518 DO_IT_NOW is now ignored. It used to mean that we should
4519 run the timer directly instead of queueing a timer-event.
4520 Now we always run timers directly. */
4523 timer_check (do_it_now
)
4526 EMACS_TIME nexttime
;
4527 EMACS_TIME now
, idleness_now
;
4528 Lisp_Object timers
, idle_timers
, chosen_timer
;
4529 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4531 EMACS_SET_SECS (nexttime
, -1);
4532 EMACS_SET_USECS (nexttime
, -1);
4534 /* Always consider the ordinary timers. */
4535 timers
= Vtimer_list
;
4536 /* Consider the idle timers only if Emacs is idle. */
4537 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4538 idle_timers
= Vtimer_idle_list
;
4541 chosen_timer
= Qnil
;
4542 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4544 /* First run the code that was delayed. */
4545 while (CONSP (pending_funcalls
))
4547 Lisp_Object funcall
= XCAR (pending_funcalls
);
4548 pending_funcalls
= XCDR (pending_funcalls
);
4549 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4552 if (CONSP (timers
) || CONSP (idle_timers
))
4554 EMACS_GET_TIME (now
);
4555 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4556 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4559 while (CONSP (timers
) || CONSP (idle_timers
))
4561 Lisp_Object
*vector
;
4562 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4563 EMACS_TIME timer_time
, idle_timer_time
;
4564 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4566 /* Skip past invalid timers and timers already handled. */
4569 timer
= XCAR (timers
);
4570 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4572 timers
= XCDR (timers
);
4575 vector
= XVECTOR (timer
)->contents
;
4577 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4578 || !INTEGERP (vector
[3])
4579 || ! NILP (vector
[0]))
4581 timers
= XCDR (timers
);
4585 if (!NILP (idle_timers
))
4587 timer
= XCAR (idle_timers
);
4588 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4590 idle_timers
= XCDR (idle_timers
);
4593 vector
= XVECTOR (timer
)->contents
;
4595 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4596 || !INTEGERP (vector
[3])
4597 || ! NILP (vector
[0]))
4599 idle_timers
= XCDR (idle_timers
);
4604 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4605 based on the next ordinary timer.
4606 TIMER_DIFFERENCE is the distance in time from NOW to when
4607 this timer becomes ripe (negative if it's already ripe). */
4610 timer
= XCAR (timers
);
4611 vector
= XVECTOR (timer
)->contents
;
4612 EMACS_SET_SECS (timer_time
,
4613 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4614 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4615 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4618 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4619 based on the next idle timer. */
4620 if (!NILP (idle_timers
))
4622 idle_timer
= XCAR (idle_timers
);
4623 vector
= XVECTOR (idle_timer
)->contents
;
4624 EMACS_SET_SECS (idle_timer_time
,
4625 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4626 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4627 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4630 /* Decide which timer is the next timer,
4631 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4632 Also step down the list where we found that timer. */
4634 if (! NILP (timers
) && ! NILP (idle_timers
))
4637 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4638 if (EMACS_TIME_NEG_P (temp
))
4640 chosen_timer
= timer
;
4641 timers
= XCDR (timers
);
4642 difference
= timer_difference
;
4646 chosen_timer
= idle_timer
;
4647 idle_timers
= XCDR (idle_timers
);
4648 difference
= idle_timer_difference
;
4651 else if (! NILP (timers
))
4653 chosen_timer
= timer
;
4654 timers
= XCDR (timers
);
4655 difference
= timer_difference
;
4659 chosen_timer
= idle_timer
;
4660 idle_timers
= XCDR (idle_timers
);
4661 difference
= idle_timer_difference
;
4663 vector
= XVECTOR (chosen_timer
)->contents
;
4665 /* If timer is ripe, run it if it hasn't been run. */
4666 if (EMACS_TIME_NEG_P (difference
)
4667 || (EMACS_SECS (difference
) == 0
4668 && EMACS_USECS (difference
) == 0))
4670 if (NILP (vector
[0]))
4672 int count
= SPECPDL_INDEX ();
4673 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4675 /* Mark the timer as triggered to prevent problems if the lisp
4676 code fails to reschedule it right. */
4679 specbind (Qinhibit_quit
, Qt
);
4681 call1 (Qtimer_event_handler
, chosen_timer
);
4682 Vdeactivate_mark
= old_deactivate_mark
;
4684 unbind_to (count
, Qnil
);
4686 /* Since we have handled the event,
4687 we don't need to tell the caller to wake up and do it. */
4691 /* When we encounter a timer that is still waiting,
4692 return the amount of time to wait before it is ripe. */
4699 /* No timers are pending in the future. */
4700 /* Return 0 if we generated an event, and -1 if not. */
4705 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4706 doc
: /* Return the current length of Emacs idleness, or nil.
4707 The value when Emacs is idle is a list of three integers. The first has
4708 the most significant 16 bits of the seconds, while the second has the least
4709 significant 16 bits. The third integer gives the microsecond count.
4711 The value when Emacs is not idle is nil.
4713 The microsecond count is zero on systems that do not provide
4714 resolution finer than a second. */)
4717 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4719 EMACS_TIME now
, idleness_now
;
4721 EMACS_GET_TIME (now
);
4722 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4724 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4725 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4726 make_number (EMACS_USECS (idleness_now
)));
4732 /* Caches for modify_event_symbol. */
4733 static Lisp_Object accent_key_syms
;
4734 static Lisp_Object func_key_syms
;
4735 static Lisp_Object mouse_syms
;
4736 static Lisp_Object wheel_syms
;
4737 static Lisp_Object drag_n_drop_syms
;
4739 /* This is a list of keysym codes for special "accent" characters.
4740 It parallels lispy_accent_keys. */
4742 static int lispy_accent_codes
[] =
4744 #ifdef XK_dead_circumflex
4749 #ifdef XK_dead_grave
4754 #ifdef XK_dead_tilde
4759 #ifdef XK_dead_diaeresis
4764 #ifdef XK_dead_macron
4769 #ifdef XK_dead_degree
4774 #ifdef XK_dead_acute
4779 #ifdef XK_dead_cedilla
4784 #ifdef XK_dead_breve
4789 #ifdef XK_dead_ogonek
4794 #ifdef XK_dead_caron
4799 #ifdef XK_dead_doubleacute
4800 XK_dead_doubleacute
,
4804 #ifdef XK_dead_abovedot
4809 #ifdef XK_dead_abovering
4819 #ifdef XK_dead_belowdot
4824 #ifdef XK_dead_voiced_sound
4825 XK_dead_voiced_sound
,
4829 #ifdef XK_dead_semivoiced_sound
4830 XK_dead_semivoiced_sound
,
4846 /* This is a list of Lisp names for special "accent" characters.
4847 It parallels lispy_accent_codes. */
4849 static char *lispy_accent_keys
[] =
4867 "dead-voiced-sound",
4868 "dead-semivoiced-sound",
4874 #define FUNCTION_KEY_OFFSET 0x0
4876 char *lispy_function_keys
[] =
4880 0, /* VK_LBUTTON 0x01 */
4881 0, /* VK_RBUTTON 0x02 */
4882 "cancel", /* VK_CANCEL 0x03 */
4883 0, /* VK_MBUTTON 0x04 */
4885 0, 0, 0, /* 0x05 .. 0x07 */
4887 "backspace", /* VK_BACK 0x08 */
4888 "tab", /* VK_TAB 0x09 */
4890 0, 0, /* 0x0A .. 0x0B */
4892 "clear", /* VK_CLEAR 0x0C */
4893 "return", /* VK_RETURN 0x0D */
4895 0, 0, /* 0x0E .. 0x0F */
4897 0, /* VK_SHIFT 0x10 */
4898 0, /* VK_CONTROL 0x11 */
4899 0, /* VK_MENU 0x12 */
4900 "pause", /* VK_PAUSE 0x13 */
4901 "capslock", /* VK_CAPITAL 0x14 */
4902 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4904 "junja", /* VK_JUNJA 0x17 */
4905 "final", /* VK_FINAL 0x18 */
4906 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4908 "escape", /* VK_ESCAPE 0x1B */
4909 "convert", /* VK_CONVERT 0x1C */
4910 "non-convert", /* VK_NONCONVERT 0x1D */
4911 "accept", /* VK_ACCEPT 0x1E */
4912 "mode-change", /* VK_MODECHANGE 0x1F */
4913 0, /* VK_SPACE 0x20 */
4914 "prior", /* VK_PRIOR 0x21 */
4915 "next", /* VK_NEXT 0x22 */
4916 "end", /* VK_END 0x23 */
4917 "home", /* VK_HOME 0x24 */
4918 "left", /* VK_LEFT 0x25 */
4919 "up", /* VK_UP 0x26 */
4920 "right", /* VK_RIGHT 0x27 */
4921 "down", /* VK_DOWN 0x28 */
4922 "select", /* VK_SELECT 0x29 */
4923 "print", /* VK_PRINT 0x2A */
4924 "execute", /* VK_EXECUTE 0x2B */
4925 "snapshot", /* VK_SNAPSHOT 0x2C */
4926 "insert", /* VK_INSERT 0x2D */
4927 "delete", /* VK_DELETE 0x2E */
4928 "help", /* VK_HELP 0x2F */
4930 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4932 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4934 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4936 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4938 0, 0, 0, 0, 0, 0, 0, 0, 0,
4939 0, 0, 0, 0, 0, 0, 0, 0, 0,
4940 0, 0, 0, 0, 0, 0, 0, 0,
4942 "lwindow", /* VK_LWIN 0x5B */
4943 "rwindow", /* VK_RWIN 0x5C */
4944 "apps", /* VK_APPS 0x5D */
4947 "kp-0", /* VK_NUMPAD0 0x60 */
4948 "kp-1", /* VK_NUMPAD1 0x61 */
4949 "kp-2", /* VK_NUMPAD2 0x62 */
4950 "kp-3", /* VK_NUMPAD3 0x63 */
4951 "kp-4", /* VK_NUMPAD4 0x64 */
4952 "kp-5", /* VK_NUMPAD5 0x65 */
4953 "kp-6", /* VK_NUMPAD6 0x66 */
4954 "kp-7", /* VK_NUMPAD7 0x67 */
4955 "kp-8", /* VK_NUMPAD8 0x68 */
4956 "kp-9", /* VK_NUMPAD9 0x69 */
4957 "kp-multiply", /* VK_MULTIPLY 0x6A */
4958 "kp-add", /* VK_ADD 0x6B */
4959 "kp-separator", /* VK_SEPARATOR 0x6C */
4960 "kp-subtract", /* VK_SUBTRACT 0x6D */
4961 "kp-decimal", /* VK_DECIMAL 0x6E */
4962 "kp-divide", /* VK_DIVIDE 0x6F */
4963 "f1", /* VK_F1 0x70 */
4964 "f2", /* VK_F2 0x71 */
4965 "f3", /* VK_F3 0x72 */
4966 "f4", /* VK_F4 0x73 */
4967 "f5", /* VK_F5 0x74 */
4968 "f6", /* VK_F6 0x75 */
4969 "f7", /* VK_F7 0x76 */
4970 "f8", /* VK_F8 0x77 */
4971 "f9", /* VK_F9 0x78 */
4972 "f10", /* VK_F10 0x79 */
4973 "f11", /* VK_F11 0x7A */
4974 "f12", /* VK_F12 0x7B */
4975 "f13", /* VK_F13 0x7C */
4976 "f14", /* VK_F14 0x7D */
4977 "f15", /* VK_F15 0x7E */
4978 "f16", /* VK_F16 0x7F */
4979 "f17", /* VK_F17 0x80 */
4980 "f18", /* VK_F18 0x81 */
4981 "f19", /* VK_F19 0x82 */
4982 "f20", /* VK_F20 0x83 */
4983 "f21", /* VK_F21 0x84 */
4984 "f22", /* VK_F22 0x85 */
4985 "f23", /* VK_F23 0x86 */
4986 "f24", /* VK_F24 0x87 */
4988 0, 0, 0, 0, /* 0x88 .. 0x8B */
4989 0, 0, 0, 0, /* 0x8C .. 0x8F */
4991 "kp-numlock", /* VK_NUMLOCK 0x90 */
4992 "scroll", /* VK_SCROLL 0x91 */
4993 /* Not sure where the following block comes from.
4994 Windows headers have NEC and Fujitsu specific keys in
4995 this block, but nothing generic. */
4996 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4997 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4998 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4999 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
5000 "kp-end", /* VK_NUMPAD_END 0x96 */
5001 "kp-home", /* VK_NUMPAD_HOME 0x97 */
5002 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
5003 "kp-up", /* VK_NUMPAD_UP 0x99 */
5004 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
5005 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
5006 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
5007 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
5009 0, 0, /* 0x9E .. 0x9F */
5012 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
5013 * Used only as parameters to GetAsyncKeyState and GetKeyState.
5014 * No other API or message will distinguish left and right keys this way.
5019 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
5020 to enable them selectively, and gives access to a few more functions.
5021 See lispy_multimedia_keys below. */
5022 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
5023 0, 0, 0, /* 0xAD .. 0xAF Volume */
5024 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
5025 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
5027 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
5028 0, 0, 0, 0, 0, 0, 0, 0, 0,
5030 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
5031 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5032 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5035 "ax", /* VK_OEM_AX 0xE1 */
5036 0, /* VK_OEM_102 0xE2 */
5037 "ico-help", /* VK_ICO_HELP 0xE3 */
5038 "ico-00", /* VK_ICO_00 0xE4 */
5039 0, /* VK_PROCESSKEY 0xE5 */
5040 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
5041 "packet", /* VK_PACKET 0xE7 */
5043 "reset", /* VK_OEM_RESET 0xE9 */
5044 "jump", /* VK_OEM_JUMP 0xEA */
5045 "oem-pa1", /* VK_OEM_PA1 0xEB */
5046 "oem-pa2", /* VK_OEM_PA2 0xEC */
5047 "oem-pa3", /* VK_OEM_PA3 0xED */
5048 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
5049 "cusel", /* VK_OEM_CUSEL 0xEF */
5050 "oem-attn", /* VK_OEM_ATTN 0xF0 */
5051 "finish", /* VK_OEM_FINISH 0xF1 */
5052 "copy", /* VK_OEM_COPY 0xF2 */
5053 "auto", /* VK_OEM_AUTO 0xF3 */
5054 "enlw", /* VK_OEM_ENLW 0xF4 */
5055 "backtab", /* VK_OEM_BACKTAB 0xF5 */
5056 "attn", /* VK_ATTN 0xF6 */
5057 "crsel", /* VK_CRSEL 0xF7 */
5058 "exsel", /* VK_EXSEL 0xF8 */
5059 "ereof", /* VK_EREOF 0xF9 */
5060 "play", /* VK_PLAY 0xFA */
5061 "zoom", /* VK_ZOOM 0xFB */
5062 "noname", /* VK_NONAME 0xFC */
5063 "pa1", /* VK_PA1 0xFD */
5064 "oem_clear", /* VK_OEM_CLEAR 0xFE */
5068 /* Some of these duplicate the "Media keys" on newer keyboards,
5069 but they are delivered to the application in a different way. */
5070 static char *lispy_multimedia_keys
[] =
5078 "browser-favorites",
5115 "toggle-dictate-command",
5121 "media-fast-forward",
5124 "media-channel-down"
5127 #else /* not HAVE_NTGUI */
5129 /* This should be dealt with in XTread_socket now, and that doesn't
5130 depend on the client system having the Kana syms defined. See also
5131 the XK_kana_A case below. */
5134 static char *lispy_kana_keys
[] =
5136 /* X Keysym value */
5137 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5138 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5139 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5140 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5141 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5142 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5143 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5144 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5145 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5146 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5147 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5148 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5149 "kana-i", "kana-u", "kana-e", "kana-o",
5150 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5151 "prolongedsound", "kana-A", "kana-I", "kana-U",
5152 "kana-E", "kana-O", "kana-KA", "kana-KI",
5153 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5154 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5155 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5156 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5157 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5158 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5159 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5160 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5161 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5162 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5163 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5164 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5166 #endif /* XK_kana_A */
5169 #define FUNCTION_KEY_OFFSET 0xff00
5171 /* You'll notice that this table is arranged to be conveniently
5172 indexed by X Windows keysym values. */
5173 static char *lispy_function_keys
[] =
5175 /* X Keysym value */
5177 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5178 "backspace", "tab", "linefeed", "clear",
5180 0, 0, 0, "pause", /* 0xff10...1f */
5181 0, 0, 0, 0, 0, 0, 0, "escape",
5183 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5184 "romaji", "hiragana", "katakana", "hiragana-katakana",
5185 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5186 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5187 "eisu-toggle", /* 0xff30...3f */
5188 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5189 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5191 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5192 "down", "prior", "next", "end",
5193 "begin", 0, 0, 0, 0, 0, 0, 0,
5194 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5205 "break", /* 0xff6b */
5208 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5209 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5210 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5211 0, 0, 0, 0, 0, 0, 0, 0,
5212 "kp-tab", /* 0xff89 */
5214 "kp-enter", /* 0xff8d */
5216 "kp-f1", /* 0xff91 */
5220 "kp-home", /* 0xff95 */
5225 "kp-prior", /* kp-page-up */
5226 "kp-next", /* kp-page-down */
5232 0, 0, 0, 0, 0, 0, 0, 0, 0,
5233 "kp-multiply", /* 0xffaa */
5238 "kp-divide", /* 0xffaf */
5239 "kp-0", /* 0xffb0 */
5240 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5243 "kp-equal", /* 0xffbd */
5244 "f1", /* 0xffbe */ /* IsFunctionKey */
5246 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5247 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5248 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5249 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5250 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5251 0, 0, 0, 0, 0, 0, 0, 0,
5252 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5253 0, 0, 0, 0, 0, 0, 0, "delete"
5256 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5257 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5259 static char *iso_lispy_function_keys
[] =
5261 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5262 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5263 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5264 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5265 "iso-lefttab", /* 0xfe20 */
5266 "iso-move-line-up", "iso-move-line-down",
5267 "iso-partial-line-up", "iso-partial-line-down",
5268 "iso-partial-space-left", "iso-partial-space-right",
5269 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5270 "iso-release-margin-left", "iso-release-margin-right",
5271 "iso-release-both-margins",
5272 "iso-fast-cursor-left", "iso-fast-cursor-right",
5273 "iso-fast-cursor-up", "iso-fast-cursor-down",
5274 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5275 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5278 #endif /* not HAVE_NTGUI */
5280 Lisp_Object Vlispy_mouse_stem
;
5282 static char *lispy_wheel_names
[] =
5284 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5287 /* drag-n-drop events are generated when a set of selected files are
5288 dragged from another application and dropped onto an Emacs window. */
5289 static char *lispy_drag_n_drop_names
[] =
5294 /* Scroll bar parts. */
5295 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5296 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5297 Lisp_Object Qtop
, Qratio
;
5299 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5300 Lisp_Object
*scroll_bar_parts
[] = {
5301 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5302 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5305 /* A vector, indexed by button number, giving the down-going location
5306 of currently depressed buttons, both scroll bar and non-scroll bar.
5308 The elements have the form
5309 (BUTTON-NUMBER MODIFIER-MASK . REST)
5310 where REST is the cdr of a position as it would be reported in the event.
5312 The make_lispy_event function stores positions here to tell the
5313 difference between click and drag events, and to store the starting
5314 location to be included in drag events. */
5316 static Lisp_Object button_down_location
;
5318 /* Information about the most recent up-going button event: Which
5319 button, what location, and what time. */
5321 static int last_mouse_button
;
5322 static int last_mouse_x
;
5323 static int last_mouse_y
;
5324 static unsigned long button_down_time
;
5326 /* The maximum time between clicks to make a double-click, or Qnil to
5327 disable double-click detection, or Qt for no time limit. */
5329 Lisp_Object Vdouble_click_time
;
5331 /* Maximum number of pixels the mouse may be moved between clicks
5332 to make a double-click. */
5334 EMACS_INT double_click_fuzz
;
5336 /* The number of clicks in this multiple-click. */
5338 int double_click_count
;
5340 /* Return position of a mouse click or wheel event */
5343 make_lispy_position (f
, x
, y
, time
)
5349 enum window_part part
;
5350 Lisp_Object posn
= Qnil
;
5351 Lisp_Object extra_info
= Qnil
;
5354 /* Set `window' to the window under frame pixel coordinates (x,y) */
5356 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5357 &part
, &wx
, &wy
, 0);
5361 if (WINDOWP (window
))
5363 /* It's a click in window window at frame coordinates (x,y) */
5364 struct window
*w
= XWINDOW (window
);
5365 Lisp_Object string_info
= Qnil
;
5366 int textpos
= -1, rx
= -1, ry
= -1;
5367 int dx
= -1, dy
= -1;
5368 int width
= -1, height
= -1;
5369 Lisp_Object object
= Qnil
;
5371 /* Set event coordinates to window-relative coordinates
5372 for constructing the Lisp event below. */
5376 if (part
== ON_TEXT
)
5378 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5380 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5382 /* Mode line or header line. Look for a string under
5383 the mouse that may have a `local-map' property. */
5387 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5389 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5390 &object
, &dx
, &dy
, &width
, &height
);
5391 if (STRINGP (string
))
5392 string_info
= Fcons (string
, make_number (charpos
));
5393 if (w
== XWINDOW (selected_window
)
5394 && current_buffer
== XBUFFER (w
->buffer
))
5397 textpos
= XMARKER (w
->pointm
)->charpos
;
5399 else if (part
== ON_VERTICAL_BORDER
)
5401 posn
= Qvertical_line
;
5406 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5411 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5413 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5414 &object
, &dx
, &dy
, &width
, &height
);
5415 if (STRINGP (string
))
5416 string_info
= Fcons (string
, make_number (charpos
));
5417 if (part
== ON_LEFT_MARGIN
)
5420 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5422 else if (part
== ON_LEFT_FRINGE
)
5424 posn
= Qleft_fringe
;
5427 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5429 : window_box_width (w
, LEFT_MARGIN_AREA
));
5432 else if (part
== ON_RIGHT_FRINGE
)
5434 posn
= Qright_fringe
;
5437 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5438 + window_box_width (w
, TEXT_AREA
)
5439 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5440 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5446 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5447 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5452 Lisp_Object string2
, object2
= Qnil
;
5453 struct display_pos p
;
5455 int width2
, height2
;
5456 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5457 &object2
, &dx2
, &dy2
,
5459 textpos
= CHARPOS (p
.pos
);
5460 if (rx
< 0) rx
= wx
;
5461 if (ry
< 0) ry
= wy
;
5462 if (dx
< 0) dx
= dx2
;
5463 if (dy
< 0) dy
= dy2
;
5464 if (width
< 0) width
= width2
;
5465 if (height
< 0) height
= height2
;
5469 posn
= make_number (textpos
);
5470 if (STRINGP (string2
))
5471 string_info
= Fcons (string2
,
5472 make_number (CHARPOS (p
.string_pos
)));
5478 #ifdef HAVE_WINDOW_SYSTEM
5479 if (IMAGEP (object
))
5481 Lisp_Object image_map
, hotspot
;
5482 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5484 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5486 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5487 posn
= XCAR (hotspot
);
5492 extra_info
= Fcons (object
,
5493 Fcons (Fcons (make_number (dx
),
5495 Fcons (Fcons (make_number (width
),
5496 make_number (height
)),
5500 extra_info
= Fcons (string_info
,
5501 Fcons (make_number (textpos
),
5502 Fcons (Fcons (make_number (rx
),
5508 XSETFRAME (window
, f
);
5513 XSETFASTINT (*x
, 0);
5514 XSETFASTINT (*y
, 0);
5517 return Fcons (window
,
5519 Fcons (Fcons (*x
, *y
),
5520 Fcons (make_number (time
),
5524 /* Given a struct input_event, build the lisp event which represents
5525 it. If EVENT is 0, build a mouse movement event from the mouse
5526 movement buffer, which should have a movement event in it.
5528 Note that events must be passed to this function in the order they
5529 are received; this function stores the location of button presses
5530 in order to build drag events when the button is released. */
5533 make_lispy_event (event
)
5534 struct input_event
*event
;
5538 switch (SWITCH_ENUM_CAST (event
->kind
))
5540 /* A simple keystroke. */
5541 case ASCII_KEYSTROKE_EVENT
:
5542 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5544 Lisp_Object lispy_c
;
5545 int c
= event
->code
;
5546 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5549 eassert (c
== event
->code
);
5550 /* Turn ASCII characters into control characters
5552 if (event
->modifiers
& ctrl_modifier
)
5554 c
= make_ctrl_char (c
);
5555 event
->modifiers
&= ~ctrl_modifier
;
5559 /* Add in the other modifier bits. The shift key was taken care
5560 of by the X code. */
5561 c
|= (event
->modifiers
5562 & (meta_modifier
| alt_modifier
5563 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5564 /* Distinguish Shift-SPC from SPC. */
5565 if ((event
->code
) == 040
5566 && event
->modifiers
& shift_modifier
)
5567 c
|= shift_modifier
;
5568 button_down_time
= 0;
5569 XSETFASTINT (lispy_c
, c
);
5574 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5575 except that they are non-key events (last-nonmenu-event is nil). */
5576 case NS_NONKEY_EVENT
:
5579 /* A function key. The symbol may need to have modifier prefixes
5581 case NON_ASCII_KEYSTROKE_EVENT
:
5582 button_down_time
= 0;
5584 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5585 if (event
->code
== lispy_accent_codes
[i
])
5586 return modify_event_symbol (i
,
5588 Qfunction_key
, Qnil
,
5589 lispy_accent_keys
, &accent_key_syms
,
5590 (sizeof (lispy_accent_keys
)
5591 / sizeof (lispy_accent_keys
[0])));
5595 if (event
->code
>= 0x400 && event
->code
< 0x500)
5596 return modify_event_symbol (event
->code
- 0x400,
5597 event
->modifiers
& ~shift_modifier
,
5598 Qfunction_key
, Qnil
,
5599 lispy_kana_keys
, &func_key_syms
,
5600 (sizeof (lispy_kana_keys
)
5601 / sizeof (lispy_kana_keys
[0])));
5602 #endif /* XK_kana_A */
5605 #ifdef ISO_FUNCTION_KEY_OFFSET
5606 if (event
->code
< FUNCTION_KEY_OFFSET
5607 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5608 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5610 Qfunction_key
, Qnil
,
5611 iso_lispy_function_keys
, &func_key_syms
,
5612 (sizeof (iso_lispy_function_keys
)
5613 / sizeof (iso_lispy_function_keys
[0])));
5616 /* Handle system-specific or unknown keysyms. */
5617 if (event
->code
& (1 << 28)
5618 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5619 || (event
->code
- FUNCTION_KEY_OFFSET
5620 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5621 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5623 /* We need to use an alist rather than a vector as the cache
5624 since we can't make a vector long enuf. */
5625 if (NILP (current_kboard
->system_key_syms
))
5626 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5627 return modify_event_symbol (event
->code
,
5630 current_kboard
->Vsystem_key_alist
,
5631 0, ¤t_kboard
->system_key_syms
,
5635 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5637 Qfunction_key
, Qnil
,
5638 lispy_function_keys
, &func_key_syms
,
5639 (sizeof (lispy_function_keys
)
5640 / sizeof (lispy_function_keys
[0])));
5643 case MULTIMEDIA_KEY_EVENT
:
5644 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5645 / sizeof (lispy_multimedia_keys
[0]))
5646 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5648 return modify_event_symbol (event
->code
, event
->modifiers
,
5649 Qfunction_key
, Qnil
,
5650 lispy_multimedia_keys
, &func_key_syms
,
5651 (sizeof (lispy_multimedia_keys
)
5652 / sizeof (lispy_multimedia_keys
[0])));
5658 /* A mouse click. Figure out where it is, decide whether it's
5659 a press, click or drag, and build the appropriate structure. */
5660 case MOUSE_CLICK_EVENT
:
5661 #ifndef USE_TOOLKIT_SCROLL_BARS
5662 case SCROLL_BAR_CLICK_EVENT
:
5665 int button
= event
->code
;
5667 Lisp_Object position
;
5668 Lisp_Object
*start_pos_ptr
;
5669 Lisp_Object start_pos
;
5673 /* Build the position as appropriate for this mouse click. */
5674 if (event
->kind
== MOUSE_CLICK_EVENT
)
5676 struct frame
*f
= XFRAME (event
->frame_or_window
);
5677 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5681 /* Ignore mouse events that were made on frame that
5682 have been deleted. */
5683 if (! FRAME_LIVE_P (f
))
5686 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5687 /* EVENT->x and EVENT->y are frame-relative pixel
5688 coordinates at this place. Under old redisplay, COLUMN
5689 and ROW are set to frame relative glyph coordinates
5690 which are then used to determine whether this click is
5691 in a menu (non-toolkit version). */
5692 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5693 &column
, &row
, NULL
, 1);
5695 /* In the non-toolkit version, clicks on the menu bar
5696 are ordinary button events in the event buffer.
5697 Distinguish them, and invoke the menu.
5699 (In the toolkit version, the toolkit handles the menu bar
5700 and Emacs doesn't know about it until after the user
5701 makes a selection.) */
5702 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5703 && (event
->modifiers
& down_modifier
))
5705 Lisp_Object items
, item
;
5710 /* Activate the menu bar on the down event. If the
5711 up event comes in before the menu code can deal with it,
5713 if (! (event
->modifiers
& down_modifier
))
5717 /* Find the menu bar item under `column'. */
5719 items
= FRAME_MENU_BAR_ITEMS (f
);
5720 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5722 Lisp_Object pos
, string
;
5723 string
= AREF (items
, i
+ 1);
5724 pos
= AREF (items
, i
+ 3);
5727 if (column
>= XINT (pos
)
5728 && column
< XINT (pos
) + SCHARS (string
))
5730 item
= AREF (items
, i
);
5735 /* ELisp manual 2.4b says (x y) are window relative but
5736 code says they are frame-relative. */
5738 = Fcons (event
->frame_or_window
,
5740 Fcons (Fcons (event
->x
, event
->y
),
5741 Fcons (make_number (event
->timestamp
),
5744 return Fcons (item
, Fcons (position
, Qnil
));
5746 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5748 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5751 #ifndef USE_TOOLKIT_SCROLL_BARS
5754 /* It's a scrollbar click. */
5756 Lisp_Object portion_whole
;
5759 window
= event
->frame_or_window
;
5760 portion_whole
= Fcons (event
->x
, event
->y
);
5761 part
= *scroll_bar_parts
[(int) event
->part
];
5765 Fcons (Qvertical_scroll_bar
,
5766 Fcons (portion_whole
,
5767 Fcons (make_number (event
->timestamp
),
5768 Fcons (part
, Qnil
)))));
5770 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5772 if (button
>= ASIZE (button_down_location
))
5774 button_down_location
= larger_vector (button_down_location
,
5776 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5779 start_pos_ptr
= &AREF (button_down_location
, button
);
5780 start_pos
= *start_pos_ptr
;
5781 *start_pos_ptr
= Qnil
;
5784 /* On window-system frames, use the value of
5785 double-click-fuzz as is. On other frames, interpret it
5786 as a multiple of 1/8 characters. */
5790 if (WINDOWP (event
->frame_or_window
))
5791 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5792 else if (FRAMEP (event
->frame_or_window
))
5793 f
= XFRAME (event
->frame_or_window
);
5797 if (FRAME_WINDOW_P (f
))
5798 fuzz
= double_click_fuzz
;
5800 fuzz
= double_click_fuzz
/ 8;
5802 is_double
= (button
== last_mouse_button
5803 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5804 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5805 && button_down_time
!= 0
5806 && (EQ (Vdouble_click_time
, Qt
)
5807 || (INTEGERP (Vdouble_click_time
)
5808 && ((int)(event
->timestamp
- button_down_time
)
5809 < XINT (Vdouble_click_time
)))));
5812 last_mouse_button
= button
;
5813 last_mouse_x
= XINT (event
->x
);
5814 last_mouse_y
= XINT (event
->y
);
5816 /* If this is a button press, squirrel away the location, so
5817 we can decide later whether it was a click or a drag. */
5818 if (event
->modifiers
& down_modifier
)
5822 double_click_count
++;
5823 event
->modifiers
|= ((double_click_count
> 2)
5828 double_click_count
= 1;
5829 button_down_time
= event
->timestamp
;
5830 *start_pos_ptr
= Fcopy_alist (position
);
5831 ignore_mouse_drag_p
= 0;
5834 /* Now we're releasing a button - check the co-ordinates to
5835 see if this was a click or a drag. */
5836 else if (event
->modifiers
& up_modifier
)
5838 /* If we did not see a down before this up, ignore the up.
5839 Probably this happened because the down event chose a
5840 menu item. It would be an annoyance to treat the
5841 release of the button that chose the menu item as a
5844 if (!CONSP (start_pos
))
5847 event
->modifiers
&= ~up_modifier
;
5848 #if 0 /* Formerly we treated an up with no down as a click event. */
5849 if (!CONSP (start_pos
))
5850 event
->modifiers
|= click_modifier
;
5855 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5857 /* The third element of every position
5858 should be the (x,y) pair. */
5859 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5861 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5863 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5864 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5867 if (ignore_mouse_drag_p
)
5869 event
->modifiers
|= click_modifier
;
5870 ignore_mouse_drag_p
= 0;
5872 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5873 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5874 /* Maybe the mouse has moved a lot, caused scrolling, and
5875 eventually ended up at the same screen position (but
5876 not buffer position) in which case it is a drag, not
5878 /* FIXME: OTOH if the buffer position has changed
5879 because of a timer or process filter rather than
5880 because of mouse movement, it should be considered as
5881 a click. But mouse-drag-region completely ignores
5882 this case and it hasn't caused any real problem, so
5883 it's probably OK to ignore it as well. */
5884 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5885 /* Mouse hasn't moved (much). */
5886 event
->modifiers
|= click_modifier
;
5889 button_down_time
= 0;
5890 event
->modifiers
|= drag_modifier
;
5893 /* Don't check is_double; treat this as multiple
5894 if the down-event was multiple. */
5895 if (double_click_count
> 1)
5896 event
->modifiers
|= ((double_click_count
> 2)
5902 /* Every mouse event should either have the down_modifier or
5903 the up_modifier set. */
5907 /* Get the symbol we should use for the mouse click. */
5910 head
= modify_event_symbol (button
,
5912 Qmouse_click
, Vlispy_mouse_stem
,
5915 XVECTOR (mouse_syms
)->size
);
5916 if (event
->modifiers
& drag_modifier
)
5921 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5924 Fcons (make_number (double_click_count
),
5934 case HORIZ_WHEEL_EVENT
:
5936 Lisp_Object position
;
5939 /* Build the position as appropriate for this mouse click. */
5940 struct frame
*f
= XFRAME (event
->frame_or_window
);
5942 /* Ignore wheel events that were made on frame that have been
5944 if (! FRAME_LIVE_P (f
))
5947 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5950 /* Set double or triple modifiers to indicate the wheel speed. */
5952 /* On window-system frames, use the value of
5953 double-click-fuzz as is. On other frames, interpret it
5954 as a multiple of 1/8 characters. */
5960 if (WINDOWP (event
->frame_or_window
))
5961 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5962 else if (FRAMEP (event
->frame_or_window
))
5963 f
= XFRAME (event
->frame_or_window
);
5967 if (FRAME_WINDOW_P (f
))
5968 fuzz
= double_click_fuzz
;
5970 fuzz
= double_click_fuzz
/ 8;
5972 if (event
->modifiers
& up_modifier
)
5974 /* Emit a wheel-up event. */
5975 event
->modifiers
&= ~up_modifier
;
5978 else if (event
->modifiers
& down_modifier
)
5980 /* Emit a wheel-down event. */
5981 event
->modifiers
&= ~down_modifier
;
5985 /* Every wheel event should either have the down_modifier or
5986 the up_modifier set. */
5989 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5992 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5993 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5994 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5995 && button_down_time
!= 0
5996 && (EQ (Vdouble_click_time
, Qt
)
5997 || (INTEGERP (Vdouble_click_time
)
5998 && ((int)(event
->timestamp
- button_down_time
)
5999 < XINT (Vdouble_click_time
)))));
6002 double_click_count
++;
6003 event
->modifiers
|= ((double_click_count
> 2)
6009 double_click_count
= 1;
6010 event
->modifiers
|= click_modifier
;
6013 button_down_time
= event
->timestamp
;
6014 /* Use a negative value to distinguish wheel from mouse button. */
6015 last_mouse_button
= - (1 + symbol_num
);
6016 last_mouse_x
= XINT (event
->x
);
6017 last_mouse_y
= XINT (event
->y
);
6019 /* Get the symbol we should use for the wheel event. */
6020 head
= modify_event_symbol (symbol_num
,
6026 ASIZE (wheel_syms
));
6029 if (event
->modifiers
& (double_modifier
| triple_modifier
))
6032 Fcons (make_number (double_click_count
),
6041 #ifdef USE_TOOLKIT_SCROLL_BARS
6043 /* We don't have down and up events if using toolkit scroll bars,
6044 so make this always a click event. Store in the `part' of
6045 the Lisp event a symbol which maps to the following actions:
6047 `above_handle' page up
6048 `below_handle' page down
6052 `bottom' bottom of buffer
6053 `handle' thumb has been dragged.
6054 `end-scroll' end of interaction with scroll bar
6056 The incoming input_event contains in its `part' member an
6057 index of type `enum scroll_bar_part' which we can use as an
6058 index in scroll_bar_parts to get the appropriate symbol. */
6060 case SCROLL_BAR_CLICK_EVENT
:
6062 Lisp_Object position
, head
, window
, portion_whole
, part
;
6064 window
= event
->frame_or_window
;
6065 portion_whole
= Fcons (event
->x
, event
->y
);
6066 part
= *scroll_bar_parts
[(int) event
->part
];
6070 Fcons (Qvertical_scroll_bar
,
6071 Fcons (portion_whole
,
6072 Fcons (make_number (event
->timestamp
),
6073 Fcons (part
, Qnil
)))));
6075 /* Always treat scroll bar events as clicks. */
6076 event
->modifiers
|= click_modifier
;
6077 event
->modifiers
&= ~up_modifier
;
6079 if (event
->code
>= ASIZE (mouse_syms
))
6080 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
6082 /* Get the symbol we should use for the mouse click. */
6083 head
= modify_event_symbol (event
->code
,
6088 XVECTOR (mouse_syms
)->size
);
6089 return Fcons (head
, Fcons (position
, Qnil
));
6092 #endif /* USE_TOOLKIT_SCROLL_BARS */
6094 case DRAG_N_DROP_EVENT
:
6097 Lisp_Object head
, position
;
6100 f
= XFRAME (event
->frame_or_window
);
6103 /* Ignore mouse events that were made on frames that
6104 have been deleted. */
6105 if (! FRAME_LIVE_P (f
))
6108 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6111 head
= modify_event_symbol (0, event
->modifiers
,
6113 lispy_drag_n_drop_names
,
6114 &drag_n_drop_syms
, 1);
6120 #endif /* HAVE_MOUSE */
6122 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6123 || defined(HAVE_NS) || defined (USE_GTK)
6124 case MENU_BAR_EVENT
:
6125 if (EQ (event
->arg
, event
->frame_or_window
))
6126 /* This is the prefix key. We translate this to
6127 `(menu_bar)' because the code in keyboard.c for menu
6128 events, which we use, relies on this. */
6129 return Fcons (Qmenu_bar
, Qnil
);
6133 case SELECT_WINDOW_EVENT
:
6134 /* Make an event (select-window (WINDOW)). */
6135 return Fcons (Qselect_window
,
6136 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6139 case TOOL_BAR_EVENT
:
6140 if (EQ (event
->arg
, event
->frame_or_window
))
6141 /* This is the prefix key. We translate this to
6142 `(tool_bar)' because the code in keyboard.c for tool bar
6143 events, which we use, relies on this. */
6144 return Fcons (Qtool_bar
, Qnil
);
6145 else if (SYMBOLP (event
->arg
))
6146 return apply_modifiers (event
->modifiers
, event
->arg
);
6149 case USER_SIGNAL_EVENT
:
6150 /* A user signal. */
6152 char *name
= find_user_signal_name (event
->code
);
6155 return intern (name
);
6158 case SAVE_SESSION_EVENT
:
6159 return Qsave_session
;
6164 return Fcons (Qdbus_event
, event
->arg
);
6166 #endif /* HAVE_DBUS */
6169 case GPM_CLICK_EVENT
:
6171 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6172 Lisp_Object head
, position
;
6173 Lisp_Object
*start_pos_ptr
;
6174 Lisp_Object start_pos
;
6175 int button
= event
->code
;
6177 if (button
>= ASIZE (button_down_location
))
6179 button_down_location
= larger_vector (button_down_location
,
6181 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6184 start_pos_ptr
= &AREF (button_down_location
, button
);
6185 start_pos
= *start_pos_ptr
;
6187 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6190 if (event
->modifiers
& down_modifier
)
6191 *start_pos_ptr
= Fcopy_alist (position
);
6192 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6194 if (!CONSP (start_pos
))
6196 event
->modifiers
&= ~up_modifier
;
6199 head
= modify_event_symbol (button
,
6201 Qmouse_click
, Vlispy_mouse_stem
,
6204 XVECTOR (mouse_syms
)->size
);
6206 if (event
->modifiers
& drag_modifier
)
6211 else if (event
->modifiers
& double_modifier
)
6214 Fcons (make_number (2),
6216 else if (event
->modifiers
& triple_modifier
)
6219 Fcons (make_number (3),
6226 #endif /* HAVE_GPM */
6228 /* The 'kind' field of the event is something we don't recognize. */
6234 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6237 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6239 Lisp_Object bar_window
;
6240 enum scroll_bar_part part
;
6244 /* Is it a scroll bar movement? */
6245 if (frame
&& ! NILP (bar_window
))
6247 Lisp_Object part_sym
;
6249 part_sym
= *scroll_bar_parts
[(int) part
];
6250 return Fcons (Qscroll_bar_movement
,
6251 (Fcons (Fcons (bar_window
,
6252 Fcons (Qvertical_scroll_bar
,
6253 Fcons (Fcons (x
, y
),
6254 Fcons (make_number (time
),
6260 /* Or is it an ordinary mouse movement? */
6263 Lisp_Object position
;
6265 position
= make_lispy_position (frame
, &x
, &y
, time
);
6267 return Fcons (Qmouse_movement
,
6273 #endif /* HAVE_MOUSE || HAVE GPM */
6275 /* Construct a switch frame event. */
6277 make_lispy_switch_frame (frame
)
6280 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6283 /* Manipulating modifiers. */
6285 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6287 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6288 SYMBOL's name of the end of the modifiers; the string from this
6289 position is the unmodified symbol name.
6291 This doesn't use any caches. */
6294 parse_modifiers_uncached (symbol
, modifier_end
)
6302 CHECK_SYMBOL (symbol
);
6305 name
= SYMBOL_NAME (symbol
);
6307 for (i
= 0; i
+2 <= SBYTES (name
); )
6309 int this_mod_end
= 0;
6312 /* See if the name continues with a modifier word.
6313 Check that the word appears, but don't check what follows it.
6314 Set this_mod and this_mod_end to record what we find. */
6316 switch (SREF (name
, i
))
6318 #define SINGLE_LETTER_MOD(BIT) \
6319 (this_mod_end = i + 1, this_mod = BIT)
6322 SINGLE_LETTER_MOD (alt_modifier
);
6326 SINGLE_LETTER_MOD (ctrl_modifier
);
6330 SINGLE_LETTER_MOD (hyper_modifier
);
6334 SINGLE_LETTER_MOD (meta_modifier
);
6338 SINGLE_LETTER_MOD (shift_modifier
);
6342 SINGLE_LETTER_MOD (super_modifier
);
6345 #undef SINGLE_LETTER_MOD
6347 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6348 if (i + LEN + 1 <= SBYTES (name) \
6349 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6351 this_mod_end = i + LEN; \
6356 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6357 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6358 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6362 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6364 #undef MULTI_LETTER_MOD
6368 /* If we found no modifier, stop looking for them. */
6369 if (this_mod_end
== 0)
6372 /* Check there is a dash after the modifier, so that it
6373 really is a modifier. */
6374 if (this_mod_end
>= SBYTES (name
)
6375 || SREF (name
, this_mod_end
) != '-')
6378 /* This modifier is real; look for another. */
6379 modifiers
|= this_mod
;
6380 i
= this_mod_end
+ 1;
6383 /* Should we include the `click' modifier? */
6384 if (! (modifiers
& (down_modifier
| drag_modifier
6385 | double_modifier
| triple_modifier
))
6386 && i
+ 7 == SBYTES (name
)
6387 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6388 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6389 modifiers
|= click_modifier
;
6391 if (! (modifiers
& (double_modifier
| triple_modifier
))
6392 && i
+ 6 < SBYTES (name
)
6393 && strncmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6394 modifiers
|= click_modifier
;
6402 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6403 prepended to the string BASE[0..BASE_LEN-1].
6404 This doesn't use any caches. */
6406 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6409 int base_len
, base_len_byte
;
6411 /* Since BASE could contain nulls, we can't use intern here; we have
6412 to use Fintern, which expects a genuine Lisp_String, and keeps a
6415 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6421 /* Only the event queue may use the `up' modifier; it should always
6422 be turned into a click or drag event before presented to lisp code. */
6423 if (modifiers
& up_modifier
)
6426 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6427 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6428 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6429 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6430 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6431 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6432 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6433 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6434 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6435 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6436 /* The click modifier is denoted by the absence of other modifiers. */
6440 mod_len
= p
- new_mods
;
6444 Lisp_Object new_name
;
6446 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6447 mod_len
+ base_len_byte
);
6448 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6449 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6451 return Fintern (new_name
, Qnil
);
6456 static char *modifier_names
[] =
6458 "up", "down", "drag", "click", "double", "triple", 0, 0,
6459 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6460 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6462 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6464 static Lisp_Object modifier_symbols
;
6466 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6468 lispy_modifier_list (modifiers
)
6471 Lisp_Object modifier_list
;
6474 modifier_list
= Qnil
;
6475 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6476 if (modifiers
& (1<<i
))
6477 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6480 return modifier_list
;
6484 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6485 where UNMODIFIED is the unmodified form of SYMBOL,
6486 MASK is the set of modifiers present in SYMBOL's name.
6487 This is similar to parse_modifiers_uncached, but uses the cache in
6488 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6489 Qevent_symbol_elements property. */
6491 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6494 parse_modifiers (symbol
)
6497 Lisp_Object elements
;
6499 if (INTEGERP (symbol
))
6500 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6501 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6503 else if (!SYMBOLP (symbol
))
6506 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6507 if (CONSP (elements
))
6512 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6513 Lisp_Object unmodified
;
6516 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6517 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6520 if (modifiers
& ~INTMASK
)
6522 XSETFASTINT (mask
, modifiers
);
6523 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6525 /* Cache the parsing results on SYMBOL. */
6526 Fput (symbol
, Qevent_symbol_element_mask
,
6528 Fput (symbol
, Qevent_symbol_elements
,
6529 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6531 /* Since we know that SYMBOL is modifiers applied to unmodified,
6532 it would be nice to put that in unmodified's cache.
6533 But we can't, since we're not sure that parse_modifiers is
6540 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6541 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6542 doc
: /* Parse the event symbol. For internal use. */)
6546 /* Fill the cache if needed. */
6547 parse_modifiers (symbol
);
6548 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6549 and use the Lispier representation stored on Qevent_symbol_elements
6551 return Fget (symbol
, Qevent_symbol_elements
);
6554 /* Apply the modifiers MODIFIERS to the symbol BASE.
6555 BASE must be unmodified.
6557 This is like apply_modifiers_uncached, but uses BASE's
6558 Qmodifier_cache property, if present. It also builds
6559 Qevent_symbol_elements properties, since it has that info anyway.
6561 apply_modifiers copies the value of BASE's Qevent_kind property to
6562 the modified symbol. */
6564 apply_modifiers (modifiers
, base
)
6568 Lisp_Object cache
, index
, entry
, new_symbol
;
6570 /* Mask out upper bits. We don't know where this value's been. */
6571 modifiers
&= INTMASK
;
6573 if (INTEGERP (base
))
6574 return make_number (XINT (base
) | modifiers
);
6576 /* The click modifier never figures into cache indices. */
6577 cache
= Fget (base
, Qmodifier_cache
);
6578 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6579 entry
= assq_no_quit (index
, cache
);
6582 new_symbol
= XCDR (entry
);
6585 /* We have to create the symbol ourselves. */
6586 new_symbol
= apply_modifiers_uncached (modifiers
,
6587 SDATA (SYMBOL_NAME (base
)),
6588 SCHARS (SYMBOL_NAME (base
)),
6589 SBYTES (SYMBOL_NAME (base
)));
6591 /* Add the new symbol to the base's cache. */
6592 entry
= Fcons (index
, new_symbol
);
6593 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6595 /* We have the parsing info now for free, so we could add it to
6597 XSETFASTINT (index, modifiers);
6598 Fput (new_symbol, Qevent_symbol_element_mask,
6599 Fcons (base, Fcons (index, Qnil)));
6600 Fput (new_symbol, Qevent_symbol_elements,
6601 Fcons (base, lispy_modifier_list (modifiers)));
6602 Sadly, this is only correct if `base' is indeed a base event,
6603 which is not necessarily the case. -stef */
6606 /* Make sure this symbol is of the same kind as BASE.
6608 You'd think we could just set this once and for all when we
6609 intern the symbol above, but reorder_modifiers may call us when
6610 BASE's property isn't set right; we can't assume that just
6611 because it has a Qmodifier_cache property it must have its
6612 Qevent_kind set right as well. */
6613 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6617 kind
= Fget (base
, Qevent_kind
);
6619 Fput (new_symbol
, Qevent_kind
, kind
);
6626 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6627 return a symbol with the modifiers placed in the canonical order.
6628 Canonical order is alphabetical, except for down and drag, which
6629 always come last. The 'click' modifier is never written out.
6631 Fdefine_key calls this to make sure that (for example) C-M-foo
6632 and M-C-foo end up being equivalent in the keymap. */
6635 reorder_modifiers (symbol
)
6638 /* It's hopefully okay to write the code this way, since everything
6639 will soon be in caches, and no consing will be done at all. */
6642 parsed
= parse_modifiers (symbol
);
6643 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6648 /* For handling events, we often want to produce a symbol whose name
6649 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6650 to some base, like the name of a function key or mouse button.
6651 modify_event_symbol produces symbols of this sort.
6653 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6654 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6657 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6658 into symbol names, or a string specifying a name stem used to
6659 construct a symbol name or the form `STEM-N', where N is the decimal
6660 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6661 non-nil; otherwise NAME_TABLE is used.
6663 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6664 persist between calls to modify_event_symbol that it can use to
6665 store a cache of the symbols it's generated for this NAME_TABLE
6666 before. The object stored there may be a vector or an alist.
6668 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6670 MODIFIERS is a set of modifier bits (as given in struct input_events)
6671 whose prefixes should be applied to the symbol name.
6673 SYMBOL_KIND is the value to be placed in the event_kind property of
6674 the returned symbol.
6676 The symbols we create are supposed to have an
6677 `event-symbol-elements' property, which lists the modifiers present
6678 in the symbol's name. */
6681 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6682 name_table
, symbol_table
, table_size
)
6685 Lisp_Object symbol_kind
;
6686 Lisp_Object name_alist_or_stem
;
6688 Lisp_Object
*symbol_table
;
6689 unsigned int table_size
;
6692 Lisp_Object symbol_int
;
6694 /* Get rid of the "vendor-specific" bit here. */
6695 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6697 /* Is this a request for a valid symbol? */
6698 if (symbol_num
< 0 || symbol_num
>= table_size
)
6701 if (CONSP (*symbol_table
))
6702 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6704 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6705 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6706 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6707 we've never used that symbol before. */
6710 if (! VECTORP (*symbol_table
)
6711 || XVECTOR (*symbol_table
)->size
!= table_size
)
6715 XSETFASTINT (size
, table_size
);
6716 *symbol_table
= Fmake_vector (size
, Qnil
);
6719 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6722 /* Have we already used this symbol before? */
6725 /* No; let's create it. */
6726 if (CONSP (name_alist_or_stem
))
6727 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6728 else if (STRINGP (name_alist_or_stem
))
6730 int len
= SBYTES (name_alist_or_stem
);
6731 char *buf
= (char *) alloca (len
+ 50);
6732 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6733 (long) XINT (symbol_int
) + 1);
6734 value
= intern (buf
);
6736 else if (name_table
!= 0 && name_table
[symbol_num
])
6737 value
= intern (name_table
[symbol_num
]);
6739 #ifdef HAVE_WINDOW_SYSTEM
6742 char *name
= x_get_keysym_name (symbol_num
);
6744 value
= intern (name
);
6751 sprintf (buf
, "key-%d", symbol_num
);
6752 value
= intern (buf
);
6755 if (CONSP (*symbol_table
))
6756 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6758 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6760 /* Fill in the cache entries for this symbol; this also
6761 builds the Qevent_symbol_elements property, which the user
6763 apply_modifiers (modifiers
& click_modifier
, value
);
6764 Fput (value
, Qevent_kind
, symbol_kind
);
6767 /* Apply modifiers to that symbol. */
6768 return apply_modifiers (modifiers
, value
);
6771 /* Convert a list that represents an event type,
6772 such as (ctrl meta backspace), into the usual representation of that
6773 event type as a number or a symbol. */
6775 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6776 doc
: /* Convert the event description list EVENT-DESC to an event type.
6777 EVENT-DESC should contain one base event type (a character or symbol)
6778 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6779 drag, down, double or triple). The base must be last.
6780 The return value is an event type (a character or symbol) which
6781 has the same base event type and all the specified modifiers. */)
6783 Lisp_Object event_desc
;
6791 while (CONSP (rest
))
6799 /* Given a symbol, see if it is a modifier name. */
6800 if (SYMBOLP (elt
) && CONSP (rest
))
6801 this = parse_solitary_modifier (elt
);
6805 else if (!NILP (base
))
6806 error ("Two bases given in one event");
6812 /* Let the symbol A refer to the character A. */
6813 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6814 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6816 if (INTEGERP (base
))
6818 /* Turn (shift a) into A. */
6819 if ((modifiers
& shift_modifier
) != 0
6820 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6822 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6823 modifiers
&= ~shift_modifier
;
6826 /* Turn (control a) into C-a. */
6827 if (modifiers
& ctrl_modifier
)
6828 return make_number ((modifiers
& ~ctrl_modifier
)
6829 | make_ctrl_char (XINT (base
)));
6831 return make_number (modifiers
| XINT (base
));
6833 else if (SYMBOLP (base
))
6834 return apply_modifiers (modifiers
, base
);
6837 error ("Invalid base event");
6842 /* Try to recognize SYMBOL as a modifier name.
6843 Return the modifier flag bit, or 0 if not recognized. */
6846 parse_solitary_modifier (Lisp_Object symbol
)
6848 Lisp_Object name
= SYMBOL_NAME (symbol
);
6850 switch (SREF (name
, 0))
6852 #define SINGLE_LETTER_MOD(BIT) \
6853 if (SBYTES (name) == 1) \
6856 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6857 if (LEN == SBYTES (name) \
6858 && ! strncmp (SDATA (name), NAME, LEN)) \
6862 SINGLE_LETTER_MOD (alt_modifier
);
6866 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6870 SINGLE_LETTER_MOD (ctrl_modifier
);
6874 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6875 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6879 SINGLE_LETTER_MOD (hyper_modifier
);
6883 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6887 SINGLE_LETTER_MOD (meta_modifier
);
6891 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6895 SINGLE_LETTER_MOD (shift_modifier
);
6899 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6900 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6901 SINGLE_LETTER_MOD (super_modifier
);
6905 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6906 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6907 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6911 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6914 #undef SINGLE_LETTER_MOD
6915 #undef MULTI_LETTER_MOD
6921 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6922 Such a list is not valid as an event,
6923 but it can be a Lucid-style event type list. */
6926 lucid_event_type_list_p (object
)
6931 if (! CONSP (object
))
6934 if (EQ (XCAR (object
), Qhelp_echo
)
6935 || EQ (XCAR (object
), Qvertical_line
)
6936 || EQ (XCAR (object
), Qmode_line
)
6937 || EQ (XCAR (object
), Qheader_line
))
6940 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6944 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6951 /* Store into *addr a value nonzero if terminal input chars are available.
6952 Serves the purpose of ioctl (0, FIONREAD, addr)
6953 but works even if FIONREAD does not exist.
6954 (In fact, this may actually read some input.)
6956 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6957 timer events that are ripe.
6958 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6959 events (FOCUS_IN_EVENT).
6960 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6961 movements and toolkit scroll bar thumb drags. */
6964 get_input_pending (addr
, flags
)
6968 /* First of all, have we already counted some input? */
6969 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6971 /* If input is being read as it arrives, and we have none, there is none. */
6972 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6975 /* Try to read some input and see how much we get. */
6977 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6980 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6983 gobble_input (expected
)
6987 /* Read D-Bus messages. */
6988 xd_read_queued_messages ();
6989 #endif /* HAVE_DBUS */
6992 if (interrupt_input
)
6995 mask
= sigblock (sigmask (SIGIO
));
6996 read_avail_input (expected
);
7000 #ifdef POLL_FOR_INPUT
7001 /* XXX This condition was (read_socket_hook && !interrupt_input),
7002 but read_socket_hook is not global anymore. Let's pretend that
7004 if (!interrupt_input
&& poll_suppress_count
== 0)
7007 mask
= sigblock (sigmask (SIGALRM
));
7008 read_avail_input (expected
);
7014 read_avail_input (expected
);
7017 /* Put a BUFFER_SWITCH_EVENT in the buffer
7018 so that read_key_sequence will notice the new current buffer. */
7021 record_asynch_buffer_change ()
7023 struct input_event event
;
7027 event
.kind
= BUFFER_SWITCH_EVENT
;
7028 event
.frame_or_window
= Qnil
;
7032 /* We don't need a buffer-switch event unless Emacs is waiting for input.
7033 The purpose of the event is to make read_key_sequence look up the
7034 keymaps again. If we aren't in read_key_sequence, we don't need one,
7035 and the event could cause trouble by messing up (input-pending-p). */
7036 tem
= Fwaiting_for_user_input_p ();
7040 /* We never need these events if we have no asynchronous subprocesses. */
7044 /* Make sure no interrupt happens while storing the event. */
7046 if (interrupt_input
)
7049 mask
= sigblock (sigmask (SIGIO
));
7050 kbd_buffer_store_event (&event
);
7057 kbd_buffer_store_event (&event
);
7062 /* Read any terminal input already buffered up by the system
7063 into the kbd_buffer, but do not wait.
7065 EXPECTED should be nonzero if the caller knows there is some input.
7067 Returns the number of keyboard chars read, or -1 meaning
7068 this is a bad time to try to read input. */
7071 read_avail_input (expected
)
7078 /* Store pending user signal events, if any. */
7079 if (store_user_signal_events ())
7082 /* Loop through the available terminals, and call their input hooks. */
7086 struct terminal
*next
= t
->next_terminal
;
7088 if (t
->read_socket_hook
)
7091 struct input_event hold_quit
;
7093 EVENT_INIT (hold_quit
);
7094 hold_quit
.kind
= NO_EVENT
;
7096 /* No need for FIONREAD or fcntl; just say don't wait. */
7097 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
7103 if (nr
== -1) /* Not OK to read input now. */
7107 else if (nr
== -2) /* Non-transient error. */
7109 /* The terminal device terminated; it should be closed. */
7111 /* Kill Emacs if this was our last terminal. */
7112 if (!terminal_list
->next_terminal
)
7113 /* Formerly simply reported no input, but that
7114 sometimes led to a failure of Emacs to terminate.
7115 SIGHUP seems appropriate if we can't reach the
7117 /* ??? Is it really right to send the signal just to
7118 this process rather than to the whole process
7119 group? Perhaps on systems with FIONREAD Emacs is
7120 alone in its group. */
7121 kill (getpid (), SIGHUP
);
7123 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
7126 XSETTERMINAL (tmp
, t
);
7127 Fdelete_terminal (tmp
, Qnoelisp
);
7131 if (hold_quit
.kind
!= NO_EVENT
)
7132 kbd_buffer_store_event (&hold_quit
);
7141 frame_make_pointer_visible ();
7147 decode_keyboard_code (struct tty_display_info
*tty
,
7148 struct coding_system
*coding
,
7149 unsigned char *buf
, int nbytes
)
7151 unsigned char *src
= buf
;
7152 const unsigned char *p
;
7157 if (tty
->meta_key
!= 2)
7158 for (i
= 0; i
< nbytes
; i
++)
7160 if (coding
->carryover_bytes
> 0)
7162 src
= alloca (coding
->carryover_bytes
+ nbytes
);
7163 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
7164 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
7165 nbytes
+= coding
->carryover_bytes
;
7167 coding
->destination
= alloca (nbytes
* 4);
7168 coding
->dst_bytes
= nbytes
* 4;
7169 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
7170 if (coding
->produced_char
== 0)
7172 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
7174 struct input_event buf
;
7177 buf
.code
= STRING_CHAR_ADVANCE (p
);
7178 buf
.kind
= (ASCII_CHAR_P (buf
.code
)
7179 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
7180 /* See the comment in tty_read_avail_input. */
7181 buf
.frame_or_window
= tty
->top_frame
;
7183 kbd_buffer_store_event (&buf
);
7187 /* This is the tty way of reading available input.
7189 Note that each terminal device has its own `struct terminal' object,
7190 and so this function is called once for each individual termcap
7191 terminal. The first parameter indicates which terminal to read from. */
7194 tty_read_avail_input (struct terminal
*terminal
,
7196 struct input_event
*hold_quit
)
7198 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7199 the kbd_buffer can really hold. That may prevent loss
7200 of characters on some systems when input is stuffed at us. */
7201 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7203 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7206 if (!terminal
->name
) /* Don't read from a dead terminal. */
7209 if (terminal
->type
!= output_termcap
7210 && terminal
->type
!= output_msdos_raw
)
7213 /* XXX I think the following code should be moved to separate hook
7214 functions in system-dependent files. */
7217 #else /* not WINDOWSNT */
7218 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7222 return 0; /* The terminal is suspended. */
7225 n_to_read
= dos_keysns ();
7229 cbuf
[0] = dos_keyread ();
7232 #else /* not MSDOS */
7237 struct input_event hold_quit
;
7238 int gpm
, fd
= gpm_fd
;
7240 EVENT_INIT (hold_quit
);
7241 hold_quit
.kind
= NO_EVENT
;
7243 /* gpm==1 if event received.
7244 gpm==0 if the GPM daemon has closed the connection, in which case
7245 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7246 we save it in `fd' so close_gpm can remove it from the
7248 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7249 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7250 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7253 /* Presumably the GPM daemon has closed the connection. */
7255 if (hold_quit
.kind
!= NO_EVENT
)
7256 kbd_buffer_store_event (&hold_quit
);
7260 #endif /* HAVE_GPM */
7262 /* Determine how many characters we should *try* to read. */
7264 /* Find out how much input is available. */
7265 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7267 if (! noninteractive
)
7268 return -2; /* Close this terminal. */
7274 if (n_to_read
> sizeof cbuf
)
7275 n_to_read
= sizeof cbuf
;
7276 #else /* no FIONREAD */
7277 #if defined (USG) || defined(CYGWIN)
7278 /* Read some input if available, but don't wait. */
7279 n_to_read
= sizeof cbuf
;
7280 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7286 /* Now read; for one reason or another, this will not block.
7287 NREAD is set to the number of chars read. */
7290 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7291 /* POSIX infers that processes which are not in the session leader's
7292 process group won't get SIGHUP's at logout time. BSDI adheres to
7293 this part standard and returns -1 from read (0) with errno==EIO
7294 when the control tty is taken away.
7295 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7296 if (nread
== -1 && errno
== EIO
)
7297 return -2; /* Close this terminal. */
7298 #if defined (AIX) && defined (_BSD)
7299 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7300 This looks incorrect, but it isn't, because _BSD causes
7301 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7302 and that causes a value other than 0 when there is no input. */
7304 return -2; /* Close this terminal. */
7308 /* We used to retry the read if it was interrupted.
7309 But this does the wrong thing when O_NDELAY causes
7310 an EAGAIN error. Does anybody know of a situation
7311 where a retry is actually needed? */
7313 nread
< 0 && (errno
== EAGAIN
7327 #if defined (USG) || defined (CYGWIN)
7328 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7329 #endif /* USG or CYGWIN */
7330 #endif /* no FIONREAD */
7335 #endif /* not MSDOS */
7336 #endif /* not WINDOWSNT */
7338 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7339 & CODING_REQUIRE_DECODING_MASK
)
7341 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7344 /* Decode the key sequence except for those with meta
7346 for (i
= from
= 0; ; i
++)
7347 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7349 struct input_event buf
;
7351 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7356 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7357 buf
.modifiers
= meta_modifier
;
7358 buf
.code
= cbuf
[i
] & ~0x80;
7359 /* See the comment below. */
7360 buf
.frame_or_window
= tty
->top_frame
;
7362 kbd_buffer_store_event (&buf
);
7368 for (i
= 0; i
< nread
; i
++)
7370 struct input_event buf
;
7372 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7374 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7375 buf
.modifiers
= meta_modifier
;
7376 if (tty
->meta_key
!= 2)
7380 /* Set the frame corresponding to the active tty. Note that the
7381 value of selected_frame is not reliable here, redisplay tends
7382 to temporarily change it. */
7383 buf
.frame_or_window
= tty
->top_frame
;
7386 kbd_buffer_store_event (&buf
);
7387 /* Don't look at input that follows a C-g too closely.
7388 This reduces lossage due to autorepeat on C-g. */
7389 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7390 && buf
.code
== quit_char
)
7398 handle_async_input ()
7400 interrupt_input_pending
= 0;
7402 pending_signals
= pending_atimers
;
7404 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7405 doing anything dangerous. */
7412 nread
= read_avail_input (1);
7413 /* -1 means it's not ok to read the input now.
7414 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7415 0 means there was no keyboard input available. */
7425 process_pending_signals ()
7427 if (interrupt_input_pending
)
7428 handle_async_input ();
7429 do_pending_atimers ();
7432 #ifdef SIGIO /* for entire page */
7433 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7436 input_available_signal (signo
)
7439 /* Must preserve main program's value of errno. */
7440 int old_errno
= errno
;
7441 #if defined (USG) && !defined (POSIX_SIGNALS)
7442 /* USG systems forget handlers when they are used;
7443 must reestablish each time */
7444 signal (signo
, input_available_signal
);
7448 interrupt_input_pending
= 1;
7449 pending_signals
= 1;
7451 SIGNAL_THREAD_CHECK (signo
);
7454 if (input_available_clear_time
)
7455 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7458 handle_async_input ();
7465 /* Send ourselves a SIGIO.
7467 This function exists so that the UNBLOCK_INPUT macro in
7468 blockinput.h can have some way to take care of input we put off
7469 dealing with, without assuming that every file which uses
7470 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7472 reinvoke_input_signal ()
7475 handle_async_input ();
7481 /* User signal events. */
7483 struct user_signal_info
7485 /* Signal number. */
7488 /* Name of the signal. */
7491 /* Number of pending signals. */
7494 struct user_signal_info
*next
;
7497 /* List of user signals. */
7498 static struct user_signal_info
*user_signals
= NULL
;
7501 add_user_signal (sig
, name
)
7505 struct user_signal_info
*p
;
7507 for (p
= user_signals
; p
; p
= p
->next
)
7509 /* Already added. */
7512 p
= xmalloc (sizeof (struct user_signal_info
));
7514 p
->name
= xstrdup (name
);
7516 p
->next
= user_signals
;
7519 signal (sig
, handle_user_signal
);
7523 handle_user_signal (sig
)
7526 int old_errno
= errno
;
7527 struct user_signal_info
*p
;
7529 #if defined (USG) && !defined (POSIX_SIGNALS)
7530 /* USG systems forget handlers when they are used;
7531 must reestablish each time */
7532 signal (sig
, handle_user_signal
);
7535 SIGNAL_THREAD_CHECK (sig
);
7537 for (p
= user_signals
; p
; p
= p
->next
)
7542 if (interrupt_input
)
7543 kill (getpid (), SIGIO
);
7547 /* Tell wait_reading_process_output that it needs to wake
7548 up and look around. */
7549 if (input_available_clear_time
)
7550 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7559 find_user_signal_name (sig
)
7562 struct user_signal_info
*p
;
7564 for (p
= user_signals
; p
; p
= p
->next
)
7572 store_user_signal_events ()
7574 struct user_signal_info
*p
;
7575 struct input_event buf
;
7578 for (p
= user_signals
; p
; p
= p
->next
)
7579 if (p
->npending
> 0)
7585 bzero (&buf
, sizeof buf
);
7586 buf
.kind
= USER_SIGNAL_EVENT
;
7587 buf
.frame_or_window
= selected_frame
;
7589 nstored
+= p
->npending
;
7591 mask
= sigblock (sigmask (p
->sig
));
7595 kbd_buffer_store_event (&buf
);
7598 while (p
->npending
> 0);
7606 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7607 static Lisp_Object menu_bar_one_keymap_changed_items
;
7609 /* These variables hold the vector under construction within
7610 menu_bar_items and its subroutines, and the current index
7611 for storing into that vector. */
7612 static Lisp_Object menu_bar_items_vector
;
7613 static int menu_bar_items_index
;
7615 /* Return a vector of menu items for a menu bar, appropriate
7616 to the current buffer. Each item has three elements in the vector:
7619 OLD is an old vector we can optionally reuse, or nil. */
7622 menu_bar_items (old
)
7625 /* The number of keymaps we're scanning right now, and the number of
7626 keymaps we have allocated space for. */
7629 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7630 in the current keymaps, or nil where it is not a prefix. */
7633 Lisp_Object def
, tail
;
7642 /* In order to build the menus, we need to call the keymap
7643 accessors. They all call QUIT. But this function is called
7644 during redisplay, during which a quit is fatal. So inhibit
7645 quitting while building the menus.
7646 We do this instead of specbind because (1) errors will clear it anyway
7647 and (2) this avoids risk of specpdl overflow. */
7648 oquit
= Vinhibit_quit
;
7652 menu_bar_items_vector
= old
;
7654 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7655 menu_bar_items_index
= 0;
7657 /* Build our list of keymaps.
7658 If we recognize a function key and replace its escape sequence in
7659 keybuf with its symbol, or if the sequence starts with a mouse
7660 click and we need to switch buffers, we jump back here to rebuild
7661 the initial keymaps from the current buffer. */
7665 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7666 if (!NILP (Voverriding_local_map_menu_flag
))
7668 /* Yes, use them (if non-nil) as well as the global map. */
7669 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7671 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7672 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7673 if (!NILP (Voverriding_local_map
))
7674 maps
[nmaps
++] = Voverriding_local_map
;
7678 /* No, so use major and minor mode keymaps and keymap property.
7679 Note that menu-bar bindings in the local-map and keymap
7680 properties may not work reliable, as they are only
7681 recognized when the menu-bar (or mode-line) is updated,
7682 which does not normally happen after every command. */
7685 nminor
= current_minor_maps (NULL
, &tmaps
);
7686 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7688 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7689 maps
[nmaps
++] = tem
;
7690 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7692 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7694 maps
[nmaps
++] = current_global_map
;
7697 /* Look up in each map the dummy prefix key `menu-bar'. */
7701 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7702 if (!NILP (maps
[mapno
]))
7704 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7708 menu_bar_one_keymap_changed_items
= Qnil
;
7709 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7713 /* Move to the end those items that should be at the end. */
7715 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7718 int end
= menu_bar_items_index
;
7720 for (i
= 0; i
< end
; i
+= 4)
7721 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7723 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7724 /* Move the item at index I to the end,
7725 shifting all the others forward. */
7726 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7727 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7728 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7729 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7731 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7732 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7733 (end
- i
- 4) * sizeof (Lisp_Object
));
7734 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7735 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7736 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7737 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7742 /* Add nil, nil, nil, nil at the end. */
7743 i
= menu_bar_items_index
;
7744 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7745 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7746 /* Add this item. */
7747 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7748 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7749 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7750 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7751 menu_bar_items_index
= i
;
7753 Vinhibit_quit
= oquit
;
7754 return menu_bar_items_vector
;
7757 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7758 If there's already an item for KEY, add this DEF to it. */
7760 Lisp_Object item_properties
;
7763 menu_bar_item (key
, item
, dummy1
, dummy2
)
7764 Lisp_Object key
, item
, dummy1
;
7767 struct gcpro gcpro1
;
7771 if (EQ (item
, Qundefined
))
7773 /* If a map has an explicit `undefined' as definition,
7774 discard any previously made menu bar item. */
7776 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7777 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7779 if (menu_bar_items_index
> i
+ 4)
7780 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7781 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7782 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7783 menu_bar_items_index
-= 4;
7787 /* If this keymap has already contributed to this KEY,
7788 don't contribute to it a second time. */
7789 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7790 if (!NILP (tem
) || NILP (item
))
7793 menu_bar_one_keymap_changed_items
7794 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7796 /* We add to menu_bar_one_keymap_changed_items before doing the
7797 parse_menu_item, so that if it turns out it wasn't a menu item,
7798 it still correctly hides any further menu item. */
7800 i
= parse_menu_item (item
, 0, 1);
7805 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7807 /* Find any existing item for this KEY. */
7808 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7809 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7812 /* If we did not find this KEY, add it at the end. */
7813 if (i
== menu_bar_items_index
)
7815 /* If vector is too small, get a bigger one. */
7816 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7817 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7818 /* Add this item. */
7819 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7820 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7821 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7822 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7823 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7824 menu_bar_items_index
= i
;
7826 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7830 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7831 /* If the new and the old items are not both keymaps,
7832 the lookup will only find `item'. */
7833 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7834 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7838 /* This is used as the handler when calling menu_item_eval_property. */
7840 menu_item_eval_property_1 (arg
)
7843 /* If we got a quit from within the menu computation,
7844 quit all the way out of it. This takes care of C-] in the debugger. */
7845 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7846 Fsignal (Qquit
, Qnil
);
7851 /* Evaluate an expression and return the result (or nil if something
7852 went wrong). Used to evaluate dynamic parts of menu items. */
7854 menu_item_eval_property (sexpr
)
7857 int count
= SPECPDL_INDEX ();
7859 specbind (Qinhibit_redisplay
, Qt
);
7860 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7861 menu_item_eval_property_1
);
7862 return unbind_to (count
, val
);
7865 /* This function parses a menu item and leaves the result in the
7866 vector item_properties.
7867 ITEM is a key binding, a possible menu item.
7868 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7869 evaluate dynamic expressions in the menu item.
7870 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7872 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7873 parse_menu_item returns true if the item is a menu item and false
7877 parse_menu_item (item
, notreal
, inmenubar
)
7879 int notreal
, inmenubar
;
7881 Lisp_Object def
, tem
, item_string
, start
;
7883 Lisp_Object keyhint
;
7892 /* Create item_properties vector if necessary. */
7893 if (NILP (item_properties
))
7895 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7897 /* Initialize optional entries. */
7898 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7899 ASET (item_properties
, i
, Qnil
);
7900 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7902 /* Save the item here to protect it from GC. */
7903 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7905 item_string
= XCAR (item
);
7909 if (STRINGP (item_string
))
7911 /* Old format menu item. */
7912 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7914 /* Maybe help string. */
7915 if (CONSP (item
) && STRINGP (XCAR (item
)))
7917 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7922 /* Maybe an obsolete key binding cache. */
7923 if (CONSP (item
) && CONSP (XCAR (item
))
7924 && (NILP (XCAR (XCAR (item
)))
7925 || VECTORP (XCAR (XCAR (item
)))))
7928 /* This is the real definition--the function to run. */
7929 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7931 /* Get enable property, if any. */
7934 tem
= Fget (item
, Qmenu_enable
);
7935 if (!NILP (Venable_disabled_menus_and_buttons
))
7936 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7937 else if (!NILP (tem
))
7938 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7941 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7943 /* New format menu item. */
7944 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7945 start
= XCDR (item
);
7948 /* We have a real binding. */
7949 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7951 item
= XCDR (start
);
7952 /* Is there an obsolete cache list with key equivalences. */
7953 if (CONSP (item
) && CONSP (XCAR (item
)))
7956 /* Parse properties. */
7957 while (CONSP (item
) && CONSP (XCDR (item
)))
7962 if (EQ (tem
, QCenable
))
7964 if (!NILP (Venable_disabled_menus_and_buttons
))
7965 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7967 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7969 else if (EQ (tem
, QCvisible
) && !notreal
)
7971 /* If got a visible property and that evaluates to nil
7972 then ignore this item. */
7973 tem
= menu_item_eval_property (XCAR (item
));
7977 else if (EQ (tem
, QChelp
))
7978 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7979 else if (EQ (tem
, QCfilter
))
7981 else if (EQ (tem
, QCkey_sequence
))
7984 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7985 /* Be GC protected. Set keyhint to item instead of tem. */
7988 else if (EQ (tem
, QCkeys
))
7991 if (CONSP (tem
) || STRINGP (tem
))
7992 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7994 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7999 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8001 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8003 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
8009 else if (inmenubar
|| !NILP (start
))
8013 return 0; /* not a menu item */
8015 /* If item string is not a string, evaluate it to get string.
8016 If we don't get a string, skip this item. */
8017 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
8018 if (!(STRINGP (item_string
) || notreal
))
8020 item_string
= menu_item_eval_property (item_string
);
8021 if (!STRINGP (item_string
))
8023 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
8026 /* If got a filter apply it on definition. */
8027 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8030 def
= menu_item_eval_property (list2 (XCAR (filter
),
8031 list2 (Qquote
, def
)));
8033 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
8036 /* Enable or disable selection of item. */
8037 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
8043 tem
= menu_item_eval_property (tem
);
8044 if (inmenubar
&& NILP (tem
))
8045 return 0; /* Ignore disabled items in menu bar. */
8046 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
8049 /* If we got no definition, this item is just unselectable text which
8050 is OK in a submenu but not in the menubar. */
8052 return (inmenubar
? 0 : 1);
8054 /* See if this is a separate pane or a submenu. */
8055 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8056 tem
= get_keymap (def
, 0, 1);
8057 /* For a subkeymap, just record its details and exit. */
8060 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
8061 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
8065 /* At the top level in the menu bar, do likewise for commands also.
8066 The menu bar does not display equivalent key bindings anyway.
8067 ITEM_PROPERTY_DEF is already set up properly. */
8071 /* If we only want to precompute equivalent key bindings (which we
8072 don't even do any more anyway), stop here. */
8076 { /* This is a command. See if there is an equivalent key binding. */
8077 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
8079 /* The previous code preferred :key-sequence to :keys, so we
8080 preserve this behavior. */
8081 if (STRINGP (keyeq
) && !CONSP (keyhint
))
8082 keyeq
= Fsubstitute_command_keys (keyeq
);
8085 Lisp_Object prefix
= keyeq
;
8086 Lisp_Object keys
= Qnil
;
8090 def
= XCAR (prefix
);
8091 prefix
= XCDR (prefix
);
8094 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8096 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
8098 keys
= XCAR (keyhint
);
8099 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
8101 /* We have a suggested key. Is it bound to the command? */
8104 /* If the command is an alias for another
8105 (such as lmenu.el set it up), check if the
8106 original command matches the cached command. */
8107 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
8112 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
8116 tem
= Fkey_description (keys
, Qnil
);
8119 if (STRINGP (XCAR (prefix
)))
8120 tem
= concat2 (XCAR (prefix
), tem
);
8121 if (STRINGP (XCDR (prefix
)))
8122 tem
= concat2 (tem
, XCDR (prefix
));
8124 keyeq
= concat2 (build_string (" "), tem
);
8125 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
8131 /* If we have an equivalent key binding, use that. */
8132 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
8135 /* Include this when menu help is implemented.
8136 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
8137 if (!(NILP (tem) || STRINGP (tem)))
8139 tem = menu_item_eval_property (tem);
8142 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8146 /* Handle radio buttons or toggle boxes. */
8147 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8149 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8150 menu_item_eval_property (tem
));
8157 /***********************************************************************
8159 ***********************************************************************/
8161 /* A vector holding tool bar items while they are parsed in function
8162 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8165 static Lisp_Object tool_bar_items_vector
;
8167 /* A vector holding the result of parse_tool_bar_item. Layout is like
8168 the one for a single item in tool_bar_items_vector. */
8170 static Lisp_Object tool_bar_item_properties
;
8172 /* Next free index in tool_bar_items_vector. */
8174 static int ntool_bar_items
;
8176 /* The symbols `tool-bar', `:image' and `:rtl'. */
8178 extern Lisp_Object Qtool_bar
;
8179 Lisp_Object QCimage
;
8182 /* Function prototypes. */
8184 static void init_tool_bar_items
P_ ((Lisp_Object
));
8185 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
8186 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
8187 static void append_tool_bar_item
P_ ((void));
8190 /* Return a vector of tool bar items for keymaps currently in effect.
8191 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8192 tool bar items found. */
8195 tool_bar_items (reuse
, nitems
)
8206 /* In order to build the menus, we need to call the keymap
8207 accessors. They all call QUIT. But this function is called
8208 during redisplay, during which a quit is fatal. So inhibit
8209 quitting while building the menus. We do this instead of
8210 specbind because (1) errors will clear it anyway and (2) this
8211 avoids risk of specpdl overflow. */
8212 oquit
= Vinhibit_quit
;
8215 /* Initialize tool_bar_items_vector and protect it from GC. */
8216 init_tool_bar_items (reuse
);
8218 /* Build list of keymaps in maps. Set nmaps to the number of maps
8221 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8222 if (!NILP (Voverriding_local_map_menu_flag
))
8224 /* Yes, use them (if non-nil) as well as the global map. */
8225 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8227 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8228 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8229 if (!NILP (Voverriding_local_map
))
8230 maps
[nmaps
++] = Voverriding_local_map
;
8234 /* No, so use major and minor mode keymaps and keymap property.
8235 Note that tool-bar bindings in the local-map and keymap
8236 properties may not work reliable, as they are only
8237 recognized when the tool-bar (or mode-line) is updated,
8238 which does not normally happen after every command. */
8241 nminor
= current_minor_maps (NULL
, &tmaps
);
8242 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8244 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8245 maps
[nmaps
++] = tem
;
8246 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
8248 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8251 /* Add global keymap at the end. */
8252 maps
[nmaps
++] = current_global_map
;
8254 /* Process maps in reverse order and look up in each map the prefix
8256 for (i
= nmaps
- 1; i
>= 0; --i
)
8257 if (!NILP (maps
[i
]))
8261 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8263 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8266 Vinhibit_quit
= oquit
;
8267 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8268 return tool_bar_items_vector
;
8272 /* Process the definition of KEY which is DEF. */
8275 process_tool_bar_item (key
, def
, data
, args
)
8276 Lisp_Object key
, def
, data
;
8280 extern Lisp_Object Qundefined
;
8281 struct gcpro gcpro1
, gcpro2
;
8283 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8287 if (EQ (def
, Qundefined
))
8289 /* If a map has an explicit `undefined' as definition,
8290 discard any previously made item. */
8291 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8293 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8295 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8297 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8298 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
8299 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8300 * sizeof (Lisp_Object
)));
8301 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8306 else if (parse_tool_bar_item (key
, def
))
8307 /* Append a new tool bar item to tool_bar_items_vector. Accept
8308 more than one definition for the same key. */
8309 append_tool_bar_item ();
8315 /* Parse a tool bar item specification ITEM for key KEY and return the
8316 result in tool_bar_item_properties. Value is zero if ITEM is
8319 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8321 CAPTION is the caption of the item, If it's not a string, it is
8322 evaluated to get a string.
8324 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8325 as binding are currently ignored.
8327 The following properties are recognized:
8331 FORM is evaluated and specifies whether the tool bar item is
8332 enabled or disabled.
8336 FORM is evaluated and specifies whether the tool bar item is visible.
8338 - `:filter FUNCTION'
8340 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8341 result is stored as the new binding.
8343 - `:button (TYPE SELECTED)'
8345 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8346 and specifies whether the button is selected (pressed) or not.
8350 IMAGES is either a single image specification or a vector of four
8351 image specifications. See enum tool_bar_item_images.
8353 - `:help HELP-STRING'.
8355 Gives a help string to display for the tool bar item. */
8358 parse_tool_bar_item (key
, item
)
8359 Lisp_Object key
, item
;
8361 /* Access slot with index IDX of vector tool_bar_item_properties. */
8362 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8364 Lisp_Object filter
= Qnil
;
8365 Lisp_Object caption
;
8368 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8369 Rule out items that aren't lists, don't start with
8370 `menu-item' or whose rest following `tool-bar-item' is not a
8373 || !EQ (XCAR (item
), Qmenu_item
)
8374 || (item
= XCDR (item
),
8378 /* Create tool_bar_item_properties vector if necessary. Reset it to
8380 if (VECTORP (tool_bar_item_properties
))
8382 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8386 tool_bar_item_properties
8387 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8390 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8391 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8393 /* Get the caption of the item. If the caption is not a string,
8394 evaluate it to get a string. If we don't get a string, skip this
8396 caption
= XCAR (item
);
8397 if (!STRINGP (caption
))
8399 caption
= menu_item_eval_property (caption
);
8400 if (!STRINGP (caption
))
8403 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8405 /* Give up if rest following the caption is not a list. */
8410 /* Store the binding. */
8411 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8414 /* Ignore cached key binding, if any. */
8415 if (CONSP (item
) && CONSP (XCAR (item
)))
8418 /* Process the rest of the properties. */
8419 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8421 Lisp_Object key
, value
;
8424 value
= XCAR (XCDR (item
));
8426 if (EQ (key
, QCenable
))
8428 /* `:enable FORM'. */
8429 if (!NILP (Venable_disabled_menus_and_buttons
))
8430 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8432 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8434 else if (EQ (key
, QCvisible
))
8436 /* `:visible FORM'. If got a visible property and that
8437 evaluates to nil then ignore this item. */
8438 if (NILP (menu_item_eval_property (value
)))
8441 else if (EQ (key
, QChelp
))
8442 /* `:help HELP-STRING'. */
8443 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8444 else if (EQ (key
, QCfilter
))
8445 /* ':filter FORM'. */
8447 else if (EQ (key
, QCbutton
) && CONSP (value
))
8449 /* `:button (TYPE . SELECTED)'. */
8450 Lisp_Object type
, selected
;
8452 type
= XCAR (value
);
8453 selected
= XCDR (value
);
8454 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8456 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8457 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8460 else if (EQ (key
, QCimage
)
8462 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8463 /* Value is either a single image specification or a vector
8464 of 4 such specifications for the different button states. */
8465 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8466 else if (EQ (key
, Qrtl
))
8468 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8471 /* If got a filter apply it on binding. */
8473 PROP (TOOL_BAR_ITEM_BINDING
)
8474 = menu_item_eval_property (list2 (filter
,
8476 PROP (TOOL_BAR_ITEM_BINDING
))));
8478 /* See if the binding is a keymap. Give up if it is. */
8479 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8482 /* Enable or disable selection of item. */
8483 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8484 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8485 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8487 /* Handle radio buttons or toggle boxes. */
8488 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8489 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8490 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8498 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8499 that can be reused. */
8502 init_tool_bar_items (reuse
)
8505 if (VECTORP (reuse
))
8506 tool_bar_items_vector
= reuse
;
8508 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8509 ntool_bar_items
= 0;
8513 /* Append parsed tool bar item properties from
8514 tool_bar_item_properties */
8517 append_tool_bar_item ()
8519 Lisp_Object
*to
, *from
;
8521 /* Enlarge tool_bar_items_vector if necessary. */
8522 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8523 >= XVECTOR (tool_bar_items_vector
)->size
)
8524 tool_bar_items_vector
8525 = larger_vector (tool_bar_items_vector
,
8526 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8528 /* Append entries from tool_bar_item_properties to the end of
8529 tool_bar_items_vector. */
8530 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8531 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8532 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8533 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8540 /* Read a character using menus based on maps in the array MAPS.
8541 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8542 Return t if we displayed a menu but the user rejected it.
8544 PREV_EVENT is the previous input event, or nil if we are reading
8545 the first event of a key sequence.
8547 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8548 if we used a mouse menu to read the input, or zero otherwise. If
8549 USED_MOUSE_MENU is null, we don't dereference it.
8551 The prompting is done based on the prompt-string of the map
8552 and the strings associated with various map elements.
8554 This can be done with X menus or with menus put in the minibuf.
8555 These are done in different ways, depending on how the input will be read.
8556 Menus using X are done after auto-saving in read-char, getting the input
8557 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8558 and do auto-saving in the inner call of read_char. */
8561 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8564 Lisp_Object prev_event
;
8565 int *used_mouse_menu
;
8569 if (used_mouse_menu
)
8570 *used_mouse_menu
= 0;
8572 /* Use local over global Menu maps */
8574 if (! menu_prompting
)
8577 /* Optionally disregard all but the global map. */
8578 if (inhibit_local_menu_bar_menus
)
8580 maps
+= (nmaps
- 1);
8585 /* If we got to this point via a mouse click,
8586 use a real menu for mouse selection. */
8587 if (EVENT_HAS_PARAMETERS (prev_event
)
8588 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8589 && !EQ (XCAR (prev_event
), Qtool_bar
))
8591 /* Display the menu and get the selection. */
8592 Lisp_Object
*realmaps
8593 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8597 /* Use the maps that are not nil. */
8598 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8599 if (!NILP (maps
[mapno
]))
8600 realmaps
[nmaps1
++] = maps
[mapno
];
8602 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8607 record_menu_key (XCAR (value
));
8609 /* If we got multiple events, unread all but
8611 There is no way to prevent those unread events
8612 from showing up later in last_nonmenu_event.
8613 So turn symbol and integer events into lists,
8614 to indicate that they came from a mouse menu,
8615 so that when present in last_nonmenu_event
8616 they won't confuse things. */
8617 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8619 record_menu_key (XCAR (tem
));
8620 if (SYMBOLP (XCAR (tem
))
8621 || INTEGERP (XCAR (tem
)))
8622 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8625 /* If we got more than one event, put all but the first
8626 onto this list to be read later.
8627 Return just the first event now. */
8628 Vunread_command_events
8629 = nconc2 (XCDR (value
), Vunread_command_events
);
8630 value
= XCAR (value
);
8632 else if (NILP (value
))
8634 if (used_mouse_menu
)
8635 *used_mouse_menu
= 1;
8638 #endif /* HAVE_MENUS */
8642 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8643 We make this bigger when necessary, and never free it. */
8644 static char *read_char_minibuf_menu_text
;
8645 /* Size of that buffer. */
8646 static int read_char_minibuf_menu_width
;
8649 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8655 register Lisp_Object name
;
8657 /* FIXME: Use the minibuffer's frame width. */
8658 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8661 Lisp_Object rest
, vector
;
8667 if (! menu_prompting
)
8670 /* Get the menu name from the first map that has one (a prompt string). */
8671 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8673 name
= Fkeymap_prompt (maps
[mapno
]);
8678 /* If we don't have any menus, just read a character normally. */
8679 if (!STRINGP (name
))
8682 /* Make sure we have a big enough buffer for the menu text. */
8683 width
= max (width
, SBYTES (name
));
8684 if (read_char_minibuf_menu_text
== 0)
8686 read_char_minibuf_menu_width
= width
+ 4;
8687 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8689 else if (width
+ 4 > read_char_minibuf_menu_width
)
8691 read_char_minibuf_menu_width
= width
+ 4;
8692 read_char_minibuf_menu_text
8693 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8695 menu
= read_char_minibuf_menu_text
;
8697 /* Prompt string always starts with map's prompt, and a space. */
8698 strcpy (menu
, SDATA (name
));
8699 nlength
= SBYTES (name
);
8700 menu
[nlength
++] = ':';
8701 menu
[nlength
++] = ' ';
8704 /* Start prompting at start of first map. */
8708 /* Present the documented bindings, a line at a time. */
8715 Lisp_Object orig_defn_macro
;
8717 /* Loop over elements of map. */
8722 /* If reached end of map, start at beginning of next map. */
8726 /* At end of last map, wrap around to first map if just starting,
8727 or end this line if already have something on it. */
8731 if (notfirst
|| nobindings
) break;
8736 /* Look at the next element of the map. */
8738 elt
= XVECTOR (vector
)->contents
[idx
];
8740 elt
= Fcar_safe (rest
);
8742 if (idx
< 0 && VECTORP (elt
))
8744 /* If we found a dense table in the keymap,
8745 advanced past it, but start scanning its contents. */
8746 rest
= Fcdr_safe (rest
);
8752 /* An ordinary element. */
8753 Lisp_Object event
, tem
;
8757 event
= Fcar_safe (elt
); /* alist */
8758 elt
= Fcdr_safe (elt
);
8762 XSETINT (event
, idx
); /* vector */
8765 /* Ignore the element if it has no prompt string. */
8766 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8768 /* 1 if the char to type matches the string. */
8770 Lisp_Object upcased_event
, downcased_event
;
8771 Lisp_Object desc
= Qnil
;
8773 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8775 upcased_event
= Fupcase (event
);
8776 downcased_event
= Fdowncase (event
);
8777 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8778 || XINT (downcased_event
) == SREF (s
, 0));
8780 desc
= Fsingle_key_description (event
, Qnil
);
8782 #if 0 /* It is redundant to list the equivalent key bindings because
8783 the prefix is what the user has already typed. */
8785 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8787 /* Insert equivalent keybinding. */
8788 s
= concat2 (s
, tem
);
8791 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8792 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8794 /* Insert button prefix. */
8795 Lisp_Object selected
8796 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8797 if (EQ (tem
, QCradio
))
8798 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8800 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8801 s
= concat2 (tem
, s
);
8805 /* If we have room for the prompt string, add it to this line.
8806 If this is the first on the line, always add it. */
8807 if ((SCHARS (s
) + i
+ 2
8808 + (char_matches
? 0 : SCHARS (desc
) + 3))
8814 /* Punctuate between strings. */
8817 strcpy (menu
+ i
, ", ");
8823 /* If the char to type doesn't match the string's
8824 first char, explicitly show what char to type. */
8827 /* Add as much of string as fits. */
8828 thiswidth
= SCHARS (desc
);
8829 if (thiswidth
+ i
> width
)
8830 thiswidth
= width
- i
;
8831 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8833 strcpy (menu
+ i
, " = ");
8837 /* Add as much of string as fits. */
8838 thiswidth
= SCHARS (s
);
8839 if (thiswidth
+ i
> width
)
8840 thiswidth
= width
- i
;
8841 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8847 /* If this element does not fit, end the line now,
8848 and save the element for the next line. */
8849 strcpy (menu
+ i
, "...");
8854 /* Move past this element. */
8855 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8856 /* Handle reaching end of dense table. */
8861 rest
= Fcdr_safe (rest
);
8865 /* Prompt with that and read response. */
8866 message2_nolog (menu
, strlen (menu
),
8867 ! NILP (current_buffer
->enable_multibyte_characters
));
8869 /* Make believe its not a keyboard macro in case the help char
8870 is pressed. Help characters are not recorded because menu prompting
8871 is not used on replay.
8873 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8874 current_kboard
->defining_kbd_macro
= Qnil
;
8876 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8877 while (BUFFERP (obj
));
8878 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8880 if (!INTEGERP (obj
))
8882 else if (XINT (obj
) == -2)
8887 if (! EQ (obj
, menu_prompt_more_char
)
8888 && (!INTEGERP (menu_prompt_more_char
)
8889 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8891 if (!NILP (current_kboard
->defining_kbd_macro
))
8892 store_kbd_macro_char (obj
);
8895 /* Help char - go round again */
8899 /* Reading key sequences. */
8901 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8902 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8903 keymap, or nil otherwise. Return the index of the first keymap in
8904 which KEY has any binding, or NMAPS if no map has a binding.
8906 If KEY is a meta ASCII character, treat it like meta-prefix-char
8907 followed by the corresponding non-meta character. Keymaps in
8908 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8911 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8914 NEXT may be the same array as CURRENT. */
8917 follow_key (key
, nmaps
, current
, defs
, next
)
8919 Lisp_Object
*current
, *defs
, *next
;
8922 int i
, first_binding
;
8924 first_binding
= nmaps
;
8925 for (i
= nmaps
- 1; i
>= 0; i
--)
8927 if (! NILP (current
[i
]))
8929 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8930 if (! NILP (defs
[i
]))
8937 /* Given the set of bindings we've found, produce the next set of maps. */
8938 if (first_binding
< nmaps
)
8939 for (i
= 0; i
< nmaps
; i
++)
8940 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8942 return first_binding
;
8945 /* Structure used to keep track of partial application of key remapping
8946 such as Vfunction_key_map and Vkey_translation_map. */
8947 typedef struct keyremap
8949 /* This is the map originally specified for this use. */
8951 /* This is a submap reached by looking up, in PARENT,
8952 the events from START to END. */
8954 /* Positions [START, END) in the key sequence buffer
8955 are the key that we have scanned so far.
8956 Those events are the ones that we will replace
8957 if PAREHT maps them into a key sequence. */
8961 /* Lookup KEY in MAP.
8962 MAP is a keymap mapping keys to key vectors or functions.
8963 If the mapping is a function and DO_FUNCTION is non-zero, then
8964 the function is called with PROMPT as parameter and its return
8965 value is used as the return value of this function (after checking
8966 that it is indeed a vector). */
8969 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8970 Lisp_Object map
, key
, prompt
;
8975 next
= access_keymap (map
, key
, 1, 0, 1);
8977 /* Handle symbol with autoload definition. */
8978 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8979 && CONSP (XSYMBOL (next
)->function
)
8980 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8981 do_autoload (XSYMBOL (next
)->function
, next
);
8983 /* Handle a symbol whose function definition is a keymap
8985 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8986 && (ARRAYP (XSYMBOL (next
)->function
)
8987 || KEYMAPP (XSYMBOL (next
)->function
)))
8988 next
= XSYMBOL (next
)->function
;
8990 /* If the keymap gives a function, not an
8991 array, then call the function with one arg and use
8992 its value instead. */
8993 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8998 next
= call1 (next
, prompt
);
8999 /* If the function returned something invalid,
9000 barf--don't ignore it.
9001 (To ignore it safely, we would need to gcpro a bunch of
9002 other variables.) */
9003 if (! (VECTORP (next
) || STRINGP (next
)))
9004 error ("Function %s returns invalid key sequence", tem
);
9009 /* Do one step of the key remapping used for function-key-map and
9010 key-translation-map:
9011 KEYBUF is the buffer holding the input events.
9012 BUFSIZE is its maximum size.
9013 FKEY is a pointer to the keyremap structure to use.
9014 INPUT is the index of the last element in KEYBUF.
9015 DOIT if non-zero says that the remapping can actually take place.
9016 DIFF is used to return the number of keys added/removed by the remapping.
9017 PARENT is the root of the keymap.
9018 PROMPT is the prompt to use if the remapping happens through a function.
9019 The return value is non-zero if the remapping actually took place. */
9022 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
9023 Lisp_Object
*keybuf
, prompt
;
9025 int input
, doit
, *diff
, bufsize
;
9027 Lisp_Object next
, key
;
9029 key
= keybuf
[fkey
->end
++];
9031 if (KEYMAPP (fkey
->parent
))
9032 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
9036 /* If keybuf[fkey->start..fkey->end] is bound in the
9037 map and we're in a position to do the key remapping, replace it with
9038 the binding and restart with fkey->start at the end. */
9039 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
9041 int len
= XFASTINT (Flength (next
));
9044 *diff
= len
- (fkey
->end
- fkey
->start
);
9046 if (input
+ *diff
>= bufsize
)
9047 error ("Key sequence too long");
9049 /* Shift the keys that follow fkey->end. */
9051 for (i
= fkey
->end
; i
< input
; i
++)
9052 keybuf
[i
+ *diff
] = keybuf
[i
];
9054 for (i
= input
- 1; i
>= fkey
->end
; i
--)
9055 keybuf
[i
+ *diff
] = keybuf
[i
];
9056 /* Overwrite the old keys with the new ones. */
9057 for (i
= 0; i
< len
; i
++)
9058 keybuf
[fkey
->start
+ i
]
9059 = Faref (next
, make_number (i
));
9061 fkey
->start
= fkey
->end
+= *diff
;
9062 fkey
->map
= fkey
->parent
;
9067 fkey
->map
= get_keymap (next
, 0, 1);
9069 /* If we no longer have a bound suffix, try a new position for
9071 if (!CONSP (fkey
->map
))
9073 fkey
->end
= ++fkey
->start
;
9074 fkey
->map
= fkey
->parent
;
9079 /* Read a sequence of keys that ends with a non prefix character,
9080 storing it in KEYBUF, a buffer of size BUFSIZE.
9082 Return the length of the key sequence stored.
9083 Return -1 if the user rejected a command menu.
9085 Echo starting immediately unless `prompt' is 0.
9087 Where a key sequence ends depends on the currently active keymaps.
9088 These include any minor mode keymaps active in the current buffer,
9089 the current buffer's local map, and the global map.
9091 If a key sequence has no other bindings, we check Vfunction_key_map
9092 to see if some trailing subsequence might be the beginning of a
9093 function key's sequence. If so, we try to read the whole function
9094 key, and substitute its symbolic name into the key sequence.
9096 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9097 `double-' events into similar click events, if that would make them
9098 bound. We try to turn `triple-' events first into `double-' events,
9101 If we get a mouse click in a mode line, vertical divider, or other
9102 non-text area, we treat the click as if it were prefixed by the
9103 symbol denoting that area - `mode-line', `vertical-line', or
9106 If the sequence starts with a mouse click, we read the key sequence
9107 with respect to the buffer clicked on, not the current buffer.
9109 If the user switches frames in the midst of a key sequence, we put
9110 off the switch-frame event until later; the next call to
9111 read_char will return it.
9113 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9114 from the selected window's buffer. */
9117 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
9118 can_return_switch_frame
, fix_current_buffer
)
9119 Lisp_Object
*keybuf
;
9122 int dont_downcase_last
;
9123 int can_return_switch_frame
;
9124 int fix_current_buffer
;
9126 volatile Lisp_Object from_string
;
9127 volatile int count
= SPECPDL_INDEX ();
9129 /* How many keys there are in the current key sequence. */
9132 /* The length of the echo buffer when we started reading, and
9133 the length of this_command_keys when we started reading. */
9134 volatile int echo_start
;
9135 volatile int keys_start
;
9137 /* The number of keymaps we're scanning right now, and the number of
9138 keymaps we have allocated space for. */
9140 volatile int nmaps_allocated
= 0;
9142 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9143 the current keymaps. */
9144 Lisp_Object
*volatile defs
= NULL
;
9146 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9147 in the current keymaps, or nil where it is not a prefix. */
9148 Lisp_Object
*volatile submaps
= NULL
;
9150 /* The local map to start out with at start of key sequence. */
9151 volatile Lisp_Object orig_local_map
;
9153 /* The map from the `keymap' property to start out with at start of
9155 volatile Lisp_Object orig_keymap
;
9157 /* 1 if we have already considered switching to the local-map property
9158 of the place where a mouse click occurred. */
9159 volatile int localized_local_map
= 0;
9161 /* The index in submaps[] of the first keymap that has a binding for
9162 this key sequence. In other words, the lowest i such that
9163 submaps[i] is non-nil. */
9164 volatile int first_binding
;
9165 /* Index of the first key that has no binding.
9166 It is useless to try fkey.start larger than that. */
9167 volatile int first_unbound
;
9169 /* If t < mock_input, then KEYBUF[t] should be read as the next
9172 We use this to recover after recognizing a function key. Once we
9173 realize that a suffix of the current key sequence is actually a
9174 function key's escape sequence, we replace the suffix with the
9175 function key's binding from Vfunction_key_map. Now keybuf
9176 contains a new and different key sequence, so the echo area,
9177 this_command_keys, and the submaps and defs arrays are wrong. In
9178 this situation, we set mock_input to t, set t to 0, and jump to
9179 restart_sequence; the loop will read keys from keybuf up until
9180 mock_input, thus rebuilding the state; and then it will resume
9181 reading characters from the keyboard. */
9182 volatile int mock_input
= 0;
9184 /* If the sequence is unbound in submaps[], then
9185 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9186 and fkey.map is its binding.
9188 These might be > t, indicating that all function key scanning
9189 should hold off until t reaches them. We do this when we've just
9190 recognized a function key, to avoid searching for the function
9191 key's again in Vfunction_key_map. */
9192 volatile keyremap fkey
;
9194 /* Likewise, for key_translation_map and input-decode-map. */
9195 volatile keyremap keytran
, indec
;
9197 /* Non-zero if we are trying to map a key by changing an upper-case
9198 letter to lower case, or a shifted function key to an unshifted
9200 volatile int shift_translated
= 0;
9202 /* If we receive a `switch-frame' or `select-window' event in the middle of
9203 a key sequence, we put it off for later.
9204 While we're reading, we keep the event here. */
9205 volatile Lisp_Object delayed_switch_frame
;
9207 /* See the comment below... */
9208 #if defined (GOBBLE_FIRST_EVENT)
9209 Lisp_Object first_event
;
9212 volatile Lisp_Object original_uppercase
;
9213 volatile int original_uppercase_position
= -1;
9215 /* Gets around Microsoft compiler limitations. */
9218 struct buffer
*starting_buffer
;
9220 /* List of events for which a fake prefix key has been generated. */
9221 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
9223 #if defined (GOBBLE_FIRST_EVENT)
9227 struct gcpro gcpro1
;
9229 GCPRO1 (fake_prefixed_keys
);
9230 raw_keybuf_count
= 0;
9232 last_nonmenu_event
= Qnil
;
9234 delayed_switch_frame
= Qnil
;
9239 echo_prompt (prompt
);
9240 else if (cursor_in_echo_area
9241 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9242 && NILP (Fzerop (Vecho_keystrokes
)))
9243 /* This doesn't put in a dash if the echo buffer is empty, so
9244 you don't always see a dash hanging out in the minibuffer. */
9248 /* Record the initial state of the echo area and this_command_keys;
9249 we will need to restore them if we replay a key sequence. */
9251 echo_start
= echo_length ();
9252 keys_start
= this_command_key_count
;
9253 this_single_command_key_start
= keys_start
;
9255 #if defined (GOBBLE_FIRST_EVENT)
9256 /* This doesn't quite work, because some of the things that read_char
9257 does cannot safely be bypassed. It seems too risky to try to make
9260 /* Read the first char of the sequence specially, before setting
9261 up any keymaps, in case a filter runs and switches buffers on us. */
9262 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9264 #endif /* GOBBLE_FIRST_EVENT */
9266 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9267 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9270 /* We jump here when we need to reinitialize fkey and keytran; this
9271 happens if we switch keyboards between rescans. */
9272 replay_entire_sequence
:
9274 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9275 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9276 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9277 indec
.start
= indec
.end
= 0;
9278 fkey
.start
= fkey
.end
= 0;
9279 keytran
.start
= keytran
.end
= 0;
9281 /* We jump here when the key sequence has been thoroughly changed, and
9282 we need to rescan it starting from the beginning. When we jump here,
9283 keybuf[0..mock_input] holds the sequence we should reread. */
9286 starting_buffer
= current_buffer
;
9287 first_unbound
= bufsize
+ 1;
9289 /* Build our list of keymaps.
9290 If we recognize a function key and replace its escape sequence in
9291 keybuf with its symbol, or if the sequence starts with a mouse
9292 click and we need to switch buffers, we jump back here to rebuild
9293 the initial keymaps from the current buffer. */
9296 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9298 if (2 > nmaps_allocated
)
9300 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9301 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9302 nmaps_allocated
= 2;
9304 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9306 else if (!NILP (Voverriding_local_map
))
9308 if (2 > nmaps_allocated
)
9310 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9311 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9312 nmaps_allocated
= 2;
9314 submaps
[nmaps
++] = Voverriding_local_map
;
9322 nminor
= current_minor_maps (0, &maps
);
9323 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9325 if (total
> nmaps_allocated
)
9327 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9328 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9329 nmaps_allocated
= total
;
9332 if (!NILP (orig_keymap
))
9333 submaps
[nmaps
++] = orig_keymap
;
9335 bcopy (maps
, (void *) (submaps
+ nmaps
),
9336 nminor
* sizeof (submaps
[0]));
9340 submaps
[nmaps
++] = orig_local_map
;
9342 submaps
[nmaps
++] = current_global_map
;
9344 /* Find an accurate initial value for first_binding. */
9345 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9346 if (! NILP (submaps
[first_binding
]))
9349 /* Start from the beginning in keybuf. */
9352 /* These are no-ops the first time through, but if we restart, they
9353 revert the echo area and this_command_keys to their original state. */
9354 this_command_key_count
= keys_start
;
9355 if (INTERACTIVE
&& t
< mock_input
)
9356 echo_truncate (echo_start
);
9358 /* If the best binding for the current key sequence is a keymap, or
9359 we may be looking at a function key's escape sequence, keep on
9361 while (first_binding
< nmaps
9362 /* Keep reading as long as there's a prefix binding. */
9363 ? !NILP (submaps
[first_binding
])
9364 /* Don't return in the middle of a possible function key sequence,
9365 if the only bindings we found were via case conversion.
9366 Thus, if ESC O a has a function-key-map translation
9367 and ESC o has a binding, don't return after ESC O,
9368 so that we can translate ESC O plus the next character. */
9369 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9372 int used_mouse_menu
= 0;
9374 /* Where the last real key started. If we need to throw away a
9375 key that has expanded into more than one element of keybuf
9376 (say, a mouse click on the mode line which is being treated
9377 as [mode-line (mouse-...)], then we backtrack to this point
9379 volatile int last_real_key_start
;
9381 /* These variables are analogous to echo_start and keys_start;
9382 while those allow us to restart the entire key sequence,
9383 echo_local_start and keys_local_start allow us to throw away
9385 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9387 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9388 eassert (indec
.start
<= indec
.end
);
9389 eassert (fkey
.start
<= fkey
.end
);
9390 eassert (keytran
.start
<= keytran
.end
);
9391 /* key-translation-map is applied *after* function-key-map
9392 which is itself applied *after* input-decode-map. */
9393 eassert (fkey
.end
<= indec
.start
);
9394 eassert (keytran
.end
<= fkey
.start
);
9396 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9397 first_unbound
< keytran
.start
)
9398 { /* The prefix upto first_unbound has no binding and has
9399 no translation left to do either, so we know it's unbound.
9400 If we don't stop now, we risk staying here indefinitely
9401 (if the user keeps entering fkey or keytran prefixes
9402 like C-c ESC ESC ESC ESC ...) */
9404 for (i
= first_unbound
+ 1; i
< t
; i
++)
9405 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9406 mock_input
= t
- first_unbound
- 1;
9407 indec
.end
= indec
.start
-= first_unbound
+ 1;
9408 indec
.map
= indec
.parent
;
9409 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9410 fkey
.map
= fkey
.parent
;
9411 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9412 keytran
.map
= keytran
.parent
;
9413 goto replay_sequence
;
9417 error ("Key sequence too long");
9420 echo_local_start
= echo_length ();
9421 keys_local_start
= this_command_key_count
;
9422 local_first_binding
= first_binding
;
9425 /* These are no-ops, unless we throw away a keystroke below and
9426 jumped back up to replay_key; in that case, these restore the
9427 variables to their original state, allowing us to replay the
9429 if (INTERACTIVE
&& t
< mock_input
)
9430 echo_truncate (echo_local_start
);
9431 this_command_key_count
= keys_local_start
;
9432 first_binding
= local_first_binding
;
9434 /* By default, assume each event is "real". */
9435 last_real_key_start
= t
;
9437 /* Does mock_input indicate that we are re-reading a key sequence? */
9441 add_command_key (key
);
9442 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9443 && NILP (Fzerop (Vecho_keystrokes
)))
9447 /* If not, we should actually read a character. */
9451 KBOARD
*interrupted_kboard
= current_kboard
;
9452 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9453 key
= read_char (NILP (prompt
), nmaps
,
9454 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9455 &used_mouse_menu
, NULL
);
9456 if (INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9461 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9462 if (k
== interrupted_kboard
)
9467 /* Don't touch interrupted_kboard when it's been
9469 delayed_switch_frame
= Qnil
;
9470 goto replay_entire_sequence
;
9473 if (!NILP (delayed_switch_frame
))
9475 interrupted_kboard
->kbd_queue
9476 = Fcons (delayed_switch_frame
,
9477 interrupted_kboard
->kbd_queue
);
9478 delayed_switch_frame
= Qnil
;
9482 interrupted_kboard
->kbd_queue
9483 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9485 /* If the side queue is non-empty, ensure it begins with a
9486 switch-frame, so we'll replay it in the right context. */
9487 if (CONSP (interrupted_kboard
->kbd_queue
)
9488 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9489 !(EVENT_HAS_PARAMETERS (key
)
9490 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9494 XSETFRAME (frame
, interrupted_frame
);
9495 interrupted_kboard
->kbd_queue
9496 = Fcons (make_lispy_switch_frame (frame
),
9497 interrupted_kboard
->kbd_queue
);
9500 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9501 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9502 goto replay_entire_sequence
;
9506 /* read_char returns t when it shows a menu and the user rejects it.
9510 unbind_to (count
, Qnil
);
9515 /* read_char returns -1 at the end of a macro.
9516 Emacs 18 handles this by returning immediately with a
9517 zero, so that's what we'll do. */
9518 if (INTEGERP (key
) && XINT (key
) == -1)
9521 /* The Microsoft C compiler can't handle the goto that
9527 /* If the current buffer has been changed from under us, the
9528 keymap may have changed, so replay the sequence. */
9531 timer_resume_idle ();
9534 /* Reset the current buffer from the selected window
9535 in case something changed the former and not the latter.
9536 This is to be more consistent with the behavior
9537 of the command_loop_1. */
9538 if (fix_current_buffer
)
9540 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9542 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9543 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9546 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9547 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9548 goto replay_sequence
;
9551 /* If we have a quit that was typed in another frame, and
9552 quit_throw_to_read_char switched buffers,
9553 replay to get the right keymap. */
9555 && XINT (key
) == quit_char
9556 && current_buffer
!= starting_buffer
)
9559 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9563 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9564 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9565 goto replay_sequence
;
9570 if (EVENT_HAS_PARAMETERS (key
)
9571 /* Either a `switch-frame' or a `select-window' event. */
9572 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9574 /* If we're at the beginning of a key sequence, and the caller
9575 says it's okay, go ahead and return this event. If we're
9576 in the midst of a key sequence, delay it until the end. */
9577 if (t
> 0 || !can_return_switch_frame
)
9579 delayed_switch_frame
= key
;
9585 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9589 /* Clicks in non-text areas get prefixed by the symbol
9590 in their CHAR-ADDRESS field. For example, a click on
9591 the mode line is prefixed by the symbol `mode-line'.
9593 Furthermore, key sequences beginning with mouse clicks
9594 are read using the keymaps of the buffer clicked on, not
9595 the current buffer. So we may have to switch the buffer
9598 When we turn one event into two events, we must make sure
9599 that neither of the two looks like the original--so that,
9600 if we replay the events, they won't be expanded again.
9601 If not for this, such reexpansion could happen either here
9602 or when user programs play with this-command-keys. */
9603 if (EVENT_HAS_PARAMETERS (key
))
9608 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9609 if (EQ (kind
, Qmouse_click
))
9611 Lisp_Object window
, posn
;
9613 window
= POSN_WINDOW (EVENT_START (key
));
9614 posn
= POSN_POSN (EVENT_START (key
));
9617 || (!NILP (fake_prefixed_keys
)
9618 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9620 /* We're looking a second time at an event for which
9621 we generated a fake prefix key. Set
9622 last_real_key_start appropriately. */
9624 last_real_key_start
= t
- 1;
9627 /* Key sequences beginning with mouse clicks are
9628 read using the keymaps in the buffer clicked on,
9629 not the current buffer. If we're at the
9630 beginning of a key sequence, switch buffers. */
9631 if (last_real_key_start
== 0
9633 && BUFFERP (XWINDOW (window
)->buffer
)
9634 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9636 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9640 /* Arrange to go back to the original buffer once we're
9641 done reading the key sequence. Note that we can't
9642 use save_excursion_{save,restore} here, because they
9643 save point as well as the current buffer; we don't
9644 want to save point, because redisplay may change it,
9645 to accommodate a Fset_window_start or something. We
9646 don't want to do this at the top of the function,
9647 because we may get input from a subprocess which
9648 wants to change the selected window and stuff (say,
9650 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9652 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9654 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9655 orig_local_map
= get_local_map (PT
, current_buffer
,
9657 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9658 goto replay_sequence
;
9661 /* For a mouse click, get the local text-property keymap
9662 of the place clicked on, rather than point. */
9663 if (last_real_key_start
== 0
9664 && CONSP (XCDR (key
))
9665 && ! localized_local_map
)
9667 Lisp_Object map_here
, start
, pos
;
9669 localized_local_map
= 1;
9670 start
= EVENT_START (key
);
9672 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9674 pos
= POSN_BUFFER_POSN (start
);
9676 && XINT (pos
) >= BEGV
9677 && XINT (pos
) <= ZV
)
9679 map_here
= get_local_map (XINT (pos
),
9680 current_buffer
, Qlocal_map
);
9681 if (!EQ (map_here
, orig_local_map
))
9683 orig_local_map
= map_here
;
9684 ++localized_local_map
;
9687 map_here
= get_local_map (XINT (pos
),
9688 current_buffer
, Qkeymap
);
9689 if (!EQ (map_here
, orig_keymap
))
9691 orig_keymap
= map_here
;
9692 ++localized_local_map
;
9695 if (localized_local_map
> 1)
9700 goto replay_sequence
;
9706 /* Expand mode-line and scroll-bar events into two events:
9707 use posn as a fake prefix key. */
9709 && (NILP (fake_prefixed_keys
)
9710 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9712 if (t
+ 1 >= bufsize
)
9713 error ("Key sequence too long");
9716 keybuf
[t
+ 1] = key
;
9719 /* Record that a fake prefix key has been generated
9720 for KEY. Don't modify the event; this would
9721 prevent proper action when the event is pushed
9722 back into unread-command-events. */
9723 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9725 /* If on a mode line string with a local keymap,
9726 reconsider the key sequence with that keymap. */
9727 if (string
= POSN_STRING (EVENT_START (key
)),
9728 (CONSP (string
) && STRINGP (XCAR (string
))))
9730 Lisp_Object pos
, map
, map2
;
9732 pos
= XCDR (string
);
9733 string
= XCAR (string
);
9735 && XINT (pos
) < SCHARS (string
))
9737 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9739 orig_local_map
= map
;
9740 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9743 if (!NILP (map
) || !NILP (map2
))
9744 goto replay_sequence
;
9750 else if (NILP (from_string
)
9751 && (string
= POSN_STRING (EVENT_START (key
)),
9752 (CONSP (string
) && STRINGP (XCAR (string
)))))
9754 /* For a click on a string, i.e. overlay string or a
9755 string displayed via the `display' property,
9756 consider `local-map' and `keymap' properties of
9758 Lisp_Object pos
, map
, map2
;
9760 pos
= XCDR (string
);
9761 string
= XCAR (string
);
9763 && XINT (pos
) < SCHARS (string
))
9765 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9767 orig_local_map
= map
;
9768 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9772 if (!NILP (map
) || !NILP (map2
))
9774 from_string
= string
;
9777 goto replay_sequence
;
9782 else if (CONSP (XCDR (key
))
9783 && CONSP (EVENT_START (key
))
9784 && CONSP (XCDR (EVENT_START (key
))))
9788 posn
= POSN_POSN (EVENT_START (key
));
9789 /* Handle menu-bar events:
9790 insert the dummy prefix event `menu-bar'. */
9791 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9793 if (t
+ 1 >= bufsize
)
9794 error ("Key sequence too long");
9798 /* Zap the position in key, so we know that we've
9799 expanded it, and don't try to do so again. */
9800 POSN_SET_POSN (EVENT_START (key
),
9801 Fcons (posn
, Qnil
));
9804 goto replay_sequence
;
9806 else if (CONSP (posn
))
9808 /* We're looking at the second event of a
9809 sequence which we expanded before. Set
9810 last_real_key_start appropriately. */
9811 if (last_real_key_start
== t
&& t
> 0)
9812 last_real_key_start
= t
- 1;
9817 /* We have finally decided that KEY is something we might want
9819 first_binding
= (follow_key (key
,
9820 nmaps
- first_binding
,
9821 submaps
+ first_binding
,
9822 defs
+ first_binding
,
9823 submaps
+ first_binding
)
9826 /* If KEY wasn't bound, we'll try some fallbacks. */
9827 if (first_binding
< nmaps
)
9828 /* This is needed for the following scenario:
9829 event 0: a down-event that gets dropped by calling replay_key.
9830 event 1: some normal prefix like C-h.
9831 After event 0, first_unbound is 0, after event 1 indec.start,
9832 fkey.start, and keytran.start are all 1, so when we see that
9833 C-h is bound, we need to update first_unbound. */
9834 first_unbound
= max (t
+ 1, first_unbound
);
9839 /* Remember the position to put an upper bound on indec.start. */
9840 first_unbound
= min (t
, first_unbound
);
9842 head
= EVENT_HEAD (key
);
9843 if (help_char_p (head
) && t
> 0)
9845 read_key_sequence_cmd
= Vprefix_help_command
;
9847 last_nonmenu_event
= key
;
9848 /* The Microsoft C compiler can't handle the goto that
9856 Lisp_Object breakdown
;
9859 breakdown
= parse_modifiers (head
);
9860 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9861 /* Attempt to reduce an unbound mouse event to a simpler
9862 event that is bound:
9863 Drags reduce to clicks.
9864 Double-clicks reduce to clicks.
9865 Triple-clicks reduce to double-clicks, then to clicks.
9866 Down-clicks are eliminated.
9867 Double-downs reduce to downs, then are eliminated.
9868 Triple-downs reduce to double-downs, then to downs,
9869 then are eliminated. */
9870 if (modifiers
& (down_modifier
| drag_modifier
9871 | double_modifier
| triple_modifier
))
9873 while (modifiers
& (down_modifier
| drag_modifier
9874 | double_modifier
| triple_modifier
))
9876 Lisp_Object new_head
, new_click
;
9877 if (modifiers
& triple_modifier
)
9878 modifiers
^= (double_modifier
| triple_modifier
);
9879 else if (modifiers
& double_modifier
)
9880 modifiers
&= ~double_modifier
;
9881 else if (modifiers
& drag_modifier
)
9882 modifiers
&= ~drag_modifier
;
9885 /* Dispose of this `down' event by simply jumping
9886 back to replay_key, to get another event.
9888 Note that if this event came from mock input,
9889 then just jumping back to replay_key will just
9890 hand it to us again. So we have to wipe out any
9893 We could delete keybuf[t] and shift everything
9894 after that to the left by one spot, but we'd also
9895 have to fix up any variable that points into
9896 keybuf, and shifting isn't really necessary
9899 Adding prefixes for non-textual mouse clicks
9900 creates two characters of mock input, and both
9901 must be thrown away. If we're only looking at
9902 the prefix now, we can just jump back to
9903 replay_key. On the other hand, if we've already
9904 processed the prefix, and now the actual click
9905 itself is giving us trouble, then we've lost the
9906 state of the keymaps we want to backtrack to, and
9907 we need to replay the whole sequence to rebuild
9910 Beyond that, only function key expansion could
9911 create more than two keys, but that should never
9912 generate mouse events, so it's okay to zero
9913 mock_input in that case too.
9915 FIXME: The above paragraph seems just plain
9916 wrong, if you consider things like
9917 xterm-mouse-mode. -stef
9919 Isn't this just the most wonderful code ever? */
9921 /* If mock_input > t + 1, the above simplification
9922 will actually end up dropping keys on the floor.
9923 This is probably OK for now, but even
9924 if mock_input <= t + 1, we need to adjust indec,
9926 Typical case [header-line down-mouse-N]:
9927 mock_input = 2, t = 1, fkey.end = 1,
9928 last_real_key_start = 0. */
9929 if (indec
.end
> last_real_key_start
)
9931 indec
.end
= indec
.start
9932 = min (last_real_key_start
, indec
.start
);
9933 indec
.map
= indec
.parent
;
9934 if (fkey
.end
> last_real_key_start
)
9936 fkey
.end
= fkey
.start
9937 = min (last_real_key_start
, fkey
.start
);
9938 fkey
.map
= fkey
.parent
;
9939 if (keytran
.end
> last_real_key_start
)
9941 keytran
.end
= keytran
.start
9942 = min (last_real_key_start
, keytran
.start
);
9943 keytran
.map
= keytran
.parent
;
9947 if (t
== last_real_key_start
)
9954 mock_input
= last_real_key_start
;
9955 goto replay_sequence
;
9960 = apply_modifiers (modifiers
, XCAR (breakdown
));
9962 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9964 /* Look for a binding for this new key. follow_key
9965 promises that it didn't munge submaps the
9966 last time we called it, since key was unbound. */
9968 = (follow_key (new_click
,
9969 nmaps
- local_first_binding
,
9970 submaps
+ local_first_binding
,
9971 defs
+ local_first_binding
,
9972 submaps
+ local_first_binding
)
9973 + local_first_binding
);
9975 /* If that click is bound, go for it. */
9976 if (first_binding
< nmaps
)
9981 /* Otherwise, we'll leave key set to the drag event. */
9988 /* Normally, last_nonmenu_event gets the previous key we read.
9989 But when a mouse popup menu is being used,
9990 we don't update last_nonmenu_event; it continues to hold the mouse
9991 event that preceded the first level of menu. */
9992 if (!used_mouse_menu
)
9993 last_nonmenu_event
= key
;
9995 /* Record what part of this_command_keys is the current key sequence. */
9996 this_single_command_key_start
= this_command_key_count
- t
;
9998 /* Look for this sequence in input-decode-map.
9999 Scan from indec.end until we find a bound suffix. */
10000 while (indec
.end
< t
)
10002 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10005 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10006 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
10011 mock_input
= diff
+ max (t
, mock_input
);
10012 goto replay_sequence
;
10016 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
10017 && indec
.start
>= t
)
10018 /* There is a binding and it's not a prefix.
10019 (and it doesn't have any input-decode-map translation pending).
10020 There is thus no function-key in this sequence.
10021 Moving fkey.start is important in this case to allow keytran.start
10022 to go over the sequence before we return (since we keep the
10023 invariant that keytran.end <= fkey.start). */
10025 if (fkey
.start
< t
)
10026 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
10029 /* If the sequence is unbound, see if we can hang a function key
10030 off the end of it. */
10031 /* Continue scan from fkey.end until we find a bound suffix. */
10032 while (fkey
.end
< indec
.start
)
10034 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10037 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10038 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
10039 max (t
, mock_input
),
10040 /* If there's a binding (i.e.
10041 first_binding >= nmaps) we don't want
10042 to apply this function-key-mapping. */
10043 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
10048 mock_input
= diff
+ max (t
, mock_input
);
10049 /* Adjust the input-decode-map counters. */
10051 indec
.start
+= diff
;
10053 goto replay_sequence
;
10057 /* Look for this sequence in key-translation-map.
10058 Scan from keytran.end until we find a bound suffix. */
10059 while (keytran
.end
< fkey
.start
)
10061 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10064 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10065 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
10070 mock_input
= diff
+ max (t
, mock_input
);
10071 /* Adjust the function-key-map and input-decode-map counters. */
10073 indec
.start
+= diff
;
10075 fkey
.start
+= diff
;
10077 goto replay_sequence
;
10081 /* If KEY is not defined in any of the keymaps,
10082 and cannot be part of a function key or translation,
10083 and is an upper case letter
10084 use the corresponding lower-case letter instead. */
10085 if (first_binding
>= nmaps
10086 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
10088 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10089 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10090 || (XINT (key
) & shift_modifier
)))
10092 Lisp_Object new_key
;
10094 original_uppercase
= key
;
10095 original_uppercase_position
= t
- 1;
10097 if (XINT (key
) & shift_modifier
)
10098 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10100 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10101 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10103 /* We have to do this unconditionally, regardless of whether
10104 the lower-case char is defined in the keymaps, because they
10105 might get translated through function-key-map. */
10106 keybuf
[t
- 1] = new_key
;
10107 mock_input
= max (t
, mock_input
);
10108 shift_translated
= 1;
10110 goto replay_sequence
;
10112 /* If KEY is not defined in any of the keymaps,
10113 and cannot be part of a function key or translation,
10114 and is a shifted function key,
10115 use the corresponding unshifted function key instead. */
10116 if (first_binding
>= nmaps
10117 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10119 Lisp_Object breakdown
= parse_modifiers (key
);
10121 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10123 if (modifiers
& shift_modifier
10124 /* Treat uppercase keys as shifted. */
10126 && (KEY_TO_CHAR (key
)
10127 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
10128 && UPPERCASEP (KEY_TO_CHAR (key
))))
10130 Lisp_Object new_key
10131 = (modifiers
& shift_modifier
10132 ? apply_modifiers (modifiers
& ~shift_modifier
,
10134 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
10136 original_uppercase
= key
;
10137 original_uppercase_position
= t
- 1;
10139 /* We have to do this unconditionally, regardless of whether
10140 the lower-case char is defined in the keymaps, because they
10141 might get translated through function-key-map. */
10142 keybuf
[t
- 1] = new_key
;
10143 mock_input
= max (t
, mock_input
);
10144 /* Reset fkey (and consequently keytran) to apply
10145 function-key-map on the result, so that S-backspace is
10146 correctly mapped to DEL (via backspace). OTOH,
10147 input-decode-map doesn't need to go through it again. */
10148 fkey
.start
= fkey
.end
= 0;
10149 keytran
.start
= keytran
.end
= 0;
10150 shift_translated
= 1;
10152 goto replay_sequence
;
10157 read_key_sequence_cmd
= (first_binding
< nmaps
10158 ? defs
[first_binding
]
10161 unread_switch_frame
= delayed_switch_frame
;
10162 unbind_to (count
, Qnil
);
10164 /* Don't downcase the last character if the caller says don't.
10165 Don't downcase it if the result is undefined, either. */
10166 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10168 && t
- 1 == original_uppercase_position
)
10170 keybuf
[t
- 1] = original_uppercase
;
10171 shift_translated
= 0;
10174 if (shift_translated
)
10175 Vthis_command_keys_shift_translated
= Qt
;
10177 /* Occasionally we fabricate events, perhaps by expanding something
10178 according to function-key-map, or by adding a prefix symbol to a
10179 mouse click in the scroll bar or modeline. In this cases, return
10180 the entire generated key sequence, even if we hit an unbound
10181 prefix or a definition before the end. This means that you will
10182 be able to push back the event properly, and also means that
10183 read-key-sequence will always return a logical unit.
10186 for (; t
< mock_input
; t
++)
10188 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10189 && NILP (Fzerop (Vecho_keystrokes
)))
10190 echo_char (keybuf
[t
]);
10191 add_command_key (keybuf
[t
]);
10198 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10199 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10200 The sequence is sufficient to specify a non-prefix command in the
10201 current local and global maps.
10203 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10204 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10205 as a continuation of the previous key.
10207 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10208 convert the last event to lower case. (Normally any upper case event
10209 is converted to lower case if the original event is undefined and the lower
10210 case equivalent is defined.) A non-nil value is appropriate for reading
10211 a key sequence to be defined.
10213 A C-g typed while in this function is treated like any other character,
10214 and `quit-flag' is not set.
10216 If the key sequence starts with a mouse click, then the sequence is read
10217 using the keymaps of the buffer of the window clicked in, not the buffer
10218 of the selected window as normal.
10220 `read-key-sequence' drops unbound button-down events, since you normally
10221 only care about the click or drag events which follow them. If a drag
10222 or multi-click event is unbound, but the corresponding click event would
10223 be bound, `read-key-sequence' turns the event into a click event at the
10224 drag's starting position. This means that you don't have to distinguish
10225 between click and drag, double, or triple events unless you want to.
10227 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10228 lines separating windows, and scroll bars with imaginary keys
10229 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10231 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10232 function will process a switch-frame event if the user switches frames
10233 before typing anything. If the user switches frames in the middle of a
10234 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10235 is nil, then the event will be put off until after the current key sequence.
10237 `read-key-sequence' checks `function-key-map' for function key
10238 sequences, where they wouldn't conflict with ordinary bindings. See
10239 `function-key-map' for more details.
10241 The optional fifth argument COMMAND-LOOP, if non-nil, means
10242 that this key sequence is being read by something that will
10243 read commands one after another. It should be nil if the caller
10244 will read just one key sequence. */)
10245 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10247 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10248 Lisp_Object can_return_switch_frame
, command_loop
;
10250 Lisp_Object keybuf
[30];
10252 struct gcpro gcpro1
;
10253 int count
= SPECPDL_INDEX ();
10255 if (!NILP (prompt
))
10256 CHECK_STRING (prompt
);
10259 specbind (Qinput_method_exit_on_first_char
,
10260 (NILP (command_loop
) ? Qt
: Qnil
));
10261 specbind (Qinput_method_use_echo_area
,
10262 (NILP (command_loop
) ? Qt
: Qnil
));
10264 bzero (keybuf
, sizeof keybuf
);
10265 GCPRO1 (keybuf
[0]);
10266 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10268 if (NILP (continue_echo
))
10270 this_command_key_count
= 0;
10271 this_command_key_count_reset
= 0;
10272 this_single_command_key_start
= 0;
10275 #ifdef HAVE_WINDOW_SYSTEM
10276 if (display_hourglass_p
)
10277 cancel_hourglass ();
10280 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10281 prompt
, ! NILP (dont_downcase_last
),
10282 ! NILP (can_return_switch_frame
), 0);
10284 #if 0 /* The following is fine for code reading a key sequence and
10285 then proceeding with a lenghty computation, but it's not good
10286 for code reading keys in a loop, like an input method. */
10287 #ifdef HAVE_WINDOW_SYSTEM
10288 if (display_hourglass_p
)
10289 start_hourglass ();
10299 return unbind_to (count
, make_event_array (i
, keybuf
));
10302 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10303 Sread_key_sequence_vector
, 1, 5, 0,
10304 doc
: /* Like `read-key-sequence' but always return a vector. */)
10305 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10307 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10308 Lisp_Object can_return_switch_frame
, command_loop
;
10310 Lisp_Object keybuf
[30];
10312 struct gcpro gcpro1
;
10313 int count
= SPECPDL_INDEX ();
10315 if (!NILP (prompt
))
10316 CHECK_STRING (prompt
);
10319 specbind (Qinput_method_exit_on_first_char
,
10320 (NILP (command_loop
) ? Qt
: Qnil
));
10321 specbind (Qinput_method_use_echo_area
,
10322 (NILP (command_loop
) ? Qt
: Qnil
));
10324 bzero (keybuf
, sizeof keybuf
);
10325 GCPRO1 (keybuf
[0]);
10326 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10328 if (NILP (continue_echo
))
10330 this_command_key_count
= 0;
10331 this_command_key_count_reset
= 0;
10332 this_single_command_key_start
= 0;
10335 #ifdef HAVE_WINDOW_SYSTEM
10336 if (display_hourglass_p
)
10337 cancel_hourglass ();
10340 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10341 prompt
, ! NILP (dont_downcase_last
),
10342 ! NILP (can_return_switch_frame
), 0);
10344 #ifdef HAVE_WINDOW_SYSTEM
10345 if (display_hourglass_p
)
10346 start_hourglass ();
10355 return unbind_to (count
, Fvector (i
, keybuf
));
10358 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10359 doc
: /* Execute CMD as an editor command.
10360 CMD must be a symbol that satisfies the `commandp' predicate.
10361 Optional second arg RECORD-FLAG non-nil
10362 means unconditionally put this command in `command-history'.
10363 Otherwise, that is done only if an arg is read using the minibuffer.
10364 The argument KEYS specifies the value to use instead of (this-command-keys)
10365 when reading the arguments; if it is nil, (this-command-keys) is used.
10366 The argument SPECIAL, if non-nil, means that this command is executing
10367 a special event, so ignore the prefix argument and don't clear it. */)
10368 (cmd
, record_flag
, keys
, special
)
10369 Lisp_Object cmd
, record_flag
, keys
, special
;
10371 register Lisp_Object final
;
10372 register Lisp_Object tem
;
10373 Lisp_Object prefixarg
;
10374 extern int debug_on_next_call
;
10376 debug_on_next_call
= 0;
10378 if (NILP (special
))
10380 prefixarg
= current_kboard
->Vprefix_arg
;
10381 Vcurrent_prefix_arg
= prefixarg
;
10382 current_kboard
->Vprefix_arg
= Qnil
;
10389 tem
= Fget (cmd
, Qdisabled
);
10390 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10392 tem
= Fsymbol_value (Qdisabled_command_function
);
10394 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10400 final
= Findirect_function (cmd
, Qnil
);
10402 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10404 struct gcpro gcpro1
, gcpro2
;
10406 GCPRO2 (cmd
, prefixarg
);
10407 do_autoload (final
, cmd
);
10414 if (STRINGP (final
) || VECTORP (final
))
10416 /* If requested, place the macro in the command history. For
10417 other sorts of commands, call-interactively takes care of
10419 if (!NILP (record_flag
))
10422 = Fcons (Fcons (Qexecute_kbd_macro
,
10423 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10426 /* Don't keep command history around forever. */
10427 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10429 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10431 XSETCDR (tem
, Qnil
);
10435 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10438 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10439 /* Don't call Fcall_interactively directly because we want to make
10440 sure the backtrace has an entry for `call-interactively'.
10441 For the same reason, pass `cmd' rather than `final'. */
10442 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10449 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10451 doc
: /* Read function name, then read its arguments and call it.
10453 To pass a numeric argument to the command you are invoking with, specify
10454 the numeric argument to this command.
10456 Noninteractively, the argument PREFIXARG is the prefix argument to
10457 give to the command you invoke, if it asks for an argument. */)
10459 Lisp_Object prefixarg
;
10461 Lisp_Object function
;
10463 int saved_last_point_position
;
10464 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10465 Lisp_Object bindings
, value
;
10466 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10467 #ifdef HAVE_WINDOW_SYSTEM
10468 /* The call to Fcompleting_read wil start and cancel the hourglass,
10469 but if the hourglass was already scheduled, this means that no
10470 hourglass will be shown for the actual M-x command itself.
10471 So we restart it if it is already scheduled. Note that checking
10472 hourglass_shown_p is not enough, normally the hourglass is not shown,
10473 just scheduled to be shown. */
10474 int hstarted
= hourglass_started ();
10477 saved_keys
= Fvector (this_command_key_count
,
10478 XVECTOR (this_command_keys
)->contents
);
10479 saved_last_point_position_buffer
= last_point_position_buffer
;
10480 saved_last_point_position
= last_point_position
;
10482 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10484 if (EQ (prefixarg
, Qminus
))
10485 strcpy (buf
, "- ");
10486 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10487 strcpy (buf
, "C-u ");
10488 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10489 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10490 else if (INTEGERP (prefixarg
))
10491 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10493 /* This isn't strictly correct if execute-extended-command
10494 is bound to anything else. Perhaps it should use
10495 this_command_keys? */
10496 strcat (buf
, "M-x ");
10498 /* Prompt with buf, and then read a string, completing from and
10499 restricting to the set of all defined commands. Don't provide
10500 any initial input. Save the command read on the extended-command
10502 function
= Fcompleting_read (build_string (buf
),
10503 Vobarray
, Qcommandp
,
10504 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10507 #ifdef HAVE_WINDOW_SYSTEM
10508 if (hstarted
) start_hourglass ();
10511 if (STRINGP (function
) && SCHARS (function
) == 0)
10512 error ("No command name given");
10514 /* Set this_command_keys to the concatenation of saved_keys and
10515 function, followed by a RET. */
10520 this_command_key_count
= 0;
10521 this_command_key_count_reset
= 0;
10522 this_single_command_key_start
= 0;
10524 keys
= XVECTOR (saved_keys
)->contents
;
10525 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10526 add_command_key (keys
[i
]);
10528 for (i
= 0; i
< SCHARS (function
); i
++)
10529 add_command_key (Faref (function
, make_number (i
)));
10531 add_command_key (make_number ('\015'));
10534 last_point_position
= saved_last_point_position
;
10535 last_point_position_buffer
= saved_last_point_position_buffer
;
10539 function
= Fintern (function
, Qnil
);
10540 current_kboard
->Vprefix_arg
= prefixarg
;
10541 Vthis_command
= function
;
10542 real_this_command
= function
;
10544 /* If enabled, show which key runs this command. */
10545 if (!NILP (Vsuggest_key_bindings
)
10546 && NILP (Vexecuting_kbd_macro
)
10547 && SYMBOLP (function
))
10548 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10554 GCPRO3 (bindings
, value
, function
);
10555 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10557 /* If the command has a key binding, print it now. */
10558 if (!NILP (bindings
)
10559 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10562 /* But first wait, and skip the message if there is input. */
10563 Lisp_Object waited
;
10565 /* If this command displayed something in the echo area;
10566 wait a few seconds, then display our suggestion message. */
10567 if (NILP (echo_area_buffer
[0]))
10568 waited
= sit_for (make_number (0), 0, 2);
10569 else if (NUMBERP (Vsuggest_key_bindings
))
10570 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10572 waited
= sit_for (make_number (2), 0, 2);
10574 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10576 Lisp_Object binding
;
10578 int message_p
= push_message ();
10579 int count
= SPECPDL_INDEX ();
10581 record_unwind_protect (pop_message_unwind
, Qnil
);
10582 binding
= Fkey_description (bindings
, Qnil
);
10585 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10588 sprintf (newmessage
, "You can run the command `%s' with %s",
10589 SDATA (SYMBOL_NAME (function
)),
10591 message2_nolog (newmessage
,
10592 strlen (newmessage
),
10593 STRING_MULTIBYTE (binding
));
10594 if (NUMBERP (Vsuggest_key_bindings
))
10595 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10597 waited
= sit_for (make_number (2), 0, 2);
10599 if (!NILP (waited
) && message_p
)
10600 restore_message ();
10602 unbind_to (count
, Qnil
);
10606 RETURN_UNGCPRO (value
);
10610 /* Return nonzero if input events are pending. */
10613 detect_input_pending ()
10615 if (!input_pending
)
10616 get_input_pending (&input_pending
, 0);
10618 return input_pending
;
10621 /* Return nonzero if input events other than mouse movements are
10625 detect_input_pending_ignore_squeezables ()
10627 if (!input_pending
)
10628 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10630 return input_pending
;
10633 /* Return nonzero if input events are pending, and run any pending timers. */
10636 detect_input_pending_run_timers (do_display
)
10639 int old_timers_run
= timers_run
;
10641 if (!input_pending
)
10642 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10644 if (old_timers_run
!= timers_run
&& do_display
)
10646 redisplay_preserve_echo_area (8);
10647 /* The following fixes a bug when using lazy-lock with
10648 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10649 from an idle timer function. The symptom of the bug is that
10650 the cursor sometimes doesn't become visible until the next X
10651 event is processed. --gerd. */
10653 Lisp_Object tail
, frame
;
10654 FOR_EACH_FRAME (tail
, frame
)
10655 if (FRAME_RIF (XFRAME (frame
)))
10656 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10660 return input_pending
;
10663 /* This is called in some cases before a possible quit.
10664 It cases the next call to detect_input_pending to recompute input_pending.
10665 So calling this function unnecessarily can't do any harm. */
10668 clear_input_pending ()
10673 /* Return nonzero if there are pending requeued events.
10674 This isn't used yet. The hope is to make wait_reading_process_output
10675 call it, and return if it runs Lisp code that unreads something.
10676 The problem is, kbd_buffer_get_event needs to be fixed to know what
10677 to do in that case. It isn't trivial. */
10680 requeued_events_pending_p ()
10682 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10686 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10687 doc
: /* Return t if command input is currently available with no wait.
10688 Actually, the value is nil only if we can be sure that no input is available;
10689 if there is a doubt, the value is t. */)
10692 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10693 || !NILP (Vunread_post_input_method_events
)
10694 || !NILP (Vunread_input_method_events
))
10697 get_input_pending (&input_pending
,
10698 READABLE_EVENTS_DO_TIMERS_NOW
10699 | READABLE_EVENTS_FILTER_EVENTS
);
10700 return input_pending
> 0 ? Qt
: Qnil
;
10703 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10704 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10707 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10710 if (total_keys
< NUM_RECENT_KEYS
)
10711 return Fvector (total_keys
, keys
);
10714 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10715 bcopy (keys
+ recent_keys_index
,
10716 XVECTOR (val
)->contents
,
10717 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10719 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10720 recent_keys_index
* sizeof (Lisp_Object
));
10725 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10726 doc
: /* Return the key sequence that invoked this command.
10727 However, if the command has called `read-key-sequence', it returns
10728 the last key sequence that has been read.
10729 The value is a string or a vector.
10731 See also `this-command-keys-vector'. */)
10734 return make_event_array (this_command_key_count
,
10735 XVECTOR (this_command_keys
)->contents
);
10738 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10739 doc
: /* Return the key sequence that invoked this command, as a vector.
10740 However, if the command has called `read-key-sequence', it returns
10741 the last key sequence that has been read.
10743 See also `this-command-keys'. */)
10746 return Fvector (this_command_key_count
,
10747 XVECTOR (this_command_keys
)->contents
);
10750 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10751 Sthis_single_command_keys
, 0, 0, 0,
10752 doc
: /* Return the key sequence that invoked this command.
10753 More generally, it returns the last key sequence read, either by
10754 the command loop or by `read-key-sequence'.
10755 Unlike `this-command-keys', this function's value
10756 does not include prefix arguments.
10757 The value is always a vector. */)
10760 return Fvector (this_command_key_count
10761 - this_single_command_key_start
,
10762 (XVECTOR (this_command_keys
)->contents
10763 + this_single_command_key_start
));
10766 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10767 Sthis_single_command_raw_keys
, 0, 0, 0,
10768 doc
: /* Return the raw events that were read for this command.
10769 More generally, it returns the last key sequence read, either by
10770 the command loop or by `read-key-sequence'.
10771 Unlike `this-single-command-keys', this function's value
10772 shows the events before all translations (except for input methods).
10773 The value is always a vector. */)
10776 return Fvector (raw_keybuf_count
,
10777 (XVECTOR (raw_keybuf
)->contents
));
10780 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10781 Sreset_this_command_lengths
, 0, 0, 0,
10782 doc
: /* Make the unread events replace the last command and echo.
10783 Used in `universal-argument-other-key'.
10785 `universal-argument-other-key' rereads the event just typed.
10786 It then gets translated through `function-key-map'.
10787 The translated event has to replace the real events,
10788 both in the value of (this-command-keys) and in echoing.
10789 To achieve this, `universal-argument-other-key' calls
10790 `reset-this-command-lengths', which discards the record of reading
10791 these events the first time. */)
10794 this_command_key_count
= before_command_key_count
;
10795 if (this_command_key_count
< this_single_command_key_start
)
10796 this_single_command_key_start
= this_command_key_count
;
10798 echo_truncate (before_command_echo_length
);
10800 /* Cause whatever we put into unread-command-events
10801 to echo as if it were being freshly read from the keyboard. */
10802 this_command_key_count_reset
= 1;
10807 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10808 Sclear_this_command_keys
, 0, 1, 0,
10809 doc
: /* Clear out the vector that `this-command-keys' returns.
10810 Also clear the record of the last 100 events, unless optional arg
10811 KEEP-RECORD is non-nil. */)
10813 Lisp_Object keep_record
;
10817 this_command_key_count
= 0;
10818 this_command_key_count_reset
= 0;
10820 if (NILP (keep_record
))
10822 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10823 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10825 recent_keys_index
= 0;
10830 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10831 doc
: /* Return the current depth in recursive edits. */)
10835 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10839 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10840 "FOpen dribble file: ",
10841 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10842 If FILE is nil, close any open dribble file. */)
10855 file
= Fexpand_file_name (file
, Qnil
);
10856 dribble
= fopen (SDATA (file
), "w");
10858 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10863 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10864 doc
: /* Discard the contents of the terminal input buffer.
10865 Also end any kbd macro being defined. */)
10868 if (!NILP (current_kboard
->defining_kbd_macro
))
10870 /* Discard the last command from the macro. */
10871 Fcancel_kbd_macro_events ();
10875 update_mode_lines
++;
10877 Vunread_command_events
= Qnil
;
10878 unread_command_char
= -1;
10880 discard_tty_input ();
10882 kbd_fetch_ptr
= kbd_store_ptr
;
10888 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10889 doc
: /* Stop Emacs and return to superior process. You can resume later.
10890 If `cannot-suspend' is non-nil, or if the system doesn't support job
10891 control, run a subshell instead.
10893 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10894 to be read as terminal input by Emacs's parent, after suspension.
10896 Before suspending, run the normal hook `suspend-hook'.
10897 After resumption run the normal hook `suspend-resume-hook'.
10899 Some operating systems cannot stop the Emacs process and resume it later.
10900 On such systems, Emacs starts a subshell instead of suspending. */)
10902 Lisp_Object stuffstring
;
10904 int count
= SPECPDL_INDEX ();
10905 int old_height
, old_width
;
10907 struct gcpro gcpro1
;
10909 if (tty_list
&& tty_list
->next
)
10910 error ("There are other tty frames open; close them before suspending Emacs");
10912 if (!NILP (stuffstring
))
10913 CHECK_STRING (stuffstring
);
10915 /* Run the functions in suspend-hook. */
10916 if (!NILP (Vrun_hooks
))
10917 call1 (Vrun_hooks
, intern ("suspend-hook"));
10919 GCPRO1 (stuffstring
);
10920 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10921 reset_all_sys_modes ();
10922 /* sys_suspend can get an error if it tries to fork a subshell
10923 and the system resources aren't available for that. */
10924 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10926 stuff_buffered_input (stuffstring
);
10927 if (cannot_suspend
)
10931 unbind_to (count
, Qnil
);
10933 /* Check if terminal/window size has changed.
10934 Note that this is not useful when we are running directly
10935 with a window system; but suspend should be disabled in that case. */
10936 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10937 if (width
!= old_width
|| height
!= old_height
)
10938 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10940 /* Run suspend-resume-hook. */
10941 if (!NILP (Vrun_hooks
))
10942 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10948 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10949 Then in any case stuff anything Emacs has read ahead and not used. */
10952 stuff_buffered_input (stuffstring
)
10953 Lisp_Object stuffstring
;
10955 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10956 register unsigned char *p
;
10958 if (STRINGP (stuffstring
))
10960 register int count
;
10962 p
= SDATA (stuffstring
);
10963 count
= SBYTES (stuffstring
);
10964 while (count
-- > 0)
10969 /* Anything we have read ahead, put back for the shell to read. */
10970 /* ?? What should this do when we have multiple keyboards??
10971 Should we ignore anything that was typed in at the "wrong" kboard?
10973 rms: we should stuff everything back into the kboard
10975 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10978 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10979 kbd_fetch_ptr
= kbd_buffer
;
10980 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10981 stuff_char (kbd_fetch_ptr
->code
);
10983 clear_event (kbd_fetch_ptr
);
10987 #endif /* SIGTSTP */
10991 set_waiting_for_input (time_to_clear
)
10992 EMACS_TIME
*time_to_clear
;
10994 input_available_clear_time
= time_to_clear
;
10996 /* Tell handle_interrupt to throw back to read_char, */
10997 waiting_for_input
= 1;
10999 /* If handle_interrupt was called before and buffered a C-g,
11000 make it run again now, to avoid timing error. */
11001 if (!NILP (Vquit_flag
))
11002 quit_throw_to_read_char ();
11006 clear_waiting_for_input ()
11008 /* Tell handle_interrupt not to throw back to read_char, */
11009 waiting_for_input
= 0;
11010 input_available_clear_time
= 0;
11013 /* The SIGINT handler.
11015 If we have a frame on the controlling tty, we assume that the
11016 SIGINT was generated by C-g, so we call handle_interrupt.
11017 Otherwise, the handler kills Emacs. */
11020 interrupt_signal (signalnum
) /* If we don't have an argument, */
11021 int signalnum
; /* some compilers complain in signal calls. */
11023 /* Must preserve main program's value of errno. */
11024 int old_errno
= errno
;
11025 struct terminal
*terminal
;
11027 #if defined (USG) && !defined (POSIX_SIGNALS)
11028 /* USG systems forget handlers when they are used;
11029 must reestablish each time */
11030 signal (SIGINT
, interrupt_signal
);
11031 signal (SIGQUIT
, interrupt_signal
);
11034 SIGNAL_THREAD_CHECK (signalnum
);
11036 /* See if we have an active terminal on our controlling tty. */
11037 terminal
= get_named_tty ("/dev/tty");
11040 /* If there are no frames there, let's pretend that we are a
11041 well-behaving UN*X program and quit. */
11042 Fkill_emacs (Qnil
);
11046 /* Otherwise, the SIGINT was probably generated by C-g. */
11048 /* Set internal_last_event_frame to the top frame of the
11049 controlling tty, if we have a frame there. We disable the
11050 interrupt key on secondary ttys, so the SIGINT must have come
11051 from the controlling tty. */
11052 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
11054 handle_interrupt ();
11060 /* This routine is called at interrupt level in response to C-g.
11062 It is called from the SIGINT handler or kbd_buffer_store_event.
11064 If `waiting_for_input' is non zero, then unless `echoing' is
11065 nonzero, immediately throw back to read_char.
11067 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
11068 eval to throw, when it gets a chance. If quit-flag is already
11069 non-nil, it stops the job right away. */
11072 handle_interrupt ()
11078 /* XXX This code needs to be revised for multi-tty support. */
11079 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
11081 /* If SIGINT isn't blocked, don't let us be interrupted by
11082 another SIGINT, it might be harmful due to non-reentrancy
11083 in I/O functions. */
11084 sigblock (sigmask (SIGINT
));
11087 reset_all_sys_modes ();
11089 #ifdef SIGTSTP /* Support possible in later USG versions */
11091 * On systems which can suspend the current process and return to the original
11092 * shell, this command causes the user to end up back at the shell.
11093 * The "Auto-save" and "Abort" questions are not asked until
11094 * the user elects to return to emacs, at which point he can save the current
11095 * job and either dump core or continue.
11099 /* Perhaps should really fork an inferior shell?
11100 But that would not provide any way to get back
11101 to the original shell, ever. */
11102 printf ("No support for stopping a process on this operating system;\n");
11103 printf ("you can continue or abort.\n");
11104 #endif /* not SIGTSTP */
11106 /* We must remain inside the screen area when the internal terminal
11107 is used. Note that [Enter] is not echoed by dos. */
11108 cursor_to (SELECTED_FRAME (), 0, 0);
11110 /* It doesn't work to autosave while GC is in progress;
11111 the code used for auto-saving doesn't cope with the mark bit. */
11112 if (!gc_in_progress
)
11114 printf ("Auto-save? (y or n) ");
11116 if (((c
= getchar ()) & ~040) == 'Y')
11118 Fdo_auto_save (Qt
, Qnil
);
11120 printf ("\r\nAuto-save done");
11121 #else /* not MSDOS */
11122 printf ("Auto-save done\n");
11123 #endif /* not MSDOS */
11125 while (c
!= '\n') c
= getchar ();
11129 /* During GC, it must be safe to reenable quitting again. */
11130 Vinhibit_quit
= Qnil
;
11133 #endif /* not MSDOS */
11134 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11135 printf ("but will instead do a real quit after garbage collection ends\r\n");
11140 printf ("\r\nAbort? (y or n) ");
11141 #else /* not MSDOS */
11142 printf ("Abort (and dump core)? (y or n) ");
11143 #endif /* not MSDOS */
11145 if (((c
= getchar ()) & ~040) == 'Y')
11147 while (c
!= '\n') c
= getchar ();
11149 printf ("\r\nContinuing...\r\n");
11150 #else /* not MSDOS */
11151 printf ("Continuing...\n");
11152 #endif /* not MSDOS */
11154 init_all_sys_modes ();
11159 /* If executing a function that wants to be interrupted out of
11160 and the user has not deferred quitting by binding `inhibit-quit'
11161 then quit right away. */
11162 if (immediate_quit
&& NILP (Vinhibit_quit
))
11164 struct gl_state_s saved
;
11165 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11167 immediate_quit
= 0;
11170 GCPRO4 (saved
.object
, saved
.global_code
,
11171 saved
.current_syntax_table
, saved
.old_prop
);
11172 Fsignal (Qquit
, Qnil
);
11177 /* Else request quit when it's safe */
11181 /* TODO: The longjmp in this call throws the NS event loop integration off,
11182 and it seems to do fine without this. Probably some attention
11183 needs to be paid to the setting of waiting_for_input in
11184 wait_reading_process_output() under HAVE_NS because of the call
11185 to ns_select there (needed because otherwise events aren't picked up
11186 outside of polling since we don't get SIGIO like X and we don't have a
11187 separate event loop thread like W32. */
11189 if (waiting_for_input
&& !echoing
)
11190 quit_throw_to_read_char ();
11194 /* Handle a C-g by making read_char return C-g. */
11197 quit_throw_to_read_char ()
11200 /* Prevent another signal from doing this before we finish. */
11201 clear_waiting_for_input ();
11204 Vunread_command_events
= Qnil
;
11205 unread_command_char
= -1;
11207 #if 0 /* Currently, sit_for is called from read_char without turning
11208 off polling. And that can call set_waiting_for_input.
11209 It seems to be harmless. */
11210 #ifdef POLL_FOR_INPUT
11211 /* May be > 1 if in recursive minibuffer. */
11212 if (poll_suppress_count
== 0)
11216 if (FRAMEP (internal_last_event_frame
)
11217 && !EQ (internal_last_event_frame
, selected_frame
))
11218 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11221 _longjmp (getcjmp
, 1);
11224 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11225 doc
: /* Set interrupt mode of reading keyboard input.
11226 If INTERRUPT is non-nil, Emacs will use input interrupts;
11227 otherwise Emacs uses CBREAK mode.
11229 See also `current-input-mode'. */)
11231 Lisp_Object interrupt
;
11233 int new_interrupt_input
;
11235 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11236 #ifdef HAVE_X_WINDOWS
11237 if (x_display_list
!= NULL
)
11239 /* When using X, don't give the user a real choice,
11240 because we haven't implemented the mechanisms to support it. */
11241 #ifdef NO_SOCK_SIGIO
11242 new_interrupt_input
= 0;
11243 #else /* not NO_SOCK_SIGIO */
11244 new_interrupt_input
= 1;
11245 #endif /* NO_SOCK_SIGIO */
11248 #endif /* HAVE_X_WINDOWS */
11249 new_interrupt_input
= !NILP (interrupt
);
11250 #else /* not SIGIO */
11251 new_interrupt_input
= 0;
11252 #endif /* not SIGIO */
11254 if (new_interrupt_input
!= interrupt_input
)
11256 #ifdef POLL_FOR_INPUT
11260 /* this causes startup screen to be restored and messes with the mouse */
11261 reset_all_sys_modes ();
11263 interrupt_input
= new_interrupt_input
;
11265 init_all_sys_modes ();
11268 #ifdef POLL_FOR_INPUT
11269 poll_suppress_count
= 1;
11276 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11277 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11278 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11279 C-q in key sequences.
11281 This setting only has an effect on tty terminals and only when
11282 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11284 See also `current-input-mode'. */)
11286 Lisp_Object flow
, terminal
;
11288 struct terminal
*t
= get_terminal (terminal
, 1);
11289 struct tty_display_info
*tty
;
11290 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11292 tty
= t
->display_info
.tty
;
11294 if (tty
->flow_control
!= !NILP (flow
))
11297 /* this causes startup screen to be restored and messes with the mouse */
11298 reset_sys_modes (tty
);
11301 tty
->flow_control
= !NILP (flow
);
11304 init_sys_modes (tty
);
11310 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11311 doc
: /* Enable or disable 8-bit input on TERMINAL.
11312 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11313 bit as the Meta modifier.
11315 If META is nil, Emacs will ignore the top bit, on the assumption it is
11318 Otherwise, Emacs will accept and pass through 8-bit input without
11319 specially interpreting the top bit.
11321 This setting only has an effect on tty terminal devices.
11323 Optional parameter TERMINAL specifies the tty terminal device to use.
11324 It may be a terminal object, a frame, or nil for the terminal used by
11325 the currently selected frame.
11327 See also `current-input-mode'. */)
11329 Lisp_Object meta
, terminal
;
11331 struct terminal
*t
= get_terminal (terminal
, 1);
11332 struct tty_display_info
*tty
;
11335 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11337 tty
= t
->display_info
.tty
;
11341 else if (EQ (meta
, Qt
))
11346 if (tty
->meta_key
!= new_meta
)
11349 /* this causes startup screen to be restored and messes with the mouse */
11350 reset_sys_modes (tty
);
11353 tty
->meta_key
= new_meta
;
11356 init_sys_modes (tty
);
11362 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11363 doc
: /* Specify character used for quitting.
11364 QUIT must be an ASCII character.
11366 This function only has an effect on the controlling tty of the Emacs
11369 See also `current-input-mode'. */)
11373 struct terminal
*t
= get_named_tty ("/dev/tty");
11374 struct tty_display_info
*tty
;
11375 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11377 tty
= t
->display_info
.tty
;
11379 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11380 error ("QUIT must be an ASCII character");
11383 /* this causes startup screen to be restored and messes with the mouse */
11384 reset_sys_modes (tty
);
11387 /* Don't let this value be out of range. */
11388 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11391 init_sys_modes (tty
);
11397 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11398 doc
: /* Set mode of reading keyboard input.
11399 First arg INTERRUPT non-nil means use input interrupts;
11400 nil means use CBREAK mode.
11401 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11402 (no effect except in CBREAK mode).
11403 Third arg META t means accept 8-bit input (for a Meta key).
11404 META nil means ignore the top bit, on the assumption it is parity.
11405 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11406 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11407 See also `current-input-mode'. */)
11408 (interrupt
, flow
, meta
, quit
)
11409 Lisp_Object interrupt
, flow
, meta
, quit
;
11411 Fset_input_interrupt_mode (interrupt
);
11412 Fset_output_flow_control (flow
, Qnil
);
11413 Fset_input_meta_mode (meta
, Qnil
);
11415 Fset_quit_char (quit
);
11419 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11420 doc
: /* Return information about the way Emacs currently reads keyboard input.
11421 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11422 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11423 nil, Emacs is using CBREAK mode.
11424 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11425 terminal; this does not apply if Emacs uses interrupt-driven input.
11426 META is t if accepting 8-bit input with 8th bit as Meta flag.
11427 META nil means ignoring the top bit, on the assumption it is parity.
11428 META is neither t nor nil if accepting 8-bit input and using
11429 all 8 bits as the character code.
11430 QUIT is the character Emacs currently uses to quit.
11431 The elements of this list correspond to the arguments of
11432 `set-input-mode'. */)
11435 Lisp_Object val
[4];
11436 struct frame
*sf
= XFRAME (selected_frame
);
11438 val
[0] = interrupt_input
? Qt
: Qnil
;
11439 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11441 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11442 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11444 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11451 XSETFASTINT (val
[3], quit_char
);
11453 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11456 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11457 doc
: /* Return position information for pixel coordinates X and Y.
11458 By default, X and Y are relative to text area of the selected window.
11459 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11460 If optional fourth arg WHOLE is non-nil, X is relative to the left
11461 edge of the window.
11463 The return value is similar to a mouse click position:
11464 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11465 IMAGE (DX . DY) (WIDTH . HEIGHT))
11466 The `posn-' functions access elements of such lists. */)
11467 (x
, y
, frame_or_window
, whole
)
11468 Lisp_Object x
, y
, frame_or_window
, whole
;
11473 if (NILP (frame_or_window
))
11474 frame_or_window
= selected_window
;
11476 if (WINDOWP (frame_or_window
))
11480 CHECK_LIVE_WINDOW (frame_or_window
);
11482 w
= XWINDOW (frame_or_window
);
11483 XSETINT (x
, (XINT (x
)
11484 + WINDOW_LEFT_EDGE_X (w
)
11486 ? window_box_left_offset (w
, TEXT_AREA
)
11488 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11489 frame_or_window
= w
->frame
;
11492 CHECK_LIVE_FRAME (frame_or_window
);
11494 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11497 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11498 doc
: /* Return position information for buffer POS in WINDOW.
11499 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11501 Return nil if position is not visible in window. Otherwise,
11502 the return value is similar to that returned by `event-start' for
11503 a mouse click at the upper left corner of the glyph corresponding
11504 to the given buffer position:
11505 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11506 IMAGE (DX . DY) (WIDTH . HEIGHT))
11507 The `posn-' functions access elements of such lists. */)
11509 Lisp_Object pos
, window
;
11514 window
= selected_window
;
11516 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11519 Lisp_Object x
= XCAR (tem
);
11520 Lisp_Object y
= XCAR (XCDR (tem
));
11522 /* Point invisible due to hscrolling? */
11525 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11533 * Set up a new kboard object with reasonable initial values.
11539 kb
->Voverriding_terminal_local_map
= Qnil
;
11540 kb
->Vlast_command
= Qnil
;
11541 kb
->Vreal_last_command
= Qnil
;
11542 kb
->Vkeyboard_translate_table
= Qnil
;
11543 kb
->Vlast_repeatable_command
= Qnil
;
11544 kb
->Vprefix_arg
= Qnil
;
11545 kb
->Vlast_prefix_arg
= Qnil
;
11546 kb
->kbd_queue
= Qnil
;
11547 kb
->kbd_queue_has_data
= 0;
11548 kb
->immediate_echo
= 0;
11549 kb
->echo_string
= Qnil
;
11550 kb
->echo_after_prompt
= -1;
11551 kb
->kbd_macro_buffer
= 0;
11552 kb
->kbd_macro_bufsize
= 0;
11553 kb
->defining_kbd_macro
= Qnil
;
11554 kb
->Vlast_kbd_macro
= Qnil
;
11555 kb
->reference_count
= 0;
11556 kb
->Vsystem_key_alist
= Qnil
;
11557 kb
->system_key_syms
= Qnil
;
11558 kb
->Vwindow_system
= Qt
; /* Unset. */
11559 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11560 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11561 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11562 kb
->Vdefault_minibuffer_frame
= Qnil
;
11566 * Destroy the contents of a kboard object, but not the object itself.
11567 * We use this just before deleting it, or if we're going to initialize
11568 * it a second time.
11574 xfree (kb
->kbd_macro_buffer
);
11577 /* Free KB and memory referenced from it. */
11585 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11588 *kbp
= kb
->next_kboard
;
11590 /* Prevent a dangling reference to KB. */
11591 if (kb
== current_kboard
11592 && FRAMEP (selected_frame
)
11593 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11595 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11597 if (current_kboard
== kb
)
11608 /* This is correct before outermost invocation of the editor loop */
11609 command_loop_level
= -1;
11610 immediate_quit
= 0;
11611 quit_char
= Ctl ('g');
11612 Vunread_command_events
= Qnil
;
11613 unread_command_char
= -1;
11614 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11616 recent_keys_index
= 0;
11617 kbd_fetch_ptr
= kbd_buffer
;
11618 kbd_store_ptr
= kbd_buffer
;
11619 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11620 do_mouse_tracking
= Qnil
;
11623 interrupt_input_blocked
= 0;
11624 interrupt_input_pending
= 0;
11626 pending_signals
= 0;
11629 /* This means that command_loop_1 won't try to select anything the first
11631 internal_last_event_frame
= Qnil
;
11632 Vlast_event_frame
= internal_last_event_frame
;
11634 current_kboard
= initial_kboard
;
11635 /* Re-initialize the keyboard again. */
11636 wipe_kboard (current_kboard
);
11637 init_kboard (current_kboard
);
11638 /* A value of nil for Vwindow_system normally means a tty, but we also use
11639 it for the initial terminal since there is no window system there. */
11640 current_kboard
->Vwindow_system
= Qnil
;
11642 if (!noninteractive
)
11644 /* Before multi-tty support, these handlers used to be installed
11645 only if the current session was a tty session. Now an Emacs
11646 session may have multiple display types, so we always handle
11647 SIGINT. There is special code in interrupt_signal to exit
11648 Emacs on SIGINT when there are no termcap frames on the
11649 controlling terminal. */
11650 signal (SIGINT
, interrupt_signal
);
11651 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11652 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11653 SIGQUIT and we can't tell which one it will give us. */
11654 signal (SIGQUIT
, interrupt_signal
);
11655 #endif /* HAVE_TERMIO */
11657 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11659 if (!noninteractive
)
11660 signal (SIGIO
, input_available_signal
);
11663 /* Use interrupt input by default, if it works and noninterrupt input
11664 has deficiencies. */
11666 #ifdef INTERRUPT_INPUT
11667 interrupt_input
= 1;
11669 interrupt_input
= 0;
11675 if (keyboard_init_hook
)
11676 (*keyboard_init_hook
) ();
11678 #ifdef POLL_FOR_INPUT
11680 poll_suppress_count
= 1;
11685 /* This type's only use is in syms_of_keyboard, to initialize the
11686 event header symbols and put properties on them. */
11687 struct event_head
{
11693 struct event_head head_table
[] = {
11694 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11695 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11696 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11697 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11698 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11699 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11700 /* `select-window' should be handled just like `switch-frame'
11701 in read_key_sequence. */
11702 {&Qselect_window
, "select-window", &Qswitch_frame
}
11706 syms_of_keyboard ()
11708 pending_funcalls
= Qnil
;
11709 staticpro (&pending_funcalls
);
11711 Vlispy_mouse_stem
= build_string ("mouse");
11712 staticpro (&Vlispy_mouse_stem
);
11715 QCimage
= intern_c_string (":image");
11716 staticpro (&QCimage
);
11718 staticpro (&Qhelp_echo
);
11719 Qhelp_echo
= intern_c_string ("help-echo");
11722 Qrtl
= intern_c_string (":rtl");
11724 staticpro (&item_properties
);
11725 item_properties
= Qnil
;
11727 staticpro (&tool_bar_item_properties
);
11728 tool_bar_item_properties
= Qnil
;
11729 staticpro (&tool_bar_items_vector
);
11730 tool_bar_items_vector
= Qnil
;
11732 staticpro (&real_this_command
);
11733 real_this_command
= Qnil
;
11735 Qtimer_event_handler
= intern_c_string ("timer-event-handler");
11736 staticpro (&Qtimer_event_handler
);
11738 Qdisabled_command_function
= intern_c_string ("disabled-command-function");
11739 staticpro (&Qdisabled_command_function
);
11741 Qself_insert_command
= intern_c_string ("self-insert-command");
11742 staticpro (&Qself_insert_command
);
11744 Qforward_char
= intern_c_string ("forward-char");
11745 staticpro (&Qforward_char
);
11747 Qbackward_char
= intern_c_string ("backward-char");
11748 staticpro (&Qbackward_char
);
11750 Qdisabled
= intern_c_string ("disabled");
11751 staticpro (&Qdisabled
);
11753 Qundefined
= intern_c_string ("undefined");
11754 staticpro (&Qundefined
);
11756 Qpre_command_hook
= intern_c_string ("pre-command-hook");
11757 staticpro (&Qpre_command_hook
);
11759 Qpost_command_hook
= intern_c_string ("post-command-hook");
11760 staticpro (&Qpost_command_hook
);
11762 Qdeferred_action_function
= intern_c_string ("deferred-action-function");
11763 staticpro (&Qdeferred_action_function
);
11765 Qcommand_hook_internal
= intern_c_string ("command-hook-internal");
11766 staticpro (&Qcommand_hook_internal
);
11768 Qfunction_key
= intern_c_string ("function-key");
11769 staticpro (&Qfunction_key
);
11770 Qmouse_click
= intern_c_string ("mouse-click");
11771 staticpro (&Qmouse_click
);
11772 #if defined (WINDOWSNT)
11773 Qlanguage_change
= intern_c_string ("language-change");
11774 staticpro (&Qlanguage_change
);
11776 Qdrag_n_drop
= intern_c_string ("drag-n-drop");
11777 staticpro (&Qdrag_n_drop
);
11779 Qsave_session
= intern_c_string ("save-session");
11780 staticpro (&Qsave_session
);
11783 Qdbus_event
= intern_c_string ("dbus-event");
11784 staticpro (&Qdbus_event
);
11787 Qmenu_enable
= intern_c_string ("menu-enable");
11788 staticpro (&Qmenu_enable
);
11789 QCenable
= intern_c_string (":enable");
11790 staticpro (&QCenable
);
11791 QCvisible
= intern_c_string (":visible");
11792 staticpro (&QCvisible
);
11793 QChelp
= intern_c_string (":help");
11794 staticpro (&QChelp
);
11795 QCfilter
= intern_c_string (":filter");
11796 staticpro (&QCfilter
);
11797 QCbutton
= intern_c_string (":button");
11798 staticpro (&QCbutton
);
11799 QCkeys
= intern_c_string (":keys");
11800 staticpro (&QCkeys
);
11801 QCkey_sequence
= intern_c_string (":key-sequence");
11802 staticpro (&QCkey_sequence
);
11803 QCtoggle
= intern_c_string (":toggle");
11804 staticpro (&QCtoggle
);
11805 QCradio
= intern_c_string (":radio");
11806 staticpro (&QCradio
);
11808 Qmode_line
= intern_c_string ("mode-line");
11809 staticpro (&Qmode_line
);
11810 Qvertical_line
= intern_c_string ("vertical-line");
11811 staticpro (&Qvertical_line
);
11812 Qvertical_scroll_bar
= intern_c_string ("vertical-scroll-bar");
11813 staticpro (&Qvertical_scroll_bar
);
11814 Qmenu_bar
= intern_c_string ("menu-bar");
11815 staticpro (&Qmenu_bar
);
11817 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11818 Qmouse_fixup_help_message
= intern_c_string ("mouse-fixup-help-message");
11819 staticpro (&Qmouse_fixup_help_message
);
11822 Qabove_handle
= intern_c_string ("above-handle");
11823 staticpro (&Qabove_handle
);
11824 Qhandle
= intern_c_string ("handle");
11825 staticpro (&Qhandle
);
11826 Qbelow_handle
= intern_c_string ("below-handle");
11827 staticpro (&Qbelow_handle
);
11828 Qup
= intern_c_string ("up");
11830 Qdown
= intern_c_string ("down");
11831 staticpro (&Qdown
);
11832 Qtop
= intern_c_string ("top");
11834 Qbottom
= intern_c_string ("bottom");
11835 staticpro (&Qbottom
);
11836 Qend_scroll
= intern_c_string ("end-scroll");
11837 staticpro (&Qend_scroll
);
11838 Qratio
= intern_c_string ("ratio");
11839 staticpro (&Qratio
);
11841 Qevent_kind
= intern_c_string ("event-kind");
11842 staticpro (&Qevent_kind
);
11843 Qevent_symbol_elements
= intern_c_string ("event-symbol-elements");
11844 staticpro (&Qevent_symbol_elements
);
11845 Qevent_symbol_element_mask
= intern_c_string ("event-symbol-element-mask");
11846 staticpro (&Qevent_symbol_element_mask
);
11847 Qmodifier_cache
= intern_c_string ("modifier-cache");
11848 staticpro (&Qmodifier_cache
);
11850 Qrecompute_lucid_menubar
= intern_c_string ("recompute-lucid-menubar");
11851 staticpro (&Qrecompute_lucid_menubar
);
11852 Qactivate_menubar_hook
= intern_c_string ("activate-menubar-hook");
11853 staticpro (&Qactivate_menubar_hook
);
11855 Qpolling_period
= intern_c_string ("polling-period");
11856 staticpro (&Qpolling_period
);
11858 Qinput_method_function
= intern_c_string ("input-method-function");
11859 staticpro (&Qinput_method_function
);
11861 Qinput_method_exit_on_first_char
= intern_c_string ("input-method-exit-on-first-char");
11862 staticpro (&Qinput_method_exit_on_first_char
);
11863 Qinput_method_use_echo_area
= intern_c_string ("input-method-use-echo-area");
11864 staticpro (&Qinput_method_use_echo_area
);
11866 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11867 Fset (Qinput_method_use_echo_area
, Qnil
);
11869 last_point_position_buffer
= Qnil
;
11870 last_point_position_window
= Qnil
;
11873 struct event_head
*p
;
11875 for (p
= head_table
;
11876 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11879 *p
->var
= intern_c_string (p
->name
);
11880 staticpro (p
->var
);
11881 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11882 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11886 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11887 staticpro (&button_down_location
);
11888 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11889 staticpro (&mouse_syms
);
11890 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11891 / sizeof (lispy_wheel_names
[0])),
11893 staticpro (&wheel_syms
);
11897 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11899 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11900 for (i
= 0; i
< len
; i
++)
11901 if (modifier_names
[i
])
11902 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11903 staticpro (&modifier_symbols
);
11906 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11907 staticpro (&recent_keys
);
11909 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11910 staticpro (&this_command_keys
);
11912 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11913 staticpro (&raw_keybuf
);
11915 Qextended_command_history
= intern_c_string ("extended-command-history");
11916 Fset (Qextended_command_history
, Qnil
);
11917 staticpro (&Qextended_command_history
);
11919 accent_key_syms
= Qnil
;
11920 staticpro (&accent_key_syms
);
11922 func_key_syms
= Qnil
;
11923 staticpro (&func_key_syms
);
11925 drag_n_drop_syms
= Qnil
;
11926 staticpro (&drag_n_drop_syms
);
11928 unread_switch_frame
= Qnil
;
11929 staticpro (&unread_switch_frame
);
11931 internal_last_event_frame
= Qnil
;
11932 staticpro (&internal_last_event_frame
);
11934 read_key_sequence_cmd
= Qnil
;
11935 staticpro (&read_key_sequence_cmd
);
11937 menu_bar_one_keymap_changed_items
= Qnil
;
11938 staticpro (&menu_bar_one_keymap_changed_items
);
11940 menu_bar_items_vector
= Qnil
;
11941 staticpro (&menu_bar_items_vector
);
11943 help_form_saved_window_configs
= Qnil
;
11944 staticpro (&help_form_saved_window_configs
);
11946 defsubr (&Scurrent_idle_time
);
11947 defsubr (&Sevent_symbol_parse_modifiers
);
11948 defsubr (&Sevent_convert_list
);
11949 defsubr (&Sread_key_sequence
);
11950 defsubr (&Sread_key_sequence_vector
);
11951 defsubr (&Srecursive_edit
);
11952 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11953 defsubr (&Strack_mouse
);
11955 defsubr (&Sinput_pending_p
);
11956 defsubr (&Scommand_execute
);
11957 defsubr (&Srecent_keys
);
11958 defsubr (&Sthis_command_keys
);
11959 defsubr (&Sthis_command_keys_vector
);
11960 defsubr (&Sthis_single_command_keys
);
11961 defsubr (&Sthis_single_command_raw_keys
);
11962 defsubr (&Sreset_this_command_lengths
);
11963 defsubr (&Sclear_this_command_keys
);
11964 defsubr (&Ssuspend_emacs
);
11965 defsubr (&Sabort_recursive_edit
);
11966 defsubr (&Sexit_recursive_edit
);
11967 defsubr (&Srecursion_depth
);
11968 defsubr (&Stop_level
);
11969 defsubr (&Sdiscard_input
);
11970 defsubr (&Sopen_dribble_file
);
11971 defsubr (&Sset_input_interrupt_mode
);
11972 defsubr (&Sset_output_flow_control
);
11973 defsubr (&Sset_input_meta_mode
);
11974 defsubr (&Sset_quit_char
);
11975 defsubr (&Sset_input_mode
);
11976 defsubr (&Scurrent_input_mode
);
11977 defsubr (&Sexecute_extended_command
);
11978 defsubr (&Sposn_at_point
);
11979 defsubr (&Sposn_at_x_y
);
11981 DEFVAR_LISP ("last-command-event", &last_command_event
,
11982 doc
: /* Last input event that was part of a command. */);
11984 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11985 doc
: /* Last input event in a command, except for mouse menu events.
11986 Mouse menus give back keys that don't look like mouse events;
11987 this variable holds the actual mouse event that led to the menu,
11988 so that you can determine whether the command was run by mouse or not. */);
11990 DEFVAR_LISP ("last-input-event", &last_input_event
,
11991 doc
: /* Last input event. */);
11993 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11994 doc
: /* List of events to be read as the command input.
11995 These events are processed first, before actual keyboard input.
11996 Events read from this list are not normally added to `this-command-keys',
11997 as they will already have been added once as they were read for the first time.
11998 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11999 Vunread_command_events
= Qnil
;
12001 DEFVAR_INT ("unread-command-char", &unread_command_char
,
12002 doc
: /* If not -1, an object to be read as next command input event. */);
12004 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
12005 doc
: /* List of events to be processed as input by input methods.
12006 These events are processed before `unread-command-events'
12007 and actual keyboard input, but are not given to `input-method-function'. */);
12008 Vunread_post_input_method_events
= Qnil
;
12010 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
12011 doc
: /* List of events to be processed as input by input methods.
12012 These events are processed after `unread-command-events', but
12013 before actual keyboard input.
12014 If there's an active input method, the events are given to
12015 `input-method-function'. */);
12016 Vunread_input_method_events
= Qnil
;
12018 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
12019 doc
: /* Meta-prefix character code.
12020 Meta-foo as command input turns into this character followed by foo. */);
12021 XSETINT (meta_prefix_char
, 033);
12023 DEFVAR_KBOARD ("last-command", Vlast_command
,
12024 doc
: /* The last command executed.
12025 Normally a symbol with a function definition, but can be whatever was found
12026 in the keymap, or whatever the variable `this-command' was set to by that
12029 The value `mode-exit' is special; it means that the previous command
12030 read an event that told it to exit, and it did so and unread that event.
12031 In other words, the present command is the event that made the previous
12034 The value `kill-region' is special; it means that the previous command
12035 was a kill command.
12037 `last-command' has a separate binding for each terminal device.
12038 See Info node `(elisp)Multiple displays'. */);
12040 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
12041 doc
: /* Same as `last-command', but never altered by Lisp code. */);
12043 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
12044 doc
: /* Last command that may be repeated.
12045 The last command executed that was not bound to an input event.
12046 This is the command `repeat' will try to repeat. */);
12048 DEFVAR_LISP ("this-command", &Vthis_command
,
12049 doc
: /* The command now being executed.
12050 The command can set this variable; whatever is put here
12051 will be in `last-command' during the following command. */);
12052 Vthis_command
= Qnil
;
12054 DEFVAR_LISP ("this-command-keys-shift-translated",
12055 &Vthis_command_keys_shift_translated
,
12056 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
12057 Shift-translation occurs when there is no binding for the key sequence
12058 as entered, but a binding was found by changing an upper-case letter
12059 to lower-case, or a shifted function key to an unshifted one. */);
12060 Vthis_command_keys_shift_translated
= Qnil
;
12062 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
12063 doc
: /* The command bound to the current key sequence before remapping.
12064 It equals `this-command' if the original command was not remapped through
12065 any of the active keymaps. Otherwise, the value of `this-command' is the
12066 result of looking up the original command in the active keymaps. */);
12067 Vthis_original_command
= Qnil
;
12069 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
12070 doc
: /* *Number of input events between auto-saves.
12071 Zero means disable autosaving due to number of characters typed. */);
12072 auto_save_interval
= 300;
12074 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
12075 doc
: /* *Number of seconds idle time before auto-save.
12076 Zero or nil means disable auto-saving due to idleness.
12077 After auto-saving due to this many seconds of idle time,
12078 Emacs also does a garbage collection if that seems to be warranted. */);
12079 XSETFASTINT (Vauto_save_timeout
, 30);
12081 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
12082 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
12083 The value may be integer or floating point. */);
12084 Vecho_keystrokes
= make_number (1);
12086 DEFVAR_INT ("polling-period", &polling_period
,
12087 doc
: /* *Interval between polling for input during Lisp execution.
12088 The reason for polling is to make C-g work to stop a running program.
12089 Polling is needed only when using X windows and SIGIO does not work.
12090 Polling is automatically disabled in all other cases. */);
12091 polling_period
= 2;
12093 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
12094 doc
: /* *Maximum time between mouse clicks to make a double-click.
12095 Measured in milliseconds. The value nil means disable double-click
12096 recognition; t means double-clicks have no time limit and are detected
12097 by position only. */);
12098 Vdouble_click_time
= make_number (500);
12100 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
12101 doc
: /* *Maximum mouse movement between clicks to make a double-click.
12102 On window-system frames, value is the number of pixels the mouse may have
12103 moved horizontally or vertically between two clicks to make a double-click.
12104 On non window-system frames, value is interpreted in units of 1/8 characters
12107 This variable is also the threshold for motion of the mouse
12108 to count as a drag. */);
12109 double_click_fuzz
= 3;
12111 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
12112 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
12113 inhibit_local_menu_bar_menus
= 0;
12115 DEFVAR_INT ("num-input-keys", &num_input_keys
,
12116 doc
: /* Number of complete key sequences read as input so far.
12117 This includes key sequences read from keyboard macros.
12118 The number is effectively the number of interactive command invocations. */);
12119 num_input_keys
= 0;
12121 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
12122 doc
: /* Number of input events read from the keyboard so far.
12123 This does not include events generated by keyboard macros. */);
12124 num_nonmacro_input_events
= 0;
12126 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
12127 doc
: /* The frame in which the most recently read event occurred.
12128 If the last event came from a keyboard macro, this is set to `macro'. */);
12129 Vlast_event_frame
= Qnil
;
12131 /* This variable is set up in sysdep.c. */
12132 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
12133 doc
: /* The ERASE character as set by the user with stty. */);
12135 DEFVAR_LISP ("help-char", &Vhelp_char
,
12136 doc
: /* Character to recognize as meaning Help.
12137 When it is read, do `(eval help-form)', and display result if it's a string.
12138 If the value of `help-form' is nil, this char can be read normally. */);
12139 XSETINT (Vhelp_char
, Ctl ('H'));
12141 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
12142 doc
: /* List of input events to recognize as meaning Help.
12143 These work just like the value of `help-char' (see that). */);
12144 Vhelp_event_list
= Qnil
;
12146 DEFVAR_LISP ("help-form", &Vhelp_form
,
12147 doc
: /* Form to execute when character `help-char' is read.
12148 If the form returns a string, that string is displayed.
12149 If `help-form' is nil, the help char is not recognized. */);
12152 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12153 doc
: /* Command to run when `help-char' character follows a prefix key.
12154 This command is used only when there is no actual binding
12155 for that character after that prefix key. */);
12156 Vprefix_help_command
= Qnil
;
12158 DEFVAR_LISP ("top-level", &Vtop_level
,
12159 doc
: /* Form to evaluate when Emacs starts up.
12160 Useful to set before you dump a modified Emacs. */);
12163 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12164 doc
: /* Translate table for local keyboard input, or nil.
12165 If non-nil, the value should be a char-table. Each character read
12166 from the keyboard is looked up in this char-table. If the value found
12167 there is non-nil, then it is used instead of the actual input character.
12169 The value can also be a string or vector, but this is considered obsolete.
12170 If it is a string or vector of length N, character codes N and up are left
12171 untranslated. In a vector, an element which is nil means "no translation".
12173 This is applied to the characters supplied to input methods, not their
12174 output. See also `translation-table-for-input'.
12176 This variable has a separate binding for each terminal. See Info node
12177 `(elisp)Multiple displays'. */);
12179 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12180 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12181 \(Even if the operating system has support for stopping a process.\) */);
12182 cannot_suspend
= 0;
12184 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12185 doc
: /* Non-nil means prompt with menus when appropriate.
12186 This is done when reading from a keymap that has a prompt string,
12187 for elements that have prompt strings.
12188 The menu is displayed on the screen
12189 if X menus were enabled at configuration
12190 time and the previous event was a mouse click prefix key.
12191 Otherwise, menu prompting uses the echo area. */);
12192 menu_prompting
= 1;
12194 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12195 doc
: /* Character to see next line of menu prompt.
12196 Type this character while in a menu prompt to rotate around the lines of it. */);
12197 XSETINT (menu_prompt_more_char
, ' ');
12199 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12200 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12201 Emacs applies the modifiers of the character stored here to each keyboard
12202 character it reads. For example, after evaluating the expression
12203 (setq extra-keyboard-modifiers ?\\C-x)
12204 all input characters will have the control modifier applied to them.
12206 Note that the character ?\\C-@, equivalent to the integer zero, does
12207 not count as a control character; rather, it counts as a character
12208 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12209 cancels any modification. */);
12210 extra_keyboard_modifiers
= 0;
12212 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12213 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12214 The command loop sets this to nil before each command,
12215 and tests the value when the command returns.
12216 Buffer modification stores t in this variable. */);
12217 Vdeactivate_mark
= Qnil
;
12218 Qdeactivate_mark
= intern_c_string ("deactivate-mark");
12219 staticpro (&Qdeactivate_mark
);
12221 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12222 doc
: /* Temporary storage of `pre-command-hook' or `post-command-hook'. */);
12223 Vcommand_hook_internal
= Qnil
;
12225 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12226 doc
: /* Normal hook run before each command is executed.
12227 If an unhandled error happens in running this hook,
12228 the hook value is set to nil, since otherwise the error
12229 might happen repeatedly and make Emacs nonfunctional. */);
12230 Vpre_command_hook
= Qnil
;
12232 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12233 doc
: /* Normal hook run after each command is executed.
12234 If an unhandled error happens in running this hook,
12235 the hook value is set to nil, since otherwise the error
12236 might happen repeatedly and make Emacs nonfunctional. */);
12237 Vpost_command_hook
= Qnil
;
12240 DEFVAR_LISP ("echo-area-clear-hook", ...,
12241 doc
: /* Normal hook run when clearing the echo area. */);
12243 Qecho_area_clear_hook
= intern_c_string ("echo-area-clear-hook");
12244 staticpro (&Qecho_area_clear_hook
);
12245 Fset (Qecho_area_clear_hook
, Qnil
);
12247 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12248 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12249 Vlucid_menu_bar_dirty_flag
= Qnil
;
12251 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12252 doc
: /* List of menu bar items to move to the end of the menu bar.
12253 The elements of the list are event types that may have menu bar bindings. */);
12254 Vmenu_bar_final_items
= Qnil
;
12256 DEFVAR_KBOARD ("overriding-terminal-local-map",
12257 Voverriding_terminal_local_map
,
12258 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12259 If this variable is non-nil, it is used as a keymap instead of the
12260 buffer's local map, and the minor mode keymaps and text property keymaps.
12261 It also replaces `overriding-local-map'.
12263 This variable is intended to let commands such as `universal-argument'
12264 set up a different keymap for reading the next command.
12266 `overriding-terminal-local-map' has a separate binding for each
12268 See Info node `(elisp)Multiple displays'. */);
12270 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12271 doc
: /* Keymap that overrides all other local keymaps.
12272 If this variable is non-nil, it is used as a keymap--replacing the
12273 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12274 Voverriding_local_map
= Qnil
;
12276 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12277 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12278 Otherwise, the menu bar continues to reflect the buffer's local map
12279 and the minor mode maps regardless of `overriding-local-map'. */);
12280 Voverriding_local_map_menu_flag
= Qnil
;
12282 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12283 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12284 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12286 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12287 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12289 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12290 doc
: /* Alist of system-specific X windows key symbols.
12291 Each element should have the form (N . SYMBOL) where N is the
12292 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12293 and SYMBOL is its name.
12295 `system-key-alist' has a separate binding for each terminal device.
12296 See Info node `(elisp)Multiple displays'. */);
12298 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12299 doc
: /* Keymap that translates key sequences to key sequences during input.
12300 This is used mainly for mapping key sequences into some preferred
12301 key events (symbols).
12303 The `read-key-sequence' function replaces any subsequence bound by
12304 `local-function-key-map' with its binding. More precisely, when the
12305 active keymaps have no binding for the current key sequence but
12306 `local-function-key-map' binds a suffix of the sequence to a vector or
12307 string, `read-key-sequence' replaces the matching suffix with its
12308 binding, and continues with the new sequence.
12310 If the binding is a function, it is called with one argument (the prompt)
12311 and its return value (a key sequence) is used.
12313 The events that come from bindings in `local-function-key-map' are not
12314 themselves looked up in `local-function-key-map'.
12316 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12317 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12318 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12319 typing `ESC O P x' would return [f1 x].
12321 `local-function-key-map' has a separate binding for each terminal
12322 device. See Info node `(elisp)Multiple displays'. If you need to
12323 define a binding on all terminals, change `function-key-map'
12324 instead. Initially, `local-function-key-map' is an empty keymap that
12325 has `function-key-map' as its parent on all terminal devices. */);
12327 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12328 doc
: /* Keymap that decodes input escape sequences.
12329 This is used mainly for mapping ASCII function key sequences into
12330 real Emacs function key events (symbols).
12332 The `read-key-sequence' function replaces any subsequence bound by
12333 `input-decode-map' with its binding. Contrary to `function-key-map',
12334 this map applies its rebinding regardless of the presence of an ordinary
12335 binding. So it is more like `key-translation-map' except that it applies
12336 before `function-key-map' rather than after.
12338 If the binding is a function, it is called with one argument (the prompt)
12339 and its return value (a key sequence) is used.
12341 The events that come from bindings in `input-decode-map' are not
12342 themselves looked up in `input-decode-map'.
12344 This variable is keyboard-local. */);
12346 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12347 doc
: /* The parent keymap of all `local-function-key-map' instances.
12348 Function key definitions that apply to all terminal devices should go
12349 here. If a mapping is defined in both the current
12350 `local-function-key-map' binding and this variable, then the local
12351 definition will take precendence. */);
12352 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12354 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12355 doc
: /* Keymap of key translations that can override keymaps.
12356 This keymap works like `function-key-map', but comes after that,
12357 and its non-prefix bindings override ordinary bindings.
12358 Another difference is that it is global rather than keyboard-local. */);
12359 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12361 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12362 doc
: /* List of deferred actions to be performed at a later time.
12363 The precise format isn't relevant here; we just check whether it is nil. */);
12364 Vdeferred_action_list
= Qnil
;
12366 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12367 doc
: /* Function to call to handle deferred actions, after each command.
12368 This function is called with no arguments after each command
12369 whenever `deferred-action-list' is non-nil. */);
12370 Vdeferred_action_function
= Qnil
;
12372 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12373 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12374 The value can be a length of time to show the message for.
12375 If the value is non-nil and not a number, we wait 2 seconds. */);
12376 Vsuggest_key_bindings
= Qt
;
12378 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12379 doc
: /* List of active absolute time timers in order of increasing time. */);
12380 Vtimer_list
= Qnil
;
12382 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12383 doc
: /* List of active idle-time timers in order of increasing time. */);
12384 Vtimer_idle_list
= Qnil
;
12386 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12387 doc
: /* If non-nil, the function that implements the current input method.
12388 It's called with one argument, a printing character that was just read.
12389 \(That means a character with code 040...0176.)
12390 Typically this function uses `read-event' to read additional events.
12391 When it does so, it should first bind `input-method-function' to nil
12392 so it will not be called recursively.
12394 The function should return a list of zero or more events
12395 to be used as input. If it wants to put back some events
12396 to be reconsidered, separately, by the input method,
12397 it can add them to the beginning of `unread-command-events'.
12399 The input method function can find in `input-method-previous-message'
12400 the previous echo area message.
12402 The input method function should refer to the variables
12403 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12404 for guidance on what to do. */);
12405 Vinput_method_function
= Qnil
;
12407 DEFVAR_LISP ("input-method-previous-message",
12408 &Vinput_method_previous_message
,
12409 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12410 This variable exists because `read-event' clears the echo area
12411 before running the input method. It is nil if there was no message. */);
12412 Vinput_method_previous_message
= Qnil
;
12414 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12415 doc
: /* If non-nil, the function that implements the display of help.
12416 It's called with one argument, the help string to display. */);
12417 Vshow_help_function
= Qnil
;
12419 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12420 doc
: /* If non-nil, suppress point adjustment after executing a command.
12422 After a command is executed, if point is moved into a region that has
12423 special properties (e.g. composition, display), we adjust point to
12424 the boundary of the region. But, when a command sets this variable to
12425 non-nil, we suppress the point adjustment.
12427 This variable is set to nil before reading a command, and is checked
12428 just after executing the command. */);
12429 Vdisable_point_adjustment
= Qnil
;
12431 DEFVAR_LISP ("global-disable-point-adjustment",
12432 &Vglobal_disable_point_adjustment
,
12433 doc
: /* *If non-nil, always suppress point adjustment.
12435 The default value is nil, in which case, point adjustment are
12436 suppressed only after special commands that set
12437 `disable-point-adjustment' (which see) to non-nil. */);
12438 Vglobal_disable_point_adjustment
= Qnil
;
12440 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12441 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12442 If the value is not a number, such messages don't time out. */);
12443 Vminibuffer_message_timeout
= make_number (2);
12445 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12446 doc
: /* If non-nil, any keyboard input throws to this symbol.
12447 The value of that variable is passed to `quit-flag' and later causes a
12448 peculiar kind of quitting. */);
12449 Vthrow_on_input
= Qnil
;
12451 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12452 doc
: /* If non-nil, function to output error messages.
12453 The arguments are the error data, a list of the form
12454 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12455 such as just as `condition-case' would bind its variable to,
12456 the context (a string which normally goes at the start of the message),
12457 and the Lisp function within which the error was signaled. */);
12458 Vcommand_error_function
= Qnil
;
12460 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12461 &Venable_disabled_menus_and_buttons
,
12462 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12464 Help functions bind this to allow help on disabled menu items
12465 and tool-bar buttons. */);
12466 Venable_disabled_menus_and_buttons
= Qnil
;
12468 /* Create the initial keyboard. */
12469 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12470 init_kboard (initial_kboard
);
12471 /* Vwindow_system is left at t for now. */
12472 initial_kboard
->next_kboard
= all_kboards
;
12473 all_kboards
= initial_kboard
;
12477 keys_of_keyboard ()
12479 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12480 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12481 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12482 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12483 initial_define_key (meta_map
, 'x', "execute-extended-command");
12485 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12486 "handle-delete-frame");
12487 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12488 "ns-put-working-text");
12489 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12490 "ns-unput-working-text");
12491 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12492 current-prefix-arg, as is done in `handle-switch-frame'.
12493 But `handle-switch-frame is not run from the special-map.
12494 Commands from that map are run in a special way that automatically
12495 preserves the prefix-arg. Restoring the prefix arg here is not just
12496 redundant but harmful:
12498 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12499 - after the first prompt, the exit-minibuffer-hook is run which may
12500 iconify a frame and thus push a `iconify-frame' event.
12501 - after running exit-minibuffer-hook, current-prefix-arg is
12502 restored to the non-nil value it had before the prompt.
12503 - we enter the second prompt.
12504 current-prefix-arg is non-nil, prefix-arg is nil.
12505 - before running the first real event, we run the special iconify-frame
12506 event, but we pass the `special' arg to execute-command so
12507 current-prefix-arg and prefix-arg are left untouched.
12508 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12509 - the next key event will have a spuriously non-nil current-prefix-arg. */
12510 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12512 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12514 /* Handling it at such a low-level causes read_key_sequence to get
12515 * confused because it doesn't realize that the current_buffer was
12516 * changed by read_char.
12518 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12519 * "handle-select-window"); */
12520 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12521 "handle-save-session");
12524 /* Define a special event which is raised for dbus callback
12526 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12527 "dbus-handle-event");
12531 /* Mark the pointers in the kboard objects.
12532 Called by the Fgarbage_collector. */
12538 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12540 if (kb
->kbd_macro_buffer
)
12541 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12543 mark_object (kb
->Voverriding_terminal_local_map
);
12544 mark_object (kb
->Vlast_command
);
12545 mark_object (kb
->Vreal_last_command
);
12546 mark_object (kb
->Vkeyboard_translate_table
);
12547 mark_object (kb
->Vlast_repeatable_command
);
12548 mark_object (kb
->Vprefix_arg
);
12549 mark_object (kb
->Vlast_prefix_arg
);
12550 mark_object (kb
->kbd_queue
);
12551 mark_object (kb
->defining_kbd_macro
);
12552 mark_object (kb
->Vlast_kbd_macro
);
12553 mark_object (kb
->Vsystem_key_alist
);
12554 mark_object (kb
->system_key_syms
);
12555 mark_object (kb
->Vwindow_system
);
12556 mark_object (kb
->Vinput_decode_map
);
12557 mark_object (kb
->Vlocal_function_key_map
);
12558 mark_object (kb
->Vdefault_minibuffer_frame
);
12559 mark_object (kb
->echo_string
);
12562 struct input_event
*event
;
12563 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12565 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12566 event
= kbd_buffer
;
12567 if (event
->kind
!= SELECTION_REQUEST_EVENT
12568 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12570 mark_object (event
->x
);
12571 mark_object (event
->y
);
12573 mark_object (event
->frame_or_window
);
12574 mark_object (event
->arg
);
12579 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12580 (do not change this comment) */