* ediff.texi (Session Commands): Fix typo.
[emacs.git] / src / keyboard.c
blob527a82b55ff089a9887e7df925a2e6e6372777fc
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, 2009 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/>. */
21 #include <config.h>
22 #include <signal.h>
23 #include <stdio.h>
24 #include "lisp.h"
25 #include "termchar.h"
26 #include "termopts.h"
27 #include "frame.h"
28 #include "termhooks.h"
29 #include "macros.h"
30 #include "keyboard.h"
31 #include "window.h"
32 #include "commands.h"
33 #include "buffer.h"
34 #include "character.h"
35 #include "disptab.h"
36 #include "dispextern.h"
37 #include "syntax.h"
38 #include "intervals.h"
39 #include "keymap.h"
40 #include "blockinput.h"
41 #include "puresize.h"
42 #include "systime.h"
43 #include "atimer.h"
44 #include <setjmp.h>
45 #include <errno.h>
47 #ifdef HAVE_GTK_AND_PTHREAD
48 #include <pthread.h>
49 #endif
50 #ifdef MSDOS
51 #include "msdos.h"
52 #include <time.h>
53 #else /* not MSDOS */
54 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
59 #include <sys/types.h>
60 #ifdef HAVE_UNISTD_H
61 #include <unistd.h>
62 #endif
64 #ifdef HAVE_FCNTL_H
65 #include <fcntl.h>
66 #endif
68 /* This is to get the definitions of the XK_ symbols. */
69 #ifdef HAVE_X_WINDOWS
70 #include "xterm.h"
71 #endif
73 #ifdef HAVE_NTGUI
74 #include "w32term.h"
75 #endif /* HAVE_NTGUI */
77 #ifdef HAVE_NS
78 #include "nsterm.h"
79 #endif
81 #ifndef USE_CRT_DLL
82 extern int errno;
83 #endif
85 /* Variables for blockinput.h: */
87 /* Non-zero if interrupt input is blocked right now. */
88 volatile int interrupt_input_blocked;
90 /* Nonzero means an input interrupt has arrived
91 during the current critical section. */
92 int interrupt_input_pending;
94 /* This var should be (interrupt_input_pending || pending_atimers).
95 The QUIT macro checks this instead of interrupt_input_pending and
96 pending_atimers separately, to reduce code size. So, any code that
97 changes interrupt_input_pending or pending_atimers should update
98 this too. */
99 #ifdef SYNC_INPUT
100 int pending_signals;
101 #endif
103 #define KBD_BUFFER_SIZE 4096
105 KBOARD *initial_kboard;
106 KBOARD *current_kboard;
107 KBOARD *all_kboards;
108 int single_kboard;
110 /* Non-nil disable property on a command means
111 do not execute it; call disabled-command-function's value instead. */
112 Lisp_Object Qdisabled, Qdisabled_command_function;
114 #define NUM_RECENT_KEYS (300)
115 int recent_keys_index; /* Index for storing next element into recent_keys */
116 int total_keys; /* Total number of elements stored into recent_keys */
117 Lisp_Object recent_keys; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
119 /* Vector holding the key sequence that invoked the current command.
120 It is reused for each command, and it may be longer than the current
121 sequence; this_command_key_count indicates how many elements
122 actually mean something.
123 It's easier to staticpro a single Lisp_Object than an array. */
124 Lisp_Object this_command_keys;
125 int this_command_key_count;
127 /* 1 after calling Freset_this_command_lengths.
128 Usually it is 0. */
129 int this_command_key_count_reset;
131 /* This vector is used as a buffer to record the events that were actually read
132 by read_key_sequence. */
133 Lisp_Object raw_keybuf;
134 int raw_keybuf_count;
136 /* Non-nil if the present key sequence was obtained by shift translation. */
137 Lisp_Object Vthis_command_keys_shift_translated;
139 #define GROW_RAW_KEYBUF \
140 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
141 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
143 /* Number of elements of this_command_keys
144 that precede this key sequence. */
145 int this_single_command_key_start;
147 /* Record values of this_command_key_count and echo_length ()
148 before this command was read. */
149 static int before_command_key_count;
150 static int before_command_echo_length;
152 extern int minbuf_level;
154 extern int message_enable_multibyte;
156 /* If non-nil, the function that implements the display of help.
157 It's called with one argument, the help string to display. */
159 Lisp_Object Vshow_help_function;
161 /* Nonzero means do menu prompting. */
163 static int menu_prompting;
165 /* Character to see next line of menu prompt. */
167 static Lisp_Object menu_prompt_more_char;
169 /* For longjmp to where kbd input is being done. */
171 static jmp_buf getcjmp;
173 /* True while doing kbd input. */
174 int waiting_for_input;
176 /* True while displaying for echoing. Delays C-g throwing. */
178 int echoing;
180 /* Non-null means we can start echoing at the next input pause even
181 though there is something in the echo area. */
183 static struct kboard *ok_to_echo_at_next_pause;
185 /* The kboard last echoing, or null for none. Reset to 0 in
186 cancel_echoing. If non-null, and a current echo area message
187 exists, and echo_message_buffer is eq to the current message
188 buffer, we know that the message comes from echo_kboard. */
190 struct kboard *echo_kboard;
192 /* The buffer used for echoing. Set in echo_now, reset in
193 cancel_echoing. */
195 Lisp_Object echo_message_buffer;
197 /* Nonzero means disregard local maps for the menu bar. */
198 static int inhibit_local_menu_bar_menus;
200 /* Nonzero means C-g should cause immediate error-signal. */
201 int immediate_quit;
203 /* The user's hook function for outputting an error message. */
204 Lisp_Object Vcommand_error_function;
206 /* The user's ERASE setting. */
207 Lisp_Object Vtty_erase_char;
209 /* Character to recognize as the help char. */
210 Lisp_Object Vhelp_char;
212 /* List of other event types to recognize as meaning "help". */
213 Lisp_Object Vhelp_event_list;
215 /* Form to execute when help char is typed. */
216 Lisp_Object Vhelp_form;
218 /* Command to run when the help character follows a prefix key. */
219 Lisp_Object Vprefix_help_command;
221 /* List of items that should move to the end of the menu bar. */
222 Lisp_Object Vmenu_bar_final_items;
224 /* Non-nil means show the equivalent key-binding for
225 any M-x command that has one.
226 The value can be a length of time to show the message for.
227 If the value is non-nil and not a number, we wait 2 seconds. */
228 Lisp_Object Vsuggest_key_bindings;
230 /* How long to display an echo-area message when the minibuffer is active.
231 If the value is not a number, such messages don't time out. */
232 Lisp_Object Vminibuffer_message_timeout;
234 /* Character that causes a quit. Normally C-g.
236 If we are running on an ordinary terminal, this must be an ordinary
237 ASCII char, since we want to make it our interrupt character.
239 If we are not running on an ordinary terminal, it still needs to be
240 an ordinary ASCII char. This character needs to be recognized in
241 the input interrupt handler. At this point, the keystroke is
242 represented as a struct input_event, while the desired quit
243 character is specified as a lispy event. The mapping from struct
244 input_events to lispy events cannot run in an interrupt handler,
245 and the reverse mapping is difficult for anything but ASCII
246 keystrokes.
248 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
249 ASCII character. */
250 int quit_char;
252 extern Lisp_Object current_global_map;
253 extern int minibuf_level;
255 /* If non-nil, this is a map that overrides all other local maps. */
256 Lisp_Object Voverriding_local_map;
258 /* If non-nil, Voverriding_local_map applies to the menu bar. */
259 Lisp_Object Voverriding_local_map_menu_flag;
261 /* Keymap that defines special misc events that should
262 be processed immediately at a low level. */
263 Lisp_Object Vspecial_event_map;
265 /* Current depth in recursive edits. */
266 int command_loop_level;
268 /* Total number of times command_loop has read a key sequence. */
269 EMACS_INT num_input_keys;
271 /* Last input event read as a command. */
272 Lisp_Object last_command_event;
274 /* Last input character read as a command, not counting menus
275 reached by the mouse. */
276 Lisp_Object last_nonmenu_event;
278 /* Last input event read for any purpose. */
279 Lisp_Object last_input_event;
281 /* If not Qnil, a list of objects to be read as subsequent command input. */
282 Lisp_Object Vunread_command_events;
284 /* If not Qnil, a list of objects to be read as subsequent command input
285 including input method processing. */
286 Lisp_Object Vunread_input_method_events;
288 /* If not Qnil, a list of objects to be read as subsequent command input
289 but NOT including input method processing. */
290 Lisp_Object Vunread_post_input_method_events;
292 /* If not -1, an event to be read as subsequent command input. */
293 EMACS_INT unread_command_char;
295 /* If not Qnil, this is a switch-frame event which we decided to put
296 off until the end of a key sequence. This should be read as the
297 next command input, after any unread_command_events.
299 read_key_sequence uses this to delay switch-frame events until the
300 end of the key sequence; Fread_char uses it to put off switch-frame
301 events until a non-ASCII event is acceptable as input. */
302 Lisp_Object unread_switch_frame;
304 /* A mask of extra modifier bits to put into every keyboard char. */
305 EMACS_INT extra_keyboard_modifiers;
307 /* Char to use as prefix when a meta character is typed in.
308 This is bound on entry to minibuffer in case ESC is changed there. */
310 Lisp_Object meta_prefix_char;
312 /* Last size recorded for a current buffer which is not a minibuffer. */
313 static int last_non_minibuf_size;
315 /* Number of idle seconds before an auto-save and garbage collection. */
316 static Lisp_Object Vauto_save_timeout;
318 /* Total number of times read_char has returned. */
319 int num_input_events;
321 /* Total number of times read_char has returned, outside of macros. */
322 EMACS_INT num_nonmacro_input_events;
324 /* Auto-save automatically when this many characters have been typed
325 since the last time. */
327 static EMACS_INT auto_save_interval;
329 /* Value of num_nonmacro_input_events as of last auto save. */
331 int last_auto_save;
333 /* The command being executed by the command loop.
334 Commands may set this, and the value set will be copied into
335 current_kboard->Vlast_command instead of the actual command. */
336 Lisp_Object Vthis_command;
338 /* This is like Vthis_command, except that commands never set it. */
339 Lisp_Object real_this_command;
341 /* If the lookup of the command returns a binding, the original
342 command is stored in this-original-command. It is nil otherwise. */
343 Lisp_Object Vthis_original_command;
345 /* The value of point when the last command was started. */
346 int last_point_position;
348 /* The buffer that was current when the last command was started. */
349 Lisp_Object last_point_position_buffer;
351 /* The window that was selected when the last command was started. */
352 Lisp_Object last_point_position_window;
354 /* The frame in which the last input event occurred, or Qmacro if the
355 last event came from a macro. We use this to determine when to
356 generate switch-frame events. This may be cleared by functions
357 like Fselect_frame, to make sure that a switch-frame event is
358 generated by the next character. */
359 Lisp_Object internal_last_event_frame;
361 /* A user-visible version of the above, intended to allow users to
362 figure out where the last event came from, if the event doesn't
363 carry that information itself (i.e. if it was a character). */
364 Lisp_Object Vlast_event_frame;
366 /* The timestamp of the last input event we received from the X server.
367 X Windows wants this for selection ownership. */
368 unsigned long last_event_timestamp;
370 Lisp_Object Qself_insert_command;
371 Lisp_Object Qforward_char;
372 Lisp_Object Qbackward_char;
373 Lisp_Object Qundefined;
374 Lisp_Object Qtimer_event_handler;
376 /* read_key_sequence stores here the command definition of the
377 key sequence that it reads. */
378 Lisp_Object read_key_sequence_cmd;
380 /* Echo unfinished commands after this many seconds of pause. */
381 Lisp_Object Vecho_keystrokes;
383 /* Form to evaluate (if non-nil) when Emacs is started. */
384 Lisp_Object Vtop_level;
386 /* If non-nil, this implements the current input method. */
387 Lisp_Object Vinput_method_function;
388 Lisp_Object Qinput_method_function;
390 /* When we call Vinput_method_function,
391 this holds the echo area message that was just erased. */
392 Lisp_Object Vinput_method_previous_message;
394 /* Non-nil means deactivate the mark at end of this command. */
395 Lisp_Object Vdeactivate_mark;
396 Lisp_Object Qdeactivate_mark;
398 /* Menu bar specified in Lucid Emacs fashion. */
400 Lisp_Object Vlucid_menu_bar_dirty_flag;
401 Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;
403 Lisp_Object Qecho_area_clear_hook;
405 /* Hooks to run before and after each command. */
406 Lisp_Object Qpre_command_hook, Vpre_command_hook;
407 Lisp_Object Qpost_command_hook, Vpost_command_hook;
408 Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
410 /* Parent keymap of terminal-local function-key-map instances. */
411 Lisp_Object Vfunction_key_map;
413 /* Keymap of key translations that can override keymaps. */
414 Lisp_Object Vkey_translation_map;
416 /* List of deferred actions to be performed at a later time.
417 The precise format isn't relevant here; we just check whether it is nil. */
418 Lisp_Object Vdeferred_action_list;
420 /* Function to call to handle deferred actions, when there are any. */
421 Lisp_Object Vdeferred_action_function;
422 Lisp_Object Qdeferred_action_function;
424 Lisp_Object Qinput_method_exit_on_first_char;
425 Lisp_Object Qinput_method_use_echo_area;
427 /* File in which we write all commands we read. */
428 FILE *dribble;
430 /* Nonzero if input is available. */
431 int input_pending;
433 extern char *pending_malloc_warning;
435 /* Circular buffer for pre-read keyboard input. */
437 static struct input_event kbd_buffer[KBD_BUFFER_SIZE];
439 /* Pointer to next available character in kbd_buffer.
440 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
441 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
442 next available char is in kbd_buffer[0]. */
443 static struct input_event *kbd_fetch_ptr;
445 /* Pointer to next place to store character in kbd_buffer. This
446 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
447 character should go in kbd_buffer[0]. */
448 static struct input_event * volatile kbd_store_ptr;
450 /* The above pair of variables forms a "queue empty" flag. When we
451 enqueue a non-hook event, we increment kbd_store_ptr. When we
452 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
453 there is input available if the two pointers are not equal.
455 Why not just have a flag set and cleared by the enqueuing and
456 dequeuing functions? Such a flag could be screwed up by interrupts
457 at inopportune times. */
459 /* If this flag is non-nil, we check mouse_moved to see when the
460 mouse moves, and motion events will appear in the input stream.
461 Otherwise, mouse motion is ignored. */
462 Lisp_Object do_mouse_tracking;
464 /* Symbols to head events. */
465 Lisp_Object Qmouse_movement;
466 Lisp_Object Qscroll_bar_movement;
467 Lisp_Object Qswitch_frame;
468 Lisp_Object Qdelete_frame;
469 Lisp_Object Qiconify_frame;
470 Lisp_Object Qmake_frame_visible;
471 Lisp_Object Qselect_window;
472 Lisp_Object Qhelp_echo;
474 extern Lisp_Object Qremap;
476 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
477 Lisp_Object Qmouse_fixup_help_message;
478 #endif
480 /* Symbols to denote kinds of events. */
481 Lisp_Object Qfunction_key;
482 Lisp_Object Qmouse_click;
483 #if defined (WINDOWSNT)
484 Lisp_Object Qlanguage_change;
485 #endif
486 Lisp_Object Qdrag_n_drop;
487 Lisp_Object Qsave_session;
488 #ifdef HAVE_DBUS
489 Lisp_Object Qdbus_event;
490 #endif
491 /* Lisp_Object Qmouse_movement; - also an event header */
493 /* Properties of event headers. */
494 Lisp_Object Qevent_kind;
495 Lisp_Object Qevent_symbol_elements;
497 /* menu item parts */
498 Lisp_Object Qmenu_alias;
499 Lisp_Object Qmenu_enable;
500 Lisp_Object QCenable, QCvisible, QChelp, QCfilter, QCkeys, QCkey_sequence;
501 Lisp_Object QCbutton, QCtoggle, QCradio;
502 extern Lisp_Object Vdefine_key_rebound_commands;
503 extern Lisp_Object Qmenu_item;
505 /* An event header symbol HEAD may have a property named
506 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
507 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
508 mask of modifiers applied to it. If present, this is used to help
509 speed up parse_modifiers. */
510 Lisp_Object Qevent_symbol_element_mask;
512 /* An unmodified event header BASE may have a property named
513 Qmodifier_cache, which is an alist mapping modifier masks onto
514 modified versions of BASE. If present, this helps speed up
515 apply_modifiers. */
516 Lisp_Object Qmodifier_cache;
518 /* Symbols to use for parts of windows. */
519 Lisp_Object Qmode_line;
520 Lisp_Object Qvertical_line;
521 Lisp_Object Qvertical_scroll_bar;
522 Lisp_Object Qmenu_bar;
523 extern Lisp_Object Qleft_margin, Qright_margin;
524 extern Lisp_Object Qleft_fringe, Qright_fringe;
525 extern Lisp_Object QCmap;
527 Lisp_Object recursive_edit_unwind (), command_loop ();
528 Lisp_Object Fthis_command_keys ();
529 Lisp_Object Qextended_command_history;
530 EMACS_TIME timer_check ();
532 extern Lisp_Object Vhistory_length, Vtranslation_table_for_input;
534 extern char *x_get_keysym_name ();
536 static void record_menu_key ();
537 static int echo_length ();
539 Lisp_Object Qpolling_period;
541 /* List of absolute timers. Appears in order of next scheduled event. */
542 Lisp_Object Vtimer_list;
544 /* List of idle time timers. Appears in order of next scheduled event. */
545 Lisp_Object Vtimer_idle_list;
547 /* Incremented whenever a timer is run. */
548 int timers_run;
550 extern Lisp_Object Vprint_level, Vprint_length;
552 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
553 happens. */
554 EMACS_TIME *input_available_clear_time;
556 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
557 Default is 1 if INTERRUPT_INPUT is defined. */
558 int interrupt_input;
560 /* Nonzero while interrupts are temporarily deferred during redisplay. */
561 int interrupts_deferred;
563 /* Allow m- file to inhibit use of FIONREAD. */
564 #ifdef BROKEN_FIONREAD
565 #undef FIONREAD
566 #endif
568 /* We are unable to use interrupts if FIONREAD is not available,
569 so flush SIGIO so we won't try. */
570 #if !defined (FIONREAD)
571 #ifdef SIGIO
572 #undef SIGIO
573 #endif
574 #endif
576 /* If we support a window system, turn on the code to poll periodically
577 to detect C-g. It isn't actually used when doing interrupt input. */
578 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
579 #define POLL_FOR_INPUT
580 #endif
582 /* After a command is executed, if point is moved into a region that
583 has specific properties (e.g. composition, display), we adjust
584 point to the boundary of the region. But, if a command sets this
585 variable to non-nil, we suppress this point adjustment. This
586 variable is set to nil before reading a command. */
588 Lisp_Object Vdisable_point_adjustment;
590 /* If non-nil, always disable point adjustment. */
592 Lisp_Object Vglobal_disable_point_adjustment;
594 /* The time when Emacs started being idle. */
596 static EMACS_TIME timer_idleness_start_time;
598 /* After Emacs stops being idle, this saves the last value
599 of timer_idleness_start_time from when it was idle. */
601 static EMACS_TIME timer_last_idleness_start_time;
603 /* If non-nil, events produced by disabled menu items and tool-bar
604 buttons are not ignored. Help functions bind this to allow help on
605 those items and buttons. */
606 Lisp_Object Venable_disabled_menus_and_buttons;
609 /* Global variable declarations. */
611 /* Flags for readable_events. */
612 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
613 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
614 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
616 /* Function for init_keyboard to call with no args (if nonzero). */
617 void (*keyboard_init_hook) ();
619 static int read_avail_input P_ ((int));
620 static void get_input_pending P_ ((int *, int));
621 static int readable_events P_ ((int));
622 static Lisp_Object read_char_x_menu_prompt P_ ((int, Lisp_Object *,
623 Lisp_Object, int *));
624 static Lisp_Object read_char_x_menu_prompt ();
625 static Lisp_Object read_char_minibuf_menu_prompt P_ ((int, int,
626 Lisp_Object *));
627 static Lisp_Object make_lispy_event P_ ((struct input_event *));
628 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
629 static Lisp_Object make_lispy_movement P_ ((struct frame *, Lisp_Object,
630 enum scroll_bar_part,
631 Lisp_Object, Lisp_Object,
632 unsigned long));
633 #endif
634 static Lisp_Object modify_event_symbol P_ ((int, unsigned, Lisp_Object,
635 Lisp_Object, char **,
636 Lisp_Object *, unsigned));
637 static Lisp_Object make_lispy_switch_frame P_ ((Lisp_Object));
638 static void save_getcjmp P_ ((jmp_buf));
639 static void save_getcjmp ();
640 static void restore_getcjmp P_ ((jmp_buf));
641 static Lisp_Object apply_modifiers P_ ((int, Lisp_Object));
642 static void clear_event P_ ((struct input_event *));
643 static Lisp_Object restore_kboard_configuration P_ ((Lisp_Object));
644 static SIGTYPE interrupt_signal P_ ((int signalnum));
645 static void handle_interrupt P_ ((void));
646 static void timer_start_idle P_ ((void));
647 static void timer_stop_idle P_ ((void));
648 static void timer_resume_idle P_ ((void));
649 static SIGTYPE handle_user_signal P_ ((int));
650 static char *find_user_signal_name P_ ((int));
651 static int store_user_signal_events P_ ((void));
653 /* Nonzero means don't try to suspend even if the operating system seems
654 to support it. */
655 static int cannot_suspend;
657 extern Lisp_Object Qidentity, Qonly;
659 /* Install the string STR as the beginning of the string of echoing,
660 so that it serves as a prompt for the next character.
661 Also start echoing. */
663 void
664 echo_prompt (str)
665 Lisp_Object str;
667 current_kboard->echo_string = str;
668 current_kboard->echo_after_prompt = SCHARS (str);
669 echo_now ();
672 /* Add C to the echo string, if echoing is going on.
673 C can be a character, which is printed prettily ("M-C-x" and all that
674 jazz), or a symbol, whose name is printed. */
676 void
677 echo_char (c)
678 Lisp_Object c;
680 if (current_kboard->immediate_echo)
682 int size = KEY_DESCRIPTION_SIZE + 100;
683 char *buffer = (char *) alloca (size);
684 char *ptr = buffer;
685 Lisp_Object echo_string;
687 echo_string = current_kboard->echo_string;
689 /* If someone has passed us a composite event, use its head symbol. */
690 c = EVENT_HEAD (c);
692 if (INTEGERP (c))
694 ptr = push_key_description (XINT (c), ptr, 1);
696 else if (SYMBOLP (c))
698 Lisp_Object name = SYMBOL_NAME (c);
699 int nbytes = SBYTES (name);
701 if (size - (ptr - buffer) < nbytes)
703 int offset = ptr - buffer;
704 size = max (2 * size, size + nbytes);
705 buffer = (char *) alloca (size);
706 ptr = buffer + offset;
709 ptr += copy_text (SDATA (name), ptr, nbytes,
710 STRING_MULTIBYTE (name), 1);
713 if ((NILP (echo_string) || SCHARS (echo_string) == 0)
714 && help_char_p (c))
716 const char *text = " (Type ? for further options)";
717 int len = strlen (text);
719 if (size - (ptr - buffer) < len)
721 int offset = ptr - buffer;
722 size += len;
723 buffer = (char *) alloca (size);
724 ptr = buffer + offset;
727 bcopy (text, ptr, len);
728 ptr += len;
731 /* Replace a dash from echo_dash with a space, otherwise
732 add a space at the end as a separator between keys. */
733 if (STRINGP (echo_string)
734 && SCHARS (echo_string) > 1)
736 Lisp_Object last_char, prev_char, idx;
738 idx = make_number (SCHARS (echo_string) - 2);
739 prev_char = Faref (echo_string, idx);
741 idx = make_number (SCHARS (echo_string) - 1);
742 last_char = Faref (echo_string, idx);
744 /* We test PREV_CHAR to make sure this isn't the echoing
745 of a minus-sign. */
746 if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
747 Faset (echo_string, idx, make_number (' '));
748 else
749 echo_string = concat2 (echo_string, build_string (" "));
751 else if (STRINGP (echo_string))
752 echo_string = concat2 (echo_string, build_string (" "));
754 current_kboard->echo_string
755 = concat2 (echo_string, make_string (buffer, ptr - buffer));
757 echo_now ();
761 /* Temporarily add a dash to the end of the echo string if it's not
762 empty, so that it serves as a mini-prompt for the very next character. */
764 void
765 echo_dash ()
767 /* Do nothing if not echoing at all. */
768 if (NILP (current_kboard->echo_string))
769 return;
771 if (!current_kboard->immediate_echo
772 && SCHARS (current_kboard->echo_string) == 0)
773 return;
775 /* Do nothing if we just printed a prompt. */
776 if (current_kboard->echo_after_prompt
777 == SCHARS (current_kboard->echo_string))
778 return;
780 /* Do nothing if we have already put a dash at the end. */
781 if (SCHARS (current_kboard->echo_string) > 1)
783 Lisp_Object last_char, prev_char, idx;
785 idx = make_number (SCHARS (current_kboard->echo_string) - 2);
786 prev_char = Faref (current_kboard->echo_string, idx);
788 idx = make_number (SCHARS (current_kboard->echo_string) - 1);
789 last_char = Faref (current_kboard->echo_string, idx);
791 if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
792 return;
795 /* Put a dash at the end of the buffer temporarily,
796 but make it go away when the next character is added. */
797 current_kboard->echo_string = concat2 (current_kboard->echo_string,
798 build_string ("-"));
799 echo_now ();
802 /* Display the current echo string, and begin echoing if not already
803 doing so. */
805 void
806 echo_now ()
808 if (!current_kboard->immediate_echo)
810 int i;
811 current_kboard->immediate_echo = 1;
813 for (i = 0; i < this_command_key_count; i++)
815 Lisp_Object c;
817 /* Set before_command_echo_length to the value that would
818 have been saved before the start of this subcommand in
819 command_loop_1, if we had already been echoing then. */
820 if (i == this_single_command_key_start)
821 before_command_echo_length = echo_length ();
823 c = XVECTOR (this_command_keys)->contents[i];
824 if (! (EVENT_HAS_PARAMETERS (c)
825 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
826 echo_char (c);
829 /* Set before_command_echo_length to the value that would
830 have been saved before the start of this subcommand in
831 command_loop_1, if we had already been echoing then. */
832 if (this_command_key_count == this_single_command_key_start)
833 before_command_echo_length = echo_length ();
835 /* Put a dash at the end to invite the user to type more. */
836 echo_dash ();
839 echoing = 1;
840 message3_nolog (current_kboard->echo_string,
841 SBYTES (current_kboard->echo_string),
842 STRING_MULTIBYTE (current_kboard->echo_string));
843 echoing = 0;
845 /* Record in what buffer we echoed, and from which kboard. */
846 echo_message_buffer = echo_area_buffer[0];
847 echo_kboard = current_kboard;
849 if (waiting_for_input && !NILP (Vquit_flag))
850 quit_throw_to_read_char ();
853 /* Turn off echoing, for the start of a new command. */
855 void
856 cancel_echoing ()
858 current_kboard->immediate_echo = 0;
859 current_kboard->echo_after_prompt = -1;
860 current_kboard->echo_string = Qnil;
861 ok_to_echo_at_next_pause = NULL;
862 echo_kboard = NULL;
863 echo_message_buffer = Qnil;
866 /* Return the length of the current echo string. */
868 static int
869 echo_length ()
871 return (STRINGP (current_kboard->echo_string)
872 ? SCHARS (current_kboard->echo_string)
873 : 0);
876 /* Truncate the current echo message to its first LEN chars.
877 This and echo_char get used by read_key_sequence when the user
878 switches frames while entering a key sequence. */
880 static void
881 echo_truncate (nchars)
882 int nchars;
884 if (STRINGP (current_kboard->echo_string))
885 current_kboard->echo_string
886 = Fsubstring (current_kboard->echo_string,
887 make_number (0), make_number (nchars));
888 truncate_echo_area (nchars);
892 /* Functions for manipulating this_command_keys. */
893 static void
894 add_command_key (key)
895 Lisp_Object key;
897 #if 0 /* Not needed after we made Freset_this_command_lengths
898 do the job immediately. */
899 /* If reset-this-command-length was called recently, obey it now.
900 See the doc string of that function for an explanation of why. */
901 if (before_command_restore_flag)
903 this_command_key_count = before_command_key_count_1;
904 if (this_command_key_count < this_single_command_key_start)
905 this_single_command_key_start = this_command_key_count;
906 echo_truncate (before_command_echo_length_1);
907 before_command_restore_flag = 0;
909 #endif
911 if (this_command_key_count >= ASIZE (this_command_keys))
912 this_command_keys = larger_vector (this_command_keys,
913 2 * ASIZE (this_command_keys),
914 Qnil);
916 ASET (this_command_keys, this_command_key_count, key);
917 ++this_command_key_count;
921 Lisp_Object
922 recursive_edit_1 ()
924 int count = SPECPDL_INDEX ();
925 Lisp_Object val;
927 if (command_loop_level > 0)
929 specbind (Qstandard_output, Qt);
930 specbind (Qstandard_input, Qt);
933 #ifdef HAVE_WINDOW_SYSTEM
934 /* The command loop has started an hourglass timer, so we have to
935 cancel it here, otherwise it will fire because the recursive edit
936 can take some time. Do not check for display_hourglass_p here,
937 because it could already be nil. */
938 cancel_hourglass ();
939 #endif
941 /* This function may have been called from a debugger called from
942 within redisplay, for instance by Edebugging a function called
943 from fontification-functions. We want to allow redisplay in
944 the debugging session.
946 The recursive edit is left with a `(throw exit ...)'. The `exit'
947 tag is not caught anywhere in redisplay, i.e. when we leave the
948 recursive edit, the original redisplay leading to the recursive
949 edit will be unwound. The outcome should therefore be safe. */
950 specbind (Qinhibit_redisplay, Qnil);
951 redisplaying_p = 0;
953 val = command_loop ();
954 if (EQ (val, Qt))
955 Fsignal (Qquit, Qnil);
956 /* Handle throw from read_minibuf when using minibuffer
957 while it's active but we're in another window. */
958 if (STRINGP (val))
959 xsignal1 (Qerror, val);
961 return unbind_to (count, Qnil);
964 /* When an auto-save happens, record the "time", and don't do again soon. */
966 void
967 record_auto_save ()
969 last_auto_save = num_nonmacro_input_events;
972 /* Make an auto save happen as soon as possible at command level. */
974 void
975 force_auto_save_soon ()
977 last_auto_save = - auto_save_interval - 1;
979 record_asynch_buffer_change ();
982 DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
983 doc: /* Invoke the editor command loop recursively.
984 To get out of the recursive edit, a command can do `(throw 'exit nil)';
985 that tells this function to return.
986 Alternatively, `(throw 'exit t)' makes this function signal an error.
987 This function is called by the editor initialization to begin editing. */)
990 int count = SPECPDL_INDEX ();
991 Lisp_Object buffer;
993 /* If we enter while input is blocked, don't lock up here.
994 This may happen through the debugger during redisplay. */
995 if (INPUT_BLOCKED_P)
996 return Qnil;
998 command_loop_level++;
999 update_mode_lines = 1;
1001 if (command_loop_level
1002 && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
1003 buffer = Fcurrent_buffer ();
1004 else
1005 buffer = Qnil;
1007 /* If we leave recursive_edit_1 below with a `throw' for instance,
1008 like it is done in the splash screen display, we have to
1009 make sure that we restore single_kboard as command_loop_1
1010 would have done if it were left normally. */
1011 if (command_loop_level > 0)
1012 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1013 record_unwind_protect (recursive_edit_unwind, buffer);
1015 recursive_edit_1 ();
1016 return unbind_to (count, Qnil);
1019 Lisp_Object
1020 recursive_edit_unwind (buffer)
1021 Lisp_Object buffer;
1023 if (BUFFERP (buffer))
1024 Fset_buffer (buffer);
1026 command_loop_level--;
1027 update_mode_lines = 1;
1028 return Qnil;
1032 #if 0 /* These two functions are now replaced with
1033 temporarily_switch_to_single_kboard. */
1034 static void
1035 any_kboard_state ()
1037 #if 0 /* Theory: if there's anything in Vunread_command_events,
1038 it will right away be read by read_key_sequence,
1039 and then if we do switch KBOARDS, it will go into the side
1040 queue then. So we don't need to do anything special here -- rms. */
1041 if (CONSP (Vunread_command_events))
1043 current_kboard->kbd_queue
1044 = nconc2 (Vunread_command_events, current_kboard->kbd_queue);
1045 current_kboard->kbd_queue_has_data = 1;
1047 Vunread_command_events = Qnil;
1048 #endif
1049 single_kboard = 0;
1052 /* Switch to the single-kboard state, making current_kboard
1053 the only KBOARD from which further input is accepted. */
1055 void
1056 single_kboard_state ()
1058 single_kboard = 1;
1060 #endif
1062 /* If we're in single_kboard state for kboard KBOARD,
1063 get out of it. */
1065 void
1066 not_single_kboard_state (kboard)
1067 KBOARD *kboard;
1069 if (kboard == current_kboard)
1070 single_kboard = 0;
1073 /* Maintain a stack of kboards, so other parts of Emacs
1074 can switch temporarily to the kboard of a given frame
1075 and then revert to the previous status. */
1077 struct kboard_stack
1079 KBOARD *kboard;
1080 struct kboard_stack *next;
1083 static struct kboard_stack *kboard_stack;
1085 void
1086 push_kboard (k)
1087 struct kboard *k;
1089 struct kboard_stack *p
1090 = (struct kboard_stack *) xmalloc (sizeof (struct kboard_stack));
1092 p->next = kboard_stack;
1093 p->kboard = current_kboard;
1094 kboard_stack = p;
1096 current_kboard = k;
1099 void
1100 pop_kboard ()
1102 struct terminal *t;
1103 struct kboard_stack *p = kboard_stack;
1104 int found = 0;
1105 for (t = terminal_list; t; t = t->next_terminal)
1107 if (t->kboard == p->kboard)
1109 current_kboard = p->kboard;
1110 found = 1;
1111 break;
1114 if (!found)
1116 /* The terminal we remembered has been deleted. */
1117 current_kboard = FRAME_KBOARD (SELECTED_FRAME ());
1118 single_kboard = 0;
1120 kboard_stack = p->next;
1121 xfree (p);
1124 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1125 from which further input is accepted. If F is non-nil, set its
1126 KBOARD as the current keyboard.
1128 This function uses record_unwind_protect to return to the previous
1129 state later.
1131 If Emacs is already in single_kboard mode, and F's keyboard is
1132 locked, then this function will throw an errow. */
1134 void
1135 temporarily_switch_to_single_kboard (f)
1136 struct frame *f;
1138 int was_locked = single_kboard;
1139 if (was_locked)
1141 if (f != NULL && FRAME_KBOARD (f) != current_kboard)
1142 /* We can not switch keyboards while in single_kboard mode.
1143 In rare cases, Lisp code may call `recursive-edit' (or
1144 `read-minibuffer' or `y-or-n-p') after it switched to a
1145 locked frame. For example, this is likely to happen
1146 when server.el connects to a new terminal while Emacs is in
1147 single_kboard mode. It is best to throw an error instead
1148 of presenting the user with a frozen screen. */
1149 error ("Terminal %d is locked, cannot read from it",
1150 FRAME_TERMINAL (f)->id);
1151 else
1152 /* This call is unnecessary, but helps
1153 `restore_kboard_configuration' discover if somebody changed
1154 `current_kboard' behind our back. */
1155 push_kboard (current_kboard);
1157 else if (f != NULL)
1158 current_kboard = FRAME_KBOARD (f);
1159 single_kboard = 1;
1160 record_unwind_protect (restore_kboard_configuration,
1161 (was_locked ? Qt : Qnil));
1164 #if 0 /* This function is not needed anymore. */
1165 void
1166 record_single_kboard_state ()
1168 if (single_kboard)
1169 push_kboard (current_kboard);
1170 record_unwind_protect (restore_kboard_configuration,
1171 (single_kboard ? Qt : Qnil));
1173 #endif
1175 static Lisp_Object
1176 restore_kboard_configuration (was_locked)
1177 Lisp_Object was_locked;
1179 if (NILP (was_locked))
1180 single_kboard = 0;
1181 else
1183 struct kboard *prev = current_kboard;
1184 single_kboard = 1;
1185 pop_kboard ();
1186 /* The pop should not change the kboard. */
1187 if (single_kboard && current_kboard != prev)
1188 abort ();
1190 return Qnil;
1194 /* Handle errors that are not handled at inner levels
1195 by printing an error message and returning to the editor command loop. */
1197 Lisp_Object
1198 cmd_error (data)
1199 Lisp_Object data;
1201 Lisp_Object old_level, old_length;
1202 char macroerror[50];
1204 #ifdef HAVE_WINDOW_SYSTEM
1205 if (display_hourglass_p)
1206 cancel_hourglass ();
1207 #endif
1209 if (!NILP (executing_kbd_macro))
1211 if (executing_kbd_macro_iterations == 1)
1212 sprintf (macroerror, "After 1 kbd macro iteration: ");
1213 else
1214 sprintf (macroerror, "After %d kbd macro iterations: ",
1215 executing_kbd_macro_iterations);
1217 else
1218 *macroerror = 0;
1220 Vstandard_output = Qt;
1221 Vstandard_input = Qt;
1222 Vexecuting_kbd_macro = Qnil;
1223 executing_kbd_macro = Qnil;
1224 current_kboard->Vprefix_arg = Qnil;
1225 current_kboard->Vlast_prefix_arg = Qnil;
1226 cancel_echoing ();
1228 /* Avoid unquittable loop if data contains a circular list. */
1229 old_level = Vprint_level;
1230 old_length = Vprint_length;
1231 XSETFASTINT (Vprint_level, 10);
1232 XSETFASTINT (Vprint_length, 10);
1233 cmd_error_internal (data, macroerror);
1234 Vprint_level = old_level;
1235 Vprint_length = old_length;
1237 Vquit_flag = Qnil;
1239 Vinhibit_quit = Qnil;
1240 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1241 if (command_loop_level == 0 && minibuf_level == 0)
1242 any_kboard_state ();
1243 #endif
1245 return make_number (0);
1248 /* Take actions on handling an error. DATA is the data that describes
1249 the error.
1251 CONTEXT is a C-string containing ASCII characters only which
1252 describes the context in which the error happened. If we need to
1253 generalize CONTEXT to allow multibyte characters, make it a Lisp
1254 string. */
1256 void
1257 cmd_error_internal (data, context)
1258 Lisp_Object data;
1259 char *context;
1261 struct frame *sf = SELECTED_FRAME ();
1263 /* The immediate context is not interesting for Quits,
1264 since they are asyncronous. */
1265 if (EQ (XCAR (data), Qquit))
1266 Vsignaling_function = Qnil;
1268 Vquit_flag = Qnil;
1269 Vinhibit_quit = Qt;
1271 /* Use user's specified output function if any. */
1272 if (!NILP (Vcommand_error_function))
1273 call3 (Vcommand_error_function, data,
1274 context ? build_string (context) : empty_unibyte_string,
1275 Vsignaling_function);
1276 /* If the window system or terminal frame hasn't been initialized
1277 yet, or we're not interactive, write the message to stderr and exit. */
1278 else if (!sf->glyphs_initialized_p
1279 /* The initial frame is a special non-displaying frame. It
1280 will be current in daemon mode when there are no frames
1281 to display, and in non-daemon mode before the real frame
1282 has finished initializing. If an error is thrown in the
1283 latter case while creating the frame, then the frame
1284 will never be displayed, so the safest thing to do is
1285 write to stderr and quit. In daemon mode, there are
1286 many other potential errors that do not prevent frames
1287 from being created, so continuing as normal is better in
1288 that case. */
1289 || (!IS_DAEMON && FRAME_INITIAL_P (sf))
1290 || noninteractive)
1292 print_error_message (data, Qexternal_debugging_output,
1293 context, Vsignaling_function);
1294 Fterpri (Qexternal_debugging_output);
1295 Fkill_emacs (make_number (-1));
1297 else
1299 clear_message (1, 0);
1300 Fdiscard_input ();
1301 message_log_maybe_newline ();
1302 bitch_at_user ();
1304 print_error_message (data, Qt, context, Vsignaling_function);
1307 Vsignaling_function = Qnil;
1310 Lisp_Object command_loop_1 ();
1311 Lisp_Object command_loop_2 ();
1312 Lisp_Object top_level_1 ();
1314 /* Entry to editor-command-loop.
1315 This level has the catches for exiting/returning to editor command loop.
1316 It returns nil to exit recursive edit, t to abort it. */
1318 Lisp_Object
1319 command_loop ()
1321 if (command_loop_level > 0 || minibuf_level > 0)
1323 Lisp_Object val;
1324 val = internal_catch (Qexit, command_loop_2, Qnil);
1325 executing_kbd_macro = Qnil;
1326 return val;
1328 else
1329 while (1)
1331 internal_catch (Qtop_level, top_level_1, Qnil);
1332 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1333 /* Reset single_kboard in case top-level set it while
1334 evaluating an -f option, or we are stuck there for some
1335 other reason. */
1336 any_kboard_state ();
1337 #endif
1338 internal_catch (Qtop_level, command_loop_2, Qnil);
1339 executing_kbd_macro = Qnil;
1341 /* End of file in -batch run causes exit here. */
1342 if (noninteractive)
1343 Fkill_emacs (Qt);
1347 /* Here we catch errors in execution of commands within the
1348 editing loop, and reenter the editing loop.
1349 When there is an error, cmd_error runs and returns a non-nil
1350 value to us. A value of nil means that command_loop_1 itself
1351 returned due to end of file (or end of kbd macro). */
1353 Lisp_Object
1354 command_loop_2 ()
1356 register Lisp_Object val;
1359 val = internal_condition_case (command_loop_1, Qerror, cmd_error);
1360 while (!NILP (val));
1362 return Qnil;
1365 Lisp_Object
1366 top_level_2 ()
1368 return Feval (Vtop_level);
1371 Lisp_Object
1372 top_level_1 ()
1374 /* On entry to the outer level, run the startup file */
1375 if (!NILP (Vtop_level))
1376 internal_condition_case (top_level_2, Qerror, cmd_error);
1377 else if (!NILP (Vpurify_flag))
1378 message ("Bare impure Emacs (standard Lisp code not loaded)");
1379 else
1380 message ("Bare Emacs (standard Lisp code not loaded)");
1381 return Qnil;
1384 DEFUN ("top-level", Ftop_level, Stop_level, 0, 0, "",
1385 doc: /* Exit all recursive editing levels.
1386 This also exits all active minibuffers. */)
1389 #ifdef HAVE_WINDOW_SYSTEM
1390 if (display_hourglass_p)
1391 cancel_hourglass ();
1392 #endif
1394 /* Unblock input if we enter with input blocked. This may happen if
1395 redisplay traps e.g. during tool-bar update with input blocked. */
1396 while (INPUT_BLOCKED_P)
1397 UNBLOCK_INPUT;
1399 return Fthrow (Qtop_level, Qnil);
1402 DEFUN ("exit-recursive-edit", Fexit_recursive_edit, Sexit_recursive_edit, 0, 0, "",
1403 doc: /* Exit from the innermost recursive edit or minibuffer. */)
1406 if (command_loop_level > 0 || minibuf_level > 0)
1407 Fthrow (Qexit, Qnil);
1409 error ("No recursive edit is in progress");
1410 return Qnil;
1413 DEFUN ("abort-recursive-edit", Fabort_recursive_edit, Sabort_recursive_edit, 0, 0, "",
1414 doc: /* Abort the command that requested this recursive edit or minibuffer input. */)
1417 if (command_loop_level > 0 || minibuf_level > 0)
1418 Fthrow (Qexit, Qt);
1420 error ("No recursive edit is in progress");
1421 return Qnil;
1424 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1426 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1427 of this function. */
1429 static Lisp_Object
1430 tracking_off (old_value)
1431 Lisp_Object old_value;
1433 do_mouse_tracking = old_value;
1434 if (NILP (old_value))
1436 /* Redisplay may have been preempted because there was input
1437 available, and it assumes it will be called again after the
1438 input has been processed. If the only input available was
1439 the sort that we have just disabled, then we need to call
1440 redisplay. */
1441 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW))
1443 redisplay_preserve_echo_area (6);
1444 get_input_pending (&input_pending,
1445 READABLE_EVENTS_DO_TIMERS_NOW);
1448 return Qnil;
1451 DEFUN ("track-mouse", Ftrack_mouse, Strack_mouse, 0, UNEVALLED, 0,
1452 doc: /* Evaluate BODY with mouse movement events enabled.
1453 Within a `track-mouse' form, mouse motion generates input events that
1454 you can read with `read-event'.
1455 Normally, mouse motion is ignored.
1456 usage: (track-mouse BODY...) */)
1457 (args)
1458 Lisp_Object args;
1460 int count = SPECPDL_INDEX ();
1461 Lisp_Object val;
1463 record_unwind_protect (tracking_off, do_mouse_tracking);
1465 do_mouse_tracking = Qt;
1467 val = Fprogn (args);
1468 return unbind_to (count, val);
1471 /* If mouse has moved on some frame, return one of those frames.
1473 Return 0 otherwise.
1475 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1476 after resizing the tool-bar window. */
1478 int ignore_mouse_drag_p;
1480 static FRAME_PTR
1481 some_mouse_moved ()
1483 Lisp_Object tail, frame;
1485 if (ignore_mouse_drag_p)
1487 /* ignore_mouse_drag_p = 0; */
1488 return 0;
1491 FOR_EACH_FRAME (tail, frame)
1493 if (XFRAME (frame)->mouse_moved)
1494 return XFRAME (frame);
1497 return 0;
1500 #endif /* HAVE_MOUSE || HAVE_GPM */
1502 /* This is the actual command reading loop,
1503 sans error-handling encapsulation. */
1505 static int read_key_sequence P_ ((Lisp_Object *, int, Lisp_Object,
1506 int, int, int));
1507 void safe_run_hooks P_ ((Lisp_Object));
1508 static void adjust_point_for_property P_ ((int, int));
1510 /* Cancel hourglass from protect_unwind.
1511 ARG is not used. */
1512 #ifdef HAVE_WINDOW_SYSTEM
1513 static Lisp_Object
1514 cancel_hourglass_unwind (arg)
1515 Lisp_Object arg;
1517 cancel_hourglass ();
1518 return Qnil;
1520 #endif
1522 Lisp_Object
1523 command_loop_1 ()
1525 Lisp_Object cmd;
1526 int lose;
1527 int nonundocount;
1528 Lisp_Object keybuf[30];
1529 int i;
1530 int prev_modiff = 0;
1531 struct buffer *prev_buffer = NULL;
1532 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1533 int was_locked = single_kboard;
1534 #endif
1535 int already_adjusted = 0;
1537 current_kboard->Vprefix_arg = Qnil;
1538 current_kboard->Vlast_prefix_arg = Qnil;
1539 Vdeactivate_mark = Qnil;
1540 waiting_for_input = 0;
1541 cancel_echoing ();
1543 nonundocount = 0;
1544 this_command_key_count = 0;
1545 this_command_key_count_reset = 0;
1546 this_single_command_key_start = 0;
1548 if (NILP (Vmemory_full))
1550 /* Make sure this hook runs after commands that get errors and
1551 throw to top level. */
1552 /* Note that the value cell will never directly contain nil
1553 if the symbol is a local variable. */
1554 if (!NILP (Vpost_command_hook) && !NILP (Vrun_hooks))
1555 safe_run_hooks (Qpost_command_hook);
1557 /* If displaying a message, resize the echo area window to fit
1558 that message's size exactly. */
1559 if (!NILP (echo_area_buffer[0]))
1560 resize_echo_area_exactly ();
1562 if (!NILP (Vdeferred_action_list))
1563 safe_run_hooks (Qdeferred_action_function);
1566 /* Do this after running Vpost_command_hook, for consistency. */
1567 current_kboard->Vlast_command = Vthis_command;
1568 current_kboard->Vreal_last_command = real_this_command;
1569 if (!CONSP (last_command_event))
1570 current_kboard->Vlast_repeatable_command = real_this_command;
1572 while (1)
1574 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
1575 Fkill_emacs (Qnil);
1577 /* Make sure the current window's buffer is selected. */
1578 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
1579 set_buffer_internal (XBUFFER (XWINDOW (selected_window)->buffer));
1581 /* Display any malloc warning that just came out. Use while because
1582 displaying one warning can cause another. */
1584 while (pending_malloc_warning)
1585 display_malloc_warning ();
1587 Vdeactivate_mark = Qnil;
1589 /* If minibuffer on and echo area in use,
1590 wait a short time and redraw minibuffer. */
1592 if (minibuf_level
1593 && !NILP (echo_area_buffer[0])
1594 && EQ (minibuf_window, echo_area_window)
1595 && NUMBERP (Vminibuffer_message_timeout))
1597 /* Bind inhibit-quit to t so that C-g gets read in
1598 rather than quitting back to the minibuffer. */
1599 int count = SPECPDL_INDEX ();
1600 specbind (Qinhibit_quit, Qt);
1602 sit_for (Vminibuffer_message_timeout, 0, 2);
1604 /* Clear the echo area. */
1605 message2 (0, 0, 0);
1606 safe_run_hooks (Qecho_area_clear_hook);
1608 unbind_to (count, Qnil);
1610 /* If a C-g came in before, treat it as input now. */
1611 if (!NILP (Vquit_flag))
1613 Vquit_flag = Qnil;
1614 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
1618 #if 0
1619 /* Select the frame that the last event came from. Usually,
1620 switch-frame events will take care of this, but if some lisp
1621 code swallows a switch-frame event, we'll fix things up here.
1622 Is this a good idea? */
1623 if (FRAMEP (internal_last_event_frame)
1624 && !EQ (internal_last_event_frame, selected_frame))
1625 Fselect_frame (internal_last_event_frame, Qnil);
1626 #endif
1627 /* If it has changed current-menubar from previous value,
1628 really recompute the menubar from the value. */
1629 if (! NILP (Vlucid_menu_bar_dirty_flag)
1630 && !NILP (Ffboundp (Qrecompute_lucid_menubar)))
1631 call0 (Qrecompute_lucid_menubar);
1633 before_command_key_count = this_command_key_count;
1634 before_command_echo_length = echo_length ();
1636 Vthis_command = Qnil;
1637 real_this_command = Qnil;
1638 Vthis_original_command = Qnil;
1639 Vthis_command_keys_shift_translated = Qnil;
1641 /* Read next key sequence; i gets its length. */
1642 i = read_key_sequence (keybuf, sizeof keybuf / sizeof keybuf[0],
1643 Qnil, 0, 1, 1);
1645 /* A filter may have run while we were reading the input. */
1646 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
1647 Fkill_emacs (Qnil);
1648 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
1649 set_buffer_internal (XBUFFER (XWINDOW (selected_window)->buffer));
1651 ++num_input_keys;
1653 /* Now we have read a key sequence of length I,
1654 or else I is 0 and we found end of file. */
1656 if (i == 0) /* End of file -- happens only in */
1657 return Qnil; /* a kbd macro, at the end. */
1658 /* -1 means read_key_sequence got a menu that was rejected.
1659 Just loop around and read another command. */
1660 if (i == -1)
1662 cancel_echoing ();
1663 this_command_key_count = 0;
1664 this_command_key_count_reset = 0;
1665 this_single_command_key_start = 0;
1666 goto finalize;
1669 last_command_event = keybuf[i - 1];
1671 /* If the previous command tried to force a specific window-start,
1672 forget about that, in case this command moves point far away
1673 from that position. But also throw away beg_unchanged and
1674 end_unchanged information in that case, so that redisplay will
1675 update the whole window properly. */
1676 if (!NILP (XWINDOW (selected_window)->force_start))
1678 struct buffer *b;
1679 XWINDOW (selected_window)->force_start = Qnil;
1680 b = XBUFFER (XWINDOW (selected_window)->buffer);
1681 BUF_BEG_UNCHANGED (b) = BUF_END_UNCHANGED (b) = 0;
1684 cmd = read_key_sequence_cmd;
1685 if (!NILP (Vexecuting_kbd_macro))
1687 if (!NILP (Vquit_flag))
1689 Vexecuting_kbd_macro = Qt;
1690 QUIT; /* Make some noise. */
1691 /* Will return since macro now empty. */
1695 /* Do redisplay processing after this command except in special
1696 cases identified below. */
1697 prev_buffer = current_buffer;
1698 prev_modiff = MODIFF;
1699 last_point_position = PT;
1700 last_point_position_window = selected_window;
1701 XSETBUFFER (last_point_position_buffer, prev_buffer);
1703 /* By default, we adjust point to a boundary of a region that
1704 has such a property that should be treated intangible
1705 (e.g. composition, display). But, some commands will set
1706 this variable differently. */
1707 Vdisable_point_adjustment = Qnil;
1709 /* Process filters and timers may have messed with deactivate-mark.
1710 reset it before we execute the command. */
1711 Vdeactivate_mark = Qnil;
1713 /* Remap command through active keymaps */
1714 Vthis_original_command = cmd;
1715 if (SYMBOLP (cmd))
1717 Lisp_Object cmd1;
1718 if (cmd1 = Fcommand_remapping (cmd, Qnil, Qnil), !NILP (cmd1))
1719 cmd = cmd1;
1722 /* Execute the command. */
1724 Vthis_command = cmd;
1725 real_this_command = cmd;
1726 /* Note that the value cell will never directly contain nil
1727 if the symbol is a local variable. */
1728 if (!NILP (Vpre_command_hook) && !NILP (Vrun_hooks))
1729 safe_run_hooks (Qpre_command_hook);
1731 already_adjusted = 0;
1733 if (NILP (Vthis_command))
1735 /* nil means key is undefined. */
1736 Lisp_Object keys = Fvector (i, keybuf);
1737 keys = Fkey_description (keys, Qnil);
1738 bitch_at_user ();
1739 message_with_string ("%s is undefined", keys, 0);
1740 current_kboard->defining_kbd_macro = Qnil;
1741 update_mode_lines = 1;
1742 current_kboard->Vprefix_arg = Qnil;
1744 else
1746 if (NILP (current_kboard->Vprefix_arg))
1748 /* In case we jump to directly_done. */
1749 Vcurrent_prefix_arg = current_kboard->Vprefix_arg;
1751 /* Recognize some common commands in common situations and
1752 do them directly. */
1753 if (EQ (Vthis_command, Qforward_char) && PT < ZV
1754 && NILP (Vthis_command_keys_shift_translated)
1755 && !CONSP (Vtransient_mark_mode))
1757 struct Lisp_Char_Table *dp
1758 = window_display_table (XWINDOW (selected_window));
1759 lose = FETCH_CHAR (PT_BYTE);
1760 SET_PT (PT + 1);
1761 if (! NILP (Vpost_command_hook))
1762 /* Put this before calling adjust_point_for_property
1763 so it will only get called once in any case. */
1764 goto directly_done;
1765 if (current_buffer == prev_buffer
1766 && last_point_position != PT
1767 && NILP (Vdisable_point_adjustment)
1768 && NILP (Vglobal_disable_point_adjustment))
1769 adjust_point_for_property (last_point_position, 0);
1770 already_adjusted = 1;
1771 if (PT == last_point_position + 1
1772 && (dp
1773 ? (VECTORP (DISP_CHAR_VECTOR (dp, lose))
1774 ? XVECTOR (DISP_CHAR_VECTOR (dp, lose))->size == 1
1775 : (NILP (DISP_CHAR_VECTOR (dp, lose))
1776 && (lose >= 0x20 && lose < 0x7f)))
1777 : (lose >= 0x20 && lose < 0x7f))
1778 /* To extract the case of continuation on
1779 wide-column characters. */
1780 && ASCII_BYTE_P (lose)
1781 && (XFASTINT (XWINDOW (selected_window)->last_modified)
1782 >= MODIFF)
1783 && (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1784 >= OVERLAY_MODIFF)
1785 && (XFASTINT (XWINDOW (selected_window)->last_point)
1786 == PT - 1)
1787 && !windows_or_buffers_changed
1788 && EQ (current_buffer->selective_display, Qnil)
1789 && !detect_input_pending ()
1790 && NILP (XWINDOW (selected_window)->column_number_displayed)
1791 && NILP (Vexecuting_kbd_macro))
1792 direct_output_forward_char (1);
1793 goto directly_done;
1795 else if (EQ (Vthis_command, Qbackward_char) && PT > BEGV
1796 && NILP (Vthis_command_keys_shift_translated)
1797 && !CONSP (Vtransient_mark_mode))
1799 struct Lisp_Char_Table *dp
1800 = window_display_table (XWINDOW (selected_window));
1801 SET_PT (PT - 1);
1802 lose = FETCH_CHAR (PT_BYTE);
1803 if (! NILP (Vpost_command_hook))
1804 goto directly_done;
1805 if (current_buffer == prev_buffer
1806 && last_point_position != PT
1807 && NILP (Vdisable_point_adjustment)
1808 && NILP (Vglobal_disable_point_adjustment))
1809 adjust_point_for_property (last_point_position, 0);
1810 already_adjusted = 1;
1811 if (PT == last_point_position - 1
1812 && (dp
1813 ? (VECTORP (DISP_CHAR_VECTOR (dp, lose))
1814 ? XVECTOR (DISP_CHAR_VECTOR (dp, lose))->size == 1
1815 : (NILP (DISP_CHAR_VECTOR (dp, lose))
1816 && (lose >= 0x20 && lose < 0x7f)))
1817 : (lose >= 0x20 && lose < 0x7f))
1818 && (XFASTINT (XWINDOW (selected_window)->last_modified)
1819 >= MODIFF)
1820 && (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1821 >= OVERLAY_MODIFF)
1822 && (XFASTINT (XWINDOW (selected_window)->last_point)
1823 == PT + 1)
1824 && !windows_or_buffers_changed
1825 && EQ (current_buffer->selective_display, Qnil)
1826 && !detect_input_pending ()
1827 && NILP (XWINDOW (selected_window)->column_number_displayed)
1828 && NILP (Vexecuting_kbd_macro))
1829 direct_output_forward_char (-1);
1830 goto directly_done;
1832 else if (EQ (Vthis_command, Qself_insert_command)
1833 /* Try this optimization only on char keystrokes. */
1834 && NATNUMP (last_command_event)
1835 && CHAR_VALID_P (XFASTINT (last_command_event), 0))
1837 unsigned int c
1838 = translate_char (Vtranslation_table_for_input,
1839 XFASTINT (last_command_event));
1840 int value;
1841 if (NILP (Vexecuting_kbd_macro)
1842 && !EQ (minibuf_window, selected_window))
1844 if (!nonundocount || nonundocount >= 20)
1846 Fundo_boundary ();
1847 nonundocount = 0;
1849 nonundocount++;
1852 lose = ((XFASTINT (XWINDOW (selected_window)->last_modified)
1853 < MODIFF)
1854 || (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1855 < OVERLAY_MODIFF)
1856 || (XFASTINT (XWINDOW (selected_window)->last_point)
1857 != PT)
1858 || MODIFF <= SAVE_MODIFF
1859 || windows_or_buffers_changed
1860 || !EQ (current_buffer->selective_display, Qnil)
1861 || detect_input_pending ()
1862 || !NILP (XWINDOW (selected_window)->column_number_displayed)
1863 || !NILP (Vexecuting_kbd_macro));
1865 value = internal_self_insert (c, 0);
1867 if (value == 2)
1868 nonundocount = 0;
1870 if (! NILP (Vpost_command_hook))
1871 /* Put this before calling adjust_point_for_property
1872 so it will only get called once in any case. */
1873 goto directly_done;
1875 /* VALUE == 1 when AFTER-CHANGE functions are
1876 installed which is the case most of the time
1877 because FONT-LOCK installs one. */
1878 if (!lose && !value)
1879 direct_output_for_insert (c);
1880 goto directly_done;
1884 /* Here for a command that isn't executed directly */
1887 #ifdef HAVE_WINDOW_SYSTEM
1888 int scount = SPECPDL_INDEX ();
1890 if (display_hourglass_p
1891 && NILP (Vexecuting_kbd_macro))
1893 record_unwind_protect (cancel_hourglass_unwind, Qnil);
1894 start_hourglass ();
1896 #endif
1898 nonundocount = 0;
1899 if (NILP (current_kboard->Vprefix_arg))
1900 Fundo_boundary ();
1901 Fcommand_execute (Vthis_command, Qnil, Qnil, Qnil);
1903 #ifdef HAVE_WINDOW_SYSTEM
1904 /* Do not check display_hourglass_p here, because
1905 Fcommand_execute could change it, but we should cancel
1906 hourglass cursor anyway.
1907 But don't cancel the hourglass within a macro
1908 just because a command in the macro finishes. */
1909 if (NILP (Vexecuting_kbd_macro))
1910 unbind_to (scount, Qnil);
1911 #endif
1914 directly_done: ;
1915 current_kboard->Vlast_prefix_arg = Vcurrent_prefix_arg;
1917 /* Note that the value cell will never directly contain nil
1918 if the symbol is a local variable. */
1919 if (!NILP (Vpost_command_hook) && !NILP (Vrun_hooks))
1920 safe_run_hooks (Qpost_command_hook);
1922 /* If displaying a message, resize the echo area window to fit
1923 that message's size exactly. */
1924 if (!NILP (echo_area_buffer[0]))
1925 resize_echo_area_exactly ();
1927 if (!NILP (Vdeferred_action_list))
1928 safe_run_hooks (Qdeferred_action_function);
1930 /* If there is a prefix argument,
1931 1) We don't want Vlast_command to be ``universal-argument''
1932 (that would be dumb), so don't set Vlast_command,
1933 2) we want to leave echoing on so that the prefix will be
1934 echoed as part of this key sequence, so don't call
1935 cancel_echoing, and
1936 3) we want to leave this_command_key_count non-zero, so that
1937 read_char will realize that it is re-reading a character, and
1938 not echo it a second time.
1940 If the command didn't actually create a prefix arg,
1941 but is merely a frame event that is transparent to prefix args,
1942 then the above doesn't apply. */
1943 if (NILP (current_kboard->Vprefix_arg) || CONSP (last_command_event))
1945 current_kboard->Vlast_command = Vthis_command;
1946 current_kboard->Vreal_last_command = real_this_command;
1947 if (!CONSP (last_command_event))
1948 current_kboard->Vlast_repeatable_command = real_this_command;
1949 cancel_echoing ();
1950 this_command_key_count = 0;
1951 this_command_key_count_reset = 0;
1952 this_single_command_key_start = 0;
1955 if (!NILP (current_buffer->mark_active) && !NILP (Vrun_hooks))
1957 /* In Emacs 22, setting transient-mark-mode to `only' was a
1958 way of turning it on for just one command. This usage is
1959 obsolete, but support it anyway. */
1960 if (EQ (Vtransient_mark_mode, Qidentity))
1961 Vtransient_mark_mode = Qnil;
1962 else if (EQ (Vtransient_mark_mode, Qonly))
1963 Vtransient_mark_mode = Qidentity;
1965 if (!NILP (Vdeactivate_mark))
1966 call0 (Qdeactivate_mark);
1967 else if (current_buffer != prev_buffer || MODIFF != prev_modiff)
1968 call1 (Vrun_hooks, intern ("activate-mark-hook"));
1971 finalize:
1973 if (current_buffer == prev_buffer
1974 && last_point_position != PT
1975 && NILP (Vdisable_point_adjustment)
1976 && NILP (Vglobal_disable_point_adjustment)
1977 && !already_adjusted)
1978 adjust_point_for_property (last_point_position, MODIFF != prev_modiff);
1980 /* Install chars successfully executed in kbd macro. */
1982 if (!NILP (current_kboard->defining_kbd_macro)
1983 && NILP (current_kboard->Vprefix_arg))
1984 finalize_kbd_macro_chars ();
1985 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1986 if (!was_locked)
1987 any_kboard_state ();
1988 #endif
1992 extern Lisp_Object Qcomposition, Qdisplay;
1994 /* Adjust point to a boundary of a region that has such a property
1995 that should be treated intangible. For the moment, we check
1996 `composition', `display' and `invisible' properties.
1997 LAST_PT is the last position of point. */
1999 extern Lisp_Object Qafter_string, Qbefore_string;
2000 extern Lisp_Object get_pos_property P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
2002 static void
2003 adjust_point_for_property (last_pt, modified)
2004 int last_pt;
2005 int modified;
2007 EMACS_INT beg, end;
2008 Lisp_Object val, overlay, tmp;
2009 int check_composition = 1, check_display = 1, check_invisible = 1;
2010 int orig_pt = PT;
2012 /* FIXME: cycling is probably not necessary because these properties
2013 can't be usefully combined anyway. */
2014 while (check_composition || check_display || check_invisible)
2016 /* FIXME: check `intangible'. */
2017 if (check_composition
2018 && PT > BEGV && PT < ZV
2019 && (beg = composition_adjust_point (last_pt)) != PT)
2021 SET_PT (beg);
2022 check_display = check_invisible = 1;
2024 check_composition = 0;
2025 if (check_display
2026 && PT > BEGV && PT < ZV
2027 && !NILP (val = get_char_property_and_overlay
2028 (make_number (PT), Qdisplay, Qnil, &overlay))
2029 && display_prop_intangible_p (val)
2030 && (!OVERLAYP (overlay)
2031 ? get_property_and_range (PT, Qdisplay, &val, &beg, &end, Qnil)
2032 : (beg = OVERLAY_POSITION (OVERLAY_START (overlay)),
2033 end = OVERLAY_POSITION (OVERLAY_END (overlay))))
2034 && (beg < PT /* && end > PT <- It's always the case. */
2035 || (beg <= PT && STRINGP (val) && SCHARS (val) == 0)))
2037 xassert (end > PT);
2038 SET_PT (PT < last_pt
2039 ? (STRINGP (val) && SCHARS (val) == 0 ? beg - 1 : beg)
2040 : end);
2041 check_composition = check_invisible = 1;
2043 check_display = 0;
2044 if (check_invisible && PT > BEGV && PT < ZV)
2046 int inv, ellipsis = 0;
2047 beg = end = PT;
2049 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2050 while (end < ZV
2051 /* Stop if we find a spot between two runs of
2052 `invisible' where inserted text would be visible.
2053 This is important when we have two invisible
2054 boundaries that enclose an area: if the area is
2055 empty, we need this test in order to make it
2056 possible to place point in the middle rather than
2057 skip both boundaries.
2058 Note that this will stop anywhere in a non-sticky
2059 text-property, but I don't think there's much we
2060 can do about that. */
2061 && (val = get_pos_property (make_number (end),
2062 Qinvisible, Qnil),
2063 TEXT_PROP_MEANS_INVISIBLE (val))
2064 /* FIXME: write and then use get_pos_property_and_overlay. */
2065 && !NILP (val = get_char_property_and_overlay
2066 (make_number (end), Qinvisible, Qnil, &overlay))
2067 && (inv = TEXT_PROP_MEANS_INVISIBLE (val)))
2069 ellipsis = ellipsis || inv > 1
2070 || (OVERLAYP (overlay)
2071 && (!NILP (Foverlay_get (overlay, Qafter_string))
2072 || !NILP (Foverlay_get (overlay, Qbefore_string))));
2073 tmp = Fnext_single_char_property_change
2074 (make_number (end), Qinvisible, Qnil, Qnil);
2075 end = NATNUMP (tmp) ? XFASTINT (tmp) : ZV;
2077 while (beg > BEGV
2078 && (val = get_pos_property (make_number (beg),
2079 Qinvisible, Qnil),
2080 TEXT_PROP_MEANS_INVISIBLE (val))
2081 && !NILP (val = get_char_property_and_overlay
2082 (make_number (beg - 1), Qinvisible, Qnil, &overlay))
2083 && (inv = TEXT_PROP_MEANS_INVISIBLE (val)))
2085 ellipsis = ellipsis || inv > 1
2086 || (OVERLAYP (overlay)
2087 && (!NILP (Foverlay_get (overlay, Qafter_string))
2088 || !NILP (Foverlay_get (overlay, Qbefore_string))));
2089 tmp = Fprevious_single_char_property_change
2090 (make_number (beg), Qinvisible, Qnil, Qnil);
2091 beg = NATNUMP (tmp) ? XFASTINT (tmp) : BEGV;
2094 /* Move away from the inside area. */
2095 if (beg < PT && end > PT)
2097 SET_PT ((orig_pt == PT && (last_pt < beg || last_pt > end))
2098 /* We haven't moved yet (so we don't need to fear
2099 infinite-looping) and we were outside the range
2100 before (so either end of the range still corresponds
2101 to a move in the right direction): pretend we moved
2102 less than we actually did, so that we still have
2103 more freedom below in choosing which end of the range
2104 to go to. */
2105 ? (orig_pt = -1, PT < last_pt ? end : beg)
2106 /* We either have moved already or the last point
2107 was already in the range: we don't get to choose
2108 which end of the range we have to go to. */
2109 : (PT < last_pt ? beg : end));
2110 check_composition = check_display = 1;
2112 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2113 the point to something other than its argument, due to
2114 point-motion hooks, intangibility, etc. */
2115 xassert (PT == beg || PT == end);
2116 #endif
2118 /* Pretend the area doesn't exist if the buffer is not
2119 modified. */
2120 if (!modified && !ellipsis && beg < end)
2122 if (last_pt == beg && PT == end && end < ZV)
2123 (check_composition = check_display = 1, SET_PT (end + 1));
2124 else if (last_pt == end && PT == beg && beg > BEGV)
2125 (check_composition = check_display = 1, SET_PT (beg - 1));
2126 else if (PT == ((PT < last_pt) ? beg : end))
2127 /* We've already moved as far as we can. Trying to go
2128 to the other end would mean moving backwards and thus
2129 could lead to an infinite loop. */
2131 else if (val = get_pos_property (make_number (PT),
2132 Qinvisible, Qnil),
2133 TEXT_PROP_MEANS_INVISIBLE (val)
2134 && (val = get_pos_property
2135 (make_number (PT == beg ? end : beg),
2136 Qinvisible, Qnil),
2137 !TEXT_PROP_MEANS_INVISIBLE (val)))
2138 (check_composition = check_display = 1,
2139 SET_PT (PT == beg ? end : beg));
2142 check_invisible = 0;
2146 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2148 static Lisp_Object
2149 safe_run_hooks_1 (hook)
2150 Lisp_Object hook;
2152 if (NILP (Vrun_hooks))
2153 return Qnil;
2154 return call1 (Vrun_hooks, Vinhibit_quit);
2157 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2159 static Lisp_Object
2160 safe_run_hooks_error (data)
2161 Lisp_Object data;
2163 Lisp_Object args[3];
2164 args[0] = build_string ("Error in %s: %s");
2165 args[1] = Vinhibit_quit;
2166 args[2] = data;
2167 Fmessage (3, args);
2168 return Fset (Vinhibit_quit, Qnil);
2171 /* If we get an error while running the hook, cause the hook variable
2172 to be nil. Also inhibit quits, so that C-g won't cause the hook
2173 to mysteriously evaporate. */
2175 void
2176 safe_run_hooks (hook)
2177 Lisp_Object hook;
2179 int count = SPECPDL_INDEX ();
2180 specbind (Qinhibit_quit, hook);
2182 internal_condition_case (safe_run_hooks_1, Qt, safe_run_hooks_error);
2184 unbind_to (count, Qnil);
2188 /* Number of seconds between polling for input. This is a Lisp
2189 variable that can be bound. */
2191 EMACS_INT polling_period;
2193 /* Nonzero means polling for input is temporarily suppressed. */
2195 int poll_suppress_count;
2197 /* Asynchronous timer for polling. */
2199 struct atimer *poll_timer;
2202 #ifdef POLL_FOR_INPUT
2204 /* Poll for input, so that we catch a C-g if it comes in. This
2205 function is called from x_make_frame_visible, see comment
2206 there. */
2208 void
2209 poll_for_input_1 ()
2211 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
2212 doing anything dangerous. */
2213 #ifdef HAVE_NS
2214 ++handling_signal;
2215 #endif
2216 if (interrupt_input_blocked == 0
2217 && !waiting_for_input)
2218 read_avail_input (0);
2219 #ifdef HAVE_NS
2220 --handling_signal;
2221 #endif
2224 /* Timer callback function for poll_timer. TIMER is equal to
2225 poll_timer. */
2227 void
2228 poll_for_input (timer)
2229 struct atimer *timer;
2231 if (poll_suppress_count == 0)
2233 #ifdef SYNC_INPUT
2234 interrupt_input_pending = 1;
2235 pending_signals = 1;
2236 #else
2237 poll_for_input_1 ();
2238 #endif
2242 #endif /* POLL_FOR_INPUT */
2244 /* Begin signals to poll for input, if they are appropriate.
2245 This function is called unconditionally from various places. */
2247 void
2248 start_polling ()
2250 #ifdef POLL_FOR_INPUT
2251 /* XXX This condition was (read_socket_hook && !interrupt_input),
2252 but read_socket_hook is not global anymore. Let's pretend that
2253 it's always set. */
2254 if (!interrupt_input)
2256 /* Turn alarm handling on unconditionally. It might have
2257 been turned off in process.c. */
2258 turn_on_atimers (1);
2260 /* If poll timer doesn't exist, are we need one with
2261 a different interval, start a new one. */
2262 if (poll_timer == NULL
2263 || EMACS_SECS (poll_timer->interval) != polling_period)
2265 EMACS_TIME interval;
2267 if (poll_timer)
2268 cancel_atimer (poll_timer);
2270 EMACS_SET_SECS_USECS (interval, polling_period, 0);
2271 poll_timer = start_atimer (ATIMER_CONTINUOUS, interval,
2272 poll_for_input, NULL);
2275 /* Let the timer's callback function poll for input
2276 if this becomes zero. */
2277 --poll_suppress_count;
2279 #endif
2282 /* Nonzero if we are using polling to handle input asynchronously. */
2285 input_polling_used ()
2287 #ifdef POLL_FOR_INPUT
2288 /* XXX This condition was (read_socket_hook && !interrupt_input),
2289 but read_socket_hook is not global anymore. Let's pretend that
2290 it's always set. */
2291 return !interrupt_input;
2292 #else
2293 return 0;
2294 #endif
2297 /* Turn off polling. */
2299 void
2300 stop_polling ()
2302 #ifdef POLL_FOR_INPUT
2303 /* XXX This condition was (read_socket_hook && !interrupt_input),
2304 but read_socket_hook is not global anymore. Let's pretend that
2305 it's always set. */
2306 if (!interrupt_input)
2307 ++poll_suppress_count;
2308 #endif
2311 /* Set the value of poll_suppress_count to COUNT
2312 and start or stop polling accordingly. */
2314 void
2315 set_poll_suppress_count (count)
2316 int count;
2318 #ifdef POLL_FOR_INPUT
2319 if (count == 0 && poll_suppress_count != 0)
2321 poll_suppress_count = 1;
2322 start_polling ();
2324 else if (count != 0 && poll_suppress_count == 0)
2326 stop_polling ();
2328 poll_suppress_count = count;
2329 #endif
2332 /* Bind polling_period to a value at least N.
2333 But don't decrease it. */
2335 void
2336 bind_polling_period (n)
2337 int n;
2339 #ifdef POLL_FOR_INPUT
2340 int new = polling_period;
2342 if (n > new)
2343 new = n;
2345 stop_other_atimers (poll_timer);
2346 stop_polling ();
2347 specbind (Qpolling_period, make_number (new));
2348 /* Start a new alarm with the new period. */
2349 start_polling ();
2350 #endif
2353 /* Apply the control modifier to CHARACTER. */
2356 make_ctrl_char (c)
2357 int c;
2359 /* Save the upper bits here. */
2360 int upper = c & ~0177;
2362 if (! ASCII_BYTE_P (c))
2363 return c |= ctrl_modifier;
2365 c &= 0177;
2367 /* Everything in the columns containing the upper-case letters
2368 denotes a control character. */
2369 if (c >= 0100 && c < 0140)
2371 int oc = c;
2372 c &= ~0140;
2373 /* Set the shift modifier for a control char
2374 made from a shifted letter. But only for letters! */
2375 if (oc >= 'A' && oc <= 'Z')
2376 c |= shift_modifier;
2379 /* The lower-case letters denote control characters too. */
2380 else if (c >= 'a' && c <= 'z')
2381 c &= ~0140;
2383 /* Include the bits for control and shift
2384 only if the basic ASCII code can't indicate them. */
2385 else if (c >= ' ')
2386 c |= ctrl_modifier;
2388 /* Replace the high bits. */
2389 c |= (upper & ~ctrl_modifier);
2391 return c;
2394 /* Display the help-echo property of the character after the mouse pointer.
2395 Either show it in the echo area, or call show-help-function to display
2396 it by other means (maybe in a tooltip).
2398 If HELP is nil, that means clear the previous help echo.
2400 If HELP is a string, display that string. If HELP is a function,
2401 call it with OBJECT and POS as arguments; the function should
2402 return a help string or nil for none. For all other types of HELP,
2403 evaluate it to obtain a string.
2405 WINDOW is the window in which the help was generated, if any.
2406 It is nil if not in a window.
2408 If OBJECT is a buffer, POS is the position in the buffer where the
2409 `help-echo' text property was found.
2411 If OBJECT is an overlay, that overlay has a `help-echo' property,
2412 and POS is the position in the overlay's buffer under the mouse.
2414 If OBJECT is a string (an overlay string or a string displayed with
2415 the `display' property). POS is the position in that string under
2416 the mouse.
2418 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2419 echo overwrites a keystroke echo currently displayed in the echo
2420 area.
2422 Note: this function may only be called with HELP nil or a string
2423 from X code running asynchronously. */
2425 void
2426 show_help_echo (help, window, object, pos, ok_to_overwrite_keystroke_echo)
2427 Lisp_Object help, window, object, pos;
2428 int ok_to_overwrite_keystroke_echo;
2430 if (!NILP (help) && !STRINGP (help))
2432 if (FUNCTIONP (help))
2434 Lisp_Object args[4];
2435 args[0] = help;
2436 args[1] = window;
2437 args[2] = object;
2438 args[3] = pos;
2439 help = safe_call (4, args);
2441 else
2442 help = safe_eval (help);
2444 if (!STRINGP (help))
2445 return;
2448 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2449 if (!noninteractive && STRINGP (help))
2451 /* The mouse-fixup-help-message Lisp function can call
2452 mouse_position_hook, which resets the mouse_moved flags.
2453 This causes trouble if we are trying to read a mouse motion
2454 event (i.e., if we are inside a `track-mouse' form), so we
2455 restore the mouse_moved flag. */
2456 FRAME_PTR f = NILP (do_mouse_tracking) ? NULL : some_mouse_moved ();
2457 help = call1 (Qmouse_fixup_help_message, help);
2458 if (f)
2459 f->mouse_moved = 1;
2461 #endif
2463 if (STRINGP (help) || NILP (help))
2465 if (!NILP (Vshow_help_function))
2466 call1 (Vshow_help_function, help);
2467 help_echo_showing_p = STRINGP (help);
2473 /* Input of single characters from keyboard */
2475 Lisp_Object print_help ();
2476 static Lisp_Object kbd_buffer_get_event ();
2477 static void record_char ();
2479 static Lisp_Object help_form_saved_window_configs;
2480 static Lisp_Object
2481 read_char_help_form_unwind (Lisp_Object arg)
2483 Lisp_Object window_config = XCAR (help_form_saved_window_configs);
2484 help_form_saved_window_configs = XCDR (help_form_saved_window_configs);
2485 if (!NILP (window_config))
2486 Fset_window_configuration (window_config);
2487 return Qnil;
2490 #define STOP_POLLING \
2491 do { if (! polling_stopped_here) stop_polling (); \
2492 polling_stopped_here = 1; } while (0)
2494 #define RESUME_POLLING \
2495 do { if (polling_stopped_here) start_polling (); \
2496 polling_stopped_here = 0; } while (0)
2498 /* read a character from the keyboard; call the redisplay if needed */
2499 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2500 -1 means do not do redisplay, but do do autosaving.
2501 1 means do both. */
2503 /* The arguments MAPS and NMAPS are for menu prompting.
2504 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2506 PREV_EVENT is the previous input event, or nil if we are reading
2507 the first event of a key sequence (or not reading a key sequence).
2508 If PREV_EVENT is t, that is a "magic" value that says
2509 not to run input methods, but in other respects to act as if
2510 not reading a key sequence.
2512 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2513 if we used a mouse menu to read the input, or zero otherwise. If
2514 USED_MOUSE_MENU is null, we don't dereference it.
2516 Value is -2 when we find input on another keyboard. A second call
2517 to read_char will read it.
2519 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2520 specifying the maximum time to wait until. If no input arrives by
2521 that time, stop waiting and return nil.
2523 Value is t if we showed a menu and the user rejected it. */
2525 Lisp_Object
2526 read_char (commandflag, nmaps, maps, prev_event, used_mouse_menu, end_time)
2527 int commandflag;
2528 int nmaps;
2529 Lisp_Object *maps;
2530 Lisp_Object prev_event;
2531 int *used_mouse_menu;
2532 EMACS_TIME *end_time;
2534 volatile Lisp_Object c;
2535 int count, jmpcount;
2536 jmp_buf local_getcjmp;
2537 jmp_buf save_jump;
2538 volatile int key_already_recorded = 0;
2539 Lisp_Object tem, save;
2540 volatile Lisp_Object previous_echo_area_message;
2541 volatile Lisp_Object also_record;
2542 volatile int reread;
2543 struct gcpro gcpro1, gcpro2;
2544 int polling_stopped_here = 0;
2545 struct kboard *orig_kboard = current_kboard;
2547 also_record = Qnil;
2549 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2550 before_command_key_count = this_command_key_count;
2551 before_command_echo_length = echo_length ();
2552 #endif
2553 c = Qnil;
2554 previous_echo_area_message = Qnil;
2556 GCPRO2 (c, previous_echo_area_message);
2558 retry:
2560 reread = 0;
2561 if (CONSP (Vunread_post_input_method_events))
2563 c = XCAR (Vunread_post_input_method_events);
2564 Vunread_post_input_method_events
2565 = XCDR (Vunread_post_input_method_events);
2567 /* Undo what read_char_x_menu_prompt did when it unread
2568 additional keys returned by Fx_popup_menu. */
2569 if (CONSP (c)
2570 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c)))
2571 && NILP (XCDR (c)))
2572 c = XCAR (c);
2574 reread = 1;
2575 goto reread_first;
2578 if (unread_command_char != -1)
2580 XSETINT (c, unread_command_char);
2581 unread_command_char = -1;
2583 reread = 1;
2584 goto reread_first;
2587 if (CONSP (Vunread_command_events))
2589 int was_disabled = 0;
2591 c = XCAR (Vunread_command_events);
2592 Vunread_command_events = XCDR (Vunread_command_events);
2594 reread = 1;
2596 /* Undo what sit-for did when it unread additional keys
2597 inside universal-argument. */
2599 if (CONSP (c)
2600 && EQ (XCAR (c), Qt))
2602 reread = 0;
2603 c = XCDR (c);
2606 /* Undo what read_char_x_menu_prompt did when it unread
2607 additional keys returned by Fx_popup_menu. */
2608 if (CONSP (c)
2609 && EQ (XCDR (c), Qdisabled)
2610 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c))))
2612 was_disabled = 1;
2613 c = XCAR (c);
2616 /* If the queued event is something that used the mouse,
2617 set used_mouse_menu accordingly. */
2618 if (used_mouse_menu
2619 /* Also check was_disabled so last-nonmenu-event won't return
2620 a bad value when submenus are involved. (Bug#447) */
2621 && (EQ (c, Qtool_bar) || EQ (c, Qmenu_bar) || was_disabled))
2622 *used_mouse_menu = 1;
2624 goto reread_for_input_method;
2627 if (CONSP (Vunread_input_method_events))
2629 c = XCAR (Vunread_input_method_events);
2630 Vunread_input_method_events = XCDR (Vunread_input_method_events);
2632 /* Undo what read_char_x_menu_prompt did when it unread
2633 additional keys returned by Fx_popup_menu. */
2634 if (CONSP (c)
2635 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c)))
2636 && NILP (XCDR (c)))
2637 c = XCAR (c);
2638 reread = 1;
2639 goto reread_for_input_method;
2642 this_command_key_count_reset = 0;
2644 if (!NILP (Vexecuting_kbd_macro))
2646 /* We set this to Qmacro; since that's not a frame, nobody will
2647 try to switch frames on us, and the selected window will
2648 remain unchanged.
2650 Since this event came from a macro, it would be misleading to
2651 leave internal_last_event_frame set to wherever the last
2652 real event came from. Normally, a switch-frame event selects
2653 internal_last_event_frame after each command is read, but
2654 events read from a macro should never cause a new frame to be
2655 selected. */
2656 Vlast_event_frame = internal_last_event_frame = Qmacro;
2658 /* Exit the macro if we are at the end.
2659 Also, some things replace the macro with t
2660 to force an early exit. */
2661 if (EQ (Vexecuting_kbd_macro, Qt)
2662 || executing_kbd_macro_index >= XFASTINT (Flength (Vexecuting_kbd_macro)))
2664 XSETINT (c, -1);
2665 goto exit;
2668 c = Faref (Vexecuting_kbd_macro, make_number (executing_kbd_macro_index));
2669 if (STRINGP (Vexecuting_kbd_macro)
2670 && (XINT (c) & 0x80) && (XUINT (c) <= 0xff))
2671 XSETFASTINT (c, CHAR_META | (XINT (c) & ~0x80));
2673 executing_kbd_macro_index++;
2675 goto from_macro;
2678 if (!NILP (unread_switch_frame))
2680 c = unread_switch_frame;
2681 unread_switch_frame = Qnil;
2683 /* This event should make it into this_command_keys, and get echoed
2684 again, so we do not set `reread'. */
2685 goto reread_first;
2688 /* if redisplay was requested */
2689 if (commandflag >= 0)
2691 int echo_current = EQ (echo_message_buffer, echo_area_buffer[0]);
2693 /* If there is pending input, process any events which are not
2694 user-visible, such as X selection_request events. */
2695 if (input_pending
2696 || detect_input_pending_run_timers (0))
2697 swallow_events (0); /* may clear input_pending */
2699 /* Redisplay if no pending input. */
2700 while (!input_pending)
2702 if (help_echo_showing_p && !EQ (selected_window, minibuf_window))
2703 redisplay_preserve_echo_area (5);
2704 else
2705 redisplay ();
2707 if (!input_pending)
2708 /* Normal case: no input arrived during redisplay. */
2709 break;
2711 /* Input arrived and pre-empted redisplay.
2712 Process any events which are not user-visible. */
2713 swallow_events (0);
2714 /* If that cleared input_pending, try again to redisplay. */
2717 /* Prevent the redisplay we just did
2718 from messing up echoing of the input after the prompt. */
2719 if (commandflag == 0 && echo_current)
2720 echo_message_buffer = echo_area_buffer[0];
2724 /* Message turns off echoing unless more keystrokes turn it on again.
2726 The code in 20.x for the condition was
2728 1. echo_area_glyphs && *echo_area_glyphs
2729 2. && echo_area_glyphs != current_kboard->echobuf
2730 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2732 (1) means there's a current message displayed
2734 (2) means it's not the message from echoing from the current
2735 kboard.
2737 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2738 is set to a non-null value. This is done in read_char and it is
2739 set to echo_area_glyphs after a call to echo_char. That means
2740 ok_to_echo_at_next_pause is either null or
2741 current_kboard->echobuf with the appropriate current_kboard at
2742 that time.
2744 So, condition (3) means in clear text ok_to_echo_at_next_pause
2745 must be either null, or the current message isn't from echoing at
2746 all, or it's from echoing from a different kboard than the
2747 current one. */
2749 if (/* There currently is something in the echo area. */
2750 !NILP (echo_area_buffer[0])
2751 && (/* And it's either not from echoing. */
2752 !EQ (echo_area_buffer[0], echo_message_buffer)
2753 /* Or it's an echo from a different kboard. */
2754 || echo_kboard != current_kboard
2755 /* Or we explicitly allow overwriting whatever there is. */
2756 || ok_to_echo_at_next_pause == NULL))
2757 cancel_echoing ();
2758 else
2759 echo_dash ();
2761 /* Try reading a character via menu prompting in the minibuf.
2762 Try this before the sit-for, because the sit-for
2763 would do the wrong thing if we are supposed to do
2764 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2765 after a mouse event so don't try a minibuf menu. */
2766 c = Qnil;
2767 if (nmaps > 0 && INTERACTIVE
2768 && !NILP (prev_event) && ! EVENT_HAS_PARAMETERS (prev_event)
2769 /* Don't bring up a menu if we already have another event. */
2770 && NILP (Vunread_command_events)
2771 && unread_command_char < 0
2772 && !detect_input_pending_run_timers (0))
2774 c = read_char_minibuf_menu_prompt (commandflag, nmaps, maps);
2776 if (INTEGERP (c) && XINT (c) == -2)
2777 return c; /* wrong_kboard_jmpbuf */
2779 if (! NILP (c))
2781 key_already_recorded = 1;
2782 goto non_reread_1;
2786 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2787 We will do that below, temporarily for short sections of code,
2788 when appropriate. local_getcjmp must be in effect
2789 around any call to sit_for or kbd_buffer_get_event;
2790 it *must not* be in effect when we call redisplay. */
2792 jmpcount = SPECPDL_INDEX ();
2793 if (_setjmp (local_getcjmp))
2795 /* Handle quits while reading the keyboard. */
2796 /* We must have saved the outer value of getcjmp here,
2797 so restore it now. */
2798 restore_getcjmp (save_jump);
2799 unbind_to (jmpcount, Qnil);
2800 XSETINT (c, quit_char);
2801 internal_last_event_frame = selected_frame;
2802 Vlast_event_frame = internal_last_event_frame;
2803 /* If we report the quit char as an event,
2804 don't do so more than once. */
2805 if (!NILP (Vinhibit_quit))
2806 Vquit_flag = Qnil;
2809 KBOARD *kb = FRAME_KBOARD (XFRAME (selected_frame));
2810 if (kb != current_kboard)
2812 Lisp_Object link = kb->kbd_queue;
2813 /* We shouldn't get here if we were in single-kboard mode! */
2814 if (single_kboard)
2815 abort ();
2816 if (CONSP (link))
2818 while (CONSP (XCDR (link)))
2819 link = XCDR (link);
2820 if (!NILP (XCDR (link)))
2821 abort ();
2823 if (!CONSP (link))
2824 kb->kbd_queue = Fcons (c, Qnil);
2825 else
2826 XSETCDR (link, Fcons (c, Qnil));
2827 kb->kbd_queue_has_data = 1;
2828 current_kboard = kb;
2829 /* This is going to exit from read_char
2830 so we had better get rid of this frame's stuff. */
2831 UNGCPRO;
2832 return make_number (-2); /* wrong_kboard_jmpbuf */
2835 goto non_reread;
2838 /* Start idle timers if no time limit is supplied. We don't do it
2839 if a time limit is supplied to avoid an infinite recursion in the
2840 situation where an idle timer calls `sit-for'. */
2842 if (!end_time)
2843 timer_start_idle ();
2845 /* If in middle of key sequence and minibuffer not active,
2846 start echoing if enough time elapses. */
2848 if (minibuf_level == 0
2849 && !end_time
2850 && !current_kboard->immediate_echo
2851 && this_command_key_count > 0
2852 && ! noninteractive
2853 && (FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
2854 && NILP (Fzerop (Vecho_keystrokes))
2855 && (/* No message. */
2856 NILP (echo_area_buffer[0])
2857 /* Or empty message. */
2858 || (BUF_BEG (XBUFFER (echo_area_buffer[0]))
2859 == BUF_Z (XBUFFER (echo_area_buffer[0])))
2860 /* Or already echoing from same kboard. */
2861 || (echo_kboard && ok_to_echo_at_next_pause == echo_kboard)
2862 /* Or not echoing before and echoing allowed. */
2863 || (!echo_kboard && ok_to_echo_at_next_pause)))
2865 /* After a mouse event, start echoing right away.
2866 This is because we are probably about to display a menu,
2867 and we don't want to delay before doing so. */
2868 if (EVENT_HAS_PARAMETERS (prev_event))
2869 echo_now ();
2870 else
2872 Lisp_Object tem0;
2874 save_getcjmp (save_jump);
2875 restore_getcjmp (local_getcjmp);
2876 tem0 = sit_for (Vecho_keystrokes, 1, 1);
2877 restore_getcjmp (save_jump);
2878 if (EQ (tem0, Qt)
2879 && ! CONSP (Vunread_command_events))
2880 echo_now ();
2884 /* Maybe auto save due to number of keystrokes. */
2886 if (commandflag != 0
2887 && auto_save_interval > 0
2888 && num_nonmacro_input_events - last_auto_save > max (auto_save_interval, 20)
2889 && !detect_input_pending_run_timers (0))
2891 Fdo_auto_save (Qnil, Qnil);
2892 /* Hooks can actually change some buffers in auto save. */
2893 redisplay ();
2896 /* Try reading using an X menu.
2897 This is never confused with reading using the minibuf
2898 because the recursive call of read_char in read_char_minibuf_menu_prompt
2899 does not pass on any keymaps. */
2901 if (nmaps > 0 && INTERACTIVE
2902 && !NILP (prev_event)
2903 && EVENT_HAS_PARAMETERS (prev_event)
2904 && !EQ (XCAR (prev_event), Qmenu_bar)
2905 && !EQ (XCAR (prev_event), Qtool_bar)
2906 /* Don't bring up a menu if we already have another event. */
2907 && NILP (Vunread_command_events)
2908 && unread_command_char < 0)
2910 c = read_char_x_menu_prompt (nmaps, maps, prev_event, used_mouse_menu);
2912 /* Now that we have read an event, Emacs is not idle. */
2913 if (!end_time)
2914 timer_stop_idle ();
2916 goto exit;
2919 /* Maybe autosave and/or garbage collect due to idleness. */
2921 if (INTERACTIVE && NILP (c))
2923 int delay_level, buffer_size;
2925 /* Slow down auto saves logarithmically in size of current buffer,
2926 and garbage collect while we're at it. */
2927 if (! MINI_WINDOW_P (XWINDOW (selected_window)))
2928 last_non_minibuf_size = Z - BEG;
2929 buffer_size = (last_non_minibuf_size >> 8) + 1;
2930 delay_level = 0;
2931 while (buffer_size > 64)
2932 delay_level++, buffer_size -= buffer_size >> 2;
2933 if (delay_level < 4) delay_level = 4;
2934 /* delay_level is 4 for files under around 50k, 7 at 100k,
2935 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2937 /* Auto save if enough time goes by without input. */
2938 if (commandflag != 0
2939 && num_nonmacro_input_events > last_auto_save
2940 && INTEGERP (Vauto_save_timeout)
2941 && XINT (Vauto_save_timeout) > 0)
2943 Lisp_Object tem0;
2944 int timeout = delay_level * XFASTINT (Vauto_save_timeout) / 4;
2946 save_getcjmp (save_jump);
2947 restore_getcjmp (local_getcjmp);
2948 tem0 = sit_for (make_number (timeout), 1, 1);
2949 restore_getcjmp (save_jump);
2951 if (EQ (tem0, Qt)
2952 && ! CONSP (Vunread_command_events))
2954 Fdo_auto_save (Qnil, Qnil);
2956 /* If we have auto-saved and there is still no input
2957 available, garbage collect if there has been enough
2958 consing going on to make it worthwhile. */
2959 if (!detect_input_pending_run_timers (0)
2960 && consing_since_gc > gc_cons_threshold / 2)
2961 Fgarbage_collect ();
2963 redisplay ();
2968 /* Notify the caller if an autosave hook, or a timer, sentinel or
2969 filter in the sit_for calls above have changed the current
2970 kboard. This could happen if they use the minibuffer or start a
2971 recursive edit, like the fancy splash screen in server.el's
2972 filter. If this longjmp wasn't here, read_key_sequence would
2973 interpret the next key sequence using the wrong translation
2974 tables and function keymaps. */
2975 if (NILP (c) && current_kboard != orig_kboard)
2977 UNGCPRO;
2978 return make_number (-2); /* wrong_kboard_jmpbuf */
2981 /* If this has become non-nil here, it has been set by a timer
2982 or sentinel or filter. */
2983 if (CONSP (Vunread_command_events))
2985 c = XCAR (Vunread_command_events);
2986 Vunread_command_events = XCDR (Vunread_command_events);
2989 /* Read something from current KBOARD's side queue, if possible. */
2991 if (NILP (c))
2993 if (current_kboard->kbd_queue_has_data)
2995 if (!CONSP (current_kboard->kbd_queue))
2996 abort ();
2997 c = XCAR (current_kboard->kbd_queue);
2998 current_kboard->kbd_queue
2999 = XCDR (current_kboard->kbd_queue);
3000 if (NILP (current_kboard->kbd_queue))
3001 current_kboard->kbd_queue_has_data = 0;
3002 input_pending = readable_events (0);
3003 if (EVENT_HAS_PARAMETERS (c)
3004 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qswitch_frame))
3005 internal_last_event_frame = XCAR (XCDR (c));
3006 Vlast_event_frame = internal_last_event_frame;
3010 /* If current_kboard's side queue is empty check the other kboards.
3011 If one of them has data that we have not yet seen here,
3012 switch to it and process the data waiting for it.
3014 Note: if the events queued up for another kboard
3015 have already been seen here, and therefore are not a complete command,
3016 the kbd_queue_has_data field is 0, so we skip that kboard here.
3017 That's to avoid an infinite loop switching between kboards here. */
3018 if (NILP (c) && !single_kboard)
3020 KBOARD *kb;
3021 for (kb = all_kboards; kb; kb = kb->next_kboard)
3022 if (kb->kbd_queue_has_data)
3024 current_kboard = kb;
3025 /* This is going to exit from read_char
3026 so we had better get rid of this frame's stuff. */
3027 UNGCPRO;
3028 return make_number (-2); /* wrong_kboard_jmpbuf */
3032 wrong_kboard:
3034 STOP_POLLING;
3036 /* Finally, we read from the main queue,
3037 and if that gives us something we can't use yet, we put it on the
3038 appropriate side queue and try again. */
3040 if (NILP (c))
3042 KBOARD *kb;
3044 if (end_time)
3046 EMACS_TIME now;
3047 EMACS_GET_TIME (now);
3048 if (EMACS_TIME_GE (now, *end_time))
3049 goto exit;
3052 /* Actually read a character, waiting if necessary. */
3053 save_getcjmp (save_jump);
3054 restore_getcjmp (local_getcjmp);
3055 if (!end_time)
3056 timer_start_idle ();
3057 c = kbd_buffer_get_event (&kb, used_mouse_menu, end_time);
3058 restore_getcjmp (save_jump);
3060 if (! NILP (c) && (kb != current_kboard))
3062 Lisp_Object link = kb->kbd_queue;
3063 if (CONSP (link))
3065 while (CONSP (XCDR (link)))
3066 link = XCDR (link);
3067 if (!NILP (XCDR (link)))
3068 abort ();
3070 if (!CONSP (link))
3071 kb->kbd_queue = Fcons (c, Qnil);
3072 else
3073 XSETCDR (link, Fcons (c, Qnil));
3074 kb->kbd_queue_has_data = 1;
3075 c = Qnil;
3076 if (single_kboard)
3077 goto wrong_kboard;
3078 current_kboard = kb;
3079 /* This is going to exit from read_char
3080 so we had better get rid of this frame's stuff. */
3081 UNGCPRO;
3082 return make_number (-2);
3086 /* Terminate Emacs in batch mode if at eof. */
3087 if (noninteractive && INTEGERP (c) && XINT (c) < 0)
3088 Fkill_emacs (make_number (1));
3090 if (INTEGERP (c))
3092 /* Add in any extra modifiers, where appropriate. */
3093 if ((extra_keyboard_modifiers & CHAR_CTL)
3094 || ((extra_keyboard_modifiers & 0177) < ' '
3095 && (extra_keyboard_modifiers & 0177) != 0))
3096 XSETINT (c, make_ctrl_char (XINT (c)));
3098 /* Transfer any other modifier bits directly from
3099 extra_keyboard_modifiers to c. Ignore the actual character code
3100 in the low 16 bits of extra_keyboard_modifiers. */
3101 XSETINT (c, XINT (c) | (extra_keyboard_modifiers & ~0xff7f & ~CHAR_CTL));
3104 non_reread:
3106 if (!end_time)
3107 timer_stop_idle ();
3108 RESUME_POLLING;
3110 if (NILP (c))
3112 if (commandflag >= 0
3113 && !input_pending && !detect_input_pending_run_timers (0))
3114 redisplay ();
3116 goto wrong_kboard;
3119 non_reread_1:
3121 /* Buffer switch events are only for internal wakeups
3122 so don't show them to the user.
3123 Also, don't record a key if we already did. */
3124 if (BUFFERP (c) || key_already_recorded)
3125 goto exit;
3127 /* Process special events within read_char
3128 and loop around to read another event. */
3129 save = Vquit_flag;
3130 Vquit_flag = Qnil;
3131 tem = access_keymap (get_keymap (Vspecial_event_map, 0, 1), c, 0, 0, 1);
3132 Vquit_flag = save;
3134 if (!NILP (tem))
3136 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3137 int was_locked = single_kboard;
3138 int count = SPECPDL_INDEX ();
3139 record_single_kboard_state ();
3140 #endif
3142 last_input_event = c;
3143 Fcommand_execute (tem, Qnil, Fvector (1, &last_input_event), Qt);
3145 if (CONSP (c) && EQ (XCAR (c), Qselect_window) && !end_time)
3146 /* We stopped being idle for this event; undo that. This
3147 prevents automatic window selection (under
3148 mouse_autoselect_window from acting as a real input event, for
3149 example banishing the mouse under mouse-avoidance-mode. */
3150 timer_resume_idle ();
3152 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3153 /* Resume allowing input from any kboard, if that was true before. */
3154 if (!was_locked)
3155 any_kboard_state ();
3156 unbind_to (count, Qnil);
3157 #endif
3159 goto retry;
3162 /* Handle things that only apply to characters. */
3163 if (INTEGERP (c))
3165 /* If kbd_buffer_get_event gave us an EOF, return that. */
3166 if (XINT (c) == -1)
3167 goto exit;
3169 if ((STRINGP (current_kboard->Vkeyboard_translate_table)
3170 && SCHARS (current_kboard->Vkeyboard_translate_table) > (unsigned) XFASTINT (c))
3171 || (VECTORP (current_kboard->Vkeyboard_translate_table)
3172 && XVECTOR (current_kboard->Vkeyboard_translate_table)->size > (unsigned) XFASTINT (c))
3173 || (CHAR_TABLE_P (current_kboard->Vkeyboard_translate_table)
3174 && CHARACTERP (c)))
3176 Lisp_Object d;
3177 d = Faref (current_kboard->Vkeyboard_translate_table, c);
3178 /* nil in keyboard-translate-table means no translation. */
3179 if (!NILP (d))
3180 c = d;
3184 /* If this event is a mouse click in the menu bar,
3185 return just menu-bar for now. Modify the mouse click event
3186 so we won't do this twice, then queue it up. */
3187 if (EVENT_HAS_PARAMETERS (c)
3188 && CONSP (XCDR (c))
3189 && CONSP (EVENT_START (c))
3190 && CONSP (XCDR (EVENT_START (c))))
3192 Lisp_Object posn;
3194 posn = POSN_POSN (EVENT_START (c));
3195 /* Handle menu-bar events:
3196 insert the dummy prefix event `menu-bar'. */
3197 if (EQ (posn, Qmenu_bar) || EQ (posn, Qtool_bar))
3199 /* Change menu-bar to (menu-bar) as the event "position". */
3200 POSN_SET_POSN (EVENT_START (c), Fcons (posn, Qnil));
3202 also_record = c;
3203 Vunread_command_events = Fcons (c, Vunread_command_events);
3204 c = posn;
3208 /* Store these characters into recent_keys, the dribble file if any,
3209 and the keyboard macro being defined, if any. */
3210 record_char (c);
3211 if (! NILP (also_record))
3212 record_char (also_record);
3214 /* Wipe the echo area.
3215 But first, if we are about to use an input method,
3216 save the echo area contents for it to refer to. */
3217 if (INTEGERP (c)
3218 && ! NILP (Vinput_method_function)
3219 && (unsigned) XINT (c) >= ' '
3220 && (unsigned) XINT (c) != 127
3221 && (unsigned) XINT (c) < 256)
3223 previous_echo_area_message = Fcurrent_message ();
3224 Vinput_method_previous_message = previous_echo_area_message;
3227 /* Now wipe the echo area, except for help events which do their
3228 own stuff with the echo area. */
3229 if (!CONSP (c)
3230 || (!(EQ (Qhelp_echo, XCAR (c)))
3231 && !(EQ (Qswitch_frame, XCAR (c)))))
3233 if (!NILP (echo_area_buffer[0]))
3234 safe_run_hooks (Qecho_area_clear_hook);
3235 clear_message (1, 0);
3238 reread_for_input_method:
3239 from_macro:
3240 /* Pass this to the input method, if appropriate. */
3241 if (INTEGERP (c)
3242 && ! NILP (Vinput_method_function)
3243 /* Don't run the input method within a key sequence,
3244 after the first event of the key sequence. */
3245 && NILP (prev_event)
3246 && (unsigned) XINT (c) >= ' '
3247 && (unsigned) XINT (c) != 127
3248 && (unsigned) XINT (c) < 256)
3250 Lisp_Object keys;
3251 int key_count, key_count_reset;
3252 struct gcpro gcpro1;
3253 int count = SPECPDL_INDEX ();
3255 /* Save the echo status. */
3256 int saved_immediate_echo = current_kboard->immediate_echo;
3257 struct kboard *saved_ok_to_echo = ok_to_echo_at_next_pause;
3258 Lisp_Object saved_echo_string = current_kboard->echo_string;
3259 int saved_echo_after_prompt = current_kboard->echo_after_prompt;
3261 #if 0
3262 if (before_command_restore_flag)
3264 this_command_key_count = before_command_key_count_1;
3265 if (this_command_key_count < this_single_command_key_start)
3266 this_single_command_key_start = this_command_key_count;
3267 echo_truncate (before_command_echo_length_1);
3268 before_command_restore_flag = 0;
3270 #endif
3272 /* Save the this_command_keys status. */
3273 key_count = this_command_key_count;
3274 key_count_reset = this_command_key_count_reset;
3276 if (key_count > 0)
3277 keys = Fcopy_sequence (this_command_keys);
3278 else
3279 keys = Qnil;
3280 GCPRO1 (keys);
3282 /* Clear out this_command_keys. */
3283 this_command_key_count = 0;
3284 this_command_key_count_reset = 0;
3286 /* Now wipe the echo area. */
3287 if (!NILP (echo_area_buffer[0]))
3288 safe_run_hooks (Qecho_area_clear_hook);
3289 clear_message (1, 0);
3290 echo_truncate (0);
3292 /* If we are not reading a key sequence,
3293 never use the echo area. */
3294 if (maps == 0)
3296 specbind (Qinput_method_use_echo_area, Qt);
3299 /* Call the input method. */
3300 tem = call1 (Vinput_method_function, c);
3302 tem = unbind_to (count, tem);
3304 /* Restore the saved echoing state
3305 and this_command_keys state. */
3306 this_command_key_count = key_count;
3307 this_command_key_count_reset = key_count_reset;
3308 if (key_count > 0)
3309 this_command_keys = keys;
3311 cancel_echoing ();
3312 ok_to_echo_at_next_pause = saved_ok_to_echo;
3313 current_kboard->echo_string = saved_echo_string;
3314 current_kboard->echo_after_prompt = saved_echo_after_prompt;
3315 if (saved_immediate_echo)
3316 echo_now ();
3318 UNGCPRO;
3320 /* The input method can return no events. */
3321 if (! CONSP (tem))
3323 /* Bring back the previous message, if any. */
3324 if (! NILP (previous_echo_area_message))
3325 message_with_string ("%s", previous_echo_area_message, 0);
3326 goto retry;
3328 /* It returned one event or more. */
3329 c = XCAR (tem);
3330 Vunread_post_input_method_events
3331 = nconc2 (XCDR (tem), Vunread_post_input_method_events);
3334 reread_first:
3336 /* Display help if not echoing. */
3337 if (CONSP (c) && EQ (XCAR (c), Qhelp_echo))
3339 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3340 Lisp_Object help, object, position, window, tem;
3342 tem = Fcdr (XCDR (c));
3343 help = Fcar (tem);
3344 tem = Fcdr (tem);
3345 window = Fcar (tem);
3346 tem = Fcdr (tem);
3347 object = Fcar (tem);
3348 tem = Fcdr (tem);
3349 position = Fcar (tem);
3351 show_help_echo (help, window, object, position, 0);
3353 /* We stopped being idle for this event; undo that. */
3354 if (!end_time)
3355 timer_resume_idle ();
3356 goto retry;
3359 if ((! reread || this_command_key_count == 0
3360 || this_command_key_count_reset)
3361 && !end_time)
3364 /* Don't echo mouse motion events. */
3365 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
3366 && NILP (Fzerop (Vecho_keystrokes))
3367 && ! (EVENT_HAS_PARAMETERS (c)
3368 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
3370 echo_char (c);
3371 if (! NILP (also_record))
3372 echo_char (also_record);
3373 /* Once we reread a character, echoing can happen
3374 the next time we pause to read a new one. */
3375 ok_to_echo_at_next_pause = current_kboard;
3378 /* Record this character as part of the current key. */
3379 add_command_key (c);
3380 if (! NILP (also_record))
3381 add_command_key (also_record);
3384 last_input_event = c;
3385 num_input_events++;
3387 /* Process the help character specially if enabled */
3388 if (!NILP (Vhelp_form) && help_char_p (c))
3390 Lisp_Object tem0;
3391 count = SPECPDL_INDEX ();
3393 help_form_saved_window_configs
3394 = Fcons (Fcurrent_window_configuration (Qnil),
3395 help_form_saved_window_configs);
3396 record_unwind_protect (read_char_help_form_unwind, Qnil);
3398 tem0 = Feval (Vhelp_form);
3399 if (STRINGP (tem0))
3400 internal_with_output_to_temp_buffer ("*Help*", print_help, tem0);
3402 cancel_echoing ();
3405 c = read_char (0, 0, 0, Qnil, 0, NULL);
3406 if (EVENT_HAS_PARAMETERS (c)
3407 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_click))
3408 XSETCAR (help_form_saved_window_configs, Qnil);
3410 while (BUFFERP (c));
3411 /* Remove the help from the frame */
3412 unbind_to (count, Qnil);
3414 redisplay ();
3415 if (EQ (c, make_number (040)))
3417 cancel_echoing ();
3419 c = read_char (0, 0, 0, Qnil, 0, NULL);
3420 while (BUFFERP (c));
3424 exit:
3425 RESUME_POLLING;
3426 RETURN_UNGCPRO (c);
3429 /* Record a key that came from a mouse menu.
3430 Record it for echoing, for this-command-keys, and so on. */
3432 static void
3433 record_menu_key (c)
3434 Lisp_Object c;
3436 /* Wipe the echo area. */
3437 clear_message (1, 0);
3439 record_char (c);
3441 #if 0
3442 before_command_key_count = this_command_key_count;
3443 before_command_echo_length = echo_length ();
3444 #endif
3446 /* Don't echo mouse motion events. */
3447 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
3448 && NILP (Fzerop (Vecho_keystrokes)))
3450 echo_char (c);
3452 /* Once we reread a character, echoing can happen
3453 the next time we pause to read a new one. */
3454 ok_to_echo_at_next_pause = 0;
3457 /* Record this character as part of the current key. */
3458 add_command_key (c);
3460 /* Re-reading in the middle of a command */
3461 last_input_event = c;
3462 num_input_events++;
3465 /* Return 1 if should recognize C as "the help character". */
3468 help_char_p (c)
3469 Lisp_Object c;
3471 Lisp_Object tail;
3473 if (EQ (c, Vhelp_char))
3474 return 1;
3475 for (tail = Vhelp_event_list; CONSP (tail); tail = XCDR (tail))
3476 if (EQ (c, XCAR (tail)))
3477 return 1;
3478 return 0;
3481 /* Record the input event C in various ways. */
3483 static void
3484 record_char (c)
3485 Lisp_Object c;
3487 int recorded = 0;
3489 if (CONSP (c) && (EQ (XCAR (c), Qhelp_echo) || EQ (XCAR (c), Qmouse_movement)))
3491 /* To avoid filling recent_keys with help-echo and mouse-movement
3492 events, we filter out repeated help-echo events, only store the
3493 first and last in a series of mouse-movement events, and don't
3494 store repeated help-echo events which are only separated by
3495 mouse-movement events. */
3497 Lisp_Object ev1, ev2, ev3;
3498 int ix1, ix2, ix3;
3500 if ((ix1 = recent_keys_index - 1) < 0)
3501 ix1 = NUM_RECENT_KEYS - 1;
3502 ev1 = AREF (recent_keys, ix1);
3504 if ((ix2 = ix1 - 1) < 0)
3505 ix2 = NUM_RECENT_KEYS - 1;
3506 ev2 = AREF (recent_keys, ix2);
3508 if ((ix3 = ix2 - 1) < 0)
3509 ix3 = NUM_RECENT_KEYS - 1;
3510 ev3 = AREF (recent_keys, ix3);
3512 if (EQ (XCAR (c), Qhelp_echo))
3514 /* Don't record `help-echo' in recent_keys unless it shows some help
3515 message, and a different help than the previously recorded
3516 event. */
3517 Lisp_Object help, last_help;
3519 help = Fcar_safe (Fcdr_safe (XCDR (c)));
3520 if (!STRINGP (help))
3521 recorded = 1;
3522 else if (CONSP (ev1) && EQ (XCAR (ev1), Qhelp_echo)
3523 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev1))), EQ (last_help, help)))
3524 recorded = 1;
3525 else if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3526 && CONSP (ev2) && EQ (XCAR (ev2), Qhelp_echo)
3527 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev2))), EQ (last_help, help)))
3528 recorded = -1;
3529 else if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3530 && CONSP (ev2) && EQ (XCAR (ev2), Qmouse_movement)
3531 && CONSP (ev3) && EQ (XCAR (ev3), Qhelp_echo)
3532 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev3))), EQ (last_help, help)))
3533 recorded = -2;
3535 else if (EQ (XCAR (c), Qmouse_movement))
3537 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3538 So additional mouse movement events replace the last element. */
3539 Lisp_Object last_window, window;
3541 window = Fcar_safe (Fcar_safe (XCDR (c)));
3542 if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3543 && (last_window = Fcar_safe (Fcar_safe (XCDR (ev1))), EQ (last_window, window))
3544 && CONSP (ev2) && EQ (XCAR (ev2), Qmouse_movement)
3545 && (last_window = Fcar_safe (Fcar_safe (XCDR (ev2))), EQ (last_window, window)))
3547 ASET (recent_keys, ix1, c);
3548 recorded = 1;
3552 else
3553 store_kbd_macro_char (c);
3555 if (!recorded)
3557 total_keys++;
3558 ASET (recent_keys, recent_keys_index, c);
3559 if (++recent_keys_index >= NUM_RECENT_KEYS)
3560 recent_keys_index = 0;
3562 else if (recorded < 0)
3564 /* We need to remove one or two events from recent_keys.
3565 To do this, we simply put nil at those events and move the
3566 recent_keys_index backwards over those events. Usually,
3567 users will never see those nil events, as they will be
3568 overwritten by the command keys entered to see recent_keys
3569 (e.g. C-h l). */
3571 while (recorded++ < 0 && total_keys > 0)
3573 if (total_keys < NUM_RECENT_KEYS)
3574 total_keys--;
3575 if (--recent_keys_index < 0)
3576 recent_keys_index = NUM_RECENT_KEYS - 1;
3577 ASET (recent_keys, recent_keys_index, Qnil);
3581 num_nonmacro_input_events++;
3583 /* Write c to the dribble file. If c is a lispy event, write
3584 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3585 If you, dear reader, have a better idea, you've got the source. :-) */
3586 if (dribble)
3588 BLOCK_INPUT;
3589 if (INTEGERP (c))
3591 if (XUINT (c) < 0x100)
3592 putc (XINT (c), dribble);
3593 else
3594 fprintf (dribble, " 0x%x", (int) XUINT (c));
3596 else
3598 Lisp_Object dribblee;
3600 /* If it's a structured event, take the event header. */
3601 dribblee = EVENT_HEAD (c);
3603 if (SYMBOLP (dribblee))
3605 putc ('<', dribble);
3606 fwrite (SDATA (SYMBOL_NAME (dribblee)), sizeof (char),
3607 SBYTES (SYMBOL_NAME (dribblee)),
3608 dribble);
3609 putc ('>', dribble);
3613 fflush (dribble);
3614 UNBLOCK_INPUT;
3618 Lisp_Object
3619 print_help (object)
3620 Lisp_Object object;
3622 struct buffer *old = current_buffer;
3623 Fprinc (object, Qnil);
3624 set_buffer_internal (XBUFFER (Vstandard_output));
3625 call0 (intern ("help-mode"));
3626 set_buffer_internal (old);
3627 return Qnil;
3630 /* Copy out or in the info on where C-g should throw to.
3631 This is used when running Lisp code from within get_char,
3632 in case get_char is called recursively.
3633 See read_process_output. */
3635 static void
3636 save_getcjmp (temp)
3637 jmp_buf temp;
3639 bcopy (getcjmp, temp, sizeof getcjmp);
3642 static void
3643 restore_getcjmp (temp)
3644 jmp_buf temp;
3646 bcopy (temp, getcjmp, sizeof getcjmp);
3649 /* Low level keyboard/mouse input.
3650 kbd_buffer_store_event places events in kbd_buffer, and
3651 kbd_buffer_get_event retrieves them. */
3653 /* Return true if there are any events in the queue that read-char
3654 would return. If this returns false, a read-char would block. */
3655 static int
3656 readable_events (flags)
3657 int flags;
3659 if (flags & READABLE_EVENTS_DO_TIMERS_NOW)
3660 timer_check (1);
3662 /* If the buffer contains only FOCUS_IN_EVENT events, and
3663 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3664 if (kbd_fetch_ptr != kbd_store_ptr)
3666 if (flags & (READABLE_EVENTS_FILTER_EVENTS
3667 #ifdef USE_TOOLKIT_SCROLL_BARS
3668 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3669 #endif
3672 struct input_event *event;
3674 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
3675 ? kbd_fetch_ptr
3676 : kbd_buffer);
3680 if (!(
3681 #ifdef USE_TOOLKIT_SCROLL_BARS
3682 (flags & READABLE_EVENTS_FILTER_EVENTS) &&
3683 #endif
3684 event->kind == FOCUS_IN_EVENT)
3685 #ifdef USE_TOOLKIT_SCROLL_BARS
3686 && !((flags & READABLE_EVENTS_IGNORE_SQUEEZABLES)
3687 && event->kind == SCROLL_BAR_CLICK_EVENT
3688 && event->part == scroll_bar_handle
3689 && event->modifiers == 0)
3690 #endif
3692 return 1;
3693 event++;
3694 if (event == kbd_buffer + KBD_BUFFER_SIZE)
3695 event = kbd_buffer;
3697 while (event != kbd_store_ptr);
3699 else
3700 return 1;
3703 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3704 if (!(flags & READABLE_EVENTS_IGNORE_SQUEEZABLES)
3705 && !NILP (do_mouse_tracking) && some_mouse_moved ())
3706 return 1;
3707 #endif
3708 if (single_kboard)
3710 if (current_kboard->kbd_queue_has_data)
3711 return 1;
3713 else
3715 KBOARD *kb;
3716 for (kb = all_kboards; kb; kb = kb->next_kboard)
3717 if (kb->kbd_queue_has_data)
3718 return 1;
3720 return 0;
3723 /* Set this for debugging, to have a way to get out */
3724 int stop_character;
3726 static KBOARD *
3727 event_to_kboard (event)
3728 struct input_event *event;
3730 Lisp_Object frame;
3731 frame = event->frame_or_window;
3732 if (CONSP (frame))
3733 frame = XCAR (frame);
3734 else if (WINDOWP (frame))
3735 frame = WINDOW_FRAME (XWINDOW (frame));
3737 /* There are still some events that don't set this field.
3738 For now, just ignore the problem.
3739 Also ignore dead frames here. */
3740 if (!FRAMEP (frame) || !FRAME_LIVE_P (XFRAME (frame)))
3741 return 0;
3742 else
3743 return FRAME_KBOARD (XFRAME (frame));
3747 Lisp_Object Vthrow_on_input;
3749 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3751 void
3752 kbd_buffer_store_event (event)
3753 register struct input_event *event;
3755 kbd_buffer_store_event_hold (event, 0);
3758 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3760 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3761 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3762 Else, if EVENT is a quit event, store the quit event
3763 in HOLD_QUIT, and return (thus ignoring further events).
3765 This is used in read_avail_input to postpone the processing
3766 of the quit event until all subsequent input events have been
3767 parsed (and discarded).
3770 void
3771 kbd_buffer_store_event_hold (event, hold_quit)
3772 register struct input_event *event;
3773 struct input_event *hold_quit;
3775 if (event->kind == NO_EVENT)
3776 abort ();
3778 if (hold_quit && hold_quit->kind != NO_EVENT)
3779 return;
3781 if (event->kind == ASCII_KEYSTROKE_EVENT)
3783 register int c = event->code & 0377;
3785 if (event->modifiers & ctrl_modifier)
3786 c = make_ctrl_char (c);
3788 c |= (event->modifiers
3789 & (meta_modifier | alt_modifier
3790 | hyper_modifier | super_modifier));
3792 if (c == quit_char)
3794 KBOARD *kb = FRAME_KBOARD (XFRAME (event->frame_or_window));
3795 struct input_event *sp;
3797 if (single_kboard && kb != current_kboard)
3799 kb->kbd_queue
3800 = Fcons (make_lispy_switch_frame (event->frame_or_window),
3801 Fcons (make_number (c), Qnil));
3802 kb->kbd_queue_has_data = 1;
3803 for (sp = kbd_fetch_ptr; sp != kbd_store_ptr; sp++)
3805 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3806 sp = kbd_buffer;
3808 if (event_to_kboard (sp) == kb)
3810 sp->kind = NO_EVENT;
3811 sp->frame_or_window = Qnil;
3812 sp->arg = Qnil;
3815 return;
3818 if (hold_quit)
3820 bcopy (event, (char *) hold_quit, sizeof (*event));
3821 return;
3824 /* If this results in a quit_char being returned to Emacs as
3825 input, set Vlast_event_frame properly. If this doesn't
3826 get returned to Emacs as an event, the next event read
3827 will set Vlast_event_frame again, so this is safe to do. */
3829 Lisp_Object focus;
3831 focus = FRAME_FOCUS_FRAME (XFRAME (event->frame_or_window));
3832 if (NILP (focus))
3833 focus = event->frame_or_window;
3834 internal_last_event_frame = focus;
3835 Vlast_event_frame = focus;
3838 last_event_timestamp = event->timestamp;
3839 handle_interrupt ();
3840 return;
3843 if (c && c == stop_character)
3845 sys_suspend ();
3846 return;
3849 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3850 Just ignore the second one. */
3851 else if (event->kind == BUFFER_SWITCH_EVENT
3852 && kbd_fetch_ptr != kbd_store_ptr
3853 && ((kbd_store_ptr == kbd_buffer
3854 ? kbd_buffer + KBD_BUFFER_SIZE - 1
3855 : kbd_store_ptr - 1)->kind) == BUFFER_SWITCH_EVENT)
3856 return;
3858 if (kbd_store_ptr - kbd_buffer == KBD_BUFFER_SIZE)
3859 kbd_store_ptr = kbd_buffer;
3861 /* Don't let the very last slot in the buffer become full,
3862 since that would make the two pointers equal,
3863 and that is indistinguishable from an empty buffer.
3864 Discard the event if it would fill the last slot. */
3865 if (kbd_fetch_ptr - 1 != kbd_store_ptr)
3867 *kbd_store_ptr = *event;
3868 ++kbd_store_ptr;
3871 /* If we're inside while-no-input, and this event qualifies
3872 as input, set quit-flag to cause an interrupt. */
3873 if (!NILP (Vthrow_on_input)
3874 && event->kind != FOCUS_IN_EVENT
3875 && event->kind != HELP_EVENT
3876 && event->kind != DEICONIFY_EVENT)
3878 Vquit_flag = Vthrow_on_input;
3879 /* If we're inside a function that wants immediate quits,
3880 do it now. */
3881 if (immediate_quit && NILP (Vinhibit_quit))
3883 immediate_quit = 0;
3884 sigfree ();
3885 QUIT;
3891 /* Put an input event back in the head of the event queue. */
3893 void
3894 kbd_buffer_unget_event (event)
3895 register struct input_event *event;
3897 if (kbd_fetch_ptr == kbd_buffer)
3898 kbd_fetch_ptr = kbd_buffer + KBD_BUFFER_SIZE;
3900 /* Don't let the very last slot in the buffer become full, */
3901 if (kbd_fetch_ptr - 1 != kbd_store_ptr)
3903 --kbd_fetch_ptr;
3904 *kbd_fetch_ptr = *event;
3909 /* Generate HELP_EVENT input_events in BUFP which has room for
3910 SIZE events. If there's not enough room in BUFP, ignore this
3911 event.
3913 HELP is the help form.
3915 FRAME is the frame on which the help is generated. OBJECT is the
3916 Lisp object where the help was found (a buffer, a string, an
3917 overlay, or nil if neither from a string nor from a buffer. POS is
3918 the position within OBJECT where the help was found.
3920 Value is the number of input_events generated. */
3922 void
3923 gen_help_event (help, frame, window, object, pos)
3924 Lisp_Object help, frame, object, window;
3925 int pos;
3927 struct input_event event;
3929 EVENT_INIT (event);
3931 event.kind = HELP_EVENT;
3932 event.frame_or_window = frame;
3933 event.arg = object;
3934 event.x = WINDOWP (window) ? window : frame;
3935 event.y = help;
3936 event.code = pos;
3937 kbd_buffer_store_event (&event);
3941 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3943 void
3944 kbd_buffer_store_help_event (frame, help)
3945 Lisp_Object frame, help;
3947 struct input_event event;
3949 event.kind = HELP_EVENT;
3950 event.frame_or_window = frame;
3951 event.arg = Qnil;
3952 event.x = Qnil;
3953 event.y = help;
3954 event.code = 0;
3955 kbd_buffer_store_event (&event);
3959 /* Discard any mouse events in the event buffer by setting them to
3960 NO_EVENT. */
3961 void
3962 discard_mouse_events ()
3964 struct input_event *sp;
3965 for (sp = kbd_fetch_ptr; sp != kbd_store_ptr; sp++)
3967 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3968 sp = kbd_buffer;
3970 if (sp->kind == MOUSE_CLICK_EVENT
3971 || sp->kind == WHEEL_EVENT
3972 || sp->kind == HORIZ_WHEEL_EVENT
3973 #ifdef HAVE_GPM
3974 || sp->kind == GPM_CLICK_EVENT
3975 #endif
3976 || sp->kind == SCROLL_BAR_CLICK_EVENT)
3978 sp->kind = NO_EVENT;
3984 /* Return non-zero if there are any real events waiting in the event
3985 buffer, not counting `NO_EVENT's.
3987 If DISCARD is non-zero, discard NO_EVENT events at the front of
3988 the input queue, possibly leaving the input queue empty if there
3989 are no real input events. */
3992 kbd_buffer_events_waiting (discard)
3993 int discard;
3995 struct input_event *sp;
3997 for (sp = kbd_fetch_ptr;
3998 sp != kbd_store_ptr && sp->kind == NO_EVENT;
3999 ++sp)
4001 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
4002 sp = kbd_buffer;
4005 if (discard)
4006 kbd_fetch_ptr = sp;
4008 return sp != kbd_store_ptr && sp->kind != NO_EVENT;
4012 /* Clear input event EVENT. */
4014 static INLINE void
4015 clear_event (event)
4016 struct input_event *event;
4018 event->kind = NO_EVENT;
4022 /* Read one event from the event buffer, waiting if necessary.
4023 The value is a Lisp object representing the event.
4024 The value is nil for an event that should be ignored,
4025 or that was handled here.
4026 We always read and discard one event. */
4028 static Lisp_Object
4029 kbd_buffer_get_event (kbp, used_mouse_menu, end_time)
4030 KBOARD **kbp;
4031 int *used_mouse_menu;
4032 EMACS_TIME *end_time;
4034 register int c;
4035 Lisp_Object obj;
4037 if (noninteractive
4038 /* In case we are running as a daemon, only do this before
4039 detaching from the terminal. */
4040 || (IS_DAEMON && daemon_pipe[1] >= 0))
4042 c = getchar ();
4043 XSETINT (obj, c);
4044 *kbp = current_kboard;
4045 return obj;
4048 /* Wait until there is input available. */
4049 for (;;)
4051 /* Break loop if there's an unread command event. Needed in
4052 moused window autoselection which uses a timer to insert such
4053 events. */
4054 if (CONSP (Vunread_command_events))
4055 break;
4057 if (kbd_fetch_ptr != kbd_store_ptr)
4058 break;
4059 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4060 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
4061 break;
4062 #endif
4064 /* If the quit flag is set, then read_char will return
4065 quit_char, so that counts as "available input." */
4066 if (!NILP (Vquit_flag))
4067 quit_throw_to_read_char ();
4069 /* One way or another, wait until input is available; then, if
4070 interrupt handlers have not read it, read it now. */
4072 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4073 #ifdef SIGIO
4074 gobble_input (0);
4075 #endif /* SIGIO */
4076 if (kbd_fetch_ptr != kbd_store_ptr)
4077 break;
4078 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4079 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
4080 break;
4081 #endif
4082 if (end_time)
4084 EMACS_TIME duration;
4085 EMACS_GET_TIME (duration);
4086 if (EMACS_TIME_GE (duration, *end_time))
4087 return Qnil; /* finished waiting */
4088 else
4090 EMACS_SUB_TIME (duration, *end_time, duration);
4091 wait_reading_process_output (EMACS_SECS (duration),
4092 EMACS_USECS (duration),
4093 -1, 1, Qnil, NULL, 0);
4096 else
4097 wait_reading_process_output (0, 0, -1, 1, Qnil, NULL, 0);
4099 if (!interrupt_input && kbd_fetch_ptr == kbd_store_ptr)
4100 /* Pass 1 for EXPECT since we just waited to have input. */
4101 read_avail_input (1);
4104 if (CONSP (Vunread_command_events))
4106 Lisp_Object first;
4107 first = XCAR (Vunread_command_events);
4108 Vunread_command_events = XCDR (Vunread_command_events);
4109 *kbp = current_kboard;
4110 return first;
4113 /* At this point, we know that there is a readable event available
4114 somewhere. If the event queue is empty, then there must be a
4115 mouse movement enabled and available. */
4116 if (kbd_fetch_ptr != kbd_store_ptr)
4118 struct input_event *event;
4120 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
4121 ? kbd_fetch_ptr
4122 : kbd_buffer);
4124 last_event_timestamp = event->timestamp;
4126 *kbp = event_to_kboard (event);
4127 if (*kbp == 0)
4128 *kbp = current_kboard; /* Better than returning null ptr? */
4130 obj = Qnil;
4132 /* These two kinds of events get special handling
4133 and don't actually appear to the command loop.
4134 We return nil for them. */
4135 if (event->kind == SELECTION_REQUEST_EVENT
4136 || event->kind == SELECTION_CLEAR_EVENT)
4138 #ifdef HAVE_X11
4139 struct input_event copy;
4141 /* Remove it from the buffer before processing it,
4142 since otherwise swallow_events will see it
4143 and process it again. */
4144 copy = *event;
4145 kbd_fetch_ptr = event + 1;
4146 input_pending = readable_events (0);
4147 x_handle_selection_event (&copy);
4148 #else
4149 /* We're getting selection request events, but we don't have
4150 a window system. */
4151 abort ();
4152 #endif
4155 #if defined (HAVE_NS)
4156 else if (event->kind == NS_TEXT_EVENT)
4158 if (event->code == KEY_NS_PUT_WORKING_TEXT)
4159 obj = Fcons (intern ("ns-put-working-text"), Qnil);
4160 else
4161 obj = Fcons (intern ("ns-unput-working-text"), Qnil);
4162 kbd_fetch_ptr = event + 1;
4163 *used_mouse_menu = 1;
4165 #endif
4167 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4168 || defined (HAVE_NS)
4169 else if (event->kind == DELETE_WINDOW_EVENT)
4171 /* Make an event (delete-frame (FRAME)). */
4172 obj = Fcons (event->frame_or_window, Qnil);
4173 obj = Fcons (Qdelete_frame, Fcons (obj, Qnil));
4174 kbd_fetch_ptr = event + 1;
4176 #endif
4177 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4178 || defined (HAVE_NS)
4179 else if (event->kind == ICONIFY_EVENT)
4181 /* Make an event (iconify-frame (FRAME)). */
4182 obj = Fcons (event->frame_or_window, Qnil);
4183 obj = Fcons (Qiconify_frame, Fcons (obj, Qnil));
4184 kbd_fetch_ptr = event + 1;
4186 else if (event->kind == DEICONIFY_EVENT)
4188 /* Make an event (make-frame-visible (FRAME)). */
4189 obj = Fcons (event->frame_or_window, Qnil);
4190 obj = Fcons (Qmake_frame_visible, Fcons (obj, Qnil));
4191 kbd_fetch_ptr = event + 1;
4193 #endif
4194 else if (event->kind == BUFFER_SWITCH_EVENT)
4196 /* The value doesn't matter here; only the type is tested. */
4197 XSETBUFFER (obj, current_buffer);
4198 kbd_fetch_ptr = event + 1;
4200 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4201 || defined(HAVE_NS) || defined (USE_GTK)
4202 else if (event->kind == MENU_BAR_ACTIVATE_EVENT)
4204 kbd_fetch_ptr = event + 1;
4205 input_pending = readable_events (0);
4206 if (FRAME_LIVE_P (XFRAME (event->frame_or_window)))
4207 x_activate_menubar (XFRAME (event->frame_or_window));
4209 #endif
4210 #if defined (WINDOWSNT)
4211 else if (event->kind == LANGUAGE_CHANGE_EVENT)
4213 /* Make an event (language-change (FRAME CHARSET LCID)). */
4214 obj = Fcons (event->frame_or_window, Qnil);
4215 obj = Fcons (Qlanguage_change, Fcons (obj, Qnil));
4216 kbd_fetch_ptr = event + 1;
4218 #endif
4219 else if (event->kind == SAVE_SESSION_EVENT)
4221 obj = Fcons (Qsave_session, Qnil);
4222 kbd_fetch_ptr = event + 1;
4224 /* Just discard these, by returning nil.
4225 With MULTI_KBOARD, these events are used as placeholders
4226 when we need to randomly delete events from the queue.
4227 (They shouldn't otherwise be found in the buffer,
4228 but on some machines it appears they do show up
4229 even without MULTI_KBOARD.) */
4230 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4231 mouse events during a popup-menu call. */
4232 else if (event->kind == NO_EVENT)
4233 kbd_fetch_ptr = event + 1;
4234 else if (event->kind == HELP_EVENT)
4236 Lisp_Object object, position, help, frame, window;
4238 frame = event->frame_or_window;
4239 object = event->arg;
4240 position = make_number (event->code);
4241 window = event->x;
4242 help = event->y;
4243 clear_event (event);
4245 kbd_fetch_ptr = event + 1;
4246 if (!WINDOWP (window))
4247 window = Qnil;
4248 obj = Fcons (Qhelp_echo,
4249 list5 (frame, help, window, object, position));
4251 else if (event->kind == FOCUS_IN_EVENT)
4253 /* Notification of a FocusIn event. The frame receiving the
4254 focus is in event->frame_or_window. Generate a
4255 switch-frame event if necessary. */
4256 Lisp_Object frame, focus;
4258 frame = event->frame_or_window;
4259 focus = FRAME_FOCUS_FRAME (XFRAME (frame));
4260 if (FRAMEP (focus))
4261 frame = focus;
4263 if (!EQ (frame, internal_last_event_frame)
4264 && !EQ (frame, selected_frame))
4265 obj = make_lispy_switch_frame (frame);
4266 internal_last_event_frame = frame;
4267 kbd_fetch_ptr = event + 1;
4269 #ifdef HAVE_DBUS
4270 else if (event->kind == DBUS_EVENT)
4272 obj = make_lispy_event (event);
4273 kbd_fetch_ptr = event + 1;
4275 #endif
4276 else
4278 /* If this event is on a different frame, return a switch-frame this
4279 time, and leave the event in the queue for next time. */
4280 Lisp_Object frame;
4281 Lisp_Object focus;
4283 frame = event->frame_or_window;
4284 if (CONSP (frame))
4285 frame = XCAR (frame);
4286 else if (WINDOWP (frame))
4287 frame = WINDOW_FRAME (XWINDOW (frame));
4289 focus = FRAME_FOCUS_FRAME (XFRAME (frame));
4290 if (! NILP (focus))
4291 frame = focus;
4293 if (! EQ (frame, internal_last_event_frame)
4294 && !EQ (frame, selected_frame))
4295 obj = make_lispy_switch_frame (frame);
4296 internal_last_event_frame = frame;
4298 /* If we didn't decide to make a switch-frame event, go ahead
4299 and build a real event from the queue entry. */
4301 if (NILP (obj))
4303 obj = make_lispy_event (event);
4305 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4306 || defined(HAVE_NS) || defined (USE_GTK)
4307 /* If this was a menu selection, then set the flag to inhibit
4308 writing to last_nonmenu_event. Don't do this if the event
4309 we're returning is (menu-bar), though; that indicates the
4310 beginning of the menu sequence, and we might as well leave
4311 that as the `event with parameters' for this selection. */
4312 if (used_mouse_menu
4313 && !EQ (event->frame_or_window, event->arg)
4314 && (event->kind == MENU_BAR_EVENT
4315 || event->kind == TOOL_BAR_EVENT))
4316 *used_mouse_menu = 1;
4317 #endif
4318 #ifdef HAVE_NS
4319 /* certain system events are non-key events */
4320 if (event->kind == NS_NONKEY_EVENT)
4321 *used_mouse_menu = 1;
4322 #endif
4324 /* Wipe out this event, to catch bugs. */
4325 clear_event (event);
4326 kbd_fetch_ptr = event + 1;
4330 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4331 /* Try generating a mouse motion event. */
4332 else if (!NILP (do_mouse_tracking) && some_mouse_moved ())
4334 FRAME_PTR f = some_mouse_moved ();
4335 Lisp_Object bar_window;
4336 enum scroll_bar_part part;
4337 Lisp_Object x, y;
4338 unsigned long time;
4340 *kbp = current_kboard;
4341 /* Note that this uses F to determine which terminal to look at.
4342 If there is no valid info, it does not store anything
4343 so x remains nil. */
4344 x = Qnil;
4346 /* XXX Can f or mouse_position_hook be NULL here? */
4347 if (f && FRAME_TERMINAL (f)->mouse_position_hook)
4348 (*FRAME_TERMINAL (f)->mouse_position_hook) (&f, 0, &bar_window,
4349 &part, &x, &y, &time);
4351 obj = Qnil;
4353 /* Decide if we should generate a switch-frame event. Don't
4354 generate switch-frame events for motion outside of all Emacs
4355 frames. */
4356 if (!NILP (x) && f)
4358 Lisp_Object frame;
4360 frame = FRAME_FOCUS_FRAME (f);
4361 if (NILP (frame))
4362 XSETFRAME (frame, f);
4364 if (! EQ (frame, internal_last_event_frame)
4365 && !EQ (frame, selected_frame))
4366 obj = make_lispy_switch_frame (frame);
4367 internal_last_event_frame = frame;
4370 /* If we didn't decide to make a switch-frame event, go ahead and
4371 return a mouse-motion event. */
4372 if (!NILP (x) && NILP (obj))
4373 obj = make_lispy_movement (f, bar_window, part, x, y, time);
4375 #endif /* HAVE_MOUSE || HAVE GPM */
4376 else
4377 /* We were promised by the above while loop that there was
4378 something for us to read! */
4379 abort ();
4381 input_pending = readable_events (0);
4383 Vlast_event_frame = internal_last_event_frame;
4385 return (obj);
4388 /* Process any events that are not user-visible,
4389 then return, without reading any user-visible events. */
4391 void
4392 swallow_events (do_display)
4393 int do_display;
4395 int old_timers_run;
4397 while (kbd_fetch_ptr != kbd_store_ptr)
4399 struct input_event *event;
4401 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
4402 ? kbd_fetch_ptr
4403 : kbd_buffer);
4405 last_event_timestamp = event->timestamp;
4407 /* These two kinds of events get special handling
4408 and don't actually appear to the command loop. */
4409 if (event->kind == SELECTION_REQUEST_EVENT
4410 || event->kind == SELECTION_CLEAR_EVENT)
4412 #ifdef HAVE_X11
4413 struct input_event copy;
4415 /* Remove it from the buffer before processing it,
4416 since otherwise swallow_events called recursively could see it
4417 and process it again. */
4418 copy = *event;
4419 kbd_fetch_ptr = event + 1;
4420 input_pending = readable_events (0);
4421 x_handle_selection_event (&copy);
4422 #else
4423 /* We're getting selection request events, but we don't have
4424 a window system. */
4425 abort ();
4426 #endif
4428 else
4429 break;
4432 old_timers_run = timers_run;
4433 get_input_pending (&input_pending, READABLE_EVENTS_DO_TIMERS_NOW);
4435 if (timers_run != old_timers_run && do_display)
4436 redisplay_preserve_echo_area (7);
4439 /* Record the start of when Emacs is idle,
4440 for the sake of running idle-time timers. */
4442 static void
4443 timer_start_idle ()
4445 Lisp_Object timers;
4447 /* If we are already in the idle state, do nothing. */
4448 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4449 return;
4451 EMACS_GET_TIME (timer_idleness_start_time);
4453 timer_last_idleness_start_time = timer_idleness_start_time;
4455 /* Mark all idle-time timers as once again candidates for running. */
4456 for (timers = Vtimer_idle_list; CONSP (timers); timers = XCDR (timers))
4458 Lisp_Object timer;
4460 timer = XCAR (timers);
4462 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
4463 continue;
4464 XVECTOR (timer)->contents[0] = Qnil;
4468 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4470 static void
4471 timer_stop_idle ()
4473 EMACS_SET_SECS_USECS (timer_idleness_start_time, -1, -1);
4476 /* Resume idle timer from last idle start time. */
4478 static void
4479 timer_resume_idle ()
4481 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4482 return;
4484 timer_idleness_start_time = timer_last_idleness_start_time;
4487 /* This is only for debugging. */
4488 struct input_event last_timer_event;
4490 /* List of elisp functions to call, delayed because they were generated in
4491 a context where Elisp could not be safely run (e.g. redisplay, signal,
4492 ...). Each lement has the form (FUN . ARGS). */
4493 Lisp_Object pending_funcalls;
4495 extern Lisp_Object Qapply;
4497 /* Check whether a timer has fired. To prevent larger problems we simply
4498 disregard elements that are not proper timers. Do not make a circular
4499 timer list for the time being.
4501 Returns the number of seconds to wait until the next timer fires. If a
4502 timer is triggering now, return zero seconds.
4503 If no timer is active, return -1 seconds.
4505 If a timer is ripe, we run it, with quitting turned off.
4507 DO_IT_NOW is now ignored. It used to mean that we should
4508 run the timer directly instead of queueing a timer-event.
4509 Now we always run timers directly. */
4511 EMACS_TIME
4512 timer_check (do_it_now)
4513 int do_it_now;
4515 EMACS_TIME nexttime;
4516 EMACS_TIME now, idleness_now;
4517 Lisp_Object timers, idle_timers, chosen_timer;
4518 struct gcpro gcpro1, gcpro2, gcpro3;
4520 EMACS_SET_SECS (nexttime, -1);
4521 EMACS_SET_USECS (nexttime, -1);
4523 /* Always consider the ordinary timers. */
4524 timers = Vtimer_list;
4525 /* Consider the idle timers only if Emacs is idle. */
4526 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4527 idle_timers = Vtimer_idle_list;
4528 else
4529 idle_timers = Qnil;
4530 chosen_timer = Qnil;
4531 GCPRO3 (timers, idle_timers, chosen_timer);
4533 /* First run the code that was delayed. */
4534 while (CONSP (pending_funcalls))
4536 Lisp_Object funcall = XCAR (pending_funcalls);
4537 pending_funcalls = XCDR (pending_funcalls);
4538 safe_call2 (Qapply, XCAR (funcall), XCDR (funcall));
4541 if (CONSP (timers) || CONSP (idle_timers))
4543 EMACS_GET_TIME (now);
4544 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4545 EMACS_SUB_TIME (idleness_now, now, timer_idleness_start_time);
4548 while (CONSP (timers) || CONSP (idle_timers))
4550 Lisp_Object *vector;
4551 Lisp_Object timer = Qnil, idle_timer = Qnil;
4552 EMACS_TIME timer_time, idle_timer_time;
4553 EMACS_TIME difference, timer_difference, idle_timer_difference;
4555 /* Skip past invalid timers and timers already handled. */
4556 if (!NILP (timers))
4558 timer = XCAR (timers);
4559 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
4561 timers = XCDR (timers);
4562 continue;
4564 vector = XVECTOR (timer)->contents;
4566 if (!INTEGERP (vector[1]) || !INTEGERP (vector[2])
4567 || !INTEGERP (vector[3])
4568 || ! NILP (vector[0]))
4570 timers = XCDR (timers);
4571 continue;
4574 if (!NILP (idle_timers))
4576 timer = XCAR (idle_timers);
4577 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
4579 idle_timers = XCDR (idle_timers);
4580 continue;
4582 vector = XVECTOR (timer)->contents;
4584 if (!INTEGERP (vector[1]) || !INTEGERP (vector[2])
4585 || !INTEGERP (vector[3])
4586 || ! NILP (vector[0]))
4588 idle_timers = XCDR (idle_timers);
4589 continue;
4593 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4594 based on the next ordinary timer.
4595 TIMER_DIFFERENCE is the distance in time from NOW to when
4596 this timer becomes ripe (negative if it's already ripe). */
4597 if (!NILP (timers))
4599 timer = XCAR (timers);
4600 vector = XVECTOR (timer)->contents;
4601 EMACS_SET_SECS (timer_time,
4602 (XINT (vector[1]) << 16) | (XINT (vector[2])));
4603 EMACS_SET_USECS (timer_time, XINT (vector[3]));
4604 EMACS_SUB_TIME (timer_difference, timer_time, now);
4607 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4608 based on the next idle timer. */
4609 if (!NILP (idle_timers))
4611 idle_timer = XCAR (idle_timers);
4612 vector = XVECTOR (idle_timer)->contents;
4613 EMACS_SET_SECS (idle_timer_time,
4614 (XINT (vector[1]) << 16) | (XINT (vector[2])));
4615 EMACS_SET_USECS (idle_timer_time, XINT (vector[3]));
4616 EMACS_SUB_TIME (idle_timer_difference, idle_timer_time, idleness_now);
4619 /* Decide which timer is the next timer,
4620 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4621 Also step down the list where we found that timer. */
4623 if (! NILP (timers) && ! NILP (idle_timers))
4625 EMACS_TIME temp;
4626 EMACS_SUB_TIME (temp, timer_difference, idle_timer_difference);
4627 if (EMACS_TIME_NEG_P (temp))
4629 chosen_timer = timer;
4630 timers = XCDR (timers);
4631 difference = timer_difference;
4633 else
4635 chosen_timer = idle_timer;
4636 idle_timers = XCDR (idle_timers);
4637 difference = idle_timer_difference;
4640 else if (! NILP (timers))
4642 chosen_timer = timer;
4643 timers = XCDR (timers);
4644 difference = timer_difference;
4646 else
4648 chosen_timer = idle_timer;
4649 idle_timers = XCDR (idle_timers);
4650 difference = idle_timer_difference;
4652 vector = XVECTOR (chosen_timer)->contents;
4654 /* If timer is ripe, run it if it hasn't been run. */
4655 if (EMACS_TIME_NEG_P (difference)
4656 || (EMACS_SECS (difference) == 0
4657 && EMACS_USECS (difference) == 0))
4659 if (NILP (vector[0]))
4661 int count = SPECPDL_INDEX ();
4662 Lisp_Object old_deactivate_mark = Vdeactivate_mark;
4664 /* Mark the timer as triggered to prevent problems if the lisp
4665 code fails to reschedule it right. */
4666 vector[0] = Qt;
4668 specbind (Qinhibit_quit, Qt);
4670 call1 (Qtimer_event_handler, chosen_timer);
4671 Vdeactivate_mark = old_deactivate_mark;
4672 timers_run++;
4673 unbind_to (count, Qnil);
4675 /* Since we have handled the event,
4676 we don't need to tell the caller to wake up and do it. */
4679 else
4680 /* When we encounter a timer that is still waiting,
4681 return the amount of time to wait before it is ripe. */
4683 UNGCPRO;
4684 return difference;
4688 /* No timers are pending in the future. */
4689 /* Return 0 if we generated an event, and -1 if not. */
4690 UNGCPRO;
4691 return nexttime;
4694 DEFUN ("current-idle-time", Fcurrent_idle_time, Scurrent_idle_time, 0, 0, 0,
4695 doc: /* Return the current length of Emacs idleness, or nil.
4696 The value when Emacs is idle is a list of three integers. The first has
4697 the most significant 16 bits of the seconds, while the second has the least
4698 significant 16 bits. The third integer gives the microsecond count.
4700 The value when Emacs is not idle is nil.
4702 The microsecond count is zero on systems that do not provide
4703 resolution finer than a second. */)
4706 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4708 EMACS_TIME now, idleness_now;
4710 EMACS_GET_TIME (now);
4711 EMACS_SUB_TIME (idleness_now, now, timer_idleness_start_time);
4713 return list3 (make_number ((EMACS_SECS (idleness_now) >> 16) & 0xffff),
4714 make_number ((EMACS_SECS (idleness_now) >> 0) & 0xffff),
4715 make_number (EMACS_USECS (idleness_now)));
4718 return Qnil;
4721 /* Caches for modify_event_symbol. */
4722 static Lisp_Object accent_key_syms;
4723 static Lisp_Object func_key_syms;
4724 static Lisp_Object mouse_syms;
4725 static Lisp_Object wheel_syms;
4726 static Lisp_Object drag_n_drop_syms;
4728 /* This is a list of keysym codes for special "accent" characters.
4729 It parallels lispy_accent_keys. */
4731 static int lispy_accent_codes[] =
4733 #ifdef XK_dead_circumflex
4734 XK_dead_circumflex,
4735 #else
4737 #endif
4738 #ifdef XK_dead_grave
4739 XK_dead_grave,
4740 #else
4742 #endif
4743 #ifdef XK_dead_tilde
4744 XK_dead_tilde,
4745 #else
4747 #endif
4748 #ifdef XK_dead_diaeresis
4749 XK_dead_diaeresis,
4750 #else
4752 #endif
4753 #ifdef XK_dead_macron
4754 XK_dead_macron,
4755 #else
4757 #endif
4758 #ifdef XK_dead_degree
4759 XK_dead_degree,
4760 #else
4762 #endif
4763 #ifdef XK_dead_acute
4764 XK_dead_acute,
4765 #else
4767 #endif
4768 #ifdef XK_dead_cedilla
4769 XK_dead_cedilla,
4770 #else
4772 #endif
4773 #ifdef XK_dead_breve
4774 XK_dead_breve,
4775 #else
4777 #endif
4778 #ifdef XK_dead_ogonek
4779 XK_dead_ogonek,
4780 #else
4782 #endif
4783 #ifdef XK_dead_caron
4784 XK_dead_caron,
4785 #else
4787 #endif
4788 #ifdef XK_dead_doubleacute
4789 XK_dead_doubleacute,
4790 #else
4792 #endif
4793 #ifdef XK_dead_abovedot
4794 XK_dead_abovedot,
4795 #else
4797 #endif
4798 #ifdef XK_dead_abovering
4799 XK_dead_abovering,
4800 #else
4802 #endif
4803 #ifdef XK_dead_iota
4804 XK_dead_iota,
4805 #else
4807 #endif
4808 #ifdef XK_dead_belowdot
4809 XK_dead_belowdot,
4810 #else
4812 #endif
4813 #ifdef XK_dead_voiced_sound
4814 XK_dead_voiced_sound,
4815 #else
4817 #endif
4818 #ifdef XK_dead_semivoiced_sound
4819 XK_dead_semivoiced_sound,
4820 #else
4822 #endif
4823 #ifdef XK_dead_hook
4824 XK_dead_hook,
4825 #else
4827 #endif
4828 #ifdef XK_dead_horn
4829 XK_dead_horn,
4830 #else
4832 #endif
4835 /* This is a list of Lisp names for special "accent" characters.
4836 It parallels lispy_accent_codes. */
4838 static char *lispy_accent_keys[] =
4840 "dead-circumflex",
4841 "dead-grave",
4842 "dead-tilde",
4843 "dead-diaeresis",
4844 "dead-macron",
4845 "dead-degree",
4846 "dead-acute",
4847 "dead-cedilla",
4848 "dead-breve",
4849 "dead-ogonek",
4850 "dead-caron",
4851 "dead-doubleacute",
4852 "dead-abovedot",
4853 "dead-abovering",
4854 "dead-iota",
4855 "dead-belowdot",
4856 "dead-voiced-sound",
4857 "dead-semivoiced-sound",
4858 "dead-hook",
4859 "dead-horn",
4862 #ifdef HAVE_NTGUI
4863 #define FUNCTION_KEY_OFFSET 0x0
4865 char *lispy_function_keys[] =
4867 0, /* 0 */
4869 0, /* VK_LBUTTON 0x01 */
4870 0, /* VK_RBUTTON 0x02 */
4871 "cancel", /* VK_CANCEL 0x03 */
4872 0, /* VK_MBUTTON 0x04 */
4874 0, 0, 0, /* 0x05 .. 0x07 */
4876 "backspace", /* VK_BACK 0x08 */
4877 "tab", /* VK_TAB 0x09 */
4879 0, 0, /* 0x0A .. 0x0B */
4881 "clear", /* VK_CLEAR 0x0C */
4882 "return", /* VK_RETURN 0x0D */
4884 0, 0, /* 0x0E .. 0x0F */
4886 0, /* VK_SHIFT 0x10 */
4887 0, /* VK_CONTROL 0x11 */
4888 0, /* VK_MENU 0x12 */
4889 "pause", /* VK_PAUSE 0x13 */
4890 "capslock", /* VK_CAPITAL 0x14 */
4891 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4892 0, /* 0x16 */
4893 "junja", /* VK_JUNJA 0x17 */
4894 "final", /* VK_FINAL 0x18 */
4895 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4896 0, /* 0x1A */
4897 "escape", /* VK_ESCAPE 0x1B */
4898 "convert", /* VK_CONVERT 0x1C */
4899 "non-convert", /* VK_NONCONVERT 0x1D */
4900 "accept", /* VK_ACCEPT 0x1E */
4901 "mode-change", /* VK_MODECHANGE 0x1F */
4902 0, /* VK_SPACE 0x20 */
4903 "prior", /* VK_PRIOR 0x21 */
4904 "next", /* VK_NEXT 0x22 */
4905 "end", /* VK_END 0x23 */
4906 "home", /* VK_HOME 0x24 */
4907 "left", /* VK_LEFT 0x25 */
4908 "up", /* VK_UP 0x26 */
4909 "right", /* VK_RIGHT 0x27 */
4910 "down", /* VK_DOWN 0x28 */
4911 "select", /* VK_SELECT 0x29 */
4912 "print", /* VK_PRINT 0x2A */
4913 "execute", /* VK_EXECUTE 0x2B */
4914 "snapshot", /* VK_SNAPSHOT 0x2C */
4915 "insert", /* VK_INSERT 0x2D */
4916 "delete", /* VK_DELETE 0x2E */
4917 "help", /* VK_HELP 0x2F */
4919 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4921 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4923 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4925 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4927 0, 0, 0, 0, 0, 0, 0, 0, 0,
4928 0, 0, 0, 0, 0, 0, 0, 0, 0,
4929 0, 0, 0, 0, 0, 0, 0, 0,
4931 "lwindow", /* VK_LWIN 0x5B */
4932 "rwindow", /* VK_RWIN 0x5C */
4933 "apps", /* VK_APPS 0x5D */
4934 0, /* 0x5E */
4935 "sleep",
4936 "kp-0", /* VK_NUMPAD0 0x60 */
4937 "kp-1", /* VK_NUMPAD1 0x61 */
4938 "kp-2", /* VK_NUMPAD2 0x62 */
4939 "kp-3", /* VK_NUMPAD3 0x63 */
4940 "kp-4", /* VK_NUMPAD4 0x64 */
4941 "kp-5", /* VK_NUMPAD5 0x65 */
4942 "kp-6", /* VK_NUMPAD6 0x66 */
4943 "kp-7", /* VK_NUMPAD7 0x67 */
4944 "kp-8", /* VK_NUMPAD8 0x68 */
4945 "kp-9", /* VK_NUMPAD9 0x69 */
4946 "kp-multiply", /* VK_MULTIPLY 0x6A */
4947 "kp-add", /* VK_ADD 0x6B */
4948 "kp-separator", /* VK_SEPARATOR 0x6C */
4949 "kp-subtract", /* VK_SUBTRACT 0x6D */
4950 "kp-decimal", /* VK_DECIMAL 0x6E */
4951 "kp-divide", /* VK_DIVIDE 0x6F */
4952 "f1", /* VK_F1 0x70 */
4953 "f2", /* VK_F2 0x71 */
4954 "f3", /* VK_F3 0x72 */
4955 "f4", /* VK_F4 0x73 */
4956 "f5", /* VK_F5 0x74 */
4957 "f6", /* VK_F6 0x75 */
4958 "f7", /* VK_F7 0x76 */
4959 "f8", /* VK_F8 0x77 */
4960 "f9", /* VK_F9 0x78 */
4961 "f10", /* VK_F10 0x79 */
4962 "f11", /* VK_F11 0x7A */
4963 "f12", /* VK_F12 0x7B */
4964 "f13", /* VK_F13 0x7C */
4965 "f14", /* VK_F14 0x7D */
4966 "f15", /* VK_F15 0x7E */
4967 "f16", /* VK_F16 0x7F */
4968 "f17", /* VK_F17 0x80 */
4969 "f18", /* VK_F18 0x81 */
4970 "f19", /* VK_F19 0x82 */
4971 "f20", /* VK_F20 0x83 */
4972 "f21", /* VK_F21 0x84 */
4973 "f22", /* VK_F22 0x85 */
4974 "f23", /* VK_F23 0x86 */
4975 "f24", /* VK_F24 0x87 */
4977 0, 0, 0, 0, /* 0x88 .. 0x8B */
4978 0, 0, 0, 0, /* 0x8C .. 0x8F */
4980 "kp-numlock", /* VK_NUMLOCK 0x90 */
4981 "scroll", /* VK_SCROLL 0x91 */
4982 /* Not sure where the following block comes from.
4983 Windows headers have NEC and Fujitsu specific keys in
4984 this block, but nothing generic. */
4985 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4986 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4987 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4988 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4989 "kp-end", /* VK_NUMPAD_END 0x96 */
4990 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4991 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4992 "kp-up", /* VK_NUMPAD_UP 0x99 */
4993 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4994 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4995 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4996 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4998 0, 0, /* 0x9E .. 0x9F */
5001 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
5002 * Used only as parameters to GetAsyncKeyState and GetKeyState.
5003 * No other API or message will distinguish left and right keys this way.
5004 * 0xA0 .. 0xA5
5006 0, 0, 0, 0, 0, 0,
5008 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
5009 to enable them selectively, and gives access to a few more functions.
5010 See lispy_multimedia_keys below. */
5011 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
5012 0, 0, 0, /* 0xAD .. 0xAF Volume */
5013 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
5014 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
5016 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
5017 0, 0, 0, 0, 0, 0, 0, 0, 0,
5019 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
5020 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5021 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5023 0, /* 0xE0 */
5024 "ax", /* VK_OEM_AX 0xE1 */
5025 0, /* VK_OEM_102 0xE2 */
5026 "ico-help", /* VK_ICO_HELP 0xE3 */
5027 "ico-00", /* VK_ICO_00 0xE4 */
5028 0, /* VK_PROCESSKEY 0xE5 */
5029 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
5030 "packet", /* VK_PACKET 0xE7 */
5031 0, /* 0xE8 */
5032 "reset", /* VK_OEM_RESET 0xE9 */
5033 "jump", /* VK_OEM_JUMP 0xEA */
5034 "oem-pa1", /* VK_OEM_PA1 0xEB */
5035 "oem-pa2", /* VK_OEM_PA2 0xEC */
5036 "oem-pa3", /* VK_OEM_PA3 0xED */
5037 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
5038 "cusel", /* VK_OEM_CUSEL 0xEF */
5039 "oem-attn", /* VK_OEM_ATTN 0xF0 */
5040 "finish", /* VK_OEM_FINISH 0xF1 */
5041 "copy", /* VK_OEM_COPY 0xF2 */
5042 "auto", /* VK_OEM_AUTO 0xF3 */
5043 "enlw", /* VK_OEM_ENLW 0xF4 */
5044 "backtab", /* VK_OEM_BACKTAB 0xF5 */
5045 "attn", /* VK_ATTN 0xF6 */
5046 "crsel", /* VK_CRSEL 0xF7 */
5047 "exsel", /* VK_EXSEL 0xF8 */
5048 "ereof", /* VK_EREOF 0xF9 */
5049 "play", /* VK_PLAY 0xFA */
5050 "zoom", /* VK_ZOOM 0xFB */
5051 "noname", /* VK_NONAME 0xFC */
5052 "pa1", /* VK_PA1 0xFD */
5053 "oem_clear", /* VK_OEM_CLEAR 0xFE */
5054 0 /* 0xFF */
5057 /* Some of these duplicate the "Media keys" on newer keyboards,
5058 but they are delivered to the application in a different way. */
5059 static char *lispy_multimedia_keys[] =
5062 "browser-back",
5063 "browser-forward",
5064 "browser-refresh",
5065 "browser-stop",
5066 "browser-search",
5067 "browser-favorites",
5068 "browser-home",
5069 "volume-mute",
5070 "volume-down",
5071 "volume-up",
5072 "media-next",
5073 "media-previous",
5074 "media-stop",
5075 "media-play-pause",
5076 "mail",
5077 "media-select",
5078 "app-1",
5079 "app-2",
5080 "bass-down",
5081 "bass-boost",
5082 "bass-up",
5083 "treble-down",
5084 "treble-up",
5085 "mic-volume-mute",
5086 "mic-volume-down",
5087 "mic-volume-up",
5088 "help",
5089 "find",
5090 "new",
5091 "open",
5092 "close",
5093 "save",
5094 "print",
5095 "undo",
5096 "redo",
5097 "copy",
5098 "cut",
5099 "paste",
5100 "mail-reply",
5101 "mail-forward",
5102 "mail-send",
5103 "spell-check",
5104 "toggle-dictate-command",
5105 "mic-toggle",
5106 "correction-list",
5107 "media-play",
5108 "media-pause",
5109 "media-record",
5110 "media-fast-forward",
5111 "media-rewind",
5112 "media-channel-up",
5113 "media-channel-down"
5116 #else /* not HAVE_NTGUI */
5118 /* This should be dealt with in XTread_socket now, and that doesn't
5119 depend on the client system having the Kana syms defined. See also
5120 the XK_kana_A case below. */
5121 #if 0
5122 #ifdef XK_kana_A
5123 static char *lispy_kana_keys[] =
5125 /* X Keysym value */
5126 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5127 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5128 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5129 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5130 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5131 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5132 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5133 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5134 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5135 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5136 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5137 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5138 "kana-i", "kana-u", "kana-e", "kana-o",
5139 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5140 "prolongedsound", "kana-A", "kana-I", "kana-U",
5141 "kana-E", "kana-O", "kana-KA", "kana-KI",
5142 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5143 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5144 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5145 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5146 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5147 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5148 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5149 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5150 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5151 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5152 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5153 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5155 #endif /* XK_kana_A */
5156 #endif /* 0 */
5158 #define FUNCTION_KEY_OFFSET 0xff00
5160 /* You'll notice that this table is arranged to be conveniently
5161 indexed by X Windows keysym values. */
5162 static char *lispy_function_keys[] =
5164 /* X Keysym value */
5166 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5167 "backspace", "tab", "linefeed", "clear",
5168 0, "return", 0, 0,
5169 0, 0, 0, "pause", /* 0xff10...1f */
5170 0, 0, 0, 0, 0, 0, 0, "escape",
5171 0, 0, 0, 0,
5172 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5173 "romaji", "hiragana", "katakana", "hiragana-katakana",
5174 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5175 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5176 "eisu-toggle", /* 0xff30...3f */
5177 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5178 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5180 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5181 "down", "prior", "next", "end",
5182 "begin", 0, 0, 0, 0, 0, 0, 0,
5183 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5184 "print",
5185 "execute",
5186 "insert",
5187 0, /* 0xff64 */
5188 "undo",
5189 "redo",
5190 "menu",
5191 "find",
5192 "cancel",
5193 "help",
5194 "break", /* 0xff6b */
5196 0, 0, 0, 0,
5197 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5198 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5199 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5200 0, 0, 0, 0, 0, 0, 0, 0,
5201 "kp-tab", /* 0xff89 */
5202 0, 0, 0,
5203 "kp-enter", /* 0xff8d */
5204 0, 0, 0,
5205 "kp-f1", /* 0xff91 */
5206 "kp-f2",
5207 "kp-f3",
5208 "kp-f4",
5209 "kp-home", /* 0xff95 */
5210 "kp-left",
5211 "kp-up",
5212 "kp-right",
5213 "kp-down",
5214 "kp-prior", /* kp-page-up */
5215 "kp-next", /* kp-page-down */
5216 "kp-end",
5217 "kp-begin",
5218 "kp-insert",
5219 "kp-delete",
5220 0, /* 0xffa0 */
5221 0, 0, 0, 0, 0, 0, 0, 0, 0,
5222 "kp-multiply", /* 0xffaa */
5223 "kp-add",
5224 "kp-separator",
5225 "kp-subtract",
5226 "kp-decimal",
5227 "kp-divide", /* 0xffaf */
5228 "kp-0", /* 0xffb0 */
5229 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5230 0, /* 0xffba */
5231 0, 0,
5232 "kp-equal", /* 0xffbd */
5233 "f1", /* 0xffbe */ /* IsFunctionKey */
5234 "f2",
5235 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5236 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5237 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5238 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5239 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5240 0, 0, 0, 0, 0, 0, 0, 0,
5241 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5242 0, 0, 0, 0, 0, 0, 0, "delete"
5245 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5246 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5248 static char *iso_lispy_function_keys[] =
5250 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5251 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5252 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5253 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5254 "iso-lefttab", /* 0xfe20 */
5255 "iso-move-line-up", "iso-move-line-down",
5256 "iso-partial-line-up", "iso-partial-line-down",
5257 "iso-partial-space-left", "iso-partial-space-right",
5258 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5259 "iso-release-margin-left", "iso-release-margin-right",
5260 "iso-release-both-margins",
5261 "iso-fast-cursor-left", "iso-fast-cursor-right",
5262 "iso-fast-cursor-up", "iso-fast-cursor-down",
5263 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5264 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5267 #endif /* not HAVE_NTGUI */
5269 Lisp_Object Vlispy_mouse_stem;
5271 static char *lispy_wheel_names[] =
5273 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5276 /* drag-n-drop events are generated when a set of selected files are
5277 dragged from another application and dropped onto an Emacs window. */
5278 static char *lispy_drag_n_drop_names[] =
5280 "drag-n-drop"
5283 /* Scroll bar parts. */
5284 Lisp_Object Qabove_handle, Qhandle, Qbelow_handle;
5285 Lisp_Object Qup, Qdown, Qbottom, Qend_scroll;
5286 Lisp_Object Qtop, Qratio;
5288 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5289 Lisp_Object *scroll_bar_parts[] = {
5290 &Qabove_handle, &Qhandle, &Qbelow_handle,
5291 &Qup, &Qdown, &Qtop, &Qbottom, &Qend_scroll, &Qratio
5294 /* A vector, indexed by button number, giving the down-going location
5295 of currently depressed buttons, both scroll bar and non-scroll bar.
5297 The elements have the form
5298 (BUTTON-NUMBER MODIFIER-MASK . REST)
5299 where REST is the cdr of a position as it would be reported in the event.
5301 The make_lispy_event function stores positions here to tell the
5302 difference between click and drag events, and to store the starting
5303 location to be included in drag events. */
5305 static Lisp_Object button_down_location;
5307 /* Information about the most recent up-going button event: Which
5308 button, what location, and what time. */
5310 static int last_mouse_button;
5311 static int last_mouse_x;
5312 static int last_mouse_y;
5313 static unsigned long button_down_time;
5315 /* The maximum time between clicks to make a double-click, or Qnil to
5316 disable double-click detection, or Qt for no time limit. */
5318 Lisp_Object Vdouble_click_time;
5320 /* Maximum number of pixels the mouse may be moved between clicks
5321 to make a double-click. */
5323 EMACS_INT double_click_fuzz;
5325 /* The number of clicks in this multiple-click. */
5327 int double_click_count;
5329 /* Return position of a mouse click or wheel event */
5331 static Lisp_Object
5332 make_lispy_position (f, x, y, time)
5333 struct frame *f;
5334 Lisp_Object *x, *y;
5335 unsigned long time;
5337 Lisp_Object window;
5338 enum window_part part;
5339 Lisp_Object posn = Qnil;
5340 Lisp_Object extra_info = Qnil;
5341 int wx, wy;
5343 /* Set `window' to the window under frame pixel coordinates (x,y) */
5344 if (f)
5345 window = window_from_coordinates (f, XINT (*x), XINT (*y),
5346 &part, &wx, &wy, 0);
5347 else
5348 window = Qnil;
5350 if (WINDOWP (window))
5352 /* It's a click in window window at frame coordinates (x,y) */
5353 struct window *w = XWINDOW (window);
5354 Lisp_Object string_info = Qnil;
5355 int textpos = -1, rx = -1, ry = -1;
5356 int dx = -1, dy = -1;
5357 int width = -1, height = -1;
5358 Lisp_Object object = Qnil;
5360 /* Set event coordinates to window-relative coordinates
5361 for constructing the Lisp event below. */
5362 XSETINT (*x, wx);
5363 XSETINT (*y, wy);
5365 if (part == ON_TEXT)
5367 wx += WINDOW_LEFT_MARGIN_WIDTH (w);
5369 else if (part == ON_MODE_LINE || part == ON_HEADER_LINE)
5371 /* Mode line or header line. Look for a string under
5372 the mouse that may have a `local-map' property. */
5373 Lisp_Object string;
5374 int charpos;
5376 posn = part == ON_MODE_LINE ? Qmode_line : Qheader_line;
5377 rx = wx, ry = wy;
5378 string = mode_line_string (w, part, &rx, &ry, &charpos,
5379 &object, &dx, &dy, &width, &height);
5380 if (STRINGP (string))
5381 string_info = Fcons (string, make_number (charpos));
5382 if (w == XWINDOW (selected_window)
5383 && current_buffer == XBUFFER (w->buffer))
5384 textpos = PT;
5385 else
5386 textpos = XMARKER (w->pointm)->charpos;
5388 else if (part == ON_VERTICAL_BORDER)
5390 posn = Qvertical_line;
5391 wx = -1;
5392 dx = 0;
5393 width = 1;
5395 else if (part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
5397 Lisp_Object string;
5398 int charpos;
5400 posn = (part == ON_LEFT_MARGIN) ? Qleft_margin : Qright_margin;
5401 rx = wx, ry = wy;
5402 string = marginal_area_string (w, part, &rx, &ry, &charpos,
5403 &object, &dx, &dy, &width, &height);
5404 if (STRINGP (string))
5405 string_info = Fcons (string, make_number (charpos));
5406 if (part == ON_LEFT_MARGIN)
5407 wx = 0;
5408 else
5409 wx = window_box_right_offset (w, TEXT_AREA) - 1;
5411 else if (part == ON_LEFT_FRINGE)
5413 posn = Qleft_fringe;
5414 rx = 0;
5415 dx = wx;
5416 wx = (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5418 : window_box_width (w, LEFT_MARGIN_AREA));
5419 dx -= wx;
5421 else if (part == ON_RIGHT_FRINGE)
5423 posn = Qright_fringe;
5424 rx = 0;
5425 dx = wx;
5426 wx = (window_box_width (w, LEFT_MARGIN_AREA)
5427 + window_box_width (w, TEXT_AREA)
5428 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5429 ? window_box_width (w, RIGHT_MARGIN_AREA)
5430 : 0));
5431 dx -= wx;
5433 else
5435 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5436 wx = max (WINDOW_LEFT_MARGIN_WIDTH (w), wx);
5439 if (textpos < 0)
5441 Lisp_Object string2, object2 = Qnil;
5442 struct display_pos p;
5443 int dx2, dy2;
5444 int width2, height2;
5445 string2 = buffer_posn_from_coords (w, &wx, &wy, &p,
5446 &object2, &dx2, &dy2,
5447 &width2, &height2);
5448 textpos = CHARPOS (p.pos);
5449 if (rx < 0) rx = wx;
5450 if (ry < 0) ry = wy;
5451 if (dx < 0) dx = dx2;
5452 if (dy < 0) dy = dy2;
5453 if (width < 0) width = width2;
5454 if (height < 0) height = height2;
5456 if (NILP (posn))
5458 posn = make_number (textpos);
5459 if (STRINGP (string2))
5460 string_info = Fcons (string2,
5461 make_number (CHARPOS (p.string_pos)));
5463 if (NILP (object))
5464 object = object2;
5467 #ifdef HAVE_WINDOW_SYSTEM
5468 if (IMAGEP (object))
5470 Lisp_Object image_map, hotspot;
5471 if ((image_map = Fplist_get (XCDR (object), QCmap),
5472 !NILP (image_map))
5473 && (hotspot = find_hot_spot (image_map, dx, dy),
5474 CONSP (hotspot))
5475 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
5476 posn = XCAR (hotspot);
5478 #endif
5480 /* Object info */
5481 extra_info = Fcons (object,
5482 Fcons (Fcons (make_number (dx),
5483 make_number (dy)),
5484 Fcons (Fcons (make_number (width),
5485 make_number (height)),
5486 Qnil)));
5488 /* String info */
5489 extra_info = Fcons (string_info,
5490 Fcons (make_number (textpos),
5491 Fcons (Fcons (make_number (rx),
5492 make_number (ry)),
5493 extra_info)));
5495 else if (f != 0)
5497 XSETFRAME (window, f);
5499 else
5501 window = Qnil;
5502 XSETFASTINT (*x, 0);
5503 XSETFASTINT (*y, 0);
5506 return Fcons (window,
5507 Fcons (posn,
5508 Fcons (Fcons (*x, *y),
5509 Fcons (make_number (time),
5510 extra_info))));
5513 /* Given a struct input_event, build the lisp event which represents
5514 it. If EVENT is 0, build a mouse movement event from the mouse
5515 movement buffer, which should have a movement event in it.
5517 Note that events must be passed to this function in the order they
5518 are received; this function stores the location of button presses
5519 in order to build drag events when the button is released. */
5521 static Lisp_Object
5522 make_lispy_event (event)
5523 struct input_event *event;
5525 int i;
5527 switch (SWITCH_ENUM_CAST (event->kind))
5529 /* A simple keystroke. */
5530 case ASCII_KEYSTROKE_EVENT:
5531 case MULTIBYTE_CHAR_KEYSTROKE_EVENT:
5533 Lisp_Object lispy_c;
5534 int c = event->code;
5535 if (event->kind == ASCII_KEYSTROKE_EVENT)
5537 c &= 0377;
5538 eassert (c == event->code);
5539 /* Turn ASCII characters into control characters
5540 when proper. */
5541 if (event->modifiers & ctrl_modifier)
5543 c = make_ctrl_char (c);
5544 event->modifiers &= ~ctrl_modifier;
5548 /* Add in the other modifier bits. The shift key was taken care
5549 of by the X code. */
5550 c |= (event->modifiers
5551 & (meta_modifier | alt_modifier
5552 | hyper_modifier | super_modifier | ctrl_modifier));
5553 /* Distinguish Shift-SPC from SPC. */
5554 if ((event->code) == 040
5555 && event->modifiers & shift_modifier)
5556 c |= shift_modifier;
5557 button_down_time = 0;
5558 XSETFASTINT (lispy_c, c);
5559 return lispy_c;
5562 #ifdef HAVE_NS
5563 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5564 except that they are non-key events (last-nonmenu-event is nil). */
5565 case NS_NONKEY_EVENT:
5566 #endif
5568 /* A function key. The symbol may need to have modifier prefixes
5569 tacked onto it. */
5570 case NON_ASCII_KEYSTROKE_EVENT:
5571 button_down_time = 0;
5573 for (i = 0; i < sizeof (lispy_accent_codes) / sizeof (int); i++)
5574 if (event->code == lispy_accent_codes[i])
5575 return modify_event_symbol (i,
5576 event->modifiers,
5577 Qfunction_key, Qnil,
5578 lispy_accent_keys, &accent_key_syms,
5579 (sizeof (lispy_accent_keys)
5580 / sizeof (lispy_accent_keys[0])));
5582 #if 0
5583 #ifdef XK_kana_A
5584 if (event->code >= 0x400 && event->code < 0x500)
5585 return modify_event_symbol (event->code - 0x400,
5586 event->modifiers & ~shift_modifier,
5587 Qfunction_key, Qnil,
5588 lispy_kana_keys, &func_key_syms,
5589 (sizeof (lispy_kana_keys)
5590 / sizeof (lispy_kana_keys[0])));
5591 #endif /* XK_kana_A */
5592 #endif /* 0 */
5594 #ifdef ISO_FUNCTION_KEY_OFFSET
5595 if (event->code < FUNCTION_KEY_OFFSET
5596 && event->code >= ISO_FUNCTION_KEY_OFFSET)
5597 return modify_event_symbol (event->code - ISO_FUNCTION_KEY_OFFSET,
5598 event->modifiers,
5599 Qfunction_key, Qnil,
5600 iso_lispy_function_keys, &func_key_syms,
5601 (sizeof (iso_lispy_function_keys)
5602 / sizeof (iso_lispy_function_keys[0])));
5603 #endif
5605 /* Handle system-specific or unknown keysyms. */
5606 if (event->code & (1 << 28)
5607 || event->code - FUNCTION_KEY_OFFSET < 0
5608 || (event->code - FUNCTION_KEY_OFFSET
5609 >= sizeof lispy_function_keys / sizeof *lispy_function_keys)
5610 || !lispy_function_keys[event->code - FUNCTION_KEY_OFFSET])
5612 /* We need to use an alist rather than a vector as the cache
5613 since we can't make a vector long enuf. */
5614 if (NILP (current_kboard->system_key_syms))
5615 current_kboard->system_key_syms = Fcons (Qnil, Qnil);
5616 return modify_event_symbol (event->code,
5617 event->modifiers,
5618 Qfunction_key,
5619 current_kboard->Vsystem_key_alist,
5620 0, &current_kboard->system_key_syms,
5621 (unsigned) -1);
5624 return modify_event_symbol (event->code - FUNCTION_KEY_OFFSET,
5625 event->modifiers,
5626 Qfunction_key, Qnil,
5627 lispy_function_keys, &func_key_syms,
5628 (sizeof (lispy_function_keys)
5629 / sizeof (lispy_function_keys[0])));
5631 #ifdef WINDOWSNT
5632 case MULTIMEDIA_KEY_EVENT:
5633 if (event->code < (sizeof (lispy_multimedia_keys)
5634 / sizeof (lispy_multimedia_keys[0]))
5635 && event->code > 0 && lispy_multimedia_keys[event->code])
5637 return modify_event_symbol (event->code, event->modifiers,
5638 Qfunction_key, Qnil,
5639 lispy_multimedia_keys, &func_key_syms,
5640 (sizeof (lispy_multimedia_keys)
5641 / sizeof (lispy_multimedia_keys[0])));
5643 return Qnil;
5644 #endif
5646 #ifdef HAVE_MOUSE
5647 /* A mouse click. Figure out where it is, decide whether it's
5648 a press, click or drag, and build the appropriate structure. */
5649 case MOUSE_CLICK_EVENT:
5650 #ifndef USE_TOOLKIT_SCROLL_BARS
5651 case SCROLL_BAR_CLICK_EVENT:
5652 #endif
5654 int button = event->code;
5655 int is_double;
5656 Lisp_Object position;
5657 Lisp_Object *start_pos_ptr;
5658 Lisp_Object start_pos;
5660 position = Qnil;
5662 /* Build the position as appropriate for this mouse click. */
5663 if (event->kind == MOUSE_CLICK_EVENT)
5665 struct frame *f = XFRAME (event->frame_or_window);
5666 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5667 int row, column;
5668 #endif
5670 /* Ignore mouse events that were made on frame that
5671 have been deleted. */
5672 if (! FRAME_LIVE_P (f))
5673 return Qnil;
5675 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5676 /* EVENT->x and EVENT->y are frame-relative pixel
5677 coordinates at this place. Under old redisplay, COLUMN
5678 and ROW are set to frame relative glyph coordinates
5679 which are then used to determine whether this click is
5680 in a menu (non-toolkit version). */
5681 pixel_to_glyph_coords (f, XINT (event->x), XINT (event->y),
5682 &column, &row, NULL, 1);
5684 /* In the non-toolkit version, clicks on the menu bar
5685 are ordinary button events in the event buffer.
5686 Distinguish them, and invoke the menu.
5688 (In the toolkit version, the toolkit handles the menu bar
5689 and Emacs doesn't know about it until after the user
5690 makes a selection.) */
5691 if (row >= 0 && row < FRAME_MENU_BAR_LINES (f)
5692 && (event->modifiers & down_modifier))
5694 Lisp_Object items, item;
5695 int hpos;
5696 int i;
5698 #if 0
5699 /* Activate the menu bar on the down event. If the
5700 up event comes in before the menu code can deal with it,
5701 just ignore it. */
5702 if (! (event->modifiers & down_modifier))
5703 return Qnil;
5704 #endif
5706 /* Find the menu bar item under `column'. */
5707 item = Qnil;
5708 items = FRAME_MENU_BAR_ITEMS (f);
5709 for (i = 0; i < XVECTOR (items)->size; i += 4)
5711 Lisp_Object pos, string;
5712 string = AREF (items, i + 1);
5713 pos = AREF (items, i + 3);
5714 if (NILP (string))
5715 break;
5716 if (column >= XINT (pos)
5717 && column < XINT (pos) + SCHARS (string))
5719 item = AREF (items, i);
5720 break;
5724 /* ELisp manual 2.4b says (x y) are window relative but
5725 code says they are frame-relative. */
5726 position
5727 = Fcons (event->frame_or_window,
5728 Fcons (Qmenu_bar,
5729 Fcons (Fcons (event->x, event->y),
5730 Fcons (make_number (event->timestamp),
5731 Qnil))));
5733 return Fcons (item, Fcons (position, Qnil));
5735 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5737 position = make_lispy_position (f, &event->x, &event->y,
5738 event->timestamp);
5740 #ifndef USE_TOOLKIT_SCROLL_BARS
5741 else
5743 /* It's a scrollbar click. */
5744 Lisp_Object window;
5745 Lisp_Object portion_whole;
5746 Lisp_Object part;
5748 window = event->frame_or_window;
5749 portion_whole = Fcons (event->x, event->y);
5750 part = *scroll_bar_parts[(int) event->part];
5752 position
5753 = Fcons (window,
5754 Fcons (Qvertical_scroll_bar,
5755 Fcons (portion_whole,
5756 Fcons (make_number (event->timestamp),
5757 Fcons (part, Qnil)))));
5759 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5761 if (button >= ASIZE (button_down_location))
5763 button_down_location = larger_vector (button_down_location,
5764 button + 1, Qnil);
5765 mouse_syms = larger_vector (mouse_syms, button + 1, Qnil);
5768 start_pos_ptr = &AREF (button_down_location, button);
5769 start_pos = *start_pos_ptr;
5770 *start_pos_ptr = Qnil;
5773 /* On window-system frames, use the value of
5774 double-click-fuzz as is. On other frames, interpret it
5775 as a multiple of 1/8 characters. */
5776 struct frame *f;
5777 int fuzz;
5779 if (WINDOWP (event->frame_or_window))
5780 f = XFRAME (XWINDOW (event->frame_or_window)->frame);
5781 else if (FRAMEP (event->frame_or_window))
5782 f = XFRAME (event->frame_or_window);
5783 else
5784 abort ();
5786 if (FRAME_WINDOW_P (f))
5787 fuzz = double_click_fuzz;
5788 else
5789 fuzz = double_click_fuzz / 8;
5791 is_double = (button == last_mouse_button
5792 && (eabs (XINT (event->x) - last_mouse_x) <= fuzz)
5793 && (eabs (XINT (event->y) - last_mouse_y) <= fuzz)
5794 && button_down_time != 0
5795 && (EQ (Vdouble_click_time, Qt)
5796 || (INTEGERP (Vdouble_click_time)
5797 && ((int)(event->timestamp - button_down_time)
5798 < XINT (Vdouble_click_time)))));
5801 last_mouse_button = button;
5802 last_mouse_x = XINT (event->x);
5803 last_mouse_y = XINT (event->y);
5805 /* If this is a button press, squirrel away the location, so
5806 we can decide later whether it was a click or a drag. */
5807 if (event->modifiers & down_modifier)
5809 if (is_double)
5811 double_click_count++;
5812 event->modifiers |= ((double_click_count > 2)
5813 ? triple_modifier
5814 : double_modifier);
5816 else
5817 double_click_count = 1;
5818 button_down_time = event->timestamp;
5819 *start_pos_ptr = Fcopy_alist (position);
5820 ignore_mouse_drag_p = 0;
5823 /* Now we're releasing a button - check the co-ordinates to
5824 see if this was a click or a drag. */
5825 else if (event->modifiers & up_modifier)
5827 /* If we did not see a down before this up, ignore the up.
5828 Probably this happened because the down event chose a
5829 menu item. It would be an annoyance to treat the
5830 release of the button that chose the menu item as a
5831 separate event. */
5833 if (!CONSP (start_pos))
5834 return Qnil;
5836 event->modifiers &= ~up_modifier;
5837 #if 0 /* Formerly we treated an up with no down as a click event. */
5838 if (!CONSP (start_pos))
5839 event->modifiers |= click_modifier;
5840 else
5841 #endif
5843 Lisp_Object down;
5844 EMACS_INT xdiff = double_click_fuzz, ydiff = double_click_fuzz;
5846 /* The third element of every position
5847 should be the (x,y) pair. */
5848 down = Fcar (Fcdr (Fcdr (start_pos)));
5849 if (CONSP (down)
5850 && INTEGERP (XCAR (down)) && INTEGERP (XCDR (down)))
5852 xdiff = XINT (event->x) - XINT (XCAR (down));
5853 ydiff = XINT (event->y) - XINT (XCDR (down));
5856 if (ignore_mouse_drag_p)
5858 event->modifiers |= click_modifier;
5859 ignore_mouse_drag_p = 0;
5861 else if (xdiff < double_click_fuzz && xdiff > - double_click_fuzz
5862 && ydiff < double_click_fuzz && ydiff > - double_click_fuzz
5863 /* Maybe the mouse has moved a lot, caused scrolling, and
5864 eventually ended up at the same screen position (but
5865 not buffer position) in which case it is a drag, not
5866 a click. */
5867 /* FIXME: OTOH if the buffer position has changed
5868 because of a timer or process filter rather than
5869 because of mouse movement, it should be considered as
5870 a click. But mouse-drag-region completely ignores
5871 this case and it hasn't caused any real problem, so
5872 it's probably OK to ignore it as well. */
5873 && EQ (Fcar (Fcdr (start_pos)), Fcar (Fcdr (position))))
5874 /* Mouse hasn't moved (much). */
5875 event->modifiers |= click_modifier;
5876 else
5878 button_down_time = 0;
5879 event->modifiers |= drag_modifier;
5882 /* Don't check is_double; treat this as multiple
5883 if the down-event was multiple. */
5884 if (double_click_count > 1)
5885 event->modifiers |= ((double_click_count > 2)
5886 ? triple_modifier
5887 : double_modifier);
5890 else
5891 /* Every mouse event should either have the down_modifier or
5892 the up_modifier set. */
5893 abort ();
5896 /* Get the symbol we should use for the mouse click. */
5897 Lisp_Object head;
5899 head = modify_event_symbol (button,
5900 event->modifiers,
5901 Qmouse_click, Vlispy_mouse_stem,
5902 NULL,
5903 &mouse_syms,
5904 XVECTOR (mouse_syms)->size);
5905 if (event->modifiers & drag_modifier)
5906 return Fcons (head,
5907 Fcons (start_pos,
5908 Fcons (position,
5909 Qnil)));
5910 else if (event->modifiers & (double_modifier | triple_modifier))
5911 return Fcons (head,
5912 Fcons (position,
5913 Fcons (make_number (double_click_count),
5914 Qnil)));
5915 else
5916 return Fcons (head,
5917 Fcons (position,
5918 Qnil));
5922 case WHEEL_EVENT:
5923 case HORIZ_WHEEL_EVENT:
5925 Lisp_Object position;
5926 Lisp_Object head;
5928 /* Build the position as appropriate for this mouse click. */
5929 struct frame *f = XFRAME (event->frame_or_window);
5931 /* Ignore wheel events that were made on frame that have been
5932 deleted. */
5933 if (! FRAME_LIVE_P (f))
5934 return Qnil;
5936 position = make_lispy_position (f, &event->x, &event->y,
5937 event->timestamp);
5939 /* Set double or triple modifiers to indicate the wheel speed. */
5941 /* On window-system frames, use the value of
5942 double-click-fuzz as is. On other frames, interpret it
5943 as a multiple of 1/8 characters. */
5944 struct frame *f;
5945 int fuzz;
5946 int is_double;
5948 if (WINDOWP (event->frame_or_window))
5949 f = XFRAME (XWINDOW (event->frame_or_window)->frame);
5950 else if (FRAMEP (event->frame_or_window))
5951 f = XFRAME (event->frame_or_window);
5952 else
5953 abort ();
5955 if (FRAME_WINDOW_P (f))
5956 fuzz = double_click_fuzz;
5957 else
5958 fuzz = double_click_fuzz / 8;
5960 is_double = (last_mouse_button < 0
5961 && (eabs (XINT (event->x) - last_mouse_x) <= fuzz)
5962 && (eabs (XINT (event->y) - last_mouse_y) <= fuzz)
5963 && button_down_time != 0
5964 && (EQ (Vdouble_click_time, Qt)
5965 || (INTEGERP (Vdouble_click_time)
5966 && ((int)(event->timestamp - button_down_time)
5967 < XINT (Vdouble_click_time)))));
5968 if (is_double)
5970 double_click_count++;
5971 event->modifiers |= ((double_click_count > 2)
5972 ? triple_modifier
5973 : double_modifier);
5975 else
5977 double_click_count = 1;
5978 event->modifiers |= click_modifier;
5981 button_down_time = event->timestamp;
5982 /* Use a negative value to distinguish wheel from mouse button. */
5983 last_mouse_button = -1;
5984 last_mouse_x = XINT (event->x);
5985 last_mouse_y = XINT (event->y);
5989 int symbol_num;
5991 if (event->modifiers & up_modifier)
5993 /* Emit a wheel-up event. */
5994 event->modifiers &= ~up_modifier;
5995 symbol_num = 0;
5997 else if (event->modifiers & down_modifier)
5999 /* Emit a wheel-down event. */
6000 event->modifiers &= ~down_modifier;
6001 symbol_num = 1;
6003 else
6004 /* Every wheel event should either have the down_modifier or
6005 the up_modifier set. */
6006 abort ();
6008 if (event->kind == HORIZ_WHEEL_EVENT)
6009 symbol_num += 2;
6011 /* Get the symbol we should use for the wheel event. */
6012 head = modify_event_symbol (symbol_num,
6013 event->modifiers,
6014 Qmouse_click,
6015 Qnil,
6016 lispy_wheel_names,
6017 &wheel_syms,
6018 ASIZE (wheel_syms));
6021 if (event->modifiers & (double_modifier | triple_modifier))
6022 return Fcons (head,
6023 Fcons (position,
6024 Fcons (make_number (double_click_count),
6025 Qnil)));
6026 else
6027 return Fcons (head,
6028 Fcons (position,
6029 Qnil));
6033 #ifdef USE_TOOLKIT_SCROLL_BARS
6035 /* We don't have down and up events if using toolkit scroll bars,
6036 so make this always a click event. Store in the `part' of
6037 the Lisp event a symbol which maps to the following actions:
6039 `above_handle' page up
6040 `below_handle' page down
6041 `up' line up
6042 `down' line down
6043 `top' top of buffer
6044 `bottom' bottom of buffer
6045 `handle' thumb has been dragged.
6046 `end-scroll' end of interaction with scroll bar
6048 The incoming input_event contains in its `part' member an
6049 index of type `enum scroll_bar_part' which we can use as an
6050 index in scroll_bar_parts to get the appropriate symbol. */
6052 case SCROLL_BAR_CLICK_EVENT:
6054 Lisp_Object position, head, window, portion_whole, part;
6056 window = event->frame_or_window;
6057 portion_whole = Fcons (event->x, event->y);
6058 part = *scroll_bar_parts[(int) event->part];
6060 position
6061 = Fcons (window,
6062 Fcons (Qvertical_scroll_bar,
6063 Fcons (portion_whole,
6064 Fcons (make_number (event->timestamp),
6065 Fcons (part, Qnil)))));
6067 /* Always treat scroll bar events as clicks. */
6068 event->modifiers |= click_modifier;
6069 event->modifiers &= ~up_modifier;
6071 if (event->code >= ASIZE (mouse_syms))
6072 mouse_syms = larger_vector (mouse_syms, event->code + 1, Qnil);
6074 /* Get the symbol we should use for the mouse click. */
6075 head = modify_event_symbol (event->code,
6076 event->modifiers,
6077 Qmouse_click,
6078 Vlispy_mouse_stem,
6079 NULL, &mouse_syms,
6080 XVECTOR (mouse_syms)->size);
6081 return Fcons (head, Fcons (position, Qnil));
6084 #endif /* USE_TOOLKIT_SCROLL_BARS */
6086 case DRAG_N_DROP_EVENT:
6088 FRAME_PTR f;
6089 Lisp_Object head, position;
6090 Lisp_Object files;
6092 f = XFRAME (event->frame_or_window);
6093 files = event->arg;
6095 /* Ignore mouse events that were made on frames that
6096 have been deleted. */
6097 if (! FRAME_LIVE_P (f))
6098 return Qnil;
6100 position = make_lispy_position (f, &event->x, &event->y,
6101 event->timestamp);
6103 head = modify_event_symbol (0, event->modifiers,
6104 Qdrag_n_drop, Qnil,
6105 lispy_drag_n_drop_names,
6106 &drag_n_drop_syms, 1);
6107 return Fcons (head,
6108 Fcons (position,
6109 Fcons (files,
6110 Qnil)));
6112 #endif /* HAVE_MOUSE */
6114 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6115 || defined(HAVE_NS) || defined (USE_GTK)
6116 case MENU_BAR_EVENT:
6117 if (EQ (event->arg, event->frame_or_window))
6118 /* This is the prefix key. We translate this to
6119 `(menu_bar)' because the code in keyboard.c for menu
6120 events, which we use, relies on this. */
6121 return Fcons (Qmenu_bar, Qnil);
6122 return event->arg;
6123 #endif
6125 case SELECT_WINDOW_EVENT:
6126 /* Make an event (select-window (WINDOW)). */
6127 return Fcons (Qselect_window,
6128 Fcons (Fcons (event->frame_or_window, Qnil),
6129 Qnil));
6131 case TOOL_BAR_EVENT:
6132 if (EQ (event->arg, event->frame_or_window))
6133 /* This is the prefix key. We translate this to
6134 `(tool_bar)' because the code in keyboard.c for tool bar
6135 events, which we use, relies on this. */
6136 return Fcons (Qtool_bar, Qnil);
6137 else if (SYMBOLP (event->arg))
6138 return apply_modifiers (event->modifiers, event->arg);
6139 return event->arg;
6141 case USER_SIGNAL_EVENT:
6142 /* A user signal. */
6144 char *name = find_user_signal_name (event->code);
6145 if (!name)
6146 abort ();
6147 return intern (name);
6150 case SAVE_SESSION_EVENT:
6151 return Qsave_session;
6153 #ifdef HAVE_DBUS
6154 case DBUS_EVENT:
6156 return Fcons (Qdbus_event, event->arg);
6158 #endif /* HAVE_DBUS */
6160 #ifdef HAVE_GPM
6161 case GPM_CLICK_EVENT:
6163 FRAME_PTR f = XFRAME (event->frame_or_window);
6164 Lisp_Object head, position;
6165 Lisp_Object *start_pos_ptr;
6166 Lisp_Object start_pos;
6167 int button = event->code;
6169 if (button >= ASIZE (button_down_location))
6171 button_down_location = larger_vector (button_down_location,
6172 button + 1, Qnil);
6173 mouse_syms = larger_vector (mouse_syms, button + 1, Qnil);
6176 start_pos_ptr = &AREF (button_down_location, button);
6177 start_pos = *start_pos_ptr;
6179 position = make_lispy_position (f, &event->x, &event->y,
6180 event->timestamp);
6182 if (event->modifiers & down_modifier)
6183 *start_pos_ptr = Fcopy_alist (position);
6184 else if (event->modifiers & (up_modifier | drag_modifier))
6186 if (!CONSP (start_pos))
6187 return Qnil;
6188 event->modifiers &= ~up_modifier;
6191 head = modify_event_symbol (button,
6192 event->modifiers,
6193 Qmouse_click, Vlispy_mouse_stem,
6194 NULL,
6195 &mouse_syms,
6196 XVECTOR (mouse_syms)->size);
6198 if (event->modifiers & drag_modifier)
6199 return Fcons (head,
6200 Fcons (start_pos,
6201 Fcons (position,
6202 Qnil)));
6203 else if (event->modifiers & double_modifier)
6204 return Fcons (head,
6205 Fcons (position,
6206 Fcons (make_number (2),
6207 Qnil)));
6208 else if (event->modifiers & triple_modifier)
6209 return Fcons (head,
6210 Fcons (position,
6211 Fcons (make_number (3),
6212 Qnil)));
6213 else
6214 return Fcons (head,
6215 Fcons (position,
6216 Qnil));
6218 #endif /* HAVE_GPM */
6220 /* The 'kind' field of the event is something we don't recognize. */
6221 default:
6222 abort ();
6226 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6228 static Lisp_Object
6229 make_lispy_movement (frame, bar_window, part, x, y, time)
6230 FRAME_PTR frame;
6231 Lisp_Object bar_window;
6232 enum scroll_bar_part part;
6233 Lisp_Object x, y;
6234 unsigned long time;
6236 /* Is it a scroll bar movement? */
6237 if (frame && ! NILP (bar_window))
6239 Lisp_Object part_sym;
6241 part_sym = *scroll_bar_parts[(int) part];
6242 return Fcons (Qscroll_bar_movement,
6243 (Fcons (Fcons (bar_window,
6244 Fcons (Qvertical_scroll_bar,
6245 Fcons (Fcons (x, y),
6246 Fcons (make_number (time),
6247 Fcons (part_sym,
6248 Qnil))))),
6249 Qnil)));
6252 /* Or is it an ordinary mouse movement? */
6253 else
6255 Lisp_Object position;
6257 position = make_lispy_position (frame, &x, &y, time);
6259 return Fcons (Qmouse_movement,
6260 Fcons (position,
6261 Qnil));
6265 #endif /* HAVE_MOUSE || HAVE GPM */
6267 /* Construct a switch frame event. */
6268 static Lisp_Object
6269 make_lispy_switch_frame (frame)
6270 Lisp_Object frame;
6272 return Fcons (Qswitch_frame, Fcons (frame, Qnil));
6275 /* Manipulating modifiers. */
6277 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6279 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6280 SYMBOL's name of the end of the modifiers; the string from this
6281 position is the unmodified symbol name.
6283 This doesn't use any caches. */
6285 static int
6286 parse_modifiers_uncached (symbol, modifier_end)
6287 Lisp_Object symbol;
6288 int *modifier_end;
6290 Lisp_Object name;
6291 int i;
6292 int modifiers;
6294 CHECK_SYMBOL (symbol);
6296 modifiers = 0;
6297 name = SYMBOL_NAME (symbol);
6299 for (i = 0; i+2 <= SBYTES (name); )
6301 int this_mod_end = 0;
6302 int this_mod = 0;
6304 /* See if the name continues with a modifier word.
6305 Check that the word appears, but don't check what follows it.
6306 Set this_mod and this_mod_end to record what we find. */
6308 switch (SREF (name, i))
6310 #define SINGLE_LETTER_MOD(BIT) \
6311 (this_mod_end = i + 1, this_mod = BIT)
6313 case 'A':
6314 SINGLE_LETTER_MOD (alt_modifier);
6315 break;
6317 case 'C':
6318 SINGLE_LETTER_MOD (ctrl_modifier);
6319 break;
6321 case 'H':
6322 SINGLE_LETTER_MOD (hyper_modifier);
6323 break;
6325 case 'M':
6326 SINGLE_LETTER_MOD (meta_modifier);
6327 break;
6329 case 'S':
6330 SINGLE_LETTER_MOD (shift_modifier);
6331 break;
6333 case 's':
6334 SINGLE_LETTER_MOD (super_modifier);
6335 break;
6337 #undef SINGLE_LETTER_MOD
6339 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6340 if (i + LEN + 1 <= SBYTES (name) \
6341 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6343 this_mod_end = i + LEN; \
6344 this_mod = BIT; \
6347 case 'd':
6348 MULTI_LETTER_MOD (drag_modifier, "drag", 4);
6349 MULTI_LETTER_MOD (down_modifier, "down", 4);
6350 MULTI_LETTER_MOD (double_modifier, "double", 6);
6351 break;
6353 case 't':
6354 MULTI_LETTER_MOD (triple_modifier, "triple", 6);
6355 break;
6356 #undef MULTI_LETTER_MOD
6360 /* If we found no modifier, stop looking for them. */
6361 if (this_mod_end == 0)
6362 break;
6364 /* Check there is a dash after the modifier, so that it
6365 really is a modifier. */
6366 if (this_mod_end >= SBYTES (name)
6367 || SREF (name, this_mod_end) != '-')
6368 break;
6370 /* This modifier is real; look for another. */
6371 modifiers |= this_mod;
6372 i = this_mod_end + 1;
6375 /* Should we include the `click' modifier? */
6376 if (! (modifiers & (down_modifier | drag_modifier
6377 | double_modifier | triple_modifier))
6378 && i + 7 == SBYTES (name)
6379 && strncmp (SDATA (name) + i, "mouse-", 6) == 0
6380 && ('0' <= SREF (name, i + 6) && SREF (name, i + 6) <= '9'))
6381 modifiers |= click_modifier;
6383 if (! (modifiers & (double_modifier | triple_modifier))
6384 && i + 6 < SBYTES (name)
6385 && strncmp (SDATA (name) + i, "wheel-", 6) == 0)
6386 modifiers |= click_modifier;
6388 if (modifier_end)
6389 *modifier_end = i;
6391 return modifiers;
6394 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6395 prepended to the string BASE[0..BASE_LEN-1].
6396 This doesn't use any caches. */
6397 static Lisp_Object
6398 apply_modifiers_uncached (modifiers, base, base_len, base_len_byte)
6399 int modifiers;
6400 char *base;
6401 int base_len, base_len_byte;
6403 /* Since BASE could contain nulls, we can't use intern here; we have
6404 to use Fintern, which expects a genuine Lisp_String, and keeps a
6405 reference to it. */
6406 char *new_mods
6407 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6408 int mod_len;
6411 char *p = new_mods;
6413 /* Only the event queue may use the `up' modifier; it should always
6414 be turned into a click or drag event before presented to lisp code. */
6415 if (modifiers & up_modifier)
6416 abort ();
6418 if (modifiers & alt_modifier) { *p++ = 'A'; *p++ = '-'; }
6419 if (modifiers & ctrl_modifier) { *p++ = 'C'; *p++ = '-'; }
6420 if (modifiers & hyper_modifier) { *p++ = 'H'; *p++ = '-'; }
6421 if (modifiers & meta_modifier) { *p++ = 'M'; *p++ = '-'; }
6422 if (modifiers & shift_modifier) { *p++ = 'S'; *p++ = '-'; }
6423 if (modifiers & super_modifier) { *p++ = 's'; *p++ = '-'; }
6424 if (modifiers & double_modifier) { strcpy (p, "double-"); p += 7; }
6425 if (modifiers & triple_modifier) { strcpy (p, "triple-"); p += 7; }
6426 if (modifiers & down_modifier) { strcpy (p, "down-"); p += 5; }
6427 if (modifiers & drag_modifier) { strcpy (p, "drag-"); p += 5; }
6428 /* The click modifier is denoted by the absence of other modifiers. */
6430 *p = '\0';
6432 mod_len = p - new_mods;
6436 Lisp_Object new_name;
6438 new_name = make_uninit_multibyte_string (mod_len + base_len,
6439 mod_len + base_len_byte);
6440 bcopy (new_mods, SDATA (new_name), mod_len);
6441 bcopy (base, SDATA (new_name) + mod_len, base_len_byte);
6443 return Fintern (new_name, Qnil);
6448 static char *modifier_names[] =
6450 "up", "down", "drag", "click", "double", "triple", 0, 0,
6451 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6452 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6454 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6456 static Lisp_Object modifier_symbols;
6458 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6459 static Lisp_Object
6460 lispy_modifier_list (modifiers)
6461 int modifiers;
6463 Lisp_Object modifier_list;
6464 int i;
6466 modifier_list = Qnil;
6467 for (i = 0; (1<<i) <= modifiers && i < NUM_MOD_NAMES; i++)
6468 if (modifiers & (1<<i))
6469 modifier_list = Fcons (XVECTOR (modifier_symbols)->contents[i],
6470 modifier_list);
6472 return modifier_list;
6476 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6477 where UNMODIFIED is the unmodified form of SYMBOL,
6478 MASK is the set of modifiers present in SYMBOL's name.
6479 This is similar to parse_modifiers_uncached, but uses the cache in
6480 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6481 Qevent_symbol_elements property. */
6483 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6485 Lisp_Object
6486 parse_modifiers (symbol)
6487 Lisp_Object symbol;
6489 Lisp_Object elements;
6491 if (INTEGERP (symbol))
6492 return (Fcons (make_number (KEY_TO_CHAR (symbol)),
6493 Fcons (make_number (XINT (symbol) & CHAR_MODIFIER_MASK),
6494 Qnil)));
6495 else if (!SYMBOLP (symbol))
6496 return Qnil;
6498 elements = Fget (symbol, Qevent_symbol_element_mask);
6499 if (CONSP (elements))
6500 return elements;
6501 else
6503 int end;
6504 int modifiers = parse_modifiers_uncached (symbol, &end);
6505 Lisp_Object unmodified;
6506 Lisp_Object mask;
6508 unmodified = Fintern (make_string (SDATA (SYMBOL_NAME (symbol)) + end,
6509 SBYTES (SYMBOL_NAME (symbol)) - end),
6510 Qnil);
6512 if (modifiers & ~INTMASK)
6513 abort ();
6514 XSETFASTINT (mask, modifiers);
6515 elements = Fcons (unmodified, Fcons (mask, Qnil));
6517 /* Cache the parsing results on SYMBOL. */
6518 Fput (symbol, Qevent_symbol_element_mask,
6519 elements);
6520 Fput (symbol, Qevent_symbol_elements,
6521 Fcons (unmodified, lispy_modifier_list (modifiers)));
6523 /* Since we know that SYMBOL is modifiers applied to unmodified,
6524 it would be nice to put that in unmodified's cache.
6525 But we can't, since we're not sure that parse_modifiers is
6526 canonical. */
6528 return elements;
6532 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers,
6533 Sevent_symbol_parse_modifiers, 1, 1, 0,
6534 doc: /* Parse the event symbol. For internal use. */)
6535 (symbol)
6536 Lisp_Object symbol;
6538 /* Fill the cache if needed. */
6539 parse_modifiers (symbol);
6540 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6541 and use the Lispier representation stored on Qevent_symbol_elements
6542 instead. */
6543 return Fget (symbol, Qevent_symbol_elements);
6546 /* Apply the modifiers MODIFIERS to the symbol BASE.
6547 BASE must be unmodified.
6549 This is like apply_modifiers_uncached, but uses BASE's
6550 Qmodifier_cache property, if present. It also builds
6551 Qevent_symbol_elements properties, since it has that info anyway.
6553 apply_modifiers copies the value of BASE's Qevent_kind property to
6554 the modified symbol. */
6555 static Lisp_Object
6556 apply_modifiers (modifiers, base)
6557 int modifiers;
6558 Lisp_Object base;
6560 Lisp_Object cache, index, entry, new_symbol;
6562 /* Mask out upper bits. We don't know where this value's been. */
6563 modifiers &= INTMASK;
6565 if (INTEGERP (base))
6566 return make_number (XINT (base) | modifiers);
6568 /* The click modifier never figures into cache indices. */
6569 cache = Fget (base, Qmodifier_cache);
6570 XSETFASTINT (index, (modifiers & ~click_modifier));
6571 entry = assq_no_quit (index, cache);
6573 if (CONSP (entry))
6574 new_symbol = XCDR (entry);
6575 else
6577 /* We have to create the symbol ourselves. */
6578 new_symbol = apply_modifiers_uncached (modifiers,
6579 SDATA (SYMBOL_NAME (base)),
6580 SCHARS (SYMBOL_NAME (base)),
6581 SBYTES (SYMBOL_NAME (base)));
6583 /* Add the new symbol to the base's cache. */
6584 entry = Fcons (index, new_symbol);
6585 Fput (base, Qmodifier_cache, Fcons (entry, cache));
6587 /* We have the parsing info now for free, so we could add it to
6588 the caches:
6589 XSETFASTINT (index, modifiers);
6590 Fput (new_symbol, Qevent_symbol_element_mask,
6591 Fcons (base, Fcons (index, Qnil)));
6592 Fput (new_symbol, Qevent_symbol_elements,
6593 Fcons (base, lispy_modifier_list (modifiers)));
6594 Sadly, this is only correct if `base' is indeed a base event,
6595 which is not necessarily the case. -stef */
6598 /* Make sure this symbol is of the same kind as BASE.
6600 You'd think we could just set this once and for all when we
6601 intern the symbol above, but reorder_modifiers may call us when
6602 BASE's property isn't set right; we can't assume that just
6603 because it has a Qmodifier_cache property it must have its
6604 Qevent_kind set right as well. */
6605 if (NILP (Fget (new_symbol, Qevent_kind)))
6607 Lisp_Object kind;
6609 kind = Fget (base, Qevent_kind);
6610 if (! NILP (kind))
6611 Fput (new_symbol, Qevent_kind, kind);
6614 return new_symbol;
6618 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6619 return a symbol with the modifiers placed in the canonical order.
6620 Canonical order is alphabetical, except for down and drag, which
6621 always come last. The 'click' modifier is never written out.
6623 Fdefine_key calls this to make sure that (for example) C-M-foo
6624 and M-C-foo end up being equivalent in the keymap. */
6626 Lisp_Object
6627 reorder_modifiers (symbol)
6628 Lisp_Object symbol;
6630 /* It's hopefully okay to write the code this way, since everything
6631 will soon be in caches, and no consing will be done at all. */
6632 Lisp_Object parsed;
6634 parsed = parse_modifiers (symbol);
6635 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed))),
6636 XCAR (parsed));
6640 /* For handling events, we often want to produce a symbol whose name
6641 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6642 to some base, like the name of a function key or mouse button.
6643 modify_event_symbol produces symbols of this sort.
6645 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6646 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6647 in the table.
6649 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6650 into symbol names, or a string specifying a name stem used to
6651 construct a symbol name or the form `STEM-N', where N is the decimal
6652 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6653 non-nil; otherwise NAME_TABLE is used.
6655 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6656 persist between calls to modify_event_symbol that it can use to
6657 store a cache of the symbols it's generated for this NAME_TABLE
6658 before. The object stored there may be a vector or an alist.
6660 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6662 MODIFIERS is a set of modifier bits (as given in struct input_events)
6663 whose prefixes should be applied to the symbol name.
6665 SYMBOL_KIND is the value to be placed in the event_kind property of
6666 the returned symbol.
6668 The symbols we create are supposed to have an
6669 `event-symbol-elements' property, which lists the modifiers present
6670 in the symbol's name. */
6672 static Lisp_Object
6673 modify_event_symbol (symbol_num, modifiers, symbol_kind, name_alist_or_stem,
6674 name_table, symbol_table, table_size)
6675 int symbol_num;
6676 unsigned modifiers;
6677 Lisp_Object symbol_kind;
6678 Lisp_Object name_alist_or_stem;
6679 char **name_table;
6680 Lisp_Object *symbol_table;
6681 unsigned int table_size;
6683 Lisp_Object value;
6684 Lisp_Object symbol_int;
6686 /* Get rid of the "vendor-specific" bit here. */
6687 XSETINT (symbol_int, symbol_num & 0xffffff);
6689 /* Is this a request for a valid symbol? */
6690 if (symbol_num < 0 || symbol_num >= table_size)
6691 return Qnil;
6693 if (CONSP (*symbol_table))
6694 value = Fcdr (assq_no_quit (symbol_int, *symbol_table));
6696 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6697 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6698 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6699 we've never used that symbol before. */
6700 else
6702 if (! VECTORP (*symbol_table)
6703 || XVECTOR (*symbol_table)->size != table_size)
6705 Lisp_Object size;
6707 XSETFASTINT (size, table_size);
6708 *symbol_table = Fmake_vector (size, Qnil);
6711 value = XVECTOR (*symbol_table)->contents[symbol_num];
6714 /* Have we already used this symbol before? */
6715 if (NILP (value))
6717 /* No; let's create it. */
6718 if (CONSP (name_alist_or_stem))
6719 value = Fcdr_safe (Fassq (symbol_int, name_alist_or_stem));
6720 else if (STRINGP (name_alist_or_stem))
6722 int len = SBYTES (name_alist_or_stem);
6723 char *buf = (char *) alloca (len + 50);
6724 sprintf (buf, "%s-%ld", SDATA (name_alist_or_stem),
6725 (long) XINT (symbol_int) + 1);
6726 value = intern (buf);
6728 else if (name_table != 0 && name_table[symbol_num])
6729 value = intern (name_table[symbol_num]);
6731 #ifdef HAVE_WINDOW_SYSTEM
6732 if (NILP (value))
6734 char *name = x_get_keysym_name (symbol_num);
6735 if (name)
6736 value = intern (name);
6738 #endif
6740 if (NILP (value))
6742 char buf[20];
6743 sprintf (buf, "key-%d", symbol_num);
6744 value = intern (buf);
6747 if (CONSP (*symbol_table))
6748 *symbol_table = Fcons (Fcons (symbol_int, value), *symbol_table);
6749 else
6750 XVECTOR (*symbol_table)->contents[symbol_num] = value;
6752 /* Fill in the cache entries for this symbol; this also
6753 builds the Qevent_symbol_elements property, which the user
6754 cares about. */
6755 apply_modifiers (modifiers & click_modifier, value);
6756 Fput (value, Qevent_kind, symbol_kind);
6759 /* Apply modifiers to that symbol. */
6760 return apply_modifiers (modifiers, value);
6763 /* Convert a list that represents an event type,
6764 such as (ctrl meta backspace), into the usual representation of that
6765 event type as a number or a symbol. */
6767 DEFUN ("event-convert-list", Fevent_convert_list, Sevent_convert_list, 1, 1, 0,
6768 doc: /* Convert the event description list EVENT-DESC to an event type.
6769 EVENT-DESC should contain one base event type (a character or symbol)
6770 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6771 drag, down, double or triple). The base must be last.
6772 The return value is an event type (a character or symbol) which
6773 has the same base event type and all the specified modifiers. */)
6774 (event_desc)
6775 Lisp_Object event_desc;
6777 Lisp_Object base;
6778 int modifiers = 0;
6779 Lisp_Object rest;
6781 base = Qnil;
6782 rest = event_desc;
6783 while (CONSP (rest))
6785 Lisp_Object elt;
6786 int this = 0;
6788 elt = XCAR (rest);
6789 rest = XCDR (rest);
6791 /* Given a symbol, see if it is a modifier name. */
6792 if (SYMBOLP (elt) && CONSP (rest))
6793 this = parse_solitary_modifier (elt);
6795 if (this != 0)
6796 modifiers |= this;
6797 else if (!NILP (base))
6798 error ("Two bases given in one event");
6799 else
6800 base = elt;
6804 /* Let the symbol A refer to the character A. */
6805 if (SYMBOLP (base) && SCHARS (SYMBOL_NAME (base)) == 1)
6806 XSETINT (base, SREF (SYMBOL_NAME (base), 0));
6808 if (INTEGERP (base))
6810 /* Turn (shift a) into A. */
6811 if ((modifiers & shift_modifier) != 0
6812 && (XINT (base) >= 'a' && XINT (base) <= 'z'))
6814 XSETINT (base, XINT (base) - ('a' - 'A'));
6815 modifiers &= ~shift_modifier;
6818 /* Turn (control a) into C-a. */
6819 if (modifiers & ctrl_modifier)
6820 return make_number ((modifiers & ~ctrl_modifier)
6821 | make_ctrl_char (XINT (base)));
6822 else
6823 return make_number (modifiers | XINT (base));
6825 else if (SYMBOLP (base))
6826 return apply_modifiers (modifiers, base);
6827 else
6829 error ("Invalid base event");
6830 return Qnil;
6834 /* Try to recognize SYMBOL as a modifier name.
6835 Return the modifier flag bit, or 0 if not recognized. */
6838 parse_solitary_modifier (Lisp_Object symbol)
6840 Lisp_Object name = SYMBOL_NAME (symbol);
6842 switch (SREF (name, 0))
6844 #define SINGLE_LETTER_MOD(BIT) \
6845 if (SBYTES (name) == 1) \
6846 return BIT;
6848 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6849 if (LEN == SBYTES (name) \
6850 && ! strncmp (SDATA (name), NAME, LEN)) \
6851 return BIT;
6853 case 'A':
6854 SINGLE_LETTER_MOD (alt_modifier);
6855 break;
6857 case 'a':
6858 MULTI_LETTER_MOD (alt_modifier, "alt", 3);
6859 break;
6861 case 'C':
6862 SINGLE_LETTER_MOD (ctrl_modifier);
6863 break;
6865 case 'c':
6866 MULTI_LETTER_MOD (ctrl_modifier, "ctrl", 4);
6867 MULTI_LETTER_MOD (ctrl_modifier, "control", 7);
6868 break;
6870 case 'H':
6871 SINGLE_LETTER_MOD (hyper_modifier);
6872 break;
6874 case 'h':
6875 MULTI_LETTER_MOD (hyper_modifier, "hyper", 5);
6876 break;
6878 case 'M':
6879 SINGLE_LETTER_MOD (meta_modifier);
6880 break;
6882 case 'm':
6883 MULTI_LETTER_MOD (meta_modifier, "meta", 4);
6884 break;
6886 case 'S':
6887 SINGLE_LETTER_MOD (shift_modifier);
6888 break;
6890 case 's':
6891 MULTI_LETTER_MOD (shift_modifier, "shift", 5);
6892 MULTI_LETTER_MOD (super_modifier, "super", 5);
6893 SINGLE_LETTER_MOD (super_modifier);
6894 break;
6896 case 'd':
6897 MULTI_LETTER_MOD (drag_modifier, "drag", 4);
6898 MULTI_LETTER_MOD (down_modifier, "down", 4);
6899 MULTI_LETTER_MOD (double_modifier, "double", 6);
6900 break;
6902 case 't':
6903 MULTI_LETTER_MOD (triple_modifier, "triple", 6);
6904 break;
6906 #undef SINGLE_LETTER_MOD
6907 #undef MULTI_LETTER_MOD
6910 return 0;
6913 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6914 Such a list is not valid as an event,
6915 but it can be a Lucid-style event type list. */
6918 lucid_event_type_list_p (object)
6919 Lisp_Object object;
6921 Lisp_Object tail;
6923 if (! CONSP (object))
6924 return 0;
6926 if (EQ (XCAR (object), Qhelp_echo)
6927 || EQ (XCAR (object), Qvertical_line)
6928 || EQ (XCAR (object), Qmode_line)
6929 || EQ (XCAR (object), Qheader_line))
6930 return 0;
6932 for (tail = object; CONSP (tail); tail = XCDR (tail))
6934 Lisp_Object elt;
6935 elt = XCAR (tail);
6936 if (! (INTEGERP (elt) || SYMBOLP (elt)))
6937 return 0;
6940 return NILP (tail);
6943 /* Store into *addr a value nonzero if terminal input chars are available.
6944 Serves the purpose of ioctl (0, FIONREAD, addr)
6945 but works even if FIONREAD does not exist.
6946 (In fact, this may actually read some input.)
6948 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6949 timer events that are ripe.
6950 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6951 events (FOCUS_IN_EVENT).
6952 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6953 movements and toolkit scroll bar thumb drags. */
6955 static void
6956 get_input_pending (addr, flags)
6957 int *addr;
6958 int flags;
6960 /* First of all, have we already counted some input? */
6961 *addr = (!NILP (Vquit_flag) || readable_events (flags));
6963 /* If input is being read as it arrives, and we have none, there is none. */
6964 if (*addr > 0 || (interrupt_input && ! interrupts_deferred))
6965 return;
6967 /* Try to read some input and see how much we get. */
6968 gobble_input (0);
6969 *addr = (!NILP (Vquit_flag) || readable_events (flags));
6972 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6974 void
6975 gobble_input (expected)
6976 int expected;
6978 #ifdef HAVE_DBUS
6979 /* Check whether a D-Bus message has arrived. */
6980 xd_read_queued_messages ();
6981 #endif /* HAVE_DBUS */
6983 #ifdef SIGIO
6984 if (interrupt_input)
6986 SIGMASKTYPE mask;
6987 mask = sigblock (sigmask (SIGIO));
6988 read_avail_input (expected);
6989 sigsetmask (mask);
6991 else
6992 #ifdef POLL_FOR_INPUT
6993 /* XXX This condition was (read_socket_hook && !interrupt_input),
6994 but read_socket_hook is not global anymore. Let's pretend that
6995 it's always set. */
6996 if (!interrupt_input && poll_suppress_count == 0)
6998 SIGMASKTYPE mask;
6999 mask = sigblock (sigmask (SIGALRM));
7000 read_avail_input (expected);
7001 sigsetmask (mask);
7003 else
7004 #endif
7005 #endif
7006 read_avail_input (expected);
7009 /* Put a BUFFER_SWITCH_EVENT in the buffer
7010 so that read_key_sequence will notice the new current buffer. */
7012 void
7013 record_asynch_buffer_change ()
7015 struct input_event event;
7016 Lisp_Object tem;
7017 EVENT_INIT (event);
7019 event.kind = BUFFER_SWITCH_EVENT;
7020 event.frame_or_window = Qnil;
7021 event.arg = Qnil;
7023 #ifdef subprocesses
7024 /* We don't need a buffer-switch event unless Emacs is waiting for input.
7025 The purpose of the event is to make read_key_sequence look up the
7026 keymaps again. If we aren't in read_key_sequence, we don't need one,
7027 and the event could cause trouble by messing up (input-pending-p). */
7028 tem = Fwaiting_for_user_input_p ();
7029 if (NILP (tem))
7030 return;
7031 #else
7032 /* We never need these events if we have no asynchronous subprocesses. */
7033 return;
7034 #endif
7036 /* Make sure no interrupt happens while storing the event. */
7037 #ifdef SIGIO
7038 if (interrupt_input)
7040 SIGMASKTYPE mask;
7041 mask = sigblock (sigmask (SIGIO));
7042 kbd_buffer_store_event (&event);
7043 sigsetmask (mask);
7045 else
7046 #endif
7048 stop_polling ();
7049 kbd_buffer_store_event (&event);
7050 start_polling ();
7054 /* Read any terminal input already buffered up by the system
7055 into the kbd_buffer, but do not wait.
7057 EXPECTED should be nonzero if the caller knows there is some input.
7059 Returns the number of keyboard chars read, or -1 meaning
7060 this is a bad time to try to read input. */
7062 static int
7063 read_avail_input (expected)
7064 int expected;
7066 int nread = 0;
7067 int err = 0;
7068 struct terminal *t;
7070 /* Store pending user signal events, if any. */
7071 if (store_user_signal_events ())
7072 expected = 0;
7074 /* Loop through the available terminals, and call their input hooks. */
7075 t = terminal_list;
7076 while (t)
7078 struct terminal *next = t->next_terminal;
7080 if (t->read_socket_hook)
7082 int nr;
7083 struct input_event hold_quit;
7085 EVENT_INIT (hold_quit);
7086 hold_quit.kind = NO_EVENT;
7088 /* No need for FIONREAD or fcntl; just say don't wait. */
7089 while (nr = (*t->read_socket_hook) (t, expected, &hold_quit), nr > 0)
7091 nread += nr;
7092 expected = 0;
7095 if (nr == -1) /* Not OK to read input now. */
7097 err = 1;
7099 else if (nr == -2) /* Non-transient error. */
7101 /* The terminal device terminated; it should be closed. */
7103 /* Kill Emacs if this was our last terminal. */
7104 if (!terminal_list->next_terminal)
7105 /* Formerly simply reported no input, but that
7106 sometimes led to a failure of Emacs to terminate.
7107 SIGHUP seems appropriate if we can't reach the
7108 terminal. */
7109 /* ??? Is it really right to send the signal just to
7110 this process rather than to the whole process
7111 group? Perhaps on systems with FIONREAD Emacs is
7112 alone in its group. */
7113 kill (getpid (), SIGHUP);
7115 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
7117 Lisp_Object tmp;
7118 XSETTERMINAL (tmp, t);
7119 Fdelete_terminal (tmp, Qnoelisp);
7123 if (hold_quit.kind != NO_EVENT)
7124 kbd_buffer_store_event (&hold_quit);
7127 t = next;
7130 if (err && !nread)
7131 nread = -1;
7133 return nread;
7136 /* This is the tty way of reading available input.
7138 Note that each terminal device has its own `struct terminal' object,
7139 and so this function is called once for each individual termcap
7140 terminal. The first parameter indicates which terminal to read from. */
7143 tty_read_avail_input (struct terminal *terminal,
7144 int expected,
7145 struct input_event *hold_quit)
7147 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7148 the kbd_buffer can really hold. That may prevent loss
7149 of characters on some systems when input is stuffed at us. */
7150 unsigned char cbuf[KBD_BUFFER_SIZE - 1];
7151 int n_to_read, i;
7152 struct tty_display_info *tty = terminal->display_info.tty;
7153 int nread = 0;
7155 if (!terminal->name) /* Don't read from a dead terminal. */
7156 return 0;
7158 if (terminal->type != output_termcap
7159 && terminal->type != output_msdos_raw)
7160 abort ();
7162 /* XXX I think the following code should be moved to separate hook
7163 functions in system-dependent files. */
7164 #ifdef WINDOWSNT
7165 return 0;
7166 #else /* not WINDOWSNT */
7167 if (! tty->term_initted) /* In case we get called during bootstrap. */
7168 return 0;
7170 if (! tty->input)
7171 return 0; /* The terminal is suspended. */
7173 #ifdef MSDOS
7174 n_to_read = dos_keysns ();
7175 if (n_to_read == 0)
7176 return 0;
7178 cbuf[0] = dos_keyread ();
7179 nread = 1;
7181 #else /* not MSDOS */
7182 #ifdef HAVE_GPM
7183 if (gpm_tty == tty)
7185 Gpm_Event event;
7186 struct input_event hold_quit;
7187 int gpm, fd = gpm_fd;
7189 EVENT_INIT (hold_quit);
7190 hold_quit.kind = NO_EVENT;
7192 /* gpm==1 if event received.
7193 gpm==0 if the GPM daemon has closed the connection, in which case
7194 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7195 we save it in `fd' so close_gpm can remove it from the
7196 select masks.
7197 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7198 while (gpm = Gpm_GetEvent (&event), gpm == 1) {
7199 nread += handle_one_term_event (tty, &event, &hold_quit);
7201 if (gpm == 0)
7202 /* Presumably the GPM daemon has closed the connection. */
7203 close_gpm (fd);
7204 if (hold_quit.kind != NO_EVENT)
7205 kbd_buffer_store_event (&hold_quit);
7206 if (nread)
7207 return nread;
7209 #endif /* HAVE_GPM */
7211 /* Determine how many characters we should *try* to read. */
7212 #ifdef FIONREAD
7213 /* Find out how much input is available. */
7214 if (ioctl (fileno (tty->input), FIONREAD, &n_to_read) < 0)
7216 if (! noninteractive)
7217 return -2; /* Close this terminal. */
7218 else
7219 n_to_read = 0;
7221 if (n_to_read == 0)
7222 return 0;
7223 if (n_to_read > sizeof cbuf)
7224 n_to_read = sizeof cbuf;
7225 #else /* no FIONREAD */
7226 #if defined (USG) || defined(CYGWIN)
7227 /* Read some input if available, but don't wait. */
7228 n_to_read = sizeof cbuf;
7229 fcntl (fileno (tty->input), F_SETFL, O_NDELAY);
7230 #else
7231 you lose;
7232 #endif
7233 #endif
7235 /* Now read; for one reason or another, this will not block.
7236 NREAD is set to the number of chars read. */
7239 nread = emacs_read (fileno (tty->input), cbuf, n_to_read);
7240 /* POSIX infers that processes which are not in the session leader's
7241 process group won't get SIGHUP's at logout time. BSDI adheres to
7242 this part standard and returns -1 from read (0) with errno==EIO
7243 when the control tty is taken away.
7244 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7245 if (nread == -1 && errno == EIO)
7246 return -2; /* Close this terminal. */
7247 #if defined (AIX) && defined (_BSD)
7248 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7249 This looks incorrect, but it isn't, because _BSD causes
7250 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7251 and that causes a value other than 0 when there is no input. */
7252 if (nread == 0)
7253 return -2; /* Close this terminal. */
7254 #endif
7256 while (
7257 /* We used to retry the read if it was interrupted.
7258 But this does the wrong thing when O_NDELAY causes
7259 an EAGAIN error. Does anybody know of a situation
7260 where a retry is actually needed? */
7261 #if 0
7262 nread < 0 && (errno == EAGAIN
7263 #ifdef EFAULT
7264 || errno == EFAULT
7265 #endif
7266 #ifdef EBADSLT
7267 || errno == EBADSLT
7268 #endif
7270 #else
7272 #endif
7275 #ifndef FIONREAD
7276 #if defined (USG) || defined (CYGWIN)
7277 fcntl (fileno (tty->input), F_SETFL, 0);
7278 #endif /* USG or CYGWIN */
7279 #endif /* no FIONREAD */
7281 if (nread <= 0)
7282 return nread;
7284 #endif /* not MSDOS */
7285 #endif /* not WINDOWSNT */
7287 for (i = 0; i < nread; i++)
7289 struct input_event buf;
7290 EVENT_INIT (buf);
7291 buf.kind = ASCII_KEYSTROKE_EVENT;
7292 buf.modifiers = 0;
7293 if (tty->meta_key == 1 && (cbuf[i] & 0x80))
7294 buf.modifiers = meta_modifier;
7295 if (tty->meta_key != 2)
7296 cbuf[i] &= ~0x80;
7298 buf.code = cbuf[i];
7299 /* Set the frame corresponding to the active tty. Note that the
7300 value of selected_frame is not reliable here, redisplay tends
7301 to temporarily change it. */
7302 buf.frame_or_window = tty->top_frame;
7303 buf.arg = Qnil;
7305 kbd_buffer_store_event (&buf);
7306 /* Don't look at input that follows a C-g too closely.
7307 This reduces lossage due to autorepeat on C-g. */
7308 if (buf.kind == ASCII_KEYSTROKE_EVENT
7309 && buf.code == quit_char)
7310 break;
7313 return nread;
7316 void
7317 handle_async_input ()
7319 interrupt_input_pending = 0;
7320 #ifdef SYNC_INPUT
7321 pending_signals = pending_atimers;
7322 #endif
7323 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7324 doing anything dangerous. */
7325 #ifdef HAVE_NS
7326 ++handling_signal;
7327 #endif
7328 while (1)
7330 int nread;
7331 nread = read_avail_input (1);
7332 /* -1 means it's not ok to read the input now.
7333 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7334 0 means there was no keyboard input available. */
7335 if (nread <= 0)
7336 break;
7338 #ifdef HAVE_NS
7339 --handling_signal;
7340 #endif
7343 void
7344 process_pending_signals ()
7346 if (interrupt_input_pending)
7347 handle_async_input ();
7348 do_pending_atimers ();
7351 #ifdef SIGIO /* for entire page */
7352 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7354 static SIGTYPE
7355 input_available_signal (signo)
7356 int signo;
7358 /* Must preserve main program's value of errno. */
7359 int old_errno = errno;
7360 #if defined (USG) && !defined (POSIX_SIGNALS)
7361 /* USG systems forget handlers when they are used;
7362 must reestablish each time */
7363 signal (signo, input_available_signal);
7364 #endif /* USG */
7366 #ifdef SYNC_INPUT
7367 interrupt_input_pending = 1;
7368 pending_signals = 1;
7369 #else
7370 SIGNAL_THREAD_CHECK (signo);
7371 #endif
7373 if (input_available_clear_time)
7374 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
7376 #ifndef SYNC_INPUT
7377 handle_async_input ();
7378 #endif
7380 errno = old_errno;
7382 #endif /* SIGIO */
7384 /* Send ourselves a SIGIO.
7386 This function exists so that the UNBLOCK_INPUT macro in
7387 blockinput.h can have some way to take care of input we put off
7388 dealing with, without assuming that every file which uses
7389 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7390 void
7391 reinvoke_input_signal ()
7393 #ifdef SIGIO
7394 handle_async_input ();
7395 #endif
7400 /* User signal events. */
7402 struct user_signal_info
7404 /* Signal number. */
7405 int sig;
7407 /* Name of the signal. */
7408 char *name;
7410 /* Number of pending signals. */
7411 int npending;
7413 struct user_signal_info *next;
7416 /* List of user signals. */
7417 static struct user_signal_info *user_signals = NULL;
7419 void
7420 add_user_signal (sig, name)
7421 int sig;
7422 const char *name;
7424 struct user_signal_info *p;
7426 for (p = user_signals; p; p = p->next)
7427 if (p->sig == sig)
7428 /* Already added. */
7429 return;
7431 p = xmalloc (sizeof (struct user_signal_info));
7432 p->sig = sig;
7433 p->name = xstrdup (name);
7434 p->npending = 0;
7435 p->next = user_signals;
7436 user_signals = p;
7438 signal (sig, handle_user_signal);
7441 static SIGTYPE
7442 handle_user_signal (sig)
7443 int sig;
7445 int old_errno = errno;
7446 struct user_signal_info *p;
7448 #if defined (USG) && !defined (POSIX_SIGNALS)
7449 /* USG systems forget handlers when they are used;
7450 must reestablish each time */
7451 signal (sig, handle_user_signal);
7452 #endif
7454 SIGNAL_THREAD_CHECK (sig);
7456 for (p = user_signals; p; p = p->next)
7457 if (p->sig == sig)
7459 p->npending++;
7460 #ifdef SIGIO
7461 if (interrupt_input)
7462 kill (getpid (), SIGIO);
7463 else
7464 #endif
7466 /* Tell wait_reading_process_output that it needs to wake
7467 up and look around. */
7468 if (input_available_clear_time)
7469 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
7471 break;
7474 errno = old_errno;
7477 static char *
7478 find_user_signal_name (sig)
7479 int sig;
7481 struct user_signal_info *p;
7483 for (p = user_signals; p; p = p->next)
7484 if (p->sig == sig)
7485 return p->name;
7487 return NULL;
7490 static int
7491 store_user_signal_events ()
7493 struct user_signal_info *p;
7494 struct input_event buf;
7495 int nstored = 0;
7497 for (p = user_signals; p; p = p->next)
7498 if (p->npending > 0)
7500 SIGMASKTYPE mask;
7502 if (nstored == 0)
7504 bzero (&buf, sizeof buf);
7505 buf.kind = USER_SIGNAL_EVENT;
7506 buf.frame_or_window = selected_frame;
7508 nstored += p->npending;
7510 mask = sigblock (sigmask (p->sig));
7513 buf.code = p->sig;
7514 kbd_buffer_store_event (&buf);
7515 p->npending--;
7517 while (p->npending > 0);
7518 sigsetmask (mask);
7521 return nstored;
7525 static void menu_bar_item P_ ((Lisp_Object, Lisp_Object, Lisp_Object, void*));
7526 static Lisp_Object menu_bar_one_keymap_changed_items;
7528 /* These variables hold the vector under construction within
7529 menu_bar_items and its subroutines, and the current index
7530 for storing into that vector. */
7531 static Lisp_Object menu_bar_items_vector;
7532 static int menu_bar_items_index;
7534 /* Return a vector of menu items for a menu bar, appropriate
7535 to the current buffer. Each item has three elements in the vector:
7536 KEY STRING MAPLIST.
7538 OLD is an old vector we can optionally reuse, or nil. */
7540 Lisp_Object
7541 menu_bar_items (old)
7542 Lisp_Object old;
7544 /* The number of keymaps we're scanning right now, and the number of
7545 keymaps we have allocated space for. */
7546 int nmaps;
7548 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7549 in the current keymaps, or nil where it is not a prefix. */
7550 Lisp_Object *maps;
7552 Lisp_Object def, tail;
7554 Lisp_Object result;
7556 int mapno;
7557 Lisp_Object oquit;
7559 int i;
7561 /* In order to build the menus, we need to call the keymap
7562 accessors. They all call QUIT. But this function is called
7563 during redisplay, during which a quit is fatal. So inhibit
7564 quitting while building the menus.
7565 We do this instead of specbind because (1) errors will clear it anyway
7566 and (2) this avoids risk of specpdl overflow. */
7567 oquit = Vinhibit_quit;
7568 Vinhibit_quit = Qt;
7570 if (!NILP (old))
7571 menu_bar_items_vector = old;
7572 else
7573 menu_bar_items_vector = Fmake_vector (make_number (24), Qnil);
7574 menu_bar_items_index = 0;
7576 /* Build our list of keymaps.
7577 If we recognize a function key and replace its escape sequence in
7578 keybuf with its symbol, or if the sequence starts with a mouse
7579 click and we need to switch buffers, we jump back here to rebuild
7580 the initial keymaps from the current buffer. */
7582 Lisp_Object *tmaps;
7584 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7585 if (!NILP (Voverriding_local_map_menu_flag))
7587 /* Yes, use them (if non-nil) as well as the global map. */
7588 maps = (Lisp_Object *) alloca (3 * sizeof (maps[0]));
7589 nmaps = 0;
7590 if (!NILP (current_kboard->Voverriding_terminal_local_map))
7591 maps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
7592 if (!NILP (Voverriding_local_map))
7593 maps[nmaps++] = Voverriding_local_map;
7595 else
7597 /* No, so use major and minor mode keymaps and keymap property.
7598 Note that menu-bar bindings in the local-map and keymap
7599 properties may not work reliable, as they are only
7600 recognized when the menu-bar (or mode-line) is updated,
7601 which does not normally happen after every command. */
7602 Lisp_Object tem;
7603 int nminor;
7604 nminor = current_minor_maps (NULL, &tmaps);
7605 maps = (Lisp_Object *) alloca ((nminor + 3) * sizeof (maps[0]));
7606 nmaps = 0;
7607 if (tem = get_local_map (PT, current_buffer, Qkeymap), !NILP (tem))
7608 maps[nmaps++] = tem;
7609 bcopy (tmaps, (void *) (maps + nmaps), nminor * sizeof (maps[0]));
7610 nmaps += nminor;
7611 maps[nmaps++] = get_local_map (PT, current_buffer, Qlocal_map);
7613 maps[nmaps++] = current_global_map;
7616 /* Look up in each map the dummy prefix key `menu-bar'. */
7618 result = Qnil;
7620 for (mapno = nmaps - 1; mapno >= 0; mapno--)
7621 if (!NILP (maps[mapno]))
7623 def = get_keymap (access_keymap (maps[mapno], Qmenu_bar, 1, 0, 1),
7624 0, 1);
7625 if (CONSP (def))
7627 menu_bar_one_keymap_changed_items = Qnil;
7628 map_keymap (def, menu_bar_item, Qnil, NULL, 1);
7632 /* Move to the end those items that should be at the end. */
7634 for (tail = Vmenu_bar_final_items; CONSP (tail); tail = XCDR (tail))
7636 int i;
7637 int end = menu_bar_items_index;
7639 for (i = 0; i < end; i += 4)
7640 if (EQ (XCAR (tail), XVECTOR (menu_bar_items_vector)->contents[i]))
7642 Lisp_Object tem0, tem1, tem2, tem3;
7643 /* Move the item at index I to the end,
7644 shifting all the others forward. */
7645 tem0 = XVECTOR (menu_bar_items_vector)->contents[i + 0];
7646 tem1 = XVECTOR (menu_bar_items_vector)->contents[i + 1];
7647 tem2 = XVECTOR (menu_bar_items_vector)->contents[i + 2];
7648 tem3 = XVECTOR (menu_bar_items_vector)->contents[i + 3];
7649 if (end > i + 4)
7650 bcopy (&XVECTOR (menu_bar_items_vector)->contents[i + 4],
7651 &XVECTOR (menu_bar_items_vector)->contents[i],
7652 (end - i - 4) * sizeof (Lisp_Object));
7653 XVECTOR (menu_bar_items_vector)->contents[end - 4] = tem0;
7654 XVECTOR (menu_bar_items_vector)->contents[end - 3] = tem1;
7655 XVECTOR (menu_bar_items_vector)->contents[end - 2] = tem2;
7656 XVECTOR (menu_bar_items_vector)->contents[end - 1] = tem3;
7657 break;
7661 /* Add nil, nil, nil, nil at the end. */
7662 i = menu_bar_items_index;
7663 if (i + 4 > XVECTOR (menu_bar_items_vector)->size)
7664 menu_bar_items_vector = larger_vector (menu_bar_items_vector, 2 * i, Qnil);
7665 /* Add this item. */
7666 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
7667 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
7668 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
7669 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
7670 menu_bar_items_index = i;
7672 Vinhibit_quit = oquit;
7673 return menu_bar_items_vector;
7676 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7677 If there's already an item for KEY, add this DEF to it. */
7679 Lisp_Object item_properties;
7681 static void
7682 menu_bar_item (key, item, dummy1, dummy2)
7683 Lisp_Object key, item, dummy1;
7684 void *dummy2;
7686 struct gcpro gcpro1;
7687 int i;
7688 Lisp_Object tem;
7690 if (EQ (item, Qundefined))
7692 /* If a map has an explicit `undefined' as definition,
7693 discard any previously made menu bar item. */
7695 for (i = 0; i < menu_bar_items_index; i += 4)
7696 if (EQ (key, XVECTOR (menu_bar_items_vector)->contents[i]))
7698 if (menu_bar_items_index > i + 4)
7699 bcopy (&XVECTOR (menu_bar_items_vector)->contents[i + 4],
7700 &XVECTOR (menu_bar_items_vector)->contents[i],
7701 (menu_bar_items_index - i - 4) * sizeof (Lisp_Object));
7702 menu_bar_items_index -= 4;
7706 /* If this keymap has already contributed to this KEY,
7707 don't contribute to it a second time. */
7708 tem = Fmemq (key, menu_bar_one_keymap_changed_items);
7709 if (!NILP (tem) || NILP (item))
7710 return;
7712 menu_bar_one_keymap_changed_items
7713 = Fcons (key, menu_bar_one_keymap_changed_items);
7715 /* We add to menu_bar_one_keymap_changed_items before doing the
7716 parse_menu_item, so that if it turns out it wasn't a menu item,
7717 it still correctly hides any further menu item. */
7718 GCPRO1 (key);
7719 i = parse_menu_item (item, 0, 1);
7720 UNGCPRO;
7721 if (!i)
7722 return;
7724 item = XVECTOR (item_properties)->contents[ITEM_PROPERTY_DEF];
7726 /* Find any existing item for this KEY. */
7727 for (i = 0; i < menu_bar_items_index; i += 4)
7728 if (EQ (key, XVECTOR (menu_bar_items_vector)->contents[i]))
7729 break;
7731 /* If we did not find this KEY, add it at the end. */
7732 if (i == menu_bar_items_index)
7734 /* If vector is too small, get a bigger one. */
7735 if (i + 4 > XVECTOR (menu_bar_items_vector)->size)
7736 menu_bar_items_vector = larger_vector (menu_bar_items_vector, 2 * i, Qnil);
7737 /* Add this item. */
7738 XVECTOR (menu_bar_items_vector)->contents[i++] = key;
7739 XVECTOR (menu_bar_items_vector)->contents[i++]
7740 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_NAME];
7741 XVECTOR (menu_bar_items_vector)->contents[i++] = Fcons (item, Qnil);
7742 XVECTOR (menu_bar_items_vector)->contents[i++] = make_number (0);
7743 menu_bar_items_index = i;
7745 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7746 else
7748 Lisp_Object old;
7749 old = XVECTOR (menu_bar_items_vector)->contents[i + 2];
7750 /* If the new and the old items are not both keymaps,
7751 the lookup will only find `item'. */
7752 item = Fcons (item, KEYMAPP (item) && KEYMAPP (XCAR (old)) ? old : Qnil);
7753 XVECTOR (menu_bar_items_vector)->contents[i + 2] = item;
7757 /* This is used as the handler when calling menu_item_eval_property. */
7758 static Lisp_Object
7759 menu_item_eval_property_1 (arg)
7760 Lisp_Object arg;
7762 /* If we got a quit from within the menu computation,
7763 quit all the way out of it. This takes care of C-] in the debugger. */
7764 if (CONSP (arg) && EQ (XCAR (arg), Qquit))
7765 Fsignal (Qquit, Qnil);
7767 return Qnil;
7770 /* Evaluate an expression and return the result (or nil if something
7771 went wrong). Used to evaluate dynamic parts of menu items. */
7772 Lisp_Object
7773 menu_item_eval_property (sexpr)
7774 Lisp_Object sexpr;
7776 int count = SPECPDL_INDEX ();
7777 Lisp_Object val;
7778 specbind (Qinhibit_redisplay, Qt);
7779 val = internal_condition_case_1 (Feval, sexpr, Qerror,
7780 menu_item_eval_property_1);
7781 return unbind_to (count, val);
7784 /* This function parses a menu item and leaves the result in the
7785 vector item_properties.
7786 ITEM is a key binding, a possible menu item.
7787 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7788 evaluate dynamic expressions in the menu item.
7789 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7790 top level.
7791 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7792 parse_menu_item returns true if the item is a menu item and false
7793 otherwise. */
7796 parse_menu_item (item, notreal, inmenubar)
7797 Lisp_Object item;
7798 int notreal, inmenubar;
7800 Lisp_Object def, tem, item_string, start;
7801 Lisp_Object cachelist;
7802 Lisp_Object filter;
7803 Lisp_Object keyhint;
7804 int i;
7805 int newcache = 0;
7807 cachelist = Qnil;
7808 filter = Qnil;
7809 keyhint = Qnil;
7811 if (!CONSP (item))
7812 return 0;
7814 /* Create item_properties vector if necessary. */
7815 if (NILP (item_properties))
7816 item_properties
7817 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE + 1), Qnil);
7819 /* Initialize optional entries. */
7820 for (i = ITEM_PROPERTY_DEF; i < ITEM_PROPERTY_ENABLE; i++)
7821 ASET (item_properties, i, Qnil);
7822 ASET (item_properties, ITEM_PROPERTY_ENABLE, Qt);
7824 /* Save the item here to protect it from GC. */
7825 ASET (item_properties, ITEM_PROPERTY_ITEM, item);
7827 item_string = XCAR (item);
7829 start = item;
7830 item = XCDR (item);
7831 if (STRINGP (item_string))
7833 /* Old format menu item. */
7834 ASET (item_properties, ITEM_PROPERTY_NAME, item_string);
7836 /* Maybe help string. */
7837 if (CONSP (item) && STRINGP (XCAR (item)))
7839 ASET (item_properties, ITEM_PROPERTY_HELP, XCAR (item));
7840 start = item;
7841 item = XCDR (item);
7844 /* Maybe key binding cache. */
7845 if (CONSP (item) && CONSP (XCAR (item))
7846 && (NILP (XCAR (XCAR (item)))
7847 || VECTORP (XCAR (XCAR (item)))))
7849 cachelist = XCAR (item);
7850 item = XCDR (item);
7853 /* This is the real definition--the function to run. */
7854 ASET (item_properties, ITEM_PROPERTY_DEF, item);
7856 /* Get enable property, if any. */
7857 if (SYMBOLP (item))
7859 tem = Fget (item, Qmenu_enable);
7860 if (!NILP (Venable_disabled_menus_and_buttons))
7861 ASET (item_properties, ITEM_PROPERTY_ENABLE, Qt);
7862 else if (!NILP (tem))
7863 ASET (item_properties, ITEM_PROPERTY_ENABLE, tem);
7866 else if (EQ (item_string, Qmenu_item) && CONSP (item))
7868 /* New format menu item. */
7869 ASET (item_properties, ITEM_PROPERTY_NAME, XCAR (item));
7870 start = XCDR (item);
7871 if (CONSP (start))
7873 /* We have a real binding. */
7874 ASET (item_properties, ITEM_PROPERTY_DEF, XCAR (start));
7876 item = XCDR (start);
7877 /* Is there a cache list with key equivalences. */
7878 if (CONSP (item) && CONSP (XCAR (item)))
7880 cachelist = XCAR (item);
7881 item = XCDR (item);
7884 /* Parse properties. */
7885 while (CONSP (item) && CONSP (XCDR (item)))
7887 tem = XCAR (item);
7888 item = XCDR (item);
7890 if (EQ (tem, QCenable))
7892 if (!NILP (Venable_disabled_menus_and_buttons))
7893 ASET (item_properties, ITEM_PROPERTY_ENABLE, Qt);
7894 else
7895 ASET (item_properties, ITEM_PROPERTY_ENABLE, XCAR (item));
7897 else if (EQ (tem, QCvisible) && !notreal)
7899 /* If got a visible property and that evaluates to nil
7900 then ignore this item. */
7901 tem = menu_item_eval_property (XCAR (item));
7902 if (NILP (tem))
7903 return 0;
7905 else if (EQ (tem, QChelp))
7906 ASET (item_properties, ITEM_PROPERTY_HELP, XCAR (item));
7907 else if (EQ (tem, QCfilter))
7908 filter = item;
7909 else if (EQ (tem, QCkey_sequence))
7911 tem = XCAR (item);
7912 if (NILP (cachelist)
7913 && (SYMBOLP (tem) || STRINGP (tem) || VECTORP (tem)))
7914 /* Be GC protected. Set keyhint to item instead of tem. */
7915 keyhint = item;
7917 else if (EQ (tem, QCkeys))
7919 tem = XCAR (item);
7920 if (CONSP (tem) || (STRINGP (tem) && NILP (cachelist)))
7921 ASET (item_properties, ITEM_PROPERTY_KEYEQ, tem);
7923 else if (EQ (tem, QCbutton) && CONSP (XCAR (item)))
7925 Lisp_Object type;
7926 tem = XCAR (item);
7927 type = XCAR (tem);
7928 if (EQ (type, QCtoggle) || EQ (type, QCradio))
7930 ASET (item_properties, ITEM_PROPERTY_SELECTED,
7931 XCDR (tem));
7932 ASET (item_properties, ITEM_PROPERTY_TYPE, type);
7935 item = XCDR (item);
7938 else if (inmenubar || !NILP (start))
7939 return 0;
7941 else
7942 return 0; /* not a menu item */
7944 /* If item string is not a string, evaluate it to get string.
7945 If we don't get a string, skip this item. */
7946 item_string = AREF (item_properties, ITEM_PROPERTY_NAME);
7947 if (!(STRINGP (item_string) || notreal))
7949 item_string = menu_item_eval_property (item_string);
7950 if (!STRINGP (item_string))
7951 return 0;
7952 ASET (item_properties, ITEM_PROPERTY_NAME, item_string);
7955 /* If got a filter apply it on definition. */
7956 def = AREF (item_properties, ITEM_PROPERTY_DEF);
7957 if (!NILP (filter))
7959 def = menu_item_eval_property (list2 (XCAR (filter),
7960 list2 (Qquote, def)));
7962 ASET (item_properties, ITEM_PROPERTY_DEF, def);
7965 /* Enable or disable selection of item. */
7966 tem = AREF (item_properties, ITEM_PROPERTY_ENABLE);
7967 if (!EQ (tem, Qt))
7969 if (notreal)
7970 tem = Qt;
7971 else
7972 tem = menu_item_eval_property (tem);
7973 if (inmenubar && NILP (tem))
7974 return 0; /* Ignore disabled items in menu bar. */
7975 ASET (item_properties, ITEM_PROPERTY_ENABLE, tem);
7978 /* If we got no definition, this item is just unselectable text which
7979 is OK in a submenu but not in the menubar. */
7980 if (NILP (def))
7981 return (inmenubar ? 0 : 1);
7983 /* See if this is a separate pane or a submenu. */
7984 def = AREF (item_properties, ITEM_PROPERTY_DEF);
7985 tem = get_keymap (def, 0, 1);
7986 /* For a subkeymap, just record its details and exit. */
7987 if (CONSP (tem))
7989 ASET (item_properties, ITEM_PROPERTY_MAP, tem);
7990 ASET (item_properties, ITEM_PROPERTY_DEF, tem);
7991 return 1;
7994 /* At the top level in the menu bar, do likewise for commands also.
7995 The menu bar does not display equivalent key bindings anyway.
7996 ITEM_PROPERTY_DEF is already set up properly. */
7997 if (inmenubar > 0)
7998 return 1;
8000 /* This is a command. See if there is an equivalent key binding. */
8001 if (NILP (cachelist))
8003 /* We have to create a cachelist. */
8004 /* With the introduction of where_is_cache, the computation
8005 of equivalent key bindings is sufficiently fast that we
8006 do not need to cache it here any more. */
8007 /* CHECK_IMPURE (start);
8008 XSETCDR (start, Fcons (Fcons (Qnil, Qnil), XCDR (start)));
8009 cachelist = XCAR (XCDR (start)); */
8010 cachelist = Fcons (Qnil, Qnil);
8011 newcache = 1;
8012 tem = AREF (item_properties, ITEM_PROPERTY_KEYEQ);
8013 if (!NILP (keyhint))
8015 XSETCAR (cachelist, XCAR (keyhint));
8016 newcache = 0;
8018 else if (STRINGP (tem))
8020 XSETCDR (cachelist, Fsubstitute_command_keys (tem));
8021 XSETCAR (cachelist, Qt);
8025 tem = XCAR (cachelist);
8026 if (!EQ (tem, Qt))
8028 int chkcache = 0;
8029 Lisp_Object prefix;
8031 if (!NILP (tem))
8032 tem = Fkey_binding (tem, Qnil, Qnil, Qnil);
8034 prefix = AREF (item_properties, ITEM_PROPERTY_KEYEQ);
8035 if (CONSP (prefix))
8037 def = XCAR (prefix);
8038 prefix = XCDR (prefix);
8040 else
8041 def = AREF (item_properties, ITEM_PROPERTY_DEF);
8043 if (NILP (XCAR (cachelist))) /* Have no saved key. */
8045 if (newcache /* Always check first time. */
8046 /* Should we check everything when precomputing key
8047 bindings? */
8048 /* If something had no key binding before, don't recheck it
8049 because that is too slow--except if we have a list of
8050 rebound commands in Vdefine_key_rebound_commands, do
8051 recheck any command that appears in that list. */
8052 || (CONSP (Vdefine_key_rebound_commands)
8053 && !NILP (Fmemq (def, Vdefine_key_rebound_commands))))
8054 chkcache = 1;
8056 /* We had a saved key. Is it still bound to the command? */
8057 else if (NILP (tem)
8058 || (!EQ (tem, def)
8059 /* If the command is an alias for another
8060 (such as lmenu.el set it up), check if the
8061 original command matches the cached command. */
8062 && !(SYMBOLP (def) && EQ (tem, XSYMBOL (def)->function))))
8063 chkcache = 1; /* Need to recompute key binding. */
8065 if (chkcache)
8067 /* Recompute equivalent key binding. If the command is an alias
8068 for another (such as lmenu.el set it up), see if the original
8069 command name has equivalent keys. Otherwise look up the
8070 specified command itself. We don't try both, because that
8071 makes lmenu menus slow. */
8072 if (SYMBOLP (def)
8073 && SYMBOLP (XSYMBOL (def)->function)
8074 && ! NILP (Fget (def, Qmenu_alias)))
8075 def = XSYMBOL (def)->function;
8076 tem = Fwhere_is_internal (def, Qnil, Qt, Qnil, Qt);
8078 /* Don't display remap bindings.*/
8079 if (VECTORP (tem) && ASIZE (tem) > 0 && EQ (AREF (tem, 0), Qremap))
8080 tem = Qnil;
8082 XSETCAR (cachelist, tem);
8083 if (NILP (tem))
8085 XSETCDR (cachelist, Qnil);
8086 chkcache = 0;
8089 else if (!NILP (keyhint) && !NILP (XCAR (cachelist)))
8091 tem = XCAR (cachelist);
8092 chkcache = 1;
8095 newcache = chkcache;
8096 if (chkcache)
8098 tem = Fkey_description (tem, Qnil);
8099 if (CONSP (prefix))
8101 if (STRINGP (XCAR (prefix)))
8102 tem = concat2 (XCAR (prefix), tem);
8103 if (STRINGP (XCDR (prefix)))
8104 tem = concat2 (tem, XCDR (prefix));
8106 XSETCDR (cachelist, tem);
8110 tem = XCDR (cachelist);
8111 if (newcache && !NILP (tem))
8113 tem = concat2 (build_string (" "), tem);
8114 /* tem = concat3 (build_string (" ("), tem, build_string (")")); */
8115 XSETCDR (cachelist, tem);
8118 /* If we only want to precompute equivalent key bindings, stop here. */
8119 if (notreal)
8120 return 1;
8122 /* If we have an equivalent key binding, use that. */
8123 ASET (item_properties, ITEM_PROPERTY_KEYEQ, tem);
8125 /* Include this when menu help is implemented.
8126 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
8127 if (!(NILP (tem) || STRINGP (tem)))
8129 tem = menu_item_eval_property (tem);
8130 if (!STRINGP (tem))
8131 tem = Qnil;
8132 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8136 /* Handle radio buttons or toggle boxes. */
8137 tem = AREF (item_properties, ITEM_PROPERTY_SELECTED);
8138 if (!NILP (tem))
8139 ASET (item_properties, ITEM_PROPERTY_SELECTED,
8140 menu_item_eval_property (tem));
8142 return 1;
8147 /***********************************************************************
8148 Tool-bars
8149 ***********************************************************************/
8151 /* A vector holding tool bar items while they are parsed in function
8152 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8153 in the vector. */
8155 static Lisp_Object tool_bar_items_vector;
8157 /* A vector holding the result of parse_tool_bar_item. Layout is like
8158 the one for a single item in tool_bar_items_vector. */
8160 static Lisp_Object tool_bar_item_properties;
8162 /* Next free index in tool_bar_items_vector. */
8164 static int ntool_bar_items;
8166 /* The symbols `tool-bar', `:image' and `:rtl'. */
8168 extern Lisp_Object Qtool_bar;
8169 Lisp_Object QCimage;
8170 Lisp_Object Qrtl;
8172 /* Function prototypes. */
8174 static void init_tool_bar_items P_ ((Lisp_Object));
8175 static void process_tool_bar_item P_ ((Lisp_Object, Lisp_Object, Lisp_Object, void*));
8176 static int parse_tool_bar_item P_ ((Lisp_Object, Lisp_Object));
8177 static void append_tool_bar_item P_ ((void));
8180 /* Return a vector of tool bar items for keymaps currently in effect.
8181 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8182 tool bar items found. */
8184 Lisp_Object
8185 tool_bar_items (reuse, nitems)
8186 Lisp_Object reuse;
8187 int *nitems;
8189 Lisp_Object *maps;
8190 int nmaps, i;
8191 Lisp_Object oquit;
8192 Lisp_Object *tmaps;
8194 *nitems = 0;
8196 /* In order to build the menus, we need to call the keymap
8197 accessors. They all call QUIT. But this function is called
8198 during redisplay, during which a quit is fatal. So inhibit
8199 quitting while building the menus. We do this instead of
8200 specbind because (1) errors will clear it anyway and (2) this
8201 avoids risk of specpdl overflow. */
8202 oquit = Vinhibit_quit;
8203 Vinhibit_quit = Qt;
8205 /* Initialize tool_bar_items_vector and protect it from GC. */
8206 init_tool_bar_items (reuse);
8208 /* Build list of keymaps in maps. Set nmaps to the number of maps
8209 to process. */
8211 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8212 if (!NILP (Voverriding_local_map_menu_flag))
8214 /* Yes, use them (if non-nil) as well as the global map. */
8215 maps = (Lisp_Object *) alloca (3 * sizeof (maps[0]));
8216 nmaps = 0;
8217 if (!NILP (current_kboard->Voverriding_terminal_local_map))
8218 maps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
8219 if (!NILP (Voverriding_local_map))
8220 maps[nmaps++] = Voverriding_local_map;
8222 else
8224 /* No, so use major and minor mode keymaps and keymap property.
8225 Note that tool-bar bindings in the local-map and keymap
8226 properties may not work reliable, as they are only
8227 recognized when the tool-bar (or mode-line) is updated,
8228 which does not normally happen after every command. */
8229 Lisp_Object tem;
8230 int nminor;
8231 nminor = current_minor_maps (NULL, &tmaps);
8232 maps = (Lisp_Object *) alloca ((nminor + 3) * sizeof (maps[0]));
8233 nmaps = 0;
8234 if (tem = get_local_map (PT, current_buffer, Qkeymap), !NILP (tem))
8235 maps[nmaps++] = tem;
8236 bcopy (tmaps, (void *) (maps + nmaps), nminor * sizeof (maps[0]));
8237 nmaps += nminor;
8238 maps[nmaps++] = get_local_map (PT, current_buffer, Qlocal_map);
8241 /* Add global keymap at the end. */
8242 maps[nmaps++] = current_global_map;
8244 /* Process maps in reverse order and look up in each map the prefix
8245 key `tool-bar'. */
8246 for (i = nmaps - 1; i >= 0; --i)
8247 if (!NILP (maps[i]))
8249 Lisp_Object keymap;
8251 keymap = get_keymap (access_keymap (maps[i], Qtool_bar, 1, 0, 1), 0, 1);
8252 if (CONSP (keymap))
8253 map_keymap (keymap, process_tool_bar_item, Qnil, NULL, 1);
8256 Vinhibit_quit = oquit;
8257 *nitems = ntool_bar_items / TOOL_BAR_ITEM_NSLOTS;
8258 return tool_bar_items_vector;
8262 /* Process the definition of KEY which is DEF. */
8264 static void
8265 process_tool_bar_item (key, def, data, args)
8266 Lisp_Object key, def, data;
8267 void *args;
8269 int i;
8270 extern Lisp_Object Qundefined;
8271 struct gcpro gcpro1, gcpro2;
8273 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8274 eval. */
8275 GCPRO2 (key, def);
8277 if (EQ (def, Qundefined))
8279 /* If a map has an explicit `undefined' as definition,
8280 discard any previously made item. */
8281 for (i = 0; i < ntool_bar_items; i += TOOL_BAR_ITEM_NSLOTS)
8283 Lisp_Object *v = XVECTOR (tool_bar_items_vector)->contents + i;
8285 if (EQ (key, v[TOOL_BAR_ITEM_KEY]))
8287 if (ntool_bar_items > i + TOOL_BAR_ITEM_NSLOTS)
8288 bcopy (v + TOOL_BAR_ITEM_NSLOTS, v,
8289 ((ntool_bar_items - i - TOOL_BAR_ITEM_NSLOTS)
8290 * sizeof (Lisp_Object)));
8291 ntool_bar_items -= TOOL_BAR_ITEM_NSLOTS;
8292 break;
8296 else if (parse_tool_bar_item (key, def))
8297 /* Append a new tool bar item to tool_bar_items_vector. Accept
8298 more than one definition for the same key. */
8299 append_tool_bar_item ();
8301 UNGCPRO;
8305 /* Parse a tool bar item specification ITEM for key KEY and return the
8306 result in tool_bar_item_properties. Value is zero if ITEM is
8307 invalid.
8309 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8311 CAPTION is the caption of the item, If it's not a string, it is
8312 evaluated to get a string.
8314 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8315 as binding are currently ignored.
8317 The following properties are recognized:
8319 - `:enable FORM'.
8321 FORM is evaluated and specifies whether the tool bar item is
8322 enabled or disabled.
8324 - `:visible FORM'
8326 FORM is evaluated and specifies whether the tool bar item is visible.
8328 - `:filter FUNCTION'
8330 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8331 result is stored as the new binding.
8333 - `:button (TYPE SELECTED)'
8335 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8336 and specifies whether the button is selected (pressed) or not.
8338 - `:image IMAGES'
8340 IMAGES is either a single image specification or a vector of four
8341 image specifications. See enum tool_bar_item_images.
8343 - `:help HELP-STRING'.
8345 Gives a help string to display for the tool bar item. */
8347 static int
8348 parse_tool_bar_item (key, item)
8349 Lisp_Object key, item;
8351 /* Access slot with index IDX of vector tool_bar_item_properties. */
8352 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8354 Lisp_Object filter = Qnil;
8355 Lisp_Object caption;
8356 int i;
8358 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8359 Rule out items that aren't lists, don't start with
8360 `menu-item' or whose rest following `tool-bar-item' is not a
8361 list. */
8362 if (!CONSP (item)
8363 || !EQ (XCAR (item), Qmenu_item)
8364 || (item = XCDR (item),
8365 !CONSP (item)))
8366 return 0;
8368 /* Create tool_bar_item_properties vector if necessary. Reset it to
8369 defaults. */
8370 if (VECTORP (tool_bar_item_properties))
8372 for (i = 0; i < TOOL_BAR_ITEM_NSLOTS; ++i)
8373 PROP (i) = Qnil;
8375 else
8376 tool_bar_item_properties
8377 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS), Qnil);
8379 /* Set defaults. */
8380 PROP (TOOL_BAR_ITEM_KEY) = key;
8381 PROP (TOOL_BAR_ITEM_ENABLED_P) = Qt;
8383 /* Get the caption of the item. If the caption is not a string,
8384 evaluate it to get a string. If we don't get a string, skip this
8385 item. */
8386 caption = XCAR (item);
8387 if (!STRINGP (caption))
8389 caption = menu_item_eval_property (caption);
8390 if (!STRINGP (caption))
8391 return 0;
8393 PROP (TOOL_BAR_ITEM_CAPTION) = caption;
8395 /* Give up if rest following the caption is not a list. */
8396 item = XCDR (item);
8397 if (!CONSP (item))
8398 return 0;
8400 /* Store the binding. */
8401 PROP (TOOL_BAR_ITEM_BINDING) = XCAR (item);
8402 item = XCDR (item);
8404 /* Ignore cached key binding, if any. */
8405 if (CONSP (item) && CONSP (XCAR (item)))
8406 item = XCDR (item);
8408 /* Process the rest of the properties. */
8409 for (; CONSP (item) && CONSP (XCDR (item)); item = XCDR (XCDR (item)))
8411 Lisp_Object key, value;
8413 key = XCAR (item);
8414 value = XCAR (XCDR (item));
8416 if (EQ (key, QCenable))
8418 /* `:enable FORM'. */
8419 if (!NILP (Venable_disabled_menus_and_buttons))
8420 PROP (TOOL_BAR_ITEM_ENABLED_P) = Qt;
8421 else
8422 PROP (TOOL_BAR_ITEM_ENABLED_P) = value;
8424 else if (EQ (key, QCvisible))
8426 /* `:visible FORM'. If got a visible property and that
8427 evaluates to nil then ignore this item. */
8428 if (NILP (menu_item_eval_property (value)))
8429 return 0;
8431 else if (EQ (key, QChelp))
8432 /* `:help HELP-STRING'. */
8433 PROP (TOOL_BAR_ITEM_HELP) = value;
8434 else if (EQ (key, QCfilter))
8435 /* ':filter FORM'. */
8436 filter = value;
8437 else if (EQ (key, QCbutton) && CONSP (value))
8439 /* `:button (TYPE . SELECTED)'. */
8440 Lisp_Object type, selected;
8442 type = XCAR (value);
8443 selected = XCDR (value);
8444 if (EQ (type, QCtoggle) || EQ (type, QCradio))
8446 PROP (TOOL_BAR_ITEM_SELECTED_P) = selected;
8447 PROP (TOOL_BAR_ITEM_TYPE) = type;
8450 else if (EQ (key, QCimage)
8451 && (CONSP (value)
8452 || (VECTORP (value) && XVECTOR (value)->size == 4)))
8453 /* Value is either a single image specification or a vector
8454 of 4 such specifications for the different button states. */
8455 PROP (TOOL_BAR_ITEM_IMAGES) = value;
8456 else if (EQ (key, Qrtl))
8457 /* ':rtl STRING' */
8458 PROP (TOOL_BAR_ITEM_RTL_IMAGE) = value;
8461 /* If got a filter apply it on binding. */
8462 if (!NILP (filter))
8463 PROP (TOOL_BAR_ITEM_BINDING)
8464 = menu_item_eval_property (list2 (filter,
8465 list2 (Qquote,
8466 PROP (TOOL_BAR_ITEM_BINDING))));
8468 /* See if the binding is a keymap. Give up if it is. */
8469 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING), 0, 1)))
8470 return 0;
8472 /* Enable or disable selection of item. */
8473 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P), Qt))
8474 PROP (TOOL_BAR_ITEM_ENABLED_P)
8475 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P));
8477 /* Handle radio buttons or toggle boxes. */
8478 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P)))
8479 PROP (TOOL_BAR_ITEM_SELECTED_P)
8480 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P));
8482 return 1;
8484 #undef PROP
8488 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8489 that can be reused. */
8491 static void
8492 init_tool_bar_items (reuse)
8493 Lisp_Object reuse;
8495 if (VECTORP (reuse))
8496 tool_bar_items_vector = reuse;
8497 else
8498 tool_bar_items_vector = Fmake_vector (make_number (64), Qnil);
8499 ntool_bar_items = 0;
8503 /* Append parsed tool bar item properties from
8504 tool_bar_item_properties */
8506 static void
8507 append_tool_bar_item ()
8509 Lisp_Object *to, *from;
8511 /* Enlarge tool_bar_items_vector if necessary. */
8512 if (ntool_bar_items + TOOL_BAR_ITEM_NSLOTS
8513 >= XVECTOR (tool_bar_items_vector)->size)
8514 tool_bar_items_vector
8515 = larger_vector (tool_bar_items_vector,
8516 2 * XVECTOR (tool_bar_items_vector)->size, Qnil);
8518 /* Append entries from tool_bar_item_properties to the end of
8519 tool_bar_items_vector. */
8520 to = XVECTOR (tool_bar_items_vector)->contents + ntool_bar_items;
8521 from = XVECTOR (tool_bar_item_properties)->contents;
8522 bcopy (from, to, TOOL_BAR_ITEM_NSLOTS * sizeof *to);
8523 ntool_bar_items += TOOL_BAR_ITEM_NSLOTS;
8530 /* Read a character using menus based on maps in the array MAPS.
8531 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8532 Return t if we displayed a menu but the user rejected it.
8534 PREV_EVENT is the previous input event, or nil if we are reading
8535 the first event of a key sequence.
8537 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8538 if we used a mouse menu to read the input, or zero otherwise. If
8539 USED_MOUSE_MENU is null, we don't dereference it.
8541 The prompting is done based on the prompt-string of the map
8542 and the strings associated with various map elements.
8544 This can be done with X menus or with menus put in the minibuf.
8545 These are done in different ways, depending on how the input will be read.
8546 Menus using X are done after auto-saving in read-char, getting the input
8547 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8548 and do auto-saving in the inner call of read_char. */
8550 static Lisp_Object
8551 read_char_x_menu_prompt (nmaps, maps, prev_event, used_mouse_menu)
8552 int nmaps;
8553 Lisp_Object *maps;
8554 Lisp_Object prev_event;
8555 int *used_mouse_menu;
8557 int mapno;
8558 register Lisp_Object name = Qnil;
8560 if (used_mouse_menu)
8561 *used_mouse_menu = 0;
8563 /* Use local over global Menu maps */
8565 if (! menu_prompting)
8566 return Qnil;
8568 /* Optionally disregard all but the global map. */
8569 if (inhibit_local_menu_bar_menus)
8571 maps += (nmaps - 1);
8572 nmaps = 1;
8575 /* Get the menu name from the first map that has one (a prompt string). */
8576 for (mapno = 0; mapno < nmaps; mapno++)
8578 name = Fkeymap_prompt (maps[mapno]);
8579 if (!NILP (name))
8580 break;
8583 /* If we don't have any menus, just read a character normally. */
8584 if (!STRINGP (name))
8585 return Qnil;
8587 #ifdef HAVE_MENUS
8588 /* If we got to this point via a mouse click,
8589 use a real menu for mouse selection. */
8590 if (EVENT_HAS_PARAMETERS (prev_event)
8591 && !EQ (XCAR (prev_event), Qmenu_bar)
8592 && !EQ (XCAR (prev_event), Qtool_bar))
8594 /* Display the menu and get the selection. */
8595 Lisp_Object *realmaps
8596 = (Lisp_Object *) alloca (nmaps * sizeof (Lisp_Object));
8597 Lisp_Object value;
8598 int nmaps1 = 0;
8600 /* Use the maps that are not nil. */
8601 for (mapno = 0; mapno < nmaps; mapno++)
8602 if (!NILP (maps[mapno]))
8603 realmaps[nmaps1++] = maps[mapno];
8605 value = Fx_popup_menu (prev_event, Flist (nmaps1, realmaps));
8606 if (CONSP (value))
8608 Lisp_Object tem;
8610 record_menu_key (XCAR (value));
8612 /* If we got multiple events, unread all but
8613 the first.
8614 There is no way to prevent those unread events
8615 from showing up later in last_nonmenu_event.
8616 So turn symbol and integer events into lists,
8617 to indicate that they came from a mouse menu,
8618 so that when present in last_nonmenu_event
8619 they won't confuse things. */
8620 for (tem = XCDR (value); CONSP (tem); tem = XCDR (tem))
8622 record_menu_key (XCAR (tem));
8623 if (SYMBOLP (XCAR (tem))
8624 || INTEGERP (XCAR (tem)))
8625 XSETCAR (tem, Fcons (XCAR (tem), Qdisabled));
8628 /* If we got more than one event, put all but the first
8629 onto this list to be read later.
8630 Return just the first event now. */
8631 Vunread_command_events
8632 = nconc2 (XCDR (value), Vunread_command_events);
8633 value = XCAR (value);
8635 else if (NILP (value))
8636 value = Qt;
8637 if (used_mouse_menu)
8638 *used_mouse_menu = 1;
8639 return value;
8641 #endif /* HAVE_MENUS */
8642 return Qnil ;
8645 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8646 We make this bigger when necessary, and never free it. */
8647 static char *read_char_minibuf_menu_text;
8648 /* Size of that buffer. */
8649 static int read_char_minibuf_menu_width;
8651 static Lisp_Object
8652 read_char_minibuf_menu_prompt (commandflag, nmaps, maps)
8653 int commandflag ;
8654 int nmaps;
8655 Lisp_Object *maps;
8657 int mapno;
8658 register Lisp_Object name;
8659 int nlength;
8660 /* FIXME: Use the minibuffer's frame width. */
8661 int width = FRAME_COLS (SELECTED_FRAME ()) - 4;
8662 int idx = -1;
8663 int nobindings = 1;
8664 Lisp_Object rest, vector;
8665 char *menu;
8667 vector = Qnil;
8668 name = Qnil;
8670 if (! menu_prompting)
8671 return Qnil;
8673 /* Get the menu name from the first map that has one (a prompt string). */
8674 for (mapno = 0; mapno < nmaps; mapno++)
8676 name = Fkeymap_prompt (maps[mapno]);
8677 if (!NILP (name))
8678 break;
8681 /* If we don't have any menus, just read a character normally. */
8682 if (!STRINGP (name))
8683 return Qnil;
8685 /* Make sure we have a big enough buffer for the menu text. */
8686 width = max (width, SBYTES (name));
8687 if (read_char_minibuf_menu_text == 0)
8689 read_char_minibuf_menu_width = width + 4;
8690 read_char_minibuf_menu_text = (char *) xmalloc (width + 4);
8692 else if (width + 4 > read_char_minibuf_menu_width)
8694 read_char_minibuf_menu_width = width + 4;
8695 read_char_minibuf_menu_text
8696 = (char *) xrealloc (read_char_minibuf_menu_text, width + 4);
8698 menu = read_char_minibuf_menu_text;
8700 /* Prompt string always starts with map's prompt, and a space. */
8701 strcpy (menu, SDATA (name));
8702 nlength = SBYTES (name);
8703 menu[nlength++] = ':';
8704 menu[nlength++] = ' ';
8705 menu[nlength] = 0;
8707 /* Start prompting at start of first map. */
8708 mapno = 0;
8709 rest = maps[mapno];
8711 /* Present the documented bindings, a line at a time. */
8712 while (1)
8714 int notfirst = 0;
8715 int i = nlength;
8716 Lisp_Object obj;
8717 int ch;
8718 Lisp_Object orig_defn_macro;
8720 /* Loop over elements of map. */
8721 while (i < width)
8723 Lisp_Object elt;
8725 /* If reached end of map, start at beginning of next map. */
8726 if (NILP (rest))
8728 mapno++;
8729 /* At end of last map, wrap around to first map if just starting,
8730 or end this line if already have something on it. */
8731 if (mapno == nmaps)
8733 mapno = 0;
8734 if (notfirst || nobindings) break;
8736 rest = maps[mapno];
8739 /* Look at the next element of the map. */
8740 if (idx >= 0)
8741 elt = XVECTOR (vector)->contents[idx];
8742 else
8743 elt = Fcar_safe (rest);
8745 if (idx < 0 && VECTORP (elt))
8747 /* If we found a dense table in the keymap,
8748 advanced past it, but start scanning its contents. */
8749 rest = Fcdr_safe (rest);
8750 vector = elt;
8751 idx = 0;
8753 else
8755 /* An ordinary element. */
8756 Lisp_Object event, tem;
8758 if (idx < 0)
8760 event = Fcar_safe (elt); /* alist */
8761 elt = Fcdr_safe (elt);
8763 else
8765 XSETINT (event, idx); /* vector */
8768 /* Ignore the element if it has no prompt string. */
8769 if (INTEGERP (event) && parse_menu_item (elt, 0, -1))
8771 /* 1 if the char to type matches the string. */
8772 int char_matches;
8773 Lisp_Object upcased_event, downcased_event;
8774 Lisp_Object desc = Qnil;
8775 Lisp_Object s
8776 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_NAME];
8778 upcased_event = Fupcase (event);
8779 downcased_event = Fdowncase (event);
8780 char_matches = (XINT (upcased_event) == SREF (s, 0)
8781 || XINT (downcased_event) == SREF (s, 0));
8782 if (! char_matches)
8783 desc = Fsingle_key_description (event, Qnil);
8785 #if 0 /* It is redundant to list the equivalent key bindings because
8786 the prefix is what the user has already typed. */
8788 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_KEYEQ];
8789 if (!NILP (tem))
8790 /* Insert equivalent keybinding. */
8791 s = concat2 (s, tem);
8792 #endif
8794 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_TYPE];
8795 if (EQ (tem, QCradio) || EQ (tem, QCtoggle))
8797 /* Insert button prefix. */
8798 Lisp_Object selected
8799 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_SELECTED];
8800 if (EQ (tem, QCradio))
8801 tem = build_string (NILP (selected) ? "(*) " : "( ) ");
8802 else
8803 tem = build_string (NILP (selected) ? "[X] " : "[ ] ");
8804 s = concat2 (tem, s);
8808 /* If we have room for the prompt string, add it to this line.
8809 If this is the first on the line, always add it. */
8810 if ((SCHARS (s) + i + 2
8811 + (char_matches ? 0 : SCHARS (desc) + 3))
8812 < width
8813 || !notfirst)
8815 int thiswidth;
8817 /* Punctuate between strings. */
8818 if (notfirst)
8820 strcpy (menu + i, ", ");
8821 i += 2;
8823 notfirst = 1;
8824 nobindings = 0 ;
8826 /* If the char to type doesn't match the string's
8827 first char, explicitly show what char to type. */
8828 if (! char_matches)
8830 /* Add as much of string as fits. */
8831 thiswidth = SCHARS (desc);
8832 if (thiswidth + i > width)
8833 thiswidth = width - i;
8834 bcopy (SDATA (desc), menu + i, thiswidth);
8835 i += thiswidth;
8836 strcpy (menu + i, " = ");
8837 i += 3;
8840 /* Add as much of string as fits. */
8841 thiswidth = SCHARS (s);
8842 if (thiswidth + i > width)
8843 thiswidth = width - i;
8844 bcopy (SDATA (s), menu + i, thiswidth);
8845 i += thiswidth;
8846 menu[i] = 0;
8848 else
8850 /* If this element does not fit, end the line now,
8851 and save the element for the next line. */
8852 strcpy (menu + i, "...");
8853 break;
8857 /* Move past this element. */
8858 if (idx >= 0 && idx + 1 >= XVECTOR (vector)->size)
8859 /* Handle reaching end of dense table. */
8860 idx = -1;
8861 if (idx >= 0)
8862 idx++;
8863 else
8864 rest = Fcdr_safe (rest);
8868 /* Prompt with that and read response. */
8869 message2_nolog (menu, strlen (menu),
8870 ! NILP (current_buffer->enable_multibyte_characters));
8872 /* Make believe its not a keyboard macro in case the help char
8873 is pressed. Help characters are not recorded because menu prompting
8874 is not used on replay.
8876 orig_defn_macro = current_kboard->defining_kbd_macro;
8877 current_kboard->defining_kbd_macro = Qnil;
8879 obj = read_char (commandflag, 0, 0, Qt, 0, NULL);
8880 while (BUFFERP (obj));
8881 current_kboard->defining_kbd_macro = orig_defn_macro;
8883 if (!INTEGERP (obj))
8884 return obj;
8885 else if (XINT (obj) == -2)
8886 return obj;
8887 else
8888 ch = XINT (obj);
8890 if (! EQ (obj, menu_prompt_more_char)
8891 && (!INTEGERP (menu_prompt_more_char)
8892 || ! EQ (obj, make_number (Ctl (XINT (menu_prompt_more_char))))))
8894 if (!NILP (current_kboard->defining_kbd_macro))
8895 store_kbd_macro_char (obj);
8896 return obj;
8898 /* Help char - go round again */
8902 /* Reading key sequences. */
8904 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8905 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8906 keymap, or nil otherwise. Return the index of the first keymap in
8907 which KEY has any binding, or NMAPS if no map has a binding.
8909 If KEY is a meta ASCII character, treat it like meta-prefix-char
8910 followed by the corresponding non-meta character. Keymaps in
8911 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8912 NEXT.
8914 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8915 unmodified.
8917 NEXT may be the same array as CURRENT. */
8919 static int
8920 follow_key (key, nmaps, current, defs, next)
8921 Lisp_Object key;
8922 Lisp_Object *current, *defs, *next;
8923 int nmaps;
8925 int i, first_binding;
8927 first_binding = nmaps;
8928 for (i = nmaps - 1; i >= 0; i--)
8930 if (! NILP (current[i]))
8932 defs[i] = access_keymap (current[i], key, 1, 0, 1);
8933 if (! NILP (defs[i]))
8934 first_binding = i;
8936 else
8937 defs[i] = Qnil;
8940 /* Given the set of bindings we've found, produce the next set of maps. */
8941 if (first_binding < nmaps)
8942 for (i = 0; i < nmaps; i++)
8943 next[i] = NILP (defs[i]) ? Qnil : get_keymap (defs[i], 0, 1);
8945 return first_binding;
8948 /* Structure used to keep track of partial application of key remapping
8949 such as Vfunction_key_map and Vkey_translation_map. */
8950 typedef struct keyremap
8952 /* This is the map originally specified for this use. */
8953 Lisp_Object parent;
8954 /* This is a submap reached by looking up, in PARENT,
8955 the events from START to END. */
8956 Lisp_Object map;
8957 /* Positions [START, END) in the key sequence buffer
8958 are the key that we have scanned so far.
8959 Those events are the ones that we will replace
8960 if PAREHT maps them into a key sequence. */
8961 int start, end;
8962 } keyremap;
8964 /* Lookup KEY in MAP.
8965 MAP is a keymap mapping keys to key vectors or functions.
8966 If the mapping is a function and DO_FUNCTION is non-zero, then
8967 the function is called with PROMPT as parameter and its return
8968 value is used as the return value of this function (after checking
8969 that it is indeed a vector). */
8971 static Lisp_Object
8972 access_keymap_keyremap (map, key, prompt, do_funcall)
8973 Lisp_Object map, key, prompt;
8974 int do_funcall;
8976 Lisp_Object next;
8978 next = access_keymap (map, key, 1, 0, 1);
8980 /* Handle symbol with autoload definition. */
8981 if (SYMBOLP (next) && !NILP (Ffboundp (next))
8982 && CONSP (XSYMBOL (next)->function)
8983 && EQ (XCAR (XSYMBOL (next)->function), Qautoload))
8984 do_autoload (XSYMBOL (next)->function, next);
8986 /* Handle a symbol whose function definition is a keymap
8987 or an array. */
8988 if (SYMBOLP (next) && !NILP (Ffboundp (next))
8989 && (ARRAYP (XSYMBOL (next)->function)
8990 || KEYMAPP (XSYMBOL (next)->function)))
8991 next = XSYMBOL (next)->function;
8993 /* If the keymap gives a function, not an
8994 array, then call the function with one arg and use
8995 its value instead. */
8996 if (SYMBOLP (next) && !NILP (Ffboundp (next)) && do_funcall)
8998 Lisp_Object tem;
8999 tem = next;
9001 next = call1 (next, prompt);
9002 /* If the function returned something invalid,
9003 barf--don't ignore it.
9004 (To ignore it safely, we would need to gcpro a bunch of
9005 other variables.) */
9006 if (! (VECTORP (next) || STRINGP (next)))
9007 error ("Function %s returns invalid key sequence", tem);
9009 return next;
9012 /* Do one step of the key remapping used for function-key-map and
9013 key-translation-map:
9014 KEYBUF is the buffer holding the input events.
9015 BUFSIZE is its maximum size.
9016 FKEY is a pointer to the keyremap structure to use.
9017 INPUT is the index of the last element in KEYBUF.
9018 DOIT if non-zero says that the remapping can actually take place.
9019 DIFF is used to return the number of keys added/removed by the remapping.
9020 PARENT is the root of the keymap.
9021 PROMPT is the prompt to use if the remapping happens through a function.
9022 The return value is non-zero if the remapping actually took place. */
9024 static int
9025 keyremap_step (keybuf, bufsize, fkey, input, doit, diff, prompt)
9026 Lisp_Object *keybuf, prompt;
9027 keyremap *fkey;
9028 int input, doit, *diff, bufsize;
9030 Lisp_Object next, key;
9032 key = keybuf[fkey->end++];
9034 if (KEYMAPP (fkey->parent))
9035 next = access_keymap_keyremap (fkey->map, key, prompt, doit);
9036 else
9037 next = Qnil;
9039 /* If keybuf[fkey->start..fkey->end] is bound in the
9040 map and we're in a position to do the key remapping, replace it with
9041 the binding and restart with fkey->start at the end. */
9042 if ((VECTORP (next) || STRINGP (next)) && doit)
9044 int len = XFASTINT (Flength (next));
9045 int i;
9047 *diff = len - (fkey->end - fkey->start);
9049 if (input + *diff >= bufsize)
9050 error ("Key sequence too long");
9052 /* Shift the keys that follow fkey->end. */
9053 if (*diff < 0)
9054 for (i = fkey->end; i < input; i++)
9055 keybuf[i + *diff] = keybuf[i];
9056 else if (*diff > 0)
9057 for (i = input - 1; i >= fkey->end; i--)
9058 keybuf[i + *diff] = keybuf[i];
9059 /* Overwrite the old keys with the new ones. */
9060 for (i = 0; i < len; i++)
9061 keybuf[fkey->start + i]
9062 = Faref (next, make_number (i));
9064 fkey->start = fkey->end += *diff;
9065 fkey->map = fkey->parent;
9067 return 1;
9070 fkey->map = get_keymap (next, 0, 1);
9072 /* If we no longer have a bound suffix, try a new position for
9073 fkey->start. */
9074 if (!CONSP (fkey->map))
9076 fkey->end = ++fkey->start;
9077 fkey->map = fkey->parent;
9079 return 0;
9082 /* Read a sequence of keys that ends with a non prefix character,
9083 storing it in KEYBUF, a buffer of size BUFSIZE.
9084 Prompt with PROMPT.
9085 Return the length of the key sequence stored.
9086 Return -1 if the user rejected a command menu.
9088 Echo starting immediately unless `prompt' is 0.
9090 Where a key sequence ends depends on the currently active keymaps.
9091 These include any minor mode keymaps active in the current buffer,
9092 the current buffer's local map, and the global map.
9094 If a key sequence has no other bindings, we check Vfunction_key_map
9095 to see if some trailing subsequence might be the beginning of a
9096 function key's sequence. If so, we try to read the whole function
9097 key, and substitute its symbolic name into the key sequence.
9099 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9100 `double-' events into similar click events, if that would make them
9101 bound. We try to turn `triple-' events first into `double-' events,
9102 then into clicks.
9104 If we get a mouse click in a mode line, vertical divider, or other
9105 non-text area, we treat the click as if it were prefixed by the
9106 symbol denoting that area - `mode-line', `vertical-line', or
9107 whatever.
9109 If the sequence starts with a mouse click, we read the key sequence
9110 with respect to the buffer clicked on, not the current buffer.
9112 If the user switches frames in the midst of a key sequence, we put
9113 off the switch-frame event until later; the next call to
9114 read_char will return it.
9116 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9117 from the selected window's buffer. */
9119 static int
9120 read_key_sequence (keybuf, bufsize, prompt, dont_downcase_last,
9121 can_return_switch_frame, fix_current_buffer)
9122 Lisp_Object *keybuf;
9123 int bufsize;
9124 Lisp_Object prompt;
9125 int dont_downcase_last;
9126 int can_return_switch_frame;
9127 int fix_current_buffer;
9129 volatile Lisp_Object from_string;
9130 volatile int count = SPECPDL_INDEX ();
9132 /* How many keys there are in the current key sequence. */
9133 volatile int t;
9135 /* The length of the echo buffer when we started reading, and
9136 the length of this_command_keys when we started reading. */
9137 volatile int echo_start;
9138 volatile int keys_start;
9140 /* The number of keymaps we're scanning right now, and the number of
9141 keymaps we have allocated space for. */
9142 volatile int nmaps;
9143 volatile int nmaps_allocated = 0;
9145 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9146 the current keymaps. */
9147 Lisp_Object *volatile defs = NULL;
9149 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9150 in the current keymaps, or nil where it is not a prefix. */
9151 Lisp_Object *volatile submaps = NULL;
9153 /* The local map to start out with at start of key sequence. */
9154 volatile Lisp_Object orig_local_map;
9156 /* The map from the `keymap' property to start out with at start of
9157 key sequence. */
9158 volatile Lisp_Object orig_keymap;
9160 /* 1 if we have already considered switching to the local-map property
9161 of the place where a mouse click occurred. */
9162 volatile int localized_local_map = 0;
9164 /* The index in submaps[] of the first keymap that has a binding for
9165 this key sequence. In other words, the lowest i such that
9166 submaps[i] is non-nil. */
9167 volatile int first_binding;
9168 /* Index of the first key that has no binding.
9169 It is useless to try fkey.start larger than that. */
9170 volatile int first_unbound;
9172 /* If t < mock_input, then KEYBUF[t] should be read as the next
9173 input key.
9175 We use this to recover after recognizing a function key. Once we
9176 realize that a suffix of the current key sequence is actually a
9177 function key's escape sequence, we replace the suffix with the
9178 function key's binding from Vfunction_key_map. Now keybuf
9179 contains a new and different key sequence, so the echo area,
9180 this_command_keys, and the submaps and defs arrays are wrong. In
9181 this situation, we set mock_input to t, set t to 0, and jump to
9182 restart_sequence; the loop will read keys from keybuf up until
9183 mock_input, thus rebuilding the state; and then it will resume
9184 reading characters from the keyboard. */
9185 volatile int mock_input = 0;
9187 /* If the sequence is unbound in submaps[], then
9188 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9189 and fkey.map is its binding.
9191 These might be > t, indicating that all function key scanning
9192 should hold off until t reaches them. We do this when we've just
9193 recognized a function key, to avoid searching for the function
9194 key's again in Vfunction_key_map. */
9195 volatile keyremap fkey;
9197 /* Likewise, for key_translation_map and input-decode-map. */
9198 volatile keyremap keytran, indec;
9200 /* Non-zero if we are trying to map a key by changing an upper-case
9201 letter to lower case, or a shifted function key to an unshifted
9202 one. */
9203 volatile int shift_translated = 0;
9205 /* If we receive a `switch-frame' or `select-window' event in the middle of
9206 a key sequence, we put it off for later.
9207 While we're reading, we keep the event here. */
9208 volatile Lisp_Object delayed_switch_frame;
9210 /* See the comment below... */
9211 #if defined (GOBBLE_FIRST_EVENT)
9212 Lisp_Object first_event;
9213 #endif
9215 volatile Lisp_Object original_uppercase;
9216 volatile int original_uppercase_position = -1;
9218 /* Gets around Microsoft compiler limitations. */
9219 int dummyflag = 0;
9221 struct buffer *starting_buffer;
9223 /* List of events for which a fake prefix key has been generated. */
9224 volatile Lisp_Object fake_prefixed_keys = Qnil;
9226 #if defined (GOBBLE_FIRST_EVENT)
9227 int junk;
9228 #endif
9230 struct gcpro gcpro1;
9232 GCPRO1 (fake_prefixed_keys);
9233 raw_keybuf_count = 0;
9235 last_nonmenu_event = Qnil;
9237 delayed_switch_frame = Qnil;
9239 if (INTERACTIVE)
9241 if (!NILP (prompt))
9242 echo_prompt (prompt);
9243 else if (cursor_in_echo_area
9244 && (FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
9245 && NILP (Fzerop (Vecho_keystrokes)))
9246 /* This doesn't put in a dash if the echo buffer is empty, so
9247 you don't always see a dash hanging out in the minibuffer. */
9248 echo_dash ();
9251 /* Record the initial state of the echo area and this_command_keys;
9252 we will need to restore them if we replay a key sequence. */
9253 if (INTERACTIVE)
9254 echo_start = echo_length ();
9255 keys_start = this_command_key_count;
9256 this_single_command_key_start = keys_start;
9258 #if defined (GOBBLE_FIRST_EVENT)
9259 /* This doesn't quite work, because some of the things that read_char
9260 does cannot safely be bypassed. It seems too risky to try to make
9261 this work right. */
9263 /* Read the first char of the sequence specially, before setting
9264 up any keymaps, in case a filter runs and switches buffers on us. */
9265 first_event = read_char (NILP (prompt), 0, submaps, last_nonmenu_event,
9266 &junk, NULL);
9267 #endif /* GOBBLE_FIRST_EVENT */
9269 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
9270 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
9271 from_string = Qnil;
9273 /* We jump here when we need to reinitialize fkey and keytran; this
9274 happens if we switch keyboards between rescans. */
9275 replay_entire_sequence:
9277 indec.map = indec.parent = current_kboard->Vinput_decode_map;
9278 fkey.map = fkey.parent = current_kboard->Vlocal_function_key_map;
9279 keytran.map = keytran.parent = Vkey_translation_map;
9280 indec.start = indec.end = 0;
9281 fkey.start = fkey.end = 0;
9282 keytran.start = keytran.end = 0;
9284 /* We jump here when the key sequence has been thoroughly changed, and
9285 we need to rescan it starting from the beginning. When we jump here,
9286 keybuf[0..mock_input] holds the sequence we should reread. */
9287 replay_sequence:
9289 starting_buffer = current_buffer;
9290 first_unbound = bufsize + 1;
9292 /* Build our list of keymaps.
9293 If we recognize a function key and replace its escape sequence in
9294 keybuf with its symbol, or if the sequence starts with a mouse
9295 click and we need to switch buffers, we jump back here to rebuild
9296 the initial keymaps from the current buffer. */
9297 nmaps = 0;
9299 if (!NILP (current_kboard->Voverriding_terminal_local_map))
9301 if (2 > nmaps_allocated)
9303 submaps = (Lisp_Object *) alloca (2 * sizeof (submaps[0]));
9304 defs = (Lisp_Object *) alloca (2 * sizeof (defs[0]));
9305 nmaps_allocated = 2;
9307 submaps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
9309 else if (!NILP (Voverriding_local_map))
9311 if (2 > nmaps_allocated)
9313 submaps = (Lisp_Object *) alloca (2 * sizeof (submaps[0]));
9314 defs = (Lisp_Object *) alloca (2 * sizeof (defs[0]));
9315 nmaps_allocated = 2;
9317 submaps[nmaps++] = Voverriding_local_map;
9319 else
9321 int nminor;
9322 int total;
9323 Lisp_Object *maps;
9325 nminor = current_minor_maps (0, &maps);
9326 total = nminor + (!NILP (orig_keymap) ? 3 : 2);
9328 if (total > nmaps_allocated)
9330 submaps = (Lisp_Object *) alloca (total * sizeof (submaps[0]));
9331 defs = (Lisp_Object *) alloca (total * sizeof (defs[0]));
9332 nmaps_allocated = total;
9335 if (!NILP (orig_keymap))
9336 submaps[nmaps++] = orig_keymap;
9338 bcopy (maps, (void *) (submaps + nmaps),
9339 nminor * sizeof (submaps[0]));
9341 nmaps += nminor;
9343 submaps[nmaps++] = orig_local_map;
9345 submaps[nmaps++] = current_global_map;
9347 /* Find an accurate initial value for first_binding. */
9348 for (first_binding = 0; first_binding < nmaps; first_binding++)
9349 if (! NILP (submaps[first_binding]))
9350 break;
9352 /* Start from the beginning in keybuf. */
9353 t = 0;
9355 /* These are no-ops the first time through, but if we restart, they
9356 revert the echo area and this_command_keys to their original state. */
9357 this_command_key_count = keys_start;
9358 if (INTERACTIVE && t < mock_input)
9359 echo_truncate (echo_start);
9361 /* If the best binding for the current key sequence is a keymap, or
9362 we may be looking at a function key's escape sequence, keep on
9363 reading. */
9364 while (first_binding < nmaps
9365 /* Keep reading as long as there's a prefix binding. */
9366 ? !NILP (submaps[first_binding])
9367 /* Don't return in the middle of a possible function key sequence,
9368 if the only bindings we found were via case conversion.
9369 Thus, if ESC O a has a function-key-map translation
9370 and ESC o has a binding, don't return after ESC O,
9371 so that we can translate ESC O plus the next character. */
9372 : (/* indec.start < t || fkey.start < t || */ keytran.start < t))
9374 Lisp_Object key;
9375 int used_mouse_menu = 0;
9377 /* Where the last real key started. If we need to throw away a
9378 key that has expanded into more than one element of keybuf
9379 (say, a mouse click on the mode line which is being treated
9380 as [mode-line (mouse-...)], then we backtrack to this point
9381 of keybuf. */
9382 volatile int last_real_key_start;
9384 /* These variables are analogous to echo_start and keys_start;
9385 while those allow us to restart the entire key sequence,
9386 echo_local_start and keys_local_start allow us to throw away
9387 just one key. */
9388 volatile int echo_local_start, keys_local_start, local_first_binding;
9390 eassert (indec.end == t || (indec.end > t && indec.end <= mock_input));
9391 eassert (indec.start <= indec.end);
9392 eassert (fkey.start <= fkey.end);
9393 eassert (keytran.start <= keytran.end);
9394 /* key-translation-map is applied *after* function-key-map
9395 which is itself applied *after* input-decode-map. */
9396 eassert (fkey.end <= indec.start);
9397 eassert (keytran.end <= fkey.start);
9399 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9400 first_unbound < keytran.start)
9401 { /* The prefix upto first_unbound has no binding and has
9402 no translation left to do either, so we know it's unbound.
9403 If we don't stop now, we risk staying here indefinitely
9404 (if the user keeps entering fkey or keytran prefixes
9405 like C-c ESC ESC ESC ESC ...) */
9406 int i;
9407 for (i = first_unbound + 1; i < t; i++)
9408 keybuf[i - first_unbound - 1] = keybuf[i];
9409 mock_input = t - first_unbound - 1;
9410 indec.end = indec.start -= first_unbound + 1;
9411 indec.map = indec.parent;
9412 fkey.end = fkey.start -= first_unbound + 1;
9413 fkey.map = fkey.parent;
9414 keytran.end = keytran.start -= first_unbound + 1;
9415 keytran.map = keytran.parent;
9416 goto replay_sequence;
9419 if (t >= bufsize)
9420 error ("Key sequence too long");
9422 if (INTERACTIVE)
9423 echo_local_start = echo_length ();
9424 keys_local_start = this_command_key_count;
9425 local_first_binding = first_binding;
9427 replay_key:
9428 /* These are no-ops, unless we throw away a keystroke below and
9429 jumped back up to replay_key; in that case, these restore the
9430 variables to their original state, allowing us to replay the
9431 loop. */
9432 if (INTERACTIVE && t < mock_input)
9433 echo_truncate (echo_local_start);
9434 this_command_key_count = keys_local_start;
9435 first_binding = local_first_binding;
9437 /* By default, assume each event is "real". */
9438 last_real_key_start = t;
9440 /* Does mock_input indicate that we are re-reading a key sequence? */
9441 if (t < mock_input)
9443 key = keybuf[t];
9444 add_command_key (key);
9445 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
9446 && NILP (Fzerop (Vecho_keystrokes)))
9447 echo_char (key);
9450 /* If not, we should actually read a character. */
9451 else
9454 KBOARD *interrupted_kboard = current_kboard;
9455 struct frame *interrupted_frame = SELECTED_FRAME ();
9456 key = read_char (NILP (prompt), nmaps,
9457 (Lisp_Object *) submaps, last_nonmenu_event,
9458 &used_mouse_menu, NULL);
9459 if (INTEGERP (key) && XINT (key) == -2) /* wrong_kboard_jmpbuf */
9461 int found = 0;
9462 struct kboard *k;
9464 for (k = all_kboards; k; k = k->next_kboard)
9465 if (k == interrupted_kboard)
9466 found = 1;
9468 if (!found)
9470 /* Don't touch interrupted_kboard when it's been
9471 deleted. */
9472 delayed_switch_frame = Qnil;
9473 goto replay_entire_sequence;
9476 if (!NILP (delayed_switch_frame))
9478 interrupted_kboard->kbd_queue
9479 = Fcons (delayed_switch_frame,
9480 interrupted_kboard->kbd_queue);
9481 delayed_switch_frame = Qnil;
9484 while (t > 0)
9485 interrupted_kboard->kbd_queue
9486 = Fcons (keybuf[--t], interrupted_kboard->kbd_queue);
9488 /* If the side queue is non-empty, ensure it begins with a
9489 switch-frame, so we'll replay it in the right context. */
9490 if (CONSP (interrupted_kboard->kbd_queue)
9491 && (key = XCAR (interrupted_kboard->kbd_queue),
9492 !(EVENT_HAS_PARAMETERS (key)
9493 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key)),
9494 Qswitch_frame))))
9496 Lisp_Object frame;
9497 XSETFRAME (frame, interrupted_frame);
9498 interrupted_kboard->kbd_queue
9499 = Fcons (make_lispy_switch_frame (frame),
9500 interrupted_kboard->kbd_queue);
9502 mock_input = 0;
9503 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
9504 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
9505 goto replay_entire_sequence;
9509 /* read_char returns t when it shows a menu and the user rejects it.
9510 Just return -1. */
9511 if (EQ (key, Qt))
9513 unbind_to (count, Qnil);
9514 UNGCPRO;
9515 return -1;
9518 /* read_char returns -1 at the end of a macro.
9519 Emacs 18 handles this by returning immediately with a
9520 zero, so that's what we'll do. */
9521 if (INTEGERP (key) && XINT (key) == -1)
9523 t = 0;
9524 /* The Microsoft C compiler can't handle the goto that
9525 would go here. */
9526 dummyflag = 1;
9527 break;
9530 /* If the current buffer has been changed from under us, the
9531 keymap may have changed, so replay the sequence. */
9532 if (BUFFERP (key))
9534 timer_resume_idle ();
9536 mock_input = t;
9537 /* Reset the current buffer from the selected window
9538 in case something changed the former and not the latter.
9539 This is to be more consistent with the behavior
9540 of the command_loop_1. */
9541 if (fix_current_buffer)
9543 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
9544 Fkill_emacs (Qnil);
9545 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
9546 Fset_buffer (XWINDOW (selected_window)->buffer);
9549 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
9550 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
9551 goto replay_sequence;
9554 /* If we have a quit that was typed in another frame, and
9555 quit_throw_to_read_char switched buffers,
9556 replay to get the right keymap. */
9557 if (INTEGERP (key)
9558 && XINT (key) == quit_char
9559 && current_buffer != starting_buffer)
9561 GROW_RAW_KEYBUF;
9562 XVECTOR (raw_keybuf)->contents[raw_keybuf_count++] = key;
9563 keybuf[t++] = key;
9564 mock_input = t;
9565 Vquit_flag = Qnil;
9566 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
9567 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
9568 goto replay_sequence;
9571 Vquit_flag = Qnil;
9573 if (EVENT_HAS_PARAMETERS (key)
9574 /* Either a `switch-frame' or a `select-window' event. */
9575 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key)), Qswitch_frame))
9577 /* If we're at the beginning of a key sequence, and the caller
9578 says it's okay, go ahead and return this event. If we're
9579 in the midst of a key sequence, delay it until the end. */
9580 if (t > 0 || !can_return_switch_frame)
9582 delayed_switch_frame = key;
9583 goto replay_key;
9587 GROW_RAW_KEYBUF;
9588 ASET (raw_keybuf, raw_keybuf_count, key);
9589 raw_keybuf_count++;
9592 /* Clicks in non-text areas get prefixed by the symbol
9593 in their CHAR-ADDRESS field. For example, a click on
9594 the mode line is prefixed by the symbol `mode-line'.
9596 Furthermore, key sequences beginning with mouse clicks
9597 are read using the keymaps of the buffer clicked on, not
9598 the current buffer. So we may have to switch the buffer
9599 here.
9601 When we turn one event into two events, we must make sure
9602 that neither of the two looks like the original--so that,
9603 if we replay the events, they won't be expanded again.
9604 If not for this, such reexpansion could happen either here
9605 or when user programs play with this-command-keys. */
9606 if (EVENT_HAS_PARAMETERS (key))
9608 Lisp_Object kind;
9609 Lisp_Object string;
9611 kind = EVENT_HEAD_KIND (EVENT_HEAD (key));
9612 if (EQ (kind, Qmouse_click))
9614 Lisp_Object window, posn;
9616 window = POSN_WINDOW (EVENT_START (key));
9617 posn = POSN_POSN (EVENT_START (key));
9619 if (CONSP (posn)
9620 || (!NILP (fake_prefixed_keys)
9621 && !NILP (Fmemq (key, fake_prefixed_keys))))
9623 /* We're looking a second time at an event for which
9624 we generated a fake prefix key. Set
9625 last_real_key_start appropriately. */
9626 if (t > 0)
9627 last_real_key_start = t - 1;
9630 /* Key sequences beginning with mouse clicks are
9631 read using the keymaps in the buffer clicked on,
9632 not the current buffer. If we're at the
9633 beginning of a key sequence, switch buffers. */
9634 if (last_real_key_start == 0
9635 && WINDOWP (window)
9636 && BUFFERP (XWINDOW (window)->buffer)
9637 && XBUFFER (XWINDOW (window)->buffer) != current_buffer)
9639 XVECTOR (raw_keybuf)->contents[raw_keybuf_count++] = key;
9640 keybuf[t] = key;
9641 mock_input = t + 1;
9643 /* Arrange to go back to the original buffer once we're
9644 done reading the key sequence. Note that we can't
9645 use save_excursion_{save,restore} here, because they
9646 save point as well as the current buffer; we don't
9647 want to save point, because redisplay may change it,
9648 to accommodate a Fset_window_start or something. We
9649 don't want to do this at the top of the function,
9650 because we may get input from a subprocess which
9651 wants to change the selected window and stuff (say,
9652 emacsclient). */
9653 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
9655 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
9656 Fkill_emacs (Qnil);
9657 set_buffer_internal (XBUFFER (XWINDOW (window)->buffer));
9658 orig_local_map = get_local_map (PT, current_buffer,
9659 Qlocal_map);
9660 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
9661 goto replay_sequence;
9664 /* For a mouse click, get the local text-property keymap
9665 of the place clicked on, rather than point. */
9666 if (last_real_key_start == 0
9667 && CONSP (XCDR (key))
9668 && ! localized_local_map)
9670 Lisp_Object map_here, start, pos;
9672 localized_local_map = 1;
9673 start = EVENT_START (key);
9675 if (CONSP (start) && POSN_INBUFFER_P (start))
9677 pos = POSN_BUFFER_POSN (start);
9678 if (INTEGERP (pos)
9679 && XINT (pos) >= BEGV
9680 && XINT (pos) <= ZV)
9682 map_here = get_local_map (XINT (pos),
9683 current_buffer, Qlocal_map);
9684 if (!EQ (map_here, orig_local_map))
9686 orig_local_map = map_here;
9687 ++localized_local_map;
9690 map_here = get_local_map (XINT (pos),
9691 current_buffer, Qkeymap);
9692 if (!EQ (map_here, orig_keymap))
9694 orig_keymap = map_here;
9695 ++localized_local_map;
9698 if (localized_local_map > 1)
9700 keybuf[t] = key;
9701 mock_input = t + 1;
9703 goto replay_sequence;
9709 /* Expand mode-line and scroll-bar events into two events:
9710 use posn as a fake prefix key. */
9711 if (SYMBOLP (posn)
9712 && (NILP (fake_prefixed_keys)
9713 || NILP (Fmemq (key, fake_prefixed_keys))))
9715 if (t + 1 >= bufsize)
9716 error ("Key sequence too long");
9718 keybuf[t] = posn;
9719 keybuf[t + 1] = key;
9720 mock_input = t + 2;
9722 /* Record that a fake prefix key has been generated
9723 for KEY. Don't modify the event; this would
9724 prevent proper action when the event is pushed
9725 back into unread-command-events. */
9726 fake_prefixed_keys = Fcons (key, fake_prefixed_keys);
9728 /* If on a mode line string with a local keymap,
9729 reconsider the key sequence with that keymap. */
9730 if (string = POSN_STRING (EVENT_START (key)),
9731 (CONSP (string) && STRINGP (XCAR (string))))
9733 Lisp_Object pos, map, map2;
9735 pos = XCDR (string);
9736 string = XCAR (string);
9737 if (XINT (pos) >= 0
9738 && XINT (pos) < SCHARS (string))
9740 map = Fget_text_property (pos, Qlocal_map, string);
9741 if (!NILP (map))
9742 orig_local_map = map;
9743 map2 = Fget_text_property (pos, Qkeymap, string);
9744 if (!NILP (map2))
9745 orig_keymap = map2;
9746 if (!NILP (map) || !NILP (map2))
9747 goto replay_sequence;
9751 goto replay_key;
9753 else if (NILP (from_string)
9754 && (string = POSN_STRING (EVENT_START (key)),
9755 (CONSP (string) && STRINGP (XCAR (string)))))
9757 /* For a click on a string, i.e. overlay string or a
9758 string displayed via the `display' property,
9759 consider `local-map' and `keymap' properties of
9760 that string. */
9761 Lisp_Object pos, map, map2;
9763 pos = XCDR (string);
9764 string = XCAR (string);
9765 if (XINT (pos) >= 0
9766 && XINT (pos) < SCHARS (string))
9768 map = Fget_text_property (pos, Qlocal_map, string);
9769 if (!NILP (map))
9770 orig_local_map = map;
9771 map2 = Fget_text_property (pos, Qkeymap, string);
9772 if (!NILP (map2))
9773 orig_keymap = map2;
9775 if (!NILP (map) || !NILP (map2))
9777 from_string = string;
9778 keybuf[t++] = key;
9779 mock_input = t;
9780 goto replay_sequence;
9785 else if (CONSP (XCDR (key))
9786 && CONSP (EVENT_START (key))
9787 && CONSP (XCDR (EVENT_START (key))))
9789 Lisp_Object posn;
9791 posn = POSN_POSN (EVENT_START (key));
9792 /* Handle menu-bar events:
9793 insert the dummy prefix event `menu-bar'. */
9794 if (EQ (posn, Qmenu_bar) || EQ (posn, Qtool_bar))
9796 if (t + 1 >= bufsize)
9797 error ("Key sequence too long");
9798 keybuf[t] = posn;
9799 keybuf[t+1] = key;
9801 /* Zap the position in key, so we know that we've
9802 expanded it, and don't try to do so again. */
9803 POSN_SET_POSN (EVENT_START (key),
9804 Fcons (posn, Qnil));
9806 mock_input = t + 2;
9807 goto replay_sequence;
9809 else if (CONSP (posn))
9811 /* We're looking at the second event of a
9812 sequence which we expanded before. Set
9813 last_real_key_start appropriately. */
9814 if (last_real_key_start == t && t > 0)
9815 last_real_key_start = t - 1;
9820 /* We have finally decided that KEY is something we might want
9821 to look up. */
9822 first_binding = (follow_key (key,
9823 nmaps - first_binding,
9824 submaps + first_binding,
9825 defs + first_binding,
9826 submaps + first_binding)
9827 + first_binding);
9829 /* If KEY wasn't bound, we'll try some fallbacks. */
9830 if (first_binding < nmaps)
9831 /* This is needed for the following scenario:
9832 event 0: a down-event that gets dropped by calling replay_key.
9833 event 1: some normal prefix like C-h.
9834 After event 0, first_unbound is 0, after event 1 indec.start,
9835 fkey.start, and keytran.start are all 1, so when we see that
9836 C-h is bound, we need to update first_unbound. */
9837 first_unbound = max (t + 1, first_unbound);
9838 else
9840 Lisp_Object head;
9842 /* Remember the position to put an upper bound on indec.start. */
9843 first_unbound = min (t, first_unbound);
9845 head = EVENT_HEAD (key);
9846 if (help_char_p (head) && t > 0)
9848 read_key_sequence_cmd = Vprefix_help_command;
9849 keybuf[t++] = key;
9850 last_nonmenu_event = key;
9851 /* The Microsoft C compiler can't handle the goto that
9852 would go here. */
9853 dummyflag = 1;
9854 break;
9857 if (SYMBOLP (head))
9859 Lisp_Object breakdown;
9860 int modifiers;
9862 breakdown = parse_modifiers (head);
9863 modifiers = XINT (XCAR (XCDR (breakdown)));
9864 /* Attempt to reduce an unbound mouse event to a simpler
9865 event that is bound:
9866 Drags reduce to clicks.
9867 Double-clicks reduce to clicks.
9868 Triple-clicks reduce to double-clicks, then to clicks.
9869 Down-clicks are eliminated.
9870 Double-downs reduce to downs, then are eliminated.
9871 Triple-downs reduce to double-downs, then to downs,
9872 then are eliminated. */
9873 if (modifiers & (down_modifier | drag_modifier
9874 | double_modifier | triple_modifier))
9876 while (modifiers & (down_modifier | drag_modifier
9877 | double_modifier | triple_modifier))
9879 Lisp_Object new_head, new_click;
9880 if (modifiers & triple_modifier)
9881 modifiers ^= (double_modifier | triple_modifier);
9882 else if (modifiers & double_modifier)
9883 modifiers &= ~double_modifier;
9884 else if (modifiers & drag_modifier)
9885 modifiers &= ~drag_modifier;
9886 else
9888 /* Dispose of this `down' event by simply jumping
9889 back to replay_key, to get another event.
9891 Note that if this event came from mock input,
9892 then just jumping back to replay_key will just
9893 hand it to us again. So we have to wipe out any
9894 mock input.
9896 We could delete keybuf[t] and shift everything
9897 after that to the left by one spot, but we'd also
9898 have to fix up any variable that points into
9899 keybuf, and shifting isn't really necessary
9900 anyway.
9902 Adding prefixes for non-textual mouse clicks
9903 creates two characters of mock input, and both
9904 must be thrown away. If we're only looking at
9905 the prefix now, we can just jump back to
9906 replay_key. On the other hand, if we've already
9907 processed the prefix, and now the actual click
9908 itself is giving us trouble, then we've lost the
9909 state of the keymaps we want to backtrack to, and
9910 we need to replay the whole sequence to rebuild
9913 Beyond that, only function key expansion could
9914 create more than two keys, but that should never
9915 generate mouse events, so it's okay to zero
9916 mock_input in that case too.
9918 FIXME: The above paragraph seems just plain
9919 wrong, if you consider things like
9920 xterm-mouse-mode. -stef
9922 Isn't this just the most wonderful code ever? */
9924 /* If mock_input > t + 1, the above simplification
9925 will actually end up dropping keys on the floor.
9926 This is probably OK for now, but even
9927 if mock_input <= t + 1, we need to adjust indec,
9928 fkey, and keytran.
9929 Typical case [header-line down-mouse-N]:
9930 mock_input = 2, t = 1, fkey.end = 1,
9931 last_real_key_start = 0. */
9932 if (indec.end > last_real_key_start)
9934 indec.end = indec.start
9935 = min (last_real_key_start, indec.start);
9936 indec.map = indec.parent;
9937 if (fkey.end > last_real_key_start)
9939 fkey.end = fkey.start
9940 = min (last_real_key_start, fkey.start);
9941 fkey.map = fkey.parent;
9942 if (keytran.end > last_real_key_start)
9944 keytran.end = keytran.start
9945 = min (last_real_key_start, keytran.start);
9946 keytran.map = keytran.parent;
9950 if (t == last_real_key_start)
9952 mock_input = 0;
9953 goto replay_key;
9955 else
9957 mock_input = last_real_key_start;
9958 goto replay_sequence;
9962 new_head
9963 = apply_modifiers (modifiers, XCAR (breakdown));
9964 new_click
9965 = Fcons (new_head, Fcons (EVENT_START (key), Qnil));
9967 /* Look for a binding for this new key. follow_key
9968 promises that it didn't munge submaps the
9969 last time we called it, since key was unbound. */
9970 first_binding
9971 = (follow_key (new_click,
9972 nmaps - local_first_binding,
9973 submaps + local_first_binding,
9974 defs + local_first_binding,
9975 submaps + local_first_binding)
9976 + local_first_binding);
9978 /* If that click is bound, go for it. */
9979 if (first_binding < nmaps)
9981 key = new_click;
9982 break;
9984 /* Otherwise, we'll leave key set to the drag event. */
9990 keybuf[t++] = key;
9991 /* Normally, last_nonmenu_event gets the previous key we read.
9992 But when a mouse popup menu is being used,
9993 we don't update last_nonmenu_event; it continues to hold the mouse
9994 event that preceded the first level of menu. */
9995 if (!used_mouse_menu)
9996 last_nonmenu_event = key;
9998 /* Record what part of this_command_keys is the current key sequence. */
9999 this_single_command_key_start = this_command_key_count - t;
10001 /* Look for this sequence in input-decode-map.
10002 Scan from indec.end until we find a bound suffix. */
10003 while (indec.end < t)
10005 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
10006 int done, diff;
10008 GCPRO4 (indec.map, fkey.map, keytran.map, delayed_switch_frame);
10009 done = keyremap_step (keybuf, bufsize, &indec, max (t, mock_input),
10010 1, &diff, prompt);
10011 UNGCPRO;
10012 if (done)
10014 mock_input = diff + max (t, mock_input);
10015 goto replay_sequence;
10019 if (first_binding < nmaps && NILP (submaps[first_binding])
10020 && indec.start >= t)
10021 /* There is a binding and it's not a prefix.
10022 (and it doesn't have any input-decode-map translation pending).
10023 There is thus no function-key in this sequence.
10024 Moving fkey.start is important in this case to allow keytran.start
10025 to go over the sequence before we return (since we keep the
10026 invariant that keytran.end <= fkey.start). */
10028 if (fkey.start < t)
10029 (fkey.start = fkey.end = t, fkey.map = fkey.parent);
10031 else
10032 /* If the sequence is unbound, see if we can hang a function key
10033 off the end of it. */
10034 /* Continue scan from fkey.end until we find a bound suffix. */
10035 while (fkey.end < indec.start)
10037 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
10038 int done, diff;
10040 GCPRO4 (indec.map, fkey.map, keytran.map, delayed_switch_frame);
10041 done = keyremap_step (keybuf, bufsize, &fkey,
10042 max (t, mock_input),
10043 /* If there's a binding (i.e.
10044 first_binding >= nmaps) we don't want
10045 to apply this function-key-mapping. */
10046 fkey.end + 1 == t && first_binding >= nmaps,
10047 &diff, prompt);
10048 UNGCPRO;
10049 if (done)
10051 mock_input = diff + max (t, mock_input);
10052 /* Adjust the input-decode-map counters. */
10053 indec.end += diff;
10054 indec.start += diff;
10056 goto replay_sequence;
10060 /* Look for this sequence in key-translation-map.
10061 Scan from keytran.end until we find a bound suffix. */
10062 while (keytran.end < fkey.start)
10064 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
10065 int done, diff;
10067 GCPRO4 (indec.map, fkey.map, keytran.map, delayed_switch_frame);
10068 done = keyremap_step (keybuf, bufsize, &keytran, max (t, mock_input),
10069 1, &diff, prompt);
10070 UNGCPRO;
10071 if (done)
10073 mock_input = diff + max (t, mock_input);
10074 /* Adjust the function-key-map and input-decode-map counters. */
10075 indec.end += diff;
10076 indec.start += diff;
10077 fkey.end += diff;
10078 fkey.start += diff;
10080 goto replay_sequence;
10084 /* If KEY is not defined in any of the keymaps,
10085 and cannot be part of a function key or translation,
10086 and is an upper case letter
10087 use the corresponding lower-case letter instead. */
10088 if (first_binding >= nmaps
10089 && /* indec.start >= t && fkey.start >= t && */ keytran.start >= t
10090 && INTEGERP (key)
10091 && ((CHARACTERP (make_number (XINT (key) & ~CHAR_MODIFIER_MASK))
10092 && UPPERCASEP (XINT (key) & ~CHAR_MODIFIER_MASK))
10093 || (XINT (key) & shift_modifier)))
10095 Lisp_Object new_key;
10097 original_uppercase = key;
10098 original_uppercase_position = t - 1;
10100 if (XINT (key) & shift_modifier)
10101 XSETINT (new_key, XINT (key) & ~shift_modifier);
10102 else
10103 XSETINT (new_key, (DOWNCASE (XINT (key) & ~CHAR_MODIFIER_MASK)
10104 | (XINT (key) & CHAR_MODIFIER_MASK)));
10106 /* We have to do this unconditionally, regardless of whether
10107 the lower-case char is defined in the keymaps, because they
10108 might get translated through function-key-map. */
10109 keybuf[t - 1] = new_key;
10110 mock_input = max (t, mock_input);
10111 shift_translated = 1;
10113 goto replay_sequence;
10115 /* If KEY is not defined in any of the keymaps,
10116 and cannot be part of a function key or translation,
10117 and is a shifted function key,
10118 use the corresponding unshifted function key instead. */
10119 if (first_binding >= nmaps
10120 && /* indec.start >= t && fkey.start >= t && */ keytran.start >= t)
10122 Lisp_Object breakdown = parse_modifiers (key);
10123 int modifiers
10124 = CONSP (breakdown) ? (XINT (XCAR (XCDR (breakdown)))) : 0;
10126 if (modifiers & shift_modifier
10127 /* Treat uppercase keys as shifted. */
10128 || (INTEGERP (key)
10129 && (KEY_TO_CHAR (key)
10130 < XCHAR_TABLE (current_buffer->downcase_table)->size)
10131 && UPPERCASEP (KEY_TO_CHAR (key))))
10133 Lisp_Object new_key
10134 = (modifiers & shift_modifier
10135 ? apply_modifiers (modifiers & ~shift_modifier,
10136 XCAR (breakdown))
10137 : make_number (DOWNCASE (KEY_TO_CHAR (key)) | modifiers));
10139 original_uppercase = key;
10140 original_uppercase_position = t - 1;
10142 /* We have to do this unconditionally, regardless of whether
10143 the lower-case char is defined in the keymaps, because they
10144 might get translated through function-key-map. */
10145 keybuf[t - 1] = new_key;
10146 mock_input = max (t, mock_input);
10147 /* Reset fkey (and consequently keytran) to apply
10148 function-key-map on the result, so that S-backspace is
10149 correctly mapped to DEL (via backspace). OTOH,
10150 input-decode-map doesn't need to go through it again. */
10151 fkey.start = fkey.end = 0;
10152 keytran.start = keytran.end = 0;
10153 shift_translated = 1;
10155 goto replay_sequence;
10159 if (!dummyflag)
10160 read_key_sequence_cmd = (first_binding < nmaps
10161 ? defs[first_binding]
10162 : Qnil);
10164 unread_switch_frame = delayed_switch_frame;
10165 unbind_to (count, Qnil);
10167 /* Don't downcase the last character if the caller says don't.
10168 Don't downcase it if the result is undefined, either. */
10169 if ((dont_downcase_last || first_binding >= nmaps)
10170 && t > 0
10171 && t - 1 == original_uppercase_position)
10173 keybuf[t - 1] = original_uppercase;
10174 shift_translated = 0;
10177 if (shift_translated)
10178 Vthis_command_keys_shift_translated = Qt;
10180 /* Occasionally we fabricate events, perhaps by expanding something
10181 according to function-key-map, or by adding a prefix symbol to a
10182 mouse click in the scroll bar or modeline. In this cases, return
10183 the entire generated key sequence, even if we hit an unbound
10184 prefix or a definition before the end. This means that you will
10185 be able to push back the event properly, and also means that
10186 read-key-sequence will always return a logical unit.
10188 Better ideas? */
10189 for (; t < mock_input; t++)
10191 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
10192 && NILP (Fzerop (Vecho_keystrokes)))
10193 echo_char (keybuf[t]);
10194 add_command_key (keybuf[t]);
10197 UNGCPRO;
10198 return t;
10201 DEFUN ("read-key-sequence", Fread_key_sequence, Sread_key_sequence, 1, 5, 0,
10202 doc: /* Read a sequence of keystrokes and return as a string or vector.
10203 The sequence is sufficient to specify a non-prefix command in the
10204 current local and global maps.
10206 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10207 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10208 as a continuation of the previous key.
10210 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10211 convert the last event to lower case. (Normally any upper case event
10212 is converted to lower case if the original event is undefined and the lower
10213 case equivalent is defined.) A non-nil value is appropriate for reading
10214 a key sequence to be defined.
10216 A C-g typed while in this function is treated like any other character,
10217 and `quit-flag' is not set.
10219 If the key sequence starts with a mouse click, then the sequence is read
10220 using the keymaps of the buffer of the window clicked in, not the buffer
10221 of the selected window as normal.
10223 `read-key-sequence' drops unbound button-down events, since you normally
10224 only care about the click or drag events which follow them. If a drag
10225 or multi-click event is unbound, but the corresponding click event would
10226 be bound, `read-key-sequence' turns the event into a click event at the
10227 drag's starting position. This means that you don't have to distinguish
10228 between click and drag, double, or triple events unless you want to.
10230 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10231 lines separating windows, and scroll bars with imaginary keys
10232 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10234 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10235 function will process a switch-frame event if the user switches frames
10236 before typing anything. If the user switches frames in the middle of a
10237 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10238 is nil, then the event will be put off until after the current key sequence.
10240 `read-key-sequence' checks `function-key-map' for function key
10241 sequences, where they wouldn't conflict with ordinary bindings. See
10242 `function-key-map' for more details.
10244 The optional fifth argument COMMAND-LOOP, if non-nil, means
10245 that this key sequence is being read by something that will
10246 read commands one after another. It should be nil if the caller
10247 will read just one key sequence. */)
10248 (prompt, continue_echo, dont_downcase_last, can_return_switch_frame,
10249 command_loop)
10250 Lisp_Object prompt, continue_echo, dont_downcase_last;
10251 Lisp_Object can_return_switch_frame, command_loop;
10253 Lisp_Object keybuf[30];
10254 register int i;
10255 struct gcpro gcpro1;
10256 int count = SPECPDL_INDEX ();
10258 if (!NILP (prompt))
10259 CHECK_STRING (prompt);
10260 QUIT;
10262 specbind (Qinput_method_exit_on_first_char,
10263 (NILP (command_loop) ? Qt : Qnil));
10264 specbind (Qinput_method_use_echo_area,
10265 (NILP (command_loop) ? Qt : Qnil));
10267 bzero (keybuf, sizeof keybuf);
10268 GCPRO1 (keybuf[0]);
10269 gcpro1.nvars = (sizeof keybuf/sizeof (keybuf[0]));
10271 if (NILP (continue_echo))
10273 this_command_key_count = 0;
10274 this_command_key_count_reset = 0;
10275 this_single_command_key_start = 0;
10278 #ifdef HAVE_WINDOW_SYSTEM
10279 if (display_hourglass_p)
10280 cancel_hourglass ();
10281 #endif
10283 i = read_key_sequence (keybuf, (sizeof keybuf/sizeof (keybuf[0])),
10284 prompt, ! NILP (dont_downcase_last),
10285 ! NILP (can_return_switch_frame), 0);
10287 #if 0 /* The following is fine for code reading a key sequence and
10288 then proceeding with a lenghty computation, but it's not good
10289 for code reading keys in a loop, like an input method. */
10290 #ifdef HAVE_WINDOW_SYSTEM
10291 if (display_hourglass_p)
10292 start_hourglass ();
10293 #endif
10294 #endif
10296 if (i == -1)
10298 Vquit_flag = Qt;
10299 QUIT;
10301 UNGCPRO;
10302 return unbind_to (count, make_event_array (i, keybuf));
10305 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector,
10306 Sread_key_sequence_vector, 1, 5, 0,
10307 doc: /* Like `read-key-sequence' but always return a vector. */)
10308 (prompt, continue_echo, dont_downcase_last, can_return_switch_frame,
10309 command_loop)
10310 Lisp_Object prompt, continue_echo, dont_downcase_last;
10311 Lisp_Object can_return_switch_frame, command_loop;
10313 Lisp_Object keybuf[30];
10314 register int i;
10315 struct gcpro gcpro1;
10316 int count = SPECPDL_INDEX ();
10318 if (!NILP (prompt))
10319 CHECK_STRING (prompt);
10320 QUIT;
10322 specbind (Qinput_method_exit_on_first_char,
10323 (NILP (command_loop) ? Qt : Qnil));
10324 specbind (Qinput_method_use_echo_area,
10325 (NILP (command_loop) ? Qt : Qnil));
10327 bzero (keybuf, sizeof keybuf);
10328 GCPRO1 (keybuf[0]);
10329 gcpro1.nvars = (sizeof keybuf/sizeof (keybuf[0]));
10331 if (NILP (continue_echo))
10333 this_command_key_count = 0;
10334 this_command_key_count_reset = 0;
10335 this_single_command_key_start = 0;
10338 #ifdef HAVE_WINDOW_SYSTEM
10339 if (display_hourglass_p)
10340 cancel_hourglass ();
10341 #endif
10343 i = read_key_sequence (keybuf, (sizeof keybuf/sizeof (keybuf[0])),
10344 prompt, ! NILP (dont_downcase_last),
10345 ! NILP (can_return_switch_frame), 0);
10347 #ifdef HAVE_WINDOW_SYSTEM
10348 if (display_hourglass_p)
10349 start_hourglass ();
10350 #endif
10352 if (i == -1)
10354 Vquit_flag = Qt;
10355 QUIT;
10357 UNGCPRO;
10358 return unbind_to (count, Fvector (i, keybuf));
10361 DEFUN ("command-execute", Fcommand_execute, Scommand_execute, 1, 4, 0,
10362 doc: /* Execute CMD as an editor command.
10363 CMD must be a symbol that satisfies the `commandp' predicate.
10364 Optional second arg RECORD-FLAG non-nil
10365 means unconditionally put this command in `command-history'.
10366 Otherwise, that is done only if an arg is read using the minibuffer.
10367 The argument KEYS specifies the value to use instead of (this-command-keys)
10368 when reading the arguments; if it is nil, (this-command-keys) is used.
10369 The argument SPECIAL, if non-nil, means that this command is executing
10370 a special event, so ignore the prefix argument and don't clear it. */)
10371 (cmd, record_flag, keys, special)
10372 Lisp_Object cmd, record_flag, keys, special;
10374 register Lisp_Object final;
10375 register Lisp_Object tem;
10376 Lisp_Object prefixarg;
10377 extern int debug_on_next_call;
10379 debug_on_next_call = 0;
10381 if (NILP (special))
10383 prefixarg = current_kboard->Vprefix_arg;
10384 Vcurrent_prefix_arg = prefixarg;
10385 current_kboard->Vprefix_arg = Qnil;
10387 else
10388 prefixarg = Qnil;
10390 if (SYMBOLP (cmd))
10392 tem = Fget (cmd, Qdisabled);
10393 if (!NILP (tem) && !NILP (Vrun_hooks))
10395 tem = Fsymbol_value (Qdisabled_command_function);
10396 if (!NILP (tem))
10397 return call1 (Vrun_hooks, Qdisabled_command_function);
10401 while (1)
10403 final = Findirect_function (cmd, Qnil);
10405 if (CONSP (final) && (tem = Fcar (final), EQ (tem, Qautoload)))
10407 struct gcpro gcpro1, gcpro2;
10409 GCPRO2 (cmd, prefixarg);
10410 do_autoload (final, cmd);
10411 UNGCPRO;
10413 else
10414 break;
10417 if (STRINGP (final) || VECTORP (final))
10419 /* If requested, place the macro in the command history. For
10420 other sorts of commands, call-interactively takes care of
10421 this. */
10422 if (!NILP (record_flag))
10424 Vcommand_history
10425 = Fcons (Fcons (Qexecute_kbd_macro,
10426 Fcons (final, Fcons (prefixarg, Qnil))),
10427 Vcommand_history);
10429 /* Don't keep command history around forever. */
10430 if (NUMBERP (Vhistory_length) && XINT (Vhistory_length) > 0)
10432 tem = Fnthcdr (Vhistory_length, Vcommand_history);
10433 if (CONSP (tem))
10434 XSETCDR (tem, Qnil);
10438 return Fexecute_kbd_macro (final, prefixarg, Qnil);
10441 if (CONSP (final) || SUBRP (final) || COMPILEDP (final))
10442 /* Don't call Fcall_interactively directly because we want to make
10443 sure the backtrace has an entry for `call-interactively'.
10444 For the same reason, pass `cmd' rather than `final'. */
10445 return call3 (Qcall_interactively, cmd, record_flag, keys);
10447 return Qnil;
10452 DEFUN ("execute-extended-command", Fexecute_extended_command, Sexecute_extended_command,
10453 1, 1, "P",
10454 doc: /* Read function name, then read its arguments and call it.
10456 To pass a numeric argument to the command you are invoking with, specify
10457 the numeric argument to this command.
10459 Noninteractively, the argument PREFIXARG is the prefix argument to
10460 give to the command you invoke, if it asks for an argument. */)
10461 (prefixarg)
10462 Lisp_Object prefixarg;
10464 Lisp_Object function;
10465 char buf[40];
10466 int saved_last_point_position;
10467 Lisp_Object saved_keys, saved_last_point_position_buffer;
10468 Lisp_Object bindings, value;
10469 struct gcpro gcpro1, gcpro2, gcpro3;
10470 #ifdef HAVE_WINDOW_SYSTEM
10471 /* The call to Fcompleting_read wil start and cancel the hourglass,
10472 but if the hourglass was already scheduled, this means that no
10473 hourglass will be shown for the actual M-x command itself.
10474 So we restart it if it is already scheduled. Note that checking
10475 hourglass_shown_p is not enough, normally the hourglass is not shown,
10476 just scheduled to be shown. */
10477 int hstarted = hourglass_started ();
10478 #endif
10480 saved_keys = Fvector (this_command_key_count,
10481 XVECTOR (this_command_keys)->contents);
10482 saved_last_point_position_buffer = last_point_position_buffer;
10483 saved_last_point_position = last_point_position;
10484 buf[0] = 0;
10485 GCPRO3 (saved_keys, prefixarg, saved_last_point_position_buffer);
10487 if (EQ (prefixarg, Qminus))
10488 strcpy (buf, "- ");
10489 else if (CONSP (prefixarg) && XINT (XCAR (prefixarg)) == 4)
10490 strcpy (buf, "C-u ");
10491 else if (CONSP (prefixarg) && INTEGERP (XCAR (prefixarg)))
10492 sprintf (buf, "%ld ", (long) XINT (XCAR (prefixarg)));
10493 else if (INTEGERP (prefixarg))
10494 sprintf (buf, "%ld ", (long) XINT (prefixarg));
10496 /* This isn't strictly correct if execute-extended-command
10497 is bound to anything else. Perhaps it should use
10498 this_command_keys? */
10499 strcat (buf, "M-x ");
10501 /* Prompt with buf, and then read a string, completing from and
10502 restricting to the set of all defined commands. Don't provide
10503 any initial input. Save the command read on the extended-command
10504 history list. */
10505 function = Fcompleting_read (build_string (buf),
10506 Vobarray, Qcommandp,
10507 Qt, Qnil, Qextended_command_history, Qnil,
10508 Qnil);
10510 #ifdef HAVE_WINDOW_SYSTEM
10511 if (hstarted) start_hourglass ();
10512 #endif
10514 if (STRINGP (function) && SCHARS (function) == 0)
10515 error ("No command name given");
10517 /* Set this_command_keys to the concatenation of saved_keys and
10518 function, followed by a RET. */
10520 Lisp_Object *keys;
10521 int i;
10523 this_command_key_count = 0;
10524 this_command_key_count_reset = 0;
10525 this_single_command_key_start = 0;
10527 keys = XVECTOR (saved_keys)->contents;
10528 for (i = 0; i < XVECTOR (saved_keys)->size; i++)
10529 add_command_key (keys[i]);
10531 for (i = 0; i < SCHARS (function); i++)
10532 add_command_key (Faref (function, make_number (i)));
10534 add_command_key (make_number ('\015'));
10537 last_point_position = saved_last_point_position;
10538 last_point_position_buffer = saved_last_point_position_buffer;
10540 UNGCPRO;
10542 function = Fintern (function, Qnil);
10543 current_kboard->Vprefix_arg = prefixarg;
10544 Vthis_command = function;
10545 real_this_command = function;
10547 /* If enabled, show which key runs this command. */
10548 if (!NILP (Vsuggest_key_bindings)
10549 && NILP (Vexecuting_kbd_macro)
10550 && SYMBOLP (function))
10551 bindings = Fwhere_is_internal (function, Voverriding_local_map,
10552 Qt, Qnil, Qnil);
10553 else
10554 bindings = Qnil;
10556 value = Qnil;
10557 GCPRO3 (bindings, value, function);
10558 value = Fcommand_execute (function, Qt, Qnil, Qnil);
10560 /* If the command has a key binding, print it now. */
10561 if (!NILP (bindings)
10562 && ! (VECTORP (bindings) && EQ (Faref (bindings, make_number (0)),
10563 Qmouse_movement)))
10565 /* But first wait, and skip the message if there is input. */
10566 Lisp_Object waited;
10568 /* If this command displayed something in the echo area;
10569 wait a few seconds, then display our suggestion message. */
10570 if (NILP (echo_area_buffer[0]))
10571 waited = sit_for (make_number (0), 0, 2);
10572 else if (NUMBERP (Vsuggest_key_bindings))
10573 waited = sit_for (Vsuggest_key_bindings, 0, 2);
10574 else
10575 waited = sit_for (make_number (2), 0, 2);
10577 if (!NILP (waited) && ! CONSP (Vunread_command_events))
10579 Lisp_Object binding;
10580 char *newmessage;
10581 int message_p = push_message ();
10582 int count = SPECPDL_INDEX ();
10584 record_unwind_protect (pop_message_unwind, Qnil);
10585 binding = Fkey_description (bindings, Qnil);
10587 newmessage
10588 = (char *) alloca (SCHARS (SYMBOL_NAME (function))
10589 + SBYTES (binding)
10590 + 100);
10591 sprintf (newmessage, "You can run the command `%s' with %s",
10592 SDATA (SYMBOL_NAME (function)),
10593 SDATA (binding));
10594 message2_nolog (newmessage,
10595 strlen (newmessage),
10596 STRING_MULTIBYTE (binding));
10597 if (NUMBERP (Vsuggest_key_bindings))
10598 waited = sit_for (Vsuggest_key_bindings, 0, 2);
10599 else
10600 waited = sit_for (make_number (2), 0, 2);
10602 if (!NILP (waited) && message_p)
10603 restore_message ();
10605 unbind_to (count, Qnil);
10609 RETURN_UNGCPRO (value);
10613 /* Return nonzero if input events are pending. */
10616 detect_input_pending ()
10618 if (!input_pending)
10619 get_input_pending (&input_pending, 0);
10621 return input_pending;
10624 /* Return nonzero if input events other than mouse movements are
10625 pending. */
10628 detect_input_pending_ignore_squeezables ()
10630 if (!input_pending)
10631 get_input_pending (&input_pending, READABLE_EVENTS_IGNORE_SQUEEZABLES);
10633 return input_pending;
10636 /* Return nonzero if input events are pending, and run any pending timers. */
10639 detect_input_pending_run_timers (do_display)
10640 int do_display;
10642 int old_timers_run = timers_run;
10644 if (!input_pending)
10645 get_input_pending (&input_pending, READABLE_EVENTS_DO_TIMERS_NOW);
10647 if (old_timers_run != timers_run && do_display)
10649 redisplay_preserve_echo_area (8);
10650 /* The following fixes a bug when using lazy-lock with
10651 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10652 from an idle timer function. The symptom of the bug is that
10653 the cursor sometimes doesn't become visible until the next X
10654 event is processed. --gerd. */
10656 Lisp_Object tail, frame;
10657 FOR_EACH_FRAME (tail, frame)
10658 if (FRAME_RIF (XFRAME (frame)))
10659 FRAME_RIF (XFRAME (frame))->flush_display (XFRAME (frame));
10663 return input_pending;
10666 /* This is called in some cases before a possible quit.
10667 It cases the next call to detect_input_pending to recompute input_pending.
10668 So calling this function unnecessarily can't do any harm. */
10670 void
10671 clear_input_pending ()
10673 input_pending = 0;
10676 /* Return nonzero if there are pending requeued events.
10677 This isn't used yet. The hope is to make wait_reading_process_output
10678 call it, and return if it runs Lisp code that unreads something.
10679 The problem is, kbd_buffer_get_event needs to be fixed to know what
10680 to do in that case. It isn't trivial. */
10683 requeued_events_pending_p ()
10685 return (!NILP (Vunread_command_events) || unread_command_char != -1);
10689 DEFUN ("input-pending-p", Finput_pending_p, Sinput_pending_p, 0, 0, 0,
10690 doc: /* Return t if command input is currently available with no wait.
10691 Actually, the value is nil only if we can be sure that no input is available;
10692 if there is a doubt, the value is t. */)
10695 if (!NILP (Vunread_command_events) || unread_command_char != -1
10696 || !NILP (Vunread_post_input_method_events)
10697 || !NILP (Vunread_input_method_events))
10698 return (Qt);
10700 get_input_pending (&input_pending,
10701 READABLE_EVENTS_DO_TIMERS_NOW
10702 | READABLE_EVENTS_FILTER_EVENTS);
10703 return input_pending > 0 ? Qt : Qnil;
10706 DEFUN ("recent-keys", Frecent_keys, Srecent_keys, 0, 0, 0,
10707 doc: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10710 Lisp_Object *keys = XVECTOR (recent_keys)->contents;
10711 Lisp_Object val;
10713 if (total_keys < NUM_RECENT_KEYS)
10714 return Fvector (total_keys, keys);
10715 else
10717 val = Fvector (NUM_RECENT_KEYS, keys);
10718 bcopy (keys + recent_keys_index,
10719 XVECTOR (val)->contents,
10720 (NUM_RECENT_KEYS - recent_keys_index) * sizeof (Lisp_Object));
10721 bcopy (keys,
10722 XVECTOR (val)->contents + NUM_RECENT_KEYS - recent_keys_index,
10723 recent_keys_index * sizeof (Lisp_Object));
10724 return val;
10728 DEFUN ("this-command-keys", Fthis_command_keys, Sthis_command_keys, 0, 0, 0,
10729 doc: /* Return the key sequence that invoked this command.
10730 However, if the command has called `read-key-sequence', it returns
10731 the last key sequence that has been read.
10732 The value is a string or a vector.
10734 See also `this-command-keys-vector'. */)
10737 return make_event_array (this_command_key_count,
10738 XVECTOR (this_command_keys)->contents);
10741 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector, Sthis_command_keys_vector, 0, 0, 0,
10742 doc: /* Return the key sequence that invoked this command, as a vector.
10743 However, if the command has called `read-key-sequence', it returns
10744 the last key sequence that has been read.
10746 See also `this-command-keys'. */)
10749 return Fvector (this_command_key_count,
10750 XVECTOR (this_command_keys)->contents);
10753 DEFUN ("this-single-command-keys", Fthis_single_command_keys,
10754 Sthis_single_command_keys, 0, 0, 0,
10755 doc: /* Return the key sequence that invoked this command.
10756 More generally, it returns the last key sequence read, either by
10757 the command loop or by `read-key-sequence'.
10758 Unlike `this-command-keys', this function's value
10759 does not include prefix arguments.
10760 The value is always a vector. */)
10763 return Fvector (this_command_key_count
10764 - this_single_command_key_start,
10765 (XVECTOR (this_command_keys)->contents
10766 + this_single_command_key_start));
10769 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys,
10770 Sthis_single_command_raw_keys, 0, 0, 0,
10771 doc: /* Return the raw events that were read for this command.
10772 More generally, it returns the last key sequence read, either by
10773 the command loop or by `read-key-sequence'.
10774 Unlike `this-single-command-keys', this function's value
10775 shows the events before all translations (except for input methods).
10776 The value is always a vector. */)
10779 return Fvector (raw_keybuf_count,
10780 (XVECTOR (raw_keybuf)->contents));
10783 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths,
10784 Sreset_this_command_lengths, 0, 0, 0,
10785 doc: /* Make the unread events replace the last command and echo.
10786 Used in `universal-argument-other-key'.
10788 `universal-argument-other-key' rereads the event just typed.
10789 It then gets translated through `function-key-map'.
10790 The translated event has to replace the real events,
10791 both in the value of (this-command-keys) and in echoing.
10792 To achieve this, `universal-argument-other-key' calls
10793 `reset-this-command-lengths', which discards the record of reading
10794 these events the first time. */)
10797 this_command_key_count = before_command_key_count;
10798 if (this_command_key_count < this_single_command_key_start)
10799 this_single_command_key_start = this_command_key_count;
10801 echo_truncate (before_command_echo_length);
10803 /* Cause whatever we put into unread-command-events
10804 to echo as if it were being freshly read from the keyboard. */
10805 this_command_key_count_reset = 1;
10807 return Qnil;
10810 DEFUN ("clear-this-command-keys", Fclear_this_command_keys,
10811 Sclear_this_command_keys, 0, 1, 0,
10812 doc: /* Clear out the vector that `this-command-keys' returns.
10813 Also clear the record of the last 100 events, unless optional arg
10814 KEEP-RECORD is non-nil. */)
10815 (keep_record)
10816 Lisp_Object keep_record;
10818 int i;
10820 this_command_key_count = 0;
10821 this_command_key_count_reset = 0;
10823 if (NILP (keep_record))
10825 for (i = 0; i < XVECTOR (recent_keys)->size; ++i)
10826 XVECTOR (recent_keys)->contents[i] = Qnil;
10827 total_keys = 0;
10828 recent_keys_index = 0;
10830 return Qnil;
10833 DEFUN ("recursion-depth", Frecursion_depth, Srecursion_depth, 0, 0, 0,
10834 doc: /* Return the current depth in recursive edits. */)
10837 Lisp_Object temp;
10838 XSETFASTINT (temp, command_loop_level + minibuf_level);
10839 return temp;
10842 DEFUN ("open-dribble-file", Fopen_dribble_file, Sopen_dribble_file, 1, 1,
10843 "FOpen dribble file: ",
10844 doc: /* Start writing all keyboard characters to a dribble file called FILE.
10845 If FILE is nil, close any open dribble file. */)
10846 (file)
10847 Lisp_Object file;
10849 if (dribble)
10851 BLOCK_INPUT;
10852 fclose (dribble);
10853 UNBLOCK_INPUT;
10854 dribble = 0;
10856 if (!NILP (file))
10858 file = Fexpand_file_name (file, Qnil);
10859 dribble = fopen (SDATA (file), "w");
10860 if (dribble == 0)
10861 report_file_error ("Opening dribble", Fcons (file, Qnil));
10863 return Qnil;
10866 DEFUN ("discard-input", Fdiscard_input, Sdiscard_input, 0, 0, 0,
10867 doc: /* Discard the contents of the terminal input buffer.
10868 Also end any kbd macro being defined. */)
10871 if (!NILP (current_kboard->defining_kbd_macro))
10873 /* Discard the last command from the macro. */
10874 Fcancel_kbd_macro_events ();
10875 end_kbd_macro ();
10878 update_mode_lines++;
10880 Vunread_command_events = Qnil;
10881 unread_command_char = -1;
10883 discard_tty_input ();
10885 kbd_fetch_ptr = kbd_store_ptr;
10886 input_pending = 0;
10888 return Qnil;
10891 DEFUN ("suspend-emacs", Fsuspend_emacs, Ssuspend_emacs, 0, 1, "",
10892 doc: /* Stop Emacs and return to superior process. You can resume later.
10893 If `cannot-suspend' is non-nil, or if the system doesn't support job
10894 control, run a subshell instead.
10896 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10897 to be read as terminal input by Emacs's parent, after suspension.
10899 Before suspending, run the normal hook `suspend-hook'.
10900 After resumption run the normal hook `suspend-resume-hook'.
10902 Some operating systems cannot stop the Emacs process and resume it later.
10903 On such systems, Emacs starts a subshell instead of suspending. */)
10904 (stuffstring)
10905 Lisp_Object stuffstring;
10907 int count = SPECPDL_INDEX ();
10908 int old_height, old_width;
10909 int width, height;
10910 struct gcpro gcpro1;
10912 if (tty_list && tty_list->next)
10913 error ("There are other tty frames open; close them before suspending Emacs");
10915 if (!NILP (stuffstring))
10916 CHECK_STRING (stuffstring);
10918 /* Run the functions in suspend-hook. */
10919 if (!NILP (Vrun_hooks))
10920 call1 (Vrun_hooks, intern ("suspend-hook"));
10922 GCPRO1 (stuffstring);
10923 get_tty_size (fileno (CURTTY ()->input), &old_width, &old_height);
10924 reset_all_sys_modes ();
10925 /* sys_suspend can get an error if it tries to fork a subshell
10926 and the system resources aren't available for that. */
10927 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object))) init_all_sys_modes,
10928 Qnil);
10929 stuff_buffered_input (stuffstring);
10930 if (cannot_suspend)
10931 sys_subshell ();
10932 else
10933 sys_suspend ();
10934 unbind_to (count, Qnil);
10936 /* Check if terminal/window size has changed.
10937 Note that this is not useful when we are running directly
10938 with a window system; but suspend should be disabled in that case. */
10939 get_tty_size (fileno (CURTTY ()->input), &width, &height);
10940 if (width != old_width || height != old_height)
10941 change_frame_size (SELECTED_FRAME (), height, width, 0, 0, 0);
10943 /* Run suspend-resume-hook. */
10944 if (!NILP (Vrun_hooks))
10945 call1 (Vrun_hooks, intern ("suspend-resume-hook"));
10947 UNGCPRO;
10948 return Qnil;
10951 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10952 Then in any case stuff anything Emacs has read ahead and not used. */
10954 void
10955 stuff_buffered_input (stuffstring)
10956 Lisp_Object stuffstring;
10958 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10959 register unsigned char *p;
10961 if (STRINGP (stuffstring))
10963 register int count;
10965 p = SDATA (stuffstring);
10966 count = SBYTES (stuffstring);
10967 while (count-- > 0)
10968 stuff_char (*p++);
10969 stuff_char ('\n');
10972 /* Anything we have read ahead, put back for the shell to read. */
10973 /* ?? What should this do when we have multiple keyboards??
10974 Should we ignore anything that was typed in at the "wrong" kboard?
10976 rms: we should stuff everything back into the kboard
10977 it came from. */
10978 for (; kbd_fetch_ptr != kbd_store_ptr; kbd_fetch_ptr++)
10981 if (kbd_fetch_ptr == kbd_buffer + KBD_BUFFER_SIZE)
10982 kbd_fetch_ptr = kbd_buffer;
10983 if (kbd_fetch_ptr->kind == ASCII_KEYSTROKE_EVENT)
10984 stuff_char (kbd_fetch_ptr->code);
10986 clear_event (kbd_fetch_ptr);
10989 input_pending = 0;
10990 #endif /* SIGTSTP */
10993 void
10994 set_waiting_for_input (time_to_clear)
10995 EMACS_TIME *time_to_clear;
10997 input_available_clear_time = time_to_clear;
10999 /* Tell handle_interrupt to throw back to read_char, */
11000 waiting_for_input = 1;
11002 /* If handle_interrupt was called before and buffered a C-g,
11003 make it run again now, to avoid timing error. */
11004 if (!NILP (Vquit_flag))
11005 quit_throw_to_read_char ();
11008 void
11009 clear_waiting_for_input ()
11011 /* Tell handle_interrupt not to throw back to read_char, */
11012 waiting_for_input = 0;
11013 input_available_clear_time = 0;
11016 /* The SIGINT handler.
11018 If we have a frame on the controlling tty, we assume that the
11019 SIGINT was generated by C-g, so we call handle_interrupt.
11020 Otherwise, the handler kills Emacs. */
11022 static SIGTYPE
11023 interrupt_signal (signalnum) /* If we don't have an argument, */
11024 int signalnum; /* some compilers complain in signal calls. */
11026 /* Must preserve main program's value of errno. */
11027 int old_errno = errno;
11028 struct terminal *terminal;
11030 #if defined (USG) && !defined (POSIX_SIGNALS)
11031 /* USG systems forget handlers when they are used;
11032 must reestablish each time */
11033 signal (SIGINT, interrupt_signal);
11034 signal (SIGQUIT, interrupt_signal);
11035 #endif /* USG */
11037 SIGNAL_THREAD_CHECK (signalnum);
11039 /* See if we have an active terminal on our controlling tty. */
11040 terminal = get_named_tty ("/dev/tty");
11041 if (!terminal)
11043 /* If there are no frames there, let's pretend that we are a
11044 well-behaving UN*X program and quit. */
11045 Fkill_emacs (Qnil);
11047 else
11049 /* Otherwise, the SIGINT was probably generated by C-g. */
11051 /* Set internal_last_event_frame to the top frame of the
11052 controlling tty, if we have a frame there. We disable the
11053 interrupt key on secondary ttys, so the SIGINT must have come
11054 from the controlling tty. */
11055 internal_last_event_frame = terminal->display_info.tty->top_frame;
11057 handle_interrupt ();
11060 errno = old_errno;
11063 /* This routine is called at interrupt level in response to C-g.
11065 It is called from the SIGINT handler or kbd_buffer_store_event.
11067 If `waiting_for_input' is non zero, then unless `echoing' is
11068 nonzero, immediately throw back to read_char.
11070 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
11071 eval to throw, when it gets a chance. If quit-flag is already
11072 non-nil, it stops the job right away. */
11074 static void
11075 handle_interrupt ()
11077 char c;
11079 cancel_echoing ();
11081 /* XXX This code needs to be revised for multi-tty support. */
11082 if (!NILP (Vquit_flag) && get_named_tty ("/dev/tty"))
11084 /* If SIGINT isn't blocked, don't let us be interrupted by
11085 another SIGINT, it might be harmful due to non-reentrancy
11086 in I/O functions. */
11087 sigblock (sigmask (SIGINT));
11089 fflush (stdout);
11090 reset_all_sys_modes ();
11092 #ifdef SIGTSTP /* Support possible in later USG versions */
11094 * On systems which can suspend the current process and return to the original
11095 * shell, this command causes the user to end up back at the shell.
11096 * The "Auto-save" and "Abort" questions are not asked until
11097 * the user elects to return to emacs, at which point he can save the current
11098 * job and either dump core or continue.
11100 sys_suspend ();
11101 #else
11102 /* Perhaps should really fork an inferior shell?
11103 But that would not provide any way to get back
11104 to the original shell, ever. */
11105 printf ("No support for stopping a process on this operating system;\n");
11106 printf ("you can continue or abort.\n");
11107 #endif /* not SIGTSTP */
11108 #ifdef MSDOS
11109 /* We must remain inside the screen area when the internal terminal
11110 is used. Note that [Enter] is not echoed by dos. */
11111 cursor_to (SELECTED_FRAME (), 0, 0);
11112 #endif
11113 /* It doesn't work to autosave while GC is in progress;
11114 the code used for auto-saving doesn't cope with the mark bit. */
11115 if (!gc_in_progress)
11117 printf ("Auto-save? (y or n) ");
11118 fflush (stdout);
11119 if (((c = getchar ()) & ~040) == 'Y')
11121 Fdo_auto_save (Qt, Qnil);
11122 #ifdef MSDOS
11123 printf ("\r\nAuto-save done");
11124 #else /* not MSDOS */
11125 printf ("Auto-save done\n");
11126 #endif /* not MSDOS */
11128 while (c != '\n') c = getchar ();
11130 else
11132 /* During GC, it must be safe to reenable quitting again. */
11133 Vinhibit_quit = Qnil;
11134 #ifdef MSDOS
11135 printf ("\r\n");
11136 #endif /* not MSDOS */
11137 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11138 printf ("but will instead do a real quit after garbage collection ends\r\n");
11139 fflush (stdout);
11142 #ifdef MSDOS
11143 printf ("\r\nAbort? (y or n) ");
11144 #else /* not MSDOS */
11145 printf ("Abort (and dump core)? (y or n) ");
11146 #endif /* not MSDOS */
11147 fflush (stdout);
11148 if (((c = getchar ()) & ~040) == 'Y')
11149 abort ();
11150 while (c != '\n') c = getchar ();
11151 #ifdef MSDOS
11152 printf ("\r\nContinuing...\r\n");
11153 #else /* not MSDOS */
11154 printf ("Continuing...\n");
11155 #endif /* not MSDOS */
11156 fflush (stdout);
11157 init_all_sys_modes ();
11158 sigfree ();
11160 else
11162 /* If executing a function that wants to be interrupted out of
11163 and the user has not deferred quitting by binding `inhibit-quit'
11164 then quit right away. */
11165 if (immediate_quit && NILP (Vinhibit_quit))
11167 struct gl_state_s saved;
11168 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
11170 immediate_quit = 0;
11171 sigfree ();
11172 saved = gl_state;
11173 GCPRO4 (saved.object, saved.global_code,
11174 saved.current_syntax_table, saved.old_prop);
11175 Fsignal (Qquit, Qnil);
11176 gl_state = saved;
11177 UNGCPRO;
11179 else
11180 /* Else request quit when it's safe */
11181 Vquit_flag = Qt;
11184 /* TODO: The longjmp in this call throws the NS event loop integration off,
11185 and it seems to do fine without this. Probably some attention
11186 needs to be paid to the setting of waiting_for_input in
11187 wait_reading_process_output() under HAVE_NS because of the call
11188 to ns_select there (needed because otherwise events aren't picked up
11189 outside of polling since we don't get SIGIO like X and we don't have a
11190 separate event loop thread like W32. */
11191 #ifndef HAVE_NS
11192 if (waiting_for_input && !echoing)
11193 quit_throw_to_read_char ();
11194 #endif
11197 /* Handle a C-g by making read_char return C-g. */
11199 void
11200 quit_throw_to_read_char ()
11202 sigfree ();
11203 /* Prevent another signal from doing this before we finish. */
11204 clear_waiting_for_input ();
11205 input_pending = 0;
11207 Vunread_command_events = Qnil;
11208 unread_command_char = -1;
11210 #if 0 /* Currently, sit_for is called from read_char without turning
11211 off polling. And that can call set_waiting_for_input.
11212 It seems to be harmless. */
11213 #ifdef POLL_FOR_INPUT
11214 /* May be > 1 if in recursive minibuffer. */
11215 if (poll_suppress_count == 0)
11216 abort ();
11217 #endif
11218 #endif
11219 if (FRAMEP (internal_last_event_frame)
11220 && !EQ (internal_last_event_frame, selected_frame))
11221 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame),
11222 0, 0, Qnil);
11224 _longjmp (getcjmp, 1);
11227 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode, Sset_input_interrupt_mode, 1, 1, 0,
11228 doc: /* Set interrupt mode of reading keyboard input.
11229 If INTERRUPT is non-nil, Emacs will use input interrupts;
11230 otherwise Emacs uses CBREAK mode.
11232 See also `current-input-mode'. */)
11233 (interrupt)
11234 Lisp_Object interrupt;
11236 int new_interrupt_input;
11237 #ifdef SIGIO
11238 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11239 #ifdef HAVE_X_WINDOWS
11240 if (x_display_list != NULL)
11242 /* When using X, don't give the user a real choice,
11243 because we haven't implemented the mechanisms to support it. */
11244 #ifdef NO_SOCK_SIGIO
11245 new_interrupt_input = 0;
11246 #else /* not NO_SOCK_SIGIO */
11247 new_interrupt_input = 1;
11248 #endif /* NO_SOCK_SIGIO */
11250 else
11251 #endif /* HAVE_X_WINDOWS */
11252 new_interrupt_input = !NILP (interrupt);
11253 #else /* not SIGIO */
11254 new_interrupt_input = 0;
11255 #endif /* not SIGIO */
11257 if (new_interrupt_input != interrupt_input)
11259 #ifdef POLL_FOR_INPUT
11260 stop_polling ();
11261 #endif
11262 #ifndef DOS_NT
11263 /* this causes startup screen to be restored and messes with the mouse */
11264 reset_all_sys_modes ();
11265 #endif
11266 interrupt_input = new_interrupt_input;
11267 #ifndef DOS_NT
11268 init_all_sys_modes ();
11269 #endif
11271 #ifdef POLL_FOR_INPUT
11272 poll_suppress_count = 1;
11273 start_polling ();
11274 #endif
11276 return Qnil;
11279 DEFUN ("set-output-flow-control", Fset_output_flow_control, Sset_output_flow_control, 1, 2, 0,
11280 doc: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11281 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11282 C-q in key sequences.
11284 This setting only has an effect on tty terminals and only when
11285 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11287 See also `current-input-mode'. */)
11288 (flow, terminal)
11289 Lisp_Object flow, terminal;
11291 struct terminal *t = get_terminal (terminal, 1);
11292 struct tty_display_info *tty;
11293 if (t == NULL || (t->type != output_termcap && t->type != output_msdos_raw))
11294 return Qnil;
11295 tty = t->display_info.tty;
11297 if (tty->flow_control != !NILP (flow))
11299 #ifndef DOS_NT
11300 /* this causes startup screen to be restored and messes with the mouse */
11301 reset_sys_modes (tty);
11302 #endif
11304 tty->flow_control = !NILP (flow);
11306 #ifndef DOS_NT
11307 init_sys_modes (tty);
11308 #endif
11310 return Qnil;
11313 DEFUN ("set-input-meta-mode", Fset_input_meta_mode, Sset_input_meta_mode, 1, 2, 0,
11314 doc: /* Enable or disable 8-bit input on TERMINAL.
11315 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11316 bit as the Meta modifier.
11318 If META is nil, Emacs will ignore the top bit, on the assumption it is
11319 parity.
11321 Otherwise, Emacs will accept and pass through 8-bit input without
11322 specially interpreting the top bit.
11324 This setting only has an effect on tty terminal devices.
11326 Optional parameter TERMINAL specifies the tty terminal device to use.
11327 It may be a terminal id, a frame, or nil for the terminal used by the
11328 currently selected frame.
11330 See also `current-input-mode'. */)
11331 (meta, terminal)
11332 Lisp_Object meta, terminal;
11334 struct terminal *t = get_terminal (terminal, 1);
11335 struct tty_display_info *tty;
11336 int new_meta;
11338 if (t == NULL || (t->type != output_termcap && t->type != output_msdos_raw))
11339 return Qnil;
11340 tty = t->display_info.tty;
11342 if (NILP (meta))
11343 new_meta = 0;
11344 else if (EQ (meta, Qt))
11345 new_meta = 1;
11346 else
11347 new_meta = 2;
11349 if (tty->meta_key != new_meta)
11351 #ifndef DOS_NT
11352 /* this causes startup screen to be restored and messes with the mouse */
11353 reset_sys_modes (tty);
11354 #endif
11356 tty->meta_key = new_meta;
11358 #ifndef DOS_NT
11359 init_sys_modes (tty);
11360 #endif
11362 return Qnil;
11365 DEFUN ("set-quit-char", Fset_quit_char, Sset_quit_char, 1, 1, 0,
11366 doc: /* Specify character used for quitting.
11367 QUIT must be an ASCII character.
11369 This function only has an effect on the controlling tty of the Emacs
11370 process.
11372 See also `current-input-mode'. */)
11373 (quit)
11374 Lisp_Object quit;
11376 struct terminal *t = get_named_tty ("/dev/tty");
11377 struct tty_display_info *tty;
11378 if (t == NULL || (t->type != output_termcap && t->type != output_msdos_raw))
11379 return Qnil;
11380 tty = t->display_info.tty;
11382 if (NILP (quit) || !INTEGERP (quit) || XINT (quit) < 0 || XINT (quit) > 0400)
11383 error ("QUIT must be an ASCII character");
11385 #ifndef DOS_NT
11386 /* this causes startup screen to be restored and messes with the mouse */
11387 reset_sys_modes (tty);
11388 #endif
11390 /* Don't let this value be out of range. */
11391 quit_char = XINT (quit) & (tty->meta_key == 0 ? 0177 : 0377);
11393 #ifndef DOS_NT
11394 init_sys_modes (tty);
11395 #endif
11397 return Qnil;
11400 DEFUN ("set-input-mode", Fset_input_mode, Sset_input_mode, 3, 4, 0,
11401 doc: /* Set mode of reading keyboard input.
11402 First arg INTERRUPT non-nil means use input interrupts;
11403 nil means use CBREAK mode.
11404 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11405 (no effect except in CBREAK mode).
11406 Third arg META t means accept 8-bit input (for a Meta key).
11407 META nil means ignore the top bit, on the assumption it is parity.
11408 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11409 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11410 See also `current-input-mode'. */)
11411 (interrupt, flow, meta, quit)
11412 Lisp_Object interrupt, flow, meta, quit;
11414 Fset_input_interrupt_mode (interrupt);
11415 Fset_output_flow_control (flow, Qnil);
11416 Fset_input_meta_mode (meta, Qnil);
11417 if (!NILP (quit))
11418 Fset_quit_char (quit);
11419 return Qnil;
11422 DEFUN ("current-input-mode", Fcurrent_input_mode, Scurrent_input_mode, 0, 0, 0,
11423 doc: /* Return information about the way Emacs currently reads keyboard input.
11424 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11425 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11426 nil, Emacs is using CBREAK mode.
11427 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11428 terminal; this does not apply if Emacs uses interrupt-driven input.
11429 META is t if accepting 8-bit input with 8th bit as Meta flag.
11430 META nil means ignoring the top bit, on the assumption it is parity.
11431 META is neither t nor nil if accepting 8-bit input and using
11432 all 8 bits as the character code.
11433 QUIT is the character Emacs currently uses to quit.
11434 The elements of this list correspond to the arguments of
11435 `set-input-mode'. */)
11438 Lisp_Object val[4];
11439 struct frame *sf = XFRAME (selected_frame);
11441 val[0] = interrupt_input ? Qt : Qnil;
11442 if (FRAME_TERMCAP_P (sf) || FRAME_MSDOS_P (sf))
11444 val[1] = FRAME_TTY (sf)->flow_control ? Qt : Qnil;
11445 val[2] = (FRAME_TTY (sf)->meta_key == 2
11446 ? make_number (0)
11447 : (CURTTY ()->meta_key == 1 ? Qt : Qnil));
11449 else
11451 val[1] = Qnil;
11452 val[2] = Qt;
11454 XSETFASTINT (val[3], quit_char);
11456 return Flist (sizeof (val) / sizeof (val[0]), val);
11459 DEFUN ("posn-at-x-y", Fposn_at_x_y, Sposn_at_x_y, 2, 4, 0,
11460 doc: /* Return position information for pixel coordinates X and Y.
11461 By default, X and Y are relative to text area of the selected window.
11462 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11463 If optional fourth arg WHOLE is non-nil, X is relative to the left
11464 edge of the window.
11466 The return value is similar to a mouse click position:
11467 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11468 IMAGE (DX . DY) (WIDTH . HEIGHT))
11469 The `posn-' functions access elements of such lists. */)
11470 (x, y, frame_or_window, whole)
11471 Lisp_Object x, y, frame_or_window, whole;
11473 CHECK_NATNUM (x);
11474 CHECK_NATNUM (y);
11476 if (NILP (frame_or_window))
11477 frame_or_window = selected_window;
11479 if (WINDOWP (frame_or_window))
11481 struct window *w;
11483 CHECK_LIVE_WINDOW (frame_or_window);
11485 w = XWINDOW (frame_or_window);
11486 XSETINT (x, (XINT (x)
11487 + WINDOW_LEFT_EDGE_X (w)
11488 + (NILP (whole)
11489 ? window_box_left_offset (w, TEXT_AREA)
11490 : 0)));
11491 XSETINT (y, WINDOW_TO_FRAME_PIXEL_Y (w, XINT (y)));
11492 frame_or_window = w->frame;
11495 CHECK_LIVE_FRAME (frame_or_window);
11497 return make_lispy_position (XFRAME (frame_or_window), &x, &y, 0);
11500 DEFUN ("posn-at-point", Fposn_at_point, Sposn_at_point, 0, 2, 0,
11501 doc: /* Return position information for buffer POS in WINDOW.
11502 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11504 Return nil if position is not visible in window. Otherwise,
11505 the return value is similar to that returned by `event-start' for
11506 a mouse click at the upper left corner of the glyph corresponding
11507 to the given buffer position:
11508 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11509 IMAGE (DX . DY) (WIDTH . HEIGHT))
11510 The `posn-' functions access elements of such lists. */)
11511 (pos, window)
11512 Lisp_Object pos, window;
11514 Lisp_Object tem;
11516 if (NILP (window))
11517 window = selected_window;
11519 tem = Fpos_visible_in_window_p (pos, window, Qt);
11520 if (!NILP (tem))
11522 Lisp_Object x = XCAR (tem);
11523 Lisp_Object y = XCAR (XCDR (tem));
11525 /* Point invisible due to hscrolling? */
11526 if (XINT (x) < 0)
11527 return Qnil;
11528 tem = Fposn_at_x_y (x, y, window, Qnil);
11531 return tem;
11536 * Set up a new kboard object with reasonable initial values.
11538 void
11539 init_kboard (kb)
11540 KBOARD *kb;
11542 kb->Voverriding_terminal_local_map = Qnil;
11543 kb->Vlast_command = Qnil;
11544 kb->Vreal_last_command = Qnil;
11545 kb->Vkeyboard_translate_table = Qnil;
11546 kb->Vlast_repeatable_command = Qnil;
11547 kb->Vprefix_arg = Qnil;
11548 kb->Vlast_prefix_arg = Qnil;
11549 kb->kbd_queue = Qnil;
11550 kb->kbd_queue_has_data = 0;
11551 kb->immediate_echo = 0;
11552 kb->echo_string = Qnil;
11553 kb->echo_after_prompt = -1;
11554 kb->kbd_macro_buffer = 0;
11555 kb->kbd_macro_bufsize = 0;
11556 kb->defining_kbd_macro = Qnil;
11557 kb->Vlast_kbd_macro = Qnil;
11558 kb->reference_count = 0;
11559 kb->Vsystem_key_alist = Qnil;
11560 kb->system_key_syms = Qnil;
11561 kb->Vwindow_system = Qt; /* Unset. */
11562 kb->Vinput_decode_map = Fmake_sparse_keymap (Qnil);
11563 kb->Vlocal_function_key_map = Fmake_sparse_keymap (Qnil);
11564 Fset_keymap_parent (kb->Vlocal_function_key_map, Vfunction_key_map);
11565 kb->Vdefault_minibuffer_frame = Qnil;
11569 * Destroy the contents of a kboard object, but not the object itself.
11570 * We use this just before deleting it, or if we're going to initialize
11571 * it a second time.
11573 static void
11574 wipe_kboard (kb)
11575 KBOARD *kb;
11577 xfree (kb->kbd_macro_buffer);
11580 /* Free KB and memory referenced from it. */
11582 void
11583 delete_kboard (kb)
11584 KBOARD *kb;
11586 KBOARD **kbp;
11588 for (kbp = &all_kboards; *kbp != kb; kbp = &(*kbp)->next_kboard)
11589 if (*kbp == NULL)
11590 abort ();
11591 *kbp = kb->next_kboard;
11593 /* Prevent a dangling reference to KB. */
11594 if (kb == current_kboard
11595 && FRAMEP (selected_frame)
11596 && FRAME_LIVE_P (XFRAME (selected_frame)))
11598 current_kboard = FRAME_KBOARD (XFRAME (selected_frame));
11599 single_kboard = 0;
11600 if (current_kboard == kb)
11601 abort ();
11604 wipe_kboard (kb);
11605 xfree (kb);
11608 void
11609 init_keyboard ()
11611 /* This is correct before outermost invocation of the editor loop */
11612 command_loop_level = -1;
11613 immediate_quit = 0;
11614 quit_char = Ctl ('g');
11615 Vunread_command_events = Qnil;
11616 unread_command_char = -1;
11617 EMACS_SET_SECS_USECS (timer_idleness_start_time, -1, -1);
11618 total_keys = 0;
11619 recent_keys_index = 0;
11620 kbd_fetch_ptr = kbd_buffer;
11621 kbd_store_ptr = kbd_buffer;
11622 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11623 do_mouse_tracking = Qnil;
11624 #endif
11625 input_pending = 0;
11626 interrupt_input_blocked = 0;
11627 interrupt_input_pending = 0;
11628 #ifdef SYNC_INPUT
11629 pending_signals = 0;
11630 #endif
11632 /* This means that command_loop_1 won't try to select anything the first
11633 time through. */
11634 internal_last_event_frame = Qnil;
11635 Vlast_event_frame = internal_last_event_frame;
11637 current_kboard = initial_kboard;
11638 /* Re-initialize the keyboard again. */
11639 wipe_kboard (current_kboard);
11640 init_kboard (current_kboard);
11641 /* A value of nil for Vwindow_system normally means a tty, but we also use
11642 it for the initial terminal since there is no window system there. */
11643 current_kboard->Vwindow_system = Qnil;
11645 if (!noninteractive)
11647 /* Before multi-tty support, these handlers used to be installed
11648 only if the current session was a tty session. Now an Emacs
11649 session may have multiple display types, so we always handle
11650 SIGINT. There is special code in interrupt_signal to exit
11651 Emacs on SIGINT when there are no termcap frames on the
11652 controlling terminal. */
11653 signal (SIGINT, interrupt_signal);
11654 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11655 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11656 SIGQUIT and we can't tell which one it will give us. */
11657 signal (SIGQUIT, interrupt_signal);
11658 #endif /* HAVE_TERMIO */
11660 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11661 #ifdef SIGIO
11662 if (!noninteractive)
11663 signal (SIGIO, input_available_signal);
11664 #endif /* SIGIO */
11666 /* Use interrupt input by default, if it works and noninterrupt input
11667 has deficiencies. */
11669 #ifdef INTERRUPT_INPUT
11670 interrupt_input = 1;
11671 #else
11672 interrupt_input = 0;
11673 #endif
11675 sigfree ();
11676 dribble = 0;
11678 if (keyboard_init_hook)
11679 (*keyboard_init_hook) ();
11681 #ifdef POLL_FOR_INPUT
11682 poll_suppress_count = 1;
11683 start_polling ();
11684 #endif
11687 /* This type's only use is in syms_of_keyboard, to initialize the
11688 event header symbols and put properties on them. */
11689 struct event_head {
11690 Lisp_Object *var;
11691 char *name;
11692 Lisp_Object *kind;
11695 struct event_head head_table[] = {
11696 {&Qmouse_movement, "mouse-movement", &Qmouse_movement},
11697 {&Qscroll_bar_movement, "scroll-bar-movement", &Qmouse_movement},
11698 {&Qswitch_frame, "switch-frame", &Qswitch_frame},
11699 {&Qdelete_frame, "delete-frame", &Qdelete_frame},
11700 {&Qiconify_frame, "iconify-frame", &Qiconify_frame},
11701 {&Qmake_frame_visible, "make-frame-visible", &Qmake_frame_visible},
11702 /* `select-window' should be handled just like `switch-frame'
11703 in read_key_sequence. */
11704 {&Qselect_window, "select-window", &Qswitch_frame}
11707 void
11708 syms_of_keyboard ()
11710 pending_funcalls = Qnil;
11712 Vlispy_mouse_stem = build_string ("mouse");
11713 staticpro (&Vlispy_mouse_stem);
11715 /* Tool-bars. */
11716 QCimage = intern (":image");
11717 staticpro (&QCimage);
11719 staticpro (&Qhelp_echo);
11720 Qhelp_echo = intern ("help-echo");
11722 staticpro (&Qrtl);
11723 Qrtl = intern (":rtl");
11725 staticpro (&item_properties);
11726 item_properties = Qnil;
11728 staticpro (&tool_bar_item_properties);
11729 tool_bar_item_properties = Qnil;
11730 staticpro (&tool_bar_items_vector);
11731 tool_bar_items_vector = Qnil;
11733 staticpro (&real_this_command);
11734 real_this_command = Qnil;
11736 Qtimer_event_handler = intern ("timer-event-handler");
11737 staticpro (&Qtimer_event_handler);
11739 Qdisabled_command_function = intern ("disabled-command-function");
11740 staticpro (&Qdisabled_command_function);
11742 Qself_insert_command = intern ("self-insert-command");
11743 staticpro (&Qself_insert_command);
11745 Qforward_char = intern ("forward-char");
11746 staticpro (&Qforward_char);
11748 Qbackward_char = intern ("backward-char");
11749 staticpro (&Qbackward_char);
11751 Qdisabled = intern ("disabled");
11752 staticpro (&Qdisabled);
11754 Qundefined = intern ("undefined");
11755 staticpro (&Qundefined);
11757 Qpre_command_hook = intern ("pre-command-hook");
11758 staticpro (&Qpre_command_hook);
11760 Qpost_command_hook = intern ("post-command-hook");
11761 staticpro (&Qpost_command_hook);
11763 Qdeferred_action_function = intern ("deferred-action-function");
11764 staticpro (&Qdeferred_action_function);
11766 Qcommand_hook_internal = intern ("command-hook-internal");
11767 staticpro (&Qcommand_hook_internal);
11769 Qfunction_key = intern ("function-key");
11770 staticpro (&Qfunction_key);
11771 Qmouse_click = intern ("mouse-click");
11772 staticpro (&Qmouse_click);
11773 #if defined (WINDOWSNT)
11774 Qlanguage_change = intern ("language-change");
11775 staticpro (&Qlanguage_change);
11776 #endif
11777 Qdrag_n_drop = intern ("drag-n-drop");
11778 staticpro (&Qdrag_n_drop);
11780 Qsave_session = intern ("save-session");
11781 staticpro (&Qsave_session);
11783 #ifdef HAVE_DBUS
11784 Qdbus_event = intern ("dbus-event");
11785 staticpro (&Qdbus_event);
11786 #endif
11788 Qmenu_enable = intern ("menu-enable");
11789 staticpro (&Qmenu_enable);
11790 Qmenu_alias = intern ("menu-alias");
11791 staticpro (&Qmenu_alias);
11792 QCenable = intern (":enable");
11793 staticpro (&QCenable);
11794 QCvisible = intern (":visible");
11795 staticpro (&QCvisible);
11796 QChelp = intern (":help");
11797 staticpro (&QChelp);
11798 QCfilter = intern (":filter");
11799 staticpro (&QCfilter);
11800 QCbutton = intern (":button");
11801 staticpro (&QCbutton);
11802 QCkeys = intern (":keys");
11803 staticpro (&QCkeys);
11804 QCkey_sequence = intern (":key-sequence");
11805 staticpro (&QCkey_sequence);
11806 QCtoggle = intern (":toggle");
11807 staticpro (&QCtoggle);
11808 QCradio = intern (":radio");
11809 staticpro (&QCradio);
11811 Qmode_line = intern ("mode-line");
11812 staticpro (&Qmode_line);
11813 Qvertical_line = intern ("vertical-line");
11814 staticpro (&Qvertical_line);
11815 Qvertical_scroll_bar = intern ("vertical-scroll-bar");
11816 staticpro (&Qvertical_scroll_bar);
11817 Qmenu_bar = intern ("menu-bar");
11818 staticpro (&Qmenu_bar);
11820 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11821 Qmouse_fixup_help_message = intern ("mouse-fixup-help-message");
11822 staticpro (&Qmouse_fixup_help_message);
11823 #endif
11825 Qabove_handle = intern ("above-handle");
11826 staticpro (&Qabove_handle);
11827 Qhandle = intern ("handle");
11828 staticpro (&Qhandle);
11829 Qbelow_handle = intern ("below-handle");
11830 staticpro (&Qbelow_handle);
11831 Qup = intern ("up");
11832 staticpro (&Qup);
11833 Qdown = intern ("down");
11834 staticpro (&Qdown);
11835 Qtop = intern ("top");
11836 staticpro (&Qtop);
11837 Qbottom = intern ("bottom");
11838 staticpro (&Qbottom);
11839 Qend_scroll = intern ("end-scroll");
11840 staticpro (&Qend_scroll);
11841 Qratio = intern ("ratio");
11842 staticpro (&Qratio);
11844 Qevent_kind = intern ("event-kind");
11845 staticpro (&Qevent_kind);
11846 Qevent_symbol_elements = intern ("event-symbol-elements");
11847 staticpro (&Qevent_symbol_elements);
11848 Qevent_symbol_element_mask = intern ("event-symbol-element-mask");
11849 staticpro (&Qevent_symbol_element_mask);
11850 Qmodifier_cache = intern ("modifier-cache");
11851 staticpro (&Qmodifier_cache);
11853 Qrecompute_lucid_menubar = intern ("recompute-lucid-menubar");
11854 staticpro (&Qrecompute_lucid_menubar);
11855 Qactivate_menubar_hook = intern ("activate-menubar-hook");
11856 staticpro (&Qactivate_menubar_hook);
11858 Qpolling_period = intern ("polling-period");
11859 staticpro (&Qpolling_period);
11861 Qinput_method_function = intern ("input-method-function");
11862 staticpro (&Qinput_method_function);
11864 Qinput_method_exit_on_first_char = intern ("input-method-exit-on-first-char");
11865 staticpro (&Qinput_method_exit_on_first_char);
11866 Qinput_method_use_echo_area = intern ("input-method-use-echo-area");
11867 staticpro (&Qinput_method_use_echo_area);
11869 Fset (Qinput_method_exit_on_first_char, Qnil);
11870 Fset (Qinput_method_use_echo_area, Qnil);
11872 last_point_position_buffer = Qnil;
11873 last_point_position_window = Qnil;
11876 struct event_head *p;
11878 for (p = head_table;
11879 p < head_table + (sizeof (head_table) / sizeof (head_table[0]));
11880 p++)
11882 *p->var = intern (p->name);
11883 staticpro (p->var);
11884 Fput (*p->var, Qevent_kind, *p->kind);
11885 Fput (*p->var, Qevent_symbol_elements, Fcons (*p->var, Qnil));
11889 button_down_location = Fmake_vector (make_number (1), Qnil);
11890 staticpro (&button_down_location);
11891 mouse_syms = Fmake_vector (make_number (1), Qnil);
11892 staticpro (&mouse_syms);
11893 wheel_syms = Fmake_vector (make_number (4), Qnil);
11894 staticpro (&wheel_syms);
11897 int i;
11898 int len = sizeof (modifier_names) / sizeof (modifier_names[0]);
11900 modifier_symbols = Fmake_vector (make_number (len), Qnil);
11901 for (i = 0; i < len; i++)
11902 if (modifier_names[i])
11903 XVECTOR (modifier_symbols)->contents[i] = intern (modifier_names[i]);
11904 staticpro (&modifier_symbols);
11907 recent_keys = Fmake_vector (make_number (NUM_RECENT_KEYS), Qnil);
11908 staticpro (&recent_keys);
11910 this_command_keys = Fmake_vector (make_number (40), Qnil);
11911 staticpro (&this_command_keys);
11913 raw_keybuf = Fmake_vector (make_number (30), Qnil);
11914 staticpro (&raw_keybuf);
11916 Qextended_command_history = intern ("extended-command-history");
11917 Fset (Qextended_command_history, Qnil);
11918 staticpro (&Qextended_command_history);
11920 accent_key_syms = Qnil;
11921 staticpro (&accent_key_syms);
11923 func_key_syms = Qnil;
11924 staticpro (&func_key_syms);
11926 drag_n_drop_syms = Qnil;
11927 staticpro (&drag_n_drop_syms);
11929 unread_switch_frame = Qnil;
11930 staticpro (&unread_switch_frame);
11932 internal_last_event_frame = Qnil;
11933 staticpro (&internal_last_event_frame);
11935 read_key_sequence_cmd = Qnil;
11936 staticpro (&read_key_sequence_cmd);
11938 menu_bar_one_keymap_changed_items = Qnil;
11939 staticpro (&menu_bar_one_keymap_changed_items);
11941 menu_bar_items_vector = Qnil;
11942 staticpro (&menu_bar_items_vector);
11944 help_form_saved_window_configs = Qnil;
11945 staticpro (&help_form_saved_window_configs);
11947 defsubr (&Scurrent_idle_time);
11948 defsubr (&Sevent_symbol_parse_modifiers);
11949 defsubr (&Sevent_convert_list);
11950 defsubr (&Sread_key_sequence);
11951 defsubr (&Sread_key_sequence_vector);
11952 defsubr (&Srecursive_edit);
11953 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11954 defsubr (&Strack_mouse);
11955 #endif
11956 defsubr (&Sinput_pending_p);
11957 defsubr (&Scommand_execute);
11958 defsubr (&Srecent_keys);
11959 defsubr (&Sthis_command_keys);
11960 defsubr (&Sthis_command_keys_vector);
11961 defsubr (&Sthis_single_command_keys);
11962 defsubr (&Sthis_single_command_raw_keys);
11963 defsubr (&Sreset_this_command_lengths);
11964 defsubr (&Sclear_this_command_keys);
11965 defsubr (&Ssuspend_emacs);
11966 defsubr (&Sabort_recursive_edit);
11967 defsubr (&Sexit_recursive_edit);
11968 defsubr (&Srecursion_depth);
11969 defsubr (&Stop_level);
11970 defsubr (&Sdiscard_input);
11971 defsubr (&Sopen_dribble_file);
11972 defsubr (&Sset_input_interrupt_mode);
11973 defsubr (&Sset_output_flow_control);
11974 defsubr (&Sset_input_meta_mode);
11975 defsubr (&Sset_quit_char);
11976 defsubr (&Sset_input_mode);
11977 defsubr (&Scurrent_input_mode);
11978 defsubr (&Sexecute_extended_command);
11979 defsubr (&Sposn_at_point);
11980 defsubr (&Sposn_at_x_y);
11982 DEFVAR_LISP ("last-command-event", &last_command_event,
11983 doc: /* Last input event that was part of a command. */);
11985 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event,
11986 doc: /* Last input event in a command, except for mouse menu events.
11987 Mouse menus give back keys that don't look like mouse events;
11988 this variable holds the actual mouse event that led to the menu,
11989 so that you can determine whether the command was run by mouse or not. */);
11991 DEFVAR_LISP ("last-input-event", &last_input_event,
11992 doc: /* Last input event. */);
11994 DEFVAR_LISP ("unread-command-events", &Vunread_command_events,
11995 doc: /* List of events to be read as the command input.
11996 These events are processed first, before actual keyboard input.
11997 Events read from this list are not normally added to `this-command-keys',
11998 as they will already have been added once as they were read for the first time.
11999 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
12000 Vunread_command_events = Qnil;
12002 DEFVAR_INT ("unread-command-char", &unread_command_char,
12003 doc: /* If not -1, an object to be read as next command input event. */);
12005 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events,
12006 doc: /* List of events to be processed as input by input methods.
12007 These events are processed before `unread-command-events'
12008 and actual keyboard input, but are not given to `input-method-function'. */);
12009 Vunread_post_input_method_events = Qnil;
12011 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events,
12012 doc: /* List of events to be processed as input by input methods.
12013 These events are processed after `unread-command-events', but
12014 before actual keyboard input.
12015 If there's an active input method, the events are given to
12016 `input-method-function'. */);
12017 Vunread_input_method_events = Qnil;
12019 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char,
12020 doc: /* Meta-prefix character code.
12021 Meta-foo as command input turns into this character followed by foo. */);
12022 XSETINT (meta_prefix_char, 033);
12024 DEFVAR_KBOARD ("last-command", Vlast_command,
12025 doc: /* The last command executed.
12026 Normally a symbol with a function definition, but can be whatever was found
12027 in the keymap, or whatever the variable `this-command' was set to by that
12028 command.
12030 The value `mode-exit' is special; it means that the previous command
12031 read an event that told it to exit, and it did so and unread that event.
12032 In other words, the present command is the event that made the previous
12033 command exit.
12035 The value `kill-region' is special; it means that the previous command
12036 was a kill command.
12038 `last-command' has a separate binding for each terminal device.
12039 See Info node `(elisp)Multiple displays'. */);
12041 DEFVAR_KBOARD ("real-last-command", Vreal_last_command,
12042 doc: /* Same as `last-command', but never altered by Lisp code. */);
12044 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command,
12045 doc: /* Last command that may be repeated.
12046 The last command executed that was not bound to an input event.
12047 This is the command `repeat' will try to repeat. */);
12049 DEFVAR_LISP ("this-command", &Vthis_command,
12050 doc: /* The command now being executed.
12051 The command can set this variable; whatever is put here
12052 will be in `last-command' during the following command. */);
12053 Vthis_command = Qnil;
12055 DEFVAR_LISP ("this-command-keys-shift-translated",
12056 &Vthis_command_keys_shift_translated,
12057 doc: /* Non-nil if the key sequence activating this command was shift-translated.
12058 Shift-translation occurs when there is no binding for the key sequence
12059 as entered, but a binding was found by changing an upper-case letter
12060 to lower-case, or a shifted function key to an unshifted one. */);
12061 Vthis_command_keys_shift_translated = Qnil;
12063 DEFVAR_LISP ("this-original-command", &Vthis_original_command,
12064 doc: /* The command bound to the current key sequence before remapping.
12065 It equals `this-command' if the original command was not remapped through
12066 any of the active keymaps. Otherwise, the value of `this-command' is the
12067 result of looking up the original command in the active keymaps. */);
12068 Vthis_original_command = Qnil;
12070 DEFVAR_INT ("auto-save-interval", &auto_save_interval,
12071 doc: /* *Number of input events between auto-saves.
12072 Zero means disable autosaving due to number of characters typed. */);
12073 auto_save_interval = 300;
12075 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout,
12076 doc: /* *Number of seconds idle time before auto-save.
12077 Zero or nil means disable auto-saving due to idleness.
12078 After auto-saving due to this many seconds of idle time,
12079 Emacs also does a garbage collection if that seems to be warranted. */);
12080 XSETFASTINT (Vauto_save_timeout, 30);
12082 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes,
12083 doc: /* *Nonzero means echo unfinished commands after this many seconds of pause.
12084 The value may be integer or floating point. */);
12085 Vecho_keystrokes = make_number (1);
12087 DEFVAR_INT ("polling-period", &polling_period,
12088 doc: /* *Interval between polling for input during Lisp execution.
12089 The reason for polling is to make C-g work to stop a running program.
12090 Polling is needed only when using X windows and SIGIO does not work.
12091 Polling is automatically disabled in all other cases. */);
12092 polling_period = 2;
12094 DEFVAR_LISP ("double-click-time", &Vdouble_click_time,
12095 doc: /* *Maximum time between mouse clicks to make a double-click.
12096 Measured in milliseconds. The value nil means disable double-click
12097 recognition; t means double-clicks have no time limit and are detected
12098 by position only. */);
12099 Vdouble_click_time = make_number (500);
12101 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz,
12102 doc: /* *Maximum mouse movement between clicks to make a double-click.
12103 On window-system frames, value is the number of pixels the mouse may have
12104 moved horizontally or vertically between two clicks to make a double-click.
12105 On non window-system frames, value is interpreted in units of 1/8 characters
12106 instead of pixels.
12108 This variable is also the threshold for motion of the mouse
12109 to count as a drag. */);
12110 double_click_fuzz = 3;
12112 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus,
12113 doc: /* *Non-nil means inhibit local map menu bar menus. */);
12114 inhibit_local_menu_bar_menus = 0;
12116 DEFVAR_INT ("num-input-keys", &num_input_keys,
12117 doc: /* Number of complete key sequences read as input so far.
12118 This includes key sequences read from keyboard macros.
12119 The number is effectively the number of interactive command invocations. */);
12120 num_input_keys = 0;
12122 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events,
12123 doc: /* Number of input events read from the keyboard so far.
12124 This does not include events generated by keyboard macros. */);
12125 num_nonmacro_input_events = 0;
12127 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame,
12128 doc: /* The frame in which the most recently read event occurred.
12129 If the last event came from a keyboard macro, this is set to `macro'. */);
12130 Vlast_event_frame = Qnil;
12132 /* This variable is set up in sysdep.c. */
12133 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char,
12134 doc: /* The ERASE character as set by the user with stty. */);
12136 DEFVAR_LISP ("help-char", &Vhelp_char,
12137 doc: /* Character to recognize as meaning Help.
12138 When it is read, do `(eval help-form)', and display result if it's a string.
12139 If the value of `help-form' is nil, this char can be read normally. */);
12140 XSETINT (Vhelp_char, Ctl ('H'));
12142 DEFVAR_LISP ("help-event-list", &Vhelp_event_list,
12143 doc: /* List of input events to recognize as meaning Help.
12144 These work just like the value of `help-char' (see that). */);
12145 Vhelp_event_list = Qnil;
12147 DEFVAR_LISP ("help-form", &Vhelp_form,
12148 doc: /* Form to execute when character `help-char' is read.
12149 If the form returns a string, that string is displayed.
12150 If `help-form' is nil, the help char is not recognized. */);
12151 Vhelp_form = Qnil;
12153 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command,
12154 doc: /* Command to run when `help-char' character follows a prefix key.
12155 This command is used only when there is no actual binding
12156 for that character after that prefix key. */);
12157 Vprefix_help_command = Qnil;
12159 DEFVAR_LISP ("top-level", &Vtop_level,
12160 doc: /* Form to evaluate when Emacs starts up.
12161 Useful to set before you dump a modified Emacs. */);
12162 Vtop_level = Qnil;
12164 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table,
12165 doc: /* Translate table for local keyboard input, or nil.
12166 If non-nil, the value should be a char-table. Each character read
12167 from the keyboard is looked up in this char-table. If the value found
12168 there is non-nil, then it is used instead of the actual input character.
12170 The value can also be a string or vector, but this is considered obsolete.
12171 If it is a string or vector of length N, character codes N and up are left
12172 untranslated. In a vector, an element which is nil means "no translation".
12174 This is applied to the characters supplied to input methods, not their
12175 output. See also `translation-table-for-input'.
12177 This variable has a separate binding for each terminal. See Info node
12178 `(elisp)Multiple displays'. */);
12180 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend,
12181 doc: /* Non-nil means to always spawn a subshell instead of suspending.
12182 \(Even if the operating system has support for stopping a process.\) */);
12183 cannot_suspend = 0;
12185 DEFVAR_BOOL ("menu-prompting", &menu_prompting,
12186 doc: /* Non-nil means prompt with menus when appropriate.
12187 This is done when reading from a keymap that has a prompt string,
12188 for elements that have prompt strings.
12189 The menu is displayed on the screen
12190 if X menus were enabled at configuration
12191 time and the previous event was a mouse click prefix key.
12192 Otherwise, menu prompting uses the echo area. */);
12193 menu_prompting = 1;
12195 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char,
12196 doc: /* Character to see next line of menu prompt.
12197 Type this character while in a menu prompt to rotate around the lines of it. */);
12198 XSETINT (menu_prompt_more_char, ' ');
12200 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers,
12201 doc: /* A mask of additional modifier keys to use with every keyboard character.
12202 Emacs applies the modifiers of the character stored here to each keyboard
12203 character it reads. For example, after evaluating the expression
12204 (setq extra-keyboard-modifiers ?\\C-x)
12205 all input characters will have the control modifier applied to them.
12207 Note that the character ?\\C-@, equivalent to the integer zero, does
12208 not count as a control character; rather, it counts as a character
12209 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12210 cancels any modification. */);
12211 extra_keyboard_modifiers = 0;
12213 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark,
12214 doc: /* If an editing command sets this to t, deactivate the mark afterward.
12215 The command loop sets this to nil before each command,
12216 and tests the value when the command returns.
12217 Buffer modification stores t in this variable. */);
12218 Vdeactivate_mark = Qnil;
12219 Qdeactivate_mark = intern ("deactivate-mark");
12220 staticpro (&Qdeactivate_mark);
12222 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal,
12223 doc: /* Temporary storage of `pre-command-hook' or `post-command-hook'. */);
12224 Vcommand_hook_internal = Qnil;
12226 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook,
12227 doc: /* Normal hook run before each command is executed.
12228 If an unhandled error happens in running this hook,
12229 the hook value is set to nil, since otherwise the error
12230 might happen repeatedly and make Emacs nonfunctional. */);
12231 Vpre_command_hook = Qnil;
12233 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook,
12234 doc: /* Normal hook run after each command is executed.
12235 If an unhandled error happens in running this hook,
12236 the hook value is set to nil, since otherwise the error
12237 might happen repeatedly and make Emacs nonfunctional. */);
12238 Vpost_command_hook = Qnil;
12240 #if 0
12241 DEFVAR_LISP ("echo-area-clear-hook", ...,
12242 doc: /* Normal hook run when clearing the echo area. */);
12243 #endif
12244 Qecho_area_clear_hook = intern ("echo-area-clear-hook");
12245 staticpro (&Qecho_area_clear_hook);
12246 SET_SYMBOL_VALUE (Qecho_area_clear_hook, Qnil);
12248 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag,
12249 doc: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12250 Vlucid_menu_bar_dirty_flag = Qnil;
12252 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items,
12253 doc: /* List of menu bar items to move to the end of the menu bar.
12254 The elements of the list are event types that may have menu bar bindings. */);
12255 Vmenu_bar_final_items = Qnil;
12257 DEFVAR_KBOARD ("overriding-terminal-local-map",
12258 Voverriding_terminal_local_map,
12259 doc: /* Per-terminal keymap that overrides all other local keymaps.
12260 If this variable is non-nil, it is used as a keymap instead of the
12261 buffer's local map, and the minor mode keymaps and text property keymaps.
12262 It also replaces `overriding-local-map'.
12264 This variable is intended to let commands such as `universal-argument'
12265 set up a different keymap for reading the next command.
12267 `overriding-terminal-local-map' has a separate binding for each
12268 terminal device.
12269 See Info node `(elisp)Multiple displays'. */);
12271 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map,
12272 doc: /* Keymap that overrides all other local keymaps.
12273 If this variable is non-nil, it is used as a keymap--replacing the
12274 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12275 Voverriding_local_map = Qnil;
12277 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag,
12278 doc: /* Non-nil means `overriding-local-map' applies to the menu bar.
12279 Otherwise, the menu bar continues to reflect the buffer's local map
12280 and the minor mode maps regardless of `overriding-local-map'. */);
12281 Voverriding_local_map_menu_flag = Qnil;
12283 DEFVAR_LISP ("special-event-map", &Vspecial_event_map,
12284 doc: /* Keymap defining bindings for special events to execute at low level. */);
12285 Vspecial_event_map = Fcons (intern ("keymap"), Qnil);
12287 DEFVAR_LISP ("track-mouse", &do_mouse_tracking,
12288 doc: /* *Non-nil means generate motion events for mouse motion. */);
12290 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist,
12291 doc: /* Alist of system-specific X windows key symbols.
12292 Each element should have the form (N . SYMBOL) where N is the
12293 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12294 and SYMBOL is its name.
12296 `system-key-alist' has a separate binding for each terminal device.
12297 See Info node `(elisp)Multiple displays'. */);
12299 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map,
12300 doc: /* Keymap that translates key sequences to key sequences during input.
12301 This is used mainly for mapping key sequences into some preferred
12302 key events (symbols).
12304 The `read-key-sequence' function replaces any subsequence bound by
12305 `local-function-key-map' with its binding. More precisely, when the
12306 active keymaps have no binding for the current key sequence but
12307 `local-function-key-map' binds a suffix of the sequence to a vector or
12308 string, `read-key-sequence' replaces the matching suffix with its
12309 binding, and continues with the new sequence.
12311 If the binding is a function, it is called with one argument (the prompt)
12312 and its return value (a key sequence) is used.
12314 The events that come from bindings in `local-function-key-map' are not
12315 themselves looked up in `local-function-key-map'.
12317 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12318 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12319 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12320 typing `ESC O P x' would return [f1 x].
12322 `local-function-key-map' has a separate binding for each terminal
12323 device. See Info node `(elisp)Multiple displays'. If you need to
12324 define a binding on all terminals, change `function-key-map'
12325 instead. Initially, `local-function-key-map' is an empty keymap that
12326 has `function-key-map' as its parent on all terminal devices. */);
12328 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map,
12329 doc: /* Keymap that decodes input escape sequences.
12330 This is used mainly for mapping ASCII function key sequences into
12331 real Emacs function key events (symbols).
12333 The `read-key-sequence' function replaces any subsequence bound by
12334 `input-key-map' with its binding. Contrary to `function-key-map',
12335 this map applies its rebinding regardless of the presence of an ordinary
12336 binding. So it is more like `key-translation-map' except that it applies
12337 before `function-key-map' rather than after.
12339 If the binding is a function, it is called with one argument (the prompt)
12340 and its return value (a key sequence) is used.
12342 The events that come from bindings in `input-decode-map' are not
12343 themselves looked up in `input-decode-map'.
12345 This variable is keyboard-local. */);
12347 DEFVAR_LISP ("function-key-map", &Vfunction_key_map,
12348 doc: /* The parent keymap of all `local-function-key-map' instances.
12349 Function key definitions that apply to all terminal devices should go
12350 here. If a mapping is defined in both the current
12351 `local-function-key-map' binding and this variable, then the local
12352 definition will take precendence. */);
12353 Vfunction_key_map = Fmake_sparse_keymap (Qnil);
12355 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map,
12356 doc: /* Keymap of key translations that can override keymaps.
12357 This keymap works like `function-key-map', but comes after that,
12358 and its non-prefix bindings override ordinary bindings.
12359 Another difference is that it is global rather than keyboard-local. */);
12360 Vkey_translation_map = Fmake_sparse_keymap (Qnil);
12362 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list,
12363 doc: /* List of deferred actions to be performed at a later time.
12364 The precise format isn't relevant here; we just check whether it is nil. */);
12365 Vdeferred_action_list = Qnil;
12367 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function,
12368 doc: /* Function to call to handle deferred actions, after each command.
12369 This function is called with no arguments after each command
12370 whenever `deferred-action-list' is non-nil. */);
12371 Vdeferred_action_function = Qnil;
12373 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings,
12374 doc: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12375 The value can be a length of time to show the message for.
12376 If the value is non-nil and not a number, we wait 2 seconds. */);
12377 Vsuggest_key_bindings = Qt;
12379 DEFVAR_LISP ("timer-list", &Vtimer_list,
12380 doc: /* List of active absolute time timers in order of increasing time. */);
12381 Vtimer_list = Qnil;
12383 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list,
12384 doc: /* List of active idle-time timers in order of increasing time. */);
12385 Vtimer_idle_list = Qnil;
12387 DEFVAR_LISP ("input-method-function", &Vinput_method_function,
12388 doc: /* If non-nil, the function that implements the current input method.
12389 It's called with one argument, a printing character that was just read.
12390 \(That means a character with code 040...0176.)
12391 Typically this function uses `read-event' to read additional events.
12392 When it does so, it should first bind `input-method-function' to nil
12393 so it will not be called recursively.
12395 The function should return a list of zero or more events
12396 to be used as input. If it wants to put back some events
12397 to be reconsidered, separately, by the input method,
12398 it can add them to the beginning of `unread-command-events'.
12400 The input method function can find in `input-method-previous-message'
12401 the previous echo area message.
12403 The input method function should refer to the variables
12404 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12405 for guidance on what to do. */);
12406 Vinput_method_function = Qnil;
12408 DEFVAR_LISP ("input-method-previous-message",
12409 &Vinput_method_previous_message,
12410 doc: /* When `input-method-function' is called, hold the previous echo area message.
12411 This variable exists because `read-event' clears the echo area
12412 before running the input method. It is nil if there was no message. */);
12413 Vinput_method_previous_message = Qnil;
12415 DEFVAR_LISP ("show-help-function", &Vshow_help_function,
12416 doc: /* If non-nil, the function that implements the display of help.
12417 It's called with one argument, the help string to display. */);
12418 Vshow_help_function = Qnil;
12420 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment,
12421 doc: /* If non-nil, suppress point adjustment after executing a command.
12423 After a command is executed, if point is moved into a region that has
12424 special properties (e.g. composition, display), we adjust point to
12425 the boundary of the region. But, when a command sets this variable to
12426 non-nil, we suppress the point adjustment.
12428 This variable is set to nil before reading a command, and is checked
12429 just after executing the command. */);
12430 Vdisable_point_adjustment = Qnil;
12432 DEFVAR_LISP ("global-disable-point-adjustment",
12433 &Vglobal_disable_point_adjustment,
12434 doc: /* *If non-nil, always suppress point adjustment.
12436 The default value is nil, in which case, point adjustment are
12437 suppressed only after special commands that set
12438 `disable-point-adjustment' (which see) to non-nil. */);
12439 Vglobal_disable_point_adjustment = Qnil;
12441 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout,
12442 doc: /* *How long to display an echo-area message when the minibuffer is active.
12443 If the value is not a number, such messages don't time out. */);
12444 Vminibuffer_message_timeout = make_number (2);
12446 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input,
12447 doc: /* If non-nil, any keyboard input throws to this symbol.
12448 The value of that variable is passed to `quit-flag' and later causes a
12449 peculiar kind of quitting. */);
12450 Vthrow_on_input = Qnil;
12452 DEFVAR_LISP ("command-error-function", &Vcommand_error_function,
12453 doc: /* If non-nil, function to output error messages.
12454 The arguments are the error data, a list of the form
12455 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12456 such as just as `condition-case' would bind its variable to,
12457 the context (a string which normally goes at the start of the message),
12458 and the Lisp function within which the error was signaled. */);
12459 Vcommand_error_function = Qnil;
12461 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12462 &Venable_disabled_menus_and_buttons,
12463 doc: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12465 Help functions bind this to allow help on disabled menu items
12466 and tool-bar buttons. */);
12467 Venable_disabled_menus_and_buttons = Qnil;
12469 /* Create the initial keyboard. */
12470 initial_kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
12471 init_kboard (initial_kboard);
12472 /* Vwindow_system is left at t for now. */
12473 initial_kboard->next_kboard = all_kboards;
12474 all_kboards = initial_kboard;
12477 void
12478 keys_of_keyboard ()
12480 initial_define_key (global_map, Ctl ('Z'), "suspend-emacs");
12481 initial_define_key (control_x_map, Ctl ('Z'), "suspend-emacs");
12482 initial_define_key (meta_map, Ctl ('C'), "exit-recursive-edit");
12483 initial_define_key (global_map, Ctl (']'), "abort-recursive-edit");
12484 initial_define_key (meta_map, 'x', "execute-extended-command");
12486 initial_define_lispy_key (Vspecial_event_map, "delete-frame",
12487 "handle-delete-frame");
12488 initial_define_lispy_key (Vspecial_event_map, "ns-put-working-text",
12489 "ns-put-working-text");
12490 initial_define_lispy_key (Vspecial_event_map, "ns-unput-working-text",
12491 "ns-unput-working-text");
12492 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12493 current-prefix-arg, as is done in `handle-switch-frame'.
12494 But `handle-switch-frame is not run from the special-map.
12495 Commands from that map are run in a special way that automatically
12496 preserves the prefix-arg. Restoring the prefix arg here is not just
12497 redundant but harmful:
12498 - C-u C-x v =
12499 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12500 - after the first prompt, the exit-minibuffer-hook is run which may
12501 iconify a frame and thus push a `iconify-frame' event.
12502 - after running exit-minibuffer-hook, current-prefix-arg is
12503 restored to the non-nil value it had before the prompt.
12504 - we enter the second prompt.
12505 current-prefix-arg is non-nil, prefix-arg is nil.
12506 - before running the first real event, we run the special iconify-frame
12507 event, but we pass the `special' arg to execute-command so
12508 current-prefix-arg and prefix-arg are left untouched.
12509 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12510 - the next key event will have a spuriously non-nil current-prefix-arg. */
12511 initial_define_lispy_key (Vspecial_event_map, "iconify-frame",
12512 "ignore");
12513 initial_define_lispy_key (Vspecial_event_map, "make-frame-visible",
12514 "ignore");
12515 /* Handling it at such a low-level causes read_key_sequence to get
12516 * confused because it doesn't realize that the current_buffer was
12517 * changed by read_char.
12519 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12520 * "handle-select-window"); */
12521 initial_define_lispy_key (Vspecial_event_map, "save-session",
12522 "handle-save-session");
12524 #ifdef HAVE_DBUS
12525 /* Define a special event which is raised for dbus callback
12526 functions. */
12527 initial_define_lispy_key (Vspecial_event_map, "dbus-event",
12528 "dbus-handle-event");
12529 #endif
12532 /* Mark the pointers in the kboard objects.
12533 Called by the Fgarbage_collector. */
12534 void
12535 mark_kboards ()
12537 KBOARD *kb;
12538 Lisp_Object *p;
12539 for (kb = all_kboards; kb; kb = kb->next_kboard)
12541 if (kb->kbd_macro_buffer)
12542 for (p = kb->kbd_macro_buffer; p < kb->kbd_macro_ptr; p++)
12543 mark_object (*p);
12544 mark_object (kb->Voverriding_terminal_local_map);
12545 mark_object (kb->Vlast_command);
12546 mark_object (kb->Vreal_last_command);
12547 mark_object (kb->Vkeyboard_translate_table);
12548 mark_object (kb->Vlast_repeatable_command);
12549 mark_object (kb->Vprefix_arg);
12550 mark_object (kb->Vlast_prefix_arg);
12551 mark_object (kb->kbd_queue);
12552 mark_object (kb->defining_kbd_macro);
12553 mark_object (kb->Vlast_kbd_macro);
12554 mark_object (kb->Vsystem_key_alist);
12555 mark_object (kb->system_key_syms);
12556 mark_object (kb->Vwindow_system);
12557 mark_object (kb->Vinput_decode_map);
12558 mark_object (kb->Vlocal_function_key_map);
12559 mark_object (kb->Vdefault_minibuffer_frame);
12560 mark_object (kb->echo_string);
12563 struct input_event *event;
12564 for (event = kbd_fetch_ptr; event != kbd_store_ptr; event++)
12566 if (event == kbd_buffer + KBD_BUFFER_SIZE)
12567 event = kbd_buffer;
12568 if (event->kind != SELECTION_REQUEST_EVENT
12569 && event->kind != SELECTION_CLEAR_EVENT)
12571 mark_object (event->x);
12572 mark_object (event->y);
12574 mark_object (event->frame_or_window);
12575 mark_object (event->arg);
12580 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12581 (do not change this comment) */