(posix_memalign): New function.
[bpt/emacs.git] / src / keyboard.c
CommitLineData
284f4730 1/* Keyboard and mouse input; editor command loop.
0b5538bd
TTN
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
3 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
4e6835db 4 2005, 2006, 2007 Free Software Foundation, Inc.
284f4730
JB
5
6This file is part of GNU Emacs.
7
8GNU Emacs is free software; you can redistribute it and/or modify
9it under the terms of the GNU General Public License as published by
684d6f5b 10the Free Software Foundation; either version 3, or (at your option)
284f4730
JB
11any later version.
12
13GNU Emacs is distributed in the hope that it will be useful,
14but WITHOUT ANY WARRANTY; without even the implied warranty of
15MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16GNU General Public License for more details.
17
18You should have received a copy of the GNU General Public License
19along with GNU Emacs; see the file COPYING. If not, write to
4fc5845f
LK
20the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21Boston, MA 02110-1301, USA. */
284f4730 22
18160b98 23#include <config.h>
68c45bf0 24#include <signal.h>
284f4730 25#include <stdio.h>
284f4730
JB
26#include "termchar.h"
27#include "termopts.h"
28#include "lisp.h"
29#include "termhooks.h"
30#include "macros.h"
02639609 31#include "keyboard.h"
ff11dfa1 32#include "frame.h"
284f4730
JB
33#include "window.h"
34#include "commands.h"
35#include "buffer.h"
37cd9f30 36#include "charset.h"
284f4730 37#include "disptab.h"
f4255cd1 38#include "dispextern.h"
e39da3d7 39#include "syntax.h"
497ba7a1 40#include "intervals.h"
bdb7aa47 41#include "keymap.h"
9ac0d9e0 42#include "blockinput.h"
e8886a1d 43#include "puresize.h"
8a9f5d3c
GM
44#include "systime.h"
45#include "atimer.h"
284f4730
JB
46#include <setjmp.h>
47#include <errno.h>
48
aa477689
JD
49#ifdef HAVE_GTK_AND_PTHREAD
50#include <pthread.h>
51#endif
80e4aa30
RS
52#ifdef MSDOS
53#include "msdos.h"
54#include <time.h>
55#else /* not MSDOS */
284f4730
JB
56#ifndef VMS
57#include <sys/ioctl.h>
284f4730 58#endif
80e4aa30 59#endif /* not MSDOS */
284f4730 60
52baf19e 61#include "syssignal.h"
6ef5b54f 62#include "systty.h"
52baf19e 63
03cee6ae
GM
64#include <sys/types.h>
65#ifdef HAVE_UNISTD_H
66#include <unistd.h>
67#endif
68
e31d908f
DN
69#ifdef HAVE_FCNTL_H
70#include <fcntl.h>
71#endif
72
c5e3b6c5
RS
73/* This is to get the definitions of the XK_ symbols. */
74#ifdef HAVE_X_WINDOWS
75#include "xterm.h"
76#endif
77
e98a93eb
GV
78#ifdef HAVE_NTGUI
79#include "w32term.h"
80#endif /* HAVE_NTGUI */
81
e0f712ba 82#ifdef MAC_OS
1a578e9b
AC
83#include "macterm.h"
84#endif
85
02639609 86#ifndef USE_CRT_DLL
52baf19e 87extern int errno;
02639609 88#endif
52baf19e 89
9ac0d9e0
JB
90/* Variables for blockinput.h: */
91
92/* Non-zero if interrupt input is blocked right now. */
cf2db145 93volatile int interrupt_input_blocked;
9ac0d9e0
JB
94
95/* Nonzero means an input interrupt has arrived
96 during the current critical section. */
63927c41 97int interrupt_input_pending;
9ac0d9e0
JB
98
99
437f6112
RS
100/* File descriptor to use for input. */
101extern int input_fd;
284f4730 102
e98a93eb 103#ifdef HAVE_WINDOW_SYSTEM
284f4730 104/* Make all keyboard buffers much bigger when using X windows. */
e0f712ba
AC
105#ifdef MAC_OS8
106/* But not too big (local data > 32K error) if on Mac OS Classic. */
f019cded
RS
107#define KBD_BUFFER_SIZE 512
108#else
284f4730 109#define KBD_BUFFER_SIZE 4096
f019cded 110#endif
284f4730 111#else /* No X-windows, character input */
de11c1ea 112#define KBD_BUFFER_SIZE 4096
284f4730
JB
113#endif /* No X-windows */
114
222d557c
GM
115#define abs(x) ((x) >= 0 ? (x) : -(x))
116
284f4730
JB
117/* Following definition copied from eval.c */
118
119struct backtrace
120 {
121 struct backtrace *next;
122 Lisp_Object *function;
123 Lisp_Object *args; /* Points to vector of args. */
124 int nargs; /* length of vector. If nargs is UNEVALLED,
125 args points to slot holding list of
126 unevalled args */
127 char evalargs;
080e18b1
KS
128 /* Nonzero means call value of debugger when done with this operation. */
129 char debug_on_exit;
284f4730
JB
130 };
131
c5fdd383
KH
132#ifdef MULTI_KBOARD
133KBOARD *initial_kboard;
134KBOARD *current_kboard;
135KBOARD *all_kboards;
1e8bd3da 136int single_kboard;
6c6083a9 137#else
c5fdd383 138KBOARD the_only_kboard;
6c6083a9 139#endif
612b78ef 140
284f4730 141/* Non-nil disable property on a command means
971e4c98
LT
142 do not execute it; call disabled-command-function's value instead. */
143Lisp_Object Qdisabled, Qdisabled_command_function;
284f4730 144
0721f230 145#define NUM_RECENT_KEYS (300)
284f4730
JB
146int recent_keys_index; /* Index for storing next element into recent_keys */
147int total_keys; /* Total number of elements stored into recent_keys */
0721f230 148Lisp_Object recent_keys; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
284f4730 149
6569cc8d
JB
150/* Vector holding the key sequence that invoked the current command.
151 It is reused for each command, and it may be longer than the current
152 sequence; this_command_key_count indicates how many elements
153 actually mean something.
154 It's easier to staticpro a single Lisp_Object than an array. */
155Lisp_Object this_command_keys;
156int this_command_key_count;
284f4730 157
63020c46
RS
158/* 1 after calling Freset_this_command_lengths.
159 Usually it is 0. */
160int this_command_key_count_reset;
161
7d18f9ae
RS
162/* This vector is used as a buffer to record the events that were actually read
163 by read_key_sequence. */
164Lisp_Object raw_keybuf;
165int raw_keybuf_count;
166
167#define GROW_RAW_KEYBUF \
7189cad8 168 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
7d18f9ae
RS
169 { \
170 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
171 Lisp_Object new; \
172 new = Fmake_vector (make_number (newsize), Qnil); \
173 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
174 raw_keybuf_count * sizeof (Lisp_Object)); \
175 raw_keybuf = new; \
176 }
177
6321824f
RS
178/* Number of elements of this_command_keys
179 that precede this key sequence. */
180int this_single_command_key_start;
181
71918b75
RS
182/* Record values of this_command_key_count and echo_length ()
183 before this command was read. */
184static int before_command_key_count;
185static int before_command_echo_length;
71918b75 186
284f4730
JB
187extern int minbuf_level;
188
a59b172a
RS
189extern int message_enable_multibyte;
190
284f4730
JB
191extern struct backtrace *backtrace_list;
192
7ee32cda
GM
193/* If non-nil, the function that implements the display of help.
194 It's called with one argument, the help string to display. */
195
196Lisp_Object Vshow_help_function;
197
f0c1cc56
GM
198/* If a string, the message displayed before displaying a help-echo
199 in the echo area. */
200
201Lisp_Object Vpre_help_message;
202
284f4730 203/* Nonzero means do menu prompting. */
f0c1cc56 204
284f4730
JB
205static int menu_prompting;
206
207/* Character to see next line of menu prompt. */
f0c1cc56 208
284f4730
JB
209static Lisp_Object menu_prompt_more_char;
210
211/* For longjmp to where kbd input is being done. */
f0c1cc56 212
284f4730
JB
213static jmp_buf getcjmp;
214
215/* True while doing kbd input. */
216int waiting_for_input;
217
218/* True while displaying for echoing. Delays C-g throwing. */
985f9f66 219
c843d6c6 220int echoing;
284f4730 221
985f9f66
GM
222/* Non-null means we can start echoing at the next input pause even
223 though there is something in the echo area. */
224
225static struct kboard *ok_to_echo_at_next_pause;
226
59a84f8e
GM
227/* The kboard last echoing, or null for none. Reset to 0 in
228 cancel_echoing. If non-null, and a current echo area message
229 exists, and echo_message_buffer is eq to the current message
230 buffer, we know that the message comes from echo_kboard. */
985f9f66 231
f49aedfd 232struct kboard *echo_kboard;
1fc93d49 233
59a84f8e
GM
234/* The buffer used for echoing. Set in echo_now, reset in
235 cancel_echoing. */
236
c843d6c6 237Lisp_Object echo_message_buffer;
59a84f8e 238
03361bcc
RS
239/* Nonzero means disregard local maps for the menu bar. */
240static int inhibit_local_menu_bar_menus;
241
80e4aa30 242/* Nonzero means C-g should cause immediate error-signal. */
284f4730
JB
243int immediate_quit;
244
04d8c47d
RS
245/* The user's hook function for outputting an error message. */
246Lisp_Object Vcommand_error_function;
247
fa90970d
RS
248/* The user's ERASE setting. */
249Lisp_Object Vtty_erase_char;
250
284f4730 251/* Character to recognize as the help char. */
7e85b935 252Lisp_Object Vhelp_char;
284f4730 253
ecb7cb34
KH
254/* List of other event types to recognize as meaning "help". */
255Lisp_Object Vhelp_event_list;
256
284f4730
JB
257/* Form to execute when help char is typed. */
258Lisp_Object Vhelp_form;
259
7e85b935
RS
260/* Command to run when the help character follows a prefix key. */
261Lisp_Object Vprefix_help_command;
262
9f9c0e27
RS
263/* List of items that should move to the end of the menu bar. */
264Lisp_Object Vmenu_bar_final_items;
a73c5e29 265
6526ab49
RS
266/* Non-nil means show the equivalent key-binding for
267 any M-x command that has one.
268 The value can be a length of time to show the message for.
269 If the value is non-nil and not a number, we wait 2 seconds. */
270Lisp_Object Vsuggest_key_bindings;
271
00392ce6
MB
272/* How long to display an echo-area message when the minibuffer is active.
273 If the value is not a number, such messages don't time out. */
274Lisp_Object Vminibuffer_message_timeout;
275
284f4730
JB
276/* Character that causes a quit. Normally C-g.
277
278 If we are running on an ordinary terminal, this must be an ordinary
279 ASCII char, since we want to make it our interrupt character.
280
281 If we are not running on an ordinary terminal, it still needs to be
282 an ordinary ASCII char. This character needs to be recognized in
283 the input interrupt handler. At this point, the keystroke is
284 represented as a struct input_event, while the desired quit
285 character is specified as a lispy event. The mapping from struct
286 input_events to lispy events cannot run in an interrupt handler,
287 and the reverse mapping is difficult for anything but ASCII
288 keystrokes.
289
290 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
291 ASCII character. */
292int quit_char;
293
294extern Lisp_Object current_global_map;
295extern int minibuf_level;
296
9dd3131c
RS
297/* If non-nil, this is a map that overrides all other local maps. */
298Lisp_Object Voverriding_local_map;
299
d0a49716
RS
300/* If non-nil, Voverriding_local_map applies to the menu bar. */
301Lisp_Object Voverriding_local_map_menu_flag;
302
7f07d5ca
RS
303/* Keymap that defines special misc events that should
304 be processed immediately at a low level. */
305Lisp_Object Vspecial_event_map;
306
284f4730
JB
307/* Current depth in recursive edits. */
308int command_loop_level;
309
310/* Total number of times command_loop has read a key sequence. */
31ade731 311EMACS_INT num_input_keys;
284f4730
JB
312
313/* Last input character read as a command. */
314Lisp_Object last_command_char;
315
7d6de002
RS
316/* Last input character read as a command, not counting menus
317 reached by the mouse. */
318Lisp_Object last_nonmenu_event;
319
284f4730
JB
320/* Last input character read for any purpose. */
321Lisp_Object last_input_char;
322
dbc4e1c1 323/* If not Qnil, a list of objects to be read as subsequent command input. */
24597608 324Lisp_Object Vunread_command_events;
284f4730 325
7d18f9ae
RS
326/* If not Qnil, a list of objects to be read as subsequent command input
327 including input method processing. */
328Lisp_Object Vunread_input_method_events;
329
330/* If not Qnil, a list of objects to be read as subsequent command input
331 but NOT including input method processing. */
332Lisp_Object Vunread_post_input_method_events;
333
86e5706b 334/* If not -1, an event to be read as subsequent command input. */
31ade731 335EMACS_INT unread_command_char;
86e5706b 336
cd21b839
JB
337/* If not Qnil, this is a switch-frame event which we decided to put
338 off until the end of a key sequence. This should be read as the
dbc4e1c1 339 next command input, after any unread_command_events.
8f805655
JB
340
341 read_key_sequence uses this to delay switch-frame events until the
342 end of the key sequence; Fread_char uses it to put off switch-frame
343 events until a non-ASCII event is acceptable as input. */
344Lisp_Object unread_switch_frame;
cd21b839 345
9fa4395d 346/* A mask of extra modifier bits to put into every keyboard char. */
31ade731 347EMACS_INT extra_keyboard_modifiers;
9fa4395d 348
284f4730
JB
349/* Char to use as prefix when a meta character is typed in.
350 This is bound on entry to minibuffer in case ESC is changed there. */
351
352Lisp_Object meta_prefix_char;
353
354/* Last size recorded for a current buffer which is not a minibuffer. */
355static int last_non_minibuf_size;
356
06ef7355 357/* Number of idle seconds before an auto-save and garbage collection. */
284f4730
JB
358static Lisp_Object Vauto_save_timeout;
359
360/* Total number of times read_char has returned. */
4abfba1f 361int num_input_events;
284f4730 362
51172b6d 363/* Total number of times read_char has returned, outside of macros. */
31ade731 364EMACS_INT num_nonmacro_input_events;
51172b6d 365
284f4730
JB
366/* Auto-save automatically when this many characters have been typed
367 since the last time. */
368
31ade731 369static EMACS_INT auto_save_interval;
284f4730 370
c43b1734 371/* Value of num_nonmacro_input_events as of last auto save. */
284f4730
JB
372
373int last_auto_save;
374
284f4730 375/* The command being executed by the command loop.
6c7178b9
KH
376 Commands may set this, and the value set will be copied into
377 current_kboard->Vlast_command instead of the actual command. */
d5eecefb
RS
378Lisp_Object Vthis_command;
379
380/* This is like Vthis_command, except that commands never set it. */
381Lisp_Object real_this_command;
284f4730 382
8b9940e6
KS
383/* If the lookup of the command returns a binding, the original
384 command is stored in this-original-command. It is nil otherwise. */
385Lisp_Object Vthis_original_command;
386
bb0e1d19 387/* The value of point when the last command was started. */
b453f72e
KH
388int last_point_position;
389
047688cb
RS
390/* The buffer that was current when the last command was started. */
391Lisp_Object last_point_position_buffer;
392
bb0e1d19
RS
393/* The window that was selected when the last command was started. */
394Lisp_Object last_point_position_window;
395
4c52b668
KH
396/* The frame in which the last input event occurred, or Qmacro if the
397 last event came from a macro. We use this to determine when to
398 generate switch-frame events. This may be cleared by functions
399 like Fselect_frame, to make sure that a switch-frame event is
400 generated by the next character. */
401Lisp_Object internal_last_event_frame;
4c52b668
KH
402
403/* A user-visible version of the above, intended to allow users to
404 figure out where the last event came from, if the event doesn't
405 carry that information itself (i.e. if it was a character). */
406Lisp_Object Vlast_event_frame;
407
1113d9db
JB
408/* The timestamp of the last input event we received from the X server.
409 X Windows wants this for selection ownership. */
284f4730
JB
410unsigned long last_event_timestamp;
411
412Lisp_Object Qself_insert_command;
413Lisp_Object Qforward_char;
414Lisp_Object Qbackward_char;
e58aa385 415Lisp_Object Qundefined;
d925fb39 416Lisp_Object Qtimer_event_handler;
284f4730
JB
417
418/* read_key_sequence stores here the command definition of the
419 key sequence that it reads. */
420Lisp_Object read_key_sequence_cmd;
421
39aab679
DL
422/* Echo unfinished commands after this many seconds of pause. */
423Lisp_Object Vecho_keystrokes;
424
284f4730
JB
425/* Form to evaluate (if non-nil) when Emacs is started. */
426Lisp_Object Vtop_level;
427
a0acc6c7 428/* User-supplied table to translate input characters. */
284f4730
JB
429Lisp_Object Vkeyboard_translate_table;
430
431/* Keymap mapping ASCII function key sequences onto their preferred forms. */
432extern Lisp_Object Vfunction_key_map;
433
e0301c07
RS
434/* Another keymap that maps key sequences into key sequences.
435 This one takes precedence over ordinary definitions. */
436extern Lisp_Object Vkey_translation_map;
a612e298 437
7d18f9ae
RS
438/* If non-nil, this implements the current input method. */
439Lisp_Object Vinput_method_function;
440Lisp_Object Qinput_method_function;
441
d5eecefb
RS
442/* When we call Vinput_method_function,
443 this holds the echo area message that was just erased. */
444Lisp_Object Vinput_method_previous_message;
445
86e5706b
RS
446/* Non-nil means deactivate the mark at end of this command. */
447Lisp_Object Vdeactivate_mark;
448
48e416d4
RS
449/* Menu bar specified in Lucid Emacs fashion. */
450
451Lisp_Object Vlucid_menu_bar_dirty_flag;
452Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;
453
cf24f894 454Lisp_Object Qecho_area_clear_hook;
cdb9d665 455
86e5706b 456/* Hooks to run before and after each command. */
59aadc81
RS
457Lisp_Object Qpre_command_hook, Vpre_command_hook;
458Lisp_Object Qpost_command_hook, Vpost_command_hook;
40932d1a 459Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
86e5706b 460
8a792f3a
RS
461/* List of deferred actions to be performed at a later time.
462 The precise format isn't relevant here; we just check whether it is nil. */
463Lisp_Object Vdeferred_action_list;
464
465/* Function to call to handle deferred actions, when there are any. */
466Lisp_Object Vdeferred_action_function;
3ef14e46 467Lisp_Object Qdeferred_action_function;
8a792f3a 468
d5eecefb
RS
469Lisp_Object Qinput_method_exit_on_first_char;
470Lisp_Object Qinput_method_use_echo_area;
471
284f4730
JB
472/* File in which we write all commands we read. */
473FILE *dribble;
474
475/* Nonzero if input is available. */
476int input_pending;
477
b04904fb
RS
478/* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
479 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
480
284f4730
JB
481int meta_key;
482
483extern char *pending_malloc_warning;
484
beecf6a1 485/* Circular buffer for pre-read keyboard input. */
da8f7368 486
beecf6a1
KH
487static struct input_event kbd_buffer[KBD_BUFFER_SIZE];
488
beecf6a1
KH
489/* Pointer to next available character in kbd_buffer.
490 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
5cb6905d 491 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
beecf6a1
KH
492 next available char is in kbd_buffer[0]. */
493static struct input_event *kbd_fetch_ptr;
494
495/* Pointer to next place to store character in kbd_buffer. This
496 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
497 character should go in kbd_buffer[0]. */
7ee32cda 498static struct input_event * volatile kbd_store_ptr;
beecf6a1
KH
499
500/* The above pair of variables forms a "queue empty" flag. When we
501 enqueue a non-hook event, we increment kbd_store_ptr. When we
502 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
503 there is input available iff the two pointers are not equal.
504
505 Why not just have a flag set and cleared by the enqueuing and
506 dequeuing functions? Such a flag could be screwed up by interrupts
507 at inopportune times. */
508
f3253854 509/* If this flag is non-nil, we check mouse_moved to see when the
a9d77f1f
RS
510 mouse moves, and motion events will appear in the input stream.
511 Otherwise, mouse motion is ignored. */
e10da507 512Lisp_Object do_mouse_tracking;
284f4730 513
284f4730
JB
514/* Symbols to head events. */
515Lisp_Object Qmouse_movement;
3c370943 516Lisp_Object Qscroll_bar_movement;
cd21b839 517Lisp_Object Qswitch_frame;
bbdc2092 518Lisp_Object Qdelete_frame;
af17bd2b
KH
519Lisp_Object Qiconify_frame;
520Lisp_Object Qmake_frame_visible;
a697f886 521Lisp_Object Qselect_window;
7ee32cda 522Lisp_Object Qhelp_echo;
cd21b839 523
ae372f41 524#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
c22237f7
KS
525Lisp_Object Qmouse_fixup_help_message;
526#endif
527
284f4730
JB
528/* Symbols to denote kinds of events. */
529Lisp_Object Qfunction_key;
530Lisp_Object Qmouse_click;
c16dab62 531#if defined (WINDOWSNT) || defined (MAC_OS)
1161d367 532Lisp_Object Qlanguage_change;
07de30b9 533#endif
a24dc617 534Lisp_Object Qdrag_n_drop;
4ebc27a5 535Lisp_Object Qsave_session;
f66c49cc
YM
536#ifdef MAC_OS
537Lisp_Object Qmac_apple_event;
538#endif
4ebc27a5 539
284f4730 540/* Lisp_Object Qmouse_movement; - also an event header */
284f4730
JB
541
542/* Properties of event headers. */
543Lisp_Object Qevent_kind;
88cb0656 544Lisp_Object Qevent_symbol_elements;
284f4730 545
e8886a1d
RS
546/* menu item parts */
547Lisp_Object Qmenu_alias;
598a9fa7 548Lisp_Object Qmenu_enable;
74c1de23
RS
549Lisp_Object QCenable, QCvisible, QChelp, QCfilter, QCkeys, QCkey_sequence;
550Lisp_Object QCbutton, QCtoggle, QCradio;
e8886a1d
RS
551extern Lisp_Object Vdefine_key_rebound_commands;
552extern Lisp_Object Qmenu_item;
598a9fa7 553
0a7f1fc0
JB
554/* An event header symbol HEAD may have a property named
555 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
556 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
557 mask of modifiers applied to it. If present, this is used to help
558 speed up parse_modifiers. */
559Lisp_Object Qevent_symbol_element_mask;
560
561/* An unmodified event header BASE may have a property named
562 Qmodifier_cache, which is an alist mapping modifier masks onto
563 modified versions of BASE. If present, this helps speed up
564 apply_modifiers. */
565Lisp_Object Qmodifier_cache;
566
5ec75a55 567/* Symbols to use for parts of windows. */
284f4730 568Lisp_Object Qmode_line;
e5d77022 569Lisp_Object Qvertical_line;
3c370943 570Lisp_Object Qvertical_scroll_bar;
5ec75a55 571Lisp_Object Qmenu_bar;
7d60ad8a 572extern Lisp_Object Qleft_margin, Qright_margin;
3d566707 573extern Lisp_Object Qleft_fringe, Qright_fringe;
2e3f0f61 574extern Lisp_Object QCmap;
5ec75a55 575
f4255cd1
JB
576Lisp_Object recursive_edit_unwind (), command_loop ();
577Lisp_Object Fthis_command_keys ();
03b4122a 578Lisp_Object Qextended_command_history;
c04cbc3b 579EMACS_TIME timer_check ();
284f4730 580
a0acc6c7 581extern Lisp_Object Vhistory_length, Vtranslation_table_for_input;
f4385381 582
2c834fb3
KH
583extern char *x_get_keysym_name ();
584
8eb4d8ef 585static void record_menu_key ();
22b94eeb 586static int echo_length ();
8eb4d8ef 587
f4eef8b4
RS
588Lisp_Object Qpolling_period;
589
d9d4c147 590/* List of absolute timers. Appears in order of next scheduled event. */
c04cbc3b
RS
591Lisp_Object Vtimer_list;
592
d9d4c147
KH
593/* List of idle time timers. Appears in order of next scheduled event. */
594Lisp_Object Vtimer_idle_list;
595
87dd9b9b
RS
596/* Incremented whenever a timer is run. */
597int timers_run;
598
a9f16aa9
KH
599extern Lisp_Object Vprint_level, Vprint_length;
600
ffd56f97
JB
601/* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
602 happens. */
603EMACS_TIME *input_available_clear_time;
284f4730
JB
604
605/* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
606 Default is 1 if INTERRUPT_INPUT is defined. */
607int interrupt_input;
608
609/* Nonzero while interrupts are temporarily deferred during redisplay. */
610int interrupts_deferred;
611
87dd9b9b 612/* Nonzero means use ^S/^Q for flow control. */
284f4730
JB
613int flow_control;
614
284f4730
JB
615/* Allow m- file to inhibit use of FIONREAD. */
616#ifdef BROKEN_FIONREAD
617#undef FIONREAD
618#endif
619
620/* We are unable to use interrupts if FIONREAD is not available,
621 so flush SIGIO so we won't try. */
fc7a70cc 622#if !defined (FIONREAD)
284f4730
JB
623#ifdef SIGIO
624#undef SIGIO
625#endif
626#endif
627
e98a93eb 628/* If we support a window system, turn on the code to poll periodically
34f04431 629 to detect C-g. It isn't actually used when doing interrupt input. */
742fbed7 630#if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
284f4730
JB
631#define POLL_FOR_INPUT
632#endif
adf5cb9c
KH
633
634/* After a command is executed, if point is moved into a region that
635 has specific properties (e.g. composition, display), we adjust
636 point to the boundary of the region. But, if a command sets this
27fd22dc 637 variable to non-nil, we suppress this point adjustment. This
adf5cb9c 638 variable is set to nil before reading a command. */
da8f7368 639
adf5cb9c
KH
640Lisp_Object Vdisable_point_adjustment;
641
642/* If non-nil, always disable point adjustment. */
da8f7368 643
adf5cb9c
KH
644Lisp_Object Vglobal_disable_point_adjustment;
645
fdbb67fe
GM
646/* The time when Emacs started being idle. */
647
648static EMACS_TIME timer_idleness_start_time;
649
3021d3a9
RS
650/* After Emacs stops being idle, this saves the last value
651 of timer_idleness_start_time from when it was idle. */
652
653static EMACS_TIME timer_last_idleness_start_time;
654
9d56e0da
EZ
655/* If non-nil, events produced by disabled menu items and tool-bar
656 buttons are not ignored. Help functions bind this to allow help on
657 those items and buttons. */
658Lisp_Object Venable_disabled_menus_and_buttons;
659
284f4730
JB
660\f
661/* Global variable declarations. */
662
a2d5fca0
JD
663/* Flags for readable_events. */
664#define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
665#define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
666#define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
667
284f4730
JB
668/* Function for init_keyboard to call with no args (if nonzero). */
669void (*keyboard_init_hook) ();
670
0bbfdc25
GM
671static int read_avail_input P_ ((int));
672static void get_input_pending P_ ((int *, int));
673static int readable_events P_ ((int));
674static Lisp_Object read_char_x_menu_prompt P_ ((int, Lisp_Object *,
675 Lisp_Object, int *));
8150596a 676static Lisp_Object read_char_x_menu_prompt ();
0bbfdc25
GM
677static Lisp_Object read_char_minibuf_menu_prompt P_ ((int, int,
678 Lisp_Object *));
679static Lisp_Object make_lispy_event P_ ((struct input_event *));
ae372f41 680#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
0bbfdc25
GM
681static Lisp_Object make_lispy_movement P_ ((struct frame *, Lisp_Object,
682 enum scroll_bar_part,
683 Lisp_Object, Lisp_Object,
684 unsigned long));
514354e9 685#endif
0bbfdc25
GM
686static Lisp_Object modify_event_symbol P_ ((int, unsigned, Lisp_Object,
687 Lisp_Object, char **,
688 Lisp_Object *, unsigned));
689static Lisp_Object make_lispy_switch_frame P_ ((Lisp_Object));
690static int parse_solitary_modifier P_ ((Lisp_Object));
3d31316f 691static int parse_solitary_modifier ();
0bbfdc25 692static void save_getcjmp P_ ((jmp_buf));
dfcf069d 693static void save_getcjmp ();
0bbfdc25 694static void restore_getcjmp P_ ((jmp_buf));
7ee32cda 695static Lisp_Object apply_modifiers P_ ((int, Lisp_Object));
0bbfdc25 696static void clear_event P_ ((struct input_event *));
9ce50b1e 697static void any_kboard_state P_ ((void));
5598c32e 698static SIGTYPE interrupt_signal P_ ((int signalnum));
5c12e63f
KS
699static void timer_start_idle P_ ((void));
700static void timer_stop_idle P_ ((void));
701static void timer_resume_idle P_ ((void));
23479b40
YM
702static SIGTYPE handle_user_signal P_ ((int));
703static char *find_user_signal_name P_ ((int));
704static int store_user_signal_events P_ ((void));
284f4730 705
8026024c
KH
706/* Nonzero means don't try to suspend even if the operating system seems
707 to support it. */
708static int cannot_suspend;
709
29204e13
RS
710extern Lisp_Object Qidentity, Qonly;
711\f
284f4730
JB
712/* Install the string STR as the beginning of the string of echoing,
713 so that it serves as a prompt for the next character.
714 Also start echoing. */
715
dfcf069d 716void
284f4730 717echo_prompt (str)
a4ef85ee 718 Lisp_Object str;
284f4730 719{
678e9d18 720 current_kboard->echo_string = str;
0d121f7c 721 current_kboard->echo_after_prompt = SCHARS (str);
3dbd9ee4 722 echo_now ();
284f4730
JB
723}
724
df0f2ba1 725/* Add C to the echo string, if echoing is going on.
284f4730
JB
726 C can be a character, which is printed prettily ("M-C-x" and all that
727 jazz), or a symbol, whose name is printed. */
728
dfcf069d 729void
284f4730
JB
730echo_char (c)
731 Lisp_Object c;
732{
c5fdd383 733 if (current_kboard->immediate_echo)
284f4730 734 {
678e9d18
GM
735 int size = KEY_DESCRIPTION_SIZE + 100;
736 char *buffer = (char *) alloca (size);
737 char *ptr = buffer;
738 Lisp_Object echo_string;
284f4730 739
0d121f7c 740 echo_string = current_kboard->echo_string;
c60ee5e7 741
284f4730 742 /* If someone has passed us a composite event, use its head symbol. */
88cb0656 743 c = EVENT_HEAD (c);
284f4730 744
8c18cbfb 745 if (INTEGERP (c))
284f4730 746 {
678e9d18 747 ptr = push_key_description (XINT (c), ptr, 1);
284f4730 748 }
8c18cbfb 749 else if (SYMBOLP (c))
284f4730 750 {
1b049b51
KR
751 Lisp_Object name = SYMBOL_NAME (c);
752 int nbytes = SBYTES (name);
c60ee5e7 753
0d121f7c 754 if (size - (ptr - buffer) < nbytes)
678e9d18
GM
755 {
756 int offset = ptr - buffer;
0d121f7c 757 size = max (2 * size, size + nbytes);
678e9d18
GM
758 buffer = (char *) alloca (size);
759 ptr = buffer + offset;
760 }
761
1b049b51
KR
762 ptr += copy_text (SDATA (name), ptr, nbytes,
763 STRING_MULTIBYTE (name), 1);
284f4730
JB
764 }
765
0d121f7c 766 if ((NILP (echo_string) || SCHARS (echo_string) == 0)
ecb7cb34 767 && help_char_p (c))
284f4730 768 {
678e9d18
GM
769 const char *text = " (Type ? for further options)";
770 int len = strlen (text);
c60ee5e7 771
678e9d18
GM
772 if (size - (ptr - buffer) < len)
773 {
774 int offset = ptr - buffer;
775 size += len;
776 buffer = (char *) alloca (size);
777 ptr = buffer + offset;
778 }
779
780 bcopy (text, ptr, len);
781 ptr += len;
284f4730
JB
782 }
783
0d121f7c
GM
784 /* Replace a dash from echo_dash with a space, otherwise
785 add a space at the end as a separator between keys. */
678e9d18 786 if (STRINGP (echo_string)
2ff4d3d9 787 && SCHARS (echo_string) > 1)
0d121f7c 788 {
2ff4d3d9
RS
789 Lisp_Object last_char, prev_char, idx;
790
791 idx = make_number (SCHARS (echo_string) - 2);
792 prev_char = Faref (echo_string, idx);
0d121f7c
GM
793
794 idx = make_number (SCHARS (echo_string) - 1);
795 last_char = Faref (echo_string, idx);
796
2ff4d3d9
RS
797 /* We test PREV_CHAR to make sure this isn't the echoing
798 of a minus-sign. */
799 if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
0d121f7c
GM
800 Faset (echo_string, idx, make_number (' '));
801 else
802 echo_string = concat2 (echo_string, build_string (" "));
803 }
c3be81c7
RS
804 else if (STRINGP (echo_string))
805 echo_string = concat2 (echo_string, build_string (" "));
678e9d18
GM
806
807 current_kboard->echo_string
808 = concat2 (echo_string, make_string (buffer, ptr - buffer));
284f4730 809
3dbd9ee4 810 echo_now ();
284f4730
JB
811 }
812}
813
814/* Temporarily add a dash to the end of the echo string if it's not
815 empty, so that it serves as a mini-prompt for the very next character. */
816
dfcf069d 817void
284f4730
JB
818echo_dash ()
819{
678e9d18
GM
820 /* Do nothing if not echoing at all. */
821 if (NILP (current_kboard->echo_string))
822 return;
823
c5fdd383 824 if (!current_kboard->immediate_echo
0d121f7c 825 && SCHARS (current_kboard->echo_string) == 0)
284f4730 826 return;
c60ee5e7 827
7a80a6f6 828 /* Do nothing if we just printed a prompt. */
c5fdd383 829 if (current_kboard->echo_after_prompt
0d121f7c 830 == SCHARS (current_kboard->echo_string))
4bafa972 831 return;
c60ee5e7 832
366511da
MB
833 /* Do nothing if we have already put a dash at the end. */
834 if (SCHARS (current_kboard->echo_string) > 1)
835 {
c3be81c7 836 Lisp_Object last_char, prev_char, idx;
366511da 837
c3be81c7
RS
838 idx = make_number (SCHARS (current_kboard->echo_string) - 2);
839 prev_char = Faref (current_kboard->echo_string, idx);
366511da 840
c3be81c7
RS
841 idx = make_number (SCHARS (current_kboard->echo_string) - 1);
842 last_char = Faref (current_kboard->echo_string, idx);
366511da 843
c3be81c7
RS
844 if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
845 return;
366511da
MB
846 }
847
284f4730
JB
848 /* Put a dash at the end of the buffer temporarily,
849 but make it go away when the next character is added. */
678e9d18
GM
850 current_kboard->echo_string = concat2 (current_kboard->echo_string,
851 build_string ("-"));
3dbd9ee4 852 echo_now ();
284f4730
JB
853}
854
855/* Display the current echo string, and begin echoing if not already
856 doing so. */
857
07a59269 858void
3dbd9ee4 859echo_now ()
284f4730 860{
c5fdd383 861 if (!current_kboard->immediate_echo)
284f4730
JB
862 {
863 int i;
c5fdd383 864 current_kboard->immediate_echo = 1;
284f4730
JB
865
866 for (i = 0; i < this_command_key_count; i++)
d0a57728
RS
867 {
868 Lisp_Object c;
22b94eeb
RS
869
870 /* Set before_command_echo_length to the value that would
871 have been saved before the start of this subcommand in
872 command_loop_1, if we had already been echoing then. */
873 if (i == this_single_command_key_start)
874 before_command_echo_length = echo_length ();
875
d0a57728
RS
876 c = XVECTOR (this_command_keys)->contents[i];
877 if (! (EVENT_HAS_PARAMETERS (c)
878 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
879 echo_char (c);
880 }
22b94eeb
RS
881
882 /* Set before_command_echo_length to the value that would
883 have been saved before the start of this subcommand in
884 command_loop_1, if we had already been echoing then. */
885 if (this_command_key_count == this_single_command_key_start)
886 before_command_echo_length = echo_length ();
887
888 /* Put a dash at the end to invite the user to type more. */
284f4730
JB
889 echo_dash ();
890 }
891
892 echoing = 1;
678e9d18 893 message3_nolog (current_kboard->echo_string,
0d121f7c 894 SBYTES (current_kboard->echo_string),
d5db4077 895 STRING_MULTIBYTE (current_kboard->echo_string));
284f4730
JB
896 echoing = 0;
897
59a84f8e
GM
898 /* Record in what buffer we echoed, and from which kboard. */
899 echo_message_buffer = echo_area_buffer[0];
900 echo_kboard = current_kboard;
901
284f4730
JB
902 if (waiting_for_input && !NILP (Vquit_flag))
903 quit_throw_to_read_char ();
904}
905
906/* Turn off echoing, for the start of a new command. */
907
dfcf069d 908void
284f4730
JB
909cancel_echoing ()
910{
c5fdd383 911 current_kboard->immediate_echo = 0;
c5fdd383 912 current_kboard->echo_after_prompt = -1;
678e9d18 913 current_kboard->echo_string = Qnil;
59a84f8e
GM
914 ok_to_echo_at_next_pause = NULL;
915 echo_kboard = NULL;
916 echo_message_buffer = Qnil;
284f4730
JB
917}
918
919/* Return the length of the current echo string. */
920
921static int
922echo_length ()
923{
678e9d18 924 return (STRINGP (current_kboard->echo_string)
0d121f7c 925 ? SCHARS (current_kboard->echo_string)
678e9d18 926 : 0);
284f4730
JB
927}
928
929/* Truncate the current echo message to its first LEN chars.
930 This and echo_char get used by read_key_sequence when the user
ff11dfa1 931 switches frames while entering a key sequence. */
284f4730
JB
932
933static void
678e9d18
GM
934echo_truncate (nchars)
935 int nchars;
936{
937 if (STRINGP (current_kboard->echo_string))
938 current_kboard->echo_string
939 = Fsubstring (current_kboard->echo_string,
940 make_number (0), make_number (nchars));
941 truncate_echo_area (nchars);
284f4730
JB
942}
943
944\f
945/* Functions for manipulating this_command_keys. */
946static void
947add_command_key (key)
948 Lisp_Object key;
949{
22b94eeb
RS
950#if 0 /* Not needed after we made Freset_this_command_lengths
951 do the job immediately. */
71918b75
RS
952 /* If reset-this-command-length was called recently, obey it now.
953 See the doc string of that function for an explanation of why. */
954 if (before_command_restore_flag)
955 {
956 this_command_key_count = before_command_key_count_1;
6321824f
RS
957 if (this_command_key_count < this_single_command_key_start)
958 this_single_command_key_start = this_command_key_count;
71918b75
RS
959 echo_truncate (before_command_echo_length_1);
960 before_command_restore_flag = 0;
961 }
22b94eeb 962#endif
71918b75 963
f4e05d97
GM
964 if (this_command_key_count >= ASIZE (this_command_keys))
965 this_command_keys = larger_vector (this_command_keys,
966 2 * ASIZE (this_command_keys),
967 Qnil);
6569cc8d 968
f4e05d97
GM
969 AREF (this_command_keys, this_command_key_count) = key;
970 ++this_command_key_count;
284f4730 971}
f4e05d97 972
284f4730
JB
973\f
974Lisp_Object
975recursive_edit_1 ()
976{
aed13378 977 int count = SPECPDL_INDEX ();
284f4730
JB
978 Lisp_Object val;
979
980 if (command_loop_level > 0)
981 {
982 specbind (Qstandard_output, Qt);
983 specbind (Qstandard_input, Qt);
984 }
985
84265027 986#ifdef HAVE_X_WINDOWS
526a058f 987 /* The command loop has started an hourglass timer, so we have to
84265027 988 cancel it here, otherwise it will fire because the recursive edit
d8e2d5ba
PJ
989 can take some time. Do not check for display_hourglass_p here,
990 because it could already be nil. */
526a058f 991 cancel_hourglass ();
84265027
GM
992#endif
993
980a2d69
GM
994 /* This function may have been called from a debugger called from
995 within redisplay, for instance by Edebugging a function called
996 from fontification-functions. We want to allow redisplay in
997 the debugging session.
998
999 The recursive edit is left with a `(throw exit ...)'. The `exit'
1000 tag is not caught anywhere in redisplay, i.e. when we leave the
1001 recursive edit, the original redisplay leading to the recursive
1002 edit will be unwound. The outcome should therefore be safe. */
1003 specbind (Qinhibit_redisplay, Qnil);
1004 redisplaying_p = 0;
1005
284f4730
JB
1006 val = command_loop ();
1007 if (EQ (val, Qt))
1008 Fsignal (Qquit, Qnil);
cb252880
RS
1009 /* Handle throw from read_minibuf when using minibuffer
1010 while it's active but we're in another window. */
1011 if (STRINGP (val))
43cae48c 1012 xsignal1 (Qerror, val);
284f4730 1013
cb5df6ae 1014 return unbind_to (count, Qnil);
284f4730
JB
1015}
1016
1017/* When an auto-save happens, record the "time", and don't do again soon. */
5846638c 1018
07a59269 1019void
284f4730
JB
1020record_auto_save ()
1021{
c43b1734 1022 last_auto_save = num_nonmacro_input_events;
284f4730 1023}
5846638c
RS
1024
1025/* Make an auto save happen as soon as possible at command level. */
1026
dfcf069d 1027void
5846638c
RS
1028force_auto_save_soon ()
1029{
1030 last_auto_save = - auto_save_interval - 1;
241ceaf7
RS
1031
1032 record_asynch_buffer_change ();
5846638c 1033}
284f4730 1034\f
284f4730 1035DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
4707d2d0
PJ
1036 doc: /* Invoke the editor command loop recursively.
1037To get out of the recursive edit, a command can do `(throw 'exit nil)';
1038that tells this function to return.
6e604a9b 1039Alternatively, `(throw 'exit t)' makes this function signal an error.
4707d2d0
PJ
1040This function is called by the editor initialization to begin editing. */)
1041 ()
284f4730 1042{
aed13378 1043 int count = SPECPDL_INDEX ();
9ce50b1e 1044 Lisp_Object buffer;
284f4730 1045
96edd5d4
KS
1046 /* If we enter while input is blocked, don't lock up here.
1047 This may happen through the debugger during redisplay. */
1048 if (INPUT_BLOCKED_P)
1049 return Qnil;
1050
284f4730
JB
1051 command_loop_level++;
1052 update_mode_lines = 1;
1053
9ce50b1e
GM
1054 if (command_loop_level
1055 && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
1056 buffer = Fcurrent_buffer ();
1057 else
1058 buffer = Qnil;
1059
1060 /* If we leave recursive_edit_1 below with a `throw' for instance,
1061 like it is done in the splash screen display, we have to
1062 make sure that we restore single_kboard as command_loop_1
1063 would have done if it were left normally. */
284f4730 1064 record_unwind_protect (recursive_edit_unwind,
9ce50b1e
GM
1065 Fcons (buffer, single_kboard ? Qt : Qnil));
1066
284f4730
JB
1067 recursive_edit_1 ();
1068 return unbind_to (count, Qnil);
1069}
1070
1071Lisp_Object
9ce50b1e
GM
1072recursive_edit_unwind (info)
1073 Lisp_Object info;
284f4730 1074{
9ce50b1e
GM
1075 if (BUFFERP (XCAR (info)))
1076 Fset_buffer (XCAR (info));
c60ee5e7 1077
9ce50b1e
GM
1078 if (NILP (XCDR (info)))
1079 any_kboard_state ();
1080 else
1081 single_kboard_state ();
c60ee5e7 1082
284f4730
JB
1083 command_loop_level--;
1084 update_mode_lines = 1;
1085 return Qnil;
1086}
9ce50b1e 1087
284f4730 1088\f
604ccd1d 1089static void
1e8bd3da 1090any_kboard_state ()
604ccd1d 1091{
1e8bd3da
RS
1092#ifdef MULTI_KBOARD
1093#if 0 /* Theory: if there's anything in Vunread_command_events,
1094 it will right away be read by read_key_sequence,
1095 and then if we do switch KBOARDS, it will go into the side
1096 queue then. So we don't need to do anything special here -- rms. */
604ccd1d 1097 if (CONSP (Vunread_command_events))
4524b161 1098 {
c5fdd383
KH
1099 current_kboard->kbd_queue
1100 = nconc2 (Vunread_command_events, current_kboard->kbd_queue);
1101 current_kboard->kbd_queue_has_data = 1;
4524b161 1102 }
604ccd1d 1103 Vunread_command_events = Qnil;
1e8bd3da
RS
1104#endif
1105 single_kboard = 0;
1106#endif
604ccd1d 1107}
1e8bd3da
RS
1108
1109/* Switch to the single-kboard state, making current_kboard
1110 the only KBOARD from which further input is accepted. */
1111
1112void
1113single_kboard_state ()
1114{
1115#ifdef MULTI_KBOARD
1116 single_kboard = 1;
604ccd1d 1117#endif
1e8bd3da
RS
1118}
1119
0c1c1b93
RS
1120/* If we're in single_kboard state for kboard KBOARD,
1121 get out of it. */
1122
1123void
1124not_single_kboard_state (kboard)
1125 KBOARD *kboard;
1126{
26503ad2 1127#ifdef MULTI_KBOARD
0c1c1b93
RS
1128 if (kboard == current_kboard)
1129 single_kboard = 0;
26503ad2 1130#endif
0c1c1b93
RS
1131}
1132
1e8bd3da
RS
1133/* Maintain a stack of kboards, so other parts of Emacs
1134 can switch temporarily to the kboard of a given frame
1135 and then revert to the previous status. */
1136
1137struct kboard_stack
1138{
1139 KBOARD *kboard;
1140 struct kboard_stack *next;
1141};
1142
1143static struct kboard_stack *kboard_stack;
1144
1145void
1146push_frame_kboard (f)
1147 FRAME_PTR f;
1148{
ab48365b 1149#ifdef MULTI_KBOARD
1e8bd3da
RS
1150 struct kboard_stack *p
1151 = (struct kboard_stack *) xmalloc (sizeof (struct kboard_stack));
1152
1153 p->next = kboard_stack;
1154 p->kboard = current_kboard;
1155 kboard_stack = p;
1156
1157 current_kboard = FRAME_KBOARD (f);
ab48365b 1158#endif
1e8bd3da
RS
1159}
1160
1161void
1162pop_frame_kboard ()
1163{
ab48365b 1164#ifdef MULTI_KBOARD
1e8bd3da
RS
1165 struct kboard_stack *p = kboard_stack;
1166 current_kboard = p->kboard;
1167 kboard_stack = p->next;
1168 xfree (p);
ab48365b 1169#endif
1e8bd3da
RS
1170}
1171\f
1172/* Handle errors that are not handled at inner levels
1173 by printing an error message and returning to the editor command loop. */
604ccd1d 1174
284f4730
JB
1175Lisp_Object
1176cmd_error (data)
1177 Lisp_Object data;
a1341f75 1178{
a9f16aa9 1179 Lisp_Object old_level, old_length;
e881d8b2
RS
1180 char macroerror[50];
1181
160552c5
RS
1182#ifdef HAVE_X_WINDOWS
1183 if (display_hourglass_p)
1184 cancel_hourglass ();
1185#endif
1186
649d952d 1187 if (!NILP (executing_kbd_macro))
e881d8b2 1188 {
649d952d 1189 if (executing_kbd_macro_iterations == 1)
e881d8b2
RS
1190 sprintf (macroerror, "After 1 kbd macro iteration: ");
1191 else
1192 sprintf (macroerror, "After %d kbd macro iterations: ",
649d952d 1193 executing_kbd_macro_iterations);
e881d8b2
RS
1194 }
1195 else
1196 *macroerror = 0;
a9f16aa9 1197
a1341f75
RS
1198 Vstandard_output = Qt;
1199 Vstandard_input = Qt;
ce0d2858 1200 Vexecuting_kbd_macro = Qnil;
649d952d 1201 executing_kbd_macro = Qnil;
d8bcf58e 1202 current_kboard->Vprefix_arg = Qnil;
75045dcb 1203 current_kboard->Vlast_prefix_arg = Qnil;
df0f2ba1 1204 cancel_echoing ();
a9f16aa9
KH
1205
1206 /* Avoid unquittable loop if data contains a circular list. */
1207 old_level = Vprint_level;
1208 old_length = Vprint_length;
0c04a67e
RS
1209 XSETFASTINT (Vprint_level, 10);
1210 XSETFASTINT (Vprint_length, 10);
e881d8b2 1211 cmd_error_internal (data, macroerror);
a9f16aa9
KH
1212 Vprint_level = old_level;
1213 Vprint_length = old_length;
a1341f75
RS
1214
1215 Vquit_flag = Qnil;
1216
1217 Vinhibit_quit = Qnil;
c5fdd383 1218#ifdef MULTI_KBOARD
e3ee34f0
RS
1219 if (command_loop_level == 0 && minibuf_level == 0)
1220 any_kboard_state ();
ff4b06d3 1221#endif
a1341f75
RS
1222
1223 return make_number (0);
1224}
1225
301738ed
RS
1226/* Take actions on handling an error. DATA is the data that describes
1227 the error.
1228
1229 CONTEXT is a C-string containing ASCII characters only which
1230 describes the context in which the error happened. If we need to
1231 generalize CONTEXT to allow multibyte characters, make it a Lisp
1232 string. */
1233
07a59269 1234void
a1341f75
RS
1235cmd_error_internal (data, context)
1236 Lisp_Object data;
1237 char *context;
284f4730 1238{
788f89eb 1239 struct frame *sf = SELECTED_FRAME ();
284f4730 1240
04d8c47d
RS
1241 /* The immediate context is not interesting for Quits,
1242 since they are asyncronous. */
1243 if (EQ (XCAR (data), Qquit))
1244 Vsignaling_function = Qnil;
1245
284f4730
JB
1246 Vquit_flag = Qnil;
1247 Vinhibit_quit = Qt;
284f4730 1248
04d8c47d
RS
1249 /* Use user's specified output function if any. */
1250 if (!NILP (Vcommand_error_function))
1251 call3 (Vcommand_error_function, data,
fcd69a29 1252 context ? build_string (context) : empty_unibyte_string,
04d8c47d 1253 Vsignaling_function);
ff11dfa1 1254 /* If the window system or terminal frame hasn't been initialized
04d8c47d
RS
1255 yet, or we're not interactive, write the message to stderr and exit. */
1256 else if (!sf->glyphs_initialized_p
1257 /* This is the case of the frame dumped with Emacs, when we're
1258 running under a window system. */
1259 || (!NILP (Vwindow_system)
1260 && !inhibit_window_system
1261 && FRAME_TERMCAP_P (sf))
1262 || noninteractive)
1263 {
1264 print_error_message (data, Qexternal_debugging_output,
1265 context, Vsignaling_function);
1266 Fterpri (Qexternal_debugging_output);
1267 Fkill_emacs (make_number (-1));
7ee32cda 1268 }
284f4730
JB
1269 else
1270 {
04d8c47d 1271 clear_message (1, 0);
284f4730 1272 Fdiscard_input ();
dc4854ce 1273 message_log_maybe_newline ();
284f4730 1274 bitch_at_user ();
c60ee5e7 1275
04d8c47d
RS
1276 print_error_message (data, Qt, context, Vsignaling_function);
1277 }
a1341f75 1278
dc4854ce 1279 Vsignaling_function = Qnil;
284f4730
JB
1280}
1281\f
1282Lisp_Object command_loop_1 ();
1283Lisp_Object command_loop_2 ();
1284Lisp_Object top_level_1 ();
1285
1286/* Entry to editor-command-loop.
1287 This level has the catches for exiting/returning to editor command loop.
1288 It returns nil to exit recursive edit, t to abort it. */
1289
1290Lisp_Object
1291command_loop ()
1292{
1293 if (command_loop_level > 0 || minibuf_level > 0)
1294 {
07ba902e
RS
1295 Lisp_Object val;
1296 val = internal_catch (Qexit, command_loop_2, Qnil);
649d952d 1297 executing_kbd_macro = Qnil;
68c46464 1298 return val;
284f4730
JB
1299 }
1300 else
1301 while (1)
1302 {
1303 internal_catch (Qtop_level, top_level_1, Qnil);
e3ee34f0
RS
1304 /* Reset single_kboard in case top-level set it while
1305 evaluating an -f option, or we are stuck there for some
1306 other reason. */
1307 any_kboard_state ();
284f4730 1308 internal_catch (Qtop_level, command_loop_2, Qnil);
649d952d 1309 executing_kbd_macro = Qnil;
df0f2ba1 1310
284f4730
JB
1311 /* End of file in -batch run causes exit here. */
1312 if (noninteractive)
1313 Fkill_emacs (Qt);
1314 }
1315}
1316
1317/* Here we catch errors in execution of commands within the
1318 editing loop, and reenter the editing loop.
1319 When there is an error, cmd_error runs and returns a non-nil
27fd22dc 1320 value to us. A value of nil means that command_loop_1 itself
284f4730
JB
1321 returned due to end of file (or end of kbd macro). */
1322
1323Lisp_Object
1324command_loop_2 ()
1325{
1326 register Lisp_Object val;
1327
1328 do
1329 val = internal_condition_case (command_loop_1, Qerror, cmd_error);
1330 while (!NILP (val));
1331
1332 return Qnil;
1333}
1334
1335Lisp_Object
1336top_level_2 ()
1337{
1338 return Feval (Vtop_level);
1339}
1340
1341Lisp_Object
1342top_level_1 ()
1343{
1344 /* On entry to the outer level, run the startup file */
1345 if (!NILP (Vtop_level))
1346 internal_condition_case (top_level_2, Qerror, cmd_error);
1347 else if (!NILP (Vpurify_flag))
1348 message ("Bare impure Emacs (standard Lisp code not loaded)");
1349 else
1350 message ("Bare Emacs (standard Lisp code not loaded)");
1351 return Qnil;
1352}
1353
1354DEFUN ("top-level", Ftop_level, Stop_level, 0, 0, "",
4707d2d0
PJ
1355 doc: /* Exit all recursive editing levels. */)
1356 ()
284f4730 1357{
2c9cf2c8 1358#ifdef HAVE_X_WINDOWS
526a058f
GM
1359 if (display_hourglass_p)
1360 cancel_hourglass ();
2c9cf2c8 1361#endif
96edd5d4 1362
a25e44b2
JD
1363 /* Unblock input if we enter with input blocked. This may happen if
1364 redisplay traps e.g. during tool-bar update with input blocked. */
1365 while (INPUT_BLOCKED_P)
1366 UNBLOCK_INPUT;
1367
8c907a56 1368 return Fthrow (Qtop_level, Qnil);
284f4730
JB
1369}
1370
1371DEFUN ("exit-recursive-edit", Fexit_recursive_edit, Sexit_recursive_edit, 0, 0, "",
4707d2d0
PJ
1372 doc: /* Exit from the innermost recursive edit or minibuffer. */)
1373 ()
284f4730
JB
1374{
1375 if (command_loop_level > 0 || minibuf_level > 0)
1376 Fthrow (Qexit, Qnil);
1377
1378 error ("No recursive edit is in progress");
8c907a56 1379 return Qnil;
284f4730
JB
1380}
1381
1382DEFUN ("abort-recursive-edit", Fabort_recursive_edit, Sabort_recursive_edit, 0, 0, "",
4707d2d0
PJ
1383 doc: /* Abort the command that requested this recursive edit or minibuffer input. */)
1384 ()
284f4730
JB
1385{
1386 if (command_loop_level > 0 || minibuf_level > 0)
1387 Fthrow (Qexit, Qt);
1388
1389 error ("No recursive edit is in progress");
8c907a56 1390 return Qnil;
284f4730
JB
1391}
1392\f
ae372f41 1393#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
c5b76d6c
CY
1394
1395/* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1396 of this function. */
1397
1398static Lisp_Object
1399tracking_off (old_value)
1400 Lisp_Object old_value;
1401{
1402 do_mouse_tracking = old_value;
1403 if (NILP (old_value))
1404 {
1405 /* Redisplay may have been preempted because there was input
1406 available, and it assumes it will be called again after the
1407 input has been processed. If the only input available was
1408 the sort that we have just disabled, then we need to call
1409 redisplay. */
1410 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW))
1411 {
1412 redisplay_preserve_echo_area (6);
1413 get_input_pending (&input_pending,
1414 READABLE_EVENTS_DO_TIMERS_NOW);
1415 }
1416 }
1417 return Qnil;
1418}
1419
1420DEFUN ("track-mouse", Ftrack_mouse, Strack_mouse, 0, UNEVALLED, 0,
1421 doc: /* Evaluate BODY with mouse movement events enabled.
1422Within a `track-mouse' form, mouse motion generates input events that
1423you can read with `read-event'.
1424Normally, mouse motion is ignored.
d514369d 1425usage: (track-mouse BODY...) */)
c5b76d6c
CY
1426 (args)
1427 Lisp_Object args;
1428{
1429 int count = SPECPDL_INDEX ();
1430 Lisp_Object val;
1431
1432 record_unwind_protect (tracking_off, do_mouse_tracking);
1433
1434 do_mouse_tracking = Qt;
1435
1436 val = Fprogn (args);
1437 return unbind_to (count, val);
1438}
1439
1440/* If mouse has moved on some frame, return one of those frames.
3b0cdcef
KS
1441
1442 Return 0 otherwise.
1443
1444 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1445 after resizing the tool-bar window. */
1446
1447int ignore_mouse_drag_p;
c5b76d6c
CY
1448
1449static FRAME_PTR
1450some_mouse_moved ()
1451{
1452 Lisp_Object tail, frame;
1453
3b0cdcef
KS
1454 if (ignore_mouse_drag_p)
1455 {
e2bb07db 1456 /* ignore_mouse_drag_p = 0; */
3b0cdcef
KS
1457 return 0;
1458 }
1459
c5b76d6c
CY
1460 FOR_EACH_FRAME (tail, frame)
1461 {
1462 if (XFRAME (frame)->mouse_moved)
1463 return XFRAME (frame);
1464 }
1465
1466 return 0;
1467}
1468
ae372f41 1469#endif /* HAVE_MOUSE || HAVE_GPM */
c5b76d6c 1470\f
284f4730
JB
1471/* This is the actual command reading loop,
1472 sans error-handling encapsulation. */
1473
a7b772c1
GM
1474static int read_key_sequence P_ ((Lisp_Object *, int, Lisp_Object,
1475 int, int, int));
1476void safe_run_hooks P_ ((Lisp_Object));
2a026b04 1477static void adjust_point_for_property P_ ((int, int));
284f4730 1478
0af912f0
JD
1479/* Cancel hourglass from protect_unwind.
1480 ARG is not used. */
bb8db7e1 1481#ifdef HAVE_X_WINDOWS
0af912f0
JD
1482static Lisp_Object
1483cancel_hourglass_unwind (arg)
1484 Lisp_Object arg;
1485{
1486 cancel_hourglass ();
cea5d0d4 1487 return Qnil;
0af912f0 1488}
bb8db7e1 1489#endif
0af912f0 1490
284f4730
JB
1491Lisp_Object
1492command_loop_1 ()
1493{
03cee6ae
GM
1494 Lisp_Object cmd;
1495 int lose;
284f4730
JB
1496 int nonundocount;
1497 Lisp_Object keybuf[30];
1498 int i;
284f4730 1499 int no_direct;
a53fe666 1500 int prev_modiff = 0;
8c907a56 1501 struct buffer *prev_buffer = NULL;
c5fdd383 1502#ifdef MULTI_KBOARD
1e8bd3da 1503 int was_locked = single_kboard;
bded54dd 1504#endif
2764bebd 1505 int already_adjusted;
284f4730 1506
d9b641bb 1507 current_kboard->Vprefix_arg = Qnil;
75045dcb 1508 current_kboard->Vlast_prefix_arg = Qnil;
86e5706b 1509 Vdeactivate_mark = Qnil;
284f4730 1510 waiting_for_input = 0;
df0f2ba1 1511 cancel_echoing ();
284f4730 1512
284f4730 1513 nonundocount = 0;
284f4730 1514 this_command_key_count = 0;
63020c46 1515 this_command_key_count_reset = 0;
6321824f 1516 this_single_command_key_start = 0;
284f4730 1517
325309f5 1518 if (NILP (Vmemory_full))
59aadc81 1519 {
10ffcb64
RS
1520 /* Make sure this hook runs after commands that get errors and
1521 throw to top level. */
1522 /* Note that the value cell will never directly contain nil
1523 if the symbol is a local variable. */
1524 if (!NILP (Vpost_command_hook) && !NILP (Vrun_hooks))
1525 safe_run_hooks (Qpost_command_hook);
1526
1527 /* If displaying a message, resize the echo area window to fit
1528 that message's size exactly. */
1529 if (!NILP (echo_area_buffer[0]))
1530 resize_echo_area_exactly ();
1531
1532 if (!NILP (Vdeferred_action_list))
0b5d283f 1533 safe_run_hooks (Qdeferred_action_function);
59aadc81
RS
1534 }
1535
51d5a2c9 1536 /* Do this after running Vpost_command_hook, for consistency. */
d5eecefb
RS
1537 current_kboard->Vlast_command = Vthis_command;
1538 current_kboard->Vreal_last_command = real_this_command;
51d5a2c9 1539
284f4730
JB
1540 while (1)
1541 {
788f89eb 1542 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
a94a4335
KH
1543 Fkill_emacs (Qnil);
1544
284f4730
JB
1545 /* Make sure the current window's buffer is selected. */
1546 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
1547 set_buffer_internal (XBUFFER (XWINDOW (selected_window)->buffer));
1548
1549 /* Display any malloc warning that just came out. Use while because
1550 displaying one warning can cause another. */
1551
1552 while (pending_malloc_warning)
1553 display_malloc_warning ();
1554
1555 no_direct = 0;
1556
86e5706b
RS
1557 Vdeactivate_mark = Qnil;
1558
284f4730 1559 /* If minibuffer on and echo area in use,
00392ce6 1560 wait a short time and redraw minibuffer. */
284f4730 1561
7ee32cda 1562 if (minibuf_level
985f9f66 1563 && !NILP (echo_area_buffer[0])
2bcac766 1564 && EQ (minibuf_window, echo_area_window))
284f4730 1565 {
f1bed6d8
RS
1566 /* Bind inhibit-quit to t so that C-g gets read in
1567 rather than quitting back to the minibuffer. */
aed13378 1568 int count = SPECPDL_INDEX ();
f1bed6d8 1569 specbind (Qinhibit_quit, Qt);
f1bed6d8 1570
2bcac766
CY
1571 if (NUMBERP (Vminibuffer_message_timeout))
1572 sit_for (Vminibuffer_message_timeout, 0, 2);
1573 else
1574 sit_for (Qt, 0, 2);
666dc232 1575
e6aa7813 1576 /* Clear the echo area. */
301738ed 1577 message2 (0, 0, 0);
cdb9d665 1578 safe_run_hooks (Qecho_area_clear_hook);
e6aa7813 1579
db08707d
RS
1580 unbind_to (count, Qnil);
1581
e6aa7813 1582 /* If a C-g came in before, treat it as input now. */
284f4730
JB
1583 if (!NILP (Vquit_flag))
1584 {
1585 Vquit_flag = Qnil;
24597608 1586 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
284f4730
JB
1587 }
1588 }
1589
1590#ifdef C_ALLOCA
ff4b06d3 1591 alloca (0); /* Cause a garbage collection now */
284f4730
JB
1592 /* Since we can free the most stuff here. */
1593#endif /* C_ALLOCA */
1594
8f805655 1595#if 0
8f805655
JB
1596 /* Select the frame that the last event came from. Usually,
1597 switch-frame events will take care of this, but if some lisp
1598 code swallows a switch-frame event, we'll fix things up here.
1599 Is this a good idea? */
8c18cbfb 1600 if (FRAMEP (internal_last_event_frame)
788f89eb 1601 && !EQ (internal_last_event_frame, selected_frame))
f840fb39 1602 Fselect_frame (internal_last_event_frame);
284f4730 1603#endif
48e416d4
RS
1604 /* If it has changed current-menubar from previous value,
1605 really recompute the menubar from the value. */
a646e520
RS
1606 if (! NILP (Vlucid_menu_bar_dirty_flag)
1607 && !NILP (Ffboundp (Qrecompute_lucid_menubar)))
48e416d4
RS
1608 call0 (Qrecompute_lucid_menubar);
1609
71918b75
RS
1610 before_command_key_count = this_command_key_count;
1611 before_command_echo_length = echo_length ();
1612
d5eecefb
RS
1613 Vthis_command = Qnil;
1614 real_this_command = Qnil;
9d138659 1615 Vthis_original_command = Qnil;
d7437ef6 1616
8f805655 1617 /* Read next key sequence; i gets its length. */
ce98e608 1618 i = read_key_sequence (keybuf, sizeof keybuf / sizeof keybuf[0],
f571ae0d 1619 Qnil, 0, 1, 1);
8f805655 1620
6fac1409 1621 /* A filter may have run while we were reading the input. */
788f89eb 1622 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
a94a4335 1623 Fkill_emacs (Qnil);
6fac1409
RS
1624 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
1625 set_buffer_internal (XBUFFER (XWINDOW (selected_window)->buffer));
1626
8f805655
JB
1627 ++num_input_keys;
1628
284f4730
JB
1629 /* Now we have read a key sequence of length I,
1630 or else I is 0 and we found end of file. */
1631
1632 if (i == 0) /* End of file -- happens only in */
1633 return Qnil; /* a kbd macro, at the end. */
dcc408a0
RS
1634 /* -1 means read_key_sequence got a menu that was rejected.
1635 Just loop around and read another command. */
1636 if (i == -1)
1637 {
1638 cancel_echoing ();
1639 this_command_key_count = 0;
63020c46 1640 this_command_key_count_reset = 0;
6321824f 1641 this_single_command_key_start = 0;
ff4b06d3 1642 goto finalize;
dcc408a0 1643 }
284f4730 1644
284f4730
JB
1645 last_command_char = keybuf[i - 1];
1646
75c0b143
RS
1647 /* If the previous command tried to force a specific window-start,
1648 forget about that, in case this command moves point far away
c422836d
KH
1649 from that position. But also throw away beg_unchanged and
1650 end_unchanged information in that case, so that redisplay will
1651 update the whole window properly. */
1652 if (!NILP (XWINDOW (selected_window)->force_start))
1653 {
9351ebd0 1654 struct buffer *b;
c422836d 1655 XWINDOW (selected_window)->force_start = Qnil;
9351ebd0
GM
1656 b = XBUFFER (XWINDOW (selected_window)->buffer);
1657 BUF_BEG_UNCHANGED (b) = BUF_END_UNCHANGED (b) = 0;
c422836d 1658 }
75c0b143 1659
284f4730 1660 cmd = read_key_sequence_cmd;
ce0d2858 1661 if (!NILP (Vexecuting_kbd_macro))
284f4730
JB
1662 {
1663 if (!NILP (Vquit_flag))
1664 {
ce0d2858 1665 Vexecuting_kbd_macro = Qt;
284f4730
JB
1666 QUIT; /* Make some noise. */
1667 /* Will return since macro now empty. */
1668 }
1669 }
1670
1671 /* Do redisplay processing after this command except in special
e35b6123 1672 cases identified below. */
86e5706b
RS
1673 prev_buffer = current_buffer;
1674 prev_modiff = MODIFF;
8746da95 1675 last_point_position = PT;
bb0e1d19 1676 last_point_position_window = selected_window;
18cd2eeb 1677 XSETBUFFER (last_point_position_buffer, prev_buffer);
86e5706b 1678
adf5cb9c
KH
1679 /* By default, we adjust point to a boundary of a region that
1680 has such a property that should be treated intangible
1681 (e.g. composition, display). But, some commands will set
1682 this variable differently. */
1683 Vdisable_point_adjustment = Qnil;
a7b772c1 1684
be2488ca
GM
1685 /* Process filters and timers may have messed with deactivate-mark.
1686 reset it before we execute the command. */
1687 Vdeactivate_mark = Qnil;
1688
8b9940e6
KS
1689 /* Remap command through active keymaps */
1690 Vthis_original_command = cmd;
a34cb674 1691 if (SYMBOLP (cmd))
8b9940e6
KS
1692 {
1693 Lisp_Object cmd1;
9be34f7f 1694 if (cmd1 = Fcommand_remapping (cmd, Qnil, Qnil), !NILP (cmd1))
8b9940e6
KS
1695 cmd = cmd1;
1696 }
1697
284f4730
JB
1698 /* Execute the command. */
1699
d5eecefb
RS
1700 Vthis_command = cmd;
1701 real_this_command = cmd;
a98ea3f9
RS
1702 /* Note that the value cell will never directly contain nil
1703 if the symbol is a local variable. */
e98a93eb 1704 if (!NILP (Vpre_command_hook) && !NILP (Vrun_hooks))
a98ea3f9 1705 safe_run_hooks (Qpre_command_hook);
c60ee5e7 1706
2764bebd
RS
1707 already_adjusted = 0;
1708
d5eecefb 1709 if (NILP (Vthis_command))
284f4730
JB
1710 {
1711 /* nil means key is undefined. */
1bf0e604
SM
1712 Lisp_Object keys = Fvector (i, keybuf);
1713 keys = Fkey_description (keys, Qnil);
284f4730 1714 bitch_at_user ();
1bf0e604 1715 message_with_string ("%s is undefined", keys, 0);
c5fdd383 1716 current_kboard->defining_kbd_macro = Qnil;
284f4730 1717 update_mode_lines = 1;
d8bcf58e 1718 current_kboard->Vprefix_arg = Qnil;
284f4730
JB
1719 }
1720 else
1721 {
d8bcf58e 1722 if (NILP (current_kboard->Vprefix_arg) && ! no_direct)
284f4730 1723 {
75045dcb
RS
1724 /* In case we jump to directly_done. */
1725 Vcurrent_prefix_arg = current_kboard->Vprefix_arg;
1726
284f4730
JB
1727 /* Recognize some common commands in common situations and
1728 do them directly. */
d5eecefb 1729 if (EQ (Vthis_command, Qforward_char) && PT < ZV)
284f4730 1730 {
51ad8a68 1731 struct Lisp_Char_Table *dp
284f4730 1732 = window_display_table (XWINDOW (selected_window));
aaf35234 1733 lose = FETCH_CHAR (PT_BYTE);
8458ede6 1734 SET_PT (PT + 1);
d86ba5c5
RS
1735 if (! NILP (Vpost_command_hook))
1736 /* Put this before calling adjust_point_for_property
1737 so it will only get called once in any case. */
1738 goto directly_done;
22b94eeb
RS
1739 if (current_buffer == prev_buffer
1740 && last_point_position != PT
1741 && NILP (Vdisable_point_adjustment)
1742 && NILP (Vglobal_disable_point_adjustment))
1743 adjust_point_for_property (last_point_position, 0);
2764bebd
RS
1744 already_adjusted = 1;
1745 if (PT == last_point_position + 1
1746 && (dp
1747 ? (VECTORP (DISP_CHAR_VECTOR (dp, lose))
1748 ? XVECTOR (DISP_CHAR_VECTOR (dp, lose))->size == 1
1749 : (NILP (DISP_CHAR_VECTOR (dp, lose))
1750 && (lose >= 0x20 && lose < 0x7f)))
1751 : (lose >= 0x20 && lose < 0x7f))
37cd9f30
KH
1752 /* To extract the case of continuation on
1753 wide-column characters. */
8458ede6 1754 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE)) == 1)
284f4730
JB
1755 && (XFASTINT (XWINDOW (selected_window)->last_modified)
1756 >= MODIFF)
598ba4c7
RS
1757 && (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1758 >= OVERLAY_MODIFF)
284f4730 1759 && (XFASTINT (XWINDOW (selected_window)->last_point)
8001d352 1760 == PT - 1)
284f4730
JB
1761 && !windows_or_buffers_changed
1762 && EQ (current_buffer->selective_display, Qnil)
1763 && !detect_input_pending ()
962ae636 1764 && NILP (XWINDOW (selected_window)->column_number_displayed)
ce0d2858 1765 && NILP (Vexecuting_kbd_macro))
e35b6123 1766 direct_output_forward_char (1);
284f4730
JB
1767 goto directly_done;
1768 }
d5eecefb 1769 else if (EQ (Vthis_command, Qbackward_char) && PT > BEGV)
284f4730 1770 {
51ad8a68 1771 struct Lisp_Char_Table *dp
284f4730 1772 = window_display_table (XWINDOW (selected_window));
8458ede6 1773 SET_PT (PT - 1);
aaf35234 1774 lose = FETCH_CHAR (PT_BYTE);
d86ba5c5
RS
1775 if (! NILP (Vpost_command_hook))
1776 goto directly_done;
22b94eeb
RS
1777 if (current_buffer == prev_buffer
1778 && last_point_position != PT
1779 && NILP (Vdisable_point_adjustment)
1780 && NILP (Vglobal_disable_point_adjustment))
1781 adjust_point_for_property (last_point_position, 0);
2764bebd
RS
1782 already_adjusted = 1;
1783 if (PT == last_point_position - 1
1784 && (dp
1785 ? (VECTORP (DISP_CHAR_VECTOR (dp, lose))
1786 ? XVECTOR (DISP_CHAR_VECTOR (dp, lose))->size == 1
1787 : (NILP (DISP_CHAR_VECTOR (dp, lose))
1788 && (lose >= 0x20 && lose < 0x7f)))
1789 : (lose >= 0x20 && lose < 0x7f))
284f4730
JB
1790 && (XFASTINT (XWINDOW (selected_window)->last_modified)
1791 >= MODIFF)
598ba4c7
RS
1792 && (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1793 >= OVERLAY_MODIFF)
284f4730 1794 && (XFASTINT (XWINDOW (selected_window)->last_point)
8001d352 1795 == PT + 1)
284f4730
JB
1796 && !windows_or_buffers_changed
1797 && EQ (current_buffer->selective_display, Qnil)
1798 && !detect_input_pending ()
962ae636 1799 && NILP (XWINDOW (selected_window)->column_number_displayed)
ce0d2858 1800 && NILP (Vexecuting_kbd_macro))
e35b6123 1801 direct_output_forward_char (-1);
284f4730
JB
1802 goto directly_done;
1803 }
d5eecefb 1804 else if (EQ (Vthis_command, Qself_insert_command)
14e40288
SM
1805 /* Try this optimization only on char keystrokes. */
1806 && NATNUMP (last_command_char)
1807 && CHAR_VALID_P (XFASTINT (last_command_char), 0))
284f4730 1808 {
d86ba5c5
RS
1809 unsigned int c
1810 = translate_char (Vtranslation_table_for_input,
1811 XFASTINT (last_command_char), 0, 0, 0);
fc9cce4e 1812 int value;
ce0d2858 1813 if (NILP (Vexecuting_kbd_macro)
fc9cce4e 1814 && !EQ (minibuf_window, selected_window))
284f4730
JB
1815 {
1816 if (!nonundocount || nonundocount >= 20)
1817 {
1818 Fundo_boundary ();
1819 nonundocount = 0;
1820 }
1821 nonundocount++;
1822 }
c60ee5e7 1823
fc9cce4e
RS
1824 lose = ((XFASTINT (XWINDOW (selected_window)->last_modified)
1825 < MODIFF)
598ba4c7
RS
1826 || (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1827 < OVERLAY_MODIFF)
fc9cce4e
RS
1828 || (XFASTINT (XWINDOW (selected_window)->last_point)
1829 != PT)
4c61f38e 1830 || MODIFF <= SAVE_MODIFF
fc9cce4e
RS
1831 || windows_or_buffers_changed
1832 || !EQ (current_buffer->selective_display, Qnil)
1833 || detect_input_pending ()
962ae636 1834 || !NILP (XWINDOW (selected_window)->column_number_displayed)
ce0d2858 1835 || !NILP (Vexecuting_kbd_macro));
c60ee5e7 1836
fc9cce4e 1837 value = internal_self_insert (c, 0);
7ee32cda 1838
fc9cce4e
RS
1839 if (value == 2)
1840 nonundocount = 0;
1841
294d643a
RS
1842 if (! NILP (Vpost_command_hook))
1843 /* Put this before calling adjust_point_for_property
1844 so it will only get called once in any case. */
1845 goto directly_done;
1846
7ee32cda
GM
1847 /* VALUE == 1 when AFTER-CHANGE functions are
1848 installed which is the case most of the time
1849 because FONT-LOCK installs one. */
1850 if (!lose && !value)
e35b6123 1851 direct_output_for_insert (c);
284f4730
JB
1852 goto directly_done;
1853 }
1854 }
1855
1856 /* Here for a command that isn't executed directly */
1857
0af912f0 1858 {
7ee32cda 1859#ifdef HAVE_X_WINDOWS
0af912f0
JD
1860 int scount = SPECPDL_INDEX ();
1861
1862 if (display_hourglass_p
ce0d2858 1863 && NILP (Vexecuting_kbd_macro))
0af912f0
JD
1864 {
1865 record_unwind_protect (cancel_hourglass_unwind, Qnil);
1866 start_hourglass ();
1867 }
7ee32cda
GM
1868#endif
1869
0af912f0
JD
1870 nonundocount = 0;
1871 if (NILP (current_kboard->Vprefix_arg))
1872 Fundo_boundary ();
1873 Fcommand_execute (Vthis_command, Qnil, Qnil, Qnil);
d0c48478
GM
1874
1875#ifdef HAVE_X_WINDOWS
4fbcc9b1
PJ
1876 /* Do not check display_hourglass_p here, because
1877 Fcommand_execute could change it, but we should cancel
e1204d39
RS
1878 hourglass cursor anyway.
1879 But don't cancel the hourglass within a macro
1880 just because a command in the macro finishes. */
ce0d2858 1881 if (NILP (Vexecuting_kbd_macro))
0af912f0 1882 unbind_to (scount, Qnil);
d0c48478 1883#endif
0af912f0 1884 }
284f4730 1885 }
a764a753 1886 directly_done: ;
75045dcb 1887 current_kboard->Vlast_prefix_arg = Vcurrent_prefix_arg;
284f4730 1888
84ee6048
RS
1889 /* Note that the value cell will never directly contain nil
1890 if the symbol is a local variable. */
1891 if (!NILP (Vpost_command_hook) && !NILP (Vrun_hooks))
1892 safe_run_hooks (Qpost_command_hook);
1893
8f12e41d
GM
1894 /* If displaying a message, resize the echo area window to fit
1895 that message's size exactly. */
1896 if (!NILP (echo_area_buffer[0]))
f09c15ed 1897 resize_echo_area_exactly ();
8f12e41d 1898
84ee6048
RS
1899 if (!NILP (Vdeferred_action_list))
1900 safe_run_hooks (Qdeferred_action_function);
1901
284f4730 1902 /* If there is a prefix argument,
6c7178b9
KH
1903 1) We don't want Vlast_command to be ``universal-argument''
1904 (that would be dumb), so don't set Vlast_command,
284f4730
JB
1905 2) we want to leave echoing on so that the prefix will be
1906 echoed as part of this key sequence, so don't call
1907 cancel_echoing, and
1908 3) we want to leave this_command_key_count non-zero, so that
1909 read_char will realize that it is re-reading a character, and
217258d5
KH
1910 not echo it a second time.
1911
1912 If the command didn't actually create a prefix arg,
1913 but is merely a frame event that is transparent to prefix args,
1914 then the above doesn't apply. */
1915 if (NILP (current_kboard->Vprefix_arg) || CONSP (last_command_char))
284f4730 1916 {
d5eecefb
RS
1917 current_kboard->Vlast_command = Vthis_command;
1918 current_kboard->Vreal_last_command = real_this_command;
284f4730
JB
1919 cancel_echoing ();
1920 this_command_key_count = 0;
63020c46 1921 this_command_key_count_reset = 0;
6321824f 1922 this_single_command_key_start = 0;
284f4730 1923 }
86e5706b 1924
88ce066e 1925 if (!NILP (current_buffer->mark_active) && !NILP (Vrun_hooks))
86e5706b 1926 {
f28c1bd9
RS
1927 /* Setting transient-mark-mode to `only' is a way of
1928 turning it on for just one command. */
1929
1930 if (EQ (Vtransient_mark_mode, Qidentity))
1931 Vtransient_mark_mode = Qnil;
1932 if (EQ (Vtransient_mark_mode, Qonly))
1933 Vtransient_mark_mode = Qidentity;
1934
86e5706b
RS
1935 if (!NILP (Vdeactivate_mark) && !NILP (Vtransient_mark_mode))
1936 {
2e1a49ad
SM
1937 /* We could also call `deactivate'mark'. */
1938 if (EQ (Vtransient_mark_mode, Qlambda))
1939 Vtransient_mark_mode = Qnil;
1940 else
1941 {
1942 current_buffer->mark_active = Qnil;
1943 call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
1944 }
86e5706b
RS
1945 }
1946 else if (current_buffer != prev_buffer || MODIFF != prev_modiff)
1947 call1 (Vrun_hooks, intern ("activate-mark-hook"));
1948 }
ff4b06d3
KH
1949
1950 finalize:
adf5cb9c
KH
1951
1952 if (current_buffer == prev_buffer
1953 && last_point_position != PT
1954 && NILP (Vdisable_point_adjustment)
2764bebd
RS
1955 && NILP (Vglobal_disable_point_adjustment)
1956 && !already_adjusted)
2a026b04 1957 adjust_point_for_property (last_point_position, MODIFF != prev_modiff);
adf5cb9c 1958
ff4b06d3
KH
1959 /* Install chars successfully executed in kbd macro. */
1960
d8bcf58e
KH
1961 if (!NILP (current_kboard->defining_kbd_macro)
1962 && NILP (current_kboard->Vprefix_arg))
ff4b06d3
KH
1963 finalize_kbd_macro_chars ();
1964
c5fdd383 1965#ifdef MULTI_KBOARD
604ccd1d 1966 if (!was_locked)
1e8bd3da 1967 any_kboard_state ();
ff4b06d3 1968#endif
284f4730
JB
1969 }
1970}
1c9784c9 1971
adf5cb9c
KH
1972extern Lisp_Object Qcomposition, Qdisplay;
1973
1974/* Adjust point to a boundary of a region that has such a property
1975 that should be treated intangible. For the moment, we check
7e16ef60
SM
1976 `composition', `display' and `invisible' properties.
1977 LAST_PT is the last position of point. */
adf5cb9c 1978
14e40288
SM
1979extern Lisp_Object Qafter_string, Qbefore_string;
1980extern Lisp_Object get_pos_property P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
1981
adf5cb9c 1982static void
2a026b04 1983adjust_point_for_property (last_pt, modified)
adf5cb9c 1984 int last_pt;
2a026b04 1985 int modified;
adf5cb9c 1986{
7e16ef60
SM
1987 int beg, end;
1988 Lisp_Object val, overlay, tmp;
1989 int check_composition = 1, check_display = 1, check_invisible = 1;
0bbdffbd 1990 int orig_pt = PT;
adf5cb9c 1991
0bbdffbd
SM
1992 /* FIXME: cycling is probably not necessary because these properties
1993 can't be usefully combined anyway. */
7e16ef60 1994 while (check_composition || check_display || check_invisible)
adf5cb9c
KH
1995 {
1996 if (check_composition
1997 && PT > BEGV && PT < ZV
7e16ef60
SM
1998 && get_property_and_range (PT, Qcomposition, &val, &beg, &end, Qnil)
1999 && COMPOSITION_VALID_P (beg, end, val)
2000 && beg < PT /* && end > PT <- It's always the case. */
2001 && (last_pt <= beg || last_pt >= end))
adf5cb9c 2002 {
14e40288 2003 xassert (end > PT);
7e16ef60 2004 SET_PT (PT < last_pt ? beg : end);
14e40288 2005 check_display = check_invisible = 1;
adf5cb9c
KH
2006 }
2007 check_composition = 0;
2008 if (check_display
2009 && PT > BEGV && PT < ZV
7e16ef60
SM
2010 && !NILP (val = get_char_property_and_overlay
2011 (make_number (PT), Qdisplay, Qnil, &overlay))
3e9ac4b7 2012 && display_prop_intangible_p (val)
7e16ef60
SM
2013 && (!OVERLAYP (overlay)
2014 ? get_property_and_range (PT, Qdisplay, &val, &beg, &end, Qnil)
2015 : (beg = OVERLAY_POSITION (OVERLAY_START (overlay)),
2016 end = OVERLAY_POSITION (OVERLAY_END (overlay))))
4ca39724
KS
2017 && (beg < PT /* && end > PT <- It's always the case. */
2018 || (beg <= PT && STRINGP (val) && SCHARS (val) == 0)))
adf5cb9c 2019 {
14e40288 2020 xassert (end > PT);
4ca39724
KS
2021 SET_PT (PT < last_pt
2022 ? (STRINGP (val) && SCHARS (val) == 0 ? beg - 1 : beg)
2023 : end);
14e40288 2024 check_composition = check_invisible = 1;
adf5cb9c
KH
2025 }
2026 check_display = 0;
14e40288 2027 if (check_invisible && PT > BEGV && PT < ZV)
7e16ef60 2028 {
14e40288
SM
2029 int inv, ellipsis = 0;
2030 beg = end = PT;
2031
2032 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2033 while (end < ZV
2034 && !NILP (val = get_char_property_and_overlay
2035 (make_number (end), Qinvisible, Qnil, &overlay))
2036 && (inv = TEXT_PROP_MEANS_INVISIBLE (val)))
2037 {
2038 ellipsis = ellipsis || inv > 1
2039 || (OVERLAYP (overlay)
2040 && (!NILP (Foverlay_get (overlay, Qafter_string))
2041 || !NILP (Foverlay_get (overlay, Qbefore_string))));
2042 tmp = Fnext_single_char_property_change
2043 (make_number (end), Qinvisible, Qnil, Qnil);
2044 end = NATNUMP (tmp) ? XFASTINT (tmp) : ZV;
2045 }
2046 while (beg > BEGV
2047 && !NILP (val = get_char_property_and_overlay
2048 (make_number (beg - 1), Qinvisible, Qnil, &overlay))
2049 && (inv = TEXT_PROP_MEANS_INVISIBLE (val)))
2050 {
2051 ellipsis = ellipsis || inv > 1
2052 || (OVERLAYP (overlay)
2053 && (!NILP (Foverlay_get (overlay, Qafter_string))
2054 || !NILP (Foverlay_get (overlay, Qbefore_string))));
2055 tmp = Fprevious_single_char_property_change
2056 (make_number (beg), Qinvisible, Qnil, Qnil);
2057 beg = NATNUMP (tmp) ? XFASTINT (tmp) : BEGV;
2058 }
c60ee5e7 2059
14e40288
SM
2060 /* Move away from the inside area. */
2061 if (beg < PT && end > PT)
2062 {
0bbdffbd
SM
2063 SET_PT ((orig_pt == PT && (last_pt < beg || last_pt > end))
2064 /* We haven't moved yet (so we don't need to fear
2065 infinite-looping) and we were outside the range
2066 before (so either end of the range still corresponds
2067 to a move in the right direction): pretend we moved
2068 less than we actually did, so that we still have
2069 more freedom below in choosing which end of the range
2070 to go to. */
9465a86c 2071 ? (orig_pt = -1, PT < last_pt ? end : beg)
0bbdffbd
SM
2072 /* We either have moved already or the last point
2073 was already in the range: we don't get to choose
2074 which end of the range we have to go to. */
2075 : (PT < last_pt ? beg : end));
14e40288
SM
2076 check_composition = check_display = 1;
2077 }
a874691c
MB
2078#if 0 /* This assertion isn't correct, because SET_PT may end up setting
2079 the point to something other than its argument, due to
2080 point-motion hooks, intangibility, etc. */
14e40288 2081 xassert (PT == beg || PT == end);
a874691c
MB
2082#endif
2083
2a026b04
KH
2084 /* Pretend the area doesn't exist if the buffer is not
2085 modified. */
2086 if (!modified && !ellipsis && beg < end)
14e40288
SM
2087 {
2088 if (last_pt == beg && PT == end && end < ZV)
2089 (check_composition = check_display = 1, SET_PT (end + 1));
2090 else if (last_pt == end && PT == beg && beg > BEGV)
2091 (check_composition = check_display = 1, SET_PT (beg - 1));
2092 else if (PT == ((PT < last_pt) ? beg : end))
2093 /* We've already moved as far as we can. Trying to go
2094 to the other end would mean moving backwards and thus
2095 could lead to an infinite loop. */
2096 ;
2097 else if (val = get_pos_property (make_number (PT),
2098 Qinvisible, Qnil),
2099 TEXT_PROP_MEANS_INVISIBLE (val)
2100 && (val = get_pos_property
2101 (make_number (PT == beg ? end : beg),
2102 Qinvisible, Qnil),
2103 !TEXT_PROP_MEANS_INVISIBLE (val)))
2104 (check_composition = check_display = 1,
2105 SET_PT (PT == beg ? end : beg));
2106 }
7e16ef60
SM
2107 }
2108 check_invisible = 0;
adf5cb9c
KH
2109 }
2110}
2111
0bc3db2b
RS
2112/* Subroutine for safe_run_hooks: run the hook HOOK. */
2113
2114static Lisp_Object
2115safe_run_hooks_1 (hook)
2116 Lisp_Object hook;
2117{
5e093f44
RS
2118 if (NILP (Vrun_hooks))
2119 return Qnil;
0bc3db2b
RS
2120 return call1 (Vrun_hooks, Vinhibit_quit);
2121}
2122
2123/* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2124
2125static Lisp_Object
2126safe_run_hooks_error (data)
2127 Lisp_Object data;
2128{
adec392e
SM
2129 Lisp_Object args[3];
2130 args[0] = build_string ("Error in %s: %s");
2131 args[1] = Vinhibit_quit;
2132 args[2] = data;
2133 Fmessage (3, args);
30690496 2134 return Fset (Vinhibit_quit, Qnil);
0bc3db2b
RS
2135}
2136
1c9784c9
KH
2137/* If we get an error while running the hook, cause the hook variable
2138 to be nil. Also inhibit quits, so that C-g won't cause the hook
2139 to mysteriously evaporate. */
0bc3db2b 2140
68f297c5 2141void
1c9784c9 2142safe_run_hooks (hook)
a98ea3f9 2143 Lisp_Object hook;
1c9784c9 2144{
aed13378 2145 int count = SPECPDL_INDEX ();
0bc3db2b
RS
2146 specbind (Qinhibit_quit, hook);
2147
e702932d 2148 internal_condition_case (safe_run_hooks_1, Qt, safe_run_hooks_error);
1c9784c9
KH
2149
2150 unbind_to (count, Qnil);
2151}
8a9f5d3c 2152
284f4730 2153\f
8a9f5d3c
GM
2154/* Number of seconds between polling for input. This is a Lisp
2155 variable that can be bound. */
2156
31ade731 2157EMACS_INT polling_period;
284f4730 2158
eb8c3be9 2159/* Nonzero means polling for input is temporarily suppressed. */
8a9f5d3c 2160
284f4730
JB
2161int poll_suppress_count;
2162
8a9f5d3c
GM
2163/* Asynchronous timer for polling. */
2164
2165struct atimer *poll_timer;
2166
284f4730 2167
36922b18
RS
2168#ifdef POLL_FOR_INPUT
2169
8a9f5d3c
GM
2170/* Poll for input, so what we catch a C-g if it comes in. This
2171 function is called from x_make_frame_visible, see comment
2172 there. */
284f4730 2173
8a9f5d3c
GM
2174void
2175poll_for_input_1 ()
284f4730 2176{
9ac0d9e0
JB
2177 if (interrupt_input_blocked == 0
2178 && !waiting_for_input)
2179 read_avail_input (0);
284f4730
JB
2180}
2181
8a9f5d3c
GM
2182/* Timer callback function for poll_timer. TIMER is equal to
2183 poll_timer. */
2184
2185void
2186poll_for_input (timer)
2187 struct atimer *timer;
2188{
2189 if (poll_suppress_count == 0)
a42bf890
YM
2190#ifdef SYNC_INPUT
2191 interrupt_input_pending = 1;
2192#else
8a9f5d3c 2193 poll_for_input_1 ();
a42bf890 2194#endif
8a9f5d3c
GM
2195}
2196
2197#endif /* POLL_FOR_INPUT */
284f4730
JB
2198
2199/* Begin signals to poll for input, if they are appropriate.
2200 This function is called unconditionally from various places. */
2201
07a59269 2202void
284f4730
JB
2203start_polling ()
2204{
2205#ifdef POLL_FOR_INPUT
34f04431 2206 if (read_socket_hook && !interrupt_input)
284f4730 2207 {
8a9f5d3c
GM
2208 /* Turn alarm handling on unconditionally. It might have
2209 been turned off in process.c. */
2210 turn_on_atimers (1);
c60ee5e7 2211
8a9f5d3c
GM
2212 /* If poll timer doesn't exist, are we need one with
2213 a different interval, start a new one. */
2214 if (poll_timer == NULL
2215 || EMACS_SECS (poll_timer->interval) != polling_period)
284f4730 2216 {
8a9f5d3c
GM
2217 EMACS_TIME interval;
2218
2219 if (poll_timer)
2220 cancel_atimer (poll_timer);
c60ee5e7 2221
8a9f5d3c
GM
2222 EMACS_SET_SECS_USECS (interval, polling_period, 0);
2223 poll_timer = start_atimer (ATIMER_CONTINUOUS, interval,
2224 poll_for_input, NULL);
284f4730 2225 }
8a9f5d3c
GM
2226
2227 /* Let the timer's callback function poll for input
2228 if this becomes zero. */
2229 --poll_suppress_count;
284f4730
JB
2230 }
2231#endif
2232}
2233
1d3195db
RS
2234/* Nonzero if we are using polling to handle input asynchronously. */
2235
2236int
2237input_polling_used ()
2238{
2239#ifdef POLL_FOR_INPUT
2240 return read_socket_hook && !interrupt_input;
2241#else
2242 return 0;
2243#endif
2244}
2245
284f4730
JB
2246/* Turn off polling. */
2247
07a59269 2248void
284f4730
JB
2249stop_polling ()
2250{
2251#ifdef POLL_FOR_INPUT
34f04431 2252 if (read_socket_hook && !interrupt_input)
8a9f5d3c 2253 ++poll_suppress_count;
284f4730
JB
2254#endif
2255}
fe8aeef3
RS
2256
2257/* Set the value of poll_suppress_count to COUNT
2258 and start or stop polling accordingly. */
2259
2260void
2261set_poll_suppress_count (count)
2262 int count;
2263{
2264#ifdef POLL_FOR_INPUT
2265 if (count == 0 && poll_suppress_count != 0)
2266 {
2267 poll_suppress_count = 1;
2268 start_polling ();
2269 }
2270 else if (count != 0 && poll_suppress_count == 0)
2271 {
2272 stop_polling ();
2273 }
2274 poll_suppress_count = count;
2275#endif
2276}
f4eef8b4 2277
d0a57728
RS
2278/* Bind polling_period to a value at least N.
2279 But don't decrease it. */
2280
07a59269 2281void
f4eef8b4
RS
2282bind_polling_period (n)
2283 int n;
2284{
2285#ifdef POLL_FOR_INPUT
d0a57728
RS
2286 int new = polling_period;
2287
2288 if (n > new)
2289 new = n;
2290
6fe007f7 2291 stop_other_atimers (poll_timer);
f4eef8b4 2292 stop_polling ();
d0a57728
RS
2293 specbind (Qpolling_period, make_number (new));
2294 /* Start a new alarm with the new period. */
f4eef8b4
RS
2295 start_polling ();
2296#endif
2297}
284f4730 2298\f
6da3dd3a
RS
2299/* Apply the control modifier to CHARACTER. */
2300
faf5e407
JB
2301int
2302make_ctrl_char (c)
2303 int c;
2304{
d205953b
JB
2305 /* Save the upper bits here. */
2306 int upper = c & ~0177;
2307
2308 c &= 0177;
2309
2310 /* Everything in the columns containing the upper-case letters
2311 denotes a control character. */
2312 if (c >= 0100 && c < 0140)
2313 {
2314 int oc = c;
2315 c &= ~0140;
2316 /* Set the shift modifier for a control char
2317 made from a shifted letter. But only for letters! */
2318 if (oc >= 'A' && oc <= 'Z')
2319 c |= shift_modifier;
2320 }
2321
2322 /* The lower-case letters denote control characters too. */
2323 else if (c >= 'a' && c <= 'z')
2324 c &= ~0140;
2325
2326 /* Include the bits for control and shift
2327 only if the basic ASCII code can't indicate them. */
2328 else if (c >= ' ')
2329 c |= ctrl_modifier;
2330
2331 /* Replace the high bits. */
2332 c |= (upper & ~ctrl_modifier);
faf5e407
JB
2333
2334 return c;
2335}
2336
bb8c4865
RS
2337/* Display the help-echo property of the character after the mouse pointer.
2338 Either show it in the echo area, or call show-help-function to display
2339 it by other means (maybe in a tooltip).
d4e68eea 2340
bb8c4865
RS
2341 If HELP is nil, that means clear the previous help echo.
2342
2343 If HELP is a string, display that string. If HELP is a function,
2344 call it with OBJECT and POS as arguments; the function should
2345 return a help string or nil for none. For all other types of HELP,
2346 evaluate it to obtain a string.
8dfd92c9 2347
2190735a
GM
2348 WINDOW is the window in which the help was generated, if any.
2349 It is nil if not in a window.
2350
5b2ec2d0
GM
2351 If OBJECT is a buffer, POS is the position in the buffer where the
2352 `help-echo' text property was found.
2353
2354 If OBJECT is an overlay, that overlay has a `help-echo' property,
2355 and POS is the position in the overlay's buffer under the mouse.
2356
2357 If OBJECT is a string (an overlay string or a string displayed with
2358 the `display' property). POS is the position in that string under
2359 the mouse.
d4e68eea 2360
27fd22dc 2361 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
d4e68eea
GM
2362 echo overwrites a keystroke echo currently displayed in the echo
2363 area.
2364
8dfd92c9
GM
2365 Note: this function may only be called with HELP nil or a string
2366 from X code running asynchronously. */
d4e68eea 2367
31f84d03 2368void
2190735a
GM
2369show_help_echo (help, window, object, pos, ok_to_overwrite_keystroke_echo)
2370 Lisp_Object help, window, object, pos;
adc84f48 2371 int ok_to_overwrite_keystroke_echo;
31f84d03 2372{
8dfd92c9 2373 if (!NILP (help) && !STRINGP (help))
d4e68eea 2374 {
8dfd92c9
GM
2375 if (FUNCTIONP (help))
2376 {
2190735a 2377 Lisp_Object args[4];
8dfd92c9 2378 args[0] = help;
2190735a
GM
2379 args[1] = window;
2380 args[2] = object;
2381 args[3] = pos;
1db0076e 2382 help = safe_call (4, args);
8dfd92c9
GM
2383 }
2384 else
1db0076e 2385 help = safe_eval (help);
c60ee5e7 2386
8dfd92c9 2387 if (!STRINGP (help))
d4e68eea 2388 return;
31f84d03
SM
2389 }
2390
ae372f41 2391#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
c22237f7 2392 if (!noninteractive && STRINGP (help))
c5b76d6c
CY
2393 {
2394 /* The mouse-fixup-help-message Lisp function can call
2395 mouse_position_hook, which resets the mouse_moved flags.
2396 This causes trouble if we are trying to read a mouse motion
2397 event (i.e., if we are inside a `track-mouse' form), so we
2398 restore the mouse_moved flag. */
2399 FRAME_PTR f = NILP (do_mouse_tracking) ? NULL : some_mouse_moved ();
2400 help = call1 (Qmouse_fixup_help_message, help);
2401 if (f)
2402 f->mouse_moved = 1;
2403 }
c22237f7
KS
2404#endif
2405
8dfd92c9 2406 if (STRINGP (help) || NILP (help))
d4e68eea
GM
2407 {
2408 if (!NILP (Vshow_help_function))
8dfd92c9 2409 call1 (Vshow_help_function, help);
d4e68eea
GM
2410 else if (/* Don't overwrite minibuffer contents. */
2411 !MINI_WINDOW_P (XWINDOW (selected_window))
2412 /* Don't overwrite a keystroke echo. */
8dfd92c9
GM
2413 && (NILP (echo_message_buffer)
2414 || ok_to_overwrite_keystroke_echo)
d4e68eea
GM
2415 /* Don't overwrite a prompt. */
2416 && !cursor_in_echo_area)
2417 {
8dfd92c9 2418 if (STRINGP (help))
d4e68eea 2419 {
331379bf 2420 int count = SPECPDL_INDEX ();
f0c1cc56
GM
2421
2422 if (!help_echo_showing_p)
2423 Vpre_help_message = current_message ();
c60ee5e7 2424
d4e68eea 2425 specbind (Qmessage_truncate_lines, Qt);
d5db4077 2426 message3_nolog (help, SBYTES (help),
8dfd92c9 2427 STRING_MULTIBYTE (help));
d4e68eea
GM
2428 unbind_to (count, Qnil);
2429 }
f0c1cc56
GM
2430 else if (STRINGP (Vpre_help_message))
2431 {
2432 message3_nolog (Vpre_help_message,
d5db4077 2433 SBYTES (Vpre_help_message),
f0c1cc56
GM
2434 STRING_MULTIBYTE (Vpre_help_message));
2435 Vpre_help_message = Qnil;
2436 }
d4e68eea 2437 else
f0c1cc56 2438 message (0);
d4e68eea 2439 }
c60ee5e7 2440
5295a500 2441 help_echo_showing_p = STRINGP (help);
d4e68eea 2442 }
31f84d03
SM
2443}
2444
faf5e407
JB
2445
2446\f
284f4730
JB
2447/* Input of single characters from keyboard */
2448
2449Lisp_Object print_help ();
2450static Lisp_Object kbd_buffer_get_event ();
e4fe371d 2451static void record_char ();
284f4730 2452
638d3da0
CY
2453static Lisp_Object help_form_saved_window_configs;
2454static Lisp_Object
2455read_char_help_form_unwind (arg)
2456{
2457 Lisp_Object window_config = XCAR (help_form_saved_window_configs);
2458 help_form_saved_window_configs = XCDR (help_form_saved_window_configs);
2459 if (!NILP (window_config))
2460 Fset_window_configuration (window_config);
2461 return Qnil;
2462}
2463
c5fdd383
KH
2464#ifdef MULTI_KBOARD
2465static jmp_buf wrong_kboard_jmpbuf;
bded54dd 2466#endif
beecf6a1 2467
184c3d81
RS
2468#define STOP_POLLING \
2469do { if (! polling_stopped_here) stop_polling (); \
2470 polling_stopped_here = 1; } while (0)
2471
2472#define RESUME_POLLING \
2473do { if (polling_stopped_here) start_polling (); \
2474 polling_stopped_here = 0; } while (0)
2475
284f4730
JB
2476/* read a character from the keyboard; call the redisplay if needed */
2477/* commandflag 0 means do not do auto-saving, but do do redisplay.
2478 -1 means do not do redisplay, but do do autosaving.
2479 1 means do both. */
2480
7d6de002
RS
2481/* The arguments MAPS and NMAPS are for menu prompting.
2482 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2483
2484 PREV_EVENT is the previous input event, or nil if we are reading
b638f328
RS
2485 the first event of a key sequence (or not reading a key sequence).
2486 If PREV_EVENT is t, that is a "magic" value that says
2487 not to run input methods, but in other respects to act as if
2488 not reading a key sequence.
7d6de002 2489
83d68044 2490 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
6569cc8d 2491 if we used a mouse menu to read the input, or zero otherwise. If
83d68044 2492 USED_MOUSE_MENU is null, we don't dereference it.
dcc408a0 2493
179f689c
CY
2494 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2495 specifying the maximum time to wait until. If no input arrives by
2496 that time, stop waiting and return nil.
2497
dcc408a0 2498 Value is t if we showed a menu and the user rejected it. */
7d6de002 2499
284f4730 2500Lisp_Object
179f689c 2501read_char (commandflag, nmaps, maps, prev_event, used_mouse_menu, end_time)
284f4730 2502 int commandflag;
7d6de002
RS
2503 int nmaps;
2504 Lisp_Object *maps;
2505 Lisp_Object prev_event;
2506 int *used_mouse_menu;
179f689c 2507 EMACS_TIME *end_time;
284f4730 2508{
8c907a56 2509 volatile Lisp_Object c;
092869b9 2510 int count, jmpcount;
410d4de9 2511 jmp_buf local_getcjmp;
284f4730 2512 jmp_buf save_jump;
8c907a56 2513 volatile int key_already_recorded = 0;
017c7cb6 2514 Lisp_Object tem, save;
8c907a56
GM
2515 volatile Lisp_Object previous_echo_area_message;
2516 volatile Lisp_Object also_record;
2517 volatile int reread;
d5eecefb 2518 struct gcpro gcpro1, gcpro2;
184c3d81 2519 int polling_stopped_here = 0;
7c3bc944 2520
e4fe371d 2521 also_record = Qnil;
284f4730 2522
22b94eeb 2523#if 0 /* This was commented out as part of fixing echo for C-u left. */
71918b75
RS
2524 before_command_key_count = this_command_key_count;
2525 before_command_echo_length = echo_length ();
22b94eeb 2526#endif
ef6661f7 2527 c = Qnil;
7ee32cda 2528 previous_echo_area_message = Qnil;
71918b75 2529
7ee32cda 2530 GCPRO2 (c, previous_echo_area_message);
7c3bc944 2531
7f07d5ca
RS
2532 retry:
2533
7d18f9ae
RS
2534 reread = 0;
2535 if (CONSP (Vunread_post_input_method_events))
284f4730 2536 {
7539e11f 2537 c = XCAR (Vunread_post_input_method_events);
7d18f9ae 2538 Vunread_post_input_method_events
7539e11f 2539 = XCDR (Vunread_post_input_method_events);
284f4730 2540
2479e91e
RS
2541 /* Undo what read_char_x_menu_prompt did when it unread
2542 additional keys returned by Fx_popup_menu. */
2543 if (CONSP (c)
7539e11f
KR
2544 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c)))
2545 && NILP (XCDR (c)))
2546 c = XCAR (c);
2479e91e 2547
7d18f9ae
RS
2548 reread = 1;
2549 goto reread_first;
284f4730
JB
2550 }
2551
86e5706b
RS
2552 if (unread_command_char != -1)
2553 {
18cd2eeb 2554 XSETINT (c, unread_command_char);
86e5706b
RS
2555 unread_command_char = -1;
2556
7d18f9ae
RS
2557 reread = 1;
2558 goto reread_first;
2559 }
2560
2561 if (CONSP (Vunread_command_events))
2562 {
7539e11f
KR
2563 c = XCAR (Vunread_command_events);
2564 Vunread_command_events = XCDR (Vunread_command_events);
7d18f9ae 2565
96f4f7ec
KS
2566 reread = 1;
2567
2568 /* Undo what sit-for did when it unread additional keys
2569 inside universal-argument. */
2570
2571 if (CONSP (c)
2572 && EQ (XCAR (c), Qt))
2573 {
2574 reread = 0;
2575 c = XCDR (c);
2576 }
2577
7d18f9ae
RS
2578 /* Undo what read_char_x_menu_prompt did when it unread
2579 additional keys returned by Fx_popup_menu. */
2580 if (CONSP (c)
f4e05d97
GM
2581 && EQ (XCDR (c), Qdisabled)
2582 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c))))
7539e11f 2583 c = XCAR (c);
c60ee5e7 2584
d17e49a8
GM
2585 /* If the queued event is something that used the mouse,
2586 set used_mouse_menu accordingly. */
2587 if (used_mouse_menu
2588 && (EQ (c, Qtool_bar) || EQ (c, Qmenu_bar)))
2589 *used_mouse_menu = 1;
c60ee5e7 2590
7d18f9ae
RS
2591 goto reread_for_input_method;
2592 }
2593
2594 if (CONSP (Vunread_input_method_events))
2595 {
7539e11f
KR
2596 c = XCAR (Vunread_input_method_events);
2597 Vunread_input_method_events = XCDR (Vunread_input_method_events);
7d18f9ae
RS
2598
2599 /* Undo what read_char_x_menu_prompt did when it unread
2600 additional keys returned by Fx_popup_menu. */
2601 if (CONSP (c)
7539e11f
KR
2602 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c)))
2603 && NILP (XCDR (c)))
2604 c = XCAR (c);
7d18f9ae
RS
2605 reread = 1;
2606 goto reread_for_input_method;
86e5706b
RS
2607 }
2608
63020c46
RS
2609 this_command_key_count_reset = 0;
2610
ce0d2858 2611 if (!NILP (Vexecuting_kbd_macro))
284f4730 2612 {
fce33686
JB
2613 /* We set this to Qmacro; since that's not a frame, nobody will
2614 try to switch frames on us, and the selected window will
2615 remain unchanged.
2616
2617 Since this event came from a macro, it would be misleading to
eb8c3be9 2618 leave internal_last_event_frame set to wherever the last
3c370943
JB
2619 real event came from. Normally, a switch-frame event selects
2620 internal_last_event_frame after each command is read, but
2621 events read from a macro should never cause a new frame to be
2622 selected. */
4c52b668 2623 Vlast_event_frame = internal_last_event_frame = Qmacro;
fce33686 2624
663258f2
JB
2625 /* Exit the macro if we are at the end.
2626 Also, some things replace the macro with t
2627 to force an early exit. */
ce0d2858 2628 if (EQ (Vexecuting_kbd_macro, Qt)
649d952d 2629 || executing_kbd_macro_index >= XFASTINT (Flength (Vexecuting_kbd_macro)))
284f4730 2630 {
18cd2eeb 2631 XSETINT (c, -1);
184c3d81 2632 goto exit;
284f4730 2633 }
df0f2ba1 2634
649d952d 2635 c = Faref (Vexecuting_kbd_macro, make_number (executing_kbd_macro_index));
ce0d2858 2636 if (STRINGP (Vexecuting_kbd_macro)
d5161e8c 2637 && (XINT (c) & 0x80) && (XUINT (c) <= 0xff))
bb9e9bed 2638 XSETFASTINT (c, CHAR_META | (XINT (c) & ~0x80));
86e5706b 2639
649d952d 2640 executing_kbd_macro_index++;
284f4730
JB
2641
2642 goto from_macro;
2643 }
2644
cd21b839
JB
2645 if (!NILP (unread_switch_frame))
2646 {
2647 c = unread_switch_frame;
2648 unread_switch_frame = Qnil;
2649
2650 /* This event should make it into this_command_keys, and get echoed
7d18f9ae 2651 again, so we do not set `reread'. */
f4255cd1 2652 goto reread_first;
cd21b839
JB
2653 }
2654
adc1d5c8 2655 /* if redisplay was requested */
6e4e64a8
RS
2656 if (commandflag >= 0)
2657 {
adc1d5c8
RS
2658 /* If there is pending input, process any events which are not
2659 user-visible, such as X selection_request events. */
6e4e64a8
RS
2660 if (input_pending
2661 || detect_input_pending_run_timers (0))
adc1d5c8 2662 swallow_events (0); /* may clear input_pending */
6e4e64a8 2663
adc1d5c8
RS
2664 /* Redisplay if no pending input. */
2665 while (!input_pending)
2666 {
5295a500 2667 if (help_echo_showing_p && !EQ (selected_window, minibuf_window))
3007ebfb 2668 redisplay_preserve_echo_area (5);
5295a500
GM
2669 else
2670 redisplay ();
adc1d5c8
RS
2671
2672 if (!input_pending)
2673 /* Normal case: no input arrived during redisplay. */
2674 break;
2675
2676 /* Input arrived and pre-empted redisplay.
2677 Process any events which are not user-visible. */
2678 swallow_events (0);
2679 /* If that cleared input_pending, try again to redisplay. */
2680 }
6e4e64a8 2681 }
e9bf89a0 2682
59a84f8e 2683 /* Message turns off echoing unless more keystrokes turn it on again.
c60ee5e7 2684
59a84f8e
GM
2685 The code in 20.x for the condition was
2686
2687 1. echo_area_glyphs && *echo_area_glyphs
2688 2. && echo_area_glyphs != current_kboard->echobuf
2689 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2690
2691 (1) means there's a current message displayed
c60ee5e7 2692
59a84f8e
GM
2693 (2) means it's not the message from echoing from the current
2694 kboard.
c60ee5e7 2695
59a84f8e
GM
2696 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2697 is set to a non-null value. This is done in read_char and it is
2698 set to echo_area_glyphs after a call to echo_char. That means
2699 ok_to_echo_at_next_pause is either null or
2700 current_kboard->echobuf with the appropriate current_kboard at
2701 that time.
2702
2703 So, condition (3) means in clear text ok_to_echo_at_next_pause
2704 must be either null, or the current message isn't from echoing at
2705 all, or it's from echoing from a different kboard than the
2706 current one. */
c60ee5e7 2707
27fd22dc 2708 if (/* There currently is something in the echo area. */
985f9f66 2709 !NILP (echo_area_buffer[0])
59a84f8e
GM
2710 && (/* And it's either not from echoing. */
2711 !EQ (echo_area_buffer[0], echo_message_buffer)
2712 /* Or it's an echo from a different kboard. */
2713 || echo_kboard != current_kboard
2714 /* Or we explicitly allow overwriting whatever there is. */
2715 || ok_to_echo_at_next_pause == NULL))
7ee32cda 2716 cancel_echoing ();
410d4de9 2717 else
410d4de9 2718 echo_dash ();
c60ee5e7 2719
410d4de9
RS
2720 /* Try reading a character via menu prompting in the minibuf.
2721 Try this before the sit-for, because the sit-for
2722 would do the wrong thing if we are supposed to do
2723 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2724 after a mouse event so don't try a minibuf menu. */
2725 c = Qnil;
2726 if (nmaps > 0 && INTERACTIVE
2727 && !NILP (prev_event) && ! EVENT_HAS_PARAMETERS (prev_event)
2728 /* Don't bring up a menu if we already have another event. */
2729 && NILP (Vunread_command_events)
2730 && unread_command_char < 0
4ec4ed6a 2731 && !detect_input_pending_run_timers (0))
410d4de9
RS
2732 {
2733 c = read_char_minibuf_menu_prompt (commandflag, nmaps, maps);
2734 if (! NILP (c))
2735 {
2736 key_already_recorded = 1;
2737 goto non_reread_1;
2738 }
2739 }
284f4730 2740
410d4de9
RS
2741 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2742 We will do that below, temporarily for short sections of code,
2743 when appropriate. local_getcjmp must be in effect
2744 around any call to sit_for or kbd_buffer_get_event;
2745 it *must not* be in effect when we call redisplay. */
284f4730 2746
092869b9 2747 jmpcount = SPECPDL_INDEX ();
410d4de9 2748 if (_setjmp (local_getcjmp))
284f4730 2749 {
dfbfad25
RS
2750 /* We must have saved the outer value of getcjmp here,
2751 so restore it now. */
2752 restore_getcjmp (save_jump);
092869b9 2753 unbind_to (jmpcount, Qnil);
18cd2eeb 2754 XSETINT (c, quit_char);
788f89eb 2755 internal_last_event_frame = selected_frame;
4c52b668 2756 Vlast_event_frame = internal_last_event_frame;
04904c29
RS
2757 /* If we report the quit char as an event,
2758 don't do so more than once. */
2759 if (!NILP (Vinhibit_quit))
2760 Vquit_flag = Qnil;
284f4730 2761
c5fdd383 2762#ifdef MULTI_KBOARD
df0f2ba1 2763 {
788f89eb 2764 KBOARD *kb = FRAME_KBOARD (XFRAME (selected_frame));
c5fdd383 2765 if (kb != current_kboard)
df0f2ba1 2766 {
f3fbd155 2767 Lisp_Object link = kb->kbd_queue;
1e8bd3da
RS
2768 /* We shouldn't get here if we were in single-kboard mode! */
2769 if (single_kboard)
df0f2ba1 2770 abort ();
f3fbd155
KR
2771 if (CONSP (link))
2772 {
2773 while (CONSP (XCDR (link)))
2774 link = XCDR (link);
2775 if (!NILP (XCDR (link)))
2776 abort ();
2777 }
2778 if (!CONSP (link))
2779 kb->kbd_queue = Fcons (c, Qnil);
2780 else
2781 XSETCDR (link, Fcons (c, Qnil));
c5fdd383
KH
2782 kb->kbd_queue_has_data = 1;
2783 current_kboard = kb;
ef6661f7
RS
2784 /* This is going to exit from read_char
2785 so we had better get rid of this frame's stuff. */
2786 UNGCPRO;
c5fdd383 2787 longjmp (wrong_kboard_jmpbuf, 1);
df0f2ba1
KH
2788 }
2789 }
2790#endif
284f4730
JB
2791 goto non_reread;
2792 }
2793
3236e6b8
CY
2794 /* Start idle timers if no time limit is supplied. We don't do it
2795 if a time limit is supplied to avoid an infinite recursion in the
2796 situation where an idle timer calls `sit-for'. */
70282fce 2797
3236e6b8 2798 if (!end_time)
70282fce 2799 timer_start_idle ();
d9d4c147 2800
284f4730
JB
2801 /* If in middle of key sequence and minibuffer not active,
2802 start echoing if enough time elapses. */
410d4de9 2803
c60ee5e7 2804 if (minibuf_level == 0
179f689c 2805 && !end_time
7ee32cda 2806 && !current_kboard->immediate_echo
6c6083a9 2807 && this_command_key_count > 0
27203ead 2808 && ! noninteractive
f2647d04
DL
2809 && (FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
2810 && NILP (Fzerop (Vecho_keystrokes))
985f9f66
GM
2811 && (/* No message. */
2812 NILP (echo_area_buffer[0])
2813 /* Or empty message. */
2814 || (BUF_BEG (XBUFFER (echo_area_buffer[0]))
2815 == BUF_Z (XBUFFER (echo_area_buffer[0])))
2816 /* Or already echoing from same kboard. */
2817 || (echo_kboard && ok_to_echo_at_next_pause == echo_kboard)
2818 /* Or not echoing before and echoing allowed. */
2819 || (!echo_kboard && ok_to_echo_at_next_pause)))
284f4730 2820 {
7d6de002
RS
2821 /* After a mouse event, start echoing right away.
2822 This is because we are probably about to display a menu,
2823 and we don't want to delay before doing so. */
dbc4e1c1 2824 if (EVENT_HAS_PARAMETERS (prev_event))
3dbd9ee4 2825 echo_now ();
7d6de002
RS
2826 else
2827 {
666dc232
KS
2828 Lisp_Object tem0;
2829
410d4de9
RS
2830 save_getcjmp (save_jump);
2831 restore_getcjmp (local_getcjmp);
666dc232 2832 tem0 = sit_for (Vecho_keystrokes, 1, 1);
410d4de9 2833 restore_getcjmp (save_jump);
303b5b3f
RS
2834 if (EQ (tem0, Qt)
2835 && ! CONSP (Vunread_command_events))
3dbd9ee4 2836 echo_now ();
7d6de002 2837 }
284f4730
JB
2838 }
2839
410d4de9 2840 /* Maybe auto save due to number of keystrokes. */
284f4730
JB
2841
2842 if (commandflag != 0
2843 && auto_save_interval > 0
c43b1734 2844 && num_nonmacro_input_events - last_auto_save > max (auto_save_interval, 20)
4ec4ed6a 2845 && !detect_input_pending_run_timers (0))
284f4730 2846 {
284f4730 2847 Fdo_auto_save (Qnil, Qnil);
ef8fd672
RS
2848 /* Hooks can actually change some buffers in auto save. */
2849 redisplay ();
284f4730
JB
2850 }
2851
8150596a 2852 /* Try reading using an X menu.
24597608
RS
2853 This is never confused with reading using the minibuf
2854 because the recursive call of read_char in read_char_minibuf_menu_prompt
2855 does not pass on any keymaps. */
410d4de9 2856
24597608 2857 if (nmaps > 0 && INTERACTIVE
5a8d99e0
KH
2858 && !NILP (prev_event)
2859 && EVENT_HAS_PARAMETERS (prev_event)
7539e11f
KR
2860 && !EQ (XCAR (prev_event), Qmenu_bar)
2861 && !EQ (XCAR (prev_event), Qtool_bar)
24597608
RS
2862 /* Don't bring up a menu if we already have another event. */
2863 && NILP (Vunread_command_events)
b8556aee 2864 && unread_command_char < 0)
8eb4d8ef
RS
2865 {
2866 c = read_char_x_menu_prompt (nmaps, maps, prev_event, used_mouse_menu);
2867
2868 /* Now that we have read an event, Emacs is not idle. */
3236e6b8
CY
2869 if (!end_time)
2870 timer_stop_idle ();
8eb4d8ef 2871
184c3d81 2872 goto exit;
8eb4d8ef 2873 }
7d6de002 2874
410d4de9
RS
2875 /* Maybe autosave and/or garbage collect due to idleness. */
2876
26c1639e 2877 if (INTERACTIVE && NILP (c))
7d6de002
RS
2878 {
2879 int delay_level, buffer_size;
2880
410d4de9
RS
2881 /* Slow down auto saves logarithmically in size of current buffer,
2882 and garbage collect while we're at it. */
7d6de002
RS
2883 if (! MINI_WINDOW_P (XWINDOW (selected_window)))
2884 last_non_minibuf_size = Z - BEG;
2885 buffer_size = (last_non_minibuf_size >> 8) + 1;
2886 delay_level = 0;
2887 while (buffer_size > 64)
2888 delay_level++, buffer_size -= buffer_size >> 2;
2889 if (delay_level < 4) delay_level = 4;
2890 /* delay_level is 4 for files under around 50k, 7 at 100k,
2891 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2892
2893 /* Auto save if enough time goes by without input. */
2894 if (commandflag != 0
c43b1734 2895 && num_nonmacro_input_events > last_auto_save
8c18cbfb 2896 && INTEGERP (Vauto_save_timeout)
7d6de002
RS
2897 && XINT (Vauto_save_timeout) > 0)
2898 {
2899 Lisp_Object tem0;
666dc232 2900 int timeout = delay_level * XFASTINT (Vauto_save_timeout) / 4;
410d4de9
RS
2901
2902 save_getcjmp (save_jump);
2903 restore_getcjmp (local_getcjmp);
666dc232 2904 tem0 = sit_for (make_number (timeout), 1, 1);
410d4de9
RS
2905 restore_getcjmp (save_jump);
2906
303b5b3f
RS
2907 if (EQ (tem0, Qt)
2908 && ! CONSP (Vunread_command_events))
7d6de002 2909 {
7d6de002 2910 Fdo_auto_save (Qnil, Qnil);
7d6de002
RS
2911
2912 /* If we have auto-saved and there is still no input
2913 available, garbage collect if there has been enough
2914 consing going on to make it worthwhile. */
4ec4ed6a 2915 if (!detect_input_pending_run_timers (0)
c8e16a02 2916 && consing_since_gc > gc_cons_threshold / 2)
ef8fd672 2917 Fgarbage_collect ();
410d4de9 2918
ef8fd672 2919 redisplay ();
7d6de002
RS
2920 }
2921 }
2922 }
284f4730 2923
303b5b3f
RS
2924 /* If this has become non-nil here, it has been set by a timer
2925 or sentinel or filter. */
2926 if (CONSP (Vunread_command_events))
2927 {
7539e11f
KR
2928 c = XCAR (Vunread_command_events);
2929 Vunread_command_events = XCDR (Vunread_command_events);
303b5b3f
RS
2930 }
2931
410d4de9
RS
2932 /* Read something from current KBOARD's side queue, if possible. */
2933
beecf6a1 2934 if (NILP (c))
1e12dd87 2935 {
c5fdd383 2936 if (current_kboard->kbd_queue_has_data)
beecf6a1 2937 {
c5fdd383 2938 if (!CONSP (current_kboard->kbd_queue))
4524b161 2939 abort ();
7539e11f 2940 c = XCAR (current_kboard->kbd_queue);
c5fdd383 2941 current_kboard->kbd_queue
7539e11f 2942 = XCDR (current_kboard->kbd_queue);
c5fdd383
KH
2943 if (NILP (current_kboard->kbd_queue))
2944 current_kboard->kbd_queue_has_data = 0;
d9d4c147 2945 input_pending = readable_events (0);
4c52b668
KH
2946 if (EVENT_HAS_PARAMETERS (c)
2947 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qswitch_frame))
7539e11f 2948 internal_last_event_frame = XCAR (XCDR (c));
4c52b668 2949 Vlast_event_frame = internal_last_event_frame;
beecf6a1 2950 }
1e8bd3da
RS
2951 }
2952
c5fdd383 2953#ifdef MULTI_KBOARD
1e8bd3da
RS
2954 /* If current_kboard's side queue is empty check the other kboards.
2955 If one of them has data that we have not yet seen here,
2956 switch to it and process the data waiting for it.
2957
2958 Note: if the events queued up for another kboard
2959 have already been seen here, and therefore are not a complete command,
2960 the kbd_queue_has_data field is 0, so we skip that kboard here.
2961 That's to avoid an infinite loop switching between kboards here. */
2962 if (NILP (c) && !single_kboard)
2963 {
2964 KBOARD *kb;
2965 for (kb = all_kboards; kb; kb = kb->next_kboard)
2966 if (kb->kbd_queue_has_data)
2967 {
2968 current_kboard = kb;
ef6661f7
RS
2969 /* This is going to exit from read_char
2970 so we had better get rid of this frame's stuff. */
2971 UNGCPRO;
1e8bd3da
RS
2972 longjmp (wrong_kboard_jmpbuf, 1);
2973 }
2974 }
df0f2ba1
KH
2975#endif
2976
410d4de9
RS
2977 wrong_kboard:
2978
184c3d81 2979 STOP_POLLING;
410d4de9 2980
1e8bd3da
RS
2981 /* Finally, we read from the main queue,
2982 and if that gives us something we can't use yet, we put it on the
2983 appropriate side queue and try again. */
410d4de9 2984
1e8bd3da
RS
2985 if (NILP (c))
2986 {
2987 KBOARD *kb;
2988
179f689c
CY
2989 if (end_time)
2990 {
2991 EMACS_TIME now;
2992 EMACS_GET_TIME (now);
2993 if (EMACS_TIME_GE (now, *end_time))
2994 goto exit;
2995 }
2996
1e8bd3da 2997 /* Actually read a character, waiting if necessary. */
410d4de9
RS
2998 save_getcjmp (save_jump);
2999 restore_getcjmp (local_getcjmp);
3236e6b8 3000 if (!end_time)
70282fce 3001 timer_start_idle ();
179f689c 3002 c = kbd_buffer_get_event (&kb, used_mouse_menu, end_time);
410d4de9
RS
3003 restore_getcjmp (save_jump);
3004
c5fdd383 3005#ifdef MULTI_KBOARD
410d4de9 3006 if (! NILP (c) && (kb != current_kboard))
1e8bd3da 3007 {
f3fbd155
KR
3008 Lisp_Object link = kb->kbd_queue;
3009 if (CONSP (link))
3010 {
3011 while (CONSP (XCDR (link)))
3012 link = XCDR (link);
3013 if (!NILP (XCDR (link)))
3014 abort ();
3015 }
3016 if (!CONSP (link))
3017 kb->kbd_queue = Fcons (c, Qnil);
3018 else
3019 XSETCDR (link, Fcons (c, Qnil));
1e8bd3da 3020 kb->kbd_queue_has_data = 1;
46b84797 3021 c = Qnil;
1e8bd3da
RS
3022 if (single_kboard)
3023 goto wrong_kboard;
3024 current_kboard = kb;
ef6661f7
RS
3025 /* This is going to exit from read_char
3026 so we had better get rid of this frame's stuff. */
3027 UNGCPRO;
1e8bd3da 3028 longjmp (wrong_kboard_jmpbuf, 1);
df0f2ba1 3029 }
1e8bd3da 3030#endif
beecf6a1 3031 }
1e8bd3da 3032
284f4730 3033 /* Terminate Emacs in batch mode if at eof. */
8c18cbfb 3034 if (noninteractive && INTEGERP (c) && XINT (c) < 0)
284f4730
JB
3035 Fkill_emacs (make_number (1));
3036
8c18cbfb 3037 if (INTEGERP (c))
80645119
JB
3038 {
3039 /* Add in any extra modifiers, where appropriate. */
3040 if ((extra_keyboard_modifiers & CHAR_CTL)
3041 || ((extra_keyboard_modifiers & 0177) < ' '
3042 && (extra_keyboard_modifiers & 0177) != 0))
faf5e407 3043 XSETINT (c, make_ctrl_char (XINT (c)));
80645119
JB
3044
3045 /* Transfer any other modifier bits directly from
3046 extra_keyboard_modifiers to c. Ignore the actual character code
3047 in the low 16 bits of extra_keyboard_modifiers. */
b8d9050d 3048 XSETINT (c, XINT (c) | (extra_keyboard_modifiers & ~0xff7f & ~CHAR_CTL));
80645119 3049 }
9fa4395d 3050
284f4730
JB
3051 non_reread:
3052
3236e6b8
CY
3053 if (!end_time)
3054 timer_stop_idle ();
184c3d81 3055 RESUME_POLLING;
284f4730 3056
410d4de9
RS
3057 if (NILP (c))
3058 {
3059 if (commandflag >= 0
4ec4ed6a 3060 && !input_pending && !detect_input_pending_run_timers (0))
410d4de9
RS
3061 redisplay ();
3062
3063 goto wrong_kboard;
3064 }
3065
3066 non_reread_1:
3067
dfd11da7 3068 /* Buffer switch events are only for internal wakeups
7c3bc944
RS
3069 so don't show them to the user.
3070 Also, don't record a key if we already did. */
3071 if (BUFFERP (c) || key_already_recorded)
184c3d81 3072 goto exit;
a1341f75 3073
7f07d5ca
RS
3074 /* Process special events within read_char
3075 and loop around to read another event. */
017c7cb6
RS
3076 save = Vquit_flag;
3077 Vquit_flag = Qnil;
02067692 3078 tem = access_keymap (get_keymap (Vspecial_event_map, 0, 1), c, 0, 0, 1);
017c7cb6 3079 Vquit_flag = save;
7f07d5ca
RS
3080
3081 if (!NILP (tem))
3082 {
ba8dfba8
RS
3083 int was_locked = single_kboard;
3084
7f07d5ca 3085 last_input_char = c;
158f7532 3086 Fcommand_execute (tem, Qnil, Fvector (1, &last_input_char), Qt);
ba8dfba8 3087
3236e6b8 3088 if (CONSP (c) && EQ (XCAR (c), Qselect_window) && !end_time)
5d12f14d
EZ
3089 /* We stopped being idle for this event; undo that. This
3090 prevents automatic window selection (under
0b9a1d3d 3091 mouse_autoselect_window from acting as a real input event, for
5d12f14d 3092 example banishing the mouse under mouse-avoidance-mode. */
5c12e63f 3093 timer_resume_idle ();
5d12f14d 3094
ba8dfba8
RS
3095 /* Resume allowing input from any kboard, if that was true before. */
3096 if (!was_locked)
3097 any_kboard_state ();
3098
7f07d5ca
RS
3099 goto retry;
3100 }
3101
284f4730 3102 /* Handle things that only apply to characters. */
8c18cbfb 3103 if (INTEGERP (c))
284f4730
JB
3104 {
3105 /* If kbd_buffer_get_event gave us an EOF, return that. */
86e5706b 3106 if (XINT (c) == -1)
184c3d81 3107 goto exit;
284f4730 3108
301738ed 3109 if ((STRINGP (Vkeyboard_translate_table)
d5db4077 3110 && SCHARS (Vkeyboard_translate_table) > (unsigned) XFASTINT (c))
301738ed
RS
3111 || (VECTORP (Vkeyboard_translate_table)
3112 && XVECTOR (Vkeyboard_translate_table)->size > (unsigned) XFASTINT (c))
3113 || (CHAR_TABLE_P (Vkeyboard_translate_table)
5e3cb80d 3114 && CHAR_VALID_P (XINT (c), 0)))
f9414d62
RS
3115 {
3116 Lisp_Object d;
3117 d = Faref (Vkeyboard_translate_table, c);
3118 /* nil in keyboard-translate-table means no translation. */
3119 if (!NILP (d))
3120 c = d;
3121 }
284f4730
JB
3122 }
3123
e4fe371d
RS
3124 /* If this event is a mouse click in the menu bar,
3125 return just menu-bar for now. Modify the mouse click event
3126 so we won't do this twice, then queue it up. */
3127 if (EVENT_HAS_PARAMETERS (c)
7539e11f 3128 && CONSP (XCDR (c))
e4fe371d 3129 && CONSP (EVENT_START (c))
7539e11f 3130 && CONSP (XCDR (EVENT_START (c))))
284f4730 3131 {
e4fe371d 3132 Lisp_Object posn;
284f4730 3133
eee5863b 3134 posn = POSN_POSN (EVENT_START (c));
e4fe371d
RS
3135 /* Handle menu-bar events:
3136 insert the dummy prefix event `menu-bar'. */
9ea173e8 3137 if (EQ (posn, Qmenu_bar) || EQ (posn, Qtool_bar))
e4fe371d
RS
3138 {
3139 /* Change menu-bar to (menu-bar) as the event "position". */
eee5863b 3140 POSN_SET_POSN (EVENT_START (c), Fcons (posn, Qnil));
284f4730 3141
e4fe371d
RS
3142 also_record = c;
3143 Vunread_command_events = Fcons (c, Vunread_command_events);
3144 c = posn;
284f4730 3145 }
284f4730
JB
3146 }
3147
7d18f9ae
RS
3148 /* Store these characters into recent_keys, the dribble file if any,
3149 and the keyboard macro being defined, if any. */
e4fe371d
RS
3150 record_char (c);
3151 if (! NILP (also_record))
3152 record_char (also_record);
51172b6d 3153
d5eecefb
RS
3154 /* Wipe the echo area.
3155 But first, if we are about to use an input method,
3156 save the echo area contents for it to refer to. */
3157 if (INTEGERP (c)
3158 && ! NILP (Vinput_method_function)
3159 && (unsigned) XINT (c) >= ' '
8d769115
KH
3160 && (unsigned) XINT (c) != 127
3161 && (unsigned) XINT (c) < 256)
7ee32cda
GM
3162 {
3163 previous_echo_area_message = Fcurrent_message ();
3164 Vinput_method_previous_message = previous_echo_area_message;
3165 }
d5eecefb 3166
1172eb8d
GM
3167 /* Now wipe the echo area, except for help events which do their
3168 own stuff with the echo area. */
4d2e9f95
GM
3169 if (!CONSP (c)
3170 || (!(EQ (Qhelp_echo, XCAR (c)))
3171 && !(EQ (Qswitch_frame, XCAR (c)))))
1172eb8d
GM
3172 {
3173 if (!NILP (echo_area_buffer[0]))
3174 safe_run_hooks (Qecho_area_clear_hook);
3175 clear_message (1, 0);
3176 }
d5eecefb 3177
7d18f9ae 3178 reread_for_input_method:
284f4730 3179 from_macro:
7d18f9ae 3180 /* Pass this to the input method, if appropriate. */
d5eecefb
RS
3181 if (INTEGERP (c)
3182 && ! NILP (Vinput_method_function)
b638f328
RS
3183 /* Don't run the input method within a key sequence,
3184 after the first event of the key sequence. */
3185 && NILP (prev_event)
d5eecefb 3186 && (unsigned) XINT (c) >= ' '
8d769115
KH
3187 && (unsigned) XINT (c) != 127
3188 && (unsigned) XINT (c) < 256)
d5eecefb 3189 {
c60ee5e7 3190 Lisp_Object keys;
63020c46 3191 int key_count, key_count_reset;
d5eecefb 3192 struct gcpro gcpro1;
aed13378 3193 int count = SPECPDL_INDEX ();
d5eecefb 3194
6e5742a0
RS
3195 /* Save the echo status. */
3196 int saved_immediate_echo = current_kboard->immediate_echo;
985f9f66 3197 struct kboard *saved_ok_to_echo = ok_to_echo_at_next_pause;
dc29116a 3198 Lisp_Object saved_echo_string = current_kboard->echo_string;
6e5742a0
RS
3199 int saved_echo_after_prompt = current_kboard->echo_after_prompt;
3200
22b94eeb 3201#if 0
6e5742a0
RS
3202 if (before_command_restore_flag)
3203 {
3204 this_command_key_count = before_command_key_count_1;
3205 if (this_command_key_count < this_single_command_key_start)
3206 this_single_command_key_start = this_command_key_count;
3207 echo_truncate (before_command_echo_length_1);
3208 before_command_restore_flag = 0;
3209 }
22b94eeb 3210#endif
6e5742a0
RS
3211
3212 /* Save the this_command_keys status. */
3213 key_count = this_command_key_count;
63020c46 3214 key_count_reset = this_command_key_count_reset;
6e5742a0
RS
3215
3216 if (key_count > 0)
3217 keys = Fcopy_sequence (this_command_keys);
3218 else
3219 keys = Qnil;
d5eecefb 3220 GCPRO1 (keys);
6e5742a0
RS
3221
3222 /* Clear out this_command_keys. */
3223 this_command_key_count = 0;
63020c46 3224 this_command_key_count_reset = 0;
6e5742a0
RS
3225
3226 /* Now wipe the echo area. */
985f9f66 3227 if (!NILP (echo_area_buffer[0]))
6e5742a0 3228 safe_run_hooks (Qecho_area_clear_hook);
985f9f66 3229 clear_message (1, 0);
6e5742a0
RS
3230 echo_truncate (0);
3231
b638f328
RS
3232 /* If we are not reading a key sequence,
3233 never use the echo area. */
3234 if (maps == 0)
3235 {
b638f328
RS
3236 specbind (Qinput_method_use_echo_area, Qt);
3237 }
3238
6e5742a0 3239 /* Call the input method. */
d5eecefb 3240 tem = call1 (Vinput_method_function, c);
b638f328
RS
3241
3242 tem = unbind_to (count, tem);
3243
6e5742a0
RS
3244 /* Restore the saved echoing state
3245 and this_command_keys state. */
3246 this_command_key_count = key_count;
63020c46 3247 this_command_key_count_reset = key_count_reset;
6e5742a0
RS
3248 if (key_count > 0)
3249 this_command_keys = keys;
3250
3251 cancel_echoing ();
3252 ok_to_echo_at_next_pause = saved_ok_to_echo;
dc29116a 3253 current_kboard->echo_string = saved_echo_string;
6e5742a0
RS
3254 current_kboard->echo_after_prompt = saved_echo_after_prompt;
3255 if (saved_immediate_echo)
3256 echo_now ();
3257
d5eecefb 3258 UNGCPRO;
6e5742a0 3259
d5eecefb
RS
3260 /* The input method can return no events. */
3261 if (! CONSP (tem))
7d18f9ae 3262 {
d5eecefb 3263 /* Bring back the previous message, if any. */
7ee32cda
GM
3264 if (! NILP (previous_echo_area_message))
3265 message_with_string ("%s", previous_echo_area_message, 0);
d5eecefb 3266 goto retry;
7d18f9ae 3267 }
d5eecefb 3268 /* It returned one event or more. */
7539e11f 3269 c = XCAR (tem);
d5eecefb 3270 Vunread_post_input_method_events
7539e11f 3271 = nconc2 (XCDR (tem), Vunread_post_input_method_events);
7d18f9ae 3272 }
7c3bc944 3273
7d18f9ae 3274 reread_first:
284f4730 3275
7ee32cda 3276 /* Display help if not echoing. */
1172eb8d 3277 if (CONSP (c) && EQ (XCAR (c), Qhelp_echo))
7ee32cda 3278 {
2190735a 3279 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
d31053f9
RS
3280 Lisp_Object help, object, position, window, tem;
3281
3282 tem = Fcdr (XCDR (c));
3283 help = Fcar (tem);
3284 tem = Fcdr (tem);
3285 window = Fcar (tem);
3286 tem = Fcdr (tem);
3287 object = Fcar (tem);
3288 tem = Fcdr (tem);
3289 position = Fcar (tem);
3290
2190735a 3291 show_help_echo (help, window, object, position, 0);
fdbb67fe
GM
3292
3293 /* We stopped being idle for this event; undo that. */
3236e6b8
CY
3294 if (!end_time)
3295 timer_resume_idle ();
7ee32cda
GM
3296 goto retry;
3297 }
c60ee5e7 3298
4c0240d2
RS
3299 if ((! reread || this_command_key_count == 0
3300 || this_command_key_count_reset)
3301 && !end_time)
e4fe371d 3302 {
7d18f9ae
RS
3303
3304 /* Don't echo mouse motion events. */
f2647d04
DL
3305 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
3306 && NILP (Fzerop (Vecho_keystrokes))
7d18f9ae
RS
3307 && ! (EVENT_HAS_PARAMETERS (c)
3308 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
3309 {
3310 echo_char (c);
3311 if (! NILP (also_record))
3312 echo_char (also_record);
3313 /* Once we reread a character, echoing can happen
3314 the next time we pause to read a new one. */
985f9f66 3315 ok_to_echo_at_next_pause = current_kboard;
7d18f9ae
RS
3316 }
3317
3318 /* Record this character as part of the current key. */
3319 add_command_key (c);
e4fe371d 3320 if (! NILP (also_record))
7d18f9ae 3321 add_command_key (also_record);
e4fe371d 3322 }
b8556aee 3323
284f4730 3324 last_input_char = c;
c43b1734 3325 num_input_events++;
284f4730
JB
3326
3327 /* Process the help character specially if enabled */
ecb7cb34 3328 if (!NILP (Vhelp_form) && help_char_p (c))
284f4730
JB
3329 {
3330 Lisp_Object tem0;
aed13378 3331 count = SPECPDL_INDEX ();
284f4730 3332
638d3da0
CY
3333 help_form_saved_window_configs
3334 = Fcons (Fcurrent_window_configuration (Qnil),
3335 help_form_saved_window_configs);
3336 record_unwind_protect (read_char_help_form_unwind, Qnil);
284f4730
JB
3337
3338 tem0 = Feval (Vhelp_form);
8c18cbfb 3339 if (STRINGP (tem0))
284f4730
JB
3340 internal_with_output_to_temp_buffer ("*Help*", print_help, tem0);
3341
3342 cancel_echoing ();
3cb81011 3343 do
638d3da0
CY
3344 {
3345 c = read_char (0, 0, 0, Qnil, 0, NULL);
3346 if (EVENT_HAS_PARAMETERS (c)
3347 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_click))
3348 XSETCAR (help_form_saved_window_configs, Qnil);
3349 }
8c18cbfb 3350 while (BUFFERP (c));
ff11dfa1 3351 /* Remove the help from the frame */
284f4730 3352 unbind_to (count, Qnil);
410d4de9 3353
284f4730
JB
3354 redisplay ();
3355 if (EQ (c, make_number (040)))
3356 {
3357 cancel_echoing ();
3cb81011 3358 do
179f689c 3359 c = read_char (0, 0, 0, Qnil, 0, NULL);
8c18cbfb 3360 while (BUFFERP (c));
284f4730
JB
3361 }
3362 }
3363
184c3d81
RS
3364 exit:
3365 RESUME_POLLING;
7c3bc944 3366 RETURN_UNGCPRO (c);
284f4730
JB
3367}
3368
8eb4d8ef
RS
3369/* Record a key that came from a mouse menu.
3370 Record it for echoing, for this-command-keys, and so on. */
3371
3372static void
3373record_menu_key (c)
3374 Lisp_Object c;
3375{
3376 /* Wipe the echo area. */
985f9f66 3377 clear_message (1, 0);
8eb4d8ef
RS
3378
3379 record_char (c);
3380
22b94eeb 3381#if 0
8eb4d8ef
RS
3382 before_command_key_count = this_command_key_count;
3383 before_command_echo_length = echo_length ();
22b94eeb 3384#endif
8eb4d8ef
RS
3385
3386 /* Don't echo mouse motion events. */
f2647d04
DL
3387 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
3388 && NILP (Fzerop (Vecho_keystrokes)))
8eb4d8ef
RS
3389 {
3390 echo_char (c);
3391
3392 /* Once we reread a character, echoing can happen
3393 the next time we pause to read a new one. */
3394 ok_to_echo_at_next_pause = 0;
3395 }
3396
3397 /* Record this character as part of the current key. */
3398 add_command_key (c);
3399
3400 /* Re-reading in the middle of a command */
3401 last_input_char = c;
c43b1734 3402 num_input_events++;
8eb4d8ef
RS
3403}
3404
ecb7cb34
KH
3405/* Return 1 if should recognize C as "the help character". */
3406
3407int
3408help_char_p (c)
3409 Lisp_Object c;
3410{
3411 Lisp_Object tail;
3412
3413 if (EQ (c, Vhelp_char))
3414 return 1;
7539e11f
KR
3415 for (tail = Vhelp_event_list; CONSP (tail); tail = XCDR (tail))
3416 if (EQ (c, XCAR (tail)))
ecb7cb34
KH
3417 return 1;
3418 return 0;
3419}
3420
e4fe371d
RS
3421/* Record the input event C in various ways. */
3422
3423static void
3424record_char (c)
3425 Lisp_Object c;
3426{
090c68b9 3427 int recorded = 0;
52be17cc 3428
090c68b9
KS
3429 if (CONSP (c) && (EQ (XCAR (c), Qhelp_echo) || EQ (XCAR (c), Qmouse_movement)))
3430 {
3431 /* To avoid filling recent_keys with help-echo and mouse-movement
3432 events, we filter out repeated help-echo events, only store the
3433 first and last in a series of mouse-movement events, and don't
3434 store repeated help-echo events which are only separated by
3435 mouse-movement events. */
3436
3437 Lisp_Object ev1, ev2, ev3;
3438 int ix1, ix2, ix3;
c60ee5e7 3439
090c68b9
KS
3440 if ((ix1 = recent_keys_index - 1) < 0)
3441 ix1 = NUM_RECENT_KEYS - 1;
3442 ev1 = AREF (recent_keys, ix1);
c60ee5e7 3443
090c68b9
KS
3444 if ((ix2 = ix1 - 1) < 0)
3445 ix2 = NUM_RECENT_KEYS - 1;
3446 ev2 = AREF (recent_keys, ix2);
c60ee5e7 3447
090c68b9
KS
3448 if ((ix3 = ix2 - 1) < 0)
3449 ix3 = NUM_RECENT_KEYS - 1;
3450 ev3 = AREF (recent_keys, ix3);
c60ee5e7 3451
090c68b9
KS
3452 if (EQ (XCAR (c), Qhelp_echo))
3453 {
3454 /* Don't record `help-echo' in recent_keys unless it shows some help
a978004d 3455 message, and a different help than the previously recorded
090c68b9
KS
3456 event. */
3457 Lisp_Object help, last_help;
3458
3459 help = Fcar_safe (Fcdr_safe (XCDR (c)));
3460 if (!STRINGP (help))
3461 recorded = 1;
3462 else if (CONSP (ev1) && EQ (XCAR (ev1), Qhelp_echo)
3463 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev1))), EQ (last_help, help)))
3464 recorded = 1;
3465 else if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3466 && CONSP (ev2) && EQ (XCAR (ev2), Qhelp_echo)
3467 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev2))), EQ (last_help, help)))
3468 recorded = -1;
3469 else if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3470 && CONSP (ev2) && EQ (XCAR (ev2), Qmouse_movement)
3471 && CONSP (ev3) && EQ (XCAR (ev3), Qhelp_echo)
3472 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev3))), EQ (last_help, help)))
3473 recorded = -2;
3474 }
3475 else if (EQ (XCAR (c), Qmouse_movement))
52be17cc 3476 {
090c68b9
KS
3477 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3478 So additional mouse movement events replace the last element. */
3479 Lisp_Object last_window, window;
3480
3481 window = Fcar_safe (Fcar_safe (XCDR (c)));
3482 if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3483 && (last_window = Fcar_safe (Fcar_safe (XCDR (ev1))), EQ (last_window, window))
3484 && CONSP (ev2) && EQ (XCAR (ev2), Qmouse_movement)
3485 && (last_window = Fcar_safe (Fcar_safe (XCDR (ev2))), EQ (last_window, window)))
52be17cc 3486 {
090c68b9
KS
3487 ASET (recent_keys, ix1, c);
3488 recorded = 1;
52be17cc
GM
3489 }
3490 }
3491 }
3492 else
090c68b9
KS
3493 store_kbd_macro_char (c);
3494
3495 if (!recorded)
e8a50785
GM
3496 {
3497 total_keys++;
3498 ASET (recent_keys, recent_keys_index, c);
3499 if (++recent_keys_index >= NUM_RECENT_KEYS)
3500 recent_keys_index = 0;
3501 }
090c68b9
KS
3502 else if (recorded < 0)
3503 {
3504 /* We need to remove one or two events from recent_keys.
3505 To do this, we simply put nil at those events and move the
3506 recent_keys_index backwards over those events. Usually,
3507 users will never see those nil events, as they will be
3508 overwritten by the command keys entered to see recent_keys
3509 (e.g. C-h l). */
3510
3511 while (recorded++ < 0 && total_keys > 0)
3512 {
3513 if (total_keys < NUM_RECENT_KEYS)
3514 total_keys--;
3515 if (--recent_keys_index < 0)
3516 recent_keys_index = NUM_RECENT_KEYS - 1;
3517 ASET (recent_keys, recent_keys_index, Qnil);
3518 }
3519 }
3520
3521 num_nonmacro_input_events++;
c60ee5e7 3522
e4fe371d
RS
3523 /* Write c to the dribble file. If c is a lispy event, write
3524 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3525 If you, dear reader, have a better idea, you've got the source. :-) */
3526 if (dribble)
3527 {
34f5c10f 3528 BLOCK_INPUT;
e4fe371d
RS
3529 if (INTEGERP (c))
3530 {
3531 if (XUINT (c) < 0x100)
3532 putc (XINT (c), dribble);
3533 else
6de34814 3534 fprintf (dribble, " 0x%x", (int) XUINT (c));
e4fe371d
RS
3535 }
3536 else
3537 {
3538 Lisp_Object dribblee;
3539
3540 /* If it's a structured event, take the event header. */
3541 dribblee = EVENT_HEAD (c);
3542
3543 if (SYMBOLP (dribblee))
3544 {
3545 putc ('<', dribble);
d5db4077
KR
3546 fwrite (SDATA (SYMBOL_NAME (dribblee)), sizeof (char),
3547 SBYTES (SYMBOL_NAME (dribblee)),
e4fe371d
RS
3548 dribble);
3549 putc ('>', dribble);
3550 }
3551 }
3552
3553 fflush (dribble);
34f5c10f 3554 UNBLOCK_INPUT;
e4fe371d 3555 }
e4fe371d
RS
3556}
3557
284f4730
JB
3558Lisp_Object
3559print_help (object)
3560 Lisp_Object object;
3561{
622de3e9 3562 struct buffer *old = current_buffer;
284f4730 3563 Fprinc (object, Qnil);
622de3e9
KH
3564 set_buffer_internal (XBUFFER (Vstandard_output));
3565 call0 (intern ("help-mode"));
3566 set_buffer_internal (old);
284f4730
JB
3567 return Qnil;
3568}
3569
3570/* Copy out or in the info on where C-g should throw to.
3571 This is used when running Lisp code from within get_char,
3572 in case get_char is called recursively.
3573 See read_process_output. */
3574
dfcf069d 3575static void
284f4730
JB
3576save_getcjmp (temp)
3577 jmp_buf temp;
3578{
3579 bcopy (getcjmp, temp, sizeof getcjmp);
3580}
3581
dfcf069d 3582static void
284f4730
JB
3583restore_getcjmp (temp)
3584 jmp_buf temp;
3585{
3586 bcopy (temp, getcjmp, sizeof getcjmp);
3587}
284f4730 3588\f
a612e298
RS
3589/* Low level keyboard/mouse input.
3590 kbd_buffer_store_event places events in kbd_buffer, and
0646c0dd 3591 kbd_buffer_get_event retrieves them. */
a612e298
RS
3592
3593/* Return true iff there are any events in the queue that read-char
3594 would return. If this returns false, a read-char would block. */
3595static int
a2d5fca0
JD
3596readable_events (flags)
3597 int flags;
a612e298 3598{
a2d5fca0
JD
3599 if (flags & READABLE_EVENTS_DO_TIMERS_NOW)
3600 timer_check (1);
4ec4ed6a 3601
a2d5fca0
JD
3602 /* If the buffer contains only FOCUS_IN_EVENT events, and
3603 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
beecf6a1 3604 if (kbd_fetch_ptr != kbd_store_ptr)
a0ba8995 3605 {
354344a2
YM
3606 if (flags & (READABLE_EVENTS_FILTER_EVENTS
3607#ifdef USE_TOOLKIT_SCROLL_BARS
3608 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3609#endif
3610 ))
20057d52
JD
3611 {
3612 struct input_event *event;
3613
3614 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
3615 ? kbd_fetch_ptr
3616 : kbd_buffer);
3617
354344a2
YM
3618 do
3619 {
3620 if (!(
3621#ifdef USE_TOOLKIT_SCROLL_BARS
3622 (flags & READABLE_EVENTS_FILTER_EVENTS) &&
3623#endif
3624 event->kind == FOCUS_IN_EVENT)
3625#ifdef USE_TOOLKIT_SCROLL_BARS
3626 && !((flags & READABLE_EVENTS_IGNORE_SQUEEZABLES)
3627 && event->kind == SCROLL_BAR_CLICK_EVENT
3628 && event->part == scroll_bar_handle
3629 && event->modifiers == 0)
3630#endif
3631 )
3632 return 1;
3633 event++;
20057d52
JD
3634 if (event == kbd_buffer + KBD_BUFFER_SIZE)
3635 event = kbd_buffer;
354344a2
YM
3636 }
3637 while (event != kbd_store_ptr);
20057d52 3638 }
354344a2
YM
3639 else
3640 return 1;
a0ba8995
RS
3641 }
3642
ae372f41 3643#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
a2d5fca0
JD
3644 if (!(flags & READABLE_EVENTS_IGNORE_SQUEEZABLES)
3645 && !NILP (do_mouse_tracking) && some_mouse_moved ())
beecf6a1
KH
3646 return 1;
3647#endif
1e8bd3da 3648 if (single_kboard)
4c52b668 3649 {
c5fdd383 3650 if (current_kboard->kbd_queue_has_data)
4c52b668
KH
3651 return 1;
3652 }
3653 else
3654 {
c5fdd383
KH
3655 KBOARD *kb;
3656 for (kb = all_kboards; kb; kb = kb->next_kboard)
3657 if (kb->kbd_queue_has_data)
4c52b668
KH
3658 return 1;
3659 }
beecf6a1 3660 return 0;
a612e298
RS
3661}
3662
3663/* Set this for debugging, to have a way to get out */
3664int stop_character;
284f4730 3665
c5fdd383
KH
3666#ifdef MULTI_KBOARD
3667static KBOARD *
3668event_to_kboard (event)
5798cf15
KH
3669 struct input_event *event;
3670{
3671 Lisp_Object frame;
3672 frame = event->frame_or_window;
3673 if (CONSP (frame))
7539e11f 3674 frame = XCAR (frame);
5798cf15
KH
3675 else if (WINDOWP (frame))
3676 frame = WINDOW_FRAME (XWINDOW (frame));
3677
3678 /* There are still some events that don't set this field.
f5b56972
KH
3679 For now, just ignore the problem.
3680 Also ignore dead frames here. */
3681 if (!FRAMEP (frame) || !FRAME_LIVE_P (XFRAME (frame)))
5798cf15
KH
3682 return 0;
3683 else
c5fdd383 3684 return FRAME_KBOARD (XFRAME (frame));
5798cf15
KH
3685}
3686#endif
3687
2a84c6da
KS
3688
3689Lisp_Object Vthrow_on_input;
3690
284f4730
JB
3691/* Store an event obtained at interrupt level into kbd_buffer, fifo */
3692
3693void
3694kbd_buffer_store_event (event)
3695 register struct input_event *event;
0fc0bac9
KS
3696{
3697 kbd_buffer_store_event_hold (event, 0);
3698}
3699
3700/* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3701
3702 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3703 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3704 Else, if EVENT is a quit event, store the quit event
3705 in HOLD_QUIT, and return (thus ignoring further events).
3706
3707 This is used in read_avail_input to postpone the processing
3708 of the quit event until all subsequent input events have been
3709 parsed (and discarded).
3710 */
3711
3712void
3713kbd_buffer_store_event_hold (event, hold_quit)
3714 register struct input_event *event;
3715 struct input_event *hold_quit;
284f4730 3716{
3b8f9651 3717 if (event->kind == NO_EVENT)
284f4730
JB
3718 abort ();
3719
0fc0bac9
KS
3720 if (hold_quit && hold_quit->kind != NO_EVENT)
3721 return;
3722
3b8f9651 3723 if (event->kind == ASCII_KEYSTROKE_EVENT)
284f4730 3724 {
e9bf89a0 3725 register int c = event->code & 0377;
284f4730 3726
faf5e407
JB
3727 if (event->modifiers & ctrl_modifier)
3728 c = make_ctrl_char (c);
3729
9fd7d808
RS
3730 c |= (event->modifiers
3731 & (meta_modifier | alt_modifier
3732 | hyper_modifier | super_modifier));
3733
86e5706b 3734 if (c == quit_char)
284f4730 3735 {
c5fdd383
KH
3736#ifdef MULTI_KBOARD
3737 KBOARD *kb;
5798cf15
KH
3738 struct input_event *sp;
3739
1e8bd3da 3740 if (single_kboard
c5fdd383
KH
3741 && (kb = FRAME_KBOARD (XFRAME (event->frame_or_window)),
3742 kb != current_kboard))
5798cf15 3743 {
c5fdd383 3744 kb->kbd_queue
5798cf15
KH
3745 = Fcons (make_lispy_switch_frame (event->frame_or_window),
3746 Fcons (make_number (c), Qnil));
c5fdd383 3747 kb->kbd_queue_has_data = 1;
5798cf15
KH
3748 for (sp = kbd_fetch_ptr; sp != kbd_store_ptr; sp++)
3749 {
3750 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3751 sp = kbd_buffer;
3752
c5fdd383 3753 if (event_to_kboard (sp) == kb)
5798cf15 3754 {
3b8f9651 3755 sp->kind = NO_EVENT;
5798cf15 3756 sp->frame_or_window = Qnil;
da8f7368 3757 sp->arg = Qnil;
5798cf15
KH
3758 }
3759 }
3760 return;
3761 }
3762#endif
3e51c7b7 3763
0fc0bac9
KS
3764 if (hold_quit)
3765 {
3766 bcopy (event, (char *) hold_quit, sizeof (*event));
3767 return;
3768 }
3769
284f4730 3770 /* If this results in a quit_char being returned to Emacs as
3c370943 3771 input, set Vlast_event_frame properly. If this doesn't
284f4730 3772 get returned to Emacs as an event, the next event read
ff11dfa1 3773 will set Vlast_event_frame again, so this is safe to do. */
4bb994d1 3774 {
9b8eb840 3775 Lisp_Object focus;
4bb994d1 3776
9b8eb840 3777 focus = FRAME_FOCUS_FRAME (XFRAME (event->frame_or_window));
4bb994d1 3778 if (NILP (focus))
beecf6a1 3779 focus = event->frame_or_window;
4c52b668
KH
3780 internal_last_event_frame = focus;
3781 Vlast_event_frame = focus;
4bb994d1 3782 }
3e51c7b7 3783
ffd56f97 3784 last_event_timestamp = event->timestamp;
7189cad8 3785 interrupt_signal (0 /* dummy */);
284f4730
JB
3786 return;
3787 }
3788
3789 if (c && c == stop_character)
3790 {
3791 sys_suspend ();
3792 return;
3793 }
284f4730 3794 }
3b8f9651 3795 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3fe8e9a2 3796 Just ignore the second one. */
3b8f9651 3797 else if (event->kind == BUFFER_SWITCH_EVENT
3fe8e9a2 3798 && kbd_fetch_ptr != kbd_store_ptr
0fc0bac9
KS
3799 && ((kbd_store_ptr == kbd_buffer
3800 ? kbd_buffer + KBD_BUFFER_SIZE - 1
3801 : kbd_store_ptr - 1)->kind) == BUFFER_SWITCH_EVENT)
3fe8e9a2 3802 return;
284f4730 3803
beecf6a1
KH
3804 if (kbd_store_ptr - kbd_buffer == KBD_BUFFER_SIZE)
3805 kbd_store_ptr = kbd_buffer;
284f4730
JB
3806
3807 /* Don't let the very last slot in the buffer become full,
3808 since that would make the two pointers equal,
3809 and that is indistinguishable from an empty buffer.
3810 Discard the event if it would fill the last slot. */
beecf6a1 3811 if (kbd_fetch_ptr - 1 != kbd_store_ptr)
284f4730 3812 {
e3f6e7c7
KS
3813 *kbd_store_ptr = *event;
3814 ++kbd_store_ptr;
3815 }
2a84c6da 3816
85e7f477
RS
3817 /* If we're inside while-no-input, and this event qualifies
3818 as input, set quit-flag to cause an interrupt. */
2a84c6da
KS
3819 if (!NILP (Vthrow_on_input)
3820 && event->kind != FOCUS_IN_EVENT
3821 && event->kind != HELP_EVENT
b809d9e7 3822 && event->kind != DEICONIFY_EVENT)
85e7f477
RS
3823 {
3824 Vquit_flag = Vthrow_on_input;
3825 /* If we're inside a function that wants immediate quits,
3826 do it now. */
3827 if (immediate_quit && NILP (Vinhibit_quit))
3828 {
3829 immediate_quit = 0;
3830 sigfree ();
3831 QUIT;
3832 }
3833 }
e3f6e7c7 3834}
c60ee5e7 3835
da8f7368 3836
e3f6e7c7 3837/* Put an input event back in the head of the event queue. */
284f4730 3838
e3f6e7c7
KS
3839void
3840kbd_buffer_unget_event (event)
3841 register struct input_event *event;
3842{
3843 if (kbd_fetch_ptr == kbd_buffer)
3844 kbd_fetch_ptr = kbd_buffer + KBD_BUFFER_SIZE;
3845
3846 /* Don't let the very last slot in the buffer become full, */
3847 if (kbd_fetch_ptr - 1 != kbd_store_ptr)
3848 {
3849 --kbd_fetch_ptr;
3850 *kbd_fetch_ptr = *event;
284f4730
JB
3851 }
3852}
8dfd92c9
GM
3853
3854
f139e559 3855/* Generate HELP_EVENT input_events in BUFP which has room for
0bbfdc25
GM
3856 SIZE events. If there's not enough room in BUFP, ignore this
3857 event.
8dfd92c9
GM
3858
3859 HELP is the help form.
3860
3861 FRAME is the frame on which the help is generated. OBJECT is the
5b2ec2d0
GM
3862 Lisp object where the help was found (a buffer, a string, an
3863 overlay, or nil if neither from a string nor from a buffer. POS is
3864 the position within OBJECT where the help was found.
8dfd92c9
GM
3865
3866 Value is the number of input_events generated. */
3867
0fc0bac9
KS
3868void
3869gen_help_event (help, frame, window, object, pos)
2190735a 3870 Lisp_Object help, frame, object, window;
8dfd92c9
GM
3871 int pos;
3872{
0fc0bac9
KS
3873 struct input_event event;
3874
3875 EVENT_INIT (event);
3876
3877 event.kind = HELP_EVENT;
3878 event.frame_or_window = frame;
3879 event.arg = object;
3880 event.x = WINDOWP (window) ? window : frame;
3881 event.y = help;
3882 event.code = pos;
3883 kbd_buffer_store_event (&event);
8dfd92c9
GM
3884}
3885
3886
3887/* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3888
3889void
3890kbd_buffer_store_help_event (frame, help)
3891 Lisp_Object frame, help;
3892{
3893 struct input_event event;
3894
3895 event.kind = HELP_EVENT;
3896 event.frame_or_window = frame;
3897 event.arg = Qnil;
2e1a49ad
SM
3898 event.x = Qnil;
3899 event.y = help;
8dfd92c9
GM
3900 event.code = 0;
3901 kbd_buffer_store_event (&event);
8dfd92c9
GM
3902}
3903
a612e298 3904\f
07de30b9 3905/* Discard any mouse events in the event buffer by setting them to
3b8f9651 3906 NO_EVENT. */
07de30b9
GV
3907void
3908discard_mouse_events ()
3909{
3910 struct input_event *sp;
3911 for (sp = kbd_fetch_ptr; sp != kbd_store_ptr; sp++)
3912 {
3913 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3914 sp = kbd_buffer;
3915
3b8f9651 3916 if (sp->kind == MOUSE_CLICK_EVENT
8006e4bb 3917 || sp->kind == WHEEL_EVENT
07de30b9 3918#ifdef WINDOWSNT
3b8f9651 3919 || sp->kind == W32_SCROLL_BAR_CLICK_EVENT
e416374c
NR
3920#endif
3921#ifdef HAVE_GPM
3922 || sp->kind == GPM_CLICK_EVENT
07de30b9 3923#endif
3b8f9651 3924 || sp->kind == SCROLL_BAR_CLICK_EVENT)
07de30b9 3925 {
3b8f9651 3926 sp->kind = NO_EVENT;
07de30b9
GV
3927 }
3928 }
3929}
eeabfe76 3930
0bbfdc25
GM
3931
3932/* Return non-zero if there are any real events waiting in the event
3b8f9651 3933 buffer, not counting `NO_EVENT's.
0bbfdc25 3934
3b8f9651 3935 If DISCARD is non-zero, discard NO_EVENT events at the front of
0bbfdc25
GM
3936 the input queue, possibly leaving the input queue empty if there
3937 are no real input events. */
3938
eeabfe76
EZ
3939int
3940kbd_buffer_events_waiting (discard)
3941 int discard;
3942{
3943 struct input_event *sp;
c60ee5e7 3944
0bbfdc25 3945 for (sp = kbd_fetch_ptr;
3b8f9651 3946 sp != kbd_store_ptr && sp->kind == NO_EVENT;
0bbfdc25 3947 ++sp)
eeabfe76
EZ
3948 {
3949 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3950 sp = kbd_buffer;
eeabfe76 3951 }
0bbfdc25 3952
eeabfe76
EZ
3953 if (discard)
3954 kbd_fetch_ptr = sp;
0bbfdc25 3955
3b8f9651 3956 return sp != kbd_store_ptr && sp->kind != NO_EVENT;
eeabfe76 3957}
0bbfdc25 3958
07de30b9 3959\f
0bbfdc25
GM
3960/* Clear input event EVENT. */
3961
3962static INLINE void
3963clear_event (event)
3964 struct input_event *event;
3965{
3b8f9651 3966 event->kind = NO_EVENT;
0bbfdc25
GM
3967}
3968
3969
a612e298
RS
3970/* Read one event from the event buffer, waiting if necessary.
3971 The value is a Lisp object representing the event.
3972 The value is nil for an event that should be ignored,
3973 or that was handled here.
3974 We always read and discard one event. */
284f4730
JB
3975
3976static Lisp_Object
179f689c 3977kbd_buffer_get_event (kbp, used_mouse_menu, end_time)
410d4de9 3978 KBOARD **kbp;
83d68044 3979 int *used_mouse_menu;
179f689c 3980 EMACS_TIME *end_time;
284f4730
JB
3981{
3982 register int c;
3983 Lisp_Object obj;
3984
3985 if (noninteractive)
3986 {
3987 c = getchar ();
18cd2eeb 3988 XSETINT (obj, c);
f5b56972 3989 *kbp = current_kboard;
284f4730
JB
3990 return obj;
3991 }
3992
3993 /* Wait until there is input available. */
3994 for (;;)
3995 {
beecf6a1
KH
3996 if (kbd_fetch_ptr != kbd_store_ptr)
3997 break;
ae372f41 3998#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
f3253854 3999 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
284f4730 4000 break;
beecf6a1 4001#endif
284f4730
JB
4002
4003 /* If the quit flag is set, then read_char will return
4004 quit_char, so that counts as "available input." */
4005 if (!NILP (Vquit_flag))
4006 quit_throw_to_read_char ();
4007
4008 /* One way or another, wait until input is available; then, if
4009 interrupt handlers have not read it, read it now. */
4010
4011#ifdef OLDVMS
4012 wait_for_kbd_input ();
4013#else
4014/* Note SIGIO has been undef'd if FIONREAD is missing. */
4015#ifdef SIGIO
4016 gobble_input (0);
4017#endif /* SIGIO */
beecf6a1
KH
4018 if (kbd_fetch_ptr != kbd_store_ptr)
4019 break;
ae372f41 4020#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
f3253854 4021 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
beecf6a1
KH
4022 break;
4023#endif
179f689c
CY
4024 if (end_time)
4025 {
4026 EMACS_TIME duration;
4027 EMACS_GET_TIME (duration);
6b657e42
EZ
4028 if (EMACS_TIME_GE (duration, *end_time))
4029 return Qnil; /* finished waiting */
179f689c 4030 else
6b657e42
EZ
4031 {
4032 EMACS_SUB_TIME (duration, *end_time, duration);
4033 wait_reading_process_output (EMACS_SECS (duration),
4034 EMACS_USECS (duration),
4035 -1, 1, Qnil, NULL, 0);
4036 }
179f689c
CY
4037 }
4038 else
d64b707c 4039 wait_reading_process_output (0, 0, -1, 1, Qnil, NULL, 0);
284f4730 4040
179f689c
CY
4041 if (!interrupt_input && kbd_fetch_ptr == kbd_store_ptr)
4042 /* Pass 1 for EXPECT since we just waited to have input. */
4043 read_avail_input (1);
284f4730
JB
4044#endif /* not VMS */
4045 }
4046
303b5b3f
RS
4047 if (CONSP (Vunread_command_events))
4048 {
4049 Lisp_Object first;
7539e11f
KR
4050 first = XCAR (Vunread_command_events);
4051 Vunread_command_events = XCDR (Vunread_command_events);
303b5b3f
RS
4052 *kbp = current_kboard;
4053 return first;
4054 }
4055
284f4730
JB
4056 /* At this point, we know that there is a readable event available
4057 somewhere. If the event queue is empty, then there must be a
4058 mouse movement enabled and available. */
beecf6a1 4059 if (kbd_fetch_ptr != kbd_store_ptr)
284f4730 4060 {
cd21b839 4061 struct input_event *event;
3e51c7b7 4062
beecf6a1
KH
4063 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
4064 ? kbd_fetch_ptr
4065 : kbd_buffer);
3e51c7b7 4066
cd21b839 4067 last_event_timestamp = event->timestamp;
cd21b839 4068
c5fdd383
KH
4069#ifdef MULTI_KBOARD
4070 *kbp = event_to_kboard (event);
4071 if (*kbp == 0)
4072 *kbp = current_kboard; /* Better than returning null ptr? */
5798cf15 4073#else
c5fdd383 4074 *kbp = &the_only_kboard;
5798cf15 4075#endif
beecf6a1 4076
4bb994d1
JB
4077 obj = Qnil;
4078
48e416d4 4079 /* These two kinds of events get special handling
a612e298
RS
4080 and don't actually appear to the command loop.
4081 We return nil for them. */
e3f6e7c7
KS
4082 if (event->kind == SELECTION_REQUEST_EVENT
4083 || event->kind == SELECTION_CLEAR_EVENT)
48e416d4 4084 {
598a9fa7 4085#ifdef HAVE_X11
1e8bd3da
RS
4086 struct input_event copy;
4087
4581e928
RS
4088 /* Remove it from the buffer before processing it,
4089 since otherwise swallow_events will see it
4090 and process it again. */
1e8bd3da 4091 copy = *event;
beecf6a1 4092 kbd_fetch_ptr = event + 1;
d9d4c147 4093 input_pending = readable_events (0);
e3f6e7c7 4094 x_handle_selection_event (&copy);
598a9fa7
JB
4095#else
4096 /* We're getting selection request events, but we don't have
4097 a window system. */
4098 abort ();
4099#endif
48e416d4
RS
4100 }
4101
e0f712ba 4102#if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3b8f9651 4103 else if (event->kind == DELETE_WINDOW_EVENT)
990acea3 4104 {
bbdc2092
RS
4105 /* Make an event (delete-frame (FRAME)). */
4106 obj = Fcons (event->frame_or_window, Qnil);
af17bd2b 4107 obj = Fcons (Qdelete_frame, Fcons (obj, Qnil));
beecf6a1 4108 kbd_fetch_ptr = event + 1;
af17bd2b 4109 }
1a578e9b 4110#endif
fca32d15 4111#if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3b8f9651 4112 else if (event->kind == ICONIFY_EVENT)
af17bd2b
KH
4113 {
4114 /* Make an event (iconify-frame (FRAME)). */
4115 obj = Fcons (event->frame_or_window, Qnil);
4116 obj = Fcons (Qiconify_frame, Fcons (obj, Qnil));
beecf6a1 4117 kbd_fetch_ptr = event + 1;
af17bd2b 4118 }
3b8f9651 4119 else if (event->kind == DEICONIFY_EVENT)
af17bd2b
KH
4120 {
4121 /* Make an event (make-frame-visible (FRAME)). */
4122 obj = Fcons (event->frame_or_window, Qnil);
4123 obj = Fcons (Qmake_frame_visible, Fcons (obj, Qnil));
beecf6a1 4124 kbd_fetch_ptr = event + 1;
990acea3
RS
4125 }
4126#endif
3b8f9651 4127 else if (event->kind == BUFFER_SWITCH_EVENT)
a8015ab5
KH
4128 {
4129 /* The value doesn't matter here; only the type is tested. */
18cd2eeb 4130 XSETBUFFER (obj, current_buffer);
beecf6a1 4131 kbd_fetch_ptr = event + 1;
a8015ab5 4132 }
488dd4c4
JD
4133#if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4134 || defined (USE_GTK)
3b8f9651 4135 else if (event->kind == MENU_BAR_ACTIVATE_EVENT)
099787c1
RS
4136 {
4137 kbd_fetch_ptr = event + 1;
d9d4c147 4138 input_pending = readable_events (0);
e649d076
RS
4139 if (FRAME_LIVE_P (XFRAME (event->frame_or_window)))
4140 x_activate_menubar (XFRAME (event->frame_or_window));
099787c1 4141 }
1161d367 4142#endif
c16dab62 4143#if defined (WINDOWSNT) || defined (MAC_OS)
3b8f9651 4144 else if (event->kind == LANGUAGE_CHANGE_EVENT)
1161d367 4145 {
c16dab62
YM
4146#ifdef MAC_OS
4147 /* Make an event (language-change (KEY_SCRIPT)). */
4148 obj = Fcons (make_number (event->code), Qnil);
4149#else
1161d367 4150 /* Make an event (language-change (FRAME CHARSET LCID)). */
d352abdf 4151 obj = Fcons (event->frame_or_window, Qnil);
c16dab62 4152#endif
1161d367
GV
4153 obj = Fcons (Qlanguage_change, Fcons (obj, Qnil));
4154 kbd_fetch_ptr = event + 1;
4155 }
099787c1 4156#endif
3b8f9651 4157 else if (event->kind == SAVE_SESSION_EVENT)
4ebc27a5
JD
4158 {
4159 obj = Fcons (Qsave_session, Qnil);
4160 kbd_fetch_ptr = event + 1;
4161 }
a612e298 4162 /* Just discard these, by returning nil.
c5fdd383 4163 With MULTI_KBOARD, these events are used as placeholders
5798cf15
KH
4164 when we need to randomly delete events from the queue.
4165 (They shouldn't otherwise be found in the buffer,
4166 but on some machines it appears they do show up
c5fdd383 4167 even without MULTI_KBOARD.) */
3b8f9651 4168 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
07de30b9 4169 mouse events during a popup-menu call. */
3b8f9651 4170 else if (event->kind == NO_EVENT)
beecf6a1 4171 kbd_fetch_ptr = event + 1;
7ee32cda
GM
4172 else if (event->kind == HELP_EVENT)
4173 {
2190735a 4174 Lisp_Object object, position, help, frame, window;
e4457b09 4175
8dfd92c9
GM
4176 frame = event->frame_or_window;
4177 object = event->arg;
2e1a49ad
SM
4178 position = make_number (event->code);
4179 window = event->x;
4180 help = event->y;
0bbfdc25 4181 clear_event (event);
e4457b09
GM
4182
4183 kbd_fetch_ptr = event + 1;
2190735a
GM
4184 if (!WINDOWP (window))
4185 window = Qnil;
4186 obj = Fcons (Qhelp_echo,
4187 list5 (frame, help, window, object, position));
7ee32cda 4188 }
c51c7093
GM
4189 else if (event->kind == FOCUS_IN_EVENT)
4190 {
4191 /* Notification of a FocusIn event. The frame receiving the
4192 focus is in event->frame_or_window. Generate a
4193 switch-frame event if necessary. */
4194 Lisp_Object frame, focus;
4195
4196 frame = event->frame_or_window;
4197 focus = FRAME_FOCUS_FRAME (XFRAME (frame));
4198 if (FRAMEP (focus))
4199 frame = focus;
4200
4201 if (!EQ (frame, internal_last_event_frame)
4202 && !EQ (frame, selected_frame))
4203 obj = make_lispy_switch_frame (frame);
4204 internal_last_event_frame = frame;
4205 kbd_fetch_ptr = event + 1;
4206 }
1e12dd87
RS
4207 else
4208 {
c51c7093
GM
4209 /* If this event is on a different frame, return a switch-frame this
4210 time, and leave the event in the queue for next time. */
9b8eb840 4211 Lisp_Object frame;
1e12dd87 4212 Lisp_Object focus;
7b4aedb9 4213
9b8eb840 4214 frame = event->frame_or_window;
2470a66f 4215 if (CONSP (frame))
7539e11f 4216 frame = XCAR (frame);
2470a66f 4217 else if (WINDOWP (frame))
1e12dd87 4218 frame = WINDOW_FRAME (XWINDOW (frame));
4bb994d1 4219
1e12dd87
RS
4220 focus = FRAME_FOCUS_FRAME (XFRAME (frame));
4221 if (! NILP (focus))
4222 frame = focus;
07d2b8de 4223
4c52b668 4224 if (! EQ (frame, internal_last_event_frame)
788f89eb 4225 && !EQ (frame, selected_frame))
1e12dd87 4226 obj = make_lispy_switch_frame (frame);
4c52b668 4227 internal_last_event_frame = frame;
4bb994d1 4228
1e12dd87
RS
4229 /* If we didn't decide to make a switch-frame event, go ahead
4230 and build a real event from the queue entry. */
cd21b839 4231
1e12dd87
RS
4232 if (NILP (obj))
4233 {
4234 obj = make_lispy_event (event);
c60ee5e7 4235
488dd4c4
JD
4236#if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4237 || defined (USE_GTK)
83d68044
KH
4238 /* If this was a menu selection, then set the flag to inhibit
4239 writing to last_nonmenu_event. Don't do this if the event
4240 we're returning is (menu-bar), though; that indicates the
4241 beginning of the menu sequence, and we might as well leave
4242 that as the `event with parameters' for this selection. */
da8f7368
GM
4243 if (used_mouse_menu
4244 && !EQ (event->frame_or_window, event->arg)
4245 && (event->kind == MENU_BAR_EVENT
4246 || event->kind == TOOL_BAR_EVENT))
83d68044
KH
4247 *used_mouse_menu = 1;
4248#endif
1e12dd87
RS
4249
4250 /* Wipe out this event, to catch bugs. */
0bbfdc25 4251 clear_event (event);
beecf6a1 4252 kbd_fetch_ptr = event + 1;
1e12dd87 4253 }
4bb994d1 4254 }
284f4730 4255 }
ae372f41 4256#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
a612e298 4257 /* Try generating a mouse motion event. */
f3253854 4258 else if (!NILP (do_mouse_tracking) && some_mouse_moved ())
284f4730 4259 {
f3253854 4260 FRAME_PTR f = some_mouse_moved ();
7b4aedb9 4261 Lisp_Object bar_window;
3c370943 4262 enum scroll_bar_part part;
e5d77022
JB
4263 Lisp_Object x, y;
4264 unsigned long time;
284f4730 4265
c5fdd383 4266 *kbp = current_kboard;
e177ac3a
RS
4267 /* Note that this uses F to determine which display to look at.
4268 If there is no valid info, it does not store anything
4269 so x remains nil. */
4270 x = Qnil;
dd26ab75 4271 (*mouse_position_hook) (&f, 0, &bar_window, &part, &x, &y, &time);
4bb994d1
JB
4272
4273 obj = Qnil;
284f4730 4274
4bb994d1
JB
4275 /* Decide if we should generate a switch-frame event. Don't
4276 generate switch-frame events for motion outside of all Emacs
4277 frames. */
e177ac3a 4278 if (!NILP (x) && f)
cd21b839 4279 {
9b8eb840 4280 Lisp_Object frame;
4bb994d1 4281
9b8eb840 4282 frame = FRAME_FOCUS_FRAME (f);
4bb994d1 4283 if (NILP (frame))
18cd2eeb 4284 XSETFRAME (frame, f);
4bb994d1 4285
4c52b668 4286 if (! EQ (frame, internal_last_event_frame)
788f89eb 4287 && !EQ (frame, selected_frame))
764cb3f9 4288 obj = make_lispy_switch_frame (frame);
4c52b668 4289 internal_last_event_frame = frame;
cd21b839 4290 }
4bb994d1 4291
df0f2ba1 4292 /* If we didn't decide to make a switch-frame event, go ahead and
4bb994d1 4293 return a mouse-motion event. */
e177ac3a 4294 if (!NILP (x) && NILP (obj))
7b4aedb9 4295 obj = make_lispy_movement (f, bar_window, part, x, y, time);
6cbff1cb 4296 }
ae372f41 4297#endif /* HAVE_MOUSE || HAVE GPM */
284f4730
JB
4298 else
4299 /* We were promised by the above while loop that there was
4300 something for us to read! */
4301 abort ();
4302
d9d4c147 4303 input_pending = readable_events (0);
284f4730 4304
4c52b668 4305 Vlast_event_frame = internal_last_event_frame;
3c370943 4306
284f4730
JB
4307 return (obj);
4308}
a612e298
RS
4309\f
4310/* Process any events that are not user-visible,
4311 then return, without reading any user-visible events. */
3a3b9632
RS
4312
4313void
d9d4c147
KH
4314swallow_events (do_display)
4315 int do_display;
3a3b9632 4316{
87dd9b9b
RS
4317 int old_timers_run;
4318
beecf6a1 4319 while (kbd_fetch_ptr != kbd_store_ptr)
3a3b9632
RS
4320 {
4321 struct input_event *event;
4322
beecf6a1
KH
4323 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
4324 ? kbd_fetch_ptr
4325 : kbd_buffer);
3a3b9632
RS
4326
4327 last_event_timestamp = event->timestamp;
4328
4329 /* These two kinds of events get special handling
4330 and don't actually appear to the command loop. */
e3f6e7c7
KS
4331 if (event->kind == SELECTION_REQUEST_EVENT
4332 || event->kind == SELECTION_CLEAR_EVENT)
3a3b9632
RS
4333 {
4334#ifdef HAVE_X11
4581e928 4335 struct input_event copy;
e0301c07
RS
4336
4337 /* Remove it from the buffer before processing it,
4338 since otherwise swallow_events called recursively could see it
4339 and process it again. */
4581e928 4340 copy = *event;
beecf6a1 4341 kbd_fetch_ptr = event + 1;
d9d4c147 4342 input_pending = readable_events (0);
e3f6e7c7 4343 x_handle_selection_event (&copy);
3a3b9632
RS
4344#else
4345 /* We're getting selection request events, but we don't have
4346 a window system. */
4347 abort ();
4348#endif
4349 }
4350 else
4351 break;
4352 }
4353
87dd9b9b 4354 old_timers_run = timers_run;
a2d5fca0 4355 get_input_pending (&input_pending, READABLE_EVENTS_DO_TIMERS_NOW);
87dd9b9b
RS
4356
4357 if (timers_run != old_timers_run && do_display)
3007ebfb 4358 redisplay_preserve_echo_area (7);
3a3b9632 4359}
a612e298 4360\f
d9d4c147
KH
4361/* Record the start of when Emacs is idle,
4362 for the sake of running idle-time timers. */
4363
5c12e63f 4364static void
d9d4c147
KH
4365timer_start_idle ()
4366{
4367 Lisp_Object timers;
4368
4369 /* If we are already in the idle state, do nothing. */
4370 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4371 return;
4372
4373 EMACS_GET_TIME (timer_idleness_start_time);
4374
3021d3a9
RS
4375 timer_last_idleness_start_time = timer_idleness_start_time;
4376
d9d4c147 4377 /* Mark all idle-time timers as once again candidates for running. */
7539e11f 4378 for (timers = Vtimer_idle_list; CONSP (timers); timers = XCDR (timers))
d9d4c147
KH
4379 {
4380 Lisp_Object timer;
4381
7539e11f 4382 timer = XCAR (timers);
d9d4c147
KH
4383
4384 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
4385 continue;
4386 XVECTOR (timer)->contents[0] = Qnil;
4387 }
4388}
4389
4390/* Record that Emacs is no longer idle, so stop running idle-time timers. */
4391
5c12e63f 4392static void
d9d4c147
KH
4393timer_stop_idle ()
4394{
4395 EMACS_SET_SECS_USECS (timer_idleness_start_time, -1, -1);
4396}
4397
5c12e63f
KS
4398/* Resume idle timer from last idle start time. */
4399
4400static void
4401timer_resume_idle ()
4402{
4403 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4404 return;
4405
4406 timer_idleness_start_time = timer_last_idleness_start_time;
4407}
4408
e044e87c
RS
4409/* This is only for debugging. */
4410struct input_event last_timer_event;
4411
c04cbc3b
RS
4412/* Check whether a timer has fired. To prevent larger problems we simply
4413 disregard elements that are not proper timers. Do not make a circular
4414 timer list for the time being.
4415
4416 Returns the number of seconds to wait until the next timer fires. If a
4417 timer is triggering now, return zero seconds.
4418 If no timer is active, return -1 seconds.
4419
4ec4ed6a
RS
4420 If a timer is ripe, we run it, with quitting turned off.
4421
4422 DO_IT_NOW is now ignored. It used to mean that we should
4423 run the timer directly instead of queueing a timer-event.
4424 Now we always run timers directly. */
c04cbc3b
RS
4425
4426EMACS_TIME
4427timer_check (do_it_now)
4428 int do_it_now;
4429{
4430 EMACS_TIME nexttime;
9291c072
RS
4431 EMACS_TIME now, idleness_now;
4432 Lisp_Object timers, idle_timers, chosen_timer;
9291c072 4433 struct gcpro gcpro1, gcpro2, gcpro3;
c04cbc3b 4434
c04cbc3b
RS
4435 EMACS_SET_SECS (nexttime, -1);
4436 EMACS_SET_USECS (nexttime, -1);
4437
9291c072 4438 /* Always consider the ordinary timers. */
7ea13e12 4439 timers = Vtimer_list;
9291c072
RS
4440 /* Consider the idle timers only if Emacs is idle. */
4441 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4442 idle_timers = Vtimer_idle_list;
4443 else
4444 idle_timers = Qnil;
4445 chosen_timer = Qnil;
4446 GCPRO3 (timers, idle_timers, chosen_timer);
7ea13e12 4447
9291c072 4448 if (CONSP (timers) || CONSP (idle_timers))
c04cbc3b 4449 {
9291c072
RS
4450 EMACS_GET_TIME (now);
4451 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4452 EMACS_SUB_TIME (idleness_now, now, timer_idleness_start_time);
4453 }
c04cbc3b 4454
9291c072
RS
4455 while (CONSP (timers) || CONSP (idle_timers))
4456 {
9291c072 4457 Lisp_Object *vector;
8c907a56 4458 Lisp_Object timer = Qnil, idle_timer = Qnil;
9291c072
RS
4459 EMACS_TIME timer_time, idle_timer_time;
4460 EMACS_TIME difference, timer_difference, idle_timer_difference;
4461
4462 /* Skip past invalid timers and timers already handled. */
4463 if (!NILP (timers))
c04cbc3b 4464 {
7539e11f 4465 timer = XCAR (timers);
9291c072
RS
4466 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
4467 {
7539e11f 4468 timers = XCDR (timers);
9291c072
RS
4469 continue;
4470 }
4471 vector = XVECTOR (timer)->contents;
d9d4c147 4472
9291c072
RS
4473 if (!INTEGERP (vector[1]) || !INTEGERP (vector[2])
4474 || !INTEGERP (vector[3])
4475 || ! NILP (vector[0]))
4476 {
7539e11f 4477 timers = XCDR (timers);
9291c072
RS
4478 continue;
4479 }
4480 }
4481 if (!NILP (idle_timers))
4482 {
7539e11f 4483 timer = XCAR (idle_timers);
d9d4c147 4484 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
9291c072 4485 {
7539e11f 4486 idle_timers = XCDR (idle_timers);
9291c072
RS
4487 continue;
4488 }
d9d4c147
KH
4489 vector = XVECTOR (timer)->contents;
4490
4491 if (!INTEGERP (vector[1]) || !INTEGERP (vector[2])
9291c072
RS
4492 || !INTEGERP (vector[3])
4493 || ! NILP (vector[0]))
4494 {
7539e11f 4495 idle_timers = XCDR (idle_timers);
9291c072
RS
4496 continue;
4497 }
4498 }
d9d4c147 4499
9291c072
RS
4500 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4501 based on the next ordinary timer.
4502 TIMER_DIFFERENCE is the distance in time from NOW to when
4503 this timer becomes ripe (negative if it's already ripe). */
4504 if (!NILP (timers))
4505 {
7539e11f 4506 timer = XCAR (timers);
9291c072 4507 vector = XVECTOR (timer)->contents;
d9d4c147
KH
4508 EMACS_SET_SECS (timer_time,
4509 (XINT (vector[1]) << 16) | (XINT (vector[2])));
4510 EMACS_SET_USECS (timer_time, XINT (vector[3]));
9291c072
RS
4511 EMACS_SUB_TIME (timer_difference, timer_time, now);
4512 }
ba8dfba8 4513
9291c072
RS
4514 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4515 based on the next idle timer. */
4516 if (!NILP (idle_timers))
4517 {
7539e11f 4518 idle_timer = XCAR (idle_timers);
9291c072
RS
4519 vector = XVECTOR (idle_timer)->contents;
4520 EMACS_SET_SECS (idle_timer_time,
4521 (XINT (vector[1]) << 16) | (XINT (vector[2])));
4522 EMACS_SET_USECS (idle_timer_time, XINT (vector[3]));
4523 EMACS_SUB_TIME (idle_timer_difference, idle_timer_time, idleness_now);
4524 }
ba8dfba8 4525
9291c072
RS
4526 /* Decide which timer is the next timer,
4527 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4528 Also step down the list where we found that timer. */
d9d4c147 4529
9291c072
RS
4530 if (! NILP (timers) && ! NILP (idle_timers))
4531 {
4532 EMACS_TIME temp;
4533 EMACS_SUB_TIME (temp, timer_difference, idle_timer_difference);
4534 if (EMACS_TIME_NEG_P (temp))
4535 {
4536 chosen_timer = timer;
7539e11f 4537 timers = XCDR (timers);
9291c072 4538 difference = timer_difference;
c04cbc3b 4539 }
d9d4c147 4540 else
d9d4c147 4541 {
9291c072 4542 chosen_timer = idle_timer;
7539e11f 4543 idle_timers = XCDR (idle_timers);
9291c072 4544 difference = idle_timer_difference;
d9d4c147 4545 }
7ea13e12 4546 }
9291c072
RS
4547 else if (! NILP (timers))
4548 {
4549 chosen_timer = timer;
7539e11f 4550 timers = XCDR (timers);
9291c072
RS
4551 difference = timer_difference;
4552 }
4553 else
4554 {
4555 chosen_timer = idle_timer;
7539e11f 4556 idle_timers = XCDR (idle_timers);
9291c072
RS
4557 difference = idle_timer_difference;
4558 }
4559 vector = XVECTOR (chosen_timer)->contents;
c60ee5e7 4560
bd55b860 4561 /* If timer is ripe, run it if it hasn't been run. */
9291c072
RS
4562 if (EMACS_TIME_NEG_P (difference)
4563 || (EMACS_SECS (difference) == 0
4564 && EMACS_USECS (difference) == 0))
4565 {
4566 if (NILP (vector[0]))
4567 {
d925fb39 4568 int was_locked = single_kboard;
331379bf 4569 int count = SPECPDL_INDEX ();
d0bbfc99 4570 Lisp_Object old_deactivate_mark = Vdeactivate_mark;
d925fb39 4571
9291c072
RS
4572 /* Mark the timer as triggered to prevent problems if the lisp
4573 code fails to reschedule it right. */
4574 vector[0] = Qt;
4575
d925fb39 4576 specbind (Qinhibit_quit, Qt);
c60ee5e7 4577
d925fb39 4578 call1 (Qtimer_event_handler, chosen_timer);
d0bbfc99 4579 Vdeactivate_mark = old_deactivate_mark;
d925fb39 4580 timers_run++;
d925fb39 4581 unbind_to (count, Qnil);
4ec4ed6a 4582
d925fb39
RS
4583 /* Resume allowing input from any kboard, if that was true before. */
4584 if (!was_locked)
4585 any_kboard_state ();
9291c072 4586
d925fb39
RS
4587 /* Since we have handled the event,
4588 we don't need to tell the caller to wake up and do it. */
9291c072
RS
4589 }
4590 }
4591 else
4592 /* When we encounter a timer that is still waiting,
4593 return the amount of time to wait before it is ripe. */
4594 {
4595 UNGCPRO;
9291c072
RS
4596 return difference;
4597 }
c04cbc3b 4598 }
9291c072 4599
7ea13e12
RS
4600 /* No timers are pending in the future. */
4601 /* Return 0 if we generated an event, and -1 if not. */
4602 UNGCPRO;
c04cbc3b
RS
4603 return nexttime;
4604}
ff458d81
RS
4605
4606DEFUN ("current-idle-time", Fcurrent_idle_time, Scurrent_idle_time, 0, 0, 0,
cc4d4639 4607 doc: /* Return the current length of Emacs idleness.
ff458d81
RS
4608The value is returned as a list of three integers. The first has the
4609most significant 16 bits of the seconds, while the second has the
4610least significant 16 bits. The third integer gives the microsecond
4611count.
4612
4613The microsecond count is zero on systems that do not provide
4614resolution finer than a second. */)
4615 ()
4616{
ff458d81
RS
4617 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4618 {
966949b0 4619 EMACS_TIME now, idleness_now;
ff458d81 4620
966949b0
KS
4621 EMACS_GET_TIME (now);
4622 EMACS_SUB_TIME (idleness_now, now, timer_idleness_start_time);
ff458d81 4623
966949b0
KS
4624 return list3 (make_number ((EMACS_SECS (idleness_now) >> 16) & 0xffff),
4625 make_number ((EMACS_SECS (idleness_now) >> 0) & 0xffff),
4626 make_number (EMACS_USECS (idleness_now)));
ff458d81
RS
4627 }
4628
4629 return Qnil;
4630}
c04cbc3b 4631\f
284f4730 4632/* Caches for modify_event_symbol. */
e9bf89a0 4633static Lisp_Object accent_key_syms;
284f4730
JB
4634static Lisp_Object func_key_syms;
4635static Lisp_Object mouse_syms;
8006e4bb 4636static Lisp_Object wheel_syms;
a24dc617 4637static Lisp_Object drag_n_drop_syms;
284f4730 4638
e9bf89a0
RS
4639/* This is a list of keysym codes for special "accent" characters.
4640 It parallels lispy_accent_keys. */
4641
4642static int lispy_accent_codes[] =
4643{
79a7046c 4644#ifdef XK_dead_circumflex
e9bf89a0 4645 XK_dead_circumflex,
79a7046c
RS
4646#else
4647 0,
4648#endif
4649#ifdef XK_dead_grave
e9bf89a0 4650 XK_dead_grave,
79a7046c
RS
4651#else
4652 0,
4653#endif
4654#ifdef XK_dead_tilde
e9bf89a0 4655 XK_dead_tilde,
79a7046c
RS
4656#else
4657 0,
4658#endif
4659#ifdef XK_dead_diaeresis
e9bf89a0 4660 XK_dead_diaeresis,
79a7046c
RS
4661#else
4662 0,
4663#endif
4664#ifdef XK_dead_macron
e9bf89a0 4665 XK_dead_macron,
79a7046c
RS
4666#else
4667 0,
4668#endif
4669#ifdef XK_dead_degree
e9bf89a0 4670 XK_dead_degree,
79a7046c
RS
4671#else
4672 0,
4673#endif
4674#ifdef XK_dead_acute
e9bf89a0 4675 XK_dead_acute,
79a7046c
RS
4676#else
4677 0,
4678#endif
4679#ifdef XK_dead_cedilla
e9bf89a0 4680 XK_dead_cedilla,
79a7046c
RS
4681#else
4682 0,
4683#endif
4684#ifdef XK_dead_breve
e9bf89a0 4685 XK_dead_breve,
79a7046c
RS
4686#else
4687 0,
4688#endif
4689#ifdef XK_dead_ogonek
e9bf89a0 4690 XK_dead_ogonek,
79a7046c
RS
4691#else
4692 0,
4693#endif
4694#ifdef XK_dead_caron
e9bf89a0 4695 XK_dead_caron,
79a7046c
RS
4696#else
4697 0,
4698#endif
4699#ifdef XK_dead_doubleacute
e9bf89a0 4700 XK_dead_doubleacute,
79a7046c
RS
4701#else
4702 0,
4703#endif
4704#ifdef XK_dead_abovedot
e9bf89a0 4705 XK_dead_abovedot,
79a7046c
RS
4706#else
4707 0,
4708#endif
ed3230db
DL
4709#ifdef XK_dead_abovering
4710 XK_dead_abovering,
4711#else
4712 0,
4713#endif
4714#ifdef XK_dead_iota
4715 XK_dead_iota,
4716#else
4717 0,
4718#endif
4719#ifdef XK_dead_belowdot
4720 XK_dead_belowdot,
4721#else
4722 0,
4723#endif
4724#ifdef XK_dead_voiced_sound
4725 XK_dead_voiced_sound,
4726#else
4727 0,
4728#endif
4729#ifdef XK_dead_semivoiced_sound
4730 XK_dead_semivoiced_sound,
4731#else
4732 0,
4733#endif
4734#ifdef XK_dead_hook
4735 XK_dead_hook,
4736#else
4737 0,
4738#endif
4739#ifdef XK_dead_horn
4740 XK_dead_horn,
4741#else
4742 0,
4743#endif
e9bf89a0
RS
4744};
4745
4746/* This is a list of Lisp names for special "accent" characters.
4747 It parallels lispy_accent_codes. */
4748
4749static char *lispy_accent_keys[] =
4750{
4751 "dead-circumflex",
4752 "dead-grave",
4753 "dead-tilde",
4754 "dead-diaeresis",
4755 "dead-macron",
4756 "dead-degree",
4757 "dead-acute",
4758 "dead-cedilla",
4759 "dead-breve",
4760 "dead-ogonek",
4761 "dead-caron",
4762 "dead-doubleacute",
4763 "dead-abovedot",
ed3230db
DL
4764 "dead-abovering",
4765 "dead-iota",
4766 "dead-belowdot",
4767 "dead-voiced-sound",
4768 "dead-semivoiced-sound",
4769 "dead-hook",
4770 "dead-horn",
e9bf89a0
RS
4771};
4772
e98a93eb
GV
4773#ifdef HAVE_NTGUI
4774#define FUNCTION_KEY_OFFSET 0x0
4775
4776char *lispy_function_keys[] =
4777 {
4778 0, /* 0 */
c60ee5e7 4779
e98a93eb
GV
4780 0, /* VK_LBUTTON 0x01 */
4781 0, /* VK_RBUTTON 0x02 */
4782 "cancel", /* VK_CANCEL 0x03 */
4783 0, /* VK_MBUTTON 0x04 */
c60ee5e7 4784
e98a93eb 4785 0, 0, 0, /* 0x05 .. 0x07 */
c60ee5e7 4786
e98a93eb
GV
4787 "backspace", /* VK_BACK 0x08 */
4788 "tab", /* VK_TAB 0x09 */
c60ee5e7 4789
e98a93eb 4790 0, 0, /* 0x0A .. 0x0B */
c60ee5e7 4791
e98a93eb
GV
4792 "clear", /* VK_CLEAR 0x0C */
4793 "return", /* VK_RETURN 0x0D */
c60ee5e7 4794
e98a93eb 4795 0, 0, /* 0x0E .. 0x0F */
c60ee5e7 4796
1161d367
GV
4797 0, /* VK_SHIFT 0x10 */
4798 0, /* VK_CONTROL 0x11 */
4799 0, /* VK_MENU 0x12 */
e98a93eb 4800 "pause", /* VK_PAUSE 0x13 */
1161d367 4801 "capslock", /* VK_CAPITAL 0x14 */
c60ee5e7 4802
e98a93eb 4803 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
c60ee5e7 4804
1161d367 4805 "escape", /* VK_ESCAPE 0x1B */
c60ee5e7 4806
e98a93eb 4807 0, 0, 0, 0, /* 0x1C .. 0x1F */
c60ee5e7 4808
e98a93eb
GV
4809 0, /* VK_SPACE 0x20 */
4810 "prior", /* VK_PRIOR 0x21 */
4811 "next", /* VK_NEXT 0x22 */
4812 "end", /* VK_END 0x23 */
4813 "home", /* VK_HOME 0x24 */
4814 "left", /* VK_LEFT 0x25 */
4815 "up", /* VK_UP 0x26 */
4816 "right", /* VK_RIGHT 0x27 */
4817 "down", /* VK_DOWN 0x28 */
4818 "select", /* VK_SELECT 0x29 */
4819 "print", /* VK_PRINT 0x2A */
4820 "execute", /* VK_EXECUTE 0x2B */
4821 "snapshot", /* VK_SNAPSHOT 0x2C */
4822 "insert", /* VK_INSERT 0x2D */
4823 "delete", /* VK_DELETE 0x2E */
4824 "help", /* VK_HELP 0x2F */
c60ee5e7 4825
e98a93eb 4826 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
c60ee5e7 4827
e98a93eb 4828 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
c60ee5e7 4829
e98a93eb 4830 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
c60ee5e7 4831
e98a93eb 4832 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
c60ee5e7
JB
4833
4834 0, 0, 0, 0, 0, 0, 0, 0, 0,
4835 0, 0, 0, 0, 0, 0, 0, 0, 0,
e98a93eb 4836 0, 0, 0, 0, 0, 0, 0, 0,
c60ee5e7 4837
e376f90d
RS
4838 "lwindow", /* VK_LWIN 0x5B */
4839 "rwindow", /* VK_RWIN 0x5C */
4840 "apps", /* VK_APPS 0x5D */
c60ee5e7 4841
e98a93eb 4842 0, 0, /* 0x5E .. 0x5F */
c60ee5e7 4843
e98a93eb
GV
4844 "kp-0", /* VK_NUMPAD0 0x60 */
4845 "kp-1", /* VK_NUMPAD1 0x61 */
4846 "kp-2", /* VK_NUMPAD2 0x62 */
4847 "kp-3", /* VK_NUMPAD3 0x63 */
4848 "kp-4", /* VK_NUMPAD4 0x64 */
4849 "kp-5", /* VK_NUMPAD5 0x65 */
4850 "kp-6", /* VK_NUMPAD6 0x66 */
4851 "kp-7", /* VK_NUMPAD7 0x67 */
4852 "kp-8", /* VK_NUMPAD8 0x68 */
4853 "kp-9", /* VK_NUMPAD9 0x69 */
4854 "kp-multiply", /* VK_MULTIPLY 0x6A */
4855 "kp-add", /* VK_ADD 0x6B */
4856 "kp-separator", /* VK_SEPARATOR 0x6C */
4857 "kp-subtract", /* VK_SUBTRACT 0x6D */
4858 "kp-decimal", /* VK_DECIMAL 0x6E */
4859 "kp-divide", /* VK_DIVIDE 0x6F */
4860 "f1", /* VK_F1 0x70 */
4861 "f2", /* VK_F2 0x71 */
4862 "f3", /* VK_F3 0x72 */
4863 "f4", /* VK_F4 0x73 */
4864 "f5", /* VK_F5 0x74 */
4865 "f6", /* VK_F6 0x75 */
4866 "f7", /* VK_F7 0x76 */
4867 "f8", /* VK_F8 0x77 */
4868 "f9", /* VK_F9 0x78 */
4869 "f10", /* VK_F10 0x79 */
4870 "f11", /* VK_F11 0x7A */
4871 "f12", /* VK_F12 0x7B */
4872 "f13", /* VK_F13 0x7C */
4873 "f14", /* VK_F14 0x7D */
4874 "f15", /* VK_F15 0x7E */
4875 "f16", /* VK_F16 0x7F */
4876 "f17", /* VK_F17 0x80 */
4877 "f18", /* VK_F18 0x81 */
4878 "f19", /* VK_F19 0x82 */
4879 "f20", /* VK_F20 0x83 */
4880 "f21", /* VK_F21 0x84 */
4881 "f22", /* VK_F22 0x85 */
4882 "f23", /* VK_F23 0x86 */
4883 "f24", /* VK_F24 0x87 */
c60ee5e7 4884
e98a93eb
GV
4885 0, 0, 0, 0, /* 0x88 .. 0x8B */
4886 0, 0, 0, 0, /* 0x8C .. 0x8F */
c60ee5e7 4887
e98a93eb
GV
4888 "kp-numlock", /* VK_NUMLOCK 0x90 */
4889 "scroll", /* VK_SCROLL 0x91 */
c60ee5e7 4890
e376f90d
RS
4891 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4892 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4893 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4894 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4895 "kp-end", /* VK_NUMPAD_END 0x96 */
4896 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4897 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4898 "kp-up", /* VK_NUMPAD_UP 0x99 */
4899 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4900 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4901 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4902 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4903
4904 0, 0, /* 0x9E .. 0x9F */
4905
e98a93eb
GV
4906 /*
4907 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
e8886a1d 4908 * Used only as parameters to GetAsyncKeyState and GetKeyState.
e98a93eb
GV
4909 * No other API or message will distinguish left and right keys this way.
4910 */
4911 /* 0xA0 .. 0xEF */
c60ee5e7 4912
e98a93eb
GV
4913 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4914 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4915 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4916 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4917 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
c60ee5e7 4918
e98a93eb 4919 /* 0xF0 .. 0xF5 */
c60ee5e7 4920
e98a93eb 4921 0, 0, 0, 0, 0, 0,
c60ee5e7 4922
e98a93eb
GV
4923 "attn", /* VK_ATTN 0xF6 */
4924 "crsel", /* VK_CRSEL 0xF7 */
4925 "exsel", /* VK_EXSEL 0xF8 */
4926 "ereof", /* VK_EREOF 0xF9 */
4927 "play", /* VK_PLAY 0xFA */
4928 "zoom", /* VK_ZOOM 0xFB */
4929 "noname", /* VK_NONAME 0xFC */
4930 "pa1", /* VK_PA1 0xFD */
4931 "oem_clear", /* VK_OEM_CLEAR 0xFE */
1161d367 4932 0 /* 0xFF */
e98a93eb
GV
4933 };
4934
04f215f0 4935#else /* not HAVE_NTGUI */
e98a93eb 4936
ed3230db
DL
4937/* This should be dealt with in XTread_socket now, and that doesn't
4938 depend on the client system having the Kana syms defined. See also
4939 the XK_kana_A case below. */
4940#if 0
37cd9f30
KH
4941#ifdef XK_kana_A
4942static char *lispy_kana_keys[] =
4943 {
4944 /* X Keysym value */
4945 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4946 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4947 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4948 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4949 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4950 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4951 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4952 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4953 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4954 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
c60ee5e7 4955 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
37cd9f30
KH
4956 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4957 "kana-i", "kana-u", "kana-e", "kana-o",
4958 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4959 "prolongedsound", "kana-A", "kana-I", "kana-U",
4960 "kana-E", "kana-O", "kana-KA", "kana-KI",
4961 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4962 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4963 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4964 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4965 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4966 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4967 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4968 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4969 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4970 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4971 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4972 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4973 };
4974#endif /* XK_kana_A */
ed3230db 4975#endif /* 0 */
37cd9f30 4976
04f215f0
RS
4977#define FUNCTION_KEY_OFFSET 0xff00
4978
284f4730
JB
4979/* You'll notice that this table is arranged to be conveniently
4980 indexed by X Windows keysym values. */
4981static char *lispy_function_keys[] =
4982 {
4983 /* X Keysym value */
4984
75045dcb
RS
4985 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4986 "backspace", "tab", "linefeed", "clear",
4987 0, "return", 0, 0,
4988 0, 0, 0, "pause", /* 0xff10...1f */
4989 0, 0, 0, 0, 0, 0, 0, "escape",
86e5706b 4990 0, 0, 0, 0,
75045dcb
RS
4991 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4992 "romaji", "hiragana", "katakana", "hiragana-katakana",
4993 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4994 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4995 "eisu-toggle", /* 0xff30...3f */
4996 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
86e5706b
RS
4997 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4998
75045dcb
RS
4999 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5000 "down", "prior", "next", "end",
5001 "begin", 0, 0, 0, 0, 0, 0, 0,
284f4730
JB
5002 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5003 "print",
5004 "execute",
5005 "insert",
5006 0, /* 0xff64 */
5007 "undo",
5008 "redo",
5009 "menu",
5010 "find",
5011 "cancel",
5012 "help",
5013 "break", /* 0xff6b */
5014
75045dcb
RS
5015 0, 0, 0, 0,
5016 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5017 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
284f4730
JB
5018 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5019 0, 0, 0, 0, 0, 0, 0, 0,
5020 "kp-tab", /* 0xff89 */
5021 0, 0, 0,
5022 "kp-enter", /* 0xff8d */
5023 0, 0, 0,
5024 "kp-f1", /* 0xff91 */
5025 "kp-f2",
5026 "kp-f3",
5027 "kp-f4",
872157e7
RS
5028 "kp-home", /* 0xff95 */
5029 "kp-left",
5030 "kp-up",
5031 "kp-right",
5032 "kp-down",
5033 "kp-prior", /* kp-page-up */
5034 "kp-next", /* kp-page-down */
5035 "kp-end",
5036 "kp-begin",
5037 "kp-insert",
5038 "kp-delete",
5039 0, /* 0xffa0 */
5040 0, 0, 0, 0, 0, 0, 0, 0, 0,
284f4730
JB
5041 "kp-multiply", /* 0xffaa */
5042 "kp-add",
5043 "kp-separator",
5044 "kp-subtract",
5045 "kp-decimal",
5046 "kp-divide", /* 0xffaf */
5047 "kp-0", /* 0xffb0 */
5048 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5049 0, /* 0xffba */
5050 0, 0,
5051 "kp-equal", /* 0xffbd */
5052 "f1", /* 0xffbe */ /* IsFunctionKey */
86e5706b
RS
5053 "f2",
5054 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5055 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5056 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5057 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5058 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5059 0, 0, 0, 0, 0, 0, 0, 0,
5060 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5061 0, 0, 0, 0, 0, 0, 0, "delete"
04f215f0 5062 };
284f4730 5063
04f215f0
RS
5064/* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5065#define ISO_FUNCTION_KEY_OFFSET 0xfe00
5066
5067static char *iso_lispy_function_keys[] =
5068 {
5069 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5070 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5071 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5072 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5073 "iso-lefttab", /* 0xfe20 */
c60ee5e7
JB
5074 "iso-move-line-up", "iso-move-line-down",
5075 "iso-partial-line-up", "iso-partial-line-down",
5076 "iso-partial-space-left", "iso-partial-space-right",
04f215f0
RS
5077 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5078 "iso-release-margin-left", "iso-release-margin-right",
5079 "iso-release-both-margins",
5080 "iso-fast-cursor-left", "iso-fast-cursor-right",
5081 "iso-fast-cursor-up", "iso-fast-cursor-down",
5082 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5083 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5084 };
5085
5086#endif /* not HAVE_NTGUI */
e98a93eb 5087
8e1e4240 5088Lisp_Object Vlispy_mouse_stem;
284f4730 5089
8006e4bb
JR
5090static char *lispy_wheel_names[] =
5091{
5092 "wheel-up", "wheel-down"
5093};
5094
a24dc617
RS
5095/* drag-n-drop events are generated when a set of selected files are
5096 dragged from another application and dropped onto an Emacs window. */
5097static char *lispy_drag_n_drop_names[] =
5098{
5099 "drag-n-drop"
5100};
5101
3c370943 5102/* Scroll bar parts. */
4bb994d1 5103Lisp_Object Qabove_handle, Qhandle, Qbelow_handle;
7ee32cda 5104Lisp_Object Qup, Qdown, Qbottom, Qend_scroll;
eef28553 5105Lisp_Object Qtop, Qratio;
4bb994d1 5106
3c370943
JB
5107/* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5108Lisp_Object *scroll_bar_parts[] = {
db08707d 5109 &Qabove_handle, &Qhandle, &Qbelow_handle,
eef28553 5110 &Qup, &Qdown, &Qtop, &Qbottom, &Qend_scroll, &Qratio
4bb994d1
JB
5111};
5112
7b4aedb9 5113/* A vector, indexed by button number, giving the down-going location
3c370943 5114 of currently depressed buttons, both scroll bar and non-scroll bar.
7b4aedb9
JB
5115
5116 The elements have the form
5117 (BUTTON-NUMBER MODIFIER-MASK . REST)
5118 where REST is the cdr of a position as it would be reported in the event.
5119
5120 The make_lispy_event function stores positions here to tell the
5121 difference between click and drag events, and to store the starting
5122 location to be included in drag events. */
5123
5124static Lisp_Object button_down_location;
88cb0656 5125
fbcd35bd
JB
5126/* Information about the most recent up-going button event: Which
5127 button, what location, and what time. */
5128
559f9d04
RS
5129static int last_mouse_button;
5130static int last_mouse_x;
5131static int last_mouse_y;
5132static unsigned long button_down_time;
fbcd35bd 5133
222d557c
GM
5134/* The maximum time between clicks to make a double-click, or Qnil to
5135 disable double-click detection, or Qt for no time limit. */
5136
564dc952 5137Lisp_Object Vdouble_click_time;
fbcd35bd 5138
222d557c
GM
5139/* Maximum number of pixels the mouse may be moved between clicks
5140 to make a double-click. */
5141
31ade731 5142EMACS_INT double_click_fuzz;
222d557c 5143
fbcd35bd
JB
5144/* The number of clicks in this multiple-click. */
5145
5146int double_click_count;
5147
3d566707
KS
5148/* Return position of a mouse click or wheel event */
5149
5150static Lisp_Object
5151make_lispy_position (f, x, y, time)
5152 struct frame *f;
5153 Lisp_Object *x, *y;
5154 unsigned long time;
5155{
5156 Lisp_Object window;
5157 enum window_part part;
5158 Lisp_Object posn = Qnil;
5159 Lisp_Object extra_info = Qnil;
5160 int wx, wy;
5161
5162 /* Set `window' to the window under frame pixel coordinates (x,y) */
5163 if (f)
5164 window = window_from_coordinates (f, XINT (*x), XINT (*y),
5165 &part, &wx, &wy, 0);
5166 else
5167 window = Qnil;
5168
5169 if (WINDOWP (window))
5170 {
5171 /* It's a click in window window at frame coordinates (x,y) */
5172 struct window *w = XWINDOW (window);
eee5863b 5173 Lisp_Object string_info = Qnil;
3d566707 5174 int textpos = -1, rx = -1, ry = -1;
45de137a 5175 int dx = -1, dy = -1;
eee5863b
KS
5176 int width = -1, height = -1;
5177 Lisp_Object object = Qnil;
3d566707
KS
5178
5179 /* Set event coordinates to window-relative coordinates
5180 for constructing the Lisp event below. */
5181 XSETINT (*x, wx);
5182 XSETINT (*y, wy);
5183
6507c4c7
KS
5184 if (part == ON_TEXT)
5185 {
5186 wx += WINDOW_LEFT_MARGIN_WIDTH (w);
5187 }
5188 else if (part == ON_MODE_LINE || part == ON_HEADER_LINE)
3d566707
KS
5189 {
5190 /* Mode line or header line. Look for a string under
5191 the mouse that may have a `local-map' property. */
5192 Lisp_Object string;
5193 int charpos;
5194
5195 posn = part == ON_MODE_LINE ? Qmode_line : Qheader_line;
5196 rx = wx, ry = wy;
eee5863b
KS
5197 string = mode_line_string (w, part, &rx, &ry, &charpos,
5198 &object, &dx, &dy, &width, &height);
3d566707 5199 if (STRINGP (string))
eee5863b 5200 string_info = Fcons (string, make_number (charpos));
3d566707
KS
5201 if (w == XWINDOW (selected_window))
5202 textpos = PT;
5203 else
5204 textpos = XMARKER (w->pointm)->charpos;
5205 }
5206 else if (part == ON_VERTICAL_BORDER)
5207 {
5208 posn = Qvertical_line;
5209 wx = -1;
45de137a 5210 dx = 0;
eee5863b 5211 width = 1;
3d566707
KS
5212 }
5213 else if (part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
5214 {
5215 Lisp_Object string;
5216 int charpos;
2320865d 5217
3d566707
KS
5218 posn = (part == ON_LEFT_MARGIN) ? Qleft_margin : Qright_margin;
5219 rx = wx, ry = wy;
eee5863b
KS
5220 string = marginal_area_string (w, part, &rx, &ry, &charpos,
5221 &object, &dx, &dy, &width, &height);
3d566707 5222 if (STRINGP (string))
eee5863b 5223 string_info = Fcons (string, make_number (charpos));
a65fc2c3
KS
5224 if (part == ON_LEFT_MARGIN)
5225 wx = 0;
5226 else
5227 wx = window_box_right_offset (w, TEXT_AREA) - 1;
5228 }
5229 else if (part == ON_LEFT_FRINGE)
5230 {
5231 posn = Qleft_fringe;
5232 rx = 0;
5233 dx = wx;
5234 wx = (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5235 ? 0
5236 : window_box_width (w, LEFT_MARGIN_AREA));
5237 dx -= wx;
3d566707 5238 }
a65fc2c3 5239 else if (part == ON_RIGHT_FRINGE)
3d566707 5240 {
a65fc2c3 5241 posn = Qright_fringe;
3d566707 5242 rx = 0;
45de137a 5243 dx = wx;
a65fc2c3
KS
5244 wx = (window_box_width (w, LEFT_MARGIN_AREA)
5245 + window_box_width (w, TEXT_AREA)
5246 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5247 ? window_box_width (w, RIGHT_MARGIN_AREA)
5248 : 0));
5249 dx -= wx;
5250 }
5251 else
5252 {
5253 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5254 wx = max (WINDOW_LEFT_MARGIN_WIDTH (w), wx);
3d566707
KS
5255 }
5256
5257 if (textpos < 0)
5258 {
eee5863b 5259 Lisp_Object string2, object2 = Qnil;
3d566707 5260 struct display_pos p;
45de137a 5261 int dx2, dy2;
eee5863b 5262 int width2, height2;
eee5863b
KS
5263 string2 = buffer_posn_from_coords (w, &wx, &wy, &p,
5264 &object2, &dx2, &dy2,
5265 &width2, &height2);
3d566707 5266 textpos = CHARPOS (p.pos);
45de137a
KS
5267 if (rx < 0) rx = wx;
5268 if (ry < 0) ry = wy;
5269 if (dx < 0) dx = dx2;
5270 if (dy < 0) dy = dy2;
eee5863b
KS
5271 if (width < 0) width = width2;
5272 if (height < 0) height = height2;
3d566707
KS
5273
5274 if (NILP (posn))
5275 {
5276 posn = make_number (textpos);
eee5863b
KS
5277 if (STRINGP (string2))
5278 string_info = Fcons (string2,
5279 make_number (CHARPOS (p.string_pos)));
3d566707 5280 }
eee5863b
KS
5281 if (NILP (object))
5282 object = object2;
3d566707
KS
5283 }
5284
eee5863b
KS
5285#ifdef HAVE_WINDOW_SYSTEM
5286 if (IMAGEP (object))
5287 {
5288 Lisp_Object image_map, hotspot;
5289 if ((image_map = Fplist_get (XCDR (object), QCmap),
5290 !NILP (image_map))
5291 && (hotspot = find_hot_spot (image_map, dx, dy),
5292 CONSP (hotspot))
5293 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
5294 posn = XCAR (hotspot);
5295 }
5296#endif
5297
5298 /* Object info */
3d566707 5299 extra_info = Fcons (object,
eee5863b
KS
5300 Fcons (Fcons (make_number (dx),
5301 make_number (dy)),
5302 Fcons (Fcons (make_number (width),
5303 make_number (height)),
5304 Qnil)));
5305
5306 /* String info */
5307 extra_info = Fcons (string_info,
3d566707
KS
5308 Fcons (make_number (textpos),
5309 Fcons (Fcons (make_number (rx),
5310 make_number (ry)),
eee5863b 5311 extra_info)));
3d566707
KS
5312 }
5313 else if (f != 0)
5314 {
5315 XSETFRAME (window, f);
5316 }
5317 else
5318 {
5319 window = Qnil;
5320 XSETFASTINT (*x, 0);
5321 XSETFASTINT (*y, 0);
5322 }
5323
5324 return Fcons (window,
5325 Fcons (posn,
5326 Fcons (Fcons (*x, *y),
5327 Fcons (make_number (time),
5328 extra_info))));
5329}
5330
284f4730
JB
5331/* Given a struct input_event, build the lisp event which represents
5332 it. If EVENT is 0, build a mouse movement event from the mouse
88cb0656
JB
5333 movement buffer, which should have a movement event in it.
5334
5335 Note that events must be passed to this function in the order they
5336 are received; this function stores the location of button presses
5337 in order to build drag events when the button is released. */
284f4730
JB
5338
5339static Lisp_Object
5340make_lispy_event (event)
5341 struct input_event *event;
5342{
79a7046c
RS
5343 int i;
5344
0220c518 5345 switch (SWITCH_ENUM_CAST (event->kind))
284f4730 5346 {
284f4730 5347 /* A simple keystroke. */
3b8f9651 5348 case ASCII_KEYSTROKE_EVENT:
86e5706b 5349 {
9343ab07 5350 Lisp_Object lispy_c;
e9bf89a0 5351 int c = event->code & 0377;
5a1c6df8
JB
5352 /* Turn ASCII characters into control characters
5353 when proper. */
5354 if (event->modifiers & ctrl_modifier)
d205953b
JB
5355 c = make_ctrl_char (c);
5356
5357 /* Add in the other modifier bits. We took care of ctrl_modifier
5358 just above, and the shift key was taken care of by the X code,
5359 and applied to control characters by make_ctrl_char. */
86e5706b
RS
5360 c |= (event->modifiers
5361 & (meta_modifier | alt_modifier
5362 | hyper_modifier | super_modifier));
32454a9f
RS
5363 /* Distinguish Shift-SPC from SPC. */
5364 if ((event->code & 0377) == 040
5365 && event->modifiers & shift_modifier)
5366 c |= shift_modifier;
559f9d04 5367 button_down_time = 0;
bb9e9bed 5368 XSETFASTINT (lispy_c, c);
9343ab07 5369 return lispy_c;
86e5706b 5370 }
284f4730 5371
3b8f9651 5372 case MULTIBYTE_CHAR_KEYSTROKE_EVENT:
a50e723f
KH
5373 {
5374 Lisp_Object lispy_c;
24d80a06 5375 int c = event->code;
a50e723f 5376
24d80a06
SM
5377 /* Add in the other modifier bits. We took care of ctrl_modifier
5378 just above, and the shift key was taken care of by the X code,
5379 and applied to control characters by make_ctrl_char. */
5380 c |= (event->modifiers
5381 & (meta_modifier | alt_modifier
5382 | hyper_modifier | super_modifier | ctrl_modifier));
5383 /* What about the `shift' modifier ? */
5384 button_down_time = 0;
5385 XSETFASTINT (lispy_c, c);
a50e723f
KH
5386 return lispy_c;
5387 }
5388
284f4730
JB
5389 /* A function key. The symbol may need to have modifier prefixes
5390 tacked onto it. */
3b8f9651 5391 case NON_ASCII_KEYSTROKE_EVENT:
559f9d04 5392 button_down_time = 0;
e9bf89a0
RS
5393
5394 for (i = 0; i < sizeof (lispy_accent_codes) / sizeof (int); i++)
5395 if (event->code == lispy_accent_codes[i])
5396 return modify_event_symbol (i,
5397 event->modifiers,
80e4aa30 5398 Qfunction_key, Qnil,
e9bf89a0
RS
5399 lispy_accent_keys, &accent_key_syms,
5400 (sizeof (lispy_accent_keys)
5401 / sizeof (lispy_accent_keys[0])));
5402
ed3230db 5403#if 0
37cd9f30
KH
5404#ifdef XK_kana_A
5405 if (event->code >= 0x400 && event->code < 0x500)
5406 return modify_event_symbol (event->code - 0x400,
5407 event->modifiers & ~shift_modifier,
5408 Qfunction_key, Qnil,
5409 lispy_kana_keys, &func_key_syms,
5410 (sizeof (lispy_kana_keys)
5411 / sizeof (lispy_kana_keys[0])));
5412#endif /* XK_kana_A */
ed3230db 5413#endif /* 0 */
37cd9f30 5414
111c4138 5415#ifdef ISO_FUNCTION_KEY_OFFSET
04f215f0
RS
5416 if (event->code < FUNCTION_KEY_OFFSET
5417 && event->code >= ISO_FUNCTION_KEY_OFFSET)
5418 return modify_event_symbol (event->code - ISO_FUNCTION_KEY_OFFSET,
5419 event->modifiers,
5420 Qfunction_key, Qnil,
5421 iso_lispy_function_keys, &func_key_syms,
5422 (sizeof (iso_lispy_function_keys)
5423 / sizeof (iso_lispy_function_keys[0])));
111c4138 5424#endif
656280a6 5425
4c8bc894
SM
5426 /* Handle system-specific or unknown keysyms. */
5427 if (event->code & (1 << 28)
5428 || event->code - FUNCTION_KEY_OFFSET < 0
656280a6 5429 || (event->code - FUNCTION_KEY_OFFSET
4c8bc894
SM
5430 >= sizeof lispy_function_keys / sizeof *lispy_function_keys)
5431 || !lispy_function_keys[event->code - FUNCTION_KEY_OFFSET])
656280a6 5432 {
4c8bc894
SM
5433 /* We need to use an alist rather than a vector as the cache
5434 since we can't make a vector long enuf. */
5435 if (NILP (current_kboard->system_key_syms))
5436 current_kboard->system_key_syms = Fcons (Qnil, Qnil);
5437 return modify_event_symbol (event->code,
5438 event->modifiers,
5439 Qfunction_key,
5440 current_kboard->Vsystem_key_alist,
5441 0, &current_kboard->system_key_syms,
5442 (unsigned) -1);
656280a6 5443 }
656280a6
GM
5444
5445 return modify_event_symbol (event->code - FUNCTION_KEY_OFFSET,
5446 event->modifiers,
5447 Qfunction_key, Qnil,
5448 lispy_function_keys, &func_key_syms,
5449 (sizeof (lispy_function_keys)
5450 / sizeof (lispy_function_keys[0])));
284f4730 5451
514354e9 5452#ifdef HAVE_MOUSE
df0f2ba1 5453 /* A mouse click. Figure out where it is, decide whether it's
88cb0656 5454 a press, click or drag, and build the appropriate structure. */
3b8f9651 5455 case MOUSE_CLICK_EVENT:
7ee32cda 5456#ifndef USE_TOOLKIT_SCROLL_BARS
3b8f9651 5457 case SCROLL_BAR_CLICK_EVENT:
7ee32cda 5458#endif
284f4730 5459 {
e9bf89a0 5460 int button = event->code;
559f9d04 5461 int is_double;
7b4aedb9 5462 Lisp_Object position;
dbc4e1c1
JB
5463 Lisp_Object *start_pos_ptr;
5464 Lisp_Object start_pos;
284f4730 5465
8c907a56
GM
5466 position = Qnil;
5467
7b4aedb9 5468 /* Build the position as appropriate for this mouse click. */
3b8f9651 5469 if (event->kind == MOUSE_CLICK_EVENT)
284f4730 5470 {
c5cf2109 5471 struct frame *f = XFRAME (event->frame_or_window);
3d566707 5472#if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
9e20143a 5473 int row, column;
3d566707 5474#endif
9e20143a 5475
5da3133a
RS
5476 /* Ignore mouse events that were made on frame that
5477 have been deleted. */
5478 if (! FRAME_LIVE_P (f))
5479 return Qnil;
5480
3d566707 5481#if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
7ee32cda
GM
5482 /* EVENT->x and EVENT->y are frame-relative pixel
5483 coordinates at this place. Under old redisplay, COLUMN
5484 and ROW are set to frame relative glyph coordinates
5485 which are then used to determine whether this click is
5486 in a menu (non-toolkit version). */
5487 pixel_to_glyph_coords (f, XINT (event->x), XINT (event->y),
5488 &column, &row, NULL, 1);
7b4aedb9 5489
eef045bf
RS
5490 /* In the non-toolkit version, clicks on the menu bar
5491 are ordinary button events in the event buffer.
5492 Distinguish them, and invoke the menu.
5493
5494 (In the toolkit version, the toolkit handles the menu bar
5495 and Emacs doesn't know about it until after the user
5496 makes a selection.) */
2ee250ec
RS
5497 if (row >= 0 && row < FRAME_MENU_BAR_LINES (f)
5498 && (event->modifiers & down_modifier))
bb936752 5499 {
b7c49376 5500 Lisp_Object items, item;
0a0e8fe6
RS
5501 int hpos;
5502 int i;
5503
2ee250ec 5504#if 0
0a0e8fe6
RS
5505 /* Activate the menu bar on the down event. If the
5506 up event comes in before the menu code can deal with it,
5507 just ignore it. */
5508 if (! (event->modifiers & down_modifier))
5509 return Qnil;
2ee250ec 5510#endif
0aafc975 5511
7ee32cda 5512 /* Find the menu bar item under `column'. */
f2ae6b3f 5513 item = Qnil;
5ec75a55 5514 items = FRAME_MENU_BAR_ITEMS (f);
35b3402f 5515 for (i = 0; i < XVECTOR (items)->size; i += 4)
5ec75a55
RS
5516 {
5517 Lisp_Object pos, string;
129004d3
GM
5518 string = AREF (items, i + 1);
5519 pos = AREF (items, i + 3);
b7c49376
RS
5520 if (NILP (string))
5521 break;
9e20143a 5522 if (column >= XINT (pos)
d5db4077 5523 && column < XINT (pos) + SCHARS (string))
b7c49376 5524 {
129004d3 5525 item = AREF (items, i);
b7c49376
RS
5526 break;
5527 }
5ec75a55 5528 }
9e20143a 5529
7ee32cda
GM
5530 /* ELisp manual 2.4b says (x y) are window relative but
5531 code says they are frame-relative. */
5ec75a55
RS
5532 position
5533 = Fcons (event->frame_or_window,
5534 Fcons (Qmenu_bar,
5535 Fcons (Fcons (event->x, event->y),
5536 Fcons (make_number (event->timestamp),
5537 Qnil))));
5538
b7c49376 5539 return Fcons (item, Fcons (position, Qnil));
5ec75a55 5540 }
488dd4c4 5541#endif /* not USE_X_TOOLKIT && not USE_GTK */
0aafc975 5542
3d566707
KS
5543 position = make_lispy_position (f, &event->x, &event->y,
5544 event->timestamp);
284f4730 5545 }
7ee32cda 5546#ifndef USE_TOOLKIT_SCROLL_BARS
7b4aedb9 5547 else
88cb0656 5548 {
7ee32cda 5549 /* It's a scrollbar click. */
3d566707 5550 Lisp_Object window;
9e20143a
RS
5551 Lisp_Object portion_whole;
5552 Lisp_Object part;
5553
5554 window = event->frame_or_window;
5555 portion_whole = Fcons (event->x, event->y);
5556 part = *scroll_bar_parts[(int) event->part];
7b4aedb9 5557
db08707d
RS
5558 position
5559 = Fcons (window,
5560 Fcons (Qvertical_scroll_bar,
5561 Fcons (portion_whole,
5562 Fcons (make_number (event->timestamp),
5563 Fcons (part, Qnil)))));
88cb0656 5564 }
7ee32cda 5565#endif /* not USE_TOOLKIT_SCROLL_BARS */
88cb0656 5566
129004d3 5567 if (button >= ASIZE (button_down_location))
8e1e4240
GM
5568 {
5569 button_down_location = larger_vector (button_down_location,
5570 button + 1, Qnil);
5571 mouse_syms = larger_vector (mouse_syms, button + 1, Qnil);
5572 }
c60ee5e7 5573
129004d3 5574 start_pos_ptr = &AREF (button_down_location, button);
dbc4e1c1
JB
5575 start_pos = *start_pos_ptr;
5576 *start_pos_ptr = Qnil;
7b4aedb9 5577
c5cf2109
GM
5578 {
5579 /* On window-system frames, use the value of
5580 double-click-fuzz as is. On other frames, interpret it
5581 as a multiple of 1/8 characters. */
5582 struct frame *f;
5583 int fuzz;
5584
5585 if (WINDOWP (event->frame_or_window))
5586 f = XFRAME (XWINDOW (event->frame_or_window)->frame);
5587 else if (FRAMEP (event->frame_or_window))
5588 f = XFRAME (event->frame_or_window);
5589 else
5590 abort ();
5591
5592 if (FRAME_WINDOW_P (f))
5593 fuzz = double_click_fuzz;
5594 else
5595 fuzz = double_click_fuzz / 8;
5596
5597 is_double = (button == last_mouse_button
5598 && (abs (XINT (event->x) - last_mouse_x) <= fuzz)
5599 && (abs (XINT (event->y) - last_mouse_y) <= fuzz)
5600 && button_down_time != 0
5601 && (EQ (Vdouble_click_time, Qt)
5602 || (INTEGERP (Vdouble_click_time)
5603 && ((int)(event->timestamp - button_down_time)
5604 < XINT (Vdouble_click_time)))));
5605 }
c60ee5e7 5606
559f9d04
RS
5607 last_mouse_button = button;
5608 last_mouse_x = XINT (event->x);
5609 last_mouse_y = XINT (event->y);
5610
7b4aedb9
JB
5611 /* If this is a button press, squirrel away the location, so
5612 we can decide later whether it was a click or a drag. */
5613 if (event->modifiers & down_modifier)
559f9d04
RS
5614 {
5615 if (is_double)
5616 {
5617 double_click_count++;
5618 event->modifiers |= ((double_click_count > 2)
5619 ? triple_modifier
5620 : double_modifier);
5621 }
5622 else
5623 double_click_count = 1;
5624 button_down_time = event->timestamp;
5625 *start_pos_ptr = Fcopy_alist (position);
3b0cdcef 5626 ignore_mouse_drag_p = 0;
559f9d04 5627 }
7b4aedb9 5628
88cb0656 5629 /* Now we're releasing a button - check the co-ordinates to
7b4aedb9 5630 see if this was a click or a drag. */
88cb0656
JB
5631 else if (event->modifiers & up_modifier)
5632 {
129004d3
GM
5633 /* If we did not see a down before this up, ignore the up.
5634 Probably this happened because the down event chose a
5635 menu item. It would be an annoyance to treat the
5636 release of the button that chose the menu item as a
5637 separate event. */
48e416d4 5638
8c18cbfb 5639 if (!CONSP (start_pos))
48e416d4
RS
5640 return Qnil;
5641
88cb0656 5642 event->modifiers &= ~up_modifier;
48e416d4 5643#if 0 /* Formerly we treated an up with no down as a click event. */
8c18cbfb 5644 if (!CONSP (start_pos))
dbc4e1c1
JB
5645 event->modifiers |= click_modifier;
5646 else
48e416d4 5647#endif
dbc4e1c1 5648 {
9b8eb840 5649 Lisp_Object down;
d31053f9 5650 EMACS_INT xdiff = double_click_fuzz, ydiff = double_click_fuzz;
dbc4e1c1 5651
d31053f9
RS
5652 /* The third element of every position
5653 should be the (x,y) pair. */
5654 down = Fcar (Fcdr (Fcdr (start_pos)));
7a6a97d7
SM
5655 if (CONSP (down)
5656 && INTEGERP (XCAR (down)) && INTEGERP (XCDR (down)))
d31053f9 5657 {
4156359e
SM
5658 xdiff = XINT (event->x) - XINT (XCAR (down));
5659 ydiff = XINT (event->y) - XINT (XCDR (down));
d31053f9
RS
5660 }
5661
3b0cdcef
KS
5662 if (ignore_mouse_drag_p)
5663 {
5664 event->modifiers |= click_modifier;
5665 ignore_mouse_drag_p = 0;
5666 }
5667 else if (xdiff < double_click_fuzz && xdiff > - double_click_fuzz
5668 && ydiff < double_click_fuzz && ydiff > - double_click_fuzz
4156359e
SM
5669 /* Maybe the mouse has moved a lot, caused scrolling, and
5670 eventually ended up at the same screen position (but
5671 not buffer position) in which case it is a drag, not
5672 a click. */
5673 /* FIXME: OTOH if the buffer position has changed
5674 because of a timer or process filter rather than
5675 because of mouse movement, it should be considered as
5676 a click. But mouse-drag-region completely ignores
5677 this case and it hasn't caused any real problem, so
5678 it's probably OK to ignore it as well. */
5679 && EQ (Fcar (Fcdr (start_pos)), Fcar (Fcdr (position))))
d31053f9 5680 /* Mouse hasn't moved (much). */
129004d3 5681 event->modifiers |= click_modifier;
fbcd35bd
JB
5682 else
5683 {
d31053f9
RS
5684 button_down_time = 0;
5685 event->modifiers |= drag_modifier;
fbcd35bd 5686 }
c60ee5e7 5687
bc536d84
RS
5688 /* Don't check is_double; treat this as multiple
5689 if the down-event was multiple. */
5690 if (double_click_count > 1)
5691 event->modifiers |= ((double_click_count > 2)
5692 ? triple_modifier
5693 : double_modifier);
dbc4e1c1 5694 }
88cb0656
JB
5695 }
5696 else
5697 /* Every mouse event should either have the down_modifier or
7b4aedb9 5698 the up_modifier set. */
88cb0656
JB
5699 abort ();
5700
88cb0656 5701 {
7b4aedb9 5702 /* Get the symbol we should use for the mouse click. */
9b8eb840
KH
5703 Lisp_Object head;
5704
5705 head = modify_event_symbol (button,
5706 event->modifiers,
8e1e4240
GM
5707 Qmouse_click, Vlispy_mouse_stem,
5708 NULL,
5709 &mouse_syms,
5710 XVECTOR (mouse_syms)->size);
88cb0656 5711 if (event->modifiers & drag_modifier)
dbc4e1c1
JB
5712 return Fcons (head,
5713 Fcons (start_pos,
5714 Fcons (position,
5715 Qnil)));
fbcd35bd
JB
5716 else if (event->modifiers & (double_modifier | triple_modifier))
5717 return Fcons (head,
5718 Fcons (position,
5719 Fcons (make_number (double_click_count),
5720 Qnil)));
88cb0656
JB
5721 else
5722 return Fcons (head,
7b4aedb9 5723 Fcons (position,
88cb0656
JB
5724 Qnil));
5725 }
284f4730 5726 }
db08707d 5727
8006e4bb
JR
5728 case WHEEL_EVENT:
5729 {
5730 Lisp_Object position;
8006e4bb 5731 Lisp_Object head;
2320865d 5732
87d386ff 5733 /* Build the position as appropriate for this mouse click. */
87d386ff 5734 struct frame *f = XFRAME (event->frame_or_window);
87d386ff
JR
5735
5736 /* Ignore wheel events that were made on frame that have been
5737 deleted. */
5738 if (! FRAME_LIVE_P (f))
5739 return Qnil;
5740
3d566707
KS
5741 position = make_lispy_position (f, &event->x, &event->y,
5742 event->timestamp);
87d386ff 5743
db9cd97a 5744 /* Set double or triple modifiers to indicate the wheel speed. */
87d386ff
JR
5745 {
5746 /* On window-system frames, use the value of
5747 double-click-fuzz as is. On other frames, interpret it
5748 as a multiple of 1/8 characters. */
5749 struct frame *f;
5750 int fuzz;
5751 int is_double;
5752
5753 if (WINDOWP (event->frame_or_window))
5754 f = XFRAME (XWINDOW (event->frame_or_window)->frame);
5755 else if (FRAMEP (event->frame_or_window))
5756 f = XFRAME (event->frame_or_window);
5757 else
5758 abort ();
5759
5760 if (FRAME_WINDOW_P (f))
5761 fuzz = double_click_fuzz;
5762 else
5763 fuzz = double_click_fuzz / 8;
5764
5765 is_double = (last_mouse_button < 0
5766 && (abs (XINT (event->x) - last_mouse_x) <= fuzz)
5767 && (abs (XINT (event->y) - last_mouse_y) <= fuzz)
5768 && button_down_time != 0
5769 && (EQ (Vdouble_click_time, Qt)
5770 || (INTEGERP (Vdouble_click_time)
5771 && ((int)(event->timestamp - button_down_time)
5772 < XINT (Vdouble_click_time)))));
5773 if (is_double)
5774 {
5775 double_click_count++;
5776 event->modifiers |= ((double_click_count > 2)
5777 ? triple_modifier
5778 : double_modifier);
5779 }
5780 else
5781 {
5782 double_click_count = 1;
5783 event->modifiers |= click_modifier;
5784 }
5785
5786 button_down_time = event->timestamp;
5787 /* Use a negative value to distinguish wheel from mouse button. */
5788 last_mouse_button = -1;
5789 last_mouse_x = XINT (event->x);
5790 last_mouse_y = XINT (event->y);
5791 }
5792
5793 {
5794 int symbol_num;
5795
5796 if (event->modifiers & up_modifier)
5797 {
db9cd97a 5798 /* Emit a wheel-up event. */
87d386ff
JR
5799 event->modifiers &= ~up_modifier;
5800 symbol_num = 0;
5801 }
5802 else if (event->modifiers & down_modifier)
5803 {
5804 /* Emit a wheel-down event. */
5805 event->modifiers &= ~down_modifier;
5806 symbol_num = 1;
5807 }
5808 else
5809 /* Every wheel event should either have the down_modifier or
5810 the up_modifier set. */
5811 abort ();
5812
db9cd97a 5813 /* Get the symbol we should use for the wheel event. */
87d386ff
JR
5814 head = modify_event_symbol (symbol_num,
5815 event->modifiers,
5816 Qmouse_click,
5817 Qnil,
5818 lispy_wheel_names,
5819 &wheel_syms,
5820 ASIZE (wheel_syms));
5821 }
5822
5823 if (event->modifiers & (double_modifier | triple_modifier))
5824 return Fcons (head,
5825 Fcons (position,
5826 Fcons (make_number (double_click_count),
5827 Qnil)));
5828 else
5829 return Fcons (head,
5830 Fcons (position,
5831 Qnil));
8006e4bb
JR
5832 }
5833
5834
05be3964 5835#ifdef USE_TOOLKIT_SCROLL_BARS
7ee32cda
GM
5836
5837 /* We don't have down and up events if using toolkit scroll bars,
5838 so make this always a click event. Store in the `part' of
5839 the Lisp event a symbol which maps to the following actions:
5840
5841 `above_handle' page up
5842 `below_handle' page down
5843 `up' line up
5844 `down' line down
5845 `top' top of buffer
5846 `bottom' bottom of buffer
5847 `handle' thumb has been dragged.
5848 `end-scroll' end of interaction with scroll bar
5849
5850 The incoming input_event contains in its `part' member an
5851 index of type `enum scroll_bar_part' which we can use as an
5852 index in scroll_bar_parts to get the appropriate symbol. */
c60ee5e7 5853
3b8f9651 5854 case SCROLL_BAR_CLICK_EVENT:
7ee32cda
GM
5855 {
5856 Lisp_Object position, head, window, portion_whole, part;
5857
5858 window = event->frame_or_window;
5859 portion_whole = Fcons (event->x, event->y);
5860 part = *scroll_bar_parts[(int) event->part];
5861
5862 position
5863 = Fcons (window,
5864 Fcons (Qvertical_scroll_bar,
5865 Fcons (portion_whole,
5866 Fcons (make_number (event->timestamp),
5867 Fcons (part, Qnil)))));
5868
5869 /* Always treat scroll bar events as clicks. */
5870 event->modifiers |= click_modifier;
05be3964 5871 event->modifiers &= ~up_modifier;
7ee32cda 5872
257f40f2
JD
5873 if (event->code >= ASIZE (mouse_syms))
5874 mouse_syms = larger_vector (mouse_syms, event->code + 1, Qnil);
5875
7ee32cda
GM
5876 /* Get the symbol we should use for the mouse click. */
5877 head = modify_event_symbol (event->code,
5878 event->modifiers,
14e40288 5879 Qmouse_click,
8e1e4240
GM
5880 Vlispy_mouse_stem,
5881 NULL, &mouse_syms,
5882 XVECTOR (mouse_syms)->size);
7ee32cda
GM
5883 return Fcons (head, Fcons (position, Qnil));
5884 }
c60ee5e7 5885
7ee32cda
GM
5886#endif /* USE_TOOLKIT_SCROLL_BARS */
5887
db08707d 5888#ifdef WINDOWSNT
3b8f9651 5889 case W32_SCROLL_BAR_CLICK_EVENT:
db08707d
RS
5890 {
5891 int button = event->code;
5892 int is_double;
5893 Lisp_Object position;
5894 Lisp_Object *start_pos_ptr;
5895 Lisp_Object start_pos;
5896
db08707d
RS
5897 {
5898 Lisp_Object window;
5899 Lisp_Object portion_whole;
5900 Lisp_Object part;
5901
5902 window = event->frame_or_window;
5903 portion_whole = Fcons (event->x, event->y);
5904 part = *scroll_bar_parts[(int) event->part];
5905
e8886a1d
RS
5906 position
5907 = Fcons (window,
5908 Fcons (Qvertical_scroll_bar,
5909 Fcons (portion_whole,
5910 Fcons (make_number (event->timestamp),
5911 Fcons (part, Qnil)))));
db08707d
RS
5912 }
5913
fbd6baed 5914 /* Always treat W32 scroll bar events as clicks. */
db08707d
RS
5915 event->modifiers |= click_modifier;
5916
5917 {
5918 /* Get the symbol we should use for the mouse click. */
5919 Lisp_Object head;
5920
5921 head = modify_event_symbol (button,
5922 event->modifiers,
c60ee5e7 5923 Qmouse_click,
8e1e4240
GM
5924 Vlispy_mouse_stem,
5925 NULL, &mouse_syms,
5926 XVECTOR (mouse_syms)->size);
db08707d
RS
5927 return Fcons (head,
5928 Fcons (position,
5929 Qnil));
5930 }
5931 }
1e7c162f 5932#endif /* WINDOWSNT */
a24dc617 5933
3b8f9651 5934 case DRAG_N_DROP_EVENT:
a24dc617 5935 {
a24dc617 5936 FRAME_PTR f;
3d566707 5937 Lisp_Object head, position;
a24dc617 5938 Lisp_Object files;
a24dc617 5939
82de1de9
YM
5940 f = XFRAME (event->frame_or_window);
5941 files = event->arg;
a24dc617
RS
5942
5943 /* Ignore mouse events that were made on frames that
5944 have been deleted. */
5945 if (! FRAME_LIVE_P (f))
5946 return Qnil;
afabdbe5 5947
3d566707
KS
5948 position = make_lispy_position (f, &event->x, &event->y,
5949 event->timestamp);
5950
5951 head = modify_event_symbol (0, event->modifiers,
5952 Qdrag_n_drop, Qnil,
5953 lispy_drag_n_drop_names,
5954 &drag_n_drop_syms, 1);
5955 return Fcons (head,
5956 Fcons (position,
5957 Fcons (files,
5958 Qnil)));
a24dc617 5959 }
514354e9 5960#endif /* HAVE_MOUSE */
284f4730 5961
488dd4c4
JD
5962#if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5963 || defined (USE_GTK)
da8f7368
GM
5964 case MENU_BAR_EVENT:
5965 if (EQ (event->arg, event->frame_or_window))
5966 /* This is the prefix key. We translate this to
5967 `(menu_bar)' because the code in keyboard.c for menu
5968 events, which we use, relies on this. */
5969 return Fcons (Qmenu_bar, Qnil);
5970 return event->arg;
2470a66f
KH
5971#endif
5972
a4e19f6e
SM
5973 case SELECT_WINDOW_EVENT:
5974 /* Make an event (select-window (WINDOW)). */
5975 return Fcons (Qselect_window,
5976 Fcons (Fcons (event->frame_or_window, Qnil),
5977 Qnil));
5978
9ea173e8 5979 case TOOL_BAR_EVENT:
da8f7368
GM
5980 if (EQ (event->arg, event->frame_or_window))
5981 /* This is the prefix key. We translate this to
27fd22dc 5982 `(tool_bar)' because the code in keyboard.c for tool bar
da8f7368
GM
5983 events, which we use, relies on this. */
5984 return Fcons (Qtool_bar, Qnil);
5985 else if (SYMBOLP (event->arg))
5986 return apply_modifiers (event->modifiers, event->arg);
5987 return event->arg;
5988
5989 case USER_SIGNAL_EVENT:
5bf68f6e 5990 /* A user signal. */
b809d9e7
KS
5991 {
5992 char *name = find_user_signal_name (event->code);
5993 if (!name)
5994 abort ();
5995 return intern (name);
5996 }
c60ee5e7 5997
3b8f9651 5998 case SAVE_SESSION_EVENT:
4ebc27a5 5999 return Qsave_session;
c60ee5e7 6000
f66c49cc
YM
6001#ifdef MAC_OS
6002 case MAC_APPLE_EVENT:
6003 {
6004 Lisp_Object spec[2];
6005
6006 spec[0] = event->x;
6007 spec[1] = event->y;
6008 return Fcons (Qmac_apple_event,
6009 Fcons (Fvector (2, spec),
2e1df0e6 6010 Fcons (event->arg, Qnil)));
f66c49cc
YM
6011 }
6012#endif
6013
7e5a23bd 6014#ifdef HAVE_GPM
ae372f41
NR
6015 case GPM_CLICK_EVENT:
6016 {
6017 FRAME_PTR f = XFRAME (event->frame_or_window);
6018 Lisp_Object head, position;
6019 Lisp_Object *start_pos_ptr;
6020 Lisp_Object start_pos;
6021 int button = event->code;
6022
6023 if (button >= ASIZE (button_down_location))
6024 {
6025 button_down_location = larger_vector (button_down_location,
6026 button + 1, Qnil);
6027 mouse_syms = larger_vector (mouse_syms, button + 1, Qnil);
6028 }
6029
6030 start_pos_ptr = &AREF (button_down_location, button);
6031 start_pos = *start_pos_ptr;
6032
6033 position = make_lispy_position (f, &event->x, &event->y,
6034 event->timestamp);
6035
6036 if (event->modifiers & down_modifier)
6037 *start_pos_ptr = Fcopy_alist (position);
6038 else if (event->modifiers & (up_modifier | drag_modifier))
6039 {
6040 if (!CONSP (start_pos))
6041 return Qnil;
6042 event->modifiers &= ~up_modifier;
6043 }
6044
6045 head = modify_event_symbol (button,
6046 event->modifiers,
6047 Qmouse_click, Vlispy_mouse_stem,
6048 NULL,
6049 &mouse_syms,
6050 XVECTOR (mouse_syms)->size);
6051
6052 if (event->modifiers & drag_modifier)
6053 return Fcons (head,
6054 Fcons (start_pos,
6055 Fcons (position,
6056 Qnil)));
6057 else if (event->modifiers & double_modifier)
6058 return Fcons (head,
6059 Fcons (position,
6060 Fcons (make_number (2),
6061 Qnil)));
6062 else if (event->modifiers & triple_modifier)
6063 return Fcons (head,
6064 Fcons (position,
6065 Fcons (make_number (3),
6066 Qnil)));
6067 else
6068 return Fcons (head,
6069 Fcons (position,
6070 Qnil));
6071 }
7e5a23bd 6072#endif /* HAVE_GPM */
ae372f41 6073
284f4730
JB
6074 /* The 'kind' field of the event is something we don't recognize. */
6075 default:
48e416d4 6076 abort ();
284f4730
JB
6077 }
6078}
6079
bdb1e01d 6080#if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6cbff1cb 6081
284f4730 6082static Lisp_Object
7b4aedb9 6083make_lispy_movement (frame, bar_window, part, x, y, time)
ff11dfa1 6084 FRAME_PTR frame;
7b4aedb9 6085 Lisp_Object bar_window;
3c370943 6086 enum scroll_bar_part part;
284f4730 6087 Lisp_Object x, y;
e5d77022 6088 unsigned long time;
284f4730 6089{
3c370943 6090 /* Is it a scroll bar movement? */
7b4aedb9 6091 if (frame && ! NILP (bar_window))
4bb994d1 6092 {
9b8eb840 6093 Lisp_Object part_sym;
4bb994d1 6094
9b8eb840 6095 part_sym = *scroll_bar_parts[(int) part];
3c370943 6096 return Fcons (Qscroll_bar_movement,
7b4aedb9 6097 (Fcons (Fcons (bar_window,
3c370943 6098 Fcons (Qvertical_scroll_bar,
4bb994d1
JB
6099 Fcons (Fcons (x, y),
6100 Fcons (make_number (time),
cb5df6ae 6101 Fcons (part_sym,
4bb994d1
JB
6102 Qnil))))),
6103 Qnil)));
6104 }
6105
6106 /* Or is it an ordinary mouse movement? */
284f4730
JB
6107 else
6108 {
3d566707 6109 Lisp_Object position;
4bb994d1 6110
3d566707 6111 position = make_lispy_position (frame, &x, &y, time);
284f4730 6112
4bb994d1 6113 return Fcons (Qmouse_movement,
3d566707 6114 Fcons (position,
4bb994d1
JB
6115 Qnil));
6116 }
284f4730
JB
6117}
6118
bdb1e01d 6119#endif /* HAVE_MOUSE || HAVE GPM */
6cbff1cb 6120
cd21b839
JB
6121/* Construct a switch frame event. */
6122static Lisp_Object
6123make_lispy_switch_frame (frame)
6124 Lisp_Object frame;
6125{
6126 return Fcons (Qswitch_frame, Fcons (frame, Qnil));
6127}
0a7f1fc0
JB
6128\f
6129/* Manipulating modifiers. */
284f4730 6130
0a7f1fc0 6131/* Parse the name of SYMBOL, and return the set of modifiers it contains.
284f4730 6132
0a7f1fc0
JB
6133 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6134 SYMBOL's name of the end of the modifiers; the string from this
6135 position is the unmodified symbol name.
284f4730 6136
0a7f1fc0 6137 This doesn't use any caches. */
6da3dd3a 6138
0a7f1fc0
JB
6139static int
6140parse_modifiers_uncached (symbol, modifier_end)
284f4730 6141 Lisp_Object symbol;
0a7f1fc0 6142 int *modifier_end;
284f4730 6143{
1b049b51 6144 Lisp_Object name;
284f4730
JB
6145 int i;
6146 int modifiers;
284f4730 6147
b7826503 6148 CHECK_SYMBOL (symbol);
df0f2ba1 6149
284f4730 6150 modifiers = 0;
1b049b51 6151 name = SYMBOL_NAME (symbol);
284f4730 6152
1b049b51 6153 for (i = 0; i+2 <= SBYTES (name); )
6da3dd3a
RS
6154 {
6155 int this_mod_end = 0;
6156 int this_mod = 0;
284f4730 6157
6da3dd3a
RS
6158 /* See if the name continues with a modifier word.
6159 Check that the word appears, but don't check what follows it.
6160 Set this_mod and this_mod_end to record what we find. */
fce33686 6161
1b049b51 6162 switch (SREF (name, i))
6da3dd3a
RS
6163 {
6164#define SINGLE_LETTER_MOD(BIT) \
6165 (this_mod_end = i + 1, this_mod = BIT)
6166
6da3dd3a
RS
6167 case 'A':
6168 SINGLE_LETTER_MOD (alt_modifier);
6169 break;
284f4730 6170
6da3dd3a
RS
6171 case 'C':
6172 SINGLE_LETTER_MOD (ctrl_modifier);
6173 break;
284f4730 6174
6da3dd3a
RS
6175 case 'H':
6176 SINGLE_LETTER_MOD (hyper_modifier);
6177 break;
6178
6da3dd3a
RS
6179 case 'M':
6180 SINGLE_LETTER_MOD (meta_modifier);
6181 break;
6182
6da3dd3a
RS
6183 case 'S':
6184 SINGLE_LETTER_MOD (shift_modifier);
6185 break;
6186
6187 case 's':
6da3dd3a
RS
6188 SINGLE_LETTER_MOD (super_modifier);
6189 break;
6190
0a7f1fc0 6191#undef SINGLE_LETTER_MOD
65470b52
SM
6192
6193#define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6194 if (i + LEN + 1 <= SBYTES (name) \
6195 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6196 { \
6197 this_mod_end = i + LEN; \
6198 this_mod = BIT; \
6199 }
6200
6201 case 'd':
6202 MULTI_LETTER_MOD (drag_modifier, "drag", 4);
6203 MULTI_LETTER_MOD (down_modifier, "down", 4);
6204 MULTI_LETTER_MOD (double_modifier, "double", 6);
6205 break;
6206
6207 case 't':
6208 MULTI_LETTER_MOD (triple_modifier, "triple", 6);
6209 break;
6210#undef MULTI_LETTER_MOD
6211
6da3dd3a
RS
6212 }
6213
6214 /* If we found no modifier, stop looking for them. */
6215 if (this_mod_end == 0)
6216 break;
6217
6218 /* Check there is a dash after the modifier, so that it
6219 really is a modifier. */
1b049b51
KR
6220 if (this_mod_end >= SBYTES (name)
6221 || SREF (name, this_mod_end) != '-')
6da3dd3a
RS
6222 break;
6223
6224 /* This modifier is real; look for another. */
6225 modifiers |= this_mod;
6226 i = this_mod_end + 1;
6227 }
284f4730 6228
0a7f1fc0 6229 /* Should we include the `click' modifier? */
fbcd35bd
JB
6230 if (! (modifiers & (down_modifier | drag_modifier
6231 | double_modifier | triple_modifier))
1b049b51
KR
6232 && i + 7 == SBYTES (name)
6233 && strncmp (SDATA (name) + i, "mouse-", 6) == 0
6234 && ('0' <= SREF (name, i + 6) && SREF (name, i + 6) <= '9'))
0a7f1fc0
JB
6235 modifiers |= click_modifier;
6236
6237 if (modifier_end)
6238 *modifier_end = i;
6239
6240 return modifiers;
6241}
6242
0a7f1fc0
JB
6243/* Return a symbol whose name is the modifier prefixes for MODIFIERS
6244 prepended to the string BASE[0..BASE_LEN-1].
6245 This doesn't use any caches. */
6246static Lisp_Object
301738ed 6247apply_modifiers_uncached (modifiers, base, base_len, base_len_byte)
0a7f1fc0
JB
6248 int modifiers;
6249 char *base;
301738ed 6250 int base_len, base_len_byte;
0a7f1fc0
JB
6251{
6252 /* Since BASE could contain nulls, we can't use intern here; we have
6253 to use Fintern, which expects a genuine Lisp_String, and keeps a
6254 reference to it. */
301738ed
RS
6255 char *new_mods
6256 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
0a7f1fc0 6257 int mod_len;
284f4730 6258
284f4730 6259 {
0a7f1fc0
JB
6260 char *p = new_mods;
6261
6262 /* Only the event queue may use the `up' modifier; it should always
6263 be turned into a click or drag event before presented to lisp code. */
6264 if (modifiers & up_modifier)
6265 abort ();
6266
6267 if (modifiers & alt_modifier) { *p++ = 'A'; *p++ = '-'; }
6268 if (modifiers & ctrl_modifier) { *p++ = 'C'; *p++ = '-'; }
6269 if (modifiers & hyper_modifier) { *p++ = 'H'; *p++ = '-'; }
6270 if (modifiers & meta_modifier) { *p++ = 'M'; *p++ = '-'; }
6271 if (modifiers & shift_modifier) { *p++ = 'S'; *p++ = '-'; }
86e5706b 6272 if (modifiers & super_modifier) { *p++ = 's'; *p++ = '-'; }
fbcd35bd
JB
6273 if (modifiers & double_modifier) { strcpy (p, "double-"); p += 7; }
6274 if (modifiers & triple_modifier) { strcpy (p, "triple-"); p += 7; }
559f9d04
RS
6275 if (modifiers & down_modifier) { strcpy (p, "down-"); p += 5; }
6276 if (modifiers & drag_modifier) { strcpy (p, "drag-"); p += 5; }
0a7f1fc0
JB
6277 /* The click modifier is denoted by the absence of other modifiers. */
6278
6279 *p = '\0';
6280
6281 mod_len = p - new_mods;
6282 }
284f4730 6283
0a7f1fc0 6284 {
9b8eb840 6285 Lisp_Object new_name;
df0f2ba1 6286
301738ed
RS
6287 new_name = make_uninit_multibyte_string (mod_len + base_len,
6288 mod_len + base_len_byte);
d5db4077
KR
6289 bcopy (new_mods, SDATA (new_name), mod_len);
6290 bcopy (base, SDATA (new_name) + mod_len, base_len_byte);
284f4730
JB
6291
6292 return Fintern (new_name, Qnil);
6293 }
6294}
6295
6296
0a7f1fc0
JB
6297static char *modifier_names[] =
6298{
fbcd35bd 6299 "up", "down", "drag", "click", "double", "triple", 0, 0,
f335fabe 6300 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
86e5706b 6301 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
0a7f1fc0 6302};
80645119 6303#define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
0a7f1fc0
JB
6304
6305static Lisp_Object modifier_symbols;
6306
6307/* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6308static Lisp_Object
6309lispy_modifier_list (modifiers)
6310 int modifiers;
6311{
6312 Lisp_Object modifier_list;
6313 int i;
6314
6315 modifier_list = Qnil;
80645119 6316 for (i = 0; (1<<i) <= modifiers && i < NUM_MOD_NAMES; i++)
0a7f1fc0 6317 if (modifiers & (1<<i))
80645119
JB
6318 modifier_list = Fcons (XVECTOR (modifier_symbols)->contents[i],
6319 modifier_list);
0a7f1fc0
JB
6320
6321 return modifier_list;
6322}
6323
6324
6325/* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6326 where UNMODIFIED is the unmodified form of SYMBOL,
6327 MASK is the set of modifiers present in SYMBOL's name.
6328 This is similar to parse_modifiers_uncached, but uses the cache in
6329 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6330 Qevent_symbol_elements property. */
3d31316f 6331
1161d367 6332Lisp_Object
0a7f1fc0
JB
6333parse_modifiers (symbol)
6334 Lisp_Object symbol;
6335{
9b8eb840 6336 Lisp_Object elements;
0a7f1fc0 6337
9b8eb840 6338 elements = Fget (symbol, Qevent_symbol_element_mask);
0a7f1fc0
JB
6339 if (CONSP (elements))
6340 return elements;
6341 else
6342 {
6343 int end;
ec0faad2 6344 int modifiers = parse_modifiers_uncached (symbol, &end);
9b8eb840 6345 Lisp_Object unmodified;
0a7f1fc0
JB
6346 Lisp_Object mask;
6347
d5db4077
KR
6348 unmodified = Fintern (make_string (SDATA (SYMBOL_NAME (symbol)) + end,
6349 SBYTES (SYMBOL_NAME (symbol)) - end),
9b8eb840
KH
6350 Qnil);
6351
e22216b8 6352 if (modifiers & ~INTMASK)
734fef94 6353 abort ();
bb9e9bed 6354 XSETFASTINT (mask, modifiers);
0a7f1fc0
JB
6355 elements = Fcons (unmodified, Fcons (mask, Qnil));
6356
6357 /* Cache the parsing results on SYMBOL. */
6358 Fput (symbol, Qevent_symbol_element_mask,
6359 elements);
6360 Fput (symbol, Qevent_symbol_elements,
6361 Fcons (unmodified, lispy_modifier_list (modifiers)));
6362
6363 /* Since we know that SYMBOL is modifiers applied to unmodified,
6364 it would be nice to put that in unmodified's cache.
6365 But we can't, since we're not sure that parse_modifiers is
6366 canonical. */
6367
6368 return elements;
6369 }
6370}
6371
6372/* Apply the modifiers MODIFIERS to the symbol BASE.
6373 BASE must be unmodified.
6374
6375 This is like apply_modifiers_uncached, but uses BASE's
6376 Qmodifier_cache property, if present. It also builds
cd21b839
JB
6377 Qevent_symbol_elements properties, since it has that info anyway.
6378
6379 apply_modifiers copies the value of BASE's Qevent_kind property to
6380 the modified symbol. */
0a7f1fc0
JB
6381static Lisp_Object
6382apply_modifiers (modifiers, base)
6383 int modifiers;
6384 Lisp_Object base;
6385{
7b4aedb9 6386 Lisp_Object cache, index, entry, new_symbol;
0a7f1fc0 6387
80645119 6388 /* Mask out upper bits. We don't know where this value's been. */
e22216b8 6389 modifiers &= INTMASK;
80645119 6390
0a7f1fc0 6391 /* The click modifier never figures into cache indices. */
0a7f1fc0 6392 cache = Fget (base, Qmodifier_cache);
bb9e9bed 6393 XSETFASTINT (index, (modifiers & ~click_modifier));
697e4895 6394 entry = assq_no_quit (index, cache);
0a7f1fc0
JB
6395
6396 if (CONSP (entry))
7539e11f 6397 new_symbol = XCDR (entry);
7b4aedb9
JB
6398 else
6399 {
df0f2ba1 6400 /* We have to create the symbol ourselves. */
7b4aedb9 6401 new_symbol = apply_modifiers_uncached (modifiers,
d5db4077
KR
6402 SDATA (SYMBOL_NAME (base)),
6403 SCHARS (SYMBOL_NAME (base)),
6404 SBYTES (SYMBOL_NAME (base)));
7b4aedb9
JB
6405
6406 /* Add the new symbol to the base's cache. */
6407 entry = Fcons (index, new_symbol);
6408 Fput (base, Qmodifier_cache, Fcons (entry, cache));
6409
35fb885d
SM
6410 /* We have the parsing info now for free, so we could add it to
6411 the caches:
6412 XSETFASTINT (index, modifiers);
6413 Fput (new_symbol, Qevent_symbol_element_mask,
6414 Fcons (base, Fcons (index, Qnil)));
6415 Fput (new_symbol, Qevent_symbol_elements,
6416 Fcons (base, lispy_modifier_list (modifiers)));
6417 Sadly, this is only correct if `base' is indeed a base event,
6418 which is not necessarily the case. -stef */
7b4aedb9 6419 }
0a7f1fc0 6420
df0f2ba1 6421 /* Make sure this symbol is of the same kind as BASE.
7b4aedb9
JB
6422
6423 You'd think we could just set this once and for all when we
6424 intern the symbol above, but reorder_modifiers may call us when
6425 BASE's property isn't set right; we can't assume that just
80645119
JB
6426 because it has a Qmodifier_cache property it must have its
6427 Qevent_kind set right as well. */
7b4aedb9
JB
6428 if (NILP (Fget (new_symbol, Qevent_kind)))
6429 {
9b8eb840 6430 Lisp_Object kind;
7b4aedb9 6431
9b8eb840 6432 kind = Fget (base, Qevent_kind);
7b4aedb9
JB
6433 if (! NILP (kind))
6434 Fput (new_symbol, Qevent_kind, kind);
6435 }
6436
6437 return new_symbol;
0a7f1fc0
JB
6438}
6439
6440
6441/* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6442 return a symbol with the modifiers placed in the canonical order.
6443 Canonical order is alphabetical, except for down and drag, which
6444 always come last. The 'click' modifier is never written out.
6445
6446 Fdefine_key calls this to make sure that (for example) C-M-foo
6447 and M-C-foo end up being equivalent in the keymap. */
6448
6449Lisp_Object
6450reorder_modifiers (symbol)
6451 Lisp_Object symbol;
6452{
6453 /* It's hopefully okay to write the code this way, since everything
6454 will soon be in caches, and no consing will be done at all. */
9b8eb840 6455 Lisp_Object parsed;
0a7f1fc0 6456
9b8eb840 6457 parsed = parse_modifiers (symbol);
7539e11f
KR
6458 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed))),
6459 XCAR (parsed));
0a7f1fc0
JB
6460}
6461
6462
284f4730
JB
6463/* For handling events, we often want to produce a symbol whose name
6464 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6465 to some base, like the name of a function key or mouse button.
6466 modify_event_symbol produces symbols of this sort.
6467
6468 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6469 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6470 in the table.
6471
8e1e4240
GM
6472 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6473 into symbol names, or a string specifying a name stem used to
a50e723f 6474 construct a symbol name or the form `STEM-N', where N is the decimal
8e1e4240
GM
6475 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6476 non-nil; otherwise NAME_TABLE is used.
80e4aa30 6477
284f4730
JB
6478 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6479 persist between calls to modify_event_symbol that it can use to
6480 store a cache of the symbols it's generated for this NAME_TABLE
80e4aa30 6481 before. The object stored there may be a vector or an alist.
284f4730
JB
6482
6483 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
df0f2ba1 6484
284f4730
JB
6485 MODIFIERS is a set of modifier bits (as given in struct input_events)
6486 whose prefixes should be applied to the symbol name.
6487
6488 SYMBOL_KIND is the value to be placed in the event_kind property of
df0f2ba1 6489 the returned symbol.
88cb0656
JB
6490
6491 The symbols we create are supposed to have an
eb8c3be9 6492 `event-symbol-elements' property, which lists the modifiers present
88cb0656
JB
6493 in the symbol's name. */
6494
284f4730 6495static Lisp_Object
8e1e4240 6496modify_event_symbol (symbol_num, modifiers, symbol_kind, name_alist_or_stem,
80e4aa30 6497 name_table, symbol_table, table_size)
284f4730
JB
6498 int symbol_num;
6499 unsigned modifiers;
6500 Lisp_Object symbol_kind;
8e1e4240 6501 Lisp_Object name_alist_or_stem;
284f4730
JB
6502 char **name_table;
6503 Lisp_Object *symbol_table;
2c834fb3 6504 unsigned int table_size;
284f4730 6505{
80e4aa30
RS
6506 Lisp_Object value;
6507 Lisp_Object symbol_int;
6508
2c834fb3
KH
6509 /* Get rid of the "vendor-specific" bit here. */
6510 XSETINT (symbol_int, symbol_num & 0xffffff);
284f4730
JB
6511
6512 /* Is this a request for a valid symbol? */
88cb0656 6513 if (symbol_num < 0 || symbol_num >= table_size)
0c2611c5 6514 return Qnil;
284f4730 6515
80e4aa30
RS
6516 if (CONSP (*symbol_table))
6517 value = Fcdr (assq_no_quit (symbol_int, *symbol_table));
6518
0a7f1fc0 6519 /* If *symbol_table doesn't seem to be initialized properly, fix that.
88cb0656 6520 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4bb994d1
JB
6521 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6522 we've never used that symbol before. */
80e4aa30 6523 else
88cb0656 6524 {
80e4aa30
RS
6525 if (! VECTORP (*symbol_table)
6526 || XVECTOR (*symbol_table)->size != table_size)
6527 {
6528 Lisp_Object size;
0a7f1fc0 6529
bb9e9bed 6530 XSETFASTINT (size, table_size);
80e4aa30
RS
6531 *symbol_table = Fmake_vector (size, Qnil);
6532 }
284f4730 6533
80e4aa30
RS
6534 value = XVECTOR (*symbol_table)->contents[symbol_num];
6535 }
284f4730 6536
0a7f1fc0 6537 /* Have we already used this symbol before? */
80e4aa30 6538 if (NILP (value))
284f4730 6539 {
0a7f1fc0 6540 /* No; let's create it. */
8e1e4240
GM
6541 if (CONSP (name_alist_or_stem))
6542 value = Fcdr_safe (Fassq (symbol_int, name_alist_or_stem));
6543 else if (STRINGP (name_alist_or_stem))
6544 {
d5db4077 6545 int len = SBYTES (name_alist_or_stem);
8e1e4240 6546 char *buf = (char *) alloca (len + 50);
cea5d0d4
AS
6547 sprintf (buf, "%s-%ld", SDATA (name_alist_or_stem),
6548 (long) XINT (symbol_int) + 1);
8e1e4240
GM
6549 value = intern (buf);
6550 }
2ff6714d 6551 else if (name_table != 0 && name_table[symbol_num])
80e4aa30 6552 value = intern (name_table[symbol_num]);
b64b4075 6553
e98a93eb 6554#ifdef HAVE_WINDOW_SYSTEM
2c834fb3
KH
6555 if (NILP (value))
6556 {
6557 char *name = x_get_keysym_name (symbol_num);
6558 if (name)
6559 value = intern (name);
6560 }
6561#endif
6562
b64b4075 6563 if (NILP (value))
d1f50460
RS
6564 {
6565 char buf[20];
6566 sprintf (buf, "key-%d", symbol_num);
80e4aa30 6567 value = intern (buf);
d1f50460 6568 }
0a7f1fc0 6569
80e4aa30 6570 if (CONSP (*symbol_table))
4205cb08 6571 *symbol_table = Fcons (Fcons (symbol_int, value), *symbol_table);
80e4aa30
RS
6572 else
6573 XVECTOR (*symbol_table)->contents[symbol_num] = value;
6574
df0f2ba1 6575 /* Fill in the cache entries for this symbol; this also
0a7f1fc0
JB
6576 builds the Qevent_symbol_elements property, which the user
6577 cares about. */
80e4aa30
RS
6578 apply_modifiers (modifiers & click_modifier, value);
6579 Fput (value, Qevent_kind, symbol_kind);
284f4730 6580 }
88cb0656 6581
0a7f1fc0 6582 /* Apply modifiers to that symbol. */
80e4aa30 6583 return apply_modifiers (modifiers, value);
284f4730 6584}
6da3dd3a
RS
6585\f
6586/* Convert a list that represents an event type,
6587 such as (ctrl meta backspace), into the usual representation of that
6588 event type as a number or a symbol. */
6589
a1706c30 6590DEFUN ("event-convert-list", Fevent_convert_list, Sevent_convert_list, 1, 1, 0,
4707d2d0
PJ
6591 doc: /* Convert the event description list EVENT-DESC to an event type.
6592EVENT-DESC should contain one base event type (a character or symbol)
6593and zero or more modifier names (control, meta, hyper, super, shift, alt,
6594drag, down, double or triple). The base must be last.
6595The return value is an event type (a character or symbol) which
6596has the same base event type and all the specified modifiers. */)
6597 (event_desc)
e57d8fd8 6598 Lisp_Object event_desc;
6da3dd3a
RS
6599{
6600 Lisp_Object base;
6601 int modifiers = 0;
6602 Lisp_Object rest;
6603
6604 base = Qnil;
e57d8fd8 6605 rest = event_desc;
6da3dd3a
RS
6606 while (CONSP (rest))
6607 {
6608 Lisp_Object elt;
6609 int this = 0;
6610
7539e11f
KR
6611 elt = XCAR (rest);
6612 rest = XCDR (rest);
6da3dd3a 6613
3d31316f 6614 /* Given a symbol, see if it is a modifier name. */
377f24f5 6615 if (SYMBOLP (elt) && CONSP (rest))
3d31316f 6616 this = parse_solitary_modifier (elt);
6da3dd3a
RS
6617
6618 if (this != 0)
6619 modifiers |= this;
6620 else if (!NILP (base))
6621 error ("Two bases given in one event");
6622 else
6623 base = elt;
6624
6da3dd3a
RS
6625 }
6626
3d31316f 6627 /* Let the symbol A refer to the character A. */
d5db4077 6628 if (SYMBOLP (base) && SCHARS (SYMBOL_NAME (base)) == 1)
4069e0f8 6629 XSETINT (base, SREF (SYMBOL_NAME (base), 0));
3d31316f 6630
6da3dd3a
RS
6631 if (INTEGERP (base))
6632 {
3d31316f
RS
6633 /* Turn (shift a) into A. */
6634 if ((modifiers & shift_modifier) != 0
6635 && (XINT (base) >= 'a' && XINT (base) <= 'z'))
6636 {
6637 XSETINT (base, XINT (base) - ('a' - 'A'));
6638 modifiers &= ~shift_modifier;
6639 }
6640
6641 /* Turn (control a) into C-a. */
6da3dd3a 6642 if (modifiers & ctrl_modifier)
3d31316f 6643 return make_number ((modifiers & ~ctrl_modifier)
6da3dd3a
RS
6644 | make_ctrl_char (XINT (base)));
6645 else
6646 return make_number (modifiers | XINT (base));
6647 }
6648 else if (SYMBOLP (base))
6649 return apply_modifiers (modifiers, base);
6650 else
8c907a56
GM
6651 {
6652 error ("Invalid base event");
6653 return Qnil;
6654 }
6da3dd3a
RS
6655}
6656
3d31316f
RS
6657/* Try to recognize SYMBOL as a modifier name.
6658 Return the modifier flag bit, or 0 if not recognized. */
6659
6660static int
6661parse_solitary_modifier (symbol)
6662 Lisp_Object symbol;
6663{
1b049b51 6664 Lisp_Object name = SYMBOL_NAME (symbol);
3d31316f 6665
1b049b51 6666 switch (SREF (name, 0))
3d31316f
RS
6667 {
6668#define SINGLE_LETTER_MOD(BIT) \
1b049b51 6669 if (SBYTES (name) == 1) \
3d31316f
RS
6670 return BIT;
6671
6672#define MULTI_LETTER_MOD(BIT, NAME, LEN) \
1b049b51
KR
6673 if (LEN == SBYTES (name) \
6674 && ! strncmp (SDATA (name), NAME, LEN)) \
3d31316f
RS
6675 return BIT;
6676
6677 case 'A':
6678 SINGLE_LETTER_MOD (alt_modifier);
6679 break;
6680
6681 case 'a':
6682 MULTI_LETTER_MOD (alt_modifier, "alt", 3);
6683 break;
6684
6685 case 'C':
6686 SINGLE_LETTER_MOD (ctrl_modifier);
6687 break;
6688
6689 case 'c':
6690 MULTI_LETTER_MOD (ctrl_modifier, "ctrl", 4);
6691 MULTI_LETTER_MOD (ctrl_modifier, "control", 7);
6692 break;
6693
6694 case 'H':
6695 SINGLE_LETTER_MOD (hyper_modifier);
6696 break;
6697
6698 case 'h':
6699 MULTI_LETTER_MOD (hyper_modifier, "hyper", 5);
6700 break;
6701
6702 case 'M':
6703 SINGLE_LETTER_MOD (meta_modifier);
6704 break;
6705
6706 case 'm':
6707 MULTI_LETTER_MOD (meta_modifier, "meta", 4);
6708 break;
6709
6710 case 'S':
6711 SINGLE_LETTER_MOD (shift_modifier);
6712 break;
6713
6714 case 's':
6715 MULTI_LETTER_MOD (shift_modifier, "shift", 5);
6716 MULTI_LETTER_MOD (super_modifier, "super", 5);
6717 SINGLE_LETTER_MOD (super_modifier);
6718 break;
6719
6720 case 'd':
6721 MULTI_LETTER_MOD (drag_modifier, "drag", 4);
6722 MULTI_LETTER_MOD (down_modifier, "down", 4);
6723 MULTI_LETTER_MOD (double_modifier, "double", 6);
6724 break;
6725
6726 case 't':
6727 MULTI_LETTER_MOD (triple_modifier, "triple", 6);
6728 break;
6729
6730#undef SINGLE_LETTER_MOD
6731#undef MULTI_LETTER_MOD
6732 }
6733
6734 return 0;
6735}
6736
6da3dd3a
RS
6737/* Return 1 if EVENT is a list whose elements are all integers or symbols.
6738 Such a list is not valid as an event,
6739 but it can be a Lucid-style event type list. */
6740
6741int
6742lucid_event_type_list_p (object)
6743 Lisp_Object object;
6744{
6745 Lisp_Object tail;
6746
6747 if (! CONSP (object))
6748 return 0;
902ae620
GM
6749
6750 if (EQ (XCAR (object), Qhelp_echo)
6751 || EQ (XCAR (object), Qvertical_line)
6752 || EQ (XCAR (object), Qmode_line)
6753 || EQ (XCAR (object), Qheader_line))
6754 return 0;
6da3dd3a 6755
7539e11f 6756 for (tail = object; CONSP (tail); tail = XCDR (tail))
6da3dd3a
RS
6757 {
6758 Lisp_Object elt;
7539e11f 6759 elt = XCAR (tail);
6da3dd3a
RS
6760 if (! (INTEGERP (elt) || SYMBOLP (elt)))
6761 return 0;
6762 }
6763
6764 return NILP (tail);
6765}
284f4730 6766\f
284f4730
JB
6767/* Store into *addr a value nonzero if terminal input chars are available.
6768 Serves the purpose of ioctl (0, FIONREAD, addr)
6769 but works even if FIONREAD does not exist.
d9d4c147
KH
6770 (In fact, this may actually read some input.)
6771
a2d5fca0
JD
6772 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6773 timer events that are ripe.
6774 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6775 events (FOCUS_IN_EVENT).
6776 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
354344a2 6777 movements and toolkit scroll bar thumb drags. */
284f4730
JB
6778
6779static void
a2d5fca0 6780get_input_pending (addr, flags)
284f4730 6781 int *addr;
a2d5fca0 6782 int flags;
284f4730
JB
6783{
6784 /* First of all, have we already counted some input? */
a2d5fca0 6785 *addr = (!NILP (Vquit_flag) || readable_events (flags));
284f4730
JB
6786
6787 /* If input is being read as it arrives, and we have none, there is none. */
6788 if (*addr > 0 || (interrupt_input && ! interrupts_deferred))
6789 return;
6790
6791 /* Try to read some input and see how much we get. */
6792 gobble_input (0);
a2d5fca0 6793 *addr = (!NILP (Vquit_flag) || readable_events (flags));
284f4730
JB
6794}
6795
81931ba1 6796/* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
284f4730 6797
07a59269 6798void
284f4730
JB
6799gobble_input (expected)
6800 int expected;
6801{
6802#ifndef VMS
6803#ifdef SIGIO
6804 if (interrupt_input)
6805 {
32676c08 6806 SIGMASKTYPE mask;
4f8aaa74 6807 mask = sigblock (sigmask (SIGIO));
284f4730 6808 read_avail_input (expected);
e065a56e 6809 sigsetmask (mask);
284f4730
JB
6810 }
6811 else
81931ba1
RS
6812#ifdef POLL_FOR_INPUT
6813 if (read_socket_hook && !interrupt_input && poll_suppress_count == 0)
6814 {
6815 SIGMASKTYPE mask;
4f8aaa74 6816 mask = sigblock (sigmask (SIGALRM));
81931ba1
RS
6817 read_avail_input (expected);
6818 sigsetmask (mask);
6819 }
6820 else
87485d6f 6821#endif
284f4730
JB
6822#endif
6823 read_avail_input (expected);
6824#endif
6825}
a8015ab5 6826
3b8f9651 6827/* Put a BUFFER_SWITCH_EVENT in the buffer
241ceaf7
RS
6828 so that read_key_sequence will notice the new current buffer. */
6829
07a59269 6830void
a8015ab5
KH
6831record_asynch_buffer_change ()
6832{
6833 struct input_event event;
a30f0615 6834 Lisp_Object tem;
1269a761 6835 EVENT_INIT (event);
a30f0615 6836
3b8f9651 6837 event.kind = BUFFER_SWITCH_EVENT;
a8015ab5 6838 event.frame_or_window = Qnil;
da8f7368 6839 event.arg = Qnil;
241ceaf7 6840
f65e6f7d 6841#ifdef subprocesses
a30f0615
RS
6842 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6843 The purpose of the event is to make read_key_sequence look up the
6844 keymaps again. If we aren't in read_key_sequence, we don't need one,
6845 and the event could cause trouble by messing up (input-pending-p). */
6846 tem = Fwaiting_for_user_input_p ();
6847 if (NILP (tem))
6848 return;
f65e6f7d
RS
6849#else
6850 /* We never need these events if we have no asynchronous subprocesses. */
6851 return;
6852#endif
a30f0615 6853
241ceaf7
RS
6854 /* Make sure no interrupt happens while storing the event. */
6855#ifdef SIGIO
6856 if (interrupt_input)
6857 {
6858 SIGMASKTYPE mask;
4f8aaa74 6859 mask = sigblock (sigmask (SIGIO));
241ceaf7
RS
6860 kbd_buffer_store_event (&event);
6861 sigsetmask (mask);
6862 }
6863 else
6864#endif
6865 {
6866 stop_polling ();
6867 kbd_buffer_store_event (&event);
6868 start_polling ();
6869 }
a8015ab5 6870}
284f4730
JB
6871\f
6872#ifndef VMS
6873
6874/* Read any terminal input already buffered up by the system
6875 into the kbd_buffer, but do not wait.
6876
6877 EXPECTED should be nonzero if the caller knows there is some input.
6878
6879 Except on VMS, all input is read by this function.
6880 If interrupt_input is nonzero, this function MUST be called
6881 only when SIGIO is blocked.
6882
6883 Returns the number of keyboard chars read, or -1 meaning
0fc0bac9 6884 this is a bad time to try to read input. */
284f4730
JB
6885
6886static int
6887read_avail_input (expected)
6888 int expected;
6889{
284f4730 6890 register int i;
351d2e14 6891 int nread = 0;
284f4730 6892
23479b40
YM
6893 /* Store pending user signal events, if any. */
6894 if (store_user_signal_events ())
6895 expected = 0;
6896
351d2e14 6897 if (read_socket_hook)
7371cef0 6898 {
351d2e14 6899 int nr;
0fc0bac9 6900 struct input_event hold_quit;
1269a761 6901
0fc0bac9
KS
6902 EVENT_INIT (hold_quit);
6903 hold_quit.kind = NO_EVENT;
351d2e14 6904
0fc0bac9
KS
6905 /* No need for FIONREAD or fcntl; just say don't wait. */
6906 while (nr = (*read_socket_hook) (input_fd, expected, &hold_quit), nr > 0)
6907 {
6908 nread += nr;
6909 expected = 0;
6910 }
6911 if (hold_quit.kind != NO_EVENT)
6912 kbd_buffer_store_event (&hold_quit);
351d2e14 6913 }
284f4730
JB
6914 else
6915 {
17270835
RS
6916 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6917 the kbd_buffer can really hold. That may prevent loss
6918 of characters on some systems when input is stuffed at us. */
6919 unsigned char cbuf[KBD_BUFFER_SIZE - 1];
58788063 6920 int n_to_read;
284f4730 6921
58788063 6922 /* Determine how many characters we should *try* to read. */
bc536d84 6923#ifdef WINDOWSNT
7371cef0 6924 return 0;
bc536d84 6925#else /* not WINDOWSNT */
80e4aa30 6926#ifdef MSDOS
58788063
RS
6927 n_to_read = dos_keysns ();
6928 if (n_to_read == 0)
351d2e14 6929 return 0;
c3a2738c 6930#else /* not MSDOS */
7e5a23bd 6931#ifdef HAVE_GPM
ae372f41
NR
6932 if (term_gpm)
6933 {
6934 Gpm_Event event;
6935 struct input_event hold_quit;
6936 int gpm;
6937
6938 EVENT_INIT (hold_quit);
6939 hold_quit.kind = NO_EVENT;
6940
6941 while (gpm = Gpm_GetEvent (&event), gpm == 1) {
6942 nread += handle_one_term_event (&event, &hold_quit);
6943 }
6944 if (hold_quit.kind != NO_EVENT)
6945 kbd_buffer_store_event (&hold_quit);
6946 if (nread)
6947 return nread;
6948 }
7e5a23bd 6949#endif /* HAVE_GPM */
284f4730 6950#ifdef FIONREAD
ae372f41
NR
6951
6952 /* Find out how much input is available. */
437f6112 6953 if (ioctl (input_fd, FIONREAD, &n_to_read) < 0)
284f4730
JB
6954 /* Formerly simply reported no input, but that sometimes led to
6955 a failure of Emacs to terminate.
6956 SIGHUP seems appropriate if we can't reach the terminal. */
e4535288
RS
6957 /* ??? Is it really right to send the signal just to this process
6958 rather than to the whole process group?
6959 Perhaps on systems with FIONREAD Emacs is alone in its group. */
f1871a7d
RS
6960 {
6961 if (! noninteractive)
6962 kill (getpid (), SIGHUP);
6963 else
6964 n_to_read = 0;
6965 }
58788063 6966 if (n_to_read == 0)
351d2e14 6967 return 0;
58788063
RS
6968 if (n_to_read > sizeof cbuf)
6969 n_to_read = sizeof cbuf;
284f4730 6970#else /* no FIONREAD */
c60ee5e7 6971#if defined (USG) || defined (DGUX) || defined(CYGWIN)
284f4730 6972 /* Read some input if available, but don't wait. */
58788063 6973 n_to_read = sizeof cbuf;
437f6112 6974 fcntl (input_fd, F_SETFL, O_NDELAY);
284f4730
JB
6975#else
6976 you lose;
6977#endif
6978#endif
80e4aa30 6979#endif /* not MSDOS */
bc536d84 6980#endif /* not WINDOWSNT */
284f4730 6981
58788063
RS
6982 /* Now read; for one reason or another, this will not block.
6983 NREAD is set to the number of chars read. */
9134775b 6984 do
284f4730 6985 {
80e4aa30 6986#ifdef MSDOS
0c04a67e 6987 cbuf[0] = dos_keyread ();
80e4aa30
RS
6988 nread = 1;
6989#else
68c45bf0 6990 nread = emacs_read (input_fd, cbuf, n_to_read);
80e4aa30 6991#endif
49854566
RS
6992 /* POSIX infers that processes which are not in the session leader's
6993 process group won't get SIGHUP's at logout time. BSDI adheres to
e8886a1d 6994 this part standard and returns -1 from read (0) with errno==EIO
49854566
RS
6995 when the control tty is taken away.
6996 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6997 if (nread == -1 && errno == EIO)
6998 kill (0, SIGHUP);
762f2b92 6999#if defined (AIX) && (! defined (aix386) && defined (_BSD))
284f4730
JB
7000 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7001 This looks incorrect, but it isn't, because _BSD causes
7002 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7003 and that causes a value other than 0 when there is no input. */
854f3a54 7004 if (nread == 0)
80e4aa30 7005 kill (0, SIGHUP);
284f4730 7006#endif
9134775b 7007 }
791587ee
KH
7008 while (
7009 /* We used to retry the read if it was interrupted.
7010 But this does the wrong thing when O_NDELAY causes
7011 an EAGAIN error. Does anybody know of a situation
7012 where a retry is actually needed? */
7013#if 0
7014 nread < 0 && (errno == EAGAIN
6aec06f5 7015#ifdef EFAULT
9134775b 7016 || errno == EFAULT
80e4aa30 7017#endif
284f4730 7018#ifdef EBADSLT
9134775b 7019 || errno == EBADSLT
284f4730 7020#endif
791587ee
KH
7021 )
7022#else
7023 0
7024#endif
7025 );
284f4730
JB
7026
7027#ifndef FIONREAD
c60ee5e7 7028#if defined (USG) || defined (DGUX) || defined (CYGWIN)
437f6112 7029 fcntl (input_fd, F_SETFL, 0);
c60ee5e7 7030#endif /* USG or DGUX or CYGWIN */
284f4730
JB
7031#endif /* no FIONREAD */
7032 for (i = 0; i < nread; i++)
7033 {
351d2e14
KS
7034 struct input_event buf;
7035 EVENT_INIT (buf);
7036 buf.kind = ASCII_KEYSTROKE_EVENT;
7037 buf.modifiers = 0;
b04904fb 7038 if (meta_key == 1 && (cbuf[i] & 0x80))
351d2e14 7039 buf.modifiers = meta_modifier;
b04904fb
RS
7040 if (meta_key != 2)
7041 cbuf[i] &= ~0x80;
f3e59d5e 7042
351d2e14
KS
7043 buf.code = cbuf[i];
7044 buf.frame_or_window = selected_frame;
7045 buf.arg = Qnil;
2320865d 7046
351d2e14
KS
7047 kbd_buffer_store_event (&buf);
7048 /* Don't look at input that follows a C-g too closely.
7049 This reduces lossage due to autorepeat on C-g. */
7050 if (buf.kind == ASCII_KEYSTROKE_EVENT
7051 && buf.code == quit_char)
7052 break;
284f4730
JB
7053 }
7054 }
7055
99402311 7056 return nread;
284f4730
JB
7057}
7058#endif /* not VMS */
7059\f
b65c1b44
SM
7060void
7061handle_async_input ()
7062{
7063#ifdef BSD4_1
7064 extern int select_alarmed;
7065#endif
aa477689 7066
b65c1b44
SM
7067 interrupt_input_pending = 0;
7068
7069 while (1)
7070 {
7071 int nread;
7072 nread = read_avail_input (1);
7073 /* -1 means it's not ok to read the input now.
7074 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7075 0 means there was no keyboard input available. */
7076 if (nread <= 0)
7077 break;
7078
7079#ifdef BSD4_1
7080 select_alarmed = 1; /* Force the select emulator back to life */
7081#endif
7082 }
7083}
7084
284f4730
JB
7085#ifdef SIGIO /* for entire page */
7086/* Note SIGIO has been undef'd if FIONREAD is missing. */
7087
4216b545 7088static SIGTYPE
284f4730
JB
7089input_available_signal (signo)
7090 int signo;
7091{
7092 /* Must preserve main program's value of errno. */
7093 int old_errno = errno;
5970a8cb 7094#if defined (USG) && !defined (POSIX_SIGNALS)
284f4730
JB
7095 /* USG systems forget handlers when they are used;
7096 must reestablish each time */
7097 signal (signo, input_available_signal);
7098#endif /* USG */
7099
7100#ifdef BSD4_1
7101 sigisheld (SIGIO);
7102#endif
7103
b65c1b44
SM
7104#ifdef SYNC_INPUT
7105 interrupt_input_pending = 1;
7106#else
333f1b6f 7107 SIGNAL_THREAD_CHECK (signo);
bd55c35c 7108#endif
a25f766a 7109
bd55c35c
JD
7110 if (input_available_clear_time)
7111 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
7112
7113#ifndef SYNC_INPUT
b65c1b44 7114 handle_async_input ();
284f4730 7115#endif
284f4730
JB
7116
7117#ifdef BSD4_1
7118 sigfree ();
7119#endif
7120 errno = old_errno;
7121}
7122#endif /* SIGIO */
ad163903
JB
7123
7124/* Send ourselves a SIGIO.
7125
7126 This function exists so that the UNBLOCK_INPUT macro in
7127 blockinput.h can have some way to take care of input we put off
7128 dealing with, without assuming that every file which uses
7129 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7130void
7131reinvoke_input_signal ()
7132{
df0f2ba1 7133#ifdef SIGIO
b65c1b44 7134 handle_async_input ();
ad163903
JB
7135#endif
7136}
7137
7138
284f4730 7139\f
23479b40
YM
7140/* User signal events. */
7141
7142struct user_signal_info
7143{
7144 /* Signal number. */
7145 int sig;
7146
7147 /* Name of the signal. */
7148 char *name;
7149
7150 /* Number of pending signals. */
7151 int npending;
7152
7153 struct user_signal_info *next;
7154};
7155
7156/* List of user signals. */
7157static struct user_signal_info *user_signals = NULL;
7158
7159void
7160add_user_signal (sig, name)
7161 int sig;
7162 const char *name;
7163{
7164 struct user_signal_info *p;
7165
7166 for (p = user_signals; p; p = p->next)
7167 if (p->sig == sig)
7168 /* Already added. */
7169 return;
7170
7171 p = xmalloc (sizeof (struct user_signal_info));
7172 p->sig = sig;
7173 p->name = xstrdup (name);
7174 p->npending = 0;
7175 p->next = user_signals;
7176 user_signals = p;
7177
7178 signal (sig, handle_user_signal);
7179}
7180
7181static SIGTYPE
7182handle_user_signal (sig)
7183 int sig;
7184{
7185 int old_errno = errno;
7186 struct user_signal_info *p;
7187
7188#if defined (USG) && !defined (POSIX_SIGNALS)
7189 /* USG systems forget handlers when they are used;
7190 must reestablish each time */
7191 signal (sig, handle_user_signal);
7192#endif
7193
7194 SIGNAL_THREAD_CHECK (sig);
7195
7196 for (p = user_signals; p; p = p->next)
7197 if (p->sig == sig)
7198 {
7199 p->npending++;
7200#ifdef SIGIO
7201 if (interrupt_input)
7202 kill (getpid (), SIGIO);
7203 else
7204#endif
7205 {
7206 /* Tell wait_reading_process_output that it needs to wake
7207 up and look around. */
7208 if (input_available_clear_time)
7209 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
7210 }
7211 break;
7212 }
7213
7214 errno = old_errno;
7215}
7216
7217static char *
7218find_user_signal_name (sig)
7219 int sig;
7220{
7221 struct user_signal_info *p;
7222
7223 for (p = user_signals; p; p = p->next)
7224 if (p->sig == sig)
7225 return p->name;
7226
7227 return NULL;
7228}
7229
7230static int
7231store_user_signal_events ()
7232{
7233 struct user_signal_info *p;
7234 struct input_event buf;
7235 int nstored = 0;
7236
7237 for (p = user_signals; p; p = p->next)
7238 if (p->npending > 0)
7239 {
7240 SIGMASKTYPE mask;
7241
7242 if (nstored == 0)
7243 {
7244 bzero (&buf, sizeof buf);
7245 buf.kind = USER_SIGNAL_EVENT;
7246 buf.frame_or_window = selected_frame;
7247 }
7248 nstored += p->npending;
7249
7250 mask = sigblock (sigmask (p->sig));
7251 do
7252 {
23479b40
YM
7253 buf.code = p->sig;
7254 kbd_buffer_store_event (&buf);
7255 p->npending--;
7256 }
7257 while (p->npending > 0);
7258 sigsetmask (mask);
7259 }
7260
7261 return nstored;
7262}
7263
7264\f
318ab85c
SM
7265static void menu_bar_item P_ ((Lisp_Object, Lisp_Object, Lisp_Object, void*));
7266static Lisp_Object menu_bar_one_keymap_changed_items;
b7c49376
RS
7267
7268/* These variables hold the vector under construction within
7269 menu_bar_items and its subroutines, and the current index
7270 for storing into that vector. */
7271static Lisp_Object menu_bar_items_vector;
9343ab07 7272static int menu_bar_items_index;
5ec75a55 7273
b7c49376
RS
7274/* Return a vector of menu items for a menu bar, appropriate
7275 to the current buffer. Each item has three elements in the vector:
f5e09c8b 7276 KEY STRING MAPLIST.
b7c49376
RS
7277
7278 OLD is an old vector we can optionally reuse, or nil. */
5ec75a55
RS
7279
7280Lisp_Object
b7c49376
RS
7281menu_bar_items (old)
7282 Lisp_Object old;
5ec75a55
RS
7283{
7284 /* The number of keymaps we're scanning right now, and the number of
7285 keymaps we have allocated space for. */
7286 int nmaps;
7287
7288 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7289 in the current keymaps, or nil where it is not a prefix. */
7290 Lisp_Object *maps;
7291
aebfea68 7292 Lisp_Object def, tail;
5ec75a55
RS
7293
7294 Lisp_Object result;
7295
7296 int mapno;
47d319aa 7297 Lisp_Object oquit;
5ec75a55 7298
b7c49376
RS
7299 int i;
7300
db60d856
JB
7301 /* In order to build the menus, we need to call the keymap
7302 accessors. They all call QUIT. But this function is called
7303 during redisplay, during which a quit is fatal. So inhibit
47d319aa
RS
7304 quitting while building the menus.
7305 We do this instead of specbind because (1) errors will clear it anyway
7306 and (2) this avoids risk of specpdl overflow. */
7307 oquit = Vinhibit_quit;
df0f2ba1 7308 Vinhibit_quit = Qt;
db60d856 7309
b7c49376
RS
7310 if (!NILP (old))
7311 menu_bar_items_vector = old;
7312 else
7313 menu_bar_items_vector = Fmake_vector (make_number (24), Qnil);
7314 menu_bar_items_index = 0;
7315
5ec75a55
RS
7316 /* Build our list of keymaps.
7317 If we recognize a function key and replace its escape sequence in
7318 keybuf with its symbol, or if the sequence starts with a mouse
7319 click and we need to switch buffers, we jump back here to rebuild
7320 the initial keymaps from the current buffer. */
df0f2ba1 7321 {
5ec75a55
RS
7322 Lisp_Object *tmaps;
7323
217258d5 7324 /* Should overriding-terminal-local-map and overriding-local-map apply? */
d0a49716 7325 if (!NILP (Voverriding_local_map_menu_flag))
9dd3131c 7326 {
217258d5
KH
7327 /* Yes, use them (if non-nil) as well as the global map. */
7328 maps = (Lisp_Object *) alloca (3 * sizeof (maps[0]));
7329 nmaps = 0;
7330 if (!NILP (current_kboard->Voverriding_terminal_local_map))
7331 maps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
7332 if (!NILP (Voverriding_local_map))
7333 maps[nmaps++] = Voverriding_local_map;
9dd3131c
RS
7334 }
7335 else
7336 {
fd646341
KS
7337 /* No, so use major and minor mode keymaps and keymap property.
7338 Note that menu-bar bindings in the local-map and keymap
7339 properties may not work reliable, as they are only
7340 recognized when the menu-bar (or mode-line) is updated,
7341 which does not normally happen after every command. */
7342 Lisp_Object tem;
7343 int nminor;
7344 nminor = current_minor_maps (NULL, &tmaps);
7345 maps = (Lisp_Object *) alloca ((nminor + 3) * sizeof (maps[0]));
7346 nmaps = 0;
7347 if (tem = get_local_map (PT, current_buffer, Qkeymap), !NILP (tem))
7348 maps[nmaps++] = tem;
7349 bcopy (tmaps, (void *) (maps + nmaps), nminor * sizeof (maps[0]));
7350 nmaps += nminor;
7351 maps[nmaps++] = get_local_map (PT, current_buffer, Qlocal_map);
9dd3131c 7352 }
217258d5 7353 maps[nmaps++] = current_global_map;
5ec75a55
RS
7354 }
7355
7356 /* Look up in each map the dummy prefix key `menu-bar'. */
7357
7358 result = Qnil;
7359
e58aa385 7360 for (mapno = nmaps - 1; mapno >= 0; mapno--)
25126faa
GM
7361 if (!NILP (maps[mapno]))
7362 {
341a09cf
SM
7363 def = get_keymap (access_keymap (maps[mapno], Qmenu_bar, 1, 0, 1),
7364 0, 1);
02067692 7365 if (CONSP (def))
4216b545
SM
7366 {
7367 menu_bar_one_keymap_changed_items = Qnil;
7368 map_keymap (def, menu_bar_item, Qnil, NULL, 1);
7369 }
25126faa 7370 }
5ec75a55 7371
b7c49376
RS
7372 /* Move to the end those items that should be at the end. */
7373
7539e11f 7374 for (tail = Vmenu_bar_final_items; CONSP (tail); tail = XCDR (tail))
9f9c0e27 7375 {
b7c49376
RS
7376 int i;
7377 int end = menu_bar_items_index;
7378
35b3402f 7379 for (i = 0; i < end; i += 4)
7539e11f 7380 if (EQ (XCAR (tail), XVECTOR (menu_bar_items_vector)->contents[i]))
b7c49376 7381 {
35b3402f 7382 Lisp_Object tem0, tem1, tem2, tem3;
0301268e
RS
7383 /* Move the item at index I to the end,
7384 shifting all the others forward. */
7385 tem0 = XVECTOR (menu_bar_items_vector)->contents[i + 0];
7386 tem1 = XVECTOR (menu_bar_items_vector)->contents[i + 1];
7387 tem2 = XVECTOR (menu_bar_items_vector)->contents[i + 2];
35b3402f
RS
7388 tem3 = XVECTOR (menu_bar_items_vector)->contents[i + 3];
7389 if (end > i + 4)
7390 bcopy (&XVECTOR (menu_bar_items_vector)->contents[i + 4],
0301268e 7391 &XVECTOR (menu_bar_items_vector)->contents[i],
35b3402f
RS
7392 (end - i - 4) * sizeof (Lisp_Object));
7393 XVECTOR (menu_bar_items_vector)->contents[end - 4] = tem0;
7394 XVECTOR (menu_bar_items_vector)->contents[end - 3] = tem1;
7395 XVECTOR (menu_bar_items_vector)->contents[end - 2] = tem2;
7396 XVECTOR (menu_bar_items_vector)->contents[end - 1] = tem3;
0301268e 7397 break;
b7c49376
RS
7398 }
7399 }
9f9c0e27 7400
0c9071cd 7401 /* Add nil, nil, nil, nil at the end. */
b7c49376 7402 i = menu_bar_items_index;
35b3402f 7403 if (i + 4 > XVECTOR (menu_bar_items_vector)->size)
b7c49376
RS
7404 {
7405 Lisp_Object tem;
b7c49376
RS
7406 tem = Fmake_vector (make_number (2 * i), Qnil);
7407 bcopy (XVECTOR (menu_bar_items_vector)->contents,
7408 XVECTOR (tem)->contents, i * sizeof (Lisp_Object));
7409 menu_bar_items_vector = tem;
9f9c0e27 7410 }
b7c49376
RS
7411 /* Add this item. */
7412 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
7413 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
7414 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
35b3402f 7415 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
b7c49376 7416 menu_bar_items_index = i;
a73c5e29 7417
47d319aa 7418 Vinhibit_quit = oquit;
b7c49376 7419 return menu_bar_items_vector;
5ec75a55
RS
7420}
7421\f
f5e09c8b
RS
7422/* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7423 If there's already an item for KEY, add this DEF to it. */
7424
e8886a1d
RS
7425Lisp_Object item_properties;
7426
b7c49376 7427static void
4216b545
SM
7428menu_bar_item (key, item, dummy1, dummy2)
7429 Lisp_Object key, item, dummy1;
7430 void *dummy2;
5ec75a55 7431{
e8886a1d 7432 struct gcpro gcpro1;
b7c49376 7433 int i;
759860a6 7434 Lisp_Object tem;
5ec75a55 7435
e8886a1d 7436 if (EQ (item, Qundefined))
e58aa385 7437 {
f5e09c8b 7438 /* If a map has an explicit `undefined' as definition,
e58aa385 7439 discard any previously made menu bar item. */
b7c49376 7440
35b3402f 7441 for (i = 0; i < menu_bar_items_index; i += 4)
b7c49376
RS
7442 if (EQ (key, XVECTOR (menu_bar_items_vector)->contents[i]))
7443 {
35b3402f
RS
7444 if (menu_bar_items_index > i + 4)
7445 bcopy (&XVECTOR (menu_bar_items_vector)->contents[i + 4],
b7c49376 7446 &XVECTOR (menu_bar_items_vector)->contents[i],
35b3402f
RS
7447 (menu_bar_items_index - i - 4) * sizeof (Lisp_Object));
7448 menu_bar_items_index -= 4;
b7c49376 7449 }
e58aa385
RS
7450 }
7451
759860a6
RS
7452 /* If this keymap has already contributed to this KEY,
7453 don't contribute to it a second time. */
7454 tem = Fmemq (key, menu_bar_one_keymap_changed_items);
9cd2ced7 7455 if (!NILP (tem) || NILP (item))
759860a6
RS
7456 return;
7457
7458 menu_bar_one_keymap_changed_items
7459 = Fcons (key, menu_bar_one_keymap_changed_items);
7460
9cd2ced7
SM
7461 /* We add to menu_bar_one_keymap_changed_items before doing the
7462 parse_menu_item, so that if it turns out it wasn't a menu item,
7463 it still correctly hides any further menu item. */
7464 GCPRO1 (key);
7465 i = parse_menu_item (item, 0, 1);
7466 UNGCPRO;
7467 if (!i)
7468 return;
7469
e8886a1d
RS
7470 item = XVECTOR (item_properties)->contents[ITEM_PROPERTY_DEF];
7471
f5e09c8b 7472 /* Find any existing item for this KEY. */
35b3402f 7473 for (i = 0; i < menu_bar_items_index; i += 4)
b7c49376
RS
7474 if (EQ (key, XVECTOR (menu_bar_items_vector)->contents[i]))
7475 break;
7476
f5e09c8b 7477 /* If we did not find this KEY, add it at the end. */
b7c49376
RS
7478 if (i == menu_bar_items_index)
7479 {
7480 /* If vector is too small, get a bigger one. */
35b3402f 7481 if (i + 4 > XVECTOR (menu_bar_items_vector)->size)
b7c49376
RS
7482 {
7483 Lisp_Object tem;
b7c49376
RS
7484 tem = Fmake_vector (make_number (2 * i), Qnil);
7485 bcopy (XVECTOR (menu_bar_items_vector)->contents,
7486 XVECTOR (tem)->contents, i * sizeof (Lisp_Object));
7487 menu_bar_items_vector = tem;
7488 }
e8886a1d 7489
b7c49376
RS
7490 /* Add this item. */
7491 XVECTOR (menu_bar_items_vector)->contents[i++] = key;
e8886a1d
RS
7492 XVECTOR (menu_bar_items_vector)->contents[i++]
7493 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_NAME];
7494 XVECTOR (menu_bar_items_vector)->contents[i++] = Fcons (item, Qnil);
35b3402f 7495 XVECTOR (menu_bar_items_vector)->contents[i++] = make_number (0);
b7c49376
RS
7496 menu_bar_items_index = i;
7497 }
e8886a1d 7498 /* We did find an item for this KEY. Add ITEM to its list of maps. */
f5e09c8b
RS
7499 else
7500 {
7501 Lisp_Object old;
7502 old = XVECTOR (menu_bar_items_vector)->contents[i + 2];
4216b545
SM
7503 /* If the new and the old items are not both keymaps,
7504 the lookup will only find `item'. */
7505 item = Fcons (item, KEYMAPP (item) && KEYMAPP (XCAR (old)) ? old : Qnil);
7506 XVECTOR (menu_bar_items_vector)->contents[i + 2] = item;
f5e09c8b 7507 }
5ec75a55
RS
7508}
7509\f
e8886a1d
RS
7510 /* This is used as the handler when calling menu_item_eval_property. */
7511static Lisp_Object
7512menu_item_eval_property_1 (arg)
7513 Lisp_Object arg;
7514{
7515 /* If we got a quit from within the menu computation,
7516 quit all the way out of it. This takes care of C-] in the debugger. */
7539e11f 7517 if (CONSP (arg) && EQ (XCAR (arg), Qquit))
e8886a1d
RS
7518 Fsignal (Qquit, Qnil);
7519
7520 return Qnil;
7521}
7522
c60ee5e7 7523/* Evaluate an expression and return the result (or nil if something
e8886a1d 7524 went wrong). Used to evaluate dynamic parts of menu items. */
7ee32cda 7525Lisp_Object
e8886a1d
RS
7526menu_item_eval_property (sexpr)
7527 Lisp_Object sexpr;
7528{
aed13378 7529 int count = SPECPDL_INDEX ();
e8886a1d 7530 Lisp_Object val;
44e553a3 7531 specbind (Qinhibit_redisplay, Qt);
e8886a1d
RS
7532 val = internal_condition_case_1 (Feval, sexpr, Qerror,
7533 menu_item_eval_property_1);
44e553a3 7534 return unbind_to (count, val);
e8886a1d
RS
7535}
7536
7537/* This function parses a menu item and leaves the result in the
7538 vector item_properties.
7539 ITEM is a key binding, a possible menu item.
7540 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7541 evaluate dynamic expressions in the menu item.
fd3613d7 7542 INMENUBAR is > 0 when this is considered for an entry in a menu bar
e8886a1d 7543 top level.
fd3613d7 7544 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
e8886a1d
RS
7545 parse_menu_item returns true if the item is a menu item and false
7546 otherwise. */
7547
7548int
7549parse_menu_item (item, notreal, inmenubar)
7550 Lisp_Object item;
7551 int notreal, inmenubar;
7552{
adc1d5c8 7553 Lisp_Object def, tem, item_string, start;
07ba902e
RS
7554 Lisp_Object cachelist;
7555 Lisp_Object filter;
7556 Lisp_Object keyhint;
e8886a1d 7557 int i;
74c1de23
RS
7558 int newcache = 0;
7559
07ba902e
RS
7560 cachelist = Qnil;
7561 filter = Qnil;
7562 keyhint = Qnil;
7563
e8886a1d
RS
7564 if (!CONSP (item))
7565 return 0;
7566
e8886a1d
RS
7567 /* Create item_properties vector if necessary. */
7568 if (NILP (item_properties))
7569 item_properties
7570 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE + 1), Qnil);
7571
7572 /* Initialize optional entries. */
7573 for (i = ITEM_PROPERTY_DEF; i < ITEM_PROPERTY_ENABLE; i++)
3626fb1a
GM
7574 AREF (item_properties, i) = Qnil;
7575 AREF (item_properties, ITEM_PROPERTY_ENABLE) = Qt;
c60ee5e7 7576
e8886a1d 7577 /* Save the item here to protect it from GC. */
3626fb1a 7578 AREF (item_properties, ITEM_PROPERTY_ITEM) = item;
e8886a1d 7579
7539e11f 7580 item_string = XCAR (item);
e8886a1d
RS
7581
7582 start = item;
7539e11f 7583 item = XCDR (item);
e8886a1d
RS
7584 if (STRINGP (item_string))
7585 {
7586 /* Old format menu item. */
3626fb1a 7587 AREF (item_properties, ITEM_PROPERTY_NAME) = item_string;
e8886a1d
RS
7588
7589 /* Maybe help string. */
7539e11f 7590 if (CONSP (item) && STRINGP (XCAR (item)))
e8886a1d 7591 {
3626fb1a 7592 AREF (item_properties, ITEM_PROPERTY_HELP) = XCAR (item);
e8886a1d 7593 start = item;
7539e11f 7594 item = XCDR (item);
e8886a1d 7595 }
c60ee5e7 7596
31f84d03 7597 /* Maybe key binding cache. */
7539e11f
KR
7598 if (CONSP (item) && CONSP (XCAR (item))
7599 && (NILP (XCAR (XCAR (item)))
7600 || VECTORP (XCAR (XCAR (item)))))
e8886a1d 7601 {
7539e11f
KR
7602 cachelist = XCAR (item);
7603 item = XCDR (item);
e8886a1d 7604 }
c60ee5e7 7605
e8886a1d 7606 /* This is the real definition--the function to run. */
3626fb1a 7607 AREF (item_properties, ITEM_PROPERTY_DEF) = item;
e8886a1d
RS
7608
7609 /* Get enable property, if any. */
7610 if (SYMBOLP (item))
7611 {
7612 tem = Fget (item, Qmenu_enable);
9d56e0da
EZ
7613 if (!NILP (Venable_disabled_menus_and_buttons))
7614 AREF (item_properties, ITEM_PROPERTY_ENABLE) = Qt;
7615 else if (!NILP (tem))
3626fb1a 7616 AREF (item_properties, ITEM_PROPERTY_ENABLE) = tem;
e8886a1d
RS
7617 }
7618 }
7619 else if (EQ (item_string, Qmenu_item) && CONSP (item))
7620 {
7621 /* New format menu item. */
3626fb1a 7622 AREF (item_properties, ITEM_PROPERTY_NAME) = XCAR (item);
7539e11f 7623 start = XCDR (item);
e8886a1d
RS
7624 if (CONSP (start))
7625 {
7626 /* We have a real binding. */
3626fb1a 7627 AREF (item_properties, ITEM_PROPERTY_DEF) = XCAR (start);
e8886a1d 7628
7539e11f 7629 item = XCDR (start);
e8886a1d 7630 /* Is there a cache list with key equivalences. */
7539e11f 7631 if (CONSP (item) && CONSP (XCAR (item)))
e8886a1d 7632 {
7539e11f
KR
7633 cachelist = XCAR (item);
7634 item = XCDR (item);
e8886a1d
RS
7635 }
7636
7637 /* Parse properties. */
7539e11f 7638 while (CONSP (item) && CONSP (XCDR (item)))
e8886a1d 7639 {
7539e11f
KR
7640 tem = XCAR (item);
7641 item = XCDR (item);
e8886a1d
RS
7642
7643 if (EQ (tem, QCenable))
9d56e0da
EZ
7644 {
7645 if (!NILP (Venable_disabled_menus_and_buttons))
7646 AREF (item_properties, ITEM_PROPERTY_ENABLE) = Qt;
7647 else
7648 AREF (item_properties, ITEM_PROPERTY_ENABLE) = XCAR (item);
7649 }
e8886a1d
RS
7650 else if (EQ (tem, QCvisible) && !notreal)
7651 {
7652 /* If got a visible property and that evaluates to nil
7653 then ignore this item. */
7539e11f 7654 tem = menu_item_eval_property (XCAR (item));
e8886a1d 7655 if (NILP (tem))
adc1d5c8 7656 return 0;
e8886a1d
RS
7657 }
7658 else if (EQ (tem, QChelp))
3626fb1a 7659 AREF (item_properties, ITEM_PROPERTY_HELP) = XCAR (item);
e8886a1d 7660 else if (EQ (tem, QCfilter))
74c1de23
RS
7661 filter = item;
7662 else if (EQ (tem, QCkey_sequence))
7663 {
7539e11f 7664 tem = XCAR (item);
74c1de23
RS
7665 if (NILP (cachelist)
7666 && (SYMBOLP (tem) || STRINGP (tem) || VECTORP (tem)))
7667 /* Be GC protected. Set keyhint to item instead of tem. */
7668 keyhint = item;
7669 }
7670 else if (EQ (tem, QCkeys))
7671 {
7539e11f 7672 tem = XCAR (item);
03cee6ae 7673 if (CONSP (tem) || (STRINGP (tem) && NILP (cachelist)))
3626fb1a 7674 AREF (item_properties, ITEM_PROPERTY_KEYEQ) = tem;
74c1de23 7675 }
7539e11f 7676 else if (EQ (tem, QCbutton) && CONSP (XCAR (item)))
e8886a1d 7677 {
74c1de23 7678 Lisp_Object type;
7539e11f
KR
7679 tem = XCAR (item);
7680 type = XCAR (tem);
e8886a1d
RS
7681 if (EQ (type, QCtoggle) || EQ (type, QCradio))
7682 {
3626fb1a 7683 AREF (item_properties, ITEM_PROPERTY_SELECTED)
7539e11f 7684 = XCDR (tem);
3626fb1a 7685 AREF (item_properties, ITEM_PROPERTY_TYPE)
e8886a1d
RS
7686 = type;
7687 }
7688 }
7539e11f 7689 item = XCDR (item);
e8886a1d
RS
7690 }
7691 }
7692 else if (inmenubar || !NILP (start))
adc1d5c8 7693 return 0;
e8886a1d
RS
7694 }
7695 else
adc1d5c8 7696 return 0; /* not a menu item */
e8886a1d
RS
7697
7698 /* If item string is not a string, evaluate it to get string.
7699 If we don't get a string, skip this item. */
3626fb1a 7700 item_string = AREF (item_properties, ITEM_PROPERTY_NAME);
e8886a1d
RS
7701 if (!(STRINGP (item_string) || notreal))
7702 {
7703 item_string = menu_item_eval_property (item_string);
7704 if (!STRINGP (item_string))
adc1d5c8 7705 return 0;
3626fb1a 7706 AREF (item_properties, ITEM_PROPERTY_NAME) = item_string;
e8886a1d 7707 }
c60ee5e7 7708
e8886a1d 7709 /* If got a filter apply it on definition. */
3626fb1a 7710 def = AREF (item_properties, ITEM_PROPERTY_DEF);
e8886a1d
RS
7711 if (!NILP (filter))
7712 {
7539e11f 7713 def = menu_item_eval_property (list2 (XCAR (filter),
c5c5a6f8
RS
7714 list2 (Qquote, def)));
7715
3626fb1a 7716 AREF (item_properties, ITEM_PROPERTY_DEF) = def;
e8886a1d
RS
7717 }
7718
e8886a1d 7719 /* Enable or disable selection of item. */
3626fb1a 7720 tem = AREF (item_properties, ITEM_PROPERTY_ENABLE);
e8886a1d
RS
7721 if (!EQ (tem, Qt))
7722 {
7723 if (notreal)
7724 tem = Qt;
7725 else
7726 tem = menu_item_eval_property (tem);
7727 if (inmenubar && NILP (tem))
adc1d5c8 7728 return 0; /* Ignore disabled items in menu bar. */
3626fb1a 7729 AREF (item_properties, ITEM_PROPERTY_ENABLE) = tem;
e8886a1d
RS
7730 }
7731
7189cad8
SM
7732 /* If we got no definition, this item is just unselectable text which
7733 is OK in a submenu but not in the menubar. */
7734 if (NILP (def))
7735 return (inmenubar ? 0 : 1);
c60ee5e7 7736
e8886a1d 7737 /* See if this is a separate pane or a submenu. */
3626fb1a 7738 def = AREF (item_properties, ITEM_PROPERTY_DEF);
02067692 7739 tem = get_keymap (def, 0, 1);
9ac425d1 7740 /* For a subkeymap, just record its details and exit. */
02067692 7741 if (CONSP (tem))
e8886a1d 7742 {
3626fb1a
GM
7743 AREF (item_properties, ITEM_PROPERTY_MAP) = tem;
7744 AREF (item_properties, ITEM_PROPERTY_DEF) = tem;
e8886a1d
RS
7745 return 1;
7746 }
c60ee5e7 7747
9ac425d1
RS
7748 /* At the top level in the menu bar, do likewise for commands also.
7749 The menu bar does not display equivalent key bindings anyway.
7750 ITEM_PROPERTY_DEF is already set up properly. */
7751 if (inmenubar > 0)
7752 return 1;
e8886a1d
RS
7753
7754 /* This is a command. See if there is an equivalent key binding. */
7755 if (NILP (cachelist))
7756 {
74c1de23 7757 /* We have to create a cachelist. */
e8886a1d 7758 CHECK_IMPURE (start);
f3fbd155 7759 XSETCDR (start, Fcons (Fcons (Qnil, Qnil), XCDR (start)));
7539e11f 7760 cachelist = XCAR (XCDR (start));
74c1de23 7761 newcache = 1;
3626fb1a 7762 tem = AREF (item_properties, ITEM_PROPERTY_KEYEQ);
74c1de23
RS
7763 if (!NILP (keyhint))
7764 {
f3fbd155 7765 XSETCAR (cachelist, XCAR (keyhint));
74c1de23
RS
7766 newcache = 0;
7767 }
7768 else if (STRINGP (tem))
7769 {
f3fbd155
KR
7770 XSETCDR (cachelist, Fsubstitute_command_keys (tem));
7771 XSETCAR (cachelist, Qt);
74c1de23
RS
7772 }
7773 }
c60ee5e7 7774
7539e11f 7775 tem = XCAR (cachelist);
74c1de23
RS
7776 if (!EQ (tem, Qt))
7777 {
7778 int chkcache = 0;
7779 Lisp_Object prefix;
7780
7781 if (!NILP (tem))
b74e16a3 7782 tem = Fkey_binding (tem, Qnil, Qnil, Qnil);
74c1de23 7783
3626fb1a 7784 prefix = AREF (item_properties, ITEM_PROPERTY_KEYEQ);
74c1de23
RS
7785 if (CONSP (prefix))
7786 {
7539e11f
KR
7787 def = XCAR (prefix);
7788 prefix = XCDR (prefix);
74c1de23 7789 }
e8886a1d 7790 else
3626fb1a 7791 def = AREF (item_properties, ITEM_PROPERTY_DEF);
74c1de23 7792
9867523c 7793 if (NILP (XCAR (cachelist))) /* Have no saved key. */
74c1de23
RS
7794 {
7795 if (newcache /* Always check first time. */
7796 /* Should we check everything when precomputing key
7797 bindings? */
74c1de23
RS
7798 /* If something had no key binding before, don't recheck it
7799 because that is too slow--except if we have a list of
7800 rebound commands in Vdefine_key_rebound_commands, do
7801 recheck any command that appears in that list. */
7802 || (CONSP (Vdefine_key_rebound_commands)
7803 && !NILP (Fmemq (def, Vdefine_key_rebound_commands))))
7804 chkcache = 1;
7805 }
7806 /* We had a saved key. Is it still bound to the command? */
7807 else if (NILP (tem)
03cee6ae
GM
7808 || (!EQ (tem, def)
7809 /* If the command is an alias for another
7810 (such as lmenu.el set it up), check if the
7811 original command matches the cached command. */
7812 && !(SYMBOLP (def) && EQ (tem, XSYMBOL (def)->function))))
74c1de23
RS
7813 chkcache = 1; /* Need to recompute key binding. */
7814
7815 if (chkcache)
7816 {
7817 /* Recompute equivalent key binding. If the command is an alias
7818 for another (such as lmenu.el set it up), see if the original
7819 command name has equivalent keys. Otherwise look up the
7820 specified command itself. We don't try both, because that
7821 makes lmenu menus slow. */
3626fb1a
GM
7822 if (SYMBOLP (def)
7823 && SYMBOLP (XSYMBOL (def)->function)
74c1de23
RS
7824 && ! NILP (Fget (def, Qmenu_alias)))
7825 def = XSYMBOL (def)->function;
8b9940e6 7826 tem = Fwhere_is_internal (def, Qnil, Qt, Qnil, Qt);
f3fbd155 7827 XSETCAR (cachelist, tem);
74c1de23
RS
7828 if (NILP (tem))
7829 {
f3fbd155 7830 XSETCDR (cachelist, Qnil);
74c1de23
RS
7831 chkcache = 0;
7832 }
7833 }
7539e11f 7834 else if (!NILP (keyhint) && !NILP (XCAR (cachelist)))
74c1de23 7835 {
7539e11f 7836 tem = XCAR (cachelist);
74c1de23
RS
7837 chkcache = 1;
7838 }
7839
7840 newcache = chkcache;
7841 if (chkcache)
7842 {
a1bfe073 7843 tem = Fkey_description (tem, Qnil);
74c1de23
RS
7844 if (CONSP (prefix))
7845 {
7539e11f
KR
7846 if (STRINGP (XCAR (prefix)))
7847 tem = concat2 (XCAR (prefix), tem);
7848 if (STRINGP (XCDR (prefix)))
7849 tem = concat2 (tem, XCDR (prefix));
74c1de23 7850 }
f3fbd155 7851 XSETCDR (cachelist, tem);
74c1de23
RS
7852 }
7853 }
7854
7539e11f 7855 tem = XCDR (cachelist);
74c1de23 7856 if (newcache && !NILP (tem))
e8886a1d 7857 {
74c1de23 7858 tem = concat3 (build_string (" ("), tem, build_string (")"));
f3fbd155 7859 XSETCDR (cachelist, tem);
e8886a1d
RS
7860 }
7861
7862 /* If we only want to precompute equivalent key bindings, stop here. */
7863 if (notreal)
adc1d5c8 7864 return 1;
e8886a1d
RS
7865
7866 /* If we have an equivalent key binding, use that. */
3626fb1a 7867 AREF (item_properties, ITEM_PROPERTY_KEYEQ) = tem;
adc1d5c8
RS
7868
7869 /* Include this when menu help is implemented.
7870 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7871 if (!(NILP (tem) || STRINGP (tem)))
7872 {
7873 tem = menu_item_eval_property (tem);
7874 if (!STRINGP (tem))
7875 tem = Qnil;
7876 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7877 }
e8886a1d
RS
7878 */
7879
c60ee5e7 7880 /* Handle radio buttons or toggle boxes. */
3626fb1a 7881 tem = AREF (item_properties, ITEM_PROPERTY_SELECTED);
e8886a1d 7882 if (!NILP (tem))
3626fb1a 7883 AREF (item_properties, ITEM_PROPERTY_SELECTED)
e8886a1d
RS
7884 = menu_item_eval_property (tem);
7885
e8886a1d
RS
7886 return 1;
7887}
7ee32cda
GM
7888
7889
7890\f
7891/***********************************************************************
7892 Tool-bars
7893 ***********************************************************************/
7894
9ea173e8 7895/* A vector holding tool bar items while they are parsed in function
27fd22dc 7896 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
9ea173e8 7897 in the vector. */
7ee32cda 7898
9ea173e8 7899static Lisp_Object tool_bar_items_vector;
7ee32cda 7900
9ea173e8
GM
7901/* A vector holding the result of parse_tool_bar_item. Layout is like
7902 the one for a single item in tool_bar_items_vector. */
7ee32cda 7903
9ea173e8 7904static Lisp_Object tool_bar_item_properties;
7ee32cda 7905
9ea173e8 7906/* Next free index in tool_bar_items_vector. */
7ee32cda 7907
9ea173e8 7908static int ntool_bar_items;
7ee32cda 7909
9ea173e8 7910/* The symbols `tool-bar', and `:image'. */
7ee32cda 7911
9ea173e8 7912extern Lisp_Object Qtool_bar;
7ee32cda
GM
7913Lisp_Object QCimage;
7914
7915/* Function prototypes. */
7916
9ea173e8 7917static void init_tool_bar_items P_ ((Lisp_Object));
9c8c4d5b 7918static void process_tool_bar_item P_ ((Lisp_Object, Lisp_Object, Lisp_Object, void*));
9ea173e8
GM
7919static int parse_tool_bar_item P_ ((Lisp_Object, Lisp_Object));
7920static void append_tool_bar_item P_ ((void));
7ee32cda
GM
7921
7922
9ea173e8 7923/* Return a vector of tool bar items for keymaps currently in effect.
7ee32cda 7924 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
9ea173e8 7925 tool bar items found. */
7ee32cda
GM
7926
7927Lisp_Object
9ea173e8 7928tool_bar_items (reuse, nitems)
7ee32cda
GM
7929 Lisp_Object reuse;
7930 int *nitems;
7931{
7932 Lisp_Object *maps;
7933 int nmaps, i;
7934 Lisp_Object oquit;
7935 Lisp_Object *tmaps;
7ee32cda
GM
7936
7937 *nitems = 0;
7938
7939 /* In order to build the menus, we need to call the keymap
7940 accessors. They all call QUIT. But this function is called
7941 during redisplay, during which a quit is fatal. So inhibit
7942 quitting while building the menus. We do this instead of
7943 specbind because (1) errors will clear it anyway and (2) this
7944 avoids risk of specpdl overflow. */
7945 oquit = Vinhibit_quit;
7946 Vinhibit_quit = Qt;
c60ee5e7 7947
9ea173e8
GM
7948 /* Initialize tool_bar_items_vector and protect it from GC. */
7949 init_tool_bar_items (reuse);
7ee32cda
GM
7950
7951 /* Build list of keymaps in maps. Set nmaps to the number of maps
7952 to process. */
c60ee5e7 7953
7ee32cda
GM
7954 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7955 if (!NILP (Voverriding_local_map_menu_flag))
7956 {
7957 /* Yes, use them (if non-nil) as well as the global map. */
7958 maps = (Lisp_Object *) alloca (3 * sizeof (maps[0]));
7959 nmaps = 0;
7960 if (!NILP (current_kboard->Voverriding_terminal_local_map))
7961 maps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
7962 if (!NILP (Voverriding_local_map))
7963 maps[nmaps++] = Voverriding_local_map;
7964 }
7965 else
7966 {
fd646341
KS
7967 /* No, so use major and minor mode keymaps and keymap property.
7968 Note that tool-bar bindings in the local-map and keymap
7969 properties may not work reliable, as they are only
7970 recognized when the tool-bar (or mode-line) is updated,
7971 which does not normally happen after every command. */
7972 Lisp_Object tem;
7973 int nminor;
7974 nminor = current_minor_maps (NULL, &tmaps);
7975 maps = (Lisp_Object *) alloca ((nminor + 3) * sizeof (maps[0]));
7976 nmaps = 0;
7977 if (tem = get_local_map (PT, current_buffer, Qkeymap), !NILP (tem))
7978 maps[nmaps++] = tem;
7979 bcopy (tmaps, (void *) (maps + nmaps), nminor * sizeof (maps[0]));
7980 nmaps += nminor;
7981 maps[nmaps++] = get_local_map (PT, current_buffer, Qlocal_map);
7ee32cda
GM
7982 }
7983
7984 /* Add global keymap at the end. */
7985 maps[nmaps++] = current_global_map;
7986
7987 /* Process maps in reverse order and look up in each map the prefix
9ea173e8 7988 key `tool-bar'. */
7ee32cda
GM
7989 for (i = nmaps - 1; i >= 0; --i)
7990 if (!NILP (maps[i]))
7991 {
7992 Lisp_Object keymap;
db785038 7993
341a09cf 7994 keymap = get_keymap (access_keymap (maps[i], Qtool_bar, 1, 0, 1), 0, 1);
02067692 7995 if (CONSP (keymap))
293bd733 7996 map_keymap (keymap, process_tool_bar_item, Qnil, NULL, 1);
7ee32cda
GM
7997 }
7998
7999 Vinhibit_quit = oquit;
9ea173e8
GM
8000 *nitems = ntool_bar_items / TOOL_BAR_ITEM_NSLOTS;
8001 return tool_bar_items_vector;
7ee32cda
GM
8002}
8003
8004
8005/* Process the definition of KEY which is DEF. */
8006
8007static void
9c8c4d5b 8008process_tool_bar_item (key, def, data, args)
293bd733
SM
8009 Lisp_Object key, def, data;
8010 void *args;
7ee32cda
GM
8011{
8012 int i;
8013 extern Lisp_Object Qundefined;
8014 struct gcpro gcpro1, gcpro2;
8015
9ea173e8 8016 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7ee32cda
GM
8017 eval. */
8018 GCPRO2 (key, def);
8019
8020 if (EQ (def, Qundefined))
8021 {
8022 /* If a map has an explicit `undefined' as definition,
8023 discard any previously made item. */
9ea173e8 8024 for (i = 0; i < ntool_bar_items; i += TOOL_BAR_ITEM_NSLOTS)
7ee32cda 8025 {
9ea173e8 8026 Lisp_Object *v = XVECTOR (tool_bar_items_vector)->contents + i;
c60ee5e7 8027
9ea173e8 8028 if (EQ (key, v[TOOL_BAR_ITEM_KEY]))
7ee32cda 8029 {
9ea173e8
GM
8030 if (ntool_bar_items > i + TOOL_BAR_ITEM_NSLOTS)
8031 bcopy (v + TOOL_BAR_ITEM_NSLOTS, v,
8032 ((ntool_bar_items - i - TOOL_BAR_ITEM_NSLOTS)
7ee32cda 8033 * sizeof (Lisp_Object)));
9ea173e8 8034 ntool_bar_items -= TOOL_BAR_ITEM_NSLOTS;
7ee32cda
GM
8035 break;
8036 }
8037 }
8038 }
9ea173e8
GM
8039 else if (parse_tool_bar_item (key, def))
8040 /* Append a new tool bar item to tool_bar_items_vector. Accept
7ee32cda 8041 more than one definition for the same key. */
9ea173e8 8042 append_tool_bar_item ();
7ee32cda
GM
8043
8044 UNGCPRO;
8045}
8046
8047
9ea173e8
GM
8048/* Parse a tool bar item specification ITEM for key KEY and return the
8049 result in tool_bar_item_properties. Value is zero if ITEM is
7ee32cda
GM
8050 invalid.
8051
8052 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
c60ee5e7 8053
7ee32cda
GM
8054 CAPTION is the caption of the item, If it's not a string, it is
8055 evaluated to get a string.
c60ee5e7 8056
9ea173e8 8057 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7ee32cda
GM
8058 as binding are currently ignored.
8059
8060 The following properties are recognized:
8061
8062 - `:enable FORM'.
c60ee5e7 8063
9ea173e8
GM
8064 FORM is evaluated and specifies whether the tool bar item is
8065 enabled or disabled.
c60ee5e7 8066
7ee32cda 8067 - `:visible FORM'
c60ee5e7 8068
9ea173e8 8069 FORM is evaluated and specifies whether the tool bar item is visible.
c60ee5e7 8070
7ee32cda
GM
8071 - `:filter FUNCTION'
8072
8073 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8074 result is stored as the new binding.
c60ee5e7 8075
7ee32cda
GM
8076 - `:button (TYPE SELECTED)'
8077
8078 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8079 and specifies whether the button is selected (pressed) or not.
c60ee5e7 8080
7ee32cda
GM
8081 - `:image IMAGES'
8082
8083 IMAGES is either a single image specification or a vector of four
9ea173e8 8084 image specifications. See enum tool_bar_item_images.
c60ee5e7 8085
7ee32cda 8086 - `:help HELP-STRING'.
c60ee5e7 8087
9ea173e8 8088 Gives a help string to display for the tool bar item. */
7ee32cda
GM
8089
8090static int
9ea173e8 8091parse_tool_bar_item (key, item)
7ee32cda
GM
8092 Lisp_Object key, item;
8093{
9ea173e8
GM
8094 /* Access slot with index IDX of vector tool_bar_item_properties. */
8095#define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7ee32cda
GM
8096
8097 Lisp_Object filter = Qnil;
8098 Lisp_Object caption;
7ee32cda 8099 int i;
7ee32cda 8100
8c907a56
GM
8101 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8102 Rule out items that aren't lists, don't start with
8103 `menu-item' or whose rest following `tool-bar-item' is not a
7ee32cda
GM
8104 list. */
8105 if (!CONSP (item)
8106 || !EQ (XCAR (item), Qmenu_item)
8107 || (item = XCDR (item),
8108 !CONSP (item)))
8109 return 0;
8110
9ea173e8 8111 /* Create tool_bar_item_properties vector if necessary. Reset it to
7ee32cda 8112 defaults. */
9ea173e8 8113 if (VECTORP (tool_bar_item_properties))
7ee32cda 8114 {
9ea173e8 8115 for (i = 0; i < TOOL_BAR_ITEM_NSLOTS; ++i)
7ee32cda
GM
8116 PROP (i) = Qnil;
8117 }
8118 else
9ea173e8
GM
8119 tool_bar_item_properties
8120 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS), Qnil);
c60ee5e7 8121
7ee32cda 8122 /* Set defaults. */
9ea173e8
GM
8123 PROP (TOOL_BAR_ITEM_KEY) = key;
8124 PROP (TOOL_BAR_ITEM_ENABLED_P) = Qt;
c60ee5e7 8125
7ee32cda
GM
8126 /* Get the caption of the item. If the caption is not a string,
8127 evaluate it to get a string. If we don't get a string, skip this
8128 item. */
8129 caption = XCAR (item);
8130 if (!STRINGP (caption))
8131 {
8132 caption = menu_item_eval_property (caption);
8133 if (!STRINGP (caption))
8134 return 0;
8135 }
9ea173e8 8136 PROP (TOOL_BAR_ITEM_CAPTION) = caption;
7ee32cda
GM
8137
8138 /* Give up if rest following the caption is not a list. */
8139 item = XCDR (item);
8140 if (!CONSP (item))
8141 return 0;
8142
8143 /* Store the binding. */
9ea173e8 8144 PROP (TOOL_BAR_ITEM_BINDING) = XCAR (item);
7ee32cda
GM
8145 item = XCDR (item);
8146
8c907a56
GM
8147 /* Ignore cached key binding, if any. */
8148 if (CONSP (item) && CONSP (XCAR (item)))
8149 item = XCDR (item);
8150
7ee32cda
GM
8151 /* Process the rest of the properties. */
8152 for (; CONSP (item) && CONSP (XCDR (item)); item = XCDR (XCDR (item)))
8153 {
8154 Lisp_Object key, value;
8155
8156 key = XCAR (item);
8157 value = XCAR (XCDR (item));
8158
8159 if (EQ (key, QCenable))
9d56e0da
EZ
8160 {
8161 /* `:enable FORM'. */
8162 if (!NILP (Venable_disabled_menus_and_buttons))
8163 PROP (TOOL_BAR_ITEM_ENABLED_P) = Qt;
8164 else
8165 PROP (TOOL_BAR_ITEM_ENABLED_P) = value;
8166 }
7ee32cda
GM
8167 else if (EQ (key, QCvisible))
8168 {
8169 /* `:visible FORM'. If got a visible property and that
8170 evaluates to nil then ignore this item. */
8171 if (NILP (menu_item_eval_property (value)))
8172 return 0;
8173 }
8174 else if (EQ (key, QChelp))
8175 /* `:help HELP-STRING'. */
9ea173e8 8176 PROP (TOOL_BAR_ITEM_HELP) = value;
7ee32cda
GM
8177 else if (EQ (key, QCfilter))
8178 /* ':filter FORM'. */
8179 filter = value;
8180 else if (EQ (key, QCbutton) && CONSP (value))
8181 {
8182 /* `:button (TYPE . SELECTED)'. */
8183 Lisp_Object type, selected;
8184
8185 type = XCAR (value);
8186 selected = XCDR (value);
8187 if (EQ (type, QCtoggle) || EQ (type, QCradio))
8188 {
9ea173e8
GM
8189 PROP (TOOL_BAR_ITEM_SELECTED_P) = selected;
8190 PROP (TOOL_BAR_ITEM_TYPE) = type;
7ee32cda
GM
8191 }
8192 }
8193 else if (EQ (key, QCimage)
8194 && (CONSP (value)
8195 || (VECTORP (value) && XVECTOR (value)->size == 4)))
8196 /* Value is either a single image specification or a vector
27fd22dc 8197 of 4 such specifications for the different button states. */
9ea173e8 8198 PROP (TOOL_BAR_ITEM_IMAGES) = value;
7ee32cda
GM
8199 }
8200
8201 /* If got a filter apply it on binding. */
8202 if (!NILP (filter))
9ea173e8 8203 PROP (TOOL_BAR_ITEM_BINDING)
7ee32cda
GM
8204 = menu_item_eval_property (list2 (filter,
8205 list2 (Qquote,
9ea173e8 8206 PROP (TOOL_BAR_ITEM_BINDING))));
7ee32cda
GM
8207
8208 /* See if the binding is a keymap. Give up if it is. */
02067692 8209 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING), 0, 1)))
7ee32cda
GM
8210 return 0;
8211
8212 /* Enable or disable selection of item. */
9ea173e8
GM
8213 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P), Qt))
8214 PROP (TOOL_BAR_ITEM_ENABLED_P)
8215 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P));
7ee32cda 8216
c60ee5e7 8217 /* Handle radio buttons or toggle boxes. */
9ea173e8
GM
8218 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P)))
8219 PROP (TOOL_BAR_ITEM_SELECTED_P)
8220 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P));
7ee32cda
GM
8221
8222 return 1;
c60ee5e7 8223
7ee32cda
GM
8224#undef PROP
8225}
8226
8227
9ea173e8
GM
8228/* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8229 that can be reused. */
7ee32cda
GM
8230
8231static void
9ea173e8 8232init_tool_bar_items (reuse)
7ee32cda
GM
8233 Lisp_Object reuse;
8234{
8235 if (VECTORP (reuse))
9ea173e8 8236 tool_bar_items_vector = reuse;
7ee32cda 8237 else
9ea173e8
GM
8238 tool_bar_items_vector = Fmake_vector (make_number (64), Qnil);
8239 ntool_bar_items = 0;
7ee32cda
GM
8240}
8241
8242
9ea173e8
GM
8243/* Append parsed tool bar item properties from
8244 tool_bar_item_properties */
7ee32cda
GM
8245
8246static void
9ea173e8 8247append_tool_bar_item ()
7ee32cda
GM
8248{
8249 Lisp_Object *to, *from;
c60ee5e7 8250
9ea173e8
GM
8251 /* Enlarge tool_bar_items_vector if necessary. */
8252 if (ntool_bar_items + TOOL_BAR_ITEM_NSLOTS
8253 >= XVECTOR (tool_bar_items_vector)->size)
7ee32cda
GM
8254 {
8255 Lisp_Object new_vector;
9ea173e8 8256 int old_size = XVECTOR (tool_bar_items_vector)->size;
7ee32cda
GM
8257
8258 new_vector = Fmake_vector (make_number (2 * old_size), Qnil);
9ea173e8 8259 bcopy (XVECTOR (tool_bar_items_vector)->contents,
7ee32cda
GM
8260 XVECTOR (new_vector)->contents,
8261 old_size * sizeof (Lisp_Object));
9ea173e8 8262 tool_bar_items_vector = new_vector;
7ee32cda
GM
8263 }
8264
9ea173e8
GM
8265 /* Append entries from tool_bar_item_properties to the end of
8266 tool_bar_items_vector. */
8267 to = XVECTOR (tool_bar_items_vector)->contents + ntool_bar_items;
8268 from = XVECTOR (tool_bar_item_properties)->contents;
8269 bcopy (from, to, TOOL_BAR_ITEM_NSLOTS * sizeof *to);
8270 ntool_bar_items += TOOL_BAR_ITEM_NSLOTS;
7ee32cda
GM
8271}
8272
8273
8274
8275
e8886a1d 8276\f
dcc408a0
RS
8277/* Read a character using menus based on maps in the array MAPS.
8278 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8279 Return t if we displayed a menu but the user rejected it.
7d6de002
RS
8280
8281 PREV_EVENT is the previous input event, or nil if we are reading
8282 the first event of a key sequence.
8283
83d68044 8284 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
6569cc8d 8285 if we used a mouse menu to read the input, or zero otherwise. If
83d68044 8286 USED_MOUSE_MENU is null, we don't dereference it.
284f4730
JB
8287
8288 The prompting is done based on the prompt-string of the map
df0f2ba1 8289 and the strings associated with various map elements.
8150596a
RS
8290
8291 This can be done with X menus or with menus put in the minibuf.
8292 These are done in different ways, depending on how the input will be read.
8293 Menus using X are done after auto-saving in read-char, getting the input
8294 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8295 and do auto-saving in the inner call of read_char. */
284f4730 8296
7617111f 8297static Lisp_Object
8150596a 8298read_char_x_menu_prompt (nmaps, maps, prev_event, used_mouse_menu)
7d6de002
RS
8299 int nmaps;
8300 Lisp_Object *maps;
8301 Lisp_Object prev_event;
8302 int *used_mouse_menu;
284f4730 8303{
7d6de002 8304 int mapno;
14e40288 8305 register Lisp_Object name = Qnil;
7d6de002 8306
6569cc8d
JB
8307 if (used_mouse_menu)
8308 *used_mouse_menu = 0;
284f4730
JB
8309
8310 /* Use local over global Menu maps */
8311
7d6de002
RS
8312 if (! menu_prompting)
8313 return Qnil;
8314
03361bcc
RS
8315 /* Optionally disregard all but the global map. */
8316 if (inhibit_local_menu_bar_menus)
8317 {
8318 maps += (nmaps - 1);
8319 nmaps = 1;
8320 }
8321
7d6de002
RS
8322 /* Get the menu name from the first map that has one (a prompt string). */
8323 for (mapno = 0; mapno < nmaps; mapno++)
8324 {
bdb7aa47 8325 name = Fkeymap_prompt (maps[mapno]);
7d6de002
RS
8326 if (!NILP (name))
8327 break;
8328 }
284f4730 8329
7d6de002 8330 /* If we don't have any menus, just read a character normally. */
fa113341 8331 if (!STRINGP (name))
7d6de002
RS
8332 return Qnil;
8333
1f5b1641 8334#ifdef HAVE_MENUS
7d6de002
RS
8335 /* If we got to this point via a mouse click,
8336 use a real menu for mouse selection. */
5a8d99e0 8337 if (EVENT_HAS_PARAMETERS (prev_event)
7539e11f
KR
8338 && !EQ (XCAR (prev_event), Qmenu_bar)
8339 && !EQ (XCAR (prev_event), Qtool_bar))
7d6de002
RS
8340 {
8341 /* Display the menu and get the selection. */
8342 Lisp_Object *realmaps
8343 = (Lisp_Object *) alloca (nmaps * sizeof (Lisp_Object));
8344 Lisp_Object value;
8345 int nmaps1 = 0;
8346
8347 /* Use the maps that are not nil. */
8348 for (mapno = 0; mapno < nmaps; mapno++)
8349 if (!NILP (maps[mapno]))
8350 realmaps[nmaps1++] = maps[mapno];
8351
8352 value = Fx_popup_menu (prev_event, Flist (nmaps1, realmaps));
663258f2
JB
8353 if (CONSP (value))
8354 {
68f297c5
RS
8355 Lisp_Object tem;
8356
7539e11f 8357 record_menu_key (XCAR (value));
8eb4d8ef 8358
68f297c5
RS
8359 /* If we got multiple events, unread all but
8360 the first.
8361 There is no way to prevent those unread events
8362 from showing up later in last_nonmenu_event.
8363 So turn symbol and integer events into lists,
8364 to indicate that they came from a mouse menu,
8365 so that when present in last_nonmenu_event
8366 they won't confuse things. */
f4e05d97 8367 for (tem = XCDR (value); !NILP (tem); tem = XCDR (tem))
8eb4d8ef 8368 {
7539e11f
KR
8369 record_menu_key (XCAR (tem));
8370 if (SYMBOLP (XCAR (tem))
8371 || INTEGERP (XCAR (tem)))
f3fbd155 8372 XSETCAR (tem, Fcons (XCAR (tem), Qdisabled));
8eb4d8ef 8373 }
68f297c5 8374
663258f2
JB
8375 /* If we got more than one event, put all but the first
8376 onto this list to be read later.
8377 Return just the first event now. */
24597608 8378 Vunread_command_events
7539e11f
KR
8379 = nconc2 (XCDR (value), Vunread_command_events);
8380 value = XCAR (value);
663258f2 8381 }
1c90c381 8382 else if (NILP (value))
dcc408a0 8383 value = Qt;
6569cc8d
JB
8384 if (used_mouse_menu)
8385 *used_mouse_menu = 1;
7d6de002
RS
8386 return value;
8387 }
1f5b1641 8388#endif /* HAVE_MENUS */
8150596a
RS
8389 return Qnil ;
8390}
8391
af2b7cc9
KS
8392/* Buffer in use so far for the minibuf prompts for menu keymaps.
8393 We make this bigger when necessary, and never free it. */
8394static char *read_char_minibuf_menu_text;
8395/* Size of that buffer. */
8396static int read_char_minibuf_menu_width;
8397
8150596a 8398static Lisp_Object
24597608 8399read_char_minibuf_menu_prompt (commandflag, nmaps, maps)
8150596a
RS
8400 int commandflag ;
8401 int nmaps;
8402 Lisp_Object *maps;
8403{
8404 int mapno;
8405 register Lisp_Object name;
af2b7cc9 8406 int nlength;
14e40288 8407 /* FIXME: Use the minibuffer's frame width. */
2cdbe73e 8408 int width = FRAME_COLS (SELECTED_FRAME ()) - 4;
8150596a 8409 int idx = -1;
af2b7cc9 8410 int nobindings = 1;
8150596a 8411 Lisp_Object rest, vector;
af2b7cc9 8412 char *menu;
8150596a 8413
8c907a56 8414 vector = Qnil;
7189cad8 8415 name = Qnil;
8c907a56 8416
8150596a
RS
8417 if (! menu_prompting)
8418 return Qnil;
8419
af2b7cc9
KS
8420 /* Make sure we have a big enough buffer for the menu text. */
8421 if (read_char_minibuf_menu_text == 0)
8422 {
8423 read_char_minibuf_menu_width = width + 4;
8424 read_char_minibuf_menu_text = (char *) xmalloc (width + 4);
8425 }
8426 else if (width + 4 > read_char_minibuf_menu_width)
8427 {
8428 read_char_minibuf_menu_width = width + 4;
8429 read_char_minibuf_menu_text
8430 = (char *) xrealloc (read_char_minibuf_menu_text, width + 4);
8431 }
8432 menu = read_char_minibuf_menu_text;
8433
8150596a
RS
8434 /* Get the menu name from the first map that has one (a prompt string). */
8435 for (mapno = 0; mapno < nmaps; mapno++)
8436 {
bdb7aa47 8437 name = Fkeymap_prompt (maps[mapno]);
8150596a
RS
8438 if (!NILP (name))
8439 break;
8440 }
8441
8442 /* If we don't have any menus, just read a character normally. */
fa113341 8443 if (!STRINGP (name))
8150596a 8444 return Qnil;
284f4730 8445
af2b7cc9 8446 /* Prompt string always starts with map's prompt, and a space. */
d5db4077
KR
8447 strcpy (menu, SDATA (name));
8448 nlength = SBYTES (name);
af2b7cc9
KS
8449 menu[nlength++] = ':';
8450 menu[nlength++] = ' ';
8451 menu[nlength] = 0;
8452
7d6de002
RS
8453 /* Start prompting at start of first map. */
8454 mapno = 0;
8455 rest = maps[mapno];
284f4730 8456
af2b7cc9
KS
8457 /* Present the documented bindings, a line at a time. */
8458 while (1)
284f4730 8459 {
af2b7cc9
KS
8460 int notfirst = 0;
8461 int i = nlength;
8462 Lisp_Object obj;
8463 int ch;
8464 Lisp_Object orig_defn_macro;
284f4730 8465
af2b7cc9
KS
8466 /* Loop over elements of map. */
8467 while (i < width)
284f4730 8468 {
af2b7cc9 8469 Lisp_Object elt;
284f4730 8470
af2b7cc9
KS
8471 /* If reached end of map, start at beginning of next map. */
8472 if (NILP (rest))
8473 {
8474 mapno++;
8475 /* At end of last map, wrap around to first map if just starting,
8476 or end this line if already have something on it. */
8477 if (mapno == nmaps)
8478 {
8479 mapno = 0;
8480 if (notfirst || nobindings) break;
8481 }
8482 rest = maps[mapno];
8483 }
7d6de002 8484
af2b7cc9
KS
8485 /* Look at the next element of the map. */
8486 if (idx >= 0)
8487 elt = XVECTOR (vector)->contents[idx];
8488 else
8489 elt = Fcar_safe (rest);
7d6de002 8490
af2b7cc9 8491 if (idx < 0 && VECTORP (elt))
284f4730 8492 {
af2b7cc9
KS
8493 /* If we found a dense table in the keymap,
8494 advanced past it, but start scanning its contents. */
8495 rest = Fcdr_safe (rest);
8496 vector = elt;
8497 idx = 0;
284f4730 8498 }
7d6de002
RS
8499 else
8500 {
af2b7cc9
KS
8501 /* An ordinary element. */
8502 Lisp_Object event, tem;
7d6de002 8503
af2b7cc9
KS
8504 if (idx < 0)
8505 {
8506 event = Fcar_safe (elt); /* alist */
8507 elt = Fcdr_safe (elt);
8508 }
8509 else
8510 {
8511 XSETINT (event, idx); /* vector */
8512 }
284f4730 8513
af2b7cc9
KS
8514 /* Ignore the element if it has no prompt string. */
8515 if (INTEGERP (event) && parse_menu_item (elt, 0, -1))
8516 {
8517 /* 1 if the char to type matches the string. */
8518 int char_matches;
8519 Lisp_Object upcased_event, downcased_event;
8520 Lisp_Object desc = Qnil;
8521 Lisp_Object s
8522 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_NAME];
8523
8524 upcased_event = Fupcase (event);
8525 downcased_event = Fdowncase (event);
d5db4077
KR
8526 char_matches = (XINT (upcased_event) == SREF (s, 0)
8527 || XINT (downcased_event) == SREF (s, 0));
af2b7cc9
KS
8528 if (! char_matches)
8529 desc = Fsingle_key_description (event, Qnil);
8530
8531#if 0 /* It is redundant to list the equivalent key bindings because
8532 the prefix is what the user has already typed. */
8533 tem
8534 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_KEYEQ];
8535 if (!NILP (tem))
8536 /* Insert equivalent keybinding. */
8537 s = concat2 (s, tem);
8538#endif
8539 tem
8540 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_TYPE];
8541 if (EQ (tem, QCradio) || EQ (tem, QCtoggle))
8542 {
8543 /* Insert button prefix. */
8544 Lisp_Object selected
8545 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_SELECTED];
8546 if (EQ (tem, QCradio))
8547 tem = build_string (NILP (selected) ? "(*) " : "( ) ");
8548 else
8549 tem = build_string (NILP (selected) ? "[X] " : "[ ] ");
8550 s = concat2 (tem, s);
8551 }
c60ee5e7 8552
af2b7cc9
KS
8553
8554 /* If we have room for the prompt string, add it to this line.
8555 If this is the first on the line, always add it. */
d5db4077
KR
8556 if ((SCHARS (s) + i + 2
8557 + (char_matches ? 0 : SCHARS (desc) + 3))
af2b7cc9
KS
8558 < width
8559 || !notfirst)
8560 {
8561 int thiswidth;
8562
8563 /* Punctuate between strings. */
8564 if (notfirst)
8565 {
8566 strcpy (menu + i, ", ");
8567 i += 2;
8568 }
8569 notfirst = 1;
8570 nobindings = 0 ;
8571
8572 /* If the char to type doesn't match the string's
8573 first char, explicitly show what char to type. */
8574 if (! char_matches)
8575 {
8576 /* Add as much of string as fits. */
d5db4077 8577 thiswidth = SCHARS (desc);
af2b7cc9
KS
8578 if (thiswidth + i > width)
8579 thiswidth = width - i;
d5db4077 8580 bcopy (SDATA (desc), menu + i, thiswidth);
af2b7cc9
KS
8581 i += thiswidth;
8582 strcpy (menu + i, " = ");
8583 i += 3;
8584 }
8585
8586 /* Add as much of string as fits. */
d5db4077 8587 thiswidth = SCHARS (s);
af2b7cc9
KS
8588 if (thiswidth + i > width)
8589 thiswidth = width - i;
d5db4077 8590 bcopy (SDATA (s), menu + i, thiswidth);
af2b7cc9
KS
8591 i += thiswidth;
8592 menu[i] = 0;
8593 }
8594 else
8595 {
8596 /* If this element does not fit, end the line now,
8597 and save the element for the next line. */
8598 strcpy (menu + i, "...");
8599 break;
8600 }
8601 }
8602
8603 /* Move past this element. */
8604 if (idx >= 0 && idx + 1 >= XVECTOR (vector)->size)
8605 /* Handle reaching end of dense table. */
8606 idx = -1;
8607 if (idx >= 0)
8608 idx++;
8609 else
8610 rest = Fcdr_safe (rest);
8611 }
325309f5 8612 }
8150596a 8613
af2b7cc9 8614 /* Prompt with that and read response. */
c60ee5e7 8615 message2_nolog (menu, strlen (menu),
af2b7cc9 8616 ! NILP (current_buffer->enable_multibyte_characters));
284f4730 8617
af2b7cc9
KS
8618 /* Make believe its not a keyboard macro in case the help char
8619 is pressed. Help characters are not recorded because menu prompting
8620 is not used on replay.
8621 */
8622 orig_defn_macro = current_kboard->defining_kbd_macro;
8623 current_kboard->defining_kbd_macro = Qnil;
8624 do
179f689c 8625 obj = read_char (commandflag, 0, 0, Qt, 0, NULL);
af2b7cc9
KS
8626 while (BUFFERP (obj));
8627 current_kboard->defining_kbd_macro = orig_defn_macro;
284f4730 8628
af2b7cc9
KS
8629 if (!INTEGERP (obj))
8630 return obj;
8631 else
8632 ch = XINT (obj);
8633
8634 if (! EQ (obj, menu_prompt_more_char)
8635 && (!INTEGERP (menu_prompt_more_char)
8636 || ! EQ (obj, make_number (Ctl (XINT (menu_prompt_more_char))))))
8637 {
8638 if (!NILP (current_kboard->defining_kbd_macro))
8639 store_kbd_macro_char (obj);
8640 return obj;
8641 }
8642 /* Help char - go round again */
8643 }
284f4730 8644}
284f4730
JB
8645\f
8646/* Reading key sequences. */
8647
8648/* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8649 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8650 keymap, or nil otherwise. Return the index of the first keymap in
8651 which KEY has any binding, or NMAPS if no map has a binding.
8652
8653 If KEY is a meta ASCII character, treat it like meta-prefix-char
8654 followed by the corresponding non-meta character. Keymaps in
8655 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8656 NEXT.
8657
88cb0656
JB
8658 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8659 unmodified.
8660
569871d2 8661 NEXT may be the same array as CURRENT. */
284f4730
JB
8662
8663static int
4e50f26a 8664follow_key (key, nmaps, current, defs, next)
284f4730
JB
8665 Lisp_Object key;
8666 Lisp_Object *current, *defs, *next;
8667 int nmaps;
8668{
8669 int i, first_binding;
8670
284f4730
JB
8671 first_binding = nmaps;
8672 for (i = nmaps - 1; i >= 0; i--)
8673 {
8674 if (! NILP (current[i]))
8675 {
fe5b94c5 8676 defs[i] = access_keymap (current[i], key, 1, 0, 1);
284f4730
JB
8677 if (! NILP (defs[i]))
8678 first_binding = i;
8679 }
8680 else
8681 defs[i] = Qnil;
8682 }
8683
284f4730 8684 /* Given the set of bindings we've found, produce the next set of maps. */
0a7f1fc0
JB
8685 if (first_binding < nmaps)
8686 for (i = 0; i < nmaps; i++)
02067692 8687 next[i] = NILP (defs[i]) ? Qnil : get_keymap (defs[i], 0, 1);
284f4730
JB
8688
8689 return first_binding;
8690}
8691
a7f26f28
SM
8692/* Structure used to keep track of partial application of key remapping
8693 such as Vfunction_key_map and Vkey_translation_map. */
8694typedef struct keyremap
8695{
c2028ac6
RS
8696 /* This is the map originally specified for this use. */
8697 Lisp_Object parent;
8698 /* This is a submap reached by looking up, in PARENT,
8699 the events from START to END. */
8700 Lisp_Object map;
8701 /* Positions [START, END) in the key sequence buffer
8702 are the key that we have scanned so far.
8703 Those events are the ones that we will replace
8704 if PAREHT maps them into a key sequence. */
a7f26f28
SM
8705 int start, end;
8706} keyremap;
8707
fe5b94c5
SM
8708/* Lookup KEY in MAP.
8709 MAP is a keymap mapping keys to key vectors or functions.
8710 If the mapping is a function and DO_FUNCTION is non-zero, then
8711 the function is called with PROMPT as parameter and its return
8712 value is used as the return value of this function (after checking
8713 that it is indeed a vector). */
8714
8715static Lisp_Object
8716access_keymap_keyremap (map, key, prompt, do_funcall)
8717 Lisp_Object map, key, prompt;
8718 int do_funcall;
8719{
8720 Lisp_Object next;
2320865d 8721
fe5b94c5
SM
8722 next = access_keymap (map, key, 1, 0, 1);
8723
8724 /* Handle symbol with autoload definition. */
8725 if (SYMBOLP (next) && !NILP (Ffboundp (next))
8726 && CONSP (XSYMBOL (next)->function)
8727 && EQ (XCAR (XSYMBOL (next)->function), Qautoload))
8728 do_autoload (XSYMBOL (next)->function, next);
8729
8730 /* Handle a symbol whose function definition is a keymap
8731 or an array. */
8732 if (SYMBOLP (next) && !NILP (Ffboundp (next))
592c0e80 8733 && (ARRAYP (XSYMBOL (next)->function)
fe5b94c5
SM
8734 || KEYMAPP (XSYMBOL (next)->function)))
8735 next = XSYMBOL (next)->function;
2320865d 8736
fe5b94c5
SM
8737 /* If the keymap gives a function, not an
8738 array, then call the function with one arg and use
8739 its value instead. */
8740 if (SYMBOLP (next) && !NILP (Ffboundp (next)) && do_funcall)
8741 {
8742 Lisp_Object tem;
8743 tem = next;
8744
8745 next = call1 (next, prompt);
8746 /* If the function returned something invalid,
8747 barf--don't ignore it.
8748 (To ignore it safely, we would need to gcpro a bunch of
8749 other variables.) */
8750 if (! (VECTORP (next) || STRINGP (next)))
8751 error ("Function %s returns invalid key sequence", tem);
8752 }
8753 return next;
8754}
8755
8756/* Do one step of the key remapping used for function-key-map and
8757 key-translation-map:
8758 KEYBUF is the buffer holding the input events.
8759 BUFSIZE is its maximum size.
8760 FKEY is a pointer to the keyremap structure to use.
8761 INPUT is the index of the last element in KEYBUF.
8762 DOIT if non-zero says that the remapping can actually take place.
8763 DIFF is used to return the number of keys added/removed by the remapping.
8764 PARENT is the root of the keymap.
8765 PROMPT is the prompt to use if the remapping happens through a function.
8766 The return value is non-zero if the remapping actually took place. */
8767
8768static int
24d80a06
SM
8769keyremap_step (keybuf, bufsize, fkey, input, doit, diff, prompt)
8770 Lisp_Object *keybuf, prompt;
fe5b94c5
SM
8771 keyremap *fkey;
8772 int input, doit, *diff, bufsize;
8773{
8774 Lisp_Object next, key;
8775
8776 key = keybuf[fkey->end++];
c2028ac6
RS
8777
8778 if (KEYMAPP (fkey->parent))
8779 next = access_keymap_keyremap (fkey->map, key, prompt, doit);
8780 else
8781 next = Qnil;
fe5b94c5
SM
8782
8783 /* If keybuf[fkey->start..fkey->end] is bound in the
8784 map and we're in a position to do the key remapping, replace it with
8785 the binding and restart with fkey->start at the end. */
8786 if ((VECTORP (next) || STRINGP (next)) && doit)
8787 {
8788 int len = XFASTINT (Flength (next));
8789 int i;
8790
8791 *diff = len - (fkey->end - fkey->start);
8792
8793 if (input + *diff >= bufsize)
8794 error ("Key sequence too long");
8795
8796 /* Shift the keys that follow fkey->end. */
8797 if (*diff < 0)
8798 for (i = fkey->end; i < input; i++)
8799 keybuf[i + *diff] = keybuf[i];
8800 else if (*diff > 0)
8801 for (i = input - 1; i >= fkey->end; i--)
8802 keybuf[i + *diff] = keybuf[i];
8803 /* Overwrite the old keys with the new ones. */
8804 for (i = 0; i < len; i++)
8805 keybuf[fkey->start + i]
8806 = Faref (next, make_number (i));
8807
8808 fkey->start = fkey->end += *diff;
24d80a06 8809 fkey->map = fkey->parent;
fe5b94c5
SM
8810
8811 return 1;
8812 }
8813
8814 fkey->map = get_keymap (next, 0, 1);
8815
8816 /* If we no longer have a bound suffix, try a new position for
8817 fkey->start. */
8818 if (!CONSP (fkey->map))
8819 {
8820 fkey->end = ++fkey->start;
24d80a06 8821 fkey->map = fkey->parent;
fe5b94c5
SM
8822 }
8823 return 0;
8824}
a7f26f28 8825
df0f2ba1 8826/* Read a sequence of keys that ends with a non prefix character,
f4255cd1
JB
8827 storing it in KEYBUF, a buffer of size BUFSIZE.
8828 Prompt with PROMPT.
284f4730 8829 Return the length of the key sequence stored.
dcc408a0 8830 Return -1 if the user rejected a command menu.
284f4730 8831
f4255cd1
JB
8832 Echo starting immediately unless `prompt' is 0.
8833
8834 Where a key sequence ends depends on the currently active keymaps.
8835 These include any minor mode keymaps active in the current buffer,
8836 the current buffer's local map, and the global map.
8837
8838 If a key sequence has no other bindings, we check Vfunction_key_map
8839 to see if some trailing subsequence might be the beginning of a
8840 function key's sequence. If so, we try to read the whole function
8841 key, and substitute its symbolic name into the key sequence.
8842
fbcd35bd
JB
8843 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8844 `double-' events into similar click events, if that would make them
8845 bound. We try to turn `triple-' events first into `double-' events,
8846 then into clicks.
f4255cd1
JB
8847
8848 If we get a mouse click in a mode line, vertical divider, or other
8849 non-text area, we treat the click as if it were prefixed by the
8850 symbol denoting that area - `mode-line', `vertical-line', or
8851 whatever.
8852
8853 If the sequence starts with a mouse click, we read the key sequence
8854 with respect to the buffer clicked on, not the current buffer.
284f4730 8855
f4255cd1
JB
8856 If the user switches frames in the midst of a key sequence, we put
8857 off the switch-frame event until later; the next call to
f571ae0d
RS
8858 read_char will return it.
8859
8860 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8861 from the selected window's buffer. */
48e416d4 8862
284f4730 8863static int
ce98e608 8864read_key_sequence (keybuf, bufsize, prompt, dont_downcase_last,
f571ae0d 8865 can_return_switch_frame, fix_current_buffer)
284f4730
JB
8866 Lisp_Object *keybuf;
8867 int bufsize;
84d91fda 8868 Lisp_Object prompt;
309b0fc8 8869 int dont_downcase_last;
ce98e608 8870 int can_return_switch_frame;
f571ae0d 8871 int fix_current_buffer;
284f4730 8872{
db14cfc5 8873 volatile Lisp_Object from_string;
aed13378 8874 volatile int count = SPECPDL_INDEX ();
f4255cd1 8875
284f4730 8876 /* How many keys there are in the current key sequence. */
8c907a56 8877 volatile int t;
284f4730 8878
284f4730
JB
8879 /* The length of the echo buffer when we started reading, and
8880 the length of this_command_keys when we started reading. */
8c907a56
GM
8881 volatile int echo_start;
8882 volatile int keys_start;
284f4730
JB
8883
8884 /* The number of keymaps we're scanning right now, and the number of
8885 keymaps we have allocated space for. */
8c907a56
GM
8886 volatile int nmaps;
8887 volatile int nmaps_allocated = 0;
284f4730 8888
284f4730
JB
8889 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8890 the current keymaps. */
8c907a56 8891 Lisp_Object *volatile defs = NULL;
284f4730 8892
f4255cd1
JB
8893 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8894 in the current keymaps, or nil where it is not a prefix. */
8c907a56 8895 Lisp_Object *volatile submaps = NULL;
f4255cd1 8896
e0dff5f6 8897 /* The local map to start out with at start of key sequence. */
8c907a56 8898 volatile Lisp_Object orig_local_map;
e0dff5f6 8899
30690496
DL
8900 /* The map from the `keymap' property to start out with at start of
8901 key sequence. */
8c907a56 8902 volatile Lisp_Object orig_keymap;
30690496 8903
e0dff5f6
RS
8904 /* 1 if we have already considered switching to the local-map property
8905 of the place where a mouse click occurred. */
8c907a56 8906 volatile int localized_local_map = 0;
e0dff5f6 8907
9de5eb68 8908 /* The index in submaps[] of the first keymap that has a binding for
f4255cd1 8909 this key sequence. In other words, the lowest i such that
9de5eb68 8910 submaps[i] is non-nil. */
8c907a56 8911 volatile int first_binding;
7189cad8 8912 /* Index of the first key that has no binding.
a7f26f28 8913 It is useless to try fkey.start larger than that. */
7189cad8 8914 volatile int first_unbound;
284f4730 8915
f4255cd1 8916 /* If t < mock_input, then KEYBUF[t] should be read as the next
253598e4
JB
8917 input key.
8918
8919 We use this to recover after recognizing a function key. Once we
8920 realize that a suffix of the current key sequence is actually a
8921 function key's escape sequence, we replace the suffix with the
8922 function key's binding from Vfunction_key_map. Now keybuf
f4255cd1
JB
8923 contains a new and different key sequence, so the echo area,
8924 this_command_keys, and the submaps and defs arrays are wrong. In
8925 this situation, we set mock_input to t, set t to 0, and jump to
8926 restart_sequence; the loop will read keys from keybuf up until
8927 mock_input, thus rebuilding the state; and then it will resume
8928 reading characters from the keyboard. */
8c907a56 8929 volatile int mock_input = 0;
284f4730 8930
253598e4 8931 /* If the sequence is unbound in submaps[], then
a7f26f28
SM
8932 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8933 and fkey.map is its binding.
253598e4 8934
f4255cd1
JB
8935 These might be > t, indicating that all function key scanning
8936 should hold off until t reaches them. We do this when we've just
8937 recognized a function key, to avoid searching for the function
8938 key's again in Vfunction_key_map. */
a7f26f28 8939 volatile keyremap fkey;
284f4730 8940
a612e298 8941 /* Likewise, for key_translation_map. */
a7f26f28 8942 volatile keyremap keytran;
a612e298 8943
fe5b94c5
SM
8944 /* If we receive a `switch-frame' or `select-window' event in the middle of
8945 a key sequence, we put it off for later.
8946 While we're reading, we keep the event here. */
8c907a56 8947 volatile Lisp_Object delayed_switch_frame;
cd21b839 8948
51763820
BF
8949 /* See the comment below... */
8950#if defined (GOBBLE_FIRST_EVENT)
4efda7dd 8951 Lisp_Object first_event;
51763820 8952#endif
4efda7dd 8953
8c907a56
GM
8954 volatile Lisp_Object original_uppercase;
8955 volatile int original_uppercase_position = -1;
309b0fc8 8956
bc536d84 8957 /* Gets around Microsoft compiler limitations. */
309b0fc8 8958 int dummyflag = 0;
bc536d84 8959
3b9189f8
RS
8960 struct buffer *starting_buffer;
8961
2dc00208
GM
8962 /* List of events for which a fake prefix key has been generated. */
8963 volatile Lisp_Object fake_prefixed_keys = Qnil;
8964
03cee6ae 8965#if defined (GOBBLE_FIRST_EVENT)
4efda7dd 8966 int junk;
03cee6ae 8967#endif
4efda7dd 8968
2dc00208
GM
8969 struct gcpro gcpro1;
8970
8971 GCPRO1 (fake_prefixed_keys);
7d18f9ae
RS
8972 raw_keybuf_count = 0;
8973
4efda7dd
RS
8974 last_nonmenu_event = Qnil;
8975
8976 delayed_switch_frame = Qnil;
24d80a06
SM
8977 fkey.map = fkey.parent = Vfunction_key_map;
8978 keytran.map = keytran.parent = Vkey_translation_map;
c2028ac6
RS
8979 fkey.start = fkey.end = 0;
8980 keytran.start = keytran.end = 0;
a612e298 8981
284f4730
JB
8982 if (INTERACTIVE)
8983 {
84d91fda 8984 if (!NILP (prompt))
a4ef85ee 8985 echo_prompt (prompt);
f2647d04
DL
8986 else if (cursor_in_echo_area
8987 && (FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
8988 && NILP (Fzerop (Vecho_keystrokes)))
284f4730
JB
8989 /* This doesn't put in a dash if the echo buffer is empty, so
8990 you don't always see a dash hanging out in the minibuffer. */
8991 echo_dash ();
284f4730
JB
8992 }
8993
f4255cd1
JB
8994 /* Record the initial state of the echo area and this_command_keys;
8995 we will need to restore them if we replay a key sequence. */
0a7f1fc0 8996 if (INTERACTIVE)
df0f2ba1 8997 echo_start = echo_length ();
f4255cd1 8998 keys_start = this_command_key_count;
6321824f 8999 this_single_command_key_start = keys_start;
0a7f1fc0 9000
51763820
BF
9001#if defined (GOBBLE_FIRST_EVENT)
9002 /* This doesn't quite work, because some of the things that read_char
9003 does cannot safely be bypassed. It seems too risky to try to make
df0f2ba1 9004 this work right. */
51763820 9005
4efda7dd
RS
9006 /* Read the first char of the sequence specially, before setting
9007 up any keymaps, in case a filter runs and switches buffers on us. */
84d91fda 9008 first_event = read_char (NILP (prompt), 0, submaps, last_nonmenu_event,
179f689c 9009 &junk, NULL);
51763820 9010#endif /* GOBBLE_FIRST_EVENT */
4efda7dd 9011
24a40fbb
GM
9012 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
9013 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
db14cfc5 9014 from_string = Qnil;
e0dff5f6 9015
7b4aedb9
JB
9016 /* We jump here when the key sequence has been thoroughly changed, and
9017 we need to rescan it starting from the beginning. When we jump here,
9018 keybuf[0..mock_input] holds the sequence we should reread. */
07d2b8de 9019 replay_sequence:
7b4aedb9 9020
3b9189f8 9021 starting_buffer = current_buffer;
7189cad8 9022 first_unbound = bufsize + 1;
3b9189f8 9023
f4255cd1 9024 /* Build our list of keymaps.
07d2b8de
JB
9025 If we recognize a function key and replace its escape sequence in
9026 keybuf with its symbol, or if the sequence starts with a mouse
9027 click and we need to switch buffers, we jump back here to rebuild
9028 the initial keymaps from the current buffer. */
4cbedc16 9029 nmaps = 0;
284f4730 9030
4c0240d2 9031 if (!NILP (current_kboard->Voverriding_terminal_local_map))
4cbedc16 9032 {
4c0240d2 9033 if (2 > nmaps_allocated)
4cbedc16 9034 {
4c0240d2
RS
9035 submaps = (Lisp_Object *) alloca (2 * sizeof (submaps[0]));
9036 defs = (Lisp_Object *) alloca (2 * sizeof (defs[0]));
9037 nmaps_allocated = 2;
4cbedc16
RS
9038 }
9039 if (!NILP (current_kboard->Voverriding_terminal_local_map))
9040 submaps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
4c0240d2
RS
9041 }
9042 else if (!NILP (Voverriding_local_map))
9043 {
9044 if (2 > nmaps_allocated)
9045 {
9046 submaps = (Lisp_Object *) alloca (2 * sizeof (submaps[0]));
9047 defs = (Lisp_Object *) alloca (2 * sizeof (defs[0]));
9048 nmaps_allocated = 2;
9049 }
4cbedc16
RS
9050 if (!NILP (Voverriding_local_map))
9051 submaps[nmaps++] = Voverriding_local_map;
9052 }
9053 else
9054 {
4cbedc16
RS
9055 int nminor;
9056 int total;
9057 Lisp_Object *maps;
9058
9059 nminor = current_minor_maps (0, &maps);
9060 total = nminor + (!NILP (orig_keymap) ? 3 : 2);
9061
9062 if (total > nmaps_allocated)
9063 {
9064 submaps = (Lisp_Object *) alloca (total * sizeof (submaps[0]));
9065 defs = (Lisp_Object *) alloca (total * sizeof (defs[0]));
9066 nmaps_allocated = total;
9067 }
9068
9069 if (!NILP (orig_keymap))
9070 submaps[nmaps++] = orig_keymap;
9071
7d1c4866 9072 bcopy (maps, (void *) (submaps + nmaps),
4cbedc16
RS
9073 nminor * sizeof (submaps[0]));
9074
9075 nmaps += nminor;
9076
9077 submaps[nmaps++] = orig_local_map;
9078 }
9079 submaps[nmaps++] = current_global_map;
284f4730
JB
9080
9081 /* Find an accurate initial value for first_binding. */
9082 for (first_binding = 0; first_binding < nmaps; first_binding++)
253598e4 9083 if (! NILP (submaps[first_binding]))
284f4730
JB
9084 break;
9085
3b9189f8 9086 /* Start from the beginning in keybuf. */
f4255cd1
JB
9087 t = 0;
9088
9089 /* These are no-ops the first time through, but if we restart, they
9090 revert the echo area and this_command_keys to their original state. */
9091 this_command_key_count = keys_start;
df0f2ba1 9092 if (INTERACTIVE && t < mock_input)
f4255cd1
JB
9093 echo_truncate (echo_start);
9094
cca310da
JB
9095 /* If the best binding for the current key sequence is a keymap, or
9096 we may be looking at a function key's escape sequence, keep on
9097 reading. */
a7f26f28
SM
9098 while (first_binding < nmaps
9099 /* Keep reading as long as there's a prefix binding. */
9100 ? !NILP (submaps[first_binding])
e9bf89a0
RS
9101 /* Don't return in the middle of a possible function key sequence,
9102 if the only bindings we found were via case conversion.
9103 Thus, if ESC O a has a function-key-map translation
9104 and ESC o has a binding, don't return after ESC O,
9105 so that we can translate ESC O plus the next character. */
a7f26f28 9106 : (fkey.start < t || keytran.start < t))
284f4730
JB
9107 {
9108 Lisp_Object key;
7d6de002 9109 int used_mouse_menu = 0;
284f4730 9110
7b4aedb9
JB
9111 /* Where the last real key started. If we need to throw away a
9112 key that has expanded into more than one element of keybuf
9113 (say, a mouse click on the mode line which is being treated
9114 as [mode-line (mouse-...)], then we backtrack to this point
9115 of keybuf. */
8c907a56 9116 volatile int last_real_key_start;
7b4aedb9 9117
0a7f1fc0
JB
9118 /* These variables are analogous to echo_start and keys_start;
9119 while those allow us to restart the entire key sequence,
9120 echo_local_start and keys_local_start allow us to throw away
9121 just one key. */
8c907a56 9122 volatile int echo_local_start, keys_local_start, local_first_binding;
f4255cd1 9123
fe5b94c5
SM
9124 eassert (fkey.end == t || (fkey.end > t && fkey.end <= mock_input));
9125 eassert (fkey.start <= fkey.end);
9126 eassert (keytran.start <= keytran.end);
2cf4b7b2 9127 /* key-translation-map is applied *after* function-key-map. */
a7f26f28 9128 eassert (keytran.end <= fkey.start);
7189cad8 9129
a7f26f28 9130 if (first_unbound < fkey.start && first_unbound < keytran.start)
7189cad8
SM
9131 { /* The prefix upto first_unbound has no binding and has
9132 no translation left to do either, so we know it's unbound.
9133 If we don't stop now, we risk staying here indefinitely
9134 (if the user keeps entering fkey or keytran prefixes
9135 like C-c ESC ESC ESC ESC ...) */
9136 int i;
9137 for (i = first_unbound + 1; i < t; i++)
9138 keybuf[i - first_unbound - 1] = keybuf[i];
9139 mock_input = t - first_unbound - 1;
a7f26f28 9140 fkey.end = fkey.start -= first_unbound + 1;
24d80a06 9141 fkey.map = fkey.parent;
a7f26f28 9142 keytran.end = keytran.start -= first_unbound + 1;
24d80a06 9143 keytran.map = keytran.parent;
7189cad8
SM
9144 goto replay_sequence;
9145 }
9146
284f4730 9147 if (t >= bufsize)
3fe8e9a2 9148 error ("Key sequence too long");
284f4730 9149
f4255cd1
JB
9150 if (INTERACTIVE)
9151 echo_local_start = echo_length ();
9152 keys_local_start = this_command_key_count;
9153 local_first_binding = first_binding;
df0f2ba1 9154
f4255cd1 9155 replay_key:
0a7f1fc0 9156 /* These are no-ops, unless we throw away a keystroke below and
f4255cd1
JB
9157 jumped back up to replay_key; in that case, these restore the
9158 variables to their original state, allowing us to replay the
0a7f1fc0 9159 loop. */
40932d1a 9160 if (INTERACTIVE && t < mock_input)
f4255cd1 9161 echo_truncate (echo_local_start);
0a7f1fc0
JB
9162 this_command_key_count = keys_local_start;
9163 first_binding = local_first_binding;
9164
7e85b935
RS
9165 /* By default, assume each event is "real". */
9166 last_real_key_start = t;
9167
f4255cd1 9168 /* Does mock_input indicate that we are re-reading a key sequence? */
284f4730
JB
9169 if (t < mock_input)
9170 {
9171 key = keybuf[t];
9172 add_command_key (key);
f2647d04
DL
9173 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
9174 && NILP (Fzerop (Vecho_keystrokes)))
a98ea3f9 9175 echo_char (key);
284f4730 9176 }
253598e4
JB
9177
9178 /* If not, we should actually read a character. */
284f4730
JB
9179 else
9180 {
beecf6a1 9181 {
c5fdd383
KH
9182#ifdef MULTI_KBOARD
9183 KBOARD *interrupted_kboard = current_kboard;
788f89eb 9184 struct frame *interrupted_frame = SELECTED_FRAME ();
c5fdd383 9185 if (setjmp (wrong_kboard_jmpbuf))
beecf6a1 9186 {
5798cf15
KH
9187 if (!NILP (delayed_switch_frame))
9188 {
c5fdd383 9189 interrupted_kboard->kbd_queue
5798cf15 9190 = Fcons (delayed_switch_frame,
c5fdd383 9191 interrupted_kboard->kbd_queue);
5798cf15
KH
9192 delayed_switch_frame = Qnil;
9193 }
beecf6a1 9194 while (t > 0)
c5fdd383
KH
9195 interrupted_kboard->kbd_queue
9196 = Fcons (keybuf[--t], interrupted_kboard->kbd_queue);
5798cf15
KH
9197
9198 /* If the side queue is non-empty, ensure it begins with a
9199 switch-frame, so we'll replay it in the right context. */
c5fdd383 9200 if (CONSP (interrupted_kboard->kbd_queue)
7539e11f 9201 && (key = XCAR (interrupted_kboard->kbd_queue),
5798cf15
KH
9202 !(EVENT_HAS_PARAMETERS (key)
9203 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key)),
9204 Qswitch_frame))))
df0f2ba1
KH
9205 {
9206 Lisp_Object frame;
9207 XSETFRAME (frame, interrupted_frame);
c5fdd383 9208 interrupted_kboard->kbd_queue
df0f2ba1 9209 = Fcons (make_lispy_switch_frame (frame),
c5fdd383 9210 interrupted_kboard->kbd_queue);
df0f2ba1 9211 }
beecf6a1 9212 mock_input = 0;
24a40fbb
GM
9213 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
9214 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
beecf6a1
KH
9215 goto replay_sequence;
9216 }
bded54dd 9217#endif
8c907a56
GM
9218 key = read_char (NILP (prompt), nmaps,
9219 (Lisp_Object *) submaps, last_nonmenu_event,
179f689c 9220 &used_mouse_menu, NULL);
beecf6a1 9221 }
284f4730 9222
dcc408a0
RS
9223 /* read_char returns t when it shows a menu and the user rejects it.
9224 Just return -1. */
9225 if (EQ (key, Qt))
7d18f9ae
RS
9226 {
9227 unbind_to (count, Qnil);
2dc00208 9228 UNGCPRO;
7d18f9ae
RS
9229 return -1;
9230 }
dcc408a0 9231
f4255cd1 9232 /* read_char returns -1 at the end of a macro.
284f4730
JB
9233 Emacs 18 handles this by returning immediately with a
9234 zero, so that's what we'll do. */
8c18cbfb 9235 if (INTEGERP (key) && XINT (key) == -1)
cd21b839 9236 {
f4255cd1 9237 t = 0;
bc536d84
RS
9238 /* The Microsoft C compiler can't handle the goto that
9239 would go here. */
309b0fc8 9240 dummyflag = 1;
bc536d84 9241 break;
cd21b839 9242 }
df0f2ba1 9243
3cb81011
KH
9244 /* If the current buffer has been changed from under us, the
9245 keymap may have changed, so replay the sequence. */
8c18cbfb 9246 if (BUFFERP (key))
3cb81011 9247 {
5c12e63f 9248 timer_resume_idle ();
3021d3a9 9249
3cb81011 9250 mock_input = t;
f571ae0d
RS
9251 /* Reset the current buffer from the selected window
9252 in case something changed the former and not the latter.
9253 This is to be more consistent with the behavior
9254 of the command_loop_1. */
9255 if (fix_current_buffer)
a94a4335 9256 {
788f89eb 9257 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
a94a4335
KH
9258 Fkill_emacs (Qnil);
9259 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
9260 Fset_buffer (XWINDOW (selected_window)->buffer);
9261 }
f571ae0d 9262
24a40fbb
GM
9263 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
9264 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
3cb81011
KH
9265 goto replay_sequence;
9266 }
9267
3b9189f8
RS
9268 /* If we have a quit that was typed in another frame, and
9269 quit_throw_to_read_char switched buffers,
9270 replay to get the right keymap. */
f4e05d97
GM
9271 if (INTEGERP (key)
9272 && XINT (key) == quit_char
9273 && current_buffer != starting_buffer)
3b9189f8 9274 {
7d18f9ae
RS
9275 GROW_RAW_KEYBUF;
9276 XVECTOR (raw_keybuf)->contents[raw_keybuf_count++] = key;
3b9189f8
RS
9277 keybuf[t++] = key;
9278 mock_input = t;
9279 Vquit_flag = Qnil;
24a40fbb
GM
9280 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
9281 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
3b9189f8
RS
9282 goto replay_sequence;
9283 }
3cb81011 9284
284f4730 9285 Vquit_flag = Qnil;
7d18f9ae
RS
9286
9287 if (EVENT_HAS_PARAMETERS (key)
fe5b94c5 9288 /* Either a `switch-frame' or a `select-window' event. */
7d18f9ae
RS
9289 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key)), Qswitch_frame))
9290 {
9291 /* If we're at the beginning of a key sequence, and the caller
9292 says it's okay, go ahead and return this event. If we're
9293 in the midst of a key sequence, delay it until the end. */
9294 if (t > 0 || !can_return_switch_frame)
9295 {
9296 delayed_switch_frame = key;
9297 goto replay_key;
9298 }
9299 }
9300
9301 GROW_RAW_KEYBUF;
9302 XVECTOR (raw_keybuf)->contents[raw_keybuf_count++] = key;
7e85b935 9303 }
284f4730 9304
df0f2ba1 9305 /* Clicks in non-text areas get prefixed by the symbol
7e85b935
RS
9306 in their CHAR-ADDRESS field. For example, a click on
9307 the mode line is prefixed by the symbol `mode-line'.
9308
9309 Furthermore, key sequences beginning with mouse clicks
9310 are read using the keymaps of the buffer clicked on, not
9311 the current buffer. So we may have to switch the buffer
9312 here.
9313
9314 When we turn one event into two events, we must make sure
9315 that neither of the two looks like the original--so that,
9316 if we replay the events, they won't be expanded again.
9317 If not for this, such reexpansion could happen either here
9318 or when user programs play with this-command-keys. */
9319 if (EVENT_HAS_PARAMETERS (key))
9320 {
9b8eb840 9321 Lisp_Object kind;
45de137a 9322 Lisp_Object string;
cca310da 9323
9b8eb840 9324 kind = EVENT_HEAD_KIND (EVENT_HEAD (key));
7e85b935 9325 if (EQ (kind, Qmouse_click))
0a7f1fc0 9326 {
9b8eb840 9327 Lisp_Object window, posn;
f4255cd1 9328
9b8eb840 9329 window = POSN_WINDOW (EVENT_START (key));
eee5863b 9330 posn = POSN_POSN (EVENT_START (key));
7ee32cda 9331
2cf066c3
GM
9332 if (CONSP (posn)
9333 || (!NILP (fake_prefixed_keys)
9334 && !NILP (Fmemq (key, fake_prefixed_keys))))
0a7f1fc0 9335 {
2cf066c3
GM
9336 /* We're looking a second time at an event for which
9337 we generated a fake prefix key. Set
7e85b935
RS
9338 last_real_key_start appropriately. */
9339 if (t > 0)
9340 last_real_key_start = t - 1;
cd21b839 9341 }
7e85b935
RS
9342
9343 /* Key sequences beginning with mouse clicks are
9344 read using the keymaps in the buffer clicked on,
9345 not the current buffer. If we're at the
9346 beginning of a key sequence, switch buffers. */
9347 if (last_real_key_start == 0
8c18cbfb
KH
9348 && WINDOWP (window)
9349 && BUFFERP (XWINDOW (window)->buffer)
7e85b935 9350 && XBUFFER (XWINDOW (window)->buffer) != current_buffer)
cd21b839 9351 {
7d18f9ae 9352 XVECTOR (raw_keybuf)->contents[raw_keybuf_count++] = key;
7e85b935
RS
9353 keybuf[t] = key;
9354 mock_input = t + 1;
9355
9356 /* Arrange to go back to the original buffer once we're
9357 done reading the key sequence. Note that we can't
9358 use save_excursion_{save,restore} here, because they
9359 save point as well as the current buffer; we don't
9360 want to save point, because redisplay may change it,
9361 to accommodate a Fset_window_start or something. We
9362 don't want to do this at the top of the function,
9363 because we may get input from a subprocess which
9364 wants to change the selected window and stuff (say,
9365 emacsclient). */
9366 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
9367
788f89eb 9368 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
a94a4335 9369 Fkill_emacs (Qnil);
24a40fbb 9370 set_buffer_internal (XBUFFER (XWINDOW (window)->buffer));
30690496 9371 orig_local_map = get_local_map (PT, current_buffer,
24a40fbb
GM
9372 Qlocal_map);
9373 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
7e85b935 9374 goto replay_sequence;
0a7f1fc0 9375 }
c60ee5e7 9376
e0dff5f6
RS
9377 /* For a mouse click, get the local text-property keymap
9378 of the place clicked on, rather than point. */
7ee32cda 9379 if (last_real_key_start == 0
7539e11f 9380 && CONSP (XCDR (key))
e0dff5f6 9381 && ! localized_local_map)
5ec75a55 9382 {
e0dff5f6
RS
9383 Lisp_Object map_here, start, pos;
9384
9385 localized_local_map = 1;
9386 start = EVENT_START (key);
c60ee5e7 9387
eee5863b 9388 if (CONSP (start) && POSN_INBUFFER_P (start))
e0dff5f6
RS
9389 {
9390 pos = POSN_BUFFER_POSN (start);
b78ce8fb 9391 if (INTEGERP (pos)
602ae44c
CY
9392 && XINT (pos) >= BEGV
9393 && XINT (pos) <= ZV)
e0dff5f6 9394 {
30690496 9395 map_here = get_local_map (XINT (pos),
24a40fbb 9396 current_buffer, Qlocal_map);
e0dff5f6
RS
9397 if (!EQ (map_here, orig_local_map))
9398 {
9399 orig_local_map = map_here;
b74e16a3 9400 ++localized_local_map;
30690496 9401 }
b74e16a3 9402
30690496 9403 map_here = get_local_map (XINT (pos),
24a40fbb 9404 current_buffer, Qkeymap);
30690496
DL
9405 if (!EQ (map_here, orig_keymap))
9406 {
9407 orig_keymap = map_here;
b74e16a3
DK
9408 ++localized_local_map;
9409 }
9410
9411 if (localized_local_map > 1)
9412 {
30690496
DL
9413 keybuf[t] = key;
9414 mock_input = t + 1;
9415
e0dff5f6
RS
9416 goto replay_sequence;
9417 }
9418 }
9419 }
9420 }
9421
9422 /* Expand mode-line and scroll-bar events into two events:
9423 use posn as a fake prefix key. */
2dc00208
GM
9424 if (SYMBOLP (posn)
9425 && (NILP (fake_prefixed_keys)
9426 || NILP (Fmemq (key, fake_prefixed_keys))))
e0dff5f6 9427 {
7e85b935 9428 if (t + 1 >= bufsize)
3fe8e9a2 9429 error ("Key sequence too long");
c60ee5e7 9430
2dc00208
GM
9431 keybuf[t] = posn;
9432 keybuf[t + 1] = key;
9433 mock_input = t + 2;
9434
9435 /* Record that a fake prefix key has been generated
9436 for KEY. Don't modify the event; this would
9437 prevent proper action when the event is pushed
c7f4f573 9438 back into unread-command-events. */
2dc00208 9439 fake_prefixed_keys = Fcons (key, fake_prefixed_keys);
7ee32cda
GM
9440
9441 /* If on a mode line string with a local keymap,
9442 reconsider the key sequence with that keymap. */
45de137a
KS
9443 if (string = POSN_STRING (EVENT_START (key)),
9444 (CONSP (string) && STRINGP (XCAR (string))))
7ee32cda 9445 {
45de137a 9446 Lisp_Object pos, map, map2;
7ee32cda 9447
7ee32cda
GM
9448 pos = XCDR (string);
9449 string = XCAR (string);
52e386c2 9450 if (XINT (pos) >= 0
d5db4077 9451 && XINT (pos) < SCHARS (string))
30690496
DL
9452 {
9453 map = Fget_text_property (pos, Qlocal_map, string);
9454 if (!NILP (map))
9455 orig_local_map = map;
9456 map2 = Fget_text_property (pos, Qkeymap, string);
9457 if (!NILP (map2))
9458 orig_keymap = map2;
9459 if (!NILP (map) || !NILP (map2))
9460 goto replay_sequence;
9461 }
7ee32cda
GM
9462 }
9463
7e85b935 9464 goto replay_key;
5ec75a55 9465 }
45de137a
KS
9466 else if (NILP (from_string)
9467 && (string = POSN_STRING (EVENT_START (key)),
9468 (CONSP (string) && STRINGP (XCAR (string)))))
db14cfc5
GM
9469 {
9470 /* For a click on a string, i.e. overlay string or a
9471 string displayed via the `display' property,
9472 consider `local-map' and `keymap' properties of
9473 that string. */
45de137a 9474 Lisp_Object pos, map, map2;
db14cfc5 9475
db14cfc5
GM
9476 pos = XCDR (string);
9477 string = XCAR (string);
9478 if (XINT (pos) >= 0
d5db4077 9479 && XINT (pos) < SCHARS (string))
db14cfc5
GM
9480 {
9481 map = Fget_text_property (pos, Qlocal_map, string);
9482 if (!NILP (map))
9483 orig_local_map = map;
9484 map2 = Fget_text_property (pos, Qkeymap, string);
9485 if (!NILP (map2))
9486 orig_keymap = map2;
9487
9488 if (!NILP (map) || !NILP (map2))
9489 {
9490 from_string = string;
32949266
CY
9491 keybuf[t++] = key;
9492 mock_input = t;
db14cfc5
GM
9493 goto replay_sequence;
9494 }
9495 }
9496 }
0a7f1fc0 9497 }
7539e11f 9498 else if (CONSP (XCDR (key))
7a80a6f6 9499 && CONSP (EVENT_START (key))
7539e11f 9500 && CONSP (XCDR (EVENT_START (key))))
7e85b935 9501 {
9b8eb840 9502 Lisp_Object posn;
7e85b935 9503
eee5863b 9504 posn = POSN_POSN (EVENT_START (key));
7e85b935
RS
9505 /* Handle menu-bar events:
9506 insert the dummy prefix event `menu-bar'. */
9ea173e8 9507 if (EQ (posn, Qmenu_bar) || EQ (posn, Qtool_bar))
7e85b935
RS
9508 {
9509 if (t + 1 >= bufsize)
3fe8e9a2 9510 error ("Key sequence too long");
7e85b935
RS
9511 keybuf[t] = posn;
9512 keybuf[t+1] = key;
9513
9514 /* Zap the position in key, so we know that we've
9515 expanded it, and don't try to do so again. */
eee5863b
KS
9516 POSN_SET_POSN (EVENT_START (key),
9517 Fcons (posn, Qnil));
7e85b935
RS
9518
9519 mock_input = t + 2;
9520 goto replay_sequence;
9521 }
8c18cbfb 9522 else if (CONSP (posn))
7e85b935
RS
9523 {
9524 /* We're looking at the second event of a
9525 sequence which we expanded before. Set
9526 last_real_key_start appropriately. */
9527 if (last_real_key_start == t && t > 0)
9528 last_real_key_start = t - 1;
9529 }
a6d53864 9530 }
284f4730 9531 }
f4255cd1
JB
9532
9533 /* We have finally decided that KEY is something we might want
9534 to look up. */
284f4730
JB
9535 first_binding = (follow_key (key,
9536 nmaps - first_binding,
253598e4 9537 submaps + first_binding,
284f4730 9538 defs + first_binding,
4e50f26a 9539 submaps + first_binding)
284f4730 9540 + first_binding);
0a7f1fc0 9541
f4255cd1 9542 /* If KEY wasn't bound, we'll try some fallbacks. */
65e0fbbf
SM
9543 if (first_binding < nmaps)
9544 /* This is needed for the following scenario:
9545 event 0: a down-event that gets dropped by calling replay_key.
9546 event 1: some normal prefix like C-h.
a7f26f28
SM
9547 After event 0, first_unbound is 0, after event 1 fkey.start
9548 and keytran.start are both 1, so when we see that C-h is bound,
65e0fbbf
SM
9549 we need to update first_unbound. */
9550 first_unbound = max (t + 1, first_unbound);
9551 else
0a7f1fc0 9552 {
9b8eb840 9553 Lisp_Object head;
c60ee5e7 9554
a7f26f28 9555 /* Remember the position to put an upper bound on fkey.start. */
7189cad8 9556 first_unbound = min (t, first_unbound);
0a7f1fc0 9557
9b8eb840 9558 head = EVENT_HEAD (key);
24736fbc 9559 if (help_char_p (head) && t > 0)
7e85b935
RS
9560 {
9561 read_key_sequence_cmd = Vprefix_help_command;
9562 keybuf[t++] = key;
9563 last_nonmenu_event = key;
bc536d84
RS
9564 /* The Microsoft C compiler can't handle the goto that
9565 would go here. */
309b0fc8 9566 dummyflag = 1;
0d882d52 9567 break;
7e85b935
RS
9568 }
9569
8c18cbfb 9570 if (SYMBOLP (head))
0a7f1fc0 9571 {
9b8eb840
KH
9572 Lisp_Object breakdown;
9573 int modifiers;
0a7f1fc0 9574
9b8eb840 9575 breakdown = parse_modifiers (head);
7539e11f 9576 modifiers = XINT (XCAR (XCDR (breakdown)));
559f9d04
RS
9577 /* Attempt to reduce an unbound mouse event to a simpler
9578 event that is bound:
9579 Drags reduce to clicks.
9580 Double-clicks reduce to clicks.
9581 Triple-clicks reduce to double-clicks, then to clicks.
9582 Down-clicks are eliminated.
9583 Double-downs reduce to downs, then are eliminated.
9584 Triple-downs reduce to double-downs, then to downs,
9585 then are eliminated. */
9586 if (modifiers & (down_modifier | drag_modifier
9587 | double_modifier | triple_modifier))
0a7f1fc0 9588 {
559f9d04
RS
9589 while (modifiers & (down_modifier | drag_modifier
9590 | double_modifier | triple_modifier))
fbcd35bd
JB
9591 {
9592 Lisp_Object new_head, new_click;
9593 if (modifiers & triple_modifier)
9594 modifiers ^= (double_modifier | triple_modifier);
bc536d84
RS
9595 else if (modifiers & double_modifier)
9596 modifiers &= ~double_modifier;
9597 else if (modifiers & drag_modifier)
9598 modifiers &= ~drag_modifier;
559f9d04
RS
9599 else
9600 {
9601 /* Dispose of this `down' event by simply jumping
9602 back to replay_key, to get another event.
9603
9604 Note that if this event came from mock input,
9605 then just jumping back to replay_key will just
9606 hand it to us again. So we have to wipe out any
9607 mock input.
9608
9609 We could delete keybuf[t] and shift everything
9610 after that to the left by one spot, but we'd also
9611 have to fix up any variable that points into
9612 keybuf, and shifting isn't really necessary
9613 anyway.
9614
9615 Adding prefixes for non-textual mouse clicks
9616 creates two characters of mock input, and both
9617 must be thrown away. If we're only looking at
9618 the prefix now, we can just jump back to
9619 replay_key. On the other hand, if we've already
9620 processed the prefix, and now the actual click
9621 itself is giving us trouble, then we've lost the
9622 state of the keymaps we want to backtrack to, and
9623 we need to replay the whole sequence to rebuild
9624 it.
9625
9626 Beyond that, only function key expansion could
9627 create more than two keys, but that should never
9628 generate mouse events, so it's okay to zero
9629 mock_input in that case too.
9630
65e0fbbf
SM
9631 FIXME: The above paragraph seems just plain
9632 wrong, if you consider things like
9633 xterm-mouse-mode. -stef
9634
559f9d04 9635 Isn't this just the most wonderful code ever? */
017be6c7
SM
9636
9637 /* If mock_input > t + 1, the above simplification
9638 will actually end up dropping keys on the floor.
9639 This is probably OK for now, but even
9640 if mock_input <= t + 1, we need to adjust fkey
9641 and keytran.
9642 Typical case [header-line down-mouse-N]:
9643 mock_input = 2, t = 1, fkey.end = 1,
9644 last_real_key_start = 0. */
9645 if (fkey.end > last_real_key_start)
9646 {
9647 fkey.end = fkey.start
9648 = min (last_real_key_start, fkey.start);
9649 fkey.map = fkey.parent;
9650 if (keytran.end > last_real_key_start)
9651 {
9652 keytran.end = keytran.start
9653 = min (last_real_key_start, keytran.start);
9654 keytran.map = keytran.parent;
9655 }
9656 }
559f9d04
RS
9657 if (t == last_real_key_start)
9658 {
9659 mock_input = 0;
9660 goto replay_key;
9661 }
9662 else
9663 {
9664 mock_input = last_real_key_start;
9665 goto replay_sequence;
9666 }
9667 }
9668
27203ead 9669 new_head
7539e11f 9670 = apply_modifiers (modifiers, XCAR (breakdown));
27203ead
RS
9671 new_click
9672 = Fcons (new_head, Fcons (EVENT_START (key), Qnil));
fbcd35bd
JB
9673
9674 /* Look for a binding for this new key. follow_key
9675 promises that it didn't munge submaps the
9676 last time we called it, since key was unbound. */
27203ead
RS
9677 first_binding
9678 = (follow_key (new_click,
9679 nmaps - local_first_binding,
9680 submaps + local_first_binding,
9681 defs + local_first_binding,
4e50f26a 9682 submaps + local_first_binding)
27203ead 9683 + local_first_binding);
fbcd35bd
JB
9684
9685 /* If that click is bound, go for it. */
9686 if (first_binding < nmaps)
9687 {
9688 key = new_click;
9689 break;
9690 }
9691 /* Otherwise, we'll leave key set to the drag event. */
9692 }
0a7f1fc0
JB
9693 }
9694 }
9695 }
9696
284f4730 9697 keybuf[t++] = key;
7d6de002
RS
9698 /* Normally, last_nonmenu_event gets the previous key we read.
9699 But when a mouse popup menu is being used,
9700 we don't update last_nonmenu_event; it continues to hold the mouse
9701 event that preceded the first level of menu. */
9702 if (!used_mouse_menu)
9703 last_nonmenu_event = key;
284f4730 9704
6321824f
RS
9705 /* Record what part of this_command_keys is the current key sequence. */
9706 this_single_command_key_start = this_command_key_count - t;
9707
65e0fbbf
SM
9708 if (first_binding < nmaps && NILP (submaps[first_binding]))
9709 /* There is a binding and it's not a prefix.
9710 There is thus no function-key in this sequence.
9711 Moving fkey.start is important in this case to allow keytran.start
9712 to go over the sequence before we return (since we keep the
9713 invariant that keytran.end <= fkey.start). */
9714 {
a7f26f28 9715 if (fkey.start < t)
24d80a06 9716 (fkey.start = fkey.end = t, fkey.map = fkey.parent);
65e0fbbf
SM
9717 }
9718 else
9719 /* If the sequence is unbound, see if we can hang a function key
9720 off the end of it. */
fe5b94c5
SM
9721 /* Continue scan from fkey.end until we find a bound suffix. */
9722 while (fkey.end < t)
a612e298 9723 {
fe5b94c5
SM
9724 struct gcpro gcpro1, gcpro2, gcpro3;
9725 int done, diff;
9726
9727 GCPRO3 (fkey.map, keytran.map, delayed_switch_frame);
9728 done = keyremap_step (keybuf, bufsize, &fkey,
9729 max (t, mock_input),
9730 /* If there's a binding (i.e.
9731 first_binding >= nmaps) we don't want
9732 to apply this function-key-mapping. */
9733 fkey.end + 1 == t && first_binding >= nmaps,
24d80a06 9734 &diff, prompt);
fe5b94c5
SM
9735 UNGCPRO;
9736 if (done)
a612e298 9737 {
fe5b94c5 9738 mock_input = diff + max (t, mock_input);
a612e298
RS
9739 goto replay_sequence;
9740 }
fe5b94c5 9741 }
a612e298 9742
fe5b94c5
SM
9743 /* Look for this sequence in key-translation-map.
9744 Scan from keytran.end until we find a bound suffix. */
9745 while (keytran.end < fkey.start)
9746 {
9747 struct gcpro gcpro1, gcpro2, gcpro3;
9748 int done, diff;
a612e298 9749
fe5b94c5
SM
9750 GCPRO3 (fkey.map, keytran.map, delayed_switch_frame);
9751 done = keyremap_step (keybuf, bufsize, &keytran, max (t, mock_input),
24d80a06 9752 1, &diff, prompt);
fe5b94c5
SM
9753 UNGCPRO;
9754 if (done)
9755 {
9756 mock_input = diff + max (t, mock_input);
9757 /* Adjust the function-key-map counters. */
9758 fkey.end += diff;
9759 fkey.start += diff;
2320865d 9760
fe5b94c5
SM
9761 goto replay_sequence;
9762 }
9763 }
4e50f26a
RS
9764
9765 /* If KEY is not defined in any of the keymaps,
9766 and cannot be part of a function key or translation,
9767 and is an upper case letter
9768 use the corresponding lower-case letter instead. */
65e0fbbf 9769 if (first_binding >= nmaps
a7f26f28 9770 && fkey.start >= t && keytran.start >= t
8c18cbfb 9771 && INTEGERP (key)
4e50f26a 9772 && ((((XINT (key) & 0x3ffff)
301738ed 9773 < XCHAR_TABLE (current_buffer->downcase_table)->size)
4e50f26a
RS
9774 && UPPERCASEP (XINT (key) & 0x3ffff))
9775 || (XINT (key) & shift_modifier)))
9776 {
569871d2 9777 Lisp_Object new_key;
569871d2 9778
309b0fc8
RS
9779 original_uppercase = key;
9780 original_uppercase_position = t - 1;
9781
831f35a2 9782 if (XINT (key) & shift_modifier)
569871d2 9783 XSETINT (new_key, XINT (key) & ~shift_modifier);
4e50f26a 9784 else
569871d2
RS
9785 XSETINT (new_key, (DOWNCASE (XINT (key) & 0x3ffff)
9786 | (XINT (key) & ~0x3ffff)));
9787
3fe8e9a2
RS
9788 /* We have to do this unconditionally, regardless of whether
9789 the lower-case char is defined in the keymaps, because they
9790 might get translated through function-key-map. */
9791 keybuf[t - 1] = new_key;
2cf4b7b2 9792 mock_input = max (t, mock_input);
3fe8e9a2
RS
9793
9794 goto replay_sequence;
4e50f26a 9795 }
ef8fd672
RS
9796 /* If KEY is not defined in any of the keymaps,
9797 and cannot be part of a function key or translation,
9798 and is a shifted function key,
9799 use the corresponding unshifted function key instead. */
65e0fbbf 9800 if (first_binding >= nmaps
a7f26f28 9801 && fkey.start >= t && keytran.start >= t
ef8fd672
RS
9802 && SYMBOLP (key))
9803 {
9804 Lisp_Object breakdown;
9805 int modifiers;
9806
9807 breakdown = parse_modifiers (key);
7539e11f 9808 modifiers = XINT (XCAR (XCDR (breakdown)));
ef8fd672
RS
9809 if (modifiers & shift_modifier)
9810 {
569871d2 9811 Lisp_Object new_key;
3fe8e9a2
RS
9812
9813 original_uppercase = key;
9814 original_uppercase_position = t - 1;
ef8fd672 9815
569871d2
RS
9816 modifiers &= ~shift_modifier;
9817 new_key = apply_modifiers (modifiers,
7539e11f 9818 XCAR (breakdown));
569871d2 9819
3fe8e9a2 9820 keybuf[t - 1] = new_key;
2cf4b7b2 9821 mock_input = max (t, mock_input);
c2028ac6
RS
9822 fkey.start = fkey.end = 0;
9823 keytran.start = keytran.end = 0;
3fe8e9a2
RS
9824
9825 goto replay_sequence;
ef8fd672
RS
9826 }
9827 }
284f4730
JB
9828 }
9829
309b0fc8 9830 if (!dummyflag)
bc536d84
RS
9831 read_key_sequence_cmd = (first_binding < nmaps
9832 ? defs[first_binding]
9833 : Qnil);
284f4730 9834
cd21b839 9835 unread_switch_frame = delayed_switch_frame;
f4255cd1 9836 unbind_to (count, Qnil);
07f76a14 9837
3fe8e9a2
RS
9838 /* Don't downcase the last character if the caller says don't.
9839 Don't downcase it if the result is undefined, either. */
9840 if ((dont_downcase_last || first_binding >= nmaps)
a53fe666 9841 && t > 0
3fe8e9a2 9842 && t - 1 == original_uppercase_position)
309b0fc8
RS
9843 keybuf[t - 1] = original_uppercase;
9844
07f76a14
JB
9845 /* Occasionally we fabricate events, perhaps by expanding something
9846 according to function-key-map, or by adding a prefix symbol to a
9847 mouse click in the scroll bar or modeline. In this cases, return
9848 the entire generated key sequence, even if we hit an unbound
9849 prefix or a definition before the end. This means that you will
9850 be able to push back the event properly, and also means that
9851 read-key-sequence will always return a logical unit.
9852
9853 Better ideas? */
cca310da
JB
9854 for (; t < mock_input; t++)
9855 {
f2647d04
DL
9856 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
9857 && NILP (Fzerop (Vecho_keystrokes)))
a98ea3f9 9858 echo_char (keybuf[t]);
cca310da
JB
9859 add_command_key (keybuf[t]);
9860 }
07f76a14 9861
c60ee5e7 9862
7d18f9ae 9863
2dc00208 9864 UNGCPRO;
284f4730
JB
9865 return t;
9866}
9867
d5eecefb 9868DEFUN ("read-key-sequence", Fread_key_sequence, Sread_key_sequence, 1, 5, 0,
4707d2d0
PJ
9869 doc: /* Read a sequence of keystrokes and return as a string or vector.
9870The sequence is sufficient to specify a non-prefix command in the
9871current local and global maps.
9872
9873First arg PROMPT is a prompt string. If nil, do not prompt specially.
9874Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9875as a continuation of the previous key.
9876
9877The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9878convert the last event to lower case. (Normally any upper case event
9879is converted to lower case if the original event is undefined and the lower
9880case equivalent is defined.) A non-nil value is appropriate for reading
9881a key sequence to be defined.
9882
9883A C-g typed while in this function is treated like any other character,
9884and `quit-flag' is not set.
9885
9886If the key sequence starts with a mouse click, then the sequence is read
9887using the keymaps of the buffer of the window clicked in, not the buffer
9888of the selected window as normal.
9889
9890`read-key-sequence' drops unbound button-down events, since you normally
9891only care about the click or drag events which follow them. If a drag
9892or multi-click event is unbound, but the corresponding click event would
9893be bound, `read-key-sequence' turns the event into a click event at the
9894drag's starting position. This means that you don't have to distinguish
9895between click and drag, double, or triple events unless you want to.
9896
9897`read-key-sequence' prefixes mouse events on mode lines, the vertical
9898lines separating windows, and scroll bars with imaginary keys
9899`mode-line', `vertical-line', and `vertical-scroll-bar'.
9900
9901Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9902function will process a switch-frame event if the user switches frames
9903before typing anything. If the user switches frames in the middle of a
9904key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9905is nil, then the event will be put off until after the current key sequence.
9906
9907`read-key-sequence' checks `function-key-map' for function key
9908sequences, where they wouldn't conflict with ordinary bindings. See
9909`function-key-map' for more details.
9910
9911The optional fifth argument COMMAND-LOOP, if non-nil, means
9912that this key sequence is being read by something that will
9913read commands one after another. It should be nil if the caller
9914will read just one key sequence. */)
d5eecefb
RS
9915 (prompt, continue_echo, dont_downcase_last, can_return_switch_frame,
9916 command_loop)
309b0fc8 9917 Lisp_Object prompt, continue_echo, dont_downcase_last;
d5eecefb 9918 Lisp_Object can_return_switch_frame, command_loop;
284f4730
JB
9919{
9920 Lisp_Object keybuf[30];
9921 register int i;
03cee6ae 9922 struct gcpro gcpro1;
aed13378 9923 int count = SPECPDL_INDEX ();
284f4730
JB
9924
9925 if (!NILP (prompt))
b7826503 9926 CHECK_STRING (prompt);
284f4730
JB
9927 QUIT;
9928
d5eecefb
RS
9929 specbind (Qinput_method_exit_on_first_char,
9930 (NILP (command_loop) ? Qt : Qnil));
9931 specbind (Qinput_method_use_echo_area,
9932 (NILP (command_loop) ? Qt : Qnil));
9933
284f4730
JB
9934 bzero (keybuf, sizeof keybuf);
9935 GCPRO1 (keybuf[0]);
9936 gcpro1.nvars = (sizeof keybuf/sizeof (keybuf[0]));
9937
daa37602 9938 if (NILP (continue_echo))
6321824f
RS
9939 {
9940 this_command_key_count = 0;
63020c46 9941 this_command_key_count_reset = 0;
6321824f
RS
9942 this_single_command_key_start = 0;
9943 }
c0a58692 9944
d0c48478 9945#ifdef HAVE_X_WINDOWS
526a058f
GM
9946 if (display_hourglass_p)
9947 cancel_hourglass ();
d0c48478
GM
9948#endif
9949
309b0fc8 9950 i = read_key_sequence (keybuf, (sizeof keybuf/sizeof (keybuf[0])),
ce98e608 9951 prompt, ! NILP (dont_downcase_last),
f571ae0d 9952 ! NILP (can_return_switch_frame), 0);
284f4730 9953
ae18aa3b 9954#if 0 /* The following is fine for code reading a key sequence and
f95c4fe5 9955 then proceeding with a lenghty computation, but it's not good
ae18aa3b 9956 for code reading keys in a loop, like an input method. */
d0c48478 9957#ifdef HAVE_X_WINDOWS
526a058f
GM
9958 if (display_hourglass_p)
9959 start_hourglass ();
ae18aa3b 9960#endif
d0c48478
GM
9961#endif
9962
dcc408a0
RS
9963 if (i == -1)
9964 {
9965 Vquit_flag = Qt;
9966 QUIT;
9967 }
284f4730 9968 UNGCPRO;
d5eecefb 9969 return unbind_to (count, make_event_array (i, keybuf));
284f4730 9970}
e39da3d7
RS
9971
9972DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector,
d5eecefb 9973 Sread_key_sequence_vector, 1, 5, 0,
4707d2d0
PJ
9974 doc: /* Like `read-key-sequence' but always return a vector. */)
9975 (prompt, continue_echo, dont_downcase_last, can_return_switch_frame,
9976 command_loop)
e39da3d7 9977 Lisp_Object prompt, continue_echo, dont_downcase_last;
d5eecefb 9978 Lisp_Object can_return_switch_frame, command_loop;
e39da3d7
RS
9979{
9980 Lisp_Object keybuf[30];
9981 register int i;
03cee6ae 9982 struct gcpro gcpro1;
aed13378 9983 int count = SPECPDL_INDEX ();
e39da3d7
RS
9984
9985 if (!NILP (prompt))
b7826503 9986 CHECK_STRING (prompt);
e39da3d7
RS
9987 QUIT;
9988
d5eecefb
RS
9989 specbind (Qinput_method_exit_on_first_char,
9990 (NILP (command_loop) ? Qt : Qnil));
9991 specbind (Qinput_method_use_echo_area,
9992 (NILP (command_loop) ? Qt : Qnil));
9993
e39da3d7
RS
9994 bzero (keybuf, sizeof keybuf);
9995 GCPRO1 (keybuf[0]);
9996 gcpro1.nvars = (sizeof keybuf/sizeof (keybuf[0]));
9997
9998 if (NILP (continue_echo))
9999 {
10000 this_command_key_count = 0;
63020c46 10001 this_command_key_count_reset = 0;
e39da3d7
RS
10002 this_single_command_key_start = 0;
10003 }
10004
d0c48478 10005#ifdef HAVE_X_WINDOWS
526a058f
GM
10006 if (display_hourglass_p)
10007 cancel_hourglass ();
d0c48478
GM
10008#endif
10009
e39da3d7
RS
10010 i = read_key_sequence (keybuf, (sizeof keybuf/sizeof (keybuf[0])),
10011 prompt, ! NILP (dont_downcase_last),
10012 ! NILP (can_return_switch_frame), 0);
10013
d0c48478 10014#ifdef HAVE_X_WINDOWS
526a058f
GM
10015 if (display_hourglass_p)
10016 start_hourglass ();
d0c48478
GM
10017#endif
10018
e39da3d7
RS
10019 if (i == -1)
10020 {
10021 Vquit_flag = Qt;
10022 QUIT;
10023 }
10024 UNGCPRO;
d5eecefb 10025 return unbind_to (count, Fvector (i, keybuf));
e39da3d7 10026}
284f4730 10027\f
158f7532 10028DEFUN ("command-execute", Fcommand_execute, Scommand_execute, 1, 4, 0,
4707d2d0
PJ
10029 doc: /* Execute CMD as an editor command.
10030CMD must be a symbol that satisfies the `commandp' predicate.
10031Optional second arg RECORD-FLAG non-nil
10032means unconditionally put this command in `command-history'.
10033Otherwise, that is done only if an arg is read using the minibuffer.
10034The argument KEYS specifies the value to use instead of (this-command-keys)
10035when reading the arguments; if it is nil, (this-command-keys) is used.
10036The argument SPECIAL, if non-nil, means that this command is executing
10037a special event, so ignore the prefix argument and don't clear it. */)
158f7532
RS
10038 (cmd, record_flag, keys, special)
10039 Lisp_Object cmd, record_flag, keys, special;
284f4730
JB
10040{
10041 register Lisp_Object final;
10042 register Lisp_Object tem;
10043 Lisp_Object prefixarg;
10044 struct backtrace backtrace;
10045 extern int debug_on_next_call;
10046
284f4730
JB
10047 debug_on_next_call = 0;
10048
158f7532
RS
10049 if (NILP (special))
10050 {
10051 prefixarg = current_kboard->Vprefix_arg;
10052 Vcurrent_prefix_arg = prefixarg;
10053 current_kboard->Vprefix_arg = Qnil;
10054 }
10055 else
10056 prefixarg = Qnil;
10057
8c18cbfb 10058 if (SYMBOLP (cmd))
284f4730
JB
10059 {
10060 tem = Fget (cmd, Qdisabled);
88ce066e 10061 if (!NILP (tem) && !NILP (Vrun_hooks))
b78ce8fb 10062 {
971e4c98 10063 tem = Fsymbol_value (Qdisabled_command_function);
b78ce8fb 10064 if (!NILP (tem))
971e4c98 10065 return call1 (Vrun_hooks, Qdisabled_command_function);
b78ce8fb 10066 }
284f4730
JB
10067 }
10068
01e26217 10069 while (1)
284f4730 10070 {
a7f96a35 10071 final = Findirect_function (cmd, Qnil);
284f4730
JB
10072
10073 if (CONSP (final) && (tem = Fcar (final), EQ (tem, Qautoload)))
b516a185
RS
10074 {
10075 struct gcpro gcpro1, gcpro2;
10076
10077 GCPRO2 (cmd, prefixarg);
10078 do_autoload (final, cmd);
10079 UNGCPRO;
10080 }
284f4730
JB
10081 else
10082 break;
10083 }
10084
8c18cbfb 10085 if (STRINGP (final) || VECTORP (final))
284f4730
JB
10086 {
10087 /* If requested, place the macro in the command history. For
10088 other sorts of commands, call-interactively takes care of
10089 this. */
e57d8fd8 10090 if (!NILP (record_flag))
f4385381
RS
10091 {
10092 Vcommand_history
10093 = Fcons (Fcons (Qexecute_kbd_macro,
10094 Fcons (final, Fcons (prefixarg, Qnil))),
10095 Vcommand_history);
10096
10097 /* Don't keep command history around forever. */
10098 if (NUMBERP (Vhistory_length) && XINT (Vhistory_length) > 0)
10099 {
10100 tem = Fnthcdr (Vhistory_length, Vcommand_history);
10101 if (CONSP (tem))
f3fbd155 10102 XSETCDR (tem, Qnil);
f4385381
RS
10103 }
10104 }
284f4730 10105
caa06051 10106 return Fexecute_kbd_macro (final, prefixarg, Qnil);
284f4730 10107 }
f4385381 10108
8c18cbfb 10109 if (CONSP (final) || SUBRP (final) || COMPILEDP (final))
284f4730
JB
10110 {
10111 backtrace.next = backtrace_list;
10112 backtrace_list = &backtrace;
10113 backtrace.function = &Qcall_interactively;
10114 backtrace.args = &cmd;
10115 backtrace.nargs = 1;
10116 backtrace.evalargs = 0;
080e18b1 10117 backtrace.debug_on_exit = 0;
284f4730 10118
e57d8fd8 10119 tem = Fcall_interactively (cmd, record_flag, keys);
284f4730
JB
10120
10121 backtrace_list = backtrace.next;
10122 return tem;
10123 }
10124 return Qnil;
10125}
c970a760
GM
10126
10127
284f4730 10128\f
284f4730 10129DEFUN ("execute-extended-command", Fexecute_extended_command, Sexecute_extended_command,
4707d2d0 10130 1, 1, "P",
dfb4bff5
EZ
10131 doc: /* Read function name, then read its arguments and call it.
10132
10133To pass a numeric argument to the command you are invoking with, specify
10134the numeric argument to this command.
10135
10136Noninteractively, the argument PREFIXARG is the prefix argument to
10137give to the command you invoke, if it asks for an argument. */)
4707d2d0 10138 (prefixarg)
284f4730
JB
10139 Lisp_Object prefixarg;
10140{
10141 Lisp_Object function;
10142 char buf[40];
2e1a49ad
SM
10143 int saved_last_point_position;
10144 Lisp_Object saved_keys, saved_last_point_position_buffer;
5434fce6 10145 Lisp_Object bindings, value;
2e1a49ad 10146 struct gcpro gcpro1, gcpro2, gcpro3;
a25e44b2
JD
10147#ifdef HAVE_X_WINDOWS
10148 /* The call to Fcompleting_read wil start and cancel the hourglass,
10149 but if the hourglass was already scheduled, this means that no
10150 hourglass will be shown for the actual M-x command itself.
10151 So we restart it if it is already scheduled. Note that checking
10152 hourglass_shown_p is not enough, normally the hourglass is not shown,
10153 just scheduled to be shown. */
10154 int hstarted = hourglass_started ();
10155#endif
284f4730 10156
b0f2a7bf
KH
10157 saved_keys = Fvector (this_command_key_count,
10158 XVECTOR (this_command_keys)->contents);
2e1a49ad
SM
10159 saved_last_point_position_buffer = last_point_position_buffer;
10160 saved_last_point_position = last_point_position;
284f4730 10161 buf[0] = 0;
2e1a49ad 10162 GCPRO3 (saved_keys, prefixarg, saved_last_point_position_buffer);
284f4730
JB
10163
10164 if (EQ (prefixarg, Qminus))
10165 strcpy (buf, "- ");
7539e11f 10166 else if (CONSP (prefixarg) && XINT (XCAR (prefixarg)) == 4)
284f4730 10167 strcpy (buf, "C-u ");
7539e11f 10168 else if (CONSP (prefixarg) && INTEGERP (XCAR (prefixarg)))
cea5d0d4 10169 sprintf (buf, "%ld ", (long) XINT (XCAR (prefixarg)));
8c18cbfb 10170 else if (INTEGERP (prefixarg))
cea5d0d4 10171 sprintf (buf, "%ld ", (long) XINT (prefixarg));
284f4730
JB
10172
10173 /* This isn't strictly correct if execute-extended-command
10174 is bound to anything else. Perhaps it should use
10175 this_command_keys? */
10176 strcat (buf, "M-x ");
10177
10178 /* Prompt with buf, and then read a string, completing from and
10179 restricting to the set of all defined commands. Don't provide
51763820 10180 any initial input. Save the command read on the extended-command
03b4122a 10181 history list. */
284f4730
JB
10182 function = Fcompleting_read (build_string (buf),
10183 Vobarray, Qcommandp,
4328577a
KH
10184 Qt, Qnil, Qextended_command_history, Qnil,
10185 Qnil);
284f4730 10186
a25e44b2
JD
10187#ifdef HAVE_X_WINDOWS
10188 if (hstarted) start_hourglass ();
10189#endif
10190
d5db4077 10191 if (STRINGP (function) && SCHARS (function) == 0)
1f5b1641
RS
10192 error ("No command name given");
10193
1113d9db
JB
10194 /* Set this_command_keys to the concatenation of saved_keys and
10195 function, followed by a RET. */
284f4730 10196 {
b0f2a7bf 10197 Lisp_Object *keys;
284f4730 10198 int i;
284f4730 10199
1113d9db 10200 this_command_key_count = 0;
63020c46 10201 this_command_key_count_reset = 0;
6321824f 10202 this_single_command_key_start = 0;
1113d9db 10203
b0f2a7bf
KH
10204 keys = XVECTOR (saved_keys)->contents;
10205 for (i = 0; i < XVECTOR (saved_keys)->size; i++)
10206 add_command_key (keys[i]);
1113d9db 10207
1b049b51 10208 for (i = 0; i < SCHARS (function); i++)
301738ed 10209 add_command_key (Faref (function, make_number (i)));
1113d9db 10210
301738ed 10211 add_command_key (make_number ('\015'));
284f4730
JB
10212 }
10213
2e1a49ad
SM
10214 last_point_position = saved_last_point_position;
10215 last_point_position_buffer = saved_last_point_position_buffer;
10216
284f4730
JB
10217 UNGCPRO;
10218
0a7f1fc0 10219 function = Fintern (function, Qnil);
d8bcf58e 10220 current_kboard->Vprefix_arg = prefixarg;
d5eecefb
RS
10221 Vthis_command = function;
10222 real_this_command = function;
284f4730 10223
6526ab49
RS
10224 /* If enabled, show which key runs this command. */
10225 if (!NILP (Vsuggest_key_bindings)
ce0d2858 10226 && NILP (Vexecuting_kbd_macro)
6526ab49 10227 && SYMBOLP (function))
5434fce6 10228 bindings = Fwhere_is_internal (function, Voverriding_local_map,
8b9940e6 10229 Qt, Qnil, Qnil);
5434fce6
RS
10230 else
10231 bindings = Qnil;
6526ab49 10232
5434fce6
RS
10233 value = Qnil;
10234 GCPRO2 (bindings, value);
10235 value = Fcommand_execute (function, Qt, Qnil, Qnil);
6526ab49 10236
5434fce6 10237 /* If the command has a key binding, print it now. */
3ababa60 10238 if (!NILP (bindings)
ee112567
KH
10239 && ! (VECTORP (bindings) && EQ (Faref (bindings, make_number (0)),
10240 Qmouse_movement)))
5434fce6
RS
10241 {
10242 /* But first wait, and skip the message if there is input. */
7ba07a1a
CY
10243 Lisp_Object waited;
10244
666dc232
KS
10245 /* If this command displayed something in the echo area;
10246 wait a few seconds, then display our suggestion message. */
10247 if (NILP (echo_area_buffer[0]))
10248 waited = sit_for (make_number (0), 0, 2);
10249 else if (NUMBERP (Vsuggest_key_bindings))
2bcac766 10250 waited = sit_for (Vsuggest_key_bindings, 0, 2);
426939cc 10251 else
666dc232 10252 waited = sit_for (make_number (2), 0, 2);
426939cc 10253
7ba07a1a 10254 if (!NILP (waited) && ! CONSP (Vunread_command_events))
6526ab49 10255 {
5434fce6
RS
10256 Lisp_Object binding;
10257 char *newmessage;
985f9f66 10258 int message_p = push_message ();
331379bf 10259 int count = SPECPDL_INDEX ();
5434fce6 10260
65efd7da 10261 record_unwind_protect (pop_message_unwind, Qnil);
a1bfe073 10262 binding = Fkey_description (bindings, Qnil);
5434fce6
RS
10263
10264 newmessage
d5db4077
KR
10265 = (char *) alloca (SCHARS (SYMBOL_NAME (function))
10266 + SBYTES (binding)
5434fce6 10267 + 100);
3ababa60 10268 sprintf (newmessage, "You can run the command `%s' with %s",
d5db4077
KR
10269 SDATA (SYMBOL_NAME (function)),
10270 SDATA (binding));
301738ed
RS
10271 message2_nolog (newmessage,
10272 strlen (newmessage),
10273 STRING_MULTIBYTE (binding));
7ba07a1a 10274 if (NUMBERP (Vsuggest_key_bindings))
666dc232 10275 waited = sit_for (Vsuggest_key_bindings, 0, 2);
7ba07a1a 10276 else
666dc232 10277 waited = sit_for (make_number (2), 0, 2);
7ba07a1a
CY
10278
10279 if (!NILP (waited) && message_p)
985f9f66
GM
10280 restore_message ();
10281
c970a760 10282 unbind_to (count, Qnil);
6526ab49
RS
10283 }
10284 }
10285
5434fce6 10286 RETURN_UNGCPRO (value);
284f4730 10287}
6526ab49 10288
284f4730 10289\f
d9d4c147 10290/* Return nonzero if input events are pending. */
284f4730 10291
dfcf069d 10292int
284f4730
JB
10293detect_input_pending ()
10294{
10295 if (!input_pending)
d9d4c147
KH
10296 get_input_pending (&input_pending, 0);
10297
10298 return input_pending;
10299}
10300
a2d5fca0
JD
10301/* Return nonzero if input events other than mouse movements are
10302 pending. */
10303
10304int
10305detect_input_pending_ignore_squeezables ()
10306{
10307 if (!input_pending)
10308 get_input_pending (&input_pending, READABLE_EVENTS_IGNORE_SQUEEZABLES);
10309
10310 return input_pending;
10311}
10312
b1878f45 10313/* Return nonzero if input events are pending, and run any pending timers. */
d9d4c147 10314
dfcf069d 10315int
87dd9b9b
RS
10316detect_input_pending_run_timers (do_display)
10317 int do_display;
d9d4c147 10318{
87dd9b9b
RS
10319 int old_timers_run = timers_run;
10320
d9d4c147 10321 if (!input_pending)
a2d5fca0 10322 get_input_pending (&input_pending, READABLE_EVENTS_DO_TIMERS_NOW);
284f4730 10323
87dd9b9b 10324 if (old_timers_run != timers_run && do_display)
7ee32cda 10325 {
3007ebfb 10326 redisplay_preserve_echo_area (8);
7ee32cda
GM
10327 /* The following fixes a bug when using lazy-lock with
10328 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10329 from an idle timer function. The symptom of the bug is that
10330 the cursor sometimes doesn't become visible until the next X
10331 event is processed. --gerd. */
10332 if (rif)
10333 rif->flush_display (NULL);
10334 }
87dd9b9b 10335
284f4730
JB
10336 return input_pending;
10337}
10338
ffd56f97
JB
10339/* This is called in some cases before a possible quit.
10340 It cases the next call to detect_input_pending to recompute input_pending.
10341 So calling this function unnecessarily can't do any harm. */
07a59269
KH
10342
10343void
ffd56f97
JB
10344clear_input_pending ()
10345{
10346 input_pending = 0;
10347}
10348
b1878f45 10349/* Return nonzero if there are pending requeued events.
d64b707c 10350 This isn't used yet. The hope is to make wait_reading_process_output
27fd22dc 10351 call it, and return if it runs Lisp code that unreads something.
b1878f45
RS
10352 The problem is, kbd_buffer_get_event needs to be fixed to know what
10353 to do in that case. It isn't trivial. */
10354
dfcf069d 10355int
b1878f45
RS
10356requeued_events_pending_p ()
10357{
10358 return (!NILP (Vunread_command_events) || unread_command_char != -1);
10359}
10360
10361
284f4730 10362DEFUN ("input-pending-p", Finput_pending_p, Sinput_pending_p, 0, 0, 0,
a064684d
RS
10363 doc: /* Return t if command input is currently available with no wait.
10364Actually, the value is nil only if we can be sure that no input is available;
10365if there is a doubt, the value is t. */)
4707d2d0 10366 ()
284f4730 10367{
182f67de
KS
10368 if (!NILP (Vunread_command_events) || unread_command_char != -1
10369 || !NILP (Vunread_post_input_method_events)
10370 || !NILP (Vunread_input_method_events))
284f4730
JB
10371 return (Qt);
10372
a2d5fca0
JD
10373 get_input_pending (&input_pending,
10374 READABLE_EVENTS_DO_TIMERS_NOW
10375 | READABLE_EVENTS_FILTER_EVENTS);
d9d4c147 10376 return input_pending > 0 ? Qt : Qnil;
284f4730
JB
10377}
10378
10379DEFUN ("recent-keys", Frecent_keys, Srecent_keys, 0, 0, 0,
0721f230 10380 doc: /* Return vector of last 300 events, not counting those from keyboard macros. */)
4707d2d0 10381 ()
284f4730 10382{
5160df46 10383 Lisp_Object *keys = XVECTOR (recent_keys)->contents;
284f4730
JB
10384 Lisp_Object val;
10385
10386 if (total_keys < NUM_RECENT_KEYS)
5160df46 10387 return Fvector (total_keys, keys);
284f4730
JB
10388 else
10389 {
5160df46
JB
10390 val = Fvector (NUM_RECENT_KEYS, keys);
10391 bcopy (keys + recent_keys_index,
284f4730
JB
10392 XVECTOR (val)->contents,
10393 (NUM_RECENT_KEYS - recent_keys_index) * sizeof (Lisp_Object));
5160df46 10394 bcopy (keys,
284f4730
JB
10395 XVECTOR (val)->contents + NUM_RECENT_KEYS - recent_keys_index,
10396 recent_keys_index * sizeof (Lisp_Object));
10397 return val;
10398 }
10399}
10400
10401DEFUN ("this-command-keys", Fthis_command_keys, Sthis_command_keys, 0, 0, 0,
4707d2d0 10402 doc: /* Return the key sequence that invoked this command.
92501652 10403However, if the command has called `read-key-sequence', it returns
4052e7bb 10404the last key sequence that has been read.
65849ada
EZ
10405The value is a string or a vector.
10406
10407See also `this-command-keys-vector'. */)
4707d2d0 10408 ()
284f4730 10409{
86e5706b
RS
10410 return make_event_array (this_command_key_count,
10411 XVECTOR (this_command_keys)->contents);
284f4730
JB
10412}
10413
e39da3d7 10414DEFUN ("this-command-keys-vector", Fthis_command_keys_vector, Sthis_command_keys_vector, 0, 0, 0,
92501652
RS
10415 doc: /* Return the key sequence that invoked this command, as a vector.
10416However, if the command has called `read-key-sequence', it returns
65849ada
EZ
10417the last key sequence that has been read.
10418
10419See also `this-command-keys'. */)
4707d2d0 10420 ()
e39da3d7
RS
10421{
10422 return Fvector (this_command_key_count,
10423 XVECTOR (this_command_keys)->contents);
10424}
10425
6321824f
RS
10426DEFUN ("this-single-command-keys", Fthis_single_command_keys,
10427 Sthis_single_command_keys, 0, 0, 0,
4707d2d0 10428 doc: /* Return the key sequence that invoked this command.
92501652
RS
10429More generally, it returns the last key sequence read, either by
10430the command loop or by `read-key-sequence'.
4707d2d0
PJ
10431Unlike `this-command-keys', this function's value
10432does not include prefix arguments.
10433The value is always a vector. */)
10434 ()
6321824f 10435{
e39da3d7
RS
10436 return Fvector (this_command_key_count
10437 - this_single_command_key_start,
10438 (XVECTOR (this_command_keys)->contents
10439 + this_single_command_key_start));
6321824f
RS
10440}
10441
7d18f9ae
RS
10442DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys,
10443 Sthis_single_command_raw_keys, 0, 0, 0,
4707d2d0 10444 doc: /* Return the raw events that were read for this command.
92501652
RS
10445More generally, it returns the last key sequence read, either by
10446the command loop or by `read-key-sequence'.
4707d2d0
PJ
10447Unlike `this-single-command-keys', this function's value
10448shows the events before all translations (except for input methods).
10449The value is always a vector. */)
10450 ()
7d18f9ae
RS
10451{
10452 return Fvector (raw_keybuf_count,
10453 (XVECTOR (raw_keybuf)->contents));
10454}
10455
71918b75 10456DEFUN ("reset-this-command-lengths", Freset_this_command_lengths,
4707d2d0 10457 Sreset_this_command_lengths, 0, 0, 0,
63020c46
RS
10458 doc: /* Make the unread events replace the last command and echo.
10459Used in `universal-argument-other-key'.
4707d2d0
PJ
10460
10461`universal-argument-other-key' rereads the event just typed.
10462It then gets translated through `function-key-map'.
63020c46
RS
10463The translated event has to replace the real events,
10464both in the value of (this-command-keys) and in echoing.
10465To achieve this, `universal-argument-other-key' calls
10466`reset-this-command-lengths', which discards the record of reading
10467these events the first time. */)
4707d2d0 10468 ()
71918b75 10469{
22b94eeb
RS
10470 this_command_key_count = before_command_key_count;
10471 if (this_command_key_count < this_single_command_key_start)
10472 this_single_command_key_start = this_command_key_count;
63020c46 10473
22b94eeb
RS
10474 echo_truncate (before_command_echo_length);
10475
63020c46
RS
10476 /* Cause whatever we put into unread-command-events
10477 to echo as if it were being freshly read from the keyboard. */
10478 this_command_key_count_reset = 1;
10479
6e5742a0 10480 return Qnil;
71918b75
RS
10481}
10482
82e6e5af 10483DEFUN ("clear-this-command-keys", Fclear_this_command_keys,
ab1959fc 10484 Sclear_this_command_keys, 0, 1, 0,
4707d2d0 10485 doc: /* Clear out the vector that `this-command-keys' returns.
ab1959fc
KS
10486Also clear the record of the last 100 events, unless optional arg
10487KEEP-RECORD is non-nil. */)
10488 (keep_record)
10489 Lisp_Object keep_record;
82e6e5af 10490{
fb0dde6c 10491 int i;
c60ee5e7 10492
82e6e5af 10493 this_command_key_count = 0;
63020c46 10494 this_command_key_count_reset = 0;
fb0dde6c 10495
ab1959fc
KS
10496 if (NILP (keep_record))
10497 {
10498 for (i = 0; i < XVECTOR (recent_keys)->size; ++i)
10499 XVECTOR (recent_keys)->contents[i] = Qnil;
10500 total_keys = 0;
10501 recent_keys_index = 0;
10502 }
82e6e5af
RS
10503 return Qnil;
10504}
10505
284f4730 10506DEFUN ("recursion-depth", Frecursion_depth, Srecursion_depth, 0, 0, 0,
4707d2d0
PJ
10507 doc: /* Return the current depth in recursive edits. */)
10508 ()
284f4730
JB
10509{
10510 Lisp_Object temp;
bb9e9bed 10511 XSETFASTINT (temp, command_loop_level + minibuf_level);
284f4730
JB
10512 return temp;
10513}
10514
10515DEFUN ("open-dribble-file", Fopen_dribble_file, Sopen_dribble_file, 1, 1,
4707d2d0
PJ
10516 "FOpen dribble file: ",
10517 doc: /* Start writing all keyboard characters to a dribble file called FILE.
10518If FILE is nil, close any open dribble file. */)
10519 (file)
284f4730
JB
10520 Lisp_Object file;
10521{
6cb52def 10522 if (dribble)
284f4730 10523 {
34f5c10f 10524 BLOCK_INPUT;
6cb52def 10525 fclose (dribble);
34f5c10f 10526 UNBLOCK_INPUT;
6cb52def 10527 dribble = 0;
284f4730 10528 }
6cb52def 10529 if (!NILP (file))
284f4730
JB
10530 {
10531 file = Fexpand_file_name (file, Qnil);
d5db4077 10532 dribble = fopen (SDATA (file), "w");
ab6ca1de
KH
10533 if (dribble == 0)
10534 report_file_error ("Opening dribble", Fcons (file, Qnil));
284f4730
JB
10535 }
10536 return Qnil;
10537}
10538
10539DEFUN ("discard-input", Fdiscard_input, Sdiscard_input, 0, 0, 0,
4707d2d0 10540 doc: /* Discard the contents of the terminal input buffer.
2b17d5ed 10541Also end any kbd macro being defined. */)
4707d2d0 10542 ()
284f4730 10543{
2b17d5ed
KS
10544 if (!NILP (current_kboard->defining_kbd_macro))
10545 {
10546 /* Discard the last command from the macro. */
10547 Fcancel_kbd_macro_events ();
10548 end_kbd_macro ();
10549 }
10550
284f4730
JB
10551 update_mode_lines++;
10552
24597608 10553 Vunread_command_events = Qnil;
86e5706b 10554 unread_command_char = -1;
284f4730
JB
10555
10556 discard_tty_input ();
10557
7ee32cda 10558 kbd_fetch_ptr = kbd_store_ptr;
284f4730
JB
10559 input_pending = 0;
10560
10561 return Qnil;
10562}
10563\f
10564DEFUN ("suspend-emacs", Fsuspend_emacs, Ssuspend_emacs, 0, 1, "",
4707d2d0
PJ
10565 doc: /* Stop Emacs and return to superior process. You can resume later.
10566If `cannot-suspend' is non-nil, or if the system doesn't support job
10567control, run a subshell instead.
10568
10569If optional arg STUFFSTRING is non-nil, its characters are stuffed
10570to be read as terminal input by Emacs's parent, after suspension.
10571
10572Before suspending, run the normal hook `suspend-hook'.
10573After resumption run the normal hook `suspend-resume-hook'.
10574
10575Some operating systems cannot stop the Emacs process and resume it later.
10576On such systems, Emacs starts a subshell instead of suspending. */)
10577 (stuffstring)
284f4730
JB
10578 Lisp_Object stuffstring;
10579{
aed13378 10580 int count = SPECPDL_INDEX ();
284f4730
JB
10581 int old_height, old_width;
10582 int width, height;
03cee6ae 10583 struct gcpro gcpro1;
284f4730
JB
10584
10585 if (!NILP (stuffstring))
b7826503 10586 CHECK_STRING (stuffstring);
284f4730 10587
1e95ed28
JB
10588 /* Run the functions in suspend-hook. */
10589 if (!NILP (Vrun_hooks))
10590 call1 (Vrun_hooks, intern ("suspend-hook"));
284f4730 10591
b7d2ebbf 10592 GCPRO1 (stuffstring);
ff11dfa1 10593 get_frame_size (&old_width, &old_height);
284f4730
JB
10594 reset_sys_modes ();
10595 /* sys_suspend can get an error if it tries to fork a subshell
10596 and the system resources aren't available for that. */
91a0da02 10597 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object))) init_sys_modes,
d52a7a92 10598 Qnil);
284f4730 10599 stuff_buffered_input (stuffstring);
8026024c
KH
10600 if (cannot_suspend)
10601 sys_subshell ();
10602 else
10603 sys_suspend ();
284f4730
JB
10604 unbind_to (count, Qnil);
10605
10606 /* Check if terminal/window size has changed.
10607 Note that this is not useful when we are running directly
10608 with a window system; but suspend should be disabled in that case. */
ff11dfa1 10609 get_frame_size (&width, &height);
284f4730 10610 if (width != old_width || height != old_height)
788f89eb 10611 change_frame_size (SELECTED_FRAME (), height, width, 0, 0, 0);
284f4730 10612
1e95ed28 10613 /* Run suspend-resume-hook. */
284f4730
JB
10614 if (!NILP (Vrun_hooks))
10615 call1 (Vrun_hooks, intern ("suspend-resume-hook"));
df0f2ba1 10616
284f4730
JB
10617 UNGCPRO;
10618 return Qnil;
10619}
10620
10621/* If STUFFSTRING is a string, stuff its contents as pending terminal input.
eb8c3be9 10622 Then in any case stuff anything Emacs has read ahead and not used. */
284f4730 10623
07a59269 10624void
284f4730
JB
10625stuff_buffered_input (stuffstring)
10626 Lisp_Object stuffstring;
10627{
0c1c1b93 10628#ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
612b78ef 10629 register unsigned char *p;
612b78ef 10630
8c18cbfb 10631 if (STRINGP (stuffstring))
284f4730
JB
10632 {
10633 register int count;
10634
d5db4077
KR
10635 p = SDATA (stuffstring);
10636 count = SBYTES (stuffstring);
284f4730
JB
10637 while (count-- > 0)
10638 stuff_char (*p++);
10639 stuff_char ('\n');
10640 }
c60ee5e7 10641
284f4730 10642 /* Anything we have read ahead, put back for the shell to read. */
beecf6a1 10643 /* ?? What should this do when we have multiple keyboards??
0c1c1b93 10644 Should we ignore anything that was typed in at the "wrong" kboard?
26503ad2 10645
0c1c1b93
RS
10646 rms: we should stuff everything back into the kboard
10647 it came from. */
beecf6a1 10648 for (; kbd_fetch_ptr != kbd_store_ptr; kbd_fetch_ptr++)
284f4730 10649 {
c60ee5e7 10650
beecf6a1
KH
10651 if (kbd_fetch_ptr == kbd_buffer + KBD_BUFFER_SIZE)
10652 kbd_fetch_ptr = kbd_buffer;
3b8f9651 10653 if (kbd_fetch_ptr->kind == ASCII_KEYSTROKE_EVENT)
beecf6a1 10654 stuff_char (kbd_fetch_ptr->code);
c60ee5e7 10655
d92f48d3 10656 clear_event (kbd_fetch_ptr);
284f4730 10657 }
c60ee5e7 10658
284f4730 10659 input_pending = 0;
0c1c1b93 10660#endif /* SIGTSTP */
284f4730
JB
10661}
10662\f
dfcf069d 10663void
ffd56f97
JB
10664set_waiting_for_input (time_to_clear)
10665 EMACS_TIME *time_to_clear;
284f4730 10666{
ffd56f97 10667 input_available_clear_time = time_to_clear;
284f4730
JB
10668
10669 /* Tell interrupt_signal to throw back to read_char, */
10670 waiting_for_input = 1;
10671
10672 /* If interrupt_signal was called before and buffered a C-g,
10673 make it run again now, to avoid timing error. */
10674 if (!NILP (Vquit_flag))
10675 quit_throw_to_read_char ();
284f4730
JB
10676}
10677
07a59269 10678void
284f4730
JB
10679clear_waiting_for_input ()
10680{
10681 /* Tell interrupt_signal not to throw back to read_char, */
10682 waiting_for_input = 0;
ffd56f97 10683 input_available_clear_time = 0;
284f4730
JB
10684}
10685
27fd22dc 10686/* This routine is called at interrupt level in response to C-g.
c60ee5e7 10687
d4e68eea
GM
10688 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10689 is called from kbd_buffer_store_event, in handling SIGIO or
10690 SIGTINT.
284f4730 10691
d4e68eea
GM
10692 If `waiting_for_input' is non zero, then unless `echoing' is
10693 nonzero, immediately throw back to read_char.
284f4730 10694
d4e68eea
GM
10695 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10696 eval to throw, when it gets a chance. If quit-flag is already
10697 non-nil, it stops the job right away. */
284f4730 10698
14e40288 10699static SIGTYPE
91c049d4
RS
10700interrupt_signal (signalnum) /* If we don't have an argument, */
10701 int signalnum; /* some compilers complain in signal calls. */
284f4730
JB
10702{
10703 char c;
10704 /* Must preserve main program's value of errno. */
10705 int old_errno = errno;
788f89eb 10706 struct frame *sf = SELECTED_FRAME ();
284f4730 10707
5970a8cb 10708#if defined (USG) && !defined (POSIX_SIGNALS)
7a80a6f6
RS
10709 if (!read_socket_hook && NILP (Vwindow_system))
10710 {
10711 /* USG systems forget handlers when they are used;
10712 must reestablish each time */
10713 signal (SIGINT, interrupt_signal);
10714 signal (SIGQUIT, interrupt_signal);
10715 }
284f4730
JB
10716#endif /* USG */
10717
333f1b6f 10718 SIGNAL_THREAD_CHECK (signalnum);
284f4730
JB
10719 cancel_echoing ();
10720
31e4e97b 10721 if (!NILP (Vquit_flag)
788f89eb 10722 && (FRAME_TERMCAP_P (sf) || FRAME_MSDOS_P (sf)))
284f4730 10723 {
31e4e97b
EZ
10724 /* If SIGINT isn't blocked, don't let us be interrupted by
10725 another SIGINT, it might be harmful due to non-reentrancy
10726 in I/O functions. */
10727 sigblock (sigmask (SIGINT));
10728
284f4730
JB
10729 fflush (stdout);
10730 reset_sys_modes ();
31e4e97b 10731
284f4730
JB
10732#ifdef SIGTSTP /* Support possible in later USG versions */
10733/*
10734 * On systems which can suspend the current process and return to the original
10735 * shell, this command causes the user to end up back at the shell.
10736 * The "Auto-save" and "Abort" questions are not asked until
10737 * the user elects to return to emacs, at which point he can save the current
10738 * job and either dump core or continue.
10739 */
10740 sys_suspend ();
10741#else
10742#ifdef VMS
10743 if (sys_suspend () == -1)
10744 {
10745 printf ("Not running as a subprocess;\n");
10746 printf ("you can continue or abort.\n");
10747 }
10748#else /* not VMS */
10749 /* Perhaps should really fork an inferior shell?
10750 But that would not provide any way to get back
10751 to the original shell, ever. */
10752 printf ("No support for stopping a process on this operating system;\n");
10753 printf ("you can continue or abort.\n");
10754#endif /* not VMS */
10755#endif /* not SIGTSTP */
80e4aa30
RS
10756#ifdef MSDOS
10757 /* We must remain inside the screen area when the internal terminal
10758 is used. Note that [Enter] is not echoed by dos. */
10759 cursor_to (0, 0);
10760#endif
118d6ca9
RS
10761 /* It doesn't work to autosave while GC is in progress;
10762 the code used for auto-saving doesn't cope with the mark bit. */
10763 if (!gc_in_progress)
9fd7d808 10764 {
118d6ca9
RS
10765 printf ("Auto-save? (y or n) ");
10766 fflush (stdout);
10767 if (((c = getchar ()) & ~040) == 'Y')
10768 {
10769 Fdo_auto_save (Qt, Qnil);
80e4aa30 10770#ifdef MSDOS
118d6ca9 10771 printf ("\r\nAuto-save done");
80e4aa30 10772#else /* not MSDOS */
118d6ca9 10773 printf ("Auto-save done\n");
80e4aa30 10774#endif /* not MSDOS */
118d6ca9
RS
10775 }
10776 while (c != '\n') c = getchar ();
9fd7d808 10777 }
c60ee5e7 10778 else
118d6ca9
RS
10779 {
10780 /* During GC, it must be safe to reenable quitting again. */
10781 Vinhibit_quit = Qnil;
10782#ifdef MSDOS
10783 printf ("\r\n");
10784#endif /* not MSDOS */
10785 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10786 printf ("but will instead do a real quit after garbage collection ends\r\n");
10787 fflush (stdout);
10788 }
10789
80e4aa30
RS
10790#ifdef MSDOS
10791 printf ("\r\nAbort? (y or n) ");
10792#else /* not MSDOS */
284f4730
JB
10793#ifdef VMS
10794 printf ("Abort (and enter debugger)? (y or n) ");
10795#else /* not VMS */
10796 printf ("Abort (and dump core)? (y or n) ");
10797#endif /* not VMS */
80e4aa30 10798#endif /* not MSDOS */
284f4730
JB
10799 fflush (stdout);
10800 if (((c = getchar ()) & ~040) == 'Y')
10801 abort ();
10802 while (c != '\n') c = getchar ();
80e4aa30
RS
10803#ifdef MSDOS
10804 printf ("\r\nContinuing...\r\n");
10805#else /* not MSDOS */
284f4730 10806 printf ("Continuing...\n");
80e4aa30 10807#endif /* not MSDOS */
284f4730
JB
10808 fflush (stdout);
10809 init_sys_modes ();
31e4e97b 10810 sigfree ();
284f4730
JB
10811 }
10812 else
10813 {
10814 /* If executing a function that wants to be interrupted out of
10815 and the user has not deferred quitting by binding `inhibit-quit'
10816 then quit right away. */
10817 if (immediate_quit && NILP (Vinhibit_quit))
10818 {
e39da3d7
RS
10819 struct gl_state_s saved;
10820 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
10821
284f4730
JB
10822 immediate_quit = 0;
10823 sigfree ();
e39da3d7
RS
10824 saved = gl_state;
10825 GCPRO4 (saved.object, saved.global_code,
10826 saved.current_syntax_table, saved.old_prop);
284f4730 10827 Fsignal (Qquit, Qnil);
e39da3d7
RS
10828 gl_state = saved;
10829 UNGCPRO;
284f4730
JB
10830 }
10831 else
10832 /* Else request quit when it's safe */
10833 Vquit_flag = Qt;
10834 }
10835
10836 if (waiting_for_input && !echoing)
10837 quit_throw_to_read_char ();
10838
10839 errno = old_errno;
10840}
10841
10842/* Handle a C-g by making read_char return C-g. */
10843
07a59269 10844void
284f4730
JB
10845quit_throw_to_read_char ()
10846{
284f4730
JB
10847 sigfree ();
10848 /* Prevent another signal from doing this before we finish. */
f76475ad 10849 clear_waiting_for_input ();
284f4730
JB
10850 input_pending = 0;
10851
24597608 10852 Vunread_command_events = Qnil;
86e5706b 10853 unread_command_char = -1;
284f4730 10854
087feab3
RS
10855#if 0 /* Currently, sit_for is called from read_char without turning
10856 off polling. And that can call set_waiting_for_input.
10857 It seems to be harmless. */
e6b01c14
JB
10858#ifdef POLL_FOR_INPUT
10859 /* May be > 1 if in recursive minibuffer. */
10860 if (poll_suppress_count == 0)
10861 abort ();
10862#endif
087feab3 10863#endif
4c52b668 10864 if (FRAMEP (internal_last_event_frame)
788f89eb 10865 && !EQ (internal_last_event_frame, selected_frame))
719191cf 10866 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame),
827c686c 10867 0, 0);
e6b01c14 10868
284f4730
JB
10869 _longjmp (getcjmp, 1);
10870}
10871\f
10872DEFUN ("set-input-mode", Fset_input_mode, Sset_input_mode, 3, 4, 0,
4707d2d0
PJ
10873 doc: /* Set mode of reading keyboard input.
10874First arg INTERRUPT non-nil means use input interrupts;
10875 nil means use CBREAK mode.
10876Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10877 (no effect except in CBREAK mode).
10878Third arg META t means accept 8-bit input (for a Meta key).
10879 META nil means ignore the top bit, on the assumption it is parity.
10880 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10881Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10882See also `current-input-mode'. */)
10883 (interrupt, flow, meta, quit)
284f4730
JB
10884 Lisp_Object interrupt, flow, meta, quit;
10885{
10886 if (!NILP (quit)
8c18cbfb 10887 && (!INTEGERP (quit) || XINT (quit) < 0 || XINT (quit) > 0400))
34f04431
RS
10888 error ("set-input-mode: QUIT must be an ASCII character");
10889
10890#ifdef POLL_FOR_INPUT
10891 stop_polling ();
10892#endif
284f4730 10893
07de30b9 10894#ifndef DOS_NT
2ee250ec 10895 /* this causes startup screen to be restored and messes with the mouse */
284f4730 10896 reset_sys_modes ();
2ee250ec
RS
10897#endif
10898
284f4730
JB
10899#ifdef SIGIO
10900/* Note SIGIO has been undef'd if FIONREAD is missing. */
284f4730 10901 if (read_socket_hook)
9a0f60bb
KH
10902 {
10903 /* When using X, don't give the user a real choice,
10904 because we haven't implemented the mechanisms to support it. */
10905#ifdef NO_SOCK_SIGIO
10906 interrupt_input = 0;
10907#else /* not NO_SOCK_SIGIO */
10908 interrupt_input = 1;
284f4730 10909#endif /* NO_SOCK_SIGIO */
9a0f60bb
KH
10910 }
10911 else
284f4730
JB
10912 interrupt_input = !NILP (interrupt);
10913#else /* not SIGIO */
10914 interrupt_input = 0;
10915#endif /* not SIGIO */
9a0f60bb 10916
284f4730
JB
10917/* Our VMS input only works by interrupts, as of now. */
10918#ifdef VMS
10919 interrupt_input = 1;
10920#endif
9a0f60bb 10921
284f4730 10922 flow_control = !NILP (flow);
b04904fb
RS
10923 if (NILP (meta))
10924 meta_key = 0;
10925 else if (EQ (meta, Qt))
10926 meta_key = 1;
10927 else
10928 meta_key = 2;
284f4730
JB
10929 if (!NILP (quit))
10930 /* Don't let this value be out of range. */
10931 quit_char = XINT (quit) & (meta_key ? 0377 : 0177);
10932
07de30b9 10933#ifndef DOS_NT
284f4730 10934 init_sys_modes ();
2ee250ec 10935#endif
34f04431
RS
10936
10937#ifdef POLL_FOR_INPUT
10938 poll_suppress_count = 1;
10939 start_polling ();
10940#endif
284f4730
JB
10941 return Qnil;
10942}
80645119
JB
10943
10944DEFUN ("current-input-mode", Fcurrent_input_mode, Scurrent_input_mode, 0, 0, 0,
4707d2d0
PJ
10945 doc: /* Return information about the way Emacs currently reads keyboard input.
10946The value is a list of the form (INTERRUPT FLOW META QUIT), where
10947 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10948 nil, Emacs is using CBREAK mode.
10949 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10950 terminal; this does not apply if Emacs uses interrupt-driven input.
10951 META is t if accepting 8-bit input with 8th bit as Meta flag.
10952 META nil means ignoring the top bit, on the assumption it is parity.
10953 META is neither t nor nil if accepting 8-bit input and using
10954 all 8 bits as the character code.
10955 QUIT is the character Emacs currently uses to quit.
10956The elements of this list correspond to the arguments of
10957`set-input-mode'. */)
10958 ()
80645119
JB
10959{
10960 Lisp_Object val[4];
10961
10962 val[0] = interrupt_input ? Qt : Qnil;
10963 val[1] = flow_control ? Qt : Qnil;
a8ee7ef9 10964 val[2] = meta_key == 2 ? make_number (0) : meta_key == 1 ? Qt : Qnil;
bb9e9bed 10965 XSETFASTINT (val[3], quit_char);
80645119 10966
bf673a7a 10967 return Flist (sizeof (val) / sizeof (val[0]), val);
80645119
JB
10968}
10969
a25f766a 10970DEFUN ("posn-at-x-y", Fposn_at_x_y, Sposn_at_x_y, 2, 4, 0,
ec026e7a
KS
10971 doc: /* Return position information for pixel coordinates X and Y.
10972By default, X and Y are relative to text area of the selected window.
6e604a9b 10973Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
a25f766a
KS
10974If optional fourth arg WHOLE is non-nil, X is relative to the left
10975edge of the window.
ec026e7a
KS
10976
10977The return value is similar to a mouse click position:
10978 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10979 IMAGE (DX . DY) (WIDTH . HEIGHT))
10980The `posn-' functions access elements of such lists. */)
a25f766a
KS
10981 (x, y, frame_or_window, whole)
10982 Lisp_Object x, y, frame_or_window, whole;
ec026e7a 10983{
f4a5a485
SM
10984 CHECK_NATNUM (x);
10985 CHECK_NATNUM (y);
10986
ec026e7a
KS
10987 if (NILP (frame_or_window))
10988 frame_or_window = selected_window;
10989
10990 if (WINDOWP (frame_or_window))
10991 {
10992 struct window *w;
10993
10994 CHECK_LIVE_WINDOW (frame_or_window);
10995
10996 w = XWINDOW (frame_or_window);
6507c4c7
KS
10997 XSETINT (x, (XINT (x)
10998 + WINDOW_LEFT_EDGE_X (w)
a25f766a
KS
10999 + (NILP (whole)
11000 ? window_box_left_offset (w, TEXT_AREA)
6507c4c7 11001 : 0)));
ec026e7a
KS
11002 XSETINT (y, WINDOW_TO_FRAME_PIXEL_Y (w, XINT (y)));
11003 frame_or_window = w->frame;
11004 }
11005
11006 CHECK_LIVE_FRAME (frame_or_window);
11007
11008 return make_lispy_position (XFRAME (frame_or_window), &x, &y, 0);
11009}
11010
11011DEFUN ("posn-at-point", Fposn_at_point, Sposn_at_point, 0, 2, 0,
11012 doc: /* Return position information for buffer POS in WINDOW.
11013POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11014
11015Return nil if position is not visible in window. Otherwise,
883d272e 11016the return value is similar to that returned by `event-start' for
ec026e7a
KS
11017a mouse click at the upper left corner of the glyph corresponding
11018to the given buffer position:
11019 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11020 IMAGE (DX . DY) (WIDTH . HEIGHT))
8f1657f0 11021The `posn-' functions access elements of such lists. */)
ec026e7a
KS
11022 (pos, window)
11023 Lisp_Object pos, window;
11024{
11025 Lisp_Object tem;
11026
6507c4c7
KS
11027 if (NILP (window))
11028 window = selected_window;
11029
ec026e7a
KS
11030 tem = Fpos_visible_in_window_p (pos, window, Qt);
11031 if (!NILP (tem))
6507c4c7
KS
11032 {
11033 Lisp_Object x = XCAR (tem);
11034 Lisp_Object y = XCAR (XCDR (tem));
11035
11036 /* Point invisible due to hscrolling? */
11037 if (XINT (x) < 0)
11038 return Qnil;
11039 tem = Fposn_at_x_y (x, y, window, Qnil);
11040 }
11041
ec026e7a
KS
11042 return tem;
11043}
11044
284f4730 11045\f
6c6083a9 11046/*
c5fdd383 11047 * Set up a new kboard object with reasonable initial values.
6c6083a9
KH
11048 */
11049void
c5fdd383
KH
11050init_kboard (kb)
11051 KBOARD *kb;
6c6083a9 11052{
217258d5 11053 kb->Voverriding_terminal_local_map = Qnil;
6c7178b9 11054 kb->Vlast_command = Qnil;
75045dcb 11055 kb->Vreal_last_command = Qnil;
d8bcf58e 11056 kb->Vprefix_arg = Qnil;
75045dcb 11057 kb->Vlast_prefix_arg = Qnil;
c5fdd383
KH
11058 kb->kbd_queue = Qnil;
11059 kb->kbd_queue_has_data = 0;
11060 kb->immediate_echo = 0;
678e9d18 11061 kb->echo_string = Qnil;
c5fdd383
KH
11062 kb->echo_after_prompt = -1;
11063 kb->kbd_macro_buffer = 0;
11064 kb->kbd_macro_bufsize = 0;
11065 kb->defining_kbd_macro = Qnil;
11066 kb->Vlast_kbd_macro = Qnil;
11067 kb->reference_count = 0;
7c97ffdc 11068 kb->Vsystem_key_alist = Qnil;
142e6c73 11069 kb->system_key_syms = Qnil;
9ba47203 11070 kb->Vdefault_minibuffer_frame = Qnil;
6c6083a9
KH
11071}
11072
11073/*
c5fdd383 11074 * Destroy the contents of a kboard object, but not the object itself.
8e6208c5 11075 * We use this just before deleting it, or if we're going to initialize
6c6083a9
KH
11076 * it a second time.
11077 */
e50b8090 11078static void
c5fdd383
KH
11079wipe_kboard (kb)
11080 KBOARD *kb;
6c6083a9 11081{
c5fdd383
KH
11082 if (kb->kbd_macro_buffer)
11083 xfree (kb->kbd_macro_buffer);
6c6083a9
KH
11084}
11085
e50b8090 11086#ifdef MULTI_KBOARD
a122a38e
GM
11087
11088/* Free KB and memory referenced from it. */
11089
e50b8090
KH
11090void
11091delete_kboard (kb)
a122a38e 11092 KBOARD *kb;
e50b8090
KH
11093{
11094 KBOARD **kbp;
c60ee5e7 11095
e50b8090
KH
11096 for (kbp = &all_kboards; *kbp != kb; kbp = &(*kbp)->next_kboard)
11097 if (*kbp == NULL)
11098 abort ();
11099 *kbp = kb->next_kboard;
a122a38e
GM
11100
11101 /* Prevent a dangling reference to KB. */
18f534df
GM
11102 if (kb == current_kboard
11103 && FRAMEP (selected_frame)
11104 && FRAME_LIVE_P (XFRAME (selected_frame)))
a122a38e 11105 {
18f534df 11106 current_kboard = XFRAME (selected_frame)->kboard;
a122a38e
GM
11107 if (current_kboard == kb)
11108 abort ();
11109 }
c60ee5e7 11110
e50b8090
KH
11111 wipe_kboard (kb);
11112 xfree (kb);
11113}
a122a38e
GM
11114
11115#endif /* MULTI_KBOARD */
e50b8090 11116
dfcf069d 11117void
284f4730
JB
11118init_keyboard ()
11119{
284f4730
JB
11120 /* This is correct before outermost invocation of the editor loop */
11121 command_loop_level = -1;
11122 immediate_quit = 0;
11123 quit_char = Ctl ('g');
24597608 11124 Vunread_command_events = Qnil;
86e5706b 11125 unread_command_char = -1;
87dd9b9b 11126 EMACS_SET_SECS_USECS (timer_idleness_start_time, -1, -1);
284f4730 11127 total_keys = 0;
9deb415a 11128 recent_keys_index = 0;
beecf6a1
KH
11129 kbd_fetch_ptr = kbd_buffer;
11130 kbd_store_ptr = kbd_buffer;
ae372f41 11131#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
a9d77f1f 11132 do_mouse_tracking = Qnil;
2eb6bfbe 11133#endif
284f4730 11134 input_pending = 0;
4c180390
JD
11135 interrupt_input_blocked = 0;
11136 interrupt_input_pending = 0;
284f4730 11137
4c52b668
KH
11138 /* This means that command_loop_1 won't try to select anything the first
11139 time through. */
11140 internal_last_event_frame = Qnil;
11141 Vlast_event_frame = internal_last_event_frame;
4c52b668 11142
c5fdd383 11143#ifdef MULTI_KBOARD
aaca43a1 11144 current_kboard = initial_kboard;
6c6083a9 11145#endif
aaca43a1 11146 wipe_kboard (current_kboard);
c5fdd383 11147 init_kboard (current_kboard);
07d2b8de 11148
7a80a6f6 11149 if (!noninteractive && !read_socket_hook && NILP (Vwindow_system))
284f4730
JB
11150 {
11151 signal (SIGINT, interrupt_signal);
cb5df6ae 11152#if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
284f4730
JB
11153 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11154 SIGQUIT and we can't tell which one it will give us. */
11155 signal (SIGQUIT, interrupt_signal);
11156#endif /* HAVE_TERMIO */
7a80a6f6 11157 }
284f4730
JB
11158/* Note SIGIO has been undef'd if FIONREAD is missing. */
11159#ifdef SIGIO
7a80a6f6
RS
11160 if (!noninteractive)
11161 signal (SIGIO, input_available_signal);
8ea0a720 11162#endif /* SIGIO */
284f4730
JB
11163
11164/* Use interrupt input by default, if it works and noninterrupt input
11165 has deficiencies. */
11166
11167#ifdef INTERRUPT_INPUT
11168 interrupt_input = 1;
11169#else
11170 interrupt_input = 0;
11171#endif
11172
11173/* Our VMS input only works by interrupts, as of now. */
11174#ifdef VMS
11175 interrupt_input = 1;
11176#endif
11177
11178 sigfree ();
11179 dribble = 0;
11180
11181 if (keyboard_init_hook)
11182 (*keyboard_init_hook) ();
11183
11184#ifdef POLL_FOR_INPUT
11185 poll_suppress_count = 1;
11186 start_polling ();
11187#endif
11188}
11189
df0f2ba1 11190/* This type's only use is in syms_of_keyboard, to initialize the
284f4730
JB
11191 event header symbols and put properties on them. */
11192struct event_head {
11193 Lisp_Object *var;
11194 char *name;
11195 Lisp_Object *kind;
11196};
11197
11198struct event_head head_table[] = {
7406e988
PJ
11199 {&Qmouse_movement, "mouse-movement", &Qmouse_movement},
11200 {&Qscroll_bar_movement, "scroll-bar-movement", &Qmouse_movement},
11201 {&Qswitch_frame, "switch-frame", &Qswitch_frame},
11202 {&Qdelete_frame, "delete-frame", &Qdelete_frame},
11203 {&Qiconify_frame, "iconify-frame", &Qiconify_frame},
a697f886 11204 {&Qmake_frame_visible, "make-frame-visible", &Qmake_frame_visible},
6901b111
SM
11205 /* `select-window' should be handled just like `switch-frame'
11206 in read_key_sequence. */
11207 {&Qselect_window, "select-window", &Qswitch_frame}
284f4730
JB
11208};
11209
dfcf069d 11210void
284f4730
JB
11211syms_of_keyboard ()
11212{
f0c1cc56
GM
11213 Vpre_help_message = Qnil;
11214 staticpro (&Vpre_help_message);
c60ee5e7 11215
8e1e4240
GM
11216 Vlispy_mouse_stem = build_string ("mouse");
11217 staticpro (&Vlispy_mouse_stem);
f0c1cc56 11218
9ea173e8 11219 /* Tool-bars. */
7ee32cda
GM
11220 QCimage = intern (":image");
11221 staticpro (&QCimage);
11222
11223 staticpro (&Qhelp_echo);
11224 Qhelp_echo = intern ("help-echo");
11225
e8886a1d
RS
11226 staticpro (&item_properties);
11227 item_properties = Qnil;
11228
9ea173e8
GM
11229 staticpro (&tool_bar_item_properties);
11230 tool_bar_item_properties = Qnil;
11231 staticpro (&tool_bar_items_vector);
11232 tool_bar_items_vector = Qnil;
7ee32cda 11233
d5eecefb
RS
11234 staticpro (&real_this_command);
11235 real_this_command = Qnil;
11236
d925fb39
RS
11237 Qtimer_event_handler = intern ("timer-event-handler");
11238 staticpro (&Qtimer_event_handler);
11239
971e4c98
LT
11240 Qdisabled_command_function = intern ("disabled-command-function");
11241 staticpro (&Qdisabled_command_function);
2e894dab 11242
284f4730
JB
11243 Qself_insert_command = intern ("self-insert-command");
11244 staticpro (&Qself_insert_command);
11245
11246 Qforward_char = intern ("forward-char");
11247 staticpro (&Qforward_char);
11248
11249 Qbackward_char = intern ("backward-char");
11250 staticpro (&Qbackward_char);
11251
11252 Qdisabled = intern ("disabled");
11253 staticpro (&Qdisabled);
11254
e58aa385
RS
11255 Qundefined = intern ("undefined");
11256 staticpro (&Qundefined);
11257
86e5706b
RS
11258 Qpre_command_hook = intern ("pre-command-hook");
11259 staticpro (&Qpre_command_hook);
11260
11261 Qpost_command_hook = intern ("post-command-hook");
11262 staticpro (&Qpost_command_hook);
11263
3ef14e46
RS
11264 Qdeferred_action_function = intern ("deferred-action-function");
11265 staticpro (&Qdeferred_action_function);
11266
40932d1a
RS
11267 Qcommand_hook_internal = intern ("command-hook-internal");
11268 staticpro (&Qcommand_hook_internal);
11269
284f4730
JB
11270 Qfunction_key = intern ("function-key");
11271 staticpro (&Qfunction_key);
13b5e56c 11272 Qmouse_click = intern ("mouse-click");
284f4730 11273 staticpro (&Qmouse_click);
c16dab62 11274#if defined (WINDOWSNT) || defined (MAC_OS)
1161d367
GV
11275 Qlanguage_change = intern ("language-change");
11276 staticpro (&Qlanguage_change);
07de30b9 11277#endif
a24dc617
RS
11278 Qdrag_n_drop = intern ("drag-n-drop");
11279 staticpro (&Qdrag_n_drop);
284f4730 11280
4ebc27a5 11281 Qsave_session = intern ("save-session");
6e604a9b 11282 staticpro (&Qsave_session);
c60ee5e7 11283
f66c49cc
YM
11284#ifdef MAC_OS
11285 Qmac_apple_event = intern ("mac-apple-event");
11286 staticpro (&Qmac_apple_event);
11287#endif
11288
598a9fa7
JB
11289 Qmenu_enable = intern ("menu-enable");
11290 staticpro (&Qmenu_enable);
e8886a1d
RS
11291 Qmenu_alias = intern ("menu-alias");
11292 staticpro (&Qmenu_alias);
11293 QCenable = intern (":enable");
11294 staticpro (&QCenable);
11295 QCvisible = intern (":visible");
11296 staticpro (&QCvisible);
7ee32cda
GM
11297 QChelp = intern (":help");
11298 staticpro (&QChelp);
e8886a1d
RS
11299 QCfilter = intern (":filter");
11300 staticpro (&QCfilter);
11301 QCbutton = intern (":button");
11302 staticpro (&QCbutton);
74c1de23
RS
11303 QCkeys = intern (":keys");
11304 staticpro (&QCkeys);
11305 QCkey_sequence = intern (":key-sequence");
11306 staticpro (&QCkey_sequence);
e8886a1d
RS
11307 QCtoggle = intern (":toggle");
11308 staticpro (&QCtoggle);
11309 QCradio = intern (":radio");
11310 staticpro (&QCradio);
598a9fa7 11311
284f4730
JB
11312 Qmode_line = intern ("mode-line");
11313 staticpro (&Qmode_line);
e5d77022
JB
11314 Qvertical_line = intern ("vertical-line");
11315 staticpro (&Qvertical_line);
3c370943
JB
11316 Qvertical_scroll_bar = intern ("vertical-scroll-bar");
11317 staticpro (&Qvertical_scroll_bar);
5ec75a55
RS
11318 Qmenu_bar = intern ("menu-bar");
11319 staticpro (&Qmenu_bar);
4bb994d1 11320
ae372f41 11321#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
c22237f7
KS
11322 Qmouse_fixup_help_message = intern ("mouse-fixup-help-message");
11323 staticpro (&Qmouse_fixup_help_message);
11324#endif
11325
4bb994d1
JB
11326 Qabove_handle = intern ("above-handle");
11327 staticpro (&Qabove_handle);
11328 Qhandle = intern ("handle");
11329 staticpro (&Qhandle);
11330 Qbelow_handle = intern ("below-handle");
11331 staticpro (&Qbelow_handle);
db08707d
RS
11332 Qup = intern ("up");
11333 staticpro (&Qup);
11334 Qdown = intern ("down");
11335 staticpro (&Qdown);
7ee32cda
GM
11336 Qtop = intern ("top");
11337 staticpro (&Qtop);
11338 Qbottom = intern ("bottom");
11339 staticpro (&Qbottom);
11340 Qend_scroll = intern ("end-scroll");
11341 staticpro (&Qend_scroll);
eef28553
SM
11342 Qratio = intern ("ratio");
11343 staticpro (&Qratio);
284f4730 11344
cd21b839 11345 Qevent_kind = intern ("event-kind");
284f4730 11346 staticpro (&Qevent_kind);
88cb0656
JB
11347 Qevent_symbol_elements = intern ("event-symbol-elements");
11348 staticpro (&Qevent_symbol_elements);
0a7f1fc0
JB
11349 Qevent_symbol_element_mask = intern ("event-symbol-element-mask");
11350 staticpro (&Qevent_symbol_element_mask);
11351 Qmodifier_cache = intern ("modifier-cache");
11352 staticpro (&Qmodifier_cache);
284f4730 11353
48e416d4
RS
11354 Qrecompute_lucid_menubar = intern ("recompute-lucid-menubar");
11355 staticpro (&Qrecompute_lucid_menubar);
11356 Qactivate_menubar_hook = intern ("activate-menubar-hook");
11357 staticpro (&Qactivate_menubar_hook);
11358
f4eef8b4
RS
11359 Qpolling_period = intern ("polling-period");
11360 staticpro (&Qpolling_period);
11361
7d18f9ae
RS
11362 Qinput_method_function = intern ("input-method-function");
11363 staticpro (&Qinput_method_function);
11364
d5eecefb
RS
11365 Qinput_method_exit_on_first_char = intern ("input-method-exit-on-first-char");
11366 staticpro (&Qinput_method_exit_on_first_char);
11367 Qinput_method_use_echo_area = intern ("input-method-use-echo-area");
11368 staticpro (&Qinput_method_use_echo_area);
11369
11370 Fset (Qinput_method_exit_on_first_char, Qnil);
11371 Fset (Qinput_method_use_echo_area, Qnil);
11372
e18dfbf4 11373 last_point_position_buffer = Qnil;
bb0e1d19 11374 last_point_position_window = Qnil;
e18dfbf4 11375
284f4730
JB
11376 {
11377 struct event_head *p;
11378
11379 for (p = head_table;
11380 p < head_table + (sizeof (head_table) / sizeof (head_table[0]));
11381 p++)
11382 {
11383 *p->var = intern (p->name);
11384 staticpro (p->var);
11385 Fput (*p->var, Qevent_kind, *p->kind);
88cb0656 11386 Fput (*p->var, Qevent_symbol_elements, Fcons (*p->var, Qnil));
284f4730
JB
11387 }
11388 }
11389
8e1e4240 11390 button_down_location = Fmake_vector (make_number (1), Qnil);
7b4aedb9 11391 staticpro (&button_down_location);
8e1e4240
GM
11392 mouse_syms = Fmake_vector (make_number (1), Qnil);
11393 staticpro (&mouse_syms);
8006e4bb
JR
11394 wheel_syms = Fmake_vector (make_number (2), Qnil);
11395 staticpro (&wheel_syms);
88cb0656
JB
11396
11397 {
11398 int i;
11399 int len = sizeof (modifier_names) / sizeof (modifier_names[0]);
11400
11401 modifier_symbols = Fmake_vector (make_number (len), Qnil);
11402 for (i = 0; i < len; i++)
86e5706b
RS
11403 if (modifier_names[i])
11404 XVECTOR (modifier_symbols)->contents[i] = intern (modifier_names[i]);
88cb0656
JB
11405 staticpro (&modifier_symbols);
11406 }
11407
9deb415a
JB
11408 recent_keys = Fmake_vector (make_number (NUM_RECENT_KEYS), Qnil);
11409 staticpro (&recent_keys);
11410
6569cc8d 11411 this_command_keys = Fmake_vector (make_number (40), Qnil);
715d9345 11412 staticpro (&this_command_keys);
6569cc8d 11413
7d18f9ae
RS
11414 raw_keybuf = Fmake_vector (make_number (30), Qnil);
11415 staticpro (&raw_keybuf);
11416
03b4122a
BF
11417 Qextended_command_history = intern ("extended-command-history");
11418 Fset (Qextended_command_history, Qnil);
11419 staticpro (&Qextended_command_history);
11420
24597608
RS
11421 accent_key_syms = Qnil;
11422 staticpro (&accent_key_syms);
11423
284f4730
JB
11424 func_key_syms = Qnil;
11425 staticpro (&func_key_syms);
11426
a24dc617
RS
11427 drag_n_drop_syms = Qnil;
11428 staticpro (&drag_n_drop_syms);
07de30b9 11429
cd21b839
JB
11430 unread_switch_frame = Qnil;
11431 staticpro (&unread_switch_frame);
11432
fe412364
EN
11433 internal_last_event_frame = Qnil;
11434 staticpro (&internal_last_event_frame);
11435
11436 read_key_sequence_cmd = Qnil;
11437 staticpro (&read_key_sequence_cmd);
11438
759860a6
RS
11439 menu_bar_one_keymap_changed_items = Qnil;
11440 staticpro (&menu_bar_one_keymap_changed_items);
11441
7320c7de
KS
11442 menu_bar_items_vector = Qnil;
11443 staticpro (&menu_bar_items_vector);
11444
638d3da0
CY
11445 help_form_saved_window_configs = Qnil;
11446 staticpro (&help_form_saved_window_configs);
11447
ff458d81 11448 defsubr (&Scurrent_idle_time);
a1706c30 11449 defsubr (&Sevent_convert_list);
284f4730 11450 defsubr (&Sread_key_sequence);
e39da3d7 11451 defsubr (&Sread_key_sequence_vector);
284f4730 11452 defsubr (&Srecursive_edit);
ae372f41 11453#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
284f4730 11454 defsubr (&Strack_mouse);
2eb6bfbe 11455#endif
284f4730
JB
11456 defsubr (&Sinput_pending_p);
11457 defsubr (&Scommand_execute);
11458 defsubr (&Srecent_keys);
11459 defsubr (&Sthis_command_keys);
e39da3d7 11460 defsubr (&Sthis_command_keys_vector);
6321824f 11461 defsubr (&Sthis_single_command_keys);
7d18f9ae 11462 defsubr (&Sthis_single_command_raw_keys);
71918b75 11463 defsubr (&Sreset_this_command_lengths);
82e6e5af 11464 defsubr (&Sclear_this_command_keys);
284f4730
JB
11465 defsubr (&Ssuspend_emacs);
11466 defsubr (&Sabort_recursive_edit);
11467 defsubr (&Sexit_recursive_edit);
11468 defsubr (&Srecursion_depth);
11469 defsubr (&Stop_level);
11470 defsubr (&Sdiscard_input);
11471 defsubr (&Sopen_dribble_file);
11472 defsubr (&Sset_input_mode);
80645119 11473 defsubr (&Scurrent_input_mode);
284f4730 11474 defsubr (&Sexecute_extended_command);
ec026e7a
KS
11475 defsubr (&Sposn_at_point);
11476 defsubr (&Sposn_at_x_y);
284f4730 11477
284f4730 11478 DEFVAR_LISP ("last-command-char", &last_command_char,
4707d2d0 11479 doc: /* Last input event that was part of a command. */);
86e5706b 11480
186cf719 11481 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char,
4707d2d0 11482 doc: /* Last input event that was part of a command. */);
284f4730 11483
7d6de002 11484 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event,
4707d2d0
PJ
11485 doc: /* Last input event in a command, except for mouse menu events.
11486Mouse menus give back keys that don't look like mouse events;
11487this variable holds the actual mouse event that led to the menu,
11488so that you can determine whether the command was run by mouse or not. */);
7d6de002 11489
284f4730 11490 DEFVAR_LISP ("last-input-char", &last_input_char,
fa1361cb 11491 doc: /* Last input event. */);
86e5706b 11492
186cf719 11493 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char,
4707d2d0 11494 doc: /* Last input event. */);
284f4730 11495
24597608 11496 DEFVAR_LISP ("unread-command-events", &Vunread_command_events,
4707d2d0 11497 doc: /* List of events to be read as the command input.
96f4f7ec
KS
11498These events are processed first, before actual keyboard input.
11499Events read from this list are not normally added to `this-command-keys',
11500as they will already have been added once as they were read for the first time.
11501An element of the form (t . EVENT) forces EVENT to be added to that list. */);
7d18f9ae 11502 Vunread_command_events = Qnil;
284f4730 11503
86e5706b 11504 DEFVAR_INT ("unread-command-char", &unread_command_char,
4707d2d0 11505 doc: /* If not -1, an object to be read as next command input event. */);
86e5706b 11506
7d18f9ae 11507 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events,
4707d2d0 11508 doc: /* List of events to be processed as input by input methods.
748726f4 11509These events are processed before `unread-command-events'
7d8d0914 11510and actual keyboard input, but are not given to `input-method-function'. */);
7d18f9ae
RS
11511 Vunread_post_input_method_events = Qnil;
11512
11513 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events,
4707d2d0
PJ
11514 doc: /* List of events to be processed as input by input methods.
11515These events are processed after `unread-command-events', but
748726f4
KH
11516before actual keyboard input.
11517If there's an active input method, the events are given to
11518`input-method-function'. */);
7d18f9ae
RS
11519 Vunread_input_method_events = Qnil;
11520
284f4730 11521 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char,
4707d2d0
PJ
11522 doc: /* Meta-prefix character code.
11523Meta-foo as command input turns into this character followed by foo. */);
18cd2eeb 11524 XSETINT (meta_prefix_char, 033);
284f4730 11525
6c7178b9 11526 DEFVAR_KBOARD ("last-command", Vlast_command,
4707d2d0
PJ
11527 doc: /* The last command executed.
11528Normally a symbol with a function definition, but can be whatever was found
11529in the keymap, or whatever the variable `this-command' was set to by that
11530command.
11531
11532The value `mode-exit' is special; it means that the previous command
11533read an event that told it to exit, and it did so and unread that event.
11534In other words, the present command is the event that made the previous
11535command exit.
11536
11537The value `kill-region' is special; it means that the previous command
11538was a kill command. */);
284f4730 11539
75045dcb 11540 DEFVAR_KBOARD ("real-last-command", Vreal_last_command,
4707d2d0 11541 doc: /* Same as `last-command', but never altered by Lisp code. */);
75045dcb 11542
d5eecefb 11543 DEFVAR_LISP ("this-command", &Vthis_command,
4707d2d0
PJ
11544 doc: /* The command now being executed.
11545The command can set this variable; whatever is put here
11546will be in `last-command' during the following command. */);
d5eecefb 11547 Vthis_command = Qnil;
284f4730 11548
8b9940e6 11549 DEFVAR_LISP ("this-original-command", &Vthis_original_command,
f5613d1e
KS
11550 doc: /* The command bound to the current key sequence before remapping.
11551It equals `this-command' if the original command was not remapped through
11552any of the active keymaps. Otherwise, the value of `this-command' is the
177c0ea7 11553result of looking up the original command in the active keymaps. */);
8b9940e6
KS
11554 Vthis_original_command = Qnil;
11555
284f4730 11556 DEFVAR_INT ("auto-save-interval", &auto_save_interval,
4707d2d0
PJ
11557 doc: /* *Number of input events between auto-saves.
11558Zero means disable autosaving due to number of characters typed. */);
284f4730
JB
11559 auto_save_interval = 300;
11560
11561 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout,
4707d2d0
PJ
11562 doc: /* *Number of seconds idle time before auto-save.
11563Zero or nil means disable auto-saving due to idleness.
11564After auto-saving due to this many seconds of idle time,
11565Emacs also does a garbage collection if that seems to be warranted. */);
bb9e9bed 11566 XSETFASTINT (Vauto_save_timeout, 30);
284f4730 11567
39aab679 11568 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes,
4707d2d0
PJ
11569 doc: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11570The value may be integer or floating point. */);
39aab679 11571 Vecho_keystrokes = make_number (1);
284f4730
JB
11572
11573 DEFVAR_INT ("polling-period", &polling_period,
4707d2d0
PJ
11574 doc: /* *Interval between polling for input during Lisp execution.
11575The reason for polling is to make C-g work to stop a running program.
11576Polling is needed only when using X windows and SIGIO does not work.
11577Polling is automatically disabled in all other cases. */);
284f4730 11578 polling_period = 2;
df0f2ba1 11579
564dc952 11580 DEFVAR_LISP ("double-click-time", &Vdouble_click_time,
4707d2d0 11581 doc: /* *Maximum time between mouse clicks to make a double-click.
05e0ac99
JB
11582Measured in milliseconds. The value nil means disable double-click
11583recognition; t means double-clicks have no time limit and are detected
4707d2d0 11584by position only. */);
aab06933 11585 Vdouble_click_time = make_number (500);
fbcd35bd 11586
222d557c 11587 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz,
4707d2d0
PJ
11588 doc: /* *Maximum mouse movement between clicks to make a double-click.
11589On window-system frames, value is the number of pixels the mouse may have
11590moved horizontally or vertically between two clicks to make a double-click.
11591On non window-system frames, value is interpreted in units of 1/8 characters
1ca6a9c4
RS
11592instead of pixels.
11593
11594This variable is also the threshold for motion of the mouse
11595to count as a drag. */);
222d557c 11596 double_click_fuzz = 3;
c60ee5e7 11597
03361bcc 11598 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus,
4707d2d0 11599 doc: /* *Non-nil means inhibit local map menu bar menus. */);
03361bcc
RS
11600 inhibit_local_menu_bar_menus = 0;
11601
284f4730 11602 DEFVAR_INT ("num-input-keys", &num_input_keys,
4707d2d0
PJ
11603 doc: /* Number of complete key sequences read as input so far.
11604This includes key sequences read from keyboard macros.
11605The number is effectively the number of interactive command invocations. */);
284f4730
JB
11606 num_input_keys = 0;
11607
c43b1734 11608 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events,
4707d2d0
PJ
11609 doc: /* Number of input events read from the keyboard so far.
11610This does not include events generated by keyboard macros. */);
c43b1734 11611 num_nonmacro_input_events = 0;
fa90970d 11612
4c52b668 11613 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame,
4707d2d0
PJ
11614 doc: /* The frame in which the most recently read event occurred.
11615If the last event came from a keyboard macro, this is set to `macro'. */);
4c52b668
KH
11616 Vlast_event_frame = Qnil;
11617
fa90970d
RS
11618 /* This variable is set up in sysdep.c. */
11619 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char,
4707d2d0 11620 doc: /* The ERASE character as set by the user with stty. */);
fa90970d 11621
7e85b935 11622 DEFVAR_LISP ("help-char", &Vhelp_char,
4707d2d0
PJ
11623 doc: /* Character to recognize as meaning Help.
11624When it is read, do `(eval help-form)', and display result if it's a string.
11625If the value of `help-form' is nil, this char can be read normally. */);
18cd2eeb 11626 XSETINT (Vhelp_char, Ctl ('H'));
284f4730 11627
ecb7cb34 11628 DEFVAR_LISP ("help-event-list", &Vhelp_event_list,
4707d2d0
PJ
11629 doc: /* List of input events to recognize as meaning Help.
11630These work just like the value of `help-char' (see that). */);
ecb7cb34
KH
11631 Vhelp_event_list = Qnil;
11632
284f4730 11633 DEFVAR_LISP ("help-form", &Vhelp_form,
4707d2d0
PJ
11634 doc: /* Form to execute when character `help-char' is read.
11635If the form returns a string, that string is displayed.
11636If `help-form' is nil, the help char is not recognized. */);
284f4730
JB
11637 Vhelp_form = Qnil;
11638
7e85b935 11639 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command,
4707d2d0
PJ
11640 doc: /* Command to run when `help-char' character follows a prefix key.
11641This command is used only when there is no actual binding
11642for that character after that prefix key. */);
7e85b935
RS
11643 Vprefix_help_command = Qnil;
11644
284f4730 11645 DEFVAR_LISP ("top-level", &Vtop_level,
4707d2d0
PJ
11646 doc: /* Form to evaluate when Emacs starts up.
11647Useful to set before you dump a modified Emacs. */);
284f4730
JB
11648 Vtop_level = Qnil;
11649
11650 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table,
4707d2d0 11651 doc: /* Translate table for keyboard input, or nil.
669de2fb
LT
11652If non-nil, the value should be a char-table. Each character read
11653from the keyboard is looked up in this char-table. If the value found
11654there is non-nil, then it is used instead of the actual input character.
11655
11656The value can also be a string or vector, but this is considered obsolete.
11657If it is a string or vector of length N, character codes N and up are left
11658untranslated. In a vector, an element which is nil means "no translation".
a0acc6c7
DL
11659
11660This is applied to the characters supplied to input methods, not their
11661output. See also `translation-table-for-input'. */);
284f4730
JB
11662 Vkeyboard_translate_table = Qnil;
11663
8026024c 11664 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend,
4707d2d0
PJ
11665 doc: /* Non-nil means to always spawn a subshell instead of suspending.
11666\(Even if the operating system has support for stopping a process.\) */);
8026024c
KH
11667 cannot_suspend = 0;
11668
284f4730 11669 DEFVAR_BOOL ("menu-prompting", &menu_prompting,
4707d2d0
PJ
11670 doc: /* Non-nil means prompt with menus when appropriate.
11671This is done when reading from a keymap that has a prompt string,
11672for elements that have prompt strings.
11673The menu is displayed on the screen
11674if X menus were enabled at configuration
11675time and the previous event was a mouse click prefix key.
11676Otherwise, menu prompting uses the echo area. */);
284f4730
JB
11677 menu_prompting = 1;
11678
11679 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char,
4707d2d0
PJ
11680 doc: /* Character to see next line of menu prompt.
11681Type this character while in a menu prompt to rotate around the lines of it. */);
18cd2eeb 11682 XSETINT (menu_prompt_more_char, ' ');
9fa4395d
RS
11683
11684 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers,
4707d2d0
PJ
11685 doc: /* A mask of additional modifier keys to use with every keyboard character.
11686Emacs applies the modifiers of the character stored here to each keyboard
11687character it reads. For example, after evaluating the expression
11688 (setq extra-keyboard-modifiers ?\\C-x)
11689all input characters will have the control modifier applied to them.
11690
11691Note that the character ?\\C-@, equivalent to the integer zero, does
11692not count as a control character; rather, it counts as a character
11693with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11694cancels any modification. */);
9fa4395d 11695 extra_keyboard_modifiers = 0;
86e5706b
RS
11696
11697 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark,
4707d2d0
PJ
11698 doc: /* If an editing command sets this to t, deactivate the mark afterward.
11699The command loop sets this to nil before each command,
11700and tests the value when the command returns.
11701Buffer modification stores t in this variable. */);
86e5706b
RS
11702 Vdeactivate_mark = Qnil;
11703
b0f2a7bf 11704 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal,
4707d2d0 11705 doc: /* Temporary storage of pre-command-hook or post-command-hook. */);
b0f2a7bf
KH
11706 Vcommand_hook_internal = Qnil;
11707
86e5706b 11708 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook,
4707d2d0
PJ
11709 doc: /* Normal hook run before each command is executed.
11710If an unhandled error happens in running this hook,
11711the hook value is set to nil, since otherwise the error
11712might happen repeatedly and make Emacs nonfunctional. */);
86e5706b
RS
11713 Vpre_command_hook = Qnil;
11714
11715 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook,
4707d2d0
PJ
11716 doc: /* Normal hook run after each command is executed.
11717If an unhandled error happens in running this hook,
11718the hook value is set to nil, since otherwise the error
11719might happen repeatedly and make Emacs nonfunctional. */);
86e5706b 11720 Vpost_command_hook = Qnil;
48e416d4 11721
cf24f894
RS
11722#if 0
11723 DEFVAR_LISP ("echo-area-clear-hook", ...,
4707d2d0 11724 doc: /* Normal hook run when clearing the echo area. */);
cf24f894
RS
11725#endif
11726 Qecho_area_clear_hook = intern ("echo-area-clear-hook");
c8e16a02 11727 staticpro (&Qecho_area_clear_hook);
cf24f894 11728 SET_SYMBOL_VALUE (Qecho_area_clear_hook, Qnil);
cdb9d665 11729
48e416d4 11730 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag,
fa1361cb 11731 doc: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
48e416d4 11732 Vlucid_menu_bar_dirty_flag = Qnil;
a73c5e29 11733
9f9c0e27 11734 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items,
4707d2d0
PJ
11735 doc: /* List of menu bar items to move to the end of the menu bar.
11736The elements of the list are event types that may have menu bar bindings. */);
9f9c0e27 11737 Vmenu_bar_final_items = Qnil;
e9bf89a0 11738
217258d5
KH
11739 DEFVAR_KBOARD ("overriding-terminal-local-map",
11740 Voverriding_terminal_local_map,
4707d2d0
PJ
11741 doc: /* Per-terminal keymap that overrides all other local keymaps.
11742If this variable is non-nil, it is used as a keymap instead of the
11743buffer's local map, and the minor mode keymaps and text property keymaps.
5a45dd33
RS
11744It also replaces `overriding-local-map'.
11745
4707d2d0
PJ
11746This variable is intended to let commands such as `universal-argument'
11747set up a different keymap for reading the next command. */);
217258d5 11748
9dd3131c 11749 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map,
4707d2d0 11750 doc: /* Keymap that overrides all other local keymaps.
5a45dd33
RS
11751If this variable is non-nil, it is used as a keymap--replacing the
11752buffer's local map, the minor mode keymaps, and char property keymaps. */);
9dd3131c
RS
11753 Voverriding_local_map = Qnil;
11754
d0a49716 11755 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag,
4707d2d0
PJ
11756 doc: /* Non-nil means `overriding-local-map' applies to the menu bar.
11757Otherwise, the menu bar continues to reflect the buffer's local map
11758and the minor mode maps regardless of `overriding-local-map'. */);
d0a49716
RS
11759 Voverriding_local_map_menu_flag = Qnil;
11760
7f07d5ca 11761 DEFVAR_LISP ("special-event-map", &Vspecial_event_map,
4707d2d0 11762 doc: /* Keymap defining bindings for special events to execute at low level. */);
7f07d5ca
RS
11763 Vspecial_event_map = Fcons (intern ("keymap"), Qnil);
11764
71edead1 11765 DEFVAR_LISP ("track-mouse", &do_mouse_tracking,
4707d2d0 11766 doc: /* *Non-nil means generate motion events for mouse motion. */);
80e4aa30 11767
7c97ffdc 11768 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist,
4707d2d0
PJ
11769 doc: /* Alist of system-specific X windows key symbols.
11770Each element should have the form (N . SYMBOL) where N is the
11771numeric keysym code (sans the \"system-specific\" bit 1<<28)
11772and SYMBOL is its name. */);
8a792f3a
RS
11773
11774 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list,
4707d2d0
PJ
11775 doc: /* List of deferred actions to be performed at a later time.
11776The precise format isn't relevant here; we just check whether it is nil. */);
8a792f3a
RS
11777 Vdeferred_action_list = Qnil;
11778
11779 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function,
4707d2d0
PJ
11780 doc: /* Function to call to handle deferred actions, after each command.
11781This function is called with no arguments after each command
11782whenever `deferred-action-list' is non-nil. */);
8a792f3a 11783 Vdeferred_action_function = Qnil;
6526ab49
RS
11784
11785 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings,
4707d2d0
PJ
11786 doc: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11787The value can be a length of time to show the message for.
11788If the value is non-nil and not a number, we wait 2 seconds. */);
6526ab49 11789 Vsuggest_key_bindings = Qt;
8bb1c042 11790
c04cbc3b 11791 DEFVAR_LISP ("timer-list", &Vtimer_list,
4707d2d0 11792 doc: /* List of active absolute time timers in order of increasing time. */);
c04cbc3b 11793 Vtimer_list = Qnil;
d9d4c147
KH
11794
11795 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list,
4707d2d0 11796 doc: /* List of active idle-time timers in order of increasing time. */);
d9d4c147 11797 Vtimer_idle_list = Qnil;
7d18f9ae
RS
11798
11799 DEFVAR_LISP ("input-method-function", &Vinput_method_function,
4707d2d0
PJ
11800 doc: /* If non-nil, the function that implements the current input method.
11801It's called with one argument, a printing character that was just read.
11802\(That means a character with code 040...0176.)
11803Typically this function uses `read-event' to read additional events.
11804When it does so, it should first bind `input-method-function' to nil
11805so it will not be called recursively.
11806
11807The function should return a list of zero or more events
11808to be used as input. If it wants to put back some events
11809to be reconsidered, separately, by the input method,
11810it can add them to the beginning of `unread-command-events'.
11811
11812The input method function can find in `input-method-previous-method'
11813the previous echo area message.
11814
11815The input method function should refer to the variables
11816`input-method-use-echo-area' and `input-method-exit-on-first-char'
11817for guidance on what to do. */);
7d18f9ae 11818 Vinput_method_function = Qnil;
d5eecefb
RS
11819
11820 DEFVAR_LISP ("input-method-previous-message",
11821 &Vinput_method_previous_message,
4707d2d0
PJ
11822 doc: /* When `input-method-function' is called, hold the previous echo area message.
11823This variable exists because `read-event' clears the echo area
11824before running the input method. It is nil if there was no message. */);
d5eecefb 11825 Vinput_method_previous_message = Qnil;
7ee32cda
GM
11826
11827 DEFVAR_LISP ("show-help-function", &Vshow_help_function,
4707d2d0
PJ
11828 doc: /* If non-nil, the function that implements the display of help.
11829It's called with one argument, the help string to display. */);
7ee32cda 11830 Vshow_help_function = Qnil;
adf5cb9c
KH
11831
11832 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment,
4707d2d0
PJ
11833 doc: /* If non-nil, suppress point adjustment after executing a command.
11834
11835After a command is executed, if point is moved into a region that has
11836special properties (e.g. composition, display), we adjust point to
5fee9a2f
LT
11837the boundary of the region. But, when a command sets this variable to
11838non-nil, we suppress the point adjustment.
4707d2d0
PJ
11839
11840This variable is set to nil before reading a command, and is checked
11841just after executing the command. */);
adf5cb9c
KH
11842 Vdisable_point_adjustment = Qnil;
11843
11844 DEFVAR_LISP ("global-disable-point-adjustment",
11845 &Vglobal_disable_point_adjustment,
4707d2d0
PJ
11846 doc: /* *If non-nil, always suppress point adjustment.
11847
11848The default value is nil, in which case, point adjustment are
11849suppressed only after special commands that set
11850`disable-point-adjustment' (which see) to non-nil. */);
adf5cb9c 11851 Vglobal_disable_point_adjustment = Qnil;
3626fb1a 11852
00392ce6 11853 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout,
4707d2d0
PJ
11854 doc: /* *How long to display an echo-area message when the minibuffer is active.
11855If the value is not a number, such messages don't time out. */);
00392ce6 11856 Vminibuffer_message_timeout = make_number (2);
2a84c6da
KS
11857
11858 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input,
11859 doc: /* If non-nil, any keyboard input throws to this symbol.
11860The value of that variable is passed to `quit-flag' and later causes a
11861peculiar kind of quitting. */);
11862 Vthrow_on_input = Qnil;
9d56e0da 11863
04d8c47d
RS
11864 DEFVAR_LISP ("command-error-function", &Vcommand_error_function,
11865 doc: /* If non-nil, function to output error messages.
11866The arguments are the error data, a list of the form
11867 (SIGNALED-CONDITIONS . SIGNAL-DATA)
11868such as just as `condition-case' would bind its variable to,
11869the context (a string which normally goes at the start of the message),
11870and the Lisp function within which the error was signaled. */);
11871 Vcommand_error_function = Qnil;
11872
9d56e0da
EZ
11873 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11874 &Venable_disabled_menus_and_buttons,
11875 doc: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11876
11877Help functions bind this to allow help on disabled menu items
11878and tool-bar buttons. */);
11879 Venable_disabled_menus_and_buttons = Qnil;
284f4730
JB
11880}
11881
dfcf069d 11882void
284f4730
JB
11883keys_of_keyboard ()
11884{
11885 initial_define_key (global_map, Ctl ('Z'), "suspend-emacs");
11886 initial_define_key (control_x_map, Ctl ('Z'), "suspend-emacs");
11887 initial_define_key (meta_map, Ctl ('C'), "exit-recursive-edit");
11888 initial_define_key (global_map, Ctl (']'), "abort-recursive-edit");
11889 initial_define_key (meta_map, 'x', "execute-extended-command");
7f07d5ca
RS
11890
11891 initial_define_lispy_key (Vspecial_event_map, "delete-frame",
11892 "handle-delete-frame");
a18bf897
SM
11893 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11894 current-prefix-arg, as is done in `handle-switch-frame'.
11895 But `handle-switch-frame is not run from the special-map.
11896 Commands from that map are run in a special way that automatically
11897 preserves the prefix-arg. Restoring the prefix arg here is not just
11898 redundant but harmful:
11899 - C-u C-x v =
11900 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11901 - after the first prompt, the exit-minibuffer-hook is run which may
11902 iconify a frame and thus push a `iconify-frame' event.
11903 - after running exit-minibuffer-hook, current-prefix-arg is
11904 restored to the non-nil value it had before the prompt.
11905 - we enter the second prompt.
11906 current-prefix-arg is non-nil, prefix-arg is nil.
11907 - before running the first real event, we run the special iconify-frame
11908 event, but we pass the `special' arg to execute-command so
11909 current-prefix-arg and prefix-arg are left untouched.
11910 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11911 - the next key event will have a spuriously non-nil current-prefix-arg. */
7f07d5ca 11912 initial_define_lispy_key (Vspecial_event_map, "iconify-frame",
a18bf897 11913 "ignore");
7f07d5ca 11914 initial_define_lispy_key (Vspecial_event_map, "make-frame-visible",
a18bf897 11915 "ignore");
a4e19f6e
SM
11916 /* Handling it at such a low-level causes read_key_sequence to get
11917 * confused because it doesn't realize that the current_buffer was
11918 * changed by read_char.
2320865d 11919 *
a4e19f6e
SM
11920 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11921 * "handle-select-window"); */
4ebc27a5
JD
11922 initial_define_lispy_key (Vspecial_event_map, "save-session",
11923 "handle-save-session");
284f4730 11924}
1269a761
SM
11925
11926/* Mark the pointers in the kboard objects.
11927 Called by the Fgarbage_collector. */
11928void
11929mark_kboards ()
11930{
11931 KBOARD *kb;
11932 Lisp_Object *p;
11933 for (kb = all_kboards; kb; kb = kb->next_kboard)
11934 {
11935 if (kb->kbd_macro_buffer)
11936 for (p = kb->kbd_macro_buffer; p < kb->kbd_macro_ptr; p++)
3ebb8729
SM
11937 mark_object (*p);
11938 mark_object (kb->Voverriding_terminal_local_map);
11939 mark_object (kb->Vlast_command);
11940 mark_object (kb->Vreal_last_command);
11941 mark_object (kb->Vprefix_arg);
11942 mark_object (kb->Vlast_prefix_arg);
11943 mark_object (kb->kbd_queue);
11944 mark_object (kb->defining_kbd_macro);
11945 mark_object (kb->Vlast_kbd_macro);
11946 mark_object (kb->Vsystem_key_alist);
11947 mark_object (kb->system_key_syms);
11948 mark_object (kb->Vdefault_minibuffer_frame);
11949 mark_object (kb->echo_string);
1269a761
SM
11950 }
11951 {
11952 struct input_event *event;
11953 for (event = kbd_fetch_ptr; event != kbd_store_ptr; event++)
11954 {
11955 if (event == kbd_buffer + KBD_BUFFER_SIZE)
11956 event = kbd_buffer;
e3f6e7c7
KS
11957 if (event->kind != SELECTION_REQUEST_EVENT
11958 && event->kind != SELECTION_CLEAR_EVENT)
0161caf9
KS
11959 {
11960 mark_object (event->x);
11961 mark_object (event->y);
11962 }
3ebb8729
SM
11963 mark_object (event->frame_or_window);
11964 mark_object (event->arg);
1269a761
SM
11965 }
11966 }
11967}
ab5796a9
MB
11968
11969/* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11970 (do not change this comment) */