Rewrite globals to allow indirection in C.
[emacs.git] / src / keyboard.c
blob76e8197dc7f2dfcd798a1f9a523c1edcc35b1e2f
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, 2010 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 <setjmp.h>
25 #include "lisp.h"
26 #include "termchar.h"
27 #include "termopts.h"
28 #include "frame.h"
29 #include "termhooks.h"
30 #include "macros.h"
31 #include "keyboard.h"
32 #include "window.h"
33 #include "commands.h"
34 #include "buffer.h"
35 #include "character.h"
36 #include "disptab.h"
37 #include "dispextern.h"
38 #include "syntax.h"
39 #include "intervals.h"
40 #include "keymap.h"
41 #include "blockinput.h"
42 #include "puresize.h"
43 #include "systime.h"
44 #include "atimer.h"
45 #include <setjmp.h>
46 #include <errno.h>
48 #ifdef HAVE_GTK_AND_PTHREAD
49 #include <pthread.h>
50 #endif
51 #ifdef MSDOS
52 #include "msdos.h"
53 #include <time.h>
54 #else /* not MSDOS */
55 #include <sys/ioctl.h>
56 #endif /* not MSDOS */
58 #include "syssignal.h"
60 #include <sys/types.h>
61 #ifdef HAVE_UNISTD_H
62 #include <unistd.h>
63 #endif
65 #ifdef HAVE_FCNTL_H
66 #include <fcntl.h>
67 #endif
69 /* This is to get the definitions of the XK_ symbols. */
70 #ifdef HAVE_X_WINDOWS
71 #include "xterm.h"
72 #endif
74 #ifdef HAVE_NTGUI
75 #include "w32term.h"
76 #endif /* HAVE_NTGUI */
78 #ifdef HAVE_NS
79 #include "nsterm.h"
80 #endif
82 #ifndef USE_CRT_DLL
83 extern int errno;
84 #endif
86 /* Variables for blockinput.h: */
88 /* Non-zero if interrupt input is blocked right now. */
89 volatile int interrupt_input_blocked;
91 /* Nonzero means an input interrupt has arrived
92 during the current critical section. */
93 int interrupt_input_pending;
95 /* This var should be (interrupt_input_pending || pending_atimers).
96 The QUIT macro checks this instead of interrupt_input_pending and
97 pending_atimers separately, to reduce code size. So, any code that
98 changes interrupt_input_pending or pending_atimers should update
99 this too. */
100 #ifdef SYNC_INPUT
101 int pending_signals;
102 #endif
104 #define KBD_BUFFER_SIZE 4096
106 KBOARD *initial_kboard;
107 KBOARD *current_kboard;
108 KBOARD *all_kboards;
109 int single_kboard;
111 /* Non-nil disable property on a command means
112 do not execute it; call disabled-command-function's value instead. */
113 Lisp_Object Qdisabled, Qdisabled_command_function;
115 #define NUM_RECENT_KEYS (300)
116 int recent_keys_index; /* Index for storing next element into recent_keys */
117 int total_keys; /* Total number of elements stored into recent_keys */
118 Lisp_Object recent_keys; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
120 /* Vector holding the key sequence that invoked the current command.
121 It is reused for each command, and it may be longer than the current
122 sequence; this_command_key_count indicates how many elements
123 actually mean something.
124 It's easier to staticpro a single Lisp_Object than an array. */
125 Lisp_Object this_command_keys;
126 int this_command_key_count;
128 /* 1 after calling Freset_this_command_lengths.
129 Usually it is 0. */
130 int this_command_key_count_reset;
132 /* This vector is used as a buffer to record the events that were actually read
133 by read_key_sequence. */
134 Lisp_Object raw_keybuf;
135 int raw_keybuf_count;
137 /* Non-nil if the present key sequence was obtained by shift translation. */
138 Lisp_Object impl_Vthis_command_keys_shift_translated;
140 #define GROW_RAW_KEYBUF \
141 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
142 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
144 /* Number of elements of this_command_keys
145 that precede this key sequence. */
146 int this_single_command_key_start;
148 /* Record values of this_command_key_count and echo_length ()
149 before this command was read. */
150 static int before_command_key_count;
151 static int before_command_echo_length;
153 extern int minbuf_level;
155 extern int message_enable_multibyte;
157 /* If non-nil, the function that implements the display of help.
158 It's called with one argument, the help string to display. */
160 Lisp_Object impl_Vshow_help_function;
162 /* Nonzero means do menu prompting. */
164 static int menu_prompting;
166 /* Character to see next line of menu prompt. */
168 static Lisp_Object impl_menu_prompt_more_char;
170 /* For longjmp to where kbd input is being done. */
172 static jmp_buf getcjmp;
174 /* True while doing kbd input. */
175 int waiting_for_input;
177 /* True while displaying for echoing. Delays C-g throwing. */
179 int echoing;
181 /* Non-null means we can start echoing at the next input pause even
182 though there is something in the echo area. */
184 static struct kboard *ok_to_echo_at_next_pause;
186 /* The kboard last echoing, or null for none. Reset to 0 in
187 cancel_echoing. If non-null, and a current echo area message
188 exists, and echo_message_buffer is eq to the current message
189 buffer, we know that the message comes from echo_kboard. */
191 struct kboard *echo_kboard;
193 /* The buffer used for echoing. Set in echo_now, reset in
194 cancel_echoing. */
196 Lisp_Object echo_message_buffer;
198 /* Nonzero means disregard local maps for the menu bar. */
199 static int inhibit_local_menu_bar_menus;
201 /* Nonzero means C-g should cause immediate error-signal. */
202 int immediate_quit;
204 /* The user's hook function for outputting an error message. */
205 Lisp_Object impl_Vcommand_error_function;
207 /* The user's ERASE setting. */
208 Lisp_Object impl_Vtty_erase_char;
210 /* Character to recognize as the help char. */
211 Lisp_Object impl_Vhelp_char;
213 /* List of other event types to recognize as meaning "help". */
214 Lisp_Object impl_Vhelp_event_list;
216 /* Form to execute when help char is typed. */
217 Lisp_Object impl_Vhelp_form;
219 /* Command to run when the help character follows a prefix key. */
220 Lisp_Object impl_Vprefix_help_command;
222 /* List of items that should move to the end of the menu bar. */
223 Lisp_Object impl_Vmenu_bar_final_items;
225 /* Non-nil means show the equivalent key-binding for
226 any M-x command that has one.
227 The value can be a length of time to show the message for.
228 If the value is non-nil and not a number, we wait 2 seconds. */
229 Lisp_Object impl_Vsuggest_key_bindings;
231 /* How long to display an echo-area message when the minibuffer is active.
232 If the value is not a number, such messages don't time out. */
233 Lisp_Object impl_Vminibuffer_message_timeout;
235 /* Character that causes a quit. Normally C-g.
237 If we are running on an ordinary terminal, this must be an ordinary
238 ASCII char, since we want to make it our interrupt character.
240 If we are not running on an ordinary terminal, it still needs to be
241 an ordinary ASCII char. This character needs to be recognized in
242 the input interrupt handler. At this point, the keystroke is
243 represented as a struct input_event, while the desired quit
244 character is specified as a lispy event. The mapping from struct
245 input_events to lispy events cannot run in an interrupt handler,
246 and the reverse mapping is difficult for anything but ASCII
247 keystrokes.
249 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
250 ASCII character. */
251 int quit_char;
253 extern Lisp_Object current_global_map;
254 extern int minibuf_level;
256 /* If non-nil, this is a map that overrides all other local maps. */
257 Lisp_Object impl_Voverriding_local_map;
259 /* If non-nil, Voverriding_local_map applies to the menu bar. */
260 Lisp_Object impl_Voverriding_local_map_menu_flag;
262 /* Keymap that defines special misc events that should
263 be processed immediately at a low level. */
264 Lisp_Object impl_Vspecial_event_map;
266 /* Current depth in recursive edits. */
267 int command_loop_level;
269 /* Total number of times command_loop has read a key sequence. */
270 EMACS_INT num_input_keys;
272 /* Last input event read as a command. */
273 Lisp_Object impl_last_command_event;
275 /* Last input character read as a command, not counting menus
276 reached by the mouse. */
277 Lisp_Object impl_last_nonmenu_event;
279 /* Last input event read for any purpose. */
280 Lisp_Object impl_last_input_event;
282 /* If not Qnil, a list of objects to be read as subsequent command input. */
283 Lisp_Object impl_Vunread_command_events;
285 /* If not Qnil, a list of objects to be read as subsequent command input
286 including input method processing. */
287 Lisp_Object impl_Vunread_input_method_events;
289 /* If not Qnil, a list of objects to be read as subsequent command input
290 but NOT including input method processing. */
291 Lisp_Object impl_Vunread_post_input_method_events;
293 /* If not -1, an event to be read as subsequent command input. */
294 EMACS_INT unread_command_char;
296 /* If not Qnil, this is a switch-frame event which we decided to put
297 off until the end of a key sequence. This should be read as the
298 next command input, after any unread_command_events.
300 read_key_sequence uses this to delay switch-frame events until the
301 end of the key sequence; Fread_char uses it to put off switch-frame
302 events until a non-ASCII event is acceptable as input. */
303 Lisp_Object unread_switch_frame;
305 /* A mask of extra modifier bits to put into every keyboard char. */
306 EMACS_INT extra_keyboard_modifiers;
308 /* Char to use as prefix when a meta character is typed in.
309 This is bound on entry to minibuffer in case ESC is changed there. */
311 Lisp_Object impl_meta_prefix_char;
313 /* Last size recorded for a current buffer which is not a minibuffer. */
314 static int last_non_minibuf_size;
316 /* Number of idle seconds before an auto-save and garbage collection. */
317 static Lisp_Object impl_Vauto_save_timeout;
319 /* Total number of times read_char has returned. */
320 int num_input_events;
322 /* Total number of times read_char has returned, outside of macros. */
323 EMACS_INT num_nonmacro_input_events;
325 /* Auto-save automatically when this many characters have been typed
326 since the last time. */
328 static EMACS_INT auto_save_interval;
330 /* Value of num_nonmacro_input_events as of last auto save. */
332 int last_auto_save;
334 /* The command being executed by the command loop.
335 Commands may set this, and the value set will be copied into
336 current_kboard->Vlast_command instead of the actual command. */
337 Lisp_Object impl_Vthis_command;
339 /* This is like Vthis_command, except that commands never set it. */
340 Lisp_Object real_this_command;
342 /* If the lookup of the command returns a binding, the original
343 command is stored in this-original-command. It is nil otherwise. */
344 Lisp_Object impl_Vthis_original_command;
346 /* The value of point when the last command was started. */
347 int last_point_position;
349 /* The buffer that was current when the last command was started. */
350 Lisp_Object last_point_position_buffer;
352 /* The window that was selected when the last command was started. */
353 Lisp_Object last_point_position_window;
355 /* The frame in which the last input event occurred, or Qmacro if the
356 last event came from a macro. We use this to determine when to
357 generate switch-frame events. This may be cleared by functions
358 like Fselect_frame, to make sure that a switch-frame event is
359 generated by the next character. */
360 Lisp_Object internal_last_event_frame;
362 /* A user-visible version of the above, intended to allow users to
363 figure out where the last event came from, if the event doesn't
364 carry that information itself (i.e. if it was a character). */
365 Lisp_Object impl_Vlast_event_frame;
367 /* The timestamp of the last input event we received from the X server.
368 X Windows wants this for selection ownership. */
369 unsigned long last_event_timestamp;
371 Lisp_Object Qself_insert_command;
372 Lisp_Object Qforward_char;
373 Lisp_Object Qbackward_char;
374 Lisp_Object Qundefined;
375 Lisp_Object Qtimer_event_handler;
377 /* read_key_sequence stores here the command definition of the
378 key sequence that it reads. */
379 Lisp_Object read_key_sequence_cmd;
381 /* Echo unfinished commands after this many seconds of pause. */
382 Lisp_Object impl_Vecho_keystrokes;
384 /* Form to evaluate (if non-nil) when Emacs is started. */
385 Lisp_Object impl_Vtop_level;
387 /* If non-nil, this implements the current input method. */
388 Lisp_Object impl_Vinput_method_function;
389 Lisp_Object Qinput_method_function;
391 /* When we call Vinput_method_function,
392 this holds the echo area message that was just erased. */
393 Lisp_Object impl_Vinput_method_previous_message;
395 /* Non-nil means deactivate the mark at end of this command. */
396 Lisp_Object impl_Vdeactivate_mark;
397 Lisp_Object Qdeactivate_mark;
399 /* Menu bar specified in Lucid Emacs fashion. */
401 Lisp_Object impl_Vlucid_menu_bar_dirty_flag;
402 Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;
404 Lisp_Object Qecho_area_clear_hook;
406 /* Hooks to run before and after each command. */
407 Lisp_Object Qpre_command_hook, impl_Vpre_command_hook;
408 Lisp_Object Qpost_command_hook, impl_Vpost_command_hook;
409 Lisp_Object Qcommand_hook_internal, impl_Vcommand_hook_internal;
411 /* Parent keymap of terminal-local function-key-map instances. */
412 Lisp_Object impl_Vfunction_key_map;
414 /* Keymap of key translations that can override keymaps. */
415 Lisp_Object impl_Vkey_translation_map;
417 /* List of deferred actions to be performed at a later time.
418 The precise format isn't relevant here; we just check whether it is nil. */
419 Lisp_Object impl_Vdeferred_action_list;
421 /* Function to call to handle deferred actions, when there are any. */
422 Lisp_Object impl_Vdeferred_action_function;
423 Lisp_Object Qdeferred_action_function;
425 Lisp_Object Qinput_method_exit_on_first_char;
426 Lisp_Object Qinput_method_use_echo_area;
428 /* File in which we write all commands we read. */
429 FILE *dribble;
431 /* Nonzero if input is available. */
432 int input_pending;
434 extern char *pending_malloc_warning;
436 /* Circular buffer for pre-read keyboard input. */
438 static struct input_event kbd_buffer[KBD_BUFFER_SIZE];
440 /* Pointer to next available character in kbd_buffer.
441 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
442 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
443 next available char is in kbd_buffer[0]. */
444 static struct input_event *kbd_fetch_ptr;
446 /* Pointer to next place to store character in kbd_buffer. This
447 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
448 character should go in kbd_buffer[0]. */
449 static struct input_event * volatile kbd_store_ptr;
451 /* The above pair of variables forms a "queue empty" flag. When we
452 enqueue a non-hook event, we increment kbd_store_ptr. When we
453 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
454 there is input available if the two pointers are not equal.
456 Why not just have a flag set and cleared by the enqueuing and
457 dequeuing functions? Such a flag could be screwed up by interrupts
458 at inopportune times. */
460 /* If this flag is non-nil, we check mouse_moved to see when the
461 mouse moves, and motion events will appear in the input stream.
462 Otherwise, mouse motion is ignored. */
463 Lisp_Object impl_do_mouse_tracking;
465 /* Symbols to head events. */
466 Lisp_Object Qmouse_movement;
467 Lisp_Object Qscroll_bar_movement;
468 Lisp_Object Qswitch_frame;
469 Lisp_Object Qdelete_frame;
470 Lisp_Object Qiconify_frame;
471 Lisp_Object Qmake_frame_visible;
472 Lisp_Object Qselect_window;
473 Lisp_Object Qhelp_echo;
475 extern Lisp_Object Qremap;
477 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
478 Lisp_Object Qmouse_fixup_help_message;
479 #endif
481 /* Symbols to denote kinds of events. */
482 Lisp_Object Qfunction_key;
483 Lisp_Object Qmouse_click;
484 #if defined (WINDOWSNT)
485 Lisp_Object Qlanguage_change;
486 #endif
487 Lisp_Object Qdrag_n_drop;
488 Lisp_Object Qsave_session;
489 #ifdef HAVE_DBUS
490 Lisp_Object Qdbus_event;
491 #endif
492 Lisp_Object Qconfig_changed_event;
494 /* Lisp_Object Qmouse_movement; - also an event header */
496 /* Properties of event headers. */
497 Lisp_Object Qevent_kind;
498 Lisp_Object Qevent_symbol_elements;
500 /* menu item parts */
501 Lisp_Object Qmenu_enable;
502 Lisp_Object QCenable, QCvisible, QChelp, QCfilter, QCkeys, QCkey_sequence;
503 Lisp_Object QCbutton, QCtoggle, QCradio;
504 extern Lisp_Object Qmenu_item;
506 /* An event header symbol HEAD may have a property named
507 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
508 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
509 mask of modifiers applied to it. If present, this is used to help
510 speed up parse_modifiers. */
511 Lisp_Object Qevent_symbol_element_mask;
513 /* An unmodified event header BASE may have a property named
514 Qmodifier_cache, which is an alist mapping modifier masks onto
515 modified versions of BASE. If present, this helps speed up
516 apply_modifiers. */
517 Lisp_Object Qmodifier_cache;
519 /* Symbols to use for parts of windows. */
520 Lisp_Object Qmode_line;
521 Lisp_Object Qvertical_line;
522 Lisp_Object Qvertical_scroll_bar;
523 Lisp_Object Qmenu_bar;
524 extern Lisp_Object Qleft_margin, Qright_margin;
525 extern Lisp_Object Qleft_fringe, Qright_fringe;
526 extern Lisp_Object QCmap;
528 Lisp_Object recursive_edit_unwind (), command_loop ();
529 Lisp_Object Fthis_command_keys ();
530 Lisp_Object Qextended_command_history;
531 EMACS_TIME timer_check ();
533 extern Lisp_Object impl_Vhistory_length, impl_Vtranslation_table_for_input;
535 extern char *x_get_keysym_name ();
537 static void record_menu_key ();
538 static int echo_length ();
540 Lisp_Object Qpolling_period;
542 /* List of absolute timers. Appears in order of next scheduled event. */
543 Lisp_Object impl_Vtimer_list;
545 /* List of idle time timers. Appears in order of next scheduled event. */
546 Lisp_Object impl_Vtimer_idle_list;
548 /* Incremented whenever a timer is run. */
549 int timers_run;
551 extern Lisp_Object impl_Vprint_level, impl_Vprint_length;
553 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
554 happens. */
555 EMACS_TIME *input_available_clear_time;
557 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
558 Default is 1 if INTERRUPT_INPUT is defined. */
559 int interrupt_input;
561 /* Nonzero while interrupts are temporarily deferred during redisplay. */
562 int interrupts_deferred;
564 /* Allow m- file to inhibit use of FIONREAD. */
565 #ifdef BROKEN_FIONREAD
566 #undef FIONREAD
567 #endif
569 /* We are unable to use interrupts if FIONREAD is not available,
570 so flush SIGIO so we won't try. */
571 #if !defined (FIONREAD)
572 #ifdef SIGIO
573 #undef SIGIO
574 #endif
575 #endif
577 /* If we support a window system, turn on the code to poll periodically
578 to detect C-g. It isn't actually used when doing interrupt input. */
579 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
580 #define POLL_FOR_INPUT
581 #endif
583 /* After a command is executed, if point is moved into a region that
584 has specific properties (e.g. composition, display), we adjust
585 point to the boundary of the region. But, if a command sets this
586 variable to non-nil, we suppress this point adjustment. This
587 variable is set to nil before reading a command. */
589 Lisp_Object impl_Vdisable_point_adjustment;
591 /* If non-nil, always disable point adjustment. */
593 Lisp_Object impl_Vglobal_disable_point_adjustment;
595 /* The time when Emacs started being idle. */
597 static EMACS_TIME timer_idleness_start_time;
599 /* After Emacs stops being idle, this saves the last value
600 of timer_idleness_start_time from when it was idle. */
602 static EMACS_TIME timer_last_idleness_start_time;
604 /* If non-nil, events produced by disabled menu items and tool-bar
605 buttons are not ignored. Help functions bind this to allow help on
606 those items and buttons. */
607 Lisp_Object impl_Venable_disabled_menus_and_buttons;
610 /* Global variable declarations. */
612 /* Flags for readable_events. */
613 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
614 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
615 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
617 /* Function for init_keyboard to call with no args (if nonzero). */
618 void (*keyboard_init_hook) ();
620 static int read_avail_input P_ ((int));
621 static void get_input_pending P_ ((int *, int));
622 static int readable_events P_ ((int));
623 static Lisp_Object read_char_x_menu_prompt P_ ((int, Lisp_Object *,
624 Lisp_Object, int *));
625 static Lisp_Object read_char_x_menu_prompt ();
626 static Lisp_Object read_char_minibuf_menu_prompt P_ ((int, int,
627 Lisp_Object *));
628 static Lisp_Object make_lispy_event P_ ((struct input_event *));
629 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
630 static Lisp_Object make_lispy_movement P_ ((struct frame *, Lisp_Object,
631 enum scroll_bar_part,
632 Lisp_Object, Lisp_Object,
633 unsigned long));
634 #endif
635 static Lisp_Object modify_event_symbol P_ ((int, unsigned, Lisp_Object,
636 Lisp_Object, char **,
637 Lisp_Object *, unsigned));
638 static Lisp_Object make_lispy_switch_frame P_ ((Lisp_Object));
639 static void save_getcjmp P_ ((jmp_buf));
640 static void save_getcjmp ();
641 static void restore_getcjmp P_ ((jmp_buf));
642 static Lisp_Object apply_modifiers P_ ((int, Lisp_Object));
643 static void clear_event P_ ((struct input_event *));
644 static Lisp_Object restore_kboard_configuration P_ ((Lisp_Object));
645 static SIGTYPE interrupt_signal P_ ((int signalnum));
646 static void handle_interrupt P_ ((void));
647 static void timer_start_idle P_ ((void));
648 static void timer_stop_idle P_ ((void));
649 static void timer_resume_idle P_ ((void));
650 static SIGTYPE handle_user_signal P_ ((int));
651 static char *find_user_signal_name P_ ((int));
652 static int store_user_signal_events P_ ((void));
654 /* Nonzero means don't try to suspend even if the operating system seems
655 to support it. */
656 static int cannot_suspend;
658 extern Lisp_Object Qidentity, Qonly;
660 /* Install the string STR as the beginning of the string of echoing,
661 so that it serves as a prompt for the next character.
662 Also start echoing. */
664 void
665 echo_prompt (str)
666 Lisp_Object str;
668 current_kboard->echo_string = str;
669 current_kboard->echo_after_prompt = SCHARS (str);
670 echo_now ();
673 /* Add C to the echo string, if echoing is going on.
674 C can be a character, which is printed prettily ("M-C-x" and all that
675 jazz), or a symbol, whose name is printed. */
677 void
678 echo_char (c)
679 Lisp_Object c;
681 if (current_kboard->immediate_echo)
683 int size = KEY_DESCRIPTION_SIZE + 100;
684 char *buffer = (char *) alloca (size);
685 char *ptr = buffer;
686 Lisp_Object echo_string;
688 echo_string = current_kboard->echo_string;
690 /* If someone has passed us a composite event, use its head symbol. */
691 c = EVENT_HEAD (c);
693 if (INTEGERP (c))
695 ptr = push_key_description (XINT (c), ptr, 1);
697 else if (SYMBOLP (c))
699 Lisp_Object name = SYMBOL_NAME (c);
700 int nbytes = SBYTES (name);
702 if (size - (ptr - buffer) < nbytes)
704 int offset = ptr - buffer;
705 size = max (2 * size, size + nbytes);
706 buffer = (char *) alloca (size);
707 ptr = buffer + offset;
710 ptr += copy_text (SDATA (name), ptr, nbytes,
711 STRING_MULTIBYTE (name), 1);
714 if ((NILP (echo_string) || SCHARS (echo_string) == 0)
715 && help_char_p (c))
717 const char *text = " (Type ? for further options)";
718 int len = strlen (text);
720 if (size - (ptr - buffer) < len)
722 int offset = ptr - buffer;
723 size += len;
724 buffer = (char *) alloca (size);
725 ptr = buffer + offset;
728 bcopy (text, ptr, len);
729 ptr += len;
732 /* Replace a dash from echo_dash with a space, otherwise
733 add a space at the end as a separator between keys. */
734 if (STRINGP (echo_string)
735 && SCHARS (echo_string) > 1)
737 Lisp_Object last_char, prev_char, idx;
739 idx = make_number (SCHARS (echo_string) - 2);
740 prev_char = Faref (echo_string, idx);
742 idx = make_number (SCHARS (echo_string) - 1);
743 last_char = Faref (echo_string, idx);
745 /* We test PREV_CHAR to make sure this isn't the echoing
746 of a minus-sign. */
747 if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
748 Faset (echo_string, idx, make_number (' '));
749 else
750 echo_string = concat2 (echo_string, build_string (" "));
752 else if (STRINGP (echo_string))
753 echo_string = concat2 (echo_string, build_string (" "));
755 current_kboard->echo_string
756 = concat2 (echo_string, make_string (buffer, ptr - buffer));
758 echo_now ();
762 /* Temporarily add a dash to the end of the echo string if it's not
763 empty, so that it serves as a mini-prompt for the very next character. */
765 void
766 echo_dash ()
768 /* Do nothing if not echoing at all. */
769 if (NILP (current_kboard->echo_string))
770 return;
772 if (!current_kboard->immediate_echo
773 && SCHARS (current_kboard->echo_string) == 0)
774 return;
776 /* Do nothing if we just printed a prompt. */
777 if (current_kboard->echo_after_prompt
778 == SCHARS (current_kboard->echo_string))
779 return;
781 /* Do nothing if we have already put a dash at the end. */
782 if (SCHARS (current_kboard->echo_string) > 1)
784 Lisp_Object last_char, prev_char, idx;
786 idx = make_number (SCHARS (current_kboard->echo_string) - 2);
787 prev_char = Faref (current_kboard->echo_string, idx);
789 idx = make_number (SCHARS (current_kboard->echo_string) - 1);
790 last_char = Faref (current_kboard->echo_string, idx);
792 if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
793 return;
796 /* Put a dash at the end of the buffer temporarily,
797 but make it go away when the next character is added. */
798 current_kboard->echo_string = concat2 (current_kboard->echo_string,
799 build_string ("-"));
800 echo_now ();
803 /* Display the current echo string, and begin echoing if not already
804 doing so. */
806 void
807 echo_now ()
809 if (!current_kboard->immediate_echo)
811 int i;
812 current_kboard->immediate_echo = 1;
814 for (i = 0; i < this_command_key_count; i++)
816 Lisp_Object c;
818 /* Set before_command_echo_length to the value that would
819 have been saved before the start of this subcommand in
820 command_loop_1, if we had already been echoing then. */
821 if (i == this_single_command_key_start)
822 before_command_echo_length = echo_length ();
824 c = XVECTOR (this_command_keys)->contents[i];
825 if (! (EVENT_HAS_PARAMETERS (c)
826 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
827 echo_char (c);
830 /* Set before_command_echo_length to the value that would
831 have been saved before the start of this subcommand in
832 command_loop_1, if we had already been echoing then. */
833 if (this_command_key_count == this_single_command_key_start)
834 before_command_echo_length = echo_length ();
836 /* Put a dash at the end to invite the user to type more. */
837 echo_dash ();
840 echoing = 1;
841 message3_nolog (current_kboard->echo_string,
842 SBYTES (current_kboard->echo_string),
843 STRING_MULTIBYTE (current_kboard->echo_string));
844 echoing = 0;
846 /* Record in what buffer we echoed, and from which kboard. */
847 echo_message_buffer = echo_area_buffer[0];
848 echo_kboard = current_kboard;
850 if (waiting_for_input && !NILP (Vquit_flag))
851 quit_throw_to_read_char ();
854 /* Turn off echoing, for the start of a new command. */
856 void
857 cancel_echoing ()
859 current_kboard->immediate_echo = 0;
860 current_kboard->echo_after_prompt = -1;
861 current_kboard->echo_string = Qnil;
862 ok_to_echo_at_next_pause = NULL;
863 echo_kboard = NULL;
864 echo_message_buffer = Qnil;
867 /* Return the length of the current echo string. */
869 static int
870 echo_length ()
872 return (STRINGP (current_kboard->echo_string)
873 ? SCHARS (current_kboard->echo_string)
874 : 0);
877 /* Truncate the current echo message to its first LEN chars.
878 This and echo_char get used by read_key_sequence when the user
879 switches frames while entering a key sequence. */
881 static void
882 echo_truncate (nchars)
883 int nchars;
885 if (STRINGP (current_kboard->echo_string))
886 current_kboard->echo_string
887 = Fsubstring (current_kboard->echo_string,
888 make_number (0), make_number (nchars));
889 truncate_echo_area (nchars);
893 /* Functions for manipulating this_command_keys. */
894 static void
895 add_command_key (key)
896 Lisp_Object key;
898 #if 0 /* Not needed after we made Freset_this_command_lengths
899 do the job immediately. */
900 /* If reset-this-command-length was called recently, obey it now.
901 See the doc string of that function for an explanation of why. */
902 if (before_command_restore_flag)
904 this_command_key_count = before_command_key_count_1;
905 if (this_command_key_count < this_single_command_key_start)
906 this_single_command_key_start = this_command_key_count;
907 echo_truncate (before_command_echo_length_1);
908 before_command_restore_flag = 0;
910 #endif
912 if (this_command_key_count >= ASIZE (this_command_keys))
913 this_command_keys = larger_vector (this_command_keys,
914 2 * ASIZE (this_command_keys),
915 Qnil);
917 ASET (this_command_keys, this_command_key_count, key);
918 ++this_command_key_count;
922 Lisp_Object
923 recursive_edit_1 ()
925 int count = SPECPDL_INDEX ();
926 Lisp_Object val;
928 if (command_loop_level > 0)
930 specbind (Qstandard_output, Qt);
931 specbind (Qstandard_input, Qt);
934 #ifdef HAVE_WINDOW_SYSTEM
935 /* The command loop has started an hourglass timer, so we have to
936 cancel it here, otherwise it will fire because the recursive edit
937 can take some time. Do not check for display_hourglass_p here,
938 because it could already be nil. */
939 cancel_hourglass ();
940 #endif
942 /* This function may have been called from a debugger called from
943 within redisplay, for instance by Edebugging a function called
944 from fontification-functions. We want to allow redisplay in
945 the debugging session.
947 The recursive edit is left with a `(throw exit ...)'. The `exit'
948 tag is not caught anywhere in redisplay, i.e. when we leave the
949 recursive edit, the original redisplay leading to the recursive
950 edit will be unwound. The outcome should therefore be safe. */
951 specbind (Qinhibit_redisplay, Qnil);
952 redisplaying_p = 0;
954 val = command_loop ();
955 if (EQ (val, Qt))
956 Fsignal (Qquit, Qnil);
957 /* Handle throw from read_minibuf when using minibuffer
958 while it's active but we're in another window. */
959 if (STRINGP (val))
960 xsignal1 (Qerror, val);
962 return unbind_to (count, Qnil);
965 /* When an auto-save happens, record the "time", and don't do again soon. */
967 void
968 record_auto_save ()
970 last_auto_save = num_nonmacro_input_events;
973 /* Make an auto save happen as soon as possible at command level. */
975 void
976 force_auto_save_soon ()
978 last_auto_save = - auto_save_interval - 1;
980 record_asynch_buffer_change ();
983 DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
984 doc: /* Invoke the editor command loop recursively.
985 To get out of the recursive edit, a command can do `(throw 'exit nil)';
986 that tells this function to return.
987 Alternatively, `(throw 'exit t)' makes this function signal an error.
988 This function is called by the editor initialization to begin editing. */)
991 int count = SPECPDL_INDEX ();
992 Lisp_Object buffer;
994 /* If we enter while input is blocked, don't lock up here.
995 This may happen through the debugger during redisplay. */
996 if (INPUT_BLOCKED_P)
997 return Qnil;
999 command_loop_level++;
1000 update_mode_lines = 1;
1002 if (command_loop_level
1003 && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
1004 buffer = Fcurrent_buffer ();
1005 else
1006 buffer = Qnil;
1008 /* If we leave recursive_edit_1 below with a `throw' for instance,
1009 like it is done in the splash screen display, we have to
1010 make sure that we restore single_kboard as command_loop_1
1011 would have done if it were left normally. */
1012 if (command_loop_level > 0)
1013 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1014 record_unwind_protect (recursive_edit_unwind, buffer);
1016 recursive_edit_1 ();
1017 return unbind_to (count, Qnil);
1020 Lisp_Object
1021 recursive_edit_unwind (buffer)
1022 Lisp_Object buffer;
1024 if (BUFFERP (buffer))
1025 Fset_buffer (buffer);
1027 command_loop_level--;
1028 update_mode_lines = 1;
1029 return Qnil;
1033 #if 0 /* These two functions are now replaced with
1034 temporarily_switch_to_single_kboard. */
1035 static void
1036 any_kboard_state ()
1038 #if 0 /* Theory: if there's anything in Vunread_command_events,
1039 it will right away be read by read_key_sequence,
1040 and then if we do switch KBOARDS, it will go into the side
1041 queue then. So we don't need to do anything special here -- rms. */
1042 if (CONSP (Vunread_command_events))
1044 current_kboard->kbd_queue
1045 = nconc2 (Vunread_command_events, current_kboard->kbd_queue);
1046 current_kboard->kbd_queue_has_data = 1;
1048 Vunread_command_events = Qnil;
1049 #endif
1050 single_kboard = 0;
1053 /* Switch to the single-kboard state, making current_kboard
1054 the only KBOARD from which further input is accepted. */
1056 void
1057 single_kboard_state ()
1059 single_kboard = 1;
1061 #endif
1063 /* If we're in single_kboard state for kboard KBOARD,
1064 get out of it. */
1066 void
1067 not_single_kboard_state (kboard)
1068 KBOARD *kboard;
1070 if (kboard == current_kboard)
1071 single_kboard = 0;
1074 /* Maintain a stack of kboards, so other parts of Emacs
1075 can switch temporarily to the kboard of a given frame
1076 and then revert to the previous status. */
1078 struct kboard_stack
1080 KBOARD *kboard;
1081 struct kboard_stack *next;
1084 static struct kboard_stack *kboard_stack;
1086 void
1087 push_kboard (k)
1088 struct kboard *k;
1090 struct kboard_stack *p
1091 = (struct kboard_stack *) xmalloc (sizeof (struct kboard_stack));
1093 p->next = kboard_stack;
1094 p->kboard = current_kboard;
1095 kboard_stack = p;
1097 current_kboard = k;
1100 void
1101 pop_kboard ()
1103 struct terminal *t;
1104 struct kboard_stack *p = kboard_stack;
1105 int found = 0;
1106 for (t = terminal_list; t; t = t->next_terminal)
1108 if (t->kboard == p->kboard)
1110 current_kboard = p->kboard;
1111 found = 1;
1112 break;
1115 if (!found)
1117 /* The terminal we remembered has been deleted. */
1118 current_kboard = FRAME_KBOARD (SELECTED_FRAME ());
1119 single_kboard = 0;
1121 kboard_stack = p->next;
1122 xfree (p);
1125 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1126 from which further input is accepted. If F is non-nil, set its
1127 KBOARD as the current keyboard.
1129 This function uses record_unwind_protect to return to the previous
1130 state later.
1132 If Emacs is already in single_kboard mode, and F's keyboard is
1133 locked, then this function will throw an errow. */
1135 void
1136 temporarily_switch_to_single_kboard (f)
1137 struct frame *f;
1139 int was_locked = single_kboard;
1140 if (was_locked)
1142 if (f != NULL && FRAME_KBOARD (f) != current_kboard)
1143 /* We can not switch keyboards while in single_kboard mode.
1144 In rare cases, Lisp code may call `recursive-edit' (or
1145 `read-minibuffer' or `y-or-n-p') after it switched to a
1146 locked frame. For example, this is likely to happen
1147 when server.el connects to a new terminal while Emacs is in
1148 single_kboard mode. It is best to throw an error instead
1149 of presenting the user with a frozen screen. */
1150 error ("Terminal %d is locked, cannot read from it",
1151 FRAME_TERMINAL (f)->id);
1152 else
1153 /* This call is unnecessary, but helps
1154 `restore_kboard_configuration' discover if somebody changed
1155 `current_kboard' behind our back. */
1156 push_kboard (current_kboard);
1158 else if (f != NULL)
1159 current_kboard = FRAME_KBOARD (f);
1160 single_kboard = 1;
1161 record_unwind_protect (restore_kboard_configuration,
1162 (was_locked ? Qt : Qnil));
1165 #if 0 /* This function is not needed anymore. */
1166 void
1167 record_single_kboard_state ()
1169 if (single_kboard)
1170 push_kboard (current_kboard);
1171 record_unwind_protect (restore_kboard_configuration,
1172 (single_kboard ? Qt : Qnil));
1174 #endif
1176 static Lisp_Object
1177 restore_kboard_configuration (was_locked)
1178 Lisp_Object was_locked;
1180 if (NILP (was_locked))
1181 single_kboard = 0;
1182 else
1184 struct kboard *prev = current_kboard;
1185 single_kboard = 1;
1186 pop_kboard ();
1187 /* The pop should not change the kboard. */
1188 if (single_kboard && current_kboard != prev)
1189 abort ();
1191 return Qnil;
1195 /* Handle errors that are not handled at inner levels
1196 by printing an error message and returning to the editor command loop. */
1198 Lisp_Object
1199 cmd_error (data)
1200 Lisp_Object data;
1202 Lisp_Object old_level, old_length;
1203 char macroerror[50];
1205 #ifdef HAVE_WINDOW_SYSTEM
1206 if (display_hourglass_p)
1207 cancel_hourglass ();
1208 #endif
1210 if (!NILP (executing_kbd_macro))
1212 if (executing_kbd_macro_iterations == 1)
1213 sprintf (macroerror, "After 1 kbd macro iteration: ");
1214 else
1215 sprintf (macroerror, "After %d kbd macro iterations: ",
1216 executing_kbd_macro_iterations);
1218 else
1219 *macroerror = 0;
1221 Vstandard_output = Qt;
1222 Vstandard_input = Qt;
1223 Vexecuting_kbd_macro = Qnil;
1224 executing_kbd_macro = Qnil;
1225 current_kboard->Vprefix_arg = Qnil;
1226 current_kboard->Vlast_prefix_arg = Qnil;
1227 cancel_echoing ();
1229 /* Avoid unquittable loop if data contains a circular list. */
1230 old_level = Vprint_level;
1231 old_length = Vprint_length;
1232 XSETFASTINT (Vprint_level, 10);
1233 XSETFASTINT (Vprint_length, 10);
1234 cmd_error_internal (data, macroerror);
1235 Vprint_level = old_level;
1236 Vprint_length = old_length;
1238 Vquit_flag = Qnil;
1240 Vinhibit_quit = Qnil;
1241 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1242 if (command_loop_level == 0 && minibuf_level == 0)
1243 any_kboard_state ();
1244 #endif
1246 return make_number (0);
1249 /* Take actions on handling an error. DATA is the data that describes
1250 the error.
1252 CONTEXT is a C-string containing ASCII characters only which
1253 describes the context in which the error happened. If we need to
1254 generalize CONTEXT to allow multibyte characters, make it a Lisp
1255 string. */
1257 void
1258 cmd_error_internal (data, context)
1259 Lisp_Object data;
1260 char *context;
1262 struct frame *sf = SELECTED_FRAME ();
1264 /* The immediate context is not interesting for Quits,
1265 since they are asyncronous. */
1266 if (EQ (XCAR (data), Qquit))
1267 Vsignaling_function = Qnil;
1269 Vquit_flag = Qnil;
1270 Vinhibit_quit = Qt;
1272 /* Use user's specified output function if any. */
1273 if (!NILP (Vcommand_error_function))
1274 call3 (Vcommand_error_function, data,
1275 context ? build_string (context) : empty_unibyte_string,
1276 Vsignaling_function);
1277 /* If the window system or terminal frame hasn't been initialized
1278 yet, or we're not interactive, write the message to stderr and exit. */
1279 else if (!sf->glyphs_initialized_p
1280 /* The initial frame is a special non-displaying frame. It
1281 will be current in daemon mode when there are no frames
1282 to display, and in non-daemon mode before the real frame
1283 has finished initializing. If an error is thrown in the
1284 latter case while creating the frame, then the frame
1285 will never be displayed, so the safest thing to do is
1286 write to stderr and quit. In daemon mode, there are
1287 many other potential errors that do not prevent frames
1288 from being created, so continuing as normal is better in
1289 that case. */
1290 || (!IS_DAEMON && FRAME_INITIAL_P (sf))
1291 || noninteractive)
1293 print_error_message (data, Qexternal_debugging_output,
1294 context, Vsignaling_function);
1295 Fterpri (Qexternal_debugging_output);
1296 Fkill_emacs (make_number (-1));
1298 else
1300 clear_message (1, 0);
1301 Fdiscard_input ();
1302 message_log_maybe_newline ();
1303 bitch_at_user ();
1305 print_error_message (data, Qt, context, Vsignaling_function);
1308 Vsignaling_function = Qnil;
1311 Lisp_Object command_loop_1 ();
1312 Lisp_Object command_loop_2 ();
1313 Lisp_Object top_level_1 ();
1315 /* Entry to editor-command-loop.
1316 This level has the catches for exiting/returning to editor command loop.
1317 It returns nil to exit recursive edit, t to abort it. */
1319 Lisp_Object
1320 command_loop ()
1322 if (command_loop_level > 0 || minibuf_level > 0)
1324 Lisp_Object val;
1325 val = internal_catch (Qexit, command_loop_2, Qnil);
1326 executing_kbd_macro = Qnil;
1327 return val;
1329 else
1330 while (1)
1332 internal_catch (Qtop_level, top_level_1, Qnil);
1333 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1334 /* Reset single_kboard in case top-level set it while
1335 evaluating an -f option, or we are stuck there for some
1336 other reason. */
1337 any_kboard_state ();
1338 #endif
1339 internal_catch (Qtop_level, command_loop_2, Qnil);
1340 executing_kbd_macro = Qnil;
1342 /* End of file in -batch run causes exit here. */
1343 if (noninteractive)
1344 Fkill_emacs (Qt);
1348 /* Here we catch errors in execution of commands within the
1349 editing loop, and reenter the editing loop.
1350 When there is an error, cmd_error runs and returns a non-nil
1351 value to us. A value of nil means that command_loop_1 itself
1352 returned due to end of file (or end of kbd macro). */
1354 Lisp_Object
1355 command_loop_2 ()
1357 register Lisp_Object val;
1360 val = internal_condition_case (command_loop_1, Qerror, cmd_error);
1361 while (!NILP (val));
1363 return Qnil;
1366 Lisp_Object
1367 top_level_2 ()
1369 return Feval (Vtop_level);
1372 Lisp_Object
1373 top_level_1 ()
1375 /* On entry to the outer level, run the startup file */
1376 if (!NILP (Vtop_level))
1377 internal_condition_case (top_level_2, Qerror, cmd_error);
1378 else if (!NILP (Vpurify_flag))
1379 message ("Bare impure Emacs (standard Lisp code not loaded)");
1380 else
1381 message ("Bare Emacs (standard Lisp code not loaded)");
1382 return Qnil;
1385 DEFUN ("top-level", Ftop_level, Stop_level, 0, 0, "",
1386 doc: /* Exit all recursive editing levels.
1387 This also exits all active minibuffers. */)
1390 #ifdef HAVE_WINDOW_SYSTEM
1391 if (display_hourglass_p)
1392 cancel_hourglass ();
1393 #endif
1395 /* Unblock input if we enter with input blocked. This may happen if
1396 redisplay traps e.g. during tool-bar update with input blocked. */
1397 while (INPUT_BLOCKED_P)
1398 UNBLOCK_INPUT;
1400 return Fthrow (Qtop_level, Qnil);
1403 DEFUN ("exit-recursive-edit", Fexit_recursive_edit, Sexit_recursive_edit, 0, 0, "",
1404 doc: /* Exit from the innermost recursive edit or minibuffer. */)
1407 if (command_loop_level > 0 || minibuf_level > 0)
1408 Fthrow (Qexit, Qnil);
1410 error ("No recursive edit is in progress");
1411 return Qnil;
1414 DEFUN ("abort-recursive-edit", Fabort_recursive_edit, Sabort_recursive_edit, 0, 0, "",
1415 doc: /* Abort the command that requested this recursive edit or minibuffer input. */)
1418 if (command_loop_level > 0 || minibuf_level > 0)
1419 Fthrow (Qexit, Qt);
1421 error ("No recursive edit is in progress");
1422 return Qnil;
1425 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1427 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1428 of this function. */
1430 static Lisp_Object
1431 tracking_off (old_value)
1432 Lisp_Object old_value;
1434 do_mouse_tracking = old_value;
1435 if (NILP (old_value))
1437 /* Redisplay may have been preempted because there was input
1438 available, and it assumes it will be called again after the
1439 input has been processed. If the only input available was
1440 the sort that we have just disabled, then we need to call
1441 redisplay. */
1442 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW))
1444 redisplay_preserve_echo_area (6);
1445 get_input_pending (&input_pending,
1446 READABLE_EVENTS_DO_TIMERS_NOW);
1449 return Qnil;
1452 DEFUN ("track-mouse", Ftrack_mouse, Strack_mouse, 0, UNEVALLED, 0,
1453 doc: /* Evaluate BODY with mouse movement events enabled.
1454 Within a `track-mouse' form, mouse motion generates input events that
1455 you can read with `read-event'.
1456 Normally, mouse motion is ignored.
1457 usage: (track-mouse BODY...) */)
1458 (args)
1459 Lisp_Object args;
1461 int count = SPECPDL_INDEX ();
1462 Lisp_Object val;
1464 record_unwind_protect (tracking_off, do_mouse_tracking);
1466 do_mouse_tracking = Qt;
1468 val = Fprogn (args);
1469 return unbind_to (count, val);
1472 /* If mouse has moved on some frame, return one of those frames.
1474 Return 0 otherwise.
1476 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1477 after resizing the tool-bar window. */
1479 int ignore_mouse_drag_p;
1481 static FRAME_PTR
1482 some_mouse_moved ()
1484 Lisp_Object tail, frame;
1486 if (ignore_mouse_drag_p)
1488 /* ignore_mouse_drag_p = 0; */
1489 return 0;
1492 FOR_EACH_FRAME (tail, frame)
1494 if (XFRAME (frame)->mouse_moved)
1495 return XFRAME (frame);
1498 return 0;
1501 #endif /* HAVE_MOUSE || HAVE_GPM */
1503 /* This is the actual command reading loop,
1504 sans error-handling encapsulation. */
1506 static int read_key_sequence P_ ((Lisp_Object *, int, Lisp_Object,
1507 int, int, int));
1508 void safe_run_hooks P_ ((Lisp_Object));
1509 static void adjust_point_for_property P_ ((int, int));
1511 /* Cancel hourglass from protect_unwind.
1512 ARG is not used. */
1513 #ifdef HAVE_WINDOW_SYSTEM
1514 static Lisp_Object
1515 cancel_hourglass_unwind (arg)
1516 Lisp_Object arg;
1518 cancel_hourglass ();
1519 return Qnil;
1521 #endif
1523 extern int nonundocount; /* Declared in cmds.c. */
1525 Lisp_Object
1526 command_loop_1 ()
1528 Lisp_Object cmd;
1529 int lose;
1530 Lisp_Object keybuf[30];
1531 int i;
1532 int prev_modiff = 0;
1533 struct buffer *prev_buffer = NULL;
1534 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1535 int was_locked = single_kboard;
1536 #endif
1537 int already_adjusted = 0;
1539 current_kboard->Vprefix_arg = Qnil;
1540 current_kboard->Vlast_prefix_arg = Qnil;
1541 Vdeactivate_mark = Qnil;
1542 waiting_for_input = 0;
1543 cancel_echoing ();
1545 this_command_key_count = 0;
1546 this_command_key_count_reset = 0;
1547 this_single_command_key_start = 0;
1549 if (NILP (Vmemory_full))
1551 /* Make sure this hook runs after commands that get errors and
1552 throw to top level. */
1553 /* Note that the value cell will never directly contain nil
1554 if the symbol is a local variable. */
1555 if (!NILP (Vpost_command_hook) && !NILP (Vrun_hooks))
1556 safe_run_hooks (Qpost_command_hook);
1558 /* If displaying a message, resize the echo area window to fit
1559 that message's size exactly. */
1560 if (!NILP (echo_area_buffer[0]))
1561 resize_echo_area_exactly ();
1563 if (!NILP (Vdeferred_action_list))
1564 safe_run_hooks (Qdeferred_action_function);
1567 /* Do this after running Vpost_command_hook, for consistency. */
1568 current_kboard->Vlast_command = Vthis_command;
1569 current_kboard->Vreal_last_command = real_this_command;
1570 if (!CONSP (last_command_event))
1571 current_kboard->Vlast_repeatable_command = real_this_command;
1573 while (1)
1575 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
1576 Fkill_emacs (Qnil);
1578 /* Make sure the current window's buffer is selected. */
1579 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
1580 set_buffer_internal (XBUFFER (XWINDOW (selected_window)->buffer));
1582 /* Display any malloc warning that just came out. Use while because
1583 displaying one warning can cause another. */
1585 while (pending_malloc_warning)
1586 display_malloc_warning ();
1588 Vdeactivate_mark = Qnil;
1590 /* If minibuffer on and echo area in use,
1591 wait a short time and redraw minibuffer. */
1593 if (minibuf_level
1594 && !NILP (echo_area_buffer[0])
1595 && EQ (minibuf_window, echo_area_window)
1596 && NUMBERP (Vminibuffer_message_timeout))
1598 /* Bind inhibit-quit to t so that C-g gets read in
1599 rather than quitting back to the minibuffer. */
1600 int count = SPECPDL_INDEX ();
1601 specbind (Qinhibit_quit, Qt);
1603 sit_for (Vminibuffer_message_timeout, 0, 2);
1605 /* Clear the echo area. */
1606 message2 (0, 0, 0);
1607 safe_run_hooks (Qecho_area_clear_hook);
1609 unbind_to (count, Qnil);
1611 /* If a C-g came in before, treat it as input now. */
1612 if (!NILP (Vquit_flag))
1614 Vquit_flag = Qnil;
1615 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
1619 #if 0
1620 /* Select the frame that the last event came from. Usually,
1621 switch-frame events will take care of this, but if some lisp
1622 code swallows a switch-frame event, we'll fix things up here.
1623 Is this a good idea? */
1624 if (FRAMEP (internal_last_event_frame)
1625 && !EQ (internal_last_event_frame, selected_frame))
1626 Fselect_frame (internal_last_event_frame, Qnil);
1627 #endif
1628 /* If it has changed current-menubar from previous value,
1629 really recompute the menubar from the value. */
1630 if (! NILP (Vlucid_menu_bar_dirty_flag)
1631 && !NILP (Ffboundp (Qrecompute_lucid_menubar)))
1632 call0 (Qrecompute_lucid_menubar);
1634 before_command_key_count = this_command_key_count;
1635 before_command_echo_length = echo_length ();
1637 Vthis_command = Qnil;
1638 real_this_command = Qnil;
1639 Vthis_original_command = Qnil;
1640 Vthis_command_keys_shift_translated = Qnil;
1642 /* Read next key sequence; i gets its length. */
1643 i = read_key_sequence (keybuf, sizeof keybuf / sizeof keybuf[0],
1644 Qnil, 0, 1, 1);
1646 /* A filter may have run while we were reading the input. */
1647 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
1648 Fkill_emacs (Qnil);
1649 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
1650 set_buffer_internal (XBUFFER (XWINDOW (selected_window)->buffer));
1652 ++num_input_keys;
1654 /* Now we have read a key sequence of length I,
1655 or else I is 0 and we found end of file. */
1657 if (i == 0) /* End of file -- happens only in */
1658 return Qnil; /* a kbd macro, at the end. */
1659 /* -1 means read_key_sequence got a menu that was rejected.
1660 Just loop around and read another command. */
1661 if (i == -1)
1663 cancel_echoing ();
1664 this_command_key_count = 0;
1665 this_command_key_count_reset = 0;
1666 this_single_command_key_start = 0;
1667 goto finalize;
1670 last_command_event = keybuf[i - 1];
1672 /* If the previous command tried to force a specific window-start,
1673 forget about that, in case this command moves point far away
1674 from that position. But also throw away beg_unchanged and
1675 end_unchanged information in that case, so that redisplay will
1676 update the whole window properly. */
1677 if (!NILP (XWINDOW (selected_window)->force_start))
1679 struct buffer *b;
1680 XWINDOW (selected_window)->force_start = Qnil;
1681 b = XBUFFER (XWINDOW (selected_window)->buffer);
1682 BUF_BEG_UNCHANGED (b) = BUF_END_UNCHANGED (b) = 0;
1685 cmd = read_key_sequence_cmd;
1686 if (!NILP (Vexecuting_kbd_macro))
1688 if (!NILP (Vquit_flag))
1690 Vexecuting_kbd_macro = Qt;
1691 QUIT; /* Make some noise. */
1692 /* Will return since macro now empty. */
1696 /* Do redisplay processing after this command except in special
1697 cases identified below. */
1698 prev_buffer = current_buffer;
1699 prev_modiff = MODIFF;
1700 last_point_position = PT;
1701 last_point_position_window = selected_window;
1702 XSETBUFFER (last_point_position_buffer, prev_buffer);
1704 /* By default, we adjust point to a boundary of a region that
1705 has such a property that should be treated intangible
1706 (e.g. composition, display). But, some commands will set
1707 this variable differently. */
1708 Vdisable_point_adjustment = Qnil;
1710 /* Process filters and timers may have messed with deactivate-mark.
1711 reset it before we execute the command. */
1712 Vdeactivate_mark = Qnil;
1714 /* Remap command through active keymaps */
1715 Vthis_original_command = cmd;
1716 if (SYMBOLP (cmd))
1718 Lisp_Object cmd1;
1719 if (cmd1 = Fcommand_remapping (cmd, Qnil, Qnil), !NILP (cmd1))
1720 cmd = cmd1;
1723 /* Execute the command. */
1725 Vthis_command = cmd;
1726 real_this_command = cmd;
1727 /* Note that the value cell will never directly contain nil
1728 if the symbol is a local variable. */
1729 if (!NILP (Vpre_command_hook) && !NILP (Vrun_hooks))
1730 safe_run_hooks (Qpre_command_hook);
1732 already_adjusted = 0;
1734 if (NILP (Vthis_command))
1736 /* nil means key is undefined. */
1737 Lisp_Object keys = Fvector (i, keybuf);
1738 keys = Fkey_description (keys, Qnil);
1739 bitch_at_user ();
1740 message_with_string ("%s is undefined", keys, 0);
1741 current_kboard->defining_kbd_macro = Qnil;
1742 update_mode_lines = 1;
1743 current_kboard->Vprefix_arg = Qnil;
1745 else
1747 if (NILP (current_kboard->Vprefix_arg))
1749 /* In case we jump to directly_done. */
1750 Vcurrent_prefix_arg = current_kboard->Vprefix_arg;
1752 /* Recognize some common commands in common situations and
1753 do them directly. */
1754 if (EQ (Vthis_command, Qforward_char) && PT < ZV
1755 && NILP (Vthis_command_keys_shift_translated)
1756 && !CONSP (Vtransient_mark_mode))
1758 struct Lisp_Char_Table *dp
1759 = window_display_table (XWINDOW (selected_window));
1760 lose = FETCH_CHAR (PT_BYTE);
1761 SET_PT (PT + 1);
1762 if (! NILP (Vpost_command_hook))
1763 /* Put this before calling adjust_point_for_property
1764 so it will only get called once in any case. */
1765 goto directly_done;
1766 if (current_buffer == prev_buffer
1767 && last_point_position != PT
1768 && NILP (Vdisable_point_adjustment)
1769 && NILP (Vglobal_disable_point_adjustment))
1770 adjust_point_for_property (last_point_position, 0);
1771 already_adjusted = 1;
1772 if (PT == last_point_position + 1
1773 && (dp
1774 ? (VECTORP (DISP_CHAR_VECTOR (dp, lose))
1775 ? XVECTOR (DISP_CHAR_VECTOR (dp, lose))->size == 1
1776 : (NILP (DISP_CHAR_VECTOR (dp, lose))
1777 && (lose >= 0x20 && lose < 0x7f)))
1778 : (lose >= 0x20 && lose < 0x7f))
1779 /* To extract the case of continuation on
1780 wide-column characters. */
1781 && ASCII_BYTE_P (lose)
1782 && (XFASTINT (XWINDOW (selected_window)->last_modified)
1783 >= MODIFF)
1784 && (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1785 >= OVERLAY_MODIFF)
1786 && (XFASTINT (XWINDOW (selected_window)->last_point)
1787 == PT - 1)
1788 && !windows_or_buffers_changed
1789 && EQ (current_buffer->selective_display, Qnil)
1790 && !detect_input_pending ()
1791 && NILP (XWINDOW (selected_window)->column_number_displayed)
1792 && NILP (Vexecuting_kbd_macro))
1793 direct_output_forward_char (1);
1794 goto directly_done;
1796 else if (EQ (Vthis_command, Qbackward_char) && PT > BEGV
1797 && NILP (Vthis_command_keys_shift_translated)
1798 && !CONSP (Vtransient_mark_mode))
1800 struct Lisp_Char_Table *dp
1801 = window_display_table (XWINDOW (selected_window));
1802 SET_PT (PT - 1);
1803 lose = FETCH_CHAR (PT_BYTE);
1804 if (! NILP (Vpost_command_hook))
1805 goto directly_done;
1806 if (current_buffer == prev_buffer
1807 && last_point_position != PT
1808 && NILP (Vdisable_point_adjustment)
1809 && NILP (Vglobal_disable_point_adjustment))
1810 adjust_point_for_property (last_point_position, 0);
1811 already_adjusted = 1;
1812 if (PT == last_point_position - 1
1813 && (dp
1814 ? (VECTORP (DISP_CHAR_VECTOR (dp, lose))
1815 ? XVECTOR (DISP_CHAR_VECTOR (dp, lose))->size == 1
1816 : (NILP (DISP_CHAR_VECTOR (dp, lose))
1817 && (lose >= 0x20 && lose < 0x7f)))
1818 : (lose >= 0x20 && lose < 0x7f))
1819 && (XFASTINT (XWINDOW (selected_window)->last_modified)
1820 >= MODIFF)
1821 && (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1822 >= OVERLAY_MODIFF)
1823 && (XFASTINT (XWINDOW (selected_window)->last_point)
1824 == PT + 1)
1825 && !windows_or_buffers_changed
1826 && EQ (current_buffer->selective_display, Qnil)
1827 && !detect_input_pending ()
1828 && NILP (XWINDOW (selected_window)->column_number_displayed)
1829 && NILP (Vexecuting_kbd_macro))
1830 direct_output_forward_char (-1);
1831 goto directly_done;
1833 else if (EQ (Vthis_command, Qself_insert_command)
1834 /* Try this optimization only on char keystrokes. */
1835 && NATNUMP (last_command_event)
1836 && CHAR_VALID_P (XFASTINT (last_command_event), 0))
1838 unsigned int c
1839 = translate_char (Vtranslation_table_for_input,
1840 XFASTINT (last_command_event));
1841 int value;
1842 if (NILP (Vexecuting_kbd_macro)
1843 && !EQ (minibuf_window, selected_window))
1845 if (!nonundocount || nonundocount >= 20)
1847 Fundo_boundary ();
1848 nonundocount = 0;
1850 nonundocount++;
1853 lose = ((XFASTINT (XWINDOW (selected_window)->last_modified)
1854 < MODIFF)
1855 || (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1856 < OVERLAY_MODIFF)
1857 || (XFASTINT (XWINDOW (selected_window)->last_point)
1858 != PT)
1859 || MODIFF <= SAVE_MODIFF
1860 || windows_or_buffers_changed
1861 || !EQ (current_buffer->selective_display, Qnil)
1862 || detect_input_pending ()
1863 || !NILP (XWINDOW (selected_window)->column_number_displayed)
1864 || !NILP (Vexecuting_kbd_macro));
1866 value = internal_self_insert (c, 0);
1868 if (value == 2)
1869 nonundocount = 0;
1871 frame_make_pointer_invisible ();
1873 if (! NILP (Vpost_command_hook))
1874 /* Put this before calling adjust_point_for_property
1875 so it will only get called once in any case. */
1876 goto directly_done;
1878 /* VALUE == 1 when AFTER-CHANGE functions are
1879 installed which is the case most of the time
1880 because FONT-LOCK installs one. */
1881 if (!lose && !value)
1882 direct_output_for_insert (c);
1883 goto directly_done;
1887 /* Here for a command that isn't executed directly */
1890 #ifdef HAVE_WINDOW_SYSTEM
1891 int scount = SPECPDL_INDEX ();
1893 if (display_hourglass_p
1894 && NILP (Vexecuting_kbd_macro))
1896 record_unwind_protect (cancel_hourglass_unwind, Qnil);
1897 start_hourglass ();
1899 #endif
1901 nonundocount = 0;
1902 if (NILP (current_kboard->Vprefix_arg)) /* FIXME: Why? --Stef */
1903 Fundo_boundary ();
1904 Fcommand_execute (Vthis_command, Qnil, Qnil, Qnil);
1906 #ifdef HAVE_WINDOW_SYSTEM
1907 /* Do not check display_hourglass_p here, because
1908 Fcommand_execute could change it, but we should cancel
1909 hourglass cursor anyway.
1910 But don't cancel the hourglass within a macro
1911 just because a command in the macro finishes. */
1912 if (NILP (Vexecuting_kbd_macro))
1913 unbind_to (scount, Qnil);
1914 #endif
1917 directly_done: ;
1918 current_kboard->Vlast_prefix_arg = Vcurrent_prefix_arg;
1920 /* Note that the value cell will never directly contain nil
1921 if the symbol is a local variable. */
1922 if (!NILP (Vpost_command_hook) && !NILP (Vrun_hooks))
1923 safe_run_hooks (Qpost_command_hook);
1925 /* If displaying a message, resize the echo area window to fit
1926 that message's size exactly. */
1927 if (!NILP (echo_area_buffer[0]))
1928 resize_echo_area_exactly ();
1930 if (!NILP (Vdeferred_action_list))
1931 safe_run_hooks (Qdeferred_action_function);
1933 /* If there is a prefix argument,
1934 1) We don't want Vlast_command to be ``universal-argument''
1935 (that would be dumb), so don't set Vlast_command,
1936 2) we want to leave echoing on so that the prefix will be
1937 echoed as part of this key sequence, so don't call
1938 cancel_echoing, and
1939 3) we want to leave this_command_key_count non-zero, so that
1940 read_char will realize that it is re-reading a character, and
1941 not echo it a second time.
1943 If the command didn't actually create a prefix arg,
1944 but is merely a frame event that is transparent to prefix args,
1945 then the above doesn't apply. */
1946 if (NILP (current_kboard->Vprefix_arg) || CONSP (last_command_event))
1948 current_kboard->Vlast_command = Vthis_command;
1949 current_kboard->Vreal_last_command = real_this_command;
1950 if (!CONSP (last_command_event))
1951 current_kboard->Vlast_repeatable_command = real_this_command;
1952 cancel_echoing ();
1953 this_command_key_count = 0;
1954 this_command_key_count_reset = 0;
1955 this_single_command_key_start = 0;
1958 if (!NILP (current_buffer->mark_active) && !NILP (Vrun_hooks))
1960 /* In Emacs 22, setting transient-mark-mode to `only' was a
1961 way of turning it on for just one command. This usage is
1962 obsolete, but support it anyway. */
1963 if (EQ (Vtransient_mark_mode, Qidentity))
1964 Vtransient_mark_mode = Qnil;
1965 else if (EQ (Vtransient_mark_mode, Qonly))
1966 Vtransient_mark_mode = Qidentity;
1968 if (!NILP (Vdeactivate_mark))
1969 call0 (Qdeactivate_mark);
1970 else if (current_buffer != prev_buffer || MODIFF != prev_modiff)
1971 call1 (Vrun_hooks, intern ("activate-mark-hook"));
1974 finalize:
1976 if (current_buffer == prev_buffer
1977 && last_point_position != PT
1978 && NILP (Vdisable_point_adjustment)
1979 && NILP (Vglobal_disable_point_adjustment))
1981 if (last_point_position > BEGV
1982 && last_point_position < ZV
1983 && (composition_adjust_point (last_point_position,
1984 last_point_position)
1985 != last_point_position))
1986 /* The last point was temporarily set within a grapheme
1987 cluster to prevent automatic composition. To recover
1988 the automatic composition, we must update the
1989 display. */
1990 windows_or_buffers_changed++;
1991 if (!already_adjusted)
1992 adjust_point_for_property (last_point_position,
1993 MODIFF != prev_modiff);
1996 /* Install chars successfully executed in kbd macro. */
1998 if (!NILP (current_kboard->defining_kbd_macro)
1999 && NILP (current_kboard->Vprefix_arg))
2000 finalize_kbd_macro_chars ();
2001 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2002 if (!was_locked)
2003 any_kboard_state ();
2004 #endif
2008 extern Lisp_Object Qcomposition, Qdisplay;
2010 /* Adjust point to a boundary of a region that has such a property
2011 that should be treated intangible. For the moment, we check
2012 `composition', `display' and `invisible' properties.
2013 LAST_PT is the last position of point. */
2015 extern Lisp_Object Qafter_string, Qbefore_string;
2016 extern Lisp_Object get_pos_property P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
2018 static void
2019 adjust_point_for_property (last_pt, modified)
2020 int last_pt;
2021 int modified;
2023 EMACS_INT beg, end;
2024 Lisp_Object val, overlay, tmp;
2025 /* When called after buffer modification, we should temporarily
2026 suppress the point adjustment for automatic composition so that a
2027 user can keep inserting another character at point or keep
2028 deleting characters around point. */
2029 int check_composition = ! modified, check_display = 1, check_invisible = 1;
2030 int orig_pt = PT;
2032 /* FIXME: cycling is probably not necessary because these properties
2033 can't be usefully combined anyway. */
2034 while (check_composition || check_display || check_invisible)
2036 /* FIXME: check `intangible'. */
2037 if (check_composition
2038 && PT > BEGV && PT < ZV
2039 && (beg = composition_adjust_point (last_pt, PT)) != PT)
2041 SET_PT (beg);
2042 check_display = check_invisible = 1;
2044 check_composition = 0;
2045 if (check_display
2046 && PT > BEGV && PT < ZV
2047 && !NILP (val = get_char_property_and_overlay
2048 (make_number (PT), Qdisplay, Qnil, &overlay))
2049 && display_prop_intangible_p (val)
2050 && (!OVERLAYP (overlay)
2051 ? get_property_and_range (PT, Qdisplay, &val, &beg, &end, Qnil)
2052 : (beg = OVERLAY_POSITION (OVERLAY_START (overlay)),
2053 end = OVERLAY_POSITION (OVERLAY_END (overlay))))
2054 && (beg < PT /* && end > PT <- It's always the case. */
2055 || (beg <= PT && STRINGP (val) && SCHARS (val) == 0)))
2057 xassert (end > PT);
2058 SET_PT (PT < last_pt
2059 ? (STRINGP (val) && SCHARS (val) == 0 ? beg - 1 : beg)
2060 : end);
2061 check_composition = check_invisible = 1;
2063 check_display = 0;
2064 if (check_invisible && PT > BEGV && PT < ZV)
2066 int inv, ellipsis = 0;
2067 beg = end = PT;
2069 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2070 while (end < ZV
2071 #if 0
2072 /* FIXME: We should stop if we find a spot between
2073 two runs of `invisible' where inserted text would
2074 be visible. This is important when we have two
2075 invisible boundaries that enclose an area: if the
2076 area is empty, we need this test in order to make
2077 it possible to place point in the middle rather
2078 than skip both boundaries. However, this code
2079 also stops anywhere in a non-sticky text-property,
2080 which breaks (e.g.) Org mode. */
2081 && (val = get_pos_property (make_number (end),
2082 Qinvisible, Qnil),
2083 TEXT_PROP_MEANS_INVISIBLE (val))
2084 #endif
2085 && !NILP (val = get_char_property_and_overlay
2086 (make_number (end), Qinvisible, Qnil, &overlay))
2087 && (inv = TEXT_PROP_MEANS_INVISIBLE (val)))
2089 ellipsis = ellipsis || inv > 1
2090 || (OVERLAYP (overlay)
2091 && (!NILP (Foverlay_get (overlay, Qafter_string))
2092 || !NILP (Foverlay_get (overlay, Qbefore_string))));
2093 tmp = Fnext_single_char_property_change
2094 (make_number (end), Qinvisible, Qnil, Qnil);
2095 end = NATNUMP (tmp) ? XFASTINT (tmp) : ZV;
2097 while (beg > BEGV
2098 #if 0
2099 && (val = get_pos_property (make_number (beg),
2100 Qinvisible, Qnil),
2101 TEXT_PROP_MEANS_INVISIBLE (val))
2102 #endif
2103 && !NILP (val = get_char_property_and_overlay
2104 (make_number (beg - 1), Qinvisible, Qnil, &overlay))
2105 && (inv = TEXT_PROP_MEANS_INVISIBLE (val)))
2107 ellipsis = ellipsis || inv > 1
2108 || (OVERLAYP (overlay)
2109 && (!NILP (Foverlay_get (overlay, Qafter_string))
2110 || !NILP (Foverlay_get (overlay, Qbefore_string))));
2111 tmp = Fprevious_single_char_property_change
2112 (make_number (beg), Qinvisible, Qnil, Qnil);
2113 beg = NATNUMP (tmp) ? XFASTINT (tmp) : BEGV;
2116 /* Move away from the inside area. */
2117 if (beg < PT && end > PT)
2119 SET_PT ((orig_pt == PT && (last_pt < beg || last_pt > end))
2120 /* We haven't moved yet (so we don't need to fear
2121 infinite-looping) and we were outside the range
2122 before (so either end of the range still corresponds
2123 to a move in the right direction): pretend we moved
2124 less than we actually did, so that we still have
2125 more freedom below in choosing which end of the range
2126 to go to. */
2127 ? (orig_pt = -1, PT < last_pt ? end : beg)
2128 /* We either have moved already or the last point
2129 was already in the range: we don't get to choose
2130 which end of the range we have to go to. */
2131 : (PT < last_pt ? beg : end));
2132 check_composition = check_display = 1;
2134 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2135 the point to something other than its argument, due to
2136 point-motion hooks, intangibility, etc. */
2137 xassert (PT == beg || PT == end);
2138 #endif
2140 /* Pretend the area doesn't exist if the buffer is not
2141 modified. */
2142 if (!modified && !ellipsis && beg < end)
2144 if (last_pt == beg && PT == end && end < ZV)
2145 (check_composition = check_display = 1, SET_PT (end + 1));
2146 else if (last_pt == end && PT == beg && beg > BEGV)
2147 (check_composition = check_display = 1, SET_PT (beg - 1));
2148 else if (PT == ((PT < last_pt) ? beg : end))
2149 /* We've already moved as far as we can. Trying to go
2150 to the other end would mean moving backwards and thus
2151 could lead to an infinite loop. */
2153 else if (val = get_pos_property (make_number (PT),
2154 Qinvisible, Qnil),
2155 TEXT_PROP_MEANS_INVISIBLE (val)
2156 && (val = get_pos_property
2157 (make_number (PT == beg ? end : beg),
2158 Qinvisible, Qnil),
2159 !TEXT_PROP_MEANS_INVISIBLE (val)))
2160 (check_composition = check_display = 1,
2161 SET_PT (PT == beg ? end : beg));
2164 check_invisible = 0;
2168 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2170 static Lisp_Object
2171 safe_run_hooks_1 (hook)
2172 Lisp_Object hook;
2174 if (NILP (Vrun_hooks))
2175 return Qnil;
2176 return call1 (Vrun_hooks, Vinhibit_quit);
2179 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2181 static Lisp_Object
2182 safe_run_hooks_error (data)
2183 Lisp_Object data;
2185 Lisp_Object args[3];
2186 args[0] = build_string ("Error in %s: %s");
2187 args[1] = Vinhibit_quit;
2188 args[2] = data;
2189 Fmessage (3, args);
2190 return Fset (Vinhibit_quit, Qnil);
2193 /* If we get an error while running the hook, cause the hook variable
2194 to be nil. Also inhibit quits, so that C-g won't cause the hook
2195 to mysteriously evaporate. */
2197 void
2198 safe_run_hooks (hook)
2199 Lisp_Object hook;
2201 int count = SPECPDL_INDEX ();
2202 specbind (Qinhibit_quit, hook);
2204 internal_condition_case (safe_run_hooks_1, Qt, safe_run_hooks_error);
2206 unbind_to (count, Qnil);
2210 /* Number of seconds between polling for input. This is a Lisp
2211 variable that can be bound. */
2213 EMACS_INT polling_period;
2215 /* Nonzero means polling for input is temporarily suppressed. */
2217 int poll_suppress_count;
2219 /* Asynchronous timer for polling. */
2221 struct atimer *poll_timer;
2224 #ifdef POLL_FOR_INPUT
2226 /* Poll for input, so that we catch a C-g if it comes in. This
2227 function is called from x_make_frame_visible, see comment
2228 there. */
2230 void
2231 poll_for_input_1 ()
2233 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
2234 doing anything dangerous. */
2235 #ifdef HAVE_NS
2236 ++handling_signal;
2237 #endif
2238 if (interrupt_input_blocked == 0
2239 && !waiting_for_input)
2240 read_avail_input (0);
2241 #ifdef HAVE_NS
2242 --handling_signal;
2243 #endif
2246 /* Timer callback function for poll_timer. TIMER is equal to
2247 poll_timer. */
2249 void
2250 poll_for_input (timer)
2251 struct atimer *timer;
2253 if (poll_suppress_count == 0)
2255 #ifdef SYNC_INPUT
2256 interrupt_input_pending = 1;
2257 pending_signals = 1;
2258 #else
2259 poll_for_input_1 ();
2260 #endif
2264 #endif /* POLL_FOR_INPUT */
2266 /* Begin signals to poll for input, if they are appropriate.
2267 This function is called unconditionally from various places. */
2269 void
2270 start_polling ()
2272 #ifdef POLL_FOR_INPUT
2273 /* XXX This condition was (read_socket_hook && !interrupt_input),
2274 but read_socket_hook is not global anymore. Let's pretend that
2275 it's always set. */
2276 if (!interrupt_input)
2278 /* Turn alarm handling on unconditionally. It might have
2279 been turned off in process.c. */
2280 turn_on_atimers (1);
2282 /* If poll timer doesn't exist, are we need one with
2283 a different interval, start a new one. */
2284 if (poll_timer == NULL
2285 || EMACS_SECS (poll_timer->interval) != polling_period)
2287 EMACS_TIME interval;
2289 if (poll_timer)
2290 cancel_atimer (poll_timer);
2292 EMACS_SET_SECS_USECS (interval, polling_period, 0);
2293 poll_timer = start_atimer (ATIMER_CONTINUOUS, interval,
2294 poll_for_input, NULL);
2297 /* Let the timer's callback function poll for input
2298 if this becomes zero. */
2299 --poll_suppress_count;
2301 #endif
2304 /* Nonzero if we are using polling to handle input asynchronously. */
2307 input_polling_used ()
2309 #ifdef POLL_FOR_INPUT
2310 /* XXX This condition was (read_socket_hook && !interrupt_input),
2311 but read_socket_hook is not global anymore. Let's pretend that
2312 it's always set. */
2313 return !interrupt_input;
2314 #else
2315 return 0;
2316 #endif
2319 /* Turn off polling. */
2321 void
2322 stop_polling ()
2324 #ifdef POLL_FOR_INPUT
2325 /* XXX This condition was (read_socket_hook && !interrupt_input),
2326 but read_socket_hook is not global anymore. Let's pretend that
2327 it's always set. */
2328 if (!interrupt_input)
2329 ++poll_suppress_count;
2330 #endif
2333 /* Set the value of poll_suppress_count to COUNT
2334 and start or stop polling accordingly. */
2336 void
2337 set_poll_suppress_count (count)
2338 int count;
2340 #ifdef POLL_FOR_INPUT
2341 if (count == 0 && poll_suppress_count != 0)
2343 poll_suppress_count = 1;
2344 start_polling ();
2346 else if (count != 0 && poll_suppress_count == 0)
2348 stop_polling ();
2350 poll_suppress_count = count;
2351 #endif
2354 /* Bind polling_period to a value at least N.
2355 But don't decrease it. */
2357 void
2358 bind_polling_period (n)
2359 int n;
2361 #ifdef POLL_FOR_INPUT
2362 int new = polling_period;
2364 if (n > new)
2365 new = n;
2367 stop_other_atimers (poll_timer);
2368 stop_polling ();
2369 specbind (Qpolling_period, make_number (new));
2370 /* Start a new alarm with the new period. */
2371 start_polling ();
2372 #endif
2375 /* Apply the control modifier to CHARACTER. */
2378 make_ctrl_char (c)
2379 int c;
2381 /* Save the upper bits here. */
2382 int upper = c & ~0177;
2384 if (! ASCII_BYTE_P (c))
2385 return c |= ctrl_modifier;
2387 c &= 0177;
2389 /* Everything in the columns containing the upper-case letters
2390 denotes a control character. */
2391 if (c >= 0100 && c < 0140)
2393 int oc = c;
2394 c &= ~0140;
2395 /* Set the shift modifier for a control char
2396 made from a shifted letter. But only for letters! */
2397 if (oc >= 'A' && oc <= 'Z')
2398 c |= shift_modifier;
2401 /* The lower-case letters denote control characters too. */
2402 else if (c >= 'a' && c <= 'z')
2403 c &= ~0140;
2405 /* Include the bits for control and shift
2406 only if the basic ASCII code can't indicate them. */
2407 else if (c >= ' ')
2408 c |= ctrl_modifier;
2410 /* Replace the high bits. */
2411 c |= (upper & ~ctrl_modifier);
2413 return c;
2416 /* Display the help-echo property of the character after the mouse pointer.
2417 Either show it in the echo area, or call show-help-function to display
2418 it by other means (maybe in a tooltip).
2420 If HELP is nil, that means clear the previous help echo.
2422 If HELP is a string, display that string. If HELP is a function,
2423 call it with OBJECT and POS as arguments; the function should
2424 return a help string or nil for none. For all other types of HELP,
2425 evaluate it to obtain a string.
2427 WINDOW is the window in which the help was generated, if any.
2428 It is nil if not in a window.
2430 If OBJECT is a buffer, POS is the position in the buffer where the
2431 `help-echo' text property was found.
2433 If OBJECT is an overlay, that overlay has a `help-echo' property,
2434 and POS is the position in the overlay's buffer under the mouse.
2436 If OBJECT is a string (an overlay string or a string displayed with
2437 the `display' property). POS is the position in that string under
2438 the mouse.
2440 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2441 echo overwrites a keystroke echo currently displayed in the echo
2442 area.
2444 Note: this function may only be called with HELP nil or a string
2445 from X code running asynchronously. */
2447 void
2448 show_help_echo (help, window, object, pos, ok_to_overwrite_keystroke_echo)
2449 Lisp_Object help, window, object, pos;
2450 int ok_to_overwrite_keystroke_echo;
2452 if (!NILP (help) && !STRINGP (help))
2454 if (FUNCTIONP (help))
2456 Lisp_Object args[4];
2457 args[0] = help;
2458 args[1] = window;
2459 args[2] = object;
2460 args[3] = pos;
2461 help = safe_call (4, args);
2463 else
2464 help = safe_eval (help);
2466 if (!STRINGP (help))
2467 return;
2470 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2471 if (!noninteractive && STRINGP (help))
2473 /* The mouse-fixup-help-message Lisp function can call
2474 mouse_position_hook, which resets the mouse_moved flags.
2475 This causes trouble if we are trying to read a mouse motion
2476 event (i.e., if we are inside a `track-mouse' form), so we
2477 restore the mouse_moved flag. */
2478 FRAME_PTR f = NILP (do_mouse_tracking) ? NULL : some_mouse_moved ();
2479 help = call1 (Qmouse_fixup_help_message, help);
2480 if (f)
2481 f->mouse_moved = 1;
2483 #endif
2485 if (STRINGP (help) || NILP (help))
2487 if (!NILP (Vshow_help_function))
2488 call1 (Vshow_help_function, help);
2489 help_echo_showing_p = STRINGP (help);
2495 /* Input of single characters from keyboard */
2497 Lisp_Object print_help ();
2498 static Lisp_Object kbd_buffer_get_event ();
2499 static void record_char ();
2501 static Lisp_Object help_form_saved_window_configs;
2502 static Lisp_Object
2503 read_char_help_form_unwind (Lisp_Object arg)
2505 Lisp_Object window_config = XCAR (help_form_saved_window_configs);
2506 help_form_saved_window_configs = XCDR (help_form_saved_window_configs);
2507 if (!NILP (window_config))
2508 Fset_window_configuration (window_config);
2509 return Qnil;
2512 #define STOP_POLLING \
2513 do { if (! polling_stopped_here) stop_polling (); \
2514 polling_stopped_here = 1; } while (0)
2516 #define RESUME_POLLING \
2517 do { if (polling_stopped_here) start_polling (); \
2518 polling_stopped_here = 0; } while (0)
2520 /* read a character from the keyboard; call the redisplay if needed */
2521 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2522 -1 means do not do redisplay, but do do autosaving.
2523 1 means do both. */
2525 /* The arguments MAPS and NMAPS are for menu prompting.
2526 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2528 PREV_EVENT is the previous input event, or nil if we are reading
2529 the first event of a key sequence (or not reading a key sequence).
2530 If PREV_EVENT is t, that is a "magic" value that says
2531 not to run input methods, but in other respects to act as if
2532 not reading a key sequence.
2534 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2535 if we used a mouse menu to read the input, or zero otherwise. If
2536 USED_MOUSE_MENU is null, we don't dereference it.
2538 Value is -2 when we find input on another keyboard. A second call
2539 to read_char will read it.
2541 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2542 specifying the maximum time to wait until. If no input arrives by
2543 that time, stop waiting and return nil.
2545 Value is t if we showed a menu and the user rejected it. */
2547 Lisp_Object
2548 read_char (commandflag, nmaps, maps, prev_event, used_mouse_menu, end_time)
2549 int commandflag;
2550 int nmaps;
2551 Lisp_Object *maps;
2552 Lisp_Object prev_event;
2553 int *used_mouse_menu;
2554 EMACS_TIME *end_time;
2556 volatile Lisp_Object c;
2557 int count, jmpcount;
2558 jmp_buf local_getcjmp;
2559 jmp_buf save_jump;
2560 volatile int key_already_recorded = 0;
2561 Lisp_Object tem, save;
2562 volatile Lisp_Object previous_echo_area_message;
2563 volatile Lisp_Object also_record;
2564 volatile int reread;
2565 struct gcpro gcpro1, gcpro2;
2566 int polling_stopped_here = 0;
2567 struct kboard *orig_kboard = current_kboard;
2569 also_record = Qnil;
2571 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2572 before_command_key_count = this_command_key_count;
2573 before_command_echo_length = echo_length ();
2574 #endif
2575 c = Qnil;
2576 previous_echo_area_message = Qnil;
2578 GCPRO2 (c, previous_echo_area_message);
2580 retry:
2582 reread = 0;
2583 if (CONSP (Vunread_post_input_method_events))
2585 c = XCAR (Vunread_post_input_method_events);
2586 Vunread_post_input_method_events
2587 = XCDR (Vunread_post_input_method_events);
2589 /* Undo what read_char_x_menu_prompt did when it unread
2590 additional keys returned by Fx_popup_menu. */
2591 if (CONSP (c)
2592 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c)))
2593 && NILP (XCDR (c)))
2594 c = XCAR (c);
2596 reread = 1;
2597 goto reread_first;
2600 if (unread_command_char != -1)
2602 XSETINT (c, unread_command_char);
2603 unread_command_char = -1;
2605 reread = 1;
2606 goto reread_first;
2609 if (CONSP (Vunread_command_events))
2611 int was_disabled = 0;
2613 c = XCAR (Vunread_command_events);
2614 Vunread_command_events = XCDR (Vunread_command_events);
2616 reread = 1;
2618 /* Undo what sit-for did when it unread additional keys
2619 inside universal-argument. */
2621 if (CONSP (c)
2622 && EQ (XCAR (c), Qt))
2624 reread = 0;
2625 c = XCDR (c);
2628 /* Undo what read_char_x_menu_prompt did when it unread
2629 additional keys returned by Fx_popup_menu. */
2630 if (CONSP (c)
2631 && EQ (XCDR (c), Qdisabled)
2632 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c))))
2634 was_disabled = 1;
2635 c = XCAR (c);
2638 /* If the queued event is something that used the mouse,
2639 set used_mouse_menu accordingly. */
2640 if (used_mouse_menu
2641 /* Also check was_disabled so last-nonmenu-event won't return
2642 a bad value when submenus are involved. (Bug#447) */
2643 && (EQ (c, Qtool_bar) || EQ (c, Qmenu_bar) || was_disabled))
2644 *used_mouse_menu = 1;
2646 goto reread_for_input_method;
2649 if (CONSP (Vunread_input_method_events))
2651 c = XCAR (Vunread_input_method_events);
2652 Vunread_input_method_events = XCDR (Vunread_input_method_events);
2654 /* Undo what read_char_x_menu_prompt did when it unread
2655 additional keys returned by Fx_popup_menu. */
2656 if (CONSP (c)
2657 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c)))
2658 && NILP (XCDR (c)))
2659 c = XCAR (c);
2660 reread = 1;
2661 goto reread_for_input_method;
2664 this_command_key_count_reset = 0;
2666 if (!NILP (Vexecuting_kbd_macro))
2668 /* We set this to Qmacro; since that's not a frame, nobody will
2669 try to switch frames on us, and the selected window will
2670 remain unchanged.
2672 Since this event came from a macro, it would be misleading to
2673 leave internal_last_event_frame set to wherever the last
2674 real event came from. Normally, a switch-frame event selects
2675 internal_last_event_frame after each command is read, but
2676 events read from a macro should never cause a new frame to be
2677 selected. */
2678 Vlast_event_frame = internal_last_event_frame = Qmacro;
2680 /* Exit the macro if we are at the end.
2681 Also, some things replace the macro with t
2682 to force an early exit. */
2683 if (EQ (Vexecuting_kbd_macro, Qt)
2684 || executing_kbd_macro_index >= XFASTINT (Flength (Vexecuting_kbd_macro)))
2686 XSETINT (c, -1);
2687 goto exit;
2690 c = Faref (Vexecuting_kbd_macro, make_number (executing_kbd_macro_index));
2691 if (STRINGP (Vexecuting_kbd_macro)
2692 && (XINT (c) & 0x80) && (XUINT (c) <= 0xff))
2693 XSETFASTINT (c, CHAR_META | (XINT (c) & ~0x80));
2695 executing_kbd_macro_index++;
2697 goto from_macro;
2700 if (!NILP (unread_switch_frame))
2702 c = unread_switch_frame;
2703 unread_switch_frame = Qnil;
2705 /* This event should make it into this_command_keys, and get echoed
2706 again, so we do not set `reread'. */
2707 goto reread_first;
2710 /* if redisplay was requested */
2711 if (commandflag >= 0)
2713 int echo_current = EQ (echo_message_buffer, echo_area_buffer[0]);
2715 /* If there is pending input, process any events which are not
2716 user-visible, such as X selection_request events. */
2717 if (input_pending
2718 || detect_input_pending_run_timers (0))
2719 swallow_events (0); /* may clear input_pending */
2721 /* Redisplay if no pending input. */
2722 while (!input_pending)
2724 if (help_echo_showing_p && !EQ (selected_window, minibuf_window))
2725 redisplay_preserve_echo_area (5);
2726 else
2727 redisplay ();
2729 if (!input_pending)
2730 /* Normal case: no input arrived during redisplay. */
2731 break;
2733 /* Input arrived and pre-empted redisplay.
2734 Process any events which are not user-visible. */
2735 swallow_events (0);
2736 /* If that cleared input_pending, try again to redisplay. */
2739 /* Prevent the redisplay we just did
2740 from messing up echoing of the input after the prompt. */
2741 if (commandflag == 0 && echo_current)
2742 echo_message_buffer = echo_area_buffer[0];
2746 /* Message turns off echoing unless more keystrokes turn it on again.
2748 The code in 20.x for the condition was
2750 1. echo_area_glyphs && *echo_area_glyphs
2751 2. && echo_area_glyphs != current_kboard->echobuf
2752 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2754 (1) means there's a current message displayed
2756 (2) means it's not the message from echoing from the current
2757 kboard.
2759 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2760 is set to a non-null value. This is done in read_char and it is
2761 set to echo_area_glyphs after a call to echo_char. That means
2762 ok_to_echo_at_next_pause is either null or
2763 current_kboard->echobuf with the appropriate current_kboard at
2764 that time.
2766 So, condition (3) means in clear text ok_to_echo_at_next_pause
2767 must be either null, or the current message isn't from echoing at
2768 all, or it's from echoing from a different kboard than the
2769 current one. */
2771 if (/* There currently is something in the echo area. */
2772 !NILP (echo_area_buffer[0])
2773 && (/* And it's either not from echoing. */
2774 !EQ (echo_area_buffer[0], echo_message_buffer)
2775 /* Or it's an echo from a different kboard. */
2776 || echo_kboard != current_kboard
2777 /* Or we explicitly allow overwriting whatever there is. */
2778 || ok_to_echo_at_next_pause == NULL))
2779 cancel_echoing ();
2780 else
2781 echo_dash ();
2783 /* Try reading a character via menu prompting in the minibuf.
2784 Try this before the sit-for, because the sit-for
2785 would do the wrong thing if we are supposed to do
2786 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2787 after a mouse event so don't try a minibuf menu. */
2788 c = Qnil;
2789 if (nmaps > 0 && INTERACTIVE
2790 && !NILP (prev_event) && ! EVENT_HAS_PARAMETERS (prev_event)
2791 /* Don't bring up a menu if we already have another event. */
2792 && NILP (Vunread_command_events)
2793 && unread_command_char < 0
2794 && !detect_input_pending_run_timers (0))
2796 c = read_char_minibuf_menu_prompt (commandflag, nmaps, maps);
2798 if (INTEGERP (c) && XINT (c) == -2)
2799 return c; /* wrong_kboard_jmpbuf */
2801 if (! NILP (c))
2803 key_already_recorded = 1;
2804 goto non_reread_1;
2808 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2809 We will do that below, temporarily for short sections of code,
2810 when appropriate. local_getcjmp must be in effect
2811 around any call to sit_for or kbd_buffer_get_event;
2812 it *must not* be in effect when we call redisplay. */
2814 jmpcount = SPECPDL_INDEX ();
2815 if (_setjmp (local_getcjmp))
2817 /* Handle quits while reading the keyboard. */
2818 /* We must have saved the outer value of getcjmp here,
2819 so restore it now. */
2820 restore_getcjmp (save_jump);
2821 unbind_to (jmpcount, Qnil);
2822 XSETINT (c, quit_char);
2823 internal_last_event_frame = selected_frame;
2824 Vlast_event_frame = internal_last_event_frame;
2825 /* If we report the quit char as an event,
2826 don't do so more than once. */
2827 if (!NILP (Vinhibit_quit))
2828 Vquit_flag = Qnil;
2831 KBOARD *kb = FRAME_KBOARD (XFRAME (selected_frame));
2832 if (kb != current_kboard)
2834 Lisp_Object link = kb->kbd_queue;
2835 /* We shouldn't get here if we were in single-kboard mode! */
2836 if (single_kboard)
2837 abort ();
2838 if (CONSP (link))
2840 while (CONSP (XCDR (link)))
2841 link = XCDR (link);
2842 if (!NILP (XCDR (link)))
2843 abort ();
2845 if (!CONSP (link))
2846 kb->kbd_queue = Fcons (c, Qnil);
2847 else
2848 XSETCDR (link, Fcons (c, Qnil));
2849 kb->kbd_queue_has_data = 1;
2850 current_kboard = kb;
2851 /* This is going to exit from read_char
2852 so we had better get rid of this frame's stuff. */
2853 UNGCPRO;
2854 return make_number (-2); /* wrong_kboard_jmpbuf */
2857 goto non_reread;
2860 /* Start idle timers if no time limit is supplied. We don't do it
2861 if a time limit is supplied to avoid an infinite recursion in the
2862 situation where an idle timer calls `sit-for'. */
2864 if (!end_time)
2865 timer_start_idle ();
2867 /* If in middle of key sequence and minibuffer not active,
2868 start echoing if enough time elapses. */
2870 if (minibuf_level == 0
2871 && !end_time
2872 && !current_kboard->immediate_echo
2873 && this_command_key_count > 0
2874 && ! noninteractive
2875 && (FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
2876 && NILP (Fzerop (Vecho_keystrokes))
2877 && (/* No message. */
2878 NILP (echo_area_buffer[0])
2879 /* Or empty message. */
2880 || (BUF_BEG (XBUFFER (echo_area_buffer[0]))
2881 == BUF_Z (XBUFFER (echo_area_buffer[0])))
2882 /* Or already echoing from same kboard. */
2883 || (echo_kboard && ok_to_echo_at_next_pause == echo_kboard)
2884 /* Or not echoing before and echoing allowed. */
2885 || (!echo_kboard && ok_to_echo_at_next_pause)))
2887 /* After a mouse event, start echoing right away.
2888 This is because we are probably about to display a menu,
2889 and we don't want to delay before doing so. */
2890 if (EVENT_HAS_PARAMETERS (prev_event))
2891 echo_now ();
2892 else
2894 Lisp_Object tem0;
2896 save_getcjmp (save_jump);
2897 restore_getcjmp (local_getcjmp);
2898 tem0 = sit_for (Vecho_keystrokes, 1, 1);
2899 restore_getcjmp (save_jump);
2900 if (EQ (tem0, Qt)
2901 && ! CONSP (Vunread_command_events))
2902 echo_now ();
2906 /* Maybe auto save due to number of keystrokes. */
2908 if (commandflag != 0
2909 && auto_save_interval > 0
2910 && num_nonmacro_input_events - last_auto_save > max (auto_save_interval, 20)
2911 && !detect_input_pending_run_timers (0))
2913 Fdo_auto_save (Qnil, Qnil);
2914 /* Hooks can actually change some buffers in auto save. */
2915 redisplay ();
2918 /* Try reading using an X menu.
2919 This is never confused with reading using the minibuf
2920 because the recursive call of read_char in read_char_minibuf_menu_prompt
2921 does not pass on any keymaps. */
2923 if (nmaps > 0 && INTERACTIVE
2924 && !NILP (prev_event)
2925 && EVENT_HAS_PARAMETERS (prev_event)
2926 && !EQ (XCAR (prev_event), Qmenu_bar)
2927 && !EQ (XCAR (prev_event), Qtool_bar)
2928 /* Don't bring up a menu if we already have another event. */
2929 && NILP (Vunread_command_events)
2930 && unread_command_char < 0)
2932 c = read_char_x_menu_prompt (nmaps, maps, prev_event, used_mouse_menu);
2934 /* Now that we have read an event, Emacs is not idle. */
2935 if (!end_time)
2936 timer_stop_idle ();
2938 goto exit;
2941 /* Maybe autosave and/or garbage collect due to idleness. */
2943 if (INTERACTIVE && NILP (c))
2945 int delay_level, buffer_size;
2947 /* Slow down auto saves logarithmically in size of current buffer,
2948 and garbage collect while we're at it. */
2949 if (! MINI_WINDOW_P (XWINDOW (selected_window)))
2950 last_non_minibuf_size = Z - BEG;
2951 buffer_size = (last_non_minibuf_size >> 8) + 1;
2952 delay_level = 0;
2953 while (buffer_size > 64)
2954 delay_level++, buffer_size -= buffer_size >> 2;
2955 if (delay_level < 4) delay_level = 4;
2956 /* delay_level is 4 for files under around 50k, 7 at 100k,
2957 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2959 /* Auto save if enough time goes by without input. */
2960 if (commandflag != 0
2961 && num_nonmacro_input_events > last_auto_save
2962 && INTEGERP (Vauto_save_timeout)
2963 && XINT (Vauto_save_timeout) > 0)
2965 Lisp_Object tem0;
2966 int timeout = delay_level * XFASTINT (Vauto_save_timeout) / 4;
2968 save_getcjmp (save_jump);
2969 restore_getcjmp (local_getcjmp);
2970 tem0 = sit_for (make_number (timeout), 1, 1);
2971 restore_getcjmp (save_jump);
2973 if (EQ (tem0, Qt)
2974 && ! CONSP (Vunread_command_events))
2976 Fdo_auto_save (Qnil, Qnil);
2978 /* If we have auto-saved and there is still no input
2979 available, garbage collect if there has been enough
2980 consing going on to make it worthwhile. */
2981 if (!detect_input_pending_run_timers (0)
2982 && consing_since_gc > gc_cons_threshold / 2)
2983 Fgarbage_collect ();
2985 redisplay ();
2990 /* Notify the caller if an autosave hook, or a timer, sentinel or
2991 filter in the sit_for calls above have changed the current
2992 kboard. This could happen if they use the minibuffer or start a
2993 recursive edit, like the fancy splash screen in server.el's
2994 filter. If this longjmp wasn't here, read_key_sequence would
2995 interpret the next key sequence using the wrong translation
2996 tables and function keymaps. */
2997 if (NILP (c) && current_kboard != orig_kboard)
2999 UNGCPRO;
3000 return make_number (-2); /* wrong_kboard_jmpbuf */
3003 /* If this has become non-nil here, it has been set by a timer
3004 or sentinel or filter. */
3005 if (CONSP (Vunread_command_events))
3007 c = XCAR (Vunread_command_events);
3008 Vunread_command_events = XCDR (Vunread_command_events);
3011 /* Read something from current KBOARD's side queue, if possible. */
3013 if (NILP (c))
3015 if (current_kboard->kbd_queue_has_data)
3017 if (!CONSP (current_kboard->kbd_queue))
3018 abort ();
3019 c = XCAR (current_kboard->kbd_queue);
3020 current_kboard->kbd_queue
3021 = XCDR (current_kboard->kbd_queue);
3022 if (NILP (current_kboard->kbd_queue))
3023 current_kboard->kbd_queue_has_data = 0;
3024 input_pending = readable_events (0);
3025 if (EVENT_HAS_PARAMETERS (c)
3026 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qswitch_frame))
3027 internal_last_event_frame = XCAR (XCDR (c));
3028 Vlast_event_frame = internal_last_event_frame;
3032 /* If current_kboard's side queue is empty check the other kboards.
3033 If one of them has data that we have not yet seen here,
3034 switch to it and process the data waiting for it.
3036 Note: if the events queued up for another kboard
3037 have already been seen here, and therefore are not a complete command,
3038 the kbd_queue_has_data field is 0, so we skip that kboard here.
3039 That's to avoid an infinite loop switching between kboards here. */
3040 if (NILP (c) && !single_kboard)
3042 KBOARD *kb;
3043 for (kb = all_kboards; kb; kb = kb->next_kboard)
3044 if (kb->kbd_queue_has_data)
3046 current_kboard = kb;
3047 /* This is going to exit from read_char
3048 so we had better get rid of this frame's stuff. */
3049 UNGCPRO;
3050 return make_number (-2); /* wrong_kboard_jmpbuf */
3054 wrong_kboard:
3056 STOP_POLLING;
3058 /* Finally, we read from the main queue,
3059 and if that gives us something we can't use yet, we put it on the
3060 appropriate side queue and try again. */
3062 if (NILP (c))
3064 KBOARD *kb;
3066 if (end_time)
3068 EMACS_TIME now;
3069 EMACS_GET_TIME (now);
3070 if (EMACS_TIME_GE (now, *end_time))
3071 goto exit;
3074 /* Actually read a character, waiting if necessary. */
3075 save_getcjmp (save_jump);
3076 restore_getcjmp (local_getcjmp);
3077 if (!end_time)
3078 timer_start_idle ();
3079 c = kbd_buffer_get_event (&kb, used_mouse_menu, end_time);
3080 restore_getcjmp (save_jump);
3082 if (! NILP (c) && (kb != current_kboard))
3084 Lisp_Object link = kb->kbd_queue;
3085 if (CONSP (link))
3087 while (CONSP (XCDR (link)))
3088 link = XCDR (link);
3089 if (!NILP (XCDR (link)))
3090 abort ();
3092 if (!CONSP (link))
3093 kb->kbd_queue = Fcons (c, Qnil);
3094 else
3095 XSETCDR (link, Fcons (c, Qnil));
3096 kb->kbd_queue_has_data = 1;
3097 c = Qnil;
3098 if (single_kboard)
3099 goto wrong_kboard;
3100 current_kboard = kb;
3101 /* This is going to exit from read_char
3102 so we had better get rid of this frame's stuff. */
3103 UNGCPRO;
3104 return make_number (-2);
3108 /* Terminate Emacs in batch mode if at eof. */
3109 if (noninteractive && INTEGERP (c) && XINT (c) < 0)
3110 Fkill_emacs (make_number (1));
3112 if (INTEGERP (c))
3114 /* Add in any extra modifiers, where appropriate. */
3115 if ((extra_keyboard_modifiers & CHAR_CTL)
3116 || ((extra_keyboard_modifiers & 0177) < ' '
3117 && (extra_keyboard_modifiers & 0177) != 0))
3118 XSETINT (c, make_ctrl_char (XINT (c)));
3120 /* Transfer any other modifier bits directly from
3121 extra_keyboard_modifiers to c. Ignore the actual character code
3122 in the low 16 bits of extra_keyboard_modifiers. */
3123 XSETINT (c, XINT (c) | (extra_keyboard_modifiers & ~0xff7f & ~CHAR_CTL));
3126 non_reread:
3128 if (!end_time)
3129 timer_stop_idle ();
3130 RESUME_POLLING;
3132 if (NILP (c))
3134 if (commandflag >= 0
3135 && !input_pending && !detect_input_pending_run_timers (0))
3136 redisplay ();
3138 goto wrong_kboard;
3141 non_reread_1:
3143 /* Buffer switch events are only for internal wakeups
3144 so don't show them to the user.
3145 Also, don't record a key if we already did. */
3146 if (BUFFERP (c) || key_already_recorded)
3147 goto exit;
3149 /* Process special events within read_char
3150 and loop around to read another event. */
3151 save = Vquit_flag;
3152 Vquit_flag = Qnil;
3153 tem = access_keymap (get_keymap (Vspecial_event_map, 0, 1), c, 0, 0, 1);
3154 Vquit_flag = save;
3156 if (!NILP (tem))
3158 struct buffer *prev_buffer = current_buffer;
3159 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3160 int was_locked = single_kboard;
3161 int count = SPECPDL_INDEX ();
3162 record_single_kboard_state ();
3163 #endif
3165 last_input_event = c;
3166 Fcommand_execute (tem, Qnil, Fvector (1, &last_input_event), Qt);
3168 if (CONSP (c) && EQ (XCAR (c), Qselect_window) && !end_time)
3169 /* We stopped being idle for this event; undo that. This
3170 prevents automatic window selection (under
3171 mouse_autoselect_window from acting as a real input event, for
3172 example banishing the mouse under mouse-avoidance-mode. */
3173 timer_resume_idle ();
3175 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3176 /* Resume allowing input from any kboard, if that was true before. */
3177 if (!was_locked)
3178 any_kboard_state ();
3179 unbind_to (count, Qnil);
3180 #endif
3182 if (current_buffer != prev_buffer)
3184 /* The command may have changed the keymaps. Pretend there
3185 is input in another keyboard and return. This will
3186 recalculate keymaps. */
3187 c = make_number (-2);
3188 goto exit;
3190 else
3191 goto retry;
3194 /* Handle things that only apply to characters. */
3195 if (INTEGERP (c))
3197 /* If kbd_buffer_get_event gave us an EOF, return that. */
3198 if (XINT (c) == -1)
3199 goto exit;
3201 if ((STRINGP (current_kboard->Vkeyboard_translate_table)
3202 && SCHARS (current_kboard->Vkeyboard_translate_table) > (unsigned) XFASTINT (c))
3203 || (VECTORP (current_kboard->Vkeyboard_translate_table)
3204 && XVECTOR (current_kboard->Vkeyboard_translate_table)->size > (unsigned) XFASTINT (c))
3205 || (CHAR_TABLE_P (current_kboard->Vkeyboard_translate_table)
3206 && CHARACTERP (c)))
3208 Lisp_Object d;
3209 d = Faref (current_kboard->Vkeyboard_translate_table, c);
3210 /* nil in keyboard-translate-table means no translation. */
3211 if (!NILP (d))
3212 c = d;
3216 /* If this event is a mouse click in the menu bar,
3217 return just menu-bar for now. Modify the mouse click event
3218 so we won't do this twice, then queue it up. */
3219 if (EVENT_HAS_PARAMETERS (c)
3220 && CONSP (XCDR (c))
3221 && CONSP (EVENT_START (c))
3222 && CONSP (XCDR (EVENT_START (c))))
3224 Lisp_Object posn;
3226 posn = POSN_POSN (EVENT_START (c));
3227 /* Handle menu-bar events:
3228 insert the dummy prefix event `menu-bar'. */
3229 if (EQ (posn, Qmenu_bar) || EQ (posn, Qtool_bar))
3231 /* Change menu-bar to (menu-bar) as the event "position". */
3232 POSN_SET_POSN (EVENT_START (c), Fcons (posn, Qnil));
3234 also_record = c;
3235 Vunread_command_events = Fcons (c, Vunread_command_events);
3236 c = posn;
3240 /* Store these characters into recent_keys, the dribble file if any,
3241 and the keyboard macro being defined, if any. */
3242 record_char (c);
3243 if (! NILP (also_record))
3244 record_char (also_record);
3246 /* Wipe the echo area.
3247 But first, if we are about to use an input method,
3248 save the echo area contents for it to refer to. */
3249 if (INTEGERP (c)
3250 && ! NILP (Vinput_method_function)
3251 && (unsigned) XINT (c) >= ' '
3252 && (unsigned) XINT (c) != 127
3253 && (unsigned) XINT (c) < 256)
3255 previous_echo_area_message = Fcurrent_message ();
3256 Vinput_method_previous_message = previous_echo_area_message;
3259 /* Now wipe the echo area, except for help events which do their
3260 own stuff with the echo area. */
3261 if (!CONSP (c)
3262 || (!(EQ (Qhelp_echo, XCAR (c)))
3263 && !(EQ (Qswitch_frame, XCAR (c)))))
3265 if (!NILP (echo_area_buffer[0]))
3266 safe_run_hooks (Qecho_area_clear_hook);
3267 clear_message (1, 0);
3270 reread_for_input_method:
3271 from_macro:
3272 /* Pass this to the input method, if appropriate. */
3273 if (INTEGERP (c)
3274 && ! NILP (Vinput_method_function)
3275 /* Don't run the input method within a key sequence,
3276 after the first event of the key sequence. */
3277 && NILP (prev_event)
3278 && (unsigned) XINT (c) >= ' '
3279 && (unsigned) XINT (c) != 127
3280 && (unsigned) XINT (c) < 256)
3282 Lisp_Object keys;
3283 int key_count, key_count_reset;
3284 struct gcpro gcpro1;
3285 int count = SPECPDL_INDEX ();
3287 /* Save the echo status. */
3288 int saved_immediate_echo = current_kboard->immediate_echo;
3289 struct kboard *saved_ok_to_echo = ok_to_echo_at_next_pause;
3290 Lisp_Object saved_echo_string = current_kboard->echo_string;
3291 int saved_echo_after_prompt = current_kboard->echo_after_prompt;
3293 #if 0
3294 if (before_command_restore_flag)
3296 this_command_key_count = before_command_key_count_1;
3297 if (this_command_key_count < this_single_command_key_start)
3298 this_single_command_key_start = this_command_key_count;
3299 echo_truncate (before_command_echo_length_1);
3300 before_command_restore_flag = 0;
3302 #endif
3304 /* Save the this_command_keys status. */
3305 key_count = this_command_key_count;
3306 key_count_reset = this_command_key_count_reset;
3308 if (key_count > 0)
3309 keys = Fcopy_sequence (this_command_keys);
3310 else
3311 keys = Qnil;
3312 GCPRO1 (keys);
3314 /* Clear out this_command_keys. */
3315 this_command_key_count = 0;
3316 this_command_key_count_reset = 0;
3318 /* Now wipe the echo area. */
3319 if (!NILP (echo_area_buffer[0]))
3320 safe_run_hooks (Qecho_area_clear_hook);
3321 clear_message (1, 0);
3322 echo_truncate (0);
3324 /* If we are not reading a key sequence,
3325 never use the echo area. */
3326 if (maps == 0)
3328 specbind (Qinput_method_use_echo_area, Qt);
3331 /* Call the input method. */
3332 tem = call1 (Vinput_method_function, c);
3334 tem = unbind_to (count, tem);
3336 /* Restore the saved echoing state
3337 and this_command_keys state. */
3338 this_command_key_count = key_count;
3339 this_command_key_count_reset = key_count_reset;
3340 if (key_count > 0)
3341 this_command_keys = keys;
3343 cancel_echoing ();
3344 ok_to_echo_at_next_pause = saved_ok_to_echo;
3345 current_kboard->echo_string = saved_echo_string;
3346 current_kboard->echo_after_prompt = saved_echo_after_prompt;
3347 if (saved_immediate_echo)
3348 echo_now ();
3350 UNGCPRO;
3352 /* The input method can return no events. */
3353 if (! CONSP (tem))
3355 /* Bring back the previous message, if any. */
3356 if (! NILP (previous_echo_area_message))
3357 message_with_string ("%s", previous_echo_area_message, 0);
3358 goto retry;
3360 /* It returned one event or more. */
3361 c = XCAR (tem);
3362 Vunread_post_input_method_events
3363 = nconc2 (XCDR (tem), Vunread_post_input_method_events);
3366 reread_first:
3368 /* Display help if not echoing. */
3369 if (CONSP (c) && EQ (XCAR (c), Qhelp_echo))
3371 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3372 Lisp_Object help, object, position, window, tem;
3374 tem = Fcdr (XCDR (c));
3375 help = Fcar (tem);
3376 tem = Fcdr (tem);
3377 window = Fcar (tem);
3378 tem = Fcdr (tem);
3379 object = Fcar (tem);
3380 tem = Fcdr (tem);
3381 position = Fcar (tem);
3383 show_help_echo (help, window, object, position, 0);
3385 /* We stopped being idle for this event; undo that. */
3386 if (!end_time)
3387 timer_resume_idle ();
3388 goto retry;
3391 if ((! reread || this_command_key_count == 0
3392 || this_command_key_count_reset)
3393 && !end_time)
3396 /* Don't echo mouse motion events. */
3397 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
3398 && NILP (Fzerop (Vecho_keystrokes))
3399 && ! (EVENT_HAS_PARAMETERS (c)
3400 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
3402 echo_char (c);
3403 if (! NILP (also_record))
3404 echo_char (also_record);
3405 /* Once we reread a character, echoing can happen
3406 the next time we pause to read a new one. */
3407 ok_to_echo_at_next_pause = current_kboard;
3410 /* Record this character as part of the current key. */
3411 add_command_key (c);
3412 if (! NILP (also_record))
3413 add_command_key (also_record);
3416 last_input_event = c;
3417 num_input_events++;
3419 /* Process the help character specially if enabled */
3420 if (!NILP (Vhelp_form) && help_char_p (c))
3422 Lisp_Object tem0;
3423 count = SPECPDL_INDEX ();
3425 help_form_saved_window_configs
3426 = Fcons (Fcurrent_window_configuration (Qnil),
3427 help_form_saved_window_configs);
3428 record_unwind_protect (read_char_help_form_unwind, Qnil);
3430 tem0 = Feval (Vhelp_form);
3431 if (STRINGP (tem0))
3432 internal_with_output_to_temp_buffer ("*Help*", print_help, tem0);
3434 cancel_echoing ();
3437 c = read_char (0, 0, 0, Qnil, 0, NULL);
3438 if (EVENT_HAS_PARAMETERS (c)
3439 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_click))
3440 XSETCAR (help_form_saved_window_configs, Qnil);
3442 while (BUFFERP (c));
3443 /* Remove the help from the frame */
3444 unbind_to (count, Qnil);
3446 redisplay ();
3447 if (EQ (c, make_number (040)))
3449 cancel_echoing ();
3451 c = read_char (0, 0, 0, Qnil, 0, NULL);
3452 while (BUFFERP (c));
3456 exit:
3457 RESUME_POLLING;
3458 RETURN_UNGCPRO (c);
3461 /* Record a key that came from a mouse menu.
3462 Record it for echoing, for this-command-keys, and so on. */
3464 static void
3465 record_menu_key (c)
3466 Lisp_Object c;
3468 /* Wipe the echo area. */
3469 clear_message (1, 0);
3471 record_char (c);
3473 #if 0
3474 before_command_key_count = this_command_key_count;
3475 before_command_echo_length = echo_length ();
3476 #endif
3478 /* Don't echo mouse motion events. */
3479 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
3480 && NILP (Fzerop (Vecho_keystrokes)))
3482 echo_char (c);
3484 /* Once we reread a character, echoing can happen
3485 the next time we pause to read a new one. */
3486 ok_to_echo_at_next_pause = 0;
3489 /* Record this character as part of the current key. */
3490 add_command_key (c);
3492 /* Re-reading in the middle of a command */
3493 last_input_event = c;
3494 num_input_events++;
3497 /* Return 1 if should recognize C as "the help character". */
3500 help_char_p (c)
3501 Lisp_Object c;
3503 Lisp_Object tail;
3505 if (EQ (c, Vhelp_char))
3506 return 1;
3507 for (tail = Vhelp_event_list; CONSP (tail); tail = XCDR (tail))
3508 if (EQ (c, XCAR (tail)))
3509 return 1;
3510 return 0;
3513 /* Record the input event C in various ways. */
3515 static void
3516 record_char (c)
3517 Lisp_Object c;
3519 int recorded = 0;
3521 if (CONSP (c) && (EQ (XCAR (c), Qhelp_echo) || EQ (XCAR (c), Qmouse_movement)))
3523 /* To avoid filling recent_keys with help-echo and mouse-movement
3524 events, we filter out repeated help-echo events, only store the
3525 first and last in a series of mouse-movement events, and don't
3526 store repeated help-echo events which are only separated by
3527 mouse-movement events. */
3529 Lisp_Object ev1, ev2, ev3;
3530 int ix1, ix2, ix3;
3532 if ((ix1 = recent_keys_index - 1) < 0)
3533 ix1 = NUM_RECENT_KEYS - 1;
3534 ev1 = AREF (recent_keys, ix1);
3536 if ((ix2 = ix1 - 1) < 0)
3537 ix2 = NUM_RECENT_KEYS - 1;
3538 ev2 = AREF (recent_keys, ix2);
3540 if ((ix3 = ix2 - 1) < 0)
3541 ix3 = NUM_RECENT_KEYS - 1;
3542 ev3 = AREF (recent_keys, ix3);
3544 if (EQ (XCAR (c), Qhelp_echo))
3546 /* Don't record `help-echo' in recent_keys unless it shows some help
3547 message, and a different help than the previously recorded
3548 event. */
3549 Lisp_Object help, last_help;
3551 help = Fcar_safe (Fcdr_safe (XCDR (c)));
3552 if (!STRINGP (help))
3553 recorded = 1;
3554 else if (CONSP (ev1) && EQ (XCAR (ev1), Qhelp_echo)
3555 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev1))), EQ (last_help, help)))
3556 recorded = 1;
3557 else if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3558 && CONSP (ev2) && EQ (XCAR (ev2), Qhelp_echo)
3559 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev2))), EQ (last_help, help)))
3560 recorded = -1;
3561 else if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3562 && CONSP (ev2) && EQ (XCAR (ev2), Qmouse_movement)
3563 && CONSP (ev3) && EQ (XCAR (ev3), Qhelp_echo)
3564 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev3))), EQ (last_help, help)))
3565 recorded = -2;
3567 else if (EQ (XCAR (c), Qmouse_movement))
3569 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3570 So additional mouse movement events replace the last element. */
3571 Lisp_Object last_window, window;
3573 window = Fcar_safe (Fcar_safe (XCDR (c)));
3574 if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3575 && (last_window = Fcar_safe (Fcar_safe (XCDR (ev1))), EQ (last_window, window))
3576 && CONSP (ev2) && EQ (XCAR (ev2), Qmouse_movement)
3577 && (last_window = Fcar_safe (Fcar_safe (XCDR (ev2))), EQ (last_window, window)))
3579 ASET (recent_keys, ix1, c);
3580 recorded = 1;
3584 else
3585 store_kbd_macro_char (c);
3587 if (!recorded)
3589 total_keys++;
3590 ASET (recent_keys, recent_keys_index, c);
3591 if (++recent_keys_index >= NUM_RECENT_KEYS)
3592 recent_keys_index = 0;
3594 else if (recorded < 0)
3596 /* We need to remove one or two events from recent_keys.
3597 To do this, we simply put nil at those events and move the
3598 recent_keys_index backwards over those events. Usually,
3599 users will never see those nil events, as they will be
3600 overwritten by the command keys entered to see recent_keys
3601 (e.g. C-h l). */
3603 while (recorded++ < 0 && total_keys > 0)
3605 if (total_keys < NUM_RECENT_KEYS)
3606 total_keys--;
3607 if (--recent_keys_index < 0)
3608 recent_keys_index = NUM_RECENT_KEYS - 1;
3609 ASET (recent_keys, recent_keys_index, Qnil);
3613 num_nonmacro_input_events++;
3615 /* Write c to the dribble file. If c is a lispy event, write
3616 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3617 If you, dear reader, have a better idea, you've got the source. :-) */
3618 if (dribble)
3620 BLOCK_INPUT;
3621 if (INTEGERP (c))
3623 if (XUINT (c) < 0x100)
3624 putc (XINT (c), dribble);
3625 else
3626 fprintf (dribble, " 0x%x", (int) XUINT (c));
3628 else
3630 Lisp_Object dribblee;
3632 /* If it's a structured event, take the event header. */
3633 dribblee = EVENT_HEAD (c);
3635 if (SYMBOLP (dribblee))
3637 putc ('<', dribble);
3638 fwrite (SDATA (SYMBOL_NAME (dribblee)), sizeof (char),
3639 SBYTES (SYMBOL_NAME (dribblee)),
3640 dribble);
3641 putc ('>', dribble);
3645 fflush (dribble);
3646 UNBLOCK_INPUT;
3650 Lisp_Object
3651 print_help (object)
3652 Lisp_Object object;
3654 struct buffer *old = current_buffer;
3655 Fprinc (object, Qnil);
3656 set_buffer_internal (XBUFFER (Vstandard_output));
3657 call0 (intern ("help-mode"));
3658 set_buffer_internal (old);
3659 return Qnil;
3662 /* Copy out or in the info on where C-g should throw to.
3663 This is used when running Lisp code from within get_char,
3664 in case get_char is called recursively.
3665 See read_process_output. */
3667 static void
3668 save_getcjmp (temp)
3669 jmp_buf temp;
3671 bcopy (getcjmp, temp, sizeof getcjmp);
3674 static void
3675 restore_getcjmp (temp)
3676 jmp_buf temp;
3678 bcopy (temp, getcjmp, sizeof getcjmp);
3681 /* Low level keyboard/mouse input.
3682 kbd_buffer_store_event places events in kbd_buffer, and
3683 kbd_buffer_get_event retrieves them. */
3685 /* Return true if there are any events in the queue that read-char
3686 would return. If this returns false, a read-char would block. */
3687 static int
3688 readable_events (flags)
3689 int flags;
3691 #ifdef HAVE_DBUS
3692 /* Check whether a D-Bus message has arrived. */
3693 if (xd_pending_messages () > 0)
3694 return 1;
3695 #endif /* HAVE_DBUS */
3697 if (flags & READABLE_EVENTS_DO_TIMERS_NOW)
3698 timer_check (1);
3700 /* If the buffer contains only FOCUS_IN_EVENT events, and
3701 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3702 if (kbd_fetch_ptr != kbd_store_ptr)
3704 if (flags & (READABLE_EVENTS_FILTER_EVENTS
3705 #ifdef USE_TOOLKIT_SCROLL_BARS
3706 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3707 #endif
3710 struct input_event *event;
3712 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
3713 ? kbd_fetch_ptr
3714 : kbd_buffer);
3718 if (!(
3719 #ifdef USE_TOOLKIT_SCROLL_BARS
3720 (flags & READABLE_EVENTS_FILTER_EVENTS) &&
3721 #endif
3722 event->kind == FOCUS_IN_EVENT)
3723 #ifdef USE_TOOLKIT_SCROLL_BARS
3724 && !((flags & READABLE_EVENTS_IGNORE_SQUEEZABLES)
3725 && event->kind == SCROLL_BAR_CLICK_EVENT
3726 && event->part == scroll_bar_handle
3727 && event->modifiers == 0)
3728 #endif
3730 return 1;
3731 event++;
3732 if (event == kbd_buffer + KBD_BUFFER_SIZE)
3733 event = kbd_buffer;
3735 while (event != kbd_store_ptr);
3737 else
3738 return 1;
3741 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3742 if (!(flags & READABLE_EVENTS_IGNORE_SQUEEZABLES)
3743 && !NILP (do_mouse_tracking) && some_mouse_moved ())
3744 return 1;
3745 #endif
3746 if (single_kboard)
3748 if (current_kboard->kbd_queue_has_data)
3749 return 1;
3751 else
3753 KBOARD *kb;
3754 for (kb = all_kboards; kb; kb = kb->next_kboard)
3755 if (kb->kbd_queue_has_data)
3756 return 1;
3758 return 0;
3761 /* Set this for debugging, to have a way to get out */
3762 int stop_character;
3764 static KBOARD *
3765 event_to_kboard (event)
3766 struct input_event *event;
3768 Lisp_Object frame;
3769 frame = event->frame_or_window;
3770 if (CONSP (frame))
3771 frame = XCAR (frame);
3772 else if (WINDOWP (frame))
3773 frame = WINDOW_FRAME (XWINDOW (frame));
3775 /* There are still some events that don't set this field.
3776 For now, just ignore the problem.
3777 Also ignore dead frames here. */
3778 if (!FRAMEP (frame) || !FRAME_LIVE_P (XFRAME (frame)))
3779 return 0;
3780 else
3781 return FRAME_KBOARD (XFRAME (frame));
3785 Lisp_Object impl_Vthrow_on_input;
3787 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3789 void
3790 kbd_buffer_store_event (event)
3791 register struct input_event *event;
3793 kbd_buffer_store_event_hold (event, 0);
3796 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3798 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3799 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3800 Else, if EVENT is a quit event, store the quit event
3801 in HOLD_QUIT, and return (thus ignoring further events).
3803 This is used in read_avail_input to postpone the processing
3804 of the quit event until all subsequent input events have been
3805 parsed (and discarded).
3808 void
3809 kbd_buffer_store_event_hold (event, hold_quit)
3810 register struct input_event *event;
3811 struct input_event *hold_quit;
3813 if (event->kind == NO_EVENT)
3814 abort ();
3816 if (hold_quit && hold_quit->kind != NO_EVENT)
3817 return;
3819 if (event->kind == ASCII_KEYSTROKE_EVENT)
3821 register int c = event->code & 0377;
3823 if (event->modifiers & ctrl_modifier)
3824 c = make_ctrl_char (c);
3826 c |= (event->modifiers
3827 & (meta_modifier | alt_modifier
3828 | hyper_modifier | super_modifier));
3830 if (c == quit_char)
3832 KBOARD *kb = FRAME_KBOARD (XFRAME (event->frame_or_window));
3833 struct input_event *sp;
3835 if (single_kboard && kb != current_kboard)
3837 kb->kbd_queue
3838 = Fcons (make_lispy_switch_frame (event->frame_or_window),
3839 Fcons (make_number (c), Qnil));
3840 kb->kbd_queue_has_data = 1;
3841 for (sp = kbd_fetch_ptr; sp != kbd_store_ptr; sp++)
3843 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3844 sp = kbd_buffer;
3846 if (event_to_kboard (sp) == kb)
3848 sp->kind = NO_EVENT;
3849 sp->frame_or_window = Qnil;
3850 sp->arg = Qnil;
3853 return;
3856 if (hold_quit)
3858 bcopy (event, (char *) hold_quit, sizeof (*event));
3859 return;
3862 /* If this results in a quit_char being returned to Emacs as
3863 input, set Vlast_event_frame properly. If this doesn't
3864 get returned to Emacs as an event, the next event read
3865 will set Vlast_event_frame again, so this is safe to do. */
3867 Lisp_Object focus;
3869 focus = FRAME_FOCUS_FRAME (XFRAME (event->frame_or_window));
3870 if (NILP (focus))
3871 focus = event->frame_or_window;
3872 internal_last_event_frame = focus;
3873 Vlast_event_frame = focus;
3876 last_event_timestamp = event->timestamp;
3877 handle_interrupt ();
3878 return;
3881 if (c && c == stop_character)
3883 sys_suspend ();
3884 return;
3887 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3888 Just ignore the second one. */
3889 else if (event->kind == BUFFER_SWITCH_EVENT
3890 && kbd_fetch_ptr != kbd_store_ptr
3891 && ((kbd_store_ptr == kbd_buffer
3892 ? kbd_buffer + KBD_BUFFER_SIZE - 1
3893 : kbd_store_ptr - 1)->kind) == BUFFER_SWITCH_EVENT)
3894 return;
3896 if (kbd_store_ptr - kbd_buffer == KBD_BUFFER_SIZE)
3897 kbd_store_ptr = kbd_buffer;
3899 /* Don't let the very last slot in the buffer become full,
3900 since that would make the two pointers equal,
3901 and that is indistinguishable from an empty buffer.
3902 Discard the event if it would fill the last slot. */
3903 if (kbd_fetch_ptr - 1 != kbd_store_ptr)
3905 *kbd_store_ptr = *event;
3906 ++kbd_store_ptr;
3909 /* If we're inside while-no-input, and this event qualifies
3910 as input, set quit-flag to cause an interrupt. */
3911 if (!NILP (Vthrow_on_input)
3912 && event->kind != FOCUS_IN_EVENT
3913 && event->kind != HELP_EVENT
3914 && event->kind != DEICONIFY_EVENT)
3916 Vquit_flag = Vthrow_on_input;
3917 /* If we're inside a function that wants immediate quits,
3918 do it now. */
3919 if (immediate_quit && NILP (Vinhibit_quit))
3921 immediate_quit = 0;
3922 sigfree ();
3923 QUIT;
3929 /* Put an input event back in the head of the event queue. */
3931 void
3932 kbd_buffer_unget_event (event)
3933 register struct input_event *event;
3935 if (kbd_fetch_ptr == kbd_buffer)
3936 kbd_fetch_ptr = kbd_buffer + KBD_BUFFER_SIZE;
3938 /* Don't let the very last slot in the buffer become full, */
3939 if (kbd_fetch_ptr - 1 != kbd_store_ptr)
3941 --kbd_fetch_ptr;
3942 *kbd_fetch_ptr = *event;
3947 /* Generate HELP_EVENT input_events in BUFP which has room for
3948 SIZE events. If there's not enough room in BUFP, ignore this
3949 event.
3951 HELP is the help form.
3953 FRAME is the frame on which the help is generated. OBJECT is the
3954 Lisp object where the help was found (a buffer, a string, an
3955 overlay, or nil if neither from a string nor from a buffer. POS is
3956 the position within OBJECT where the help was found.
3958 Value is the number of input_events generated. */
3960 void
3961 gen_help_event (help, frame, window, object, pos)
3962 Lisp_Object help, frame, object, window;
3963 int pos;
3965 struct input_event event;
3967 EVENT_INIT (event);
3969 event.kind = HELP_EVENT;
3970 event.frame_or_window = frame;
3971 event.arg = object;
3972 event.x = WINDOWP (window) ? window : frame;
3973 event.y = help;
3974 event.code = pos;
3975 kbd_buffer_store_event (&event);
3979 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3981 void
3982 kbd_buffer_store_help_event (frame, help)
3983 Lisp_Object frame, help;
3985 struct input_event event;
3987 event.kind = HELP_EVENT;
3988 event.frame_or_window = frame;
3989 event.arg = Qnil;
3990 event.x = Qnil;
3991 event.y = help;
3992 event.code = 0;
3993 kbd_buffer_store_event (&event);
3997 /* Discard any mouse events in the event buffer by setting them to
3998 NO_EVENT. */
3999 void
4000 discard_mouse_events ()
4002 struct input_event *sp;
4003 for (sp = kbd_fetch_ptr; sp != kbd_store_ptr; sp++)
4005 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
4006 sp = kbd_buffer;
4008 if (sp->kind == MOUSE_CLICK_EVENT
4009 || sp->kind == WHEEL_EVENT
4010 || sp->kind == HORIZ_WHEEL_EVENT
4011 #ifdef HAVE_GPM
4012 || sp->kind == GPM_CLICK_EVENT
4013 #endif
4014 || sp->kind == SCROLL_BAR_CLICK_EVENT)
4016 sp->kind = NO_EVENT;
4022 /* Return non-zero if there are any real events waiting in the event
4023 buffer, not counting `NO_EVENT's.
4025 If DISCARD is non-zero, discard NO_EVENT events at the front of
4026 the input queue, possibly leaving the input queue empty if there
4027 are no real input events. */
4030 kbd_buffer_events_waiting (discard)
4031 int discard;
4033 struct input_event *sp;
4035 for (sp = kbd_fetch_ptr;
4036 sp != kbd_store_ptr && sp->kind == NO_EVENT;
4037 ++sp)
4039 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
4040 sp = kbd_buffer;
4043 if (discard)
4044 kbd_fetch_ptr = sp;
4046 return sp != kbd_store_ptr && sp->kind != NO_EVENT;
4050 /* Clear input event EVENT. */
4052 static INLINE void
4053 clear_event (event)
4054 struct input_event *event;
4056 event->kind = NO_EVENT;
4060 /* Read one event from the event buffer, waiting if necessary.
4061 The value is a Lisp object representing the event.
4062 The value is nil for an event that should be ignored,
4063 or that was handled here.
4064 We always read and discard one event. */
4066 static Lisp_Object
4067 kbd_buffer_get_event (kbp, used_mouse_menu, end_time)
4068 KBOARD **kbp;
4069 int *used_mouse_menu;
4070 EMACS_TIME *end_time;
4072 register int c;
4073 Lisp_Object obj;
4075 if (noninteractive
4076 /* In case we are running as a daemon, only do this before
4077 detaching from the terminal. */
4078 || (IS_DAEMON && daemon_pipe[1] >= 0))
4080 c = getchar ();
4081 XSETINT (obj, c);
4082 *kbp = current_kboard;
4083 return obj;
4086 /* Wait until there is input available. */
4087 for (;;)
4089 /* Break loop if there's an unread command event. Needed in
4090 moused window autoselection which uses a timer to insert such
4091 events. */
4092 if (CONSP (Vunread_command_events))
4093 break;
4095 if (kbd_fetch_ptr != kbd_store_ptr)
4096 break;
4097 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4098 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
4099 break;
4100 #endif
4102 /* If the quit flag is set, then read_char will return
4103 quit_char, so that counts as "available input." */
4104 if (!NILP (Vquit_flag))
4105 quit_throw_to_read_char ();
4107 /* One way or another, wait until input is available; then, if
4108 interrupt handlers have not read it, read it now. */
4110 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4111 #ifdef SIGIO
4112 gobble_input (0);
4113 #endif /* SIGIO */
4114 if (kbd_fetch_ptr != kbd_store_ptr)
4115 break;
4116 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4117 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
4118 break;
4119 #endif
4120 if (end_time)
4122 EMACS_TIME duration;
4123 EMACS_GET_TIME (duration);
4124 if (EMACS_TIME_GE (duration, *end_time))
4125 return Qnil; /* finished waiting */
4126 else
4128 EMACS_SUB_TIME (duration, *end_time, duration);
4129 wait_reading_process_output (EMACS_SECS (duration),
4130 EMACS_USECS (duration),
4131 -1, 1, Qnil, NULL, 0);
4134 else
4135 wait_reading_process_output (0, 0, -1, 1, Qnil, NULL, 0);
4137 if (!interrupt_input && kbd_fetch_ptr == kbd_store_ptr)
4138 /* Pass 1 for EXPECT since we just waited to have input. */
4139 read_avail_input (1);
4142 if (CONSP (Vunread_command_events))
4144 Lisp_Object first;
4145 first = XCAR (Vunread_command_events);
4146 Vunread_command_events = XCDR (Vunread_command_events);
4147 *kbp = current_kboard;
4148 return first;
4151 /* At this point, we know that there is a readable event available
4152 somewhere. If the event queue is empty, then there must be a
4153 mouse movement enabled and available. */
4154 if (kbd_fetch_ptr != kbd_store_ptr)
4156 struct input_event *event;
4158 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
4159 ? kbd_fetch_ptr
4160 : kbd_buffer);
4162 last_event_timestamp = event->timestamp;
4164 *kbp = event_to_kboard (event);
4165 if (*kbp == 0)
4166 *kbp = current_kboard; /* Better than returning null ptr? */
4168 obj = Qnil;
4170 /* These two kinds of events get special handling
4171 and don't actually appear to the command loop.
4172 We return nil for them. */
4173 if (event->kind == SELECTION_REQUEST_EVENT
4174 || event->kind == SELECTION_CLEAR_EVENT)
4176 #ifdef HAVE_X11
4177 struct input_event copy;
4179 /* Remove it from the buffer before processing it,
4180 since otherwise swallow_events will see it
4181 and process it again. */
4182 copy = *event;
4183 kbd_fetch_ptr = event + 1;
4184 input_pending = readable_events (0);
4185 x_handle_selection_event (&copy);
4186 #else
4187 /* We're getting selection request events, but we don't have
4188 a window system. */
4189 abort ();
4190 #endif
4193 #if defined (HAVE_NS)
4194 else if (event->kind == NS_TEXT_EVENT)
4196 if (event->code == KEY_NS_PUT_WORKING_TEXT)
4197 obj = Fcons (intern ("ns-put-working-text"), Qnil);
4198 else
4199 obj = Fcons (intern ("ns-unput-working-text"), Qnil);
4200 kbd_fetch_ptr = event + 1;
4201 if (used_mouse_menu)
4202 *used_mouse_menu = 1;
4204 #endif
4206 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4207 || defined (HAVE_NS)
4208 else if (event->kind == DELETE_WINDOW_EVENT)
4210 /* Make an event (delete-frame (FRAME)). */
4211 obj = Fcons (event->frame_or_window, Qnil);
4212 obj = Fcons (Qdelete_frame, Fcons (obj, Qnil));
4213 kbd_fetch_ptr = event + 1;
4215 #endif
4216 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4217 || defined (HAVE_NS)
4218 else if (event->kind == ICONIFY_EVENT)
4220 /* Make an event (iconify-frame (FRAME)). */
4221 obj = Fcons (event->frame_or_window, Qnil);
4222 obj = Fcons (Qiconify_frame, Fcons (obj, Qnil));
4223 kbd_fetch_ptr = event + 1;
4225 else if (event->kind == DEICONIFY_EVENT)
4227 /* Make an event (make-frame-visible (FRAME)). */
4228 obj = Fcons (event->frame_or_window, Qnil);
4229 obj = Fcons (Qmake_frame_visible, Fcons (obj, Qnil));
4230 kbd_fetch_ptr = event + 1;
4232 #endif
4233 else if (event->kind == BUFFER_SWITCH_EVENT)
4235 /* The value doesn't matter here; only the type is tested. */
4236 XSETBUFFER (obj, current_buffer);
4237 kbd_fetch_ptr = event + 1;
4239 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4240 || defined(HAVE_NS) || defined (USE_GTK)
4241 else if (event->kind == MENU_BAR_ACTIVATE_EVENT)
4243 kbd_fetch_ptr = event + 1;
4244 input_pending = readable_events (0);
4245 if (FRAME_LIVE_P (XFRAME (event->frame_or_window)))
4246 x_activate_menubar (XFRAME (event->frame_or_window));
4248 #endif
4249 #if defined (WINDOWSNT)
4250 else if (event->kind == LANGUAGE_CHANGE_EVENT)
4252 /* Make an event (language-change (FRAME CHARSET LCID)). */
4253 obj = Fcons (event->frame_or_window, Qnil);
4254 obj = Fcons (Qlanguage_change, Fcons (obj, Qnil));
4255 kbd_fetch_ptr = event + 1;
4257 #endif
4258 else if (event->kind == SAVE_SESSION_EVENT)
4260 obj = Fcons (Qsave_session, Qnil);
4261 kbd_fetch_ptr = event + 1;
4263 /* Just discard these, by returning nil.
4264 With MULTI_KBOARD, these events are used as placeholders
4265 when we need to randomly delete events from the queue.
4266 (They shouldn't otherwise be found in the buffer,
4267 but on some machines it appears they do show up
4268 even without MULTI_KBOARD.) */
4269 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4270 mouse events during a popup-menu call. */
4271 else if (event->kind == NO_EVENT)
4272 kbd_fetch_ptr = event + 1;
4273 else if (event->kind == HELP_EVENT)
4275 Lisp_Object object, position, help, frame, window;
4277 frame = event->frame_or_window;
4278 object = event->arg;
4279 position = make_number (event->code);
4280 window = event->x;
4281 help = event->y;
4282 clear_event (event);
4284 kbd_fetch_ptr = event + 1;
4285 if (!WINDOWP (window))
4286 window = Qnil;
4287 obj = Fcons (Qhelp_echo,
4288 list5 (frame, help, window, object, position));
4290 else if (event->kind == FOCUS_IN_EVENT)
4292 /* Notification of a FocusIn event. The frame receiving the
4293 focus is in event->frame_or_window. Generate a
4294 switch-frame event if necessary. */
4295 Lisp_Object frame, focus;
4297 frame = event->frame_or_window;
4298 focus = FRAME_FOCUS_FRAME (XFRAME (frame));
4299 if (FRAMEP (focus))
4300 frame = focus;
4302 if (!EQ (frame, internal_last_event_frame)
4303 && !EQ (frame, selected_frame))
4304 obj = make_lispy_switch_frame (frame);
4305 internal_last_event_frame = frame;
4306 kbd_fetch_ptr = event + 1;
4308 #ifdef HAVE_DBUS
4309 else if (event->kind == DBUS_EVENT)
4311 obj = make_lispy_event (event);
4312 kbd_fetch_ptr = event + 1;
4314 #endif
4315 else if (event->kind == CONFIG_CHANGED_EVENT)
4317 obj = make_lispy_event (event);
4318 kbd_fetch_ptr = event + 1;
4320 else
4322 /* If this event is on a different frame, return a switch-frame this
4323 time, and leave the event in the queue for next time. */
4324 Lisp_Object frame;
4325 Lisp_Object focus;
4327 frame = event->frame_or_window;
4328 if (CONSP (frame))
4329 frame = XCAR (frame);
4330 else if (WINDOWP (frame))
4331 frame = WINDOW_FRAME (XWINDOW (frame));
4333 focus = FRAME_FOCUS_FRAME (XFRAME (frame));
4334 if (! NILP (focus))
4335 frame = focus;
4337 if (! EQ (frame, internal_last_event_frame)
4338 && !EQ (frame, selected_frame))
4339 obj = make_lispy_switch_frame (frame);
4340 internal_last_event_frame = frame;
4342 /* If we didn't decide to make a switch-frame event, go ahead
4343 and build a real event from the queue entry. */
4345 if (NILP (obj))
4347 obj = make_lispy_event (event);
4349 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4350 || defined(HAVE_NS) || defined (USE_GTK)
4351 /* If this was a menu selection, then set the flag to inhibit
4352 writing to last_nonmenu_event. Don't do this if the event
4353 we're returning is (menu-bar), though; that indicates the
4354 beginning of the menu sequence, and we might as well leave
4355 that as the `event with parameters' for this selection. */
4356 if (used_mouse_menu
4357 && !EQ (event->frame_or_window, event->arg)
4358 && (event->kind == MENU_BAR_EVENT
4359 || event->kind == TOOL_BAR_EVENT))
4360 *used_mouse_menu = 1;
4361 #endif
4362 #ifdef HAVE_NS
4363 /* certain system events are non-key events */
4364 if (used_mouse_menu
4365 && event->kind == NS_NONKEY_EVENT)
4366 *used_mouse_menu = 1;
4367 #endif
4369 /* Wipe out this event, to catch bugs. */
4370 clear_event (event);
4371 kbd_fetch_ptr = event + 1;
4375 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4376 /* Try generating a mouse motion event. */
4377 else if (!NILP (do_mouse_tracking) && some_mouse_moved ())
4379 FRAME_PTR f = some_mouse_moved ();
4380 Lisp_Object bar_window;
4381 enum scroll_bar_part part;
4382 Lisp_Object x, y;
4383 unsigned long time;
4385 *kbp = current_kboard;
4386 /* Note that this uses F to determine which terminal to look at.
4387 If there is no valid info, it does not store anything
4388 so x remains nil. */
4389 x = Qnil;
4391 /* XXX Can f or mouse_position_hook be NULL here? */
4392 if (f && FRAME_TERMINAL (f)->mouse_position_hook)
4393 (*FRAME_TERMINAL (f)->mouse_position_hook) (&f, 0, &bar_window,
4394 &part, &x, &y, &time);
4396 obj = Qnil;
4398 /* Decide if we should generate a switch-frame event. Don't
4399 generate switch-frame events for motion outside of all Emacs
4400 frames. */
4401 if (!NILP (x) && f)
4403 Lisp_Object frame;
4405 frame = FRAME_FOCUS_FRAME (f);
4406 if (NILP (frame))
4407 XSETFRAME (frame, f);
4409 if (! EQ (frame, internal_last_event_frame)
4410 && !EQ (frame, selected_frame))
4411 obj = make_lispy_switch_frame (frame);
4412 internal_last_event_frame = frame;
4415 /* If we didn't decide to make a switch-frame event, go ahead and
4416 return a mouse-motion event. */
4417 if (!NILP (x) && NILP (obj))
4418 obj = make_lispy_movement (f, bar_window, part, x, y, time);
4420 #endif /* HAVE_MOUSE || HAVE GPM */
4421 else
4422 /* We were promised by the above while loop that there was
4423 something for us to read! */
4424 abort ();
4426 input_pending = readable_events (0);
4428 Vlast_event_frame = internal_last_event_frame;
4430 return (obj);
4433 /* Process any events that are not user-visible,
4434 then return, without reading any user-visible events. */
4436 void
4437 swallow_events (do_display)
4438 int do_display;
4440 int old_timers_run;
4442 while (kbd_fetch_ptr != kbd_store_ptr)
4444 struct input_event *event;
4446 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
4447 ? kbd_fetch_ptr
4448 : kbd_buffer);
4450 last_event_timestamp = event->timestamp;
4452 /* These two kinds of events get special handling
4453 and don't actually appear to the command loop. */
4454 if (event->kind == SELECTION_REQUEST_EVENT
4455 || event->kind == SELECTION_CLEAR_EVENT)
4457 #ifdef HAVE_X11
4458 struct input_event copy;
4460 /* Remove it from the buffer before processing it,
4461 since otherwise swallow_events called recursively could see it
4462 and process it again. */
4463 copy = *event;
4464 kbd_fetch_ptr = event + 1;
4465 input_pending = readable_events (0);
4466 x_handle_selection_event (&copy);
4467 #else
4468 /* We're getting selection request events, but we don't have
4469 a window system. */
4470 abort ();
4471 #endif
4473 else
4474 break;
4477 old_timers_run = timers_run;
4478 get_input_pending (&input_pending, READABLE_EVENTS_DO_TIMERS_NOW);
4480 if (timers_run != old_timers_run && do_display)
4481 redisplay_preserve_echo_area (7);
4484 /* Record the start of when Emacs is idle,
4485 for the sake of running idle-time timers. */
4487 static void
4488 timer_start_idle ()
4490 Lisp_Object timers;
4492 /* If we are already in the idle state, do nothing. */
4493 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4494 return;
4496 EMACS_GET_TIME (timer_idleness_start_time);
4498 timer_last_idleness_start_time = timer_idleness_start_time;
4500 /* Mark all idle-time timers as once again candidates for running. */
4501 for (timers = Vtimer_idle_list; CONSP (timers); timers = XCDR (timers))
4503 Lisp_Object timer;
4505 timer = XCAR (timers);
4507 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
4508 continue;
4509 XVECTOR (timer)->contents[0] = Qnil;
4513 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4515 static void
4516 timer_stop_idle ()
4518 EMACS_SET_SECS_USECS (timer_idleness_start_time, -1, -1);
4521 /* Resume idle timer from last idle start time. */
4523 static void
4524 timer_resume_idle ()
4526 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4527 return;
4529 timer_idleness_start_time = timer_last_idleness_start_time;
4532 /* This is only for debugging. */
4533 struct input_event last_timer_event;
4535 /* List of elisp functions to call, delayed because they were generated in
4536 a context where Elisp could not be safely run (e.g. redisplay, signal,
4537 ...). Each element has the form (FUN . ARGS). */
4538 Lisp_Object pending_funcalls;
4540 extern Lisp_Object Qapply;
4542 /* Check whether a timer has fired. To prevent larger problems we simply
4543 disregard elements that are not proper timers. Do not make a circular
4544 timer list for the time being.
4546 Returns the time to wait until the next timer fires. If a
4547 timer is triggering now, return zero.
4548 If no timer is active, return -1.
4550 If a timer is ripe, we run it, with quitting turned off.
4551 In that case we return 0 to indicate that a new timer_check_2 call
4552 should be done. */
4554 static EMACS_TIME
4555 timer_check_2 ()
4557 EMACS_TIME nexttime;
4558 EMACS_TIME now, idleness_now;
4559 Lisp_Object timers, idle_timers, chosen_timer;
4560 struct gcpro gcpro1, gcpro2, gcpro3;
4562 EMACS_SET_SECS (nexttime, -1);
4563 EMACS_SET_USECS (nexttime, -1);
4565 /* Always consider the ordinary timers. */
4566 timers = Vtimer_list;
4567 /* Consider the idle timers only if Emacs is idle. */
4568 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4569 idle_timers = Vtimer_idle_list;
4570 else
4571 idle_timers = Qnil;
4572 chosen_timer = Qnil;
4573 GCPRO3 (timers, idle_timers, chosen_timer);
4575 /* First run the code that was delayed. */
4576 while (CONSP (pending_funcalls))
4578 Lisp_Object funcall = XCAR (pending_funcalls);
4579 pending_funcalls = XCDR (pending_funcalls);
4580 safe_call2 (Qapply, XCAR (funcall), XCDR (funcall));
4583 if (CONSP (timers) || CONSP (idle_timers))
4585 EMACS_GET_TIME (now);
4586 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4587 EMACS_SUB_TIME (idleness_now, now, timer_idleness_start_time);
4590 while (CONSP (timers) || CONSP (idle_timers))
4592 Lisp_Object *vector;
4593 Lisp_Object timer = Qnil, idle_timer = Qnil;
4594 EMACS_TIME timer_time, idle_timer_time;
4595 EMACS_TIME difference, timer_difference, idle_timer_difference;
4597 /* Skip past invalid timers and timers already handled. */
4598 if (!NILP (timers))
4600 timer = XCAR (timers);
4601 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
4603 timers = XCDR (timers);
4604 continue;
4606 vector = XVECTOR (timer)->contents;
4608 if (!INTEGERP (vector[1]) || !INTEGERP (vector[2])
4609 || !INTEGERP (vector[3])
4610 || ! NILP (vector[0]))
4612 timers = XCDR (timers);
4613 continue;
4616 if (!NILP (idle_timers))
4618 timer = XCAR (idle_timers);
4619 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
4621 idle_timers = XCDR (idle_timers);
4622 continue;
4624 vector = XVECTOR (timer)->contents;
4626 if (!INTEGERP (vector[1]) || !INTEGERP (vector[2])
4627 || !INTEGERP (vector[3])
4628 || ! NILP (vector[0]))
4630 idle_timers = XCDR (idle_timers);
4631 continue;
4635 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4636 based on the next ordinary timer.
4637 TIMER_DIFFERENCE is the distance in time from NOW to when
4638 this timer becomes ripe (negative if it's already ripe). */
4639 if (!NILP (timers))
4641 timer = XCAR (timers);
4642 vector = XVECTOR (timer)->contents;
4643 EMACS_SET_SECS (timer_time,
4644 (XINT (vector[1]) << 16) | (XINT (vector[2])));
4645 EMACS_SET_USECS (timer_time, XINT (vector[3]));
4646 EMACS_SUB_TIME (timer_difference, timer_time, now);
4649 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4650 based on the next idle timer. */
4651 if (!NILP (idle_timers))
4653 idle_timer = XCAR (idle_timers);
4654 vector = XVECTOR (idle_timer)->contents;
4655 EMACS_SET_SECS (idle_timer_time,
4656 (XINT (vector[1]) << 16) | (XINT (vector[2])));
4657 EMACS_SET_USECS (idle_timer_time, XINT (vector[3]));
4658 EMACS_SUB_TIME (idle_timer_difference, idle_timer_time, idleness_now);
4661 /* Decide which timer is the next timer,
4662 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4663 Also step down the list where we found that timer. */
4665 if (! NILP (timers) && ! NILP (idle_timers))
4667 EMACS_TIME temp;
4668 EMACS_SUB_TIME (temp, timer_difference, idle_timer_difference);
4669 if (EMACS_TIME_NEG_P (temp))
4671 chosen_timer = timer;
4672 timers = XCDR (timers);
4673 difference = timer_difference;
4675 else
4677 chosen_timer = idle_timer;
4678 idle_timers = XCDR (idle_timers);
4679 difference = idle_timer_difference;
4682 else if (! NILP (timers))
4684 chosen_timer = timer;
4685 timers = XCDR (timers);
4686 difference = timer_difference;
4688 else
4690 chosen_timer = idle_timer;
4691 idle_timers = XCDR (idle_timers);
4692 difference = idle_timer_difference;
4694 vector = XVECTOR (chosen_timer)->contents;
4696 /* If timer is ripe, run it if it hasn't been run. */
4697 if (EMACS_TIME_NEG_P (difference)
4698 || (EMACS_SECS (difference) == 0
4699 && EMACS_USECS (difference) == 0))
4701 if (NILP (vector[0]))
4703 int count = SPECPDL_INDEX ();
4704 Lisp_Object old_deactivate_mark = Vdeactivate_mark;
4706 /* Mark the timer as triggered to prevent problems if the lisp
4707 code fails to reschedule it right. */
4708 vector[0] = Qt;
4710 specbind (Qinhibit_quit, Qt);
4712 call1 (Qtimer_event_handler, chosen_timer);
4713 Vdeactivate_mark = old_deactivate_mark;
4714 timers_run++;
4715 unbind_to (count, Qnil);
4717 /* Since we have handled the event,
4718 we don't need to tell the caller to wake up and do it. */
4719 /* But the caller must still wait for the next timer, so
4720 return 0 to indicate that. */
4723 EMACS_SET_SECS (nexttime, 0);
4724 EMACS_SET_USECS (nexttime, 0);
4726 else
4727 /* When we encounter a timer that is still waiting,
4728 return the amount of time to wait before it is ripe. */
4730 UNGCPRO;
4731 return difference;
4735 /* No timers are pending in the future. */
4736 /* Return 0 if we generated an event, and -1 if not. */
4737 UNGCPRO;
4738 return nexttime;
4742 /* Check whether a timer has fired. To prevent larger problems we simply
4743 disregard elements that are not proper timers. Do not make a circular
4744 timer list for the time being.
4746 Returns the time to wait until the next timer fires.
4747 If no timer is active, return -1.
4749 As long as any timer is ripe, we run it.
4751 DO_IT_NOW is now ignored. It used to mean that we should
4752 run the timer directly instead of queueing a timer-event.
4753 Now we always run timers directly. */
4755 EMACS_TIME
4756 timer_check (do_it_now)
4757 int do_it_now;
4759 EMACS_TIME nexttime;
4763 nexttime = timer_check_2 ();
4765 while (EMACS_SECS (nexttime) == 0 && EMACS_USECS (nexttime) == 0);
4767 return nexttime;
4770 DEFUN ("current-idle-time", Fcurrent_idle_time, Scurrent_idle_time, 0, 0, 0,
4771 doc: /* Return the current length of Emacs idleness, or nil.
4772 The value when Emacs is idle is a list of three integers. The first has
4773 the most significant 16 bits of the seconds, while the second has the least
4774 significant 16 bits. The third integer gives the microsecond count.
4776 The value when Emacs is not idle is nil.
4778 The microsecond count is zero on systems that do not provide
4779 resolution finer than a second. */)
4782 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4784 EMACS_TIME now, idleness_now;
4786 EMACS_GET_TIME (now);
4787 EMACS_SUB_TIME (idleness_now, now, timer_idleness_start_time);
4789 return list3 (make_number ((EMACS_SECS (idleness_now) >> 16) & 0xffff),
4790 make_number ((EMACS_SECS (idleness_now) >> 0) & 0xffff),
4791 make_number (EMACS_USECS (idleness_now)));
4794 return Qnil;
4797 /* Caches for modify_event_symbol. */
4798 static Lisp_Object accent_key_syms;
4799 static Lisp_Object func_key_syms;
4800 static Lisp_Object mouse_syms;
4801 static Lisp_Object wheel_syms;
4802 static Lisp_Object drag_n_drop_syms;
4804 /* This is a list of keysym codes for special "accent" characters.
4805 It parallels lispy_accent_keys. */
4807 static const int lispy_accent_codes[] =
4809 #ifdef XK_dead_circumflex
4810 XK_dead_circumflex,
4811 #else
4813 #endif
4814 #ifdef XK_dead_grave
4815 XK_dead_grave,
4816 #else
4818 #endif
4819 #ifdef XK_dead_tilde
4820 XK_dead_tilde,
4821 #else
4823 #endif
4824 #ifdef XK_dead_diaeresis
4825 XK_dead_diaeresis,
4826 #else
4828 #endif
4829 #ifdef XK_dead_macron
4830 XK_dead_macron,
4831 #else
4833 #endif
4834 #ifdef XK_dead_degree
4835 XK_dead_degree,
4836 #else
4838 #endif
4839 #ifdef XK_dead_acute
4840 XK_dead_acute,
4841 #else
4843 #endif
4844 #ifdef XK_dead_cedilla
4845 XK_dead_cedilla,
4846 #else
4848 #endif
4849 #ifdef XK_dead_breve
4850 XK_dead_breve,
4851 #else
4853 #endif
4854 #ifdef XK_dead_ogonek
4855 XK_dead_ogonek,
4856 #else
4858 #endif
4859 #ifdef XK_dead_caron
4860 XK_dead_caron,
4861 #else
4863 #endif
4864 #ifdef XK_dead_doubleacute
4865 XK_dead_doubleacute,
4866 #else
4868 #endif
4869 #ifdef XK_dead_abovedot
4870 XK_dead_abovedot,
4871 #else
4873 #endif
4874 #ifdef XK_dead_abovering
4875 XK_dead_abovering,
4876 #else
4878 #endif
4879 #ifdef XK_dead_iota
4880 XK_dead_iota,
4881 #else
4883 #endif
4884 #ifdef XK_dead_belowdot
4885 XK_dead_belowdot,
4886 #else
4888 #endif
4889 #ifdef XK_dead_voiced_sound
4890 XK_dead_voiced_sound,
4891 #else
4893 #endif
4894 #ifdef XK_dead_semivoiced_sound
4895 XK_dead_semivoiced_sound,
4896 #else
4898 #endif
4899 #ifdef XK_dead_hook
4900 XK_dead_hook,
4901 #else
4903 #endif
4904 #ifdef XK_dead_horn
4905 XK_dead_horn,
4906 #else
4908 #endif
4911 /* This is a list of Lisp names for special "accent" characters.
4912 It parallels lispy_accent_codes. */
4914 static char *lispy_accent_keys[] =
4916 "dead-circumflex",
4917 "dead-grave",
4918 "dead-tilde",
4919 "dead-diaeresis",
4920 "dead-macron",
4921 "dead-degree",
4922 "dead-acute",
4923 "dead-cedilla",
4924 "dead-breve",
4925 "dead-ogonek",
4926 "dead-caron",
4927 "dead-doubleacute",
4928 "dead-abovedot",
4929 "dead-abovering",
4930 "dead-iota",
4931 "dead-belowdot",
4932 "dead-voiced-sound",
4933 "dead-semivoiced-sound",
4934 "dead-hook",
4935 "dead-horn",
4938 #ifdef HAVE_NTGUI
4939 #define FUNCTION_KEY_OFFSET 0x0
4941 char *lispy_function_keys[] =
4943 0, /* 0 */
4945 0, /* VK_LBUTTON 0x01 */
4946 0, /* VK_RBUTTON 0x02 */
4947 "cancel", /* VK_CANCEL 0x03 */
4948 0, /* VK_MBUTTON 0x04 */
4950 0, 0, 0, /* 0x05 .. 0x07 */
4952 "backspace", /* VK_BACK 0x08 */
4953 "tab", /* VK_TAB 0x09 */
4955 0, 0, /* 0x0A .. 0x0B */
4957 "clear", /* VK_CLEAR 0x0C */
4958 "return", /* VK_RETURN 0x0D */
4960 0, 0, /* 0x0E .. 0x0F */
4962 0, /* VK_SHIFT 0x10 */
4963 0, /* VK_CONTROL 0x11 */
4964 0, /* VK_MENU 0x12 */
4965 "pause", /* VK_PAUSE 0x13 */
4966 "capslock", /* VK_CAPITAL 0x14 */
4967 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4968 0, /* 0x16 */
4969 "junja", /* VK_JUNJA 0x17 */
4970 "final", /* VK_FINAL 0x18 */
4971 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4972 0, /* 0x1A */
4973 "escape", /* VK_ESCAPE 0x1B */
4974 "convert", /* VK_CONVERT 0x1C */
4975 "non-convert", /* VK_NONCONVERT 0x1D */
4976 "accept", /* VK_ACCEPT 0x1E */
4977 "mode-change", /* VK_MODECHANGE 0x1F */
4978 0, /* VK_SPACE 0x20 */
4979 "prior", /* VK_PRIOR 0x21 */
4980 "next", /* VK_NEXT 0x22 */
4981 "end", /* VK_END 0x23 */
4982 "home", /* VK_HOME 0x24 */
4983 "left", /* VK_LEFT 0x25 */
4984 "up", /* VK_UP 0x26 */
4985 "right", /* VK_RIGHT 0x27 */
4986 "down", /* VK_DOWN 0x28 */
4987 "select", /* VK_SELECT 0x29 */
4988 "print", /* VK_PRINT 0x2A */
4989 "execute", /* VK_EXECUTE 0x2B */
4990 "snapshot", /* VK_SNAPSHOT 0x2C */
4991 "insert", /* VK_INSERT 0x2D */
4992 "delete", /* VK_DELETE 0x2E */
4993 "help", /* VK_HELP 0x2F */
4995 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4997 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4999 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
5001 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
5003 0, 0, 0, 0, 0, 0, 0, 0, 0,
5004 0, 0, 0, 0, 0, 0, 0, 0, 0,
5005 0, 0, 0, 0, 0, 0, 0, 0,
5007 "lwindow", /* VK_LWIN 0x5B */
5008 "rwindow", /* VK_RWIN 0x5C */
5009 "apps", /* VK_APPS 0x5D */
5010 0, /* 0x5E */
5011 "sleep",
5012 "kp-0", /* VK_NUMPAD0 0x60 */
5013 "kp-1", /* VK_NUMPAD1 0x61 */
5014 "kp-2", /* VK_NUMPAD2 0x62 */
5015 "kp-3", /* VK_NUMPAD3 0x63 */
5016 "kp-4", /* VK_NUMPAD4 0x64 */
5017 "kp-5", /* VK_NUMPAD5 0x65 */
5018 "kp-6", /* VK_NUMPAD6 0x66 */
5019 "kp-7", /* VK_NUMPAD7 0x67 */
5020 "kp-8", /* VK_NUMPAD8 0x68 */
5021 "kp-9", /* VK_NUMPAD9 0x69 */
5022 "kp-multiply", /* VK_MULTIPLY 0x6A */
5023 "kp-add", /* VK_ADD 0x6B */
5024 "kp-separator", /* VK_SEPARATOR 0x6C */
5025 "kp-subtract", /* VK_SUBTRACT 0x6D */
5026 "kp-decimal", /* VK_DECIMAL 0x6E */
5027 "kp-divide", /* VK_DIVIDE 0x6F */
5028 "f1", /* VK_F1 0x70 */
5029 "f2", /* VK_F2 0x71 */
5030 "f3", /* VK_F3 0x72 */
5031 "f4", /* VK_F4 0x73 */
5032 "f5", /* VK_F5 0x74 */
5033 "f6", /* VK_F6 0x75 */
5034 "f7", /* VK_F7 0x76 */
5035 "f8", /* VK_F8 0x77 */
5036 "f9", /* VK_F9 0x78 */
5037 "f10", /* VK_F10 0x79 */
5038 "f11", /* VK_F11 0x7A */
5039 "f12", /* VK_F12 0x7B */
5040 "f13", /* VK_F13 0x7C */
5041 "f14", /* VK_F14 0x7D */
5042 "f15", /* VK_F15 0x7E */
5043 "f16", /* VK_F16 0x7F */
5044 "f17", /* VK_F17 0x80 */
5045 "f18", /* VK_F18 0x81 */
5046 "f19", /* VK_F19 0x82 */
5047 "f20", /* VK_F20 0x83 */
5048 "f21", /* VK_F21 0x84 */
5049 "f22", /* VK_F22 0x85 */
5050 "f23", /* VK_F23 0x86 */
5051 "f24", /* VK_F24 0x87 */
5053 0, 0, 0, 0, /* 0x88 .. 0x8B */
5054 0, 0, 0, 0, /* 0x8C .. 0x8F */
5056 "kp-numlock", /* VK_NUMLOCK 0x90 */
5057 "scroll", /* VK_SCROLL 0x91 */
5058 /* Not sure where the following block comes from.
5059 Windows headers have NEC and Fujitsu specific keys in
5060 this block, but nothing generic. */
5061 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
5062 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
5063 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
5064 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
5065 "kp-end", /* VK_NUMPAD_END 0x96 */
5066 "kp-home", /* VK_NUMPAD_HOME 0x97 */
5067 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
5068 "kp-up", /* VK_NUMPAD_UP 0x99 */
5069 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
5070 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
5071 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
5072 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
5074 0, 0, /* 0x9E .. 0x9F */
5077 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
5078 * Used only as parameters to GetAsyncKeyState and GetKeyState.
5079 * No other API or message will distinguish left and right keys this way.
5080 * 0xA0 .. 0xA5
5082 0, 0, 0, 0, 0, 0,
5084 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
5085 to enable them selectively, and gives access to a few more functions.
5086 See lispy_multimedia_keys below. */
5087 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
5088 0, 0, 0, /* 0xAD .. 0xAF Volume */
5089 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
5090 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
5092 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
5093 0, 0, 0, 0, 0, 0, 0, 0, 0,
5095 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
5096 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5097 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5099 0, /* 0xE0 */
5100 "ax", /* VK_OEM_AX 0xE1 */
5101 0, /* VK_OEM_102 0xE2 */
5102 "ico-help", /* VK_ICO_HELP 0xE3 */
5103 "ico-00", /* VK_ICO_00 0xE4 */
5104 0, /* VK_PROCESSKEY 0xE5 */
5105 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
5106 "packet", /* VK_PACKET 0xE7 */
5107 0, /* 0xE8 */
5108 "reset", /* VK_OEM_RESET 0xE9 */
5109 "jump", /* VK_OEM_JUMP 0xEA */
5110 "oem-pa1", /* VK_OEM_PA1 0xEB */
5111 "oem-pa2", /* VK_OEM_PA2 0xEC */
5112 "oem-pa3", /* VK_OEM_PA3 0xED */
5113 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
5114 "cusel", /* VK_OEM_CUSEL 0xEF */
5115 "oem-attn", /* VK_OEM_ATTN 0xF0 */
5116 "finish", /* VK_OEM_FINISH 0xF1 */
5117 "copy", /* VK_OEM_COPY 0xF2 */
5118 "auto", /* VK_OEM_AUTO 0xF3 */
5119 "enlw", /* VK_OEM_ENLW 0xF4 */
5120 "backtab", /* VK_OEM_BACKTAB 0xF5 */
5121 "attn", /* VK_ATTN 0xF6 */
5122 "crsel", /* VK_CRSEL 0xF7 */
5123 "exsel", /* VK_EXSEL 0xF8 */
5124 "ereof", /* VK_EREOF 0xF9 */
5125 "play", /* VK_PLAY 0xFA */
5126 "zoom", /* VK_ZOOM 0xFB */
5127 "noname", /* VK_NONAME 0xFC */
5128 "pa1", /* VK_PA1 0xFD */
5129 "oem_clear", /* VK_OEM_CLEAR 0xFE */
5130 0 /* 0xFF */
5133 /* Some of these duplicate the "Media keys" on newer keyboards,
5134 but they are delivered to the application in a different way. */
5135 static char *lispy_multimedia_keys[] =
5138 "browser-back",
5139 "browser-forward",
5140 "browser-refresh",
5141 "browser-stop",
5142 "browser-search",
5143 "browser-favorites",
5144 "browser-home",
5145 "volume-mute",
5146 "volume-down",
5147 "volume-up",
5148 "media-next",
5149 "media-previous",
5150 "media-stop",
5151 "media-play-pause",
5152 "mail",
5153 "media-select",
5154 "app-1",
5155 "app-2",
5156 "bass-down",
5157 "bass-boost",
5158 "bass-up",
5159 "treble-down",
5160 "treble-up",
5161 "mic-volume-mute",
5162 "mic-volume-down",
5163 "mic-volume-up",
5164 "help",
5165 "find",
5166 "new",
5167 "open",
5168 "close",
5169 "save",
5170 "print",
5171 "undo",
5172 "redo",
5173 "copy",
5174 "cut",
5175 "paste",
5176 "mail-reply",
5177 "mail-forward",
5178 "mail-send",
5179 "spell-check",
5180 "toggle-dictate-command",
5181 "mic-toggle",
5182 "correction-list",
5183 "media-play",
5184 "media-pause",
5185 "media-record",
5186 "media-fast-forward",
5187 "media-rewind",
5188 "media-channel-up",
5189 "media-channel-down"
5192 #else /* not HAVE_NTGUI */
5194 /* This should be dealt with in XTread_socket now, and that doesn't
5195 depend on the client system having the Kana syms defined. See also
5196 the XK_kana_A case below. */
5197 #if 0
5198 #ifdef XK_kana_A
5199 static char *lispy_kana_keys[] =
5201 /* X Keysym value */
5202 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5203 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5204 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5205 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5206 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5207 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5208 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5209 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5210 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5211 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5212 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5213 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5214 "kana-i", "kana-u", "kana-e", "kana-o",
5215 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5216 "prolongedsound", "kana-A", "kana-I", "kana-U",
5217 "kana-E", "kana-O", "kana-KA", "kana-KI",
5218 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5219 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5220 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5221 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5222 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5223 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5224 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5225 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5226 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5227 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5228 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5229 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5231 #endif /* XK_kana_A */
5232 #endif /* 0 */
5234 #define FUNCTION_KEY_OFFSET 0xff00
5236 /* You'll notice that this table is arranged to be conveniently
5237 indexed by X Windows keysym values. */
5238 static char *lispy_function_keys[] =
5240 /* X Keysym value */
5242 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5243 "backspace", "tab", "linefeed", "clear",
5244 0, "return", 0, 0,
5245 0, 0, 0, "pause", /* 0xff10...1f */
5246 0, 0, 0, 0, 0, 0, 0, "escape",
5247 0, 0, 0, 0,
5248 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5249 "romaji", "hiragana", "katakana", "hiragana-katakana",
5250 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5251 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5252 "eisu-toggle", /* 0xff30...3f */
5253 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5254 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5256 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5257 "down", "prior", "next", "end",
5258 "begin", 0, 0, 0, 0, 0, 0, 0,
5259 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5260 "print",
5261 "execute",
5262 "insert",
5263 0, /* 0xff64 */
5264 "undo",
5265 "redo",
5266 "menu",
5267 "find",
5268 "cancel",
5269 "help",
5270 "break", /* 0xff6b */
5272 0, 0, 0, 0,
5273 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5274 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5275 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5276 0, 0, 0, 0, 0, 0, 0, 0,
5277 "kp-tab", /* 0xff89 */
5278 0, 0, 0,
5279 "kp-enter", /* 0xff8d */
5280 0, 0, 0,
5281 "kp-f1", /* 0xff91 */
5282 "kp-f2",
5283 "kp-f3",
5284 "kp-f4",
5285 "kp-home", /* 0xff95 */
5286 "kp-left",
5287 "kp-up",
5288 "kp-right",
5289 "kp-down",
5290 "kp-prior", /* kp-page-up */
5291 "kp-next", /* kp-page-down */
5292 "kp-end",
5293 "kp-begin",
5294 "kp-insert",
5295 "kp-delete",
5296 0, /* 0xffa0 */
5297 0, 0, 0, 0, 0, 0, 0, 0, 0,
5298 "kp-multiply", /* 0xffaa */
5299 "kp-add",
5300 "kp-separator",
5301 "kp-subtract",
5302 "kp-decimal",
5303 "kp-divide", /* 0xffaf */
5304 "kp-0", /* 0xffb0 */
5305 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5306 0, /* 0xffba */
5307 0, 0,
5308 "kp-equal", /* 0xffbd */
5309 "f1", /* 0xffbe */ /* IsFunctionKey */
5310 "f2",
5311 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5312 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5313 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5314 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5315 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5316 0, 0, 0, 0, 0, 0, 0, 0,
5317 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5318 0, 0, 0, 0, 0, 0, 0, "delete"
5321 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5322 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5324 static char *iso_lispy_function_keys[] =
5326 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5327 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5328 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5329 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5330 "iso-lefttab", /* 0xfe20 */
5331 "iso-move-line-up", "iso-move-line-down",
5332 "iso-partial-line-up", "iso-partial-line-down",
5333 "iso-partial-space-left", "iso-partial-space-right",
5334 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5335 "iso-release-margin-left", "iso-release-margin-right",
5336 "iso-release-both-margins",
5337 "iso-fast-cursor-left", "iso-fast-cursor-right",
5338 "iso-fast-cursor-up", "iso-fast-cursor-down",
5339 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5340 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5343 #endif /* not HAVE_NTGUI */
5345 Lisp_Object Vlispy_mouse_stem;
5347 static char *lispy_wheel_names[] =
5349 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5352 /* drag-n-drop events are generated when a set of selected files are
5353 dragged from another application and dropped onto an Emacs window. */
5354 static char *lispy_drag_n_drop_names[] =
5356 "drag-n-drop"
5359 /* Scroll bar parts. */
5360 Lisp_Object Qabove_handle, Qhandle, Qbelow_handle;
5361 Lisp_Object Qup, Qdown, Qbottom, Qend_scroll;
5362 Lisp_Object Qtop, Qratio;
5364 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5365 Lisp_Object *scroll_bar_parts[] = {
5366 &Qabove_handle, &Qhandle, &Qbelow_handle,
5367 &Qup, &Qdown, &Qtop, &Qbottom, &Qend_scroll, &Qratio
5370 /* A vector, indexed by button number, giving the down-going location
5371 of currently depressed buttons, both scroll bar and non-scroll bar.
5373 The elements have the form
5374 (BUTTON-NUMBER MODIFIER-MASK . REST)
5375 where REST is the cdr of a position as it would be reported in the event.
5377 The make_lispy_event function stores positions here to tell the
5378 difference between click and drag events, and to store the starting
5379 location to be included in drag events. */
5381 static Lisp_Object button_down_location;
5383 /* Information about the most recent up-going button event: Which
5384 button, what location, and what time. */
5386 static int last_mouse_button;
5387 static int last_mouse_x;
5388 static int last_mouse_y;
5389 static unsigned long button_down_time;
5391 /* The maximum time between clicks to make a double-click, or Qnil to
5392 disable double-click detection, or Qt for no time limit. */
5394 Lisp_Object impl_Vdouble_click_time;
5396 /* Maximum number of pixels the mouse may be moved between clicks
5397 to make a double-click. */
5399 EMACS_INT double_click_fuzz;
5401 /* The number of clicks in this multiple-click. */
5403 int double_click_count;
5405 /* Return position of a mouse click or wheel event */
5407 static Lisp_Object
5408 make_lispy_position (f, x, y, time)
5409 struct frame *f;
5410 Lisp_Object *x, *y;
5411 unsigned long time;
5413 Lisp_Object window;
5414 enum window_part part;
5415 Lisp_Object posn = Qnil;
5416 Lisp_Object extra_info = Qnil;
5417 int wx, wy;
5419 /* Set `window' to the window under frame pixel coordinates (x,y) */
5420 if (f)
5421 window = window_from_coordinates (f, XINT (*x), XINT (*y),
5422 &part, &wx, &wy, 0);
5423 else
5424 window = Qnil;
5426 if (WINDOWP (window))
5428 /* It's a click in window window at frame coordinates (x,y) */
5429 struct window *w = XWINDOW (window);
5430 Lisp_Object string_info = Qnil;
5431 int textpos = -1, rx = -1, ry = -1;
5432 int dx = -1, dy = -1;
5433 int width = -1, height = -1;
5434 Lisp_Object object = Qnil;
5436 /* Set event coordinates to window-relative coordinates
5437 for constructing the Lisp event below. */
5438 XSETINT (*x, wx);
5439 XSETINT (*y, wy);
5441 if (part == ON_TEXT)
5443 wx += WINDOW_LEFT_MARGIN_WIDTH (w);
5445 else if (part == ON_MODE_LINE || part == ON_HEADER_LINE)
5447 /* Mode line or header line. Look for a string under
5448 the mouse that may have a `local-map' property. */
5449 Lisp_Object string;
5450 int charpos;
5452 posn = part == ON_MODE_LINE ? Qmode_line : Qheader_line;
5453 rx = wx, ry = wy;
5454 string = mode_line_string (w, part, &rx, &ry, &charpos,
5455 &object, &dx, &dy, &width, &height);
5456 if (STRINGP (string))
5457 string_info = Fcons (string, make_number (charpos));
5458 if (w == XWINDOW (selected_window)
5459 && current_buffer == XBUFFER (w->buffer))
5460 textpos = PT;
5461 else
5462 textpos = XMARKER (w->pointm)->charpos;
5464 else if (part == ON_VERTICAL_BORDER)
5466 posn = Qvertical_line;
5467 wx = -1;
5468 dx = 0;
5469 width = 1;
5471 else if (part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
5473 Lisp_Object string;
5474 int charpos;
5476 posn = (part == ON_LEFT_MARGIN) ? Qleft_margin : Qright_margin;
5477 rx = wx, ry = wy;
5478 string = marginal_area_string (w, part, &rx, &ry, &charpos,
5479 &object, &dx, &dy, &width, &height);
5480 if (STRINGP (string))
5481 string_info = Fcons (string, make_number (charpos));
5482 if (part == ON_LEFT_MARGIN)
5483 wx = 0;
5484 else
5485 wx = window_box_right_offset (w, TEXT_AREA) - 1;
5487 else if (part == ON_LEFT_FRINGE)
5489 posn = Qleft_fringe;
5490 rx = 0;
5491 dx = wx;
5492 wx = (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5494 : window_box_width (w, LEFT_MARGIN_AREA));
5495 dx -= wx;
5497 else if (part == ON_RIGHT_FRINGE)
5499 posn = Qright_fringe;
5500 rx = 0;
5501 dx = wx;
5502 wx = (window_box_width (w, LEFT_MARGIN_AREA)
5503 + window_box_width (w, TEXT_AREA)
5504 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5505 ? window_box_width (w, RIGHT_MARGIN_AREA)
5506 : 0));
5507 dx -= wx;
5509 else
5511 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5512 wx = max (WINDOW_LEFT_MARGIN_WIDTH (w), wx);
5515 if (textpos < 0)
5517 Lisp_Object string2, object2 = Qnil;
5518 struct display_pos p;
5519 int dx2, dy2;
5520 int width2, height2;
5521 string2 = buffer_posn_from_coords (w, &wx, &wy, &p,
5522 &object2, &dx2, &dy2,
5523 &width2, &height2);
5524 textpos = CHARPOS (p.pos);
5525 if (rx < 0) rx = wx;
5526 if (ry < 0) ry = wy;
5527 if (dx < 0) dx = dx2;
5528 if (dy < 0) dy = dy2;
5529 if (width < 0) width = width2;
5530 if (height < 0) height = height2;
5532 if (NILP (posn))
5534 posn = make_number (textpos);
5535 if (STRINGP (string2))
5536 string_info = Fcons (string2,
5537 make_number (CHARPOS (p.string_pos)));
5539 if (NILP (object))
5540 object = object2;
5543 #ifdef HAVE_WINDOW_SYSTEM
5544 if (IMAGEP (object))
5546 Lisp_Object image_map, hotspot;
5547 if ((image_map = Fplist_get (XCDR (object), QCmap),
5548 !NILP (image_map))
5549 && (hotspot = find_hot_spot (image_map, dx, dy),
5550 CONSP (hotspot))
5551 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
5552 posn = XCAR (hotspot);
5554 #endif
5556 /* Object info */
5557 extra_info = Fcons (object,
5558 Fcons (Fcons (make_number (dx),
5559 make_number (dy)),
5560 Fcons (Fcons (make_number (width),
5561 make_number (height)),
5562 Qnil)));
5564 /* String info */
5565 extra_info = Fcons (string_info,
5566 Fcons (make_number (textpos),
5567 Fcons (Fcons (make_number (rx),
5568 make_number (ry)),
5569 extra_info)));
5571 else if (f != 0)
5573 XSETFRAME (window, f);
5575 else
5577 window = Qnil;
5578 XSETFASTINT (*x, 0);
5579 XSETFASTINT (*y, 0);
5582 return Fcons (window,
5583 Fcons (posn,
5584 Fcons (Fcons (*x, *y),
5585 Fcons (make_number (time),
5586 extra_info))));
5589 /* Given a struct input_event, build the lisp event which represents
5590 it. If EVENT is 0, build a mouse movement event from the mouse
5591 movement buffer, which should have a movement event in it.
5593 Note that events must be passed to this function in the order they
5594 are received; this function stores the location of button presses
5595 in order to build drag events when the button is released. */
5597 static Lisp_Object
5598 make_lispy_event (event)
5599 struct input_event *event;
5601 int i;
5603 switch (SWITCH_ENUM_CAST (event->kind))
5605 /* A simple keystroke. */
5606 case ASCII_KEYSTROKE_EVENT:
5607 case MULTIBYTE_CHAR_KEYSTROKE_EVENT:
5609 Lisp_Object lispy_c;
5610 int c = event->code;
5611 if (event->kind == ASCII_KEYSTROKE_EVENT)
5613 c &= 0377;
5614 eassert (c == event->code);
5615 /* Turn ASCII characters into control characters
5616 when proper. */
5617 if (event->modifiers & ctrl_modifier)
5619 c = make_ctrl_char (c);
5620 event->modifiers &= ~ctrl_modifier;
5624 /* Add in the other modifier bits. The shift key was taken care
5625 of by the X code. */
5626 c |= (event->modifiers
5627 & (meta_modifier | alt_modifier
5628 | hyper_modifier | super_modifier | ctrl_modifier));
5629 /* Distinguish Shift-SPC from SPC. */
5630 if ((event->code) == 040
5631 && event->modifiers & shift_modifier)
5632 c |= shift_modifier;
5633 button_down_time = 0;
5634 XSETFASTINT (lispy_c, c);
5635 return lispy_c;
5638 #ifdef HAVE_NS
5639 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5640 except that they are non-key events (last-nonmenu-event is nil). */
5641 case NS_NONKEY_EVENT:
5642 #endif
5644 /* A function key. The symbol may need to have modifier prefixes
5645 tacked onto it. */
5646 case NON_ASCII_KEYSTROKE_EVENT:
5647 button_down_time = 0;
5649 for (i = 0; i < sizeof (lispy_accent_codes) / sizeof (int); i++)
5650 if (event->code == lispy_accent_codes[i])
5651 return modify_event_symbol (i,
5652 event->modifiers,
5653 Qfunction_key, Qnil,
5654 lispy_accent_keys, &accent_key_syms,
5655 (sizeof (lispy_accent_keys)
5656 / sizeof (lispy_accent_keys[0])));
5658 #if 0
5659 #ifdef XK_kana_A
5660 if (event->code >= 0x400 && event->code < 0x500)
5661 return modify_event_symbol (event->code - 0x400,
5662 event->modifiers & ~shift_modifier,
5663 Qfunction_key, Qnil,
5664 lispy_kana_keys, &func_key_syms,
5665 (sizeof (lispy_kana_keys)
5666 / sizeof (lispy_kana_keys[0])));
5667 #endif /* XK_kana_A */
5668 #endif /* 0 */
5670 #ifdef ISO_FUNCTION_KEY_OFFSET
5671 if (event->code < FUNCTION_KEY_OFFSET
5672 && event->code >= ISO_FUNCTION_KEY_OFFSET)
5673 return modify_event_symbol (event->code - ISO_FUNCTION_KEY_OFFSET,
5674 event->modifiers,
5675 Qfunction_key, Qnil,
5676 iso_lispy_function_keys, &func_key_syms,
5677 (sizeof (iso_lispy_function_keys)
5678 / sizeof (iso_lispy_function_keys[0])));
5679 #endif
5681 /* Handle system-specific or unknown keysyms. */
5682 if (event->code & (1 << 28)
5683 || event->code - FUNCTION_KEY_OFFSET < 0
5684 || (event->code - FUNCTION_KEY_OFFSET
5685 >= sizeof lispy_function_keys / sizeof *lispy_function_keys)
5686 || !lispy_function_keys[event->code - FUNCTION_KEY_OFFSET])
5688 /* We need to use an alist rather than a vector as the cache
5689 since we can't make a vector long enuf. */
5690 if (NILP (current_kboard->system_key_syms))
5691 current_kboard->system_key_syms = Fcons (Qnil, Qnil);
5692 return modify_event_symbol (event->code,
5693 event->modifiers,
5694 Qfunction_key,
5695 current_kboard->Vsystem_key_alist,
5696 0, &current_kboard->system_key_syms,
5697 (unsigned) -1);
5700 return modify_event_symbol (event->code - FUNCTION_KEY_OFFSET,
5701 event->modifiers,
5702 Qfunction_key, Qnil,
5703 lispy_function_keys, &func_key_syms,
5704 (sizeof (lispy_function_keys)
5705 / sizeof (lispy_function_keys[0])));
5707 #ifdef WINDOWSNT
5708 case MULTIMEDIA_KEY_EVENT:
5709 if (event->code < (sizeof (lispy_multimedia_keys)
5710 / sizeof (lispy_multimedia_keys[0]))
5711 && event->code > 0 && lispy_multimedia_keys[event->code])
5713 return modify_event_symbol (event->code, event->modifiers,
5714 Qfunction_key, Qnil,
5715 lispy_multimedia_keys, &func_key_syms,
5716 (sizeof (lispy_multimedia_keys)
5717 / sizeof (lispy_multimedia_keys[0])));
5719 return Qnil;
5720 #endif
5722 #ifdef HAVE_MOUSE
5723 /* A mouse click. Figure out where it is, decide whether it's
5724 a press, click or drag, and build the appropriate structure. */
5725 case MOUSE_CLICK_EVENT:
5726 #ifndef USE_TOOLKIT_SCROLL_BARS
5727 case SCROLL_BAR_CLICK_EVENT:
5728 #endif
5730 int button = event->code;
5731 int is_double;
5732 Lisp_Object position;
5733 Lisp_Object *start_pos_ptr;
5734 Lisp_Object start_pos;
5736 position = Qnil;
5738 /* Build the position as appropriate for this mouse click. */
5739 if (event->kind == MOUSE_CLICK_EVENT)
5741 struct frame *f = XFRAME (event->frame_or_window);
5742 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5743 int row, column;
5744 #endif
5746 /* Ignore mouse events that were made on frame that
5747 have been deleted. */
5748 if (! FRAME_LIVE_P (f))
5749 return Qnil;
5751 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5752 /* EVENT->x and EVENT->y are frame-relative pixel
5753 coordinates at this place. Under old redisplay, COLUMN
5754 and ROW are set to frame relative glyph coordinates
5755 which are then used to determine whether this click is
5756 in a menu (non-toolkit version). */
5757 pixel_to_glyph_coords (f, XINT (event->x), XINT (event->y),
5758 &column, &row, NULL, 1);
5760 /* In the non-toolkit version, clicks on the menu bar
5761 are ordinary button events in the event buffer.
5762 Distinguish them, and invoke the menu.
5764 (In the toolkit version, the toolkit handles the menu bar
5765 and Emacs doesn't know about it until after the user
5766 makes a selection.) */
5767 if (row >= 0 && row < FRAME_MENU_BAR_LINES (f)
5768 && (event->modifiers & down_modifier))
5770 Lisp_Object items, item;
5771 int hpos;
5772 int i;
5774 #if 0
5775 /* Activate the menu bar on the down event. If the
5776 up event comes in before the menu code can deal with it,
5777 just ignore it. */
5778 if (! (event->modifiers & down_modifier))
5779 return Qnil;
5780 #endif
5782 /* Find the menu bar item under `column'. */
5783 item = Qnil;
5784 items = FRAME_MENU_BAR_ITEMS (f);
5785 for (i = 0; i < XVECTOR (items)->size; i += 4)
5787 Lisp_Object pos, string;
5788 string = AREF (items, i + 1);
5789 pos = AREF (items, i + 3);
5790 if (NILP (string))
5791 break;
5792 if (column >= XINT (pos)
5793 && column < XINT (pos) + SCHARS (string))
5795 item = AREF (items, i);
5796 break;
5800 /* ELisp manual 2.4b says (x y) are window relative but
5801 code says they are frame-relative. */
5802 position
5803 = Fcons (event->frame_or_window,
5804 Fcons (Qmenu_bar,
5805 Fcons (Fcons (event->x, event->y),
5806 Fcons (make_number (event->timestamp),
5807 Qnil))));
5809 return Fcons (item, Fcons (position, Qnil));
5811 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5813 position = make_lispy_position (f, &event->x, &event->y,
5814 event->timestamp);
5816 #ifndef USE_TOOLKIT_SCROLL_BARS
5817 else
5819 /* It's a scrollbar click. */
5820 Lisp_Object window;
5821 Lisp_Object portion_whole;
5822 Lisp_Object part;
5824 window = event->frame_or_window;
5825 portion_whole = Fcons (event->x, event->y);
5826 part = *scroll_bar_parts[(int) event->part];
5828 position
5829 = Fcons (window,
5830 Fcons (Qvertical_scroll_bar,
5831 Fcons (portion_whole,
5832 Fcons (make_number (event->timestamp),
5833 Fcons (part, Qnil)))));
5835 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5837 if (button >= ASIZE (button_down_location))
5839 button_down_location = larger_vector (button_down_location,
5840 button + 1, Qnil);
5841 mouse_syms = larger_vector (mouse_syms, button + 1, Qnil);
5844 start_pos_ptr = &AREF (button_down_location, button);
5845 start_pos = *start_pos_ptr;
5846 *start_pos_ptr = Qnil;
5849 /* On window-system frames, use the value of
5850 double-click-fuzz as is. On other frames, interpret it
5851 as a multiple of 1/8 characters. */
5852 struct frame *f;
5853 int fuzz;
5855 if (WINDOWP (event->frame_or_window))
5856 f = XFRAME (XWINDOW (event->frame_or_window)->frame);
5857 else if (FRAMEP (event->frame_or_window))
5858 f = XFRAME (event->frame_or_window);
5859 else
5860 abort ();
5862 if (FRAME_WINDOW_P (f))
5863 fuzz = double_click_fuzz;
5864 else
5865 fuzz = double_click_fuzz / 8;
5867 is_double = (button == last_mouse_button
5868 && (eabs (XINT (event->x) - last_mouse_x) <= fuzz)
5869 && (eabs (XINT (event->y) - last_mouse_y) <= fuzz)
5870 && button_down_time != 0
5871 && (EQ (Vdouble_click_time, Qt)
5872 || (INTEGERP (Vdouble_click_time)
5873 && ((int)(event->timestamp - button_down_time)
5874 < XINT (Vdouble_click_time)))));
5877 last_mouse_button = button;
5878 last_mouse_x = XINT (event->x);
5879 last_mouse_y = XINT (event->y);
5881 /* If this is a button press, squirrel away the location, so
5882 we can decide later whether it was a click or a drag. */
5883 if (event->modifiers & down_modifier)
5885 if (is_double)
5887 double_click_count++;
5888 event->modifiers |= ((double_click_count > 2)
5889 ? triple_modifier
5890 : double_modifier);
5892 else
5893 double_click_count = 1;
5894 button_down_time = event->timestamp;
5895 *start_pos_ptr = Fcopy_alist (position);
5896 ignore_mouse_drag_p = 0;
5899 /* Now we're releasing a button - check the co-ordinates to
5900 see if this was a click or a drag. */
5901 else if (event->modifiers & up_modifier)
5903 /* If we did not see a down before this up, ignore the up.
5904 Probably this happened because the down event chose a
5905 menu item. It would be an annoyance to treat the
5906 release of the button that chose the menu item as a
5907 separate event. */
5909 if (!CONSP (start_pos))
5910 return Qnil;
5912 event->modifiers &= ~up_modifier;
5913 #if 0 /* Formerly we treated an up with no down as a click event. */
5914 if (!CONSP (start_pos))
5915 event->modifiers |= click_modifier;
5916 else
5917 #endif
5919 Lisp_Object down;
5920 EMACS_INT xdiff = double_click_fuzz, ydiff = double_click_fuzz;
5922 /* The third element of every position
5923 should be the (x,y) pair. */
5924 down = Fcar (Fcdr (Fcdr (start_pos)));
5925 if (CONSP (down)
5926 && INTEGERP (XCAR (down)) && INTEGERP (XCDR (down)))
5928 xdiff = XINT (event->x) - XINT (XCAR (down));
5929 ydiff = XINT (event->y) - XINT (XCDR (down));
5932 if (ignore_mouse_drag_p)
5934 event->modifiers |= click_modifier;
5935 ignore_mouse_drag_p = 0;
5937 else if (xdiff < double_click_fuzz && xdiff > - double_click_fuzz
5938 && ydiff < double_click_fuzz && ydiff > - double_click_fuzz
5939 /* Maybe the mouse has moved a lot, caused scrolling, and
5940 eventually ended up at the same screen position (but
5941 not buffer position) in which case it is a drag, not
5942 a click. */
5943 /* FIXME: OTOH if the buffer position has changed
5944 because of a timer or process filter rather than
5945 because of mouse movement, it should be considered as
5946 a click. But mouse-drag-region completely ignores
5947 this case and it hasn't caused any real problem, so
5948 it's probably OK to ignore it as well. */
5949 && EQ (Fcar (Fcdr (start_pos)), Fcar (Fcdr (position))))
5950 /* Mouse hasn't moved (much). */
5951 event->modifiers |= click_modifier;
5952 else
5954 button_down_time = 0;
5955 event->modifiers |= drag_modifier;
5958 /* Don't check is_double; treat this as multiple
5959 if the down-event was multiple. */
5960 if (double_click_count > 1)
5961 event->modifiers |= ((double_click_count > 2)
5962 ? triple_modifier
5963 : double_modifier);
5966 else
5967 /* Every mouse event should either have the down_modifier or
5968 the up_modifier set. */
5969 abort ();
5972 /* Get the symbol we should use for the mouse click. */
5973 Lisp_Object head;
5975 head = modify_event_symbol (button,
5976 event->modifiers,
5977 Qmouse_click, Vlispy_mouse_stem,
5978 NULL,
5979 &mouse_syms,
5980 XVECTOR (mouse_syms)->size);
5981 if (event->modifiers & drag_modifier)
5982 return Fcons (head,
5983 Fcons (start_pos,
5984 Fcons (position,
5985 Qnil)));
5986 else if (event->modifiers & (double_modifier | triple_modifier))
5987 return Fcons (head,
5988 Fcons (position,
5989 Fcons (make_number (double_click_count),
5990 Qnil)));
5991 else
5992 return Fcons (head,
5993 Fcons (position,
5994 Qnil));
5998 case WHEEL_EVENT:
5999 case HORIZ_WHEEL_EVENT:
6001 Lisp_Object position;
6002 Lisp_Object head;
6004 /* Build the position as appropriate for this mouse click. */
6005 struct frame *f = XFRAME (event->frame_or_window);
6007 /* Ignore wheel events that were made on frame that have been
6008 deleted. */
6009 if (! FRAME_LIVE_P (f))
6010 return Qnil;
6012 position = make_lispy_position (f, &event->x, &event->y,
6013 event->timestamp);
6015 /* Set double or triple modifiers to indicate the wheel speed. */
6017 /* On window-system frames, use the value of
6018 double-click-fuzz as is. On other frames, interpret it
6019 as a multiple of 1/8 characters. */
6020 struct frame *f;
6021 int fuzz;
6022 int symbol_num;
6023 int is_double;
6025 if (WINDOWP (event->frame_or_window))
6026 f = XFRAME (XWINDOW (event->frame_or_window)->frame);
6027 else if (FRAMEP (event->frame_or_window))
6028 f = XFRAME (event->frame_or_window);
6029 else
6030 abort ();
6032 if (FRAME_WINDOW_P (f))
6033 fuzz = double_click_fuzz;
6034 else
6035 fuzz = double_click_fuzz / 8;
6037 if (event->modifiers & up_modifier)
6039 /* Emit a wheel-up event. */
6040 event->modifiers &= ~up_modifier;
6041 symbol_num = 0;
6043 else if (event->modifiers & down_modifier)
6045 /* Emit a wheel-down event. */
6046 event->modifiers &= ~down_modifier;
6047 symbol_num = 1;
6049 else
6050 /* Every wheel event should either have the down_modifier or
6051 the up_modifier set. */
6052 abort ();
6054 if (event->kind == HORIZ_WHEEL_EVENT)
6055 symbol_num += 2;
6057 is_double = (last_mouse_button == - (1 + symbol_num)
6058 && (eabs (XINT (event->x) - last_mouse_x) <= fuzz)
6059 && (eabs (XINT (event->y) - last_mouse_y) <= fuzz)
6060 && button_down_time != 0
6061 && (EQ (Vdouble_click_time, Qt)
6062 || (INTEGERP (Vdouble_click_time)
6063 && ((int)(event->timestamp - button_down_time)
6064 < XINT (Vdouble_click_time)))));
6065 if (is_double)
6067 double_click_count++;
6068 event->modifiers |= ((double_click_count > 2)
6069 ? triple_modifier
6070 : double_modifier);
6072 else
6074 double_click_count = 1;
6075 event->modifiers |= click_modifier;
6078 button_down_time = event->timestamp;
6079 /* Use a negative value to distinguish wheel from mouse button. */
6080 last_mouse_button = - (1 + symbol_num);
6081 last_mouse_x = XINT (event->x);
6082 last_mouse_y = XINT (event->y);
6084 /* Get the symbol we should use for the wheel event. */
6085 head = modify_event_symbol (symbol_num,
6086 event->modifiers,
6087 Qmouse_click,
6088 Qnil,
6089 lispy_wheel_names,
6090 &wheel_syms,
6091 ASIZE (wheel_syms));
6094 if (event->modifiers & (double_modifier | triple_modifier))
6095 return Fcons (head,
6096 Fcons (position,
6097 Fcons (make_number (double_click_count),
6098 Qnil)));
6099 else
6100 return Fcons (head,
6101 Fcons (position,
6102 Qnil));
6106 #ifdef USE_TOOLKIT_SCROLL_BARS
6108 /* We don't have down and up events if using toolkit scroll bars,
6109 so make this always a click event. Store in the `part' of
6110 the Lisp event a symbol which maps to the following actions:
6112 `above_handle' page up
6113 `below_handle' page down
6114 `up' line up
6115 `down' line down
6116 `top' top of buffer
6117 `bottom' bottom of buffer
6118 `handle' thumb has been dragged.
6119 `end-scroll' end of interaction with scroll bar
6121 The incoming input_event contains in its `part' member an
6122 index of type `enum scroll_bar_part' which we can use as an
6123 index in scroll_bar_parts to get the appropriate symbol. */
6125 case SCROLL_BAR_CLICK_EVENT:
6127 Lisp_Object position, head, window, portion_whole, part;
6129 window = event->frame_or_window;
6130 portion_whole = Fcons (event->x, event->y);
6131 part = *scroll_bar_parts[(int) event->part];
6133 position
6134 = Fcons (window,
6135 Fcons (Qvertical_scroll_bar,
6136 Fcons (portion_whole,
6137 Fcons (make_number (event->timestamp),
6138 Fcons (part, Qnil)))));
6140 /* Always treat scroll bar events as clicks. */
6141 event->modifiers |= click_modifier;
6142 event->modifiers &= ~up_modifier;
6144 if (event->code >= ASIZE (mouse_syms))
6145 mouse_syms = larger_vector (mouse_syms, event->code + 1, Qnil);
6147 /* Get the symbol we should use for the mouse click. */
6148 head = modify_event_symbol (event->code,
6149 event->modifiers,
6150 Qmouse_click,
6151 Vlispy_mouse_stem,
6152 NULL, &mouse_syms,
6153 XVECTOR (mouse_syms)->size);
6154 return Fcons (head, Fcons (position, Qnil));
6157 #endif /* USE_TOOLKIT_SCROLL_BARS */
6159 case DRAG_N_DROP_EVENT:
6161 FRAME_PTR f;
6162 Lisp_Object head, position;
6163 Lisp_Object files;
6165 f = XFRAME (event->frame_or_window);
6166 files = event->arg;
6168 /* Ignore mouse events that were made on frames that
6169 have been deleted. */
6170 if (! FRAME_LIVE_P (f))
6171 return Qnil;
6173 position = make_lispy_position (f, &event->x, &event->y,
6174 event->timestamp);
6176 head = modify_event_symbol (0, event->modifiers,
6177 Qdrag_n_drop, Qnil,
6178 lispy_drag_n_drop_names,
6179 &drag_n_drop_syms, 1);
6180 return Fcons (head,
6181 Fcons (position,
6182 Fcons (files,
6183 Qnil)));
6185 #endif /* HAVE_MOUSE */
6187 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6188 || defined(HAVE_NS) || defined (USE_GTK)
6189 case MENU_BAR_EVENT:
6190 if (EQ (event->arg, event->frame_or_window))
6191 /* This is the prefix key. We translate this to
6192 `(menu_bar)' because the code in keyboard.c for menu
6193 events, which we use, relies on this. */
6194 return Fcons (Qmenu_bar, Qnil);
6195 return event->arg;
6196 #endif
6198 case SELECT_WINDOW_EVENT:
6199 /* Make an event (select-window (WINDOW)). */
6200 return Fcons (Qselect_window,
6201 Fcons (Fcons (event->frame_or_window, Qnil),
6202 Qnil));
6204 case TOOL_BAR_EVENT:
6205 if (EQ (event->arg, event->frame_or_window))
6206 /* This is the prefix key. We translate this to
6207 `(tool_bar)' because the code in keyboard.c for tool bar
6208 events, which we use, relies on this. */
6209 return Fcons (Qtool_bar, Qnil);
6210 else if (SYMBOLP (event->arg))
6211 return apply_modifiers (event->modifiers, event->arg);
6212 return event->arg;
6214 case USER_SIGNAL_EVENT:
6215 /* A user signal. */
6217 char *name = find_user_signal_name (event->code);
6218 if (!name)
6219 abort ();
6220 return intern (name);
6223 case SAVE_SESSION_EVENT:
6224 return Qsave_session;
6226 #ifdef HAVE_DBUS
6227 case DBUS_EVENT:
6229 return Fcons (Qdbus_event, event->arg);
6231 #endif /* HAVE_DBUS */
6233 case CONFIG_CHANGED_EVENT:
6234 return Fcons (Qconfig_changed_event,
6235 Fcons (event->arg,
6236 Fcons (event->frame_or_window, Qnil)));
6237 #ifdef HAVE_GPM
6238 case GPM_CLICK_EVENT:
6240 FRAME_PTR f = XFRAME (event->frame_or_window);
6241 Lisp_Object head, position;
6242 Lisp_Object *start_pos_ptr;
6243 Lisp_Object start_pos;
6244 int button = event->code;
6246 if (button >= ASIZE (button_down_location))
6248 button_down_location = larger_vector (button_down_location,
6249 button + 1, Qnil);
6250 mouse_syms = larger_vector (mouse_syms, button + 1, Qnil);
6253 start_pos_ptr = &AREF (button_down_location, button);
6254 start_pos = *start_pos_ptr;
6256 position = make_lispy_position (f, &event->x, &event->y,
6257 event->timestamp);
6259 if (event->modifiers & down_modifier)
6260 *start_pos_ptr = Fcopy_alist (position);
6261 else if (event->modifiers & (up_modifier | drag_modifier))
6263 if (!CONSP (start_pos))
6264 return Qnil;
6265 event->modifiers &= ~up_modifier;
6268 head = modify_event_symbol (button,
6269 event->modifiers,
6270 Qmouse_click, Vlispy_mouse_stem,
6271 NULL,
6272 &mouse_syms,
6273 XVECTOR (mouse_syms)->size);
6275 if (event->modifiers & drag_modifier)
6276 return Fcons (head,
6277 Fcons (start_pos,
6278 Fcons (position,
6279 Qnil)));
6280 else if (event->modifiers & double_modifier)
6281 return Fcons (head,
6282 Fcons (position,
6283 Fcons (make_number (2),
6284 Qnil)));
6285 else if (event->modifiers & triple_modifier)
6286 return Fcons (head,
6287 Fcons (position,
6288 Fcons (make_number (3),
6289 Qnil)));
6290 else
6291 return Fcons (head,
6292 Fcons (position,
6293 Qnil));
6295 #endif /* HAVE_GPM */
6297 /* The 'kind' field of the event is something we don't recognize. */
6298 default:
6299 abort ();
6303 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6305 static Lisp_Object
6306 make_lispy_movement (frame, bar_window, part, x, y, time)
6307 FRAME_PTR frame;
6308 Lisp_Object bar_window;
6309 enum scroll_bar_part part;
6310 Lisp_Object x, y;
6311 unsigned long time;
6313 /* Is it a scroll bar movement? */
6314 if (frame && ! NILP (bar_window))
6316 Lisp_Object part_sym;
6318 part_sym = *scroll_bar_parts[(int) part];
6319 return Fcons (Qscroll_bar_movement,
6320 (Fcons (Fcons (bar_window,
6321 Fcons (Qvertical_scroll_bar,
6322 Fcons (Fcons (x, y),
6323 Fcons (make_number (time),
6324 Fcons (part_sym,
6325 Qnil))))),
6326 Qnil)));
6329 /* Or is it an ordinary mouse movement? */
6330 else
6332 Lisp_Object position;
6334 position = make_lispy_position (frame, &x, &y, time);
6336 return Fcons (Qmouse_movement,
6337 Fcons (position,
6338 Qnil));
6342 #endif /* HAVE_MOUSE || HAVE GPM */
6344 /* Construct a switch frame event. */
6345 static Lisp_Object
6346 make_lispy_switch_frame (frame)
6347 Lisp_Object frame;
6349 return Fcons (Qswitch_frame, Fcons (frame, Qnil));
6352 /* Manipulating modifiers. */
6354 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6356 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6357 SYMBOL's name of the end of the modifiers; the string from this
6358 position is the unmodified symbol name.
6360 This doesn't use any caches. */
6362 static int
6363 parse_modifiers_uncached (symbol, modifier_end)
6364 Lisp_Object symbol;
6365 int *modifier_end;
6367 Lisp_Object name;
6368 int i;
6369 int modifiers;
6371 CHECK_SYMBOL (symbol);
6373 modifiers = 0;
6374 name = SYMBOL_NAME (symbol);
6376 for (i = 0; i+2 <= SBYTES (name); )
6378 int this_mod_end = 0;
6379 int this_mod = 0;
6381 /* See if the name continues with a modifier word.
6382 Check that the word appears, but don't check what follows it.
6383 Set this_mod and this_mod_end to record what we find. */
6385 switch (SREF (name, i))
6387 #define SINGLE_LETTER_MOD(BIT) \
6388 (this_mod_end = i + 1, this_mod = BIT)
6390 case 'A':
6391 SINGLE_LETTER_MOD (alt_modifier);
6392 break;
6394 case 'C':
6395 SINGLE_LETTER_MOD (ctrl_modifier);
6396 break;
6398 case 'H':
6399 SINGLE_LETTER_MOD (hyper_modifier);
6400 break;
6402 case 'M':
6403 SINGLE_LETTER_MOD (meta_modifier);
6404 break;
6406 case 'S':
6407 SINGLE_LETTER_MOD (shift_modifier);
6408 break;
6410 case 's':
6411 SINGLE_LETTER_MOD (super_modifier);
6412 break;
6414 #undef SINGLE_LETTER_MOD
6416 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6417 if (i + LEN + 1 <= SBYTES (name) \
6418 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6420 this_mod_end = i + LEN; \
6421 this_mod = BIT; \
6424 case 'd':
6425 MULTI_LETTER_MOD (drag_modifier, "drag", 4);
6426 MULTI_LETTER_MOD (down_modifier, "down", 4);
6427 MULTI_LETTER_MOD (double_modifier, "double", 6);
6428 break;
6430 case 't':
6431 MULTI_LETTER_MOD (triple_modifier, "triple", 6);
6432 break;
6433 #undef MULTI_LETTER_MOD
6437 /* If we found no modifier, stop looking for them. */
6438 if (this_mod_end == 0)
6439 break;
6441 /* Check there is a dash after the modifier, so that it
6442 really is a modifier. */
6443 if (this_mod_end >= SBYTES (name)
6444 || SREF (name, this_mod_end) != '-')
6445 break;
6447 /* This modifier is real; look for another. */
6448 modifiers |= this_mod;
6449 i = this_mod_end + 1;
6452 /* Should we include the `click' modifier? */
6453 if (! (modifiers & (down_modifier | drag_modifier
6454 | double_modifier | triple_modifier))
6455 && i + 7 == SBYTES (name)
6456 && strncmp (SDATA (name) + i, "mouse-", 6) == 0
6457 && ('0' <= SREF (name, i + 6) && SREF (name, i + 6) <= '9'))
6458 modifiers |= click_modifier;
6460 if (! (modifiers & (double_modifier | triple_modifier))
6461 && i + 6 < SBYTES (name)
6462 && strncmp (SDATA (name) + i, "wheel-", 6) == 0)
6463 modifiers |= click_modifier;
6465 if (modifier_end)
6466 *modifier_end = i;
6468 return modifiers;
6471 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6472 prepended to the string BASE[0..BASE_LEN-1].
6473 This doesn't use any caches. */
6474 static Lisp_Object
6475 apply_modifiers_uncached (modifiers, base, base_len, base_len_byte)
6476 int modifiers;
6477 char *base;
6478 int base_len, base_len_byte;
6480 /* Since BASE could contain nulls, we can't use intern here; we have
6481 to use Fintern, which expects a genuine Lisp_String, and keeps a
6482 reference to it. */
6483 char *new_mods
6484 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6485 int mod_len;
6488 char *p = new_mods;
6490 /* Only the event queue may use the `up' modifier; it should always
6491 be turned into a click or drag event before presented to lisp code. */
6492 if (modifiers & up_modifier)
6493 abort ();
6495 if (modifiers & alt_modifier) { *p++ = 'A'; *p++ = '-'; }
6496 if (modifiers & ctrl_modifier) { *p++ = 'C'; *p++ = '-'; }
6497 if (modifiers & hyper_modifier) { *p++ = 'H'; *p++ = '-'; }
6498 if (modifiers & meta_modifier) { *p++ = 'M'; *p++ = '-'; }
6499 if (modifiers & shift_modifier) { *p++ = 'S'; *p++ = '-'; }
6500 if (modifiers & super_modifier) { *p++ = 's'; *p++ = '-'; }
6501 if (modifiers & double_modifier) { strcpy (p, "double-"); p += 7; }
6502 if (modifiers & triple_modifier) { strcpy (p, "triple-"); p += 7; }
6503 if (modifiers & down_modifier) { strcpy (p, "down-"); p += 5; }
6504 if (modifiers & drag_modifier) { strcpy (p, "drag-"); p += 5; }
6505 /* The click modifier is denoted by the absence of other modifiers. */
6507 *p = '\0';
6509 mod_len = p - new_mods;
6513 Lisp_Object new_name;
6515 new_name = make_uninit_multibyte_string (mod_len + base_len,
6516 mod_len + base_len_byte);
6517 bcopy (new_mods, SDATA (new_name), mod_len);
6518 bcopy (base, SDATA (new_name) + mod_len, base_len_byte);
6520 return Fintern (new_name, Qnil);
6525 static const char *modifier_names[] =
6527 "up", "down", "drag", "click", "double", "triple", 0, 0,
6528 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6529 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6531 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6533 static Lisp_Object modifier_symbols;
6535 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6536 static Lisp_Object
6537 lispy_modifier_list (modifiers)
6538 int modifiers;
6540 Lisp_Object modifier_list;
6541 int i;
6543 modifier_list = Qnil;
6544 for (i = 0; (1<<i) <= modifiers && i < NUM_MOD_NAMES; i++)
6545 if (modifiers & (1<<i))
6546 modifier_list = Fcons (XVECTOR (modifier_symbols)->contents[i],
6547 modifier_list);
6549 return modifier_list;
6553 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6554 where UNMODIFIED is the unmodified form of SYMBOL,
6555 MASK is the set of modifiers present in SYMBOL's name.
6556 This is similar to parse_modifiers_uncached, but uses the cache in
6557 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6558 Qevent_symbol_elements property. */
6560 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6562 Lisp_Object
6563 parse_modifiers (symbol)
6564 Lisp_Object symbol;
6566 Lisp_Object elements;
6568 if (INTEGERP (symbol))
6569 return (Fcons (make_number (KEY_TO_CHAR (symbol)),
6570 Fcons (make_number (XINT (symbol) & CHAR_MODIFIER_MASK),
6571 Qnil)));
6572 else if (!SYMBOLP (symbol))
6573 return Qnil;
6575 elements = Fget (symbol, Qevent_symbol_element_mask);
6576 if (CONSP (elements))
6577 return elements;
6578 else
6580 int end;
6581 int modifiers = parse_modifiers_uncached (symbol, &end);
6582 Lisp_Object unmodified;
6583 Lisp_Object mask;
6585 unmodified = Fintern (make_string (SDATA (SYMBOL_NAME (symbol)) + end,
6586 SBYTES (SYMBOL_NAME (symbol)) - end),
6587 Qnil);
6589 if (modifiers & ~INTMASK)
6590 abort ();
6591 XSETFASTINT (mask, modifiers);
6592 elements = Fcons (unmodified, Fcons (mask, Qnil));
6594 /* Cache the parsing results on SYMBOL. */
6595 Fput (symbol, Qevent_symbol_element_mask,
6596 elements);
6597 Fput (symbol, Qevent_symbol_elements,
6598 Fcons (unmodified, lispy_modifier_list (modifiers)));
6600 /* Since we know that SYMBOL is modifiers applied to unmodified,
6601 it would be nice to put that in unmodified's cache.
6602 But we can't, since we're not sure that parse_modifiers is
6603 canonical. */
6605 return elements;
6609 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers,
6610 Sevent_symbol_parse_modifiers, 1, 1, 0,
6611 doc: /* Parse the event symbol. For internal use. */)
6612 (symbol)
6613 Lisp_Object symbol;
6615 /* Fill the cache if needed. */
6616 parse_modifiers (symbol);
6617 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6618 and use the Lispier representation stored on Qevent_symbol_elements
6619 instead. */
6620 return Fget (symbol, Qevent_symbol_elements);
6623 /* Apply the modifiers MODIFIERS to the symbol BASE.
6624 BASE must be unmodified.
6626 This is like apply_modifiers_uncached, but uses BASE's
6627 Qmodifier_cache property, if present. It also builds
6628 Qevent_symbol_elements properties, since it has that info anyway.
6630 apply_modifiers copies the value of BASE's Qevent_kind property to
6631 the modified symbol. */
6632 static Lisp_Object
6633 apply_modifiers (modifiers, base)
6634 int modifiers;
6635 Lisp_Object base;
6637 Lisp_Object cache, index, entry, new_symbol;
6639 /* Mask out upper bits. We don't know where this value's been. */
6640 modifiers &= INTMASK;
6642 if (INTEGERP (base))
6643 return make_number (XINT (base) | modifiers);
6645 /* The click modifier never figures into cache indices. */
6646 cache = Fget (base, Qmodifier_cache);
6647 XSETFASTINT (index, (modifiers & ~click_modifier));
6648 entry = assq_no_quit (index, cache);
6650 if (CONSP (entry))
6651 new_symbol = XCDR (entry);
6652 else
6654 /* We have to create the symbol ourselves. */
6655 new_symbol = apply_modifiers_uncached (modifiers,
6656 SDATA (SYMBOL_NAME (base)),
6657 SCHARS (SYMBOL_NAME (base)),
6658 SBYTES (SYMBOL_NAME (base)));
6660 /* Add the new symbol to the base's cache. */
6661 entry = Fcons (index, new_symbol);
6662 Fput (base, Qmodifier_cache, Fcons (entry, cache));
6664 /* We have the parsing info now for free, so we could add it to
6665 the caches:
6666 XSETFASTINT (index, modifiers);
6667 Fput (new_symbol, Qevent_symbol_element_mask,
6668 Fcons (base, Fcons (index, Qnil)));
6669 Fput (new_symbol, Qevent_symbol_elements,
6670 Fcons (base, lispy_modifier_list (modifiers)));
6671 Sadly, this is only correct if `base' is indeed a base event,
6672 which is not necessarily the case. -stef */
6675 /* Make sure this symbol is of the same kind as BASE.
6677 You'd think we could just set this once and for all when we
6678 intern the symbol above, but reorder_modifiers may call us when
6679 BASE's property isn't set right; we can't assume that just
6680 because it has a Qmodifier_cache property it must have its
6681 Qevent_kind set right as well. */
6682 if (NILP (Fget (new_symbol, Qevent_kind)))
6684 Lisp_Object kind;
6686 kind = Fget (base, Qevent_kind);
6687 if (! NILP (kind))
6688 Fput (new_symbol, Qevent_kind, kind);
6691 return new_symbol;
6695 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6696 return a symbol with the modifiers placed in the canonical order.
6697 Canonical order is alphabetical, except for down and drag, which
6698 always come last. The 'click' modifier is never written out.
6700 Fdefine_key calls this to make sure that (for example) C-M-foo
6701 and M-C-foo end up being equivalent in the keymap. */
6703 Lisp_Object
6704 reorder_modifiers (symbol)
6705 Lisp_Object symbol;
6707 /* It's hopefully okay to write the code this way, since everything
6708 will soon be in caches, and no consing will be done at all. */
6709 Lisp_Object parsed;
6711 parsed = parse_modifiers (symbol);
6712 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed))),
6713 XCAR (parsed));
6717 /* For handling events, we often want to produce a symbol whose name
6718 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6719 to some base, like the name of a function key or mouse button.
6720 modify_event_symbol produces symbols of this sort.
6722 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6723 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6724 in the table.
6726 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6727 into symbol names, or a string specifying a name stem used to
6728 construct a symbol name or the form `STEM-N', where N is the decimal
6729 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6730 non-nil; otherwise NAME_TABLE is used.
6732 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6733 persist between calls to modify_event_symbol that it can use to
6734 store a cache of the symbols it's generated for this NAME_TABLE
6735 before. The object stored there may be a vector or an alist.
6737 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6739 MODIFIERS is a set of modifier bits (as given in struct input_events)
6740 whose prefixes should be applied to the symbol name.
6742 SYMBOL_KIND is the value to be placed in the event_kind property of
6743 the returned symbol.
6745 The symbols we create are supposed to have an
6746 `event-symbol-elements' property, which lists the modifiers present
6747 in the symbol's name. */
6749 static Lisp_Object
6750 modify_event_symbol (symbol_num, modifiers, symbol_kind, name_alist_or_stem,
6751 name_table, symbol_table, table_size)
6752 int symbol_num;
6753 unsigned modifiers;
6754 Lisp_Object symbol_kind;
6755 Lisp_Object name_alist_or_stem;
6756 char **name_table;
6757 Lisp_Object *symbol_table;
6758 unsigned int table_size;
6760 Lisp_Object value;
6761 Lisp_Object symbol_int;
6763 /* Get rid of the "vendor-specific" bit here. */
6764 XSETINT (symbol_int, symbol_num & 0xffffff);
6766 /* Is this a request for a valid symbol? */
6767 if (symbol_num < 0 || symbol_num >= table_size)
6768 return Qnil;
6770 if (CONSP (*symbol_table))
6771 value = Fcdr (assq_no_quit (symbol_int, *symbol_table));
6773 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6774 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6775 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6776 we've never used that symbol before. */
6777 else
6779 if (! VECTORP (*symbol_table)
6780 || XVECTOR (*symbol_table)->size != table_size)
6782 Lisp_Object size;
6784 XSETFASTINT (size, table_size);
6785 *symbol_table = Fmake_vector (size, Qnil);
6788 value = XVECTOR (*symbol_table)->contents[symbol_num];
6791 /* Have we already used this symbol before? */
6792 if (NILP (value))
6794 /* No; let's create it. */
6795 if (CONSP (name_alist_or_stem))
6796 value = Fcdr_safe (Fassq (symbol_int, name_alist_or_stem));
6797 else if (STRINGP (name_alist_or_stem))
6799 int len = SBYTES (name_alist_or_stem);
6800 char *buf = (char *) alloca (len + 50);
6801 sprintf (buf, "%s-%ld", SDATA (name_alist_or_stem),
6802 (long) XINT (symbol_int) + 1);
6803 value = intern (buf);
6805 else if (name_table != 0 && name_table[symbol_num])
6806 value = intern (name_table[symbol_num]);
6808 #ifdef HAVE_WINDOW_SYSTEM
6809 if (NILP (value))
6811 char *name = x_get_keysym_name (symbol_num);
6812 if (name)
6813 value = intern (name);
6815 #endif
6817 if (NILP (value))
6819 char buf[20];
6820 sprintf (buf, "key-%d", symbol_num);
6821 value = intern (buf);
6824 if (CONSP (*symbol_table))
6825 *symbol_table = Fcons (Fcons (symbol_int, value), *symbol_table);
6826 else
6827 XVECTOR (*symbol_table)->contents[symbol_num] = value;
6829 /* Fill in the cache entries for this symbol; this also
6830 builds the Qevent_symbol_elements property, which the user
6831 cares about. */
6832 apply_modifiers (modifiers & click_modifier, value);
6833 Fput (value, Qevent_kind, symbol_kind);
6836 /* Apply modifiers to that symbol. */
6837 return apply_modifiers (modifiers, value);
6840 /* Convert a list that represents an event type,
6841 such as (ctrl meta backspace), into the usual representation of that
6842 event type as a number or a symbol. */
6844 DEFUN ("event-convert-list", Fevent_convert_list, Sevent_convert_list, 1, 1, 0,
6845 doc: /* Convert the event description list EVENT-DESC to an event type.
6846 EVENT-DESC should contain one base event type (a character or symbol)
6847 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6848 drag, down, double or triple). The base must be last.
6849 The return value is an event type (a character or symbol) which
6850 has the same base event type and all the specified modifiers. */)
6851 (event_desc)
6852 Lisp_Object event_desc;
6854 Lisp_Object base;
6855 int modifiers = 0;
6856 Lisp_Object rest;
6858 base = Qnil;
6859 rest = event_desc;
6860 while (CONSP (rest))
6862 Lisp_Object elt;
6863 int this = 0;
6865 elt = XCAR (rest);
6866 rest = XCDR (rest);
6868 /* Given a symbol, see if it is a modifier name. */
6869 if (SYMBOLP (elt) && CONSP (rest))
6870 this = parse_solitary_modifier (elt);
6872 if (this != 0)
6873 modifiers |= this;
6874 else if (!NILP (base))
6875 error ("Two bases given in one event");
6876 else
6877 base = elt;
6881 /* Let the symbol A refer to the character A. */
6882 if (SYMBOLP (base) && SCHARS (SYMBOL_NAME (base)) == 1)
6883 XSETINT (base, SREF (SYMBOL_NAME (base), 0));
6885 if (INTEGERP (base))
6887 /* Turn (shift a) into A. */
6888 if ((modifiers & shift_modifier) != 0
6889 && (XINT (base) >= 'a' && XINT (base) <= 'z'))
6891 XSETINT (base, XINT (base) - ('a' - 'A'));
6892 modifiers &= ~shift_modifier;
6895 /* Turn (control a) into C-a. */
6896 if (modifiers & ctrl_modifier)
6897 return make_number ((modifiers & ~ctrl_modifier)
6898 | make_ctrl_char (XINT (base)));
6899 else
6900 return make_number (modifiers | XINT (base));
6902 else if (SYMBOLP (base))
6903 return apply_modifiers (modifiers, base);
6904 else
6906 error ("Invalid base event");
6907 return Qnil;
6911 /* Try to recognize SYMBOL as a modifier name.
6912 Return the modifier flag bit, or 0 if not recognized. */
6915 parse_solitary_modifier (Lisp_Object symbol)
6917 Lisp_Object name = SYMBOL_NAME (symbol);
6919 switch (SREF (name, 0))
6921 #define SINGLE_LETTER_MOD(BIT) \
6922 if (SBYTES (name) == 1) \
6923 return BIT;
6925 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6926 if (LEN == SBYTES (name) \
6927 && ! strncmp (SDATA (name), NAME, LEN)) \
6928 return BIT;
6930 case 'A':
6931 SINGLE_LETTER_MOD (alt_modifier);
6932 break;
6934 case 'a':
6935 MULTI_LETTER_MOD (alt_modifier, "alt", 3);
6936 break;
6938 case 'C':
6939 SINGLE_LETTER_MOD (ctrl_modifier);
6940 break;
6942 case 'c':
6943 MULTI_LETTER_MOD (ctrl_modifier, "ctrl", 4);
6944 MULTI_LETTER_MOD (ctrl_modifier, "control", 7);
6945 break;
6947 case 'H':
6948 SINGLE_LETTER_MOD (hyper_modifier);
6949 break;
6951 case 'h':
6952 MULTI_LETTER_MOD (hyper_modifier, "hyper", 5);
6953 break;
6955 case 'M':
6956 SINGLE_LETTER_MOD (meta_modifier);
6957 break;
6959 case 'm':
6960 MULTI_LETTER_MOD (meta_modifier, "meta", 4);
6961 break;
6963 case 'S':
6964 SINGLE_LETTER_MOD (shift_modifier);
6965 break;
6967 case 's':
6968 MULTI_LETTER_MOD (shift_modifier, "shift", 5);
6969 MULTI_LETTER_MOD (super_modifier, "super", 5);
6970 SINGLE_LETTER_MOD (super_modifier);
6971 break;
6973 case 'd':
6974 MULTI_LETTER_MOD (drag_modifier, "drag", 4);
6975 MULTI_LETTER_MOD (down_modifier, "down", 4);
6976 MULTI_LETTER_MOD (double_modifier, "double", 6);
6977 break;
6979 case 't':
6980 MULTI_LETTER_MOD (triple_modifier, "triple", 6);
6981 break;
6983 #undef SINGLE_LETTER_MOD
6984 #undef MULTI_LETTER_MOD
6987 return 0;
6990 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6991 Such a list is not valid as an event,
6992 but it can be a Lucid-style event type list. */
6995 lucid_event_type_list_p (object)
6996 Lisp_Object object;
6998 Lisp_Object tail;
7000 if (! CONSP (object))
7001 return 0;
7003 if (EQ (XCAR (object), Qhelp_echo)
7004 || EQ (XCAR (object), Qvertical_line)
7005 || EQ (XCAR (object), Qmode_line)
7006 || EQ (XCAR (object), Qheader_line))
7007 return 0;
7009 for (tail = object; CONSP (tail); tail = XCDR (tail))
7011 Lisp_Object elt;
7012 elt = XCAR (tail);
7013 if (! (INTEGERP (elt) || SYMBOLP (elt)))
7014 return 0;
7017 return NILP (tail);
7020 /* Store into *addr a value nonzero if terminal input chars are available.
7021 Serves the purpose of ioctl (0, FIONREAD, addr)
7022 but works even if FIONREAD does not exist.
7023 (In fact, this may actually read some input.)
7025 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
7026 timer events that are ripe.
7027 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
7028 events (FOCUS_IN_EVENT).
7029 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
7030 movements and toolkit scroll bar thumb drags. */
7032 static void
7033 get_input_pending (addr, flags)
7034 int *addr;
7035 int flags;
7037 /* First of all, have we already counted some input? */
7038 *addr = (!NILP (Vquit_flag) || readable_events (flags));
7040 /* If input is being read as it arrives, and we have none, there is none. */
7041 if (*addr > 0 || (interrupt_input && ! interrupts_deferred))
7042 return;
7044 /* Try to read some input and see how much we get. */
7045 gobble_input (0);
7046 *addr = (!NILP (Vquit_flag) || readable_events (flags));
7049 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
7051 void
7052 gobble_input (expected)
7053 int expected;
7055 #ifdef HAVE_DBUS
7056 /* Read D-Bus messages. */
7057 xd_read_queued_messages ();
7058 #endif /* HAVE_DBUS */
7060 #ifdef SIGIO
7061 if (interrupt_input)
7063 SIGMASKTYPE mask;
7064 mask = sigblock (sigmask (SIGIO));
7065 read_avail_input (expected);
7066 sigsetmask (mask);
7068 else
7069 #ifdef POLL_FOR_INPUT
7070 /* XXX This condition was (read_socket_hook && !interrupt_input),
7071 but read_socket_hook is not global anymore. Let's pretend that
7072 it's always set. */
7073 if (!interrupt_input && poll_suppress_count == 0)
7075 SIGMASKTYPE mask;
7076 mask = sigblock (sigmask (SIGALRM));
7077 read_avail_input (expected);
7078 sigsetmask (mask);
7080 else
7081 #endif
7082 #endif
7083 read_avail_input (expected);
7086 /* Put a BUFFER_SWITCH_EVENT in the buffer
7087 so that read_key_sequence will notice the new current buffer. */
7089 void
7090 record_asynch_buffer_change ()
7092 struct input_event event;
7093 Lisp_Object tem;
7094 EVENT_INIT (event);
7096 event.kind = BUFFER_SWITCH_EVENT;
7097 event.frame_or_window = Qnil;
7098 event.arg = Qnil;
7100 #ifdef subprocesses
7101 /* We don't need a buffer-switch event unless Emacs is waiting for input.
7102 The purpose of the event is to make read_key_sequence look up the
7103 keymaps again. If we aren't in read_key_sequence, we don't need one,
7104 and the event could cause trouble by messing up (input-pending-p). */
7105 tem = Fwaiting_for_user_input_p ();
7106 if (NILP (tem))
7107 return;
7108 #else
7109 /* We never need these events if we have no asynchronous subprocesses. */
7110 return;
7111 #endif
7113 /* Make sure no interrupt happens while storing the event. */
7114 #ifdef SIGIO
7115 if (interrupt_input)
7117 SIGMASKTYPE mask;
7118 mask = sigblock (sigmask (SIGIO));
7119 kbd_buffer_store_event (&event);
7120 sigsetmask (mask);
7122 else
7123 #endif
7125 stop_polling ();
7126 kbd_buffer_store_event (&event);
7127 start_polling ();
7131 /* Read any terminal input already buffered up by the system
7132 into the kbd_buffer, but do not wait.
7134 EXPECTED should be nonzero if the caller knows there is some input.
7136 Returns the number of keyboard chars read, or -1 meaning
7137 this is a bad time to try to read input. */
7139 static int
7140 read_avail_input (expected)
7141 int expected;
7143 int nread = 0;
7144 int err = 0;
7145 struct terminal *t;
7147 /* Store pending user signal events, if any. */
7148 if (store_user_signal_events ())
7149 expected = 0;
7151 /* Loop through the available terminals, and call their input hooks. */
7152 t = terminal_list;
7153 while (t)
7155 struct terminal *next = t->next_terminal;
7157 if (t->read_socket_hook)
7159 int nr;
7160 struct input_event hold_quit;
7162 EVENT_INIT (hold_quit);
7163 hold_quit.kind = NO_EVENT;
7165 /* No need for FIONREAD or fcntl; just say don't wait. */
7166 while (nr = (*t->read_socket_hook) (t, expected, &hold_quit), nr > 0)
7168 nread += nr;
7169 expected = 0;
7172 if (nr == -1) /* Not OK to read input now. */
7174 err = 1;
7176 else if (nr == -2) /* Non-transient error. */
7178 /* The terminal device terminated; it should be closed. */
7180 /* Kill Emacs if this was our last terminal. */
7181 if (!terminal_list->next_terminal)
7182 /* Formerly simply reported no input, but that
7183 sometimes led to a failure of Emacs to terminate.
7184 SIGHUP seems appropriate if we can't reach the
7185 terminal. */
7186 /* ??? Is it really right to send the signal just to
7187 this process rather than to the whole process
7188 group? Perhaps on systems with FIONREAD Emacs is
7189 alone in its group. */
7190 kill (getpid (), SIGHUP);
7192 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
7194 Lisp_Object tmp;
7195 XSETTERMINAL (tmp, t);
7196 Fdelete_terminal (tmp, Qnoelisp);
7200 if (hold_quit.kind != NO_EVENT)
7201 kbd_buffer_store_event (&hold_quit);
7204 t = next;
7207 if (err && !nread)
7208 nread = -1;
7210 frame_make_pointer_visible ();
7212 return nread;
7215 static void
7216 decode_keyboard_code (struct tty_display_info *tty,
7217 struct coding_system *coding,
7218 unsigned char *buf, int nbytes)
7220 unsigned char *src = buf;
7221 const unsigned char *p;
7222 int i;
7224 if (nbytes == 0)
7225 return;
7226 if (tty->meta_key != 2)
7227 for (i = 0; i < nbytes; i++)
7228 buf[i] &= ~0x80;
7229 if (coding->carryover_bytes > 0)
7231 src = alloca (coding->carryover_bytes + nbytes);
7232 memcpy (src, coding->carryover, coding->carryover_bytes);
7233 memcpy (src + coding->carryover_bytes, buf, nbytes);
7234 nbytes += coding->carryover_bytes;
7236 coding->destination = alloca (nbytes * 4);
7237 coding->dst_bytes = nbytes * 4;
7238 decode_coding_c_string (coding, src, nbytes, Qnil);
7239 if (coding->produced_char == 0)
7240 return;
7241 for (i = 0, p = coding->destination; i < coding->produced_char; i++)
7243 struct input_event buf;
7245 EVENT_INIT (buf);
7246 buf.code = STRING_CHAR_ADVANCE (p);
7247 buf.kind = (ASCII_CHAR_P (buf.code)
7248 ? ASCII_KEYSTROKE_EVENT : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
7249 /* See the comment in tty_read_avail_input. */
7250 buf.frame_or_window = tty->top_frame;
7251 buf.arg = Qnil;
7252 kbd_buffer_store_event (&buf);
7256 /* This is the tty way of reading available input.
7258 Note that each terminal device has its own `struct terminal' object,
7259 and so this function is called once for each individual termcap
7260 terminal. The first parameter indicates which terminal to read from. */
7263 tty_read_avail_input (struct terminal *terminal,
7264 int expected,
7265 struct input_event *hold_quit)
7267 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7268 the kbd_buffer can really hold. That may prevent loss
7269 of characters on some systems when input is stuffed at us. */
7270 unsigned char cbuf[KBD_BUFFER_SIZE - 1];
7271 int n_to_read, i;
7272 struct tty_display_info *tty = terminal->display_info.tty;
7273 int nread = 0;
7275 if (!terminal->name) /* Don't read from a dead terminal. */
7276 return 0;
7278 if (terminal->type != output_termcap
7279 && terminal->type != output_msdos_raw)
7280 abort ();
7282 /* XXX I think the following code should be moved to separate hook
7283 functions in system-dependent files. */
7284 #ifdef WINDOWSNT
7285 return 0;
7286 #else /* not WINDOWSNT */
7287 if (! tty->term_initted) /* In case we get called during bootstrap. */
7288 return 0;
7290 if (! tty->input)
7291 return 0; /* The terminal is suspended. */
7293 #ifdef MSDOS
7294 n_to_read = dos_keysns ();
7295 if (n_to_read == 0)
7296 return 0;
7298 cbuf[0] = dos_keyread ();
7299 nread = 1;
7301 #else /* not MSDOS */
7302 #ifdef HAVE_GPM
7303 if (gpm_tty == tty)
7305 Gpm_Event event;
7306 struct input_event hold_quit;
7307 int gpm, fd = gpm_fd;
7309 EVENT_INIT (hold_quit);
7310 hold_quit.kind = NO_EVENT;
7312 /* gpm==1 if event received.
7313 gpm==0 if the GPM daemon has closed the connection, in which case
7314 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7315 we save it in `fd' so close_gpm can remove it from the
7316 select masks.
7317 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7318 while (gpm = Gpm_GetEvent (&event), gpm == 1) {
7319 nread += handle_one_term_event (tty, &event, &hold_quit);
7321 if (gpm == 0)
7322 /* Presumably the GPM daemon has closed the connection. */
7323 close_gpm (fd);
7324 if (hold_quit.kind != NO_EVENT)
7325 kbd_buffer_store_event (&hold_quit);
7326 if (nread)
7327 return nread;
7329 #endif /* HAVE_GPM */
7331 /* Determine how many characters we should *try* to read. */
7332 #ifdef FIONREAD
7333 /* Find out how much input is available. */
7334 if (ioctl (fileno (tty->input), FIONREAD, &n_to_read) < 0)
7336 if (! noninteractive)
7337 return -2; /* Close this terminal. */
7338 else
7339 n_to_read = 0;
7341 if (n_to_read == 0)
7342 return 0;
7343 if (n_to_read > sizeof cbuf)
7344 n_to_read = sizeof cbuf;
7345 #else /* no FIONREAD */
7346 #if defined (USG) || defined(CYGWIN)
7347 /* Read some input if available, but don't wait. */
7348 n_to_read = sizeof cbuf;
7349 fcntl (fileno (tty->input), F_SETFL, O_NDELAY);
7350 #else
7351 you lose;
7352 #endif
7353 #endif
7355 /* Now read; for one reason or another, this will not block.
7356 NREAD is set to the number of chars read. */
7359 nread = emacs_read (fileno (tty->input), cbuf, n_to_read);
7360 /* POSIX infers that processes which are not in the session leader's
7361 process group won't get SIGHUP's at logout time. BSDI adheres to
7362 this part standard and returns -1 from read (0) with errno==EIO
7363 when the control tty is taken away.
7364 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7365 if (nread == -1 && errno == EIO)
7366 return -2; /* Close this terminal. */
7367 #if defined (AIX) && defined (_BSD)
7368 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7369 This looks incorrect, but it isn't, because _BSD causes
7370 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7371 and that causes a value other than 0 when there is no input. */
7372 if (nread == 0)
7373 return -2; /* Close this terminal. */
7374 #endif
7376 while (
7377 /* We used to retry the read if it was interrupted.
7378 But this does the wrong thing when O_NDELAY causes
7379 an EAGAIN error. Does anybody know of a situation
7380 where a retry is actually needed? */
7381 #if 0
7382 nread < 0 && (errno == EAGAIN
7383 #ifdef EFAULT
7384 || errno == EFAULT
7385 #endif
7386 #ifdef EBADSLT
7387 || errno == EBADSLT
7388 #endif
7390 #else
7392 #endif
7395 #ifndef FIONREAD
7396 #if defined (USG) || defined (CYGWIN)
7397 fcntl (fileno (tty->input), F_SETFL, 0);
7398 #endif /* USG or CYGWIN */
7399 #endif /* no FIONREAD */
7401 if (nread <= 0)
7402 return nread;
7404 #endif /* not MSDOS */
7405 #endif /* not WINDOWSNT */
7407 if (TERMINAL_KEYBOARD_CODING (terminal)->common_flags
7408 & CODING_REQUIRE_DECODING_MASK)
7410 struct coding_system *coding = TERMINAL_KEYBOARD_CODING (terminal);
7411 int from;
7413 /* Decode the key sequence except for those with meta
7414 modifiers. */
7415 for (i = from = 0; ; i++)
7416 if (i == nread || (tty->meta_key == 1 && (cbuf[i] & 0x80)))
7418 struct input_event buf;
7420 decode_keyboard_code (tty, coding, cbuf + from, i - from);
7421 if (i == nread)
7422 break;
7424 EVENT_INIT (buf);
7425 buf.kind = ASCII_KEYSTROKE_EVENT;
7426 buf.modifiers = meta_modifier;
7427 buf.code = cbuf[i] & ~0x80;
7428 /* See the comment below. */
7429 buf.frame_or_window = tty->top_frame;
7430 buf.arg = Qnil;
7431 kbd_buffer_store_event (&buf);
7432 from = i + 1;
7434 return nread;
7437 for (i = 0; i < nread; i++)
7439 struct input_event buf;
7440 EVENT_INIT (buf);
7441 buf.kind = ASCII_KEYSTROKE_EVENT;
7442 buf.modifiers = 0;
7443 if (tty->meta_key == 1 && (cbuf[i] & 0x80))
7444 buf.modifiers = meta_modifier;
7445 if (tty->meta_key != 2)
7446 cbuf[i] &= ~0x80;
7448 buf.code = cbuf[i];
7449 /* Set the frame corresponding to the active tty. Note that the
7450 value of selected_frame is not reliable here, redisplay tends
7451 to temporarily change it. */
7452 buf.frame_or_window = tty->top_frame;
7453 buf.arg = Qnil;
7455 kbd_buffer_store_event (&buf);
7456 /* Don't look at input that follows a C-g too closely.
7457 This reduces lossage due to autorepeat on C-g. */
7458 if (buf.kind == ASCII_KEYSTROKE_EVENT
7459 && buf.code == quit_char)
7460 break;
7463 return nread;
7466 void
7467 handle_async_input ()
7469 interrupt_input_pending = 0;
7470 #ifdef SYNC_INPUT
7471 pending_signals = pending_atimers;
7472 #endif
7473 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7474 doing anything dangerous. */
7475 #ifdef HAVE_NS
7476 ++handling_signal;
7477 #endif
7478 while (1)
7480 int nread;
7481 nread = read_avail_input (1);
7482 /* -1 means it's not ok to read the input now.
7483 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7484 0 means there was no keyboard input available. */
7485 if (nread <= 0)
7486 break;
7488 #ifdef HAVE_NS
7489 --handling_signal;
7490 #endif
7493 void
7494 process_pending_signals ()
7496 if (interrupt_input_pending)
7497 handle_async_input ();
7498 do_pending_atimers ();
7501 #ifdef SIGIO /* for entire page */
7502 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7504 static SIGTYPE
7505 input_available_signal (signo)
7506 int signo;
7508 /* Must preserve main program's value of errno. */
7509 int old_errno = errno;
7510 SIGNAL_THREAD_CHECK (signo);
7512 #ifdef SYNC_INPUT
7513 interrupt_input_pending = 1;
7514 pending_signals = 1;
7515 #endif
7517 if (input_available_clear_time)
7518 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
7520 #ifndef SYNC_INPUT
7521 handle_async_input ();
7522 #endif
7524 errno = old_errno;
7526 #endif /* SIGIO */
7528 /* Send ourselves a SIGIO.
7530 This function exists so that the UNBLOCK_INPUT macro in
7531 blockinput.h can have some way to take care of input we put off
7532 dealing with, without assuming that every file which uses
7533 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7534 void
7535 reinvoke_input_signal ()
7537 #ifdef SIGIO
7538 handle_async_input ();
7539 #endif
7544 /* User signal events. */
7546 struct user_signal_info
7548 /* Signal number. */
7549 int sig;
7551 /* Name of the signal. */
7552 char *name;
7554 /* Number of pending signals. */
7555 int npending;
7557 struct user_signal_info *next;
7560 /* List of user signals. */
7561 static struct user_signal_info *user_signals = NULL;
7563 void
7564 add_user_signal (sig, name)
7565 int sig;
7566 const char *name;
7568 struct user_signal_info *p;
7570 for (p = user_signals; p; p = p->next)
7571 if (p->sig == sig)
7572 /* Already added. */
7573 return;
7575 p = xmalloc (sizeof (struct user_signal_info));
7576 p->sig = sig;
7577 p->name = xstrdup (name);
7578 p->npending = 0;
7579 p->next = user_signals;
7580 user_signals = p;
7582 signal (sig, handle_user_signal);
7585 static SIGTYPE
7586 handle_user_signal (sig)
7587 int sig;
7589 int old_errno = errno;
7590 struct user_signal_info *p;
7592 SIGNAL_THREAD_CHECK (sig);
7594 for (p = user_signals; p; p = p->next)
7595 if (p->sig == sig)
7597 p->npending++;
7598 #ifdef SIGIO
7599 if (interrupt_input)
7600 kill (getpid (), SIGIO);
7601 else
7602 #endif
7604 /* Tell wait_reading_process_output that it needs to wake
7605 up and look around. */
7606 if (input_available_clear_time)
7607 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
7609 break;
7612 errno = old_errno;
7615 static char *
7616 find_user_signal_name (sig)
7617 int sig;
7619 struct user_signal_info *p;
7621 for (p = user_signals; p; p = p->next)
7622 if (p->sig == sig)
7623 return p->name;
7625 return NULL;
7628 static int
7629 store_user_signal_events ()
7631 struct user_signal_info *p;
7632 struct input_event buf;
7633 int nstored = 0;
7635 for (p = user_signals; p; p = p->next)
7636 if (p->npending > 0)
7638 SIGMASKTYPE mask;
7640 if (nstored == 0)
7642 bzero (&buf, sizeof buf);
7643 buf.kind = USER_SIGNAL_EVENT;
7644 buf.frame_or_window = selected_frame;
7646 nstored += p->npending;
7648 mask = sigblock (sigmask (p->sig));
7651 buf.code = p->sig;
7652 kbd_buffer_store_event (&buf);
7653 p->npending--;
7655 while (p->npending > 0);
7656 sigsetmask (mask);
7659 return nstored;
7663 static void menu_bar_item P_ ((Lisp_Object, Lisp_Object, Lisp_Object, void*));
7664 static Lisp_Object menu_bar_one_keymap_changed_items;
7666 /* These variables hold the vector under construction within
7667 menu_bar_items and its subroutines, and the current index
7668 for storing into that vector. */
7669 static Lisp_Object menu_bar_items_vector;
7670 static int menu_bar_items_index;
7672 /* Return a vector of menu items for a menu bar, appropriate
7673 to the current buffer. Each item has three elements in the vector:
7674 KEY STRING MAPLIST.
7676 OLD is an old vector we can optionally reuse, or nil. */
7678 Lisp_Object
7679 menu_bar_items (old)
7680 Lisp_Object old;
7682 /* The number of keymaps we're scanning right now, and the number of
7683 keymaps we have allocated space for. */
7684 int nmaps;
7686 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7687 in the current keymaps, or nil where it is not a prefix. */
7688 Lisp_Object *maps;
7690 Lisp_Object def, tail;
7692 Lisp_Object result;
7694 int mapno;
7695 Lisp_Object oquit;
7697 int i;
7699 /* In order to build the menus, we need to call the keymap
7700 accessors. They all call QUIT. But this function is called
7701 during redisplay, during which a quit is fatal. So inhibit
7702 quitting while building the menus.
7703 We do this instead of specbind because (1) errors will clear it anyway
7704 and (2) this avoids risk of specpdl overflow. */
7705 oquit = Vinhibit_quit;
7706 Vinhibit_quit = Qt;
7708 if (!NILP (old))
7709 menu_bar_items_vector = old;
7710 else
7711 menu_bar_items_vector = Fmake_vector (make_number (24), Qnil);
7712 menu_bar_items_index = 0;
7714 /* Build our list of keymaps.
7715 If we recognize a function key and replace its escape sequence in
7716 keybuf with its symbol, or if the sequence starts with a mouse
7717 click and we need to switch buffers, we jump back here to rebuild
7718 the initial keymaps from the current buffer. */
7720 Lisp_Object *tmaps;
7722 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7723 if (!NILP (Voverriding_local_map_menu_flag))
7725 /* Yes, use them (if non-nil) as well as the global map. */
7726 maps = (Lisp_Object *) alloca (3 * sizeof (maps[0]));
7727 nmaps = 0;
7728 if (!NILP (current_kboard->Voverriding_terminal_local_map))
7729 maps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
7730 if (!NILP (Voverriding_local_map))
7731 maps[nmaps++] = Voverriding_local_map;
7733 else
7735 /* No, so use major and minor mode keymaps and keymap property.
7736 Note that menu-bar bindings in the local-map and keymap
7737 properties may not work reliable, as they are only
7738 recognized when the menu-bar (or mode-line) is updated,
7739 which does not normally happen after every command. */
7740 Lisp_Object tem;
7741 int nminor;
7742 nminor = current_minor_maps (NULL, &tmaps);
7743 maps = (Lisp_Object *) alloca ((nminor + 3) * sizeof (maps[0]));
7744 nmaps = 0;
7745 if (tem = get_local_map (PT, current_buffer, Qkeymap), !NILP (tem))
7746 maps[nmaps++] = tem;
7747 bcopy (tmaps, (void *) (maps + nmaps), nminor * sizeof (maps[0]));
7748 nmaps += nminor;
7749 maps[nmaps++] = get_local_map (PT, current_buffer, Qlocal_map);
7751 maps[nmaps++] = current_global_map;
7754 /* Look up in each map the dummy prefix key `menu-bar'. */
7756 result = Qnil;
7758 for (mapno = nmaps - 1; mapno >= 0; mapno--)
7759 if (!NILP (maps[mapno]))
7761 def = get_keymap (access_keymap (maps[mapno], Qmenu_bar, 1, 0, 1),
7762 0, 1);
7763 if (CONSP (def))
7765 menu_bar_one_keymap_changed_items = Qnil;
7766 map_keymap (def, menu_bar_item, Qnil, NULL, 1);
7770 /* Move to the end those items that should be at the end. */
7772 for (tail = Vmenu_bar_final_items; CONSP (tail); tail = XCDR (tail))
7774 int i;
7775 int end = menu_bar_items_index;
7777 for (i = 0; i < end; i += 4)
7778 if (EQ (XCAR (tail), XVECTOR (menu_bar_items_vector)->contents[i]))
7780 Lisp_Object tem0, tem1, tem2, tem3;
7781 /* Move the item at index I to the end,
7782 shifting all the others forward. */
7783 tem0 = XVECTOR (menu_bar_items_vector)->contents[i + 0];
7784 tem1 = XVECTOR (menu_bar_items_vector)->contents[i + 1];
7785 tem2 = XVECTOR (menu_bar_items_vector)->contents[i + 2];
7786 tem3 = XVECTOR (menu_bar_items_vector)->contents[i + 3];
7787 if (end > i + 4)
7788 bcopy (&XVECTOR (menu_bar_items_vector)->contents[i + 4],
7789 &XVECTOR (menu_bar_items_vector)->contents[i],
7790 (end - i - 4) * sizeof (Lisp_Object));
7791 XVECTOR (menu_bar_items_vector)->contents[end - 4] = tem0;
7792 XVECTOR (menu_bar_items_vector)->contents[end - 3] = tem1;
7793 XVECTOR (menu_bar_items_vector)->contents[end - 2] = tem2;
7794 XVECTOR (menu_bar_items_vector)->contents[end - 1] = tem3;
7795 break;
7799 /* Add nil, nil, nil, nil at the end. */
7800 i = menu_bar_items_index;
7801 if (i + 4 > XVECTOR (menu_bar_items_vector)->size)
7802 menu_bar_items_vector = larger_vector (menu_bar_items_vector, 2 * i, Qnil);
7803 /* Add this item. */
7804 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
7805 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
7806 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
7807 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
7808 menu_bar_items_index = i;
7810 Vinhibit_quit = oquit;
7811 return menu_bar_items_vector;
7814 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7815 If there's already an item for KEY, add this DEF to it. */
7817 Lisp_Object item_properties;
7819 static void
7820 menu_bar_item (key, item, dummy1, dummy2)
7821 Lisp_Object key, item, dummy1;
7822 void *dummy2;
7824 struct gcpro gcpro1;
7825 int i;
7826 Lisp_Object tem;
7828 if (EQ (item, Qundefined))
7830 /* If a map has an explicit `undefined' as definition,
7831 discard any previously made menu bar item. */
7833 for (i = 0; i < menu_bar_items_index; i += 4)
7834 if (EQ (key, XVECTOR (menu_bar_items_vector)->contents[i]))
7836 if (menu_bar_items_index > i + 4)
7837 bcopy (&XVECTOR (menu_bar_items_vector)->contents[i + 4],
7838 &XVECTOR (menu_bar_items_vector)->contents[i],
7839 (menu_bar_items_index - i - 4) * sizeof (Lisp_Object));
7840 menu_bar_items_index -= 4;
7844 /* If this keymap has already contributed to this KEY,
7845 don't contribute to it a second time. */
7846 tem = Fmemq (key, menu_bar_one_keymap_changed_items);
7847 if (!NILP (tem) || NILP (item))
7848 return;
7850 menu_bar_one_keymap_changed_items
7851 = Fcons (key, menu_bar_one_keymap_changed_items);
7853 /* We add to menu_bar_one_keymap_changed_items before doing the
7854 parse_menu_item, so that if it turns out it wasn't a menu item,
7855 it still correctly hides any further menu item. */
7856 GCPRO1 (key);
7857 i = parse_menu_item (item, 1);
7858 UNGCPRO;
7859 if (!i)
7860 return;
7862 item = XVECTOR (item_properties)->contents[ITEM_PROPERTY_DEF];
7864 /* Find any existing item for this KEY. */
7865 for (i = 0; i < menu_bar_items_index; i += 4)
7866 if (EQ (key, XVECTOR (menu_bar_items_vector)->contents[i]))
7867 break;
7869 /* If we did not find this KEY, add it at the end. */
7870 if (i == menu_bar_items_index)
7872 /* If vector is too small, get a bigger one. */
7873 if (i + 4 > XVECTOR (menu_bar_items_vector)->size)
7874 menu_bar_items_vector = larger_vector (menu_bar_items_vector, 2 * i, Qnil);
7875 /* Add this item. */
7876 XVECTOR (menu_bar_items_vector)->contents[i++] = key;
7877 XVECTOR (menu_bar_items_vector)->contents[i++]
7878 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_NAME];
7879 XVECTOR (menu_bar_items_vector)->contents[i++] = Fcons (item, Qnil);
7880 XVECTOR (menu_bar_items_vector)->contents[i++] = make_number (0);
7881 menu_bar_items_index = i;
7883 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7884 else
7886 Lisp_Object old;
7887 old = XVECTOR (menu_bar_items_vector)->contents[i + 2];
7888 /* If the new and the old items are not both keymaps,
7889 the lookup will only find `item'. */
7890 item = Fcons (item, KEYMAPP (item) && KEYMAPP (XCAR (old)) ? old : Qnil);
7891 XVECTOR (menu_bar_items_vector)->contents[i + 2] = item;
7895 /* This is used as the handler when calling menu_item_eval_property. */
7896 static Lisp_Object
7897 menu_item_eval_property_1 (arg)
7898 Lisp_Object arg;
7900 /* If we got a quit from within the menu computation,
7901 quit all the way out of it. This takes care of C-] in the debugger. */
7902 if (CONSP (arg) && EQ (XCAR (arg), Qquit))
7903 Fsignal (Qquit, Qnil);
7905 return Qnil;
7908 /* Evaluate an expression and return the result (or nil if something
7909 went wrong). Used to evaluate dynamic parts of menu items. */
7910 Lisp_Object
7911 menu_item_eval_property (sexpr)
7912 Lisp_Object sexpr;
7914 int count = SPECPDL_INDEX ();
7915 Lisp_Object val;
7916 specbind (Qinhibit_redisplay, Qt);
7917 val = internal_condition_case_1 (Feval, sexpr, Qerror,
7918 menu_item_eval_property_1);
7919 return unbind_to (count, val);
7922 /* This function parses a menu item and leaves the result in the
7923 vector item_properties.
7924 ITEM is a key binding, a possible menu item.
7925 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7926 top level.
7927 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7928 parse_menu_item returns true if the item is a menu item and false
7929 otherwise. */
7932 parse_menu_item (item, inmenubar)
7933 Lisp_Object item;
7934 int inmenubar;
7936 Lisp_Object def, tem, item_string, start;
7937 Lisp_Object filter;
7938 Lisp_Object keyhint;
7939 int i;
7941 filter = Qnil;
7942 keyhint = Qnil;
7944 if (!CONSP (item))
7945 return 0;
7947 /* Create item_properties vector if necessary. */
7948 if (NILP (item_properties))
7949 item_properties
7950 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE + 1), Qnil);
7952 /* Initialize optional entries. */
7953 for (i = ITEM_PROPERTY_DEF; i < ITEM_PROPERTY_ENABLE; i++)
7954 ASET (item_properties, i, Qnil);
7955 ASET (item_properties, ITEM_PROPERTY_ENABLE, Qt);
7957 /* Save the item here to protect it from GC. */
7958 ASET (item_properties, ITEM_PROPERTY_ITEM, item);
7960 item_string = XCAR (item);
7962 start = item;
7963 item = XCDR (item);
7964 if (STRINGP (item_string))
7966 /* Old format menu item. */
7967 ASET (item_properties, ITEM_PROPERTY_NAME, item_string);
7969 /* Maybe help string. */
7970 if (CONSP (item) && STRINGP (XCAR (item)))
7972 ASET (item_properties, ITEM_PROPERTY_HELP, XCAR (item));
7973 start = item;
7974 item = XCDR (item);
7977 /* Maybe an obsolete key binding cache. */
7978 if (CONSP (item) && CONSP (XCAR (item))
7979 && (NILP (XCAR (XCAR (item)))
7980 || VECTORP (XCAR (XCAR (item)))))
7981 item = XCDR (item);
7983 /* This is the real definition--the function to run. */
7984 ASET (item_properties, ITEM_PROPERTY_DEF, item);
7986 /* Get enable property, if any. */
7987 if (SYMBOLP (item))
7989 tem = Fget (item, Qmenu_enable);
7990 if (!NILP (Venable_disabled_menus_and_buttons))
7991 ASET (item_properties, ITEM_PROPERTY_ENABLE, Qt);
7992 else if (!NILP (tem))
7993 ASET (item_properties, ITEM_PROPERTY_ENABLE, tem);
7996 else if (EQ (item_string, Qmenu_item) && CONSP (item))
7998 /* New format menu item. */
7999 ASET (item_properties, ITEM_PROPERTY_NAME, XCAR (item));
8000 start = XCDR (item);
8001 if (CONSP (start))
8003 /* We have a real binding. */
8004 ASET (item_properties, ITEM_PROPERTY_DEF, XCAR (start));
8006 item = XCDR (start);
8007 /* Is there an obsolete cache list with key equivalences. */
8008 if (CONSP (item) && CONSP (XCAR (item)))
8009 item = XCDR (item);
8011 /* Parse properties. */
8012 while (CONSP (item) && CONSP (XCDR (item)))
8014 tem = XCAR (item);
8015 item = XCDR (item);
8017 if (EQ (tem, QCenable))
8019 if (!NILP (Venable_disabled_menus_and_buttons))
8020 ASET (item_properties, ITEM_PROPERTY_ENABLE, Qt);
8021 else
8022 ASET (item_properties, ITEM_PROPERTY_ENABLE, XCAR (item));
8024 else if (EQ (tem, QCvisible))
8026 /* If got a visible property and that evaluates to nil
8027 then ignore this item. */
8028 tem = menu_item_eval_property (XCAR (item));
8029 if (NILP (tem))
8030 return 0;
8032 else if (EQ (tem, QChelp))
8033 ASET (item_properties, ITEM_PROPERTY_HELP, XCAR (item));
8034 else if (EQ (tem, QCfilter))
8035 filter = item;
8036 else if (EQ (tem, QCkey_sequence))
8038 tem = XCAR (item);
8039 if (SYMBOLP (tem) || STRINGP (tem) || VECTORP (tem))
8040 /* Be GC protected. Set keyhint to item instead of tem. */
8041 keyhint = item;
8043 else if (EQ (tem, QCkeys))
8045 tem = XCAR (item);
8046 if (CONSP (tem) || STRINGP (tem))
8047 ASET (item_properties, ITEM_PROPERTY_KEYEQ, tem);
8049 else if (EQ (tem, QCbutton) && CONSP (XCAR (item)))
8051 Lisp_Object type;
8052 tem = XCAR (item);
8053 type = XCAR (tem);
8054 if (EQ (type, QCtoggle) || EQ (type, QCradio))
8056 ASET (item_properties, ITEM_PROPERTY_SELECTED,
8057 XCDR (tem));
8058 ASET (item_properties, ITEM_PROPERTY_TYPE, type);
8061 item = XCDR (item);
8064 else if (inmenubar || !NILP (start))
8065 return 0;
8067 else
8068 return 0; /* not a menu item */
8070 /* If item string is not a string, evaluate it to get string.
8071 If we don't get a string, skip this item. */
8072 item_string = AREF (item_properties, ITEM_PROPERTY_NAME);
8073 if (!(STRINGP (item_string)))
8075 item_string = menu_item_eval_property (item_string);
8076 if (!STRINGP (item_string))
8077 return 0;
8078 ASET (item_properties, ITEM_PROPERTY_NAME, item_string);
8081 /* If got a filter apply it on definition. */
8082 def = AREF (item_properties, ITEM_PROPERTY_DEF);
8083 if (!NILP (filter))
8085 def = menu_item_eval_property (list2 (XCAR (filter),
8086 list2 (Qquote, def)));
8088 ASET (item_properties, ITEM_PROPERTY_DEF, def);
8091 /* Enable or disable selection of item. */
8092 tem = AREF (item_properties, ITEM_PROPERTY_ENABLE);
8093 if (!EQ (tem, Qt))
8095 tem = menu_item_eval_property (tem);
8096 if (inmenubar && NILP (tem))
8097 return 0; /* Ignore disabled items in menu bar. */
8098 ASET (item_properties, ITEM_PROPERTY_ENABLE, tem);
8101 /* If we got no definition, this item is just unselectable text which
8102 is OK in a submenu but not in the menubar. */
8103 if (NILP (def))
8104 return (inmenubar ? 0 : 1);
8106 /* See if this is a separate pane or a submenu. */
8107 def = AREF (item_properties, ITEM_PROPERTY_DEF);
8108 tem = get_keymap (def, 0, 1);
8109 /* For a subkeymap, just record its details and exit. */
8110 if (CONSP (tem))
8112 ASET (item_properties, ITEM_PROPERTY_MAP, tem);
8113 ASET (item_properties, ITEM_PROPERTY_DEF, tem);
8114 return 1;
8117 /* At the top level in the menu bar, do likewise for commands also.
8118 The menu bar does not display equivalent key bindings anyway.
8119 ITEM_PROPERTY_DEF is already set up properly. */
8120 if (inmenubar > 0)
8121 return 1;
8123 { /* This is a command. See if there is an equivalent key binding. */
8124 Lisp_Object keyeq = AREF (item_properties, ITEM_PROPERTY_KEYEQ);
8126 /* The previous code preferred :key-sequence to :keys, so we
8127 preserve this behavior. */
8128 if (STRINGP (keyeq) && !CONSP (keyhint))
8129 keyeq = Fsubstitute_command_keys (keyeq);
8130 else
8132 Lisp_Object prefix = keyeq;
8133 Lisp_Object keys = Qnil;
8135 if (CONSP (prefix))
8137 def = XCAR (prefix);
8138 prefix = XCDR (prefix);
8140 else
8141 def = AREF (item_properties, ITEM_PROPERTY_DEF);
8143 if (CONSP (keyhint) && !NILP (XCAR (keyhint)))
8145 keys = XCAR (keyhint);
8146 tem = Fkey_binding (keys, Qnil, Qnil, Qnil);
8148 /* We have a suggested key. Is it bound to the command? */
8149 if (NILP (tem)
8150 || (!EQ (tem, def)
8151 /* If the command is an alias for another
8152 (such as lmenu.el set it up), check if the
8153 original command matches the cached command. */
8154 && !(SYMBOLP (def) && EQ (tem, XSYMBOL (def)->function))))
8155 keys = Qnil;
8158 if (NILP (keys))
8159 keys = Fwhere_is_internal (def, Qnil, Qt, Qnil, Qnil);
8161 if (!NILP (keys))
8163 tem = Fkey_description (keys, Qnil);
8164 if (CONSP (prefix))
8166 if (STRINGP (XCAR (prefix)))
8167 tem = concat2 (XCAR (prefix), tem);
8168 if (STRINGP (XCDR (prefix)))
8169 tem = concat2 (tem, XCDR (prefix));
8171 keyeq = concat2 (build_string (" "), tem);
8172 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
8174 else
8175 keyeq = Qnil;
8178 /* If we have an equivalent key binding, use that. */
8179 ASET (item_properties, ITEM_PROPERTY_KEYEQ, keyeq);
8182 /* Include this when menu help is implemented.
8183 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
8184 if (!(NILP (tem) || STRINGP (tem)))
8186 tem = menu_item_eval_property (tem);
8187 if (!STRINGP (tem))
8188 tem = Qnil;
8189 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8193 /* Handle radio buttons or toggle boxes. */
8194 tem = AREF (item_properties, ITEM_PROPERTY_SELECTED);
8195 if (!NILP (tem))
8196 ASET (item_properties, ITEM_PROPERTY_SELECTED,
8197 menu_item_eval_property (tem));
8199 return 1;
8204 /***********************************************************************
8205 Tool-bars
8206 ***********************************************************************/
8208 /* A vector holding tool bar items while they are parsed in function
8209 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8210 in the vector. */
8212 static Lisp_Object tool_bar_items_vector;
8214 /* A vector holding the result of parse_tool_bar_item. Layout is like
8215 the one for a single item in tool_bar_items_vector. */
8217 static Lisp_Object tool_bar_item_properties;
8219 /* Next free index in tool_bar_items_vector. */
8221 static int ntool_bar_items;
8223 /* The symbols `tool-bar', `:image' and `:rtl'. */
8225 extern Lisp_Object Qtool_bar;
8226 Lisp_Object QCimage;
8227 Lisp_Object Qrtl;
8229 /* Function prototypes. */
8231 static void init_tool_bar_items P_ ((Lisp_Object));
8232 static void process_tool_bar_item P_ ((Lisp_Object, Lisp_Object, Lisp_Object, void*));
8233 static int parse_tool_bar_item P_ ((Lisp_Object, Lisp_Object));
8234 static void append_tool_bar_item P_ ((void));
8237 /* Return a vector of tool bar items for keymaps currently in effect.
8238 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8239 tool bar items found. */
8241 Lisp_Object
8242 tool_bar_items (reuse, nitems)
8243 Lisp_Object reuse;
8244 int *nitems;
8246 Lisp_Object *maps;
8247 int nmaps, i;
8248 Lisp_Object oquit;
8249 Lisp_Object *tmaps;
8251 *nitems = 0;
8253 /* In order to build the menus, we need to call the keymap
8254 accessors. They all call QUIT. But this function is called
8255 during redisplay, during which a quit is fatal. So inhibit
8256 quitting while building the menus. We do this instead of
8257 specbind because (1) errors will clear it anyway and (2) this
8258 avoids risk of specpdl overflow. */
8259 oquit = Vinhibit_quit;
8260 Vinhibit_quit = Qt;
8262 /* Initialize tool_bar_items_vector and protect it from GC. */
8263 init_tool_bar_items (reuse);
8265 /* Build list of keymaps in maps. Set nmaps to the number of maps
8266 to process. */
8268 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8269 if (!NILP (Voverriding_local_map_menu_flag))
8271 /* Yes, use them (if non-nil) as well as the global map. */
8272 maps = (Lisp_Object *) alloca (3 * sizeof (maps[0]));
8273 nmaps = 0;
8274 if (!NILP (current_kboard->Voverriding_terminal_local_map))
8275 maps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
8276 if (!NILP (Voverriding_local_map))
8277 maps[nmaps++] = Voverriding_local_map;
8279 else
8281 /* No, so use major and minor mode keymaps and keymap property.
8282 Note that tool-bar bindings in the local-map and keymap
8283 properties may not work reliable, as they are only
8284 recognized when the tool-bar (or mode-line) is updated,
8285 which does not normally happen after every command. */
8286 Lisp_Object tem;
8287 int nminor;
8288 nminor = current_minor_maps (NULL, &tmaps);
8289 maps = (Lisp_Object *) alloca ((nminor + 3) * sizeof (maps[0]));
8290 nmaps = 0;
8291 if (tem = get_local_map (PT, current_buffer, Qkeymap), !NILP (tem))
8292 maps[nmaps++] = tem;
8293 bcopy (tmaps, (void *) (maps + nmaps), nminor * sizeof (maps[0]));
8294 nmaps += nminor;
8295 maps[nmaps++] = get_local_map (PT, current_buffer, Qlocal_map);
8298 /* Add global keymap at the end. */
8299 maps[nmaps++] = current_global_map;
8301 /* Process maps in reverse order and look up in each map the prefix
8302 key `tool-bar'. */
8303 for (i = nmaps - 1; i >= 0; --i)
8304 if (!NILP (maps[i]))
8306 Lisp_Object keymap;
8308 keymap = get_keymap (access_keymap (maps[i], Qtool_bar, 1, 0, 1), 0, 1);
8309 if (CONSP (keymap))
8310 map_keymap (keymap, process_tool_bar_item, Qnil, NULL, 1);
8313 Vinhibit_quit = oquit;
8314 *nitems = ntool_bar_items / TOOL_BAR_ITEM_NSLOTS;
8315 return tool_bar_items_vector;
8319 /* Process the definition of KEY which is DEF. */
8321 static void
8322 process_tool_bar_item (key, def, data, args)
8323 Lisp_Object key, def, data;
8324 void *args;
8326 int i;
8327 extern Lisp_Object Qundefined;
8328 struct gcpro gcpro1, gcpro2;
8330 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8331 eval. */
8332 GCPRO2 (key, def);
8334 if (EQ (def, Qundefined))
8336 /* If a map has an explicit `undefined' as definition,
8337 discard any previously made item. */
8338 for (i = 0; i < ntool_bar_items; i += TOOL_BAR_ITEM_NSLOTS)
8340 Lisp_Object *v = XVECTOR (tool_bar_items_vector)->contents + i;
8342 if (EQ (key, v[TOOL_BAR_ITEM_KEY]))
8344 if (ntool_bar_items > i + TOOL_BAR_ITEM_NSLOTS)
8345 bcopy (v + TOOL_BAR_ITEM_NSLOTS, v,
8346 ((ntool_bar_items - i - TOOL_BAR_ITEM_NSLOTS)
8347 * sizeof (Lisp_Object)));
8348 ntool_bar_items -= TOOL_BAR_ITEM_NSLOTS;
8349 break;
8353 else if (parse_tool_bar_item (key, def))
8354 /* Append a new tool bar item to tool_bar_items_vector. Accept
8355 more than one definition for the same key. */
8356 append_tool_bar_item ();
8358 UNGCPRO;
8362 /* Parse a tool bar item specification ITEM for key KEY and return the
8363 result in tool_bar_item_properties. Value is zero if ITEM is
8364 invalid.
8366 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8368 CAPTION is the caption of the item, If it's not a string, it is
8369 evaluated to get a string.
8371 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8372 as binding are currently ignored.
8374 The following properties are recognized:
8376 - `:enable FORM'.
8378 FORM is evaluated and specifies whether the tool bar item is
8379 enabled or disabled.
8381 - `:visible FORM'
8383 FORM is evaluated and specifies whether the tool bar item is visible.
8385 - `:filter FUNCTION'
8387 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8388 result is stored as the new binding.
8390 - `:button (TYPE SELECTED)'
8392 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8393 and specifies whether the button is selected (pressed) or not.
8395 - `:image IMAGES'
8397 IMAGES is either a single image specification or a vector of four
8398 image specifications. See enum tool_bar_item_images.
8400 - `:help HELP-STRING'.
8402 Gives a help string to display for the tool bar item. */
8404 static int
8405 parse_tool_bar_item (key, item)
8406 Lisp_Object key, item;
8408 /* Access slot with index IDX of vector tool_bar_item_properties. */
8409 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8411 Lisp_Object filter = Qnil;
8412 Lisp_Object caption;
8413 int i;
8415 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8416 Rule out items that aren't lists, don't start with
8417 `menu-item' or whose rest following `tool-bar-item' is not a
8418 list. */
8419 if (!CONSP (item)
8420 || !EQ (XCAR (item), Qmenu_item)
8421 || (item = XCDR (item),
8422 !CONSP (item)))
8423 return 0;
8425 /* Create tool_bar_item_properties vector if necessary. Reset it to
8426 defaults. */
8427 if (VECTORP (tool_bar_item_properties))
8429 for (i = 0; i < TOOL_BAR_ITEM_NSLOTS; ++i)
8430 PROP (i) = Qnil;
8432 else
8433 tool_bar_item_properties
8434 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS), Qnil);
8436 /* Set defaults. */
8437 PROP (TOOL_BAR_ITEM_KEY) = key;
8438 PROP (TOOL_BAR_ITEM_ENABLED_P) = Qt;
8440 /* Get the caption of the item. If the caption is not a string,
8441 evaluate it to get a string. If we don't get a string, skip this
8442 item. */
8443 caption = XCAR (item);
8444 if (!STRINGP (caption))
8446 caption = menu_item_eval_property (caption);
8447 if (!STRINGP (caption))
8448 return 0;
8450 PROP (TOOL_BAR_ITEM_CAPTION) = caption;
8452 /* Give up if rest following the caption is not a list. */
8453 item = XCDR (item);
8454 if (!CONSP (item))
8455 return 0;
8457 /* Store the binding. */
8458 PROP (TOOL_BAR_ITEM_BINDING) = XCAR (item);
8459 item = XCDR (item);
8461 /* Ignore cached key binding, if any. */
8462 if (CONSP (item) && CONSP (XCAR (item)))
8463 item = XCDR (item);
8465 /* Process the rest of the properties. */
8466 for (; CONSP (item) && CONSP (XCDR (item)); item = XCDR (XCDR (item)))
8468 Lisp_Object key, value;
8470 key = XCAR (item);
8471 value = XCAR (XCDR (item));
8473 if (EQ (key, QCenable))
8475 /* `:enable FORM'. */
8476 if (!NILP (Venable_disabled_menus_and_buttons))
8477 PROP (TOOL_BAR_ITEM_ENABLED_P) = Qt;
8478 else
8479 PROP (TOOL_BAR_ITEM_ENABLED_P) = value;
8481 else if (EQ (key, QCvisible))
8483 /* `:visible FORM'. If got a visible property and that
8484 evaluates to nil then ignore this item. */
8485 if (NILP (menu_item_eval_property (value)))
8486 return 0;
8488 else if (EQ (key, QChelp))
8489 /* `:help HELP-STRING'. */
8490 PROP (TOOL_BAR_ITEM_HELP) = value;
8491 else if (EQ (key, QCfilter))
8492 /* ':filter FORM'. */
8493 filter = value;
8494 else if (EQ (key, QCbutton) && CONSP (value))
8496 /* `:button (TYPE . SELECTED)'. */
8497 Lisp_Object type, selected;
8499 type = XCAR (value);
8500 selected = XCDR (value);
8501 if (EQ (type, QCtoggle) || EQ (type, QCradio))
8503 PROP (TOOL_BAR_ITEM_SELECTED_P) = selected;
8504 PROP (TOOL_BAR_ITEM_TYPE) = type;
8507 else if (EQ (key, QCimage)
8508 && (CONSP (value)
8509 || (VECTORP (value) && XVECTOR (value)->size == 4)))
8510 /* Value is either a single image specification or a vector
8511 of 4 such specifications for the different button states. */
8512 PROP (TOOL_BAR_ITEM_IMAGES) = value;
8513 else if (EQ (key, Qrtl))
8514 /* ':rtl STRING' */
8515 PROP (TOOL_BAR_ITEM_RTL_IMAGE) = value;
8518 /* If got a filter apply it on binding. */
8519 if (!NILP (filter))
8520 PROP (TOOL_BAR_ITEM_BINDING)
8521 = menu_item_eval_property (list2 (filter,
8522 list2 (Qquote,
8523 PROP (TOOL_BAR_ITEM_BINDING))));
8525 /* See if the binding is a keymap. Give up if it is. */
8526 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING), 0, 1)))
8527 return 0;
8529 /* Enable or disable selection of item. */
8530 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P), Qt))
8531 PROP (TOOL_BAR_ITEM_ENABLED_P)
8532 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P));
8534 /* Handle radio buttons or toggle boxes. */
8535 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P)))
8536 PROP (TOOL_BAR_ITEM_SELECTED_P)
8537 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P));
8539 return 1;
8541 #undef PROP
8545 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8546 that can be reused. */
8548 static void
8549 init_tool_bar_items (reuse)
8550 Lisp_Object reuse;
8552 if (VECTORP (reuse))
8553 tool_bar_items_vector = reuse;
8554 else
8555 tool_bar_items_vector = Fmake_vector (make_number (64), Qnil);
8556 ntool_bar_items = 0;
8560 /* Append parsed tool bar item properties from
8561 tool_bar_item_properties */
8563 static void
8564 append_tool_bar_item ()
8566 Lisp_Object *to, *from;
8568 /* Enlarge tool_bar_items_vector if necessary. */
8569 if (ntool_bar_items + TOOL_BAR_ITEM_NSLOTS
8570 >= XVECTOR (tool_bar_items_vector)->size)
8571 tool_bar_items_vector
8572 = larger_vector (tool_bar_items_vector,
8573 2 * XVECTOR (tool_bar_items_vector)->size, Qnil);
8575 /* Append entries from tool_bar_item_properties to the end of
8576 tool_bar_items_vector. */
8577 to = XVECTOR (tool_bar_items_vector)->contents + ntool_bar_items;
8578 from = XVECTOR (tool_bar_item_properties)->contents;
8579 bcopy (from, to, TOOL_BAR_ITEM_NSLOTS * sizeof *to);
8580 ntool_bar_items += TOOL_BAR_ITEM_NSLOTS;
8587 /* Read a character using menus based on maps in the array MAPS.
8588 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8589 Return t if we displayed a menu but the user rejected it.
8591 PREV_EVENT is the previous input event, or nil if we are reading
8592 the first event of a key sequence.
8594 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8595 if we used a mouse menu to read the input, or zero otherwise. If
8596 USED_MOUSE_MENU is null, we don't dereference it.
8598 The prompting is done based on the prompt-string of the map
8599 and the strings associated with various map elements.
8601 This can be done with X menus or with menus put in the minibuf.
8602 These are done in different ways, depending on how the input will be read.
8603 Menus using X are done after auto-saving in read-char, getting the input
8604 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8605 and do auto-saving in the inner call of read_char. */
8607 static Lisp_Object
8608 read_char_x_menu_prompt (nmaps, maps, prev_event, used_mouse_menu)
8609 int nmaps;
8610 Lisp_Object *maps;
8611 Lisp_Object prev_event;
8612 int *used_mouse_menu;
8614 int mapno;
8616 if (used_mouse_menu)
8617 *used_mouse_menu = 0;
8619 /* Use local over global Menu maps */
8621 if (! menu_prompting)
8622 return Qnil;
8624 /* Optionally disregard all but the global map. */
8625 if (inhibit_local_menu_bar_menus)
8627 maps += (nmaps - 1);
8628 nmaps = 1;
8631 #ifdef HAVE_MENUS
8632 /* If we got to this point via a mouse click,
8633 use a real menu for mouse selection. */
8634 if (EVENT_HAS_PARAMETERS (prev_event)
8635 && !EQ (XCAR (prev_event), Qmenu_bar)
8636 && !EQ (XCAR (prev_event), Qtool_bar))
8638 /* Display the menu and get the selection. */
8639 Lisp_Object *realmaps
8640 = (Lisp_Object *) alloca (nmaps * sizeof (Lisp_Object));
8641 Lisp_Object value;
8642 int nmaps1 = 0;
8644 /* Use the maps that are not nil. */
8645 for (mapno = 0; mapno < nmaps; mapno++)
8646 if (!NILP (maps[mapno]))
8647 realmaps[nmaps1++] = maps[mapno];
8649 value = Fx_popup_menu (prev_event, Flist (nmaps1, realmaps));
8650 if (CONSP (value))
8652 Lisp_Object tem;
8654 record_menu_key (XCAR (value));
8656 /* If we got multiple events, unread all but
8657 the first.
8658 There is no way to prevent those unread events
8659 from showing up later in last_nonmenu_event.
8660 So turn symbol and integer events into lists,
8661 to indicate that they came from a mouse menu,
8662 so that when present in last_nonmenu_event
8663 they won't confuse things. */
8664 for (tem = XCDR (value); CONSP (tem); tem = XCDR (tem))
8666 record_menu_key (XCAR (tem));
8667 if (SYMBOLP (XCAR (tem))
8668 || INTEGERP (XCAR (tem)))
8669 XSETCAR (tem, Fcons (XCAR (tem), Qdisabled));
8672 /* If we got more than one event, put all but the first
8673 onto this list to be read later.
8674 Return just the first event now. */
8675 Vunread_command_events
8676 = nconc2 (XCDR (value), Vunread_command_events);
8677 value = XCAR (value);
8679 else if (NILP (value))
8680 value = Qt;
8681 if (used_mouse_menu)
8682 *used_mouse_menu = 1;
8683 return value;
8685 #endif /* HAVE_MENUS */
8686 return Qnil ;
8689 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8690 We make this bigger when necessary, and never free it. */
8691 static char *read_char_minibuf_menu_text;
8692 /* Size of that buffer. */
8693 static int read_char_minibuf_menu_width;
8695 static Lisp_Object
8696 read_char_minibuf_menu_prompt (commandflag, nmaps, maps)
8697 int commandflag ;
8698 int nmaps;
8699 Lisp_Object *maps;
8701 int mapno;
8702 register Lisp_Object name;
8703 int nlength;
8704 /* FIXME: Use the minibuffer's frame width. */
8705 int width = FRAME_COLS (SELECTED_FRAME ()) - 4;
8706 int idx = -1;
8707 int nobindings = 1;
8708 Lisp_Object rest, vector;
8709 char *menu;
8711 vector = Qnil;
8712 name = Qnil;
8714 if (! menu_prompting)
8715 return Qnil;
8717 /* Get the menu name from the first map that has one (a prompt string). */
8718 for (mapno = 0; mapno < nmaps; mapno++)
8720 name = Fkeymap_prompt (maps[mapno]);
8721 if (!NILP (name))
8722 break;
8725 /* If we don't have any menus, just read a character normally. */
8726 if (!STRINGP (name))
8727 return Qnil;
8729 /* Make sure we have a big enough buffer for the menu text. */
8730 width = max (width, SBYTES (name));
8731 if (read_char_minibuf_menu_text == 0)
8733 read_char_minibuf_menu_width = width + 4;
8734 read_char_minibuf_menu_text = (char *) xmalloc (width + 4);
8736 else if (width + 4 > read_char_minibuf_menu_width)
8738 read_char_minibuf_menu_width = width + 4;
8739 read_char_minibuf_menu_text
8740 = (char *) xrealloc (read_char_minibuf_menu_text, width + 4);
8742 menu = read_char_minibuf_menu_text;
8744 /* Prompt string always starts with map's prompt, and a space. */
8745 strcpy (menu, SDATA (name));
8746 nlength = SBYTES (name);
8747 menu[nlength++] = ':';
8748 menu[nlength++] = ' ';
8749 menu[nlength] = 0;
8751 /* Start prompting at start of first map. */
8752 mapno = 0;
8753 rest = maps[mapno];
8755 /* Present the documented bindings, a line at a time. */
8756 while (1)
8758 int notfirst = 0;
8759 int i = nlength;
8760 Lisp_Object obj;
8761 int ch;
8762 Lisp_Object orig_defn_macro;
8764 /* Loop over elements of map. */
8765 while (i < width)
8767 Lisp_Object elt;
8769 /* If reached end of map, start at beginning of next map. */
8770 if (NILP (rest))
8772 mapno++;
8773 /* At end of last map, wrap around to first map if just starting,
8774 or end this line if already have something on it. */
8775 if (mapno == nmaps)
8777 mapno = 0;
8778 if (notfirst || nobindings) break;
8780 rest = maps[mapno];
8783 /* Look at the next element of the map. */
8784 if (idx >= 0)
8785 elt = XVECTOR (vector)->contents[idx];
8786 else
8787 elt = Fcar_safe (rest);
8789 if (idx < 0 && VECTORP (elt))
8791 /* If we found a dense table in the keymap,
8792 advanced past it, but start scanning its contents. */
8793 rest = Fcdr_safe (rest);
8794 vector = elt;
8795 idx = 0;
8797 else
8799 /* An ordinary element. */
8800 Lisp_Object event, tem;
8802 if (idx < 0)
8804 event = Fcar_safe (elt); /* alist */
8805 elt = Fcdr_safe (elt);
8807 else
8809 XSETINT (event, idx); /* vector */
8812 /* Ignore the element if it has no prompt string. */
8813 if (INTEGERP (event) && parse_menu_item (elt, -1))
8815 /* 1 if the char to type matches the string. */
8816 int char_matches;
8817 Lisp_Object upcased_event, downcased_event;
8818 Lisp_Object desc = Qnil;
8819 Lisp_Object s
8820 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_NAME];
8822 upcased_event = Fupcase (event);
8823 downcased_event = Fdowncase (event);
8824 char_matches = (XINT (upcased_event) == SREF (s, 0)
8825 || XINT (downcased_event) == SREF (s, 0));
8826 if (! char_matches)
8827 desc = Fsingle_key_description (event, Qnil);
8829 #if 0 /* It is redundant to list the equivalent key bindings because
8830 the prefix is what the user has already typed. */
8832 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_KEYEQ];
8833 if (!NILP (tem))
8834 /* Insert equivalent keybinding. */
8835 s = concat2 (s, tem);
8836 #endif
8838 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_TYPE];
8839 if (EQ (tem, QCradio) || EQ (tem, QCtoggle))
8841 /* Insert button prefix. */
8842 Lisp_Object selected
8843 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_SELECTED];
8844 if (EQ (tem, QCradio))
8845 tem = build_string (NILP (selected) ? "(*) " : "( ) ");
8846 else
8847 tem = build_string (NILP (selected) ? "[X] " : "[ ] ");
8848 s = concat2 (tem, s);
8852 /* If we have room for the prompt string, add it to this line.
8853 If this is the first on the line, always add it. */
8854 if ((SCHARS (s) + i + 2
8855 + (char_matches ? 0 : SCHARS (desc) + 3))
8856 < width
8857 || !notfirst)
8859 int thiswidth;
8861 /* Punctuate between strings. */
8862 if (notfirst)
8864 strcpy (menu + i, ", ");
8865 i += 2;
8867 notfirst = 1;
8868 nobindings = 0 ;
8870 /* If the char to type doesn't match the string's
8871 first char, explicitly show what char to type. */
8872 if (! char_matches)
8874 /* Add as much of string as fits. */
8875 thiswidth = SCHARS (desc);
8876 if (thiswidth + i > width)
8877 thiswidth = width - i;
8878 bcopy (SDATA (desc), menu + i, thiswidth);
8879 i += thiswidth;
8880 strcpy (menu + i, " = ");
8881 i += 3;
8884 /* Add as much of string as fits. */
8885 thiswidth = SCHARS (s);
8886 if (thiswidth + i > width)
8887 thiswidth = width - i;
8888 bcopy (SDATA (s), menu + i, thiswidth);
8889 i += thiswidth;
8890 menu[i] = 0;
8892 else
8894 /* If this element does not fit, end the line now,
8895 and save the element for the next line. */
8896 strcpy (menu + i, "...");
8897 break;
8901 /* Move past this element. */
8902 if (idx >= 0 && idx + 1 >= XVECTOR (vector)->size)
8903 /* Handle reaching end of dense table. */
8904 idx = -1;
8905 if (idx >= 0)
8906 idx++;
8907 else
8908 rest = Fcdr_safe (rest);
8912 /* Prompt with that and read response. */
8913 message2_nolog (menu, strlen (menu),
8914 ! NILP (current_buffer->enable_multibyte_characters));
8916 /* Make believe its not a keyboard macro in case the help char
8917 is pressed. Help characters are not recorded because menu prompting
8918 is not used on replay.
8920 orig_defn_macro = current_kboard->defining_kbd_macro;
8921 current_kboard->defining_kbd_macro = Qnil;
8923 obj = read_char (commandflag, 0, 0, Qt, 0, NULL);
8924 while (BUFFERP (obj));
8925 current_kboard->defining_kbd_macro = orig_defn_macro;
8927 if (!INTEGERP (obj))
8928 return obj;
8929 else if (XINT (obj) == -2)
8930 return obj;
8931 else
8932 ch = XINT (obj);
8934 if (! EQ (obj, menu_prompt_more_char)
8935 && (!INTEGERP (menu_prompt_more_char)
8936 || ! EQ (obj, make_number (Ctl (XINT (menu_prompt_more_char))))))
8938 if (!NILP (current_kboard->defining_kbd_macro))
8939 store_kbd_macro_char (obj);
8940 return obj;
8942 /* Help char - go round again */
8946 /* Reading key sequences. */
8948 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8949 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8950 keymap, or nil otherwise. Return the index of the first keymap in
8951 which KEY has any binding, or NMAPS if no map has a binding.
8953 If KEY is a meta ASCII character, treat it like meta-prefix-char
8954 followed by the corresponding non-meta character. Keymaps in
8955 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8956 NEXT.
8958 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8959 unmodified.
8961 NEXT may be the same array as CURRENT. */
8963 static int
8964 follow_key (key, nmaps, current, defs, next)
8965 Lisp_Object key;
8966 Lisp_Object *current, *defs, *next;
8967 int nmaps;
8969 int i, first_binding;
8971 first_binding = nmaps;
8972 for (i = nmaps - 1; i >= 0; i--)
8974 if (! NILP (current[i]))
8976 defs[i] = access_keymap (current[i], key, 1, 0, 1);
8977 if (! NILP (defs[i]))
8978 first_binding = i;
8980 else
8981 defs[i] = Qnil;
8984 /* Given the set of bindings we've found, produce the next set of maps. */
8985 if (first_binding < nmaps)
8986 for (i = 0; i < nmaps; i++)
8987 next[i] = NILP (defs[i]) ? Qnil : get_keymap (defs[i], 0, 1);
8989 return first_binding;
8992 /* Structure used to keep track of partial application of key remapping
8993 such as Vfunction_key_map and Vkey_translation_map. */
8994 typedef struct keyremap
8996 /* This is the map originally specified for this use. */
8997 Lisp_Object parent;
8998 /* This is a submap reached by looking up, in PARENT,
8999 the events from START to END. */
9000 Lisp_Object map;
9001 /* Positions [START, END) in the key sequence buffer
9002 are the key that we have scanned so far.
9003 Those events are the ones that we will replace
9004 if PAREHT maps them into a key sequence. */
9005 int start, end;
9006 } keyremap;
9008 /* Lookup KEY in MAP.
9009 MAP is a keymap mapping keys to key vectors or functions.
9010 If the mapping is a function and DO_FUNCTION is non-zero, then
9011 the function is called with PROMPT as parameter and its return
9012 value is used as the return value of this function (after checking
9013 that it is indeed a vector). */
9015 static Lisp_Object
9016 access_keymap_keyremap (map, key, prompt, do_funcall)
9017 Lisp_Object map, key, prompt;
9018 int do_funcall;
9020 Lisp_Object next;
9022 next = access_keymap (map, key, 1, 0, 1);
9024 /* Handle symbol with autoload definition. */
9025 if (SYMBOLP (next) && !NILP (Ffboundp (next))
9026 && CONSP (XSYMBOL (next)->function)
9027 && EQ (XCAR (XSYMBOL (next)->function), Qautoload))
9028 do_autoload (XSYMBOL (next)->function, next);
9030 /* Handle a symbol whose function definition is a keymap
9031 or an array. */
9032 if (SYMBOLP (next) && !NILP (Ffboundp (next))
9033 && (ARRAYP (XSYMBOL (next)->function)
9034 || KEYMAPP (XSYMBOL (next)->function)))
9035 next = XSYMBOL (next)->function;
9037 /* If the keymap gives a function, not an
9038 array, then call the function with one arg and use
9039 its value instead. */
9040 if (SYMBOLP (next) && !NILP (Ffboundp (next)) && do_funcall)
9042 Lisp_Object tem;
9043 tem = next;
9045 next = call1 (next, prompt);
9046 /* If the function returned something invalid,
9047 barf--don't ignore it.
9048 (To ignore it safely, we would need to gcpro a bunch of
9049 other variables.) */
9050 if (! (VECTORP (next) || STRINGP (next)))
9051 error ("Function %s returns invalid key sequence", tem);
9053 return next;
9056 /* Do one step of the key remapping used for function-key-map and
9057 key-translation-map:
9058 KEYBUF is the buffer holding the input events.
9059 BUFSIZE is its maximum size.
9060 FKEY is a pointer to the keyremap structure to use.
9061 INPUT is the index of the last element in KEYBUF.
9062 DOIT if non-zero says that the remapping can actually take place.
9063 DIFF is used to return the number of keys added/removed by the remapping.
9064 PARENT is the root of the keymap.
9065 PROMPT is the prompt to use if the remapping happens through a function.
9066 The return value is non-zero if the remapping actually took place. */
9068 static int
9069 keyremap_step (keybuf, bufsize, fkey, input, doit, diff, prompt)
9070 Lisp_Object *keybuf, prompt;
9071 keyremap *fkey;
9072 int input, doit, *diff, bufsize;
9074 Lisp_Object next, key;
9076 key = keybuf[fkey->end++];
9078 if (KEYMAPP (fkey->parent))
9079 next = access_keymap_keyremap (fkey->map, key, prompt, doit);
9080 else
9081 next = Qnil;
9083 /* If keybuf[fkey->start..fkey->end] is bound in the
9084 map and we're in a position to do the key remapping, replace it with
9085 the binding and restart with fkey->start at the end. */
9086 if ((VECTORP (next) || STRINGP (next)) && doit)
9088 int len = XFASTINT (Flength (next));
9089 int i;
9091 *diff = len - (fkey->end - fkey->start);
9093 if (input + *diff >= bufsize)
9094 error ("Key sequence too long");
9096 /* Shift the keys that follow fkey->end. */
9097 if (*diff < 0)
9098 for (i = fkey->end; i < input; i++)
9099 keybuf[i + *diff] = keybuf[i];
9100 else if (*diff > 0)
9101 for (i = input - 1; i >= fkey->end; i--)
9102 keybuf[i + *diff] = keybuf[i];
9103 /* Overwrite the old keys with the new ones. */
9104 for (i = 0; i < len; i++)
9105 keybuf[fkey->start + i]
9106 = Faref (next, make_number (i));
9108 fkey->start = fkey->end += *diff;
9109 fkey->map = fkey->parent;
9111 return 1;
9114 fkey->map = get_keymap (next, 0, 1);
9116 /* If we no longer have a bound suffix, try a new position for
9117 fkey->start. */
9118 if (!CONSP (fkey->map))
9120 fkey->end = ++fkey->start;
9121 fkey->map = fkey->parent;
9123 return 0;
9126 /* Read a sequence of keys that ends with a non prefix character,
9127 storing it in KEYBUF, a buffer of size BUFSIZE.
9128 Prompt with PROMPT.
9129 Return the length of the key sequence stored.
9130 Return -1 if the user rejected a command menu.
9132 Echo starting immediately unless `prompt' is 0.
9134 Where a key sequence ends depends on the currently active keymaps.
9135 These include any minor mode keymaps active in the current buffer,
9136 the current buffer's local map, and the global map.
9138 If a key sequence has no other bindings, we check Vfunction_key_map
9139 to see if some trailing subsequence might be the beginning of a
9140 function key's sequence. If so, we try to read the whole function
9141 key, and substitute its symbolic name into the key sequence.
9143 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9144 `double-' events into similar click events, if that would make them
9145 bound. We try to turn `triple-' events first into `double-' events,
9146 then into clicks.
9148 If we get a mouse click in a mode line, vertical divider, or other
9149 non-text area, we treat the click as if it were prefixed by the
9150 symbol denoting that area - `mode-line', `vertical-line', or
9151 whatever.
9153 If the sequence starts with a mouse click, we read the key sequence
9154 with respect to the buffer clicked on, not the current buffer.
9156 If the user switches frames in the midst of a key sequence, we put
9157 off the switch-frame event until later; the next call to
9158 read_char will return it.
9160 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9161 from the selected window's buffer. */
9163 static int
9164 read_key_sequence (keybuf, bufsize, prompt, dont_downcase_last,
9165 can_return_switch_frame, fix_current_buffer)
9166 Lisp_Object *keybuf;
9167 int bufsize;
9168 Lisp_Object prompt;
9169 int dont_downcase_last;
9170 int can_return_switch_frame;
9171 int fix_current_buffer;
9173 volatile Lisp_Object from_string;
9174 volatile int count = SPECPDL_INDEX ();
9176 /* How many keys there are in the current key sequence. */
9177 volatile int t;
9179 /* The length of the echo buffer when we started reading, and
9180 the length of this_command_keys when we started reading. */
9181 volatile int echo_start;
9182 volatile int keys_start;
9184 /* The number of keymaps we're scanning right now, and the number of
9185 keymaps we have allocated space for. */
9186 volatile int nmaps;
9187 volatile int nmaps_allocated = 0;
9189 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9190 the current keymaps. */
9191 Lisp_Object *volatile defs = NULL;
9193 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9194 in the current keymaps, or nil where it is not a prefix. */
9195 Lisp_Object *volatile submaps = NULL;
9197 /* The local map to start out with at start of key sequence. */
9198 volatile Lisp_Object orig_local_map;
9200 /* The map from the `keymap' property to start out with at start of
9201 key sequence. */
9202 volatile Lisp_Object orig_keymap;
9204 /* 1 if we have already considered switching to the local-map property
9205 of the place where a mouse click occurred. */
9206 volatile int localized_local_map = 0;
9208 /* The index in submaps[] of the first keymap that has a binding for
9209 this key sequence. In other words, the lowest i such that
9210 submaps[i] is non-nil. */
9211 volatile int first_binding;
9212 /* Index of the first key that has no binding.
9213 It is useless to try fkey.start larger than that. */
9214 volatile int first_unbound;
9216 /* If t < mock_input, then KEYBUF[t] should be read as the next
9217 input key.
9219 We use this to recover after recognizing a function key. Once we
9220 realize that a suffix of the current key sequence is actually a
9221 function key's escape sequence, we replace the suffix with the
9222 function key's binding from Vfunction_key_map. Now keybuf
9223 contains a new and different key sequence, so the echo area,
9224 this_command_keys, and the submaps and defs arrays are wrong. In
9225 this situation, we set mock_input to t, set t to 0, and jump to
9226 restart_sequence; the loop will read keys from keybuf up until
9227 mock_input, thus rebuilding the state; and then it will resume
9228 reading characters from the keyboard. */
9229 volatile int mock_input = 0;
9231 /* If the sequence is unbound in submaps[], then
9232 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9233 and fkey.map is its binding.
9235 These might be > t, indicating that all function key scanning
9236 should hold off until t reaches them. We do this when we've just
9237 recognized a function key, to avoid searching for the function
9238 key's again in Vfunction_key_map. */
9239 volatile keyremap fkey;
9241 /* Likewise, for key_translation_map and input-decode-map. */
9242 volatile keyremap keytran, indec;
9244 /* Non-zero if we are trying to map a key by changing an upper-case
9245 letter to lower case, or a shifted function key to an unshifted
9246 one. */
9247 volatile int shift_translated = 0;
9249 /* If we receive a `switch-frame' or `select-window' event in the middle of
9250 a key sequence, we put it off for later.
9251 While we're reading, we keep the event here. */
9252 volatile Lisp_Object delayed_switch_frame;
9254 /* See the comment below... */
9255 #if defined (GOBBLE_FIRST_EVENT)
9256 Lisp_Object first_event;
9257 #endif
9259 volatile Lisp_Object original_uppercase;
9260 volatile int original_uppercase_position = -1;
9262 /* Gets around Microsoft compiler limitations. */
9263 int dummyflag = 0;
9265 struct buffer *starting_buffer;
9267 /* List of events for which a fake prefix key has been generated. */
9268 volatile Lisp_Object fake_prefixed_keys = Qnil;
9270 #if defined (GOBBLE_FIRST_EVENT)
9271 int junk;
9272 #endif
9274 struct gcpro gcpro1;
9276 GCPRO1 (fake_prefixed_keys);
9277 raw_keybuf_count = 0;
9279 last_nonmenu_event = Qnil;
9281 delayed_switch_frame = Qnil;
9283 if (INTERACTIVE)
9285 if (!NILP (prompt))
9286 echo_prompt (prompt);
9287 else if (cursor_in_echo_area
9288 && (FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
9289 && NILP (Fzerop (Vecho_keystrokes)))
9290 /* This doesn't put in a dash if the echo buffer is empty, so
9291 you don't always see a dash hanging out in the minibuffer. */
9292 echo_dash ();
9295 /* Record the initial state of the echo area and this_command_keys;
9296 we will need to restore them if we replay a key sequence. */
9297 if (INTERACTIVE)
9298 echo_start = echo_length ();
9299 keys_start = this_command_key_count;
9300 this_single_command_key_start = keys_start;
9302 #if defined (GOBBLE_FIRST_EVENT)
9303 /* This doesn't quite work, because some of the things that read_char
9304 does cannot safely be bypassed. It seems too risky to try to make
9305 this work right. */
9307 /* Read the first char of the sequence specially, before setting
9308 up any keymaps, in case a filter runs and switches buffers on us. */
9309 first_event = read_char (NILP (prompt), 0, submaps, last_nonmenu_event,
9310 &junk, NULL);
9311 #endif /* GOBBLE_FIRST_EVENT */
9313 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
9314 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
9315 from_string = Qnil;
9317 /* We jump here when we need to reinitialize fkey and keytran; this
9318 happens if we switch keyboards between rescans. */
9319 replay_entire_sequence:
9321 indec.map = indec.parent = current_kboard->Vinput_decode_map;
9322 fkey.map = fkey.parent = current_kboard->Vlocal_function_key_map;
9323 keytran.map = keytran.parent = Vkey_translation_map;
9324 indec.start = indec.end = 0;
9325 fkey.start = fkey.end = 0;
9326 keytran.start = keytran.end = 0;
9328 /* We jump here when the key sequence has been thoroughly changed, and
9329 we need to rescan it starting from the beginning. When we jump here,
9330 keybuf[0..mock_input] holds the sequence we should reread. */
9331 replay_sequence:
9333 starting_buffer = current_buffer;
9334 first_unbound = bufsize + 1;
9336 /* Build our list of keymaps.
9337 If we recognize a function key and replace its escape sequence in
9338 keybuf with its symbol, or if the sequence starts with a mouse
9339 click and we need to switch buffers, we jump back here to rebuild
9340 the initial keymaps from the current buffer. */
9341 nmaps = 0;
9343 if (!NILP (current_kboard->Voverriding_terminal_local_map))
9345 if (2 > nmaps_allocated)
9347 submaps = (Lisp_Object *) alloca (2 * sizeof (submaps[0]));
9348 defs = (Lisp_Object *) alloca (2 * sizeof (defs[0]));
9349 nmaps_allocated = 2;
9351 submaps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
9353 else if (!NILP (Voverriding_local_map))
9355 if (2 > nmaps_allocated)
9357 submaps = (Lisp_Object *) alloca (2 * sizeof (submaps[0]));
9358 defs = (Lisp_Object *) alloca (2 * sizeof (defs[0]));
9359 nmaps_allocated = 2;
9361 submaps[nmaps++] = Voverriding_local_map;
9363 else
9365 int nminor;
9366 int total;
9367 Lisp_Object *maps;
9369 nminor = current_minor_maps (0, &maps);
9370 total = nminor + (!NILP (orig_keymap) ? 3 : 2);
9372 if (total > nmaps_allocated)
9374 submaps = (Lisp_Object *) alloca (total * sizeof (submaps[0]));
9375 defs = (Lisp_Object *) alloca (total * sizeof (defs[0]));
9376 nmaps_allocated = total;
9379 if (!NILP (orig_keymap))
9380 submaps[nmaps++] = orig_keymap;
9382 bcopy (maps, (void *) (submaps + nmaps),
9383 nminor * sizeof (submaps[0]));
9385 nmaps += nminor;
9387 submaps[nmaps++] = orig_local_map;
9389 submaps[nmaps++] = current_global_map;
9391 /* Find an accurate initial value for first_binding. */
9392 for (first_binding = 0; first_binding < nmaps; first_binding++)
9393 if (! NILP (submaps[first_binding]))
9394 break;
9396 /* Start from the beginning in keybuf. */
9397 t = 0;
9399 /* These are no-ops the first time through, but if we restart, they
9400 revert the echo area and this_command_keys to their original state. */
9401 this_command_key_count = keys_start;
9402 if (INTERACTIVE && t < mock_input)
9403 echo_truncate (echo_start);
9405 /* If the best binding for the current key sequence is a keymap, or
9406 we may be looking at a function key's escape sequence, keep on
9407 reading. */
9408 while (first_binding < nmaps
9409 /* Keep reading as long as there's a prefix binding. */
9410 ? !NILP (submaps[first_binding])
9411 /* Don't return in the middle of a possible function key sequence,
9412 if the only bindings we found were via case conversion.
9413 Thus, if ESC O a has a function-key-map translation
9414 and ESC o has a binding, don't return after ESC O,
9415 so that we can translate ESC O plus the next character. */
9416 : (/* indec.start < t || fkey.start < t || */ keytran.start < t))
9418 Lisp_Object key;
9419 int used_mouse_menu = 0;
9421 /* Where the last real key started. If we need to throw away a
9422 key that has expanded into more than one element of keybuf
9423 (say, a mouse click on the mode line which is being treated
9424 as [mode-line (mouse-...)], then we backtrack to this point
9425 of keybuf. */
9426 volatile int last_real_key_start;
9428 /* These variables are analogous to echo_start and keys_start;
9429 while those allow us to restart the entire key sequence,
9430 echo_local_start and keys_local_start allow us to throw away
9431 just one key. */
9432 volatile int echo_local_start, keys_local_start, local_first_binding;
9434 eassert (indec.end == t || (indec.end > t && indec.end <= mock_input));
9435 eassert (indec.start <= indec.end);
9436 eassert (fkey.start <= fkey.end);
9437 eassert (keytran.start <= keytran.end);
9438 /* key-translation-map is applied *after* function-key-map
9439 which is itself applied *after* input-decode-map. */
9440 eassert (fkey.end <= indec.start);
9441 eassert (keytran.end <= fkey.start);
9443 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9444 first_unbound < keytran.start)
9445 { /* The prefix upto first_unbound has no binding and has
9446 no translation left to do either, so we know it's unbound.
9447 If we don't stop now, we risk staying here indefinitely
9448 (if the user keeps entering fkey or keytran prefixes
9449 like C-c ESC ESC ESC ESC ...) */
9450 int i;
9451 for (i = first_unbound + 1; i < t; i++)
9452 keybuf[i - first_unbound - 1] = keybuf[i];
9453 mock_input = t - first_unbound - 1;
9454 indec.end = indec.start -= first_unbound + 1;
9455 indec.map = indec.parent;
9456 fkey.end = fkey.start -= first_unbound + 1;
9457 fkey.map = fkey.parent;
9458 keytran.end = keytran.start -= first_unbound + 1;
9459 keytran.map = keytran.parent;
9460 goto replay_sequence;
9463 if (t >= bufsize)
9464 error ("Key sequence too long");
9466 if (INTERACTIVE)
9467 echo_local_start = echo_length ();
9468 keys_local_start = this_command_key_count;
9469 local_first_binding = first_binding;
9471 replay_key:
9472 /* These are no-ops, unless we throw away a keystroke below and
9473 jumped back up to replay_key; in that case, these restore the
9474 variables to their original state, allowing us to replay the
9475 loop. */
9476 if (INTERACTIVE && t < mock_input)
9477 echo_truncate (echo_local_start);
9478 this_command_key_count = keys_local_start;
9479 first_binding = local_first_binding;
9481 /* By default, assume each event is "real". */
9482 last_real_key_start = t;
9484 /* Does mock_input indicate that we are re-reading a key sequence? */
9485 if (t < mock_input)
9487 key = keybuf[t];
9488 add_command_key (key);
9489 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
9490 && NILP (Fzerop (Vecho_keystrokes)))
9491 echo_char (key);
9494 /* If not, we should actually read a character. */
9495 else
9498 KBOARD *interrupted_kboard = current_kboard;
9499 struct frame *interrupted_frame = SELECTED_FRAME ();
9500 key = read_char (NILP (prompt), nmaps,
9501 (Lisp_Object *) submaps, last_nonmenu_event,
9502 &used_mouse_menu, NULL);
9503 if ((INTEGERP (key) && XINT (key) == -2) /* wrong_kboard_jmpbuf */
9504 /* When switching to a new tty (with a new keyboard),
9505 read_char returns the new buffer, rather than -2
9506 (Bug#5095). This is because `terminal-init-xterm'
9507 calls read-char, which eats the wrong_kboard_jmpbuf
9508 return. Any better way to fix this? -- cyd */
9509 || (interrupted_kboard != current_kboard))
9511 int found = 0;
9512 struct kboard *k;
9514 for (k = all_kboards; k; k = k->next_kboard)
9515 if (k == interrupted_kboard)
9516 found = 1;
9518 if (!found)
9520 /* Don't touch interrupted_kboard when it's been
9521 deleted. */
9522 delayed_switch_frame = Qnil;
9523 goto replay_entire_sequence;
9526 if (!NILP (delayed_switch_frame))
9528 interrupted_kboard->kbd_queue
9529 = Fcons (delayed_switch_frame,
9530 interrupted_kboard->kbd_queue);
9531 delayed_switch_frame = Qnil;
9534 while (t > 0)
9535 interrupted_kboard->kbd_queue
9536 = Fcons (keybuf[--t], interrupted_kboard->kbd_queue);
9538 /* If the side queue is non-empty, ensure it begins with a
9539 switch-frame, so we'll replay it in the right context. */
9540 if (CONSP (interrupted_kboard->kbd_queue)
9541 && (key = XCAR (interrupted_kboard->kbd_queue),
9542 !(EVENT_HAS_PARAMETERS (key)
9543 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key)),
9544 Qswitch_frame))))
9546 Lisp_Object frame;
9547 XSETFRAME (frame, interrupted_frame);
9548 interrupted_kboard->kbd_queue
9549 = Fcons (make_lispy_switch_frame (frame),
9550 interrupted_kboard->kbd_queue);
9552 mock_input = 0;
9553 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
9554 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
9555 goto replay_entire_sequence;
9559 /* read_char returns t when it shows a menu and the user rejects it.
9560 Just return -1. */
9561 if (EQ (key, Qt))
9563 unbind_to (count, Qnil);
9564 UNGCPRO;
9565 return -1;
9568 /* read_char returns -1 at the end of a macro.
9569 Emacs 18 handles this by returning immediately with a
9570 zero, so that's what we'll do. */
9571 if (INTEGERP (key) && XINT (key) == -1)
9573 t = 0;
9574 /* The Microsoft C compiler can't handle the goto that
9575 would go here. */
9576 dummyflag = 1;
9577 break;
9580 /* If the current buffer has been changed from under us, the
9581 keymap may have changed, so replay the sequence. */
9582 if (BUFFERP (key))
9584 timer_resume_idle ();
9586 mock_input = t;
9587 /* Reset the current buffer from the selected window
9588 in case something changed the former and not the latter.
9589 This is to be more consistent with the behavior
9590 of the command_loop_1. */
9591 if (fix_current_buffer)
9593 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
9594 Fkill_emacs (Qnil);
9595 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
9596 Fset_buffer (XWINDOW (selected_window)->buffer);
9599 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
9600 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
9601 goto replay_sequence;
9604 /* If we have a quit that was typed in another frame, and
9605 quit_throw_to_read_char switched buffers,
9606 replay to get the right keymap. */
9607 if (INTEGERP (key)
9608 && XINT (key) == quit_char
9609 && current_buffer != starting_buffer)
9611 GROW_RAW_KEYBUF;
9612 XVECTOR (raw_keybuf)->contents[raw_keybuf_count++] = key;
9613 keybuf[t++] = key;
9614 mock_input = t;
9615 Vquit_flag = Qnil;
9616 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
9617 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
9618 goto replay_sequence;
9621 Vquit_flag = Qnil;
9623 if (EVENT_HAS_PARAMETERS (key)
9624 /* Either a `switch-frame' or a `select-window' event. */
9625 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key)), Qswitch_frame))
9627 /* If we're at the beginning of a key sequence, and the caller
9628 says it's okay, go ahead and return this event. If we're
9629 in the midst of a key sequence, delay it until the end. */
9630 if (t > 0 || !can_return_switch_frame)
9632 delayed_switch_frame = key;
9633 goto replay_key;
9637 GROW_RAW_KEYBUF;
9638 ASET (raw_keybuf, raw_keybuf_count, key);
9639 raw_keybuf_count++;
9642 /* Clicks in non-text areas get prefixed by the symbol
9643 in their CHAR-ADDRESS field. For example, a click on
9644 the mode line is prefixed by the symbol `mode-line'.
9646 Furthermore, key sequences beginning with mouse clicks
9647 are read using the keymaps of the buffer clicked on, not
9648 the current buffer. So we may have to switch the buffer
9649 here.
9651 When we turn one event into two events, we must make sure
9652 that neither of the two looks like the original--so that,
9653 if we replay the events, they won't be expanded again.
9654 If not for this, such reexpansion could happen either here
9655 or when user programs play with this-command-keys. */
9656 if (EVENT_HAS_PARAMETERS (key))
9658 Lisp_Object kind;
9659 Lisp_Object string;
9661 kind = EVENT_HEAD_KIND (EVENT_HEAD (key));
9662 if (EQ (kind, Qmouse_click))
9664 Lisp_Object window, posn;
9666 window = POSN_WINDOW (EVENT_START (key));
9667 posn = POSN_POSN (EVENT_START (key));
9669 if (CONSP (posn)
9670 || (!NILP (fake_prefixed_keys)
9671 && !NILP (Fmemq (key, fake_prefixed_keys))))
9673 /* We're looking a second time at an event for which
9674 we generated a fake prefix key. Set
9675 last_real_key_start appropriately. */
9676 if (t > 0)
9677 last_real_key_start = t - 1;
9680 /* Key sequences beginning with mouse clicks are
9681 read using the keymaps in the buffer clicked on,
9682 not the current buffer. If we're at the
9683 beginning of a key sequence, switch buffers. */
9684 if (last_real_key_start == 0
9685 && WINDOWP (window)
9686 && BUFFERP (XWINDOW (window)->buffer)
9687 && XBUFFER (XWINDOW (window)->buffer) != current_buffer)
9689 XVECTOR (raw_keybuf)->contents[raw_keybuf_count++] = key;
9690 keybuf[t] = key;
9691 mock_input = t + 1;
9693 /* Arrange to go back to the original buffer once we're
9694 done reading the key sequence. Note that we can't
9695 use save_excursion_{save,restore} here, because they
9696 save point as well as the current buffer; we don't
9697 want to save point, because redisplay may change it,
9698 to accommodate a Fset_window_start or something. We
9699 don't want to do this at the top of the function,
9700 because we may get input from a subprocess which
9701 wants to change the selected window and stuff (say,
9702 emacsclient). */
9703 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
9705 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
9706 Fkill_emacs (Qnil);
9707 set_buffer_internal (XBUFFER (XWINDOW (window)->buffer));
9708 orig_local_map = get_local_map (PT, current_buffer,
9709 Qlocal_map);
9710 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
9711 goto replay_sequence;
9714 /* For a mouse click, get the local text-property keymap
9715 of the place clicked on, rather than point. */
9716 if (last_real_key_start == 0
9717 && CONSP (XCDR (key))
9718 && ! localized_local_map)
9720 Lisp_Object map_here, start, pos;
9722 localized_local_map = 1;
9723 start = EVENT_START (key);
9725 if (CONSP (start) && POSN_INBUFFER_P (start))
9727 pos = POSN_BUFFER_POSN (start);
9728 if (INTEGERP (pos)
9729 && XINT (pos) >= BEGV
9730 && XINT (pos) <= ZV)
9732 map_here = get_local_map (XINT (pos),
9733 current_buffer, Qlocal_map);
9734 if (!EQ (map_here, orig_local_map))
9736 orig_local_map = map_here;
9737 ++localized_local_map;
9740 map_here = get_local_map (XINT (pos),
9741 current_buffer, Qkeymap);
9742 if (!EQ (map_here, orig_keymap))
9744 orig_keymap = map_here;
9745 ++localized_local_map;
9748 if (localized_local_map > 1)
9750 keybuf[t] = key;
9751 mock_input = t + 1;
9753 goto replay_sequence;
9759 /* Expand mode-line and scroll-bar events into two events:
9760 use posn as a fake prefix key. */
9761 if (SYMBOLP (posn)
9762 && (NILP (fake_prefixed_keys)
9763 || NILP (Fmemq (key, fake_prefixed_keys))))
9765 if (t + 1 >= bufsize)
9766 error ("Key sequence too long");
9768 keybuf[t] = posn;
9769 keybuf[t + 1] = key;
9770 mock_input = t + 2;
9772 /* Record that a fake prefix key has been generated
9773 for KEY. Don't modify the event; this would
9774 prevent proper action when the event is pushed
9775 back into unread-command-events. */
9776 fake_prefixed_keys = Fcons (key, fake_prefixed_keys);
9778 /* If on a mode line string with a local keymap,
9779 reconsider the key sequence with that keymap. */
9780 if (string = POSN_STRING (EVENT_START (key)),
9781 (CONSP (string) && STRINGP (XCAR (string))))
9783 Lisp_Object pos, map, map2;
9785 pos = XCDR (string);
9786 string = XCAR (string);
9787 if (XINT (pos) >= 0
9788 && XINT (pos) < SCHARS (string))
9790 map = Fget_text_property (pos, Qlocal_map, string);
9791 if (!NILP (map))
9792 orig_local_map = map;
9793 map2 = Fget_text_property (pos, Qkeymap, string);
9794 if (!NILP (map2))
9795 orig_keymap = map2;
9796 if (!NILP (map) || !NILP (map2))
9797 goto replay_sequence;
9801 goto replay_key;
9803 else if (NILP (from_string)
9804 && (string = POSN_STRING (EVENT_START (key)),
9805 (CONSP (string) && STRINGP (XCAR (string)))))
9807 /* For a click on a string, i.e. overlay string or a
9808 string displayed via the `display' property,
9809 consider `local-map' and `keymap' properties of
9810 that string. */
9811 Lisp_Object pos, map, map2;
9813 pos = XCDR (string);
9814 string = XCAR (string);
9815 if (XINT (pos) >= 0
9816 && XINT (pos) < SCHARS (string))
9818 map = Fget_text_property (pos, Qlocal_map, string);
9819 if (!NILP (map))
9820 orig_local_map = map;
9821 map2 = Fget_text_property (pos, Qkeymap, string);
9822 if (!NILP (map2))
9823 orig_keymap = map2;
9825 if (!NILP (map) || !NILP (map2))
9827 from_string = string;
9828 keybuf[t++] = key;
9829 mock_input = t;
9830 goto replay_sequence;
9835 else if (CONSP (XCDR (key))
9836 && CONSP (EVENT_START (key))
9837 && CONSP (XCDR (EVENT_START (key))))
9839 Lisp_Object posn;
9841 posn = POSN_POSN (EVENT_START (key));
9842 /* Handle menu-bar events:
9843 insert the dummy prefix event `menu-bar'. */
9844 if (EQ (posn, Qmenu_bar) || EQ (posn, Qtool_bar))
9846 if (t + 1 >= bufsize)
9847 error ("Key sequence too long");
9848 keybuf[t] = posn;
9849 keybuf[t+1] = key;
9851 /* Zap the position in key, so we know that we've
9852 expanded it, and don't try to do so again. */
9853 POSN_SET_POSN (EVENT_START (key),
9854 Fcons (posn, Qnil));
9856 mock_input = t + 2;
9857 goto replay_sequence;
9859 else if (CONSP (posn))
9861 /* We're looking at the second event of a
9862 sequence which we expanded before. Set
9863 last_real_key_start appropriately. */
9864 if (last_real_key_start == t && t > 0)
9865 last_real_key_start = t - 1;
9870 /* We have finally decided that KEY is something we might want
9871 to look up. */
9872 first_binding = (follow_key (key,
9873 nmaps - first_binding,
9874 submaps + first_binding,
9875 defs + first_binding,
9876 submaps + first_binding)
9877 + first_binding);
9879 /* If KEY wasn't bound, we'll try some fallbacks. */
9880 if (first_binding < nmaps)
9881 /* This is needed for the following scenario:
9882 event 0: a down-event that gets dropped by calling replay_key.
9883 event 1: some normal prefix like C-h.
9884 After event 0, first_unbound is 0, after event 1 indec.start,
9885 fkey.start, and keytran.start are all 1, so when we see that
9886 C-h is bound, we need to update first_unbound. */
9887 first_unbound = max (t + 1, first_unbound);
9888 else
9890 Lisp_Object head;
9892 /* Remember the position to put an upper bound on indec.start. */
9893 first_unbound = min (t, first_unbound);
9895 head = EVENT_HEAD (key);
9896 if (help_char_p (head) && t > 0)
9898 read_key_sequence_cmd = Vprefix_help_command;
9899 keybuf[t++] = key;
9900 last_nonmenu_event = key;
9901 /* The Microsoft C compiler can't handle the goto that
9902 would go here. */
9903 dummyflag = 1;
9904 break;
9907 if (SYMBOLP (head))
9909 Lisp_Object breakdown;
9910 int modifiers;
9912 breakdown = parse_modifiers (head);
9913 modifiers = XINT (XCAR (XCDR (breakdown)));
9914 /* Attempt to reduce an unbound mouse event to a simpler
9915 event that is bound:
9916 Drags reduce to clicks.
9917 Double-clicks reduce to clicks.
9918 Triple-clicks reduce to double-clicks, then to clicks.
9919 Down-clicks are eliminated.
9920 Double-downs reduce to downs, then are eliminated.
9921 Triple-downs reduce to double-downs, then to downs,
9922 then are eliminated. */
9923 if (modifiers & (down_modifier | drag_modifier
9924 | double_modifier | triple_modifier))
9926 while (modifiers & (down_modifier | drag_modifier
9927 | double_modifier | triple_modifier))
9929 Lisp_Object new_head, new_click;
9930 if (modifiers & triple_modifier)
9931 modifiers ^= (double_modifier | triple_modifier);
9932 else if (modifiers & double_modifier)
9933 modifiers &= ~double_modifier;
9934 else if (modifiers & drag_modifier)
9935 modifiers &= ~drag_modifier;
9936 else
9938 /* Dispose of this `down' event by simply jumping
9939 back to replay_key, to get another event.
9941 Note that if this event came from mock input,
9942 then just jumping back to replay_key will just
9943 hand it to us again. So we have to wipe out any
9944 mock input.
9946 We could delete keybuf[t] and shift everything
9947 after that to the left by one spot, but we'd also
9948 have to fix up any variable that points into
9949 keybuf, and shifting isn't really necessary
9950 anyway.
9952 Adding prefixes for non-textual mouse clicks
9953 creates two characters of mock input, and both
9954 must be thrown away. If we're only looking at
9955 the prefix now, we can just jump back to
9956 replay_key. On the other hand, if we've already
9957 processed the prefix, and now the actual click
9958 itself is giving us trouble, then we've lost the
9959 state of the keymaps we want to backtrack to, and
9960 we need to replay the whole sequence to rebuild
9963 Beyond that, only function key expansion could
9964 create more than two keys, but that should never
9965 generate mouse events, so it's okay to zero
9966 mock_input in that case too.
9968 FIXME: The above paragraph seems just plain
9969 wrong, if you consider things like
9970 xterm-mouse-mode. -stef
9972 Isn't this just the most wonderful code ever? */
9974 /* If mock_input > t + 1, the above simplification
9975 will actually end up dropping keys on the floor.
9976 This is probably OK for now, but even
9977 if mock_input <= t + 1, we need to adjust indec,
9978 fkey, and keytran.
9979 Typical case [header-line down-mouse-N]:
9980 mock_input = 2, t = 1, fkey.end = 1,
9981 last_real_key_start = 0. */
9982 if (indec.end > last_real_key_start)
9984 indec.end = indec.start
9985 = min (last_real_key_start, indec.start);
9986 indec.map = indec.parent;
9987 if (fkey.end > last_real_key_start)
9989 fkey.end = fkey.start
9990 = min (last_real_key_start, fkey.start);
9991 fkey.map = fkey.parent;
9992 if (keytran.end > last_real_key_start)
9994 keytran.end = keytran.start
9995 = min (last_real_key_start, keytran.start);
9996 keytran.map = keytran.parent;
10000 if (t == last_real_key_start)
10002 mock_input = 0;
10003 goto replay_key;
10005 else
10007 mock_input = last_real_key_start;
10008 goto replay_sequence;
10012 new_head
10013 = apply_modifiers (modifiers, XCAR (breakdown));
10014 new_click
10015 = Fcons (new_head, Fcons (EVENT_START (key), Qnil));
10017 /* Look for a binding for this new key. follow_key
10018 promises that it didn't munge submaps the
10019 last time we called it, since key was unbound. */
10020 first_binding
10021 = (follow_key (new_click,
10022 nmaps - local_first_binding,
10023 submaps + local_first_binding,
10024 defs + local_first_binding,
10025 submaps + local_first_binding)
10026 + local_first_binding);
10028 /* If that click is bound, go for it. */
10029 if (first_binding < nmaps)
10031 key = new_click;
10032 break;
10034 /* Otherwise, we'll leave key set to the drag event. */
10040 keybuf[t++] = key;
10041 /* Normally, last_nonmenu_event gets the previous key we read.
10042 But when a mouse popup menu is being used,
10043 we don't update last_nonmenu_event; it continues to hold the mouse
10044 event that preceded the first level of menu. */
10045 if (!used_mouse_menu)
10046 last_nonmenu_event = key;
10048 /* Record what part of this_command_keys is the current key sequence. */
10049 this_single_command_key_start = this_command_key_count - t;
10051 /* Look for this sequence in input-decode-map.
10052 Scan from indec.end until we find a bound suffix. */
10053 while (indec.end < t)
10055 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
10056 int done, diff;
10058 GCPRO4 (indec.map, fkey.map, keytran.map, delayed_switch_frame);
10059 done = keyremap_step (keybuf, bufsize, &indec, max (t, mock_input),
10060 1, &diff, prompt);
10061 UNGCPRO;
10062 if (done)
10064 mock_input = diff + max (t, mock_input);
10065 goto replay_sequence;
10069 if (first_binding < nmaps && NILP (submaps[first_binding])
10070 && indec.start >= t)
10071 /* There is a binding and it's not a prefix.
10072 (and it doesn't have any input-decode-map translation pending).
10073 There is thus no function-key in this sequence.
10074 Moving fkey.start is important in this case to allow keytran.start
10075 to go over the sequence before we return (since we keep the
10076 invariant that keytran.end <= fkey.start). */
10078 if (fkey.start < t)
10079 (fkey.start = fkey.end = t, fkey.map = fkey.parent);
10081 else
10082 /* If the sequence is unbound, see if we can hang a function key
10083 off the end of it. */
10084 /* Continue scan from fkey.end until we find a bound suffix. */
10085 while (fkey.end < indec.start)
10087 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
10088 int done, diff;
10090 GCPRO4 (indec.map, fkey.map, keytran.map, delayed_switch_frame);
10091 done = keyremap_step (keybuf, bufsize, &fkey,
10092 max (t, mock_input),
10093 /* If there's a binding (i.e.
10094 first_binding >= nmaps) we don't want
10095 to apply this function-key-mapping. */
10096 fkey.end + 1 == t && first_binding >= nmaps,
10097 &diff, prompt);
10098 UNGCPRO;
10099 if (done)
10101 mock_input = diff + max (t, mock_input);
10102 /* Adjust the input-decode-map counters. */
10103 indec.end += diff;
10104 indec.start += diff;
10106 goto replay_sequence;
10110 /* Look for this sequence in key-translation-map.
10111 Scan from keytran.end until we find a bound suffix. */
10112 while (keytran.end < fkey.start)
10114 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
10115 int done, diff;
10117 GCPRO4 (indec.map, fkey.map, keytran.map, delayed_switch_frame);
10118 done = keyremap_step (keybuf, bufsize, &keytran, max (t, mock_input),
10119 1, &diff, prompt);
10120 UNGCPRO;
10121 if (done)
10123 mock_input = diff + max (t, mock_input);
10124 /* Adjust the function-key-map and input-decode-map counters. */
10125 indec.end += diff;
10126 indec.start += diff;
10127 fkey.end += diff;
10128 fkey.start += diff;
10130 goto replay_sequence;
10134 /* If KEY is not defined in any of the keymaps,
10135 and cannot be part of a function key or translation,
10136 and is an upper case letter
10137 use the corresponding lower-case letter instead. */
10138 if (first_binding >= nmaps
10139 && /* indec.start >= t && fkey.start >= t && */ keytran.start >= t
10140 && INTEGERP (key)
10141 && ((CHARACTERP (make_number (XINT (key) & ~CHAR_MODIFIER_MASK))
10142 && UPPERCASEP (XINT (key) & ~CHAR_MODIFIER_MASK))
10143 || (XINT (key) & shift_modifier)))
10145 Lisp_Object new_key;
10147 original_uppercase = key;
10148 original_uppercase_position = t - 1;
10150 if (XINT (key) & shift_modifier)
10151 XSETINT (new_key, XINT (key) & ~shift_modifier);
10152 else
10153 XSETINT (new_key, (DOWNCASE (XINT (key) & ~CHAR_MODIFIER_MASK)
10154 | (XINT (key) & CHAR_MODIFIER_MASK)));
10156 /* We have to do this unconditionally, regardless of whether
10157 the lower-case char is defined in the keymaps, because they
10158 might get translated through function-key-map. */
10159 keybuf[t - 1] = new_key;
10160 mock_input = max (t, mock_input);
10161 shift_translated = 1;
10163 goto replay_sequence;
10165 /* If KEY is not defined in any of the keymaps,
10166 and cannot be part of a function key or translation,
10167 and is a shifted function key,
10168 use the corresponding unshifted function key instead. */
10169 if (first_binding >= nmaps
10170 && /* indec.start >= t && fkey.start >= t && */ keytran.start >= t)
10172 Lisp_Object breakdown = parse_modifiers (key);
10173 int modifiers
10174 = CONSP (breakdown) ? (XINT (XCAR (XCDR (breakdown)))) : 0;
10176 if (modifiers & shift_modifier
10177 /* Treat uppercase keys as shifted. */
10178 || (INTEGERP (key)
10179 && (KEY_TO_CHAR (key)
10180 < XCHAR_TABLE (current_buffer->downcase_table)->size)
10181 && UPPERCASEP (KEY_TO_CHAR (key))))
10183 Lisp_Object new_key
10184 = (modifiers & shift_modifier
10185 ? apply_modifiers (modifiers & ~shift_modifier,
10186 XCAR (breakdown))
10187 : make_number (DOWNCASE (KEY_TO_CHAR (key)) | modifiers));
10189 original_uppercase = key;
10190 original_uppercase_position = t - 1;
10192 /* We have to do this unconditionally, regardless of whether
10193 the lower-case char is defined in the keymaps, because they
10194 might get translated through function-key-map. */
10195 keybuf[t - 1] = new_key;
10196 mock_input = max (t, mock_input);
10197 /* Reset fkey (and consequently keytran) to apply
10198 function-key-map on the result, so that S-backspace is
10199 correctly mapped to DEL (via backspace). OTOH,
10200 input-decode-map doesn't need to go through it again. */
10201 fkey.start = fkey.end = 0;
10202 keytran.start = keytran.end = 0;
10203 shift_translated = 1;
10205 goto replay_sequence;
10209 if (!dummyflag)
10210 read_key_sequence_cmd = (first_binding < nmaps
10211 ? defs[first_binding]
10212 : Qnil);
10214 unread_switch_frame = delayed_switch_frame;
10215 unbind_to (count, Qnil);
10217 /* Don't downcase the last character if the caller says don't.
10218 Don't downcase it if the result is undefined, either. */
10219 if ((dont_downcase_last || first_binding >= nmaps)
10220 && t > 0
10221 && t - 1 == original_uppercase_position)
10223 keybuf[t - 1] = original_uppercase;
10224 shift_translated = 0;
10227 if (shift_translated)
10228 Vthis_command_keys_shift_translated = Qt;
10230 /* Occasionally we fabricate events, perhaps by expanding something
10231 according to function-key-map, or by adding a prefix symbol to a
10232 mouse click in the scroll bar or modeline. In this cases, return
10233 the entire generated key sequence, even if we hit an unbound
10234 prefix or a definition before the end. This means that you will
10235 be able to push back the event properly, and also means that
10236 read-key-sequence will always return a logical unit.
10238 Better ideas? */
10239 for (; t < mock_input; t++)
10241 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
10242 && NILP (Fzerop (Vecho_keystrokes)))
10243 echo_char (keybuf[t]);
10244 add_command_key (keybuf[t]);
10247 UNGCPRO;
10248 return t;
10251 DEFUN ("read-key-sequence", Fread_key_sequence, Sread_key_sequence, 1, 5, 0,
10252 doc: /* Read a sequence of keystrokes and return as a string or vector.
10253 The sequence is sufficient to specify a non-prefix command in the
10254 current local and global maps.
10256 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10257 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10258 as a continuation of the previous key.
10260 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10261 convert the last event to lower case. (Normally any upper case event
10262 is converted to lower case if the original event is undefined and the lower
10263 case equivalent is defined.) A non-nil value is appropriate for reading
10264 a key sequence to be defined.
10266 A C-g typed while in this function is treated like any other character,
10267 and `quit-flag' is not set.
10269 If the key sequence starts with a mouse click, then the sequence is read
10270 using the keymaps of the buffer of the window clicked in, not the buffer
10271 of the selected window as normal.
10273 `read-key-sequence' drops unbound button-down events, since you normally
10274 only care about the click or drag events which follow them. If a drag
10275 or multi-click event is unbound, but the corresponding click event would
10276 be bound, `read-key-sequence' turns the event into a click event at the
10277 drag's starting position. This means that you don't have to distinguish
10278 between click and drag, double, or triple events unless you want to.
10280 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10281 lines separating windows, and scroll bars with imaginary keys
10282 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10284 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10285 function will process a switch-frame event if the user switches frames
10286 before typing anything. If the user switches frames in the middle of a
10287 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10288 is nil, then the event will be put off until after the current key sequence.
10290 `read-key-sequence' checks `function-key-map' for function key
10291 sequences, where they wouldn't conflict with ordinary bindings. See
10292 `function-key-map' for more details.
10294 The optional fifth argument COMMAND-LOOP, if non-nil, means
10295 that this key sequence is being read by something that will
10296 read commands one after another. It should be nil if the caller
10297 will read just one key sequence. */)
10298 (prompt, continue_echo, dont_downcase_last, can_return_switch_frame,
10299 command_loop)
10300 Lisp_Object prompt, continue_echo, dont_downcase_last;
10301 Lisp_Object can_return_switch_frame, command_loop;
10303 Lisp_Object keybuf[30];
10304 register int i;
10305 struct gcpro gcpro1;
10306 int count = SPECPDL_INDEX ();
10308 if (!NILP (prompt))
10309 CHECK_STRING (prompt);
10310 QUIT;
10312 specbind (Qinput_method_exit_on_first_char,
10313 (NILP (command_loop) ? Qt : Qnil));
10314 specbind (Qinput_method_use_echo_area,
10315 (NILP (command_loop) ? Qt : Qnil));
10317 bzero (keybuf, sizeof keybuf);
10318 GCPRO1 (keybuf[0]);
10319 gcpro1.nvars = (sizeof keybuf/sizeof (keybuf[0]));
10321 if (NILP (continue_echo))
10323 this_command_key_count = 0;
10324 this_command_key_count_reset = 0;
10325 this_single_command_key_start = 0;
10328 #ifdef HAVE_WINDOW_SYSTEM
10329 if (display_hourglass_p)
10330 cancel_hourglass ();
10331 #endif
10333 i = read_key_sequence (keybuf, (sizeof keybuf/sizeof (keybuf[0])),
10334 prompt, ! NILP (dont_downcase_last),
10335 ! NILP (can_return_switch_frame), 0);
10337 #if 0 /* The following is fine for code reading a key sequence and
10338 then proceeding with a lenghty computation, but it's not good
10339 for code reading keys in a loop, like an input method. */
10340 #ifdef HAVE_WINDOW_SYSTEM
10341 if (display_hourglass_p)
10342 start_hourglass ();
10343 #endif
10344 #endif
10346 if (i == -1)
10348 Vquit_flag = Qt;
10349 QUIT;
10351 UNGCPRO;
10352 return unbind_to (count, make_event_array (i, keybuf));
10355 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector,
10356 Sread_key_sequence_vector, 1, 5, 0,
10357 doc: /* Like `read-key-sequence' but always return a vector. */)
10358 (prompt, continue_echo, dont_downcase_last, can_return_switch_frame,
10359 command_loop)
10360 Lisp_Object prompt, continue_echo, dont_downcase_last;
10361 Lisp_Object can_return_switch_frame, command_loop;
10363 Lisp_Object keybuf[30];
10364 register int i;
10365 struct gcpro gcpro1;
10366 int count = SPECPDL_INDEX ();
10368 if (!NILP (prompt))
10369 CHECK_STRING (prompt);
10370 QUIT;
10372 specbind (Qinput_method_exit_on_first_char,
10373 (NILP (command_loop) ? Qt : Qnil));
10374 specbind (Qinput_method_use_echo_area,
10375 (NILP (command_loop) ? Qt : Qnil));
10377 bzero (keybuf, sizeof keybuf);
10378 GCPRO1 (keybuf[0]);
10379 gcpro1.nvars = (sizeof keybuf/sizeof (keybuf[0]));
10381 if (NILP (continue_echo))
10383 this_command_key_count = 0;
10384 this_command_key_count_reset = 0;
10385 this_single_command_key_start = 0;
10388 #ifdef HAVE_WINDOW_SYSTEM
10389 if (display_hourglass_p)
10390 cancel_hourglass ();
10391 #endif
10393 i = read_key_sequence (keybuf, (sizeof keybuf/sizeof (keybuf[0])),
10394 prompt, ! NILP (dont_downcase_last),
10395 ! NILP (can_return_switch_frame), 0);
10397 #ifdef HAVE_WINDOW_SYSTEM
10398 if (display_hourglass_p)
10399 start_hourglass ();
10400 #endif
10402 if (i == -1)
10404 Vquit_flag = Qt;
10405 QUIT;
10407 UNGCPRO;
10408 return unbind_to (count, Fvector (i, keybuf));
10411 DEFUN ("command-execute", Fcommand_execute, Scommand_execute, 1, 4, 0,
10412 doc: /* Execute CMD as an editor command.
10413 CMD must be a symbol that satisfies the `commandp' predicate.
10414 Optional second arg RECORD-FLAG non-nil
10415 means unconditionally put this command in `command-history'.
10416 Otherwise, that is done only if an arg is read using the minibuffer.
10417 The argument KEYS specifies the value to use instead of (this-command-keys)
10418 when reading the arguments; if it is nil, (this-command-keys) is used.
10419 The argument SPECIAL, if non-nil, means that this command is executing
10420 a special event, so ignore the prefix argument and don't clear it. */)
10421 (cmd, record_flag, keys, special)
10422 Lisp_Object cmd, record_flag, keys, special;
10424 register Lisp_Object final;
10425 register Lisp_Object tem;
10426 Lisp_Object prefixarg;
10427 extern int debug_on_next_call;
10429 debug_on_next_call = 0;
10431 if (NILP (special))
10433 prefixarg = current_kboard->Vprefix_arg;
10434 Vcurrent_prefix_arg = prefixarg;
10435 current_kboard->Vprefix_arg = Qnil;
10437 else
10438 prefixarg = Qnil;
10440 if (SYMBOLP (cmd))
10442 tem = Fget (cmd, Qdisabled);
10443 if (!NILP (tem) && !NILP (Vrun_hooks))
10445 tem = Fsymbol_value (Qdisabled_command_function);
10446 if (!NILP (tem))
10447 return call1 (Vrun_hooks, Qdisabled_command_function);
10451 while (1)
10453 final = Findirect_function (cmd, Qnil);
10455 if (CONSP (final) && (tem = Fcar (final), EQ (tem, Qautoload)))
10457 struct gcpro gcpro1, gcpro2;
10459 GCPRO2 (cmd, prefixarg);
10460 do_autoload (final, cmd);
10461 UNGCPRO;
10463 else
10464 break;
10467 if (STRINGP (final) || VECTORP (final))
10469 /* If requested, place the macro in the command history. For
10470 other sorts of commands, call-interactively takes care of
10471 this. */
10472 if (!NILP (record_flag))
10474 Vcommand_history
10475 = Fcons (Fcons (Qexecute_kbd_macro,
10476 Fcons (final, Fcons (prefixarg, Qnil))),
10477 Vcommand_history);
10479 /* Don't keep command history around forever. */
10480 if (NUMBERP (Vhistory_length) && XINT (Vhistory_length) > 0)
10482 tem = Fnthcdr (Vhistory_length, Vcommand_history);
10483 if (CONSP (tem))
10484 XSETCDR (tem, Qnil);
10488 return Fexecute_kbd_macro (final, prefixarg, Qnil);
10491 if (CONSP (final) || SUBRP (final) || COMPILEDP (final))
10492 /* Don't call Fcall_interactively directly because we want to make
10493 sure the backtrace has an entry for `call-interactively'.
10494 For the same reason, pass `cmd' rather than `final'. */
10495 return call3 (Qcall_interactively, cmd, record_flag, keys);
10497 return Qnil;
10502 DEFUN ("execute-extended-command", Fexecute_extended_command, Sexecute_extended_command,
10503 1, 1, "P",
10504 doc: /* Read function name, then read its arguments and call it.
10506 To pass a numeric argument to the command you are invoking with, specify
10507 the numeric argument to this command.
10509 Noninteractively, the argument PREFIXARG is the prefix argument to
10510 give to the command you invoke, if it asks for an argument. */)
10511 (prefixarg)
10512 Lisp_Object prefixarg;
10514 Lisp_Object function;
10515 char buf[40];
10516 int saved_last_point_position;
10517 Lisp_Object saved_keys, saved_last_point_position_buffer;
10518 Lisp_Object bindings, value;
10519 struct gcpro gcpro1, gcpro2, gcpro3;
10520 #ifdef HAVE_WINDOW_SYSTEM
10521 /* The call to Fcompleting_read wil start and cancel the hourglass,
10522 but if the hourglass was already scheduled, this means that no
10523 hourglass will be shown for the actual M-x command itself.
10524 So we restart it if it is already scheduled. Note that checking
10525 hourglass_shown_p is not enough, normally the hourglass is not shown,
10526 just scheduled to be shown. */
10527 int hstarted = hourglass_started ();
10528 #endif
10530 saved_keys = Fvector (this_command_key_count,
10531 XVECTOR (this_command_keys)->contents);
10532 saved_last_point_position_buffer = last_point_position_buffer;
10533 saved_last_point_position = last_point_position;
10534 buf[0] = 0;
10535 GCPRO3 (saved_keys, prefixarg, saved_last_point_position_buffer);
10537 if (EQ (prefixarg, Qminus))
10538 strcpy (buf, "- ");
10539 else if (CONSP (prefixarg) && XINT (XCAR (prefixarg)) == 4)
10540 strcpy (buf, "C-u ");
10541 else if (CONSP (prefixarg) && INTEGERP (XCAR (prefixarg)))
10542 sprintf (buf, "%ld ", (long) XINT (XCAR (prefixarg)));
10543 else if (INTEGERP (prefixarg))
10544 sprintf (buf, "%ld ", (long) XINT (prefixarg));
10546 /* This isn't strictly correct if execute-extended-command
10547 is bound to anything else. Perhaps it should use
10548 this_command_keys? */
10549 strcat (buf, "M-x ");
10551 /* Prompt with buf, and then read a string, completing from and
10552 restricting to the set of all defined commands. Don't provide
10553 any initial input. Save the command read on the extended-command
10554 history list. */
10555 function = Fcompleting_read (build_string (buf),
10556 Vobarray, Qcommandp,
10557 Qt, Qnil, Qextended_command_history, Qnil,
10558 Qnil);
10560 #ifdef HAVE_WINDOW_SYSTEM
10561 if (hstarted) start_hourglass ();
10562 #endif
10564 if (STRINGP (function) && SCHARS (function) == 0)
10565 error ("No command name given");
10567 /* Set this_command_keys to the concatenation of saved_keys and
10568 function, followed by a RET. */
10570 Lisp_Object *keys;
10571 int i;
10573 this_command_key_count = 0;
10574 this_command_key_count_reset = 0;
10575 this_single_command_key_start = 0;
10577 keys = XVECTOR (saved_keys)->contents;
10578 for (i = 0; i < XVECTOR (saved_keys)->size; i++)
10579 add_command_key (keys[i]);
10581 for (i = 0; i < SCHARS (function); i++)
10582 add_command_key (Faref (function, make_number (i)));
10584 add_command_key (make_number ('\015'));
10587 last_point_position = saved_last_point_position;
10588 last_point_position_buffer = saved_last_point_position_buffer;
10590 UNGCPRO;
10592 function = Fintern (function, Qnil);
10593 current_kboard->Vprefix_arg = prefixarg;
10594 Vthis_command = function;
10595 real_this_command = function;
10597 /* If enabled, show which key runs this command. */
10598 if (!NILP (Vsuggest_key_bindings)
10599 && NILP (Vexecuting_kbd_macro)
10600 && SYMBOLP (function))
10601 bindings = Fwhere_is_internal (function, Voverriding_local_map,
10602 Qt, Qnil, Qnil);
10603 else
10604 bindings = Qnil;
10606 value = Qnil;
10607 GCPRO3 (bindings, value, function);
10608 value = Fcommand_execute (function, Qt, Qnil, Qnil);
10610 /* If the command has a key binding, print it now. */
10611 if (!NILP (bindings)
10612 && ! (VECTORP (bindings) && EQ (Faref (bindings, make_number (0)),
10613 Qmouse_movement)))
10615 /* But first wait, and skip the message if there is input. */
10616 Lisp_Object waited;
10618 /* If this command displayed something in the echo area;
10619 wait a few seconds, then display our suggestion message. */
10620 if (NILP (echo_area_buffer[0]))
10621 waited = sit_for (make_number (0), 0, 2);
10622 else if (NUMBERP (Vsuggest_key_bindings))
10623 waited = sit_for (Vsuggest_key_bindings, 0, 2);
10624 else
10625 waited = sit_for (make_number (2), 0, 2);
10627 if (!NILP (waited) && ! CONSP (Vunread_command_events))
10629 Lisp_Object binding;
10630 char *newmessage;
10631 int message_p = push_message ();
10632 int count = SPECPDL_INDEX ();
10634 record_unwind_protect (pop_message_unwind, Qnil);
10635 binding = Fkey_description (bindings, Qnil);
10637 newmessage
10638 = (char *) alloca (SCHARS (SYMBOL_NAME (function))
10639 + SBYTES (binding)
10640 + 100);
10641 sprintf (newmessage, "You can run the command `%s' with %s",
10642 SDATA (SYMBOL_NAME (function)),
10643 SDATA (binding));
10644 message2_nolog (newmessage,
10645 strlen (newmessage),
10646 STRING_MULTIBYTE (binding));
10647 if (NUMBERP (Vsuggest_key_bindings))
10648 waited = sit_for (Vsuggest_key_bindings, 0, 2);
10649 else
10650 waited = sit_for (make_number (2), 0, 2);
10652 if (!NILP (waited) && message_p)
10653 restore_message ();
10655 unbind_to (count, Qnil);
10659 RETURN_UNGCPRO (value);
10663 /* Return nonzero if input events are pending. */
10666 detect_input_pending ()
10668 if (!input_pending)
10669 get_input_pending (&input_pending, 0);
10671 return input_pending;
10674 /* Return nonzero if input events other than mouse movements are
10675 pending. */
10678 detect_input_pending_ignore_squeezables ()
10680 if (!input_pending)
10681 get_input_pending (&input_pending, READABLE_EVENTS_IGNORE_SQUEEZABLES);
10683 return input_pending;
10686 /* Return nonzero if input events are pending, and run any pending timers. */
10689 detect_input_pending_run_timers (do_display)
10690 int do_display;
10692 int old_timers_run = timers_run;
10694 if (!input_pending)
10695 get_input_pending (&input_pending, READABLE_EVENTS_DO_TIMERS_NOW);
10697 if (old_timers_run != timers_run && do_display)
10699 redisplay_preserve_echo_area (8);
10700 /* The following fixes a bug when using lazy-lock with
10701 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10702 from an idle timer function. The symptom of the bug is that
10703 the cursor sometimes doesn't become visible until the next X
10704 event is processed. --gerd. */
10706 Lisp_Object tail, frame;
10707 FOR_EACH_FRAME (tail, frame)
10708 if (FRAME_RIF (XFRAME (frame)))
10709 FRAME_RIF (XFRAME (frame))->flush_display (XFRAME (frame));
10713 return input_pending;
10716 /* This is called in some cases before a possible quit.
10717 It cases the next call to detect_input_pending to recompute input_pending.
10718 So calling this function unnecessarily can't do any harm. */
10720 void
10721 clear_input_pending ()
10723 input_pending = 0;
10726 /* Return nonzero if there are pending requeued events.
10727 This isn't used yet. The hope is to make wait_reading_process_output
10728 call it, and return if it runs Lisp code that unreads something.
10729 The problem is, kbd_buffer_get_event needs to be fixed to know what
10730 to do in that case. It isn't trivial. */
10733 requeued_events_pending_p ()
10735 return (!NILP (Vunread_command_events) || unread_command_char != -1);
10739 DEFUN ("input-pending-p", Finput_pending_p, Sinput_pending_p, 0, 0, 0,
10740 doc: /* Return t if command input is currently available with no wait.
10741 Actually, the value is nil only if we can be sure that no input is available;
10742 if there is a doubt, the value is t. */)
10745 if (!NILP (Vunread_command_events) || unread_command_char != -1
10746 || !NILP (Vunread_post_input_method_events)
10747 || !NILP (Vunread_input_method_events))
10748 return (Qt);
10750 get_input_pending (&input_pending,
10751 READABLE_EVENTS_DO_TIMERS_NOW
10752 | READABLE_EVENTS_FILTER_EVENTS);
10753 return input_pending > 0 ? Qt : Qnil;
10756 DEFUN ("recent-keys", Frecent_keys, Srecent_keys, 0, 0, 0,
10757 doc: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10760 Lisp_Object *keys = XVECTOR (recent_keys)->contents;
10761 Lisp_Object val;
10763 if (total_keys < NUM_RECENT_KEYS)
10764 return Fvector (total_keys, keys);
10765 else
10767 val = Fvector (NUM_RECENT_KEYS, keys);
10768 bcopy (keys + recent_keys_index,
10769 XVECTOR (val)->contents,
10770 (NUM_RECENT_KEYS - recent_keys_index) * sizeof (Lisp_Object));
10771 bcopy (keys,
10772 XVECTOR (val)->contents + NUM_RECENT_KEYS - recent_keys_index,
10773 recent_keys_index * sizeof (Lisp_Object));
10774 return val;
10778 DEFUN ("this-command-keys", Fthis_command_keys, Sthis_command_keys, 0, 0, 0,
10779 doc: /* Return the key sequence that invoked this command.
10780 However, if the command has called `read-key-sequence', it returns
10781 the last key sequence that has been read.
10782 The value is a string or a vector.
10784 See also `this-command-keys-vector'. */)
10787 return make_event_array (this_command_key_count,
10788 XVECTOR (this_command_keys)->contents);
10791 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector, Sthis_command_keys_vector, 0, 0, 0,
10792 doc: /* Return the key sequence that invoked this command, as a vector.
10793 However, if the command has called `read-key-sequence', it returns
10794 the last key sequence that has been read.
10796 See also `this-command-keys'. */)
10799 return Fvector (this_command_key_count,
10800 XVECTOR (this_command_keys)->contents);
10803 DEFUN ("this-single-command-keys", Fthis_single_command_keys,
10804 Sthis_single_command_keys, 0, 0, 0,
10805 doc: /* Return the key sequence that invoked this command.
10806 More generally, it returns the last key sequence read, either by
10807 the command loop or by `read-key-sequence'.
10808 Unlike `this-command-keys', this function's value
10809 does not include prefix arguments.
10810 The value is always a vector. */)
10813 return Fvector (this_command_key_count
10814 - this_single_command_key_start,
10815 (XVECTOR (this_command_keys)->contents
10816 + this_single_command_key_start));
10819 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys,
10820 Sthis_single_command_raw_keys, 0, 0, 0,
10821 doc: /* Return the raw events that were read for this command.
10822 More generally, it returns the last key sequence read, either by
10823 the command loop or by `read-key-sequence'.
10824 Unlike `this-single-command-keys', this function's value
10825 shows the events before all translations (except for input methods).
10826 The value is always a vector. */)
10829 return Fvector (raw_keybuf_count,
10830 (XVECTOR (raw_keybuf)->contents));
10833 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths,
10834 Sreset_this_command_lengths, 0, 0, 0,
10835 doc: /* Make the unread events replace the last command and echo.
10836 Used in `universal-argument-other-key'.
10838 `universal-argument-other-key' rereads the event just typed.
10839 It then gets translated through `function-key-map'.
10840 The translated event has to replace the real events,
10841 both in the value of (this-command-keys) and in echoing.
10842 To achieve this, `universal-argument-other-key' calls
10843 `reset-this-command-lengths', which discards the record of reading
10844 these events the first time. */)
10847 this_command_key_count = before_command_key_count;
10848 if (this_command_key_count < this_single_command_key_start)
10849 this_single_command_key_start = this_command_key_count;
10851 echo_truncate (before_command_echo_length);
10853 /* Cause whatever we put into unread-command-events
10854 to echo as if it were being freshly read from the keyboard. */
10855 this_command_key_count_reset = 1;
10857 return Qnil;
10860 DEFUN ("clear-this-command-keys", Fclear_this_command_keys,
10861 Sclear_this_command_keys, 0, 1, 0,
10862 doc: /* Clear out the vector that `this-command-keys' returns.
10863 Also clear the record of the last 100 events, unless optional arg
10864 KEEP-RECORD is non-nil. */)
10865 (keep_record)
10866 Lisp_Object keep_record;
10868 int i;
10870 this_command_key_count = 0;
10871 this_command_key_count_reset = 0;
10873 if (NILP (keep_record))
10875 for (i = 0; i < XVECTOR (recent_keys)->size; ++i)
10876 XVECTOR (recent_keys)->contents[i] = Qnil;
10877 total_keys = 0;
10878 recent_keys_index = 0;
10880 return Qnil;
10883 DEFUN ("recursion-depth", Frecursion_depth, Srecursion_depth, 0, 0, 0,
10884 doc: /* Return the current depth in recursive edits. */)
10887 Lisp_Object temp;
10888 XSETFASTINT (temp, command_loop_level + minibuf_level);
10889 return temp;
10892 DEFUN ("open-dribble-file", Fopen_dribble_file, Sopen_dribble_file, 1, 1,
10893 "FOpen dribble file: ",
10894 doc: /* Start writing all keyboard characters to a dribble file called FILE.
10895 If FILE is nil, close any open dribble file. */)
10896 (file)
10897 Lisp_Object file;
10899 if (dribble)
10901 BLOCK_INPUT;
10902 fclose (dribble);
10903 UNBLOCK_INPUT;
10904 dribble = 0;
10906 if (!NILP (file))
10908 file = Fexpand_file_name (file, Qnil);
10909 dribble = fopen (SDATA (file), "w");
10910 if (dribble == 0)
10911 report_file_error ("Opening dribble", Fcons (file, Qnil));
10913 return Qnil;
10916 DEFUN ("discard-input", Fdiscard_input, Sdiscard_input, 0, 0, 0,
10917 doc: /* Discard the contents of the terminal input buffer.
10918 Also end any kbd macro being defined. */)
10921 if (!NILP (current_kboard->defining_kbd_macro))
10923 /* Discard the last command from the macro. */
10924 Fcancel_kbd_macro_events ();
10925 end_kbd_macro ();
10928 update_mode_lines++;
10930 Vunread_command_events = Qnil;
10931 unread_command_char = -1;
10933 discard_tty_input ();
10935 kbd_fetch_ptr = kbd_store_ptr;
10936 input_pending = 0;
10938 return Qnil;
10941 DEFUN ("suspend-emacs", Fsuspend_emacs, Ssuspend_emacs, 0, 1, "",
10942 doc: /* Stop Emacs and return to superior process. You can resume later.
10943 If `cannot-suspend' is non-nil, or if the system doesn't support job
10944 control, run a subshell instead.
10946 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10947 to be read as terminal input by Emacs's parent, after suspension.
10949 Before suspending, run the normal hook `suspend-hook'.
10950 After resumption run the normal hook `suspend-resume-hook'.
10952 Some operating systems cannot stop the Emacs process and resume it later.
10953 On such systems, Emacs starts a subshell instead of suspending. */)
10954 (stuffstring)
10955 Lisp_Object stuffstring;
10957 int count = SPECPDL_INDEX ();
10958 int old_height, old_width;
10959 int width, height;
10960 struct gcpro gcpro1;
10962 if (tty_list && tty_list->next)
10963 error ("There are other tty frames open; close them before suspending Emacs");
10965 if (!NILP (stuffstring))
10966 CHECK_STRING (stuffstring);
10968 /* Run the functions in suspend-hook. */
10969 if (!NILP (Vrun_hooks))
10970 call1 (Vrun_hooks, intern ("suspend-hook"));
10972 GCPRO1 (stuffstring);
10973 get_tty_size (fileno (CURTTY ()->input), &old_width, &old_height);
10974 reset_all_sys_modes ();
10975 /* sys_suspend can get an error if it tries to fork a subshell
10976 and the system resources aren't available for that. */
10977 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object))) init_all_sys_modes,
10978 Qnil);
10979 stuff_buffered_input (stuffstring);
10980 if (cannot_suspend)
10981 sys_subshell ();
10982 else
10983 sys_suspend ();
10984 unbind_to (count, Qnil);
10986 /* Check if terminal/window size has changed.
10987 Note that this is not useful when we are running directly
10988 with a window system; but suspend should be disabled in that case. */
10989 get_tty_size (fileno (CURTTY ()->input), &width, &height);
10990 if (width != old_width || height != old_height)
10991 change_frame_size (SELECTED_FRAME (), height, width, 0, 0, 0);
10993 /* Run suspend-resume-hook. */
10994 if (!NILP (Vrun_hooks))
10995 call1 (Vrun_hooks, intern ("suspend-resume-hook"));
10997 UNGCPRO;
10998 return Qnil;
11001 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
11002 Then in any case stuff anything Emacs has read ahead and not used. */
11004 void
11005 stuff_buffered_input (stuffstring)
11006 Lisp_Object stuffstring;
11008 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
11009 register unsigned char *p;
11011 if (STRINGP (stuffstring))
11013 register int count;
11015 p = SDATA (stuffstring);
11016 count = SBYTES (stuffstring);
11017 while (count-- > 0)
11018 stuff_char (*p++);
11019 stuff_char ('\n');
11022 /* Anything we have read ahead, put back for the shell to read. */
11023 /* ?? What should this do when we have multiple keyboards??
11024 Should we ignore anything that was typed in at the "wrong" kboard?
11026 rms: we should stuff everything back into the kboard
11027 it came from. */
11028 for (; kbd_fetch_ptr != kbd_store_ptr; kbd_fetch_ptr++)
11031 if (kbd_fetch_ptr == kbd_buffer + KBD_BUFFER_SIZE)
11032 kbd_fetch_ptr = kbd_buffer;
11033 if (kbd_fetch_ptr->kind == ASCII_KEYSTROKE_EVENT)
11034 stuff_char (kbd_fetch_ptr->code);
11036 clear_event (kbd_fetch_ptr);
11039 input_pending = 0;
11040 #endif /* SIGTSTP */
11043 void
11044 set_waiting_for_input (time_to_clear)
11045 EMACS_TIME *time_to_clear;
11047 input_available_clear_time = time_to_clear;
11049 /* Tell handle_interrupt to throw back to read_char, */
11050 waiting_for_input = 1;
11052 /* If handle_interrupt was called before and buffered a C-g,
11053 make it run again now, to avoid timing error. */
11054 if (!NILP (Vquit_flag))
11055 quit_throw_to_read_char ();
11058 void
11059 clear_waiting_for_input ()
11061 /* Tell handle_interrupt not to throw back to read_char, */
11062 waiting_for_input = 0;
11063 input_available_clear_time = 0;
11066 /* The SIGINT handler.
11068 If we have a frame on the controlling tty, we assume that the
11069 SIGINT was generated by C-g, so we call handle_interrupt.
11070 Otherwise, the handler kills Emacs. */
11072 static SIGTYPE
11073 interrupt_signal (signalnum) /* If we don't have an argument, */
11074 int signalnum; /* some compilers complain in signal calls. */
11076 /* Must preserve main program's value of errno. */
11077 int old_errno = errno;
11078 struct terminal *terminal;
11080 SIGNAL_THREAD_CHECK (signalnum);
11082 /* See if we have an active terminal on our controlling tty. */
11083 terminal = get_named_tty ("/dev/tty");
11084 if (!terminal)
11086 /* If there are no frames there, let's pretend that we are a
11087 well-behaving UN*X program and quit. */
11088 Fkill_emacs (Qnil);
11090 else
11092 /* Otherwise, the SIGINT was probably generated by C-g. */
11094 /* Set internal_last_event_frame to the top frame of the
11095 controlling tty, if we have a frame there. We disable the
11096 interrupt key on secondary ttys, so the SIGINT must have come
11097 from the controlling tty. */
11098 internal_last_event_frame = terminal->display_info.tty->top_frame;
11100 handle_interrupt ();
11103 errno = old_errno;
11106 /* This routine is called at interrupt level in response to C-g.
11108 It is called from the SIGINT handler or kbd_buffer_store_event.
11110 If `waiting_for_input' is non zero, then unless `echoing' is
11111 nonzero, immediately throw back to read_char.
11113 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
11114 eval to throw, when it gets a chance. If quit-flag is already
11115 non-nil, it stops the job right away. */
11117 static void
11118 handle_interrupt ()
11120 char c;
11122 cancel_echoing ();
11124 /* XXX This code needs to be revised for multi-tty support. */
11125 if (!NILP (Vquit_flag) && get_named_tty ("/dev/tty"))
11127 /* If SIGINT isn't blocked, don't let us be interrupted by
11128 another SIGINT, it might be harmful due to non-reentrancy
11129 in I/O functions. */
11130 sigblock (sigmask (SIGINT));
11132 fflush (stdout);
11133 reset_all_sys_modes ();
11135 #ifdef SIGTSTP /* Support possible in later USG versions */
11137 * On systems which can suspend the current process and return to the original
11138 * shell, this command causes the user to end up back at the shell.
11139 * The "Auto-save" and "Abort" questions are not asked until
11140 * the user elects to return to emacs, at which point he can save the current
11141 * job and either dump core or continue.
11143 sys_suspend ();
11144 #else
11145 /* Perhaps should really fork an inferior shell?
11146 But that would not provide any way to get back
11147 to the original shell, ever. */
11148 printf ("No support for stopping a process on this operating system;\n");
11149 printf ("you can continue or abort.\n");
11150 #endif /* not SIGTSTP */
11151 #ifdef MSDOS
11152 /* We must remain inside the screen area when the internal terminal
11153 is used. Note that [Enter] is not echoed by dos. */
11154 cursor_to (SELECTED_FRAME (), 0, 0);
11155 #endif
11156 /* It doesn't work to autosave while GC is in progress;
11157 the code used for auto-saving doesn't cope with the mark bit. */
11158 if (!gc_in_progress)
11160 printf ("Auto-save? (y or n) ");
11161 fflush (stdout);
11162 if (((c = getchar ()) & ~040) == 'Y')
11164 Fdo_auto_save (Qt, Qnil);
11165 #ifdef MSDOS
11166 printf ("\r\nAuto-save done");
11167 #else /* not MSDOS */
11168 printf ("Auto-save done\n");
11169 #endif /* not MSDOS */
11171 while (c != '\n') c = getchar ();
11173 else
11175 /* During GC, it must be safe to reenable quitting again. */
11176 Vinhibit_quit = Qnil;
11177 #ifdef MSDOS
11178 printf ("\r\n");
11179 #endif /* not MSDOS */
11180 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11181 printf ("but will instead do a real quit after garbage collection ends\r\n");
11182 fflush (stdout);
11185 #ifdef MSDOS
11186 printf ("\r\nAbort? (y or n) ");
11187 #else /* not MSDOS */
11188 printf ("Abort (and dump core)? (y or n) ");
11189 #endif /* not MSDOS */
11190 fflush (stdout);
11191 if (((c = getchar ()) & ~040) == 'Y')
11192 abort ();
11193 while (c != '\n') c = getchar ();
11194 #ifdef MSDOS
11195 printf ("\r\nContinuing...\r\n");
11196 #else /* not MSDOS */
11197 printf ("Continuing...\n");
11198 #endif /* not MSDOS */
11199 fflush (stdout);
11200 init_all_sys_modes ();
11201 sigfree ();
11203 else
11205 /* If executing a function that wants to be interrupted out of
11206 and the user has not deferred quitting by binding `inhibit-quit'
11207 then quit right away. */
11208 if (immediate_quit && NILP (Vinhibit_quit))
11210 struct gl_state_s saved;
11211 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
11213 immediate_quit = 0;
11214 sigfree ();
11215 saved = gl_state;
11216 GCPRO4 (saved.object, saved.global_code,
11217 saved.current_syntax_table, saved.old_prop);
11218 Fsignal (Qquit, Qnil);
11219 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
11220 gl_state = saved;
11221 UNGCPRO;
11223 else
11224 /* Else request quit when it's safe */
11225 Vquit_flag = Qt;
11228 /* TODO: The longjmp in this call throws the NS event loop integration off,
11229 and it seems to do fine without this. Probably some attention
11230 needs to be paid to the setting of waiting_for_input in
11231 wait_reading_process_output() under HAVE_NS because of the call
11232 to ns_select there (needed because otherwise events aren't picked up
11233 outside of polling since we don't get SIGIO like X and we don't have a
11234 separate event loop thread like W32. */
11235 #ifndef HAVE_NS
11236 if (waiting_for_input && !echoing)
11237 quit_throw_to_read_char ();
11238 #endif
11241 /* Handle a C-g by making read_char return C-g. */
11243 void
11244 quit_throw_to_read_char ()
11246 sigfree ();
11247 /* Prevent another signal from doing this before we finish. */
11248 clear_waiting_for_input ();
11249 input_pending = 0;
11251 Vunread_command_events = Qnil;
11252 unread_command_char = -1;
11254 #if 0 /* Currently, sit_for is called from read_char without turning
11255 off polling. And that can call set_waiting_for_input.
11256 It seems to be harmless. */
11257 #ifdef POLL_FOR_INPUT
11258 /* May be > 1 if in recursive minibuffer. */
11259 if (poll_suppress_count == 0)
11260 abort ();
11261 #endif
11262 #endif
11263 if (FRAMEP (internal_last_event_frame)
11264 && !EQ (internal_last_event_frame, selected_frame))
11265 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame),
11266 0, 0, Qnil);
11268 _longjmp (getcjmp, 1);
11271 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode, Sset_input_interrupt_mode, 1, 1, 0,
11272 doc: /* Set interrupt mode of reading keyboard input.
11273 If INTERRUPT is non-nil, Emacs will use input interrupts;
11274 otherwise Emacs uses CBREAK mode.
11276 See also `current-input-mode'. */)
11277 (interrupt)
11278 Lisp_Object interrupt;
11280 int new_interrupt_input;
11281 #ifdef SIGIO
11282 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11283 #ifdef HAVE_X_WINDOWS
11284 if (x_display_list != NULL)
11286 /* When using X, don't give the user a real choice,
11287 because we haven't implemented the mechanisms to support it. */
11288 new_interrupt_input = 1;
11290 else
11291 #endif /* HAVE_X_WINDOWS */
11292 new_interrupt_input = !NILP (interrupt);
11293 #else /* not SIGIO */
11294 new_interrupt_input = 0;
11295 #endif /* not SIGIO */
11297 if (new_interrupt_input != interrupt_input)
11299 #ifdef POLL_FOR_INPUT
11300 stop_polling ();
11301 #endif
11302 #ifndef DOS_NT
11303 /* this causes startup screen to be restored and messes with the mouse */
11304 reset_all_sys_modes ();
11305 #endif
11306 interrupt_input = new_interrupt_input;
11307 #ifndef DOS_NT
11308 init_all_sys_modes ();
11309 #endif
11311 #ifdef POLL_FOR_INPUT
11312 poll_suppress_count = 1;
11313 start_polling ();
11314 #endif
11316 return Qnil;
11319 DEFUN ("set-output-flow-control", Fset_output_flow_control, Sset_output_flow_control, 1, 2, 0,
11320 doc: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11321 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11322 C-q in key sequences.
11324 This setting only has an effect on tty terminals and only when
11325 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11327 See also `current-input-mode'. */)
11328 (flow, terminal)
11329 Lisp_Object flow, terminal;
11331 struct terminal *t = get_terminal (terminal, 1);
11332 struct tty_display_info *tty;
11333 if (t == NULL || (t->type != output_termcap && t->type != output_msdos_raw))
11334 return Qnil;
11335 tty = t->display_info.tty;
11337 if (tty->flow_control != !NILP (flow))
11339 #ifndef DOS_NT
11340 /* this causes startup screen to be restored and messes with the mouse */
11341 reset_sys_modes (tty);
11342 #endif
11344 tty->flow_control = !NILP (flow);
11346 #ifndef DOS_NT
11347 init_sys_modes (tty);
11348 #endif
11350 return Qnil;
11353 DEFUN ("set-input-meta-mode", Fset_input_meta_mode, Sset_input_meta_mode, 1, 2, 0,
11354 doc: /* Enable or disable 8-bit input on TERMINAL.
11355 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11356 bit as the Meta modifier.
11358 If META is nil, Emacs will ignore the top bit, on the assumption it is
11359 parity.
11361 Otherwise, Emacs will accept and pass through 8-bit input without
11362 specially interpreting the top bit.
11364 This setting only has an effect on tty terminal devices.
11366 Optional parameter TERMINAL specifies the tty terminal device to use.
11367 It may be a terminal object, a frame, or nil for the terminal used by
11368 the currently selected frame.
11370 See also `current-input-mode'. */)
11371 (meta, terminal)
11372 Lisp_Object meta, terminal;
11374 struct terminal *t = get_terminal (terminal, 1);
11375 struct tty_display_info *tty;
11376 int new_meta;
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 (meta))
11383 new_meta = 0;
11384 else if (EQ (meta, Qt))
11385 new_meta = 1;
11386 else
11387 new_meta = 2;
11389 if (tty->meta_key != new_meta)
11391 #ifndef DOS_NT
11392 /* this causes startup screen to be restored and messes with the mouse */
11393 reset_sys_modes (tty);
11394 #endif
11396 tty->meta_key = new_meta;
11398 #ifndef DOS_NT
11399 init_sys_modes (tty);
11400 #endif
11402 return Qnil;
11405 DEFUN ("set-quit-char", Fset_quit_char, Sset_quit_char, 1, 1, 0,
11406 doc: /* Specify character used for quitting.
11407 QUIT must be an ASCII character.
11409 This function only has an effect on the controlling tty of the Emacs
11410 process.
11412 See also `current-input-mode'. */)
11413 (quit)
11414 Lisp_Object quit;
11416 struct terminal *t = get_named_tty ("/dev/tty");
11417 struct tty_display_info *tty;
11418 if (t == NULL || (t->type != output_termcap && t->type != output_msdos_raw))
11419 return Qnil;
11420 tty = t->display_info.tty;
11422 if (NILP (quit) || !INTEGERP (quit) || XINT (quit) < 0 || XINT (quit) > 0400)
11423 error ("QUIT must be an ASCII character");
11425 #ifndef DOS_NT
11426 /* this causes startup screen to be restored and messes with the mouse */
11427 reset_sys_modes (tty);
11428 #endif
11430 /* Don't let this value be out of range. */
11431 quit_char = XINT (quit) & (tty->meta_key == 0 ? 0177 : 0377);
11433 #ifndef DOS_NT
11434 init_sys_modes (tty);
11435 #endif
11437 return Qnil;
11440 DEFUN ("set-input-mode", Fset_input_mode, Sset_input_mode, 3, 4, 0,
11441 doc: /* Set mode of reading keyboard input.
11442 First arg INTERRUPT non-nil means use input interrupts;
11443 nil means use CBREAK mode.
11444 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11445 (no effect except in CBREAK mode).
11446 Third arg META t means accept 8-bit input (for a Meta key).
11447 META nil means ignore the top bit, on the assumption it is parity.
11448 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11449 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11450 See also `current-input-mode'. */)
11451 (interrupt, flow, meta, quit)
11452 Lisp_Object interrupt, flow, meta, quit;
11454 Fset_input_interrupt_mode (interrupt);
11455 Fset_output_flow_control (flow, Qnil);
11456 Fset_input_meta_mode (meta, Qnil);
11457 if (!NILP (quit))
11458 Fset_quit_char (quit);
11459 return Qnil;
11462 DEFUN ("current-input-mode", Fcurrent_input_mode, Scurrent_input_mode, 0, 0, 0,
11463 doc: /* Return information about the way Emacs currently reads keyboard input.
11464 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11465 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11466 nil, Emacs is using CBREAK mode.
11467 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11468 terminal; this does not apply if Emacs uses interrupt-driven input.
11469 META is t if accepting 8-bit input with 8th bit as Meta flag.
11470 META nil means ignoring the top bit, on the assumption it is parity.
11471 META is neither t nor nil if accepting 8-bit input and using
11472 all 8 bits as the character code.
11473 QUIT is the character Emacs currently uses to quit.
11474 The elements of this list correspond to the arguments of
11475 `set-input-mode'. */)
11478 Lisp_Object val[4];
11479 struct frame *sf = XFRAME (selected_frame);
11481 val[0] = interrupt_input ? Qt : Qnil;
11482 if (FRAME_TERMCAP_P (sf) || FRAME_MSDOS_P (sf))
11484 val[1] = FRAME_TTY (sf)->flow_control ? Qt : Qnil;
11485 val[2] = (FRAME_TTY (sf)->meta_key == 2
11486 ? make_number (0)
11487 : (CURTTY ()->meta_key == 1 ? Qt : Qnil));
11489 else
11491 val[1] = Qnil;
11492 val[2] = Qt;
11494 XSETFASTINT (val[3], quit_char);
11496 return Flist (sizeof (val) / sizeof (val[0]), val);
11499 DEFUN ("posn-at-x-y", Fposn_at_x_y, Sposn_at_x_y, 2, 4, 0,
11500 doc: /* Return position information for pixel coordinates X and Y.
11501 By default, X and Y are relative to text area of the selected window.
11502 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11503 If optional fourth arg WHOLE is non-nil, X is relative to the left
11504 edge of the window.
11506 The return value is similar to a mouse click position:
11507 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11508 IMAGE (DX . DY) (WIDTH . HEIGHT))
11509 The `posn-' functions access elements of such lists. */)
11510 (x, y, frame_or_window, whole)
11511 Lisp_Object x, y, frame_or_window, whole;
11513 CHECK_NATNUM (x);
11514 CHECK_NATNUM (y);
11516 if (NILP (frame_or_window))
11517 frame_or_window = selected_window;
11519 if (WINDOWP (frame_or_window))
11521 struct window *w;
11523 CHECK_LIVE_WINDOW (frame_or_window);
11525 w = XWINDOW (frame_or_window);
11526 XSETINT (x, (XINT (x)
11527 + WINDOW_LEFT_EDGE_X (w)
11528 + (NILP (whole)
11529 ? window_box_left_offset (w, TEXT_AREA)
11530 : 0)));
11531 XSETINT (y, WINDOW_TO_FRAME_PIXEL_Y (w, XINT (y)));
11532 frame_or_window = w->frame;
11535 CHECK_LIVE_FRAME (frame_or_window);
11537 return make_lispy_position (XFRAME (frame_or_window), &x, &y, 0);
11540 DEFUN ("posn-at-point", Fposn_at_point, Sposn_at_point, 0, 2, 0,
11541 doc: /* Return position information for buffer POS in WINDOW.
11542 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11544 Return nil if position is not visible in window. Otherwise,
11545 the return value is similar to that returned by `event-start' for
11546 a mouse click at the upper left corner of the glyph corresponding
11547 to the given buffer position:
11548 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11549 IMAGE (DX . DY) (WIDTH . HEIGHT))
11550 The `posn-' functions access elements of such lists. */)
11551 (pos, window)
11552 Lisp_Object pos, window;
11554 Lisp_Object tem;
11556 if (NILP (window))
11557 window = selected_window;
11559 tem = Fpos_visible_in_window_p (pos, window, Qt);
11560 if (!NILP (tem))
11562 Lisp_Object x = XCAR (tem);
11563 Lisp_Object y = XCAR (XCDR (tem));
11565 /* Point invisible due to hscrolling? */
11566 if (XINT (x) < 0)
11567 return Qnil;
11568 tem = Fposn_at_x_y (x, y, window, Qnil);
11571 return tem;
11576 * Set up a new kboard object with reasonable initial values.
11578 void
11579 init_kboard (kb)
11580 KBOARD *kb;
11582 kb->Voverriding_terminal_local_map = Qnil;
11583 kb->Vlast_command = Qnil;
11584 kb->Vreal_last_command = Qnil;
11585 kb->Vkeyboard_translate_table = Qnil;
11586 kb->Vlast_repeatable_command = Qnil;
11587 kb->Vprefix_arg = Qnil;
11588 kb->Vlast_prefix_arg = Qnil;
11589 kb->kbd_queue = Qnil;
11590 kb->kbd_queue_has_data = 0;
11591 kb->immediate_echo = 0;
11592 kb->echo_string = Qnil;
11593 kb->echo_after_prompt = -1;
11594 kb->kbd_macro_buffer = 0;
11595 kb->kbd_macro_bufsize = 0;
11596 kb->defining_kbd_macro = Qnil;
11597 kb->Vlast_kbd_macro = Qnil;
11598 kb->reference_count = 0;
11599 kb->Vsystem_key_alist = Qnil;
11600 kb->system_key_syms = Qnil;
11601 kb->Vwindow_system = Qt; /* Unset. */
11602 kb->Vinput_decode_map = Fmake_sparse_keymap (Qnil);
11603 kb->Vlocal_function_key_map = Fmake_sparse_keymap (Qnil);
11604 Fset_keymap_parent (kb->Vlocal_function_key_map, Vfunction_key_map);
11605 kb->Vdefault_minibuffer_frame = Qnil;
11609 * Destroy the contents of a kboard object, but not the object itself.
11610 * We use this just before deleting it, or if we're going to initialize
11611 * it a second time.
11613 static void
11614 wipe_kboard (kb)
11615 KBOARD *kb;
11617 xfree (kb->kbd_macro_buffer);
11620 /* Free KB and memory referenced from it. */
11622 void
11623 delete_kboard (kb)
11624 KBOARD *kb;
11626 KBOARD **kbp;
11628 for (kbp = &all_kboards; *kbp != kb; kbp = &(*kbp)->next_kboard)
11629 if (*kbp == NULL)
11630 abort ();
11631 *kbp = kb->next_kboard;
11633 /* Prevent a dangling reference to KB. */
11634 if (kb == current_kboard
11635 && FRAMEP (selected_frame)
11636 && FRAME_LIVE_P (XFRAME (selected_frame)))
11638 current_kboard = FRAME_KBOARD (XFRAME (selected_frame));
11639 single_kboard = 0;
11640 if (current_kboard == kb)
11641 abort ();
11644 wipe_kboard (kb);
11645 xfree (kb);
11648 void
11649 init_keyboard ()
11651 /* This is correct before outermost invocation of the editor loop */
11652 command_loop_level = -1;
11653 immediate_quit = 0;
11654 quit_char = Ctl ('g');
11655 Vunread_command_events = Qnil;
11656 unread_command_char = -1;
11657 EMACS_SET_SECS_USECS (timer_idleness_start_time, -1, -1);
11658 total_keys = 0;
11659 recent_keys_index = 0;
11660 kbd_fetch_ptr = kbd_buffer;
11661 kbd_store_ptr = kbd_buffer;
11662 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11663 do_mouse_tracking = Qnil;
11664 #endif
11665 input_pending = 0;
11666 interrupt_input_blocked = 0;
11667 interrupt_input_pending = 0;
11668 #ifdef SYNC_INPUT
11669 pending_signals = 0;
11670 #endif
11672 /* This means that command_loop_1 won't try to select anything the first
11673 time through. */
11674 internal_last_event_frame = Qnil;
11675 Vlast_event_frame = internal_last_event_frame;
11677 current_kboard = initial_kboard;
11678 /* Re-initialize the keyboard again. */
11679 wipe_kboard (current_kboard);
11680 init_kboard (current_kboard);
11681 /* A value of nil for Vwindow_system normally means a tty, but we also use
11682 it for the initial terminal since there is no window system there. */
11683 current_kboard->Vwindow_system = Qnil;
11685 if (!noninteractive)
11687 /* Before multi-tty support, these handlers used to be installed
11688 only if the current session was a tty session. Now an Emacs
11689 session may have multiple display types, so we always handle
11690 SIGINT. There is special code in interrupt_signal to exit
11691 Emacs on SIGINT when there are no termcap frames on the
11692 controlling terminal. */
11693 signal (SIGINT, interrupt_signal);
11694 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11695 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11696 SIGQUIT and we can't tell which one it will give us. */
11697 signal (SIGQUIT, interrupt_signal);
11698 #endif /* HAVE_TERMIO */
11700 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11701 #ifdef SIGIO
11702 if (!noninteractive)
11703 signal (SIGIO, input_available_signal);
11704 #endif /* SIGIO */
11706 /* Use interrupt input by default, if it works and noninterrupt input
11707 has deficiencies. */
11709 #ifdef INTERRUPT_INPUT
11710 interrupt_input = 1;
11711 #else
11712 interrupt_input = 0;
11713 #endif
11715 sigfree ();
11716 dribble = 0;
11718 if (keyboard_init_hook)
11719 (*keyboard_init_hook) ();
11721 #ifdef POLL_FOR_INPUT
11722 poll_timer = NULL;
11723 poll_suppress_count = 1;
11724 start_polling ();
11725 #endif
11728 /* This type's only use is in syms_of_keyboard, to initialize the
11729 event header symbols and put properties on them. */
11730 struct event_head {
11731 Lisp_Object *var;
11732 char *name;
11733 Lisp_Object *kind;
11736 struct event_head head_table[] = {
11737 {&Qmouse_movement, "mouse-movement", &Qmouse_movement},
11738 {&Qscroll_bar_movement, "scroll-bar-movement", &Qmouse_movement},
11739 {&Qswitch_frame, "switch-frame", &Qswitch_frame},
11740 {&Qdelete_frame, "delete-frame", &Qdelete_frame},
11741 {&Qiconify_frame, "iconify-frame", &Qiconify_frame},
11742 {&Qmake_frame_visible, "make-frame-visible", &Qmake_frame_visible},
11743 /* `select-window' should be handled just like `switch-frame'
11744 in read_key_sequence. */
11745 {&Qselect_window, "select-window", &Qswitch_frame}
11748 void
11749 syms_of_keyboard ()
11751 pending_funcalls = Qnil;
11752 staticpro (&pending_funcalls);
11754 Vlispy_mouse_stem = make_pure_c_string ("mouse");
11755 staticpro (&Vlispy_mouse_stem);
11757 /* Tool-bars. */
11758 QCimage = intern_c_string (":image");
11759 staticpro (&QCimage);
11761 staticpro (&Qhelp_echo);
11762 Qhelp_echo = intern_c_string ("help-echo");
11764 staticpro (&Qrtl);
11765 Qrtl = intern_c_string (":rtl");
11767 staticpro (&item_properties);
11768 item_properties = Qnil;
11770 staticpro (&tool_bar_item_properties);
11771 tool_bar_item_properties = Qnil;
11772 staticpro (&tool_bar_items_vector);
11773 tool_bar_items_vector = Qnil;
11775 staticpro (&real_this_command);
11776 real_this_command = Qnil;
11778 Qtimer_event_handler = intern_c_string ("timer-event-handler");
11779 staticpro (&Qtimer_event_handler);
11781 Qdisabled_command_function = intern_c_string ("disabled-command-function");
11782 staticpro (&Qdisabled_command_function);
11784 Qself_insert_command = intern_c_string ("self-insert-command");
11785 staticpro (&Qself_insert_command);
11787 Qforward_char = intern_c_string ("forward-char");
11788 staticpro (&Qforward_char);
11790 Qbackward_char = intern_c_string ("backward-char");
11791 staticpro (&Qbackward_char);
11793 Qdisabled = intern_c_string ("disabled");
11794 staticpro (&Qdisabled);
11796 Qundefined = intern_c_string ("undefined");
11797 staticpro (&Qundefined);
11799 Qpre_command_hook = intern_c_string ("pre-command-hook");
11800 staticpro (&Qpre_command_hook);
11802 Qpost_command_hook = intern_c_string ("post-command-hook");
11803 staticpro (&Qpost_command_hook);
11805 Qdeferred_action_function = intern_c_string ("deferred-action-function");
11806 staticpro (&Qdeferred_action_function);
11808 Qcommand_hook_internal = intern_c_string ("command-hook-internal");
11809 staticpro (&Qcommand_hook_internal);
11811 Qfunction_key = intern_c_string ("function-key");
11812 staticpro (&Qfunction_key);
11813 Qmouse_click = intern_c_string ("mouse-click");
11814 staticpro (&Qmouse_click);
11815 #if defined (WINDOWSNT)
11816 Qlanguage_change = intern_c_string ("language-change");
11817 staticpro (&Qlanguage_change);
11818 #endif
11819 Qdrag_n_drop = intern_c_string ("drag-n-drop");
11820 staticpro (&Qdrag_n_drop);
11822 Qsave_session = intern_c_string ("save-session");
11823 staticpro (&Qsave_session);
11825 #ifdef HAVE_DBUS
11826 Qdbus_event = intern_c_string ("dbus-event");
11827 staticpro (&Qdbus_event);
11828 #endif
11830 Qconfig_changed_event = intern_c_string ("config-changed-event");
11831 staticpro (&Qconfig_changed_event);
11833 Qmenu_enable = intern_c_string ("menu-enable");
11834 staticpro (&Qmenu_enable);
11835 QCenable = intern_c_string (":enable");
11836 staticpro (&QCenable);
11837 QCvisible = intern_c_string (":visible");
11838 staticpro (&QCvisible);
11839 QChelp = intern_c_string (":help");
11840 staticpro (&QChelp);
11841 QCfilter = intern_c_string (":filter");
11842 staticpro (&QCfilter);
11843 QCbutton = intern_c_string (":button");
11844 staticpro (&QCbutton);
11845 QCkeys = intern_c_string (":keys");
11846 staticpro (&QCkeys);
11847 QCkey_sequence = intern_c_string (":key-sequence");
11848 staticpro (&QCkey_sequence);
11849 QCtoggle = intern_c_string (":toggle");
11850 staticpro (&QCtoggle);
11851 QCradio = intern_c_string (":radio");
11852 staticpro (&QCradio);
11854 Qmode_line = intern_c_string ("mode-line");
11855 staticpro (&Qmode_line);
11856 Qvertical_line = intern_c_string ("vertical-line");
11857 staticpro (&Qvertical_line);
11858 Qvertical_scroll_bar = intern_c_string ("vertical-scroll-bar");
11859 staticpro (&Qvertical_scroll_bar);
11860 Qmenu_bar = intern_c_string ("menu-bar");
11861 staticpro (&Qmenu_bar);
11863 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11864 Qmouse_fixup_help_message = intern_c_string ("mouse-fixup-help-message");
11865 staticpro (&Qmouse_fixup_help_message);
11866 #endif
11868 Qabove_handle = intern_c_string ("above-handle");
11869 staticpro (&Qabove_handle);
11870 Qhandle = intern_c_string ("handle");
11871 staticpro (&Qhandle);
11872 Qbelow_handle = intern_c_string ("below-handle");
11873 staticpro (&Qbelow_handle);
11874 Qup = intern_c_string ("up");
11875 staticpro (&Qup);
11876 Qdown = intern_c_string ("down");
11877 staticpro (&Qdown);
11878 Qtop = intern_c_string ("top");
11879 staticpro (&Qtop);
11880 Qbottom = intern_c_string ("bottom");
11881 staticpro (&Qbottom);
11882 Qend_scroll = intern_c_string ("end-scroll");
11883 staticpro (&Qend_scroll);
11884 Qratio = intern_c_string ("ratio");
11885 staticpro (&Qratio);
11887 Qevent_kind = intern_c_string ("event-kind");
11888 staticpro (&Qevent_kind);
11889 Qevent_symbol_elements = intern_c_string ("event-symbol-elements");
11890 staticpro (&Qevent_symbol_elements);
11891 Qevent_symbol_element_mask = intern_c_string ("event-symbol-element-mask");
11892 staticpro (&Qevent_symbol_element_mask);
11893 Qmodifier_cache = intern_c_string ("modifier-cache");
11894 staticpro (&Qmodifier_cache);
11896 Qrecompute_lucid_menubar = intern_c_string ("recompute-lucid-menubar");
11897 staticpro (&Qrecompute_lucid_menubar);
11898 Qactivate_menubar_hook = intern_c_string ("activate-menubar-hook");
11899 staticpro (&Qactivate_menubar_hook);
11901 Qpolling_period = intern_c_string ("polling-period");
11902 staticpro (&Qpolling_period);
11904 Qinput_method_function = intern_c_string ("input-method-function");
11905 staticpro (&Qinput_method_function);
11907 Qinput_method_exit_on_first_char = intern_c_string ("input-method-exit-on-first-char");
11908 staticpro (&Qinput_method_exit_on_first_char);
11909 Qinput_method_use_echo_area = intern_c_string ("input-method-use-echo-area");
11910 staticpro (&Qinput_method_use_echo_area);
11912 Fset (Qinput_method_exit_on_first_char, Qnil);
11913 Fset (Qinput_method_use_echo_area, Qnil);
11915 last_point_position_buffer = Qnil;
11916 last_point_position_window = Qnil;
11919 struct event_head *p;
11921 for (p = head_table;
11922 p < head_table + (sizeof (head_table) / sizeof (head_table[0]));
11923 p++)
11925 *p->var = intern_c_string (p->name);
11926 staticpro (p->var);
11927 Fput (*p->var, Qevent_kind, *p->kind);
11928 Fput (*p->var, Qevent_symbol_elements, Fcons (*p->var, Qnil));
11932 button_down_location = Fmake_vector (make_number (5), Qnil);
11933 staticpro (&button_down_location);
11934 mouse_syms = Fmake_vector (make_number (5), Qnil);
11935 staticpro (&mouse_syms);
11936 wheel_syms = Fmake_vector (make_number (sizeof (lispy_wheel_names)
11937 / sizeof (lispy_wheel_names[0])),
11938 Qnil);
11939 staticpro (&wheel_syms);
11942 int i;
11943 int len = sizeof (modifier_names) / sizeof (modifier_names[0]);
11945 modifier_symbols = Fmake_vector (make_number (len), Qnil);
11946 for (i = 0; i < len; i++)
11947 if (modifier_names[i])
11948 XVECTOR (modifier_symbols)->contents[i] = intern_c_string (modifier_names[i]);
11949 staticpro (&modifier_symbols);
11952 recent_keys = Fmake_vector (make_number (NUM_RECENT_KEYS), Qnil);
11953 staticpro (&recent_keys);
11955 this_command_keys = Fmake_vector (make_number (40), Qnil);
11956 staticpro (&this_command_keys);
11958 raw_keybuf = Fmake_vector (make_number (30), Qnil);
11959 staticpro (&raw_keybuf);
11961 Qextended_command_history = intern_c_string ("extended-command-history");
11962 Fset (Qextended_command_history, Qnil);
11963 staticpro (&Qextended_command_history);
11965 accent_key_syms = Qnil;
11966 staticpro (&accent_key_syms);
11968 func_key_syms = Qnil;
11969 staticpro (&func_key_syms);
11971 drag_n_drop_syms = Qnil;
11972 staticpro (&drag_n_drop_syms);
11974 unread_switch_frame = Qnil;
11975 staticpro (&unread_switch_frame);
11977 internal_last_event_frame = Qnil;
11978 staticpro (&internal_last_event_frame);
11980 read_key_sequence_cmd = Qnil;
11981 staticpro (&read_key_sequence_cmd);
11983 menu_bar_one_keymap_changed_items = Qnil;
11984 staticpro (&menu_bar_one_keymap_changed_items);
11986 menu_bar_items_vector = Qnil;
11987 staticpro (&menu_bar_items_vector);
11989 help_form_saved_window_configs = Qnil;
11990 staticpro (&help_form_saved_window_configs);
11992 defsubr (&Scurrent_idle_time);
11993 defsubr (&Sevent_symbol_parse_modifiers);
11994 defsubr (&Sevent_convert_list);
11995 defsubr (&Sread_key_sequence);
11996 defsubr (&Sread_key_sequence_vector);
11997 defsubr (&Srecursive_edit);
11998 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11999 defsubr (&Strack_mouse);
12000 #endif
12001 defsubr (&Sinput_pending_p);
12002 defsubr (&Scommand_execute);
12003 defsubr (&Srecent_keys);
12004 defsubr (&Sthis_command_keys);
12005 defsubr (&Sthis_command_keys_vector);
12006 defsubr (&Sthis_single_command_keys);
12007 defsubr (&Sthis_single_command_raw_keys);
12008 defsubr (&Sreset_this_command_lengths);
12009 defsubr (&Sclear_this_command_keys);
12010 defsubr (&Ssuspend_emacs);
12011 defsubr (&Sabort_recursive_edit);
12012 defsubr (&Sexit_recursive_edit);
12013 defsubr (&Srecursion_depth);
12014 defsubr (&Stop_level);
12015 defsubr (&Sdiscard_input);
12016 defsubr (&Sopen_dribble_file);
12017 defsubr (&Sset_input_interrupt_mode);
12018 defsubr (&Sset_output_flow_control);
12019 defsubr (&Sset_input_meta_mode);
12020 defsubr (&Sset_quit_char);
12021 defsubr (&Sset_input_mode);
12022 defsubr (&Scurrent_input_mode);
12023 defsubr (&Sexecute_extended_command);
12024 defsubr (&Sposn_at_point);
12025 defsubr (&Sposn_at_x_y);
12027 DEFVAR_LISP ("last-command-event", &last_command_event,
12028 doc: /* Last input event that was part of a command. */);
12030 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event,
12031 doc: /* Last input event in a command, except for mouse menu events.
12032 Mouse menus give back keys that don't look like mouse events;
12033 this variable holds the actual mouse event that led to the menu,
12034 so that you can determine whether the command was run by mouse or not. */);
12036 DEFVAR_LISP ("last-input-event", &last_input_event,
12037 doc: /* Last input event. */);
12039 DEFVAR_LISP ("unread-command-events", &Vunread_command_events,
12040 doc: /* List of events to be read as the command input.
12041 These events are processed first, before actual keyboard input.
12042 Events read from this list are not normally added to `this-command-keys',
12043 as they will already have been added once as they were read for the first time.
12044 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
12045 Vunread_command_events = Qnil;
12047 DEFVAR_INT ("unread-command-char", &unread_command_char,
12048 doc: /* If not -1, an object to be read as next command input event. */);
12050 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events,
12051 doc: /* List of events to be processed as input by input methods.
12052 These events are processed before `unread-command-events'
12053 and actual keyboard input, but are not given to `input-method-function'. */);
12054 Vunread_post_input_method_events = Qnil;
12056 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events,
12057 doc: /* List of events to be processed as input by input methods.
12058 These events are processed after `unread-command-events', but
12059 before actual keyboard input.
12060 If there's an active input method, the events are given to
12061 `input-method-function'. */);
12062 Vunread_input_method_events = Qnil;
12064 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char,
12065 doc: /* Meta-prefix character code.
12066 Meta-foo as command input turns into this character followed by foo. */);
12067 XSETINT (meta_prefix_char, 033);
12069 DEFVAR_KBOARD ("last-command", Vlast_command,
12070 doc: /* The last command executed.
12071 Normally a symbol with a function definition, but can be whatever was found
12072 in the keymap, or whatever the variable `this-command' was set to by that
12073 command.
12075 The value `mode-exit' is special; it means that the previous command
12076 read an event that told it to exit, and it did so and unread that event.
12077 In other words, the present command is the event that made the previous
12078 command exit.
12080 The value `kill-region' is special; it means that the previous command
12081 was a kill command.
12083 `last-command' has a separate binding for each terminal device.
12084 See Info node `(elisp)Multiple displays'. */);
12086 DEFVAR_KBOARD ("real-last-command", Vreal_last_command,
12087 doc: /* Same as `last-command', but never altered by Lisp code. */);
12089 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command,
12090 doc: /* Last command that may be repeated.
12091 The last command executed that was not bound to an input event.
12092 This is the command `repeat' will try to repeat. */);
12094 DEFVAR_LISP ("this-command", &Vthis_command,
12095 doc: /* The command now being executed.
12096 The command can set this variable; whatever is put here
12097 will be in `last-command' during the following command. */);
12098 Vthis_command = Qnil;
12100 DEFVAR_LISP ("this-command-keys-shift-translated",
12101 &Vthis_command_keys_shift_translated,
12102 doc: /* Non-nil if the key sequence activating this command was shift-translated.
12103 Shift-translation occurs when there is no binding for the key sequence
12104 as entered, but a binding was found by changing an upper-case letter
12105 to lower-case, or a shifted function key to an unshifted one. */);
12106 Vthis_command_keys_shift_translated = Qnil;
12108 DEFVAR_LISP ("this-original-command", &Vthis_original_command,
12109 doc: /* The command bound to the current key sequence before remapping.
12110 It equals `this-command' if the original command was not remapped through
12111 any of the active keymaps. Otherwise, the value of `this-command' is the
12112 result of looking up the original command in the active keymaps. */);
12113 Vthis_original_command = Qnil;
12115 DEFVAR_INT ("auto-save-interval", &auto_save_interval,
12116 doc: /* *Number of input events between auto-saves.
12117 Zero means disable autosaving due to number of characters typed. */);
12118 auto_save_interval = 300;
12120 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout,
12121 doc: /* *Number of seconds idle time before auto-save.
12122 Zero or nil means disable auto-saving due to idleness.
12123 After auto-saving due to this many seconds of idle time,
12124 Emacs also does a garbage collection if that seems to be warranted. */);
12125 XSETFASTINT (Vauto_save_timeout, 30);
12127 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes,
12128 doc: /* *Nonzero means echo unfinished commands after this many seconds of pause.
12129 The value may be integer or floating point. */);
12130 Vecho_keystrokes = make_number (1);
12132 DEFVAR_INT ("polling-period", &polling_period,
12133 doc: /* *Interval between polling for input during Lisp execution.
12134 The reason for polling is to make C-g work to stop a running program.
12135 Polling is needed only when using X windows and SIGIO does not work.
12136 Polling is automatically disabled in all other cases. */);
12137 polling_period = 2;
12139 DEFVAR_LISP ("double-click-time", &Vdouble_click_time,
12140 doc: /* *Maximum time between mouse clicks to make a double-click.
12141 Measured in milliseconds. The value nil means disable double-click
12142 recognition; t means double-clicks have no time limit and are detected
12143 by position only. */);
12144 Vdouble_click_time = make_number (500);
12146 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz,
12147 doc: /* *Maximum mouse movement between clicks to make a double-click.
12148 On window-system frames, value is the number of pixels the mouse may have
12149 moved horizontally or vertically between two clicks to make a double-click.
12150 On non window-system frames, value is interpreted in units of 1/8 characters
12151 instead of pixels.
12153 This variable is also the threshold for motion of the mouse
12154 to count as a drag. */);
12155 double_click_fuzz = 3;
12157 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus,
12158 doc: /* *Non-nil means inhibit local map menu bar menus. */);
12159 inhibit_local_menu_bar_menus = 0;
12161 DEFVAR_INT ("num-input-keys", &num_input_keys,
12162 doc: /* Number of complete key sequences read as input so far.
12163 This includes key sequences read from keyboard macros.
12164 The number is effectively the number of interactive command invocations. */);
12165 num_input_keys = 0;
12167 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events,
12168 doc: /* Number of input events read from the keyboard so far.
12169 This does not include events generated by keyboard macros. */);
12170 num_nonmacro_input_events = 0;
12172 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame,
12173 doc: /* The frame in which the most recently read event occurred.
12174 If the last event came from a keyboard macro, this is set to `macro'. */);
12175 Vlast_event_frame = Qnil;
12177 /* This variable is set up in sysdep.c. */
12178 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char,
12179 doc: /* The ERASE character as set by the user with stty. */);
12181 DEFVAR_LISP ("help-char", &Vhelp_char,
12182 doc: /* Character to recognize as meaning Help.
12183 When it is read, do `(eval help-form)', and display result if it's a string.
12184 If the value of `help-form' is nil, this char can be read normally. */);
12185 XSETINT (Vhelp_char, Ctl ('H'));
12187 DEFVAR_LISP ("help-event-list", &Vhelp_event_list,
12188 doc: /* List of input events to recognize as meaning Help.
12189 These work just like the value of `help-char' (see that). */);
12190 Vhelp_event_list = Qnil;
12192 DEFVAR_LISP ("help-form", &Vhelp_form,
12193 doc: /* Form to execute when character `help-char' is read.
12194 If the form returns a string, that string is displayed.
12195 If `help-form' is nil, the help char is not recognized. */);
12196 Vhelp_form = Qnil;
12198 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command,
12199 doc: /* Command to run when `help-char' character follows a prefix key.
12200 This command is used only when there is no actual binding
12201 for that character after that prefix key. */);
12202 Vprefix_help_command = Qnil;
12204 DEFVAR_LISP ("top-level", &Vtop_level,
12205 doc: /* Form to evaluate when Emacs starts up.
12206 Useful to set before you dump a modified Emacs. */);
12207 Vtop_level = Qnil;
12209 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table,
12210 doc: /* Translate table for local keyboard input, or nil.
12211 If non-nil, the value should be a char-table. Each character read
12212 from the keyboard is looked up in this char-table. If the value found
12213 there is non-nil, then it is used instead of the actual input character.
12215 The value can also be a string or vector, but this is considered obsolete.
12216 If it is a string or vector of length N, character codes N and up are left
12217 untranslated. In a vector, an element which is nil means "no translation".
12219 This is applied to the characters supplied to input methods, not their
12220 output. See also `translation-table-for-input'.
12222 This variable has a separate binding for each terminal. See Info node
12223 `(elisp)Multiple displays'. */);
12225 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend,
12226 doc: /* Non-nil means to always spawn a subshell instead of suspending.
12227 \(Even if the operating system has support for stopping a process.\) */);
12228 cannot_suspend = 0;
12230 DEFVAR_BOOL ("menu-prompting", &menu_prompting,
12231 doc: /* Non-nil means prompt with menus when appropriate.
12232 This is done when reading from a keymap that has a prompt string,
12233 for elements that have prompt strings.
12234 The menu is displayed on the screen
12235 if X menus were enabled at configuration
12236 time and the previous event was a mouse click prefix key.
12237 Otherwise, menu prompting uses the echo area. */);
12238 menu_prompting = 1;
12240 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char,
12241 doc: /* Character to see next line of menu prompt.
12242 Type this character while in a menu prompt to rotate around the lines of it. */);
12243 XSETINT (menu_prompt_more_char, ' ');
12245 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers,
12246 doc: /* A mask of additional modifier keys to use with every keyboard character.
12247 Emacs applies the modifiers of the character stored here to each keyboard
12248 character it reads. For example, after evaluating the expression
12249 (setq extra-keyboard-modifiers ?\\C-x)
12250 all input characters will have the control modifier applied to them.
12252 Note that the character ?\\C-@, equivalent to the integer zero, does
12253 not count as a control character; rather, it counts as a character
12254 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12255 cancels any modification. */);
12256 extra_keyboard_modifiers = 0;
12258 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark,
12259 doc: /* If an editing command sets this to t, deactivate the mark afterward.
12260 The command loop sets this to nil before each command,
12261 and tests the value when the command returns.
12262 Buffer modification stores t in this variable. */);
12263 Vdeactivate_mark = Qnil;
12264 Qdeactivate_mark = intern_c_string ("deactivate-mark");
12265 staticpro (&Qdeactivate_mark);
12267 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal,
12268 doc: /* Temporary storage of `pre-command-hook' or `post-command-hook'. */);
12269 Vcommand_hook_internal = Qnil;
12271 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook,
12272 doc: /* Normal hook run before each command is executed.
12273 If an unhandled error happens in running this hook,
12274 the hook value is set to nil, since otherwise the error
12275 might happen repeatedly and make Emacs nonfunctional. */);
12276 Vpre_command_hook = Qnil;
12278 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook,
12279 doc: /* Normal hook run after each command is executed.
12280 If an unhandled error happens in running this hook,
12281 the hook value is set to nil, since otherwise the error
12282 might happen repeatedly and make Emacs nonfunctional. */);
12283 Vpost_command_hook = Qnil;
12285 #if 0
12286 DEFVAR_LISP ("echo-area-clear-hook", ...,
12287 doc: /* Normal hook run when clearing the echo area. */);
12288 #endif
12289 Qecho_area_clear_hook = intern_c_string ("echo-area-clear-hook");
12290 staticpro (&Qecho_area_clear_hook);
12291 Fset (Qecho_area_clear_hook, Qnil);
12293 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag,
12294 doc: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12295 Vlucid_menu_bar_dirty_flag = Qnil;
12297 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items,
12298 doc: /* List of menu bar items to move to the end of the menu bar.
12299 The elements of the list are event types that may have menu bar bindings. */);
12300 Vmenu_bar_final_items = Qnil;
12302 DEFVAR_KBOARD ("overriding-terminal-local-map",
12303 Voverriding_terminal_local_map,
12304 doc: /* Per-terminal keymap that overrides all other local keymaps.
12305 If this variable is non-nil, it is used as a keymap instead of the
12306 buffer's local map, and the minor mode keymaps and text property keymaps.
12307 It also replaces `overriding-local-map'.
12309 This variable is intended to let commands such as `universal-argument'
12310 set up a different keymap for reading the next command.
12312 `overriding-terminal-local-map' has a separate binding for each
12313 terminal device.
12314 See Info node `(elisp)Multiple displays'. */);
12316 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map,
12317 doc: /* Keymap that overrides all other local keymaps.
12318 If this variable is non-nil, it is used as a keymap--replacing the
12319 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12320 Voverriding_local_map = Qnil;
12322 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag,
12323 doc: /* Non-nil means `overriding-local-map' applies to the menu bar.
12324 Otherwise, the menu bar continues to reflect the buffer's local map
12325 and the minor mode maps regardless of `overriding-local-map'. */);
12326 Voverriding_local_map_menu_flag = Qnil;
12328 DEFVAR_LISP ("special-event-map", &Vspecial_event_map,
12329 doc: /* Keymap defining bindings for special events to execute at low level. */);
12330 Vspecial_event_map = Fcons (intern_c_string ("keymap"), Qnil);
12332 DEFVAR_LISP ("track-mouse", &do_mouse_tracking,
12333 doc: /* *Non-nil means generate motion events for mouse motion. */);
12335 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist,
12336 doc: /* Alist of system-specific X windows key symbols.
12337 Each element should have the form (N . SYMBOL) where N is the
12338 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12339 and SYMBOL is its name.
12341 `system-key-alist' has a separate binding for each terminal device.
12342 See Info node `(elisp)Multiple displays'. */);
12344 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map,
12345 doc: /* Keymap that translates key sequences to key sequences during input.
12346 This is used mainly for mapping key sequences into some preferred
12347 key events (symbols).
12349 The `read-key-sequence' function replaces any subsequence bound by
12350 `local-function-key-map' with its binding. More precisely, when the
12351 active keymaps have no binding for the current key sequence but
12352 `local-function-key-map' binds a suffix of the sequence to a vector or
12353 string, `read-key-sequence' replaces the matching suffix with its
12354 binding, and continues with the new sequence.
12356 If the binding is a function, it is called with one argument (the prompt)
12357 and its return value (a key sequence) is used.
12359 The events that come from bindings in `local-function-key-map' are not
12360 themselves looked up in `local-function-key-map'.
12362 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12363 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12364 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12365 typing `ESC O P x' would return [f1 x].
12367 `local-function-key-map' has a separate binding for each terminal
12368 device. See Info node `(elisp)Multiple displays'. If you need to
12369 define a binding on all terminals, change `function-key-map'
12370 instead. Initially, `local-function-key-map' is an empty keymap that
12371 has `function-key-map' as its parent on all terminal devices. */);
12373 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map,
12374 doc: /* Keymap that decodes input escape sequences.
12375 This is used mainly for mapping ASCII function key sequences into
12376 real Emacs function key events (symbols).
12378 The `read-key-sequence' function replaces any subsequence bound by
12379 `input-decode-map' with its binding. Contrary to `function-key-map',
12380 this map applies its rebinding regardless of the presence of an ordinary
12381 binding. So it is more like `key-translation-map' except that it applies
12382 before `function-key-map' rather than after.
12384 If the binding is a function, it is called with one argument (the prompt)
12385 and its return value (a key sequence) is used.
12387 The events that come from bindings in `input-decode-map' are not
12388 themselves looked up in `input-decode-map'.
12390 This variable is keyboard-local. */);
12392 DEFVAR_LISP ("function-key-map", &Vfunction_key_map,
12393 doc: /* The parent keymap of all `local-function-key-map' instances.
12394 Function key definitions that apply to all terminal devices should go
12395 here. If a mapping is defined in both the current
12396 `local-function-key-map' binding and this variable, then the local
12397 definition will take precendence. */);
12398 Vfunction_key_map = Fmake_sparse_keymap (Qnil);
12400 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map,
12401 doc: /* Keymap of key translations that can override keymaps.
12402 This keymap works like `function-key-map', but comes after that,
12403 and its non-prefix bindings override ordinary bindings.
12404 Another difference is that it is global rather than keyboard-local. */);
12405 Vkey_translation_map = Fmake_sparse_keymap (Qnil);
12407 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list,
12408 doc: /* List of deferred actions to be performed at a later time.
12409 The precise format isn't relevant here; we just check whether it is nil. */);
12410 Vdeferred_action_list = Qnil;
12412 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function,
12413 doc: /* Function to call to handle deferred actions, after each command.
12414 This function is called with no arguments after each command
12415 whenever `deferred-action-list' is non-nil. */);
12416 Vdeferred_action_function = Qnil;
12418 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings,
12419 doc: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12420 The value can be a length of time to show the message for.
12421 If the value is non-nil and not a number, we wait 2 seconds. */);
12422 Vsuggest_key_bindings = Qt;
12424 DEFVAR_LISP ("timer-list", &Vtimer_list,
12425 doc: /* List of active absolute time timers in order of increasing time. */);
12426 Vtimer_list = Qnil;
12428 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list,
12429 doc: /* List of active idle-time timers in order of increasing time. */);
12430 Vtimer_idle_list = Qnil;
12432 DEFVAR_LISP ("input-method-function", &Vinput_method_function,
12433 doc: /* If non-nil, the function that implements the current input method.
12434 It's called with one argument, a printing character that was just read.
12435 \(That means a character with code 040...0176.)
12436 Typically this function uses `read-event' to read additional events.
12437 When it does so, it should first bind `input-method-function' to nil
12438 so it will not be called recursively.
12440 The function should return a list of zero or more events
12441 to be used as input. If it wants to put back some events
12442 to be reconsidered, separately, by the input method,
12443 it can add them to the beginning of `unread-command-events'.
12445 The input method function can find in `input-method-previous-message'
12446 the previous echo area message.
12448 The input method function should refer to the variables
12449 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12450 for guidance on what to do. */);
12451 Vinput_method_function = Qnil;
12453 DEFVAR_LISP ("input-method-previous-message",
12454 &Vinput_method_previous_message,
12455 doc: /* When `input-method-function' is called, hold the previous echo area message.
12456 This variable exists because `read-event' clears the echo area
12457 before running the input method. It is nil if there was no message. */);
12458 Vinput_method_previous_message = Qnil;
12460 DEFVAR_LISP ("show-help-function", &Vshow_help_function,
12461 doc: /* If non-nil, the function that implements the display of help.
12462 It's called with one argument, the help string to display. */);
12463 Vshow_help_function = Qnil;
12465 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment,
12466 doc: /* If non-nil, suppress point adjustment after executing a command.
12468 After a command is executed, if point is moved into a region that has
12469 special properties (e.g. composition, display), we adjust point to
12470 the boundary of the region. But, when a command sets this variable to
12471 non-nil, we suppress the point adjustment.
12473 This variable is set to nil before reading a command, and is checked
12474 just after executing the command. */);
12475 Vdisable_point_adjustment = Qnil;
12477 DEFVAR_LISP ("global-disable-point-adjustment",
12478 &Vglobal_disable_point_adjustment,
12479 doc: /* *If non-nil, always suppress point adjustment.
12481 The default value is nil, in which case, point adjustment are
12482 suppressed only after special commands that set
12483 `disable-point-adjustment' (which see) to non-nil. */);
12484 Vglobal_disable_point_adjustment = Qnil;
12486 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout,
12487 doc: /* *How long to display an echo-area message when the minibuffer is active.
12488 If the value is not a number, such messages don't time out. */);
12489 Vminibuffer_message_timeout = make_number (2);
12491 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input,
12492 doc: /* If non-nil, any keyboard input throws to this symbol.
12493 The value of that variable is passed to `quit-flag' and later causes a
12494 peculiar kind of quitting. */);
12495 Vthrow_on_input = Qnil;
12497 DEFVAR_LISP ("command-error-function", &Vcommand_error_function,
12498 doc: /* If non-nil, function to output error messages.
12499 The arguments are the error data, a list of the form
12500 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12501 such as just as `condition-case' would bind its variable to,
12502 the context (a string which normally goes at the start of the message),
12503 and the Lisp function within which the error was signaled. */);
12504 Vcommand_error_function = Qnil;
12506 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12507 &Venable_disabled_menus_and_buttons,
12508 doc: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12510 Help functions bind this to allow help on disabled menu items
12511 and tool-bar buttons. */);
12512 Venable_disabled_menus_and_buttons = Qnil;
12514 /* Create the initial keyboard. */
12515 initial_kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
12516 init_kboard (initial_kboard);
12517 /* Vwindow_system is left at t for now. */
12518 initial_kboard->next_kboard = all_kboards;
12519 all_kboards = initial_kboard;
12522 void
12523 keys_of_keyboard ()
12525 initial_define_key (global_map, Ctl ('Z'), "suspend-emacs");
12526 initial_define_key (control_x_map, Ctl ('Z'), "suspend-emacs");
12527 initial_define_key (meta_map, Ctl ('C'), "exit-recursive-edit");
12528 initial_define_key (global_map, Ctl (']'), "abort-recursive-edit");
12529 initial_define_key (meta_map, 'x', "execute-extended-command");
12531 initial_define_lispy_key (Vspecial_event_map, "delete-frame",
12532 "handle-delete-frame");
12533 initial_define_lispy_key (Vspecial_event_map, "ns-put-working-text",
12534 "ns-put-working-text");
12535 initial_define_lispy_key (Vspecial_event_map, "ns-unput-working-text",
12536 "ns-unput-working-text");
12537 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12538 current-prefix-arg, as is done in `handle-switch-frame'.
12539 But `handle-switch-frame is not run from the special-map.
12540 Commands from that map are run in a special way that automatically
12541 preserves the prefix-arg. Restoring the prefix arg here is not just
12542 redundant but harmful:
12543 - C-u C-x v =
12544 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12545 - after the first prompt, the exit-minibuffer-hook is run which may
12546 iconify a frame and thus push a `iconify-frame' event.
12547 - after running exit-minibuffer-hook, current-prefix-arg is
12548 restored to the non-nil value it had before the prompt.
12549 - we enter the second prompt.
12550 current-prefix-arg is non-nil, prefix-arg is nil.
12551 - before running the first real event, we run the special iconify-frame
12552 event, but we pass the `special' arg to execute-command so
12553 current-prefix-arg and prefix-arg are left untouched.
12554 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12555 - the next key event will have a spuriously non-nil current-prefix-arg. */
12556 initial_define_lispy_key (Vspecial_event_map, "iconify-frame",
12557 "ignore");
12558 initial_define_lispy_key (Vspecial_event_map, "make-frame-visible",
12559 "ignore");
12560 /* Handling it at such a low-level causes read_key_sequence to get
12561 * confused because it doesn't realize that the current_buffer was
12562 * changed by read_char.
12564 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12565 * "handle-select-window"); */
12566 initial_define_lispy_key (Vspecial_event_map, "save-session",
12567 "handle-save-session");
12569 #ifdef HAVE_DBUS
12570 /* Define a special event which is raised for dbus callback
12571 functions. */
12572 initial_define_lispy_key (Vspecial_event_map, "dbus-event",
12573 "dbus-handle-event");
12574 #endif
12576 initial_define_lispy_key (Vspecial_event_map, "config-changed-event",
12577 "ignore");
12580 /* Mark the pointers in the kboard objects.
12581 Called by the Fgarbage_collector. */
12582 void
12583 mark_kboards ()
12585 KBOARD *kb;
12586 Lisp_Object *p;
12587 for (kb = all_kboards; kb; kb = kb->next_kboard)
12589 if (kb->kbd_macro_buffer)
12590 for (p = kb->kbd_macro_buffer; p < kb->kbd_macro_ptr; p++)
12591 mark_object (*p);
12592 mark_object (kb->Voverriding_terminal_local_map);
12593 mark_object (kb->Vlast_command);
12594 mark_object (kb->Vreal_last_command);
12595 mark_object (kb->Vkeyboard_translate_table);
12596 mark_object (kb->Vlast_repeatable_command);
12597 mark_object (kb->Vprefix_arg);
12598 mark_object (kb->Vlast_prefix_arg);
12599 mark_object (kb->kbd_queue);
12600 mark_object (kb->defining_kbd_macro);
12601 mark_object (kb->Vlast_kbd_macro);
12602 mark_object (kb->Vsystem_key_alist);
12603 mark_object (kb->system_key_syms);
12604 mark_object (kb->Vwindow_system);
12605 mark_object (kb->Vinput_decode_map);
12606 mark_object (kb->Vlocal_function_key_map);
12607 mark_object (kb->Vdefault_minibuffer_frame);
12608 mark_object (kb->echo_string);
12611 struct input_event *event;
12612 for (event = kbd_fetch_ptr; event != kbd_store_ptr; event++)
12614 if (event == kbd_buffer + KBD_BUFFER_SIZE)
12615 event = kbd_buffer;
12616 if (event->kind != SELECTION_REQUEST_EVENT
12617 && event->kind != SELECTION_CLEAR_EVENT)
12619 mark_object (event->x);
12620 mark_object (event->y);
12622 mark_object (event->frame_or_window);
12623 mark_object (event->arg);
12628 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12629 (do not change this comment) */