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 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/>. */
28 #include "termhooks.h"
34 #include "character.h"
36 #include "dispextern.h"
38 #include "intervals.h"
40 #include "blockinput.h"
47 #ifdef HAVE_GTK_AND_PTHREAD
55 #include <sys/ioctl.h>
57 #endif /* not MSDOS */
59 #include "syssignal.h"
61 #include <sys/types.h>
70 /* This is to get the definitions of the XK_ symbols. */
77 #endif /* HAVE_NTGUI */
85 extern Lisp_Object Qsuper
;
92 /* Variables for blockinput.h: */
94 /* Non-zero if interrupt input is blocked right now. */
95 volatile int interrupt_input_blocked
;
97 /* Nonzero means an input interrupt has arrived
98 during the current critical section. */
99 int interrupt_input_pending
;
101 #define KBD_BUFFER_SIZE 4096
104 KBOARD
*initial_kboard
;
105 KBOARD
*current_kboard
;
109 KBOARD the_only_kboard
;
112 /* Non-nil disable property on a command means
113 do not execute it; call disabled-command-function's value instead. */
114 Lisp_Object Qdisabled
, Qdisabled_command_function
;
116 #define NUM_RECENT_KEYS (300)
117 int recent_keys_index
; /* Index for storing next element into recent_keys */
118 int total_keys
; /* Total number of elements stored into recent_keys */
119 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
121 /* Vector holding the key sequence that invoked the current command.
122 It is reused for each command, and it may be longer than the current
123 sequence; this_command_key_count indicates how many elements
124 actually mean something.
125 It's easier to staticpro a single Lisp_Object than an array. */
126 Lisp_Object this_command_keys
;
127 int this_command_key_count
;
129 /* 1 after calling Freset_this_command_lengths.
131 int this_command_key_count_reset
;
133 /* This vector is used as a buffer to record the events that were actually read
134 by read_key_sequence. */
135 Lisp_Object raw_keybuf
;
136 int raw_keybuf_count
;
138 /* Non-nil if the present key sequence was obtained by shift translation. */
139 Lisp_Object Vthis_command_keys_shift_translated
;
141 #define GROW_RAW_KEYBUF \
142 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
143 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
145 /* Number of elements of this_command_keys
146 that precede this key sequence. */
147 int this_single_command_key_start
;
149 /* Record values of this_command_key_count and echo_length ()
150 before this command was read. */
151 static int before_command_key_count
;
152 static int before_command_echo_length
;
154 extern int minbuf_level
;
156 extern int message_enable_multibyte
;
158 /* If non-nil, the function that implements the display of help.
159 It's called with one argument, the help string to display. */
161 Lisp_Object Vshow_help_function
;
163 /* Nonzero means do menu prompting. */
165 static int menu_prompting
;
167 /* Character to see next line of menu prompt. */
169 static Lisp_Object menu_prompt_more_char
;
171 /* For longjmp to where kbd input is being done. */
173 static jmp_buf getcjmp
;
175 /* True while doing kbd input. */
176 int waiting_for_input
;
178 /* True while displaying for echoing. Delays C-g throwing. */
182 /* Non-null means we can start echoing at the next input pause even
183 though there is something in the echo area. */
185 static struct kboard
*ok_to_echo_at_next_pause
;
187 /* The kboard last echoing, or null for none. Reset to 0 in
188 cancel_echoing. If non-null, and a current echo area message
189 exists, and echo_message_buffer is eq to the current message
190 buffer, we know that the message comes from echo_kboard. */
192 struct kboard
*echo_kboard
;
194 /* The buffer used for echoing. Set in echo_now, reset in
197 Lisp_Object echo_message_buffer
;
199 /* Nonzero means disregard local maps for the menu bar. */
200 static int inhibit_local_menu_bar_menus
;
202 /* Nonzero means C-g should cause immediate error-signal. */
205 /* The user's hook function for outputting an error message. */
206 Lisp_Object Vcommand_error_function
;
208 /* The user's ERASE setting. */
209 Lisp_Object Vtty_erase_char
;
211 /* Character to recognize as the help char. */
212 Lisp_Object Vhelp_char
;
214 /* List of other event types to recognize as meaning "help". */
215 Lisp_Object Vhelp_event_list
;
217 /* Form to execute when help char is typed. */
218 Lisp_Object Vhelp_form
;
220 /* Command to run when the help character follows a prefix key. */
221 Lisp_Object Vprefix_help_command
;
223 /* List of items that should move to the end of the menu bar. */
224 Lisp_Object Vmenu_bar_final_items
;
226 /* Non-nil means show the equivalent key-binding for
227 any M-x command that has one.
228 The value can be a length of time to show the message for.
229 If the value is non-nil and not a number, we wait 2 seconds. */
230 Lisp_Object Vsuggest_key_bindings
;
232 /* How long to display an echo-area message when the minibuffer is active.
233 If the value is not a number, such messages don't time out. */
234 Lisp_Object Vminibuffer_message_timeout
;
236 /* Character that causes a quit. Normally C-g.
238 If we are running on an ordinary terminal, this must be an ordinary
239 ASCII char, since we want to make it our interrupt character.
241 If we are not running on an ordinary terminal, it still needs to be
242 an ordinary ASCII char. This character needs to be recognized in
243 the input interrupt handler. At this point, the keystroke is
244 represented as a struct input_event, while the desired quit
245 character is specified as a lispy event. The mapping from struct
246 input_events to lispy events cannot run in an interrupt handler,
247 and the reverse mapping is difficult for anything but ASCII
250 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
254 extern Lisp_Object current_global_map
;
255 extern int minibuf_level
;
257 /* If non-nil, this is a map that overrides all other local maps. */
258 Lisp_Object Voverriding_local_map
;
260 /* If non-nil, Voverriding_local_map applies to the menu bar. */
261 Lisp_Object Voverriding_local_map_menu_flag
;
263 /* Keymap that defines special misc events that should
264 be processed immediately at a low level. */
265 Lisp_Object Vspecial_event_map
;
267 /* Current depth in recursive edits. */
268 int command_loop_level
;
270 /* Total number of times command_loop has read a key sequence. */
271 EMACS_INT num_input_keys
;
273 /* Last input character read as a command. */
274 Lisp_Object last_command_char
;
276 /* Last input character read as a command, not counting menus
277 reached by the mouse. */
278 Lisp_Object last_nonmenu_event
;
280 /* Last input character read for any purpose. */
281 Lisp_Object last_input_char
;
283 /* If not Qnil, a list of objects to be read as subsequent command input. */
284 Lisp_Object Vunread_command_events
;
286 /* If not Qnil, a list of objects to be read as subsequent command input
287 including input method processing. */
288 Lisp_Object Vunread_input_method_events
;
290 /* If not Qnil, a list of objects to be read as subsequent command input
291 but NOT including input method processing. */
292 Lisp_Object Vunread_post_input_method_events
;
294 /* If not -1, an event to be read as subsequent command input. */
295 EMACS_INT unread_command_char
;
297 /* If not Qnil, this is a switch-frame event which we decided to put
298 off until the end of a key sequence. This should be read as the
299 next command input, after any unread_command_events.
301 read_key_sequence uses this to delay switch-frame events until the
302 end of the key sequence; Fread_char uses it to put off switch-frame
303 events until a non-ASCII event is acceptable as input. */
304 Lisp_Object unread_switch_frame
;
306 /* A mask of extra modifier bits to put into every keyboard char. */
307 EMACS_INT extra_keyboard_modifiers
;
309 /* Char to use as prefix when a meta character is typed in.
310 This is bound on entry to minibuffer in case ESC is changed there. */
312 Lisp_Object meta_prefix_char
;
314 /* Last size recorded for a current buffer which is not a minibuffer. */
315 static int last_non_minibuf_size
;
317 /* Number of idle seconds before an auto-save and garbage collection. */
318 static Lisp_Object Vauto_save_timeout
;
320 /* Total number of times read_char has returned. */
321 int num_input_events
;
323 /* Total number of times read_char has returned, outside of macros. */
324 EMACS_INT num_nonmacro_input_events
;
326 /* Auto-save automatically when this many characters have been typed
327 since the last time. */
329 static EMACS_INT auto_save_interval
;
331 /* Value of num_nonmacro_input_events as of last auto save. */
335 /* The command being executed by the command loop.
336 Commands may set this, and the value set will be copied into
337 current_kboard->Vlast_command instead of the actual command. */
338 Lisp_Object Vthis_command
;
340 /* This is like Vthis_command, except that commands never set it. */
341 Lisp_Object real_this_command
;
343 /* If the lookup of the command returns a binding, the original
344 command is stored in this-original-command. It is nil otherwise. */
345 Lisp_Object Vthis_original_command
;
347 /* The value of point when the last command was started. */
348 int last_point_position
;
350 /* The buffer that was current when the last command was started. */
351 Lisp_Object last_point_position_buffer
;
353 /* The window that was selected when the last command was started. */
354 Lisp_Object last_point_position_window
;
356 /* The frame in which the last input event occurred, or Qmacro if the
357 last event came from a macro. We use this to determine when to
358 generate switch-frame events. This may be cleared by functions
359 like Fselect_frame, to make sure that a switch-frame event is
360 generated by the next character. */
361 Lisp_Object internal_last_event_frame
;
363 /* A user-visible version of the above, intended to allow users to
364 figure out where the last event came from, if the event doesn't
365 carry that information itself (i.e. if it was a character). */
366 Lisp_Object Vlast_event_frame
;
368 /* The timestamp of the last input event we received from the X server.
369 X Windows wants this for selection ownership. */
370 unsigned long last_event_timestamp
;
372 Lisp_Object Qself_insert_command
;
373 Lisp_Object Qforward_char
;
374 Lisp_Object Qbackward_char
;
375 Lisp_Object Qundefined
;
376 Lisp_Object Qtimer_event_handler
;
378 /* read_key_sequence stores here the command definition of the
379 key sequence that it reads. */
380 Lisp_Object read_key_sequence_cmd
;
382 /* Echo unfinished commands after this many seconds of pause. */
383 Lisp_Object Vecho_keystrokes
;
385 /* Form to evaluate (if non-nil) when Emacs is started. */
386 Lisp_Object Vtop_level
;
388 /* If non-nil, this implements the current input method. */
389 Lisp_Object Vinput_method_function
;
390 Lisp_Object Qinput_method_function
;
392 /* When we call Vinput_method_function,
393 this holds the echo area message that was just erased. */
394 Lisp_Object Vinput_method_previous_message
;
396 /* Non-nil means deactivate the mark at end of this command. */
397 Lisp_Object Vdeactivate_mark
;
398 Lisp_Object Qdeactivate_mark
;
400 /* Menu bar specified in Lucid Emacs fashion. */
402 Lisp_Object Vlucid_menu_bar_dirty_flag
;
403 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
405 Lisp_Object Qecho_area_clear_hook
;
407 /* Hooks to run before and after each command. */
408 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
409 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
410 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
412 /* Parent keymap of terminal-local function-key-map instances. */
413 Lisp_Object Vfunction_key_map
;
415 /* Keymap of key translations that can override keymaps. */
416 Lisp_Object Vkey_translation_map
;
418 /* List of deferred actions to be performed at a later time.
419 The precise format isn't relevant here; we just check whether it is nil. */
420 Lisp_Object Vdeferred_action_list
;
422 /* Function to call to handle deferred actions, when there are any. */
423 Lisp_Object Vdeferred_action_function
;
424 Lisp_Object Qdeferred_action_function
;
426 Lisp_Object Qinput_method_exit_on_first_char
;
427 Lisp_Object Qinput_method_use_echo_area
;
429 /* File in which we write all commands we read. */
432 /* Nonzero if input is available. */
435 extern char *pending_malloc_warning
;
437 /* Circular buffer for pre-read keyboard input. */
439 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
441 /* Pointer to next available character in kbd_buffer.
442 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
443 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
444 next available char is in kbd_buffer[0]. */
445 static struct input_event
*kbd_fetch_ptr
;
447 /* Pointer to next place to store character in kbd_buffer. This
448 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
449 character should go in kbd_buffer[0]. */
450 static struct input_event
* volatile kbd_store_ptr
;
452 /* The above pair of variables forms a "queue empty" flag. When we
453 enqueue a non-hook event, we increment kbd_store_ptr. When we
454 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
455 there is input available if the two pointers are not equal.
457 Why not just have a flag set and cleared by the enqueuing and
458 dequeuing functions? Such a flag could be screwed up by interrupts
459 at inopportune times. */
461 /* If this flag is non-nil, we check mouse_moved to see when the
462 mouse moves, and motion events will appear in the input stream.
463 Otherwise, mouse motion is ignored. */
464 Lisp_Object do_mouse_tracking
;
466 /* Symbols to head events. */
467 Lisp_Object Qmouse_movement
;
468 Lisp_Object Qscroll_bar_movement
;
469 Lisp_Object Qswitch_frame
;
470 Lisp_Object Qdelete_frame
;
471 Lisp_Object Qiconify_frame
;
472 Lisp_Object Qmake_frame_visible
;
473 Lisp_Object Qselect_window
;
474 Lisp_Object Qhelp_echo
;
476 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
477 Lisp_Object Qmouse_fixup_help_message
;
480 /* Symbols to denote kinds of events. */
481 Lisp_Object Qfunction_key
;
482 Lisp_Object Qmouse_click
;
483 #if defined (WINDOWSNT) || defined (MAC_OS)
484 Lisp_Object Qlanguage_change
;
486 Lisp_Object Qdrag_n_drop
;
487 Lisp_Object Qsave_session
;
489 Lisp_Object Qmac_apple_event
;
492 Lisp_Object Qdbus_event
;
494 /* Lisp_Object Qmouse_movement; - also an event header */
496 /* Properties of event headers. */
497 Lisp_Object Qevent_kind
;
498 Lisp_Object Qevent_symbol_elements
;
500 /* menu item parts */
501 Lisp_Object Qmenu_alias
;
502 Lisp_Object Qmenu_enable
;
503 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
504 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
505 extern Lisp_Object Vdefine_key_rebound_commands
;
506 extern Lisp_Object Qmenu_item
;
508 /* An event header symbol HEAD may have a property named
509 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
510 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
511 mask of modifiers applied to it. If present, this is used to help
512 speed up parse_modifiers. */
513 Lisp_Object Qevent_symbol_element_mask
;
515 /* An unmodified event header BASE may have a property named
516 Qmodifier_cache, which is an alist mapping modifier masks onto
517 modified versions of BASE. If present, this helps speed up
519 Lisp_Object Qmodifier_cache
;
521 /* Symbols to use for parts of windows. */
522 Lisp_Object Qmode_line
;
523 Lisp_Object Qvertical_line
;
524 Lisp_Object Qvertical_scroll_bar
;
525 Lisp_Object Qmenu_bar
;
526 extern Lisp_Object Qleft_margin
, Qright_margin
;
527 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
528 extern Lisp_Object QCmap
;
530 Lisp_Object
recursive_edit_unwind (), command_loop ();
531 Lisp_Object
Fthis_command_keys ();
532 Lisp_Object Qextended_command_history
;
533 EMACS_TIME
timer_check ();
535 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
537 extern char *x_get_keysym_name ();
539 static void record_menu_key ();
540 static int echo_length ();
542 Lisp_Object Qpolling_period
;
544 /* List of absolute timers. Appears in order of next scheduled event. */
545 Lisp_Object Vtimer_list
;
547 /* List of idle time timers. Appears in order of next scheduled event. */
548 Lisp_Object Vtimer_idle_list
;
550 /* Incremented whenever a timer is run. */
553 extern Lisp_Object Vprint_level
, Vprint_length
;
555 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
557 EMACS_TIME
*input_available_clear_time
;
559 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
560 Default is 1 if INTERRUPT_INPUT is defined. */
563 /* Nonzero while interrupts are temporarily deferred during redisplay. */
564 int interrupts_deferred
;
566 /* Allow m- file to inhibit use of FIONREAD. */
567 #ifdef BROKEN_FIONREAD
571 /* We are unable to use interrupts if FIONREAD is not available,
572 so flush SIGIO so we won't try. */
573 #if !defined (FIONREAD)
579 /* If we support a window system, turn on the code to poll periodically
580 to detect C-g. It isn't actually used when doing interrupt input. */
581 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
582 #define POLL_FOR_INPUT
585 /* After a command is executed, if point is moved into a region that
586 has specific properties (e.g. composition, display), we adjust
587 point to the boundary of the region. But, if a command sets this
588 variable to non-nil, we suppress this point adjustment. This
589 variable is set to nil before reading a command. */
591 Lisp_Object Vdisable_point_adjustment
;
593 /* If non-nil, always disable point adjustment. */
595 Lisp_Object Vglobal_disable_point_adjustment
;
597 /* The time when Emacs started being idle. */
599 static EMACS_TIME timer_idleness_start_time
;
601 /* After Emacs stops being idle, this saves the last value
602 of timer_idleness_start_time from when it was idle. */
604 static EMACS_TIME timer_last_idleness_start_time
;
606 /* If non-nil, events produced by disabled menu items and tool-bar
607 buttons are not ignored. Help functions bind this to allow help on
608 those items and buttons. */
609 Lisp_Object Venable_disabled_menus_and_buttons
;
612 /* Global variable declarations. */
614 /* Flags for readable_events. */
615 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
616 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
617 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
619 /* Function for init_keyboard to call with no args (if nonzero). */
620 void (*keyboard_init_hook
) ();
622 static int read_avail_input
P_ ((int));
623 static void get_input_pending
P_ ((int *, int));
624 static int readable_events
P_ ((int));
625 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
626 Lisp_Object
, int *));
627 static Lisp_Object
read_char_x_menu_prompt ();
628 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
630 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
631 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
632 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
633 enum scroll_bar_part
,
634 Lisp_Object
, Lisp_Object
,
637 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
638 Lisp_Object
, char **,
639 Lisp_Object
*, unsigned));
640 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
641 static int parse_solitary_modifier
P_ ((Lisp_Object
));
642 static int parse_solitary_modifier ();
643 static void save_getcjmp
P_ ((jmp_buf));
644 static void save_getcjmp ();
645 static void restore_getcjmp
P_ ((jmp_buf));
646 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
647 static void clear_event
P_ ((struct input_event
*));
649 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
651 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
652 static void handle_interrupt
P_ ((void));
653 static void timer_start_idle
P_ ((void));
654 static void timer_stop_idle
P_ ((void));
655 static void timer_resume_idle
P_ ((void));
656 static SIGTYPE handle_user_signal
P_ ((int));
657 static char *find_user_signal_name
P_ ((int));
658 static int store_user_signal_events
P_ ((void));
660 /* Nonzero means don't try to suspend even if the operating system seems
662 static int cannot_suspend
;
664 extern Lisp_Object Qidentity
, Qonly
;
666 /* Install the string STR as the beginning of the string of echoing,
667 so that it serves as a prompt for the next character.
668 Also start echoing. */
674 current_kboard
->echo_string
= str
;
675 current_kboard
->echo_after_prompt
= SCHARS (str
);
679 /* Add C to the echo string, if echoing is going on.
680 C can be a character, which is printed prettily ("M-C-x" and all that
681 jazz), or a symbol, whose name is printed. */
687 if (current_kboard
->immediate_echo
)
689 int size
= KEY_DESCRIPTION_SIZE
+ 100;
690 char *buffer
= (char *) alloca (size
);
692 Lisp_Object echo_string
;
694 echo_string
= current_kboard
->echo_string
;
696 /* If someone has passed us a composite event, use its head symbol. */
701 ptr
= push_key_description (XINT (c
), ptr
, 1);
703 else if (SYMBOLP (c
))
705 Lisp_Object name
= SYMBOL_NAME (c
);
706 int nbytes
= SBYTES (name
);
708 if (size
- (ptr
- buffer
) < nbytes
)
710 int offset
= ptr
- buffer
;
711 size
= max (2 * size
, size
+ nbytes
);
712 buffer
= (char *) alloca (size
);
713 ptr
= buffer
+ offset
;
716 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
717 STRING_MULTIBYTE (name
), 1);
720 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
723 const char *text
= " (Type ? for further options)";
724 int len
= strlen (text
);
726 if (size
- (ptr
- buffer
) < len
)
728 int offset
= ptr
- buffer
;
730 buffer
= (char *) alloca (size
);
731 ptr
= buffer
+ offset
;
734 bcopy (text
, ptr
, len
);
738 /* Replace a dash from echo_dash with a space, otherwise
739 add a space at the end as a separator between keys. */
740 if (STRINGP (echo_string
)
741 && SCHARS (echo_string
) > 1)
743 Lisp_Object last_char
, prev_char
, idx
;
745 idx
= make_number (SCHARS (echo_string
) - 2);
746 prev_char
= Faref (echo_string
, idx
);
748 idx
= make_number (SCHARS (echo_string
) - 1);
749 last_char
= Faref (echo_string
, idx
);
751 /* We test PREV_CHAR to make sure this isn't the echoing
753 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
754 Faset (echo_string
, idx
, make_number (' '));
756 echo_string
= concat2 (echo_string
, build_string (" "));
758 else if (STRINGP (echo_string
))
759 echo_string
= concat2 (echo_string
, build_string (" "));
761 current_kboard
->echo_string
762 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
768 /* Temporarily add a dash to the end of the echo string if it's not
769 empty, so that it serves as a mini-prompt for the very next character. */
774 /* Do nothing if not echoing at all. */
775 if (NILP (current_kboard
->echo_string
))
778 if (!current_kboard
->immediate_echo
779 && SCHARS (current_kboard
->echo_string
) == 0)
782 /* Do nothing if we just printed a prompt. */
783 if (current_kboard
->echo_after_prompt
784 == SCHARS (current_kboard
->echo_string
))
787 /* Do nothing if we have already put a dash at the end. */
788 if (SCHARS (current_kboard
->echo_string
) > 1)
790 Lisp_Object last_char
, prev_char
, idx
;
792 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
793 prev_char
= Faref (current_kboard
->echo_string
, idx
);
795 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
796 last_char
= Faref (current_kboard
->echo_string
, idx
);
798 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
802 /* Put a dash at the end of the buffer temporarily,
803 but make it go away when the next character is added. */
804 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
809 /* Display the current echo string, and begin echoing if not already
815 if (!current_kboard
->immediate_echo
)
818 current_kboard
->immediate_echo
= 1;
820 for (i
= 0; i
< this_command_key_count
; i
++)
824 /* Set before_command_echo_length to the value that would
825 have been saved before the start of this subcommand in
826 command_loop_1, if we had already been echoing then. */
827 if (i
== this_single_command_key_start
)
828 before_command_echo_length
= echo_length ();
830 c
= XVECTOR (this_command_keys
)->contents
[i
];
831 if (! (EVENT_HAS_PARAMETERS (c
)
832 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
836 /* Set before_command_echo_length to the value that would
837 have been saved before the start of this subcommand in
838 command_loop_1, if we had already been echoing then. */
839 if (this_command_key_count
== this_single_command_key_start
)
840 before_command_echo_length
= echo_length ();
842 /* Put a dash at the end to invite the user to type more. */
847 message3_nolog (current_kboard
->echo_string
,
848 SBYTES (current_kboard
->echo_string
),
849 STRING_MULTIBYTE (current_kboard
->echo_string
));
852 /* Record in what buffer we echoed, and from which kboard. */
853 echo_message_buffer
= echo_area_buffer
[0];
854 echo_kboard
= current_kboard
;
856 if (waiting_for_input
&& !NILP (Vquit_flag
))
857 quit_throw_to_read_char ();
860 /* Turn off echoing, for the start of a new command. */
865 current_kboard
->immediate_echo
= 0;
866 current_kboard
->echo_after_prompt
= -1;
867 current_kboard
->echo_string
= Qnil
;
868 ok_to_echo_at_next_pause
= NULL
;
870 echo_message_buffer
= Qnil
;
873 /* Return the length of the current echo string. */
878 return (STRINGP (current_kboard
->echo_string
)
879 ? SCHARS (current_kboard
->echo_string
)
883 /* Truncate the current echo message to its first LEN chars.
884 This and echo_char get used by read_key_sequence when the user
885 switches frames while entering a key sequence. */
888 echo_truncate (nchars
)
891 if (STRINGP (current_kboard
->echo_string
))
892 current_kboard
->echo_string
893 = Fsubstring (current_kboard
->echo_string
,
894 make_number (0), make_number (nchars
));
895 truncate_echo_area (nchars
);
899 /* Functions for manipulating this_command_keys. */
901 add_command_key (key
)
904 #if 0 /* Not needed after we made Freset_this_command_lengths
905 do the job immediately. */
906 /* If reset-this-command-length was called recently, obey it now.
907 See the doc string of that function for an explanation of why. */
908 if (before_command_restore_flag
)
910 this_command_key_count
= before_command_key_count_1
;
911 if (this_command_key_count
< this_single_command_key_start
)
912 this_single_command_key_start
= this_command_key_count
;
913 echo_truncate (before_command_echo_length_1
);
914 before_command_restore_flag
= 0;
918 if (this_command_key_count
>= ASIZE (this_command_keys
))
919 this_command_keys
= larger_vector (this_command_keys
,
920 2 * ASIZE (this_command_keys
),
923 ASET (this_command_keys
, this_command_key_count
, key
);
924 ++this_command_key_count
;
931 int count
= SPECPDL_INDEX ();
934 if (command_loop_level
> 0)
936 specbind (Qstandard_output
, Qt
);
937 specbind (Qstandard_input
, Qt
);
940 #ifdef HAVE_WINDOW_SYSTEM
941 /* The command loop has started an hourglass timer, so we have to
942 cancel it here, otherwise it will fire because the recursive edit
943 can take some time. Do not check for display_hourglass_p here,
944 because it could already be nil. */
948 /* This function may have been called from a debugger called from
949 within redisplay, for instance by Edebugging a function called
950 from fontification-functions. We want to allow redisplay in
951 the debugging session.
953 The recursive edit is left with a `(throw exit ...)'. The `exit'
954 tag is not caught anywhere in redisplay, i.e. when we leave the
955 recursive edit, the original redisplay leading to the recursive
956 edit will be unwound. The outcome should therefore be safe. */
957 specbind (Qinhibit_redisplay
, Qnil
);
960 val
= command_loop ();
962 Fsignal (Qquit
, Qnil
);
963 /* Handle throw from read_minibuf when using minibuffer
964 while it's active but we're in another window. */
966 xsignal1 (Qerror
, val
);
968 return unbind_to (count
, Qnil
);
971 /* When an auto-save happens, record the "time", and don't do again soon. */
976 last_auto_save
= num_nonmacro_input_events
;
979 /* Make an auto save happen as soon as possible at command level. */
982 force_auto_save_soon ()
984 last_auto_save
= - auto_save_interval
- 1;
986 record_asynch_buffer_change ();
989 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
990 doc
: /* Invoke the editor command loop recursively.
991 To get out of the recursive edit, a command can do `(throw 'exit nil)';
992 that tells this function to return.
993 Alternatively, `(throw 'exit t)' makes this function signal an error.
994 This function is called by the editor initialization to begin editing. */)
997 int count
= SPECPDL_INDEX ();
1000 /* If we enter while input is blocked, don't lock up here.
1001 This may happen through the debugger during redisplay. */
1002 if (INPUT_BLOCKED_P
)
1005 command_loop_level
++;
1006 update_mode_lines
= 1;
1008 if (command_loop_level
1009 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1010 buffer
= Fcurrent_buffer ();
1014 /* If we leave recursive_edit_1 below with a `throw' for instance,
1015 like it is done in the splash screen display, we have to
1016 make sure that we restore single_kboard as command_loop_1
1017 would have done if it were left normally. */
1018 if (command_loop_level
> 0)
1019 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1020 record_unwind_protect (recursive_edit_unwind
, buffer
);
1022 recursive_edit_1 ();
1023 return unbind_to (count
, Qnil
);
1027 recursive_edit_unwind (buffer
)
1030 if (BUFFERP (buffer
))
1031 Fset_buffer (buffer
);
1033 command_loop_level
--;
1034 update_mode_lines
= 1;
1039 #if 0 /* These two functions are now replaced with
1040 temporarily_switch_to_single_kboard. */
1045 #if 0 /* Theory: if there's anything in Vunread_command_events,
1046 it will right away be read by read_key_sequence,
1047 and then if we do switch KBOARDS, it will go into the side
1048 queue then. So we don't need to do anything special here -- rms. */
1049 if (CONSP (Vunread_command_events
))
1051 current_kboard
->kbd_queue
1052 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1053 current_kboard
->kbd_queue_has_data
= 1;
1055 Vunread_command_events
= Qnil
;
1061 /* Switch to the single-kboard state, making current_kboard
1062 the only KBOARD from which further input is accepted. */
1065 single_kboard_state ()
1073 /* If we're in single_kboard state for kboard KBOARD,
1077 not_single_kboard_state (kboard
)
1081 if (kboard
== current_kboard
)
1086 /* Maintain a stack of kboards, so other parts of Emacs
1087 can switch temporarily to the kboard of a given frame
1088 and then revert to the previous status. */
1093 struct kboard_stack
*next
;
1096 static struct kboard_stack
*kboard_stack
;
1103 struct kboard_stack
*p
1104 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1106 p
->next
= kboard_stack
;
1107 p
->kboard
= current_kboard
;
1119 struct kboard_stack
*p
= kboard_stack
;
1121 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1123 if (t
->kboard
== p
->kboard
)
1125 current_kboard
= p
->kboard
;
1132 /* The terminal we remembered has been deleted. */
1133 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1136 kboard_stack
= p
->next
;
1141 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1142 from which further input is accepted. If F is non-nil, set its
1143 KBOARD as the current keyboard.
1145 This function uses record_unwind_protect to return to the previous
1148 If Emacs is already in single_kboard mode, and F's keyboard is
1149 locked, then this function will throw an errow. */
1152 temporarily_switch_to_single_kboard (f
)
1156 int was_locked
= single_kboard
;
1159 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1160 /* We can not switch keyboards while in single_kboard mode.
1161 In rare cases, Lisp code may call `recursive-edit' (or
1162 `read-minibuffer' or `y-or-n-p') after it switched to a
1163 locked frame. For example, this is likely to happen
1164 when server.el connects to a new terminal while Emacs is in
1165 single_kboard mode. It is best to throw an error instead
1166 of presenting the user with a frozen screen. */
1167 error ("Terminal %d is locked, cannot read from it",
1168 FRAME_TERMINAL (f
)->id
);
1170 /* This call is unnecessary, but helps
1171 `restore_kboard_configuration' discover if somebody changed
1172 `current_kboard' behind our back. */
1173 push_kboard (current_kboard
);
1176 current_kboard
= FRAME_KBOARD (f
);
1178 record_unwind_protect (restore_kboard_configuration
,
1179 (was_locked
? Qt
: Qnil
));
1183 #if 0 /* This function is not needed anymore. */
1185 record_single_kboard_state ()
1188 push_kboard (current_kboard
);
1189 record_unwind_protect (restore_kboard_configuration
,
1190 (single_kboard
? Qt
: Qnil
));
1196 restore_kboard_configuration (was_locked
)
1197 Lisp_Object was_locked
;
1199 if (NILP (was_locked
))
1203 struct kboard
*prev
= current_kboard
;
1206 /* The pop should not change the kboard. */
1207 if (single_kboard
&& current_kboard
!= prev
)
1215 /* Handle errors that are not handled at inner levels
1216 by printing an error message and returning to the editor command loop. */
1222 Lisp_Object old_level
, old_length
;
1223 char macroerror
[50];
1225 #ifdef HAVE_WINDOW_SYSTEM
1226 if (display_hourglass_p
)
1227 cancel_hourglass ();
1230 if (!NILP (executing_kbd_macro
))
1232 if (executing_kbd_macro_iterations
== 1)
1233 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1235 sprintf (macroerror
, "After %d kbd macro iterations: ",
1236 executing_kbd_macro_iterations
);
1241 Vstandard_output
= Qt
;
1242 Vstandard_input
= Qt
;
1243 Vexecuting_kbd_macro
= Qnil
;
1244 executing_kbd_macro
= Qnil
;
1245 current_kboard
->Vprefix_arg
= Qnil
;
1246 current_kboard
->Vlast_prefix_arg
= Qnil
;
1249 /* Avoid unquittable loop if data contains a circular list. */
1250 old_level
= Vprint_level
;
1251 old_length
= Vprint_length
;
1252 XSETFASTINT (Vprint_level
, 10);
1253 XSETFASTINT (Vprint_length
, 10);
1254 cmd_error_internal (data
, macroerror
);
1255 Vprint_level
= old_level
;
1256 Vprint_length
= old_length
;
1260 Vinhibit_quit
= Qnil
;
1261 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1263 if (command_loop_level
== 0 && minibuf_level
== 0)
1264 any_kboard_state ();
1268 return make_number (0);
1271 /* Take actions on handling an error. DATA is the data that describes
1274 CONTEXT is a C-string containing ASCII characters only which
1275 describes the context in which the error happened. If we need to
1276 generalize CONTEXT to allow multibyte characters, make it a Lisp
1280 cmd_error_internal (data
, context
)
1284 struct frame
*sf
= SELECTED_FRAME ();
1286 /* The immediate context is not interesting for Quits,
1287 since they are asyncronous. */
1288 if (EQ (XCAR (data
), Qquit
))
1289 Vsignaling_function
= Qnil
;
1294 /* Use user's specified output function if any. */
1295 if (!NILP (Vcommand_error_function
))
1296 call3 (Vcommand_error_function
, data
,
1297 context
? build_string (context
) : empty_unibyte_string
,
1298 Vsignaling_function
);
1299 /* If the window system or terminal frame hasn't been initialized
1300 yet, or we're not interactive, write the message to stderr and exit. */
1301 else if (!sf
->glyphs_initialized_p
1302 || FRAME_INITIAL_P (sf
)
1305 print_error_message (data
, Qexternal_debugging_output
,
1306 context
, Vsignaling_function
);
1307 Fterpri (Qexternal_debugging_output
);
1308 Fkill_emacs (make_number (-1));
1312 clear_message (1, 0);
1314 message_log_maybe_newline ();
1317 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1320 Vsignaling_function
= Qnil
;
1323 Lisp_Object
command_loop_1 ();
1324 Lisp_Object
command_loop_2 ();
1325 Lisp_Object
top_level_1 ();
1327 /* Entry to editor-command-loop.
1328 This level has the catches for exiting/returning to editor command loop.
1329 It returns nil to exit recursive edit, t to abort it. */
1334 if (command_loop_level
> 0 || minibuf_level
> 0)
1337 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1338 executing_kbd_macro
= Qnil
;
1344 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1345 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1346 /* Reset single_kboard in case top-level set it while
1347 evaluating an -f option, or we are stuck there for some
1349 any_kboard_state ();
1351 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1352 executing_kbd_macro
= Qnil
;
1354 /* End of file in -batch run causes exit here. */
1360 /* Here we catch errors in execution of commands within the
1361 editing loop, and reenter the editing loop.
1362 When there is an error, cmd_error runs and returns a non-nil
1363 value to us. A value of nil means that command_loop_1 itself
1364 returned due to end of file (or end of kbd macro). */
1369 register Lisp_Object val
;
1372 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1373 while (!NILP (val
));
1381 return Feval (Vtop_level
);
1387 /* On entry to the outer level, run the startup file */
1388 if (!NILP (Vtop_level
))
1389 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1390 else if (!NILP (Vpurify_flag
))
1391 message ("Bare impure Emacs (standard Lisp code not loaded)");
1393 message ("Bare Emacs (standard Lisp code not loaded)");
1397 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1398 doc
: /* Exit all recursive editing levels. */)
1401 #ifdef HAVE_WINDOW_SYSTEM
1402 if (display_hourglass_p
)
1403 cancel_hourglass ();
1406 /* Unblock input if we enter with input blocked. This may happen if
1407 redisplay traps e.g. during tool-bar update with input blocked. */
1408 while (INPUT_BLOCKED_P
)
1411 return Fthrow (Qtop_level
, Qnil
);
1414 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1415 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1418 if (command_loop_level
> 0 || minibuf_level
> 0)
1419 Fthrow (Qexit
, Qnil
);
1421 error ("No recursive edit is in progress");
1425 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1426 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1429 if (command_loop_level
> 0 || minibuf_level
> 0)
1432 error ("No recursive edit is in progress");
1436 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1438 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1439 of this function. */
1442 tracking_off (old_value
)
1443 Lisp_Object old_value
;
1445 do_mouse_tracking
= old_value
;
1446 if (NILP (old_value
))
1448 /* Redisplay may have been preempted because there was input
1449 available, and it assumes it will be called again after the
1450 input has been processed. If the only input available was
1451 the sort that we have just disabled, then we need to call
1453 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1455 redisplay_preserve_echo_area (6);
1456 get_input_pending (&input_pending
,
1457 READABLE_EVENTS_DO_TIMERS_NOW
);
1463 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1464 doc
: /* Evaluate BODY with mouse movement events enabled.
1465 Within a `track-mouse' form, mouse motion generates input events that
1466 you can read with `read-event'.
1467 Normally, mouse motion is ignored.
1468 usage: (track-mouse BODY...) */)
1472 int count
= SPECPDL_INDEX ();
1475 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1477 do_mouse_tracking
= Qt
;
1479 val
= Fprogn (args
);
1480 return unbind_to (count
, val
);
1483 /* If mouse has moved on some frame, return one of those frames.
1487 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1488 after resizing the tool-bar window. */
1490 int ignore_mouse_drag_p
;
1495 Lisp_Object tail
, frame
;
1497 if (ignore_mouse_drag_p
)
1499 /* ignore_mouse_drag_p = 0; */
1503 FOR_EACH_FRAME (tail
, frame
)
1505 if (XFRAME (frame
)->mouse_moved
)
1506 return XFRAME (frame
);
1512 #endif /* HAVE_MOUSE || HAVE_GPM */
1514 /* This is the actual command reading loop,
1515 sans error-handling encapsulation. */
1517 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1519 void safe_run_hooks
P_ ((Lisp_Object
));
1520 static void adjust_point_for_property
P_ ((int, int));
1522 /* Cancel hourglass from protect_unwind.
1524 #ifdef HAVE_WINDOW_SYSTEM
1526 cancel_hourglass_unwind (arg
)
1529 cancel_hourglass ();
1540 Lisp_Object keybuf
[30];
1542 int prev_modiff
= 0;
1543 struct buffer
*prev_buffer
= NULL
;
1544 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1546 int was_locked
= single_kboard
;
1549 int already_adjusted
= 0;
1551 current_kboard
->Vprefix_arg
= Qnil
;
1552 current_kboard
->Vlast_prefix_arg
= Qnil
;
1553 Vdeactivate_mark
= Qnil
;
1554 waiting_for_input
= 0;
1558 this_command_key_count
= 0;
1559 this_command_key_count_reset
= 0;
1560 this_single_command_key_start
= 0;
1562 if (NILP (Vmemory_full
))
1564 /* Make sure this hook runs after commands that get errors and
1565 throw to top level. */
1566 /* Note that the value cell will never directly contain nil
1567 if the symbol is a local variable. */
1568 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1569 safe_run_hooks (Qpost_command_hook
);
1571 /* If displaying a message, resize the echo area window to fit
1572 that message's size exactly. */
1573 if (!NILP (echo_area_buffer
[0]))
1574 resize_echo_area_exactly ();
1576 if (!NILP (Vdeferred_action_list
))
1577 safe_run_hooks (Qdeferred_action_function
);
1580 /* Do this after running Vpost_command_hook, for consistency. */
1581 current_kboard
->Vlast_command
= Vthis_command
;
1582 current_kboard
->Vreal_last_command
= real_this_command
;
1583 if (!CONSP (last_command_char
))
1584 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1588 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1591 /* Make sure the current window's buffer is selected. */
1592 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1593 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1595 /* Display any malloc warning that just came out. Use while because
1596 displaying one warning can cause another. */
1598 while (pending_malloc_warning
)
1599 display_malloc_warning ();
1601 Vdeactivate_mark
= Qnil
;
1603 /* If minibuffer on and echo area in use,
1604 wait a short time and redraw minibuffer. */
1607 && !NILP (echo_area_buffer
[0])
1608 && EQ (minibuf_window
, echo_area_window
)
1609 && NUMBERP (Vminibuffer_message_timeout
))
1611 /* Bind inhibit-quit to t so that C-g gets read in
1612 rather than quitting back to the minibuffer. */
1613 int count
= SPECPDL_INDEX ();
1614 specbind (Qinhibit_quit
, Qt
);
1616 sit_for (Vminibuffer_message_timeout
, 0, 2);
1618 /* Clear the echo area. */
1620 safe_run_hooks (Qecho_area_clear_hook
);
1622 unbind_to (count
, Qnil
);
1624 /* If a C-g came in before, treat it as input now. */
1625 if (!NILP (Vquit_flag
))
1628 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1633 /* Select the frame that the last event came from. Usually,
1634 switch-frame events will take care of this, but if some lisp
1635 code swallows a switch-frame event, we'll fix things up here.
1636 Is this a good idea? */
1637 if (FRAMEP (internal_last_event_frame
)
1638 && !EQ (internal_last_event_frame
, selected_frame
))
1639 Fselect_frame (internal_last_event_frame
);
1641 /* If it has changed current-menubar from previous value,
1642 really recompute the menubar from the value. */
1643 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1644 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1645 call0 (Qrecompute_lucid_menubar
);
1647 before_command_key_count
= this_command_key_count
;
1648 before_command_echo_length
= echo_length ();
1650 Vthis_command
= Qnil
;
1651 real_this_command
= Qnil
;
1652 Vthis_original_command
= Qnil
;
1653 Vthis_command_keys_shift_translated
= Qnil
;
1655 /* Read next key sequence; i gets its length. */
1656 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1659 /* A filter may have run while we were reading the input. */
1660 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1662 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1663 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1667 /* Now we have read a key sequence of length I,
1668 or else I is 0 and we found end of file. */
1670 if (i
== 0) /* End of file -- happens only in */
1671 return Qnil
; /* a kbd macro, at the end. */
1672 /* -1 means read_key_sequence got a menu that was rejected.
1673 Just loop around and read another command. */
1677 this_command_key_count
= 0;
1678 this_command_key_count_reset
= 0;
1679 this_single_command_key_start
= 0;
1683 last_command_char
= keybuf
[i
- 1];
1685 /* If the previous command tried to force a specific window-start,
1686 forget about that, in case this command moves point far away
1687 from that position. But also throw away beg_unchanged and
1688 end_unchanged information in that case, so that redisplay will
1689 update the whole window properly. */
1690 if (!NILP (XWINDOW (selected_window
)->force_start
))
1693 XWINDOW (selected_window
)->force_start
= Qnil
;
1694 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1695 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1698 cmd
= read_key_sequence_cmd
;
1699 if (!NILP (Vexecuting_kbd_macro
))
1701 if (!NILP (Vquit_flag
))
1703 Vexecuting_kbd_macro
= Qt
;
1704 QUIT
; /* Make some noise. */
1705 /* Will return since macro now empty. */
1709 /* Do redisplay processing after this command except in special
1710 cases identified below. */
1711 prev_buffer
= current_buffer
;
1712 prev_modiff
= MODIFF
;
1713 last_point_position
= PT
;
1714 last_point_position_window
= selected_window
;
1715 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1717 /* By default, we adjust point to a boundary of a region that
1718 has such a property that should be treated intangible
1719 (e.g. composition, display). But, some commands will set
1720 this variable differently. */
1721 Vdisable_point_adjustment
= Qnil
;
1723 /* Process filters and timers may have messed with deactivate-mark.
1724 reset it before we execute the command. */
1725 Vdeactivate_mark
= Qnil
;
1727 /* Remap command through active keymaps */
1728 Vthis_original_command
= cmd
;
1732 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1736 /* Execute the command. */
1738 Vthis_command
= cmd
;
1739 real_this_command
= cmd
;
1740 /* Note that the value cell will never directly contain nil
1741 if the symbol is a local variable. */
1742 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1743 safe_run_hooks (Qpre_command_hook
);
1745 already_adjusted
= 0;
1747 if (NILP (Vthis_command
))
1749 /* nil means key is undefined. */
1750 Lisp_Object keys
= Fvector (i
, keybuf
);
1751 keys
= Fkey_description (keys
, Qnil
);
1753 message_with_string ("%s is undefined", keys
, 0);
1754 current_kboard
->defining_kbd_macro
= Qnil
;
1755 update_mode_lines
= 1;
1756 current_kboard
->Vprefix_arg
= Qnil
;
1760 if (NILP (current_kboard
->Vprefix_arg
))
1762 /* In case we jump to directly_done. */
1763 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1765 /* Recognize some common commands in common situations and
1766 do them directly. */
1767 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
1768 && NILP (Vthis_command_keys_shift_translated
)
1769 && !CONSP (Vtransient_mark_mode
))
1771 struct Lisp_Char_Table
*dp
1772 = window_display_table (XWINDOW (selected_window
));
1773 lose
= FETCH_CHAR (PT_BYTE
);
1775 if (! NILP (Vpost_command_hook
))
1776 /* Put this before calling adjust_point_for_property
1777 so it will only get called once in any case. */
1779 if (current_buffer
== prev_buffer
1780 && last_point_position
!= PT
1781 && NILP (Vdisable_point_adjustment
)
1782 && NILP (Vglobal_disable_point_adjustment
))
1783 adjust_point_for_property (last_point_position
, 0);
1784 already_adjusted
= 1;
1785 if (PT
== last_point_position
+ 1
1787 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1788 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1789 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1790 && (lose
>= 0x20 && lose
< 0x7f)))
1791 : (lose
>= 0x20 && lose
< 0x7f))
1792 /* To extract the case of continuation on
1793 wide-column characters. */
1794 && ASCII_BYTE_P (lose
)
1795 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1797 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1799 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1801 && !windows_or_buffers_changed
1802 && EQ (current_buffer
->selective_display
, Qnil
)
1803 && !detect_input_pending ()
1804 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1805 && NILP (Vexecuting_kbd_macro
))
1806 direct_output_forward_char (1);
1809 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
1810 && NILP (Vthis_command_keys_shift_translated
)
1811 && !CONSP (Vtransient_mark_mode
))
1813 struct Lisp_Char_Table
*dp
1814 = window_display_table (XWINDOW (selected_window
));
1816 lose
= FETCH_CHAR (PT_BYTE
);
1817 if (! NILP (Vpost_command_hook
))
1819 if (current_buffer
== prev_buffer
1820 && last_point_position
!= PT
1821 && NILP (Vdisable_point_adjustment
)
1822 && NILP (Vglobal_disable_point_adjustment
))
1823 adjust_point_for_property (last_point_position
, 0);
1824 already_adjusted
= 1;
1825 if (PT
== last_point_position
- 1
1827 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1828 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1829 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1830 && (lose
>= 0x20 && lose
< 0x7f)))
1831 : (lose
>= 0x20 && lose
< 0x7f))
1832 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1834 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1836 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1838 && !windows_or_buffers_changed
1839 && EQ (current_buffer
->selective_display
, Qnil
)
1840 && !detect_input_pending ()
1841 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1842 && NILP (Vexecuting_kbd_macro
))
1843 direct_output_forward_char (-1);
1846 else if (EQ (Vthis_command
, Qself_insert_command
)
1847 /* Try this optimization only on char keystrokes. */
1848 && NATNUMP (last_command_char
)
1849 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1852 = translate_char (Vtranslation_table_for_input
,
1853 XFASTINT (last_command_char
));
1855 if (NILP (Vexecuting_kbd_macro
)
1856 && !EQ (minibuf_window
, selected_window
))
1858 if (!nonundocount
|| nonundocount
>= 20)
1866 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1868 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1870 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1872 || MODIFF
<= SAVE_MODIFF
1873 || windows_or_buffers_changed
1874 || !EQ (current_buffer
->selective_display
, Qnil
)
1875 || detect_input_pending ()
1876 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1877 || !NILP (Vexecuting_kbd_macro
));
1879 value
= internal_self_insert (c
, 0);
1884 if (! NILP (Vpost_command_hook
))
1885 /* Put this before calling adjust_point_for_property
1886 so it will only get called once in any case. */
1889 /* VALUE == 1 when AFTER-CHANGE functions are
1890 installed which is the case most of the time
1891 because FONT-LOCK installs one. */
1892 if (!lose
&& !value
)
1893 direct_output_for_insert (c
);
1898 /* Here for a command that isn't executed directly */
1901 #ifdef HAVE_WINDOW_SYSTEM
1902 int scount
= SPECPDL_INDEX ();
1904 if (display_hourglass_p
1905 && NILP (Vexecuting_kbd_macro
))
1907 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1913 if (NILP (current_kboard
->Vprefix_arg
))
1915 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1917 #ifdef HAVE_WINDOW_SYSTEM
1918 /* Do not check display_hourglass_p here, because
1919 Fcommand_execute could change it, but we should cancel
1920 hourglass cursor anyway.
1921 But don't cancel the hourglass within a macro
1922 just because a command in the macro finishes. */
1923 if (NILP (Vexecuting_kbd_macro
))
1924 unbind_to (scount
, Qnil
);
1929 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1931 /* Note that the value cell will never directly contain nil
1932 if the symbol is a local variable. */
1933 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1934 safe_run_hooks (Qpost_command_hook
);
1936 /* If displaying a message, resize the echo area window to fit
1937 that message's size exactly. */
1938 if (!NILP (echo_area_buffer
[0]))
1939 resize_echo_area_exactly ();
1941 if (!NILP (Vdeferred_action_list
))
1942 safe_run_hooks (Qdeferred_action_function
);
1944 /* If there is a prefix argument,
1945 1) We don't want Vlast_command to be ``universal-argument''
1946 (that would be dumb), so don't set Vlast_command,
1947 2) we want to leave echoing on so that the prefix will be
1948 echoed as part of this key sequence, so don't call
1950 3) we want to leave this_command_key_count non-zero, so that
1951 read_char will realize that it is re-reading a character, and
1952 not echo it a second time.
1954 If the command didn't actually create a prefix arg,
1955 but is merely a frame event that is transparent to prefix args,
1956 then the above doesn't apply. */
1957 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1959 current_kboard
->Vlast_command
= Vthis_command
;
1960 current_kboard
->Vreal_last_command
= real_this_command
;
1961 if (!CONSP (last_command_char
))
1962 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1964 this_command_key_count
= 0;
1965 this_command_key_count_reset
= 0;
1966 this_single_command_key_start
= 0;
1969 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1971 /* In Emacs 22, setting transient-mark-mode to `only' was a
1972 way of turning it on for just one command. This usage is
1973 obsolete, but support it anyway. */
1974 if (EQ (Vtransient_mark_mode
, Qidentity
))
1975 Vtransient_mark_mode
= Qnil
;
1976 else if (EQ (Vtransient_mark_mode
, Qonly
))
1977 Vtransient_mark_mode
= Qidentity
;
1979 if (!NILP (Vdeactivate_mark
))
1980 call0 (Qdeactivate_mark
);
1981 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1982 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1987 if (current_buffer
== prev_buffer
1988 && last_point_position
!= PT
1989 && NILP (Vdisable_point_adjustment
)
1990 && NILP (Vglobal_disable_point_adjustment
)
1991 && !already_adjusted
)
1992 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1994 /* Install chars successfully executed in kbd macro. */
1996 if (!NILP (current_kboard
->defining_kbd_macro
)
1997 && NILP (current_kboard
->Vprefix_arg
))
1998 finalize_kbd_macro_chars ();
1999 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2002 any_kboard_state ();
2008 extern Lisp_Object Qcomposition
, Qdisplay
;
2010 /* Adjust point to a boundary of a region that has such a property
2011 that should be treated intangible. For the moment, we check
2012 `composition', `display' and `invisible' properties.
2013 LAST_PT is the last position of point. */
2015 extern Lisp_Object Qafter_string
, Qbefore_string
;
2016 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2019 adjust_point_for_property (last_pt
, modified
)
2024 Lisp_Object val
, overlay
, tmp
;
2025 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
2028 /* FIXME: cycling is probably not necessary because these properties
2029 can't be usefully combined anyway. */
2030 while (check_composition
|| check_display
|| check_invisible
)
2032 /* FIXME: check `intangible'. */
2033 if (check_composition
2034 && PT
> BEGV
&& PT
< ZV
2035 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
2036 && COMPOSITION_VALID_P (beg
, end
, val
)
2037 && beg
< PT
/* && end > PT <- It's always the case. */
2038 && (last_pt
<= beg
|| last_pt
>= end
))
2041 SET_PT (PT
< last_pt
? beg
: end
);
2042 check_display
= check_invisible
= 1;
2044 check_composition
= 0;
2046 && PT
> BEGV
&& PT
< ZV
2047 && !NILP (val
= get_char_property_and_overlay
2048 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
2049 && display_prop_intangible_p (val
)
2050 && (!OVERLAYP (overlay
)
2051 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
2052 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
2053 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
2054 && (beg
< PT
/* && end > PT <- It's always the case. */
2055 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
2058 SET_PT (PT
< last_pt
2059 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
2061 check_composition
= check_invisible
= 1;
2064 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
2066 int inv
, ellipsis
= 0;
2069 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2071 && !NILP (val
= get_char_property_and_overlay
2072 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
2073 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2075 ellipsis
= ellipsis
|| inv
> 1
2076 || (OVERLAYP (overlay
)
2077 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2078 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2079 tmp
= Fnext_single_char_property_change
2080 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
2081 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
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 what we catch a C-g if it comes in. This
2208 function is called from x_make_frame_visible, see comment
2214 if (interrupt_input_blocked
== 0
2215 && !waiting_for_input
)
2216 read_avail_input (0);
2219 /* Timer callback function for poll_timer. TIMER is equal to
2223 poll_for_input (timer
)
2224 struct atimer
*timer
;
2226 if (poll_suppress_count
== 0)
2228 interrupt_input_pending
= 1;
2230 poll_for_input_1 ();
2234 #endif /* POLL_FOR_INPUT */
2236 /* Begin signals to poll for input, if they are appropriate.
2237 This function is called unconditionally from various places. */
2242 #ifdef POLL_FOR_INPUT
2243 /* XXX This condition was (read_socket_hook && !interrupt_input),
2244 but read_socket_hook is not global anymore. Let's pretend that
2246 if (!interrupt_input
)
2248 /* Turn alarm handling on unconditionally. It might have
2249 been turned off in process.c. */
2250 turn_on_atimers (1);
2252 /* If poll timer doesn't exist, are we need one with
2253 a different interval, start a new one. */
2254 if (poll_timer
== NULL
2255 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2257 EMACS_TIME interval
;
2260 cancel_atimer (poll_timer
);
2262 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2263 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2264 poll_for_input
, NULL
);
2267 /* Let the timer's callback function poll for input
2268 if this becomes zero. */
2269 --poll_suppress_count
;
2274 /* Nonzero if we are using polling to handle input asynchronously. */
2277 input_polling_used ()
2279 #ifdef POLL_FOR_INPUT
2280 /* XXX This condition was (read_socket_hook && !interrupt_input),
2281 but read_socket_hook is not global anymore. Let's pretend that
2283 return !interrupt_input
;
2289 /* Turn off polling. */
2294 #ifdef POLL_FOR_INPUT
2295 /* XXX This condition was (read_socket_hook && !interrupt_input),
2296 but read_socket_hook is not global anymore. Let's pretend that
2298 if (!interrupt_input
)
2299 ++poll_suppress_count
;
2303 /* Set the value of poll_suppress_count to COUNT
2304 and start or stop polling accordingly. */
2307 set_poll_suppress_count (count
)
2310 #ifdef POLL_FOR_INPUT
2311 if (count
== 0 && poll_suppress_count
!= 0)
2313 poll_suppress_count
= 1;
2316 else if (count
!= 0 && poll_suppress_count
== 0)
2320 poll_suppress_count
= count
;
2324 /* Bind polling_period to a value at least N.
2325 But don't decrease it. */
2328 bind_polling_period (n
)
2331 #ifdef POLL_FOR_INPUT
2332 int new = polling_period
;
2337 stop_other_atimers (poll_timer
);
2339 specbind (Qpolling_period
, make_number (new));
2340 /* Start a new alarm with the new period. */
2345 /* Apply the control modifier to CHARACTER. */
2351 /* Save the upper bits here. */
2352 int upper
= c
& ~0177;
2354 if (! ASCII_BYTE_P (c
))
2355 return c
|= ctrl_modifier
;
2359 /* Everything in the columns containing the upper-case letters
2360 denotes a control character. */
2361 if (c
>= 0100 && c
< 0140)
2365 /* Set the shift modifier for a control char
2366 made from a shifted letter. But only for letters! */
2367 if (oc
>= 'A' && oc
<= 'Z')
2368 c
|= shift_modifier
;
2371 /* The lower-case letters denote control characters too. */
2372 else if (c
>= 'a' && c
<= 'z')
2375 /* Include the bits for control and shift
2376 only if the basic ASCII code can't indicate them. */
2380 /* Replace the high bits. */
2381 c
|= (upper
& ~ctrl_modifier
);
2386 /* Display the help-echo property of the character after the mouse pointer.
2387 Either show it in the echo area, or call show-help-function to display
2388 it by other means (maybe in a tooltip).
2390 If HELP is nil, that means clear the previous help echo.
2392 If HELP is a string, display that string. If HELP is a function,
2393 call it with OBJECT and POS as arguments; the function should
2394 return a help string or nil for none. For all other types of HELP,
2395 evaluate it to obtain a string.
2397 WINDOW is the window in which the help was generated, if any.
2398 It is nil if not in a window.
2400 If OBJECT is a buffer, POS is the position in the buffer where the
2401 `help-echo' text property was found.
2403 If OBJECT is an overlay, that overlay has a `help-echo' property,
2404 and POS is the position in the overlay's buffer under the mouse.
2406 If OBJECT is a string (an overlay string or a string displayed with
2407 the `display' property). POS is the position in that string under
2410 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2411 echo overwrites a keystroke echo currently displayed in the echo
2414 Note: this function may only be called with HELP nil or a string
2415 from X code running asynchronously. */
2418 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2419 Lisp_Object help
, window
, object
, pos
;
2420 int ok_to_overwrite_keystroke_echo
;
2422 if (!NILP (help
) && !STRINGP (help
))
2424 if (FUNCTIONP (help
))
2426 Lisp_Object args
[4];
2431 help
= safe_call (4, args
);
2434 help
= safe_eval (help
);
2436 if (!STRINGP (help
))
2440 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2441 if (!noninteractive
&& STRINGP (help
))
2443 /* The mouse-fixup-help-message Lisp function can call
2444 mouse_position_hook, which resets the mouse_moved flags.
2445 This causes trouble if we are trying to read a mouse motion
2446 event (i.e., if we are inside a `track-mouse' form), so we
2447 restore the mouse_moved flag. */
2448 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2449 help
= call1 (Qmouse_fixup_help_message
, help
);
2455 if (STRINGP (help
) || NILP (help
))
2457 if (!NILP (Vshow_help_function
))
2458 call1 (Vshow_help_function
, help
);
2459 help_echo_showing_p
= STRINGP (help
);
2465 /* Input of single characters from keyboard */
2467 Lisp_Object
print_help ();
2468 static Lisp_Object
kbd_buffer_get_event ();
2469 static void record_char ();
2471 static Lisp_Object help_form_saved_window_configs
;
2473 read_char_help_form_unwind (arg
)
2475 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2476 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2477 if (!NILP (window_config
))
2478 Fset_window_configuration (window_config
);
2482 #define STOP_POLLING \
2483 do { if (! polling_stopped_here) stop_polling (); \
2484 polling_stopped_here = 1; } while (0)
2486 #define RESUME_POLLING \
2487 do { if (polling_stopped_here) start_polling (); \
2488 polling_stopped_here = 0; } while (0)
2490 /* read a character from the keyboard; call the redisplay if needed */
2491 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2492 -1 means do not do redisplay, but do do autosaving.
2495 /* The arguments MAPS and NMAPS are for menu prompting.
2496 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2498 PREV_EVENT is the previous input event, or nil if we are reading
2499 the first event of a key sequence (or not reading a key sequence).
2500 If PREV_EVENT is t, that is a "magic" value that says
2501 not to run input methods, but in other respects to act as if
2502 not reading a key sequence.
2504 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2505 if we used a mouse menu to read the input, or zero otherwise. If
2506 USED_MOUSE_MENU is null, we don't dereference it.
2508 Value is -2 when we find input on another keyboard. A second call
2509 to read_char will read it.
2511 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2512 specifying the maximum time to wait until. If no input arrives by
2513 that time, stop waiting and return nil.
2515 Value is t if we showed a menu and the user rejected it. */
2518 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2522 Lisp_Object prev_event
;
2523 int *used_mouse_menu
;
2524 EMACS_TIME
*end_time
;
2526 volatile Lisp_Object c
;
2527 int count
, jmpcount
;
2528 jmp_buf local_getcjmp
;
2530 volatile int key_already_recorded
= 0;
2531 Lisp_Object tem
, save
;
2532 volatile Lisp_Object previous_echo_area_message
;
2533 volatile Lisp_Object also_record
;
2534 volatile int reread
;
2535 struct gcpro gcpro1
, gcpro2
;
2536 int polling_stopped_here
= 0;
2537 struct kboard
*orig_kboard
= current_kboard
;
2541 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2542 before_command_key_count
= this_command_key_count
;
2543 before_command_echo_length
= echo_length ();
2546 previous_echo_area_message
= Qnil
;
2548 GCPRO2 (c
, previous_echo_area_message
);
2553 if (CONSP (Vunread_post_input_method_events
))
2555 c
= XCAR (Vunread_post_input_method_events
);
2556 Vunread_post_input_method_events
2557 = XCDR (Vunread_post_input_method_events
);
2559 /* Undo what read_char_x_menu_prompt did when it unread
2560 additional keys returned by Fx_popup_menu. */
2562 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2570 if (unread_command_char
!= -1)
2572 XSETINT (c
, unread_command_char
);
2573 unread_command_char
= -1;
2579 if (CONSP (Vunread_command_events
))
2581 c
= XCAR (Vunread_command_events
);
2582 Vunread_command_events
= XCDR (Vunread_command_events
);
2586 /* Undo what sit-for did when it unread additional keys
2587 inside universal-argument. */
2590 && EQ (XCAR (c
), Qt
))
2596 /* Undo what read_char_x_menu_prompt did when it unread
2597 additional keys returned by Fx_popup_menu. */
2599 && EQ (XCDR (c
), Qdisabled
)
2600 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2603 /* If the queued event is something that used the mouse,
2604 set used_mouse_menu accordingly. */
2606 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2607 *used_mouse_menu
= 1;
2609 goto reread_for_input_method
;
2612 if (CONSP (Vunread_input_method_events
))
2614 c
= XCAR (Vunread_input_method_events
);
2615 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2617 /* Undo what read_char_x_menu_prompt did when it unread
2618 additional keys returned by Fx_popup_menu. */
2620 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2624 goto reread_for_input_method
;
2627 this_command_key_count_reset
= 0;
2629 if (!NILP (Vexecuting_kbd_macro
))
2631 /* We set this to Qmacro; since that's not a frame, nobody will
2632 try to switch frames on us, and the selected window will
2635 Since this event came from a macro, it would be misleading to
2636 leave internal_last_event_frame set to wherever the last
2637 real event came from. Normally, a switch-frame event selects
2638 internal_last_event_frame after each command is read, but
2639 events read from a macro should never cause a new frame to be
2641 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2643 /* Exit the macro if we are at the end.
2644 Also, some things replace the macro with t
2645 to force an early exit. */
2646 if (EQ (Vexecuting_kbd_macro
, Qt
)
2647 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2653 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2654 if (STRINGP (Vexecuting_kbd_macro
)
2655 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2656 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2658 executing_kbd_macro_index
++;
2663 if (!NILP (unread_switch_frame
))
2665 c
= unread_switch_frame
;
2666 unread_switch_frame
= Qnil
;
2668 /* This event should make it into this_command_keys, and get echoed
2669 again, so we do not set `reread'. */
2673 /* if redisplay was requested */
2674 if (commandflag
>= 0)
2676 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2678 /* If there is pending input, process any events which are not
2679 user-visible, such as X selection_request events. */
2681 || detect_input_pending_run_timers (0))
2682 swallow_events (0); /* may clear input_pending */
2684 /* Redisplay if no pending input. */
2685 while (!input_pending
)
2687 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2688 redisplay_preserve_echo_area (5);
2693 /* Normal case: no input arrived during redisplay. */
2696 /* Input arrived and pre-empted redisplay.
2697 Process any events which are not user-visible. */
2699 /* If that cleared input_pending, try again to redisplay. */
2702 /* Prevent the redisplay we just did
2703 from messing up echoing of the input after the prompt. */
2704 if (commandflag
== 0 && echo_current
)
2705 echo_message_buffer
= echo_area_buffer
[0];
2709 /* Message turns off echoing unless more keystrokes turn it on again.
2711 The code in 20.x for the condition was
2713 1. echo_area_glyphs && *echo_area_glyphs
2714 2. && echo_area_glyphs != current_kboard->echobuf
2715 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2717 (1) means there's a current message displayed
2719 (2) means it's not the message from echoing from the current
2722 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2723 is set to a non-null value. This is done in read_char and it is
2724 set to echo_area_glyphs after a call to echo_char. That means
2725 ok_to_echo_at_next_pause is either null or
2726 current_kboard->echobuf with the appropriate current_kboard at
2729 So, condition (3) means in clear text ok_to_echo_at_next_pause
2730 must be either null, or the current message isn't from echoing at
2731 all, or it's from echoing from a different kboard than the
2734 if (/* There currently is something in the echo area. */
2735 !NILP (echo_area_buffer
[0])
2736 && (/* And it's either not from echoing. */
2737 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2738 /* Or it's an echo from a different kboard. */
2739 || echo_kboard
!= current_kboard
2740 /* Or we explicitly allow overwriting whatever there is. */
2741 || ok_to_echo_at_next_pause
== NULL
))
2746 /* Try reading a character via menu prompting in the minibuf.
2747 Try this before the sit-for, because the sit-for
2748 would do the wrong thing if we are supposed to do
2749 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2750 after a mouse event so don't try a minibuf menu. */
2752 if (nmaps
> 0 && INTERACTIVE
2753 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2754 /* Don't bring up a menu if we already have another event. */
2755 && NILP (Vunread_command_events
)
2756 && unread_command_char
< 0
2757 && !detect_input_pending_run_timers (0))
2759 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2761 if (INTEGERP (c
) && XINT (c
) == -2)
2762 return c
; /* wrong_kboard_jmpbuf */
2766 key_already_recorded
= 1;
2771 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2772 We will do that below, temporarily for short sections of code,
2773 when appropriate. local_getcjmp must be in effect
2774 around any call to sit_for or kbd_buffer_get_event;
2775 it *must not* be in effect when we call redisplay. */
2777 jmpcount
= SPECPDL_INDEX ();
2778 if (_setjmp (local_getcjmp
))
2780 /* Handle quits while reading the keyboard. */
2781 /* We must have saved the outer value of getcjmp here,
2782 so restore it now. */
2783 restore_getcjmp (save_jump
);
2784 unbind_to (jmpcount
, Qnil
);
2785 XSETINT (c
, quit_char
);
2786 internal_last_event_frame
= selected_frame
;
2787 Vlast_event_frame
= internal_last_event_frame
;
2788 /* If we report the quit char as an event,
2789 don't do so more than once. */
2790 if (!NILP (Vinhibit_quit
))
2795 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2796 if (kb
!= current_kboard
)
2798 Lisp_Object link
= kb
->kbd_queue
;
2799 /* We shouldn't get here if we were in single-kboard mode! */
2804 while (CONSP (XCDR (link
)))
2806 if (!NILP (XCDR (link
)))
2810 kb
->kbd_queue
= Fcons (c
, Qnil
);
2812 XSETCDR (link
, Fcons (c
, Qnil
));
2813 kb
->kbd_queue_has_data
= 1;
2814 current_kboard
= kb
;
2815 /* This is going to exit from read_char
2816 so we had better get rid of this frame's stuff. */
2818 return make_number (-2); /* wrong_kboard_jmpbuf */
2825 /* Start idle timers if no time limit is supplied. We don't do it
2826 if a time limit is supplied to avoid an infinite recursion in the
2827 situation where an idle timer calls `sit-for'. */
2830 timer_start_idle ();
2832 /* If in middle of key sequence and minibuffer not active,
2833 start echoing if enough time elapses. */
2835 if (minibuf_level
== 0
2837 && !current_kboard
->immediate_echo
2838 && this_command_key_count
> 0
2840 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2841 && NILP (Fzerop (Vecho_keystrokes
))
2842 && (/* No message. */
2843 NILP (echo_area_buffer
[0])
2844 /* Or empty message. */
2845 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2846 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2847 /* Or already echoing from same kboard. */
2848 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2849 /* Or not echoing before and echoing allowed. */
2850 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2852 /* After a mouse event, start echoing right away.
2853 This is because we are probably about to display a menu,
2854 and we don't want to delay before doing so. */
2855 if (EVENT_HAS_PARAMETERS (prev_event
))
2861 save_getcjmp (save_jump
);
2862 restore_getcjmp (local_getcjmp
);
2863 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2864 restore_getcjmp (save_jump
);
2866 && ! CONSP (Vunread_command_events
))
2871 /* Maybe auto save due to number of keystrokes. */
2873 if (commandflag
!= 0
2874 && auto_save_interval
> 0
2875 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2876 && !detect_input_pending_run_timers (0))
2878 Fdo_auto_save (Qnil
, Qnil
);
2879 /* Hooks can actually change some buffers in auto save. */
2883 /* Try reading using an X menu.
2884 This is never confused with reading using the minibuf
2885 because the recursive call of read_char in read_char_minibuf_menu_prompt
2886 does not pass on any keymaps. */
2888 if (nmaps
> 0 && INTERACTIVE
2889 && !NILP (prev_event
)
2890 && EVENT_HAS_PARAMETERS (prev_event
)
2891 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2892 && !EQ (XCAR (prev_event
), Qtool_bar
)
2893 /* Don't bring up a menu if we already have another event. */
2894 && NILP (Vunread_command_events
)
2895 && unread_command_char
< 0)
2897 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2899 /* Now that we have read an event, Emacs is not idle. */
2906 /* Maybe autosave and/or garbage collect due to idleness. */
2908 if (INTERACTIVE
&& NILP (c
))
2910 int delay_level
, buffer_size
;
2912 /* Slow down auto saves logarithmically in size of current buffer,
2913 and garbage collect while we're at it. */
2914 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2915 last_non_minibuf_size
= Z
- BEG
;
2916 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2918 while (buffer_size
> 64)
2919 delay_level
++, buffer_size
-= buffer_size
>> 2;
2920 if (delay_level
< 4) delay_level
= 4;
2921 /* delay_level is 4 for files under around 50k, 7 at 100k,
2922 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2924 /* Auto save if enough time goes by without input. */
2925 if (commandflag
!= 0
2926 && num_nonmacro_input_events
> last_auto_save
2927 && INTEGERP (Vauto_save_timeout
)
2928 && XINT (Vauto_save_timeout
) > 0)
2931 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2933 save_getcjmp (save_jump
);
2934 restore_getcjmp (local_getcjmp
);
2935 tem0
= sit_for (make_number (timeout
), 1, 1);
2936 restore_getcjmp (save_jump
);
2939 && ! CONSP (Vunread_command_events
))
2941 Fdo_auto_save (Qnil
, Qnil
);
2943 /* If we have auto-saved and there is still no input
2944 available, garbage collect if there has been enough
2945 consing going on to make it worthwhile. */
2946 if (!detect_input_pending_run_timers (0)
2947 && consing_since_gc
> gc_cons_threshold
/ 2)
2948 Fgarbage_collect ();
2955 /* Notify the caller if an autosave hook, or a timer, sentinel or
2956 filter in the sit_for calls above have changed the current
2957 kboard. This could happen if they use the minibuffer or start a
2958 recursive edit, like the fancy splash screen in server.el's
2959 filter. If this longjmp wasn't here, read_key_sequence would
2960 interpret the next key sequence using the wrong translation
2961 tables and function keymaps. */
2962 if (NILP (c
) && current_kboard
!= orig_kboard
)
2965 return make_number (-2); /* wrong_kboard_jmpbuf */
2968 /* If this has become non-nil here, it has been set by a timer
2969 or sentinel or filter. */
2970 if (CONSP (Vunread_command_events
))
2972 c
= XCAR (Vunread_command_events
);
2973 Vunread_command_events
= XCDR (Vunread_command_events
);
2976 /* Read something from current KBOARD's side queue, if possible. */
2980 if (current_kboard
->kbd_queue_has_data
)
2982 if (!CONSP (current_kboard
->kbd_queue
))
2984 c
= XCAR (current_kboard
->kbd_queue
);
2985 current_kboard
->kbd_queue
2986 = XCDR (current_kboard
->kbd_queue
);
2987 if (NILP (current_kboard
->kbd_queue
))
2988 current_kboard
->kbd_queue_has_data
= 0;
2989 input_pending
= readable_events (0);
2990 if (EVENT_HAS_PARAMETERS (c
)
2991 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2992 internal_last_event_frame
= XCAR (XCDR (c
));
2993 Vlast_event_frame
= internal_last_event_frame
;
2998 /* If current_kboard's side queue is empty check the other kboards.
2999 If one of them has data that we have not yet seen here,
3000 switch to it and process the data waiting for it.
3002 Note: if the events queued up for another kboard
3003 have already been seen here, and therefore are not a complete command,
3004 the kbd_queue_has_data field is 0, so we skip that kboard here.
3005 That's to avoid an infinite loop switching between kboards here. */
3006 if (NILP (c
) && !single_kboard
)
3009 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3010 if (kb
->kbd_queue_has_data
)
3012 current_kboard
= kb
;
3013 /* This is going to exit from read_char
3014 so we had better get rid of this frame's stuff. */
3016 return make_number (-2); /* wrong_kboard_jmpbuf */
3025 /* Finally, we read from the main queue,
3026 and if that gives us something we can't use yet, we put it on the
3027 appropriate side queue and try again. */
3036 EMACS_GET_TIME (now
);
3037 if (EMACS_TIME_GE (now
, *end_time
))
3041 /* Actually read a character, waiting if necessary. */
3042 save_getcjmp (save_jump
);
3043 restore_getcjmp (local_getcjmp
);
3045 timer_start_idle ();
3046 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
3047 restore_getcjmp (save_jump
);
3050 if (! NILP (c
) && (kb
!= current_kboard
))
3052 Lisp_Object link
= kb
->kbd_queue
;
3055 while (CONSP (XCDR (link
)))
3057 if (!NILP (XCDR (link
)))
3061 kb
->kbd_queue
= Fcons (c
, Qnil
);
3063 XSETCDR (link
, Fcons (c
, Qnil
));
3064 kb
->kbd_queue_has_data
= 1;
3068 current_kboard
= kb
;
3069 /* This is going to exit from read_char
3070 so we had better get rid of this frame's stuff. */
3072 return make_number (-2);
3077 /* Terminate Emacs in batch mode if at eof. */
3078 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
3079 Fkill_emacs (make_number (1));
3083 /* Add in any extra modifiers, where appropriate. */
3084 if ((extra_keyboard_modifiers
& CHAR_CTL
)
3085 || ((extra_keyboard_modifiers
& 0177) < ' '
3086 && (extra_keyboard_modifiers
& 0177) != 0))
3087 XSETINT (c
, make_ctrl_char (XINT (c
)));
3089 /* Transfer any other modifier bits directly from
3090 extra_keyboard_modifiers to c. Ignore the actual character code
3091 in the low 16 bits of extra_keyboard_modifiers. */
3092 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
3103 if (commandflag
>= 0
3104 && !input_pending
&& !detect_input_pending_run_timers (0))
3112 /* Buffer switch events are only for internal wakeups
3113 so don't show them to the user.
3114 Also, don't record a key if we already did. */
3115 if (BUFFERP (c
) || key_already_recorded
)
3118 /* Process special events within read_char
3119 and loop around to read another event. */
3122 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3127 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3128 int was_locked
= single_kboard
;
3129 int count
= SPECPDL_INDEX ();
3130 record_single_kboard_state ();
3133 last_input_char
= c
;
3134 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
3136 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3137 /* We stopped being idle for this event; undo that. This
3138 prevents automatic window selection (under
3139 mouse_autoselect_window from acting as a real input event, for
3140 example banishing the mouse under mouse-avoidance-mode. */
3141 timer_resume_idle ();
3143 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3144 /* Resume allowing input from any kboard, if that was true before. */
3146 any_kboard_state ();
3147 unbind_to (count
, Qnil
);
3153 /* Handle things that only apply to characters. */
3156 /* If kbd_buffer_get_event gave us an EOF, return that. */
3160 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3161 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3162 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3163 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3164 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3168 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3169 /* nil in keyboard-translate-table means no translation. */
3175 /* If this event is a mouse click in the menu bar,
3176 return just menu-bar for now. Modify the mouse click event
3177 so we won't do this twice, then queue it up. */
3178 if (EVENT_HAS_PARAMETERS (c
)
3180 && CONSP (EVENT_START (c
))
3181 && CONSP (XCDR (EVENT_START (c
))))
3185 posn
= POSN_POSN (EVENT_START (c
));
3186 /* Handle menu-bar events:
3187 insert the dummy prefix event `menu-bar'. */
3188 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3190 /* Change menu-bar to (menu-bar) as the event "position". */
3191 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3194 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3199 /* Store these characters into recent_keys, the dribble file if any,
3200 and the keyboard macro being defined, if any. */
3202 if (! NILP (also_record
))
3203 record_char (also_record
);
3205 /* Wipe the echo area.
3206 But first, if we are about to use an input method,
3207 save the echo area contents for it to refer to. */
3209 && ! NILP (Vinput_method_function
)
3210 && (unsigned) XINT (c
) >= ' '
3211 && (unsigned) XINT (c
) != 127
3212 && (unsigned) XINT (c
) < 256)
3214 previous_echo_area_message
= Fcurrent_message ();
3215 Vinput_method_previous_message
= previous_echo_area_message
;
3218 /* Now wipe the echo area, except for help events which do their
3219 own stuff with the echo area. */
3221 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3222 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3224 if (!NILP (echo_area_buffer
[0]))
3225 safe_run_hooks (Qecho_area_clear_hook
);
3226 clear_message (1, 0);
3229 reread_for_input_method
:
3231 /* Pass this to the input method, if appropriate. */
3233 && ! NILP (Vinput_method_function
)
3234 /* Don't run the input method within a key sequence,
3235 after the first event of the key sequence. */
3236 && NILP (prev_event
)
3237 && (unsigned) XINT (c
) >= ' '
3238 && (unsigned) XINT (c
) != 127
3239 && (unsigned) XINT (c
) < 256)
3242 int key_count
, key_count_reset
;
3243 struct gcpro gcpro1
;
3244 int count
= SPECPDL_INDEX ();
3246 /* Save the echo status. */
3247 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3248 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3249 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3250 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3253 if (before_command_restore_flag
)
3255 this_command_key_count
= before_command_key_count_1
;
3256 if (this_command_key_count
< this_single_command_key_start
)
3257 this_single_command_key_start
= this_command_key_count
;
3258 echo_truncate (before_command_echo_length_1
);
3259 before_command_restore_flag
= 0;
3263 /* Save the this_command_keys status. */
3264 key_count
= this_command_key_count
;
3265 key_count_reset
= this_command_key_count_reset
;
3268 keys
= Fcopy_sequence (this_command_keys
);
3273 /* Clear out this_command_keys. */
3274 this_command_key_count
= 0;
3275 this_command_key_count_reset
= 0;
3277 /* Now wipe the echo area. */
3278 if (!NILP (echo_area_buffer
[0]))
3279 safe_run_hooks (Qecho_area_clear_hook
);
3280 clear_message (1, 0);
3283 /* If we are not reading a key sequence,
3284 never use the echo area. */
3287 specbind (Qinput_method_use_echo_area
, Qt
);
3290 /* Call the input method. */
3291 tem
= call1 (Vinput_method_function
, c
);
3293 tem
= unbind_to (count
, tem
);
3295 /* Restore the saved echoing state
3296 and this_command_keys state. */
3297 this_command_key_count
= key_count
;
3298 this_command_key_count_reset
= key_count_reset
;
3300 this_command_keys
= keys
;
3303 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3304 current_kboard
->echo_string
= saved_echo_string
;
3305 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3306 if (saved_immediate_echo
)
3311 /* The input method can return no events. */
3314 /* Bring back the previous message, if any. */
3315 if (! NILP (previous_echo_area_message
))
3316 message_with_string ("%s", previous_echo_area_message
, 0);
3319 /* It returned one event or more. */
3321 Vunread_post_input_method_events
3322 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3327 /* Display help if not echoing. */
3328 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3330 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3331 Lisp_Object help
, object
, position
, window
, tem
;
3333 tem
= Fcdr (XCDR (c
));
3336 window
= Fcar (tem
);
3338 object
= Fcar (tem
);
3340 position
= Fcar (tem
);
3342 show_help_echo (help
, window
, object
, position
, 0);
3344 /* We stopped being idle for this event; undo that. */
3346 timer_resume_idle ();
3350 if ((! reread
|| this_command_key_count
== 0
3351 || this_command_key_count_reset
)
3355 /* Don't echo mouse motion events. */
3356 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3357 && NILP (Fzerop (Vecho_keystrokes
))
3358 && ! (EVENT_HAS_PARAMETERS (c
)
3359 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3362 if (! NILP (also_record
))
3363 echo_char (also_record
);
3364 /* Once we reread a character, echoing can happen
3365 the next time we pause to read a new one. */
3366 ok_to_echo_at_next_pause
= current_kboard
;
3369 /* Record this character as part of the current key. */
3370 add_command_key (c
);
3371 if (! NILP (also_record
))
3372 add_command_key (also_record
);
3375 last_input_char
= c
;
3378 /* Process the help character specially if enabled */
3379 if (!NILP (Vhelp_form
) && help_char_p (c
))
3382 count
= SPECPDL_INDEX ();
3384 help_form_saved_window_configs
3385 = Fcons (Fcurrent_window_configuration (Qnil
),
3386 help_form_saved_window_configs
);
3387 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3389 tem0
= Feval (Vhelp_form
);
3391 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3396 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3397 if (EVENT_HAS_PARAMETERS (c
)
3398 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3399 XSETCAR (help_form_saved_window_configs
, Qnil
);
3401 while (BUFFERP (c
));
3402 /* Remove the help from the frame */
3403 unbind_to (count
, Qnil
);
3406 if (EQ (c
, make_number (040)))
3410 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3411 while (BUFFERP (c
));
3420 /* Record a key that came from a mouse menu.
3421 Record it for echoing, for this-command-keys, and so on. */
3427 /* Wipe the echo area. */
3428 clear_message (1, 0);
3433 before_command_key_count
= this_command_key_count
;
3434 before_command_echo_length
= echo_length ();
3437 /* Don't echo mouse motion events. */
3438 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3439 && NILP (Fzerop (Vecho_keystrokes
)))
3443 /* Once we reread a character, echoing can happen
3444 the next time we pause to read a new one. */
3445 ok_to_echo_at_next_pause
= 0;
3448 /* Record this character as part of the current key. */
3449 add_command_key (c
);
3451 /* Re-reading in the middle of a command */
3452 last_input_char
= c
;
3456 /* Return 1 if should recognize C as "the help character". */
3464 if (EQ (c
, Vhelp_char
))
3466 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3467 if (EQ (c
, XCAR (tail
)))
3472 /* Record the input event C in various ways. */
3480 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3482 /* To avoid filling recent_keys with help-echo and mouse-movement
3483 events, we filter out repeated help-echo events, only store the
3484 first and last in a series of mouse-movement events, and don't
3485 store repeated help-echo events which are only separated by
3486 mouse-movement events. */
3488 Lisp_Object ev1
, ev2
, ev3
;
3491 if ((ix1
= recent_keys_index
- 1) < 0)
3492 ix1
= NUM_RECENT_KEYS
- 1;
3493 ev1
= AREF (recent_keys
, ix1
);
3495 if ((ix2
= ix1
- 1) < 0)
3496 ix2
= NUM_RECENT_KEYS
- 1;
3497 ev2
= AREF (recent_keys
, ix2
);
3499 if ((ix3
= ix2
- 1) < 0)
3500 ix3
= NUM_RECENT_KEYS
- 1;
3501 ev3
= AREF (recent_keys
, ix3
);
3503 if (EQ (XCAR (c
), Qhelp_echo
))
3505 /* Don't record `help-echo' in recent_keys unless it shows some help
3506 message, and a different help than the previously recorded
3508 Lisp_Object help
, last_help
;
3510 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3511 if (!STRINGP (help
))
3513 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3514 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3516 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3517 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3518 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3520 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3521 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3522 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3523 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3526 else if (EQ (XCAR (c
), Qmouse_movement
))
3528 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3529 So additional mouse movement events replace the last element. */
3530 Lisp_Object last_window
, window
;
3532 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3533 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3534 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3535 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3536 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3538 ASET (recent_keys
, ix1
, c
);
3544 store_kbd_macro_char (c
);
3549 ASET (recent_keys
, recent_keys_index
, c
);
3550 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3551 recent_keys_index
= 0;
3553 else if (recorded
< 0)
3555 /* We need to remove one or two events from recent_keys.
3556 To do this, we simply put nil at those events and move the
3557 recent_keys_index backwards over those events. Usually,
3558 users will never see those nil events, as they will be
3559 overwritten by the command keys entered to see recent_keys
3562 while (recorded
++ < 0 && total_keys
> 0)
3564 if (total_keys
< NUM_RECENT_KEYS
)
3566 if (--recent_keys_index
< 0)
3567 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3568 ASET (recent_keys
, recent_keys_index
, Qnil
);
3572 num_nonmacro_input_events
++;
3574 /* Write c to the dribble file. If c is a lispy event, write
3575 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3576 If you, dear reader, have a better idea, you've got the source. :-) */
3582 if (XUINT (c
) < 0x100)
3583 putc (XINT (c
), dribble
);
3585 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3589 Lisp_Object dribblee
;
3591 /* If it's a structured event, take the event header. */
3592 dribblee
= EVENT_HEAD (c
);
3594 if (SYMBOLP (dribblee
))
3596 putc ('<', dribble
);
3597 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3598 SBYTES (SYMBOL_NAME (dribblee
)),
3600 putc ('>', dribble
);
3613 struct buffer
*old
= current_buffer
;
3614 Fprinc (object
, Qnil
);
3615 set_buffer_internal (XBUFFER (Vstandard_output
));
3616 call0 (intern ("help-mode"));
3617 set_buffer_internal (old
);
3621 /* Copy out or in the info on where C-g should throw to.
3622 This is used when running Lisp code from within get_char,
3623 in case get_char is called recursively.
3624 See read_process_output. */
3630 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3634 restore_getcjmp (temp
)
3637 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3640 /* Low level keyboard/mouse input.
3641 kbd_buffer_store_event places events in kbd_buffer, and
3642 kbd_buffer_get_event retrieves them. */
3644 /* Return true if there are any events in the queue that read-char
3645 would return. If this returns false, a read-char would block. */
3647 readable_events (flags
)
3650 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3653 /* If the buffer contains only FOCUS_IN_EVENT events, and
3654 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3655 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3657 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3658 #ifdef USE_TOOLKIT_SCROLL_BARS
3659 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3663 struct input_event
*event
;
3665 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3672 #ifdef USE_TOOLKIT_SCROLL_BARS
3673 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3675 event
->kind
== FOCUS_IN_EVENT
)
3676 #ifdef USE_TOOLKIT_SCROLL_BARS
3677 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3678 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3679 && event
->part
== scroll_bar_handle
3680 && event
->modifiers
== 0)
3685 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3688 while (event
!= kbd_store_ptr
);
3694 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3695 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3696 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3701 if (current_kboard
->kbd_queue_has_data
)
3707 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3708 if (kb
->kbd_queue_has_data
)
3714 /* Set this for debugging, to have a way to get out */
3719 event_to_kboard (event
)
3720 struct input_event
*event
;
3723 frame
= event
->frame_or_window
;
3725 frame
= XCAR (frame
);
3726 else if (WINDOWP (frame
))
3727 frame
= WINDOW_FRAME (XWINDOW (frame
));
3729 /* There are still some events that don't set this field.
3730 For now, just ignore the problem.
3731 Also ignore dead frames here. */
3732 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3735 return FRAME_KBOARD (XFRAME (frame
));
3740 Lisp_Object Vthrow_on_input
;
3742 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3745 kbd_buffer_store_event (event
)
3746 register struct input_event
*event
;
3748 kbd_buffer_store_event_hold (event
, 0);
3751 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3753 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3754 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3755 Else, if EVENT is a quit event, store the quit event
3756 in HOLD_QUIT, and return (thus ignoring further events).
3758 This is used in read_avail_input to postpone the processing
3759 of the quit event until all subsequent input events have been
3760 parsed (and discarded).
3764 kbd_buffer_store_event_hold (event
, hold_quit
)
3765 register struct input_event
*event
;
3766 struct input_event
*hold_quit
;
3768 if (event
->kind
== NO_EVENT
)
3771 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3774 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3776 register int c
= event
->code
& 0377;
3778 if (event
->modifiers
& ctrl_modifier
)
3779 c
= make_ctrl_char (c
);
3781 c
|= (event
->modifiers
3782 & (meta_modifier
| alt_modifier
3783 | hyper_modifier
| super_modifier
));
3788 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3789 struct input_event
*sp
;
3791 if (single_kboard
&& kb
!= current_kboard
)
3794 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3795 Fcons (make_number (c
), Qnil
));
3796 kb
->kbd_queue_has_data
= 1;
3797 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3799 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3802 if (event_to_kboard (sp
) == kb
)
3804 sp
->kind
= NO_EVENT
;
3805 sp
->frame_or_window
= Qnil
;
3815 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3819 /* If this results in a quit_char being returned to Emacs as
3820 input, set Vlast_event_frame properly. If this doesn't
3821 get returned to Emacs as an event, the next event read
3822 will set Vlast_event_frame again, so this is safe to do. */
3826 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3828 focus
= event
->frame_or_window
;
3829 internal_last_event_frame
= focus
;
3830 Vlast_event_frame
= focus
;
3833 last_event_timestamp
= event
->timestamp
;
3834 handle_interrupt ();
3838 if (c
&& c
== stop_character
)
3844 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3845 Just ignore the second one. */
3846 else if (event
->kind
== BUFFER_SWITCH_EVENT
3847 && kbd_fetch_ptr
!= kbd_store_ptr
3848 && ((kbd_store_ptr
== kbd_buffer
3849 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3850 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3853 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3854 kbd_store_ptr
= kbd_buffer
;
3856 /* Don't let the very last slot in the buffer become full,
3857 since that would make the two pointers equal,
3858 and that is indistinguishable from an empty buffer.
3859 Discard the event if it would fill the last slot. */
3860 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3862 *kbd_store_ptr
= *event
;
3866 /* If we're inside while-no-input, and this event qualifies
3867 as input, set quit-flag to cause an interrupt. */
3868 if (!NILP (Vthrow_on_input
)
3869 && event
->kind
!= FOCUS_IN_EVENT
3870 && event
->kind
!= HELP_EVENT
3871 && event
->kind
!= DEICONIFY_EVENT
)
3873 Vquit_flag
= Vthrow_on_input
;
3874 /* If we're inside a function that wants immediate quits,
3876 if (immediate_quit
&& NILP (Vinhibit_quit
))
3886 /* Put an input event back in the head of the event queue. */
3889 kbd_buffer_unget_event (event
)
3890 register struct input_event
*event
;
3892 if (kbd_fetch_ptr
== kbd_buffer
)
3893 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3895 /* Don't let the very last slot in the buffer become full, */
3896 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3899 *kbd_fetch_ptr
= *event
;
3904 /* Generate HELP_EVENT input_events in BUFP which has room for
3905 SIZE events. If there's not enough room in BUFP, ignore this
3908 HELP is the help form.
3910 FRAME is the frame on which the help is generated. OBJECT is the
3911 Lisp object where the help was found (a buffer, a string, an
3912 overlay, or nil if neither from a string nor from a buffer. POS is
3913 the position within OBJECT where the help was found.
3915 Value is the number of input_events generated. */
3918 gen_help_event (help
, frame
, window
, object
, pos
)
3919 Lisp_Object help
, frame
, object
, window
;
3922 struct input_event event
;
3926 event
.kind
= HELP_EVENT
;
3927 event
.frame_or_window
= frame
;
3929 event
.x
= WINDOWP (window
) ? window
: frame
;
3932 kbd_buffer_store_event (&event
);
3936 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3939 kbd_buffer_store_help_event (frame
, help
)
3940 Lisp_Object frame
, help
;
3942 struct input_event event
;
3944 event
.kind
= HELP_EVENT
;
3945 event
.frame_or_window
= frame
;
3950 kbd_buffer_store_event (&event
);
3954 /* Discard any mouse events in the event buffer by setting them to
3957 discard_mouse_events ()
3959 struct input_event
*sp
;
3960 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3962 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3965 if (sp
->kind
== MOUSE_CLICK_EVENT
3966 || sp
->kind
== WHEEL_EVENT
3967 || sp
->kind
== HORIZ_WHEEL_EVENT
3969 || sp
->kind
== GPM_CLICK_EVENT
3971 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3973 sp
->kind
= NO_EVENT
;
3979 /* Return non-zero if there are any real events waiting in the event
3980 buffer, not counting `NO_EVENT's.
3982 If DISCARD is non-zero, discard NO_EVENT events at the front of
3983 the input queue, possibly leaving the input queue empty if there
3984 are no real input events. */
3987 kbd_buffer_events_waiting (discard
)
3990 struct input_event
*sp
;
3992 for (sp
= kbd_fetch_ptr
;
3993 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3996 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4003 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
4007 /* Clear input event EVENT. */
4011 struct input_event
*event
;
4013 event
->kind
= NO_EVENT
;
4017 /* Read one event from the event buffer, waiting if necessary.
4018 The value is a Lisp object representing the event.
4019 The value is nil for an event that should be ignored,
4020 or that was handled here.
4021 We always read and discard one event. */
4024 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
4026 int *used_mouse_menu
;
4027 EMACS_TIME
*end_time
;
4036 *kbp
= current_kboard
;
4040 /* Wait until there is input available. */
4043 /* Break loop if there's an unread command event. Needed in
4044 moused window autoselection which uses a timer to insert such
4046 if (CONSP (Vunread_command_events
))
4049 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4051 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4052 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4056 /* If the quit flag is set, then read_char will return
4057 quit_char, so that counts as "available input." */
4058 if (!NILP (Vquit_flag
))
4059 quit_throw_to_read_char ();
4061 /* One way or another, wait until input is available; then, if
4062 interrupt handlers have not read it, read it now. */
4065 wait_for_kbd_input ();
4067 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4071 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4073 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4074 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4079 EMACS_TIME duration
;
4080 EMACS_GET_TIME (duration
);
4081 if (EMACS_TIME_GE (duration
, *end_time
))
4082 return Qnil
; /* finished waiting */
4085 EMACS_SUB_TIME (duration
, *end_time
, duration
);
4086 wait_reading_process_output (EMACS_SECS (duration
),
4087 EMACS_USECS (duration
),
4088 -1, 1, Qnil
, NULL
, 0);
4092 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
4094 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
4095 /* Pass 1 for EXPECT since we just waited to have input. */
4096 read_avail_input (1);
4097 #endif /* not VMS */
4100 if (CONSP (Vunread_command_events
))
4103 first
= XCAR (Vunread_command_events
);
4104 Vunread_command_events
= XCDR (Vunread_command_events
);
4105 *kbp
= current_kboard
;
4109 /* At this point, we know that there is a readable event available
4110 somewhere. If the event queue is empty, then there must be a
4111 mouse movement enabled and available. */
4112 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4114 struct input_event
*event
;
4116 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4120 last_event_timestamp
= event
->timestamp
;
4123 *kbp
= event_to_kboard (event
);
4125 *kbp
= current_kboard
; /* Better than returning null ptr? */
4127 *kbp
= &the_only_kboard
;
4132 /* These two kinds of events get special handling
4133 and don't actually appear to the command loop.
4134 We return nil for them. */
4135 if (event
->kind
== SELECTION_REQUEST_EVENT
4136 || event
->kind
== SELECTION_CLEAR_EVENT
)
4139 struct input_event copy
;
4141 /* Remove it from the buffer before processing it,
4142 since otherwise swallow_events will see it
4143 and process it again. */
4145 kbd_fetch_ptr
= event
+ 1;
4146 input_pending
= readable_events (0);
4147 x_handle_selection_event (©
);
4149 /* We're getting selection request events, but we don't have
4155 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4156 || defined (HAVE_NS)
4157 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4159 /* Make an event (delete-frame (FRAME)). */
4160 obj
= Fcons (event
->frame_or_window
, Qnil
);
4161 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4162 kbd_fetch_ptr
= event
+ 1;
4165 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4166 || defined (HAVE_NS)
4167 else if (event
->kind
== ICONIFY_EVENT
)
4169 /* Make an event (iconify-frame (FRAME)). */
4170 obj
= Fcons (event
->frame_or_window
, Qnil
);
4171 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4172 kbd_fetch_ptr
= event
+ 1;
4174 else if (event
->kind
== DEICONIFY_EVENT
)
4176 /* Make an event (make-frame-visible (FRAME)). */
4177 obj
= Fcons (event
->frame_or_window
, Qnil
);
4178 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4179 kbd_fetch_ptr
= event
+ 1;
4182 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4184 /* The value doesn't matter here; only the type is tested. */
4185 XSETBUFFER (obj
, current_buffer
);
4186 kbd_fetch_ptr
= event
+ 1;
4188 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4189 || defined(HAVE_NS) || defined (USE_GTK)
4190 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4192 kbd_fetch_ptr
= event
+ 1;
4193 input_pending
= readable_events (0);
4194 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4195 x_activate_menubar (XFRAME (event
->frame_or_window
));
4198 #if defined (WINDOWSNT) || defined (MAC_OS)
4199 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4202 /* Make an event (language-change (KEY_SCRIPT)). */
4203 obj
= Fcons (make_number (event
->code
), Qnil
);
4205 /* Make an event (language-change (FRAME CHARSET LCID)). */
4206 obj
= Fcons (event
->frame_or_window
, Qnil
);
4208 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4209 kbd_fetch_ptr
= event
+ 1;
4212 else if (event
->kind
== SAVE_SESSION_EVENT
)
4214 obj
= Fcons (Qsave_session
, Qnil
);
4215 kbd_fetch_ptr
= event
+ 1;
4217 /* Just discard these, by returning nil.
4218 With MULTI_KBOARD, these events are used as placeholders
4219 when we need to randomly delete events from the queue.
4220 (They shouldn't otherwise be found in the buffer,
4221 but on some machines it appears they do show up
4222 even without MULTI_KBOARD.) */
4223 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4224 mouse events during a popup-menu call. */
4225 else if (event
->kind
== NO_EVENT
)
4226 kbd_fetch_ptr
= event
+ 1;
4227 else if (event
->kind
== HELP_EVENT
)
4229 Lisp_Object object
, position
, help
, frame
, window
;
4231 frame
= event
->frame_or_window
;
4232 object
= event
->arg
;
4233 position
= make_number (event
->code
);
4236 clear_event (event
);
4238 kbd_fetch_ptr
= event
+ 1;
4239 if (!WINDOWP (window
))
4241 obj
= Fcons (Qhelp_echo
,
4242 list5 (frame
, help
, window
, object
, position
));
4244 else if (event
->kind
== FOCUS_IN_EVENT
)
4246 /* Notification of a FocusIn event. The frame receiving the
4247 focus is in event->frame_or_window. Generate a
4248 switch-frame event if necessary. */
4249 Lisp_Object frame
, focus
;
4251 frame
= event
->frame_or_window
;
4252 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4256 if (!EQ (frame
, internal_last_event_frame
)
4257 && !EQ (frame
, selected_frame
))
4258 obj
= make_lispy_switch_frame (frame
);
4259 internal_last_event_frame
= frame
;
4260 kbd_fetch_ptr
= event
+ 1;
4263 else if (event
->kind
== DBUS_EVENT
)
4265 obj
= make_lispy_event (event
);
4266 kbd_fetch_ptr
= event
+ 1;
4271 /* If this event is on a different frame, return a switch-frame this
4272 time, and leave the event in the queue for next time. */
4276 frame
= event
->frame_or_window
;
4278 frame
= XCAR (frame
);
4279 else if (WINDOWP (frame
))
4280 frame
= WINDOW_FRAME (XWINDOW (frame
));
4282 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4286 if (! EQ (frame
, internal_last_event_frame
)
4287 && !EQ (frame
, selected_frame
))
4288 obj
= make_lispy_switch_frame (frame
);
4289 internal_last_event_frame
= frame
;
4291 /* If we didn't decide to make a switch-frame event, go ahead
4292 and build a real event from the queue entry. */
4296 obj
= make_lispy_event (event
);
4298 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4299 || defined(HAVE_NS) || defined (USE_GTK)
4300 /* If this was a menu selection, then set the flag to inhibit
4301 writing to last_nonmenu_event. Don't do this if the event
4302 we're returning is (menu-bar), though; that indicates the
4303 beginning of the menu sequence, and we might as well leave
4304 that as the `event with parameters' for this selection. */
4306 && !EQ (event
->frame_or_window
, event
->arg
)
4307 && (event
->kind
== MENU_BAR_EVENT
4308 || event
->kind
== TOOL_BAR_EVENT
))
4309 *used_mouse_menu
= 1;
4312 /* Wipe out this event, to catch bugs. */
4313 clear_event (event
);
4314 kbd_fetch_ptr
= event
+ 1;
4318 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4319 /* Try generating a mouse motion event. */
4320 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4322 FRAME_PTR f
= some_mouse_moved ();
4323 Lisp_Object bar_window
;
4324 enum scroll_bar_part part
;
4328 *kbp
= current_kboard
;
4329 /* Note that this uses F to determine which terminal to look at.
4330 If there is no valid info, it does not store anything
4331 so x remains nil. */
4334 /* XXX Can f or mouse_position_hook be NULL here? */
4335 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4336 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4337 &part
, &x
, &y
, &time
);
4341 /* Decide if we should generate a switch-frame event. Don't
4342 generate switch-frame events for motion outside of all Emacs
4348 frame
= FRAME_FOCUS_FRAME (f
);
4350 XSETFRAME (frame
, f
);
4352 if (! EQ (frame
, internal_last_event_frame
)
4353 && !EQ (frame
, selected_frame
))
4354 obj
= make_lispy_switch_frame (frame
);
4355 internal_last_event_frame
= frame
;
4358 /* If we didn't decide to make a switch-frame event, go ahead and
4359 return a mouse-motion event. */
4360 if (!NILP (x
) && NILP (obj
))
4361 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4363 #endif /* HAVE_MOUSE || HAVE GPM */
4365 /* We were promised by the above while loop that there was
4366 something for us to read! */
4369 input_pending
= readable_events (0);
4371 Vlast_event_frame
= internal_last_event_frame
;
4376 /* Process any events that are not user-visible,
4377 then return, without reading any user-visible events. */
4380 swallow_events (do_display
)
4385 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4387 struct input_event
*event
;
4389 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4393 last_event_timestamp
= event
->timestamp
;
4395 /* These two kinds of events get special handling
4396 and don't actually appear to the command loop. */
4397 if (event
->kind
== SELECTION_REQUEST_EVENT
4398 || event
->kind
== SELECTION_CLEAR_EVENT
)
4401 struct input_event copy
;
4403 /* Remove it from the buffer before processing it,
4404 since otherwise swallow_events called recursively could see it
4405 and process it again. */
4407 kbd_fetch_ptr
= event
+ 1;
4408 input_pending
= readable_events (0);
4409 x_handle_selection_event (©
);
4411 /* We're getting selection request events, but we don't have
4420 old_timers_run
= timers_run
;
4421 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4423 if (timers_run
!= old_timers_run
&& do_display
)
4424 redisplay_preserve_echo_area (7);
4427 /* Record the start of when Emacs is idle,
4428 for the sake of running idle-time timers. */
4435 /* If we are already in the idle state, do nothing. */
4436 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4439 EMACS_GET_TIME (timer_idleness_start_time
);
4441 timer_last_idleness_start_time
= timer_idleness_start_time
;
4443 /* Mark all idle-time timers as once again candidates for running. */
4444 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4448 timer
= XCAR (timers
);
4450 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4452 XVECTOR (timer
)->contents
[0] = Qnil
;
4456 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4461 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4464 /* Resume idle timer from last idle start time. */
4467 timer_resume_idle ()
4469 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4472 timer_idleness_start_time
= timer_last_idleness_start_time
;
4475 /* This is only for debugging. */
4476 struct input_event last_timer_event
;
4478 /* List of elisp functions to call, delayed because they were generated in
4479 a context where Elisp could not be safely run (e.g. redisplay, signal,
4480 ...). Each lement has the form (FUN . ARGS). */
4481 Lisp_Object pending_funcalls
;
4483 extern Lisp_Object Qapply
;
4485 /* Check whether a timer has fired. To prevent larger problems we simply
4486 disregard elements that are not proper timers. Do not make a circular
4487 timer list for the time being.
4489 Returns the number of seconds to wait until the next timer fires. If a
4490 timer is triggering now, return zero seconds.
4491 If no timer is active, return -1 seconds.
4493 If a timer is ripe, we run it, with quitting turned off.
4495 DO_IT_NOW is now ignored. It used to mean that we should
4496 run the timer directly instead of queueing a timer-event.
4497 Now we always run timers directly. */
4500 timer_check (do_it_now
)
4503 EMACS_TIME nexttime
;
4504 EMACS_TIME now
, idleness_now
;
4505 Lisp_Object timers
, idle_timers
, chosen_timer
;
4506 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4508 EMACS_SET_SECS (nexttime
, -1);
4509 EMACS_SET_USECS (nexttime
, -1);
4511 /* Always consider the ordinary timers. */
4512 timers
= Vtimer_list
;
4513 /* Consider the idle timers only if Emacs is idle. */
4514 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4515 idle_timers
= Vtimer_idle_list
;
4518 chosen_timer
= Qnil
;
4519 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4521 /* First run the code that was delayed. */
4522 while (CONSP (pending_funcalls
))
4524 Lisp_Object funcall
= XCAR (pending_funcalls
);
4525 pending_funcalls
= XCDR (pending_funcalls
);
4526 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4529 if (CONSP (timers
) || CONSP (idle_timers
))
4531 EMACS_GET_TIME (now
);
4532 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4533 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4536 while (CONSP (timers
) || CONSP (idle_timers
))
4538 Lisp_Object
*vector
;
4539 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4540 EMACS_TIME timer_time
, idle_timer_time
;
4541 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4543 /* Skip past invalid timers and timers already handled. */
4546 timer
= XCAR (timers
);
4547 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4549 timers
= XCDR (timers
);
4552 vector
= XVECTOR (timer
)->contents
;
4554 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4555 || !INTEGERP (vector
[3])
4556 || ! NILP (vector
[0]))
4558 timers
= XCDR (timers
);
4562 if (!NILP (idle_timers
))
4564 timer
= XCAR (idle_timers
);
4565 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4567 idle_timers
= XCDR (idle_timers
);
4570 vector
= XVECTOR (timer
)->contents
;
4572 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4573 || !INTEGERP (vector
[3])
4574 || ! NILP (vector
[0]))
4576 idle_timers
= XCDR (idle_timers
);
4581 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4582 based on the next ordinary timer.
4583 TIMER_DIFFERENCE is the distance in time from NOW to when
4584 this timer becomes ripe (negative if it's already ripe). */
4587 timer
= XCAR (timers
);
4588 vector
= XVECTOR (timer
)->contents
;
4589 EMACS_SET_SECS (timer_time
,
4590 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4591 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4592 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4595 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4596 based on the next idle timer. */
4597 if (!NILP (idle_timers
))
4599 idle_timer
= XCAR (idle_timers
);
4600 vector
= XVECTOR (idle_timer
)->contents
;
4601 EMACS_SET_SECS (idle_timer_time
,
4602 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4603 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4604 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4607 /* Decide which timer is the next timer,
4608 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4609 Also step down the list where we found that timer. */
4611 if (! NILP (timers
) && ! NILP (idle_timers
))
4614 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4615 if (EMACS_TIME_NEG_P (temp
))
4617 chosen_timer
= timer
;
4618 timers
= XCDR (timers
);
4619 difference
= timer_difference
;
4623 chosen_timer
= idle_timer
;
4624 idle_timers
= XCDR (idle_timers
);
4625 difference
= idle_timer_difference
;
4628 else if (! NILP (timers
))
4630 chosen_timer
= timer
;
4631 timers
= XCDR (timers
);
4632 difference
= timer_difference
;
4636 chosen_timer
= idle_timer
;
4637 idle_timers
= XCDR (idle_timers
);
4638 difference
= idle_timer_difference
;
4640 vector
= XVECTOR (chosen_timer
)->contents
;
4642 /* If timer is ripe, run it if it hasn't been run. */
4643 if (EMACS_TIME_NEG_P (difference
)
4644 || (EMACS_SECS (difference
) == 0
4645 && EMACS_USECS (difference
) == 0))
4647 if (NILP (vector
[0]))
4649 int count
= SPECPDL_INDEX ();
4650 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4652 #if 0 /* This shouldn't be necessary anymore. --lorentey */
4653 /* On unbind_to, resume allowing input from any kboard, if that
4655 record_single_kboard_state ();
4657 /* Mark the timer as triggered to prevent problems if the lisp
4658 code fails to reschedule it right. */
4661 specbind (Qinhibit_quit
, Qt
);
4663 call1 (Qtimer_event_handler
, chosen_timer
);
4664 Vdeactivate_mark
= old_deactivate_mark
;
4666 unbind_to (count
, Qnil
);
4668 /* Since we have handled the event,
4669 we don't need to tell the caller to wake up and do it. */
4673 /* When we encounter a timer that is still waiting,
4674 return the amount of time to wait before it is ripe. */
4681 /* No timers are pending in the future. */
4682 /* Return 0 if we generated an event, and -1 if not. */
4687 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4688 doc
: /* Return the current length of Emacs idleness, or nil.
4689 The value when Emacs is idle is a list of three integers. The first has the
4690 most significant 16 bits of the seconds, while the second has the
4691 least significant 16 bits. The third integer gives the microsecond
4694 The value when Emacs is not idle is nil.
4696 The microsecond count is zero on systems that do not provide
4697 resolution finer than a second. */)
4700 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4702 EMACS_TIME now
, idleness_now
;
4704 EMACS_GET_TIME (now
);
4705 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4707 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4708 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4709 make_number (EMACS_USECS (idleness_now
)));
4715 /* Caches for modify_event_symbol. */
4716 static Lisp_Object accent_key_syms
;
4717 static Lisp_Object func_key_syms
;
4718 static Lisp_Object mouse_syms
;
4719 static Lisp_Object wheel_syms
;
4720 static Lisp_Object drag_n_drop_syms
;
4722 /* This is a list of keysym codes for special "accent" characters.
4723 It parallels lispy_accent_keys. */
4725 static int lispy_accent_codes
[] =
4727 #ifdef XK_dead_circumflex
4732 #ifdef XK_dead_grave
4737 #ifdef XK_dead_tilde
4742 #ifdef XK_dead_diaeresis
4747 #ifdef XK_dead_macron
4752 #ifdef XK_dead_degree
4757 #ifdef XK_dead_acute
4762 #ifdef XK_dead_cedilla
4767 #ifdef XK_dead_breve
4772 #ifdef XK_dead_ogonek
4777 #ifdef XK_dead_caron
4782 #ifdef XK_dead_doubleacute
4783 XK_dead_doubleacute
,
4787 #ifdef XK_dead_abovedot
4792 #ifdef XK_dead_abovering
4802 #ifdef XK_dead_belowdot
4807 #ifdef XK_dead_voiced_sound
4808 XK_dead_voiced_sound
,
4812 #ifdef XK_dead_semivoiced_sound
4813 XK_dead_semivoiced_sound
,
4829 /* This is a list of Lisp names for special "accent" characters.
4830 It parallels lispy_accent_codes. */
4832 static char *lispy_accent_keys
[] =
4850 "dead-voiced-sound",
4851 "dead-semivoiced-sound",
4857 #define FUNCTION_KEY_OFFSET 0x0
4859 char *lispy_function_keys
[] =
4863 0, /* VK_LBUTTON 0x01 */
4864 0, /* VK_RBUTTON 0x02 */
4865 "cancel", /* VK_CANCEL 0x03 */
4866 0, /* VK_MBUTTON 0x04 */
4868 0, 0, 0, /* 0x05 .. 0x07 */
4870 "backspace", /* VK_BACK 0x08 */
4871 "tab", /* VK_TAB 0x09 */
4873 0, 0, /* 0x0A .. 0x0B */
4875 "clear", /* VK_CLEAR 0x0C */
4876 "return", /* VK_RETURN 0x0D */
4878 0, 0, /* 0x0E .. 0x0F */
4880 0, /* VK_SHIFT 0x10 */
4881 0, /* VK_CONTROL 0x11 */
4882 0, /* VK_MENU 0x12 */
4883 "pause", /* VK_PAUSE 0x13 */
4884 "capslock", /* VK_CAPITAL 0x14 */
4885 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4887 "junja", /* VK_JUNJA 0x17 */
4888 "final", /* VK_FINAL 0x18 */
4889 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4891 "escape", /* VK_ESCAPE 0x1B */
4892 "convert", /* VK_CONVERT 0x1C */
4893 "non-convert", /* VK_NONCONVERT 0x1D */
4894 "accept", /* VK_ACCEPT 0x1E */
4895 "mode-change", /* VK_MODECHANGE 0x1F */
4896 0, /* VK_SPACE 0x20 */
4897 "prior", /* VK_PRIOR 0x21 */
4898 "next", /* VK_NEXT 0x22 */
4899 "end", /* VK_END 0x23 */
4900 "home", /* VK_HOME 0x24 */
4901 "left", /* VK_LEFT 0x25 */
4902 "up", /* VK_UP 0x26 */
4903 "right", /* VK_RIGHT 0x27 */
4904 "down", /* VK_DOWN 0x28 */
4905 "select", /* VK_SELECT 0x29 */
4906 "print", /* VK_PRINT 0x2A */
4907 "execute", /* VK_EXECUTE 0x2B */
4908 "snapshot", /* VK_SNAPSHOT 0x2C */
4909 "insert", /* VK_INSERT 0x2D */
4910 "delete", /* VK_DELETE 0x2E */
4911 "help", /* VK_HELP 0x2F */
4913 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4915 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4917 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4919 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4921 0, 0, 0, 0, 0, 0, 0, 0, 0,
4922 0, 0, 0, 0, 0, 0, 0, 0, 0,
4923 0, 0, 0, 0, 0, 0, 0, 0,
4925 "lwindow", /* VK_LWIN 0x5B */
4926 "rwindow", /* VK_RWIN 0x5C */
4927 "apps", /* VK_APPS 0x5D */
4930 "kp-0", /* VK_NUMPAD0 0x60 */
4931 "kp-1", /* VK_NUMPAD1 0x61 */
4932 "kp-2", /* VK_NUMPAD2 0x62 */
4933 "kp-3", /* VK_NUMPAD3 0x63 */
4934 "kp-4", /* VK_NUMPAD4 0x64 */
4935 "kp-5", /* VK_NUMPAD5 0x65 */
4936 "kp-6", /* VK_NUMPAD6 0x66 */
4937 "kp-7", /* VK_NUMPAD7 0x67 */
4938 "kp-8", /* VK_NUMPAD8 0x68 */
4939 "kp-9", /* VK_NUMPAD9 0x69 */
4940 "kp-multiply", /* VK_MULTIPLY 0x6A */
4941 "kp-add", /* VK_ADD 0x6B */
4942 "kp-separator", /* VK_SEPARATOR 0x6C */
4943 "kp-subtract", /* VK_SUBTRACT 0x6D */
4944 "kp-decimal", /* VK_DECIMAL 0x6E */
4945 "kp-divide", /* VK_DIVIDE 0x6F */
4946 "f1", /* VK_F1 0x70 */
4947 "f2", /* VK_F2 0x71 */
4948 "f3", /* VK_F3 0x72 */
4949 "f4", /* VK_F4 0x73 */
4950 "f5", /* VK_F5 0x74 */
4951 "f6", /* VK_F6 0x75 */
4952 "f7", /* VK_F7 0x76 */
4953 "f8", /* VK_F8 0x77 */
4954 "f9", /* VK_F9 0x78 */
4955 "f10", /* VK_F10 0x79 */
4956 "f11", /* VK_F11 0x7A */
4957 "f12", /* VK_F12 0x7B */
4958 "f13", /* VK_F13 0x7C */
4959 "f14", /* VK_F14 0x7D */
4960 "f15", /* VK_F15 0x7E */
4961 "f16", /* VK_F16 0x7F */
4962 "f17", /* VK_F17 0x80 */
4963 "f18", /* VK_F18 0x81 */
4964 "f19", /* VK_F19 0x82 */
4965 "f20", /* VK_F20 0x83 */
4966 "f21", /* VK_F21 0x84 */
4967 "f22", /* VK_F22 0x85 */
4968 "f23", /* VK_F23 0x86 */
4969 "f24", /* VK_F24 0x87 */
4971 0, 0, 0, 0, /* 0x88 .. 0x8B */
4972 0, 0, 0, 0, /* 0x8C .. 0x8F */
4974 "kp-numlock", /* VK_NUMLOCK 0x90 */
4975 "scroll", /* VK_SCROLL 0x91 */
4976 /* Not sure where the following block comes from.
4977 Windows headers have NEC and Fujitsu specific keys in
4978 this block, but nothing generic. */
4979 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4980 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4981 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4982 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4983 "kp-end", /* VK_NUMPAD_END 0x96 */
4984 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4985 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4986 "kp-up", /* VK_NUMPAD_UP 0x99 */
4987 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4988 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4989 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4990 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4992 0, 0, /* 0x9E .. 0x9F */
4995 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4996 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4997 * No other API or message will distinguish left and right keys this way.
5002 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
5003 to enable them selectively, and gives access to a few more functions.
5004 See lispy_multimedia_keys below. */
5005 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
5006 0, 0, 0, /* 0xAD .. 0xAF Volume */
5007 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
5008 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
5010 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
5011 0, 0, 0, 0, 0, 0, 0, 0, 0,
5013 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
5014 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5015 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5018 "ax", /* VK_OEM_AX 0xE1 */
5019 0, /* VK_OEM_102 0xE2 */
5020 "ico-help", /* VK_ICO_HELP 0xE3 */
5021 "ico-00", /* VK_ICO_00 0xE4 */
5022 0, /* VK_PROCESSKEY 0xE5 */
5023 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
5024 "packet", /* VK_PACKET 0xE7 */
5026 "reset", /* VK_OEM_RESET 0xE9 */
5027 "jump", /* VK_OEM_JUMP 0xEA */
5028 "oem-pa1", /* VK_OEM_PA1 0xEB */
5029 "oem-pa2", /* VK_OEM_PA2 0xEC */
5030 "oem-pa3", /* VK_OEM_PA3 0xED */
5031 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
5032 "cusel", /* VK_OEM_CUSEL 0xEF */
5033 "oem-attn", /* VK_OEM_ATTN 0xF0 */
5034 "finish", /* VK_OEM_FINISH 0xF1 */
5035 "copy", /* VK_OEM_COPY 0xF2 */
5036 "auto", /* VK_OEM_AUTO 0xF3 */
5037 "enlw", /* VK_OEM_ENLW 0xF4 */
5038 "backtab", /* VK_OEM_BACKTAB 0xF5 */
5039 "attn", /* VK_ATTN 0xF6 */
5040 "crsel", /* VK_CRSEL 0xF7 */
5041 "exsel", /* VK_EXSEL 0xF8 */
5042 "ereof", /* VK_EREOF 0xF9 */
5043 "play", /* VK_PLAY 0xFA */
5044 "zoom", /* VK_ZOOM 0xFB */
5045 "noname", /* VK_NONAME 0xFC */
5046 "pa1", /* VK_PA1 0xFD */
5047 "oem_clear", /* VK_OEM_CLEAR 0xFE */
5051 /* Some of these duplicate the "Media keys" on newer keyboards,
5052 but they are delivered to the application in a different way. */
5053 static char *lispy_multimedia_keys
[] =
5061 "browser-favorites",
5098 "toggle-dictate-command",
5104 "media-fast-forward",
5107 "media-channel-down"
5110 #else /* not HAVE_NTGUI */
5112 /* This should be dealt with in XTread_socket now, and that doesn't
5113 depend on the client system having the Kana syms defined. See also
5114 the XK_kana_A case below. */
5117 static char *lispy_kana_keys
[] =
5119 /* X Keysym value */
5120 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5121 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5122 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5123 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5124 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5125 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5126 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5127 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5128 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5129 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5130 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5131 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5132 "kana-i", "kana-u", "kana-e", "kana-o",
5133 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5134 "prolongedsound", "kana-A", "kana-I", "kana-U",
5135 "kana-E", "kana-O", "kana-KA", "kana-KI",
5136 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5137 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5138 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5139 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5140 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5141 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5142 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5143 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5144 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5145 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5146 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5147 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5149 #endif /* XK_kana_A */
5152 #define FUNCTION_KEY_OFFSET 0xff00
5154 /* You'll notice that this table is arranged to be conveniently
5155 indexed by X Windows keysym values. */
5156 static char *lispy_function_keys
[] =
5158 /* X Keysym value */
5160 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5161 "backspace", "tab", "linefeed", "clear",
5163 0, 0, 0, "pause", /* 0xff10...1f */
5164 0, 0, 0, 0, 0, 0, 0, "escape",
5166 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5167 "romaji", "hiragana", "katakana", "hiragana-katakana",
5168 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5169 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5170 "eisu-toggle", /* 0xff30...3f */
5171 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5172 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5174 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5175 "down", "prior", "next", "end",
5176 "begin", 0, 0, 0, 0, 0, 0, 0,
5177 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5188 "break", /* 0xff6b */
5191 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5192 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5193 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5194 0, 0, 0, 0, 0, 0, 0, 0,
5195 "kp-tab", /* 0xff89 */
5197 "kp-enter", /* 0xff8d */
5199 "kp-f1", /* 0xff91 */
5203 "kp-home", /* 0xff95 */
5208 "kp-prior", /* kp-page-up */
5209 "kp-next", /* kp-page-down */
5215 0, 0, 0, 0, 0, 0, 0, 0, 0,
5216 "kp-multiply", /* 0xffaa */
5221 "kp-divide", /* 0xffaf */
5222 "kp-0", /* 0xffb0 */
5223 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5226 "kp-equal", /* 0xffbd */
5227 "f1", /* 0xffbe */ /* IsFunctionKey */
5229 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5230 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5231 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5232 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5233 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5234 0, 0, 0, 0, 0, 0, 0, 0,
5235 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5236 0, 0, 0, 0, 0, 0, 0, "delete"
5239 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5240 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5242 static char *iso_lispy_function_keys
[] =
5244 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5245 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5246 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5247 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5248 "iso-lefttab", /* 0xfe20 */
5249 "iso-move-line-up", "iso-move-line-down",
5250 "iso-partial-line-up", "iso-partial-line-down",
5251 "iso-partial-space-left", "iso-partial-space-right",
5252 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5253 "iso-release-margin-left", "iso-release-margin-right",
5254 "iso-release-both-margins",
5255 "iso-fast-cursor-left", "iso-fast-cursor-right",
5256 "iso-fast-cursor-up", "iso-fast-cursor-down",
5257 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5258 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5261 #endif /* not HAVE_NTGUI */
5263 Lisp_Object Vlispy_mouse_stem
;
5265 static char *lispy_wheel_names
[] =
5267 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5270 /* drag-n-drop events are generated when a set of selected files are
5271 dragged from another application and dropped onto an Emacs window. */
5272 static char *lispy_drag_n_drop_names
[] =
5277 /* Scroll bar parts. */
5278 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5279 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5280 Lisp_Object Qtop
, Qratio
;
5282 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5283 Lisp_Object
*scroll_bar_parts
[] = {
5284 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5285 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5288 /* A vector, indexed by button number, giving the down-going location
5289 of currently depressed buttons, both scroll bar and non-scroll bar.
5291 The elements have the form
5292 (BUTTON-NUMBER MODIFIER-MASK . REST)
5293 where REST is the cdr of a position as it would be reported in the event.
5295 The make_lispy_event function stores positions here to tell the
5296 difference between click and drag events, and to store the starting
5297 location to be included in drag events. */
5299 static Lisp_Object button_down_location
;
5301 /* Information about the most recent up-going button event: Which
5302 button, what location, and what time. */
5304 static int last_mouse_button
;
5305 static int last_mouse_x
;
5306 static int last_mouse_y
;
5307 static unsigned long button_down_time
;
5309 /* The maximum time between clicks to make a double-click, or Qnil to
5310 disable double-click detection, or Qt for no time limit. */
5312 Lisp_Object Vdouble_click_time
;
5314 /* Maximum number of pixels the mouse may be moved between clicks
5315 to make a double-click. */
5317 EMACS_INT double_click_fuzz
;
5319 /* The number of clicks in this multiple-click. */
5321 int double_click_count
;
5323 /* Return position of a mouse click or wheel event */
5326 make_lispy_position (f
, x
, y
, time
)
5332 enum window_part part
;
5333 Lisp_Object posn
= Qnil
;
5334 Lisp_Object extra_info
= Qnil
;
5337 /* Set `window' to the window under frame pixel coordinates (x,y) */
5339 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5340 &part
, &wx
, &wy
, 0);
5344 if (WINDOWP (window
))
5346 /* It's a click in window window at frame coordinates (x,y) */
5347 struct window
*w
= XWINDOW (window
);
5348 Lisp_Object string_info
= Qnil
;
5349 int textpos
= -1, rx
= -1, ry
= -1;
5350 int dx
= -1, dy
= -1;
5351 int width
= -1, height
= -1;
5352 Lisp_Object object
= Qnil
;
5354 /* Set event coordinates to window-relative coordinates
5355 for constructing the Lisp event below. */
5359 if (part
== ON_TEXT
)
5361 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5363 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5365 /* Mode line or header line. Look for a string under
5366 the mouse that may have a `local-map' property. */
5370 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5372 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5373 &object
, &dx
, &dy
, &width
, &height
);
5374 if (STRINGP (string
))
5375 string_info
= Fcons (string
, make_number (charpos
));
5376 if (w
== XWINDOW (selected_window
))
5379 textpos
= XMARKER (w
->pointm
)->charpos
;
5381 else if (part
== ON_VERTICAL_BORDER
)
5383 posn
= Qvertical_line
;
5388 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5393 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5395 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5396 &object
, &dx
, &dy
, &width
, &height
);
5397 if (STRINGP (string
))
5398 string_info
= Fcons (string
, make_number (charpos
));
5399 if (part
== ON_LEFT_MARGIN
)
5402 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5404 else if (part
== ON_LEFT_FRINGE
)
5406 posn
= Qleft_fringe
;
5409 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5411 : window_box_width (w
, LEFT_MARGIN_AREA
));
5414 else if (part
== ON_RIGHT_FRINGE
)
5416 posn
= Qright_fringe
;
5419 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5420 + window_box_width (w
, TEXT_AREA
)
5421 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5422 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5428 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5429 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5434 Lisp_Object string2
, object2
= Qnil
;
5435 struct display_pos p
;
5437 int width2
, height2
;
5438 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5439 &object2
, &dx2
, &dy2
,
5441 textpos
= CHARPOS (p
.pos
);
5442 if (rx
< 0) rx
= wx
;
5443 if (ry
< 0) ry
= wy
;
5444 if (dx
< 0) dx
= dx2
;
5445 if (dy
< 0) dy
= dy2
;
5446 if (width
< 0) width
= width2
;
5447 if (height
< 0) height
= height2
;
5451 posn
= make_number (textpos
);
5452 if (STRINGP (string2
))
5453 string_info
= Fcons (string2
,
5454 make_number (CHARPOS (p
.string_pos
)));
5460 #ifdef HAVE_WINDOW_SYSTEM
5461 if (IMAGEP (object
))
5463 Lisp_Object image_map
, hotspot
;
5464 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5466 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5468 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5469 posn
= XCAR (hotspot
);
5474 extra_info
= Fcons (object
,
5475 Fcons (Fcons (make_number (dx
),
5477 Fcons (Fcons (make_number (width
),
5478 make_number (height
)),
5482 extra_info
= Fcons (string_info
,
5483 Fcons (make_number (textpos
),
5484 Fcons (Fcons (make_number (rx
),
5490 XSETFRAME (window
, f
);
5495 XSETFASTINT (*x
, 0);
5496 XSETFASTINT (*y
, 0);
5499 return Fcons (window
,
5501 Fcons (Fcons (*x
, *y
),
5502 Fcons (make_number (time
),
5506 /* Given a struct input_event, build the lisp event which represents
5507 it. If EVENT is 0, build a mouse movement event from the mouse
5508 movement buffer, which should have a movement event in it.
5510 Note that events must be passed to this function in the order they
5511 are received; this function stores the location of button presses
5512 in order to build drag events when the button is released. */
5515 make_lispy_event (event
)
5516 struct input_event
*event
;
5520 switch (SWITCH_ENUM_CAST (event
->kind
))
5522 /* A simple keystroke. */
5523 case ASCII_KEYSTROKE_EVENT
:
5524 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5526 Lisp_Object lispy_c
;
5527 int c
= event
->code
;
5528 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5531 eassert (c
== event
->code
);
5532 /* Turn ASCII characters into control characters
5534 if (event
->modifiers
& ctrl_modifier
)
5536 c
= make_ctrl_char (c
);
5537 event
->modifiers
&= ~ctrl_modifier
;
5541 /* Add in the other modifier bits. The shift key was taken care
5542 of by the X code. */
5543 c
|= (event
->modifiers
5544 & (meta_modifier
| alt_modifier
5545 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5546 /* Distinguish Shift-SPC from SPC. */
5547 if ((event
->code
) == 040
5548 && event
->modifiers
& shift_modifier
)
5549 c
|= shift_modifier
;
5550 button_down_time
= 0;
5551 XSETFASTINT (lispy_c
, c
);
5555 /* A function key. The symbol may need to have modifier prefixes
5557 case NON_ASCII_KEYSTROKE_EVENT
:
5558 button_down_time
= 0;
5560 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5561 if (event
->code
== lispy_accent_codes
[i
])
5562 return modify_event_symbol (i
,
5564 Qfunction_key
, Qnil
,
5565 lispy_accent_keys
, &accent_key_syms
,
5566 (sizeof (lispy_accent_keys
)
5567 / sizeof (lispy_accent_keys
[0])));
5571 if (event
->code
>= 0x400 && event
->code
< 0x500)
5572 return modify_event_symbol (event
->code
- 0x400,
5573 event
->modifiers
& ~shift_modifier
,
5574 Qfunction_key
, Qnil
,
5575 lispy_kana_keys
, &func_key_syms
,
5576 (sizeof (lispy_kana_keys
)
5577 / sizeof (lispy_kana_keys
[0])));
5578 #endif /* XK_kana_A */
5581 #ifdef ISO_FUNCTION_KEY_OFFSET
5582 if (event
->code
< FUNCTION_KEY_OFFSET
5583 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5584 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5586 Qfunction_key
, Qnil
,
5587 iso_lispy_function_keys
, &func_key_syms
,
5588 (sizeof (iso_lispy_function_keys
)
5589 / sizeof (iso_lispy_function_keys
[0])));
5592 /* Handle system-specific or unknown keysyms. */
5593 if (event
->code
& (1 << 28)
5594 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5595 || (event
->code
- FUNCTION_KEY_OFFSET
5596 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5597 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5599 /* We need to use an alist rather than a vector as the cache
5600 since we can't make a vector long enuf. */
5601 if (NILP (current_kboard
->system_key_syms
))
5602 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5603 return modify_event_symbol (event
->code
,
5606 current_kboard
->Vsystem_key_alist
,
5607 0, ¤t_kboard
->system_key_syms
,
5611 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5613 Qfunction_key
, Qnil
,
5614 lispy_function_keys
, &func_key_syms
,
5615 (sizeof (lispy_function_keys
)
5616 / sizeof (lispy_function_keys
[0])));
5619 case MULTIMEDIA_KEY_EVENT
:
5620 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5621 / sizeof (lispy_multimedia_keys
[0]))
5622 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5624 return modify_event_symbol (event
->code
, event
->modifiers
,
5625 Qfunction_key
, Qnil
,
5626 lispy_multimedia_keys
, &func_key_syms
,
5627 (sizeof (lispy_multimedia_keys
)
5628 / sizeof (lispy_multimedia_keys
[0])));
5634 /* A mouse click. Figure out where it is, decide whether it's
5635 a press, click or drag, and build the appropriate structure. */
5636 case MOUSE_CLICK_EVENT
:
5637 #ifndef USE_TOOLKIT_SCROLL_BARS
5638 case SCROLL_BAR_CLICK_EVENT
:
5641 int button
= event
->code
;
5643 Lisp_Object position
;
5644 Lisp_Object
*start_pos_ptr
;
5645 Lisp_Object start_pos
;
5649 /* Build the position as appropriate for this mouse click. */
5650 if (event
->kind
== MOUSE_CLICK_EVENT
)
5652 struct frame
*f
= XFRAME (event
->frame_or_window
);
5653 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5657 /* Ignore mouse events that were made on frame that
5658 have been deleted. */
5659 if (! FRAME_LIVE_P (f
))
5662 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5663 /* EVENT->x and EVENT->y are frame-relative pixel
5664 coordinates at this place. Under old redisplay, COLUMN
5665 and ROW are set to frame relative glyph coordinates
5666 which are then used to determine whether this click is
5667 in a menu (non-toolkit version). */
5668 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5669 &column
, &row
, NULL
, 1);
5671 /* In the non-toolkit version, clicks on the menu bar
5672 are ordinary button events in the event buffer.
5673 Distinguish them, and invoke the menu.
5675 (In the toolkit version, the toolkit handles the menu bar
5676 and Emacs doesn't know about it until after the user
5677 makes a selection.) */
5678 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5679 && (event
->modifiers
& down_modifier
))
5681 Lisp_Object items
, item
;
5686 /* Activate the menu bar on the down event. If the
5687 up event comes in before the menu code can deal with it,
5689 if (! (event
->modifiers
& down_modifier
))
5693 /* Find the menu bar item under `column'. */
5695 items
= FRAME_MENU_BAR_ITEMS (f
);
5696 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5698 Lisp_Object pos
, string
;
5699 string
= AREF (items
, i
+ 1);
5700 pos
= AREF (items
, i
+ 3);
5703 if (column
>= XINT (pos
)
5704 && column
< XINT (pos
) + SCHARS (string
))
5706 item
= AREF (items
, i
);
5711 /* ELisp manual 2.4b says (x y) are window relative but
5712 code says they are frame-relative. */
5714 = Fcons (event
->frame_or_window
,
5716 Fcons (Fcons (event
->x
, event
->y
),
5717 Fcons (make_number (event
->timestamp
),
5720 return Fcons (item
, Fcons (position
, Qnil
));
5722 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5724 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5727 #ifndef USE_TOOLKIT_SCROLL_BARS
5730 /* It's a scrollbar click. */
5732 Lisp_Object portion_whole
;
5735 window
= event
->frame_or_window
;
5736 portion_whole
= Fcons (event
->x
, event
->y
);
5737 part
= *scroll_bar_parts
[(int) event
->part
];
5741 Fcons (Qvertical_scroll_bar
,
5742 Fcons (portion_whole
,
5743 Fcons (make_number (event
->timestamp
),
5744 Fcons (part
, Qnil
)))));
5746 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5748 if (button
>= ASIZE (button_down_location
))
5750 button_down_location
= larger_vector (button_down_location
,
5752 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5755 start_pos_ptr
= &AREF (button_down_location
, button
);
5756 start_pos
= *start_pos_ptr
;
5757 *start_pos_ptr
= Qnil
;
5760 /* On window-system frames, use the value of
5761 double-click-fuzz as is. On other frames, interpret it
5762 as a multiple of 1/8 characters. */
5766 if (WINDOWP (event
->frame_or_window
))
5767 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5768 else if (FRAMEP (event
->frame_or_window
))
5769 f
= XFRAME (event
->frame_or_window
);
5773 if (FRAME_WINDOW_P (f
))
5774 fuzz
= double_click_fuzz
;
5776 fuzz
= double_click_fuzz
/ 8;
5778 is_double
= (button
== last_mouse_button
5779 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5780 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5781 && button_down_time
!= 0
5782 && (EQ (Vdouble_click_time
, Qt
)
5783 || (INTEGERP (Vdouble_click_time
)
5784 && ((int)(event
->timestamp
- button_down_time
)
5785 < XINT (Vdouble_click_time
)))));
5788 last_mouse_button
= button
;
5789 last_mouse_x
= XINT (event
->x
);
5790 last_mouse_y
= XINT (event
->y
);
5792 /* If this is a button press, squirrel away the location, so
5793 we can decide later whether it was a click or a drag. */
5794 if (event
->modifiers
& down_modifier
)
5798 double_click_count
++;
5799 event
->modifiers
|= ((double_click_count
> 2)
5804 double_click_count
= 1;
5805 button_down_time
= event
->timestamp
;
5806 *start_pos_ptr
= Fcopy_alist (position
);
5807 ignore_mouse_drag_p
= 0;
5810 /* Now we're releasing a button - check the co-ordinates to
5811 see if this was a click or a drag. */
5812 else if (event
->modifiers
& up_modifier
)
5814 /* If we did not see a down before this up, ignore the up.
5815 Probably this happened because the down event chose a
5816 menu item. It would be an annoyance to treat the
5817 release of the button that chose the menu item as a
5820 if (!CONSP (start_pos
))
5823 event
->modifiers
&= ~up_modifier
;
5824 #if 0 /* Formerly we treated an up with no down as a click event. */
5825 if (!CONSP (start_pos
))
5826 event
->modifiers
|= click_modifier
;
5831 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5833 /* The third element of every position
5834 should be the (x,y) pair. */
5835 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5837 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5839 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5840 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5843 if (ignore_mouse_drag_p
)
5845 event
->modifiers
|= click_modifier
;
5846 ignore_mouse_drag_p
= 0;
5848 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5849 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5850 /* Maybe the mouse has moved a lot, caused scrolling, and
5851 eventually ended up at the same screen position (but
5852 not buffer position) in which case it is a drag, not
5854 /* FIXME: OTOH if the buffer position has changed
5855 because of a timer or process filter rather than
5856 because of mouse movement, it should be considered as
5857 a click. But mouse-drag-region completely ignores
5858 this case and it hasn't caused any real problem, so
5859 it's probably OK to ignore it as well. */
5860 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5861 /* Mouse hasn't moved (much). */
5862 event
->modifiers
|= click_modifier
;
5865 button_down_time
= 0;
5866 event
->modifiers
|= drag_modifier
;
5869 /* Don't check is_double; treat this as multiple
5870 if the down-event was multiple. */
5871 if (double_click_count
> 1)
5872 event
->modifiers
|= ((double_click_count
> 2)
5878 /* Every mouse event should either have the down_modifier or
5879 the up_modifier set. */
5883 /* Get the symbol we should use for the mouse click. */
5886 head
= modify_event_symbol (button
,
5888 Qmouse_click
, Vlispy_mouse_stem
,
5891 XVECTOR (mouse_syms
)->size
);
5892 if (event
->modifiers
& drag_modifier
)
5897 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5900 Fcons (make_number (double_click_count
),
5910 case HORIZ_WHEEL_EVENT
:
5912 Lisp_Object position
;
5915 /* Build the position as appropriate for this mouse click. */
5916 struct frame
*f
= XFRAME (event
->frame_or_window
);
5918 /* Ignore wheel events that were made on frame that have been
5920 if (! FRAME_LIVE_P (f
))
5923 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5926 /* Set double or triple modifiers to indicate the wheel speed. */
5928 /* On window-system frames, use the value of
5929 double-click-fuzz as is. On other frames, interpret it
5930 as a multiple of 1/8 characters. */
5935 if (WINDOWP (event
->frame_or_window
))
5936 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5937 else if (FRAMEP (event
->frame_or_window
))
5938 f
= XFRAME (event
->frame_or_window
);
5942 if (FRAME_WINDOW_P (f
))
5943 fuzz
= double_click_fuzz
;
5945 fuzz
= double_click_fuzz
/ 8;
5947 is_double
= (last_mouse_button
< 0
5948 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5949 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5950 && button_down_time
!= 0
5951 && (EQ (Vdouble_click_time
, Qt
)
5952 || (INTEGERP (Vdouble_click_time
)
5953 && ((int)(event
->timestamp
- button_down_time
)
5954 < XINT (Vdouble_click_time
)))));
5957 double_click_count
++;
5958 event
->modifiers
|= ((double_click_count
> 2)
5964 double_click_count
= 1;
5965 event
->modifiers
|= click_modifier
;
5968 button_down_time
= event
->timestamp
;
5969 /* Use a negative value to distinguish wheel from mouse button. */
5970 last_mouse_button
= -1;
5971 last_mouse_x
= XINT (event
->x
);
5972 last_mouse_y
= XINT (event
->y
);
5978 if (event
->modifiers
& up_modifier
)
5980 /* Emit a wheel-up event. */
5981 event
->modifiers
&= ~up_modifier
;
5984 else if (event
->modifiers
& down_modifier
)
5986 /* Emit a wheel-down event. */
5987 event
->modifiers
&= ~down_modifier
;
5991 /* Every wheel event should either have the down_modifier or
5992 the up_modifier set. */
5995 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5998 /* Get the symbol we should use for the wheel event. */
5999 head
= modify_event_symbol (symbol_num
,
6005 ASIZE (wheel_syms
));
6008 if (event
->modifiers
& (double_modifier
| triple_modifier
))
6011 Fcons (make_number (double_click_count
),
6020 #ifdef USE_TOOLKIT_SCROLL_BARS
6022 /* We don't have down and up events if using toolkit scroll bars,
6023 so make this always a click event. Store in the `part' of
6024 the Lisp event a symbol which maps to the following actions:
6026 `above_handle' page up
6027 `below_handle' page down
6031 `bottom' bottom of buffer
6032 `handle' thumb has been dragged.
6033 `end-scroll' end of interaction with scroll bar
6035 The incoming input_event contains in its `part' member an
6036 index of type `enum scroll_bar_part' which we can use as an
6037 index in scroll_bar_parts to get the appropriate symbol. */
6039 case SCROLL_BAR_CLICK_EVENT
:
6041 Lisp_Object position
, head
, window
, portion_whole
, part
;
6043 window
= event
->frame_or_window
;
6044 portion_whole
= Fcons (event
->x
, event
->y
);
6045 part
= *scroll_bar_parts
[(int) event
->part
];
6049 Fcons (Qvertical_scroll_bar
,
6050 Fcons (portion_whole
,
6051 Fcons (make_number (event
->timestamp
),
6052 Fcons (part
, Qnil
)))));
6054 /* Always treat scroll bar events as clicks. */
6055 event
->modifiers
|= click_modifier
;
6056 event
->modifiers
&= ~up_modifier
;
6058 if (event
->code
>= ASIZE (mouse_syms
))
6059 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
6061 /* Get the symbol we should use for the mouse click. */
6062 head
= modify_event_symbol (event
->code
,
6067 XVECTOR (mouse_syms
)->size
);
6068 return Fcons (head
, Fcons (position
, Qnil
));
6071 #endif /* USE_TOOLKIT_SCROLL_BARS */
6073 case DRAG_N_DROP_EVENT
:
6076 Lisp_Object head
, position
;
6079 f
= XFRAME (event
->frame_or_window
);
6082 /* Ignore mouse events that were made on frames that
6083 have been deleted. */
6084 if (! FRAME_LIVE_P (f
))
6087 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6090 head
= modify_event_symbol (0, event
->modifiers
,
6092 lispy_drag_n_drop_names
,
6093 &drag_n_drop_syms
, 1);
6099 #endif /* HAVE_MOUSE */
6101 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
6102 || defined(HAVE_NS) || defined (USE_GTK)
6103 case MENU_BAR_EVENT
:
6104 if (EQ (event
->arg
, event
->frame_or_window
))
6105 /* This is the prefix key. We translate this to
6106 `(menu_bar)' because the code in keyboard.c for menu
6107 events, which we use, relies on this. */
6108 return Fcons (Qmenu_bar
, Qnil
);
6112 case SELECT_WINDOW_EVENT
:
6113 /* Make an event (select-window (WINDOW)). */
6114 return Fcons (Qselect_window
,
6115 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6118 case TOOL_BAR_EVENT
:
6119 if (EQ (event
->arg
, event
->frame_or_window
))
6120 /* This is the prefix key. We translate this to
6121 `(tool_bar)' because the code in keyboard.c for tool bar
6122 events, which we use, relies on this. */
6123 return Fcons (Qtool_bar
, Qnil
);
6124 else if (SYMBOLP (event
->arg
))
6125 return apply_modifiers (event
->modifiers
, event
->arg
);
6128 case USER_SIGNAL_EVENT
:
6129 /* A user signal. */
6131 char *name
= find_user_signal_name (event
->code
);
6134 return intern (name
);
6137 case SAVE_SESSION_EVENT
:
6138 return Qsave_session
;
6141 case MAC_APPLE_EVENT
:
6143 Lisp_Object spec
[2];
6147 return Fcons (Qmac_apple_event
,
6148 Fcons (Fvector (2, spec
),
6149 Fcons (event
->arg
, Qnil
)));
6156 return Fcons (Qdbus_event
, event
->arg
);
6158 #endif /* HAVE_DBUS */
6161 case GPM_CLICK_EVENT
:
6163 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6164 Lisp_Object head
, position
;
6165 Lisp_Object
*start_pos_ptr
;
6166 Lisp_Object start_pos
;
6167 int button
= event
->code
;
6169 if (button
>= ASIZE (button_down_location
))
6171 button_down_location
= larger_vector (button_down_location
,
6173 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6176 start_pos_ptr
= &AREF (button_down_location
, button
);
6177 start_pos
= *start_pos_ptr
;
6179 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6182 if (event
->modifiers
& down_modifier
)
6183 *start_pos_ptr
= Fcopy_alist (position
);
6184 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6186 if (!CONSP (start_pos
))
6188 event
->modifiers
&= ~up_modifier
;
6191 head
= modify_event_symbol (button
,
6193 Qmouse_click
, Vlispy_mouse_stem
,
6196 XVECTOR (mouse_syms
)->size
);
6198 if (event
->modifiers
& drag_modifier
)
6203 else if (event
->modifiers
& double_modifier
)
6206 Fcons (make_number (2),
6208 else if (event
->modifiers
& triple_modifier
)
6211 Fcons (make_number (3),
6218 #endif /* HAVE_GPM */
6220 /* The 'kind' field of the event is something we don't recognize. */
6226 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6229 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6231 Lisp_Object bar_window
;
6232 enum scroll_bar_part part
;
6236 /* Is it a scroll bar movement? */
6237 if (frame
&& ! NILP (bar_window
))
6239 Lisp_Object part_sym
;
6241 part_sym
= *scroll_bar_parts
[(int) part
];
6242 return Fcons (Qscroll_bar_movement
,
6243 (Fcons (Fcons (bar_window
,
6244 Fcons (Qvertical_scroll_bar
,
6245 Fcons (Fcons (x
, y
),
6246 Fcons (make_number (time
),
6252 /* Or is it an ordinary mouse movement? */
6255 Lisp_Object position
;
6257 position
= make_lispy_position (frame
, &x
, &y
, time
);
6259 return Fcons (Qmouse_movement
,
6265 #endif /* HAVE_MOUSE || HAVE GPM */
6267 /* Construct a switch frame event. */
6269 make_lispy_switch_frame (frame
)
6272 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6275 /* Manipulating modifiers. */
6277 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6279 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6280 SYMBOL's name of the end of the modifiers; the string from this
6281 position is the unmodified symbol name.
6283 This doesn't use any caches. */
6286 parse_modifiers_uncached (symbol
, modifier_end
)
6294 CHECK_SYMBOL (symbol
);
6297 name
= SYMBOL_NAME (symbol
);
6299 for (i
= 0; i
+2 <= SBYTES (name
); )
6301 int this_mod_end
= 0;
6304 /* See if the name continues with a modifier word.
6305 Check that the word appears, but don't check what follows it.
6306 Set this_mod and this_mod_end to record what we find. */
6308 switch (SREF (name
, i
))
6310 #define SINGLE_LETTER_MOD(BIT) \
6311 (this_mod_end = i + 1, this_mod = BIT)
6314 SINGLE_LETTER_MOD (alt_modifier
);
6318 SINGLE_LETTER_MOD (ctrl_modifier
);
6322 SINGLE_LETTER_MOD (hyper_modifier
);
6326 SINGLE_LETTER_MOD (meta_modifier
);
6330 SINGLE_LETTER_MOD (shift_modifier
);
6334 SINGLE_LETTER_MOD (super_modifier
);
6337 #undef SINGLE_LETTER_MOD
6339 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6340 if (i + LEN + 1 <= SBYTES (name) \
6341 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6343 this_mod_end = i + LEN; \
6348 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6349 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6350 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6354 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6356 #undef MULTI_LETTER_MOD
6360 /* If we found no modifier, stop looking for them. */
6361 if (this_mod_end
== 0)
6364 /* Check there is a dash after the modifier, so that it
6365 really is a modifier. */
6366 if (this_mod_end
>= SBYTES (name
)
6367 || SREF (name
, this_mod_end
) != '-')
6370 /* This modifier is real; look for another. */
6371 modifiers
|= this_mod
;
6372 i
= this_mod_end
+ 1;
6375 /* Should we include the `click' modifier? */
6376 if (! (modifiers
& (down_modifier
| drag_modifier
6377 | double_modifier
| triple_modifier
))
6378 && i
+ 7 == SBYTES (name
)
6379 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6380 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6381 modifiers
|= click_modifier
;
6389 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6390 prepended to the string BASE[0..BASE_LEN-1].
6391 This doesn't use any caches. */
6393 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6396 int base_len
, base_len_byte
;
6398 /* Since BASE could contain nulls, we can't use intern here; we have
6399 to use Fintern, which expects a genuine Lisp_String, and keeps a
6402 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6408 /* Only the event queue may use the `up' modifier; it should always
6409 be turned into a click or drag event before presented to lisp code. */
6410 if (modifiers
& up_modifier
)
6413 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6414 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6415 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6416 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6417 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6418 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6419 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6420 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6421 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6422 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6423 /* The click modifier is denoted by the absence of other modifiers. */
6427 mod_len
= p
- new_mods
;
6431 Lisp_Object new_name
;
6433 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6434 mod_len
+ base_len_byte
);
6435 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6436 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6438 return Fintern (new_name
, Qnil
);
6443 static char *modifier_names
[] =
6445 "up", "down", "drag", "click", "double", "triple", 0, 0,
6446 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6447 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6449 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6451 static Lisp_Object modifier_symbols
;
6453 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6455 lispy_modifier_list (modifiers
)
6458 Lisp_Object modifier_list
;
6461 modifier_list
= Qnil
;
6462 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6463 if (modifiers
& (1<<i
))
6464 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6467 return modifier_list
;
6471 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6472 where UNMODIFIED is the unmodified form of SYMBOL,
6473 MASK is the set of modifiers present in SYMBOL's name.
6474 This is similar to parse_modifiers_uncached, but uses the cache in
6475 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6476 Qevent_symbol_elements property. */
6478 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6481 parse_modifiers (symbol
)
6484 Lisp_Object elements
;
6486 if (INTEGERP (symbol
))
6487 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6488 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6490 else if (!SYMBOLP (symbol
))
6493 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6494 if (CONSP (elements
))
6499 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6500 Lisp_Object unmodified
;
6503 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6504 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6507 if (modifiers
& ~INTMASK
)
6509 XSETFASTINT (mask
, modifiers
);
6510 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6512 /* Cache the parsing results on SYMBOL. */
6513 Fput (symbol
, Qevent_symbol_element_mask
,
6515 Fput (symbol
, Qevent_symbol_elements
,
6516 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6518 /* Since we know that SYMBOL is modifiers applied to unmodified,
6519 it would be nice to put that in unmodified's cache.
6520 But we can't, since we're not sure that parse_modifiers is
6527 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6528 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6529 doc
: /* Parse the event symbol. For internal use. */)
6533 /* Fill the cache if needed. */
6534 parse_modifiers (symbol
);
6535 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6536 and use the Lispier representation stored on Qevent_symbol_elements
6538 return Fget (symbol
, Qevent_symbol_elements
);
6541 /* Apply the modifiers MODIFIERS to the symbol BASE.
6542 BASE must be unmodified.
6544 This is like apply_modifiers_uncached, but uses BASE's
6545 Qmodifier_cache property, if present. It also builds
6546 Qevent_symbol_elements properties, since it has that info anyway.
6548 apply_modifiers copies the value of BASE's Qevent_kind property to
6549 the modified symbol. */
6551 apply_modifiers (modifiers
, base
)
6555 Lisp_Object cache
, index
, entry
, new_symbol
;
6557 /* Mask out upper bits. We don't know where this value's been. */
6558 modifiers
&= INTMASK
;
6560 if (INTEGERP (base
))
6561 return make_number (XINT (base
) | modifiers
);
6563 /* The click modifier never figures into cache indices. */
6564 cache
= Fget (base
, Qmodifier_cache
);
6565 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6566 entry
= assq_no_quit (index
, cache
);
6569 new_symbol
= XCDR (entry
);
6572 /* We have to create the symbol ourselves. */
6573 new_symbol
= apply_modifiers_uncached (modifiers
,
6574 SDATA (SYMBOL_NAME (base
)),
6575 SCHARS (SYMBOL_NAME (base
)),
6576 SBYTES (SYMBOL_NAME (base
)));
6578 /* Add the new symbol to the base's cache. */
6579 entry
= Fcons (index
, new_symbol
);
6580 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6582 /* We have the parsing info now for free, so we could add it to
6584 XSETFASTINT (index, modifiers);
6585 Fput (new_symbol, Qevent_symbol_element_mask,
6586 Fcons (base, Fcons (index, Qnil)));
6587 Fput (new_symbol, Qevent_symbol_elements,
6588 Fcons (base, lispy_modifier_list (modifiers)));
6589 Sadly, this is only correct if `base' is indeed a base event,
6590 which is not necessarily the case. -stef */
6593 /* Make sure this symbol is of the same kind as BASE.
6595 You'd think we could just set this once and for all when we
6596 intern the symbol above, but reorder_modifiers may call us when
6597 BASE's property isn't set right; we can't assume that just
6598 because it has a Qmodifier_cache property it must have its
6599 Qevent_kind set right as well. */
6600 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6604 kind
= Fget (base
, Qevent_kind
);
6606 Fput (new_symbol
, Qevent_kind
, kind
);
6613 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6614 return a symbol with the modifiers placed in the canonical order.
6615 Canonical order is alphabetical, except for down and drag, which
6616 always come last. The 'click' modifier is never written out.
6618 Fdefine_key calls this to make sure that (for example) C-M-foo
6619 and M-C-foo end up being equivalent in the keymap. */
6622 reorder_modifiers (symbol
)
6625 /* It's hopefully okay to write the code this way, since everything
6626 will soon be in caches, and no consing will be done at all. */
6629 parsed
= parse_modifiers (symbol
);
6630 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6635 /* For handling events, we often want to produce a symbol whose name
6636 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6637 to some base, like the name of a function key or mouse button.
6638 modify_event_symbol produces symbols of this sort.
6640 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6641 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6644 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6645 into symbol names, or a string specifying a name stem used to
6646 construct a symbol name or the form `STEM-N', where N is the decimal
6647 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6648 non-nil; otherwise NAME_TABLE is used.
6650 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6651 persist between calls to modify_event_symbol that it can use to
6652 store a cache of the symbols it's generated for this NAME_TABLE
6653 before. The object stored there may be a vector or an alist.
6655 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6657 MODIFIERS is a set of modifier bits (as given in struct input_events)
6658 whose prefixes should be applied to the symbol name.
6660 SYMBOL_KIND is the value to be placed in the event_kind property of
6661 the returned symbol.
6663 The symbols we create are supposed to have an
6664 `event-symbol-elements' property, which lists the modifiers present
6665 in the symbol's name. */
6668 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6669 name_table
, symbol_table
, table_size
)
6672 Lisp_Object symbol_kind
;
6673 Lisp_Object name_alist_or_stem
;
6675 Lisp_Object
*symbol_table
;
6676 unsigned int table_size
;
6679 Lisp_Object symbol_int
;
6681 /* Get rid of the "vendor-specific" bit here. */
6682 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6684 /* Is this a request for a valid symbol? */
6685 if (symbol_num
< 0 || symbol_num
>= table_size
)
6688 if (CONSP (*symbol_table
))
6689 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6691 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6692 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6693 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6694 we've never used that symbol before. */
6697 if (! VECTORP (*symbol_table
)
6698 || XVECTOR (*symbol_table
)->size
!= table_size
)
6702 XSETFASTINT (size
, table_size
);
6703 *symbol_table
= Fmake_vector (size
, Qnil
);
6706 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6709 /* Have we already used this symbol before? */
6712 /* No; let's create it. */
6713 if (CONSP (name_alist_or_stem
))
6714 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6715 else if (STRINGP (name_alist_or_stem
))
6717 int len
= SBYTES (name_alist_or_stem
);
6718 char *buf
= (char *) alloca (len
+ 50);
6719 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6720 (long) XINT (symbol_int
) + 1);
6721 value
= intern (buf
);
6723 else if (name_table
!= 0 && name_table
[symbol_num
])
6724 value
= intern (name_table
[symbol_num
]);
6726 #ifdef HAVE_WINDOW_SYSTEM
6729 char *name
= x_get_keysym_name (symbol_num
);
6731 value
= intern (name
);
6738 sprintf (buf
, "key-%d", symbol_num
);
6739 value
= intern (buf
);
6742 if (CONSP (*symbol_table
))
6743 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6745 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6747 /* Fill in the cache entries for this symbol; this also
6748 builds the Qevent_symbol_elements property, which the user
6750 apply_modifiers (modifiers
& click_modifier
, value
);
6751 Fput (value
, Qevent_kind
, symbol_kind
);
6754 /* Apply modifiers to that symbol. */
6755 return apply_modifiers (modifiers
, value
);
6758 /* Convert a list that represents an event type,
6759 such as (ctrl meta backspace), into the usual representation of that
6760 event type as a number or a symbol. */
6762 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6763 doc
: /* Convert the event description list EVENT-DESC to an event type.
6764 EVENT-DESC should contain one base event type (a character or symbol)
6765 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6766 drag, down, double or triple). The base must be last.
6767 The return value is an event type (a character or symbol) which
6768 has the same base event type and all the specified modifiers. */)
6770 Lisp_Object event_desc
;
6778 while (CONSP (rest
))
6786 /* Given a symbol, see if it is a modifier name. */
6787 if (SYMBOLP (elt
) && CONSP (rest
))
6788 this = parse_solitary_modifier (elt
);
6792 else if (!NILP (base
))
6793 error ("Two bases given in one event");
6799 /* Let the symbol A refer to the character A. */
6800 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6801 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6803 if (INTEGERP (base
))
6805 /* Turn (shift a) into A. */
6806 if ((modifiers
& shift_modifier
) != 0
6807 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6809 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6810 modifiers
&= ~shift_modifier
;
6813 /* Turn (control a) into C-a. */
6814 if (modifiers
& ctrl_modifier
)
6815 return make_number ((modifiers
& ~ctrl_modifier
)
6816 | make_ctrl_char (XINT (base
)));
6818 return make_number (modifiers
| XINT (base
));
6820 else if (SYMBOLP (base
))
6821 return apply_modifiers (modifiers
, base
);
6824 error ("Invalid base event");
6829 /* Try to recognize SYMBOL as a modifier name.
6830 Return the modifier flag bit, or 0 if not recognized. */
6833 parse_solitary_modifier (symbol
)
6836 Lisp_Object name
= SYMBOL_NAME (symbol
);
6838 switch (SREF (name
, 0))
6840 #define SINGLE_LETTER_MOD(BIT) \
6841 if (SBYTES (name) == 1) \
6844 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6845 if (LEN == SBYTES (name) \
6846 && ! strncmp (SDATA (name), NAME, LEN)) \
6850 SINGLE_LETTER_MOD (alt_modifier
);
6854 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6858 SINGLE_LETTER_MOD (ctrl_modifier
);
6862 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6863 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6867 SINGLE_LETTER_MOD (hyper_modifier
);
6871 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6875 SINGLE_LETTER_MOD (meta_modifier
);
6879 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6883 SINGLE_LETTER_MOD (shift_modifier
);
6887 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6888 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6889 SINGLE_LETTER_MOD (super_modifier
);
6893 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6894 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6895 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6899 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6902 #undef SINGLE_LETTER_MOD
6903 #undef MULTI_LETTER_MOD
6909 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6910 Such a list is not valid as an event,
6911 but it can be a Lucid-style event type list. */
6914 lucid_event_type_list_p (object
)
6919 if (! CONSP (object
))
6922 if (EQ (XCAR (object
), Qhelp_echo
)
6923 || EQ (XCAR (object
), Qvertical_line
)
6924 || EQ (XCAR (object
), Qmode_line
)
6925 || EQ (XCAR (object
), Qheader_line
))
6928 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6932 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6939 /* Store into *addr a value nonzero if terminal input chars are available.
6940 Serves the purpose of ioctl (0, FIONREAD, addr)
6941 but works even if FIONREAD does not exist.
6942 (In fact, this may actually read some input.)
6944 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6945 timer events that are ripe.
6946 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6947 events (FOCUS_IN_EVENT).
6948 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6949 movements and toolkit scroll bar thumb drags. */
6952 get_input_pending (addr
, flags
)
6956 /* First of all, have we already counted some input? */
6957 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6959 /* If input is being read as it arrives, and we have none, there is none. */
6960 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6963 /* Try to read some input and see how much we get. */
6965 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6968 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6971 gobble_input (expected
)
6975 /* Check whether a D-Bus message has arrived. */
6976 xd_read_queued_messages ();
6977 #endif /* HAVE_DBUS */
6981 if (interrupt_input
)
6984 mask
= sigblock (sigmask (SIGIO
));
6985 read_avail_input (expected
);
6989 #ifdef POLL_FOR_INPUT
6990 /* XXX This condition was (read_socket_hook && !interrupt_input),
6991 but read_socket_hook is not global anymore. Let's pretend that
6993 if (!interrupt_input
&& poll_suppress_count
== 0)
6996 mask
= sigblock (sigmask (SIGALRM
));
6997 read_avail_input (expected
);
7003 read_avail_input (expected
);
7007 /* Put a BUFFER_SWITCH_EVENT in the buffer
7008 so that read_key_sequence will notice the new current buffer. */
7011 record_asynch_buffer_change ()
7013 struct input_event event
;
7017 event
.kind
= BUFFER_SWITCH_EVENT
;
7018 event
.frame_or_window
= Qnil
;
7022 /* We don't need a buffer-switch event unless Emacs is waiting for input.
7023 The purpose of the event is to make read_key_sequence look up the
7024 keymaps again. If we aren't in read_key_sequence, we don't need one,
7025 and the event could cause trouble by messing up (input-pending-p). */
7026 tem
= Fwaiting_for_user_input_p ();
7030 /* We never need these events if we have no asynchronous subprocesses. */
7034 /* Make sure no interrupt happens while storing the event. */
7036 if (interrupt_input
)
7039 mask
= sigblock (sigmask (SIGIO
));
7040 kbd_buffer_store_event (&event
);
7047 kbd_buffer_store_event (&event
);
7054 /* Read any terminal input already buffered up by the system
7055 into the kbd_buffer, but do not wait.
7057 EXPECTED should be nonzero if the caller knows there is some input.
7059 Except on VMS, all input is read by this function.
7060 If interrupt_input is nonzero, this function MUST be called
7061 only when SIGIO is blocked.
7063 Returns the number of keyboard chars read, or -1 meaning
7064 this is a bad time to try to read input. */
7067 read_avail_input (expected
)
7074 /* Store pending user signal events, if any. */
7075 if (store_user_signal_events ())
7078 /* Loop through the available terminals, and call their input hooks. */
7082 struct terminal
*next
= t
->next_terminal
;
7084 if (t
->read_socket_hook
)
7087 struct input_event hold_quit
;
7089 EVENT_INIT (hold_quit
);
7090 hold_quit
.kind
= NO_EVENT
;
7092 /* No need for FIONREAD or fcntl; just say don't wait. */
7093 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
7099 if (nr
== -1) /* Not OK to read input now. */
7103 else if (nr
== -2) /* Non-transient error. */
7105 /* The terminal device terminated; it should be closed. */
7107 /* Kill Emacs if this was our last terminal. */
7108 if (!terminal_list
->next_terminal
)
7109 /* Formerly simply reported no input, but that
7110 sometimes led to a failure of Emacs to terminate.
7111 SIGHUP seems appropriate if we can't reach the
7113 /* ??? Is it really right to send the signal just to
7114 this process rather than to the whole process
7115 group? Perhaps on systems with FIONREAD Emacs is
7116 alone in its group. */
7117 kill (getpid (), SIGHUP
);
7119 /* XXX Is calling delete_terminal safe here? It calls Fdelete_frame. */
7122 XSETTERMINAL (tmp
, t
);
7123 Fdelete_terminal (tmp
, Qnoelisp
);
7127 if (hold_quit
.kind
!= NO_EVENT
)
7128 kbd_buffer_store_event (&hold_quit
);
7140 /* This is the tty way of reading available input.
7142 Note that each terminal device has its own `struct terminal' object,
7143 and so this function is called once for each individual termcap
7144 terminal. The first parameter indicates which terminal to read from. */
7147 tty_read_avail_input (struct terminal
*terminal
,
7149 struct input_event
*hold_quit
)
7151 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7152 the kbd_buffer can really hold. That may prevent loss
7153 of characters on some systems when input is stuffed at us. */
7154 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7156 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7159 if (!terminal
->name
) /* Don't read from a dead terminal. */
7162 if (terminal
->type
!= output_termcap
)
7165 /* XXX I think the following code should be moved to separate hook
7166 functions in system-dependent files. */
7169 #else /* not WINDOWSNT */
7171 n_to_read
= dos_keysns ();
7175 cbuf
[0] = dos_keyread ();
7178 #else /* not MSDOS */
7180 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7184 return 0; /* The terminal is suspended. */
7190 struct input_event hold_quit
;
7193 EVENT_INIT (hold_quit
);
7194 hold_quit
.kind
= NO_EVENT
;
7196 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7197 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7199 if (hold_quit
.kind
!= NO_EVENT
)
7200 kbd_buffer_store_event (&hold_quit
);
7204 #endif /* HAVE_GPM */
7206 /* Determine how many characters we should *try* to read. */
7208 /* Find out how much input is available. */
7209 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7211 if (! noninteractive
)
7212 return -2; /* Close this terminal. */
7218 if (n_to_read
> sizeof cbuf
)
7219 n_to_read
= sizeof cbuf
;
7220 #else /* no FIONREAD */
7221 #if defined (USG) || defined(CYGWIN)
7222 /* Read some input if available, but don't wait. */
7223 n_to_read
= sizeof cbuf
;
7224 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7230 /* Now read; for one reason or another, this will not block.
7231 NREAD is set to the number of chars read. */
7234 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7235 /* POSIX infers that processes which are not in the session leader's
7236 process group won't get SIGHUP's at logout time. BSDI adheres to
7237 this part standard and returns -1 from read (0) with errno==EIO
7238 when the control tty is taken away.
7239 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7240 if (nread
== -1 && errno
== EIO
)
7241 return -2; /* Close this terminal. */
7242 #if defined (AIX) && defined (_BSD)
7243 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7244 This looks incorrect, but it isn't, because _BSD causes
7245 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7246 and that causes a value other than 0 when there is no input. */
7248 return -2; /* Close this terminal. */
7252 /* We used to retry the read if it was interrupted.
7253 But this does the wrong thing when O_NDELAY causes
7254 an EAGAIN error. Does anybody know of a situation
7255 where a retry is actually needed? */
7257 nread
< 0 && (errno
== EAGAIN
7271 #if defined (USG) || defined (CYGWIN)
7272 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7273 #endif /* USG or CYGWIN */
7274 #endif /* no FIONREAD */
7279 #endif /* not MSDOS */
7280 #endif /* not WINDOWSNT */
7282 for (i
= 0; i
< nread
; i
++)
7284 struct input_event buf
;
7286 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7288 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7289 buf
.modifiers
= meta_modifier
;
7290 if (tty
->meta_key
!= 2)
7294 /* Set the frame corresponding to the active tty. Note that the
7295 value of selected_frame is not reliable here, redisplay tends
7296 to temporarily change it. */
7297 buf
.frame_or_window
= tty
->top_frame
;
7300 kbd_buffer_store_event (&buf
);
7301 /* Don't look at input that follows a C-g too closely.
7302 This reduces lossage due to autorepeat on C-g. */
7303 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7304 && buf
.code
== quit_char
)
7310 #endif /* not VMS */
7313 handle_async_input ()
7316 extern int select_alarmed
;
7319 interrupt_input_pending
= 0;
7324 nread
= read_avail_input (1);
7325 /* -1 means it's not ok to read the input now.
7326 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7327 0 means there was no keyboard input available. */
7332 select_alarmed
= 1; /* Force the select emulator back to life */
7337 #ifdef SIGIO /* for entire page */
7338 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7341 input_available_signal (signo
)
7344 /* Must preserve main program's value of errno. */
7345 int old_errno
= errno
;
7346 #if defined (USG) && !defined (POSIX_SIGNALS)
7347 /* USG systems forget handlers when they are used;
7348 must reestablish each time */
7349 signal (signo
, input_available_signal
);
7357 interrupt_input_pending
= 1;
7359 SIGNAL_THREAD_CHECK (signo
);
7362 if (input_available_clear_time
)
7363 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7366 handle_async_input ();
7376 /* Send ourselves a SIGIO.
7378 This function exists so that the UNBLOCK_INPUT macro in
7379 blockinput.h can have some way to take care of input we put off
7380 dealing with, without assuming that every file which uses
7381 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7383 reinvoke_input_signal ()
7386 handle_async_input ();
7392 /* User signal events. */
7394 struct user_signal_info
7396 /* Signal number. */
7399 /* Name of the signal. */
7402 /* Number of pending signals. */
7405 struct user_signal_info
*next
;
7408 /* List of user signals. */
7409 static struct user_signal_info
*user_signals
= NULL
;
7412 add_user_signal (sig
, name
)
7416 struct user_signal_info
*p
;
7418 for (p
= user_signals
; p
; p
= p
->next
)
7420 /* Already added. */
7423 p
= xmalloc (sizeof (struct user_signal_info
));
7425 p
->name
= xstrdup (name
);
7427 p
->next
= user_signals
;
7430 signal (sig
, handle_user_signal
);
7434 handle_user_signal (sig
)
7437 int old_errno
= errno
;
7438 struct user_signal_info
*p
;
7440 #if defined (USG) && !defined (POSIX_SIGNALS)
7441 /* USG systems forget handlers when they are used;
7442 must reestablish each time */
7443 signal (sig
, handle_user_signal
);
7446 SIGNAL_THREAD_CHECK (sig
);
7448 for (p
= user_signals
; p
; p
= p
->next
)
7453 if (interrupt_input
)
7454 kill (getpid (), SIGIO
);
7458 /* Tell wait_reading_process_output that it needs to wake
7459 up and look around. */
7460 if (input_available_clear_time
)
7461 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7470 find_user_signal_name (sig
)
7473 struct user_signal_info
*p
;
7475 for (p
= user_signals
; p
; p
= p
->next
)
7483 store_user_signal_events ()
7485 struct user_signal_info
*p
;
7486 struct input_event buf
;
7489 for (p
= user_signals
; p
; p
= p
->next
)
7490 if (p
->npending
> 0)
7496 bzero (&buf
, sizeof buf
);
7497 buf
.kind
= USER_SIGNAL_EVENT
;
7498 buf
.frame_or_window
= selected_frame
;
7500 nstored
+= p
->npending
;
7502 mask
= sigblock (sigmask (p
->sig
));
7506 kbd_buffer_store_event (&buf
);
7509 while (p
->npending
> 0);
7517 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7518 static Lisp_Object menu_bar_one_keymap_changed_items
;
7520 /* These variables hold the vector under construction within
7521 menu_bar_items and its subroutines, and the current index
7522 for storing into that vector. */
7523 static Lisp_Object menu_bar_items_vector
;
7524 static int menu_bar_items_index
;
7526 /* Return a vector of menu items for a menu bar, appropriate
7527 to the current buffer. Each item has three elements in the vector:
7530 OLD is an old vector we can optionally reuse, or nil. */
7533 menu_bar_items (old
)
7536 /* The number of keymaps we're scanning right now, and the number of
7537 keymaps we have allocated space for. */
7540 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7541 in the current keymaps, or nil where it is not a prefix. */
7544 Lisp_Object def
, tail
;
7553 /* In order to build the menus, we need to call the keymap
7554 accessors. They all call QUIT. But this function is called
7555 during redisplay, during which a quit is fatal. So inhibit
7556 quitting while building the menus.
7557 We do this instead of specbind because (1) errors will clear it anyway
7558 and (2) this avoids risk of specpdl overflow. */
7559 oquit
= Vinhibit_quit
;
7563 menu_bar_items_vector
= old
;
7565 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7566 menu_bar_items_index
= 0;
7568 /* Build our list of keymaps.
7569 If we recognize a function key and replace its escape sequence in
7570 keybuf with its symbol, or if the sequence starts with a mouse
7571 click and we need to switch buffers, we jump back here to rebuild
7572 the initial keymaps from the current buffer. */
7576 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7577 if (!NILP (Voverriding_local_map_menu_flag
))
7579 /* Yes, use them (if non-nil) as well as the global map. */
7580 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7582 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7583 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7584 if (!NILP (Voverriding_local_map
))
7585 maps
[nmaps
++] = Voverriding_local_map
;
7589 /* No, so use major and minor mode keymaps and keymap property.
7590 Note that menu-bar bindings in the local-map and keymap
7591 properties may not work reliable, as they are only
7592 recognized when the menu-bar (or mode-line) is updated,
7593 which does not normally happen after every command. */
7596 nminor
= current_minor_maps (NULL
, &tmaps
);
7597 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7599 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7600 maps
[nmaps
++] = tem
;
7601 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7603 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7605 maps
[nmaps
++] = current_global_map
;
7608 /* Look up in each map the dummy prefix key `menu-bar'. */
7612 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7613 if (!NILP (maps
[mapno
]))
7615 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7619 menu_bar_one_keymap_changed_items
= Qnil
;
7620 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7624 /* Move to the end those items that should be at the end. */
7626 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7629 int end
= menu_bar_items_index
;
7631 for (i
= 0; i
< end
; i
+= 4)
7632 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7634 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7635 /* Move the item at index I to the end,
7636 shifting all the others forward. */
7637 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7638 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7639 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7640 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7642 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7643 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7644 (end
- i
- 4) * sizeof (Lisp_Object
));
7645 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7646 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7647 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7648 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7653 /* Add nil, nil, nil, nil at the end. */
7654 i
= menu_bar_items_index
;
7655 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7656 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7657 /* Add this item. */
7658 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7659 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7660 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7661 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7662 menu_bar_items_index
= i
;
7664 Vinhibit_quit
= oquit
;
7665 return menu_bar_items_vector
;
7668 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7669 If there's already an item for KEY, add this DEF to it. */
7671 Lisp_Object item_properties
;
7674 menu_bar_item (key
, item
, dummy1
, dummy2
)
7675 Lisp_Object key
, item
, dummy1
;
7678 struct gcpro gcpro1
;
7682 if (EQ (item
, Qundefined
))
7684 /* If a map has an explicit `undefined' as definition,
7685 discard any previously made menu bar item. */
7687 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7688 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7690 if (menu_bar_items_index
> i
+ 4)
7691 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7692 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7693 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7694 menu_bar_items_index
-= 4;
7698 /* If this keymap has already contributed to this KEY,
7699 don't contribute to it a second time. */
7700 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7701 if (!NILP (tem
) || NILP (item
))
7704 menu_bar_one_keymap_changed_items
7705 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7707 /* We add to menu_bar_one_keymap_changed_items before doing the
7708 parse_menu_item, so that if it turns out it wasn't a menu item,
7709 it still correctly hides any further menu item. */
7711 i
= parse_menu_item (item
, 0, 1);
7716 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7718 /* Find any existing item for this KEY. */
7719 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7720 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7723 /* If we did not find this KEY, add it at the end. */
7724 if (i
== menu_bar_items_index
)
7726 /* If vector is too small, get a bigger one. */
7727 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7728 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7729 /* Add this item. */
7730 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7731 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7732 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7733 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7734 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7735 menu_bar_items_index
= i
;
7737 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7741 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7742 /* If the new and the old items are not both keymaps,
7743 the lookup will only find `item'. */
7744 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7745 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7749 /* This is used as the handler when calling menu_item_eval_property. */
7751 menu_item_eval_property_1 (arg
)
7754 /* If we got a quit from within the menu computation,
7755 quit all the way out of it. This takes care of C-] in the debugger. */
7756 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7757 Fsignal (Qquit
, Qnil
);
7762 /* Evaluate an expression and return the result (or nil if something
7763 went wrong). Used to evaluate dynamic parts of menu items. */
7765 menu_item_eval_property (sexpr
)
7768 int count
= SPECPDL_INDEX ();
7770 specbind (Qinhibit_redisplay
, Qt
);
7771 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7772 menu_item_eval_property_1
);
7773 return unbind_to (count
, val
);
7776 /* This function parses a menu item and leaves the result in the
7777 vector item_properties.
7778 ITEM is a key binding, a possible menu item.
7779 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7780 evaluate dynamic expressions in the menu item.
7781 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7783 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7784 parse_menu_item returns true if the item is a menu item and false
7788 parse_menu_item (item
, notreal
, inmenubar
)
7790 int notreal
, inmenubar
;
7792 Lisp_Object def
, tem
, item_string
, start
;
7793 Lisp_Object cachelist
;
7795 Lisp_Object keyhint
;
7806 /* Create item_properties vector if necessary. */
7807 if (NILP (item_properties
))
7809 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7811 /* Initialize optional entries. */
7812 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7813 ASET (item_properties
, i
, Qnil
);
7814 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7816 /* Save the item here to protect it from GC. */
7817 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7819 item_string
= XCAR (item
);
7823 if (STRINGP (item_string
))
7825 /* Old format menu item. */
7826 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7828 /* Maybe help string. */
7829 if (CONSP (item
) && STRINGP (XCAR (item
)))
7831 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7836 /* Maybe key binding cache. */
7837 if (CONSP (item
) && CONSP (XCAR (item
))
7838 && (NILP (XCAR (XCAR (item
)))
7839 || VECTORP (XCAR (XCAR (item
)))))
7841 cachelist
= XCAR (item
);
7845 /* This is the real definition--the function to run. */
7846 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7848 /* Get enable property, if any. */
7851 tem
= Fget (item
, Qmenu_enable
);
7852 if (!NILP (Venable_disabled_menus_and_buttons
))
7853 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7854 else if (!NILP (tem
))
7855 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7858 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7860 /* New format menu item. */
7861 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7862 start
= XCDR (item
);
7865 /* We have a real binding. */
7866 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7868 item
= XCDR (start
);
7869 /* Is there a cache list with key equivalences. */
7870 if (CONSP (item
) && CONSP (XCAR (item
)))
7872 cachelist
= XCAR (item
);
7876 /* Parse properties. */
7877 while (CONSP (item
) && CONSP (XCDR (item
)))
7882 if (EQ (tem
, QCenable
))
7884 if (!NILP (Venable_disabled_menus_and_buttons
))
7885 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7887 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7889 else if (EQ (tem
, QCvisible
) && !notreal
)
7891 /* If got a visible property and that evaluates to nil
7892 then ignore this item. */
7893 tem
= menu_item_eval_property (XCAR (item
));
7897 else if (EQ (tem
, QChelp
))
7898 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7899 else if (EQ (tem
, QCfilter
))
7901 else if (EQ (tem
, QCkey_sequence
))
7904 if (NILP (cachelist
)
7905 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7906 /* Be GC protected. Set keyhint to item instead of tem. */
7909 else if (EQ (tem
, QCkeys
))
7912 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7913 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7915 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7920 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7922 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7924 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7930 else if (inmenubar
|| !NILP (start
))
7934 return 0; /* not a menu item */
7936 /* If item string is not a string, evaluate it to get string.
7937 If we don't get a string, skip this item. */
7938 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7939 if (!(STRINGP (item_string
) || notreal
))
7941 item_string
= menu_item_eval_property (item_string
);
7942 if (!STRINGP (item_string
))
7944 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7947 /* If got a filter apply it on definition. */
7948 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7951 def
= menu_item_eval_property (list2 (XCAR (filter
),
7952 list2 (Qquote
, def
)));
7954 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7957 /* Enable or disable selection of item. */
7958 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7964 tem
= menu_item_eval_property (tem
);
7965 if (inmenubar
&& NILP (tem
))
7966 return 0; /* Ignore disabled items in menu bar. */
7967 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7970 /* If we got no definition, this item is just unselectable text which
7971 is OK in a submenu but not in the menubar. */
7973 return (inmenubar
? 0 : 1);
7975 /* See if this is a separate pane or a submenu. */
7976 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7977 tem
= get_keymap (def
, 0, 1);
7978 /* For a subkeymap, just record its details and exit. */
7981 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7982 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7986 /* At the top level in the menu bar, do likewise for commands also.
7987 The menu bar does not display equivalent key bindings anyway.
7988 ITEM_PROPERTY_DEF is already set up properly. */
7992 /* This is a command. See if there is an equivalent key binding. */
7993 if (NILP (cachelist
))
7995 /* We have to create a cachelist. */
7996 /* With the introduction of where_is_cache, the computation
7997 of equivalent key bindings is sufficiently fast that we
7998 do not need to cache it here any more. */
7999 /* CHECK_IMPURE (start);
8000 XSETCDR (start, Fcons (Fcons (Qnil, Qnil), XCDR (start)));
8001 cachelist = XCAR (XCDR (start)); */
8002 cachelist
= Fcons (Qnil
, Qnil
);
8004 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
8005 if (!NILP (keyhint
))
8007 XSETCAR (cachelist
, XCAR (keyhint
));
8010 else if (STRINGP (tem
))
8012 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
8013 XSETCAR (cachelist
, Qt
);
8017 tem
= XCAR (cachelist
);
8024 tem
= Fkey_binding (tem
, Qnil
, Qnil
, Qnil
);
8026 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
8029 def
= XCAR (prefix
);
8030 prefix
= XCDR (prefix
);
8033 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8035 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
8037 if (newcache
/* Always check first time. */
8038 /* Should we check everything when precomputing key
8040 /* If something had no key binding before, don't recheck it
8041 because that is too slow--except if we have a list of
8042 rebound commands in Vdefine_key_rebound_commands, do
8043 recheck any command that appears in that list. */
8044 || (CONSP (Vdefine_key_rebound_commands
)
8045 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
8048 /* We had a saved key. Is it still bound to the command? */
8051 /* If the command is an alias for another
8052 (such as lmenu.el set it up), check if the
8053 original command matches the cached command. */
8054 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
8055 chkcache
= 1; /* Need to recompute key binding. */
8059 /* Recompute equivalent key binding. If the command is an alias
8060 for another (such as lmenu.el set it up), see if the original
8061 command name has equivalent keys. Otherwise look up the
8062 specified command itself. We don't try both, because that
8063 makes lmenu menus slow. */
8065 && SYMBOLP (XSYMBOL (def
)->function
)
8066 && ! NILP (Fget (def
, Qmenu_alias
)))
8067 def
= XSYMBOL (def
)->function
;
8069 /* prefer 'super' bindings */
8070 tem
= Fwhere_is_internal (def
, Qnil
, Qsuper
, Qt
, Qt
);
8072 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
8074 XSETCAR (cachelist
, tem
);
8077 XSETCDR (cachelist
, Qnil
);
8081 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
8083 tem
= XCAR (cachelist
);
8087 newcache
= chkcache
;
8090 tem
= Fkey_description (tem
, Qnil
);
8093 if (STRINGP (XCAR (prefix
)))
8094 tem
= concat2 (XCAR (prefix
), tem
);
8095 if (STRINGP (XCDR (prefix
)))
8096 tem
= concat2 (tem
, XCDR (prefix
));
8098 XSETCDR (cachelist
, tem
);
8102 tem
= XCDR (cachelist
);
8103 if (newcache
&& !NILP (tem
))
8105 tem
= concat2 (build_string (" "), tem
);
8106 /* tem = concat3 (build_string (" ("), tem, build_string (")")); */
8107 XSETCDR (cachelist
, tem
);
8110 /* If we only want to precompute equivalent key bindings, stop here. */
8114 /* If we have an equivalent key binding, use that. */
8115 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
8117 /* Include this when menu help is implemented.
8118 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
8119 if (!(NILP (tem) || STRINGP (tem)))
8121 tem = menu_item_eval_property (tem);
8124 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8128 /* Handle radio buttons or toggle boxes. */
8129 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8131 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8132 menu_item_eval_property (tem
));
8139 /***********************************************************************
8141 ***********************************************************************/
8143 /* A vector holding tool bar items while they are parsed in function
8144 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8147 static Lisp_Object tool_bar_items_vector
;
8149 /* A vector holding the result of parse_tool_bar_item. Layout is like
8150 the one for a single item in tool_bar_items_vector. */
8152 static Lisp_Object tool_bar_item_properties
;
8154 /* Next free index in tool_bar_items_vector. */
8156 static int ntool_bar_items
;
8158 /* The symbols `tool-bar', `:image' and `:rtl'. */
8160 extern Lisp_Object Qtool_bar
;
8161 Lisp_Object QCimage
;
8164 /* Function prototypes. */
8166 static void init_tool_bar_items
P_ ((Lisp_Object
));
8167 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
8168 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
8169 static void append_tool_bar_item
P_ ((void));
8172 /* Return a vector of tool bar items for keymaps currently in effect.
8173 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8174 tool bar items found. */
8177 tool_bar_items (reuse
, nitems
)
8188 /* In order to build the menus, we need to call the keymap
8189 accessors. They all call QUIT. But this function is called
8190 during redisplay, during which a quit is fatal. So inhibit
8191 quitting while building the menus. We do this instead of
8192 specbind because (1) errors will clear it anyway and (2) this
8193 avoids risk of specpdl overflow. */
8194 oquit
= Vinhibit_quit
;
8197 /* Initialize tool_bar_items_vector and protect it from GC. */
8198 init_tool_bar_items (reuse
);
8200 /* Build list of keymaps in maps. Set nmaps to the number of maps
8203 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8204 if (!NILP (Voverriding_local_map_menu_flag
))
8206 /* Yes, use them (if non-nil) as well as the global map. */
8207 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8209 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8210 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8211 if (!NILP (Voverriding_local_map
))
8212 maps
[nmaps
++] = Voverriding_local_map
;
8216 /* No, so use major and minor mode keymaps and keymap property.
8217 Note that tool-bar bindings in the local-map and keymap
8218 properties may not work reliable, as they are only
8219 recognized when the tool-bar (or mode-line) is updated,
8220 which does not normally happen after every command. */
8223 nminor
= current_minor_maps (NULL
, &tmaps
);
8224 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8226 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8227 maps
[nmaps
++] = tem
;
8228 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
8230 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8233 /* Add global keymap at the end. */
8234 maps
[nmaps
++] = current_global_map
;
8236 /* Process maps in reverse order and look up in each map the prefix
8238 for (i
= nmaps
- 1; i
>= 0; --i
)
8239 if (!NILP (maps
[i
]))
8243 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8245 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8248 Vinhibit_quit
= oquit
;
8249 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8250 return tool_bar_items_vector
;
8254 /* Process the definition of KEY which is DEF. */
8257 process_tool_bar_item (key
, def
, data
, args
)
8258 Lisp_Object key
, def
, data
;
8262 extern Lisp_Object Qundefined
;
8263 struct gcpro gcpro1
, gcpro2
;
8265 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8269 if (EQ (def
, Qundefined
))
8271 /* If a map has an explicit `undefined' as definition,
8272 discard any previously made item. */
8273 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8275 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8277 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8279 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8280 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
8281 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8282 * sizeof (Lisp_Object
)));
8283 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8288 else if (parse_tool_bar_item (key
, def
))
8289 /* Append a new tool bar item to tool_bar_items_vector. Accept
8290 more than one definition for the same key. */
8291 append_tool_bar_item ();
8297 /* Parse a tool bar item specification ITEM for key KEY and return the
8298 result in tool_bar_item_properties. Value is zero if ITEM is
8301 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8303 CAPTION is the caption of the item, If it's not a string, it is
8304 evaluated to get a string.
8306 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8307 as binding are currently ignored.
8309 The following properties are recognized:
8313 FORM is evaluated and specifies whether the tool bar item is
8314 enabled or disabled.
8318 FORM is evaluated and specifies whether the tool bar item is visible.
8320 - `:filter FUNCTION'
8322 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8323 result is stored as the new binding.
8325 - `:button (TYPE SELECTED)'
8327 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8328 and specifies whether the button is selected (pressed) or not.
8332 IMAGES is either a single image specification or a vector of four
8333 image specifications. See enum tool_bar_item_images.
8335 - `:help HELP-STRING'.
8337 Gives a help string to display for the tool bar item. */
8340 parse_tool_bar_item (key
, item
)
8341 Lisp_Object key
, item
;
8343 /* Access slot with index IDX of vector tool_bar_item_properties. */
8344 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8346 Lisp_Object filter
= Qnil
;
8347 Lisp_Object caption
;
8350 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8351 Rule out items that aren't lists, don't start with
8352 `menu-item' or whose rest following `tool-bar-item' is not a
8355 || !EQ (XCAR (item
), Qmenu_item
)
8356 || (item
= XCDR (item
),
8360 /* Create tool_bar_item_properties vector if necessary. Reset it to
8362 if (VECTORP (tool_bar_item_properties
))
8364 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8368 tool_bar_item_properties
8369 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8372 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8373 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8375 /* Get the caption of the item. If the caption is not a string,
8376 evaluate it to get a string. If we don't get a string, skip this
8378 caption
= XCAR (item
);
8379 if (!STRINGP (caption
))
8381 caption
= menu_item_eval_property (caption
);
8382 if (!STRINGP (caption
))
8385 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8387 /* Give up if rest following the caption is not a list. */
8392 /* Store the binding. */
8393 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8396 /* Ignore cached key binding, if any. */
8397 if (CONSP (item
) && CONSP (XCAR (item
)))
8400 /* Process the rest of the properties. */
8401 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8403 Lisp_Object key
, value
;
8406 value
= XCAR (XCDR (item
));
8408 if (EQ (key
, QCenable
))
8410 /* `:enable FORM'. */
8411 if (!NILP (Venable_disabled_menus_and_buttons
))
8412 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8414 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8416 else if (EQ (key
, QCvisible
))
8418 /* `:visible FORM'. If got a visible property and that
8419 evaluates to nil then ignore this item. */
8420 if (NILP (menu_item_eval_property (value
)))
8423 else if (EQ (key
, QChelp
))
8424 /* `:help HELP-STRING'. */
8425 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8426 else if (EQ (key
, QCfilter
))
8427 /* ':filter FORM'. */
8429 else if (EQ (key
, QCbutton
) && CONSP (value
))
8431 /* `:button (TYPE . SELECTED)'. */
8432 Lisp_Object type
, selected
;
8434 type
= XCAR (value
);
8435 selected
= XCDR (value
);
8436 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8438 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8439 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8442 else if (EQ (key
, QCimage
)
8444 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8445 /* Value is either a single image specification or a vector
8446 of 4 such specifications for the different button states. */
8447 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8448 else if (EQ (key
, Qrtl
))
8450 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8453 /* If got a filter apply it on binding. */
8455 PROP (TOOL_BAR_ITEM_BINDING
)
8456 = menu_item_eval_property (list2 (filter
,
8458 PROP (TOOL_BAR_ITEM_BINDING
))));
8460 /* See if the binding is a keymap. Give up if it is. */
8461 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8464 /* Enable or disable selection of item. */
8465 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8466 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8467 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8469 /* Handle radio buttons or toggle boxes. */
8470 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8471 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8472 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8480 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8481 that can be reused. */
8484 init_tool_bar_items (reuse
)
8487 if (VECTORP (reuse
))
8488 tool_bar_items_vector
= reuse
;
8490 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8491 ntool_bar_items
= 0;
8495 /* Append parsed tool bar item properties from
8496 tool_bar_item_properties */
8499 append_tool_bar_item ()
8501 Lisp_Object
*to
, *from
;
8503 /* Enlarge tool_bar_items_vector if necessary. */
8504 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8505 >= XVECTOR (tool_bar_items_vector
)->size
)
8506 tool_bar_items_vector
8507 = larger_vector (tool_bar_items_vector
,
8508 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8510 /* Append entries from tool_bar_item_properties to the end of
8511 tool_bar_items_vector. */
8512 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8513 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8514 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8515 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8522 /* Read a character using menus based on maps in the array MAPS.
8523 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8524 Return t if we displayed a menu but the user rejected it.
8526 PREV_EVENT is the previous input event, or nil if we are reading
8527 the first event of a key sequence.
8529 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8530 if we used a mouse menu to read the input, or zero otherwise. If
8531 USED_MOUSE_MENU is null, we don't dereference it.
8533 The prompting is done based on the prompt-string of the map
8534 and the strings associated with various map elements.
8536 This can be done with X menus or with menus put in the minibuf.
8537 These are done in different ways, depending on how the input will be read.
8538 Menus using X are done after auto-saving in read-char, getting the input
8539 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8540 and do auto-saving in the inner call of read_char. */
8543 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8546 Lisp_Object prev_event
;
8547 int *used_mouse_menu
;
8550 register Lisp_Object name
= Qnil
;
8552 if (used_mouse_menu
)
8553 *used_mouse_menu
= 0;
8555 /* Use local over global Menu maps */
8557 if (! menu_prompting
)
8560 /* Optionally disregard all but the global map. */
8561 if (inhibit_local_menu_bar_menus
)
8563 maps
+= (nmaps
- 1);
8567 /* Get the menu name from the first map that has one (a prompt string). */
8568 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8570 name
= Fkeymap_prompt (maps
[mapno
]);
8575 /* If we don't have any menus, just read a character normally. */
8576 if (!STRINGP (name
))
8580 /* If we got to this point via a mouse click,
8581 use a real menu for mouse selection. */
8582 if (EVENT_HAS_PARAMETERS (prev_event
)
8583 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8584 && !EQ (XCAR (prev_event
), Qtool_bar
))
8586 /* Display the menu and get the selection. */
8587 Lisp_Object
*realmaps
8588 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8592 /* Use the maps that are not nil. */
8593 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8594 if (!NILP (maps
[mapno
]))
8595 realmaps
[nmaps1
++] = maps
[mapno
];
8597 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8602 record_menu_key (XCAR (value
));
8604 /* If we got multiple events, unread all but
8606 There is no way to prevent those unread events
8607 from showing up later in last_nonmenu_event.
8608 So turn symbol and integer events into lists,
8609 to indicate that they came from a mouse menu,
8610 so that when present in last_nonmenu_event
8611 they won't confuse things. */
8612 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8614 record_menu_key (XCAR (tem
));
8615 if (SYMBOLP (XCAR (tem
))
8616 || INTEGERP (XCAR (tem
)))
8617 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8620 /* If we got more than one event, put all but the first
8621 onto this list to be read later.
8622 Return just the first event now. */
8623 Vunread_command_events
8624 = nconc2 (XCDR (value
), Vunread_command_events
);
8625 value
= XCAR (value
);
8627 else if (NILP (value
))
8629 if (used_mouse_menu
)
8630 *used_mouse_menu
= 1;
8633 #endif /* HAVE_MENUS */
8637 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8638 We make this bigger when necessary, and never free it. */
8639 static char *read_char_minibuf_menu_text
;
8640 /* Size of that buffer. */
8641 static int read_char_minibuf_menu_width
;
8644 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8650 register Lisp_Object name
;
8652 /* FIXME: Use the minibuffer's frame width. */
8653 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8656 Lisp_Object rest
, vector
;
8662 if (! menu_prompting
)
8665 /* Make sure we have a big enough buffer for the menu text. */
8666 if (read_char_minibuf_menu_text
== 0)
8668 read_char_minibuf_menu_width
= width
+ 4;
8669 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8671 else if (width
+ 4 > read_char_minibuf_menu_width
)
8673 read_char_minibuf_menu_width
= width
+ 4;
8674 read_char_minibuf_menu_text
8675 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8677 menu
= read_char_minibuf_menu_text
;
8679 /* Get the menu name from the first map that has one (a prompt string). */
8680 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8682 name
= Fkeymap_prompt (maps
[mapno
]);
8687 /* If we don't have any menus, just read a character normally. */
8688 if (!STRINGP (name
))
8691 /* Prompt string always starts with map's prompt, and a space. */
8692 strcpy (menu
, SDATA (name
));
8693 nlength
= SBYTES (name
);
8694 menu
[nlength
++] = ':';
8695 menu
[nlength
++] = ' ';
8698 /* Start prompting at start of first map. */
8702 /* Present the documented bindings, a line at a time. */
8709 Lisp_Object orig_defn_macro
;
8711 /* Loop over elements of map. */
8716 /* If reached end of map, start at beginning of next map. */
8720 /* At end of last map, wrap around to first map if just starting,
8721 or end this line if already have something on it. */
8725 if (notfirst
|| nobindings
) break;
8730 /* Look at the next element of the map. */
8732 elt
= XVECTOR (vector
)->contents
[idx
];
8734 elt
= Fcar_safe (rest
);
8736 if (idx
< 0 && VECTORP (elt
))
8738 /* If we found a dense table in the keymap,
8739 advanced past it, but start scanning its contents. */
8740 rest
= Fcdr_safe (rest
);
8746 /* An ordinary element. */
8747 Lisp_Object event
, tem
;
8751 event
= Fcar_safe (elt
); /* alist */
8752 elt
= Fcdr_safe (elt
);
8756 XSETINT (event
, idx
); /* vector */
8759 /* Ignore the element if it has no prompt string. */
8760 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8762 /* 1 if the char to type matches the string. */
8764 Lisp_Object upcased_event
, downcased_event
;
8765 Lisp_Object desc
= Qnil
;
8767 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8769 upcased_event
= Fupcase (event
);
8770 downcased_event
= Fdowncase (event
);
8771 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8772 || XINT (downcased_event
) == SREF (s
, 0));
8774 desc
= Fsingle_key_description (event
, Qnil
);
8776 #if 0 /* It is redundant to list the equivalent key bindings because
8777 the prefix is what the user has already typed. */
8779 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8781 /* Insert equivalent keybinding. */
8782 s
= concat2 (s
, tem
);
8785 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8786 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8788 /* Insert button prefix. */
8789 Lisp_Object selected
8790 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8791 if (EQ (tem
, QCradio
))
8792 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8794 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8795 s
= concat2 (tem
, s
);
8799 /* If we have room for the prompt string, add it to this line.
8800 If this is the first on the line, always add it. */
8801 if ((SCHARS (s
) + i
+ 2
8802 + (char_matches
? 0 : SCHARS (desc
) + 3))
8808 /* Punctuate between strings. */
8811 strcpy (menu
+ i
, ", ");
8817 /* If the char to type doesn't match the string's
8818 first char, explicitly show what char to type. */
8821 /* Add as much of string as fits. */
8822 thiswidth
= SCHARS (desc
);
8823 if (thiswidth
+ i
> width
)
8824 thiswidth
= width
- i
;
8825 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8827 strcpy (menu
+ i
, " = ");
8831 /* Add as much of string as fits. */
8832 thiswidth
= SCHARS (s
);
8833 if (thiswidth
+ i
> width
)
8834 thiswidth
= width
- i
;
8835 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8841 /* If this element does not fit, end the line now,
8842 and save the element for the next line. */
8843 strcpy (menu
+ i
, "...");
8848 /* Move past this element. */
8849 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8850 /* Handle reaching end of dense table. */
8855 rest
= Fcdr_safe (rest
);
8859 /* Prompt with that and read response. */
8860 message2_nolog (menu
, strlen (menu
),
8861 ! NILP (current_buffer
->enable_multibyte_characters
));
8863 /* Make believe its not a keyboard macro in case the help char
8864 is pressed. Help characters are not recorded because menu prompting
8865 is not used on replay.
8867 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8868 current_kboard
->defining_kbd_macro
= Qnil
;
8870 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8871 while (BUFFERP (obj
));
8872 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8874 if (!INTEGERP (obj
))
8876 else if (XINT (obj
) == -2)
8881 if (! EQ (obj
, menu_prompt_more_char
)
8882 && (!INTEGERP (menu_prompt_more_char
)
8883 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8885 if (!NILP (current_kboard
->defining_kbd_macro
))
8886 store_kbd_macro_char (obj
);
8889 /* Help char - go round again */
8893 /* Reading key sequences. */
8895 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8896 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8897 keymap, or nil otherwise. Return the index of the first keymap in
8898 which KEY has any binding, or NMAPS if no map has a binding.
8900 If KEY is a meta ASCII character, treat it like meta-prefix-char
8901 followed by the corresponding non-meta character. Keymaps in
8902 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8905 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8908 NEXT may be the same array as CURRENT. */
8911 follow_key (key
, nmaps
, current
, defs
, next
)
8913 Lisp_Object
*current
, *defs
, *next
;
8916 int i
, first_binding
;
8918 first_binding
= nmaps
;
8919 for (i
= nmaps
- 1; i
>= 0; i
--)
8921 if (! NILP (current
[i
]))
8923 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8924 if (! NILP (defs
[i
]))
8931 /* Given the set of bindings we've found, produce the next set of maps. */
8932 if (first_binding
< nmaps
)
8933 for (i
= 0; i
< nmaps
; i
++)
8934 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8936 return first_binding
;
8939 /* Structure used to keep track of partial application of key remapping
8940 such as Vfunction_key_map and Vkey_translation_map. */
8941 typedef struct keyremap
8943 /* This is the map originally specified for this use. */
8945 /* This is a submap reached by looking up, in PARENT,
8946 the events from START to END. */
8948 /* Positions [START, END) in the key sequence buffer
8949 are the key that we have scanned so far.
8950 Those events are the ones that we will replace
8951 if PAREHT maps them into a key sequence. */
8955 /* Lookup KEY in MAP.
8956 MAP is a keymap mapping keys to key vectors or functions.
8957 If the mapping is a function and DO_FUNCTION is non-zero, then
8958 the function is called with PROMPT as parameter and its return
8959 value is used as the return value of this function (after checking
8960 that it is indeed a vector). */
8963 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8964 Lisp_Object map
, key
, prompt
;
8969 next
= access_keymap (map
, key
, 1, 0, 1);
8971 /* Handle symbol with autoload definition. */
8972 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8973 && CONSP (XSYMBOL (next
)->function
)
8974 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8975 do_autoload (XSYMBOL (next
)->function
, next
);
8977 /* Handle a symbol whose function definition is a keymap
8979 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8980 && (ARRAYP (XSYMBOL (next
)->function
)
8981 || KEYMAPP (XSYMBOL (next
)->function
)))
8982 next
= XSYMBOL (next
)->function
;
8984 /* If the keymap gives a function, not an
8985 array, then call the function with one arg and use
8986 its value instead. */
8987 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8992 next
= call1 (next
, prompt
);
8993 /* If the function returned something invalid,
8994 barf--don't ignore it.
8995 (To ignore it safely, we would need to gcpro a bunch of
8996 other variables.) */
8997 if (! (VECTORP (next
) || STRINGP (next
)))
8998 error ("Function %s returns invalid key sequence", tem
);
9003 /* Do one step of the key remapping used for function-key-map and
9004 key-translation-map:
9005 KEYBUF is the buffer holding the input events.
9006 BUFSIZE is its maximum size.
9007 FKEY is a pointer to the keyremap structure to use.
9008 INPUT is the index of the last element in KEYBUF.
9009 DOIT if non-zero says that the remapping can actually take place.
9010 DIFF is used to return the number of keys added/removed by the remapping.
9011 PARENT is the root of the keymap.
9012 PROMPT is the prompt to use if the remapping happens through a function.
9013 The return value is non-zero if the remapping actually took place. */
9016 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
9017 Lisp_Object
*keybuf
, prompt
;
9019 int input
, doit
, *diff
, bufsize
;
9021 Lisp_Object next
, key
;
9023 key
= keybuf
[fkey
->end
++];
9025 if (KEYMAPP (fkey
->parent
))
9026 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
9030 /* If keybuf[fkey->start..fkey->end] is bound in the
9031 map and we're in a position to do the key remapping, replace it with
9032 the binding and restart with fkey->start at the end. */
9033 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
9035 int len
= XFASTINT (Flength (next
));
9038 *diff
= len
- (fkey
->end
- fkey
->start
);
9040 if (input
+ *diff
>= bufsize
)
9041 error ("Key sequence too long");
9043 /* Shift the keys that follow fkey->end. */
9045 for (i
= fkey
->end
; i
< input
; i
++)
9046 keybuf
[i
+ *diff
] = keybuf
[i
];
9048 for (i
= input
- 1; i
>= fkey
->end
; i
--)
9049 keybuf
[i
+ *diff
] = keybuf
[i
];
9050 /* Overwrite the old keys with the new ones. */
9051 for (i
= 0; i
< len
; i
++)
9052 keybuf
[fkey
->start
+ i
]
9053 = Faref (next
, make_number (i
));
9055 fkey
->start
= fkey
->end
+= *diff
;
9056 fkey
->map
= fkey
->parent
;
9061 fkey
->map
= get_keymap (next
, 0, 1);
9063 /* If we no longer have a bound suffix, try a new position for
9065 if (!CONSP (fkey
->map
))
9067 fkey
->end
= ++fkey
->start
;
9068 fkey
->map
= fkey
->parent
;
9073 /* Read a sequence of keys that ends with a non prefix character,
9074 storing it in KEYBUF, a buffer of size BUFSIZE.
9076 Return the length of the key sequence stored.
9077 Return -1 if the user rejected a command menu.
9079 Echo starting immediately unless `prompt' is 0.
9081 Where a key sequence ends depends on the currently active keymaps.
9082 These include any minor mode keymaps active in the current buffer,
9083 the current buffer's local map, and the global map.
9085 If a key sequence has no other bindings, we check Vfunction_key_map
9086 to see if some trailing subsequence might be the beginning of a
9087 function key's sequence. If so, we try to read the whole function
9088 key, and substitute its symbolic name into the key sequence.
9090 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9091 `double-' events into similar click events, if that would make them
9092 bound. We try to turn `triple-' events first into `double-' events,
9095 If we get a mouse click in a mode line, vertical divider, or other
9096 non-text area, we treat the click as if it were prefixed by the
9097 symbol denoting that area - `mode-line', `vertical-line', or
9100 If the sequence starts with a mouse click, we read the key sequence
9101 with respect to the buffer clicked on, not the current buffer.
9103 If the user switches frames in the midst of a key sequence, we put
9104 off the switch-frame event until later; the next call to
9105 read_char will return it.
9107 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9108 from the selected window's buffer. */
9111 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
9112 can_return_switch_frame
, fix_current_buffer
)
9113 Lisp_Object
*keybuf
;
9116 int dont_downcase_last
;
9117 int can_return_switch_frame
;
9118 int fix_current_buffer
;
9120 volatile Lisp_Object from_string
;
9121 volatile int count
= SPECPDL_INDEX ();
9123 /* How many keys there are in the current key sequence. */
9126 /* The length of the echo buffer when we started reading, and
9127 the length of this_command_keys when we started reading. */
9128 volatile int echo_start
;
9129 volatile int keys_start
;
9131 /* The number of keymaps we're scanning right now, and the number of
9132 keymaps we have allocated space for. */
9134 volatile int nmaps_allocated
= 0;
9136 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9137 the current keymaps. */
9138 Lisp_Object
*volatile defs
= NULL
;
9140 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9141 in the current keymaps, or nil where it is not a prefix. */
9142 Lisp_Object
*volatile submaps
= NULL
;
9144 /* The local map to start out with at start of key sequence. */
9145 volatile Lisp_Object orig_local_map
;
9147 /* The map from the `keymap' property to start out with at start of
9149 volatile Lisp_Object orig_keymap
;
9151 /* 1 if we have already considered switching to the local-map property
9152 of the place where a mouse click occurred. */
9153 volatile int localized_local_map
= 0;
9155 /* The index in submaps[] of the first keymap that has a binding for
9156 this key sequence. In other words, the lowest i such that
9157 submaps[i] is non-nil. */
9158 volatile int first_binding
;
9159 /* Index of the first key that has no binding.
9160 It is useless to try fkey.start larger than that. */
9161 volatile int first_unbound
;
9163 /* If t < mock_input, then KEYBUF[t] should be read as the next
9166 We use this to recover after recognizing a function key. Once we
9167 realize that a suffix of the current key sequence is actually a
9168 function key's escape sequence, we replace the suffix with the
9169 function key's binding from Vfunction_key_map. Now keybuf
9170 contains a new and different key sequence, so the echo area,
9171 this_command_keys, and the submaps and defs arrays are wrong. In
9172 this situation, we set mock_input to t, set t to 0, and jump to
9173 restart_sequence; the loop will read keys from keybuf up until
9174 mock_input, thus rebuilding the state; and then it will resume
9175 reading characters from the keyboard. */
9176 volatile int mock_input
= 0;
9178 /* If the sequence is unbound in submaps[], then
9179 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9180 and fkey.map is its binding.
9182 These might be > t, indicating that all function key scanning
9183 should hold off until t reaches them. We do this when we've just
9184 recognized a function key, to avoid searching for the function
9185 key's again in Vfunction_key_map. */
9186 volatile keyremap fkey
;
9188 /* Likewise, for key_translation_map and input-decode-map. */
9189 volatile keyremap keytran
, indec
;
9191 /* Non-zero if we are trying to map a key by changing an upper-case
9192 letter to lower case, or a shifted function key to an unshifted
9194 volatile int shift_translated
= 0;
9196 /* If we receive a `switch-frame' or `select-window' event in the middle of
9197 a key sequence, we put it off for later.
9198 While we're reading, we keep the event here. */
9199 volatile Lisp_Object delayed_switch_frame
;
9201 /* See the comment below... */
9202 #if defined (GOBBLE_FIRST_EVENT)
9203 Lisp_Object first_event
;
9206 volatile Lisp_Object original_uppercase
;
9207 volatile int original_uppercase_position
= -1;
9209 /* Gets around Microsoft compiler limitations. */
9212 struct buffer
*starting_buffer
;
9214 /* List of events for which a fake prefix key has been generated. */
9215 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
9217 #if defined (GOBBLE_FIRST_EVENT)
9221 struct gcpro gcpro1
;
9223 GCPRO1 (fake_prefixed_keys
);
9224 raw_keybuf_count
= 0;
9226 last_nonmenu_event
= Qnil
;
9228 delayed_switch_frame
= Qnil
;
9233 echo_prompt (prompt
);
9234 else if (cursor_in_echo_area
9235 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9236 && NILP (Fzerop (Vecho_keystrokes
)))
9237 /* This doesn't put in a dash if the echo buffer is empty, so
9238 you don't always see a dash hanging out in the minibuffer. */
9242 /* Record the initial state of the echo area and this_command_keys;
9243 we will need to restore them if we replay a key sequence. */
9245 echo_start
= echo_length ();
9246 keys_start
= this_command_key_count
;
9247 this_single_command_key_start
= keys_start
;
9249 #if defined (GOBBLE_FIRST_EVENT)
9250 /* This doesn't quite work, because some of the things that read_char
9251 does cannot safely be bypassed. It seems too risky to try to make
9254 /* Read the first char of the sequence specially, before setting
9255 up any keymaps, in case a filter runs and switches buffers on us. */
9256 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9258 #endif /* GOBBLE_FIRST_EVENT */
9260 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9261 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9264 /* The multi-tty merge moved the code below to right after
9265 `replay_sequence' which caused all these translation maps to be applied
9266 repeatedly, even tho their doc says very clearly they are not applied to
9268 The reason for this move was: "We may switch keyboards between rescans,
9269 so we need to reinitialize fkey and keytran before each replay".
9270 This move was wrong (even if we switch keyboards, keybuf still holds the
9271 keys we've read already from the original keyboard and some of those keys
9272 may have already been translated). So there may still be a bug out there
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. */
9452 KBOARD
*interrupted_kboard
= current_kboard
;
9453 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9455 key
= read_char (NILP (prompt
), nmaps
,
9456 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9457 &used_mouse_menu
, NULL
);
9459 if (INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9464 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9465 if (k
== interrupted_kboard
)
9470 /* Don't touch interrupted_kboard when it's been
9472 delayed_switch_frame
= Qnil
;
9473 goto replay_sequence
;
9476 if (!NILP (delayed_switch_frame
))
9478 interrupted_kboard
->kbd_queue
9479 = Fcons (delayed_switch_frame
,
9480 interrupted_kboard
->kbd_queue
);
9481 delayed_switch_frame
= Qnil
;
9485 interrupted_kboard
->kbd_queue
9486 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9488 /* If the side queue is non-empty, ensure it begins with a
9489 switch-frame, so we'll replay it in the right context. */
9490 if (CONSP (interrupted_kboard
->kbd_queue
)
9491 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9492 !(EVENT_HAS_PARAMETERS (key
)
9493 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9497 XSETFRAME (frame
, interrupted_frame
);
9498 interrupted_kboard
->kbd_queue
9499 = Fcons (make_lispy_switch_frame (frame
),
9500 interrupted_kboard
->kbd_queue
);
9503 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9504 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9505 goto replay_sequence
;
9510 /* read_char returns t when it shows a menu and the user rejects it.
9514 unbind_to (count
, Qnil
);
9519 /* read_char returns -1 at the end of a macro.
9520 Emacs 18 handles this by returning immediately with a
9521 zero, so that's what we'll do. */
9522 if (INTEGERP (key
) && XINT (key
) == -1)
9525 /* The Microsoft C compiler can't handle the goto that
9531 /* If the current buffer has been changed from under us, the
9532 keymap may have changed, so replay the sequence. */
9535 timer_resume_idle ();
9538 /* Reset the current buffer from the selected window
9539 in case something changed the former and not the latter.
9540 This is to be more consistent with the behavior
9541 of the command_loop_1. */
9542 if (fix_current_buffer
)
9544 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9546 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9547 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9550 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9551 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9552 goto replay_sequence
;
9555 /* If we have a quit that was typed in another frame, and
9556 quit_throw_to_read_char switched buffers,
9557 replay to get the right keymap. */
9559 && XINT (key
) == quit_char
9560 && current_buffer
!= starting_buffer
)
9563 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9567 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9568 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9569 goto replay_sequence
;
9574 if (EVENT_HAS_PARAMETERS (key
)
9575 /* Either a `switch-frame' or a `select-window' event. */
9576 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9578 /* If we're at the beginning of a key sequence, and the caller
9579 says it's okay, go ahead and return this event. If we're
9580 in the midst of a key sequence, delay it until the end. */
9581 if (t
> 0 || !can_return_switch_frame
)
9583 delayed_switch_frame
= key
;
9589 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9593 /* Clicks in non-text areas get prefixed by the symbol
9594 in their CHAR-ADDRESS field. For example, a click on
9595 the mode line is prefixed by the symbol `mode-line'.
9597 Furthermore, key sequences beginning with mouse clicks
9598 are read using the keymaps of the buffer clicked on, not
9599 the current buffer. So we may have to switch the buffer
9602 When we turn one event into two events, we must make sure
9603 that neither of the two looks like the original--so that,
9604 if we replay the events, they won't be expanded again.
9605 If not for this, such reexpansion could happen either here
9606 or when user programs play with this-command-keys. */
9607 if (EVENT_HAS_PARAMETERS (key
))
9612 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9613 if (EQ (kind
, Qmouse_click
))
9615 Lisp_Object window
, posn
;
9617 window
= POSN_WINDOW (EVENT_START (key
));
9618 posn
= POSN_POSN (EVENT_START (key
));
9621 || (!NILP (fake_prefixed_keys
)
9622 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9624 /* We're looking a second time at an event for which
9625 we generated a fake prefix key. Set
9626 last_real_key_start appropriately. */
9628 last_real_key_start
= t
- 1;
9631 /* Key sequences beginning with mouse clicks are
9632 read using the keymaps in the buffer clicked on,
9633 not the current buffer. If we're at the
9634 beginning of a key sequence, switch buffers. */
9635 if (last_real_key_start
== 0
9637 && BUFFERP (XWINDOW (window
)->buffer
)
9638 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9640 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9644 /* Arrange to go back to the original buffer once we're
9645 done reading the key sequence. Note that we can't
9646 use save_excursion_{save,restore} here, because they
9647 save point as well as the current buffer; we don't
9648 want to save point, because redisplay may change it,
9649 to accommodate a Fset_window_start or something. We
9650 don't want to do this at the top of the function,
9651 because we may get input from a subprocess which
9652 wants to change the selected window and stuff (say,
9654 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9656 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9658 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9659 orig_local_map
= get_local_map (PT
, current_buffer
,
9661 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9662 goto replay_sequence
;
9665 /* For a mouse click, get the local text-property keymap
9666 of the place clicked on, rather than point. */
9667 if (last_real_key_start
== 0
9668 && CONSP (XCDR (key
))
9669 && ! localized_local_map
)
9671 Lisp_Object map_here
, start
, pos
;
9673 localized_local_map
= 1;
9674 start
= EVENT_START (key
);
9676 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9678 pos
= POSN_BUFFER_POSN (start
);
9680 && XINT (pos
) >= BEGV
9681 && XINT (pos
) <= ZV
)
9683 map_here
= get_local_map (XINT (pos
),
9684 current_buffer
, Qlocal_map
);
9685 if (!EQ (map_here
, orig_local_map
))
9687 orig_local_map
= map_here
;
9688 ++localized_local_map
;
9691 map_here
= get_local_map (XINT (pos
),
9692 current_buffer
, Qkeymap
);
9693 if (!EQ (map_here
, orig_keymap
))
9695 orig_keymap
= map_here
;
9696 ++localized_local_map
;
9699 if (localized_local_map
> 1)
9704 goto replay_sequence
;
9710 /* Expand mode-line and scroll-bar events into two events:
9711 use posn as a fake prefix key. */
9713 && (NILP (fake_prefixed_keys
)
9714 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9716 if (t
+ 1 >= bufsize
)
9717 error ("Key sequence too long");
9720 keybuf
[t
+ 1] = key
;
9723 /* Record that a fake prefix key has been generated
9724 for KEY. Don't modify the event; this would
9725 prevent proper action when the event is pushed
9726 back into unread-command-events. */
9727 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9729 /* If on a mode line string with a local keymap,
9730 reconsider the key sequence with that keymap. */
9731 if (string
= POSN_STRING (EVENT_START (key
)),
9732 (CONSP (string
) && STRINGP (XCAR (string
))))
9734 Lisp_Object pos
, map
, map2
;
9736 pos
= XCDR (string
);
9737 string
= XCAR (string
);
9739 && XINT (pos
) < SCHARS (string
))
9741 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9743 orig_local_map
= map
;
9744 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9747 if (!NILP (map
) || !NILP (map2
))
9748 goto replay_sequence
;
9754 else if (NILP (from_string
)
9755 && (string
= POSN_STRING (EVENT_START (key
)),
9756 (CONSP (string
) && STRINGP (XCAR (string
)))))
9758 /* For a click on a string, i.e. overlay string or a
9759 string displayed via the `display' property,
9760 consider `local-map' and `keymap' properties of
9762 Lisp_Object pos
, map
, map2
;
9764 pos
= XCDR (string
);
9765 string
= XCAR (string
);
9767 && XINT (pos
) < SCHARS (string
))
9769 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9771 orig_local_map
= map
;
9772 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9776 if (!NILP (map
) || !NILP (map2
))
9778 from_string
= string
;
9781 goto replay_sequence
;
9786 else if (CONSP (XCDR (key
))
9787 && CONSP (EVENT_START (key
))
9788 && CONSP (XCDR (EVENT_START (key
))))
9792 posn
= POSN_POSN (EVENT_START (key
));
9793 /* Handle menu-bar events:
9794 insert the dummy prefix event `menu-bar'. */
9795 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9797 if (t
+ 1 >= bufsize
)
9798 error ("Key sequence too long");
9802 /* Zap the position in key, so we know that we've
9803 expanded it, and don't try to do so again. */
9804 POSN_SET_POSN (EVENT_START (key
),
9805 Fcons (posn
, Qnil
));
9808 goto replay_sequence
;
9810 else if (CONSP (posn
))
9812 /* We're looking at the second event of a
9813 sequence which we expanded before. Set
9814 last_real_key_start appropriately. */
9815 if (last_real_key_start
== t
&& t
> 0)
9816 last_real_key_start
= t
- 1;
9821 /* We have finally decided that KEY is something we might want
9823 first_binding
= (follow_key (key
,
9824 nmaps
- first_binding
,
9825 submaps
+ first_binding
,
9826 defs
+ first_binding
,
9827 submaps
+ first_binding
)
9830 /* If KEY wasn't bound, we'll try some fallbacks. */
9831 if (first_binding
< nmaps
)
9832 /* This is needed for the following scenario:
9833 event 0: a down-event that gets dropped by calling replay_key.
9834 event 1: some normal prefix like C-h.
9835 After event 0, first_unbound is 0, after event 1 indec.start,
9836 fkey.start, and keytran.start are all 1, so when we see that
9837 C-h is bound, we need to update first_unbound. */
9838 first_unbound
= max (t
+ 1, first_unbound
);
9843 /* Remember the position to put an upper bound on indec.start. */
9844 first_unbound
= min (t
, first_unbound
);
9846 head
= EVENT_HEAD (key
);
9847 if (help_char_p (head
) && t
> 0)
9849 read_key_sequence_cmd
= Vprefix_help_command
;
9851 last_nonmenu_event
= key
;
9852 /* The Microsoft C compiler can't handle the goto that
9860 Lisp_Object breakdown
;
9863 breakdown
= parse_modifiers (head
);
9864 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9865 /* Attempt to reduce an unbound mouse event to a simpler
9866 event that is bound:
9867 Drags reduce to clicks.
9868 Double-clicks reduce to clicks.
9869 Triple-clicks reduce to double-clicks, then to clicks.
9870 Down-clicks are eliminated.
9871 Double-downs reduce to downs, then are eliminated.
9872 Triple-downs reduce to double-downs, then to downs,
9873 then are eliminated. */
9874 if (modifiers
& (down_modifier
| drag_modifier
9875 | double_modifier
| triple_modifier
))
9877 while (modifiers
& (down_modifier
| drag_modifier
9878 | double_modifier
| triple_modifier
))
9880 Lisp_Object new_head
, new_click
;
9881 if (modifiers
& triple_modifier
)
9882 modifiers
^= (double_modifier
| triple_modifier
);
9883 else if (modifiers
& double_modifier
)
9884 modifiers
&= ~double_modifier
;
9885 else if (modifiers
& drag_modifier
)
9886 modifiers
&= ~drag_modifier
;
9889 /* Dispose of this `down' event by simply jumping
9890 back to replay_key, to get another event.
9892 Note that if this event came from mock input,
9893 then just jumping back to replay_key will just
9894 hand it to us again. So we have to wipe out any
9897 We could delete keybuf[t] and shift everything
9898 after that to the left by one spot, but we'd also
9899 have to fix up any variable that points into
9900 keybuf, and shifting isn't really necessary
9903 Adding prefixes for non-textual mouse clicks
9904 creates two characters of mock input, and both
9905 must be thrown away. If we're only looking at
9906 the prefix now, we can just jump back to
9907 replay_key. On the other hand, if we've already
9908 processed the prefix, and now the actual click
9909 itself is giving us trouble, then we've lost the
9910 state of the keymaps we want to backtrack to, and
9911 we need to replay the whole sequence to rebuild
9914 Beyond that, only function key expansion could
9915 create more than two keys, but that should never
9916 generate mouse events, so it's okay to zero
9917 mock_input in that case too.
9919 FIXME: The above paragraph seems just plain
9920 wrong, if you consider things like
9921 xterm-mouse-mode. -stef
9923 Isn't this just the most wonderful code ever? */
9925 /* If mock_input > t + 1, the above simplification
9926 will actually end up dropping keys on the floor.
9927 This is probably OK for now, but even
9928 if mock_input <= t + 1, we need to adjust indec,
9930 Typical case [header-line down-mouse-N]:
9931 mock_input = 2, t = 1, fkey.end = 1,
9932 last_real_key_start = 0. */
9933 if (indec
.end
> last_real_key_start
)
9935 indec
.end
= indec
.start
9936 = min (last_real_key_start
, indec
.start
);
9937 indec
.map
= indec
.parent
;
9938 if (fkey
.end
> last_real_key_start
)
9940 fkey
.end
= fkey
.start
9941 = min (last_real_key_start
, fkey
.start
);
9942 fkey
.map
= fkey
.parent
;
9943 if (keytran
.end
> last_real_key_start
)
9945 keytran
.end
= keytran
.start
9946 = min (last_real_key_start
, keytran
.start
);
9947 keytran
.map
= keytran
.parent
;
9951 if (t
== last_real_key_start
)
9958 mock_input
= last_real_key_start
;
9959 goto replay_sequence
;
9964 = apply_modifiers (modifiers
, XCAR (breakdown
));
9966 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9968 /* Look for a binding for this new key. follow_key
9969 promises that it didn't munge submaps the
9970 last time we called it, since key was unbound. */
9972 = (follow_key (new_click
,
9973 nmaps
- local_first_binding
,
9974 submaps
+ local_first_binding
,
9975 defs
+ local_first_binding
,
9976 submaps
+ local_first_binding
)
9977 + local_first_binding
);
9979 /* If that click is bound, go for it. */
9980 if (first_binding
< nmaps
)
9985 /* Otherwise, we'll leave key set to the drag event. */
9992 /* Normally, last_nonmenu_event gets the previous key we read.
9993 But when a mouse popup menu is being used,
9994 we don't update last_nonmenu_event; it continues to hold the mouse
9995 event that preceded the first level of menu. */
9996 if (!used_mouse_menu
)
9997 last_nonmenu_event
= key
;
9999 /* Record what part of this_command_keys is the current key sequence. */
10000 this_single_command_key_start
= this_command_key_count
- t
;
10002 /* Look for this sequence in input-decode-map.
10003 Scan from indec.end until we find a bound suffix. */
10004 while (indec
.end
< t
)
10006 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10009 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10010 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
10015 mock_input
= diff
+ max (t
, mock_input
);
10016 goto replay_sequence
;
10020 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
10021 && indec
.start
>= t
)
10022 /* There is a binding and it's not a prefix.
10023 (and it doesn't have any input-decode-map translation pending).
10024 There is thus no function-key in this sequence.
10025 Moving fkey.start is important in this case to allow keytran.start
10026 to go over the sequence before we return (since we keep the
10027 invariant that keytran.end <= fkey.start). */
10029 if (fkey
.start
< t
)
10030 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
10033 /* If the sequence is unbound, see if we can hang a function key
10034 off the end of it. */
10035 /* Continue scan from fkey.end until we find a bound suffix. */
10036 while (fkey
.end
< indec
.start
)
10038 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10041 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10042 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
10043 max (t
, mock_input
),
10044 /* If there's a binding (i.e.
10045 first_binding >= nmaps) we don't want
10046 to apply this function-key-mapping. */
10047 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
10052 mock_input
= diff
+ max (t
, mock_input
);
10053 /* Adjust the input-decode-map counters. */
10055 indec
.start
+= diff
;
10057 goto replay_sequence
;
10061 /* Look for this sequence in key-translation-map.
10062 Scan from keytran.end until we find a bound suffix. */
10063 while (keytran
.end
< fkey
.start
)
10065 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10068 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10069 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
10074 mock_input
= diff
+ max (t
, mock_input
);
10075 /* Adjust the function-key-map and input-decode-map counters. */
10077 indec
.start
+= diff
;
10079 fkey
.start
+= diff
;
10081 goto replay_sequence
;
10085 /* If KEY is not defined in any of the keymaps,
10086 and cannot be part of a function key or translation,
10087 and is an upper case letter
10088 use the corresponding lower-case letter instead. */
10089 if (first_binding
>= nmaps
10090 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
10092 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10093 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10094 || (XINT (key
) & shift_modifier
)))
10096 Lisp_Object new_key
;
10098 original_uppercase
= key
;
10099 original_uppercase_position
= t
- 1;
10101 if (XINT (key
) & shift_modifier
)
10102 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10104 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10105 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10107 /* We have to do this unconditionally, regardless of whether
10108 the lower-case char is defined in the keymaps, because they
10109 might get translated through function-key-map. */
10110 keybuf
[t
- 1] = new_key
;
10111 mock_input
= max (t
, mock_input
);
10112 shift_translated
= 1;
10114 goto replay_sequence
;
10116 /* If KEY is not defined in any of the keymaps,
10117 and cannot be part of a function key or translation,
10118 and is a shifted function key,
10119 use the corresponding unshifted function key instead. */
10120 if (first_binding
>= nmaps
10121 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10123 Lisp_Object breakdown
= parse_modifiers (key
);
10125 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10127 if (modifiers
& shift_modifier
10128 /* Treat uppercase keys as shifted. */
10130 && (KEY_TO_CHAR (key
)
10131 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
10132 && UPPERCASEP (KEY_TO_CHAR (key
))))
10134 Lisp_Object new_key
10135 = (modifiers
& shift_modifier
10136 ? apply_modifiers (modifiers
& ~shift_modifier
,
10138 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
10140 original_uppercase
= key
;
10141 original_uppercase_position
= t
- 1;
10143 /* We have to do this unconditionally, regardless of whether
10144 the lower-case char is defined in the keymaps, because they
10145 might get translated through function-key-map. */
10146 keybuf
[t
- 1] = new_key
;
10147 mock_input
= max (t
, mock_input
);
10148 /* Reset fkey (and consequently keytran) to apply
10149 function-key-map on the result, so that S-backspace is
10150 correctly mapped to DEL (via backspace). OTOH,
10151 input-decode-map doesn't need to go through it again. */
10152 fkey
.start
= fkey
.end
= 0;
10153 keytran
.start
= keytran
.end
= 0;
10154 shift_translated
= 1;
10156 goto replay_sequence
;
10161 read_key_sequence_cmd
= (first_binding
< nmaps
10162 ? defs
[first_binding
]
10165 unread_switch_frame
= delayed_switch_frame
;
10166 unbind_to (count
, Qnil
);
10168 /* Don't downcase the last character if the caller says don't.
10169 Don't downcase it if the result is undefined, either. */
10170 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10172 && t
- 1 == original_uppercase_position
)
10174 keybuf
[t
- 1] = original_uppercase
;
10175 shift_translated
= 0;
10178 if (shift_translated
)
10179 Vthis_command_keys_shift_translated
= Qt
;
10181 /* Occasionally we fabricate events, perhaps by expanding something
10182 according to function-key-map, or by adding a prefix symbol to a
10183 mouse click in the scroll bar or modeline. In this cases, return
10184 the entire generated key sequence, even if we hit an unbound
10185 prefix or a definition before the end. This means that you will
10186 be able to push back the event properly, and also means that
10187 read-key-sequence will always return a logical unit.
10190 for (; t
< mock_input
; t
++)
10192 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10193 && NILP (Fzerop (Vecho_keystrokes
)))
10194 echo_char (keybuf
[t
]);
10195 add_command_key (keybuf
[t
]);
10202 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10203 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10204 The sequence is sufficient to specify a non-prefix command in the
10205 current local and global maps.
10207 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10208 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10209 as a continuation of the previous key.
10211 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10212 convert the last event to lower case. (Normally any upper case event
10213 is converted to lower case if the original event is undefined and the lower
10214 case equivalent is defined.) A non-nil value is appropriate for reading
10215 a key sequence to be defined.
10217 A C-g typed while in this function is treated like any other character,
10218 and `quit-flag' is not set.
10220 If the key sequence starts with a mouse click, then the sequence is read
10221 using the keymaps of the buffer of the window clicked in, not the buffer
10222 of the selected window as normal.
10224 `read-key-sequence' drops unbound button-down events, since you normally
10225 only care about the click or drag events which follow them. If a drag
10226 or multi-click event is unbound, but the corresponding click event would
10227 be bound, `read-key-sequence' turns the event into a click event at the
10228 drag's starting position. This means that you don't have to distinguish
10229 between click and drag, double, or triple events unless you want to.
10231 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10232 lines separating windows, and scroll bars with imaginary keys
10233 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10235 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10236 function will process a switch-frame event if the user switches frames
10237 before typing anything. If the user switches frames in the middle of a
10238 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10239 is nil, then the event will be put off until after the current key sequence.
10241 `read-key-sequence' checks `function-key-map' for function key
10242 sequences, where they wouldn't conflict with ordinary bindings. See
10243 `function-key-map' for more details.
10245 The optional fifth argument COMMAND-LOOP, if non-nil, means
10246 that this key sequence is being read by something that will
10247 read commands one after another. It should be nil if the caller
10248 will read just one key sequence. */)
10249 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10251 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10252 Lisp_Object can_return_switch_frame
, command_loop
;
10254 Lisp_Object keybuf
[30];
10256 struct gcpro gcpro1
;
10257 int count
= SPECPDL_INDEX ();
10259 if (!NILP (prompt
))
10260 CHECK_STRING (prompt
);
10263 specbind (Qinput_method_exit_on_first_char
,
10264 (NILP (command_loop
) ? Qt
: Qnil
));
10265 specbind (Qinput_method_use_echo_area
,
10266 (NILP (command_loop
) ? Qt
: Qnil
));
10268 bzero (keybuf
, sizeof keybuf
);
10269 GCPRO1 (keybuf
[0]);
10270 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10272 if (NILP (continue_echo
))
10274 this_command_key_count
= 0;
10275 this_command_key_count_reset
= 0;
10276 this_single_command_key_start
= 0;
10279 #ifdef HAVE_WINDOW_SYSTEM
10280 if (display_hourglass_p
)
10281 cancel_hourglass ();
10284 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10285 prompt
, ! NILP (dont_downcase_last
),
10286 ! NILP (can_return_switch_frame
), 0);
10288 #if 0 /* The following is fine for code reading a key sequence and
10289 then proceeding with a lenghty computation, but it's not good
10290 for code reading keys in a loop, like an input method. */
10291 #ifdef HAVE_WINDOW_SYSTEM
10292 if (display_hourglass_p
)
10293 start_hourglass ();
10303 return unbind_to (count
, make_event_array (i
, keybuf
));
10306 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10307 Sread_key_sequence_vector
, 1, 5, 0,
10308 doc
: /* Like `read-key-sequence' but always return a vector. */)
10309 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10311 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10312 Lisp_Object can_return_switch_frame
, command_loop
;
10314 Lisp_Object keybuf
[30];
10316 struct gcpro gcpro1
;
10317 int count
= SPECPDL_INDEX ();
10319 if (!NILP (prompt
))
10320 CHECK_STRING (prompt
);
10323 specbind (Qinput_method_exit_on_first_char
,
10324 (NILP (command_loop
) ? Qt
: Qnil
));
10325 specbind (Qinput_method_use_echo_area
,
10326 (NILP (command_loop
) ? Qt
: Qnil
));
10328 bzero (keybuf
, sizeof keybuf
);
10329 GCPRO1 (keybuf
[0]);
10330 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10332 if (NILP (continue_echo
))
10334 this_command_key_count
= 0;
10335 this_command_key_count_reset
= 0;
10336 this_single_command_key_start
= 0;
10339 #ifdef HAVE_WINDOW_SYSTEM
10340 if (display_hourglass_p
)
10341 cancel_hourglass ();
10344 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10345 prompt
, ! NILP (dont_downcase_last
),
10346 ! NILP (can_return_switch_frame
), 0);
10348 #ifdef HAVE_WINDOW_SYSTEM
10349 if (display_hourglass_p
)
10350 start_hourglass ();
10359 return unbind_to (count
, Fvector (i
, keybuf
));
10362 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10363 doc
: /* Execute CMD as an editor command.
10364 CMD must be a symbol that satisfies the `commandp' predicate.
10365 Optional second arg RECORD-FLAG non-nil
10366 means unconditionally put this command in `command-history'.
10367 Otherwise, that is done only if an arg is read using the minibuffer.
10368 The argument KEYS specifies the value to use instead of (this-command-keys)
10369 when reading the arguments; if it is nil, (this-command-keys) is used.
10370 The argument SPECIAL, if non-nil, means that this command is executing
10371 a special event, so ignore the prefix argument and don't clear it. */)
10372 (cmd
, record_flag
, keys
, special
)
10373 Lisp_Object cmd
, record_flag
, keys
, special
;
10375 register Lisp_Object final
;
10376 register Lisp_Object tem
;
10377 Lisp_Object prefixarg
;
10378 extern int debug_on_next_call
;
10380 debug_on_next_call
= 0;
10382 if (NILP (special
))
10384 prefixarg
= current_kboard
->Vprefix_arg
;
10385 Vcurrent_prefix_arg
= prefixarg
;
10386 current_kboard
->Vprefix_arg
= Qnil
;
10393 tem
= Fget (cmd
, Qdisabled
);
10394 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10396 tem
= Fsymbol_value (Qdisabled_command_function
);
10398 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10404 final
= Findirect_function (cmd
, Qnil
);
10406 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10408 struct gcpro gcpro1
, gcpro2
;
10410 GCPRO2 (cmd
, prefixarg
);
10411 do_autoload (final
, cmd
);
10418 if (STRINGP (final
) || VECTORP (final
))
10420 /* If requested, place the macro in the command history. For
10421 other sorts of commands, call-interactively takes care of
10423 if (!NILP (record_flag
))
10426 = Fcons (Fcons (Qexecute_kbd_macro
,
10427 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10430 /* Don't keep command history around forever. */
10431 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10433 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10435 XSETCDR (tem
, Qnil
);
10439 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10442 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10443 /* Don't call Fcall_interactively directly because we want to make
10444 sure the backtrace has an entry for `call-interactively'.
10445 For the same reason, pass `cmd' rather than `final'. */
10446 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10453 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10455 doc
: /* Read function name, then read its arguments and call it.
10457 To pass a numeric argument to the command you are invoking with, specify
10458 the numeric argument to this command.
10460 Noninteractively, the argument PREFIXARG is the prefix argument to
10461 give to the command you invoke, if it asks for an argument. */)
10463 Lisp_Object prefixarg
;
10465 Lisp_Object function
;
10467 int saved_last_point_position
;
10468 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10469 Lisp_Object bindings
, value
;
10470 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10471 #ifdef HAVE_WINDOW_SYSTEM
10472 /* The call to Fcompleting_read wil start and cancel the hourglass,
10473 but if the hourglass was already scheduled, this means that no
10474 hourglass will be shown for the actual M-x command itself.
10475 So we restart it if it is already scheduled. Note that checking
10476 hourglass_shown_p is not enough, normally the hourglass is not shown,
10477 just scheduled to be shown. */
10478 int hstarted
= hourglass_started ();
10481 saved_keys
= Fvector (this_command_key_count
,
10482 XVECTOR (this_command_keys
)->contents
);
10483 saved_last_point_position_buffer
= last_point_position_buffer
;
10484 saved_last_point_position
= last_point_position
;
10486 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10488 if (EQ (prefixarg
, Qminus
))
10489 strcpy (buf
, "- ");
10490 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10491 strcpy (buf
, "C-u ");
10492 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10493 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10494 else if (INTEGERP (prefixarg
))
10495 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10497 /* This isn't strictly correct if execute-extended-command
10498 is bound to anything else. Perhaps it should use
10499 this_command_keys? */
10500 strcat (buf
, "M-x ");
10502 /* Prompt with buf, and then read a string, completing from and
10503 restricting to the set of all defined commands. Don't provide
10504 any initial input. Save the command read on the extended-command
10506 function
= Fcompleting_read (build_string (buf
),
10507 Vobarray
, Qcommandp
,
10508 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10511 #ifdef HAVE_WINDOW_SYSTEM
10512 if (hstarted
) start_hourglass ();
10515 if (STRINGP (function
) && SCHARS (function
) == 0)
10516 error ("No command name given");
10518 /* Set this_command_keys to the concatenation of saved_keys and
10519 function, followed by a RET. */
10524 this_command_key_count
= 0;
10525 this_command_key_count_reset
= 0;
10526 this_single_command_key_start
= 0;
10528 keys
= XVECTOR (saved_keys
)->contents
;
10529 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10530 add_command_key (keys
[i
]);
10532 for (i
= 0; i
< SCHARS (function
); i
++)
10533 add_command_key (Faref (function
, make_number (i
)));
10535 add_command_key (make_number ('\015'));
10538 last_point_position
= saved_last_point_position
;
10539 last_point_position_buffer
= saved_last_point_position_buffer
;
10543 function
= Fintern (function
, Qnil
);
10544 current_kboard
->Vprefix_arg
= prefixarg
;
10545 Vthis_command
= function
;
10546 real_this_command
= function
;
10548 /* If enabled, show which key runs this command. */
10549 if (!NILP (Vsuggest_key_bindings
)
10550 && NILP (Vexecuting_kbd_macro
)
10551 && SYMBOLP (function
))
10552 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10558 GCPRO3 (bindings
, value
, function
);
10559 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10561 /* If the command has a key binding, print it now. */
10562 if (!NILP (bindings
)
10563 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10566 /* But first wait, and skip the message if there is input. */
10567 Lisp_Object waited
;
10569 /* If this command displayed something in the echo area;
10570 wait a few seconds, then display our suggestion message. */
10571 if (NILP (echo_area_buffer
[0]))
10572 waited
= sit_for (make_number (0), 0, 2);
10573 else if (NUMBERP (Vsuggest_key_bindings
))
10574 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10576 waited
= sit_for (make_number (2), 0, 2);
10578 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10580 Lisp_Object binding
;
10582 int message_p
= push_message ();
10583 int count
= SPECPDL_INDEX ();
10585 record_unwind_protect (pop_message_unwind
, Qnil
);
10586 binding
= Fkey_description (bindings
, Qnil
);
10589 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10592 sprintf (newmessage
, "You can run the command `%s' with %s",
10593 SDATA (SYMBOL_NAME (function
)),
10595 message2_nolog (newmessage
,
10596 strlen (newmessage
),
10597 STRING_MULTIBYTE (binding
));
10598 if (NUMBERP (Vsuggest_key_bindings
))
10599 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10601 waited
= sit_for (make_number (2), 0, 2);
10603 if (!NILP (waited
) && message_p
)
10604 restore_message ();
10606 unbind_to (count
, Qnil
);
10610 RETURN_UNGCPRO (value
);
10614 /* Return nonzero if input events are pending. */
10617 detect_input_pending ()
10619 if (!input_pending
)
10620 get_input_pending (&input_pending
, 0);
10622 return input_pending
;
10625 /* Return nonzero if input events other than mouse movements are
10629 detect_input_pending_ignore_squeezables ()
10631 if (!input_pending
)
10632 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10634 return input_pending
;
10637 /* Return nonzero if input events are pending, and run any pending timers. */
10640 detect_input_pending_run_timers (do_display
)
10643 int old_timers_run
= timers_run
;
10645 if (!input_pending
)
10646 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10648 if (old_timers_run
!= timers_run
&& do_display
)
10650 redisplay_preserve_echo_area (8);
10651 /* The following fixes a bug when using lazy-lock with
10652 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10653 from an idle timer function. The symptom of the bug is that
10654 the cursor sometimes doesn't become visible until the next X
10655 event is processed. --gerd. */
10657 Lisp_Object tail
, frame
;
10658 FOR_EACH_FRAME (tail
, frame
)
10659 if (FRAME_RIF (XFRAME (frame
)))
10660 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10664 return input_pending
;
10667 /* This is called in some cases before a possible quit.
10668 It cases the next call to detect_input_pending to recompute input_pending.
10669 So calling this function unnecessarily can't do any harm. */
10672 clear_input_pending ()
10677 /* Return nonzero if there are pending requeued events.
10678 This isn't used yet. The hope is to make wait_reading_process_output
10679 call it, and return if it runs Lisp code that unreads something.
10680 The problem is, kbd_buffer_get_event needs to be fixed to know what
10681 to do in that case. It isn't trivial. */
10684 requeued_events_pending_p ()
10686 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10690 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10691 doc
: /* Return t if command input is currently available with no wait.
10692 Actually, the value is nil only if we can be sure that no input is available;
10693 if there is a doubt, the value is t. */)
10696 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10697 || !NILP (Vunread_post_input_method_events
)
10698 || !NILP (Vunread_input_method_events
))
10701 get_input_pending (&input_pending
,
10702 READABLE_EVENTS_DO_TIMERS_NOW
10703 | READABLE_EVENTS_FILTER_EVENTS
);
10704 return input_pending
> 0 ? Qt
: Qnil
;
10707 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10708 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10711 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10714 if (total_keys
< NUM_RECENT_KEYS
)
10715 return Fvector (total_keys
, keys
);
10718 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10719 bcopy (keys
+ recent_keys_index
,
10720 XVECTOR (val
)->contents
,
10721 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10723 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10724 recent_keys_index
* sizeof (Lisp_Object
));
10729 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10730 doc
: /* Return the key sequence that invoked this command.
10731 However, if the command has called `read-key-sequence', it returns
10732 the last key sequence that has been read.
10733 The value is a string or a vector.
10735 See also `this-command-keys-vector'. */)
10738 return make_event_array (this_command_key_count
,
10739 XVECTOR (this_command_keys
)->contents
);
10742 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10743 doc
: /* Return the key sequence that invoked this command, as a vector.
10744 However, if the command has called `read-key-sequence', it returns
10745 the last key sequence that has been read.
10747 See also `this-command-keys'. */)
10750 return Fvector (this_command_key_count
,
10751 XVECTOR (this_command_keys
)->contents
);
10754 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10755 Sthis_single_command_keys
, 0, 0, 0,
10756 doc
: /* Return the key sequence that invoked this command.
10757 More generally, it returns the last key sequence read, either by
10758 the command loop or by `read-key-sequence'.
10759 Unlike `this-command-keys', this function's value
10760 does not include prefix arguments.
10761 The value is always a vector. */)
10764 return Fvector (this_command_key_count
10765 - this_single_command_key_start
,
10766 (XVECTOR (this_command_keys
)->contents
10767 + this_single_command_key_start
));
10770 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10771 Sthis_single_command_raw_keys
, 0, 0, 0,
10772 doc
: /* Return the raw events that were read for this command.
10773 More generally, it returns the last key sequence read, either by
10774 the command loop or by `read-key-sequence'.
10775 Unlike `this-single-command-keys', this function's value
10776 shows the events before all translations (except for input methods).
10777 The value is always a vector. */)
10780 return Fvector (raw_keybuf_count
,
10781 (XVECTOR (raw_keybuf
)->contents
));
10784 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10785 Sreset_this_command_lengths
, 0, 0, 0,
10786 doc
: /* Make the unread events replace the last command and echo.
10787 Used in `universal-argument-other-key'.
10789 `universal-argument-other-key' rereads the event just typed.
10790 It then gets translated through `function-key-map'.
10791 The translated event has to replace the real events,
10792 both in the value of (this-command-keys) and in echoing.
10793 To achieve this, `universal-argument-other-key' calls
10794 `reset-this-command-lengths', which discards the record of reading
10795 these events the first time. */)
10798 this_command_key_count
= before_command_key_count
;
10799 if (this_command_key_count
< this_single_command_key_start
)
10800 this_single_command_key_start
= this_command_key_count
;
10802 echo_truncate (before_command_echo_length
);
10804 /* Cause whatever we put into unread-command-events
10805 to echo as if it were being freshly read from the keyboard. */
10806 this_command_key_count_reset
= 1;
10811 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10812 Sclear_this_command_keys
, 0, 1, 0,
10813 doc
: /* Clear out the vector that `this-command-keys' returns.
10814 Also clear the record of the last 100 events, unless optional arg
10815 KEEP-RECORD is non-nil. */)
10817 Lisp_Object keep_record
;
10821 this_command_key_count
= 0;
10822 this_command_key_count_reset
= 0;
10824 if (NILP (keep_record
))
10826 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10827 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10829 recent_keys_index
= 0;
10834 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10835 doc
: /* Return the current depth in recursive edits. */)
10839 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10843 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10844 "FOpen dribble file: ",
10845 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10846 If FILE is nil, close any open dribble file. */)
10859 file
= Fexpand_file_name (file
, Qnil
);
10860 dribble
= fopen (SDATA (file
), "w");
10862 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10867 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10868 doc
: /* Discard the contents of the terminal input buffer.
10869 Also end any kbd macro being defined. */)
10872 if (!NILP (current_kboard
->defining_kbd_macro
))
10874 /* Discard the last command from the macro. */
10875 Fcancel_kbd_macro_events ();
10879 update_mode_lines
++;
10881 Vunread_command_events
= Qnil
;
10882 unread_command_char
= -1;
10884 discard_tty_input ();
10886 kbd_fetch_ptr
= kbd_store_ptr
;
10892 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10893 doc
: /* Stop Emacs and return to superior process. You can resume later.
10894 If `cannot-suspend' is non-nil, or if the system doesn't support job
10895 control, run a subshell instead.
10897 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10898 to be read as terminal input by Emacs's parent, after suspension.
10900 Before suspending, run the normal hook `suspend-hook'.
10901 After resumption run the normal hook `suspend-resume-hook'.
10903 Some operating systems cannot stop the Emacs process and resume it later.
10904 On such systems, Emacs starts a subshell instead of suspending. */)
10906 Lisp_Object stuffstring
;
10908 int count
= SPECPDL_INDEX ();
10909 int old_height
, old_width
;
10911 struct gcpro gcpro1
;
10913 if (tty_list
&& tty_list
->next
)
10914 error ("There are other tty frames open; close them before suspending Emacs");
10916 if (!NILP (stuffstring
))
10917 CHECK_STRING (stuffstring
);
10919 /* Run the functions in suspend-hook. */
10920 if (!NILP (Vrun_hooks
))
10921 call1 (Vrun_hooks
, intern ("suspend-hook"));
10923 GCPRO1 (stuffstring
);
10924 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10925 reset_all_sys_modes ();
10926 /* sys_suspend can get an error if it tries to fork a subshell
10927 and the system resources aren't available for that. */
10928 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10930 stuff_buffered_input (stuffstring
);
10931 if (cannot_suspend
)
10935 unbind_to (count
, Qnil
);
10937 /* Check if terminal/window size has changed.
10938 Note that this is not useful when we are running directly
10939 with a window system; but suspend should be disabled in that case. */
10940 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10941 if (width
!= old_width
|| height
!= old_height
)
10942 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10944 /* Run suspend-resume-hook. */
10945 if (!NILP (Vrun_hooks
))
10946 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10952 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10953 Then in any case stuff anything Emacs has read ahead and not used. */
10956 stuff_buffered_input (stuffstring
)
10957 Lisp_Object stuffstring
;
10959 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10960 register unsigned char *p
;
10962 if (STRINGP (stuffstring
))
10964 register int count
;
10966 p
= SDATA (stuffstring
);
10967 count
= SBYTES (stuffstring
);
10968 while (count
-- > 0)
10973 /* Anything we have read ahead, put back for the shell to read. */
10974 /* ?? What should this do when we have multiple keyboards??
10975 Should we ignore anything that was typed in at the "wrong" kboard?
10977 rms: we should stuff everything back into the kboard
10979 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10982 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10983 kbd_fetch_ptr
= kbd_buffer
;
10984 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10985 stuff_char (kbd_fetch_ptr
->code
);
10987 clear_event (kbd_fetch_ptr
);
10991 #endif /* SIGTSTP */
10995 set_waiting_for_input (time_to_clear
)
10996 EMACS_TIME
*time_to_clear
;
10998 input_available_clear_time
= time_to_clear
;
11000 /* Tell handle_interrupt to throw back to read_char, */
11001 waiting_for_input
= 1;
11003 /* If handle_interrupt was called before and buffered a C-g,
11004 make it run again now, to avoid timing error. */
11005 if (!NILP (Vquit_flag
))
11006 quit_throw_to_read_char ();
11010 clear_waiting_for_input ()
11012 /* Tell handle_interrupt not to throw back to read_char, */
11013 waiting_for_input
= 0;
11014 input_available_clear_time
= 0;
11017 /* The SIGINT handler.
11019 If we have a frame on the controlling tty, we assume that the
11020 SIGINT was generated by C-g, so we call handle_interrupt.
11021 Otherwise, the handler kills Emacs. */
11024 interrupt_signal (signalnum
) /* If we don't have an argument, */
11025 int signalnum
; /* some compilers complain in signal calls. */
11027 /* Must preserve main program's value of errno. */
11028 int old_errno
= errno
;
11029 struct terminal
*terminal
;
11031 #if defined (USG) && !defined (POSIX_SIGNALS)
11032 /* USG systems forget handlers when they are used;
11033 must reestablish each time */
11034 signal (SIGINT
, interrupt_signal
);
11035 signal (SIGQUIT
, interrupt_signal
);
11038 SIGNAL_THREAD_CHECK (signalnum
);
11040 /* See if we have an active terminal on our controlling tty. */
11041 terminal
= get_named_tty ("/dev/tty");
11044 /* If there are no frames there, let's pretend that we are a
11045 well-behaving UN*X program and quit. */
11046 Fkill_emacs (Qnil
);
11050 /* Otherwise, the SIGINT was probably generated by C-g. */
11052 /* Set internal_last_event_frame to the top frame of the
11053 controlling tty, if we have a frame there. We disable the
11054 interrupt key on secondary ttys, so the SIGINT must have come
11055 from the controlling tty. */
11056 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
11058 handle_interrupt ();
11064 /* This routine is called at interrupt level in response to C-g.
11066 It is called from the SIGINT handler or kbd_buffer_store_event.
11068 If `waiting_for_input' is non zero, then unless `echoing' is
11069 nonzero, immediately throw back to read_char.
11071 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
11072 eval to throw, when it gets a chance. If quit-flag is already
11073 non-nil, it stops the job right away. */
11076 handle_interrupt ()
11082 /* XXX This code needs to be revised for multi-tty support. */
11083 if (!NILP (Vquit_flag
)
11085 && get_named_tty ("/dev/tty")
11089 /* If SIGINT isn't blocked, don't let us be interrupted by
11090 another SIGINT, it might be harmful due to non-reentrancy
11091 in I/O functions. */
11092 sigblock (sigmask (SIGINT
));
11095 reset_all_sys_modes ();
11097 #ifdef SIGTSTP /* Support possible in later USG versions */
11099 * On systems which can suspend the current process and return to the original
11100 * shell, this command causes the user to end up back at the shell.
11101 * The "Auto-save" and "Abort" questions are not asked until
11102 * the user elects to return to emacs, at which point he can save the current
11103 * job and either dump core or continue.
11108 if (sys_suspend () == -1)
11110 printf ("Not running as a subprocess;\n");
11111 printf ("you can continue or abort.\n");
11113 #else /* not VMS */
11114 /* Perhaps should really fork an inferior shell?
11115 But that would not provide any way to get back
11116 to the original shell, ever. */
11117 printf ("No support for stopping a process on this operating system;\n");
11118 printf ("you can continue or abort.\n");
11119 #endif /* not VMS */
11120 #endif /* not SIGTSTP */
11122 /* We must remain inside the screen area when the internal terminal
11123 is used. Note that [Enter] is not echoed by dos. */
11126 /* It doesn't work to autosave while GC is in progress;
11127 the code used for auto-saving doesn't cope with the mark bit. */
11128 if (!gc_in_progress
)
11130 printf ("Auto-save? (y or n) ");
11132 if (((c
= getchar ()) & ~040) == 'Y')
11134 Fdo_auto_save (Qt
, Qnil
);
11136 printf ("\r\nAuto-save done");
11137 #else /* not MSDOS */
11138 printf ("Auto-save done\n");
11139 #endif /* not MSDOS */
11141 while (c
!= '\n') c
= getchar ();
11145 /* During GC, it must be safe to reenable quitting again. */
11146 Vinhibit_quit
= Qnil
;
11149 #endif /* not MSDOS */
11150 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11151 printf ("but will instead do a real quit after garbage collection ends\r\n");
11156 printf ("\r\nAbort? (y or n) ");
11157 #else /* not MSDOS */
11159 printf ("Abort (and enter debugger)? (y or n) ");
11160 #else /* not VMS */
11161 printf ("Abort (and dump core)? (y or n) ");
11162 #endif /* not VMS */
11163 #endif /* not MSDOS */
11165 if (((c
= getchar ()) & ~040) == 'Y')
11167 while (c
!= '\n') c
= getchar ();
11169 printf ("\r\nContinuing...\r\n");
11170 #else /* not MSDOS */
11171 printf ("Continuing...\n");
11172 #endif /* not MSDOS */
11174 init_all_sys_modes ();
11179 /* If executing a function that wants to be interrupted out of
11180 and the user has not deferred quitting by binding `inhibit-quit'
11181 then quit right away. */
11182 if (immediate_quit
&& NILP (Vinhibit_quit
))
11184 struct gl_state_s saved
;
11185 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11187 immediate_quit
= 0;
11190 GCPRO4 (saved
.object
, saved
.global_code
,
11191 saved
.current_syntax_table
, saved
.old_prop
);
11192 Fsignal (Qquit
, Qnil
);
11197 /* Else request quit when it's safe */
11201 if (waiting_for_input
&& !echoing
)
11202 quit_throw_to_read_char ();
11205 /* Handle a C-g by making read_char return C-g. */
11208 quit_throw_to_read_char ()
11211 /* Prevent another signal from doing this before we finish. */
11212 clear_waiting_for_input ();
11215 Vunread_command_events
= Qnil
;
11216 unread_command_char
= -1;
11218 #if 0 /* Currently, sit_for is called from read_char without turning
11219 off polling. And that can call set_waiting_for_input.
11220 It seems to be harmless. */
11221 #ifdef POLL_FOR_INPUT
11222 /* May be > 1 if in recursive minibuffer. */
11223 if (poll_suppress_count
== 0)
11227 if (FRAMEP (internal_last_event_frame
)
11228 && !EQ (internal_last_event_frame
, selected_frame
))
11229 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11232 _longjmp (getcjmp
, 1);
11235 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11236 doc
: /* Set interrupt mode of reading keyboard input.
11237 If INTERRUPT is non-nil, Emacs will use input interrupts;
11238 otherwise Emacs uses CBREAK mode.
11240 See also `current-input-mode'. */)
11242 Lisp_Object interrupt
;
11244 int new_interrupt_input
;
11246 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11247 #ifdef HAVE_X_WINDOWS
11248 if (x_display_list
!= NULL
)
11250 /* When using X, don't give the user a real choice,
11251 because we haven't implemented the mechanisms to support it. */
11252 #ifdef NO_SOCK_SIGIO
11253 new_interrupt_input
= 0;
11254 #else /* not NO_SOCK_SIGIO */
11255 new_interrupt_input
= 1;
11256 #endif /* NO_SOCK_SIGIO */
11260 new_interrupt_input
= !NILP (interrupt
);
11261 #else /* not SIGIO */
11262 new_interrupt_input
= 0;
11263 #endif /* not SIGIO */
11265 /* Our VMS input only works by interrupts, as of now. */
11267 new_interrupt_input
= 1;
11270 if (new_interrupt_input
!= interrupt_input
)
11272 #ifdef POLL_FOR_INPUT
11276 /* this causes startup screen to be restored and messes with the mouse */
11277 reset_all_sys_modes ();
11279 interrupt_input
= new_interrupt_input
;
11281 init_all_sys_modes ();
11284 #ifdef POLL_FOR_INPUT
11285 poll_suppress_count
= 1;
11292 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11293 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11294 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11295 C-q in key sequences.
11297 This setting only has an effect on tty terminals and only when
11298 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11300 See also `current-input-mode'. */)
11302 Lisp_Object flow
, terminal
;
11304 struct terminal
*t
= get_terminal (terminal
, 1);
11305 struct tty_display_info
*tty
;
11306 if (t
== NULL
|| t
->type
!= output_termcap
)
11308 tty
= t
->display_info
.tty
;
11310 if (tty
->flow_control
!= !NILP (flow
))
11313 /* this causes startup screen to be restored and messes with the mouse */
11314 reset_sys_modes (tty
);
11317 tty
->flow_control
= !NILP (flow
);
11320 init_sys_modes (tty
);
11326 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11327 doc
: /* Enable or disable 8-bit input on TERMINAL.
11328 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11329 bit as the Meta modifier.
11331 If META is nil, Emacs will ignore the top bit, on the assumption it is
11334 Otherwise, Emacs will accept and pass through 8-bit input without
11335 specially interpreting the top bit.
11337 This setting only has an effect on tty terminal devices.
11339 Optional parameter TERMINAL specifies the tty terminal device to use.
11340 It may be a terminal id, a frame, or nil for the terminal used by the
11341 currently selected frame.
11343 See also `current-input-mode'. */)
11345 Lisp_Object meta
, terminal
;
11347 struct terminal
*t
= get_terminal (terminal
, 1);
11348 struct tty_display_info
*tty
;
11351 if (t
== NULL
|| t
->type
!= output_termcap
)
11353 tty
= t
->display_info
.tty
;
11357 else if (EQ (meta
, Qt
))
11362 if (tty
->meta_key
!= new_meta
)
11365 /* this causes startup screen to be restored and messes with the mouse */
11366 reset_sys_modes (tty
);
11369 tty
->meta_key
= new_meta
;
11372 init_sys_modes (tty
);
11378 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11379 doc
: /* Specify character used for quitting.
11380 QUIT must be an ASCII character.
11382 This function only has an effect on the controlling tty of the Emacs
11385 See also `current-input-mode'. */)
11389 struct terminal
*t
= get_named_tty ("/dev/tty");
11390 struct tty_display_info
*tty
;
11391 if (t
== NULL
|| t
->type
!= output_termcap
)
11393 tty
= t
->display_info
.tty
;
11395 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11396 error ("QUIT must be an ASCII character");
11399 /* this causes startup screen to be restored and messes with the mouse */
11400 reset_sys_modes (tty
);
11403 /* Don't let this value be out of range. */
11404 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11407 init_sys_modes (tty
);
11413 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11414 doc
: /* Set mode of reading keyboard input.
11415 First arg INTERRUPT non-nil means use input interrupts;
11416 nil means use CBREAK mode.
11417 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11418 (no effect except in CBREAK mode).
11419 Third arg META t means accept 8-bit input (for a Meta key).
11420 META nil means ignore the top bit, on the assumption it is parity.
11421 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11422 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11423 See also `current-input-mode'. */)
11424 (interrupt
, flow
, meta
, quit
)
11425 Lisp_Object interrupt
, flow
, meta
, quit
;
11427 Fset_input_interrupt_mode (interrupt
);
11428 Fset_output_flow_control (flow
, Qnil
);
11429 Fset_input_meta_mode (meta
, Qnil
);
11431 Fset_quit_char (quit
);
11435 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11436 doc
: /* Return information about the way Emacs currently reads keyboard input.
11437 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11438 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11439 nil, Emacs is using CBREAK mode.
11440 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11441 terminal; this does not apply if Emacs uses interrupt-driven input.
11442 META is t if accepting 8-bit input with 8th bit as Meta flag.
11443 META nil means ignoring the top bit, on the assumption it is parity.
11444 META is neither t nor nil if accepting 8-bit input and using
11445 all 8 bits as the character code.
11446 QUIT is the character Emacs currently uses to quit.
11447 The elements of this list correspond to the arguments of
11448 `set-input-mode'. */)
11451 Lisp_Object val
[4];
11452 struct frame
*sf
= XFRAME (selected_frame
);
11454 val
[0] = interrupt_input
? Qt
: Qnil
;
11455 if (FRAME_TERMCAP_P (sf
))
11457 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11458 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11460 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11467 XSETFASTINT (val
[3], quit_char
);
11469 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11472 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11473 doc
: /* Return position information for pixel coordinates X and Y.
11474 By default, X and Y are relative to text area of the selected window.
11475 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11476 If optional fourth arg WHOLE is non-nil, X is relative to the left
11477 edge of the window.
11479 The return value is similar to a mouse click position:
11480 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11481 IMAGE (DX . DY) (WIDTH . HEIGHT))
11482 The `posn-' functions access elements of such lists. */)
11483 (x
, y
, frame_or_window
, whole
)
11484 Lisp_Object x
, y
, frame_or_window
, whole
;
11489 if (NILP (frame_or_window
))
11490 frame_or_window
= selected_window
;
11492 if (WINDOWP (frame_or_window
))
11496 CHECK_LIVE_WINDOW (frame_or_window
);
11498 w
= XWINDOW (frame_or_window
);
11499 XSETINT (x
, (XINT (x
)
11500 + WINDOW_LEFT_EDGE_X (w
)
11502 ? window_box_left_offset (w
, TEXT_AREA
)
11504 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11505 frame_or_window
= w
->frame
;
11508 CHECK_LIVE_FRAME (frame_or_window
);
11510 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11513 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11514 doc
: /* Return position information for buffer POS in WINDOW.
11515 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11517 Return nil if position is not visible in window. Otherwise,
11518 the return value is similar to that returned by `event-start' for
11519 a mouse click at the upper left corner of the glyph corresponding
11520 to the given buffer position:
11521 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11522 IMAGE (DX . DY) (WIDTH . HEIGHT))
11523 The `posn-' functions access elements of such lists. */)
11525 Lisp_Object pos
, window
;
11530 window
= selected_window
;
11532 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11535 Lisp_Object x
= XCAR (tem
);
11536 Lisp_Object y
= XCAR (XCDR (tem
));
11538 /* Point invisible due to hscrolling? */
11541 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11549 * Set up a new kboard object with reasonable initial values.
11555 kb
->Voverriding_terminal_local_map
= Qnil
;
11556 kb
->Vlast_command
= Qnil
;
11557 kb
->Vreal_last_command
= Qnil
;
11558 kb
->Vkeyboard_translate_table
= Qnil
;
11559 kb
->Vlast_repeatable_command
= Qnil
;
11560 kb
->Vprefix_arg
= Qnil
;
11561 kb
->Vlast_prefix_arg
= Qnil
;
11562 kb
->kbd_queue
= Qnil
;
11563 kb
->kbd_queue_has_data
= 0;
11564 kb
->immediate_echo
= 0;
11565 kb
->echo_string
= Qnil
;
11566 kb
->echo_after_prompt
= -1;
11567 kb
->kbd_macro_buffer
= 0;
11568 kb
->kbd_macro_bufsize
= 0;
11569 kb
->defining_kbd_macro
= Qnil
;
11570 kb
->Vlast_kbd_macro
= Qnil
;
11571 kb
->reference_count
= 0;
11572 kb
->Vsystem_key_alist
= Qnil
;
11573 kb
->system_key_syms
= Qnil
;
11574 kb
->Vwindow_system
= Qt
; /* Unset. */
11575 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11576 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11577 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11578 kb
->Vdefault_minibuffer_frame
= Qnil
;
11582 * Destroy the contents of a kboard object, but not the object itself.
11583 * We use this just before deleting it, or if we're going to initialize
11584 * it a second time.
11590 xfree (kb
->kbd_macro_buffer
);
11593 #ifdef MULTI_KBOARD
11595 /* Free KB and memory referenced from it. */
11603 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11606 *kbp
= kb
->next_kboard
;
11608 /* Prevent a dangling reference to KB. */
11609 if (kb
== current_kboard
11610 && FRAMEP (selected_frame
)
11611 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11613 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11615 if (current_kboard
== kb
)
11623 #endif /* MULTI_KBOARD */
11628 /* This is correct before outermost invocation of the editor loop */
11629 command_loop_level
= -1;
11630 immediate_quit
= 0;
11631 quit_char
= Ctl ('g');
11632 Vunread_command_events
= Qnil
;
11633 unread_command_char
= -1;
11634 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11636 recent_keys_index
= 0;
11637 kbd_fetch_ptr
= kbd_buffer
;
11638 kbd_store_ptr
= kbd_buffer
;
11639 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11640 do_mouse_tracking
= Qnil
;
11643 interrupt_input_blocked
= 0;
11644 interrupt_input_pending
= 0;
11646 /* This means that command_loop_1 won't try to select anything the first
11648 internal_last_event_frame
= Qnil
;
11649 Vlast_event_frame
= internal_last_event_frame
;
11651 #ifdef MULTI_KBOARD
11652 current_kboard
= initial_kboard
;
11654 /* Re-initialize the keyboard again. */
11655 wipe_kboard (current_kboard
);
11656 init_kboard (current_kboard
);
11657 /* A value of nil for Vwindow_system normally means a tty, but we also use
11658 it for the initial terminal since there is no window system there. */
11659 current_kboard
->Vwindow_system
= Qnil
;
11661 if (!noninteractive
)
11663 /* Before multi-tty support, these handlers used to be installed
11664 only if the current session was a tty session. Now an Emacs
11665 session may have multiple display types, so we always handle
11666 SIGINT. There is special code in interrupt_signal to exit
11667 Emacs on SIGINT when there are no termcap frames on the
11668 controlling terminal. */
11669 signal (SIGINT
, interrupt_signal
);
11670 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11671 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11672 SIGQUIT and we can't tell which one it will give us. */
11673 signal (SIGQUIT
, interrupt_signal
);
11674 #endif /* HAVE_TERMIO */
11676 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11678 if (!noninteractive
)
11679 signal (SIGIO
, input_available_signal
);
11682 /* Use interrupt input by default, if it works and noninterrupt input
11683 has deficiencies. */
11685 #ifdef INTERRUPT_INPUT
11686 interrupt_input
= 1;
11688 interrupt_input
= 0;
11691 /* Our VMS input only works by interrupts, as of now. */
11693 interrupt_input
= 1;
11699 if (keyboard_init_hook
)
11700 (*keyboard_init_hook
) ();
11702 #ifdef POLL_FOR_INPUT
11703 poll_suppress_count
= 1;
11708 /* This type's only use is in syms_of_keyboard, to initialize the
11709 event header symbols and put properties on them. */
11710 struct event_head
{
11716 struct event_head head_table
[] = {
11717 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11718 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11719 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11720 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11721 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11722 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11723 /* `select-window' should be handled just like `switch-frame'
11724 in read_key_sequence. */
11725 {&Qselect_window
, "select-window", &Qswitch_frame
}
11729 syms_of_keyboard ()
11731 pending_funcalls
= Qnil
;
11733 Vlispy_mouse_stem
= build_string ("mouse");
11734 staticpro (&Vlispy_mouse_stem
);
11737 QCimage
= intern (":image");
11738 staticpro (&QCimage
);
11740 staticpro (&Qhelp_echo
);
11741 Qhelp_echo
= intern ("help-echo");
11744 Qrtl
= intern (":rtl");
11746 staticpro (&item_properties
);
11747 item_properties
= Qnil
;
11749 staticpro (&tool_bar_item_properties
);
11750 tool_bar_item_properties
= Qnil
;
11751 staticpro (&tool_bar_items_vector
);
11752 tool_bar_items_vector
= Qnil
;
11754 staticpro (&real_this_command
);
11755 real_this_command
= Qnil
;
11757 Qtimer_event_handler
= intern ("timer-event-handler");
11758 staticpro (&Qtimer_event_handler
);
11760 Qdisabled_command_function
= intern ("disabled-command-function");
11761 staticpro (&Qdisabled_command_function
);
11763 Qself_insert_command
= intern ("self-insert-command");
11764 staticpro (&Qself_insert_command
);
11766 Qforward_char
= intern ("forward-char");
11767 staticpro (&Qforward_char
);
11769 Qbackward_char
= intern ("backward-char");
11770 staticpro (&Qbackward_char
);
11772 Qdisabled
= intern ("disabled");
11773 staticpro (&Qdisabled
);
11775 Qundefined
= intern ("undefined");
11776 staticpro (&Qundefined
);
11778 Qpre_command_hook
= intern ("pre-command-hook");
11779 staticpro (&Qpre_command_hook
);
11781 Qpost_command_hook
= intern ("post-command-hook");
11782 staticpro (&Qpost_command_hook
);
11784 Qdeferred_action_function
= intern ("deferred-action-function");
11785 staticpro (&Qdeferred_action_function
);
11787 Qcommand_hook_internal
= intern ("command-hook-internal");
11788 staticpro (&Qcommand_hook_internal
);
11790 Qfunction_key
= intern ("function-key");
11791 staticpro (&Qfunction_key
);
11792 Qmouse_click
= intern ("mouse-click");
11793 staticpro (&Qmouse_click
);
11794 #if defined (WINDOWSNT) || defined (MAC_OS)
11795 Qlanguage_change
= intern ("language-change");
11796 staticpro (&Qlanguage_change
);
11798 Qdrag_n_drop
= intern ("drag-n-drop");
11799 staticpro (&Qdrag_n_drop
);
11801 Qsave_session
= intern ("save-session");
11802 staticpro (&Qsave_session
);
11805 Qmac_apple_event
= intern ("mac-apple-event");
11806 staticpro (&Qmac_apple_event
);
11810 Qdbus_event
= intern ("dbus-event");
11811 staticpro (&Qdbus_event
);
11814 Qmenu_enable
= intern ("menu-enable");
11815 staticpro (&Qmenu_enable
);
11816 Qmenu_alias
= intern ("menu-alias");
11817 staticpro (&Qmenu_alias
);
11818 QCenable
= intern (":enable");
11819 staticpro (&QCenable
);
11820 QCvisible
= intern (":visible");
11821 staticpro (&QCvisible
);
11822 QChelp
= intern (":help");
11823 staticpro (&QChelp
);
11824 QCfilter
= intern (":filter");
11825 staticpro (&QCfilter
);
11826 QCbutton
= intern (":button");
11827 staticpro (&QCbutton
);
11828 QCkeys
= intern (":keys");
11829 staticpro (&QCkeys
);
11830 QCkey_sequence
= intern (":key-sequence");
11831 staticpro (&QCkey_sequence
);
11832 QCtoggle
= intern (":toggle");
11833 staticpro (&QCtoggle
);
11834 QCradio
= intern (":radio");
11835 staticpro (&QCradio
);
11837 Qmode_line
= intern ("mode-line");
11838 staticpro (&Qmode_line
);
11839 Qvertical_line
= intern ("vertical-line");
11840 staticpro (&Qvertical_line
);
11841 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11842 staticpro (&Qvertical_scroll_bar
);
11843 Qmenu_bar
= intern ("menu-bar");
11844 staticpro (&Qmenu_bar
);
11846 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11847 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11848 staticpro (&Qmouse_fixup_help_message
);
11851 Qabove_handle
= intern ("above-handle");
11852 staticpro (&Qabove_handle
);
11853 Qhandle
= intern ("handle");
11854 staticpro (&Qhandle
);
11855 Qbelow_handle
= intern ("below-handle");
11856 staticpro (&Qbelow_handle
);
11857 Qup
= intern ("up");
11859 Qdown
= intern ("down");
11860 staticpro (&Qdown
);
11861 Qtop
= intern ("top");
11863 Qbottom
= intern ("bottom");
11864 staticpro (&Qbottom
);
11865 Qend_scroll
= intern ("end-scroll");
11866 staticpro (&Qend_scroll
);
11867 Qratio
= intern ("ratio");
11868 staticpro (&Qratio
);
11870 Qevent_kind
= intern ("event-kind");
11871 staticpro (&Qevent_kind
);
11872 Qevent_symbol_elements
= intern ("event-symbol-elements");
11873 staticpro (&Qevent_symbol_elements
);
11874 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11875 staticpro (&Qevent_symbol_element_mask
);
11876 Qmodifier_cache
= intern ("modifier-cache");
11877 staticpro (&Qmodifier_cache
);
11879 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11880 staticpro (&Qrecompute_lucid_menubar
);
11881 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11882 staticpro (&Qactivate_menubar_hook
);
11884 Qpolling_period
= intern ("polling-period");
11885 staticpro (&Qpolling_period
);
11887 Qinput_method_function
= intern ("input-method-function");
11888 staticpro (&Qinput_method_function
);
11890 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11891 staticpro (&Qinput_method_exit_on_first_char
);
11892 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11893 staticpro (&Qinput_method_use_echo_area
);
11895 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11896 Fset (Qinput_method_use_echo_area
, Qnil
);
11898 last_point_position_buffer
= Qnil
;
11899 last_point_position_window
= Qnil
;
11902 struct event_head
*p
;
11904 for (p
= head_table
;
11905 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11908 *p
->var
= intern (p
->name
);
11909 staticpro (p
->var
);
11910 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11911 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11915 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11916 staticpro (&button_down_location
);
11917 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11918 staticpro (&mouse_syms
);
11919 wheel_syms
= Fmake_vector (make_number (4), Qnil
);
11920 staticpro (&wheel_syms
);
11924 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11926 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11927 for (i
= 0; i
< len
; i
++)
11928 if (modifier_names
[i
])
11929 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11930 staticpro (&modifier_symbols
);
11933 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11934 staticpro (&recent_keys
);
11936 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11937 staticpro (&this_command_keys
);
11939 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11940 staticpro (&raw_keybuf
);
11942 Qextended_command_history
= intern ("extended-command-history");
11943 Fset (Qextended_command_history
, Qnil
);
11944 staticpro (&Qextended_command_history
);
11946 accent_key_syms
= Qnil
;
11947 staticpro (&accent_key_syms
);
11949 func_key_syms
= Qnil
;
11950 staticpro (&func_key_syms
);
11952 drag_n_drop_syms
= Qnil
;
11953 staticpro (&drag_n_drop_syms
);
11955 unread_switch_frame
= Qnil
;
11956 staticpro (&unread_switch_frame
);
11958 internal_last_event_frame
= Qnil
;
11959 staticpro (&internal_last_event_frame
);
11961 read_key_sequence_cmd
= Qnil
;
11962 staticpro (&read_key_sequence_cmd
);
11964 menu_bar_one_keymap_changed_items
= Qnil
;
11965 staticpro (&menu_bar_one_keymap_changed_items
);
11967 menu_bar_items_vector
= Qnil
;
11968 staticpro (&menu_bar_items_vector
);
11970 help_form_saved_window_configs
= Qnil
;
11971 staticpro (&help_form_saved_window_configs
);
11973 defsubr (&Scurrent_idle_time
);
11974 defsubr (&Sevent_symbol_parse_modifiers
);
11975 defsubr (&Sevent_convert_list
);
11976 defsubr (&Sread_key_sequence
);
11977 defsubr (&Sread_key_sequence_vector
);
11978 defsubr (&Srecursive_edit
);
11979 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11980 defsubr (&Strack_mouse
);
11982 defsubr (&Sinput_pending_p
);
11983 defsubr (&Scommand_execute
);
11984 defsubr (&Srecent_keys
);
11985 defsubr (&Sthis_command_keys
);
11986 defsubr (&Sthis_command_keys_vector
);
11987 defsubr (&Sthis_single_command_keys
);
11988 defsubr (&Sthis_single_command_raw_keys
);
11989 defsubr (&Sreset_this_command_lengths
);
11990 defsubr (&Sclear_this_command_keys
);
11991 defsubr (&Ssuspend_emacs
);
11992 defsubr (&Sabort_recursive_edit
);
11993 defsubr (&Sexit_recursive_edit
);
11994 defsubr (&Srecursion_depth
);
11995 defsubr (&Stop_level
);
11996 defsubr (&Sdiscard_input
);
11997 defsubr (&Sopen_dribble_file
);
11998 defsubr (&Sset_input_interrupt_mode
);
11999 defsubr (&Sset_output_flow_control
);
12000 defsubr (&Sset_input_meta_mode
);
12001 defsubr (&Sset_quit_char
);
12002 defsubr (&Sset_input_mode
);
12003 defsubr (&Scurrent_input_mode
);
12004 defsubr (&Sexecute_extended_command
);
12005 defsubr (&Sposn_at_point
);
12006 defsubr (&Sposn_at_x_y
);
12008 DEFVAR_LISP ("last-command-char", &last_command_char
,
12009 doc
: /* Last input event that was part of a command. */);
12011 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
12012 doc
: /* Last input event that was part of a command. */);
12014 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
12015 doc
: /* Last input event in a command, except for mouse menu events.
12016 Mouse menus give back keys that don't look like mouse events;
12017 this variable holds the actual mouse event that led to the menu,
12018 so that you can determine whether the command was run by mouse or not. */);
12020 DEFVAR_LISP ("last-input-char", &last_input_char
,
12021 doc
: /* Last input event. */);
12023 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
12024 doc
: /* Last input event. */);
12026 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
12027 doc
: /* List of events to be read as the command input.
12028 These events are processed first, before actual keyboard input.
12029 Events read from this list are not normally added to `this-command-keys',
12030 as they will already have been added once as they were read for the first time.
12031 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
12032 Vunread_command_events
= Qnil
;
12034 DEFVAR_INT ("unread-command-char", &unread_command_char
,
12035 doc
: /* If not -1, an object to be read as next command input event. */);
12037 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
12038 doc
: /* List of events to be processed as input by input methods.
12039 These events are processed before `unread-command-events'
12040 and actual keyboard input, but are not given to `input-method-function'. */);
12041 Vunread_post_input_method_events
= Qnil
;
12043 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
12044 doc
: /* List of events to be processed as input by input methods.
12045 These events are processed after `unread-command-events', but
12046 before actual keyboard input.
12047 If there's an active input method, the events are given to
12048 `input-method-function'. */);
12049 Vunread_input_method_events
= Qnil
;
12051 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
12052 doc
: /* Meta-prefix character code.
12053 Meta-foo as command input turns into this character followed by foo. */);
12054 XSETINT (meta_prefix_char
, 033);
12056 DEFVAR_KBOARD ("last-command", Vlast_command
,
12057 doc
: /* The last command executed.
12058 Normally a symbol with a function definition, but can be whatever was found
12059 in the keymap, or whatever the variable `this-command' was set to by that
12062 The value `mode-exit' is special; it means that the previous command
12063 read an event that told it to exit, and it did so and unread that event.
12064 In other words, the present command is the event that made the previous
12067 The value `kill-region' is special; it means that the previous command
12068 was a kill command.
12070 `last-command' has a separate binding for each terminal device.
12071 See Info node `(elisp)Multiple displays'. */);
12073 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
12074 doc
: /* Same as `last-command', but never altered by Lisp code. */);
12076 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
12077 doc
: /* Last command that may be repeated.
12078 The last command executed that was not bound to an input event.
12079 This is the command `repeat' will try to repeat. */);
12081 DEFVAR_LISP ("this-command", &Vthis_command
,
12082 doc
: /* The command now being executed.
12083 The command can set this variable; whatever is put here
12084 will be in `last-command' during the following command. */);
12085 Vthis_command
= Qnil
;
12087 DEFVAR_LISP ("this-command-keys-shift-translated",
12088 &Vthis_command_keys_shift_translated
,
12089 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
12090 Shift-translation occurs when there is no binding for the key sequence
12091 as entered, but a binding was found by changing an upper-case letter
12092 to lower-case, or a shifted function key to an unshifted one. */);
12093 Vthis_command_keys_shift_translated
= Qnil
;
12095 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
12096 doc
: /* The command bound to the current key sequence before remapping.
12097 It equals `this-command' if the original command was not remapped through
12098 any of the active keymaps. Otherwise, the value of `this-command' is the
12099 result of looking up the original command in the active keymaps. */);
12100 Vthis_original_command
= Qnil
;
12102 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
12103 doc
: /* *Number of input events between auto-saves.
12104 Zero means disable autosaving due to number of characters typed. */);
12105 auto_save_interval
= 300;
12107 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
12108 doc
: /* *Number of seconds idle time before auto-save.
12109 Zero or nil means disable auto-saving due to idleness.
12110 After auto-saving due to this many seconds of idle time,
12111 Emacs also does a garbage collection if that seems to be warranted. */);
12112 XSETFASTINT (Vauto_save_timeout
, 30);
12114 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
12115 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
12116 The value may be integer or floating point. */);
12117 Vecho_keystrokes
= make_number (1);
12119 DEFVAR_INT ("polling-period", &polling_period
,
12120 doc
: /* *Interval between polling for input during Lisp execution.
12121 The reason for polling is to make C-g work to stop a running program.
12122 Polling is needed only when using X windows and SIGIO does not work.
12123 Polling is automatically disabled in all other cases. */);
12124 polling_period
= 2;
12126 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
12127 doc
: /* *Maximum time between mouse clicks to make a double-click.
12128 Measured in milliseconds. The value nil means disable double-click
12129 recognition; t means double-clicks have no time limit and are detected
12130 by position only. */);
12131 Vdouble_click_time
= make_number (500);
12133 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
12134 doc
: /* *Maximum mouse movement between clicks to make a double-click.
12135 On window-system frames, value is the number of pixels the mouse may have
12136 moved horizontally or vertically between two clicks to make a double-click.
12137 On non window-system frames, value is interpreted in units of 1/8 characters
12140 This variable is also the threshold for motion of the mouse
12141 to count as a drag. */);
12142 double_click_fuzz
= 3;
12144 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
12145 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
12146 inhibit_local_menu_bar_menus
= 0;
12148 DEFVAR_INT ("num-input-keys", &num_input_keys
,
12149 doc
: /* Number of complete key sequences read as input so far.
12150 This includes key sequences read from keyboard macros.
12151 The number is effectively the number of interactive command invocations. */);
12152 num_input_keys
= 0;
12154 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
12155 doc
: /* Number of input events read from the keyboard so far.
12156 This does not include events generated by keyboard macros. */);
12157 num_nonmacro_input_events
= 0;
12159 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
12160 doc
: /* The frame in which the most recently read event occurred.
12161 If the last event came from a keyboard macro, this is set to `macro'. */);
12162 Vlast_event_frame
= Qnil
;
12164 /* This variable is set up in sysdep.c. */
12165 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
12166 doc
: /* The ERASE character as set by the user with stty. */);
12168 DEFVAR_LISP ("help-char", &Vhelp_char
,
12169 doc
: /* Character to recognize as meaning Help.
12170 When it is read, do `(eval help-form)', and display result if it's a string.
12171 If the value of `help-form' is nil, this char can be read normally. */);
12172 XSETINT (Vhelp_char
, Ctl ('H'));
12174 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
12175 doc
: /* List of input events to recognize as meaning Help.
12176 These work just like the value of `help-char' (see that). */);
12177 Vhelp_event_list
= Qnil
;
12179 DEFVAR_LISP ("help-form", &Vhelp_form
,
12180 doc
: /* Form to execute when character `help-char' is read.
12181 If the form returns a string, that string is displayed.
12182 If `help-form' is nil, the help char is not recognized. */);
12185 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12186 doc
: /* Command to run when `help-char' character follows a prefix key.
12187 This command is used only when there is no actual binding
12188 for that character after that prefix key. */);
12189 Vprefix_help_command
= Qnil
;
12191 DEFVAR_LISP ("top-level", &Vtop_level
,
12192 doc
: /* Form to evaluate when Emacs starts up.
12193 Useful to set before you dump a modified Emacs. */);
12196 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12197 doc
: /* Translate table for local keyboard input, or nil.
12198 If non-nil, the value should be a char-table. Each character read
12199 from the keyboard is looked up in this char-table. If the value found
12200 there is non-nil, then it is used instead of the actual input character.
12202 The value can also be a string or vector, but this is considered obsolete.
12203 If it is a string or vector of length N, character codes N and up are left
12204 untranslated. In a vector, an element which is nil means "no translation".
12206 This is applied to the characters supplied to input methods, not their
12207 output. See also `translation-table-for-input'.
12209 This variable has a separate binding for each terminal. See Info node
12210 `(elisp)Multiple displays'. */);
12212 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12213 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12214 \(Even if the operating system has support for stopping a process.\) */);
12215 cannot_suspend
= 0;
12217 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12218 doc
: /* Non-nil means prompt with menus when appropriate.
12219 This is done when reading from a keymap that has a prompt string,
12220 for elements that have prompt strings.
12221 The menu is displayed on the screen
12222 if X menus were enabled at configuration
12223 time and the previous event was a mouse click prefix key.
12224 Otherwise, menu prompting uses the echo area. */);
12225 menu_prompting
= 1;
12227 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12228 doc
: /* Character to see next line of menu prompt.
12229 Type this character while in a menu prompt to rotate around the lines of it. */);
12230 XSETINT (menu_prompt_more_char
, ' ');
12232 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12233 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12234 Emacs applies the modifiers of the character stored here to each keyboard
12235 character it reads. For example, after evaluating the expression
12236 (setq extra-keyboard-modifiers ?\\C-x)
12237 all input characters will have the control modifier applied to them.
12239 Note that the character ?\\C-@, equivalent to the integer zero, does
12240 not count as a control character; rather, it counts as a character
12241 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12242 cancels any modification. */);
12243 extra_keyboard_modifiers
= 0;
12245 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12246 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12247 The command loop sets this to nil before each command,
12248 and tests the value when the command returns.
12249 Buffer modification stores t in this variable. */);
12250 Vdeactivate_mark
= Qnil
;
12251 Qdeactivate_mark
= intern ("deactivate-mark");
12252 staticpro (&Qdeactivate_mark
);
12254 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12255 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
12256 Vcommand_hook_internal
= Qnil
;
12258 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12259 doc
: /* Normal hook run before each command is executed.
12260 If an unhandled error happens in running this hook,
12261 the hook value is set to nil, since otherwise the error
12262 might happen repeatedly and make Emacs nonfunctional. */);
12263 Vpre_command_hook
= Qnil
;
12265 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12266 doc
: /* Normal hook run after each command is executed.
12267 If an unhandled error happens in running this hook,
12268 the hook value is set to nil, since otherwise the error
12269 might happen repeatedly and make Emacs nonfunctional. */);
12270 Vpost_command_hook
= Qnil
;
12273 DEFVAR_LISP ("echo-area-clear-hook", ...,
12274 doc
: /* Normal hook run when clearing the echo area. */);
12276 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
12277 staticpro (&Qecho_area_clear_hook
);
12278 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
12280 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12281 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12282 Vlucid_menu_bar_dirty_flag
= Qnil
;
12284 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12285 doc
: /* List of menu bar items to move to the end of the menu bar.
12286 The elements of the list are event types that may have menu bar bindings. */);
12287 Vmenu_bar_final_items
= Qnil
;
12289 DEFVAR_KBOARD ("overriding-terminal-local-map",
12290 Voverriding_terminal_local_map
,
12291 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12292 If this variable is non-nil, it is used as a keymap instead of the
12293 buffer's local map, and the minor mode keymaps and text property keymaps.
12294 It also replaces `overriding-local-map'.
12296 This variable is intended to let commands such as `universal-argument'
12297 set up a different keymap for reading the next command.
12299 `overriding-terminal-local-map' has a separate binding for each
12301 See Info node `(elisp)Multiple displays'. */);
12303 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12304 doc
: /* Keymap that overrides all other local keymaps.
12305 If this variable is non-nil, it is used as a keymap--replacing the
12306 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12307 Voverriding_local_map
= Qnil
;
12309 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12310 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12311 Otherwise, the menu bar continues to reflect the buffer's local map
12312 and the minor mode maps regardless of `overriding-local-map'. */);
12313 Voverriding_local_map_menu_flag
= Qnil
;
12315 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12316 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12317 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
12319 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12320 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12322 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12323 doc
: /* Alist of system-specific X windows key symbols.
12324 Each element should have the form (N . SYMBOL) where N is the
12325 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12326 and SYMBOL is its name.
12328 `system-key-alist' has a separate binding for each terminal device.
12329 See Info node `(elisp)Multiple displays'. */);
12331 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12332 doc
: /* Keymap that translates key sequences to key sequences during input.
12333 This is used mainly for mapping key sequences into some preferred
12334 key events (symbols).
12336 The `read-key-sequence' function replaces any subsequence bound by
12337 `local-function-key-map' with its binding. More precisely, when the
12338 active keymaps have no binding for the current key sequence but
12339 `local-function-key-map' binds a suffix of the sequence to a vector or
12340 string, `read-key-sequence' replaces the matching suffix with its
12341 binding, and continues with the new sequence.
12343 If the binding is a function, it is called with one argument (the prompt)
12344 and its return value (a key sequence) is used.
12346 The events that come from bindings in `local-function-key-map' are not
12347 themselves looked up in `local-function-key-map'.
12349 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12350 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12351 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12352 typing `ESC O P x' would return [f1 x].
12354 `local-function-key-map' has a separate binding for each terminal
12355 device. See Info node `(elisp)Multiple displays'. If you need to
12356 define a binding on all terminals, change `function-key-map'
12357 instead. Initially, `local-function-key-map' is an empty keymap that
12358 has `function-key-map' as its parent on all terminal devices. */);
12360 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12361 doc
: /* Keymap that decodes input escape sequences.
12362 This is used mainly for mapping ASCII function key sequences into
12363 real Emacs function key events (symbols).
12365 The `read-key-sequence' function replaces any subsequence bound by
12366 `local-function-key-map' with its binding. Contrary to `function-key-map',
12367 this map applies its rebinding regardless of the presence of an ordinary
12368 binding. So it is more like `key-translation-map' except that it applies
12369 before `function-key-map' rather than after.
12371 If the binding is a function, it is called with one argument (the prompt)
12372 and its return value (a key sequence) is used.
12374 The events that come from bindings in `input-decode-map' are not
12375 themselves looked up in `input-decode-map'.
12377 This variable is keyboard-local. */);
12379 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12380 doc
: /* The parent keymap of all `local-function-key-map' instances.
12381 Function key definitions that apply to all terminal devices should go
12382 here. If a mapping is defined in both the current
12383 `local-function-key-map' binding and this variable, then the local
12384 definition will take precendence. */);
12385 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12387 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12388 doc
: /* Keymap of key translations that can override keymaps.
12389 This keymap works like `function-key-map', but comes after that,
12390 and its non-prefix bindings override ordinary bindings.
12391 Another difference is that it is global rather than keyboard-local. */);
12392 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12394 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12395 doc
: /* List of deferred actions to be performed at a later time.
12396 The precise format isn't relevant here; we just check whether it is nil. */);
12397 Vdeferred_action_list
= Qnil
;
12399 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12400 doc
: /* Function to call to handle deferred actions, after each command.
12401 This function is called with no arguments after each command
12402 whenever `deferred-action-list' is non-nil. */);
12403 Vdeferred_action_function
= Qnil
;
12405 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12406 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12407 The value can be a length of time to show the message for.
12408 If the value is non-nil and not a number, we wait 2 seconds. */);
12409 Vsuggest_key_bindings
= Qt
;
12411 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12412 doc
: /* List of active absolute time timers in order of increasing time. */);
12413 Vtimer_list
= Qnil
;
12415 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12416 doc
: /* List of active idle-time timers in order of increasing time. */);
12417 Vtimer_idle_list
= Qnil
;
12419 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12420 doc
: /* If non-nil, the function that implements the current input method.
12421 It's called with one argument, a printing character that was just read.
12422 \(That means a character with code 040...0176.)
12423 Typically this function uses `read-event' to read additional events.
12424 When it does so, it should first bind `input-method-function' to nil
12425 so it will not be called recursively.
12427 The function should return a list of zero or more events
12428 to be used as input. If it wants to put back some events
12429 to be reconsidered, separately, by the input method,
12430 it can add them to the beginning of `unread-command-events'.
12432 The input method function can find in `input-method-previous-method'
12433 the previous echo area message.
12435 The input method function should refer to the variables
12436 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12437 for guidance on what to do. */);
12438 Vinput_method_function
= Qnil
;
12440 DEFVAR_LISP ("input-method-previous-message",
12441 &Vinput_method_previous_message
,
12442 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12443 This variable exists because `read-event' clears the echo area
12444 before running the input method. It is nil if there was no message. */);
12445 Vinput_method_previous_message
= Qnil
;
12447 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12448 doc
: /* If non-nil, the function that implements the display of help.
12449 It's called with one argument, the help string to display. */);
12450 Vshow_help_function
= Qnil
;
12452 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12453 doc
: /* If non-nil, suppress point adjustment after executing a command.
12455 After a command is executed, if point is moved into a region that has
12456 special properties (e.g. composition, display), we adjust point to
12457 the boundary of the region. But, when a command sets this variable to
12458 non-nil, we suppress the point adjustment.
12460 This variable is set to nil before reading a command, and is checked
12461 just after executing the command. */);
12462 Vdisable_point_adjustment
= Qnil
;
12464 DEFVAR_LISP ("global-disable-point-adjustment",
12465 &Vglobal_disable_point_adjustment
,
12466 doc
: /* *If non-nil, always suppress point adjustment.
12468 The default value is nil, in which case, point adjustment are
12469 suppressed only after special commands that set
12470 `disable-point-adjustment' (which see) to non-nil. */);
12471 Vglobal_disable_point_adjustment
= Qnil
;
12473 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12474 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12475 If the value is not a number, such messages don't time out. */);
12476 Vminibuffer_message_timeout
= make_number (2);
12478 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12479 doc
: /* If non-nil, any keyboard input throws to this symbol.
12480 The value of that variable is passed to `quit-flag' and later causes a
12481 peculiar kind of quitting. */);
12482 Vthrow_on_input
= Qnil
;
12484 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12485 doc
: /* If non-nil, function to output error messages.
12486 The arguments are the error data, a list of the form
12487 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12488 such as just as `condition-case' would bind its variable to,
12489 the context (a string which normally goes at the start of the message),
12490 and the Lisp function within which the error was signaled. */);
12491 Vcommand_error_function
= Qnil
;
12493 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12494 &Venable_disabled_menus_and_buttons
,
12495 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12497 Help functions bind this to allow help on disabled menu items
12498 and tool-bar buttons. */);
12499 Venable_disabled_menus_and_buttons
= Qnil
;
12501 #ifdef MULTI_KBOARD
12502 /* Create the initial keyboard. */
12503 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12504 init_kboard (initial_kboard
);
12505 /* Vwindow_system is left at t for now. */
12506 initial_kboard
->next_kboard
= all_kboards
;
12507 all_kboards
= initial_kboard
;
12512 keys_of_keyboard ()
12514 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12515 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12516 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12517 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12518 initial_define_key (meta_map
, 'x', "execute-extended-command");
12520 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12521 "handle-delete-frame");
12522 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12523 current-prefix-arg, as is done in `handle-switch-frame'.
12524 But `handle-switch-frame is not run from the special-map.
12525 Commands from that map are run in a special way that automatically
12526 preserves the prefix-arg. Restoring the prefix arg here is not just
12527 redundant but harmful:
12529 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12530 - after the first prompt, the exit-minibuffer-hook is run which may
12531 iconify a frame and thus push a `iconify-frame' event.
12532 - after running exit-minibuffer-hook, current-prefix-arg is
12533 restored to the non-nil value it had before the prompt.
12534 - we enter the second prompt.
12535 current-prefix-arg is non-nil, prefix-arg is nil.
12536 - before running the first real event, we run the special iconify-frame
12537 event, but we pass the `special' arg to execute-command so
12538 current-prefix-arg and prefix-arg are left untouched.
12539 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12540 - the next key event will have a spuriously non-nil current-prefix-arg. */
12541 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12543 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12545 /* Handling it at such a low-level causes read_key_sequence to get
12546 * confused because it doesn't realize that the current_buffer was
12547 * changed by read_char.
12549 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12550 * "handle-select-window"); */
12551 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12552 "handle-save-session");
12555 /* Define a special event which is raised for dbus callback
12557 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12558 "dbus-handle-event");
12562 /* Mark the pointers in the kboard objects.
12563 Called by the Fgarbage_collector. */
12569 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12571 if (kb
->kbd_macro_buffer
)
12572 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12574 mark_object (kb
->Voverriding_terminal_local_map
);
12575 mark_object (kb
->Vlast_command
);
12576 mark_object (kb
->Vreal_last_command
);
12577 mark_object (kb
->Vkeyboard_translate_table
);
12578 mark_object (kb
->Vlast_repeatable_command
);
12579 mark_object (kb
->Vprefix_arg
);
12580 mark_object (kb
->Vlast_prefix_arg
);
12581 mark_object (kb
->kbd_queue
);
12582 mark_object (kb
->defining_kbd_macro
);
12583 mark_object (kb
->Vlast_kbd_macro
);
12584 mark_object (kb
->Vsystem_key_alist
);
12585 mark_object (kb
->system_key_syms
);
12586 mark_object (kb
->Vwindow_system
);
12587 mark_object (kb
->Vinput_decode_map
);
12588 mark_object (kb
->Vlocal_function_key_map
);
12589 mark_object (kb
->Vdefault_minibuffer_frame
);
12590 mark_object (kb
->echo_string
);
12593 struct input_event
*event
;
12594 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12596 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12597 event
= kbd_buffer
;
12598 if (event
->kind
!= SELECTION_REQUEST_EVENT
12599 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12601 mark_object (event
->x
);
12602 mark_object (event
->y
);
12604 mark_object (event
->frame_or_window
);
12605 mark_object (event
->arg
);
12610 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12611 (do not change this comment) */