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, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
30 #include "termhooks.h"
36 #include "character.h"
38 #include "dispextern.h"
40 #include "intervals.h"
42 #include "blockinput.h"
49 #ifdef HAVE_GTK_AND_PTHREAD
57 #include <sys/ioctl.h>
59 #endif /* not MSDOS */
61 #include "syssignal.h"
63 #include <sys/types.h>
72 /* This is to get the definitions of the XK_ symbols. */
79 #endif /* HAVE_NTGUI */
89 /* Variables for blockinput.h: */
91 /* Non-zero if interrupt input is blocked right now. */
92 volatile int interrupt_input_blocked
;
94 /* Nonzero means an input interrupt has arrived
95 during the current critical section. */
96 int interrupt_input_pending
;
98 #define KBD_BUFFER_SIZE 4096
101 KBOARD
*initial_kboard
;
102 KBOARD
*current_kboard
;
106 KBOARD the_only_kboard
;
109 /* Non-nil disable property on a command means
110 do not execute it; call disabled-command-function's value instead. */
111 Lisp_Object Qdisabled
, Qdisabled_command_function
;
113 #define NUM_RECENT_KEYS (300)
114 int recent_keys_index
; /* Index for storing next element into recent_keys */
115 int total_keys
; /* Total number of elements stored into recent_keys */
116 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
118 /* Vector holding the key sequence that invoked the current command.
119 It is reused for each command, and it may be longer than the current
120 sequence; this_command_key_count indicates how many elements
121 actually mean something.
122 It's easier to staticpro a single Lisp_Object than an array. */
123 Lisp_Object this_command_keys
;
124 int this_command_key_count
;
126 /* 1 after calling Freset_this_command_lengths.
128 int this_command_key_count_reset
;
130 /* This vector is used as a buffer to record the events that were actually read
131 by read_key_sequence. */
132 Lisp_Object raw_keybuf
;
133 int raw_keybuf_count
;
135 /* Non-nil if the present key sequence was obtained by shift translation. */
136 Lisp_Object Vthis_command_keys_shift_translated
;
138 #define GROW_RAW_KEYBUF \
139 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
140 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
142 /* Number of elements of this_command_keys
143 that precede this key sequence. */
144 int this_single_command_key_start
;
146 /* Record values of this_command_key_count and echo_length ()
147 before this command was read. */
148 static int before_command_key_count
;
149 static int before_command_echo_length
;
151 extern int minbuf_level
;
153 extern int message_enable_multibyte
;
155 /* If non-nil, the function that implements the display of help.
156 It's called with one argument, the help string to display. */
158 Lisp_Object Vshow_help_function
;
160 /* If a string, the message displayed before displaying a help-echo
163 Lisp_Object Vpre_help_message
;
165 /* Nonzero means do menu prompting. */
167 static int menu_prompting
;
169 /* Character to see next line of menu prompt. */
171 static Lisp_Object menu_prompt_more_char
;
173 /* For longjmp to where kbd input is being done. */
175 static jmp_buf getcjmp
;
177 /* True while doing kbd input. */
178 int waiting_for_input
;
180 /* True while displaying for echoing. Delays C-g throwing. */
184 /* Non-null means we can start echoing at the next input pause even
185 though there is something in the echo area. */
187 static struct kboard
*ok_to_echo_at_next_pause
;
189 /* The kboard last echoing, or null for none. Reset to 0 in
190 cancel_echoing. If non-null, and a current echo area message
191 exists, and echo_message_buffer is eq to the current message
192 buffer, we know that the message comes from echo_kboard. */
194 struct kboard
*echo_kboard
;
196 /* The buffer used for echoing. Set in echo_now, reset in
199 Lisp_Object echo_message_buffer
;
201 /* Nonzero means disregard local maps for the menu bar. */
202 static int inhibit_local_menu_bar_menus
;
204 /* Nonzero means C-g should cause immediate error-signal. */
207 /* The user's hook function for outputting an error message. */
208 Lisp_Object Vcommand_error_function
;
210 /* The user's ERASE setting. */
211 Lisp_Object Vtty_erase_char
;
213 /* Character to recognize as the help char. */
214 Lisp_Object Vhelp_char
;
216 /* List of other event types to recognize as meaning "help". */
217 Lisp_Object Vhelp_event_list
;
219 /* Form to execute when help char is typed. */
220 Lisp_Object Vhelp_form
;
222 /* Command to run when the help character follows a prefix key. */
223 Lisp_Object Vprefix_help_command
;
225 /* List of items that should move to the end of the menu bar. */
226 Lisp_Object Vmenu_bar_final_items
;
228 /* Non-nil means show the equivalent key-binding for
229 any M-x command that has one.
230 The value can be a length of time to show the message for.
231 If the value is non-nil and not a number, we wait 2 seconds. */
232 Lisp_Object Vsuggest_key_bindings
;
234 /* How long to display an echo-area message when the minibuffer is active.
235 If the value is not a number, such messages don't time out. */
236 Lisp_Object Vminibuffer_message_timeout
;
238 /* Character that causes a quit. Normally C-g.
240 If we are running on an ordinary terminal, this must be an ordinary
241 ASCII char, since we want to make it our interrupt character.
243 If we are not running on an ordinary terminal, it still needs to be
244 an ordinary ASCII char. This character needs to be recognized in
245 the input interrupt handler. At this point, the keystroke is
246 represented as a struct input_event, while the desired quit
247 character is specified as a lispy event. The mapping from struct
248 input_events to lispy events cannot run in an interrupt handler,
249 and the reverse mapping is difficult for anything but ASCII
252 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
256 extern Lisp_Object current_global_map
;
257 extern int minibuf_level
;
259 /* If non-nil, this is a map that overrides all other local maps. */
260 Lisp_Object Voverriding_local_map
;
262 /* If non-nil, Voverriding_local_map applies to the menu bar. */
263 Lisp_Object Voverriding_local_map_menu_flag
;
265 /* Keymap that defines special misc events that should
266 be processed immediately at a low level. */
267 Lisp_Object Vspecial_event_map
;
269 /* Current depth in recursive edits. */
270 int command_loop_level
;
272 /* Total number of times command_loop has read a key sequence. */
273 EMACS_INT num_input_keys
;
275 /* Last input character read as a command. */
276 Lisp_Object last_command_char
;
278 /* Last input character read as a command, not counting menus
279 reached by the mouse. */
280 Lisp_Object last_nonmenu_event
;
282 /* Last input character read for any purpose. */
283 Lisp_Object last_input_char
;
285 /* If not Qnil, a list of objects to be read as subsequent command input. */
286 Lisp_Object Vunread_command_events
;
288 /* If not Qnil, a list of objects to be read as subsequent command input
289 including input method processing. */
290 Lisp_Object Vunread_input_method_events
;
292 /* If not Qnil, a list of objects to be read as subsequent command input
293 but NOT including input method processing. */
294 Lisp_Object Vunread_post_input_method_events
;
296 /* If not -1, an event to be read as subsequent command input. */
297 EMACS_INT unread_command_char
;
299 /* If not Qnil, this is a switch-frame event which we decided to put
300 off until the end of a key sequence. This should be read as the
301 next command input, after any unread_command_events.
303 read_key_sequence uses this to delay switch-frame events until the
304 end of the key sequence; Fread_char uses it to put off switch-frame
305 events until a non-ASCII event is acceptable as input. */
306 Lisp_Object unread_switch_frame
;
308 /* A mask of extra modifier bits to put into every keyboard char. */
309 EMACS_INT extra_keyboard_modifiers
;
311 /* Char to use as prefix when a meta character is typed in.
312 This is bound on entry to minibuffer in case ESC is changed there. */
314 Lisp_Object meta_prefix_char
;
316 /* Last size recorded for a current buffer which is not a minibuffer. */
317 static int last_non_minibuf_size
;
319 /* Number of idle seconds before an auto-save and garbage collection. */
320 static Lisp_Object Vauto_save_timeout
;
322 /* Total number of times read_char has returned. */
323 int num_input_events
;
325 /* Total number of times read_char has returned, outside of macros. */
326 EMACS_INT num_nonmacro_input_events
;
328 /* Auto-save automatically when this many characters have been typed
329 since the last time. */
331 static EMACS_INT auto_save_interval
;
333 /* Value of num_nonmacro_input_events as of last auto save. */
337 /* The command being executed by the command loop.
338 Commands may set this, and the value set will be copied into
339 current_kboard->Vlast_command instead of the actual command. */
340 Lisp_Object Vthis_command
;
342 /* This is like Vthis_command, except that commands never set it. */
343 Lisp_Object real_this_command
;
345 /* If the lookup of the command returns a binding, the original
346 command is stored in this-original-command. It is nil otherwise. */
347 Lisp_Object Vthis_original_command
;
349 /* The value of point when the last command was started. */
350 int last_point_position
;
352 /* The buffer that was current when the last command was started. */
353 Lisp_Object last_point_position_buffer
;
355 /* The window that was selected when the last command was started. */
356 Lisp_Object last_point_position_window
;
358 /* The frame in which the last input event occurred, or Qmacro if the
359 last event came from a macro. We use this to determine when to
360 generate switch-frame events. This may be cleared by functions
361 like Fselect_frame, to make sure that a switch-frame event is
362 generated by the next character. */
363 Lisp_Object internal_last_event_frame
;
365 /* A user-visible version of the above, intended to allow users to
366 figure out where the last event came from, if the event doesn't
367 carry that information itself (i.e. if it was a character). */
368 Lisp_Object Vlast_event_frame
;
370 /* The timestamp of the last input event we received from the X server.
371 X Windows wants this for selection ownership. */
372 unsigned long last_event_timestamp
;
374 Lisp_Object Qself_insert_command
;
375 Lisp_Object Qforward_char
;
376 Lisp_Object Qbackward_char
;
377 Lisp_Object Qundefined
;
378 Lisp_Object Qtimer_event_handler
;
380 /* read_key_sequence stores here the command definition of the
381 key sequence that it reads. */
382 Lisp_Object read_key_sequence_cmd
;
384 /* Echo unfinished commands after this many seconds of pause. */
385 Lisp_Object Vecho_keystrokes
;
387 /* Form to evaluate (if non-nil) when Emacs is started. */
388 Lisp_Object Vtop_level
;
390 /* If non-nil, this implements the current input method. */
391 Lisp_Object Vinput_method_function
;
392 Lisp_Object Qinput_method_function
;
394 /* When we call Vinput_method_function,
395 this holds the echo area message that was just erased. */
396 Lisp_Object Vinput_method_previous_message
;
398 /* Non-nil means deactivate the mark at end of this command. */
399 Lisp_Object Vdeactivate_mark
;
400 Lisp_Object Qdeactivate_mark
;
402 /* Menu bar specified in Lucid Emacs fashion. */
404 Lisp_Object Vlucid_menu_bar_dirty_flag
;
405 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
407 Lisp_Object Qecho_area_clear_hook
;
409 /* Hooks to run before and after each command. */
410 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
411 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
412 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
414 /* Parent keymap of terminal-local function-key-map instances. */
415 Lisp_Object Vfunction_key_map
;
417 /* Keymap of key translations that can override keymaps. */
418 Lisp_Object Vkey_translation_map
;
420 /* List of deferred actions to be performed at a later time.
421 The precise format isn't relevant here; we just check whether it is nil. */
422 Lisp_Object Vdeferred_action_list
;
424 /* Function to call to handle deferred actions, when there are any. */
425 Lisp_Object Vdeferred_action_function
;
426 Lisp_Object Qdeferred_action_function
;
428 Lisp_Object Qinput_method_exit_on_first_char
;
429 Lisp_Object Qinput_method_use_echo_area
;
431 /* File in which we write all commands we read. */
434 /* Nonzero if input is available. */
437 extern char *pending_malloc_warning
;
439 /* Circular buffer for pre-read keyboard input. */
441 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
443 /* Pointer to next available character in kbd_buffer.
444 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
445 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
446 next available char is in kbd_buffer[0]. */
447 static struct input_event
*kbd_fetch_ptr
;
449 /* Pointer to next place to store character in kbd_buffer. This
450 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
451 character should go in kbd_buffer[0]. */
452 static struct input_event
* volatile kbd_store_ptr
;
454 /* The above pair of variables forms a "queue empty" flag. When we
455 enqueue a non-hook event, we increment kbd_store_ptr. When we
456 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
457 there is input available if the two pointers are not equal.
459 Why not just have a flag set and cleared by the enqueuing and
460 dequeuing functions? Such a flag could be screwed up by interrupts
461 at inopportune times. */
463 /* If this flag is non-nil, we check mouse_moved to see when the
464 mouse moves, and motion events will appear in the input stream.
465 Otherwise, mouse motion is ignored. */
466 Lisp_Object do_mouse_tracking
;
468 /* Symbols to head events. */
469 Lisp_Object Qmouse_movement
;
470 Lisp_Object Qscroll_bar_movement
;
471 Lisp_Object Qswitch_frame
;
472 Lisp_Object Qdelete_frame
;
473 Lisp_Object Qiconify_frame
;
474 Lisp_Object Qmake_frame_visible
;
475 Lisp_Object Qselect_window
;
476 Lisp_Object Qhelp_echo
;
478 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
479 Lisp_Object Qmouse_fixup_help_message
;
482 /* Symbols to denote kinds of events. */
483 Lisp_Object Qfunction_key
;
484 Lisp_Object Qmouse_click
;
485 #if defined (WINDOWSNT) || defined (MAC_OS)
486 Lisp_Object Qlanguage_change
;
488 Lisp_Object Qdrag_n_drop
;
489 Lisp_Object Qsave_session
;
491 Lisp_Object Qmac_apple_event
;
494 Lisp_Object Qdbus_event
;
496 /* Lisp_Object Qmouse_movement; - also an event header */
498 /* Properties of event headers. */
499 Lisp_Object Qevent_kind
;
500 Lisp_Object Qevent_symbol_elements
;
502 /* menu item parts */
503 Lisp_Object Qmenu_alias
;
504 Lisp_Object Qmenu_enable
;
505 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
506 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
507 extern Lisp_Object Vdefine_key_rebound_commands
;
508 extern Lisp_Object Qmenu_item
;
510 /* An event header symbol HEAD may have a property named
511 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
512 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
513 mask of modifiers applied to it. If present, this is used to help
514 speed up parse_modifiers. */
515 Lisp_Object Qevent_symbol_element_mask
;
517 /* An unmodified event header BASE may have a property named
518 Qmodifier_cache, which is an alist mapping modifier masks onto
519 modified versions of BASE. If present, this helps speed up
521 Lisp_Object Qmodifier_cache
;
523 /* Symbols to use for parts of windows. */
524 Lisp_Object Qmode_line
;
525 Lisp_Object Qvertical_line
;
526 Lisp_Object Qvertical_scroll_bar
;
527 Lisp_Object Qmenu_bar
;
528 extern Lisp_Object Qleft_margin
, Qright_margin
;
529 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
530 extern Lisp_Object QCmap
;
532 Lisp_Object
recursive_edit_unwind (), command_loop ();
533 Lisp_Object
Fthis_command_keys ();
534 Lisp_Object Qextended_command_history
;
535 EMACS_TIME
timer_check ();
537 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
539 extern char *x_get_keysym_name ();
541 static void record_menu_key ();
542 static int echo_length ();
544 Lisp_Object Qpolling_period
;
546 /* List of absolute timers. Appears in order of next scheduled event. */
547 Lisp_Object Vtimer_list
;
549 /* List of idle time timers. Appears in order of next scheduled event. */
550 Lisp_Object Vtimer_idle_list
;
552 /* Incremented whenever a timer is run. */
555 extern Lisp_Object Vprint_level
, Vprint_length
;
557 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
559 EMACS_TIME
*input_available_clear_time
;
561 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
562 Default is 1 if INTERRUPT_INPUT is defined. */
565 /* Nonzero while interrupts are temporarily deferred during redisplay. */
566 int interrupts_deferred
;
568 /* Allow m- file to inhibit use of FIONREAD. */
569 #ifdef BROKEN_FIONREAD
573 /* We are unable to use interrupts if FIONREAD is not available,
574 so flush SIGIO so we won't try. */
575 #if !defined (FIONREAD)
581 /* If we support a window system, turn on the code to poll periodically
582 to detect C-g. It isn't actually used when doing interrupt input. */
583 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
584 #define POLL_FOR_INPUT
587 /* After a command is executed, if point is moved into a region that
588 has specific properties (e.g. composition, display), we adjust
589 point to the boundary of the region. But, if a command sets this
590 variable to non-nil, we suppress this point adjustment. This
591 variable is set to nil before reading a command. */
593 Lisp_Object Vdisable_point_adjustment
;
595 /* If non-nil, always disable point adjustment. */
597 Lisp_Object Vglobal_disable_point_adjustment
;
599 /* The time when Emacs started being idle. */
601 static EMACS_TIME timer_idleness_start_time
;
603 /* After Emacs stops being idle, this saves the last value
604 of timer_idleness_start_time from when it was idle. */
606 static EMACS_TIME timer_last_idleness_start_time
;
608 /* If non-nil, events produced by disabled menu items and tool-bar
609 buttons are not ignored. Help functions bind this to allow help on
610 those items and buttons. */
611 Lisp_Object Venable_disabled_menus_and_buttons
;
614 /* Global variable declarations. */
616 /* Flags for readable_events. */
617 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
618 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
619 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
621 /* Function for init_keyboard to call with no args (if nonzero). */
622 void (*keyboard_init_hook
) ();
624 static int read_avail_input
P_ ((int));
625 static void get_input_pending
P_ ((int *, int));
626 static int readable_events
P_ ((int));
627 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
628 Lisp_Object
, int *));
629 static Lisp_Object
read_char_x_menu_prompt ();
630 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
632 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
633 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
634 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
635 enum scroll_bar_part
,
636 Lisp_Object
, Lisp_Object
,
639 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
640 Lisp_Object
, char **,
641 Lisp_Object
*, unsigned));
642 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
643 static int parse_solitary_modifier
P_ ((Lisp_Object
));
644 static int parse_solitary_modifier ();
645 static void save_getcjmp
P_ ((jmp_buf));
646 static void save_getcjmp ();
647 static void restore_getcjmp
P_ ((jmp_buf));
648 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
649 static void clear_event
P_ ((struct input_event
*));
651 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
653 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
654 static void handle_interrupt
P_ ((void));
655 static void timer_start_idle
P_ ((void));
656 static void timer_stop_idle
P_ ((void));
657 static void timer_resume_idle
P_ ((void));
658 static SIGTYPE handle_user_signal
P_ ((int));
659 static char *find_user_signal_name
P_ ((int));
660 static int store_user_signal_events
P_ ((void));
662 /* Nonzero means don't try to suspend even if the operating system seems
664 static int cannot_suspend
;
666 extern Lisp_Object Qidentity
, Qonly
;
668 /* Install the string STR as the beginning of the string of echoing,
669 so that it serves as a prompt for the next character.
670 Also start echoing. */
676 current_kboard
->echo_string
= str
;
677 current_kboard
->echo_after_prompt
= SCHARS (str
);
681 /* Add C to the echo string, if echoing is going on.
682 C can be a character, which is printed prettily ("M-C-x" and all that
683 jazz), or a symbol, whose name is printed. */
689 if (current_kboard
->immediate_echo
)
691 int size
= KEY_DESCRIPTION_SIZE
+ 100;
692 char *buffer
= (char *) alloca (size
);
694 Lisp_Object echo_string
;
696 echo_string
= current_kboard
->echo_string
;
698 /* If someone has passed us a composite event, use its head symbol. */
703 ptr
= push_key_description (XINT (c
), ptr
, 1);
705 else if (SYMBOLP (c
))
707 Lisp_Object name
= SYMBOL_NAME (c
);
708 int nbytes
= SBYTES (name
);
710 if (size
- (ptr
- buffer
) < nbytes
)
712 int offset
= ptr
- buffer
;
713 size
= max (2 * size
, size
+ nbytes
);
714 buffer
= (char *) alloca (size
);
715 ptr
= buffer
+ offset
;
718 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
719 STRING_MULTIBYTE (name
), 1);
722 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
725 const char *text
= " (Type ? for further options)";
726 int len
= strlen (text
);
728 if (size
- (ptr
- buffer
) < len
)
730 int offset
= ptr
- buffer
;
732 buffer
= (char *) alloca (size
);
733 ptr
= buffer
+ offset
;
736 bcopy (text
, ptr
, len
);
740 /* Replace a dash from echo_dash with a space, otherwise
741 add a space at the end as a separator between keys. */
742 if (STRINGP (echo_string
)
743 && SCHARS (echo_string
) > 1)
745 Lisp_Object last_char
, prev_char
, idx
;
747 idx
= make_number (SCHARS (echo_string
) - 2);
748 prev_char
= Faref (echo_string
, idx
);
750 idx
= make_number (SCHARS (echo_string
) - 1);
751 last_char
= Faref (echo_string
, idx
);
753 /* We test PREV_CHAR to make sure this isn't the echoing
755 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
756 Faset (echo_string
, idx
, make_number (' '));
758 echo_string
= concat2 (echo_string
, build_string (" "));
760 else if (STRINGP (echo_string
))
761 echo_string
= concat2 (echo_string
, build_string (" "));
763 current_kboard
->echo_string
764 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
770 /* Temporarily add a dash to the end of the echo string if it's not
771 empty, so that it serves as a mini-prompt for the very next character. */
776 /* Do nothing if not echoing at all. */
777 if (NILP (current_kboard
->echo_string
))
780 if (!current_kboard
->immediate_echo
781 && SCHARS (current_kboard
->echo_string
) == 0)
784 /* Do nothing if we just printed a prompt. */
785 if (current_kboard
->echo_after_prompt
786 == SCHARS (current_kboard
->echo_string
))
789 /* Do nothing if we have already put a dash at the end. */
790 if (SCHARS (current_kboard
->echo_string
) > 1)
792 Lisp_Object last_char
, prev_char
, idx
;
794 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
795 prev_char
= Faref (current_kboard
->echo_string
, idx
);
797 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
798 last_char
= Faref (current_kboard
->echo_string
, idx
);
800 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
804 /* Put a dash at the end of the buffer temporarily,
805 but make it go away when the next character is added. */
806 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
811 /* Display the current echo string, and begin echoing if not already
817 if (!current_kboard
->immediate_echo
)
820 current_kboard
->immediate_echo
= 1;
822 for (i
= 0; i
< this_command_key_count
; i
++)
826 /* Set before_command_echo_length to the value that would
827 have been saved before the start of this subcommand in
828 command_loop_1, if we had already been echoing then. */
829 if (i
== this_single_command_key_start
)
830 before_command_echo_length
= echo_length ();
832 c
= XVECTOR (this_command_keys
)->contents
[i
];
833 if (! (EVENT_HAS_PARAMETERS (c
)
834 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
838 /* Set before_command_echo_length to the value that would
839 have been saved before the start of this subcommand in
840 command_loop_1, if we had already been echoing then. */
841 if (this_command_key_count
== this_single_command_key_start
)
842 before_command_echo_length
= echo_length ();
844 /* Put a dash at the end to invite the user to type more. */
849 message3_nolog (current_kboard
->echo_string
,
850 SBYTES (current_kboard
->echo_string
),
851 STRING_MULTIBYTE (current_kboard
->echo_string
));
854 /* Record in what buffer we echoed, and from which kboard. */
855 echo_message_buffer
= echo_area_buffer
[0];
856 echo_kboard
= current_kboard
;
858 if (waiting_for_input
&& !NILP (Vquit_flag
))
859 quit_throw_to_read_char ();
862 /* Turn off echoing, for the start of a new command. */
867 current_kboard
->immediate_echo
= 0;
868 current_kboard
->echo_after_prompt
= -1;
869 current_kboard
->echo_string
= Qnil
;
870 ok_to_echo_at_next_pause
= NULL
;
872 echo_message_buffer
= Qnil
;
875 /* Return the length of the current echo string. */
880 return (STRINGP (current_kboard
->echo_string
)
881 ? SCHARS (current_kboard
->echo_string
)
885 /* Truncate the current echo message to its first LEN chars.
886 This and echo_char get used by read_key_sequence when the user
887 switches frames while entering a key sequence. */
890 echo_truncate (nchars
)
893 if (STRINGP (current_kboard
->echo_string
))
894 current_kboard
->echo_string
895 = Fsubstring (current_kboard
->echo_string
,
896 make_number (0), make_number (nchars
));
897 truncate_echo_area (nchars
);
901 /* Functions for manipulating this_command_keys. */
903 add_command_key (key
)
906 #if 0 /* Not needed after we made Freset_this_command_lengths
907 do the job immediately. */
908 /* If reset-this-command-length was called recently, obey it now.
909 See the doc string of that function for an explanation of why. */
910 if (before_command_restore_flag
)
912 this_command_key_count
= before_command_key_count_1
;
913 if (this_command_key_count
< this_single_command_key_start
)
914 this_single_command_key_start
= this_command_key_count
;
915 echo_truncate (before_command_echo_length_1
);
916 before_command_restore_flag
= 0;
920 if (this_command_key_count
>= ASIZE (this_command_keys
))
921 this_command_keys
= larger_vector (this_command_keys
,
922 2 * ASIZE (this_command_keys
),
925 ASET (this_command_keys
, this_command_key_count
, key
);
926 ++this_command_key_count
;
933 int count
= SPECPDL_INDEX ();
936 if (command_loop_level
> 0)
938 specbind (Qstandard_output
, Qt
);
939 specbind (Qstandard_input
, Qt
);
942 #ifdef HAVE_WINDOW_SYSTEM
943 /* The command loop has started an hourglass timer, so we have to
944 cancel it here, otherwise it will fire because the recursive edit
945 can take some time. Do not check for display_hourglass_p here,
946 because it could already be nil. */
950 /* This function may have been called from a debugger called from
951 within redisplay, for instance by Edebugging a function called
952 from fontification-functions. We want to allow redisplay in
953 the debugging session.
955 The recursive edit is left with a `(throw exit ...)'. The `exit'
956 tag is not caught anywhere in redisplay, i.e. when we leave the
957 recursive edit, the original redisplay leading to the recursive
958 edit will be unwound. The outcome should therefore be safe. */
959 specbind (Qinhibit_redisplay
, Qnil
);
962 val
= command_loop ();
964 Fsignal (Qquit
, Qnil
);
965 /* Handle throw from read_minibuf when using minibuffer
966 while it's active but we're in another window. */
968 xsignal1 (Qerror
, val
);
970 return unbind_to (count
, Qnil
);
973 /* When an auto-save happens, record the "time", and don't do again soon. */
978 last_auto_save
= num_nonmacro_input_events
;
981 /* Make an auto save happen as soon as possible at command level. */
984 force_auto_save_soon ()
986 last_auto_save
= - auto_save_interval
- 1;
988 record_asynch_buffer_change ();
991 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
992 doc
: /* Invoke the editor command loop recursively.
993 To get out of the recursive edit, a command can do `(throw 'exit nil)';
994 that tells this function to return.
995 Alternatively, `(throw 'exit t)' makes this function signal an error.
996 This function is called by the editor initialization to begin editing. */)
999 int count
= SPECPDL_INDEX ();
1002 /* If we enter while input is blocked, don't lock up here.
1003 This may happen through the debugger during redisplay. */
1004 if (INPUT_BLOCKED_P
)
1007 command_loop_level
++;
1008 update_mode_lines
= 1;
1010 if (command_loop_level
1011 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1012 buffer
= Fcurrent_buffer ();
1016 /* If we leave recursive_edit_1 below with a `throw' for instance,
1017 like it is done in the splash screen display, we have to
1018 make sure that we restore single_kboard as command_loop_1
1019 would have done if it were left normally. */
1020 if (command_loop_level
> 0)
1021 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1022 record_unwind_protect (recursive_edit_unwind
, buffer
);
1024 recursive_edit_1 ();
1025 return unbind_to (count
, Qnil
);
1029 recursive_edit_unwind (buffer
)
1032 if (BUFFERP (buffer
))
1033 Fset_buffer (buffer
);
1035 command_loop_level
--;
1036 update_mode_lines
= 1;
1041 #if 0 /* These two functions are now replaced with
1042 temporarily_switch_to_single_kboard. */
1047 #if 0 /* Theory: if there's anything in Vunread_command_events,
1048 it will right away be read by read_key_sequence,
1049 and then if we do switch KBOARDS, it will go into the side
1050 queue then. So we don't need to do anything special here -- rms. */
1051 if (CONSP (Vunread_command_events
))
1053 current_kboard
->kbd_queue
1054 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1055 current_kboard
->kbd_queue_has_data
= 1;
1057 Vunread_command_events
= Qnil
;
1063 /* Switch to the single-kboard state, making current_kboard
1064 the only KBOARD from which further input is accepted. */
1067 single_kboard_state ()
1075 /* If we're in single_kboard state for kboard KBOARD,
1079 not_single_kboard_state (kboard
)
1083 if (kboard
== current_kboard
)
1088 /* Maintain a stack of kboards, so other parts of Emacs
1089 can switch temporarily to the kboard of a given frame
1090 and then revert to the previous status. */
1095 struct kboard_stack
*next
;
1098 static struct kboard_stack
*kboard_stack
;
1105 struct kboard_stack
*p
1106 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1108 p
->next
= kboard_stack
;
1109 p
->kboard
= current_kboard
;
1121 struct kboard_stack
*p
= kboard_stack
;
1123 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1125 if (t
->kboard
== p
->kboard
)
1127 current_kboard
= p
->kboard
;
1134 /* The terminal we remembered has been deleted. */
1135 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1138 kboard_stack
= p
->next
;
1143 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1144 from which further input is accepted. If F is non-nil, set its
1145 KBOARD as the current keyboard.
1147 This function uses record_unwind_protect to return to the previous
1150 If Emacs is already in single_kboard mode, and F's keyboard is
1151 locked, then this function will throw an errow. */
1154 temporarily_switch_to_single_kboard (f
)
1158 int was_locked
= single_kboard
;
1161 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1162 /* We can not switch keyboards while in single_kboard mode.
1163 In rare cases, Lisp code may call `recursive-edit' (or
1164 `read-minibuffer' or `y-or-n-p') after it switched to a
1165 locked frame. For example, this is likely to happen
1166 when server.el connects to a new terminal while Emacs is in
1167 single_kboard mode. It is best to throw an error instead
1168 of presenting the user with a frozen screen. */
1169 error ("Terminal %d is locked, cannot read from it",
1170 FRAME_TERMINAL (f
)->id
);
1172 /* This call is unnecessary, but helps
1173 `restore_kboard_configuration' discover if somebody changed
1174 `current_kboard' behind our back. */
1175 push_kboard (current_kboard
);
1178 current_kboard
= FRAME_KBOARD (f
);
1180 record_unwind_protect (restore_kboard_configuration
,
1181 (was_locked
? Qt
: Qnil
));
1185 #if 0 /* This function is not needed anymore. */
1187 record_single_kboard_state ()
1190 push_kboard (current_kboard
);
1191 record_unwind_protect (restore_kboard_configuration
,
1192 (single_kboard
? Qt
: Qnil
));
1198 restore_kboard_configuration (was_locked
)
1199 Lisp_Object was_locked
;
1201 if (NILP (was_locked
))
1205 struct kboard
*prev
= current_kboard
;
1208 /* The pop should not change the kboard. */
1209 if (single_kboard
&& current_kboard
!= prev
)
1217 /* Handle errors that are not handled at inner levels
1218 by printing an error message and returning to the editor command loop. */
1224 Lisp_Object old_level
, old_length
;
1225 char macroerror
[50];
1227 #ifdef HAVE_WINDOW_SYSTEM
1228 if (display_hourglass_p
)
1229 cancel_hourglass ();
1232 if (!NILP (executing_kbd_macro
))
1234 if (executing_kbd_macro_iterations
== 1)
1235 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1237 sprintf (macroerror
, "After %d kbd macro iterations: ",
1238 executing_kbd_macro_iterations
);
1243 Vstandard_output
= Qt
;
1244 Vstandard_input
= Qt
;
1245 Vexecuting_kbd_macro
= Qnil
;
1246 executing_kbd_macro
= Qnil
;
1247 current_kboard
->Vprefix_arg
= Qnil
;
1248 current_kboard
->Vlast_prefix_arg
= Qnil
;
1251 /* Avoid unquittable loop if data contains a circular list. */
1252 old_level
= Vprint_level
;
1253 old_length
= Vprint_length
;
1254 XSETFASTINT (Vprint_level
, 10);
1255 XSETFASTINT (Vprint_length
, 10);
1256 cmd_error_internal (data
, macroerror
);
1257 Vprint_level
= old_level
;
1258 Vprint_length
= old_length
;
1262 Vinhibit_quit
= Qnil
;
1263 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1265 if (command_loop_level
== 0 && minibuf_level
== 0)
1266 any_kboard_state ();
1270 return make_number (0);
1273 /* Take actions on handling an error. DATA is the data that describes
1276 CONTEXT is a C-string containing ASCII characters only which
1277 describes the context in which the error happened. If we need to
1278 generalize CONTEXT to allow multibyte characters, make it a Lisp
1282 cmd_error_internal (data
, context
)
1286 struct frame
*sf
= SELECTED_FRAME ();
1288 /* The immediate context is not interesting for Quits,
1289 since they are asyncronous. */
1290 if (EQ (XCAR (data
), Qquit
))
1291 Vsignaling_function
= Qnil
;
1296 /* Use user's specified output function if any. */
1297 if (!NILP (Vcommand_error_function
))
1298 call3 (Vcommand_error_function
, data
,
1299 context
? build_string (context
) : empty_unibyte_string
,
1300 Vsignaling_function
);
1301 /* If the window system or terminal frame hasn't been initialized
1302 yet, or we're not interactive, write the message to stderr and exit. */
1303 else if (!sf
->glyphs_initialized_p
1304 || FRAME_INITIAL_P (sf
)
1307 print_error_message (data
, Qexternal_debugging_output
,
1308 context
, Vsignaling_function
);
1309 Fterpri (Qexternal_debugging_output
);
1310 Fkill_emacs (make_number (-1));
1314 clear_message (1, 0);
1316 message_log_maybe_newline ();
1319 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1322 Vsignaling_function
= Qnil
;
1325 Lisp_Object
command_loop_1 ();
1326 Lisp_Object
command_loop_2 ();
1327 Lisp_Object
top_level_1 ();
1329 /* Entry to editor-command-loop.
1330 This level has the catches for exiting/returning to editor command loop.
1331 It returns nil to exit recursive edit, t to abort it. */
1336 if (command_loop_level
> 0 || minibuf_level
> 0)
1339 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1340 executing_kbd_macro
= Qnil
;
1346 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1347 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1348 /* Reset single_kboard in case top-level set it while
1349 evaluating an -f option, or we are stuck there for some
1351 any_kboard_state ();
1353 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1354 executing_kbd_macro
= Qnil
;
1356 /* End of file in -batch run causes exit here. */
1362 /* Here we catch errors in execution of commands within the
1363 editing loop, and reenter the editing loop.
1364 When there is an error, cmd_error runs and returns a non-nil
1365 value to us. A value of nil means that command_loop_1 itself
1366 returned due to end of file (or end of kbd macro). */
1371 register Lisp_Object val
;
1374 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1375 while (!NILP (val
));
1383 return Feval (Vtop_level
);
1389 /* On entry to the outer level, run the startup file */
1390 if (!NILP (Vtop_level
))
1391 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1392 else if (!NILP (Vpurify_flag
))
1393 message ("Bare impure Emacs (standard Lisp code not loaded)");
1395 message ("Bare Emacs (standard Lisp code not loaded)");
1399 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1400 doc
: /* Exit all recursive editing levels. */)
1403 #ifdef HAVE_WINDOW_SYSTEM
1404 if (display_hourglass_p
)
1405 cancel_hourglass ();
1408 /* Unblock input if we enter with input blocked. This may happen if
1409 redisplay traps e.g. during tool-bar update with input blocked. */
1410 while (INPUT_BLOCKED_P
)
1413 return Fthrow (Qtop_level
, Qnil
);
1416 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1417 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1420 if (command_loop_level
> 0 || minibuf_level
> 0)
1421 Fthrow (Qexit
, Qnil
);
1423 error ("No recursive edit is in progress");
1427 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1428 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1431 if (command_loop_level
> 0 || minibuf_level
> 0)
1434 error ("No recursive edit is in progress");
1438 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1440 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1441 of this function. */
1444 tracking_off (old_value
)
1445 Lisp_Object old_value
;
1447 do_mouse_tracking
= old_value
;
1448 if (NILP (old_value
))
1450 /* Redisplay may have been preempted because there was input
1451 available, and it assumes it will be called again after the
1452 input has been processed. If the only input available was
1453 the sort that we have just disabled, then we need to call
1455 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1457 redisplay_preserve_echo_area (6);
1458 get_input_pending (&input_pending
,
1459 READABLE_EVENTS_DO_TIMERS_NOW
);
1465 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1466 doc
: /* Evaluate BODY with mouse movement events enabled.
1467 Within a `track-mouse' form, mouse motion generates input events that
1468 you can read with `read-event'.
1469 Normally, mouse motion is ignored.
1470 usage: (track-mouse BODY...) */)
1474 int count
= SPECPDL_INDEX ();
1477 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1479 do_mouse_tracking
= Qt
;
1481 val
= Fprogn (args
);
1482 return unbind_to (count
, val
);
1485 /* If mouse has moved on some frame, return one of those frames.
1489 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1490 after resizing the tool-bar window. */
1492 int ignore_mouse_drag_p
;
1497 Lisp_Object tail
, frame
;
1499 if (ignore_mouse_drag_p
)
1501 /* ignore_mouse_drag_p = 0; */
1505 FOR_EACH_FRAME (tail
, frame
)
1507 if (XFRAME (frame
)->mouse_moved
)
1508 return XFRAME (frame
);
1514 #endif /* HAVE_MOUSE || HAVE_GPM */
1516 /* This is the actual command reading loop,
1517 sans error-handling encapsulation. */
1519 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1521 void safe_run_hooks
P_ ((Lisp_Object
));
1522 static void adjust_point_for_property
P_ ((int, int));
1524 /* Cancel hourglass from protect_unwind.
1526 #ifdef HAVE_WINDOW_SYSTEM
1528 cancel_hourglass_unwind (arg
)
1531 cancel_hourglass ();
1542 Lisp_Object keybuf
[30];
1544 int prev_modiff
= 0;
1545 struct buffer
*prev_buffer
= NULL
;
1546 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1548 int was_locked
= single_kboard
;
1551 int already_adjusted
= 0;
1553 current_kboard
->Vprefix_arg
= Qnil
;
1554 current_kboard
->Vlast_prefix_arg
= Qnil
;
1555 Vdeactivate_mark
= Qnil
;
1556 waiting_for_input
= 0;
1560 this_command_key_count
= 0;
1561 this_command_key_count_reset
= 0;
1562 this_single_command_key_start
= 0;
1564 if (NILP (Vmemory_full
))
1566 /* Make sure this hook runs after commands that get errors and
1567 throw to top level. */
1568 /* Note that the value cell will never directly contain nil
1569 if the symbol is a local variable. */
1570 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1571 safe_run_hooks (Qpost_command_hook
);
1573 /* If displaying a message, resize the echo area window to fit
1574 that message's size exactly. */
1575 if (!NILP (echo_area_buffer
[0]))
1576 resize_echo_area_exactly ();
1578 if (!NILP (Vdeferred_action_list
))
1579 safe_run_hooks (Qdeferred_action_function
);
1582 /* Do this after running Vpost_command_hook, for consistency. */
1583 current_kboard
->Vlast_command
= Vthis_command
;
1584 current_kboard
->Vreal_last_command
= real_this_command
;
1585 if (!CONSP (last_command_char
))
1586 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1590 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1593 /* Make sure the current window's buffer is selected. */
1594 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1595 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1597 /* Display any malloc warning that just came out. Use while because
1598 displaying one warning can cause another. */
1600 while (pending_malloc_warning
)
1601 display_malloc_warning ();
1603 Vdeactivate_mark
= Qnil
;
1605 /* If minibuffer on and echo area in use,
1606 wait a short time and redraw minibuffer. */
1609 && !NILP (echo_area_buffer
[0])
1610 && EQ (minibuf_window
, echo_area_window
)
1611 && NUMBERP (Vminibuffer_message_timeout
))
1613 /* Bind inhibit-quit to t so that C-g gets read in
1614 rather than quitting back to the minibuffer. */
1615 int count
= SPECPDL_INDEX ();
1616 specbind (Qinhibit_quit
, Qt
);
1618 sit_for (Vminibuffer_message_timeout
, 0, 2);
1620 /* Clear the echo area. */
1622 safe_run_hooks (Qecho_area_clear_hook
);
1624 unbind_to (count
, Qnil
);
1626 /* If a C-g came in before, treat it as input now. */
1627 if (!NILP (Vquit_flag
))
1630 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1635 /* Select the frame that the last event came from. Usually,
1636 switch-frame events will take care of this, but if some lisp
1637 code swallows a switch-frame event, we'll fix things up here.
1638 Is this a good idea? */
1639 if (FRAMEP (internal_last_event_frame
)
1640 && !EQ (internal_last_event_frame
, selected_frame
))
1641 Fselect_frame (internal_last_event_frame
);
1643 /* If it has changed current-menubar from previous value,
1644 really recompute the menubar from the value. */
1645 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1646 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1647 call0 (Qrecompute_lucid_menubar
);
1649 before_command_key_count
= this_command_key_count
;
1650 before_command_echo_length
= echo_length ();
1652 Vthis_command
= Qnil
;
1653 real_this_command
= Qnil
;
1654 Vthis_original_command
= Qnil
;
1655 Vthis_command_keys_shift_translated
= Qnil
;
1657 /* Read next key sequence; i gets its length. */
1658 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1661 /* A filter may have run while we were reading the input. */
1662 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1664 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1665 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1669 /* Now we have read a key sequence of length I,
1670 or else I is 0 and we found end of file. */
1672 if (i
== 0) /* End of file -- happens only in */
1673 return Qnil
; /* a kbd macro, at the end. */
1674 /* -1 means read_key_sequence got a menu that was rejected.
1675 Just loop around and read another command. */
1679 this_command_key_count
= 0;
1680 this_command_key_count_reset
= 0;
1681 this_single_command_key_start
= 0;
1685 last_command_char
= keybuf
[i
- 1];
1687 /* If the previous command tried to force a specific window-start,
1688 forget about that, in case this command moves point far away
1689 from that position. But also throw away beg_unchanged and
1690 end_unchanged information in that case, so that redisplay will
1691 update the whole window properly. */
1692 if (!NILP (XWINDOW (selected_window
)->force_start
))
1695 XWINDOW (selected_window
)->force_start
= Qnil
;
1696 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1697 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1700 cmd
= read_key_sequence_cmd
;
1701 if (!NILP (Vexecuting_kbd_macro
))
1703 if (!NILP (Vquit_flag
))
1705 Vexecuting_kbd_macro
= Qt
;
1706 QUIT
; /* Make some noise. */
1707 /* Will return since macro now empty. */
1711 /* Do redisplay processing after this command except in special
1712 cases identified below. */
1713 prev_buffer
= current_buffer
;
1714 prev_modiff
= MODIFF
;
1715 last_point_position
= PT
;
1716 last_point_position_window
= selected_window
;
1717 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1719 /* By default, we adjust point to a boundary of a region that
1720 has such a property that should be treated intangible
1721 (e.g. composition, display). But, some commands will set
1722 this variable differently. */
1723 Vdisable_point_adjustment
= Qnil
;
1725 /* Process filters and timers may have messed with deactivate-mark.
1726 reset it before we execute the command. */
1727 Vdeactivate_mark
= Qnil
;
1729 /* Remap command through active keymaps */
1730 Vthis_original_command
= cmd
;
1734 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1738 /* Execute the command. */
1740 Vthis_command
= cmd
;
1741 real_this_command
= cmd
;
1742 /* Note that the value cell will never directly contain nil
1743 if the symbol is a local variable. */
1744 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1745 safe_run_hooks (Qpre_command_hook
);
1747 already_adjusted
= 0;
1749 if (NILP (Vthis_command
))
1751 /* nil means key is undefined. */
1752 Lisp_Object keys
= Fvector (i
, keybuf
);
1753 keys
= Fkey_description (keys
, Qnil
);
1755 message_with_string ("%s is undefined", keys
, 0);
1756 current_kboard
->defining_kbd_macro
= Qnil
;
1757 update_mode_lines
= 1;
1758 current_kboard
->Vprefix_arg
= Qnil
;
1762 if (NILP (current_kboard
->Vprefix_arg
))
1764 /* In case we jump to directly_done. */
1765 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1767 /* Recognize some common commands in common situations and
1768 do them directly. */
1769 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
1770 && NILP (Vthis_command_keys_shift_translated
)
1771 && !CONSP (Vtransient_mark_mode
))
1773 struct Lisp_Char_Table
*dp
1774 = window_display_table (XWINDOW (selected_window
));
1775 lose
= FETCH_CHAR (PT_BYTE
);
1777 if (! NILP (Vpost_command_hook
))
1778 /* Put this before calling adjust_point_for_property
1779 so it will only get called once in any case. */
1781 if (current_buffer
== prev_buffer
1782 && last_point_position
!= PT
1783 && NILP (Vdisable_point_adjustment
)
1784 && NILP (Vglobal_disable_point_adjustment
))
1785 adjust_point_for_property (last_point_position
, 0);
1786 already_adjusted
= 1;
1787 if (PT
== last_point_position
+ 1
1789 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1790 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1791 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1792 && (lose
>= 0x20 && lose
< 0x7f)))
1793 : (lose
>= 0x20 && lose
< 0x7f))
1794 /* To extract the case of continuation on
1795 wide-column characters. */
1796 && ASCII_BYTE_P (lose
)
1797 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1799 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1801 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1803 && !windows_or_buffers_changed
1804 && EQ (current_buffer
->selective_display
, Qnil
)
1805 && !detect_input_pending ()
1806 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1807 && NILP (Vexecuting_kbd_macro
))
1808 direct_output_forward_char (1);
1811 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
1812 && NILP (Vthis_command_keys_shift_translated
)
1813 && !CONSP (Vtransient_mark_mode
))
1815 struct Lisp_Char_Table
*dp
1816 = window_display_table (XWINDOW (selected_window
));
1818 lose
= FETCH_CHAR (PT_BYTE
);
1819 if (! NILP (Vpost_command_hook
))
1821 if (current_buffer
== prev_buffer
1822 && last_point_position
!= PT
1823 && NILP (Vdisable_point_adjustment
)
1824 && NILP (Vglobal_disable_point_adjustment
))
1825 adjust_point_for_property (last_point_position
, 0);
1826 already_adjusted
= 1;
1827 if (PT
== last_point_position
- 1
1829 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1830 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1831 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1832 && (lose
>= 0x20 && lose
< 0x7f)))
1833 : (lose
>= 0x20 && lose
< 0x7f))
1834 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1836 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1838 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1840 && !windows_or_buffers_changed
1841 && EQ (current_buffer
->selective_display
, Qnil
)
1842 && !detect_input_pending ()
1843 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1844 && NILP (Vexecuting_kbd_macro
))
1845 direct_output_forward_char (-1);
1848 else if (EQ (Vthis_command
, Qself_insert_command
)
1849 /* Try this optimization only on char keystrokes. */
1850 && NATNUMP (last_command_char
)
1851 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1854 = translate_char (Vtranslation_table_for_input
,
1855 XFASTINT (last_command_char
));
1857 if (NILP (Vexecuting_kbd_macro
)
1858 && !EQ (minibuf_window
, selected_window
))
1860 if (!nonundocount
|| nonundocount
>= 20)
1868 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1870 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1872 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1874 || MODIFF
<= SAVE_MODIFF
1875 || windows_or_buffers_changed
1876 || !EQ (current_buffer
->selective_display
, Qnil
)
1877 || detect_input_pending ()
1878 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1879 || !NILP (Vexecuting_kbd_macro
));
1881 value
= internal_self_insert (c
, 0);
1886 if (! NILP (Vpost_command_hook
))
1887 /* Put this before calling adjust_point_for_property
1888 so it will only get called once in any case. */
1891 /* VALUE == 1 when AFTER-CHANGE functions are
1892 installed which is the case most of the time
1893 because FONT-LOCK installs one. */
1894 if (!lose
&& !value
)
1895 direct_output_for_insert (c
);
1900 /* Here for a command that isn't executed directly */
1903 #ifdef HAVE_WINDOW_SYSTEM
1904 int scount
= SPECPDL_INDEX ();
1906 if (display_hourglass_p
1907 && NILP (Vexecuting_kbd_macro
))
1909 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1915 if (NILP (current_kboard
->Vprefix_arg
))
1917 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1919 #ifdef HAVE_WINDOW_SYSTEM
1920 /* Do not check display_hourglass_p here, because
1921 Fcommand_execute could change it, but we should cancel
1922 hourglass cursor anyway.
1923 But don't cancel the hourglass within a macro
1924 just because a command in the macro finishes. */
1925 if (NILP (Vexecuting_kbd_macro
))
1926 unbind_to (scount
, Qnil
);
1931 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1933 /* Note that the value cell will never directly contain nil
1934 if the symbol is a local variable. */
1935 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1936 safe_run_hooks (Qpost_command_hook
);
1938 /* If displaying a message, resize the echo area window to fit
1939 that message's size exactly. */
1940 if (!NILP (echo_area_buffer
[0]))
1941 resize_echo_area_exactly ();
1943 if (!NILP (Vdeferred_action_list
))
1944 safe_run_hooks (Qdeferred_action_function
);
1946 /* If there is a prefix argument,
1947 1) We don't want Vlast_command to be ``universal-argument''
1948 (that would be dumb), so don't set Vlast_command,
1949 2) we want to leave echoing on so that the prefix will be
1950 echoed as part of this key sequence, so don't call
1952 3) we want to leave this_command_key_count non-zero, so that
1953 read_char will realize that it is re-reading a character, and
1954 not echo it a second time.
1956 If the command didn't actually create a prefix arg,
1957 but is merely a frame event that is transparent to prefix args,
1958 then the above doesn't apply. */
1959 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1961 current_kboard
->Vlast_command
= Vthis_command
;
1962 current_kboard
->Vreal_last_command
= real_this_command
;
1963 if (!CONSP (last_command_char
))
1964 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1966 this_command_key_count
= 0;
1967 this_command_key_count_reset
= 0;
1968 this_single_command_key_start
= 0;
1971 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1973 /* In Emacs 22, setting transient-mark-mode to `only' was a
1974 way of turning it on for just one command. This usage is
1975 obsolete, but support it anyway. */
1976 if (EQ (Vtransient_mark_mode
, Qidentity
))
1977 Vtransient_mark_mode
= Qnil
;
1978 else if (EQ (Vtransient_mark_mode
, Qonly
))
1979 Vtransient_mark_mode
= Qidentity
;
1981 if (!NILP (Vdeactivate_mark
))
1982 call0 (Qdeactivate_mark
);
1983 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1984 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1989 if (current_buffer
== prev_buffer
1990 && last_point_position
!= PT
1991 && NILP (Vdisable_point_adjustment
)
1992 && NILP (Vglobal_disable_point_adjustment
)
1993 && !already_adjusted
)
1994 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1996 /* Install chars successfully executed in kbd macro. */
1998 if (!NILP (current_kboard
->defining_kbd_macro
)
1999 && NILP (current_kboard
->Vprefix_arg
))
2000 finalize_kbd_macro_chars ();
2001 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2004 any_kboard_state ();
2010 extern Lisp_Object Qcomposition
, Qdisplay
;
2012 /* Adjust point to a boundary of a region that has such a property
2013 that should be treated intangible. For the moment, we check
2014 `composition', `display' and `invisible' properties.
2015 LAST_PT is the last position of point. */
2017 extern Lisp_Object Qafter_string
, Qbefore_string
;
2018 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2021 adjust_point_for_property (last_pt
, modified
)
2026 Lisp_Object val
, overlay
, tmp
;
2027 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
2030 /* FIXME: cycling is probably not necessary because these properties
2031 can't be usefully combined anyway. */
2032 while (check_composition
|| check_display
|| check_invisible
)
2034 /* FIXME: check `intangible'. */
2035 if (check_composition
2036 && PT
> BEGV
&& PT
< ZV
2037 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
2038 && COMPOSITION_VALID_P (beg
, end
, val
)
2039 && beg
< PT
/* && end > PT <- It's always the case. */
2040 && (last_pt
<= beg
|| last_pt
>= end
))
2043 SET_PT (PT
< last_pt
? beg
: end
);
2044 check_display
= check_invisible
= 1;
2046 check_composition
= 0;
2048 && PT
> BEGV
&& PT
< ZV
2049 && !NILP (val
= get_char_property_and_overlay
2050 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
2051 && display_prop_intangible_p (val
)
2052 && (!OVERLAYP (overlay
)
2053 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
2054 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
2055 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
2056 && (beg
< PT
/* && end > PT <- It's always the case. */
2057 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
2060 SET_PT (PT
< last_pt
2061 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
2063 check_composition
= check_invisible
= 1;
2066 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
2068 int inv
, ellipsis
= 0;
2071 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2073 && !NILP (val
= get_char_property_and_overlay
2074 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
2075 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2077 ellipsis
= ellipsis
|| inv
> 1
2078 || (OVERLAYP (overlay
)
2079 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2080 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2081 tmp
= Fnext_single_char_property_change
2082 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
2083 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
2086 && !NILP (val
= get_char_property_and_overlay
2087 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
2088 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2090 ellipsis
= ellipsis
|| inv
> 1
2091 || (OVERLAYP (overlay
)
2092 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2093 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2094 tmp
= Fprevious_single_char_property_change
2095 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2096 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2099 /* Move away from the inside area. */
2100 if (beg
< PT
&& end
> PT
)
2102 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2103 /* We haven't moved yet (so we don't need to fear
2104 infinite-looping) and we were outside the range
2105 before (so either end of the range still corresponds
2106 to a move in the right direction): pretend we moved
2107 less than we actually did, so that we still have
2108 more freedom below in choosing which end of the range
2110 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2111 /* We either have moved already or the last point
2112 was already in the range: we don't get to choose
2113 which end of the range we have to go to. */
2114 : (PT
< last_pt
? beg
: end
));
2115 check_composition
= check_display
= 1;
2117 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2118 the point to something other than its argument, due to
2119 point-motion hooks, intangibility, etc. */
2120 xassert (PT
== beg
|| PT
== end
);
2123 /* Pretend the area doesn't exist if the buffer is not
2125 if (!modified
&& !ellipsis
&& beg
< end
)
2127 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2128 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2129 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2130 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2131 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2132 /* We've already moved as far as we can. Trying to go
2133 to the other end would mean moving backwards and thus
2134 could lead to an infinite loop. */
2136 else if (val
= get_pos_property (make_number (PT
),
2138 TEXT_PROP_MEANS_INVISIBLE (val
)
2139 && (val
= get_pos_property
2140 (make_number (PT
== beg
? end
: beg
),
2142 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2143 (check_composition
= check_display
= 1,
2144 SET_PT (PT
== beg
? end
: beg
));
2147 check_invisible
= 0;
2151 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2154 safe_run_hooks_1 (hook
)
2157 if (NILP (Vrun_hooks
))
2159 return call1 (Vrun_hooks
, Vinhibit_quit
);
2162 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2165 safe_run_hooks_error (data
)
2168 Lisp_Object args
[3];
2169 args
[0] = build_string ("Error in %s: %s");
2170 args
[1] = Vinhibit_quit
;
2173 return Fset (Vinhibit_quit
, Qnil
);
2176 /* If we get an error while running the hook, cause the hook variable
2177 to be nil. Also inhibit quits, so that C-g won't cause the hook
2178 to mysteriously evaporate. */
2181 safe_run_hooks (hook
)
2184 int count
= SPECPDL_INDEX ();
2185 specbind (Qinhibit_quit
, hook
);
2187 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2189 unbind_to (count
, Qnil
);
2193 /* Number of seconds between polling for input. This is a Lisp
2194 variable that can be bound. */
2196 EMACS_INT polling_period
;
2198 /* Nonzero means polling for input is temporarily suppressed. */
2200 int poll_suppress_count
;
2202 /* Asynchronous timer for polling. */
2204 struct atimer
*poll_timer
;
2207 #ifdef POLL_FOR_INPUT
2209 /* Poll for input, so what we catch a C-g if it comes in. This
2210 function is called from x_make_frame_visible, see comment
2216 if (interrupt_input_blocked
== 0
2217 && !waiting_for_input
)
2218 read_avail_input (0);
2221 /* Timer callback function for poll_timer. TIMER is equal to
2225 poll_for_input (timer
)
2226 struct atimer
*timer
;
2228 if (poll_suppress_count
== 0)
2230 interrupt_input_pending
= 1;
2232 poll_for_input_1 ();
2236 #endif /* POLL_FOR_INPUT */
2238 /* Begin signals to poll for input, if they are appropriate.
2239 This function is called unconditionally from various places. */
2244 #ifdef POLL_FOR_INPUT
2245 /* XXX This condition was (read_socket_hook && !interrupt_input),
2246 but read_socket_hook is not global anymore. Let's pretend that
2248 if (!interrupt_input
)
2250 /* Turn alarm handling on unconditionally. It might have
2251 been turned off in process.c. */
2252 turn_on_atimers (1);
2254 /* If poll timer doesn't exist, are we need one with
2255 a different interval, start a new one. */
2256 if (poll_timer
== NULL
2257 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2259 EMACS_TIME interval
;
2262 cancel_atimer (poll_timer
);
2264 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2265 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2266 poll_for_input
, NULL
);
2269 /* Let the timer's callback function poll for input
2270 if this becomes zero. */
2271 --poll_suppress_count
;
2276 /* Nonzero if we are using polling to handle input asynchronously. */
2279 input_polling_used ()
2281 #ifdef POLL_FOR_INPUT
2282 /* XXX This condition was (read_socket_hook && !interrupt_input),
2283 but read_socket_hook is not global anymore. Let's pretend that
2285 return !interrupt_input
;
2291 /* Turn off polling. */
2296 #ifdef POLL_FOR_INPUT
2297 /* XXX This condition was (read_socket_hook && !interrupt_input),
2298 but read_socket_hook is not global anymore. Let's pretend that
2300 if (!interrupt_input
)
2301 ++poll_suppress_count
;
2305 /* Set the value of poll_suppress_count to COUNT
2306 and start or stop polling accordingly. */
2309 set_poll_suppress_count (count
)
2312 #ifdef POLL_FOR_INPUT
2313 if (count
== 0 && poll_suppress_count
!= 0)
2315 poll_suppress_count
= 1;
2318 else if (count
!= 0 && poll_suppress_count
== 0)
2322 poll_suppress_count
= count
;
2326 /* Bind polling_period to a value at least N.
2327 But don't decrease it. */
2330 bind_polling_period (n
)
2333 #ifdef POLL_FOR_INPUT
2334 int new = polling_period
;
2339 stop_other_atimers (poll_timer
);
2341 specbind (Qpolling_period
, make_number (new));
2342 /* Start a new alarm with the new period. */
2347 /* Apply the control modifier to CHARACTER. */
2353 /* Save the upper bits here. */
2354 int upper
= c
& ~0177;
2356 if (! ASCII_BYTE_P (c
))
2357 return c
|= ctrl_modifier
;
2361 /* Everything in the columns containing the upper-case letters
2362 denotes a control character. */
2363 if (c
>= 0100 && c
< 0140)
2367 /* Set the shift modifier for a control char
2368 made from a shifted letter. But only for letters! */
2369 if (oc
>= 'A' && oc
<= 'Z')
2370 c
|= shift_modifier
;
2373 /* The lower-case letters denote control characters too. */
2374 else if (c
>= 'a' && c
<= 'z')
2377 /* Include the bits for control and shift
2378 only if the basic ASCII code can't indicate them. */
2382 /* Replace the high bits. */
2383 c
|= (upper
& ~ctrl_modifier
);
2388 /* Display the help-echo property of the character after the mouse pointer.
2389 Either show it in the echo area, or call show-help-function to display
2390 it by other means (maybe in a tooltip).
2392 If HELP is nil, that means clear the previous help echo.
2394 If HELP is a string, display that string. If HELP is a function,
2395 call it with OBJECT and POS as arguments; the function should
2396 return a help string or nil for none. For all other types of HELP,
2397 evaluate it to obtain a string.
2399 WINDOW is the window in which the help was generated, if any.
2400 It is nil if not in a window.
2402 If OBJECT is a buffer, POS is the position in the buffer where the
2403 `help-echo' text property was found.
2405 If OBJECT is an overlay, that overlay has a `help-echo' property,
2406 and POS is the position in the overlay's buffer under the mouse.
2408 If OBJECT is a string (an overlay string or a string displayed with
2409 the `display' property). POS is the position in that string under
2412 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2413 echo overwrites a keystroke echo currently displayed in the echo
2416 Note: this function may only be called with HELP nil or a string
2417 from X code running asynchronously. */
2420 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2421 Lisp_Object help
, window
, object
, pos
;
2422 int ok_to_overwrite_keystroke_echo
;
2424 if (!NILP (help
) && !STRINGP (help
))
2426 if (FUNCTIONP (help
))
2428 Lisp_Object args
[4];
2433 help
= safe_call (4, args
);
2436 help
= safe_eval (help
);
2438 if (!STRINGP (help
))
2442 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2443 if (!noninteractive
&& STRINGP (help
))
2445 /* The mouse-fixup-help-message Lisp function can call
2446 mouse_position_hook, which resets the mouse_moved flags.
2447 This causes trouble if we are trying to read a mouse motion
2448 event (i.e., if we are inside a `track-mouse' form), so we
2449 restore the mouse_moved flag. */
2450 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2451 help
= call1 (Qmouse_fixup_help_message
, help
);
2457 if (STRINGP (help
) || NILP (help
))
2459 if (!NILP (Vshow_help_function
))
2460 call1 (Vshow_help_function
, help
);
2461 else if (/* Don't overwrite minibuffer contents. */
2462 !MINI_WINDOW_P (XWINDOW (selected_window
))
2463 /* Don't overwrite a keystroke echo. */
2464 && (NILP (echo_message_buffer
)
2465 || ok_to_overwrite_keystroke_echo
)
2466 /* Don't overwrite a prompt. */
2467 && !cursor_in_echo_area
)
2471 int count
= SPECPDL_INDEX ();
2473 if (!help_echo_showing_p
)
2474 Vpre_help_message
= current_message ();
2476 specbind (Qmessage_truncate_lines
, Qt
);
2477 message3_nolog (help
, SBYTES (help
),
2478 STRING_MULTIBYTE (help
));
2479 unbind_to (count
, Qnil
);
2481 else if (STRINGP (Vpre_help_message
))
2483 message3_nolog (Vpre_help_message
,
2484 SBYTES (Vpre_help_message
),
2485 STRING_MULTIBYTE (Vpre_help_message
));
2486 Vpre_help_message
= Qnil
;
2492 help_echo_showing_p
= STRINGP (help
);
2498 /* Input of single characters from keyboard */
2500 Lisp_Object
print_help ();
2501 static Lisp_Object
kbd_buffer_get_event ();
2502 static void record_char ();
2504 static Lisp_Object help_form_saved_window_configs
;
2506 read_char_help_form_unwind (arg
)
2508 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2509 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2510 if (!NILP (window_config
))
2511 Fset_window_configuration (window_config
);
2515 #define STOP_POLLING \
2516 do { if (! polling_stopped_here) stop_polling (); \
2517 polling_stopped_here = 1; } while (0)
2519 #define RESUME_POLLING \
2520 do { if (polling_stopped_here) start_polling (); \
2521 polling_stopped_here = 0; } while (0)
2523 /* read a character from the keyboard; call the redisplay if needed */
2524 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2525 -1 means do not do redisplay, but do do autosaving.
2528 /* The arguments MAPS and NMAPS are for menu prompting.
2529 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2531 PREV_EVENT is the previous input event, or nil if we are reading
2532 the first event of a key sequence (or not reading a key sequence).
2533 If PREV_EVENT is t, that is a "magic" value that says
2534 not to run input methods, but in other respects to act as if
2535 not reading a key sequence.
2537 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2538 if we used a mouse menu to read the input, or zero otherwise. If
2539 USED_MOUSE_MENU is null, we don't dereference it.
2541 Value is -2 when we find input on another keyboard. A second call
2542 to read_char will read it.
2544 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2545 specifying the maximum time to wait until. If no input arrives by
2546 that time, stop waiting and return nil.
2548 Value is t if we showed a menu and the user rejected it. */
2551 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2555 Lisp_Object prev_event
;
2556 int *used_mouse_menu
;
2557 EMACS_TIME
*end_time
;
2559 volatile Lisp_Object c
;
2560 int count
, jmpcount
;
2561 jmp_buf local_getcjmp
;
2563 volatile int key_already_recorded
= 0;
2564 Lisp_Object tem
, save
;
2565 volatile Lisp_Object previous_echo_area_message
;
2566 volatile Lisp_Object also_record
;
2567 volatile int reread
;
2568 struct gcpro gcpro1
, gcpro2
;
2569 int polling_stopped_here
= 0;
2570 struct kboard
*orig_kboard
= current_kboard
;
2574 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2575 before_command_key_count
= this_command_key_count
;
2576 before_command_echo_length
= echo_length ();
2579 previous_echo_area_message
= Qnil
;
2581 GCPRO2 (c
, previous_echo_area_message
);
2586 if (CONSP (Vunread_post_input_method_events
))
2588 c
= XCAR (Vunread_post_input_method_events
);
2589 Vunread_post_input_method_events
2590 = XCDR (Vunread_post_input_method_events
);
2592 /* Undo what read_char_x_menu_prompt did when it unread
2593 additional keys returned by Fx_popup_menu. */
2595 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2603 if (unread_command_char
!= -1)
2605 XSETINT (c
, unread_command_char
);
2606 unread_command_char
= -1;
2612 if (CONSP (Vunread_command_events
))
2614 c
= XCAR (Vunread_command_events
);
2615 Vunread_command_events
= XCDR (Vunread_command_events
);
2619 /* Undo what sit-for did when it unread additional keys
2620 inside universal-argument. */
2623 && EQ (XCAR (c
), Qt
))
2629 /* Undo what read_char_x_menu_prompt did when it unread
2630 additional keys returned by Fx_popup_menu. */
2632 && EQ (XCDR (c
), Qdisabled
)
2633 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2636 /* If the queued event is something that used the mouse,
2637 set used_mouse_menu accordingly. */
2639 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2640 *used_mouse_menu
= 1;
2642 goto reread_for_input_method
;
2645 if (CONSP (Vunread_input_method_events
))
2647 c
= XCAR (Vunread_input_method_events
);
2648 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2650 /* Undo what read_char_x_menu_prompt did when it unread
2651 additional keys returned by Fx_popup_menu. */
2653 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2657 goto reread_for_input_method
;
2660 this_command_key_count_reset
= 0;
2662 if (!NILP (Vexecuting_kbd_macro
))
2664 /* We set this to Qmacro; since that's not a frame, nobody will
2665 try to switch frames on us, and the selected window will
2668 Since this event came from a macro, it would be misleading to
2669 leave internal_last_event_frame set to wherever the last
2670 real event came from. Normally, a switch-frame event selects
2671 internal_last_event_frame after each command is read, but
2672 events read from a macro should never cause a new frame to be
2674 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2676 /* Exit the macro if we are at the end.
2677 Also, some things replace the macro with t
2678 to force an early exit. */
2679 if (EQ (Vexecuting_kbd_macro
, Qt
)
2680 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2686 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2687 if (STRINGP (Vexecuting_kbd_macro
)
2688 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2689 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2691 executing_kbd_macro_index
++;
2696 if (!NILP (unread_switch_frame
))
2698 c
= unread_switch_frame
;
2699 unread_switch_frame
= Qnil
;
2701 /* This event should make it into this_command_keys, and get echoed
2702 again, so we do not set `reread'. */
2706 /* if redisplay was requested */
2707 if (commandflag
>= 0)
2709 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2711 /* If there is pending input, process any events which are not
2712 user-visible, such as X selection_request events. */
2714 || detect_input_pending_run_timers (0))
2715 swallow_events (0); /* may clear input_pending */
2717 /* Redisplay if no pending input. */
2718 while (!input_pending
)
2720 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2721 redisplay_preserve_echo_area (5);
2726 /* Normal case: no input arrived during redisplay. */
2729 /* Input arrived and pre-empted redisplay.
2730 Process any events which are not user-visible. */
2732 /* If that cleared input_pending, try again to redisplay. */
2735 /* Prevent the redisplay we just did
2736 from messing up echoing of the input after the prompt. */
2737 if (commandflag
== 0 && echo_current
)
2738 echo_message_buffer
= echo_area_buffer
[0];
2742 /* Message turns off echoing unless more keystrokes turn it on again.
2744 The code in 20.x for the condition was
2746 1. echo_area_glyphs && *echo_area_glyphs
2747 2. && echo_area_glyphs != current_kboard->echobuf
2748 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2750 (1) means there's a current message displayed
2752 (2) means it's not the message from echoing from the current
2755 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2756 is set to a non-null value. This is done in read_char and it is
2757 set to echo_area_glyphs after a call to echo_char. That means
2758 ok_to_echo_at_next_pause is either null or
2759 current_kboard->echobuf with the appropriate current_kboard at
2762 So, condition (3) means in clear text ok_to_echo_at_next_pause
2763 must be either null, or the current message isn't from echoing at
2764 all, or it's from echoing from a different kboard than the
2767 if (/* There currently is something in the echo area. */
2768 !NILP (echo_area_buffer
[0])
2769 && (/* And it's either not from echoing. */
2770 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2771 /* Or it's an echo from a different kboard. */
2772 || echo_kboard
!= current_kboard
2773 /* Or we explicitly allow overwriting whatever there is. */
2774 || ok_to_echo_at_next_pause
== NULL
))
2779 /* Try reading a character via menu prompting in the minibuf.
2780 Try this before the sit-for, because the sit-for
2781 would do the wrong thing if we are supposed to do
2782 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2783 after a mouse event so don't try a minibuf menu. */
2785 if (nmaps
> 0 && INTERACTIVE
2786 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2787 /* Don't bring up a menu if we already have another event. */
2788 && NILP (Vunread_command_events
)
2789 && unread_command_char
< 0
2790 && !detect_input_pending_run_timers (0))
2792 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2794 if (INTEGERP (c
) && XINT (c
) == -2)
2795 return c
; /* wrong_kboard_jmpbuf */
2799 key_already_recorded
= 1;
2804 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2805 We will do that below, temporarily for short sections of code,
2806 when appropriate. local_getcjmp must be in effect
2807 around any call to sit_for or kbd_buffer_get_event;
2808 it *must not* be in effect when we call redisplay. */
2810 jmpcount
= SPECPDL_INDEX ();
2811 if (_setjmp (local_getcjmp
))
2813 /* Handle quits while reading the keyboard. */
2814 /* We must have saved the outer value of getcjmp here,
2815 so restore it now. */
2816 restore_getcjmp (save_jump
);
2817 unbind_to (jmpcount
, Qnil
);
2818 XSETINT (c
, quit_char
);
2819 internal_last_event_frame
= selected_frame
;
2820 Vlast_event_frame
= internal_last_event_frame
;
2821 /* If we report the quit char as an event,
2822 don't do so more than once. */
2823 if (!NILP (Vinhibit_quit
))
2828 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2829 if (kb
!= current_kboard
)
2831 Lisp_Object link
= kb
->kbd_queue
;
2832 /* We shouldn't get here if we were in single-kboard mode! */
2837 while (CONSP (XCDR (link
)))
2839 if (!NILP (XCDR (link
)))
2843 kb
->kbd_queue
= Fcons (c
, Qnil
);
2845 XSETCDR (link
, Fcons (c
, Qnil
));
2846 kb
->kbd_queue_has_data
= 1;
2847 current_kboard
= kb
;
2848 /* This is going to exit from read_char
2849 so we had better get rid of this frame's stuff. */
2851 return make_number (-2); /* wrong_kboard_jmpbuf */
2858 /* Start idle timers if no time limit is supplied. We don't do it
2859 if a time limit is supplied to avoid an infinite recursion in the
2860 situation where an idle timer calls `sit-for'. */
2863 timer_start_idle ();
2865 /* If in middle of key sequence and minibuffer not active,
2866 start echoing if enough time elapses. */
2868 if (minibuf_level
== 0
2870 && !current_kboard
->immediate_echo
2871 && this_command_key_count
> 0
2873 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2874 && NILP (Fzerop (Vecho_keystrokes
))
2875 && (/* No message. */
2876 NILP (echo_area_buffer
[0])
2877 /* Or empty message. */
2878 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2879 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2880 /* Or already echoing from same kboard. */
2881 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2882 /* Or not echoing before and echoing allowed. */
2883 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2885 /* After a mouse event, start echoing right away.
2886 This is because we are probably about to display a menu,
2887 and we don't want to delay before doing so. */
2888 if (EVENT_HAS_PARAMETERS (prev_event
))
2894 save_getcjmp (save_jump
);
2895 restore_getcjmp (local_getcjmp
);
2896 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2897 restore_getcjmp (save_jump
);
2899 && ! CONSP (Vunread_command_events
))
2904 /* Maybe auto save due to number of keystrokes. */
2906 if (commandflag
!= 0
2907 && auto_save_interval
> 0
2908 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2909 && !detect_input_pending_run_timers (0))
2911 Fdo_auto_save (Qnil
, Qnil
);
2912 /* Hooks can actually change some buffers in auto save. */
2916 /* Try reading using an X menu.
2917 This is never confused with reading using the minibuf
2918 because the recursive call of read_char in read_char_minibuf_menu_prompt
2919 does not pass on any keymaps. */
2921 if (nmaps
> 0 && INTERACTIVE
2922 && !NILP (prev_event
)
2923 && EVENT_HAS_PARAMETERS (prev_event
)
2924 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2925 && !EQ (XCAR (prev_event
), Qtool_bar
)
2926 /* Don't bring up a menu if we already have another event. */
2927 && NILP (Vunread_command_events
)
2928 && unread_command_char
< 0)
2930 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2932 /* Now that we have read an event, Emacs is not idle. */
2939 /* Maybe autosave and/or garbage collect due to idleness. */
2941 if (INTERACTIVE
&& NILP (c
))
2943 int delay_level
, buffer_size
;
2945 /* Slow down auto saves logarithmically in size of current buffer,
2946 and garbage collect while we're at it. */
2947 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2948 last_non_minibuf_size
= Z
- BEG
;
2949 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2951 while (buffer_size
> 64)
2952 delay_level
++, buffer_size
-= buffer_size
>> 2;
2953 if (delay_level
< 4) delay_level
= 4;
2954 /* delay_level is 4 for files under around 50k, 7 at 100k,
2955 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2957 /* Auto save if enough time goes by without input. */
2958 if (commandflag
!= 0
2959 && num_nonmacro_input_events
> last_auto_save
2960 && INTEGERP (Vauto_save_timeout
)
2961 && XINT (Vauto_save_timeout
) > 0)
2964 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2966 save_getcjmp (save_jump
);
2967 restore_getcjmp (local_getcjmp
);
2968 tem0
= sit_for (make_number (timeout
), 1, 1);
2969 restore_getcjmp (save_jump
);
2972 && ! CONSP (Vunread_command_events
))
2974 Fdo_auto_save (Qnil
, Qnil
);
2976 /* If we have auto-saved and there is still no input
2977 available, garbage collect if there has been enough
2978 consing going on to make it worthwhile. */
2979 if (!detect_input_pending_run_timers (0)
2980 && consing_since_gc
> gc_cons_threshold
/ 2)
2981 Fgarbage_collect ();
2988 /* Notify the caller if an autosave hook, or a timer, sentinel or
2989 filter in the sit_for calls above have changed the current
2990 kboard. This could happen if they use the minibuffer or start a
2991 recursive edit, like the fancy splash screen in server.el's
2992 filter. If this longjmp wasn't here, read_key_sequence would
2993 interpret the next key sequence using the wrong translation
2994 tables and function keymaps. */
2995 if (NILP (c
) && current_kboard
!= orig_kboard
)
2998 return make_number (-2); /* wrong_kboard_jmpbuf */
3001 /* If this has become non-nil here, it has been set by a timer
3002 or sentinel or filter. */
3003 if (CONSP (Vunread_command_events
))
3005 c
= XCAR (Vunread_command_events
);
3006 Vunread_command_events
= XCDR (Vunread_command_events
);
3009 /* Read something from current KBOARD's side queue, if possible. */
3013 if (current_kboard
->kbd_queue_has_data
)
3015 if (!CONSP (current_kboard
->kbd_queue
))
3017 c
= XCAR (current_kboard
->kbd_queue
);
3018 current_kboard
->kbd_queue
3019 = XCDR (current_kboard
->kbd_queue
);
3020 if (NILP (current_kboard
->kbd_queue
))
3021 current_kboard
->kbd_queue_has_data
= 0;
3022 input_pending
= readable_events (0);
3023 if (EVENT_HAS_PARAMETERS (c
)
3024 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
3025 internal_last_event_frame
= XCAR (XCDR (c
));
3026 Vlast_event_frame
= internal_last_event_frame
;
3031 /* If current_kboard's side queue is empty check the other kboards.
3032 If one of them has data that we have not yet seen here,
3033 switch to it and process the data waiting for it.
3035 Note: if the events queued up for another kboard
3036 have already been seen here, and therefore are not a complete command,
3037 the kbd_queue_has_data field is 0, so we skip that kboard here.
3038 That's to avoid an infinite loop switching between kboards here. */
3039 if (NILP (c
) && !single_kboard
)
3042 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3043 if (kb
->kbd_queue_has_data
)
3045 current_kboard
= kb
;
3046 /* This is going to exit from read_char
3047 so we had better get rid of this frame's stuff. */
3049 return make_number (-2); /* wrong_kboard_jmpbuf */
3058 /* Finally, we read from the main queue,
3059 and if that gives us something we can't use yet, we put it on the
3060 appropriate side queue and try again. */
3069 EMACS_GET_TIME (now
);
3070 if (EMACS_TIME_GE (now
, *end_time
))
3074 /* Actually read a character, waiting if necessary. */
3075 save_getcjmp (save_jump
);
3076 restore_getcjmp (local_getcjmp
);
3078 timer_start_idle ();
3079 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
3080 restore_getcjmp (save_jump
);
3083 if (! NILP (c
) && (kb
!= current_kboard
))
3085 Lisp_Object link
= kb
->kbd_queue
;
3088 while (CONSP (XCDR (link
)))
3090 if (!NILP (XCDR (link
)))
3094 kb
->kbd_queue
= Fcons (c
, Qnil
);
3096 XSETCDR (link
, Fcons (c
, Qnil
));
3097 kb
->kbd_queue_has_data
= 1;
3101 current_kboard
= kb
;
3102 /* This is going to exit from read_char
3103 so we had better get rid of this frame's stuff. */
3105 return make_number (-2);
3110 /* Terminate Emacs in batch mode if at eof. */
3111 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
3112 Fkill_emacs (make_number (1));
3116 /* Add in any extra modifiers, where appropriate. */
3117 if ((extra_keyboard_modifiers
& CHAR_CTL
)
3118 || ((extra_keyboard_modifiers
& 0177) < ' '
3119 && (extra_keyboard_modifiers
& 0177) != 0))
3120 XSETINT (c
, make_ctrl_char (XINT (c
)));
3122 /* Transfer any other modifier bits directly from
3123 extra_keyboard_modifiers to c. Ignore the actual character code
3124 in the low 16 bits of extra_keyboard_modifiers. */
3125 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
3136 if (commandflag
>= 0
3137 && !input_pending
&& !detect_input_pending_run_timers (0))
3145 /* Buffer switch events are only for internal wakeups
3146 so don't show them to the user.
3147 Also, don't record a key if we already did. */
3148 if (BUFFERP (c
) || key_already_recorded
)
3151 /* Process special events within read_char
3152 and loop around to read another event. */
3155 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3160 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3161 int was_locked
= single_kboard
;
3162 int count
= SPECPDL_INDEX ();
3163 record_single_kboard_state ();
3166 last_input_char
= c
;
3167 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
3169 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3170 /* We stopped being idle for this event; undo that. This
3171 prevents automatic window selection (under
3172 mouse_autoselect_window from acting as a real input event, for
3173 example banishing the mouse under mouse-avoidance-mode. */
3174 timer_resume_idle ();
3176 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3177 /* Resume allowing input from any kboard, if that was true before. */
3179 any_kboard_state ();
3180 unbind_to (count
, Qnil
);
3186 /* Handle things that only apply to characters. */
3189 /* If kbd_buffer_get_event gave us an EOF, return that. */
3193 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3194 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3195 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3196 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3197 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3201 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3202 /* nil in keyboard-translate-table means no translation. */
3208 /* If this event is a mouse click in the menu bar,
3209 return just menu-bar for now. Modify the mouse click event
3210 so we won't do this twice, then queue it up. */
3211 if (EVENT_HAS_PARAMETERS (c
)
3213 && CONSP (EVENT_START (c
))
3214 && CONSP (XCDR (EVENT_START (c
))))
3218 posn
= POSN_POSN (EVENT_START (c
));
3219 /* Handle menu-bar events:
3220 insert the dummy prefix event `menu-bar'. */
3221 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3223 /* Change menu-bar to (menu-bar) as the event "position". */
3224 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3227 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3232 /* Store these characters into recent_keys, the dribble file if any,
3233 and the keyboard macro being defined, if any. */
3235 if (! NILP (also_record
))
3236 record_char (also_record
);
3238 /* Wipe the echo area.
3239 But first, if we are about to use an input method,
3240 save the echo area contents for it to refer to. */
3242 && ! NILP (Vinput_method_function
)
3243 && (unsigned) XINT (c
) >= ' '
3244 && (unsigned) XINT (c
) != 127
3245 && (unsigned) XINT (c
) < 256)
3247 previous_echo_area_message
= Fcurrent_message ();
3248 Vinput_method_previous_message
= previous_echo_area_message
;
3251 /* Now wipe the echo area, except for help events which do their
3252 own stuff with the echo area. */
3254 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3255 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3257 if (!NILP (echo_area_buffer
[0]))
3258 safe_run_hooks (Qecho_area_clear_hook
);
3259 clear_message (1, 0);
3262 reread_for_input_method
:
3264 /* Pass this to the input method, if appropriate. */
3266 && ! NILP (Vinput_method_function
)
3267 /* Don't run the input method within a key sequence,
3268 after the first event of the key sequence. */
3269 && NILP (prev_event
)
3270 && (unsigned) XINT (c
) >= ' '
3271 && (unsigned) XINT (c
) != 127
3272 && (unsigned) XINT (c
) < 256)
3275 int key_count
, key_count_reset
;
3276 struct gcpro gcpro1
;
3277 int count
= SPECPDL_INDEX ();
3279 /* Save the echo status. */
3280 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3281 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3282 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3283 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3286 if (before_command_restore_flag
)
3288 this_command_key_count
= before_command_key_count_1
;
3289 if (this_command_key_count
< this_single_command_key_start
)
3290 this_single_command_key_start
= this_command_key_count
;
3291 echo_truncate (before_command_echo_length_1
);
3292 before_command_restore_flag
= 0;
3296 /* Save the this_command_keys status. */
3297 key_count
= this_command_key_count
;
3298 key_count_reset
= this_command_key_count_reset
;
3301 keys
= Fcopy_sequence (this_command_keys
);
3306 /* Clear out this_command_keys. */
3307 this_command_key_count
= 0;
3308 this_command_key_count_reset
= 0;
3310 /* Now wipe the echo area. */
3311 if (!NILP (echo_area_buffer
[0]))
3312 safe_run_hooks (Qecho_area_clear_hook
);
3313 clear_message (1, 0);
3316 /* If we are not reading a key sequence,
3317 never use the echo area. */
3320 specbind (Qinput_method_use_echo_area
, Qt
);
3323 /* Call the input method. */
3324 tem
= call1 (Vinput_method_function
, c
);
3326 tem
= unbind_to (count
, tem
);
3328 /* Restore the saved echoing state
3329 and this_command_keys state. */
3330 this_command_key_count
= key_count
;
3331 this_command_key_count_reset
= key_count_reset
;
3333 this_command_keys
= keys
;
3336 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3337 current_kboard
->echo_string
= saved_echo_string
;
3338 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3339 if (saved_immediate_echo
)
3344 /* The input method can return no events. */
3347 /* Bring back the previous message, if any. */
3348 if (! NILP (previous_echo_area_message
))
3349 message_with_string ("%s", previous_echo_area_message
, 0);
3352 /* It returned one event or more. */
3354 Vunread_post_input_method_events
3355 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3360 /* Display help if not echoing. */
3361 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3363 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3364 Lisp_Object help
, object
, position
, window
, tem
;
3366 tem
= Fcdr (XCDR (c
));
3369 window
= Fcar (tem
);
3371 object
= Fcar (tem
);
3373 position
= Fcar (tem
);
3375 show_help_echo (help
, window
, object
, position
, 0);
3377 /* We stopped being idle for this event; undo that. */
3379 timer_resume_idle ();
3383 if ((! reread
|| this_command_key_count
== 0
3384 || this_command_key_count_reset
)
3388 /* Don't echo mouse motion events. */
3389 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3390 && NILP (Fzerop (Vecho_keystrokes
))
3391 && ! (EVENT_HAS_PARAMETERS (c
)
3392 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3395 if (! NILP (also_record
))
3396 echo_char (also_record
);
3397 /* Once we reread a character, echoing can happen
3398 the next time we pause to read a new one. */
3399 ok_to_echo_at_next_pause
= current_kboard
;
3402 /* Record this character as part of the current key. */
3403 add_command_key (c
);
3404 if (! NILP (also_record
))
3405 add_command_key (also_record
);
3408 last_input_char
= c
;
3411 /* Process the help character specially if enabled */
3412 if (!NILP (Vhelp_form
) && help_char_p (c
))
3415 count
= SPECPDL_INDEX ();
3417 help_form_saved_window_configs
3418 = Fcons (Fcurrent_window_configuration (Qnil
),
3419 help_form_saved_window_configs
);
3420 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3422 tem0
= Feval (Vhelp_form
);
3424 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3429 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3430 if (EVENT_HAS_PARAMETERS (c
)
3431 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3432 XSETCAR (help_form_saved_window_configs
, Qnil
);
3434 while (BUFFERP (c
));
3435 /* Remove the help from the frame */
3436 unbind_to (count
, Qnil
);
3439 if (EQ (c
, make_number (040)))
3443 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3444 while (BUFFERP (c
));
3453 /* Record a key that came from a mouse menu.
3454 Record it for echoing, for this-command-keys, and so on. */
3460 /* Wipe the echo area. */
3461 clear_message (1, 0);
3466 before_command_key_count
= this_command_key_count
;
3467 before_command_echo_length
= echo_length ();
3470 /* Don't echo mouse motion events. */
3471 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3472 && NILP (Fzerop (Vecho_keystrokes
)))
3476 /* Once we reread a character, echoing can happen
3477 the next time we pause to read a new one. */
3478 ok_to_echo_at_next_pause
= 0;
3481 /* Record this character as part of the current key. */
3482 add_command_key (c
);
3484 /* Re-reading in the middle of a command */
3485 last_input_char
= c
;
3489 /* Return 1 if should recognize C as "the help character". */
3497 if (EQ (c
, Vhelp_char
))
3499 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3500 if (EQ (c
, XCAR (tail
)))
3505 /* Record the input event C in various ways. */
3513 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3515 /* To avoid filling recent_keys with help-echo and mouse-movement
3516 events, we filter out repeated help-echo events, only store the
3517 first and last in a series of mouse-movement events, and don't
3518 store repeated help-echo events which are only separated by
3519 mouse-movement events. */
3521 Lisp_Object ev1
, ev2
, ev3
;
3524 if ((ix1
= recent_keys_index
- 1) < 0)
3525 ix1
= NUM_RECENT_KEYS
- 1;
3526 ev1
= AREF (recent_keys
, ix1
);
3528 if ((ix2
= ix1
- 1) < 0)
3529 ix2
= NUM_RECENT_KEYS
- 1;
3530 ev2
= AREF (recent_keys
, ix2
);
3532 if ((ix3
= ix2
- 1) < 0)
3533 ix3
= NUM_RECENT_KEYS
- 1;
3534 ev3
= AREF (recent_keys
, ix3
);
3536 if (EQ (XCAR (c
), Qhelp_echo
))
3538 /* Don't record `help-echo' in recent_keys unless it shows some help
3539 message, and a different help than the previously recorded
3541 Lisp_Object help
, last_help
;
3543 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3544 if (!STRINGP (help
))
3546 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3547 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3549 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3550 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3551 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3553 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3554 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3555 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3556 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3559 else if (EQ (XCAR (c
), Qmouse_movement
))
3561 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3562 So additional mouse movement events replace the last element. */
3563 Lisp_Object last_window
, window
;
3565 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3566 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3567 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3568 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3569 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3571 ASET (recent_keys
, ix1
, c
);
3577 store_kbd_macro_char (c
);
3582 ASET (recent_keys
, recent_keys_index
, c
);
3583 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3584 recent_keys_index
= 0;
3586 else if (recorded
< 0)
3588 /* We need to remove one or two events from recent_keys.
3589 To do this, we simply put nil at those events and move the
3590 recent_keys_index backwards over those events. Usually,
3591 users will never see those nil events, as they will be
3592 overwritten by the command keys entered to see recent_keys
3595 while (recorded
++ < 0 && total_keys
> 0)
3597 if (total_keys
< NUM_RECENT_KEYS
)
3599 if (--recent_keys_index
< 0)
3600 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3601 ASET (recent_keys
, recent_keys_index
, Qnil
);
3605 num_nonmacro_input_events
++;
3607 /* Write c to the dribble file. If c is a lispy event, write
3608 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3609 If you, dear reader, have a better idea, you've got the source. :-) */
3615 if (XUINT (c
) < 0x100)
3616 putc (XINT (c
), dribble
);
3618 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3622 Lisp_Object dribblee
;
3624 /* If it's a structured event, take the event header. */
3625 dribblee
= EVENT_HEAD (c
);
3627 if (SYMBOLP (dribblee
))
3629 putc ('<', dribble
);
3630 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3631 SBYTES (SYMBOL_NAME (dribblee
)),
3633 putc ('>', dribble
);
3646 struct buffer
*old
= current_buffer
;
3647 Fprinc (object
, Qnil
);
3648 set_buffer_internal (XBUFFER (Vstandard_output
));
3649 call0 (intern ("help-mode"));
3650 set_buffer_internal (old
);
3654 /* Copy out or in the info on where C-g should throw to.
3655 This is used when running Lisp code from within get_char,
3656 in case get_char is called recursively.
3657 See read_process_output. */
3663 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3667 restore_getcjmp (temp
)
3670 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3673 /* Low level keyboard/mouse input.
3674 kbd_buffer_store_event places events in kbd_buffer, and
3675 kbd_buffer_get_event retrieves them. */
3677 /* Return true if there are any events in the queue that read-char
3678 would return. If this returns false, a read-char would block. */
3680 readable_events (flags
)
3683 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3686 /* If the buffer contains only FOCUS_IN_EVENT events, and
3687 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3688 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3690 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3691 #ifdef USE_TOOLKIT_SCROLL_BARS
3692 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3696 struct input_event
*event
;
3698 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3705 #ifdef USE_TOOLKIT_SCROLL_BARS
3706 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3708 event
->kind
== FOCUS_IN_EVENT
)
3709 #ifdef USE_TOOLKIT_SCROLL_BARS
3710 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3711 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3712 && event
->part
== scroll_bar_handle
3713 && event
->modifiers
== 0)
3718 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3721 while (event
!= kbd_store_ptr
);
3727 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3728 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3729 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3734 if (current_kboard
->kbd_queue_has_data
)
3740 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3741 if (kb
->kbd_queue_has_data
)
3747 /* Set this for debugging, to have a way to get out */
3752 event_to_kboard (event
)
3753 struct input_event
*event
;
3756 frame
= event
->frame_or_window
;
3758 frame
= XCAR (frame
);
3759 else if (WINDOWP (frame
))
3760 frame
= WINDOW_FRAME (XWINDOW (frame
));
3762 /* There are still some events that don't set this field.
3763 For now, just ignore the problem.
3764 Also ignore dead frames here. */
3765 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3768 return FRAME_KBOARD (XFRAME (frame
));
3773 Lisp_Object Vthrow_on_input
;
3775 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3778 kbd_buffer_store_event (event
)
3779 register struct input_event
*event
;
3781 kbd_buffer_store_event_hold (event
, 0);
3784 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3786 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3787 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3788 Else, if EVENT is a quit event, store the quit event
3789 in HOLD_QUIT, and return (thus ignoring further events).
3791 This is used in read_avail_input to postpone the processing
3792 of the quit event until all subsequent input events have been
3793 parsed (and discarded).
3797 kbd_buffer_store_event_hold (event
, hold_quit
)
3798 register struct input_event
*event
;
3799 struct input_event
*hold_quit
;
3801 if (event
->kind
== NO_EVENT
)
3804 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3807 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3809 register int c
= event
->code
& 0377;
3811 if (event
->modifiers
& ctrl_modifier
)
3812 c
= make_ctrl_char (c
);
3814 c
|= (event
->modifiers
3815 & (meta_modifier
| alt_modifier
3816 | hyper_modifier
| super_modifier
));
3821 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3822 struct input_event
*sp
;
3824 if (single_kboard
&& kb
!= current_kboard
)
3827 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3828 Fcons (make_number (c
), Qnil
));
3829 kb
->kbd_queue_has_data
= 1;
3830 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3832 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3835 if (event_to_kboard (sp
) == kb
)
3837 sp
->kind
= NO_EVENT
;
3838 sp
->frame_or_window
= Qnil
;
3848 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3852 /* If this results in a quit_char being returned to Emacs as
3853 input, set Vlast_event_frame properly. If this doesn't
3854 get returned to Emacs as an event, the next event read
3855 will set Vlast_event_frame again, so this is safe to do. */
3859 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3861 focus
= event
->frame_or_window
;
3862 internal_last_event_frame
= focus
;
3863 Vlast_event_frame
= focus
;
3866 last_event_timestamp
= event
->timestamp
;
3867 handle_interrupt ();
3871 if (c
&& c
== stop_character
)
3877 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3878 Just ignore the second one. */
3879 else if (event
->kind
== BUFFER_SWITCH_EVENT
3880 && kbd_fetch_ptr
!= kbd_store_ptr
3881 && ((kbd_store_ptr
== kbd_buffer
3882 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3883 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3886 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3887 kbd_store_ptr
= kbd_buffer
;
3889 /* Don't let the very last slot in the buffer become full,
3890 since that would make the two pointers equal,
3891 and that is indistinguishable from an empty buffer.
3892 Discard the event if it would fill the last slot. */
3893 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3895 *kbd_store_ptr
= *event
;
3899 /* If we're inside while-no-input, and this event qualifies
3900 as input, set quit-flag to cause an interrupt. */
3901 if (!NILP (Vthrow_on_input
)
3902 && event
->kind
!= FOCUS_IN_EVENT
3903 && event
->kind
!= HELP_EVENT
3904 && event
->kind
!= DEICONIFY_EVENT
)
3906 Vquit_flag
= Vthrow_on_input
;
3907 /* If we're inside a function that wants immediate quits,
3909 if (immediate_quit
&& NILP (Vinhibit_quit
))
3919 /* Put an input event back in the head of the event queue. */
3922 kbd_buffer_unget_event (event
)
3923 register struct input_event
*event
;
3925 if (kbd_fetch_ptr
== kbd_buffer
)
3926 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3928 /* Don't let the very last slot in the buffer become full, */
3929 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3932 *kbd_fetch_ptr
= *event
;
3937 /* Generate HELP_EVENT input_events in BUFP which has room for
3938 SIZE events. If there's not enough room in BUFP, ignore this
3941 HELP is the help form.
3943 FRAME is the frame on which the help is generated. OBJECT is the
3944 Lisp object where the help was found (a buffer, a string, an
3945 overlay, or nil if neither from a string nor from a buffer. POS is
3946 the position within OBJECT where the help was found.
3948 Value is the number of input_events generated. */
3951 gen_help_event (help
, frame
, window
, object
, pos
)
3952 Lisp_Object help
, frame
, object
, window
;
3955 struct input_event event
;
3959 event
.kind
= HELP_EVENT
;
3960 event
.frame_or_window
= frame
;
3962 event
.x
= WINDOWP (window
) ? window
: frame
;
3965 kbd_buffer_store_event (&event
);
3969 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3972 kbd_buffer_store_help_event (frame
, help
)
3973 Lisp_Object frame
, help
;
3975 struct input_event event
;
3977 event
.kind
= HELP_EVENT
;
3978 event
.frame_or_window
= frame
;
3983 kbd_buffer_store_event (&event
);
3987 /* Discard any mouse events in the event buffer by setting them to
3990 discard_mouse_events ()
3992 struct input_event
*sp
;
3993 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3995 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3998 if (sp
->kind
== MOUSE_CLICK_EVENT
3999 || sp
->kind
== WHEEL_EVENT
4000 || sp
->kind
== HORIZ_WHEEL_EVENT
4002 || sp
->kind
== GPM_CLICK_EVENT
4004 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
4006 sp
->kind
= NO_EVENT
;
4012 /* Return non-zero if there are any real events waiting in the event
4013 buffer, not counting `NO_EVENT's.
4015 If DISCARD is non-zero, discard NO_EVENT events at the front of
4016 the input queue, possibly leaving the input queue empty if there
4017 are no real input events. */
4020 kbd_buffer_events_waiting (discard
)
4023 struct input_event
*sp
;
4025 for (sp
= kbd_fetch_ptr
;
4026 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
4029 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4036 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
4040 /* Clear input event EVENT. */
4044 struct input_event
*event
;
4046 event
->kind
= NO_EVENT
;
4050 /* Read one event from the event buffer, waiting if necessary.
4051 The value is a Lisp object representing the event.
4052 The value is nil for an event that should be ignored,
4053 or that was handled here.
4054 We always read and discard one event. */
4057 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
4059 int *used_mouse_menu
;
4060 EMACS_TIME
*end_time
;
4069 *kbp
= current_kboard
;
4073 /* Wait until there is input available. */
4076 /* Break loop if there's an unread command event. Needed in
4077 moused window autoselection which uses a timer to insert such
4079 if (CONSP (Vunread_command_events
))
4082 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4084 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4085 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4089 /* If the quit flag is set, then read_char will return
4090 quit_char, so that counts as "available input." */
4091 if (!NILP (Vquit_flag
))
4092 quit_throw_to_read_char ();
4094 /* One way or another, wait until input is available; then, if
4095 interrupt handlers have not read it, read it now. */
4098 wait_for_kbd_input ();
4100 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4104 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4106 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4107 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4112 EMACS_TIME duration
;
4113 EMACS_GET_TIME (duration
);
4114 if (EMACS_TIME_GE (duration
, *end_time
))
4115 return Qnil
; /* finished waiting */
4118 EMACS_SUB_TIME (duration
, *end_time
, duration
);
4119 wait_reading_process_output (EMACS_SECS (duration
),
4120 EMACS_USECS (duration
),
4121 -1, 1, Qnil
, NULL
, 0);
4125 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
4127 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
4128 /* Pass 1 for EXPECT since we just waited to have input. */
4129 read_avail_input (1);
4130 #endif /* not VMS */
4133 if (CONSP (Vunread_command_events
))
4136 first
= XCAR (Vunread_command_events
);
4137 Vunread_command_events
= XCDR (Vunread_command_events
);
4138 *kbp
= current_kboard
;
4142 /* At this point, we know that there is a readable event available
4143 somewhere. If the event queue is empty, then there must be a
4144 mouse movement enabled and available. */
4145 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4147 struct input_event
*event
;
4149 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4153 last_event_timestamp
= event
->timestamp
;
4156 *kbp
= event_to_kboard (event
);
4158 *kbp
= current_kboard
; /* Better than returning null ptr? */
4160 *kbp
= &the_only_kboard
;
4165 /* These two kinds of events get special handling
4166 and don't actually appear to the command loop.
4167 We return nil for them. */
4168 if (event
->kind
== SELECTION_REQUEST_EVENT
4169 || event
->kind
== SELECTION_CLEAR_EVENT
)
4172 struct input_event copy
;
4174 /* Remove it from the buffer before processing it,
4175 since otherwise swallow_events will see it
4176 and process it again. */
4178 kbd_fetch_ptr
= event
+ 1;
4179 input_pending
= readable_events (0);
4180 x_handle_selection_event (©
);
4182 /* We're getting selection request events, but we don't have
4188 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4189 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4191 /* Make an event (delete-frame (FRAME)). */
4192 obj
= Fcons (event
->frame_or_window
, Qnil
);
4193 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4194 kbd_fetch_ptr
= event
+ 1;
4197 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4198 else if (event
->kind
== ICONIFY_EVENT
)
4200 /* Make an event (iconify-frame (FRAME)). */
4201 obj
= Fcons (event
->frame_or_window
, Qnil
);
4202 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4203 kbd_fetch_ptr
= event
+ 1;
4205 else if (event
->kind
== DEICONIFY_EVENT
)
4207 /* Make an event (make-frame-visible (FRAME)). */
4208 obj
= Fcons (event
->frame_or_window
, Qnil
);
4209 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4210 kbd_fetch_ptr
= event
+ 1;
4213 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4215 /* The value doesn't matter here; only the type is tested. */
4216 XSETBUFFER (obj
, current_buffer
);
4217 kbd_fetch_ptr
= event
+ 1;
4219 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4220 || defined (USE_GTK)
4221 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4223 kbd_fetch_ptr
= event
+ 1;
4224 input_pending
= readable_events (0);
4225 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4226 x_activate_menubar (XFRAME (event
->frame_or_window
));
4229 #if defined (WINDOWSNT) || defined (MAC_OS)
4230 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4233 /* Make an event (language-change (KEY_SCRIPT)). */
4234 obj
= Fcons (make_number (event
->code
), Qnil
);
4236 /* Make an event (language-change (FRAME CHARSET LCID)). */
4237 obj
= Fcons (event
->frame_or_window
, Qnil
);
4239 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4240 kbd_fetch_ptr
= event
+ 1;
4243 else if (event
->kind
== SAVE_SESSION_EVENT
)
4245 obj
= Fcons (Qsave_session
, Qnil
);
4246 kbd_fetch_ptr
= event
+ 1;
4248 /* Just discard these, by returning nil.
4249 With MULTI_KBOARD, these events are used as placeholders
4250 when we need to randomly delete events from the queue.
4251 (They shouldn't otherwise be found in the buffer,
4252 but on some machines it appears they do show up
4253 even without MULTI_KBOARD.) */
4254 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4255 mouse events during a popup-menu call. */
4256 else if (event
->kind
== NO_EVENT
)
4257 kbd_fetch_ptr
= event
+ 1;
4258 else if (event
->kind
== HELP_EVENT
)
4260 Lisp_Object object
, position
, help
, frame
, window
;
4262 frame
= event
->frame_or_window
;
4263 object
= event
->arg
;
4264 position
= make_number (event
->code
);
4267 clear_event (event
);
4269 kbd_fetch_ptr
= event
+ 1;
4270 if (!WINDOWP (window
))
4272 obj
= Fcons (Qhelp_echo
,
4273 list5 (frame
, help
, window
, object
, position
));
4275 else if (event
->kind
== FOCUS_IN_EVENT
)
4277 /* Notification of a FocusIn event. The frame receiving the
4278 focus is in event->frame_or_window. Generate a
4279 switch-frame event if necessary. */
4280 Lisp_Object frame
, focus
;
4282 frame
= event
->frame_or_window
;
4283 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4287 if (!EQ (frame
, internal_last_event_frame
)
4288 && !EQ (frame
, selected_frame
))
4289 obj
= make_lispy_switch_frame (frame
);
4290 internal_last_event_frame
= frame
;
4291 kbd_fetch_ptr
= event
+ 1;
4294 else if (event
->kind
== DBUS_EVENT
)
4296 obj
= make_lispy_event (event
);
4297 kbd_fetch_ptr
= event
+ 1;
4302 /* If this event is on a different frame, return a switch-frame this
4303 time, and leave the event in the queue for next time. */
4307 frame
= event
->frame_or_window
;
4309 frame
= XCAR (frame
);
4310 else if (WINDOWP (frame
))
4311 frame
= WINDOW_FRAME (XWINDOW (frame
));
4313 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4317 if (! EQ (frame
, internal_last_event_frame
)
4318 && !EQ (frame
, selected_frame
))
4319 obj
= make_lispy_switch_frame (frame
);
4320 internal_last_event_frame
= frame
;
4322 /* If we didn't decide to make a switch-frame event, go ahead
4323 and build a real event from the queue entry. */
4327 obj
= make_lispy_event (event
);
4329 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4330 || defined (USE_GTK)
4331 /* If this was a menu selection, then set the flag to inhibit
4332 writing to last_nonmenu_event. Don't do this if the event
4333 we're returning is (menu-bar), though; that indicates the
4334 beginning of the menu sequence, and we might as well leave
4335 that as the `event with parameters' for this selection. */
4337 && !EQ (event
->frame_or_window
, event
->arg
)
4338 && (event
->kind
== MENU_BAR_EVENT
4339 || event
->kind
== TOOL_BAR_EVENT
))
4340 *used_mouse_menu
= 1;
4343 /* Wipe out this event, to catch bugs. */
4344 clear_event (event
);
4345 kbd_fetch_ptr
= event
+ 1;
4349 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4350 /* Try generating a mouse motion event. */
4351 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4353 FRAME_PTR f
= some_mouse_moved ();
4354 Lisp_Object bar_window
;
4355 enum scroll_bar_part part
;
4359 *kbp
= current_kboard
;
4360 /* Note that this uses F to determine which terminal to look at.
4361 If there is no valid info, it does not store anything
4362 so x remains nil. */
4365 /* XXX Can f or mouse_position_hook be NULL here? */
4366 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4367 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4368 &part
, &x
, &y
, &time
);
4372 /* Decide if we should generate a switch-frame event. Don't
4373 generate switch-frame events for motion outside of all Emacs
4379 frame
= FRAME_FOCUS_FRAME (f
);
4381 XSETFRAME (frame
, f
);
4383 if (! EQ (frame
, internal_last_event_frame
)
4384 && !EQ (frame
, selected_frame
))
4385 obj
= make_lispy_switch_frame (frame
);
4386 internal_last_event_frame
= frame
;
4389 /* If we didn't decide to make a switch-frame event, go ahead and
4390 return a mouse-motion event. */
4391 if (!NILP (x
) && NILP (obj
))
4392 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4394 #endif /* HAVE_MOUSE || HAVE GPM */
4396 /* We were promised by the above while loop that there was
4397 something for us to read! */
4400 input_pending
= readable_events (0);
4402 Vlast_event_frame
= internal_last_event_frame
;
4407 /* Process any events that are not user-visible,
4408 then return, without reading any user-visible events. */
4411 swallow_events (do_display
)
4416 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4418 struct input_event
*event
;
4420 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4424 last_event_timestamp
= event
->timestamp
;
4426 /* These two kinds of events get special handling
4427 and don't actually appear to the command loop. */
4428 if (event
->kind
== SELECTION_REQUEST_EVENT
4429 || event
->kind
== SELECTION_CLEAR_EVENT
)
4432 struct input_event copy
;
4434 /* Remove it from the buffer before processing it,
4435 since otherwise swallow_events called recursively could see it
4436 and process it again. */
4438 kbd_fetch_ptr
= event
+ 1;
4439 input_pending
= readable_events (0);
4440 x_handle_selection_event (©
);
4442 /* We're getting selection request events, but we don't have
4451 old_timers_run
= timers_run
;
4452 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4454 if (timers_run
!= old_timers_run
&& do_display
)
4455 redisplay_preserve_echo_area (7);
4458 /* Record the start of when Emacs is idle,
4459 for the sake of running idle-time timers. */
4466 /* If we are already in the idle state, do nothing. */
4467 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4470 EMACS_GET_TIME (timer_idleness_start_time
);
4472 timer_last_idleness_start_time
= timer_idleness_start_time
;
4474 /* Mark all idle-time timers as once again candidates for running. */
4475 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4479 timer
= XCAR (timers
);
4481 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4483 XVECTOR (timer
)->contents
[0] = Qnil
;
4487 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4492 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4495 /* Resume idle timer from last idle start time. */
4498 timer_resume_idle ()
4500 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4503 timer_idleness_start_time
= timer_last_idleness_start_time
;
4506 /* This is only for debugging. */
4507 struct input_event last_timer_event
;
4509 /* List of elisp functions to call, delayed because they were generated in
4510 a context where Elisp could not be safely run (e.g. redisplay, signal,
4511 ...). Each lement has the form (FUN . ARGS). */
4512 Lisp_Object pending_funcalls
;
4514 extern Lisp_Object Qapply
;
4516 /* Check whether a timer has fired. To prevent larger problems we simply
4517 disregard elements that are not proper timers. Do not make a circular
4518 timer list for the time being.
4520 Returns the number of seconds to wait until the next timer fires. If a
4521 timer is triggering now, return zero seconds.
4522 If no timer is active, return -1 seconds.
4524 If a timer is ripe, we run it, with quitting turned off.
4526 DO_IT_NOW is now ignored. It used to mean that we should
4527 run the timer directly instead of queueing a timer-event.
4528 Now we always run timers directly. */
4531 timer_check (do_it_now
)
4534 EMACS_TIME nexttime
;
4535 EMACS_TIME now
, idleness_now
;
4536 Lisp_Object timers
, idle_timers
, chosen_timer
;
4537 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4539 EMACS_SET_SECS (nexttime
, -1);
4540 EMACS_SET_USECS (nexttime
, -1);
4542 /* Always consider the ordinary timers. */
4543 timers
= Vtimer_list
;
4544 /* Consider the idle timers only if Emacs is idle. */
4545 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4546 idle_timers
= Vtimer_idle_list
;
4549 chosen_timer
= Qnil
;
4550 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4552 /* First run the code that was delayed. */
4553 while (CONSP (pending_funcalls
))
4555 Lisp_Object funcall
= XCAR (pending_funcalls
);
4556 pending_funcalls
= XCDR (pending_funcalls
);
4557 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4560 if (CONSP (timers
) || CONSP (idle_timers
))
4562 EMACS_GET_TIME (now
);
4563 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4564 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4567 while (CONSP (timers
) || CONSP (idle_timers
))
4569 Lisp_Object
*vector
;
4570 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4571 EMACS_TIME timer_time
, idle_timer_time
;
4572 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4574 /* Skip past invalid timers and timers already handled. */
4577 timer
= XCAR (timers
);
4578 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4580 timers
= XCDR (timers
);
4583 vector
= XVECTOR (timer
)->contents
;
4585 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4586 || !INTEGERP (vector
[3])
4587 || ! NILP (vector
[0]))
4589 timers
= XCDR (timers
);
4593 if (!NILP (idle_timers
))
4595 timer
= XCAR (idle_timers
);
4596 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4598 idle_timers
= XCDR (idle_timers
);
4601 vector
= XVECTOR (timer
)->contents
;
4603 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4604 || !INTEGERP (vector
[3])
4605 || ! NILP (vector
[0]))
4607 idle_timers
= XCDR (idle_timers
);
4612 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4613 based on the next ordinary timer.
4614 TIMER_DIFFERENCE is the distance in time from NOW to when
4615 this timer becomes ripe (negative if it's already ripe). */
4618 timer
= XCAR (timers
);
4619 vector
= XVECTOR (timer
)->contents
;
4620 EMACS_SET_SECS (timer_time
,
4621 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4622 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4623 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4626 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4627 based on the next idle timer. */
4628 if (!NILP (idle_timers
))
4630 idle_timer
= XCAR (idle_timers
);
4631 vector
= XVECTOR (idle_timer
)->contents
;
4632 EMACS_SET_SECS (idle_timer_time
,
4633 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4634 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4635 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4638 /* Decide which timer is the next timer,
4639 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4640 Also step down the list where we found that timer. */
4642 if (! NILP (timers
) && ! NILP (idle_timers
))
4645 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4646 if (EMACS_TIME_NEG_P (temp
))
4648 chosen_timer
= timer
;
4649 timers
= XCDR (timers
);
4650 difference
= timer_difference
;
4654 chosen_timer
= idle_timer
;
4655 idle_timers
= XCDR (idle_timers
);
4656 difference
= idle_timer_difference
;
4659 else if (! NILP (timers
))
4661 chosen_timer
= timer
;
4662 timers
= XCDR (timers
);
4663 difference
= timer_difference
;
4667 chosen_timer
= idle_timer
;
4668 idle_timers
= XCDR (idle_timers
);
4669 difference
= idle_timer_difference
;
4671 vector
= XVECTOR (chosen_timer
)->contents
;
4673 /* If timer is ripe, run it if it hasn't been run. */
4674 if (EMACS_TIME_NEG_P (difference
)
4675 || (EMACS_SECS (difference
) == 0
4676 && EMACS_USECS (difference
) == 0))
4678 if (NILP (vector
[0]))
4680 int count
= SPECPDL_INDEX ();
4681 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4683 #if 0 /* This shouldn't be necessary anymore. --lorentey */
4684 /* On unbind_to, resume allowing input from any kboard, if that
4686 record_single_kboard_state ();
4688 /* Mark the timer as triggered to prevent problems if the lisp
4689 code fails to reschedule it right. */
4692 specbind (Qinhibit_quit
, Qt
);
4694 call1 (Qtimer_event_handler
, chosen_timer
);
4695 Vdeactivate_mark
= old_deactivate_mark
;
4697 unbind_to (count
, Qnil
);
4699 /* Since we have handled the event,
4700 we don't need to tell the caller to wake up and do it. */
4704 /* When we encounter a timer that is still waiting,
4705 return the amount of time to wait before it is ripe. */
4712 /* No timers are pending in the future. */
4713 /* Return 0 if we generated an event, and -1 if not. */
4718 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4719 doc
: /* Return the current length of Emacs idleness, or nil.
4720 The value when Emacs is idle is a list of three integers. The first has the
4721 most significant 16 bits of the seconds, while the second has the
4722 least significant 16 bits. The third integer gives the microsecond
4725 The value when Emacs is not idle is nil.
4727 The microsecond count is zero on systems that do not provide
4728 resolution finer than a second. */)
4731 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4733 EMACS_TIME now
, idleness_now
;
4735 EMACS_GET_TIME (now
);
4736 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4738 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4739 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4740 make_number (EMACS_USECS (idleness_now
)));
4746 /* Caches for modify_event_symbol. */
4747 static Lisp_Object accent_key_syms
;
4748 static Lisp_Object func_key_syms
;
4749 static Lisp_Object mouse_syms
;
4750 static Lisp_Object wheel_syms
;
4751 static Lisp_Object drag_n_drop_syms
;
4753 /* This is a list of keysym codes for special "accent" characters.
4754 It parallels lispy_accent_keys. */
4756 static int lispy_accent_codes
[] =
4758 #ifdef XK_dead_circumflex
4763 #ifdef XK_dead_grave
4768 #ifdef XK_dead_tilde
4773 #ifdef XK_dead_diaeresis
4778 #ifdef XK_dead_macron
4783 #ifdef XK_dead_degree
4788 #ifdef XK_dead_acute
4793 #ifdef XK_dead_cedilla
4798 #ifdef XK_dead_breve
4803 #ifdef XK_dead_ogonek
4808 #ifdef XK_dead_caron
4813 #ifdef XK_dead_doubleacute
4814 XK_dead_doubleacute
,
4818 #ifdef XK_dead_abovedot
4823 #ifdef XK_dead_abovering
4833 #ifdef XK_dead_belowdot
4838 #ifdef XK_dead_voiced_sound
4839 XK_dead_voiced_sound
,
4843 #ifdef XK_dead_semivoiced_sound
4844 XK_dead_semivoiced_sound
,
4860 /* This is a list of Lisp names for special "accent" characters.
4861 It parallels lispy_accent_codes. */
4863 static char *lispy_accent_keys
[] =
4881 "dead-voiced-sound",
4882 "dead-semivoiced-sound",
4888 #define FUNCTION_KEY_OFFSET 0x0
4890 char *lispy_function_keys
[] =
4894 0, /* VK_LBUTTON 0x01 */
4895 0, /* VK_RBUTTON 0x02 */
4896 "cancel", /* VK_CANCEL 0x03 */
4897 0, /* VK_MBUTTON 0x04 */
4899 0, 0, 0, /* 0x05 .. 0x07 */
4901 "backspace", /* VK_BACK 0x08 */
4902 "tab", /* VK_TAB 0x09 */
4904 0, 0, /* 0x0A .. 0x0B */
4906 "clear", /* VK_CLEAR 0x0C */
4907 "return", /* VK_RETURN 0x0D */
4909 0, 0, /* 0x0E .. 0x0F */
4911 0, /* VK_SHIFT 0x10 */
4912 0, /* VK_CONTROL 0x11 */
4913 0, /* VK_MENU 0x12 */
4914 "pause", /* VK_PAUSE 0x13 */
4915 "capslock", /* VK_CAPITAL 0x14 */
4916 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4918 "junja", /* VK_JUNJA 0x17 */
4919 "final", /* VK_FINAL 0x18 */
4920 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4922 "escape", /* VK_ESCAPE 0x1B */
4923 "convert", /* VK_CONVERT 0x1C */
4924 "non-convert", /* VK_NONCONVERT 0x1D */
4925 "accept", /* VK_ACCEPT 0x1E */
4926 "mode-change", /* VK_MODECHANGE 0x1F */
4927 0, /* VK_SPACE 0x20 */
4928 "prior", /* VK_PRIOR 0x21 */
4929 "next", /* VK_NEXT 0x22 */
4930 "end", /* VK_END 0x23 */
4931 "home", /* VK_HOME 0x24 */
4932 "left", /* VK_LEFT 0x25 */
4933 "up", /* VK_UP 0x26 */
4934 "right", /* VK_RIGHT 0x27 */
4935 "down", /* VK_DOWN 0x28 */
4936 "select", /* VK_SELECT 0x29 */
4937 "print", /* VK_PRINT 0x2A */
4938 "execute", /* VK_EXECUTE 0x2B */
4939 "snapshot", /* VK_SNAPSHOT 0x2C */
4940 "insert", /* VK_INSERT 0x2D */
4941 "delete", /* VK_DELETE 0x2E */
4942 "help", /* VK_HELP 0x2F */
4944 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4946 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4948 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4950 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4952 0, 0, 0, 0, 0, 0, 0, 0, 0,
4953 0, 0, 0, 0, 0, 0, 0, 0, 0,
4954 0, 0, 0, 0, 0, 0, 0, 0,
4956 "lwindow", /* VK_LWIN 0x5B */
4957 "rwindow", /* VK_RWIN 0x5C */
4958 "apps", /* VK_APPS 0x5D */
4961 "kp-0", /* VK_NUMPAD0 0x60 */
4962 "kp-1", /* VK_NUMPAD1 0x61 */
4963 "kp-2", /* VK_NUMPAD2 0x62 */
4964 "kp-3", /* VK_NUMPAD3 0x63 */
4965 "kp-4", /* VK_NUMPAD4 0x64 */
4966 "kp-5", /* VK_NUMPAD5 0x65 */
4967 "kp-6", /* VK_NUMPAD6 0x66 */
4968 "kp-7", /* VK_NUMPAD7 0x67 */
4969 "kp-8", /* VK_NUMPAD8 0x68 */
4970 "kp-9", /* VK_NUMPAD9 0x69 */
4971 "kp-multiply", /* VK_MULTIPLY 0x6A */
4972 "kp-add", /* VK_ADD 0x6B */
4973 "kp-separator", /* VK_SEPARATOR 0x6C */
4974 "kp-subtract", /* VK_SUBTRACT 0x6D */
4975 "kp-decimal", /* VK_DECIMAL 0x6E */
4976 "kp-divide", /* VK_DIVIDE 0x6F */
4977 "f1", /* VK_F1 0x70 */
4978 "f2", /* VK_F2 0x71 */
4979 "f3", /* VK_F3 0x72 */
4980 "f4", /* VK_F4 0x73 */
4981 "f5", /* VK_F5 0x74 */
4982 "f6", /* VK_F6 0x75 */
4983 "f7", /* VK_F7 0x76 */
4984 "f8", /* VK_F8 0x77 */
4985 "f9", /* VK_F9 0x78 */
4986 "f10", /* VK_F10 0x79 */
4987 "f11", /* VK_F11 0x7A */
4988 "f12", /* VK_F12 0x7B */
4989 "f13", /* VK_F13 0x7C */
4990 "f14", /* VK_F14 0x7D */
4991 "f15", /* VK_F15 0x7E */
4992 "f16", /* VK_F16 0x7F */
4993 "f17", /* VK_F17 0x80 */
4994 "f18", /* VK_F18 0x81 */
4995 "f19", /* VK_F19 0x82 */
4996 "f20", /* VK_F20 0x83 */
4997 "f21", /* VK_F21 0x84 */
4998 "f22", /* VK_F22 0x85 */
4999 "f23", /* VK_F23 0x86 */
5000 "f24", /* VK_F24 0x87 */
5002 0, 0, 0, 0, /* 0x88 .. 0x8B */
5003 0, 0, 0, 0, /* 0x8C .. 0x8F */
5005 "kp-numlock", /* VK_NUMLOCK 0x90 */
5006 "scroll", /* VK_SCROLL 0x91 */
5007 /* Not sure where the following block comes from.
5008 Windows headers have NEC and Fujitsu specific keys in
5009 this block, but nothing generic. */
5010 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
5011 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
5012 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
5013 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
5014 "kp-end", /* VK_NUMPAD_END 0x96 */
5015 "kp-home", /* VK_NUMPAD_HOME 0x97 */
5016 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
5017 "kp-up", /* VK_NUMPAD_UP 0x99 */
5018 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
5019 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
5020 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
5021 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
5023 0, 0, /* 0x9E .. 0x9F */
5026 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
5027 * Used only as parameters to GetAsyncKeyState and GetKeyState.
5028 * No other API or message will distinguish left and right keys this way.
5033 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
5034 to enable them selectively, and gives access to a few more functions.
5035 See lispy_multimedia_keys below. */
5036 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
5037 0, 0, 0, /* 0xAD .. 0xAF Volume */
5038 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
5039 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
5041 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
5042 0, 0, 0, 0, 0, 0, 0, 0, 0,
5044 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
5045 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5046 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5049 "ax", /* VK_OEM_AX 0xE1 */
5050 0, /* VK_OEM_102 0xE2 */
5051 "ico-help", /* VK_ICO_HELP 0xE3 */
5052 "ico-00", /* VK_ICO_00 0xE4 */
5053 0, /* VK_PROCESSKEY 0xE5 */
5054 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
5055 "packet", /* VK_PACKET 0xE7 */
5057 "reset", /* VK_OEM_RESET 0xE9 */
5058 "jump", /* VK_OEM_JUMP 0xEA */
5059 "oem-pa1", /* VK_OEM_PA1 0xEB */
5060 "oem-pa2", /* VK_OEM_PA2 0xEC */
5061 "oem-pa3", /* VK_OEM_PA3 0xED */
5062 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
5063 "cusel", /* VK_OEM_CUSEL 0xEF */
5064 "oem-attn", /* VK_OEM_ATTN 0xF0 */
5065 "finish", /* VK_OEM_FINISH 0xF1 */
5066 "copy", /* VK_OEM_COPY 0xF2 */
5067 "auto", /* VK_OEM_AUTO 0xF3 */
5068 "enlw", /* VK_OEM_ENLW 0xF4 */
5069 "backtab", /* VK_OEM_BACKTAB 0xF5 */
5070 "attn", /* VK_ATTN 0xF6 */
5071 "crsel", /* VK_CRSEL 0xF7 */
5072 "exsel", /* VK_EXSEL 0xF8 */
5073 "ereof", /* VK_EREOF 0xF9 */
5074 "play", /* VK_PLAY 0xFA */
5075 "zoom", /* VK_ZOOM 0xFB */
5076 "noname", /* VK_NONAME 0xFC */
5077 "pa1", /* VK_PA1 0xFD */
5078 "oem_clear", /* VK_OEM_CLEAR 0xFE */
5082 /* Some of these duplicate the "Media keys" on newer keyboards,
5083 but they are delivered to the application in a different way. */
5084 static char *lispy_multimedia_keys
[] =
5092 "browser-favorites",
5129 "toggle-dictate-command",
5135 "media-fast-forward",
5138 "media-channel-down"
5141 #else /* not HAVE_NTGUI */
5143 /* This should be dealt with in XTread_socket now, and that doesn't
5144 depend on the client system having the Kana syms defined. See also
5145 the XK_kana_A case below. */
5148 static char *lispy_kana_keys
[] =
5150 /* X Keysym value */
5151 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5152 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5153 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5154 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5155 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5156 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5157 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5158 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5159 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5160 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5161 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5162 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5163 "kana-i", "kana-u", "kana-e", "kana-o",
5164 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5165 "prolongedsound", "kana-A", "kana-I", "kana-U",
5166 "kana-E", "kana-O", "kana-KA", "kana-KI",
5167 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5168 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5169 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5170 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5171 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5172 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5173 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5174 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5175 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5176 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5177 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5178 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5180 #endif /* XK_kana_A */
5183 #define FUNCTION_KEY_OFFSET 0xff00
5185 /* You'll notice that this table is arranged to be conveniently
5186 indexed by X Windows keysym values. */
5187 static char *lispy_function_keys
[] =
5189 /* X Keysym value */
5191 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5192 "backspace", "tab", "linefeed", "clear",
5194 0, 0, 0, "pause", /* 0xff10...1f */
5195 0, 0, 0, 0, 0, 0, 0, "escape",
5197 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5198 "romaji", "hiragana", "katakana", "hiragana-katakana",
5199 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5200 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5201 "eisu-toggle", /* 0xff30...3f */
5202 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5203 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5205 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5206 "down", "prior", "next", "end",
5207 "begin", 0, 0, 0, 0, 0, 0, 0,
5208 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5219 "break", /* 0xff6b */
5222 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5223 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5224 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5225 0, 0, 0, 0, 0, 0, 0, 0,
5226 "kp-tab", /* 0xff89 */
5228 "kp-enter", /* 0xff8d */
5230 "kp-f1", /* 0xff91 */
5234 "kp-home", /* 0xff95 */
5239 "kp-prior", /* kp-page-up */
5240 "kp-next", /* kp-page-down */
5246 0, 0, 0, 0, 0, 0, 0, 0, 0,
5247 "kp-multiply", /* 0xffaa */
5252 "kp-divide", /* 0xffaf */
5253 "kp-0", /* 0xffb0 */
5254 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5257 "kp-equal", /* 0xffbd */
5258 "f1", /* 0xffbe */ /* IsFunctionKey */
5260 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5261 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5262 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5263 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5264 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5265 0, 0, 0, 0, 0, 0, 0, 0,
5266 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5267 0, 0, 0, 0, 0, 0, 0, "delete"
5270 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5271 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5273 static char *iso_lispy_function_keys
[] =
5275 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5276 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5277 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5278 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5279 "iso-lefttab", /* 0xfe20 */
5280 "iso-move-line-up", "iso-move-line-down",
5281 "iso-partial-line-up", "iso-partial-line-down",
5282 "iso-partial-space-left", "iso-partial-space-right",
5283 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5284 "iso-release-margin-left", "iso-release-margin-right",
5285 "iso-release-both-margins",
5286 "iso-fast-cursor-left", "iso-fast-cursor-right",
5287 "iso-fast-cursor-up", "iso-fast-cursor-down",
5288 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5289 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5292 #endif /* not HAVE_NTGUI */
5294 Lisp_Object Vlispy_mouse_stem
;
5296 static char *lispy_wheel_names
[] =
5298 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5301 /* drag-n-drop events are generated when a set of selected files are
5302 dragged from another application and dropped onto an Emacs window. */
5303 static char *lispy_drag_n_drop_names
[] =
5308 /* Scroll bar parts. */
5309 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5310 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5311 Lisp_Object Qtop
, Qratio
;
5313 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5314 Lisp_Object
*scroll_bar_parts
[] = {
5315 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5316 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5319 /* A vector, indexed by button number, giving the down-going location
5320 of currently depressed buttons, both scroll bar and non-scroll bar.
5322 The elements have the form
5323 (BUTTON-NUMBER MODIFIER-MASK . REST)
5324 where REST is the cdr of a position as it would be reported in the event.
5326 The make_lispy_event function stores positions here to tell the
5327 difference between click and drag events, and to store the starting
5328 location to be included in drag events. */
5330 static Lisp_Object button_down_location
;
5332 /* Information about the most recent up-going button event: Which
5333 button, what location, and what time. */
5335 static int last_mouse_button
;
5336 static int last_mouse_x
;
5337 static int last_mouse_y
;
5338 static unsigned long button_down_time
;
5340 /* The maximum time between clicks to make a double-click, or Qnil to
5341 disable double-click detection, or Qt for no time limit. */
5343 Lisp_Object Vdouble_click_time
;
5345 /* Maximum number of pixels the mouse may be moved between clicks
5346 to make a double-click. */
5348 EMACS_INT double_click_fuzz
;
5350 /* The number of clicks in this multiple-click. */
5352 int double_click_count
;
5354 /* Return position of a mouse click or wheel event */
5357 make_lispy_position (f
, x
, y
, time
)
5363 enum window_part part
;
5364 Lisp_Object posn
= Qnil
;
5365 Lisp_Object extra_info
= Qnil
;
5368 /* Set `window' to the window under frame pixel coordinates (x,y) */
5370 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5371 &part
, &wx
, &wy
, 0);
5375 if (WINDOWP (window
))
5377 /* It's a click in window window at frame coordinates (x,y) */
5378 struct window
*w
= XWINDOW (window
);
5379 Lisp_Object string_info
= Qnil
;
5380 int textpos
= -1, rx
= -1, ry
= -1;
5381 int dx
= -1, dy
= -1;
5382 int width
= -1, height
= -1;
5383 Lisp_Object object
= Qnil
;
5385 /* Set event coordinates to window-relative coordinates
5386 for constructing the Lisp event below. */
5390 if (part
== ON_TEXT
)
5392 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5394 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5396 /* Mode line or header line. Look for a string under
5397 the mouse that may have a `local-map' property. */
5401 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5403 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5404 &object
, &dx
, &dy
, &width
, &height
);
5405 if (STRINGP (string
))
5406 string_info
= Fcons (string
, make_number (charpos
));
5407 if (w
== XWINDOW (selected_window
))
5410 textpos
= XMARKER (w
->pointm
)->charpos
;
5412 else if (part
== ON_VERTICAL_BORDER
)
5414 posn
= Qvertical_line
;
5419 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5424 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5426 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5427 &object
, &dx
, &dy
, &width
, &height
);
5428 if (STRINGP (string
))
5429 string_info
= Fcons (string
, make_number (charpos
));
5430 if (part
== ON_LEFT_MARGIN
)
5433 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5435 else if (part
== ON_LEFT_FRINGE
)
5437 posn
= Qleft_fringe
;
5440 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5442 : window_box_width (w
, LEFT_MARGIN_AREA
));
5445 else if (part
== ON_RIGHT_FRINGE
)
5447 posn
= Qright_fringe
;
5450 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5451 + window_box_width (w
, TEXT_AREA
)
5452 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5453 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5459 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5460 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5465 Lisp_Object string2
, object2
= Qnil
;
5466 struct display_pos p
;
5468 int width2
, height2
;
5469 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5470 &object2
, &dx2
, &dy2
,
5472 textpos
= CHARPOS (p
.pos
);
5473 if (rx
< 0) rx
= wx
;
5474 if (ry
< 0) ry
= wy
;
5475 if (dx
< 0) dx
= dx2
;
5476 if (dy
< 0) dy
= dy2
;
5477 if (width
< 0) width
= width2
;
5478 if (height
< 0) height
= height2
;
5482 posn
= make_number (textpos
);
5483 if (STRINGP (string2
))
5484 string_info
= Fcons (string2
,
5485 make_number (CHARPOS (p
.string_pos
)));
5491 #ifdef HAVE_WINDOW_SYSTEM
5492 if (IMAGEP (object
))
5494 Lisp_Object image_map
, hotspot
;
5495 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5497 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5499 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5500 posn
= XCAR (hotspot
);
5505 extra_info
= Fcons (object
,
5506 Fcons (Fcons (make_number (dx
),
5508 Fcons (Fcons (make_number (width
),
5509 make_number (height
)),
5513 extra_info
= Fcons (string_info
,
5514 Fcons (make_number (textpos
),
5515 Fcons (Fcons (make_number (rx
),
5521 XSETFRAME (window
, f
);
5526 XSETFASTINT (*x
, 0);
5527 XSETFASTINT (*y
, 0);
5530 return Fcons (window
,
5532 Fcons (Fcons (*x
, *y
),
5533 Fcons (make_number (time
),
5537 /* Given a struct input_event, build the lisp event which represents
5538 it. If EVENT is 0, build a mouse movement event from the mouse
5539 movement buffer, which should have a movement event in it.
5541 Note that events must be passed to this function in the order they
5542 are received; this function stores the location of button presses
5543 in order to build drag events when the button is released. */
5546 make_lispy_event (event
)
5547 struct input_event
*event
;
5551 switch (SWITCH_ENUM_CAST (event
->kind
))
5553 /* A simple keystroke. */
5554 case ASCII_KEYSTROKE_EVENT
:
5555 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5557 Lisp_Object lispy_c
;
5558 int c
= event
->code
;
5559 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5562 eassert (c
== event
->code
);
5563 /* Turn ASCII characters into control characters
5565 if (event
->modifiers
& ctrl_modifier
)
5567 c
= make_ctrl_char (c
);
5568 event
->modifiers
&= ~ctrl_modifier
;
5572 /* Add in the other modifier bits. The shift key was taken care
5573 of by the X code. */
5574 c
|= (event
->modifiers
5575 & (meta_modifier
| alt_modifier
5576 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5577 /* Distinguish Shift-SPC from SPC. */
5578 if ((event
->code
) == 040
5579 && event
->modifiers
& shift_modifier
)
5580 c
|= shift_modifier
;
5581 button_down_time
= 0;
5582 XSETFASTINT (lispy_c
, c
);
5586 /* A function key. The symbol may need to have modifier prefixes
5588 case NON_ASCII_KEYSTROKE_EVENT
:
5589 button_down_time
= 0;
5591 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5592 if (event
->code
== lispy_accent_codes
[i
])
5593 return modify_event_symbol (i
,
5595 Qfunction_key
, Qnil
,
5596 lispy_accent_keys
, &accent_key_syms
,
5597 (sizeof (lispy_accent_keys
)
5598 / sizeof (lispy_accent_keys
[0])));
5602 if (event
->code
>= 0x400 && event
->code
< 0x500)
5603 return modify_event_symbol (event
->code
- 0x400,
5604 event
->modifiers
& ~shift_modifier
,
5605 Qfunction_key
, Qnil
,
5606 lispy_kana_keys
, &func_key_syms
,
5607 (sizeof (lispy_kana_keys
)
5608 / sizeof (lispy_kana_keys
[0])));
5609 #endif /* XK_kana_A */
5612 #ifdef ISO_FUNCTION_KEY_OFFSET
5613 if (event
->code
< FUNCTION_KEY_OFFSET
5614 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5615 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5617 Qfunction_key
, Qnil
,
5618 iso_lispy_function_keys
, &func_key_syms
,
5619 (sizeof (iso_lispy_function_keys
)
5620 / sizeof (iso_lispy_function_keys
[0])));
5623 /* Handle system-specific or unknown keysyms. */
5624 if (event
->code
& (1 << 28)
5625 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5626 || (event
->code
- FUNCTION_KEY_OFFSET
5627 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5628 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5630 /* We need to use an alist rather than a vector as the cache
5631 since we can't make a vector long enuf. */
5632 if (NILP (current_kboard
->system_key_syms
))
5633 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5634 return modify_event_symbol (event
->code
,
5637 current_kboard
->Vsystem_key_alist
,
5638 0, ¤t_kboard
->system_key_syms
,
5642 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5644 Qfunction_key
, Qnil
,
5645 lispy_function_keys
, &func_key_syms
,
5646 (sizeof (lispy_function_keys
)
5647 / sizeof (lispy_function_keys
[0])));
5650 case MULTIMEDIA_KEY_EVENT
:
5651 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5652 / sizeof (lispy_multimedia_keys
[0]))
5653 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5655 return modify_event_symbol (event
->code
, event
->modifiers
,
5656 Qfunction_key
, Qnil
,
5657 lispy_multimedia_keys
, &func_key_syms
,
5658 (sizeof (lispy_multimedia_keys
)
5659 / sizeof (lispy_multimedia_keys
[0])));
5665 /* A mouse click. Figure out where it is, decide whether it's
5666 a press, click or drag, and build the appropriate structure. */
5667 case MOUSE_CLICK_EVENT
:
5668 #ifndef USE_TOOLKIT_SCROLL_BARS
5669 case SCROLL_BAR_CLICK_EVENT
:
5672 int button
= event
->code
;
5674 Lisp_Object position
;
5675 Lisp_Object
*start_pos_ptr
;
5676 Lisp_Object start_pos
;
5680 /* Build the position as appropriate for this mouse click. */
5681 if (event
->kind
== MOUSE_CLICK_EVENT
)
5683 struct frame
*f
= XFRAME (event
->frame_or_window
);
5684 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5688 /* Ignore mouse events that were made on frame that
5689 have been deleted. */
5690 if (! FRAME_LIVE_P (f
))
5693 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5694 /* EVENT->x and EVENT->y are frame-relative pixel
5695 coordinates at this place. Under old redisplay, COLUMN
5696 and ROW are set to frame relative glyph coordinates
5697 which are then used to determine whether this click is
5698 in a menu (non-toolkit version). */
5699 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5700 &column
, &row
, NULL
, 1);
5702 /* In the non-toolkit version, clicks on the menu bar
5703 are ordinary button events in the event buffer.
5704 Distinguish them, and invoke the menu.
5706 (In the toolkit version, the toolkit handles the menu bar
5707 and Emacs doesn't know about it until after the user
5708 makes a selection.) */
5709 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5710 && (event
->modifiers
& down_modifier
))
5712 Lisp_Object items
, item
;
5717 /* Activate the menu bar on the down event. If the
5718 up event comes in before the menu code can deal with it,
5720 if (! (event
->modifiers
& down_modifier
))
5724 /* Find the menu bar item under `column'. */
5726 items
= FRAME_MENU_BAR_ITEMS (f
);
5727 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5729 Lisp_Object pos
, string
;
5730 string
= AREF (items
, i
+ 1);
5731 pos
= AREF (items
, i
+ 3);
5734 if (column
>= XINT (pos
)
5735 && column
< XINT (pos
) + SCHARS (string
))
5737 item
= AREF (items
, i
);
5742 /* ELisp manual 2.4b says (x y) are window relative but
5743 code says they are frame-relative. */
5745 = Fcons (event
->frame_or_window
,
5747 Fcons (Fcons (event
->x
, event
->y
),
5748 Fcons (make_number (event
->timestamp
),
5751 return Fcons (item
, Fcons (position
, Qnil
));
5753 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5755 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5758 #ifndef USE_TOOLKIT_SCROLL_BARS
5761 /* It's a scrollbar click. */
5763 Lisp_Object portion_whole
;
5766 window
= event
->frame_or_window
;
5767 portion_whole
= Fcons (event
->x
, event
->y
);
5768 part
= *scroll_bar_parts
[(int) event
->part
];
5772 Fcons (Qvertical_scroll_bar
,
5773 Fcons (portion_whole
,
5774 Fcons (make_number (event
->timestamp
),
5775 Fcons (part
, Qnil
)))));
5777 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5779 if (button
>= ASIZE (button_down_location
))
5781 button_down_location
= larger_vector (button_down_location
,
5783 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5786 start_pos_ptr
= &AREF (button_down_location
, button
);
5787 start_pos
= *start_pos_ptr
;
5788 *start_pos_ptr
= Qnil
;
5791 /* On window-system frames, use the value of
5792 double-click-fuzz as is. On other frames, interpret it
5793 as a multiple of 1/8 characters. */
5797 if (WINDOWP (event
->frame_or_window
))
5798 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5799 else if (FRAMEP (event
->frame_or_window
))
5800 f
= XFRAME (event
->frame_or_window
);
5804 if (FRAME_WINDOW_P (f
))
5805 fuzz
= double_click_fuzz
;
5807 fuzz
= double_click_fuzz
/ 8;
5809 is_double
= (button
== last_mouse_button
5810 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5811 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5812 && button_down_time
!= 0
5813 && (EQ (Vdouble_click_time
, Qt
)
5814 || (INTEGERP (Vdouble_click_time
)
5815 && ((int)(event
->timestamp
- button_down_time
)
5816 < XINT (Vdouble_click_time
)))));
5819 last_mouse_button
= button
;
5820 last_mouse_x
= XINT (event
->x
);
5821 last_mouse_y
= XINT (event
->y
);
5823 /* If this is a button press, squirrel away the location, so
5824 we can decide later whether it was a click or a drag. */
5825 if (event
->modifiers
& down_modifier
)
5829 double_click_count
++;
5830 event
->modifiers
|= ((double_click_count
> 2)
5835 double_click_count
= 1;
5836 button_down_time
= event
->timestamp
;
5837 *start_pos_ptr
= Fcopy_alist (position
);
5838 ignore_mouse_drag_p
= 0;
5841 /* Now we're releasing a button - check the co-ordinates to
5842 see if this was a click or a drag. */
5843 else if (event
->modifiers
& up_modifier
)
5845 /* If we did not see a down before this up, ignore the up.
5846 Probably this happened because the down event chose a
5847 menu item. It would be an annoyance to treat the
5848 release of the button that chose the menu item as a
5851 if (!CONSP (start_pos
))
5854 event
->modifiers
&= ~up_modifier
;
5855 #if 0 /* Formerly we treated an up with no down as a click event. */
5856 if (!CONSP (start_pos
))
5857 event
->modifiers
|= click_modifier
;
5862 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5864 /* The third element of every position
5865 should be the (x,y) pair. */
5866 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5868 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5870 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5871 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5874 if (ignore_mouse_drag_p
)
5876 event
->modifiers
|= click_modifier
;
5877 ignore_mouse_drag_p
= 0;
5879 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5880 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5881 /* Maybe the mouse has moved a lot, caused scrolling, and
5882 eventually ended up at the same screen position (but
5883 not buffer position) in which case it is a drag, not
5885 /* FIXME: OTOH if the buffer position has changed
5886 because of a timer or process filter rather than
5887 because of mouse movement, it should be considered as
5888 a click. But mouse-drag-region completely ignores
5889 this case and it hasn't caused any real problem, so
5890 it's probably OK to ignore it as well. */
5891 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5892 /* Mouse hasn't moved (much). */
5893 event
->modifiers
|= click_modifier
;
5896 button_down_time
= 0;
5897 event
->modifiers
|= drag_modifier
;
5900 /* Don't check is_double; treat this as multiple
5901 if the down-event was multiple. */
5902 if (double_click_count
> 1)
5903 event
->modifiers
|= ((double_click_count
> 2)
5909 /* Every mouse event should either have the down_modifier or
5910 the up_modifier set. */
5914 /* Get the symbol we should use for the mouse click. */
5917 head
= modify_event_symbol (button
,
5919 Qmouse_click
, Vlispy_mouse_stem
,
5922 XVECTOR (mouse_syms
)->size
);
5923 if (event
->modifiers
& drag_modifier
)
5928 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5931 Fcons (make_number (double_click_count
),
5941 case HORIZ_WHEEL_EVENT
:
5943 Lisp_Object position
;
5946 /* Build the position as appropriate for this mouse click. */
5947 struct frame
*f
= XFRAME (event
->frame_or_window
);
5949 /* Ignore wheel events that were made on frame that have been
5951 if (! FRAME_LIVE_P (f
))
5954 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5957 /* Set double or triple modifiers to indicate the wheel speed. */
5959 /* On window-system frames, use the value of
5960 double-click-fuzz as is. On other frames, interpret it
5961 as a multiple of 1/8 characters. */
5966 if (WINDOWP (event
->frame_or_window
))
5967 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5968 else if (FRAMEP (event
->frame_or_window
))
5969 f
= XFRAME (event
->frame_or_window
);
5973 if (FRAME_WINDOW_P (f
))
5974 fuzz
= double_click_fuzz
;
5976 fuzz
= double_click_fuzz
/ 8;
5978 is_double
= (last_mouse_button
< 0
5979 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5980 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5981 && button_down_time
!= 0
5982 && (EQ (Vdouble_click_time
, Qt
)
5983 || (INTEGERP (Vdouble_click_time
)
5984 && ((int)(event
->timestamp
- button_down_time
)
5985 < XINT (Vdouble_click_time
)))));
5988 double_click_count
++;
5989 event
->modifiers
|= ((double_click_count
> 2)
5995 double_click_count
= 1;
5996 event
->modifiers
|= click_modifier
;
5999 button_down_time
= event
->timestamp
;
6000 /* Use a negative value to distinguish wheel from mouse button. */
6001 last_mouse_button
= -1;
6002 last_mouse_x
= XINT (event
->x
);
6003 last_mouse_y
= XINT (event
->y
);
6009 if (event
->modifiers
& up_modifier
)
6011 /* Emit a wheel-up event. */
6012 event
->modifiers
&= ~up_modifier
;
6015 else if (event
->modifiers
& down_modifier
)
6017 /* Emit a wheel-down event. */
6018 event
->modifiers
&= ~down_modifier
;
6022 /* Every wheel event should either have the down_modifier or
6023 the up_modifier set. */
6026 if (event
->kind
== HORIZ_WHEEL_EVENT
)
6029 /* Get the symbol we should use for the wheel event. */
6030 head
= modify_event_symbol (symbol_num
,
6036 ASIZE (wheel_syms
));
6039 if (event
->modifiers
& (double_modifier
| triple_modifier
))
6042 Fcons (make_number (double_click_count
),
6051 #ifdef USE_TOOLKIT_SCROLL_BARS
6053 /* We don't have down and up events if using toolkit scroll bars,
6054 so make this always a click event. Store in the `part' of
6055 the Lisp event a symbol which maps to the following actions:
6057 `above_handle' page up
6058 `below_handle' page down
6062 `bottom' bottom of buffer
6063 `handle' thumb has been dragged.
6064 `end-scroll' end of interaction with scroll bar
6066 The incoming input_event contains in its `part' member an
6067 index of type `enum scroll_bar_part' which we can use as an
6068 index in scroll_bar_parts to get the appropriate symbol. */
6070 case SCROLL_BAR_CLICK_EVENT
:
6072 Lisp_Object position
, head
, window
, portion_whole
, part
;
6074 window
= event
->frame_or_window
;
6075 portion_whole
= Fcons (event
->x
, event
->y
);
6076 part
= *scroll_bar_parts
[(int) event
->part
];
6080 Fcons (Qvertical_scroll_bar
,
6081 Fcons (portion_whole
,
6082 Fcons (make_number (event
->timestamp
),
6083 Fcons (part
, Qnil
)))));
6085 /* Always treat scroll bar events as clicks. */
6086 event
->modifiers
|= click_modifier
;
6087 event
->modifiers
&= ~up_modifier
;
6089 if (event
->code
>= ASIZE (mouse_syms
))
6090 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
6092 /* Get the symbol we should use for the mouse click. */
6093 head
= modify_event_symbol (event
->code
,
6098 XVECTOR (mouse_syms
)->size
);
6099 return Fcons (head
, Fcons (position
, Qnil
));
6102 #endif /* USE_TOOLKIT_SCROLL_BARS */
6104 case DRAG_N_DROP_EVENT
:
6107 Lisp_Object head
, position
;
6110 f
= XFRAME (event
->frame_or_window
);
6113 /* Ignore mouse events that were made on frames that
6114 have been deleted. */
6115 if (! FRAME_LIVE_P (f
))
6118 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6121 head
= modify_event_symbol (0, event
->modifiers
,
6123 lispy_drag_n_drop_names
,
6124 &drag_n_drop_syms
, 1);
6130 #endif /* HAVE_MOUSE */
6132 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
6133 || defined (USE_GTK)
6134 case MENU_BAR_EVENT
:
6135 if (EQ (event
->arg
, event
->frame_or_window
))
6136 /* This is the prefix key. We translate this to
6137 `(menu_bar)' because the code in keyboard.c for menu
6138 events, which we use, relies on this. */
6139 return Fcons (Qmenu_bar
, Qnil
);
6143 case SELECT_WINDOW_EVENT
:
6144 /* Make an event (select-window (WINDOW)). */
6145 return Fcons (Qselect_window
,
6146 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6149 case TOOL_BAR_EVENT
:
6150 if (EQ (event
->arg
, event
->frame_or_window
))
6151 /* This is the prefix key. We translate this to
6152 `(tool_bar)' because the code in keyboard.c for tool bar
6153 events, which we use, relies on this. */
6154 return Fcons (Qtool_bar
, Qnil
);
6155 else if (SYMBOLP (event
->arg
))
6156 return apply_modifiers (event
->modifiers
, event
->arg
);
6159 case USER_SIGNAL_EVENT
:
6160 /* A user signal. */
6162 char *name
= find_user_signal_name (event
->code
);
6165 return intern (name
);
6168 case SAVE_SESSION_EVENT
:
6169 return Qsave_session
;
6172 case MAC_APPLE_EVENT
:
6174 Lisp_Object spec
[2];
6178 return Fcons (Qmac_apple_event
,
6179 Fcons (Fvector (2, spec
),
6180 Fcons (event
->arg
, Qnil
)));
6187 return Fcons (Qdbus_event
, event
->arg
);
6189 #endif /* HAVE_DBUS */
6192 case GPM_CLICK_EVENT
:
6194 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6195 Lisp_Object head
, position
;
6196 Lisp_Object
*start_pos_ptr
;
6197 Lisp_Object start_pos
;
6198 int button
= event
->code
;
6200 if (button
>= ASIZE (button_down_location
))
6202 button_down_location
= larger_vector (button_down_location
,
6204 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6207 start_pos_ptr
= &AREF (button_down_location
, button
);
6208 start_pos
= *start_pos_ptr
;
6210 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6213 if (event
->modifiers
& down_modifier
)
6214 *start_pos_ptr
= Fcopy_alist (position
);
6215 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6217 if (!CONSP (start_pos
))
6219 event
->modifiers
&= ~up_modifier
;
6222 head
= modify_event_symbol (button
,
6224 Qmouse_click
, Vlispy_mouse_stem
,
6227 XVECTOR (mouse_syms
)->size
);
6229 if (event
->modifiers
& drag_modifier
)
6234 else if (event
->modifiers
& double_modifier
)
6237 Fcons (make_number (2),
6239 else if (event
->modifiers
& triple_modifier
)
6242 Fcons (make_number (3),
6249 #endif /* HAVE_GPM */
6251 /* The 'kind' field of the event is something we don't recognize. */
6257 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6260 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6262 Lisp_Object bar_window
;
6263 enum scroll_bar_part part
;
6267 /* Is it a scroll bar movement? */
6268 if (frame
&& ! NILP (bar_window
))
6270 Lisp_Object part_sym
;
6272 part_sym
= *scroll_bar_parts
[(int) part
];
6273 return Fcons (Qscroll_bar_movement
,
6274 (Fcons (Fcons (bar_window
,
6275 Fcons (Qvertical_scroll_bar
,
6276 Fcons (Fcons (x
, y
),
6277 Fcons (make_number (time
),
6283 /* Or is it an ordinary mouse movement? */
6286 Lisp_Object position
;
6288 position
= make_lispy_position (frame
, &x
, &y
, time
);
6290 return Fcons (Qmouse_movement
,
6296 #endif /* HAVE_MOUSE || HAVE GPM */
6298 /* Construct a switch frame event. */
6300 make_lispy_switch_frame (frame
)
6303 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6306 /* Manipulating modifiers. */
6308 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6310 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6311 SYMBOL's name of the end of the modifiers; the string from this
6312 position is the unmodified symbol name.
6314 This doesn't use any caches. */
6317 parse_modifiers_uncached (symbol
, modifier_end
)
6325 CHECK_SYMBOL (symbol
);
6328 name
= SYMBOL_NAME (symbol
);
6330 for (i
= 0; i
+2 <= SBYTES (name
); )
6332 int this_mod_end
= 0;
6335 /* See if the name continues with a modifier word.
6336 Check that the word appears, but don't check what follows it.
6337 Set this_mod and this_mod_end to record what we find. */
6339 switch (SREF (name
, i
))
6341 #define SINGLE_LETTER_MOD(BIT) \
6342 (this_mod_end = i + 1, this_mod = BIT)
6345 SINGLE_LETTER_MOD (alt_modifier
);
6349 SINGLE_LETTER_MOD (ctrl_modifier
);
6353 SINGLE_LETTER_MOD (hyper_modifier
);
6357 SINGLE_LETTER_MOD (meta_modifier
);
6361 SINGLE_LETTER_MOD (shift_modifier
);
6365 SINGLE_LETTER_MOD (super_modifier
);
6368 #undef SINGLE_LETTER_MOD
6370 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6371 if (i + LEN + 1 <= SBYTES (name) \
6372 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6374 this_mod_end = i + LEN; \
6379 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6380 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6381 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6385 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6387 #undef MULTI_LETTER_MOD
6391 /* If we found no modifier, stop looking for them. */
6392 if (this_mod_end
== 0)
6395 /* Check there is a dash after the modifier, so that it
6396 really is a modifier. */
6397 if (this_mod_end
>= SBYTES (name
)
6398 || SREF (name
, this_mod_end
) != '-')
6401 /* This modifier is real; look for another. */
6402 modifiers
|= this_mod
;
6403 i
= this_mod_end
+ 1;
6406 /* Should we include the `click' modifier? */
6407 if (! (modifiers
& (down_modifier
| drag_modifier
6408 | double_modifier
| triple_modifier
))
6409 && i
+ 7 == SBYTES (name
)
6410 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6411 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6412 modifiers
|= click_modifier
;
6420 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6421 prepended to the string BASE[0..BASE_LEN-1].
6422 This doesn't use any caches. */
6424 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6427 int base_len
, base_len_byte
;
6429 /* Since BASE could contain nulls, we can't use intern here; we have
6430 to use Fintern, which expects a genuine Lisp_String, and keeps a
6433 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6439 /* Only the event queue may use the `up' modifier; it should always
6440 be turned into a click or drag event before presented to lisp code. */
6441 if (modifiers
& up_modifier
)
6444 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6445 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6446 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6447 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6448 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6449 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6450 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6451 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6452 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6453 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6454 /* The click modifier is denoted by the absence of other modifiers. */
6458 mod_len
= p
- new_mods
;
6462 Lisp_Object new_name
;
6464 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6465 mod_len
+ base_len_byte
);
6466 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6467 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6469 return Fintern (new_name
, Qnil
);
6474 static char *modifier_names
[] =
6476 "up", "down", "drag", "click", "double", "triple", 0, 0,
6477 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6478 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6480 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6482 static Lisp_Object modifier_symbols
;
6484 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6486 lispy_modifier_list (modifiers
)
6489 Lisp_Object modifier_list
;
6492 modifier_list
= Qnil
;
6493 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6494 if (modifiers
& (1<<i
))
6495 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6498 return modifier_list
;
6502 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6503 where UNMODIFIED is the unmodified form of SYMBOL,
6504 MASK is the set of modifiers present in SYMBOL's name.
6505 This is similar to parse_modifiers_uncached, but uses the cache in
6506 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6507 Qevent_symbol_elements property. */
6509 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6512 parse_modifiers (symbol
)
6515 Lisp_Object elements
;
6517 if (INTEGERP (symbol
))
6518 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6519 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6521 else if (!SYMBOLP (symbol
))
6524 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6525 if (CONSP (elements
))
6530 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6531 Lisp_Object unmodified
;
6534 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6535 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6538 if (modifiers
& ~INTMASK
)
6540 XSETFASTINT (mask
, modifiers
);
6541 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6543 /* Cache the parsing results on SYMBOL. */
6544 Fput (symbol
, Qevent_symbol_element_mask
,
6546 Fput (symbol
, Qevent_symbol_elements
,
6547 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6549 /* Since we know that SYMBOL is modifiers applied to unmodified,
6550 it would be nice to put that in unmodified's cache.
6551 But we can't, since we're not sure that parse_modifiers is
6558 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6559 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6560 doc
: /* Parse the event symbol. For internal use. */)
6564 /* Fill the cache if needed. */
6565 parse_modifiers (symbol
);
6566 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6567 and use the Lispier representation stored on Qevent_symbol_elements
6569 return Fget (symbol
, Qevent_symbol_elements
);
6572 /* Apply the modifiers MODIFIERS to the symbol BASE.
6573 BASE must be unmodified.
6575 This is like apply_modifiers_uncached, but uses BASE's
6576 Qmodifier_cache property, if present. It also builds
6577 Qevent_symbol_elements properties, since it has that info anyway.
6579 apply_modifiers copies the value of BASE's Qevent_kind property to
6580 the modified symbol. */
6582 apply_modifiers (modifiers
, base
)
6586 Lisp_Object cache
, index
, entry
, new_symbol
;
6588 /* Mask out upper bits. We don't know where this value's been. */
6589 modifiers
&= INTMASK
;
6591 if (INTEGERP (base
))
6592 return make_number (XINT (base
) | modifiers
);
6594 /* The click modifier never figures into cache indices. */
6595 cache
= Fget (base
, Qmodifier_cache
);
6596 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6597 entry
= assq_no_quit (index
, cache
);
6600 new_symbol
= XCDR (entry
);
6603 /* We have to create the symbol ourselves. */
6604 new_symbol
= apply_modifiers_uncached (modifiers
,
6605 SDATA (SYMBOL_NAME (base
)),
6606 SCHARS (SYMBOL_NAME (base
)),
6607 SBYTES (SYMBOL_NAME (base
)));
6609 /* Add the new symbol to the base's cache. */
6610 entry
= Fcons (index
, new_symbol
);
6611 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6613 /* We have the parsing info now for free, so we could add it to
6615 XSETFASTINT (index, modifiers);
6616 Fput (new_symbol, Qevent_symbol_element_mask,
6617 Fcons (base, Fcons (index, Qnil)));
6618 Fput (new_symbol, Qevent_symbol_elements,
6619 Fcons (base, lispy_modifier_list (modifiers)));
6620 Sadly, this is only correct if `base' is indeed a base event,
6621 which is not necessarily the case. -stef */
6624 /* Make sure this symbol is of the same kind as BASE.
6626 You'd think we could just set this once and for all when we
6627 intern the symbol above, but reorder_modifiers may call us when
6628 BASE's property isn't set right; we can't assume that just
6629 because it has a Qmodifier_cache property it must have its
6630 Qevent_kind set right as well. */
6631 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6635 kind
= Fget (base
, Qevent_kind
);
6637 Fput (new_symbol
, Qevent_kind
, kind
);
6644 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6645 return a symbol with the modifiers placed in the canonical order.
6646 Canonical order is alphabetical, except for down and drag, which
6647 always come last. The 'click' modifier is never written out.
6649 Fdefine_key calls this to make sure that (for example) C-M-foo
6650 and M-C-foo end up being equivalent in the keymap. */
6653 reorder_modifiers (symbol
)
6656 /* It's hopefully okay to write the code this way, since everything
6657 will soon be in caches, and no consing will be done at all. */
6660 parsed
= parse_modifiers (symbol
);
6661 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6666 /* For handling events, we often want to produce a symbol whose name
6667 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6668 to some base, like the name of a function key or mouse button.
6669 modify_event_symbol produces symbols of this sort.
6671 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6672 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6675 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6676 into symbol names, or a string specifying a name stem used to
6677 construct a symbol name or the form `STEM-N', where N is the decimal
6678 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6679 non-nil; otherwise NAME_TABLE is used.
6681 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6682 persist between calls to modify_event_symbol that it can use to
6683 store a cache of the symbols it's generated for this NAME_TABLE
6684 before. The object stored there may be a vector or an alist.
6686 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6688 MODIFIERS is a set of modifier bits (as given in struct input_events)
6689 whose prefixes should be applied to the symbol name.
6691 SYMBOL_KIND is the value to be placed in the event_kind property of
6692 the returned symbol.
6694 The symbols we create are supposed to have an
6695 `event-symbol-elements' property, which lists the modifiers present
6696 in the symbol's name. */
6699 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6700 name_table
, symbol_table
, table_size
)
6703 Lisp_Object symbol_kind
;
6704 Lisp_Object name_alist_or_stem
;
6706 Lisp_Object
*symbol_table
;
6707 unsigned int table_size
;
6710 Lisp_Object symbol_int
;
6712 /* Get rid of the "vendor-specific" bit here. */
6713 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6715 /* Is this a request for a valid symbol? */
6716 if (symbol_num
< 0 || symbol_num
>= table_size
)
6719 if (CONSP (*symbol_table
))
6720 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6722 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6723 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6724 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6725 we've never used that symbol before. */
6728 if (! VECTORP (*symbol_table
)
6729 || XVECTOR (*symbol_table
)->size
!= table_size
)
6733 XSETFASTINT (size
, table_size
);
6734 *symbol_table
= Fmake_vector (size
, Qnil
);
6737 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6740 /* Have we already used this symbol before? */
6743 /* No; let's create it. */
6744 if (CONSP (name_alist_or_stem
))
6745 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6746 else if (STRINGP (name_alist_or_stem
))
6748 int len
= SBYTES (name_alist_or_stem
);
6749 char *buf
= (char *) alloca (len
+ 50);
6750 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6751 (long) XINT (symbol_int
) + 1);
6752 value
= intern (buf
);
6754 else if (name_table
!= 0 && name_table
[symbol_num
])
6755 value
= intern (name_table
[symbol_num
]);
6757 #ifdef HAVE_WINDOW_SYSTEM
6760 char *name
= x_get_keysym_name (symbol_num
);
6762 value
= intern (name
);
6769 sprintf (buf
, "key-%d", symbol_num
);
6770 value
= intern (buf
);
6773 if (CONSP (*symbol_table
))
6774 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6776 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6778 /* Fill in the cache entries for this symbol; this also
6779 builds the Qevent_symbol_elements property, which the user
6781 apply_modifiers (modifiers
& click_modifier
, value
);
6782 Fput (value
, Qevent_kind
, symbol_kind
);
6785 /* Apply modifiers to that symbol. */
6786 return apply_modifiers (modifiers
, value
);
6789 /* Convert a list that represents an event type,
6790 such as (ctrl meta backspace), into the usual representation of that
6791 event type as a number or a symbol. */
6793 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6794 doc
: /* Convert the event description list EVENT-DESC to an event type.
6795 EVENT-DESC should contain one base event type (a character or symbol)
6796 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6797 drag, down, double or triple). The base must be last.
6798 The return value is an event type (a character or symbol) which
6799 has the same base event type and all the specified modifiers. */)
6801 Lisp_Object event_desc
;
6809 while (CONSP (rest
))
6817 /* Given a symbol, see if it is a modifier name. */
6818 if (SYMBOLP (elt
) && CONSP (rest
))
6819 this = parse_solitary_modifier (elt
);
6823 else if (!NILP (base
))
6824 error ("Two bases given in one event");
6830 /* Let the symbol A refer to the character A. */
6831 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6832 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6834 if (INTEGERP (base
))
6836 /* Turn (shift a) into A. */
6837 if ((modifiers
& shift_modifier
) != 0
6838 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6840 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6841 modifiers
&= ~shift_modifier
;
6844 /* Turn (control a) into C-a. */
6845 if (modifiers
& ctrl_modifier
)
6846 return make_number ((modifiers
& ~ctrl_modifier
)
6847 | make_ctrl_char (XINT (base
)));
6849 return make_number (modifiers
| XINT (base
));
6851 else if (SYMBOLP (base
))
6852 return apply_modifiers (modifiers
, base
);
6855 error ("Invalid base event");
6860 /* Try to recognize SYMBOL as a modifier name.
6861 Return the modifier flag bit, or 0 if not recognized. */
6864 parse_solitary_modifier (symbol
)
6867 Lisp_Object name
= SYMBOL_NAME (symbol
);
6869 switch (SREF (name
, 0))
6871 #define SINGLE_LETTER_MOD(BIT) \
6872 if (SBYTES (name) == 1) \
6875 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6876 if (LEN == SBYTES (name) \
6877 && ! strncmp (SDATA (name), NAME, LEN)) \
6881 SINGLE_LETTER_MOD (alt_modifier
);
6885 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6889 SINGLE_LETTER_MOD (ctrl_modifier
);
6893 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6894 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6898 SINGLE_LETTER_MOD (hyper_modifier
);
6902 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6906 SINGLE_LETTER_MOD (meta_modifier
);
6910 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6914 SINGLE_LETTER_MOD (shift_modifier
);
6918 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6919 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6920 SINGLE_LETTER_MOD (super_modifier
);
6924 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6925 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6926 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6930 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6933 #undef SINGLE_LETTER_MOD
6934 #undef MULTI_LETTER_MOD
6940 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6941 Such a list is not valid as an event,
6942 but it can be a Lucid-style event type list. */
6945 lucid_event_type_list_p (object
)
6950 if (! CONSP (object
))
6953 if (EQ (XCAR (object
), Qhelp_echo
)
6954 || EQ (XCAR (object
), Qvertical_line
)
6955 || EQ (XCAR (object
), Qmode_line
)
6956 || EQ (XCAR (object
), Qheader_line
))
6959 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6963 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6970 /* Store into *addr a value nonzero if terminal input chars are available.
6971 Serves the purpose of ioctl (0, FIONREAD, addr)
6972 but works even if FIONREAD does not exist.
6973 (In fact, this may actually read some input.)
6975 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6976 timer events that are ripe.
6977 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6978 events (FOCUS_IN_EVENT).
6979 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6980 movements and toolkit scroll bar thumb drags. */
6983 get_input_pending (addr
, flags
)
6987 /* First of all, have we already counted some input? */
6988 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6990 /* If input is being read as it arrives, and we have none, there is none. */
6991 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6994 /* Try to read some input and see how much we get. */
6996 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6999 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
7002 gobble_input (expected
)
7006 /* Check whether a D-Bus message has arrived. */
7007 xd_read_queued_messages ();
7008 #endif /* HAVE_DBUS */
7012 if (interrupt_input
)
7015 mask
= sigblock (sigmask (SIGIO
));
7016 read_avail_input (expected
);
7020 #ifdef POLL_FOR_INPUT
7021 /* XXX This condition was (read_socket_hook && !interrupt_input),
7022 but read_socket_hook is not global anymore. Let's pretend that
7024 if (!interrupt_input
&& poll_suppress_count
== 0)
7027 mask
= sigblock (sigmask (SIGALRM
));
7028 read_avail_input (expected
);
7034 read_avail_input (expected
);
7038 /* Put a BUFFER_SWITCH_EVENT in the buffer
7039 so that read_key_sequence will notice the new current buffer. */
7042 record_asynch_buffer_change ()
7044 struct input_event event
;
7048 event
.kind
= BUFFER_SWITCH_EVENT
;
7049 event
.frame_or_window
= Qnil
;
7053 /* We don't need a buffer-switch event unless Emacs is waiting for input.
7054 The purpose of the event is to make read_key_sequence look up the
7055 keymaps again. If we aren't in read_key_sequence, we don't need one,
7056 and the event could cause trouble by messing up (input-pending-p). */
7057 tem
= Fwaiting_for_user_input_p ();
7061 /* We never need these events if we have no asynchronous subprocesses. */
7065 /* Make sure no interrupt happens while storing the event. */
7067 if (interrupt_input
)
7070 mask
= sigblock (sigmask (SIGIO
));
7071 kbd_buffer_store_event (&event
);
7078 kbd_buffer_store_event (&event
);
7085 /* Read any terminal input already buffered up by the system
7086 into the kbd_buffer, but do not wait.
7088 EXPECTED should be nonzero if the caller knows there is some input.
7090 Except on VMS, all input is read by this function.
7091 If interrupt_input is nonzero, this function MUST be called
7092 only when SIGIO is blocked.
7094 Returns the number of keyboard chars read, or -1 meaning
7095 this is a bad time to try to read input. */
7098 read_avail_input (expected
)
7105 /* Store pending user signal events, if any. */
7106 if (store_user_signal_events ())
7109 /* Loop through the available terminals, and call their input hooks. */
7113 struct terminal
*next
= t
->next_terminal
;
7115 if (t
->read_socket_hook
)
7118 struct input_event hold_quit
;
7120 EVENT_INIT (hold_quit
);
7121 hold_quit
.kind
= NO_EVENT
;
7123 /* No need for FIONREAD or fcntl; just say don't wait. */
7124 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
7130 if (nr
== -1) /* Not OK to read input now. */
7134 else if (nr
== -2) /* Non-transient error. */
7136 /* The terminal device terminated; it should be closed. */
7138 /* Kill Emacs if this was our last terminal. */
7139 if (!terminal_list
->next_terminal
)
7140 /* Formerly simply reported no input, but that
7141 sometimes led to a failure of Emacs to terminate.
7142 SIGHUP seems appropriate if we can't reach the
7144 /* ??? Is it really right to send the signal just to
7145 this process rather than to the whole process
7146 group? Perhaps on systems with FIONREAD Emacs is
7147 alone in its group. */
7148 kill (getpid (), SIGHUP
);
7150 /* XXX Is calling delete_terminal safe here? It calls Fdelete_frame. */
7153 XSETTERMINAL (tmp
, t
);
7154 Fdelete_terminal (tmp
, Qnoelisp
);
7158 if (hold_quit
.kind
!= NO_EVENT
)
7159 kbd_buffer_store_event (&hold_quit
);
7171 /* This is the tty way of reading available input.
7173 Note that each terminal device has its own `struct terminal' object,
7174 and so this function is called once for each individual termcap
7175 terminal. The first parameter indicates which terminal to read from. */
7178 tty_read_avail_input (struct terminal
*terminal
,
7180 struct input_event
*hold_quit
)
7182 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7183 the kbd_buffer can really hold. That may prevent loss
7184 of characters on some systems when input is stuffed at us. */
7185 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7187 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7190 if (!terminal
->name
) /* Don't read from a dead terminal. */
7193 if (terminal
->type
!= output_termcap
)
7196 /* XXX I think the following code should be moved to separate hook
7197 functions in system-dependent files. */
7200 #else /* not WINDOWSNT */
7202 n_to_read
= dos_keysns ();
7206 cbuf
[0] = dos_keyread ();
7209 #else /* not MSDOS */
7211 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7215 return 0; /* The terminal is suspended. */
7221 struct input_event hold_quit
;
7224 EVENT_INIT (hold_quit
);
7225 hold_quit
.kind
= NO_EVENT
;
7227 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7228 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7230 if (hold_quit
.kind
!= NO_EVENT
)
7231 kbd_buffer_store_event (&hold_quit
);
7235 #endif /* HAVE_GPM */
7237 /* Determine how many characters we should *try* to read. */
7239 /* Find out how much input is available. */
7240 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7242 if (! noninteractive
)
7243 return -2; /* Close this terminal. */
7249 if (n_to_read
> sizeof cbuf
)
7250 n_to_read
= sizeof cbuf
;
7251 #else /* no FIONREAD */
7252 #if defined (USG) || defined(CYGWIN)
7253 /* Read some input if available, but don't wait. */
7254 n_to_read
= sizeof cbuf
;
7255 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7261 /* Now read; for one reason or another, this will not block.
7262 NREAD is set to the number of chars read. */
7265 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7266 /* POSIX infers that processes which are not in the session leader's
7267 process group won't get SIGHUP's at logout time. BSDI adheres to
7268 this part standard and returns -1 from read (0) with errno==EIO
7269 when the control tty is taken away.
7270 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7271 if (nread
== -1 && errno
== EIO
)
7272 return -2; /* Close this terminal. */
7273 #if defined (AIX) && defined (_BSD)
7274 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7275 This looks incorrect, but it isn't, because _BSD causes
7276 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7277 and that causes a value other than 0 when there is no input. */
7279 return -2; /* Close this terminal. */
7283 /* We used to retry the read if it was interrupted.
7284 But this does the wrong thing when O_NDELAY causes
7285 an EAGAIN error. Does anybody know of a situation
7286 where a retry is actually needed? */
7288 nread
< 0 && (errno
== EAGAIN
7302 #if defined (USG) || defined (CYGWIN)
7303 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7304 #endif /* USG or CYGWIN */
7305 #endif /* no FIONREAD */
7310 #endif /* not MSDOS */
7311 #endif /* not WINDOWSNT */
7313 for (i
= 0; i
< nread
; i
++)
7315 struct input_event buf
;
7317 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7319 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7320 buf
.modifiers
= meta_modifier
;
7321 if (tty
->meta_key
!= 2)
7325 /* Set the frame corresponding to the active tty. Note that the
7326 value of selected_frame is not reliable here, redisplay tends
7327 to temporarily change it. */
7328 buf
.frame_or_window
= tty
->top_frame
;
7331 kbd_buffer_store_event (&buf
);
7332 /* Don't look at input that follows a C-g too closely.
7333 This reduces lossage due to autorepeat on C-g. */
7334 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7335 && buf
.code
== quit_char
)
7341 #endif /* not VMS */
7344 handle_async_input ()
7347 extern int select_alarmed
;
7350 interrupt_input_pending
= 0;
7355 nread
= read_avail_input (1);
7356 /* -1 means it's not ok to read the input now.
7357 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7358 0 means there was no keyboard input available. */
7363 select_alarmed
= 1; /* Force the select emulator back to life */
7368 #ifdef SIGIO /* for entire page */
7369 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7372 input_available_signal (signo
)
7375 /* Must preserve main program's value of errno. */
7376 int old_errno
= errno
;
7377 #if defined (USG) && !defined (POSIX_SIGNALS)
7378 /* USG systems forget handlers when they are used;
7379 must reestablish each time */
7380 signal (signo
, input_available_signal
);
7388 interrupt_input_pending
= 1;
7390 SIGNAL_THREAD_CHECK (signo
);
7393 if (input_available_clear_time
)
7394 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7397 handle_async_input ();
7407 /* Send ourselves a SIGIO.
7409 This function exists so that the UNBLOCK_INPUT macro in
7410 blockinput.h can have some way to take care of input we put off
7411 dealing with, without assuming that every file which uses
7412 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7414 reinvoke_input_signal ()
7417 handle_async_input ();
7423 /* User signal events. */
7425 struct user_signal_info
7427 /* Signal number. */
7430 /* Name of the signal. */
7433 /* Number of pending signals. */
7436 struct user_signal_info
*next
;
7439 /* List of user signals. */
7440 static struct user_signal_info
*user_signals
= NULL
;
7443 add_user_signal (sig
, name
)
7447 struct user_signal_info
*p
;
7449 for (p
= user_signals
; p
; p
= p
->next
)
7451 /* Already added. */
7454 p
= xmalloc (sizeof (struct user_signal_info
));
7456 p
->name
= xstrdup (name
);
7458 p
->next
= user_signals
;
7461 signal (sig
, handle_user_signal
);
7465 handle_user_signal (sig
)
7468 int old_errno
= errno
;
7469 struct user_signal_info
*p
;
7471 #if defined (USG) && !defined (POSIX_SIGNALS)
7472 /* USG systems forget handlers when they are used;
7473 must reestablish each time */
7474 signal (sig
, handle_user_signal
);
7477 SIGNAL_THREAD_CHECK (sig
);
7479 for (p
= user_signals
; p
; p
= p
->next
)
7484 if (interrupt_input
)
7485 kill (getpid (), SIGIO
);
7489 /* Tell wait_reading_process_output that it needs to wake
7490 up and look around. */
7491 if (input_available_clear_time
)
7492 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7501 find_user_signal_name (sig
)
7504 struct user_signal_info
*p
;
7506 for (p
= user_signals
; p
; p
= p
->next
)
7514 store_user_signal_events ()
7516 struct user_signal_info
*p
;
7517 struct input_event buf
;
7520 for (p
= user_signals
; p
; p
= p
->next
)
7521 if (p
->npending
> 0)
7527 bzero (&buf
, sizeof buf
);
7528 buf
.kind
= USER_SIGNAL_EVENT
;
7529 buf
.frame_or_window
= selected_frame
;
7531 nstored
+= p
->npending
;
7533 mask
= sigblock (sigmask (p
->sig
));
7537 kbd_buffer_store_event (&buf
);
7540 while (p
->npending
> 0);
7548 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7549 static Lisp_Object menu_bar_one_keymap_changed_items
;
7551 /* These variables hold the vector under construction within
7552 menu_bar_items and its subroutines, and the current index
7553 for storing into that vector. */
7554 static Lisp_Object menu_bar_items_vector
;
7555 static int menu_bar_items_index
;
7557 /* Return a vector of menu items for a menu bar, appropriate
7558 to the current buffer. Each item has three elements in the vector:
7561 OLD is an old vector we can optionally reuse, or nil. */
7564 menu_bar_items (old
)
7567 /* The number of keymaps we're scanning right now, and the number of
7568 keymaps we have allocated space for. */
7571 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7572 in the current keymaps, or nil where it is not a prefix. */
7575 Lisp_Object def
, tail
;
7584 /* In order to build the menus, we need to call the keymap
7585 accessors. They all call QUIT. But this function is called
7586 during redisplay, during which a quit is fatal. So inhibit
7587 quitting while building the menus.
7588 We do this instead of specbind because (1) errors will clear it anyway
7589 and (2) this avoids risk of specpdl overflow. */
7590 oquit
= Vinhibit_quit
;
7594 menu_bar_items_vector
= old
;
7596 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7597 menu_bar_items_index
= 0;
7599 /* Build our list of keymaps.
7600 If we recognize a function key and replace its escape sequence in
7601 keybuf with its symbol, or if the sequence starts with a mouse
7602 click and we need to switch buffers, we jump back here to rebuild
7603 the initial keymaps from the current buffer. */
7607 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7608 if (!NILP (Voverriding_local_map_menu_flag
))
7610 /* Yes, use them (if non-nil) as well as the global map. */
7611 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7613 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7614 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7615 if (!NILP (Voverriding_local_map
))
7616 maps
[nmaps
++] = Voverriding_local_map
;
7620 /* No, so use major and minor mode keymaps and keymap property.
7621 Note that menu-bar bindings in the local-map and keymap
7622 properties may not work reliable, as they are only
7623 recognized when the menu-bar (or mode-line) is updated,
7624 which does not normally happen after every command. */
7627 nminor
= current_minor_maps (NULL
, &tmaps
);
7628 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7630 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7631 maps
[nmaps
++] = tem
;
7632 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7634 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7636 maps
[nmaps
++] = current_global_map
;
7639 /* Look up in each map the dummy prefix key `menu-bar'. */
7643 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7644 if (!NILP (maps
[mapno
]))
7646 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7650 menu_bar_one_keymap_changed_items
= Qnil
;
7651 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7655 /* Move to the end those items that should be at the end. */
7657 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7660 int end
= menu_bar_items_index
;
7662 for (i
= 0; i
< end
; i
+= 4)
7663 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7665 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7666 /* Move the item at index I to the end,
7667 shifting all the others forward. */
7668 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7669 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7670 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7671 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7673 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7674 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7675 (end
- i
- 4) * sizeof (Lisp_Object
));
7676 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7677 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7678 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7679 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7684 /* Add nil, nil, nil, nil at the end. */
7685 i
= menu_bar_items_index
;
7686 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7687 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7688 /* Add this item. */
7689 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7690 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7691 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7692 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7693 menu_bar_items_index
= i
;
7695 Vinhibit_quit
= oquit
;
7696 return menu_bar_items_vector
;
7699 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7700 If there's already an item for KEY, add this DEF to it. */
7702 Lisp_Object item_properties
;
7705 menu_bar_item (key
, item
, dummy1
, dummy2
)
7706 Lisp_Object key
, item
, dummy1
;
7709 struct gcpro gcpro1
;
7713 if (EQ (item
, Qundefined
))
7715 /* If a map has an explicit `undefined' as definition,
7716 discard any previously made menu bar item. */
7718 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7719 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7721 if (menu_bar_items_index
> i
+ 4)
7722 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7723 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7724 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7725 menu_bar_items_index
-= 4;
7729 /* If this keymap has already contributed to this KEY,
7730 don't contribute to it a second time. */
7731 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7732 if (!NILP (tem
) || NILP (item
))
7735 menu_bar_one_keymap_changed_items
7736 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7738 /* We add to menu_bar_one_keymap_changed_items before doing the
7739 parse_menu_item, so that if it turns out it wasn't a menu item,
7740 it still correctly hides any further menu item. */
7742 i
= parse_menu_item (item
, 0, 1);
7747 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7749 /* Find any existing item for this KEY. */
7750 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7751 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7754 /* If we did not find this KEY, add it at the end. */
7755 if (i
== menu_bar_items_index
)
7757 /* If vector is too small, get a bigger one. */
7758 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7759 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7760 /* Add this item. */
7761 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7762 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7763 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7764 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7765 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7766 menu_bar_items_index
= i
;
7768 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7772 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7773 /* If the new and the old items are not both keymaps,
7774 the lookup will only find `item'. */
7775 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7776 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7780 /* This is used as the handler when calling menu_item_eval_property. */
7782 menu_item_eval_property_1 (arg
)
7785 /* If we got a quit from within the menu computation,
7786 quit all the way out of it. This takes care of C-] in the debugger. */
7787 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7788 Fsignal (Qquit
, Qnil
);
7793 /* Evaluate an expression and return the result (or nil if something
7794 went wrong). Used to evaluate dynamic parts of menu items. */
7796 menu_item_eval_property (sexpr
)
7799 int count
= SPECPDL_INDEX ();
7801 specbind (Qinhibit_redisplay
, Qt
);
7802 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7803 menu_item_eval_property_1
);
7804 return unbind_to (count
, val
);
7807 /* This function parses a menu item and leaves the result in the
7808 vector item_properties.
7809 ITEM is a key binding, a possible menu item.
7810 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7811 evaluate dynamic expressions in the menu item.
7812 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7814 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7815 parse_menu_item returns true if the item is a menu item and false
7819 parse_menu_item (item
, notreal
, inmenubar
)
7821 int notreal
, inmenubar
;
7823 Lisp_Object def
, tem
, item_string
, start
;
7824 Lisp_Object cachelist
;
7826 Lisp_Object keyhint
;
7837 /* Create item_properties vector if necessary. */
7838 if (NILP (item_properties
))
7840 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7842 /* Initialize optional entries. */
7843 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7844 ASET (item_properties
, i
, Qnil
);
7845 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7847 /* Save the item here to protect it from GC. */
7848 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7850 item_string
= XCAR (item
);
7854 if (STRINGP (item_string
))
7856 /* Old format menu item. */
7857 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7859 /* Maybe help string. */
7860 if (CONSP (item
) && STRINGP (XCAR (item
)))
7862 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7867 /* Maybe key binding cache. */
7868 if (CONSP (item
) && CONSP (XCAR (item
))
7869 && (NILP (XCAR (XCAR (item
)))
7870 || VECTORP (XCAR (XCAR (item
)))))
7872 cachelist
= XCAR (item
);
7876 /* This is the real definition--the function to run. */
7877 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7879 /* Get enable property, if any. */
7882 tem
= Fget (item
, Qmenu_enable
);
7883 if (!NILP (Venable_disabled_menus_and_buttons
))
7884 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7885 else if (!NILP (tem
))
7886 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7889 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7891 /* New format menu item. */
7892 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7893 start
= XCDR (item
);
7896 /* We have a real binding. */
7897 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7899 item
= XCDR (start
);
7900 /* Is there a cache list with key equivalences. */
7901 if (CONSP (item
) && CONSP (XCAR (item
)))
7903 cachelist
= XCAR (item
);
7907 /* Parse properties. */
7908 while (CONSP (item
) && CONSP (XCDR (item
)))
7913 if (EQ (tem
, QCenable
))
7915 if (!NILP (Venable_disabled_menus_and_buttons
))
7916 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7918 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7920 else if (EQ (tem
, QCvisible
) && !notreal
)
7922 /* If got a visible property and that evaluates to nil
7923 then ignore this item. */
7924 tem
= menu_item_eval_property (XCAR (item
));
7928 else if (EQ (tem
, QChelp
))
7929 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7930 else if (EQ (tem
, QCfilter
))
7932 else if (EQ (tem
, QCkey_sequence
))
7935 if (NILP (cachelist
)
7936 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7937 /* Be GC protected. Set keyhint to item instead of tem. */
7940 else if (EQ (tem
, QCkeys
))
7943 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7944 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7946 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7951 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7953 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7955 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7961 else if (inmenubar
|| !NILP (start
))
7965 return 0; /* not a menu item */
7967 /* If item string is not a string, evaluate it to get string.
7968 If we don't get a string, skip this item. */
7969 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7970 if (!(STRINGP (item_string
) || notreal
))
7972 item_string
= menu_item_eval_property (item_string
);
7973 if (!STRINGP (item_string
))
7975 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7978 /* If got a filter apply it on definition. */
7979 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7982 def
= menu_item_eval_property (list2 (XCAR (filter
),
7983 list2 (Qquote
, def
)));
7985 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7988 /* Enable or disable selection of item. */
7989 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7995 tem
= menu_item_eval_property (tem
);
7996 if (inmenubar
&& NILP (tem
))
7997 return 0; /* Ignore disabled items in menu bar. */
7998 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
8001 /* If we got no definition, this item is just unselectable text which
8002 is OK in a submenu but not in the menubar. */
8004 return (inmenubar
? 0 : 1);
8006 /* See if this is a separate pane or a submenu. */
8007 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8008 tem
= get_keymap (def
, 0, 1);
8009 /* For a subkeymap, just record its details and exit. */
8012 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
8013 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
8017 /* At the top level in the menu bar, do likewise for commands also.
8018 The menu bar does not display equivalent key bindings anyway.
8019 ITEM_PROPERTY_DEF is already set up properly. */
8023 /* This is a command. See if there is an equivalent key binding. */
8024 if (NILP (cachelist
))
8026 /* We have to create a cachelist. */
8027 CHECK_IMPURE (start
);
8028 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
8029 cachelist
= XCAR (XCDR (start
));
8031 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
8032 if (!NILP (keyhint
))
8034 XSETCAR (cachelist
, XCAR (keyhint
));
8037 else if (STRINGP (tem
))
8039 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
8040 XSETCAR (cachelist
, Qt
);
8044 tem
= XCAR (cachelist
);
8051 tem
= Fkey_binding (tem
, Qnil
, Qnil
, Qnil
);
8053 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
8056 def
= XCAR (prefix
);
8057 prefix
= XCDR (prefix
);
8060 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8062 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
8064 if (newcache
/* Always check first time. */
8065 /* Should we check everything when precomputing key
8067 /* If something had no key binding before, don't recheck it
8068 because that is too slow--except if we have a list of
8069 rebound commands in Vdefine_key_rebound_commands, do
8070 recheck any command that appears in that list. */
8071 || (CONSP (Vdefine_key_rebound_commands
)
8072 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
8075 /* We had a saved key. Is it still bound to the command? */
8078 /* If the command is an alias for another
8079 (such as lmenu.el set it up), check if the
8080 original command matches the cached command. */
8081 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
8082 chkcache
= 1; /* Need to recompute key binding. */
8086 /* Recompute equivalent key binding. If the command is an alias
8087 for another (such as lmenu.el set it up), see if the original
8088 command name has equivalent keys. Otherwise look up the
8089 specified command itself. We don't try both, because that
8090 makes lmenu menus slow. */
8092 && SYMBOLP (XSYMBOL (def
)->function
)
8093 && ! NILP (Fget (def
, Qmenu_alias
)))
8094 def
= XSYMBOL (def
)->function
;
8095 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
8096 XSETCAR (cachelist
, tem
);
8099 XSETCDR (cachelist
, Qnil
);
8103 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
8105 tem
= XCAR (cachelist
);
8109 newcache
= chkcache
;
8112 tem
= Fkey_description (tem
, Qnil
);
8115 if (STRINGP (XCAR (prefix
)))
8116 tem
= concat2 (XCAR (prefix
), tem
);
8117 if (STRINGP (XCDR (prefix
)))
8118 tem
= concat2 (tem
, XCDR (prefix
));
8120 XSETCDR (cachelist
, tem
);
8124 tem
= XCDR (cachelist
);
8125 if (newcache
&& !NILP (tem
))
8127 tem
= concat2 (build_string (" "), tem
);
8128 // tem = concat3 (build_string (" ("), tem, build_string (")"));
8129 XSETCDR (cachelist
, tem
);
8132 /* If we only want to precompute equivalent key bindings, stop here. */
8136 /* If we have an equivalent key binding, use that. */
8137 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
8139 /* Include this when menu help is implemented.
8140 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
8141 if (!(NILP (tem) || STRINGP (tem)))
8143 tem = menu_item_eval_property (tem);
8146 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8150 /* Handle radio buttons or toggle boxes. */
8151 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8153 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8154 menu_item_eval_property (tem
));
8161 /***********************************************************************
8163 ***********************************************************************/
8165 /* A vector holding tool bar items while they are parsed in function
8166 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8169 static Lisp_Object tool_bar_items_vector
;
8171 /* A vector holding the result of parse_tool_bar_item. Layout is like
8172 the one for a single item in tool_bar_items_vector. */
8174 static Lisp_Object tool_bar_item_properties
;
8176 /* Next free index in tool_bar_items_vector. */
8178 static int ntool_bar_items
;
8180 /* The symbols `tool-bar', `:image' and `:rtl'. */
8182 extern Lisp_Object Qtool_bar
;
8183 Lisp_Object QCimage
;
8186 /* Function prototypes. */
8188 static void init_tool_bar_items
P_ ((Lisp_Object
));
8189 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
8190 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
8191 static void append_tool_bar_item
P_ ((void));
8194 /* Return a vector of tool bar items for keymaps currently in effect.
8195 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8196 tool bar items found. */
8199 tool_bar_items (reuse
, nitems
)
8210 /* In order to build the menus, we need to call the keymap
8211 accessors. They all call QUIT. But this function is called
8212 during redisplay, during which a quit is fatal. So inhibit
8213 quitting while building the menus. We do this instead of
8214 specbind because (1) errors will clear it anyway and (2) this
8215 avoids risk of specpdl overflow. */
8216 oquit
= Vinhibit_quit
;
8219 /* Initialize tool_bar_items_vector and protect it from GC. */
8220 init_tool_bar_items (reuse
);
8222 /* Build list of keymaps in maps. Set nmaps to the number of maps
8225 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8226 if (!NILP (Voverriding_local_map_menu_flag
))
8228 /* Yes, use them (if non-nil) as well as the global map. */
8229 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8231 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8232 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8233 if (!NILP (Voverriding_local_map
))
8234 maps
[nmaps
++] = Voverriding_local_map
;
8238 /* No, so use major and minor mode keymaps and keymap property.
8239 Note that tool-bar bindings in the local-map and keymap
8240 properties may not work reliable, as they are only
8241 recognized when the tool-bar (or mode-line) is updated,
8242 which does not normally happen after every command. */
8245 nminor
= current_minor_maps (NULL
, &tmaps
);
8246 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8248 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8249 maps
[nmaps
++] = tem
;
8250 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
8252 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8255 /* Add global keymap at the end. */
8256 maps
[nmaps
++] = current_global_map
;
8258 /* Process maps in reverse order and look up in each map the prefix
8260 for (i
= nmaps
- 1; i
>= 0; --i
)
8261 if (!NILP (maps
[i
]))
8265 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8267 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8270 Vinhibit_quit
= oquit
;
8271 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8272 return tool_bar_items_vector
;
8276 /* Process the definition of KEY which is DEF. */
8279 process_tool_bar_item (key
, def
, data
, args
)
8280 Lisp_Object key
, def
, data
;
8284 extern Lisp_Object Qundefined
;
8285 struct gcpro gcpro1
, gcpro2
;
8287 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8291 if (EQ (def
, Qundefined
))
8293 /* If a map has an explicit `undefined' as definition,
8294 discard any previously made item. */
8295 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8297 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8299 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8301 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8302 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
8303 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8304 * sizeof (Lisp_Object
)));
8305 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8310 else if (parse_tool_bar_item (key
, def
))
8311 /* Append a new tool bar item to tool_bar_items_vector. Accept
8312 more than one definition for the same key. */
8313 append_tool_bar_item ();
8319 /* Parse a tool bar item specification ITEM for key KEY and return the
8320 result in tool_bar_item_properties. Value is zero if ITEM is
8323 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8325 CAPTION is the caption of the item, If it's not a string, it is
8326 evaluated to get a string.
8328 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8329 as binding are currently ignored.
8331 The following properties are recognized:
8335 FORM is evaluated and specifies whether the tool bar item is
8336 enabled or disabled.
8340 FORM is evaluated and specifies whether the tool bar item is visible.
8342 - `:filter FUNCTION'
8344 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8345 result is stored as the new binding.
8347 - `:button (TYPE SELECTED)'
8349 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8350 and specifies whether the button is selected (pressed) or not.
8354 IMAGES is either a single image specification or a vector of four
8355 image specifications. See enum tool_bar_item_images.
8357 - `:help HELP-STRING'.
8359 Gives a help string to display for the tool bar item. */
8362 parse_tool_bar_item (key
, item
)
8363 Lisp_Object key
, item
;
8365 /* Access slot with index IDX of vector tool_bar_item_properties. */
8366 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8368 Lisp_Object filter
= Qnil
;
8369 Lisp_Object caption
;
8372 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8373 Rule out items that aren't lists, don't start with
8374 `menu-item' or whose rest following `tool-bar-item' is not a
8377 || !EQ (XCAR (item
), Qmenu_item
)
8378 || (item
= XCDR (item
),
8382 /* Create tool_bar_item_properties vector if necessary. Reset it to
8384 if (VECTORP (tool_bar_item_properties
))
8386 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8390 tool_bar_item_properties
8391 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8394 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8395 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8397 /* Get the caption of the item. If the caption is not a string,
8398 evaluate it to get a string. If we don't get a string, skip this
8400 caption
= XCAR (item
);
8401 if (!STRINGP (caption
))
8403 caption
= menu_item_eval_property (caption
);
8404 if (!STRINGP (caption
))
8407 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8409 /* Give up if rest following the caption is not a list. */
8414 /* Store the binding. */
8415 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8418 /* Ignore cached key binding, if any. */
8419 if (CONSP (item
) && CONSP (XCAR (item
)))
8422 /* Process the rest of the properties. */
8423 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8425 Lisp_Object key
, value
;
8428 value
= XCAR (XCDR (item
));
8430 if (EQ (key
, QCenable
))
8432 /* `:enable FORM'. */
8433 if (!NILP (Venable_disabled_menus_and_buttons
))
8434 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8436 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8438 else if (EQ (key
, QCvisible
))
8440 /* `:visible FORM'. If got a visible property and that
8441 evaluates to nil then ignore this item. */
8442 if (NILP (menu_item_eval_property (value
)))
8445 else if (EQ (key
, QChelp
))
8446 /* `:help HELP-STRING'. */
8447 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8448 else if (EQ (key
, QCfilter
))
8449 /* ':filter FORM'. */
8451 else if (EQ (key
, QCbutton
) && CONSP (value
))
8453 /* `:button (TYPE . SELECTED)'. */
8454 Lisp_Object type
, selected
;
8456 type
= XCAR (value
);
8457 selected
= XCDR (value
);
8458 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8460 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8461 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8464 else if (EQ (key
, QCimage
)
8466 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8467 /* Value is either a single image specification or a vector
8468 of 4 such specifications for the different button states. */
8469 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8470 else if (EQ (key
, Qrtl
))
8472 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8475 /* If got a filter apply it on binding. */
8477 PROP (TOOL_BAR_ITEM_BINDING
)
8478 = menu_item_eval_property (list2 (filter
,
8480 PROP (TOOL_BAR_ITEM_BINDING
))));
8482 /* See if the binding is a keymap. Give up if it is. */
8483 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8486 /* Enable or disable selection of item. */
8487 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8488 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8489 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8491 /* Handle radio buttons or toggle boxes. */
8492 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8493 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8494 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8502 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8503 that can be reused. */
8506 init_tool_bar_items (reuse
)
8509 if (VECTORP (reuse
))
8510 tool_bar_items_vector
= reuse
;
8512 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8513 ntool_bar_items
= 0;
8517 /* Append parsed tool bar item properties from
8518 tool_bar_item_properties */
8521 append_tool_bar_item ()
8523 Lisp_Object
*to
, *from
;
8525 /* Enlarge tool_bar_items_vector if necessary. */
8526 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8527 >= XVECTOR (tool_bar_items_vector
)->size
)
8528 tool_bar_items_vector
8529 = larger_vector (tool_bar_items_vector
,
8530 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8532 /* Append entries from tool_bar_item_properties to the end of
8533 tool_bar_items_vector. */
8534 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8535 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8536 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8537 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8544 /* Read a character using menus based on maps in the array MAPS.
8545 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8546 Return t if we displayed a menu but the user rejected it.
8548 PREV_EVENT is the previous input event, or nil if we are reading
8549 the first event of a key sequence.
8551 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8552 if we used a mouse menu to read the input, or zero otherwise. If
8553 USED_MOUSE_MENU is null, we don't dereference it.
8555 The prompting is done based on the prompt-string of the map
8556 and the strings associated with various map elements.
8558 This can be done with X menus or with menus put in the minibuf.
8559 These are done in different ways, depending on how the input will be read.
8560 Menus using X are done after auto-saving in read-char, getting the input
8561 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8562 and do auto-saving in the inner call of read_char. */
8565 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8568 Lisp_Object prev_event
;
8569 int *used_mouse_menu
;
8572 register Lisp_Object name
= Qnil
;
8574 if (used_mouse_menu
)
8575 *used_mouse_menu
= 0;
8577 /* Use local over global Menu maps */
8579 if (! menu_prompting
)
8582 /* Optionally disregard all but the global map. */
8583 if (inhibit_local_menu_bar_menus
)
8585 maps
+= (nmaps
- 1);
8589 /* Get the menu name from the first map that has one (a prompt string). */
8590 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8592 name
= Fkeymap_prompt (maps
[mapno
]);
8597 /* If we don't have any menus, just read a character normally. */
8598 if (!STRINGP (name
))
8602 /* If we got to this point via a mouse click,
8603 use a real menu for mouse selection. */
8604 if (EVENT_HAS_PARAMETERS (prev_event
)
8605 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8606 && !EQ (XCAR (prev_event
), Qtool_bar
))
8608 /* Display the menu and get the selection. */
8609 Lisp_Object
*realmaps
8610 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8614 /* Use the maps that are not nil. */
8615 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8616 if (!NILP (maps
[mapno
]))
8617 realmaps
[nmaps1
++] = maps
[mapno
];
8619 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8624 record_menu_key (XCAR (value
));
8626 /* If we got multiple events, unread all but
8628 There is no way to prevent those unread events
8629 from showing up later in last_nonmenu_event.
8630 So turn symbol and integer events into lists,
8631 to indicate that they came from a mouse menu,
8632 so that when present in last_nonmenu_event
8633 they won't confuse things. */
8634 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8636 record_menu_key (XCAR (tem
));
8637 if (SYMBOLP (XCAR (tem
))
8638 || INTEGERP (XCAR (tem
)))
8639 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8642 /* If we got more than one event, put all but the first
8643 onto this list to be read later.
8644 Return just the first event now. */
8645 Vunread_command_events
8646 = nconc2 (XCDR (value
), Vunread_command_events
);
8647 value
= XCAR (value
);
8649 else if (NILP (value
))
8651 if (used_mouse_menu
)
8652 *used_mouse_menu
= 1;
8655 #endif /* HAVE_MENUS */
8659 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8660 We make this bigger when necessary, and never free it. */
8661 static char *read_char_minibuf_menu_text
;
8662 /* Size of that buffer. */
8663 static int read_char_minibuf_menu_width
;
8666 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8672 register Lisp_Object name
;
8674 /* FIXME: Use the minibuffer's frame width. */
8675 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8678 Lisp_Object rest
, vector
;
8684 if (! menu_prompting
)
8687 /* Make sure we have a big enough buffer for the menu text. */
8688 if (read_char_minibuf_menu_text
== 0)
8690 read_char_minibuf_menu_width
= width
+ 4;
8691 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8693 else if (width
+ 4 > read_char_minibuf_menu_width
)
8695 read_char_minibuf_menu_width
= width
+ 4;
8696 read_char_minibuf_menu_text
8697 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8699 menu
= read_char_minibuf_menu_text
;
8701 /* Get the menu name from the first map that has one (a prompt string). */
8702 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8704 name
= Fkeymap_prompt (maps
[mapno
]);
8709 /* If we don't have any menus, just read a character normally. */
8710 if (!STRINGP (name
))
8713 /* Prompt string always starts with map's prompt, and a space. */
8714 strcpy (menu
, SDATA (name
));
8715 nlength
= SBYTES (name
);
8716 menu
[nlength
++] = ':';
8717 menu
[nlength
++] = ' ';
8720 /* Start prompting at start of first map. */
8724 /* Present the documented bindings, a line at a time. */
8731 Lisp_Object orig_defn_macro
;
8733 /* Loop over elements of map. */
8738 /* If reached end of map, start at beginning of next map. */
8742 /* At end of last map, wrap around to first map if just starting,
8743 or end this line if already have something on it. */
8747 if (notfirst
|| nobindings
) break;
8752 /* Look at the next element of the map. */
8754 elt
= XVECTOR (vector
)->contents
[idx
];
8756 elt
= Fcar_safe (rest
);
8758 if (idx
< 0 && VECTORP (elt
))
8760 /* If we found a dense table in the keymap,
8761 advanced past it, but start scanning its contents. */
8762 rest
= Fcdr_safe (rest
);
8768 /* An ordinary element. */
8769 Lisp_Object event
, tem
;
8773 event
= Fcar_safe (elt
); /* alist */
8774 elt
= Fcdr_safe (elt
);
8778 XSETINT (event
, idx
); /* vector */
8781 /* Ignore the element if it has no prompt string. */
8782 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8784 /* 1 if the char to type matches the string. */
8786 Lisp_Object upcased_event
, downcased_event
;
8787 Lisp_Object desc
= Qnil
;
8789 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8791 upcased_event
= Fupcase (event
);
8792 downcased_event
= Fdowncase (event
);
8793 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8794 || XINT (downcased_event
) == SREF (s
, 0));
8796 desc
= Fsingle_key_description (event
, Qnil
);
8798 #if 0 /* It is redundant to list the equivalent key bindings because
8799 the prefix is what the user has already typed. */
8801 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8803 /* Insert equivalent keybinding. */
8804 s
= concat2 (s
, tem
);
8807 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8808 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8810 /* Insert button prefix. */
8811 Lisp_Object selected
8812 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8813 if (EQ (tem
, QCradio
))
8814 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8816 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8817 s
= concat2 (tem
, s
);
8821 /* If we have room for the prompt string, add it to this line.
8822 If this is the first on the line, always add it. */
8823 if ((SCHARS (s
) + i
+ 2
8824 + (char_matches
? 0 : SCHARS (desc
) + 3))
8830 /* Punctuate between strings. */
8833 strcpy (menu
+ i
, ", ");
8839 /* If the char to type doesn't match the string's
8840 first char, explicitly show what char to type. */
8843 /* Add as much of string as fits. */
8844 thiswidth
= SCHARS (desc
);
8845 if (thiswidth
+ i
> width
)
8846 thiswidth
= width
- i
;
8847 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8849 strcpy (menu
+ i
, " = ");
8853 /* Add as much of string as fits. */
8854 thiswidth
= SCHARS (s
);
8855 if (thiswidth
+ i
> width
)
8856 thiswidth
= width
- i
;
8857 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8863 /* If this element does not fit, end the line now,
8864 and save the element for the next line. */
8865 strcpy (menu
+ i
, "...");
8870 /* Move past this element. */
8871 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8872 /* Handle reaching end of dense table. */
8877 rest
= Fcdr_safe (rest
);
8881 /* Prompt with that and read response. */
8882 message2_nolog (menu
, strlen (menu
),
8883 ! NILP (current_buffer
->enable_multibyte_characters
));
8885 /* Make believe its not a keyboard macro in case the help char
8886 is pressed. Help characters are not recorded because menu prompting
8887 is not used on replay.
8889 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8890 current_kboard
->defining_kbd_macro
= Qnil
;
8892 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8893 while (BUFFERP (obj
));
8894 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8896 if (!INTEGERP (obj
))
8898 else if (XINT (obj
) == -2)
8903 if (! EQ (obj
, menu_prompt_more_char
)
8904 && (!INTEGERP (menu_prompt_more_char
)
8905 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8907 if (!NILP (current_kboard
->defining_kbd_macro
))
8908 store_kbd_macro_char (obj
);
8911 /* Help char - go round again */
8915 /* Reading key sequences. */
8917 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8918 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8919 keymap, or nil otherwise. Return the index of the first keymap in
8920 which KEY has any binding, or NMAPS if no map has a binding.
8922 If KEY is a meta ASCII character, treat it like meta-prefix-char
8923 followed by the corresponding non-meta character. Keymaps in
8924 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8927 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8930 NEXT may be the same array as CURRENT. */
8933 follow_key (key
, nmaps
, current
, defs
, next
)
8935 Lisp_Object
*current
, *defs
, *next
;
8938 int i
, first_binding
;
8940 first_binding
= nmaps
;
8941 for (i
= nmaps
- 1; i
>= 0; i
--)
8943 if (! NILP (current
[i
]))
8945 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8946 if (! NILP (defs
[i
]))
8953 /* Given the set of bindings we've found, produce the next set of maps. */
8954 if (first_binding
< nmaps
)
8955 for (i
= 0; i
< nmaps
; i
++)
8956 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8958 return first_binding
;
8961 /* Structure used to keep track of partial application of key remapping
8962 such as Vfunction_key_map and Vkey_translation_map. */
8963 typedef struct keyremap
8965 /* This is the map originally specified for this use. */
8967 /* This is a submap reached by looking up, in PARENT,
8968 the events from START to END. */
8970 /* Positions [START, END) in the key sequence buffer
8971 are the key that we have scanned so far.
8972 Those events are the ones that we will replace
8973 if PAREHT maps them into a key sequence. */
8977 /* Lookup KEY in MAP.
8978 MAP is a keymap mapping keys to key vectors or functions.
8979 If the mapping is a function and DO_FUNCTION is non-zero, then
8980 the function is called with PROMPT as parameter and its return
8981 value is used as the return value of this function (after checking
8982 that it is indeed a vector). */
8985 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8986 Lisp_Object map
, key
, prompt
;
8991 next
= access_keymap (map
, key
, 1, 0, 1);
8993 /* Handle symbol with autoload definition. */
8994 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8995 && CONSP (XSYMBOL (next
)->function
)
8996 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8997 do_autoload (XSYMBOL (next
)->function
, next
);
8999 /* Handle a symbol whose function definition is a keymap
9001 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
9002 && (ARRAYP (XSYMBOL (next
)->function
)
9003 || KEYMAPP (XSYMBOL (next
)->function
)))
9004 next
= XSYMBOL (next
)->function
;
9006 /* If the keymap gives a function, not an
9007 array, then call the function with one arg and use
9008 its value instead. */
9009 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
9014 next
= call1 (next
, prompt
);
9015 /* If the function returned something invalid,
9016 barf--don't ignore it.
9017 (To ignore it safely, we would need to gcpro a bunch of
9018 other variables.) */
9019 if (! (VECTORP (next
) || STRINGP (next
)))
9020 error ("Function %s returns invalid key sequence", tem
);
9025 /* Do one step of the key remapping used for function-key-map and
9026 key-translation-map:
9027 KEYBUF is the buffer holding the input events.
9028 BUFSIZE is its maximum size.
9029 FKEY is a pointer to the keyremap structure to use.
9030 INPUT is the index of the last element in KEYBUF.
9031 DOIT if non-zero says that the remapping can actually take place.
9032 DIFF is used to return the number of keys added/removed by the remapping.
9033 PARENT is the root of the keymap.
9034 PROMPT is the prompt to use if the remapping happens through a function.
9035 The return value is non-zero if the remapping actually took place. */
9038 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
9039 Lisp_Object
*keybuf
, prompt
;
9041 int input
, doit
, *diff
, bufsize
;
9043 Lisp_Object next
, key
;
9045 key
= keybuf
[fkey
->end
++];
9047 if (KEYMAPP (fkey
->parent
))
9048 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
9052 /* If keybuf[fkey->start..fkey->end] is bound in the
9053 map and we're in a position to do the key remapping, replace it with
9054 the binding and restart with fkey->start at the end. */
9055 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
9057 int len
= XFASTINT (Flength (next
));
9060 *diff
= len
- (fkey
->end
- fkey
->start
);
9062 if (input
+ *diff
>= bufsize
)
9063 error ("Key sequence too long");
9065 /* Shift the keys that follow fkey->end. */
9067 for (i
= fkey
->end
; i
< input
; i
++)
9068 keybuf
[i
+ *diff
] = keybuf
[i
];
9070 for (i
= input
- 1; i
>= fkey
->end
; i
--)
9071 keybuf
[i
+ *diff
] = keybuf
[i
];
9072 /* Overwrite the old keys with the new ones. */
9073 for (i
= 0; i
< len
; i
++)
9074 keybuf
[fkey
->start
+ i
]
9075 = Faref (next
, make_number (i
));
9077 fkey
->start
= fkey
->end
+= *diff
;
9078 fkey
->map
= fkey
->parent
;
9083 fkey
->map
= get_keymap (next
, 0, 1);
9085 /* If we no longer have a bound suffix, try a new position for
9087 if (!CONSP (fkey
->map
))
9089 fkey
->end
= ++fkey
->start
;
9090 fkey
->map
= fkey
->parent
;
9095 /* Read a sequence of keys that ends with a non prefix character,
9096 storing it in KEYBUF, a buffer of size BUFSIZE.
9098 Return the length of the key sequence stored.
9099 Return -1 if the user rejected a command menu.
9101 Echo starting immediately unless `prompt' is 0.
9103 Where a key sequence ends depends on the currently active keymaps.
9104 These include any minor mode keymaps active in the current buffer,
9105 the current buffer's local map, and the global map.
9107 If a key sequence has no other bindings, we check Vfunction_key_map
9108 to see if some trailing subsequence might be the beginning of a
9109 function key's sequence. If so, we try to read the whole function
9110 key, and substitute its symbolic name into the key sequence.
9112 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9113 `double-' events into similar click events, if that would make them
9114 bound. We try to turn `triple-' events first into `double-' events,
9117 If we get a mouse click in a mode line, vertical divider, or other
9118 non-text area, we treat the click as if it were prefixed by the
9119 symbol denoting that area - `mode-line', `vertical-line', or
9122 If the sequence starts with a mouse click, we read the key sequence
9123 with respect to the buffer clicked on, not the current buffer.
9125 If the user switches frames in the midst of a key sequence, we put
9126 off the switch-frame event until later; the next call to
9127 read_char will return it.
9129 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9130 from the selected window's buffer. */
9133 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
9134 can_return_switch_frame
, fix_current_buffer
)
9135 Lisp_Object
*keybuf
;
9138 int dont_downcase_last
;
9139 int can_return_switch_frame
;
9140 int fix_current_buffer
;
9142 volatile Lisp_Object from_string
;
9143 volatile int count
= SPECPDL_INDEX ();
9145 /* How many keys there are in the current key sequence. */
9148 /* The length of the echo buffer when we started reading, and
9149 the length of this_command_keys when we started reading. */
9150 volatile int echo_start
;
9151 volatile int keys_start
;
9153 /* The number of keymaps we're scanning right now, and the number of
9154 keymaps we have allocated space for. */
9156 volatile int nmaps_allocated
= 0;
9158 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9159 the current keymaps. */
9160 Lisp_Object
*volatile defs
= NULL
;
9162 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9163 in the current keymaps, or nil where it is not a prefix. */
9164 Lisp_Object
*volatile submaps
= NULL
;
9166 /* The local map to start out with at start of key sequence. */
9167 volatile Lisp_Object orig_local_map
;
9169 /* The map from the `keymap' property to start out with at start of
9171 volatile Lisp_Object orig_keymap
;
9173 /* 1 if we have already considered switching to the local-map property
9174 of the place where a mouse click occurred. */
9175 volatile int localized_local_map
= 0;
9177 /* The index in submaps[] of the first keymap that has a binding for
9178 this key sequence. In other words, the lowest i such that
9179 submaps[i] is non-nil. */
9180 volatile int first_binding
;
9181 /* Index of the first key that has no binding.
9182 It is useless to try fkey.start larger than that. */
9183 volatile int first_unbound
;
9185 /* If t < mock_input, then KEYBUF[t] should be read as the next
9188 We use this to recover after recognizing a function key. Once we
9189 realize that a suffix of the current key sequence is actually a
9190 function key's escape sequence, we replace the suffix with the
9191 function key's binding from Vfunction_key_map. Now keybuf
9192 contains a new and different key sequence, so the echo area,
9193 this_command_keys, and the submaps and defs arrays are wrong. In
9194 this situation, we set mock_input to t, set t to 0, and jump to
9195 restart_sequence; the loop will read keys from keybuf up until
9196 mock_input, thus rebuilding the state; and then it will resume
9197 reading characters from the keyboard. */
9198 volatile int mock_input
= 0;
9200 /* If the sequence is unbound in submaps[], then
9201 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9202 and fkey.map is its binding.
9204 These might be > t, indicating that all function key scanning
9205 should hold off until t reaches them. We do this when we've just
9206 recognized a function key, to avoid searching for the function
9207 key's again in Vfunction_key_map. */
9208 volatile keyremap fkey
;
9210 /* Likewise, for key_translation_map and input-decode-map. */
9211 volatile keyremap keytran
, indec
;
9213 /* Non-zero if we are trying to map a key by changing an upper-case
9214 letter to lower case, or a shifted function key to an unshifted
9216 volatile int shift_translated
= 0;
9218 /* If we receive a `switch-frame' or `select-window' event in the middle of
9219 a key sequence, we put it off for later.
9220 While we're reading, we keep the event here. */
9221 volatile Lisp_Object delayed_switch_frame
;
9223 /* See the comment below... */
9224 #if defined (GOBBLE_FIRST_EVENT)
9225 Lisp_Object first_event
;
9228 volatile Lisp_Object original_uppercase
;
9229 volatile int original_uppercase_position
= -1;
9231 /* Gets around Microsoft compiler limitations. */
9234 struct buffer
*starting_buffer
;
9236 /* List of events for which a fake prefix key has been generated. */
9237 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
9239 #if defined (GOBBLE_FIRST_EVENT)
9243 struct gcpro gcpro1
;
9245 GCPRO1 (fake_prefixed_keys
);
9246 raw_keybuf_count
= 0;
9248 last_nonmenu_event
= Qnil
;
9250 delayed_switch_frame
= Qnil
;
9255 echo_prompt (prompt
);
9256 else if (cursor_in_echo_area
9257 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9258 && NILP (Fzerop (Vecho_keystrokes
)))
9259 /* This doesn't put in a dash if the echo buffer is empty, so
9260 you don't always see a dash hanging out in the minibuffer. */
9264 /* Record the initial state of the echo area and this_command_keys;
9265 we will need to restore them if we replay a key sequence. */
9267 echo_start
= echo_length ();
9268 keys_start
= this_command_key_count
;
9269 this_single_command_key_start
= keys_start
;
9271 #if defined (GOBBLE_FIRST_EVENT)
9272 /* This doesn't quite work, because some of the things that read_char
9273 does cannot safely be bypassed. It seems too risky to try to make
9276 /* Read the first char of the sequence specially, before setting
9277 up any keymaps, in case a filter runs and switches buffers on us. */
9278 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9280 #endif /* GOBBLE_FIRST_EVENT */
9282 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9283 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9286 /* The multi-tty merge moved the code below to right after
9287 `replay_sequence' which caused all these translation maps to be applied
9288 repeatedly, even tho their doc says very clearly they are not applied to
9290 The reason for this move was: "We may switch keyboards between rescans,
9291 so we need to reinitialize fkey and keytran before each replay".
9292 This move was wrong (even if we switch keyboards, keybuf still holds the
9293 keys we've read already from the original keyboard and some of those keys
9294 may have already been translated). So there may still be a bug out there
9296 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9297 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9298 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9299 indec
.start
= indec
.end
= 0;
9300 fkey
.start
= fkey
.end
= 0;
9301 keytran
.start
= keytran
.end
= 0;
9303 /* We jump here when the key sequence has been thoroughly changed, and
9304 we need to rescan it starting from the beginning. When we jump here,
9305 keybuf[0..mock_input] holds the sequence we should reread. */
9308 starting_buffer
= current_buffer
;
9309 first_unbound
= bufsize
+ 1;
9311 /* Build our list of keymaps.
9312 If we recognize a function key and replace its escape sequence in
9313 keybuf with its symbol, or if the sequence starts with a mouse
9314 click and we need to switch buffers, we jump back here to rebuild
9315 the initial keymaps from the current buffer. */
9318 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9320 if (2 > nmaps_allocated
)
9322 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9323 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9324 nmaps_allocated
= 2;
9326 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9327 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9329 else if (!NILP (Voverriding_local_map
))
9331 if (2 > nmaps_allocated
)
9333 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9334 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9335 nmaps_allocated
= 2;
9337 if (!NILP (Voverriding_local_map
))
9338 submaps
[nmaps
++] = Voverriding_local_map
;
9346 nminor
= current_minor_maps (0, &maps
);
9347 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9349 if (total
> nmaps_allocated
)
9351 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9352 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9353 nmaps_allocated
= total
;
9356 if (!NILP (orig_keymap
))
9357 submaps
[nmaps
++] = orig_keymap
;
9359 bcopy (maps
, (void *) (submaps
+ nmaps
),
9360 nminor
* sizeof (submaps
[0]));
9364 submaps
[nmaps
++] = orig_local_map
;
9366 submaps
[nmaps
++] = current_global_map
;
9368 /* Find an accurate initial value for first_binding. */
9369 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9370 if (! NILP (submaps
[first_binding
]))
9373 /* Start from the beginning in keybuf. */
9376 /* These are no-ops the first time through, but if we restart, they
9377 revert the echo area and this_command_keys to their original state. */
9378 this_command_key_count
= keys_start
;
9379 if (INTERACTIVE
&& t
< mock_input
)
9380 echo_truncate (echo_start
);
9382 /* If the best binding for the current key sequence is a keymap, or
9383 we may be looking at a function key's escape sequence, keep on
9385 while (first_binding
< nmaps
9386 /* Keep reading as long as there's a prefix binding. */
9387 ? !NILP (submaps
[first_binding
])
9388 /* Don't return in the middle of a possible function key sequence,
9389 if the only bindings we found were via case conversion.
9390 Thus, if ESC O a has a function-key-map translation
9391 and ESC o has a binding, don't return after ESC O,
9392 so that we can translate ESC O plus the next character. */
9393 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9396 int used_mouse_menu
= 0;
9398 /* Where the last real key started. If we need to throw away a
9399 key that has expanded into more than one element of keybuf
9400 (say, a mouse click on the mode line which is being treated
9401 as [mode-line (mouse-...)], then we backtrack to this point
9403 volatile int last_real_key_start
;
9405 /* These variables are analogous to echo_start and keys_start;
9406 while those allow us to restart the entire key sequence,
9407 echo_local_start and keys_local_start allow us to throw away
9409 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9411 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9412 eassert (indec
.start
<= indec
.end
);
9413 eassert (fkey
.start
<= fkey
.end
);
9414 eassert (keytran
.start
<= keytran
.end
);
9415 /* key-translation-map is applied *after* function-key-map
9416 which is itself applied *after* input-decode-map. */
9417 eassert (fkey
.end
<= indec
.start
);
9418 eassert (keytran
.end
<= fkey
.start
);
9420 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9421 first_unbound
< keytran
.start
)
9422 { /* The prefix upto first_unbound has no binding and has
9423 no translation left to do either, so we know it's unbound.
9424 If we don't stop now, we risk staying here indefinitely
9425 (if the user keeps entering fkey or keytran prefixes
9426 like C-c ESC ESC ESC ESC ...) */
9428 for (i
= first_unbound
+ 1; i
< t
; i
++)
9429 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9430 mock_input
= t
- first_unbound
- 1;
9431 indec
.end
= indec
.start
-= first_unbound
+ 1;
9432 indec
.map
= indec
.parent
;
9433 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9434 fkey
.map
= fkey
.parent
;
9435 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9436 keytran
.map
= keytran
.parent
;
9437 goto replay_sequence
;
9441 error ("Key sequence too long");
9444 echo_local_start
= echo_length ();
9445 keys_local_start
= this_command_key_count
;
9446 local_first_binding
= first_binding
;
9449 /* These are no-ops, unless we throw away a keystroke below and
9450 jumped back up to replay_key; in that case, these restore the
9451 variables to their original state, allowing us to replay the
9453 if (INTERACTIVE
&& t
< mock_input
)
9454 echo_truncate (echo_local_start
);
9455 this_command_key_count
= keys_local_start
;
9456 first_binding
= local_first_binding
;
9458 /* By default, assume each event is "real". */
9459 last_real_key_start
= t
;
9461 /* Does mock_input indicate that we are re-reading a key sequence? */
9465 add_command_key (key
);
9466 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9467 && NILP (Fzerop (Vecho_keystrokes
)))
9471 /* If not, we should actually read a character. */
9476 KBOARD
*interrupted_kboard
= current_kboard
;
9477 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9479 key
= read_char (NILP (prompt
), nmaps
,
9480 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9481 &used_mouse_menu
, NULL
);
9483 if (INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9488 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9489 if (k
== interrupted_kboard
)
9494 /* Don't touch interrupted_kboard when it's been
9496 delayed_switch_frame
= Qnil
;
9497 goto replay_sequence
;
9500 if (!NILP (delayed_switch_frame
))
9502 interrupted_kboard
->kbd_queue
9503 = Fcons (delayed_switch_frame
,
9504 interrupted_kboard
->kbd_queue
);
9505 delayed_switch_frame
= Qnil
;
9509 interrupted_kboard
->kbd_queue
9510 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9512 /* If the side queue is non-empty, ensure it begins with a
9513 switch-frame, so we'll replay it in the right context. */
9514 if (CONSP (interrupted_kboard
->kbd_queue
)
9515 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9516 !(EVENT_HAS_PARAMETERS (key
)
9517 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9521 XSETFRAME (frame
, interrupted_frame
);
9522 interrupted_kboard
->kbd_queue
9523 = Fcons (make_lispy_switch_frame (frame
),
9524 interrupted_kboard
->kbd_queue
);
9527 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9528 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9529 goto replay_sequence
;
9534 /* read_char returns t when it shows a menu and the user rejects it.
9538 unbind_to (count
, Qnil
);
9543 /* read_char returns -1 at the end of a macro.
9544 Emacs 18 handles this by returning immediately with a
9545 zero, so that's what we'll do. */
9546 if (INTEGERP (key
) && XINT (key
) == -1)
9549 /* The Microsoft C compiler can't handle the goto that
9555 /* If the current buffer has been changed from under us, the
9556 keymap may have changed, so replay the sequence. */
9559 timer_resume_idle ();
9562 /* Reset the current buffer from the selected window
9563 in case something changed the former and not the latter.
9564 This is to be more consistent with the behavior
9565 of the command_loop_1. */
9566 if (fix_current_buffer
)
9568 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9570 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9571 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9574 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9575 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9576 goto replay_sequence
;
9579 /* If we have a quit that was typed in another frame, and
9580 quit_throw_to_read_char switched buffers,
9581 replay to get the right keymap. */
9583 && XINT (key
) == quit_char
9584 && current_buffer
!= starting_buffer
)
9587 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9591 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9592 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9593 goto replay_sequence
;
9598 if (EVENT_HAS_PARAMETERS (key
)
9599 /* Either a `switch-frame' or a `select-window' event. */
9600 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9602 /* If we're at the beginning of a key sequence, and the caller
9603 says it's okay, go ahead and return this event. If we're
9604 in the midst of a key sequence, delay it until the end. */
9605 if (t
> 0 || !can_return_switch_frame
)
9607 delayed_switch_frame
= key
;
9613 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9617 /* Clicks in non-text areas get prefixed by the symbol
9618 in their CHAR-ADDRESS field. For example, a click on
9619 the mode line is prefixed by the symbol `mode-line'.
9621 Furthermore, key sequences beginning with mouse clicks
9622 are read using the keymaps of the buffer clicked on, not
9623 the current buffer. So we may have to switch the buffer
9626 When we turn one event into two events, we must make sure
9627 that neither of the two looks like the original--so that,
9628 if we replay the events, they won't be expanded again.
9629 If not for this, such reexpansion could happen either here
9630 or when user programs play with this-command-keys. */
9631 if (EVENT_HAS_PARAMETERS (key
))
9636 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9637 if (EQ (kind
, Qmouse_click
))
9639 Lisp_Object window
, posn
;
9641 window
= POSN_WINDOW (EVENT_START (key
));
9642 posn
= POSN_POSN (EVENT_START (key
));
9645 || (!NILP (fake_prefixed_keys
)
9646 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9648 /* We're looking a second time at an event for which
9649 we generated a fake prefix key. Set
9650 last_real_key_start appropriately. */
9652 last_real_key_start
= t
- 1;
9655 /* Key sequences beginning with mouse clicks are
9656 read using the keymaps in the buffer clicked on,
9657 not the current buffer. If we're at the
9658 beginning of a key sequence, switch buffers. */
9659 if (last_real_key_start
== 0
9661 && BUFFERP (XWINDOW (window
)->buffer
)
9662 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9664 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9668 /* Arrange to go back to the original buffer once we're
9669 done reading the key sequence. Note that we can't
9670 use save_excursion_{save,restore} here, because they
9671 save point as well as the current buffer; we don't
9672 want to save point, because redisplay may change it,
9673 to accommodate a Fset_window_start or something. We
9674 don't want to do this at the top of the function,
9675 because we may get input from a subprocess which
9676 wants to change the selected window and stuff (say,
9678 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9680 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9682 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9683 orig_local_map
= get_local_map (PT
, current_buffer
,
9685 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9686 goto replay_sequence
;
9689 /* For a mouse click, get the local text-property keymap
9690 of the place clicked on, rather than point. */
9691 if (last_real_key_start
== 0
9692 && CONSP (XCDR (key
))
9693 && ! localized_local_map
)
9695 Lisp_Object map_here
, start
, pos
;
9697 localized_local_map
= 1;
9698 start
= EVENT_START (key
);
9700 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9702 pos
= POSN_BUFFER_POSN (start
);
9704 && XINT (pos
) >= BEGV
9705 && XINT (pos
) <= ZV
)
9707 map_here
= get_local_map (XINT (pos
),
9708 current_buffer
, Qlocal_map
);
9709 if (!EQ (map_here
, orig_local_map
))
9711 orig_local_map
= map_here
;
9712 ++localized_local_map
;
9715 map_here
= get_local_map (XINT (pos
),
9716 current_buffer
, Qkeymap
);
9717 if (!EQ (map_here
, orig_keymap
))
9719 orig_keymap
= map_here
;
9720 ++localized_local_map
;
9723 if (localized_local_map
> 1)
9728 goto replay_sequence
;
9734 /* Expand mode-line and scroll-bar events into two events:
9735 use posn as a fake prefix key. */
9737 && (NILP (fake_prefixed_keys
)
9738 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9740 if (t
+ 1 >= bufsize
)
9741 error ("Key sequence too long");
9744 keybuf
[t
+ 1] = key
;
9747 /* Record that a fake prefix key has been generated
9748 for KEY. Don't modify the event; this would
9749 prevent proper action when the event is pushed
9750 back into unread-command-events. */
9751 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9753 /* If on a mode line string with a local keymap,
9754 reconsider the key sequence with that keymap. */
9755 if (string
= POSN_STRING (EVENT_START (key
)),
9756 (CONSP (string
) && STRINGP (XCAR (string
))))
9758 Lisp_Object pos
, map
, map2
;
9760 pos
= XCDR (string
);
9761 string
= XCAR (string
);
9763 && XINT (pos
) < SCHARS (string
))
9765 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9767 orig_local_map
= map
;
9768 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9771 if (!NILP (map
) || !NILP (map2
))
9772 goto replay_sequence
;
9778 else if (NILP (from_string
)
9779 && (string
= POSN_STRING (EVENT_START (key
)),
9780 (CONSP (string
) && STRINGP (XCAR (string
)))))
9782 /* For a click on a string, i.e. overlay string or a
9783 string displayed via the `display' property,
9784 consider `local-map' and `keymap' properties of
9786 Lisp_Object pos
, map
, map2
;
9788 pos
= XCDR (string
);
9789 string
= XCAR (string
);
9791 && XINT (pos
) < SCHARS (string
))
9793 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9795 orig_local_map
= map
;
9796 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9800 if (!NILP (map
) || !NILP (map2
))
9802 from_string
= string
;
9805 goto replay_sequence
;
9810 else if (CONSP (XCDR (key
))
9811 && CONSP (EVENT_START (key
))
9812 && CONSP (XCDR (EVENT_START (key
))))
9816 posn
= POSN_POSN (EVENT_START (key
));
9817 /* Handle menu-bar events:
9818 insert the dummy prefix event `menu-bar'. */
9819 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9821 if (t
+ 1 >= bufsize
)
9822 error ("Key sequence too long");
9826 /* Zap the position in key, so we know that we've
9827 expanded it, and don't try to do so again. */
9828 POSN_SET_POSN (EVENT_START (key
),
9829 Fcons (posn
, Qnil
));
9832 goto replay_sequence
;
9834 else if (CONSP (posn
))
9836 /* We're looking at the second event of a
9837 sequence which we expanded before. Set
9838 last_real_key_start appropriately. */
9839 if (last_real_key_start
== t
&& t
> 0)
9840 last_real_key_start
= t
- 1;
9845 /* We have finally decided that KEY is something we might want
9847 first_binding
= (follow_key (key
,
9848 nmaps
- first_binding
,
9849 submaps
+ first_binding
,
9850 defs
+ first_binding
,
9851 submaps
+ first_binding
)
9854 /* If KEY wasn't bound, we'll try some fallbacks. */
9855 if (first_binding
< nmaps
)
9856 /* This is needed for the following scenario:
9857 event 0: a down-event that gets dropped by calling replay_key.
9858 event 1: some normal prefix like C-h.
9859 After event 0, first_unbound is 0, after event 1 indec.start,
9860 fkey.start, and keytran.start are all 1, so when we see that
9861 C-h is bound, we need to update first_unbound. */
9862 first_unbound
= max (t
+ 1, first_unbound
);
9867 /* Remember the position to put an upper bound on indec.start. */
9868 first_unbound
= min (t
, first_unbound
);
9870 head
= EVENT_HEAD (key
);
9871 if (help_char_p (head
) && t
> 0)
9873 read_key_sequence_cmd
= Vprefix_help_command
;
9875 last_nonmenu_event
= key
;
9876 /* The Microsoft C compiler can't handle the goto that
9884 Lisp_Object breakdown
;
9887 breakdown
= parse_modifiers (head
);
9888 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9889 /* Attempt to reduce an unbound mouse event to a simpler
9890 event that is bound:
9891 Drags reduce to clicks.
9892 Double-clicks reduce to clicks.
9893 Triple-clicks reduce to double-clicks, then to clicks.
9894 Down-clicks are eliminated.
9895 Double-downs reduce to downs, then are eliminated.
9896 Triple-downs reduce to double-downs, then to downs,
9897 then are eliminated. */
9898 if (modifiers
& (down_modifier
| drag_modifier
9899 | double_modifier
| triple_modifier
))
9901 while (modifiers
& (down_modifier
| drag_modifier
9902 | double_modifier
| triple_modifier
))
9904 Lisp_Object new_head
, new_click
;
9905 if (modifiers
& triple_modifier
)
9906 modifiers
^= (double_modifier
| triple_modifier
);
9907 else if (modifiers
& double_modifier
)
9908 modifiers
&= ~double_modifier
;
9909 else if (modifiers
& drag_modifier
)
9910 modifiers
&= ~drag_modifier
;
9913 /* Dispose of this `down' event by simply jumping
9914 back to replay_key, to get another event.
9916 Note that if this event came from mock input,
9917 then just jumping back to replay_key will just
9918 hand it to us again. So we have to wipe out any
9921 We could delete keybuf[t] and shift everything
9922 after that to the left by one spot, but we'd also
9923 have to fix up any variable that points into
9924 keybuf, and shifting isn't really necessary
9927 Adding prefixes for non-textual mouse clicks
9928 creates two characters of mock input, and both
9929 must be thrown away. If we're only looking at
9930 the prefix now, we can just jump back to
9931 replay_key. On the other hand, if we've already
9932 processed the prefix, and now the actual click
9933 itself is giving us trouble, then we've lost the
9934 state of the keymaps we want to backtrack to, and
9935 we need to replay the whole sequence to rebuild
9938 Beyond that, only function key expansion could
9939 create more than two keys, but that should never
9940 generate mouse events, so it's okay to zero
9941 mock_input in that case too.
9943 FIXME: The above paragraph seems just plain
9944 wrong, if you consider things like
9945 xterm-mouse-mode. -stef
9947 Isn't this just the most wonderful code ever? */
9949 /* If mock_input > t + 1, the above simplification
9950 will actually end up dropping keys on the floor.
9951 This is probably OK for now, but even
9952 if mock_input <= t + 1, we need to adjust indec,
9954 Typical case [header-line down-mouse-N]:
9955 mock_input = 2, t = 1, fkey.end = 1,
9956 last_real_key_start = 0. */
9957 if (indec
.end
> last_real_key_start
)
9959 indec
.end
= indec
.start
9960 = min (last_real_key_start
, indec
.start
);
9961 indec
.map
= indec
.parent
;
9962 if (fkey
.end
> last_real_key_start
)
9964 fkey
.end
= fkey
.start
9965 = min (last_real_key_start
, fkey
.start
);
9966 fkey
.map
= fkey
.parent
;
9967 if (keytran
.end
> last_real_key_start
)
9969 keytran
.end
= keytran
.start
9970 = min (last_real_key_start
, keytran
.start
);
9971 keytran
.map
= keytran
.parent
;
9975 if (t
== last_real_key_start
)
9982 mock_input
= last_real_key_start
;
9983 goto replay_sequence
;
9988 = apply_modifiers (modifiers
, XCAR (breakdown
));
9990 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9992 /* Look for a binding for this new key. follow_key
9993 promises that it didn't munge submaps the
9994 last time we called it, since key was unbound. */
9996 = (follow_key (new_click
,
9997 nmaps
- local_first_binding
,
9998 submaps
+ local_first_binding
,
9999 defs
+ local_first_binding
,
10000 submaps
+ local_first_binding
)
10001 + local_first_binding
);
10003 /* If that click is bound, go for it. */
10004 if (first_binding
< nmaps
)
10009 /* Otherwise, we'll leave key set to the drag event. */
10016 /* Normally, last_nonmenu_event gets the previous key we read.
10017 But when a mouse popup menu is being used,
10018 we don't update last_nonmenu_event; it continues to hold the mouse
10019 event that preceded the first level of menu. */
10020 if (!used_mouse_menu
)
10021 last_nonmenu_event
= key
;
10023 /* Record what part of this_command_keys is the current key sequence. */
10024 this_single_command_key_start
= this_command_key_count
- t
;
10026 /* Look for this sequence in input-decode-map.
10027 Scan from indec.end until we find a bound suffix. */
10028 while (indec
.end
< t
)
10030 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10033 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10034 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
10039 mock_input
= diff
+ max (t
, mock_input
);
10040 goto replay_sequence
;
10044 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
10045 && indec
.start
>= t
)
10046 /* There is a binding and it's not a prefix.
10047 (and it doesn't have any input-decode-map translation pending).
10048 There is thus no function-key in this sequence.
10049 Moving fkey.start is important in this case to allow keytran.start
10050 to go over the sequence before we return (since we keep the
10051 invariant that keytran.end <= fkey.start). */
10053 if (fkey
.start
< t
)
10054 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
10057 /* If the sequence is unbound, see if we can hang a function key
10058 off the end of it. */
10059 /* Continue scan from fkey.end until we find a bound suffix. */
10060 while (fkey
.end
< indec
.start
)
10062 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10065 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10066 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
10067 max (t
, mock_input
),
10068 /* If there's a binding (i.e.
10069 first_binding >= nmaps) we don't want
10070 to apply this function-key-mapping. */
10071 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
10076 mock_input
= diff
+ max (t
, mock_input
);
10077 /* Adjust the input-decode-map counters. */
10079 indec
.start
+= diff
;
10081 goto replay_sequence
;
10085 /* Look for this sequence in key-translation-map.
10086 Scan from keytran.end until we find a bound suffix. */
10087 while (keytran
.end
< fkey
.start
)
10089 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10092 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10093 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
10098 mock_input
= diff
+ max (t
, mock_input
);
10099 /* Adjust the function-key-map and input-decode-map counters. */
10101 indec
.start
+= diff
;
10103 fkey
.start
+= diff
;
10105 goto replay_sequence
;
10109 /* If KEY is not defined in any of the keymaps,
10110 and cannot be part of a function key or translation,
10111 and is an upper case letter
10112 use the corresponding lower-case letter instead. */
10113 if (first_binding
>= nmaps
10114 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
10116 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10117 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10118 || (XINT (key
) & shift_modifier
)))
10120 Lisp_Object new_key
;
10122 original_uppercase
= key
;
10123 original_uppercase_position
= t
- 1;
10125 if (XINT (key
) & shift_modifier
)
10126 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10128 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10129 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10131 /* We have to do this unconditionally, regardless of whether
10132 the lower-case char is defined in the keymaps, because they
10133 might get translated through function-key-map. */
10134 keybuf
[t
- 1] = new_key
;
10135 mock_input
= max (t
, mock_input
);
10136 shift_translated
= 1;
10138 goto replay_sequence
;
10140 /* If KEY is not defined in any of the keymaps,
10141 and cannot be part of a function key or translation,
10142 and is a shifted function key,
10143 use the corresponding unshifted function key instead. */
10144 if (first_binding
>= nmaps
10145 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10147 Lisp_Object breakdown
= parse_modifiers (key
);
10149 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10151 if (modifiers
& shift_modifier
10152 /* Treat uppercase keys as shifted. */
10154 && (KEY_TO_CHAR (key
)
10155 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
10156 && UPPERCASEP (KEY_TO_CHAR (key
))))
10158 Lisp_Object new_key
10159 = (modifiers
& shift_modifier
10160 ? apply_modifiers (modifiers
& ~shift_modifier
,
10162 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
10164 original_uppercase
= key
;
10165 original_uppercase_position
= t
- 1;
10167 /* We have to do this unconditionally, regardless of whether
10168 the lower-case char is defined in the keymaps, because they
10169 might get translated through function-key-map. */
10170 keybuf
[t
- 1] = new_key
;
10171 mock_input
= max (t
, mock_input
);
10172 /* Reset fkey (and consequently keytran) to apply
10173 function-key-map on the result, so that S-backspace is
10174 correctly mapped to DEL (via backspace). OTOH,
10175 input-decode-map doesn't need to go through it again. */
10176 fkey
.start
= fkey
.end
= 0;
10177 keytran
.start
= keytran
.end
= 0;
10178 shift_translated
= 1;
10180 goto replay_sequence
;
10185 read_key_sequence_cmd
= (first_binding
< nmaps
10186 ? defs
[first_binding
]
10189 unread_switch_frame
= delayed_switch_frame
;
10190 unbind_to (count
, Qnil
);
10192 /* Don't downcase the last character if the caller says don't.
10193 Don't downcase it if the result is undefined, either. */
10194 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10196 && t
- 1 == original_uppercase_position
)
10198 keybuf
[t
- 1] = original_uppercase
;
10199 shift_translated
= 0;
10202 if (shift_translated
)
10203 Vthis_command_keys_shift_translated
= Qt
;
10205 /* Occasionally we fabricate events, perhaps by expanding something
10206 according to function-key-map, or by adding a prefix symbol to a
10207 mouse click in the scroll bar or modeline. In this cases, return
10208 the entire generated key sequence, even if we hit an unbound
10209 prefix or a definition before the end. This means that you will
10210 be able to push back the event properly, and also means that
10211 read-key-sequence will always return a logical unit.
10214 for (; t
< mock_input
; t
++)
10216 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10217 && NILP (Fzerop (Vecho_keystrokes
)))
10218 echo_char (keybuf
[t
]);
10219 add_command_key (keybuf
[t
]);
10226 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10227 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10228 The sequence is sufficient to specify a non-prefix command in the
10229 current local and global maps.
10231 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10232 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10233 as a continuation of the previous key.
10235 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10236 convert the last event to lower case. (Normally any upper case event
10237 is converted to lower case if the original event is undefined and the lower
10238 case equivalent is defined.) A non-nil value is appropriate for reading
10239 a key sequence to be defined.
10241 A C-g typed while in this function is treated like any other character,
10242 and `quit-flag' is not set.
10244 If the key sequence starts with a mouse click, then the sequence is read
10245 using the keymaps of the buffer of the window clicked in, not the buffer
10246 of the selected window as normal.
10248 `read-key-sequence' drops unbound button-down events, since you normally
10249 only care about the click or drag events which follow them. If a drag
10250 or multi-click event is unbound, but the corresponding click event would
10251 be bound, `read-key-sequence' turns the event into a click event at the
10252 drag's starting position. This means that you don't have to distinguish
10253 between click and drag, double, or triple events unless you want to.
10255 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10256 lines separating windows, and scroll bars with imaginary keys
10257 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10259 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10260 function will process a switch-frame event if the user switches frames
10261 before typing anything. If the user switches frames in the middle of a
10262 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10263 is nil, then the event will be put off until after the current key sequence.
10265 `read-key-sequence' checks `function-key-map' for function key
10266 sequences, where they wouldn't conflict with ordinary bindings. See
10267 `function-key-map' for more details.
10269 The optional fifth argument COMMAND-LOOP, if non-nil, means
10270 that this key sequence is being read by something that will
10271 read commands one after another. It should be nil if the caller
10272 will read just one key sequence. */)
10273 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10275 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10276 Lisp_Object can_return_switch_frame
, command_loop
;
10278 Lisp_Object keybuf
[30];
10280 struct gcpro gcpro1
;
10281 int count
= SPECPDL_INDEX ();
10283 if (!NILP (prompt
))
10284 CHECK_STRING (prompt
);
10287 specbind (Qinput_method_exit_on_first_char
,
10288 (NILP (command_loop
) ? Qt
: Qnil
));
10289 specbind (Qinput_method_use_echo_area
,
10290 (NILP (command_loop
) ? Qt
: Qnil
));
10292 bzero (keybuf
, sizeof keybuf
);
10293 GCPRO1 (keybuf
[0]);
10294 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10296 if (NILP (continue_echo
))
10298 this_command_key_count
= 0;
10299 this_command_key_count_reset
= 0;
10300 this_single_command_key_start
= 0;
10303 #ifdef HAVE_WINDOW_SYSTEM
10304 if (display_hourglass_p
)
10305 cancel_hourglass ();
10308 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10309 prompt
, ! NILP (dont_downcase_last
),
10310 ! NILP (can_return_switch_frame
), 0);
10312 #if 0 /* The following is fine for code reading a key sequence and
10313 then proceeding with a lenghty computation, but it's not good
10314 for code reading keys in a loop, like an input method. */
10315 #ifdef HAVE_WINDOW_SYSTEM
10316 if (display_hourglass_p
)
10317 start_hourglass ();
10327 return unbind_to (count
, make_event_array (i
, keybuf
));
10330 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10331 Sread_key_sequence_vector
, 1, 5, 0,
10332 doc
: /* Like `read-key-sequence' but always return a vector. */)
10333 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10335 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10336 Lisp_Object can_return_switch_frame
, command_loop
;
10338 Lisp_Object keybuf
[30];
10340 struct gcpro gcpro1
;
10341 int count
= SPECPDL_INDEX ();
10343 if (!NILP (prompt
))
10344 CHECK_STRING (prompt
);
10347 specbind (Qinput_method_exit_on_first_char
,
10348 (NILP (command_loop
) ? Qt
: Qnil
));
10349 specbind (Qinput_method_use_echo_area
,
10350 (NILP (command_loop
) ? Qt
: Qnil
));
10352 bzero (keybuf
, sizeof keybuf
);
10353 GCPRO1 (keybuf
[0]);
10354 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10356 if (NILP (continue_echo
))
10358 this_command_key_count
= 0;
10359 this_command_key_count_reset
= 0;
10360 this_single_command_key_start
= 0;
10363 #ifdef HAVE_WINDOW_SYSTEM
10364 if (display_hourglass_p
)
10365 cancel_hourglass ();
10368 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10369 prompt
, ! NILP (dont_downcase_last
),
10370 ! NILP (can_return_switch_frame
), 0);
10372 #ifdef HAVE_WINDOW_SYSTEM
10373 if (display_hourglass_p
)
10374 start_hourglass ();
10383 return unbind_to (count
, Fvector (i
, keybuf
));
10386 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10387 doc
: /* Execute CMD as an editor command.
10388 CMD must be a symbol that satisfies the `commandp' predicate.
10389 Optional second arg RECORD-FLAG non-nil
10390 means unconditionally put this command in `command-history'.
10391 Otherwise, that is done only if an arg is read using the minibuffer.
10392 The argument KEYS specifies the value to use instead of (this-command-keys)
10393 when reading the arguments; if it is nil, (this-command-keys) is used.
10394 The argument SPECIAL, if non-nil, means that this command is executing
10395 a special event, so ignore the prefix argument and don't clear it. */)
10396 (cmd
, record_flag
, keys
, special
)
10397 Lisp_Object cmd
, record_flag
, keys
, special
;
10399 register Lisp_Object final
;
10400 register Lisp_Object tem
;
10401 Lisp_Object prefixarg
;
10402 extern int debug_on_next_call
;
10404 debug_on_next_call
= 0;
10406 if (NILP (special
))
10408 prefixarg
= current_kboard
->Vprefix_arg
;
10409 Vcurrent_prefix_arg
= prefixarg
;
10410 current_kboard
->Vprefix_arg
= Qnil
;
10417 tem
= Fget (cmd
, Qdisabled
);
10418 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10420 tem
= Fsymbol_value (Qdisabled_command_function
);
10422 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10428 final
= Findirect_function (cmd
, Qnil
);
10430 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10432 struct gcpro gcpro1
, gcpro2
;
10434 GCPRO2 (cmd
, prefixarg
);
10435 do_autoload (final
, cmd
);
10442 if (STRINGP (final
) || VECTORP (final
))
10444 /* If requested, place the macro in the command history. For
10445 other sorts of commands, call-interactively takes care of
10447 if (!NILP (record_flag
))
10450 = Fcons (Fcons (Qexecute_kbd_macro
,
10451 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10454 /* Don't keep command history around forever. */
10455 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10457 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10459 XSETCDR (tem
, Qnil
);
10463 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10466 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10467 /* Don't call Fcall_interactively directly because we want to make
10468 sure the backtrace has an entry for `call-interactively'.
10469 For the same reason, pass `cmd' rather than `final'. */
10470 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10477 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10479 doc
: /* Read function name, then read its arguments and call it.
10481 To pass a numeric argument to the command you are invoking with, specify
10482 the numeric argument to this command.
10484 Noninteractively, the argument PREFIXARG is the prefix argument to
10485 give to the command you invoke, if it asks for an argument. */)
10487 Lisp_Object prefixarg
;
10489 Lisp_Object function
;
10491 int saved_last_point_position
;
10492 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10493 Lisp_Object bindings
, value
;
10494 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10495 #ifdef HAVE_WINDOW_SYSTEM
10496 /* The call to Fcompleting_read wil start and cancel the hourglass,
10497 but if the hourglass was already scheduled, this means that no
10498 hourglass will be shown for the actual M-x command itself.
10499 So we restart it if it is already scheduled. Note that checking
10500 hourglass_shown_p is not enough, normally the hourglass is not shown,
10501 just scheduled to be shown. */
10502 int hstarted
= hourglass_started ();
10505 saved_keys
= Fvector (this_command_key_count
,
10506 XVECTOR (this_command_keys
)->contents
);
10507 saved_last_point_position_buffer
= last_point_position_buffer
;
10508 saved_last_point_position
= last_point_position
;
10510 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10512 if (EQ (prefixarg
, Qminus
))
10513 strcpy (buf
, "- ");
10514 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10515 strcpy (buf
, "C-u ");
10516 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10517 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10518 else if (INTEGERP (prefixarg
))
10519 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10521 /* This isn't strictly correct if execute-extended-command
10522 is bound to anything else. Perhaps it should use
10523 this_command_keys? */
10524 strcat (buf
, "M-x ");
10526 /* Prompt with buf, and then read a string, completing from and
10527 restricting to the set of all defined commands. Don't provide
10528 any initial input. Save the command read on the extended-command
10530 function
= Fcompleting_read (build_string (buf
),
10531 Vobarray
, Qcommandp
,
10532 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10535 #ifdef HAVE_WINDOW_SYSTEM
10536 if (hstarted
) start_hourglass ();
10539 if (STRINGP (function
) && SCHARS (function
) == 0)
10540 error ("No command name given");
10542 /* Set this_command_keys to the concatenation of saved_keys and
10543 function, followed by a RET. */
10548 this_command_key_count
= 0;
10549 this_command_key_count_reset
= 0;
10550 this_single_command_key_start
= 0;
10552 keys
= XVECTOR (saved_keys
)->contents
;
10553 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10554 add_command_key (keys
[i
]);
10556 for (i
= 0; i
< SCHARS (function
); i
++)
10557 add_command_key (Faref (function
, make_number (i
)));
10559 add_command_key (make_number ('\015'));
10562 last_point_position
= saved_last_point_position
;
10563 last_point_position_buffer
= saved_last_point_position_buffer
;
10567 function
= Fintern (function
, Qnil
);
10568 current_kboard
->Vprefix_arg
= prefixarg
;
10569 Vthis_command
= function
;
10570 real_this_command
= function
;
10572 /* If enabled, show which key runs this command. */
10573 if (!NILP (Vsuggest_key_bindings
)
10574 && NILP (Vexecuting_kbd_macro
)
10575 && SYMBOLP (function
))
10576 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10582 GCPRO3 (bindings
, value
, function
);
10583 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10585 /* If the command has a key binding, print it now. */
10586 if (!NILP (bindings
)
10587 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10590 /* But first wait, and skip the message if there is input. */
10591 Lisp_Object waited
;
10593 /* If this command displayed something in the echo area;
10594 wait a few seconds, then display our suggestion message. */
10595 if (NILP (echo_area_buffer
[0]))
10596 waited
= sit_for (make_number (0), 0, 2);
10597 else if (NUMBERP (Vsuggest_key_bindings
))
10598 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10600 waited
= sit_for (make_number (2), 0, 2);
10602 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10604 Lisp_Object binding
;
10606 int message_p
= push_message ();
10607 int count
= SPECPDL_INDEX ();
10609 record_unwind_protect (pop_message_unwind
, Qnil
);
10610 binding
= Fkey_description (bindings
, Qnil
);
10613 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10616 sprintf (newmessage
, "You can run the command `%s' with %s",
10617 SDATA (SYMBOL_NAME (function
)),
10619 message2_nolog (newmessage
,
10620 strlen (newmessage
),
10621 STRING_MULTIBYTE (binding
));
10622 if (NUMBERP (Vsuggest_key_bindings
))
10623 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10625 waited
= sit_for (make_number (2), 0, 2);
10627 if (!NILP (waited
) && message_p
)
10628 restore_message ();
10630 unbind_to (count
, Qnil
);
10634 RETURN_UNGCPRO (value
);
10638 /* Return nonzero if input events are pending. */
10641 detect_input_pending ()
10643 if (!input_pending
)
10644 get_input_pending (&input_pending
, 0);
10646 return input_pending
;
10649 /* Return nonzero if input events other than mouse movements are
10653 detect_input_pending_ignore_squeezables ()
10655 if (!input_pending
)
10656 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10658 return input_pending
;
10661 /* Return nonzero if input events are pending, and run any pending timers. */
10664 detect_input_pending_run_timers (do_display
)
10667 int old_timers_run
= timers_run
;
10669 if (!input_pending
)
10670 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10672 if (old_timers_run
!= timers_run
&& do_display
)
10674 redisplay_preserve_echo_area (8);
10675 /* The following fixes a bug when using lazy-lock with
10676 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10677 from an idle timer function. The symptom of the bug is that
10678 the cursor sometimes doesn't become visible until the next X
10679 event is processed. --gerd. */
10681 Lisp_Object tail
, frame
;
10682 FOR_EACH_FRAME (tail
, frame
)
10683 if (FRAME_RIF (XFRAME (frame
)))
10684 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10688 return input_pending
;
10691 /* This is called in some cases before a possible quit.
10692 It cases the next call to detect_input_pending to recompute input_pending.
10693 So calling this function unnecessarily can't do any harm. */
10696 clear_input_pending ()
10701 /* Return nonzero if there are pending requeued events.
10702 This isn't used yet. The hope is to make wait_reading_process_output
10703 call it, and return if it runs Lisp code that unreads something.
10704 The problem is, kbd_buffer_get_event needs to be fixed to know what
10705 to do in that case. It isn't trivial. */
10708 requeued_events_pending_p ()
10710 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10714 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10715 doc
: /* Return t if command input is currently available with no wait.
10716 Actually, the value is nil only if we can be sure that no input is available;
10717 if there is a doubt, the value is t. */)
10720 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10721 || !NILP (Vunread_post_input_method_events
)
10722 || !NILP (Vunread_input_method_events
))
10725 get_input_pending (&input_pending
,
10726 READABLE_EVENTS_DO_TIMERS_NOW
10727 | READABLE_EVENTS_FILTER_EVENTS
);
10728 return input_pending
> 0 ? Qt
: Qnil
;
10731 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10732 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10735 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10738 if (total_keys
< NUM_RECENT_KEYS
)
10739 return Fvector (total_keys
, keys
);
10742 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10743 bcopy (keys
+ recent_keys_index
,
10744 XVECTOR (val
)->contents
,
10745 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10747 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10748 recent_keys_index
* sizeof (Lisp_Object
));
10753 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10754 doc
: /* Return the key sequence that invoked this command.
10755 However, if the command has called `read-key-sequence', it returns
10756 the last key sequence that has been read.
10757 The value is a string or a vector.
10759 See also `this-command-keys-vector'. */)
10762 return make_event_array (this_command_key_count
,
10763 XVECTOR (this_command_keys
)->contents
);
10766 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10767 doc
: /* Return the key sequence that invoked this command, as a vector.
10768 However, if the command has called `read-key-sequence', it returns
10769 the last key sequence that has been read.
10771 See also `this-command-keys'. */)
10774 return Fvector (this_command_key_count
,
10775 XVECTOR (this_command_keys
)->contents
);
10778 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10779 Sthis_single_command_keys
, 0, 0, 0,
10780 doc
: /* Return the key sequence that invoked this command.
10781 More generally, it returns the last key sequence read, either by
10782 the command loop or by `read-key-sequence'.
10783 Unlike `this-command-keys', this function's value
10784 does not include prefix arguments.
10785 The value is always a vector. */)
10788 return Fvector (this_command_key_count
10789 - this_single_command_key_start
,
10790 (XVECTOR (this_command_keys
)->contents
10791 + this_single_command_key_start
));
10794 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10795 Sthis_single_command_raw_keys
, 0, 0, 0,
10796 doc
: /* Return the raw events that were read for this command.
10797 More generally, it returns the last key sequence read, either by
10798 the command loop or by `read-key-sequence'.
10799 Unlike `this-single-command-keys', this function's value
10800 shows the events before all translations (except for input methods).
10801 The value is always a vector. */)
10804 return Fvector (raw_keybuf_count
,
10805 (XVECTOR (raw_keybuf
)->contents
));
10808 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10809 Sreset_this_command_lengths
, 0, 0, 0,
10810 doc
: /* Make the unread events replace the last command and echo.
10811 Used in `universal-argument-other-key'.
10813 `universal-argument-other-key' rereads the event just typed.
10814 It then gets translated through `function-key-map'.
10815 The translated event has to replace the real events,
10816 both in the value of (this-command-keys) and in echoing.
10817 To achieve this, `universal-argument-other-key' calls
10818 `reset-this-command-lengths', which discards the record of reading
10819 these events the first time. */)
10822 this_command_key_count
= before_command_key_count
;
10823 if (this_command_key_count
< this_single_command_key_start
)
10824 this_single_command_key_start
= this_command_key_count
;
10826 echo_truncate (before_command_echo_length
);
10828 /* Cause whatever we put into unread-command-events
10829 to echo as if it were being freshly read from the keyboard. */
10830 this_command_key_count_reset
= 1;
10835 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10836 Sclear_this_command_keys
, 0, 1, 0,
10837 doc
: /* Clear out the vector that `this-command-keys' returns.
10838 Also clear the record of the last 100 events, unless optional arg
10839 KEEP-RECORD is non-nil. */)
10841 Lisp_Object keep_record
;
10845 this_command_key_count
= 0;
10846 this_command_key_count_reset
= 0;
10848 if (NILP (keep_record
))
10850 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10851 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10853 recent_keys_index
= 0;
10858 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10859 doc
: /* Return the current depth in recursive edits. */)
10863 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10867 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10868 "FOpen dribble file: ",
10869 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10870 If FILE is nil, close any open dribble file. */)
10883 file
= Fexpand_file_name (file
, Qnil
);
10884 dribble
= fopen (SDATA (file
), "w");
10886 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10891 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10892 doc
: /* Discard the contents of the terminal input buffer.
10893 Also end any kbd macro being defined. */)
10896 if (!NILP (current_kboard
->defining_kbd_macro
))
10898 /* Discard the last command from the macro. */
10899 Fcancel_kbd_macro_events ();
10903 update_mode_lines
++;
10905 Vunread_command_events
= Qnil
;
10906 unread_command_char
= -1;
10908 discard_tty_input ();
10910 kbd_fetch_ptr
= kbd_store_ptr
;
10916 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10917 doc
: /* Stop Emacs and return to superior process. You can resume later.
10918 If `cannot-suspend' is non-nil, or if the system doesn't support job
10919 control, run a subshell instead.
10921 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10922 to be read as terminal input by Emacs's parent, after suspension.
10924 Before suspending, run the normal hook `suspend-hook'.
10925 After resumption run the normal hook `suspend-resume-hook'.
10927 Some operating systems cannot stop the Emacs process and resume it later.
10928 On such systems, Emacs starts a subshell instead of suspending. */)
10930 Lisp_Object stuffstring
;
10932 int count
= SPECPDL_INDEX ();
10933 int old_height
, old_width
;
10935 struct gcpro gcpro1
;
10937 if (tty_list
&& tty_list
->next
)
10938 error ("There are other tty frames open; close them before suspending Emacs");
10940 if (!NILP (stuffstring
))
10941 CHECK_STRING (stuffstring
);
10943 /* Run the functions in suspend-hook. */
10944 if (!NILP (Vrun_hooks
))
10945 call1 (Vrun_hooks
, intern ("suspend-hook"));
10947 GCPRO1 (stuffstring
);
10948 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10949 reset_all_sys_modes ();
10950 /* sys_suspend can get an error if it tries to fork a subshell
10951 and the system resources aren't available for that. */
10952 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10954 stuff_buffered_input (stuffstring
);
10955 if (cannot_suspend
)
10959 unbind_to (count
, Qnil
);
10961 /* Check if terminal/window size has changed.
10962 Note that this is not useful when we are running directly
10963 with a window system; but suspend should be disabled in that case. */
10964 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10965 if (width
!= old_width
|| height
!= old_height
)
10966 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10968 /* Run suspend-resume-hook. */
10969 if (!NILP (Vrun_hooks
))
10970 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10976 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10977 Then in any case stuff anything Emacs has read ahead and not used. */
10980 stuff_buffered_input (stuffstring
)
10981 Lisp_Object stuffstring
;
10983 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10984 register unsigned char *p
;
10986 if (STRINGP (stuffstring
))
10988 register int count
;
10990 p
= SDATA (stuffstring
);
10991 count
= SBYTES (stuffstring
);
10992 while (count
-- > 0)
10997 /* Anything we have read ahead, put back for the shell to read. */
10998 /* ?? What should this do when we have multiple keyboards??
10999 Should we ignore anything that was typed in at the "wrong" kboard?
11001 rms: we should stuff everything back into the kboard
11003 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
11006 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11007 kbd_fetch_ptr
= kbd_buffer
;
11008 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
11009 stuff_char (kbd_fetch_ptr
->code
);
11011 clear_event (kbd_fetch_ptr
);
11015 #endif /* SIGTSTP */
11019 set_waiting_for_input (time_to_clear
)
11020 EMACS_TIME
*time_to_clear
;
11022 input_available_clear_time
= time_to_clear
;
11024 /* Tell handle_interrupt to throw back to read_char, */
11025 waiting_for_input
= 1;
11027 /* If handle_interrupt was called before and buffered a C-g,
11028 make it run again now, to avoid timing error. */
11029 if (!NILP (Vquit_flag
))
11030 quit_throw_to_read_char ();
11034 clear_waiting_for_input ()
11036 /* Tell handle_interrupt not to throw back to read_char, */
11037 waiting_for_input
= 0;
11038 input_available_clear_time
= 0;
11041 /* The SIGINT handler.
11043 If we have a frame on the controlling tty, we assume that the
11044 SIGINT was generated by C-g, so we call handle_interrupt.
11045 Otherwise, the handler kills Emacs. */
11048 interrupt_signal (signalnum
) /* If we don't have an argument, */
11049 int signalnum
; /* some compilers complain in signal calls. */
11051 /* Must preserve main program's value of errno. */
11052 int old_errno
= errno
;
11053 struct terminal
*terminal
;
11055 #if defined (USG) && !defined (POSIX_SIGNALS)
11056 /* USG systems forget handlers when they are used;
11057 must reestablish each time */
11058 signal (SIGINT
, interrupt_signal
);
11059 signal (SIGQUIT
, interrupt_signal
);
11062 SIGNAL_THREAD_CHECK (signalnum
);
11064 /* See if we have an active terminal on our controlling tty. */
11065 terminal
= get_named_tty ("/dev/tty");
11068 /* If there are no frames there, let's pretend that we are a
11069 well-behaving UN*X program and quit. */
11070 Fkill_emacs (Qnil
);
11074 /* Otherwise, the SIGINT was probably generated by C-g. */
11076 /* Set internal_last_event_frame to the top frame of the
11077 controlling tty, if we have a frame there. We disable the
11078 interrupt key on secondary ttys, so the SIGINT must have come
11079 from the controlling tty. */
11080 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
11082 handle_interrupt ();
11088 /* This routine is called at interrupt level in response to C-g.
11090 It is called from the SIGINT handler or kbd_buffer_store_event.
11092 If `waiting_for_input' is non zero, then unless `echoing' is
11093 nonzero, immediately throw back to read_char.
11095 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
11096 eval to throw, when it gets a chance. If quit-flag is already
11097 non-nil, it stops the job right away. */
11100 handle_interrupt ()
11106 /* XXX This code needs to be revised for multi-tty support. */
11107 if (!NILP (Vquit_flag
)
11109 && get_named_tty ("/dev/tty")
11113 /* If SIGINT isn't blocked, don't let us be interrupted by
11114 another SIGINT, it might be harmful due to non-reentrancy
11115 in I/O functions. */
11116 sigblock (sigmask (SIGINT
));
11119 reset_all_sys_modes ();
11121 #ifdef SIGTSTP /* Support possible in later USG versions */
11123 * On systems which can suspend the current process and return to the original
11124 * shell, this command causes the user to end up back at the shell.
11125 * The "Auto-save" and "Abort" questions are not asked until
11126 * the user elects to return to emacs, at which point he can save the current
11127 * job and either dump core or continue.
11132 if (sys_suspend () == -1)
11134 printf ("Not running as a subprocess;\n");
11135 printf ("you can continue or abort.\n");
11137 #else /* not VMS */
11138 /* Perhaps should really fork an inferior shell?
11139 But that would not provide any way to get back
11140 to the original shell, ever. */
11141 printf ("No support for stopping a process on this operating system;\n");
11142 printf ("you can continue or abort.\n");
11143 #endif /* not VMS */
11144 #endif /* not SIGTSTP */
11146 /* We must remain inside the screen area when the internal terminal
11147 is used. Note that [Enter] is not echoed by dos. */
11150 /* It doesn't work to autosave while GC is in progress;
11151 the code used for auto-saving doesn't cope with the mark bit. */
11152 if (!gc_in_progress
)
11154 printf ("Auto-save? (y or n) ");
11156 if (((c
= getchar ()) & ~040) == 'Y')
11158 Fdo_auto_save (Qt
, Qnil
);
11160 printf ("\r\nAuto-save done");
11161 #else /* not MSDOS */
11162 printf ("Auto-save done\n");
11163 #endif /* not MSDOS */
11165 while (c
!= '\n') c
= getchar ();
11169 /* During GC, it must be safe to reenable quitting again. */
11170 Vinhibit_quit
= Qnil
;
11173 #endif /* not MSDOS */
11174 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11175 printf ("but will instead do a real quit after garbage collection ends\r\n");
11180 printf ("\r\nAbort? (y or n) ");
11181 #else /* not MSDOS */
11183 printf ("Abort (and enter debugger)? (y or n) ");
11184 #else /* not VMS */
11185 printf ("Abort (and dump core)? (y or n) ");
11186 #endif /* not VMS */
11187 #endif /* not MSDOS */
11189 if (((c
= getchar ()) & ~040) == 'Y')
11191 while (c
!= '\n') c
= getchar ();
11193 printf ("\r\nContinuing...\r\n");
11194 #else /* not MSDOS */
11195 printf ("Continuing...\n");
11196 #endif /* not MSDOS */
11198 init_all_sys_modes ();
11203 /* If executing a function that wants to be interrupted out of
11204 and the user has not deferred quitting by binding `inhibit-quit'
11205 then quit right away. */
11206 if (immediate_quit
&& NILP (Vinhibit_quit
))
11208 struct gl_state_s saved
;
11209 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11211 immediate_quit
= 0;
11214 GCPRO4 (saved
.object
, saved
.global_code
,
11215 saved
.current_syntax_table
, saved
.old_prop
);
11216 Fsignal (Qquit
, Qnil
);
11221 /* Else request quit when it's safe */
11225 if (waiting_for_input
&& !echoing
)
11226 quit_throw_to_read_char ();
11229 /* Handle a C-g by making read_char return C-g. */
11232 quit_throw_to_read_char ()
11235 /* Prevent another signal from doing this before we finish. */
11236 clear_waiting_for_input ();
11239 Vunread_command_events
= Qnil
;
11240 unread_command_char
= -1;
11242 #if 0 /* Currently, sit_for is called from read_char without turning
11243 off polling. And that can call set_waiting_for_input.
11244 It seems to be harmless. */
11245 #ifdef POLL_FOR_INPUT
11246 /* May be > 1 if in recursive minibuffer. */
11247 if (poll_suppress_count
== 0)
11251 if (FRAMEP (internal_last_event_frame
)
11252 && !EQ (internal_last_event_frame
, selected_frame
))
11253 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11256 _longjmp (getcjmp
, 1);
11259 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11260 doc
: /* Set interrupt mode of reading keyboard input.
11261 If INTERRUPT is non-nil, Emacs will use input interrupts;
11262 otherwise Emacs uses CBREAK mode.
11264 See also `current-input-mode'. */)
11266 Lisp_Object interrupt
;
11268 int new_interrupt_input
;
11270 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11271 #ifdef HAVE_X_WINDOWS
11272 if (x_display_list
!= NULL
)
11274 /* When using X, don't give the user a real choice,
11275 because we haven't implemented the mechanisms to support it. */
11276 #ifdef NO_SOCK_SIGIO
11277 new_interrupt_input
= 0;
11278 #else /* not NO_SOCK_SIGIO */
11279 new_interrupt_input
= 1;
11280 #endif /* NO_SOCK_SIGIO */
11284 new_interrupt_input
= !NILP (interrupt
);
11285 #else /* not SIGIO */
11286 new_interrupt_input
= 0;
11287 #endif /* not SIGIO */
11289 /* Our VMS input only works by interrupts, as of now. */
11291 new_interrupt_input
= 1;
11294 if (new_interrupt_input
!= interrupt_input
)
11296 #ifdef POLL_FOR_INPUT
11300 /* this causes startup screen to be restored and messes with the mouse */
11301 reset_all_sys_modes ();
11303 interrupt_input
= new_interrupt_input
;
11305 init_all_sys_modes ();
11308 #ifdef POLL_FOR_INPUT
11309 poll_suppress_count
= 1;
11316 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11317 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11318 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11319 C-q in key sequences.
11321 This setting only has an effect on tty terminals and only when
11322 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11324 See also `current-input-mode'. */)
11326 Lisp_Object flow
, terminal
;
11328 struct terminal
*t
= get_terminal (terminal
, 1);
11329 struct tty_display_info
*tty
;
11330 if (t
== NULL
|| t
->type
!= output_termcap
)
11332 tty
= t
->display_info
.tty
;
11334 if (tty
->flow_control
!= !NILP (flow
))
11337 /* this causes startup screen to be restored and messes with the mouse */
11338 reset_sys_modes (tty
);
11341 tty
->flow_control
= !NILP (flow
);
11344 init_sys_modes (tty
);
11350 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11351 doc
: /* Enable or disable 8-bit input on TERMINAL.
11352 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11353 bit as the Meta modifier.
11355 If META is nil, Emacs will ignore the top bit, on the assumption it is
11358 Otherwise, Emacs will accept and pass through 8-bit input without
11359 specially interpreting the top bit.
11361 This setting only has an effect on tty terminal devices.
11363 Optional parameter TERMINAL specifies the tty terminal device to use.
11364 It may be a terminal id, a frame, or nil for the terminal used by the
11365 currently selected frame.
11367 See also `current-input-mode'. */)
11369 Lisp_Object meta
, terminal
;
11371 struct terminal
*t
= get_terminal (terminal
, 1);
11372 struct tty_display_info
*tty
;
11375 if (t
== NULL
|| t
->type
!= output_termcap
)
11377 tty
= t
->display_info
.tty
;
11381 else if (EQ (meta
, Qt
))
11386 if (tty
->meta_key
!= new_meta
)
11389 /* this causes startup screen to be restored and messes with the mouse */
11390 reset_sys_modes (tty
);
11393 tty
->meta_key
= new_meta
;
11396 init_sys_modes (tty
);
11402 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11403 doc
: /* Specify character used for quitting.
11404 QUIT must be an ASCII character.
11406 This function only has an effect on the controlling tty of the Emacs
11409 See also `current-input-mode'. */)
11413 struct terminal
*t
= get_named_tty ("/dev/tty");
11414 struct tty_display_info
*tty
;
11415 if (t
== NULL
|| t
->type
!= output_termcap
)
11417 tty
= t
->display_info
.tty
;
11419 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11420 error ("QUIT must be an ASCII character");
11423 /* this causes startup screen to be restored and messes with the mouse */
11424 reset_sys_modes (tty
);
11427 /* Don't let this value be out of range. */
11428 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11431 init_sys_modes (tty
);
11437 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11438 doc
: /* Set mode of reading keyboard input.
11439 First arg INTERRUPT non-nil means use input interrupts;
11440 nil means use CBREAK mode.
11441 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11442 (no effect except in CBREAK mode).
11443 Third arg META t means accept 8-bit input (for a Meta key).
11444 META nil means ignore the top bit, on the assumption it is parity.
11445 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11446 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11447 See also `current-input-mode'. */)
11448 (interrupt
, flow
, meta
, quit
)
11449 Lisp_Object interrupt
, flow
, meta
, quit
;
11451 Fset_input_interrupt_mode (interrupt
);
11452 Fset_output_flow_control (flow
, Qnil
);
11453 Fset_input_meta_mode (meta
, Qnil
);
11455 Fset_quit_char (quit
);
11459 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11460 doc
: /* Return information about the way Emacs currently reads keyboard input.
11461 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11462 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11463 nil, Emacs is using CBREAK mode.
11464 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11465 terminal; this does not apply if Emacs uses interrupt-driven input.
11466 META is t if accepting 8-bit input with 8th bit as Meta flag.
11467 META nil means ignoring the top bit, on the assumption it is parity.
11468 META is neither t nor nil if accepting 8-bit input and using
11469 all 8 bits as the character code.
11470 QUIT is the character Emacs currently uses to quit.
11471 The elements of this list correspond to the arguments of
11472 `set-input-mode'. */)
11475 Lisp_Object val
[4];
11476 struct frame
*sf
= XFRAME (selected_frame
);
11478 val
[0] = interrupt_input
? Qt
: Qnil
;
11479 if (FRAME_TERMCAP_P (sf
))
11481 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11482 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11484 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11491 XSETFASTINT (val
[3], quit_char
);
11493 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11496 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11497 doc
: /* Return position information for pixel coordinates X and Y.
11498 By default, X and Y are relative to text area of the selected window.
11499 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11500 If optional fourth arg WHOLE is non-nil, X is relative to the left
11501 edge of the window.
11503 The return value is similar to a mouse click position:
11504 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11505 IMAGE (DX . DY) (WIDTH . HEIGHT))
11506 The `posn-' functions access elements of such lists. */)
11507 (x
, y
, frame_or_window
, whole
)
11508 Lisp_Object x
, y
, frame_or_window
, whole
;
11513 if (NILP (frame_or_window
))
11514 frame_or_window
= selected_window
;
11516 if (WINDOWP (frame_or_window
))
11520 CHECK_LIVE_WINDOW (frame_or_window
);
11522 w
= XWINDOW (frame_or_window
);
11523 XSETINT (x
, (XINT (x
)
11524 + WINDOW_LEFT_EDGE_X (w
)
11526 ? window_box_left_offset (w
, TEXT_AREA
)
11528 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11529 frame_or_window
= w
->frame
;
11532 CHECK_LIVE_FRAME (frame_or_window
);
11534 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11537 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11538 doc
: /* Return position information for buffer POS in WINDOW.
11539 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11541 Return nil if position is not visible in window. Otherwise,
11542 the return value is similar to that returned by `event-start' for
11543 a mouse click at the upper left corner of the glyph corresponding
11544 to the given buffer position:
11545 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11546 IMAGE (DX . DY) (WIDTH . HEIGHT))
11547 The `posn-' functions access elements of such lists. */)
11549 Lisp_Object pos
, window
;
11554 window
= selected_window
;
11556 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11559 Lisp_Object x
= XCAR (tem
);
11560 Lisp_Object y
= XCAR (XCDR (tem
));
11562 /* Point invisible due to hscrolling? */
11565 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11573 * Set up a new kboard object with reasonable initial values.
11579 kb
->Voverriding_terminal_local_map
= Qnil
;
11580 kb
->Vlast_command
= Qnil
;
11581 kb
->Vreal_last_command
= Qnil
;
11582 kb
->Vkeyboard_translate_table
= Qnil
;
11583 kb
->Vlast_repeatable_command
= Qnil
;
11584 kb
->Vprefix_arg
= Qnil
;
11585 kb
->Vlast_prefix_arg
= Qnil
;
11586 kb
->kbd_queue
= Qnil
;
11587 kb
->kbd_queue_has_data
= 0;
11588 kb
->immediate_echo
= 0;
11589 kb
->echo_string
= Qnil
;
11590 kb
->echo_after_prompt
= -1;
11591 kb
->kbd_macro_buffer
= 0;
11592 kb
->kbd_macro_bufsize
= 0;
11593 kb
->defining_kbd_macro
= Qnil
;
11594 kb
->Vlast_kbd_macro
= Qnil
;
11595 kb
->reference_count
= 0;
11596 kb
->Vsystem_key_alist
= Qnil
;
11597 kb
->system_key_syms
= Qnil
;
11598 kb
->Vwindow_system
= Qt
; /* Unset. */
11599 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11600 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11601 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11602 kb
->Vdefault_minibuffer_frame
= Qnil
;
11606 * Destroy the contents of a kboard object, but not the object itself.
11607 * We use this just before deleting it, or if we're going to initialize
11608 * it a second time.
11614 if (kb
->kbd_macro_buffer
)
11615 xfree (kb
->kbd_macro_buffer
);
11618 #ifdef MULTI_KBOARD
11620 /* Free KB and memory referenced from it. */
11628 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11631 *kbp
= kb
->next_kboard
;
11633 /* Prevent a dangling reference to KB. */
11634 if (kb
== current_kboard
11635 && FRAMEP (selected_frame
)
11636 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11638 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11640 if (current_kboard
== kb
)
11648 #endif /* MULTI_KBOARD */
11653 /* This is correct before outermost invocation of the editor loop */
11654 command_loop_level
= -1;
11655 immediate_quit
= 0;
11656 quit_char
= Ctl ('g');
11657 Vunread_command_events
= Qnil
;
11658 unread_command_char
= -1;
11659 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11661 recent_keys_index
= 0;
11662 kbd_fetch_ptr
= kbd_buffer
;
11663 kbd_store_ptr
= kbd_buffer
;
11664 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11665 do_mouse_tracking
= Qnil
;
11668 interrupt_input_blocked
= 0;
11669 interrupt_input_pending
= 0;
11671 /* This means that command_loop_1 won't try to select anything the first
11673 internal_last_event_frame
= Qnil
;
11674 Vlast_event_frame
= internal_last_event_frame
;
11676 #ifdef MULTI_KBOARD
11677 current_kboard
= initial_kboard
;
11679 /* Re-initialize the keyboard again. */
11680 wipe_kboard (current_kboard
);
11681 init_kboard (current_kboard
);
11682 /* A value of nil for Vwindow_system normally means a tty, but we also use
11683 it for the initial terminal since there is no window system there. */
11684 current_kboard
->Vwindow_system
= Qnil
;
11686 if (!noninteractive
)
11688 /* Before multi-tty support, these handlers used to be installed
11689 only if the current session was a tty session. Now an Emacs
11690 session may have multiple display types, so we always handle
11691 SIGINT. There is special code in interrupt_signal to exit
11692 Emacs on SIGINT when there are no termcap frames on the
11693 controlling terminal. */
11694 signal (SIGINT
, interrupt_signal
);
11695 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11696 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11697 SIGQUIT and we can't tell which one it will give us. */
11698 signal (SIGQUIT
, interrupt_signal
);
11699 #endif /* HAVE_TERMIO */
11701 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11703 if (!noninteractive
)
11704 signal (SIGIO
, input_available_signal
);
11707 /* Use interrupt input by default, if it works and noninterrupt input
11708 has deficiencies. */
11710 #ifdef INTERRUPT_INPUT
11711 interrupt_input
= 1;
11713 interrupt_input
= 0;
11716 /* Our VMS input only works by interrupts, as of now. */
11718 interrupt_input
= 1;
11724 if (keyboard_init_hook
)
11725 (*keyboard_init_hook
) ();
11727 #ifdef POLL_FOR_INPUT
11728 poll_suppress_count
= 1;
11733 /* This type's only use is in syms_of_keyboard, to initialize the
11734 event header symbols and put properties on them. */
11735 struct event_head
{
11741 struct event_head head_table
[] = {
11742 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11743 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11744 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11745 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11746 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11747 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11748 /* `select-window' should be handled just like `switch-frame'
11749 in read_key_sequence. */
11750 {&Qselect_window
, "select-window", &Qswitch_frame
}
11754 syms_of_keyboard ()
11756 pending_funcalls
= Qnil
;
11758 Vpre_help_message
= Qnil
;
11759 staticpro (&Vpre_help_message
);
11761 Vlispy_mouse_stem
= build_string ("mouse");
11762 staticpro (&Vlispy_mouse_stem
);
11765 QCimage
= intern (":image");
11766 staticpro (&QCimage
);
11768 staticpro (&Qhelp_echo
);
11769 Qhelp_echo
= intern ("help-echo");
11772 Qrtl
= intern (":rtl");
11774 staticpro (&item_properties
);
11775 item_properties
= Qnil
;
11777 staticpro (&tool_bar_item_properties
);
11778 tool_bar_item_properties
= Qnil
;
11779 staticpro (&tool_bar_items_vector
);
11780 tool_bar_items_vector
= Qnil
;
11782 staticpro (&real_this_command
);
11783 real_this_command
= Qnil
;
11785 Qtimer_event_handler
= intern ("timer-event-handler");
11786 staticpro (&Qtimer_event_handler
);
11788 Qdisabled_command_function
= intern ("disabled-command-function");
11789 staticpro (&Qdisabled_command_function
);
11791 Qself_insert_command
= intern ("self-insert-command");
11792 staticpro (&Qself_insert_command
);
11794 Qforward_char
= intern ("forward-char");
11795 staticpro (&Qforward_char
);
11797 Qbackward_char
= intern ("backward-char");
11798 staticpro (&Qbackward_char
);
11800 Qdisabled
= intern ("disabled");
11801 staticpro (&Qdisabled
);
11803 Qundefined
= intern ("undefined");
11804 staticpro (&Qundefined
);
11806 Qpre_command_hook
= intern ("pre-command-hook");
11807 staticpro (&Qpre_command_hook
);
11809 Qpost_command_hook
= intern ("post-command-hook");
11810 staticpro (&Qpost_command_hook
);
11812 Qdeferred_action_function
= intern ("deferred-action-function");
11813 staticpro (&Qdeferred_action_function
);
11815 Qcommand_hook_internal
= intern ("command-hook-internal");
11816 staticpro (&Qcommand_hook_internal
);
11818 Qfunction_key
= intern ("function-key");
11819 staticpro (&Qfunction_key
);
11820 Qmouse_click
= intern ("mouse-click");
11821 staticpro (&Qmouse_click
);
11822 #if defined (WINDOWSNT) || defined (MAC_OS)
11823 Qlanguage_change
= intern ("language-change");
11824 staticpro (&Qlanguage_change
);
11826 Qdrag_n_drop
= intern ("drag-n-drop");
11827 staticpro (&Qdrag_n_drop
);
11829 Qsave_session
= intern ("save-session");
11830 staticpro (&Qsave_session
);
11833 Qmac_apple_event
= intern ("mac-apple-event");
11834 staticpro (&Qmac_apple_event
);
11838 Qdbus_event
= intern ("dbus-event");
11839 staticpro (&Qdbus_event
);
11842 Qmenu_enable
= intern ("menu-enable");
11843 staticpro (&Qmenu_enable
);
11844 Qmenu_alias
= intern ("menu-alias");
11845 staticpro (&Qmenu_alias
);
11846 QCenable
= intern (":enable");
11847 staticpro (&QCenable
);
11848 QCvisible
= intern (":visible");
11849 staticpro (&QCvisible
);
11850 QChelp
= intern (":help");
11851 staticpro (&QChelp
);
11852 QCfilter
= intern (":filter");
11853 staticpro (&QCfilter
);
11854 QCbutton
= intern (":button");
11855 staticpro (&QCbutton
);
11856 QCkeys
= intern (":keys");
11857 staticpro (&QCkeys
);
11858 QCkey_sequence
= intern (":key-sequence");
11859 staticpro (&QCkey_sequence
);
11860 QCtoggle
= intern (":toggle");
11861 staticpro (&QCtoggle
);
11862 QCradio
= intern (":radio");
11863 staticpro (&QCradio
);
11865 Qmode_line
= intern ("mode-line");
11866 staticpro (&Qmode_line
);
11867 Qvertical_line
= intern ("vertical-line");
11868 staticpro (&Qvertical_line
);
11869 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11870 staticpro (&Qvertical_scroll_bar
);
11871 Qmenu_bar
= intern ("menu-bar");
11872 staticpro (&Qmenu_bar
);
11874 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11875 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11876 staticpro (&Qmouse_fixup_help_message
);
11879 Qabove_handle
= intern ("above-handle");
11880 staticpro (&Qabove_handle
);
11881 Qhandle
= intern ("handle");
11882 staticpro (&Qhandle
);
11883 Qbelow_handle
= intern ("below-handle");
11884 staticpro (&Qbelow_handle
);
11885 Qup
= intern ("up");
11887 Qdown
= intern ("down");
11888 staticpro (&Qdown
);
11889 Qtop
= intern ("top");
11891 Qbottom
= intern ("bottom");
11892 staticpro (&Qbottom
);
11893 Qend_scroll
= intern ("end-scroll");
11894 staticpro (&Qend_scroll
);
11895 Qratio
= intern ("ratio");
11896 staticpro (&Qratio
);
11898 Qevent_kind
= intern ("event-kind");
11899 staticpro (&Qevent_kind
);
11900 Qevent_symbol_elements
= intern ("event-symbol-elements");
11901 staticpro (&Qevent_symbol_elements
);
11902 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11903 staticpro (&Qevent_symbol_element_mask
);
11904 Qmodifier_cache
= intern ("modifier-cache");
11905 staticpro (&Qmodifier_cache
);
11907 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11908 staticpro (&Qrecompute_lucid_menubar
);
11909 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11910 staticpro (&Qactivate_menubar_hook
);
11912 Qpolling_period
= intern ("polling-period");
11913 staticpro (&Qpolling_period
);
11915 Qinput_method_function
= intern ("input-method-function");
11916 staticpro (&Qinput_method_function
);
11918 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11919 staticpro (&Qinput_method_exit_on_first_char
);
11920 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11921 staticpro (&Qinput_method_use_echo_area
);
11923 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11924 Fset (Qinput_method_use_echo_area
, Qnil
);
11926 last_point_position_buffer
= Qnil
;
11927 last_point_position_window
= Qnil
;
11930 struct event_head
*p
;
11932 for (p
= head_table
;
11933 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11936 *p
->var
= intern (p
->name
);
11937 staticpro (p
->var
);
11938 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11939 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11943 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11944 staticpro (&button_down_location
);
11945 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11946 staticpro (&mouse_syms
);
11947 wheel_syms
= Fmake_vector (make_number (4), Qnil
);
11948 staticpro (&wheel_syms
);
11952 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11954 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11955 for (i
= 0; i
< len
; i
++)
11956 if (modifier_names
[i
])
11957 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11958 staticpro (&modifier_symbols
);
11961 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11962 staticpro (&recent_keys
);
11964 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11965 staticpro (&this_command_keys
);
11967 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11968 staticpro (&raw_keybuf
);
11970 Qextended_command_history
= intern ("extended-command-history");
11971 Fset (Qextended_command_history
, Qnil
);
11972 staticpro (&Qextended_command_history
);
11974 accent_key_syms
= Qnil
;
11975 staticpro (&accent_key_syms
);
11977 func_key_syms
= Qnil
;
11978 staticpro (&func_key_syms
);
11980 drag_n_drop_syms
= Qnil
;
11981 staticpro (&drag_n_drop_syms
);
11983 unread_switch_frame
= Qnil
;
11984 staticpro (&unread_switch_frame
);
11986 internal_last_event_frame
= Qnil
;
11987 staticpro (&internal_last_event_frame
);
11989 read_key_sequence_cmd
= Qnil
;
11990 staticpro (&read_key_sequence_cmd
);
11992 menu_bar_one_keymap_changed_items
= Qnil
;
11993 staticpro (&menu_bar_one_keymap_changed_items
);
11995 menu_bar_items_vector
= Qnil
;
11996 staticpro (&menu_bar_items_vector
);
11998 help_form_saved_window_configs
= Qnil
;
11999 staticpro (&help_form_saved_window_configs
);
12001 defsubr (&Scurrent_idle_time
);
12002 defsubr (&Sevent_symbol_parse_modifiers
);
12003 defsubr (&Sevent_convert_list
);
12004 defsubr (&Sread_key_sequence
);
12005 defsubr (&Sread_key_sequence_vector
);
12006 defsubr (&Srecursive_edit
);
12007 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
12008 defsubr (&Strack_mouse
);
12010 defsubr (&Sinput_pending_p
);
12011 defsubr (&Scommand_execute
);
12012 defsubr (&Srecent_keys
);
12013 defsubr (&Sthis_command_keys
);
12014 defsubr (&Sthis_command_keys_vector
);
12015 defsubr (&Sthis_single_command_keys
);
12016 defsubr (&Sthis_single_command_raw_keys
);
12017 defsubr (&Sreset_this_command_lengths
);
12018 defsubr (&Sclear_this_command_keys
);
12019 defsubr (&Ssuspend_emacs
);
12020 defsubr (&Sabort_recursive_edit
);
12021 defsubr (&Sexit_recursive_edit
);
12022 defsubr (&Srecursion_depth
);
12023 defsubr (&Stop_level
);
12024 defsubr (&Sdiscard_input
);
12025 defsubr (&Sopen_dribble_file
);
12026 defsubr (&Sset_input_interrupt_mode
);
12027 defsubr (&Sset_output_flow_control
);
12028 defsubr (&Sset_input_meta_mode
);
12029 defsubr (&Sset_quit_char
);
12030 defsubr (&Sset_input_mode
);
12031 defsubr (&Scurrent_input_mode
);
12032 defsubr (&Sexecute_extended_command
);
12033 defsubr (&Sposn_at_point
);
12034 defsubr (&Sposn_at_x_y
);
12036 DEFVAR_LISP ("last-command-char", &last_command_char
,
12037 doc
: /* Last input event that was part of a command. */);
12039 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
12040 doc
: /* Last input event that was part of a command. */);
12042 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
12043 doc
: /* Last input event in a command, except for mouse menu events.
12044 Mouse menus give back keys that don't look like mouse events;
12045 this variable holds the actual mouse event that led to the menu,
12046 so that you can determine whether the command was run by mouse or not. */);
12048 DEFVAR_LISP ("last-input-char", &last_input_char
,
12049 doc
: /* Last input event. */);
12051 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
12052 doc
: /* Last input event. */);
12054 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
12055 doc
: /* List of events to be read as the command input.
12056 These events are processed first, before actual keyboard input.
12057 Events read from this list are not normally added to `this-command-keys',
12058 as they will already have been added once as they were read for the first time.
12059 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
12060 Vunread_command_events
= Qnil
;
12062 DEFVAR_INT ("unread-command-char", &unread_command_char
,
12063 doc
: /* If not -1, an object to be read as next command input event. */);
12065 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
12066 doc
: /* List of events to be processed as input by input methods.
12067 These events are processed before `unread-command-events'
12068 and actual keyboard input, but are not given to `input-method-function'. */);
12069 Vunread_post_input_method_events
= Qnil
;
12071 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
12072 doc
: /* List of events to be processed as input by input methods.
12073 These events are processed after `unread-command-events', but
12074 before actual keyboard input.
12075 If there's an active input method, the events are given to
12076 `input-method-function'. */);
12077 Vunread_input_method_events
= Qnil
;
12079 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
12080 doc
: /* Meta-prefix character code.
12081 Meta-foo as command input turns into this character followed by foo. */);
12082 XSETINT (meta_prefix_char
, 033);
12084 DEFVAR_KBOARD ("last-command", Vlast_command
,
12085 doc
: /* The last command executed.
12086 Normally a symbol with a function definition, but can be whatever was found
12087 in the keymap, or whatever the variable `this-command' was set to by that
12090 The value `mode-exit' is special; it means that the previous command
12091 read an event that told it to exit, and it did so and unread that event.
12092 In other words, the present command is the event that made the previous
12095 The value `kill-region' is special; it means that the previous command
12096 was a kill command.
12098 `last-command' has a separate binding for each terminal device.
12099 See Info node `(elisp)Multiple displays'. */);
12101 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
12102 doc
: /* Same as `last-command', but never altered by Lisp code. */);
12104 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
12105 doc
: /* Last command that may be repeated.
12106 The last command executed that was not bound to an input event.
12107 This is the command `repeat' will try to repeat. */);
12109 DEFVAR_LISP ("this-command", &Vthis_command
,
12110 doc
: /* The command now being executed.
12111 The command can set this variable; whatever is put here
12112 will be in `last-command' during the following command. */);
12113 Vthis_command
= Qnil
;
12115 DEFVAR_LISP ("this-command-keys-shift-translated",
12116 &Vthis_command_keys_shift_translated
,
12117 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
12118 Shift-translation occurs when there is no binding for the key sequence
12119 as entered, but a binding was found by changing an upper-case letter
12120 to lower-case, or a shifted function key to an unshifted one. */);
12121 Vthis_command_keys_shift_translated
= Qnil
;
12123 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
12124 doc
: /* The command bound to the current key sequence before remapping.
12125 It equals `this-command' if the original command was not remapped through
12126 any of the active keymaps. Otherwise, the value of `this-command' is the
12127 result of looking up the original command in the active keymaps. */);
12128 Vthis_original_command
= Qnil
;
12130 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
12131 doc
: /* *Number of input events between auto-saves.
12132 Zero means disable autosaving due to number of characters typed. */);
12133 auto_save_interval
= 300;
12135 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
12136 doc
: /* *Number of seconds idle time before auto-save.
12137 Zero or nil means disable auto-saving due to idleness.
12138 After auto-saving due to this many seconds of idle time,
12139 Emacs also does a garbage collection if that seems to be warranted. */);
12140 XSETFASTINT (Vauto_save_timeout
, 30);
12142 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
12143 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
12144 The value may be integer or floating point. */);
12145 Vecho_keystrokes
= make_number (1);
12147 DEFVAR_INT ("polling-period", &polling_period
,
12148 doc
: /* *Interval between polling for input during Lisp execution.
12149 The reason for polling is to make C-g work to stop a running program.
12150 Polling is needed only when using X windows and SIGIO does not work.
12151 Polling is automatically disabled in all other cases. */);
12152 polling_period
= 2;
12154 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
12155 doc
: /* *Maximum time between mouse clicks to make a double-click.
12156 Measured in milliseconds. The value nil means disable double-click
12157 recognition; t means double-clicks have no time limit and are detected
12158 by position only. */);
12159 Vdouble_click_time
= make_number (500);
12161 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
12162 doc
: /* *Maximum mouse movement between clicks to make a double-click.
12163 On window-system frames, value is the number of pixels the mouse may have
12164 moved horizontally or vertically between two clicks to make a double-click.
12165 On non window-system frames, value is interpreted in units of 1/8 characters
12168 This variable is also the threshold for motion of the mouse
12169 to count as a drag. */);
12170 double_click_fuzz
= 3;
12172 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
12173 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
12174 inhibit_local_menu_bar_menus
= 0;
12176 DEFVAR_INT ("num-input-keys", &num_input_keys
,
12177 doc
: /* Number of complete key sequences read as input so far.
12178 This includes key sequences read from keyboard macros.
12179 The number is effectively the number of interactive command invocations. */);
12180 num_input_keys
= 0;
12182 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
12183 doc
: /* Number of input events read from the keyboard so far.
12184 This does not include events generated by keyboard macros. */);
12185 num_nonmacro_input_events
= 0;
12187 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
12188 doc
: /* The frame in which the most recently read event occurred.
12189 If the last event came from a keyboard macro, this is set to `macro'. */);
12190 Vlast_event_frame
= Qnil
;
12192 /* This variable is set up in sysdep.c. */
12193 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
12194 doc
: /* The ERASE character as set by the user with stty. */);
12196 DEFVAR_LISP ("help-char", &Vhelp_char
,
12197 doc
: /* Character to recognize as meaning Help.
12198 When it is read, do `(eval help-form)', and display result if it's a string.
12199 If the value of `help-form' is nil, this char can be read normally. */);
12200 XSETINT (Vhelp_char
, Ctl ('H'));
12202 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
12203 doc
: /* List of input events to recognize as meaning Help.
12204 These work just like the value of `help-char' (see that). */);
12205 Vhelp_event_list
= Qnil
;
12207 DEFVAR_LISP ("help-form", &Vhelp_form
,
12208 doc
: /* Form to execute when character `help-char' is read.
12209 If the form returns a string, that string is displayed.
12210 If `help-form' is nil, the help char is not recognized. */);
12213 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12214 doc
: /* Command to run when `help-char' character follows a prefix key.
12215 This command is used only when there is no actual binding
12216 for that character after that prefix key. */);
12217 Vprefix_help_command
= Qnil
;
12219 DEFVAR_LISP ("top-level", &Vtop_level
,
12220 doc
: /* Form to evaluate when Emacs starts up.
12221 Useful to set before you dump a modified Emacs. */);
12224 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12225 doc
: /* Translate table for local keyboard input, or nil.
12226 If non-nil, the value should be a char-table. Each character read
12227 from the keyboard is looked up in this char-table. If the value found
12228 there is non-nil, then it is used instead of the actual input character.
12230 The value can also be a string or vector, but this is considered obsolete.
12231 If it is a string or vector of length N, character codes N and up are left
12232 untranslated. In a vector, an element which is nil means "no translation".
12234 This is applied to the characters supplied to input methods, not their
12235 output. See also `translation-table-for-input'.
12237 This variable has a separate binding for each terminal. See Info node
12238 `(elisp)Multiple displays'. */);
12240 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12241 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12242 \(Even if the operating system has support for stopping a process.\) */);
12243 cannot_suspend
= 0;
12245 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12246 doc
: /* Non-nil means prompt with menus when appropriate.
12247 This is done when reading from a keymap that has a prompt string,
12248 for elements that have prompt strings.
12249 The menu is displayed on the screen
12250 if X menus were enabled at configuration
12251 time and the previous event was a mouse click prefix key.
12252 Otherwise, menu prompting uses the echo area. */);
12253 menu_prompting
= 1;
12255 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12256 doc
: /* Character to see next line of menu prompt.
12257 Type this character while in a menu prompt to rotate around the lines of it. */);
12258 XSETINT (menu_prompt_more_char
, ' ');
12260 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12261 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12262 Emacs applies the modifiers of the character stored here to each keyboard
12263 character it reads. For example, after evaluating the expression
12264 (setq extra-keyboard-modifiers ?\\C-x)
12265 all input characters will have the control modifier applied to them.
12267 Note that the character ?\\C-@, equivalent to the integer zero, does
12268 not count as a control character; rather, it counts as a character
12269 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12270 cancels any modification. */);
12271 extra_keyboard_modifiers
= 0;
12273 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12274 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12275 The command loop sets this to nil before each command,
12276 and tests the value when the command returns.
12277 Buffer modification stores t in this variable. */);
12278 Vdeactivate_mark
= Qnil
;
12279 Qdeactivate_mark
= intern ("deactivate-mark");
12280 staticpro (&Qdeactivate_mark
);
12282 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12283 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
12284 Vcommand_hook_internal
= Qnil
;
12286 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12287 doc
: /* Normal hook run before each command is executed.
12288 If an unhandled error happens in running this hook,
12289 the hook value is set to nil, since otherwise the error
12290 might happen repeatedly and make Emacs nonfunctional. */);
12291 Vpre_command_hook
= Qnil
;
12293 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12294 doc
: /* Normal hook run after each command is executed.
12295 If an unhandled error happens in running this hook,
12296 the hook value is set to nil, since otherwise the error
12297 might happen repeatedly and make Emacs nonfunctional. */);
12298 Vpost_command_hook
= Qnil
;
12301 DEFVAR_LISP ("echo-area-clear-hook", ...,
12302 doc
: /* Normal hook run when clearing the echo area. */);
12304 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
12305 staticpro (&Qecho_area_clear_hook
);
12306 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
12308 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12309 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12310 Vlucid_menu_bar_dirty_flag
= Qnil
;
12312 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12313 doc
: /* List of menu bar items to move to the end of the menu bar.
12314 The elements of the list are event types that may have menu bar bindings. */);
12315 Vmenu_bar_final_items
= Qnil
;
12317 DEFVAR_KBOARD ("overriding-terminal-local-map",
12318 Voverriding_terminal_local_map
,
12319 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12320 If this variable is non-nil, it is used as a keymap instead of the
12321 buffer's local map, and the minor mode keymaps and text property keymaps.
12322 It also replaces `overriding-local-map'.
12324 This variable is intended to let commands such as `universal-argument'
12325 set up a different keymap for reading the next command.
12327 `overriding-terminal-local-map' has a separate binding for each
12329 See Info node `(elisp)Multiple displays'. */);
12331 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12332 doc
: /* Keymap that overrides all other local keymaps.
12333 If this variable is non-nil, it is used as a keymap--replacing the
12334 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12335 Voverriding_local_map
= Qnil
;
12337 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12338 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12339 Otherwise, the menu bar continues to reflect the buffer's local map
12340 and the minor mode maps regardless of `overriding-local-map'. */);
12341 Voverriding_local_map_menu_flag
= Qnil
;
12343 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12344 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12345 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
12347 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12348 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12350 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12351 doc
: /* Alist of system-specific X windows key symbols.
12352 Each element should have the form (N . SYMBOL) where N is the
12353 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12354 and SYMBOL is its name.
12356 `system-key-alist' has a separate binding for each terminal device.
12357 See Info node `(elisp)Multiple displays'. */);
12359 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12360 doc
: /* Keymap that translates key sequences to key sequences during input.
12361 This is used mainly for mapping key sequences into some preferred
12362 key events (symbols).
12364 The `read-key-sequence' function replaces any subsequence bound by
12365 `local-function-key-map' with its binding. More precisely, when the
12366 active keymaps have no binding for the current key sequence but
12367 `local-function-key-map' binds a suffix of the sequence to a vector or
12368 string, `read-key-sequence' replaces the matching suffix with its
12369 binding, and continues with the new sequence.
12371 If the binding is a function, it is called with one argument (the prompt)
12372 and its return value (a key sequence) is used.
12374 The events that come from bindings in `local-function-key-map' are not
12375 themselves looked up in `local-function-key-map'.
12377 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12378 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12379 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12380 typing `ESC O P x' would return [f1 x].
12382 `local-function-key-map' has a separate binding for each terminal
12383 device. See Info node `(elisp)Multiple displays'. If you need to
12384 define a binding on all terminals, change `function-key-map'
12385 instead. Initially, `local-function-key-map' is an empty keymap that
12386 has `function-key-map' as its parent on all terminal devices. */);
12388 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12389 doc
: /* Keymap that decodes input escape sequences.
12390 This is used mainly for mapping ASCII function key sequences into
12391 real Emacs function key events (symbols).
12393 The `read-key-sequence' function replaces any subsequence bound by
12394 `local-function-key-map' with its binding. Contrary to `function-key-map',
12395 this map applies its rebinding regardless of the presence of an ordinary
12396 binding. So it is more like `key-translation-map' except that it applies
12397 before `function-key-map' rather than after.
12399 If the binding is a function, it is called with one argument (the prompt)
12400 and its return value (a key sequence) is used.
12402 The events that come from bindings in `input-decode-map' are not
12403 themselves looked up in `input-decode-map'.
12405 This variable is keyboard-local. */);
12407 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12408 doc
: /* The parent keymap of all `local-function-key-map' instances.
12409 Function key definitions that apply to all terminal devices should go
12410 here. If a mapping is defined in both the current
12411 `local-function-key-map' binding and this variable, then the local
12412 definition will take precendence. */);
12413 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12415 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12416 doc
: /* Keymap of key translations that can override keymaps.
12417 This keymap works like `function-key-map', but comes after that,
12418 and its non-prefix bindings override ordinary bindings.
12419 Another difference is that it is global rather than keyboard-local. */);
12420 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12422 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12423 doc
: /* List of deferred actions to be performed at a later time.
12424 The precise format isn't relevant here; we just check whether it is nil. */);
12425 Vdeferred_action_list
= Qnil
;
12427 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12428 doc
: /* Function to call to handle deferred actions, after each command.
12429 This function is called with no arguments after each command
12430 whenever `deferred-action-list' is non-nil. */);
12431 Vdeferred_action_function
= Qnil
;
12433 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12434 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12435 The value can be a length of time to show the message for.
12436 If the value is non-nil and not a number, we wait 2 seconds. */);
12437 Vsuggest_key_bindings
= Qt
;
12439 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12440 doc
: /* List of active absolute time timers in order of increasing time. */);
12441 Vtimer_list
= Qnil
;
12443 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12444 doc
: /* List of active idle-time timers in order of increasing time. */);
12445 Vtimer_idle_list
= Qnil
;
12447 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12448 doc
: /* If non-nil, the function that implements the current input method.
12449 It's called with one argument, a printing character that was just read.
12450 \(That means a character with code 040...0176.)
12451 Typically this function uses `read-event' to read additional events.
12452 When it does so, it should first bind `input-method-function' to nil
12453 so it will not be called recursively.
12455 The function should return a list of zero or more events
12456 to be used as input. If it wants to put back some events
12457 to be reconsidered, separately, by the input method,
12458 it can add them to the beginning of `unread-command-events'.
12460 The input method function can find in `input-method-previous-method'
12461 the previous echo area message.
12463 The input method function should refer to the variables
12464 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12465 for guidance on what to do. */);
12466 Vinput_method_function
= Qnil
;
12468 DEFVAR_LISP ("input-method-previous-message",
12469 &Vinput_method_previous_message
,
12470 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12471 This variable exists because `read-event' clears the echo area
12472 before running the input method. It is nil if there was no message. */);
12473 Vinput_method_previous_message
= Qnil
;
12475 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12476 doc
: /* If non-nil, the function that implements the display of help.
12477 It's called with one argument, the help string to display. */);
12478 Vshow_help_function
= Qnil
;
12480 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12481 doc
: /* If non-nil, suppress point adjustment after executing a command.
12483 After a command is executed, if point is moved into a region that has
12484 special properties (e.g. composition, display), we adjust point to
12485 the boundary of the region. But, when a command sets this variable to
12486 non-nil, we suppress the point adjustment.
12488 This variable is set to nil before reading a command, and is checked
12489 just after executing the command. */);
12490 Vdisable_point_adjustment
= Qnil
;
12492 DEFVAR_LISP ("global-disable-point-adjustment",
12493 &Vglobal_disable_point_adjustment
,
12494 doc
: /* *If non-nil, always suppress point adjustment.
12496 The default value is nil, in which case, point adjustment are
12497 suppressed only after special commands that set
12498 `disable-point-adjustment' (which see) to non-nil. */);
12499 Vglobal_disable_point_adjustment
= Qnil
;
12501 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12502 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12503 If the value is not a number, such messages don't time out. */);
12504 Vminibuffer_message_timeout
= make_number (2);
12506 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12507 doc
: /* If non-nil, any keyboard input throws to this symbol.
12508 The value of that variable is passed to `quit-flag' and later causes a
12509 peculiar kind of quitting. */);
12510 Vthrow_on_input
= Qnil
;
12512 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12513 doc
: /* If non-nil, function to output error messages.
12514 The arguments are the error data, a list of the form
12515 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12516 such as just as `condition-case' would bind its variable to,
12517 the context (a string which normally goes at the start of the message),
12518 and the Lisp function within which the error was signaled. */);
12519 Vcommand_error_function
= Qnil
;
12521 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12522 &Venable_disabled_menus_and_buttons
,
12523 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12525 Help functions bind this to allow help on disabled menu items
12526 and tool-bar buttons. */);
12527 Venable_disabled_menus_and_buttons
= Qnil
;
12529 #ifdef MULTI_KBOARD
12530 /* Create the initial keyboard. */
12531 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12532 init_kboard (initial_kboard
);
12533 /* Vwindow_system is left at t for now. */
12534 initial_kboard
->next_kboard
= all_kboards
;
12535 all_kboards
= initial_kboard
;
12540 keys_of_keyboard ()
12542 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12543 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12544 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12545 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12546 initial_define_key (meta_map
, 'x', "execute-extended-command");
12548 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12549 "handle-delete-frame");
12550 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12551 current-prefix-arg, as is done in `handle-switch-frame'.
12552 But `handle-switch-frame is not run from the special-map.
12553 Commands from that map are run in a special way that automatically
12554 preserves the prefix-arg. Restoring the prefix arg here is not just
12555 redundant but harmful:
12557 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12558 - after the first prompt, the exit-minibuffer-hook is run which may
12559 iconify a frame and thus push a `iconify-frame' event.
12560 - after running exit-minibuffer-hook, current-prefix-arg is
12561 restored to the non-nil value it had before the prompt.
12562 - we enter the second prompt.
12563 current-prefix-arg is non-nil, prefix-arg is nil.
12564 - before running the first real event, we run the special iconify-frame
12565 event, but we pass the `special' arg to execute-command so
12566 current-prefix-arg and prefix-arg are left untouched.
12567 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12568 - the next key event will have a spuriously non-nil current-prefix-arg. */
12569 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12571 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12573 /* Handling it at such a low-level causes read_key_sequence to get
12574 * confused because it doesn't realize that the current_buffer was
12575 * changed by read_char.
12577 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12578 * "handle-select-window"); */
12579 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12580 "handle-save-session");
12583 /* Define a special event which is raised for dbus callback
12585 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12586 "dbus-handle-event");
12590 /* Mark the pointers in the kboard objects.
12591 Called by the Fgarbage_collector. */
12597 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12599 if (kb
->kbd_macro_buffer
)
12600 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12602 mark_object (kb
->Voverriding_terminal_local_map
);
12603 mark_object (kb
->Vlast_command
);
12604 mark_object (kb
->Vreal_last_command
);
12605 mark_object (kb
->Vkeyboard_translate_table
);
12606 mark_object (kb
->Vlast_repeatable_command
);
12607 mark_object (kb
->Vprefix_arg
);
12608 mark_object (kb
->Vlast_prefix_arg
);
12609 mark_object (kb
->kbd_queue
);
12610 mark_object (kb
->defining_kbd_macro
);
12611 mark_object (kb
->Vlast_kbd_macro
);
12612 mark_object (kb
->Vsystem_key_alist
);
12613 mark_object (kb
->system_key_syms
);
12614 mark_object (kb
->Vwindow_system
);
12615 mark_object (kb
->Vinput_decode_map
);
12616 mark_object (kb
->Vlocal_function_key_map
);
12617 mark_object (kb
->Vdefault_minibuffer_frame
);
12618 mark_object (kb
->echo_string
);
12621 struct input_event
*event
;
12622 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12624 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12625 event
= kbd_buffer
;
12626 if (event
->kind
!= SELECTION_REQUEST_EVENT
12627 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12629 mark_object (event
->x
);
12630 mark_object (event
->y
);
12632 mark_object (event
->frame_or_window
);
12633 mark_object (event
->arg
);
12638 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12639 (do not change this comment) */