1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
3 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
28 #include "termhooks.h"
34 #include "character.h"
36 #include "dispextern.h"
38 #include "intervals.h"
40 #include "blockinput.h"
47 #ifdef HAVE_GTK_AND_PTHREAD
55 #include <sys/ioctl.h>
57 #endif /* not MSDOS */
59 #include "syssignal.h"
61 #include <sys/types.h>
70 /* This is to get the definitions of the XK_ symbols. */
77 #endif /* HAVE_NTGUI */
87 /* Variables for blockinput.h: */
89 /* Non-zero if interrupt input is blocked right now. */
90 volatile int interrupt_input_blocked
;
92 /* Nonzero means an input interrupt has arrived
93 during the current critical section. */
94 int interrupt_input_pending
;
96 #define KBD_BUFFER_SIZE 4096
98 KBOARD
*initial_kboard
;
99 KBOARD
*current_kboard
;
103 /* Non-nil disable property on a command means
104 do not execute it; call disabled-command-function's value instead. */
105 Lisp_Object Qdisabled
, Qdisabled_command_function
;
107 #define NUM_RECENT_KEYS (300)
108 int recent_keys_index
; /* Index for storing next element into recent_keys */
109 int total_keys
; /* Total number of elements stored into recent_keys */
110 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
112 /* Vector holding the key sequence that invoked the current command.
113 It is reused for each command, and it may be longer than the current
114 sequence; this_command_key_count indicates how many elements
115 actually mean something.
116 It's easier to staticpro a single Lisp_Object than an array. */
117 Lisp_Object this_command_keys
;
118 int this_command_key_count
;
120 /* 1 after calling Freset_this_command_lengths.
122 int this_command_key_count_reset
;
124 /* This vector is used as a buffer to record the events that were actually read
125 by read_key_sequence. */
126 Lisp_Object raw_keybuf
;
127 int raw_keybuf_count
;
129 /* Non-nil if the present key sequence was obtained by shift translation. */
130 Lisp_Object Vthis_command_keys_shift_translated
;
132 #define GROW_RAW_KEYBUF \
133 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
134 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
136 /* Number of elements of this_command_keys
137 that precede this key sequence. */
138 int this_single_command_key_start
;
140 /* Record values of this_command_key_count and echo_length ()
141 before this command was read. */
142 static int before_command_key_count
;
143 static int before_command_echo_length
;
145 extern int minbuf_level
;
147 extern int message_enable_multibyte
;
149 /* If non-nil, the function that implements the display of help.
150 It's called with one argument, the help string to display. */
152 Lisp_Object Vshow_help_function
;
154 /* Nonzero means do menu prompting. */
156 static int menu_prompting
;
158 /* Character to see next line of menu prompt. */
160 static Lisp_Object menu_prompt_more_char
;
162 /* For longjmp to where kbd input is being done. */
164 static jmp_buf getcjmp
;
166 /* True while doing kbd input. */
167 int waiting_for_input
;
169 /* True while displaying for echoing. Delays C-g throwing. */
173 /* Non-null means we can start echoing at the next input pause even
174 though there is something in the echo area. */
176 static struct kboard
*ok_to_echo_at_next_pause
;
178 /* The kboard last echoing, or null for none. Reset to 0 in
179 cancel_echoing. If non-null, and a current echo area message
180 exists, and echo_message_buffer is eq to the current message
181 buffer, we know that the message comes from echo_kboard. */
183 struct kboard
*echo_kboard
;
185 /* The buffer used for echoing. Set in echo_now, reset in
188 Lisp_Object echo_message_buffer
;
190 /* Nonzero means disregard local maps for the menu bar. */
191 static int inhibit_local_menu_bar_menus
;
193 /* Nonzero means C-g should cause immediate error-signal. */
196 /* The user's hook function for outputting an error message. */
197 Lisp_Object Vcommand_error_function
;
199 /* The user's ERASE setting. */
200 Lisp_Object Vtty_erase_char
;
202 /* Character to recognize as the help char. */
203 Lisp_Object Vhelp_char
;
205 /* List of other event types to recognize as meaning "help". */
206 Lisp_Object Vhelp_event_list
;
208 /* Form to execute when help char is typed. */
209 Lisp_Object Vhelp_form
;
211 /* Command to run when the help character follows a prefix key. */
212 Lisp_Object Vprefix_help_command
;
214 /* List of items that should move to the end of the menu bar. */
215 Lisp_Object Vmenu_bar_final_items
;
217 /* Non-nil means show the equivalent key-binding for
218 any M-x command that has one.
219 The value can be a length of time to show the message for.
220 If the value is non-nil and not a number, we wait 2 seconds. */
221 Lisp_Object Vsuggest_key_bindings
;
223 /* How long to display an echo-area message when the minibuffer is active.
224 If the value is not a number, such messages don't time out. */
225 Lisp_Object Vminibuffer_message_timeout
;
227 /* Character that causes a quit. Normally C-g.
229 If we are running on an ordinary terminal, this must be an ordinary
230 ASCII char, since we want to make it our interrupt character.
232 If we are not running on an ordinary terminal, it still needs to be
233 an ordinary ASCII char. This character needs to be recognized in
234 the input interrupt handler. At this point, the keystroke is
235 represented as a struct input_event, while the desired quit
236 character is specified as a lispy event. The mapping from struct
237 input_events to lispy events cannot run in an interrupt handler,
238 and the reverse mapping is difficult for anything but ASCII
241 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
245 extern Lisp_Object current_global_map
;
246 extern int minibuf_level
;
248 /* If non-nil, this is a map that overrides all other local maps. */
249 Lisp_Object Voverriding_local_map
;
251 /* If non-nil, Voverriding_local_map applies to the menu bar. */
252 Lisp_Object Voverriding_local_map_menu_flag
;
254 /* Keymap that defines special misc events that should
255 be processed immediately at a low level. */
256 Lisp_Object Vspecial_event_map
;
258 /* Current depth in recursive edits. */
259 int command_loop_level
;
261 /* Total number of times command_loop has read a key sequence. */
262 EMACS_INT num_input_keys
;
264 /* Last input character read as a command. */
265 Lisp_Object last_command_char
;
267 /* Last input character read as a command, not counting menus
268 reached by the mouse. */
269 Lisp_Object last_nonmenu_event
;
271 /* Last input character read for any purpose. */
272 Lisp_Object last_input_char
;
274 /* If not Qnil, a list of objects to be read as subsequent command input. */
275 Lisp_Object Vunread_command_events
;
277 /* If not Qnil, a list of objects to be read as subsequent command input
278 including input method processing. */
279 Lisp_Object Vunread_input_method_events
;
281 /* If not Qnil, a list of objects to be read as subsequent command input
282 but NOT including input method processing. */
283 Lisp_Object Vunread_post_input_method_events
;
285 /* If not -1, an event to be read as subsequent command input. */
286 EMACS_INT unread_command_char
;
288 /* If not Qnil, this is a switch-frame event which we decided to put
289 off until the end of a key sequence. This should be read as the
290 next command input, after any unread_command_events.
292 read_key_sequence uses this to delay switch-frame events until the
293 end of the key sequence; Fread_char uses it to put off switch-frame
294 events until a non-ASCII event is acceptable as input. */
295 Lisp_Object unread_switch_frame
;
297 /* A mask of extra modifier bits to put into every keyboard char. */
298 EMACS_INT extra_keyboard_modifiers
;
300 /* Char to use as prefix when a meta character is typed in.
301 This is bound on entry to minibuffer in case ESC is changed there. */
303 Lisp_Object meta_prefix_char
;
305 /* Last size recorded for a current buffer which is not a minibuffer. */
306 static int last_non_minibuf_size
;
308 /* Number of idle seconds before an auto-save and garbage collection. */
309 static Lisp_Object Vauto_save_timeout
;
311 /* Total number of times read_char has returned. */
312 int num_input_events
;
314 /* Total number of times read_char has returned, outside of macros. */
315 EMACS_INT num_nonmacro_input_events
;
317 /* Auto-save automatically when this many characters have been typed
318 since the last time. */
320 static EMACS_INT auto_save_interval
;
322 /* Value of num_nonmacro_input_events as of last auto save. */
326 /* The command being executed by the command loop.
327 Commands may set this, and the value set will be copied into
328 current_kboard->Vlast_command instead of the actual command. */
329 Lisp_Object Vthis_command
;
331 /* This is like Vthis_command, except that commands never set it. */
332 Lisp_Object real_this_command
;
334 /* If the lookup of the command returns a binding, the original
335 command is stored in this-original-command. It is nil otherwise. */
336 Lisp_Object Vthis_original_command
;
338 /* The value of point when the last command was started. */
339 int last_point_position
;
341 /* The buffer that was current when the last command was started. */
342 Lisp_Object last_point_position_buffer
;
344 /* The window that was selected when the last command was started. */
345 Lisp_Object last_point_position_window
;
347 /* The frame in which the last input event occurred, or Qmacro if the
348 last event came from a macro. We use this to determine when to
349 generate switch-frame events. This may be cleared by functions
350 like Fselect_frame, to make sure that a switch-frame event is
351 generated by the next character. */
352 Lisp_Object internal_last_event_frame
;
354 /* A user-visible version of the above, intended to allow users to
355 figure out where the last event came from, if the event doesn't
356 carry that information itself (i.e. if it was a character). */
357 Lisp_Object Vlast_event_frame
;
359 /* The timestamp of the last input event we received from the X server.
360 X Windows wants this for selection ownership. */
361 unsigned long last_event_timestamp
;
363 Lisp_Object Qself_insert_command
;
364 Lisp_Object Qforward_char
;
365 Lisp_Object Qbackward_char
;
366 Lisp_Object Qundefined
;
367 Lisp_Object Qtimer_event_handler
;
369 /* read_key_sequence stores here the command definition of the
370 key sequence that it reads. */
371 Lisp_Object read_key_sequence_cmd
;
373 /* Echo unfinished commands after this many seconds of pause. */
374 Lisp_Object Vecho_keystrokes
;
376 /* Form to evaluate (if non-nil) when Emacs is started. */
377 Lisp_Object Vtop_level
;
379 /* If non-nil, this implements the current input method. */
380 Lisp_Object Vinput_method_function
;
381 Lisp_Object Qinput_method_function
;
383 /* When we call Vinput_method_function,
384 this holds the echo area message that was just erased. */
385 Lisp_Object Vinput_method_previous_message
;
387 /* Non-nil means deactivate the mark at end of this command. */
388 Lisp_Object Vdeactivate_mark
;
389 Lisp_Object Qdeactivate_mark
;
391 /* Menu bar specified in Lucid Emacs fashion. */
393 Lisp_Object Vlucid_menu_bar_dirty_flag
;
394 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
396 Lisp_Object Qecho_area_clear_hook
;
398 /* Hooks to run before and after each command. */
399 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
400 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
401 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
403 /* Parent keymap of terminal-local function-key-map instances. */
404 Lisp_Object Vfunction_key_map
;
406 /* Keymap of key translations that can override keymaps. */
407 Lisp_Object Vkey_translation_map
;
409 /* List of deferred actions to be performed at a later time.
410 The precise format isn't relevant here; we just check whether it is nil. */
411 Lisp_Object Vdeferred_action_list
;
413 /* Function to call to handle deferred actions, when there are any. */
414 Lisp_Object Vdeferred_action_function
;
415 Lisp_Object Qdeferred_action_function
;
417 Lisp_Object Qinput_method_exit_on_first_char
;
418 Lisp_Object Qinput_method_use_echo_area
;
420 /* File in which we write all commands we read. */
423 /* Nonzero if input is available. */
426 extern char *pending_malloc_warning
;
428 /* Circular buffer for pre-read keyboard input. */
430 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
432 /* Pointer to next available character in kbd_buffer.
433 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
434 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
435 next available char is in kbd_buffer[0]. */
436 static struct input_event
*kbd_fetch_ptr
;
438 /* Pointer to next place to store character in kbd_buffer. This
439 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
440 character should go in kbd_buffer[0]. */
441 static struct input_event
* volatile kbd_store_ptr
;
443 /* The above pair of variables forms a "queue empty" flag. When we
444 enqueue a non-hook event, we increment kbd_store_ptr. When we
445 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
446 there is input available if the two pointers are not equal.
448 Why not just have a flag set and cleared by the enqueuing and
449 dequeuing functions? Such a flag could be screwed up by interrupts
450 at inopportune times. */
452 /* If this flag is non-nil, we check mouse_moved to see when the
453 mouse moves, and motion events will appear in the input stream.
454 Otherwise, mouse motion is ignored. */
455 Lisp_Object do_mouse_tracking
;
457 /* Symbols to head events. */
458 Lisp_Object Qmouse_movement
;
459 Lisp_Object Qscroll_bar_movement
;
460 Lisp_Object Qswitch_frame
;
461 Lisp_Object Qdelete_frame
;
462 Lisp_Object Qiconify_frame
;
463 Lisp_Object Qmake_frame_visible
;
464 Lisp_Object Qselect_window
;
465 Lisp_Object Qhelp_echo
;
467 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
468 Lisp_Object Qmouse_fixup_help_message
;
471 /* Symbols to denote kinds of events. */
472 Lisp_Object Qfunction_key
;
473 Lisp_Object Qmouse_click
;
474 #if defined (WINDOWSNT)
475 Lisp_Object Qlanguage_change
;
477 Lisp_Object Qdrag_n_drop
;
478 Lisp_Object Qsave_session
;
480 Lisp_Object Qdbus_event
;
482 /* Lisp_Object Qmouse_movement; - also an event header */
484 /* Properties of event headers. */
485 Lisp_Object Qevent_kind
;
486 Lisp_Object Qevent_symbol_elements
;
488 /* menu item parts */
489 Lisp_Object Qmenu_alias
;
490 Lisp_Object Qmenu_enable
;
491 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
492 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
493 extern Lisp_Object Vdefine_key_rebound_commands
;
494 extern Lisp_Object Qmenu_item
;
496 /* An event header symbol HEAD may have a property named
497 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
498 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
499 mask of modifiers applied to it. If present, this is used to help
500 speed up parse_modifiers. */
501 Lisp_Object Qevent_symbol_element_mask
;
503 /* An unmodified event header BASE may have a property named
504 Qmodifier_cache, which is an alist mapping modifier masks onto
505 modified versions of BASE. If present, this helps speed up
507 Lisp_Object Qmodifier_cache
;
509 /* Symbols to use for parts of windows. */
510 Lisp_Object Qmode_line
;
511 Lisp_Object Qvertical_line
;
512 Lisp_Object Qvertical_scroll_bar
;
513 Lisp_Object Qmenu_bar
;
514 extern Lisp_Object Qleft_margin
, Qright_margin
;
515 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
516 extern Lisp_Object QCmap
;
518 Lisp_Object
recursive_edit_unwind (), command_loop ();
519 Lisp_Object
Fthis_command_keys ();
520 Lisp_Object Qextended_command_history
;
521 EMACS_TIME
timer_check ();
523 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
525 extern char *x_get_keysym_name ();
527 static void record_menu_key ();
528 static int echo_length ();
530 Lisp_Object Qpolling_period
;
532 /* List of absolute timers. Appears in order of next scheduled event. */
533 Lisp_Object Vtimer_list
;
535 /* List of idle time timers. Appears in order of next scheduled event. */
536 Lisp_Object Vtimer_idle_list
;
538 /* Incremented whenever a timer is run. */
541 extern Lisp_Object Vprint_level
, Vprint_length
;
543 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
545 EMACS_TIME
*input_available_clear_time
;
547 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
548 Default is 1 if INTERRUPT_INPUT is defined. */
551 /* Nonzero while interrupts are temporarily deferred during redisplay. */
552 int interrupts_deferred
;
554 /* Allow m- file to inhibit use of FIONREAD. */
555 #ifdef BROKEN_FIONREAD
559 /* We are unable to use interrupts if FIONREAD is not available,
560 so flush SIGIO so we won't try. */
561 #if !defined (FIONREAD)
567 /* If we support a window system, turn on the code to poll periodically
568 to detect C-g. It isn't actually used when doing interrupt input. */
569 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
570 #define POLL_FOR_INPUT
573 /* After a command is executed, if point is moved into a region that
574 has specific properties (e.g. composition, display), we adjust
575 point to the boundary of the region. But, if a command sets this
576 variable to non-nil, we suppress this point adjustment. This
577 variable is set to nil before reading a command. */
579 Lisp_Object Vdisable_point_adjustment
;
581 /* If non-nil, always disable point adjustment. */
583 Lisp_Object Vglobal_disable_point_adjustment
;
585 /* The time when Emacs started being idle. */
587 static EMACS_TIME timer_idleness_start_time
;
589 /* After Emacs stops being idle, this saves the last value
590 of timer_idleness_start_time from when it was idle. */
592 static EMACS_TIME timer_last_idleness_start_time
;
594 /* If non-nil, events produced by disabled menu items and tool-bar
595 buttons are not ignored. Help functions bind this to allow help on
596 those items and buttons. */
597 Lisp_Object Venable_disabled_menus_and_buttons
;
600 /* Global variable declarations. */
602 /* Flags for readable_events. */
603 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
604 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
605 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
607 /* Function for init_keyboard to call with no args (if nonzero). */
608 void (*keyboard_init_hook
) ();
610 static int read_avail_input
P_ ((int));
611 static void get_input_pending
P_ ((int *, int));
612 static int readable_events
P_ ((int));
613 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
614 Lisp_Object
, int *));
615 static Lisp_Object
read_char_x_menu_prompt ();
616 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
618 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
619 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
620 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
621 enum scroll_bar_part
,
622 Lisp_Object
, Lisp_Object
,
625 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
626 Lisp_Object
, char **,
627 Lisp_Object
*, unsigned));
628 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
629 static void save_getcjmp
P_ ((jmp_buf));
630 static void save_getcjmp ();
631 static void restore_getcjmp
P_ ((jmp_buf));
632 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
633 static void clear_event
P_ ((struct input_event
*));
634 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
635 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
636 static void handle_interrupt
P_ ((void));
637 static void timer_start_idle
P_ ((void));
638 static void timer_stop_idle
P_ ((void));
639 static void timer_resume_idle
P_ ((void));
640 static SIGTYPE handle_user_signal
P_ ((int));
641 static char *find_user_signal_name
P_ ((int));
642 static int store_user_signal_events
P_ ((void));
644 /* Nonzero means don't try to suspend even if the operating system seems
646 static int cannot_suspend
;
648 extern Lisp_Object Qidentity
, Qonly
;
650 /* Install the string STR as the beginning of the string of echoing,
651 so that it serves as a prompt for the next character.
652 Also start echoing. */
658 current_kboard
->echo_string
= str
;
659 current_kboard
->echo_after_prompt
= SCHARS (str
);
663 /* Add C to the echo string, if echoing is going on.
664 C can be a character, which is printed prettily ("M-C-x" and all that
665 jazz), or a symbol, whose name is printed. */
671 if (current_kboard
->immediate_echo
)
673 int size
= KEY_DESCRIPTION_SIZE
+ 100;
674 char *buffer
= (char *) alloca (size
);
676 Lisp_Object echo_string
;
678 echo_string
= current_kboard
->echo_string
;
680 /* If someone has passed us a composite event, use its head symbol. */
685 ptr
= push_key_description (XINT (c
), ptr
, 1);
687 else if (SYMBOLP (c
))
689 Lisp_Object name
= SYMBOL_NAME (c
);
690 int nbytes
= SBYTES (name
);
692 if (size
- (ptr
- buffer
) < nbytes
)
694 int offset
= ptr
- buffer
;
695 size
= max (2 * size
, size
+ nbytes
);
696 buffer
= (char *) alloca (size
);
697 ptr
= buffer
+ offset
;
700 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
701 STRING_MULTIBYTE (name
), 1);
704 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
707 const char *text
= " (Type ? for further options)";
708 int len
= strlen (text
);
710 if (size
- (ptr
- buffer
) < len
)
712 int offset
= ptr
- buffer
;
714 buffer
= (char *) alloca (size
);
715 ptr
= buffer
+ offset
;
718 bcopy (text
, ptr
, len
);
722 /* Replace a dash from echo_dash with a space, otherwise
723 add a space at the end as a separator between keys. */
724 if (STRINGP (echo_string
)
725 && SCHARS (echo_string
) > 1)
727 Lisp_Object last_char
, prev_char
, idx
;
729 idx
= make_number (SCHARS (echo_string
) - 2);
730 prev_char
= Faref (echo_string
, idx
);
732 idx
= make_number (SCHARS (echo_string
) - 1);
733 last_char
= Faref (echo_string
, idx
);
735 /* We test PREV_CHAR to make sure this isn't the echoing
737 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
738 Faset (echo_string
, idx
, make_number (' '));
740 echo_string
= concat2 (echo_string
, build_string (" "));
742 else if (STRINGP (echo_string
))
743 echo_string
= concat2 (echo_string
, build_string (" "));
745 current_kboard
->echo_string
746 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
752 /* Temporarily add a dash to the end of the echo string if it's not
753 empty, so that it serves as a mini-prompt for the very next character. */
758 /* Do nothing if not echoing at all. */
759 if (NILP (current_kboard
->echo_string
))
762 if (!current_kboard
->immediate_echo
763 && SCHARS (current_kboard
->echo_string
) == 0)
766 /* Do nothing if we just printed a prompt. */
767 if (current_kboard
->echo_after_prompt
768 == SCHARS (current_kboard
->echo_string
))
771 /* Do nothing if we have already put a dash at the end. */
772 if (SCHARS (current_kboard
->echo_string
) > 1)
774 Lisp_Object last_char
, prev_char
, idx
;
776 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
777 prev_char
= Faref (current_kboard
->echo_string
, idx
);
779 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
780 last_char
= Faref (current_kboard
->echo_string
, idx
);
782 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
786 /* Put a dash at the end of the buffer temporarily,
787 but make it go away when the next character is added. */
788 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
793 /* Display the current echo string, and begin echoing if not already
799 if (!current_kboard
->immediate_echo
)
802 current_kboard
->immediate_echo
= 1;
804 for (i
= 0; i
< this_command_key_count
; i
++)
808 /* Set before_command_echo_length to the value that would
809 have been saved before the start of this subcommand in
810 command_loop_1, if we had already been echoing then. */
811 if (i
== this_single_command_key_start
)
812 before_command_echo_length
= echo_length ();
814 c
= XVECTOR (this_command_keys
)->contents
[i
];
815 if (! (EVENT_HAS_PARAMETERS (c
)
816 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
820 /* Set before_command_echo_length to the value that would
821 have been saved before the start of this subcommand in
822 command_loop_1, if we had already been echoing then. */
823 if (this_command_key_count
== this_single_command_key_start
)
824 before_command_echo_length
= echo_length ();
826 /* Put a dash at the end to invite the user to type more. */
831 message3_nolog (current_kboard
->echo_string
,
832 SBYTES (current_kboard
->echo_string
),
833 STRING_MULTIBYTE (current_kboard
->echo_string
));
836 /* Record in what buffer we echoed, and from which kboard. */
837 echo_message_buffer
= echo_area_buffer
[0];
838 echo_kboard
= current_kboard
;
840 if (waiting_for_input
&& !NILP (Vquit_flag
))
841 quit_throw_to_read_char ();
844 /* Turn off echoing, for the start of a new command. */
849 current_kboard
->immediate_echo
= 0;
850 current_kboard
->echo_after_prompt
= -1;
851 current_kboard
->echo_string
= Qnil
;
852 ok_to_echo_at_next_pause
= NULL
;
854 echo_message_buffer
= Qnil
;
857 /* Return the length of the current echo string. */
862 return (STRINGP (current_kboard
->echo_string
)
863 ? SCHARS (current_kboard
->echo_string
)
867 /* Truncate the current echo message to its first LEN chars.
868 This and echo_char get used by read_key_sequence when the user
869 switches frames while entering a key sequence. */
872 echo_truncate (nchars
)
875 if (STRINGP (current_kboard
->echo_string
))
876 current_kboard
->echo_string
877 = Fsubstring (current_kboard
->echo_string
,
878 make_number (0), make_number (nchars
));
879 truncate_echo_area (nchars
);
883 /* Functions for manipulating this_command_keys. */
885 add_command_key (key
)
888 #if 0 /* Not needed after we made Freset_this_command_lengths
889 do the job immediately. */
890 /* If reset-this-command-length was called recently, obey it now.
891 See the doc string of that function for an explanation of why. */
892 if (before_command_restore_flag
)
894 this_command_key_count
= before_command_key_count_1
;
895 if (this_command_key_count
< this_single_command_key_start
)
896 this_single_command_key_start
= this_command_key_count
;
897 echo_truncate (before_command_echo_length_1
);
898 before_command_restore_flag
= 0;
902 if (this_command_key_count
>= ASIZE (this_command_keys
))
903 this_command_keys
= larger_vector (this_command_keys
,
904 2 * ASIZE (this_command_keys
),
907 ASET (this_command_keys
, this_command_key_count
, key
);
908 ++this_command_key_count
;
915 int count
= SPECPDL_INDEX ();
918 if (command_loop_level
> 0)
920 specbind (Qstandard_output
, Qt
);
921 specbind (Qstandard_input
, Qt
);
924 #ifdef HAVE_WINDOW_SYSTEM
925 /* The command loop has started an hourglass timer, so we have to
926 cancel it here, otherwise it will fire because the recursive edit
927 can take some time. Do not check for display_hourglass_p here,
928 because it could already be nil. */
932 /* This function may have been called from a debugger called from
933 within redisplay, for instance by Edebugging a function called
934 from fontification-functions. We want to allow redisplay in
935 the debugging session.
937 The recursive edit is left with a `(throw exit ...)'. The `exit'
938 tag is not caught anywhere in redisplay, i.e. when we leave the
939 recursive edit, the original redisplay leading to the recursive
940 edit will be unwound. The outcome should therefore be safe. */
941 specbind (Qinhibit_redisplay
, Qnil
);
944 val
= command_loop ();
946 Fsignal (Qquit
, Qnil
);
947 /* Handle throw from read_minibuf when using minibuffer
948 while it's active but we're in another window. */
950 xsignal1 (Qerror
, val
);
952 return unbind_to (count
, Qnil
);
955 /* When an auto-save happens, record the "time", and don't do again soon. */
960 last_auto_save
= num_nonmacro_input_events
;
963 /* Make an auto save happen as soon as possible at command level. */
966 force_auto_save_soon ()
968 last_auto_save
= - auto_save_interval
- 1;
970 record_asynch_buffer_change ();
973 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
974 doc
: /* Invoke the editor command loop recursively.
975 To get out of the recursive edit, a command can do `(throw 'exit nil)';
976 that tells this function to return.
977 Alternatively, `(throw 'exit t)' makes this function signal an error.
978 This function is called by the editor initialization to begin editing. */)
981 int count
= SPECPDL_INDEX ();
984 /* If we enter while input is blocked, don't lock up here.
985 This may happen through the debugger during redisplay. */
989 command_loop_level
++;
990 update_mode_lines
= 1;
992 if (command_loop_level
993 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
994 buffer
= Fcurrent_buffer ();
998 /* If we leave recursive_edit_1 below with a `throw' for instance,
999 like it is done in the splash screen display, we have to
1000 make sure that we restore single_kboard as command_loop_1
1001 would have done if it were left normally. */
1002 if (command_loop_level
> 0)
1003 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1004 record_unwind_protect (recursive_edit_unwind
, buffer
);
1006 recursive_edit_1 ();
1007 return unbind_to (count
, Qnil
);
1011 recursive_edit_unwind (buffer
)
1014 if (BUFFERP (buffer
))
1015 Fset_buffer (buffer
);
1017 command_loop_level
--;
1018 update_mode_lines
= 1;
1023 #if 0 /* These two functions are now replaced with
1024 temporarily_switch_to_single_kboard. */
1028 #if 0 /* Theory: if there's anything in Vunread_command_events,
1029 it will right away be read by read_key_sequence,
1030 and then if we do switch KBOARDS, it will go into the side
1031 queue then. So we don't need to do anything special here -- rms. */
1032 if (CONSP (Vunread_command_events
))
1034 current_kboard
->kbd_queue
1035 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1036 current_kboard
->kbd_queue_has_data
= 1;
1038 Vunread_command_events
= Qnil
;
1043 /* Switch to the single-kboard state, making current_kboard
1044 the only KBOARD from which further input is accepted. */
1047 single_kboard_state ()
1053 /* If we're in single_kboard state for kboard KBOARD,
1057 not_single_kboard_state (kboard
)
1060 if (kboard
== current_kboard
)
1064 /* Maintain a stack of kboards, so other parts of Emacs
1065 can switch temporarily to the kboard of a given frame
1066 and then revert to the previous status. */
1071 struct kboard_stack
*next
;
1074 static struct kboard_stack
*kboard_stack
;
1080 struct kboard_stack
*p
1081 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1083 p
->next
= kboard_stack
;
1084 p
->kboard
= current_kboard
;
1094 struct kboard_stack
*p
= kboard_stack
;
1096 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1098 if (t
->kboard
== p
->kboard
)
1100 current_kboard
= p
->kboard
;
1107 /* The terminal we remembered has been deleted. */
1108 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1111 kboard_stack
= p
->next
;
1115 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1116 from which further input is accepted. If F is non-nil, set its
1117 KBOARD as the current keyboard.
1119 This function uses record_unwind_protect to return to the previous
1122 If Emacs is already in single_kboard mode, and F's keyboard is
1123 locked, then this function will throw an errow. */
1126 temporarily_switch_to_single_kboard (f
)
1129 int was_locked
= single_kboard
;
1132 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1133 /* We can not switch keyboards while in single_kboard mode.
1134 In rare cases, Lisp code may call `recursive-edit' (or
1135 `read-minibuffer' or `y-or-n-p') after it switched to a
1136 locked frame. For example, this is likely to happen
1137 when server.el connects to a new terminal while Emacs is in
1138 single_kboard mode. It is best to throw an error instead
1139 of presenting the user with a frozen screen. */
1140 error ("Terminal %d is locked, cannot read from it",
1141 FRAME_TERMINAL (f
)->id
);
1143 /* This call is unnecessary, but helps
1144 `restore_kboard_configuration' discover if somebody changed
1145 `current_kboard' behind our back. */
1146 push_kboard (current_kboard
);
1149 current_kboard
= FRAME_KBOARD (f
);
1151 record_unwind_protect (restore_kboard_configuration
,
1152 (was_locked
? Qt
: Qnil
));
1155 #if 0 /* This function is not needed anymore. */
1157 record_single_kboard_state ()
1160 push_kboard (current_kboard
);
1161 record_unwind_protect (restore_kboard_configuration
,
1162 (single_kboard
? Qt
: Qnil
));
1167 restore_kboard_configuration (was_locked
)
1168 Lisp_Object was_locked
;
1170 if (NILP (was_locked
))
1174 struct kboard
*prev
= current_kboard
;
1177 /* The pop should not change the kboard. */
1178 if (single_kboard
&& current_kboard
!= prev
)
1185 /* Handle errors that are not handled at inner levels
1186 by printing an error message and returning to the editor command loop. */
1192 Lisp_Object old_level
, old_length
;
1193 char macroerror
[50];
1195 #ifdef HAVE_WINDOW_SYSTEM
1196 if (display_hourglass_p
)
1197 cancel_hourglass ();
1200 if (!NILP (executing_kbd_macro
))
1202 if (executing_kbd_macro_iterations
== 1)
1203 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1205 sprintf (macroerror
, "After %d kbd macro iterations: ",
1206 executing_kbd_macro_iterations
);
1211 Vstandard_output
= Qt
;
1212 Vstandard_input
= Qt
;
1213 Vexecuting_kbd_macro
= Qnil
;
1214 executing_kbd_macro
= Qnil
;
1215 current_kboard
->Vprefix_arg
= Qnil
;
1216 current_kboard
->Vlast_prefix_arg
= Qnil
;
1219 /* Avoid unquittable loop if data contains a circular list. */
1220 old_level
= Vprint_level
;
1221 old_length
= Vprint_length
;
1222 XSETFASTINT (Vprint_level
, 10);
1223 XSETFASTINT (Vprint_length
, 10);
1224 cmd_error_internal (data
, macroerror
);
1225 Vprint_level
= old_level
;
1226 Vprint_length
= old_length
;
1230 Vinhibit_quit
= Qnil
;
1231 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1232 if (command_loop_level
== 0 && minibuf_level
== 0)
1233 any_kboard_state ();
1236 return make_number (0);
1239 /* Take actions on handling an error. DATA is the data that describes
1242 CONTEXT is a C-string containing ASCII characters only which
1243 describes the context in which the error happened. If we need to
1244 generalize CONTEXT to allow multibyte characters, make it a Lisp
1248 cmd_error_internal (data
, context
)
1252 struct frame
*sf
= SELECTED_FRAME ();
1254 /* The immediate context is not interesting for Quits,
1255 since they are asyncronous. */
1256 if (EQ (XCAR (data
), Qquit
))
1257 Vsignaling_function
= Qnil
;
1262 /* Use user's specified output function if any. */
1263 if (!NILP (Vcommand_error_function
))
1264 call3 (Vcommand_error_function
, data
,
1265 context
? build_string (context
) : empty_unibyte_string
,
1266 Vsignaling_function
);
1267 /* If the window system or terminal frame hasn't been initialized
1268 yet, or we're not interactive, write the message to stderr and exit. */
1269 else if (!sf
->glyphs_initialized_p
1270 || FRAME_INITIAL_P (sf
)
1273 print_error_message (data
, Qexternal_debugging_output
,
1274 context
, Vsignaling_function
);
1275 Fterpri (Qexternal_debugging_output
);
1276 Fkill_emacs (make_number (-1));
1280 clear_message (1, 0);
1282 message_log_maybe_newline ();
1285 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1288 Vsignaling_function
= Qnil
;
1291 Lisp_Object
command_loop_1 ();
1292 Lisp_Object
command_loop_2 ();
1293 Lisp_Object
top_level_1 ();
1295 /* Entry to editor-command-loop.
1296 This level has the catches for exiting/returning to editor command loop.
1297 It returns nil to exit recursive edit, t to abort it. */
1302 if (command_loop_level
> 0 || minibuf_level
> 0)
1305 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1306 executing_kbd_macro
= Qnil
;
1312 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1313 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1314 /* Reset single_kboard in case top-level set it while
1315 evaluating an -f option, or we are stuck there for some
1317 any_kboard_state ();
1319 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1320 executing_kbd_macro
= Qnil
;
1322 /* End of file in -batch run causes exit here. */
1328 /* Here we catch errors in execution of commands within the
1329 editing loop, and reenter the editing loop.
1330 When there is an error, cmd_error runs and returns a non-nil
1331 value to us. A value of nil means that command_loop_1 itself
1332 returned due to end of file (or end of kbd macro). */
1337 register Lisp_Object val
;
1340 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1341 while (!NILP (val
));
1349 return Feval (Vtop_level
);
1355 /* On entry to the outer level, run the startup file */
1356 if (!NILP (Vtop_level
))
1357 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1358 else if (!NILP (Vpurify_flag
))
1359 message ("Bare impure Emacs (standard Lisp code not loaded)");
1361 message ("Bare Emacs (standard Lisp code not loaded)");
1365 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1366 doc
: /* Exit all recursive editing levels. */)
1369 #ifdef HAVE_WINDOW_SYSTEM
1370 if (display_hourglass_p
)
1371 cancel_hourglass ();
1374 /* Unblock input if we enter with input blocked. This may happen if
1375 redisplay traps e.g. during tool-bar update with input blocked. */
1376 while (INPUT_BLOCKED_P
)
1379 return Fthrow (Qtop_level
, Qnil
);
1382 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1383 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1386 if (command_loop_level
> 0 || minibuf_level
> 0)
1387 Fthrow (Qexit
, Qnil
);
1389 error ("No recursive edit is in progress");
1393 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1394 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1397 if (command_loop_level
> 0 || minibuf_level
> 0)
1400 error ("No recursive edit is in progress");
1404 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1406 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1407 of this function. */
1410 tracking_off (old_value
)
1411 Lisp_Object old_value
;
1413 do_mouse_tracking
= old_value
;
1414 if (NILP (old_value
))
1416 /* Redisplay may have been preempted because there was input
1417 available, and it assumes it will be called again after the
1418 input has been processed. If the only input available was
1419 the sort that we have just disabled, then we need to call
1421 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1423 redisplay_preserve_echo_area (6);
1424 get_input_pending (&input_pending
,
1425 READABLE_EVENTS_DO_TIMERS_NOW
);
1431 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1432 doc
: /* Evaluate BODY with mouse movement events enabled.
1433 Within a `track-mouse' form, mouse motion generates input events that
1434 you can read with `read-event'.
1435 Normally, mouse motion is ignored.
1436 usage: (track-mouse BODY...) */)
1440 int count
= SPECPDL_INDEX ();
1443 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1445 do_mouse_tracking
= Qt
;
1447 val
= Fprogn (args
);
1448 return unbind_to (count
, val
);
1451 /* If mouse has moved on some frame, return one of those frames.
1455 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1456 after resizing the tool-bar window. */
1458 int ignore_mouse_drag_p
;
1463 Lisp_Object tail
, frame
;
1465 if (ignore_mouse_drag_p
)
1467 /* ignore_mouse_drag_p = 0; */
1471 FOR_EACH_FRAME (tail
, frame
)
1473 if (XFRAME (frame
)->mouse_moved
)
1474 return XFRAME (frame
);
1480 #endif /* HAVE_MOUSE || HAVE_GPM */
1482 /* This is the actual command reading loop,
1483 sans error-handling encapsulation. */
1485 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1487 void safe_run_hooks
P_ ((Lisp_Object
));
1488 static void adjust_point_for_property
P_ ((int, int));
1490 /* Cancel hourglass from protect_unwind.
1492 #ifdef HAVE_WINDOW_SYSTEM
1494 cancel_hourglass_unwind (arg
)
1497 cancel_hourglass ();
1508 Lisp_Object keybuf
[30];
1510 int prev_modiff
= 0;
1511 struct buffer
*prev_buffer
= NULL
;
1512 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1513 int was_locked
= single_kboard
;
1515 int already_adjusted
= 0;
1517 current_kboard
->Vprefix_arg
= Qnil
;
1518 current_kboard
->Vlast_prefix_arg
= Qnil
;
1519 Vdeactivate_mark
= Qnil
;
1520 waiting_for_input
= 0;
1524 this_command_key_count
= 0;
1525 this_command_key_count_reset
= 0;
1526 this_single_command_key_start
= 0;
1528 if (NILP (Vmemory_full
))
1530 /* Make sure this hook runs after commands that get errors and
1531 throw to top level. */
1532 /* Note that the value cell will never directly contain nil
1533 if the symbol is a local variable. */
1534 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1535 safe_run_hooks (Qpost_command_hook
);
1537 /* If displaying a message, resize the echo area window to fit
1538 that message's size exactly. */
1539 if (!NILP (echo_area_buffer
[0]))
1540 resize_echo_area_exactly ();
1542 if (!NILP (Vdeferred_action_list
))
1543 safe_run_hooks (Qdeferred_action_function
);
1546 /* Do this after running Vpost_command_hook, for consistency. */
1547 current_kboard
->Vlast_command
= Vthis_command
;
1548 current_kboard
->Vreal_last_command
= real_this_command
;
1549 if (!CONSP (last_command_char
))
1550 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1554 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1557 /* Make sure the current window's buffer is selected. */
1558 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1559 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1561 /* Display any malloc warning that just came out. Use while because
1562 displaying one warning can cause another. */
1564 while (pending_malloc_warning
)
1565 display_malloc_warning ();
1567 Vdeactivate_mark
= Qnil
;
1569 /* If minibuffer on and echo area in use,
1570 wait a short time and redraw minibuffer. */
1573 && !NILP (echo_area_buffer
[0])
1574 && EQ (minibuf_window
, echo_area_window
)
1575 && NUMBERP (Vminibuffer_message_timeout
))
1577 /* Bind inhibit-quit to t so that C-g gets read in
1578 rather than quitting back to the minibuffer. */
1579 int count
= SPECPDL_INDEX ();
1580 specbind (Qinhibit_quit
, Qt
);
1582 sit_for (Vminibuffer_message_timeout
, 0, 2);
1584 /* Clear the echo area. */
1586 safe_run_hooks (Qecho_area_clear_hook
);
1588 unbind_to (count
, Qnil
);
1590 /* If a C-g came in before, treat it as input now. */
1591 if (!NILP (Vquit_flag
))
1594 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1599 /* Select the frame that the last event came from. Usually,
1600 switch-frame events will take care of this, but if some lisp
1601 code swallows a switch-frame event, we'll fix things up here.
1602 Is this a good idea? */
1603 if (FRAMEP (internal_last_event_frame
)
1604 && !EQ (internal_last_event_frame
, selected_frame
))
1605 Fselect_frame (internal_last_event_frame
);
1607 /* If it has changed current-menubar from previous value,
1608 really recompute the menubar from the value. */
1609 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1610 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1611 call0 (Qrecompute_lucid_menubar
);
1613 before_command_key_count
= this_command_key_count
;
1614 before_command_echo_length
= echo_length ();
1616 Vthis_command
= Qnil
;
1617 real_this_command
= Qnil
;
1618 Vthis_original_command
= Qnil
;
1619 Vthis_command_keys_shift_translated
= Qnil
;
1621 /* Read next key sequence; i gets its length. */
1622 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1625 /* A filter may have run while we were reading the input. */
1626 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1628 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1629 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1633 /* Now we have read a key sequence of length I,
1634 or else I is 0 and we found end of file. */
1636 if (i
== 0) /* End of file -- happens only in */
1637 return Qnil
; /* a kbd macro, at the end. */
1638 /* -1 means read_key_sequence got a menu that was rejected.
1639 Just loop around and read another command. */
1643 this_command_key_count
= 0;
1644 this_command_key_count_reset
= 0;
1645 this_single_command_key_start
= 0;
1649 last_command_char
= keybuf
[i
- 1];
1651 /* If the previous command tried to force a specific window-start,
1652 forget about that, in case this command moves point far away
1653 from that position. But also throw away beg_unchanged and
1654 end_unchanged information in that case, so that redisplay will
1655 update the whole window properly. */
1656 if (!NILP (XWINDOW (selected_window
)->force_start
))
1659 XWINDOW (selected_window
)->force_start
= Qnil
;
1660 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1661 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1664 cmd
= read_key_sequence_cmd
;
1665 if (!NILP (Vexecuting_kbd_macro
))
1667 if (!NILP (Vquit_flag
))
1669 Vexecuting_kbd_macro
= Qt
;
1670 QUIT
; /* Make some noise. */
1671 /* Will return since macro now empty. */
1675 /* Do redisplay processing after this command except in special
1676 cases identified below. */
1677 prev_buffer
= current_buffer
;
1678 prev_modiff
= MODIFF
;
1679 last_point_position
= PT
;
1680 last_point_position_window
= selected_window
;
1681 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1683 /* By default, we adjust point to a boundary of a region that
1684 has such a property that should be treated intangible
1685 (e.g. composition, display). But, some commands will set
1686 this variable differently. */
1687 Vdisable_point_adjustment
= Qnil
;
1689 /* Process filters and timers may have messed with deactivate-mark.
1690 reset it before we execute the command. */
1691 Vdeactivate_mark
= Qnil
;
1693 /* Remap command through active keymaps */
1694 Vthis_original_command
= cmd
;
1698 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1702 /* Execute the command. */
1704 Vthis_command
= cmd
;
1705 real_this_command
= cmd
;
1706 /* Note that the value cell will never directly contain nil
1707 if the symbol is a local variable. */
1708 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1709 safe_run_hooks (Qpre_command_hook
);
1711 already_adjusted
= 0;
1713 if (NILP (Vthis_command
))
1715 /* nil means key is undefined. */
1716 Lisp_Object keys
= Fvector (i
, keybuf
);
1717 keys
= Fkey_description (keys
, Qnil
);
1719 message_with_string ("%s is undefined", keys
, 0);
1720 current_kboard
->defining_kbd_macro
= Qnil
;
1721 update_mode_lines
= 1;
1722 current_kboard
->Vprefix_arg
= Qnil
;
1726 if (NILP (current_kboard
->Vprefix_arg
))
1728 /* In case we jump to directly_done. */
1729 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1731 /* Recognize some common commands in common situations and
1732 do them directly. */
1733 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
1734 && NILP (Vthis_command_keys_shift_translated
)
1735 && !CONSP (Vtransient_mark_mode
))
1737 struct Lisp_Char_Table
*dp
1738 = window_display_table (XWINDOW (selected_window
));
1739 lose
= FETCH_CHAR (PT_BYTE
);
1741 if (! NILP (Vpost_command_hook
))
1742 /* Put this before calling adjust_point_for_property
1743 so it will only get called once in any case. */
1745 if (current_buffer
== prev_buffer
1746 && last_point_position
!= PT
1747 && NILP (Vdisable_point_adjustment
)
1748 && NILP (Vglobal_disable_point_adjustment
))
1749 adjust_point_for_property (last_point_position
, 0);
1750 already_adjusted
= 1;
1751 if (PT
== last_point_position
+ 1
1753 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1754 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1755 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1756 && (lose
>= 0x20 && lose
< 0x7f)))
1757 : (lose
>= 0x20 && lose
< 0x7f))
1758 /* To extract the case of continuation on
1759 wide-column characters. */
1760 && ASCII_BYTE_P (lose
)
1761 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1763 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1765 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1767 && !windows_or_buffers_changed
1768 && EQ (current_buffer
->selective_display
, Qnil
)
1769 && !detect_input_pending ()
1770 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1771 && NILP (Vexecuting_kbd_macro
))
1772 direct_output_forward_char (1);
1775 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
1776 && NILP (Vthis_command_keys_shift_translated
)
1777 && !CONSP (Vtransient_mark_mode
))
1779 struct Lisp_Char_Table
*dp
1780 = window_display_table (XWINDOW (selected_window
));
1782 lose
= FETCH_CHAR (PT_BYTE
);
1783 if (! NILP (Vpost_command_hook
))
1785 if (current_buffer
== prev_buffer
1786 && last_point_position
!= PT
1787 && NILP (Vdisable_point_adjustment
)
1788 && NILP (Vglobal_disable_point_adjustment
))
1789 adjust_point_for_property (last_point_position
, 0);
1790 already_adjusted
= 1;
1791 if (PT
== last_point_position
- 1
1793 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1794 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1795 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1796 && (lose
>= 0x20 && lose
< 0x7f)))
1797 : (lose
>= 0x20 && lose
< 0x7f))
1798 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1800 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1802 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1804 && !windows_or_buffers_changed
1805 && EQ (current_buffer
->selective_display
, Qnil
)
1806 && !detect_input_pending ()
1807 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1808 && NILP (Vexecuting_kbd_macro
))
1809 direct_output_forward_char (-1);
1812 else if (EQ (Vthis_command
, Qself_insert_command
)
1813 /* Try this optimization only on char keystrokes. */
1814 && NATNUMP (last_command_char
)
1815 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1818 = translate_char (Vtranslation_table_for_input
,
1819 XFASTINT (last_command_char
));
1821 if (NILP (Vexecuting_kbd_macro
)
1822 && !EQ (minibuf_window
, selected_window
))
1824 if (!nonundocount
|| nonundocount
>= 20)
1832 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1834 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1836 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1838 || MODIFF
<= SAVE_MODIFF
1839 || windows_or_buffers_changed
1840 || !EQ (current_buffer
->selective_display
, Qnil
)
1841 || detect_input_pending ()
1842 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1843 || !NILP (Vexecuting_kbd_macro
));
1845 value
= internal_self_insert (c
, 0);
1850 if (! NILP (Vpost_command_hook
))
1851 /* Put this before calling adjust_point_for_property
1852 so it will only get called once in any case. */
1855 /* VALUE == 1 when AFTER-CHANGE functions are
1856 installed which is the case most of the time
1857 because FONT-LOCK installs one. */
1858 if (!lose
&& !value
)
1859 direct_output_for_insert (c
);
1864 /* Here for a command that isn't executed directly */
1867 #ifdef HAVE_WINDOW_SYSTEM
1868 int scount
= SPECPDL_INDEX ();
1870 if (display_hourglass_p
1871 && NILP (Vexecuting_kbd_macro
))
1873 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1879 if (NILP (current_kboard
->Vprefix_arg
))
1881 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1883 #ifdef HAVE_WINDOW_SYSTEM
1884 /* Do not check display_hourglass_p here, because
1885 Fcommand_execute could change it, but we should cancel
1886 hourglass cursor anyway.
1887 But don't cancel the hourglass within a macro
1888 just because a command in the macro finishes. */
1889 if (NILP (Vexecuting_kbd_macro
))
1890 unbind_to (scount
, Qnil
);
1895 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1897 /* Note that the value cell will never directly contain nil
1898 if the symbol is a local variable. */
1899 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1900 safe_run_hooks (Qpost_command_hook
);
1902 /* If displaying a message, resize the echo area window to fit
1903 that message's size exactly. */
1904 if (!NILP (echo_area_buffer
[0]))
1905 resize_echo_area_exactly ();
1907 if (!NILP (Vdeferred_action_list
))
1908 safe_run_hooks (Qdeferred_action_function
);
1910 /* If there is a prefix argument,
1911 1) We don't want Vlast_command to be ``universal-argument''
1912 (that would be dumb), so don't set Vlast_command,
1913 2) we want to leave echoing on so that the prefix will be
1914 echoed as part of this key sequence, so don't call
1916 3) we want to leave this_command_key_count non-zero, so that
1917 read_char will realize that it is re-reading a character, and
1918 not echo it a second time.
1920 If the command didn't actually create a prefix arg,
1921 but is merely a frame event that is transparent to prefix args,
1922 then the above doesn't apply. */
1923 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1925 current_kboard
->Vlast_command
= Vthis_command
;
1926 current_kboard
->Vreal_last_command
= real_this_command
;
1927 if (!CONSP (last_command_char
))
1928 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1930 this_command_key_count
= 0;
1931 this_command_key_count_reset
= 0;
1932 this_single_command_key_start
= 0;
1935 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1937 /* In Emacs 22, setting transient-mark-mode to `only' was a
1938 way of turning it on for just one command. This usage is
1939 obsolete, but support it anyway. */
1940 if (EQ (Vtransient_mark_mode
, Qidentity
))
1941 Vtransient_mark_mode
= Qnil
;
1942 else if (EQ (Vtransient_mark_mode
, Qonly
))
1943 Vtransient_mark_mode
= Qidentity
;
1945 if (!NILP (Vdeactivate_mark
))
1946 call0 (Qdeactivate_mark
);
1947 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1948 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1953 if (current_buffer
== prev_buffer
1954 && last_point_position
!= PT
1955 && NILP (Vdisable_point_adjustment
)
1956 && NILP (Vglobal_disable_point_adjustment
)
1957 && !already_adjusted
)
1958 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1960 /* Install chars successfully executed in kbd macro. */
1962 if (!NILP (current_kboard
->defining_kbd_macro
)
1963 && NILP (current_kboard
->Vprefix_arg
))
1964 finalize_kbd_macro_chars ();
1965 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1967 any_kboard_state ();
1972 extern Lisp_Object Qcomposition
, Qdisplay
;
1974 /* Adjust point to a boundary of a region that has such a property
1975 that should be treated intangible. For the moment, we check
1976 `composition', `display' and `invisible' properties.
1977 LAST_PT is the last position of point. */
1979 extern Lisp_Object Qafter_string
, Qbefore_string
;
1980 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1983 adjust_point_for_property (last_pt
, modified
)
1988 Lisp_Object val
, overlay
, tmp
;
1989 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1992 /* FIXME: cycling is probably not necessary because these properties
1993 can't be usefully combined anyway. */
1994 while (check_composition
|| check_display
|| check_invisible
)
1996 /* FIXME: check `intangible'. */
1997 if (check_composition
1998 && PT
> BEGV
&& PT
< ZV
1999 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
2000 && COMPOSITION_VALID_P (beg
, end
, val
)
2001 && beg
< PT
/* && end > PT <- It's always the case. */
2002 && (last_pt
<= beg
|| last_pt
>= end
))
2005 SET_PT (PT
< last_pt
? beg
: end
);
2006 check_display
= check_invisible
= 1;
2008 check_composition
= 0;
2010 && PT
> BEGV
&& PT
< ZV
2011 && !NILP (val
= get_char_property_and_overlay
2012 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
2013 && display_prop_intangible_p (val
)
2014 && (!OVERLAYP (overlay
)
2015 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
2016 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
2017 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
2018 && (beg
< PT
/* && end > PT <- It's always the case. */
2019 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
2022 SET_PT (PT
< last_pt
2023 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
2025 check_composition
= check_invisible
= 1;
2028 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
2030 int inv
, ellipsis
= 0;
2033 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2035 && !NILP (val
= get_char_property_and_overlay
2036 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
2037 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2039 ellipsis
= ellipsis
|| inv
> 1
2040 || (OVERLAYP (overlay
)
2041 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2042 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2043 tmp
= Fnext_single_char_property_change
2044 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
2045 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
2048 && !NILP (val
= get_char_property_and_overlay
2049 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
2050 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2052 ellipsis
= ellipsis
|| inv
> 1
2053 || (OVERLAYP (overlay
)
2054 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2055 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2056 tmp
= Fprevious_single_char_property_change
2057 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2058 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2061 /* Move away from the inside area. */
2062 if (beg
< PT
&& end
> PT
)
2064 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2065 /* We haven't moved yet (so we don't need to fear
2066 infinite-looping) and we were outside the range
2067 before (so either end of the range still corresponds
2068 to a move in the right direction): pretend we moved
2069 less than we actually did, so that we still have
2070 more freedom below in choosing which end of the range
2072 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2073 /* We either have moved already or the last point
2074 was already in the range: we don't get to choose
2075 which end of the range we have to go to. */
2076 : (PT
< last_pt
? beg
: end
));
2077 check_composition
= check_display
= 1;
2079 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2080 the point to something other than its argument, due to
2081 point-motion hooks, intangibility, etc. */
2082 xassert (PT
== beg
|| PT
== end
);
2085 /* Pretend the area doesn't exist if the buffer is not
2087 if (!modified
&& !ellipsis
&& beg
< end
)
2089 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2090 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2091 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2092 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2093 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2094 /* We've already moved as far as we can. Trying to go
2095 to the other end would mean moving backwards and thus
2096 could lead to an infinite loop. */
2098 else if (val
= get_pos_property (make_number (PT
),
2100 TEXT_PROP_MEANS_INVISIBLE (val
)
2101 && (val
= get_pos_property
2102 (make_number (PT
== beg
? end
: beg
),
2104 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2105 (check_composition
= check_display
= 1,
2106 SET_PT (PT
== beg
? end
: beg
));
2109 check_invisible
= 0;
2113 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2116 safe_run_hooks_1 (hook
)
2119 if (NILP (Vrun_hooks
))
2121 return call1 (Vrun_hooks
, Vinhibit_quit
);
2124 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2127 safe_run_hooks_error (data
)
2130 Lisp_Object args
[3];
2131 args
[0] = build_string ("Error in %s: %s");
2132 args
[1] = Vinhibit_quit
;
2135 return Fset (Vinhibit_quit
, Qnil
);
2138 /* If we get an error while running the hook, cause the hook variable
2139 to be nil. Also inhibit quits, so that C-g won't cause the hook
2140 to mysteriously evaporate. */
2143 safe_run_hooks (hook
)
2146 int count
= SPECPDL_INDEX ();
2147 specbind (Qinhibit_quit
, hook
);
2149 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2151 unbind_to (count
, Qnil
);
2155 /* Number of seconds between polling for input. This is a Lisp
2156 variable that can be bound. */
2158 EMACS_INT polling_period
;
2160 /* Nonzero means polling for input is temporarily suppressed. */
2162 int poll_suppress_count
;
2164 /* Asynchronous timer for polling. */
2166 struct atimer
*poll_timer
;
2169 #ifdef POLL_FOR_INPUT
2171 /* Poll for input, so what we catch a C-g if it comes in. This
2172 function is called from x_make_frame_visible, see comment
2178 if (interrupt_input_blocked
== 0
2179 && !waiting_for_input
)
2180 read_avail_input (0);
2183 /* Timer callback function for poll_timer. TIMER is equal to
2187 poll_for_input (timer
)
2188 struct atimer
*timer
;
2190 if (poll_suppress_count
== 0)
2192 interrupt_input_pending
= 1;
2194 poll_for_input_1 ();
2198 #endif /* POLL_FOR_INPUT */
2200 /* Begin signals to poll for input, if they are appropriate.
2201 This function is called unconditionally from various places. */
2206 #ifdef POLL_FOR_INPUT
2207 /* XXX This condition was (read_socket_hook && !interrupt_input),
2208 but read_socket_hook is not global anymore. Let's pretend that
2210 if (!interrupt_input
)
2212 /* Turn alarm handling on unconditionally. It might have
2213 been turned off in process.c. */
2214 turn_on_atimers (1);
2216 /* If poll timer doesn't exist, are we need one with
2217 a different interval, start a new one. */
2218 if (poll_timer
== NULL
2219 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2221 EMACS_TIME interval
;
2224 cancel_atimer (poll_timer
);
2226 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2227 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2228 poll_for_input
, NULL
);
2231 /* Let the timer's callback function poll for input
2232 if this becomes zero. */
2233 --poll_suppress_count
;
2238 /* Nonzero if we are using polling to handle input asynchronously. */
2241 input_polling_used ()
2243 #ifdef POLL_FOR_INPUT
2244 /* XXX This condition was (read_socket_hook && !interrupt_input),
2245 but read_socket_hook is not global anymore. Let's pretend that
2247 return !interrupt_input
;
2253 /* Turn off polling. */
2258 #ifdef POLL_FOR_INPUT
2259 /* XXX This condition was (read_socket_hook && !interrupt_input),
2260 but read_socket_hook is not global anymore. Let's pretend that
2262 if (!interrupt_input
)
2263 ++poll_suppress_count
;
2267 /* Set the value of poll_suppress_count to COUNT
2268 and start or stop polling accordingly. */
2271 set_poll_suppress_count (count
)
2274 #ifdef POLL_FOR_INPUT
2275 if (count
== 0 && poll_suppress_count
!= 0)
2277 poll_suppress_count
= 1;
2280 else if (count
!= 0 && poll_suppress_count
== 0)
2284 poll_suppress_count
= count
;
2288 /* Bind polling_period to a value at least N.
2289 But don't decrease it. */
2292 bind_polling_period (n
)
2295 #ifdef POLL_FOR_INPUT
2296 int new = polling_period
;
2301 stop_other_atimers (poll_timer
);
2303 specbind (Qpolling_period
, make_number (new));
2304 /* Start a new alarm with the new period. */
2309 /* Apply the control modifier to CHARACTER. */
2315 /* Save the upper bits here. */
2316 int upper
= c
& ~0177;
2318 if (! ASCII_BYTE_P (c
))
2319 return c
|= ctrl_modifier
;
2323 /* Everything in the columns containing the upper-case letters
2324 denotes a control character. */
2325 if (c
>= 0100 && c
< 0140)
2329 /* Set the shift modifier for a control char
2330 made from a shifted letter. But only for letters! */
2331 if (oc
>= 'A' && oc
<= 'Z')
2332 c
|= shift_modifier
;
2335 /* The lower-case letters denote control characters too. */
2336 else if (c
>= 'a' && c
<= 'z')
2339 /* Include the bits for control and shift
2340 only if the basic ASCII code can't indicate them. */
2344 /* Replace the high bits. */
2345 c
|= (upper
& ~ctrl_modifier
);
2350 /* Display the help-echo property of the character after the mouse pointer.
2351 Either show it in the echo area, or call show-help-function to display
2352 it by other means (maybe in a tooltip).
2354 If HELP is nil, that means clear the previous help echo.
2356 If HELP is a string, display that string. If HELP is a function,
2357 call it with OBJECT and POS as arguments; the function should
2358 return a help string or nil for none. For all other types of HELP,
2359 evaluate it to obtain a string.
2361 WINDOW is the window in which the help was generated, if any.
2362 It is nil if not in a window.
2364 If OBJECT is a buffer, POS is the position in the buffer where the
2365 `help-echo' text property was found.
2367 If OBJECT is an overlay, that overlay has a `help-echo' property,
2368 and POS is the position in the overlay's buffer under the mouse.
2370 If OBJECT is a string (an overlay string or a string displayed with
2371 the `display' property). POS is the position in that string under
2374 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2375 echo overwrites a keystroke echo currently displayed in the echo
2378 Note: this function may only be called with HELP nil or a string
2379 from X code running asynchronously. */
2382 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2383 Lisp_Object help
, window
, object
, pos
;
2384 int ok_to_overwrite_keystroke_echo
;
2386 if (!NILP (help
) && !STRINGP (help
))
2388 if (FUNCTIONP (help
))
2390 Lisp_Object args
[4];
2395 help
= safe_call (4, args
);
2398 help
= safe_eval (help
);
2400 if (!STRINGP (help
))
2404 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2405 if (!noninteractive
&& STRINGP (help
))
2407 /* The mouse-fixup-help-message Lisp function can call
2408 mouse_position_hook, which resets the mouse_moved flags.
2409 This causes trouble if we are trying to read a mouse motion
2410 event (i.e., if we are inside a `track-mouse' form), so we
2411 restore the mouse_moved flag. */
2412 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2413 help
= call1 (Qmouse_fixup_help_message
, help
);
2419 if (STRINGP (help
) || NILP (help
))
2421 if (!NILP (Vshow_help_function
))
2422 call1 (Vshow_help_function
, help
);
2423 help_echo_showing_p
= STRINGP (help
);
2429 /* Input of single characters from keyboard */
2431 Lisp_Object
print_help ();
2432 static Lisp_Object
kbd_buffer_get_event ();
2433 static void record_char ();
2435 static Lisp_Object help_form_saved_window_configs
;
2437 read_char_help_form_unwind (arg
)
2439 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2440 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2441 if (!NILP (window_config
))
2442 Fset_window_configuration (window_config
);
2446 #define STOP_POLLING \
2447 do { if (! polling_stopped_here) stop_polling (); \
2448 polling_stopped_here = 1; } while (0)
2450 #define RESUME_POLLING \
2451 do { if (polling_stopped_here) start_polling (); \
2452 polling_stopped_here = 0; } while (0)
2454 /* read a character from the keyboard; call the redisplay if needed */
2455 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2456 -1 means do not do redisplay, but do do autosaving.
2459 /* The arguments MAPS and NMAPS are for menu prompting.
2460 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2462 PREV_EVENT is the previous input event, or nil if we are reading
2463 the first event of a key sequence (or not reading a key sequence).
2464 If PREV_EVENT is t, that is a "magic" value that says
2465 not to run input methods, but in other respects to act as if
2466 not reading a key sequence.
2468 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2469 if we used a mouse menu to read the input, or zero otherwise. If
2470 USED_MOUSE_MENU is null, we don't dereference it.
2472 Value is -2 when we find input on another keyboard. A second call
2473 to read_char will read it.
2475 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2476 specifying the maximum time to wait until. If no input arrives by
2477 that time, stop waiting and return nil.
2479 Value is t if we showed a menu and the user rejected it. */
2482 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2486 Lisp_Object prev_event
;
2487 int *used_mouse_menu
;
2488 EMACS_TIME
*end_time
;
2490 volatile Lisp_Object c
;
2491 int count
, jmpcount
;
2492 jmp_buf local_getcjmp
;
2494 volatile int key_already_recorded
= 0;
2495 Lisp_Object tem
, save
;
2496 volatile Lisp_Object previous_echo_area_message
;
2497 volatile Lisp_Object also_record
;
2498 volatile int reread
;
2499 struct gcpro gcpro1
, gcpro2
;
2500 int polling_stopped_here
= 0;
2501 struct kboard
*orig_kboard
= current_kboard
;
2505 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2506 before_command_key_count
= this_command_key_count
;
2507 before_command_echo_length
= echo_length ();
2510 previous_echo_area_message
= Qnil
;
2512 GCPRO2 (c
, previous_echo_area_message
);
2517 if (CONSP (Vunread_post_input_method_events
))
2519 c
= XCAR (Vunread_post_input_method_events
);
2520 Vunread_post_input_method_events
2521 = XCDR (Vunread_post_input_method_events
);
2523 /* Undo what read_char_x_menu_prompt did when it unread
2524 additional keys returned by Fx_popup_menu. */
2526 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2534 if (unread_command_char
!= -1)
2536 XSETINT (c
, unread_command_char
);
2537 unread_command_char
= -1;
2543 if (CONSP (Vunread_command_events
))
2545 c
= XCAR (Vunread_command_events
);
2546 Vunread_command_events
= XCDR (Vunread_command_events
);
2550 /* Undo what sit-for did when it unread additional keys
2551 inside universal-argument. */
2554 && EQ (XCAR (c
), Qt
))
2560 /* Undo what read_char_x_menu_prompt did when it unread
2561 additional keys returned by Fx_popup_menu. */
2563 && EQ (XCDR (c
), Qdisabled
)
2564 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2567 /* If the queued event is something that used the mouse,
2568 set used_mouse_menu accordingly. */
2570 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2571 *used_mouse_menu
= 1;
2573 goto reread_for_input_method
;
2576 if (CONSP (Vunread_input_method_events
))
2578 c
= XCAR (Vunread_input_method_events
);
2579 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2581 /* Undo what read_char_x_menu_prompt did when it unread
2582 additional keys returned by Fx_popup_menu. */
2584 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2588 goto reread_for_input_method
;
2591 this_command_key_count_reset
= 0;
2593 if (!NILP (Vexecuting_kbd_macro
))
2595 /* We set this to Qmacro; since that's not a frame, nobody will
2596 try to switch frames on us, and the selected window will
2599 Since this event came from a macro, it would be misleading to
2600 leave internal_last_event_frame set to wherever the last
2601 real event came from. Normally, a switch-frame event selects
2602 internal_last_event_frame after each command is read, but
2603 events read from a macro should never cause a new frame to be
2605 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2607 /* Exit the macro if we are at the end.
2608 Also, some things replace the macro with t
2609 to force an early exit. */
2610 if (EQ (Vexecuting_kbd_macro
, Qt
)
2611 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2617 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2618 if (STRINGP (Vexecuting_kbd_macro
)
2619 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2620 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2622 executing_kbd_macro_index
++;
2627 if (!NILP (unread_switch_frame
))
2629 c
= unread_switch_frame
;
2630 unread_switch_frame
= Qnil
;
2632 /* This event should make it into this_command_keys, and get echoed
2633 again, so we do not set `reread'. */
2637 /* if redisplay was requested */
2638 if (commandflag
>= 0)
2640 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2642 /* If there is pending input, process any events which are not
2643 user-visible, such as X selection_request events. */
2645 || detect_input_pending_run_timers (0))
2646 swallow_events (0); /* may clear input_pending */
2648 /* Redisplay if no pending input. */
2649 while (!input_pending
)
2651 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2652 redisplay_preserve_echo_area (5);
2657 /* Normal case: no input arrived during redisplay. */
2660 /* Input arrived and pre-empted redisplay.
2661 Process any events which are not user-visible. */
2663 /* If that cleared input_pending, try again to redisplay. */
2666 /* Prevent the redisplay we just did
2667 from messing up echoing of the input after the prompt. */
2668 if (commandflag
== 0 && echo_current
)
2669 echo_message_buffer
= echo_area_buffer
[0];
2673 /* Message turns off echoing unless more keystrokes turn it on again.
2675 The code in 20.x for the condition was
2677 1. echo_area_glyphs && *echo_area_glyphs
2678 2. && echo_area_glyphs != current_kboard->echobuf
2679 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2681 (1) means there's a current message displayed
2683 (2) means it's not the message from echoing from the current
2686 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2687 is set to a non-null value. This is done in read_char and it is
2688 set to echo_area_glyphs after a call to echo_char. That means
2689 ok_to_echo_at_next_pause is either null or
2690 current_kboard->echobuf with the appropriate current_kboard at
2693 So, condition (3) means in clear text ok_to_echo_at_next_pause
2694 must be either null, or the current message isn't from echoing at
2695 all, or it's from echoing from a different kboard than the
2698 if (/* There currently is something in the echo area. */
2699 !NILP (echo_area_buffer
[0])
2700 && (/* And it's either not from echoing. */
2701 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2702 /* Or it's an echo from a different kboard. */
2703 || echo_kboard
!= current_kboard
2704 /* Or we explicitly allow overwriting whatever there is. */
2705 || ok_to_echo_at_next_pause
== NULL
))
2710 /* Try reading a character via menu prompting in the minibuf.
2711 Try this before the sit-for, because the sit-for
2712 would do the wrong thing if we are supposed to do
2713 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2714 after a mouse event so don't try a minibuf menu. */
2716 if (nmaps
> 0 && INTERACTIVE
2717 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2718 /* Don't bring up a menu if we already have another event. */
2719 && NILP (Vunread_command_events
)
2720 && unread_command_char
< 0
2721 && !detect_input_pending_run_timers (0))
2723 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2725 if (INTEGERP (c
) && XINT (c
) == -2)
2726 return c
; /* wrong_kboard_jmpbuf */
2730 key_already_recorded
= 1;
2735 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2736 We will do that below, temporarily for short sections of code,
2737 when appropriate. local_getcjmp must be in effect
2738 around any call to sit_for or kbd_buffer_get_event;
2739 it *must not* be in effect when we call redisplay. */
2741 jmpcount
= SPECPDL_INDEX ();
2742 if (_setjmp (local_getcjmp
))
2744 /* Handle quits while reading the keyboard. */
2745 /* We must have saved the outer value of getcjmp here,
2746 so restore it now. */
2747 restore_getcjmp (save_jump
);
2748 unbind_to (jmpcount
, Qnil
);
2749 XSETINT (c
, quit_char
);
2750 internal_last_event_frame
= selected_frame
;
2751 Vlast_event_frame
= internal_last_event_frame
;
2752 /* If we report the quit char as an event,
2753 don't do so more than once. */
2754 if (!NILP (Vinhibit_quit
))
2758 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2759 if (kb
!= current_kboard
)
2761 Lisp_Object link
= kb
->kbd_queue
;
2762 /* We shouldn't get here if we were in single-kboard mode! */
2767 while (CONSP (XCDR (link
)))
2769 if (!NILP (XCDR (link
)))
2773 kb
->kbd_queue
= Fcons (c
, Qnil
);
2775 XSETCDR (link
, Fcons (c
, Qnil
));
2776 kb
->kbd_queue_has_data
= 1;
2777 current_kboard
= kb
;
2778 /* This is going to exit from read_char
2779 so we had better get rid of this frame's stuff. */
2781 return make_number (-2); /* wrong_kboard_jmpbuf */
2787 /* Start idle timers if no time limit is supplied. We don't do it
2788 if a time limit is supplied to avoid an infinite recursion in the
2789 situation where an idle timer calls `sit-for'. */
2792 timer_start_idle ();
2794 /* If in middle of key sequence and minibuffer not active,
2795 start echoing if enough time elapses. */
2797 if (minibuf_level
== 0
2799 && !current_kboard
->immediate_echo
2800 && this_command_key_count
> 0
2802 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2803 && NILP (Fzerop (Vecho_keystrokes
))
2804 && (/* No message. */
2805 NILP (echo_area_buffer
[0])
2806 /* Or empty message. */
2807 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2808 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2809 /* Or already echoing from same kboard. */
2810 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2811 /* Or not echoing before and echoing allowed. */
2812 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2814 /* After a mouse event, start echoing right away.
2815 This is because we are probably about to display a menu,
2816 and we don't want to delay before doing so. */
2817 if (EVENT_HAS_PARAMETERS (prev_event
))
2823 save_getcjmp (save_jump
);
2824 restore_getcjmp (local_getcjmp
);
2825 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2826 restore_getcjmp (save_jump
);
2828 && ! CONSP (Vunread_command_events
))
2833 /* Maybe auto save due to number of keystrokes. */
2835 if (commandflag
!= 0
2836 && auto_save_interval
> 0
2837 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2838 && !detect_input_pending_run_timers (0))
2840 Fdo_auto_save (Qnil
, Qnil
);
2841 /* Hooks can actually change some buffers in auto save. */
2845 /* Try reading using an X menu.
2846 This is never confused with reading using the minibuf
2847 because the recursive call of read_char in read_char_minibuf_menu_prompt
2848 does not pass on any keymaps. */
2850 if (nmaps
> 0 && INTERACTIVE
2851 && !NILP (prev_event
)
2852 && EVENT_HAS_PARAMETERS (prev_event
)
2853 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2854 && !EQ (XCAR (prev_event
), Qtool_bar
)
2855 /* Don't bring up a menu if we already have another event. */
2856 && NILP (Vunread_command_events
)
2857 && unread_command_char
< 0)
2859 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2861 /* Now that we have read an event, Emacs is not idle. */
2868 /* Maybe autosave and/or garbage collect due to idleness. */
2870 if (INTERACTIVE
&& NILP (c
))
2872 int delay_level
, buffer_size
;
2874 /* Slow down auto saves logarithmically in size of current buffer,
2875 and garbage collect while we're at it. */
2876 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2877 last_non_minibuf_size
= Z
- BEG
;
2878 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2880 while (buffer_size
> 64)
2881 delay_level
++, buffer_size
-= buffer_size
>> 2;
2882 if (delay_level
< 4) delay_level
= 4;
2883 /* delay_level is 4 for files under around 50k, 7 at 100k,
2884 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2886 /* Auto save if enough time goes by without input. */
2887 if (commandflag
!= 0
2888 && num_nonmacro_input_events
> last_auto_save
2889 && INTEGERP (Vauto_save_timeout
)
2890 && XINT (Vauto_save_timeout
) > 0)
2893 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2895 save_getcjmp (save_jump
);
2896 restore_getcjmp (local_getcjmp
);
2897 tem0
= sit_for (make_number (timeout
), 1, 1);
2898 restore_getcjmp (save_jump
);
2901 && ! CONSP (Vunread_command_events
))
2903 Fdo_auto_save (Qnil
, Qnil
);
2905 /* If we have auto-saved and there is still no input
2906 available, garbage collect if there has been enough
2907 consing going on to make it worthwhile. */
2908 if (!detect_input_pending_run_timers (0)
2909 && consing_since_gc
> gc_cons_threshold
/ 2)
2910 Fgarbage_collect ();
2917 /* Notify the caller if an autosave hook, or a timer, sentinel or
2918 filter in the sit_for calls above have changed the current
2919 kboard. This could happen if they use the minibuffer or start a
2920 recursive edit, like the fancy splash screen in server.el's
2921 filter. If this longjmp wasn't here, read_key_sequence would
2922 interpret the next key sequence using the wrong translation
2923 tables and function keymaps. */
2924 if (NILP (c
) && current_kboard
!= orig_kboard
)
2927 return make_number (-2); /* wrong_kboard_jmpbuf */
2930 /* If this has become non-nil here, it has been set by a timer
2931 or sentinel or filter. */
2932 if (CONSP (Vunread_command_events
))
2934 c
= XCAR (Vunread_command_events
);
2935 Vunread_command_events
= XCDR (Vunread_command_events
);
2938 /* Read something from current KBOARD's side queue, if possible. */
2942 if (current_kboard
->kbd_queue_has_data
)
2944 if (!CONSP (current_kboard
->kbd_queue
))
2946 c
= XCAR (current_kboard
->kbd_queue
);
2947 current_kboard
->kbd_queue
2948 = XCDR (current_kboard
->kbd_queue
);
2949 if (NILP (current_kboard
->kbd_queue
))
2950 current_kboard
->kbd_queue_has_data
= 0;
2951 input_pending
= readable_events (0);
2952 if (EVENT_HAS_PARAMETERS (c
)
2953 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2954 internal_last_event_frame
= XCAR (XCDR (c
));
2955 Vlast_event_frame
= internal_last_event_frame
;
2959 /* If current_kboard's side queue is empty check the other kboards.
2960 If one of them has data that we have not yet seen here,
2961 switch to it and process the data waiting for it.
2963 Note: if the events queued up for another kboard
2964 have already been seen here, and therefore are not a complete command,
2965 the kbd_queue_has_data field is 0, so we skip that kboard here.
2966 That's to avoid an infinite loop switching between kboards here. */
2967 if (NILP (c
) && !single_kboard
)
2970 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2971 if (kb
->kbd_queue_has_data
)
2973 current_kboard
= kb
;
2974 /* This is going to exit from read_char
2975 so we had better get rid of this frame's stuff. */
2977 return make_number (-2); /* wrong_kboard_jmpbuf */
2985 /* Finally, we read from the main queue,
2986 and if that gives us something we can't use yet, we put it on the
2987 appropriate side queue and try again. */
2996 EMACS_GET_TIME (now
);
2997 if (EMACS_TIME_GE (now
, *end_time
))
3001 /* Actually read a character, waiting if necessary. */
3002 save_getcjmp (save_jump
);
3003 restore_getcjmp (local_getcjmp
);
3005 timer_start_idle ();
3006 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
3007 restore_getcjmp (save_jump
);
3009 if (! NILP (c
) && (kb
!= current_kboard
))
3011 Lisp_Object link
= kb
->kbd_queue
;
3014 while (CONSP (XCDR (link
)))
3016 if (!NILP (XCDR (link
)))
3020 kb
->kbd_queue
= Fcons (c
, Qnil
);
3022 XSETCDR (link
, Fcons (c
, Qnil
));
3023 kb
->kbd_queue_has_data
= 1;
3027 current_kboard
= kb
;
3028 /* This is going to exit from read_char
3029 so we had better get rid of this frame's stuff. */
3031 return make_number (-2);
3035 /* Terminate Emacs in batch mode if at eof. */
3036 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
3037 Fkill_emacs (make_number (1));
3041 /* Add in any extra modifiers, where appropriate. */
3042 if ((extra_keyboard_modifiers
& CHAR_CTL
)
3043 || ((extra_keyboard_modifiers
& 0177) < ' '
3044 && (extra_keyboard_modifiers
& 0177) != 0))
3045 XSETINT (c
, make_ctrl_char (XINT (c
)));
3047 /* Transfer any other modifier bits directly from
3048 extra_keyboard_modifiers to c. Ignore the actual character code
3049 in the low 16 bits of extra_keyboard_modifiers. */
3050 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
3061 if (commandflag
>= 0
3062 && !input_pending
&& !detect_input_pending_run_timers (0))
3070 /* Buffer switch events are only for internal wakeups
3071 so don't show them to the user.
3072 Also, don't record a key if we already did. */
3073 if (BUFFERP (c
) || key_already_recorded
)
3076 /* Process special events within read_char
3077 and loop around to read another event. */
3080 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3085 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3086 int was_locked
= single_kboard
;
3087 int count
= SPECPDL_INDEX ();
3088 record_single_kboard_state ();
3091 last_input_char
= c
;
3092 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
3094 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3095 /* We stopped being idle for this event; undo that. This
3096 prevents automatic window selection (under
3097 mouse_autoselect_window from acting as a real input event, for
3098 example banishing the mouse under mouse-avoidance-mode. */
3099 timer_resume_idle ();
3101 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3102 /* Resume allowing input from any kboard, if that was true before. */
3104 any_kboard_state ();
3105 unbind_to (count
, Qnil
);
3111 /* Handle things that only apply to characters. */
3114 /* If kbd_buffer_get_event gave us an EOF, return that. */
3118 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3119 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3120 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3121 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3122 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3126 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3127 /* nil in keyboard-translate-table means no translation. */
3133 /* If this event is a mouse click in the menu bar,
3134 return just menu-bar for now. Modify the mouse click event
3135 so we won't do this twice, then queue it up. */
3136 if (EVENT_HAS_PARAMETERS (c
)
3138 && CONSP (EVENT_START (c
))
3139 && CONSP (XCDR (EVENT_START (c
))))
3143 posn
= POSN_POSN (EVENT_START (c
));
3144 /* Handle menu-bar events:
3145 insert the dummy prefix event `menu-bar'. */
3146 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3148 /* Change menu-bar to (menu-bar) as the event "position". */
3149 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3152 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3157 /* Store these characters into recent_keys, the dribble file if any,
3158 and the keyboard macro being defined, if any. */
3160 if (! NILP (also_record
))
3161 record_char (also_record
);
3163 /* Wipe the echo area.
3164 But first, if we are about to use an input method,
3165 save the echo area contents for it to refer to. */
3167 && ! NILP (Vinput_method_function
)
3168 && (unsigned) XINT (c
) >= ' '
3169 && (unsigned) XINT (c
) != 127
3170 && (unsigned) XINT (c
) < 256)
3172 previous_echo_area_message
= Fcurrent_message ();
3173 Vinput_method_previous_message
= previous_echo_area_message
;
3176 /* Now wipe the echo area, except for help events which do their
3177 own stuff with the echo area. */
3179 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3180 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3182 if (!NILP (echo_area_buffer
[0]))
3183 safe_run_hooks (Qecho_area_clear_hook
);
3184 clear_message (1, 0);
3187 reread_for_input_method
:
3189 /* Pass this to the input method, if appropriate. */
3191 && ! NILP (Vinput_method_function
)
3192 /* Don't run the input method within a key sequence,
3193 after the first event of the key sequence. */
3194 && NILP (prev_event
)
3195 && (unsigned) XINT (c
) >= ' '
3196 && (unsigned) XINT (c
) != 127
3197 && (unsigned) XINT (c
) < 256)
3200 int key_count
, key_count_reset
;
3201 struct gcpro gcpro1
;
3202 int count
= SPECPDL_INDEX ();
3204 /* Save the echo status. */
3205 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3206 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3207 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3208 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3211 if (before_command_restore_flag
)
3213 this_command_key_count
= before_command_key_count_1
;
3214 if (this_command_key_count
< this_single_command_key_start
)
3215 this_single_command_key_start
= this_command_key_count
;
3216 echo_truncate (before_command_echo_length_1
);
3217 before_command_restore_flag
= 0;
3221 /* Save the this_command_keys status. */
3222 key_count
= this_command_key_count
;
3223 key_count_reset
= this_command_key_count_reset
;
3226 keys
= Fcopy_sequence (this_command_keys
);
3231 /* Clear out this_command_keys. */
3232 this_command_key_count
= 0;
3233 this_command_key_count_reset
= 0;
3235 /* Now wipe the echo area. */
3236 if (!NILP (echo_area_buffer
[0]))
3237 safe_run_hooks (Qecho_area_clear_hook
);
3238 clear_message (1, 0);
3241 /* If we are not reading a key sequence,
3242 never use the echo area. */
3245 specbind (Qinput_method_use_echo_area
, Qt
);
3248 /* Call the input method. */
3249 tem
= call1 (Vinput_method_function
, c
);
3251 tem
= unbind_to (count
, tem
);
3253 /* Restore the saved echoing state
3254 and this_command_keys state. */
3255 this_command_key_count
= key_count
;
3256 this_command_key_count_reset
= key_count_reset
;
3258 this_command_keys
= keys
;
3261 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3262 current_kboard
->echo_string
= saved_echo_string
;
3263 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3264 if (saved_immediate_echo
)
3269 /* The input method can return no events. */
3272 /* Bring back the previous message, if any. */
3273 if (! NILP (previous_echo_area_message
))
3274 message_with_string ("%s", previous_echo_area_message
, 0);
3277 /* It returned one event or more. */
3279 Vunread_post_input_method_events
3280 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3285 /* Display help if not echoing. */
3286 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3288 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3289 Lisp_Object help
, object
, position
, window
, tem
;
3291 tem
= Fcdr (XCDR (c
));
3294 window
= Fcar (tem
);
3296 object
= Fcar (tem
);
3298 position
= Fcar (tem
);
3300 show_help_echo (help
, window
, object
, position
, 0);
3302 /* We stopped being idle for this event; undo that. */
3304 timer_resume_idle ();
3308 if ((! reread
|| this_command_key_count
== 0
3309 || this_command_key_count_reset
)
3313 /* Don't echo mouse motion events. */
3314 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3315 && NILP (Fzerop (Vecho_keystrokes
))
3316 && ! (EVENT_HAS_PARAMETERS (c
)
3317 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3320 if (! NILP (also_record
))
3321 echo_char (also_record
);
3322 /* Once we reread a character, echoing can happen
3323 the next time we pause to read a new one. */
3324 ok_to_echo_at_next_pause
= current_kboard
;
3327 /* Record this character as part of the current key. */
3328 add_command_key (c
);
3329 if (! NILP (also_record
))
3330 add_command_key (also_record
);
3333 last_input_char
= c
;
3336 /* Process the help character specially if enabled */
3337 if (!NILP (Vhelp_form
) && help_char_p (c
))
3340 count
= SPECPDL_INDEX ();
3342 help_form_saved_window_configs
3343 = Fcons (Fcurrent_window_configuration (Qnil
),
3344 help_form_saved_window_configs
);
3345 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3347 tem0
= Feval (Vhelp_form
);
3349 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3354 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3355 if (EVENT_HAS_PARAMETERS (c
)
3356 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3357 XSETCAR (help_form_saved_window_configs
, Qnil
);
3359 while (BUFFERP (c
));
3360 /* Remove the help from the frame */
3361 unbind_to (count
, Qnil
);
3364 if (EQ (c
, make_number (040)))
3368 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3369 while (BUFFERP (c
));
3378 /* Record a key that came from a mouse menu.
3379 Record it for echoing, for this-command-keys, and so on. */
3385 /* Wipe the echo area. */
3386 clear_message (1, 0);
3391 before_command_key_count
= this_command_key_count
;
3392 before_command_echo_length
= echo_length ();
3395 /* Don't echo mouse motion events. */
3396 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3397 && NILP (Fzerop (Vecho_keystrokes
)))
3401 /* Once we reread a character, echoing can happen
3402 the next time we pause to read a new one. */
3403 ok_to_echo_at_next_pause
= 0;
3406 /* Record this character as part of the current key. */
3407 add_command_key (c
);
3409 /* Re-reading in the middle of a command */
3410 last_input_char
= c
;
3414 /* Return 1 if should recognize C as "the help character". */
3422 if (EQ (c
, Vhelp_char
))
3424 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3425 if (EQ (c
, XCAR (tail
)))
3430 /* Record the input event C in various ways. */
3438 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3440 /* To avoid filling recent_keys with help-echo and mouse-movement
3441 events, we filter out repeated help-echo events, only store the
3442 first and last in a series of mouse-movement events, and don't
3443 store repeated help-echo events which are only separated by
3444 mouse-movement events. */
3446 Lisp_Object ev1
, ev2
, ev3
;
3449 if ((ix1
= recent_keys_index
- 1) < 0)
3450 ix1
= NUM_RECENT_KEYS
- 1;
3451 ev1
= AREF (recent_keys
, ix1
);
3453 if ((ix2
= ix1
- 1) < 0)
3454 ix2
= NUM_RECENT_KEYS
- 1;
3455 ev2
= AREF (recent_keys
, ix2
);
3457 if ((ix3
= ix2
- 1) < 0)
3458 ix3
= NUM_RECENT_KEYS
- 1;
3459 ev3
= AREF (recent_keys
, ix3
);
3461 if (EQ (XCAR (c
), Qhelp_echo
))
3463 /* Don't record `help-echo' in recent_keys unless it shows some help
3464 message, and a different help than the previously recorded
3466 Lisp_Object help
, last_help
;
3468 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3469 if (!STRINGP (help
))
3471 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3472 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3474 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3475 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3476 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3478 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3479 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3480 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3481 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3484 else if (EQ (XCAR (c
), Qmouse_movement
))
3486 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3487 So additional mouse movement events replace the last element. */
3488 Lisp_Object last_window
, window
;
3490 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3491 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3492 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3493 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3494 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3496 ASET (recent_keys
, ix1
, c
);
3502 store_kbd_macro_char (c
);
3507 ASET (recent_keys
, recent_keys_index
, c
);
3508 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3509 recent_keys_index
= 0;
3511 else if (recorded
< 0)
3513 /* We need to remove one or two events from recent_keys.
3514 To do this, we simply put nil at those events and move the
3515 recent_keys_index backwards over those events. Usually,
3516 users will never see those nil events, as they will be
3517 overwritten by the command keys entered to see recent_keys
3520 while (recorded
++ < 0 && total_keys
> 0)
3522 if (total_keys
< NUM_RECENT_KEYS
)
3524 if (--recent_keys_index
< 0)
3525 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3526 ASET (recent_keys
, recent_keys_index
, Qnil
);
3530 num_nonmacro_input_events
++;
3532 /* Write c to the dribble file. If c is a lispy event, write
3533 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3534 If you, dear reader, have a better idea, you've got the source. :-) */
3540 if (XUINT (c
) < 0x100)
3541 putc (XINT (c
), dribble
);
3543 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3547 Lisp_Object dribblee
;
3549 /* If it's a structured event, take the event header. */
3550 dribblee
= EVENT_HEAD (c
);
3552 if (SYMBOLP (dribblee
))
3554 putc ('<', dribble
);
3555 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3556 SBYTES (SYMBOL_NAME (dribblee
)),
3558 putc ('>', dribble
);
3571 struct buffer
*old
= current_buffer
;
3572 Fprinc (object
, Qnil
);
3573 set_buffer_internal (XBUFFER (Vstandard_output
));
3574 call0 (intern ("help-mode"));
3575 set_buffer_internal (old
);
3579 /* Copy out or in the info on where C-g should throw to.
3580 This is used when running Lisp code from within get_char,
3581 in case get_char is called recursively.
3582 See read_process_output. */
3588 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3592 restore_getcjmp (temp
)
3595 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3598 /* Low level keyboard/mouse input.
3599 kbd_buffer_store_event places events in kbd_buffer, and
3600 kbd_buffer_get_event retrieves them. */
3602 /* Return true if there are any events in the queue that read-char
3603 would return. If this returns false, a read-char would block. */
3605 readable_events (flags
)
3608 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3611 /* If the buffer contains only FOCUS_IN_EVENT events, and
3612 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3613 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3615 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3616 #ifdef USE_TOOLKIT_SCROLL_BARS
3617 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3621 struct input_event
*event
;
3623 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3630 #ifdef USE_TOOLKIT_SCROLL_BARS
3631 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3633 event
->kind
== FOCUS_IN_EVENT
)
3634 #ifdef USE_TOOLKIT_SCROLL_BARS
3635 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3636 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3637 && event
->part
== scroll_bar_handle
3638 && event
->modifiers
== 0)
3643 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3646 while (event
!= kbd_store_ptr
);
3652 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3653 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3654 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3659 if (current_kboard
->kbd_queue_has_data
)
3665 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3666 if (kb
->kbd_queue_has_data
)
3672 /* Set this for debugging, to have a way to get out */
3676 event_to_kboard (event
)
3677 struct input_event
*event
;
3680 frame
= event
->frame_or_window
;
3682 frame
= XCAR (frame
);
3683 else if (WINDOWP (frame
))
3684 frame
= WINDOW_FRAME (XWINDOW (frame
));
3686 /* There are still some events that don't set this field.
3687 For now, just ignore the problem.
3688 Also ignore dead frames here. */
3689 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3692 return FRAME_KBOARD (XFRAME (frame
));
3696 Lisp_Object Vthrow_on_input
;
3698 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3701 kbd_buffer_store_event (event
)
3702 register struct input_event
*event
;
3704 kbd_buffer_store_event_hold (event
, 0);
3707 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3709 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3710 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3711 Else, if EVENT is a quit event, store the quit event
3712 in HOLD_QUIT, and return (thus ignoring further events).
3714 This is used in read_avail_input to postpone the processing
3715 of the quit event until all subsequent input events have been
3716 parsed (and discarded).
3720 kbd_buffer_store_event_hold (event
, hold_quit
)
3721 register struct input_event
*event
;
3722 struct input_event
*hold_quit
;
3724 if (event
->kind
== NO_EVENT
)
3727 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3730 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3732 register int c
= event
->code
& 0377;
3734 if (event
->modifiers
& ctrl_modifier
)
3735 c
= make_ctrl_char (c
);
3737 c
|= (event
->modifiers
3738 & (meta_modifier
| alt_modifier
3739 | hyper_modifier
| super_modifier
));
3743 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3744 struct input_event
*sp
;
3746 if (single_kboard
&& kb
!= current_kboard
)
3749 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3750 Fcons (make_number (c
), Qnil
));
3751 kb
->kbd_queue_has_data
= 1;
3752 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3754 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3757 if (event_to_kboard (sp
) == kb
)
3759 sp
->kind
= NO_EVENT
;
3760 sp
->frame_or_window
= Qnil
;
3769 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3773 /* If this results in a quit_char being returned to Emacs as
3774 input, set Vlast_event_frame properly. If this doesn't
3775 get returned to Emacs as an event, the next event read
3776 will set Vlast_event_frame again, so this is safe to do. */
3780 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3782 focus
= event
->frame_or_window
;
3783 internal_last_event_frame
= focus
;
3784 Vlast_event_frame
= focus
;
3787 last_event_timestamp
= event
->timestamp
;
3788 handle_interrupt ();
3792 if (c
&& c
== stop_character
)
3798 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3799 Just ignore the second one. */
3800 else if (event
->kind
== BUFFER_SWITCH_EVENT
3801 && kbd_fetch_ptr
!= kbd_store_ptr
3802 && ((kbd_store_ptr
== kbd_buffer
3803 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3804 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3807 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3808 kbd_store_ptr
= kbd_buffer
;
3810 /* Don't let the very last slot in the buffer become full,
3811 since that would make the two pointers equal,
3812 and that is indistinguishable from an empty buffer.
3813 Discard the event if it would fill the last slot. */
3814 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3816 *kbd_store_ptr
= *event
;
3820 /* If we're inside while-no-input, and this event qualifies
3821 as input, set quit-flag to cause an interrupt. */
3822 if (!NILP (Vthrow_on_input
)
3823 && event
->kind
!= FOCUS_IN_EVENT
3824 && event
->kind
!= HELP_EVENT
3825 && event
->kind
!= DEICONIFY_EVENT
)
3827 Vquit_flag
= Vthrow_on_input
;
3828 /* If we're inside a function that wants immediate quits,
3830 if (immediate_quit
&& NILP (Vinhibit_quit
))
3840 /* Put an input event back in the head of the event queue. */
3843 kbd_buffer_unget_event (event
)
3844 register struct input_event
*event
;
3846 if (kbd_fetch_ptr
== kbd_buffer
)
3847 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3849 /* Don't let the very last slot in the buffer become full, */
3850 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3853 *kbd_fetch_ptr
= *event
;
3858 /* Generate HELP_EVENT input_events in BUFP which has room for
3859 SIZE events. If there's not enough room in BUFP, ignore this
3862 HELP is the help form.
3864 FRAME is the frame on which the help is generated. OBJECT is the
3865 Lisp object where the help was found (a buffer, a string, an
3866 overlay, or nil if neither from a string nor from a buffer. POS is
3867 the position within OBJECT where the help was found.
3869 Value is the number of input_events generated. */
3872 gen_help_event (help
, frame
, window
, object
, pos
)
3873 Lisp_Object help
, frame
, object
, window
;
3876 struct input_event event
;
3880 event
.kind
= HELP_EVENT
;
3881 event
.frame_or_window
= frame
;
3883 event
.x
= WINDOWP (window
) ? window
: frame
;
3886 kbd_buffer_store_event (&event
);
3890 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3893 kbd_buffer_store_help_event (frame
, help
)
3894 Lisp_Object frame
, help
;
3896 struct input_event event
;
3898 event
.kind
= HELP_EVENT
;
3899 event
.frame_or_window
= frame
;
3904 kbd_buffer_store_event (&event
);
3908 /* Discard any mouse events in the event buffer by setting them to
3911 discard_mouse_events ()
3913 struct input_event
*sp
;
3914 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3916 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3919 if (sp
->kind
== MOUSE_CLICK_EVENT
3920 || sp
->kind
== WHEEL_EVENT
3921 || sp
->kind
== HORIZ_WHEEL_EVENT
3923 || sp
->kind
== GPM_CLICK_EVENT
3925 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3927 sp
->kind
= NO_EVENT
;
3933 /* Return non-zero if there are any real events waiting in the event
3934 buffer, not counting `NO_EVENT's.
3936 If DISCARD is non-zero, discard NO_EVENT events at the front of
3937 the input queue, possibly leaving the input queue empty if there
3938 are no real input events. */
3941 kbd_buffer_events_waiting (discard
)
3944 struct input_event
*sp
;
3946 for (sp
= kbd_fetch_ptr
;
3947 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3950 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3957 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3961 /* Clear input event EVENT. */
3965 struct input_event
*event
;
3967 event
->kind
= NO_EVENT
;
3971 /* Read one event from the event buffer, waiting if necessary.
3972 The value is a Lisp object representing the event.
3973 The value is nil for an event that should be ignored,
3974 or that was handled here.
3975 We always read and discard one event. */
3978 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
3980 int *used_mouse_menu
;
3981 EMACS_TIME
*end_time
;
3990 *kbp
= current_kboard
;
3994 /* Wait until there is input available. */
3997 /* Break loop if there's an unread command event. Needed in
3998 moused window autoselection which uses a timer to insert such
4000 if (CONSP (Vunread_command_events
))
4003 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4005 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4006 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4010 /* If the quit flag is set, then read_char will return
4011 quit_char, so that counts as "available input." */
4012 if (!NILP (Vquit_flag
))
4013 quit_throw_to_read_char ();
4015 /* One way or another, wait until input is available; then, if
4016 interrupt handlers have not read it, read it now. */
4019 wait_for_kbd_input ();
4021 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4025 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4027 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4028 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4033 EMACS_TIME duration
;
4034 EMACS_GET_TIME (duration
);
4035 if (EMACS_TIME_GE (duration
, *end_time
))
4036 return Qnil
; /* finished waiting */
4039 EMACS_SUB_TIME (duration
, *end_time
, duration
);
4040 wait_reading_process_output (EMACS_SECS (duration
),
4041 EMACS_USECS (duration
),
4042 -1, 1, Qnil
, NULL
, 0);
4046 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
4048 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
4049 /* Pass 1 for EXPECT since we just waited to have input. */
4050 read_avail_input (1);
4051 #endif /* not VMS */
4054 if (CONSP (Vunread_command_events
))
4057 first
= XCAR (Vunread_command_events
);
4058 Vunread_command_events
= XCDR (Vunread_command_events
);
4059 *kbp
= current_kboard
;
4063 /* At this point, we know that there is a readable event available
4064 somewhere. If the event queue is empty, then there must be a
4065 mouse movement enabled and available. */
4066 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4068 struct input_event
*event
;
4070 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4074 last_event_timestamp
= event
->timestamp
;
4076 *kbp
= event_to_kboard (event
);
4078 *kbp
= current_kboard
; /* Better than returning null ptr? */
4082 /* These two kinds of events get special handling
4083 and don't actually appear to the command loop.
4084 We return nil for them. */
4085 if (event
->kind
== SELECTION_REQUEST_EVENT
4086 || event
->kind
== SELECTION_CLEAR_EVENT
)
4089 struct input_event copy
;
4091 /* Remove it from the buffer before processing it,
4092 since otherwise swallow_events will see it
4093 and process it again. */
4095 kbd_fetch_ptr
= event
+ 1;
4096 input_pending
= readable_events (0);
4097 x_handle_selection_event (©
);
4099 /* We're getting selection request events, but we don't have
4105 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4106 || defined (HAVE_NS)
4107 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4109 /* Make an event (delete-frame (FRAME)). */
4110 obj
= Fcons (event
->frame_or_window
, Qnil
);
4111 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4112 kbd_fetch_ptr
= event
+ 1;
4115 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4116 || defined (HAVE_NS)
4117 else if (event
->kind
== ICONIFY_EVENT
)
4119 /* Make an event (iconify-frame (FRAME)). */
4120 obj
= Fcons (event
->frame_or_window
, Qnil
);
4121 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4122 kbd_fetch_ptr
= event
+ 1;
4124 else if (event
->kind
== DEICONIFY_EVENT
)
4126 /* Make an event (make-frame-visible (FRAME)). */
4127 obj
= Fcons (event
->frame_or_window
, Qnil
);
4128 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4129 kbd_fetch_ptr
= event
+ 1;
4132 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4134 /* The value doesn't matter here; only the type is tested. */
4135 XSETBUFFER (obj
, current_buffer
);
4136 kbd_fetch_ptr
= event
+ 1;
4138 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4139 || defined(HAVE_NS) || defined (USE_GTK)
4140 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4142 kbd_fetch_ptr
= event
+ 1;
4143 input_pending
= readable_events (0);
4144 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4145 x_activate_menubar (XFRAME (event
->frame_or_window
));
4148 #if defined (WINDOWSNT)
4149 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4151 /* Make an event (language-change (FRAME CHARSET LCID)). */
4152 obj
= Fcons (event
->frame_or_window
, Qnil
);
4153 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4154 kbd_fetch_ptr
= event
+ 1;
4157 else if (event
->kind
== SAVE_SESSION_EVENT
)
4159 obj
= Fcons (Qsave_session
, Qnil
);
4160 kbd_fetch_ptr
= event
+ 1;
4162 /* Just discard these, by returning nil.
4163 With MULTI_KBOARD, these events are used as placeholders
4164 when we need to randomly delete events from the queue.
4165 (They shouldn't otherwise be found in the buffer,
4166 but on some machines it appears they do show up
4167 even without MULTI_KBOARD.) */
4168 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4169 mouse events during a popup-menu call. */
4170 else if (event
->kind
== NO_EVENT
)
4171 kbd_fetch_ptr
= event
+ 1;
4172 else if (event
->kind
== HELP_EVENT
)
4174 Lisp_Object object
, position
, help
, frame
, window
;
4176 frame
= event
->frame_or_window
;
4177 object
= event
->arg
;
4178 position
= make_number (event
->code
);
4181 clear_event (event
);
4183 kbd_fetch_ptr
= event
+ 1;
4184 if (!WINDOWP (window
))
4186 obj
= Fcons (Qhelp_echo
,
4187 list5 (frame
, help
, window
, object
, position
));
4189 else if (event
->kind
== FOCUS_IN_EVENT
)
4191 /* Notification of a FocusIn event. The frame receiving the
4192 focus is in event->frame_or_window. Generate a
4193 switch-frame event if necessary. */
4194 Lisp_Object frame
, focus
;
4196 frame
= event
->frame_or_window
;
4197 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4201 if (!EQ (frame
, internal_last_event_frame
)
4202 && !EQ (frame
, selected_frame
))
4203 obj
= make_lispy_switch_frame (frame
);
4204 internal_last_event_frame
= frame
;
4205 kbd_fetch_ptr
= event
+ 1;
4208 else if (event
->kind
== DBUS_EVENT
)
4210 obj
= make_lispy_event (event
);
4211 kbd_fetch_ptr
= event
+ 1;
4216 /* If this event is on a different frame, return a switch-frame this
4217 time, and leave the event in the queue for next time. */
4221 frame
= event
->frame_or_window
;
4223 frame
= XCAR (frame
);
4224 else if (WINDOWP (frame
))
4225 frame
= WINDOW_FRAME (XWINDOW (frame
));
4227 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4231 if (! EQ (frame
, internal_last_event_frame
)
4232 && !EQ (frame
, selected_frame
))
4233 obj
= make_lispy_switch_frame (frame
);
4234 internal_last_event_frame
= frame
;
4236 /* If we didn't decide to make a switch-frame event, go ahead
4237 and build a real event from the queue entry. */
4241 obj
= make_lispy_event (event
);
4243 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4244 || defined(HAVE_NS) || defined (USE_GTK)
4245 /* If this was a menu selection, then set the flag to inhibit
4246 writing to last_nonmenu_event. Don't do this if the event
4247 we're returning is (menu-bar), though; that indicates the
4248 beginning of the menu sequence, and we might as well leave
4249 that as the `event with parameters' for this selection. */
4251 && !EQ (event
->frame_or_window
, event
->arg
)
4252 && (event
->kind
== MENU_BAR_EVENT
4253 || event
->kind
== TOOL_BAR_EVENT
))
4254 *used_mouse_menu
= 1;
4257 /* Wipe out this event, to catch bugs. */
4258 clear_event (event
);
4259 kbd_fetch_ptr
= event
+ 1;
4263 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4264 /* Try generating a mouse motion event. */
4265 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4267 FRAME_PTR f
= some_mouse_moved ();
4268 Lisp_Object bar_window
;
4269 enum scroll_bar_part part
;
4273 *kbp
= current_kboard
;
4274 /* Note that this uses F to determine which terminal to look at.
4275 If there is no valid info, it does not store anything
4276 so x remains nil. */
4279 /* XXX Can f or mouse_position_hook be NULL here? */
4280 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4281 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4282 &part
, &x
, &y
, &time
);
4286 /* Decide if we should generate a switch-frame event. Don't
4287 generate switch-frame events for motion outside of all Emacs
4293 frame
= FRAME_FOCUS_FRAME (f
);
4295 XSETFRAME (frame
, f
);
4297 if (! EQ (frame
, internal_last_event_frame
)
4298 && !EQ (frame
, selected_frame
))
4299 obj
= make_lispy_switch_frame (frame
);
4300 internal_last_event_frame
= frame
;
4303 /* If we didn't decide to make a switch-frame event, go ahead and
4304 return a mouse-motion event. */
4305 if (!NILP (x
) && NILP (obj
))
4306 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4308 #endif /* HAVE_MOUSE || HAVE GPM */
4310 /* We were promised by the above while loop that there was
4311 something for us to read! */
4314 input_pending
= readable_events (0);
4316 Vlast_event_frame
= internal_last_event_frame
;
4321 /* Process any events that are not user-visible,
4322 then return, without reading any user-visible events. */
4325 swallow_events (do_display
)
4330 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4332 struct input_event
*event
;
4334 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4338 last_event_timestamp
= event
->timestamp
;
4340 /* These two kinds of events get special handling
4341 and don't actually appear to the command loop. */
4342 if (event
->kind
== SELECTION_REQUEST_EVENT
4343 || event
->kind
== SELECTION_CLEAR_EVENT
)
4346 struct input_event copy
;
4348 /* Remove it from the buffer before processing it,
4349 since otherwise swallow_events called recursively could see it
4350 and process it again. */
4352 kbd_fetch_ptr
= event
+ 1;
4353 input_pending
= readable_events (0);
4354 x_handle_selection_event (©
);
4356 /* We're getting selection request events, but we don't have
4365 old_timers_run
= timers_run
;
4366 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4368 if (timers_run
!= old_timers_run
&& do_display
)
4369 redisplay_preserve_echo_area (7);
4372 /* Record the start of when Emacs is idle,
4373 for the sake of running idle-time timers. */
4380 /* If we are already in the idle state, do nothing. */
4381 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4384 EMACS_GET_TIME (timer_idleness_start_time
);
4386 timer_last_idleness_start_time
= timer_idleness_start_time
;
4388 /* Mark all idle-time timers as once again candidates for running. */
4389 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4393 timer
= XCAR (timers
);
4395 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4397 XVECTOR (timer
)->contents
[0] = Qnil
;
4401 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4406 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4409 /* Resume idle timer from last idle start time. */
4412 timer_resume_idle ()
4414 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4417 timer_idleness_start_time
= timer_last_idleness_start_time
;
4420 /* This is only for debugging. */
4421 struct input_event last_timer_event
;
4423 /* List of elisp functions to call, delayed because they were generated in
4424 a context where Elisp could not be safely run (e.g. redisplay, signal,
4425 ...). Each lement has the form (FUN . ARGS). */
4426 Lisp_Object pending_funcalls
;
4428 extern Lisp_Object Qapply
;
4430 /* Check whether a timer has fired. To prevent larger problems we simply
4431 disregard elements that are not proper timers. Do not make a circular
4432 timer list for the time being.
4434 Returns the number of seconds to wait until the next timer fires. If a
4435 timer is triggering now, return zero seconds.
4436 If no timer is active, return -1 seconds.
4438 If a timer is ripe, we run it, with quitting turned off.
4440 DO_IT_NOW is now ignored. It used to mean that we should
4441 run the timer directly instead of queueing a timer-event.
4442 Now we always run timers directly. */
4445 timer_check (do_it_now
)
4448 EMACS_TIME nexttime
;
4449 EMACS_TIME now
, idleness_now
;
4450 Lisp_Object timers
, idle_timers
, chosen_timer
;
4451 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4453 EMACS_SET_SECS (nexttime
, -1);
4454 EMACS_SET_USECS (nexttime
, -1);
4456 /* Always consider the ordinary timers. */
4457 timers
= Vtimer_list
;
4458 /* Consider the idle timers only if Emacs is idle. */
4459 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4460 idle_timers
= Vtimer_idle_list
;
4463 chosen_timer
= Qnil
;
4464 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4466 /* First run the code that was delayed. */
4467 while (CONSP (pending_funcalls
))
4469 Lisp_Object funcall
= XCAR (pending_funcalls
);
4470 pending_funcalls
= XCDR (pending_funcalls
);
4471 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4474 if (CONSP (timers
) || CONSP (idle_timers
))
4476 EMACS_GET_TIME (now
);
4477 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4478 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4481 while (CONSP (timers
) || CONSP (idle_timers
))
4483 Lisp_Object
*vector
;
4484 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4485 EMACS_TIME timer_time
, idle_timer_time
;
4486 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4488 /* Skip past invalid timers and timers already handled. */
4491 timer
= XCAR (timers
);
4492 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4494 timers
= XCDR (timers
);
4497 vector
= XVECTOR (timer
)->contents
;
4499 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4500 || !INTEGERP (vector
[3])
4501 || ! NILP (vector
[0]))
4503 timers
= XCDR (timers
);
4507 if (!NILP (idle_timers
))
4509 timer
= XCAR (idle_timers
);
4510 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4512 idle_timers
= XCDR (idle_timers
);
4515 vector
= XVECTOR (timer
)->contents
;
4517 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4518 || !INTEGERP (vector
[3])
4519 || ! NILP (vector
[0]))
4521 idle_timers
= XCDR (idle_timers
);
4526 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4527 based on the next ordinary timer.
4528 TIMER_DIFFERENCE is the distance in time from NOW to when
4529 this timer becomes ripe (negative if it's already ripe). */
4532 timer
= XCAR (timers
);
4533 vector
= XVECTOR (timer
)->contents
;
4534 EMACS_SET_SECS (timer_time
,
4535 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4536 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4537 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4540 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4541 based on the next idle timer. */
4542 if (!NILP (idle_timers
))
4544 idle_timer
= XCAR (idle_timers
);
4545 vector
= XVECTOR (idle_timer
)->contents
;
4546 EMACS_SET_SECS (idle_timer_time
,
4547 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4548 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4549 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4552 /* Decide which timer is the next timer,
4553 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4554 Also step down the list where we found that timer. */
4556 if (! NILP (timers
) && ! NILP (idle_timers
))
4559 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4560 if (EMACS_TIME_NEG_P (temp
))
4562 chosen_timer
= timer
;
4563 timers
= XCDR (timers
);
4564 difference
= timer_difference
;
4568 chosen_timer
= idle_timer
;
4569 idle_timers
= XCDR (idle_timers
);
4570 difference
= idle_timer_difference
;
4573 else if (! NILP (timers
))
4575 chosen_timer
= timer
;
4576 timers
= XCDR (timers
);
4577 difference
= timer_difference
;
4581 chosen_timer
= idle_timer
;
4582 idle_timers
= XCDR (idle_timers
);
4583 difference
= idle_timer_difference
;
4585 vector
= XVECTOR (chosen_timer
)->contents
;
4587 /* If timer is ripe, run it if it hasn't been run. */
4588 if (EMACS_TIME_NEG_P (difference
)
4589 || (EMACS_SECS (difference
) == 0
4590 && EMACS_USECS (difference
) == 0))
4592 if (NILP (vector
[0]))
4594 int count
= SPECPDL_INDEX ();
4595 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4597 #if 0 /* This shouldn't be necessary anymore. --lorentey */
4598 /* On unbind_to, resume allowing input from any kboard, if that
4600 record_single_kboard_state ();
4602 /* Mark the timer as triggered to prevent problems if the lisp
4603 code fails to reschedule it right. */
4606 specbind (Qinhibit_quit
, Qt
);
4608 call1 (Qtimer_event_handler
, chosen_timer
);
4609 Vdeactivate_mark
= old_deactivate_mark
;
4611 unbind_to (count
, Qnil
);
4613 /* Since we have handled the event,
4614 we don't need to tell the caller to wake up and do it. */
4618 /* When we encounter a timer that is still waiting,
4619 return the amount of time to wait before it is ripe. */
4626 /* No timers are pending in the future. */
4627 /* Return 0 if we generated an event, and -1 if not. */
4632 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4633 doc
: /* Return the current length of Emacs idleness, or nil.
4634 The value when Emacs is idle is a list of three integers. The first has the
4635 most significant 16 bits of the seconds, while the second has the
4636 least significant 16 bits. The third integer gives the microsecond
4639 The value when Emacs is not idle is nil.
4641 The microsecond count is zero on systems that do not provide
4642 resolution finer than a second. */)
4645 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4647 EMACS_TIME now
, idleness_now
;
4649 EMACS_GET_TIME (now
);
4650 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4652 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4653 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4654 make_number (EMACS_USECS (idleness_now
)));
4660 /* Caches for modify_event_symbol. */
4661 static Lisp_Object accent_key_syms
;
4662 static Lisp_Object func_key_syms
;
4663 static Lisp_Object mouse_syms
;
4664 static Lisp_Object wheel_syms
;
4665 static Lisp_Object drag_n_drop_syms
;
4667 /* This is a list of keysym codes for special "accent" characters.
4668 It parallels lispy_accent_keys. */
4670 static int lispy_accent_codes
[] =
4672 #ifdef XK_dead_circumflex
4677 #ifdef XK_dead_grave
4682 #ifdef XK_dead_tilde
4687 #ifdef XK_dead_diaeresis
4692 #ifdef XK_dead_macron
4697 #ifdef XK_dead_degree
4702 #ifdef XK_dead_acute
4707 #ifdef XK_dead_cedilla
4712 #ifdef XK_dead_breve
4717 #ifdef XK_dead_ogonek
4722 #ifdef XK_dead_caron
4727 #ifdef XK_dead_doubleacute
4728 XK_dead_doubleacute
,
4732 #ifdef XK_dead_abovedot
4737 #ifdef XK_dead_abovering
4747 #ifdef XK_dead_belowdot
4752 #ifdef XK_dead_voiced_sound
4753 XK_dead_voiced_sound
,
4757 #ifdef XK_dead_semivoiced_sound
4758 XK_dead_semivoiced_sound
,
4774 /* This is a list of Lisp names for special "accent" characters.
4775 It parallels lispy_accent_codes. */
4777 static char *lispy_accent_keys
[] =
4795 "dead-voiced-sound",
4796 "dead-semivoiced-sound",
4802 #define FUNCTION_KEY_OFFSET 0x0
4804 char *lispy_function_keys
[] =
4808 0, /* VK_LBUTTON 0x01 */
4809 0, /* VK_RBUTTON 0x02 */
4810 "cancel", /* VK_CANCEL 0x03 */
4811 0, /* VK_MBUTTON 0x04 */
4813 0, 0, 0, /* 0x05 .. 0x07 */
4815 "backspace", /* VK_BACK 0x08 */
4816 "tab", /* VK_TAB 0x09 */
4818 0, 0, /* 0x0A .. 0x0B */
4820 "clear", /* VK_CLEAR 0x0C */
4821 "return", /* VK_RETURN 0x0D */
4823 0, 0, /* 0x0E .. 0x0F */
4825 0, /* VK_SHIFT 0x10 */
4826 0, /* VK_CONTROL 0x11 */
4827 0, /* VK_MENU 0x12 */
4828 "pause", /* VK_PAUSE 0x13 */
4829 "capslock", /* VK_CAPITAL 0x14 */
4830 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4832 "junja", /* VK_JUNJA 0x17 */
4833 "final", /* VK_FINAL 0x18 */
4834 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4836 "escape", /* VK_ESCAPE 0x1B */
4837 "convert", /* VK_CONVERT 0x1C */
4838 "non-convert", /* VK_NONCONVERT 0x1D */
4839 "accept", /* VK_ACCEPT 0x1E */
4840 "mode-change", /* VK_MODECHANGE 0x1F */
4841 0, /* VK_SPACE 0x20 */
4842 "prior", /* VK_PRIOR 0x21 */
4843 "next", /* VK_NEXT 0x22 */
4844 "end", /* VK_END 0x23 */
4845 "home", /* VK_HOME 0x24 */
4846 "left", /* VK_LEFT 0x25 */
4847 "up", /* VK_UP 0x26 */
4848 "right", /* VK_RIGHT 0x27 */
4849 "down", /* VK_DOWN 0x28 */
4850 "select", /* VK_SELECT 0x29 */
4851 "print", /* VK_PRINT 0x2A */
4852 "execute", /* VK_EXECUTE 0x2B */
4853 "snapshot", /* VK_SNAPSHOT 0x2C */
4854 "insert", /* VK_INSERT 0x2D */
4855 "delete", /* VK_DELETE 0x2E */
4856 "help", /* VK_HELP 0x2F */
4858 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4860 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4862 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4864 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4866 0, 0, 0, 0, 0, 0, 0, 0, 0,
4867 0, 0, 0, 0, 0, 0, 0, 0, 0,
4868 0, 0, 0, 0, 0, 0, 0, 0,
4870 "lwindow", /* VK_LWIN 0x5B */
4871 "rwindow", /* VK_RWIN 0x5C */
4872 "apps", /* VK_APPS 0x5D */
4875 "kp-0", /* VK_NUMPAD0 0x60 */
4876 "kp-1", /* VK_NUMPAD1 0x61 */
4877 "kp-2", /* VK_NUMPAD2 0x62 */
4878 "kp-3", /* VK_NUMPAD3 0x63 */
4879 "kp-4", /* VK_NUMPAD4 0x64 */
4880 "kp-5", /* VK_NUMPAD5 0x65 */
4881 "kp-6", /* VK_NUMPAD6 0x66 */
4882 "kp-7", /* VK_NUMPAD7 0x67 */
4883 "kp-8", /* VK_NUMPAD8 0x68 */
4884 "kp-9", /* VK_NUMPAD9 0x69 */
4885 "kp-multiply", /* VK_MULTIPLY 0x6A */
4886 "kp-add", /* VK_ADD 0x6B */
4887 "kp-separator", /* VK_SEPARATOR 0x6C */
4888 "kp-subtract", /* VK_SUBTRACT 0x6D */
4889 "kp-decimal", /* VK_DECIMAL 0x6E */
4890 "kp-divide", /* VK_DIVIDE 0x6F */
4891 "f1", /* VK_F1 0x70 */
4892 "f2", /* VK_F2 0x71 */
4893 "f3", /* VK_F3 0x72 */
4894 "f4", /* VK_F4 0x73 */
4895 "f5", /* VK_F5 0x74 */
4896 "f6", /* VK_F6 0x75 */
4897 "f7", /* VK_F7 0x76 */
4898 "f8", /* VK_F8 0x77 */
4899 "f9", /* VK_F9 0x78 */
4900 "f10", /* VK_F10 0x79 */
4901 "f11", /* VK_F11 0x7A */
4902 "f12", /* VK_F12 0x7B */
4903 "f13", /* VK_F13 0x7C */
4904 "f14", /* VK_F14 0x7D */
4905 "f15", /* VK_F15 0x7E */
4906 "f16", /* VK_F16 0x7F */
4907 "f17", /* VK_F17 0x80 */
4908 "f18", /* VK_F18 0x81 */
4909 "f19", /* VK_F19 0x82 */
4910 "f20", /* VK_F20 0x83 */
4911 "f21", /* VK_F21 0x84 */
4912 "f22", /* VK_F22 0x85 */
4913 "f23", /* VK_F23 0x86 */
4914 "f24", /* VK_F24 0x87 */
4916 0, 0, 0, 0, /* 0x88 .. 0x8B */
4917 0, 0, 0, 0, /* 0x8C .. 0x8F */
4919 "kp-numlock", /* VK_NUMLOCK 0x90 */
4920 "scroll", /* VK_SCROLL 0x91 */
4921 /* Not sure where the following block comes from.
4922 Windows headers have NEC and Fujitsu specific keys in
4923 this block, but nothing generic. */
4924 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4925 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4926 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4927 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4928 "kp-end", /* VK_NUMPAD_END 0x96 */
4929 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4930 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4931 "kp-up", /* VK_NUMPAD_UP 0x99 */
4932 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4933 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4934 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4935 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4937 0, 0, /* 0x9E .. 0x9F */
4940 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4941 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4942 * No other API or message will distinguish left and right keys this way.
4947 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4948 to enable them selectively, and gives access to a few more functions.
4949 See lispy_multimedia_keys below. */
4950 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4951 0, 0, 0, /* 0xAD .. 0xAF Volume */
4952 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4953 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4955 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4956 0, 0, 0, 0, 0, 0, 0, 0, 0,
4958 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4959 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4960 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4963 "ax", /* VK_OEM_AX 0xE1 */
4964 0, /* VK_OEM_102 0xE2 */
4965 "ico-help", /* VK_ICO_HELP 0xE3 */
4966 "ico-00", /* VK_ICO_00 0xE4 */
4967 0, /* VK_PROCESSKEY 0xE5 */
4968 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4969 "packet", /* VK_PACKET 0xE7 */
4971 "reset", /* VK_OEM_RESET 0xE9 */
4972 "jump", /* VK_OEM_JUMP 0xEA */
4973 "oem-pa1", /* VK_OEM_PA1 0xEB */
4974 "oem-pa2", /* VK_OEM_PA2 0xEC */
4975 "oem-pa3", /* VK_OEM_PA3 0xED */
4976 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4977 "cusel", /* VK_OEM_CUSEL 0xEF */
4978 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4979 "finish", /* VK_OEM_FINISH 0xF1 */
4980 "copy", /* VK_OEM_COPY 0xF2 */
4981 "auto", /* VK_OEM_AUTO 0xF3 */
4982 "enlw", /* VK_OEM_ENLW 0xF4 */
4983 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4984 "attn", /* VK_ATTN 0xF6 */
4985 "crsel", /* VK_CRSEL 0xF7 */
4986 "exsel", /* VK_EXSEL 0xF8 */
4987 "ereof", /* VK_EREOF 0xF9 */
4988 "play", /* VK_PLAY 0xFA */
4989 "zoom", /* VK_ZOOM 0xFB */
4990 "noname", /* VK_NONAME 0xFC */
4991 "pa1", /* VK_PA1 0xFD */
4992 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4996 /* Some of these duplicate the "Media keys" on newer keyboards,
4997 but they are delivered to the application in a different way. */
4998 static char *lispy_multimedia_keys
[] =
5006 "browser-favorites",
5043 "toggle-dictate-command",
5049 "media-fast-forward",
5052 "media-channel-down"
5055 #else /* not HAVE_NTGUI */
5057 /* This should be dealt with in XTread_socket now, and that doesn't
5058 depend on the client system having the Kana syms defined. See also
5059 the XK_kana_A case below. */
5062 static char *lispy_kana_keys
[] =
5064 /* X Keysym value */
5065 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5066 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5067 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5068 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5069 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5070 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5071 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5072 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5073 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5074 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5075 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5076 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5077 "kana-i", "kana-u", "kana-e", "kana-o",
5078 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5079 "prolongedsound", "kana-A", "kana-I", "kana-U",
5080 "kana-E", "kana-O", "kana-KA", "kana-KI",
5081 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5082 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5083 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5084 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5085 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5086 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5087 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5088 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5089 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5090 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5091 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5092 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5094 #endif /* XK_kana_A */
5097 #define FUNCTION_KEY_OFFSET 0xff00
5099 /* You'll notice that this table is arranged to be conveniently
5100 indexed by X Windows keysym values. */
5101 static char *lispy_function_keys
[] =
5103 /* X Keysym value */
5105 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5106 "backspace", "tab", "linefeed", "clear",
5108 0, 0, 0, "pause", /* 0xff10...1f */
5109 0, 0, 0, 0, 0, 0, 0, "escape",
5111 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5112 "romaji", "hiragana", "katakana", "hiragana-katakana",
5113 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5114 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5115 "eisu-toggle", /* 0xff30...3f */
5116 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5117 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5119 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5120 "down", "prior", "next", "end",
5121 "begin", 0, 0, 0, 0, 0, 0, 0,
5122 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5133 "break", /* 0xff6b */
5136 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5137 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5138 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5139 0, 0, 0, 0, 0, 0, 0, 0,
5140 "kp-tab", /* 0xff89 */
5142 "kp-enter", /* 0xff8d */
5144 "kp-f1", /* 0xff91 */
5148 "kp-home", /* 0xff95 */
5153 "kp-prior", /* kp-page-up */
5154 "kp-next", /* kp-page-down */
5160 0, 0, 0, 0, 0, 0, 0, 0, 0,
5161 "kp-multiply", /* 0xffaa */
5166 "kp-divide", /* 0xffaf */
5167 "kp-0", /* 0xffb0 */
5168 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5171 "kp-equal", /* 0xffbd */
5172 "f1", /* 0xffbe */ /* IsFunctionKey */
5174 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5175 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5176 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5177 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5178 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5179 0, 0, 0, 0, 0, 0, 0, 0,
5180 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5181 0, 0, 0, 0, 0, 0, 0, "delete"
5184 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5185 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5187 static char *iso_lispy_function_keys
[] =
5189 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5190 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5191 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5192 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5193 "iso-lefttab", /* 0xfe20 */
5194 "iso-move-line-up", "iso-move-line-down",
5195 "iso-partial-line-up", "iso-partial-line-down",
5196 "iso-partial-space-left", "iso-partial-space-right",
5197 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5198 "iso-release-margin-left", "iso-release-margin-right",
5199 "iso-release-both-margins",
5200 "iso-fast-cursor-left", "iso-fast-cursor-right",
5201 "iso-fast-cursor-up", "iso-fast-cursor-down",
5202 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5203 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5206 #endif /* not HAVE_NTGUI */
5208 Lisp_Object Vlispy_mouse_stem
;
5210 static char *lispy_wheel_names
[] =
5212 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5215 /* drag-n-drop events are generated when a set of selected files are
5216 dragged from another application and dropped onto an Emacs window. */
5217 static char *lispy_drag_n_drop_names
[] =
5222 /* Scroll bar parts. */
5223 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5224 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5225 Lisp_Object Qtop
, Qratio
;
5227 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5228 Lisp_Object
*scroll_bar_parts
[] = {
5229 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5230 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5233 /* A vector, indexed by button number, giving the down-going location
5234 of currently depressed buttons, both scroll bar and non-scroll bar.
5236 The elements have the form
5237 (BUTTON-NUMBER MODIFIER-MASK . REST)
5238 where REST is the cdr of a position as it would be reported in the event.
5240 The make_lispy_event function stores positions here to tell the
5241 difference between click and drag events, and to store the starting
5242 location to be included in drag events. */
5244 static Lisp_Object button_down_location
;
5246 /* Information about the most recent up-going button event: Which
5247 button, what location, and what time. */
5249 static int last_mouse_button
;
5250 static int last_mouse_x
;
5251 static int last_mouse_y
;
5252 static unsigned long button_down_time
;
5254 /* The maximum time between clicks to make a double-click, or Qnil to
5255 disable double-click detection, or Qt for no time limit. */
5257 Lisp_Object Vdouble_click_time
;
5259 /* Maximum number of pixels the mouse may be moved between clicks
5260 to make a double-click. */
5262 EMACS_INT double_click_fuzz
;
5264 /* The number of clicks in this multiple-click. */
5266 int double_click_count
;
5268 /* Return position of a mouse click or wheel event */
5271 make_lispy_position (f
, x
, y
, time
)
5277 enum window_part part
;
5278 Lisp_Object posn
= Qnil
;
5279 Lisp_Object extra_info
= Qnil
;
5282 /* Set `window' to the window under frame pixel coordinates (x,y) */
5284 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5285 &part
, &wx
, &wy
, 0);
5289 if (WINDOWP (window
))
5291 /* It's a click in window window at frame coordinates (x,y) */
5292 struct window
*w
= XWINDOW (window
);
5293 Lisp_Object string_info
= Qnil
;
5294 int textpos
= -1, rx
= -1, ry
= -1;
5295 int dx
= -1, dy
= -1;
5296 int width
= -1, height
= -1;
5297 Lisp_Object object
= Qnil
;
5299 /* Set event coordinates to window-relative coordinates
5300 for constructing the Lisp event below. */
5304 if (part
== ON_TEXT
)
5306 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5308 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5310 /* Mode line or header line. Look for a string under
5311 the mouse that may have a `local-map' property. */
5315 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5317 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5318 &object
, &dx
, &dy
, &width
, &height
);
5319 if (STRINGP (string
))
5320 string_info
= Fcons (string
, make_number (charpos
));
5321 if (w
== XWINDOW (selected_window
))
5324 textpos
= XMARKER (w
->pointm
)->charpos
;
5326 else if (part
== ON_VERTICAL_BORDER
)
5328 posn
= Qvertical_line
;
5333 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5338 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5340 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5341 &object
, &dx
, &dy
, &width
, &height
);
5342 if (STRINGP (string
))
5343 string_info
= Fcons (string
, make_number (charpos
));
5344 if (part
== ON_LEFT_MARGIN
)
5347 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5349 else if (part
== ON_LEFT_FRINGE
)
5351 posn
= Qleft_fringe
;
5354 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5356 : window_box_width (w
, LEFT_MARGIN_AREA
));
5359 else if (part
== ON_RIGHT_FRINGE
)
5361 posn
= Qright_fringe
;
5364 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5365 + window_box_width (w
, TEXT_AREA
)
5366 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5367 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5373 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5374 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5379 Lisp_Object string2
, object2
= Qnil
;
5380 struct display_pos p
;
5382 int width2
, height2
;
5383 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5384 &object2
, &dx2
, &dy2
,
5386 textpos
= CHARPOS (p
.pos
);
5387 if (rx
< 0) rx
= wx
;
5388 if (ry
< 0) ry
= wy
;
5389 if (dx
< 0) dx
= dx2
;
5390 if (dy
< 0) dy
= dy2
;
5391 if (width
< 0) width
= width2
;
5392 if (height
< 0) height
= height2
;
5396 posn
= make_number (textpos
);
5397 if (STRINGP (string2
))
5398 string_info
= Fcons (string2
,
5399 make_number (CHARPOS (p
.string_pos
)));
5405 #ifdef HAVE_WINDOW_SYSTEM
5406 if (IMAGEP (object
))
5408 Lisp_Object image_map
, hotspot
;
5409 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5411 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5413 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5414 posn
= XCAR (hotspot
);
5419 extra_info
= Fcons (object
,
5420 Fcons (Fcons (make_number (dx
),
5422 Fcons (Fcons (make_number (width
),
5423 make_number (height
)),
5427 extra_info
= Fcons (string_info
,
5428 Fcons (make_number (textpos
),
5429 Fcons (Fcons (make_number (rx
),
5435 XSETFRAME (window
, f
);
5440 XSETFASTINT (*x
, 0);
5441 XSETFASTINT (*y
, 0);
5444 return Fcons (window
,
5446 Fcons (Fcons (*x
, *y
),
5447 Fcons (make_number (time
),
5451 /* Given a struct input_event, build the lisp event which represents
5452 it. If EVENT is 0, build a mouse movement event from the mouse
5453 movement buffer, which should have a movement event in it.
5455 Note that events must be passed to this function in the order they
5456 are received; this function stores the location of button presses
5457 in order to build drag events when the button is released. */
5460 make_lispy_event (event
)
5461 struct input_event
*event
;
5465 switch (SWITCH_ENUM_CAST (event
->kind
))
5467 /* A simple keystroke. */
5468 case ASCII_KEYSTROKE_EVENT
:
5469 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5471 Lisp_Object lispy_c
;
5472 int c
= event
->code
;
5473 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5476 eassert (c
== event
->code
);
5477 /* Turn ASCII characters into control characters
5479 if (event
->modifiers
& ctrl_modifier
)
5481 c
= make_ctrl_char (c
);
5482 event
->modifiers
&= ~ctrl_modifier
;
5486 /* Add in the other modifier bits. The shift key was taken care
5487 of by the X code. */
5488 c
|= (event
->modifiers
5489 & (meta_modifier
| alt_modifier
5490 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5491 /* Distinguish Shift-SPC from SPC. */
5492 if ((event
->code
) == 040
5493 && event
->modifiers
& shift_modifier
)
5494 c
|= shift_modifier
;
5495 button_down_time
= 0;
5496 XSETFASTINT (lispy_c
, c
);
5500 /* A function key. The symbol may need to have modifier prefixes
5502 case NON_ASCII_KEYSTROKE_EVENT
:
5503 button_down_time
= 0;
5505 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5506 if (event
->code
== lispy_accent_codes
[i
])
5507 return modify_event_symbol (i
,
5509 Qfunction_key
, Qnil
,
5510 lispy_accent_keys
, &accent_key_syms
,
5511 (sizeof (lispy_accent_keys
)
5512 / sizeof (lispy_accent_keys
[0])));
5516 if (event
->code
>= 0x400 && event
->code
< 0x500)
5517 return modify_event_symbol (event
->code
- 0x400,
5518 event
->modifiers
& ~shift_modifier
,
5519 Qfunction_key
, Qnil
,
5520 lispy_kana_keys
, &func_key_syms
,
5521 (sizeof (lispy_kana_keys
)
5522 / sizeof (lispy_kana_keys
[0])));
5523 #endif /* XK_kana_A */
5526 #ifdef ISO_FUNCTION_KEY_OFFSET
5527 if (event
->code
< FUNCTION_KEY_OFFSET
5528 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5529 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5531 Qfunction_key
, Qnil
,
5532 iso_lispy_function_keys
, &func_key_syms
,
5533 (sizeof (iso_lispy_function_keys
)
5534 / sizeof (iso_lispy_function_keys
[0])));
5537 /* Handle system-specific or unknown keysyms. */
5538 if (event
->code
& (1 << 28)
5539 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5540 || (event
->code
- FUNCTION_KEY_OFFSET
5541 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5542 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5544 /* We need to use an alist rather than a vector as the cache
5545 since we can't make a vector long enuf. */
5546 if (NILP (current_kboard
->system_key_syms
))
5547 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5548 return modify_event_symbol (event
->code
,
5551 current_kboard
->Vsystem_key_alist
,
5552 0, ¤t_kboard
->system_key_syms
,
5556 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5558 Qfunction_key
, Qnil
,
5559 lispy_function_keys
, &func_key_syms
,
5560 (sizeof (lispy_function_keys
)
5561 / sizeof (lispy_function_keys
[0])));
5564 case MULTIMEDIA_KEY_EVENT
:
5565 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5566 / sizeof (lispy_multimedia_keys
[0]))
5567 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5569 return modify_event_symbol (event
->code
, event
->modifiers
,
5570 Qfunction_key
, Qnil
,
5571 lispy_multimedia_keys
, &func_key_syms
,
5572 (sizeof (lispy_multimedia_keys
)
5573 / sizeof (lispy_multimedia_keys
[0])));
5579 /* A mouse click. Figure out where it is, decide whether it's
5580 a press, click or drag, and build the appropriate structure. */
5581 case MOUSE_CLICK_EVENT
:
5582 #ifndef USE_TOOLKIT_SCROLL_BARS
5583 case SCROLL_BAR_CLICK_EVENT
:
5586 int button
= event
->code
;
5588 Lisp_Object position
;
5589 Lisp_Object
*start_pos_ptr
;
5590 Lisp_Object start_pos
;
5594 /* Build the position as appropriate for this mouse click. */
5595 if (event
->kind
== MOUSE_CLICK_EVENT
)
5597 struct frame
*f
= XFRAME (event
->frame_or_window
);
5598 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5602 /* Ignore mouse events that were made on frame that
5603 have been deleted. */
5604 if (! FRAME_LIVE_P (f
))
5607 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5608 /* EVENT->x and EVENT->y are frame-relative pixel
5609 coordinates at this place. Under old redisplay, COLUMN
5610 and ROW are set to frame relative glyph coordinates
5611 which are then used to determine whether this click is
5612 in a menu (non-toolkit version). */
5613 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5614 &column
, &row
, NULL
, 1);
5616 /* In the non-toolkit version, clicks on the menu bar
5617 are ordinary button events in the event buffer.
5618 Distinguish them, and invoke the menu.
5620 (In the toolkit version, the toolkit handles the menu bar
5621 and Emacs doesn't know about it until after the user
5622 makes a selection.) */
5623 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5624 && (event
->modifiers
& down_modifier
))
5626 Lisp_Object items
, item
;
5631 /* Activate the menu bar on the down event. If the
5632 up event comes in before the menu code can deal with it,
5634 if (! (event
->modifiers
& down_modifier
))
5638 /* Find the menu bar item under `column'. */
5640 items
= FRAME_MENU_BAR_ITEMS (f
);
5641 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5643 Lisp_Object pos
, string
;
5644 string
= AREF (items
, i
+ 1);
5645 pos
= AREF (items
, i
+ 3);
5648 if (column
>= XINT (pos
)
5649 && column
< XINT (pos
) + SCHARS (string
))
5651 item
= AREF (items
, i
);
5656 /* ELisp manual 2.4b says (x y) are window relative but
5657 code says they are frame-relative. */
5659 = Fcons (event
->frame_or_window
,
5661 Fcons (Fcons (event
->x
, event
->y
),
5662 Fcons (make_number (event
->timestamp
),
5665 return Fcons (item
, Fcons (position
, Qnil
));
5667 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5669 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5672 #ifndef USE_TOOLKIT_SCROLL_BARS
5675 /* It's a scrollbar click. */
5677 Lisp_Object portion_whole
;
5680 window
= event
->frame_or_window
;
5681 portion_whole
= Fcons (event
->x
, event
->y
);
5682 part
= *scroll_bar_parts
[(int) event
->part
];
5686 Fcons (Qvertical_scroll_bar
,
5687 Fcons (portion_whole
,
5688 Fcons (make_number (event
->timestamp
),
5689 Fcons (part
, Qnil
)))));
5691 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5693 if (button
>= ASIZE (button_down_location
))
5695 button_down_location
= larger_vector (button_down_location
,
5697 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5700 start_pos_ptr
= &AREF (button_down_location
, button
);
5701 start_pos
= *start_pos_ptr
;
5702 *start_pos_ptr
= Qnil
;
5705 /* On window-system frames, use the value of
5706 double-click-fuzz as is. On other frames, interpret it
5707 as a multiple of 1/8 characters. */
5711 if (WINDOWP (event
->frame_or_window
))
5712 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5713 else if (FRAMEP (event
->frame_or_window
))
5714 f
= XFRAME (event
->frame_or_window
);
5718 if (FRAME_WINDOW_P (f
))
5719 fuzz
= double_click_fuzz
;
5721 fuzz
= double_click_fuzz
/ 8;
5723 is_double
= (button
== last_mouse_button
5724 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5725 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5726 && button_down_time
!= 0
5727 && (EQ (Vdouble_click_time
, Qt
)
5728 || (INTEGERP (Vdouble_click_time
)
5729 && ((int)(event
->timestamp
- button_down_time
)
5730 < XINT (Vdouble_click_time
)))));
5733 last_mouse_button
= button
;
5734 last_mouse_x
= XINT (event
->x
);
5735 last_mouse_y
= XINT (event
->y
);
5737 /* If this is a button press, squirrel away the location, so
5738 we can decide later whether it was a click or a drag. */
5739 if (event
->modifiers
& down_modifier
)
5743 double_click_count
++;
5744 event
->modifiers
|= ((double_click_count
> 2)
5749 double_click_count
= 1;
5750 button_down_time
= event
->timestamp
;
5751 *start_pos_ptr
= Fcopy_alist (position
);
5752 ignore_mouse_drag_p
= 0;
5755 /* Now we're releasing a button - check the co-ordinates to
5756 see if this was a click or a drag. */
5757 else if (event
->modifiers
& up_modifier
)
5759 /* If we did not see a down before this up, ignore the up.
5760 Probably this happened because the down event chose a
5761 menu item. It would be an annoyance to treat the
5762 release of the button that chose the menu item as a
5765 if (!CONSP (start_pos
))
5768 event
->modifiers
&= ~up_modifier
;
5769 #if 0 /* Formerly we treated an up with no down as a click event. */
5770 if (!CONSP (start_pos
))
5771 event
->modifiers
|= click_modifier
;
5776 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5778 /* The third element of every position
5779 should be the (x,y) pair. */
5780 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5782 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5784 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5785 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5788 if (ignore_mouse_drag_p
)
5790 event
->modifiers
|= click_modifier
;
5791 ignore_mouse_drag_p
= 0;
5793 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5794 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5795 /* Maybe the mouse has moved a lot, caused scrolling, and
5796 eventually ended up at the same screen position (but
5797 not buffer position) in which case it is a drag, not
5799 /* FIXME: OTOH if the buffer position has changed
5800 because of a timer or process filter rather than
5801 because of mouse movement, it should be considered as
5802 a click. But mouse-drag-region completely ignores
5803 this case and it hasn't caused any real problem, so
5804 it's probably OK to ignore it as well. */
5805 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5806 /* Mouse hasn't moved (much). */
5807 event
->modifiers
|= click_modifier
;
5810 button_down_time
= 0;
5811 event
->modifiers
|= drag_modifier
;
5814 /* Don't check is_double; treat this as multiple
5815 if the down-event was multiple. */
5816 if (double_click_count
> 1)
5817 event
->modifiers
|= ((double_click_count
> 2)
5823 /* Every mouse event should either have the down_modifier or
5824 the up_modifier set. */
5828 /* Get the symbol we should use for the mouse click. */
5831 head
= modify_event_symbol (button
,
5833 Qmouse_click
, Vlispy_mouse_stem
,
5836 XVECTOR (mouse_syms
)->size
);
5837 if (event
->modifiers
& drag_modifier
)
5842 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5845 Fcons (make_number (double_click_count
),
5855 case HORIZ_WHEEL_EVENT
:
5857 Lisp_Object position
;
5860 /* Build the position as appropriate for this mouse click. */
5861 struct frame
*f
= XFRAME (event
->frame_or_window
);
5863 /* Ignore wheel events that were made on frame that have been
5865 if (! FRAME_LIVE_P (f
))
5868 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5871 /* Set double or triple modifiers to indicate the wheel speed. */
5873 /* On window-system frames, use the value of
5874 double-click-fuzz as is. On other frames, interpret it
5875 as a multiple of 1/8 characters. */
5880 if (WINDOWP (event
->frame_or_window
))
5881 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5882 else if (FRAMEP (event
->frame_or_window
))
5883 f
= XFRAME (event
->frame_or_window
);
5887 if (FRAME_WINDOW_P (f
))
5888 fuzz
= double_click_fuzz
;
5890 fuzz
= double_click_fuzz
/ 8;
5892 is_double
= (last_mouse_button
< 0
5893 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5894 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5895 && button_down_time
!= 0
5896 && (EQ (Vdouble_click_time
, Qt
)
5897 || (INTEGERP (Vdouble_click_time
)
5898 && ((int)(event
->timestamp
- button_down_time
)
5899 < XINT (Vdouble_click_time
)))));
5902 double_click_count
++;
5903 event
->modifiers
|= ((double_click_count
> 2)
5909 double_click_count
= 1;
5910 event
->modifiers
|= click_modifier
;
5913 button_down_time
= event
->timestamp
;
5914 /* Use a negative value to distinguish wheel from mouse button. */
5915 last_mouse_button
= -1;
5916 last_mouse_x
= XINT (event
->x
);
5917 last_mouse_y
= XINT (event
->y
);
5923 if (event
->modifiers
& up_modifier
)
5925 /* Emit a wheel-up event. */
5926 event
->modifiers
&= ~up_modifier
;
5929 else if (event
->modifiers
& down_modifier
)
5931 /* Emit a wheel-down event. */
5932 event
->modifiers
&= ~down_modifier
;
5936 /* Every wheel event should either have the down_modifier or
5937 the up_modifier set. */
5940 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5943 /* Get the symbol we should use for the wheel event. */
5944 head
= modify_event_symbol (symbol_num
,
5950 ASIZE (wheel_syms
));
5953 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5956 Fcons (make_number (double_click_count
),
5965 #ifdef USE_TOOLKIT_SCROLL_BARS
5967 /* We don't have down and up events if using toolkit scroll bars,
5968 so make this always a click event. Store in the `part' of
5969 the Lisp event a symbol which maps to the following actions:
5971 `above_handle' page up
5972 `below_handle' page down
5976 `bottom' bottom of buffer
5977 `handle' thumb has been dragged.
5978 `end-scroll' end of interaction with scroll bar
5980 The incoming input_event contains in its `part' member an
5981 index of type `enum scroll_bar_part' which we can use as an
5982 index in scroll_bar_parts to get the appropriate symbol. */
5984 case SCROLL_BAR_CLICK_EVENT
:
5986 Lisp_Object position
, head
, window
, portion_whole
, part
;
5988 window
= event
->frame_or_window
;
5989 portion_whole
= Fcons (event
->x
, event
->y
);
5990 part
= *scroll_bar_parts
[(int) event
->part
];
5994 Fcons (Qvertical_scroll_bar
,
5995 Fcons (portion_whole
,
5996 Fcons (make_number (event
->timestamp
),
5997 Fcons (part
, Qnil
)))));
5999 /* Always treat scroll bar events as clicks. */
6000 event
->modifiers
|= click_modifier
;
6001 event
->modifiers
&= ~up_modifier
;
6003 if (event
->code
>= ASIZE (mouse_syms
))
6004 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
6006 /* Get the symbol we should use for the mouse click. */
6007 head
= modify_event_symbol (event
->code
,
6012 XVECTOR (mouse_syms
)->size
);
6013 return Fcons (head
, Fcons (position
, Qnil
));
6016 #endif /* USE_TOOLKIT_SCROLL_BARS */
6018 case DRAG_N_DROP_EVENT
:
6021 Lisp_Object head
, position
;
6024 f
= XFRAME (event
->frame_or_window
);
6027 /* Ignore mouse events that were made on frames that
6028 have been deleted. */
6029 if (! FRAME_LIVE_P (f
))
6032 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6035 head
= modify_event_symbol (0, event
->modifiers
,
6037 lispy_drag_n_drop_names
,
6038 &drag_n_drop_syms
, 1);
6044 #endif /* HAVE_MOUSE */
6046 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6047 || defined(HAVE_NS) || defined (USE_GTK)
6048 case MENU_BAR_EVENT
:
6049 if (EQ (event
->arg
, event
->frame_or_window
))
6050 /* This is the prefix key. We translate this to
6051 `(menu_bar)' because the code in keyboard.c for menu
6052 events, which we use, relies on this. */
6053 return Fcons (Qmenu_bar
, Qnil
);
6057 case SELECT_WINDOW_EVENT
:
6058 /* Make an event (select-window (WINDOW)). */
6059 return Fcons (Qselect_window
,
6060 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6063 case TOOL_BAR_EVENT
:
6064 if (EQ (event
->arg
, event
->frame_or_window
))
6065 /* This is the prefix key. We translate this to
6066 `(tool_bar)' because the code in keyboard.c for tool bar
6067 events, which we use, relies on this. */
6068 return Fcons (Qtool_bar
, Qnil
);
6069 else if (SYMBOLP (event
->arg
))
6070 return apply_modifiers (event
->modifiers
, event
->arg
);
6073 case USER_SIGNAL_EVENT
:
6074 /* A user signal. */
6076 char *name
= find_user_signal_name (event
->code
);
6079 return intern (name
);
6082 case SAVE_SESSION_EVENT
:
6083 return Qsave_session
;
6088 return Fcons (Qdbus_event
, event
->arg
);
6090 #endif /* HAVE_DBUS */
6093 case GPM_CLICK_EVENT
:
6095 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6096 Lisp_Object head
, position
;
6097 Lisp_Object
*start_pos_ptr
;
6098 Lisp_Object start_pos
;
6099 int button
= event
->code
;
6101 if (button
>= ASIZE (button_down_location
))
6103 button_down_location
= larger_vector (button_down_location
,
6105 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6108 start_pos_ptr
= &AREF (button_down_location
, button
);
6109 start_pos
= *start_pos_ptr
;
6111 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6114 if (event
->modifiers
& down_modifier
)
6115 *start_pos_ptr
= Fcopy_alist (position
);
6116 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6118 if (!CONSP (start_pos
))
6120 event
->modifiers
&= ~up_modifier
;
6123 head
= modify_event_symbol (button
,
6125 Qmouse_click
, Vlispy_mouse_stem
,
6128 XVECTOR (mouse_syms
)->size
);
6130 if (event
->modifiers
& drag_modifier
)
6135 else if (event
->modifiers
& double_modifier
)
6138 Fcons (make_number (2),
6140 else if (event
->modifiers
& triple_modifier
)
6143 Fcons (make_number (3),
6150 #endif /* HAVE_GPM */
6152 /* The 'kind' field of the event is something we don't recognize. */
6158 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6161 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6163 Lisp_Object bar_window
;
6164 enum scroll_bar_part part
;
6168 /* Is it a scroll bar movement? */
6169 if (frame
&& ! NILP (bar_window
))
6171 Lisp_Object part_sym
;
6173 part_sym
= *scroll_bar_parts
[(int) part
];
6174 return Fcons (Qscroll_bar_movement
,
6175 (Fcons (Fcons (bar_window
,
6176 Fcons (Qvertical_scroll_bar
,
6177 Fcons (Fcons (x
, y
),
6178 Fcons (make_number (time
),
6184 /* Or is it an ordinary mouse movement? */
6187 Lisp_Object position
;
6189 position
= make_lispy_position (frame
, &x
, &y
, time
);
6191 return Fcons (Qmouse_movement
,
6197 #endif /* HAVE_MOUSE || HAVE GPM */
6199 /* Construct a switch frame event. */
6201 make_lispy_switch_frame (frame
)
6204 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6207 /* Manipulating modifiers. */
6209 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6211 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6212 SYMBOL's name of the end of the modifiers; the string from this
6213 position is the unmodified symbol name.
6215 This doesn't use any caches. */
6218 parse_modifiers_uncached (symbol
, modifier_end
)
6226 CHECK_SYMBOL (symbol
);
6229 name
= SYMBOL_NAME (symbol
);
6231 for (i
= 0; i
+2 <= SBYTES (name
); )
6233 int this_mod_end
= 0;
6236 /* See if the name continues with a modifier word.
6237 Check that the word appears, but don't check what follows it.
6238 Set this_mod and this_mod_end to record what we find. */
6240 switch (SREF (name
, i
))
6242 #define SINGLE_LETTER_MOD(BIT) \
6243 (this_mod_end = i + 1, this_mod = BIT)
6246 SINGLE_LETTER_MOD (alt_modifier
);
6250 SINGLE_LETTER_MOD (ctrl_modifier
);
6254 SINGLE_LETTER_MOD (hyper_modifier
);
6258 SINGLE_LETTER_MOD (meta_modifier
);
6262 SINGLE_LETTER_MOD (shift_modifier
);
6266 SINGLE_LETTER_MOD (super_modifier
);
6269 #undef SINGLE_LETTER_MOD
6271 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6272 if (i + LEN + 1 <= SBYTES (name) \
6273 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6275 this_mod_end = i + LEN; \
6280 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6281 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6282 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6286 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6288 #undef MULTI_LETTER_MOD
6292 /* If we found no modifier, stop looking for them. */
6293 if (this_mod_end
== 0)
6296 /* Check there is a dash after the modifier, so that it
6297 really is a modifier. */
6298 if (this_mod_end
>= SBYTES (name
)
6299 || SREF (name
, this_mod_end
) != '-')
6302 /* This modifier is real; look for another. */
6303 modifiers
|= this_mod
;
6304 i
= this_mod_end
+ 1;
6307 /* Should we include the `click' modifier? */
6308 if (! (modifiers
& (down_modifier
| drag_modifier
6309 | double_modifier
| triple_modifier
))
6310 && i
+ 7 == SBYTES (name
)
6311 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6312 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6313 modifiers
|= click_modifier
;
6321 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6322 prepended to the string BASE[0..BASE_LEN-1].
6323 This doesn't use any caches. */
6325 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6328 int base_len
, base_len_byte
;
6330 /* Since BASE could contain nulls, we can't use intern here; we have
6331 to use Fintern, which expects a genuine Lisp_String, and keeps a
6334 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6340 /* Only the event queue may use the `up' modifier; it should always
6341 be turned into a click or drag event before presented to lisp code. */
6342 if (modifiers
& up_modifier
)
6345 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6346 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6347 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6348 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6349 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6350 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6351 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6352 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6353 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6354 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6355 /* The click modifier is denoted by the absence of other modifiers. */
6359 mod_len
= p
- new_mods
;
6363 Lisp_Object new_name
;
6365 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6366 mod_len
+ base_len_byte
);
6367 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6368 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6370 return Fintern (new_name
, Qnil
);
6375 static char *modifier_names
[] =
6377 "up", "down", "drag", "click", "double", "triple", 0, 0,
6378 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6379 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6381 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6383 static Lisp_Object modifier_symbols
;
6385 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6387 lispy_modifier_list (modifiers
)
6390 Lisp_Object modifier_list
;
6393 modifier_list
= Qnil
;
6394 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6395 if (modifiers
& (1<<i
))
6396 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6399 return modifier_list
;
6403 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6404 where UNMODIFIED is the unmodified form of SYMBOL,
6405 MASK is the set of modifiers present in SYMBOL's name.
6406 This is similar to parse_modifiers_uncached, but uses the cache in
6407 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6408 Qevent_symbol_elements property. */
6410 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6413 parse_modifiers (symbol
)
6416 Lisp_Object elements
;
6418 if (INTEGERP (symbol
))
6419 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6420 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6422 else if (!SYMBOLP (symbol
))
6425 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6426 if (CONSP (elements
))
6431 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6432 Lisp_Object unmodified
;
6435 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6436 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6439 if (modifiers
& ~INTMASK
)
6441 XSETFASTINT (mask
, modifiers
);
6442 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6444 /* Cache the parsing results on SYMBOL. */
6445 Fput (symbol
, Qevent_symbol_element_mask
,
6447 Fput (symbol
, Qevent_symbol_elements
,
6448 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6450 /* Since we know that SYMBOL is modifiers applied to unmodified,
6451 it would be nice to put that in unmodified's cache.
6452 But we can't, since we're not sure that parse_modifiers is
6459 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6460 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6461 doc
: /* Parse the event symbol. For internal use. */)
6465 /* Fill the cache if needed. */
6466 parse_modifiers (symbol
);
6467 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6468 and use the Lispier representation stored on Qevent_symbol_elements
6470 return Fget (symbol
, Qevent_symbol_elements
);
6473 /* Apply the modifiers MODIFIERS to the symbol BASE.
6474 BASE must be unmodified.
6476 This is like apply_modifiers_uncached, but uses BASE's
6477 Qmodifier_cache property, if present. It also builds
6478 Qevent_symbol_elements properties, since it has that info anyway.
6480 apply_modifiers copies the value of BASE's Qevent_kind property to
6481 the modified symbol. */
6483 apply_modifiers (modifiers
, base
)
6487 Lisp_Object cache
, index
, entry
, new_symbol
;
6489 /* Mask out upper bits. We don't know where this value's been. */
6490 modifiers
&= INTMASK
;
6492 if (INTEGERP (base
))
6493 return make_number (XINT (base
) | modifiers
);
6495 /* The click modifier never figures into cache indices. */
6496 cache
= Fget (base
, Qmodifier_cache
);
6497 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6498 entry
= assq_no_quit (index
, cache
);
6501 new_symbol
= XCDR (entry
);
6504 /* We have to create the symbol ourselves. */
6505 new_symbol
= apply_modifiers_uncached (modifiers
,
6506 SDATA (SYMBOL_NAME (base
)),
6507 SCHARS (SYMBOL_NAME (base
)),
6508 SBYTES (SYMBOL_NAME (base
)));
6510 /* Add the new symbol to the base's cache. */
6511 entry
= Fcons (index
, new_symbol
);
6512 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6514 /* We have the parsing info now for free, so we could add it to
6516 XSETFASTINT (index, modifiers);
6517 Fput (new_symbol, Qevent_symbol_element_mask,
6518 Fcons (base, Fcons (index, Qnil)));
6519 Fput (new_symbol, Qevent_symbol_elements,
6520 Fcons (base, lispy_modifier_list (modifiers)));
6521 Sadly, this is only correct if `base' is indeed a base event,
6522 which is not necessarily the case. -stef */
6525 /* Make sure this symbol is of the same kind as BASE.
6527 You'd think we could just set this once and for all when we
6528 intern the symbol above, but reorder_modifiers may call us when
6529 BASE's property isn't set right; we can't assume that just
6530 because it has a Qmodifier_cache property it must have its
6531 Qevent_kind set right as well. */
6532 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6536 kind
= Fget (base
, Qevent_kind
);
6538 Fput (new_symbol
, Qevent_kind
, kind
);
6545 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6546 return a symbol with the modifiers placed in the canonical order.
6547 Canonical order is alphabetical, except for down and drag, which
6548 always come last. The 'click' modifier is never written out.
6550 Fdefine_key calls this to make sure that (for example) C-M-foo
6551 and M-C-foo end up being equivalent in the keymap. */
6554 reorder_modifiers (symbol
)
6557 /* It's hopefully okay to write the code this way, since everything
6558 will soon be in caches, and no consing will be done at all. */
6561 parsed
= parse_modifiers (symbol
);
6562 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6567 /* For handling events, we often want to produce a symbol whose name
6568 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6569 to some base, like the name of a function key or mouse button.
6570 modify_event_symbol produces symbols of this sort.
6572 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6573 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6576 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6577 into symbol names, or a string specifying a name stem used to
6578 construct a symbol name or the form `STEM-N', where N is the decimal
6579 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6580 non-nil; otherwise NAME_TABLE is used.
6582 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6583 persist between calls to modify_event_symbol that it can use to
6584 store a cache of the symbols it's generated for this NAME_TABLE
6585 before. The object stored there may be a vector or an alist.
6587 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6589 MODIFIERS is a set of modifier bits (as given in struct input_events)
6590 whose prefixes should be applied to the symbol name.
6592 SYMBOL_KIND is the value to be placed in the event_kind property of
6593 the returned symbol.
6595 The symbols we create are supposed to have an
6596 `event-symbol-elements' property, which lists the modifiers present
6597 in the symbol's name. */
6600 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6601 name_table
, symbol_table
, table_size
)
6604 Lisp_Object symbol_kind
;
6605 Lisp_Object name_alist_or_stem
;
6607 Lisp_Object
*symbol_table
;
6608 unsigned int table_size
;
6611 Lisp_Object symbol_int
;
6613 /* Get rid of the "vendor-specific" bit here. */
6614 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6616 /* Is this a request for a valid symbol? */
6617 if (symbol_num
< 0 || symbol_num
>= table_size
)
6620 if (CONSP (*symbol_table
))
6621 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6623 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6624 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6625 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6626 we've never used that symbol before. */
6629 if (! VECTORP (*symbol_table
)
6630 || XVECTOR (*symbol_table
)->size
!= table_size
)
6634 XSETFASTINT (size
, table_size
);
6635 *symbol_table
= Fmake_vector (size
, Qnil
);
6638 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6641 /* Have we already used this symbol before? */
6644 /* No; let's create it. */
6645 if (CONSP (name_alist_or_stem
))
6646 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6647 else if (STRINGP (name_alist_or_stem
))
6649 int len
= SBYTES (name_alist_or_stem
);
6650 char *buf
= (char *) alloca (len
+ 50);
6651 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6652 (long) XINT (symbol_int
) + 1);
6653 value
= intern (buf
);
6655 else if (name_table
!= 0 && name_table
[symbol_num
])
6656 value
= intern (name_table
[symbol_num
]);
6658 #ifdef HAVE_WINDOW_SYSTEM
6661 char *name
= x_get_keysym_name (symbol_num
);
6663 value
= intern (name
);
6670 sprintf (buf
, "key-%d", symbol_num
);
6671 value
= intern (buf
);
6674 if (CONSP (*symbol_table
))
6675 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6677 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6679 /* Fill in the cache entries for this symbol; this also
6680 builds the Qevent_symbol_elements property, which the user
6682 apply_modifiers (modifiers
& click_modifier
, value
);
6683 Fput (value
, Qevent_kind
, symbol_kind
);
6686 /* Apply modifiers to that symbol. */
6687 return apply_modifiers (modifiers
, value
);
6690 /* Convert a list that represents an event type,
6691 such as (ctrl meta backspace), into the usual representation of that
6692 event type as a number or a symbol. */
6694 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6695 doc
: /* Convert the event description list EVENT-DESC to an event type.
6696 EVENT-DESC should contain one base event type (a character or symbol)
6697 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6698 drag, down, double or triple). The base must be last.
6699 The return value is an event type (a character or symbol) which
6700 has the same base event type and all the specified modifiers. */)
6702 Lisp_Object event_desc
;
6710 while (CONSP (rest
))
6718 /* Given a symbol, see if it is a modifier name. */
6719 if (SYMBOLP (elt
) && CONSP (rest
))
6720 this = parse_solitary_modifier (elt
);
6724 else if (!NILP (base
))
6725 error ("Two bases given in one event");
6731 /* Let the symbol A refer to the character A. */
6732 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6733 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6735 if (INTEGERP (base
))
6737 /* Turn (shift a) into A. */
6738 if ((modifiers
& shift_modifier
) != 0
6739 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6741 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6742 modifiers
&= ~shift_modifier
;
6745 /* Turn (control a) into C-a. */
6746 if (modifiers
& ctrl_modifier
)
6747 return make_number ((modifiers
& ~ctrl_modifier
)
6748 | make_ctrl_char (XINT (base
)));
6750 return make_number (modifiers
| XINT (base
));
6752 else if (SYMBOLP (base
))
6753 return apply_modifiers (modifiers
, base
);
6756 error ("Invalid base event");
6761 /* Try to recognize SYMBOL as a modifier name.
6762 Return the modifier flag bit, or 0 if not recognized. */
6765 parse_solitary_modifier (Lisp_Object symbol
)
6767 Lisp_Object name
= SYMBOL_NAME (symbol
);
6769 switch (SREF (name
, 0))
6771 #define SINGLE_LETTER_MOD(BIT) \
6772 if (SBYTES (name) == 1) \
6775 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6776 if (LEN == SBYTES (name) \
6777 && ! strncmp (SDATA (name), NAME, LEN)) \
6781 SINGLE_LETTER_MOD (alt_modifier
);
6785 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6789 SINGLE_LETTER_MOD (ctrl_modifier
);
6793 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6794 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6798 SINGLE_LETTER_MOD (hyper_modifier
);
6802 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6806 SINGLE_LETTER_MOD (meta_modifier
);
6810 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6814 SINGLE_LETTER_MOD (shift_modifier
);
6818 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6819 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6820 SINGLE_LETTER_MOD (super_modifier
);
6824 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6825 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6826 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6830 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6833 #undef SINGLE_LETTER_MOD
6834 #undef MULTI_LETTER_MOD
6840 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6841 Such a list is not valid as an event,
6842 but it can be a Lucid-style event type list. */
6845 lucid_event_type_list_p (object
)
6850 if (! CONSP (object
))
6853 if (EQ (XCAR (object
), Qhelp_echo
)
6854 || EQ (XCAR (object
), Qvertical_line
)
6855 || EQ (XCAR (object
), Qmode_line
)
6856 || EQ (XCAR (object
), Qheader_line
))
6859 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6863 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6870 /* Store into *addr a value nonzero if terminal input chars are available.
6871 Serves the purpose of ioctl (0, FIONREAD, addr)
6872 but works even if FIONREAD does not exist.
6873 (In fact, this may actually read some input.)
6875 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6876 timer events that are ripe.
6877 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6878 events (FOCUS_IN_EVENT).
6879 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6880 movements and toolkit scroll bar thumb drags. */
6883 get_input_pending (addr
, flags
)
6887 /* First of all, have we already counted some input? */
6888 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6890 /* If input is being read as it arrives, and we have none, there is none. */
6891 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6894 /* Try to read some input and see how much we get. */
6896 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6899 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6902 gobble_input (expected
)
6906 /* Check whether a D-Bus message has arrived. */
6907 xd_read_queued_messages ();
6908 #endif /* HAVE_DBUS */
6912 if (interrupt_input
)
6915 mask
= sigblock (sigmask (SIGIO
));
6916 read_avail_input (expected
);
6920 #ifdef POLL_FOR_INPUT
6921 /* XXX This condition was (read_socket_hook && !interrupt_input),
6922 but read_socket_hook is not global anymore. Let's pretend that
6924 if (!interrupt_input
&& poll_suppress_count
== 0)
6927 mask
= sigblock (sigmask (SIGALRM
));
6928 read_avail_input (expected
);
6934 read_avail_input (expected
);
6938 /* Put a BUFFER_SWITCH_EVENT in the buffer
6939 so that read_key_sequence will notice the new current buffer. */
6942 record_asynch_buffer_change ()
6944 struct input_event event
;
6948 event
.kind
= BUFFER_SWITCH_EVENT
;
6949 event
.frame_or_window
= Qnil
;
6953 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6954 The purpose of the event is to make read_key_sequence look up the
6955 keymaps again. If we aren't in read_key_sequence, we don't need one,
6956 and the event could cause trouble by messing up (input-pending-p). */
6957 tem
= Fwaiting_for_user_input_p ();
6961 /* We never need these events if we have no asynchronous subprocesses. */
6965 /* Make sure no interrupt happens while storing the event. */
6967 if (interrupt_input
)
6970 mask
= sigblock (sigmask (SIGIO
));
6971 kbd_buffer_store_event (&event
);
6978 kbd_buffer_store_event (&event
);
6985 /* Read any terminal input already buffered up by the system
6986 into the kbd_buffer, but do not wait.
6988 EXPECTED should be nonzero if the caller knows there is some input.
6990 Except on VMS, all input is read by this function.
6991 If interrupt_input is nonzero, this function MUST be called
6992 only when SIGIO is blocked.
6994 Returns the number of keyboard chars read, or -1 meaning
6995 this is a bad time to try to read input. */
6998 read_avail_input (expected
)
7005 /* Store pending user signal events, if any. */
7006 if (store_user_signal_events ())
7009 /* Loop through the available terminals, and call their input hooks. */
7013 struct terminal
*next
= t
->next_terminal
;
7015 if (t
->read_socket_hook
)
7018 struct input_event hold_quit
;
7020 EVENT_INIT (hold_quit
);
7021 hold_quit
.kind
= NO_EVENT
;
7023 /* No need for FIONREAD or fcntl; just say don't wait. */
7024 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
7030 if (nr
== -1) /* Not OK to read input now. */
7034 else if (nr
== -2) /* Non-transient error. */
7036 /* The terminal device terminated; it should be closed. */
7038 /* Kill Emacs if this was our last terminal. */
7039 if (!terminal_list
->next_terminal
)
7040 /* Formerly simply reported no input, but that
7041 sometimes led to a failure of Emacs to terminate.
7042 SIGHUP seems appropriate if we can't reach the
7044 /* ??? Is it really right to send the signal just to
7045 this process rather than to the whole process
7046 group? Perhaps on systems with FIONREAD Emacs is
7047 alone in its group. */
7048 kill (getpid (), SIGHUP
);
7050 /* XXX Is calling delete_terminal safe here? It calls Fdelete_frame. */
7053 XSETTERMINAL (tmp
, t
);
7054 Fdelete_terminal (tmp
, Qnoelisp
);
7058 if (hold_quit
.kind
!= NO_EVENT
)
7059 kbd_buffer_store_event (&hold_quit
);
7071 /* This is the tty way of reading available input.
7073 Note that each terminal device has its own `struct terminal' object,
7074 and so this function is called once for each individual termcap
7075 terminal. The first parameter indicates which terminal to read from. */
7078 tty_read_avail_input (struct terminal
*terminal
,
7080 struct input_event
*hold_quit
)
7082 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7083 the kbd_buffer can really hold. That may prevent loss
7084 of characters on some systems when input is stuffed at us. */
7085 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7087 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7090 if (!terminal
->name
) /* Don't read from a dead terminal. */
7093 if (terminal
->type
!= output_termcap
)
7096 /* XXX I think the following code should be moved to separate hook
7097 functions in system-dependent files. */
7100 #else /* not WINDOWSNT */
7102 n_to_read
= dos_keysns ();
7106 cbuf
[0] = dos_keyread ();
7109 #else /* not MSDOS */
7111 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7115 return 0; /* The terminal is suspended. */
7121 struct input_event hold_quit
;
7124 EVENT_INIT (hold_quit
);
7125 hold_quit
.kind
= NO_EVENT
;
7127 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7128 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7130 if (hold_quit
.kind
!= NO_EVENT
)
7131 kbd_buffer_store_event (&hold_quit
);
7135 #endif /* HAVE_GPM */
7137 /* Determine how many characters we should *try* to read. */
7139 /* Find out how much input is available. */
7140 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7142 if (! noninteractive
)
7143 return -2; /* Close this terminal. */
7149 if (n_to_read
> sizeof cbuf
)
7150 n_to_read
= sizeof cbuf
;
7151 #else /* no FIONREAD */
7152 #if defined (USG) || defined(CYGWIN)
7153 /* Read some input if available, but don't wait. */
7154 n_to_read
= sizeof cbuf
;
7155 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7161 /* Now read; for one reason or another, this will not block.
7162 NREAD is set to the number of chars read. */
7165 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7166 /* POSIX infers that processes which are not in the session leader's
7167 process group won't get SIGHUP's at logout time. BSDI adheres to
7168 this part standard and returns -1 from read (0) with errno==EIO
7169 when the control tty is taken away.
7170 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7171 if (nread
== -1 && errno
== EIO
)
7172 return -2; /* Close this terminal. */
7173 #if defined (AIX) && defined (_BSD)
7174 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7175 This looks incorrect, but it isn't, because _BSD causes
7176 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7177 and that causes a value other than 0 when there is no input. */
7179 return -2; /* Close this terminal. */
7183 /* We used to retry the read if it was interrupted.
7184 But this does the wrong thing when O_NDELAY causes
7185 an EAGAIN error. Does anybody know of a situation
7186 where a retry is actually needed? */
7188 nread
< 0 && (errno
== EAGAIN
7202 #if defined (USG) || defined (CYGWIN)
7203 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7204 #endif /* USG or CYGWIN */
7205 #endif /* no FIONREAD */
7210 #endif /* not MSDOS */
7211 #endif /* not WINDOWSNT */
7213 for (i
= 0; i
< nread
; i
++)
7215 struct input_event buf
;
7217 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7219 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7220 buf
.modifiers
= meta_modifier
;
7221 if (tty
->meta_key
!= 2)
7225 /* Set the frame corresponding to the active tty. Note that the
7226 value of selected_frame is not reliable here, redisplay tends
7227 to temporarily change it. */
7228 buf
.frame_or_window
= tty
->top_frame
;
7231 kbd_buffer_store_event (&buf
);
7232 /* Don't look at input that follows a C-g too closely.
7233 This reduces lossage due to autorepeat on C-g. */
7234 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7235 && buf
.code
== quit_char
)
7241 #endif /* not VMS */
7244 handle_async_input ()
7246 interrupt_input_pending
= 0;
7251 nread
= read_avail_input (1);
7252 /* -1 means it's not ok to read the input now.
7253 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7254 0 means there was no keyboard input available. */
7260 #ifdef SIGIO /* for entire page */
7261 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7264 input_available_signal (signo
)
7267 /* Must preserve main program's value of errno. */
7268 int old_errno
= errno
;
7269 #if defined (USG) && !defined (POSIX_SIGNALS)
7270 /* USG systems forget handlers when they are used;
7271 must reestablish each time */
7272 signal (signo
, input_available_signal
);
7276 interrupt_input_pending
= 1;
7278 SIGNAL_THREAD_CHECK (signo
);
7281 if (input_available_clear_time
)
7282 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7285 handle_async_input ();
7292 /* Send ourselves a SIGIO.
7294 This function exists so that the UNBLOCK_INPUT macro in
7295 blockinput.h can have some way to take care of input we put off
7296 dealing with, without assuming that every file which uses
7297 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7299 reinvoke_input_signal ()
7302 handle_async_input ();
7308 /* User signal events. */
7310 struct user_signal_info
7312 /* Signal number. */
7315 /* Name of the signal. */
7318 /* Number of pending signals. */
7321 struct user_signal_info
*next
;
7324 /* List of user signals. */
7325 static struct user_signal_info
*user_signals
= NULL
;
7328 add_user_signal (sig
, name
)
7332 struct user_signal_info
*p
;
7334 for (p
= user_signals
; p
; p
= p
->next
)
7336 /* Already added. */
7339 p
= xmalloc (sizeof (struct user_signal_info
));
7341 p
->name
= xstrdup (name
);
7343 p
->next
= user_signals
;
7346 signal (sig
, handle_user_signal
);
7350 handle_user_signal (sig
)
7353 int old_errno
= errno
;
7354 struct user_signal_info
*p
;
7356 #if defined (USG) && !defined (POSIX_SIGNALS)
7357 /* USG systems forget handlers when they are used;
7358 must reestablish each time */
7359 signal (sig
, handle_user_signal
);
7362 SIGNAL_THREAD_CHECK (sig
);
7364 for (p
= user_signals
; p
; p
= p
->next
)
7369 if (interrupt_input
)
7370 kill (getpid (), SIGIO
);
7374 /* Tell wait_reading_process_output that it needs to wake
7375 up and look around. */
7376 if (input_available_clear_time
)
7377 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7386 find_user_signal_name (sig
)
7389 struct user_signal_info
*p
;
7391 for (p
= user_signals
; p
; p
= p
->next
)
7399 store_user_signal_events ()
7401 struct user_signal_info
*p
;
7402 struct input_event buf
;
7405 for (p
= user_signals
; p
; p
= p
->next
)
7406 if (p
->npending
> 0)
7412 bzero (&buf
, sizeof buf
);
7413 buf
.kind
= USER_SIGNAL_EVENT
;
7414 buf
.frame_or_window
= selected_frame
;
7416 nstored
+= p
->npending
;
7418 mask
= sigblock (sigmask (p
->sig
));
7422 kbd_buffer_store_event (&buf
);
7425 while (p
->npending
> 0);
7433 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7434 static Lisp_Object menu_bar_one_keymap_changed_items
;
7436 /* These variables hold the vector under construction within
7437 menu_bar_items and its subroutines, and the current index
7438 for storing into that vector. */
7439 static Lisp_Object menu_bar_items_vector
;
7440 static int menu_bar_items_index
;
7442 /* Return a vector of menu items for a menu bar, appropriate
7443 to the current buffer. Each item has three elements in the vector:
7446 OLD is an old vector we can optionally reuse, or nil. */
7449 menu_bar_items (old
)
7452 /* The number of keymaps we're scanning right now, and the number of
7453 keymaps we have allocated space for. */
7456 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7457 in the current keymaps, or nil where it is not a prefix. */
7460 Lisp_Object def
, tail
;
7469 /* In order to build the menus, we need to call the keymap
7470 accessors. They all call QUIT. But this function is called
7471 during redisplay, during which a quit is fatal. So inhibit
7472 quitting while building the menus.
7473 We do this instead of specbind because (1) errors will clear it anyway
7474 and (2) this avoids risk of specpdl overflow. */
7475 oquit
= Vinhibit_quit
;
7479 menu_bar_items_vector
= old
;
7481 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7482 menu_bar_items_index
= 0;
7484 /* Build our list of keymaps.
7485 If we recognize a function key and replace its escape sequence in
7486 keybuf with its symbol, or if the sequence starts with a mouse
7487 click and we need to switch buffers, we jump back here to rebuild
7488 the initial keymaps from the current buffer. */
7492 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7493 if (!NILP (Voverriding_local_map_menu_flag
))
7495 /* Yes, use them (if non-nil) as well as the global map. */
7496 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7498 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7499 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7500 if (!NILP (Voverriding_local_map
))
7501 maps
[nmaps
++] = Voverriding_local_map
;
7505 /* No, so use major and minor mode keymaps and keymap property.
7506 Note that menu-bar bindings in the local-map and keymap
7507 properties may not work reliable, as they are only
7508 recognized when the menu-bar (or mode-line) is updated,
7509 which does not normally happen after every command. */
7512 nminor
= current_minor_maps (NULL
, &tmaps
);
7513 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7515 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7516 maps
[nmaps
++] = tem
;
7517 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7519 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7521 maps
[nmaps
++] = current_global_map
;
7524 /* Look up in each map the dummy prefix key `menu-bar'. */
7528 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7529 if (!NILP (maps
[mapno
]))
7531 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7535 menu_bar_one_keymap_changed_items
= Qnil
;
7536 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7540 /* Move to the end those items that should be at the end. */
7542 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7545 int end
= menu_bar_items_index
;
7547 for (i
= 0; i
< end
; i
+= 4)
7548 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7550 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7551 /* Move the item at index I to the end,
7552 shifting all the others forward. */
7553 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7554 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7555 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7556 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7558 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7559 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7560 (end
- i
- 4) * sizeof (Lisp_Object
));
7561 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7562 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7563 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7564 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7569 /* Add nil, nil, nil, nil at the end. */
7570 i
= menu_bar_items_index
;
7571 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7572 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7573 /* Add this item. */
7574 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7575 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7576 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7577 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7578 menu_bar_items_index
= i
;
7580 Vinhibit_quit
= oquit
;
7581 return menu_bar_items_vector
;
7584 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7585 If there's already an item for KEY, add this DEF to it. */
7587 Lisp_Object item_properties
;
7590 menu_bar_item (key
, item
, dummy1
, dummy2
)
7591 Lisp_Object key
, item
, dummy1
;
7594 struct gcpro gcpro1
;
7598 if (EQ (item
, Qundefined
))
7600 /* If a map has an explicit `undefined' as definition,
7601 discard any previously made menu bar item. */
7603 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7604 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7606 if (menu_bar_items_index
> i
+ 4)
7607 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7608 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7609 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7610 menu_bar_items_index
-= 4;
7614 /* If this keymap has already contributed to this KEY,
7615 don't contribute to it a second time. */
7616 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7617 if (!NILP (tem
) || NILP (item
))
7620 menu_bar_one_keymap_changed_items
7621 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7623 /* We add to menu_bar_one_keymap_changed_items before doing the
7624 parse_menu_item, so that if it turns out it wasn't a menu item,
7625 it still correctly hides any further menu item. */
7627 i
= parse_menu_item (item
, 0, 1);
7632 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7634 /* Find any existing item for this KEY. */
7635 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7636 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7639 /* If we did not find this KEY, add it at the end. */
7640 if (i
== menu_bar_items_index
)
7642 /* If vector is too small, get a bigger one. */
7643 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7644 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7645 /* Add this item. */
7646 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7647 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7648 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7649 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7650 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7651 menu_bar_items_index
= i
;
7653 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7657 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7658 /* If the new and the old items are not both keymaps,
7659 the lookup will only find `item'. */
7660 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7661 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7665 /* This is used as the handler when calling menu_item_eval_property. */
7667 menu_item_eval_property_1 (arg
)
7670 /* If we got a quit from within the menu computation,
7671 quit all the way out of it. This takes care of C-] in the debugger. */
7672 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7673 Fsignal (Qquit
, Qnil
);
7678 /* Evaluate an expression and return the result (or nil if something
7679 went wrong). Used to evaluate dynamic parts of menu items. */
7681 menu_item_eval_property (sexpr
)
7684 int count
= SPECPDL_INDEX ();
7686 specbind (Qinhibit_redisplay
, Qt
);
7687 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7688 menu_item_eval_property_1
);
7689 return unbind_to (count
, val
);
7692 /* This function parses a menu item and leaves the result in the
7693 vector item_properties.
7694 ITEM is a key binding, a possible menu item.
7695 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7696 evaluate dynamic expressions in the menu item.
7697 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7699 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7700 parse_menu_item returns true if the item is a menu item and false
7704 parse_menu_item (item
, notreal
, inmenubar
)
7706 int notreal
, inmenubar
;
7708 Lisp_Object def
, tem
, item_string
, start
;
7709 Lisp_Object cachelist
;
7711 Lisp_Object keyhint
;
7722 /* Create item_properties vector if necessary. */
7723 if (NILP (item_properties
))
7725 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7727 /* Initialize optional entries. */
7728 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7729 ASET (item_properties
, i
, Qnil
);
7730 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7732 /* Save the item here to protect it from GC. */
7733 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7735 item_string
= XCAR (item
);
7739 if (STRINGP (item_string
))
7741 /* Old format menu item. */
7742 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7744 /* Maybe help string. */
7745 if (CONSP (item
) && STRINGP (XCAR (item
)))
7747 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7752 /* Maybe key binding cache. */
7753 if (CONSP (item
) && CONSP (XCAR (item
))
7754 && (NILP (XCAR (XCAR (item
)))
7755 || VECTORP (XCAR (XCAR (item
)))))
7757 cachelist
= XCAR (item
);
7761 /* This is the real definition--the function to run. */
7762 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7764 /* Get enable property, if any. */
7767 tem
= Fget (item
, Qmenu_enable
);
7768 if (!NILP (Venable_disabled_menus_and_buttons
))
7769 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7770 else if (!NILP (tem
))
7771 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7774 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7776 /* New format menu item. */
7777 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7778 start
= XCDR (item
);
7781 /* We have a real binding. */
7782 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7784 item
= XCDR (start
);
7785 /* Is there a cache list with key equivalences. */
7786 if (CONSP (item
) && CONSP (XCAR (item
)))
7788 cachelist
= XCAR (item
);
7792 /* Parse properties. */
7793 while (CONSP (item
) && CONSP (XCDR (item
)))
7798 if (EQ (tem
, QCenable
))
7800 if (!NILP (Venable_disabled_menus_and_buttons
))
7801 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7803 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7805 else if (EQ (tem
, QCvisible
) && !notreal
)
7807 /* If got a visible property and that evaluates to nil
7808 then ignore this item. */
7809 tem
= menu_item_eval_property (XCAR (item
));
7813 else if (EQ (tem
, QChelp
))
7814 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7815 else if (EQ (tem
, QCfilter
))
7817 else if (EQ (tem
, QCkey_sequence
))
7820 if (NILP (cachelist
)
7821 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7822 /* Be GC protected. Set keyhint to item instead of tem. */
7825 else if (EQ (tem
, QCkeys
))
7828 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7829 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7831 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7836 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7838 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7840 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7846 else if (inmenubar
|| !NILP (start
))
7850 return 0; /* not a menu item */
7852 /* If item string is not a string, evaluate it to get string.
7853 If we don't get a string, skip this item. */
7854 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7855 if (!(STRINGP (item_string
) || notreal
))
7857 item_string
= menu_item_eval_property (item_string
);
7858 if (!STRINGP (item_string
))
7860 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7863 /* If got a filter apply it on definition. */
7864 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7867 def
= menu_item_eval_property (list2 (XCAR (filter
),
7868 list2 (Qquote
, def
)));
7870 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7873 /* Enable or disable selection of item. */
7874 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7880 tem
= menu_item_eval_property (tem
);
7881 if (inmenubar
&& NILP (tem
))
7882 return 0; /* Ignore disabled items in menu bar. */
7883 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7886 /* If we got no definition, this item is just unselectable text which
7887 is OK in a submenu but not in the menubar. */
7889 return (inmenubar
? 0 : 1);
7891 /* See if this is a separate pane or a submenu. */
7892 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7893 tem
= get_keymap (def
, 0, 1);
7894 /* For a subkeymap, just record its details and exit. */
7897 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7898 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7902 /* At the top level in the menu bar, do likewise for commands also.
7903 The menu bar does not display equivalent key bindings anyway.
7904 ITEM_PROPERTY_DEF is already set up properly. */
7908 /* This is a command. See if there is an equivalent key binding. */
7909 if (NILP (cachelist
))
7911 /* We have to create a cachelist. */
7912 /* With the introduction of where_is_cache, the computation
7913 of equivalent key bindings is sufficiently fast that we
7914 do not need to cache it here any more. */
7915 /* CHECK_IMPURE (start);
7916 XSETCDR (start, Fcons (Fcons (Qnil, Qnil), XCDR (start)));
7917 cachelist = XCAR (XCDR (start)); */
7918 cachelist
= Fcons (Qnil
, Qnil
);
7920 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7921 if (!NILP (keyhint
))
7923 XSETCAR (cachelist
, XCAR (keyhint
));
7926 else if (STRINGP (tem
))
7928 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7929 XSETCAR (cachelist
, Qt
);
7933 tem
= XCAR (cachelist
);
7940 tem
= Fkey_binding (tem
, Qnil
, Qnil
, Qnil
);
7942 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7945 def
= XCAR (prefix
);
7946 prefix
= XCDR (prefix
);
7949 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7951 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7953 if (newcache
/* Always check first time. */
7954 /* Should we check everything when precomputing key
7956 /* If something had no key binding before, don't recheck it
7957 because that is too slow--except if we have a list of
7958 rebound commands in Vdefine_key_rebound_commands, do
7959 recheck any command that appears in that list. */
7960 || (CONSP (Vdefine_key_rebound_commands
)
7961 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7964 /* We had a saved key. Is it still bound to the command? */
7967 /* If the command is an alias for another
7968 (such as lmenu.el set it up), check if the
7969 original command matches the cached command. */
7970 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7971 chkcache
= 1; /* Need to recompute key binding. */
7975 /* Recompute equivalent key binding. If the command is an alias
7976 for another (such as lmenu.el set it up), see if the original
7977 command name has equivalent keys. Otherwise look up the
7978 specified command itself. We don't try both, because that
7979 makes lmenu menus slow. */
7981 && SYMBOLP (XSYMBOL (def
)->function
)
7982 && ! NILP (Fget (def
, Qmenu_alias
)))
7983 def
= XSYMBOL (def
)->function
;
7984 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7985 XSETCAR (cachelist
, tem
);
7988 XSETCDR (cachelist
, Qnil
);
7992 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7994 tem
= XCAR (cachelist
);
7998 newcache
= chkcache
;
8001 tem
= Fkey_description (tem
, Qnil
);
8004 if (STRINGP (XCAR (prefix
)))
8005 tem
= concat2 (XCAR (prefix
), tem
);
8006 if (STRINGP (XCDR (prefix
)))
8007 tem
= concat2 (tem
, XCDR (prefix
));
8009 XSETCDR (cachelist
, tem
);
8013 tem
= XCDR (cachelist
);
8014 if (newcache
&& !NILP (tem
))
8016 tem
= concat2 (build_string (" "), tem
);
8017 /* tem = concat3 (build_string (" ("), tem, build_string (")")); */
8018 XSETCDR (cachelist
, tem
);
8021 /* If we only want to precompute equivalent key bindings, stop here. */
8025 /* If we have an equivalent key binding, use that. */
8026 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
8028 /* Include this when menu help is implemented.
8029 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
8030 if (!(NILP (tem) || STRINGP (tem)))
8032 tem = menu_item_eval_property (tem);
8035 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8039 /* Handle radio buttons or toggle boxes. */
8040 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8042 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8043 menu_item_eval_property (tem
));
8050 /***********************************************************************
8052 ***********************************************************************/
8054 /* A vector holding tool bar items while they are parsed in function
8055 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8058 static Lisp_Object tool_bar_items_vector
;
8060 /* A vector holding the result of parse_tool_bar_item. Layout is like
8061 the one for a single item in tool_bar_items_vector. */
8063 static Lisp_Object tool_bar_item_properties
;
8065 /* Next free index in tool_bar_items_vector. */
8067 static int ntool_bar_items
;
8069 /* The symbols `tool-bar', `:image' and `:rtl'. */
8071 extern Lisp_Object Qtool_bar
;
8072 Lisp_Object QCimage
;
8075 /* Function prototypes. */
8077 static void init_tool_bar_items
P_ ((Lisp_Object
));
8078 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
8079 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
8080 static void append_tool_bar_item
P_ ((void));
8083 /* Return a vector of tool bar items for keymaps currently in effect.
8084 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8085 tool bar items found. */
8088 tool_bar_items (reuse
, nitems
)
8099 /* In order to build the menus, we need to call the keymap
8100 accessors. They all call QUIT. But this function is called
8101 during redisplay, during which a quit is fatal. So inhibit
8102 quitting while building the menus. We do this instead of
8103 specbind because (1) errors will clear it anyway and (2) this
8104 avoids risk of specpdl overflow. */
8105 oquit
= Vinhibit_quit
;
8108 /* Initialize tool_bar_items_vector and protect it from GC. */
8109 init_tool_bar_items (reuse
);
8111 /* Build list of keymaps in maps. Set nmaps to the number of maps
8114 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8115 if (!NILP (Voverriding_local_map_menu_flag
))
8117 /* Yes, use them (if non-nil) as well as the global map. */
8118 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8120 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8121 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8122 if (!NILP (Voverriding_local_map
))
8123 maps
[nmaps
++] = Voverriding_local_map
;
8127 /* No, so use major and minor mode keymaps and keymap property.
8128 Note that tool-bar bindings in the local-map and keymap
8129 properties may not work reliable, as they are only
8130 recognized when the tool-bar (or mode-line) is updated,
8131 which does not normally happen after every command. */
8134 nminor
= current_minor_maps (NULL
, &tmaps
);
8135 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8137 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8138 maps
[nmaps
++] = tem
;
8139 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
8141 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8144 /* Add global keymap at the end. */
8145 maps
[nmaps
++] = current_global_map
;
8147 /* Process maps in reverse order and look up in each map the prefix
8149 for (i
= nmaps
- 1; i
>= 0; --i
)
8150 if (!NILP (maps
[i
]))
8154 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8156 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8159 Vinhibit_quit
= oquit
;
8160 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8161 return tool_bar_items_vector
;
8165 /* Process the definition of KEY which is DEF. */
8168 process_tool_bar_item (key
, def
, data
, args
)
8169 Lisp_Object key
, def
, data
;
8173 extern Lisp_Object Qundefined
;
8174 struct gcpro gcpro1
, gcpro2
;
8176 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8180 if (EQ (def
, Qundefined
))
8182 /* If a map has an explicit `undefined' as definition,
8183 discard any previously made item. */
8184 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8186 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8188 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8190 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8191 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
8192 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8193 * sizeof (Lisp_Object
)));
8194 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8199 else if (parse_tool_bar_item (key
, def
))
8200 /* Append a new tool bar item to tool_bar_items_vector. Accept
8201 more than one definition for the same key. */
8202 append_tool_bar_item ();
8208 /* Parse a tool bar item specification ITEM for key KEY and return the
8209 result in tool_bar_item_properties. Value is zero if ITEM is
8212 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8214 CAPTION is the caption of the item, If it's not a string, it is
8215 evaluated to get a string.
8217 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8218 as binding are currently ignored.
8220 The following properties are recognized:
8224 FORM is evaluated and specifies whether the tool bar item is
8225 enabled or disabled.
8229 FORM is evaluated and specifies whether the tool bar item is visible.
8231 - `:filter FUNCTION'
8233 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8234 result is stored as the new binding.
8236 - `:button (TYPE SELECTED)'
8238 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8239 and specifies whether the button is selected (pressed) or not.
8243 IMAGES is either a single image specification or a vector of four
8244 image specifications. See enum tool_bar_item_images.
8246 - `:help HELP-STRING'.
8248 Gives a help string to display for the tool bar item. */
8251 parse_tool_bar_item (key
, item
)
8252 Lisp_Object key
, item
;
8254 /* Access slot with index IDX of vector tool_bar_item_properties. */
8255 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8257 Lisp_Object filter
= Qnil
;
8258 Lisp_Object caption
;
8261 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8262 Rule out items that aren't lists, don't start with
8263 `menu-item' or whose rest following `tool-bar-item' is not a
8266 || !EQ (XCAR (item
), Qmenu_item
)
8267 || (item
= XCDR (item
),
8271 /* Create tool_bar_item_properties vector if necessary. Reset it to
8273 if (VECTORP (tool_bar_item_properties
))
8275 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8279 tool_bar_item_properties
8280 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8283 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8284 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8286 /* Get the caption of the item. If the caption is not a string,
8287 evaluate it to get a string. If we don't get a string, skip this
8289 caption
= XCAR (item
);
8290 if (!STRINGP (caption
))
8292 caption
= menu_item_eval_property (caption
);
8293 if (!STRINGP (caption
))
8296 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8298 /* Give up if rest following the caption is not a list. */
8303 /* Store the binding. */
8304 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8307 /* Ignore cached key binding, if any. */
8308 if (CONSP (item
) && CONSP (XCAR (item
)))
8311 /* Process the rest of the properties. */
8312 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8314 Lisp_Object key
, value
;
8317 value
= XCAR (XCDR (item
));
8319 if (EQ (key
, QCenable
))
8321 /* `:enable FORM'. */
8322 if (!NILP (Venable_disabled_menus_and_buttons
))
8323 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8325 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8327 else if (EQ (key
, QCvisible
))
8329 /* `:visible FORM'. If got a visible property and that
8330 evaluates to nil then ignore this item. */
8331 if (NILP (menu_item_eval_property (value
)))
8334 else if (EQ (key
, QChelp
))
8335 /* `:help HELP-STRING'. */
8336 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8337 else if (EQ (key
, QCfilter
))
8338 /* ':filter FORM'. */
8340 else if (EQ (key
, QCbutton
) && CONSP (value
))
8342 /* `:button (TYPE . SELECTED)'. */
8343 Lisp_Object type
, selected
;
8345 type
= XCAR (value
);
8346 selected
= XCDR (value
);
8347 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8349 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8350 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8353 else if (EQ (key
, QCimage
)
8355 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8356 /* Value is either a single image specification or a vector
8357 of 4 such specifications for the different button states. */
8358 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8359 else if (EQ (key
, Qrtl
))
8361 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8364 /* If got a filter apply it on binding. */
8366 PROP (TOOL_BAR_ITEM_BINDING
)
8367 = menu_item_eval_property (list2 (filter
,
8369 PROP (TOOL_BAR_ITEM_BINDING
))));
8371 /* See if the binding is a keymap. Give up if it is. */
8372 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8375 /* Enable or disable selection of item. */
8376 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8377 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8378 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8380 /* Handle radio buttons or toggle boxes. */
8381 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8382 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8383 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8391 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8392 that can be reused. */
8395 init_tool_bar_items (reuse
)
8398 if (VECTORP (reuse
))
8399 tool_bar_items_vector
= reuse
;
8401 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8402 ntool_bar_items
= 0;
8406 /* Append parsed tool bar item properties from
8407 tool_bar_item_properties */
8410 append_tool_bar_item ()
8412 Lisp_Object
*to
, *from
;
8414 /* Enlarge tool_bar_items_vector if necessary. */
8415 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8416 >= XVECTOR (tool_bar_items_vector
)->size
)
8417 tool_bar_items_vector
8418 = larger_vector (tool_bar_items_vector
,
8419 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8421 /* Append entries from tool_bar_item_properties to the end of
8422 tool_bar_items_vector. */
8423 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8424 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8425 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8426 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8433 /* Read a character using menus based on maps in the array MAPS.
8434 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8435 Return t if we displayed a menu but the user rejected it.
8437 PREV_EVENT is the previous input event, or nil if we are reading
8438 the first event of a key sequence.
8440 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8441 if we used a mouse menu to read the input, or zero otherwise. If
8442 USED_MOUSE_MENU is null, we don't dereference it.
8444 The prompting is done based on the prompt-string of the map
8445 and the strings associated with various map elements.
8447 This can be done with X menus or with menus put in the minibuf.
8448 These are done in different ways, depending on how the input will be read.
8449 Menus using X are done after auto-saving in read-char, getting the input
8450 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8451 and do auto-saving in the inner call of read_char. */
8454 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8457 Lisp_Object prev_event
;
8458 int *used_mouse_menu
;
8461 register Lisp_Object name
= Qnil
;
8463 if (used_mouse_menu
)
8464 *used_mouse_menu
= 0;
8466 /* Use local over global Menu maps */
8468 if (! menu_prompting
)
8471 /* Optionally disregard all but the global map. */
8472 if (inhibit_local_menu_bar_menus
)
8474 maps
+= (nmaps
- 1);
8478 /* Get the menu name from the first map that has one (a prompt string). */
8479 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8481 name
= Fkeymap_prompt (maps
[mapno
]);
8486 /* If we don't have any menus, just read a character normally. */
8487 if (!STRINGP (name
))
8491 /* If we got to this point via a mouse click,
8492 use a real menu for mouse selection. */
8493 if (EVENT_HAS_PARAMETERS (prev_event
)
8494 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8495 && !EQ (XCAR (prev_event
), Qtool_bar
))
8497 /* Display the menu and get the selection. */
8498 Lisp_Object
*realmaps
8499 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8503 /* Use the maps that are not nil. */
8504 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8505 if (!NILP (maps
[mapno
]))
8506 realmaps
[nmaps1
++] = maps
[mapno
];
8508 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8513 record_menu_key (XCAR (value
));
8515 /* If we got multiple events, unread all but
8517 There is no way to prevent those unread events
8518 from showing up later in last_nonmenu_event.
8519 So turn symbol and integer events into lists,
8520 to indicate that they came from a mouse menu,
8521 so that when present in last_nonmenu_event
8522 they won't confuse things. */
8523 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8525 record_menu_key (XCAR (tem
));
8526 if (SYMBOLP (XCAR (tem
))
8527 || INTEGERP (XCAR (tem
)))
8528 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8531 /* If we got more than one event, put all but the first
8532 onto this list to be read later.
8533 Return just the first event now. */
8534 Vunread_command_events
8535 = nconc2 (XCDR (value
), Vunread_command_events
);
8536 value
= XCAR (value
);
8538 else if (NILP (value
))
8540 if (used_mouse_menu
)
8541 *used_mouse_menu
= 1;
8544 #endif /* HAVE_MENUS */
8548 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8549 We make this bigger when necessary, and never free it. */
8550 static char *read_char_minibuf_menu_text
;
8551 /* Size of that buffer. */
8552 static int read_char_minibuf_menu_width
;
8555 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8561 register Lisp_Object name
;
8563 /* FIXME: Use the minibuffer's frame width. */
8564 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8567 Lisp_Object rest
, vector
;
8573 if (! menu_prompting
)
8576 /* Make sure we have a big enough buffer for the menu text. */
8577 if (read_char_minibuf_menu_text
== 0)
8579 read_char_minibuf_menu_width
= width
+ 4;
8580 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8582 else if (width
+ 4 > read_char_minibuf_menu_width
)
8584 read_char_minibuf_menu_width
= width
+ 4;
8585 read_char_minibuf_menu_text
8586 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8588 menu
= read_char_minibuf_menu_text
;
8590 /* Get the menu name from the first map that has one (a prompt string). */
8591 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8593 name
= Fkeymap_prompt (maps
[mapno
]);
8598 /* If we don't have any menus, just read a character normally. */
8599 if (!STRINGP (name
))
8602 /* Prompt string always starts with map's prompt, and a space. */
8603 strcpy (menu
, SDATA (name
));
8604 nlength
= SBYTES (name
);
8605 menu
[nlength
++] = ':';
8606 menu
[nlength
++] = ' ';
8609 /* Start prompting at start of first map. */
8613 /* Present the documented bindings, a line at a time. */
8620 Lisp_Object orig_defn_macro
;
8622 /* Loop over elements of map. */
8627 /* If reached end of map, start at beginning of next map. */
8631 /* At end of last map, wrap around to first map if just starting,
8632 or end this line if already have something on it. */
8636 if (notfirst
|| nobindings
) break;
8641 /* Look at the next element of the map. */
8643 elt
= XVECTOR (vector
)->contents
[idx
];
8645 elt
= Fcar_safe (rest
);
8647 if (idx
< 0 && VECTORP (elt
))
8649 /* If we found a dense table in the keymap,
8650 advanced past it, but start scanning its contents. */
8651 rest
= Fcdr_safe (rest
);
8657 /* An ordinary element. */
8658 Lisp_Object event
, tem
;
8662 event
= Fcar_safe (elt
); /* alist */
8663 elt
= Fcdr_safe (elt
);
8667 XSETINT (event
, idx
); /* vector */
8670 /* Ignore the element if it has no prompt string. */
8671 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8673 /* 1 if the char to type matches the string. */
8675 Lisp_Object upcased_event
, downcased_event
;
8676 Lisp_Object desc
= Qnil
;
8678 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8680 upcased_event
= Fupcase (event
);
8681 downcased_event
= Fdowncase (event
);
8682 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8683 || XINT (downcased_event
) == SREF (s
, 0));
8685 desc
= Fsingle_key_description (event
, Qnil
);
8687 #if 0 /* It is redundant to list the equivalent key bindings because
8688 the prefix is what the user has already typed. */
8690 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8692 /* Insert equivalent keybinding. */
8693 s
= concat2 (s
, tem
);
8696 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8697 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8699 /* Insert button prefix. */
8700 Lisp_Object selected
8701 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8702 if (EQ (tem
, QCradio
))
8703 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8705 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8706 s
= concat2 (tem
, s
);
8710 /* If we have room for the prompt string, add it to this line.
8711 If this is the first on the line, always add it. */
8712 if ((SCHARS (s
) + i
+ 2
8713 + (char_matches
? 0 : SCHARS (desc
) + 3))
8719 /* Punctuate between strings. */
8722 strcpy (menu
+ i
, ", ");
8728 /* If the char to type doesn't match the string's
8729 first char, explicitly show what char to type. */
8732 /* Add as much of string as fits. */
8733 thiswidth
= SCHARS (desc
);
8734 if (thiswidth
+ i
> width
)
8735 thiswidth
= width
- i
;
8736 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8738 strcpy (menu
+ i
, " = ");
8742 /* Add as much of string as fits. */
8743 thiswidth
= SCHARS (s
);
8744 if (thiswidth
+ i
> width
)
8745 thiswidth
= width
- i
;
8746 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8752 /* If this element does not fit, end the line now,
8753 and save the element for the next line. */
8754 strcpy (menu
+ i
, "...");
8759 /* Move past this element. */
8760 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8761 /* Handle reaching end of dense table. */
8766 rest
= Fcdr_safe (rest
);
8770 /* Prompt with that and read response. */
8771 message2_nolog (menu
, strlen (menu
),
8772 ! NILP (current_buffer
->enable_multibyte_characters
));
8774 /* Make believe its not a keyboard macro in case the help char
8775 is pressed. Help characters are not recorded because menu prompting
8776 is not used on replay.
8778 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8779 current_kboard
->defining_kbd_macro
= Qnil
;
8781 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8782 while (BUFFERP (obj
));
8783 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8785 if (!INTEGERP (obj
))
8787 else if (XINT (obj
) == -2)
8792 if (! EQ (obj
, menu_prompt_more_char
)
8793 && (!INTEGERP (menu_prompt_more_char
)
8794 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8796 if (!NILP (current_kboard
->defining_kbd_macro
))
8797 store_kbd_macro_char (obj
);
8800 /* Help char - go round again */
8804 /* Reading key sequences. */
8806 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8807 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8808 keymap, or nil otherwise. Return the index of the first keymap in
8809 which KEY has any binding, or NMAPS if no map has a binding.
8811 If KEY is a meta ASCII character, treat it like meta-prefix-char
8812 followed by the corresponding non-meta character. Keymaps in
8813 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8816 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8819 NEXT may be the same array as CURRENT. */
8822 follow_key (key
, nmaps
, current
, defs
, next
)
8824 Lisp_Object
*current
, *defs
, *next
;
8827 int i
, first_binding
;
8829 first_binding
= nmaps
;
8830 for (i
= nmaps
- 1; i
>= 0; i
--)
8832 if (! NILP (current
[i
]))
8834 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8835 if (! NILP (defs
[i
]))
8842 /* Given the set of bindings we've found, produce the next set of maps. */
8843 if (first_binding
< nmaps
)
8844 for (i
= 0; i
< nmaps
; i
++)
8845 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8847 return first_binding
;
8850 /* Structure used to keep track of partial application of key remapping
8851 such as Vfunction_key_map and Vkey_translation_map. */
8852 typedef struct keyremap
8854 /* This is the map originally specified for this use. */
8856 /* This is a submap reached by looking up, in PARENT,
8857 the events from START to END. */
8859 /* Positions [START, END) in the key sequence buffer
8860 are the key that we have scanned so far.
8861 Those events are the ones that we will replace
8862 if PAREHT maps them into a key sequence. */
8866 /* Lookup KEY in MAP.
8867 MAP is a keymap mapping keys to key vectors or functions.
8868 If the mapping is a function and DO_FUNCTION is non-zero, then
8869 the function is called with PROMPT as parameter and its return
8870 value is used as the return value of this function (after checking
8871 that it is indeed a vector). */
8874 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8875 Lisp_Object map
, key
, prompt
;
8880 next
= access_keymap (map
, key
, 1, 0, 1);
8882 /* Handle symbol with autoload definition. */
8883 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8884 && CONSP (XSYMBOL (next
)->function
)
8885 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8886 do_autoload (XSYMBOL (next
)->function
, next
);
8888 /* Handle a symbol whose function definition is a keymap
8890 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8891 && (ARRAYP (XSYMBOL (next
)->function
)
8892 || KEYMAPP (XSYMBOL (next
)->function
)))
8893 next
= XSYMBOL (next
)->function
;
8895 /* If the keymap gives a function, not an
8896 array, then call the function with one arg and use
8897 its value instead. */
8898 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8903 next
= call1 (next
, prompt
);
8904 /* If the function returned something invalid,
8905 barf--don't ignore it.
8906 (To ignore it safely, we would need to gcpro a bunch of
8907 other variables.) */
8908 if (! (VECTORP (next
) || STRINGP (next
)))
8909 error ("Function %s returns invalid key sequence", tem
);
8914 /* Do one step of the key remapping used for function-key-map and
8915 key-translation-map:
8916 KEYBUF is the buffer holding the input events.
8917 BUFSIZE is its maximum size.
8918 FKEY is a pointer to the keyremap structure to use.
8919 INPUT is the index of the last element in KEYBUF.
8920 DOIT if non-zero says that the remapping can actually take place.
8921 DIFF is used to return the number of keys added/removed by the remapping.
8922 PARENT is the root of the keymap.
8923 PROMPT is the prompt to use if the remapping happens through a function.
8924 The return value is non-zero if the remapping actually took place. */
8927 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8928 Lisp_Object
*keybuf
, prompt
;
8930 int input
, doit
, *diff
, bufsize
;
8932 Lisp_Object next
, key
;
8934 key
= keybuf
[fkey
->end
++];
8936 if (KEYMAPP (fkey
->parent
))
8937 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8941 /* If keybuf[fkey->start..fkey->end] is bound in the
8942 map and we're in a position to do the key remapping, replace it with
8943 the binding and restart with fkey->start at the end. */
8944 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8946 int len
= XFASTINT (Flength (next
));
8949 *diff
= len
- (fkey
->end
- fkey
->start
);
8951 if (input
+ *diff
>= bufsize
)
8952 error ("Key sequence too long");
8954 /* Shift the keys that follow fkey->end. */
8956 for (i
= fkey
->end
; i
< input
; i
++)
8957 keybuf
[i
+ *diff
] = keybuf
[i
];
8959 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8960 keybuf
[i
+ *diff
] = keybuf
[i
];
8961 /* Overwrite the old keys with the new ones. */
8962 for (i
= 0; i
< len
; i
++)
8963 keybuf
[fkey
->start
+ i
]
8964 = Faref (next
, make_number (i
));
8966 fkey
->start
= fkey
->end
+= *diff
;
8967 fkey
->map
= fkey
->parent
;
8972 fkey
->map
= get_keymap (next
, 0, 1);
8974 /* If we no longer have a bound suffix, try a new position for
8976 if (!CONSP (fkey
->map
))
8978 fkey
->end
= ++fkey
->start
;
8979 fkey
->map
= fkey
->parent
;
8984 /* Read a sequence of keys that ends with a non prefix character,
8985 storing it in KEYBUF, a buffer of size BUFSIZE.
8987 Return the length of the key sequence stored.
8988 Return -1 if the user rejected a command menu.
8990 Echo starting immediately unless `prompt' is 0.
8992 Where a key sequence ends depends on the currently active keymaps.
8993 These include any minor mode keymaps active in the current buffer,
8994 the current buffer's local map, and the global map.
8996 If a key sequence has no other bindings, we check Vfunction_key_map
8997 to see if some trailing subsequence might be the beginning of a
8998 function key's sequence. If so, we try to read the whole function
8999 key, and substitute its symbolic name into the key sequence.
9001 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9002 `double-' events into similar click events, if that would make them
9003 bound. We try to turn `triple-' events first into `double-' events,
9006 If we get a mouse click in a mode line, vertical divider, or other
9007 non-text area, we treat the click as if it were prefixed by the
9008 symbol denoting that area - `mode-line', `vertical-line', or
9011 If the sequence starts with a mouse click, we read the key sequence
9012 with respect to the buffer clicked on, not the current buffer.
9014 If the user switches frames in the midst of a key sequence, we put
9015 off the switch-frame event until later; the next call to
9016 read_char will return it.
9018 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9019 from the selected window's buffer. */
9022 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
9023 can_return_switch_frame
, fix_current_buffer
)
9024 Lisp_Object
*keybuf
;
9027 int dont_downcase_last
;
9028 int can_return_switch_frame
;
9029 int fix_current_buffer
;
9031 volatile Lisp_Object from_string
;
9032 volatile int count
= SPECPDL_INDEX ();
9034 /* How many keys there are in the current key sequence. */
9037 /* The length of the echo buffer when we started reading, and
9038 the length of this_command_keys when we started reading. */
9039 volatile int echo_start
;
9040 volatile int keys_start
;
9042 /* The number of keymaps we're scanning right now, and the number of
9043 keymaps we have allocated space for. */
9045 volatile int nmaps_allocated
= 0;
9047 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9048 the current keymaps. */
9049 Lisp_Object
*volatile defs
= NULL
;
9051 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9052 in the current keymaps, or nil where it is not a prefix. */
9053 Lisp_Object
*volatile submaps
= NULL
;
9055 /* The local map to start out with at start of key sequence. */
9056 volatile Lisp_Object orig_local_map
;
9058 /* The map from the `keymap' property to start out with at start of
9060 volatile Lisp_Object orig_keymap
;
9062 /* 1 if we have already considered switching to the local-map property
9063 of the place where a mouse click occurred. */
9064 volatile int localized_local_map
= 0;
9066 /* The index in submaps[] of the first keymap that has a binding for
9067 this key sequence. In other words, the lowest i such that
9068 submaps[i] is non-nil. */
9069 volatile int first_binding
;
9070 /* Index of the first key that has no binding.
9071 It is useless to try fkey.start larger than that. */
9072 volatile int first_unbound
;
9074 /* If t < mock_input, then KEYBUF[t] should be read as the next
9077 We use this to recover after recognizing a function key. Once we
9078 realize that a suffix of the current key sequence is actually a
9079 function key's escape sequence, we replace the suffix with the
9080 function key's binding from Vfunction_key_map. Now keybuf
9081 contains a new and different key sequence, so the echo area,
9082 this_command_keys, and the submaps and defs arrays are wrong. In
9083 this situation, we set mock_input to t, set t to 0, and jump to
9084 restart_sequence; the loop will read keys from keybuf up until
9085 mock_input, thus rebuilding the state; and then it will resume
9086 reading characters from the keyboard. */
9087 volatile int mock_input
= 0;
9089 /* If the sequence is unbound in submaps[], then
9090 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9091 and fkey.map is its binding.
9093 These might be > t, indicating that all function key scanning
9094 should hold off until t reaches them. We do this when we've just
9095 recognized a function key, to avoid searching for the function
9096 key's again in Vfunction_key_map. */
9097 volatile keyremap fkey
;
9099 /* Likewise, for key_translation_map and input-decode-map. */
9100 volatile keyremap keytran
, indec
;
9102 /* Non-zero if we are trying to map a key by changing an upper-case
9103 letter to lower case, or a shifted function key to an unshifted
9105 volatile int shift_translated
= 0;
9107 /* If we receive a `switch-frame' or `select-window' event in the middle of
9108 a key sequence, we put it off for later.
9109 While we're reading, we keep the event here. */
9110 volatile Lisp_Object delayed_switch_frame
;
9112 /* See the comment below... */
9113 #if defined (GOBBLE_FIRST_EVENT)
9114 Lisp_Object first_event
;
9117 volatile Lisp_Object original_uppercase
;
9118 volatile int original_uppercase_position
= -1;
9120 /* Gets around Microsoft compiler limitations. */
9123 struct buffer
*starting_buffer
;
9125 /* List of events for which a fake prefix key has been generated. */
9126 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
9128 #if defined (GOBBLE_FIRST_EVENT)
9132 struct gcpro gcpro1
;
9134 GCPRO1 (fake_prefixed_keys
);
9135 raw_keybuf_count
= 0;
9137 last_nonmenu_event
= Qnil
;
9139 delayed_switch_frame
= Qnil
;
9144 echo_prompt (prompt
);
9145 else if (cursor_in_echo_area
9146 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9147 && NILP (Fzerop (Vecho_keystrokes
)))
9148 /* This doesn't put in a dash if the echo buffer is empty, so
9149 you don't always see a dash hanging out in the minibuffer. */
9153 /* Record the initial state of the echo area and this_command_keys;
9154 we will need to restore them if we replay a key sequence. */
9156 echo_start
= echo_length ();
9157 keys_start
= this_command_key_count
;
9158 this_single_command_key_start
= keys_start
;
9160 #if defined (GOBBLE_FIRST_EVENT)
9161 /* This doesn't quite work, because some of the things that read_char
9162 does cannot safely be bypassed. It seems too risky to try to make
9165 /* Read the first char of the sequence specially, before setting
9166 up any keymaps, in case a filter runs and switches buffers on us. */
9167 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9169 #endif /* GOBBLE_FIRST_EVENT */
9171 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9172 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9175 /* The multi-tty merge moved the code below to right after
9176 `replay_sequence' which caused all these translation maps to be applied
9177 repeatedly, even tho their doc says very clearly they are not applied to
9179 The reason for this move was: "We may switch keyboards between rescans,
9180 so we need to reinitialize fkey and keytran before each replay".
9181 This move was wrong (even if we switch keyboards, keybuf still holds the
9182 keys we've read already from the original keyboard and some of those keys
9183 may have already been translated). So there may still be a bug out there
9185 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9186 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9187 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9188 indec
.start
= indec
.end
= 0;
9189 fkey
.start
= fkey
.end
= 0;
9190 keytran
.start
= keytran
.end
= 0;
9192 /* We jump here when the key sequence has been thoroughly changed, and
9193 we need to rescan it starting from the beginning. When we jump here,
9194 keybuf[0..mock_input] holds the sequence we should reread. */
9197 starting_buffer
= current_buffer
;
9198 first_unbound
= bufsize
+ 1;
9200 /* Build our list of keymaps.
9201 If we recognize a function key and replace its escape sequence in
9202 keybuf with its symbol, or if the sequence starts with a mouse
9203 click and we need to switch buffers, we jump back here to rebuild
9204 the initial keymaps from the current buffer. */
9207 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9209 if (2 > nmaps_allocated
)
9211 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9212 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9213 nmaps_allocated
= 2;
9215 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9217 else if (!NILP (Voverriding_local_map
))
9219 if (2 > nmaps_allocated
)
9221 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9222 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9223 nmaps_allocated
= 2;
9225 submaps
[nmaps
++] = Voverriding_local_map
;
9233 nminor
= current_minor_maps (0, &maps
);
9234 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9236 if (total
> nmaps_allocated
)
9238 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9239 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9240 nmaps_allocated
= total
;
9243 if (!NILP (orig_keymap
))
9244 submaps
[nmaps
++] = orig_keymap
;
9246 bcopy (maps
, (void *) (submaps
+ nmaps
),
9247 nminor
* sizeof (submaps
[0]));
9251 submaps
[nmaps
++] = orig_local_map
;
9253 submaps
[nmaps
++] = current_global_map
;
9255 /* Find an accurate initial value for first_binding. */
9256 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9257 if (! NILP (submaps
[first_binding
]))
9260 /* Start from the beginning in keybuf. */
9263 /* These are no-ops the first time through, but if we restart, they
9264 revert the echo area and this_command_keys to their original state. */
9265 this_command_key_count
= keys_start
;
9266 if (INTERACTIVE
&& t
< mock_input
)
9267 echo_truncate (echo_start
);
9269 /* If the best binding for the current key sequence is a keymap, or
9270 we may be looking at a function key's escape sequence, keep on
9272 while (first_binding
< nmaps
9273 /* Keep reading as long as there's a prefix binding. */
9274 ? !NILP (submaps
[first_binding
])
9275 /* Don't return in the middle of a possible function key sequence,
9276 if the only bindings we found were via case conversion.
9277 Thus, if ESC O a has a function-key-map translation
9278 and ESC o has a binding, don't return after ESC O,
9279 so that we can translate ESC O plus the next character. */
9280 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9283 int used_mouse_menu
= 0;
9285 /* Where the last real key started. If we need to throw away a
9286 key that has expanded into more than one element of keybuf
9287 (say, a mouse click on the mode line which is being treated
9288 as [mode-line (mouse-...)], then we backtrack to this point
9290 volatile int last_real_key_start
;
9292 /* These variables are analogous to echo_start and keys_start;
9293 while those allow us to restart the entire key sequence,
9294 echo_local_start and keys_local_start allow us to throw away
9296 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9298 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9299 eassert (indec
.start
<= indec
.end
);
9300 eassert (fkey
.start
<= fkey
.end
);
9301 eassert (keytran
.start
<= keytran
.end
);
9302 /* key-translation-map is applied *after* function-key-map
9303 which is itself applied *after* input-decode-map. */
9304 eassert (fkey
.end
<= indec
.start
);
9305 eassert (keytran
.end
<= fkey
.start
);
9307 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9308 first_unbound
< keytran
.start
)
9309 { /* The prefix upto first_unbound has no binding and has
9310 no translation left to do either, so we know it's unbound.
9311 If we don't stop now, we risk staying here indefinitely
9312 (if the user keeps entering fkey or keytran prefixes
9313 like C-c ESC ESC ESC ESC ...) */
9315 for (i
= first_unbound
+ 1; i
< t
; i
++)
9316 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9317 mock_input
= t
- first_unbound
- 1;
9318 indec
.end
= indec
.start
-= first_unbound
+ 1;
9319 indec
.map
= indec
.parent
;
9320 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9321 fkey
.map
= fkey
.parent
;
9322 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9323 keytran
.map
= keytran
.parent
;
9324 goto replay_sequence
;
9328 error ("Key sequence too long");
9331 echo_local_start
= echo_length ();
9332 keys_local_start
= this_command_key_count
;
9333 local_first_binding
= first_binding
;
9336 /* These are no-ops, unless we throw away a keystroke below and
9337 jumped back up to replay_key; in that case, these restore the
9338 variables to their original state, allowing us to replay the
9340 if (INTERACTIVE
&& t
< mock_input
)
9341 echo_truncate (echo_local_start
);
9342 this_command_key_count
= keys_local_start
;
9343 first_binding
= local_first_binding
;
9345 /* By default, assume each event is "real". */
9346 last_real_key_start
= t
;
9348 /* Does mock_input indicate that we are re-reading a key sequence? */
9352 add_command_key (key
);
9353 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9354 && NILP (Fzerop (Vecho_keystrokes
)))
9358 /* If not, we should actually read a character. */
9362 KBOARD
*interrupted_kboard
= current_kboard
;
9363 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9364 key
= read_char (NILP (prompt
), nmaps
,
9365 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9366 &used_mouse_menu
, NULL
);
9367 if (INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9372 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9373 if (k
== interrupted_kboard
)
9378 /* Don't touch interrupted_kboard when it's been
9380 delayed_switch_frame
= Qnil
;
9381 goto replay_sequence
;
9384 if (!NILP (delayed_switch_frame
))
9386 interrupted_kboard
->kbd_queue
9387 = Fcons (delayed_switch_frame
,
9388 interrupted_kboard
->kbd_queue
);
9389 delayed_switch_frame
= Qnil
;
9393 interrupted_kboard
->kbd_queue
9394 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9396 /* If the side queue is non-empty, ensure it begins with a
9397 switch-frame, so we'll replay it in the right context. */
9398 if (CONSP (interrupted_kboard
->kbd_queue
)
9399 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9400 !(EVENT_HAS_PARAMETERS (key
)
9401 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9405 XSETFRAME (frame
, interrupted_frame
);
9406 interrupted_kboard
->kbd_queue
9407 = Fcons (make_lispy_switch_frame (frame
),
9408 interrupted_kboard
->kbd_queue
);
9411 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9412 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9413 goto replay_sequence
;
9417 /* read_char returns t when it shows a menu and the user rejects it.
9421 unbind_to (count
, Qnil
);
9426 /* read_char returns -1 at the end of a macro.
9427 Emacs 18 handles this by returning immediately with a
9428 zero, so that's what we'll do. */
9429 if (INTEGERP (key
) && XINT (key
) == -1)
9432 /* The Microsoft C compiler can't handle the goto that
9438 /* If the current buffer has been changed from under us, the
9439 keymap may have changed, so replay the sequence. */
9442 timer_resume_idle ();
9445 /* Reset the current buffer from the selected window
9446 in case something changed the former and not the latter.
9447 This is to be more consistent with the behavior
9448 of the command_loop_1. */
9449 if (fix_current_buffer
)
9451 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9453 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9454 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9457 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9458 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9459 goto replay_sequence
;
9462 /* If we have a quit that was typed in another frame, and
9463 quit_throw_to_read_char switched buffers,
9464 replay to get the right keymap. */
9466 && XINT (key
) == quit_char
9467 && current_buffer
!= starting_buffer
)
9470 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9474 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9475 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9476 goto replay_sequence
;
9481 if (EVENT_HAS_PARAMETERS (key
)
9482 /* Either a `switch-frame' or a `select-window' event. */
9483 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9485 /* If we're at the beginning of a key sequence, and the caller
9486 says it's okay, go ahead and return this event. If we're
9487 in the midst of a key sequence, delay it until the end. */
9488 if (t
> 0 || !can_return_switch_frame
)
9490 delayed_switch_frame
= key
;
9496 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9500 /* Clicks in non-text areas get prefixed by the symbol
9501 in their CHAR-ADDRESS field. For example, a click on
9502 the mode line is prefixed by the symbol `mode-line'.
9504 Furthermore, key sequences beginning with mouse clicks
9505 are read using the keymaps of the buffer clicked on, not
9506 the current buffer. So we may have to switch the buffer
9509 When we turn one event into two events, we must make sure
9510 that neither of the two looks like the original--so that,
9511 if we replay the events, they won't be expanded again.
9512 If not for this, such reexpansion could happen either here
9513 or when user programs play with this-command-keys. */
9514 if (EVENT_HAS_PARAMETERS (key
))
9519 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9520 if (EQ (kind
, Qmouse_click
))
9522 Lisp_Object window
, posn
;
9524 window
= POSN_WINDOW (EVENT_START (key
));
9525 posn
= POSN_POSN (EVENT_START (key
));
9528 || (!NILP (fake_prefixed_keys
)
9529 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9531 /* We're looking a second time at an event for which
9532 we generated a fake prefix key. Set
9533 last_real_key_start appropriately. */
9535 last_real_key_start
= t
- 1;
9538 /* Key sequences beginning with mouse clicks are
9539 read using the keymaps in the buffer clicked on,
9540 not the current buffer. If we're at the
9541 beginning of a key sequence, switch buffers. */
9542 if (last_real_key_start
== 0
9544 && BUFFERP (XWINDOW (window
)->buffer
)
9545 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9547 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9551 /* Arrange to go back to the original buffer once we're
9552 done reading the key sequence. Note that we can't
9553 use save_excursion_{save,restore} here, because they
9554 save point as well as the current buffer; we don't
9555 want to save point, because redisplay may change it,
9556 to accommodate a Fset_window_start or something. We
9557 don't want to do this at the top of the function,
9558 because we may get input from a subprocess which
9559 wants to change the selected window and stuff (say,
9561 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9563 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9565 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9566 orig_local_map
= get_local_map (PT
, current_buffer
,
9568 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9569 goto replay_sequence
;
9572 /* For a mouse click, get the local text-property keymap
9573 of the place clicked on, rather than point. */
9574 if (last_real_key_start
== 0
9575 && CONSP (XCDR (key
))
9576 && ! localized_local_map
)
9578 Lisp_Object map_here
, start
, pos
;
9580 localized_local_map
= 1;
9581 start
= EVENT_START (key
);
9583 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9585 pos
= POSN_BUFFER_POSN (start
);
9587 && XINT (pos
) >= BEGV
9588 && XINT (pos
) <= ZV
)
9590 map_here
= get_local_map (XINT (pos
),
9591 current_buffer
, Qlocal_map
);
9592 if (!EQ (map_here
, orig_local_map
))
9594 orig_local_map
= map_here
;
9595 ++localized_local_map
;
9598 map_here
= get_local_map (XINT (pos
),
9599 current_buffer
, Qkeymap
);
9600 if (!EQ (map_here
, orig_keymap
))
9602 orig_keymap
= map_here
;
9603 ++localized_local_map
;
9606 if (localized_local_map
> 1)
9611 goto replay_sequence
;
9617 /* Expand mode-line and scroll-bar events into two events:
9618 use posn as a fake prefix key. */
9620 && (NILP (fake_prefixed_keys
)
9621 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9623 if (t
+ 1 >= bufsize
)
9624 error ("Key sequence too long");
9627 keybuf
[t
+ 1] = key
;
9630 /* Record that a fake prefix key has been generated
9631 for KEY. Don't modify the event; this would
9632 prevent proper action when the event is pushed
9633 back into unread-command-events. */
9634 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9636 /* If on a mode line string with a local keymap,
9637 reconsider the key sequence with that keymap. */
9638 if (string
= POSN_STRING (EVENT_START (key
)),
9639 (CONSP (string
) && STRINGP (XCAR (string
))))
9641 Lisp_Object pos
, map
, map2
;
9643 pos
= XCDR (string
);
9644 string
= XCAR (string
);
9646 && XINT (pos
) < SCHARS (string
))
9648 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9650 orig_local_map
= map
;
9651 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9654 if (!NILP (map
) || !NILP (map2
))
9655 goto replay_sequence
;
9661 else if (NILP (from_string
)
9662 && (string
= POSN_STRING (EVENT_START (key
)),
9663 (CONSP (string
) && STRINGP (XCAR (string
)))))
9665 /* For a click on a string, i.e. overlay string or a
9666 string displayed via the `display' property,
9667 consider `local-map' and `keymap' properties of
9669 Lisp_Object pos
, map
, map2
;
9671 pos
= XCDR (string
);
9672 string
= XCAR (string
);
9674 && XINT (pos
) < SCHARS (string
))
9676 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9678 orig_local_map
= map
;
9679 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9683 if (!NILP (map
) || !NILP (map2
))
9685 from_string
= string
;
9688 goto replay_sequence
;
9693 else if (CONSP (XCDR (key
))
9694 && CONSP (EVENT_START (key
))
9695 && CONSP (XCDR (EVENT_START (key
))))
9699 posn
= POSN_POSN (EVENT_START (key
));
9700 /* Handle menu-bar events:
9701 insert the dummy prefix event `menu-bar'. */
9702 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9704 if (t
+ 1 >= bufsize
)
9705 error ("Key sequence too long");
9709 /* Zap the position in key, so we know that we've
9710 expanded it, and don't try to do so again. */
9711 POSN_SET_POSN (EVENT_START (key
),
9712 Fcons (posn
, Qnil
));
9715 goto replay_sequence
;
9717 else if (CONSP (posn
))
9719 /* We're looking at the second event of a
9720 sequence which we expanded before. Set
9721 last_real_key_start appropriately. */
9722 if (last_real_key_start
== t
&& t
> 0)
9723 last_real_key_start
= t
- 1;
9728 /* We have finally decided that KEY is something we might want
9730 first_binding
= (follow_key (key
,
9731 nmaps
- first_binding
,
9732 submaps
+ first_binding
,
9733 defs
+ first_binding
,
9734 submaps
+ first_binding
)
9737 /* If KEY wasn't bound, we'll try some fallbacks. */
9738 if (first_binding
< nmaps
)
9739 /* This is needed for the following scenario:
9740 event 0: a down-event that gets dropped by calling replay_key.
9741 event 1: some normal prefix like C-h.
9742 After event 0, first_unbound is 0, after event 1 indec.start,
9743 fkey.start, and keytran.start are all 1, so when we see that
9744 C-h is bound, we need to update first_unbound. */
9745 first_unbound
= max (t
+ 1, first_unbound
);
9750 /* Remember the position to put an upper bound on indec.start. */
9751 first_unbound
= min (t
, first_unbound
);
9753 head
= EVENT_HEAD (key
);
9754 if (help_char_p (head
) && t
> 0)
9756 read_key_sequence_cmd
= Vprefix_help_command
;
9758 last_nonmenu_event
= key
;
9759 /* The Microsoft C compiler can't handle the goto that
9767 Lisp_Object breakdown
;
9770 breakdown
= parse_modifiers (head
);
9771 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9772 /* Attempt to reduce an unbound mouse event to a simpler
9773 event that is bound:
9774 Drags reduce to clicks.
9775 Double-clicks reduce to clicks.
9776 Triple-clicks reduce to double-clicks, then to clicks.
9777 Down-clicks are eliminated.
9778 Double-downs reduce to downs, then are eliminated.
9779 Triple-downs reduce to double-downs, then to downs,
9780 then are eliminated. */
9781 if (modifiers
& (down_modifier
| drag_modifier
9782 | double_modifier
| triple_modifier
))
9784 while (modifiers
& (down_modifier
| drag_modifier
9785 | double_modifier
| triple_modifier
))
9787 Lisp_Object new_head
, new_click
;
9788 if (modifiers
& triple_modifier
)
9789 modifiers
^= (double_modifier
| triple_modifier
);
9790 else if (modifiers
& double_modifier
)
9791 modifiers
&= ~double_modifier
;
9792 else if (modifiers
& drag_modifier
)
9793 modifiers
&= ~drag_modifier
;
9796 /* Dispose of this `down' event by simply jumping
9797 back to replay_key, to get another event.
9799 Note that if this event came from mock input,
9800 then just jumping back to replay_key will just
9801 hand it to us again. So we have to wipe out any
9804 We could delete keybuf[t] and shift everything
9805 after that to the left by one spot, but we'd also
9806 have to fix up any variable that points into
9807 keybuf, and shifting isn't really necessary
9810 Adding prefixes for non-textual mouse clicks
9811 creates two characters of mock input, and both
9812 must be thrown away. If we're only looking at
9813 the prefix now, we can just jump back to
9814 replay_key. On the other hand, if we've already
9815 processed the prefix, and now the actual click
9816 itself is giving us trouble, then we've lost the
9817 state of the keymaps we want to backtrack to, and
9818 we need to replay the whole sequence to rebuild
9821 Beyond that, only function key expansion could
9822 create more than two keys, but that should never
9823 generate mouse events, so it's okay to zero
9824 mock_input in that case too.
9826 FIXME: The above paragraph seems just plain
9827 wrong, if you consider things like
9828 xterm-mouse-mode. -stef
9830 Isn't this just the most wonderful code ever? */
9832 /* If mock_input > t + 1, the above simplification
9833 will actually end up dropping keys on the floor.
9834 This is probably OK for now, but even
9835 if mock_input <= t + 1, we need to adjust indec,
9837 Typical case [header-line down-mouse-N]:
9838 mock_input = 2, t = 1, fkey.end = 1,
9839 last_real_key_start = 0. */
9840 if (indec
.end
> last_real_key_start
)
9842 indec
.end
= indec
.start
9843 = min (last_real_key_start
, indec
.start
);
9844 indec
.map
= indec
.parent
;
9845 if (fkey
.end
> last_real_key_start
)
9847 fkey
.end
= fkey
.start
9848 = min (last_real_key_start
, fkey
.start
);
9849 fkey
.map
= fkey
.parent
;
9850 if (keytran
.end
> last_real_key_start
)
9852 keytran
.end
= keytran
.start
9853 = min (last_real_key_start
, keytran
.start
);
9854 keytran
.map
= keytran
.parent
;
9858 if (t
== last_real_key_start
)
9865 mock_input
= last_real_key_start
;
9866 goto replay_sequence
;
9871 = apply_modifiers (modifiers
, XCAR (breakdown
));
9873 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9875 /* Look for a binding for this new key. follow_key
9876 promises that it didn't munge submaps the
9877 last time we called it, since key was unbound. */
9879 = (follow_key (new_click
,
9880 nmaps
- local_first_binding
,
9881 submaps
+ local_first_binding
,
9882 defs
+ local_first_binding
,
9883 submaps
+ local_first_binding
)
9884 + local_first_binding
);
9886 /* If that click is bound, go for it. */
9887 if (first_binding
< nmaps
)
9892 /* Otherwise, we'll leave key set to the drag event. */
9899 /* Normally, last_nonmenu_event gets the previous key we read.
9900 But when a mouse popup menu is being used,
9901 we don't update last_nonmenu_event; it continues to hold the mouse
9902 event that preceded the first level of menu. */
9903 if (!used_mouse_menu
)
9904 last_nonmenu_event
= key
;
9906 /* Record what part of this_command_keys is the current key sequence. */
9907 this_single_command_key_start
= this_command_key_count
- t
;
9909 /* Look for this sequence in input-decode-map.
9910 Scan from indec.end until we find a bound suffix. */
9911 while (indec
.end
< t
)
9913 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9916 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9917 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9922 mock_input
= diff
+ max (t
, mock_input
);
9923 goto replay_sequence
;
9927 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9928 && indec
.start
>= t
)
9929 /* There is a binding and it's not a prefix.
9930 (and it doesn't have any input-decode-map translation pending).
9931 There is thus no function-key in this sequence.
9932 Moving fkey.start is important in this case to allow keytran.start
9933 to go over the sequence before we return (since we keep the
9934 invariant that keytran.end <= fkey.start). */
9937 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9940 /* If the sequence is unbound, see if we can hang a function key
9941 off the end of it. */
9942 /* Continue scan from fkey.end until we find a bound suffix. */
9943 while (fkey
.end
< indec
.start
)
9945 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9948 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9949 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9950 max (t
, mock_input
),
9951 /* If there's a binding (i.e.
9952 first_binding >= nmaps) we don't want
9953 to apply this function-key-mapping. */
9954 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9959 mock_input
= diff
+ max (t
, mock_input
);
9960 /* Adjust the input-decode-map counters. */
9962 indec
.start
+= diff
;
9964 goto replay_sequence
;
9968 /* Look for this sequence in key-translation-map.
9969 Scan from keytran.end until we find a bound suffix. */
9970 while (keytran
.end
< fkey
.start
)
9972 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9975 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9976 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9981 mock_input
= diff
+ max (t
, mock_input
);
9982 /* Adjust the function-key-map and input-decode-map counters. */
9984 indec
.start
+= diff
;
9988 goto replay_sequence
;
9992 /* If KEY is not defined in any of the keymaps,
9993 and cannot be part of a function key or translation,
9994 and is an upper case letter
9995 use the corresponding lower-case letter instead. */
9996 if (first_binding
>= nmaps
9997 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9999 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10000 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10001 || (XINT (key
) & shift_modifier
)))
10003 Lisp_Object new_key
;
10005 original_uppercase
= key
;
10006 original_uppercase_position
= t
- 1;
10008 if (XINT (key
) & shift_modifier
)
10009 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10011 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10012 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10014 /* We have to do this unconditionally, regardless of whether
10015 the lower-case char is defined in the keymaps, because they
10016 might get translated through function-key-map. */
10017 keybuf
[t
- 1] = new_key
;
10018 mock_input
= max (t
, mock_input
);
10019 shift_translated
= 1;
10021 goto replay_sequence
;
10023 /* If KEY is not defined in any of the keymaps,
10024 and cannot be part of a function key or translation,
10025 and is a shifted function key,
10026 use the corresponding unshifted function key instead. */
10027 if (first_binding
>= nmaps
10028 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10030 Lisp_Object breakdown
= parse_modifiers (key
);
10032 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10034 if (modifiers
& shift_modifier
10035 /* Treat uppercase keys as shifted. */
10037 && (KEY_TO_CHAR (key
)
10038 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
10039 && UPPERCASEP (KEY_TO_CHAR (key
))))
10041 Lisp_Object new_key
10042 = (modifiers
& shift_modifier
10043 ? apply_modifiers (modifiers
& ~shift_modifier
,
10045 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
10047 original_uppercase
= key
;
10048 original_uppercase_position
= t
- 1;
10050 /* We have to do this unconditionally, regardless of whether
10051 the lower-case char is defined in the keymaps, because they
10052 might get translated through function-key-map. */
10053 keybuf
[t
- 1] = new_key
;
10054 mock_input
= max (t
, mock_input
);
10055 /* Reset fkey (and consequently keytran) to apply
10056 function-key-map on the result, so that S-backspace is
10057 correctly mapped to DEL (via backspace). OTOH,
10058 input-decode-map doesn't need to go through it again. */
10059 fkey
.start
= fkey
.end
= 0;
10060 keytran
.start
= keytran
.end
= 0;
10061 shift_translated
= 1;
10063 goto replay_sequence
;
10068 read_key_sequence_cmd
= (first_binding
< nmaps
10069 ? defs
[first_binding
]
10072 unread_switch_frame
= delayed_switch_frame
;
10073 unbind_to (count
, Qnil
);
10075 /* Don't downcase the last character if the caller says don't.
10076 Don't downcase it if the result is undefined, either. */
10077 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10079 && t
- 1 == original_uppercase_position
)
10081 keybuf
[t
- 1] = original_uppercase
;
10082 shift_translated
= 0;
10085 if (shift_translated
)
10086 Vthis_command_keys_shift_translated
= Qt
;
10088 /* Occasionally we fabricate events, perhaps by expanding something
10089 according to function-key-map, or by adding a prefix symbol to a
10090 mouse click in the scroll bar or modeline. In this cases, return
10091 the entire generated key sequence, even if we hit an unbound
10092 prefix or a definition before the end. This means that you will
10093 be able to push back the event properly, and also means that
10094 read-key-sequence will always return a logical unit.
10097 for (; t
< mock_input
; t
++)
10099 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10100 && NILP (Fzerop (Vecho_keystrokes
)))
10101 echo_char (keybuf
[t
]);
10102 add_command_key (keybuf
[t
]);
10109 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10110 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10111 The sequence is sufficient to specify a non-prefix command in the
10112 current local and global maps.
10114 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10115 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10116 as a continuation of the previous key.
10118 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10119 convert the last event to lower case. (Normally any upper case event
10120 is converted to lower case if the original event is undefined and the lower
10121 case equivalent is defined.) A non-nil value is appropriate for reading
10122 a key sequence to be defined.
10124 A C-g typed while in this function is treated like any other character,
10125 and `quit-flag' is not set.
10127 If the key sequence starts with a mouse click, then the sequence is read
10128 using the keymaps of the buffer of the window clicked in, not the buffer
10129 of the selected window as normal.
10131 `read-key-sequence' drops unbound button-down events, since you normally
10132 only care about the click or drag events which follow them. If a drag
10133 or multi-click event is unbound, but the corresponding click event would
10134 be bound, `read-key-sequence' turns the event into a click event at the
10135 drag's starting position. This means that you don't have to distinguish
10136 between click and drag, double, or triple events unless you want to.
10138 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10139 lines separating windows, and scroll bars with imaginary keys
10140 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10142 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10143 function will process a switch-frame event if the user switches frames
10144 before typing anything. If the user switches frames in the middle of a
10145 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10146 is nil, then the event will be put off until after the current key sequence.
10148 `read-key-sequence' checks `function-key-map' for function key
10149 sequences, where they wouldn't conflict with ordinary bindings. See
10150 `function-key-map' for more details.
10152 The optional fifth argument COMMAND-LOOP, if non-nil, means
10153 that this key sequence is being read by something that will
10154 read commands one after another. It should be nil if the caller
10155 will read just one key sequence. */)
10156 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10158 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10159 Lisp_Object can_return_switch_frame
, command_loop
;
10161 Lisp_Object keybuf
[30];
10163 struct gcpro gcpro1
;
10164 int count
= SPECPDL_INDEX ();
10166 if (!NILP (prompt
))
10167 CHECK_STRING (prompt
);
10170 specbind (Qinput_method_exit_on_first_char
,
10171 (NILP (command_loop
) ? Qt
: Qnil
));
10172 specbind (Qinput_method_use_echo_area
,
10173 (NILP (command_loop
) ? Qt
: Qnil
));
10175 bzero (keybuf
, sizeof keybuf
);
10176 GCPRO1 (keybuf
[0]);
10177 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10179 if (NILP (continue_echo
))
10181 this_command_key_count
= 0;
10182 this_command_key_count_reset
= 0;
10183 this_single_command_key_start
= 0;
10186 #ifdef HAVE_WINDOW_SYSTEM
10187 if (display_hourglass_p
)
10188 cancel_hourglass ();
10191 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10192 prompt
, ! NILP (dont_downcase_last
),
10193 ! NILP (can_return_switch_frame
), 0);
10195 #if 0 /* The following is fine for code reading a key sequence and
10196 then proceeding with a lenghty computation, but it's not good
10197 for code reading keys in a loop, like an input method. */
10198 #ifdef HAVE_WINDOW_SYSTEM
10199 if (display_hourglass_p
)
10200 start_hourglass ();
10210 return unbind_to (count
, make_event_array (i
, keybuf
));
10213 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10214 Sread_key_sequence_vector
, 1, 5, 0,
10215 doc
: /* Like `read-key-sequence' but always return a vector. */)
10216 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10218 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10219 Lisp_Object can_return_switch_frame
, command_loop
;
10221 Lisp_Object keybuf
[30];
10223 struct gcpro gcpro1
;
10224 int count
= SPECPDL_INDEX ();
10226 if (!NILP (prompt
))
10227 CHECK_STRING (prompt
);
10230 specbind (Qinput_method_exit_on_first_char
,
10231 (NILP (command_loop
) ? Qt
: Qnil
));
10232 specbind (Qinput_method_use_echo_area
,
10233 (NILP (command_loop
) ? Qt
: Qnil
));
10235 bzero (keybuf
, sizeof keybuf
);
10236 GCPRO1 (keybuf
[0]);
10237 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10239 if (NILP (continue_echo
))
10241 this_command_key_count
= 0;
10242 this_command_key_count_reset
= 0;
10243 this_single_command_key_start
= 0;
10246 #ifdef HAVE_WINDOW_SYSTEM
10247 if (display_hourglass_p
)
10248 cancel_hourglass ();
10251 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10252 prompt
, ! NILP (dont_downcase_last
),
10253 ! NILP (can_return_switch_frame
), 0);
10255 #ifdef HAVE_WINDOW_SYSTEM
10256 if (display_hourglass_p
)
10257 start_hourglass ();
10266 return unbind_to (count
, Fvector (i
, keybuf
));
10269 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10270 doc
: /* Execute CMD as an editor command.
10271 CMD must be a symbol that satisfies the `commandp' predicate.
10272 Optional second arg RECORD-FLAG non-nil
10273 means unconditionally put this command in `command-history'.
10274 Otherwise, that is done only if an arg is read using the minibuffer.
10275 The argument KEYS specifies the value to use instead of (this-command-keys)
10276 when reading the arguments; if it is nil, (this-command-keys) is used.
10277 The argument SPECIAL, if non-nil, means that this command is executing
10278 a special event, so ignore the prefix argument and don't clear it. */)
10279 (cmd
, record_flag
, keys
, special
)
10280 Lisp_Object cmd
, record_flag
, keys
, special
;
10282 register Lisp_Object final
;
10283 register Lisp_Object tem
;
10284 Lisp_Object prefixarg
;
10285 extern int debug_on_next_call
;
10287 debug_on_next_call
= 0;
10289 if (NILP (special
))
10291 prefixarg
= current_kboard
->Vprefix_arg
;
10292 Vcurrent_prefix_arg
= prefixarg
;
10293 current_kboard
->Vprefix_arg
= Qnil
;
10300 tem
= Fget (cmd
, Qdisabled
);
10301 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10303 tem
= Fsymbol_value (Qdisabled_command_function
);
10305 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10311 final
= Findirect_function (cmd
, Qnil
);
10313 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10315 struct gcpro gcpro1
, gcpro2
;
10317 GCPRO2 (cmd
, prefixarg
);
10318 do_autoload (final
, cmd
);
10325 if (STRINGP (final
) || VECTORP (final
))
10327 /* If requested, place the macro in the command history. For
10328 other sorts of commands, call-interactively takes care of
10330 if (!NILP (record_flag
))
10333 = Fcons (Fcons (Qexecute_kbd_macro
,
10334 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10337 /* Don't keep command history around forever. */
10338 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10340 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10342 XSETCDR (tem
, Qnil
);
10346 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10349 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10350 /* Don't call Fcall_interactively directly because we want to make
10351 sure the backtrace has an entry for `call-interactively'.
10352 For the same reason, pass `cmd' rather than `final'. */
10353 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10360 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10362 doc
: /* Read function name, then read its arguments and call it.
10364 To pass a numeric argument to the command you are invoking with, specify
10365 the numeric argument to this command.
10367 Noninteractively, the argument PREFIXARG is the prefix argument to
10368 give to the command you invoke, if it asks for an argument. */)
10370 Lisp_Object prefixarg
;
10372 Lisp_Object function
;
10374 int saved_last_point_position
;
10375 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10376 Lisp_Object bindings
, value
;
10377 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10378 #ifdef HAVE_WINDOW_SYSTEM
10379 /* The call to Fcompleting_read wil start and cancel the hourglass,
10380 but if the hourglass was already scheduled, this means that no
10381 hourglass will be shown for the actual M-x command itself.
10382 So we restart it if it is already scheduled. Note that checking
10383 hourglass_shown_p is not enough, normally the hourglass is not shown,
10384 just scheduled to be shown. */
10385 int hstarted
= hourglass_started ();
10388 saved_keys
= Fvector (this_command_key_count
,
10389 XVECTOR (this_command_keys
)->contents
);
10390 saved_last_point_position_buffer
= last_point_position_buffer
;
10391 saved_last_point_position
= last_point_position
;
10393 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10395 if (EQ (prefixarg
, Qminus
))
10396 strcpy (buf
, "- ");
10397 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10398 strcpy (buf
, "C-u ");
10399 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10400 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10401 else if (INTEGERP (prefixarg
))
10402 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10404 /* This isn't strictly correct if execute-extended-command
10405 is bound to anything else. Perhaps it should use
10406 this_command_keys? */
10407 strcat (buf
, "M-x ");
10409 /* Prompt with buf, and then read a string, completing from and
10410 restricting to the set of all defined commands. Don't provide
10411 any initial input. Save the command read on the extended-command
10413 function
= Fcompleting_read (build_string (buf
),
10414 Vobarray
, Qcommandp
,
10415 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10418 #ifdef HAVE_WINDOW_SYSTEM
10419 if (hstarted
) start_hourglass ();
10422 if (STRINGP (function
) && SCHARS (function
) == 0)
10423 error ("No command name given");
10425 /* Set this_command_keys to the concatenation of saved_keys and
10426 function, followed by a RET. */
10431 this_command_key_count
= 0;
10432 this_command_key_count_reset
= 0;
10433 this_single_command_key_start
= 0;
10435 keys
= XVECTOR (saved_keys
)->contents
;
10436 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10437 add_command_key (keys
[i
]);
10439 for (i
= 0; i
< SCHARS (function
); i
++)
10440 add_command_key (Faref (function
, make_number (i
)));
10442 add_command_key (make_number ('\015'));
10445 last_point_position
= saved_last_point_position
;
10446 last_point_position_buffer
= saved_last_point_position_buffer
;
10450 function
= Fintern (function
, Qnil
);
10451 current_kboard
->Vprefix_arg
= prefixarg
;
10452 Vthis_command
= function
;
10453 real_this_command
= function
;
10455 /* If enabled, show which key runs this command. */
10456 if (!NILP (Vsuggest_key_bindings
)
10457 && NILP (Vexecuting_kbd_macro
)
10458 && SYMBOLP (function
))
10459 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10465 GCPRO3 (bindings
, value
, function
);
10466 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10468 /* If the command has a key binding, print it now. */
10469 if (!NILP (bindings
)
10470 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10473 /* But first wait, and skip the message if there is input. */
10474 Lisp_Object waited
;
10476 /* If this command displayed something in the echo area;
10477 wait a few seconds, then display our suggestion message. */
10478 if (NILP (echo_area_buffer
[0]))
10479 waited
= sit_for (make_number (0), 0, 2);
10480 else if (NUMBERP (Vsuggest_key_bindings
))
10481 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10483 waited
= sit_for (make_number (2), 0, 2);
10485 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10487 Lisp_Object binding
;
10489 int message_p
= push_message ();
10490 int count
= SPECPDL_INDEX ();
10492 record_unwind_protect (pop_message_unwind
, Qnil
);
10493 binding
= Fkey_description (bindings
, Qnil
);
10496 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10499 sprintf (newmessage
, "You can run the command `%s' with %s",
10500 SDATA (SYMBOL_NAME (function
)),
10502 message2_nolog (newmessage
,
10503 strlen (newmessage
),
10504 STRING_MULTIBYTE (binding
));
10505 if (NUMBERP (Vsuggest_key_bindings
))
10506 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10508 waited
= sit_for (make_number (2), 0, 2);
10510 if (!NILP (waited
) && message_p
)
10511 restore_message ();
10513 unbind_to (count
, Qnil
);
10517 RETURN_UNGCPRO (value
);
10521 /* Return nonzero if input events are pending. */
10524 detect_input_pending ()
10526 if (!input_pending
)
10527 get_input_pending (&input_pending
, 0);
10529 return input_pending
;
10532 /* Return nonzero if input events other than mouse movements are
10536 detect_input_pending_ignore_squeezables ()
10538 if (!input_pending
)
10539 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10541 return input_pending
;
10544 /* Return nonzero if input events are pending, and run any pending timers. */
10547 detect_input_pending_run_timers (do_display
)
10550 int old_timers_run
= timers_run
;
10552 if (!input_pending
)
10553 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10555 if (old_timers_run
!= timers_run
&& do_display
)
10557 redisplay_preserve_echo_area (8);
10558 /* The following fixes a bug when using lazy-lock with
10559 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10560 from an idle timer function. The symptom of the bug is that
10561 the cursor sometimes doesn't become visible until the next X
10562 event is processed. --gerd. */
10564 Lisp_Object tail
, frame
;
10565 FOR_EACH_FRAME (tail
, frame
)
10566 if (FRAME_RIF (XFRAME (frame
)))
10567 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10571 return input_pending
;
10574 /* This is called in some cases before a possible quit.
10575 It cases the next call to detect_input_pending to recompute input_pending.
10576 So calling this function unnecessarily can't do any harm. */
10579 clear_input_pending ()
10584 /* Return nonzero if there are pending requeued events.
10585 This isn't used yet. The hope is to make wait_reading_process_output
10586 call it, and return if it runs Lisp code that unreads something.
10587 The problem is, kbd_buffer_get_event needs to be fixed to know what
10588 to do in that case. It isn't trivial. */
10591 requeued_events_pending_p ()
10593 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10597 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10598 doc
: /* Return t if command input is currently available with no wait.
10599 Actually, the value is nil only if we can be sure that no input is available;
10600 if there is a doubt, the value is t. */)
10603 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10604 || !NILP (Vunread_post_input_method_events
)
10605 || !NILP (Vunread_input_method_events
))
10608 get_input_pending (&input_pending
,
10609 READABLE_EVENTS_DO_TIMERS_NOW
10610 | READABLE_EVENTS_FILTER_EVENTS
);
10611 return input_pending
> 0 ? Qt
: Qnil
;
10614 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10615 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10618 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10621 if (total_keys
< NUM_RECENT_KEYS
)
10622 return Fvector (total_keys
, keys
);
10625 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10626 bcopy (keys
+ recent_keys_index
,
10627 XVECTOR (val
)->contents
,
10628 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10630 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10631 recent_keys_index
* sizeof (Lisp_Object
));
10636 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10637 doc
: /* Return the key sequence that invoked this command.
10638 However, if the command has called `read-key-sequence', it returns
10639 the last key sequence that has been read.
10640 The value is a string or a vector.
10642 See also `this-command-keys-vector'. */)
10645 return make_event_array (this_command_key_count
,
10646 XVECTOR (this_command_keys
)->contents
);
10649 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10650 doc
: /* Return the key sequence that invoked this command, as a vector.
10651 However, if the command has called `read-key-sequence', it returns
10652 the last key sequence that has been read.
10654 See also `this-command-keys'. */)
10657 return Fvector (this_command_key_count
,
10658 XVECTOR (this_command_keys
)->contents
);
10661 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10662 Sthis_single_command_keys
, 0, 0, 0,
10663 doc
: /* Return the key sequence that invoked this command.
10664 More generally, it returns the last key sequence read, either by
10665 the command loop or by `read-key-sequence'.
10666 Unlike `this-command-keys', this function's value
10667 does not include prefix arguments.
10668 The value is always a vector. */)
10671 return Fvector (this_command_key_count
10672 - this_single_command_key_start
,
10673 (XVECTOR (this_command_keys
)->contents
10674 + this_single_command_key_start
));
10677 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10678 Sthis_single_command_raw_keys
, 0, 0, 0,
10679 doc
: /* Return the raw events that were read for this command.
10680 More generally, it returns the last key sequence read, either by
10681 the command loop or by `read-key-sequence'.
10682 Unlike `this-single-command-keys', this function's value
10683 shows the events before all translations (except for input methods).
10684 The value is always a vector. */)
10687 return Fvector (raw_keybuf_count
,
10688 (XVECTOR (raw_keybuf
)->contents
));
10691 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10692 Sreset_this_command_lengths
, 0, 0, 0,
10693 doc
: /* Make the unread events replace the last command and echo.
10694 Used in `universal-argument-other-key'.
10696 `universal-argument-other-key' rereads the event just typed.
10697 It then gets translated through `function-key-map'.
10698 The translated event has to replace the real events,
10699 both in the value of (this-command-keys) and in echoing.
10700 To achieve this, `universal-argument-other-key' calls
10701 `reset-this-command-lengths', which discards the record of reading
10702 these events the first time. */)
10705 this_command_key_count
= before_command_key_count
;
10706 if (this_command_key_count
< this_single_command_key_start
)
10707 this_single_command_key_start
= this_command_key_count
;
10709 echo_truncate (before_command_echo_length
);
10711 /* Cause whatever we put into unread-command-events
10712 to echo as if it were being freshly read from the keyboard. */
10713 this_command_key_count_reset
= 1;
10718 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10719 Sclear_this_command_keys
, 0, 1, 0,
10720 doc
: /* Clear out the vector that `this-command-keys' returns.
10721 Also clear the record of the last 100 events, unless optional arg
10722 KEEP-RECORD is non-nil. */)
10724 Lisp_Object keep_record
;
10728 this_command_key_count
= 0;
10729 this_command_key_count_reset
= 0;
10731 if (NILP (keep_record
))
10733 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10734 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10736 recent_keys_index
= 0;
10741 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10742 doc
: /* Return the current depth in recursive edits. */)
10746 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10750 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10751 "FOpen dribble file: ",
10752 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10753 If FILE is nil, close any open dribble file. */)
10766 file
= Fexpand_file_name (file
, Qnil
);
10767 dribble
= fopen (SDATA (file
), "w");
10769 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10774 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10775 doc
: /* Discard the contents of the terminal input buffer.
10776 Also end any kbd macro being defined. */)
10779 if (!NILP (current_kboard
->defining_kbd_macro
))
10781 /* Discard the last command from the macro. */
10782 Fcancel_kbd_macro_events ();
10786 update_mode_lines
++;
10788 Vunread_command_events
= Qnil
;
10789 unread_command_char
= -1;
10791 discard_tty_input ();
10793 kbd_fetch_ptr
= kbd_store_ptr
;
10799 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10800 doc
: /* Stop Emacs and return to superior process. You can resume later.
10801 If `cannot-suspend' is non-nil, or if the system doesn't support job
10802 control, run a subshell instead.
10804 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10805 to be read as terminal input by Emacs's parent, after suspension.
10807 Before suspending, run the normal hook `suspend-hook'.
10808 After resumption run the normal hook `suspend-resume-hook'.
10810 Some operating systems cannot stop the Emacs process and resume it later.
10811 On such systems, Emacs starts a subshell instead of suspending. */)
10813 Lisp_Object stuffstring
;
10815 int count
= SPECPDL_INDEX ();
10816 int old_height
, old_width
;
10818 struct gcpro gcpro1
;
10820 if (tty_list
&& tty_list
->next
)
10821 error ("There are other tty frames open; close them before suspending Emacs");
10823 if (!NILP (stuffstring
))
10824 CHECK_STRING (stuffstring
);
10826 /* Run the functions in suspend-hook. */
10827 if (!NILP (Vrun_hooks
))
10828 call1 (Vrun_hooks
, intern ("suspend-hook"));
10830 GCPRO1 (stuffstring
);
10831 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10832 reset_all_sys_modes ();
10833 /* sys_suspend can get an error if it tries to fork a subshell
10834 and the system resources aren't available for that. */
10835 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10837 stuff_buffered_input (stuffstring
);
10838 if (cannot_suspend
)
10842 unbind_to (count
, Qnil
);
10844 /* Check if terminal/window size has changed.
10845 Note that this is not useful when we are running directly
10846 with a window system; but suspend should be disabled in that case. */
10847 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10848 if (width
!= old_width
|| height
!= old_height
)
10849 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10851 /* Run suspend-resume-hook. */
10852 if (!NILP (Vrun_hooks
))
10853 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10859 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10860 Then in any case stuff anything Emacs has read ahead and not used. */
10863 stuff_buffered_input (stuffstring
)
10864 Lisp_Object stuffstring
;
10866 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10867 register unsigned char *p
;
10869 if (STRINGP (stuffstring
))
10871 register int count
;
10873 p
= SDATA (stuffstring
);
10874 count
= SBYTES (stuffstring
);
10875 while (count
-- > 0)
10880 /* Anything we have read ahead, put back for the shell to read. */
10881 /* ?? What should this do when we have multiple keyboards??
10882 Should we ignore anything that was typed in at the "wrong" kboard?
10884 rms: we should stuff everything back into the kboard
10886 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10889 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10890 kbd_fetch_ptr
= kbd_buffer
;
10891 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10892 stuff_char (kbd_fetch_ptr
->code
);
10894 clear_event (kbd_fetch_ptr
);
10898 #endif /* SIGTSTP */
10902 set_waiting_for_input (time_to_clear
)
10903 EMACS_TIME
*time_to_clear
;
10905 input_available_clear_time
= time_to_clear
;
10907 /* Tell handle_interrupt to throw back to read_char, */
10908 waiting_for_input
= 1;
10910 /* If handle_interrupt was called before and buffered a C-g,
10911 make it run again now, to avoid timing error. */
10912 if (!NILP (Vquit_flag
))
10913 quit_throw_to_read_char ();
10917 clear_waiting_for_input ()
10919 /* Tell handle_interrupt not to throw back to read_char, */
10920 waiting_for_input
= 0;
10921 input_available_clear_time
= 0;
10924 /* The SIGINT handler.
10926 If we have a frame on the controlling tty, we assume that the
10927 SIGINT was generated by C-g, so we call handle_interrupt.
10928 Otherwise, the handler kills Emacs. */
10931 interrupt_signal (signalnum
) /* If we don't have an argument, */
10932 int signalnum
; /* some compilers complain in signal calls. */
10934 /* Must preserve main program's value of errno. */
10935 int old_errno
= errno
;
10936 struct terminal
*terminal
;
10938 #if defined (USG) && !defined (POSIX_SIGNALS)
10939 /* USG systems forget handlers when they are used;
10940 must reestablish each time */
10941 signal (SIGINT
, interrupt_signal
);
10942 signal (SIGQUIT
, interrupt_signal
);
10945 SIGNAL_THREAD_CHECK (signalnum
);
10947 /* See if we have an active terminal on our controlling tty. */
10948 terminal
= get_named_tty ("/dev/tty");
10951 /* If there are no frames there, let's pretend that we are a
10952 well-behaving UN*X program and quit. */
10953 Fkill_emacs (Qnil
);
10957 /* Otherwise, the SIGINT was probably generated by C-g. */
10959 /* Set internal_last_event_frame to the top frame of the
10960 controlling tty, if we have a frame there. We disable the
10961 interrupt key on secondary ttys, so the SIGINT must have come
10962 from the controlling tty. */
10963 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10965 handle_interrupt ();
10971 /* This routine is called at interrupt level in response to C-g.
10973 It is called from the SIGINT handler or kbd_buffer_store_event.
10975 If `waiting_for_input' is non zero, then unless `echoing' is
10976 nonzero, immediately throw back to read_char.
10978 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10979 eval to throw, when it gets a chance. If quit-flag is already
10980 non-nil, it stops the job right away. */
10983 handle_interrupt ()
10989 /* XXX This code needs to be revised for multi-tty support. */
10990 if (!NILP (Vquit_flag
)
10992 && get_named_tty ("/dev/tty")
10996 /* If SIGINT isn't blocked, don't let us be interrupted by
10997 another SIGINT, it might be harmful due to non-reentrancy
10998 in I/O functions. */
10999 sigblock (sigmask (SIGINT
));
11002 reset_all_sys_modes ();
11004 #ifdef SIGTSTP /* Support possible in later USG versions */
11006 * On systems which can suspend the current process and return to the original
11007 * shell, this command causes the user to end up back at the shell.
11008 * The "Auto-save" and "Abort" questions are not asked until
11009 * the user elects to return to emacs, at which point he can save the current
11010 * job and either dump core or continue.
11015 if (sys_suspend () == -1)
11017 printf ("Not running as a subprocess;\n");
11018 printf ("you can continue or abort.\n");
11020 #else /* not VMS */
11021 /* Perhaps should really fork an inferior shell?
11022 But that would not provide any way to get back
11023 to the original shell, ever. */
11024 printf ("No support for stopping a process on this operating system;\n");
11025 printf ("you can continue or abort.\n");
11026 #endif /* not VMS */
11027 #endif /* not SIGTSTP */
11029 /* We must remain inside the screen area when the internal terminal
11030 is used. Note that [Enter] is not echoed by dos. */
11033 /* It doesn't work to autosave while GC is in progress;
11034 the code used for auto-saving doesn't cope with the mark bit. */
11035 if (!gc_in_progress
)
11037 printf ("Auto-save? (y or n) ");
11039 if (((c
= getchar ()) & ~040) == 'Y')
11041 Fdo_auto_save (Qt
, Qnil
);
11043 printf ("\r\nAuto-save done");
11044 #else /* not MSDOS */
11045 printf ("Auto-save done\n");
11046 #endif /* not MSDOS */
11048 while (c
!= '\n') c
= getchar ();
11052 /* During GC, it must be safe to reenable quitting again. */
11053 Vinhibit_quit
= Qnil
;
11056 #endif /* not MSDOS */
11057 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11058 printf ("but will instead do a real quit after garbage collection ends\r\n");
11063 printf ("\r\nAbort? (y or n) ");
11064 #else /* not MSDOS */
11066 printf ("Abort (and enter debugger)? (y or n) ");
11067 #else /* not VMS */
11068 printf ("Abort (and dump core)? (y or n) ");
11069 #endif /* not VMS */
11070 #endif /* not MSDOS */
11072 if (((c
= getchar ()) & ~040) == 'Y')
11074 while (c
!= '\n') c
= getchar ();
11076 printf ("\r\nContinuing...\r\n");
11077 #else /* not MSDOS */
11078 printf ("Continuing...\n");
11079 #endif /* not MSDOS */
11081 init_all_sys_modes ();
11086 /* If executing a function that wants to be interrupted out of
11087 and the user has not deferred quitting by binding `inhibit-quit'
11088 then quit right away. */
11089 if (immediate_quit
&& NILP (Vinhibit_quit
))
11091 struct gl_state_s saved
;
11092 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11094 immediate_quit
= 0;
11097 GCPRO4 (saved
.object
, saved
.global_code
,
11098 saved
.current_syntax_table
, saved
.old_prop
);
11099 Fsignal (Qquit
, Qnil
);
11104 /* Else request quit when it's safe */
11108 if (waiting_for_input
&& !echoing
)
11109 quit_throw_to_read_char ();
11112 /* Handle a C-g by making read_char return C-g. */
11115 quit_throw_to_read_char ()
11118 /* Prevent another signal from doing this before we finish. */
11119 clear_waiting_for_input ();
11122 Vunread_command_events
= Qnil
;
11123 unread_command_char
= -1;
11125 #if 0 /* Currently, sit_for is called from read_char without turning
11126 off polling. And that can call set_waiting_for_input.
11127 It seems to be harmless. */
11128 #ifdef POLL_FOR_INPUT
11129 /* May be > 1 if in recursive minibuffer. */
11130 if (poll_suppress_count
== 0)
11134 if (FRAMEP (internal_last_event_frame
)
11135 && !EQ (internal_last_event_frame
, selected_frame
))
11136 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11139 _longjmp (getcjmp
, 1);
11142 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11143 doc
: /* Set interrupt mode of reading keyboard input.
11144 If INTERRUPT is non-nil, Emacs will use input interrupts;
11145 otherwise Emacs uses CBREAK mode.
11147 See also `current-input-mode'. */)
11149 Lisp_Object interrupt
;
11151 int new_interrupt_input
;
11153 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11154 #ifdef HAVE_X_WINDOWS
11155 if (x_display_list
!= NULL
)
11157 /* When using X, don't give the user a real choice,
11158 because we haven't implemented the mechanisms to support it. */
11159 #ifdef NO_SOCK_SIGIO
11160 new_interrupt_input
= 0;
11161 #else /* not NO_SOCK_SIGIO */
11162 new_interrupt_input
= 1;
11163 #endif /* NO_SOCK_SIGIO */
11167 new_interrupt_input
= !NILP (interrupt
);
11168 #else /* not SIGIO */
11169 new_interrupt_input
= 0;
11170 #endif /* not SIGIO */
11172 /* Our VMS input only works by interrupts, as of now. */
11174 new_interrupt_input
= 1;
11177 if (new_interrupt_input
!= interrupt_input
)
11179 #ifdef POLL_FOR_INPUT
11183 /* this causes startup screen to be restored and messes with the mouse */
11184 reset_all_sys_modes ();
11186 interrupt_input
= new_interrupt_input
;
11188 init_all_sys_modes ();
11191 #ifdef POLL_FOR_INPUT
11192 poll_suppress_count
= 1;
11199 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11200 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11201 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11202 C-q in key sequences.
11204 This setting only has an effect on tty terminals and only when
11205 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11207 See also `current-input-mode'. */)
11209 Lisp_Object flow
, terminal
;
11211 struct terminal
*t
= get_terminal (terminal
, 1);
11212 struct tty_display_info
*tty
;
11213 if (t
== NULL
|| t
->type
!= output_termcap
)
11215 tty
= t
->display_info
.tty
;
11217 if (tty
->flow_control
!= !NILP (flow
))
11220 /* this causes startup screen to be restored and messes with the mouse */
11221 reset_sys_modes (tty
);
11224 tty
->flow_control
= !NILP (flow
);
11227 init_sys_modes (tty
);
11233 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11234 doc
: /* Enable or disable 8-bit input on TERMINAL.
11235 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11236 bit as the Meta modifier.
11238 If META is nil, Emacs will ignore the top bit, on the assumption it is
11241 Otherwise, Emacs will accept and pass through 8-bit input without
11242 specially interpreting the top bit.
11244 This setting only has an effect on tty terminal devices.
11246 Optional parameter TERMINAL specifies the tty terminal device to use.
11247 It may be a terminal id, a frame, or nil for the terminal used by the
11248 currently selected frame.
11250 See also `current-input-mode'. */)
11252 Lisp_Object meta
, terminal
;
11254 struct terminal
*t
= get_terminal (terminal
, 1);
11255 struct tty_display_info
*tty
;
11258 if (t
== NULL
|| t
->type
!= output_termcap
)
11260 tty
= t
->display_info
.tty
;
11264 else if (EQ (meta
, Qt
))
11269 if (tty
->meta_key
!= new_meta
)
11272 /* this causes startup screen to be restored and messes with the mouse */
11273 reset_sys_modes (tty
);
11276 tty
->meta_key
= new_meta
;
11279 init_sys_modes (tty
);
11285 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11286 doc
: /* Specify character used for quitting.
11287 QUIT must be an ASCII character.
11289 This function only has an effect on the controlling tty of the Emacs
11292 See also `current-input-mode'. */)
11296 struct terminal
*t
= get_named_tty ("/dev/tty");
11297 struct tty_display_info
*tty
;
11298 if (t
== NULL
|| t
->type
!= output_termcap
)
11300 tty
= t
->display_info
.tty
;
11302 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11303 error ("QUIT must be an ASCII character");
11306 /* this causes startup screen to be restored and messes with the mouse */
11307 reset_sys_modes (tty
);
11310 /* Don't let this value be out of range. */
11311 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11314 init_sys_modes (tty
);
11320 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11321 doc
: /* Set mode of reading keyboard input.
11322 First arg INTERRUPT non-nil means use input interrupts;
11323 nil means use CBREAK mode.
11324 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11325 (no effect except in CBREAK mode).
11326 Third arg META t means accept 8-bit input (for a Meta key).
11327 META nil means ignore the top bit, on the assumption it is parity.
11328 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11329 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11330 See also `current-input-mode'. */)
11331 (interrupt
, flow
, meta
, quit
)
11332 Lisp_Object interrupt
, flow
, meta
, quit
;
11334 Fset_input_interrupt_mode (interrupt
);
11335 Fset_output_flow_control (flow
, Qnil
);
11336 Fset_input_meta_mode (meta
, Qnil
);
11338 Fset_quit_char (quit
);
11342 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11343 doc
: /* Return information about the way Emacs currently reads keyboard input.
11344 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11345 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11346 nil, Emacs is using CBREAK mode.
11347 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11348 terminal; this does not apply if Emacs uses interrupt-driven input.
11349 META is t if accepting 8-bit input with 8th bit as Meta flag.
11350 META nil means ignoring the top bit, on the assumption it is parity.
11351 META is neither t nor nil if accepting 8-bit input and using
11352 all 8 bits as the character code.
11353 QUIT is the character Emacs currently uses to quit.
11354 The elements of this list correspond to the arguments of
11355 `set-input-mode'. */)
11358 Lisp_Object val
[4];
11359 struct frame
*sf
= XFRAME (selected_frame
);
11361 val
[0] = interrupt_input
? Qt
: Qnil
;
11362 if (FRAME_TERMCAP_P (sf
))
11364 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11365 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11367 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11374 XSETFASTINT (val
[3], quit_char
);
11376 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11379 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11380 doc
: /* Return position information for pixel coordinates X and Y.
11381 By default, X and Y are relative to text area of the selected window.
11382 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11383 If optional fourth arg WHOLE is non-nil, X is relative to the left
11384 edge of the window.
11386 The return value is similar to a mouse click position:
11387 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11388 IMAGE (DX . DY) (WIDTH . HEIGHT))
11389 The `posn-' functions access elements of such lists. */)
11390 (x
, y
, frame_or_window
, whole
)
11391 Lisp_Object x
, y
, frame_or_window
, whole
;
11396 if (NILP (frame_or_window
))
11397 frame_or_window
= selected_window
;
11399 if (WINDOWP (frame_or_window
))
11403 CHECK_LIVE_WINDOW (frame_or_window
);
11405 w
= XWINDOW (frame_or_window
);
11406 XSETINT (x
, (XINT (x
)
11407 + WINDOW_LEFT_EDGE_X (w
)
11409 ? window_box_left_offset (w
, TEXT_AREA
)
11411 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11412 frame_or_window
= w
->frame
;
11415 CHECK_LIVE_FRAME (frame_or_window
);
11417 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11420 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11421 doc
: /* Return position information for buffer POS in WINDOW.
11422 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11424 Return nil if position is not visible in window. Otherwise,
11425 the return value is similar to that returned by `event-start' for
11426 a mouse click at the upper left corner of the glyph corresponding
11427 to the given buffer position:
11428 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11429 IMAGE (DX . DY) (WIDTH . HEIGHT))
11430 The `posn-' functions access elements of such lists. */)
11432 Lisp_Object pos
, window
;
11437 window
= selected_window
;
11439 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11442 Lisp_Object x
= XCAR (tem
);
11443 Lisp_Object y
= XCAR (XCDR (tem
));
11445 /* Point invisible due to hscrolling? */
11448 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11456 * Set up a new kboard object with reasonable initial values.
11462 kb
->Voverriding_terminal_local_map
= Qnil
;
11463 kb
->Vlast_command
= Qnil
;
11464 kb
->Vreal_last_command
= Qnil
;
11465 kb
->Vkeyboard_translate_table
= Qnil
;
11466 kb
->Vlast_repeatable_command
= Qnil
;
11467 kb
->Vprefix_arg
= Qnil
;
11468 kb
->Vlast_prefix_arg
= Qnil
;
11469 kb
->kbd_queue
= Qnil
;
11470 kb
->kbd_queue_has_data
= 0;
11471 kb
->immediate_echo
= 0;
11472 kb
->echo_string
= Qnil
;
11473 kb
->echo_after_prompt
= -1;
11474 kb
->kbd_macro_buffer
= 0;
11475 kb
->kbd_macro_bufsize
= 0;
11476 kb
->defining_kbd_macro
= Qnil
;
11477 kb
->Vlast_kbd_macro
= Qnil
;
11478 kb
->reference_count
= 0;
11479 kb
->Vsystem_key_alist
= Qnil
;
11480 kb
->system_key_syms
= Qnil
;
11481 kb
->Vwindow_system
= Qt
; /* Unset. */
11482 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11483 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11484 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11485 kb
->Vdefault_minibuffer_frame
= Qnil
;
11489 * Destroy the contents of a kboard object, but not the object itself.
11490 * We use this just before deleting it, or if we're going to initialize
11491 * it a second time.
11497 xfree (kb
->kbd_macro_buffer
);
11500 /* Free KB and memory referenced from it. */
11508 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11511 *kbp
= kb
->next_kboard
;
11513 /* Prevent a dangling reference to KB. */
11514 if (kb
== current_kboard
11515 && FRAMEP (selected_frame
)
11516 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11518 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11520 if (current_kboard
== kb
)
11531 /* This is correct before outermost invocation of the editor loop */
11532 command_loop_level
= -1;
11533 immediate_quit
= 0;
11534 quit_char
= Ctl ('g');
11535 Vunread_command_events
= Qnil
;
11536 unread_command_char
= -1;
11537 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11539 recent_keys_index
= 0;
11540 kbd_fetch_ptr
= kbd_buffer
;
11541 kbd_store_ptr
= kbd_buffer
;
11542 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11543 do_mouse_tracking
= Qnil
;
11546 interrupt_input_blocked
= 0;
11547 interrupt_input_pending
= 0;
11549 /* This means that command_loop_1 won't try to select anything the first
11551 internal_last_event_frame
= Qnil
;
11552 Vlast_event_frame
= internal_last_event_frame
;
11554 current_kboard
= initial_kboard
;
11555 /* Re-initialize the keyboard again. */
11556 wipe_kboard (current_kboard
);
11557 init_kboard (current_kboard
);
11558 /* A value of nil for Vwindow_system normally means a tty, but we also use
11559 it for the initial terminal since there is no window system there. */
11560 current_kboard
->Vwindow_system
= Qnil
;
11562 if (!noninteractive
)
11564 /* Before multi-tty support, these handlers used to be installed
11565 only if the current session was a tty session. Now an Emacs
11566 session may have multiple display types, so we always handle
11567 SIGINT. There is special code in interrupt_signal to exit
11568 Emacs on SIGINT when there are no termcap frames on the
11569 controlling terminal. */
11570 signal (SIGINT
, interrupt_signal
);
11571 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11572 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11573 SIGQUIT and we can't tell which one it will give us. */
11574 signal (SIGQUIT
, interrupt_signal
);
11575 #endif /* HAVE_TERMIO */
11577 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11579 if (!noninteractive
)
11580 signal (SIGIO
, input_available_signal
);
11583 /* Use interrupt input by default, if it works and noninterrupt input
11584 has deficiencies. */
11586 #ifdef INTERRUPT_INPUT
11587 interrupt_input
= 1;
11589 interrupt_input
= 0;
11592 /* Our VMS input only works by interrupts, as of now. */
11594 interrupt_input
= 1;
11600 if (keyboard_init_hook
)
11601 (*keyboard_init_hook
) ();
11603 #ifdef POLL_FOR_INPUT
11604 poll_suppress_count
= 1;
11609 /* This type's only use is in syms_of_keyboard, to initialize the
11610 event header symbols and put properties on them. */
11611 struct event_head
{
11617 struct event_head head_table
[] = {
11618 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11619 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11620 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11621 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11622 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11623 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11624 /* `select-window' should be handled just like `switch-frame'
11625 in read_key_sequence. */
11626 {&Qselect_window
, "select-window", &Qswitch_frame
}
11630 syms_of_keyboard ()
11632 pending_funcalls
= Qnil
;
11634 Vlispy_mouse_stem
= build_string ("mouse");
11635 staticpro (&Vlispy_mouse_stem
);
11638 QCimage
= intern (":image");
11639 staticpro (&QCimage
);
11641 staticpro (&Qhelp_echo
);
11642 Qhelp_echo
= intern ("help-echo");
11645 Qrtl
= intern (":rtl");
11647 staticpro (&item_properties
);
11648 item_properties
= Qnil
;
11650 staticpro (&tool_bar_item_properties
);
11651 tool_bar_item_properties
= Qnil
;
11652 staticpro (&tool_bar_items_vector
);
11653 tool_bar_items_vector
= Qnil
;
11655 staticpro (&real_this_command
);
11656 real_this_command
= Qnil
;
11658 Qtimer_event_handler
= intern ("timer-event-handler");
11659 staticpro (&Qtimer_event_handler
);
11661 Qdisabled_command_function
= intern ("disabled-command-function");
11662 staticpro (&Qdisabled_command_function
);
11664 Qself_insert_command
= intern ("self-insert-command");
11665 staticpro (&Qself_insert_command
);
11667 Qforward_char
= intern ("forward-char");
11668 staticpro (&Qforward_char
);
11670 Qbackward_char
= intern ("backward-char");
11671 staticpro (&Qbackward_char
);
11673 Qdisabled
= intern ("disabled");
11674 staticpro (&Qdisabled
);
11676 Qundefined
= intern ("undefined");
11677 staticpro (&Qundefined
);
11679 Qpre_command_hook
= intern ("pre-command-hook");
11680 staticpro (&Qpre_command_hook
);
11682 Qpost_command_hook
= intern ("post-command-hook");
11683 staticpro (&Qpost_command_hook
);
11685 Qdeferred_action_function
= intern ("deferred-action-function");
11686 staticpro (&Qdeferred_action_function
);
11688 Qcommand_hook_internal
= intern ("command-hook-internal");
11689 staticpro (&Qcommand_hook_internal
);
11691 Qfunction_key
= intern ("function-key");
11692 staticpro (&Qfunction_key
);
11693 Qmouse_click
= intern ("mouse-click");
11694 staticpro (&Qmouse_click
);
11695 #if defined (WINDOWSNT)
11696 Qlanguage_change
= intern ("language-change");
11697 staticpro (&Qlanguage_change
);
11699 Qdrag_n_drop
= intern ("drag-n-drop");
11700 staticpro (&Qdrag_n_drop
);
11702 Qsave_session
= intern ("save-session");
11703 staticpro (&Qsave_session
);
11706 Qdbus_event
= intern ("dbus-event");
11707 staticpro (&Qdbus_event
);
11710 Qmenu_enable
= intern ("menu-enable");
11711 staticpro (&Qmenu_enable
);
11712 Qmenu_alias
= intern ("menu-alias");
11713 staticpro (&Qmenu_alias
);
11714 QCenable
= intern (":enable");
11715 staticpro (&QCenable
);
11716 QCvisible
= intern (":visible");
11717 staticpro (&QCvisible
);
11718 QChelp
= intern (":help");
11719 staticpro (&QChelp
);
11720 QCfilter
= intern (":filter");
11721 staticpro (&QCfilter
);
11722 QCbutton
= intern (":button");
11723 staticpro (&QCbutton
);
11724 QCkeys
= intern (":keys");
11725 staticpro (&QCkeys
);
11726 QCkey_sequence
= intern (":key-sequence");
11727 staticpro (&QCkey_sequence
);
11728 QCtoggle
= intern (":toggle");
11729 staticpro (&QCtoggle
);
11730 QCradio
= intern (":radio");
11731 staticpro (&QCradio
);
11733 Qmode_line
= intern ("mode-line");
11734 staticpro (&Qmode_line
);
11735 Qvertical_line
= intern ("vertical-line");
11736 staticpro (&Qvertical_line
);
11737 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11738 staticpro (&Qvertical_scroll_bar
);
11739 Qmenu_bar
= intern ("menu-bar");
11740 staticpro (&Qmenu_bar
);
11742 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11743 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11744 staticpro (&Qmouse_fixup_help_message
);
11747 Qabove_handle
= intern ("above-handle");
11748 staticpro (&Qabove_handle
);
11749 Qhandle
= intern ("handle");
11750 staticpro (&Qhandle
);
11751 Qbelow_handle
= intern ("below-handle");
11752 staticpro (&Qbelow_handle
);
11753 Qup
= intern ("up");
11755 Qdown
= intern ("down");
11756 staticpro (&Qdown
);
11757 Qtop
= intern ("top");
11759 Qbottom
= intern ("bottom");
11760 staticpro (&Qbottom
);
11761 Qend_scroll
= intern ("end-scroll");
11762 staticpro (&Qend_scroll
);
11763 Qratio
= intern ("ratio");
11764 staticpro (&Qratio
);
11766 Qevent_kind
= intern ("event-kind");
11767 staticpro (&Qevent_kind
);
11768 Qevent_symbol_elements
= intern ("event-symbol-elements");
11769 staticpro (&Qevent_symbol_elements
);
11770 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11771 staticpro (&Qevent_symbol_element_mask
);
11772 Qmodifier_cache
= intern ("modifier-cache");
11773 staticpro (&Qmodifier_cache
);
11775 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11776 staticpro (&Qrecompute_lucid_menubar
);
11777 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11778 staticpro (&Qactivate_menubar_hook
);
11780 Qpolling_period
= intern ("polling-period");
11781 staticpro (&Qpolling_period
);
11783 Qinput_method_function
= intern ("input-method-function");
11784 staticpro (&Qinput_method_function
);
11786 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11787 staticpro (&Qinput_method_exit_on_first_char
);
11788 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11789 staticpro (&Qinput_method_use_echo_area
);
11791 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11792 Fset (Qinput_method_use_echo_area
, Qnil
);
11794 last_point_position_buffer
= Qnil
;
11795 last_point_position_window
= Qnil
;
11798 struct event_head
*p
;
11800 for (p
= head_table
;
11801 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11804 *p
->var
= intern (p
->name
);
11805 staticpro (p
->var
);
11806 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11807 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11811 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11812 staticpro (&button_down_location
);
11813 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11814 staticpro (&mouse_syms
);
11815 wheel_syms
= Fmake_vector (make_number (4), Qnil
);
11816 staticpro (&wheel_syms
);
11820 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11822 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11823 for (i
= 0; i
< len
; i
++)
11824 if (modifier_names
[i
])
11825 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11826 staticpro (&modifier_symbols
);
11829 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11830 staticpro (&recent_keys
);
11832 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11833 staticpro (&this_command_keys
);
11835 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11836 staticpro (&raw_keybuf
);
11838 Qextended_command_history
= intern ("extended-command-history");
11839 Fset (Qextended_command_history
, Qnil
);
11840 staticpro (&Qextended_command_history
);
11842 accent_key_syms
= Qnil
;
11843 staticpro (&accent_key_syms
);
11845 func_key_syms
= Qnil
;
11846 staticpro (&func_key_syms
);
11848 drag_n_drop_syms
= Qnil
;
11849 staticpro (&drag_n_drop_syms
);
11851 unread_switch_frame
= Qnil
;
11852 staticpro (&unread_switch_frame
);
11854 internal_last_event_frame
= Qnil
;
11855 staticpro (&internal_last_event_frame
);
11857 read_key_sequence_cmd
= Qnil
;
11858 staticpro (&read_key_sequence_cmd
);
11860 menu_bar_one_keymap_changed_items
= Qnil
;
11861 staticpro (&menu_bar_one_keymap_changed_items
);
11863 menu_bar_items_vector
= Qnil
;
11864 staticpro (&menu_bar_items_vector
);
11866 help_form_saved_window_configs
= Qnil
;
11867 staticpro (&help_form_saved_window_configs
);
11869 defsubr (&Scurrent_idle_time
);
11870 defsubr (&Sevent_symbol_parse_modifiers
);
11871 defsubr (&Sevent_convert_list
);
11872 defsubr (&Sread_key_sequence
);
11873 defsubr (&Sread_key_sequence_vector
);
11874 defsubr (&Srecursive_edit
);
11875 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11876 defsubr (&Strack_mouse
);
11878 defsubr (&Sinput_pending_p
);
11879 defsubr (&Scommand_execute
);
11880 defsubr (&Srecent_keys
);
11881 defsubr (&Sthis_command_keys
);
11882 defsubr (&Sthis_command_keys_vector
);
11883 defsubr (&Sthis_single_command_keys
);
11884 defsubr (&Sthis_single_command_raw_keys
);
11885 defsubr (&Sreset_this_command_lengths
);
11886 defsubr (&Sclear_this_command_keys
);
11887 defsubr (&Ssuspend_emacs
);
11888 defsubr (&Sabort_recursive_edit
);
11889 defsubr (&Sexit_recursive_edit
);
11890 defsubr (&Srecursion_depth
);
11891 defsubr (&Stop_level
);
11892 defsubr (&Sdiscard_input
);
11893 defsubr (&Sopen_dribble_file
);
11894 defsubr (&Sset_input_interrupt_mode
);
11895 defsubr (&Sset_output_flow_control
);
11896 defsubr (&Sset_input_meta_mode
);
11897 defsubr (&Sset_quit_char
);
11898 defsubr (&Sset_input_mode
);
11899 defsubr (&Scurrent_input_mode
);
11900 defsubr (&Sexecute_extended_command
);
11901 defsubr (&Sposn_at_point
);
11902 defsubr (&Sposn_at_x_y
);
11904 DEFVAR_LISP ("last-command-char", &last_command_char
,
11905 doc
: /* Last input event that was part of a command. */);
11907 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11908 doc
: /* Last input event that was part of a command. */);
11910 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11911 doc
: /* Last input event in a command, except for mouse menu events.
11912 Mouse menus give back keys that don't look like mouse events;
11913 this variable holds the actual mouse event that led to the menu,
11914 so that you can determine whether the command was run by mouse or not. */);
11916 DEFVAR_LISP ("last-input-char", &last_input_char
,
11917 doc
: /* Last input event. */);
11919 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11920 doc
: /* Last input event. */);
11922 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11923 doc
: /* List of events to be read as the command input.
11924 These events are processed first, before actual keyboard input.
11925 Events read from this list are not normally added to `this-command-keys',
11926 as they will already have been added once as they were read for the first time.
11927 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11928 Vunread_command_events
= Qnil
;
11930 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11931 doc
: /* If not -1, an object to be read as next command input event. */);
11933 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11934 doc
: /* List of events to be processed as input by input methods.
11935 These events are processed before `unread-command-events'
11936 and actual keyboard input, but are not given to `input-method-function'. */);
11937 Vunread_post_input_method_events
= Qnil
;
11939 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11940 doc
: /* List of events to be processed as input by input methods.
11941 These events are processed after `unread-command-events', but
11942 before actual keyboard input.
11943 If there's an active input method, the events are given to
11944 `input-method-function'. */);
11945 Vunread_input_method_events
= Qnil
;
11947 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11948 doc
: /* Meta-prefix character code.
11949 Meta-foo as command input turns into this character followed by foo. */);
11950 XSETINT (meta_prefix_char
, 033);
11952 DEFVAR_KBOARD ("last-command", Vlast_command
,
11953 doc
: /* The last command executed.
11954 Normally a symbol with a function definition, but can be whatever was found
11955 in the keymap, or whatever the variable `this-command' was set to by that
11958 The value `mode-exit' is special; it means that the previous command
11959 read an event that told it to exit, and it did so and unread that event.
11960 In other words, the present command is the event that made the previous
11963 The value `kill-region' is special; it means that the previous command
11964 was a kill command.
11966 `last-command' has a separate binding for each terminal device.
11967 See Info node `(elisp)Multiple displays'. */);
11969 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11970 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11972 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11973 doc
: /* Last command that may be repeated.
11974 The last command executed that was not bound to an input event.
11975 This is the command `repeat' will try to repeat. */);
11977 DEFVAR_LISP ("this-command", &Vthis_command
,
11978 doc
: /* The command now being executed.
11979 The command can set this variable; whatever is put here
11980 will be in `last-command' during the following command. */);
11981 Vthis_command
= Qnil
;
11983 DEFVAR_LISP ("this-command-keys-shift-translated",
11984 &Vthis_command_keys_shift_translated
,
11985 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11986 Shift-translation occurs when there is no binding for the key sequence
11987 as entered, but a binding was found by changing an upper-case letter
11988 to lower-case, or a shifted function key to an unshifted one. */);
11989 Vthis_command_keys_shift_translated
= Qnil
;
11991 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11992 doc
: /* The command bound to the current key sequence before remapping.
11993 It equals `this-command' if the original command was not remapped through
11994 any of the active keymaps. Otherwise, the value of `this-command' is the
11995 result of looking up the original command in the active keymaps. */);
11996 Vthis_original_command
= Qnil
;
11998 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11999 doc
: /* *Number of input events between auto-saves.
12000 Zero means disable autosaving due to number of characters typed. */);
12001 auto_save_interval
= 300;
12003 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
12004 doc
: /* *Number of seconds idle time before auto-save.
12005 Zero or nil means disable auto-saving due to idleness.
12006 After auto-saving due to this many seconds of idle time,
12007 Emacs also does a garbage collection if that seems to be warranted. */);
12008 XSETFASTINT (Vauto_save_timeout
, 30);
12010 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
12011 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
12012 The value may be integer or floating point. */);
12013 Vecho_keystrokes
= make_number (1);
12015 DEFVAR_INT ("polling-period", &polling_period
,
12016 doc
: /* *Interval between polling for input during Lisp execution.
12017 The reason for polling is to make C-g work to stop a running program.
12018 Polling is needed only when using X windows and SIGIO does not work.
12019 Polling is automatically disabled in all other cases. */);
12020 polling_period
= 2;
12022 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
12023 doc
: /* *Maximum time between mouse clicks to make a double-click.
12024 Measured in milliseconds. The value nil means disable double-click
12025 recognition; t means double-clicks have no time limit and are detected
12026 by position only. */);
12027 Vdouble_click_time
= make_number (500);
12029 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
12030 doc
: /* *Maximum mouse movement between clicks to make a double-click.
12031 On window-system frames, value is the number of pixels the mouse may have
12032 moved horizontally or vertically between two clicks to make a double-click.
12033 On non window-system frames, value is interpreted in units of 1/8 characters
12036 This variable is also the threshold for motion of the mouse
12037 to count as a drag. */);
12038 double_click_fuzz
= 3;
12040 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
12041 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
12042 inhibit_local_menu_bar_menus
= 0;
12044 DEFVAR_INT ("num-input-keys", &num_input_keys
,
12045 doc
: /* Number of complete key sequences read as input so far.
12046 This includes key sequences read from keyboard macros.
12047 The number is effectively the number of interactive command invocations. */);
12048 num_input_keys
= 0;
12050 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
12051 doc
: /* Number of input events read from the keyboard so far.
12052 This does not include events generated by keyboard macros. */);
12053 num_nonmacro_input_events
= 0;
12055 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
12056 doc
: /* The frame in which the most recently read event occurred.
12057 If the last event came from a keyboard macro, this is set to `macro'. */);
12058 Vlast_event_frame
= Qnil
;
12060 /* This variable is set up in sysdep.c. */
12061 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
12062 doc
: /* The ERASE character as set by the user with stty. */);
12064 DEFVAR_LISP ("help-char", &Vhelp_char
,
12065 doc
: /* Character to recognize as meaning Help.
12066 When it is read, do `(eval help-form)', and display result if it's a string.
12067 If the value of `help-form' is nil, this char can be read normally. */);
12068 XSETINT (Vhelp_char
, Ctl ('H'));
12070 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
12071 doc
: /* List of input events to recognize as meaning Help.
12072 These work just like the value of `help-char' (see that). */);
12073 Vhelp_event_list
= Qnil
;
12075 DEFVAR_LISP ("help-form", &Vhelp_form
,
12076 doc
: /* Form to execute when character `help-char' is read.
12077 If the form returns a string, that string is displayed.
12078 If `help-form' is nil, the help char is not recognized. */);
12081 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12082 doc
: /* Command to run when `help-char' character follows a prefix key.
12083 This command is used only when there is no actual binding
12084 for that character after that prefix key. */);
12085 Vprefix_help_command
= Qnil
;
12087 DEFVAR_LISP ("top-level", &Vtop_level
,
12088 doc
: /* Form to evaluate when Emacs starts up.
12089 Useful to set before you dump a modified Emacs. */);
12092 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12093 doc
: /* Translate table for local keyboard input, or nil.
12094 If non-nil, the value should be a char-table. Each character read
12095 from the keyboard is looked up in this char-table. If the value found
12096 there is non-nil, then it is used instead of the actual input character.
12098 The value can also be a string or vector, but this is considered obsolete.
12099 If it is a string or vector of length N, character codes N and up are left
12100 untranslated. In a vector, an element which is nil means "no translation".
12102 This is applied to the characters supplied to input methods, not their
12103 output. See also `translation-table-for-input'.
12105 This variable has a separate binding for each terminal. See Info node
12106 `(elisp)Multiple displays'. */);
12108 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12109 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12110 \(Even if the operating system has support for stopping a process.\) */);
12111 cannot_suspend
= 0;
12113 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12114 doc
: /* Non-nil means prompt with menus when appropriate.
12115 This is done when reading from a keymap that has a prompt string,
12116 for elements that have prompt strings.
12117 The menu is displayed on the screen
12118 if X menus were enabled at configuration
12119 time and the previous event was a mouse click prefix key.
12120 Otherwise, menu prompting uses the echo area. */);
12121 menu_prompting
= 1;
12123 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12124 doc
: /* Character to see next line of menu prompt.
12125 Type this character while in a menu prompt to rotate around the lines of it. */);
12126 XSETINT (menu_prompt_more_char
, ' ');
12128 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12129 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12130 Emacs applies the modifiers of the character stored here to each keyboard
12131 character it reads. For example, after evaluating the expression
12132 (setq extra-keyboard-modifiers ?\\C-x)
12133 all input characters will have the control modifier applied to them.
12135 Note that the character ?\\C-@, equivalent to the integer zero, does
12136 not count as a control character; rather, it counts as a character
12137 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12138 cancels any modification. */);
12139 extra_keyboard_modifiers
= 0;
12141 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12142 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12143 The command loop sets this to nil before each command,
12144 and tests the value when the command returns.
12145 Buffer modification stores t in this variable. */);
12146 Vdeactivate_mark
= Qnil
;
12147 Qdeactivate_mark
= intern ("deactivate-mark");
12148 staticpro (&Qdeactivate_mark
);
12150 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12151 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
12152 Vcommand_hook_internal
= Qnil
;
12154 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12155 doc
: /* Normal hook run before each command is executed.
12156 If an unhandled error happens in running this hook,
12157 the hook value is set to nil, since otherwise the error
12158 might happen repeatedly and make Emacs nonfunctional. */);
12159 Vpre_command_hook
= Qnil
;
12161 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12162 doc
: /* Normal hook run after each command is executed.
12163 If an unhandled error happens in running this hook,
12164 the hook value is set to nil, since otherwise the error
12165 might happen repeatedly and make Emacs nonfunctional. */);
12166 Vpost_command_hook
= Qnil
;
12169 DEFVAR_LISP ("echo-area-clear-hook", ...,
12170 doc
: /* Normal hook run when clearing the echo area. */);
12172 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
12173 staticpro (&Qecho_area_clear_hook
);
12174 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
12176 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12177 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12178 Vlucid_menu_bar_dirty_flag
= Qnil
;
12180 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12181 doc
: /* List of menu bar items to move to the end of the menu bar.
12182 The elements of the list are event types that may have menu bar bindings. */);
12183 Vmenu_bar_final_items
= Qnil
;
12185 DEFVAR_KBOARD ("overriding-terminal-local-map",
12186 Voverriding_terminal_local_map
,
12187 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12188 If this variable is non-nil, it is used as a keymap instead of the
12189 buffer's local map, and the minor mode keymaps and text property keymaps.
12190 It also replaces `overriding-local-map'.
12192 This variable is intended to let commands such as `universal-argument'
12193 set up a different keymap for reading the next command.
12195 `overriding-terminal-local-map' has a separate binding for each
12197 See Info node `(elisp)Multiple displays'. */);
12199 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12200 doc
: /* Keymap that overrides all other local keymaps.
12201 If this variable is non-nil, it is used as a keymap--replacing the
12202 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12203 Voverriding_local_map
= Qnil
;
12205 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12206 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12207 Otherwise, the menu bar continues to reflect the buffer's local map
12208 and the minor mode maps regardless of `overriding-local-map'. */);
12209 Voverriding_local_map_menu_flag
= Qnil
;
12211 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12212 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12213 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
12215 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12216 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12218 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12219 doc
: /* Alist of system-specific X windows key symbols.
12220 Each element should have the form (N . SYMBOL) where N is the
12221 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12222 and SYMBOL is its name.
12224 `system-key-alist' has a separate binding for each terminal device.
12225 See Info node `(elisp)Multiple displays'. */);
12227 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12228 doc
: /* Keymap that translates key sequences to key sequences during input.
12229 This is used mainly for mapping key sequences into some preferred
12230 key events (symbols).
12232 The `read-key-sequence' function replaces any subsequence bound by
12233 `local-function-key-map' with its binding. More precisely, when the
12234 active keymaps have no binding for the current key sequence but
12235 `local-function-key-map' binds a suffix of the sequence to a vector or
12236 string, `read-key-sequence' replaces the matching suffix with its
12237 binding, and continues with the new sequence.
12239 If the binding is a function, it is called with one argument (the prompt)
12240 and its return value (a key sequence) is used.
12242 The events that come from bindings in `local-function-key-map' are not
12243 themselves looked up in `local-function-key-map'.
12245 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12246 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12247 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12248 typing `ESC O P x' would return [f1 x].
12250 `local-function-key-map' has a separate binding for each terminal
12251 device. See Info node `(elisp)Multiple displays'. If you need to
12252 define a binding on all terminals, change `function-key-map'
12253 instead. Initially, `local-function-key-map' is an empty keymap that
12254 has `function-key-map' as its parent on all terminal devices. */);
12256 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12257 doc
: /* Keymap that decodes input escape sequences.
12258 This is used mainly for mapping ASCII function key sequences into
12259 real Emacs function key events (symbols).
12261 The `read-key-sequence' function replaces any subsequence bound by
12262 `local-function-key-map' with its binding. Contrary to `function-key-map',
12263 this map applies its rebinding regardless of the presence of an ordinary
12264 binding. So it is more like `key-translation-map' except that it applies
12265 before `function-key-map' rather than after.
12267 If the binding is a function, it is called with one argument (the prompt)
12268 and its return value (a key sequence) is used.
12270 The events that come from bindings in `input-decode-map' are not
12271 themselves looked up in `input-decode-map'.
12273 This variable is keyboard-local. */);
12275 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12276 doc
: /* The parent keymap of all `local-function-key-map' instances.
12277 Function key definitions that apply to all terminal devices should go
12278 here. If a mapping is defined in both the current
12279 `local-function-key-map' binding and this variable, then the local
12280 definition will take precendence. */);
12281 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12283 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12284 doc
: /* Keymap of key translations that can override keymaps.
12285 This keymap works like `function-key-map', but comes after that,
12286 and its non-prefix bindings override ordinary bindings.
12287 Another difference is that it is global rather than keyboard-local. */);
12288 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12290 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12291 doc
: /* List of deferred actions to be performed at a later time.
12292 The precise format isn't relevant here; we just check whether it is nil. */);
12293 Vdeferred_action_list
= Qnil
;
12295 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12296 doc
: /* Function to call to handle deferred actions, after each command.
12297 This function is called with no arguments after each command
12298 whenever `deferred-action-list' is non-nil. */);
12299 Vdeferred_action_function
= Qnil
;
12301 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12302 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12303 The value can be a length of time to show the message for.
12304 If the value is non-nil and not a number, we wait 2 seconds. */);
12305 Vsuggest_key_bindings
= Qt
;
12307 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12308 doc
: /* List of active absolute time timers in order of increasing time. */);
12309 Vtimer_list
= Qnil
;
12311 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12312 doc
: /* List of active idle-time timers in order of increasing time. */);
12313 Vtimer_idle_list
= Qnil
;
12315 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12316 doc
: /* If non-nil, the function that implements the current input method.
12317 It's called with one argument, a printing character that was just read.
12318 \(That means a character with code 040...0176.)
12319 Typically this function uses `read-event' to read additional events.
12320 When it does so, it should first bind `input-method-function' to nil
12321 so it will not be called recursively.
12323 The function should return a list of zero or more events
12324 to be used as input. If it wants to put back some events
12325 to be reconsidered, separately, by the input method,
12326 it can add them to the beginning of `unread-command-events'.
12328 The input method function can find in `input-method-previous-method'
12329 the previous echo area message.
12331 The input method function should refer to the variables
12332 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12333 for guidance on what to do. */);
12334 Vinput_method_function
= Qnil
;
12336 DEFVAR_LISP ("input-method-previous-message",
12337 &Vinput_method_previous_message
,
12338 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12339 This variable exists because `read-event' clears the echo area
12340 before running the input method. It is nil if there was no message. */);
12341 Vinput_method_previous_message
= Qnil
;
12343 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12344 doc
: /* If non-nil, the function that implements the display of help.
12345 It's called with one argument, the help string to display. */);
12346 Vshow_help_function
= Qnil
;
12348 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12349 doc
: /* If non-nil, suppress point adjustment after executing a command.
12351 After a command is executed, if point is moved into a region that has
12352 special properties (e.g. composition, display), we adjust point to
12353 the boundary of the region. But, when a command sets this variable to
12354 non-nil, we suppress the point adjustment.
12356 This variable is set to nil before reading a command, and is checked
12357 just after executing the command. */);
12358 Vdisable_point_adjustment
= Qnil
;
12360 DEFVAR_LISP ("global-disable-point-adjustment",
12361 &Vglobal_disable_point_adjustment
,
12362 doc
: /* *If non-nil, always suppress point adjustment.
12364 The default value is nil, in which case, point adjustment are
12365 suppressed only after special commands that set
12366 `disable-point-adjustment' (which see) to non-nil. */);
12367 Vglobal_disable_point_adjustment
= Qnil
;
12369 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12370 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12371 If the value is not a number, such messages don't time out. */);
12372 Vminibuffer_message_timeout
= make_number (2);
12374 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12375 doc
: /* If non-nil, any keyboard input throws to this symbol.
12376 The value of that variable is passed to `quit-flag' and later causes a
12377 peculiar kind of quitting. */);
12378 Vthrow_on_input
= Qnil
;
12380 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12381 doc
: /* If non-nil, function to output error messages.
12382 The arguments are the error data, a list of the form
12383 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12384 such as just as `condition-case' would bind its variable to,
12385 the context (a string which normally goes at the start of the message),
12386 and the Lisp function within which the error was signaled. */);
12387 Vcommand_error_function
= Qnil
;
12389 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12390 &Venable_disabled_menus_and_buttons
,
12391 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12393 Help functions bind this to allow help on disabled menu items
12394 and tool-bar buttons. */);
12395 Venable_disabled_menus_and_buttons
= Qnil
;
12397 /* Create the initial keyboard. */
12398 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12399 init_kboard (initial_kboard
);
12400 /* Vwindow_system is left at t for now. */
12401 initial_kboard
->next_kboard
= all_kboards
;
12402 all_kboards
= initial_kboard
;
12406 keys_of_keyboard ()
12408 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12409 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12410 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12411 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12412 initial_define_key (meta_map
, 'x', "execute-extended-command");
12414 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12415 "handle-delete-frame");
12416 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12417 current-prefix-arg, as is done in `handle-switch-frame'.
12418 But `handle-switch-frame is not run from the special-map.
12419 Commands from that map are run in a special way that automatically
12420 preserves the prefix-arg. Restoring the prefix arg here is not just
12421 redundant but harmful:
12423 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12424 - after the first prompt, the exit-minibuffer-hook is run which may
12425 iconify a frame and thus push a `iconify-frame' event.
12426 - after running exit-minibuffer-hook, current-prefix-arg is
12427 restored to the non-nil value it had before the prompt.
12428 - we enter the second prompt.
12429 current-prefix-arg is non-nil, prefix-arg is nil.
12430 - before running the first real event, we run the special iconify-frame
12431 event, but we pass the `special' arg to execute-command so
12432 current-prefix-arg and prefix-arg are left untouched.
12433 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12434 - the next key event will have a spuriously non-nil current-prefix-arg. */
12435 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12437 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12439 /* Handling it at such a low-level causes read_key_sequence to get
12440 * confused because it doesn't realize that the current_buffer was
12441 * changed by read_char.
12443 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12444 * "handle-select-window"); */
12445 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12446 "handle-save-session");
12449 /* Define a special event which is raised for dbus callback
12451 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12452 "dbus-handle-event");
12456 /* Mark the pointers in the kboard objects.
12457 Called by the Fgarbage_collector. */
12463 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12465 if (kb
->kbd_macro_buffer
)
12466 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12468 mark_object (kb
->Voverriding_terminal_local_map
);
12469 mark_object (kb
->Vlast_command
);
12470 mark_object (kb
->Vreal_last_command
);
12471 mark_object (kb
->Vkeyboard_translate_table
);
12472 mark_object (kb
->Vlast_repeatable_command
);
12473 mark_object (kb
->Vprefix_arg
);
12474 mark_object (kb
->Vlast_prefix_arg
);
12475 mark_object (kb
->kbd_queue
);
12476 mark_object (kb
->defining_kbd_macro
);
12477 mark_object (kb
->Vlast_kbd_macro
);
12478 mark_object (kb
->Vsystem_key_alist
);
12479 mark_object (kb
->system_key_syms
);
12480 mark_object (kb
->Vwindow_system
);
12481 mark_object (kb
->Vinput_decode_map
);
12482 mark_object (kb
->Vlocal_function_key_map
);
12483 mark_object (kb
->Vdefault_minibuffer_frame
);
12484 mark_object (kb
->echo_string
);
12487 struct input_event
*event
;
12488 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12490 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12491 event
= kbd_buffer
;
12492 if (event
->kind
!= SELECTION_REQUEST_EVENT
12493 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12495 mark_object (event
->x
);
12496 mark_object (event
->y
);
12498 mark_object (event
->frame_or_window
);
12499 mark_object (event
->arg
);
12504 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12505 (do not change this comment) */