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 */
91 /* Variables for blockinput.h: */
93 /* Non-zero if interrupt input is blocked right now. */
94 volatile int interrupt_input_blocked
;
96 /* Nonzero means an input interrupt has arrived
97 during the current critical section. */
98 int interrupt_input_pending
;
100 #define KBD_BUFFER_SIZE 4096
103 KBOARD
*initial_kboard
;
104 KBOARD
*current_kboard
;
108 KBOARD the_only_kboard
;
111 /* Non-nil disable property on a command means
112 do not execute it; call disabled-command-function's value instead. */
113 Lisp_Object Qdisabled
, Qdisabled_command_function
;
115 #define NUM_RECENT_KEYS (300)
116 int recent_keys_index
; /* Index for storing next element into recent_keys */
117 int total_keys
; /* Total number of elements stored into recent_keys */
118 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
120 /* Vector holding the key sequence that invoked the current command.
121 It is reused for each command, and it may be longer than the current
122 sequence; this_command_key_count indicates how many elements
123 actually mean something.
124 It's easier to staticpro a single Lisp_Object than an array. */
125 Lisp_Object this_command_keys
;
126 int this_command_key_count
;
128 /* 1 after calling Freset_this_command_lengths.
130 int this_command_key_count_reset
;
132 /* This vector is used as a buffer to record the events that were actually read
133 by read_key_sequence. */
134 Lisp_Object raw_keybuf
;
135 int raw_keybuf_count
;
137 /* Non-nil if the present key sequence was obtained by shift translation. */
138 Lisp_Object Vthis_command_keys_shift_translated
;
140 #define GROW_RAW_KEYBUF \
141 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
142 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
144 /* Number of elements of this_command_keys
145 that precede this key sequence. */
146 int this_single_command_key_start
;
148 /* Record values of this_command_key_count and echo_length ()
149 before this command was read. */
150 static int before_command_key_count
;
151 static int before_command_echo_length
;
153 extern int minbuf_level
;
155 extern int message_enable_multibyte
;
157 /* If non-nil, the function that implements the display of help.
158 It's called with one argument, the help string to display. */
160 Lisp_Object Vshow_help_function
;
162 /* Nonzero means do menu prompting. */
164 static int menu_prompting
;
166 /* Character to see next line of menu prompt. */
168 static Lisp_Object menu_prompt_more_char
;
170 /* For longjmp to where kbd input is being done. */
172 static jmp_buf getcjmp
;
174 /* True while doing kbd input. */
175 int waiting_for_input
;
177 /* True while displaying for echoing. Delays C-g throwing. */
181 /* Non-null means we can start echoing at the next input pause even
182 though there is something in the echo area. */
184 static struct kboard
*ok_to_echo_at_next_pause
;
186 /* The kboard last echoing, or null for none. Reset to 0 in
187 cancel_echoing. If non-null, and a current echo area message
188 exists, and echo_message_buffer is eq to the current message
189 buffer, we know that the message comes from echo_kboard. */
191 struct kboard
*echo_kboard
;
193 /* The buffer used for echoing. Set in echo_now, reset in
196 Lisp_Object echo_message_buffer
;
198 /* Nonzero means disregard local maps for the menu bar. */
199 static int inhibit_local_menu_bar_menus
;
201 /* Nonzero means C-g should cause immediate error-signal. */
204 /* The user's hook function for outputting an error message. */
205 Lisp_Object Vcommand_error_function
;
207 /* The user's ERASE setting. */
208 Lisp_Object Vtty_erase_char
;
210 /* Character to recognize as the help char. */
211 Lisp_Object Vhelp_char
;
213 /* List of other event types to recognize as meaning "help". */
214 Lisp_Object Vhelp_event_list
;
216 /* Form to execute when help char is typed. */
217 Lisp_Object Vhelp_form
;
219 /* Command to run when the help character follows a prefix key. */
220 Lisp_Object Vprefix_help_command
;
222 /* List of items that should move to the end of the menu bar. */
223 Lisp_Object Vmenu_bar_final_items
;
225 /* Non-nil means show the equivalent key-binding for
226 any M-x command that has one.
227 The value can be a length of time to show the message for.
228 If the value is non-nil and not a number, we wait 2 seconds. */
229 Lisp_Object Vsuggest_key_bindings
;
231 /* How long to display an echo-area message when the minibuffer is active.
232 If the value is not a number, such messages don't time out. */
233 Lisp_Object Vminibuffer_message_timeout
;
235 /* Character that causes a quit. Normally C-g.
237 If we are running on an ordinary terminal, this must be an ordinary
238 ASCII char, since we want to make it our interrupt character.
240 If we are not running on an ordinary terminal, it still needs to be
241 an ordinary ASCII char. This character needs to be recognized in
242 the input interrupt handler. At this point, the keystroke is
243 represented as a struct input_event, while the desired quit
244 character is specified as a lispy event. The mapping from struct
245 input_events to lispy events cannot run in an interrupt handler,
246 and the reverse mapping is difficult for anything but ASCII
249 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
253 extern Lisp_Object current_global_map
;
254 extern int minibuf_level
;
256 /* If non-nil, this is a map that overrides all other local maps. */
257 Lisp_Object Voverriding_local_map
;
259 /* If non-nil, Voverriding_local_map applies to the menu bar. */
260 Lisp_Object Voverriding_local_map_menu_flag
;
262 /* Keymap that defines special misc events that should
263 be processed immediately at a low level. */
264 Lisp_Object Vspecial_event_map
;
266 /* Current depth in recursive edits. */
267 int command_loop_level
;
269 /* Total number of times command_loop has read a key sequence. */
270 EMACS_INT num_input_keys
;
272 /* Last input character read as a command. */
273 Lisp_Object last_command_char
;
275 /* Last input character read as a command, not counting menus
276 reached by the mouse. */
277 Lisp_Object last_nonmenu_event
;
279 /* Last input character read for any purpose. */
280 Lisp_Object last_input_char
;
282 /* If not Qnil, a list of objects to be read as subsequent command input. */
283 Lisp_Object Vunread_command_events
;
285 /* If not Qnil, a list of objects to be read as subsequent command input
286 including input method processing. */
287 Lisp_Object Vunread_input_method_events
;
289 /* If not Qnil, a list of objects to be read as subsequent command input
290 but NOT including input method processing. */
291 Lisp_Object Vunread_post_input_method_events
;
293 /* If not -1, an event to be read as subsequent command input. */
294 EMACS_INT unread_command_char
;
296 /* If not Qnil, this is a switch-frame event which we decided to put
297 off until the end of a key sequence. This should be read as the
298 next command input, after any unread_command_events.
300 read_key_sequence uses this to delay switch-frame events until the
301 end of the key sequence; Fread_char uses it to put off switch-frame
302 events until a non-ASCII event is acceptable as input. */
303 Lisp_Object unread_switch_frame
;
305 /* A mask of extra modifier bits to put into every keyboard char. */
306 EMACS_INT extra_keyboard_modifiers
;
308 /* Char to use as prefix when a meta character is typed in.
309 This is bound on entry to minibuffer in case ESC is changed there. */
311 Lisp_Object meta_prefix_char
;
313 /* Last size recorded for a current buffer which is not a minibuffer. */
314 static int last_non_minibuf_size
;
316 /* Number of idle seconds before an auto-save and garbage collection. */
317 static Lisp_Object Vauto_save_timeout
;
319 /* Total number of times read_char has returned. */
320 int num_input_events
;
322 /* Total number of times read_char has returned, outside of macros. */
323 EMACS_INT num_nonmacro_input_events
;
325 /* Auto-save automatically when this many characters have been typed
326 since the last time. */
328 static EMACS_INT auto_save_interval
;
330 /* Value of num_nonmacro_input_events as of last auto save. */
334 /* The command being executed by the command loop.
335 Commands may set this, and the value set will be copied into
336 current_kboard->Vlast_command instead of the actual command. */
337 Lisp_Object Vthis_command
;
339 /* This is like Vthis_command, except that commands never set it. */
340 Lisp_Object real_this_command
;
342 /* If the lookup of the command returns a binding, the original
343 command is stored in this-original-command. It is nil otherwise. */
344 Lisp_Object Vthis_original_command
;
346 /* The value of point when the last command was started. */
347 int last_point_position
;
349 /* The buffer that was current when the last command was started. */
350 Lisp_Object last_point_position_buffer
;
352 /* The window that was selected when the last command was started. */
353 Lisp_Object last_point_position_window
;
355 /* The frame in which the last input event occurred, or Qmacro if the
356 last event came from a macro. We use this to determine when to
357 generate switch-frame events. This may be cleared by functions
358 like Fselect_frame, to make sure that a switch-frame event is
359 generated by the next character. */
360 Lisp_Object internal_last_event_frame
;
362 /* A user-visible version of the above, intended to allow users to
363 figure out where the last event came from, if the event doesn't
364 carry that information itself (i.e. if it was a character). */
365 Lisp_Object Vlast_event_frame
;
367 /* The timestamp of the last input event we received from the X server.
368 X Windows wants this for selection ownership. */
369 unsigned long last_event_timestamp
;
371 Lisp_Object Qself_insert_command
;
372 Lisp_Object Qforward_char
;
373 Lisp_Object Qbackward_char
;
374 Lisp_Object Qundefined
;
375 Lisp_Object Qtimer_event_handler
;
377 /* read_key_sequence stores here the command definition of the
378 key sequence that it reads. */
379 Lisp_Object read_key_sequence_cmd
;
381 /* Echo unfinished commands after this many seconds of pause. */
382 Lisp_Object Vecho_keystrokes
;
384 /* Form to evaluate (if non-nil) when Emacs is started. */
385 Lisp_Object Vtop_level
;
387 /* If non-nil, this implements the current input method. */
388 Lisp_Object Vinput_method_function
;
389 Lisp_Object Qinput_method_function
;
391 /* When we call Vinput_method_function,
392 this holds the echo area message that was just erased. */
393 Lisp_Object Vinput_method_previous_message
;
395 /* Non-nil means deactivate the mark at end of this command. */
396 Lisp_Object Vdeactivate_mark
;
397 Lisp_Object Qdeactivate_mark
;
399 /* Menu bar specified in Lucid Emacs fashion. */
401 Lisp_Object Vlucid_menu_bar_dirty_flag
;
402 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
404 Lisp_Object Qecho_area_clear_hook
;
406 /* Hooks to run before and after each command. */
407 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
408 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
409 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
411 /* Parent keymap of terminal-local function-key-map instances. */
412 Lisp_Object Vfunction_key_map
;
414 /* Keymap of key translations that can override keymaps. */
415 Lisp_Object Vkey_translation_map
;
417 /* List of deferred actions to be performed at a later time.
418 The precise format isn't relevant here; we just check whether it is nil. */
419 Lisp_Object Vdeferred_action_list
;
421 /* Function to call to handle deferred actions, when there are any. */
422 Lisp_Object Vdeferred_action_function
;
423 Lisp_Object Qdeferred_action_function
;
425 Lisp_Object Qinput_method_exit_on_first_char
;
426 Lisp_Object Qinput_method_use_echo_area
;
428 /* File in which we write all commands we read. */
431 /* Nonzero if input is available. */
434 extern char *pending_malloc_warning
;
436 /* Circular buffer for pre-read keyboard input. */
438 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
440 /* Pointer to next available character in kbd_buffer.
441 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
442 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
443 next available char is in kbd_buffer[0]. */
444 static struct input_event
*kbd_fetch_ptr
;
446 /* Pointer to next place to store character in kbd_buffer. This
447 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
448 character should go in kbd_buffer[0]. */
449 static struct input_event
* volatile kbd_store_ptr
;
451 /* The above pair of variables forms a "queue empty" flag. When we
452 enqueue a non-hook event, we increment kbd_store_ptr. When we
453 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
454 there is input available if the two pointers are not equal.
456 Why not just have a flag set and cleared by the enqueuing and
457 dequeuing functions? Such a flag could be screwed up by interrupts
458 at inopportune times. */
460 /* If this flag is non-nil, we check mouse_moved to see when the
461 mouse moves, and motion events will appear in the input stream.
462 Otherwise, mouse motion is ignored. */
463 Lisp_Object do_mouse_tracking
;
465 /* Symbols to head events. */
466 Lisp_Object Qmouse_movement
;
467 Lisp_Object Qscroll_bar_movement
;
468 Lisp_Object Qswitch_frame
;
469 Lisp_Object Qdelete_frame
;
470 Lisp_Object Qiconify_frame
;
471 Lisp_Object Qmake_frame_visible
;
472 Lisp_Object Qselect_window
;
473 Lisp_Object Qhelp_echo
;
475 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
476 Lisp_Object Qmouse_fixup_help_message
;
479 /* Symbols to denote kinds of events. */
480 Lisp_Object Qfunction_key
;
481 Lisp_Object Qmouse_click
;
482 #if defined (WINDOWSNT) || defined (MAC_OS)
483 Lisp_Object Qlanguage_change
;
485 Lisp_Object Qdrag_n_drop
;
486 Lisp_Object Qsave_session
;
488 Lisp_Object Qmac_apple_event
;
491 Lisp_Object Qdbus_event
;
493 /* Lisp_Object Qmouse_movement; - also an event header */
495 /* Properties of event headers. */
496 Lisp_Object Qevent_kind
;
497 Lisp_Object Qevent_symbol_elements
;
499 /* menu item parts */
500 Lisp_Object Qmenu_alias
;
501 Lisp_Object Qmenu_enable
;
502 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
503 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
504 extern Lisp_Object Vdefine_key_rebound_commands
;
505 extern Lisp_Object Qmenu_item
;
507 /* An event header symbol HEAD may have a property named
508 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
509 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
510 mask of modifiers applied to it. If present, this is used to help
511 speed up parse_modifiers. */
512 Lisp_Object Qevent_symbol_element_mask
;
514 /* An unmodified event header BASE may have a property named
515 Qmodifier_cache, which is an alist mapping modifier masks onto
516 modified versions of BASE. If present, this helps speed up
518 Lisp_Object Qmodifier_cache
;
520 /* Symbols to use for parts of windows. */
521 Lisp_Object Qmode_line
;
522 Lisp_Object Qvertical_line
;
523 Lisp_Object Qvertical_scroll_bar
;
524 Lisp_Object Qmenu_bar
;
525 extern Lisp_Object Qleft_margin
, Qright_margin
;
526 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
527 extern Lisp_Object QCmap
;
529 Lisp_Object
recursive_edit_unwind (), command_loop ();
530 Lisp_Object
Fthis_command_keys ();
531 Lisp_Object Qextended_command_history
;
532 EMACS_TIME
timer_check ();
534 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
536 extern char *x_get_keysym_name ();
538 static void record_menu_key ();
539 static int echo_length ();
541 Lisp_Object Qpolling_period
;
543 /* List of absolute timers. Appears in order of next scheduled event. */
544 Lisp_Object Vtimer_list
;
546 /* List of idle time timers. Appears in order of next scheduled event. */
547 Lisp_Object Vtimer_idle_list
;
549 /* Incremented whenever a timer is run. */
552 extern Lisp_Object Vprint_level
, Vprint_length
;
554 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
556 EMACS_TIME
*input_available_clear_time
;
558 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
559 Default is 1 if INTERRUPT_INPUT is defined. */
562 /* Nonzero while interrupts are temporarily deferred during redisplay. */
563 int interrupts_deferred
;
565 /* Allow m- file to inhibit use of FIONREAD. */
566 #ifdef BROKEN_FIONREAD
570 /* We are unable to use interrupts if FIONREAD is not available,
571 so flush SIGIO so we won't try. */
572 #if !defined (FIONREAD)
578 /* If we support a window system, turn on the code to poll periodically
579 to detect C-g. It isn't actually used when doing interrupt input. */
580 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
581 #define POLL_FOR_INPUT
584 /* After a command is executed, if point is moved into a region that
585 has specific properties (e.g. composition, display), we adjust
586 point to the boundary of the region. But, if a command sets this
587 variable to non-nil, we suppress this point adjustment. This
588 variable is set to nil before reading a command. */
590 Lisp_Object Vdisable_point_adjustment
;
592 /* If non-nil, always disable point adjustment. */
594 Lisp_Object Vglobal_disable_point_adjustment
;
596 /* The time when Emacs started being idle. */
598 static EMACS_TIME timer_idleness_start_time
;
600 /* After Emacs stops being idle, this saves the last value
601 of timer_idleness_start_time from when it was idle. */
603 static EMACS_TIME timer_last_idleness_start_time
;
605 /* If non-nil, events produced by disabled menu items and tool-bar
606 buttons are not ignored. Help functions bind this to allow help on
607 those items and buttons. */
608 Lisp_Object Venable_disabled_menus_and_buttons
;
611 /* Global variable declarations. */
613 /* Flags for readable_events. */
614 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
615 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
616 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
618 /* Function for init_keyboard to call with no args (if nonzero). */
619 void (*keyboard_init_hook
) ();
621 static int read_avail_input
P_ ((int));
622 static void get_input_pending
P_ ((int *, int));
623 static int readable_events
P_ ((int));
624 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
625 Lisp_Object
, int *));
626 static Lisp_Object
read_char_x_menu_prompt ();
627 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
629 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
630 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
631 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
632 enum scroll_bar_part
,
633 Lisp_Object
, Lisp_Object
,
636 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
637 Lisp_Object
, char **,
638 Lisp_Object
*, unsigned));
639 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
640 static void save_getcjmp
P_ ((jmp_buf));
641 static void save_getcjmp ();
642 static void restore_getcjmp
P_ ((jmp_buf));
643 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
644 static void clear_event
P_ ((struct input_event
*));
646 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
648 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
649 static void handle_interrupt
P_ ((void));
650 static void timer_start_idle
P_ ((void));
651 static void timer_stop_idle
P_ ((void));
652 static void timer_resume_idle
P_ ((void));
653 static SIGTYPE handle_user_signal
P_ ((int));
654 static char *find_user_signal_name
P_ ((int));
655 static int store_user_signal_events
P_ ((void));
657 /* Nonzero means don't try to suspend even if the operating system seems
659 static int cannot_suspend
;
661 extern Lisp_Object Qidentity
, Qonly
;
663 /* Install the string STR as the beginning of the string of echoing,
664 so that it serves as a prompt for the next character.
665 Also start echoing. */
671 current_kboard
->echo_string
= str
;
672 current_kboard
->echo_after_prompt
= SCHARS (str
);
676 /* Add C to the echo string, if echoing is going on.
677 C can be a character, which is printed prettily ("M-C-x" and all that
678 jazz), or a symbol, whose name is printed. */
684 if (current_kboard
->immediate_echo
)
686 int size
= KEY_DESCRIPTION_SIZE
+ 100;
687 char *buffer
= (char *) alloca (size
);
689 Lisp_Object echo_string
;
691 echo_string
= current_kboard
->echo_string
;
693 /* If someone has passed us a composite event, use its head symbol. */
698 ptr
= push_key_description (XINT (c
), ptr
, 1);
700 else if (SYMBOLP (c
))
702 Lisp_Object name
= SYMBOL_NAME (c
);
703 int nbytes
= SBYTES (name
);
705 if (size
- (ptr
- buffer
) < nbytes
)
707 int offset
= ptr
- buffer
;
708 size
= max (2 * size
, size
+ nbytes
);
709 buffer
= (char *) alloca (size
);
710 ptr
= buffer
+ offset
;
713 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
714 STRING_MULTIBYTE (name
), 1);
717 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
720 const char *text
= " (Type ? for further options)";
721 int len
= strlen (text
);
723 if (size
- (ptr
- buffer
) < len
)
725 int offset
= ptr
- buffer
;
727 buffer
= (char *) alloca (size
);
728 ptr
= buffer
+ offset
;
731 bcopy (text
, ptr
, len
);
735 /* Replace a dash from echo_dash with a space, otherwise
736 add a space at the end as a separator between keys. */
737 if (STRINGP (echo_string
)
738 && SCHARS (echo_string
) > 1)
740 Lisp_Object last_char
, prev_char
, idx
;
742 idx
= make_number (SCHARS (echo_string
) - 2);
743 prev_char
= Faref (echo_string
, idx
);
745 idx
= make_number (SCHARS (echo_string
) - 1);
746 last_char
= Faref (echo_string
, idx
);
748 /* We test PREV_CHAR to make sure this isn't the echoing
750 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
751 Faset (echo_string
, idx
, make_number (' '));
753 echo_string
= concat2 (echo_string
, build_string (" "));
755 else if (STRINGP (echo_string
))
756 echo_string
= concat2 (echo_string
, build_string (" "));
758 current_kboard
->echo_string
759 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
765 /* Temporarily add a dash to the end of the echo string if it's not
766 empty, so that it serves as a mini-prompt for the very next character. */
771 /* Do nothing if not echoing at all. */
772 if (NILP (current_kboard
->echo_string
))
775 if (!current_kboard
->immediate_echo
776 && SCHARS (current_kboard
->echo_string
) == 0)
779 /* Do nothing if we just printed a prompt. */
780 if (current_kboard
->echo_after_prompt
781 == SCHARS (current_kboard
->echo_string
))
784 /* Do nothing if we have already put a dash at the end. */
785 if (SCHARS (current_kboard
->echo_string
) > 1)
787 Lisp_Object last_char
, prev_char
, idx
;
789 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
790 prev_char
= Faref (current_kboard
->echo_string
, idx
);
792 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
793 last_char
= Faref (current_kboard
->echo_string
, idx
);
795 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
799 /* Put a dash at the end of the buffer temporarily,
800 but make it go away when the next character is added. */
801 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
806 /* Display the current echo string, and begin echoing if not already
812 if (!current_kboard
->immediate_echo
)
815 current_kboard
->immediate_echo
= 1;
817 for (i
= 0; i
< this_command_key_count
; i
++)
821 /* Set before_command_echo_length to the value that would
822 have been saved before the start of this subcommand in
823 command_loop_1, if we had already been echoing then. */
824 if (i
== this_single_command_key_start
)
825 before_command_echo_length
= echo_length ();
827 c
= XVECTOR (this_command_keys
)->contents
[i
];
828 if (! (EVENT_HAS_PARAMETERS (c
)
829 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
833 /* Set before_command_echo_length to the value that would
834 have been saved before the start of this subcommand in
835 command_loop_1, if we had already been echoing then. */
836 if (this_command_key_count
== this_single_command_key_start
)
837 before_command_echo_length
= echo_length ();
839 /* Put a dash at the end to invite the user to type more. */
844 message3_nolog (current_kboard
->echo_string
,
845 SBYTES (current_kboard
->echo_string
),
846 STRING_MULTIBYTE (current_kboard
->echo_string
));
849 /* Record in what buffer we echoed, and from which kboard. */
850 echo_message_buffer
= echo_area_buffer
[0];
851 echo_kboard
= current_kboard
;
853 if (waiting_for_input
&& !NILP (Vquit_flag
))
854 quit_throw_to_read_char ();
857 /* Turn off echoing, for the start of a new command. */
862 current_kboard
->immediate_echo
= 0;
863 current_kboard
->echo_after_prompt
= -1;
864 current_kboard
->echo_string
= Qnil
;
865 ok_to_echo_at_next_pause
= NULL
;
867 echo_message_buffer
= Qnil
;
870 /* Return the length of the current echo string. */
875 return (STRINGP (current_kboard
->echo_string
)
876 ? SCHARS (current_kboard
->echo_string
)
880 /* Truncate the current echo message to its first LEN chars.
881 This and echo_char get used by read_key_sequence when the user
882 switches frames while entering a key sequence. */
885 echo_truncate (nchars
)
888 if (STRINGP (current_kboard
->echo_string
))
889 current_kboard
->echo_string
890 = Fsubstring (current_kboard
->echo_string
,
891 make_number (0), make_number (nchars
));
892 truncate_echo_area (nchars
);
896 /* Functions for manipulating this_command_keys. */
898 add_command_key (key
)
901 #if 0 /* Not needed after we made Freset_this_command_lengths
902 do the job immediately. */
903 /* If reset-this-command-length was called recently, obey it now.
904 See the doc string of that function for an explanation of why. */
905 if (before_command_restore_flag
)
907 this_command_key_count
= before_command_key_count_1
;
908 if (this_command_key_count
< this_single_command_key_start
)
909 this_single_command_key_start
= this_command_key_count
;
910 echo_truncate (before_command_echo_length_1
);
911 before_command_restore_flag
= 0;
915 if (this_command_key_count
>= ASIZE (this_command_keys
))
916 this_command_keys
= larger_vector (this_command_keys
,
917 2 * ASIZE (this_command_keys
),
920 ASET (this_command_keys
, this_command_key_count
, key
);
921 ++this_command_key_count
;
928 int count
= SPECPDL_INDEX ();
931 if (command_loop_level
> 0)
933 specbind (Qstandard_output
, Qt
);
934 specbind (Qstandard_input
, Qt
);
937 #ifdef HAVE_WINDOW_SYSTEM
938 /* The command loop has started an hourglass timer, so we have to
939 cancel it here, otherwise it will fire because the recursive edit
940 can take some time. Do not check for display_hourglass_p here,
941 because it could already be nil. */
945 /* This function may have been called from a debugger called from
946 within redisplay, for instance by Edebugging a function called
947 from fontification-functions. We want to allow redisplay in
948 the debugging session.
950 The recursive edit is left with a `(throw exit ...)'. The `exit'
951 tag is not caught anywhere in redisplay, i.e. when we leave the
952 recursive edit, the original redisplay leading to the recursive
953 edit will be unwound. The outcome should therefore be safe. */
954 specbind (Qinhibit_redisplay
, Qnil
);
957 val
= command_loop ();
959 Fsignal (Qquit
, Qnil
);
960 /* Handle throw from read_minibuf when using minibuffer
961 while it's active but we're in another window. */
963 xsignal1 (Qerror
, val
);
965 return unbind_to (count
, Qnil
);
968 /* When an auto-save happens, record the "time", and don't do again soon. */
973 last_auto_save
= num_nonmacro_input_events
;
976 /* Make an auto save happen as soon as possible at command level. */
979 force_auto_save_soon ()
981 last_auto_save
= - auto_save_interval
- 1;
983 record_asynch_buffer_change ();
986 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
987 doc
: /* Invoke the editor command loop recursively.
988 To get out of the recursive edit, a command can do `(throw 'exit nil)';
989 that tells this function to return.
990 Alternatively, `(throw 'exit t)' makes this function signal an error.
991 This function is called by the editor initialization to begin editing. */)
994 int count
= SPECPDL_INDEX ();
997 /* If we enter while input is blocked, don't lock up here.
998 This may happen through the debugger during redisplay. */
1002 command_loop_level
++;
1003 update_mode_lines
= 1;
1005 if (command_loop_level
1006 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1007 buffer
= Fcurrent_buffer ();
1011 /* If we leave recursive_edit_1 below with a `throw' for instance,
1012 like it is done in the splash screen display, we have to
1013 make sure that we restore single_kboard as command_loop_1
1014 would have done if it were left normally. */
1015 if (command_loop_level
> 0)
1016 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1017 record_unwind_protect (recursive_edit_unwind
, buffer
);
1019 recursive_edit_1 ();
1020 return unbind_to (count
, Qnil
);
1024 recursive_edit_unwind (buffer
)
1027 if (BUFFERP (buffer
))
1028 Fset_buffer (buffer
);
1030 command_loop_level
--;
1031 update_mode_lines
= 1;
1036 #if 0 /* These two functions are now replaced with
1037 temporarily_switch_to_single_kboard. */
1042 #if 0 /* Theory: if there's anything in Vunread_command_events,
1043 it will right away be read by read_key_sequence,
1044 and then if we do switch KBOARDS, it will go into the side
1045 queue then. So we don't need to do anything special here -- rms. */
1046 if (CONSP (Vunread_command_events
))
1048 current_kboard
->kbd_queue
1049 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1050 current_kboard
->kbd_queue_has_data
= 1;
1052 Vunread_command_events
= Qnil
;
1058 /* Switch to the single-kboard state, making current_kboard
1059 the only KBOARD from which further input is accepted. */
1062 single_kboard_state ()
1070 /* If we're in single_kboard state for kboard KBOARD,
1074 not_single_kboard_state (kboard
)
1078 if (kboard
== current_kboard
)
1083 /* Maintain a stack of kboards, so other parts of Emacs
1084 can switch temporarily to the kboard of a given frame
1085 and then revert to the previous status. */
1090 struct kboard_stack
*next
;
1093 static struct kboard_stack
*kboard_stack
;
1100 struct kboard_stack
*p
1101 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1103 p
->next
= kboard_stack
;
1104 p
->kboard
= current_kboard
;
1116 struct kboard_stack
*p
= kboard_stack
;
1118 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1120 if (t
->kboard
== p
->kboard
)
1122 current_kboard
= p
->kboard
;
1129 /* The terminal we remembered has been deleted. */
1130 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1133 kboard_stack
= p
->next
;
1138 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1139 from which further input is accepted. If F is non-nil, set its
1140 KBOARD as the current keyboard.
1142 This function uses record_unwind_protect to return to the previous
1145 If Emacs is already in single_kboard mode, and F's keyboard is
1146 locked, then this function will throw an errow. */
1149 temporarily_switch_to_single_kboard (f
)
1153 int was_locked
= single_kboard
;
1156 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1157 /* We can not switch keyboards while in single_kboard mode.
1158 In rare cases, Lisp code may call `recursive-edit' (or
1159 `read-minibuffer' or `y-or-n-p') after it switched to a
1160 locked frame. For example, this is likely to happen
1161 when server.el connects to a new terminal while Emacs is in
1162 single_kboard mode. It is best to throw an error instead
1163 of presenting the user with a frozen screen. */
1164 error ("Terminal %d is locked, cannot read from it",
1165 FRAME_TERMINAL (f
)->id
);
1167 /* This call is unnecessary, but helps
1168 `restore_kboard_configuration' discover if somebody changed
1169 `current_kboard' behind our back. */
1170 push_kboard (current_kboard
);
1173 current_kboard
= FRAME_KBOARD (f
);
1175 record_unwind_protect (restore_kboard_configuration
,
1176 (was_locked
? Qt
: Qnil
));
1180 #if 0 /* This function is not needed anymore. */
1182 record_single_kboard_state ()
1185 push_kboard (current_kboard
);
1186 record_unwind_protect (restore_kboard_configuration
,
1187 (single_kboard
? Qt
: Qnil
));
1193 restore_kboard_configuration (was_locked
)
1194 Lisp_Object was_locked
;
1196 if (NILP (was_locked
))
1200 struct kboard
*prev
= current_kboard
;
1203 /* The pop should not change the kboard. */
1204 if (single_kboard
&& current_kboard
!= prev
)
1212 /* Handle errors that are not handled at inner levels
1213 by printing an error message and returning to the editor command loop. */
1219 Lisp_Object old_level
, old_length
;
1220 char macroerror
[50];
1222 #ifdef HAVE_WINDOW_SYSTEM
1223 if (display_hourglass_p
)
1224 cancel_hourglass ();
1227 if (!NILP (executing_kbd_macro
))
1229 if (executing_kbd_macro_iterations
== 1)
1230 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1232 sprintf (macroerror
, "After %d kbd macro iterations: ",
1233 executing_kbd_macro_iterations
);
1238 Vstandard_output
= Qt
;
1239 Vstandard_input
= Qt
;
1240 Vexecuting_kbd_macro
= Qnil
;
1241 executing_kbd_macro
= Qnil
;
1242 current_kboard
->Vprefix_arg
= Qnil
;
1243 current_kboard
->Vlast_prefix_arg
= Qnil
;
1246 /* Avoid unquittable loop if data contains a circular list. */
1247 old_level
= Vprint_level
;
1248 old_length
= Vprint_length
;
1249 XSETFASTINT (Vprint_level
, 10);
1250 XSETFASTINT (Vprint_length
, 10);
1251 cmd_error_internal (data
, macroerror
);
1252 Vprint_level
= old_level
;
1253 Vprint_length
= old_length
;
1257 Vinhibit_quit
= Qnil
;
1258 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1260 if (command_loop_level
== 0 && minibuf_level
== 0)
1261 any_kboard_state ();
1265 return make_number (0);
1268 /* Take actions on handling an error. DATA is the data that describes
1271 CONTEXT is a C-string containing ASCII characters only which
1272 describes the context in which the error happened. If we need to
1273 generalize CONTEXT to allow multibyte characters, make it a Lisp
1277 cmd_error_internal (data
, context
)
1281 struct frame
*sf
= SELECTED_FRAME ();
1283 /* The immediate context is not interesting for Quits,
1284 since they are asyncronous. */
1285 if (EQ (XCAR (data
), Qquit
))
1286 Vsignaling_function
= Qnil
;
1291 /* Use user's specified output function if any. */
1292 if (!NILP (Vcommand_error_function
))
1293 call3 (Vcommand_error_function
, data
,
1294 context
? build_string (context
) : empty_unibyte_string
,
1295 Vsignaling_function
);
1296 /* If the window system or terminal frame hasn't been initialized
1297 yet, or we're not interactive, write the message to stderr and exit. */
1298 else if (!sf
->glyphs_initialized_p
1299 || FRAME_INITIAL_P (sf
)
1302 print_error_message (data
, Qexternal_debugging_output
,
1303 context
, Vsignaling_function
);
1304 Fterpri (Qexternal_debugging_output
);
1305 Fkill_emacs (make_number (-1));
1309 clear_message (1, 0);
1311 message_log_maybe_newline ();
1314 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1317 Vsignaling_function
= Qnil
;
1320 Lisp_Object
command_loop_1 ();
1321 Lisp_Object
command_loop_2 ();
1322 Lisp_Object
top_level_1 ();
1324 /* Entry to editor-command-loop.
1325 This level has the catches for exiting/returning to editor command loop.
1326 It returns nil to exit recursive edit, t to abort it. */
1331 if (command_loop_level
> 0 || minibuf_level
> 0)
1334 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1335 executing_kbd_macro
= Qnil
;
1341 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1342 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1343 /* Reset single_kboard in case top-level set it while
1344 evaluating an -f option, or we are stuck there for some
1346 any_kboard_state ();
1348 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1349 executing_kbd_macro
= Qnil
;
1351 /* End of file in -batch run causes exit here. */
1357 /* Here we catch errors in execution of commands within the
1358 editing loop, and reenter the editing loop.
1359 When there is an error, cmd_error runs and returns a non-nil
1360 value to us. A value of nil means that command_loop_1 itself
1361 returned due to end of file (or end of kbd macro). */
1366 register Lisp_Object val
;
1369 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1370 while (!NILP (val
));
1378 return Feval (Vtop_level
);
1384 /* On entry to the outer level, run the startup file */
1385 if (!NILP (Vtop_level
))
1386 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1387 else if (!NILP (Vpurify_flag
))
1388 message ("Bare impure Emacs (standard Lisp code not loaded)");
1390 message ("Bare Emacs (standard Lisp code not loaded)");
1394 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1395 doc
: /* Exit all recursive editing levels. */)
1398 #ifdef HAVE_WINDOW_SYSTEM
1399 if (display_hourglass_p
)
1400 cancel_hourglass ();
1403 /* Unblock input if we enter with input blocked. This may happen if
1404 redisplay traps e.g. during tool-bar update with input blocked. */
1405 while (INPUT_BLOCKED_P
)
1408 return Fthrow (Qtop_level
, Qnil
);
1411 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1412 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1415 if (command_loop_level
> 0 || minibuf_level
> 0)
1416 Fthrow (Qexit
, Qnil
);
1418 error ("No recursive edit is in progress");
1422 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1423 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1426 if (command_loop_level
> 0 || minibuf_level
> 0)
1429 error ("No recursive edit is in progress");
1433 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1435 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1436 of this function. */
1439 tracking_off (old_value
)
1440 Lisp_Object old_value
;
1442 do_mouse_tracking
= old_value
;
1443 if (NILP (old_value
))
1445 /* Redisplay may have been preempted because there was input
1446 available, and it assumes it will be called again after the
1447 input has been processed. If the only input available was
1448 the sort that we have just disabled, then we need to call
1450 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1452 redisplay_preserve_echo_area (6);
1453 get_input_pending (&input_pending
,
1454 READABLE_EVENTS_DO_TIMERS_NOW
);
1460 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1461 doc
: /* Evaluate BODY with mouse movement events enabled.
1462 Within a `track-mouse' form, mouse motion generates input events that
1463 you can read with `read-event'.
1464 Normally, mouse motion is ignored.
1465 usage: (track-mouse BODY...) */)
1469 int count
= SPECPDL_INDEX ();
1472 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1474 do_mouse_tracking
= Qt
;
1476 val
= Fprogn (args
);
1477 return unbind_to (count
, val
);
1480 /* If mouse has moved on some frame, return one of those frames.
1484 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1485 after resizing the tool-bar window. */
1487 int ignore_mouse_drag_p
;
1492 Lisp_Object tail
, frame
;
1494 if (ignore_mouse_drag_p
)
1496 /* ignore_mouse_drag_p = 0; */
1500 FOR_EACH_FRAME (tail
, frame
)
1502 if (XFRAME (frame
)->mouse_moved
)
1503 return XFRAME (frame
);
1509 #endif /* HAVE_MOUSE || HAVE_GPM */
1511 /* This is the actual command reading loop,
1512 sans error-handling encapsulation. */
1514 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1516 void safe_run_hooks
P_ ((Lisp_Object
));
1517 static void adjust_point_for_property
P_ ((int, int));
1519 /* Cancel hourglass from protect_unwind.
1521 #ifdef HAVE_WINDOW_SYSTEM
1523 cancel_hourglass_unwind (arg
)
1526 cancel_hourglass ();
1537 Lisp_Object keybuf
[30];
1539 int prev_modiff
= 0;
1540 struct buffer
*prev_buffer
= NULL
;
1541 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1543 int was_locked
= single_kboard
;
1546 int already_adjusted
= 0;
1548 current_kboard
->Vprefix_arg
= Qnil
;
1549 current_kboard
->Vlast_prefix_arg
= Qnil
;
1550 Vdeactivate_mark
= Qnil
;
1551 waiting_for_input
= 0;
1555 this_command_key_count
= 0;
1556 this_command_key_count_reset
= 0;
1557 this_single_command_key_start
= 0;
1559 if (NILP (Vmemory_full
))
1561 /* Make sure this hook runs after commands that get errors and
1562 throw to top level. */
1563 /* Note that the value cell will never directly contain nil
1564 if the symbol is a local variable. */
1565 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1566 safe_run_hooks (Qpost_command_hook
);
1568 /* If displaying a message, resize the echo area window to fit
1569 that message's size exactly. */
1570 if (!NILP (echo_area_buffer
[0]))
1571 resize_echo_area_exactly ();
1573 if (!NILP (Vdeferred_action_list
))
1574 safe_run_hooks (Qdeferred_action_function
);
1577 /* Do this after running Vpost_command_hook, for consistency. */
1578 current_kboard
->Vlast_command
= Vthis_command
;
1579 current_kboard
->Vreal_last_command
= real_this_command
;
1580 if (!CONSP (last_command_char
))
1581 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1585 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1588 /* Make sure the current window's buffer is selected. */
1589 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1590 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1592 /* Display any malloc warning that just came out. Use while because
1593 displaying one warning can cause another. */
1595 while (pending_malloc_warning
)
1596 display_malloc_warning ();
1598 Vdeactivate_mark
= Qnil
;
1600 /* If minibuffer on and echo area in use,
1601 wait a short time and redraw minibuffer. */
1604 && !NILP (echo_area_buffer
[0])
1605 && EQ (minibuf_window
, echo_area_window
)
1606 && NUMBERP (Vminibuffer_message_timeout
))
1608 /* Bind inhibit-quit to t so that C-g gets read in
1609 rather than quitting back to the minibuffer. */
1610 int count
= SPECPDL_INDEX ();
1611 specbind (Qinhibit_quit
, Qt
);
1613 sit_for (Vminibuffer_message_timeout
, 0, 2);
1615 /* Clear the echo area. */
1617 safe_run_hooks (Qecho_area_clear_hook
);
1619 unbind_to (count
, Qnil
);
1621 /* If a C-g came in before, treat it as input now. */
1622 if (!NILP (Vquit_flag
))
1625 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1630 /* Select the frame that the last event came from. Usually,
1631 switch-frame events will take care of this, but if some lisp
1632 code swallows a switch-frame event, we'll fix things up here.
1633 Is this a good idea? */
1634 if (FRAMEP (internal_last_event_frame
)
1635 && !EQ (internal_last_event_frame
, selected_frame
))
1636 Fselect_frame (internal_last_event_frame
);
1638 /* If it has changed current-menubar from previous value,
1639 really recompute the menubar from the value. */
1640 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1641 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1642 call0 (Qrecompute_lucid_menubar
);
1644 before_command_key_count
= this_command_key_count
;
1645 before_command_echo_length
= echo_length ();
1647 Vthis_command
= Qnil
;
1648 real_this_command
= Qnil
;
1649 Vthis_original_command
= Qnil
;
1650 Vthis_command_keys_shift_translated
= Qnil
;
1652 /* Read next key sequence; i gets its length. */
1653 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1656 /* A filter may have run while we were reading the input. */
1657 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1659 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1660 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1664 /* Now we have read a key sequence of length I,
1665 or else I is 0 and we found end of file. */
1667 if (i
== 0) /* End of file -- happens only in */
1668 return Qnil
; /* a kbd macro, at the end. */
1669 /* -1 means read_key_sequence got a menu that was rejected.
1670 Just loop around and read another command. */
1674 this_command_key_count
= 0;
1675 this_command_key_count_reset
= 0;
1676 this_single_command_key_start
= 0;
1680 last_command_char
= keybuf
[i
- 1];
1682 /* If the previous command tried to force a specific window-start,
1683 forget about that, in case this command moves point far away
1684 from that position. But also throw away beg_unchanged and
1685 end_unchanged information in that case, so that redisplay will
1686 update the whole window properly. */
1687 if (!NILP (XWINDOW (selected_window
)->force_start
))
1690 XWINDOW (selected_window
)->force_start
= Qnil
;
1691 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1692 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1695 cmd
= read_key_sequence_cmd
;
1696 if (!NILP (Vexecuting_kbd_macro
))
1698 if (!NILP (Vquit_flag
))
1700 Vexecuting_kbd_macro
= Qt
;
1701 QUIT
; /* Make some noise. */
1702 /* Will return since macro now empty. */
1706 /* Do redisplay processing after this command except in special
1707 cases identified below. */
1708 prev_buffer
= current_buffer
;
1709 prev_modiff
= MODIFF
;
1710 last_point_position
= PT
;
1711 last_point_position_window
= selected_window
;
1712 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1714 /* By default, we adjust point to a boundary of a region that
1715 has such a property that should be treated intangible
1716 (e.g. composition, display). But, some commands will set
1717 this variable differently. */
1718 Vdisable_point_adjustment
= Qnil
;
1720 /* Process filters and timers may have messed with deactivate-mark.
1721 reset it before we execute the command. */
1722 Vdeactivate_mark
= Qnil
;
1724 /* Remap command through active keymaps */
1725 Vthis_original_command
= cmd
;
1729 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1733 /* Execute the command. */
1735 Vthis_command
= cmd
;
1736 real_this_command
= cmd
;
1737 /* Note that the value cell will never directly contain nil
1738 if the symbol is a local variable. */
1739 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1740 safe_run_hooks (Qpre_command_hook
);
1742 already_adjusted
= 0;
1744 if (NILP (Vthis_command
))
1746 /* nil means key is undefined. */
1747 Lisp_Object keys
= Fvector (i
, keybuf
);
1748 keys
= Fkey_description (keys
, Qnil
);
1750 message_with_string ("%s is undefined", keys
, 0);
1751 current_kboard
->defining_kbd_macro
= Qnil
;
1752 update_mode_lines
= 1;
1753 current_kboard
->Vprefix_arg
= Qnil
;
1757 if (NILP (current_kboard
->Vprefix_arg
))
1759 /* In case we jump to directly_done. */
1760 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1762 /* Recognize some common commands in common situations and
1763 do them directly. */
1764 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
1765 && NILP (Vthis_command_keys_shift_translated
)
1766 && !CONSP (Vtransient_mark_mode
))
1768 struct Lisp_Char_Table
*dp
1769 = window_display_table (XWINDOW (selected_window
));
1770 lose
= FETCH_CHAR (PT_BYTE
);
1772 if (! NILP (Vpost_command_hook
))
1773 /* Put this before calling adjust_point_for_property
1774 so it will only get called once in any case. */
1776 if (current_buffer
== prev_buffer
1777 && last_point_position
!= PT
1778 && NILP (Vdisable_point_adjustment
)
1779 && NILP (Vglobal_disable_point_adjustment
))
1780 adjust_point_for_property (last_point_position
, 0);
1781 already_adjusted
= 1;
1782 if (PT
== last_point_position
+ 1
1784 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1785 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1786 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1787 && (lose
>= 0x20 && lose
< 0x7f)))
1788 : (lose
>= 0x20 && lose
< 0x7f))
1789 /* To extract the case of continuation on
1790 wide-column characters. */
1791 && ASCII_BYTE_P (lose
)
1792 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1794 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1796 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1798 && !windows_or_buffers_changed
1799 && EQ (current_buffer
->selective_display
, Qnil
)
1800 && !detect_input_pending ()
1801 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1802 && NILP (Vexecuting_kbd_macro
))
1803 direct_output_forward_char (1);
1806 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
1807 && NILP (Vthis_command_keys_shift_translated
)
1808 && !CONSP (Vtransient_mark_mode
))
1810 struct Lisp_Char_Table
*dp
1811 = window_display_table (XWINDOW (selected_window
));
1813 lose
= FETCH_CHAR (PT_BYTE
);
1814 if (! NILP (Vpost_command_hook
))
1816 if (current_buffer
== prev_buffer
1817 && last_point_position
!= PT
1818 && NILP (Vdisable_point_adjustment
)
1819 && NILP (Vglobal_disable_point_adjustment
))
1820 adjust_point_for_property (last_point_position
, 0);
1821 already_adjusted
= 1;
1822 if (PT
== last_point_position
- 1
1824 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1825 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1826 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1827 && (lose
>= 0x20 && lose
< 0x7f)))
1828 : (lose
>= 0x20 && lose
< 0x7f))
1829 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1831 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1833 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1835 && !windows_or_buffers_changed
1836 && EQ (current_buffer
->selective_display
, Qnil
)
1837 && !detect_input_pending ()
1838 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1839 && NILP (Vexecuting_kbd_macro
))
1840 direct_output_forward_char (-1);
1843 else if (EQ (Vthis_command
, Qself_insert_command
)
1844 /* Try this optimization only on char keystrokes. */
1845 && NATNUMP (last_command_char
)
1846 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1849 = translate_char (Vtranslation_table_for_input
,
1850 XFASTINT (last_command_char
));
1852 if (NILP (Vexecuting_kbd_macro
)
1853 && !EQ (minibuf_window
, selected_window
))
1855 if (!nonundocount
|| nonundocount
>= 20)
1863 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1865 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1867 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1869 || MODIFF
<= SAVE_MODIFF
1870 || windows_or_buffers_changed
1871 || !EQ (current_buffer
->selective_display
, Qnil
)
1872 || detect_input_pending ()
1873 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1874 || !NILP (Vexecuting_kbd_macro
));
1876 value
= internal_self_insert (c
, 0);
1881 if (! NILP (Vpost_command_hook
))
1882 /* Put this before calling adjust_point_for_property
1883 so it will only get called once in any case. */
1886 /* VALUE == 1 when AFTER-CHANGE functions are
1887 installed which is the case most of the time
1888 because FONT-LOCK installs one. */
1889 if (!lose
&& !value
)
1890 direct_output_for_insert (c
);
1895 /* Here for a command that isn't executed directly */
1898 #ifdef HAVE_WINDOW_SYSTEM
1899 int scount
= SPECPDL_INDEX ();
1901 if (display_hourglass_p
1902 && NILP (Vexecuting_kbd_macro
))
1904 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1910 if (NILP (current_kboard
->Vprefix_arg
))
1912 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1914 #ifdef HAVE_WINDOW_SYSTEM
1915 /* Do not check display_hourglass_p here, because
1916 Fcommand_execute could change it, but we should cancel
1917 hourglass cursor anyway.
1918 But don't cancel the hourglass within a macro
1919 just because a command in the macro finishes. */
1920 if (NILP (Vexecuting_kbd_macro
))
1921 unbind_to (scount
, Qnil
);
1926 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1928 /* Note that the value cell will never directly contain nil
1929 if the symbol is a local variable. */
1930 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1931 safe_run_hooks (Qpost_command_hook
);
1933 /* If displaying a message, resize the echo area window to fit
1934 that message's size exactly. */
1935 if (!NILP (echo_area_buffer
[0]))
1936 resize_echo_area_exactly ();
1938 if (!NILP (Vdeferred_action_list
))
1939 safe_run_hooks (Qdeferred_action_function
);
1941 /* If there is a prefix argument,
1942 1) We don't want Vlast_command to be ``universal-argument''
1943 (that would be dumb), so don't set Vlast_command,
1944 2) we want to leave echoing on so that the prefix will be
1945 echoed as part of this key sequence, so don't call
1947 3) we want to leave this_command_key_count non-zero, so that
1948 read_char will realize that it is re-reading a character, and
1949 not echo it a second time.
1951 If the command didn't actually create a prefix arg,
1952 but is merely a frame event that is transparent to prefix args,
1953 then the above doesn't apply. */
1954 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1956 current_kboard
->Vlast_command
= Vthis_command
;
1957 current_kboard
->Vreal_last_command
= real_this_command
;
1958 if (!CONSP (last_command_char
))
1959 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1961 this_command_key_count
= 0;
1962 this_command_key_count_reset
= 0;
1963 this_single_command_key_start
= 0;
1966 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1968 /* In Emacs 22, setting transient-mark-mode to `only' was a
1969 way of turning it on for just one command. This usage is
1970 obsolete, but support it anyway. */
1971 if (EQ (Vtransient_mark_mode
, Qidentity
))
1972 Vtransient_mark_mode
= Qnil
;
1973 else if (EQ (Vtransient_mark_mode
, Qonly
))
1974 Vtransient_mark_mode
= Qidentity
;
1976 if (!NILP (Vdeactivate_mark
))
1977 call0 (Qdeactivate_mark
);
1978 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1979 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1984 if (current_buffer
== prev_buffer
1985 && last_point_position
!= PT
1986 && NILP (Vdisable_point_adjustment
)
1987 && NILP (Vglobal_disable_point_adjustment
)
1988 && !already_adjusted
)
1989 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1991 /* Install chars successfully executed in kbd macro. */
1993 if (!NILP (current_kboard
->defining_kbd_macro
)
1994 && NILP (current_kboard
->Vprefix_arg
))
1995 finalize_kbd_macro_chars ();
1996 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1999 any_kboard_state ();
2005 extern Lisp_Object Qcomposition
, Qdisplay
;
2007 /* Adjust point to a boundary of a region that has such a property
2008 that should be treated intangible. For the moment, we check
2009 `composition', `display' and `invisible' properties.
2010 LAST_PT is the last position of point. */
2012 extern Lisp_Object Qafter_string
, Qbefore_string
;
2013 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2016 adjust_point_for_property (last_pt
, modified
)
2021 Lisp_Object val
, overlay
, tmp
;
2022 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
2025 /* FIXME: cycling is probably not necessary because these properties
2026 can't be usefully combined anyway. */
2027 while (check_composition
|| check_display
|| check_invisible
)
2029 /* FIXME: check `intangible'. */
2030 if (check_composition
2031 && PT
> BEGV
&& PT
< ZV
2032 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
2033 && COMPOSITION_VALID_P (beg
, end
, val
)
2034 && beg
< PT
/* && end > PT <- It's always the case. */
2035 && (last_pt
<= beg
|| last_pt
>= end
))
2038 SET_PT (PT
< last_pt
? beg
: end
);
2039 check_display
= check_invisible
= 1;
2041 check_composition
= 0;
2043 && PT
> BEGV
&& PT
< ZV
2044 && !NILP (val
= get_char_property_and_overlay
2045 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
2046 && display_prop_intangible_p (val
)
2047 && (!OVERLAYP (overlay
)
2048 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
2049 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
2050 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
2051 && (beg
< PT
/* && end > PT <- It's always the case. */
2052 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
2055 SET_PT (PT
< last_pt
2056 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
2058 check_composition
= check_invisible
= 1;
2061 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
2063 int inv
, ellipsis
= 0;
2066 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2068 && !NILP (val
= get_char_property_and_overlay
2069 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
2070 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2072 ellipsis
= ellipsis
|| inv
> 1
2073 || (OVERLAYP (overlay
)
2074 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2075 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2076 tmp
= Fnext_single_char_property_change
2077 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
2078 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
2081 && !NILP (val
= get_char_property_and_overlay
2082 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
2083 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2085 ellipsis
= ellipsis
|| inv
> 1
2086 || (OVERLAYP (overlay
)
2087 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2088 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2089 tmp
= Fprevious_single_char_property_change
2090 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2091 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2094 /* Move away from the inside area. */
2095 if (beg
< PT
&& end
> PT
)
2097 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2098 /* We haven't moved yet (so we don't need to fear
2099 infinite-looping) and we were outside the range
2100 before (so either end of the range still corresponds
2101 to a move in the right direction): pretend we moved
2102 less than we actually did, so that we still have
2103 more freedom below in choosing which end of the range
2105 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2106 /* We either have moved already or the last point
2107 was already in the range: we don't get to choose
2108 which end of the range we have to go to. */
2109 : (PT
< last_pt
? beg
: end
));
2110 check_composition
= check_display
= 1;
2112 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2113 the point to something other than its argument, due to
2114 point-motion hooks, intangibility, etc. */
2115 xassert (PT
== beg
|| PT
== end
);
2118 /* Pretend the area doesn't exist if the buffer is not
2120 if (!modified
&& !ellipsis
&& beg
< end
)
2122 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2123 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2124 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2125 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2126 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2127 /* We've already moved as far as we can. Trying to go
2128 to the other end would mean moving backwards and thus
2129 could lead to an infinite loop. */
2131 else if (val
= get_pos_property (make_number (PT
),
2133 TEXT_PROP_MEANS_INVISIBLE (val
)
2134 && (val
= get_pos_property
2135 (make_number (PT
== beg
? end
: beg
),
2137 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2138 (check_composition
= check_display
= 1,
2139 SET_PT (PT
== beg
? end
: beg
));
2142 check_invisible
= 0;
2146 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2149 safe_run_hooks_1 (hook
)
2152 if (NILP (Vrun_hooks
))
2154 return call1 (Vrun_hooks
, Vinhibit_quit
);
2157 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2160 safe_run_hooks_error (data
)
2163 Lisp_Object args
[3];
2164 args
[0] = build_string ("Error in %s: %s");
2165 args
[1] = Vinhibit_quit
;
2168 return Fset (Vinhibit_quit
, Qnil
);
2171 /* If we get an error while running the hook, cause the hook variable
2172 to be nil. Also inhibit quits, so that C-g won't cause the hook
2173 to mysteriously evaporate. */
2176 safe_run_hooks (hook
)
2179 int count
= SPECPDL_INDEX ();
2180 specbind (Qinhibit_quit
, hook
);
2182 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2184 unbind_to (count
, Qnil
);
2188 /* Number of seconds between polling for input. This is a Lisp
2189 variable that can be bound. */
2191 EMACS_INT polling_period
;
2193 /* Nonzero means polling for input is temporarily suppressed. */
2195 int poll_suppress_count
;
2197 /* Asynchronous timer for polling. */
2199 struct atimer
*poll_timer
;
2202 #ifdef POLL_FOR_INPUT
2204 /* Poll for input, so what we catch a C-g if it comes in. This
2205 function is called from x_make_frame_visible, see comment
2211 if (interrupt_input_blocked
== 0
2212 && !waiting_for_input
)
2213 read_avail_input (0);
2216 /* Timer callback function for poll_timer. TIMER is equal to
2220 poll_for_input (timer
)
2221 struct atimer
*timer
;
2223 if (poll_suppress_count
== 0)
2225 interrupt_input_pending
= 1;
2227 poll_for_input_1 ();
2231 #endif /* POLL_FOR_INPUT */
2233 /* Begin signals to poll for input, if they are appropriate.
2234 This function is called unconditionally from various places. */
2239 #ifdef POLL_FOR_INPUT
2240 /* XXX This condition was (read_socket_hook && !interrupt_input),
2241 but read_socket_hook is not global anymore. Let's pretend that
2243 if (!interrupt_input
)
2245 /* Turn alarm handling on unconditionally. It might have
2246 been turned off in process.c. */
2247 turn_on_atimers (1);
2249 /* If poll timer doesn't exist, are we need one with
2250 a different interval, start a new one. */
2251 if (poll_timer
== NULL
2252 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2254 EMACS_TIME interval
;
2257 cancel_atimer (poll_timer
);
2259 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2260 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2261 poll_for_input
, NULL
);
2264 /* Let the timer's callback function poll for input
2265 if this becomes zero. */
2266 --poll_suppress_count
;
2271 /* Nonzero if we are using polling to handle input asynchronously. */
2274 input_polling_used ()
2276 #ifdef POLL_FOR_INPUT
2277 /* XXX This condition was (read_socket_hook && !interrupt_input),
2278 but read_socket_hook is not global anymore. Let's pretend that
2280 return !interrupt_input
;
2286 /* Turn off polling. */
2291 #ifdef POLL_FOR_INPUT
2292 /* XXX This condition was (read_socket_hook && !interrupt_input),
2293 but read_socket_hook is not global anymore. Let's pretend that
2295 if (!interrupt_input
)
2296 ++poll_suppress_count
;
2300 /* Set the value of poll_suppress_count to COUNT
2301 and start or stop polling accordingly. */
2304 set_poll_suppress_count (count
)
2307 #ifdef POLL_FOR_INPUT
2308 if (count
== 0 && poll_suppress_count
!= 0)
2310 poll_suppress_count
= 1;
2313 else if (count
!= 0 && poll_suppress_count
== 0)
2317 poll_suppress_count
= count
;
2321 /* Bind polling_period to a value at least N.
2322 But don't decrease it. */
2325 bind_polling_period (n
)
2328 #ifdef POLL_FOR_INPUT
2329 int new = polling_period
;
2334 stop_other_atimers (poll_timer
);
2336 specbind (Qpolling_period
, make_number (new));
2337 /* Start a new alarm with the new period. */
2342 /* Apply the control modifier to CHARACTER. */
2348 /* Save the upper bits here. */
2349 int upper
= c
& ~0177;
2351 if (! ASCII_BYTE_P (c
))
2352 return c
|= ctrl_modifier
;
2356 /* Everything in the columns containing the upper-case letters
2357 denotes a control character. */
2358 if (c
>= 0100 && c
< 0140)
2362 /* Set the shift modifier for a control char
2363 made from a shifted letter. But only for letters! */
2364 if (oc
>= 'A' && oc
<= 'Z')
2365 c
|= shift_modifier
;
2368 /* The lower-case letters denote control characters too. */
2369 else if (c
>= 'a' && c
<= 'z')
2372 /* Include the bits for control and shift
2373 only if the basic ASCII code can't indicate them. */
2377 /* Replace the high bits. */
2378 c
|= (upper
& ~ctrl_modifier
);
2383 /* Display the help-echo property of the character after the mouse pointer.
2384 Either show it in the echo area, or call show-help-function to display
2385 it by other means (maybe in a tooltip).
2387 If HELP is nil, that means clear the previous help echo.
2389 If HELP is a string, display that string. If HELP is a function,
2390 call it with OBJECT and POS as arguments; the function should
2391 return a help string or nil for none. For all other types of HELP,
2392 evaluate it to obtain a string.
2394 WINDOW is the window in which the help was generated, if any.
2395 It is nil if not in a window.
2397 If OBJECT is a buffer, POS is the position in the buffer where the
2398 `help-echo' text property was found.
2400 If OBJECT is an overlay, that overlay has a `help-echo' property,
2401 and POS is the position in the overlay's buffer under the mouse.
2403 If OBJECT is a string (an overlay string or a string displayed with
2404 the `display' property). POS is the position in that string under
2407 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2408 echo overwrites a keystroke echo currently displayed in the echo
2411 Note: this function may only be called with HELP nil or a string
2412 from X code running asynchronously. */
2415 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2416 Lisp_Object help
, window
, object
, pos
;
2417 int ok_to_overwrite_keystroke_echo
;
2419 if (!NILP (help
) && !STRINGP (help
))
2421 if (FUNCTIONP (help
))
2423 Lisp_Object args
[4];
2428 help
= safe_call (4, args
);
2431 help
= safe_eval (help
);
2433 if (!STRINGP (help
))
2437 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2438 if (!noninteractive
&& STRINGP (help
))
2440 /* The mouse-fixup-help-message Lisp function can call
2441 mouse_position_hook, which resets the mouse_moved flags.
2442 This causes trouble if we are trying to read a mouse motion
2443 event (i.e., if we are inside a `track-mouse' form), so we
2444 restore the mouse_moved flag. */
2445 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2446 help
= call1 (Qmouse_fixup_help_message
, help
);
2452 if (STRINGP (help
) || NILP (help
))
2454 if (!NILP (Vshow_help_function
))
2455 call1 (Vshow_help_function
, help
);
2456 help_echo_showing_p
= STRINGP (help
);
2462 /* Input of single characters from keyboard */
2464 Lisp_Object
print_help ();
2465 static Lisp_Object
kbd_buffer_get_event ();
2466 static void record_char ();
2468 static Lisp_Object help_form_saved_window_configs
;
2470 read_char_help_form_unwind (arg
)
2472 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2473 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2474 if (!NILP (window_config
))
2475 Fset_window_configuration (window_config
);
2479 #define STOP_POLLING \
2480 do { if (! polling_stopped_here) stop_polling (); \
2481 polling_stopped_here = 1; } while (0)
2483 #define RESUME_POLLING \
2484 do { if (polling_stopped_here) start_polling (); \
2485 polling_stopped_here = 0; } while (0)
2487 /* read a character from the keyboard; call the redisplay if needed */
2488 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2489 -1 means do not do redisplay, but do do autosaving.
2492 /* The arguments MAPS and NMAPS are for menu prompting.
2493 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2495 PREV_EVENT is the previous input event, or nil if we are reading
2496 the first event of a key sequence (or not reading a key sequence).
2497 If PREV_EVENT is t, that is a "magic" value that says
2498 not to run input methods, but in other respects to act as if
2499 not reading a key sequence.
2501 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2502 if we used a mouse menu to read the input, or zero otherwise. If
2503 USED_MOUSE_MENU is null, we don't dereference it.
2505 Value is -2 when we find input on another keyboard. A second call
2506 to read_char will read it.
2508 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2509 specifying the maximum time to wait until. If no input arrives by
2510 that time, stop waiting and return nil.
2512 Value is t if we showed a menu and the user rejected it. */
2515 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2519 Lisp_Object prev_event
;
2520 int *used_mouse_menu
;
2521 EMACS_TIME
*end_time
;
2523 volatile Lisp_Object c
;
2524 int count
, jmpcount
;
2525 jmp_buf local_getcjmp
;
2527 volatile int key_already_recorded
= 0;
2528 Lisp_Object tem
, save
;
2529 volatile Lisp_Object previous_echo_area_message
;
2530 volatile Lisp_Object also_record
;
2531 volatile int reread
;
2532 struct gcpro gcpro1
, gcpro2
;
2533 int polling_stopped_here
= 0;
2534 struct kboard
*orig_kboard
= current_kboard
;
2538 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2539 before_command_key_count
= this_command_key_count
;
2540 before_command_echo_length
= echo_length ();
2543 previous_echo_area_message
= Qnil
;
2545 GCPRO2 (c
, previous_echo_area_message
);
2550 if (CONSP (Vunread_post_input_method_events
))
2552 c
= XCAR (Vunread_post_input_method_events
);
2553 Vunread_post_input_method_events
2554 = XCDR (Vunread_post_input_method_events
);
2556 /* Undo what read_char_x_menu_prompt did when it unread
2557 additional keys returned by Fx_popup_menu. */
2559 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2567 if (unread_command_char
!= -1)
2569 XSETINT (c
, unread_command_char
);
2570 unread_command_char
= -1;
2576 if (CONSP (Vunread_command_events
))
2578 c
= XCAR (Vunread_command_events
);
2579 Vunread_command_events
= XCDR (Vunread_command_events
);
2583 /* Undo what sit-for did when it unread additional keys
2584 inside universal-argument. */
2587 && EQ (XCAR (c
), Qt
))
2593 /* Undo what read_char_x_menu_prompt did when it unread
2594 additional keys returned by Fx_popup_menu. */
2596 && EQ (XCDR (c
), Qdisabled
)
2597 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2600 /* If the queued event is something that used the mouse,
2601 set used_mouse_menu accordingly. */
2603 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2604 *used_mouse_menu
= 1;
2606 goto reread_for_input_method
;
2609 if (CONSP (Vunread_input_method_events
))
2611 c
= XCAR (Vunread_input_method_events
);
2612 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2614 /* Undo what read_char_x_menu_prompt did when it unread
2615 additional keys returned by Fx_popup_menu. */
2617 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2621 goto reread_for_input_method
;
2624 this_command_key_count_reset
= 0;
2626 if (!NILP (Vexecuting_kbd_macro
))
2628 /* We set this to Qmacro; since that's not a frame, nobody will
2629 try to switch frames on us, and the selected window will
2632 Since this event came from a macro, it would be misleading to
2633 leave internal_last_event_frame set to wherever the last
2634 real event came from. Normally, a switch-frame event selects
2635 internal_last_event_frame after each command is read, but
2636 events read from a macro should never cause a new frame to be
2638 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2640 /* Exit the macro if we are at the end.
2641 Also, some things replace the macro with t
2642 to force an early exit. */
2643 if (EQ (Vexecuting_kbd_macro
, Qt
)
2644 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2650 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2651 if (STRINGP (Vexecuting_kbd_macro
)
2652 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2653 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2655 executing_kbd_macro_index
++;
2660 if (!NILP (unread_switch_frame
))
2662 c
= unread_switch_frame
;
2663 unread_switch_frame
= Qnil
;
2665 /* This event should make it into this_command_keys, and get echoed
2666 again, so we do not set `reread'. */
2670 /* if redisplay was requested */
2671 if (commandflag
>= 0)
2673 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2675 /* If there is pending input, process any events which are not
2676 user-visible, such as X selection_request events. */
2678 || detect_input_pending_run_timers (0))
2679 swallow_events (0); /* may clear input_pending */
2681 /* Redisplay if no pending input. */
2682 while (!input_pending
)
2684 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2685 redisplay_preserve_echo_area (5);
2690 /* Normal case: no input arrived during redisplay. */
2693 /* Input arrived and pre-empted redisplay.
2694 Process any events which are not user-visible. */
2696 /* If that cleared input_pending, try again to redisplay. */
2699 /* Prevent the redisplay we just did
2700 from messing up echoing of the input after the prompt. */
2701 if (commandflag
== 0 && echo_current
)
2702 echo_message_buffer
= echo_area_buffer
[0];
2706 /* Message turns off echoing unless more keystrokes turn it on again.
2708 The code in 20.x for the condition was
2710 1. echo_area_glyphs && *echo_area_glyphs
2711 2. && echo_area_glyphs != current_kboard->echobuf
2712 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2714 (1) means there's a current message displayed
2716 (2) means it's not the message from echoing from the current
2719 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2720 is set to a non-null value. This is done in read_char and it is
2721 set to echo_area_glyphs after a call to echo_char. That means
2722 ok_to_echo_at_next_pause is either null or
2723 current_kboard->echobuf with the appropriate current_kboard at
2726 So, condition (3) means in clear text ok_to_echo_at_next_pause
2727 must be either null, or the current message isn't from echoing at
2728 all, or it's from echoing from a different kboard than the
2731 if (/* There currently is something in the echo area. */
2732 !NILP (echo_area_buffer
[0])
2733 && (/* And it's either not from echoing. */
2734 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2735 /* Or it's an echo from a different kboard. */
2736 || echo_kboard
!= current_kboard
2737 /* Or we explicitly allow overwriting whatever there is. */
2738 || ok_to_echo_at_next_pause
== NULL
))
2743 /* Try reading a character via menu prompting in the minibuf.
2744 Try this before the sit-for, because the sit-for
2745 would do the wrong thing if we are supposed to do
2746 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2747 after a mouse event so don't try a minibuf menu. */
2749 if (nmaps
> 0 && INTERACTIVE
2750 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2751 /* Don't bring up a menu if we already have another event. */
2752 && NILP (Vunread_command_events
)
2753 && unread_command_char
< 0
2754 && !detect_input_pending_run_timers (0))
2756 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2758 if (INTEGERP (c
) && XINT (c
) == -2)
2759 return c
; /* wrong_kboard_jmpbuf */
2763 key_already_recorded
= 1;
2768 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2769 We will do that below, temporarily for short sections of code,
2770 when appropriate. local_getcjmp must be in effect
2771 around any call to sit_for or kbd_buffer_get_event;
2772 it *must not* be in effect when we call redisplay. */
2774 jmpcount
= SPECPDL_INDEX ();
2775 if (_setjmp (local_getcjmp
))
2777 /* Handle quits while reading the keyboard. */
2778 /* We must have saved the outer value of getcjmp here,
2779 so restore it now. */
2780 restore_getcjmp (save_jump
);
2781 unbind_to (jmpcount
, Qnil
);
2782 XSETINT (c
, quit_char
);
2783 internal_last_event_frame
= selected_frame
;
2784 Vlast_event_frame
= internal_last_event_frame
;
2785 /* If we report the quit char as an event,
2786 don't do so more than once. */
2787 if (!NILP (Vinhibit_quit
))
2792 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2793 if (kb
!= current_kboard
)
2795 Lisp_Object link
= kb
->kbd_queue
;
2796 /* We shouldn't get here if we were in single-kboard mode! */
2801 while (CONSP (XCDR (link
)))
2803 if (!NILP (XCDR (link
)))
2807 kb
->kbd_queue
= Fcons (c
, Qnil
);
2809 XSETCDR (link
, Fcons (c
, Qnil
));
2810 kb
->kbd_queue_has_data
= 1;
2811 current_kboard
= kb
;
2812 /* This is going to exit from read_char
2813 so we had better get rid of this frame's stuff. */
2815 return make_number (-2); /* wrong_kboard_jmpbuf */
2822 /* Start idle timers if no time limit is supplied. We don't do it
2823 if a time limit is supplied to avoid an infinite recursion in the
2824 situation where an idle timer calls `sit-for'. */
2827 timer_start_idle ();
2829 /* If in middle of key sequence and minibuffer not active,
2830 start echoing if enough time elapses. */
2832 if (minibuf_level
== 0
2834 && !current_kboard
->immediate_echo
2835 && this_command_key_count
> 0
2837 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2838 && NILP (Fzerop (Vecho_keystrokes
))
2839 && (/* No message. */
2840 NILP (echo_area_buffer
[0])
2841 /* Or empty message. */
2842 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2843 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2844 /* Or already echoing from same kboard. */
2845 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2846 /* Or not echoing before and echoing allowed. */
2847 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2849 /* After a mouse event, start echoing right away.
2850 This is because we are probably about to display a menu,
2851 and we don't want to delay before doing so. */
2852 if (EVENT_HAS_PARAMETERS (prev_event
))
2858 save_getcjmp (save_jump
);
2859 restore_getcjmp (local_getcjmp
);
2860 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2861 restore_getcjmp (save_jump
);
2863 && ! CONSP (Vunread_command_events
))
2868 /* Maybe auto save due to number of keystrokes. */
2870 if (commandflag
!= 0
2871 && auto_save_interval
> 0
2872 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2873 && !detect_input_pending_run_timers (0))
2875 Fdo_auto_save (Qnil
, Qnil
);
2876 /* Hooks can actually change some buffers in auto save. */
2880 /* Try reading using an X menu.
2881 This is never confused with reading using the minibuf
2882 because the recursive call of read_char in read_char_minibuf_menu_prompt
2883 does not pass on any keymaps. */
2885 if (nmaps
> 0 && INTERACTIVE
2886 && !NILP (prev_event
)
2887 && EVENT_HAS_PARAMETERS (prev_event
)
2888 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2889 && !EQ (XCAR (prev_event
), Qtool_bar
)
2890 /* Don't bring up a menu if we already have another event. */
2891 && NILP (Vunread_command_events
)
2892 && unread_command_char
< 0)
2894 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2896 /* Now that we have read an event, Emacs is not idle. */
2903 /* Maybe autosave and/or garbage collect due to idleness. */
2905 if (INTERACTIVE
&& NILP (c
))
2907 int delay_level
, buffer_size
;
2909 /* Slow down auto saves logarithmically in size of current buffer,
2910 and garbage collect while we're at it. */
2911 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2912 last_non_minibuf_size
= Z
- BEG
;
2913 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2915 while (buffer_size
> 64)
2916 delay_level
++, buffer_size
-= buffer_size
>> 2;
2917 if (delay_level
< 4) delay_level
= 4;
2918 /* delay_level is 4 for files under around 50k, 7 at 100k,
2919 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2921 /* Auto save if enough time goes by without input. */
2922 if (commandflag
!= 0
2923 && num_nonmacro_input_events
> last_auto_save
2924 && INTEGERP (Vauto_save_timeout
)
2925 && XINT (Vauto_save_timeout
) > 0)
2928 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2930 save_getcjmp (save_jump
);
2931 restore_getcjmp (local_getcjmp
);
2932 tem0
= sit_for (make_number (timeout
), 1, 1);
2933 restore_getcjmp (save_jump
);
2936 && ! CONSP (Vunread_command_events
))
2938 Fdo_auto_save (Qnil
, Qnil
);
2940 /* If we have auto-saved and there is still no input
2941 available, garbage collect if there has been enough
2942 consing going on to make it worthwhile. */
2943 if (!detect_input_pending_run_timers (0)
2944 && consing_since_gc
> gc_cons_threshold
/ 2)
2945 Fgarbage_collect ();
2952 /* Notify the caller if an autosave hook, or a timer, sentinel or
2953 filter in the sit_for calls above have changed the current
2954 kboard. This could happen if they use the minibuffer or start a
2955 recursive edit, like the fancy splash screen in server.el's
2956 filter. If this longjmp wasn't here, read_key_sequence would
2957 interpret the next key sequence using the wrong translation
2958 tables and function keymaps. */
2959 if (NILP (c
) && current_kboard
!= orig_kboard
)
2962 return make_number (-2); /* wrong_kboard_jmpbuf */
2965 /* If this has become non-nil here, it has been set by a timer
2966 or sentinel or filter. */
2967 if (CONSP (Vunread_command_events
))
2969 c
= XCAR (Vunread_command_events
);
2970 Vunread_command_events
= XCDR (Vunread_command_events
);
2973 /* Read something from current KBOARD's side queue, if possible. */
2977 if (current_kboard
->kbd_queue_has_data
)
2979 if (!CONSP (current_kboard
->kbd_queue
))
2981 c
= XCAR (current_kboard
->kbd_queue
);
2982 current_kboard
->kbd_queue
2983 = XCDR (current_kboard
->kbd_queue
);
2984 if (NILP (current_kboard
->kbd_queue
))
2985 current_kboard
->kbd_queue_has_data
= 0;
2986 input_pending
= readable_events (0);
2987 if (EVENT_HAS_PARAMETERS (c
)
2988 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2989 internal_last_event_frame
= XCAR (XCDR (c
));
2990 Vlast_event_frame
= internal_last_event_frame
;
2995 /* If current_kboard's side queue is empty check the other kboards.
2996 If one of them has data that we have not yet seen here,
2997 switch to it and process the data waiting for it.
2999 Note: if the events queued up for another kboard
3000 have already been seen here, and therefore are not a complete command,
3001 the kbd_queue_has_data field is 0, so we skip that kboard here.
3002 That's to avoid an infinite loop switching between kboards here. */
3003 if (NILP (c
) && !single_kboard
)
3006 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3007 if (kb
->kbd_queue_has_data
)
3009 current_kboard
= kb
;
3010 /* This is going to exit from read_char
3011 so we had better get rid of this frame's stuff. */
3013 return make_number (-2); /* wrong_kboard_jmpbuf */
3022 /* Finally, we read from the main queue,
3023 and if that gives us something we can't use yet, we put it on the
3024 appropriate side queue and try again. */
3033 EMACS_GET_TIME (now
);
3034 if (EMACS_TIME_GE (now
, *end_time
))
3038 /* Actually read a character, waiting if necessary. */
3039 save_getcjmp (save_jump
);
3040 restore_getcjmp (local_getcjmp
);
3042 timer_start_idle ();
3043 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
3044 restore_getcjmp (save_jump
);
3047 if (! NILP (c
) && (kb
!= current_kboard
))
3049 Lisp_Object link
= kb
->kbd_queue
;
3052 while (CONSP (XCDR (link
)))
3054 if (!NILP (XCDR (link
)))
3058 kb
->kbd_queue
= Fcons (c
, Qnil
);
3060 XSETCDR (link
, Fcons (c
, Qnil
));
3061 kb
->kbd_queue_has_data
= 1;
3065 current_kboard
= kb
;
3066 /* This is going to exit from read_char
3067 so we had better get rid of this frame's stuff. */
3069 return make_number (-2);
3074 /* Terminate Emacs in batch mode if at eof. */
3075 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
3076 Fkill_emacs (make_number (1));
3080 /* Add in any extra modifiers, where appropriate. */
3081 if ((extra_keyboard_modifiers
& CHAR_CTL
)
3082 || ((extra_keyboard_modifiers
& 0177) < ' '
3083 && (extra_keyboard_modifiers
& 0177) != 0))
3084 XSETINT (c
, make_ctrl_char (XINT (c
)));
3086 /* Transfer any other modifier bits directly from
3087 extra_keyboard_modifiers to c. Ignore the actual character code
3088 in the low 16 bits of extra_keyboard_modifiers. */
3089 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
3100 if (commandflag
>= 0
3101 && !input_pending
&& !detect_input_pending_run_timers (0))
3109 /* Buffer switch events are only for internal wakeups
3110 so don't show them to the user.
3111 Also, don't record a key if we already did. */
3112 if (BUFFERP (c
) || key_already_recorded
)
3115 /* Process special events within read_char
3116 and loop around to read another event. */
3119 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3124 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3125 int was_locked
= single_kboard
;
3126 int count
= SPECPDL_INDEX ();
3127 record_single_kboard_state ();
3130 last_input_char
= c
;
3131 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
3133 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3134 /* We stopped being idle for this event; undo that. This
3135 prevents automatic window selection (under
3136 mouse_autoselect_window from acting as a real input event, for
3137 example banishing the mouse under mouse-avoidance-mode. */
3138 timer_resume_idle ();
3140 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3141 /* Resume allowing input from any kboard, if that was true before. */
3143 any_kboard_state ();
3144 unbind_to (count
, Qnil
);
3150 /* Handle things that only apply to characters. */
3153 /* If kbd_buffer_get_event gave us an EOF, return that. */
3157 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3158 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3159 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3160 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3161 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3165 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3166 /* nil in keyboard-translate-table means no translation. */
3172 /* If this event is a mouse click in the menu bar,
3173 return just menu-bar for now. Modify the mouse click event
3174 so we won't do this twice, then queue it up. */
3175 if (EVENT_HAS_PARAMETERS (c
)
3177 && CONSP (EVENT_START (c
))
3178 && CONSP (XCDR (EVENT_START (c
))))
3182 posn
= POSN_POSN (EVENT_START (c
));
3183 /* Handle menu-bar events:
3184 insert the dummy prefix event `menu-bar'. */
3185 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3187 /* Change menu-bar to (menu-bar) as the event "position". */
3188 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3191 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3196 /* Store these characters into recent_keys, the dribble file if any,
3197 and the keyboard macro being defined, if any. */
3199 if (! NILP (also_record
))
3200 record_char (also_record
);
3202 /* Wipe the echo area.
3203 But first, if we are about to use an input method,
3204 save the echo area contents for it to refer to. */
3206 && ! NILP (Vinput_method_function
)
3207 && (unsigned) XINT (c
) >= ' '
3208 && (unsigned) XINT (c
) != 127
3209 && (unsigned) XINT (c
) < 256)
3211 previous_echo_area_message
= Fcurrent_message ();
3212 Vinput_method_previous_message
= previous_echo_area_message
;
3215 /* Now wipe the echo area, except for help events which do their
3216 own stuff with the echo area. */
3218 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3219 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3221 if (!NILP (echo_area_buffer
[0]))
3222 safe_run_hooks (Qecho_area_clear_hook
);
3223 clear_message (1, 0);
3226 reread_for_input_method
:
3228 /* Pass this to the input method, if appropriate. */
3230 && ! NILP (Vinput_method_function
)
3231 /* Don't run the input method within a key sequence,
3232 after the first event of the key sequence. */
3233 && NILP (prev_event
)
3234 && (unsigned) XINT (c
) >= ' '
3235 && (unsigned) XINT (c
) != 127
3236 && (unsigned) XINT (c
) < 256)
3239 int key_count
, key_count_reset
;
3240 struct gcpro gcpro1
;
3241 int count
= SPECPDL_INDEX ();
3243 /* Save the echo status. */
3244 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3245 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3246 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3247 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3250 if (before_command_restore_flag
)
3252 this_command_key_count
= before_command_key_count_1
;
3253 if (this_command_key_count
< this_single_command_key_start
)
3254 this_single_command_key_start
= this_command_key_count
;
3255 echo_truncate (before_command_echo_length_1
);
3256 before_command_restore_flag
= 0;
3260 /* Save the this_command_keys status. */
3261 key_count
= this_command_key_count
;
3262 key_count_reset
= this_command_key_count_reset
;
3265 keys
= Fcopy_sequence (this_command_keys
);
3270 /* Clear out this_command_keys. */
3271 this_command_key_count
= 0;
3272 this_command_key_count_reset
= 0;
3274 /* Now wipe the echo area. */
3275 if (!NILP (echo_area_buffer
[0]))
3276 safe_run_hooks (Qecho_area_clear_hook
);
3277 clear_message (1, 0);
3280 /* If we are not reading a key sequence,
3281 never use the echo area. */
3284 specbind (Qinput_method_use_echo_area
, Qt
);
3287 /* Call the input method. */
3288 tem
= call1 (Vinput_method_function
, c
);
3290 tem
= unbind_to (count
, tem
);
3292 /* Restore the saved echoing state
3293 and this_command_keys state. */
3294 this_command_key_count
= key_count
;
3295 this_command_key_count_reset
= key_count_reset
;
3297 this_command_keys
= keys
;
3300 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3301 current_kboard
->echo_string
= saved_echo_string
;
3302 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3303 if (saved_immediate_echo
)
3308 /* The input method can return no events. */
3311 /* Bring back the previous message, if any. */
3312 if (! NILP (previous_echo_area_message
))
3313 message_with_string ("%s", previous_echo_area_message
, 0);
3316 /* It returned one event or more. */
3318 Vunread_post_input_method_events
3319 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3324 /* Display help if not echoing. */
3325 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3327 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3328 Lisp_Object help
, object
, position
, window
, tem
;
3330 tem
= Fcdr (XCDR (c
));
3333 window
= Fcar (tem
);
3335 object
= Fcar (tem
);
3337 position
= Fcar (tem
);
3339 show_help_echo (help
, window
, object
, position
, 0);
3341 /* We stopped being idle for this event; undo that. */
3343 timer_resume_idle ();
3347 if ((! reread
|| this_command_key_count
== 0
3348 || this_command_key_count_reset
)
3352 /* Don't echo mouse motion events. */
3353 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3354 && NILP (Fzerop (Vecho_keystrokes
))
3355 && ! (EVENT_HAS_PARAMETERS (c
)
3356 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3359 if (! NILP (also_record
))
3360 echo_char (also_record
);
3361 /* Once we reread a character, echoing can happen
3362 the next time we pause to read a new one. */
3363 ok_to_echo_at_next_pause
= current_kboard
;
3366 /* Record this character as part of the current key. */
3367 add_command_key (c
);
3368 if (! NILP (also_record
))
3369 add_command_key (also_record
);
3372 last_input_char
= c
;
3375 /* Process the help character specially if enabled */
3376 if (!NILP (Vhelp_form
) && help_char_p (c
))
3379 count
= SPECPDL_INDEX ();
3381 help_form_saved_window_configs
3382 = Fcons (Fcurrent_window_configuration (Qnil
),
3383 help_form_saved_window_configs
);
3384 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3386 tem0
= Feval (Vhelp_form
);
3388 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3393 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3394 if (EVENT_HAS_PARAMETERS (c
)
3395 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3396 XSETCAR (help_form_saved_window_configs
, Qnil
);
3398 while (BUFFERP (c
));
3399 /* Remove the help from the frame */
3400 unbind_to (count
, Qnil
);
3403 if (EQ (c
, make_number (040)))
3407 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3408 while (BUFFERP (c
));
3417 /* Record a key that came from a mouse menu.
3418 Record it for echoing, for this-command-keys, and so on. */
3424 /* Wipe the echo area. */
3425 clear_message (1, 0);
3430 before_command_key_count
= this_command_key_count
;
3431 before_command_echo_length
= echo_length ();
3434 /* Don't echo mouse motion events. */
3435 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3436 && NILP (Fzerop (Vecho_keystrokes
)))
3440 /* Once we reread a character, echoing can happen
3441 the next time we pause to read a new one. */
3442 ok_to_echo_at_next_pause
= 0;
3445 /* Record this character as part of the current key. */
3446 add_command_key (c
);
3448 /* Re-reading in the middle of a command */
3449 last_input_char
= c
;
3453 /* Return 1 if should recognize C as "the help character". */
3461 if (EQ (c
, Vhelp_char
))
3463 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3464 if (EQ (c
, XCAR (tail
)))
3469 /* Record the input event C in various ways. */
3477 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3479 /* To avoid filling recent_keys with help-echo and mouse-movement
3480 events, we filter out repeated help-echo events, only store the
3481 first and last in a series of mouse-movement events, and don't
3482 store repeated help-echo events which are only separated by
3483 mouse-movement events. */
3485 Lisp_Object ev1
, ev2
, ev3
;
3488 if ((ix1
= recent_keys_index
- 1) < 0)
3489 ix1
= NUM_RECENT_KEYS
- 1;
3490 ev1
= AREF (recent_keys
, ix1
);
3492 if ((ix2
= ix1
- 1) < 0)
3493 ix2
= NUM_RECENT_KEYS
- 1;
3494 ev2
= AREF (recent_keys
, ix2
);
3496 if ((ix3
= ix2
- 1) < 0)
3497 ix3
= NUM_RECENT_KEYS
- 1;
3498 ev3
= AREF (recent_keys
, ix3
);
3500 if (EQ (XCAR (c
), Qhelp_echo
))
3502 /* Don't record `help-echo' in recent_keys unless it shows some help
3503 message, and a different help than the previously recorded
3505 Lisp_Object help
, last_help
;
3507 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3508 if (!STRINGP (help
))
3510 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3511 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3513 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3514 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3515 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3517 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3518 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3519 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3520 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3523 else if (EQ (XCAR (c
), Qmouse_movement
))
3525 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3526 So additional mouse movement events replace the last element. */
3527 Lisp_Object last_window
, window
;
3529 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3530 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3531 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3532 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3533 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3535 ASET (recent_keys
, ix1
, c
);
3541 store_kbd_macro_char (c
);
3546 ASET (recent_keys
, recent_keys_index
, c
);
3547 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3548 recent_keys_index
= 0;
3550 else if (recorded
< 0)
3552 /* We need to remove one or two events from recent_keys.
3553 To do this, we simply put nil at those events and move the
3554 recent_keys_index backwards over those events. Usually,
3555 users will never see those nil events, as they will be
3556 overwritten by the command keys entered to see recent_keys
3559 while (recorded
++ < 0 && total_keys
> 0)
3561 if (total_keys
< NUM_RECENT_KEYS
)
3563 if (--recent_keys_index
< 0)
3564 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3565 ASET (recent_keys
, recent_keys_index
, Qnil
);
3569 num_nonmacro_input_events
++;
3571 /* Write c to the dribble file. If c is a lispy event, write
3572 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3573 If you, dear reader, have a better idea, you've got the source. :-) */
3579 if (XUINT (c
) < 0x100)
3580 putc (XINT (c
), dribble
);
3582 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3586 Lisp_Object dribblee
;
3588 /* If it's a structured event, take the event header. */
3589 dribblee
= EVENT_HEAD (c
);
3591 if (SYMBOLP (dribblee
))
3593 putc ('<', dribble
);
3594 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3595 SBYTES (SYMBOL_NAME (dribblee
)),
3597 putc ('>', dribble
);
3610 struct buffer
*old
= current_buffer
;
3611 Fprinc (object
, Qnil
);
3612 set_buffer_internal (XBUFFER (Vstandard_output
));
3613 call0 (intern ("help-mode"));
3614 set_buffer_internal (old
);
3618 /* Copy out or in the info on where C-g should throw to.
3619 This is used when running Lisp code from within get_char,
3620 in case get_char is called recursively.
3621 See read_process_output. */
3627 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3631 restore_getcjmp (temp
)
3634 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3637 /* Low level keyboard/mouse input.
3638 kbd_buffer_store_event places events in kbd_buffer, and
3639 kbd_buffer_get_event retrieves them. */
3641 /* Return true if there are any events in the queue that read-char
3642 would return. If this returns false, a read-char would block. */
3644 readable_events (flags
)
3647 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3650 /* If the buffer contains only FOCUS_IN_EVENT events, and
3651 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3652 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3654 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3655 #ifdef USE_TOOLKIT_SCROLL_BARS
3656 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3660 struct input_event
*event
;
3662 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3669 #ifdef USE_TOOLKIT_SCROLL_BARS
3670 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3672 event
->kind
== FOCUS_IN_EVENT
)
3673 #ifdef USE_TOOLKIT_SCROLL_BARS
3674 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3675 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3676 && event
->part
== scroll_bar_handle
3677 && event
->modifiers
== 0)
3682 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3685 while (event
!= kbd_store_ptr
);
3691 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3692 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3693 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3698 if (current_kboard
->kbd_queue_has_data
)
3704 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3705 if (kb
->kbd_queue_has_data
)
3711 /* Set this for debugging, to have a way to get out */
3716 event_to_kboard (event
)
3717 struct input_event
*event
;
3720 frame
= event
->frame_or_window
;
3722 frame
= XCAR (frame
);
3723 else if (WINDOWP (frame
))
3724 frame
= WINDOW_FRAME (XWINDOW (frame
));
3726 /* There are still some events that don't set this field.
3727 For now, just ignore the problem.
3728 Also ignore dead frames here. */
3729 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3732 return FRAME_KBOARD (XFRAME (frame
));
3737 Lisp_Object Vthrow_on_input
;
3739 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3742 kbd_buffer_store_event (event
)
3743 register struct input_event
*event
;
3745 kbd_buffer_store_event_hold (event
, 0);
3748 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3750 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3751 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3752 Else, if EVENT is a quit event, store the quit event
3753 in HOLD_QUIT, and return (thus ignoring further events).
3755 This is used in read_avail_input to postpone the processing
3756 of the quit event until all subsequent input events have been
3757 parsed (and discarded).
3761 kbd_buffer_store_event_hold (event
, hold_quit
)
3762 register struct input_event
*event
;
3763 struct input_event
*hold_quit
;
3765 if (event
->kind
== NO_EVENT
)
3768 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3771 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3773 register int c
= event
->code
& 0377;
3775 if (event
->modifiers
& ctrl_modifier
)
3776 c
= make_ctrl_char (c
);
3778 c
|= (event
->modifiers
3779 & (meta_modifier
| alt_modifier
3780 | hyper_modifier
| super_modifier
));
3785 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3786 struct input_event
*sp
;
3788 if (single_kboard
&& kb
!= current_kboard
)
3791 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3792 Fcons (make_number (c
), Qnil
));
3793 kb
->kbd_queue_has_data
= 1;
3794 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3796 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3799 if (event_to_kboard (sp
) == kb
)
3801 sp
->kind
= NO_EVENT
;
3802 sp
->frame_or_window
= Qnil
;
3812 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3816 /* If this results in a quit_char being returned to Emacs as
3817 input, set Vlast_event_frame properly. If this doesn't
3818 get returned to Emacs as an event, the next event read
3819 will set Vlast_event_frame again, so this is safe to do. */
3823 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3825 focus
= event
->frame_or_window
;
3826 internal_last_event_frame
= focus
;
3827 Vlast_event_frame
= focus
;
3830 last_event_timestamp
= event
->timestamp
;
3831 handle_interrupt ();
3835 if (c
&& c
== stop_character
)
3841 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3842 Just ignore the second one. */
3843 else if (event
->kind
== BUFFER_SWITCH_EVENT
3844 && kbd_fetch_ptr
!= kbd_store_ptr
3845 && ((kbd_store_ptr
== kbd_buffer
3846 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3847 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3850 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3851 kbd_store_ptr
= kbd_buffer
;
3853 /* Don't let the very last slot in the buffer become full,
3854 since that would make the two pointers equal,
3855 and that is indistinguishable from an empty buffer.
3856 Discard the event if it would fill the last slot. */
3857 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3859 *kbd_store_ptr
= *event
;
3863 /* If we're inside while-no-input, and this event qualifies
3864 as input, set quit-flag to cause an interrupt. */
3865 if (!NILP (Vthrow_on_input
)
3866 && event
->kind
!= FOCUS_IN_EVENT
3867 && event
->kind
!= HELP_EVENT
3868 && event
->kind
!= DEICONIFY_EVENT
)
3870 Vquit_flag
= Vthrow_on_input
;
3871 /* If we're inside a function that wants immediate quits,
3873 if (immediate_quit
&& NILP (Vinhibit_quit
))
3883 /* Put an input event back in the head of the event queue. */
3886 kbd_buffer_unget_event (event
)
3887 register struct input_event
*event
;
3889 if (kbd_fetch_ptr
== kbd_buffer
)
3890 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3892 /* Don't let the very last slot in the buffer become full, */
3893 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3896 *kbd_fetch_ptr
= *event
;
3901 /* Generate HELP_EVENT input_events in BUFP which has room for
3902 SIZE events. If there's not enough room in BUFP, ignore this
3905 HELP is the help form.
3907 FRAME is the frame on which the help is generated. OBJECT is the
3908 Lisp object where the help was found (a buffer, a string, an
3909 overlay, or nil if neither from a string nor from a buffer. POS is
3910 the position within OBJECT where the help was found.
3912 Value is the number of input_events generated. */
3915 gen_help_event (help
, frame
, window
, object
, pos
)
3916 Lisp_Object help
, frame
, object
, window
;
3919 struct input_event event
;
3923 event
.kind
= HELP_EVENT
;
3924 event
.frame_or_window
= frame
;
3926 event
.x
= WINDOWP (window
) ? window
: frame
;
3929 kbd_buffer_store_event (&event
);
3933 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3936 kbd_buffer_store_help_event (frame
, help
)
3937 Lisp_Object frame
, help
;
3939 struct input_event event
;
3941 event
.kind
= HELP_EVENT
;
3942 event
.frame_or_window
= frame
;
3947 kbd_buffer_store_event (&event
);
3951 /* Discard any mouse events in the event buffer by setting them to
3954 discard_mouse_events ()
3956 struct input_event
*sp
;
3957 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3959 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3962 if (sp
->kind
== MOUSE_CLICK_EVENT
3963 || sp
->kind
== WHEEL_EVENT
3964 || sp
->kind
== HORIZ_WHEEL_EVENT
3966 || sp
->kind
== GPM_CLICK_EVENT
3968 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3970 sp
->kind
= NO_EVENT
;
3976 /* Return non-zero if there are any real events waiting in the event
3977 buffer, not counting `NO_EVENT's.
3979 If DISCARD is non-zero, discard NO_EVENT events at the front of
3980 the input queue, possibly leaving the input queue empty if there
3981 are no real input events. */
3984 kbd_buffer_events_waiting (discard
)
3987 struct input_event
*sp
;
3989 for (sp
= kbd_fetch_ptr
;
3990 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3993 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4000 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
4004 /* Clear input event EVENT. */
4008 struct input_event
*event
;
4010 event
->kind
= NO_EVENT
;
4014 /* Read one event from the event buffer, waiting if necessary.
4015 The value is a Lisp object representing the event.
4016 The value is nil for an event that should be ignored,
4017 or that was handled here.
4018 We always read and discard one event. */
4021 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
4023 int *used_mouse_menu
;
4024 EMACS_TIME
*end_time
;
4033 *kbp
= current_kboard
;
4037 /* Wait until there is input available. */
4040 /* Break loop if there's an unread command event. Needed in
4041 moused window autoselection which uses a timer to insert such
4043 if (CONSP (Vunread_command_events
))
4046 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4048 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4049 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4053 /* If the quit flag is set, then read_char will return
4054 quit_char, so that counts as "available input." */
4055 if (!NILP (Vquit_flag
))
4056 quit_throw_to_read_char ();
4058 /* One way or another, wait until input is available; then, if
4059 interrupt handlers have not read it, read it now. */
4062 wait_for_kbd_input ();
4064 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4068 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4070 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4071 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4076 EMACS_TIME duration
;
4077 EMACS_GET_TIME (duration
);
4078 if (EMACS_TIME_GE (duration
, *end_time
))
4079 return Qnil
; /* finished waiting */
4082 EMACS_SUB_TIME (duration
, *end_time
, duration
);
4083 wait_reading_process_output (EMACS_SECS (duration
),
4084 EMACS_USECS (duration
),
4085 -1, 1, Qnil
, NULL
, 0);
4089 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
4091 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
4092 /* Pass 1 for EXPECT since we just waited to have input. */
4093 read_avail_input (1);
4094 #endif /* not VMS */
4097 if (CONSP (Vunread_command_events
))
4100 first
= XCAR (Vunread_command_events
);
4101 Vunread_command_events
= XCDR (Vunread_command_events
);
4102 *kbp
= current_kboard
;
4106 /* At this point, we know that there is a readable event available
4107 somewhere. If the event queue is empty, then there must be a
4108 mouse movement enabled and available. */
4109 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4111 struct input_event
*event
;
4113 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4117 last_event_timestamp
= event
->timestamp
;
4120 *kbp
= event_to_kboard (event
);
4122 *kbp
= current_kboard
; /* Better than returning null ptr? */
4124 *kbp
= &the_only_kboard
;
4129 /* These two kinds of events get special handling
4130 and don't actually appear to the command loop.
4131 We return nil for them. */
4132 if (event
->kind
== SELECTION_REQUEST_EVENT
4133 || event
->kind
== SELECTION_CLEAR_EVENT
)
4136 struct input_event copy
;
4138 /* Remove it from the buffer before processing it,
4139 since otherwise swallow_events will see it
4140 and process it again. */
4142 kbd_fetch_ptr
= event
+ 1;
4143 input_pending
= readable_events (0);
4144 x_handle_selection_event (©
);
4146 /* We're getting selection request events, but we don't have
4152 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4153 || defined (HAVE_NS)
4154 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4156 /* Make an event (delete-frame (FRAME)). */
4157 obj
= Fcons (event
->frame_or_window
, Qnil
);
4158 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4159 kbd_fetch_ptr
= event
+ 1;
4162 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4163 || defined (HAVE_NS)
4164 else if (event
->kind
== ICONIFY_EVENT
)
4166 /* Make an event (iconify-frame (FRAME)). */
4167 obj
= Fcons (event
->frame_or_window
, Qnil
);
4168 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4169 kbd_fetch_ptr
= event
+ 1;
4171 else if (event
->kind
== DEICONIFY_EVENT
)
4173 /* Make an event (make-frame-visible (FRAME)). */
4174 obj
= Fcons (event
->frame_or_window
, Qnil
);
4175 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4176 kbd_fetch_ptr
= event
+ 1;
4179 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4181 /* The value doesn't matter here; only the type is tested. */
4182 XSETBUFFER (obj
, current_buffer
);
4183 kbd_fetch_ptr
= event
+ 1;
4185 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4186 || defined(HAVE_NS) || defined (USE_GTK)
4187 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4189 kbd_fetch_ptr
= event
+ 1;
4190 input_pending
= readable_events (0);
4191 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4192 x_activate_menubar (XFRAME (event
->frame_or_window
));
4195 #if defined (WINDOWSNT) || defined (MAC_OS)
4196 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4199 /* Make an event (language-change (KEY_SCRIPT)). */
4200 obj
= Fcons (make_number (event
->code
), Qnil
);
4202 /* Make an event (language-change (FRAME CHARSET LCID)). */
4203 obj
= Fcons (event
->frame_or_window
, Qnil
);
4205 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4206 kbd_fetch_ptr
= event
+ 1;
4209 else if (event
->kind
== SAVE_SESSION_EVENT
)
4211 obj
= Fcons (Qsave_session
, Qnil
);
4212 kbd_fetch_ptr
= event
+ 1;
4214 /* Just discard these, by returning nil.
4215 With MULTI_KBOARD, these events are used as placeholders
4216 when we need to randomly delete events from the queue.
4217 (They shouldn't otherwise be found in the buffer,
4218 but on some machines it appears they do show up
4219 even without MULTI_KBOARD.) */
4220 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4221 mouse events during a popup-menu call. */
4222 else if (event
->kind
== NO_EVENT
)
4223 kbd_fetch_ptr
= event
+ 1;
4224 else if (event
->kind
== HELP_EVENT
)
4226 Lisp_Object object
, position
, help
, frame
, window
;
4228 frame
= event
->frame_or_window
;
4229 object
= event
->arg
;
4230 position
= make_number (event
->code
);
4233 clear_event (event
);
4235 kbd_fetch_ptr
= event
+ 1;
4236 if (!WINDOWP (window
))
4238 obj
= Fcons (Qhelp_echo
,
4239 list5 (frame
, help
, window
, object
, position
));
4241 else if (event
->kind
== FOCUS_IN_EVENT
)
4243 /* Notification of a FocusIn event. The frame receiving the
4244 focus is in event->frame_or_window. Generate a
4245 switch-frame event if necessary. */
4246 Lisp_Object frame
, focus
;
4248 frame
= event
->frame_or_window
;
4249 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4253 if (!EQ (frame
, internal_last_event_frame
)
4254 && !EQ (frame
, selected_frame
))
4255 obj
= make_lispy_switch_frame (frame
);
4256 internal_last_event_frame
= frame
;
4257 kbd_fetch_ptr
= event
+ 1;
4260 else if (event
->kind
== DBUS_EVENT
)
4262 obj
= make_lispy_event (event
);
4263 kbd_fetch_ptr
= event
+ 1;
4268 /* If this event is on a different frame, return a switch-frame this
4269 time, and leave the event in the queue for next time. */
4273 frame
= event
->frame_or_window
;
4275 frame
= XCAR (frame
);
4276 else if (WINDOWP (frame
))
4277 frame
= WINDOW_FRAME (XWINDOW (frame
));
4279 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4283 if (! EQ (frame
, internal_last_event_frame
)
4284 && !EQ (frame
, selected_frame
))
4285 obj
= make_lispy_switch_frame (frame
);
4286 internal_last_event_frame
= frame
;
4288 /* If we didn't decide to make a switch-frame event, go ahead
4289 and build a real event from the queue entry. */
4293 obj
= make_lispy_event (event
);
4295 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4296 || defined(HAVE_NS) || defined (USE_GTK)
4297 /* If this was a menu selection, then set the flag to inhibit
4298 writing to last_nonmenu_event. Don't do this if the event
4299 we're returning is (menu-bar), though; that indicates the
4300 beginning of the menu sequence, and we might as well leave
4301 that as the `event with parameters' for this selection. */
4303 && !EQ (event
->frame_or_window
, event
->arg
)
4304 && (event
->kind
== MENU_BAR_EVENT
4305 || event
->kind
== TOOL_BAR_EVENT
))
4306 *used_mouse_menu
= 1;
4309 /* Wipe out this event, to catch bugs. */
4310 clear_event (event
);
4311 kbd_fetch_ptr
= event
+ 1;
4315 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4316 /* Try generating a mouse motion event. */
4317 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4319 FRAME_PTR f
= some_mouse_moved ();
4320 Lisp_Object bar_window
;
4321 enum scroll_bar_part part
;
4325 *kbp
= current_kboard
;
4326 /* Note that this uses F to determine which terminal to look at.
4327 If there is no valid info, it does not store anything
4328 so x remains nil. */
4331 /* XXX Can f or mouse_position_hook be NULL here? */
4332 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4333 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4334 &part
, &x
, &y
, &time
);
4338 /* Decide if we should generate a switch-frame event. Don't
4339 generate switch-frame events for motion outside of all Emacs
4345 frame
= FRAME_FOCUS_FRAME (f
);
4347 XSETFRAME (frame
, f
);
4349 if (! EQ (frame
, internal_last_event_frame
)
4350 && !EQ (frame
, selected_frame
))
4351 obj
= make_lispy_switch_frame (frame
);
4352 internal_last_event_frame
= frame
;
4355 /* If we didn't decide to make a switch-frame event, go ahead and
4356 return a mouse-motion event. */
4357 if (!NILP (x
) && NILP (obj
))
4358 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4360 #endif /* HAVE_MOUSE || HAVE GPM */
4362 /* We were promised by the above while loop that there was
4363 something for us to read! */
4366 input_pending
= readable_events (0);
4368 Vlast_event_frame
= internal_last_event_frame
;
4373 /* Process any events that are not user-visible,
4374 then return, without reading any user-visible events. */
4377 swallow_events (do_display
)
4382 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4384 struct input_event
*event
;
4386 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4390 last_event_timestamp
= event
->timestamp
;
4392 /* These two kinds of events get special handling
4393 and don't actually appear to the command loop. */
4394 if (event
->kind
== SELECTION_REQUEST_EVENT
4395 || event
->kind
== SELECTION_CLEAR_EVENT
)
4398 struct input_event copy
;
4400 /* Remove it from the buffer before processing it,
4401 since otherwise swallow_events called recursively could see it
4402 and process it again. */
4404 kbd_fetch_ptr
= event
+ 1;
4405 input_pending
= readable_events (0);
4406 x_handle_selection_event (©
);
4408 /* We're getting selection request events, but we don't have
4417 old_timers_run
= timers_run
;
4418 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4420 if (timers_run
!= old_timers_run
&& do_display
)
4421 redisplay_preserve_echo_area (7);
4424 /* Record the start of when Emacs is idle,
4425 for the sake of running idle-time timers. */
4432 /* If we are already in the idle state, do nothing. */
4433 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4436 EMACS_GET_TIME (timer_idleness_start_time
);
4438 timer_last_idleness_start_time
= timer_idleness_start_time
;
4440 /* Mark all idle-time timers as once again candidates for running. */
4441 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4445 timer
= XCAR (timers
);
4447 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4449 XVECTOR (timer
)->contents
[0] = Qnil
;
4453 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4458 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4461 /* Resume idle timer from last idle start time. */
4464 timer_resume_idle ()
4466 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4469 timer_idleness_start_time
= timer_last_idleness_start_time
;
4472 /* This is only for debugging. */
4473 struct input_event last_timer_event
;
4475 /* List of elisp functions to call, delayed because they were generated in
4476 a context where Elisp could not be safely run (e.g. redisplay, signal,
4477 ...). Each lement has the form (FUN . ARGS). */
4478 Lisp_Object pending_funcalls
;
4480 extern Lisp_Object Qapply
;
4482 /* Check whether a timer has fired. To prevent larger problems we simply
4483 disregard elements that are not proper timers. Do not make a circular
4484 timer list for the time being.
4486 Returns the number of seconds to wait until the next timer fires. If a
4487 timer is triggering now, return zero seconds.
4488 If no timer is active, return -1 seconds.
4490 If a timer is ripe, we run it, with quitting turned off.
4492 DO_IT_NOW is now ignored. It used to mean that we should
4493 run the timer directly instead of queueing a timer-event.
4494 Now we always run timers directly. */
4497 timer_check (do_it_now
)
4500 EMACS_TIME nexttime
;
4501 EMACS_TIME now
, idleness_now
;
4502 Lisp_Object timers
, idle_timers
, chosen_timer
;
4503 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4505 EMACS_SET_SECS (nexttime
, -1);
4506 EMACS_SET_USECS (nexttime
, -1);
4508 /* Always consider the ordinary timers. */
4509 timers
= Vtimer_list
;
4510 /* Consider the idle timers only if Emacs is idle. */
4511 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4512 idle_timers
= Vtimer_idle_list
;
4515 chosen_timer
= Qnil
;
4516 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4518 /* First run the code that was delayed. */
4519 while (CONSP (pending_funcalls
))
4521 Lisp_Object funcall
= XCAR (pending_funcalls
);
4522 pending_funcalls
= XCDR (pending_funcalls
);
4523 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4526 if (CONSP (timers
) || CONSP (idle_timers
))
4528 EMACS_GET_TIME (now
);
4529 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4530 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4533 while (CONSP (timers
) || CONSP (idle_timers
))
4535 Lisp_Object
*vector
;
4536 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4537 EMACS_TIME timer_time
, idle_timer_time
;
4538 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4540 /* Skip past invalid timers and timers already handled. */
4543 timer
= XCAR (timers
);
4544 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4546 timers
= XCDR (timers
);
4549 vector
= XVECTOR (timer
)->contents
;
4551 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4552 || !INTEGERP (vector
[3])
4553 || ! NILP (vector
[0]))
4555 timers
= XCDR (timers
);
4559 if (!NILP (idle_timers
))
4561 timer
= XCAR (idle_timers
);
4562 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4564 idle_timers
= XCDR (idle_timers
);
4567 vector
= XVECTOR (timer
)->contents
;
4569 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4570 || !INTEGERP (vector
[3])
4571 || ! NILP (vector
[0]))
4573 idle_timers
= XCDR (idle_timers
);
4578 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4579 based on the next ordinary timer.
4580 TIMER_DIFFERENCE is the distance in time from NOW to when
4581 this timer becomes ripe (negative if it's already ripe). */
4584 timer
= XCAR (timers
);
4585 vector
= XVECTOR (timer
)->contents
;
4586 EMACS_SET_SECS (timer_time
,
4587 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4588 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4589 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4592 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4593 based on the next idle timer. */
4594 if (!NILP (idle_timers
))
4596 idle_timer
= XCAR (idle_timers
);
4597 vector
= XVECTOR (idle_timer
)->contents
;
4598 EMACS_SET_SECS (idle_timer_time
,
4599 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4600 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4601 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4604 /* Decide which timer is the next timer,
4605 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4606 Also step down the list where we found that timer. */
4608 if (! NILP (timers
) && ! NILP (idle_timers
))
4611 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4612 if (EMACS_TIME_NEG_P (temp
))
4614 chosen_timer
= timer
;
4615 timers
= XCDR (timers
);
4616 difference
= timer_difference
;
4620 chosen_timer
= idle_timer
;
4621 idle_timers
= XCDR (idle_timers
);
4622 difference
= idle_timer_difference
;
4625 else if (! NILP (timers
))
4627 chosen_timer
= timer
;
4628 timers
= XCDR (timers
);
4629 difference
= timer_difference
;
4633 chosen_timer
= idle_timer
;
4634 idle_timers
= XCDR (idle_timers
);
4635 difference
= idle_timer_difference
;
4637 vector
= XVECTOR (chosen_timer
)->contents
;
4639 /* If timer is ripe, run it if it hasn't been run. */
4640 if (EMACS_TIME_NEG_P (difference
)
4641 || (EMACS_SECS (difference
) == 0
4642 && EMACS_USECS (difference
) == 0))
4644 if (NILP (vector
[0]))
4646 int count
= SPECPDL_INDEX ();
4647 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4649 #if 0 /* This shouldn't be necessary anymore. --lorentey */
4650 /* On unbind_to, resume allowing input from any kboard, if that
4652 record_single_kboard_state ();
4654 /* Mark the timer as triggered to prevent problems if the lisp
4655 code fails to reschedule it right. */
4658 specbind (Qinhibit_quit
, Qt
);
4660 call1 (Qtimer_event_handler
, chosen_timer
);
4661 Vdeactivate_mark
= old_deactivate_mark
;
4663 unbind_to (count
, Qnil
);
4665 /* Since we have handled the event,
4666 we don't need to tell the caller to wake up and do it. */
4670 /* When we encounter a timer that is still waiting,
4671 return the amount of time to wait before it is ripe. */
4678 /* No timers are pending in the future. */
4679 /* Return 0 if we generated an event, and -1 if not. */
4684 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4685 doc
: /* Return the current length of Emacs idleness, or nil.
4686 The value when Emacs is idle is a list of three integers. The first has the
4687 most significant 16 bits of the seconds, while the second has the
4688 least significant 16 bits. The third integer gives the microsecond
4691 The value when Emacs is not idle is nil.
4693 The microsecond count is zero on systems that do not provide
4694 resolution finer than a second. */)
4697 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4699 EMACS_TIME now
, idleness_now
;
4701 EMACS_GET_TIME (now
);
4702 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4704 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4705 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4706 make_number (EMACS_USECS (idleness_now
)));
4712 /* Caches for modify_event_symbol. */
4713 static Lisp_Object accent_key_syms
;
4714 static Lisp_Object func_key_syms
;
4715 static Lisp_Object mouse_syms
;
4716 static Lisp_Object wheel_syms
;
4717 static Lisp_Object drag_n_drop_syms
;
4719 /* This is a list of keysym codes for special "accent" characters.
4720 It parallels lispy_accent_keys. */
4722 static int lispy_accent_codes
[] =
4724 #ifdef XK_dead_circumflex
4729 #ifdef XK_dead_grave
4734 #ifdef XK_dead_tilde
4739 #ifdef XK_dead_diaeresis
4744 #ifdef XK_dead_macron
4749 #ifdef XK_dead_degree
4754 #ifdef XK_dead_acute
4759 #ifdef XK_dead_cedilla
4764 #ifdef XK_dead_breve
4769 #ifdef XK_dead_ogonek
4774 #ifdef XK_dead_caron
4779 #ifdef XK_dead_doubleacute
4780 XK_dead_doubleacute
,
4784 #ifdef XK_dead_abovedot
4789 #ifdef XK_dead_abovering
4799 #ifdef XK_dead_belowdot
4804 #ifdef XK_dead_voiced_sound
4805 XK_dead_voiced_sound
,
4809 #ifdef XK_dead_semivoiced_sound
4810 XK_dead_semivoiced_sound
,
4826 /* This is a list of Lisp names for special "accent" characters.
4827 It parallels lispy_accent_codes. */
4829 static char *lispy_accent_keys
[] =
4847 "dead-voiced-sound",
4848 "dead-semivoiced-sound",
4854 #define FUNCTION_KEY_OFFSET 0x0
4856 char *lispy_function_keys
[] =
4860 0, /* VK_LBUTTON 0x01 */
4861 0, /* VK_RBUTTON 0x02 */
4862 "cancel", /* VK_CANCEL 0x03 */
4863 0, /* VK_MBUTTON 0x04 */
4865 0, 0, 0, /* 0x05 .. 0x07 */
4867 "backspace", /* VK_BACK 0x08 */
4868 "tab", /* VK_TAB 0x09 */
4870 0, 0, /* 0x0A .. 0x0B */
4872 "clear", /* VK_CLEAR 0x0C */
4873 "return", /* VK_RETURN 0x0D */
4875 0, 0, /* 0x0E .. 0x0F */
4877 0, /* VK_SHIFT 0x10 */
4878 0, /* VK_CONTROL 0x11 */
4879 0, /* VK_MENU 0x12 */
4880 "pause", /* VK_PAUSE 0x13 */
4881 "capslock", /* VK_CAPITAL 0x14 */
4882 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4884 "junja", /* VK_JUNJA 0x17 */
4885 "final", /* VK_FINAL 0x18 */
4886 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4888 "escape", /* VK_ESCAPE 0x1B */
4889 "convert", /* VK_CONVERT 0x1C */
4890 "non-convert", /* VK_NONCONVERT 0x1D */
4891 "accept", /* VK_ACCEPT 0x1E */
4892 "mode-change", /* VK_MODECHANGE 0x1F */
4893 0, /* VK_SPACE 0x20 */
4894 "prior", /* VK_PRIOR 0x21 */
4895 "next", /* VK_NEXT 0x22 */
4896 "end", /* VK_END 0x23 */
4897 "home", /* VK_HOME 0x24 */
4898 "left", /* VK_LEFT 0x25 */
4899 "up", /* VK_UP 0x26 */
4900 "right", /* VK_RIGHT 0x27 */
4901 "down", /* VK_DOWN 0x28 */
4902 "select", /* VK_SELECT 0x29 */
4903 "print", /* VK_PRINT 0x2A */
4904 "execute", /* VK_EXECUTE 0x2B */
4905 "snapshot", /* VK_SNAPSHOT 0x2C */
4906 "insert", /* VK_INSERT 0x2D */
4907 "delete", /* VK_DELETE 0x2E */
4908 "help", /* VK_HELP 0x2F */
4910 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4912 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4914 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4916 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4918 0, 0, 0, 0, 0, 0, 0, 0, 0,
4919 0, 0, 0, 0, 0, 0, 0, 0, 0,
4920 0, 0, 0, 0, 0, 0, 0, 0,
4922 "lwindow", /* VK_LWIN 0x5B */
4923 "rwindow", /* VK_RWIN 0x5C */
4924 "apps", /* VK_APPS 0x5D */
4927 "kp-0", /* VK_NUMPAD0 0x60 */
4928 "kp-1", /* VK_NUMPAD1 0x61 */
4929 "kp-2", /* VK_NUMPAD2 0x62 */
4930 "kp-3", /* VK_NUMPAD3 0x63 */
4931 "kp-4", /* VK_NUMPAD4 0x64 */
4932 "kp-5", /* VK_NUMPAD5 0x65 */
4933 "kp-6", /* VK_NUMPAD6 0x66 */
4934 "kp-7", /* VK_NUMPAD7 0x67 */
4935 "kp-8", /* VK_NUMPAD8 0x68 */
4936 "kp-9", /* VK_NUMPAD9 0x69 */
4937 "kp-multiply", /* VK_MULTIPLY 0x6A */
4938 "kp-add", /* VK_ADD 0x6B */
4939 "kp-separator", /* VK_SEPARATOR 0x6C */
4940 "kp-subtract", /* VK_SUBTRACT 0x6D */
4941 "kp-decimal", /* VK_DECIMAL 0x6E */
4942 "kp-divide", /* VK_DIVIDE 0x6F */
4943 "f1", /* VK_F1 0x70 */
4944 "f2", /* VK_F2 0x71 */
4945 "f3", /* VK_F3 0x72 */
4946 "f4", /* VK_F4 0x73 */
4947 "f5", /* VK_F5 0x74 */
4948 "f6", /* VK_F6 0x75 */
4949 "f7", /* VK_F7 0x76 */
4950 "f8", /* VK_F8 0x77 */
4951 "f9", /* VK_F9 0x78 */
4952 "f10", /* VK_F10 0x79 */
4953 "f11", /* VK_F11 0x7A */
4954 "f12", /* VK_F12 0x7B */
4955 "f13", /* VK_F13 0x7C */
4956 "f14", /* VK_F14 0x7D */
4957 "f15", /* VK_F15 0x7E */
4958 "f16", /* VK_F16 0x7F */
4959 "f17", /* VK_F17 0x80 */
4960 "f18", /* VK_F18 0x81 */
4961 "f19", /* VK_F19 0x82 */
4962 "f20", /* VK_F20 0x83 */
4963 "f21", /* VK_F21 0x84 */
4964 "f22", /* VK_F22 0x85 */
4965 "f23", /* VK_F23 0x86 */
4966 "f24", /* VK_F24 0x87 */
4968 0, 0, 0, 0, /* 0x88 .. 0x8B */
4969 0, 0, 0, 0, /* 0x8C .. 0x8F */
4971 "kp-numlock", /* VK_NUMLOCK 0x90 */
4972 "scroll", /* VK_SCROLL 0x91 */
4973 /* Not sure where the following block comes from.
4974 Windows headers have NEC and Fujitsu specific keys in
4975 this block, but nothing generic. */
4976 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4977 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4978 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4979 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4980 "kp-end", /* VK_NUMPAD_END 0x96 */
4981 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4982 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4983 "kp-up", /* VK_NUMPAD_UP 0x99 */
4984 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4985 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4986 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4987 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4989 0, 0, /* 0x9E .. 0x9F */
4992 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4993 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4994 * No other API or message will distinguish left and right keys this way.
4999 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
5000 to enable them selectively, and gives access to a few more functions.
5001 See lispy_multimedia_keys below. */
5002 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
5003 0, 0, 0, /* 0xAD .. 0xAF Volume */
5004 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
5005 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
5007 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
5008 0, 0, 0, 0, 0, 0, 0, 0, 0,
5010 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
5011 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5012 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5015 "ax", /* VK_OEM_AX 0xE1 */
5016 0, /* VK_OEM_102 0xE2 */
5017 "ico-help", /* VK_ICO_HELP 0xE3 */
5018 "ico-00", /* VK_ICO_00 0xE4 */
5019 0, /* VK_PROCESSKEY 0xE5 */
5020 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
5021 "packet", /* VK_PACKET 0xE7 */
5023 "reset", /* VK_OEM_RESET 0xE9 */
5024 "jump", /* VK_OEM_JUMP 0xEA */
5025 "oem-pa1", /* VK_OEM_PA1 0xEB */
5026 "oem-pa2", /* VK_OEM_PA2 0xEC */
5027 "oem-pa3", /* VK_OEM_PA3 0xED */
5028 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
5029 "cusel", /* VK_OEM_CUSEL 0xEF */
5030 "oem-attn", /* VK_OEM_ATTN 0xF0 */
5031 "finish", /* VK_OEM_FINISH 0xF1 */
5032 "copy", /* VK_OEM_COPY 0xF2 */
5033 "auto", /* VK_OEM_AUTO 0xF3 */
5034 "enlw", /* VK_OEM_ENLW 0xF4 */
5035 "backtab", /* VK_OEM_BACKTAB 0xF5 */
5036 "attn", /* VK_ATTN 0xF6 */
5037 "crsel", /* VK_CRSEL 0xF7 */
5038 "exsel", /* VK_EXSEL 0xF8 */
5039 "ereof", /* VK_EREOF 0xF9 */
5040 "play", /* VK_PLAY 0xFA */
5041 "zoom", /* VK_ZOOM 0xFB */
5042 "noname", /* VK_NONAME 0xFC */
5043 "pa1", /* VK_PA1 0xFD */
5044 "oem_clear", /* VK_OEM_CLEAR 0xFE */
5048 /* Some of these duplicate the "Media keys" on newer keyboards,
5049 but they are delivered to the application in a different way. */
5050 static char *lispy_multimedia_keys
[] =
5058 "browser-favorites",
5095 "toggle-dictate-command",
5101 "media-fast-forward",
5104 "media-channel-down"
5107 #else /* not HAVE_NTGUI */
5109 /* This should be dealt with in XTread_socket now, and that doesn't
5110 depend on the client system having the Kana syms defined. See also
5111 the XK_kana_A case below. */
5114 static char *lispy_kana_keys
[] =
5116 /* X Keysym value */
5117 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5118 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5119 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5120 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5121 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5122 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5123 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5124 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5125 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5126 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5127 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5128 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5129 "kana-i", "kana-u", "kana-e", "kana-o",
5130 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5131 "prolongedsound", "kana-A", "kana-I", "kana-U",
5132 "kana-E", "kana-O", "kana-KA", "kana-KI",
5133 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5134 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5135 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5136 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5137 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5138 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5139 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5140 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5141 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5142 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5143 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5144 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5146 #endif /* XK_kana_A */
5149 #define FUNCTION_KEY_OFFSET 0xff00
5151 /* You'll notice that this table is arranged to be conveniently
5152 indexed by X Windows keysym values. */
5153 static char *lispy_function_keys
[] =
5155 /* X Keysym value */
5157 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5158 "backspace", "tab", "linefeed", "clear",
5160 0, 0, 0, "pause", /* 0xff10...1f */
5161 0, 0, 0, 0, 0, 0, 0, "escape",
5163 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5164 "romaji", "hiragana", "katakana", "hiragana-katakana",
5165 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5166 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5167 "eisu-toggle", /* 0xff30...3f */
5168 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5169 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5171 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5172 "down", "prior", "next", "end",
5173 "begin", 0, 0, 0, 0, 0, 0, 0,
5174 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5185 "break", /* 0xff6b */
5188 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5189 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5190 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5191 0, 0, 0, 0, 0, 0, 0, 0,
5192 "kp-tab", /* 0xff89 */
5194 "kp-enter", /* 0xff8d */
5196 "kp-f1", /* 0xff91 */
5200 "kp-home", /* 0xff95 */
5205 "kp-prior", /* kp-page-up */
5206 "kp-next", /* kp-page-down */
5212 0, 0, 0, 0, 0, 0, 0, 0, 0,
5213 "kp-multiply", /* 0xffaa */
5218 "kp-divide", /* 0xffaf */
5219 "kp-0", /* 0xffb0 */
5220 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5223 "kp-equal", /* 0xffbd */
5224 "f1", /* 0xffbe */ /* IsFunctionKey */
5226 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5227 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5228 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5229 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5230 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5231 0, 0, 0, 0, 0, 0, 0, 0,
5232 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5233 0, 0, 0, 0, 0, 0, 0, "delete"
5236 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5237 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5239 static char *iso_lispy_function_keys
[] =
5241 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5242 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5243 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5244 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5245 "iso-lefttab", /* 0xfe20 */
5246 "iso-move-line-up", "iso-move-line-down",
5247 "iso-partial-line-up", "iso-partial-line-down",
5248 "iso-partial-space-left", "iso-partial-space-right",
5249 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5250 "iso-release-margin-left", "iso-release-margin-right",
5251 "iso-release-both-margins",
5252 "iso-fast-cursor-left", "iso-fast-cursor-right",
5253 "iso-fast-cursor-up", "iso-fast-cursor-down",
5254 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5255 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5258 #endif /* not HAVE_NTGUI */
5260 Lisp_Object Vlispy_mouse_stem
;
5262 static char *lispy_wheel_names
[] =
5264 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5267 /* drag-n-drop events are generated when a set of selected files are
5268 dragged from another application and dropped onto an Emacs window. */
5269 static char *lispy_drag_n_drop_names
[] =
5274 /* Scroll bar parts. */
5275 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5276 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5277 Lisp_Object Qtop
, Qratio
;
5279 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5280 Lisp_Object
*scroll_bar_parts
[] = {
5281 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5282 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5285 /* A vector, indexed by button number, giving the down-going location
5286 of currently depressed buttons, both scroll bar and non-scroll bar.
5288 The elements have the form
5289 (BUTTON-NUMBER MODIFIER-MASK . REST)
5290 where REST is the cdr of a position as it would be reported in the event.
5292 The make_lispy_event function stores positions here to tell the
5293 difference between click and drag events, and to store the starting
5294 location to be included in drag events. */
5296 static Lisp_Object button_down_location
;
5298 /* Information about the most recent up-going button event: Which
5299 button, what location, and what time. */
5301 static int last_mouse_button
;
5302 static int last_mouse_x
;
5303 static int last_mouse_y
;
5304 static unsigned long button_down_time
;
5306 /* The maximum time between clicks to make a double-click, or Qnil to
5307 disable double-click detection, or Qt for no time limit. */
5309 Lisp_Object Vdouble_click_time
;
5311 /* Maximum number of pixels the mouse may be moved between clicks
5312 to make a double-click. */
5314 EMACS_INT double_click_fuzz
;
5316 /* The number of clicks in this multiple-click. */
5318 int double_click_count
;
5320 /* Return position of a mouse click or wheel event */
5323 make_lispy_position (f
, x
, y
, time
)
5329 enum window_part part
;
5330 Lisp_Object posn
= Qnil
;
5331 Lisp_Object extra_info
= Qnil
;
5334 /* Set `window' to the window under frame pixel coordinates (x,y) */
5336 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5337 &part
, &wx
, &wy
, 0);
5341 if (WINDOWP (window
))
5343 /* It's a click in window window at frame coordinates (x,y) */
5344 struct window
*w
= XWINDOW (window
);
5345 Lisp_Object string_info
= Qnil
;
5346 int textpos
= -1, rx
= -1, ry
= -1;
5347 int dx
= -1, dy
= -1;
5348 int width
= -1, height
= -1;
5349 Lisp_Object object
= Qnil
;
5351 /* Set event coordinates to window-relative coordinates
5352 for constructing the Lisp event below. */
5356 if (part
== ON_TEXT
)
5358 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5360 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5362 /* Mode line or header line. Look for a string under
5363 the mouse that may have a `local-map' property. */
5367 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5369 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5370 &object
, &dx
, &dy
, &width
, &height
);
5371 if (STRINGP (string
))
5372 string_info
= Fcons (string
, make_number (charpos
));
5373 if (w
== XWINDOW (selected_window
))
5376 textpos
= XMARKER (w
->pointm
)->charpos
;
5378 else if (part
== ON_VERTICAL_BORDER
)
5380 posn
= Qvertical_line
;
5385 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5390 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5392 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5393 &object
, &dx
, &dy
, &width
, &height
);
5394 if (STRINGP (string
))
5395 string_info
= Fcons (string
, make_number (charpos
));
5396 if (part
== ON_LEFT_MARGIN
)
5399 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5401 else if (part
== ON_LEFT_FRINGE
)
5403 posn
= Qleft_fringe
;
5406 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5408 : window_box_width (w
, LEFT_MARGIN_AREA
));
5411 else if (part
== ON_RIGHT_FRINGE
)
5413 posn
= Qright_fringe
;
5416 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5417 + window_box_width (w
, TEXT_AREA
)
5418 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5419 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5425 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5426 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5431 Lisp_Object string2
, object2
= Qnil
;
5432 struct display_pos p
;
5434 int width2
, height2
;
5435 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5436 &object2
, &dx2
, &dy2
,
5438 textpos
= CHARPOS (p
.pos
);
5439 if (rx
< 0) rx
= wx
;
5440 if (ry
< 0) ry
= wy
;
5441 if (dx
< 0) dx
= dx2
;
5442 if (dy
< 0) dy
= dy2
;
5443 if (width
< 0) width
= width2
;
5444 if (height
< 0) height
= height2
;
5448 posn
= make_number (textpos
);
5449 if (STRINGP (string2
))
5450 string_info
= Fcons (string2
,
5451 make_number (CHARPOS (p
.string_pos
)));
5457 #ifdef HAVE_WINDOW_SYSTEM
5458 if (IMAGEP (object
))
5460 Lisp_Object image_map
, hotspot
;
5461 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5463 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5465 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5466 posn
= XCAR (hotspot
);
5471 extra_info
= Fcons (object
,
5472 Fcons (Fcons (make_number (dx
),
5474 Fcons (Fcons (make_number (width
),
5475 make_number (height
)),
5479 extra_info
= Fcons (string_info
,
5480 Fcons (make_number (textpos
),
5481 Fcons (Fcons (make_number (rx
),
5487 XSETFRAME (window
, f
);
5492 XSETFASTINT (*x
, 0);
5493 XSETFASTINT (*y
, 0);
5496 return Fcons (window
,
5498 Fcons (Fcons (*x
, *y
),
5499 Fcons (make_number (time
),
5503 /* Given a struct input_event, build the lisp event which represents
5504 it. If EVENT is 0, build a mouse movement event from the mouse
5505 movement buffer, which should have a movement event in it.
5507 Note that events must be passed to this function in the order they
5508 are received; this function stores the location of button presses
5509 in order to build drag events when the button is released. */
5512 make_lispy_event (event
)
5513 struct input_event
*event
;
5517 switch (SWITCH_ENUM_CAST (event
->kind
))
5519 /* A simple keystroke. */
5520 case ASCII_KEYSTROKE_EVENT
:
5521 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5523 Lisp_Object lispy_c
;
5524 int c
= event
->code
;
5525 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5528 eassert (c
== event
->code
);
5529 /* Turn ASCII characters into control characters
5531 if (event
->modifiers
& ctrl_modifier
)
5533 c
= make_ctrl_char (c
);
5534 event
->modifiers
&= ~ctrl_modifier
;
5538 /* Add in the other modifier bits. The shift key was taken care
5539 of by the X code. */
5540 c
|= (event
->modifiers
5541 & (meta_modifier
| alt_modifier
5542 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5543 /* Distinguish Shift-SPC from SPC. */
5544 if ((event
->code
) == 040
5545 && event
->modifiers
& shift_modifier
)
5546 c
|= shift_modifier
;
5547 button_down_time
= 0;
5548 XSETFASTINT (lispy_c
, c
);
5552 /* A function key. The symbol may need to have modifier prefixes
5554 case NON_ASCII_KEYSTROKE_EVENT
:
5555 button_down_time
= 0;
5557 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5558 if (event
->code
== lispy_accent_codes
[i
])
5559 return modify_event_symbol (i
,
5561 Qfunction_key
, Qnil
,
5562 lispy_accent_keys
, &accent_key_syms
,
5563 (sizeof (lispy_accent_keys
)
5564 / sizeof (lispy_accent_keys
[0])));
5568 if (event
->code
>= 0x400 && event
->code
< 0x500)
5569 return modify_event_symbol (event
->code
- 0x400,
5570 event
->modifiers
& ~shift_modifier
,
5571 Qfunction_key
, Qnil
,
5572 lispy_kana_keys
, &func_key_syms
,
5573 (sizeof (lispy_kana_keys
)
5574 / sizeof (lispy_kana_keys
[0])));
5575 #endif /* XK_kana_A */
5578 #ifdef ISO_FUNCTION_KEY_OFFSET
5579 if (event
->code
< FUNCTION_KEY_OFFSET
5580 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5581 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5583 Qfunction_key
, Qnil
,
5584 iso_lispy_function_keys
, &func_key_syms
,
5585 (sizeof (iso_lispy_function_keys
)
5586 / sizeof (iso_lispy_function_keys
[0])));
5589 /* Handle system-specific or unknown keysyms. */
5590 if (event
->code
& (1 << 28)
5591 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5592 || (event
->code
- FUNCTION_KEY_OFFSET
5593 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5594 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5596 /* We need to use an alist rather than a vector as the cache
5597 since we can't make a vector long enuf. */
5598 if (NILP (current_kboard
->system_key_syms
))
5599 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5600 return modify_event_symbol (event
->code
,
5603 current_kboard
->Vsystem_key_alist
,
5604 0, ¤t_kboard
->system_key_syms
,
5608 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5610 Qfunction_key
, Qnil
,
5611 lispy_function_keys
, &func_key_syms
,
5612 (sizeof (lispy_function_keys
)
5613 / sizeof (lispy_function_keys
[0])));
5616 case MULTIMEDIA_KEY_EVENT
:
5617 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5618 / sizeof (lispy_multimedia_keys
[0]))
5619 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5621 return modify_event_symbol (event
->code
, event
->modifiers
,
5622 Qfunction_key
, Qnil
,
5623 lispy_multimedia_keys
, &func_key_syms
,
5624 (sizeof (lispy_multimedia_keys
)
5625 / sizeof (lispy_multimedia_keys
[0])));
5631 /* A mouse click. Figure out where it is, decide whether it's
5632 a press, click or drag, and build the appropriate structure. */
5633 case MOUSE_CLICK_EVENT
:
5634 #ifndef USE_TOOLKIT_SCROLL_BARS
5635 case SCROLL_BAR_CLICK_EVENT
:
5638 int button
= event
->code
;
5640 Lisp_Object position
;
5641 Lisp_Object
*start_pos_ptr
;
5642 Lisp_Object start_pos
;
5646 /* Build the position as appropriate for this mouse click. */
5647 if (event
->kind
== MOUSE_CLICK_EVENT
)
5649 struct frame
*f
= XFRAME (event
->frame_or_window
);
5650 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5654 /* Ignore mouse events that were made on frame that
5655 have been deleted. */
5656 if (! FRAME_LIVE_P (f
))
5659 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5660 /* EVENT->x and EVENT->y are frame-relative pixel
5661 coordinates at this place. Under old redisplay, COLUMN
5662 and ROW are set to frame relative glyph coordinates
5663 which are then used to determine whether this click is
5664 in a menu (non-toolkit version). */
5665 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5666 &column
, &row
, NULL
, 1);
5668 /* In the non-toolkit version, clicks on the menu bar
5669 are ordinary button events in the event buffer.
5670 Distinguish them, and invoke the menu.
5672 (In the toolkit version, the toolkit handles the menu bar
5673 and Emacs doesn't know about it until after the user
5674 makes a selection.) */
5675 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5676 && (event
->modifiers
& down_modifier
))
5678 Lisp_Object items
, item
;
5683 /* Activate the menu bar on the down event. If the
5684 up event comes in before the menu code can deal with it,
5686 if (! (event
->modifiers
& down_modifier
))
5690 /* Find the menu bar item under `column'. */
5692 items
= FRAME_MENU_BAR_ITEMS (f
);
5693 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5695 Lisp_Object pos
, string
;
5696 string
= AREF (items
, i
+ 1);
5697 pos
= AREF (items
, i
+ 3);
5700 if (column
>= XINT (pos
)
5701 && column
< XINT (pos
) + SCHARS (string
))
5703 item
= AREF (items
, i
);
5708 /* ELisp manual 2.4b says (x y) are window relative but
5709 code says they are frame-relative. */
5711 = Fcons (event
->frame_or_window
,
5713 Fcons (Fcons (event
->x
, event
->y
),
5714 Fcons (make_number (event
->timestamp
),
5717 return Fcons (item
, Fcons (position
, Qnil
));
5719 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5721 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5724 #ifndef USE_TOOLKIT_SCROLL_BARS
5727 /* It's a scrollbar click. */
5729 Lisp_Object portion_whole
;
5732 window
= event
->frame_or_window
;
5733 portion_whole
= Fcons (event
->x
, event
->y
);
5734 part
= *scroll_bar_parts
[(int) event
->part
];
5738 Fcons (Qvertical_scroll_bar
,
5739 Fcons (portion_whole
,
5740 Fcons (make_number (event
->timestamp
),
5741 Fcons (part
, Qnil
)))));
5743 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5745 if (button
>= ASIZE (button_down_location
))
5747 button_down_location
= larger_vector (button_down_location
,
5749 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5752 start_pos_ptr
= &AREF (button_down_location
, button
);
5753 start_pos
= *start_pos_ptr
;
5754 *start_pos_ptr
= Qnil
;
5757 /* On window-system frames, use the value of
5758 double-click-fuzz as is. On other frames, interpret it
5759 as a multiple of 1/8 characters. */
5763 if (WINDOWP (event
->frame_or_window
))
5764 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5765 else if (FRAMEP (event
->frame_or_window
))
5766 f
= XFRAME (event
->frame_or_window
);
5770 if (FRAME_WINDOW_P (f
))
5771 fuzz
= double_click_fuzz
;
5773 fuzz
= double_click_fuzz
/ 8;
5775 is_double
= (button
== last_mouse_button
5776 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5777 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5778 && button_down_time
!= 0
5779 && (EQ (Vdouble_click_time
, Qt
)
5780 || (INTEGERP (Vdouble_click_time
)
5781 && ((int)(event
->timestamp
- button_down_time
)
5782 < XINT (Vdouble_click_time
)))));
5785 last_mouse_button
= button
;
5786 last_mouse_x
= XINT (event
->x
);
5787 last_mouse_y
= XINT (event
->y
);
5789 /* If this is a button press, squirrel away the location, so
5790 we can decide later whether it was a click or a drag. */
5791 if (event
->modifiers
& down_modifier
)
5795 double_click_count
++;
5796 event
->modifiers
|= ((double_click_count
> 2)
5801 double_click_count
= 1;
5802 button_down_time
= event
->timestamp
;
5803 *start_pos_ptr
= Fcopy_alist (position
);
5804 ignore_mouse_drag_p
= 0;
5807 /* Now we're releasing a button - check the co-ordinates to
5808 see if this was a click or a drag. */
5809 else if (event
->modifiers
& up_modifier
)
5811 /* If we did not see a down before this up, ignore the up.
5812 Probably this happened because the down event chose a
5813 menu item. It would be an annoyance to treat the
5814 release of the button that chose the menu item as a
5817 if (!CONSP (start_pos
))
5820 event
->modifiers
&= ~up_modifier
;
5821 #if 0 /* Formerly we treated an up with no down as a click event. */
5822 if (!CONSP (start_pos
))
5823 event
->modifiers
|= click_modifier
;
5828 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5830 /* The third element of every position
5831 should be the (x,y) pair. */
5832 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5834 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5836 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5837 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5840 if (ignore_mouse_drag_p
)
5842 event
->modifiers
|= click_modifier
;
5843 ignore_mouse_drag_p
= 0;
5845 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5846 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5847 /* Maybe the mouse has moved a lot, caused scrolling, and
5848 eventually ended up at the same screen position (but
5849 not buffer position) in which case it is a drag, not
5851 /* FIXME: OTOH if the buffer position has changed
5852 because of a timer or process filter rather than
5853 because of mouse movement, it should be considered as
5854 a click. But mouse-drag-region completely ignores
5855 this case and it hasn't caused any real problem, so
5856 it's probably OK to ignore it as well. */
5857 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5858 /* Mouse hasn't moved (much). */
5859 event
->modifiers
|= click_modifier
;
5862 button_down_time
= 0;
5863 event
->modifiers
|= drag_modifier
;
5866 /* Don't check is_double; treat this as multiple
5867 if the down-event was multiple. */
5868 if (double_click_count
> 1)
5869 event
->modifiers
|= ((double_click_count
> 2)
5875 /* Every mouse event should either have the down_modifier or
5876 the up_modifier set. */
5880 /* Get the symbol we should use for the mouse click. */
5883 head
= modify_event_symbol (button
,
5885 Qmouse_click
, Vlispy_mouse_stem
,
5888 XVECTOR (mouse_syms
)->size
);
5889 if (event
->modifiers
& drag_modifier
)
5894 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5897 Fcons (make_number (double_click_count
),
5907 case HORIZ_WHEEL_EVENT
:
5909 Lisp_Object position
;
5912 /* Build the position as appropriate for this mouse click. */
5913 struct frame
*f
= XFRAME (event
->frame_or_window
);
5915 /* Ignore wheel events that were made on frame that have been
5917 if (! FRAME_LIVE_P (f
))
5920 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5923 /* Set double or triple modifiers to indicate the wheel speed. */
5925 /* On window-system frames, use the value of
5926 double-click-fuzz as is. On other frames, interpret it
5927 as a multiple of 1/8 characters. */
5932 if (WINDOWP (event
->frame_or_window
))
5933 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5934 else if (FRAMEP (event
->frame_or_window
))
5935 f
= XFRAME (event
->frame_or_window
);
5939 if (FRAME_WINDOW_P (f
))
5940 fuzz
= double_click_fuzz
;
5942 fuzz
= double_click_fuzz
/ 8;
5944 is_double
= (last_mouse_button
< 0
5945 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5946 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5947 && button_down_time
!= 0
5948 && (EQ (Vdouble_click_time
, Qt
)
5949 || (INTEGERP (Vdouble_click_time
)
5950 && ((int)(event
->timestamp
- button_down_time
)
5951 < XINT (Vdouble_click_time
)))));
5954 double_click_count
++;
5955 event
->modifiers
|= ((double_click_count
> 2)
5961 double_click_count
= 1;
5962 event
->modifiers
|= click_modifier
;
5965 button_down_time
= event
->timestamp
;
5966 /* Use a negative value to distinguish wheel from mouse button. */
5967 last_mouse_button
= -1;
5968 last_mouse_x
= XINT (event
->x
);
5969 last_mouse_y
= XINT (event
->y
);
5975 if (event
->modifiers
& up_modifier
)
5977 /* Emit a wheel-up event. */
5978 event
->modifiers
&= ~up_modifier
;
5981 else if (event
->modifiers
& down_modifier
)
5983 /* Emit a wheel-down event. */
5984 event
->modifiers
&= ~down_modifier
;
5988 /* Every wheel event should either have the down_modifier or
5989 the up_modifier set. */
5992 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5995 /* Get the symbol we should use for the wheel event. */
5996 head
= modify_event_symbol (symbol_num
,
6002 ASIZE (wheel_syms
));
6005 if (event
->modifiers
& (double_modifier
| triple_modifier
))
6008 Fcons (make_number (double_click_count
),
6017 #ifdef USE_TOOLKIT_SCROLL_BARS
6019 /* We don't have down and up events if using toolkit scroll bars,
6020 so make this always a click event. Store in the `part' of
6021 the Lisp event a symbol which maps to the following actions:
6023 `above_handle' page up
6024 `below_handle' page down
6028 `bottom' bottom of buffer
6029 `handle' thumb has been dragged.
6030 `end-scroll' end of interaction with scroll bar
6032 The incoming input_event contains in its `part' member an
6033 index of type `enum scroll_bar_part' which we can use as an
6034 index in scroll_bar_parts to get the appropriate symbol. */
6036 case SCROLL_BAR_CLICK_EVENT
:
6038 Lisp_Object position
, head
, window
, portion_whole
, part
;
6040 window
= event
->frame_or_window
;
6041 portion_whole
= Fcons (event
->x
, event
->y
);
6042 part
= *scroll_bar_parts
[(int) event
->part
];
6046 Fcons (Qvertical_scroll_bar
,
6047 Fcons (portion_whole
,
6048 Fcons (make_number (event
->timestamp
),
6049 Fcons (part
, Qnil
)))));
6051 /* Always treat scroll bar events as clicks. */
6052 event
->modifiers
|= click_modifier
;
6053 event
->modifiers
&= ~up_modifier
;
6055 if (event
->code
>= ASIZE (mouse_syms
))
6056 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
6058 /* Get the symbol we should use for the mouse click. */
6059 head
= modify_event_symbol (event
->code
,
6064 XVECTOR (mouse_syms
)->size
);
6065 return Fcons (head
, Fcons (position
, Qnil
));
6068 #endif /* USE_TOOLKIT_SCROLL_BARS */
6070 case DRAG_N_DROP_EVENT
:
6073 Lisp_Object head
, position
;
6076 f
= XFRAME (event
->frame_or_window
);
6079 /* Ignore mouse events that were made on frames that
6080 have been deleted. */
6081 if (! FRAME_LIVE_P (f
))
6084 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6087 head
= modify_event_symbol (0, event
->modifiers
,
6089 lispy_drag_n_drop_names
,
6090 &drag_n_drop_syms
, 1);
6096 #endif /* HAVE_MOUSE */
6098 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
6099 || defined(HAVE_NS) || defined (USE_GTK)
6100 case MENU_BAR_EVENT
:
6101 if (EQ (event
->arg
, event
->frame_or_window
))
6102 /* This is the prefix key. We translate this to
6103 `(menu_bar)' because the code in keyboard.c for menu
6104 events, which we use, relies on this. */
6105 return Fcons (Qmenu_bar
, Qnil
);
6109 case SELECT_WINDOW_EVENT
:
6110 /* Make an event (select-window (WINDOW)). */
6111 return Fcons (Qselect_window
,
6112 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6115 case TOOL_BAR_EVENT
:
6116 if (EQ (event
->arg
, event
->frame_or_window
))
6117 /* This is the prefix key. We translate this to
6118 `(tool_bar)' because the code in keyboard.c for tool bar
6119 events, which we use, relies on this. */
6120 return Fcons (Qtool_bar
, Qnil
);
6121 else if (SYMBOLP (event
->arg
))
6122 return apply_modifiers (event
->modifiers
, event
->arg
);
6125 case USER_SIGNAL_EVENT
:
6126 /* A user signal. */
6128 char *name
= find_user_signal_name (event
->code
);
6131 return intern (name
);
6134 case SAVE_SESSION_EVENT
:
6135 return Qsave_session
;
6138 case MAC_APPLE_EVENT
:
6140 Lisp_Object spec
[2];
6144 return Fcons (Qmac_apple_event
,
6145 Fcons (Fvector (2, spec
),
6146 Fcons (event
->arg
, Qnil
)));
6153 return Fcons (Qdbus_event
, event
->arg
);
6155 #endif /* HAVE_DBUS */
6158 case GPM_CLICK_EVENT
:
6160 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6161 Lisp_Object head
, position
;
6162 Lisp_Object
*start_pos_ptr
;
6163 Lisp_Object start_pos
;
6164 int button
= event
->code
;
6166 if (button
>= ASIZE (button_down_location
))
6168 button_down_location
= larger_vector (button_down_location
,
6170 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6173 start_pos_ptr
= &AREF (button_down_location
, button
);
6174 start_pos
= *start_pos_ptr
;
6176 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6179 if (event
->modifiers
& down_modifier
)
6180 *start_pos_ptr
= Fcopy_alist (position
);
6181 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6183 if (!CONSP (start_pos
))
6185 event
->modifiers
&= ~up_modifier
;
6188 head
= modify_event_symbol (button
,
6190 Qmouse_click
, Vlispy_mouse_stem
,
6193 XVECTOR (mouse_syms
)->size
);
6195 if (event
->modifiers
& drag_modifier
)
6200 else if (event
->modifiers
& double_modifier
)
6203 Fcons (make_number (2),
6205 else if (event
->modifiers
& triple_modifier
)
6208 Fcons (make_number (3),
6215 #endif /* HAVE_GPM */
6217 /* The 'kind' field of the event is something we don't recognize. */
6223 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6226 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6228 Lisp_Object bar_window
;
6229 enum scroll_bar_part part
;
6233 /* Is it a scroll bar movement? */
6234 if (frame
&& ! NILP (bar_window
))
6236 Lisp_Object part_sym
;
6238 part_sym
= *scroll_bar_parts
[(int) part
];
6239 return Fcons (Qscroll_bar_movement
,
6240 (Fcons (Fcons (bar_window
,
6241 Fcons (Qvertical_scroll_bar
,
6242 Fcons (Fcons (x
, y
),
6243 Fcons (make_number (time
),
6249 /* Or is it an ordinary mouse movement? */
6252 Lisp_Object position
;
6254 position
= make_lispy_position (frame
, &x
, &y
, time
);
6256 return Fcons (Qmouse_movement
,
6262 #endif /* HAVE_MOUSE || HAVE GPM */
6264 /* Construct a switch frame event. */
6266 make_lispy_switch_frame (frame
)
6269 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6272 /* Manipulating modifiers. */
6274 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6276 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6277 SYMBOL's name of the end of the modifiers; the string from this
6278 position is the unmodified symbol name.
6280 This doesn't use any caches. */
6283 parse_modifiers_uncached (symbol
, modifier_end
)
6291 CHECK_SYMBOL (symbol
);
6294 name
= SYMBOL_NAME (symbol
);
6296 for (i
= 0; i
+2 <= SBYTES (name
); )
6298 int this_mod_end
= 0;
6301 /* See if the name continues with a modifier word.
6302 Check that the word appears, but don't check what follows it.
6303 Set this_mod and this_mod_end to record what we find. */
6305 switch (SREF (name
, i
))
6307 #define SINGLE_LETTER_MOD(BIT) \
6308 (this_mod_end = i + 1, this_mod = BIT)
6311 SINGLE_LETTER_MOD (alt_modifier
);
6315 SINGLE_LETTER_MOD (ctrl_modifier
);
6319 SINGLE_LETTER_MOD (hyper_modifier
);
6323 SINGLE_LETTER_MOD (meta_modifier
);
6327 SINGLE_LETTER_MOD (shift_modifier
);
6331 SINGLE_LETTER_MOD (super_modifier
);
6334 #undef SINGLE_LETTER_MOD
6336 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6337 if (i + LEN + 1 <= SBYTES (name) \
6338 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6340 this_mod_end = i + LEN; \
6345 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6346 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6347 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6351 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6353 #undef MULTI_LETTER_MOD
6357 /* If we found no modifier, stop looking for them. */
6358 if (this_mod_end
== 0)
6361 /* Check there is a dash after the modifier, so that it
6362 really is a modifier. */
6363 if (this_mod_end
>= SBYTES (name
)
6364 || SREF (name
, this_mod_end
) != '-')
6367 /* This modifier is real; look for another. */
6368 modifiers
|= this_mod
;
6369 i
= this_mod_end
+ 1;
6372 /* Should we include the `click' modifier? */
6373 if (! (modifiers
& (down_modifier
| drag_modifier
6374 | double_modifier
| triple_modifier
))
6375 && i
+ 7 == SBYTES (name
)
6376 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6377 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6378 modifiers
|= click_modifier
;
6386 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6387 prepended to the string BASE[0..BASE_LEN-1].
6388 This doesn't use any caches. */
6390 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6393 int base_len
, base_len_byte
;
6395 /* Since BASE could contain nulls, we can't use intern here; we have
6396 to use Fintern, which expects a genuine Lisp_String, and keeps a
6399 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6405 /* Only the event queue may use the `up' modifier; it should always
6406 be turned into a click or drag event before presented to lisp code. */
6407 if (modifiers
& up_modifier
)
6410 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6411 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6412 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6413 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6414 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6415 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6416 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6417 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6418 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6419 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6420 /* The click modifier is denoted by the absence of other modifiers. */
6424 mod_len
= p
- new_mods
;
6428 Lisp_Object new_name
;
6430 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6431 mod_len
+ base_len_byte
);
6432 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6433 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6435 return Fintern (new_name
, Qnil
);
6440 static char *modifier_names
[] =
6442 "up", "down", "drag", "click", "double", "triple", 0, 0,
6443 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6444 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6446 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6448 static Lisp_Object modifier_symbols
;
6450 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6452 lispy_modifier_list (modifiers
)
6455 Lisp_Object modifier_list
;
6458 modifier_list
= Qnil
;
6459 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6460 if (modifiers
& (1<<i
))
6461 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6464 return modifier_list
;
6468 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6469 where UNMODIFIED is the unmodified form of SYMBOL,
6470 MASK is the set of modifiers present in SYMBOL's name.
6471 This is similar to parse_modifiers_uncached, but uses the cache in
6472 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6473 Qevent_symbol_elements property. */
6475 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6478 parse_modifiers (symbol
)
6481 Lisp_Object elements
;
6483 if (INTEGERP (symbol
))
6484 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6485 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6487 else if (!SYMBOLP (symbol
))
6490 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6491 if (CONSP (elements
))
6496 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6497 Lisp_Object unmodified
;
6500 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6501 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6504 if (modifiers
& ~INTMASK
)
6506 XSETFASTINT (mask
, modifiers
);
6507 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6509 /* Cache the parsing results on SYMBOL. */
6510 Fput (symbol
, Qevent_symbol_element_mask
,
6512 Fput (symbol
, Qevent_symbol_elements
,
6513 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6515 /* Since we know that SYMBOL is modifiers applied to unmodified,
6516 it would be nice to put that in unmodified's cache.
6517 But we can't, since we're not sure that parse_modifiers is
6524 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6525 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6526 doc
: /* Parse the event symbol. For internal use. */)
6530 /* Fill the cache if needed. */
6531 parse_modifiers (symbol
);
6532 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6533 and use the Lispier representation stored on Qevent_symbol_elements
6535 return Fget (symbol
, Qevent_symbol_elements
);
6538 /* Apply the modifiers MODIFIERS to the symbol BASE.
6539 BASE must be unmodified.
6541 This is like apply_modifiers_uncached, but uses BASE's
6542 Qmodifier_cache property, if present. It also builds
6543 Qevent_symbol_elements properties, since it has that info anyway.
6545 apply_modifiers copies the value of BASE's Qevent_kind property to
6546 the modified symbol. */
6548 apply_modifiers (modifiers
, base
)
6552 Lisp_Object cache
, index
, entry
, new_symbol
;
6554 /* Mask out upper bits. We don't know where this value's been. */
6555 modifiers
&= INTMASK
;
6557 if (INTEGERP (base
))
6558 return make_number (XINT (base
) | modifiers
);
6560 /* The click modifier never figures into cache indices. */
6561 cache
= Fget (base
, Qmodifier_cache
);
6562 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6563 entry
= assq_no_quit (index
, cache
);
6566 new_symbol
= XCDR (entry
);
6569 /* We have to create the symbol ourselves. */
6570 new_symbol
= apply_modifiers_uncached (modifiers
,
6571 SDATA (SYMBOL_NAME (base
)),
6572 SCHARS (SYMBOL_NAME (base
)),
6573 SBYTES (SYMBOL_NAME (base
)));
6575 /* Add the new symbol to the base's cache. */
6576 entry
= Fcons (index
, new_symbol
);
6577 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6579 /* We have the parsing info now for free, so we could add it to
6581 XSETFASTINT (index, modifiers);
6582 Fput (new_symbol, Qevent_symbol_element_mask,
6583 Fcons (base, Fcons (index, Qnil)));
6584 Fput (new_symbol, Qevent_symbol_elements,
6585 Fcons (base, lispy_modifier_list (modifiers)));
6586 Sadly, this is only correct if `base' is indeed a base event,
6587 which is not necessarily the case. -stef */
6590 /* Make sure this symbol is of the same kind as BASE.
6592 You'd think we could just set this once and for all when we
6593 intern the symbol above, but reorder_modifiers may call us when
6594 BASE's property isn't set right; we can't assume that just
6595 because it has a Qmodifier_cache property it must have its
6596 Qevent_kind set right as well. */
6597 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6601 kind
= Fget (base
, Qevent_kind
);
6603 Fput (new_symbol
, Qevent_kind
, kind
);
6610 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6611 return a symbol with the modifiers placed in the canonical order.
6612 Canonical order is alphabetical, except for down and drag, which
6613 always come last. The 'click' modifier is never written out.
6615 Fdefine_key calls this to make sure that (for example) C-M-foo
6616 and M-C-foo end up being equivalent in the keymap. */
6619 reorder_modifiers (symbol
)
6622 /* It's hopefully okay to write the code this way, since everything
6623 will soon be in caches, and no consing will be done at all. */
6626 parsed
= parse_modifiers (symbol
);
6627 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6632 /* For handling events, we often want to produce a symbol whose name
6633 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6634 to some base, like the name of a function key or mouse button.
6635 modify_event_symbol produces symbols of this sort.
6637 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6638 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6641 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6642 into symbol names, or a string specifying a name stem used to
6643 construct a symbol name or the form `STEM-N', where N is the decimal
6644 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6645 non-nil; otherwise NAME_TABLE is used.
6647 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6648 persist between calls to modify_event_symbol that it can use to
6649 store a cache of the symbols it's generated for this NAME_TABLE
6650 before. The object stored there may be a vector or an alist.
6652 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6654 MODIFIERS is a set of modifier bits (as given in struct input_events)
6655 whose prefixes should be applied to the symbol name.
6657 SYMBOL_KIND is the value to be placed in the event_kind property of
6658 the returned symbol.
6660 The symbols we create are supposed to have an
6661 `event-symbol-elements' property, which lists the modifiers present
6662 in the symbol's name. */
6665 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6666 name_table
, symbol_table
, table_size
)
6669 Lisp_Object symbol_kind
;
6670 Lisp_Object name_alist_or_stem
;
6672 Lisp_Object
*symbol_table
;
6673 unsigned int table_size
;
6676 Lisp_Object symbol_int
;
6678 /* Get rid of the "vendor-specific" bit here. */
6679 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6681 /* Is this a request for a valid symbol? */
6682 if (symbol_num
< 0 || symbol_num
>= table_size
)
6685 if (CONSP (*symbol_table
))
6686 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6688 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6689 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6690 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6691 we've never used that symbol before. */
6694 if (! VECTORP (*symbol_table
)
6695 || XVECTOR (*symbol_table
)->size
!= table_size
)
6699 XSETFASTINT (size
, table_size
);
6700 *symbol_table
= Fmake_vector (size
, Qnil
);
6703 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6706 /* Have we already used this symbol before? */
6709 /* No; let's create it. */
6710 if (CONSP (name_alist_or_stem
))
6711 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6712 else if (STRINGP (name_alist_or_stem
))
6714 int len
= SBYTES (name_alist_or_stem
);
6715 char *buf
= (char *) alloca (len
+ 50);
6716 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6717 (long) XINT (symbol_int
) + 1);
6718 value
= intern (buf
);
6720 else if (name_table
!= 0 && name_table
[symbol_num
])
6721 value
= intern (name_table
[symbol_num
]);
6723 #ifdef HAVE_WINDOW_SYSTEM
6726 char *name
= x_get_keysym_name (symbol_num
);
6728 value
= intern (name
);
6735 sprintf (buf
, "key-%d", symbol_num
);
6736 value
= intern (buf
);
6739 if (CONSP (*symbol_table
))
6740 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6742 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6744 /* Fill in the cache entries for this symbol; this also
6745 builds the Qevent_symbol_elements property, which the user
6747 apply_modifiers (modifiers
& click_modifier
, value
);
6748 Fput (value
, Qevent_kind
, symbol_kind
);
6751 /* Apply modifiers to that symbol. */
6752 return apply_modifiers (modifiers
, value
);
6755 /* Convert a list that represents an event type,
6756 such as (ctrl meta backspace), into the usual representation of that
6757 event type as a number or a symbol. */
6759 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6760 doc
: /* Convert the event description list EVENT-DESC to an event type.
6761 EVENT-DESC should contain one base event type (a character or symbol)
6762 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6763 drag, down, double or triple). The base must be last.
6764 The return value is an event type (a character or symbol) which
6765 has the same base event type and all the specified modifiers. */)
6767 Lisp_Object event_desc
;
6775 while (CONSP (rest
))
6783 /* Given a symbol, see if it is a modifier name. */
6784 if (SYMBOLP (elt
) && CONSP (rest
))
6785 this = parse_solitary_modifier (elt
);
6789 else if (!NILP (base
))
6790 error ("Two bases given in one event");
6796 /* Let the symbol A refer to the character A. */
6797 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6798 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6800 if (INTEGERP (base
))
6802 /* Turn (shift a) into A. */
6803 if ((modifiers
& shift_modifier
) != 0
6804 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6806 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6807 modifiers
&= ~shift_modifier
;
6810 /* Turn (control a) into C-a. */
6811 if (modifiers
& ctrl_modifier
)
6812 return make_number ((modifiers
& ~ctrl_modifier
)
6813 | make_ctrl_char (XINT (base
)));
6815 return make_number (modifiers
| XINT (base
));
6817 else if (SYMBOLP (base
))
6818 return apply_modifiers (modifiers
, base
);
6821 error ("Invalid base event");
6826 /* Try to recognize SYMBOL as a modifier name.
6827 Return the modifier flag bit, or 0 if not recognized. */
6830 parse_solitary_modifier (Lisp_Object symbol
)
6832 Lisp_Object name
= SYMBOL_NAME (symbol
);
6834 switch (SREF (name
, 0))
6836 #define SINGLE_LETTER_MOD(BIT) \
6837 if (SBYTES (name) == 1) \
6840 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6841 if (LEN == SBYTES (name) \
6842 && ! strncmp (SDATA (name), NAME, LEN)) \
6846 SINGLE_LETTER_MOD (alt_modifier
);
6850 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6854 SINGLE_LETTER_MOD (ctrl_modifier
);
6858 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6859 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6863 SINGLE_LETTER_MOD (hyper_modifier
);
6867 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6871 SINGLE_LETTER_MOD (meta_modifier
);
6875 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6879 SINGLE_LETTER_MOD (shift_modifier
);
6883 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6884 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6885 SINGLE_LETTER_MOD (super_modifier
);
6889 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6890 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6891 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6895 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6898 #undef SINGLE_LETTER_MOD
6899 #undef MULTI_LETTER_MOD
6905 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6906 Such a list is not valid as an event,
6907 but it can be a Lucid-style event type list. */
6910 lucid_event_type_list_p (object
)
6915 if (! CONSP (object
))
6918 if (EQ (XCAR (object
), Qhelp_echo
)
6919 || EQ (XCAR (object
), Qvertical_line
)
6920 || EQ (XCAR (object
), Qmode_line
)
6921 || EQ (XCAR (object
), Qheader_line
))
6924 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6928 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6935 /* Store into *addr a value nonzero if terminal input chars are available.
6936 Serves the purpose of ioctl (0, FIONREAD, addr)
6937 but works even if FIONREAD does not exist.
6938 (In fact, this may actually read some input.)
6940 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6941 timer events that are ripe.
6942 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6943 events (FOCUS_IN_EVENT).
6944 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6945 movements and toolkit scroll bar thumb drags. */
6948 get_input_pending (addr
, flags
)
6952 /* First of all, have we already counted some input? */
6953 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6955 /* If input is being read as it arrives, and we have none, there is none. */
6956 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6959 /* Try to read some input and see how much we get. */
6961 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6964 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6967 gobble_input (expected
)
6971 /* Check whether a D-Bus message has arrived. */
6972 xd_read_queued_messages ();
6973 #endif /* HAVE_DBUS */
6977 if (interrupt_input
)
6980 mask
= sigblock (sigmask (SIGIO
));
6981 read_avail_input (expected
);
6985 #ifdef POLL_FOR_INPUT
6986 /* XXX This condition was (read_socket_hook && !interrupt_input),
6987 but read_socket_hook is not global anymore. Let's pretend that
6989 if (!interrupt_input
&& poll_suppress_count
== 0)
6992 mask
= sigblock (sigmask (SIGALRM
));
6993 read_avail_input (expected
);
6999 read_avail_input (expected
);
7003 /* Put a BUFFER_SWITCH_EVENT in the buffer
7004 so that read_key_sequence will notice the new current buffer. */
7007 record_asynch_buffer_change ()
7009 struct input_event event
;
7013 event
.kind
= BUFFER_SWITCH_EVENT
;
7014 event
.frame_or_window
= Qnil
;
7018 /* We don't need a buffer-switch event unless Emacs is waiting for input.
7019 The purpose of the event is to make read_key_sequence look up the
7020 keymaps again. If we aren't in read_key_sequence, we don't need one,
7021 and the event could cause trouble by messing up (input-pending-p). */
7022 tem
= Fwaiting_for_user_input_p ();
7026 /* We never need these events if we have no asynchronous subprocesses. */
7030 /* Make sure no interrupt happens while storing the event. */
7032 if (interrupt_input
)
7035 mask
= sigblock (sigmask (SIGIO
));
7036 kbd_buffer_store_event (&event
);
7043 kbd_buffer_store_event (&event
);
7050 /* Read any terminal input already buffered up by the system
7051 into the kbd_buffer, but do not wait.
7053 EXPECTED should be nonzero if the caller knows there is some input.
7055 Except on VMS, all input is read by this function.
7056 If interrupt_input is nonzero, this function MUST be called
7057 only when SIGIO is blocked.
7059 Returns the number of keyboard chars read, or -1 meaning
7060 this is a bad time to try to read input. */
7063 read_avail_input (expected
)
7070 /* Store pending user signal events, if any. */
7071 if (store_user_signal_events ())
7074 /* Loop through the available terminals, and call their input hooks. */
7078 struct terminal
*next
= t
->next_terminal
;
7080 if (t
->read_socket_hook
)
7083 struct input_event hold_quit
;
7085 EVENT_INIT (hold_quit
);
7086 hold_quit
.kind
= NO_EVENT
;
7088 /* No need for FIONREAD or fcntl; just say don't wait. */
7089 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
7095 if (nr
== -1) /* Not OK to read input now. */
7099 else if (nr
== -2) /* Non-transient error. */
7101 /* The terminal device terminated; it should be closed. */
7103 /* Kill Emacs if this was our last terminal. */
7104 if (!terminal_list
->next_terminal
)
7105 /* Formerly simply reported no input, but that
7106 sometimes led to a failure of Emacs to terminate.
7107 SIGHUP seems appropriate if we can't reach the
7109 /* ??? Is it really right to send the signal just to
7110 this process rather than to the whole process
7111 group? Perhaps on systems with FIONREAD Emacs is
7112 alone in its group. */
7113 kill (getpid (), SIGHUP
);
7115 /* XXX Is calling delete_terminal safe here? It calls Fdelete_frame. */
7118 XSETTERMINAL (tmp
, t
);
7119 Fdelete_terminal (tmp
, Qnoelisp
);
7123 if (hold_quit
.kind
!= NO_EVENT
)
7124 kbd_buffer_store_event (&hold_quit
);
7136 /* This is the tty way of reading available input.
7138 Note that each terminal device has its own `struct terminal' object,
7139 and so this function is called once for each individual termcap
7140 terminal. The first parameter indicates which terminal to read from. */
7143 tty_read_avail_input (struct terminal
*terminal
,
7145 struct input_event
*hold_quit
)
7147 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7148 the kbd_buffer can really hold. That may prevent loss
7149 of characters on some systems when input is stuffed at us. */
7150 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7152 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7155 if (!terminal
->name
) /* Don't read from a dead terminal. */
7158 if (terminal
->type
!= output_termcap
)
7161 /* XXX I think the following code should be moved to separate hook
7162 functions in system-dependent files. */
7165 #else /* not WINDOWSNT */
7167 n_to_read
= dos_keysns ();
7171 cbuf
[0] = dos_keyread ();
7174 #else /* not MSDOS */
7176 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7180 return 0; /* The terminal is suspended. */
7186 struct input_event hold_quit
;
7189 EVENT_INIT (hold_quit
);
7190 hold_quit
.kind
= NO_EVENT
;
7192 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7193 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7195 if (hold_quit
.kind
!= NO_EVENT
)
7196 kbd_buffer_store_event (&hold_quit
);
7200 #endif /* HAVE_GPM */
7202 /* Determine how many characters we should *try* to read. */
7204 /* Find out how much input is available. */
7205 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7207 if (! noninteractive
)
7208 return -2; /* Close this terminal. */
7214 if (n_to_read
> sizeof cbuf
)
7215 n_to_read
= sizeof cbuf
;
7216 #else /* no FIONREAD */
7217 #if defined (USG) || defined(CYGWIN)
7218 /* Read some input if available, but don't wait. */
7219 n_to_read
= sizeof cbuf
;
7220 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7226 /* Now read; for one reason or another, this will not block.
7227 NREAD is set to the number of chars read. */
7230 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7231 /* POSIX infers that processes which are not in the session leader's
7232 process group won't get SIGHUP's at logout time. BSDI adheres to
7233 this part standard and returns -1 from read (0) with errno==EIO
7234 when the control tty is taken away.
7235 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7236 if (nread
== -1 && errno
== EIO
)
7237 return -2; /* Close this terminal. */
7238 #if defined (AIX) && defined (_BSD)
7239 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7240 This looks incorrect, but it isn't, because _BSD causes
7241 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7242 and that causes a value other than 0 when there is no input. */
7244 return -2; /* Close this terminal. */
7248 /* We used to retry the read if it was interrupted.
7249 But this does the wrong thing when O_NDELAY causes
7250 an EAGAIN error. Does anybody know of a situation
7251 where a retry is actually needed? */
7253 nread
< 0 && (errno
== EAGAIN
7267 #if defined (USG) || defined (CYGWIN)
7268 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7269 #endif /* USG or CYGWIN */
7270 #endif /* no FIONREAD */
7275 #endif /* not MSDOS */
7276 #endif /* not WINDOWSNT */
7278 for (i
= 0; i
< nread
; i
++)
7280 struct input_event buf
;
7282 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7284 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7285 buf
.modifiers
= meta_modifier
;
7286 if (tty
->meta_key
!= 2)
7290 /* Set the frame corresponding to the active tty. Note that the
7291 value of selected_frame is not reliable here, redisplay tends
7292 to temporarily change it. */
7293 buf
.frame_or_window
= tty
->top_frame
;
7296 kbd_buffer_store_event (&buf
);
7297 /* Don't look at input that follows a C-g too closely.
7298 This reduces lossage due to autorepeat on C-g. */
7299 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7300 && buf
.code
== quit_char
)
7306 #endif /* not VMS */
7309 handle_async_input ()
7311 interrupt_input_pending
= 0;
7316 nread
= read_avail_input (1);
7317 /* -1 means it's not ok to read the input now.
7318 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7319 0 means there was no keyboard input available. */
7325 #ifdef SIGIO /* for entire page */
7326 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7329 input_available_signal (signo
)
7332 /* Must preserve main program's value of errno. */
7333 int old_errno
= errno
;
7334 #if defined (USG) && !defined (POSIX_SIGNALS)
7335 /* USG systems forget handlers when they are used;
7336 must reestablish each time */
7337 signal (signo
, input_available_signal
);
7341 interrupt_input_pending
= 1;
7343 SIGNAL_THREAD_CHECK (signo
);
7346 if (input_available_clear_time
)
7347 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7350 handle_async_input ();
7357 /* Send ourselves a SIGIO.
7359 This function exists so that the UNBLOCK_INPUT macro in
7360 blockinput.h can have some way to take care of input we put off
7361 dealing with, without assuming that every file which uses
7362 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7364 reinvoke_input_signal ()
7367 handle_async_input ();
7373 /* User signal events. */
7375 struct user_signal_info
7377 /* Signal number. */
7380 /* Name of the signal. */
7383 /* Number of pending signals. */
7386 struct user_signal_info
*next
;
7389 /* List of user signals. */
7390 static struct user_signal_info
*user_signals
= NULL
;
7393 add_user_signal (sig
, name
)
7397 struct user_signal_info
*p
;
7399 for (p
= user_signals
; p
; p
= p
->next
)
7401 /* Already added. */
7404 p
= xmalloc (sizeof (struct user_signal_info
));
7406 p
->name
= xstrdup (name
);
7408 p
->next
= user_signals
;
7411 signal (sig
, handle_user_signal
);
7415 handle_user_signal (sig
)
7418 int old_errno
= errno
;
7419 struct user_signal_info
*p
;
7421 #if defined (USG) && !defined (POSIX_SIGNALS)
7422 /* USG systems forget handlers when they are used;
7423 must reestablish each time */
7424 signal (sig
, handle_user_signal
);
7427 SIGNAL_THREAD_CHECK (sig
);
7429 for (p
= user_signals
; p
; p
= p
->next
)
7434 if (interrupt_input
)
7435 kill (getpid (), SIGIO
);
7439 /* Tell wait_reading_process_output that it needs to wake
7440 up and look around. */
7441 if (input_available_clear_time
)
7442 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7451 find_user_signal_name (sig
)
7454 struct user_signal_info
*p
;
7456 for (p
= user_signals
; p
; p
= p
->next
)
7464 store_user_signal_events ()
7466 struct user_signal_info
*p
;
7467 struct input_event buf
;
7470 for (p
= user_signals
; p
; p
= p
->next
)
7471 if (p
->npending
> 0)
7477 bzero (&buf
, sizeof buf
);
7478 buf
.kind
= USER_SIGNAL_EVENT
;
7479 buf
.frame_or_window
= selected_frame
;
7481 nstored
+= p
->npending
;
7483 mask
= sigblock (sigmask (p
->sig
));
7487 kbd_buffer_store_event (&buf
);
7490 while (p
->npending
> 0);
7498 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7499 static Lisp_Object menu_bar_one_keymap_changed_items
;
7501 /* These variables hold the vector under construction within
7502 menu_bar_items and its subroutines, and the current index
7503 for storing into that vector. */
7504 static Lisp_Object menu_bar_items_vector
;
7505 static int menu_bar_items_index
;
7507 /* Return a vector of menu items for a menu bar, appropriate
7508 to the current buffer. Each item has three elements in the vector:
7511 OLD is an old vector we can optionally reuse, or nil. */
7514 menu_bar_items (old
)
7517 /* The number of keymaps we're scanning right now, and the number of
7518 keymaps we have allocated space for. */
7521 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7522 in the current keymaps, or nil where it is not a prefix. */
7525 Lisp_Object def
, tail
;
7534 /* In order to build the menus, we need to call the keymap
7535 accessors. They all call QUIT. But this function is called
7536 during redisplay, during which a quit is fatal. So inhibit
7537 quitting while building the menus.
7538 We do this instead of specbind because (1) errors will clear it anyway
7539 and (2) this avoids risk of specpdl overflow. */
7540 oquit
= Vinhibit_quit
;
7544 menu_bar_items_vector
= old
;
7546 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7547 menu_bar_items_index
= 0;
7549 /* Build our list of keymaps.
7550 If we recognize a function key and replace its escape sequence in
7551 keybuf with its symbol, or if the sequence starts with a mouse
7552 click and we need to switch buffers, we jump back here to rebuild
7553 the initial keymaps from the current buffer. */
7557 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7558 if (!NILP (Voverriding_local_map_menu_flag
))
7560 /* Yes, use them (if non-nil) as well as the global map. */
7561 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7563 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7564 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7565 if (!NILP (Voverriding_local_map
))
7566 maps
[nmaps
++] = Voverriding_local_map
;
7570 /* No, so use major and minor mode keymaps and keymap property.
7571 Note that menu-bar bindings in the local-map and keymap
7572 properties may not work reliable, as they are only
7573 recognized when the menu-bar (or mode-line) is updated,
7574 which does not normally happen after every command. */
7577 nminor
= current_minor_maps (NULL
, &tmaps
);
7578 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7580 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7581 maps
[nmaps
++] = tem
;
7582 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7584 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7586 maps
[nmaps
++] = current_global_map
;
7589 /* Look up in each map the dummy prefix key `menu-bar'. */
7593 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7594 if (!NILP (maps
[mapno
]))
7596 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7600 menu_bar_one_keymap_changed_items
= Qnil
;
7601 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7605 /* Move to the end those items that should be at the end. */
7607 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7610 int end
= menu_bar_items_index
;
7612 for (i
= 0; i
< end
; i
+= 4)
7613 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7615 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7616 /* Move the item at index I to the end,
7617 shifting all the others forward. */
7618 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7619 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7620 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7621 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7623 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7624 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7625 (end
- i
- 4) * sizeof (Lisp_Object
));
7626 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7627 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7628 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7629 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7634 /* Add nil, nil, nil, nil at the end. */
7635 i
= menu_bar_items_index
;
7636 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7637 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7638 /* Add this item. */
7639 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7640 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7641 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7642 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7643 menu_bar_items_index
= i
;
7645 Vinhibit_quit
= oquit
;
7646 return menu_bar_items_vector
;
7649 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7650 If there's already an item for KEY, add this DEF to it. */
7652 Lisp_Object item_properties
;
7655 menu_bar_item (key
, item
, dummy1
, dummy2
)
7656 Lisp_Object key
, item
, dummy1
;
7659 struct gcpro gcpro1
;
7663 if (EQ (item
, Qundefined
))
7665 /* If a map has an explicit `undefined' as definition,
7666 discard any previously made menu bar item. */
7668 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7669 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7671 if (menu_bar_items_index
> i
+ 4)
7672 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7673 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7674 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7675 menu_bar_items_index
-= 4;
7679 /* If this keymap has already contributed to this KEY,
7680 don't contribute to it a second time. */
7681 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7682 if (!NILP (tem
) || NILP (item
))
7685 menu_bar_one_keymap_changed_items
7686 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7688 /* We add to menu_bar_one_keymap_changed_items before doing the
7689 parse_menu_item, so that if it turns out it wasn't a menu item,
7690 it still correctly hides any further menu item. */
7692 i
= parse_menu_item (item
, 0, 1);
7697 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7699 /* Find any existing item for this KEY. */
7700 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7701 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7704 /* If we did not find this KEY, add it at the end. */
7705 if (i
== menu_bar_items_index
)
7707 /* If vector is too small, get a bigger one. */
7708 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7709 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7710 /* Add this item. */
7711 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7712 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7713 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7714 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7715 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7716 menu_bar_items_index
= i
;
7718 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7722 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7723 /* If the new and the old items are not both keymaps,
7724 the lookup will only find `item'. */
7725 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7726 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7730 /* This is used as the handler when calling menu_item_eval_property. */
7732 menu_item_eval_property_1 (arg
)
7735 /* If we got a quit from within the menu computation,
7736 quit all the way out of it. This takes care of C-] in the debugger. */
7737 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7738 Fsignal (Qquit
, Qnil
);
7743 /* Evaluate an expression and return the result (or nil if something
7744 went wrong). Used to evaluate dynamic parts of menu items. */
7746 menu_item_eval_property (sexpr
)
7749 int count
= SPECPDL_INDEX ();
7751 specbind (Qinhibit_redisplay
, Qt
);
7752 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7753 menu_item_eval_property_1
);
7754 return unbind_to (count
, val
);
7757 /* This function parses a menu item and leaves the result in the
7758 vector item_properties.
7759 ITEM is a key binding, a possible menu item.
7760 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7761 evaluate dynamic expressions in the menu item.
7762 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7764 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7765 parse_menu_item returns true if the item is a menu item and false
7769 parse_menu_item (item
, notreal
, inmenubar
)
7771 int notreal
, inmenubar
;
7773 Lisp_Object def
, tem
, item_string
, start
;
7774 Lisp_Object cachelist
;
7776 Lisp_Object keyhint
;
7787 /* Create item_properties vector if necessary. */
7788 if (NILP (item_properties
))
7790 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7792 /* Initialize optional entries. */
7793 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7794 ASET (item_properties
, i
, Qnil
);
7795 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7797 /* Save the item here to protect it from GC. */
7798 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7800 item_string
= XCAR (item
);
7804 if (STRINGP (item_string
))
7806 /* Old format menu item. */
7807 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7809 /* Maybe help string. */
7810 if (CONSP (item
) && STRINGP (XCAR (item
)))
7812 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7817 /* Maybe key binding cache. */
7818 if (CONSP (item
) && CONSP (XCAR (item
))
7819 && (NILP (XCAR (XCAR (item
)))
7820 || VECTORP (XCAR (XCAR (item
)))))
7822 cachelist
= XCAR (item
);
7826 /* This is the real definition--the function to run. */
7827 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7829 /* Get enable property, if any. */
7832 tem
= Fget (item
, Qmenu_enable
);
7833 if (!NILP (Venable_disabled_menus_and_buttons
))
7834 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7835 else if (!NILP (tem
))
7836 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7839 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7841 /* New format menu item. */
7842 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7843 start
= XCDR (item
);
7846 /* We have a real binding. */
7847 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7849 item
= XCDR (start
);
7850 /* Is there a cache list with key equivalences. */
7851 if (CONSP (item
) && CONSP (XCAR (item
)))
7853 cachelist
= XCAR (item
);
7857 /* Parse properties. */
7858 while (CONSP (item
) && CONSP (XCDR (item
)))
7863 if (EQ (tem
, QCenable
))
7865 if (!NILP (Venable_disabled_menus_and_buttons
))
7866 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7868 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7870 else if (EQ (tem
, QCvisible
) && !notreal
)
7872 /* If got a visible property and that evaluates to nil
7873 then ignore this item. */
7874 tem
= menu_item_eval_property (XCAR (item
));
7878 else if (EQ (tem
, QChelp
))
7879 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7880 else if (EQ (tem
, QCfilter
))
7882 else if (EQ (tem
, QCkey_sequence
))
7885 if (NILP (cachelist
)
7886 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7887 /* Be GC protected. Set keyhint to item instead of tem. */
7890 else if (EQ (tem
, QCkeys
))
7893 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7894 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7896 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7901 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7903 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7905 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7911 else if (inmenubar
|| !NILP (start
))
7915 return 0; /* not a menu item */
7917 /* If item string is not a string, evaluate it to get string.
7918 If we don't get a string, skip this item. */
7919 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7920 if (!(STRINGP (item_string
) || notreal
))
7922 item_string
= menu_item_eval_property (item_string
);
7923 if (!STRINGP (item_string
))
7925 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7928 /* If got a filter apply it on definition. */
7929 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7932 def
= menu_item_eval_property (list2 (XCAR (filter
),
7933 list2 (Qquote
, def
)));
7935 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7938 /* Enable or disable selection of item. */
7939 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7945 tem
= menu_item_eval_property (tem
);
7946 if (inmenubar
&& NILP (tem
))
7947 return 0; /* Ignore disabled items in menu bar. */
7948 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7951 /* If we got no definition, this item is just unselectable text which
7952 is OK in a submenu but not in the menubar. */
7954 return (inmenubar
? 0 : 1);
7956 /* See if this is a separate pane or a submenu. */
7957 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7958 tem
= get_keymap (def
, 0, 1);
7959 /* For a subkeymap, just record its details and exit. */
7962 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7963 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7967 /* At the top level in the menu bar, do likewise for commands also.
7968 The menu bar does not display equivalent key bindings anyway.
7969 ITEM_PROPERTY_DEF is already set up properly. */
7973 /* This is a command. See if there is an equivalent key binding. */
7974 if (NILP (cachelist
))
7976 /* We have to create a cachelist. */
7977 /* With the introduction of where_is_cache, the computation
7978 of equivalent key bindings is sufficiently fast that we
7979 do not need to cache it here any more. */
7980 /* CHECK_IMPURE (start);
7981 XSETCDR (start, Fcons (Fcons (Qnil, Qnil), XCDR (start)));
7982 cachelist = XCAR (XCDR (start)); */
7983 cachelist
= Fcons (Qnil
, Qnil
);
7985 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7986 if (!NILP (keyhint
))
7988 XSETCAR (cachelist
, XCAR (keyhint
));
7991 else if (STRINGP (tem
))
7993 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7994 XSETCAR (cachelist
, Qt
);
7998 tem
= XCAR (cachelist
);
8005 tem
= Fkey_binding (tem
, Qnil
, Qnil
, Qnil
);
8007 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
8010 def
= XCAR (prefix
);
8011 prefix
= XCDR (prefix
);
8014 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8016 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
8018 if (newcache
/* Always check first time. */
8019 /* Should we check everything when precomputing key
8021 /* If something had no key binding before, don't recheck it
8022 because that is too slow--except if we have a list of
8023 rebound commands in Vdefine_key_rebound_commands, do
8024 recheck any command that appears in that list. */
8025 || (CONSP (Vdefine_key_rebound_commands
)
8026 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
8029 /* We had a saved key. Is it still bound to the command? */
8032 /* If the command is an alias for another
8033 (such as lmenu.el set it up), check if the
8034 original command matches the cached command. */
8035 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
8036 chkcache
= 1; /* Need to recompute key binding. */
8040 /* Recompute equivalent key binding. If the command is an alias
8041 for another (such as lmenu.el set it up), see if the original
8042 command name has equivalent keys. Otherwise look up the
8043 specified command itself. We don't try both, because that
8044 makes lmenu menus slow. */
8046 && SYMBOLP (XSYMBOL (def
)->function
)
8047 && ! NILP (Fget (def
, Qmenu_alias
)))
8048 def
= XSYMBOL (def
)->function
;
8049 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
8050 XSETCAR (cachelist
, tem
);
8053 XSETCDR (cachelist
, Qnil
);
8057 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
8059 tem
= XCAR (cachelist
);
8063 newcache
= chkcache
;
8066 tem
= Fkey_description (tem
, Qnil
);
8069 if (STRINGP (XCAR (prefix
)))
8070 tem
= concat2 (XCAR (prefix
), tem
);
8071 if (STRINGP (XCDR (prefix
)))
8072 tem
= concat2 (tem
, XCDR (prefix
));
8074 XSETCDR (cachelist
, tem
);
8078 tem
= XCDR (cachelist
);
8079 if (newcache
&& !NILP (tem
))
8081 tem
= concat2 (build_string (" "), tem
);
8082 /* tem = concat3 (build_string (" ("), tem, build_string (")")); */
8083 XSETCDR (cachelist
, tem
);
8086 /* If we only want to precompute equivalent key bindings, stop here. */
8090 /* If we have an equivalent key binding, use that. */
8091 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
8093 /* Include this when menu help is implemented.
8094 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
8095 if (!(NILP (tem) || STRINGP (tem)))
8097 tem = menu_item_eval_property (tem);
8100 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8104 /* Handle radio buttons or toggle boxes. */
8105 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8107 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8108 menu_item_eval_property (tem
));
8115 /***********************************************************************
8117 ***********************************************************************/
8119 /* A vector holding tool bar items while they are parsed in function
8120 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8123 static Lisp_Object tool_bar_items_vector
;
8125 /* A vector holding the result of parse_tool_bar_item. Layout is like
8126 the one for a single item in tool_bar_items_vector. */
8128 static Lisp_Object tool_bar_item_properties
;
8130 /* Next free index in tool_bar_items_vector. */
8132 static int ntool_bar_items
;
8134 /* The symbols `tool-bar', `:image' and `:rtl'. */
8136 extern Lisp_Object Qtool_bar
;
8137 Lisp_Object QCimage
;
8140 /* Function prototypes. */
8142 static void init_tool_bar_items
P_ ((Lisp_Object
));
8143 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
8144 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
8145 static void append_tool_bar_item
P_ ((void));
8148 /* Return a vector of tool bar items for keymaps currently in effect.
8149 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8150 tool bar items found. */
8153 tool_bar_items (reuse
, nitems
)
8164 /* In order to build the menus, we need to call the keymap
8165 accessors. They all call QUIT. But this function is called
8166 during redisplay, during which a quit is fatal. So inhibit
8167 quitting while building the menus. We do this instead of
8168 specbind because (1) errors will clear it anyway and (2) this
8169 avoids risk of specpdl overflow. */
8170 oquit
= Vinhibit_quit
;
8173 /* Initialize tool_bar_items_vector and protect it from GC. */
8174 init_tool_bar_items (reuse
);
8176 /* Build list of keymaps in maps. Set nmaps to the number of maps
8179 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8180 if (!NILP (Voverriding_local_map_menu_flag
))
8182 /* Yes, use them (if non-nil) as well as the global map. */
8183 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8185 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8186 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8187 if (!NILP (Voverriding_local_map
))
8188 maps
[nmaps
++] = Voverriding_local_map
;
8192 /* No, so use major and minor mode keymaps and keymap property.
8193 Note that tool-bar bindings in the local-map and keymap
8194 properties may not work reliable, as they are only
8195 recognized when the tool-bar (or mode-line) is updated,
8196 which does not normally happen after every command. */
8199 nminor
= current_minor_maps (NULL
, &tmaps
);
8200 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8202 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8203 maps
[nmaps
++] = tem
;
8204 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
8206 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8209 /* Add global keymap at the end. */
8210 maps
[nmaps
++] = current_global_map
;
8212 /* Process maps in reverse order and look up in each map the prefix
8214 for (i
= nmaps
- 1; i
>= 0; --i
)
8215 if (!NILP (maps
[i
]))
8219 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8221 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8224 Vinhibit_quit
= oquit
;
8225 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8226 return tool_bar_items_vector
;
8230 /* Process the definition of KEY which is DEF. */
8233 process_tool_bar_item (key
, def
, data
, args
)
8234 Lisp_Object key
, def
, data
;
8238 extern Lisp_Object Qundefined
;
8239 struct gcpro gcpro1
, gcpro2
;
8241 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8245 if (EQ (def
, Qundefined
))
8247 /* If a map has an explicit `undefined' as definition,
8248 discard any previously made item. */
8249 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8251 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8253 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8255 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8256 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
8257 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8258 * sizeof (Lisp_Object
)));
8259 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8264 else if (parse_tool_bar_item (key
, def
))
8265 /* Append a new tool bar item to tool_bar_items_vector. Accept
8266 more than one definition for the same key. */
8267 append_tool_bar_item ();
8273 /* Parse a tool bar item specification ITEM for key KEY and return the
8274 result in tool_bar_item_properties. Value is zero if ITEM is
8277 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8279 CAPTION is the caption of the item, If it's not a string, it is
8280 evaluated to get a string.
8282 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8283 as binding are currently ignored.
8285 The following properties are recognized:
8289 FORM is evaluated and specifies whether the tool bar item is
8290 enabled or disabled.
8294 FORM is evaluated and specifies whether the tool bar item is visible.
8296 - `:filter FUNCTION'
8298 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8299 result is stored as the new binding.
8301 - `:button (TYPE SELECTED)'
8303 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8304 and specifies whether the button is selected (pressed) or not.
8308 IMAGES is either a single image specification or a vector of four
8309 image specifications. See enum tool_bar_item_images.
8311 - `:help HELP-STRING'.
8313 Gives a help string to display for the tool bar item. */
8316 parse_tool_bar_item (key
, item
)
8317 Lisp_Object key
, item
;
8319 /* Access slot with index IDX of vector tool_bar_item_properties. */
8320 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8322 Lisp_Object filter
= Qnil
;
8323 Lisp_Object caption
;
8326 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8327 Rule out items that aren't lists, don't start with
8328 `menu-item' or whose rest following `tool-bar-item' is not a
8331 || !EQ (XCAR (item
), Qmenu_item
)
8332 || (item
= XCDR (item
),
8336 /* Create tool_bar_item_properties vector if necessary. Reset it to
8338 if (VECTORP (tool_bar_item_properties
))
8340 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8344 tool_bar_item_properties
8345 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8348 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8349 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8351 /* Get the caption of the item. If the caption is not a string,
8352 evaluate it to get a string. If we don't get a string, skip this
8354 caption
= XCAR (item
);
8355 if (!STRINGP (caption
))
8357 caption
= menu_item_eval_property (caption
);
8358 if (!STRINGP (caption
))
8361 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8363 /* Give up if rest following the caption is not a list. */
8368 /* Store the binding. */
8369 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8372 /* Ignore cached key binding, if any. */
8373 if (CONSP (item
) && CONSP (XCAR (item
)))
8376 /* Process the rest of the properties. */
8377 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8379 Lisp_Object key
, value
;
8382 value
= XCAR (XCDR (item
));
8384 if (EQ (key
, QCenable
))
8386 /* `:enable FORM'. */
8387 if (!NILP (Venable_disabled_menus_and_buttons
))
8388 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8390 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8392 else if (EQ (key
, QCvisible
))
8394 /* `:visible FORM'. If got a visible property and that
8395 evaluates to nil then ignore this item. */
8396 if (NILP (menu_item_eval_property (value
)))
8399 else if (EQ (key
, QChelp
))
8400 /* `:help HELP-STRING'. */
8401 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8402 else if (EQ (key
, QCfilter
))
8403 /* ':filter FORM'. */
8405 else if (EQ (key
, QCbutton
) && CONSP (value
))
8407 /* `:button (TYPE . SELECTED)'. */
8408 Lisp_Object type
, selected
;
8410 type
= XCAR (value
);
8411 selected
= XCDR (value
);
8412 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8414 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8415 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8418 else if (EQ (key
, QCimage
)
8420 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8421 /* Value is either a single image specification or a vector
8422 of 4 such specifications for the different button states. */
8423 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8424 else if (EQ (key
, Qrtl
))
8426 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8429 /* If got a filter apply it on binding. */
8431 PROP (TOOL_BAR_ITEM_BINDING
)
8432 = menu_item_eval_property (list2 (filter
,
8434 PROP (TOOL_BAR_ITEM_BINDING
))));
8436 /* See if the binding is a keymap. Give up if it is. */
8437 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8440 /* Enable or disable selection of item. */
8441 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8442 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8443 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8445 /* Handle radio buttons or toggle boxes. */
8446 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8447 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8448 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8456 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8457 that can be reused. */
8460 init_tool_bar_items (reuse
)
8463 if (VECTORP (reuse
))
8464 tool_bar_items_vector
= reuse
;
8466 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8467 ntool_bar_items
= 0;
8471 /* Append parsed tool bar item properties from
8472 tool_bar_item_properties */
8475 append_tool_bar_item ()
8477 Lisp_Object
*to
, *from
;
8479 /* Enlarge tool_bar_items_vector if necessary. */
8480 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8481 >= XVECTOR (tool_bar_items_vector
)->size
)
8482 tool_bar_items_vector
8483 = larger_vector (tool_bar_items_vector
,
8484 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8486 /* Append entries from tool_bar_item_properties to the end of
8487 tool_bar_items_vector. */
8488 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8489 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8490 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8491 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8498 /* Read a character using menus based on maps in the array MAPS.
8499 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8500 Return t if we displayed a menu but the user rejected it.
8502 PREV_EVENT is the previous input event, or nil if we are reading
8503 the first event of a key sequence.
8505 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8506 if we used a mouse menu to read the input, or zero otherwise. If
8507 USED_MOUSE_MENU is null, we don't dereference it.
8509 The prompting is done based on the prompt-string of the map
8510 and the strings associated with various map elements.
8512 This can be done with X menus or with menus put in the minibuf.
8513 These are done in different ways, depending on how the input will be read.
8514 Menus using X are done after auto-saving in read-char, getting the input
8515 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8516 and do auto-saving in the inner call of read_char. */
8519 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8522 Lisp_Object prev_event
;
8523 int *used_mouse_menu
;
8526 register Lisp_Object name
= Qnil
;
8528 if (used_mouse_menu
)
8529 *used_mouse_menu
= 0;
8531 /* Use local over global Menu maps */
8533 if (! menu_prompting
)
8536 /* Optionally disregard all but the global map. */
8537 if (inhibit_local_menu_bar_menus
)
8539 maps
+= (nmaps
- 1);
8543 /* Get the menu name from the first map that has one (a prompt string). */
8544 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8546 name
= Fkeymap_prompt (maps
[mapno
]);
8551 /* If we don't have any menus, just read a character normally. */
8552 if (!STRINGP (name
))
8556 /* If we got to this point via a mouse click,
8557 use a real menu for mouse selection. */
8558 if (EVENT_HAS_PARAMETERS (prev_event
)
8559 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8560 && !EQ (XCAR (prev_event
), Qtool_bar
))
8562 /* Display the menu and get the selection. */
8563 Lisp_Object
*realmaps
8564 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8568 /* Use the maps that are not nil. */
8569 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8570 if (!NILP (maps
[mapno
]))
8571 realmaps
[nmaps1
++] = maps
[mapno
];
8573 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8578 record_menu_key (XCAR (value
));
8580 /* If we got multiple events, unread all but
8582 There is no way to prevent those unread events
8583 from showing up later in last_nonmenu_event.
8584 So turn symbol and integer events into lists,
8585 to indicate that they came from a mouse menu,
8586 so that when present in last_nonmenu_event
8587 they won't confuse things. */
8588 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8590 record_menu_key (XCAR (tem
));
8591 if (SYMBOLP (XCAR (tem
))
8592 || INTEGERP (XCAR (tem
)))
8593 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8596 /* If we got more than one event, put all but the first
8597 onto this list to be read later.
8598 Return just the first event now. */
8599 Vunread_command_events
8600 = nconc2 (XCDR (value
), Vunread_command_events
);
8601 value
= XCAR (value
);
8603 else if (NILP (value
))
8605 if (used_mouse_menu
)
8606 *used_mouse_menu
= 1;
8609 #endif /* HAVE_MENUS */
8613 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8614 We make this bigger when necessary, and never free it. */
8615 static char *read_char_minibuf_menu_text
;
8616 /* Size of that buffer. */
8617 static int read_char_minibuf_menu_width
;
8620 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8626 register Lisp_Object name
;
8628 /* FIXME: Use the minibuffer's frame width. */
8629 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8632 Lisp_Object rest
, vector
;
8638 if (! menu_prompting
)
8641 /* Make sure we have a big enough buffer for the menu text. */
8642 if (read_char_minibuf_menu_text
== 0)
8644 read_char_minibuf_menu_width
= width
+ 4;
8645 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8647 else if (width
+ 4 > read_char_minibuf_menu_width
)
8649 read_char_minibuf_menu_width
= width
+ 4;
8650 read_char_minibuf_menu_text
8651 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8653 menu
= read_char_minibuf_menu_text
;
8655 /* Get the menu name from the first map that has one (a prompt string). */
8656 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8658 name
= Fkeymap_prompt (maps
[mapno
]);
8663 /* If we don't have any menus, just read a character normally. */
8664 if (!STRINGP (name
))
8667 /* Prompt string always starts with map's prompt, and a space. */
8668 strcpy (menu
, SDATA (name
));
8669 nlength
= SBYTES (name
);
8670 menu
[nlength
++] = ':';
8671 menu
[nlength
++] = ' ';
8674 /* Start prompting at start of first map. */
8678 /* Present the documented bindings, a line at a time. */
8685 Lisp_Object orig_defn_macro
;
8687 /* Loop over elements of map. */
8692 /* If reached end of map, start at beginning of next map. */
8696 /* At end of last map, wrap around to first map if just starting,
8697 or end this line if already have something on it. */
8701 if (notfirst
|| nobindings
) break;
8706 /* Look at the next element of the map. */
8708 elt
= XVECTOR (vector
)->contents
[idx
];
8710 elt
= Fcar_safe (rest
);
8712 if (idx
< 0 && VECTORP (elt
))
8714 /* If we found a dense table in the keymap,
8715 advanced past it, but start scanning its contents. */
8716 rest
= Fcdr_safe (rest
);
8722 /* An ordinary element. */
8723 Lisp_Object event
, tem
;
8727 event
= Fcar_safe (elt
); /* alist */
8728 elt
= Fcdr_safe (elt
);
8732 XSETINT (event
, idx
); /* vector */
8735 /* Ignore the element if it has no prompt string. */
8736 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8738 /* 1 if the char to type matches the string. */
8740 Lisp_Object upcased_event
, downcased_event
;
8741 Lisp_Object desc
= Qnil
;
8743 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8745 upcased_event
= Fupcase (event
);
8746 downcased_event
= Fdowncase (event
);
8747 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8748 || XINT (downcased_event
) == SREF (s
, 0));
8750 desc
= Fsingle_key_description (event
, Qnil
);
8752 #if 0 /* It is redundant to list the equivalent key bindings because
8753 the prefix is what the user has already typed. */
8755 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8757 /* Insert equivalent keybinding. */
8758 s
= concat2 (s
, tem
);
8761 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8762 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8764 /* Insert button prefix. */
8765 Lisp_Object selected
8766 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8767 if (EQ (tem
, QCradio
))
8768 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8770 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8771 s
= concat2 (tem
, s
);
8775 /* If we have room for the prompt string, add it to this line.
8776 If this is the first on the line, always add it. */
8777 if ((SCHARS (s
) + i
+ 2
8778 + (char_matches
? 0 : SCHARS (desc
) + 3))
8784 /* Punctuate between strings. */
8787 strcpy (menu
+ i
, ", ");
8793 /* If the char to type doesn't match the string's
8794 first char, explicitly show what char to type. */
8797 /* Add as much of string as fits. */
8798 thiswidth
= SCHARS (desc
);
8799 if (thiswidth
+ i
> width
)
8800 thiswidth
= width
- i
;
8801 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8803 strcpy (menu
+ i
, " = ");
8807 /* Add as much of string as fits. */
8808 thiswidth
= SCHARS (s
);
8809 if (thiswidth
+ i
> width
)
8810 thiswidth
= width
- i
;
8811 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8817 /* If this element does not fit, end the line now,
8818 and save the element for the next line. */
8819 strcpy (menu
+ i
, "...");
8824 /* Move past this element. */
8825 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8826 /* Handle reaching end of dense table. */
8831 rest
= Fcdr_safe (rest
);
8835 /* Prompt with that and read response. */
8836 message2_nolog (menu
, strlen (menu
),
8837 ! NILP (current_buffer
->enable_multibyte_characters
));
8839 /* Make believe its not a keyboard macro in case the help char
8840 is pressed. Help characters are not recorded because menu prompting
8841 is not used on replay.
8843 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8844 current_kboard
->defining_kbd_macro
= Qnil
;
8846 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8847 while (BUFFERP (obj
));
8848 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8850 if (!INTEGERP (obj
))
8852 else if (XINT (obj
) == -2)
8857 if (! EQ (obj
, menu_prompt_more_char
)
8858 && (!INTEGERP (menu_prompt_more_char
)
8859 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8861 if (!NILP (current_kboard
->defining_kbd_macro
))
8862 store_kbd_macro_char (obj
);
8865 /* Help char - go round again */
8869 /* Reading key sequences. */
8871 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8872 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8873 keymap, or nil otherwise. Return the index of the first keymap in
8874 which KEY has any binding, or NMAPS if no map has a binding.
8876 If KEY is a meta ASCII character, treat it like meta-prefix-char
8877 followed by the corresponding non-meta character. Keymaps in
8878 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8881 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8884 NEXT may be the same array as CURRENT. */
8887 follow_key (key
, nmaps
, current
, defs
, next
)
8889 Lisp_Object
*current
, *defs
, *next
;
8892 int i
, first_binding
;
8894 first_binding
= nmaps
;
8895 for (i
= nmaps
- 1; i
>= 0; i
--)
8897 if (! NILP (current
[i
]))
8899 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8900 if (! NILP (defs
[i
]))
8907 /* Given the set of bindings we've found, produce the next set of maps. */
8908 if (first_binding
< nmaps
)
8909 for (i
= 0; i
< nmaps
; i
++)
8910 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8912 return first_binding
;
8915 /* Structure used to keep track of partial application of key remapping
8916 such as Vfunction_key_map and Vkey_translation_map. */
8917 typedef struct keyremap
8919 /* This is the map originally specified for this use. */
8921 /* This is a submap reached by looking up, in PARENT,
8922 the events from START to END. */
8924 /* Positions [START, END) in the key sequence buffer
8925 are the key that we have scanned so far.
8926 Those events are the ones that we will replace
8927 if PAREHT maps them into a key sequence. */
8931 /* Lookup KEY in MAP.
8932 MAP is a keymap mapping keys to key vectors or functions.
8933 If the mapping is a function and DO_FUNCTION is non-zero, then
8934 the function is called with PROMPT as parameter and its return
8935 value is used as the return value of this function (after checking
8936 that it is indeed a vector). */
8939 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8940 Lisp_Object map
, key
, prompt
;
8945 next
= access_keymap (map
, key
, 1, 0, 1);
8947 /* Handle symbol with autoload definition. */
8948 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8949 && CONSP (XSYMBOL (next
)->function
)
8950 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8951 do_autoload (XSYMBOL (next
)->function
, next
);
8953 /* Handle a symbol whose function definition is a keymap
8955 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8956 && (ARRAYP (XSYMBOL (next
)->function
)
8957 || KEYMAPP (XSYMBOL (next
)->function
)))
8958 next
= XSYMBOL (next
)->function
;
8960 /* If the keymap gives a function, not an
8961 array, then call the function with one arg and use
8962 its value instead. */
8963 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8968 next
= call1 (next
, prompt
);
8969 /* If the function returned something invalid,
8970 barf--don't ignore it.
8971 (To ignore it safely, we would need to gcpro a bunch of
8972 other variables.) */
8973 if (! (VECTORP (next
) || STRINGP (next
)))
8974 error ("Function %s returns invalid key sequence", tem
);
8979 /* Do one step of the key remapping used for function-key-map and
8980 key-translation-map:
8981 KEYBUF is the buffer holding the input events.
8982 BUFSIZE is its maximum size.
8983 FKEY is a pointer to the keyremap structure to use.
8984 INPUT is the index of the last element in KEYBUF.
8985 DOIT if non-zero says that the remapping can actually take place.
8986 DIFF is used to return the number of keys added/removed by the remapping.
8987 PARENT is the root of the keymap.
8988 PROMPT is the prompt to use if the remapping happens through a function.
8989 The return value is non-zero if the remapping actually took place. */
8992 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8993 Lisp_Object
*keybuf
, prompt
;
8995 int input
, doit
, *diff
, bufsize
;
8997 Lisp_Object next
, key
;
8999 key
= keybuf
[fkey
->end
++];
9001 if (KEYMAPP (fkey
->parent
))
9002 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
9006 /* If keybuf[fkey->start..fkey->end] is bound in the
9007 map and we're in a position to do the key remapping, replace it with
9008 the binding and restart with fkey->start at the end. */
9009 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
9011 int len
= XFASTINT (Flength (next
));
9014 *diff
= len
- (fkey
->end
- fkey
->start
);
9016 if (input
+ *diff
>= bufsize
)
9017 error ("Key sequence too long");
9019 /* Shift the keys that follow fkey->end. */
9021 for (i
= fkey
->end
; i
< input
; i
++)
9022 keybuf
[i
+ *diff
] = keybuf
[i
];
9024 for (i
= input
- 1; i
>= fkey
->end
; i
--)
9025 keybuf
[i
+ *diff
] = keybuf
[i
];
9026 /* Overwrite the old keys with the new ones. */
9027 for (i
= 0; i
< len
; i
++)
9028 keybuf
[fkey
->start
+ i
]
9029 = Faref (next
, make_number (i
));
9031 fkey
->start
= fkey
->end
+= *diff
;
9032 fkey
->map
= fkey
->parent
;
9037 fkey
->map
= get_keymap (next
, 0, 1);
9039 /* If we no longer have a bound suffix, try a new position for
9041 if (!CONSP (fkey
->map
))
9043 fkey
->end
= ++fkey
->start
;
9044 fkey
->map
= fkey
->parent
;
9049 /* Read a sequence of keys that ends with a non prefix character,
9050 storing it in KEYBUF, a buffer of size BUFSIZE.
9052 Return the length of the key sequence stored.
9053 Return -1 if the user rejected a command menu.
9055 Echo starting immediately unless `prompt' is 0.
9057 Where a key sequence ends depends on the currently active keymaps.
9058 These include any minor mode keymaps active in the current buffer,
9059 the current buffer's local map, and the global map.
9061 If a key sequence has no other bindings, we check Vfunction_key_map
9062 to see if some trailing subsequence might be the beginning of a
9063 function key's sequence. If so, we try to read the whole function
9064 key, and substitute its symbolic name into the key sequence.
9066 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9067 `double-' events into similar click events, if that would make them
9068 bound. We try to turn `triple-' events first into `double-' events,
9071 If we get a mouse click in a mode line, vertical divider, or other
9072 non-text area, we treat the click as if it were prefixed by the
9073 symbol denoting that area - `mode-line', `vertical-line', or
9076 If the sequence starts with a mouse click, we read the key sequence
9077 with respect to the buffer clicked on, not the current buffer.
9079 If the user switches frames in the midst of a key sequence, we put
9080 off the switch-frame event until later; the next call to
9081 read_char will return it.
9083 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9084 from the selected window's buffer. */
9087 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
9088 can_return_switch_frame
, fix_current_buffer
)
9089 Lisp_Object
*keybuf
;
9092 int dont_downcase_last
;
9093 int can_return_switch_frame
;
9094 int fix_current_buffer
;
9096 volatile Lisp_Object from_string
;
9097 volatile int count
= SPECPDL_INDEX ();
9099 /* How many keys there are in the current key sequence. */
9102 /* The length of the echo buffer when we started reading, and
9103 the length of this_command_keys when we started reading. */
9104 volatile int echo_start
;
9105 volatile int keys_start
;
9107 /* The number of keymaps we're scanning right now, and the number of
9108 keymaps we have allocated space for. */
9110 volatile int nmaps_allocated
= 0;
9112 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9113 the current keymaps. */
9114 Lisp_Object
*volatile defs
= NULL
;
9116 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9117 in the current keymaps, or nil where it is not a prefix. */
9118 Lisp_Object
*volatile submaps
= NULL
;
9120 /* The local map to start out with at start of key sequence. */
9121 volatile Lisp_Object orig_local_map
;
9123 /* The map from the `keymap' property to start out with at start of
9125 volatile Lisp_Object orig_keymap
;
9127 /* 1 if we have already considered switching to the local-map property
9128 of the place where a mouse click occurred. */
9129 volatile int localized_local_map
= 0;
9131 /* The index in submaps[] of the first keymap that has a binding for
9132 this key sequence. In other words, the lowest i such that
9133 submaps[i] is non-nil. */
9134 volatile int first_binding
;
9135 /* Index of the first key that has no binding.
9136 It is useless to try fkey.start larger than that. */
9137 volatile int first_unbound
;
9139 /* If t < mock_input, then KEYBUF[t] should be read as the next
9142 We use this to recover after recognizing a function key. Once we
9143 realize that a suffix of the current key sequence is actually a
9144 function key's escape sequence, we replace the suffix with the
9145 function key's binding from Vfunction_key_map. Now keybuf
9146 contains a new and different key sequence, so the echo area,
9147 this_command_keys, and the submaps and defs arrays are wrong. In
9148 this situation, we set mock_input to t, set t to 0, and jump to
9149 restart_sequence; the loop will read keys from keybuf up until
9150 mock_input, thus rebuilding the state; and then it will resume
9151 reading characters from the keyboard. */
9152 volatile int mock_input
= 0;
9154 /* If the sequence is unbound in submaps[], then
9155 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9156 and fkey.map is its binding.
9158 These might be > t, indicating that all function key scanning
9159 should hold off until t reaches them. We do this when we've just
9160 recognized a function key, to avoid searching for the function
9161 key's again in Vfunction_key_map. */
9162 volatile keyremap fkey
;
9164 /* Likewise, for key_translation_map and input-decode-map. */
9165 volatile keyremap keytran
, indec
;
9167 /* Non-zero if we are trying to map a key by changing an upper-case
9168 letter to lower case, or a shifted function key to an unshifted
9170 volatile int shift_translated
= 0;
9172 /* If we receive a `switch-frame' or `select-window' event in the middle of
9173 a key sequence, we put it off for later.
9174 While we're reading, we keep the event here. */
9175 volatile Lisp_Object delayed_switch_frame
;
9177 /* See the comment below... */
9178 #if defined (GOBBLE_FIRST_EVENT)
9179 Lisp_Object first_event
;
9182 volatile Lisp_Object original_uppercase
;
9183 volatile int original_uppercase_position
= -1;
9185 /* Gets around Microsoft compiler limitations. */
9188 struct buffer
*starting_buffer
;
9190 /* List of events for which a fake prefix key has been generated. */
9191 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
9193 #if defined (GOBBLE_FIRST_EVENT)
9197 struct gcpro gcpro1
;
9199 GCPRO1 (fake_prefixed_keys
);
9200 raw_keybuf_count
= 0;
9202 last_nonmenu_event
= Qnil
;
9204 delayed_switch_frame
= Qnil
;
9209 echo_prompt (prompt
);
9210 else if (cursor_in_echo_area
9211 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9212 && NILP (Fzerop (Vecho_keystrokes
)))
9213 /* This doesn't put in a dash if the echo buffer is empty, so
9214 you don't always see a dash hanging out in the minibuffer. */
9218 /* Record the initial state of the echo area and this_command_keys;
9219 we will need to restore them if we replay a key sequence. */
9221 echo_start
= echo_length ();
9222 keys_start
= this_command_key_count
;
9223 this_single_command_key_start
= keys_start
;
9225 #if defined (GOBBLE_FIRST_EVENT)
9226 /* This doesn't quite work, because some of the things that read_char
9227 does cannot safely be bypassed. It seems too risky to try to make
9230 /* Read the first char of the sequence specially, before setting
9231 up any keymaps, in case a filter runs and switches buffers on us. */
9232 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9234 #endif /* GOBBLE_FIRST_EVENT */
9236 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9237 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9240 /* The multi-tty merge moved the code below to right after
9241 `replay_sequence' which caused all these translation maps to be applied
9242 repeatedly, even tho their doc says very clearly they are not applied to
9244 The reason for this move was: "We may switch keyboards between rescans,
9245 so we need to reinitialize fkey and keytran before each replay".
9246 This move was wrong (even if we switch keyboards, keybuf still holds the
9247 keys we've read already from the original keyboard and some of those keys
9248 may have already been translated). So there may still be a bug out there
9250 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9251 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9252 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9253 indec
.start
= indec
.end
= 0;
9254 fkey
.start
= fkey
.end
= 0;
9255 keytran
.start
= keytran
.end
= 0;
9257 /* We jump here when the key sequence has been thoroughly changed, and
9258 we need to rescan it starting from the beginning. When we jump here,
9259 keybuf[0..mock_input] holds the sequence we should reread. */
9262 starting_buffer
= current_buffer
;
9263 first_unbound
= bufsize
+ 1;
9265 /* Build our list of keymaps.
9266 If we recognize a function key and replace its escape sequence in
9267 keybuf with its symbol, or if the sequence starts with a mouse
9268 click and we need to switch buffers, we jump back here to rebuild
9269 the initial keymaps from the current buffer. */
9272 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9274 if (2 > nmaps_allocated
)
9276 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9277 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9278 nmaps_allocated
= 2;
9280 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9282 else if (!NILP (Voverriding_local_map
))
9284 if (2 > nmaps_allocated
)
9286 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9287 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9288 nmaps_allocated
= 2;
9290 submaps
[nmaps
++] = Voverriding_local_map
;
9298 nminor
= current_minor_maps (0, &maps
);
9299 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9301 if (total
> nmaps_allocated
)
9303 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9304 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9305 nmaps_allocated
= total
;
9308 if (!NILP (orig_keymap
))
9309 submaps
[nmaps
++] = orig_keymap
;
9311 bcopy (maps
, (void *) (submaps
+ nmaps
),
9312 nminor
* sizeof (submaps
[0]));
9316 submaps
[nmaps
++] = orig_local_map
;
9318 submaps
[nmaps
++] = current_global_map
;
9320 /* Find an accurate initial value for first_binding. */
9321 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9322 if (! NILP (submaps
[first_binding
]))
9325 /* Start from the beginning in keybuf. */
9328 /* These are no-ops the first time through, but if we restart, they
9329 revert the echo area and this_command_keys to their original state. */
9330 this_command_key_count
= keys_start
;
9331 if (INTERACTIVE
&& t
< mock_input
)
9332 echo_truncate (echo_start
);
9334 /* If the best binding for the current key sequence is a keymap, or
9335 we may be looking at a function key's escape sequence, keep on
9337 while (first_binding
< nmaps
9338 /* Keep reading as long as there's a prefix binding. */
9339 ? !NILP (submaps
[first_binding
])
9340 /* Don't return in the middle of a possible function key sequence,
9341 if the only bindings we found were via case conversion.
9342 Thus, if ESC O a has a function-key-map translation
9343 and ESC o has a binding, don't return after ESC O,
9344 so that we can translate ESC O plus the next character. */
9345 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9348 int used_mouse_menu
= 0;
9350 /* Where the last real key started. If we need to throw away a
9351 key that has expanded into more than one element of keybuf
9352 (say, a mouse click on the mode line which is being treated
9353 as [mode-line (mouse-...)], then we backtrack to this point
9355 volatile int last_real_key_start
;
9357 /* These variables are analogous to echo_start and keys_start;
9358 while those allow us to restart the entire key sequence,
9359 echo_local_start and keys_local_start allow us to throw away
9361 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9363 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9364 eassert (indec
.start
<= indec
.end
);
9365 eassert (fkey
.start
<= fkey
.end
);
9366 eassert (keytran
.start
<= keytran
.end
);
9367 /* key-translation-map is applied *after* function-key-map
9368 which is itself applied *after* input-decode-map. */
9369 eassert (fkey
.end
<= indec
.start
);
9370 eassert (keytran
.end
<= fkey
.start
);
9372 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9373 first_unbound
< keytran
.start
)
9374 { /* The prefix upto first_unbound has no binding and has
9375 no translation left to do either, so we know it's unbound.
9376 If we don't stop now, we risk staying here indefinitely
9377 (if the user keeps entering fkey or keytran prefixes
9378 like C-c ESC ESC ESC ESC ...) */
9380 for (i
= first_unbound
+ 1; i
< t
; i
++)
9381 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9382 mock_input
= t
- first_unbound
- 1;
9383 indec
.end
= indec
.start
-= first_unbound
+ 1;
9384 indec
.map
= indec
.parent
;
9385 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9386 fkey
.map
= fkey
.parent
;
9387 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9388 keytran
.map
= keytran
.parent
;
9389 goto replay_sequence
;
9393 error ("Key sequence too long");
9396 echo_local_start
= echo_length ();
9397 keys_local_start
= this_command_key_count
;
9398 local_first_binding
= first_binding
;
9401 /* These are no-ops, unless we throw away a keystroke below and
9402 jumped back up to replay_key; in that case, these restore the
9403 variables to their original state, allowing us to replay the
9405 if (INTERACTIVE
&& t
< mock_input
)
9406 echo_truncate (echo_local_start
);
9407 this_command_key_count
= keys_local_start
;
9408 first_binding
= local_first_binding
;
9410 /* By default, assume each event is "real". */
9411 last_real_key_start
= t
;
9413 /* Does mock_input indicate that we are re-reading a key sequence? */
9417 add_command_key (key
);
9418 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9419 && NILP (Fzerop (Vecho_keystrokes
)))
9423 /* If not, we should actually read a character. */
9428 KBOARD
*interrupted_kboard
= current_kboard
;
9429 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9431 key
= read_char (NILP (prompt
), nmaps
,
9432 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9433 &used_mouse_menu
, NULL
);
9435 if (INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9440 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9441 if (k
== interrupted_kboard
)
9446 /* Don't touch interrupted_kboard when it's been
9448 delayed_switch_frame
= Qnil
;
9449 goto replay_sequence
;
9452 if (!NILP (delayed_switch_frame
))
9454 interrupted_kboard
->kbd_queue
9455 = Fcons (delayed_switch_frame
,
9456 interrupted_kboard
->kbd_queue
);
9457 delayed_switch_frame
= Qnil
;
9461 interrupted_kboard
->kbd_queue
9462 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9464 /* If the side queue is non-empty, ensure it begins with a
9465 switch-frame, so we'll replay it in the right context. */
9466 if (CONSP (interrupted_kboard
->kbd_queue
)
9467 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9468 !(EVENT_HAS_PARAMETERS (key
)
9469 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9473 XSETFRAME (frame
, interrupted_frame
);
9474 interrupted_kboard
->kbd_queue
9475 = Fcons (make_lispy_switch_frame (frame
),
9476 interrupted_kboard
->kbd_queue
);
9479 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9480 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9481 goto replay_sequence
;
9486 /* read_char returns t when it shows a menu and the user rejects it.
9490 unbind_to (count
, Qnil
);
9495 /* read_char returns -1 at the end of a macro.
9496 Emacs 18 handles this by returning immediately with a
9497 zero, so that's what we'll do. */
9498 if (INTEGERP (key
) && XINT (key
) == -1)
9501 /* The Microsoft C compiler can't handle the goto that
9507 /* If the current buffer has been changed from under us, the
9508 keymap may have changed, so replay the sequence. */
9511 timer_resume_idle ();
9514 /* Reset the current buffer from the selected window
9515 in case something changed the former and not the latter.
9516 This is to be more consistent with the behavior
9517 of the command_loop_1. */
9518 if (fix_current_buffer
)
9520 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9522 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9523 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9526 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9527 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9528 goto replay_sequence
;
9531 /* If we have a quit that was typed in another frame, and
9532 quit_throw_to_read_char switched buffers,
9533 replay to get the right keymap. */
9535 && XINT (key
) == quit_char
9536 && current_buffer
!= starting_buffer
)
9539 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9543 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9544 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9545 goto replay_sequence
;
9550 if (EVENT_HAS_PARAMETERS (key
)
9551 /* Either a `switch-frame' or a `select-window' event. */
9552 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9554 /* If we're at the beginning of a key sequence, and the caller
9555 says it's okay, go ahead and return this event. If we're
9556 in the midst of a key sequence, delay it until the end. */
9557 if (t
> 0 || !can_return_switch_frame
)
9559 delayed_switch_frame
= key
;
9565 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9569 /* Clicks in non-text areas get prefixed by the symbol
9570 in their CHAR-ADDRESS field. For example, a click on
9571 the mode line is prefixed by the symbol `mode-line'.
9573 Furthermore, key sequences beginning with mouse clicks
9574 are read using the keymaps of the buffer clicked on, not
9575 the current buffer. So we may have to switch the buffer
9578 When we turn one event into two events, we must make sure
9579 that neither of the two looks like the original--so that,
9580 if we replay the events, they won't be expanded again.
9581 If not for this, such reexpansion could happen either here
9582 or when user programs play with this-command-keys. */
9583 if (EVENT_HAS_PARAMETERS (key
))
9588 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9589 if (EQ (kind
, Qmouse_click
))
9591 Lisp_Object window
, posn
;
9593 window
= POSN_WINDOW (EVENT_START (key
));
9594 posn
= POSN_POSN (EVENT_START (key
));
9597 || (!NILP (fake_prefixed_keys
)
9598 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9600 /* We're looking a second time at an event for which
9601 we generated a fake prefix key. Set
9602 last_real_key_start appropriately. */
9604 last_real_key_start
= t
- 1;
9607 /* Key sequences beginning with mouse clicks are
9608 read using the keymaps in the buffer clicked on,
9609 not the current buffer. If we're at the
9610 beginning of a key sequence, switch buffers. */
9611 if (last_real_key_start
== 0
9613 && BUFFERP (XWINDOW (window
)->buffer
)
9614 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9616 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9620 /* Arrange to go back to the original buffer once we're
9621 done reading the key sequence. Note that we can't
9622 use save_excursion_{save,restore} here, because they
9623 save point as well as the current buffer; we don't
9624 want to save point, because redisplay may change it,
9625 to accommodate a Fset_window_start or something. We
9626 don't want to do this at the top of the function,
9627 because we may get input from a subprocess which
9628 wants to change the selected window and stuff (say,
9630 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9632 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9634 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9635 orig_local_map
= get_local_map (PT
, current_buffer
,
9637 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9638 goto replay_sequence
;
9641 /* For a mouse click, get the local text-property keymap
9642 of the place clicked on, rather than point. */
9643 if (last_real_key_start
== 0
9644 && CONSP (XCDR (key
))
9645 && ! localized_local_map
)
9647 Lisp_Object map_here
, start
, pos
;
9649 localized_local_map
= 1;
9650 start
= EVENT_START (key
);
9652 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9654 pos
= POSN_BUFFER_POSN (start
);
9656 && XINT (pos
) >= BEGV
9657 && XINT (pos
) <= ZV
)
9659 map_here
= get_local_map (XINT (pos
),
9660 current_buffer
, Qlocal_map
);
9661 if (!EQ (map_here
, orig_local_map
))
9663 orig_local_map
= map_here
;
9664 ++localized_local_map
;
9667 map_here
= get_local_map (XINT (pos
),
9668 current_buffer
, Qkeymap
);
9669 if (!EQ (map_here
, orig_keymap
))
9671 orig_keymap
= map_here
;
9672 ++localized_local_map
;
9675 if (localized_local_map
> 1)
9680 goto replay_sequence
;
9686 /* Expand mode-line and scroll-bar events into two events:
9687 use posn as a fake prefix key. */
9689 && (NILP (fake_prefixed_keys
)
9690 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9692 if (t
+ 1 >= bufsize
)
9693 error ("Key sequence too long");
9696 keybuf
[t
+ 1] = key
;
9699 /* Record that a fake prefix key has been generated
9700 for KEY. Don't modify the event; this would
9701 prevent proper action when the event is pushed
9702 back into unread-command-events. */
9703 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9705 /* If on a mode line string with a local keymap,
9706 reconsider the key sequence with that keymap. */
9707 if (string
= POSN_STRING (EVENT_START (key
)),
9708 (CONSP (string
) && STRINGP (XCAR (string
))))
9710 Lisp_Object pos
, map
, map2
;
9712 pos
= XCDR (string
);
9713 string
= XCAR (string
);
9715 && XINT (pos
) < SCHARS (string
))
9717 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9719 orig_local_map
= map
;
9720 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9723 if (!NILP (map
) || !NILP (map2
))
9724 goto replay_sequence
;
9730 else if (NILP (from_string
)
9731 && (string
= POSN_STRING (EVENT_START (key
)),
9732 (CONSP (string
) && STRINGP (XCAR (string
)))))
9734 /* For a click on a string, i.e. overlay string or a
9735 string displayed via the `display' property,
9736 consider `local-map' and `keymap' properties of
9738 Lisp_Object pos
, map
, map2
;
9740 pos
= XCDR (string
);
9741 string
= XCAR (string
);
9743 && XINT (pos
) < SCHARS (string
))
9745 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9747 orig_local_map
= map
;
9748 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9752 if (!NILP (map
) || !NILP (map2
))
9754 from_string
= string
;
9757 goto replay_sequence
;
9762 else if (CONSP (XCDR (key
))
9763 && CONSP (EVENT_START (key
))
9764 && CONSP (XCDR (EVENT_START (key
))))
9768 posn
= POSN_POSN (EVENT_START (key
));
9769 /* Handle menu-bar events:
9770 insert the dummy prefix event `menu-bar'. */
9771 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9773 if (t
+ 1 >= bufsize
)
9774 error ("Key sequence too long");
9778 /* Zap the position in key, so we know that we've
9779 expanded it, and don't try to do so again. */
9780 POSN_SET_POSN (EVENT_START (key
),
9781 Fcons (posn
, Qnil
));
9784 goto replay_sequence
;
9786 else if (CONSP (posn
))
9788 /* We're looking at the second event of a
9789 sequence which we expanded before. Set
9790 last_real_key_start appropriately. */
9791 if (last_real_key_start
== t
&& t
> 0)
9792 last_real_key_start
= t
- 1;
9797 /* We have finally decided that KEY is something we might want
9799 first_binding
= (follow_key (key
,
9800 nmaps
- first_binding
,
9801 submaps
+ first_binding
,
9802 defs
+ first_binding
,
9803 submaps
+ first_binding
)
9806 /* If KEY wasn't bound, we'll try some fallbacks. */
9807 if (first_binding
< nmaps
)
9808 /* This is needed for the following scenario:
9809 event 0: a down-event that gets dropped by calling replay_key.
9810 event 1: some normal prefix like C-h.
9811 After event 0, first_unbound is 0, after event 1 indec.start,
9812 fkey.start, and keytran.start are all 1, so when we see that
9813 C-h is bound, we need to update first_unbound. */
9814 first_unbound
= max (t
+ 1, first_unbound
);
9819 /* Remember the position to put an upper bound on indec.start. */
9820 first_unbound
= min (t
, first_unbound
);
9822 head
= EVENT_HEAD (key
);
9823 if (help_char_p (head
) && t
> 0)
9825 read_key_sequence_cmd
= Vprefix_help_command
;
9827 last_nonmenu_event
= key
;
9828 /* The Microsoft C compiler can't handle the goto that
9836 Lisp_Object breakdown
;
9839 breakdown
= parse_modifiers (head
);
9840 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9841 /* Attempt to reduce an unbound mouse event to a simpler
9842 event that is bound:
9843 Drags reduce to clicks.
9844 Double-clicks reduce to clicks.
9845 Triple-clicks reduce to double-clicks, then to clicks.
9846 Down-clicks are eliminated.
9847 Double-downs reduce to downs, then are eliminated.
9848 Triple-downs reduce to double-downs, then to downs,
9849 then are eliminated. */
9850 if (modifiers
& (down_modifier
| drag_modifier
9851 | double_modifier
| triple_modifier
))
9853 while (modifiers
& (down_modifier
| drag_modifier
9854 | double_modifier
| triple_modifier
))
9856 Lisp_Object new_head
, new_click
;
9857 if (modifiers
& triple_modifier
)
9858 modifiers
^= (double_modifier
| triple_modifier
);
9859 else if (modifiers
& double_modifier
)
9860 modifiers
&= ~double_modifier
;
9861 else if (modifiers
& drag_modifier
)
9862 modifiers
&= ~drag_modifier
;
9865 /* Dispose of this `down' event by simply jumping
9866 back to replay_key, to get another event.
9868 Note that if this event came from mock input,
9869 then just jumping back to replay_key will just
9870 hand it to us again. So we have to wipe out any
9873 We could delete keybuf[t] and shift everything
9874 after that to the left by one spot, but we'd also
9875 have to fix up any variable that points into
9876 keybuf, and shifting isn't really necessary
9879 Adding prefixes for non-textual mouse clicks
9880 creates two characters of mock input, and both
9881 must be thrown away. If we're only looking at
9882 the prefix now, we can just jump back to
9883 replay_key. On the other hand, if we've already
9884 processed the prefix, and now the actual click
9885 itself is giving us trouble, then we've lost the
9886 state of the keymaps we want to backtrack to, and
9887 we need to replay the whole sequence to rebuild
9890 Beyond that, only function key expansion could
9891 create more than two keys, but that should never
9892 generate mouse events, so it's okay to zero
9893 mock_input in that case too.
9895 FIXME: The above paragraph seems just plain
9896 wrong, if you consider things like
9897 xterm-mouse-mode. -stef
9899 Isn't this just the most wonderful code ever? */
9901 /* If mock_input > t + 1, the above simplification
9902 will actually end up dropping keys on the floor.
9903 This is probably OK for now, but even
9904 if mock_input <= t + 1, we need to adjust indec,
9906 Typical case [header-line down-mouse-N]:
9907 mock_input = 2, t = 1, fkey.end = 1,
9908 last_real_key_start = 0. */
9909 if (indec
.end
> last_real_key_start
)
9911 indec
.end
= indec
.start
9912 = min (last_real_key_start
, indec
.start
);
9913 indec
.map
= indec
.parent
;
9914 if (fkey
.end
> last_real_key_start
)
9916 fkey
.end
= fkey
.start
9917 = min (last_real_key_start
, fkey
.start
);
9918 fkey
.map
= fkey
.parent
;
9919 if (keytran
.end
> last_real_key_start
)
9921 keytran
.end
= keytran
.start
9922 = min (last_real_key_start
, keytran
.start
);
9923 keytran
.map
= keytran
.parent
;
9927 if (t
== last_real_key_start
)
9934 mock_input
= last_real_key_start
;
9935 goto replay_sequence
;
9940 = apply_modifiers (modifiers
, XCAR (breakdown
));
9942 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9944 /* Look for a binding for this new key. follow_key
9945 promises that it didn't munge submaps the
9946 last time we called it, since key was unbound. */
9948 = (follow_key (new_click
,
9949 nmaps
- local_first_binding
,
9950 submaps
+ local_first_binding
,
9951 defs
+ local_first_binding
,
9952 submaps
+ local_first_binding
)
9953 + local_first_binding
);
9955 /* If that click is bound, go for it. */
9956 if (first_binding
< nmaps
)
9961 /* Otherwise, we'll leave key set to the drag event. */
9968 /* Normally, last_nonmenu_event gets the previous key we read.
9969 But when a mouse popup menu is being used,
9970 we don't update last_nonmenu_event; it continues to hold the mouse
9971 event that preceded the first level of menu. */
9972 if (!used_mouse_menu
)
9973 last_nonmenu_event
= key
;
9975 /* Record what part of this_command_keys is the current key sequence. */
9976 this_single_command_key_start
= this_command_key_count
- t
;
9978 /* Look for this sequence in input-decode-map.
9979 Scan from indec.end until we find a bound suffix. */
9980 while (indec
.end
< t
)
9982 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9985 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9986 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9991 mock_input
= diff
+ max (t
, mock_input
);
9992 goto replay_sequence
;
9996 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9997 && indec
.start
>= t
)
9998 /* There is a binding and it's not a prefix.
9999 (and it doesn't have any input-decode-map translation pending).
10000 There is thus no function-key in this sequence.
10001 Moving fkey.start is important in this case to allow keytran.start
10002 to go over the sequence before we return (since we keep the
10003 invariant that keytran.end <= fkey.start). */
10005 if (fkey
.start
< t
)
10006 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
10009 /* If the sequence is unbound, see if we can hang a function key
10010 off the end of it. */
10011 /* Continue scan from fkey.end until we find a bound suffix. */
10012 while (fkey
.end
< indec
.start
)
10014 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10017 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10018 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
10019 max (t
, mock_input
),
10020 /* If there's a binding (i.e.
10021 first_binding >= nmaps) we don't want
10022 to apply this function-key-mapping. */
10023 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
10028 mock_input
= diff
+ max (t
, mock_input
);
10029 /* Adjust the input-decode-map counters. */
10031 indec
.start
+= diff
;
10033 goto replay_sequence
;
10037 /* Look for this sequence in key-translation-map.
10038 Scan from keytran.end until we find a bound suffix. */
10039 while (keytran
.end
< fkey
.start
)
10041 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10044 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10045 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
10050 mock_input
= diff
+ max (t
, mock_input
);
10051 /* Adjust the function-key-map and input-decode-map counters. */
10053 indec
.start
+= diff
;
10055 fkey
.start
+= diff
;
10057 goto replay_sequence
;
10061 /* If KEY is not defined in any of the keymaps,
10062 and cannot be part of a function key or translation,
10063 and is an upper case letter
10064 use the corresponding lower-case letter instead. */
10065 if (first_binding
>= nmaps
10066 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
10068 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10069 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10070 || (XINT (key
) & shift_modifier
)))
10072 Lisp_Object new_key
;
10074 original_uppercase
= key
;
10075 original_uppercase_position
= t
- 1;
10077 if (XINT (key
) & shift_modifier
)
10078 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10080 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10081 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10083 /* We have to do this unconditionally, regardless of whether
10084 the lower-case char is defined in the keymaps, because they
10085 might get translated through function-key-map. */
10086 keybuf
[t
- 1] = new_key
;
10087 mock_input
= max (t
, mock_input
);
10088 shift_translated
= 1;
10090 goto replay_sequence
;
10092 /* If KEY is not defined in any of the keymaps,
10093 and cannot be part of a function key or translation,
10094 and is a shifted function key,
10095 use the corresponding unshifted function key instead. */
10096 if (first_binding
>= nmaps
10097 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10099 Lisp_Object breakdown
= parse_modifiers (key
);
10101 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10103 if (modifiers
& shift_modifier
10104 /* Treat uppercase keys as shifted. */
10106 && (KEY_TO_CHAR (key
)
10107 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
10108 && UPPERCASEP (KEY_TO_CHAR (key
))))
10110 Lisp_Object new_key
10111 = (modifiers
& shift_modifier
10112 ? apply_modifiers (modifiers
& ~shift_modifier
,
10114 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
10116 original_uppercase
= key
;
10117 original_uppercase_position
= t
- 1;
10119 /* We have to do this unconditionally, regardless of whether
10120 the lower-case char is defined in the keymaps, because they
10121 might get translated through function-key-map. */
10122 keybuf
[t
- 1] = new_key
;
10123 mock_input
= max (t
, mock_input
);
10124 /* Reset fkey (and consequently keytran) to apply
10125 function-key-map on the result, so that S-backspace is
10126 correctly mapped to DEL (via backspace). OTOH,
10127 input-decode-map doesn't need to go through it again. */
10128 fkey
.start
= fkey
.end
= 0;
10129 keytran
.start
= keytran
.end
= 0;
10130 shift_translated
= 1;
10132 goto replay_sequence
;
10137 read_key_sequence_cmd
= (first_binding
< nmaps
10138 ? defs
[first_binding
]
10141 unread_switch_frame
= delayed_switch_frame
;
10142 unbind_to (count
, Qnil
);
10144 /* Don't downcase the last character if the caller says don't.
10145 Don't downcase it if the result is undefined, either. */
10146 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10148 && t
- 1 == original_uppercase_position
)
10150 keybuf
[t
- 1] = original_uppercase
;
10151 shift_translated
= 0;
10154 if (shift_translated
)
10155 Vthis_command_keys_shift_translated
= Qt
;
10157 /* Occasionally we fabricate events, perhaps by expanding something
10158 according to function-key-map, or by adding a prefix symbol to a
10159 mouse click in the scroll bar or modeline. In this cases, return
10160 the entire generated key sequence, even if we hit an unbound
10161 prefix or a definition before the end. This means that you will
10162 be able to push back the event properly, and also means that
10163 read-key-sequence will always return a logical unit.
10166 for (; t
< mock_input
; t
++)
10168 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10169 && NILP (Fzerop (Vecho_keystrokes
)))
10170 echo_char (keybuf
[t
]);
10171 add_command_key (keybuf
[t
]);
10178 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10179 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10180 The sequence is sufficient to specify a non-prefix command in the
10181 current local and global maps.
10183 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10184 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10185 as a continuation of the previous key.
10187 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10188 convert the last event to lower case. (Normally any upper case event
10189 is converted to lower case if the original event is undefined and the lower
10190 case equivalent is defined.) A non-nil value is appropriate for reading
10191 a key sequence to be defined.
10193 A C-g typed while in this function is treated like any other character,
10194 and `quit-flag' is not set.
10196 If the key sequence starts with a mouse click, then the sequence is read
10197 using the keymaps of the buffer of the window clicked in, not the buffer
10198 of the selected window as normal.
10200 `read-key-sequence' drops unbound button-down events, since you normally
10201 only care about the click or drag events which follow them. If a drag
10202 or multi-click event is unbound, but the corresponding click event would
10203 be bound, `read-key-sequence' turns the event into a click event at the
10204 drag's starting position. This means that you don't have to distinguish
10205 between click and drag, double, or triple events unless you want to.
10207 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10208 lines separating windows, and scroll bars with imaginary keys
10209 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10211 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10212 function will process a switch-frame event if the user switches frames
10213 before typing anything. If the user switches frames in the middle of a
10214 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10215 is nil, then the event will be put off until after the current key sequence.
10217 `read-key-sequence' checks `function-key-map' for function key
10218 sequences, where they wouldn't conflict with ordinary bindings. See
10219 `function-key-map' for more details.
10221 The optional fifth argument COMMAND-LOOP, if non-nil, means
10222 that this key sequence is being read by something that will
10223 read commands one after another. It should be nil if the caller
10224 will read just one key sequence. */)
10225 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10227 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10228 Lisp_Object can_return_switch_frame
, command_loop
;
10230 Lisp_Object keybuf
[30];
10232 struct gcpro gcpro1
;
10233 int count
= SPECPDL_INDEX ();
10235 if (!NILP (prompt
))
10236 CHECK_STRING (prompt
);
10239 specbind (Qinput_method_exit_on_first_char
,
10240 (NILP (command_loop
) ? Qt
: Qnil
));
10241 specbind (Qinput_method_use_echo_area
,
10242 (NILP (command_loop
) ? Qt
: Qnil
));
10244 bzero (keybuf
, sizeof keybuf
);
10245 GCPRO1 (keybuf
[0]);
10246 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10248 if (NILP (continue_echo
))
10250 this_command_key_count
= 0;
10251 this_command_key_count_reset
= 0;
10252 this_single_command_key_start
= 0;
10255 #ifdef HAVE_WINDOW_SYSTEM
10256 if (display_hourglass_p
)
10257 cancel_hourglass ();
10260 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10261 prompt
, ! NILP (dont_downcase_last
),
10262 ! NILP (can_return_switch_frame
), 0);
10264 #if 0 /* The following is fine for code reading a key sequence and
10265 then proceeding with a lenghty computation, but it's not good
10266 for code reading keys in a loop, like an input method. */
10267 #ifdef HAVE_WINDOW_SYSTEM
10268 if (display_hourglass_p
)
10269 start_hourglass ();
10279 return unbind_to (count
, make_event_array (i
, keybuf
));
10282 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10283 Sread_key_sequence_vector
, 1, 5, 0,
10284 doc
: /* Like `read-key-sequence' but always return a vector. */)
10285 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10287 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10288 Lisp_Object can_return_switch_frame
, command_loop
;
10290 Lisp_Object keybuf
[30];
10292 struct gcpro gcpro1
;
10293 int count
= SPECPDL_INDEX ();
10295 if (!NILP (prompt
))
10296 CHECK_STRING (prompt
);
10299 specbind (Qinput_method_exit_on_first_char
,
10300 (NILP (command_loop
) ? Qt
: Qnil
));
10301 specbind (Qinput_method_use_echo_area
,
10302 (NILP (command_loop
) ? Qt
: Qnil
));
10304 bzero (keybuf
, sizeof keybuf
);
10305 GCPRO1 (keybuf
[0]);
10306 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10308 if (NILP (continue_echo
))
10310 this_command_key_count
= 0;
10311 this_command_key_count_reset
= 0;
10312 this_single_command_key_start
= 0;
10315 #ifdef HAVE_WINDOW_SYSTEM
10316 if (display_hourglass_p
)
10317 cancel_hourglass ();
10320 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10321 prompt
, ! NILP (dont_downcase_last
),
10322 ! NILP (can_return_switch_frame
), 0);
10324 #ifdef HAVE_WINDOW_SYSTEM
10325 if (display_hourglass_p
)
10326 start_hourglass ();
10335 return unbind_to (count
, Fvector (i
, keybuf
));
10338 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10339 doc
: /* Execute CMD as an editor command.
10340 CMD must be a symbol that satisfies the `commandp' predicate.
10341 Optional second arg RECORD-FLAG non-nil
10342 means unconditionally put this command in `command-history'.
10343 Otherwise, that is done only if an arg is read using the minibuffer.
10344 The argument KEYS specifies the value to use instead of (this-command-keys)
10345 when reading the arguments; if it is nil, (this-command-keys) is used.
10346 The argument SPECIAL, if non-nil, means that this command is executing
10347 a special event, so ignore the prefix argument and don't clear it. */)
10348 (cmd
, record_flag
, keys
, special
)
10349 Lisp_Object cmd
, record_flag
, keys
, special
;
10351 register Lisp_Object final
;
10352 register Lisp_Object tem
;
10353 Lisp_Object prefixarg
;
10354 extern int debug_on_next_call
;
10356 debug_on_next_call
= 0;
10358 if (NILP (special
))
10360 prefixarg
= current_kboard
->Vprefix_arg
;
10361 Vcurrent_prefix_arg
= prefixarg
;
10362 current_kboard
->Vprefix_arg
= Qnil
;
10369 tem
= Fget (cmd
, Qdisabled
);
10370 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10372 tem
= Fsymbol_value (Qdisabled_command_function
);
10374 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10380 final
= Findirect_function (cmd
, Qnil
);
10382 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10384 struct gcpro gcpro1
, gcpro2
;
10386 GCPRO2 (cmd
, prefixarg
);
10387 do_autoload (final
, cmd
);
10394 if (STRINGP (final
) || VECTORP (final
))
10396 /* If requested, place the macro in the command history. For
10397 other sorts of commands, call-interactively takes care of
10399 if (!NILP (record_flag
))
10402 = Fcons (Fcons (Qexecute_kbd_macro
,
10403 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10406 /* Don't keep command history around forever. */
10407 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10409 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10411 XSETCDR (tem
, Qnil
);
10415 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10418 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10419 /* Don't call Fcall_interactively directly because we want to make
10420 sure the backtrace has an entry for `call-interactively'.
10421 For the same reason, pass `cmd' rather than `final'. */
10422 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10429 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10431 doc
: /* Read function name, then read its arguments and call it.
10433 To pass a numeric argument to the command you are invoking with, specify
10434 the numeric argument to this command.
10436 Noninteractively, the argument PREFIXARG is the prefix argument to
10437 give to the command you invoke, if it asks for an argument. */)
10439 Lisp_Object prefixarg
;
10441 Lisp_Object function
;
10443 int saved_last_point_position
;
10444 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10445 Lisp_Object bindings
, value
;
10446 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10447 #ifdef HAVE_WINDOW_SYSTEM
10448 /* The call to Fcompleting_read wil start and cancel the hourglass,
10449 but if the hourglass was already scheduled, this means that no
10450 hourglass will be shown for the actual M-x command itself.
10451 So we restart it if it is already scheduled. Note that checking
10452 hourglass_shown_p is not enough, normally the hourglass is not shown,
10453 just scheduled to be shown. */
10454 int hstarted
= hourglass_started ();
10457 saved_keys
= Fvector (this_command_key_count
,
10458 XVECTOR (this_command_keys
)->contents
);
10459 saved_last_point_position_buffer
= last_point_position_buffer
;
10460 saved_last_point_position
= last_point_position
;
10462 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10464 if (EQ (prefixarg
, Qminus
))
10465 strcpy (buf
, "- ");
10466 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10467 strcpy (buf
, "C-u ");
10468 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10469 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10470 else if (INTEGERP (prefixarg
))
10471 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10473 /* This isn't strictly correct if execute-extended-command
10474 is bound to anything else. Perhaps it should use
10475 this_command_keys? */
10476 strcat (buf
, "M-x ");
10478 /* Prompt with buf, and then read a string, completing from and
10479 restricting to the set of all defined commands. Don't provide
10480 any initial input. Save the command read on the extended-command
10482 function
= Fcompleting_read (build_string (buf
),
10483 Vobarray
, Qcommandp
,
10484 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10487 #ifdef HAVE_WINDOW_SYSTEM
10488 if (hstarted
) start_hourglass ();
10491 if (STRINGP (function
) && SCHARS (function
) == 0)
10492 error ("No command name given");
10494 /* Set this_command_keys to the concatenation of saved_keys and
10495 function, followed by a RET. */
10500 this_command_key_count
= 0;
10501 this_command_key_count_reset
= 0;
10502 this_single_command_key_start
= 0;
10504 keys
= XVECTOR (saved_keys
)->contents
;
10505 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10506 add_command_key (keys
[i
]);
10508 for (i
= 0; i
< SCHARS (function
); i
++)
10509 add_command_key (Faref (function
, make_number (i
)));
10511 add_command_key (make_number ('\015'));
10514 last_point_position
= saved_last_point_position
;
10515 last_point_position_buffer
= saved_last_point_position_buffer
;
10519 function
= Fintern (function
, Qnil
);
10520 current_kboard
->Vprefix_arg
= prefixarg
;
10521 Vthis_command
= function
;
10522 real_this_command
= function
;
10524 /* If enabled, show which key runs this command. */
10525 if (!NILP (Vsuggest_key_bindings
)
10526 && NILP (Vexecuting_kbd_macro
)
10527 && SYMBOLP (function
))
10528 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10534 GCPRO3 (bindings
, value
, function
);
10535 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10537 /* If the command has a key binding, print it now. */
10538 if (!NILP (bindings
)
10539 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10542 /* But first wait, and skip the message if there is input. */
10543 Lisp_Object waited
;
10545 /* If this command displayed something in the echo area;
10546 wait a few seconds, then display our suggestion message. */
10547 if (NILP (echo_area_buffer
[0]))
10548 waited
= sit_for (make_number (0), 0, 2);
10549 else if (NUMBERP (Vsuggest_key_bindings
))
10550 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10552 waited
= sit_for (make_number (2), 0, 2);
10554 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10556 Lisp_Object binding
;
10558 int message_p
= push_message ();
10559 int count
= SPECPDL_INDEX ();
10561 record_unwind_protect (pop_message_unwind
, Qnil
);
10562 binding
= Fkey_description (bindings
, Qnil
);
10565 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10568 sprintf (newmessage
, "You can run the command `%s' with %s",
10569 SDATA (SYMBOL_NAME (function
)),
10571 message2_nolog (newmessage
,
10572 strlen (newmessage
),
10573 STRING_MULTIBYTE (binding
));
10574 if (NUMBERP (Vsuggest_key_bindings
))
10575 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10577 waited
= sit_for (make_number (2), 0, 2);
10579 if (!NILP (waited
) && message_p
)
10580 restore_message ();
10582 unbind_to (count
, Qnil
);
10586 RETURN_UNGCPRO (value
);
10590 /* Return nonzero if input events are pending. */
10593 detect_input_pending ()
10595 if (!input_pending
)
10596 get_input_pending (&input_pending
, 0);
10598 return input_pending
;
10601 /* Return nonzero if input events other than mouse movements are
10605 detect_input_pending_ignore_squeezables ()
10607 if (!input_pending
)
10608 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10610 return input_pending
;
10613 /* Return nonzero if input events are pending, and run any pending timers. */
10616 detect_input_pending_run_timers (do_display
)
10619 int old_timers_run
= timers_run
;
10621 if (!input_pending
)
10622 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10624 if (old_timers_run
!= timers_run
&& do_display
)
10626 redisplay_preserve_echo_area (8);
10627 /* The following fixes a bug when using lazy-lock with
10628 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10629 from an idle timer function. The symptom of the bug is that
10630 the cursor sometimes doesn't become visible until the next X
10631 event is processed. --gerd. */
10633 Lisp_Object tail
, frame
;
10634 FOR_EACH_FRAME (tail
, frame
)
10635 if (FRAME_RIF (XFRAME (frame
)))
10636 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10640 return input_pending
;
10643 /* This is called in some cases before a possible quit.
10644 It cases the next call to detect_input_pending to recompute input_pending.
10645 So calling this function unnecessarily can't do any harm. */
10648 clear_input_pending ()
10653 /* Return nonzero if there are pending requeued events.
10654 This isn't used yet. The hope is to make wait_reading_process_output
10655 call it, and return if it runs Lisp code that unreads something.
10656 The problem is, kbd_buffer_get_event needs to be fixed to know what
10657 to do in that case. It isn't trivial. */
10660 requeued_events_pending_p ()
10662 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10666 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10667 doc
: /* Return t if command input is currently available with no wait.
10668 Actually, the value is nil only if we can be sure that no input is available;
10669 if there is a doubt, the value is t. */)
10672 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10673 || !NILP (Vunread_post_input_method_events
)
10674 || !NILP (Vunread_input_method_events
))
10677 get_input_pending (&input_pending
,
10678 READABLE_EVENTS_DO_TIMERS_NOW
10679 | READABLE_EVENTS_FILTER_EVENTS
);
10680 return input_pending
> 0 ? Qt
: Qnil
;
10683 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10684 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10687 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10690 if (total_keys
< NUM_RECENT_KEYS
)
10691 return Fvector (total_keys
, keys
);
10694 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10695 bcopy (keys
+ recent_keys_index
,
10696 XVECTOR (val
)->contents
,
10697 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10699 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10700 recent_keys_index
* sizeof (Lisp_Object
));
10705 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10706 doc
: /* Return the key sequence that invoked this command.
10707 However, if the command has called `read-key-sequence', it returns
10708 the last key sequence that has been read.
10709 The value is a string or a vector.
10711 See also `this-command-keys-vector'. */)
10714 return make_event_array (this_command_key_count
,
10715 XVECTOR (this_command_keys
)->contents
);
10718 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10719 doc
: /* Return the key sequence that invoked this command, as a vector.
10720 However, if the command has called `read-key-sequence', it returns
10721 the last key sequence that has been read.
10723 See also `this-command-keys'. */)
10726 return Fvector (this_command_key_count
,
10727 XVECTOR (this_command_keys
)->contents
);
10730 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10731 Sthis_single_command_keys
, 0, 0, 0,
10732 doc
: /* Return the key sequence that invoked this command.
10733 More generally, it returns the last key sequence read, either by
10734 the command loop or by `read-key-sequence'.
10735 Unlike `this-command-keys', this function's value
10736 does not include prefix arguments.
10737 The value is always a vector. */)
10740 return Fvector (this_command_key_count
10741 - this_single_command_key_start
,
10742 (XVECTOR (this_command_keys
)->contents
10743 + this_single_command_key_start
));
10746 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10747 Sthis_single_command_raw_keys
, 0, 0, 0,
10748 doc
: /* Return the raw events that were read for this command.
10749 More generally, it returns the last key sequence read, either by
10750 the command loop or by `read-key-sequence'.
10751 Unlike `this-single-command-keys', this function's value
10752 shows the events before all translations (except for input methods).
10753 The value is always a vector. */)
10756 return Fvector (raw_keybuf_count
,
10757 (XVECTOR (raw_keybuf
)->contents
));
10760 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10761 Sreset_this_command_lengths
, 0, 0, 0,
10762 doc
: /* Make the unread events replace the last command and echo.
10763 Used in `universal-argument-other-key'.
10765 `universal-argument-other-key' rereads the event just typed.
10766 It then gets translated through `function-key-map'.
10767 The translated event has to replace the real events,
10768 both in the value of (this-command-keys) and in echoing.
10769 To achieve this, `universal-argument-other-key' calls
10770 `reset-this-command-lengths', which discards the record of reading
10771 these events the first time. */)
10774 this_command_key_count
= before_command_key_count
;
10775 if (this_command_key_count
< this_single_command_key_start
)
10776 this_single_command_key_start
= this_command_key_count
;
10778 echo_truncate (before_command_echo_length
);
10780 /* Cause whatever we put into unread-command-events
10781 to echo as if it were being freshly read from the keyboard. */
10782 this_command_key_count_reset
= 1;
10787 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10788 Sclear_this_command_keys
, 0, 1, 0,
10789 doc
: /* Clear out the vector that `this-command-keys' returns.
10790 Also clear the record of the last 100 events, unless optional arg
10791 KEEP-RECORD is non-nil. */)
10793 Lisp_Object keep_record
;
10797 this_command_key_count
= 0;
10798 this_command_key_count_reset
= 0;
10800 if (NILP (keep_record
))
10802 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10803 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10805 recent_keys_index
= 0;
10810 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10811 doc
: /* Return the current depth in recursive edits. */)
10815 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10819 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10820 "FOpen dribble file: ",
10821 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10822 If FILE is nil, close any open dribble file. */)
10835 file
= Fexpand_file_name (file
, Qnil
);
10836 dribble
= fopen (SDATA (file
), "w");
10838 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10843 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10844 doc
: /* Discard the contents of the terminal input buffer.
10845 Also end any kbd macro being defined. */)
10848 if (!NILP (current_kboard
->defining_kbd_macro
))
10850 /* Discard the last command from the macro. */
10851 Fcancel_kbd_macro_events ();
10855 update_mode_lines
++;
10857 Vunread_command_events
= Qnil
;
10858 unread_command_char
= -1;
10860 discard_tty_input ();
10862 kbd_fetch_ptr
= kbd_store_ptr
;
10868 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10869 doc
: /* Stop Emacs and return to superior process. You can resume later.
10870 If `cannot-suspend' is non-nil, or if the system doesn't support job
10871 control, run a subshell instead.
10873 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10874 to be read as terminal input by Emacs's parent, after suspension.
10876 Before suspending, run the normal hook `suspend-hook'.
10877 After resumption run the normal hook `suspend-resume-hook'.
10879 Some operating systems cannot stop the Emacs process and resume it later.
10880 On such systems, Emacs starts a subshell instead of suspending. */)
10882 Lisp_Object stuffstring
;
10884 int count
= SPECPDL_INDEX ();
10885 int old_height
, old_width
;
10887 struct gcpro gcpro1
;
10889 if (tty_list
&& tty_list
->next
)
10890 error ("There are other tty frames open; close them before suspending Emacs");
10892 if (!NILP (stuffstring
))
10893 CHECK_STRING (stuffstring
);
10895 /* Run the functions in suspend-hook. */
10896 if (!NILP (Vrun_hooks
))
10897 call1 (Vrun_hooks
, intern ("suspend-hook"));
10899 GCPRO1 (stuffstring
);
10900 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10901 reset_all_sys_modes ();
10902 /* sys_suspend can get an error if it tries to fork a subshell
10903 and the system resources aren't available for that. */
10904 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10906 stuff_buffered_input (stuffstring
);
10907 if (cannot_suspend
)
10911 unbind_to (count
, Qnil
);
10913 /* Check if terminal/window size has changed.
10914 Note that this is not useful when we are running directly
10915 with a window system; but suspend should be disabled in that case. */
10916 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10917 if (width
!= old_width
|| height
!= old_height
)
10918 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10920 /* Run suspend-resume-hook. */
10921 if (!NILP (Vrun_hooks
))
10922 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10928 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10929 Then in any case stuff anything Emacs has read ahead and not used. */
10932 stuff_buffered_input (stuffstring
)
10933 Lisp_Object stuffstring
;
10935 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10936 register unsigned char *p
;
10938 if (STRINGP (stuffstring
))
10940 register int count
;
10942 p
= SDATA (stuffstring
);
10943 count
= SBYTES (stuffstring
);
10944 while (count
-- > 0)
10949 /* Anything we have read ahead, put back for the shell to read. */
10950 /* ?? What should this do when we have multiple keyboards??
10951 Should we ignore anything that was typed in at the "wrong" kboard?
10953 rms: we should stuff everything back into the kboard
10955 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10958 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10959 kbd_fetch_ptr
= kbd_buffer
;
10960 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10961 stuff_char (kbd_fetch_ptr
->code
);
10963 clear_event (kbd_fetch_ptr
);
10967 #endif /* SIGTSTP */
10971 set_waiting_for_input (time_to_clear
)
10972 EMACS_TIME
*time_to_clear
;
10974 input_available_clear_time
= time_to_clear
;
10976 /* Tell handle_interrupt to throw back to read_char, */
10977 waiting_for_input
= 1;
10979 /* If handle_interrupt was called before and buffered a C-g,
10980 make it run again now, to avoid timing error. */
10981 if (!NILP (Vquit_flag
))
10982 quit_throw_to_read_char ();
10986 clear_waiting_for_input ()
10988 /* Tell handle_interrupt not to throw back to read_char, */
10989 waiting_for_input
= 0;
10990 input_available_clear_time
= 0;
10993 /* The SIGINT handler.
10995 If we have a frame on the controlling tty, we assume that the
10996 SIGINT was generated by C-g, so we call handle_interrupt.
10997 Otherwise, the handler kills Emacs. */
11000 interrupt_signal (signalnum
) /* If we don't have an argument, */
11001 int signalnum
; /* some compilers complain in signal calls. */
11003 /* Must preserve main program's value of errno. */
11004 int old_errno
= errno
;
11005 struct terminal
*terminal
;
11007 #if defined (USG) && !defined (POSIX_SIGNALS)
11008 /* USG systems forget handlers when they are used;
11009 must reestablish each time */
11010 signal (SIGINT
, interrupt_signal
);
11011 signal (SIGQUIT
, interrupt_signal
);
11014 SIGNAL_THREAD_CHECK (signalnum
);
11016 /* See if we have an active terminal on our controlling tty. */
11017 terminal
= get_named_tty ("/dev/tty");
11020 /* If there are no frames there, let's pretend that we are a
11021 well-behaving UN*X program and quit. */
11022 Fkill_emacs (Qnil
);
11026 /* Otherwise, the SIGINT was probably generated by C-g. */
11028 /* Set internal_last_event_frame to the top frame of the
11029 controlling tty, if we have a frame there. We disable the
11030 interrupt key on secondary ttys, so the SIGINT must have come
11031 from the controlling tty. */
11032 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
11034 handle_interrupt ();
11040 /* This routine is called at interrupt level in response to C-g.
11042 It is called from the SIGINT handler or kbd_buffer_store_event.
11044 If `waiting_for_input' is non zero, then unless `echoing' is
11045 nonzero, immediately throw back to read_char.
11047 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
11048 eval to throw, when it gets a chance. If quit-flag is already
11049 non-nil, it stops the job right away. */
11052 handle_interrupt ()
11058 /* XXX This code needs to be revised for multi-tty support. */
11059 if (!NILP (Vquit_flag
)
11061 && get_named_tty ("/dev/tty")
11065 /* If SIGINT isn't blocked, don't let us be interrupted by
11066 another SIGINT, it might be harmful due to non-reentrancy
11067 in I/O functions. */
11068 sigblock (sigmask (SIGINT
));
11071 reset_all_sys_modes ();
11073 #ifdef SIGTSTP /* Support possible in later USG versions */
11075 * On systems which can suspend the current process and return to the original
11076 * shell, this command causes the user to end up back at the shell.
11077 * The "Auto-save" and "Abort" questions are not asked until
11078 * the user elects to return to emacs, at which point he can save the current
11079 * job and either dump core or continue.
11084 if (sys_suspend () == -1)
11086 printf ("Not running as a subprocess;\n");
11087 printf ("you can continue or abort.\n");
11089 #else /* not VMS */
11090 /* Perhaps should really fork an inferior shell?
11091 But that would not provide any way to get back
11092 to the original shell, ever. */
11093 printf ("No support for stopping a process on this operating system;\n");
11094 printf ("you can continue or abort.\n");
11095 #endif /* not VMS */
11096 #endif /* not SIGTSTP */
11098 /* We must remain inside the screen area when the internal terminal
11099 is used. Note that [Enter] is not echoed by dos. */
11102 /* It doesn't work to autosave while GC is in progress;
11103 the code used for auto-saving doesn't cope with the mark bit. */
11104 if (!gc_in_progress
)
11106 printf ("Auto-save? (y or n) ");
11108 if (((c
= getchar ()) & ~040) == 'Y')
11110 Fdo_auto_save (Qt
, Qnil
);
11112 printf ("\r\nAuto-save done");
11113 #else /* not MSDOS */
11114 printf ("Auto-save done\n");
11115 #endif /* not MSDOS */
11117 while (c
!= '\n') c
= getchar ();
11121 /* During GC, it must be safe to reenable quitting again. */
11122 Vinhibit_quit
= Qnil
;
11125 #endif /* not MSDOS */
11126 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11127 printf ("but will instead do a real quit after garbage collection ends\r\n");
11132 printf ("\r\nAbort? (y or n) ");
11133 #else /* not MSDOS */
11135 printf ("Abort (and enter debugger)? (y or n) ");
11136 #else /* not VMS */
11137 printf ("Abort (and dump core)? (y or n) ");
11138 #endif /* not VMS */
11139 #endif /* not MSDOS */
11141 if (((c
= getchar ()) & ~040) == 'Y')
11143 while (c
!= '\n') c
= getchar ();
11145 printf ("\r\nContinuing...\r\n");
11146 #else /* not MSDOS */
11147 printf ("Continuing...\n");
11148 #endif /* not MSDOS */
11150 init_all_sys_modes ();
11155 /* If executing a function that wants to be interrupted out of
11156 and the user has not deferred quitting by binding `inhibit-quit'
11157 then quit right away. */
11158 if (immediate_quit
&& NILP (Vinhibit_quit
))
11160 struct gl_state_s saved
;
11161 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11163 immediate_quit
= 0;
11166 GCPRO4 (saved
.object
, saved
.global_code
,
11167 saved
.current_syntax_table
, saved
.old_prop
);
11168 Fsignal (Qquit
, Qnil
);
11173 /* Else request quit when it's safe */
11177 if (waiting_for_input
&& !echoing
)
11178 quit_throw_to_read_char ();
11181 /* Handle a C-g by making read_char return C-g. */
11184 quit_throw_to_read_char ()
11187 /* Prevent another signal from doing this before we finish. */
11188 clear_waiting_for_input ();
11191 Vunread_command_events
= Qnil
;
11192 unread_command_char
= -1;
11194 #if 0 /* Currently, sit_for is called from read_char without turning
11195 off polling. And that can call set_waiting_for_input.
11196 It seems to be harmless. */
11197 #ifdef POLL_FOR_INPUT
11198 /* May be > 1 if in recursive minibuffer. */
11199 if (poll_suppress_count
== 0)
11203 if (FRAMEP (internal_last_event_frame
)
11204 && !EQ (internal_last_event_frame
, selected_frame
))
11205 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11208 _longjmp (getcjmp
, 1);
11211 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11212 doc
: /* Set interrupt mode of reading keyboard input.
11213 If INTERRUPT is non-nil, Emacs will use input interrupts;
11214 otherwise Emacs uses CBREAK mode.
11216 See also `current-input-mode'. */)
11218 Lisp_Object interrupt
;
11220 int new_interrupt_input
;
11222 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11223 #ifdef HAVE_X_WINDOWS
11224 if (x_display_list
!= NULL
)
11226 /* When using X, don't give the user a real choice,
11227 because we haven't implemented the mechanisms to support it. */
11228 #ifdef NO_SOCK_SIGIO
11229 new_interrupt_input
= 0;
11230 #else /* not NO_SOCK_SIGIO */
11231 new_interrupt_input
= 1;
11232 #endif /* NO_SOCK_SIGIO */
11236 new_interrupt_input
= !NILP (interrupt
);
11237 #else /* not SIGIO */
11238 new_interrupt_input
= 0;
11239 #endif /* not SIGIO */
11241 /* Our VMS input only works by interrupts, as of now. */
11243 new_interrupt_input
= 1;
11246 if (new_interrupt_input
!= interrupt_input
)
11248 #ifdef POLL_FOR_INPUT
11252 /* this causes startup screen to be restored and messes with the mouse */
11253 reset_all_sys_modes ();
11255 interrupt_input
= new_interrupt_input
;
11257 init_all_sys_modes ();
11260 #ifdef POLL_FOR_INPUT
11261 poll_suppress_count
= 1;
11268 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11269 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11270 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11271 C-q in key sequences.
11273 This setting only has an effect on tty terminals and only when
11274 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11276 See also `current-input-mode'. */)
11278 Lisp_Object flow
, terminal
;
11280 struct terminal
*t
= get_terminal (terminal
, 1);
11281 struct tty_display_info
*tty
;
11282 if (t
== NULL
|| t
->type
!= output_termcap
)
11284 tty
= t
->display_info
.tty
;
11286 if (tty
->flow_control
!= !NILP (flow
))
11289 /* this causes startup screen to be restored and messes with the mouse */
11290 reset_sys_modes (tty
);
11293 tty
->flow_control
= !NILP (flow
);
11296 init_sys_modes (tty
);
11302 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11303 doc
: /* Enable or disable 8-bit input on TERMINAL.
11304 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11305 bit as the Meta modifier.
11307 If META is nil, Emacs will ignore the top bit, on the assumption it is
11310 Otherwise, Emacs will accept and pass through 8-bit input without
11311 specially interpreting the top bit.
11313 This setting only has an effect on tty terminal devices.
11315 Optional parameter TERMINAL specifies the tty terminal device to use.
11316 It may be a terminal id, a frame, or nil for the terminal used by the
11317 currently selected frame.
11319 See also `current-input-mode'. */)
11321 Lisp_Object meta
, terminal
;
11323 struct terminal
*t
= get_terminal (terminal
, 1);
11324 struct tty_display_info
*tty
;
11327 if (t
== NULL
|| t
->type
!= output_termcap
)
11329 tty
= t
->display_info
.tty
;
11333 else if (EQ (meta
, Qt
))
11338 if (tty
->meta_key
!= new_meta
)
11341 /* this causes startup screen to be restored and messes with the mouse */
11342 reset_sys_modes (tty
);
11345 tty
->meta_key
= new_meta
;
11348 init_sys_modes (tty
);
11354 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11355 doc
: /* Specify character used for quitting.
11356 QUIT must be an ASCII character.
11358 This function only has an effect on the controlling tty of the Emacs
11361 See also `current-input-mode'. */)
11365 struct terminal
*t
= get_named_tty ("/dev/tty");
11366 struct tty_display_info
*tty
;
11367 if (t
== NULL
|| t
->type
!= output_termcap
)
11369 tty
= t
->display_info
.tty
;
11371 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11372 error ("QUIT must be an ASCII character");
11375 /* this causes startup screen to be restored and messes with the mouse */
11376 reset_sys_modes (tty
);
11379 /* Don't let this value be out of range. */
11380 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11383 init_sys_modes (tty
);
11389 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11390 doc
: /* Set mode of reading keyboard input.
11391 First arg INTERRUPT non-nil means use input interrupts;
11392 nil means use CBREAK mode.
11393 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11394 (no effect except in CBREAK mode).
11395 Third arg META t means accept 8-bit input (for a Meta key).
11396 META nil means ignore the top bit, on the assumption it is parity.
11397 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11398 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11399 See also `current-input-mode'. */)
11400 (interrupt
, flow
, meta
, quit
)
11401 Lisp_Object interrupt
, flow
, meta
, quit
;
11403 Fset_input_interrupt_mode (interrupt
);
11404 Fset_output_flow_control (flow
, Qnil
);
11405 Fset_input_meta_mode (meta
, Qnil
);
11407 Fset_quit_char (quit
);
11411 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11412 doc
: /* Return information about the way Emacs currently reads keyboard input.
11413 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11414 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11415 nil, Emacs is using CBREAK mode.
11416 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11417 terminal; this does not apply if Emacs uses interrupt-driven input.
11418 META is t if accepting 8-bit input with 8th bit as Meta flag.
11419 META nil means ignoring the top bit, on the assumption it is parity.
11420 META is neither t nor nil if accepting 8-bit input and using
11421 all 8 bits as the character code.
11422 QUIT is the character Emacs currently uses to quit.
11423 The elements of this list correspond to the arguments of
11424 `set-input-mode'. */)
11427 Lisp_Object val
[4];
11428 struct frame
*sf
= XFRAME (selected_frame
);
11430 val
[0] = interrupt_input
? Qt
: Qnil
;
11431 if (FRAME_TERMCAP_P (sf
))
11433 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11434 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11436 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11443 XSETFASTINT (val
[3], quit_char
);
11445 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11448 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11449 doc
: /* Return position information for pixel coordinates X and Y.
11450 By default, X and Y are relative to text area of the selected window.
11451 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11452 If optional fourth arg WHOLE is non-nil, X is relative to the left
11453 edge of the window.
11455 The return value is similar to a mouse click position:
11456 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11457 IMAGE (DX . DY) (WIDTH . HEIGHT))
11458 The `posn-' functions access elements of such lists. */)
11459 (x
, y
, frame_or_window
, whole
)
11460 Lisp_Object x
, y
, frame_or_window
, whole
;
11465 if (NILP (frame_or_window
))
11466 frame_or_window
= selected_window
;
11468 if (WINDOWP (frame_or_window
))
11472 CHECK_LIVE_WINDOW (frame_or_window
);
11474 w
= XWINDOW (frame_or_window
);
11475 XSETINT (x
, (XINT (x
)
11476 + WINDOW_LEFT_EDGE_X (w
)
11478 ? window_box_left_offset (w
, TEXT_AREA
)
11480 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11481 frame_or_window
= w
->frame
;
11484 CHECK_LIVE_FRAME (frame_or_window
);
11486 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11489 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11490 doc
: /* Return position information for buffer POS in WINDOW.
11491 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11493 Return nil if position is not visible in window. Otherwise,
11494 the return value is similar to that returned by `event-start' for
11495 a mouse click at the upper left corner of the glyph corresponding
11496 to the given buffer position:
11497 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11498 IMAGE (DX . DY) (WIDTH . HEIGHT))
11499 The `posn-' functions access elements of such lists. */)
11501 Lisp_Object pos
, window
;
11506 window
= selected_window
;
11508 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11511 Lisp_Object x
= XCAR (tem
);
11512 Lisp_Object y
= XCAR (XCDR (tem
));
11514 /* Point invisible due to hscrolling? */
11517 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11525 * Set up a new kboard object with reasonable initial values.
11531 kb
->Voverriding_terminal_local_map
= Qnil
;
11532 kb
->Vlast_command
= Qnil
;
11533 kb
->Vreal_last_command
= Qnil
;
11534 kb
->Vkeyboard_translate_table
= Qnil
;
11535 kb
->Vlast_repeatable_command
= Qnil
;
11536 kb
->Vprefix_arg
= Qnil
;
11537 kb
->Vlast_prefix_arg
= Qnil
;
11538 kb
->kbd_queue
= Qnil
;
11539 kb
->kbd_queue_has_data
= 0;
11540 kb
->immediate_echo
= 0;
11541 kb
->echo_string
= Qnil
;
11542 kb
->echo_after_prompt
= -1;
11543 kb
->kbd_macro_buffer
= 0;
11544 kb
->kbd_macro_bufsize
= 0;
11545 kb
->defining_kbd_macro
= Qnil
;
11546 kb
->Vlast_kbd_macro
= Qnil
;
11547 kb
->reference_count
= 0;
11548 kb
->Vsystem_key_alist
= Qnil
;
11549 kb
->system_key_syms
= Qnil
;
11550 kb
->Vwindow_system
= Qt
; /* Unset. */
11551 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11552 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11553 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11554 kb
->Vdefault_minibuffer_frame
= Qnil
;
11558 * Destroy the contents of a kboard object, but not the object itself.
11559 * We use this just before deleting it, or if we're going to initialize
11560 * it a second time.
11566 xfree (kb
->kbd_macro_buffer
);
11569 #ifdef MULTI_KBOARD
11571 /* Free KB and memory referenced from it. */
11579 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11582 *kbp
= kb
->next_kboard
;
11584 /* Prevent a dangling reference to KB. */
11585 if (kb
== current_kboard
11586 && FRAMEP (selected_frame
)
11587 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11589 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11591 if (current_kboard
== kb
)
11599 #endif /* MULTI_KBOARD */
11604 /* This is correct before outermost invocation of the editor loop */
11605 command_loop_level
= -1;
11606 immediate_quit
= 0;
11607 quit_char
= Ctl ('g');
11608 Vunread_command_events
= Qnil
;
11609 unread_command_char
= -1;
11610 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11612 recent_keys_index
= 0;
11613 kbd_fetch_ptr
= kbd_buffer
;
11614 kbd_store_ptr
= kbd_buffer
;
11615 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11616 do_mouse_tracking
= Qnil
;
11619 interrupt_input_blocked
= 0;
11620 interrupt_input_pending
= 0;
11622 /* This means that command_loop_1 won't try to select anything the first
11624 internal_last_event_frame
= Qnil
;
11625 Vlast_event_frame
= internal_last_event_frame
;
11627 #ifdef MULTI_KBOARD
11628 current_kboard
= initial_kboard
;
11630 /* Re-initialize the keyboard again. */
11631 wipe_kboard (current_kboard
);
11632 init_kboard (current_kboard
);
11633 /* A value of nil for Vwindow_system normally means a tty, but we also use
11634 it for the initial terminal since there is no window system there. */
11635 current_kboard
->Vwindow_system
= Qnil
;
11637 if (!noninteractive
)
11639 /* Before multi-tty support, these handlers used to be installed
11640 only if the current session was a tty session. Now an Emacs
11641 session may have multiple display types, so we always handle
11642 SIGINT. There is special code in interrupt_signal to exit
11643 Emacs on SIGINT when there are no termcap frames on the
11644 controlling terminal. */
11645 signal (SIGINT
, interrupt_signal
);
11646 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11647 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11648 SIGQUIT and we can't tell which one it will give us. */
11649 signal (SIGQUIT
, interrupt_signal
);
11650 #endif /* HAVE_TERMIO */
11652 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11654 if (!noninteractive
)
11655 signal (SIGIO
, input_available_signal
);
11658 /* Use interrupt input by default, if it works and noninterrupt input
11659 has deficiencies. */
11661 #ifdef INTERRUPT_INPUT
11662 interrupt_input
= 1;
11664 interrupt_input
= 0;
11667 /* Our VMS input only works by interrupts, as of now. */
11669 interrupt_input
= 1;
11675 if (keyboard_init_hook
)
11676 (*keyboard_init_hook
) ();
11678 #ifdef POLL_FOR_INPUT
11679 poll_suppress_count
= 1;
11684 /* This type's only use is in syms_of_keyboard, to initialize the
11685 event header symbols and put properties on them. */
11686 struct event_head
{
11692 struct event_head head_table
[] = {
11693 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11694 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11695 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11696 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11697 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11698 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11699 /* `select-window' should be handled just like `switch-frame'
11700 in read_key_sequence. */
11701 {&Qselect_window
, "select-window", &Qswitch_frame
}
11705 syms_of_keyboard ()
11707 pending_funcalls
= Qnil
;
11709 Vlispy_mouse_stem
= build_string ("mouse");
11710 staticpro (&Vlispy_mouse_stem
);
11713 QCimage
= intern (":image");
11714 staticpro (&QCimage
);
11716 staticpro (&Qhelp_echo
);
11717 Qhelp_echo
= intern ("help-echo");
11720 Qrtl
= intern (":rtl");
11722 staticpro (&item_properties
);
11723 item_properties
= Qnil
;
11725 staticpro (&tool_bar_item_properties
);
11726 tool_bar_item_properties
= Qnil
;
11727 staticpro (&tool_bar_items_vector
);
11728 tool_bar_items_vector
= Qnil
;
11730 staticpro (&real_this_command
);
11731 real_this_command
= Qnil
;
11733 Qtimer_event_handler
= intern ("timer-event-handler");
11734 staticpro (&Qtimer_event_handler
);
11736 Qdisabled_command_function
= intern ("disabled-command-function");
11737 staticpro (&Qdisabled_command_function
);
11739 Qself_insert_command
= intern ("self-insert-command");
11740 staticpro (&Qself_insert_command
);
11742 Qforward_char
= intern ("forward-char");
11743 staticpro (&Qforward_char
);
11745 Qbackward_char
= intern ("backward-char");
11746 staticpro (&Qbackward_char
);
11748 Qdisabled
= intern ("disabled");
11749 staticpro (&Qdisabled
);
11751 Qundefined
= intern ("undefined");
11752 staticpro (&Qundefined
);
11754 Qpre_command_hook
= intern ("pre-command-hook");
11755 staticpro (&Qpre_command_hook
);
11757 Qpost_command_hook
= intern ("post-command-hook");
11758 staticpro (&Qpost_command_hook
);
11760 Qdeferred_action_function
= intern ("deferred-action-function");
11761 staticpro (&Qdeferred_action_function
);
11763 Qcommand_hook_internal
= intern ("command-hook-internal");
11764 staticpro (&Qcommand_hook_internal
);
11766 Qfunction_key
= intern ("function-key");
11767 staticpro (&Qfunction_key
);
11768 Qmouse_click
= intern ("mouse-click");
11769 staticpro (&Qmouse_click
);
11770 #if defined (WINDOWSNT) || defined (MAC_OS)
11771 Qlanguage_change
= intern ("language-change");
11772 staticpro (&Qlanguage_change
);
11774 Qdrag_n_drop
= intern ("drag-n-drop");
11775 staticpro (&Qdrag_n_drop
);
11777 Qsave_session
= intern ("save-session");
11778 staticpro (&Qsave_session
);
11781 Qmac_apple_event
= intern ("mac-apple-event");
11782 staticpro (&Qmac_apple_event
);
11786 Qdbus_event
= intern ("dbus-event");
11787 staticpro (&Qdbus_event
);
11790 Qmenu_enable
= intern ("menu-enable");
11791 staticpro (&Qmenu_enable
);
11792 Qmenu_alias
= intern ("menu-alias");
11793 staticpro (&Qmenu_alias
);
11794 QCenable
= intern (":enable");
11795 staticpro (&QCenable
);
11796 QCvisible
= intern (":visible");
11797 staticpro (&QCvisible
);
11798 QChelp
= intern (":help");
11799 staticpro (&QChelp
);
11800 QCfilter
= intern (":filter");
11801 staticpro (&QCfilter
);
11802 QCbutton
= intern (":button");
11803 staticpro (&QCbutton
);
11804 QCkeys
= intern (":keys");
11805 staticpro (&QCkeys
);
11806 QCkey_sequence
= intern (":key-sequence");
11807 staticpro (&QCkey_sequence
);
11808 QCtoggle
= intern (":toggle");
11809 staticpro (&QCtoggle
);
11810 QCradio
= intern (":radio");
11811 staticpro (&QCradio
);
11813 Qmode_line
= intern ("mode-line");
11814 staticpro (&Qmode_line
);
11815 Qvertical_line
= intern ("vertical-line");
11816 staticpro (&Qvertical_line
);
11817 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11818 staticpro (&Qvertical_scroll_bar
);
11819 Qmenu_bar
= intern ("menu-bar");
11820 staticpro (&Qmenu_bar
);
11822 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11823 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11824 staticpro (&Qmouse_fixup_help_message
);
11827 Qabove_handle
= intern ("above-handle");
11828 staticpro (&Qabove_handle
);
11829 Qhandle
= intern ("handle");
11830 staticpro (&Qhandle
);
11831 Qbelow_handle
= intern ("below-handle");
11832 staticpro (&Qbelow_handle
);
11833 Qup
= intern ("up");
11835 Qdown
= intern ("down");
11836 staticpro (&Qdown
);
11837 Qtop
= intern ("top");
11839 Qbottom
= intern ("bottom");
11840 staticpro (&Qbottom
);
11841 Qend_scroll
= intern ("end-scroll");
11842 staticpro (&Qend_scroll
);
11843 Qratio
= intern ("ratio");
11844 staticpro (&Qratio
);
11846 Qevent_kind
= intern ("event-kind");
11847 staticpro (&Qevent_kind
);
11848 Qevent_symbol_elements
= intern ("event-symbol-elements");
11849 staticpro (&Qevent_symbol_elements
);
11850 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11851 staticpro (&Qevent_symbol_element_mask
);
11852 Qmodifier_cache
= intern ("modifier-cache");
11853 staticpro (&Qmodifier_cache
);
11855 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11856 staticpro (&Qrecompute_lucid_menubar
);
11857 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11858 staticpro (&Qactivate_menubar_hook
);
11860 Qpolling_period
= intern ("polling-period");
11861 staticpro (&Qpolling_period
);
11863 Qinput_method_function
= intern ("input-method-function");
11864 staticpro (&Qinput_method_function
);
11866 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11867 staticpro (&Qinput_method_exit_on_first_char
);
11868 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11869 staticpro (&Qinput_method_use_echo_area
);
11871 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11872 Fset (Qinput_method_use_echo_area
, Qnil
);
11874 last_point_position_buffer
= Qnil
;
11875 last_point_position_window
= Qnil
;
11878 struct event_head
*p
;
11880 for (p
= head_table
;
11881 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11884 *p
->var
= intern (p
->name
);
11885 staticpro (p
->var
);
11886 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11887 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11891 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11892 staticpro (&button_down_location
);
11893 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11894 staticpro (&mouse_syms
);
11895 wheel_syms
= Fmake_vector (make_number (4), Qnil
);
11896 staticpro (&wheel_syms
);
11900 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11902 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11903 for (i
= 0; i
< len
; i
++)
11904 if (modifier_names
[i
])
11905 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11906 staticpro (&modifier_symbols
);
11909 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11910 staticpro (&recent_keys
);
11912 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11913 staticpro (&this_command_keys
);
11915 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11916 staticpro (&raw_keybuf
);
11918 Qextended_command_history
= intern ("extended-command-history");
11919 Fset (Qextended_command_history
, Qnil
);
11920 staticpro (&Qextended_command_history
);
11922 accent_key_syms
= Qnil
;
11923 staticpro (&accent_key_syms
);
11925 func_key_syms
= Qnil
;
11926 staticpro (&func_key_syms
);
11928 drag_n_drop_syms
= Qnil
;
11929 staticpro (&drag_n_drop_syms
);
11931 unread_switch_frame
= Qnil
;
11932 staticpro (&unread_switch_frame
);
11934 internal_last_event_frame
= Qnil
;
11935 staticpro (&internal_last_event_frame
);
11937 read_key_sequence_cmd
= Qnil
;
11938 staticpro (&read_key_sequence_cmd
);
11940 menu_bar_one_keymap_changed_items
= Qnil
;
11941 staticpro (&menu_bar_one_keymap_changed_items
);
11943 menu_bar_items_vector
= Qnil
;
11944 staticpro (&menu_bar_items_vector
);
11946 help_form_saved_window_configs
= Qnil
;
11947 staticpro (&help_form_saved_window_configs
);
11949 defsubr (&Scurrent_idle_time
);
11950 defsubr (&Sevent_symbol_parse_modifiers
);
11951 defsubr (&Sevent_convert_list
);
11952 defsubr (&Sread_key_sequence
);
11953 defsubr (&Sread_key_sequence_vector
);
11954 defsubr (&Srecursive_edit
);
11955 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11956 defsubr (&Strack_mouse
);
11958 defsubr (&Sinput_pending_p
);
11959 defsubr (&Scommand_execute
);
11960 defsubr (&Srecent_keys
);
11961 defsubr (&Sthis_command_keys
);
11962 defsubr (&Sthis_command_keys_vector
);
11963 defsubr (&Sthis_single_command_keys
);
11964 defsubr (&Sthis_single_command_raw_keys
);
11965 defsubr (&Sreset_this_command_lengths
);
11966 defsubr (&Sclear_this_command_keys
);
11967 defsubr (&Ssuspend_emacs
);
11968 defsubr (&Sabort_recursive_edit
);
11969 defsubr (&Sexit_recursive_edit
);
11970 defsubr (&Srecursion_depth
);
11971 defsubr (&Stop_level
);
11972 defsubr (&Sdiscard_input
);
11973 defsubr (&Sopen_dribble_file
);
11974 defsubr (&Sset_input_interrupt_mode
);
11975 defsubr (&Sset_output_flow_control
);
11976 defsubr (&Sset_input_meta_mode
);
11977 defsubr (&Sset_quit_char
);
11978 defsubr (&Sset_input_mode
);
11979 defsubr (&Scurrent_input_mode
);
11980 defsubr (&Sexecute_extended_command
);
11981 defsubr (&Sposn_at_point
);
11982 defsubr (&Sposn_at_x_y
);
11984 DEFVAR_LISP ("last-command-char", &last_command_char
,
11985 doc
: /* Last input event that was part of a command. */);
11987 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11988 doc
: /* Last input event that was part of a command. */);
11990 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11991 doc
: /* Last input event in a command, except for mouse menu events.
11992 Mouse menus give back keys that don't look like mouse events;
11993 this variable holds the actual mouse event that led to the menu,
11994 so that you can determine whether the command was run by mouse or not. */);
11996 DEFVAR_LISP ("last-input-char", &last_input_char
,
11997 doc
: /* Last input event. */);
11999 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
12000 doc
: /* Last input event. */);
12002 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
12003 doc
: /* List of events to be read as the command input.
12004 These events are processed first, before actual keyboard input.
12005 Events read from this list are not normally added to `this-command-keys',
12006 as they will already have been added once as they were read for the first time.
12007 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
12008 Vunread_command_events
= Qnil
;
12010 DEFVAR_INT ("unread-command-char", &unread_command_char
,
12011 doc
: /* If not -1, an object to be read as next command input event. */);
12013 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
12014 doc
: /* List of events to be processed as input by input methods.
12015 These events are processed before `unread-command-events'
12016 and actual keyboard input, but are not given to `input-method-function'. */);
12017 Vunread_post_input_method_events
= Qnil
;
12019 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
12020 doc
: /* List of events to be processed as input by input methods.
12021 These events are processed after `unread-command-events', but
12022 before actual keyboard input.
12023 If there's an active input method, the events are given to
12024 `input-method-function'. */);
12025 Vunread_input_method_events
= Qnil
;
12027 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
12028 doc
: /* Meta-prefix character code.
12029 Meta-foo as command input turns into this character followed by foo. */);
12030 XSETINT (meta_prefix_char
, 033);
12032 DEFVAR_KBOARD ("last-command", Vlast_command
,
12033 doc
: /* The last command executed.
12034 Normally a symbol with a function definition, but can be whatever was found
12035 in the keymap, or whatever the variable `this-command' was set to by that
12038 The value `mode-exit' is special; it means that the previous command
12039 read an event that told it to exit, and it did so and unread that event.
12040 In other words, the present command is the event that made the previous
12043 The value `kill-region' is special; it means that the previous command
12044 was a kill command.
12046 `last-command' has a separate binding for each terminal device.
12047 See Info node `(elisp)Multiple displays'. */);
12049 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
12050 doc
: /* Same as `last-command', but never altered by Lisp code. */);
12052 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
12053 doc
: /* Last command that may be repeated.
12054 The last command executed that was not bound to an input event.
12055 This is the command `repeat' will try to repeat. */);
12057 DEFVAR_LISP ("this-command", &Vthis_command
,
12058 doc
: /* The command now being executed.
12059 The command can set this variable; whatever is put here
12060 will be in `last-command' during the following command. */);
12061 Vthis_command
= Qnil
;
12063 DEFVAR_LISP ("this-command-keys-shift-translated",
12064 &Vthis_command_keys_shift_translated
,
12065 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
12066 Shift-translation occurs when there is no binding for the key sequence
12067 as entered, but a binding was found by changing an upper-case letter
12068 to lower-case, or a shifted function key to an unshifted one. */);
12069 Vthis_command_keys_shift_translated
= Qnil
;
12071 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
12072 doc
: /* The command bound to the current key sequence before remapping.
12073 It equals `this-command' if the original command was not remapped through
12074 any of the active keymaps. Otherwise, the value of `this-command' is the
12075 result of looking up the original command in the active keymaps. */);
12076 Vthis_original_command
= Qnil
;
12078 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
12079 doc
: /* *Number of input events between auto-saves.
12080 Zero means disable autosaving due to number of characters typed. */);
12081 auto_save_interval
= 300;
12083 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
12084 doc
: /* *Number of seconds idle time before auto-save.
12085 Zero or nil means disable auto-saving due to idleness.
12086 After auto-saving due to this many seconds of idle time,
12087 Emacs also does a garbage collection if that seems to be warranted. */);
12088 XSETFASTINT (Vauto_save_timeout
, 30);
12090 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
12091 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
12092 The value may be integer or floating point. */);
12093 Vecho_keystrokes
= make_number (1);
12095 DEFVAR_INT ("polling-period", &polling_period
,
12096 doc
: /* *Interval between polling for input during Lisp execution.
12097 The reason for polling is to make C-g work to stop a running program.
12098 Polling is needed only when using X windows and SIGIO does not work.
12099 Polling is automatically disabled in all other cases. */);
12100 polling_period
= 2;
12102 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
12103 doc
: /* *Maximum time between mouse clicks to make a double-click.
12104 Measured in milliseconds. The value nil means disable double-click
12105 recognition; t means double-clicks have no time limit and are detected
12106 by position only. */);
12107 Vdouble_click_time
= make_number (500);
12109 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
12110 doc
: /* *Maximum mouse movement between clicks to make a double-click.
12111 On window-system frames, value is the number of pixels the mouse may have
12112 moved horizontally or vertically between two clicks to make a double-click.
12113 On non window-system frames, value is interpreted in units of 1/8 characters
12116 This variable is also the threshold for motion of the mouse
12117 to count as a drag. */);
12118 double_click_fuzz
= 3;
12120 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
12121 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
12122 inhibit_local_menu_bar_menus
= 0;
12124 DEFVAR_INT ("num-input-keys", &num_input_keys
,
12125 doc
: /* Number of complete key sequences read as input so far.
12126 This includes key sequences read from keyboard macros.
12127 The number is effectively the number of interactive command invocations. */);
12128 num_input_keys
= 0;
12130 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
12131 doc
: /* Number of input events read from the keyboard so far.
12132 This does not include events generated by keyboard macros. */);
12133 num_nonmacro_input_events
= 0;
12135 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
12136 doc
: /* The frame in which the most recently read event occurred.
12137 If the last event came from a keyboard macro, this is set to `macro'. */);
12138 Vlast_event_frame
= Qnil
;
12140 /* This variable is set up in sysdep.c. */
12141 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
12142 doc
: /* The ERASE character as set by the user with stty. */);
12144 DEFVAR_LISP ("help-char", &Vhelp_char
,
12145 doc
: /* Character to recognize as meaning Help.
12146 When it is read, do `(eval help-form)', and display result if it's a string.
12147 If the value of `help-form' is nil, this char can be read normally. */);
12148 XSETINT (Vhelp_char
, Ctl ('H'));
12150 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
12151 doc
: /* List of input events to recognize as meaning Help.
12152 These work just like the value of `help-char' (see that). */);
12153 Vhelp_event_list
= Qnil
;
12155 DEFVAR_LISP ("help-form", &Vhelp_form
,
12156 doc
: /* Form to execute when character `help-char' is read.
12157 If the form returns a string, that string is displayed.
12158 If `help-form' is nil, the help char is not recognized. */);
12161 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12162 doc
: /* Command to run when `help-char' character follows a prefix key.
12163 This command is used only when there is no actual binding
12164 for that character after that prefix key. */);
12165 Vprefix_help_command
= Qnil
;
12167 DEFVAR_LISP ("top-level", &Vtop_level
,
12168 doc
: /* Form to evaluate when Emacs starts up.
12169 Useful to set before you dump a modified Emacs. */);
12172 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12173 doc
: /* Translate table for local keyboard input, or nil.
12174 If non-nil, the value should be a char-table. Each character read
12175 from the keyboard is looked up in this char-table. If the value found
12176 there is non-nil, then it is used instead of the actual input character.
12178 The value can also be a string or vector, but this is considered obsolete.
12179 If it is a string or vector of length N, character codes N and up are left
12180 untranslated. In a vector, an element which is nil means "no translation".
12182 This is applied to the characters supplied to input methods, not their
12183 output. See also `translation-table-for-input'.
12185 This variable has a separate binding for each terminal. See Info node
12186 `(elisp)Multiple displays'. */);
12188 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12189 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12190 \(Even if the operating system has support for stopping a process.\) */);
12191 cannot_suspend
= 0;
12193 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12194 doc
: /* Non-nil means prompt with menus when appropriate.
12195 This is done when reading from a keymap that has a prompt string,
12196 for elements that have prompt strings.
12197 The menu is displayed on the screen
12198 if X menus were enabled at configuration
12199 time and the previous event was a mouse click prefix key.
12200 Otherwise, menu prompting uses the echo area. */);
12201 menu_prompting
= 1;
12203 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12204 doc
: /* Character to see next line of menu prompt.
12205 Type this character while in a menu prompt to rotate around the lines of it. */);
12206 XSETINT (menu_prompt_more_char
, ' ');
12208 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12209 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12210 Emacs applies the modifiers of the character stored here to each keyboard
12211 character it reads. For example, after evaluating the expression
12212 (setq extra-keyboard-modifiers ?\\C-x)
12213 all input characters will have the control modifier applied to them.
12215 Note that the character ?\\C-@, equivalent to the integer zero, does
12216 not count as a control character; rather, it counts as a character
12217 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12218 cancels any modification. */);
12219 extra_keyboard_modifiers
= 0;
12221 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12222 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12223 The command loop sets this to nil before each command,
12224 and tests the value when the command returns.
12225 Buffer modification stores t in this variable. */);
12226 Vdeactivate_mark
= Qnil
;
12227 Qdeactivate_mark
= intern ("deactivate-mark");
12228 staticpro (&Qdeactivate_mark
);
12230 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12231 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
12232 Vcommand_hook_internal
= Qnil
;
12234 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12235 doc
: /* Normal hook run before each command is executed.
12236 If an unhandled error happens in running this hook,
12237 the hook value is set to nil, since otherwise the error
12238 might happen repeatedly and make Emacs nonfunctional. */);
12239 Vpre_command_hook
= Qnil
;
12241 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12242 doc
: /* Normal hook run after each command is executed.
12243 If an unhandled error happens in running this hook,
12244 the hook value is set to nil, since otherwise the error
12245 might happen repeatedly and make Emacs nonfunctional. */);
12246 Vpost_command_hook
= Qnil
;
12249 DEFVAR_LISP ("echo-area-clear-hook", ...,
12250 doc
: /* Normal hook run when clearing the echo area. */);
12252 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
12253 staticpro (&Qecho_area_clear_hook
);
12254 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
12256 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12257 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12258 Vlucid_menu_bar_dirty_flag
= Qnil
;
12260 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12261 doc
: /* List of menu bar items to move to the end of the menu bar.
12262 The elements of the list are event types that may have menu bar bindings. */);
12263 Vmenu_bar_final_items
= Qnil
;
12265 DEFVAR_KBOARD ("overriding-terminal-local-map",
12266 Voverriding_terminal_local_map
,
12267 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12268 If this variable is non-nil, it is used as a keymap instead of the
12269 buffer's local map, and the minor mode keymaps and text property keymaps.
12270 It also replaces `overriding-local-map'.
12272 This variable is intended to let commands such as `universal-argument'
12273 set up a different keymap for reading the next command.
12275 `overriding-terminal-local-map' has a separate binding for each
12277 See Info node `(elisp)Multiple displays'. */);
12279 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12280 doc
: /* Keymap that overrides all other local keymaps.
12281 If this variable is non-nil, it is used as a keymap--replacing the
12282 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12283 Voverriding_local_map
= Qnil
;
12285 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12286 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12287 Otherwise, the menu bar continues to reflect the buffer's local map
12288 and the minor mode maps regardless of `overriding-local-map'. */);
12289 Voverriding_local_map_menu_flag
= Qnil
;
12291 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12292 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12293 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
12295 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12296 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12298 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12299 doc
: /* Alist of system-specific X windows key symbols.
12300 Each element should have the form (N . SYMBOL) where N is the
12301 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12302 and SYMBOL is its name.
12304 `system-key-alist' has a separate binding for each terminal device.
12305 See Info node `(elisp)Multiple displays'. */);
12307 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12308 doc
: /* Keymap that translates key sequences to key sequences during input.
12309 This is used mainly for mapping key sequences into some preferred
12310 key events (symbols).
12312 The `read-key-sequence' function replaces any subsequence bound by
12313 `local-function-key-map' with its binding. More precisely, when the
12314 active keymaps have no binding for the current key sequence but
12315 `local-function-key-map' binds a suffix of the sequence to a vector or
12316 string, `read-key-sequence' replaces the matching suffix with its
12317 binding, and continues with the new sequence.
12319 If the binding is a function, it is called with one argument (the prompt)
12320 and its return value (a key sequence) is used.
12322 The events that come from bindings in `local-function-key-map' are not
12323 themselves looked up in `local-function-key-map'.
12325 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12326 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12327 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12328 typing `ESC O P x' would return [f1 x].
12330 `local-function-key-map' has a separate binding for each terminal
12331 device. See Info node `(elisp)Multiple displays'. If you need to
12332 define a binding on all terminals, change `function-key-map'
12333 instead. Initially, `local-function-key-map' is an empty keymap that
12334 has `function-key-map' as its parent on all terminal devices. */);
12336 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12337 doc
: /* Keymap that decodes input escape sequences.
12338 This is used mainly for mapping ASCII function key sequences into
12339 real Emacs function key events (symbols).
12341 The `read-key-sequence' function replaces any subsequence bound by
12342 `local-function-key-map' with its binding. Contrary to `function-key-map',
12343 this map applies its rebinding regardless of the presence of an ordinary
12344 binding. So it is more like `key-translation-map' except that it applies
12345 before `function-key-map' rather than after.
12347 If the binding is a function, it is called with one argument (the prompt)
12348 and its return value (a key sequence) is used.
12350 The events that come from bindings in `input-decode-map' are not
12351 themselves looked up in `input-decode-map'.
12353 This variable is keyboard-local. */);
12355 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12356 doc
: /* The parent keymap of all `local-function-key-map' instances.
12357 Function key definitions that apply to all terminal devices should go
12358 here. If a mapping is defined in both the current
12359 `local-function-key-map' binding and this variable, then the local
12360 definition will take precendence. */);
12361 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12363 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12364 doc
: /* Keymap of key translations that can override keymaps.
12365 This keymap works like `function-key-map', but comes after that,
12366 and its non-prefix bindings override ordinary bindings.
12367 Another difference is that it is global rather than keyboard-local. */);
12368 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12370 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12371 doc
: /* List of deferred actions to be performed at a later time.
12372 The precise format isn't relevant here; we just check whether it is nil. */);
12373 Vdeferred_action_list
= Qnil
;
12375 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12376 doc
: /* Function to call to handle deferred actions, after each command.
12377 This function is called with no arguments after each command
12378 whenever `deferred-action-list' is non-nil. */);
12379 Vdeferred_action_function
= Qnil
;
12381 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12382 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12383 The value can be a length of time to show the message for.
12384 If the value is non-nil and not a number, we wait 2 seconds. */);
12385 Vsuggest_key_bindings
= Qt
;
12387 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12388 doc
: /* List of active absolute time timers in order of increasing time. */);
12389 Vtimer_list
= Qnil
;
12391 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12392 doc
: /* List of active idle-time timers in order of increasing time. */);
12393 Vtimer_idle_list
= Qnil
;
12395 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12396 doc
: /* If non-nil, the function that implements the current input method.
12397 It's called with one argument, a printing character that was just read.
12398 \(That means a character with code 040...0176.)
12399 Typically this function uses `read-event' to read additional events.
12400 When it does so, it should first bind `input-method-function' to nil
12401 so it will not be called recursively.
12403 The function should return a list of zero or more events
12404 to be used as input. If it wants to put back some events
12405 to be reconsidered, separately, by the input method,
12406 it can add them to the beginning of `unread-command-events'.
12408 The input method function can find in `input-method-previous-method'
12409 the previous echo area message.
12411 The input method function should refer to the variables
12412 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12413 for guidance on what to do. */);
12414 Vinput_method_function
= Qnil
;
12416 DEFVAR_LISP ("input-method-previous-message",
12417 &Vinput_method_previous_message
,
12418 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12419 This variable exists because `read-event' clears the echo area
12420 before running the input method. It is nil if there was no message. */);
12421 Vinput_method_previous_message
= Qnil
;
12423 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12424 doc
: /* If non-nil, the function that implements the display of help.
12425 It's called with one argument, the help string to display. */);
12426 Vshow_help_function
= Qnil
;
12428 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12429 doc
: /* If non-nil, suppress point adjustment after executing a command.
12431 After a command is executed, if point is moved into a region that has
12432 special properties (e.g. composition, display), we adjust point to
12433 the boundary of the region. But, when a command sets this variable to
12434 non-nil, we suppress the point adjustment.
12436 This variable is set to nil before reading a command, and is checked
12437 just after executing the command. */);
12438 Vdisable_point_adjustment
= Qnil
;
12440 DEFVAR_LISP ("global-disable-point-adjustment",
12441 &Vglobal_disable_point_adjustment
,
12442 doc
: /* *If non-nil, always suppress point adjustment.
12444 The default value is nil, in which case, point adjustment are
12445 suppressed only after special commands that set
12446 `disable-point-adjustment' (which see) to non-nil. */);
12447 Vglobal_disable_point_adjustment
= Qnil
;
12449 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12450 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12451 If the value is not a number, such messages don't time out. */);
12452 Vminibuffer_message_timeout
= make_number (2);
12454 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12455 doc
: /* If non-nil, any keyboard input throws to this symbol.
12456 The value of that variable is passed to `quit-flag' and later causes a
12457 peculiar kind of quitting. */);
12458 Vthrow_on_input
= Qnil
;
12460 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12461 doc
: /* If non-nil, function to output error messages.
12462 The arguments are the error data, a list of the form
12463 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12464 such as just as `condition-case' would bind its variable to,
12465 the context (a string which normally goes at the start of the message),
12466 and the Lisp function within which the error was signaled. */);
12467 Vcommand_error_function
= Qnil
;
12469 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12470 &Venable_disabled_menus_and_buttons
,
12471 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12473 Help functions bind this to allow help on disabled menu items
12474 and tool-bar buttons. */);
12475 Venable_disabled_menus_and_buttons
= Qnil
;
12477 #ifdef MULTI_KBOARD
12478 /* Create the initial keyboard. */
12479 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12480 init_kboard (initial_kboard
);
12481 /* Vwindow_system is left at t for now. */
12482 initial_kboard
->next_kboard
= all_kboards
;
12483 all_kboards
= initial_kboard
;
12488 keys_of_keyboard ()
12490 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12491 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12492 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12493 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12494 initial_define_key (meta_map
, 'x', "execute-extended-command");
12496 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12497 "handle-delete-frame");
12498 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12499 current-prefix-arg, as is done in `handle-switch-frame'.
12500 But `handle-switch-frame is not run from the special-map.
12501 Commands from that map are run in a special way that automatically
12502 preserves the prefix-arg. Restoring the prefix arg here is not just
12503 redundant but harmful:
12505 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12506 - after the first prompt, the exit-minibuffer-hook is run which may
12507 iconify a frame and thus push a `iconify-frame' event.
12508 - after running exit-minibuffer-hook, current-prefix-arg is
12509 restored to the non-nil value it had before the prompt.
12510 - we enter the second prompt.
12511 current-prefix-arg is non-nil, prefix-arg is nil.
12512 - before running the first real event, we run the special iconify-frame
12513 event, but we pass the `special' arg to execute-command so
12514 current-prefix-arg and prefix-arg are left untouched.
12515 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12516 - the next key event will have a spuriously non-nil current-prefix-arg. */
12517 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12519 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12521 /* Handling it at such a low-level causes read_key_sequence to get
12522 * confused because it doesn't realize that the current_buffer was
12523 * changed by read_char.
12525 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12526 * "handle-select-window"); */
12527 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12528 "handle-save-session");
12531 /* Define a special event which is raised for dbus callback
12533 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12534 "dbus-handle-event");
12538 /* Mark the pointers in the kboard objects.
12539 Called by the Fgarbage_collector. */
12545 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12547 if (kb
->kbd_macro_buffer
)
12548 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12550 mark_object (kb
->Voverriding_terminal_local_map
);
12551 mark_object (kb
->Vlast_command
);
12552 mark_object (kb
->Vreal_last_command
);
12553 mark_object (kb
->Vkeyboard_translate_table
);
12554 mark_object (kb
->Vlast_repeatable_command
);
12555 mark_object (kb
->Vprefix_arg
);
12556 mark_object (kb
->Vlast_prefix_arg
);
12557 mark_object (kb
->kbd_queue
);
12558 mark_object (kb
->defining_kbd_macro
);
12559 mark_object (kb
->Vlast_kbd_macro
);
12560 mark_object (kb
->Vsystem_key_alist
);
12561 mark_object (kb
->system_key_syms
);
12562 mark_object (kb
->Vwindow_system
);
12563 mark_object (kb
->Vinput_decode_map
);
12564 mark_object (kb
->Vlocal_function_key_map
);
12565 mark_object (kb
->Vdefault_minibuffer_frame
);
12566 mark_object (kb
->echo_string
);
12569 struct input_event
*event
;
12570 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12572 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12573 event
= kbd_buffer
;
12574 if (event
->kind
!= SELECTION_REQUEST_EVENT
12575 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12577 mark_object (event
->x
);
12578 mark_object (event
->y
);
12580 mark_object (event
->frame_or_window
);
12581 mark_object (event
->arg
);
12586 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12587 (do not change this comment) */