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 /* Nonzero means do menu prompting. */
162 static int menu_prompting
;
164 /* Character to see next line of menu prompt. */
166 static Lisp_Object menu_prompt_more_char
;
168 /* For longjmp to where kbd input is being done. */
170 static jmp_buf getcjmp
;
172 /* True while doing kbd input. */
173 int waiting_for_input
;
175 /* True while displaying for echoing. Delays C-g throwing. */
179 /* Non-null means we can start echoing at the next input pause even
180 though there is something in the echo area. */
182 static struct kboard
*ok_to_echo_at_next_pause
;
184 /* The kboard last echoing, or null for none. Reset to 0 in
185 cancel_echoing. If non-null, and a current echo area message
186 exists, and echo_message_buffer is eq to the current message
187 buffer, we know that the message comes from echo_kboard. */
189 struct kboard
*echo_kboard
;
191 /* The buffer used for echoing. Set in echo_now, reset in
194 Lisp_Object echo_message_buffer
;
196 /* Nonzero means disregard local maps for the menu bar. */
197 static int inhibit_local_menu_bar_menus
;
199 /* Nonzero means C-g should cause immediate error-signal. */
202 /* The user's hook function for outputting an error message. */
203 Lisp_Object Vcommand_error_function
;
205 /* The user's ERASE setting. */
206 Lisp_Object Vtty_erase_char
;
208 /* Character to recognize as the help char. */
209 Lisp_Object Vhelp_char
;
211 /* List of other event types to recognize as meaning "help". */
212 Lisp_Object Vhelp_event_list
;
214 /* Form to execute when help char is typed. */
215 Lisp_Object Vhelp_form
;
217 /* Command to run when the help character follows a prefix key. */
218 Lisp_Object Vprefix_help_command
;
220 /* List of items that should move to the end of the menu bar. */
221 Lisp_Object Vmenu_bar_final_items
;
223 /* Non-nil means show the equivalent key-binding for
224 any M-x command that has one.
225 The value can be a length of time to show the message for.
226 If the value is non-nil and not a number, we wait 2 seconds. */
227 Lisp_Object Vsuggest_key_bindings
;
229 /* How long to display an echo-area message when the minibuffer is active.
230 If the value is not a number, such messages don't time out. */
231 Lisp_Object Vminibuffer_message_timeout
;
233 /* Character that causes a quit. Normally C-g.
235 If we are running on an ordinary terminal, this must be an ordinary
236 ASCII char, since we want to make it our interrupt character.
238 If we are not running on an ordinary terminal, it still needs to be
239 an ordinary ASCII char. This character needs to be recognized in
240 the input interrupt handler. At this point, the keystroke is
241 represented as a struct input_event, while the desired quit
242 character is specified as a lispy event. The mapping from struct
243 input_events to lispy events cannot run in an interrupt handler,
244 and the reverse mapping is difficult for anything but ASCII
247 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
251 extern Lisp_Object current_global_map
;
252 extern int minibuf_level
;
254 /* If non-nil, this is a map that overrides all other local maps. */
255 Lisp_Object Voverriding_local_map
;
257 /* If non-nil, Voverriding_local_map applies to the menu bar. */
258 Lisp_Object Voverriding_local_map_menu_flag
;
260 /* Keymap that defines special misc events that should
261 be processed immediately at a low level. */
262 Lisp_Object Vspecial_event_map
;
264 /* Current depth in recursive edits. */
265 int command_loop_level
;
267 /* Total number of times command_loop has read a key sequence. */
268 EMACS_INT num_input_keys
;
270 /* Last input character read as a command. */
271 Lisp_Object last_command_char
;
273 /* Last input character read as a command, not counting menus
274 reached by the mouse. */
275 Lisp_Object last_nonmenu_event
;
277 /* Last input character read for any purpose. */
278 Lisp_Object last_input_char
;
280 /* If not Qnil, a list of objects to be read as subsequent command input. */
281 Lisp_Object Vunread_command_events
;
283 /* If not Qnil, a list of objects to be read as subsequent command input
284 including input method processing. */
285 Lisp_Object Vunread_input_method_events
;
287 /* If not Qnil, a list of objects to be read as subsequent command input
288 but NOT including input method processing. */
289 Lisp_Object Vunread_post_input_method_events
;
291 /* If not -1, an event to be read as subsequent command input. */
292 EMACS_INT unread_command_char
;
294 /* If not Qnil, this is a switch-frame event which we decided to put
295 off until the end of a key sequence. This should be read as the
296 next command input, after any unread_command_events.
298 read_key_sequence uses this to delay switch-frame events until the
299 end of the key sequence; Fread_char uses it to put off switch-frame
300 events until a non-ASCII event is acceptable as input. */
301 Lisp_Object unread_switch_frame
;
303 /* A mask of extra modifier bits to put into every keyboard char. */
304 EMACS_INT extra_keyboard_modifiers
;
306 /* Char to use as prefix when a meta character is typed in.
307 This is bound on entry to minibuffer in case ESC is changed there. */
309 Lisp_Object meta_prefix_char
;
311 /* Last size recorded for a current buffer which is not a minibuffer. */
312 static int last_non_minibuf_size
;
314 /* Number of idle seconds before an auto-save and garbage collection. */
315 static Lisp_Object Vauto_save_timeout
;
317 /* Total number of times read_char has returned. */
318 int num_input_events
;
320 /* Total number of times read_char has returned, outside of macros. */
321 EMACS_INT num_nonmacro_input_events
;
323 /* Auto-save automatically when this many characters have been typed
324 since the last time. */
326 static EMACS_INT auto_save_interval
;
328 /* Value of num_nonmacro_input_events as of last auto save. */
332 /* The command being executed by the command loop.
333 Commands may set this, and the value set will be copied into
334 current_kboard->Vlast_command instead of the actual command. */
335 Lisp_Object Vthis_command
;
337 /* This is like Vthis_command, except that commands never set it. */
338 Lisp_Object real_this_command
;
340 /* If the lookup of the command returns a binding, the original
341 command is stored in this-original-command. It is nil otherwise. */
342 Lisp_Object Vthis_original_command
;
344 /* The value of point when the last command was started. */
345 int last_point_position
;
347 /* The buffer that was current when the last command was started. */
348 Lisp_Object last_point_position_buffer
;
350 /* The window that was selected when the last command was started. */
351 Lisp_Object last_point_position_window
;
353 /* The frame in which the last input event occurred, or Qmacro if the
354 last event came from a macro. We use this to determine when to
355 generate switch-frame events. This may be cleared by functions
356 like Fselect_frame, to make sure that a switch-frame event is
357 generated by the next character. */
358 Lisp_Object internal_last_event_frame
;
360 /* A user-visible version of the above, intended to allow users to
361 figure out where the last event came from, if the event doesn't
362 carry that information itself (i.e. if it was a character). */
363 Lisp_Object Vlast_event_frame
;
365 /* The timestamp of the last input event we received from the X server.
366 X Windows wants this for selection ownership. */
367 unsigned long last_event_timestamp
;
369 Lisp_Object Qself_insert_command
;
370 Lisp_Object Qforward_char
;
371 Lisp_Object Qbackward_char
;
372 Lisp_Object Qundefined
;
373 Lisp_Object Qtimer_event_handler
;
375 /* read_key_sequence stores here the command definition of the
376 key sequence that it reads. */
377 Lisp_Object read_key_sequence_cmd
;
379 /* Echo unfinished commands after this many seconds of pause. */
380 Lisp_Object Vecho_keystrokes
;
382 /* Form to evaluate (if non-nil) when Emacs is started. */
383 Lisp_Object Vtop_level
;
385 /* If non-nil, this implements the current input method. */
386 Lisp_Object Vinput_method_function
;
387 Lisp_Object Qinput_method_function
;
389 /* When we call Vinput_method_function,
390 this holds the echo area message that was just erased. */
391 Lisp_Object Vinput_method_previous_message
;
393 /* Non-nil means deactivate the mark at end of this command. */
394 Lisp_Object Vdeactivate_mark
;
395 Lisp_Object Qdeactivate_mark
;
397 /* Menu bar specified in Lucid Emacs fashion. */
399 Lisp_Object Vlucid_menu_bar_dirty_flag
;
400 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
402 Lisp_Object Qecho_area_clear_hook
;
404 /* Hooks to run before and after each command. */
405 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
406 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
407 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
409 /* Parent keymap of terminal-local function-key-map instances. */
410 Lisp_Object Vfunction_key_map
;
412 /* Keymap of key translations that can override keymaps. */
413 Lisp_Object Vkey_translation_map
;
415 /* List of deferred actions to be performed at a later time.
416 The precise format isn't relevant here; we just check whether it is nil. */
417 Lisp_Object Vdeferred_action_list
;
419 /* Function to call to handle deferred actions, when there are any. */
420 Lisp_Object Vdeferred_action_function
;
421 Lisp_Object Qdeferred_action_function
;
423 Lisp_Object Qinput_method_exit_on_first_char
;
424 Lisp_Object Qinput_method_use_echo_area
;
426 /* File in which we write all commands we read. */
429 /* Nonzero if input is available. */
432 extern char *pending_malloc_warning
;
434 /* Circular buffer for pre-read keyboard input. */
436 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
438 /* Pointer to next available character in kbd_buffer.
439 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
440 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
441 next available char is in kbd_buffer[0]. */
442 static struct input_event
*kbd_fetch_ptr
;
444 /* Pointer to next place to store character in kbd_buffer. This
445 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
446 character should go in kbd_buffer[0]. */
447 static struct input_event
* volatile kbd_store_ptr
;
449 /* The above pair of variables forms a "queue empty" flag. When we
450 enqueue a non-hook event, we increment kbd_store_ptr. When we
451 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
452 there is input available if the two pointers are not equal.
454 Why not just have a flag set and cleared by the enqueuing and
455 dequeuing functions? Such a flag could be screwed up by interrupts
456 at inopportune times. */
458 /* If this flag is non-nil, we check mouse_moved to see when the
459 mouse moves, and motion events will appear in the input stream.
460 Otherwise, mouse motion is ignored. */
461 Lisp_Object do_mouse_tracking
;
463 /* Symbols to head events. */
464 Lisp_Object Qmouse_movement
;
465 Lisp_Object Qscroll_bar_movement
;
466 Lisp_Object Qswitch_frame
;
467 Lisp_Object Qdelete_frame
;
468 Lisp_Object Qiconify_frame
;
469 Lisp_Object Qmake_frame_visible
;
470 Lisp_Object Qselect_window
;
471 Lisp_Object Qhelp_echo
;
473 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
474 Lisp_Object Qmouse_fixup_help_message
;
477 /* Symbols to denote kinds of events. */
478 Lisp_Object Qfunction_key
;
479 Lisp_Object Qmouse_click
;
480 #if defined (WINDOWSNT) || defined (MAC_OS)
481 Lisp_Object Qlanguage_change
;
483 Lisp_Object Qdrag_n_drop
;
484 Lisp_Object Qsave_session
;
486 Lisp_Object Qmac_apple_event
;
489 Lisp_Object Qdbus_event
;
491 /* Lisp_Object Qmouse_movement; - also an event header */
493 /* Properties of event headers. */
494 Lisp_Object Qevent_kind
;
495 Lisp_Object Qevent_symbol_elements
;
497 /* menu item parts */
498 Lisp_Object Qmenu_alias
;
499 Lisp_Object Qmenu_enable
;
500 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
501 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
502 extern Lisp_Object Vdefine_key_rebound_commands
;
503 extern Lisp_Object Qmenu_item
;
505 /* An event header symbol HEAD may have a property named
506 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
507 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
508 mask of modifiers applied to it. If present, this is used to help
509 speed up parse_modifiers. */
510 Lisp_Object Qevent_symbol_element_mask
;
512 /* An unmodified event header BASE may have a property named
513 Qmodifier_cache, which is an alist mapping modifier masks onto
514 modified versions of BASE. If present, this helps speed up
516 Lisp_Object Qmodifier_cache
;
518 /* Symbols to use for parts of windows. */
519 Lisp_Object Qmode_line
;
520 Lisp_Object Qvertical_line
;
521 Lisp_Object Qvertical_scroll_bar
;
522 Lisp_Object Qmenu_bar
;
523 extern Lisp_Object Qleft_margin
, Qright_margin
;
524 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
525 extern Lisp_Object QCmap
;
527 Lisp_Object
recursive_edit_unwind (), command_loop ();
528 Lisp_Object
Fthis_command_keys ();
529 Lisp_Object Qextended_command_history
;
530 EMACS_TIME
timer_check ();
532 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
534 extern char *x_get_keysym_name ();
536 static void record_menu_key ();
537 static int echo_length ();
539 Lisp_Object Qpolling_period
;
541 /* List of absolute timers. Appears in order of next scheduled event. */
542 Lisp_Object Vtimer_list
;
544 /* List of idle time timers. Appears in order of next scheduled event. */
545 Lisp_Object Vtimer_idle_list
;
547 /* Incremented whenever a timer is run. */
550 extern Lisp_Object Vprint_level
, Vprint_length
;
552 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
554 EMACS_TIME
*input_available_clear_time
;
556 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
557 Default is 1 if INTERRUPT_INPUT is defined. */
560 /* Nonzero while interrupts are temporarily deferred during redisplay. */
561 int interrupts_deferred
;
563 /* Allow m- file to inhibit use of FIONREAD. */
564 #ifdef BROKEN_FIONREAD
568 /* We are unable to use interrupts if FIONREAD is not available,
569 so flush SIGIO so we won't try. */
570 #if !defined (FIONREAD)
576 /* If we support a window system, turn on the code to poll periodically
577 to detect C-g. It isn't actually used when doing interrupt input. */
578 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
579 #define POLL_FOR_INPUT
582 /* After a command is executed, if point is moved into a region that
583 has specific properties (e.g. composition, display), we adjust
584 point to the boundary of the region. But, if a command sets this
585 variable to non-nil, we suppress this point adjustment. This
586 variable is set to nil before reading a command. */
588 Lisp_Object Vdisable_point_adjustment
;
590 /* If non-nil, always disable point adjustment. */
592 Lisp_Object Vglobal_disable_point_adjustment
;
594 /* The time when Emacs started being idle. */
596 static EMACS_TIME timer_idleness_start_time
;
598 /* After Emacs stops being idle, this saves the last value
599 of timer_idleness_start_time from when it was idle. */
601 static EMACS_TIME timer_last_idleness_start_time
;
603 /* If non-nil, events produced by disabled menu items and tool-bar
604 buttons are not ignored. Help functions bind this to allow help on
605 those items and buttons. */
606 Lisp_Object Venable_disabled_menus_and_buttons
;
609 /* Global variable declarations. */
611 /* Flags for readable_events. */
612 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
613 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
614 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
616 /* Function for init_keyboard to call with no args (if nonzero). */
617 void (*keyboard_init_hook
) ();
619 static int read_avail_input
P_ ((int));
620 static void get_input_pending
P_ ((int *, int));
621 static int readable_events
P_ ((int));
622 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
623 Lisp_Object
, int *));
624 static Lisp_Object
read_char_x_menu_prompt ();
625 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
627 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
628 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
629 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
630 enum scroll_bar_part
,
631 Lisp_Object
, Lisp_Object
,
634 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
635 Lisp_Object
, char **,
636 Lisp_Object
*, unsigned));
637 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
638 static int parse_solitary_modifier
P_ ((Lisp_Object
));
639 static int parse_solitary_modifier ();
640 static void save_getcjmp
P_ ((jmp_buf));
641 static void save_getcjmp ();
642 static void restore_getcjmp
P_ ((jmp_buf));
643 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
644 static void clear_event
P_ ((struct input_event
*));
646 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
648 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
649 static void handle_interrupt
P_ ((void));
650 static void timer_start_idle
P_ ((void));
651 static void timer_stop_idle
P_ ((void));
652 static void timer_resume_idle
P_ ((void));
653 static SIGTYPE handle_user_signal
P_ ((int));
654 static char *find_user_signal_name
P_ ((int));
655 static int store_user_signal_events
P_ ((void));
657 /* Nonzero means don't try to suspend even if the operating system seems
659 static int cannot_suspend
;
661 extern Lisp_Object Qidentity
, Qonly
;
663 /* Install the string STR as the beginning of the string of echoing,
664 so that it serves as a prompt for the next character.
665 Also start echoing. */
671 current_kboard
->echo_string
= str
;
672 current_kboard
->echo_after_prompt
= SCHARS (str
);
676 /* Add C to the echo string, if echoing is going on.
677 C can be a character, which is printed prettily ("M-C-x" and all that
678 jazz), or a symbol, whose name is printed. */
684 if (current_kboard
->immediate_echo
)
686 int size
= KEY_DESCRIPTION_SIZE
+ 100;
687 char *buffer
= (char *) alloca (size
);
689 Lisp_Object echo_string
;
691 echo_string
= current_kboard
->echo_string
;
693 /* If someone has passed us a composite event, use its head symbol. */
698 ptr
= push_key_description (XINT (c
), ptr
, 1);
700 else if (SYMBOLP (c
))
702 Lisp_Object name
= SYMBOL_NAME (c
);
703 int nbytes
= SBYTES (name
);
705 if (size
- (ptr
- buffer
) < nbytes
)
707 int offset
= ptr
- buffer
;
708 size
= max (2 * size
, size
+ nbytes
);
709 buffer
= (char *) alloca (size
);
710 ptr
= buffer
+ offset
;
713 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
714 STRING_MULTIBYTE (name
), 1);
717 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
720 const char *text
= " (Type ? for further options)";
721 int len
= strlen (text
);
723 if (size
- (ptr
- buffer
) < len
)
725 int offset
= ptr
- buffer
;
727 buffer
= (char *) alloca (size
);
728 ptr
= buffer
+ offset
;
731 bcopy (text
, ptr
, len
);
735 /* Replace a dash from echo_dash with a space, otherwise
736 add a space at the end as a separator between keys. */
737 if (STRINGP (echo_string
)
738 && SCHARS (echo_string
) > 1)
740 Lisp_Object last_char
, prev_char
, idx
;
742 idx
= make_number (SCHARS (echo_string
) - 2);
743 prev_char
= Faref (echo_string
, idx
);
745 idx
= make_number (SCHARS (echo_string
) - 1);
746 last_char
= Faref (echo_string
, idx
);
748 /* We test PREV_CHAR to make sure this isn't the echoing
750 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
751 Faset (echo_string
, idx
, make_number (' '));
753 echo_string
= concat2 (echo_string
, build_string (" "));
755 else if (STRINGP (echo_string
))
756 echo_string
= concat2 (echo_string
, build_string (" "));
758 current_kboard
->echo_string
759 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
765 /* Temporarily add a dash to the end of the echo string if it's not
766 empty, so that it serves as a mini-prompt for the very next character. */
771 /* Do nothing if not echoing at all. */
772 if (NILP (current_kboard
->echo_string
))
775 if (!current_kboard
->immediate_echo
776 && SCHARS (current_kboard
->echo_string
) == 0)
779 /* Do nothing if we just printed a prompt. */
780 if (current_kboard
->echo_after_prompt
781 == SCHARS (current_kboard
->echo_string
))
784 /* Do nothing if we have already put a dash at the end. */
785 if (SCHARS (current_kboard
->echo_string
) > 1)
787 Lisp_Object last_char
, prev_char
, idx
;
789 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
790 prev_char
= Faref (current_kboard
->echo_string
, idx
);
792 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
793 last_char
= Faref (current_kboard
->echo_string
, idx
);
795 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
799 /* Put a dash at the end of the buffer temporarily,
800 but make it go away when the next character is added. */
801 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
806 /* Display the current echo string, and begin echoing if not already
812 if (!current_kboard
->immediate_echo
)
815 current_kboard
->immediate_echo
= 1;
817 for (i
= 0; i
< this_command_key_count
; i
++)
821 /* Set before_command_echo_length to the value that would
822 have been saved before the start of this subcommand in
823 command_loop_1, if we had already been echoing then. */
824 if (i
== this_single_command_key_start
)
825 before_command_echo_length
= echo_length ();
827 c
= XVECTOR (this_command_keys
)->contents
[i
];
828 if (! (EVENT_HAS_PARAMETERS (c
)
829 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
833 /* Set before_command_echo_length to the value that would
834 have been saved before the start of this subcommand in
835 command_loop_1, if we had already been echoing then. */
836 if (this_command_key_count
== this_single_command_key_start
)
837 before_command_echo_length
= echo_length ();
839 /* Put a dash at the end to invite the user to type more. */
844 message3_nolog (current_kboard
->echo_string
,
845 SBYTES (current_kboard
->echo_string
),
846 STRING_MULTIBYTE (current_kboard
->echo_string
));
849 /* Record in what buffer we echoed, and from which kboard. */
850 echo_message_buffer
= echo_area_buffer
[0];
851 echo_kboard
= current_kboard
;
853 if (waiting_for_input
&& !NILP (Vquit_flag
))
854 quit_throw_to_read_char ();
857 /* Turn off echoing, for the start of a new command. */
862 current_kboard
->immediate_echo
= 0;
863 current_kboard
->echo_after_prompt
= -1;
864 current_kboard
->echo_string
= Qnil
;
865 ok_to_echo_at_next_pause
= NULL
;
867 echo_message_buffer
= Qnil
;
870 /* Return the length of the current echo string. */
875 return (STRINGP (current_kboard
->echo_string
)
876 ? SCHARS (current_kboard
->echo_string
)
880 /* Truncate the current echo message to its first LEN chars.
881 This and echo_char get used by read_key_sequence when the user
882 switches frames while entering a key sequence. */
885 echo_truncate (nchars
)
888 if (STRINGP (current_kboard
->echo_string
))
889 current_kboard
->echo_string
890 = Fsubstring (current_kboard
->echo_string
,
891 make_number (0), make_number (nchars
));
892 truncate_echo_area (nchars
);
896 /* Functions for manipulating this_command_keys. */
898 add_command_key (key
)
901 #if 0 /* Not needed after we made Freset_this_command_lengths
902 do the job immediately. */
903 /* If reset-this-command-length was called recently, obey it now.
904 See the doc string of that function for an explanation of why. */
905 if (before_command_restore_flag
)
907 this_command_key_count
= before_command_key_count_1
;
908 if (this_command_key_count
< this_single_command_key_start
)
909 this_single_command_key_start
= this_command_key_count
;
910 echo_truncate (before_command_echo_length_1
);
911 before_command_restore_flag
= 0;
915 if (this_command_key_count
>= ASIZE (this_command_keys
))
916 this_command_keys
= larger_vector (this_command_keys
,
917 2 * ASIZE (this_command_keys
),
920 ASET (this_command_keys
, this_command_key_count
, key
);
921 ++this_command_key_count
;
928 int count
= SPECPDL_INDEX ();
931 if (command_loop_level
> 0)
933 specbind (Qstandard_output
, Qt
);
934 specbind (Qstandard_input
, Qt
);
937 #ifdef HAVE_WINDOW_SYSTEM
938 /* The command loop has started an hourglass timer, so we have to
939 cancel it here, otherwise it will fire because the recursive edit
940 can take some time. Do not check for display_hourglass_p here,
941 because it could already be nil. */
945 /* This function may have been called from a debugger called from
946 within redisplay, for instance by Edebugging a function called
947 from fontification-functions. We want to allow redisplay in
948 the debugging session.
950 The recursive edit is left with a `(throw exit ...)'. The `exit'
951 tag is not caught anywhere in redisplay, i.e. when we leave the
952 recursive edit, the original redisplay leading to the recursive
953 edit will be unwound. The outcome should therefore be safe. */
954 specbind (Qinhibit_redisplay
, Qnil
);
957 val
= command_loop ();
959 Fsignal (Qquit
, Qnil
);
960 /* Handle throw from read_minibuf when using minibuffer
961 while it's active but we're in another window. */
963 xsignal1 (Qerror
, val
);
965 return unbind_to (count
, Qnil
);
968 /* When an auto-save happens, record the "time", and don't do again soon. */
973 last_auto_save
= num_nonmacro_input_events
;
976 /* Make an auto save happen as soon as possible at command level. */
979 force_auto_save_soon ()
981 last_auto_save
= - auto_save_interval
- 1;
983 record_asynch_buffer_change ();
986 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
987 doc
: /* Invoke the editor command loop recursively.
988 To get out of the recursive edit, a command can do `(throw 'exit nil)';
989 that tells this function to return.
990 Alternatively, `(throw 'exit t)' makes this function signal an error.
991 This function is called by the editor initialization to begin editing. */)
994 int count
= SPECPDL_INDEX ();
997 /* If we enter while input is blocked, don't lock up here.
998 This may happen through the debugger during redisplay. */
1002 command_loop_level
++;
1003 update_mode_lines
= 1;
1005 if (command_loop_level
1006 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1007 buffer
= Fcurrent_buffer ();
1011 /* If we leave recursive_edit_1 below with a `throw' for instance,
1012 like it is done in the splash screen display, we have to
1013 make sure that we restore single_kboard as command_loop_1
1014 would have done if it were left normally. */
1015 if (command_loop_level
> 0)
1016 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1017 record_unwind_protect (recursive_edit_unwind
, buffer
);
1019 recursive_edit_1 ();
1020 return unbind_to (count
, Qnil
);
1024 recursive_edit_unwind (buffer
)
1027 if (BUFFERP (buffer
))
1028 Fset_buffer (buffer
);
1030 command_loop_level
--;
1031 update_mode_lines
= 1;
1036 #if 0 /* These two functions are now replaced with
1037 temporarily_switch_to_single_kboard. */
1042 #if 0 /* Theory: if there's anything in Vunread_command_events,
1043 it will right away be read by read_key_sequence,
1044 and then if we do switch KBOARDS, it will go into the side
1045 queue then. So we don't need to do anything special here -- rms. */
1046 if (CONSP (Vunread_command_events
))
1048 current_kboard
->kbd_queue
1049 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1050 current_kboard
->kbd_queue_has_data
= 1;
1052 Vunread_command_events
= Qnil
;
1058 /* Switch to the single-kboard state, making current_kboard
1059 the only KBOARD from which further input is accepted. */
1062 single_kboard_state ()
1070 /* If we're in single_kboard state for kboard KBOARD,
1074 not_single_kboard_state (kboard
)
1078 if (kboard
== current_kboard
)
1083 /* Maintain a stack of kboards, so other parts of Emacs
1084 can switch temporarily to the kboard of a given frame
1085 and then revert to the previous status. */
1090 struct kboard_stack
*next
;
1093 static struct kboard_stack
*kboard_stack
;
1100 struct kboard_stack
*p
1101 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1103 p
->next
= kboard_stack
;
1104 p
->kboard
= current_kboard
;
1116 struct kboard_stack
*p
= kboard_stack
;
1118 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1120 if (t
->kboard
== p
->kboard
)
1122 current_kboard
= p
->kboard
;
1129 /* The terminal we remembered has been deleted. */
1130 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1133 kboard_stack
= p
->next
;
1138 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1139 from which further input is accepted. If F is non-nil, set its
1140 KBOARD as the current keyboard.
1142 This function uses record_unwind_protect to return to the previous
1145 If Emacs is already in single_kboard mode, and F's keyboard is
1146 locked, then this function will throw an errow. */
1149 temporarily_switch_to_single_kboard (f
)
1153 int was_locked
= single_kboard
;
1156 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1157 /* We can not switch keyboards while in single_kboard mode.
1158 In rare cases, Lisp code may call `recursive-edit' (or
1159 `read-minibuffer' or `y-or-n-p') after it switched to a
1160 locked frame. For example, this is likely to happen
1161 when server.el connects to a new terminal while Emacs is in
1162 single_kboard mode. It is best to throw an error instead
1163 of presenting the user with a frozen screen. */
1164 error ("Terminal %d is locked, cannot read from it",
1165 FRAME_TERMINAL (f
)->id
);
1167 /* This call is unnecessary, but helps
1168 `restore_kboard_configuration' discover if somebody changed
1169 `current_kboard' behind our back. */
1170 push_kboard (current_kboard
);
1173 current_kboard
= FRAME_KBOARD (f
);
1175 record_unwind_protect (restore_kboard_configuration
,
1176 (was_locked
? Qt
: Qnil
));
1180 #if 0 /* This function is not needed anymore. */
1182 record_single_kboard_state ()
1185 push_kboard (current_kboard
);
1186 record_unwind_protect (restore_kboard_configuration
,
1187 (single_kboard
? Qt
: Qnil
));
1193 restore_kboard_configuration (was_locked
)
1194 Lisp_Object was_locked
;
1196 if (NILP (was_locked
))
1200 struct kboard
*prev
= current_kboard
;
1203 /* The pop should not change the kboard. */
1204 if (single_kboard
&& current_kboard
!= prev
)
1212 /* Handle errors that are not handled at inner levels
1213 by printing an error message and returning to the editor command loop. */
1219 Lisp_Object old_level
, old_length
;
1220 char macroerror
[50];
1222 #ifdef HAVE_WINDOW_SYSTEM
1223 if (display_hourglass_p
)
1224 cancel_hourglass ();
1227 if (!NILP (executing_kbd_macro
))
1229 if (executing_kbd_macro_iterations
== 1)
1230 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1232 sprintf (macroerror
, "After %d kbd macro iterations: ",
1233 executing_kbd_macro_iterations
);
1238 Vstandard_output
= Qt
;
1239 Vstandard_input
= Qt
;
1240 Vexecuting_kbd_macro
= Qnil
;
1241 executing_kbd_macro
= Qnil
;
1242 current_kboard
->Vprefix_arg
= Qnil
;
1243 current_kboard
->Vlast_prefix_arg
= Qnil
;
1246 /* Avoid unquittable loop if data contains a circular list. */
1247 old_level
= Vprint_level
;
1248 old_length
= Vprint_length
;
1249 XSETFASTINT (Vprint_level
, 10);
1250 XSETFASTINT (Vprint_length
, 10);
1251 cmd_error_internal (data
, macroerror
);
1252 Vprint_level
= old_level
;
1253 Vprint_length
= old_length
;
1257 Vinhibit_quit
= Qnil
;
1258 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1260 if (command_loop_level
== 0 && minibuf_level
== 0)
1261 any_kboard_state ();
1265 return make_number (0);
1268 /* Take actions on handling an error. DATA is the data that describes
1271 CONTEXT is a C-string containing ASCII characters only which
1272 describes the context in which the error happened. If we need to
1273 generalize CONTEXT to allow multibyte characters, make it a Lisp
1277 cmd_error_internal (data
, context
)
1281 struct frame
*sf
= SELECTED_FRAME ();
1283 /* The immediate context is not interesting for Quits,
1284 since they are asyncronous. */
1285 if (EQ (XCAR (data
), Qquit
))
1286 Vsignaling_function
= Qnil
;
1291 /* Use user's specified output function if any. */
1292 if (!NILP (Vcommand_error_function
))
1293 call3 (Vcommand_error_function
, data
,
1294 context
? build_string (context
) : empty_unibyte_string
,
1295 Vsignaling_function
);
1296 /* If the window system or terminal frame hasn't been initialized
1297 yet, or we're not interactive, write the message to stderr and exit. */
1298 else if (!sf
->glyphs_initialized_p
1299 || FRAME_INITIAL_P (sf
)
1302 print_error_message (data
, Qexternal_debugging_output
,
1303 context
, Vsignaling_function
);
1304 Fterpri (Qexternal_debugging_output
);
1305 Fkill_emacs (make_number (-1));
1309 clear_message (1, 0);
1311 message_log_maybe_newline ();
1314 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1317 Vsignaling_function
= Qnil
;
1320 Lisp_Object
command_loop_1 ();
1321 Lisp_Object
command_loop_2 ();
1322 Lisp_Object
top_level_1 ();
1324 /* Entry to editor-command-loop.
1325 This level has the catches for exiting/returning to editor command loop.
1326 It returns nil to exit recursive edit, t to abort it. */
1331 if (command_loop_level
> 0 || minibuf_level
> 0)
1334 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1335 executing_kbd_macro
= Qnil
;
1341 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1342 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1343 /* Reset single_kboard in case top-level set it while
1344 evaluating an -f option, or we are stuck there for some
1346 any_kboard_state ();
1348 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1349 executing_kbd_macro
= Qnil
;
1351 /* End of file in -batch run causes exit here. */
1357 /* Here we catch errors in execution of commands within the
1358 editing loop, and reenter the editing loop.
1359 When there is an error, cmd_error runs and returns a non-nil
1360 value to us. A value of nil means that command_loop_1 itself
1361 returned due to end of file (or end of kbd macro). */
1366 register Lisp_Object val
;
1369 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1370 while (!NILP (val
));
1378 return Feval (Vtop_level
);
1384 /* On entry to the outer level, run the startup file */
1385 if (!NILP (Vtop_level
))
1386 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1387 else if (!NILP (Vpurify_flag
))
1388 message ("Bare impure Emacs (standard Lisp code not loaded)");
1390 message ("Bare Emacs (standard Lisp code not loaded)");
1394 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1395 doc
: /* Exit all recursive editing levels. */)
1398 #ifdef HAVE_WINDOW_SYSTEM
1399 if (display_hourglass_p
)
1400 cancel_hourglass ();
1403 /* Unblock input if we enter with input blocked. This may happen if
1404 redisplay traps e.g. during tool-bar update with input blocked. */
1405 while (INPUT_BLOCKED_P
)
1408 return Fthrow (Qtop_level
, Qnil
);
1411 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1412 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1415 if (command_loop_level
> 0 || minibuf_level
> 0)
1416 Fthrow (Qexit
, Qnil
);
1418 error ("No recursive edit is in progress");
1422 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1423 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1426 if (command_loop_level
> 0 || minibuf_level
> 0)
1429 error ("No recursive edit is in progress");
1433 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1435 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1436 of this function. */
1439 tracking_off (old_value
)
1440 Lisp_Object old_value
;
1442 do_mouse_tracking
= old_value
;
1443 if (NILP (old_value
))
1445 /* Redisplay may have been preempted because there was input
1446 available, and it assumes it will be called again after the
1447 input has been processed. If the only input available was
1448 the sort that we have just disabled, then we need to call
1450 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1452 redisplay_preserve_echo_area (6);
1453 get_input_pending (&input_pending
,
1454 READABLE_EVENTS_DO_TIMERS_NOW
);
1460 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1461 doc
: /* Evaluate BODY with mouse movement events enabled.
1462 Within a `track-mouse' form, mouse motion generates input events that
1463 you can read with `read-event'.
1464 Normally, mouse motion is ignored.
1465 usage: (track-mouse BODY...) */)
1469 int count
= SPECPDL_INDEX ();
1472 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1474 do_mouse_tracking
= Qt
;
1476 val
= Fprogn (args
);
1477 return unbind_to (count
, val
);
1480 /* If mouse has moved on some frame, return one of those frames.
1484 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1485 after resizing the tool-bar window. */
1487 int ignore_mouse_drag_p
;
1492 Lisp_Object tail
, frame
;
1494 if (ignore_mouse_drag_p
)
1496 /* ignore_mouse_drag_p = 0; */
1500 FOR_EACH_FRAME (tail
, frame
)
1502 if (XFRAME (frame
)->mouse_moved
)
1503 return XFRAME (frame
);
1509 #endif /* HAVE_MOUSE || HAVE_GPM */
1511 /* This is the actual command reading loop,
1512 sans error-handling encapsulation. */
1514 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1516 void safe_run_hooks
P_ ((Lisp_Object
));
1517 static void adjust_point_for_property
P_ ((int, int));
1519 /* Cancel hourglass from protect_unwind.
1521 #ifdef HAVE_WINDOW_SYSTEM
1523 cancel_hourglass_unwind (arg
)
1526 cancel_hourglass ();
1537 Lisp_Object keybuf
[30];
1539 int prev_modiff
= 0;
1540 struct buffer
*prev_buffer
= NULL
;
1541 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1543 int was_locked
= single_kboard
;
1546 int already_adjusted
= 0;
1548 current_kboard
->Vprefix_arg
= Qnil
;
1549 current_kboard
->Vlast_prefix_arg
= Qnil
;
1550 Vdeactivate_mark
= Qnil
;
1551 waiting_for_input
= 0;
1555 this_command_key_count
= 0;
1556 this_command_key_count_reset
= 0;
1557 this_single_command_key_start
= 0;
1559 if (NILP (Vmemory_full
))
1561 /* Make sure this hook runs after commands that get errors and
1562 throw to top level. */
1563 /* Note that the value cell will never directly contain nil
1564 if the symbol is a local variable. */
1565 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1566 safe_run_hooks (Qpost_command_hook
);
1568 /* If displaying a message, resize the echo area window to fit
1569 that message's size exactly. */
1570 if (!NILP (echo_area_buffer
[0]))
1571 resize_echo_area_exactly ();
1573 if (!NILP (Vdeferred_action_list
))
1574 safe_run_hooks (Qdeferred_action_function
);
1577 /* Do this after running Vpost_command_hook, for consistency. */
1578 current_kboard
->Vlast_command
= Vthis_command
;
1579 current_kboard
->Vreal_last_command
= real_this_command
;
1580 if (!CONSP (last_command_char
))
1581 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1585 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1588 /* Make sure the current window's buffer is selected. */
1589 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1590 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1592 /* Display any malloc warning that just came out. Use while because
1593 displaying one warning can cause another. */
1595 while (pending_malloc_warning
)
1596 display_malloc_warning ();
1598 Vdeactivate_mark
= Qnil
;
1600 /* If minibuffer on and echo area in use,
1601 wait a short time and redraw minibuffer. */
1604 && !NILP (echo_area_buffer
[0])
1605 && EQ (minibuf_window
, echo_area_window
)
1606 && NUMBERP (Vminibuffer_message_timeout
))
1608 /* Bind inhibit-quit to t so that C-g gets read in
1609 rather than quitting back to the minibuffer. */
1610 int count
= SPECPDL_INDEX ();
1611 specbind (Qinhibit_quit
, Qt
);
1613 sit_for (Vminibuffer_message_timeout
, 0, 2);
1615 /* Clear the echo area. */
1617 safe_run_hooks (Qecho_area_clear_hook
);
1619 unbind_to (count
, Qnil
);
1621 /* If a C-g came in before, treat it as input now. */
1622 if (!NILP (Vquit_flag
))
1625 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1630 /* Select the frame that the last event came from. Usually,
1631 switch-frame events will take care of this, but if some lisp
1632 code swallows a switch-frame event, we'll fix things up here.
1633 Is this a good idea? */
1634 if (FRAMEP (internal_last_event_frame
)
1635 && !EQ (internal_last_event_frame
, selected_frame
))
1636 Fselect_frame (internal_last_event_frame
);
1638 /* If it has changed current-menubar from previous value,
1639 really recompute the menubar from the value. */
1640 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1641 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1642 call0 (Qrecompute_lucid_menubar
);
1644 before_command_key_count
= this_command_key_count
;
1645 before_command_echo_length
= echo_length ();
1647 Vthis_command
= Qnil
;
1648 real_this_command
= Qnil
;
1649 Vthis_original_command
= Qnil
;
1650 Vthis_command_keys_shift_translated
= Qnil
;
1652 /* Read next key sequence; i gets its length. */
1653 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1656 /* A filter may have run while we were reading the input. */
1657 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1659 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1660 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1664 /* Now we have read a key sequence of length I,
1665 or else I is 0 and we found end of file. */
1667 if (i
== 0) /* End of file -- happens only in */
1668 return Qnil
; /* a kbd macro, at the end. */
1669 /* -1 means read_key_sequence got a menu that was rejected.
1670 Just loop around and read another command. */
1674 this_command_key_count
= 0;
1675 this_command_key_count_reset
= 0;
1676 this_single_command_key_start
= 0;
1680 last_command_char
= keybuf
[i
- 1];
1682 /* If the previous command tried to force a specific window-start,
1683 forget about that, in case this command moves point far away
1684 from that position. But also throw away beg_unchanged and
1685 end_unchanged information in that case, so that redisplay will
1686 update the whole window properly. */
1687 if (!NILP (XWINDOW (selected_window
)->force_start
))
1690 XWINDOW (selected_window
)->force_start
= Qnil
;
1691 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1692 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1695 cmd
= read_key_sequence_cmd
;
1696 if (!NILP (Vexecuting_kbd_macro
))
1698 if (!NILP (Vquit_flag
))
1700 Vexecuting_kbd_macro
= Qt
;
1701 QUIT
; /* Make some noise. */
1702 /* Will return since macro now empty. */
1706 /* Do redisplay processing after this command except in special
1707 cases identified below. */
1708 prev_buffer
= current_buffer
;
1709 prev_modiff
= MODIFF
;
1710 last_point_position
= PT
;
1711 last_point_position_window
= selected_window
;
1712 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1714 /* By default, we adjust point to a boundary of a region that
1715 has such a property that should be treated intangible
1716 (e.g. composition, display). But, some commands will set
1717 this variable differently. */
1718 Vdisable_point_adjustment
= Qnil
;
1720 /* Process filters and timers may have messed with deactivate-mark.
1721 reset it before we execute the command. */
1722 Vdeactivate_mark
= Qnil
;
1724 /* Remap command through active keymaps */
1725 Vthis_original_command
= cmd
;
1729 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1733 /* Execute the command. */
1735 Vthis_command
= cmd
;
1736 real_this_command
= cmd
;
1737 /* Note that the value cell will never directly contain nil
1738 if the symbol is a local variable. */
1739 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1740 safe_run_hooks (Qpre_command_hook
);
1742 already_adjusted
= 0;
1744 if (NILP (Vthis_command
))
1746 /* nil means key is undefined. */
1747 Lisp_Object keys
= Fvector (i
, keybuf
);
1748 keys
= Fkey_description (keys
, Qnil
);
1750 message_with_string ("%s is undefined", keys
, 0);
1751 current_kboard
->defining_kbd_macro
= Qnil
;
1752 update_mode_lines
= 1;
1753 current_kboard
->Vprefix_arg
= Qnil
;
1757 if (NILP (current_kboard
->Vprefix_arg
))
1759 /* In case we jump to directly_done. */
1760 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1762 /* Recognize some common commands in common situations and
1763 do them directly. */
1764 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
1765 && NILP (Vthis_command_keys_shift_translated
)
1766 && !CONSP (Vtransient_mark_mode
))
1768 struct Lisp_Char_Table
*dp
1769 = window_display_table (XWINDOW (selected_window
));
1770 lose
= FETCH_CHAR (PT_BYTE
);
1772 if (! NILP (Vpost_command_hook
))
1773 /* Put this before calling adjust_point_for_property
1774 so it will only get called once in any case. */
1776 if (current_buffer
== prev_buffer
1777 && last_point_position
!= PT
1778 && NILP (Vdisable_point_adjustment
)
1779 && NILP (Vglobal_disable_point_adjustment
))
1780 adjust_point_for_property (last_point_position
, 0);
1781 already_adjusted
= 1;
1782 if (PT
== last_point_position
+ 1
1784 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1785 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1786 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1787 && (lose
>= 0x20 && lose
< 0x7f)))
1788 : (lose
>= 0x20 && lose
< 0x7f))
1789 /* To extract the case of continuation on
1790 wide-column characters. */
1791 && ASCII_BYTE_P (lose
)
1792 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1794 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1796 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1798 && !windows_or_buffers_changed
1799 && EQ (current_buffer
->selective_display
, Qnil
)
1800 && !detect_input_pending ()
1801 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1802 && NILP (Vexecuting_kbd_macro
))
1803 direct_output_forward_char (1);
1806 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
1807 && NILP (Vthis_command_keys_shift_translated
)
1808 && !CONSP (Vtransient_mark_mode
))
1810 struct Lisp_Char_Table
*dp
1811 = window_display_table (XWINDOW (selected_window
));
1813 lose
= FETCH_CHAR (PT_BYTE
);
1814 if (! NILP (Vpost_command_hook
))
1816 if (current_buffer
== prev_buffer
1817 && last_point_position
!= PT
1818 && NILP (Vdisable_point_adjustment
)
1819 && NILP (Vglobal_disable_point_adjustment
))
1820 adjust_point_for_property (last_point_position
, 0);
1821 already_adjusted
= 1;
1822 if (PT
== last_point_position
- 1
1824 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1825 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1826 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1827 && (lose
>= 0x20 && lose
< 0x7f)))
1828 : (lose
>= 0x20 && lose
< 0x7f))
1829 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1831 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1833 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1835 && !windows_or_buffers_changed
1836 && EQ (current_buffer
->selective_display
, Qnil
)
1837 && !detect_input_pending ()
1838 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1839 && NILP (Vexecuting_kbd_macro
))
1840 direct_output_forward_char (-1);
1843 else if (EQ (Vthis_command
, Qself_insert_command
)
1844 /* Try this optimization only on char keystrokes. */
1845 && NATNUMP (last_command_char
)
1846 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1849 = translate_char (Vtranslation_table_for_input
,
1850 XFASTINT (last_command_char
));
1852 if (NILP (Vexecuting_kbd_macro
)
1853 && !EQ (minibuf_window
, selected_window
))
1855 if (!nonundocount
|| nonundocount
>= 20)
1863 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1865 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1867 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1869 || MODIFF
<= SAVE_MODIFF
1870 || windows_or_buffers_changed
1871 || !EQ (current_buffer
->selective_display
, Qnil
)
1872 || detect_input_pending ()
1873 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1874 || !NILP (Vexecuting_kbd_macro
));
1876 value
= internal_self_insert (c
, 0);
1881 if (! NILP (Vpost_command_hook
))
1882 /* Put this before calling adjust_point_for_property
1883 so it will only get called once in any case. */
1886 /* VALUE == 1 when AFTER-CHANGE functions are
1887 installed which is the case most of the time
1888 because FONT-LOCK installs one. */
1889 if (!lose
&& !value
)
1890 direct_output_for_insert (c
);
1895 /* Here for a command that isn't executed directly */
1898 #ifdef HAVE_WINDOW_SYSTEM
1899 int scount
= SPECPDL_INDEX ();
1901 if (display_hourglass_p
1902 && NILP (Vexecuting_kbd_macro
))
1904 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1910 if (NILP (current_kboard
->Vprefix_arg
))
1912 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1914 #ifdef HAVE_WINDOW_SYSTEM
1915 /* Do not check display_hourglass_p here, because
1916 Fcommand_execute could change it, but we should cancel
1917 hourglass cursor anyway.
1918 But don't cancel the hourglass within a macro
1919 just because a command in the macro finishes. */
1920 if (NILP (Vexecuting_kbd_macro
))
1921 unbind_to (scount
, Qnil
);
1926 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1928 /* Note that the value cell will never directly contain nil
1929 if the symbol is a local variable. */
1930 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1931 safe_run_hooks (Qpost_command_hook
);
1933 /* If displaying a message, resize the echo area window to fit
1934 that message's size exactly. */
1935 if (!NILP (echo_area_buffer
[0]))
1936 resize_echo_area_exactly ();
1938 if (!NILP (Vdeferred_action_list
))
1939 safe_run_hooks (Qdeferred_action_function
);
1941 /* If there is a prefix argument,
1942 1) We don't want Vlast_command to be ``universal-argument''
1943 (that would be dumb), so don't set Vlast_command,
1944 2) we want to leave echoing on so that the prefix will be
1945 echoed as part of this key sequence, so don't call
1947 3) we want to leave this_command_key_count non-zero, so that
1948 read_char will realize that it is re-reading a character, and
1949 not echo it a second time.
1951 If the command didn't actually create a prefix arg,
1952 but is merely a frame event that is transparent to prefix args,
1953 then the above doesn't apply. */
1954 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1956 current_kboard
->Vlast_command
= Vthis_command
;
1957 current_kboard
->Vreal_last_command
= real_this_command
;
1958 if (!CONSP (last_command_char
))
1959 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1961 this_command_key_count
= 0;
1962 this_command_key_count_reset
= 0;
1963 this_single_command_key_start
= 0;
1966 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1968 /* In Emacs 22, setting transient-mark-mode to `only' was a
1969 way of turning it on for just one command. This usage is
1970 obsolete, but support it anyway. */
1971 if (EQ (Vtransient_mark_mode
, Qidentity
))
1972 Vtransient_mark_mode
= Qnil
;
1973 else if (EQ (Vtransient_mark_mode
, Qonly
))
1974 Vtransient_mark_mode
= Qidentity
;
1976 if (!NILP (Vdeactivate_mark
))
1977 call0 (Qdeactivate_mark
);
1978 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1979 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1984 if (current_buffer
== prev_buffer
1985 && last_point_position
!= PT
1986 && NILP (Vdisable_point_adjustment
)
1987 && NILP (Vglobal_disable_point_adjustment
)
1988 && !already_adjusted
)
1989 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1991 /* Install chars successfully executed in kbd macro. */
1993 if (!NILP (current_kboard
->defining_kbd_macro
)
1994 && NILP (current_kboard
->Vprefix_arg
))
1995 finalize_kbd_macro_chars ();
1996 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1999 any_kboard_state ();
2005 extern Lisp_Object Qcomposition
, Qdisplay
;
2007 /* Adjust point to a boundary of a region that has such a property
2008 that should be treated intangible. For the moment, we check
2009 `composition', `display' and `invisible' properties.
2010 LAST_PT is the last position of point. */
2012 extern Lisp_Object Qafter_string
, Qbefore_string
;
2013 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2016 adjust_point_for_property (last_pt
, modified
)
2021 Lisp_Object val
, overlay
, tmp
;
2022 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
2025 /* FIXME: cycling is probably not necessary because these properties
2026 can't be usefully combined anyway. */
2027 while (check_composition
|| check_display
|| check_invisible
)
2029 /* FIXME: check `intangible'. */
2030 if (check_composition
2031 && PT
> BEGV
&& PT
< ZV
2032 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
2033 && COMPOSITION_VALID_P (beg
, end
, val
)
2034 && beg
< PT
/* && end > PT <- It's always the case. */
2035 && (last_pt
<= beg
|| last_pt
>= end
))
2038 SET_PT (PT
< last_pt
? beg
: end
);
2039 check_display
= check_invisible
= 1;
2041 check_composition
= 0;
2043 && PT
> BEGV
&& PT
< ZV
2044 && !NILP (val
= get_char_property_and_overlay
2045 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
2046 && display_prop_intangible_p (val
)
2047 && (!OVERLAYP (overlay
)
2048 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
2049 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
2050 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
2051 && (beg
< PT
/* && end > PT <- It's always the case. */
2052 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
2055 SET_PT (PT
< last_pt
2056 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
2058 check_composition
= check_invisible
= 1;
2061 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
2063 int inv
, ellipsis
= 0;
2066 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2068 && !NILP (val
= get_char_property_and_overlay
2069 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
2070 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2072 ellipsis
= ellipsis
|| inv
> 1
2073 || (OVERLAYP (overlay
)
2074 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2075 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2076 tmp
= Fnext_single_char_property_change
2077 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
2078 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
2081 && !NILP (val
= get_char_property_and_overlay
2082 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
2083 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2085 ellipsis
= ellipsis
|| inv
> 1
2086 || (OVERLAYP (overlay
)
2087 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2088 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2089 tmp
= Fprevious_single_char_property_change
2090 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2091 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2094 /* Move away from the inside area. */
2095 if (beg
< PT
&& end
> PT
)
2097 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2098 /* We haven't moved yet (so we don't need to fear
2099 infinite-looping) and we were outside the range
2100 before (so either end of the range still corresponds
2101 to a move in the right direction): pretend we moved
2102 less than we actually did, so that we still have
2103 more freedom below in choosing which end of the range
2105 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2106 /* We either have moved already or the last point
2107 was already in the range: we don't get to choose
2108 which end of the range we have to go to. */
2109 : (PT
< last_pt
? beg
: end
));
2110 check_composition
= check_display
= 1;
2112 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2113 the point to something other than its argument, due to
2114 point-motion hooks, intangibility, etc. */
2115 xassert (PT
== beg
|| PT
== end
);
2118 /* Pretend the area doesn't exist if the buffer is not
2120 if (!modified
&& !ellipsis
&& beg
< end
)
2122 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2123 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2124 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2125 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2126 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2127 /* We've already moved as far as we can. Trying to go
2128 to the other end would mean moving backwards and thus
2129 could lead to an infinite loop. */
2131 else if (val
= get_pos_property (make_number (PT
),
2133 TEXT_PROP_MEANS_INVISIBLE (val
)
2134 && (val
= get_pos_property
2135 (make_number (PT
== beg
? end
: beg
),
2137 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2138 (check_composition
= check_display
= 1,
2139 SET_PT (PT
== beg
? end
: beg
));
2142 check_invisible
= 0;
2146 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2149 safe_run_hooks_1 (hook
)
2152 if (NILP (Vrun_hooks
))
2154 return call1 (Vrun_hooks
, Vinhibit_quit
);
2157 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2160 safe_run_hooks_error (data
)
2163 Lisp_Object args
[3];
2164 args
[0] = build_string ("Error in %s: %s");
2165 args
[1] = Vinhibit_quit
;
2168 return Fset (Vinhibit_quit
, Qnil
);
2171 /* If we get an error while running the hook, cause the hook variable
2172 to be nil. Also inhibit quits, so that C-g won't cause the hook
2173 to mysteriously evaporate. */
2176 safe_run_hooks (hook
)
2179 int count
= SPECPDL_INDEX ();
2180 specbind (Qinhibit_quit
, hook
);
2182 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2184 unbind_to (count
, Qnil
);
2188 /* Number of seconds between polling for input. This is a Lisp
2189 variable that can be bound. */
2191 EMACS_INT polling_period
;
2193 /* Nonzero means polling for input is temporarily suppressed. */
2195 int poll_suppress_count
;
2197 /* Asynchronous timer for polling. */
2199 struct atimer
*poll_timer
;
2202 #ifdef POLL_FOR_INPUT
2204 /* Poll for input, so what we catch a C-g if it comes in. This
2205 function is called from x_make_frame_visible, see comment
2211 if (interrupt_input_blocked
== 0
2212 && !waiting_for_input
)
2213 read_avail_input (0);
2216 /* Timer callback function for poll_timer. TIMER is equal to
2220 poll_for_input (timer
)
2221 struct atimer
*timer
;
2223 if (poll_suppress_count
== 0)
2225 interrupt_input_pending
= 1;
2227 poll_for_input_1 ();
2231 #endif /* POLL_FOR_INPUT */
2233 /* Begin signals to poll for input, if they are appropriate.
2234 This function is called unconditionally from various places. */
2239 #ifdef POLL_FOR_INPUT
2240 /* XXX This condition was (read_socket_hook && !interrupt_input),
2241 but read_socket_hook is not global anymore. Let's pretend that
2243 if (!interrupt_input
)
2245 /* Turn alarm handling on unconditionally. It might have
2246 been turned off in process.c. */
2247 turn_on_atimers (1);
2249 /* If poll timer doesn't exist, are we need one with
2250 a different interval, start a new one. */
2251 if (poll_timer
== NULL
2252 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2254 EMACS_TIME interval
;
2257 cancel_atimer (poll_timer
);
2259 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2260 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2261 poll_for_input
, NULL
);
2264 /* Let the timer's callback function poll for input
2265 if this becomes zero. */
2266 --poll_suppress_count
;
2271 /* Nonzero if we are using polling to handle input asynchronously. */
2274 input_polling_used ()
2276 #ifdef POLL_FOR_INPUT
2277 /* XXX This condition was (read_socket_hook && !interrupt_input),
2278 but read_socket_hook is not global anymore. Let's pretend that
2280 return !interrupt_input
;
2286 /* Turn off polling. */
2291 #ifdef POLL_FOR_INPUT
2292 /* XXX This condition was (read_socket_hook && !interrupt_input),
2293 but read_socket_hook is not global anymore. Let's pretend that
2295 if (!interrupt_input
)
2296 ++poll_suppress_count
;
2300 /* Set the value of poll_suppress_count to COUNT
2301 and start or stop polling accordingly. */
2304 set_poll_suppress_count (count
)
2307 #ifdef POLL_FOR_INPUT
2308 if (count
== 0 && poll_suppress_count
!= 0)
2310 poll_suppress_count
= 1;
2313 else if (count
!= 0 && poll_suppress_count
== 0)
2317 poll_suppress_count
= count
;
2321 /* Bind polling_period to a value at least N.
2322 But don't decrease it. */
2325 bind_polling_period (n
)
2328 #ifdef POLL_FOR_INPUT
2329 int new = polling_period
;
2334 stop_other_atimers (poll_timer
);
2336 specbind (Qpolling_period
, make_number (new));
2337 /* Start a new alarm with the new period. */
2342 /* Apply the control modifier to CHARACTER. */
2348 /* Save the upper bits here. */
2349 int upper
= c
& ~0177;
2351 if (! ASCII_BYTE_P (c
))
2352 return c
|= ctrl_modifier
;
2356 /* Everything in the columns containing the upper-case letters
2357 denotes a control character. */
2358 if (c
>= 0100 && c
< 0140)
2362 /* Set the shift modifier for a control char
2363 made from a shifted letter. But only for letters! */
2364 if (oc
>= 'A' && oc
<= 'Z')
2365 c
|= shift_modifier
;
2368 /* The lower-case letters denote control characters too. */
2369 else if (c
>= 'a' && c
<= 'z')
2372 /* Include the bits for control and shift
2373 only if the basic ASCII code can't indicate them. */
2377 /* Replace the high bits. */
2378 c
|= (upper
& ~ctrl_modifier
);
2383 /* Display the help-echo property of the character after the mouse pointer.
2384 Either show it in the echo area, or call show-help-function to display
2385 it by other means (maybe in a tooltip).
2387 If HELP is nil, that means clear the previous help echo.
2389 If HELP is a string, display that string. If HELP is a function,
2390 call it with OBJECT and POS as arguments; the function should
2391 return a help string or nil for none. For all other types of HELP,
2392 evaluate it to obtain a string.
2394 WINDOW is the window in which the help was generated, if any.
2395 It is nil if not in a window.
2397 If OBJECT is a buffer, POS is the position in the buffer where the
2398 `help-echo' text property was found.
2400 If OBJECT is an overlay, that overlay has a `help-echo' property,
2401 and POS is the position in the overlay's buffer under the mouse.
2403 If OBJECT is a string (an overlay string or a string displayed with
2404 the `display' property). POS is the position in that string under
2407 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2408 echo overwrites a keystroke echo currently displayed in the echo
2411 Note: this function may only be called with HELP nil or a string
2412 from X code running asynchronously. */
2415 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2416 Lisp_Object help
, window
, object
, pos
;
2417 int ok_to_overwrite_keystroke_echo
;
2419 if (!NILP (help
) && !STRINGP (help
))
2421 if (FUNCTIONP (help
))
2423 Lisp_Object args
[4];
2428 help
= safe_call (4, args
);
2431 help
= safe_eval (help
);
2433 if (!STRINGP (help
))
2437 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2438 if (!noninteractive
&& STRINGP (help
))
2440 /* The mouse-fixup-help-message Lisp function can call
2441 mouse_position_hook, which resets the mouse_moved flags.
2442 This causes trouble if we are trying to read a mouse motion
2443 event (i.e., if we are inside a `track-mouse' form), so we
2444 restore the mouse_moved flag. */
2445 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2446 help
= call1 (Qmouse_fixup_help_message
, help
);
2452 if (STRINGP (help
) || NILP (help
))
2454 if (!NILP (Vshow_help_function
))
2455 call1 (Vshow_help_function
, help
);
2456 help_echo_showing_p
= STRINGP (help
);
2462 /* Input of single characters from keyboard */
2464 Lisp_Object
print_help ();
2465 static Lisp_Object
kbd_buffer_get_event ();
2466 static void record_char ();
2468 static Lisp_Object help_form_saved_window_configs
;
2470 read_char_help_form_unwind (arg
)
2472 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2473 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2474 if (!NILP (window_config
))
2475 Fset_window_configuration (window_config
);
2479 #define STOP_POLLING \
2480 do { if (! polling_stopped_here) stop_polling (); \
2481 polling_stopped_here = 1; } while (0)
2483 #define RESUME_POLLING \
2484 do { if (polling_stopped_here) start_polling (); \
2485 polling_stopped_here = 0; } while (0)
2487 /* read a character from the keyboard; call the redisplay if needed */
2488 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2489 -1 means do not do redisplay, but do do autosaving.
2492 /* The arguments MAPS and NMAPS are for menu prompting.
2493 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2495 PREV_EVENT is the previous input event, or nil if we are reading
2496 the first event of a key sequence (or not reading a key sequence).
2497 If PREV_EVENT is t, that is a "magic" value that says
2498 not to run input methods, but in other respects to act as if
2499 not reading a key sequence.
2501 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2502 if we used a mouse menu to read the input, or zero otherwise. If
2503 USED_MOUSE_MENU is null, we don't dereference it.
2505 Value is -2 when we find input on another keyboard. A second call
2506 to read_char will read it.
2508 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2509 specifying the maximum time to wait until. If no input arrives by
2510 that time, stop waiting and return nil.
2512 Value is t if we showed a menu and the user rejected it. */
2515 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2519 Lisp_Object prev_event
;
2520 int *used_mouse_menu
;
2521 EMACS_TIME
*end_time
;
2523 volatile Lisp_Object c
;
2524 int count
, jmpcount
;
2525 jmp_buf local_getcjmp
;
2527 volatile int key_already_recorded
= 0;
2528 Lisp_Object tem
, save
;
2529 volatile Lisp_Object previous_echo_area_message
;
2530 volatile Lisp_Object also_record
;
2531 volatile int reread
;
2532 struct gcpro gcpro1
, gcpro2
;
2533 int polling_stopped_here
= 0;
2534 struct kboard
*orig_kboard
= current_kboard
;
2538 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2539 before_command_key_count
= this_command_key_count
;
2540 before_command_echo_length
= echo_length ();
2543 previous_echo_area_message
= Qnil
;
2545 GCPRO2 (c
, previous_echo_area_message
);
2550 if (CONSP (Vunread_post_input_method_events
))
2552 c
= XCAR (Vunread_post_input_method_events
);
2553 Vunread_post_input_method_events
2554 = XCDR (Vunread_post_input_method_events
);
2556 /* Undo what read_char_x_menu_prompt did when it unread
2557 additional keys returned by Fx_popup_menu. */
2559 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2567 if (unread_command_char
!= -1)
2569 XSETINT (c
, unread_command_char
);
2570 unread_command_char
= -1;
2576 if (CONSP (Vunread_command_events
))
2578 c
= XCAR (Vunread_command_events
);
2579 Vunread_command_events
= XCDR (Vunread_command_events
);
2583 /* Undo what sit-for did when it unread additional keys
2584 inside universal-argument. */
2587 && EQ (XCAR (c
), Qt
))
2593 /* Undo what read_char_x_menu_prompt did when it unread
2594 additional keys returned by Fx_popup_menu. */
2596 && EQ (XCDR (c
), Qdisabled
)
2597 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2600 /* If the queued event is something that used the mouse,
2601 set used_mouse_menu accordingly. */
2603 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2604 *used_mouse_menu
= 1;
2606 goto reread_for_input_method
;
2609 if (CONSP (Vunread_input_method_events
))
2611 c
= XCAR (Vunread_input_method_events
);
2612 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2614 /* Undo what read_char_x_menu_prompt did when it unread
2615 additional keys returned by Fx_popup_menu. */
2617 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2621 goto reread_for_input_method
;
2624 this_command_key_count_reset
= 0;
2626 if (!NILP (Vexecuting_kbd_macro
))
2628 /* We set this to Qmacro; since that's not a frame, nobody will
2629 try to switch frames on us, and the selected window will
2632 Since this event came from a macro, it would be misleading to
2633 leave internal_last_event_frame set to wherever the last
2634 real event came from. Normally, a switch-frame event selects
2635 internal_last_event_frame after each command is read, but
2636 events read from a macro should never cause a new frame to be
2638 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2640 /* Exit the macro if we are at the end.
2641 Also, some things replace the macro with t
2642 to force an early exit. */
2643 if (EQ (Vexecuting_kbd_macro
, Qt
)
2644 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2650 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2651 if (STRINGP (Vexecuting_kbd_macro
)
2652 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2653 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2655 executing_kbd_macro_index
++;
2660 if (!NILP (unread_switch_frame
))
2662 c
= unread_switch_frame
;
2663 unread_switch_frame
= Qnil
;
2665 /* This event should make it into this_command_keys, and get echoed
2666 again, so we do not set `reread'. */
2670 /* if redisplay was requested */
2671 if (commandflag
>= 0)
2673 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2675 /* If there is pending input, process any events which are not
2676 user-visible, such as X selection_request events. */
2678 || detect_input_pending_run_timers (0))
2679 swallow_events (0); /* may clear input_pending */
2681 /* Redisplay if no pending input. */
2682 while (!input_pending
)
2684 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2685 redisplay_preserve_echo_area (5);
2690 /* Normal case: no input arrived during redisplay. */
2693 /* Input arrived and pre-empted redisplay.
2694 Process any events which are not user-visible. */
2696 /* If that cleared input_pending, try again to redisplay. */
2699 /* Prevent the redisplay we just did
2700 from messing up echoing of the input after the prompt. */
2701 if (commandflag
== 0 && echo_current
)
2702 echo_message_buffer
= echo_area_buffer
[0];
2706 /* Message turns off echoing unless more keystrokes turn it on again.
2708 The code in 20.x for the condition was
2710 1. echo_area_glyphs && *echo_area_glyphs
2711 2. && echo_area_glyphs != current_kboard->echobuf
2712 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2714 (1) means there's a current message displayed
2716 (2) means it's not the message from echoing from the current
2719 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2720 is set to a non-null value. This is done in read_char and it is
2721 set to echo_area_glyphs after a call to echo_char. That means
2722 ok_to_echo_at_next_pause is either null or
2723 current_kboard->echobuf with the appropriate current_kboard at
2726 So, condition (3) means in clear text ok_to_echo_at_next_pause
2727 must be either null, or the current message isn't from echoing at
2728 all, or it's from echoing from a different kboard than the
2731 if (/* There currently is something in the echo area. */
2732 !NILP (echo_area_buffer
[0])
2733 && (/* And it's either not from echoing. */
2734 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2735 /* Or it's an echo from a different kboard. */
2736 || echo_kboard
!= current_kboard
2737 /* Or we explicitly allow overwriting whatever there is. */
2738 || ok_to_echo_at_next_pause
== NULL
))
2743 /* Try reading a character via menu prompting in the minibuf.
2744 Try this before the sit-for, because the sit-for
2745 would do the wrong thing if we are supposed to do
2746 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2747 after a mouse event so don't try a minibuf menu. */
2749 if (nmaps
> 0 && INTERACTIVE
2750 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2751 /* Don't bring up a menu if we already have another event. */
2752 && NILP (Vunread_command_events
)
2753 && unread_command_char
< 0
2754 && !detect_input_pending_run_timers (0))
2756 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2758 if (INTEGERP (c
) && XINT (c
) == -2)
2759 return c
; /* wrong_kboard_jmpbuf */
2763 key_already_recorded
= 1;
2768 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2769 We will do that below, temporarily for short sections of code,
2770 when appropriate. local_getcjmp must be in effect
2771 around any call to sit_for or kbd_buffer_get_event;
2772 it *must not* be in effect when we call redisplay. */
2774 jmpcount
= SPECPDL_INDEX ();
2775 if (_setjmp (local_getcjmp
))
2777 /* Handle quits while reading the keyboard. */
2778 /* We must have saved the outer value of getcjmp here,
2779 so restore it now. */
2780 restore_getcjmp (save_jump
);
2781 unbind_to (jmpcount
, Qnil
);
2782 XSETINT (c
, quit_char
);
2783 internal_last_event_frame
= selected_frame
;
2784 Vlast_event_frame
= internal_last_event_frame
;
2785 /* If we report the quit char as an event,
2786 don't do so more than once. */
2787 if (!NILP (Vinhibit_quit
))
2792 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2793 if (kb
!= current_kboard
)
2795 Lisp_Object link
= kb
->kbd_queue
;
2796 /* We shouldn't get here if we were in single-kboard mode! */
2801 while (CONSP (XCDR (link
)))
2803 if (!NILP (XCDR (link
)))
2807 kb
->kbd_queue
= Fcons (c
, Qnil
);
2809 XSETCDR (link
, Fcons (c
, Qnil
));
2810 kb
->kbd_queue_has_data
= 1;
2811 current_kboard
= kb
;
2812 /* This is going to exit from read_char
2813 so we had better get rid of this frame's stuff. */
2815 return make_number (-2); /* wrong_kboard_jmpbuf */
2822 /* Start idle timers if no time limit is supplied. We don't do it
2823 if a time limit is supplied to avoid an infinite recursion in the
2824 situation where an idle timer calls `sit-for'. */
2827 timer_start_idle ();
2829 /* If in middle of key sequence and minibuffer not active,
2830 start echoing if enough time elapses. */
2832 if (minibuf_level
== 0
2834 && !current_kboard
->immediate_echo
2835 && this_command_key_count
> 0
2837 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2838 && NILP (Fzerop (Vecho_keystrokes
))
2839 && (/* No message. */
2840 NILP (echo_area_buffer
[0])
2841 /* Or empty message. */
2842 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2843 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2844 /* Or already echoing from same kboard. */
2845 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2846 /* Or not echoing before and echoing allowed. */
2847 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2849 /* After a mouse event, start echoing right away.
2850 This is because we are probably about to display a menu,
2851 and we don't want to delay before doing so. */
2852 if (EVENT_HAS_PARAMETERS (prev_event
))
2858 save_getcjmp (save_jump
);
2859 restore_getcjmp (local_getcjmp
);
2860 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2861 restore_getcjmp (save_jump
);
2863 && ! CONSP (Vunread_command_events
))
2868 /* Maybe auto save due to number of keystrokes. */
2870 if (commandflag
!= 0
2871 && auto_save_interval
> 0
2872 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2873 && !detect_input_pending_run_timers (0))
2875 Fdo_auto_save (Qnil
, Qnil
);
2876 /* Hooks can actually change some buffers in auto save. */
2880 /* Try reading using an X menu.
2881 This is never confused with reading using the minibuf
2882 because the recursive call of read_char in read_char_minibuf_menu_prompt
2883 does not pass on any keymaps. */
2885 if (nmaps
> 0 && INTERACTIVE
2886 && !NILP (prev_event
)
2887 && EVENT_HAS_PARAMETERS (prev_event
)
2888 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2889 && !EQ (XCAR (prev_event
), Qtool_bar
)
2890 /* Don't bring up a menu if we already have another event. */
2891 && NILP (Vunread_command_events
)
2892 && unread_command_char
< 0)
2894 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2896 /* Now that we have read an event, Emacs is not idle. */
2903 /* Maybe autosave and/or garbage collect due to idleness. */
2905 if (INTERACTIVE
&& NILP (c
))
2907 int delay_level
, buffer_size
;
2909 /* Slow down auto saves logarithmically in size of current buffer,
2910 and garbage collect while we're at it. */
2911 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2912 last_non_minibuf_size
= Z
- BEG
;
2913 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2915 while (buffer_size
> 64)
2916 delay_level
++, buffer_size
-= buffer_size
>> 2;
2917 if (delay_level
< 4) delay_level
= 4;
2918 /* delay_level is 4 for files under around 50k, 7 at 100k,
2919 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2921 /* Auto save if enough time goes by without input. */
2922 if (commandflag
!= 0
2923 && num_nonmacro_input_events
> last_auto_save
2924 && INTEGERP (Vauto_save_timeout
)
2925 && XINT (Vauto_save_timeout
) > 0)
2928 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2930 save_getcjmp (save_jump
);
2931 restore_getcjmp (local_getcjmp
);
2932 tem0
= sit_for (make_number (timeout
), 1, 1);
2933 restore_getcjmp (save_jump
);
2936 && ! CONSP (Vunread_command_events
))
2938 Fdo_auto_save (Qnil
, Qnil
);
2940 /* If we have auto-saved and there is still no input
2941 available, garbage collect if there has been enough
2942 consing going on to make it worthwhile. */
2943 if (!detect_input_pending_run_timers (0)
2944 && consing_since_gc
> gc_cons_threshold
/ 2)
2945 Fgarbage_collect ();
2952 /* Notify the caller if an autosave hook, or a timer, sentinel or
2953 filter in the sit_for calls above have changed the current
2954 kboard. This could happen if they use the minibuffer or start a
2955 recursive edit, like the fancy splash screen in server.el's
2956 filter. If this longjmp wasn't here, read_key_sequence would
2957 interpret the next key sequence using the wrong translation
2958 tables and function keymaps. */
2959 if (NILP (c
) && current_kboard
!= orig_kboard
)
2962 return make_number (-2); /* wrong_kboard_jmpbuf */
2965 /* If this has become non-nil here, it has been set by a timer
2966 or sentinel or filter. */
2967 if (CONSP (Vunread_command_events
))
2969 c
= XCAR (Vunread_command_events
);
2970 Vunread_command_events
= XCDR (Vunread_command_events
);
2973 /* Read something from current KBOARD's side queue, if possible. */
2977 if (current_kboard
->kbd_queue_has_data
)
2979 if (!CONSP (current_kboard
->kbd_queue
))
2981 c
= XCAR (current_kboard
->kbd_queue
);
2982 current_kboard
->kbd_queue
2983 = XCDR (current_kboard
->kbd_queue
);
2984 if (NILP (current_kboard
->kbd_queue
))
2985 current_kboard
->kbd_queue_has_data
= 0;
2986 input_pending
= readable_events (0);
2987 if (EVENT_HAS_PARAMETERS (c
)
2988 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2989 internal_last_event_frame
= XCAR (XCDR (c
));
2990 Vlast_event_frame
= internal_last_event_frame
;
2995 /* If current_kboard's side queue is empty check the other kboards.
2996 If one of them has data that we have not yet seen here,
2997 switch to it and process the data waiting for it.
2999 Note: if the events queued up for another kboard
3000 have already been seen here, and therefore are not a complete command,
3001 the kbd_queue_has_data field is 0, so we skip that kboard here.
3002 That's to avoid an infinite loop switching between kboards here. */
3003 if (NILP (c
) && !single_kboard
)
3006 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3007 if (kb
->kbd_queue_has_data
)
3009 current_kboard
= kb
;
3010 /* This is going to exit from read_char
3011 so we had better get rid of this frame's stuff. */
3013 return make_number (-2); /* wrong_kboard_jmpbuf */
3022 /* Finally, we read from the main queue,
3023 and if that gives us something we can't use yet, we put it on the
3024 appropriate side queue and try again. */
3033 EMACS_GET_TIME (now
);
3034 if (EMACS_TIME_GE (now
, *end_time
))
3038 /* Actually read a character, waiting if necessary. */
3039 save_getcjmp (save_jump
);
3040 restore_getcjmp (local_getcjmp
);
3042 timer_start_idle ();
3043 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
3044 restore_getcjmp (save_jump
);
3047 if (! NILP (c
) && (kb
!= current_kboard
))
3049 Lisp_Object link
= kb
->kbd_queue
;
3052 while (CONSP (XCDR (link
)))
3054 if (!NILP (XCDR (link
)))
3058 kb
->kbd_queue
= Fcons (c
, Qnil
);
3060 XSETCDR (link
, Fcons (c
, Qnil
));
3061 kb
->kbd_queue_has_data
= 1;
3065 current_kboard
= kb
;
3066 /* This is going to exit from read_char
3067 so we had better get rid of this frame's stuff. */
3069 return make_number (-2);
3074 /* Terminate Emacs in batch mode if at eof. */
3075 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
3076 Fkill_emacs (make_number (1));
3080 /* Add in any extra modifiers, where appropriate. */
3081 if ((extra_keyboard_modifiers
& CHAR_CTL
)
3082 || ((extra_keyboard_modifiers
& 0177) < ' '
3083 && (extra_keyboard_modifiers
& 0177) != 0))
3084 XSETINT (c
, make_ctrl_char (XINT (c
)));
3086 /* Transfer any other modifier bits directly from
3087 extra_keyboard_modifiers to c. Ignore the actual character code
3088 in the low 16 bits of extra_keyboard_modifiers. */
3089 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
3100 if (commandflag
>= 0
3101 && !input_pending
&& !detect_input_pending_run_timers (0))
3109 /* Buffer switch events are only for internal wakeups
3110 so don't show them to the user.
3111 Also, don't record a key if we already did. */
3112 if (BUFFERP (c
) || key_already_recorded
)
3115 /* Process special events within read_char
3116 and loop around to read another event. */
3119 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3124 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3125 int was_locked
= single_kboard
;
3126 int count
= SPECPDL_INDEX ();
3127 record_single_kboard_state ();
3130 last_input_char
= c
;
3131 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
3133 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3134 /* We stopped being idle for this event; undo that. This
3135 prevents automatic window selection (under
3136 mouse_autoselect_window from acting as a real input event, for
3137 example banishing the mouse under mouse-avoidance-mode. */
3138 timer_resume_idle ();
3140 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3141 /* Resume allowing input from any kboard, if that was true before. */
3143 any_kboard_state ();
3144 unbind_to (count
, Qnil
);
3150 /* Handle things that only apply to characters. */
3153 /* If kbd_buffer_get_event gave us an EOF, return that. */
3157 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3158 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3159 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3160 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3161 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3165 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3166 /* nil in keyboard-translate-table means no translation. */
3172 /* If this event is a mouse click in the menu bar,
3173 return just menu-bar for now. Modify the mouse click event
3174 so we won't do this twice, then queue it up. */
3175 if (EVENT_HAS_PARAMETERS (c
)
3177 && CONSP (EVENT_START (c
))
3178 && CONSP (XCDR (EVENT_START (c
))))
3182 posn
= POSN_POSN (EVENT_START (c
));
3183 /* Handle menu-bar events:
3184 insert the dummy prefix event `menu-bar'. */
3185 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3187 /* Change menu-bar to (menu-bar) as the event "position". */
3188 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3191 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3196 /* Store these characters into recent_keys, the dribble file if any,
3197 and the keyboard macro being defined, if any. */
3199 if (! NILP (also_record
))
3200 record_char (also_record
);
3202 /* Wipe the echo area.
3203 But first, if we are about to use an input method,
3204 save the echo area contents for it to refer to. */
3206 && ! NILP (Vinput_method_function
)
3207 && (unsigned) XINT (c
) >= ' '
3208 && (unsigned) XINT (c
) != 127
3209 && (unsigned) XINT (c
) < 256)
3211 previous_echo_area_message
= Fcurrent_message ();
3212 Vinput_method_previous_message
= previous_echo_area_message
;
3215 /* Now wipe the echo area, except for help events which do their
3216 own stuff with the echo area. */
3218 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3219 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3221 if (!NILP (echo_area_buffer
[0]))
3222 safe_run_hooks (Qecho_area_clear_hook
);
3223 clear_message (1, 0);
3226 reread_for_input_method
:
3228 /* Pass this to the input method, if appropriate. */
3230 && ! NILP (Vinput_method_function
)
3231 /* Don't run the input method within a key sequence,
3232 after the first event of the key sequence. */
3233 && NILP (prev_event
)
3234 && (unsigned) XINT (c
) >= ' '
3235 && (unsigned) XINT (c
) != 127
3236 && (unsigned) XINT (c
) < 256)
3239 int key_count
, key_count_reset
;
3240 struct gcpro gcpro1
;
3241 int count
= SPECPDL_INDEX ();
3243 /* Save the echo status. */
3244 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3245 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3246 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3247 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3250 if (before_command_restore_flag
)
3252 this_command_key_count
= before_command_key_count_1
;
3253 if (this_command_key_count
< this_single_command_key_start
)
3254 this_single_command_key_start
= this_command_key_count
;
3255 echo_truncate (before_command_echo_length_1
);
3256 before_command_restore_flag
= 0;
3260 /* Save the this_command_keys status. */
3261 key_count
= this_command_key_count
;
3262 key_count_reset
= this_command_key_count_reset
;
3265 keys
= Fcopy_sequence (this_command_keys
);
3270 /* Clear out this_command_keys. */
3271 this_command_key_count
= 0;
3272 this_command_key_count_reset
= 0;
3274 /* Now wipe the echo area. */
3275 if (!NILP (echo_area_buffer
[0]))
3276 safe_run_hooks (Qecho_area_clear_hook
);
3277 clear_message (1, 0);
3280 /* If we are not reading a key sequence,
3281 never use the echo area. */
3284 specbind (Qinput_method_use_echo_area
, Qt
);
3287 /* Call the input method. */
3288 tem
= call1 (Vinput_method_function
, c
);
3290 tem
= unbind_to (count
, tem
);
3292 /* Restore the saved echoing state
3293 and this_command_keys state. */
3294 this_command_key_count
= key_count
;
3295 this_command_key_count_reset
= key_count_reset
;
3297 this_command_keys
= keys
;
3300 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3301 current_kboard
->echo_string
= saved_echo_string
;
3302 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3303 if (saved_immediate_echo
)
3308 /* The input method can return no events. */
3311 /* Bring back the previous message, if any. */
3312 if (! NILP (previous_echo_area_message
))
3313 message_with_string ("%s", previous_echo_area_message
, 0);
3316 /* It returned one event or more. */
3318 Vunread_post_input_method_events
3319 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3324 /* Display help if not echoing. */
3325 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3327 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3328 Lisp_Object help
, object
, position
, window
, tem
;
3330 tem
= Fcdr (XCDR (c
));
3333 window
= Fcar (tem
);
3335 object
= Fcar (tem
);
3337 position
= Fcar (tem
);
3339 show_help_echo (help
, window
, object
, position
, 0);
3341 /* We stopped being idle for this event; undo that. */
3343 timer_resume_idle ();
3347 if ((! reread
|| this_command_key_count
== 0
3348 || this_command_key_count_reset
)
3352 /* Don't echo mouse motion events. */
3353 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3354 && NILP (Fzerop (Vecho_keystrokes
))
3355 && ! (EVENT_HAS_PARAMETERS (c
)
3356 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3359 if (! NILP (also_record
))
3360 echo_char (also_record
);
3361 /* Once we reread a character, echoing can happen
3362 the next time we pause to read a new one. */
3363 ok_to_echo_at_next_pause
= current_kboard
;
3366 /* Record this character as part of the current key. */
3367 add_command_key (c
);
3368 if (! NILP (also_record
))
3369 add_command_key (also_record
);
3372 last_input_char
= c
;
3375 /* Process the help character specially if enabled */
3376 if (!NILP (Vhelp_form
) && help_char_p (c
))
3379 count
= SPECPDL_INDEX ();
3381 help_form_saved_window_configs
3382 = Fcons (Fcurrent_window_configuration (Qnil
),
3383 help_form_saved_window_configs
);
3384 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3386 tem0
= Feval (Vhelp_form
);
3388 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3393 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3394 if (EVENT_HAS_PARAMETERS (c
)
3395 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3396 XSETCAR (help_form_saved_window_configs
, Qnil
);
3398 while (BUFFERP (c
));
3399 /* Remove the help from the frame */
3400 unbind_to (count
, Qnil
);
3403 if (EQ (c
, make_number (040)))
3407 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3408 while (BUFFERP (c
));
3417 /* Record a key that came from a mouse menu.
3418 Record it for echoing, for this-command-keys, and so on. */
3424 /* Wipe the echo area. */
3425 clear_message (1, 0);
3430 before_command_key_count
= this_command_key_count
;
3431 before_command_echo_length
= echo_length ();
3434 /* Don't echo mouse motion events. */
3435 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3436 && NILP (Fzerop (Vecho_keystrokes
)))
3440 /* Once we reread a character, echoing can happen
3441 the next time we pause to read a new one. */
3442 ok_to_echo_at_next_pause
= 0;
3445 /* Record this character as part of the current key. */
3446 add_command_key (c
);
3448 /* Re-reading in the middle of a command */
3449 last_input_char
= c
;
3453 /* Return 1 if should recognize C as "the help character". */
3461 if (EQ (c
, Vhelp_char
))
3463 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3464 if (EQ (c
, XCAR (tail
)))
3469 /* Record the input event C in various ways. */
3477 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3479 /* To avoid filling recent_keys with help-echo and mouse-movement
3480 events, we filter out repeated help-echo events, only store the
3481 first and last in a series of mouse-movement events, and don't
3482 store repeated help-echo events which are only separated by
3483 mouse-movement events. */
3485 Lisp_Object ev1
, ev2
, ev3
;
3488 if ((ix1
= recent_keys_index
- 1) < 0)
3489 ix1
= NUM_RECENT_KEYS
- 1;
3490 ev1
= AREF (recent_keys
, ix1
);
3492 if ((ix2
= ix1
- 1) < 0)
3493 ix2
= NUM_RECENT_KEYS
- 1;
3494 ev2
= AREF (recent_keys
, ix2
);
3496 if ((ix3
= ix2
- 1) < 0)
3497 ix3
= NUM_RECENT_KEYS
- 1;
3498 ev3
= AREF (recent_keys
, ix3
);
3500 if (EQ (XCAR (c
), Qhelp_echo
))
3502 /* Don't record `help-echo' in recent_keys unless it shows some help
3503 message, and a different help than the previously recorded
3505 Lisp_Object help
, last_help
;
3507 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3508 if (!STRINGP (help
))
3510 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3511 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3513 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3514 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3515 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3517 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3518 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3519 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3520 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3523 else if (EQ (XCAR (c
), Qmouse_movement
))
3525 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3526 So additional mouse movement events replace the last element. */
3527 Lisp_Object last_window
, window
;
3529 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3530 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3531 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3532 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3533 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3535 ASET (recent_keys
, ix1
, c
);
3541 store_kbd_macro_char (c
);
3546 ASET (recent_keys
, recent_keys_index
, c
);
3547 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3548 recent_keys_index
= 0;
3550 else if (recorded
< 0)
3552 /* We need to remove one or two events from recent_keys.
3553 To do this, we simply put nil at those events and move the
3554 recent_keys_index backwards over those events. Usually,
3555 users will never see those nil events, as they will be
3556 overwritten by the command keys entered to see recent_keys
3559 while (recorded
++ < 0 && total_keys
> 0)
3561 if (total_keys
< NUM_RECENT_KEYS
)
3563 if (--recent_keys_index
< 0)
3564 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3565 ASET (recent_keys
, recent_keys_index
, Qnil
);
3569 num_nonmacro_input_events
++;
3571 /* Write c to the dribble file. If c is a lispy event, write
3572 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3573 If you, dear reader, have a better idea, you've got the source. :-) */
3579 if (XUINT (c
) < 0x100)
3580 putc (XINT (c
), dribble
);
3582 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3586 Lisp_Object dribblee
;
3588 /* If it's a structured event, take the event header. */
3589 dribblee
= EVENT_HEAD (c
);
3591 if (SYMBOLP (dribblee
))
3593 putc ('<', dribble
);
3594 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3595 SBYTES (SYMBOL_NAME (dribblee
)),
3597 putc ('>', dribble
);
3610 struct buffer
*old
= current_buffer
;
3611 Fprinc (object
, Qnil
);
3612 set_buffer_internal (XBUFFER (Vstandard_output
));
3613 call0 (intern ("help-mode"));
3614 set_buffer_internal (old
);
3618 /* Copy out or in the info on where C-g should throw to.
3619 This is used when running Lisp code from within get_char,
3620 in case get_char is called recursively.
3621 See read_process_output. */
3627 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3631 restore_getcjmp (temp
)
3634 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3637 /* Low level keyboard/mouse input.
3638 kbd_buffer_store_event places events in kbd_buffer, and
3639 kbd_buffer_get_event retrieves them. */
3641 /* Return true if there are any events in the queue that read-char
3642 would return. If this returns false, a read-char would block. */
3644 readable_events (flags
)
3647 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3650 /* If the buffer contains only FOCUS_IN_EVENT events, and
3651 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3652 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3654 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3655 #ifdef USE_TOOLKIT_SCROLL_BARS
3656 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3660 struct input_event
*event
;
3662 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3669 #ifdef USE_TOOLKIT_SCROLL_BARS
3670 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3672 event
->kind
== FOCUS_IN_EVENT
)
3673 #ifdef USE_TOOLKIT_SCROLL_BARS
3674 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3675 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3676 && event
->part
== scroll_bar_handle
3677 && event
->modifiers
== 0)
3682 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3685 while (event
!= kbd_store_ptr
);
3691 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3692 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3693 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3698 if (current_kboard
->kbd_queue_has_data
)
3704 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3705 if (kb
->kbd_queue_has_data
)
3711 /* Set this for debugging, to have a way to get out */
3716 event_to_kboard (event
)
3717 struct input_event
*event
;
3720 frame
= event
->frame_or_window
;
3722 frame
= XCAR (frame
);
3723 else if (WINDOWP (frame
))
3724 frame
= WINDOW_FRAME (XWINDOW (frame
));
3726 /* There are still some events that don't set this field.
3727 For now, just ignore the problem.
3728 Also ignore dead frames here. */
3729 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3732 return FRAME_KBOARD (XFRAME (frame
));
3737 Lisp_Object Vthrow_on_input
;
3739 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3742 kbd_buffer_store_event (event
)
3743 register struct input_event
*event
;
3745 kbd_buffer_store_event_hold (event
, 0);
3748 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3750 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3751 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3752 Else, if EVENT is a quit event, store the quit event
3753 in HOLD_QUIT, and return (thus ignoring further events).
3755 This is used in read_avail_input to postpone the processing
3756 of the quit event until all subsequent input events have been
3757 parsed (and discarded).
3761 kbd_buffer_store_event_hold (event
, hold_quit
)
3762 register struct input_event
*event
;
3763 struct input_event
*hold_quit
;
3765 if (event
->kind
== NO_EVENT
)
3768 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3771 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3773 register int c
= event
->code
& 0377;
3775 if (event
->modifiers
& ctrl_modifier
)
3776 c
= make_ctrl_char (c
);
3778 c
|= (event
->modifiers
3779 & (meta_modifier
| alt_modifier
3780 | hyper_modifier
| super_modifier
));
3785 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3786 struct input_event
*sp
;
3788 if (single_kboard
&& kb
!= current_kboard
)
3791 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3792 Fcons (make_number (c
), Qnil
));
3793 kb
->kbd_queue_has_data
= 1;
3794 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3796 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3799 if (event_to_kboard (sp
) == kb
)
3801 sp
->kind
= NO_EVENT
;
3802 sp
->frame_or_window
= Qnil
;
3812 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3816 /* If this results in a quit_char being returned to Emacs as
3817 input, set Vlast_event_frame properly. If this doesn't
3818 get returned to Emacs as an event, the next event read
3819 will set Vlast_event_frame again, so this is safe to do. */
3823 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3825 focus
= event
->frame_or_window
;
3826 internal_last_event_frame
= focus
;
3827 Vlast_event_frame
= focus
;
3830 last_event_timestamp
= event
->timestamp
;
3831 handle_interrupt ();
3835 if (c
&& c
== stop_character
)
3841 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3842 Just ignore the second one. */
3843 else if (event
->kind
== BUFFER_SWITCH_EVENT
3844 && kbd_fetch_ptr
!= kbd_store_ptr
3845 && ((kbd_store_ptr
== kbd_buffer
3846 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3847 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3850 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3851 kbd_store_ptr
= kbd_buffer
;
3853 /* Don't let the very last slot in the buffer become full,
3854 since that would make the two pointers equal,
3855 and that is indistinguishable from an empty buffer.
3856 Discard the event if it would fill the last slot. */
3857 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3859 *kbd_store_ptr
= *event
;
3863 /* If we're inside while-no-input, and this event qualifies
3864 as input, set quit-flag to cause an interrupt. */
3865 if (!NILP (Vthrow_on_input
)
3866 && event
->kind
!= FOCUS_IN_EVENT
3867 && event
->kind
!= HELP_EVENT
3868 && event
->kind
!= DEICONIFY_EVENT
)
3870 Vquit_flag
= Vthrow_on_input
;
3871 /* If we're inside a function that wants immediate quits,
3873 if (immediate_quit
&& NILP (Vinhibit_quit
))
3883 /* Put an input event back in the head of the event queue. */
3886 kbd_buffer_unget_event (event
)
3887 register struct input_event
*event
;
3889 if (kbd_fetch_ptr
== kbd_buffer
)
3890 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3892 /* Don't let the very last slot in the buffer become full, */
3893 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3896 *kbd_fetch_ptr
= *event
;
3901 /* Generate HELP_EVENT input_events in BUFP which has room for
3902 SIZE events. If there's not enough room in BUFP, ignore this
3905 HELP is the help form.
3907 FRAME is the frame on which the help is generated. OBJECT is the
3908 Lisp object where the help was found (a buffer, a string, an
3909 overlay, or nil if neither from a string nor from a buffer. POS is
3910 the position within OBJECT where the help was found.
3912 Value is the number of input_events generated. */
3915 gen_help_event (help
, frame
, window
, object
, pos
)
3916 Lisp_Object help
, frame
, object
, window
;
3919 struct input_event event
;
3923 event
.kind
= HELP_EVENT
;
3924 event
.frame_or_window
= frame
;
3926 event
.x
= WINDOWP (window
) ? window
: frame
;
3929 kbd_buffer_store_event (&event
);
3933 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3936 kbd_buffer_store_help_event (frame
, help
)
3937 Lisp_Object frame
, help
;
3939 struct input_event event
;
3941 event
.kind
= HELP_EVENT
;
3942 event
.frame_or_window
= frame
;
3947 kbd_buffer_store_event (&event
);
3951 /* Discard any mouse events in the event buffer by setting them to
3954 discard_mouse_events ()
3956 struct input_event
*sp
;
3957 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3959 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3962 if (sp
->kind
== MOUSE_CLICK_EVENT
3963 || sp
->kind
== WHEEL_EVENT
3964 || sp
->kind
== HORIZ_WHEEL_EVENT
3966 || sp
->kind
== GPM_CLICK_EVENT
3968 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3970 sp
->kind
= NO_EVENT
;
3976 /* Return non-zero if there are any real events waiting in the event
3977 buffer, not counting `NO_EVENT's.
3979 If DISCARD is non-zero, discard NO_EVENT events at the front of
3980 the input queue, possibly leaving the input queue empty if there
3981 are no real input events. */
3984 kbd_buffer_events_waiting (discard
)
3987 struct input_event
*sp
;
3989 for (sp
= kbd_fetch_ptr
;
3990 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3993 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4000 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
4004 /* Clear input event EVENT. */
4008 struct input_event
*event
;
4010 event
->kind
= NO_EVENT
;
4014 /* Read one event from the event buffer, waiting if necessary.
4015 The value is a Lisp object representing the event.
4016 The value is nil for an event that should be ignored,
4017 or that was handled here.
4018 We always read and discard one event. */
4021 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
4023 int *used_mouse_menu
;
4024 EMACS_TIME
*end_time
;
4033 *kbp
= current_kboard
;
4037 /* Wait until there is input available. */
4040 /* Break loop if there's an unread command event. Needed in
4041 moused window autoselection which uses a timer to insert such
4043 if (CONSP (Vunread_command_events
))
4046 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4048 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4049 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4053 /* If the quit flag is set, then read_char will return
4054 quit_char, so that counts as "available input." */
4055 if (!NILP (Vquit_flag
))
4056 quit_throw_to_read_char ();
4058 /* One way or another, wait until input is available; then, if
4059 interrupt handlers have not read it, read it now. */
4062 wait_for_kbd_input ();
4064 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4068 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4070 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4071 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4076 EMACS_TIME duration
;
4077 EMACS_GET_TIME (duration
);
4078 if (EMACS_TIME_GE (duration
, *end_time
))
4079 return Qnil
; /* finished waiting */
4082 EMACS_SUB_TIME (duration
, *end_time
, duration
);
4083 wait_reading_process_output (EMACS_SECS (duration
),
4084 EMACS_USECS (duration
),
4085 -1, 1, Qnil
, NULL
, 0);
4089 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
4091 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
4092 /* Pass 1 for EXPECT since we just waited to have input. */
4093 read_avail_input (1);
4094 #endif /* not VMS */
4097 if (CONSP (Vunread_command_events
))
4100 first
= XCAR (Vunread_command_events
);
4101 Vunread_command_events
= XCDR (Vunread_command_events
);
4102 *kbp
= current_kboard
;
4106 /* At this point, we know that there is a readable event available
4107 somewhere. If the event queue is empty, then there must be a
4108 mouse movement enabled and available. */
4109 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4111 struct input_event
*event
;
4113 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4117 last_event_timestamp
= event
->timestamp
;
4120 *kbp
= event_to_kboard (event
);
4122 *kbp
= current_kboard
; /* Better than returning null ptr? */
4124 *kbp
= &the_only_kboard
;
4129 /* These two kinds of events get special handling
4130 and don't actually appear to the command loop.
4131 We return nil for them. */
4132 if (event
->kind
== SELECTION_REQUEST_EVENT
4133 || event
->kind
== SELECTION_CLEAR_EVENT
)
4136 struct input_event copy
;
4138 /* Remove it from the buffer before processing it,
4139 since otherwise swallow_events will see it
4140 and process it again. */
4142 kbd_fetch_ptr
= event
+ 1;
4143 input_pending
= readable_events (0);
4144 x_handle_selection_event (©
);
4146 /* We're getting selection request events, but we don't have
4152 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4153 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4155 /* Make an event (delete-frame (FRAME)). */
4156 obj
= Fcons (event
->frame_or_window
, Qnil
);
4157 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4158 kbd_fetch_ptr
= event
+ 1;
4161 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4162 else if (event
->kind
== ICONIFY_EVENT
)
4164 /* Make an event (iconify-frame (FRAME)). */
4165 obj
= Fcons (event
->frame_or_window
, Qnil
);
4166 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4167 kbd_fetch_ptr
= event
+ 1;
4169 else if (event
->kind
== DEICONIFY_EVENT
)
4171 /* Make an event (make-frame-visible (FRAME)). */
4172 obj
= Fcons (event
->frame_or_window
, Qnil
);
4173 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4174 kbd_fetch_ptr
= event
+ 1;
4177 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4179 /* The value doesn't matter here; only the type is tested. */
4180 XSETBUFFER (obj
, current_buffer
);
4181 kbd_fetch_ptr
= event
+ 1;
4183 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4184 || defined (USE_GTK)
4185 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4187 kbd_fetch_ptr
= event
+ 1;
4188 input_pending
= readable_events (0);
4189 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4190 x_activate_menubar (XFRAME (event
->frame_or_window
));
4193 #if defined (WINDOWSNT) || defined (MAC_OS)
4194 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4197 /* Make an event (language-change (KEY_SCRIPT)). */
4198 obj
= Fcons (make_number (event
->code
), Qnil
);
4200 /* Make an event (language-change (FRAME CHARSET LCID)). */
4201 obj
= Fcons (event
->frame_or_window
, Qnil
);
4203 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4204 kbd_fetch_ptr
= event
+ 1;
4207 else if (event
->kind
== SAVE_SESSION_EVENT
)
4209 obj
= Fcons (Qsave_session
, Qnil
);
4210 kbd_fetch_ptr
= event
+ 1;
4212 /* Just discard these, by returning nil.
4213 With MULTI_KBOARD, these events are used as placeholders
4214 when we need to randomly delete events from the queue.
4215 (They shouldn't otherwise be found in the buffer,
4216 but on some machines it appears they do show up
4217 even without MULTI_KBOARD.) */
4218 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4219 mouse events during a popup-menu call. */
4220 else if (event
->kind
== NO_EVENT
)
4221 kbd_fetch_ptr
= event
+ 1;
4222 else if (event
->kind
== HELP_EVENT
)
4224 Lisp_Object object
, position
, help
, frame
, window
;
4226 frame
= event
->frame_or_window
;
4227 object
= event
->arg
;
4228 position
= make_number (event
->code
);
4231 clear_event (event
);
4233 kbd_fetch_ptr
= event
+ 1;
4234 if (!WINDOWP (window
))
4236 obj
= Fcons (Qhelp_echo
,
4237 list5 (frame
, help
, window
, object
, position
));
4239 else if (event
->kind
== FOCUS_IN_EVENT
)
4241 /* Notification of a FocusIn event. The frame receiving the
4242 focus is in event->frame_or_window. Generate a
4243 switch-frame event if necessary. */
4244 Lisp_Object frame
, focus
;
4246 frame
= event
->frame_or_window
;
4247 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4251 if (!EQ (frame
, internal_last_event_frame
)
4252 && !EQ (frame
, selected_frame
))
4253 obj
= make_lispy_switch_frame (frame
);
4254 internal_last_event_frame
= frame
;
4255 kbd_fetch_ptr
= event
+ 1;
4258 else if (event
->kind
== DBUS_EVENT
)
4260 obj
= make_lispy_event (event
);
4261 kbd_fetch_ptr
= event
+ 1;
4266 /* If this event is on a different frame, return a switch-frame this
4267 time, and leave the event in the queue for next time. */
4271 frame
= event
->frame_or_window
;
4273 frame
= XCAR (frame
);
4274 else if (WINDOWP (frame
))
4275 frame
= WINDOW_FRAME (XWINDOW (frame
));
4277 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4281 if (! EQ (frame
, internal_last_event_frame
)
4282 && !EQ (frame
, selected_frame
))
4283 obj
= make_lispy_switch_frame (frame
);
4284 internal_last_event_frame
= frame
;
4286 /* If we didn't decide to make a switch-frame event, go ahead
4287 and build a real event from the queue entry. */
4291 obj
= make_lispy_event (event
);
4293 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4294 || defined (USE_GTK)
4295 /* If this was a menu selection, then set the flag to inhibit
4296 writing to last_nonmenu_event. Don't do this if the event
4297 we're returning is (menu-bar), though; that indicates the
4298 beginning of the menu sequence, and we might as well leave
4299 that as the `event with parameters' for this selection. */
4301 && !EQ (event
->frame_or_window
, event
->arg
)
4302 && (event
->kind
== MENU_BAR_EVENT
4303 || event
->kind
== TOOL_BAR_EVENT
))
4304 *used_mouse_menu
= 1;
4307 /* Wipe out this event, to catch bugs. */
4308 clear_event (event
);
4309 kbd_fetch_ptr
= event
+ 1;
4313 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4314 /* Try generating a mouse motion event. */
4315 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4317 FRAME_PTR f
= some_mouse_moved ();
4318 Lisp_Object bar_window
;
4319 enum scroll_bar_part part
;
4323 *kbp
= current_kboard
;
4324 /* Note that this uses F to determine which terminal to look at.
4325 If there is no valid info, it does not store anything
4326 so x remains nil. */
4329 /* XXX Can f or mouse_position_hook be NULL here? */
4330 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4331 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4332 &part
, &x
, &y
, &time
);
4336 /* Decide if we should generate a switch-frame event. Don't
4337 generate switch-frame events for motion outside of all Emacs
4343 frame
= FRAME_FOCUS_FRAME (f
);
4345 XSETFRAME (frame
, f
);
4347 if (! EQ (frame
, internal_last_event_frame
)
4348 && !EQ (frame
, selected_frame
))
4349 obj
= make_lispy_switch_frame (frame
);
4350 internal_last_event_frame
= frame
;
4353 /* If we didn't decide to make a switch-frame event, go ahead and
4354 return a mouse-motion event. */
4355 if (!NILP (x
) && NILP (obj
))
4356 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4358 #endif /* HAVE_MOUSE || HAVE GPM */
4360 /* We were promised by the above while loop that there was
4361 something for us to read! */
4364 input_pending
= readable_events (0);
4366 Vlast_event_frame
= internal_last_event_frame
;
4371 /* Process any events that are not user-visible,
4372 then return, without reading any user-visible events. */
4375 swallow_events (do_display
)
4380 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4382 struct input_event
*event
;
4384 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4388 last_event_timestamp
= event
->timestamp
;
4390 /* These two kinds of events get special handling
4391 and don't actually appear to the command loop. */
4392 if (event
->kind
== SELECTION_REQUEST_EVENT
4393 || event
->kind
== SELECTION_CLEAR_EVENT
)
4396 struct input_event copy
;
4398 /* Remove it from the buffer before processing it,
4399 since otherwise swallow_events called recursively could see it
4400 and process it again. */
4402 kbd_fetch_ptr
= event
+ 1;
4403 input_pending
= readable_events (0);
4404 x_handle_selection_event (©
);
4406 /* We're getting selection request events, but we don't have
4415 old_timers_run
= timers_run
;
4416 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4418 if (timers_run
!= old_timers_run
&& do_display
)
4419 redisplay_preserve_echo_area (7);
4422 /* Record the start of when Emacs is idle,
4423 for the sake of running idle-time timers. */
4430 /* If we are already in the idle state, do nothing. */
4431 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4434 EMACS_GET_TIME (timer_idleness_start_time
);
4436 timer_last_idleness_start_time
= timer_idleness_start_time
;
4438 /* Mark all idle-time timers as once again candidates for running. */
4439 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4443 timer
= XCAR (timers
);
4445 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4447 XVECTOR (timer
)->contents
[0] = Qnil
;
4451 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4456 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4459 /* Resume idle timer from last idle start time. */
4462 timer_resume_idle ()
4464 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4467 timer_idleness_start_time
= timer_last_idleness_start_time
;
4470 /* This is only for debugging. */
4471 struct input_event last_timer_event
;
4473 /* List of elisp functions to call, delayed because they were generated in
4474 a context where Elisp could not be safely run (e.g. redisplay, signal,
4475 ...). Each lement has the form (FUN . ARGS). */
4476 Lisp_Object pending_funcalls
;
4478 extern Lisp_Object Qapply
;
4480 /* Check whether a timer has fired. To prevent larger problems we simply
4481 disregard elements that are not proper timers. Do not make a circular
4482 timer list for the time being.
4484 Returns the number of seconds to wait until the next timer fires. If a
4485 timer is triggering now, return zero seconds.
4486 If no timer is active, return -1 seconds.
4488 If a timer is ripe, we run it, with quitting turned off.
4490 DO_IT_NOW is now ignored. It used to mean that we should
4491 run the timer directly instead of queueing a timer-event.
4492 Now we always run timers directly. */
4495 timer_check (do_it_now
)
4498 EMACS_TIME nexttime
;
4499 EMACS_TIME now
, idleness_now
;
4500 Lisp_Object timers
, idle_timers
, chosen_timer
;
4501 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4503 EMACS_SET_SECS (nexttime
, -1);
4504 EMACS_SET_USECS (nexttime
, -1);
4506 /* Always consider the ordinary timers. */
4507 timers
= Vtimer_list
;
4508 /* Consider the idle timers only if Emacs is idle. */
4509 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4510 idle_timers
= Vtimer_idle_list
;
4513 chosen_timer
= Qnil
;
4514 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4516 /* First run the code that was delayed. */
4517 while (CONSP (pending_funcalls
))
4519 Lisp_Object funcall
= XCAR (pending_funcalls
);
4520 pending_funcalls
= XCDR (pending_funcalls
);
4521 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4524 if (CONSP (timers
) || CONSP (idle_timers
))
4526 EMACS_GET_TIME (now
);
4527 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4528 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4531 while (CONSP (timers
) || CONSP (idle_timers
))
4533 Lisp_Object
*vector
;
4534 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4535 EMACS_TIME timer_time
, idle_timer_time
;
4536 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4538 /* Skip past invalid timers and timers already handled. */
4541 timer
= XCAR (timers
);
4542 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4544 timers
= XCDR (timers
);
4547 vector
= XVECTOR (timer
)->contents
;
4549 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4550 || !INTEGERP (vector
[3])
4551 || ! NILP (vector
[0]))
4553 timers
= XCDR (timers
);
4557 if (!NILP (idle_timers
))
4559 timer
= XCAR (idle_timers
);
4560 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4562 idle_timers
= XCDR (idle_timers
);
4565 vector
= XVECTOR (timer
)->contents
;
4567 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4568 || !INTEGERP (vector
[3])
4569 || ! NILP (vector
[0]))
4571 idle_timers
= XCDR (idle_timers
);
4576 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4577 based on the next ordinary timer.
4578 TIMER_DIFFERENCE is the distance in time from NOW to when
4579 this timer becomes ripe (negative if it's already ripe). */
4582 timer
= XCAR (timers
);
4583 vector
= XVECTOR (timer
)->contents
;
4584 EMACS_SET_SECS (timer_time
,
4585 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4586 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4587 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4590 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4591 based on the next idle timer. */
4592 if (!NILP (idle_timers
))
4594 idle_timer
= XCAR (idle_timers
);
4595 vector
= XVECTOR (idle_timer
)->contents
;
4596 EMACS_SET_SECS (idle_timer_time
,
4597 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4598 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4599 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4602 /* Decide which timer is the next timer,
4603 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4604 Also step down the list where we found that timer. */
4606 if (! NILP (timers
) && ! NILP (idle_timers
))
4609 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4610 if (EMACS_TIME_NEG_P (temp
))
4612 chosen_timer
= timer
;
4613 timers
= XCDR (timers
);
4614 difference
= timer_difference
;
4618 chosen_timer
= idle_timer
;
4619 idle_timers
= XCDR (idle_timers
);
4620 difference
= idle_timer_difference
;
4623 else if (! NILP (timers
))
4625 chosen_timer
= timer
;
4626 timers
= XCDR (timers
);
4627 difference
= timer_difference
;
4631 chosen_timer
= idle_timer
;
4632 idle_timers
= XCDR (idle_timers
);
4633 difference
= idle_timer_difference
;
4635 vector
= XVECTOR (chosen_timer
)->contents
;
4637 /* If timer is ripe, run it if it hasn't been run. */
4638 if (EMACS_TIME_NEG_P (difference
)
4639 || (EMACS_SECS (difference
) == 0
4640 && EMACS_USECS (difference
) == 0))
4642 if (NILP (vector
[0]))
4644 int count
= SPECPDL_INDEX ();
4645 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4647 #if 0 /* This shouldn't be necessary anymore. --lorentey */
4648 /* On unbind_to, resume allowing input from any kboard, if that
4650 record_single_kboard_state ();
4652 /* Mark the timer as triggered to prevent problems if the lisp
4653 code fails to reschedule it right. */
4656 specbind (Qinhibit_quit
, Qt
);
4658 call1 (Qtimer_event_handler
, chosen_timer
);
4659 Vdeactivate_mark
= old_deactivate_mark
;
4661 unbind_to (count
, Qnil
);
4663 /* Since we have handled the event,
4664 we don't need to tell the caller to wake up and do it. */
4668 /* When we encounter a timer that is still waiting,
4669 return the amount of time to wait before it is ripe. */
4676 /* No timers are pending in the future. */
4677 /* Return 0 if we generated an event, and -1 if not. */
4682 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4683 doc
: /* Return the current length of Emacs idleness, or nil.
4684 The value when Emacs is idle is a list of three integers. The first has the
4685 most significant 16 bits of the seconds, while the second has the
4686 least significant 16 bits. The third integer gives the microsecond
4689 The value when Emacs is not idle is nil.
4691 The microsecond count is zero on systems that do not provide
4692 resolution finer than a second. */)
4695 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4697 EMACS_TIME now
, idleness_now
;
4699 EMACS_GET_TIME (now
);
4700 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4702 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4703 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4704 make_number (EMACS_USECS (idleness_now
)));
4710 /* Caches for modify_event_symbol. */
4711 static Lisp_Object accent_key_syms
;
4712 static Lisp_Object func_key_syms
;
4713 static Lisp_Object mouse_syms
;
4714 static Lisp_Object wheel_syms
;
4715 static Lisp_Object drag_n_drop_syms
;
4717 /* This is a list of keysym codes for special "accent" characters.
4718 It parallels lispy_accent_keys. */
4720 static int lispy_accent_codes
[] =
4722 #ifdef XK_dead_circumflex
4727 #ifdef XK_dead_grave
4732 #ifdef XK_dead_tilde
4737 #ifdef XK_dead_diaeresis
4742 #ifdef XK_dead_macron
4747 #ifdef XK_dead_degree
4752 #ifdef XK_dead_acute
4757 #ifdef XK_dead_cedilla
4762 #ifdef XK_dead_breve
4767 #ifdef XK_dead_ogonek
4772 #ifdef XK_dead_caron
4777 #ifdef XK_dead_doubleacute
4778 XK_dead_doubleacute
,
4782 #ifdef XK_dead_abovedot
4787 #ifdef XK_dead_abovering
4797 #ifdef XK_dead_belowdot
4802 #ifdef XK_dead_voiced_sound
4803 XK_dead_voiced_sound
,
4807 #ifdef XK_dead_semivoiced_sound
4808 XK_dead_semivoiced_sound
,
4824 /* This is a list of Lisp names for special "accent" characters.
4825 It parallels lispy_accent_codes. */
4827 static char *lispy_accent_keys
[] =
4845 "dead-voiced-sound",
4846 "dead-semivoiced-sound",
4852 #define FUNCTION_KEY_OFFSET 0x0
4854 char *lispy_function_keys
[] =
4858 0, /* VK_LBUTTON 0x01 */
4859 0, /* VK_RBUTTON 0x02 */
4860 "cancel", /* VK_CANCEL 0x03 */
4861 0, /* VK_MBUTTON 0x04 */
4863 0, 0, 0, /* 0x05 .. 0x07 */
4865 "backspace", /* VK_BACK 0x08 */
4866 "tab", /* VK_TAB 0x09 */
4868 0, 0, /* 0x0A .. 0x0B */
4870 "clear", /* VK_CLEAR 0x0C */
4871 "return", /* VK_RETURN 0x0D */
4873 0, 0, /* 0x0E .. 0x0F */
4875 0, /* VK_SHIFT 0x10 */
4876 0, /* VK_CONTROL 0x11 */
4877 0, /* VK_MENU 0x12 */
4878 "pause", /* VK_PAUSE 0x13 */
4879 "capslock", /* VK_CAPITAL 0x14 */
4880 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4882 "junja", /* VK_JUNJA 0x17 */
4883 "final", /* VK_FINAL 0x18 */
4884 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4886 "escape", /* VK_ESCAPE 0x1B */
4887 "convert", /* VK_CONVERT 0x1C */
4888 "non-convert", /* VK_NONCONVERT 0x1D */
4889 "accept", /* VK_ACCEPT 0x1E */
4890 "mode-change", /* VK_MODECHANGE 0x1F */
4891 0, /* VK_SPACE 0x20 */
4892 "prior", /* VK_PRIOR 0x21 */
4893 "next", /* VK_NEXT 0x22 */
4894 "end", /* VK_END 0x23 */
4895 "home", /* VK_HOME 0x24 */
4896 "left", /* VK_LEFT 0x25 */
4897 "up", /* VK_UP 0x26 */
4898 "right", /* VK_RIGHT 0x27 */
4899 "down", /* VK_DOWN 0x28 */
4900 "select", /* VK_SELECT 0x29 */
4901 "print", /* VK_PRINT 0x2A */
4902 "execute", /* VK_EXECUTE 0x2B */
4903 "snapshot", /* VK_SNAPSHOT 0x2C */
4904 "insert", /* VK_INSERT 0x2D */
4905 "delete", /* VK_DELETE 0x2E */
4906 "help", /* VK_HELP 0x2F */
4908 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4910 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4912 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4914 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4916 0, 0, 0, 0, 0, 0, 0, 0, 0,
4917 0, 0, 0, 0, 0, 0, 0, 0, 0,
4918 0, 0, 0, 0, 0, 0, 0, 0,
4920 "lwindow", /* VK_LWIN 0x5B */
4921 "rwindow", /* VK_RWIN 0x5C */
4922 "apps", /* VK_APPS 0x5D */
4925 "kp-0", /* VK_NUMPAD0 0x60 */
4926 "kp-1", /* VK_NUMPAD1 0x61 */
4927 "kp-2", /* VK_NUMPAD2 0x62 */
4928 "kp-3", /* VK_NUMPAD3 0x63 */
4929 "kp-4", /* VK_NUMPAD4 0x64 */
4930 "kp-5", /* VK_NUMPAD5 0x65 */
4931 "kp-6", /* VK_NUMPAD6 0x66 */
4932 "kp-7", /* VK_NUMPAD7 0x67 */
4933 "kp-8", /* VK_NUMPAD8 0x68 */
4934 "kp-9", /* VK_NUMPAD9 0x69 */
4935 "kp-multiply", /* VK_MULTIPLY 0x6A */
4936 "kp-add", /* VK_ADD 0x6B */
4937 "kp-separator", /* VK_SEPARATOR 0x6C */
4938 "kp-subtract", /* VK_SUBTRACT 0x6D */
4939 "kp-decimal", /* VK_DECIMAL 0x6E */
4940 "kp-divide", /* VK_DIVIDE 0x6F */
4941 "f1", /* VK_F1 0x70 */
4942 "f2", /* VK_F2 0x71 */
4943 "f3", /* VK_F3 0x72 */
4944 "f4", /* VK_F4 0x73 */
4945 "f5", /* VK_F5 0x74 */
4946 "f6", /* VK_F6 0x75 */
4947 "f7", /* VK_F7 0x76 */
4948 "f8", /* VK_F8 0x77 */
4949 "f9", /* VK_F9 0x78 */
4950 "f10", /* VK_F10 0x79 */
4951 "f11", /* VK_F11 0x7A */
4952 "f12", /* VK_F12 0x7B */
4953 "f13", /* VK_F13 0x7C */
4954 "f14", /* VK_F14 0x7D */
4955 "f15", /* VK_F15 0x7E */
4956 "f16", /* VK_F16 0x7F */
4957 "f17", /* VK_F17 0x80 */
4958 "f18", /* VK_F18 0x81 */
4959 "f19", /* VK_F19 0x82 */
4960 "f20", /* VK_F20 0x83 */
4961 "f21", /* VK_F21 0x84 */
4962 "f22", /* VK_F22 0x85 */
4963 "f23", /* VK_F23 0x86 */
4964 "f24", /* VK_F24 0x87 */
4966 0, 0, 0, 0, /* 0x88 .. 0x8B */
4967 0, 0, 0, 0, /* 0x8C .. 0x8F */
4969 "kp-numlock", /* VK_NUMLOCK 0x90 */
4970 "scroll", /* VK_SCROLL 0x91 */
4971 /* Not sure where the following block comes from.
4972 Windows headers have NEC and Fujitsu specific keys in
4973 this block, but nothing generic. */
4974 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4975 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4976 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4977 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4978 "kp-end", /* VK_NUMPAD_END 0x96 */
4979 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4980 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4981 "kp-up", /* VK_NUMPAD_UP 0x99 */
4982 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4983 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4984 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4985 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4987 0, 0, /* 0x9E .. 0x9F */
4990 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4991 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4992 * No other API or message will distinguish left and right keys this way.
4997 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4998 to enable them selectively, and gives access to a few more functions.
4999 See lispy_multimedia_keys below. */
5000 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
5001 0, 0, 0, /* 0xAD .. 0xAF Volume */
5002 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
5003 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
5005 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
5006 0, 0, 0, 0, 0, 0, 0, 0, 0,
5008 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
5009 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5010 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5013 "ax", /* VK_OEM_AX 0xE1 */
5014 0, /* VK_OEM_102 0xE2 */
5015 "ico-help", /* VK_ICO_HELP 0xE3 */
5016 "ico-00", /* VK_ICO_00 0xE4 */
5017 0, /* VK_PROCESSKEY 0xE5 */
5018 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
5019 "packet", /* VK_PACKET 0xE7 */
5021 "reset", /* VK_OEM_RESET 0xE9 */
5022 "jump", /* VK_OEM_JUMP 0xEA */
5023 "oem-pa1", /* VK_OEM_PA1 0xEB */
5024 "oem-pa2", /* VK_OEM_PA2 0xEC */
5025 "oem-pa3", /* VK_OEM_PA3 0xED */
5026 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
5027 "cusel", /* VK_OEM_CUSEL 0xEF */
5028 "oem-attn", /* VK_OEM_ATTN 0xF0 */
5029 "finish", /* VK_OEM_FINISH 0xF1 */
5030 "copy", /* VK_OEM_COPY 0xF2 */
5031 "auto", /* VK_OEM_AUTO 0xF3 */
5032 "enlw", /* VK_OEM_ENLW 0xF4 */
5033 "backtab", /* VK_OEM_BACKTAB 0xF5 */
5034 "attn", /* VK_ATTN 0xF6 */
5035 "crsel", /* VK_CRSEL 0xF7 */
5036 "exsel", /* VK_EXSEL 0xF8 */
5037 "ereof", /* VK_EREOF 0xF9 */
5038 "play", /* VK_PLAY 0xFA */
5039 "zoom", /* VK_ZOOM 0xFB */
5040 "noname", /* VK_NONAME 0xFC */
5041 "pa1", /* VK_PA1 0xFD */
5042 "oem_clear", /* VK_OEM_CLEAR 0xFE */
5046 /* Some of these duplicate the "Media keys" on newer keyboards,
5047 but they are delivered to the application in a different way. */
5048 static char *lispy_multimedia_keys
[] =
5056 "browser-favorites",
5093 "toggle-dictate-command",
5099 "media-fast-forward",
5102 "media-channel-down"
5105 #else /* not HAVE_NTGUI */
5107 /* This should be dealt with in XTread_socket now, and that doesn't
5108 depend on the client system having the Kana syms defined. See also
5109 the XK_kana_A case below. */
5112 static char *lispy_kana_keys
[] =
5114 /* X Keysym value */
5115 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5116 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5117 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5118 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5119 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5120 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5121 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5122 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5123 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5124 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5125 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5126 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5127 "kana-i", "kana-u", "kana-e", "kana-o",
5128 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5129 "prolongedsound", "kana-A", "kana-I", "kana-U",
5130 "kana-E", "kana-O", "kana-KA", "kana-KI",
5131 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5132 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5133 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5134 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5135 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5136 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5137 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5138 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5139 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5140 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5141 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5142 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5144 #endif /* XK_kana_A */
5147 #define FUNCTION_KEY_OFFSET 0xff00
5149 /* You'll notice that this table is arranged to be conveniently
5150 indexed by X Windows keysym values. */
5151 static char *lispy_function_keys
[] =
5153 /* X Keysym value */
5155 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5156 "backspace", "tab", "linefeed", "clear",
5158 0, 0, 0, "pause", /* 0xff10...1f */
5159 0, 0, 0, 0, 0, 0, 0, "escape",
5161 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5162 "romaji", "hiragana", "katakana", "hiragana-katakana",
5163 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5164 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5165 "eisu-toggle", /* 0xff30...3f */
5166 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5167 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5169 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5170 "down", "prior", "next", "end",
5171 "begin", 0, 0, 0, 0, 0, 0, 0,
5172 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5183 "break", /* 0xff6b */
5186 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5187 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5188 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5189 0, 0, 0, 0, 0, 0, 0, 0,
5190 "kp-tab", /* 0xff89 */
5192 "kp-enter", /* 0xff8d */
5194 "kp-f1", /* 0xff91 */
5198 "kp-home", /* 0xff95 */
5203 "kp-prior", /* kp-page-up */
5204 "kp-next", /* kp-page-down */
5210 0, 0, 0, 0, 0, 0, 0, 0, 0,
5211 "kp-multiply", /* 0xffaa */
5216 "kp-divide", /* 0xffaf */
5217 "kp-0", /* 0xffb0 */
5218 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5221 "kp-equal", /* 0xffbd */
5222 "f1", /* 0xffbe */ /* IsFunctionKey */
5224 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5225 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5226 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5227 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5228 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5229 0, 0, 0, 0, 0, 0, 0, 0,
5230 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5231 0, 0, 0, 0, 0, 0, 0, "delete"
5234 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5235 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5237 static char *iso_lispy_function_keys
[] =
5239 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5240 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5241 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5242 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5243 "iso-lefttab", /* 0xfe20 */
5244 "iso-move-line-up", "iso-move-line-down",
5245 "iso-partial-line-up", "iso-partial-line-down",
5246 "iso-partial-space-left", "iso-partial-space-right",
5247 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5248 "iso-release-margin-left", "iso-release-margin-right",
5249 "iso-release-both-margins",
5250 "iso-fast-cursor-left", "iso-fast-cursor-right",
5251 "iso-fast-cursor-up", "iso-fast-cursor-down",
5252 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5253 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5256 #endif /* not HAVE_NTGUI */
5258 Lisp_Object Vlispy_mouse_stem
;
5260 static char *lispy_wheel_names
[] =
5262 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5265 /* drag-n-drop events are generated when a set of selected files are
5266 dragged from another application and dropped onto an Emacs window. */
5267 static char *lispy_drag_n_drop_names
[] =
5272 /* Scroll bar parts. */
5273 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5274 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5275 Lisp_Object Qtop
, Qratio
;
5277 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5278 Lisp_Object
*scroll_bar_parts
[] = {
5279 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5280 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5283 /* A vector, indexed by button number, giving the down-going location
5284 of currently depressed buttons, both scroll bar and non-scroll bar.
5286 The elements have the form
5287 (BUTTON-NUMBER MODIFIER-MASK . REST)
5288 where REST is the cdr of a position as it would be reported in the event.
5290 The make_lispy_event function stores positions here to tell the
5291 difference between click and drag events, and to store the starting
5292 location to be included in drag events. */
5294 static Lisp_Object button_down_location
;
5296 /* Information about the most recent up-going button event: Which
5297 button, what location, and what time. */
5299 static int last_mouse_button
;
5300 static int last_mouse_x
;
5301 static int last_mouse_y
;
5302 static unsigned long button_down_time
;
5304 /* The maximum time between clicks to make a double-click, or Qnil to
5305 disable double-click detection, or Qt for no time limit. */
5307 Lisp_Object Vdouble_click_time
;
5309 /* Maximum number of pixels the mouse may be moved between clicks
5310 to make a double-click. */
5312 EMACS_INT double_click_fuzz
;
5314 /* The number of clicks in this multiple-click. */
5316 int double_click_count
;
5318 /* Return position of a mouse click or wheel event */
5321 make_lispy_position (f
, x
, y
, time
)
5327 enum window_part part
;
5328 Lisp_Object posn
= Qnil
;
5329 Lisp_Object extra_info
= Qnil
;
5332 /* Set `window' to the window under frame pixel coordinates (x,y) */
5334 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5335 &part
, &wx
, &wy
, 0);
5339 if (WINDOWP (window
))
5341 /* It's a click in window window at frame coordinates (x,y) */
5342 struct window
*w
= XWINDOW (window
);
5343 Lisp_Object string_info
= Qnil
;
5344 int textpos
= -1, rx
= -1, ry
= -1;
5345 int dx
= -1, dy
= -1;
5346 int width
= -1, height
= -1;
5347 Lisp_Object object
= Qnil
;
5349 /* Set event coordinates to window-relative coordinates
5350 for constructing the Lisp event below. */
5354 if (part
== ON_TEXT
)
5356 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5358 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5360 /* Mode line or header line. Look for a string under
5361 the mouse that may have a `local-map' property. */
5365 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5367 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5368 &object
, &dx
, &dy
, &width
, &height
);
5369 if (STRINGP (string
))
5370 string_info
= Fcons (string
, make_number (charpos
));
5371 if (w
== XWINDOW (selected_window
))
5374 textpos
= XMARKER (w
->pointm
)->charpos
;
5376 else if (part
== ON_VERTICAL_BORDER
)
5378 posn
= Qvertical_line
;
5383 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5388 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5390 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5391 &object
, &dx
, &dy
, &width
, &height
);
5392 if (STRINGP (string
))
5393 string_info
= Fcons (string
, make_number (charpos
));
5394 if (part
== ON_LEFT_MARGIN
)
5397 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5399 else if (part
== ON_LEFT_FRINGE
)
5401 posn
= Qleft_fringe
;
5404 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5406 : window_box_width (w
, LEFT_MARGIN_AREA
));
5409 else if (part
== ON_RIGHT_FRINGE
)
5411 posn
= Qright_fringe
;
5414 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5415 + window_box_width (w
, TEXT_AREA
)
5416 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5417 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5423 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5424 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5429 Lisp_Object string2
, object2
= Qnil
;
5430 struct display_pos p
;
5432 int width2
, height2
;
5433 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5434 &object2
, &dx2
, &dy2
,
5436 textpos
= CHARPOS (p
.pos
);
5437 if (rx
< 0) rx
= wx
;
5438 if (ry
< 0) ry
= wy
;
5439 if (dx
< 0) dx
= dx2
;
5440 if (dy
< 0) dy
= dy2
;
5441 if (width
< 0) width
= width2
;
5442 if (height
< 0) height
= height2
;
5446 posn
= make_number (textpos
);
5447 if (STRINGP (string2
))
5448 string_info
= Fcons (string2
,
5449 make_number (CHARPOS (p
.string_pos
)));
5455 #ifdef HAVE_WINDOW_SYSTEM
5456 if (IMAGEP (object
))
5458 Lisp_Object image_map
, hotspot
;
5459 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5461 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5463 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5464 posn
= XCAR (hotspot
);
5469 extra_info
= Fcons (object
,
5470 Fcons (Fcons (make_number (dx
),
5472 Fcons (Fcons (make_number (width
),
5473 make_number (height
)),
5477 extra_info
= Fcons (string_info
,
5478 Fcons (make_number (textpos
),
5479 Fcons (Fcons (make_number (rx
),
5485 XSETFRAME (window
, f
);
5490 XSETFASTINT (*x
, 0);
5491 XSETFASTINT (*y
, 0);
5494 return Fcons (window
,
5496 Fcons (Fcons (*x
, *y
),
5497 Fcons (make_number (time
),
5501 /* Given a struct input_event, build the lisp event which represents
5502 it. If EVENT is 0, build a mouse movement event from the mouse
5503 movement buffer, which should have a movement event in it.
5505 Note that events must be passed to this function in the order they
5506 are received; this function stores the location of button presses
5507 in order to build drag events when the button is released. */
5510 make_lispy_event (event
)
5511 struct input_event
*event
;
5515 switch (SWITCH_ENUM_CAST (event
->kind
))
5517 /* A simple keystroke. */
5518 case ASCII_KEYSTROKE_EVENT
:
5519 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5521 Lisp_Object lispy_c
;
5522 int c
= event
->code
;
5523 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5526 eassert (c
== event
->code
);
5527 /* Turn ASCII characters into control characters
5529 if (event
->modifiers
& ctrl_modifier
)
5531 c
= make_ctrl_char (c
);
5532 event
->modifiers
&= ~ctrl_modifier
;
5536 /* Add in the other modifier bits. The shift key was taken care
5537 of by the X code. */
5538 c
|= (event
->modifiers
5539 & (meta_modifier
| alt_modifier
5540 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5541 /* Distinguish Shift-SPC from SPC. */
5542 if ((event
->code
) == 040
5543 && event
->modifiers
& shift_modifier
)
5544 c
|= shift_modifier
;
5545 button_down_time
= 0;
5546 XSETFASTINT (lispy_c
, c
);
5550 /* A function key. The symbol may need to have modifier prefixes
5552 case NON_ASCII_KEYSTROKE_EVENT
:
5553 button_down_time
= 0;
5555 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5556 if (event
->code
== lispy_accent_codes
[i
])
5557 return modify_event_symbol (i
,
5559 Qfunction_key
, Qnil
,
5560 lispy_accent_keys
, &accent_key_syms
,
5561 (sizeof (lispy_accent_keys
)
5562 / sizeof (lispy_accent_keys
[0])));
5566 if (event
->code
>= 0x400 && event
->code
< 0x500)
5567 return modify_event_symbol (event
->code
- 0x400,
5568 event
->modifiers
& ~shift_modifier
,
5569 Qfunction_key
, Qnil
,
5570 lispy_kana_keys
, &func_key_syms
,
5571 (sizeof (lispy_kana_keys
)
5572 / sizeof (lispy_kana_keys
[0])));
5573 #endif /* XK_kana_A */
5576 #ifdef ISO_FUNCTION_KEY_OFFSET
5577 if (event
->code
< FUNCTION_KEY_OFFSET
5578 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5579 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5581 Qfunction_key
, Qnil
,
5582 iso_lispy_function_keys
, &func_key_syms
,
5583 (sizeof (iso_lispy_function_keys
)
5584 / sizeof (iso_lispy_function_keys
[0])));
5587 /* Handle system-specific or unknown keysyms. */
5588 if (event
->code
& (1 << 28)
5589 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5590 || (event
->code
- FUNCTION_KEY_OFFSET
5591 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5592 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5594 /* We need to use an alist rather than a vector as the cache
5595 since we can't make a vector long enuf. */
5596 if (NILP (current_kboard
->system_key_syms
))
5597 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5598 return modify_event_symbol (event
->code
,
5601 current_kboard
->Vsystem_key_alist
,
5602 0, ¤t_kboard
->system_key_syms
,
5606 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5608 Qfunction_key
, Qnil
,
5609 lispy_function_keys
, &func_key_syms
,
5610 (sizeof (lispy_function_keys
)
5611 / sizeof (lispy_function_keys
[0])));
5614 case MULTIMEDIA_KEY_EVENT
:
5615 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5616 / sizeof (lispy_multimedia_keys
[0]))
5617 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5619 return modify_event_symbol (event
->code
, event
->modifiers
,
5620 Qfunction_key
, Qnil
,
5621 lispy_multimedia_keys
, &func_key_syms
,
5622 (sizeof (lispy_multimedia_keys
)
5623 / sizeof (lispy_multimedia_keys
[0])));
5629 /* A mouse click. Figure out where it is, decide whether it's
5630 a press, click or drag, and build the appropriate structure. */
5631 case MOUSE_CLICK_EVENT
:
5632 #ifndef USE_TOOLKIT_SCROLL_BARS
5633 case SCROLL_BAR_CLICK_EVENT
:
5636 int button
= event
->code
;
5638 Lisp_Object position
;
5639 Lisp_Object
*start_pos_ptr
;
5640 Lisp_Object start_pos
;
5644 /* Build the position as appropriate for this mouse click. */
5645 if (event
->kind
== MOUSE_CLICK_EVENT
)
5647 struct frame
*f
= XFRAME (event
->frame_or_window
);
5648 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5652 /* Ignore mouse events that were made on frame that
5653 have been deleted. */
5654 if (! FRAME_LIVE_P (f
))
5657 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5658 /* EVENT->x and EVENT->y are frame-relative pixel
5659 coordinates at this place. Under old redisplay, COLUMN
5660 and ROW are set to frame relative glyph coordinates
5661 which are then used to determine whether this click is
5662 in a menu (non-toolkit version). */
5663 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5664 &column
, &row
, NULL
, 1);
5666 /* In the non-toolkit version, clicks on the menu bar
5667 are ordinary button events in the event buffer.
5668 Distinguish them, and invoke the menu.
5670 (In the toolkit version, the toolkit handles the menu bar
5671 and Emacs doesn't know about it until after the user
5672 makes a selection.) */
5673 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5674 && (event
->modifiers
& down_modifier
))
5676 Lisp_Object items
, item
;
5681 /* Activate the menu bar on the down event. If the
5682 up event comes in before the menu code can deal with it,
5684 if (! (event
->modifiers
& down_modifier
))
5688 /* Find the menu bar item under `column'. */
5690 items
= FRAME_MENU_BAR_ITEMS (f
);
5691 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5693 Lisp_Object pos
, string
;
5694 string
= AREF (items
, i
+ 1);
5695 pos
= AREF (items
, i
+ 3);
5698 if (column
>= XINT (pos
)
5699 && column
< XINT (pos
) + SCHARS (string
))
5701 item
= AREF (items
, i
);
5706 /* ELisp manual 2.4b says (x y) are window relative but
5707 code says they are frame-relative. */
5709 = Fcons (event
->frame_or_window
,
5711 Fcons (Fcons (event
->x
, event
->y
),
5712 Fcons (make_number (event
->timestamp
),
5715 return Fcons (item
, Fcons (position
, Qnil
));
5717 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5719 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5722 #ifndef USE_TOOLKIT_SCROLL_BARS
5725 /* It's a scrollbar click. */
5727 Lisp_Object portion_whole
;
5730 window
= event
->frame_or_window
;
5731 portion_whole
= Fcons (event
->x
, event
->y
);
5732 part
= *scroll_bar_parts
[(int) event
->part
];
5736 Fcons (Qvertical_scroll_bar
,
5737 Fcons (portion_whole
,
5738 Fcons (make_number (event
->timestamp
),
5739 Fcons (part
, Qnil
)))));
5741 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5743 if (button
>= ASIZE (button_down_location
))
5745 button_down_location
= larger_vector (button_down_location
,
5747 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5750 start_pos_ptr
= &AREF (button_down_location
, button
);
5751 start_pos
= *start_pos_ptr
;
5752 *start_pos_ptr
= Qnil
;
5755 /* On window-system frames, use the value of
5756 double-click-fuzz as is. On other frames, interpret it
5757 as a multiple of 1/8 characters. */
5761 if (WINDOWP (event
->frame_or_window
))
5762 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5763 else if (FRAMEP (event
->frame_or_window
))
5764 f
= XFRAME (event
->frame_or_window
);
5768 if (FRAME_WINDOW_P (f
))
5769 fuzz
= double_click_fuzz
;
5771 fuzz
= double_click_fuzz
/ 8;
5773 is_double
= (button
== last_mouse_button
5774 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5775 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5776 && button_down_time
!= 0
5777 && (EQ (Vdouble_click_time
, Qt
)
5778 || (INTEGERP (Vdouble_click_time
)
5779 && ((int)(event
->timestamp
- button_down_time
)
5780 < XINT (Vdouble_click_time
)))));
5783 last_mouse_button
= button
;
5784 last_mouse_x
= XINT (event
->x
);
5785 last_mouse_y
= XINT (event
->y
);
5787 /* If this is a button press, squirrel away the location, so
5788 we can decide later whether it was a click or a drag. */
5789 if (event
->modifiers
& down_modifier
)
5793 double_click_count
++;
5794 event
->modifiers
|= ((double_click_count
> 2)
5799 double_click_count
= 1;
5800 button_down_time
= event
->timestamp
;
5801 *start_pos_ptr
= Fcopy_alist (position
);
5802 ignore_mouse_drag_p
= 0;
5805 /* Now we're releasing a button - check the co-ordinates to
5806 see if this was a click or a drag. */
5807 else if (event
->modifiers
& up_modifier
)
5809 /* If we did not see a down before this up, ignore the up.
5810 Probably this happened because the down event chose a
5811 menu item. It would be an annoyance to treat the
5812 release of the button that chose the menu item as a
5815 if (!CONSP (start_pos
))
5818 event
->modifiers
&= ~up_modifier
;
5819 #if 0 /* Formerly we treated an up with no down as a click event. */
5820 if (!CONSP (start_pos
))
5821 event
->modifiers
|= click_modifier
;
5826 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5828 /* The third element of every position
5829 should be the (x,y) pair. */
5830 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5832 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5834 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5835 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5838 if (ignore_mouse_drag_p
)
5840 event
->modifiers
|= click_modifier
;
5841 ignore_mouse_drag_p
= 0;
5843 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5844 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5845 /* Maybe the mouse has moved a lot, caused scrolling, and
5846 eventually ended up at the same screen position (but
5847 not buffer position) in which case it is a drag, not
5849 /* FIXME: OTOH if the buffer position has changed
5850 because of a timer or process filter rather than
5851 because of mouse movement, it should be considered as
5852 a click. But mouse-drag-region completely ignores
5853 this case and it hasn't caused any real problem, so
5854 it's probably OK to ignore it as well. */
5855 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5856 /* Mouse hasn't moved (much). */
5857 event
->modifiers
|= click_modifier
;
5860 button_down_time
= 0;
5861 event
->modifiers
|= drag_modifier
;
5864 /* Don't check is_double; treat this as multiple
5865 if the down-event was multiple. */
5866 if (double_click_count
> 1)
5867 event
->modifiers
|= ((double_click_count
> 2)
5873 /* Every mouse event should either have the down_modifier or
5874 the up_modifier set. */
5878 /* Get the symbol we should use for the mouse click. */
5881 head
= modify_event_symbol (button
,
5883 Qmouse_click
, Vlispy_mouse_stem
,
5886 XVECTOR (mouse_syms
)->size
);
5887 if (event
->modifiers
& drag_modifier
)
5892 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5895 Fcons (make_number (double_click_count
),
5905 case HORIZ_WHEEL_EVENT
:
5907 Lisp_Object position
;
5910 /* Build the position as appropriate for this mouse click. */
5911 struct frame
*f
= XFRAME (event
->frame_or_window
);
5913 /* Ignore wheel events that were made on frame that have been
5915 if (! FRAME_LIVE_P (f
))
5918 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5921 /* Set double or triple modifiers to indicate the wheel speed. */
5923 /* On window-system frames, use the value of
5924 double-click-fuzz as is. On other frames, interpret it
5925 as a multiple of 1/8 characters. */
5930 if (WINDOWP (event
->frame_or_window
))
5931 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5932 else if (FRAMEP (event
->frame_or_window
))
5933 f
= XFRAME (event
->frame_or_window
);
5937 if (FRAME_WINDOW_P (f
))
5938 fuzz
= double_click_fuzz
;
5940 fuzz
= double_click_fuzz
/ 8;
5942 is_double
= (last_mouse_button
< 0
5943 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5944 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5945 && button_down_time
!= 0
5946 && (EQ (Vdouble_click_time
, Qt
)
5947 || (INTEGERP (Vdouble_click_time
)
5948 && ((int)(event
->timestamp
- button_down_time
)
5949 < XINT (Vdouble_click_time
)))));
5952 double_click_count
++;
5953 event
->modifiers
|= ((double_click_count
> 2)
5959 double_click_count
= 1;
5960 event
->modifiers
|= click_modifier
;
5963 button_down_time
= event
->timestamp
;
5964 /* Use a negative value to distinguish wheel from mouse button. */
5965 last_mouse_button
= -1;
5966 last_mouse_x
= XINT (event
->x
);
5967 last_mouse_y
= XINT (event
->y
);
5973 if (event
->modifiers
& up_modifier
)
5975 /* Emit a wheel-up event. */
5976 event
->modifiers
&= ~up_modifier
;
5979 else if (event
->modifiers
& down_modifier
)
5981 /* Emit a wheel-down event. */
5982 event
->modifiers
&= ~down_modifier
;
5986 /* Every wheel event should either have the down_modifier or
5987 the up_modifier set. */
5990 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5993 /* Get the symbol we should use for the wheel event. */
5994 head
= modify_event_symbol (symbol_num
,
6000 ASIZE (wheel_syms
));
6003 if (event
->modifiers
& (double_modifier
| triple_modifier
))
6006 Fcons (make_number (double_click_count
),
6015 #ifdef USE_TOOLKIT_SCROLL_BARS
6017 /* We don't have down and up events if using toolkit scroll bars,
6018 so make this always a click event. Store in the `part' of
6019 the Lisp event a symbol which maps to the following actions:
6021 `above_handle' page up
6022 `below_handle' page down
6026 `bottom' bottom of buffer
6027 `handle' thumb has been dragged.
6028 `end-scroll' end of interaction with scroll bar
6030 The incoming input_event contains in its `part' member an
6031 index of type `enum scroll_bar_part' which we can use as an
6032 index in scroll_bar_parts to get the appropriate symbol. */
6034 case SCROLL_BAR_CLICK_EVENT
:
6036 Lisp_Object position
, head
, window
, portion_whole
, part
;
6038 window
= event
->frame_or_window
;
6039 portion_whole
= Fcons (event
->x
, event
->y
);
6040 part
= *scroll_bar_parts
[(int) event
->part
];
6044 Fcons (Qvertical_scroll_bar
,
6045 Fcons (portion_whole
,
6046 Fcons (make_number (event
->timestamp
),
6047 Fcons (part
, Qnil
)))));
6049 /* Always treat scroll bar events as clicks. */
6050 event
->modifiers
|= click_modifier
;
6051 event
->modifiers
&= ~up_modifier
;
6053 if (event
->code
>= ASIZE (mouse_syms
))
6054 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
6056 /* Get the symbol we should use for the mouse click. */
6057 head
= modify_event_symbol (event
->code
,
6062 XVECTOR (mouse_syms
)->size
);
6063 return Fcons (head
, Fcons (position
, Qnil
));
6066 #endif /* USE_TOOLKIT_SCROLL_BARS */
6068 case DRAG_N_DROP_EVENT
:
6071 Lisp_Object head
, position
;
6074 f
= XFRAME (event
->frame_or_window
);
6077 /* Ignore mouse events that were made on frames that
6078 have been deleted. */
6079 if (! FRAME_LIVE_P (f
))
6082 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6085 head
= modify_event_symbol (0, event
->modifiers
,
6087 lispy_drag_n_drop_names
,
6088 &drag_n_drop_syms
, 1);
6094 #endif /* HAVE_MOUSE */
6096 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
6097 || defined (USE_GTK)
6098 case MENU_BAR_EVENT
:
6099 if (EQ (event
->arg
, event
->frame_or_window
))
6100 /* This is the prefix key. We translate this to
6101 `(menu_bar)' because the code in keyboard.c for menu
6102 events, which we use, relies on this. */
6103 return Fcons (Qmenu_bar
, Qnil
);
6107 case SELECT_WINDOW_EVENT
:
6108 /* Make an event (select-window (WINDOW)). */
6109 return Fcons (Qselect_window
,
6110 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6113 case TOOL_BAR_EVENT
:
6114 if (EQ (event
->arg
, event
->frame_or_window
))
6115 /* This is the prefix key. We translate this to
6116 `(tool_bar)' because the code in keyboard.c for tool bar
6117 events, which we use, relies on this. */
6118 return Fcons (Qtool_bar
, Qnil
);
6119 else if (SYMBOLP (event
->arg
))
6120 return apply_modifiers (event
->modifiers
, event
->arg
);
6123 case USER_SIGNAL_EVENT
:
6124 /* A user signal. */
6126 char *name
= find_user_signal_name (event
->code
);
6129 return intern (name
);
6132 case SAVE_SESSION_EVENT
:
6133 return Qsave_session
;
6136 case MAC_APPLE_EVENT
:
6138 Lisp_Object spec
[2];
6142 return Fcons (Qmac_apple_event
,
6143 Fcons (Fvector (2, spec
),
6144 Fcons (event
->arg
, Qnil
)));
6151 return Fcons (Qdbus_event
, event
->arg
);
6153 #endif /* HAVE_DBUS */
6156 case GPM_CLICK_EVENT
:
6158 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6159 Lisp_Object head
, position
;
6160 Lisp_Object
*start_pos_ptr
;
6161 Lisp_Object start_pos
;
6162 int button
= event
->code
;
6164 if (button
>= ASIZE (button_down_location
))
6166 button_down_location
= larger_vector (button_down_location
,
6168 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6171 start_pos_ptr
= &AREF (button_down_location
, button
);
6172 start_pos
= *start_pos_ptr
;
6174 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6177 if (event
->modifiers
& down_modifier
)
6178 *start_pos_ptr
= Fcopy_alist (position
);
6179 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6181 if (!CONSP (start_pos
))
6183 event
->modifiers
&= ~up_modifier
;
6186 head
= modify_event_symbol (button
,
6188 Qmouse_click
, Vlispy_mouse_stem
,
6191 XVECTOR (mouse_syms
)->size
);
6193 if (event
->modifiers
& drag_modifier
)
6198 else if (event
->modifiers
& double_modifier
)
6201 Fcons (make_number (2),
6203 else if (event
->modifiers
& triple_modifier
)
6206 Fcons (make_number (3),
6213 #endif /* HAVE_GPM */
6215 /* The 'kind' field of the event is something we don't recognize. */
6221 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6224 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6226 Lisp_Object bar_window
;
6227 enum scroll_bar_part part
;
6231 /* Is it a scroll bar movement? */
6232 if (frame
&& ! NILP (bar_window
))
6234 Lisp_Object part_sym
;
6236 part_sym
= *scroll_bar_parts
[(int) part
];
6237 return Fcons (Qscroll_bar_movement
,
6238 (Fcons (Fcons (bar_window
,
6239 Fcons (Qvertical_scroll_bar
,
6240 Fcons (Fcons (x
, y
),
6241 Fcons (make_number (time
),
6247 /* Or is it an ordinary mouse movement? */
6250 Lisp_Object position
;
6252 position
= make_lispy_position (frame
, &x
, &y
, time
);
6254 return Fcons (Qmouse_movement
,
6260 #endif /* HAVE_MOUSE || HAVE GPM */
6262 /* Construct a switch frame event. */
6264 make_lispy_switch_frame (frame
)
6267 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6270 /* Manipulating modifiers. */
6272 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6274 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6275 SYMBOL's name of the end of the modifiers; the string from this
6276 position is the unmodified symbol name.
6278 This doesn't use any caches. */
6281 parse_modifiers_uncached (symbol
, modifier_end
)
6289 CHECK_SYMBOL (symbol
);
6292 name
= SYMBOL_NAME (symbol
);
6294 for (i
= 0; i
+2 <= SBYTES (name
); )
6296 int this_mod_end
= 0;
6299 /* See if the name continues with a modifier word.
6300 Check that the word appears, but don't check what follows it.
6301 Set this_mod and this_mod_end to record what we find. */
6303 switch (SREF (name
, i
))
6305 #define SINGLE_LETTER_MOD(BIT) \
6306 (this_mod_end = i + 1, this_mod = BIT)
6309 SINGLE_LETTER_MOD (alt_modifier
);
6313 SINGLE_LETTER_MOD (ctrl_modifier
);
6317 SINGLE_LETTER_MOD (hyper_modifier
);
6321 SINGLE_LETTER_MOD (meta_modifier
);
6325 SINGLE_LETTER_MOD (shift_modifier
);
6329 SINGLE_LETTER_MOD (super_modifier
);
6332 #undef SINGLE_LETTER_MOD
6334 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6335 if (i + LEN + 1 <= SBYTES (name) \
6336 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6338 this_mod_end = i + LEN; \
6343 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6344 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6345 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6349 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6351 #undef MULTI_LETTER_MOD
6355 /* If we found no modifier, stop looking for them. */
6356 if (this_mod_end
== 0)
6359 /* Check there is a dash after the modifier, so that it
6360 really is a modifier. */
6361 if (this_mod_end
>= SBYTES (name
)
6362 || SREF (name
, this_mod_end
) != '-')
6365 /* This modifier is real; look for another. */
6366 modifiers
|= this_mod
;
6367 i
= this_mod_end
+ 1;
6370 /* Should we include the `click' modifier? */
6371 if (! (modifiers
& (down_modifier
| drag_modifier
6372 | double_modifier
| triple_modifier
))
6373 && i
+ 7 == SBYTES (name
)
6374 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6375 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6376 modifiers
|= click_modifier
;
6384 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6385 prepended to the string BASE[0..BASE_LEN-1].
6386 This doesn't use any caches. */
6388 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6391 int base_len
, base_len_byte
;
6393 /* Since BASE could contain nulls, we can't use intern here; we have
6394 to use Fintern, which expects a genuine Lisp_String, and keeps a
6397 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6403 /* Only the event queue may use the `up' modifier; it should always
6404 be turned into a click or drag event before presented to lisp code. */
6405 if (modifiers
& up_modifier
)
6408 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6409 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6410 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6411 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6412 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6413 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6414 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6415 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6416 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6417 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6418 /* The click modifier is denoted by the absence of other modifiers. */
6422 mod_len
= p
- new_mods
;
6426 Lisp_Object new_name
;
6428 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6429 mod_len
+ base_len_byte
);
6430 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6431 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6433 return Fintern (new_name
, Qnil
);
6438 static char *modifier_names
[] =
6440 "up", "down", "drag", "click", "double", "triple", 0, 0,
6441 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6442 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6444 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6446 static Lisp_Object modifier_symbols
;
6448 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6450 lispy_modifier_list (modifiers
)
6453 Lisp_Object modifier_list
;
6456 modifier_list
= Qnil
;
6457 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6458 if (modifiers
& (1<<i
))
6459 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6462 return modifier_list
;
6466 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6467 where UNMODIFIED is the unmodified form of SYMBOL,
6468 MASK is the set of modifiers present in SYMBOL's name.
6469 This is similar to parse_modifiers_uncached, but uses the cache in
6470 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6471 Qevent_symbol_elements property. */
6473 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6476 parse_modifiers (symbol
)
6479 Lisp_Object elements
;
6481 if (INTEGERP (symbol
))
6482 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6483 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6485 else if (!SYMBOLP (symbol
))
6488 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6489 if (CONSP (elements
))
6494 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6495 Lisp_Object unmodified
;
6498 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6499 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6502 if (modifiers
& ~INTMASK
)
6504 XSETFASTINT (mask
, modifiers
);
6505 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6507 /* Cache the parsing results on SYMBOL. */
6508 Fput (symbol
, Qevent_symbol_element_mask
,
6510 Fput (symbol
, Qevent_symbol_elements
,
6511 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6513 /* Since we know that SYMBOL is modifiers applied to unmodified,
6514 it would be nice to put that in unmodified's cache.
6515 But we can't, since we're not sure that parse_modifiers is
6522 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6523 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6524 doc
: /* Parse the event symbol. For internal use. */)
6528 /* Fill the cache if needed. */
6529 parse_modifiers (symbol
);
6530 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6531 and use the Lispier representation stored on Qevent_symbol_elements
6533 return Fget (symbol
, Qevent_symbol_elements
);
6536 /* Apply the modifiers MODIFIERS to the symbol BASE.
6537 BASE must be unmodified.
6539 This is like apply_modifiers_uncached, but uses BASE's
6540 Qmodifier_cache property, if present. It also builds
6541 Qevent_symbol_elements properties, since it has that info anyway.
6543 apply_modifiers copies the value of BASE's Qevent_kind property to
6544 the modified symbol. */
6546 apply_modifiers (modifiers
, base
)
6550 Lisp_Object cache
, index
, entry
, new_symbol
;
6552 /* Mask out upper bits. We don't know where this value's been. */
6553 modifiers
&= INTMASK
;
6555 if (INTEGERP (base
))
6556 return make_number (XINT (base
) | modifiers
);
6558 /* The click modifier never figures into cache indices. */
6559 cache
= Fget (base
, Qmodifier_cache
);
6560 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6561 entry
= assq_no_quit (index
, cache
);
6564 new_symbol
= XCDR (entry
);
6567 /* We have to create the symbol ourselves. */
6568 new_symbol
= apply_modifiers_uncached (modifiers
,
6569 SDATA (SYMBOL_NAME (base
)),
6570 SCHARS (SYMBOL_NAME (base
)),
6571 SBYTES (SYMBOL_NAME (base
)));
6573 /* Add the new symbol to the base's cache. */
6574 entry
= Fcons (index
, new_symbol
);
6575 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6577 /* We have the parsing info now for free, so we could add it to
6579 XSETFASTINT (index, modifiers);
6580 Fput (new_symbol, Qevent_symbol_element_mask,
6581 Fcons (base, Fcons (index, Qnil)));
6582 Fput (new_symbol, Qevent_symbol_elements,
6583 Fcons (base, lispy_modifier_list (modifiers)));
6584 Sadly, this is only correct if `base' is indeed a base event,
6585 which is not necessarily the case. -stef */
6588 /* Make sure this symbol is of the same kind as BASE.
6590 You'd think we could just set this once and for all when we
6591 intern the symbol above, but reorder_modifiers may call us when
6592 BASE's property isn't set right; we can't assume that just
6593 because it has a Qmodifier_cache property it must have its
6594 Qevent_kind set right as well. */
6595 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6599 kind
= Fget (base
, Qevent_kind
);
6601 Fput (new_symbol
, Qevent_kind
, kind
);
6608 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6609 return a symbol with the modifiers placed in the canonical order.
6610 Canonical order is alphabetical, except for down and drag, which
6611 always come last. The 'click' modifier is never written out.
6613 Fdefine_key calls this to make sure that (for example) C-M-foo
6614 and M-C-foo end up being equivalent in the keymap. */
6617 reorder_modifiers (symbol
)
6620 /* It's hopefully okay to write the code this way, since everything
6621 will soon be in caches, and no consing will be done at all. */
6624 parsed
= parse_modifiers (symbol
);
6625 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6630 /* For handling events, we often want to produce a symbol whose name
6631 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6632 to some base, like the name of a function key or mouse button.
6633 modify_event_symbol produces symbols of this sort.
6635 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6636 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6639 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6640 into symbol names, or a string specifying a name stem used to
6641 construct a symbol name or the form `STEM-N', where N is the decimal
6642 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6643 non-nil; otherwise NAME_TABLE is used.
6645 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6646 persist between calls to modify_event_symbol that it can use to
6647 store a cache of the symbols it's generated for this NAME_TABLE
6648 before. The object stored there may be a vector or an alist.
6650 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6652 MODIFIERS is a set of modifier bits (as given in struct input_events)
6653 whose prefixes should be applied to the symbol name.
6655 SYMBOL_KIND is the value to be placed in the event_kind property of
6656 the returned symbol.
6658 The symbols we create are supposed to have an
6659 `event-symbol-elements' property, which lists the modifiers present
6660 in the symbol's name. */
6663 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6664 name_table
, symbol_table
, table_size
)
6667 Lisp_Object symbol_kind
;
6668 Lisp_Object name_alist_or_stem
;
6670 Lisp_Object
*symbol_table
;
6671 unsigned int table_size
;
6674 Lisp_Object symbol_int
;
6676 /* Get rid of the "vendor-specific" bit here. */
6677 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6679 /* Is this a request for a valid symbol? */
6680 if (symbol_num
< 0 || symbol_num
>= table_size
)
6683 if (CONSP (*symbol_table
))
6684 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6686 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6687 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6688 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6689 we've never used that symbol before. */
6692 if (! VECTORP (*symbol_table
)
6693 || XVECTOR (*symbol_table
)->size
!= table_size
)
6697 XSETFASTINT (size
, table_size
);
6698 *symbol_table
= Fmake_vector (size
, Qnil
);
6701 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6704 /* Have we already used this symbol before? */
6707 /* No; let's create it. */
6708 if (CONSP (name_alist_or_stem
))
6709 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6710 else if (STRINGP (name_alist_or_stem
))
6712 int len
= SBYTES (name_alist_or_stem
);
6713 char *buf
= (char *) alloca (len
+ 50);
6714 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6715 (long) XINT (symbol_int
) + 1);
6716 value
= intern (buf
);
6718 else if (name_table
!= 0 && name_table
[symbol_num
])
6719 value
= intern (name_table
[symbol_num
]);
6721 #ifdef HAVE_WINDOW_SYSTEM
6724 char *name
= x_get_keysym_name (symbol_num
);
6726 value
= intern (name
);
6733 sprintf (buf
, "key-%d", symbol_num
);
6734 value
= intern (buf
);
6737 if (CONSP (*symbol_table
))
6738 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6740 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6742 /* Fill in the cache entries for this symbol; this also
6743 builds the Qevent_symbol_elements property, which the user
6745 apply_modifiers (modifiers
& click_modifier
, value
);
6746 Fput (value
, Qevent_kind
, symbol_kind
);
6749 /* Apply modifiers to that symbol. */
6750 return apply_modifiers (modifiers
, value
);
6753 /* Convert a list that represents an event type,
6754 such as (ctrl meta backspace), into the usual representation of that
6755 event type as a number or a symbol. */
6757 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6758 doc
: /* Convert the event description list EVENT-DESC to an event type.
6759 EVENT-DESC should contain one base event type (a character or symbol)
6760 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6761 drag, down, double or triple). The base must be last.
6762 The return value is an event type (a character or symbol) which
6763 has the same base event type and all the specified modifiers. */)
6765 Lisp_Object event_desc
;
6773 while (CONSP (rest
))
6781 /* Given a symbol, see if it is a modifier name. */
6782 if (SYMBOLP (elt
) && CONSP (rest
))
6783 this = parse_solitary_modifier (elt
);
6787 else if (!NILP (base
))
6788 error ("Two bases given in one event");
6794 /* Let the symbol A refer to the character A. */
6795 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6796 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6798 if (INTEGERP (base
))
6800 /* Turn (shift a) into A. */
6801 if ((modifiers
& shift_modifier
) != 0
6802 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6804 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6805 modifiers
&= ~shift_modifier
;
6808 /* Turn (control a) into C-a. */
6809 if (modifiers
& ctrl_modifier
)
6810 return make_number ((modifiers
& ~ctrl_modifier
)
6811 | make_ctrl_char (XINT (base
)));
6813 return make_number (modifiers
| XINT (base
));
6815 else if (SYMBOLP (base
))
6816 return apply_modifiers (modifiers
, base
);
6819 error ("Invalid base event");
6824 /* Try to recognize SYMBOL as a modifier name.
6825 Return the modifier flag bit, or 0 if not recognized. */
6828 parse_solitary_modifier (symbol
)
6831 Lisp_Object name
= SYMBOL_NAME (symbol
);
6833 switch (SREF (name
, 0))
6835 #define SINGLE_LETTER_MOD(BIT) \
6836 if (SBYTES (name) == 1) \
6839 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6840 if (LEN == SBYTES (name) \
6841 && ! strncmp (SDATA (name), NAME, LEN)) \
6845 SINGLE_LETTER_MOD (alt_modifier
);
6849 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6853 SINGLE_LETTER_MOD (ctrl_modifier
);
6857 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6858 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6862 SINGLE_LETTER_MOD (hyper_modifier
);
6866 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6870 SINGLE_LETTER_MOD (meta_modifier
);
6874 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6878 SINGLE_LETTER_MOD (shift_modifier
);
6882 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6883 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6884 SINGLE_LETTER_MOD (super_modifier
);
6888 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6889 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6890 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6894 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6897 #undef SINGLE_LETTER_MOD
6898 #undef MULTI_LETTER_MOD
6904 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6905 Such a list is not valid as an event,
6906 but it can be a Lucid-style event type list. */
6909 lucid_event_type_list_p (object
)
6914 if (! CONSP (object
))
6917 if (EQ (XCAR (object
), Qhelp_echo
)
6918 || EQ (XCAR (object
), Qvertical_line
)
6919 || EQ (XCAR (object
), Qmode_line
)
6920 || EQ (XCAR (object
), Qheader_line
))
6923 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6927 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6934 /* Store into *addr a value nonzero if terminal input chars are available.
6935 Serves the purpose of ioctl (0, FIONREAD, addr)
6936 but works even if FIONREAD does not exist.
6937 (In fact, this may actually read some input.)
6939 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6940 timer events that are ripe.
6941 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6942 events (FOCUS_IN_EVENT).
6943 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6944 movements and toolkit scroll bar thumb drags. */
6947 get_input_pending (addr
, flags
)
6951 /* First of all, have we already counted some input? */
6952 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6954 /* If input is being read as it arrives, and we have none, there is none. */
6955 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6958 /* Try to read some input and see how much we get. */
6960 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6963 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6966 gobble_input (expected
)
6970 /* Check whether a D-Bus message has arrived. */
6971 xd_read_queued_messages ();
6972 #endif /* HAVE_DBUS */
6976 if (interrupt_input
)
6979 mask
= sigblock (sigmask (SIGIO
));
6980 read_avail_input (expected
);
6984 #ifdef POLL_FOR_INPUT
6985 /* XXX This condition was (read_socket_hook && !interrupt_input),
6986 but read_socket_hook is not global anymore. Let's pretend that
6988 if (!interrupt_input
&& poll_suppress_count
== 0)
6991 mask
= sigblock (sigmask (SIGALRM
));
6992 read_avail_input (expected
);
6998 read_avail_input (expected
);
7002 /* Put a BUFFER_SWITCH_EVENT in the buffer
7003 so that read_key_sequence will notice the new current buffer. */
7006 record_asynch_buffer_change ()
7008 struct input_event event
;
7012 event
.kind
= BUFFER_SWITCH_EVENT
;
7013 event
.frame_or_window
= Qnil
;
7017 /* We don't need a buffer-switch event unless Emacs is waiting for input.
7018 The purpose of the event is to make read_key_sequence look up the
7019 keymaps again. If we aren't in read_key_sequence, we don't need one,
7020 and the event could cause trouble by messing up (input-pending-p). */
7021 tem
= Fwaiting_for_user_input_p ();
7025 /* We never need these events if we have no asynchronous subprocesses. */
7029 /* Make sure no interrupt happens while storing the event. */
7031 if (interrupt_input
)
7034 mask
= sigblock (sigmask (SIGIO
));
7035 kbd_buffer_store_event (&event
);
7042 kbd_buffer_store_event (&event
);
7049 /* Read any terminal input already buffered up by the system
7050 into the kbd_buffer, but do not wait.
7052 EXPECTED should be nonzero if the caller knows there is some input.
7054 Except on VMS, all input is read by this function.
7055 If interrupt_input is nonzero, this function MUST be called
7056 only when SIGIO is blocked.
7058 Returns the number of keyboard chars read, or -1 meaning
7059 this is a bad time to try to read input. */
7062 read_avail_input (expected
)
7069 /* Store pending user signal events, if any. */
7070 if (store_user_signal_events ())
7073 /* Loop through the available terminals, and call their input hooks. */
7077 struct terminal
*next
= t
->next_terminal
;
7079 if (t
->read_socket_hook
)
7082 struct input_event hold_quit
;
7084 EVENT_INIT (hold_quit
);
7085 hold_quit
.kind
= NO_EVENT
;
7087 /* No need for FIONREAD or fcntl; just say don't wait. */
7088 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
7094 if (nr
== -1) /* Not OK to read input now. */
7098 else if (nr
== -2) /* Non-transient error. */
7100 /* The terminal device terminated; it should be closed. */
7102 /* Kill Emacs if this was our last terminal. */
7103 if (!terminal_list
->next_terminal
)
7104 /* Formerly simply reported no input, but that
7105 sometimes led to a failure of Emacs to terminate.
7106 SIGHUP seems appropriate if we can't reach the
7108 /* ??? Is it really right to send the signal just to
7109 this process rather than to the whole process
7110 group? Perhaps on systems with FIONREAD Emacs is
7111 alone in its group. */
7112 kill (getpid (), SIGHUP
);
7114 /* XXX Is calling delete_terminal safe here? It calls Fdelete_frame. */
7117 XSETTERMINAL (tmp
, t
);
7118 Fdelete_terminal (tmp
, Qnoelisp
);
7122 if (hold_quit
.kind
!= NO_EVENT
)
7123 kbd_buffer_store_event (&hold_quit
);
7135 /* This is the tty way of reading available input.
7137 Note that each terminal device has its own `struct terminal' object,
7138 and so this function is called once for each individual termcap
7139 terminal. The first parameter indicates which terminal to read from. */
7142 tty_read_avail_input (struct terminal
*terminal
,
7144 struct input_event
*hold_quit
)
7146 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7147 the kbd_buffer can really hold. That may prevent loss
7148 of characters on some systems when input is stuffed at us. */
7149 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7151 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7154 if (!terminal
->name
) /* Don't read from a dead terminal. */
7157 if (terminal
->type
!= output_termcap
)
7160 /* XXX I think the following code should be moved to separate hook
7161 functions in system-dependent files. */
7164 #else /* not WINDOWSNT */
7166 n_to_read
= dos_keysns ();
7170 cbuf
[0] = dos_keyread ();
7173 #else /* not MSDOS */
7175 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7179 return 0; /* The terminal is suspended. */
7185 struct input_event hold_quit
;
7188 EVENT_INIT (hold_quit
);
7189 hold_quit
.kind
= NO_EVENT
;
7191 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7192 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7194 if (hold_quit
.kind
!= NO_EVENT
)
7195 kbd_buffer_store_event (&hold_quit
);
7199 #endif /* HAVE_GPM */
7201 /* Determine how many characters we should *try* to read. */
7203 /* Find out how much input is available. */
7204 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7206 if (! noninteractive
)
7207 return -2; /* Close this terminal. */
7213 if (n_to_read
> sizeof cbuf
)
7214 n_to_read
= sizeof cbuf
;
7215 #else /* no FIONREAD */
7216 #if defined (USG) || defined(CYGWIN)
7217 /* Read some input if available, but don't wait. */
7218 n_to_read
= sizeof cbuf
;
7219 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7225 /* Now read; for one reason or another, this will not block.
7226 NREAD is set to the number of chars read. */
7229 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7230 /* POSIX infers that processes which are not in the session leader's
7231 process group won't get SIGHUP's at logout time. BSDI adheres to
7232 this part standard and returns -1 from read (0) with errno==EIO
7233 when the control tty is taken away.
7234 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7235 if (nread
== -1 && errno
== EIO
)
7236 return -2; /* Close this terminal. */
7237 #if defined (AIX) && defined (_BSD)
7238 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7239 This looks incorrect, but it isn't, because _BSD causes
7240 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7241 and that causes a value other than 0 when there is no input. */
7243 return -2; /* Close this terminal. */
7247 /* We used to retry the read if it was interrupted.
7248 But this does the wrong thing when O_NDELAY causes
7249 an EAGAIN error. Does anybody know of a situation
7250 where a retry is actually needed? */
7252 nread
< 0 && (errno
== EAGAIN
7266 #if defined (USG) || defined (CYGWIN)
7267 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7268 #endif /* USG or CYGWIN */
7269 #endif /* no FIONREAD */
7274 #endif /* not MSDOS */
7275 #endif /* not WINDOWSNT */
7277 for (i
= 0; i
< nread
; i
++)
7279 struct input_event buf
;
7281 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7283 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7284 buf
.modifiers
= meta_modifier
;
7285 if (tty
->meta_key
!= 2)
7289 /* Set the frame corresponding to the active tty. Note that the
7290 value of selected_frame is not reliable here, redisplay tends
7291 to temporarily change it. */
7292 buf
.frame_or_window
= tty
->top_frame
;
7295 kbd_buffer_store_event (&buf
);
7296 /* Don't look at input that follows a C-g too closely.
7297 This reduces lossage due to autorepeat on C-g. */
7298 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7299 && buf
.code
== quit_char
)
7305 #endif /* not VMS */
7308 handle_async_input ()
7311 extern int select_alarmed
;
7314 interrupt_input_pending
= 0;
7319 nread
= read_avail_input (1);
7320 /* -1 means it's not ok to read the input now.
7321 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7322 0 means there was no keyboard input available. */
7327 select_alarmed
= 1; /* Force the select emulator back to life */
7332 #ifdef SIGIO /* for entire page */
7333 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7336 input_available_signal (signo
)
7339 /* Must preserve main program's value of errno. */
7340 int old_errno
= errno
;
7341 #if defined (USG) && !defined (POSIX_SIGNALS)
7342 /* USG systems forget handlers when they are used;
7343 must reestablish each time */
7344 signal (signo
, input_available_signal
);
7352 interrupt_input_pending
= 1;
7354 SIGNAL_THREAD_CHECK (signo
);
7357 if (input_available_clear_time
)
7358 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7361 handle_async_input ();
7371 /* Send ourselves a SIGIO.
7373 This function exists so that the UNBLOCK_INPUT macro in
7374 blockinput.h can have some way to take care of input we put off
7375 dealing with, without assuming that every file which uses
7376 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7378 reinvoke_input_signal ()
7381 handle_async_input ();
7387 /* User signal events. */
7389 struct user_signal_info
7391 /* Signal number. */
7394 /* Name of the signal. */
7397 /* Number of pending signals. */
7400 struct user_signal_info
*next
;
7403 /* List of user signals. */
7404 static struct user_signal_info
*user_signals
= NULL
;
7407 add_user_signal (sig
, name
)
7411 struct user_signal_info
*p
;
7413 for (p
= user_signals
; p
; p
= p
->next
)
7415 /* Already added. */
7418 p
= xmalloc (sizeof (struct user_signal_info
));
7420 p
->name
= xstrdup (name
);
7422 p
->next
= user_signals
;
7425 signal (sig
, handle_user_signal
);
7429 handle_user_signal (sig
)
7432 int old_errno
= errno
;
7433 struct user_signal_info
*p
;
7435 #if defined (USG) && !defined (POSIX_SIGNALS)
7436 /* USG systems forget handlers when they are used;
7437 must reestablish each time */
7438 signal (sig
, handle_user_signal
);
7441 SIGNAL_THREAD_CHECK (sig
);
7443 for (p
= user_signals
; p
; p
= p
->next
)
7448 if (interrupt_input
)
7449 kill (getpid (), SIGIO
);
7453 /* Tell wait_reading_process_output that it needs to wake
7454 up and look around. */
7455 if (input_available_clear_time
)
7456 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7465 find_user_signal_name (sig
)
7468 struct user_signal_info
*p
;
7470 for (p
= user_signals
; p
; p
= p
->next
)
7478 store_user_signal_events ()
7480 struct user_signal_info
*p
;
7481 struct input_event buf
;
7484 for (p
= user_signals
; p
; p
= p
->next
)
7485 if (p
->npending
> 0)
7491 bzero (&buf
, sizeof buf
);
7492 buf
.kind
= USER_SIGNAL_EVENT
;
7493 buf
.frame_or_window
= selected_frame
;
7495 nstored
+= p
->npending
;
7497 mask
= sigblock (sigmask (p
->sig
));
7501 kbd_buffer_store_event (&buf
);
7504 while (p
->npending
> 0);
7512 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7513 static Lisp_Object menu_bar_one_keymap_changed_items
;
7515 /* These variables hold the vector under construction within
7516 menu_bar_items and its subroutines, and the current index
7517 for storing into that vector. */
7518 static Lisp_Object menu_bar_items_vector
;
7519 static int menu_bar_items_index
;
7521 /* Return a vector of menu items for a menu bar, appropriate
7522 to the current buffer. Each item has three elements in the vector:
7525 OLD is an old vector we can optionally reuse, or nil. */
7528 menu_bar_items (old
)
7531 /* The number of keymaps we're scanning right now, and the number of
7532 keymaps we have allocated space for. */
7535 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7536 in the current keymaps, or nil where it is not a prefix. */
7539 Lisp_Object def
, tail
;
7548 /* In order to build the menus, we need to call the keymap
7549 accessors. They all call QUIT. But this function is called
7550 during redisplay, during which a quit is fatal. So inhibit
7551 quitting while building the menus.
7552 We do this instead of specbind because (1) errors will clear it anyway
7553 and (2) this avoids risk of specpdl overflow. */
7554 oquit
= Vinhibit_quit
;
7558 menu_bar_items_vector
= old
;
7560 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7561 menu_bar_items_index
= 0;
7563 /* Build our list of keymaps.
7564 If we recognize a function key and replace its escape sequence in
7565 keybuf with its symbol, or if the sequence starts with a mouse
7566 click and we need to switch buffers, we jump back here to rebuild
7567 the initial keymaps from the current buffer. */
7571 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7572 if (!NILP (Voverriding_local_map_menu_flag
))
7574 /* Yes, use them (if non-nil) as well as the global map. */
7575 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7577 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7578 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7579 if (!NILP (Voverriding_local_map
))
7580 maps
[nmaps
++] = Voverriding_local_map
;
7584 /* No, so use major and minor mode keymaps and keymap property.
7585 Note that menu-bar bindings in the local-map and keymap
7586 properties may not work reliable, as they are only
7587 recognized when the menu-bar (or mode-line) is updated,
7588 which does not normally happen after every command. */
7591 nminor
= current_minor_maps (NULL
, &tmaps
);
7592 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7594 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7595 maps
[nmaps
++] = tem
;
7596 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7598 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7600 maps
[nmaps
++] = current_global_map
;
7603 /* Look up in each map the dummy prefix key `menu-bar'. */
7607 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7608 if (!NILP (maps
[mapno
]))
7610 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7614 menu_bar_one_keymap_changed_items
= Qnil
;
7615 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7619 /* Move to the end those items that should be at the end. */
7621 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7624 int end
= menu_bar_items_index
;
7626 for (i
= 0; i
< end
; i
+= 4)
7627 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7629 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7630 /* Move the item at index I to the end,
7631 shifting all the others forward. */
7632 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7633 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7634 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7635 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7637 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7638 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7639 (end
- i
- 4) * sizeof (Lisp_Object
));
7640 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7641 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7642 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7643 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7648 /* Add nil, nil, nil, nil at the end. */
7649 i
= menu_bar_items_index
;
7650 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7651 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7652 /* Add this item. */
7653 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7654 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7655 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7656 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7657 menu_bar_items_index
= i
;
7659 Vinhibit_quit
= oquit
;
7660 return menu_bar_items_vector
;
7663 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7664 If there's already an item for KEY, add this DEF to it. */
7666 Lisp_Object item_properties
;
7669 menu_bar_item (key
, item
, dummy1
, dummy2
)
7670 Lisp_Object key
, item
, dummy1
;
7673 struct gcpro gcpro1
;
7677 if (EQ (item
, Qundefined
))
7679 /* If a map has an explicit `undefined' as definition,
7680 discard any previously made menu bar item. */
7682 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7683 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7685 if (menu_bar_items_index
> i
+ 4)
7686 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7687 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7688 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7689 menu_bar_items_index
-= 4;
7693 /* If this keymap has already contributed to this KEY,
7694 don't contribute to it a second time. */
7695 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7696 if (!NILP (tem
) || NILP (item
))
7699 menu_bar_one_keymap_changed_items
7700 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7702 /* We add to menu_bar_one_keymap_changed_items before doing the
7703 parse_menu_item, so that if it turns out it wasn't a menu item,
7704 it still correctly hides any further menu item. */
7706 i
= parse_menu_item (item
, 0, 1);
7711 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7713 /* Find any existing item for this KEY. */
7714 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7715 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7718 /* If we did not find this KEY, add it at the end. */
7719 if (i
== menu_bar_items_index
)
7721 /* If vector is too small, get a bigger one. */
7722 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7723 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7724 /* Add this item. */
7725 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7726 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7727 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7728 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7729 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7730 menu_bar_items_index
= i
;
7732 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7736 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7737 /* If the new and the old items are not both keymaps,
7738 the lookup will only find `item'. */
7739 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7740 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7744 /* This is used as the handler when calling menu_item_eval_property. */
7746 menu_item_eval_property_1 (arg
)
7749 /* If we got a quit from within the menu computation,
7750 quit all the way out of it. This takes care of C-] in the debugger. */
7751 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7752 Fsignal (Qquit
, Qnil
);
7757 /* Evaluate an expression and return the result (or nil if something
7758 went wrong). Used to evaluate dynamic parts of menu items. */
7760 menu_item_eval_property (sexpr
)
7763 int count
= SPECPDL_INDEX ();
7765 specbind (Qinhibit_redisplay
, Qt
);
7766 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7767 menu_item_eval_property_1
);
7768 return unbind_to (count
, val
);
7771 /* This function parses a menu item and leaves the result in the
7772 vector item_properties.
7773 ITEM is a key binding, a possible menu item.
7774 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7775 evaluate dynamic expressions in the menu item.
7776 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7778 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7779 parse_menu_item returns true if the item is a menu item and false
7783 parse_menu_item (item
, notreal
, inmenubar
)
7785 int notreal
, inmenubar
;
7787 Lisp_Object def
, tem
, item_string
, start
;
7788 Lisp_Object cachelist
;
7790 Lisp_Object keyhint
;
7801 /* Create item_properties vector if necessary. */
7802 if (NILP (item_properties
))
7804 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7806 /* Initialize optional entries. */
7807 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7808 ASET (item_properties
, i
, Qnil
);
7809 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7811 /* Save the item here to protect it from GC. */
7812 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7814 item_string
= XCAR (item
);
7818 if (STRINGP (item_string
))
7820 /* Old format menu item. */
7821 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7823 /* Maybe help string. */
7824 if (CONSP (item
) && STRINGP (XCAR (item
)))
7826 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7831 /* Maybe key binding cache. */
7832 if (CONSP (item
) && CONSP (XCAR (item
))
7833 && (NILP (XCAR (XCAR (item
)))
7834 || VECTORP (XCAR (XCAR (item
)))))
7836 cachelist
= XCAR (item
);
7840 /* This is the real definition--the function to run. */
7841 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7843 /* Get enable property, if any. */
7846 tem
= Fget (item
, Qmenu_enable
);
7847 if (!NILP (Venable_disabled_menus_and_buttons
))
7848 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7849 else if (!NILP (tem
))
7850 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7853 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7855 /* New format menu item. */
7856 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7857 start
= XCDR (item
);
7860 /* We have a real binding. */
7861 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7863 item
= XCDR (start
);
7864 /* Is there a cache list with key equivalences. */
7865 if (CONSP (item
) && CONSP (XCAR (item
)))
7867 cachelist
= XCAR (item
);
7871 /* Parse properties. */
7872 while (CONSP (item
) && CONSP (XCDR (item
)))
7877 if (EQ (tem
, QCenable
))
7879 if (!NILP (Venable_disabled_menus_and_buttons
))
7880 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7882 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7884 else if (EQ (tem
, QCvisible
) && !notreal
)
7886 /* If got a visible property and that evaluates to nil
7887 then ignore this item. */
7888 tem
= menu_item_eval_property (XCAR (item
));
7892 else if (EQ (tem
, QChelp
))
7893 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7894 else if (EQ (tem
, QCfilter
))
7896 else if (EQ (tem
, QCkey_sequence
))
7899 if (NILP (cachelist
)
7900 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7901 /* Be GC protected. Set keyhint to item instead of tem. */
7904 else if (EQ (tem
, QCkeys
))
7907 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7908 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7910 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7915 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7917 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7919 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7925 else if (inmenubar
|| !NILP (start
))
7929 return 0; /* not a menu item */
7931 /* If item string is not a string, evaluate it to get string.
7932 If we don't get a string, skip this item. */
7933 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7934 if (!(STRINGP (item_string
) || notreal
))
7936 item_string
= menu_item_eval_property (item_string
);
7937 if (!STRINGP (item_string
))
7939 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7942 /* If got a filter apply it on definition. */
7943 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7946 def
= menu_item_eval_property (list2 (XCAR (filter
),
7947 list2 (Qquote
, def
)));
7949 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7952 /* Enable or disable selection of item. */
7953 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7959 tem
= menu_item_eval_property (tem
);
7960 if (inmenubar
&& NILP (tem
))
7961 return 0; /* Ignore disabled items in menu bar. */
7962 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7965 /* If we got no definition, this item is just unselectable text which
7966 is OK in a submenu but not in the menubar. */
7968 return (inmenubar
? 0 : 1);
7970 /* See if this is a separate pane or a submenu. */
7971 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7972 tem
= get_keymap (def
, 0, 1);
7973 /* For a subkeymap, just record its details and exit. */
7976 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7977 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7981 /* At the top level in the menu bar, do likewise for commands also.
7982 The menu bar does not display equivalent key bindings anyway.
7983 ITEM_PROPERTY_DEF is already set up properly. */
7987 /* This is a command. See if there is an equivalent key binding. */
7988 if (NILP (cachelist
))
7990 /* We have to create a cachelist. */
7991 CHECK_IMPURE (start
);
7992 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7993 cachelist
= XCAR (XCDR (start
));
7995 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7996 if (!NILP (keyhint
))
7998 XSETCAR (cachelist
, XCAR (keyhint
));
8001 else if (STRINGP (tem
))
8003 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
8004 XSETCAR (cachelist
, Qt
);
8008 tem
= XCAR (cachelist
);
8015 tem
= Fkey_binding (tem
, Qnil
, Qnil
, Qnil
);
8017 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
8020 def
= XCAR (prefix
);
8021 prefix
= XCDR (prefix
);
8024 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8026 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
8028 if (newcache
/* Always check first time. */
8029 /* Should we check everything when precomputing key
8031 /* If something had no key binding before, don't recheck it
8032 because that is too slow--except if we have a list of
8033 rebound commands in Vdefine_key_rebound_commands, do
8034 recheck any command that appears in that list. */
8035 || (CONSP (Vdefine_key_rebound_commands
)
8036 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
8039 /* We had a saved key. Is it still bound to the command? */
8042 /* If the command is an alias for another
8043 (such as lmenu.el set it up), check if the
8044 original command matches the cached command. */
8045 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
8046 chkcache
= 1; /* Need to recompute key binding. */
8050 /* Recompute equivalent key binding. If the command is an alias
8051 for another (such as lmenu.el set it up), see if the original
8052 command name has equivalent keys. Otherwise look up the
8053 specified command itself. We don't try both, because that
8054 makes lmenu menus slow. */
8056 && SYMBOLP (XSYMBOL (def
)->function
)
8057 && ! NILP (Fget (def
, Qmenu_alias
)))
8058 def
= XSYMBOL (def
)->function
;
8059 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
8060 XSETCAR (cachelist
, tem
);
8063 XSETCDR (cachelist
, Qnil
);
8067 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
8069 tem
= XCAR (cachelist
);
8073 newcache
= chkcache
;
8076 tem
= Fkey_description (tem
, Qnil
);
8079 if (STRINGP (XCAR (prefix
)))
8080 tem
= concat2 (XCAR (prefix
), tem
);
8081 if (STRINGP (XCDR (prefix
)))
8082 tem
= concat2 (tem
, XCDR (prefix
));
8084 XSETCDR (cachelist
, tem
);
8088 tem
= XCDR (cachelist
);
8089 if (newcache
&& !NILP (tem
))
8091 tem
= concat2 (build_string (" "), tem
);
8092 // tem = concat3 (build_string (" ("), tem, build_string (")"));
8093 XSETCDR (cachelist
, tem
);
8096 /* If we only want to precompute equivalent key bindings, stop here. */
8100 /* If we have an equivalent key binding, use that. */
8101 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
8103 /* Include this when menu help is implemented.
8104 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
8105 if (!(NILP (tem) || STRINGP (tem)))
8107 tem = menu_item_eval_property (tem);
8110 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8114 /* Handle radio buttons or toggle boxes. */
8115 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8117 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8118 menu_item_eval_property (tem
));
8125 /***********************************************************************
8127 ***********************************************************************/
8129 /* A vector holding tool bar items while they are parsed in function
8130 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8133 static Lisp_Object tool_bar_items_vector
;
8135 /* A vector holding the result of parse_tool_bar_item. Layout is like
8136 the one for a single item in tool_bar_items_vector. */
8138 static Lisp_Object tool_bar_item_properties
;
8140 /* Next free index in tool_bar_items_vector. */
8142 static int ntool_bar_items
;
8144 /* The symbols `tool-bar', `:image' and `:rtl'. */
8146 extern Lisp_Object Qtool_bar
;
8147 Lisp_Object QCimage
;
8150 /* Function prototypes. */
8152 static void init_tool_bar_items
P_ ((Lisp_Object
));
8153 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
8154 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
8155 static void append_tool_bar_item
P_ ((void));
8158 /* Return a vector of tool bar items for keymaps currently in effect.
8159 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8160 tool bar items found. */
8163 tool_bar_items (reuse
, nitems
)
8174 /* In order to build the menus, we need to call the keymap
8175 accessors. They all call QUIT. But this function is called
8176 during redisplay, during which a quit is fatal. So inhibit
8177 quitting while building the menus. We do this instead of
8178 specbind because (1) errors will clear it anyway and (2) this
8179 avoids risk of specpdl overflow. */
8180 oquit
= Vinhibit_quit
;
8183 /* Initialize tool_bar_items_vector and protect it from GC. */
8184 init_tool_bar_items (reuse
);
8186 /* Build list of keymaps in maps. Set nmaps to the number of maps
8189 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8190 if (!NILP (Voverriding_local_map_menu_flag
))
8192 /* Yes, use them (if non-nil) as well as the global map. */
8193 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8195 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8196 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8197 if (!NILP (Voverriding_local_map
))
8198 maps
[nmaps
++] = Voverriding_local_map
;
8202 /* No, so use major and minor mode keymaps and keymap property.
8203 Note that tool-bar bindings in the local-map and keymap
8204 properties may not work reliable, as they are only
8205 recognized when the tool-bar (or mode-line) is updated,
8206 which does not normally happen after every command. */
8209 nminor
= current_minor_maps (NULL
, &tmaps
);
8210 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8212 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8213 maps
[nmaps
++] = tem
;
8214 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
8216 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8219 /* Add global keymap at the end. */
8220 maps
[nmaps
++] = current_global_map
;
8222 /* Process maps in reverse order and look up in each map the prefix
8224 for (i
= nmaps
- 1; i
>= 0; --i
)
8225 if (!NILP (maps
[i
]))
8229 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8231 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8234 Vinhibit_quit
= oquit
;
8235 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8236 return tool_bar_items_vector
;
8240 /* Process the definition of KEY which is DEF. */
8243 process_tool_bar_item (key
, def
, data
, args
)
8244 Lisp_Object key
, def
, data
;
8248 extern Lisp_Object Qundefined
;
8249 struct gcpro gcpro1
, gcpro2
;
8251 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8255 if (EQ (def
, Qundefined
))
8257 /* If a map has an explicit `undefined' as definition,
8258 discard any previously made item. */
8259 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8261 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8263 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8265 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8266 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
8267 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8268 * sizeof (Lisp_Object
)));
8269 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8274 else if (parse_tool_bar_item (key
, def
))
8275 /* Append a new tool bar item to tool_bar_items_vector. Accept
8276 more than one definition for the same key. */
8277 append_tool_bar_item ();
8283 /* Parse a tool bar item specification ITEM for key KEY and return the
8284 result in tool_bar_item_properties. Value is zero if ITEM is
8287 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8289 CAPTION is the caption of the item, If it's not a string, it is
8290 evaluated to get a string.
8292 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8293 as binding are currently ignored.
8295 The following properties are recognized:
8299 FORM is evaluated and specifies whether the tool bar item is
8300 enabled or disabled.
8304 FORM is evaluated and specifies whether the tool bar item is visible.
8306 - `:filter FUNCTION'
8308 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8309 result is stored as the new binding.
8311 - `:button (TYPE SELECTED)'
8313 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8314 and specifies whether the button is selected (pressed) or not.
8318 IMAGES is either a single image specification or a vector of four
8319 image specifications. See enum tool_bar_item_images.
8321 - `:help HELP-STRING'.
8323 Gives a help string to display for the tool bar item. */
8326 parse_tool_bar_item (key
, item
)
8327 Lisp_Object key
, item
;
8329 /* Access slot with index IDX of vector tool_bar_item_properties. */
8330 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8332 Lisp_Object filter
= Qnil
;
8333 Lisp_Object caption
;
8336 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8337 Rule out items that aren't lists, don't start with
8338 `menu-item' or whose rest following `tool-bar-item' is not a
8341 || !EQ (XCAR (item
), Qmenu_item
)
8342 || (item
= XCDR (item
),
8346 /* Create tool_bar_item_properties vector if necessary. Reset it to
8348 if (VECTORP (tool_bar_item_properties
))
8350 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8354 tool_bar_item_properties
8355 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8358 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8359 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8361 /* Get the caption of the item. If the caption is not a string,
8362 evaluate it to get a string. If we don't get a string, skip this
8364 caption
= XCAR (item
);
8365 if (!STRINGP (caption
))
8367 caption
= menu_item_eval_property (caption
);
8368 if (!STRINGP (caption
))
8371 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8373 /* Give up if rest following the caption is not a list. */
8378 /* Store the binding. */
8379 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8382 /* Ignore cached key binding, if any. */
8383 if (CONSP (item
) && CONSP (XCAR (item
)))
8386 /* Process the rest of the properties. */
8387 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8389 Lisp_Object key
, value
;
8392 value
= XCAR (XCDR (item
));
8394 if (EQ (key
, QCenable
))
8396 /* `:enable FORM'. */
8397 if (!NILP (Venable_disabled_menus_and_buttons
))
8398 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8400 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8402 else if (EQ (key
, QCvisible
))
8404 /* `:visible FORM'. If got a visible property and that
8405 evaluates to nil then ignore this item. */
8406 if (NILP (menu_item_eval_property (value
)))
8409 else if (EQ (key
, QChelp
))
8410 /* `:help HELP-STRING'. */
8411 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8412 else if (EQ (key
, QCfilter
))
8413 /* ':filter FORM'. */
8415 else if (EQ (key
, QCbutton
) && CONSP (value
))
8417 /* `:button (TYPE . SELECTED)'. */
8418 Lisp_Object type
, selected
;
8420 type
= XCAR (value
);
8421 selected
= XCDR (value
);
8422 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8424 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8425 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8428 else if (EQ (key
, QCimage
)
8430 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8431 /* Value is either a single image specification or a vector
8432 of 4 such specifications for the different button states. */
8433 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8434 else if (EQ (key
, Qrtl
))
8436 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8439 /* If got a filter apply it on binding. */
8441 PROP (TOOL_BAR_ITEM_BINDING
)
8442 = menu_item_eval_property (list2 (filter
,
8444 PROP (TOOL_BAR_ITEM_BINDING
))));
8446 /* See if the binding is a keymap. Give up if it is. */
8447 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8450 /* Enable or disable selection of item. */
8451 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8452 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8453 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8455 /* Handle radio buttons or toggle boxes. */
8456 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8457 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8458 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8466 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8467 that can be reused. */
8470 init_tool_bar_items (reuse
)
8473 if (VECTORP (reuse
))
8474 tool_bar_items_vector
= reuse
;
8476 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8477 ntool_bar_items
= 0;
8481 /* Append parsed tool bar item properties from
8482 tool_bar_item_properties */
8485 append_tool_bar_item ()
8487 Lisp_Object
*to
, *from
;
8489 /* Enlarge tool_bar_items_vector if necessary. */
8490 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8491 >= XVECTOR (tool_bar_items_vector
)->size
)
8492 tool_bar_items_vector
8493 = larger_vector (tool_bar_items_vector
,
8494 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8496 /* Append entries from tool_bar_item_properties to the end of
8497 tool_bar_items_vector. */
8498 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8499 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8500 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8501 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8508 /* Read a character using menus based on maps in the array MAPS.
8509 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8510 Return t if we displayed a menu but the user rejected it.
8512 PREV_EVENT is the previous input event, or nil if we are reading
8513 the first event of a key sequence.
8515 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8516 if we used a mouse menu to read the input, or zero otherwise. If
8517 USED_MOUSE_MENU is null, we don't dereference it.
8519 The prompting is done based on the prompt-string of the map
8520 and the strings associated with various map elements.
8522 This can be done with X menus or with menus put in the minibuf.
8523 These are done in different ways, depending on how the input will be read.
8524 Menus using X are done after auto-saving in read-char, getting the input
8525 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8526 and do auto-saving in the inner call of read_char. */
8529 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8532 Lisp_Object prev_event
;
8533 int *used_mouse_menu
;
8536 register Lisp_Object name
= Qnil
;
8538 if (used_mouse_menu
)
8539 *used_mouse_menu
= 0;
8541 /* Use local over global Menu maps */
8543 if (! menu_prompting
)
8546 /* Optionally disregard all but the global map. */
8547 if (inhibit_local_menu_bar_menus
)
8549 maps
+= (nmaps
- 1);
8553 /* Get the menu name from the first map that has one (a prompt string). */
8554 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8556 name
= Fkeymap_prompt (maps
[mapno
]);
8561 /* If we don't have any menus, just read a character normally. */
8562 if (!STRINGP (name
))
8566 /* If we got to this point via a mouse click,
8567 use a real menu for mouse selection. */
8568 if (EVENT_HAS_PARAMETERS (prev_event
)
8569 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8570 && !EQ (XCAR (prev_event
), Qtool_bar
))
8572 /* Display the menu and get the selection. */
8573 Lisp_Object
*realmaps
8574 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8578 /* Use the maps that are not nil. */
8579 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8580 if (!NILP (maps
[mapno
]))
8581 realmaps
[nmaps1
++] = maps
[mapno
];
8583 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8588 record_menu_key (XCAR (value
));
8590 /* If we got multiple events, unread all but
8592 There is no way to prevent those unread events
8593 from showing up later in last_nonmenu_event.
8594 So turn symbol and integer events into lists,
8595 to indicate that they came from a mouse menu,
8596 so that when present in last_nonmenu_event
8597 they won't confuse things. */
8598 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8600 record_menu_key (XCAR (tem
));
8601 if (SYMBOLP (XCAR (tem
))
8602 || INTEGERP (XCAR (tem
)))
8603 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8606 /* If we got more than one event, put all but the first
8607 onto this list to be read later.
8608 Return just the first event now. */
8609 Vunread_command_events
8610 = nconc2 (XCDR (value
), Vunread_command_events
);
8611 value
= XCAR (value
);
8613 else if (NILP (value
))
8615 if (used_mouse_menu
)
8616 *used_mouse_menu
= 1;
8619 #endif /* HAVE_MENUS */
8623 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8624 We make this bigger when necessary, and never free it. */
8625 static char *read_char_minibuf_menu_text
;
8626 /* Size of that buffer. */
8627 static int read_char_minibuf_menu_width
;
8630 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8636 register Lisp_Object name
;
8638 /* FIXME: Use the minibuffer's frame width. */
8639 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8642 Lisp_Object rest
, vector
;
8648 if (! menu_prompting
)
8651 /* Make sure we have a big enough buffer for the menu text. */
8652 if (read_char_minibuf_menu_text
== 0)
8654 read_char_minibuf_menu_width
= width
+ 4;
8655 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8657 else if (width
+ 4 > read_char_minibuf_menu_width
)
8659 read_char_minibuf_menu_width
= width
+ 4;
8660 read_char_minibuf_menu_text
8661 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8663 menu
= read_char_minibuf_menu_text
;
8665 /* Get the menu name from the first map that has one (a prompt string). */
8666 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8668 name
= Fkeymap_prompt (maps
[mapno
]);
8673 /* If we don't have any menus, just read a character normally. */
8674 if (!STRINGP (name
))
8677 /* Prompt string always starts with map's prompt, and a space. */
8678 strcpy (menu
, SDATA (name
));
8679 nlength
= SBYTES (name
);
8680 menu
[nlength
++] = ':';
8681 menu
[nlength
++] = ' ';
8684 /* Start prompting at start of first map. */
8688 /* Present the documented bindings, a line at a time. */
8695 Lisp_Object orig_defn_macro
;
8697 /* Loop over elements of map. */
8702 /* If reached end of map, start at beginning of next map. */
8706 /* At end of last map, wrap around to first map if just starting,
8707 or end this line if already have something on it. */
8711 if (notfirst
|| nobindings
) break;
8716 /* Look at the next element of the map. */
8718 elt
= XVECTOR (vector
)->contents
[idx
];
8720 elt
= Fcar_safe (rest
);
8722 if (idx
< 0 && VECTORP (elt
))
8724 /* If we found a dense table in the keymap,
8725 advanced past it, but start scanning its contents. */
8726 rest
= Fcdr_safe (rest
);
8732 /* An ordinary element. */
8733 Lisp_Object event
, tem
;
8737 event
= Fcar_safe (elt
); /* alist */
8738 elt
= Fcdr_safe (elt
);
8742 XSETINT (event
, idx
); /* vector */
8745 /* Ignore the element if it has no prompt string. */
8746 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8748 /* 1 if the char to type matches the string. */
8750 Lisp_Object upcased_event
, downcased_event
;
8751 Lisp_Object desc
= Qnil
;
8753 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8755 upcased_event
= Fupcase (event
);
8756 downcased_event
= Fdowncase (event
);
8757 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8758 || XINT (downcased_event
) == SREF (s
, 0));
8760 desc
= Fsingle_key_description (event
, Qnil
);
8762 #if 0 /* It is redundant to list the equivalent key bindings because
8763 the prefix is what the user has already typed. */
8765 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8767 /* Insert equivalent keybinding. */
8768 s
= concat2 (s
, tem
);
8771 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8772 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8774 /* Insert button prefix. */
8775 Lisp_Object selected
8776 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8777 if (EQ (tem
, QCradio
))
8778 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8780 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8781 s
= concat2 (tem
, s
);
8785 /* If we have room for the prompt string, add it to this line.
8786 If this is the first on the line, always add it. */
8787 if ((SCHARS (s
) + i
+ 2
8788 + (char_matches
? 0 : SCHARS (desc
) + 3))
8794 /* Punctuate between strings. */
8797 strcpy (menu
+ i
, ", ");
8803 /* If the char to type doesn't match the string's
8804 first char, explicitly show what char to type. */
8807 /* Add as much of string as fits. */
8808 thiswidth
= SCHARS (desc
);
8809 if (thiswidth
+ i
> width
)
8810 thiswidth
= width
- i
;
8811 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8813 strcpy (menu
+ i
, " = ");
8817 /* Add as much of string as fits. */
8818 thiswidth
= SCHARS (s
);
8819 if (thiswidth
+ i
> width
)
8820 thiswidth
= width
- i
;
8821 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8827 /* If this element does not fit, end the line now,
8828 and save the element for the next line. */
8829 strcpy (menu
+ i
, "...");
8834 /* Move past this element. */
8835 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8836 /* Handle reaching end of dense table. */
8841 rest
= Fcdr_safe (rest
);
8845 /* Prompt with that and read response. */
8846 message2_nolog (menu
, strlen (menu
),
8847 ! NILP (current_buffer
->enable_multibyte_characters
));
8849 /* Make believe its not a keyboard macro in case the help char
8850 is pressed. Help characters are not recorded because menu prompting
8851 is not used on replay.
8853 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8854 current_kboard
->defining_kbd_macro
= Qnil
;
8856 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8857 while (BUFFERP (obj
));
8858 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8860 if (!INTEGERP (obj
))
8862 else if (XINT (obj
) == -2)
8867 if (! EQ (obj
, menu_prompt_more_char
)
8868 && (!INTEGERP (menu_prompt_more_char
)
8869 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8871 if (!NILP (current_kboard
->defining_kbd_macro
))
8872 store_kbd_macro_char (obj
);
8875 /* Help char - go round again */
8879 /* Reading key sequences. */
8881 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8882 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8883 keymap, or nil otherwise. Return the index of the first keymap in
8884 which KEY has any binding, or NMAPS if no map has a binding.
8886 If KEY is a meta ASCII character, treat it like meta-prefix-char
8887 followed by the corresponding non-meta character. Keymaps in
8888 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8891 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8894 NEXT may be the same array as CURRENT. */
8897 follow_key (key
, nmaps
, current
, defs
, next
)
8899 Lisp_Object
*current
, *defs
, *next
;
8902 int i
, first_binding
;
8904 first_binding
= nmaps
;
8905 for (i
= nmaps
- 1; i
>= 0; i
--)
8907 if (! NILP (current
[i
]))
8909 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8910 if (! NILP (defs
[i
]))
8917 /* Given the set of bindings we've found, produce the next set of maps. */
8918 if (first_binding
< nmaps
)
8919 for (i
= 0; i
< nmaps
; i
++)
8920 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8922 return first_binding
;
8925 /* Structure used to keep track of partial application of key remapping
8926 such as Vfunction_key_map and Vkey_translation_map. */
8927 typedef struct keyremap
8929 /* This is the map originally specified for this use. */
8931 /* This is a submap reached by looking up, in PARENT,
8932 the events from START to END. */
8934 /* Positions [START, END) in the key sequence buffer
8935 are the key that we have scanned so far.
8936 Those events are the ones that we will replace
8937 if PAREHT maps them into a key sequence. */
8941 /* Lookup KEY in MAP.
8942 MAP is a keymap mapping keys to key vectors or functions.
8943 If the mapping is a function and DO_FUNCTION is non-zero, then
8944 the function is called with PROMPT as parameter and its return
8945 value is used as the return value of this function (after checking
8946 that it is indeed a vector). */
8949 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8950 Lisp_Object map
, key
, prompt
;
8955 next
= access_keymap (map
, key
, 1, 0, 1);
8957 /* Handle symbol with autoload definition. */
8958 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8959 && CONSP (XSYMBOL (next
)->function
)
8960 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8961 do_autoload (XSYMBOL (next
)->function
, next
);
8963 /* Handle a symbol whose function definition is a keymap
8965 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8966 && (ARRAYP (XSYMBOL (next
)->function
)
8967 || KEYMAPP (XSYMBOL (next
)->function
)))
8968 next
= XSYMBOL (next
)->function
;
8970 /* If the keymap gives a function, not an
8971 array, then call the function with one arg and use
8972 its value instead. */
8973 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8978 next
= call1 (next
, prompt
);
8979 /* If the function returned something invalid,
8980 barf--don't ignore it.
8981 (To ignore it safely, we would need to gcpro a bunch of
8982 other variables.) */
8983 if (! (VECTORP (next
) || STRINGP (next
)))
8984 error ("Function %s returns invalid key sequence", tem
);
8989 /* Do one step of the key remapping used for function-key-map and
8990 key-translation-map:
8991 KEYBUF is the buffer holding the input events.
8992 BUFSIZE is its maximum size.
8993 FKEY is a pointer to the keyremap structure to use.
8994 INPUT is the index of the last element in KEYBUF.
8995 DOIT if non-zero says that the remapping can actually take place.
8996 DIFF is used to return the number of keys added/removed by the remapping.
8997 PARENT is the root of the keymap.
8998 PROMPT is the prompt to use if the remapping happens through a function.
8999 The return value is non-zero if the remapping actually took place. */
9002 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
9003 Lisp_Object
*keybuf
, prompt
;
9005 int input
, doit
, *diff
, bufsize
;
9007 Lisp_Object next
, key
;
9009 key
= keybuf
[fkey
->end
++];
9011 if (KEYMAPP (fkey
->parent
))
9012 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
9016 /* If keybuf[fkey->start..fkey->end] is bound in the
9017 map and we're in a position to do the key remapping, replace it with
9018 the binding and restart with fkey->start at the end. */
9019 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
9021 int len
= XFASTINT (Flength (next
));
9024 *diff
= len
- (fkey
->end
- fkey
->start
);
9026 if (input
+ *diff
>= bufsize
)
9027 error ("Key sequence too long");
9029 /* Shift the keys that follow fkey->end. */
9031 for (i
= fkey
->end
; i
< input
; i
++)
9032 keybuf
[i
+ *diff
] = keybuf
[i
];
9034 for (i
= input
- 1; i
>= fkey
->end
; i
--)
9035 keybuf
[i
+ *diff
] = keybuf
[i
];
9036 /* Overwrite the old keys with the new ones. */
9037 for (i
= 0; i
< len
; i
++)
9038 keybuf
[fkey
->start
+ i
]
9039 = Faref (next
, make_number (i
));
9041 fkey
->start
= fkey
->end
+= *diff
;
9042 fkey
->map
= fkey
->parent
;
9047 fkey
->map
= get_keymap (next
, 0, 1);
9049 /* If we no longer have a bound suffix, try a new position for
9051 if (!CONSP (fkey
->map
))
9053 fkey
->end
= ++fkey
->start
;
9054 fkey
->map
= fkey
->parent
;
9059 /* Read a sequence of keys that ends with a non prefix character,
9060 storing it in KEYBUF, a buffer of size BUFSIZE.
9062 Return the length of the key sequence stored.
9063 Return -1 if the user rejected a command menu.
9065 Echo starting immediately unless `prompt' is 0.
9067 Where a key sequence ends depends on the currently active keymaps.
9068 These include any minor mode keymaps active in the current buffer,
9069 the current buffer's local map, and the global map.
9071 If a key sequence has no other bindings, we check Vfunction_key_map
9072 to see if some trailing subsequence might be the beginning of a
9073 function key's sequence. If so, we try to read the whole function
9074 key, and substitute its symbolic name into the key sequence.
9076 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9077 `double-' events into similar click events, if that would make them
9078 bound. We try to turn `triple-' events first into `double-' events,
9081 If we get a mouse click in a mode line, vertical divider, or other
9082 non-text area, we treat the click as if it were prefixed by the
9083 symbol denoting that area - `mode-line', `vertical-line', or
9086 If the sequence starts with a mouse click, we read the key sequence
9087 with respect to the buffer clicked on, not the current buffer.
9089 If the user switches frames in the midst of a key sequence, we put
9090 off the switch-frame event until later; the next call to
9091 read_char will return it.
9093 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9094 from the selected window's buffer. */
9097 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
9098 can_return_switch_frame
, fix_current_buffer
)
9099 Lisp_Object
*keybuf
;
9102 int dont_downcase_last
;
9103 int can_return_switch_frame
;
9104 int fix_current_buffer
;
9106 volatile Lisp_Object from_string
;
9107 volatile int count
= SPECPDL_INDEX ();
9109 /* How many keys there are in the current key sequence. */
9112 /* The length of the echo buffer when we started reading, and
9113 the length of this_command_keys when we started reading. */
9114 volatile int echo_start
;
9115 volatile int keys_start
;
9117 /* The number of keymaps we're scanning right now, and the number of
9118 keymaps we have allocated space for. */
9120 volatile int nmaps_allocated
= 0;
9122 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9123 the current keymaps. */
9124 Lisp_Object
*volatile defs
= NULL
;
9126 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9127 in the current keymaps, or nil where it is not a prefix. */
9128 Lisp_Object
*volatile submaps
= NULL
;
9130 /* The local map to start out with at start of key sequence. */
9131 volatile Lisp_Object orig_local_map
;
9133 /* The map from the `keymap' property to start out with at start of
9135 volatile Lisp_Object orig_keymap
;
9137 /* 1 if we have already considered switching to the local-map property
9138 of the place where a mouse click occurred. */
9139 volatile int localized_local_map
= 0;
9141 /* The index in submaps[] of the first keymap that has a binding for
9142 this key sequence. In other words, the lowest i such that
9143 submaps[i] is non-nil. */
9144 volatile int first_binding
;
9145 /* Index of the first key that has no binding.
9146 It is useless to try fkey.start larger than that. */
9147 volatile int first_unbound
;
9149 /* If t < mock_input, then KEYBUF[t] should be read as the next
9152 We use this to recover after recognizing a function key. Once we
9153 realize that a suffix of the current key sequence is actually a
9154 function key's escape sequence, we replace the suffix with the
9155 function key's binding from Vfunction_key_map. Now keybuf
9156 contains a new and different key sequence, so the echo area,
9157 this_command_keys, and the submaps and defs arrays are wrong. In
9158 this situation, we set mock_input to t, set t to 0, and jump to
9159 restart_sequence; the loop will read keys from keybuf up until
9160 mock_input, thus rebuilding the state; and then it will resume
9161 reading characters from the keyboard. */
9162 volatile int mock_input
= 0;
9164 /* If the sequence is unbound in submaps[], then
9165 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9166 and fkey.map is its binding.
9168 These might be > t, indicating that all function key scanning
9169 should hold off until t reaches them. We do this when we've just
9170 recognized a function key, to avoid searching for the function
9171 key's again in Vfunction_key_map. */
9172 volatile keyremap fkey
;
9174 /* Likewise, for key_translation_map and input-decode-map. */
9175 volatile keyremap keytran
, indec
;
9177 /* Non-zero if we are trying to map a key by changing an upper-case
9178 letter to lower case, or a shifted function key to an unshifted
9180 volatile int shift_translated
= 0;
9182 /* If we receive a `switch-frame' or `select-window' event in the middle of
9183 a key sequence, we put it off for later.
9184 While we're reading, we keep the event here. */
9185 volatile Lisp_Object delayed_switch_frame
;
9187 /* See the comment below... */
9188 #if defined (GOBBLE_FIRST_EVENT)
9189 Lisp_Object first_event
;
9192 volatile Lisp_Object original_uppercase
;
9193 volatile int original_uppercase_position
= -1;
9195 /* Gets around Microsoft compiler limitations. */
9198 struct buffer
*starting_buffer
;
9200 /* List of events for which a fake prefix key has been generated. */
9201 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
9203 #if defined (GOBBLE_FIRST_EVENT)
9207 struct gcpro gcpro1
;
9209 GCPRO1 (fake_prefixed_keys
);
9210 raw_keybuf_count
= 0;
9212 last_nonmenu_event
= Qnil
;
9214 delayed_switch_frame
= Qnil
;
9219 echo_prompt (prompt
);
9220 else if (cursor_in_echo_area
9221 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9222 && NILP (Fzerop (Vecho_keystrokes
)))
9223 /* This doesn't put in a dash if the echo buffer is empty, so
9224 you don't always see a dash hanging out in the minibuffer. */
9228 /* Record the initial state of the echo area and this_command_keys;
9229 we will need to restore them if we replay a key sequence. */
9231 echo_start
= echo_length ();
9232 keys_start
= this_command_key_count
;
9233 this_single_command_key_start
= keys_start
;
9235 #if defined (GOBBLE_FIRST_EVENT)
9236 /* This doesn't quite work, because some of the things that read_char
9237 does cannot safely be bypassed. It seems too risky to try to make
9240 /* Read the first char of the sequence specially, before setting
9241 up any keymaps, in case a filter runs and switches buffers on us. */
9242 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9244 #endif /* GOBBLE_FIRST_EVENT */
9246 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9247 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9250 /* The multi-tty merge moved the code below to right after
9251 `replay_sequence' which caused all these translation maps to be applied
9252 repeatedly, even tho their doc says very clearly they are not applied to
9254 The reason for this move was: "We may switch keyboards between rescans,
9255 so we need to reinitialize fkey and keytran before each replay".
9256 This move was wrong (even if we switch keyboards, keybuf still holds the
9257 keys we've read already from the original keyboard and some of those keys
9258 may have already been translated). So there may still be a bug out there
9260 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9261 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9262 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9263 indec
.start
= indec
.end
= 0;
9264 fkey
.start
= fkey
.end
= 0;
9265 keytran
.start
= keytran
.end
= 0;
9267 /* We jump here when the key sequence has been thoroughly changed, and
9268 we need to rescan it starting from the beginning. When we jump here,
9269 keybuf[0..mock_input] holds the sequence we should reread. */
9272 starting_buffer
= current_buffer
;
9273 first_unbound
= bufsize
+ 1;
9275 /* Build our list of keymaps.
9276 If we recognize a function key and replace its escape sequence in
9277 keybuf with its symbol, or if the sequence starts with a mouse
9278 click and we need to switch buffers, we jump back here to rebuild
9279 the initial keymaps from the current buffer. */
9282 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9284 if (2 > nmaps_allocated
)
9286 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9287 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9288 nmaps_allocated
= 2;
9290 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9292 else if (!NILP (Voverriding_local_map
))
9294 if (2 > nmaps_allocated
)
9296 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9297 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9298 nmaps_allocated
= 2;
9300 submaps
[nmaps
++] = Voverriding_local_map
;
9308 nminor
= current_minor_maps (0, &maps
);
9309 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9311 if (total
> nmaps_allocated
)
9313 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9314 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9315 nmaps_allocated
= total
;
9318 if (!NILP (orig_keymap
))
9319 submaps
[nmaps
++] = orig_keymap
;
9321 bcopy (maps
, (void *) (submaps
+ nmaps
),
9322 nminor
* sizeof (submaps
[0]));
9326 submaps
[nmaps
++] = orig_local_map
;
9328 submaps
[nmaps
++] = current_global_map
;
9330 /* Find an accurate initial value for first_binding. */
9331 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9332 if (! NILP (submaps
[first_binding
]))
9335 /* Start from the beginning in keybuf. */
9338 /* These are no-ops the first time through, but if we restart, they
9339 revert the echo area and this_command_keys to their original state. */
9340 this_command_key_count
= keys_start
;
9341 if (INTERACTIVE
&& t
< mock_input
)
9342 echo_truncate (echo_start
);
9344 /* If the best binding for the current key sequence is a keymap, or
9345 we may be looking at a function key's escape sequence, keep on
9347 while (first_binding
< nmaps
9348 /* Keep reading as long as there's a prefix binding. */
9349 ? !NILP (submaps
[first_binding
])
9350 /* Don't return in the middle of a possible function key sequence,
9351 if the only bindings we found were via case conversion.
9352 Thus, if ESC O a has a function-key-map translation
9353 and ESC o has a binding, don't return after ESC O,
9354 so that we can translate ESC O plus the next character. */
9355 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9358 int used_mouse_menu
= 0;
9360 /* Where the last real key started. If we need to throw away a
9361 key that has expanded into more than one element of keybuf
9362 (say, a mouse click on the mode line which is being treated
9363 as [mode-line (mouse-...)], then we backtrack to this point
9365 volatile int last_real_key_start
;
9367 /* These variables are analogous to echo_start and keys_start;
9368 while those allow us to restart the entire key sequence,
9369 echo_local_start and keys_local_start allow us to throw away
9371 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9373 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9374 eassert (indec
.start
<= indec
.end
);
9375 eassert (fkey
.start
<= fkey
.end
);
9376 eassert (keytran
.start
<= keytran
.end
);
9377 /* key-translation-map is applied *after* function-key-map
9378 which is itself applied *after* input-decode-map. */
9379 eassert (fkey
.end
<= indec
.start
);
9380 eassert (keytran
.end
<= fkey
.start
);
9382 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9383 first_unbound
< keytran
.start
)
9384 { /* The prefix upto first_unbound has no binding and has
9385 no translation left to do either, so we know it's unbound.
9386 If we don't stop now, we risk staying here indefinitely
9387 (if the user keeps entering fkey or keytran prefixes
9388 like C-c ESC ESC ESC ESC ...) */
9390 for (i
= first_unbound
+ 1; i
< t
; i
++)
9391 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9392 mock_input
= t
- first_unbound
- 1;
9393 indec
.end
= indec
.start
-= first_unbound
+ 1;
9394 indec
.map
= indec
.parent
;
9395 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9396 fkey
.map
= fkey
.parent
;
9397 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9398 keytran
.map
= keytran
.parent
;
9399 goto replay_sequence
;
9403 error ("Key sequence too long");
9406 echo_local_start
= echo_length ();
9407 keys_local_start
= this_command_key_count
;
9408 local_first_binding
= first_binding
;
9411 /* These are no-ops, unless we throw away a keystroke below and
9412 jumped back up to replay_key; in that case, these restore the
9413 variables to their original state, allowing us to replay the
9415 if (INTERACTIVE
&& t
< mock_input
)
9416 echo_truncate (echo_local_start
);
9417 this_command_key_count
= keys_local_start
;
9418 first_binding
= local_first_binding
;
9420 /* By default, assume each event is "real". */
9421 last_real_key_start
= t
;
9423 /* Does mock_input indicate that we are re-reading a key sequence? */
9427 add_command_key (key
);
9428 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9429 && NILP (Fzerop (Vecho_keystrokes
)))
9433 /* If not, we should actually read a character. */
9438 KBOARD
*interrupted_kboard
= current_kboard
;
9439 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9441 key
= read_char (NILP (prompt
), nmaps
,
9442 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9443 &used_mouse_menu
, NULL
);
9445 if (INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9450 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9451 if (k
== interrupted_kboard
)
9456 /* Don't touch interrupted_kboard when it's been
9458 delayed_switch_frame
= Qnil
;
9459 goto replay_sequence
;
9462 if (!NILP (delayed_switch_frame
))
9464 interrupted_kboard
->kbd_queue
9465 = Fcons (delayed_switch_frame
,
9466 interrupted_kboard
->kbd_queue
);
9467 delayed_switch_frame
= Qnil
;
9471 interrupted_kboard
->kbd_queue
9472 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9474 /* If the side queue is non-empty, ensure it begins with a
9475 switch-frame, so we'll replay it in the right context. */
9476 if (CONSP (interrupted_kboard
->kbd_queue
)
9477 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9478 !(EVENT_HAS_PARAMETERS (key
)
9479 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9483 XSETFRAME (frame
, interrupted_frame
);
9484 interrupted_kboard
->kbd_queue
9485 = Fcons (make_lispy_switch_frame (frame
),
9486 interrupted_kboard
->kbd_queue
);
9489 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9490 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9491 goto replay_sequence
;
9496 /* read_char returns t when it shows a menu and the user rejects it.
9500 unbind_to (count
, Qnil
);
9505 /* read_char returns -1 at the end of a macro.
9506 Emacs 18 handles this by returning immediately with a
9507 zero, so that's what we'll do. */
9508 if (INTEGERP (key
) && XINT (key
) == -1)
9511 /* The Microsoft C compiler can't handle the goto that
9517 /* If the current buffer has been changed from under us, the
9518 keymap may have changed, so replay the sequence. */
9521 timer_resume_idle ();
9524 /* Reset the current buffer from the selected window
9525 in case something changed the former and not the latter.
9526 This is to be more consistent with the behavior
9527 of the command_loop_1. */
9528 if (fix_current_buffer
)
9530 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9532 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9533 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9536 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9537 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9538 goto replay_sequence
;
9541 /* If we have a quit that was typed in another frame, and
9542 quit_throw_to_read_char switched buffers,
9543 replay to get the right keymap. */
9545 && XINT (key
) == quit_char
9546 && current_buffer
!= starting_buffer
)
9549 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9553 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9554 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9555 goto replay_sequence
;
9560 if (EVENT_HAS_PARAMETERS (key
)
9561 /* Either a `switch-frame' or a `select-window' event. */
9562 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9564 /* If we're at the beginning of a key sequence, and the caller
9565 says it's okay, go ahead and return this event. If we're
9566 in the midst of a key sequence, delay it until the end. */
9567 if (t
> 0 || !can_return_switch_frame
)
9569 delayed_switch_frame
= key
;
9575 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9579 /* Clicks in non-text areas get prefixed by the symbol
9580 in their CHAR-ADDRESS field. For example, a click on
9581 the mode line is prefixed by the symbol `mode-line'.
9583 Furthermore, key sequences beginning with mouse clicks
9584 are read using the keymaps of the buffer clicked on, not
9585 the current buffer. So we may have to switch the buffer
9588 When we turn one event into two events, we must make sure
9589 that neither of the two looks like the original--so that,
9590 if we replay the events, they won't be expanded again.
9591 If not for this, such reexpansion could happen either here
9592 or when user programs play with this-command-keys. */
9593 if (EVENT_HAS_PARAMETERS (key
))
9598 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9599 if (EQ (kind
, Qmouse_click
))
9601 Lisp_Object window
, posn
;
9603 window
= POSN_WINDOW (EVENT_START (key
));
9604 posn
= POSN_POSN (EVENT_START (key
));
9607 || (!NILP (fake_prefixed_keys
)
9608 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9610 /* We're looking a second time at an event for which
9611 we generated a fake prefix key. Set
9612 last_real_key_start appropriately. */
9614 last_real_key_start
= t
- 1;
9617 /* Key sequences beginning with mouse clicks are
9618 read using the keymaps in the buffer clicked on,
9619 not the current buffer. If we're at the
9620 beginning of a key sequence, switch buffers. */
9621 if (last_real_key_start
== 0
9623 && BUFFERP (XWINDOW (window
)->buffer
)
9624 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9626 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9630 /* Arrange to go back to the original buffer once we're
9631 done reading the key sequence. Note that we can't
9632 use save_excursion_{save,restore} here, because they
9633 save point as well as the current buffer; we don't
9634 want to save point, because redisplay may change it,
9635 to accommodate a Fset_window_start or something. We
9636 don't want to do this at the top of the function,
9637 because we may get input from a subprocess which
9638 wants to change the selected window and stuff (say,
9640 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9642 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9644 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9645 orig_local_map
= get_local_map (PT
, current_buffer
,
9647 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9648 goto replay_sequence
;
9651 /* For a mouse click, get the local text-property keymap
9652 of the place clicked on, rather than point. */
9653 if (last_real_key_start
== 0
9654 && CONSP (XCDR (key
))
9655 && ! localized_local_map
)
9657 Lisp_Object map_here
, start
, pos
;
9659 localized_local_map
= 1;
9660 start
= EVENT_START (key
);
9662 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9664 pos
= POSN_BUFFER_POSN (start
);
9666 && XINT (pos
) >= BEGV
9667 && XINT (pos
) <= ZV
)
9669 map_here
= get_local_map (XINT (pos
),
9670 current_buffer
, Qlocal_map
);
9671 if (!EQ (map_here
, orig_local_map
))
9673 orig_local_map
= map_here
;
9674 ++localized_local_map
;
9677 map_here
= get_local_map (XINT (pos
),
9678 current_buffer
, Qkeymap
);
9679 if (!EQ (map_here
, orig_keymap
))
9681 orig_keymap
= map_here
;
9682 ++localized_local_map
;
9685 if (localized_local_map
> 1)
9690 goto replay_sequence
;
9696 /* Expand mode-line and scroll-bar events into two events:
9697 use posn as a fake prefix key. */
9699 && (NILP (fake_prefixed_keys
)
9700 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9702 if (t
+ 1 >= bufsize
)
9703 error ("Key sequence too long");
9706 keybuf
[t
+ 1] = key
;
9709 /* Record that a fake prefix key has been generated
9710 for KEY. Don't modify the event; this would
9711 prevent proper action when the event is pushed
9712 back into unread-command-events. */
9713 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9715 /* If on a mode line string with a local keymap,
9716 reconsider the key sequence with that keymap. */
9717 if (string
= POSN_STRING (EVENT_START (key
)),
9718 (CONSP (string
) && STRINGP (XCAR (string
))))
9720 Lisp_Object pos
, map
, map2
;
9722 pos
= XCDR (string
);
9723 string
= XCAR (string
);
9725 && XINT (pos
) < SCHARS (string
))
9727 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9729 orig_local_map
= map
;
9730 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9733 if (!NILP (map
) || !NILP (map2
))
9734 goto replay_sequence
;
9740 else if (NILP (from_string
)
9741 && (string
= POSN_STRING (EVENT_START (key
)),
9742 (CONSP (string
) && STRINGP (XCAR (string
)))))
9744 /* For a click on a string, i.e. overlay string or a
9745 string displayed via the `display' property,
9746 consider `local-map' and `keymap' properties of
9748 Lisp_Object pos
, map
, map2
;
9750 pos
= XCDR (string
);
9751 string
= XCAR (string
);
9753 && XINT (pos
) < SCHARS (string
))
9755 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9757 orig_local_map
= map
;
9758 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9762 if (!NILP (map
) || !NILP (map2
))
9764 from_string
= string
;
9767 goto replay_sequence
;
9772 else if (CONSP (XCDR (key
))
9773 && CONSP (EVENT_START (key
))
9774 && CONSP (XCDR (EVENT_START (key
))))
9778 posn
= POSN_POSN (EVENT_START (key
));
9779 /* Handle menu-bar events:
9780 insert the dummy prefix event `menu-bar'. */
9781 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9783 if (t
+ 1 >= bufsize
)
9784 error ("Key sequence too long");
9788 /* Zap the position in key, so we know that we've
9789 expanded it, and don't try to do so again. */
9790 POSN_SET_POSN (EVENT_START (key
),
9791 Fcons (posn
, Qnil
));
9794 goto replay_sequence
;
9796 else if (CONSP (posn
))
9798 /* We're looking at the second event of a
9799 sequence which we expanded before. Set
9800 last_real_key_start appropriately. */
9801 if (last_real_key_start
== t
&& t
> 0)
9802 last_real_key_start
= t
- 1;
9807 /* We have finally decided that KEY is something we might want
9809 first_binding
= (follow_key (key
,
9810 nmaps
- first_binding
,
9811 submaps
+ first_binding
,
9812 defs
+ first_binding
,
9813 submaps
+ first_binding
)
9816 /* If KEY wasn't bound, we'll try some fallbacks. */
9817 if (first_binding
< nmaps
)
9818 /* This is needed for the following scenario:
9819 event 0: a down-event that gets dropped by calling replay_key.
9820 event 1: some normal prefix like C-h.
9821 After event 0, first_unbound is 0, after event 1 indec.start,
9822 fkey.start, and keytran.start are all 1, so when we see that
9823 C-h is bound, we need to update first_unbound. */
9824 first_unbound
= max (t
+ 1, first_unbound
);
9829 /* Remember the position to put an upper bound on indec.start. */
9830 first_unbound
= min (t
, first_unbound
);
9832 head
= EVENT_HEAD (key
);
9833 if (help_char_p (head
) && t
> 0)
9835 read_key_sequence_cmd
= Vprefix_help_command
;
9837 last_nonmenu_event
= key
;
9838 /* The Microsoft C compiler can't handle the goto that
9846 Lisp_Object breakdown
;
9849 breakdown
= parse_modifiers (head
);
9850 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9851 /* Attempt to reduce an unbound mouse event to a simpler
9852 event that is bound:
9853 Drags reduce to clicks.
9854 Double-clicks reduce to clicks.
9855 Triple-clicks reduce to double-clicks, then to clicks.
9856 Down-clicks are eliminated.
9857 Double-downs reduce to downs, then are eliminated.
9858 Triple-downs reduce to double-downs, then to downs,
9859 then are eliminated. */
9860 if (modifiers
& (down_modifier
| drag_modifier
9861 | double_modifier
| triple_modifier
))
9863 while (modifiers
& (down_modifier
| drag_modifier
9864 | double_modifier
| triple_modifier
))
9866 Lisp_Object new_head
, new_click
;
9867 if (modifiers
& triple_modifier
)
9868 modifiers
^= (double_modifier
| triple_modifier
);
9869 else if (modifiers
& double_modifier
)
9870 modifiers
&= ~double_modifier
;
9871 else if (modifiers
& drag_modifier
)
9872 modifiers
&= ~drag_modifier
;
9875 /* Dispose of this `down' event by simply jumping
9876 back to replay_key, to get another event.
9878 Note that if this event came from mock input,
9879 then just jumping back to replay_key will just
9880 hand it to us again. So we have to wipe out any
9883 We could delete keybuf[t] and shift everything
9884 after that to the left by one spot, but we'd also
9885 have to fix up any variable that points into
9886 keybuf, and shifting isn't really necessary
9889 Adding prefixes for non-textual mouse clicks
9890 creates two characters of mock input, and both
9891 must be thrown away. If we're only looking at
9892 the prefix now, we can just jump back to
9893 replay_key. On the other hand, if we've already
9894 processed the prefix, and now the actual click
9895 itself is giving us trouble, then we've lost the
9896 state of the keymaps we want to backtrack to, and
9897 we need to replay the whole sequence to rebuild
9900 Beyond that, only function key expansion could
9901 create more than two keys, but that should never
9902 generate mouse events, so it's okay to zero
9903 mock_input in that case too.
9905 FIXME: The above paragraph seems just plain
9906 wrong, if you consider things like
9907 xterm-mouse-mode. -stef
9909 Isn't this just the most wonderful code ever? */
9911 /* If mock_input > t + 1, the above simplification
9912 will actually end up dropping keys on the floor.
9913 This is probably OK for now, but even
9914 if mock_input <= t + 1, we need to adjust indec,
9916 Typical case [header-line down-mouse-N]:
9917 mock_input = 2, t = 1, fkey.end = 1,
9918 last_real_key_start = 0. */
9919 if (indec
.end
> last_real_key_start
)
9921 indec
.end
= indec
.start
9922 = min (last_real_key_start
, indec
.start
);
9923 indec
.map
= indec
.parent
;
9924 if (fkey
.end
> last_real_key_start
)
9926 fkey
.end
= fkey
.start
9927 = min (last_real_key_start
, fkey
.start
);
9928 fkey
.map
= fkey
.parent
;
9929 if (keytran
.end
> last_real_key_start
)
9931 keytran
.end
= keytran
.start
9932 = min (last_real_key_start
, keytran
.start
);
9933 keytran
.map
= keytran
.parent
;
9937 if (t
== last_real_key_start
)
9944 mock_input
= last_real_key_start
;
9945 goto replay_sequence
;
9950 = apply_modifiers (modifiers
, XCAR (breakdown
));
9952 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9954 /* Look for a binding for this new key. follow_key
9955 promises that it didn't munge submaps the
9956 last time we called it, since key was unbound. */
9958 = (follow_key (new_click
,
9959 nmaps
- local_first_binding
,
9960 submaps
+ local_first_binding
,
9961 defs
+ local_first_binding
,
9962 submaps
+ local_first_binding
)
9963 + local_first_binding
);
9965 /* If that click is bound, go for it. */
9966 if (first_binding
< nmaps
)
9971 /* Otherwise, we'll leave key set to the drag event. */
9978 /* Normally, last_nonmenu_event gets the previous key we read.
9979 But when a mouse popup menu is being used,
9980 we don't update last_nonmenu_event; it continues to hold the mouse
9981 event that preceded the first level of menu. */
9982 if (!used_mouse_menu
)
9983 last_nonmenu_event
= key
;
9985 /* Record what part of this_command_keys is the current key sequence. */
9986 this_single_command_key_start
= this_command_key_count
- t
;
9988 /* Look for this sequence in input-decode-map.
9989 Scan from indec.end until we find a bound suffix. */
9990 while (indec
.end
< t
)
9992 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9995 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9996 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
10001 mock_input
= diff
+ max (t
, mock_input
);
10002 goto replay_sequence
;
10006 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
10007 && indec
.start
>= t
)
10008 /* There is a binding and it's not a prefix.
10009 (and it doesn't have any input-decode-map translation pending).
10010 There is thus no function-key in this sequence.
10011 Moving fkey.start is important in this case to allow keytran.start
10012 to go over the sequence before we return (since we keep the
10013 invariant that keytran.end <= fkey.start). */
10015 if (fkey
.start
< t
)
10016 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
10019 /* If the sequence is unbound, see if we can hang a function key
10020 off the end of it. */
10021 /* Continue scan from fkey.end until we find a bound suffix. */
10022 while (fkey
.end
< indec
.start
)
10024 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10027 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10028 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
10029 max (t
, mock_input
),
10030 /* If there's a binding (i.e.
10031 first_binding >= nmaps) we don't want
10032 to apply this function-key-mapping. */
10033 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
10038 mock_input
= diff
+ max (t
, mock_input
);
10039 /* Adjust the input-decode-map counters. */
10041 indec
.start
+= diff
;
10043 goto replay_sequence
;
10047 /* Look for this sequence in key-translation-map.
10048 Scan from keytran.end until we find a bound suffix. */
10049 while (keytran
.end
< fkey
.start
)
10051 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10054 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10055 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
10060 mock_input
= diff
+ max (t
, mock_input
);
10061 /* Adjust the function-key-map and input-decode-map counters. */
10063 indec
.start
+= diff
;
10065 fkey
.start
+= diff
;
10067 goto replay_sequence
;
10071 /* If KEY is not defined in any of the keymaps,
10072 and cannot be part of a function key or translation,
10073 and is an upper case letter
10074 use the corresponding lower-case letter instead. */
10075 if (first_binding
>= nmaps
10076 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
10078 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10079 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10080 || (XINT (key
) & shift_modifier
)))
10082 Lisp_Object new_key
;
10084 original_uppercase
= key
;
10085 original_uppercase_position
= t
- 1;
10087 if (XINT (key
) & shift_modifier
)
10088 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10090 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10091 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10093 /* We have to do this unconditionally, regardless of whether
10094 the lower-case char is defined in the keymaps, because they
10095 might get translated through function-key-map. */
10096 keybuf
[t
- 1] = new_key
;
10097 mock_input
= max (t
, mock_input
);
10098 shift_translated
= 1;
10100 goto replay_sequence
;
10102 /* If KEY is not defined in any of the keymaps,
10103 and cannot be part of a function key or translation,
10104 and is a shifted function key,
10105 use the corresponding unshifted function key instead. */
10106 if (first_binding
>= nmaps
10107 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10109 Lisp_Object breakdown
= parse_modifiers (key
);
10111 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10113 if (modifiers
& shift_modifier
10114 /* Treat uppercase keys as shifted. */
10116 && (KEY_TO_CHAR (key
)
10117 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
10118 && UPPERCASEP (KEY_TO_CHAR (key
))))
10120 Lisp_Object new_key
10121 = (modifiers
& shift_modifier
10122 ? apply_modifiers (modifiers
& ~shift_modifier
,
10124 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
10126 original_uppercase
= key
;
10127 original_uppercase_position
= t
- 1;
10129 /* We have to do this unconditionally, regardless of whether
10130 the lower-case char is defined in the keymaps, because they
10131 might get translated through function-key-map. */
10132 keybuf
[t
- 1] = new_key
;
10133 mock_input
= max (t
, mock_input
);
10134 /* Reset fkey (and consequently keytran) to apply
10135 function-key-map on the result, so that S-backspace is
10136 correctly mapped to DEL (via backspace). OTOH,
10137 input-decode-map doesn't need to go through it again. */
10138 fkey
.start
= fkey
.end
= 0;
10139 keytran
.start
= keytran
.end
= 0;
10140 shift_translated
= 1;
10142 goto replay_sequence
;
10147 read_key_sequence_cmd
= (first_binding
< nmaps
10148 ? defs
[first_binding
]
10151 unread_switch_frame
= delayed_switch_frame
;
10152 unbind_to (count
, Qnil
);
10154 /* Don't downcase the last character if the caller says don't.
10155 Don't downcase it if the result is undefined, either. */
10156 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10158 && t
- 1 == original_uppercase_position
)
10160 keybuf
[t
- 1] = original_uppercase
;
10161 shift_translated
= 0;
10164 if (shift_translated
)
10165 Vthis_command_keys_shift_translated
= Qt
;
10167 /* Occasionally we fabricate events, perhaps by expanding something
10168 according to function-key-map, or by adding a prefix symbol to a
10169 mouse click in the scroll bar or modeline. In this cases, return
10170 the entire generated key sequence, even if we hit an unbound
10171 prefix or a definition before the end. This means that you will
10172 be able to push back the event properly, and also means that
10173 read-key-sequence will always return a logical unit.
10176 for (; t
< mock_input
; t
++)
10178 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10179 && NILP (Fzerop (Vecho_keystrokes
)))
10180 echo_char (keybuf
[t
]);
10181 add_command_key (keybuf
[t
]);
10188 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10189 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10190 The sequence is sufficient to specify a non-prefix command in the
10191 current local and global maps.
10193 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10194 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10195 as a continuation of the previous key.
10197 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10198 convert the last event to lower case. (Normally any upper case event
10199 is converted to lower case if the original event is undefined and the lower
10200 case equivalent is defined.) A non-nil value is appropriate for reading
10201 a key sequence to be defined.
10203 A C-g typed while in this function is treated like any other character,
10204 and `quit-flag' is not set.
10206 If the key sequence starts with a mouse click, then the sequence is read
10207 using the keymaps of the buffer of the window clicked in, not the buffer
10208 of the selected window as normal.
10210 `read-key-sequence' drops unbound button-down events, since you normally
10211 only care about the click or drag events which follow them. If a drag
10212 or multi-click event is unbound, but the corresponding click event would
10213 be bound, `read-key-sequence' turns the event into a click event at the
10214 drag's starting position. This means that you don't have to distinguish
10215 between click and drag, double, or triple events unless you want to.
10217 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10218 lines separating windows, and scroll bars with imaginary keys
10219 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10221 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10222 function will process a switch-frame event if the user switches frames
10223 before typing anything. If the user switches frames in the middle of a
10224 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10225 is nil, then the event will be put off until after the current key sequence.
10227 `read-key-sequence' checks `function-key-map' for function key
10228 sequences, where they wouldn't conflict with ordinary bindings. See
10229 `function-key-map' for more details.
10231 The optional fifth argument COMMAND-LOOP, if non-nil, means
10232 that this key sequence is being read by something that will
10233 read commands one after another. It should be nil if the caller
10234 will read just one key sequence. */)
10235 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10237 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10238 Lisp_Object can_return_switch_frame
, command_loop
;
10240 Lisp_Object keybuf
[30];
10242 struct gcpro gcpro1
;
10243 int count
= SPECPDL_INDEX ();
10245 if (!NILP (prompt
))
10246 CHECK_STRING (prompt
);
10249 specbind (Qinput_method_exit_on_first_char
,
10250 (NILP (command_loop
) ? Qt
: Qnil
));
10251 specbind (Qinput_method_use_echo_area
,
10252 (NILP (command_loop
) ? Qt
: Qnil
));
10254 bzero (keybuf
, sizeof keybuf
);
10255 GCPRO1 (keybuf
[0]);
10256 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10258 if (NILP (continue_echo
))
10260 this_command_key_count
= 0;
10261 this_command_key_count_reset
= 0;
10262 this_single_command_key_start
= 0;
10265 #ifdef HAVE_WINDOW_SYSTEM
10266 if (display_hourglass_p
)
10267 cancel_hourglass ();
10270 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10271 prompt
, ! NILP (dont_downcase_last
),
10272 ! NILP (can_return_switch_frame
), 0);
10274 #if 0 /* The following is fine for code reading a key sequence and
10275 then proceeding with a lenghty computation, but it's not good
10276 for code reading keys in a loop, like an input method. */
10277 #ifdef HAVE_WINDOW_SYSTEM
10278 if (display_hourglass_p
)
10279 start_hourglass ();
10289 return unbind_to (count
, make_event_array (i
, keybuf
));
10292 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10293 Sread_key_sequence_vector
, 1, 5, 0,
10294 doc
: /* Like `read-key-sequence' but always return a vector. */)
10295 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10297 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10298 Lisp_Object can_return_switch_frame
, command_loop
;
10300 Lisp_Object keybuf
[30];
10302 struct gcpro gcpro1
;
10303 int count
= SPECPDL_INDEX ();
10305 if (!NILP (prompt
))
10306 CHECK_STRING (prompt
);
10309 specbind (Qinput_method_exit_on_first_char
,
10310 (NILP (command_loop
) ? Qt
: Qnil
));
10311 specbind (Qinput_method_use_echo_area
,
10312 (NILP (command_loop
) ? Qt
: Qnil
));
10314 bzero (keybuf
, sizeof keybuf
);
10315 GCPRO1 (keybuf
[0]);
10316 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10318 if (NILP (continue_echo
))
10320 this_command_key_count
= 0;
10321 this_command_key_count_reset
= 0;
10322 this_single_command_key_start
= 0;
10325 #ifdef HAVE_WINDOW_SYSTEM
10326 if (display_hourglass_p
)
10327 cancel_hourglass ();
10330 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10331 prompt
, ! NILP (dont_downcase_last
),
10332 ! NILP (can_return_switch_frame
), 0);
10334 #ifdef HAVE_WINDOW_SYSTEM
10335 if (display_hourglass_p
)
10336 start_hourglass ();
10345 return unbind_to (count
, Fvector (i
, keybuf
));
10348 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10349 doc
: /* Execute CMD as an editor command.
10350 CMD must be a symbol that satisfies the `commandp' predicate.
10351 Optional second arg RECORD-FLAG non-nil
10352 means unconditionally put this command in `command-history'.
10353 Otherwise, that is done only if an arg is read using the minibuffer.
10354 The argument KEYS specifies the value to use instead of (this-command-keys)
10355 when reading the arguments; if it is nil, (this-command-keys) is used.
10356 The argument SPECIAL, if non-nil, means that this command is executing
10357 a special event, so ignore the prefix argument and don't clear it. */)
10358 (cmd
, record_flag
, keys
, special
)
10359 Lisp_Object cmd
, record_flag
, keys
, special
;
10361 register Lisp_Object final
;
10362 register Lisp_Object tem
;
10363 Lisp_Object prefixarg
;
10364 extern int debug_on_next_call
;
10366 debug_on_next_call
= 0;
10368 if (NILP (special
))
10370 prefixarg
= current_kboard
->Vprefix_arg
;
10371 Vcurrent_prefix_arg
= prefixarg
;
10372 current_kboard
->Vprefix_arg
= Qnil
;
10379 tem
= Fget (cmd
, Qdisabled
);
10380 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10382 tem
= Fsymbol_value (Qdisabled_command_function
);
10384 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10390 final
= Findirect_function (cmd
, Qnil
);
10392 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10394 struct gcpro gcpro1
, gcpro2
;
10396 GCPRO2 (cmd
, prefixarg
);
10397 do_autoload (final
, cmd
);
10404 if (STRINGP (final
) || VECTORP (final
))
10406 /* If requested, place the macro in the command history. For
10407 other sorts of commands, call-interactively takes care of
10409 if (!NILP (record_flag
))
10412 = Fcons (Fcons (Qexecute_kbd_macro
,
10413 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10416 /* Don't keep command history around forever. */
10417 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10419 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10421 XSETCDR (tem
, Qnil
);
10425 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10428 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10429 /* Don't call Fcall_interactively directly because we want to make
10430 sure the backtrace has an entry for `call-interactively'.
10431 For the same reason, pass `cmd' rather than `final'. */
10432 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10439 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10441 doc
: /* Read function name, then read its arguments and call it.
10443 To pass a numeric argument to the command you are invoking with, specify
10444 the numeric argument to this command.
10446 Noninteractively, the argument PREFIXARG is the prefix argument to
10447 give to the command you invoke, if it asks for an argument. */)
10449 Lisp_Object prefixarg
;
10451 Lisp_Object function
;
10453 int saved_last_point_position
;
10454 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10455 Lisp_Object bindings
, value
;
10456 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10457 #ifdef HAVE_WINDOW_SYSTEM
10458 /* The call to Fcompleting_read wil start and cancel the hourglass,
10459 but if the hourglass was already scheduled, this means that no
10460 hourglass will be shown for the actual M-x command itself.
10461 So we restart it if it is already scheduled. Note that checking
10462 hourglass_shown_p is not enough, normally the hourglass is not shown,
10463 just scheduled to be shown. */
10464 int hstarted
= hourglass_started ();
10467 saved_keys
= Fvector (this_command_key_count
,
10468 XVECTOR (this_command_keys
)->contents
);
10469 saved_last_point_position_buffer
= last_point_position_buffer
;
10470 saved_last_point_position
= last_point_position
;
10472 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10474 if (EQ (prefixarg
, Qminus
))
10475 strcpy (buf
, "- ");
10476 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10477 strcpy (buf
, "C-u ");
10478 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10479 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10480 else if (INTEGERP (prefixarg
))
10481 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10483 /* This isn't strictly correct if execute-extended-command
10484 is bound to anything else. Perhaps it should use
10485 this_command_keys? */
10486 strcat (buf
, "M-x ");
10488 /* Prompt with buf, and then read a string, completing from and
10489 restricting to the set of all defined commands. Don't provide
10490 any initial input. Save the command read on the extended-command
10492 function
= Fcompleting_read (build_string (buf
),
10493 Vobarray
, Qcommandp
,
10494 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10497 #ifdef HAVE_WINDOW_SYSTEM
10498 if (hstarted
) start_hourglass ();
10501 if (STRINGP (function
) && SCHARS (function
) == 0)
10502 error ("No command name given");
10504 /* Set this_command_keys to the concatenation of saved_keys and
10505 function, followed by a RET. */
10510 this_command_key_count
= 0;
10511 this_command_key_count_reset
= 0;
10512 this_single_command_key_start
= 0;
10514 keys
= XVECTOR (saved_keys
)->contents
;
10515 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10516 add_command_key (keys
[i
]);
10518 for (i
= 0; i
< SCHARS (function
); i
++)
10519 add_command_key (Faref (function
, make_number (i
)));
10521 add_command_key (make_number ('\015'));
10524 last_point_position
= saved_last_point_position
;
10525 last_point_position_buffer
= saved_last_point_position_buffer
;
10529 function
= Fintern (function
, Qnil
);
10530 current_kboard
->Vprefix_arg
= prefixarg
;
10531 Vthis_command
= function
;
10532 real_this_command
= function
;
10534 /* If enabled, show which key runs this command. */
10535 if (!NILP (Vsuggest_key_bindings
)
10536 && NILP (Vexecuting_kbd_macro
)
10537 && SYMBOLP (function
))
10538 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10544 GCPRO3 (bindings
, value
, function
);
10545 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10547 /* If the command has a key binding, print it now. */
10548 if (!NILP (bindings
)
10549 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10552 /* But first wait, and skip the message if there is input. */
10553 Lisp_Object waited
;
10555 /* If this command displayed something in the echo area;
10556 wait a few seconds, then display our suggestion message. */
10557 if (NILP (echo_area_buffer
[0]))
10558 waited
= sit_for (make_number (0), 0, 2);
10559 else if (NUMBERP (Vsuggest_key_bindings
))
10560 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10562 waited
= sit_for (make_number (2), 0, 2);
10564 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10566 Lisp_Object binding
;
10568 int message_p
= push_message ();
10569 int count
= SPECPDL_INDEX ();
10571 record_unwind_protect (pop_message_unwind
, Qnil
);
10572 binding
= Fkey_description (bindings
, Qnil
);
10575 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10578 sprintf (newmessage
, "You can run the command `%s' with %s",
10579 SDATA (SYMBOL_NAME (function
)),
10581 message2_nolog (newmessage
,
10582 strlen (newmessage
),
10583 STRING_MULTIBYTE (binding
));
10584 if (NUMBERP (Vsuggest_key_bindings
))
10585 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10587 waited
= sit_for (make_number (2), 0, 2);
10589 if (!NILP (waited
) && message_p
)
10590 restore_message ();
10592 unbind_to (count
, Qnil
);
10596 RETURN_UNGCPRO (value
);
10600 /* Return nonzero if input events are pending. */
10603 detect_input_pending ()
10605 if (!input_pending
)
10606 get_input_pending (&input_pending
, 0);
10608 return input_pending
;
10611 /* Return nonzero if input events other than mouse movements are
10615 detect_input_pending_ignore_squeezables ()
10617 if (!input_pending
)
10618 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10620 return input_pending
;
10623 /* Return nonzero if input events are pending, and run any pending timers. */
10626 detect_input_pending_run_timers (do_display
)
10629 int old_timers_run
= timers_run
;
10631 if (!input_pending
)
10632 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10634 if (old_timers_run
!= timers_run
&& do_display
)
10636 redisplay_preserve_echo_area (8);
10637 /* The following fixes a bug when using lazy-lock with
10638 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10639 from an idle timer function. The symptom of the bug is that
10640 the cursor sometimes doesn't become visible until the next X
10641 event is processed. --gerd. */
10643 Lisp_Object tail
, frame
;
10644 FOR_EACH_FRAME (tail
, frame
)
10645 if (FRAME_RIF (XFRAME (frame
)))
10646 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10650 return input_pending
;
10653 /* This is called in some cases before a possible quit.
10654 It cases the next call to detect_input_pending to recompute input_pending.
10655 So calling this function unnecessarily can't do any harm. */
10658 clear_input_pending ()
10663 /* Return nonzero if there are pending requeued events.
10664 This isn't used yet. The hope is to make wait_reading_process_output
10665 call it, and return if it runs Lisp code that unreads something.
10666 The problem is, kbd_buffer_get_event needs to be fixed to know what
10667 to do in that case. It isn't trivial. */
10670 requeued_events_pending_p ()
10672 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10676 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10677 doc
: /* Return t if command input is currently available with no wait.
10678 Actually, the value is nil only if we can be sure that no input is available;
10679 if there is a doubt, the value is t. */)
10682 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10683 || !NILP (Vunread_post_input_method_events
)
10684 || !NILP (Vunread_input_method_events
))
10687 get_input_pending (&input_pending
,
10688 READABLE_EVENTS_DO_TIMERS_NOW
10689 | READABLE_EVENTS_FILTER_EVENTS
);
10690 return input_pending
> 0 ? Qt
: Qnil
;
10693 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10694 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10697 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10700 if (total_keys
< NUM_RECENT_KEYS
)
10701 return Fvector (total_keys
, keys
);
10704 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10705 bcopy (keys
+ recent_keys_index
,
10706 XVECTOR (val
)->contents
,
10707 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10709 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10710 recent_keys_index
* sizeof (Lisp_Object
));
10715 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10716 doc
: /* Return the key sequence that invoked this command.
10717 However, if the command has called `read-key-sequence', it returns
10718 the last key sequence that has been read.
10719 The value is a string or a vector.
10721 See also `this-command-keys-vector'. */)
10724 return make_event_array (this_command_key_count
,
10725 XVECTOR (this_command_keys
)->contents
);
10728 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10729 doc
: /* Return the key sequence that invoked this command, as a vector.
10730 However, if the command has called `read-key-sequence', it returns
10731 the last key sequence that has been read.
10733 See also `this-command-keys'. */)
10736 return Fvector (this_command_key_count
,
10737 XVECTOR (this_command_keys
)->contents
);
10740 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10741 Sthis_single_command_keys
, 0, 0, 0,
10742 doc
: /* Return the key sequence that invoked this command.
10743 More generally, it returns the last key sequence read, either by
10744 the command loop or by `read-key-sequence'.
10745 Unlike `this-command-keys', this function's value
10746 does not include prefix arguments.
10747 The value is always a vector. */)
10750 return Fvector (this_command_key_count
10751 - this_single_command_key_start
,
10752 (XVECTOR (this_command_keys
)->contents
10753 + this_single_command_key_start
));
10756 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10757 Sthis_single_command_raw_keys
, 0, 0, 0,
10758 doc
: /* Return the raw events that were read for this command.
10759 More generally, it returns the last key sequence read, either by
10760 the command loop or by `read-key-sequence'.
10761 Unlike `this-single-command-keys', this function's value
10762 shows the events before all translations (except for input methods).
10763 The value is always a vector. */)
10766 return Fvector (raw_keybuf_count
,
10767 (XVECTOR (raw_keybuf
)->contents
));
10770 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10771 Sreset_this_command_lengths
, 0, 0, 0,
10772 doc
: /* Make the unread events replace the last command and echo.
10773 Used in `universal-argument-other-key'.
10775 `universal-argument-other-key' rereads the event just typed.
10776 It then gets translated through `function-key-map'.
10777 The translated event has to replace the real events,
10778 both in the value of (this-command-keys) and in echoing.
10779 To achieve this, `universal-argument-other-key' calls
10780 `reset-this-command-lengths', which discards the record of reading
10781 these events the first time. */)
10784 this_command_key_count
= before_command_key_count
;
10785 if (this_command_key_count
< this_single_command_key_start
)
10786 this_single_command_key_start
= this_command_key_count
;
10788 echo_truncate (before_command_echo_length
);
10790 /* Cause whatever we put into unread-command-events
10791 to echo as if it were being freshly read from the keyboard. */
10792 this_command_key_count_reset
= 1;
10797 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10798 Sclear_this_command_keys
, 0, 1, 0,
10799 doc
: /* Clear out the vector that `this-command-keys' returns.
10800 Also clear the record of the last 100 events, unless optional arg
10801 KEEP-RECORD is non-nil. */)
10803 Lisp_Object keep_record
;
10807 this_command_key_count
= 0;
10808 this_command_key_count_reset
= 0;
10810 if (NILP (keep_record
))
10812 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10813 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10815 recent_keys_index
= 0;
10820 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10821 doc
: /* Return the current depth in recursive edits. */)
10825 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10829 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10830 "FOpen dribble file: ",
10831 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10832 If FILE is nil, close any open dribble file. */)
10845 file
= Fexpand_file_name (file
, Qnil
);
10846 dribble
= fopen (SDATA (file
), "w");
10848 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10853 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10854 doc
: /* Discard the contents of the terminal input buffer.
10855 Also end any kbd macro being defined. */)
10858 if (!NILP (current_kboard
->defining_kbd_macro
))
10860 /* Discard the last command from the macro. */
10861 Fcancel_kbd_macro_events ();
10865 update_mode_lines
++;
10867 Vunread_command_events
= Qnil
;
10868 unread_command_char
= -1;
10870 discard_tty_input ();
10872 kbd_fetch_ptr
= kbd_store_ptr
;
10878 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10879 doc
: /* Stop Emacs and return to superior process. You can resume later.
10880 If `cannot-suspend' is non-nil, or if the system doesn't support job
10881 control, run a subshell instead.
10883 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10884 to be read as terminal input by Emacs's parent, after suspension.
10886 Before suspending, run the normal hook `suspend-hook'.
10887 After resumption run the normal hook `suspend-resume-hook'.
10889 Some operating systems cannot stop the Emacs process and resume it later.
10890 On such systems, Emacs starts a subshell instead of suspending. */)
10892 Lisp_Object stuffstring
;
10894 int count
= SPECPDL_INDEX ();
10895 int old_height
, old_width
;
10897 struct gcpro gcpro1
;
10899 if (tty_list
&& tty_list
->next
)
10900 error ("There are other tty frames open; close them before suspending Emacs");
10902 if (!NILP (stuffstring
))
10903 CHECK_STRING (stuffstring
);
10905 /* Run the functions in suspend-hook. */
10906 if (!NILP (Vrun_hooks
))
10907 call1 (Vrun_hooks
, intern ("suspend-hook"));
10909 GCPRO1 (stuffstring
);
10910 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10911 reset_all_sys_modes ();
10912 /* sys_suspend can get an error if it tries to fork a subshell
10913 and the system resources aren't available for that. */
10914 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10916 stuff_buffered_input (stuffstring
);
10917 if (cannot_suspend
)
10921 unbind_to (count
, Qnil
);
10923 /* Check if terminal/window size has changed.
10924 Note that this is not useful when we are running directly
10925 with a window system; but suspend should be disabled in that case. */
10926 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10927 if (width
!= old_width
|| height
!= old_height
)
10928 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10930 /* Run suspend-resume-hook. */
10931 if (!NILP (Vrun_hooks
))
10932 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10938 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10939 Then in any case stuff anything Emacs has read ahead and not used. */
10942 stuff_buffered_input (stuffstring
)
10943 Lisp_Object stuffstring
;
10945 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10946 register unsigned char *p
;
10948 if (STRINGP (stuffstring
))
10950 register int count
;
10952 p
= SDATA (stuffstring
);
10953 count
= SBYTES (stuffstring
);
10954 while (count
-- > 0)
10959 /* Anything we have read ahead, put back for the shell to read. */
10960 /* ?? What should this do when we have multiple keyboards??
10961 Should we ignore anything that was typed in at the "wrong" kboard?
10963 rms: we should stuff everything back into the kboard
10965 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10968 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10969 kbd_fetch_ptr
= kbd_buffer
;
10970 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10971 stuff_char (kbd_fetch_ptr
->code
);
10973 clear_event (kbd_fetch_ptr
);
10977 #endif /* SIGTSTP */
10981 set_waiting_for_input (time_to_clear
)
10982 EMACS_TIME
*time_to_clear
;
10984 input_available_clear_time
= time_to_clear
;
10986 /* Tell handle_interrupt to throw back to read_char, */
10987 waiting_for_input
= 1;
10989 /* If handle_interrupt was called before and buffered a C-g,
10990 make it run again now, to avoid timing error. */
10991 if (!NILP (Vquit_flag
))
10992 quit_throw_to_read_char ();
10996 clear_waiting_for_input ()
10998 /* Tell handle_interrupt not to throw back to read_char, */
10999 waiting_for_input
= 0;
11000 input_available_clear_time
= 0;
11003 /* The SIGINT handler.
11005 If we have a frame on the controlling tty, we assume that the
11006 SIGINT was generated by C-g, so we call handle_interrupt.
11007 Otherwise, the handler kills Emacs. */
11010 interrupt_signal (signalnum
) /* If we don't have an argument, */
11011 int signalnum
; /* some compilers complain in signal calls. */
11013 /* Must preserve main program's value of errno. */
11014 int old_errno
= errno
;
11015 struct terminal
*terminal
;
11017 #if defined (USG) && !defined (POSIX_SIGNALS)
11018 /* USG systems forget handlers when they are used;
11019 must reestablish each time */
11020 signal (SIGINT
, interrupt_signal
);
11021 signal (SIGQUIT
, interrupt_signal
);
11024 SIGNAL_THREAD_CHECK (signalnum
);
11026 /* See if we have an active terminal on our controlling tty. */
11027 terminal
= get_named_tty ("/dev/tty");
11030 /* If there are no frames there, let's pretend that we are a
11031 well-behaving UN*X program and quit. */
11032 Fkill_emacs (Qnil
);
11036 /* Otherwise, the SIGINT was probably generated by C-g. */
11038 /* Set internal_last_event_frame to the top frame of the
11039 controlling tty, if we have a frame there. We disable the
11040 interrupt key on secondary ttys, so the SIGINT must have come
11041 from the controlling tty. */
11042 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
11044 handle_interrupt ();
11050 /* This routine is called at interrupt level in response to C-g.
11052 It is called from the SIGINT handler or kbd_buffer_store_event.
11054 If `waiting_for_input' is non zero, then unless `echoing' is
11055 nonzero, immediately throw back to read_char.
11057 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
11058 eval to throw, when it gets a chance. If quit-flag is already
11059 non-nil, it stops the job right away. */
11062 handle_interrupt ()
11068 /* XXX This code needs to be revised for multi-tty support. */
11069 if (!NILP (Vquit_flag
)
11071 && get_named_tty ("/dev/tty")
11075 /* If SIGINT isn't blocked, don't let us be interrupted by
11076 another SIGINT, it might be harmful due to non-reentrancy
11077 in I/O functions. */
11078 sigblock (sigmask (SIGINT
));
11081 reset_all_sys_modes ();
11083 #ifdef SIGTSTP /* Support possible in later USG versions */
11085 * On systems which can suspend the current process and return to the original
11086 * shell, this command causes the user to end up back at the shell.
11087 * The "Auto-save" and "Abort" questions are not asked until
11088 * the user elects to return to emacs, at which point he can save the current
11089 * job and either dump core or continue.
11094 if (sys_suspend () == -1)
11096 printf ("Not running as a subprocess;\n");
11097 printf ("you can continue or abort.\n");
11099 #else /* not VMS */
11100 /* Perhaps should really fork an inferior shell?
11101 But that would not provide any way to get back
11102 to the original shell, ever. */
11103 printf ("No support for stopping a process on this operating system;\n");
11104 printf ("you can continue or abort.\n");
11105 #endif /* not VMS */
11106 #endif /* not SIGTSTP */
11108 /* We must remain inside the screen area when the internal terminal
11109 is used. Note that [Enter] is not echoed by dos. */
11112 /* It doesn't work to autosave while GC is in progress;
11113 the code used for auto-saving doesn't cope with the mark bit. */
11114 if (!gc_in_progress
)
11116 printf ("Auto-save? (y or n) ");
11118 if (((c
= getchar ()) & ~040) == 'Y')
11120 Fdo_auto_save (Qt
, Qnil
);
11122 printf ("\r\nAuto-save done");
11123 #else /* not MSDOS */
11124 printf ("Auto-save done\n");
11125 #endif /* not MSDOS */
11127 while (c
!= '\n') c
= getchar ();
11131 /* During GC, it must be safe to reenable quitting again. */
11132 Vinhibit_quit
= Qnil
;
11135 #endif /* not MSDOS */
11136 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11137 printf ("but will instead do a real quit after garbage collection ends\r\n");
11142 printf ("\r\nAbort? (y or n) ");
11143 #else /* not MSDOS */
11145 printf ("Abort (and enter debugger)? (y or n) ");
11146 #else /* not VMS */
11147 printf ("Abort (and dump core)? (y or n) ");
11148 #endif /* not VMS */
11149 #endif /* not MSDOS */
11151 if (((c
= getchar ()) & ~040) == 'Y')
11153 while (c
!= '\n') c
= getchar ();
11155 printf ("\r\nContinuing...\r\n");
11156 #else /* not MSDOS */
11157 printf ("Continuing...\n");
11158 #endif /* not MSDOS */
11160 init_all_sys_modes ();
11165 /* If executing a function that wants to be interrupted out of
11166 and the user has not deferred quitting by binding `inhibit-quit'
11167 then quit right away. */
11168 if (immediate_quit
&& NILP (Vinhibit_quit
))
11170 struct gl_state_s saved
;
11171 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11173 immediate_quit
= 0;
11176 GCPRO4 (saved
.object
, saved
.global_code
,
11177 saved
.current_syntax_table
, saved
.old_prop
);
11178 Fsignal (Qquit
, Qnil
);
11183 /* Else request quit when it's safe */
11187 if (waiting_for_input
&& !echoing
)
11188 quit_throw_to_read_char ();
11191 /* Handle a C-g by making read_char return C-g. */
11194 quit_throw_to_read_char ()
11197 /* Prevent another signal from doing this before we finish. */
11198 clear_waiting_for_input ();
11201 Vunread_command_events
= Qnil
;
11202 unread_command_char
= -1;
11204 #if 0 /* Currently, sit_for is called from read_char without turning
11205 off polling. And that can call set_waiting_for_input.
11206 It seems to be harmless. */
11207 #ifdef POLL_FOR_INPUT
11208 /* May be > 1 if in recursive minibuffer. */
11209 if (poll_suppress_count
== 0)
11213 if (FRAMEP (internal_last_event_frame
)
11214 && !EQ (internal_last_event_frame
, selected_frame
))
11215 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11218 _longjmp (getcjmp
, 1);
11221 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11222 doc
: /* Set interrupt mode of reading keyboard input.
11223 If INTERRUPT is non-nil, Emacs will use input interrupts;
11224 otherwise Emacs uses CBREAK mode.
11226 See also `current-input-mode'. */)
11228 Lisp_Object interrupt
;
11230 int new_interrupt_input
;
11232 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11233 #ifdef HAVE_X_WINDOWS
11234 if (x_display_list
!= NULL
)
11236 /* When using X, don't give the user a real choice,
11237 because we haven't implemented the mechanisms to support it. */
11238 #ifdef NO_SOCK_SIGIO
11239 new_interrupt_input
= 0;
11240 #else /* not NO_SOCK_SIGIO */
11241 new_interrupt_input
= 1;
11242 #endif /* NO_SOCK_SIGIO */
11246 new_interrupt_input
= !NILP (interrupt
);
11247 #else /* not SIGIO */
11248 new_interrupt_input
= 0;
11249 #endif /* not SIGIO */
11251 /* Our VMS input only works by interrupts, as of now. */
11253 new_interrupt_input
= 1;
11256 if (new_interrupt_input
!= interrupt_input
)
11258 #ifdef POLL_FOR_INPUT
11262 /* this causes startup screen to be restored and messes with the mouse */
11263 reset_all_sys_modes ();
11265 interrupt_input
= new_interrupt_input
;
11267 init_all_sys_modes ();
11270 #ifdef POLL_FOR_INPUT
11271 poll_suppress_count
= 1;
11278 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11279 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11280 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11281 C-q in key sequences.
11283 This setting only has an effect on tty terminals and only when
11284 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11286 See also `current-input-mode'. */)
11288 Lisp_Object flow
, terminal
;
11290 struct terminal
*t
= get_terminal (terminal
, 1);
11291 struct tty_display_info
*tty
;
11292 if (t
== NULL
|| t
->type
!= output_termcap
)
11294 tty
= t
->display_info
.tty
;
11296 if (tty
->flow_control
!= !NILP (flow
))
11299 /* this causes startup screen to be restored and messes with the mouse */
11300 reset_sys_modes (tty
);
11303 tty
->flow_control
= !NILP (flow
);
11306 init_sys_modes (tty
);
11312 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11313 doc
: /* Enable or disable 8-bit input on TERMINAL.
11314 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11315 bit as the Meta modifier.
11317 If META is nil, Emacs will ignore the top bit, on the assumption it is
11320 Otherwise, Emacs will accept and pass through 8-bit input without
11321 specially interpreting the top bit.
11323 This setting only has an effect on tty terminal devices.
11325 Optional parameter TERMINAL specifies the tty terminal device to use.
11326 It may be a terminal id, a frame, or nil for the terminal used by the
11327 currently selected frame.
11329 See also `current-input-mode'. */)
11331 Lisp_Object meta
, terminal
;
11333 struct terminal
*t
= get_terminal (terminal
, 1);
11334 struct tty_display_info
*tty
;
11337 if (t
== NULL
|| t
->type
!= output_termcap
)
11339 tty
= t
->display_info
.tty
;
11343 else if (EQ (meta
, Qt
))
11348 if (tty
->meta_key
!= new_meta
)
11351 /* this causes startup screen to be restored and messes with the mouse */
11352 reset_sys_modes (tty
);
11355 tty
->meta_key
= new_meta
;
11358 init_sys_modes (tty
);
11364 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11365 doc
: /* Specify character used for quitting.
11366 QUIT must be an ASCII character.
11368 This function only has an effect on the controlling tty of the Emacs
11371 See also `current-input-mode'. */)
11375 struct terminal
*t
= get_named_tty ("/dev/tty");
11376 struct tty_display_info
*tty
;
11377 if (t
== NULL
|| t
->type
!= output_termcap
)
11379 tty
= t
->display_info
.tty
;
11381 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11382 error ("QUIT must be an ASCII character");
11385 /* this causes startup screen to be restored and messes with the mouse */
11386 reset_sys_modes (tty
);
11389 /* Don't let this value be out of range. */
11390 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11393 init_sys_modes (tty
);
11399 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11400 doc
: /* Set mode of reading keyboard input.
11401 First arg INTERRUPT non-nil means use input interrupts;
11402 nil means use CBREAK mode.
11403 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11404 (no effect except in CBREAK mode).
11405 Third arg META t means accept 8-bit input (for a Meta key).
11406 META nil means ignore the top bit, on the assumption it is parity.
11407 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11408 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11409 See also `current-input-mode'. */)
11410 (interrupt
, flow
, meta
, quit
)
11411 Lisp_Object interrupt
, flow
, meta
, quit
;
11413 Fset_input_interrupt_mode (interrupt
);
11414 Fset_output_flow_control (flow
, Qnil
);
11415 Fset_input_meta_mode (meta
, Qnil
);
11417 Fset_quit_char (quit
);
11421 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11422 doc
: /* Return information about the way Emacs currently reads keyboard input.
11423 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11424 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11425 nil, Emacs is using CBREAK mode.
11426 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11427 terminal; this does not apply if Emacs uses interrupt-driven input.
11428 META is t if accepting 8-bit input with 8th bit as Meta flag.
11429 META nil means ignoring the top bit, on the assumption it is parity.
11430 META is neither t nor nil if accepting 8-bit input and using
11431 all 8 bits as the character code.
11432 QUIT is the character Emacs currently uses to quit.
11433 The elements of this list correspond to the arguments of
11434 `set-input-mode'. */)
11437 Lisp_Object val
[4];
11438 struct frame
*sf
= XFRAME (selected_frame
);
11440 val
[0] = interrupt_input
? Qt
: Qnil
;
11441 if (FRAME_TERMCAP_P (sf
))
11443 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11444 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11446 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11453 XSETFASTINT (val
[3], quit_char
);
11455 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11458 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11459 doc
: /* Return position information for pixel coordinates X and Y.
11460 By default, X and Y are relative to text area of the selected window.
11461 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11462 If optional fourth arg WHOLE is non-nil, X is relative to the left
11463 edge of the window.
11465 The return value is similar to a mouse click position:
11466 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11467 IMAGE (DX . DY) (WIDTH . HEIGHT))
11468 The `posn-' functions access elements of such lists. */)
11469 (x
, y
, frame_or_window
, whole
)
11470 Lisp_Object x
, y
, frame_or_window
, whole
;
11475 if (NILP (frame_or_window
))
11476 frame_or_window
= selected_window
;
11478 if (WINDOWP (frame_or_window
))
11482 CHECK_LIVE_WINDOW (frame_or_window
);
11484 w
= XWINDOW (frame_or_window
);
11485 XSETINT (x
, (XINT (x
)
11486 + WINDOW_LEFT_EDGE_X (w
)
11488 ? window_box_left_offset (w
, TEXT_AREA
)
11490 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11491 frame_or_window
= w
->frame
;
11494 CHECK_LIVE_FRAME (frame_or_window
);
11496 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11499 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11500 doc
: /* Return position information for buffer POS in WINDOW.
11501 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11503 Return nil if position is not visible in window. Otherwise,
11504 the return value is similar to that returned by `event-start' for
11505 a mouse click at the upper left corner of the glyph corresponding
11506 to the given buffer position:
11507 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11508 IMAGE (DX . DY) (WIDTH . HEIGHT))
11509 The `posn-' functions access elements of such lists. */)
11511 Lisp_Object pos
, window
;
11516 window
= selected_window
;
11518 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11521 Lisp_Object x
= XCAR (tem
);
11522 Lisp_Object y
= XCAR (XCDR (tem
));
11524 /* Point invisible due to hscrolling? */
11527 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11535 * Set up a new kboard object with reasonable initial values.
11541 kb
->Voverriding_terminal_local_map
= Qnil
;
11542 kb
->Vlast_command
= Qnil
;
11543 kb
->Vreal_last_command
= Qnil
;
11544 kb
->Vkeyboard_translate_table
= Qnil
;
11545 kb
->Vlast_repeatable_command
= Qnil
;
11546 kb
->Vprefix_arg
= Qnil
;
11547 kb
->Vlast_prefix_arg
= Qnil
;
11548 kb
->kbd_queue
= Qnil
;
11549 kb
->kbd_queue_has_data
= 0;
11550 kb
->immediate_echo
= 0;
11551 kb
->echo_string
= Qnil
;
11552 kb
->echo_after_prompt
= -1;
11553 kb
->kbd_macro_buffer
= 0;
11554 kb
->kbd_macro_bufsize
= 0;
11555 kb
->defining_kbd_macro
= Qnil
;
11556 kb
->Vlast_kbd_macro
= Qnil
;
11557 kb
->reference_count
= 0;
11558 kb
->Vsystem_key_alist
= Qnil
;
11559 kb
->system_key_syms
= Qnil
;
11560 kb
->Vwindow_system
= Qt
; /* Unset. */
11561 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11562 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11563 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11564 kb
->Vdefault_minibuffer_frame
= Qnil
;
11568 * Destroy the contents of a kboard object, but not the object itself.
11569 * We use this just before deleting it, or if we're going to initialize
11570 * it a second time.
11576 if (kb
->kbd_macro_buffer
)
11577 xfree (kb
->kbd_macro_buffer
);
11580 #ifdef MULTI_KBOARD
11582 /* Free KB and memory referenced from it. */
11590 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11593 *kbp
= kb
->next_kboard
;
11595 /* Prevent a dangling reference to KB. */
11596 if (kb
== current_kboard
11597 && FRAMEP (selected_frame
)
11598 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11600 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11602 if (current_kboard
== kb
)
11610 #endif /* MULTI_KBOARD */
11615 /* This is correct before outermost invocation of the editor loop */
11616 command_loop_level
= -1;
11617 immediate_quit
= 0;
11618 quit_char
= Ctl ('g');
11619 Vunread_command_events
= Qnil
;
11620 unread_command_char
= -1;
11621 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11623 recent_keys_index
= 0;
11624 kbd_fetch_ptr
= kbd_buffer
;
11625 kbd_store_ptr
= kbd_buffer
;
11626 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11627 do_mouse_tracking
= Qnil
;
11630 interrupt_input_blocked
= 0;
11631 interrupt_input_pending
= 0;
11633 /* This means that command_loop_1 won't try to select anything the first
11635 internal_last_event_frame
= Qnil
;
11636 Vlast_event_frame
= internal_last_event_frame
;
11638 #ifdef MULTI_KBOARD
11639 current_kboard
= initial_kboard
;
11641 /* Re-initialize the keyboard again. */
11642 wipe_kboard (current_kboard
);
11643 init_kboard (current_kboard
);
11644 /* A value of nil for Vwindow_system normally means a tty, but we also use
11645 it for the initial terminal since there is no window system there. */
11646 current_kboard
->Vwindow_system
= Qnil
;
11648 if (!noninteractive
)
11650 /* Before multi-tty support, these handlers used to be installed
11651 only if the current session was a tty session. Now an Emacs
11652 session may have multiple display types, so we always handle
11653 SIGINT. There is special code in interrupt_signal to exit
11654 Emacs on SIGINT when there are no termcap frames on the
11655 controlling terminal. */
11656 signal (SIGINT
, interrupt_signal
);
11657 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11658 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11659 SIGQUIT and we can't tell which one it will give us. */
11660 signal (SIGQUIT
, interrupt_signal
);
11661 #endif /* HAVE_TERMIO */
11663 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11665 if (!noninteractive
)
11666 signal (SIGIO
, input_available_signal
);
11669 /* Use interrupt input by default, if it works and noninterrupt input
11670 has deficiencies. */
11672 #ifdef INTERRUPT_INPUT
11673 interrupt_input
= 1;
11675 interrupt_input
= 0;
11678 /* Our VMS input only works by interrupts, as of now. */
11680 interrupt_input
= 1;
11686 if (keyboard_init_hook
)
11687 (*keyboard_init_hook
) ();
11689 #ifdef POLL_FOR_INPUT
11690 poll_suppress_count
= 1;
11695 /* This type's only use is in syms_of_keyboard, to initialize the
11696 event header symbols and put properties on them. */
11697 struct event_head
{
11703 struct event_head head_table
[] = {
11704 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11705 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11706 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11707 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11708 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11709 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11710 /* `select-window' should be handled just like `switch-frame'
11711 in read_key_sequence. */
11712 {&Qselect_window
, "select-window", &Qswitch_frame
}
11716 syms_of_keyboard ()
11718 pending_funcalls
= Qnil
;
11720 Vlispy_mouse_stem
= build_string ("mouse");
11721 staticpro (&Vlispy_mouse_stem
);
11724 QCimage
= intern (":image");
11725 staticpro (&QCimage
);
11727 staticpro (&Qhelp_echo
);
11728 Qhelp_echo
= intern ("help-echo");
11731 Qrtl
= intern (":rtl");
11733 staticpro (&item_properties
);
11734 item_properties
= Qnil
;
11736 staticpro (&tool_bar_item_properties
);
11737 tool_bar_item_properties
= Qnil
;
11738 staticpro (&tool_bar_items_vector
);
11739 tool_bar_items_vector
= Qnil
;
11741 staticpro (&real_this_command
);
11742 real_this_command
= Qnil
;
11744 Qtimer_event_handler
= intern ("timer-event-handler");
11745 staticpro (&Qtimer_event_handler
);
11747 Qdisabled_command_function
= intern ("disabled-command-function");
11748 staticpro (&Qdisabled_command_function
);
11750 Qself_insert_command
= intern ("self-insert-command");
11751 staticpro (&Qself_insert_command
);
11753 Qforward_char
= intern ("forward-char");
11754 staticpro (&Qforward_char
);
11756 Qbackward_char
= intern ("backward-char");
11757 staticpro (&Qbackward_char
);
11759 Qdisabled
= intern ("disabled");
11760 staticpro (&Qdisabled
);
11762 Qundefined
= intern ("undefined");
11763 staticpro (&Qundefined
);
11765 Qpre_command_hook
= intern ("pre-command-hook");
11766 staticpro (&Qpre_command_hook
);
11768 Qpost_command_hook
= intern ("post-command-hook");
11769 staticpro (&Qpost_command_hook
);
11771 Qdeferred_action_function
= intern ("deferred-action-function");
11772 staticpro (&Qdeferred_action_function
);
11774 Qcommand_hook_internal
= intern ("command-hook-internal");
11775 staticpro (&Qcommand_hook_internal
);
11777 Qfunction_key
= intern ("function-key");
11778 staticpro (&Qfunction_key
);
11779 Qmouse_click
= intern ("mouse-click");
11780 staticpro (&Qmouse_click
);
11781 #if defined (WINDOWSNT) || defined (MAC_OS)
11782 Qlanguage_change
= intern ("language-change");
11783 staticpro (&Qlanguage_change
);
11785 Qdrag_n_drop
= intern ("drag-n-drop");
11786 staticpro (&Qdrag_n_drop
);
11788 Qsave_session
= intern ("save-session");
11789 staticpro (&Qsave_session
);
11792 Qmac_apple_event
= intern ("mac-apple-event");
11793 staticpro (&Qmac_apple_event
);
11797 Qdbus_event
= intern ("dbus-event");
11798 staticpro (&Qdbus_event
);
11801 Qmenu_enable
= intern ("menu-enable");
11802 staticpro (&Qmenu_enable
);
11803 Qmenu_alias
= intern ("menu-alias");
11804 staticpro (&Qmenu_alias
);
11805 QCenable
= intern (":enable");
11806 staticpro (&QCenable
);
11807 QCvisible
= intern (":visible");
11808 staticpro (&QCvisible
);
11809 QChelp
= intern (":help");
11810 staticpro (&QChelp
);
11811 QCfilter
= intern (":filter");
11812 staticpro (&QCfilter
);
11813 QCbutton
= intern (":button");
11814 staticpro (&QCbutton
);
11815 QCkeys
= intern (":keys");
11816 staticpro (&QCkeys
);
11817 QCkey_sequence
= intern (":key-sequence");
11818 staticpro (&QCkey_sequence
);
11819 QCtoggle
= intern (":toggle");
11820 staticpro (&QCtoggle
);
11821 QCradio
= intern (":radio");
11822 staticpro (&QCradio
);
11824 Qmode_line
= intern ("mode-line");
11825 staticpro (&Qmode_line
);
11826 Qvertical_line
= intern ("vertical-line");
11827 staticpro (&Qvertical_line
);
11828 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11829 staticpro (&Qvertical_scroll_bar
);
11830 Qmenu_bar
= intern ("menu-bar");
11831 staticpro (&Qmenu_bar
);
11833 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11834 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11835 staticpro (&Qmouse_fixup_help_message
);
11838 Qabove_handle
= intern ("above-handle");
11839 staticpro (&Qabove_handle
);
11840 Qhandle
= intern ("handle");
11841 staticpro (&Qhandle
);
11842 Qbelow_handle
= intern ("below-handle");
11843 staticpro (&Qbelow_handle
);
11844 Qup
= intern ("up");
11846 Qdown
= intern ("down");
11847 staticpro (&Qdown
);
11848 Qtop
= intern ("top");
11850 Qbottom
= intern ("bottom");
11851 staticpro (&Qbottom
);
11852 Qend_scroll
= intern ("end-scroll");
11853 staticpro (&Qend_scroll
);
11854 Qratio
= intern ("ratio");
11855 staticpro (&Qratio
);
11857 Qevent_kind
= intern ("event-kind");
11858 staticpro (&Qevent_kind
);
11859 Qevent_symbol_elements
= intern ("event-symbol-elements");
11860 staticpro (&Qevent_symbol_elements
);
11861 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11862 staticpro (&Qevent_symbol_element_mask
);
11863 Qmodifier_cache
= intern ("modifier-cache");
11864 staticpro (&Qmodifier_cache
);
11866 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11867 staticpro (&Qrecompute_lucid_menubar
);
11868 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11869 staticpro (&Qactivate_menubar_hook
);
11871 Qpolling_period
= intern ("polling-period");
11872 staticpro (&Qpolling_period
);
11874 Qinput_method_function
= intern ("input-method-function");
11875 staticpro (&Qinput_method_function
);
11877 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11878 staticpro (&Qinput_method_exit_on_first_char
);
11879 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11880 staticpro (&Qinput_method_use_echo_area
);
11882 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11883 Fset (Qinput_method_use_echo_area
, Qnil
);
11885 last_point_position_buffer
= Qnil
;
11886 last_point_position_window
= Qnil
;
11889 struct event_head
*p
;
11891 for (p
= head_table
;
11892 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11895 *p
->var
= intern (p
->name
);
11896 staticpro (p
->var
);
11897 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11898 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11902 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11903 staticpro (&button_down_location
);
11904 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11905 staticpro (&mouse_syms
);
11906 wheel_syms
= Fmake_vector (make_number (4), Qnil
);
11907 staticpro (&wheel_syms
);
11911 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11913 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11914 for (i
= 0; i
< len
; i
++)
11915 if (modifier_names
[i
])
11916 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11917 staticpro (&modifier_symbols
);
11920 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11921 staticpro (&recent_keys
);
11923 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11924 staticpro (&this_command_keys
);
11926 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11927 staticpro (&raw_keybuf
);
11929 Qextended_command_history
= intern ("extended-command-history");
11930 Fset (Qextended_command_history
, Qnil
);
11931 staticpro (&Qextended_command_history
);
11933 accent_key_syms
= Qnil
;
11934 staticpro (&accent_key_syms
);
11936 func_key_syms
= Qnil
;
11937 staticpro (&func_key_syms
);
11939 drag_n_drop_syms
= Qnil
;
11940 staticpro (&drag_n_drop_syms
);
11942 unread_switch_frame
= Qnil
;
11943 staticpro (&unread_switch_frame
);
11945 internal_last_event_frame
= Qnil
;
11946 staticpro (&internal_last_event_frame
);
11948 read_key_sequence_cmd
= Qnil
;
11949 staticpro (&read_key_sequence_cmd
);
11951 menu_bar_one_keymap_changed_items
= Qnil
;
11952 staticpro (&menu_bar_one_keymap_changed_items
);
11954 menu_bar_items_vector
= Qnil
;
11955 staticpro (&menu_bar_items_vector
);
11957 help_form_saved_window_configs
= Qnil
;
11958 staticpro (&help_form_saved_window_configs
);
11960 defsubr (&Scurrent_idle_time
);
11961 defsubr (&Sevent_symbol_parse_modifiers
);
11962 defsubr (&Sevent_convert_list
);
11963 defsubr (&Sread_key_sequence
);
11964 defsubr (&Sread_key_sequence_vector
);
11965 defsubr (&Srecursive_edit
);
11966 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11967 defsubr (&Strack_mouse
);
11969 defsubr (&Sinput_pending_p
);
11970 defsubr (&Scommand_execute
);
11971 defsubr (&Srecent_keys
);
11972 defsubr (&Sthis_command_keys
);
11973 defsubr (&Sthis_command_keys_vector
);
11974 defsubr (&Sthis_single_command_keys
);
11975 defsubr (&Sthis_single_command_raw_keys
);
11976 defsubr (&Sreset_this_command_lengths
);
11977 defsubr (&Sclear_this_command_keys
);
11978 defsubr (&Ssuspend_emacs
);
11979 defsubr (&Sabort_recursive_edit
);
11980 defsubr (&Sexit_recursive_edit
);
11981 defsubr (&Srecursion_depth
);
11982 defsubr (&Stop_level
);
11983 defsubr (&Sdiscard_input
);
11984 defsubr (&Sopen_dribble_file
);
11985 defsubr (&Sset_input_interrupt_mode
);
11986 defsubr (&Sset_output_flow_control
);
11987 defsubr (&Sset_input_meta_mode
);
11988 defsubr (&Sset_quit_char
);
11989 defsubr (&Sset_input_mode
);
11990 defsubr (&Scurrent_input_mode
);
11991 defsubr (&Sexecute_extended_command
);
11992 defsubr (&Sposn_at_point
);
11993 defsubr (&Sposn_at_x_y
);
11995 DEFVAR_LISP ("last-command-char", &last_command_char
,
11996 doc
: /* Last input event that was part of a command. */);
11998 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11999 doc
: /* Last input event that was part of a command. */);
12001 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
12002 doc
: /* Last input event in a command, except for mouse menu events.
12003 Mouse menus give back keys that don't look like mouse events;
12004 this variable holds the actual mouse event that led to the menu,
12005 so that you can determine whether the command was run by mouse or not. */);
12007 DEFVAR_LISP ("last-input-char", &last_input_char
,
12008 doc
: /* Last input event. */);
12010 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
12011 doc
: /* Last input event. */);
12013 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
12014 doc
: /* List of events to be read as the command input.
12015 These events are processed first, before actual keyboard input.
12016 Events read from this list are not normally added to `this-command-keys',
12017 as they will already have been added once as they were read for the first time.
12018 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
12019 Vunread_command_events
= Qnil
;
12021 DEFVAR_INT ("unread-command-char", &unread_command_char
,
12022 doc
: /* If not -1, an object to be read as next command input event. */);
12024 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
12025 doc
: /* List of events to be processed as input by input methods.
12026 These events are processed before `unread-command-events'
12027 and actual keyboard input, but are not given to `input-method-function'. */);
12028 Vunread_post_input_method_events
= Qnil
;
12030 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
12031 doc
: /* List of events to be processed as input by input methods.
12032 These events are processed after `unread-command-events', but
12033 before actual keyboard input.
12034 If there's an active input method, the events are given to
12035 `input-method-function'. */);
12036 Vunread_input_method_events
= Qnil
;
12038 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
12039 doc
: /* Meta-prefix character code.
12040 Meta-foo as command input turns into this character followed by foo. */);
12041 XSETINT (meta_prefix_char
, 033);
12043 DEFVAR_KBOARD ("last-command", Vlast_command
,
12044 doc
: /* The last command executed.
12045 Normally a symbol with a function definition, but can be whatever was found
12046 in the keymap, or whatever the variable `this-command' was set to by that
12049 The value `mode-exit' is special; it means that the previous command
12050 read an event that told it to exit, and it did so and unread that event.
12051 In other words, the present command is the event that made the previous
12054 The value `kill-region' is special; it means that the previous command
12055 was a kill command.
12057 `last-command' has a separate binding for each terminal device.
12058 See Info node `(elisp)Multiple displays'. */);
12060 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
12061 doc
: /* Same as `last-command', but never altered by Lisp code. */);
12063 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
12064 doc
: /* Last command that may be repeated.
12065 The last command executed that was not bound to an input event.
12066 This is the command `repeat' will try to repeat. */);
12068 DEFVAR_LISP ("this-command", &Vthis_command
,
12069 doc
: /* The command now being executed.
12070 The command can set this variable; whatever is put here
12071 will be in `last-command' during the following command. */);
12072 Vthis_command
= Qnil
;
12074 DEFVAR_LISP ("this-command-keys-shift-translated",
12075 &Vthis_command_keys_shift_translated
,
12076 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
12077 Shift-translation occurs when there is no binding for the key sequence
12078 as entered, but a binding was found by changing an upper-case letter
12079 to lower-case, or a shifted function key to an unshifted one. */);
12080 Vthis_command_keys_shift_translated
= Qnil
;
12082 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
12083 doc
: /* The command bound to the current key sequence before remapping.
12084 It equals `this-command' if the original command was not remapped through
12085 any of the active keymaps. Otherwise, the value of `this-command' is the
12086 result of looking up the original command in the active keymaps. */);
12087 Vthis_original_command
= Qnil
;
12089 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
12090 doc
: /* *Number of input events between auto-saves.
12091 Zero means disable autosaving due to number of characters typed. */);
12092 auto_save_interval
= 300;
12094 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
12095 doc
: /* *Number of seconds idle time before auto-save.
12096 Zero or nil means disable auto-saving due to idleness.
12097 After auto-saving due to this many seconds of idle time,
12098 Emacs also does a garbage collection if that seems to be warranted. */);
12099 XSETFASTINT (Vauto_save_timeout
, 30);
12101 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
12102 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
12103 The value may be integer or floating point. */);
12104 Vecho_keystrokes
= make_number (1);
12106 DEFVAR_INT ("polling-period", &polling_period
,
12107 doc
: /* *Interval between polling for input during Lisp execution.
12108 The reason for polling is to make C-g work to stop a running program.
12109 Polling is needed only when using X windows and SIGIO does not work.
12110 Polling is automatically disabled in all other cases. */);
12111 polling_period
= 2;
12113 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
12114 doc
: /* *Maximum time between mouse clicks to make a double-click.
12115 Measured in milliseconds. The value nil means disable double-click
12116 recognition; t means double-clicks have no time limit and are detected
12117 by position only. */);
12118 Vdouble_click_time
= make_number (500);
12120 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
12121 doc
: /* *Maximum mouse movement between clicks to make a double-click.
12122 On window-system frames, value is the number of pixels the mouse may have
12123 moved horizontally or vertically between two clicks to make a double-click.
12124 On non window-system frames, value is interpreted in units of 1/8 characters
12127 This variable is also the threshold for motion of the mouse
12128 to count as a drag. */);
12129 double_click_fuzz
= 3;
12131 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
12132 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
12133 inhibit_local_menu_bar_menus
= 0;
12135 DEFVAR_INT ("num-input-keys", &num_input_keys
,
12136 doc
: /* Number of complete key sequences read as input so far.
12137 This includes key sequences read from keyboard macros.
12138 The number is effectively the number of interactive command invocations. */);
12139 num_input_keys
= 0;
12141 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
12142 doc
: /* Number of input events read from the keyboard so far.
12143 This does not include events generated by keyboard macros. */);
12144 num_nonmacro_input_events
= 0;
12146 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
12147 doc
: /* The frame in which the most recently read event occurred.
12148 If the last event came from a keyboard macro, this is set to `macro'. */);
12149 Vlast_event_frame
= Qnil
;
12151 /* This variable is set up in sysdep.c. */
12152 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
12153 doc
: /* The ERASE character as set by the user with stty. */);
12155 DEFVAR_LISP ("help-char", &Vhelp_char
,
12156 doc
: /* Character to recognize as meaning Help.
12157 When it is read, do `(eval help-form)', and display result if it's a string.
12158 If the value of `help-form' is nil, this char can be read normally. */);
12159 XSETINT (Vhelp_char
, Ctl ('H'));
12161 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
12162 doc
: /* List of input events to recognize as meaning Help.
12163 These work just like the value of `help-char' (see that). */);
12164 Vhelp_event_list
= Qnil
;
12166 DEFVAR_LISP ("help-form", &Vhelp_form
,
12167 doc
: /* Form to execute when character `help-char' is read.
12168 If the form returns a string, that string is displayed.
12169 If `help-form' is nil, the help char is not recognized. */);
12172 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12173 doc
: /* Command to run when `help-char' character follows a prefix key.
12174 This command is used only when there is no actual binding
12175 for that character after that prefix key. */);
12176 Vprefix_help_command
= Qnil
;
12178 DEFVAR_LISP ("top-level", &Vtop_level
,
12179 doc
: /* Form to evaluate when Emacs starts up.
12180 Useful to set before you dump a modified Emacs. */);
12183 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12184 doc
: /* Translate table for local keyboard input, or nil.
12185 If non-nil, the value should be a char-table. Each character read
12186 from the keyboard is looked up in this char-table. If the value found
12187 there is non-nil, then it is used instead of the actual input character.
12189 The value can also be a string or vector, but this is considered obsolete.
12190 If it is a string or vector of length N, character codes N and up are left
12191 untranslated. In a vector, an element which is nil means "no translation".
12193 This is applied to the characters supplied to input methods, not their
12194 output. See also `translation-table-for-input'.
12196 This variable has a separate binding for each terminal. See Info node
12197 `(elisp)Multiple displays'. */);
12199 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12200 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12201 \(Even if the operating system has support for stopping a process.\) */);
12202 cannot_suspend
= 0;
12204 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12205 doc
: /* Non-nil means prompt with menus when appropriate.
12206 This is done when reading from a keymap that has a prompt string,
12207 for elements that have prompt strings.
12208 The menu is displayed on the screen
12209 if X menus were enabled at configuration
12210 time and the previous event was a mouse click prefix key.
12211 Otherwise, menu prompting uses the echo area. */);
12212 menu_prompting
= 1;
12214 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12215 doc
: /* Character to see next line of menu prompt.
12216 Type this character while in a menu prompt to rotate around the lines of it. */);
12217 XSETINT (menu_prompt_more_char
, ' ');
12219 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12220 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12221 Emacs applies the modifiers of the character stored here to each keyboard
12222 character it reads. For example, after evaluating the expression
12223 (setq extra-keyboard-modifiers ?\\C-x)
12224 all input characters will have the control modifier applied to them.
12226 Note that the character ?\\C-@, equivalent to the integer zero, does
12227 not count as a control character; rather, it counts as a character
12228 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12229 cancels any modification. */);
12230 extra_keyboard_modifiers
= 0;
12232 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12233 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12234 The command loop sets this to nil before each command,
12235 and tests the value when the command returns.
12236 Buffer modification stores t in this variable. */);
12237 Vdeactivate_mark
= Qnil
;
12238 Qdeactivate_mark
= intern ("deactivate-mark");
12239 staticpro (&Qdeactivate_mark
);
12241 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12242 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
12243 Vcommand_hook_internal
= Qnil
;
12245 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12246 doc
: /* Normal hook run before each command is executed.
12247 If an unhandled error happens in running this hook,
12248 the hook value is set to nil, since otherwise the error
12249 might happen repeatedly and make Emacs nonfunctional. */);
12250 Vpre_command_hook
= Qnil
;
12252 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12253 doc
: /* Normal hook run after each command is executed.
12254 If an unhandled error happens in running this hook,
12255 the hook value is set to nil, since otherwise the error
12256 might happen repeatedly and make Emacs nonfunctional. */);
12257 Vpost_command_hook
= Qnil
;
12260 DEFVAR_LISP ("echo-area-clear-hook", ...,
12261 doc
: /* Normal hook run when clearing the echo area. */);
12263 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
12264 staticpro (&Qecho_area_clear_hook
);
12265 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
12267 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12268 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12269 Vlucid_menu_bar_dirty_flag
= Qnil
;
12271 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12272 doc
: /* List of menu bar items to move to the end of the menu bar.
12273 The elements of the list are event types that may have menu bar bindings. */);
12274 Vmenu_bar_final_items
= Qnil
;
12276 DEFVAR_KBOARD ("overriding-terminal-local-map",
12277 Voverriding_terminal_local_map
,
12278 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12279 If this variable is non-nil, it is used as a keymap instead of the
12280 buffer's local map, and the minor mode keymaps and text property keymaps.
12281 It also replaces `overriding-local-map'.
12283 This variable is intended to let commands such as `universal-argument'
12284 set up a different keymap for reading the next command.
12286 `overriding-terminal-local-map' has a separate binding for each
12288 See Info node `(elisp)Multiple displays'. */);
12290 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12291 doc
: /* Keymap that overrides all other local keymaps.
12292 If this variable is non-nil, it is used as a keymap--replacing the
12293 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12294 Voverriding_local_map
= Qnil
;
12296 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12297 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12298 Otherwise, the menu bar continues to reflect the buffer's local map
12299 and the minor mode maps regardless of `overriding-local-map'. */);
12300 Voverriding_local_map_menu_flag
= Qnil
;
12302 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12303 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12304 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
12306 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12307 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12309 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12310 doc
: /* Alist of system-specific X windows key symbols.
12311 Each element should have the form (N . SYMBOL) where N is the
12312 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12313 and SYMBOL is its name.
12315 `system-key-alist' has a separate binding for each terminal device.
12316 See Info node `(elisp)Multiple displays'. */);
12318 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12319 doc
: /* Keymap that translates key sequences to key sequences during input.
12320 This is used mainly for mapping key sequences into some preferred
12321 key events (symbols).
12323 The `read-key-sequence' function replaces any subsequence bound by
12324 `local-function-key-map' with its binding. More precisely, when the
12325 active keymaps have no binding for the current key sequence but
12326 `local-function-key-map' binds a suffix of the sequence to a vector or
12327 string, `read-key-sequence' replaces the matching suffix with its
12328 binding, and continues with the new sequence.
12330 If the binding is a function, it is called with one argument (the prompt)
12331 and its return value (a key sequence) is used.
12333 The events that come from bindings in `local-function-key-map' are not
12334 themselves looked up in `local-function-key-map'.
12336 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12337 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12338 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12339 typing `ESC O P x' would return [f1 x].
12341 `local-function-key-map' has a separate binding for each terminal
12342 device. See Info node `(elisp)Multiple displays'. If you need to
12343 define a binding on all terminals, change `function-key-map'
12344 instead. Initially, `local-function-key-map' is an empty keymap that
12345 has `function-key-map' as its parent on all terminal devices. */);
12347 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12348 doc
: /* Keymap that decodes input escape sequences.
12349 This is used mainly for mapping ASCII function key sequences into
12350 real Emacs function key events (symbols).
12352 The `read-key-sequence' function replaces any subsequence bound by
12353 `local-function-key-map' with its binding. Contrary to `function-key-map',
12354 this map applies its rebinding regardless of the presence of an ordinary
12355 binding. So it is more like `key-translation-map' except that it applies
12356 before `function-key-map' rather than after.
12358 If the binding is a function, it is called with one argument (the prompt)
12359 and its return value (a key sequence) is used.
12361 The events that come from bindings in `input-decode-map' are not
12362 themselves looked up in `input-decode-map'.
12364 This variable is keyboard-local. */);
12366 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12367 doc
: /* The parent keymap of all `local-function-key-map' instances.
12368 Function key definitions that apply to all terminal devices should go
12369 here. If a mapping is defined in both the current
12370 `local-function-key-map' binding and this variable, then the local
12371 definition will take precendence. */);
12372 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12374 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12375 doc
: /* Keymap of key translations that can override keymaps.
12376 This keymap works like `function-key-map', but comes after that,
12377 and its non-prefix bindings override ordinary bindings.
12378 Another difference is that it is global rather than keyboard-local. */);
12379 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12381 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12382 doc
: /* List of deferred actions to be performed at a later time.
12383 The precise format isn't relevant here; we just check whether it is nil. */);
12384 Vdeferred_action_list
= Qnil
;
12386 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12387 doc
: /* Function to call to handle deferred actions, after each command.
12388 This function is called with no arguments after each command
12389 whenever `deferred-action-list' is non-nil. */);
12390 Vdeferred_action_function
= Qnil
;
12392 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12393 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12394 The value can be a length of time to show the message for.
12395 If the value is non-nil and not a number, we wait 2 seconds. */);
12396 Vsuggest_key_bindings
= Qt
;
12398 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12399 doc
: /* List of active absolute time timers in order of increasing time. */);
12400 Vtimer_list
= Qnil
;
12402 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12403 doc
: /* List of active idle-time timers in order of increasing time. */);
12404 Vtimer_idle_list
= Qnil
;
12406 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12407 doc
: /* If non-nil, the function that implements the current input method.
12408 It's called with one argument, a printing character that was just read.
12409 \(That means a character with code 040...0176.)
12410 Typically this function uses `read-event' to read additional events.
12411 When it does so, it should first bind `input-method-function' to nil
12412 so it will not be called recursively.
12414 The function should return a list of zero or more events
12415 to be used as input. If it wants to put back some events
12416 to be reconsidered, separately, by the input method,
12417 it can add them to the beginning of `unread-command-events'.
12419 The input method function can find in `input-method-previous-method'
12420 the previous echo area message.
12422 The input method function should refer to the variables
12423 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12424 for guidance on what to do. */);
12425 Vinput_method_function
= Qnil
;
12427 DEFVAR_LISP ("input-method-previous-message",
12428 &Vinput_method_previous_message
,
12429 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12430 This variable exists because `read-event' clears the echo area
12431 before running the input method. It is nil if there was no message. */);
12432 Vinput_method_previous_message
= Qnil
;
12434 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12435 doc
: /* If non-nil, the function that implements the display of help.
12436 It's called with one argument, the help string to display. */);
12437 Vshow_help_function
= Qnil
;
12439 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12440 doc
: /* If non-nil, suppress point adjustment after executing a command.
12442 After a command is executed, if point is moved into a region that has
12443 special properties (e.g. composition, display), we adjust point to
12444 the boundary of the region. But, when a command sets this variable to
12445 non-nil, we suppress the point adjustment.
12447 This variable is set to nil before reading a command, and is checked
12448 just after executing the command. */);
12449 Vdisable_point_adjustment
= Qnil
;
12451 DEFVAR_LISP ("global-disable-point-adjustment",
12452 &Vglobal_disable_point_adjustment
,
12453 doc
: /* *If non-nil, always suppress point adjustment.
12455 The default value is nil, in which case, point adjustment are
12456 suppressed only after special commands that set
12457 `disable-point-adjustment' (which see) to non-nil. */);
12458 Vglobal_disable_point_adjustment
= Qnil
;
12460 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12461 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12462 If the value is not a number, such messages don't time out. */);
12463 Vminibuffer_message_timeout
= make_number (2);
12465 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12466 doc
: /* If non-nil, any keyboard input throws to this symbol.
12467 The value of that variable is passed to `quit-flag' and later causes a
12468 peculiar kind of quitting. */);
12469 Vthrow_on_input
= Qnil
;
12471 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12472 doc
: /* If non-nil, function to output error messages.
12473 The arguments are the error data, a list of the form
12474 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12475 such as just as `condition-case' would bind its variable to,
12476 the context (a string which normally goes at the start of the message),
12477 and the Lisp function within which the error was signaled. */);
12478 Vcommand_error_function
= Qnil
;
12480 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12481 &Venable_disabled_menus_and_buttons
,
12482 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12484 Help functions bind this to allow help on disabled menu items
12485 and tool-bar buttons. */);
12486 Venable_disabled_menus_and_buttons
= Qnil
;
12488 #ifdef MULTI_KBOARD
12489 /* Create the initial keyboard. */
12490 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12491 init_kboard (initial_kboard
);
12492 /* Vwindow_system is left at t for now. */
12493 initial_kboard
->next_kboard
= all_kboards
;
12494 all_kboards
= initial_kboard
;
12499 keys_of_keyboard ()
12501 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12502 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12503 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12504 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12505 initial_define_key (meta_map
, 'x', "execute-extended-command");
12507 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12508 "handle-delete-frame");
12509 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12510 current-prefix-arg, as is done in `handle-switch-frame'.
12511 But `handle-switch-frame is not run from the special-map.
12512 Commands from that map are run in a special way that automatically
12513 preserves the prefix-arg. Restoring the prefix arg here is not just
12514 redundant but harmful:
12516 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12517 - after the first prompt, the exit-minibuffer-hook is run which may
12518 iconify a frame and thus push a `iconify-frame' event.
12519 - after running exit-minibuffer-hook, current-prefix-arg is
12520 restored to the non-nil value it had before the prompt.
12521 - we enter the second prompt.
12522 current-prefix-arg is non-nil, prefix-arg is nil.
12523 - before running the first real event, we run the special iconify-frame
12524 event, but we pass the `special' arg to execute-command so
12525 current-prefix-arg and prefix-arg are left untouched.
12526 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12527 - the next key event will have a spuriously non-nil current-prefix-arg. */
12528 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12530 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12532 /* Handling it at such a low-level causes read_key_sequence to get
12533 * confused because it doesn't realize that the current_buffer was
12534 * changed by read_char.
12536 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12537 * "handle-select-window"); */
12538 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12539 "handle-save-session");
12542 /* Define a special event which is raised for dbus callback
12544 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12545 "dbus-handle-event");
12549 /* Mark the pointers in the kboard objects.
12550 Called by the Fgarbage_collector. */
12556 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12558 if (kb
->kbd_macro_buffer
)
12559 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12561 mark_object (kb
->Voverriding_terminal_local_map
);
12562 mark_object (kb
->Vlast_command
);
12563 mark_object (kb
->Vreal_last_command
);
12564 mark_object (kb
->Vkeyboard_translate_table
);
12565 mark_object (kb
->Vlast_repeatable_command
);
12566 mark_object (kb
->Vprefix_arg
);
12567 mark_object (kb
->Vlast_prefix_arg
);
12568 mark_object (kb
->kbd_queue
);
12569 mark_object (kb
->defining_kbd_macro
);
12570 mark_object (kb
->Vlast_kbd_macro
);
12571 mark_object (kb
->Vsystem_key_alist
);
12572 mark_object (kb
->system_key_syms
);
12573 mark_object (kb
->Vwindow_system
);
12574 mark_object (kb
->Vinput_decode_map
);
12575 mark_object (kb
->Vlocal_function_key_map
);
12576 mark_object (kb
->Vdefault_minibuffer_frame
);
12577 mark_object (kb
->echo_string
);
12580 struct input_event
*event
;
12581 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12583 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12584 event
= kbd_buffer
;
12585 if (event
->kind
!= SELECTION_REQUEST_EVENT
12586 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12588 mark_object (event
->x
);
12589 mark_object (event
->y
);
12591 mark_object (event
->frame_or_window
);
12592 mark_object (event
->arg
);
12597 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12598 (do not change this comment) */