(syms_of_fileio) <directory-sep-char>: Doc fix.
[bpt/emacs.git] / src / keyboard.c
CommitLineData
284f4730 1/* Keyboard and mouse input; editor command loop.
f9f1e1fc 2 Copyright (C) 1985,86,87,88,89,93,94,95,96,97,99, 2000, 01, 02
39aab679 3 Free Software Foundation, Inc.
284f4730
JB
4
5This file is part of GNU Emacs.
6
7GNU Emacs is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
7b4aedb9 9the Free Software Foundation; either version 2, or (at your option)
284f4730
JB
10any later version.
11
12GNU Emacs is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GNU Emacs; see the file COPYING. If not, write to
3b7ad313
EN
19the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20Boston, MA 02111-1307, USA. */
284f4730 21
18160b98 22#include <config.h>
68c45bf0 23#include <signal.h>
284f4730 24#include <stdio.h>
284f4730
JB
25#include "termchar.h"
26#include "termopts.h"
27#include "lisp.h"
28#include "termhooks.h"
29#include "macros.h"
02639609 30#include "keyboard.h"
ff11dfa1 31#include "frame.h"
284f4730
JB
32#include "window.h"
33#include "commands.h"
34#include "buffer.h"
37cd9f30 35#include "charset.h"
284f4730 36#include "disptab.h"
f4255cd1 37#include "dispextern.h"
e39da3d7 38#include "syntax.h"
497ba7a1 39#include "intervals.h"
bdb7aa47 40#include "keymap.h"
9ac0d9e0 41#include "blockinput.h"
e8886a1d 42#include "puresize.h"
8a9f5d3c
GM
43#include "systime.h"
44#include "atimer.h"
284f4730
JB
45#include <setjmp.h>
46#include <errno.h>
47
80e4aa30
RS
48#ifdef MSDOS
49#include "msdos.h"
50#include <time.h>
51#else /* not MSDOS */
284f4730
JB
52#ifndef VMS
53#include <sys/ioctl.h>
284f4730 54#endif
80e4aa30 55#endif /* not MSDOS */
284f4730 56
52baf19e 57#include "syssignal.h"
6ef5b54f 58#include "systty.h"
52baf19e 59
03cee6ae
GM
60#include <sys/types.h>
61#ifdef HAVE_UNISTD_H
62#include <unistd.h>
63#endif
64
c5e3b6c5
RS
65/* This is to get the definitions of the XK_ symbols. */
66#ifdef HAVE_X_WINDOWS
67#include "xterm.h"
68#endif
69
e98a93eb
GV
70#ifdef HAVE_NTGUI
71#include "w32term.h"
72#endif /* HAVE_NTGUI */
73
e0f712ba 74#ifdef MAC_OS
1a578e9b
AC
75#include "macterm.h"
76#endif
77
02639609 78#ifndef USE_CRT_DLL
52baf19e 79extern int errno;
02639609 80#endif
52baf19e 81
9ac0d9e0
JB
82/* Variables for blockinput.h: */
83
84/* Non-zero if interrupt input is blocked right now. */
63927c41 85int interrupt_input_blocked;
9ac0d9e0
JB
86
87/* Nonzero means an input interrupt has arrived
88 during the current critical section. */
63927c41 89int interrupt_input_pending;
9ac0d9e0
JB
90
91
437f6112
RS
92/* File descriptor to use for input. */
93extern int input_fd;
284f4730 94
e98a93eb 95#ifdef HAVE_WINDOW_SYSTEM
284f4730 96/* Make all keyboard buffers much bigger when using X windows. */
e0f712ba
AC
97#ifdef MAC_OS8
98/* But not too big (local data > 32K error) if on Mac OS Classic. */
f019cded
RS
99#define KBD_BUFFER_SIZE 512
100#else
284f4730 101#define KBD_BUFFER_SIZE 4096
f019cded 102#endif
284f4730 103#else /* No X-windows, character input */
de11c1ea 104#define KBD_BUFFER_SIZE 4096
284f4730
JB
105#endif /* No X-windows */
106
222d557c
GM
107#define abs(x) ((x) >= 0 ? (x) : -(x))
108
284f4730
JB
109/* Following definition copied from eval.c */
110
111struct backtrace
112 {
113 struct backtrace *next;
114 Lisp_Object *function;
115 Lisp_Object *args; /* Points to vector of args. */
116 int nargs; /* length of vector. If nargs is UNEVALLED,
117 args points to slot holding list of
118 unevalled args */
119 char evalargs;
120 };
121
c5fdd383
KH
122#ifdef MULTI_KBOARD
123KBOARD *initial_kboard;
124KBOARD *current_kboard;
125KBOARD *all_kboards;
1e8bd3da 126int single_kboard;
6c6083a9 127#else
c5fdd383 128KBOARD the_only_kboard;
6c6083a9 129#endif
612b78ef 130
284f4730
JB
131/* Non-nil disable property on a command means
132 do not execute it; call disabled-command-hook's value instead. */
2e894dab 133Lisp_Object Qdisabled, Qdisabled_command_hook;
284f4730
JB
134
135#define NUM_RECENT_KEYS (100)
136int recent_keys_index; /* Index for storing next element into recent_keys */
137int total_keys; /* Total number of elements stored into recent_keys */
5160df46 138Lisp_Object recent_keys; /* A vector, holding the last 100 keystrokes */
284f4730 139
6569cc8d
JB
140/* Vector holding the key sequence that invoked the current command.
141 It is reused for each command, and it may be longer than the current
142 sequence; this_command_key_count indicates how many elements
143 actually mean something.
144 It's easier to staticpro a single Lisp_Object than an array. */
145Lisp_Object this_command_keys;
146int this_command_key_count;
284f4730 147
7d18f9ae
RS
148/* This vector is used as a buffer to record the events that were actually read
149 by read_key_sequence. */
150Lisp_Object raw_keybuf;
151int raw_keybuf_count;
152
153#define GROW_RAW_KEYBUF \
7189cad8 154 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
7d18f9ae
RS
155 { \
156 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
157 Lisp_Object new; \
158 new = Fmake_vector (make_number (newsize), Qnil); \
159 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
160 raw_keybuf_count * sizeof (Lisp_Object)); \
161 raw_keybuf = new; \
162 }
163
6321824f
RS
164/* Number of elements of this_command_keys
165 that precede this key sequence. */
166int this_single_command_key_start;
167
71918b75
RS
168/* Record values of this_command_key_count and echo_length ()
169 before this command was read. */
170static int before_command_key_count;
171static int before_command_echo_length;
172/* Values of before_command_key_count and before_command_echo_length
173 saved by reset-this-command-lengths. */
174static int before_command_key_count_1;
175static int before_command_echo_length_1;
176/* Flag set by reset-this-command-lengths,
177 saying to reset the lengths when add_command_key is called. */
178static int before_command_restore_flag;
179
284f4730
JB
180extern int minbuf_level;
181
a59b172a
RS
182extern int message_enable_multibyte;
183
284f4730
JB
184extern struct backtrace *backtrace_list;
185
7ee32cda
GM
186/* If non-nil, the function that implements the display of help.
187 It's called with one argument, the help string to display. */
188
189Lisp_Object Vshow_help_function;
190
f0c1cc56
GM
191/* If a string, the message displayed before displaying a help-echo
192 in the echo area. */
193
194Lisp_Object Vpre_help_message;
195
284f4730 196/* Nonzero means do menu prompting. */
f0c1cc56 197
284f4730
JB
198static int menu_prompting;
199
200/* Character to see next line of menu prompt. */
f0c1cc56 201
284f4730
JB
202static Lisp_Object menu_prompt_more_char;
203
204/* For longjmp to where kbd input is being done. */
f0c1cc56 205
284f4730
JB
206static jmp_buf getcjmp;
207
208/* True while doing kbd input. */
209int waiting_for_input;
210
211/* True while displaying for echoing. Delays C-g throwing. */
985f9f66 212
c843d6c6 213int echoing;
284f4730 214
985f9f66
GM
215/* Non-null means we can start echoing at the next input pause even
216 though there is something in the echo area. */
217
218static struct kboard *ok_to_echo_at_next_pause;
219
59a84f8e
GM
220/* The kboard last echoing, or null for none. Reset to 0 in
221 cancel_echoing. If non-null, and a current echo area message
222 exists, and echo_message_buffer is eq to the current message
223 buffer, we know that the message comes from echo_kboard. */
985f9f66 224
f49aedfd 225struct kboard *echo_kboard;
1fc93d49 226
59a84f8e
GM
227/* The buffer used for echoing. Set in echo_now, reset in
228 cancel_echoing. */
229
c843d6c6 230Lisp_Object echo_message_buffer;
59a84f8e 231
03361bcc
RS
232/* Nonzero means disregard local maps for the menu bar. */
233static int inhibit_local_menu_bar_menus;
234
80e4aa30 235/* Nonzero means C-g should cause immediate error-signal. */
284f4730
JB
236int immediate_quit;
237
fa90970d
RS
238/* The user's ERASE setting. */
239Lisp_Object Vtty_erase_char;
240
284f4730 241/* Character to recognize as the help char. */
7e85b935 242Lisp_Object Vhelp_char;
284f4730 243
ecb7cb34
KH
244/* List of other event types to recognize as meaning "help". */
245Lisp_Object Vhelp_event_list;
246
284f4730
JB
247/* Form to execute when help char is typed. */
248Lisp_Object Vhelp_form;
249
7e85b935
RS
250/* Command to run when the help character follows a prefix key. */
251Lisp_Object Vprefix_help_command;
252
9f9c0e27
RS
253/* List of items that should move to the end of the menu bar. */
254Lisp_Object Vmenu_bar_final_items;
a73c5e29 255
6526ab49
RS
256/* Non-nil means show the equivalent key-binding for
257 any M-x command that has one.
258 The value can be a length of time to show the message for.
259 If the value is non-nil and not a number, we wait 2 seconds. */
260Lisp_Object Vsuggest_key_bindings;
261
00392ce6
MB
262/* How long to display an echo-area message when the minibuffer is active.
263 If the value is not a number, such messages don't time out. */
264Lisp_Object Vminibuffer_message_timeout;
265
284f4730
JB
266/* Character that causes a quit. Normally C-g.
267
268 If we are running on an ordinary terminal, this must be an ordinary
269 ASCII char, since we want to make it our interrupt character.
270
271 If we are not running on an ordinary terminal, it still needs to be
272 an ordinary ASCII char. This character needs to be recognized in
273 the input interrupt handler. At this point, the keystroke is
274 represented as a struct input_event, while the desired quit
275 character is specified as a lispy event. The mapping from struct
276 input_events to lispy events cannot run in an interrupt handler,
277 and the reverse mapping is difficult for anything but ASCII
278 keystrokes.
279
280 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
281 ASCII character. */
282int quit_char;
283
284extern Lisp_Object current_global_map;
285extern int minibuf_level;
286
9dd3131c
RS
287/* If non-nil, this is a map that overrides all other local maps. */
288Lisp_Object Voverriding_local_map;
289
d0a49716
RS
290/* If non-nil, Voverriding_local_map applies to the menu bar. */
291Lisp_Object Voverriding_local_map_menu_flag;
292
7f07d5ca
RS
293/* Keymap that defines special misc events that should
294 be processed immediately at a low level. */
295Lisp_Object Vspecial_event_map;
296
284f4730
JB
297/* Current depth in recursive edits. */
298int command_loop_level;
299
300/* Total number of times command_loop has read a key sequence. */
31ade731 301EMACS_INT num_input_keys;
284f4730
JB
302
303/* Last input character read as a command. */
304Lisp_Object last_command_char;
305
7d6de002
RS
306/* Last input character read as a command, not counting menus
307 reached by the mouse. */
308Lisp_Object last_nonmenu_event;
309
284f4730
JB
310/* Last input character read for any purpose. */
311Lisp_Object last_input_char;
312
dbc4e1c1 313/* If not Qnil, a list of objects to be read as subsequent command input. */
24597608 314Lisp_Object Vunread_command_events;
284f4730 315
7d18f9ae
RS
316/* If not Qnil, a list of objects to be read as subsequent command input
317 including input method processing. */
318Lisp_Object Vunread_input_method_events;
319
320/* If not Qnil, a list of objects to be read as subsequent command input
321 but NOT including input method processing. */
322Lisp_Object Vunread_post_input_method_events;
323
86e5706b 324/* If not -1, an event to be read as subsequent command input. */
31ade731 325EMACS_INT unread_command_char;
86e5706b 326
cd21b839
JB
327/* If not Qnil, this is a switch-frame event which we decided to put
328 off until the end of a key sequence. This should be read as the
dbc4e1c1 329 next command input, after any unread_command_events.
8f805655
JB
330
331 read_key_sequence uses this to delay switch-frame events until the
332 end of the key sequence; Fread_char uses it to put off switch-frame
333 events until a non-ASCII event is acceptable as input. */
334Lisp_Object unread_switch_frame;
cd21b839 335
9fa4395d 336/* A mask of extra modifier bits to put into every keyboard char. */
31ade731 337EMACS_INT extra_keyboard_modifiers;
9fa4395d 338
284f4730
JB
339/* Char to use as prefix when a meta character is typed in.
340 This is bound on entry to minibuffer in case ESC is changed there. */
341
342Lisp_Object meta_prefix_char;
343
344/* Last size recorded for a current buffer which is not a minibuffer. */
345static int last_non_minibuf_size;
346
06ef7355 347/* Number of idle seconds before an auto-save and garbage collection. */
284f4730
JB
348static Lisp_Object Vauto_save_timeout;
349
350/* Total number of times read_char has returned. */
4abfba1f 351int num_input_events;
284f4730 352
51172b6d 353/* Total number of times read_char has returned, outside of macros. */
31ade731 354EMACS_INT num_nonmacro_input_events;
51172b6d 355
284f4730
JB
356/* Auto-save automatically when this many characters have been typed
357 since the last time. */
358
31ade731 359static EMACS_INT auto_save_interval;
284f4730 360
c43b1734 361/* Value of num_nonmacro_input_events as of last auto save. */
284f4730
JB
362
363int last_auto_save;
364
284f4730 365/* The command being executed by the command loop.
6c7178b9
KH
366 Commands may set this, and the value set will be copied into
367 current_kboard->Vlast_command instead of the actual command. */
d5eecefb
RS
368Lisp_Object Vthis_command;
369
370/* This is like Vthis_command, except that commands never set it. */
371Lisp_Object real_this_command;
284f4730 372
8b9940e6
KS
373/* If the lookup of the command returns a binding, the original
374 command is stored in this-original-command. It is nil otherwise. */
375Lisp_Object Vthis_original_command;
376
b453f72e
KH
377/* The value of point when the last command was executed. */
378int last_point_position;
379
047688cb
RS
380/* The buffer that was current when the last command was started. */
381Lisp_Object last_point_position_buffer;
382
4c52b668
KH
383/* The frame in which the last input event occurred, or Qmacro if the
384 last event came from a macro. We use this to determine when to
385 generate switch-frame events. This may be cleared by functions
386 like Fselect_frame, to make sure that a switch-frame event is
387 generated by the next character. */
388Lisp_Object internal_last_event_frame;
4c52b668
KH
389
390/* A user-visible version of the above, intended to allow users to
391 figure out where the last event came from, if the event doesn't
392 carry that information itself (i.e. if it was a character). */
393Lisp_Object Vlast_event_frame;
394
1113d9db
JB
395/* The timestamp of the last input event we received from the X server.
396 X Windows wants this for selection ownership. */
284f4730
JB
397unsigned long last_event_timestamp;
398
399Lisp_Object Qself_insert_command;
400Lisp_Object Qforward_char;
401Lisp_Object Qbackward_char;
e58aa385 402Lisp_Object Qundefined;
d925fb39 403Lisp_Object Qtimer_event_handler;
284f4730
JB
404
405/* read_key_sequence stores here the command definition of the
406 key sequence that it reads. */
407Lisp_Object read_key_sequence_cmd;
408
39aab679
DL
409/* Echo unfinished commands after this many seconds of pause. */
410Lisp_Object Vecho_keystrokes;
411
284f4730
JB
412/* Form to evaluate (if non-nil) when Emacs is started. */
413Lisp_Object Vtop_level;
414
a0acc6c7 415/* User-supplied table to translate input characters. */
284f4730
JB
416Lisp_Object Vkeyboard_translate_table;
417
418/* Keymap mapping ASCII function key sequences onto their preferred forms. */
419extern Lisp_Object Vfunction_key_map;
420
e0301c07
RS
421/* Another keymap that maps key sequences into key sequences.
422 This one takes precedence over ordinary definitions. */
423extern Lisp_Object Vkey_translation_map;
a612e298 424
7d18f9ae
RS
425/* If non-nil, this implements the current input method. */
426Lisp_Object Vinput_method_function;
427Lisp_Object Qinput_method_function;
428
d5eecefb
RS
429/* When we call Vinput_method_function,
430 this holds the echo area message that was just erased. */
431Lisp_Object Vinput_method_previous_message;
432
86e5706b
RS
433/* Non-nil means deactivate the mark at end of this command. */
434Lisp_Object Vdeactivate_mark;
435
48e416d4
RS
436/* Menu bar specified in Lucid Emacs fashion. */
437
438Lisp_Object Vlucid_menu_bar_dirty_flag;
439Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;
440
cf24f894 441Lisp_Object Qecho_area_clear_hook;
cdb9d665 442
86e5706b 443/* Hooks to run before and after each command. */
59aadc81
RS
444Lisp_Object Qpre_command_hook, Vpre_command_hook;
445Lisp_Object Qpost_command_hook, Vpost_command_hook;
40932d1a 446Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
59aadc81
RS
447/* Hook run after a command if there's no more input soon. */
448Lisp_Object Qpost_command_idle_hook, Vpost_command_idle_hook;
449
450/* Delay time in microseconds before running post-command-idle-hook. */
31ade731 451EMACS_INT post_command_idle_delay;
86e5706b 452
8a792f3a
RS
453/* List of deferred actions to be performed at a later time.
454 The precise format isn't relevant here; we just check whether it is nil. */
455Lisp_Object Vdeferred_action_list;
456
457/* Function to call to handle deferred actions, when there are any. */
458Lisp_Object Vdeferred_action_function;
3ef14e46 459Lisp_Object Qdeferred_action_function;
8a792f3a 460
d5eecefb
RS
461Lisp_Object Qinput_method_exit_on_first_char;
462Lisp_Object Qinput_method_use_echo_area;
463
284f4730
JB
464/* File in which we write all commands we read. */
465FILE *dribble;
466
467/* Nonzero if input is available. */
468int input_pending;
469
b04904fb
RS
470/* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
471 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
472
284f4730
JB
473int meta_key;
474
3626fb1a
GM
475/* Non-zero means force key bindings update in parse_menu_item. */
476
477int update_menu_bindings;
478
284f4730
JB
479extern char *pending_malloc_warning;
480
beecf6a1 481/* Circular buffer for pre-read keyboard input. */
da8f7368 482
beecf6a1
KH
483static struct input_event kbd_buffer[KBD_BUFFER_SIZE];
484
da8f7368 485/* Vector to GCPRO the Lisp objects referenced from kbd_buffer.
beecf6a1
KH
486
487 The interrupt-level event handlers will never enqueue an event on a
488 frame which is not in Vframe_list, and once an event is dequeued,
489 internal_last_event_frame or the event itself points to the frame.
490 So that's all fine.
491
492 But while the event is sitting in the queue, it's completely
493 unprotected. Suppose the user types one command which will run for
494 a while and then delete a frame, and then types another event at
495 the frame that will be deleted, before the command gets around to
496 it. Suppose there are no references to this frame elsewhere in
497 Emacs, and a GC occurs before the second event is dequeued. Now we
498 have an event referring to a freed frame, which will crash Emacs
499 when it is dequeued.
500
501 Similar things happen when an event on a scroll bar is enqueued; the
502 window may be deleted while the event is in the queue.
503
da8f7368
GM
504 So, we use this vector to protect the Lisp_Objects in the event
505 queue. That way, they'll be dequeued as dead frames or windows,
506 but still valid Lisp objects.
beecf6a1 507
3b8f9651 508 If kbd_buffer[i].kind != NO_EVENT, then
da8f7368
GM
509
510 AREF (kbd_buffer_gcpro, 2 * i) == kbd_buffer[i].frame_or_window.
511 AREF (kbd_buffer_gcpro, 2 * i + 1) == kbd_buffer[i].arg. */
512
513static Lisp_Object kbd_buffer_gcpro;
beecf6a1
KH
514
515/* Pointer to next available character in kbd_buffer.
516 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
5cb6905d 517 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
beecf6a1
KH
518 next available char is in kbd_buffer[0]. */
519static struct input_event *kbd_fetch_ptr;
520
521/* Pointer to next place to store character in kbd_buffer. This
522 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
523 character should go in kbd_buffer[0]. */
7ee32cda 524static struct input_event * volatile kbd_store_ptr;
beecf6a1
KH
525
526/* The above pair of variables forms a "queue empty" flag. When we
527 enqueue a non-hook event, we increment kbd_store_ptr. When we
528 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
529 there is input available iff the two pointers are not equal.
530
531 Why not just have a flag set and cleared by the enqueuing and
532 dequeuing functions? Such a flag could be screwed up by interrupts
533 at inopportune times. */
534
f3253854 535/* If this flag is non-nil, we check mouse_moved to see when the
a9d77f1f
RS
536 mouse moves, and motion events will appear in the input stream.
537 Otherwise, mouse motion is ignored. */
e10da507 538Lisp_Object do_mouse_tracking;
284f4730 539
284f4730
JB
540/* Symbols to head events. */
541Lisp_Object Qmouse_movement;
3c370943 542Lisp_Object Qscroll_bar_movement;
cd21b839 543Lisp_Object Qswitch_frame;
bbdc2092 544Lisp_Object Qdelete_frame;
af17bd2b
KH
545Lisp_Object Qiconify_frame;
546Lisp_Object Qmake_frame_visible;
a697f886 547Lisp_Object Qselect_window;
7ee32cda 548Lisp_Object Qhelp_echo;
cd21b839 549
284f4730
JB
550/* Symbols to denote kinds of events. */
551Lisp_Object Qfunction_key;
552Lisp_Object Qmouse_click;
742fbed7 553#if defined(WINDOWSNT) || defined(MAC_OSX)
07de30b9 554Lisp_Object Qmouse_wheel;
742fbed7
AC
555#endif
556#ifdef WINDOWSNT
1161d367 557Lisp_Object Qlanguage_change;
07de30b9 558#endif
a24dc617 559Lisp_Object Qdrag_n_drop;
4ebc27a5
JD
560Lisp_Object Qsave_session;
561
284f4730 562/* Lisp_Object Qmouse_movement; - also an event header */
284f4730
JB
563
564/* Properties of event headers. */
565Lisp_Object Qevent_kind;
88cb0656 566Lisp_Object Qevent_symbol_elements;
284f4730 567
e8886a1d
RS
568/* menu item parts */
569Lisp_Object Qmenu_alias;
598a9fa7 570Lisp_Object Qmenu_enable;
74c1de23
RS
571Lisp_Object QCenable, QCvisible, QChelp, QCfilter, QCkeys, QCkey_sequence;
572Lisp_Object QCbutton, QCtoggle, QCradio;
e8886a1d
RS
573extern Lisp_Object Vdefine_key_rebound_commands;
574extern Lisp_Object Qmenu_item;
598a9fa7 575
0a7f1fc0
JB
576/* An event header symbol HEAD may have a property named
577 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
578 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
579 mask of modifiers applied to it. If present, this is used to help
580 speed up parse_modifiers. */
581Lisp_Object Qevent_symbol_element_mask;
582
583/* An unmodified event header BASE may have a property named
584 Qmodifier_cache, which is an alist mapping modifier masks onto
585 modified versions of BASE. If present, this helps speed up
586 apply_modifiers. */
587Lisp_Object Qmodifier_cache;
588
5ec75a55 589/* Symbols to use for parts of windows. */
284f4730 590Lisp_Object Qmode_line;
e5d77022 591Lisp_Object Qvertical_line;
3c370943 592Lisp_Object Qvertical_scroll_bar;
5ec75a55 593Lisp_Object Qmenu_bar;
7d60ad8a 594extern Lisp_Object Qleft_margin, Qright_margin;
5ec75a55 595
f4255cd1
JB
596Lisp_Object recursive_edit_unwind (), command_loop ();
597Lisp_Object Fthis_command_keys ();
03b4122a 598Lisp_Object Qextended_command_history;
c04cbc3b 599EMACS_TIME timer_check ();
284f4730 600
a0acc6c7 601extern Lisp_Object Vhistory_length, Vtranslation_table_for_input;
f4385381 602
2c834fb3
KH
603extern char *x_get_keysym_name ();
604
8eb4d8ef
RS
605static void record_menu_key ();
606
f4eef8b4
RS
607Lisp_Object Qpolling_period;
608
d9d4c147 609/* List of absolute timers. Appears in order of next scheduled event. */
c04cbc3b
RS
610Lisp_Object Vtimer_list;
611
d9d4c147
KH
612/* List of idle time timers. Appears in order of next scheduled event. */
613Lisp_Object Vtimer_idle_list;
614
87dd9b9b
RS
615/* Incremented whenever a timer is run. */
616int timers_run;
617
a9f16aa9
KH
618extern Lisp_Object Vprint_level, Vprint_length;
619
ffd56f97
JB
620/* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
621 happens. */
622EMACS_TIME *input_available_clear_time;
284f4730
JB
623
624/* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
625 Default is 1 if INTERRUPT_INPUT is defined. */
626int interrupt_input;
627
628/* Nonzero while interrupts are temporarily deferred during redisplay. */
629int interrupts_deferred;
630
87dd9b9b 631/* Nonzero means use ^S/^Q for flow control. */
284f4730
JB
632int flow_control;
633
284f4730
JB
634/* Allow m- file to inhibit use of FIONREAD. */
635#ifdef BROKEN_FIONREAD
636#undef FIONREAD
637#endif
638
639/* We are unable to use interrupts if FIONREAD is not available,
640 so flush SIGIO so we won't try. */
641#ifndef FIONREAD
642#ifdef SIGIO
643#undef SIGIO
644#endif
645#endif
646
e98a93eb 647/* If we support a window system, turn on the code to poll periodically
34f04431 648 to detect C-g. It isn't actually used when doing interrupt input. */
742fbed7 649#if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
284f4730
JB
650#define POLL_FOR_INPUT
651#endif
adf5cb9c
KH
652
653/* After a command is executed, if point is moved into a region that
654 has specific properties (e.g. composition, display), we adjust
655 point to the boundary of the region. But, if a command sets this
27fd22dc 656 variable to non-nil, we suppress this point adjustment. This
adf5cb9c 657 variable is set to nil before reading a command. */
da8f7368 658
adf5cb9c
KH
659Lisp_Object Vdisable_point_adjustment;
660
661/* If non-nil, always disable point adjustment. */
da8f7368 662
adf5cb9c
KH
663Lisp_Object Vglobal_disable_point_adjustment;
664
fdbb67fe
GM
665/* The time when Emacs started being idle. */
666
667static EMACS_TIME timer_idleness_start_time;
668
3021d3a9
RS
669/* After Emacs stops being idle, this saves the last value
670 of timer_idleness_start_time from when it was idle. */
671
672static EMACS_TIME timer_last_idleness_start_time;
673
284f4730
JB
674\f
675/* Global variable declarations. */
676
677/* Function for init_keyboard to call with no args (if nonzero). */
678void (*keyboard_init_hook) ();
679
0bbfdc25
GM
680static int read_avail_input P_ ((int));
681static void get_input_pending P_ ((int *, int));
20057d52 682static void get_filtered_input_pending P_ ((int *, int, int));
0bbfdc25 683static int readable_events P_ ((int));
20057d52 684static int readable_filtered_events P_ ((int, int));
0bbfdc25
GM
685static Lisp_Object read_char_x_menu_prompt P_ ((int, Lisp_Object *,
686 Lisp_Object, int *));
8150596a 687static Lisp_Object read_char_x_menu_prompt ();
0bbfdc25
GM
688static Lisp_Object read_char_minibuf_menu_prompt P_ ((int, int,
689 Lisp_Object *));
690static Lisp_Object make_lispy_event P_ ((struct input_event *));
514354e9 691#ifdef HAVE_MOUSE
0bbfdc25
GM
692static Lisp_Object make_lispy_movement P_ ((struct frame *, Lisp_Object,
693 enum scroll_bar_part,
694 Lisp_Object, Lisp_Object,
695 unsigned long));
514354e9 696#endif
0bbfdc25
GM
697static Lisp_Object modify_event_symbol P_ ((int, unsigned, Lisp_Object,
698 Lisp_Object, char **,
699 Lisp_Object *, unsigned));
700static Lisp_Object make_lispy_switch_frame P_ ((Lisp_Object));
701static int parse_solitary_modifier P_ ((Lisp_Object));
3d31316f 702static int parse_solitary_modifier ();
0bbfdc25 703static void save_getcjmp P_ ((jmp_buf));
dfcf069d 704static void save_getcjmp ();
0bbfdc25 705static void restore_getcjmp P_ ((jmp_buf));
7ee32cda 706static Lisp_Object apply_modifiers P_ ((int, Lisp_Object));
0bbfdc25 707static void clear_event P_ ((struct input_event *));
9ce50b1e 708static void any_kboard_state P_ ((void));
5598c32e 709static SIGTYPE interrupt_signal P_ ((int signalnum));
284f4730 710
8026024c
KH
711/* Nonzero means don't try to suspend even if the operating system seems
712 to support it. */
713static int cannot_suspend;
714
284f4730
JB
715/* Install the string STR as the beginning of the string of echoing,
716 so that it serves as a prompt for the next character.
717 Also start echoing. */
718
dfcf069d 719void
284f4730 720echo_prompt (str)
a4ef85ee 721 Lisp_Object str;
284f4730 722{
678e9d18 723 current_kboard->echo_string = str;
0d121f7c 724 current_kboard->echo_after_prompt = SCHARS (str);
3dbd9ee4 725 echo_now ();
284f4730
JB
726}
727
df0f2ba1 728/* Add C to the echo string, if echoing is going on.
284f4730
JB
729 C can be a character, which is printed prettily ("M-C-x" and all that
730 jazz), or a symbol, whose name is printed. */
731
dfcf069d 732void
284f4730
JB
733echo_char (c)
734 Lisp_Object c;
735{
c5fdd383 736 if (current_kboard->immediate_echo)
284f4730 737 {
678e9d18
GM
738 int size = KEY_DESCRIPTION_SIZE + 100;
739 char *buffer = (char *) alloca (size);
740 char *ptr = buffer;
741 Lisp_Object echo_string;
284f4730 742
0d121f7c
GM
743 echo_string = current_kboard->echo_string;
744
284f4730 745 /* If someone has passed us a composite event, use its head symbol. */
88cb0656 746 c = EVENT_HEAD (c);
284f4730 747
8c18cbfb 748 if (INTEGERP (c))
284f4730 749 {
678e9d18 750 ptr = push_key_description (XINT (c), ptr, 1);
284f4730 751 }
8c18cbfb 752 else if (SYMBOLP (c))
284f4730 753 {
1b049b51
KR
754 Lisp_Object name = SYMBOL_NAME (c);
755 int nbytes = SBYTES (name);
678e9d18 756
0d121f7c 757 if (size - (ptr - buffer) < nbytes)
678e9d18
GM
758 {
759 int offset = ptr - buffer;
0d121f7c 760 size = max (2 * size, size + nbytes);
678e9d18
GM
761 buffer = (char *) alloca (size);
762 ptr = buffer + offset;
763 }
764
1b049b51
KR
765 ptr += copy_text (SDATA (name), ptr, nbytes,
766 STRING_MULTIBYTE (name), 1);
284f4730
JB
767 }
768
0d121f7c 769 if ((NILP (echo_string) || SCHARS (echo_string) == 0)
ecb7cb34 770 && help_char_p (c))
284f4730 771 {
678e9d18
GM
772 const char *text = " (Type ? for further options)";
773 int len = strlen (text);
774
775 if (size - (ptr - buffer) < len)
776 {
777 int offset = ptr - buffer;
778 size += len;
779 buffer = (char *) alloca (size);
780 ptr = buffer + offset;
781 }
782
783 bcopy (text, ptr, len);
784 ptr += len;
284f4730
JB
785 }
786
0d121f7c
GM
787 /* Replace a dash from echo_dash with a space, otherwise
788 add a space at the end as a separator between keys. */
678e9d18 789 if (STRINGP (echo_string)
0d121f7c
GM
790 && SCHARS (echo_string) > 0)
791 {
792 Lisp_Object last_char, idx;
793
794 idx = make_number (SCHARS (echo_string) - 1);
795 last_char = Faref (echo_string, idx);
796
797 if (XINT (last_char) == '-')
798 Faset (echo_string, idx, make_number (' '));
799 else
800 echo_string = concat2 (echo_string, build_string (" "));
801 }
678e9d18
GM
802
803 current_kboard->echo_string
804 = concat2 (echo_string, make_string (buffer, ptr - buffer));
284f4730 805
3dbd9ee4 806 echo_now ();
284f4730
JB
807 }
808}
809
810/* Temporarily add a dash to the end of the echo string if it's not
811 empty, so that it serves as a mini-prompt for the very next character. */
812
dfcf069d 813void
284f4730
JB
814echo_dash ()
815{
678e9d18
GM
816 /* Do nothing if not echoing at all. */
817 if (NILP (current_kboard->echo_string))
818 return;
819
c5fdd383 820 if (!current_kboard->immediate_echo
0d121f7c 821 && SCHARS (current_kboard->echo_string) == 0)
284f4730 822 return;
678e9d18 823
7a80a6f6 824 /* Do nothing if we just printed a prompt. */
c5fdd383 825 if (current_kboard->echo_after_prompt
0d121f7c 826 == SCHARS (current_kboard->echo_string))
4bafa972 827 return;
678e9d18 828
284f4730
JB
829 /* Put a dash at the end of the buffer temporarily,
830 but make it go away when the next character is added. */
678e9d18
GM
831 current_kboard->echo_string = concat2 (current_kboard->echo_string,
832 build_string ("-"));
3dbd9ee4 833 echo_now ();
284f4730
JB
834}
835
836/* Display the current echo string, and begin echoing if not already
837 doing so. */
838
07a59269 839void
3dbd9ee4 840echo_now ()
284f4730 841{
c5fdd383 842 if (!current_kboard->immediate_echo)
284f4730
JB
843 {
844 int i;
c5fdd383 845 current_kboard->immediate_echo = 1;
284f4730
JB
846
847 for (i = 0; i < this_command_key_count; i++)
d0a57728
RS
848 {
849 Lisp_Object c;
850 c = XVECTOR (this_command_keys)->contents[i];
851 if (! (EVENT_HAS_PARAMETERS (c)
852 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
853 echo_char (c);
854 }
284f4730
JB
855 echo_dash ();
856 }
857
858 echoing = 1;
678e9d18 859 message3_nolog (current_kboard->echo_string,
0d121f7c 860 SBYTES (current_kboard->echo_string),
d5db4077 861 STRING_MULTIBYTE (current_kboard->echo_string));
284f4730
JB
862 echoing = 0;
863
59a84f8e
GM
864 /* Record in what buffer we echoed, and from which kboard. */
865 echo_message_buffer = echo_area_buffer[0];
866 echo_kboard = current_kboard;
867
284f4730
JB
868 if (waiting_for_input && !NILP (Vquit_flag))
869 quit_throw_to_read_char ();
870}
871
872/* Turn off echoing, for the start of a new command. */
873
dfcf069d 874void
284f4730
JB
875cancel_echoing ()
876{
c5fdd383 877 current_kboard->immediate_echo = 0;
c5fdd383 878 current_kboard->echo_after_prompt = -1;
678e9d18 879 current_kboard->echo_string = Qnil;
59a84f8e
GM
880 ok_to_echo_at_next_pause = NULL;
881 echo_kboard = NULL;
882 echo_message_buffer = Qnil;
284f4730
JB
883}
884
885/* Return the length of the current echo string. */
886
887static int
888echo_length ()
889{
678e9d18 890 return (STRINGP (current_kboard->echo_string)
0d121f7c 891 ? SCHARS (current_kboard->echo_string)
678e9d18 892 : 0);
284f4730
JB
893}
894
895/* Truncate the current echo message to its first LEN chars.
896 This and echo_char get used by read_key_sequence when the user
ff11dfa1 897 switches frames while entering a key sequence. */
284f4730
JB
898
899static void
678e9d18
GM
900echo_truncate (nchars)
901 int nchars;
902{
903 if (STRINGP (current_kboard->echo_string))
904 current_kboard->echo_string
905 = Fsubstring (current_kboard->echo_string,
906 make_number (0), make_number (nchars));
907 truncate_echo_area (nchars);
284f4730
JB
908}
909
910\f
911/* Functions for manipulating this_command_keys. */
912static void
913add_command_key (key)
914 Lisp_Object key;
915{
71918b75
RS
916 /* If reset-this-command-length was called recently, obey it now.
917 See the doc string of that function for an explanation of why. */
918 if (before_command_restore_flag)
919 {
920 this_command_key_count = before_command_key_count_1;
6321824f
RS
921 if (this_command_key_count < this_single_command_key_start)
922 this_single_command_key_start = this_command_key_count;
71918b75
RS
923 echo_truncate (before_command_echo_length_1);
924 before_command_restore_flag = 0;
925 }
926
f4e05d97
GM
927 if (this_command_key_count >= ASIZE (this_command_keys))
928 this_command_keys = larger_vector (this_command_keys,
929 2 * ASIZE (this_command_keys),
930 Qnil);
6569cc8d 931
f4e05d97
GM
932 AREF (this_command_keys, this_command_key_count) = key;
933 ++this_command_key_count;
284f4730 934}
f4e05d97 935
284f4730
JB
936\f
937Lisp_Object
938recursive_edit_1 ()
939{
aed13378 940 int count = SPECPDL_INDEX ();
284f4730
JB
941 Lisp_Object val;
942
943 if (command_loop_level > 0)
944 {
945 specbind (Qstandard_output, Qt);
946 specbind (Qstandard_input, Qt);
947 }
948
84265027 949#ifdef HAVE_X_WINDOWS
526a058f 950 /* The command loop has started an hourglass timer, so we have to
84265027 951 cancel it here, otherwise it will fire because the recursive edit
d8e2d5ba
PJ
952 can take some time. Do not check for display_hourglass_p here,
953 because it could already be nil. */
526a058f 954 cancel_hourglass ();
84265027
GM
955#endif
956
980a2d69
GM
957 /* This function may have been called from a debugger called from
958 within redisplay, for instance by Edebugging a function called
959 from fontification-functions. We want to allow redisplay in
960 the debugging session.
961
962 The recursive edit is left with a `(throw exit ...)'. The `exit'
963 tag is not caught anywhere in redisplay, i.e. when we leave the
964 recursive edit, the original redisplay leading to the recursive
965 edit will be unwound. The outcome should therefore be safe. */
966 specbind (Qinhibit_redisplay, Qnil);
967 redisplaying_p = 0;
968
284f4730
JB
969 val = command_loop ();
970 if (EQ (val, Qt))
971 Fsignal (Qquit, Qnil);
cb252880
RS
972 /* Handle throw from read_minibuf when using minibuffer
973 while it's active but we're in another window. */
974 if (STRINGP (val))
975 Fsignal (Qerror, Fcons (val, Qnil));
284f4730 976
cb5df6ae 977 return unbind_to (count, Qnil);
284f4730
JB
978}
979
980/* When an auto-save happens, record the "time", and don't do again soon. */
5846638c 981
07a59269 982void
284f4730
JB
983record_auto_save ()
984{
c43b1734 985 last_auto_save = num_nonmacro_input_events;
284f4730 986}
5846638c
RS
987
988/* Make an auto save happen as soon as possible at command level. */
989
dfcf069d 990void
5846638c
RS
991force_auto_save_soon ()
992{
993 last_auto_save = - auto_save_interval - 1;
241ceaf7
RS
994
995 record_asynch_buffer_change ();
5846638c 996}
284f4730 997\f
284f4730 998DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
4707d2d0
PJ
999 doc: /* Invoke the editor command loop recursively.
1000To get out of the recursive edit, a command can do `(throw 'exit nil)';
1001that tells this function to return.
1002Alternately, `(throw 'exit t)' makes this function signal an error.
1003This function is called by the editor initialization to begin editing. */)
1004 ()
284f4730 1005{
aed13378 1006 int count = SPECPDL_INDEX ();
9ce50b1e 1007 Lisp_Object buffer;
284f4730
JB
1008
1009 command_loop_level++;
1010 update_mode_lines = 1;
1011
9ce50b1e
GM
1012 if (command_loop_level
1013 && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
1014 buffer = Fcurrent_buffer ();
1015 else
1016 buffer = Qnil;
1017
1018 /* If we leave recursive_edit_1 below with a `throw' for instance,
1019 like it is done in the splash screen display, we have to
1020 make sure that we restore single_kboard as command_loop_1
1021 would have done if it were left normally. */
284f4730 1022 record_unwind_protect (recursive_edit_unwind,
9ce50b1e
GM
1023 Fcons (buffer, single_kboard ? Qt : Qnil));
1024
284f4730
JB
1025 recursive_edit_1 ();
1026 return unbind_to (count, Qnil);
1027}
1028
1029Lisp_Object
9ce50b1e
GM
1030recursive_edit_unwind (info)
1031 Lisp_Object info;
284f4730 1032{
9ce50b1e
GM
1033 if (BUFFERP (XCAR (info)))
1034 Fset_buffer (XCAR (info));
1035
1036 if (NILP (XCDR (info)))
1037 any_kboard_state ();
1038 else
1039 single_kboard_state ();
1040
284f4730
JB
1041 command_loop_level--;
1042 update_mode_lines = 1;
1043 return Qnil;
1044}
9ce50b1e 1045
284f4730 1046\f
604ccd1d 1047static void
1e8bd3da 1048any_kboard_state ()
604ccd1d 1049{
1e8bd3da
RS
1050#ifdef MULTI_KBOARD
1051#if 0 /* Theory: if there's anything in Vunread_command_events,
1052 it will right away be read by read_key_sequence,
1053 and then if we do switch KBOARDS, it will go into the side
1054 queue then. So we don't need to do anything special here -- rms. */
604ccd1d 1055 if (CONSP (Vunread_command_events))
4524b161 1056 {
c5fdd383
KH
1057 current_kboard->kbd_queue
1058 = nconc2 (Vunread_command_events, current_kboard->kbd_queue);
1059 current_kboard->kbd_queue_has_data = 1;
4524b161 1060 }
604ccd1d 1061 Vunread_command_events = Qnil;
1e8bd3da
RS
1062#endif
1063 single_kboard = 0;
1064#endif
604ccd1d 1065}
1e8bd3da
RS
1066
1067/* Switch to the single-kboard state, making current_kboard
1068 the only KBOARD from which further input is accepted. */
1069
1070void
1071single_kboard_state ()
1072{
1073#ifdef MULTI_KBOARD
1074 single_kboard = 1;
604ccd1d 1075#endif
1e8bd3da
RS
1076}
1077
1078/* Maintain a stack of kboards, so other parts of Emacs
1079 can switch temporarily to the kboard of a given frame
1080 and then revert to the previous status. */
1081
1082struct kboard_stack
1083{
1084 KBOARD *kboard;
1085 struct kboard_stack *next;
1086};
1087
1088static struct kboard_stack *kboard_stack;
1089
1090void
1091push_frame_kboard (f)
1092 FRAME_PTR f;
1093{
ab48365b 1094#ifdef MULTI_KBOARD
1e8bd3da
RS
1095 struct kboard_stack *p
1096 = (struct kboard_stack *) xmalloc (sizeof (struct kboard_stack));
1097
1098 p->next = kboard_stack;
1099 p->kboard = current_kboard;
1100 kboard_stack = p;
1101
1102 current_kboard = FRAME_KBOARD (f);
ab48365b 1103#endif
1e8bd3da
RS
1104}
1105
1106void
1107pop_frame_kboard ()
1108{
ab48365b 1109#ifdef MULTI_KBOARD
1e8bd3da
RS
1110 struct kboard_stack *p = kboard_stack;
1111 current_kboard = p->kboard;
1112 kboard_stack = p->next;
1113 xfree (p);
ab48365b 1114#endif
1e8bd3da
RS
1115}
1116\f
1117/* Handle errors that are not handled at inner levels
1118 by printing an error message and returning to the editor command loop. */
604ccd1d 1119
284f4730
JB
1120Lisp_Object
1121cmd_error (data)
1122 Lisp_Object data;
a1341f75 1123{
a9f16aa9 1124 Lisp_Object old_level, old_length;
e881d8b2
RS
1125 char macroerror[50];
1126
160552c5
RS
1127#ifdef HAVE_X_WINDOWS
1128 if (display_hourglass_p)
1129 cancel_hourglass ();
1130#endif
1131
e881d8b2
RS
1132 if (!NILP (executing_macro))
1133 {
1134 if (executing_macro_iterations == 1)
1135 sprintf (macroerror, "After 1 kbd macro iteration: ");
1136 else
1137 sprintf (macroerror, "After %d kbd macro iterations: ",
1138 executing_macro_iterations);
1139 }
1140 else
1141 *macroerror = 0;
a9f16aa9 1142
a1341f75
RS
1143 Vstandard_output = Qt;
1144 Vstandard_input = Qt;
1145 Vexecuting_macro = Qnil;
9f58e89e 1146 executing_macro = Qnil;
d8bcf58e 1147 current_kboard->Vprefix_arg = Qnil;
75045dcb 1148 current_kboard->Vlast_prefix_arg = Qnil;
df0f2ba1 1149 cancel_echoing ();
a9f16aa9
KH
1150
1151 /* Avoid unquittable loop if data contains a circular list. */
1152 old_level = Vprint_level;
1153 old_length = Vprint_length;
0c04a67e
RS
1154 XSETFASTINT (Vprint_level, 10);
1155 XSETFASTINT (Vprint_length, 10);
e881d8b2 1156 cmd_error_internal (data, macroerror);
a9f16aa9
KH
1157 Vprint_level = old_level;
1158 Vprint_length = old_length;
a1341f75
RS
1159
1160 Vquit_flag = Qnil;
1161
1162 Vinhibit_quit = Qnil;
c5fdd383 1163#ifdef MULTI_KBOARD
1e8bd3da 1164 any_kboard_state ();
ff4b06d3 1165#endif
a1341f75
RS
1166
1167 return make_number (0);
1168}
1169
301738ed
RS
1170/* Take actions on handling an error. DATA is the data that describes
1171 the error.
1172
1173 CONTEXT is a C-string containing ASCII characters only which
1174 describes the context in which the error happened. If we need to
1175 generalize CONTEXT to allow multibyte characters, make it a Lisp
1176 string. */
1177
07a59269 1178void
a1341f75
RS
1179cmd_error_internal (data, context)
1180 Lisp_Object data;
1181 char *context;
284f4730 1182{
284f4730 1183 Lisp_Object stream;
7ee32cda 1184 int kill_emacs_p = 0;
788f89eb 1185 struct frame *sf = SELECTED_FRAME ();
284f4730
JB
1186
1187 Vquit_flag = Qnil;
1188 Vinhibit_quit = Qt;
985f9f66 1189 clear_message (1, 0);
284f4730 1190
ff11dfa1 1191 /* If the window system or terminal frame hasn't been initialized
284f4730
JB
1192 yet, or we're not interactive, it's best to dump this message out
1193 to stderr and exit. */
788f89eb 1194 if (!sf->glyphs_initialized_p
7ee32cda
GM
1195 /* This is the case of the frame dumped with Emacs, when we're
1196 running under a window system. */
1197 || (!NILP (Vwindow_system)
1198 && !inhibit_window_system
788f89eb 1199 && FRAME_TERMCAP_P (sf))
284f4730 1200 || noninteractive)
7ee32cda
GM
1201 {
1202 stream = Qexternal_debugging_output;
1203 kill_emacs_p = 1;
1204 }
284f4730
JB
1205 else
1206 {
1207 Fdiscard_input ();
dc4854ce 1208 message_log_maybe_newline ();
284f4730
JB
1209 bitch_at_user ();
1210 stream = Qt;
1211 }
1212
dc4854ce
RS
1213 /* The immediate context is not interesting for Quits,
1214 since they are asyncronous. */
1215 if (EQ (XCAR (data), Qquit))
1216 Vsignaling_function = Qnil;
1217
1218 print_error_message (data, stream, context, Vsignaling_function);
a1341f75 1219
dc4854ce 1220 Vsignaling_function = Qnil;
284f4730 1221
ff11dfa1 1222 /* If the window system or terminal frame hasn't been initialized
284f4730 1223 yet, or we're in -batch mode, this error should cause Emacs to exit. */
7ee32cda 1224 if (kill_emacs_p)
284f4730
JB
1225 {
1226 Fterpri (stream);
1227 Fkill_emacs (make_number (-1));
1228 }
284f4730
JB
1229}
1230\f
1231Lisp_Object command_loop_1 ();
1232Lisp_Object command_loop_2 ();
1233Lisp_Object top_level_1 ();
1234
1235/* Entry to editor-command-loop.
1236 This level has the catches for exiting/returning to editor command loop.
1237 It returns nil to exit recursive edit, t to abort it. */
1238
1239Lisp_Object
1240command_loop ()
1241{
1242 if (command_loop_level > 0 || minibuf_level > 0)
1243 {
07ba902e
RS
1244 Lisp_Object val;
1245 val = internal_catch (Qexit, command_loop_2, Qnil);
68c46464
RS
1246 executing_macro = Qnil;
1247 return val;
284f4730
JB
1248 }
1249 else
1250 while (1)
1251 {
1252 internal_catch (Qtop_level, top_level_1, Qnil);
1253 internal_catch (Qtop_level, command_loop_2, Qnil);
68c46464 1254 executing_macro = Qnil;
df0f2ba1 1255
284f4730
JB
1256 /* End of file in -batch run causes exit here. */
1257 if (noninteractive)
1258 Fkill_emacs (Qt);
1259 }
1260}
1261
1262/* Here we catch errors in execution of commands within the
1263 editing loop, and reenter the editing loop.
1264 When there is an error, cmd_error runs and returns a non-nil
27fd22dc 1265 value to us. A value of nil means that command_loop_1 itself
284f4730
JB
1266 returned due to end of file (or end of kbd macro). */
1267
1268Lisp_Object
1269command_loop_2 ()
1270{
1271 register Lisp_Object val;
1272
1273 do
1274 val = internal_condition_case (command_loop_1, Qerror, cmd_error);
1275 while (!NILP (val));
1276
1277 return Qnil;
1278}
1279
1280Lisp_Object
1281top_level_2 ()
1282{
1283 return Feval (Vtop_level);
1284}
1285
1286Lisp_Object
1287top_level_1 ()
1288{
1289 /* On entry to the outer level, run the startup file */
1290 if (!NILP (Vtop_level))
1291 internal_condition_case (top_level_2, Qerror, cmd_error);
1292 else if (!NILP (Vpurify_flag))
1293 message ("Bare impure Emacs (standard Lisp code not loaded)");
1294 else
1295 message ("Bare Emacs (standard Lisp code not loaded)");
1296 return Qnil;
1297}
1298
1299DEFUN ("top-level", Ftop_level, Stop_level, 0, 0, "",
4707d2d0
PJ
1300 doc: /* Exit all recursive editing levels. */)
1301 ()
284f4730 1302{
2c9cf2c8 1303#ifdef HAVE_X_WINDOWS
526a058f
GM
1304 if (display_hourglass_p)
1305 cancel_hourglass ();
2c9cf2c8 1306#endif
8c907a56 1307 return Fthrow (Qtop_level, Qnil);
284f4730
JB
1308}
1309
1310DEFUN ("exit-recursive-edit", Fexit_recursive_edit, Sexit_recursive_edit, 0, 0, "",
4707d2d0
PJ
1311 doc: /* Exit from the innermost recursive edit or minibuffer. */)
1312 ()
284f4730
JB
1313{
1314 if (command_loop_level > 0 || minibuf_level > 0)
1315 Fthrow (Qexit, Qnil);
1316
1317 error ("No recursive edit is in progress");
8c907a56 1318 return Qnil;
284f4730
JB
1319}
1320
1321DEFUN ("abort-recursive-edit", Fabort_recursive_edit, Sabort_recursive_edit, 0, 0, "",
4707d2d0
PJ
1322 doc: /* Abort the command that requested this recursive edit or minibuffer input. */)
1323 ()
284f4730
JB
1324{
1325 if (command_loop_level > 0 || minibuf_level > 0)
1326 Fthrow (Qexit, Qt);
1327
1328 error ("No recursive edit is in progress");
8c907a56 1329 return Qnil;
284f4730
JB
1330}
1331\f
1332/* This is the actual command reading loop,
1333 sans error-handling encapsulation. */
1334
a7b772c1
GM
1335static int read_key_sequence P_ ((Lisp_Object *, int, Lisp_Object,
1336 int, int, int));
1337void safe_run_hooks P_ ((Lisp_Object));
1338static void adjust_point_for_property P_ ((int));
284f4730
JB
1339
1340Lisp_Object
1341command_loop_1 ()
1342{
03cee6ae
GM
1343 Lisp_Object cmd;
1344 int lose;
284f4730
JB
1345 int nonundocount;
1346 Lisp_Object keybuf[30];
1347 int i;
284f4730 1348 int no_direct;
86e5706b 1349 int prev_modiff;
8c907a56 1350 struct buffer *prev_buffer = NULL;
c5fdd383 1351#ifdef MULTI_KBOARD
1e8bd3da 1352 int was_locked = single_kboard;
bded54dd 1353#endif
2764bebd 1354 int already_adjusted;
284f4730 1355
d9b641bb 1356 current_kboard->Vprefix_arg = Qnil;
75045dcb 1357 current_kboard->Vlast_prefix_arg = Qnil;
86e5706b 1358 Vdeactivate_mark = Qnil;
284f4730 1359 waiting_for_input = 0;
df0f2ba1 1360 cancel_echoing ();
284f4730 1361
284f4730 1362 nonundocount = 0;
284f4730 1363 this_command_key_count = 0;
6321824f 1364 this_single_command_key_start = 0;
284f4730 1365
325309f5 1366 if (NILP (Vmemory_full))
59aadc81 1367 {
10ffcb64
RS
1368 /* Make sure this hook runs after commands that get errors and
1369 throw to top level. */
1370 /* Note that the value cell will never directly contain nil
1371 if the symbol is a local variable. */
1372 if (!NILP (Vpost_command_hook) && !NILP (Vrun_hooks))
1373 safe_run_hooks (Qpost_command_hook);
1374
1375 /* If displaying a message, resize the echo area window to fit
1376 that message's size exactly. */
1377 if (!NILP (echo_area_buffer[0]))
1378 resize_echo_area_exactly ();
1379
1380 if (!NILP (Vdeferred_action_list))
1381 call0 (Vdeferred_action_function);
1382
1383 if (!NILP (Vpost_command_idle_hook) && !NILP (Vrun_hooks))
1384 {
1385 if (NILP (Vunread_command_events)
1386 && NILP (Vunread_input_method_events)
1387 && NILP (Vunread_post_input_method_events)
1388 && NILP (Vexecuting_macro)
1389 && !NILP (sit_for (0, post_command_idle_delay, 0, 1, 1)))
1390 safe_run_hooks (Qpost_command_idle_hook);
1391 }
59aadc81
RS
1392 }
1393
10ffcb64
RS
1394 Vmemory_full = Qnil;
1395
51d5a2c9 1396 /* Do this after running Vpost_command_hook, for consistency. */
d5eecefb
RS
1397 current_kboard->Vlast_command = Vthis_command;
1398 current_kboard->Vreal_last_command = real_this_command;
51d5a2c9 1399
284f4730
JB
1400 while (1)
1401 {
788f89eb 1402 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
a94a4335
KH
1403 Fkill_emacs (Qnil);
1404
284f4730
JB
1405 /* Make sure the current window's buffer is selected. */
1406 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
1407 set_buffer_internal (XBUFFER (XWINDOW (selected_window)->buffer));
1408
1409 /* Display any malloc warning that just came out. Use while because
1410 displaying one warning can cause another. */
1411
1412 while (pending_malloc_warning)
1413 display_malloc_warning ();
1414
1415 no_direct = 0;
1416
86e5706b
RS
1417 Vdeactivate_mark = Qnil;
1418
284f4730 1419 /* If minibuffer on and echo area in use,
00392ce6 1420 wait a short time and redraw minibuffer. */
284f4730 1421
7ee32cda 1422 if (minibuf_level
985f9f66 1423 && !NILP (echo_area_buffer[0])
00392ce6
MB
1424 && EQ (minibuf_window, echo_area_window)
1425 && NUMBERP (Vminibuffer_message_timeout))
284f4730 1426 {
f1bed6d8
RS
1427 /* Bind inhibit-quit to t so that C-g gets read in
1428 rather than quitting back to the minibuffer. */
aed13378 1429 int count = SPECPDL_INDEX ();
f1bed6d8 1430 specbind (Qinhibit_quit, Qt);
f1bed6d8 1431
00392ce6 1432 Fsit_for (Vminibuffer_message_timeout, Qnil, Qnil);
e6aa7813 1433 /* Clear the echo area. */
301738ed 1434 message2 (0, 0, 0);
cdb9d665 1435 safe_run_hooks (Qecho_area_clear_hook);
e6aa7813 1436
db08707d
RS
1437 unbind_to (count, Qnil);
1438
e6aa7813 1439 /* If a C-g came in before, treat it as input now. */
284f4730
JB
1440 if (!NILP (Vquit_flag))
1441 {
1442 Vquit_flag = Qnil;
24597608 1443 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
284f4730
JB
1444 }
1445 }
1446
1447#ifdef C_ALLOCA
ff4b06d3 1448 alloca (0); /* Cause a garbage collection now */
284f4730
JB
1449 /* Since we can free the most stuff here. */
1450#endif /* C_ALLOCA */
1451
8f805655 1452#if 0
8f805655
JB
1453 /* Select the frame that the last event came from. Usually,
1454 switch-frame events will take care of this, but if some lisp
1455 code swallows a switch-frame event, we'll fix things up here.
1456 Is this a good idea? */
8c18cbfb 1457 if (FRAMEP (internal_last_event_frame)
788f89eb 1458 && !EQ (internal_last_event_frame, selected_frame))
3c370943 1459 Fselect_frame (internal_last_event_frame, Qnil);
284f4730 1460#endif
48e416d4
RS
1461 /* If it has changed current-menubar from previous value,
1462 really recompute the menubar from the value. */
a646e520
RS
1463 if (! NILP (Vlucid_menu_bar_dirty_flag)
1464 && !NILP (Ffboundp (Qrecompute_lucid_menubar)))
48e416d4
RS
1465 call0 (Qrecompute_lucid_menubar);
1466
71918b75
RS
1467 before_command_key_count = this_command_key_count;
1468 before_command_echo_length = echo_length ();
1469
d5eecefb
RS
1470 Vthis_command = Qnil;
1471 real_this_command = Qnil;
d7437ef6 1472
8f805655 1473 /* Read next key sequence; i gets its length. */
ce98e608 1474 i = read_key_sequence (keybuf, sizeof keybuf / sizeof keybuf[0],
f571ae0d 1475 Qnil, 0, 1, 1);
8f805655 1476
6fac1409 1477 /* A filter may have run while we were reading the input. */
788f89eb 1478 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
a94a4335 1479 Fkill_emacs (Qnil);
6fac1409
RS
1480 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
1481 set_buffer_internal (XBUFFER (XWINDOW (selected_window)->buffer));
1482
8f805655
JB
1483 ++num_input_keys;
1484
284f4730
JB
1485 /* Now we have read a key sequence of length I,
1486 or else I is 0 and we found end of file. */
1487
1488 if (i == 0) /* End of file -- happens only in */
1489 return Qnil; /* a kbd macro, at the end. */
dcc408a0
RS
1490 /* -1 means read_key_sequence got a menu that was rejected.
1491 Just loop around and read another command. */
1492 if (i == -1)
1493 {
1494 cancel_echoing ();
1495 this_command_key_count = 0;
6321824f 1496 this_single_command_key_start = 0;
ff4b06d3 1497 goto finalize;
dcc408a0 1498 }
284f4730 1499
284f4730
JB
1500 last_command_char = keybuf[i - 1];
1501
75c0b143
RS
1502 /* If the previous command tried to force a specific window-start,
1503 forget about that, in case this command moves point far away
c422836d
KH
1504 from that position. But also throw away beg_unchanged and
1505 end_unchanged information in that case, so that redisplay will
1506 update the whole window properly. */
1507 if (!NILP (XWINDOW (selected_window)->force_start))
1508 {
9351ebd0 1509 struct buffer *b;
c422836d 1510 XWINDOW (selected_window)->force_start = Qnil;
9351ebd0
GM
1511 b = XBUFFER (XWINDOW (selected_window)->buffer);
1512 BUF_BEG_UNCHANGED (b) = BUF_END_UNCHANGED (b) = 0;
c422836d 1513 }
75c0b143 1514
284f4730
JB
1515 cmd = read_key_sequence_cmd;
1516 if (!NILP (Vexecuting_macro))
1517 {
1518 if (!NILP (Vquit_flag))
1519 {
1520 Vexecuting_macro = Qt;
1521 QUIT; /* Make some noise. */
1522 /* Will return since macro now empty. */
1523 }
1524 }
1525
1526 /* Do redisplay processing after this command except in special
e35b6123 1527 cases identified below. */
86e5706b
RS
1528 prev_buffer = current_buffer;
1529 prev_modiff = MODIFF;
8746da95 1530 last_point_position = PT;
18cd2eeb 1531 XSETBUFFER (last_point_position_buffer, prev_buffer);
86e5706b 1532
adf5cb9c
KH
1533 /* By default, we adjust point to a boundary of a region that
1534 has such a property that should be treated intangible
1535 (e.g. composition, display). But, some commands will set
1536 this variable differently. */
1537 Vdisable_point_adjustment = Qnil;
a7b772c1 1538
be2488ca
GM
1539 /* Process filters and timers may have messed with deactivate-mark.
1540 reset it before we execute the command. */
1541 Vdeactivate_mark = Qnil;
1542
8b9940e6
KS
1543 /* Remap command through active keymaps */
1544 Vthis_original_command = cmd;
a34cb674 1545 if (SYMBOLP (cmd))
8b9940e6
KS
1546 {
1547 Lisp_Object cmd1;
a34cb674 1548 if (cmd1 = Fremap_command (cmd), !NILP (cmd1))
8b9940e6
KS
1549 cmd = cmd1;
1550 }
1551
284f4730
JB
1552 /* Execute the command. */
1553
d5eecefb
RS
1554 Vthis_command = cmd;
1555 real_this_command = cmd;
a98ea3f9
RS
1556 /* Note that the value cell will never directly contain nil
1557 if the symbol is a local variable. */
e98a93eb 1558 if (!NILP (Vpre_command_hook) && !NILP (Vrun_hooks))
a98ea3f9 1559 safe_run_hooks (Qpre_command_hook);
75045dcb 1560
2764bebd
RS
1561 already_adjusted = 0;
1562
d5eecefb 1563 if (NILP (Vthis_command))
284f4730
JB
1564 {
1565 /* nil means key is undefined. */
1566 bitch_at_user ();
c5fdd383 1567 current_kboard->defining_kbd_macro = Qnil;
284f4730 1568 update_mode_lines = 1;
d8bcf58e 1569 current_kboard->Vprefix_arg = Qnil;
284f4730
JB
1570 }
1571 else
1572 {
d8bcf58e 1573 if (NILP (current_kboard->Vprefix_arg) && ! no_direct)
284f4730 1574 {
75045dcb
RS
1575 /* In case we jump to directly_done. */
1576 Vcurrent_prefix_arg = current_kboard->Vprefix_arg;
1577
284f4730
JB
1578 /* Recognize some common commands in common situations and
1579 do them directly. */
d5eecefb 1580 if (EQ (Vthis_command, Qforward_char) && PT < ZV)
284f4730 1581 {
51ad8a68 1582 struct Lisp_Char_Table *dp
284f4730 1583 = window_display_table (XWINDOW (selected_window));
aaf35234 1584 lose = FETCH_CHAR (PT_BYTE);
8458ede6 1585 SET_PT (PT + 1);
2764bebd
RS
1586 adjust_point_for_property (last_point_position);
1587 already_adjusted = 1;
1588 if (PT == last_point_position + 1
1589 && (dp
1590 ? (VECTORP (DISP_CHAR_VECTOR (dp, lose))
1591 ? XVECTOR (DISP_CHAR_VECTOR (dp, lose))->size == 1
1592 : (NILP (DISP_CHAR_VECTOR (dp, lose))
1593 && (lose >= 0x20 && lose < 0x7f)))
1594 : (lose >= 0x20 && lose < 0x7f))
37cd9f30
KH
1595 /* To extract the case of continuation on
1596 wide-column characters. */
8458ede6 1597 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE)) == 1)
284f4730
JB
1598 && (XFASTINT (XWINDOW (selected_window)->last_modified)
1599 >= MODIFF)
598ba4c7
RS
1600 && (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1601 >= OVERLAY_MODIFF)
284f4730 1602 && (XFASTINT (XWINDOW (selected_window)->last_point)
8001d352 1603 == PT - 1)
284f4730
JB
1604 && !windows_or_buffers_changed
1605 && EQ (current_buffer->selective_display, Qnil)
1606 && !detect_input_pending ()
962ae636 1607 && NILP (XWINDOW (selected_window)->column_number_displayed)
284f4730 1608 && NILP (Vexecuting_macro))
e35b6123 1609 direct_output_forward_char (1);
284f4730
JB
1610 goto directly_done;
1611 }
d5eecefb 1612 else if (EQ (Vthis_command, Qbackward_char) && PT > BEGV)
284f4730 1613 {
51ad8a68 1614 struct Lisp_Char_Table *dp
284f4730 1615 = window_display_table (XWINDOW (selected_window));
8458ede6 1616 SET_PT (PT - 1);
aaf35234 1617 lose = FETCH_CHAR (PT_BYTE);
2764bebd
RS
1618 adjust_point_for_property (last_point_position);
1619 already_adjusted = 1;
1620 if (PT == last_point_position - 1
1621 && (dp
1622 ? (VECTORP (DISP_CHAR_VECTOR (dp, lose))
1623 ? XVECTOR (DISP_CHAR_VECTOR (dp, lose))->size == 1
1624 : (NILP (DISP_CHAR_VECTOR (dp, lose))
1625 && (lose >= 0x20 && lose < 0x7f)))
1626 : (lose >= 0x20 && lose < 0x7f))
284f4730
JB
1627 && (XFASTINT (XWINDOW (selected_window)->last_modified)
1628 >= MODIFF)
598ba4c7
RS
1629 && (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1630 >= OVERLAY_MODIFF)
284f4730 1631 && (XFASTINT (XWINDOW (selected_window)->last_point)
8001d352 1632 == PT + 1)
284f4730
JB
1633 && !windows_or_buffers_changed
1634 && EQ (current_buffer->selective_display, Qnil)
1635 && !detect_input_pending ()
962ae636 1636 && NILP (XWINDOW (selected_window)->column_number_displayed)
284f4730 1637 && NILP (Vexecuting_macro))
e35b6123 1638 direct_output_forward_char (-1);
284f4730
JB
1639 goto directly_done;
1640 }
d5eecefb 1641 else if (EQ (Vthis_command, Qself_insert_command)
14e40288
SM
1642 /* Try this optimization only on char keystrokes. */
1643 && NATNUMP (last_command_char)
1644 && CHAR_VALID_P (XFASTINT (last_command_char), 0))
284f4730 1645 {
a0acc6c7
DL
1646 unsigned int c =
1647 translate_char (Vtranslation_table_for_input,
14e40288 1648 XFASTINT (last_command_char), 0, 0, 0);
fc9cce4e 1649 int value;
fc9cce4e
RS
1650 if (NILP (Vexecuting_macro)
1651 && !EQ (minibuf_window, selected_window))
284f4730
JB
1652 {
1653 if (!nonundocount || nonundocount >= 20)
1654 {
1655 Fundo_boundary ();
1656 nonundocount = 0;
1657 }
1658 nonundocount++;
1659 }
7ee32cda 1660
fc9cce4e
RS
1661 lose = ((XFASTINT (XWINDOW (selected_window)->last_modified)
1662 < MODIFF)
598ba4c7
RS
1663 || (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1664 < OVERLAY_MODIFF)
fc9cce4e
RS
1665 || (XFASTINT (XWINDOW (selected_window)->last_point)
1666 != PT)
4c61f38e 1667 || MODIFF <= SAVE_MODIFF
fc9cce4e
RS
1668 || windows_or_buffers_changed
1669 || !EQ (current_buffer->selective_display, Qnil)
1670 || detect_input_pending ()
962ae636 1671 || !NILP (XWINDOW (selected_window)->column_number_displayed)
fc9cce4e 1672 || !NILP (Vexecuting_macro));
7ee32cda 1673
fc9cce4e 1674 value = internal_self_insert (c, 0);
7ee32cda 1675
fc9cce4e
RS
1676 if (value == 2)
1677 nonundocount = 0;
1678
7ee32cda
GM
1679 /* VALUE == 1 when AFTER-CHANGE functions are
1680 installed which is the case most of the time
1681 because FONT-LOCK installs one. */
1682 if (!lose && !value)
e35b6123 1683 direct_output_for_insert (c);
284f4730
JB
1684 goto directly_done;
1685 }
1686 }
1687
1688 /* Here for a command that isn't executed directly */
1689
7ee32cda 1690#ifdef HAVE_X_WINDOWS
e1204d39
RS
1691 if (display_hourglass_p
1692 && NILP (Vexecuting_macro))
526a058f 1693 start_hourglass ();
7ee32cda
GM
1694#endif
1695
284f4730 1696 nonundocount = 0;
d8bcf58e 1697 if (NILP (current_kboard->Vprefix_arg))
284f4730 1698 Fundo_boundary ();
d5eecefb 1699 Fcommand_execute (Vthis_command, Qnil, Qnil, Qnil);
d0c48478
GM
1700
1701#ifdef HAVE_X_WINDOWS
4fbcc9b1
PJ
1702 /* Do not check display_hourglass_p here, because
1703 Fcommand_execute could change it, but we should cancel
e1204d39
RS
1704 hourglass cursor anyway.
1705 But don't cancel the hourglass within a macro
1706 just because a command in the macro finishes. */
1707 if (NILP (Vexecuting_macro))
1708 cancel_hourglass ();
d0c48478 1709#endif
284f4730 1710 }
a764a753 1711 directly_done: ;
75045dcb 1712 current_kboard->Vlast_prefix_arg = Vcurrent_prefix_arg;
284f4730 1713
84ee6048
RS
1714 /* Note that the value cell will never directly contain nil
1715 if the symbol is a local variable. */
1716 if (!NILP (Vpost_command_hook) && !NILP (Vrun_hooks))
1717 safe_run_hooks (Qpost_command_hook);
1718
8f12e41d
GM
1719 /* If displaying a message, resize the echo area window to fit
1720 that message's size exactly. */
1721 if (!NILP (echo_area_buffer[0]))
f09c15ed 1722 resize_echo_area_exactly ();
8f12e41d 1723
84ee6048
RS
1724 if (!NILP (Vdeferred_action_list))
1725 safe_run_hooks (Qdeferred_action_function);
1726
1727 if (!NILP (Vpost_command_idle_hook) && !NILP (Vrun_hooks))
1728 {
1729 if (NILP (Vunread_command_events)
7d18f9ae
RS
1730 && NILP (Vunread_input_method_events)
1731 && NILP (Vunread_post_input_method_events)
84ee6048
RS
1732 && NILP (Vexecuting_macro)
1733 && !NILP (sit_for (0, post_command_idle_delay, 0, 1, 1)))
1734 safe_run_hooks (Qpost_command_idle_hook);
1735 }
1736
284f4730 1737 /* If there is a prefix argument,
6c7178b9
KH
1738 1) We don't want Vlast_command to be ``universal-argument''
1739 (that would be dumb), so don't set Vlast_command,
284f4730
JB
1740 2) we want to leave echoing on so that the prefix will be
1741 echoed as part of this key sequence, so don't call
1742 cancel_echoing, and
1743 3) we want to leave this_command_key_count non-zero, so that
1744 read_char will realize that it is re-reading a character, and
217258d5
KH
1745 not echo it a second time.
1746
1747 If the command didn't actually create a prefix arg,
1748 but is merely a frame event that is transparent to prefix args,
1749 then the above doesn't apply. */
1750 if (NILP (current_kboard->Vprefix_arg) || CONSP (last_command_char))
284f4730 1751 {
d5eecefb
RS
1752 current_kboard->Vlast_command = Vthis_command;
1753 current_kboard->Vreal_last_command = real_this_command;
284f4730
JB
1754 cancel_echoing ();
1755 this_command_key_count = 0;
6321824f 1756 this_single_command_key_start = 0;
284f4730 1757 }
86e5706b 1758
88ce066e 1759 if (!NILP (current_buffer->mark_active) && !NILP (Vrun_hooks))
86e5706b
RS
1760 {
1761 if (!NILP (Vdeactivate_mark) && !NILP (Vtransient_mark_mode))
1762 {
2e1a49ad
SM
1763 /* We could also call `deactivate'mark'. */
1764 if (EQ (Vtransient_mark_mode, Qlambda))
1765 Vtransient_mark_mode = Qnil;
1766 else
1767 {
1768 current_buffer->mark_active = Qnil;
1769 call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
1770 }
86e5706b
RS
1771 }
1772 else if (current_buffer != prev_buffer || MODIFF != prev_modiff)
1773 call1 (Vrun_hooks, intern ("activate-mark-hook"));
1774 }
ff4b06d3
KH
1775
1776 finalize:
adf5cb9c
KH
1777
1778 if (current_buffer == prev_buffer
1779 && last_point_position != PT
1780 && NILP (Vdisable_point_adjustment)
2764bebd
RS
1781 && NILP (Vglobal_disable_point_adjustment)
1782 && !already_adjusted)
adf5cb9c
KH
1783 adjust_point_for_property (last_point_position);
1784
ff4b06d3
KH
1785 /* Install chars successfully executed in kbd macro. */
1786
d8bcf58e
KH
1787 if (!NILP (current_kboard->defining_kbd_macro)
1788 && NILP (current_kboard->Vprefix_arg))
ff4b06d3
KH
1789 finalize_kbd_macro_chars ();
1790
c5fdd383 1791#ifdef MULTI_KBOARD
604ccd1d 1792 if (!was_locked)
1e8bd3da 1793 any_kboard_state ();
ff4b06d3 1794#endif
284f4730
JB
1795 }
1796}
1c9784c9 1797
adf5cb9c
KH
1798extern Lisp_Object Qcomposition, Qdisplay;
1799
1800/* Adjust point to a boundary of a region that has such a property
1801 that should be treated intangible. For the moment, we check
7e16ef60
SM
1802 `composition', `display' and `invisible' properties.
1803 LAST_PT is the last position of point. */
adf5cb9c 1804
14e40288
SM
1805extern Lisp_Object Qafter_string, Qbefore_string;
1806extern Lisp_Object get_pos_property P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
1807
adf5cb9c
KH
1808static void
1809adjust_point_for_property (last_pt)
1810 int last_pt;
1811{
7e16ef60
SM
1812 int beg, end;
1813 Lisp_Object val, overlay, tmp;
1814 int check_composition = 1, check_display = 1, check_invisible = 1;
adf5cb9c 1815
7e16ef60 1816 while (check_composition || check_display || check_invisible)
adf5cb9c
KH
1817 {
1818 if (check_composition
1819 && PT > BEGV && PT < ZV
7e16ef60
SM
1820 && get_property_and_range (PT, Qcomposition, &val, &beg, &end, Qnil)
1821 && COMPOSITION_VALID_P (beg, end, val)
1822 && beg < PT /* && end > PT <- It's always the case. */
1823 && (last_pt <= beg || last_pt >= end))
adf5cb9c 1824 {
14e40288 1825 xassert (end > PT);
7e16ef60 1826 SET_PT (PT < last_pt ? beg : end);
14e40288 1827 check_display = check_invisible = 1;
adf5cb9c
KH
1828 }
1829 check_composition = 0;
1830 if (check_display
1831 && PT > BEGV && PT < ZV
7e16ef60
SM
1832 && !NILP (val = get_char_property_and_overlay
1833 (make_number (PT), Qdisplay, Qnil, &overlay))
3e9ac4b7 1834 && display_prop_intangible_p (val)
7e16ef60
SM
1835 && (!OVERLAYP (overlay)
1836 ? get_property_and_range (PT, Qdisplay, &val, &beg, &end, Qnil)
1837 : (beg = OVERLAY_POSITION (OVERLAY_START (overlay)),
1838 end = OVERLAY_POSITION (OVERLAY_END (overlay))))
14e40288 1839 && beg < PT) /* && end > PT <- It's always the case. */
adf5cb9c 1840 {
14e40288 1841 xassert (end > PT);
7e16ef60 1842 SET_PT (PT < last_pt ? beg : end);
14e40288 1843 check_composition = check_invisible = 1;
adf5cb9c
KH
1844 }
1845 check_display = 0;
14e40288 1846 if (check_invisible && PT > BEGV && PT < ZV)
7e16ef60 1847 {
14e40288
SM
1848 int inv, ellipsis = 0;
1849 beg = end = PT;
1850
1851 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1852 while (end < ZV
1853 && !NILP (val = get_char_property_and_overlay
1854 (make_number (end), Qinvisible, Qnil, &overlay))
1855 && (inv = TEXT_PROP_MEANS_INVISIBLE (val)))
1856 {
1857 ellipsis = ellipsis || inv > 1
1858 || (OVERLAYP (overlay)
1859 && (!NILP (Foverlay_get (overlay, Qafter_string))
1860 || !NILP (Foverlay_get (overlay, Qbefore_string))));
1861 tmp = Fnext_single_char_property_change
1862 (make_number (end), Qinvisible, Qnil, Qnil);
1863 end = NATNUMP (tmp) ? XFASTINT (tmp) : ZV;
1864 }
1865 while (beg > BEGV
1866 && !NILP (val = get_char_property_and_overlay
1867 (make_number (beg - 1), Qinvisible, Qnil, &overlay))
1868 && (inv = TEXT_PROP_MEANS_INVISIBLE (val)))
1869 {
1870 ellipsis = ellipsis || inv > 1
1871 || (OVERLAYP (overlay)
1872 && (!NILP (Foverlay_get (overlay, Qafter_string))
1873 || !NILP (Foverlay_get (overlay, Qbefore_string))));
1874 tmp = Fprevious_single_char_property_change
1875 (make_number (beg), Qinvisible, Qnil, Qnil);
1876 beg = NATNUMP (tmp) ? XFASTINT (tmp) : BEGV;
1877 }
1878
1879 /* Move away from the inside area. */
1880 if (beg < PT && end > PT)
1881 {
1882 SET_PT (PT < last_pt ? beg : end);
1883 check_composition = check_display = 1;
1884 }
1885 xassert (PT == beg || PT == end);
1886 /* Pretend the area doesn't exist. */
1887 if (!ellipsis && beg < end)
1888 {
1889 if (last_pt == beg && PT == end && end < ZV)
1890 (check_composition = check_display = 1, SET_PT (end + 1));
1891 else if (last_pt == end && PT == beg && beg > BEGV)
1892 (check_composition = check_display = 1, SET_PT (beg - 1));
1893 else if (PT == ((PT < last_pt) ? beg : end))
1894 /* We've already moved as far as we can. Trying to go
1895 to the other end would mean moving backwards and thus
1896 could lead to an infinite loop. */
1897 ;
1898 else if (val = get_pos_property (make_number (PT),
1899 Qinvisible, Qnil),
1900 TEXT_PROP_MEANS_INVISIBLE (val)
1901 && (val = get_pos_property
1902 (make_number (PT == beg ? end : beg),
1903 Qinvisible, Qnil),
1904 !TEXT_PROP_MEANS_INVISIBLE (val)))
1905 (check_composition = check_display = 1,
1906 SET_PT (PT == beg ? end : beg));
1907 }
7e16ef60
SM
1908 }
1909 check_invisible = 0;
adf5cb9c
KH
1910 }
1911}
1912
0bc3db2b
RS
1913/* Subroutine for safe_run_hooks: run the hook HOOK. */
1914
1915static Lisp_Object
1916safe_run_hooks_1 (hook)
1917 Lisp_Object hook;
1918{
1919 return call1 (Vrun_hooks, Vinhibit_quit);
1920}
1921
1922/* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1923
1924static Lisp_Object
1925safe_run_hooks_error (data)
1926 Lisp_Object data;
1927{
30690496 1928 return Fset (Vinhibit_quit, Qnil);
0bc3db2b
RS
1929}
1930
1c9784c9
KH
1931/* If we get an error while running the hook, cause the hook variable
1932 to be nil. Also inhibit quits, so that C-g won't cause the hook
1933 to mysteriously evaporate. */
0bc3db2b 1934
68f297c5 1935void
1c9784c9 1936safe_run_hooks (hook)
a98ea3f9 1937 Lisp_Object hook;
1c9784c9 1938{
aed13378 1939 int count = SPECPDL_INDEX ();
0bc3db2b
RS
1940 specbind (Qinhibit_quit, hook);
1941
e702932d 1942 internal_condition_case (safe_run_hooks_1, Qt, safe_run_hooks_error);
1c9784c9
KH
1943
1944 unbind_to (count, Qnil);
1945}
8a9f5d3c 1946
284f4730 1947\f
8a9f5d3c
GM
1948/* Number of seconds between polling for input. This is a Lisp
1949 variable that can be bound. */
1950
31ade731 1951EMACS_INT polling_period;
284f4730 1952
eb8c3be9 1953/* Nonzero means polling for input is temporarily suppressed. */
8a9f5d3c 1954
284f4730
JB
1955int poll_suppress_count;
1956
8a9f5d3c
GM
1957/* Asynchronous timer for polling. */
1958
1959struct atimer *poll_timer;
1960
284f4730 1961
36922b18
RS
1962#ifdef POLL_FOR_INPUT
1963
8a9f5d3c
GM
1964/* Poll for input, so what we catch a C-g if it comes in. This
1965 function is called from x_make_frame_visible, see comment
1966 there. */
284f4730 1967
8a9f5d3c
GM
1968void
1969poll_for_input_1 ()
284f4730 1970{
9ac0d9e0
JB
1971 if (interrupt_input_blocked == 0
1972 && !waiting_for_input)
1973 read_avail_input (0);
284f4730
JB
1974}
1975
8a9f5d3c
GM
1976/* Timer callback function for poll_timer. TIMER is equal to
1977 poll_timer. */
1978
1979void
1980poll_for_input (timer)
1981 struct atimer *timer;
1982{
1983 if (poll_suppress_count == 0)
1984 poll_for_input_1 ();
1985}
1986
1987#endif /* POLL_FOR_INPUT */
284f4730
JB
1988
1989/* Begin signals to poll for input, if they are appropriate.
1990 This function is called unconditionally from various places. */
1991
07a59269 1992void
284f4730
JB
1993start_polling ()
1994{
1995#ifdef POLL_FOR_INPUT
34f04431 1996 if (read_socket_hook && !interrupt_input)
284f4730 1997 {
8a9f5d3c
GM
1998 /* Turn alarm handling on unconditionally. It might have
1999 been turned off in process.c. */
2000 turn_on_atimers (1);
2001
2002 /* If poll timer doesn't exist, are we need one with
2003 a different interval, start a new one. */
2004 if (poll_timer == NULL
2005 || EMACS_SECS (poll_timer->interval) != polling_period)
284f4730 2006 {
8a9f5d3c
GM
2007 EMACS_TIME interval;
2008
2009 if (poll_timer)
2010 cancel_atimer (poll_timer);
2011
2012 EMACS_SET_SECS_USECS (interval, polling_period, 0);
2013 poll_timer = start_atimer (ATIMER_CONTINUOUS, interval,
2014 poll_for_input, NULL);
284f4730 2015 }
8a9f5d3c
GM
2016
2017 /* Let the timer's callback function poll for input
2018 if this becomes zero. */
2019 --poll_suppress_count;
284f4730
JB
2020 }
2021#endif
2022}
2023
1d3195db
RS
2024/* Nonzero if we are using polling to handle input asynchronously. */
2025
2026int
2027input_polling_used ()
2028{
2029#ifdef POLL_FOR_INPUT
2030 return read_socket_hook && !interrupt_input;
2031#else
2032 return 0;
2033#endif
2034}
2035
284f4730
JB
2036/* Turn off polling. */
2037
07a59269 2038void
284f4730
JB
2039stop_polling ()
2040{
2041#ifdef POLL_FOR_INPUT
34f04431 2042 if (read_socket_hook && !interrupt_input)
8a9f5d3c 2043 ++poll_suppress_count;
284f4730
JB
2044#endif
2045}
fe8aeef3
RS
2046
2047/* Set the value of poll_suppress_count to COUNT
2048 and start or stop polling accordingly. */
2049
2050void
2051set_poll_suppress_count (count)
2052 int count;
2053{
2054#ifdef POLL_FOR_INPUT
2055 if (count == 0 && poll_suppress_count != 0)
2056 {
2057 poll_suppress_count = 1;
2058 start_polling ();
2059 }
2060 else if (count != 0 && poll_suppress_count == 0)
2061 {
2062 stop_polling ();
2063 }
2064 poll_suppress_count = count;
2065#endif
2066}
f4eef8b4 2067
d0a57728
RS
2068/* Bind polling_period to a value at least N.
2069 But don't decrease it. */
2070
07a59269 2071void
f4eef8b4
RS
2072bind_polling_period (n)
2073 int n;
2074{
2075#ifdef POLL_FOR_INPUT
d0a57728
RS
2076 int new = polling_period;
2077
2078 if (n > new)
2079 new = n;
2080
6fe007f7 2081 stop_other_atimers (poll_timer);
f4eef8b4 2082 stop_polling ();
d0a57728
RS
2083 specbind (Qpolling_period, make_number (new));
2084 /* Start a new alarm with the new period. */
f4eef8b4
RS
2085 start_polling ();
2086#endif
2087}
284f4730 2088\f
6da3dd3a
RS
2089/* Apply the control modifier to CHARACTER. */
2090
faf5e407
JB
2091int
2092make_ctrl_char (c)
2093 int c;
2094{
d205953b
JB
2095 /* Save the upper bits here. */
2096 int upper = c & ~0177;
2097
2098 c &= 0177;
2099
2100 /* Everything in the columns containing the upper-case letters
2101 denotes a control character. */
2102 if (c >= 0100 && c < 0140)
2103 {
2104 int oc = c;
2105 c &= ~0140;
2106 /* Set the shift modifier for a control char
2107 made from a shifted letter. But only for letters! */
2108 if (oc >= 'A' && oc <= 'Z')
2109 c |= shift_modifier;
2110 }
2111
2112 /* The lower-case letters denote control characters too. */
2113 else if (c >= 'a' && c <= 'z')
2114 c &= ~0140;
2115
2116 /* Include the bits for control and shift
2117 only if the basic ASCII code can't indicate them. */
2118 else if (c >= ' ')
2119 c |= ctrl_modifier;
2120
2121 /* Replace the high bits. */
2122 c |= (upper & ~ctrl_modifier);
faf5e407
JB
2123
2124 return c;
2125}
2126
d4e68eea
GM
2127/* Display help echo in the echo area.
2128
8dfd92c9
GM
2129 HELP a string means display that string, HELP nil means clear the
2130 help echo. If HELP is a function, call it with OBJECT and POS as
2131 arguments; the function should return a help string or nil for
2132 none. For all other types of HELP evaluate it to obtain a string.
2133
2190735a
GM
2134 WINDOW is the window in which the help was generated, if any.
2135 It is nil if not in a window.
2136
5b2ec2d0
GM
2137 If OBJECT is a buffer, POS is the position in the buffer where the
2138 `help-echo' text property was found.
2139
2140 If OBJECT is an overlay, that overlay has a `help-echo' property,
2141 and POS is the position in the overlay's buffer under the mouse.
2142
2143 If OBJECT is a string (an overlay string or a string displayed with
2144 the `display' property). POS is the position in that string under
2145 the mouse.
d4e68eea 2146
27fd22dc 2147 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
d4e68eea
GM
2148 echo overwrites a keystroke echo currently displayed in the echo
2149 area.
2150
8dfd92c9
GM
2151 Note: this function may only be called with HELP nil or a string
2152 from X code running asynchronously. */
d4e68eea 2153
31f84d03 2154void
2190735a
GM
2155show_help_echo (help, window, object, pos, ok_to_overwrite_keystroke_echo)
2156 Lisp_Object help, window, object, pos;
adc84f48 2157 int ok_to_overwrite_keystroke_echo;
31f84d03 2158{
8dfd92c9 2159 if (!NILP (help) && !STRINGP (help))
d4e68eea 2160 {
8dfd92c9
GM
2161 if (FUNCTIONP (help))
2162 {
2190735a 2163 Lisp_Object args[4];
8dfd92c9 2164 args[0] = help;
2190735a
GM
2165 args[1] = window;
2166 args[2] = object;
2167 args[3] = pos;
1db0076e 2168 help = safe_call (4, args);
8dfd92c9
GM
2169 }
2170 else
1db0076e 2171 help = safe_eval (help);
8dfd92c9
GM
2172
2173 if (!STRINGP (help))
d4e68eea 2174 return;
31f84d03
SM
2175 }
2176
8dfd92c9 2177 if (STRINGP (help) || NILP (help))
d4e68eea
GM
2178 {
2179 if (!NILP (Vshow_help_function))
8dfd92c9 2180 call1 (Vshow_help_function, help);
d4e68eea
GM
2181 else if (/* Don't overwrite minibuffer contents. */
2182 !MINI_WINDOW_P (XWINDOW (selected_window))
2183 /* Don't overwrite a keystroke echo. */
8dfd92c9
GM
2184 && (NILP (echo_message_buffer)
2185 || ok_to_overwrite_keystroke_echo)
d4e68eea
GM
2186 /* Don't overwrite a prompt. */
2187 && !cursor_in_echo_area)
2188 {
8dfd92c9 2189 if (STRINGP (help))
d4e68eea 2190 {
331379bf 2191 int count = SPECPDL_INDEX ();
f0c1cc56
GM
2192
2193 if (!help_echo_showing_p)
2194 Vpre_help_message = current_message ();
2195
d4e68eea 2196 specbind (Qmessage_truncate_lines, Qt);
d5db4077 2197 message3_nolog (help, SBYTES (help),
8dfd92c9 2198 STRING_MULTIBYTE (help));
d4e68eea
GM
2199 unbind_to (count, Qnil);
2200 }
f0c1cc56
GM
2201 else if (STRINGP (Vpre_help_message))
2202 {
2203 message3_nolog (Vpre_help_message,
d5db4077 2204 SBYTES (Vpre_help_message),
f0c1cc56
GM
2205 STRING_MULTIBYTE (Vpre_help_message));
2206 Vpre_help_message = Qnil;
2207 }
d4e68eea 2208 else
f0c1cc56 2209 message (0);
d4e68eea 2210 }
5295a500
GM
2211
2212 help_echo_showing_p = STRINGP (help);
d4e68eea 2213 }
31f84d03
SM
2214}
2215
faf5e407
JB
2216
2217\f
284f4730
JB
2218/* Input of single characters from keyboard */
2219
2220Lisp_Object print_help ();
2221static Lisp_Object kbd_buffer_get_event ();
e4fe371d 2222static void record_char ();
284f4730 2223
c5fdd383
KH
2224#ifdef MULTI_KBOARD
2225static jmp_buf wrong_kboard_jmpbuf;
bded54dd 2226#endif
beecf6a1 2227
184c3d81
RS
2228#define STOP_POLLING \
2229do { if (! polling_stopped_here) stop_polling (); \
2230 polling_stopped_here = 1; } while (0)
2231
2232#define RESUME_POLLING \
2233do { if (polling_stopped_here) start_polling (); \
2234 polling_stopped_here = 0; } while (0)
2235
284f4730
JB
2236/* read a character from the keyboard; call the redisplay if needed */
2237/* commandflag 0 means do not do auto-saving, but do do redisplay.
2238 -1 means do not do redisplay, but do do autosaving.
2239 1 means do both. */
2240
7d6de002
RS
2241/* The arguments MAPS and NMAPS are for menu prompting.
2242 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2243
2244 PREV_EVENT is the previous input event, or nil if we are reading
b638f328
RS
2245 the first event of a key sequence (or not reading a key sequence).
2246 If PREV_EVENT is t, that is a "magic" value that says
2247 not to run input methods, but in other respects to act as if
2248 not reading a key sequence.
7d6de002 2249
83d68044 2250 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
6569cc8d 2251 if we used a mouse menu to read the input, or zero otherwise. If
83d68044 2252 USED_MOUSE_MENU is null, we don't dereference it.
dcc408a0
RS
2253
2254 Value is t if we showed a menu and the user rejected it. */
7d6de002 2255
284f4730 2256Lisp_Object
7d6de002 2257read_char (commandflag, nmaps, maps, prev_event, used_mouse_menu)
284f4730 2258 int commandflag;
7d6de002
RS
2259 int nmaps;
2260 Lisp_Object *maps;
2261 Lisp_Object prev_event;
2262 int *used_mouse_menu;
284f4730 2263{
8c907a56 2264 volatile Lisp_Object c;
284f4730 2265 int count;
410d4de9 2266 jmp_buf local_getcjmp;
284f4730 2267 jmp_buf save_jump;
8c907a56 2268 volatile int key_already_recorded = 0;
017c7cb6 2269 Lisp_Object tem, save;
8c907a56
GM
2270 volatile Lisp_Object previous_echo_area_message;
2271 volatile Lisp_Object also_record;
2272 volatile int reread;
d5eecefb 2273 struct gcpro gcpro1, gcpro2;
fdbb67fe 2274 EMACS_TIME last_idle_start;
184c3d81 2275 int polling_stopped_here = 0;
7c3bc944 2276
e4fe371d 2277 also_record = Qnil;
284f4730 2278
71918b75
RS
2279 before_command_key_count = this_command_key_count;
2280 before_command_echo_length = echo_length ();
ef6661f7 2281 c = Qnil;
7ee32cda 2282 previous_echo_area_message = Qnil;
71918b75 2283
7ee32cda 2284 GCPRO2 (c, previous_echo_area_message);
7c3bc944 2285
7f07d5ca
RS
2286 retry:
2287
7d18f9ae
RS
2288 reread = 0;
2289 if (CONSP (Vunread_post_input_method_events))
284f4730 2290 {
7539e11f 2291 c = XCAR (Vunread_post_input_method_events);
7d18f9ae 2292 Vunread_post_input_method_events
7539e11f 2293 = XCDR (Vunread_post_input_method_events);
284f4730 2294
2479e91e
RS
2295 /* Undo what read_char_x_menu_prompt did when it unread
2296 additional keys returned by Fx_popup_menu. */
2297 if (CONSP (c)
7539e11f
KR
2298 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c)))
2299 && NILP (XCDR (c)))
2300 c = XCAR (c);
2479e91e 2301
7d18f9ae
RS
2302 reread = 1;
2303 goto reread_first;
284f4730
JB
2304 }
2305
86e5706b
RS
2306 if (unread_command_char != -1)
2307 {
18cd2eeb 2308 XSETINT (c, unread_command_char);
86e5706b
RS
2309 unread_command_char = -1;
2310
7d18f9ae
RS
2311 reread = 1;
2312 goto reread_first;
2313 }
2314
2315 if (CONSP (Vunread_command_events))
2316 {
7539e11f
KR
2317 c = XCAR (Vunread_command_events);
2318 Vunread_command_events = XCDR (Vunread_command_events);
7d18f9ae
RS
2319
2320 /* Undo what read_char_x_menu_prompt did when it unread
2321 additional keys returned by Fx_popup_menu. */
2322 if (CONSP (c)
f4e05d97
GM
2323 && EQ (XCDR (c), Qdisabled)
2324 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c))))
7539e11f 2325 c = XCAR (c);
f4e05d97 2326
d17e49a8
GM
2327 /* If the queued event is something that used the mouse,
2328 set used_mouse_menu accordingly. */
2329 if (used_mouse_menu
2330 && (EQ (c, Qtool_bar) || EQ (c, Qmenu_bar)))
2331 *used_mouse_menu = 1;
2332
7d18f9ae
RS
2333 reread = 1;
2334 goto reread_for_input_method;
2335 }
2336
2337 if (CONSP (Vunread_input_method_events))
2338 {
7539e11f
KR
2339 c = XCAR (Vunread_input_method_events);
2340 Vunread_input_method_events = XCDR (Vunread_input_method_events);
7d18f9ae
RS
2341
2342 /* Undo what read_char_x_menu_prompt did when it unread
2343 additional keys returned by Fx_popup_menu. */
2344 if (CONSP (c)
7539e11f
KR
2345 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c)))
2346 && NILP (XCDR (c)))
2347 c = XCAR (c);
7d18f9ae
RS
2348 reread = 1;
2349 goto reread_for_input_method;
86e5706b
RS
2350 }
2351
71918b75
RS
2352 /* If there is no function key translated before
2353 reset-this-command-lengths takes effect, forget about it. */
2354 before_command_restore_flag = 0;
2355
284f4730
JB
2356 if (!NILP (Vexecuting_macro))
2357 {
fce33686
JB
2358 /* We set this to Qmacro; since that's not a frame, nobody will
2359 try to switch frames on us, and the selected window will
2360 remain unchanged.
2361
2362 Since this event came from a macro, it would be misleading to
eb8c3be9 2363 leave internal_last_event_frame set to wherever the last
3c370943
JB
2364 real event came from. Normally, a switch-frame event selects
2365 internal_last_event_frame after each command is read, but
2366 events read from a macro should never cause a new frame to be
2367 selected. */
4c52b668 2368 Vlast_event_frame = internal_last_event_frame = Qmacro;
fce33686 2369
663258f2
JB
2370 /* Exit the macro if we are at the end.
2371 Also, some things replace the macro with t
2372 to force an early exit. */
2373 if (EQ (Vexecuting_macro, Qt)
2374 || executing_macro_index >= XFASTINT (Flength (Vexecuting_macro)))
284f4730 2375 {
18cd2eeb 2376 XSETINT (c, -1);
184c3d81 2377 goto exit;
284f4730 2378 }
df0f2ba1 2379
284f4730 2380 c = Faref (Vexecuting_macro, make_number (executing_macro_index));
8c18cbfb 2381 if (STRINGP (Vexecuting_macro)
86e5706b 2382 && (XINT (c) & 0x80))
bb9e9bed 2383 XSETFASTINT (c, CHAR_META | (XINT (c) & ~0x80));
86e5706b 2384
284f4730
JB
2385 executing_macro_index++;
2386
2387 goto from_macro;
2388 }
2389
cd21b839
JB
2390 if (!NILP (unread_switch_frame))
2391 {
2392 c = unread_switch_frame;
2393 unread_switch_frame = Qnil;
2394
2395 /* This event should make it into this_command_keys, and get echoed
7d18f9ae 2396 again, so we do not set `reread'. */
f4255cd1 2397 goto reread_first;
cd21b839
JB
2398 }
2399
adc1d5c8 2400 /* if redisplay was requested */
6e4e64a8
RS
2401 if (commandflag >= 0)
2402 {
adc1d5c8
RS
2403 /* If there is pending input, process any events which are not
2404 user-visible, such as X selection_request events. */
6e4e64a8
RS
2405 if (input_pending
2406 || detect_input_pending_run_timers (0))
adc1d5c8 2407 swallow_events (0); /* may clear input_pending */
6e4e64a8 2408
adc1d5c8
RS
2409 /* Redisplay if no pending input. */
2410 while (!input_pending)
2411 {
5295a500 2412 if (help_echo_showing_p && !EQ (selected_window, minibuf_window))
3007ebfb 2413 redisplay_preserve_echo_area (5);
5295a500
GM
2414 else
2415 redisplay ();
adc1d5c8
RS
2416
2417 if (!input_pending)
2418 /* Normal case: no input arrived during redisplay. */
2419 break;
2420
2421 /* Input arrived and pre-empted redisplay.
2422 Process any events which are not user-visible. */
2423 swallow_events (0);
2424 /* If that cleared input_pending, try again to redisplay. */
2425 }
6e4e64a8 2426 }
e9bf89a0 2427
59a84f8e
GM
2428 /* Message turns off echoing unless more keystrokes turn it on again.
2429
2430 The code in 20.x for the condition was
2431
2432 1. echo_area_glyphs && *echo_area_glyphs
2433 2. && echo_area_glyphs != current_kboard->echobuf
2434 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2435
2436 (1) means there's a current message displayed
2437
2438 (2) means it's not the message from echoing from the current
2439 kboard.
2440
2441 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2442 is set to a non-null value. This is done in read_char and it is
2443 set to echo_area_glyphs after a call to echo_char. That means
2444 ok_to_echo_at_next_pause is either null or
2445 current_kboard->echobuf with the appropriate current_kboard at
2446 that time.
2447
2448 So, condition (3) means in clear text ok_to_echo_at_next_pause
2449 must be either null, or the current message isn't from echoing at
2450 all, or it's from echoing from a different kboard than the
2451 current one. */
2452
27fd22dc 2453 if (/* There currently is something in the echo area. */
985f9f66 2454 !NILP (echo_area_buffer[0])
59a84f8e
GM
2455 && (/* And it's either not from echoing. */
2456 !EQ (echo_area_buffer[0], echo_message_buffer)
2457 /* Or it's an echo from a different kboard. */
2458 || echo_kboard != current_kboard
2459 /* Or we explicitly allow overwriting whatever there is. */
2460 || ok_to_echo_at_next_pause == NULL))
7ee32cda 2461 cancel_echoing ();
410d4de9 2462 else
410d4de9 2463 echo_dash ();
59a84f8e 2464
410d4de9
RS
2465 /* Try reading a character via menu prompting in the minibuf.
2466 Try this before the sit-for, because the sit-for
2467 would do the wrong thing if we are supposed to do
2468 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2469 after a mouse event so don't try a minibuf menu. */
2470 c = Qnil;
2471 if (nmaps > 0 && INTERACTIVE
2472 && !NILP (prev_event) && ! EVENT_HAS_PARAMETERS (prev_event)
2473 /* Don't bring up a menu if we already have another event. */
2474 && NILP (Vunread_command_events)
2475 && unread_command_char < 0
4ec4ed6a 2476 && !detect_input_pending_run_timers (0))
410d4de9
RS
2477 {
2478 c = read_char_minibuf_menu_prompt (commandflag, nmaps, maps);
2479 if (! NILP (c))
2480 {
2481 key_already_recorded = 1;
2482 goto non_reread_1;
2483 }
2484 }
284f4730 2485
410d4de9
RS
2486 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2487 We will do that below, temporarily for short sections of code,
2488 when appropriate. local_getcjmp must be in effect
2489 around any call to sit_for or kbd_buffer_get_event;
2490 it *must not* be in effect when we call redisplay. */
284f4730 2491
410d4de9 2492 if (_setjmp (local_getcjmp))
284f4730 2493 {
18cd2eeb 2494 XSETINT (c, quit_char);
788f89eb 2495 internal_last_event_frame = selected_frame;
4c52b668 2496 Vlast_event_frame = internal_last_event_frame;
04904c29
RS
2497 /* If we report the quit char as an event,
2498 don't do so more than once. */
2499 if (!NILP (Vinhibit_quit))
2500 Vquit_flag = Qnil;
284f4730 2501
c5fdd383 2502#ifdef MULTI_KBOARD
df0f2ba1 2503 {
788f89eb 2504 KBOARD *kb = FRAME_KBOARD (XFRAME (selected_frame));
c5fdd383 2505 if (kb != current_kboard)
df0f2ba1 2506 {
f3fbd155 2507 Lisp_Object link = kb->kbd_queue;
1e8bd3da
RS
2508 /* We shouldn't get here if we were in single-kboard mode! */
2509 if (single_kboard)
df0f2ba1 2510 abort ();
f3fbd155
KR
2511 if (CONSP (link))
2512 {
2513 while (CONSP (XCDR (link)))
2514 link = XCDR (link);
2515 if (!NILP (XCDR (link)))
2516 abort ();
2517 }
2518 if (!CONSP (link))
2519 kb->kbd_queue = Fcons (c, Qnil);
2520 else
2521 XSETCDR (link, Fcons (c, Qnil));
c5fdd383
KH
2522 kb->kbd_queue_has_data = 1;
2523 current_kboard = kb;
ef6661f7
RS
2524 /* This is going to exit from read_char
2525 so we had better get rid of this frame's stuff. */
2526 UNGCPRO;
c5fdd383 2527 longjmp (wrong_kboard_jmpbuf, 1);
df0f2ba1
KH
2528 }
2529 }
2530#endif
284f4730
JB
2531 goto non_reread;
2532 }
2533
d9d4c147
KH
2534 timer_start_idle ();
2535
284f4730
JB
2536 /* If in middle of key sequence and minibuffer not active,
2537 start echoing if enough time elapses. */
410d4de9 2538
7ee32cda
GM
2539 if (minibuf_level == 0
2540 && !current_kboard->immediate_echo
6c6083a9 2541 && this_command_key_count > 0
27203ead 2542 && ! noninteractive
f2647d04
DL
2543 && (FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
2544 && NILP (Fzerop (Vecho_keystrokes))
985f9f66
GM
2545 && (/* No message. */
2546 NILP (echo_area_buffer[0])
2547 /* Or empty message. */
2548 || (BUF_BEG (XBUFFER (echo_area_buffer[0]))
2549 == BUF_Z (XBUFFER (echo_area_buffer[0])))
2550 /* Or already echoing from same kboard. */
2551 || (echo_kboard && ok_to_echo_at_next_pause == echo_kboard)
2552 /* Or not echoing before and echoing allowed. */
2553 || (!echo_kboard && ok_to_echo_at_next_pause)))
284f4730
JB
2554 {
2555 Lisp_Object tem0;
985f9f66 2556
7d6de002
RS
2557 /* After a mouse event, start echoing right away.
2558 This is because we are probably about to display a menu,
2559 and we don't want to delay before doing so. */
dbc4e1c1 2560 if (EVENT_HAS_PARAMETERS (prev_event))
3dbd9ee4 2561 echo_now ();
7d6de002
RS
2562 else
2563 {
39aab679
DL
2564 int sec, usec;
2565 double duration = extract_float (Vecho_keystrokes);
2566 sec = (int) duration;
15fa88ab 2567 usec = (duration - sec) * 1000000;
410d4de9
RS
2568 save_getcjmp (save_jump);
2569 restore_getcjmp (local_getcjmp);
39aab679 2570 tem0 = sit_for (sec, usec, 1, 1, 0);
410d4de9 2571 restore_getcjmp (save_jump);
303b5b3f
RS
2572 if (EQ (tem0, Qt)
2573 && ! CONSP (Vunread_command_events))
3dbd9ee4 2574 echo_now ();
7d6de002 2575 }
284f4730
JB
2576 }
2577
410d4de9 2578 /* Maybe auto save due to number of keystrokes. */
284f4730
JB
2579
2580 if (commandflag != 0
2581 && auto_save_interval > 0
c43b1734 2582 && num_nonmacro_input_events - last_auto_save > max (auto_save_interval, 20)
4ec4ed6a 2583 && !detect_input_pending_run_timers (0))
284f4730 2584 {
284f4730 2585 Fdo_auto_save (Qnil, Qnil);
ef8fd672
RS
2586 /* Hooks can actually change some buffers in auto save. */
2587 redisplay ();
284f4730
JB
2588 }
2589
8150596a 2590 /* Try reading using an X menu.
24597608
RS
2591 This is never confused with reading using the minibuf
2592 because the recursive call of read_char in read_char_minibuf_menu_prompt
2593 does not pass on any keymaps. */
410d4de9 2594
24597608 2595 if (nmaps > 0 && INTERACTIVE
5a8d99e0
KH
2596 && !NILP (prev_event)
2597 && EVENT_HAS_PARAMETERS (prev_event)
7539e11f
KR
2598 && !EQ (XCAR (prev_event), Qmenu_bar)
2599 && !EQ (XCAR (prev_event), Qtool_bar)
24597608
RS
2600 /* Don't bring up a menu if we already have another event. */
2601 && NILP (Vunread_command_events)
b8556aee 2602 && unread_command_char < 0)
8eb4d8ef
RS
2603 {
2604 c = read_char_x_menu_prompt (nmaps, maps, prev_event, used_mouse_menu);
2605
2606 /* Now that we have read an event, Emacs is not idle. */
2607 timer_stop_idle ();
2608
184c3d81 2609 goto exit;
8eb4d8ef 2610 }
7d6de002 2611
410d4de9
RS
2612 /* Maybe autosave and/or garbage collect due to idleness. */
2613
26c1639e 2614 if (INTERACTIVE && NILP (c))
7d6de002
RS
2615 {
2616 int delay_level, buffer_size;
2617
410d4de9
RS
2618 /* Slow down auto saves logarithmically in size of current buffer,
2619 and garbage collect while we're at it. */
7d6de002
RS
2620 if (! MINI_WINDOW_P (XWINDOW (selected_window)))
2621 last_non_minibuf_size = Z - BEG;
2622 buffer_size = (last_non_minibuf_size >> 8) + 1;
2623 delay_level = 0;
2624 while (buffer_size > 64)
2625 delay_level++, buffer_size -= buffer_size >> 2;
2626 if (delay_level < 4) delay_level = 4;
2627 /* delay_level is 4 for files under around 50k, 7 at 100k,
2628 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2629
2630 /* Auto save if enough time goes by without input. */
2631 if (commandflag != 0
c43b1734 2632 && num_nonmacro_input_events > last_auto_save
8c18cbfb 2633 && INTEGERP (Vauto_save_timeout)
7d6de002
RS
2634 && XINT (Vauto_save_timeout) > 0)
2635 {
2636 Lisp_Object tem0;
410d4de9
RS
2637
2638 save_getcjmp (save_jump);
2639 restore_getcjmp (local_getcjmp);
d9d4c147 2640 tem0 = sit_for (delay_level * XFASTINT (Vauto_save_timeout) / 4,
41365083 2641 0, 1, 1, 0);
410d4de9
RS
2642 restore_getcjmp (save_jump);
2643
303b5b3f
RS
2644 if (EQ (tem0, Qt)
2645 && ! CONSP (Vunread_command_events))
7d6de002 2646 {
7d6de002 2647 Fdo_auto_save (Qnil, Qnil);
7d6de002
RS
2648
2649 /* If we have auto-saved and there is still no input
2650 available, garbage collect if there has been enough
2651 consing going on to make it worthwhile. */
4ec4ed6a 2652 if (!detect_input_pending_run_timers (0)
7d6de002 2653 && consing_since_gc > gc_cons_threshold / 2)
ef8fd672 2654 Fgarbage_collect ();
410d4de9 2655
ef8fd672 2656 redisplay ();
7d6de002
RS
2657 }
2658 }
2659 }
284f4730 2660
303b5b3f
RS
2661 /* If this has become non-nil here, it has been set by a timer
2662 or sentinel or filter. */
2663 if (CONSP (Vunread_command_events))
2664 {
7539e11f
KR
2665 c = XCAR (Vunread_command_events);
2666 Vunread_command_events = XCDR (Vunread_command_events);
303b5b3f
RS
2667 }
2668
410d4de9
RS
2669 /* Read something from current KBOARD's side queue, if possible. */
2670
beecf6a1 2671 if (NILP (c))
1e12dd87 2672 {
c5fdd383 2673 if (current_kboard->kbd_queue_has_data)
beecf6a1 2674 {
c5fdd383 2675 if (!CONSP (current_kboard->kbd_queue))
4524b161 2676 abort ();
7539e11f 2677 c = XCAR (current_kboard->kbd_queue);
c5fdd383 2678 current_kboard->kbd_queue
7539e11f 2679 = XCDR (current_kboard->kbd_queue);
c5fdd383
KH
2680 if (NILP (current_kboard->kbd_queue))
2681 current_kboard->kbd_queue_has_data = 0;
d9d4c147 2682 input_pending = readable_events (0);
4c52b668
KH
2683 if (EVENT_HAS_PARAMETERS (c)
2684 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qswitch_frame))
7539e11f 2685 internal_last_event_frame = XCAR (XCDR (c));
4c52b668 2686 Vlast_event_frame = internal_last_event_frame;
beecf6a1 2687 }
1e8bd3da
RS
2688 }
2689
c5fdd383 2690#ifdef MULTI_KBOARD
1e8bd3da
RS
2691 /* If current_kboard's side queue is empty check the other kboards.
2692 If one of them has data that we have not yet seen here,
2693 switch to it and process the data waiting for it.
2694
2695 Note: if the events queued up for another kboard
2696 have already been seen here, and therefore are not a complete command,
2697 the kbd_queue_has_data field is 0, so we skip that kboard here.
2698 That's to avoid an infinite loop switching between kboards here. */
2699 if (NILP (c) && !single_kboard)
2700 {
2701 KBOARD *kb;
2702 for (kb = all_kboards; kb; kb = kb->next_kboard)
2703 if (kb->kbd_queue_has_data)
2704 {
2705 current_kboard = kb;
ef6661f7
RS
2706 /* This is going to exit from read_char
2707 so we had better get rid of this frame's stuff. */
2708 UNGCPRO;
1e8bd3da
RS
2709 longjmp (wrong_kboard_jmpbuf, 1);
2710 }
2711 }
df0f2ba1
KH
2712#endif
2713
410d4de9
RS
2714 wrong_kboard:
2715
184c3d81 2716 STOP_POLLING;
410d4de9 2717
1e8bd3da
RS
2718 /* Finally, we read from the main queue,
2719 and if that gives us something we can't use yet, we put it on the
2720 appropriate side queue and try again. */
410d4de9 2721
1e8bd3da
RS
2722 if (NILP (c))
2723 {
2724 KBOARD *kb;
2725
1e8bd3da 2726 /* Actually read a character, waiting if necessary. */
410d4de9
RS
2727 save_getcjmp (save_jump);
2728 restore_getcjmp (local_getcjmp);
5b7bc0da 2729 timer_start_idle ();
83d68044 2730 c = kbd_buffer_get_event (&kb, used_mouse_menu);
410d4de9
RS
2731 restore_getcjmp (save_jump);
2732
c5fdd383 2733#ifdef MULTI_KBOARD
410d4de9 2734 if (! NILP (c) && (kb != current_kboard))
1e8bd3da 2735 {
f3fbd155
KR
2736 Lisp_Object link = kb->kbd_queue;
2737 if (CONSP (link))
2738 {
2739 while (CONSP (XCDR (link)))
2740 link = XCDR (link);
2741 if (!NILP (XCDR (link)))
2742 abort ();
2743 }
2744 if (!CONSP (link))
2745 kb->kbd_queue = Fcons (c, Qnil);
2746 else
2747 XSETCDR (link, Fcons (c, Qnil));
1e8bd3da 2748 kb->kbd_queue_has_data = 1;
46b84797 2749 c = Qnil;
1e8bd3da
RS
2750 if (single_kboard)
2751 goto wrong_kboard;
2752 current_kboard = kb;
ef6661f7
RS
2753 /* This is going to exit from read_char
2754 so we had better get rid of this frame's stuff. */
2755 UNGCPRO;
1e8bd3da 2756 longjmp (wrong_kboard_jmpbuf, 1);
df0f2ba1 2757 }
1e8bd3da 2758#endif
beecf6a1 2759 }
1e8bd3da 2760
284f4730 2761 /* Terminate Emacs in batch mode if at eof. */
8c18cbfb 2762 if (noninteractive && INTEGERP (c) && XINT (c) < 0)
284f4730
JB
2763 Fkill_emacs (make_number (1));
2764
8c18cbfb 2765 if (INTEGERP (c))
80645119
JB
2766 {
2767 /* Add in any extra modifiers, where appropriate. */
2768 if ((extra_keyboard_modifiers & CHAR_CTL)
2769 || ((extra_keyboard_modifiers & 0177) < ' '
2770 && (extra_keyboard_modifiers & 0177) != 0))
faf5e407 2771 XSETINT (c, make_ctrl_char (XINT (c)));
80645119
JB
2772
2773 /* Transfer any other modifier bits directly from
2774 extra_keyboard_modifiers to c. Ignore the actual character code
2775 in the low 16 bits of extra_keyboard_modifiers. */
b8d9050d 2776 XSETINT (c, XINT (c) | (extra_keyboard_modifiers & ~0xff7f & ~CHAR_CTL));
80645119 2777 }
9fa4395d 2778
284f4730
JB
2779 non_reread:
2780
fdbb67fe
GM
2781 /* Record the last idle start time so that we can reset it
2782 should the next event read be a help-echo. */
2783 last_idle_start = timer_idleness_start_time;
2fb9049e 2784 timer_stop_idle ();
184c3d81 2785 RESUME_POLLING;
284f4730 2786
410d4de9
RS
2787 if (NILP (c))
2788 {
2789 if (commandflag >= 0
4ec4ed6a 2790 && !input_pending && !detect_input_pending_run_timers (0))
410d4de9
RS
2791 redisplay ();
2792
2793 goto wrong_kboard;
2794 }
2795
2796 non_reread_1:
2797
dfd11da7 2798 /* Buffer switch events are only for internal wakeups
7c3bc944
RS
2799 so don't show them to the user.
2800 Also, don't record a key if we already did. */
2801 if (BUFFERP (c) || key_already_recorded)
184c3d81 2802 goto exit;
a1341f75 2803
7f07d5ca
RS
2804 /* Process special events within read_char
2805 and loop around to read another event. */
017c7cb6
RS
2806 save = Vquit_flag;
2807 Vquit_flag = Qnil;
02067692 2808 tem = access_keymap (get_keymap (Vspecial_event_map, 0, 1), c, 0, 0, 1);
017c7cb6 2809 Vquit_flag = save;
7f07d5ca
RS
2810
2811 if (!NILP (tem))
2812 {
ba8dfba8
RS
2813 int was_locked = single_kboard;
2814
7f07d5ca 2815 last_input_char = c;
158f7532 2816 Fcommand_execute (tem, Qnil, Fvector (1, &last_input_char), Qt);
ba8dfba8 2817
5d12f14d
EZ
2818 if (CONSP (c) && EQ (XCAR (c), Qselect_window))
2819 /* We stopped being idle for this event; undo that. This
2820 prevents automatic window selection (under
0b9a1d3d 2821 mouse_autoselect_window from acting as a real input event, for
5d12f14d
EZ
2822 example banishing the mouse under mouse-avoidance-mode. */
2823 timer_idleness_start_time = last_idle_start;
2824
ba8dfba8
RS
2825 /* Resume allowing input from any kboard, if that was true before. */
2826 if (!was_locked)
2827 any_kboard_state ();
2828
7f07d5ca
RS
2829 goto retry;
2830 }
2831
284f4730 2832 /* Handle things that only apply to characters. */
8c18cbfb 2833 if (INTEGERP (c))
284f4730
JB
2834 {
2835 /* If kbd_buffer_get_event gave us an EOF, return that. */
86e5706b 2836 if (XINT (c) == -1)
184c3d81 2837 goto exit;
284f4730 2838
301738ed 2839 if ((STRINGP (Vkeyboard_translate_table)
d5db4077 2840 && SCHARS (Vkeyboard_translate_table) > (unsigned) XFASTINT (c))
301738ed
RS
2841 || (VECTORP (Vkeyboard_translate_table)
2842 && XVECTOR (Vkeyboard_translate_table)->size > (unsigned) XFASTINT (c))
2843 || (CHAR_TABLE_P (Vkeyboard_translate_table)
5e3cb80d 2844 && CHAR_VALID_P (XINT (c), 0)))
f9414d62
RS
2845 {
2846 Lisp_Object d;
2847 d = Faref (Vkeyboard_translate_table, c);
2848 /* nil in keyboard-translate-table means no translation. */
2849 if (!NILP (d))
2850 c = d;
2851 }
284f4730
JB
2852 }
2853
e4fe371d
RS
2854 /* If this event is a mouse click in the menu bar,
2855 return just menu-bar for now. Modify the mouse click event
2856 so we won't do this twice, then queue it up. */
2857 if (EVENT_HAS_PARAMETERS (c)
7539e11f 2858 && CONSP (XCDR (c))
e4fe371d 2859 && CONSP (EVENT_START (c))
7539e11f 2860 && CONSP (XCDR (EVENT_START (c))))
284f4730 2861 {
e4fe371d 2862 Lisp_Object posn;
284f4730 2863
e4fe371d
RS
2864 posn = POSN_BUFFER_POSN (EVENT_START (c));
2865 /* Handle menu-bar events:
2866 insert the dummy prefix event `menu-bar'. */
9ea173e8 2867 if (EQ (posn, Qmenu_bar) || EQ (posn, Qtool_bar))
e4fe371d
RS
2868 {
2869 /* Change menu-bar to (menu-bar) as the event "position". */
f3fbd155 2870 POSN_BUFFER_SET_POSN (EVENT_START (c), Fcons (posn, Qnil));
284f4730 2871
e4fe371d
RS
2872 also_record = c;
2873 Vunread_command_events = Fcons (c, Vunread_command_events);
2874 c = posn;
284f4730 2875 }
284f4730
JB
2876 }
2877
7d18f9ae
RS
2878 /* Store these characters into recent_keys, the dribble file if any,
2879 and the keyboard macro being defined, if any. */
e4fe371d
RS
2880 record_char (c);
2881 if (! NILP (also_record))
2882 record_char (also_record);
51172b6d 2883
d5eecefb
RS
2884 /* Wipe the echo area.
2885 But first, if we are about to use an input method,
2886 save the echo area contents for it to refer to. */
2887 if (INTEGERP (c)
2888 && ! NILP (Vinput_method_function)
2889 && (unsigned) XINT (c) >= ' '
8d769115
KH
2890 && (unsigned) XINT (c) != 127
2891 && (unsigned) XINT (c) < 256)
7ee32cda
GM
2892 {
2893 previous_echo_area_message = Fcurrent_message ();
2894 Vinput_method_previous_message = previous_echo_area_message;
2895 }
d5eecefb 2896
1172eb8d
GM
2897 /* Now wipe the echo area, except for help events which do their
2898 own stuff with the echo area. */
4d2e9f95
GM
2899 if (!CONSP (c)
2900 || (!(EQ (Qhelp_echo, XCAR (c)))
2901 && !(EQ (Qswitch_frame, XCAR (c)))))
1172eb8d
GM
2902 {
2903 if (!NILP (echo_area_buffer[0]))
2904 safe_run_hooks (Qecho_area_clear_hook);
2905 clear_message (1, 0);
2906 }
d5eecefb 2907
7d18f9ae 2908 reread_for_input_method:
284f4730 2909 from_macro:
7d18f9ae 2910 /* Pass this to the input method, if appropriate. */
d5eecefb
RS
2911 if (INTEGERP (c)
2912 && ! NILP (Vinput_method_function)
b638f328
RS
2913 /* Don't run the input method within a key sequence,
2914 after the first event of the key sequence. */
2915 && NILP (prev_event)
d5eecefb 2916 && (unsigned) XINT (c) >= ' '
8d769115
KH
2917 && (unsigned) XINT (c) != 127
2918 && (unsigned) XINT (c) < 256)
d5eecefb
RS
2919 {
2920 Lisp_Object keys;
6e5742a0 2921 int key_count;
d5eecefb 2922 struct gcpro gcpro1;
aed13378 2923 int count = SPECPDL_INDEX ();
d5eecefb 2924
6e5742a0
RS
2925 /* Save the echo status. */
2926 int saved_immediate_echo = current_kboard->immediate_echo;
985f9f66 2927 struct kboard *saved_ok_to_echo = ok_to_echo_at_next_pause;
6e5742a0
RS
2928 int saved_echo_after_prompt = current_kboard->echo_after_prompt;
2929
2930 if (before_command_restore_flag)
2931 {
2932 this_command_key_count = before_command_key_count_1;
2933 if (this_command_key_count < this_single_command_key_start)
2934 this_single_command_key_start = this_command_key_count;
2935 echo_truncate (before_command_echo_length_1);
2936 before_command_restore_flag = 0;
2937 }
2938
2939 /* Save the this_command_keys status. */
2940 key_count = this_command_key_count;
2941
2942 if (key_count > 0)
2943 keys = Fcopy_sequence (this_command_keys);
2944 else
2945 keys = Qnil;
d5eecefb 2946 GCPRO1 (keys);
6e5742a0
RS
2947
2948 /* Clear out this_command_keys. */
2949 this_command_key_count = 0;
2950
2951 /* Now wipe the echo area. */
985f9f66 2952 if (!NILP (echo_area_buffer[0]))
6e5742a0 2953 safe_run_hooks (Qecho_area_clear_hook);
985f9f66 2954 clear_message (1, 0);
6e5742a0
RS
2955 echo_truncate (0);
2956
b638f328
RS
2957 /* If we are not reading a key sequence,
2958 never use the echo area. */
2959 if (maps == 0)
2960 {
b638f328
RS
2961 specbind (Qinput_method_use_echo_area, Qt);
2962 }
2963
6e5742a0 2964 /* Call the input method. */
d5eecefb 2965 tem = call1 (Vinput_method_function, c);
b638f328
RS
2966
2967 tem = unbind_to (count, tem);
2968
6e5742a0
RS
2969 /* Restore the saved echoing state
2970 and this_command_keys state. */
2971 this_command_key_count = key_count;
2972 if (key_count > 0)
2973 this_command_keys = keys;
2974
2975 cancel_echoing ();
2976 ok_to_echo_at_next_pause = saved_ok_to_echo;
2977 current_kboard->echo_after_prompt = saved_echo_after_prompt;
2978 if (saved_immediate_echo)
2979 echo_now ();
2980
d5eecefb 2981 UNGCPRO;
6e5742a0 2982
d5eecefb
RS
2983 /* The input method can return no events. */
2984 if (! CONSP (tem))
7d18f9ae 2985 {
d5eecefb 2986 /* Bring back the previous message, if any. */
7ee32cda
GM
2987 if (! NILP (previous_echo_area_message))
2988 message_with_string ("%s", previous_echo_area_message, 0);
d5eecefb 2989 goto retry;
7d18f9ae 2990 }
d5eecefb 2991 /* It returned one event or more. */
7539e11f 2992 c = XCAR (tem);
d5eecefb 2993 Vunread_post_input_method_events
7539e11f 2994 = nconc2 (XCDR (tem), Vunread_post_input_method_events);
7d18f9ae 2995 }
7c3bc944 2996
7d18f9ae 2997 reread_first:
284f4730 2998
7ee32cda 2999 /* Display help if not echoing. */
1172eb8d 3000 if (CONSP (c) && EQ (XCAR (c), Qhelp_echo))
7ee32cda 3001 {
2190735a 3002 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
d31053f9
RS
3003 Lisp_Object help, object, position, window, tem;
3004
3005 tem = Fcdr (XCDR (c));
3006 help = Fcar (tem);
3007 tem = Fcdr (tem);
3008 window = Fcar (tem);
3009 tem = Fcdr (tem);
3010 object = Fcar (tem);
3011 tem = Fcdr (tem);
3012 position = Fcar (tem);
3013
2190735a 3014 show_help_echo (help, window, object, position, 0);
fdbb67fe
GM
3015
3016 /* We stopped being idle for this event; undo that. */
3017 timer_idleness_start_time = last_idle_start;
7ee32cda
GM
3018 goto retry;
3019 }
3020
7d18f9ae 3021 if (this_command_key_count == 0 || ! reread)
e4fe371d 3022 {
7d18f9ae
RS
3023 before_command_key_count = this_command_key_count;
3024 before_command_echo_length = echo_length ();
3025
3026 /* Don't echo mouse motion events. */
f2647d04
DL
3027 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
3028 && NILP (Fzerop (Vecho_keystrokes))
7d18f9ae
RS
3029 && ! (EVENT_HAS_PARAMETERS (c)
3030 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
3031 {
3032 echo_char (c);
3033 if (! NILP (also_record))
3034 echo_char (also_record);
3035 /* Once we reread a character, echoing can happen
3036 the next time we pause to read a new one. */
985f9f66 3037 ok_to_echo_at_next_pause = current_kboard;
7d18f9ae
RS
3038 }
3039
3040 /* Record this character as part of the current key. */
3041 add_command_key (c);
e4fe371d 3042 if (! NILP (also_record))
7d18f9ae 3043 add_command_key (also_record);
e4fe371d 3044 }
b8556aee 3045
284f4730 3046 last_input_char = c;
c43b1734 3047 num_input_events++;
284f4730
JB
3048
3049 /* Process the help character specially if enabled */
ecb7cb34 3050 if (!NILP (Vhelp_form) && help_char_p (c))
284f4730
JB
3051 {
3052 Lisp_Object tem0;
aed13378 3053 count = SPECPDL_INDEX ();
284f4730
JB
3054
3055 record_unwind_protect (Fset_window_configuration,
3056 Fcurrent_window_configuration (Qnil));
3057
3058 tem0 = Feval (Vhelp_form);
8c18cbfb 3059 if (STRINGP (tem0))
284f4730
JB
3060 internal_with_output_to_temp_buffer ("*Help*", print_help, tem0);
3061
3062 cancel_echoing ();
3cb81011
KH
3063 do
3064 c = read_char (0, 0, 0, Qnil, 0);
8c18cbfb 3065 while (BUFFERP (c));
ff11dfa1 3066 /* Remove the help from the frame */
284f4730 3067 unbind_to (count, Qnil);
410d4de9 3068
284f4730
JB
3069 redisplay ();
3070 if (EQ (c, make_number (040)))
3071 {
3072 cancel_echoing ();
3cb81011
KH
3073 do
3074 c = read_char (0, 0, 0, Qnil, 0);
8c18cbfb 3075 while (BUFFERP (c));
284f4730
JB
3076 }
3077 }
3078
184c3d81
RS
3079 exit:
3080 RESUME_POLLING;
7c3bc944 3081 RETURN_UNGCPRO (c);
284f4730
JB
3082}
3083
8eb4d8ef
RS
3084/* Record a key that came from a mouse menu.
3085 Record it for echoing, for this-command-keys, and so on. */
3086
3087static void
3088record_menu_key (c)
3089 Lisp_Object c;
3090{
3091 /* Wipe the echo area. */
985f9f66 3092 clear_message (1, 0);
8eb4d8ef
RS
3093
3094 record_char (c);
3095
3096 before_command_key_count = this_command_key_count;
3097 before_command_echo_length = echo_length ();
3098
3099 /* Don't echo mouse motion events. */
f2647d04
DL
3100 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
3101 && NILP (Fzerop (Vecho_keystrokes)))
8eb4d8ef
RS
3102 {
3103 echo_char (c);
3104
3105 /* Once we reread a character, echoing can happen
3106 the next time we pause to read a new one. */
3107 ok_to_echo_at_next_pause = 0;
3108 }
3109
3110 /* Record this character as part of the current key. */
3111 add_command_key (c);
3112
3113 /* Re-reading in the middle of a command */
3114 last_input_char = c;
c43b1734 3115 num_input_events++;
8eb4d8ef
RS
3116}
3117
ecb7cb34
KH
3118/* Return 1 if should recognize C as "the help character". */
3119
3120int
3121help_char_p (c)
3122 Lisp_Object c;
3123{
3124 Lisp_Object tail;
3125
3126 if (EQ (c, Vhelp_char))
3127 return 1;
7539e11f
KR
3128 for (tail = Vhelp_event_list; CONSP (tail); tail = XCDR (tail))
3129 if (EQ (c, XCAR (tail)))
ecb7cb34
KH
3130 return 1;
3131 return 0;
3132}
3133
e4fe371d
RS
3134/* Record the input event C in various ways. */
3135
3136static void
3137record_char (c)
3138 Lisp_Object c;
3139{
090c68b9 3140 int recorded = 0;
52be17cc 3141
090c68b9
KS
3142 if (CONSP (c) && (EQ (XCAR (c), Qhelp_echo) || EQ (XCAR (c), Qmouse_movement)))
3143 {
3144 /* To avoid filling recent_keys with help-echo and mouse-movement
3145 events, we filter out repeated help-echo events, only store the
3146 first and last in a series of mouse-movement events, and don't
3147 store repeated help-echo events which are only separated by
3148 mouse-movement events. */
3149
3150 Lisp_Object ev1, ev2, ev3;
3151 int ix1, ix2, ix3;
3152
3153 if ((ix1 = recent_keys_index - 1) < 0)
3154 ix1 = NUM_RECENT_KEYS - 1;
3155 ev1 = AREF (recent_keys, ix1);
3156
3157 if ((ix2 = ix1 - 1) < 0)
3158 ix2 = NUM_RECENT_KEYS - 1;
3159 ev2 = AREF (recent_keys, ix2);
3160
3161 if ((ix3 = ix2 - 1) < 0)
3162 ix3 = NUM_RECENT_KEYS - 1;
3163 ev3 = AREF (recent_keys, ix3);
3164
3165 if (EQ (XCAR (c), Qhelp_echo))
3166 {
3167 /* Don't record `help-echo' in recent_keys unless it shows some help
a978004d 3168 message, and a different help than the previously recorded
090c68b9
KS
3169 event. */
3170 Lisp_Object help, last_help;
3171
3172 help = Fcar_safe (Fcdr_safe (XCDR (c)));
3173 if (!STRINGP (help))
3174 recorded = 1;
3175 else if (CONSP (ev1) && EQ (XCAR (ev1), Qhelp_echo)
3176 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev1))), EQ (last_help, help)))
3177 recorded = 1;
3178 else if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3179 && CONSP (ev2) && EQ (XCAR (ev2), Qhelp_echo)
3180 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev2))), EQ (last_help, help)))
3181 recorded = -1;
3182 else if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3183 && CONSP (ev2) && EQ (XCAR (ev2), Qmouse_movement)
3184 && CONSP (ev3) && EQ (XCAR (ev3), Qhelp_echo)
3185 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev3))), EQ (last_help, help)))
3186 recorded = -2;
3187 }
3188 else if (EQ (XCAR (c), Qmouse_movement))
52be17cc 3189 {
090c68b9
KS
3190 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3191 So additional mouse movement events replace the last element. */
3192 Lisp_Object last_window, window;
3193
3194 window = Fcar_safe (Fcar_safe (XCDR (c)));
3195 if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3196 && (last_window = Fcar_safe (Fcar_safe (XCDR (ev1))), EQ (last_window, window))
3197 && CONSP (ev2) && EQ (XCAR (ev2), Qmouse_movement)
3198 && (last_window = Fcar_safe (Fcar_safe (XCDR (ev2))), EQ (last_window, window)))
52be17cc 3199 {
090c68b9
KS
3200 ASET (recent_keys, ix1, c);
3201 recorded = 1;
52be17cc
GM
3202 }
3203 }
3204 }
3205 else
090c68b9
KS
3206 store_kbd_macro_char (c);
3207
3208 if (!recorded)
e8a50785
GM
3209 {
3210 total_keys++;
3211 ASET (recent_keys, recent_keys_index, c);
3212 if (++recent_keys_index >= NUM_RECENT_KEYS)
3213 recent_keys_index = 0;
3214 }
090c68b9
KS
3215 else if (recorded < 0)
3216 {
3217 /* We need to remove one or two events from recent_keys.
3218 To do this, we simply put nil at those events and move the
3219 recent_keys_index backwards over those events. Usually,
3220 users will never see those nil events, as they will be
3221 overwritten by the command keys entered to see recent_keys
3222 (e.g. C-h l). */
3223
3224 while (recorded++ < 0 && total_keys > 0)
3225 {
3226 if (total_keys < NUM_RECENT_KEYS)
3227 total_keys--;
3228 if (--recent_keys_index < 0)
3229 recent_keys_index = NUM_RECENT_KEYS - 1;
3230 ASET (recent_keys, recent_keys_index, Qnil);
3231 }
3232 }
3233
3234 num_nonmacro_input_events++;
52be17cc 3235
e4fe371d
RS
3236 /* Write c to the dribble file. If c is a lispy event, write
3237 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3238 If you, dear reader, have a better idea, you've got the source. :-) */
3239 if (dribble)
3240 {
3241 if (INTEGERP (c))
3242 {
3243 if (XUINT (c) < 0x100)
3244 putc (XINT (c), dribble);
3245 else
6de34814 3246 fprintf (dribble, " 0x%x", (int) XUINT (c));
e4fe371d
RS
3247 }
3248 else
3249 {
3250 Lisp_Object dribblee;
3251
3252 /* If it's a structured event, take the event header. */
3253 dribblee = EVENT_HEAD (c);
3254
3255 if (SYMBOLP (dribblee))
3256 {
3257 putc ('<', dribble);
d5db4077
KR
3258 fwrite (SDATA (SYMBOL_NAME (dribblee)), sizeof (char),
3259 SBYTES (SYMBOL_NAME (dribblee)),
e4fe371d
RS
3260 dribble);
3261 putc ('>', dribble);
3262 }
3263 }
3264
3265 fflush (dribble);
3266 }
e4fe371d
RS
3267}
3268
284f4730
JB
3269Lisp_Object
3270print_help (object)
3271 Lisp_Object object;
3272{
622de3e9 3273 struct buffer *old = current_buffer;
284f4730 3274 Fprinc (object, Qnil);
622de3e9
KH
3275 set_buffer_internal (XBUFFER (Vstandard_output));
3276 call0 (intern ("help-mode"));
3277 set_buffer_internal (old);
284f4730
JB
3278 return Qnil;
3279}
3280
3281/* Copy out or in the info on where C-g should throw to.
3282 This is used when running Lisp code from within get_char,
3283 in case get_char is called recursively.
3284 See read_process_output. */
3285
dfcf069d 3286static void
284f4730
JB
3287save_getcjmp (temp)
3288 jmp_buf temp;
3289{
3290 bcopy (getcjmp, temp, sizeof getcjmp);
3291}
3292
dfcf069d 3293static void
284f4730
JB
3294restore_getcjmp (temp)
3295 jmp_buf temp;
3296{
3297 bcopy (temp, getcjmp, sizeof getcjmp);
3298}
284f4730 3299\f
2eb6bfbe
RM
3300#ifdef HAVE_MOUSE
3301
284f4730
JB
3302/* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3303 of this function. */
a9d77f1f 3304
284f4730
JB
3305static Lisp_Object
3306tracking_off (old_value)
3307 Lisp_Object old_value;
3308{
71edead1
RS
3309 do_mouse_tracking = old_value;
3310 if (NILP (old_value))
284f4730 3311 {
284f4730
JB
3312 /* Redisplay may have been preempted because there was input
3313 available, and it assumes it will be called again after the
3314 input has been processed. If the only input available was
3315 the sort that we have just disabled, then we need to call
3316 redisplay. */
d9d4c147 3317 if (!readable_events (1))
284f4730 3318 {
3007ebfb 3319 redisplay_preserve_echo_area (6);
d9d4c147 3320 get_input_pending (&input_pending, 1);
284f4730
JB
3321 }
3322 }
30690496 3323 return Qnil;
284f4730
JB
3324}
3325
3326DEFUN ("track-mouse", Ftrack_mouse, Strack_mouse, 0, UNEVALLED, 0,
4707d2d0
PJ
3327 doc: /* Evaluate BODY with mouse movement events enabled.
3328Within a `track-mouse' form, mouse motion generates input events that
3329you can read with `read-event'.
3330Normally, mouse motion is ignored.
3331usage: (track-mouse BODY ...) */)
3332 (args)
284f4730
JB
3333 Lisp_Object args;
3334{
aed13378 3335 int count = SPECPDL_INDEX ();
284f4730
JB
3336 Lisp_Object val;
3337
a9d77f1f 3338 record_unwind_protect (tracking_off, do_mouse_tracking);
284f4730 3339
f3253854 3340 do_mouse_tracking = Qt;
df0f2ba1 3341
284f4730
JB
3342 val = Fprogn (args);
3343 return unbind_to (count, val);
3344}
2eb6bfbe 3345
f3253854
KH
3346/* If mouse has moved on some frame, return one of those frames.
3347 Return 0 otherwise. */
3348
3349static FRAME_PTR
3350some_mouse_moved ()
3351{
3352 Lisp_Object tail, frame;
3353
3354 FOR_EACH_FRAME (tail, frame)
3355 {
3356 if (XFRAME (frame)->mouse_moved)
3357 return XFRAME (frame);
3358 }
3359
3360 return 0;
3361}
3362
2eb6bfbe 3363#endif /* HAVE_MOUSE */
a612e298
RS
3364\f
3365/* Low level keyboard/mouse input.
3366 kbd_buffer_store_event places events in kbd_buffer, and
0646c0dd 3367 kbd_buffer_get_event retrieves them. */
a612e298
RS
3368
3369/* Return true iff there are any events in the queue that read-char
3370 would return. If this returns false, a read-char would block. */
3371static int
20057d52 3372readable_filtered_events (do_timers_now, filter_events)
d9d4c147 3373 int do_timers_now;
20057d52 3374 int filter_events;
a612e298 3375{
4ec4ed6a
RS
3376 if (do_timers_now)
3377 timer_check (do_timers_now);
3378
a0ba8995 3379 /* If the buffer contains only FOCUS_IN_EVENT events,
20057d52 3380 and FILTER_EVENTS is nonzero, report it as empty. */
beecf6a1 3381 if (kbd_fetch_ptr != kbd_store_ptr)
a0ba8995 3382 {
20057d52 3383 int have_live_event = 1;
a0ba8995 3384
20057d52
JD
3385 if (filter_events)
3386 {
3387 struct input_event *event;
3388
3389 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
3390 ? kbd_fetch_ptr
3391 : kbd_buffer);
3392
3393 while (have_live_event && event->kind == FOCUS_IN_EVENT)
3394 {
3395 event++;
3396 if (event == kbd_buffer + KBD_BUFFER_SIZE)
3397 event = kbd_buffer;
3398 if (event == kbd_store_ptr)
3399 have_live_event = 0;
3400 }
3401 }
3402 if (have_live_event) return 1;
a0ba8995
RS
3403 }
3404
beecf6a1 3405#ifdef HAVE_MOUSE
f3253854 3406 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
beecf6a1
KH
3407 return 1;
3408#endif
1e8bd3da 3409 if (single_kboard)
4c52b668 3410 {
c5fdd383 3411 if (current_kboard->kbd_queue_has_data)
4c52b668
KH
3412 return 1;
3413 }
3414 else
3415 {
c5fdd383
KH
3416 KBOARD *kb;
3417 for (kb = all_kboards; kb; kb = kb->next_kboard)
3418 if (kb->kbd_queue_has_data)
4c52b668
KH
3419 return 1;
3420 }
beecf6a1 3421 return 0;
a612e298
RS
3422}
3423
20057d52
JD
3424/* Return true iff there are any events in the queue that read-char
3425 would return. If this returns false, a read-char would block. */
3426static int
3427readable_events (do_timers_now)
3428 int do_timers_now;
3429{
3430 return readable_filtered_events (do_timers_now, 0);
3431}
3432
a612e298
RS
3433/* Set this for debugging, to have a way to get out */
3434int stop_character;
284f4730 3435
c5fdd383
KH
3436#ifdef MULTI_KBOARD
3437static KBOARD *
3438event_to_kboard (event)
5798cf15
KH
3439 struct input_event *event;
3440{
3441 Lisp_Object frame;
3442 frame = event->frame_or_window;
3443 if (CONSP (frame))
7539e11f 3444 frame = XCAR (frame);
5798cf15
KH
3445 else if (WINDOWP (frame))
3446 frame = WINDOW_FRAME (XWINDOW (frame));
3447
3448 /* There are still some events that don't set this field.
f5b56972
KH
3449 For now, just ignore the problem.
3450 Also ignore dead frames here. */
3451 if (!FRAMEP (frame) || !FRAME_LIVE_P (XFRAME (frame)))
5798cf15
KH
3452 return 0;
3453 else
c5fdd383 3454 return FRAME_KBOARD (XFRAME (frame));
5798cf15
KH
3455}
3456#endif
3457
284f4730
JB
3458/* Store an event obtained at interrupt level into kbd_buffer, fifo */
3459
3460void
3461kbd_buffer_store_event (event)
3462 register struct input_event *event;
3463{
3b8f9651 3464 if (event->kind == NO_EVENT)
284f4730
JB
3465 abort ();
3466
3b8f9651 3467 if (event->kind == ASCII_KEYSTROKE_EVENT)
284f4730 3468 {
e9bf89a0 3469 register int c = event->code & 0377;
284f4730 3470
faf5e407
JB
3471 if (event->modifiers & ctrl_modifier)
3472 c = make_ctrl_char (c);
3473
9fd7d808
RS
3474 c |= (event->modifiers
3475 & (meta_modifier | alt_modifier
3476 | hyper_modifier | super_modifier));
3477
86e5706b 3478 if (c == quit_char)
284f4730 3479 {
c5fdd383
KH
3480#ifdef MULTI_KBOARD
3481 KBOARD *kb;
5798cf15
KH
3482 struct input_event *sp;
3483
1e8bd3da 3484 if (single_kboard
c5fdd383
KH
3485 && (kb = FRAME_KBOARD (XFRAME (event->frame_or_window)),
3486 kb != current_kboard))
5798cf15 3487 {
c5fdd383 3488 kb->kbd_queue
5798cf15
KH
3489 = Fcons (make_lispy_switch_frame (event->frame_or_window),
3490 Fcons (make_number (c), Qnil));
c5fdd383 3491 kb->kbd_queue_has_data = 1;
5798cf15
KH
3492 for (sp = kbd_fetch_ptr; sp != kbd_store_ptr; sp++)
3493 {
3494 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3495 sp = kbd_buffer;
3496
c5fdd383 3497 if (event_to_kboard (sp) == kb)
5798cf15 3498 {
3b8f9651 3499 sp->kind = NO_EVENT;
5798cf15 3500 sp->frame_or_window = Qnil;
da8f7368 3501 sp->arg = Qnil;
5798cf15
KH
3502 }
3503 }
3504 return;
3505 }
3506#endif
3e51c7b7 3507
284f4730 3508 /* If this results in a quit_char being returned to Emacs as
3c370943 3509 input, set Vlast_event_frame properly. If this doesn't
284f4730 3510 get returned to Emacs as an event, the next event read
ff11dfa1 3511 will set Vlast_event_frame again, so this is safe to do. */
4bb994d1 3512 {
9b8eb840 3513 Lisp_Object focus;
4bb994d1 3514
9b8eb840 3515 focus = FRAME_FOCUS_FRAME (XFRAME (event->frame_or_window));
4bb994d1 3516 if (NILP (focus))
beecf6a1 3517 focus = event->frame_or_window;
4c52b668
KH
3518 internal_last_event_frame = focus;
3519 Vlast_event_frame = focus;
4bb994d1 3520 }
3e51c7b7 3521
ffd56f97 3522 last_event_timestamp = event->timestamp;
7189cad8 3523 interrupt_signal (0 /* dummy */);
284f4730
JB
3524 return;
3525 }
3526
3527 if (c && c == stop_character)
3528 {
3529 sys_suspend ();
3530 return;
3531 }
284f4730 3532 }
3b8f9651 3533 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3fe8e9a2 3534 Just ignore the second one. */
3b8f9651 3535 else if (event->kind == BUFFER_SWITCH_EVENT
3fe8e9a2 3536 && kbd_fetch_ptr != kbd_store_ptr
3b8f9651 3537 && kbd_store_ptr->kind == BUFFER_SWITCH_EVENT)
3fe8e9a2 3538 return;
284f4730 3539
beecf6a1
KH
3540 if (kbd_store_ptr - kbd_buffer == KBD_BUFFER_SIZE)
3541 kbd_store_ptr = kbd_buffer;
284f4730
JB
3542
3543 /* Don't let the very last slot in the buffer become full,
3544 since that would make the two pointers equal,
3545 and that is indistinguishable from an empty buffer.
3546 Discard the event if it would fill the last slot. */
beecf6a1 3547 if (kbd_fetch_ptr - 1 != kbd_store_ptr)
284f4730 3548 {
da8f7368
GM
3549 int idx;
3550
3b8f9651 3551#if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
da8f7368
GM
3552 prone to assign individual members for other events, in case
3553 the input_event structure is changed. --2000-07-13, gerd. */
7ee32cda 3554 struct input_event *sp = kbd_store_ptr;
612b78ef 3555 sp->kind = event->kind;
3b8f9651 3556 if (event->kind == SELECTION_REQUEST_EVENT)
27203ead
RS
3557 {
3558 /* We must not use the ordinary copying code for this case,
3559 since `part' is an enum and copying it might not copy enough
3560 in this case. */
612b78ef 3561 bcopy (event, (char *) sp, sizeof (*event));
27203ead
RS
3562 }
3563 else
da8f7368 3564
27203ead 3565 {
612b78ef
KH
3566 sp->code = event->code;
3567 sp->part = event->part;
3568 sp->frame_or_window = event->frame_or_window;
da8f7368 3569 sp->arg = event->arg;
612b78ef
KH
3570 sp->modifiers = event->modifiers;
3571 sp->x = event->x;
3572 sp->y = event->y;
3573 sp->timestamp = event->timestamp;
27203ead 3574 }
da8f7368
GM
3575#else
3576 *kbd_store_ptr = *event;
3577#endif
284f4730 3578
da8f7368
GM
3579 idx = 2 * (kbd_store_ptr - kbd_buffer);
3580 ASET (kbd_buffer_gcpro, idx, event->frame_or_window);
3581 ASET (kbd_buffer_gcpro, idx + 1, event->arg);
3582 ++kbd_store_ptr;
284f4730
JB
3583 }
3584}
8dfd92c9
GM
3585
3586
f139e559 3587/* Generate HELP_EVENT input_events in BUFP which has room for
0bbfdc25
GM
3588 SIZE events. If there's not enough room in BUFP, ignore this
3589 event.
8dfd92c9
GM
3590
3591 HELP is the help form.
3592
3593 FRAME is the frame on which the help is generated. OBJECT is the
5b2ec2d0
GM
3594 Lisp object where the help was found (a buffer, a string, an
3595 overlay, or nil if neither from a string nor from a buffer. POS is
3596 the position within OBJECT where the help was found.
8dfd92c9
GM
3597
3598 Value is the number of input_events generated. */
3599
3600int
0bbfdc25 3601gen_help_event (bufp, size, help, frame, window, object, pos)
8dfd92c9 3602 struct input_event *bufp;
0bbfdc25 3603 int size;
2190735a 3604 Lisp_Object help, frame, object, window;
8dfd92c9
GM
3605 int pos;
3606{
2e1a49ad 3607 if (size >= 1)
0bbfdc25
GM
3608 {
3609 bufp->kind = HELP_EVENT;
3610 bufp->frame_or_window = frame;
3611 bufp->arg = object;
2e1a49ad
SM
3612 bufp->x = WINDOWP (window) ? window : frame;
3613 bufp->y = help;
78134789 3614 bufp->code = pos;
2e1a49ad 3615 return 1;
0bbfdc25 3616 }
2e1a49ad 3617 return 0;
8dfd92c9
GM
3618}
3619
3620
3621/* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3622
3623void
3624kbd_buffer_store_help_event (frame, help)
3625 Lisp_Object frame, help;
3626{
3627 struct input_event event;
3628
3629 event.kind = HELP_EVENT;
3630 event.frame_or_window = frame;
3631 event.arg = Qnil;
2e1a49ad
SM
3632 event.x = Qnil;
3633 event.y = help;
8dfd92c9
GM
3634 event.code = 0;
3635 kbd_buffer_store_event (&event);
8dfd92c9
GM
3636}
3637
a612e298 3638\f
07de30b9 3639/* Discard any mouse events in the event buffer by setting them to
3b8f9651 3640 NO_EVENT. */
07de30b9
GV
3641void
3642discard_mouse_events ()
3643{
3644 struct input_event *sp;
3645 for (sp = kbd_fetch_ptr; sp != kbd_store_ptr; sp++)
3646 {
3647 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3648 sp = kbd_buffer;
3649
3b8f9651 3650 if (sp->kind == MOUSE_CLICK_EVENT
07de30b9 3651#ifdef WINDOWSNT
3b8f9651 3652 || sp->kind == W32_SCROLL_BAR_CLICK_EVENT
07de30b9 3653#endif
3b8f9651 3654 || sp->kind == SCROLL_BAR_CLICK_EVENT)
07de30b9 3655 {
3b8f9651 3656 sp->kind = NO_EVENT;
07de30b9
GV
3657 }
3658 }
3659}
eeabfe76 3660
0bbfdc25
GM
3661
3662/* Return non-zero if there are any real events waiting in the event
3b8f9651 3663 buffer, not counting `NO_EVENT's.
0bbfdc25 3664
3b8f9651 3665 If DISCARD is non-zero, discard NO_EVENT events at the front of
0bbfdc25
GM
3666 the input queue, possibly leaving the input queue empty if there
3667 are no real input events. */
3668
eeabfe76
EZ
3669int
3670kbd_buffer_events_waiting (discard)
3671 int discard;
3672{
3673 struct input_event *sp;
0bbfdc25
GM
3674
3675 for (sp = kbd_fetch_ptr;
3b8f9651 3676 sp != kbd_store_ptr && sp->kind == NO_EVENT;
0bbfdc25 3677 ++sp)
eeabfe76
EZ
3678 {
3679 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3680 sp = kbd_buffer;
eeabfe76 3681 }
0bbfdc25 3682
eeabfe76
EZ
3683 if (discard)
3684 kbd_fetch_ptr = sp;
0bbfdc25 3685
3b8f9651 3686 return sp != kbd_store_ptr && sp->kind != NO_EVENT;
eeabfe76 3687}
0bbfdc25 3688
07de30b9 3689\f
0bbfdc25
GM
3690/* Clear input event EVENT. */
3691
3692static INLINE void
3693clear_event (event)
3694 struct input_event *event;
3695{
3696 int idx = 2 * (event - kbd_buffer);
3697 ASET (kbd_buffer_gcpro, idx, Qnil);
3698 ASET (kbd_buffer_gcpro, idx + 1, Qnil);
3b8f9651 3699 event->kind = NO_EVENT;
0bbfdc25
GM
3700}
3701
3702
a612e298
RS
3703/* Read one event from the event buffer, waiting if necessary.
3704 The value is a Lisp object representing the event.
3705 The value is nil for an event that should be ignored,
3706 or that was handled here.
3707 We always read and discard one event. */
284f4730
JB
3708
3709static Lisp_Object
83d68044 3710kbd_buffer_get_event (kbp, used_mouse_menu)
410d4de9 3711 KBOARD **kbp;
83d68044 3712 int *used_mouse_menu;
284f4730
JB
3713{
3714 register int c;
3715 Lisp_Object obj;
3716
3717 if (noninteractive)
3718 {
3719 c = getchar ();
18cd2eeb 3720 XSETINT (obj, c);
f5b56972 3721 *kbp = current_kboard;
284f4730
JB
3722 return obj;
3723 }
3724
3725 /* Wait until there is input available. */
3726 for (;;)
3727 {
beecf6a1
KH
3728 if (kbd_fetch_ptr != kbd_store_ptr)
3729 break;
3730#ifdef HAVE_MOUSE
f3253854 3731 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
284f4730 3732 break;
beecf6a1 3733#endif
284f4730
JB
3734
3735 /* If the quit flag is set, then read_char will return
3736 quit_char, so that counts as "available input." */
3737 if (!NILP (Vquit_flag))
3738 quit_throw_to_read_char ();
3739
3740 /* One way or another, wait until input is available; then, if
3741 interrupt handlers have not read it, read it now. */
3742
3743#ifdef OLDVMS
3744 wait_for_kbd_input ();
3745#else
3746/* Note SIGIO has been undef'd if FIONREAD is missing. */
3747#ifdef SIGIO
3748 gobble_input (0);
3749#endif /* SIGIO */
beecf6a1
KH
3750 if (kbd_fetch_ptr != kbd_store_ptr)
3751 break;
3752#ifdef HAVE_MOUSE
f3253854 3753 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
beecf6a1
KH
3754 break;
3755#endif
3756 {
3757 Lisp_Object minus_one;
f76475ad 3758
beecf6a1 3759 XSETINT (minus_one, -1);
d9d4c147 3760 wait_reading_process_input (0, 0, minus_one, 1);
284f4730 3761
beecf6a1
KH
3762 if (!interrupt_input && kbd_fetch_ptr == kbd_store_ptr)
3763 /* Pass 1 for EXPECT since we just waited to have input. */
3764 read_avail_input (1);
3765 }
284f4730
JB
3766#endif /* not VMS */
3767 }
3768
303b5b3f
RS
3769 if (CONSP (Vunread_command_events))
3770 {
3771 Lisp_Object first;
7539e11f
KR
3772 first = XCAR (Vunread_command_events);
3773 Vunread_command_events = XCDR (Vunread_command_events);
303b5b3f
RS
3774 *kbp = current_kboard;
3775 return first;
3776 }
3777
284f4730
JB
3778 /* At this point, we know that there is a readable event available
3779 somewhere. If the event queue is empty, then there must be a
3780 mouse movement enabled and available. */
beecf6a1 3781 if (kbd_fetch_ptr != kbd_store_ptr)
284f4730 3782 {
cd21b839 3783 struct input_event *event;
3e51c7b7 3784
beecf6a1
KH
3785 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
3786 ? kbd_fetch_ptr
3787 : kbd_buffer);
3e51c7b7 3788
cd21b839 3789 last_event_timestamp = event->timestamp;
cd21b839 3790
c5fdd383
KH
3791#ifdef MULTI_KBOARD
3792 *kbp = event_to_kboard (event);
3793 if (*kbp == 0)
3794 *kbp = current_kboard; /* Better than returning null ptr? */
5798cf15 3795#else
c5fdd383 3796 *kbp = &the_only_kboard;
5798cf15 3797#endif
beecf6a1 3798
4bb994d1
JB
3799 obj = Qnil;
3800
48e416d4 3801 /* These two kinds of events get special handling
a612e298
RS
3802 and don't actually appear to the command loop.
3803 We return nil for them. */
3b8f9651 3804 if (event->kind == SELECTION_REQUEST_EVENT)
48e416d4 3805 {
598a9fa7 3806#ifdef HAVE_X11
1e8bd3da
RS
3807 struct input_event copy;
3808
4581e928
RS
3809 /* Remove it from the buffer before processing it,
3810 since otherwise swallow_events will see it
3811 and process it again. */
1e8bd3da 3812 copy = *event;
beecf6a1 3813 kbd_fetch_ptr = event + 1;
d9d4c147 3814 input_pending = readable_events (0);
4581e928 3815 x_handle_selection_request (&copy);
598a9fa7
JB
3816#else
3817 /* We're getting selection request events, but we don't have
3818 a window system. */
3819 abort ();
3820#endif
48e416d4
RS
3821 }
3822
3b8f9651 3823 else if (event->kind == SELECTION_CLEAR_EVENT)
48e416d4 3824 {
598a9fa7 3825#ifdef HAVE_X11
e0301c07
RS
3826 struct input_event copy;
3827
3828 /* Remove it from the buffer before processing it. */
3829 copy = *event;
beecf6a1 3830 kbd_fetch_ptr = event + 1;
d9d4c147 3831 input_pending = readable_events (0);
90c2bb0c 3832 x_handle_selection_clear (&copy);
598a9fa7
JB
3833#else
3834 /* We're getting selection request events, but we don't have
3835 a window system. */
3836 abort ();
3837#endif
48e416d4 3838 }
e0f712ba 3839#if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3b8f9651 3840 else if (event->kind == DELETE_WINDOW_EVENT)
990acea3 3841 {
bbdc2092
RS
3842 /* Make an event (delete-frame (FRAME)). */
3843 obj = Fcons (event->frame_or_window, Qnil);
af17bd2b 3844 obj = Fcons (Qdelete_frame, Fcons (obj, Qnil));
beecf6a1 3845 kbd_fetch_ptr = event + 1;
af17bd2b 3846 }
1a578e9b
AC
3847#endif
3848#if defined (HAVE_X11) || defined (HAVE_NTGUI)
3b8f9651 3849 else if (event->kind == ICONIFY_EVENT)
af17bd2b
KH
3850 {
3851 /* Make an event (iconify-frame (FRAME)). */
3852 obj = Fcons (event->frame_or_window, Qnil);
3853 obj = Fcons (Qiconify_frame, Fcons (obj, Qnil));
beecf6a1 3854 kbd_fetch_ptr = event + 1;
af17bd2b 3855 }
3b8f9651 3856 else if (event->kind == DEICONIFY_EVENT)
af17bd2b
KH
3857 {
3858 /* Make an event (make-frame-visible (FRAME)). */
3859 obj = Fcons (event->frame_or_window, Qnil);
3860 obj = Fcons (Qmake_frame_visible, Fcons (obj, Qnil));
beecf6a1 3861 kbd_fetch_ptr = event + 1;
990acea3
RS
3862 }
3863#endif
3b8f9651 3864 else if (event->kind == BUFFER_SWITCH_EVENT)
a8015ab5
KH
3865 {
3866 /* The value doesn't matter here; only the type is tested. */
18cd2eeb 3867 XSETBUFFER (obj, current_buffer);
beecf6a1 3868 kbd_fetch_ptr = event + 1;
a8015ab5 3869 }
e0f712ba 3870#if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS)
3b8f9651 3871 else if (event->kind == MENU_BAR_ACTIVATE_EVENT)
099787c1
RS
3872 {
3873 kbd_fetch_ptr = event + 1;
d9d4c147 3874 input_pending = readable_events (0);
e649d076
RS
3875 if (FRAME_LIVE_P (XFRAME (event->frame_or_window)))
3876 x_activate_menubar (XFRAME (event->frame_or_window));
099787c1 3877 }
1161d367
GV
3878#endif
3879#ifdef WINDOWSNT
3b8f9651 3880 else if (event->kind == LANGUAGE_CHANGE_EVENT)
1161d367
GV
3881 {
3882 /* Make an event (language-change (FRAME CHARSET LCID)). */
3883 obj = Fcons (event->modifiers, Qnil);
15fdc2e3 3884 obj = Fcons (event->code, obj);
1161d367
GV
3885 obj = Fcons (event->frame_or_window, obj);
3886 obj = Fcons (Qlanguage_change, Fcons (obj, Qnil));
3887 kbd_fetch_ptr = event + 1;
3888 }
099787c1 3889#endif
3b8f9651 3890 else if (event->kind == SAVE_SESSION_EVENT)
4ebc27a5
JD
3891 {
3892 obj = Fcons (Qsave_session, Qnil);
3893 kbd_fetch_ptr = event + 1;
3894 }
a612e298 3895 /* Just discard these, by returning nil.
c5fdd383 3896 With MULTI_KBOARD, these events are used as placeholders
5798cf15
KH
3897 when we need to randomly delete events from the queue.
3898 (They shouldn't otherwise be found in the buffer,
3899 but on some machines it appears they do show up
c5fdd383 3900 even without MULTI_KBOARD.) */
3b8f9651 3901 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
07de30b9 3902 mouse events during a popup-menu call. */
3b8f9651 3903 else if (event->kind == NO_EVENT)
beecf6a1 3904 kbd_fetch_ptr = event + 1;
7ee32cda
GM
3905 else if (event->kind == HELP_EVENT)
3906 {
2190735a 3907 Lisp_Object object, position, help, frame, window;
e4457b09 3908
8dfd92c9
GM
3909 frame = event->frame_or_window;
3910 object = event->arg;
2e1a49ad
SM
3911 position = make_number (event->code);
3912 window = event->x;
3913 help = event->y;
0bbfdc25 3914 clear_event (event);
e4457b09
GM
3915
3916 kbd_fetch_ptr = event + 1;
2190735a
GM
3917 if (!WINDOWP (window))
3918 window = Qnil;
3919 obj = Fcons (Qhelp_echo,
3920 list5 (frame, help, window, object, position));
7ee32cda 3921 }
c51c7093
GM
3922 else if (event->kind == FOCUS_IN_EVENT)
3923 {
3924 /* Notification of a FocusIn event. The frame receiving the
3925 focus is in event->frame_or_window. Generate a
3926 switch-frame event if necessary. */
3927 Lisp_Object frame, focus;
3928
3929 frame = event->frame_or_window;
3930 focus = FRAME_FOCUS_FRAME (XFRAME (frame));
3931 if (FRAMEP (focus))
3932 frame = focus;
3933
3934 if (!EQ (frame, internal_last_event_frame)
3935 && !EQ (frame, selected_frame))
3936 obj = make_lispy_switch_frame (frame);
3937 internal_last_event_frame = frame;
a697f886
PJ
3938 kbd_fetch_ptr = event + 1;
3939 }
3940 else if (event->kind == SELECT_WINDOW_EVENT)
3941 {
3942 /* Make an event (select-window (WINDOW)). */
3943 obj = Fcons (event->frame_or_window, Qnil);
3944 obj = Fcons (Qselect_window, Fcons (obj, Qnil));
3945
c51c7093
GM
3946 kbd_fetch_ptr = event + 1;
3947 }
1e12dd87
RS
3948 else
3949 {
c51c7093
GM
3950 /* If this event is on a different frame, return a switch-frame this
3951 time, and leave the event in the queue for next time. */
9b8eb840 3952 Lisp_Object frame;
1e12dd87 3953 Lisp_Object focus;
7b4aedb9 3954
9b8eb840 3955 frame = event->frame_or_window;
2470a66f 3956 if (CONSP (frame))
7539e11f 3957 frame = XCAR (frame);
2470a66f 3958 else if (WINDOWP (frame))
1e12dd87 3959 frame = WINDOW_FRAME (XWINDOW (frame));
4bb994d1 3960
1e12dd87
RS
3961 focus = FRAME_FOCUS_FRAME (XFRAME (frame));
3962 if (! NILP (focus))
3963 frame = focus;
07d2b8de 3964
4c52b668 3965 if (! EQ (frame, internal_last_event_frame)
788f89eb 3966 && !EQ (frame, selected_frame))
1e12dd87 3967 obj = make_lispy_switch_frame (frame);
4c52b668 3968 internal_last_event_frame = frame;
4bb994d1 3969
1e12dd87
RS
3970 /* If we didn't decide to make a switch-frame event, go ahead
3971 and build a real event from the queue entry. */
cd21b839 3972
1e12dd87
RS
3973 if (NILP (obj))
3974 {
3975 obj = make_lispy_event (event);
da8f7368 3976
742fbed7 3977#if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS)
83d68044
KH
3978 /* If this was a menu selection, then set the flag to inhibit
3979 writing to last_nonmenu_event. Don't do this if the event
3980 we're returning is (menu-bar), though; that indicates the
3981 beginning of the menu sequence, and we might as well leave
3982 that as the `event with parameters' for this selection. */
da8f7368
GM
3983 if (used_mouse_menu
3984 && !EQ (event->frame_or_window, event->arg)
3985 && (event->kind == MENU_BAR_EVENT
3986 || event->kind == TOOL_BAR_EVENT))
83d68044
KH
3987 *used_mouse_menu = 1;
3988#endif
1e12dd87
RS
3989
3990 /* Wipe out this event, to catch bugs. */
0bbfdc25 3991 clear_event (event);
beecf6a1 3992 kbd_fetch_ptr = event + 1;
1e12dd87 3993 }
4bb994d1 3994 }
284f4730 3995 }
2eb6bfbe 3996#ifdef HAVE_MOUSE
a612e298 3997 /* Try generating a mouse motion event. */
f3253854 3998 else if (!NILP (do_mouse_tracking) && some_mouse_moved ())
284f4730 3999 {
f3253854 4000 FRAME_PTR f = some_mouse_moved ();
7b4aedb9 4001 Lisp_Object bar_window;
3c370943 4002 enum scroll_bar_part part;
e5d77022
JB
4003 Lisp_Object x, y;
4004 unsigned long time;
284f4730 4005
c5fdd383 4006 *kbp = current_kboard;
e177ac3a
RS
4007 /* Note that this uses F to determine which display to look at.
4008 If there is no valid info, it does not store anything
4009 so x remains nil. */
4010 x = Qnil;
dd26ab75 4011 (*mouse_position_hook) (&f, 0, &bar_window, &part, &x, &y, &time);
4bb994d1
JB
4012
4013 obj = Qnil;
284f4730 4014
4bb994d1
JB
4015 /* Decide if we should generate a switch-frame event. Don't
4016 generate switch-frame events for motion outside of all Emacs
4017 frames. */
e177ac3a 4018 if (!NILP (x) && f)
cd21b839 4019 {
9b8eb840 4020 Lisp_Object frame;
4bb994d1 4021
9b8eb840 4022 frame = FRAME_FOCUS_FRAME (f);
4bb994d1 4023 if (NILP (frame))
18cd2eeb 4024 XSETFRAME (frame, f);
4bb994d1 4025
4c52b668 4026 if (! EQ (frame, internal_last_event_frame)
788f89eb 4027 && !EQ (frame, selected_frame))
764cb3f9 4028 obj = make_lispy_switch_frame (frame);
4c52b668 4029 internal_last_event_frame = frame;
cd21b839 4030 }
4bb994d1 4031
df0f2ba1 4032 /* If we didn't decide to make a switch-frame event, go ahead and
4bb994d1 4033 return a mouse-motion event. */
e177ac3a 4034 if (!NILP (x) && NILP (obj))
7b4aedb9 4035 obj = make_lispy_movement (f, bar_window, part, x, y, time);
6cbff1cb 4036 }
2eb6bfbe 4037#endif /* HAVE_MOUSE */
284f4730
JB
4038 else
4039 /* We were promised by the above while loop that there was
4040 something for us to read! */
4041 abort ();
4042
d9d4c147 4043 input_pending = readable_events (0);
284f4730 4044
4c52b668 4045 Vlast_event_frame = internal_last_event_frame;
3c370943 4046
284f4730
JB
4047 return (obj);
4048}
a612e298
RS
4049\f
4050/* Process any events that are not user-visible,
4051 then return, without reading any user-visible events. */
3a3b9632
RS
4052
4053void
d9d4c147
KH
4054swallow_events (do_display)
4055 int do_display;
3a3b9632 4056{
87dd9b9b
RS
4057 int old_timers_run;
4058
beecf6a1 4059 while (kbd_fetch_ptr != kbd_store_ptr)
3a3b9632
RS
4060 {
4061 struct input_event *event;
4062
beecf6a1
KH
4063 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
4064 ? kbd_fetch_ptr
4065 : kbd_buffer);
3a3b9632
RS
4066
4067 last_event_timestamp = event->timestamp;
4068
4069 /* These two kinds of events get special handling
4070 and don't actually appear to the command loop. */
3b8f9651 4071 if (event->kind == SELECTION_REQUEST_EVENT)
3a3b9632
RS
4072 {
4073#ifdef HAVE_X11
4581e928 4074 struct input_event copy;
e0301c07
RS
4075
4076 /* Remove it from the buffer before processing it,
4077 since otherwise swallow_events called recursively could see it
4078 and process it again. */
4581e928 4079 copy = *event;
beecf6a1 4080 kbd_fetch_ptr = event + 1;
d9d4c147 4081 input_pending = readable_events (0);
4581e928 4082 x_handle_selection_request (&copy);
3a3b9632
RS
4083#else
4084 /* We're getting selection request events, but we don't have
4085 a window system. */
4086 abort ();
4087#endif
4088 }
4089
3b8f9651 4090 else if (event->kind == SELECTION_CLEAR_EVENT)
3a3b9632
RS
4091 {
4092#ifdef HAVE_X11
e0301c07
RS
4093 struct input_event copy;
4094
4095 /* Remove it from the buffer before processing it, */
4096 copy = *event;
4097
beecf6a1 4098 kbd_fetch_ptr = event + 1;
d9d4c147 4099 input_pending = readable_events (0);
90c2bb0c 4100 x_handle_selection_clear (&copy);
3a3b9632
RS
4101#else
4102 /* We're getting selection request events, but we don't have
4103 a window system. */
4104 abort ();
4105#endif
4106 }
4107 else
4108 break;
4109 }
4110
87dd9b9b 4111 old_timers_run = timers_run;
d9d4c147 4112 get_input_pending (&input_pending, 1);
87dd9b9b
RS
4113
4114 if (timers_run != old_timers_run && do_display)
3007ebfb 4115 redisplay_preserve_echo_area (7);
3a3b9632 4116}
a612e298 4117\f
d9d4c147
KH
4118/* Record the start of when Emacs is idle,
4119 for the sake of running idle-time timers. */
4120
07a59269 4121void
d9d4c147
KH
4122timer_start_idle ()
4123{
4124 Lisp_Object timers;
4125
4126 /* If we are already in the idle state, do nothing. */
4127 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4128 return;
4129
4130 EMACS_GET_TIME (timer_idleness_start_time);
4131
3021d3a9
RS
4132 timer_last_idleness_start_time = timer_idleness_start_time;
4133
d9d4c147 4134 /* Mark all idle-time timers as once again candidates for running. */
7539e11f 4135 for (timers = Vtimer_idle_list; CONSP (timers); timers = XCDR (timers))
d9d4c147
KH
4136 {
4137 Lisp_Object timer;
4138
7539e11f 4139 timer = XCAR (timers);
d9d4c147
KH
4140
4141 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
4142 continue;
4143 XVECTOR (timer)->contents[0] = Qnil;
4144 }
4145}
4146
4147/* Record that Emacs is no longer idle, so stop running idle-time timers. */
4148
07a59269 4149void
d9d4c147
KH
4150timer_stop_idle ()
4151{
4152 EMACS_SET_SECS_USECS (timer_idleness_start_time, -1, -1);
4153}
4154
e044e87c
RS
4155/* This is only for debugging. */
4156struct input_event last_timer_event;
4157
c04cbc3b
RS
4158/* Check whether a timer has fired. To prevent larger problems we simply
4159 disregard elements that are not proper timers. Do not make a circular
4160 timer list for the time being.
4161
4162 Returns the number of seconds to wait until the next timer fires. If a
4163 timer is triggering now, return zero seconds.
4164 If no timer is active, return -1 seconds.
4165
4ec4ed6a
RS
4166 If a timer is ripe, we run it, with quitting turned off.
4167
4168 DO_IT_NOW is now ignored. It used to mean that we should
4169 run the timer directly instead of queueing a timer-event.
4170 Now we always run timers directly. */
c04cbc3b
RS
4171
4172EMACS_TIME
4173timer_check (do_it_now)
4174 int do_it_now;
4175{
4176 EMACS_TIME nexttime;
9291c072
RS
4177 EMACS_TIME now, idleness_now;
4178 Lisp_Object timers, idle_timers, chosen_timer;
9291c072 4179 struct gcpro gcpro1, gcpro2, gcpro3;
c04cbc3b 4180
c04cbc3b
RS
4181 EMACS_SET_SECS (nexttime, -1);
4182 EMACS_SET_USECS (nexttime, -1);
4183
9291c072 4184 /* Always consider the ordinary timers. */
7ea13e12 4185 timers = Vtimer_list;
9291c072
RS
4186 /* Consider the idle timers only if Emacs is idle. */
4187 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4188 idle_timers = Vtimer_idle_list;
4189 else
4190 idle_timers = Qnil;
4191 chosen_timer = Qnil;
4192 GCPRO3 (timers, idle_timers, chosen_timer);
7ea13e12 4193
9291c072 4194 if (CONSP (timers) || CONSP (idle_timers))
c04cbc3b 4195 {
9291c072
RS
4196 EMACS_GET_TIME (now);
4197 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4198 EMACS_SUB_TIME (idleness_now, now, timer_idleness_start_time);
4199 }
c04cbc3b 4200
9291c072
RS
4201 while (CONSP (timers) || CONSP (idle_timers))
4202 {
9291c072 4203 Lisp_Object *vector;
8c907a56 4204 Lisp_Object timer = Qnil, idle_timer = Qnil;
9291c072
RS
4205 EMACS_TIME timer_time, idle_timer_time;
4206 EMACS_TIME difference, timer_difference, idle_timer_difference;
4207
4208 /* Skip past invalid timers and timers already handled. */
4209 if (!NILP (timers))
c04cbc3b 4210 {
7539e11f 4211 timer = XCAR (timers);
9291c072
RS
4212 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
4213 {
7539e11f 4214 timers = XCDR (timers);
9291c072
RS
4215 continue;
4216 }
4217 vector = XVECTOR (timer)->contents;
d9d4c147 4218
9291c072
RS
4219 if (!INTEGERP (vector[1]) || !INTEGERP (vector[2])
4220 || !INTEGERP (vector[3])
4221 || ! NILP (vector[0]))
4222 {
7539e11f 4223 timers = XCDR (timers);
9291c072
RS
4224 continue;
4225 }
4226 }
4227 if (!NILP (idle_timers))
4228 {
7539e11f 4229 timer = XCAR (idle_timers);
d9d4c147 4230 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
9291c072 4231 {
7539e11f 4232 idle_timers = XCDR (idle_timers);
9291c072
RS
4233 continue;
4234 }
d9d4c147
KH
4235 vector = XVECTOR (timer)->contents;
4236
4237 if (!INTEGERP (vector[1]) || !INTEGERP (vector[2])
9291c072
RS
4238 || !INTEGERP (vector[3])
4239 || ! NILP (vector[0]))
4240 {
7539e11f 4241 idle_timers = XCDR (idle_timers);
9291c072
RS
4242 continue;
4243 }
4244 }
d9d4c147 4245
9291c072
RS
4246 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4247 based on the next ordinary timer.
4248 TIMER_DIFFERENCE is the distance in time from NOW to when
4249 this timer becomes ripe (negative if it's already ripe). */
4250 if (!NILP (timers))
4251 {
7539e11f 4252 timer = XCAR (timers);
9291c072 4253 vector = XVECTOR (timer)->contents;
d9d4c147
KH
4254 EMACS_SET_SECS (timer_time,
4255 (XINT (vector[1]) << 16) | (XINT (vector[2])));
4256 EMACS_SET_USECS (timer_time, XINT (vector[3]));
9291c072
RS
4257 EMACS_SUB_TIME (timer_difference, timer_time, now);
4258 }
ba8dfba8 4259
9291c072
RS
4260 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4261 based on the next idle timer. */
4262 if (!NILP (idle_timers))
4263 {
7539e11f 4264 idle_timer = XCAR (idle_timers);
9291c072
RS
4265 vector = XVECTOR (idle_timer)->contents;
4266 EMACS_SET_SECS (idle_timer_time,
4267 (XINT (vector[1]) << 16) | (XINT (vector[2])));
4268 EMACS_SET_USECS (idle_timer_time, XINT (vector[3]));
4269 EMACS_SUB_TIME (idle_timer_difference, idle_timer_time, idleness_now);
4270 }
ba8dfba8 4271
9291c072
RS
4272 /* Decide which timer is the next timer,
4273 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4274 Also step down the list where we found that timer. */
d9d4c147 4275
9291c072
RS
4276 if (! NILP (timers) && ! NILP (idle_timers))
4277 {
4278 EMACS_TIME temp;
4279 EMACS_SUB_TIME (temp, timer_difference, idle_timer_difference);
4280 if (EMACS_TIME_NEG_P (temp))
4281 {
4282 chosen_timer = timer;
7539e11f 4283 timers = XCDR (timers);
9291c072 4284 difference = timer_difference;
c04cbc3b 4285 }
d9d4c147 4286 else
d9d4c147 4287 {
9291c072 4288 chosen_timer = idle_timer;
7539e11f 4289 idle_timers = XCDR (idle_timers);
9291c072 4290 difference = idle_timer_difference;
d9d4c147 4291 }
7ea13e12 4292 }
9291c072
RS
4293 else if (! NILP (timers))
4294 {
4295 chosen_timer = timer;
7539e11f 4296 timers = XCDR (timers);
9291c072
RS
4297 difference = timer_difference;
4298 }
4299 else
4300 {
4301 chosen_timer = idle_timer;
7539e11f 4302 idle_timers = XCDR (idle_timers);
9291c072
RS
4303 difference = idle_timer_difference;
4304 }
4305 vector = XVECTOR (chosen_timer)->contents;
4306
bd55b860 4307 /* If timer is ripe, run it if it hasn't been run. */
9291c072
RS
4308 if (EMACS_TIME_NEG_P (difference)
4309 || (EMACS_SECS (difference) == 0
4310 && EMACS_USECS (difference) == 0))
4311 {
4312 if (NILP (vector[0]))
4313 {
d925fb39 4314 int was_locked = single_kboard;
331379bf 4315 int count = SPECPDL_INDEX ();
d0bbfc99 4316 Lisp_Object old_deactivate_mark = Vdeactivate_mark;
d925fb39 4317
9291c072
RS
4318 /* Mark the timer as triggered to prevent problems if the lisp
4319 code fails to reschedule it right. */
4320 vector[0] = Qt;
4321
d925fb39 4322 specbind (Qinhibit_quit, Qt);
d0bbfc99 4323
d925fb39 4324 call1 (Qtimer_event_handler, chosen_timer);
d0bbfc99 4325 Vdeactivate_mark = old_deactivate_mark;
d925fb39 4326 timers_run++;
d925fb39 4327 unbind_to (count, Qnil);
4ec4ed6a 4328
d925fb39
RS
4329 /* Resume allowing input from any kboard, if that was true before. */
4330 if (!was_locked)
4331 any_kboard_state ();
9291c072 4332
d925fb39
RS
4333 /* Since we have handled the event,
4334 we don't need to tell the caller to wake up and do it. */
9291c072
RS
4335 }
4336 }
4337 else
4338 /* When we encounter a timer that is still waiting,
4339 return the amount of time to wait before it is ripe. */
4340 {
4341 UNGCPRO;
9291c072
RS
4342 return difference;
4343 }
c04cbc3b 4344 }
9291c072 4345
7ea13e12
RS
4346 /* No timers are pending in the future. */
4347 /* Return 0 if we generated an event, and -1 if not. */
4348 UNGCPRO;
c04cbc3b
RS
4349 return nexttime;
4350}
4351\f
284f4730 4352/* Caches for modify_event_symbol. */
e9bf89a0 4353static Lisp_Object accent_key_syms;
284f4730
JB
4354static Lisp_Object func_key_syms;
4355static Lisp_Object mouse_syms;
742fbed7 4356#if defined(WINDOWSNT) || defined(MAC_OSX)
07de30b9
GV
4357static Lisp_Object mouse_wheel_syms;
4358#endif
a24dc617 4359static Lisp_Object drag_n_drop_syms;
284f4730 4360
e9bf89a0
RS
4361/* This is a list of keysym codes for special "accent" characters.
4362 It parallels lispy_accent_keys. */
4363
4364static int lispy_accent_codes[] =
4365{
79a7046c 4366#ifdef XK_dead_circumflex
e9bf89a0 4367 XK_dead_circumflex,
79a7046c
RS
4368#else
4369 0,
4370#endif
4371#ifdef XK_dead_grave
e9bf89a0 4372 XK_dead_grave,
79a7046c
RS
4373#else
4374 0,
4375#endif
4376#ifdef XK_dead_tilde
e9bf89a0 4377 XK_dead_tilde,
79a7046c
RS
4378#else
4379 0,
4380#endif
4381#ifdef XK_dead_diaeresis
e9bf89a0 4382 XK_dead_diaeresis,
79a7046c
RS
4383#else
4384 0,
4385#endif
4386#ifdef XK_dead_macron
e9bf89a0 4387 XK_dead_macron,
79a7046c
RS
4388#else
4389 0,
4390#endif
4391#ifdef XK_dead_degree
e9bf89a0 4392 XK_dead_degree,
79a7046c
RS
4393#else
4394 0,
4395#endif
4396#ifdef XK_dead_acute
e9bf89a0 4397 XK_dead_acute,
79a7046c
RS
4398#else
4399 0,
4400#endif
4401#ifdef XK_dead_cedilla
e9bf89a0 4402 XK_dead_cedilla,
79a7046c
RS
4403#else
4404 0,
4405#endif
4406#ifdef XK_dead_breve
e9bf89a0 4407 XK_dead_breve,
79a7046c
RS
4408#else
4409 0,
4410#endif
4411#ifdef XK_dead_ogonek
e9bf89a0 4412 XK_dead_ogonek,
79a7046c
RS
4413#else
4414 0,
4415#endif
4416#ifdef XK_dead_caron
e9bf89a0 4417 XK_dead_caron,
79a7046c
RS
4418#else
4419 0,
4420#endif
4421#ifdef XK_dead_doubleacute
e9bf89a0 4422 XK_dead_doubleacute,
79a7046c
RS
4423#else
4424 0,
4425#endif
4426#ifdef XK_dead_abovedot
e9bf89a0 4427 XK_dead_abovedot,
79a7046c
RS
4428#else
4429 0,
4430#endif
ed3230db
DL
4431#ifdef XK_dead_abovering
4432 XK_dead_abovering,
4433#else
4434 0,
4435#endif
4436#ifdef XK_dead_iota
4437 XK_dead_iota,
4438#else
4439 0,
4440#endif
4441#ifdef XK_dead_belowdot
4442 XK_dead_belowdot,
4443#else
4444 0,
4445#endif
4446#ifdef XK_dead_voiced_sound
4447 XK_dead_voiced_sound,
4448#else
4449 0,
4450#endif
4451#ifdef XK_dead_semivoiced_sound
4452 XK_dead_semivoiced_sound,
4453#else
4454 0,
4455#endif
4456#ifdef XK_dead_hook
4457 XK_dead_hook,
4458#else
4459 0,
4460#endif
4461#ifdef XK_dead_horn
4462 XK_dead_horn,
4463#else
4464 0,
4465#endif
e9bf89a0
RS
4466};
4467
4468/* This is a list of Lisp names for special "accent" characters.
4469 It parallels lispy_accent_codes. */
4470
4471static char *lispy_accent_keys[] =
4472{
4473 "dead-circumflex",
4474 "dead-grave",
4475 "dead-tilde",
4476 "dead-diaeresis",
4477 "dead-macron",
4478 "dead-degree",
4479 "dead-acute",
4480 "dead-cedilla",
4481 "dead-breve",
4482 "dead-ogonek",
4483 "dead-caron",
4484 "dead-doubleacute",
4485 "dead-abovedot",
ed3230db
DL
4486 "dead-abovering",
4487 "dead-iota",
4488 "dead-belowdot",
4489 "dead-voiced-sound",
4490 "dead-semivoiced-sound",
4491 "dead-hook",
4492 "dead-horn",
e9bf89a0
RS
4493};
4494
e98a93eb
GV
4495#ifdef HAVE_NTGUI
4496#define FUNCTION_KEY_OFFSET 0x0
4497
4498char *lispy_function_keys[] =
4499 {
4500 0, /* 0 */
4501
4502 0, /* VK_LBUTTON 0x01 */
4503 0, /* VK_RBUTTON 0x02 */
4504 "cancel", /* VK_CANCEL 0x03 */
4505 0, /* VK_MBUTTON 0x04 */
4506
4507 0, 0, 0, /* 0x05 .. 0x07 */
4508
4509 "backspace", /* VK_BACK 0x08 */
4510 "tab", /* VK_TAB 0x09 */
4511
4512 0, 0, /* 0x0A .. 0x0B */
4513
4514 "clear", /* VK_CLEAR 0x0C */
4515 "return", /* VK_RETURN 0x0D */
4516
4517 0, 0, /* 0x0E .. 0x0F */
4518
1161d367
GV
4519 0, /* VK_SHIFT 0x10 */
4520 0, /* VK_CONTROL 0x11 */
4521 0, /* VK_MENU 0x12 */
e98a93eb 4522 "pause", /* VK_PAUSE 0x13 */
1161d367 4523 "capslock", /* VK_CAPITAL 0x14 */
e98a93eb
GV
4524
4525 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4526
1161d367 4527 "escape", /* VK_ESCAPE 0x1B */
e98a93eb
GV
4528
4529 0, 0, 0, 0, /* 0x1C .. 0x1F */
4530
4531 0, /* VK_SPACE 0x20 */
4532 "prior", /* VK_PRIOR 0x21 */
4533 "next", /* VK_NEXT 0x22 */
4534 "end", /* VK_END 0x23 */
4535 "home", /* VK_HOME 0x24 */
4536 "left", /* VK_LEFT 0x25 */
4537 "up", /* VK_UP 0x26 */
4538 "right", /* VK_RIGHT 0x27 */
4539 "down", /* VK_DOWN 0x28 */
4540 "select", /* VK_SELECT 0x29 */
4541 "print", /* VK_PRINT 0x2A */
4542 "execute", /* VK_EXECUTE 0x2B */
4543 "snapshot", /* VK_SNAPSHOT 0x2C */
4544 "insert", /* VK_INSERT 0x2D */
4545 "delete", /* VK_DELETE 0x2E */
4546 "help", /* VK_HELP 0x2F */
4547
4548 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4549
4550 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4551
4552 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4553
4554 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4555
4556 0, 0, 0, 0, 0, 0, 0, 0, 0,
4557 0, 0, 0, 0, 0, 0, 0, 0, 0,
4558 0, 0, 0, 0, 0, 0, 0, 0,
4559
e376f90d
RS
4560 "lwindow", /* VK_LWIN 0x5B */
4561 "rwindow", /* VK_RWIN 0x5C */
4562 "apps", /* VK_APPS 0x5D */
e98a93eb
GV
4563
4564 0, 0, /* 0x5E .. 0x5F */
4565
4566 "kp-0", /* VK_NUMPAD0 0x60 */
4567 "kp-1", /* VK_NUMPAD1 0x61 */
4568 "kp-2", /* VK_NUMPAD2 0x62 */
4569 "kp-3", /* VK_NUMPAD3 0x63 */
4570 "kp-4", /* VK_NUMPAD4 0x64 */
4571 "kp-5", /* VK_NUMPAD5 0x65 */
4572 "kp-6", /* VK_NUMPAD6 0x66 */
4573 "kp-7", /* VK_NUMPAD7 0x67 */
4574 "kp-8", /* VK_NUMPAD8 0x68 */
4575 "kp-9", /* VK_NUMPAD9 0x69 */
4576 "kp-multiply", /* VK_MULTIPLY 0x6A */
4577 "kp-add", /* VK_ADD 0x6B */
4578 "kp-separator", /* VK_SEPARATOR 0x6C */
4579 "kp-subtract", /* VK_SUBTRACT 0x6D */
4580 "kp-decimal", /* VK_DECIMAL 0x6E */
4581 "kp-divide", /* VK_DIVIDE 0x6F */
4582 "f1", /* VK_F1 0x70 */
4583 "f2", /* VK_F2 0x71 */
4584 "f3", /* VK_F3 0x72 */
4585 "f4", /* VK_F4 0x73 */
4586 "f5", /* VK_F5 0x74 */
4587 "f6", /* VK_F6 0x75 */
4588 "f7", /* VK_F7 0x76 */
4589 "f8", /* VK_F8 0x77 */
4590 "f9", /* VK_F9 0x78 */
4591 "f10", /* VK_F10 0x79 */
4592 "f11", /* VK_F11 0x7A */
4593 "f12", /* VK_F12 0x7B */
4594 "f13", /* VK_F13 0x7C */
4595 "f14", /* VK_F14 0x7D */
4596 "f15", /* VK_F15 0x7E */
4597 "f16", /* VK_F16 0x7F */
4598 "f17", /* VK_F17 0x80 */
4599 "f18", /* VK_F18 0x81 */
4600 "f19", /* VK_F19 0x82 */
4601 "f20", /* VK_F20 0x83 */
4602 "f21", /* VK_F21 0x84 */
4603 "f22", /* VK_F22 0x85 */
4604 "f23", /* VK_F23 0x86 */
4605 "f24", /* VK_F24 0x87 */
4606
4607 0, 0, 0, 0, /* 0x88 .. 0x8B */
4608 0, 0, 0, 0, /* 0x8C .. 0x8F */
4609
4610 "kp-numlock", /* VK_NUMLOCK 0x90 */
4611 "scroll", /* VK_SCROLL 0x91 */
4612
e376f90d
RS
4613 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4614 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4615 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4616 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4617 "kp-end", /* VK_NUMPAD_END 0x96 */
4618 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4619 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4620 "kp-up", /* VK_NUMPAD_UP 0x99 */
4621 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4622 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4623 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4624 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4625
4626 0, 0, /* 0x9E .. 0x9F */
4627
e98a93eb
GV
4628 /*
4629 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
e8886a1d 4630 * Used only as parameters to GetAsyncKeyState and GetKeyState.
e98a93eb
GV
4631 * No other API or message will distinguish left and right keys this way.
4632 */
4633 /* 0xA0 .. 0xEF */
4634
4635 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4636 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4637 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4638 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4639 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4640
4641 /* 0xF0 .. 0xF5 */
4642
4643 0, 0, 0, 0, 0, 0,
4644
4645 "attn", /* VK_ATTN 0xF6 */
4646 "crsel", /* VK_CRSEL 0xF7 */
4647 "exsel", /* VK_EXSEL 0xF8 */
4648 "ereof", /* VK_EREOF 0xF9 */
4649 "play", /* VK_PLAY 0xFA */
4650 "zoom", /* VK_ZOOM 0xFB */
4651 "noname", /* VK_NONAME 0xFC */
4652 "pa1", /* VK_PA1 0xFD */
4653 "oem_clear", /* VK_OEM_CLEAR 0xFE */
1161d367 4654 0 /* 0xFF */
e98a93eb
GV
4655 };
4656
04f215f0 4657#else /* not HAVE_NTGUI */
e98a93eb 4658
ed3230db
DL
4659/* This should be dealt with in XTread_socket now, and that doesn't
4660 depend on the client system having the Kana syms defined. See also
4661 the XK_kana_A case below. */
4662#if 0
37cd9f30
KH
4663#ifdef XK_kana_A
4664static char *lispy_kana_keys[] =
4665 {
4666 /* X Keysym value */
4667 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4668 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4669 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4670 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4671 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4672 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4673 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4674 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4675 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4676 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4677 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4678 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4679 "kana-i", "kana-u", "kana-e", "kana-o",
4680 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4681 "prolongedsound", "kana-A", "kana-I", "kana-U",
4682 "kana-E", "kana-O", "kana-KA", "kana-KI",
4683 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4684 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4685 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4686 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4687 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4688 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4689 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4690 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4691 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4692 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4693 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4694 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4695 };
4696#endif /* XK_kana_A */
ed3230db 4697#endif /* 0 */
37cd9f30 4698
04f215f0
RS
4699#define FUNCTION_KEY_OFFSET 0xff00
4700
284f4730
JB
4701/* You'll notice that this table is arranged to be conveniently
4702 indexed by X Windows keysym values. */
4703static char *lispy_function_keys[] =
4704 {
4705 /* X Keysym value */
4706
75045dcb
RS
4707 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4708 "backspace", "tab", "linefeed", "clear",
4709 0, "return", 0, 0,
4710 0, 0, 0, "pause", /* 0xff10...1f */
4711 0, 0, 0, 0, 0, 0, 0, "escape",
86e5706b 4712 0, 0, 0, 0,
75045dcb
RS
4713 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4714 "romaji", "hiragana", "katakana", "hiragana-katakana",
4715 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4716 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4717 "eisu-toggle", /* 0xff30...3f */
4718 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
86e5706b
RS
4719 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4720
75045dcb
RS
4721 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4722 "down", "prior", "next", "end",
4723 "begin", 0, 0, 0, 0, 0, 0, 0,
284f4730
JB
4724 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4725 "print",
4726 "execute",
4727 "insert",
4728 0, /* 0xff64 */
4729 "undo",
4730 "redo",
4731 "menu",
4732 "find",
4733 "cancel",
4734 "help",
4735 "break", /* 0xff6b */
4736
75045dcb
RS
4737 0, 0, 0, 0,
4738 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4739 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
284f4730
JB
4740 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4741 0, 0, 0, 0, 0, 0, 0, 0,
4742 "kp-tab", /* 0xff89 */
4743 0, 0, 0,
4744 "kp-enter", /* 0xff8d */
4745 0, 0, 0,
4746 "kp-f1", /* 0xff91 */
4747 "kp-f2",
4748 "kp-f3",
4749 "kp-f4",
872157e7
RS
4750 "kp-home", /* 0xff95 */
4751 "kp-left",
4752 "kp-up",
4753 "kp-right",
4754 "kp-down",
4755 "kp-prior", /* kp-page-up */
4756 "kp-next", /* kp-page-down */
4757 "kp-end",
4758 "kp-begin",
4759 "kp-insert",
4760 "kp-delete",
4761 0, /* 0xffa0 */
4762 0, 0, 0, 0, 0, 0, 0, 0, 0,
284f4730
JB
4763 "kp-multiply", /* 0xffaa */
4764 "kp-add",
4765 "kp-separator",
4766 "kp-subtract",
4767 "kp-decimal",
4768 "kp-divide", /* 0xffaf */
4769 "kp-0", /* 0xffb0 */
4770 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4771 0, /* 0xffba */
4772 0, 0,
4773 "kp-equal", /* 0xffbd */
4774 "f1", /* 0xffbe */ /* IsFunctionKey */
86e5706b
RS
4775 "f2",
4776 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4777 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4778 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4779 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4780 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4781 0, 0, 0, 0, 0, 0, 0, 0,
4782 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4783 0, 0, 0, 0, 0, 0, 0, "delete"
04f215f0 4784 };
284f4730 4785
04f215f0
RS
4786/* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4787#define ISO_FUNCTION_KEY_OFFSET 0xfe00
4788
4789static char *iso_lispy_function_keys[] =
4790 {
4791 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4792 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4793 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4794 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4795 "iso-lefttab", /* 0xfe20 */
4796 "iso-move-line-up", "iso-move-line-down",
4797 "iso-partial-line-up", "iso-partial-line-down",
4798 "iso-partial-space-left", "iso-partial-space-right",
4799 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4800 "iso-release-margin-left", "iso-release-margin-right",
4801 "iso-release-both-margins",
4802 "iso-fast-cursor-left", "iso-fast-cursor-right",
4803 "iso-fast-cursor-up", "iso-fast-cursor-down",
4804 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4805 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4806 };
4807
4808#endif /* not HAVE_NTGUI */
e98a93eb 4809
8e1e4240 4810Lisp_Object Vlispy_mouse_stem;
284f4730 4811
742fbed7 4812#if defined(WINDOWSNT) || defined(MAC_OSX)
07de30b9
GV
4813/* mouse-wheel events are generated by the wheel on devices such as
4814 the MS Intellimouse. The wheel sits in between the left and right
4815 mouse buttons, and is typically used to scroll or zoom the window
4816 underneath the pointer. mouse-wheel events specify the object on
4817 which they operate, and a delta corresponding to the amount and
4818 direction that the wheel is rotated. Clicking the mouse-wheel
4819 generates a mouse-2 event. */
4820static char *lispy_mouse_wheel_names[] =
4821{
4822 "mouse-wheel"
4823};
a24dc617 4824
07de30b9
GV
4825#endif /* WINDOWSNT */
4826
a24dc617
RS
4827/* drag-n-drop events are generated when a set of selected files are
4828 dragged from another application and dropped onto an Emacs window. */
4829static char *lispy_drag_n_drop_names[] =
4830{
4831 "drag-n-drop"
4832};
4833
3c370943 4834/* Scroll bar parts. */
4bb994d1 4835Lisp_Object Qabove_handle, Qhandle, Qbelow_handle;
7ee32cda 4836Lisp_Object Qup, Qdown, Qbottom, Qend_scroll;
eef28553 4837Lisp_Object Qtop, Qratio;
4bb994d1 4838
3c370943
JB
4839/* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4840Lisp_Object *scroll_bar_parts[] = {
db08707d 4841 &Qabove_handle, &Qhandle, &Qbelow_handle,
eef28553 4842 &Qup, &Qdown, &Qtop, &Qbottom, &Qend_scroll, &Qratio
4bb994d1
JB
4843};
4844
5bf68f6e
AS
4845/* User signal events. */
4846Lisp_Object Qusr1_signal, Qusr2_signal;
4847
4848Lisp_Object *lispy_user_signals[] =
4849{
4850 &Qusr1_signal, &Qusr2_signal
4851};
4852
4bb994d1 4853
7b4aedb9 4854/* A vector, indexed by button number, giving the down-going location
3c370943 4855 of currently depressed buttons, both scroll bar and non-scroll bar.
7b4aedb9
JB
4856
4857 The elements have the form
4858 (BUTTON-NUMBER MODIFIER-MASK . REST)
4859 where REST is the cdr of a position as it would be reported in the event.
4860
4861 The make_lispy_event function stores positions here to tell the
4862 difference between click and drag events, and to store the starting
4863 location to be included in drag events. */
4864
4865static Lisp_Object button_down_location;
88cb0656 4866
fbcd35bd
JB
4867/* Information about the most recent up-going button event: Which
4868 button, what location, and what time. */
4869
559f9d04
RS
4870static int last_mouse_button;
4871static int last_mouse_x;
4872static int last_mouse_y;
4873static unsigned long button_down_time;
fbcd35bd 4874
222d557c
GM
4875/* The maximum time between clicks to make a double-click, or Qnil to
4876 disable double-click detection, or Qt for no time limit. */
4877
564dc952 4878Lisp_Object Vdouble_click_time;
fbcd35bd 4879
222d557c
GM
4880/* Maximum number of pixels the mouse may be moved between clicks
4881 to make a double-click. */
4882
31ade731 4883EMACS_INT double_click_fuzz;
222d557c 4884
fbcd35bd
JB
4885/* The number of clicks in this multiple-click. */
4886
4887int double_click_count;
4888
284f4730
JB
4889/* Given a struct input_event, build the lisp event which represents
4890 it. If EVENT is 0, build a mouse movement event from the mouse
88cb0656
JB
4891 movement buffer, which should have a movement event in it.
4892
4893 Note that events must be passed to this function in the order they
4894 are received; this function stores the location of button presses
4895 in order to build drag events when the button is released. */
284f4730
JB
4896
4897static Lisp_Object
4898make_lispy_event (event)
4899 struct input_event *event;
4900{
79a7046c
RS
4901 int i;
4902
0220c518 4903 switch (SWITCH_ENUM_CAST (event->kind))
284f4730 4904 {
284f4730 4905 /* A simple keystroke. */
3b8f9651 4906 case ASCII_KEYSTROKE_EVENT:
86e5706b 4907 {
9343ab07 4908 Lisp_Object lispy_c;
e9bf89a0 4909 int c = event->code & 0377;
5a1c6df8
JB
4910 /* Turn ASCII characters into control characters
4911 when proper. */
4912 if (event->modifiers & ctrl_modifier)
d205953b
JB
4913 c = make_ctrl_char (c);
4914
4915 /* Add in the other modifier bits. We took care of ctrl_modifier
4916 just above, and the shift key was taken care of by the X code,
4917 and applied to control characters by make_ctrl_char. */
86e5706b
RS
4918 c |= (event->modifiers
4919 & (meta_modifier | alt_modifier
4920 | hyper_modifier | super_modifier));
32454a9f
RS
4921 /* Distinguish Shift-SPC from SPC. */
4922 if ((event->code & 0377) == 040
4923 && event->modifiers & shift_modifier)
4924 c |= shift_modifier;
559f9d04 4925 button_down_time = 0;
bb9e9bed 4926 XSETFASTINT (lispy_c, c);
9343ab07 4927 return lispy_c;
86e5706b 4928 }
284f4730 4929
3b8f9651 4930 case MULTIBYTE_CHAR_KEYSTROKE_EVENT:
a50e723f
KH
4931 {
4932 Lisp_Object lispy_c;
4933
4934 XSETFASTINT (lispy_c, event->code);
4935 return lispy_c;
4936 }
4937
284f4730
JB
4938 /* A function key. The symbol may need to have modifier prefixes
4939 tacked onto it. */
3b8f9651 4940 case NON_ASCII_KEYSTROKE_EVENT:
559f9d04 4941 button_down_time = 0;
e9bf89a0
RS
4942
4943 for (i = 0; i < sizeof (lispy_accent_codes) / sizeof (int); i++)
4944 if (event->code == lispy_accent_codes[i])
4945 return modify_event_symbol (i,
4946 event->modifiers,
80e4aa30 4947 Qfunction_key, Qnil,
e9bf89a0
RS
4948 lispy_accent_keys, &accent_key_syms,
4949 (sizeof (lispy_accent_keys)
4950 / sizeof (lispy_accent_keys[0])));
4951
ed3230db 4952#if 0
37cd9f30
KH
4953#ifdef XK_kana_A
4954 if (event->code >= 0x400 && event->code < 0x500)
4955 return modify_event_symbol (event->code - 0x400,
4956 event->modifiers & ~shift_modifier,
4957 Qfunction_key, Qnil,
4958 lispy_kana_keys, &func_key_syms,
4959 (sizeof (lispy_kana_keys)
4960 / sizeof (lispy_kana_keys[0])));
4961#endif /* XK_kana_A */
ed3230db 4962#endif /* 0 */
37cd9f30 4963
111c4138 4964#ifdef ISO_FUNCTION_KEY_OFFSET
04f215f0
RS
4965 if (event->code < FUNCTION_KEY_OFFSET
4966 && event->code >= ISO_FUNCTION_KEY_OFFSET)
4967 return modify_event_symbol (event->code - ISO_FUNCTION_KEY_OFFSET,
4968 event->modifiers,
4969 Qfunction_key, Qnil,
4970 iso_lispy_function_keys, &func_key_syms,
4971 (sizeof (iso_lispy_function_keys)
4972 / sizeof (iso_lispy_function_keys[0])));
111c4138 4973#endif
656280a6 4974
4c8bc894
SM
4975 /* Handle system-specific or unknown keysyms. */
4976 if (event->code & (1 << 28)
4977 || event->code - FUNCTION_KEY_OFFSET < 0
656280a6 4978 || (event->code - FUNCTION_KEY_OFFSET
4c8bc894
SM
4979 >= sizeof lispy_function_keys / sizeof *lispy_function_keys)
4980 || !lispy_function_keys[event->code - FUNCTION_KEY_OFFSET])
656280a6 4981 {
4c8bc894
SM
4982 /* We need to use an alist rather than a vector as the cache
4983 since we can't make a vector long enuf. */
4984 if (NILP (current_kboard->system_key_syms))
4985 current_kboard->system_key_syms = Fcons (Qnil, Qnil);
4986 return modify_event_symbol (event->code,
4987 event->modifiers,
4988 Qfunction_key,
4989 current_kboard->Vsystem_key_alist,
4990 0, &current_kboard->system_key_syms,
4991 (unsigned) -1);
656280a6 4992 }
656280a6
GM
4993
4994 return modify_event_symbol (event->code - FUNCTION_KEY_OFFSET,
4995 event->modifiers,
4996 Qfunction_key, Qnil,
4997 lispy_function_keys, &func_key_syms,
4998 (sizeof (lispy_function_keys)
4999 / sizeof (lispy_function_keys[0])));
284f4730 5000
514354e9 5001#ifdef HAVE_MOUSE
df0f2ba1 5002 /* A mouse click. Figure out where it is, decide whether it's
88cb0656 5003 a press, click or drag, and build the appropriate structure. */
3b8f9651 5004 case MOUSE_CLICK_EVENT:
7ee32cda 5005#ifndef USE_TOOLKIT_SCROLL_BARS
3b8f9651 5006 case SCROLL_BAR_CLICK_EVENT:
7ee32cda 5007#endif
284f4730 5008 {
e9bf89a0 5009 int button = event->code;
559f9d04 5010 int is_double;
7b4aedb9 5011 Lisp_Object position;
dbc4e1c1
JB
5012 Lisp_Object *start_pos_ptr;
5013 Lisp_Object start_pos;
c5cf2109 5014 Lisp_Object window;
284f4730 5015
8c907a56
GM
5016 position = Qnil;
5017
7b4aedb9 5018 /* Build the position as appropriate for this mouse click. */
3b8f9651 5019 if (event->kind == MOUSE_CLICK_EVENT)
284f4730 5020 {
7b4aedb9 5021 int part;
c5cf2109 5022 struct frame *f = XFRAME (event->frame_or_window);
7b4aedb9 5023 Lisp_Object posn;
7ee32cda 5024 Lisp_Object string_info = Qnil;
9e20143a
RS
5025 int row, column;
5026
5da3133a
RS
5027 /* Ignore mouse events that were made on frame that
5028 have been deleted. */
5029 if (! FRAME_LIVE_P (f))
5030 return Qnil;
5031
7ee32cda
GM
5032 /* EVENT->x and EVENT->y are frame-relative pixel
5033 coordinates at this place. Under old redisplay, COLUMN
5034 and ROW are set to frame relative glyph coordinates
5035 which are then used to determine whether this click is
5036 in a menu (non-toolkit version). */
5037 pixel_to_glyph_coords (f, XINT (event->x), XINT (event->y),
5038 &column, &row, NULL, 1);
7b4aedb9 5039
eef045bf
RS
5040#ifndef USE_X_TOOLKIT
5041 /* In the non-toolkit version, clicks on the menu bar
5042 are ordinary button events in the event buffer.
5043 Distinguish them, and invoke the menu.
5044
5045 (In the toolkit version, the toolkit handles the menu bar
5046 and Emacs doesn't know about it until after the user
5047 makes a selection.) */
2ee250ec
RS
5048 if (row >= 0 && row < FRAME_MENU_BAR_LINES (f)
5049 && (event->modifiers & down_modifier))
bb936752 5050 {
b7c49376 5051 Lisp_Object items, item;
0a0e8fe6
RS
5052 int hpos;
5053 int i;
5054
2ee250ec 5055#if 0
0a0e8fe6
RS
5056 /* Activate the menu bar on the down event. If the
5057 up event comes in before the menu code can deal with it,
5058 just ignore it. */
5059 if (! (event->modifiers & down_modifier))
5060 return Qnil;
2ee250ec 5061#endif
0aafc975 5062
7ee32cda 5063 /* Find the menu bar item under `column'. */
f2ae6b3f 5064 item = Qnil;
5ec75a55 5065 items = FRAME_MENU_BAR_ITEMS (f);
35b3402f 5066 for (i = 0; i < XVECTOR (items)->size; i += 4)
5ec75a55
RS
5067 {
5068 Lisp_Object pos, string;
129004d3
GM
5069 string = AREF (items, i + 1);
5070 pos = AREF (items, i + 3);
b7c49376
RS
5071 if (NILP (string))
5072 break;
9e20143a 5073 if (column >= XINT (pos)
d5db4077 5074 && column < XINT (pos) + SCHARS (string))
b7c49376 5075 {
129004d3 5076 item = AREF (items, i);
b7c49376
RS
5077 break;
5078 }
5ec75a55 5079 }
9e20143a 5080
7ee32cda
GM
5081 /* ELisp manual 2.4b says (x y) are window relative but
5082 code says they are frame-relative. */
5ec75a55
RS
5083 position
5084 = Fcons (event->frame_or_window,
5085 Fcons (Qmenu_bar,
5086 Fcons (Fcons (event->x, event->y),
5087 Fcons (make_number (event->timestamp),
5088 Qnil))));
5089
b7c49376 5090 return Fcons (item, Fcons (position, Qnil));
5ec75a55 5091 }
eef045bf 5092#endif /* not USE_X_TOOLKIT */
0aafc975 5093
7ee32cda
GM
5094 /* Set `window' to the window under frame pixel coordinates
5095 event->x/event->y. */
5096 window = window_from_coordinates (f, XINT (event->x),
5097 XINT (event->y), &part, 0);
0aafc975 5098
8c18cbfb 5099 if (!WINDOWP (window))
78ced549
RS
5100 {
5101 window = event->frame_or_window;
5102 posn = Qnil;
5103 }
284f4730 5104 else
7b4aedb9 5105 {
7ee32cda
GM
5106 /* It's a click in window window at frame coordinates
5107 event->x/ event->y. */
5108 struct window *w = XWINDOW (window);
5109
5110 /* Get window relative coordinates. Original code
5111 `rounded' this to glyph boundaries. */
5112 int wx = FRAME_TO_WINDOW_PIXEL_X (w, XINT (event->x));
5113 int wy = FRAME_TO_WINDOW_PIXEL_Y (w, XINT (event->y));
5114
5115 /* Set event coordinates to window-relative coordinates
5116 for constructing the Lisp event below. */
5117 XSETINT (event->x, wx);
5118 XSETINT (event->y, wy);
5119
5120 if (part == 1 || part == 3)
5121 {
902ae620 5122 /* Mode line or header line. Look for a string under
7ee32cda
GM
5123 the mouse that may have a `local-map' property. */
5124 Lisp_Object string;
5125 int charpos;
5126
045dee35 5127 posn = part == 1 ? Qmode_line : Qheader_line;
7ee32cda
GM
5128 string = mode_line_string (w, wx, wy, part == 1, &charpos);
5129 if (STRINGP (string))
5130 string_info = Fcons (string, make_number (charpos));
5131 }
7b4aedb9
JB
5132 else if (part == 2)
5133 posn = Qvertical_line;
7d60ad8a
GM
5134 else if (part == 6 || part == 7)
5135 {
5136 int charpos;
5137 Lisp_Object object = marginal_area_string (w, wx, wy, part,
5138 &charpos);
5139 posn = (part == 6) ? Qleft_margin : Qright_margin;
5140 if (STRINGP (object))
5141 string_info = Fcons (object, make_number (charpos));
5142 }
7b4aedb9 5143 else
a955ffa2
GM
5144 {
5145 Lisp_Object object;
5146 struct display_pos p;
5147 buffer_posn_from_coords (w, &wx, &wy, &object, &p);
5148 posn = make_number (CHARPOS (p.pos));
db14cfc5
GM
5149 if (STRINGP (object))
5150 string_info
5151 = Fcons (object,
5152 make_number (CHARPOS (p.string_pos)));
a955ffa2 5153 }
7b4aedb9
JB
5154 }
5155
5ec75a55
RS
5156 position
5157 = Fcons (window,
5158 Fcons (posn,
5159 Fcons (Fcons (event->x, event->y),
5160 Fcons (make_number (event->timestamp),
7ee32cda
GM
5161 (NILP (string_info)
5162 ? Qnil
5163 : Fcons (string_info, Qnil))))));
284f4730 5164 }
7ee32cda 5165#ifndef USE_TOOLKIT_SCROLL_BARS
7b4aedb9 5166 else
88cb0656 5167 {
7ee32cda 5168 /* It's a scrollbar click. */
9e20143a
RS
5169 Lisp_Object portion_whole;
5170 Lisp_Object part;
5171
5172 window = event->frame_or_window;
5173 portion_whole = Fcons (event->x, event->y);
5174 part = *scroll_bar_parts[(int) event->part];
7b4aedb9 5175
db08707d
RS
5176 position
5177 = Fcons (window,
5178 Fcons (Qvertical_scroll_bar,
5179 Fcons (portion_whole,
5180 Fcons (make_number (event->timestamp),
5181 Fcons (part, Qnil)))));
88cb0656 5182 }
7ee32cda 5183#endif /* not USE_TOOLKIT_SCROLL_BARS */
88cb0656 5184
129004d3 5185 if (button >= ASIZE (button_down_location))
8e1e4240
GM
5186 {
5187 button_down_location = larger_vector (button_down_location,
5188 button + 1, Qnil);
5189 mouse_syms = larger_vector (mouse_syms, button + 1, Qnil);
5190 }
5191
129004d3 5192 start_pos_ptr = &AREF (button_down_location, button);
dbc4e1c1
JB
5193 start_pos = *start_pos_ptr;
5194 *start_pos_ptr = Qnil;
7b4aedb9 5195
c5cf2109
GM
5196 {
5197 /* On window-system frames, use the value of
5198 double-click-fuzz as is. On other frames, interpret it
5199 as a multiple of 1/8 characters. */
5200 struct frame *f;
5201 int fuzz;
5202
5203 if (WINDOWP (event->frame_or_window))
5204 f = XFRAME (XWINDOW (event->frame_or_window)->frame);
5205 else if (FRAMEP (event->frame_or_window))
5206 f = XFRAME (event->frame_or_window);
5207 else
5208 abort ();
5209
5210 if (FRAME_WINDOW_P (f))
5211 fuzz = double_click_fuzz;
5212 else
5213 fuzz = double_click_fuzz / 8;
5214
5215 is_double = (button == last_mouse_button
5216 && (abs (XINT (event->x) - last_mouse_x) <= fuzz)
5217 && (abs (XINT (event->y) - last_mouse_y) <= fuzz)
5218 && button_down_time != 0
5219 && (EQ (Vdouble_click_time, Qt)
5220 || (INTEGERP (Vdouble_click_time)
5221 && ((int)(event->timestamp - button_down_time)
5222 < XINT (Vdouble_click_time)))));
5223 }
222d557c 5224
559f9d04
RS
5225 last_mouse_button = button;
5226 last_mouse_x = XINT (event->x);
5227 last_mouse_y = XINT (event->y);
5228
7b4aedb9
JB
5229 /* If this is a button press, squirrel away the location, so
5230 we can decide later whether it was a click or a drag. */
5231 if (event->modifiers & down_modifier)
559f9d04
RS
5232 {
5233 if (is_double)
5234 {
5235 double_click_count++;
5236 event->modifiers |= ((double_click_count > 2)
5237 ? triple_modifier
5238 : double_modifier);
5239 }
5240 else
5241 double_click_count = 1;
5242 button_down_time = event->timestamp;
5243 *start_pos_ptr = Fcopy_alist (position);
5244 }
7b4aedb9 5245
88cb0656 5246 /* Now we're releasing a button - check the co-ordinates to
7b4aedb9 5247 see if this was a click or a drag. */
88cb0656
JB
5248 else if (event->modifiers & up_modifier)
5249 {
129004d3
GM
5250 /* If we did not see a down before this up, ignore the up.
5251 Probably this happened because the down event chose a
5252 menu item. It would be an annoyance to treat the
5253 release of the button that chose the menu item as a
5254 separate event. */
48e416d4 5255
8c18cbfb 5256 if (!CONSP (start_pos))
48e416d4
RS
5257 return Qnil;
5258
88cb0656 5259 event->modifiers &= ~up_modifier;
48e416d4 5260#if 0 /* Formerly we treated an up with no down as a click event. */
8c18cbfb 5261 if (!CONSP (start_pos))
dbc4e1c1
JB
5262 event->modifiers |= click_modifier;
5263 else
48e416d4 5264#endif
dbc4e1c1 5265 {
9b8eb840 5266 Lisp_Object down;
d31053f9 5267 EMACS_INT xdiff = double_click_fuzz, ydiff = double_click_fuzz;
dbc4e1c1 5268
d31053f9
RS
5269 /* The third element of every position
5270 should be the (x,y) pair. */
5271 down = Fcar (Fcdr (Fcdr (start_pos)));
7a6a97d7
SM
5272 if (CONSP (down)
5273 && INTEGERP (XCAR (down)) && INTEGERP (XCDR (down)))
d31053f9 5274 {
7a6a97d7
SM
5275 xdiff = XFASTINT (event->x) - XFASTINT (XCAR (down));
5276 ydiff = XFASTINT (event->y) - XFASTINT (XCDR (down));
d31053f9
RS
5277 }
5278
5279 if (xdiff < double_click_fuzz && xdiff > - double_click_fuzz
5280 && ydiff < double_click_fuzz
5281 && ydiff > - double_click_fuzz)
5282 /* Mouse hasn't moved (much). */
129004d3 5283 event->modifiers |= click_modifier;
fbcd35bd
JB
5284 else
5285 {
d31053f9
RS
5286 button_down_time = 0;
5287 event->modifiers |= drag_modifier;
fbcd35bd 5288 }
129004d3 5289
bc536d84
RS
5290 /* Don't check is_double; treat this as multiple
5291 if the down-event was multiple. */
5292 if (double_click_count > 1)
5293 event->modifiers |= ((double_click_count > 2)
5294 ? triple_modifier
5295 : double_modifier);
dbc4e1c1 5296 }
88cb0656
JB
5297 }
5298 else
5299 /* Every mouse event should either have the down_modifier or
7b4aedb9 5300 the up_modifier set. */
88cb0656
JB
5301 abort ();
5302
88cb0656 5303 {
7b4aedb9 5304 /* Get the symbol we should use for the mouse click. */
9b8eb840
KH
5305 Lisp_Object head;
5306
5307 head = modify_event_symbol (button,
5308 event->modifiers,
8e1e4240
GM
5309 Qmouse_click, Vlispy_mouse_stem,
5310 NULL,
5311 &mouse_syms,
5312 XVECTOR (mouse_syms)->size);
88cb0656 5313 if (event->modifiers & drag_modifier)
dbc4e1c1
JB
5314 return Fcons (head,
5315 Fcons (start_pos,
5316 Fcons (position,
5317 Qnil)));
fbcd35bd
JB
5318 else if (event->modifiers & (double_modifier | triple_modifier))
5319 return Fcons (head,
5320 Fcons (position,
5321 Fcons (make_number (double_click_count),
5322 Qnil)));
88cb0656
JB
5323 else
5324 return Fcons (head,
7b4aedb9 5325 Fcons (position,
88cb0656
JB
5326 Qnil));
5327 }
284f4730 5328 }
db08707d 5329
05be3964 5330#ifdef USE_TOOLKIT_SCROLL_BARS
7ee32cda
GM
5331
5332 /* We don't have down and up events if using toolkit scroll bars,
5333 so make this always a click event. Store in the `part' of
5334 the Lisp event a symbol which maps to the following actions:
5335
5336 `above_handle' page up
5337 `below_handle' page down
5338 `up' line up
5339 `down' line down
5340 `top' top of buffer
5341 `bottom' bottom of buffer
5342 `handle' thumb has been dragged.
5343 `end-scroll' end of interaction with scroll bar
5344
5345 The incoming input_event contains in its `part' member an
5346 index of type `enum scroll_bar_part' which we can use as an
5347 index in scroll_bar_parts to get the appropriate symbol. */
5348
3b8f9651 5349 case SCROLL_BAR_CLICK_EVENT:
7ee32cda
GM
5350 {
5351 Lisp_Object position, head, window, portion_whole, part;
5352
5353 window = event->frame_or_window;
5354 portion_whole = Fcons (event->x, event->y);
5355 part = *scroll_bar_parts[(int) event->part];
5356
5357 position
5358 = Fcons (window,
5359 Fcons (Qvertical_scroll_bar,
5360 Fcons (portion_whole,
5361 Fcons (make_number (event->timestamp),
5362 Fcons (part, Qnil)))));
5363
5364 /* Always treat scroll bar events as clicks. */
5365 event->modifiers |= click_modifier;
05be3964 5366 event->modifiers &= ~up_modifier;
7ee32cda
GM
5367
5368 /* Get the symbol we should use for the mouse click. */
5369 head = modify_event_symbol (event->code,
5370 event->modifiers,
14e40288 5371 Qmouse_click,
8e1e4240
GM
5372 Vlispy_mouse_stem,
5373 NULL, &mouse_syms,
5374 XVECTOR (mouse_syms)->size);
7ee32cda
GM
5375 return Fcons (head, Fcons (position, Qnil));
5376 }
5377
5378#endif /* USE_TOOLKIT_SCROLL_BARS */
5379
db08707d 5380#ifdef WINDOWSNT
3b8f9651 5381 case W32_SCROLL_BAR_CLICK_EVENT:
db08707d
RS
5382 {
5383 int button = event->code;
5384 int is_double;
5385 Lisp_Object position;
5386 Lisp_Object *start_pos_ptr;
5387 Lisp_Object start_pos;
5388
db08707d
RS
5389 {
5390 Lisp_Object window;
5391 Lisp_Object portion_whole;
5392 Lisp_Object part;
5393
5394 window = event->frame_or_window;
5395 portion_whole = Fcons (event->x, event->y);
5396 part = *scroll_bar_parts[(int) event->part];
5397
e8886a1d
RS
5398 position
5399 = Fcons (window,
5400 Fcons (Qvertical_scroll_bar,
5401 Fcons (portion_whole,
5402 Fcons (make_number (event->timestamp),
5403 Fcons (part, Qnil)))));
db08707d
RS
5404 }
5405
fbd6baed 5406 /* Always treat W32 scroll bar events as clicks. */
db08707d
RS
5407 event->modifiers |= click_modifier;
5408
5409 {
5410 /* Get the symbol we should use for the mouse click. */
5411 Lisp_Object head;
5412
5413 head = modify_event_symbol (button,
5414 event->modifiers,
8e1e4240
GM
5415 Qmouse_click,
5416 Vlispy_mouse_stem,
5417 NULL, &mouse_syms,
5418 XVECTOR (mouse_syms)->size);
db08707d
RS
5419 return Fcons (head,
5420 Fcons (position,
5421 Qnil));
5422 }
5423 }
1e7c162f
RS
5424#endif /* WINDOWSNT */
5425#if defined(WINDOWSNT) || defined(MAC_OSX)
3b8f9651 5426 case MOUSE_WHEEL_EVENT:
07de30b9
GV
5427 {
5428 int part;
5429 FRAME_PTR f = XFRAME (event->frame_or_window);
5430 Lisp_Object window;
5431 Lisp_Object posn;
5432 Lisp_Object head, position;
5433 int row, column;
5434
5435 /* Ignore mouse events that were made on frame that
5436 have been deleted. */
5437 if (! FRAME_LIVE_P (f))
5438 return Qnil;
5439 pixel_to_glyph_coords (f, XINT (event->x), XINT (event->y),
5440 &column, &row, NULL, 1);
afabdbe5
JR
5441 window = window_from_coordinates (f, XINT (event->x),
5442 XINT (event->y), &part, 0);
07de30b9
GV
5443
5444 if (!WINDOWP (window))
5445 {
5446 window = event->frame_or_window;
5447 posn = Qnil;
5448 }
5449 else
5450 {
5451 int pixcolumn, pixrow;
5452 column -= XINT (XWINDOW (window)->left);
5453 row -= XINT (XWINDOW (window)->top);
e1bfeab2
JR
5454 glyph_to_pixel_coords (XWINDOW(window), column, row,
5455 &pixcolumn, &pixrow);
07de30b9
GV
5456 XSETINT (event->x, pixcolumn);
5457 XSETINT (event->y, pixrow);
5458
5459 if (part == 1)
5460 posn = Qmode_line;
5461 else if (part == 2)
5462 posn = Qvertical_line;
7ee32cda 5463 else if (part == 3)
045dee35 5464 posn = Qheader_line;
07de30b9 5465 else
a955ffa2
GM
5466 {
5467 Lisp_Object object;
5468 struct display_pos p;
5469 buffer_posn_from_coords (XWINDOW (window), &column, &row,
5470 &object, &p);
5471 posn = make_number (CHARPOS (p.pos));
5472 }
07de30b9 5473 }
db08707d 5474
07de30b9
GV
5475 {
5476 Lisp_Object head, position;
5477
5478 position
5479 = Fcons (window,
5480 Fcons (posn,
5481 Fcons (Fcons (event->x, event->y),
5482 Fcons (make_number (event->timestamp),
5483 Qnil))));
5484
5485 head = modify_event_symbol (0, event->modifiers,
5486 Qmouse_wheel, Qnil,
5487 lispy_mouse_wheel_names,
5488 &mouse_wheel_syms, 1);
5489 return Fcons (head,
5490 Fcons (position,
406b073d
JR
5491 /* Insert 1 here so event-click-count works. */
5492 Fcons (make_number (1),
5493 Fcons (make_number (event->code),
5494 Qnil))));
07de30b9
GV
5495 }
5496 }
742fbed7 5497#endif /* WINDOWSNT || MAC_OSX */
a24dc617 5498
3b8f9651 5499 case DRAG_N_DROP_EVENT:
a24dc617
RS
5500 {
5501 int part;
5502 FRAME_PTR f;
5503 Lisp_Object window;
5504 Lisp_Object posn;
a24dc617 5505 Lisp_Object files;
a24dc617
RS
5506
5507 /* The frame_or_window field should be a cons of the frame in
5508 which the event occurred and a list of the filenames
5509 dropped. */
5510 if (! CONSP (event->frame_or_window))
5511 abort ();
5512
7539e11f
KR
5513 f = XFRAME (XCAR (event->frame_or_window));
5514 files = XCDR (event->frame_or_window);
a24dc617
RS
5515
5516 /* Ignore mouse events that were made on frames that
5517 have been deleted. */
5518 if (! FRAME_LIVE_P (f))
5519 return Qnil;
afabdbe5
JR
5520
5521 window = window_from_coordinates (f, XINT (event->x),
5522 XINT (event->y), &part, 0);
a24dc617
RS
5523
5524 if (!WINDOWP (window))
5525 {
7539e11f 5526 window = XCAR (event->frame_or_window);
a24dc617
RS
5527 posn = Qnil;
5528 }
5529 else
5530 {
7ee32cda
GM
5531 /* It's an event in window `window' at frame coordinates
5532 event->x/ event->y. */
5533 struct window *w = XWINDOW (window);
5534
5535 /* Get window relative coordinates. */
5536 int wx = FRAME_TO_WINDOW_PIXEL_X (w, XINT (event->x));
5537 int wy = FRAME_TO_WINDOW_PIXEL_Y (w, XINT (event->y));
5538
5539 /* Set event coordinates to window-relative coordinates
5540 for constructing the Lisp event below. */
5541 XSETINT (event->x, wx);
5542 XSETINT (event->y, wy);
a24dc617
RS
5543
5544 if (part == 1)
5545 posn = Qmode_line;
5546 else if (part == 2)
5547 posn = Qvertical_line;
7ee32cda 5548 else if (part == 3)
045dee35 5549 posn = Qheader_line;
a24dc617 5550 else
a955ffa2
GM
5551 {
5552 Lisp_Object object;
5553 struct display_pos p;
5554 buffer_posn_from_coords (w, &wx, &wy, &object, &p);
5555 posn = make_number (CHARPOS (p.pos));
5556 }
a24dc617
RS
5557 }
5558
5559 {
5560 Lisp_Object head, position;
5561
5562 position
5563 = Fcons (window,
5564 Fcons (posn,
5565 Fcons (Fcons (event->x, event->y),
5566 Fcons (make_number (event->timestamp),
5567 Qnil))));
5568
5569 head = modify_event_symbol (0, event->modifiers,
5570 Qdrag_n_drop, Qnil,
5571 lispy_drag_n_drop_names,
5572 &drag_n_drop_syms, 1);
5573 return Fcons (head,
5574 Fcons (position,
5575 Fcons (files,
5576 Qnil)));
5577 }
5578 }
514354e9 5579#endif /* HAVE_MOUSE */
284f4730 5580
e0f712ba 5581#if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS)
da8f7368
GM
5582 case MENU_BAR_EVENT:
5583 if (EQ (event->arg, event->frame_or_window))
5584 /* This is the prefix key. We translate this to
5585 `(menu_bar)' because the code in keyboard.c for menu
5586 events, which we use, relies on this. */
5587 return Fcons (Qmenu_bar, Qnil);
5588 return event->arg;
2470a66f
KH
5589#endif
5590
9ea173e8 5591 case TOOL_BAR_EVENT:
da8f7368
GM
5592 if (EQ (event->arg, event->frame_or_window))
5593 /* This is the prefix key. We translate this to
27fd22dc 5594 `(tool_bar)' because the code in keyboard.c for tool bar
da8f7368
GM
5595 events, which we use, relies on this. */
5596 return Fcons (Qtool_bar, Qnil);
5597 else if (SYMBOLP (event->arg))
5598 return apply_modifiers (event->modifiers, event->arg);
5599 return event->arg;
5600
5601 case USER_SIGNAL_EVENT:
5bf68f6e
AS
5602 /* A user signal. */
5603 return *lispy_user_signals[event->code];
5604
3b8f9651 5605 case SAVE_SESSION_EVENT:
4ebc27a5
JD
5606 return Qsave_session;
5607
284f4730
JB
5608 /* The 'kind' field of the event is something we don't recognize. */
5609 default:
48e416d4 5610 abort ();
284f4730
JB
5611 }
5612}
5613
514354e9 5614#ifdef HAVE_MOUSE
6cbff1cb 5615
284f4730 5616static Lisp_Object
7b4aedb9 5617make_lispy_movement (frame, bar_window, part, x, y, time)
ff11dfa1 5618 FRAME_PTR frame;
7b4aedb9 5619 Lisp_Object bar_window;
3c370943 5620 enum scroll_bar_part part;
284f4730 5621 Lisp_Object x, y;
e5d77022 5622 unsigned long time;
284f4730 5623{
3c370943 5624 /* Is it a scroll bar movement? */
7b4aedb9 5625 if (frame && ! NILP (bar_window))
4bb994d1 5626 {
9b8eb840 5627 Lisp_Object part_sym;
4bb994d1 5628
9b8eb840 5629 part_sym = *scroll_bar_parts[(int) part];
3c370943 5630 return Fcons (Qscroll_bar_movement,
7b4aedb9 5631 (Fcons (Fcons (bar_window,
3c370943 5632 Fcons (Qvertical_scroll_bar,
4bb994d1
JB
5633 Fcons (Fcons (x, y),
5634 Fcons (make_number (time),
cb5df6ae 5635 Fcons (part_sym,
4bb994d1
JB
5636 Qnil))))),
5637 Qnil)));
5638 }
5639
5640 /* Or is it an ordinary mouse movement? */
284f4730
JB
5641 else
5642 {
4bb994d1 5643 int area;
9e20143a 5644 Lisp_Object window;
4bb994d1 5645 Lisp_Object posn;
9e20143a 5646
9e20143a 5647 if (frame)
7ee32cda
GM
5648 /* It's in a frame; which window on that frame? */
5649 window = window_from_coordinates (frame, XINT (x), XINT (y), &area, 0);
9e20143a
RS
5650 else
5651 window = Qnil;
4bb994d1 5652
8c18cbfb 5653 if (WINDOWP (window))
4bb994d1 5654 {
7ee32cda 5655 struct window *w = XWINDOW (window);
7ee32cda 5656 int wx, wy;
7ee32cda
GM
5657
5658 /* Get window relative coordinates. */
5659 wx = FRAME_TO_WINDOW_PIXEL_X (w, XINT (x));
5660 wy = FRAME_TO_WINDOW_PIXEL_Y (w, XINT (y));
5661 XSETINT (x, wx);
5662 XSETINT (y, wy);
5663
4bb994d1
JB
5664 if (area == 1)
5665 posn = Qmode_line;
5666 else if (area == 2)
5667 posn = Qvertical_line;
7ee32cda 5668 else if (area == 3)
045dee35 5669 posn = Qheader_line;
4bb994d1 5670 else
a955ffa2
GM
5671 {
5672 Lisp_Object object;
5673 struct display_pos p;
5674 buffer_posn_from_coords (w, &wx, &wy, &object, &p);
5675 posn = make_number (CHARPOS (p.pos));
5676 }
4bb994d1 5677 }
e9bf89a0
RS
5678 else if (frame != 0)
5679 {
18cd2eeb 5680 XSETFRAME (window, frame);
e9bf89a0
RS
5681 posn = Qnil;
5682 }
284f4730 5683 else
4bb994d1
JB
5684 {
5685 window = Qnil;
5686 posn = Qnil;
bb9e9bed
KH
5687 XSETFASTINT (x, 0);
5688 XSETFASTINT (y, 0);
4bb994d1 5689 }
284f4730 5690
4bb994d1
JB
5691 return Fcons (Qmouse_movement,
5692 Fcons (Fcons (window,
5693 Fcons (posn,
5694 Fcons (Fcons (x, y),
5695 Fcons (make_number (time),
5696 Qnil)))),
5697 Qnil));
5698 }
284f4730
JB
5699}
5700
514354e9 5701#endif /* HAVE_MOUSE */
6cbff1cb 5702
cd21b839
JB
5703/* Construct a switch frame event. */
5704static Lisp_Object
5705make_lispy_switch_frame (frame)
5706 Lisp_Object frame;
5707{
5708 return Fcons (Qswitch_frame, Fcons (frame, Qnil));
5709}
0a7f1fc0
JB
5710\f
5711/* Manipulating modifiers. */
284f4730 5712
0a7f1fc0 5713/* Parse the name of SYMBOL, and return the set of modifiers it contains.
284f4730 5714
0a7f1fc0
JB
5715 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5716 SYMBOL's name of the end of the modifiers; the string from this
5717 position is the unmodified symbol name.
284f4730 5718
0a7f1fc0 5719 This doesn't use any caches. */
6da3dd3a 5720
0a7f1fc0
JB
5721static int
5722parse_modifiers_uncached (symbol, modifier_end)
284f4730 5723 Lisp_Object symbol;
0a7f1fc0 5724 int *modifier_end;
284f4730 5725{
1b049b51 5726 Lisp_Object name;
284f4730
JB
5727 int i;
5728 int modifiers;
284f4730 5729
b7826503 5730 CHECK_SYMBOL (symbol);
df0f2ba1 5731
284f4730 5732 modifiers = 0;
1b049b51 5733 name = SYMBOL_NAME (symbol);
284f4730 5734
1b049b51 5735 for (i = 0; i+2 <= SBYTES (name); )
6da3dd3a
RS
5736 {
5737 int this_mod_end = 0;
5738 int this_mod = 0;
284f4730 5739
6da3dd3a
RS
5740 /* See if the name continues with a modifier word.
5741 Check that the word appears, but don't check what follows it.
5742 Set this_mod and this_mod_end to record what we find. */
fce33686 5743
1b049b51 5744 switch (SREF (name, i))
6da3dd3a
RS
5745 {
5746#define SINGLE_LETTER_MOD(BIT) \
5747 (this_mod_end = i + 1, this_mod = BIT)
5748
6da3dd3a
RS
5749 case 'A':
5750 SINGLE_LETTER_MOD (alt_modifier);
5751 break;
284f4730 5752
6da3dd3a
RS
5753 case 'C':
5754 SINGLE_LETTER_MOD (ctrl_modifier);
5755 break;
284f4730 5756
6da3dd3a
RS
5757 case 'H':
5758 SINGLE_LETTER_MOD (hyper_modifier);
5759 break;
5760
6da3dd3a
RS
5761 case 'M':
5762 SINGLE_LETTER_MOD (meta_modifier);
5763 break;
5764
6da3dd3a
RS
5765 case 'S':
5766 SINGLE_LETTER_MOD (shift_modifier);
5767 break;
5768
5769 case 's':
6da3dd3a
RS
5770 SINGLE_LETTER_MOD (super_modifier);
5771 break;
5772
0a7f1fc0 5773#undef SINGLE_LETTER_MOD
6da3dd3a
RS
5774 }
5775
5776 /* If we found no modifier, stop looking for them. */
5777 if (this_mod_end == 0)
5778 break;
5779
5780 /* Check there is a dash after the modifier, so that it
5781 really is a modifier. */
1b049b51
KR
5782 if (this_mod_end >= SBYTES (name)
5783 || SREF (name, this_mod_end) != '-')
6da3dd3a
RS
5784 break;
5785
5786 /* This modifier is real; look for another. */
5787 modifiers |= this_mod;
5788 i = this_mod_end + 1;
5789 }
284f4730 5790
0a7f1fc0 5791 /* Should we include the `click' modifier? */
fbcd35bd
JB
5792 if (! (modifiers & (down_modifier | drag_modifier
5793 | double_modifier | triple_modifier))
1b049b51
KR
5794 && i + 7 == SBYTES (name)
5795 && strncmp (SDATA (name) + i, "mouse-", 6) == 0
5796 && ('0' <= SREF (name, i + 6) && SREF (name, i + 6) <= '9'))
0a7f1fc0
JB
5797 modifiers |= click_modifier;
5798
5799 if (modifier_end)
5800 *modifier_end = i;
5801
5802 return modifiers;
5803}
5804
0a7f1fc0
JB
5805/* Return a symbol whose name is the modifier prefixes for MODIFIERS
5806 prepended to the string BASE[0..BASE_LEN-1].
5807 This doesn't use any caches. */
5808static Lisp_Object
301738ed 5809apply_modifiers_uncached (modifiers, base, base_len, base_len_byte)
0a7f1fc0
JB
5810 int modifiers;
5811 char *base;
301738ed 5812 int base_len, base_len_byte;
0a7f1fc0
JB
5813{
5814 /* Since BASE could contain nulls, we can't use intern here; we have
5815 to use Fintern, which expects a genuine Lisp_String, and keeps a
5816 reference to it. */
301738ed
RS
5817 char *new_mods
5818 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
0a7f1fc0 5819 int mod_len;
284f4730 5820
284f4730 5821 {
0a7f1fc0
JB
5822 char *p = new_mods;
5823
5824 /* Only the event queue may use the `up' modifier; it should always
5825 be turned into a click or drag event before presented to lisp code. */
5826 if (modifiers & up_modifier)
5827 abort ();
5828
5829 if (modifiers & alt_modifier) { *p++ = 'A'; *p++ = '-'; }
5830 if (modifiers & ctrl_modifier) { *p++ = 'C'; *p++ = '-'; }
5831 if (modifiers & hyper_modifier) { *p++ = 'H'; *p++ = '-'; }
5832 if (modifiers & meta_modifier) { *p++ = 'M'; *p++ = '-'; }
5833 if (modifiers & shift_modifier) { *p++ = 'S'; *p++ = '-'; }
86e5706b 5834 if (modifiers & super_modifier) { *p++ = 's'; *p++ = '-'; }
fbcd35bd
JB
5835 if (modifiers & double_modifier) { strcpy (p, "double-"); p += 7; }
5836 if (modifiers & triple_modifier) { strcpy (p, "triple-"); p += 7; }
559f9d04
RS
5837 if (modifiers & down_modifier) { strcpy (p, "down-"); p += 5; }
5838 if (modifiers & drag_modifier) { strcpy (p, "drag-"); p += 5; }
0a7f1fc0
JB
5839 /* The click modifier is denoted by the absence of other modifiers. */
5840
5841 *p = '\0';
5842
5843 mod_len = p - new_mods;
5844 }
284f4730 5845
0a7f1fc0 5846 {
9b8eb840 5847 Lisp_Object new_name;
df0f2ba1 5848
301738ed
RS
5849 new_name = make_uninit_multibyte_string (mod_len + base_len,
5850 mod_len + base_len_byte);
d5db4077
KR
5851 bcopy (new_mods, SDATA (new_name), mod_len);
5852 bcopy (base, SDATA (new_name) + mod_len, base_len_byte);
284f4730
JB
5853
5854 return Fintern (new_name, Qnil);
5855 }
5856}
5857
5858
0a7f1fc0
JB
5859static char *modifier_names[] =
5860{
fbcd35bd 5861 "up", "down", "drag", "click", "double", "triple", 0, 0,
f335fabe 5862 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
86e5706b 5863 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
0a7f1fc0 5864};
80645119 5865#define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
0a7f1fc0
JB
5866
5867static Lisp_Object modifier_symbols;
5868
5869/* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5870static Lisp_Object
5871lispy_modifier_list (modifiers)
5872 int modifiers;
5873{
5874 Lisp_Object modifier_list;
5875 int i;
5876
5877 modifier_list = Qnil;
80645119 5878 for (i = 0; (1<<i) <= modifiers && i < NUM_MOD_NAMES; i++)
0a7f1fc0 5879 if (modifiers & (1<<i))
80645119
JB
5880 modifier_list = Fcons (XVECTOR (modifier_symbols)->contents[i],
5881 modifier_list);
0a7f1fc0
JB
5882
5883 return modifier_list;
5884}
5885
5886
5887/* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
5888 where UNMODIFIED is the unmodified form of SYMBOL,
5889 MASK is the set of modifiers present in SYMBOL's name.
5890 This is similar to parse_modifiers_uncached, but uses the cache in
5891 SYMBOL's Qevent_symbol_element_mask property, and maintains the
5892 Qevent_symbol_elements property. */
3d31316f 5893
1161d367 5894Lisp_Object
0a7f1fc0
JB
5895parse_modifiers (symbol)
5896 Lisp_Object symbol;
5897{
9b8eb840 5898 Lisp_Object elements;
0a7f1fc0 5899
9b8eb840 5900 elements = Fget (symbol, Qevent_symbol_element_mask);
0a7f1fc0
JB
5901 if (CONSP (elements))
5902 return elements;
5903 else
5904 {
5905 int end;
ec0faad2 5906 int modifiers = parse_modifiers_uncached (symbol, &end);
9b8eb840 5907 Lisp_Object unmodified;
0a7f1fc0
JB
5908 Lisp_Object mask;
5909
d5db4077
KR
5910 unmodified = Fintern (make_string (SDATA (SYMBOL_NAME (symbol)) + end,
5911 SBYTES (SYMBOL_NAME (symbol)) - end),
9b8eb840
KH
5912 Qnil);
5913
c4aeb9d8 5914 if (modifiers & ~VALMASK)
734fef94 5915 abort ();
bb9e9bed 5916 XSETFASTINT (mask, modifiers);
0a7f1fc0
JB
5917 elements = Fcons (unmodified, Fcons (mask, Qnil));
5918
5919 /* Cache the parsing results on SYMBOL. */
5920 Fput (symbol, Qevent_symbol_element_mask,
5921 elements);
5922 Fput (symbol, Qevent_symbol_elements,
5923 Fcons (unmodified, lispy_modifier_list (modifiers)));
5924
5925 /* Since we know that SYMBOL is modifiers applied to unmodified,
5926 it would be nice to put that in unmodified's cache.
5927 But we can't, since we're not sure that parse_modifiers is
5928 canonical. */
5929
5930 return elements;
5931 }
5932}
5933
5934/* Apply the modifiers MODIFIERS to the symbol BASE.
5935 BASE must be unmodified.
5936
5937 This is like apply_modifiers_uncached, but uses BASE's
5938 Qmodifier_cache property, if present. It also builds
cd21b839
JB
5939 Qevent_symbol_elements properties, since it has that info anyway.
5940
5941 apply_modifiers copies the value of BASE's Qevent_kind property to
5942 the modified symbol. */
0a7f1fc0
JB
5943static Lisp_Object
5944apply_modifiers (modifiers, base)
5945 int modifiers;
5946 Lisp_Object base;
5947{
7b4aedb9 5948 Lisp_Object cache, index, entry, new_symbol;
0a7f1fc0 5949
80645119 5950 /* Mask out upper bits. We don't know where this value's been. */
c4aeb9d8 5951 modifiers &= VALMASK;
80645119 5952
0a7f1fc0 5953 /* The click modifier never figures into cache indices. */
0a7f1fc0 5954 cache = Fget (base, Qmodifier_cache);
bb9e9bed 5955 XSETFASTINT (index, (modifiers & ~click_modifier));
697e4895 5956 entry = assq_no_quit (index, cache);
0a7f1fc0
JB
5957
5958 if (CONSP (entry))
7539e11f 5959 new_symbol = XCDR (entry);
7b4aedb9
JB
5960 else
5961 {
df0f2ba1 5962 /* We have to create the symbol ourselves. */
7b4aedb9 5963 new_symbol = apply_modifiers_uncached (modifiers,
d5db4077
KR
5964 SDATA (SYMBOL_NAME (base)),
5965 SCHARS (SYMBOL_NAME (base)),
5966 SBYTES (SYMBOL_NAME (base)));
7b4aedb9
JB
5967
5968 /* Add the new symbol to the base's cache. */
5969 entry = Fcons (index, new_symbol);
5970 Fput (base, Qmodifier_cache, Fcons (entry, cache));
5971
5972 /* We have the parsing info now for free, so add it to the caches. */
bb9e9bed 5973 XSETFASTINT (index, modifiers);
7b4aedb9
JB
5974 Fput (new_symbol, Qevent_symbol_element_mask,
5975 Fcons (base, Fcons (index, Qnil)));
5976 Fput (new_symbol, Qevent_symbol_elements,
5977 Fcons (base, lispy_modifier_list (modifiers)));
5978 }
0a7f1fc0 5979
df0f2ba1 5980 /* Make sure this symbol is of the same kind as BASE.
7b4aedb9
JB
5981
5982 You'd think we could just set this once and for all when we
5983 intern the symbol above, but reorder_modifiers may call us when
5984 BASE's property isn't set right; we can't assume that just
80645119
JB
5985 because it has a Qmodifier_cache property it must have its
5986 Qevent_kind set right as well. */
7b4aedb9
JB
5987 if (NILP (Fget (new_symbol, Qevent_kind)))
5988 {
9b8eb840 5989 Lisp_Object kind;
7b4aedb9 5990
9b8eb840 5991 kind = Fget (base, Qevent_kind);
7b4aedb9
JB
5992 if (! NILP (kind))
5993 Fput (new_symbol, Qevent_kind, kind);
5994 }
5995
5996 return new_symbol;
0a7f1fc0
JB
5997}
5998
5999
6000/* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6001 return a symbol with the modifiers placed in the canonical order.
6002 Canonical order is alphabetical, except for down and drag, which
6003 always come last. The 'click' modifier is never written out.
6004
6005 Fdefine_key calls this to make sure that (for example) C-M-foo
6006 and M-C-foo end up being equivalent in the keymap. */
6007
6008Lisp_Object
6009reorder_modifiers (symbol)
6010 Lisp_Object symbol;
6011{
6012 /* It's hopefully okay to write the code this way, since everything
6013 will soon be in caches, and no consing will be done at all. */
9b8eb840 6014 Lisp_Object parsed;
0a7f1fc0 6015
9b8eb840 6016 parsed = parse_modifiers (symbol);
7539e11f
KR
6017 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed))),
6018 XCAR (parsed));
0a7f1fc0
JB
6019}
6020
6021
284f4730
JB
6022/* For handling events, we often want to produce a symbol whose name
6023 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6024 to some base, like the name of a function key or mouse button.
6025 modify_event_symbol produces symbols of this sort.
6026
6027 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6028 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6029 in the table.
6030
8e1e4240
GM
6031 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6032 into symbol names, or a string specifying a name stem used to
a50e723f 6033 construct a symbol name or the form `STEM-N', where N is the decimal
8e1e4240
GM
6034 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6035 non-nil; otherwise NAME_TABLE is used.
80e4aa30 6036
284f4730
JB
6037 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6038 persist between calls to modify_event_symbol that it can use to
6039 store a cache of the symbols it's generated for this NAME_TABLE
80e4aa30 6040 before. The object stored there may be a vector or an alist.
284f4730
JB
6041
6042 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
df0f2ba1 6043
284f4730
JB
6044 MODIFIERS is a set of modifier bits (as given in struct input_events)
6045 whose prefixes should be applied to the symbol name.
6046
6047 SYMBOL_KIND is the value to be placed in the event_kind property of
df0f2ba1 6048 the returned symbol.
88cb0656
JB
6049
6050 The symbols we create are supposed to have an
eb8c3be9 6051 `event-symbol-elements' property, which lists the modifiers present
88cb0656
JB
6052 in the symbol's name. */
6053
284f4730 6054static Lisp_Object
8e1e4240 6055modify_event_symbol (symbol_num, modifiers, symbol_kind, name_alist_or_stem,
80e4aa30 6056 name_table, symbol_table, table_size)
284f4730
JB
6057 int symbol_num;
6058 unsigned modifiers;
6059 Lisp_Object symbol_kind;
8e1e4240 6060 Lisp_Object name_alist_or_stem;
284f4730
JB
6061 char **name_table;
6062 Lisp_Object *symbol_table;
2c834fb3 6063 unsigned int table_size;
284f4730 6064{
80e4aa30
RS
6065 Lisp_Object value;
6066 Lisp_Object symbol_int;
6067
2c834fb3
KH
6068 /* Get rid of the "vendor-specific" bit here. */
6069 XSETINT (symbol_int, symbol_num & 0xffffff);
284f4730
JB
6070
6071 /* Is this a request for a valid symbol? */
88cb0656 6072 if (symbol_num < 0 || symbol_num >= table_size)
0c2611c5 6073 return Qnil;
284f4730 6074
80e4aa30
RS
6075 if (CONSP (*symbol_table))
6076 value = Fcdr (assq_no_quit (symbol_int, *symbol_table));
6077
0a7f1fc0 6078 /* If *symbol_table doesn't seem to be initialized properly, fix that.
88cb0656 6079 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4bb994d1
JB
6080 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6081 we've never used that symbol before. */
80e4aa30 6082 else
88cb0656 6083 {
80e4aa30
RS
6084 if (! VECTORP (*symbol_table)
6085 || XVECTOR (*symbol_table)->size != table_size)
6086 {
6087 Lisp_Object size;
0a7f1fc0 6088
bb9e9bed 6089 XSETFASTINT (size, table_size);
80e4aa30
RS
6090 *symbol_table = Fmake_vector (size, Qnil);
6091 }
284f4730 6092
80e4aa30
RS
6093 value = XVECTOR (*symbol_table)->contents[symbol_num];
6094 }
284f4730 6095
0a7f1fc0 6096 /* Have we already used this symbol before? */
80e4aa30 6097 if (NILP (value))
284f4730 6098 {
0a7f1fc0 6099 /* No; let's create it. */
8e1e4240
GM
6100 if (CONSP (name_alist_or_stem))
6101 value = Fcdr_safe (Fassq (symbol_int, name_alist_or_stem));
6102 else if (STRINGP (name_alist_or_stem))
6103 {
d5db4077 6104 int len = SBYTES (name_alist_or_stem);
8e1e4240 6105 char *buf = (char *) alloca (len + 50);
ed3230db
DL
6106 if (sizeof (int) == sizeof (EMACS_INT))
6107 sprintf (buf, "%s-%d", SDATA (name_alist_or_stem),
6108 XINT (symbol_int) + 1);
6109 else if (sizeof (long) == sizeof (EMACS_INT))
6110 sprintf (buf, "%s-%ld", SDATA (name_alist_or_stem),
6111 XINT (symbol_int) + 1);
8e1e4240
GM
6112 value = intern (buf);
6113 }
2ff6714d 6114 else if (name_table != 0 && name_table[symbol_num])
80e4aa30 6115 value = intern (name_table[symbol_num]);
b64b4075 6116
e98a93eb 6117#ifdef HAVE_WINDOW_SYSTEM
2c834fb3
KH
6118 if (NILP (value))
6119 {
6120 char *name = x_get_keysym_name (symbol_num);
6121 if (name)
6122 value = intern (name);
6123 }
6124#endif
6125
b64b4075 6126 if (NILP (value))
d1f50460
RS
6127 {
6128 char buf[20];
6129 sprintf (buf, "key-%d", symbol_num);
80e4aa30 6130 value = intern (buf);
d1f50460 6131 }
0a7f1fc0 6132
80e4aa30 6133 if (CONSP (*symbol_table))
4205cb08 6134 *symbol_table = Fcons (Fcons (symbol_int, value), *symbol_table);
80e4aa30
RS
6135 else
6136 XVECTOR (*symbol_table)->contents[symbol_num] = value;
6137
df0f2ba1 6138 /* Fill in the cache entries for this symbol; this also
0a7f1fc0
JB
6139 builds the Qevent_symbol_elements property, which the user
6140 cares about. */
80e4aa30
RS
6141 apply_modifiers (modifiers & click_modifier, value);
6142 Fput (value, Qevent_kind, symbol_kind);
284f4730 6143 }
88cb0656 6144
0a7f1fc0 6145 /* Apply modifiers to that symbol. */
80e4aa30 6146 return apply_modifiers (modifiers, value);
284f4730 6147}
6da3dd3a
RS
6148\f
6149/* Convert a list that represents an event type,
6150 such as (ctrl meta backspace), into the usual representation of that
6151 event type as a number or a symbol. */
6152
a1706c30 6153DEFUN ("event-convert-list", Fevent_convert_list, Sevent_convert_list, 1, 1, 0,
4707d2d0
PJ
6154 doc: /* Convert the event description list EVENT-DESC to an event type.
6155EVENT-DESC should contain one base event type (a character or symbol)
6156and zero or more modifier names (control, meta, hyper, super, shift, alt,
6157drag, down, double or triple). The base must be last.
6158The return value is an event type (a character or symbol) which
6159has the same base event type and all the specified modifiers. */)
6160 (event_desc)
e57d8fd8 6161 Lisp_Object event_desc;
6da3dd3a
RS
6162{
6163 Lisp_Object base;
6164 int modifiers = 0;
6165 Lisp_Object rest;
6166
6167 base = Qnil;
e57d8fd8 6168 rest = event_desc;
6da3dd3a
RS
6169 while (CONSP (rest))
6170 {
6171 Lisp_Object elt;
6172 int this = 0;
6173
7539e11f
KR
6174 elt = XCAR (rest);
6175 rest = XCDR (rest);
6da3dd3a 6176
3d31316f 6177 /* Given a symbol, see if it is a modifier name. */
377f24f5 6178 if (SYMBOLP (elt) && CONSP (rest))
3d31316f 6179 this = parse_solitary_modifier (elt);
6da3dd3a
RS
6180
6181 if (this != 0)
6182 modifiers |= this;
6183 else if (!NILP (base))
6184 error ("Two bases given in one event");
6185 else
6186 base = elt;
6187
6da3dd3a
RS
6188 }
6189
3d31316f 6190 /* Let the symbol A refer to the character A. */
d5db4077 6191 if (SYMBOLP (base) && SCHARS (SYMBOL_NAME (base)) == 1)
4069e0f8 6192 XSETINT (base, SREF (SYMBOL_NAME (base), 0));
3d31316f 6193
6da3dd3a
RS
6194 if (INTEGERP (base))
6195 {
3d31316f
RS
6196 /* Turn (shift a) into A. */
6197 if ((modifiers & shift_modifier) != 0
6198 && (XINT (base) >= 'a' && XINT (base) <= 'z'))
6199 {
6200 XSETINT (base, XINT (base) - ('a' - 'A'));
6201 modifiers &= ~shift_modifier;
6202 }
6203
6204 /* Turn (control a) into C-a. */
6da3dd3a 6205 if (modifiers & ctrl_modifier)
3d31316f 6206 return make_number ((modifiers & ~ctrl_modifier)
6da3dd3a
RS
6207 | make_ctrl_char (XINT (base)));
6208 else
6209 return make_number (modifiers | XINT (base));
6210 }
6211 else if (SYMBOLP (base))
6212 return apply_modifiers (modifiers, base);
6213 else
8c907a56
GM
6214 {
6215 error ("Invalid base event");
6216 return Qnil;
6217 }
6da3dd3a
RS
6218}
6219
3d31316f
RS
6220/* Try to recognize SYMBOL as a modifier name.
6221 Return the modifier flag bit, or 0 if not recognized. */
6222
6223static int
6224parse_solitary_modifier (symbol)
6225 Lisp_Object symbol;
6226{
1b049b51 6227 Lisp_Object name = SYMBOL_NAME (symbol);
3d31316f 6228
1b049b51 6229 switch (SREF (name, 0))
3d31316f
RS
6230 {
6231#define SINGLE_LETTER_MOD(BIT) \
1b049b51 6232 if (SBYTES (name) == 1) \
3d31316f
RS
6233 return BIT;
6234
6235#define MULTI_LETTER_MOD(BIT, NAME, LEN) \
1b049b51
KR
6236 if (LEN == SBYTES (name) \
6237 && ! strncmp (SDATA (name), NAME, LEN)) \
3d31316f
RS
6238 return BIT;
6239
6240 case 'A':
6241 SINGLE_LETTER_MOD (alt_modifier);
6242 break;
6243
6244 case 'a':
6245 MULTI_LETTER_MOD (alt_modifier, "alt", 3);
6246 break;
6247
6248 case 'C':
6249 SINGLE_LETTER_MOD (ctrl_modifier);
6250 break;
6251
6252 case 'c':
6253 MULTI_LETTER_MOD (ctrl_modifier, "ctrl", 4);
6254 MULTI_LETTER_MOD (ctrl_modifier, "control", 7);
6255 break;
6256
6257 case 'H':
6258 SINGLE_LETTER_MOD (hyper_modifier);
6259 break;
6260
6261 case 'h':
6262 MULTI_LETTER_MOD (hyper_modifier, "hyper", 5);
6263 break;
6264
6265 case 'M':
6266 SINGLE_LETTER_MOD (meta_modifier);
6267 break;
6268
6269 case 'm':
6270 MULTI_LETTER_MOD (meta_modifier, "meta", 4);
6271 break;
6272
6273 case 'S':
6274 SINGLE_LETTER_MOD (shift_modifier);
6275 break;
6276
6277 case 's':
6278 MULTI_LETTER_MOD (shift_modifier, "shift", 5);
6279 MULTI_LETTER_MOD (super_modifier, "super", 5);
6280 SINGLE_LETTER_MOD (super_modifier);
6281 break;
6282
6283 case 'd':
6284 MULTI_LETTER_MOD (drag_modifier, "drag", 4);
6285 MULTI_LETTER_MOD (down_modifier, "down", 4);
6286 MULTI_LETTER_MOD (double_modifier, "double", 6);
6287 break;
6288
6289 case 't':
6290 MULTI_LETTER_MOD (triple_modifier, "triple", 6);
6291 break;
6292
6293#undef SINGLE_LETTER_MOD
6294#undef MULTI_LETTER_MOD
6295 }
6296
6297 return 0;
6298}
6299
6da3dd3a
RS
6300/* Return 1 if EVENT is a list whose elements are all integers or symbols.
6301 Such a list is not valid as an event,
6302 but it can be a Lucid-style event type list. */
6303
6304int
6305lucid_event_type_list_p (object)
6306 Lisp_Object object;
6307{
6308 Lisp_Object tail;
6309
6310 if (! CONSP (object))
6311 return 0;
902ae620
GM
6312
6313 if (EQ (XCAR (object), Qhelp_echo)
6314 || EQ (XCAR (object), Qvertical_line)
6315 || EQ (XCAR (object), Qmode_line)
6316 || EQ (XCAR (object), Qheader_line))
6317 return 0;
6da3dd3a 6318
7539e11f 6319 for (tail = object; CONSP (tail); tail = XCDR (tail))
6da3dd3a
RS
6320 {
6321 Lisp_Object elt;
7539e11f 6322 elt = XCAR (tail);
6da3dd3a
RS
6323 if (! (INTEGERP (elt) || SYMBOLP (elt)))
6324 return 0;
6325 }
6326
6327 return NILP (tail);
6328}
284f4730 6329\f
284f4730
JB
6330/* Store into *addr a value nonzero if terminal input chars are available.
6331 Serves the purpose of ioctl (0, FIONREAD, addr)
6332 but works even if FIONREAD does not exist.
d9d4c147
KH
6333 (In fact, this may actually read some input.)
6334
20057d52
JD
6335 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6336 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
284f4730
JB
6337
6338static void
20057d52 6339get_filtered_input_pending (addr, do_timers_now, filter_events)
284f4730 6340 int *addr;
d9d4c147 6341 int do_timers_now;
20057d52 6342 int filter_events;
284f4730
JB
6343{
6344 /* First of all, have we already counted some input? */
20057d52
JD
6345 *addr = (!NILP (Vquit_flag)
6346 || readable_filtered_events (do_timers_now, filter_events));
284f4730
JB
6347
6348 /* If input is being read as it arrives, and we have none, there is none. */
6349 if (*addr > 0 || (interrupt_input && ! interrupts_deferred))
6350 return;
6351
6352 /* Try to read some input and see how much we get. */
6353 gobble_input (0);
20057d52
JD
6354 *addr = (!NILP (Vquit_flag)
6355 || readable_filtered_events (do_timers_now, filter_events));
6356}
6357
6358/* Store into *addr a value nonzero if terminal input chars are available.
6359 Serves the purpose of ioctl (0, FIONREAD, addr)
6360 but works even if FIONREAD does not exist.
6361 (In fact, this may actually read some input.)
6362
6363 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6364
6365static void
6366get_input_pending (addr, do_timers_now)
6367 int *addr;
6368 int do_timers_now;
6369{
6370 get_filtered_input_pending (addr, do_timers_now, 0);
284f4730
JB
6371}
6372
81931ba1 6373/* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
284f4730 6374
07a59269 6375void
284f4730
JB
6376gobble_input (expected)
6377 int expected;
6378{
6379#ifndef VMS
6380#ifdef SIGIO
6381 if (interrupt_input)
6382 {
32676c08 6383 SIGMASKTYPE mask;
4f8aaa74 6384 mask = sigblock (sigmask (SIGIO));
284f4730 6385 read_avail_input (expected);
e065a56e 6386 sigsetmask (mask);
284f4730
JB
6387 }
6388 else
81931ba1
RS
6389#ifdef POLL_FOR_INPUT
6390 if (read_socket_hook && !interrupt_input && poll_suppress_count == 0)
6391 {
6392 SIGMASKTYPE mask;
4f8aaa74 6393 mask = sigblock (sigmask (SIGALRM));
81931ba1
RS
6394 read_avail_input (expected);
6395 sigsetmask (mask);
6396 }
6397 else
87485d6f 6398#endif
284f4730
JB
6399#endif
6400 read_avail_input (expected);
6401#endif
6402}
a8015ab5 6403
3b8f9651 6404/* Put a BUFFER_SWITCH_EVENT in the buffer
241ceaf7
RS
6405 so that read_key_sequence will notice the new current buffer. */
6406
07a59269 6407void
a8015ab5
KH
6408record_asynch_buffer_change ()
6409{
6410 struct input_event event;
a30f0615
RS
6411 Lisp_Object tem;
6412
3b8f9651 6413 event.kind = BUFFER_SWITCH_EVENT;
a8015ab5 6414 event.frame_or_window = Qnil;
da8f7368 6415 event.arg = Qnil;
241ceaf7 6416
f65e6f7d 6417#ifdef subprocesses
a30f0615
RS
6418 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6419 The purpose of the event is to make read_key_sequence look up the
6420 keymaps again. If we aren't in read_key_sequence, we don't need one,
6421 and the event could cause trouble by messing up (input-pending-p). */
6422 tem = Fwaiting_for_user_input_p ();
6423 if (NILP (tem))
6424 return;
f65e6f7d
RS
6425#else
6426 /* We never need these events if we have no asynchronous subprocesses. */
6427 return;
6428#endif
a30f0615 6429
241ceaf7
RS
6430 /* Make sure no interrupt happens while storing the event. */
6431#ifdef SIGIO
6432 if (interrupt_input)
6433 {
6434 SIGMASKTYPE mask;
4f8aaa74 6435 mask = sigblock (sigmask (SIGIO));
241ceaf7
RS
6436 kbd_buffer_store_event (&event);
6437 sigsetmask (mask);
6438 }
6439 else
6440#endif
6441 {
6442 stop_polling ();
6443 kbd_buffer_store_event (&event);
6444 start_polling ();
6445 }
a8015ab5 6446}
284f4730
JB
6447\f
6448#ifndef VMS
6449
6450/* Read any terminal input already buffered up by the system
6451 into the kbd_buffer, but do not wait.
6452
6453 EXPECTED should be nonzero if the caller knows there is some input.
6454
6455 Except on VMS, all input is read by this function.
6456 If interrupt_input is nonzero, this function MUST be called
6457 only when SIGIO is blocked.
6458
6459 Returns the number of keyboard chars read, or -1 meaning
6460 this is a bad time to try to read input. */
6461
6462static int
6463read_avail_input (expected)
6464 int expected;
6465{
6466 struct input_event buf[KBD_BUFFER_SIZE];
6467 register int i;
6468 int nread;
6469
6470 if (read_socket_hook)
6471 /* No need for FIONREAD or fcntl; just say don't wait. */
33e19c6e 6472 nread = (*read_socket_hook) (input_fd, buf, KBD_BUFFER_SIZE, expected);
284f4730
JB
6473 else
6474 {
17270835
RS
6475 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6476 the kbd_buffer can really hold. That may prevent loss
6477 of characters on some systems when input is stuffed at us. */
6478 unsigned char cbuf[KBD_BUFFER_SIZE - 1];
58788063 6479 int n_to_read;
284f4730 6480
58788063 6481 /* Determine how many characters we should *try* to read. */
bc536d84
RS
6482#ifdef WINDOWSNT
6483 return 0;
6484#else /* not WINDOWSNT */
80e4aa30 6485#ifdef MSDOS
58788063
RS
6486 n_to_read = dos_keysns ();
6487 if (n_to_read == 0)
6488 return 0;
c3a2738c 6489#else /* not MSDOS */
284f4730
JB
6490#ifdef FIONREAD
6491 /* Find out how much input is available. */
437f6112 6492 if (ioctl (input_fd, FIONREAD, &n_to_read) < 0)
284f4730
JB
6493 /* Formerly simply reported no input, but that sometimes led to
6494 a failure of Emacs to terminate.
6495 SIGHUP seems appropriate if we can't reach the terminal. */
e4535288
RS
6496 /* ??? Is it really right to send the signal just to this process
6497 rather than to the whole process group?
6498 Perhaps on systems with FIONREAD Emacs is alone in its group. */
284f4730 6499 kill (getpid (), SIGHUP);
58788063 6500 if (n_to_read == 0)
284f4730 6501 return 0;
58788063
RS
6502 if (n_to_read > sizeof cbuf)
6503 n_to_read = sizeof cbuf;
284f4730 6504#else /* no FIONREAD */
0c04a67e 6505#if defined (USG) || defined (DGUX)
284f4730 6506 /* Read some input if available, but don't wait. */
58788063 6507 n_to_read = sizeof cbuf;
437f6112 6508 fcntl (input_fd, F_SETFL, O_NDELAY);
284f4730
JB
6509#else
6510 you lose;
6511#endif
6512#endif
80e4aa30 6513#endif /* not MSDOS */
bc536d84 6514#endif /* not WINDOWSNT */
284f4730 6515
58788063
RS
6516 /* Now read; for one reason or another, this will not block.
6517 NREAD is set to the number of chars read. */
9134775b 6518 do
284f4730 6519 {
80e4aa30 6520#ifdef MSDOS
0c04a67e 6521 cbuf[0] = dos_keyread ();
80e4aa30
RS
6522 nread = 1;
6523#else
68c45bf0 6524 nread = emacs_read (input_fd, cbuf, n_to_read);
80e4aa30 6525#endif
49854566
RS
6526 /* POSIX infers that processes which are not in the session leader's
6527 process group won't get SIGHUP's at logout time. BSDI adheres to
e8886a1d 6528 this part standard and returns -1 from read (0) with errno==EIO
49854566
RS
6529 when the control tty is taken away.
6530 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6531 if (nread == -1 && errno == EIO)
6532 kill (0, SIGHUP);
762f2b92 6533#if defined (AIX) && (! defined (aix386) && defined (_BSD))
284f4730
JB
6534 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6535 This looks incorrect, but it isn't, because _BSD causes
6536 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6537 and that causes a value other than 0 when there is no input. */
854f3a54 6538 if (nread == 0)
80e4aa30 6539 kill (0, SIGHUP);
284f4730 6540#endif
9134775b 6541 }
791587ee
KH
6542 while (
6543 /* We used to retry the read if it was interrupted.
6544 But this does the wrong thing when O_NDELAY causes
6545 an EAGAIN error. Does anybody know of a situation
6546 where a retry is actually needed? */
6547#if 0
6548 nread < 0 && (errno == EAGAIN
6aec06f5 6549#ifdef EFAULT
9134775b 6550 || errno == EFAULT
80e4aa30 6551#endif
284f4730 6552#ifdef EBADSLT
9134775b 6553 || errno == EBADSLT
284f4730 6554#endif
791587ee
KH
6555 )
6556#else
6557 0
6558#endif
6559 );
284f4730
JB
6560
6561#ifndef FIONREAD
02c2c53f 6562#if defined (USG) || defined (DGUX)
437f6112 6563 fcntl (input_fd, F_SETFL, 0);
02c2c53f 6564#endif /* USG or DGUX */
284f4730
JB
6565#endif /* no FIONREAD */
6566 for (i = 0; i < nread; i++)
6567 {
3b8f9651 6568 buf[i].kind = ASCII_KEYSTROKE_EVENT;
86e5706b 6569 buf[i].modifiers = 0;
b04904fb 6570 if (meta_key == 1 && (cbuf[i] & 0x80))
86e5706b 6571 buf[i].modifiers = meta_modifier;
b04904fb
RS
6572 if (meta_key != 2)
6573 cbuf[i] &= ~0x80;
f3e59d5e
KH
6574
6575 buf[i].code = cbuf[i];
788f89eb 6576 buf[i].frame_or_window = selected_frame;
da8f7368 6577 buf[i].arg = Qnil;
284f4730
JB
6578 }
6579 }
6580
6581 /* Scan the chars for C-g and store them in kbd_buffer. */
6582 for (i = 0; i < nread; i++)
6583 {
6584 kbd_buffer_store_event (&buf[i]);
6585 /* Don't look at input that follows a C-g too closely.
6586 This reduces lossage due to autorepeat on C-g. */
3b8f9651 6587 if (buf[i].kind == ASCII_KEYSTROKE_EVENT
9343ab07 6588 && buf[i].code == quit_char)
284f4730
JB
6589 break;
6590 }
6591
6592 return nread;
6593}
6594#endif /* not VMS */
6595\f
6596#ifdef SIGIO /* for entire page */
6597/* Note SIGIO has been undef'd if FIONREAD is missing. */
6598
2ce30ea2 6599SIGTYPE
284f4730
JB
6600input_available_signal (signo)
6601 int signo;
6602{
6603 /* Must preserve main program's value of errno. */
6604 int old_errno = errno;
6605#ifdef BSD4_1
6606 extern int select_alarmed;
6607#endif
6608
5970a8cb 6609#if defined (USG) && !defined (POSIX_SIGNALS)
284f4730
JB
6610 /* USG systems forget handlers when they are used;
6611 must reestablish each time */
6612 signal (signo, input_available_signal);
6613#endif /* USG */
6614
6615#ifdef BSD4_1
6616 sigisheld (SIGIO);
6617#endif
6618
ffd56f97
JB
6619 if (input_available_clear_time)
6620 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
284f4730
JB
6621
6622 while (1)
6623 {
6624 int nread;
6625 nread = read_avail_input (1);
6626 /* -1 means it's not ok to read the input now.
6627 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6628 0 means there was no keyboard input available. */
6629 if (nread <= 0)
6630 break;
6631
6632#ifdef BSD4_1
6633 select_alarmed = 1; /* Force the select emulator back to life */
6634#endif
6635 }
6636
6637#ifdef BSD4_1
6638 sigfree ();
6639#endif
6640 errno = old_errno;
6641}
6642#endif /* SIGIO */
ad163903
JB
6643
6644/* Send ourselves a SIGIO.
6645
6646 This function exists so that the UNBLOCK_INPUT macro in
6647 blockinput.h can have some way to take care of input we put off
6648 dealing with, without assuming that every file which uses
6649 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6650void
6651reinvoke_input_signal ()
6652{
df0f2ba1 6653#ifdef SIGIO
87dd9b9b 6654 kill (getpid (), SIGIO);
ad163903
JB
6655#endif
6656}
6657
6658
284f4730 6659\f
25126faa
GM
6660static void menu_bar_item P_ ((Lisp_Object, Lisp_Object));
6661static void menu_bar_one_keymap P_ ((Lisp_Object));
b7c49376
RS
6662
6663/* These variables hold the vector under construction within
6664 menu_bar_items and its subroutines, and the current index
6665 for storing into that vector. */
6666static Lisp_Object menu_bar_items_vector;
9343ab07 6667static int menu_bar_items_index;
5ec75a55 6668
b7c49376
RS
6669/* Return a vector of menu items for a menu bar, appropriate
6670 to the current buffer. Each item has three elements in the vector:
f5e09c8b 6671 KEY STRING MAPLIST.
b7c49376
RS
6672
6673 OLD is an old vector we can optionally reuse, or nil. */
5ec75a55
RS
6674
6675Lisp_Object
b7c49376
RS
6676menu_bar_items (old)
6677 Lisp_Object old;
5ec75a55
RS
6678{
6679 /* The number of keymaps we're scanning right now, and the number of
6680 keymaps we have allocated space for. */
6681 int nmaps;
6682
6683 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6684 in the current keymaps, or nil where it is not a prefix. */
6685 Lisp_Object *maps;
6686
aebfea68 6687 Lisp_Object def, tail;
5ec75a55
RS
6688
6689 Lisp_Object result;
6690
6691 int mapno;
47d319aa 6692 Lisp_Object oquit;
5ec75a55 6693
b7c49376
RS
6694 int i;
6695
6696 struct gcpro gcpro1;
6697
db60d856
JB
6698 /* In order to build the menus, we need to call the keymap
6699 accessors. They all call QUIT. But this function is called
6700 during redisplay, during which a quit is fatal. So inhibit
47d319aa
RS
6701 quitting while building the menus.
6702 We do this instead of specbind because (1) errors will clear it anyway
6703 and (2) this avoids risk of specpdl overflow. */
6704 oquit = Vinhibit_quit;
df0f2ba1 6705 Vinhibit_quit = Qt;
db60d856 6706
b7c49376
RS
6707 if (!NILP (old))
6708 menu_bar_items_vector = old;
6709 else
6710 menu_bar_items_vector = Fmake_vector (make_number (24), Qnil);
6711 menu_bar_items_index = 0;
6712
6713 GCPRO1 (menu_bar_items_vector);
6714
5ec75a55
RS
6715 /* Build our list of keymaps.
6716 If we recognize a function key and replace its escape sequence in
6717 keybuf with its symbol, or if the sequence starts with a mouse
6718 click and we need to switch buffers, we jump back here to rebuild
6719 the initial keymaps from the current buffer. */
df0f2ba1 6720 {
5ec75a55
RS
6721 Lisp_Object *tmaps;
6722
217258d5 6723 /* Should overriding-terminal-local-map and overriding-local-map apply? */
d0a49716 6724 if (!NILP (Voverriding_local_map_menu_flag))
9dd3131c 6725 {
217258d5
KH
6726 /* Yes, use them (if non-nil) as well as the global map. */
6727 maps = (Lisp_Object *) alloca (3 * sizeof (maps[0]));
6728 nmaps = 0;
6729 if (!NILP (current_kboard->Voverriding_terminal_local_map))
6730 maps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
6731 if (!NILP (Voverriding_local_map))
6732 maps[nmaps++] = Voverriding_local_map;
9dd3131c
RS
6733 }
6734 else
6735 {
fd646341
KS
6736 /* No, so use major and minor mode keymaps and keymap property.
6737 Note that menu-bar bindings in the local-map and keymap
6738 properties may not work reliable, as they are only
6739 recognized when the menu-bar (or mode-line) is updated,
6740 which does not normally happen after every command. */
6741 Lisp_Object tem;
6742 int nminor;
6743 nminor = current_minor_maps (NULL, &tmaps);
6744 maps = (Lisp_Object *) alloca ((nminor + 3) * sizeof (maps[0]));
6745 nmaps = 0;
6746 if (tem = get_local_map (PT, current_buffer, Qkeymap), !NILP (tem))
6747 maps[nmaps++] = tem;
6748 bcopy (tmaps, (void *) (maps + nmaps), nminor * sizeof (maps[0]));
6749 nmaps += nminor;
6750 maps[nmaps++] = get_local_map (PT, current_buffer, Qlocal_map);
9dd3131c 6751 }
217258d5 6752 maps[nmaps++] = current_global_map;
5ec75a55
RS
6753 }
6754
6755 /* Look up in each map the dummy prefix key `menu-bar'. */
6756
6757 result = Qnil;
6758
e58aa385 6759 for (mapno = nmaps - 1; mapno >= 0; mapno--)
25126faa
GM
6760 if (!NILP (maps[mapno]))
6761 {
341a09cf
SM
6762 def = get_keymap (access_keymap (maps[mapno], Qmenu_bar, 1, 0, 1),
6763 0, 1);
02067692 6764 if (CONSP (def))
25126faa
GM
6765 menu_bar_one_keymap (def);
6766 }
5ec75a55 6767
b7c49376
RS
6768 /* Move to the end those items that should be at the end. */
6769
7539e11f 6770 for (tail = Vmenu_bar_final_items; CONSP (tail); tail = XCDR (tail))
9f9c0e27 6771 {
b7c49376
RS
6772 int i;
6773 int end = menu_bar_items_index;
6774
35b3402f 6775 for (i = 0; i < end; i += 4)
7539e11f 6776 if (EQ (XCAR (tail), XVECTOR (menu_bar_items_vector)->contents[i]))
b7c49376 6777 {
35b3402f 6778 Lisp_Object tem0, tem1, tem2, tem3;
0301268e
RS
6779 /* Move the item at index I to the end,
6780 shifting all the others forward. */
6781 tem0 = XVECTOR (menu_bar_items_vector)->contents[i + 0];
6782 tem1 = XVECTOR (menu_bar_items_vector)->contents[i + 1];
6783 tem2 = XVECTOR (menu_bar_items_vector)->contents[i + 2];
35b3402f
RS
6784 tem3 = XVECTOR (menu_bar_items_vector)->contents[i + 3];
6785 if (end > i + 4)
6786 bcopy (&XVECTOR (menu_bar_items_vector)->contents[i + 4],
0301268e 6787 &XVECTOR (menu_bar_items_vector)->contents[i],
35b3402f
RS
6788 (end - i - 4) * sizeof (Lisp_Object));
6789 XVECTOR (menu_bar_items_vector)->contents[end - 4] = tem0;
6790 XVECTOR (menu_bar_items_vector)->contents[end - 3] = tem1;
6791 XVECTOR (menu_bar_items_vector)->contents[end - 2] = tem2;
6792 XVECTOR (menu_bar_items_vector)->contents[end - 1] = tem3;
0301268e 6793 break;
b7c49376
RS
6794 }
6795 }
9f9c0e27 6796
0c9071cd 6797 /* Add nil, nil, nil, nil at the end. */
b7c49376 6798 i = menu_bar_items_index;
35b3402f 6799 if (i + 4 > XVECTOR (menu_bar_items_vector)->size)
b7c49376
RS
6800 {
6801 Lisp_Object tem;
b7c49376
RS
6802 tem = Fmake_vector (make_number (2 * i), Qnil);
6803 bcopy (XVECTOR (menu_bar_items_vector)->contents,
6804 XVECTOR (tem)->contents, i * sizeof (Lisp_Object));
6805 menu_bar_items_vector = tem;
9f9c0e27 6806 }
b7c49376
RS
6807 /* Add this item. */
6808 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
6809 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
6810 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
35b3402f 6811 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
b7c49376 6812 menu_bar_items_index = i;
a73c5e29 6813
47d319aa 6814 Vinhibit_quit = oquit;
b7c49376
RS
6815 UNGCPRO;
6816 return menu_bar_items_vector;
5ec75a55
RS
6817}
6818\f
6819/* Scan one map KEYMAP, accumulating any menu items it defines
f5e09c8b 6820 in menu_bar_items_vector. */
5ec75a55 6821
759860a6
RS
6822static Lisp_Object menu_bar_one_keymap_changed_items;
6823
b7c49376
RS
6824static void
6825menu_bar_one_keymap (keymap)
6826 Lisp_Object keymap;
5ec75a55 6827{
03cee6ae 6828 Lisp_Object tail, item;
5ec75a55 6829
759860a6
RS
6830 menu_bar_one_keymap_changed_items = Qnil;
6831
5ec75a55 6832 /* Loop over all keymap entries that have menu strings. */
7539e11f 6833 for (tail = keymap; CONSP (tail); tail = XCDR (tail))
5ec75a55 6834 {
7539e11f 6835 item = XCAR (tail);
8c18cbfb 6836 if (CONSP (item))
7539e11f 6837 menu_bar_item (XCAR (item), XCDR (item));
8c18cbfb 6838 else if (VECTORP (item))
5ec75a55
RS
6839 {
6840 /* Loop over the char values represented in the vector. */
6841 int len = XVECTOR (item)->size;
6842 int c;
6843 for (c = 0; c < len; c++)
6844 {
6845 Lisp_Object character;
bb9e9bed 6846 XSETFASTINT (character, c);
e8886a1d 6847 menu_bar_item (character, XVECTOR (item)->contents[c]);
5ec75a55
RS
6848 }
6849 }
6850 }
5ec75a55
RS
6851}
6852
f5e09c8b
RS
6853/* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
6854 If there's already an item for KEY, add this DEF to it. */
6855
e8886a1d
RS
6856Lisp_Object item_properties;
6857
b7c49376 6858static void
e8886a1d
RS
6859menu_bar_item (key, item)
6860 Lisp_Object key, item;
5ec75a55 6861{
e8886a1d 6862 struct gcpro gcpro1;
b7c49376 6863 int i;
759860a6 6864 Lisp_Object tem;
5ec75a55 6865
e8886a1d 6866 if (EQ (item, Qundefined))
e58aa385 6867 {
f5e09c8b 6868 /* If a map has an explicit `undefined' as definition,
e58aa385 6869 discard any previously made menu bar item. */
b7c49376 6870
35b3402f 6871 for (i = 0; i < menu_bar_items_index; i += 4)
b7c49376
RS
6872 if (EQ (key, XVECTOR (menu_bar_items_vector)->contents[i]))
6873 {
35b3402f
RS
6874 if (menu_bar_items_index > i + 4)
6875 bcopy (&XVECTOR (menu_bar_items_vector)->contents[i + 4],
b7c49376 6876 &XVECTOR (menu_bar_items_vector)->contents[i],
35b3402f
RS
6877 (menu_bar_items_index - i - 4) * sizeof (Lisp_Object));
6878 menu_bar_items_index -= 4;
b7c49376 6879 }
e58aa385
RS
6880 }
6881
759860a6
RS
6882 /* If this keymap has already contributed to this KEY,
6883 don't contribute to it a second time. */
6884 tem = Fmemq (key, menu_bar_one_keymap_changed_items);
9cd2ced7 6885 if (!NILP (tem) || NILP (item))
759860a6
RS
6886 return;
6887
6888 menu_bar_one_keymap_changed_items
6889 = Fcons (key, menu_bar_one_keymap_changed_items);
6890
9cd2ced7
SM
6891 /* We add to menu_bar_one_keymap_changed_items before doing the
6892 parse_menu_item, so that if it turns out it wasn't a menu item,
6893 it still correctly hides any further menu item. */
6894 GCPRO1 (key);
6895 i = parse_menu_item (item, 0, 1);
6896 UNGCPRO;
6897 if (!i)
6898 return;
6899
e8886a1d
RS
6900 item = XVECTOR (item_properties)->contents[ITEM_PROPERTY_DEF];
6901
f5e09c8b 6902 /* Find any existing item for this KEY. */
35b3402f 6903 for (i = 0; i < menu_bar_items_index; i += 4)
b7c49376
RS
6904 if (EQ (key, XVECTOR (menu_bar_items_vector)->contents[i]))
6905 break;
6906
f5e09c8b 6907 /* If we did not find this KEY, add it at the end. */
b7c49376
RS
6908 if (i == menu_bar_items_index)
6909 {
6910 /* If vector is too small, get a bigger one. */
35b3402f 6911 if (i + 4 > XVECTOR (menu_bar_items_vector)->size)
b7c49376
RS
6912 {
6913 Lisp_Object tem;
b7c49376
RS
6914 tem = Fmake_vector (make_number (2 * i), Qnil);
6915 bcopy (XVECTOR (menu_bar_items_vector)->contents,
6916 XVECTOR (tem)->contents, i * sizeof (Lisp_Object));
6917 menu_bar_items_vector = tem;
6918 }
e8886a1d 6919
b7c49376
RS
6920 /* Add this item. */
6921 XVECTOR (menu_bar_items_vector)->contents[i++] = key;
e8886a1d
RS
6922 XVECTOR (menu_bar_items_vector)->contents[i++]
6923 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_NAME];
6924 XVECTOR (menu_bar_items_vector)->contents[i++] = Fcons (item, Qnil);
35b3402f 6925 XVECTOR (menu_bar_items_vector)->contents[i++] = make_number (0);
b7c49376
RS
6926 menu_bar_items_index = i;
6927 }
e8886a1d 6928 /* We did find an item for this KEY. Add ITEM to its list of maps. */
f5e09c8b
RS
6929 else
6930 {
6931 Lisp_Object old;
6932 old = XVECTOR (menu_bar_items_vector)->contents[i + 2];
e8886a1d 6933 XVECTOR (menu_bar_items_vector)->contents[i + 2] = Fcons (item, old);
f5e09c8b 6934 }
5ec75a55
RS
6935}
6936\f
e8886a1d
RS
6937 /* This is used as the handler when calling menu_item_eval_property. */
6938static Lisp_Object
6939menu_item_eval_property_1 (arg)
6940 Lisp_Object arg;
6941{
6942 /* If we got a quit from within the menu computation,
6943 quit all the way out of it. This takes care of C-] in the debugger. */
7539e11f 6944 if (CONSP (arg) && EQ (XCAR (arg), Qquit))
e8886a1d
RS
6945 Fsignal (Qquit, Qnil);
6946
6947 return Qnil;
6948}
6949
6950/* Evaluate an expression and return the result (or nil if something
6951 went wrong). Used to evaluate dynamic parts of menu items. */
7ee32cda 6952Lisp_Object
e8886a1d
RS
6953menu_item_eval_property (sexpr)
6954 Lisp_Object sexpr;
6955{
aed13378 6956 int count = SPECPDL_INDEX ();
e8886a1d 6957 Lisp_Object val;
44e553a3 6958 specbind (Qinhibit_redisplay, Qt);
e8886a1d
RS
6959 val = internal_condition_case_1 (Feval, sexpr, Qerror,
6960 menu_item_eval_property_1);
44e553a3 6961 return unbind_to (count, val);
e8886a1d
RS
6962}
6963
6964/* This function parses a menu item and leaves the result in the
6965 vector item_properties.
6966 ITEM is a key binding, a possible menu item.
6967 If NOTREAL is nonzero, only check for equivalent key bindings, don't
6968 evaluate dynamic expressions in the menu item.
fd3613d7 6969 INMENUBAR is > 0 when this is considered for an entry in a menu bar
e8886a1d 6970 top level.
fd3613d7 6971 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
e8886a1d
RS
6972 parse_menu_item returns true if the item is a menu item and false
6973 otherwise. */
6974
6975int
6976parse_menu_item (item, notreal, inmenubar)
6977 Lisp_Object item;
6978 int notreal, inmenubar;
6979{
adc1d5c8 6980 Lisp_Object def, tem, item_string, start;
07ba902e
RS
6981 Lisp_Object cachelist;
6982 Lisp_Object filter;
6983 Lisp_Object keyhint;
e8886a1d 6984 int i;
74c1de23
RS
6985 int newcache = 0;
6986
07ba902e
RS
6987 cachelist = Qnil;
6988 filter = Qnil;
6989 keyhint = Qnil;
6990
e8886a1d
RS
6991 if (!CONSP (item))
6992 return 0;
6993
e8886a1d
RS
6994 /* Create item_properties vector if necessary. */
6995 if (NILP (item_properties))
6996 item_properties
6997 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE + 1), Qnil);
6998
6999 /* Initialize optional entries. */
7000 for (i = ITEM_PROPERTY_DEF; i < ITEM_PROPERTY_ENABLE; i++)
3626fb1a
GM
7001 AREF (item_properties, i) = Qnil;
7002 AREF (item_properties, ITEM_PROPERTY_ENABLE) = Qt;
e8886a1d
RS
7003
7004 /* Save the item here to protect it from GC. */
3626fb1a 7005 AREF (item_properties, ITEM_PROPERTY_ITEM) = item;
e8886a1d 7006
7539e11f 7007 item_string = XCAR (item);
e8886a1d
RS
7008
7009 start = item;
7539e11f 7010 item = XCDR (item);
e8886a1d
RS
7011 if (STRINGP (item_string))
7012 {
7013 /* Old format menu item. */
3626fb1a 7014 AREF (item_properties, ITEM_PROPERTY_NAME) = item_string;
e8886a1d
RS
7015
7016 /* Maybe help string. */
7539e11f 7017 if (CONSP (item) && STRINGP (XCAR (item)))
e8886a1d 7018 {
3626fb1a 7019 AREF (item_properties, ITEM_PROPERTY_HELP) = XCAR (item);
e8886a1d 7020 start = item;
7539e11f 7021 item = XCDR (item);
e8886a1d
RS
7022 }
7023
31f84d03 7024 /* Maybe key binding cache. */
7539e11f
KR
7025 if (CONSP (item) && CONSP (XCAR (item))
7026 && (NILP (XCAR (XCAR (item)))
7027 || VECTORP (XCAR (XCAR (item)))))
e8886a1d 7028 {
7539e11f
KR
7029 cachelist = XCAR (item);
7030 item = XCDR (item);
e8886a1d
RS
7031 }
7032
7033 /* This is the real definition--the function to run. */
3626fb1a 7034 AREF (item_properties, ITEM_PROPERTY_DEF) = item;
e8886a1d
RS
7035
7036 /* Get enable property, if any. */
7037 if (SYMBOLP (item))
7038 {
7039 tem = Fget (item, Qmenu_enable);
7040 if (!NILP (tem))
3626fb1a 7041 AREF (item_properties, ITEM_PROPERTY_ENABLE) = tem;
e8886a1d
RS
7042 }
7043 }
7044 else if (EQ (item_string, Qmenu_item) && CONSP (item))
7045 {
7046 /* New format menu item. */
3626fb1a 7047 AREF (item_properties, ITEM_PROPERTY_NAME) = XCAR (item);
7539e11f 7048 start = XCDR (item);
e8886a1d
RS
7049 if (CONSP (start))
7050 {
7051 /* We have a real binding. */
3626fb1a 7052 AREF (item_properties, ITEM_PROPERTY_DEF) = XCAR (start);
e8886a1d 7053
7539e11f 7054 item = XCDR (start);
e8886a1d 7055 /* Is there a cache list with key equivalences. */
7539e11f 7056 if (CONSP (item) && CONSP (XCAR (item)))
e8886a1d 7057 {
7539e11f
KR
7058 cachelist = XCAR (item);
7059 item = XCDR (item);
e8886a1d
RS
7060 }
7061
7062 /* Parse properties. */
7539e11f 7063 while (CONSP (item) && CONSP (XCDR (item)))
e8886a1d 7064 {
7539e11f
KR
7065 tem = XCAR (item);
7066 item = XCDR (item);
e8886a1d
RS
7067
7068 if (EQ (tem, QCenable))
3626fb1a 7069 AREF (item_properties, ITEM_PROPERTY_ENABLE) = XCAR (item);
e8886a1d
RS
7070 else if (EQ (tem, QCvisible) && !notreal)
7071 {
7072 /* If got a visible property and that evaluates to nil
7073 then ignore this item. */
7539e11f 7074 tem = menu_item_eval_property (XCAR (item));
e8886a1d 7075 if (NILP (tem))
adc1d5c8 7076 return 0;
e8886a1d
RS
7077 }
7078 else if (EQ (tem, QChelp))
3626fb1a 7079 AREF (item_properties, ITEM_PROPERTY_HELP) = XCAR (item);
e8886a1d 7080 else if (EQ (tem, QCfilter))
74c1de23
RS
7081 filter = item;
7082 else if (EQ (tem, QCkey_sequence))
7083 {
7539e11f 7084 tem = XCAR (item);
74c1de23
RS
7085 if (NILP (cachelist)
7086 && (SYMBOLP (tem) || STRINGP (tem) || VECTORP (tem)))
7087 /* Be GC protected. Set keyhint to item instead of tem. */
7088 keyhint = item;
7089 }
7090 else if (EQ (tem, QCkeys))
7091 {
7539e11f 7092 tem = XCAR (item);
03cee6ae 7093 if (CONSP (tem) || (STRINGP (tem) && NILP (cachelist)))
3626fb1a 7094 AREF (item_properties, ITEM_PROPERTY_KEYEQ) = tem;
74c1de23 7095 }
7539e11f 7096 else if (EQ (tem, QCbutton) && CONSP (XCAR (item)))
e8886a1d 7097 {
74c1de23 7098 Lisp_Object type;
7539e11f
KR
7099 tem = XCAR (item);
7100 type = XCAR (tem);
e8886a1d
RS
7101 if (EQ (type, QCtoggle) || EQ (type, QCradio))
7102 {
3626fb1a 7103 AREF (item_properties, ITEM_PROPERTY_SELECTED)
7539e11f 7104 = XCDR (tem);
3626fb1a 7105 AREF (item_properties, ITEM_PROPERTY_TYPE)
e8886a1d
RS
7106 = type;
7107 }
7108 }
7539e11f 7109 item = XCDR (item);
e8886a1d
RS
7110 }
7111 }
7112 else if (inmenubar || !NILP (start))
adc1d5c8 7113 return 0;
e8886a1d
RS
7114 }
7115 else
adc1d5c8 7116 return 0; /* not a menu item */
e8886a1d
RS
7117
7118 /* If item string is not a string, evaluate it to get string.
7119 If we don't get a string, skip this item. */
3626fb1a 7120 item_string = AREF (item_properties, ITEM_PROPERTY_NAME);
e8886a1d
RS
7121 if (!(STRINGP (item_string) || notreal))
7122 {
7123 item_string = menu_item_eval_property (item_string);
7124 if (!STRINGP (item_string))
adc1d5c8 7125 return 0;
3626fb1a 7126 AREF (item_properties, ITEM_PROPERTY_NAME) = item_string;
e8886a1d
RS
7127 }
7128
7129 /* If got a filter apply it on definition. */
3626fb1a 7130 def = AREF (item_properties, ITEM_PROPERTY_DEF);
e8886a1d
RS
7131 if (!NILP (filter))
7132 {
7539e11f 7133 def = menu_item_eval_property (list2 (XCAR (filter),
c5c5a6f8
RS
7134 list2 (Qquote, def)));
7135
3626fb1a 7136 AREF (item_properties, ITEM_PROPERTY_DEF) = def;
e8886a1d
RS
7137 }
7138
e8886a1d 7139 /* Enable or disable selection of item. */
3626fb1a 7140 tem = AREF (item_properties, ITEM_PROPERTY_ENABLE);
e8886a1d
RS
7141 if (!EQ (tem, Qt))
7142 {
7143 if (notreal)
7144 tem = Qt;
7145 else
7146 tem = menu_item_eval_property (tem);
7147 if (inmenubar && NILP (tem))
adc1d5c8 7148 return 0; /* Ignore disabled items in menu bar. */
3626fb1a 7149 AREF (item_properties, ITEM_PROPERTY_ENABLE) = tem;
e8886a1d
RS
7150 }
7151
7189cad8
SM
7152 /* If we got no definition, this item is just unselectable text which
7153 is OK in a submenu but not in the menubar. */
7154 if (NILP (def))
7155 return (inmenubar ? 0 : 1);
7156
e8886a1d 7157 /* See if this is a separate pane or a submenu. */
3626fb1a 7158 def = AREF (item_properties, ITEM_PROPERTY_DEF);
02067692 7159 tem = get_keymap (def, 0, 1);
9ac425d1 7160 /* For a subkeymap, just record its details and exit. */
02067692 7161 if (CONSP (tem))
e8886a1d 7162 {
3626fb1a
GM
7163 AREF (item_properties, ITEM_PROPERTY_MAP) = tem;
7164 AREF (item_properties, ITEM_PROPERTY_DEF) = tem;
e8886a1d
RS
7165 return 1;
7166 }
3626fb1a 7167
9ac425d1
RS
7168 /* At the top level in the menu bar, do likewise for commands also.
7169 The menu bar does not display equivalent key bindings anyway.
7170 ITEM_PROPERTY_DEF is already set up properly. */
7171 if (inmenubar > 0)
7172 return 1;
e8886a1d
RS
7173
7174 /* This is a command. See if there is an equivalent key binding. */
7175 if (NILP (cachelist))
7176 {
74c1de23 7177 /* We have to create a cachelist. */
e8886a1d 7178 CHECK_IMPURE (start);
f3fbd155 7179 XSETCDR (start, Fcons (Fcons (Qnil, Qnil), XCDR (start)));
7539e11f 7180 cachelist = XCAR (XCDR (start));
74c1de23 7181 newcache = 1;
3626fb1a 7182 tem = AREF (item_properties, ITEM_PROPERTY_KEYEQ);
74c1de23
RS
7183 if (!NILP (keyhint))
7184 {
f3fbd155 7185 XSETCAR (cachelist, XCAR (keyhint));
74c1de23
RS
7186 newcache = 0;
7187 }
7188 else if (STRINGP (tem))
7189 {
f3fbd155
KR
7190 XSETCDR (cachelist, Fsubstitute_command_keys (tem));
7191 XSETCAR (cachelist, Qt);
74c1de23
RS
7192 }
7193 }
3626fb1a 7194
7539e11f 7195 tem = XCAR (cachelist);
74c1de23
RS
7196 if (!EQ (tem, Qt))
7197 {
7198 int chkcache = 0;
7199 Lisp_Object prefix;
7200
7201 if (!NILP (tem))
8b9940e6 7202 tem = Fkey_binding (tem, Qnil, Qnil);
74c1de23 7203
3626fb1a 7204 prefix = AREF (item_properties, ITEM_PROPERTY_KEYEQ);
74c1de23
RS
7205 if (CONSP (prefix))
7206 {
7539e11f
KR
7207 def = XCAR (prefix);
7208 prefix = XCDR (prefix);
74c1de23 7209 }
e8886a1d 7210 else
3626fb1a 7211 def = AREF (item_properties, ITEM_PROPERTY_DEF);
74c1de23 7212
3626fb1a
GM
7213 if (!update_menu_bindings)
7214 chkcache = 0;
7215 else if (NILP (XCAR (cachelist))) /* Have no saved key. */
74c1de23
RS
7216 {
7217 if (newcache /* Always check first time. */
7218 /* Should we check everything when precomputing key
7219 bindings? */
74c1de23
RS
7220 /* If something had no key binding before, don't recheck it
7221 because that is too slow--except if we have a list of
7222 rebound commands in Vdefine_key_rebound_commands, do
7223 recheck any command that appears in that list. */
7224 || (CONSP (Vdefine_key_rebound_commands)
7225 && !NILP (Fmemq (def, Vdefine_key_rebound_commands))))
7226 chkcache = 1;
7227 }
7228 /* We had a saved key. Is it still bound to the command? */
7229 else if (NILP (tem)
03cee6ae
GM
7230 || (!EQ (tem, def)
7231 /* If the command is an alias for another
7232 (such as lmenu.el set it up), check if the
7233 original command matches the cached command. */
7234 && !(SYMBOLP (def) && EQ (tem, XSYMBOL (def)->function))))
74c1de23
RS
7235 chkcache = 1; /* Need to recompute key binding. */
7236
7237 if (chkcache)
7238 {
7239 /* Recompute equivalent key binding. If the command is an alias
7240 for another (such as lmenu.el set it up), see if the original
7241 command name has equivalent keys. Otherwise look up the
7242 specified command itself. We don't try both, because that
7243 makes lmenu menus slow. */
3626fb1a
GM
7244 if (SYMBOLP (def)
7245 && SYMBOLP (XSYMBOL (def)->function)
74c1de23
RS
7246 && ! NILP (Fget (def, Qmenu_alias)))
7247 def = XSYMBOL (def)->function;
8b9940e6 7248 tem = Fwhere_is_internal (def, Qnil, Qt, Qnil, Qt);
f3fbd155 7249 XSETCAR (cachelist, tem);
74c1de23
RS
7250 if (NILP (tem))
7251 {
f3fbd155 7252 XSETCDR (cachelist, Qnil);
74c1de23
RS
7253 chkcache = 0;
7254 }
7255 }
7539e11f 7256 else if (!NILP (keyhint) && !NILP (XCAR (cachelist)))
74c1de23 7257 {
7539e11f 7258 tem = XCAR (cachelist);
74c1de23
RS
7259 chkcache = 1;
7260 }
7261
7262 newcache = chkcache;
7263 if (chkcache)
7264 {
7265 tem = Fkey_description (tem);
7266 if (CONSP (prefix))
7267 {
7539e11f
KR
7268 if (STRINGP (XCAR (prefix)))
7269 tem = concat2 (XCAR (prefix), tem);
7270 if (STRINGP (XCDR (prefix)))
7271 tem = concat2 (tem, XCDR (prefix));
74c1de23 7272 }
f3fbd155 7273 XSETCDR (cachelist, tem);
74c1de23
RS
7274 }
7275 }
7276
7539e11f 7277 tem = XCDR (cachelist);
74c1de23 7278 if (newcache && !NILP (tem))
e8886a1d 7279 {
74c1de23 7280 tem = concat3 (build_string (" ("), tem, build_string (")"));
f3fbd155 7281 XSETCDR (cachelist, tem);
e8886a1d
RS
7282 }
7283
7284 /* If we only want to precompute equivalent key bindings, stop here. */
7285 if (notreal)
adc1d5c8 7286 return 1;
e8886a1d
RS
7287
7288 /* If we have an equivalent key binding, use that. */
3626fb1a 7289 AREF (item_properties, ITEM_PROPERTY_KEYEQ) = tem;
adc1d5c8
RS
7290
7291 /* Include this when menu help is implemented.
7292 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7293 if (!(NILP (tem) || STRINGP (tem)))
7294 {
7295 tem = menu_item_eval_property (tem);
7296 if (!STRINGP (tem))
7297 tem = Qnil;
7298 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7299 }
e8886a1d
RS
7300 */
7301
7302 /* Handle radio buttons or toggle boxes. */
3626fb1a 7303 tem = AREF (item_properties, ITEM_PROPERTY_SELECTED);
e8886a1d 7304 if (!NILP (tem))
3626fb1a 7305 AREF (item_properties, ITEM_PROPERTY_SELECTED)
e8886a1d
RS
7306 = menu_item_eval_property (tem);
7307
e8886a1d
RS
7308 return 1;
7309}
7ee32cda
GM
7310
7311
7312\f
7313/***********************************************************************
7314 Tool-bars
7315 ***********************************************************************/
7316
9ea173e8 7317/* A vector holding tool bar items while they are parsed in function
27fd22dc 7318 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
9ea173e8 7319 in the vector. */
7ee32cda 7320
9ea173e8 7321static Lisp_Object tool_bar_items_vector;
7ee32cda 7322
9ea173e8
GM
7323/* A vector holding the result of parse_tool_bar_item. Layout is like
7324 the one for a single item in tool_bar_items_vector. */
7ee32cda 7325
9ea173e8 7326static Lisp_Object tool_bar_item_properties;
7ee32cda 7327
9ea173e8 7328/* Next free index in tool_bar_items_vector. */
7ee32cda 7329
9ea173e8 7330static int ntool_bar_items;
7ee32cda 7331
9ea173e8 7332/* The symbols `tool-bar', and `:image'. */
7ee32cda 7333
9ea173e8 7334extern Lisp_Object Qtool_bar;
7ee32cda
GM
7335Lisp_Object QCimage;
7336
7337/* Function prototypes. */
7338
9ea173e8
GM
7339static void init_tool_bar_items P_ ((Lisp_Object));
7340static void process_tool_bar_item P_ ((Lisp_Object, Lisp_Object));
7341static int parse_tool_bar_item P_ ((Lisp_Object, Lisp_Object));
7342static void append_tool_bar_item P_ ((void));
7ee32cda
GM
7343
7344
9ea173e8 7345/* Return a vector of tool bar items for keymaps currently in effect.
7ee32cda 7346 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
9ea173e8 7347 tool bar items found. */
7ee32cda
GM
7348
7349Lisp_Object
9ea173e8 7350tool_bar_items (reuse, nitems)
7ee32cda
GM
7351 Lisp_Object reuse;
7352 int *nitems;
7353{
7354 Lisp_Object *maps;
7355 int nmaps, i;
7356 Lisp_Object oquit;
7357 Lisp_Object *tmaps;
7ee32cda
GM
7358
7359 *nitems = 0;
7360
7361 /* In order to build the menus, we need to call the keymap
7362 accessors. They all call QUIT. But this function is called
7363 during redisplay, during which a quit is fatal. So inhibit
7364 quitting while building the menus. We do this instead of
7365 specbind because (1) errors will clear it anyway and (2) this
7366 avoids risk of specpdl overflow. */
7367 oquit = Vinhibit_quit;
7368 Vinhibit_quit = Qt;
7369
9ea173e8
GM
7370 /* Initialize tool_bar_items_vector and protect it from GC. */
7371 init_tool_bar_items (reuse);
7ee32cda
GM
7372
7373 /* Build list of keymaps in maps. Set nmaps to the number of maps
7374 to process. */
7375
7376 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7377 if (!NILP (Voverriding_local_map_menu_flag))
7378 {
7379 /* Yes, use them (if non-nil) as well as the global map. */
7380 maps = (Lisp_Object *) alloca (3 * sizeof (maps[0]));
7381 nmaps = 0;
7382 if (!NILP (current_kboard->Voverriding_terminal_local_map))
7383 maps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
7384 if (!NILP (Voverriding_local_map))
7385 maps[nmaps++] = Voverriding_local_map;
7386 }
7387 else
7388 {
fd646341
KS
7389 /* No, so use major and minor mode keymaps and keymap property.
7390 Note that tool-bar bindings in the local-map and keymap
7391 properties may not work reliable, as they are only
7392 recognized when the tool-bar (or mode-line) is updated,
7393 which does not normally happen after every command. */
7394 Lisp_Object tem;
7395 int nminor;
7396 nminor = current_minor_maps (NULL, &tmaps);
7397 maps = (Lisp_Object *) alloca ((nminor + 3) * sizeof (maps[0]));
7398 nmaps = 0;
7399 if (tem = get_local_map (PT, current_buffer, Qkeymap), !NILP (tem))
7400 maps[nmaps++] = tem;
7401 bcopy (tmaps, (void *) (maps + nmaps), nminor * sizeof (maps[0]));
7402 nmaps += nminor;
7403 maps[nmaps++] = get_local_map (PT, current_buffer, Qlocal_map);
7ee32cda
GM
7404 }
7405
7406 /* Add global keymap at the end. */
7407 maps[nmaps++] = current_global_map;
7408
7409 /* Process maps in reverse order and look up in each map the prefix
9ea173e8 7410 key `tool-bar'. */
7ee32cda
GM
7411 for (i = nmaps - 1; i >= 0; --i)
7412 if (!NILP (maps[i]))
7413 {
7414 Lisp_Object keymap;
db785038 7415
341a09cf 7416 keymap = get_keymap (access_keymap (maps[i], Qtool_bar, 1, 0, 1), 0, 1);
02067692 7417 if (CONSP (keymap))
7ee32cda
GM
7418 {
7419 Lisp_Object tail;
7420
7421 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7539e11f 7422 for (tail = keymap; CONSP (tail); tail = XCDR (tail))
7ee32cda
GM
7423 {
7424 Lisp_Object keydef = XCAR (tail);
7425 if (CONSP (keydef))
9ea173e8 7426 process_tool_bar_item (XCAR (keydef), XCDR (keydef));
7ee32cda
GM
7427 }
7428 }
7429 }
7430
7431 Vinhibit_quit = oquit;
9ea173e8
GM
7432 *nitems = ntool_bar_items / TOOL_BAR_ITEM_NSLOTS;
7433 return tool_bar_items_vector;
7ee32cda
GM
7434}
7435
7436
7437/* Process the definition of KEY which is DEF. */
7438
7439static void
9ea173e8 7440process_tool_bar_item (key, def)
7ee32cda
GM
7441 Lisp_Object key, def;
7442{
7443 int i;
7444 extern Lisp_Object Qundefined;
7445 struct gcpro gcpro1, gcpro2;
7446
9ea173e8 7447 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7ee32cda
GM
7448 eval. */
7449 GCPRO2 (key, def);
7450
7451 if (EQ (def, Qundefined))
7452 {
7453 /* If a map has an explicit `undefined' as definition,
7454 discard any previously made item. */
9ea173e8 7455 for (i = 0; i < ntool_bar_items; i += TOOL_BAR_ITEM_NSLOTS)
7ee32cda 7456 {
9ea173e8 7457 Lisp_Object *v = XVECTOR (tool_bar_items_vector)->contents + i;
7ee32cda 7458
9ea173e8 7459 if (EQ (key, v[TOOL_BAR_ITEM_KEY]))
7ee32cda 7460 {
9ea173e8
GM
7461 if (ntool_bar_items > i + TOOL_BAR_ITEM_NSLOTS)
7462 bcopy (v + TOOL_BAR_ITEM_NSLOTS, v,
7463 ((ntool_bar_items - i - TOOL_BAR_ITEM_NSLOTS)
7ee32cda 7464 * sizeof (Lisp_Object)));
9ea173e8 7465 ntool_bar_items -= TOOL_BAR_ITEM_NSLOTS;
7ee32cda
GM
7466 break;
7467 }
7468 }
7469 }
9ea173e8
GM
7470 else if (parse_tool_bar_item (key, def))
7471 /* Append a new tool bar item to tool_bar_items_vector. Accept
7ee32cda 7472 more than one definition for the same key. */
9ea173e8 7473 append_tool_bar_item ();
7ee32cda
GM
7474
7475 UNGCPRO;
7476}
7477
7478
9ea173e8
GM
7479/* Parse a tool bar item specification ITEM for key KEY and return the
7480 result in tool_bar_item_properties. Value is zero if ITEM is
7ee32cda
GM
7481 invalid.
7482
7483 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7484
7485 CAPTION is the caption of the item, If it's not a string, it is
7486 evaluated to get a string.
7487
9ea173e8 7488 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7ee32cda
GM
7489 as binding are currently ignored.
7490
7491 The following properties are recognized:
7492
7493 - `:enable FORM'.
7494
9ea173e8
GM
7495 FORM is evaluated and specifies whether the tool bar item is
7496 enabled or disabled.
7ee32cda
GM
7497
7498 - `:visible FORM'
7499
9ea173e8 7500 FORM is evaluated and specifies whether the tool bar item is visible.
7ee32cda
GM
7501
7502 - `:filter FUNCTION'
7503
7504 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7505 result is stored as the new binding.
7506
7507 - `:button (TYPE SELECTED)'
7508
7509 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7510 and specifies whether the button is selected (pressed) or not.
7511
7512 - `:image IMAGES'
7513
7514 IMAGES is either a single image specification or a vector of four
9ea173e8 7515 image specifications. See enum tool_bar_item_images.
7ee32cda
GM
7516
7517 - `:help HELP-STRING'.
7518
9ea173e8 7519 Gives a help string to display for the tool bar item. */
7ee32cda
GM
7520
7521static int
9ea173e8 7522parse_tool_bar_item (key, item)
7ee32cda
GM
7523 Lisp_Object key, item;
7524{
9ea173e8
GM
7525 /* Access slot with index IDX of vector tool_bar_item_properties. */
7526#define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7ee32cda
GM
7527
7528 Lisp_Object filter = Qnil;
7529 Lisp_Object caption;
7ee32cda 7530 int i;
7ee32cda 7531
8c907a56
GM
7532 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7533 Rule out items that aren't lists, don't start with
7534 `menu-item' or whose rest following `tool-bar-item' is not a
7ee32cda
GM
7535 list. */
7536 if (!CONSP (item)
7537 || !EQ (XCAR (item), Qmenu_item)
7538 || (item = XCDR (item),
7539 !CONSP (item)))
7540 return 0;
7541
9ea173e8 7542 /* Create tool_bar_item_properties vector if necessary. Reset it to
7ee32cda 7543 defaults. */
9ea173e8 7544 if (VECTORP (tool_bar_item_properties))
7ee32cda 7545 {
9ea173e8 7546 for (i = 0; i < TOOL_BAR_ITEM_NSLOTS; ++i)
7ee32cda
GM
7547 PROP (i) = Qnil;
7548 }
7549 else
9ea173e8
GM
7550 tool_bar_item_properties
7551 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS), Qnil);
7ee32cda
GM
7552
7553 /* Set defaults. */
9ea173e8
GM
7554 PROP (TOOL_BAR_ITEM_KEY) = key;
7555 PROP (TOOL_BAR_ITEM_ENABLED_P) = Qt;
7ee32cda
GM
7556
7557 /* Get the caption of the item. If the caption is not a string,
7558 evaluate it to get a string. If we don't get a string, skip this
7559 item. */
7560 caption = XCAR (item);
7561 if (!STRINGP (caption))
7562 {
7563 caption = menu_item_eval_property (caption);
7564 if (!STRINGP (caption))
7565 return 0;
7566 }
9ea173e8 7567 PROP (TOOL_BAR_ITEM_CAPTION) = caption;
7ee32cda
GM
7568
7569 /* Give up if rest following the caption is not a list. */
7570 item = XCDR (item);
7571 if (!CONSP (item))
7572 return 0;
7573
7574 /* Store the binding. */
9ea173e8 7575 PROP (TOOL_BAR_ITEM_BINDING) = XCAR (item);
7ee32cda
GM
7576 item = XCDR (item);
7577
8c907a56
GM
7578 /* Ignore cached key binding, if any. */
7579 if (CONSP (item) && CONSP (XCAR (item)))
7580 item = XCDR (item);
7581
7ee32cda
GM
7582 /* Process the rest of the properties. */
7583 for (; CONSP (item) && CONSP (XCDR (item)); item = XCDR (XCDR (item)))
7584 {
7585 Lisp_Object key, value;
7586
7587 key = XCAR (item);
7588 value = XCAR (XCDR (item));
7589
7590 if (EQ (key, QCenable))
7591 /* `:enable FORM'. */
9ea173e8 7592 PROP (TOOL_BAR_ITEM_ENABLED_P) = value;
7ee32cda
GM
7593 else if (EQ (key, QCvisible))
7594 {
7595 /* `:visible FORM'. If got a visible property and that
7596 evaluates to nil then ignore this item. */
7597 if (NILP (menu_item_eval_property (value)))
7598 return 0;
7599 }
7600 else if (EQ (key, QChelp))
7601 /* `:help HELP-STRING'. */
9ea173e8 7602 PROP (TOOL_BAR_ITEM_HELP) = value;
7ee32cda
GM
7603 else if (EQ (key, QCfilter))
7604 /* ':filter FORM'. */
7605 filter = value;
7606 else if (EQ (key, QCbutton) && CONSP (value))
7607 {
7608 /* `:button (TYPE . SELECTED)'. */
7609 Lisp_Object type, selected;
7610
7611 type = XCAR (value);
7612 selected = XCDR (value);
7613 if (EQ (type, QCtoggle) || EQ (type, QCradio))
7614 {
9ea173e8
GM
7615 PROP (TOOL_BAR_ITEM_SELECTED_P) = selected;
7616 PROP (TOOL_BAR_ITEM_TYPE) = type;
7ee32cda
GM
7617 }
7618 }
7619 else if (EQ (key, QCimage)
7620 && (CONSP (value)
7621 || (VECTORP (value) && XVECTOR (value)->size == 4)))
7622 /* Value is either a single image specification or a vector
27fd22dc 7623 of 4 such specifications for the different button states. */
9ea173e8 7624 PROP (TOOL_BAR_ITEM_IMAGES) = value;
7ee32cda
GM
7625 }
7626
7627 /* If got a filter apply it on binding. */
7628 if (!NILP (filter))
9ea173e8 7629 PROP (TOOL_BAR_ITEM_BINDING)
7ee32cda
GM
7630 = menu_item_eval_property (list2 (filter,
7631 list2 (Qquote,
9ea173e8 7632 PROP (TOOL_BAR_ITEM_BINDING))));
7ee32cda
GM
7633
7634 /* See if the binding is a keymap. Give up if it is. */
02067692 7635 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING), 0, 1)))
7ee32cda
GM
7636 return 0;
7637
7638 /* Enable or disable selection of item. */
9ea173e8
GM
7639 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P), Qt))
7640 PROP (TOOL_BAR_ITEM_ENABLED_P)
7641 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P));
7ee32cda
GM
7642
7643 /* Handle radio buttons or toggle boxes. */
9ea173e8
GM
7644 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P)))
7645 PROP (TOOL_BAR_ITEM_SELECTED_P)
7646 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P));
7ee32cda
GM
7647
7648 return 1;
7649
7650#undef PROP
7651}
7652
7653
9ea173e8
GM
7654/* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7655 that can be reused. */
7ee32cda
GM
7656
7657static void
9ea173e8 7658init_tool_bar_items (reuse)
7ee32cda
GM
7659 Lisp_Object reuse;
7660{
7661 if (VECTORP (reuse))
9ea173e8 7662 tool_bar_items_vector = reuse;
7ee32cda 7663 else
9ea173e8
GM
7664 tool_bar_items_vector = Fmake_vector (make_number (64), Qnil);
7665 ntool_bar_items = 0;
7ee32cda
GM
7666}
7667
7668
9ea173e8
GM
7669/* Append parsed tool bar item properties from
7670 tool_bar_item_properties */
7ee32cda
GM
7671
7672static void
9ea173e8 7673append_tool_bar_item ()
7ee32cda
GM
7674{
7675 Lisp_Object *to, *from;
7676
9ea173e8
GM
7677 /* Enlarge tool_bar_items_vector if necessary. */
7678 if (ntool_bar_items + TOOL_BAR_ITEM_NSLOTS
7679 >= XVECTOR (tool_bar_items_vector)->size)
7ee32cda
GM
7680 {
7681 Lisp_Object new_vector;
9ea173e8 7682 int old_size = XVECTOR (tool_bar_items_vector)->size;
7ee32cda
GM
7683
7684 new_vector = Fmake_vector (make_number (2 * old_size), Qnil);
9ea173e8 7685 bcopy (XVECTOR (tool_bar_items_vector)->contents,
7ee32cda
GM
7686 XVECTOR (new_vector)->contents,
7687 old_size * sizeof (Lisp_Object));
9ea173e8 7688 tool_bar_items_vector = new_vector;
7ee32cda
GM
7689 }
7690
9ea173e8
GM
7691 /* Append entries from tool_bar_item_properties to the end of
7692 tool_bar_items_vector. */
7693 to = XVECTOR (tool_bar_items_vector)->contents + ntool_bar_items;
7694 from = XVECTOR (tool_bar_item_properties)->contents;
7695 bcopy (from, to, TOOL_BAR_ITEM_NSLOTS * sizeof *to);
7696 ntool_bar_items += TOOL_BAR_ITEM_NSLOTS;
7ee32cda
GM
7697}
7698
7699
7700
7701
e8886a1d 7702\f
dcc408a0
RS
7703/* Read a character using menus based on maps in the array MAPS.
7704 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7705 Return t if we displayed a menu but the user rejected it.
7d6de002
RS
7706
7707 PREV_EVENT is the previous input event, or nil if we are reading
7708 the first event of a key sequence.
7709
83d68044 7710 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
6569cc8d 7711 if we used a mouse menu to read the input, or zero otherwise. If
83d68044 7712 USED_MOUSE_MENU is null, we don't dereference it.
284f4730
JB
7713
7714 The prompting is done based on the prompt-string of the map
df0f2ba1 7715 and the strings associated with various map elements.
8150596a
RS
7716
7717 This can be done with X menus or with menus put in the minibuf.
7718 These are done in different ways, depending on how the input will be read.
7719 Menus using X are done after auto-saving in read-char, getting the input
7720 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7721 and do auto-saving in the inner call of read_char. */
284f4730 7722
7617111f 7723static Lisp_Object
8150596a 7724read_char_x_menu_prompt (nmaps, maps, prev_event, used_mouse_menu)
7d6de002
RS
7725 int nmaps;
7726 Lisp_Object *maps;
7727 Lisp_Object prev_event;
7728 int *used_mouse_menu;
284f4730 7729{
7d6de002 7730 int mapno;
14e40288 7731 register Lisp_Object name = Qnil;
7d6de002 7732
6569cc8d
JB
7733 if (used_mouse_menu)
7734 *used_mouse_menu = 0;
284f4730
JB
7735
7736 /* Use local over global Menu maps */
7737
7d6de002
RS
7738 if (! menu_prompting)
7739 return Qnil;
7740
03361bcc
RS
7741 /* Optionally disregard all but the global map. */
7742 if (inhibit_local_menu_bar_menus)
7743 {
7744 maps += (nmaps - 1);
7745 nmaps = 1;
7746 }
7747
7d6de002
RS
7748 /* Get the menu name from the first map that has one (a prompt string). */
7749 for (mapno = 0; mapno < nmaps; mapno++)
7750 {
bdb7aa47 7751 name = Fkeymap_prompt (maps[mapno]);
7d6de002
RS
7752 if (!NILP (name))
7753 break;
7754 }
284f4730 7755
7d6de002 7756 /* If we don't have any menus, just read a character normally. */
fa113341 7757 if (!STRINGP (name))
7d6de002
RS
7758 return Qnil;
7759
1f5b1641 7760#ifdef HAVE_MENUS
7d6de002
RS
7761 /* If we got to this point via a mouse click,
7762 use a real menu for mouse selection. */
5a8d99e0 7763 if (EVENT_HAS_PARAMETERS (prev_event)
7539e11f
KR
7764 && !EQ (XCAR (prev_event), Qmenu_bar)
7765 && !EQ (XCAR (prev_event), Qtool_bar))
7d6de002
RS
7766 {
7767 /* Display the menu and get the selection. */
7768 Lisp_Object *realmaps
7769 = (Lisp_Object *) alloca (nmaps * sizeof (Lisp_Object));
7770 Lisp_Object value;
7771 int nmaps1 = 0;
7772
7773 /* Use the maps that are not nil. */
7774 for (mapno = 0; mapno < nmaps; mapno++)
7775 if (!NILP (maps[mapno]))
7776 realmaps[nmaps1++] = maps[mapno];
7777
7778 value = Fx_popup_menu (prev_event, Flist (nmaps1, realmaps));
663258f2
JB
7779 if (CONSP (value))
7780 {
68f297c5
RS
7781 Lisp_Object tem;
7782
7539e11f 7783 record_menu_key (XCAR (value));
8eb4d8ef 7784
68f297c5
RS
7785 /* If we got multiple events, unread all but
7786 the first.
7787 There is no way to prevent those unread events
7788 from showing up later in last_nonmenu_event.
7789 So turn symbol and integer events into lists,
7790 to indicate that they came from a mouse menu,
7791 so that when present in last_nonmenu_event
7792 they won't confuse things. */
f4e05d97 7793 for (tem = XCDR (value); !NILP (tem); tem = XCDR (tem))
8eb4d8ef 7794 {
7539e11f
KR
7795 record_menu_key (XCAR (tem));
7796 if (SYMBOLP (XCAR (tem))
7797 || INTEGERP (XCAR (tem)))
f3fbd155 7798 XSETCAR (tem, Fcons (XCAR (tem), Qdisabled));
8eb4d8ef 7799 }
68f297c5 7800
663258f2
JB
7801 /* If we got more than one event, put all but the first
7802 onto this list to be read later.
7803 Return just the first event now. */
24597608 7804 Vunread_command_events
7539e11f
KR
7805 = nconc2 (XCDR (value), Vunread_command_events);
7806 value = XCAR (value);
663258f2 7807 }
1c90c381 7808 else if (NILP (value))
dcc408a0 7809 value = Qt;
6569cc8d
JB
7810 if (used_mouse_menu)
7811 *used_mouse_menu = 1;
7d6de002
RS
7812 return value;
7813 }
1f5b1641 7814#endif /* HAVE_MENUS */
8150596a
RS
7815 return Qnil ;
7816}
7817
af2b7cc9
KS
7818/* Buffer in use so far for the minibuf prompts for menu keymaps.
7819 We make this bigger when necessary, and never free it. */
7820static char *read_char_minibuf_menu_text;
7821/* Size of that buffer. */
7822static int read_char_minibuf_menu_width;
7823
8150596a 7824static Lisp_Object
24597608 7825read_char_minibuf_menu_prompt (commandflag, nmaps, maps)
8150596a
RS
7826 int commandflag ;
7827 int nmaps;
7828 Lisp_Object *maps;
7829{
7830 int mapno;
7831 register Lisp_Object name;
af2b7cc9 7832 int nlength;
14e40288 7833 /* FIXME: Use the minibuffer's frame width. */
af2b7cc9 7834 int width = FRAME_WIDTH (SELECTED_FRAME ()) - 4;
8150596a 7835 int idx = -1;
af2b7cc9 7836 int nobindings = 1;
8150596a 7837 Lisp_Object rest, vector;
af2b7cc9 7838 char *menu;
8150596a 7839
8c907a56 7840 vector = Qnil;
7189cad8 7841 name = Qnil;
8c907a56 7842
8150596a
RS
7843 if (! menu_prompting)
7844 return Qnil;
7845
af2b7cc9
KS
7846 /* Make sure we have a big enough buffer for the menu text. */
7847 if (read_char_minibuf_menu_text == 0)
7848 {
7849 read_char_minibuf_menu_width = width + 4;
7850 read_char_minibuf_menu_text = (char *) xmalloc (width + 4);
7851 }
7852 else if (width + 4 > read_char_minibuf_menu_width)
7853 {
7854 read_char_minibuf_menu_width = width + 4;
7855 read_char_minibuf_menu_text
7856 = (char *) xrealloc (read_char_minibuf_menu_text, width + 4);
7857 }
7858 menu = read_char_minibuf_menu_text;
7859
8150596a
RS
7860 /* Get the menu name from the first map that has one (a prompt string). */
7861 for (mapno = 0; mapno < nmaps; mapno++)
7862 {
bdb7aa47 7863 name = Fkeymap_prompt (maps[mapno]);
8150596a
RS
7864 if (!NILP (name))
7865 break;
7866 }
7867
7868 /* If we don't have any menus, just read a character normally. */
fa113341 7869 if (!STRINGP (name))
8150596a 7870 return Qnil;
284f4730 7871
af2b7cc9 7872 /* Prompt string always starts with map's prompt, and a space. */
d5db4077
KR
7873 strcpy (menu, SDATA (name));
7874 nlength = SBYTES (name);
af2b7cc9
KS
7875 menu[nlength++] = ':';
7876 menu[nlength++] = ' ';
7877 menu[nlength] = 0;
7878
7d6de002
RS
7879 /* Start prompting at start of first map. */
7880 mapno = 0;
7881 rest = maps[mapno];
284f4730 7882
af2b7cc9
KS
7883 /* Present the documented bindings, a line at a time. */
7884 while (1)
284f4730 7885 {
af2b7cc9
KS
7886 int notfirst = 0;
7887 int i = nlength;
7888 Lisp_Object obj;
7889 int ch;
7890 Lisp_Object orig_defn_macro;
284f4730 7891
af2b7cc9
KS
7892 /* Loop over elements of map. */
7893 while (i < width)
284f4730 7894 {
af2b7cc9 7895 Lisp_Object elt;
284f4730 7896
af2b7cc9
KS
7897 /* If reached end of map, start at beginning of next map. */
7898 if (NILP (rest))
7899 {
7900 mapno++;
7901 /* At end of last map, wrap around to first map if just starting,
7902 or end this line if already have something on it. */
7903 if (mapno == nmaps)
7904 {
7905 mapno = 0;
7906 if (notfirst || nobindings) break;
7907 }
7908 rest = maps[mapno];
7909 }
7d6de002 7910
af2b7cc9
KS
7911 /* Look at the next element of the map. */
7912 if (idx >= 0)
7913 elt = XVECTOR (vector)->contents[idx];
7914 else
7915 elt = Fcar_safe (rest);
7d6de002 7916
af2b7cc9 7917 if (idx < 0 && VECTORP (elt))
284f4730 7918 {
af2b7cc9
KS
7919 /* If we found a dense table in the keymap,
7920 advanced past it, but start scanning its contents. */
7921 rest = Fcdr_safe (rest);
7922 vector = elt;
7923 idx = 0;
284f4730 7924 }
7d6de002
RS
7925 else
7926 {
af2b7cc9
KS
7927 /* An ordinary element. */
7928 Lisp_Object event, tem;
7d6de002 7929
af2b7cc9
KS
7930 if (idx < 0)
7931 {
7932 event = Fcar_safe (elt); /* alist */
7933 elt = Fcdr_safe (elt);
7934 }
7935 else
7936 {
7937 XSETINT (event, idx); /* vector */
7938 }
284f4730 7939
af2b7cc9
KS
7940 /* Ignore the element if it has no prompt string. */
7941 if (INTEGERP (event) && parse_menu_item (elt, 0, -1))
7942 {
7943 /* 1 if the char to type matches the string. */
7944 int char_matches;
7945 Lisp_Object upcased_event, downcased_event;
7946 Lisp_Object desc = Qnil;
7947 Lisp_Object s
7948 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_NAME];
7949
7950 upcased_event = Fupcase (event);
7951 downcased_event = Fdowncase (event);
d5db4077
KR
7952 char_matches = (XINT (upcased_event) == SREF (s, 0)
7953 || XINT (downcased_event) == SREF (s, 0));
af2b7cc9
KS
7954 if (! char_matches)
7955 desc = Fsingle_key_description (event, Qnil);
7956
7957#if 0 /* It is redundant to list the equivalent key bindings because
7958 the prefix is what the user has already typed. */
7959 tem
7960 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_KEYEQ];
7961 if (!NILP (tem))
7962 /* Insert equivalent keybinding. */
7963 s = concat2 (s, tem);
7964#endif
7965 tem
7966 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_TYPE];
7967 if (EQ (tem, QCradio) || EQ (tem, QCtoggle))
7968 {
7969 /* Insert button prefix. */
7970 Lisp_Object selected
7971 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_SELECTED];
7972 if (EQ (tem, QCradio))
7973 tem = build_string (NILP (selected) ? "(*) " : "( ) ");
7974 else
7975 tem = build_string (NILP (selected) ? "[X] " : "[ ] ");
7976 s = concat2 (tem, s);
7977 }
7978
7979
7980 /* If we have room for the prompt string, add it to this line.
7981 If this is the first on the line, always add it. */
d5db4077
KR
7982 if ((SCHARS (s) + i + 2
7983 + (char_matches ? 0 : SCHARS (desc) + 3))
af2b7cc9
KS
7984 < width
7985 || !notfirst)
7986 {
7987 int thiswidth;
7988
7989 /* Punctuate between strings. */
7990 if (notfirst)
7991 {
7992 strcpy (menu + i, ", ");
7993 i += 2;
7994 }
7995 notfirst = 1;
7996 nobindings = 0 ;
7997
7998 /* If the char to type doesn't match the string's
7999 first char, explicitly show what char to type. */
8000 if (! char_matches)
8001 {
8002 /* Add as much of string as fits. */
d5db4077 8003 thiswidth = SCHARS (desc);
af2b7cc9
KS
8004 if (thiswidth + i > width)
8005 thiswidth = width - i;
d5db4077 8006 bcopy (SDATA (desc), menu + i, thiswidth);
af2b7cc9
KS
8007 i += thiswidth;
8008 strcpy (menu + i, " = ");
8009 i += 3;
8010 }
8011
8012 /* Add as much of string as fits. */
d5db4077 8013 thiswidth = SCHARS (s);
af2b7cc9
KS
8014 if (thiswidth + i > width)
8015 thiswidth = width - i;
d5db4077 8016 bcopy (SDATA (s), menu + i, thiswidth);
af2b7cc9
KS
8017 i += thiswidth;
8018 menu[i] = 0;
8019 }
8020 else
8021 {
8022 /* If this element does not fit, end the line now,
8023 and save the element for the next line. */
8024 strcpy (menu + i, "...");
8025 break;
8026 }
8027 }
8028
8029 /* Move past this element. */
8030 if (idx >= 0 && idx + 1 >= XVECTOR (vector)->size)
8031 /* Handle reaching end of dense table. */
8032 idx = -1;
8033 if (idx >= 0)
8034 idx++;
8035 else
8036 rest = Fcdr_safe (rest);
8037 }
325309f5 8038 }
8150596a 8039
af2b7cc9
KS
8040 /* Prompt with that and read response. */
8041 message2_nolog (menu, strlen (menu),
8042 ! NILP (current_buffer->enable_multibyte_characters));
284f4730 8043
af2b7cc9
KS
8044 /* Make believe its not a keyboard macro in case the help char
8045 is pressed. Help characters are not recorded because menu prompting
8046 is not used on replay.
8047 */
8048 orig_defn_macro = current_kboard->defining_kbd_macro;
8049 current_kboard->defining_kbd_macro = Qnil;
8050 do
8051 obj = read_char (commandflag, 0, 0, Qt, 0);
8052 while (BUFFERP (obj));
8053 current_kboard->defining_kbd_macro = orig_defn_macro;
284f4730 8054
af2b7cc9
KS
8055 if (!INTEGERP (obj))
8056 return obj;
8057 else
8058 ch = XINT (obj);
8059
8060 if (! EQ (obj, menu_prompt_more_char)
8061 && (!INTEGERP (menu_prompt_more_char)
8062 || ! EQ (obj, make_number (Ctl (XINT (menu_prompt_more_char))))))
8063 {
8064 if (!NILP (current_kboard->defining_kbd_macro))
8065 store_kbd_macro_char (obj);
8066 return obj;
8067 }
8068 /* Help char - go round again */
8069 }
284f4730 8070}
284f4730
JB
8071\f
8072/* Reading key sequences. */
8073
8074/* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8075 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8076 keymap, or nil otherwise. Return the index of the first keymap in
8077 which KEY has any binding, or NMAPS if no map has a binding.
8078
8079 If KEY is a meta ASCII character, treat it like meta-prefix-char
8080 followed by the corresponding non-meta character. Keymaps in
8081 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8082 NEXT.
8083
88cb0656
JB
8084 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8085 unmodified.
8086
569871d2 8087 NEXT may be the same array as CURRENT. */
284f4730
JB
8088
8089static int
4e50f26a 8090follow_key (key, nmaps, current, defs, next)
284f4730
JB
8091 Lisp_Object key;
8092 Lisp_Object *current, *defs, *next;
8093 int nmaps;
8094{
8095 int i, first_binding;
569871d2 8096 int did_meta = 0;
284f4730 8097
284f4730
JB
8098 first_binding = nmaps;
8099 for (i = nmaps - 1; i >= 0; i--)
8100 {
8101 if (! NILP (current[i]))
8102 {
569871d2
RS
8103 Lisp_Object map;
8104 if (did_meta)
8105 map = defs[i];
8106 else
8107 map = current[i];
8108
db785038 8109 defs[i] = access_keymap (map, key, 1, 0, 1);
284f4730
JB
8110 if (! NILP (defs[i]))
8111 first_binding = i;
8112 }
8113 else
8114 defs[i] = Qnil;
8115 }
8116
284f4730 8117 /* Given the set of bindings we've found, produce the next set of maps. */
0a7f1fc0
JB
8118 if (first_binding < nmaps)
8119 for (i = 0; i < nmaps; i++)
02067692 8120 next[i] = NILP (defs[i]) ? Qnil : get_keymap (defs[i], 0, 1);
284f4730
JB
8121
8122 return first_binding;
8123}
8124
a7f26f28
SM
8125/* Structure used to keep track of partial application of key remapping
8126 such as Vfunction_key_map and Vkey_translation_map. */
8127typedef struct keyremap
8128{
8129 Lisp_Object map;
8130 int start, end;
8131} keyremap;
8132
8133
df0f2ba1 8134/* Read a sequence of keys that ends with a non prefix character,
f4255cd1
JB
8135 storing it in KEYBUF, a buffer of size BUFSIZE.
8136 Prompt with PROMPT.
284f4730 8137 Return the length of the key sequence stored.
dcc408a0 8138 Return -1 if the user rejected a command menu.
284f4730 8139
f4255cd1
JB
8140 Echo starting immediately unless `prompt' is 0.
8141
8142 Where a key sequence ends depends on the currently active keymaps.
8143 These include any minor mode keymaps active in the current buffer,
8144 the current buffer's local map, and the global map.
8145
8146 If a key sequence has no other bindings, we check Vfunction_key_map
8147 to see if some trailing subsequence might be the beginning of a
8148 function key's sequence. If so, we try to read the whole function
8149 key, and substitute its symbolic name into the key sequence.
8150
fbcd35bd
JB
8151 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8152 `double-' events into similar click events, if that would make them
8153 bound. We try to turn `triple-' events first into `double-' events,
8154 then into clicks.
f4255cd1
JB
8155
8156 If we get a mouse click in a mode line, vertical divider, or other
8157 non-text area, we treat the click as if it were prefixed by the
8158 symbol denoting that area - `mode-line', `vertical-line', or
8159 whatever.
8160
8161 If the sequence starts with a mouse click, we read the key sequence
8162 with respect to the buffer clicked on, not the current buffer.
284f4730 8163
f4255cd1
JB
8164 If the user switches frames in the midst of a key sequence, we put
8165 off the switch-frame event until later; the next call to
f571ae0d
RS
8166 read_char will return it.
8167
8168 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8169 from the selected window's buffer. */
48e416d4 8170
284f4730 8171static int
ce98e608 8172read_key_sequence (keybuf, bufsize, prompt, dont_downcase_last,
f571ae0d 8173 can_return_switch_frame, fix_current_buffer)
284f4730
JB
8174 Lisp_Object *keybuf;
8175 int bufsize;
84d91fda 8176 Lisp_Object prompt;
309b0fc8 8177 int dont_downcase_last;
ce98e608 8178 int can_return_switch_frame;
f571ae0d 8179 int fix_current_buffer;
284f4730 8180{
db14cfc5 8181 volatile Lisp_Object from_string;
aed13378 8182 volatile int count = SPECPDL_INDEX ();
f4255cd1 8183
284f4730 8184 /* How many keys there are in the current key sequence. */
8c907a56 8185 volatile int t;
284f4730 8186
284f4730
JB
8187 /* The length of the echo buffer when we started reading, and
8188 the length of this_command_keys when we started reading. */
8c907a56
GM
8189 volatile int echo_start;
8190 volatile int keys_start;
284f4730
JB
8191
8192 /* The number of keymaps we're scanning right now, and the number of
8193 keymaps we have allocated space for. */
8c907a56
GM
8194 volatile int nmaps;
8195 volatile int nmaps_allocated = 0;
284f4730 8196
284f4730
JB
8197 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8198 the current keymaps. */
8c907a56 8199 Lisp_Object *volatile defs = NULL;
284f4730 8200
f4255cd1
JB
8201 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8202 in the current keymaps, or nil where it is not a prefix. */
8c907a56 8203 Lisp_Object *volatile submaps = NULL;
f4255cd1 8204
e0dff5f6 8205 /* The local map to start out with at start of key sequence. */
8c907a56 8206 volatile Lisp_Object orig_local_map;
e0dff5f6 8207
30690496
DL
8208 /* The map from the `keymap' property to start out with at start of
8209 key sequence. */
8c907a56 8210 volatile Lisp_Object orig_keymap;
30690496 8211
e0dff5f6
RS
8212 /* 1 if we have already considered switching to the local-map property
8213 of the place where a mouse click occurred. */
8c907a56 8214 volatile int localized_local_map = 0;
e0dff5f6 8215
f4255cd1
JB
8216 /* The index in defs[] of the first keymap that has a binding for
8217 this key sequence. In other words, the lowest i such that
8218 defs[i] is non-nil. */
8c907a56 8219 volatile int first_binding;
7189cad8 8220 /* Index of the first key that has no binding.
a7f26f28 8221 It is useless to try fkey.start larger than that. */
7189cad8 8222 volatile int first_unbound;
284f4730 8223
f4255cd1 8224 /* If t < mock_input, then KEYBUF[t] should be read as the next
253598e4
JB
8225 input key.
8226
8227 We use this to recover after recognizing a function key. Once we
8228 realize that a suffix of the current key sequence is actually a
8229 function key's escape sequence, we replace the suffix with the
8230 function key's binding from Vfunction_key_map. Now keybuf
f4255cd1
JB
8231 contains a new and different key sequence, so the echo area,
8232 this_command_keys, and the submaps and defs arrays are wrong. In
8233 this situation, we set mock_input to t, set t to 0, and jump to
8234 restart_sequence; the loop will read keys from keybuf up until
8235 mock_input, thus rebuilding the state; and then it will resume
8236 reading characters from the keyboard. */
8c907a56 8237 volatile int mock_input = 0;
284f4730 8238
253598e4 8239 /* If the sequence is unbound in submaps[], then
a7f26f28
SM
8240 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8241 and fkey.map is its binding.
253598e4 8242
f4255cd1
JB
8243 These might be > t, indicating that all function key scanning
8244 should hold off until t reaches them. We do this when we've just
8245 recognized a function key, to avoid searching for the function
8246 key's again in Vfunction_key_map. */
a7f26f28 8247 volatile keyremap fkey;
284f4730 8248
a612e298 8249 /* Likewise, for key_translation_map. */
a7f26f28 8250 volatile keyremap keytran;
a612e298 8251
cd21b839
JB
8252 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
8253 we put it off for later. While we're reading, we keep the event here. */
8c907a56 8254 volatile Lisp_Object delayed_switch_frame;
cd21b839 8255
51763820
BF
8256 /* See the comment below... */
8257#if defined (GOBBLE_FIRST_EVENT)
4efda7dd 8258 Lisp_Object first_event;
51763820 8259#endif
4efda7dd 8260
8c907a56
GM
8261 volatile Lisp_Object original_uppercase;
8262 volatile int original_uppercase_position = -1;
309b0fc8 8263
bc536d84 8264 /* Gets around Microsoft compiler limitations. */
309b0fc8 8265 int dummyflag = 0;
bc536d84 8266
3b9189f8
RS
8267 struct buffer *starting_buffer;
8268
2dc00208
GM
8269 /* List of events for which a fake prefix key has been generated. */
8270 volatile Lisp_Object fake_prefixed_keys = Qnil;
8271
03cee6ae 8272#if defined (GOBBLE_FIRST_EVENT)
4efda7dd 8273 int junk;
03cee6ae 8274#endif
4efda7dd 8275
2dc00208
GM
8276 struct gcpro gcpro1;
8277
8278 GCPRO1 (fake_prefixed_keys);
7d18f9ae
RS
8279 raw_keybuf_count = 0;
8280
4efda7dd
RS
8281 last_nonmenu_event = Qnil;
8282
8283 delayed_switch_frame = Qnil;
a7f26f28
SM
8284 fkey.map = Vfunction_key_map;
8285 keytran.map = Vkey_translation_map;
8286 /* If there is no translation-map, turn off scanning. */
8287 fkey.start = fkey.end = KEYMAPP (fkey.map) ? 0 : bufsize + 1;
8288 keytran.start = keytran.end = KEYMAPP (keytran.map) ? 0 : bufsize + 1;
a612e298 8289
284f4730
JB
8290 if (INTERACTIVE)
8291 {
84d91fda 8292 if (!NILP (prompt))
a4ef85ee 8293 echo_prompt (prompt);
f2647d04
DL
8294 else if (cursor_in_echo_area
8295 && (FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
8296 && NILP (Fzerop (Vecho_keystrokes)))
284f4730
JB
8297 /* This doesn't put in a dash if the echo buffer is empty, so
8298 you don't always see a dash hanging out in the minibuffer. */
8299 echo_dash ();
284f4730
JB
8300 }
8301
f4255cd1
JB
8302 /* Record the initial state of the echo area and this_command_keys;
8303 we will need to restore them if we replay a key sequence. */
0a7f1fc0 8304 if (INTERACTIVE)
df0f2ba1 8305 echo_start = echo_length ();
f4255cd1 8306 keys_start = this_command_key_count;
6321824f 8307 this_single_command_key_start = keys_start;
0a7f1fc0 8308
51763820
BF
8309#if defined (GOBBLE_FIRST_EVENT)
8310 /* This doesn't quite work, because some of the things that read_char
8311 does cannot safely be bypassed. It seems too risky to try to make
df0f2ba1 8312 this work right. */
51763820 8313
4efda7dd
RS
8314 /* Read the first char of the sequence specially, before setting
8315 up any keymaps, in case a filter runs and switches buffers on us. */
84d91fda 8316 first_event = read_char (NILP (prompt), 0, submaps, last_nonmenu_event,
4efda7dd 8317 &junk);
51763820 8318#endif /* GOBBLE_FIRST_EVENT */
4efda7dd 8319
24a40fbb
GM
8320 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
8321 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
db14cfc5 8322 from_string = Qnil;
e0dff5f6 8323
7b4aedb9
JB
8324 /* We jump here when the key sequence has been thoroughly changed, and
8325 we need to rescan it starting from the beginning. When we jump here,
8326 keybuf[0..mock_input] holds the sequence we should reread. */
07d2b8de 8327 replay_sequence:
7b4aedb9 8328
3b9189f8 8329 starting_buffer = current_buffer;
7189cad8 8330 first_unbound = bufsize + 1;
3b9189f8 8331
f4255cd1 8332 /* Build our list of keymaps.
07d2b8de
JB
8333 If we recognize a function key and replace its escape sequence in
8334 keybuf with its symbol, or if the sequence starts with a mouse
8335 click and we need to switch buffers, we jump back here to rebuild
8336 the initial keymaps from the current buffer. */
4cbedc16 8337 nmaps = 0;
284f4730 8338
4cbedc16
RS
8339 if (!NILP (current_kboard->Voverriding_terminal_local_map)
8340 || !NILP (Voverriding_local_map))
8341 {
8342 if (3 > nmaps_allocated)
8343 {
8344 submaps = (Lisp_Object *) alloca (3 * sizeof (submaps[0]));
8345 defs = (Lisp_Object *) alloca (3 * sizeof (defs[0]));
8346 nmaps_allocated = 3;
8347 }
8348 if (!NILP (current_kboard->Voverriding_terminal_local_map))
8349 submaps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
8350 if (!NILP (Voverriding_local_map))
8351 submaps[nmaps++] = Voverriding_local_map;
8352 }
8353 else
8354 {
4cbedc16
RS
8355 int nminor;
8356 int total;
8357 Lisp_Object *maps;
8358
8359 nminor = current_minor_maps (0, &maps);
8360 total = nminor + (!NILP (orig_keymap) ? 3 : 2);
8361
8362 if (total > nmaps_allocated)
8363 {
8364 submaps = (Lisp_Object *) alloca (total * sizeof (submaps[0]));
8365 defs = (Lisp_Object *) alloca (total * sizeof (defs[0]));
8366 nmaps_allocated = total;
8367 }
8368
8369 if (!NILP (orig_keymap))
8370 submaps[nmaps++] = orig_keymap;
8371
7d1c4866 8372 bcopy (maps, (void *) (submaps + nmaps),
4cbedc16
RS
8373 nminor * sizeof (submaps[0]));
8374
8375 nmaps += nminor;
8376
8377 submaps[nmaps++] = orig_local_map;
8378 }
8379 submaps[nmaps++] = current_global_map;
284f4730
JB
8380
8381 /* Find an accurate initial value for first_binding. */
8382 for (first_binding = 0; first_binding < nmaps; first_binding++)
253598e4 8383 if (! NILP (submaps[first_binding]))
284f4730
JB
8384 break;
8385
3b9189f8 8386 /* Start from the beginning in keybuf. */
f4255cd1
JB
8387 t = 0;
8388
8389 /* These are no-ops the first time through, but if we restart, they
8390 revert the echo area and this_command_keys to their original state. */
8391 this_command_key_count = keys_start;
df0f2ba1 8392 if (INTERACTIVE && t < mock_input)
f4255cd1
JB
8393 echo_truncate (echo_start);
8394
cca310da
JB
8395 /* If the best binding for the current key sequence is a keymap, or
8396 we may be looking at a function key's escape sequence, keep on
8397 reading. */
a7f26f28
SM
8398 while (first_binding < nmaps
8399 /* Keep reading as long as there's a prefix binding. */
8400 ? !NILP (submaps[first_binding])
e9bf89a0
RS
8401 /* Don't return in the middle of a possible function key sequence,
8402 if the only bindings we found were via case conversion.
8403 Thus, if ESC O a has a function-key-map translation
8404 and ESC o has a binding, don't return after ESC O,
8405 so that we can translate ESC O plus the next character. */
a7f26f28 8406 : (fkey.start < t || keytran.start < t))
284f4730
JB
8407 {
8408 Lisp_Object key;
7d6de002 8409 int used_mouse_menu = 0;
284f4730 8410
7b4aedb9
JB
8411 /* Where the last real key started. If we need to throw away a
8412 key that has expanded into more than one element of keybuf
8413 (say, a mouse click on the mode line which is being treated
8414 as [mode-line (mouse-...)], then we backtrack to this point
8415 of keybuf. */
8c907a56 8416 volatile int last_real_key_start;
7b4aedb9 8417
0a7f1fc0
JB
8418 /* These variables are analogous to echo_start and keys_start;
8419 while those allow us to restart the entire key sequence,
8420 echo_local_start and keys_local_start allow us to throw away
8421 just one key. */
8c907a56 8422 volatile int echo_local_start, keys_local_start, local_first_binding;
f4255cd1 8423
2cf4b7b2 8424 /* key-translation-map is applied *after* function-key-map. */
a7f26f28 8425 eassert (keytran.end <= fkey.start);
7189cad8 8426
a7f26f28 8427 if (first_unbound < fkey.start && first_unbound < keytran.start)
7189cad8
SM
8428 { /* The prefix upto first_unbound has no binding and has
8429 no translation left to do either, so we know it's unbound.
8430 If we don't stop now, we risk staying here indefinitely
8431 (if the user keeps entering fkey or keytran prefixes
8432 like C-c ESC ESC ESC ESC ...) */
8433 int i;
8434 for (i = first_unbound + 1; i < t; i++)
8435 keybuf[i - first_unbound - 1] = keybuf[i];
8436 mock_input = t - first_unbound - 1;
a7f26f28
SM
8437 fkey.end = fkey.start -= first_unbound + 1;
8438 fkey.map = Vfunction_key_map;
8439 keytran.end = keytran.start -= first_unbound + 1;
8440 keytran.map = Vkey_translation_map;
7189cad8
SM
8441 goto replay_sequence;
8442 }
8443
284f4730 8444 if (t >= bufsize)
3fe8e9a2 8445 error ("Key sequence too long");
284f4730 8446
f4255cd1
JB
8447 if (INTERACTIVE)
8448 echo_local_start = echo_length ();
8449 keys_local_start = this_command_key_count;
8450 local_first_binding = first_binding;
df0f2ba1 8451
f4255cd1 8452 replay_key:
0a7f1fc0 8453 /* These are no-ops, unless we throw away a keystroke below and
f4255cd1
JB
8454 jumped back up to replay_key; in that case, these restore the
8455 variables to their original state, allowing us to replay the
0a7f1fc0 8456 loop. */
40932d1a 8457 if (INTERACTIVE && t < mock_input)
f4255cd1 8458 echo_truncate (echo_local_start);
0a7f1fc0
JB
8459 this_command_key_count = keys_local_start;
8460 first_binding = local_first_binding;
8461
7e85b935
RS
8462 /* By default, assume each event is "real". */
8463 last_real_key_start = t;
8464
f4255cd1 8465 /* Does mock_input indicate that we are re-reading a key sequence? */
284f4730
JB
8466 if (t < mock_input)
8467 {
8468 key = keybuf[t];
8469 add_command_key (key);
f2647d04
DL
8470 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
8471 && NILP (Fzerop (Vecho_keystrokes)))
a98ea3f9 8472 echo_char (key);
284f4730 8473 }
253598e4
JB
8474
8475 /* If not, we should actually read a character. */
284f4730
JB
8476 else
8477 {
beecf6a1 8478 {
c5fdd383
KH
8479#ifdef MULTI_KBOARD
8480 KBOARD *interrupted_kboard = current_kboard;
788f89eb 8481 struct frame *interrupted_frame = SELECTED_FRAME ();
c5fdd383 8482 if (setjmp (wrong_kboard_jmpbuf))
beecf6a1 8483 {
5798cf15
KH
8484 if (!NILP (delayed_switch_frame))
8485 {
c5fdd383 8486 interrupted_kboard->kbd_queue
5798cf15 8487 = Fcons (delayed_switch_frame,
c5fdd383 8488 interrupted_kboard->kbd_queue);
5798cf15
KH
8489 delayed_switch_frame = Qnil;
8490 }
beecf6a1 8491 while (t > 0)
c5fdd383
KH
8492 interrupted_kboard->kbd_queue
8493 = Fcons (keybuf[--t], interrupted_kboard->kbd_queue);
5798cf15
KH
8494
8495 /* If the side queue is non-empty, ensure it begins with a
8496 switch-frame, so we'll replay it in the right context. */
c5fdd383 8497 if (CONSP (interrupted_kboard->kbd_queue)
7539e11f 8498 && (key = XCAR (interrupted_kboard->kbd_queue),
5798cf15
KH
8499 !(EVENT_HAS_PARAMETERS (key)
8500 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key)),
8501 Qswitch_frame))))
df0f2ba1
KH
8502 {
8503 Lisp_Object frame;
8504 XSETFRAME (frame, interrupted_frame);
c5fdd383 8505 interrupted_kboard->kbd_queue
df0f2ba1 8506 = Fcons (make_lispy_switch_frame (frame),
c5fdd383 8507 interrupted_kboard->kbd_queue);
df0f2ba1 8508 }
beecf6a1 8509 mock_input = 0;
24a40fbb
GM
8510 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
8511 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
beecf6a1
KH
8512 goto replay_sequence;
8513 }
bded54dd 8514#endif
8c907a56
GM
8515 key = read_char (NILP (prompt), nmaps,
8516 (Lisp_Object *) submaps, last_nonmenu_event,
beecf6a1
KH
8517 &used_mouse_menu);
8518 }
284f4730 8519
dcc408a0
RS
8520 /* read_char returns t when it shows a menu and the user rejects it.
8521 Just return -1. */
8522 if (EQ (key, Qt))
7d18f9ae
RS
8523 {
8524 unbind_to (count, Qnil);
2dc00208 8525 UNGCPRO;
7d18f9ae
RS
8526 return -1;
8527 }
dcc408a0 8528
f4255cd1 8529 /* read_char returns -1 at the end of a macro.
284f4730
JB
8530 Emacs 18 handles this by returning immediately with a
8531 zero, so that's what we'll do. */
8c18cbfb 8532 if (INTEGERP (key) && XINT (key) == -1)
cd21b839 8533 {
f4255cd1 8534 t = 0;
bc536d84
RS
8535 /* The Microsoft C compiler can't handle the goto that
8536 would go here. */
309b0fc8 8537 dummyflag = 1;
bc536d84 8538 break;
cd21b839 8539 }
df0f2ba1 8540
3cb81011
KH
8541 /* If the current buffer has been changed from under us, the
8542 keymap may have changed, so replay the sequence. */
8c18cbfb 8543 if (BUFFERP (key))
3cb81011 8544 {
e431fcda
DL
8545 EMACS_TIME initial_idleness_start_time;
8546 EMACS_SET_SECS_USECS (initial_idleness_start_time,
8547 EMACS_SECS (timer_last_idleness_start_time),
8548 EMACS_USECS (timer_last_idleness_start_time));
3021d3a9
RS
8549
8550 /* Resume idle state, using the same start-time as before. */
8551 timer_start_idle ();
8552 timer_idleness_start_time = initial_idleness_start_time;
8553
3cb81011 8554 mock_input = t;
f571ae0d
RS
8555 /* Reset the current buffer from the selected window
8556 in case something changed the former and not the latter.
8557 This is to be more consistent with the behavior
8558 of the command_loop_1. */
8559 if (fix_current_buffer)
a94a4335 8560 {
788f89eb 8561 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
a94a4335
KH
8562 Fkill_emacs (Qnil);
8563 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
8564 Fset_buffer (XWINDOW (selected_window)->buffer);
8565 }
f571ae0d 8566
24a40fbb
GM
8567 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
8568 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
3cb81011
KH
8569 goto replay_sequence;
8570 }
8571
3b9189f8
RS
8572 /* If we have a quit that was typed in another frame, and
8573 quit_throw_to_read_char switched buffers,
8574 replay to get the right keymap. */
f4e05d97
GM
8575 if (INTEGERP (key)
8576 && XINT (key) == quit_char
8577 && current_buffer != starting_buffer)
3b9189f8 8578 {
7d18f9ae
RS
8579 GROW_RAW_KEYBUF;
8580 XVECTOR (raw_keybuf)->contents[raw_keybuf_count++] = key;
3b9189f8
RS
8581 keybuf[t++] = key;
8582 mock_input = t;
8583 Vquit_flag = Qnil;
24a40fbb
GM
8584 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
8585 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
3b9189f8
RS
8586 goto replay_sequence;
8587 }
3cb81011 8588
284f4730 8589 Vquit_flag = Qnil;
7d18f9ae
RS
8590
8591 if (EVENT_HAS_PARAMETERS (key)
8592 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key)), Qswitch_frame))
8593 {
8594 /* If we're at the beginning of a key sequence, and the caller
8595 says it's okay, go ahead and return this event. If we're
8596 in the midst of a key sequence, delay it until the end. */
8597 if (t > 0 || !can_return_switch_frame)
8598 {
8599 delayed_switch_frame = key;
8600 goto replay_key;
8601 }
8602 }
8603
8604 GROW_RAW_KEYBUF;
8605 XVECTOR (raw_keybuf)->contents[raw_keybuf_count++] = key;
7e85b935 8606 }
284f4730 8607
df0f2ba1 8608 /* Clicks in non-text areas get prefixed by the symbol
7e85b935
RS
8609 in their CHAR-ADDRESS field. For example, a click on
8610 the mode line is prefixed by the symbol `mode-line'.
8611
8612 Furthermore, key sequences beginning with mouse clicks
8613 are read using the keymaps of the buffer clicked on, not
8614 the current buffer. So we may have to switch the buffer
8615 here.
8616
8617 When we turn one event into two events, we must make sure
8618 that neither of the two looks like the original--so that,
8619 if we replay the events, they won't be expanded again.
8620 If not for this, such reexpansion could happen either here
8621 or when user programs play with this-command-keys. */
8622 if (EVENT_HAS_PARAMETERS (key))
8623 {
9b8eb840 8624 Lisp_Object kind;
cca310da 8625
9b8eb840 8626 kind = EVENT_HEAD_KIND (EVENT_HEAD (key));
7e85b935 8627 if (EQ (kind, Qmouse_click))
0a7f1fc0 8628 {
9b8eb840 8629 Lisp_Object window, posn;
f4255cd1 8630
9b8eb840
KH
8631 window = POSN_WINDOW (EVENT_START (key));
8632 posn = POSN_BUFFER_POSN (EVENT_START (key));
7ee32cda 8633
2cf066c3
GM
8634 if (CONSP (posn)
8635 || (!NILP (fake_prefixed_keys)
8636 && !NILP (Fmemq (key, fake_prefixed_keys))))
0a7f1fc0 8637 {
2cf066c3
GM
8638 /* We're looking a second time at an event for which
8639 we generated a fake prefix key. Set
7e85b935
RS
8640 last_real_key_start appropriately. */
8641 if (t > 0)
8642 last_real_key_start = t - 1;
cd21b839 8643 }
7e85b935
RS
8644
8645 /* Key sequences beginning with mouse clicks are
8646 read using the keymaps in the buffer clicked on,
8647 not the current buffer. If we're at the
8648 beginning of a key sequence, switch buffers. */
8649 if (last_real_key_start == 0
8c18cbfb
KH
8650 && WINDOWP (window)
8651 && BUFFERP (XWINDOW (window)->buffer)
7e85b935 8652 && XBUFFER (XWINDOW (window)->buffer) != current_buffer)
cd21b839 8653 {
7d18f9ae 8654 XVECTOR (raw_keybuf)->contents[raw_keybuf_count++] = key;
7e85b935
RS
8655 keybuf[t] = key;
8656 mock_input = t + 1;
8657
8658 /* Arrange to go back to the original buffer once we're
8659 done reading the key sequence. Note that we can't
8660 use save_excursion_{save,restore} here, because they
8661 save point as well as the current buffer; we don't
8662 want to save point, because redisplay may change it,
8663 to accommodate a Fset_window_start or something. We
8664 don't want to do this at the top of the function,
8665 because we may get input from a subprocess which
8666 wants to change the selected window and stuff (say,
8667 emacsclient). */
8668 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
8669
788f89eb 8670 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
a94a4335 8671 Fkill_emacs (Qnil);
24a40fbb 8672 set_buffer_internal (XBUFFER (XWINDOW (window)->buffer));
30690496 8673 orig_local_map = get_local_map (PT, current_buffer,
24a40fbb
GM
8674 Qlocal_map);
8675 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
7e85b935 8676 goto replay_sequence;
0a7f1fc0 8677 }
7ee32cda 8678
e0dff5f6
RS
8679 /* For a mouse click, get the local text-property keymap
8680 of the place clicked on, rather than point. */
7ee32cda 8681 if (last_real_key_start == 0
7539e11f 8682 && CONSP (XCDR (key))
e0dff5f6 8683 && ! localized_local_map)
5ec75a55 8684 {
e0dff5f6
RS
8685 Lisp_Object map_here, start, pos;
8686
8687 localized_local_map = 1;
8688 start = EVENT_START (key);
7ee32cda 8689
7539e11f 8690 if (CONSP (start) && CONSP (XCDR (start)))
e0dff5f6
RS
8691 {
8692 pos = POSN_BUFFER_POSN (start);
b78ce8fb
RS
8693 if (INTEGERP (pos)
8694 && XINT (pos) >= BEG && XINT (pos) <= Z)
e0dff5f6 8695 {
30690496 8696 map_here = get_local_map (XINT (pos),
24a40fbb 8697 current_buffer, Qlocal_map);
e0dff5f6
RS
8698 if (!EQ (map_here, orig_local_map))
8699 {
8700 orig_local_map = map_here;
8701 keybuf[t] = key;
8702 mock_input = t + 1;
5ec75a55 8703
30690496
DL
8704 goto replay_sequence;
8705 }
8706 map_here = get_local_map (XINT (pos),
24a40fbb 8707 current_buffer, Qkeymap);
30690496
DL
8708 if (!EQ (map_here, orig_keymap))
8709 {
8710 orig_keymap = map_here;
8711 keybuf[t] = key;
8712 mock_input = t + 1;
8713
e0dff5f6
RS
8714 goto replay_sequence;
8715 }
8716 }
8717 }
8718 }
8719
8720 /* Expand mode-line and scroll-bar events into two events:
8721 use posn as a fake prefix key. */
2dc00208
GM
8722 if (SYMBOLP (posn)
8723 && (NILP (fake_prefixed_keys)
8724 || NILP (Fmemq (key, fake_prefixed_keys))))
e0dff5f6 8725 {
7e85b935 8726 if (t + 1 >= bufsize)
3fe8e9a2 8727 error ("Key sequence too long");
7ee32cda 8728
2dc00208
GM
8729 keybuf[t] = posn;
8730 keybuf[t + 1] = key;
8731 mock_input = t + 2;
8732
8733 /* Record that a fake prefix key has been generated
8734 for KEY. Don't modify the event; this would
8735 prevent proper action when the event is pushed
c7f4f573 8736 back into unread-command-events. */
2dc00208 8737 fake_prefixed_keys = Fcons (key, fake_prefixed_keys);
7ee32cda
GM
8738
8739 /* If on a mode line string with a local keymap,
8740 reconsider the key sequence with that keymap. */
8741 if (CONSP (POSN_STRING (EVENT_START (key))))
8742 {
30690496 8743 Lisp_Object string, pos, map, map2;
7ee32cda
GM
8744
8745 string = POSN_STRING (EVENT_START (key));
8746 pos = XCDR (string);
8747 string = XCAR (string);
52e386c2 8748 if (XINT (pos) >= 0
d5db4077 8749 && XINT (pos) < SCHARS (string))
30690496
DL
8750 {
8751 map = Fget_text_property (pos, Qlocal_map, string);
8752 if (!NILP (map))
8753 orig_local_map = map;
8754 map2 = Fget_text_property (pos, Qkeymap, string);
8755 if (!NILP (map2))
8756 orig_keymap = map2;
8757 if (!NILP (map) || !NILP (map2))
8758 goto replay_sequence;
8759 }
7ee32cda
GM
8760 }
8761
7e85b935 8762 goto replay_key;
5ec75a55 8763 }
db14cfc5
GM
8764 else if (CONSP (POSN_STRING (EVENT_START (key)))
8765 && NILP (from_string))
8766 {
8767 /* For a click on a string, i.e. overlay string or a
8768 string displayed via the `display' property,
8769 consider `local-map' and `keymap' properties of
8770 that string. */
8771 Lisp_Object string, pos, map, map2;
8772
8773 string = POSN_STRING (EVENT_START (key));
8774 pos = XCDR (string);
8775 string = XCAR (string);
8776 if (XINT (pos) >= 0
d5db4077 8777 && XINT (pos) < SCHARS (string))
db14cfc5
GM
8778 {
8779 map = Fget_text_property (pos, Qlocal_map, string);
8780 if (!NILP (map))
8781 orig_local_map = map;
8782 map2 = Fget_text_property (pos, Qkeymap, string);
8783 if (!NILP (map2))
8784 orig_keymap = map2;
8785
8786 if (!NILP (map) || !NILP (map2))
8787 {
8788 from_string = string;
8789 goto replay_sequence;
8790 }
8791 }
8792 }
0a7f1fc0 8793 }
7539e11f 8794 else if (CONSP (XCDR (key))
7a80a6f6 8795 && CONSP (EVENT_START (key))
7539e11f 8796 && CONSP (XCDR (EVENT_START (key))))
7e85b935 8797 {
9b8eb840 8798 Lisp_Object posn;
7e85b935 8799
9b8eb840 8800 posn = POSN_BUFFER_POSN (EVENT_START (key));
7e85b935
RS
8801 /* Handle menu-bar events:
8802 insert the dummy prefix event `menu-bar'. */
9ea173e8 8803 if (EQ (posn, Qmenu_bar) || EQ (posn, Qtool_bar))
7e85b935
RS
8804 {
8805 if (t + 1 >= bufsize)
3fe8e9a2 8806 error ("Key sequence too long");
7e85b935
RS
8807 keybuf[t] = posn;
8808 keybuf[t+1] = key;
8809
8810 /* Zap the position in key, so we know that we've
8811 expanded it, and don't try to do so again. */
f3fbd155
KR
8812 POSN_BUFFER_SET_POSN (EVENT_START (key),
8813 Fcons (posn, Qnil));
7e85b935
RS
8814
8815 mock_input = t + 2;
8816 goto replay_sequence;
8817 }
8c18cbfb 8818 else if (CONSP (posn))
7e85b935
RS
8819 {
8820 /* We're looking at the second event of a
8821 sequence which we expanded before. Set
8822 last_real_key_start appropriately. */
8823 if (last_real_key_start == t && t > 0)
8824 last_real_key_start = t - 1;
8825 }
a6d53864 8826 }
284f4730 8827 }
f4255cd1
JB
8828
8829 /* We have finally decided that KEY is something we might want
8830 to look up. */
284f4730
JB
8831 first_binding = (follow_key (key,
8832 nmaps - first_binding,
253598e4 8833 submaps + first_binding,
284f4730 8834 defs + first_binding,
4e50f26a 8835 submaps + first_binding)
284f4730 8836 + first_binding);
0a7f1fc0 8837
f4255cd1 8838 /* If KEY wasn't bound, we'll try some fallbacks. */
65e0fbbf
SM
8839 if (first_binding < nmaps)
8840 /* This is needed for the following scenario:
8841 event 0: a down-event that gets dropped by calling replay_key.
8842 event 1: some normal prefix like C-h.
a7f26f28
SM
8843 After event 0, first_unbound is 0, after event 1 fkey.start
8844 and keytran.start are both 1, so when we see that C-h is bound,
65e0fbbf
SM
8845 we need to update first_unbound. */
8846 first_unbound = max (t + 1, first_unbound);
8847 else
0a7f1fc0 8848 {
9b8eb840 8849 Lisp_Object head;
7189cad8 8850
a7f26f28 8851 /* Remember the position to put an upper bound on fkey.start. */
7189cad8 8852 first_unbound = min (t, first_unbound);
0a7f1fc0 8853
9b8eb840 8854 head = EVENT_HEAD (key);
24736fbc 8855 if (help_char_p (head) && t > 0)
7e85b935
RS
8856 {
8857 read_key_sequence_cmd = Vprefix_help_command;
8858 keybuf[t++] = key;
8859 last_nonmenu_event = key;
bc536d84
RS
8860 /* The Microsoft C compiler can't handle the goto that
8861 would go here. */
309b0fc8 8862 dummyflag = 1;
0d882d52 8863 break;
7e85b935
RS
8864 }
8865
8c18cbfb 8866 if (SYMBOLP (head))
0a7f1fc0 8867 {
9b8eb840
KH
8868 Lisp_Object breakdown;
8869 int modifiers;
0a7f1fc0 8870
9b8eb840 8871 breakdown = parse_modifiers (head);
7539e11f 8872 modifiers = XINT (XCAR (XCDR (breakdown)));
559f9d04
RS
8873 /* Attempt to reduce an unbound mouse event to a simpler
8874 event that is bound:
8875 Drags reduce to clicks.
8876 Double-clicks reduce to clicks.
8877 Triple-clicks reduce to double-clicks, then to clicks.
8878 Down-clicks are eliminated.
8879 Double-downs reduce to downs, then are eliminated.
8880 Triple-downs reduce to double-downs, then to downs,
8881 then are eliminated. */
8882 if (modifiers & (down_modifier | drag_modifier
8883 | double_modifier | triple_modifier))
0a7f1fc0 8884 {
559f9d04
RS
8885 while (modifiers & (down_modifier | drag_modifier
8886 | double_modifier | triple_modifier))
fbcd35bd
JB
8887 {
8888 Lisp_Object new_head, new_click;
8889 if (modifiers & triple_modifier)
8890 modifiers ^= (double_modifier | triple_modifier);
bc536d84
RS
8891 else if (modifiers & double_modifier)
8892 modifiers &= ~double_modifier;
8893 else if (modifiers & drag_modifier)
8894 modifiers &= ~drag_modifier;
559f9d04
RS
8895 else
8896 {
8897 /* Dispose of this `down' event by simply jumping
8898 back to replay_key, to get another event.
8899
8900 Note that if this event came from mock input,
8901 then just jumping back to replay_key will just
8902 hand it to us again. So we have to wipe out any
8903 mock input.
8904
8905 We could delete keybuf[t] and shift everything
8906 after that to the left by one spot, but we'd also
8907 have to fix up any variable that points into
8908 keybuf, and shifting isn't really necessary
8909 anyway.
8910
8911 Adding prefixes for non-textual mouse clicks
8912 creates two characters of mock input, and both
8913 must be thrown away. If we're only looking at
8914 the prefix now, we can just jump back to
8915 replay_key. On the other hand, if we've already
8916 processed the prefix, and now the actual click
8917 itself is giving us trouble, then we've lost the
8918 state of the keymaps we want to backtrack to, and
8919 we need to replay the whole sequence to rebuild
8920 it.
8921
8922 Beyond that, only function key expansion could
8923 create more than two keys, but that should never
8924 generate mouse events, so it's okay to zero
8925 mock_input in that case too.
8926
65e0fbbf
SM
8927 FIXME: The above paragraph seems just plain
8928 wrong, if you consider things like
8929 xterm-mouse-mode. -stef
8930
559f9d04
RS
8931 Isn't this just the most wonderful code ever? */
8932 if (t == last_real_key_start)
8933 {
8934 mock_input = 0;
8935 goto replay_key;
8936 }
8937 else
8938 {
8939 mock_input = last_real_key_start;
8940 goto replay_sequence;
8941 }
8942 }
8943
27203ead 8944 new_head
7539e11f 8945 = apply_modifiers (modifiers, XCAR (breakdown));
27203ead
RS
8946 new_click
8947 = Fcons (new_head, Fcons (EVENT_START (key), Qnil));
fbcd35bd
JB
8948
8949 /* Look for a binding for this new key. follow_key
8950 promises that it didn't munge submaps the
8951 last time we called it, since key was unbound. */
27203ead
RS
8952 first_binding
8953 = (follow_key (new_click,
8954 nmaps - local_first_binding,
8955 submaps + local_first_binding,
8956 defs + local_first_binding,
4e50f26a 8957 submaps + local_first_binding)
27203ead 8958 + local_first_binding);
fbcd35bd
JB
8959
8960 /* If that click is bound, go for it. */
8961 if (first_binding < nmaps)
8962 {
8963 key = new_click;
8964 break;
8965 }
8966 /* Otherwise, we'll leave key set to the drag event. */
8967 }
0a7f1fc0
JB
8968 }
8969 }
8970 }
8971
284f4730 8972 keybuf[t++] = key;
7d6de002
RS
8973 /* Normally, last_nonmenu_event gets the previous key we read.
8974 But when a mouse popup menu is being used,
8975 we don't update last_nonmenu_event; it continues to hold the mouse
8976 event that preceded the first level of menu. */
8977 if (!used_mouse_menu)
8978 last_nonmenu_event = key;
284f4730 8979
6321824f
RS
8980 /* Record what part of this_command_keys is the current key sequence. */
8981 this_single_command_key_start = this_command_key_count - t;
8982
65e0fbbf
SM
8983 if (first_binding < nmaps && NILP (submaps[first_binding]))
8984 /* There is a binding and it's not a prefix.
8985 There is thus no function-key in this sequence.
8986 Moving fkey.start is important in this case to allow keytran.start
8987 to go over the sequence before we return (since we keep the
8988 invariant that keytran.end <= fkey.start). */
8989 {
a7f26f28
SM
8990 if (fkey.start < t)
8991 (fkey.start = fkey.end = t, fkey.map = Vfunction_key_map);
65e0fbbf
SM
8992 }
8993 else
8994 /* If the sequence is unbound, see if we can hang a function key
8995 off the end of it. */
284f4730 8996 {
a7f26f28 8997 Lisp_Object next;
284f4730 8998
a7f26f28
SM
8999 /* Continue scan from fkey.end until we find a bound suffix.
9000 If we fail, increment fkey.start and start over from there. */
9001 while (fkey.end < t)
284f4730 9002 {
f4255cd1
JB
9003 Lisp_Object key;
9004
a7f26f28
SM
9005 key = keybuf[fkey.end++];
9006 next = access_keymap (fkey.map, key, 1, 0, 1);
c700c260
RS
9007
9008 /* Handle symbol with autoload definition. */
a7f26f28
SM
9009 if (SYMBOLP (next) && ! NILP (Ffboundp (next))
9010 && CONSP (XSYMBOL (next)->function)
9011 && EQ (XCAR (XSYMBOL (next)->function), Qautoload))
9012 do_autoload (XSYMBOL (next)->function, next);
c700c260
RS
9013
9014 /* Handle a symbol whose function definition is a keymap
9015 or an array. */
a7f26f28
SM
9016 if (SYMBOLP (next) && ! NILP (Ffboundp (next))
9017 && (!NILP (Farrayp (XSYMBOL (next)->function))
9018 || KEYMAPP (XSYMBOL (next)->function)))
9019 next = XSYMBOL (next)->function;
067ffa38 9020
7a80a6f6
RS
9021#if 0 /* I didn't turn this on, because it might cause trouble
9022 for the mapping of return into C-m and tab into C-i. */
9023 /* Optionally don't map function keys into other things.
9024 This enables the user to redefine kp- keys easily. */
9025 if (SYMBOLP (key) && !NILP (Vinhibit_function_key_mapping))
a7f26f28 9026 next = Qnil;
7a80a6f6
RS
9027#endif
9028
1abe6abe
RS
9029 /* If the function key map gives a function, not an
9030 array, then call the function with no args and use
9031 its value instead. */
a7f26f28 9032 if (SYMBOLP (next) && ! NILP (Ffboundp (next))
65e0fbbf
SM
9033 /* If there's a binding (i.e. first_binding >= nmaps)
9034 we don't want to apply this function-key-mapping. */
a7f26f28 9035 && fkey.end == t && first_binding >= nmaps)
1abe6abe
RS
9036 {
9037 struct gcpro gcpro1, gcpro2, gcpro3;
9038 Lisp_Object tem;
a7f26f28 9039 tem = next;
1abe6abe 9040
a7f26f28
SM
9041 GCPRO3 (fkey.map, keytran.map, delayed_switch_frame);
9042 next = call1 (next, prompt);
1abe6abe
RS
9043 UNGCPRO;
9044 /* If the function returned something invalid,
9045 barf--don't ignore it.
df0f2ba1 9046 (To ignore it safely, we would need to gcpro a bunch of
1abe6abe 9047 other variables.) */
a7f26f28 9048 if (! (VECTORP (next) || STRINGP (next)))
6321824f 9049 error ("Function in key-translation-map returns invalid key sequence");
1abe6abe
RS
9050 }
9051
a7f26f28 9052 /* If keybuf[fkey.start..fkey.end] is bound in the
a764a753 9053 function key map and it's a suffix of the current
a7f26f28
SM
9054 sequence (i.e. fkey.end == t), replace it with
9055 the binding and restart with fkey.start at the end. */
9056 if ((VECTORP (next) || STRINGP (next))
65e0fbbf
SM
9057 /* If there's a binding (i.e. first_binding >= nmaps)
9058 we don't want to apply this function-key-mapping. */
a7f26f28 9059 && fkey.end == t && first_binding >= nmaps)
284f4730 9060 {
a7f26f28 9061 int len = XFASTINT (Flength (next));
f5ea6163 9062
a7f26f28 9063 t = fkey.start + len;
284f4730 9064 if (t >= bufsize)
3fe8e9a2 9065 error ("Key sequence too long");
284f4730 9066
a7f26f28
SM
9067 if (VECTORP (next))
9068 bcopy (XVECTOR (next)->contents,
9069 keybuf + fkey.start,
9070 (t - fkey.start) * sizeof (keybuf[0]));
9071 else if (STRINGP (next))
f5ea6163
JB
9072 {
9073 int i;
9074
9075 for (i = 0; i < len; i++)
a7f26f28 9076 XSETFASTINT (keybuf[fkey.start + i], SREF (next, i));
f5ea6163 9077 }
df0f2ba1 9078
284f4730 9079 mock_input = t;
a7f26f28
SM
9080 fkey.start = fkey.end = t;
9081 fkey.map = Vfunction_key_map;
284f4730 9082
3bd0dffb
KH
9083 /* Do pass the results through key-translation-map.
9084 But don't retranslate what key-translation-map
9085 has already translated. */
a7f26f28
SM
9086 keytran.end = keytran.start;
9087 keytran.map = Vkey_translation_map;
00a78037 9088
f4255cd1 9089 goto replay_sequence;
284f4730 9090 }
df0f2ba1 9091
a7f26f28 9092 fkey.map = get_keymap (next, 0, 1);
284f4730 9093
df0f2ba1 9094 /* If we no longer have a bound suffix, try a new positions for
a7f26f28
SM
9095 fkey.start. */
9096 if (!CONSP (fkey.map))
284f4730 9097 {
a7f26f28
SM
9098 fkey.end = ++fkey.start;
9099 fkey.map = Vfunction_key_map;
284f4730
JB
9100 }
9101 }
9102 }
a612e298
RS
9103
9104 /* Look for this sequence in key-translation-map. */
9105 {
a7f26f28 9106 Lisp_Object next;
a612e298 9107
a7f26f28
SM
9108 /* Scan from keytran.end until we find a bound suffix. */
9109 while (keytran.end < fkey.start)
a612e298
RS
9110 {
9111 Lisp_Object key;
9112
a7f26f28
SM
9113 key = keybuf[keytran.end++];
9114 next = access_keymap (keytran.map, key, 1, 0, 1);
a612e298 9115
c700c260 9116 /* Handle symbol with autoload definition. */
a7f26f28
SM
9117 if (SYMBOLP (next) && ! NILP (Ffboundp (next))
9118 && CONSP (XSYMBOL (next)->function)
9119 && EQ (XCAR (XSYMBOL (next)->function), Qautoload))
9120 do_autoload (XSYMBOL (next)->function, next);
e83f6bb0 9121
c700c260
RS
9122 /* Handle a symbol whose function definition is a keymap
9123 or an array. */
a7f26f28
SM
9124 if (SYMBOLP (next) && ! NILP (Ffboundp (next))
9125 && (!NILP (Farrayp (XSYMBOL (next)->function))
9126 || KEYMAPP (XSYMBOL (next)->function)))
9127 next = XSYMBOL (next)->function;
e83f6bb0 9128
1abe6abe 9129 /* If the key translation map gives a function, not an
e83f6bb0 9130 array, then call the function with one arg and use
1abe6abe 9131 its value instead. */
a7f26f28 9132 if (SYMBOLP (next) && ! NILP (Ffboundp (next)))
1abe6abe
RS
9133 {
9134 struct gcpro gcpro1, gcpro2, gcpro3;
9135 Lisp_Object tem;
a7f26f28 9136 tem = next;
1abe6abe 9137
a7f26f28
SM
9138 GCPRO3 (fkey.map, keytran.map, delayed_switch_frame);
9139 next = call1 (next, prompt);
1abe6abe
RS
9140 UNGCPRO;
9141 /* If the function returned something invalid,
9142 barf--don't ignore it.
df0f2ba1 9143 (To ignore it safely, we would need to gcpro a bunch of
1abe6abe 9144 other variables.) */
a7f26f28 9145 if (! (VECTORP (next) || STRINGP (next)))
40932d1a 9146 error ("Function in key-translation-map returns invalid key sequence");
1abe6abe
RS
9147 }
9148
a7f26f28 9149 /* If keybuf[keytran.start..keytran.end] is bound in the
1abe6abe 9150 key translation map and it's a suffix of the current
a7f26f28
SM
9151 sequence (i.e. keytran.end == t), replace it with
9152 the binding and restart with keytran.start at the end. */
9153 if ((VECTORP (next) || STRINGP (next)))
a612e298 9154 {
a7f26f28
SM
9155 int len = XFASTINT (Flength (next));
9156 int i, diff = len - (keytran.end - keytran.start);
a612e298 9157
2cf4b7b2
SM
9158 mock_input = max (t, mock_input);
9159 if (mock_input + diff >= bufsize)
3fe8e9a2 9160 error ("Key sequence too long");
a612e298 9161
a7f26f28 9162 /* Shift the keys that are after keytran.end. */
2cf4b7b2 9163 if (diff < 0)
a7f26f28 9164 for (i = keytran.end; i < mock_input; i++)
2cf4b7b2
SM
9165 keybuf[i + diff] = keybuf[i];
9166 else if (diff > 0)
a7f26f28 9167 for (i = mock_input - 1; i >= keytran.end; i--)
2cf4b7b2 9168 keybuf[i + diff] = keybuf[i];
a7f26f28
SM
9169 /* Replace the keys between keytran.start and keytran.end
9170 with those from next. */
2cf4b7b2 9171 for (i = 0; i < len; i++)
a7f26f28
SM
9172 keybuf[keytran.start + i]
9173 = Faref (next, make_number (i));
2cf4b7b2
SM
9174
9175 mock_input += diff;
a7f26f28
SM
9176 keytran.start = keytran.end += diff;
9177 keytran.map = Vkey_translation_map;
a612e298 9178
2cf4b7b2 9179 /* Adjust the function-key-map counters. */
a7f26f28
SM
9180 fkey.start += diff;
9181 fkey.end += diff;
00a78037 9182
a612e298
RS
9183 goto replay_sequence;
9184 }
9185
a7f26f28 9186 keytran.map = get_keymap (next, 0, 1);
a612e298 9187
df0f2ba1 9188 /* If we no longer have a bound suffix, try a new positions for
a7f26f28
SM
9189 keytran.start. */
9190 if (!CONSP (keytran.map))
a612e298 9191 {
a7f26f28
SM
9192 keytran.end = ++keytran.start;
9193 keytran.map = Vkey_translation_map;
a612e298
RS
9194 }
9195 }
9196 }
4e50f26a
RS
9197
9198 /* If KEY is not defined in any of the keymaps,
9199 and cannot be part of a function key or translation,
9200 and is an upper case letter
9201 use the corresponding lower-case letter instead. */
65e0fbbf 9202 if (first_binding >= nmaps
a7f26f28 9203 && fkey.start >= t && keytran.start >= t
8c18cbfb 9204 && INTEGERP (key)
4e50f26a 9205 && ((((XINT (key) & 0x3ffff)
301738ed 9206 < XCHAR_TABLE (current_buffer->downcase_table)->size)
4e50f26a
RS
9207 && UPPERCASEP (XINT (key) & 0x3ffff))
9208 || (XINT (key) & shift_modifier)))
9209 {
569871d2 9210 Lisp_Object new_key;
569871d2 9211
309b0fc8
RS
9212 original_uppercase = key;
9213 original_uppercase_position = t - 1;
9214
831f35a2 9215 if (XINT (key) & shift_modifier)
569871d2 9216 XSETINT (new_key, XINT (key) & ~shift_modifier);
4e50f26a 9217 else
569871d2
RS
9218 XSETINT (new_key, (DOWNCASE (XINT (key) & 0x3ffff)
9219 | (XINT (key) & ~0x3ffff)));
9220
3fe8e9a2
RS
9221 /* We have to do this unconditionally, regardless of whether
9222 the lower-case char is defined in the keymaps, because they
9223 might get translated through function-key-map. */
9224 keybuf[t - 1] = new_key;
2cf4b7b2 9225 mock_input = max (t, mock_input);
3fe8e9a2
RS
9226
9227 goto replay_sequence;
4e50f26a 9228 }
ef8fd672
RS
9229 /* If KEY is not defined in any of the keymaps,
9230 and cannot be part of a function key or translation,
9231 and is a shifted function key,
9232 use the corresponding unshifted function key instead. */
65e0fbbf 9233 if (first_binding >= nmaps
a7f26f28 9234 && fkey.start >= t && keytran.start >= t
ef8fd672
RS
9235 && SYMBOLP (key))
9236 {
9237 Lisp_Object breakdown;
9238 int modifiers;
9239
9240 breakdown = parse_modifiers (key);
7539e11f 9241 modifiers = XINT (XCAR (XCDR (breakdown)));
ef8fd672
RS
9242 if (modifiers & shift_modifier)
9243 {
569871d2 9244 Lisp_Object new_key;
3fe8e9a2
RS
9245
9246 original_uppercase = key;
9247 original_uppercase_position = t - 1;
ef8fd672 9248
569871d2
RS
9249 modifiers &= ~shift_modifier;
9250 new_key = apply_modifiers (modifiers,
7539e11f 9251 XCAR (breakdown));
569871d2 9252
3fe8e9a2 9253 keybuf[t - 1] = new_key;
2cf4b7b2 9254 mock_input = max (t, mock_input);
3fe8e9a2
RS
9255
9256 goto replay_sequence;
ef8fd672
RS
9257 }
9258 }
284f4730
JB
9259 }
9260
309b0fc8 9261 if (!dummyflag)
bc536d84
RS
9262 read_key_sequence_cmd = (first_binding < nmaps
9263 ? defs[first_binding]
9264 : Qnil);
284f4730 9265
cd21b839 9266 unread_switch_frame = delayed_switch_frame;
f4255cd1 9267 unbind_to (count, Qnil);
07f76a14 9268
3fe8e9a2
RS
9269 /* Don't downcase the last character if the caller says don't.
9270 Don't downcase it if the result is undefined, either. */
9271 if ((dont_downcase_last || first_binding >= nmaps)
9272 && t - 1 == original_uppercase_position)
309b0fc8
RS
9273 keybuf[t - 1] = original_uppercase;
9274
07f76a14
JB
9275 /* Occasionally we fabricate events, perhaps by expanding something
9276 according to function-key-map, or by adding a prefix symbol to a
9277 mouse click in the scroll bar or modeline. In this cases, return
9278 the entire generated key sequence, even if we hit an unbound
9279 prefix or a definition before the end. This means that you will
9280 be able to push back the event properly, and also means that
9281 read-key-sequence will always return a logical unit.
9282
9283 Better ideas? */
cca310da
JB
9284 for (; t < mock_input; t++)
9285 {
f2647d04
DL
9286 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
9287 && NILP (Fzerop (Vecho_keystrokes)))
a98ea3f9 9288 echo_char (keybuf[t]);
cca310da
JB
9289 add_command_key (keybuf[t]);
9290 }
07f76a14 9291
7d18f9ae
RS
9292
9293
2dc00208 9294 UNGCPRO;
284f4730
JB
9295 return t;
9296}
9297
d5eecefb 9298DEFUN ("read-key-sequence", Fread_key_sequence, Sread_key_sequence, 1, 5, 0,
4707d2d0
PJ
9299 doc: /* Read a sequence of keystrokes and return as a string or vector.
9300The sequence is sufficient to specify a non-prefix command in the
9301current local and global maps.
9302
9303First arg PROMPT is a prompt string. If nil, do not prompt specially.
9304Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9305as a continuation of the previous key.
9306
9307The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9308convert the last event to lower case. (Normally any upper case event
9309is converted to lower case if the original event is undefined and the lower
9310case equivalent is defined.) A non-nil value is appropriate for reading
9311a key sequence to be defined.
9312
9313A C-g typed while in this function is treated like any other character,
9314and `quit-flag' is not set.
9315
9316If the key sequence starts with a mouse click, then the sequence is read
9317using the keymaps of the buffer of the window clicked in, not the buffer
9318of the selected window as normal.
9319
9320`read-key-sequence' drops unbound button-down events, since you normally
9321only care about the click or drag events which follow them. If a drag
9322or multi-click event is unbound, but the corresponding click event would
9323be bound, `read-key-sequence' turns the event into a click event at the
9324drag's starting position. This means that you don't have to distinguish
9325between click and drag, double, or triple events unless you want to.
9326
9327`read-key-sequence' prefixes mouse events on mode lines, the vertical
9328lines separating windows, and scroll bars with imaginary keys
9329`mode-line', `vertical-line', and `vertical-scroll-bar'.
9330
9331Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9332function will process a switch-frame event if the user switches frames
9333before typing anything. If the user switches frames in the middle of a
9334key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9335is nil, then the event will be put off until after the current key sequence.
9336
9337`read-key-sequence' checks `function-key-map' for function key
9338sequences, where they wouldn't conflict with ordinary bindings. See
9339`function-key-map' for more details.
9340
9341The optional fifth argument COMMAND-LOOP, if non-nil, means
9342that this key sequence is being read by something that will
9343read commands one after another. It should be nil if the caller
9344will read just one key sequence. */)
d5eecefb
RS
9345 (prompt, continue_echo, dont_downcase_last, can_return_switch_frame,
9346 command_loop)
309b0fc8 9347 Lisp_Object prompt, continue_echo, dont_downcase_last;
d5eecefb 9348 Lisp_Object can_return_switch_frame, command_loop;
284f4730
JB
9349{
9350 Lisp_Object keybuf[30];
9351 register int i;
03cee6ae 9352 struct gcpro gcpro1;
aed13378 9353 int count = SPECPDL_INDEX ();
284f4730
JB
9354
9355 if (!NILP (prompt))
b7826503 9356 CHECK_STRING (prompt);
284f4730
JB
9357 QUIT;
9358
d5eecefb
RS
9359 specbind (Qinput_method_exit_on_first_char,
9360 (NILP (command_loop) ? Qt : Qnil));
9361 specbind (Qinput_method_use_echo_area,
9362 (NILP (command_loop) ? Qt : Qnil));
9363
284f4730
JB
9364 bzero (keybuf, sizeof keybuf);
9365 GCPRO1 (keybuf[0]);
9366 gcpro1.nvars = (sizeof keybuf/sizeof (keybuf[0]));
9367
daa37602 9368 if (NILP (continue_echo))
6321824f
RS
9369 {
9370 this_command_key_count = 0;
9371 this_single_command_key_start = 0;
9372 }
c0a58692 9373
d0c48478 9374#ifdef HAVE_X_WINDOWS
526a058f
GM
9375 if (display_hourglass_p)
9376 cancel_hourglass ();
d0c48478
GM
9377#endif
9378
309b0fc8 9379 i = read_key_sequence (keybuf, (sizeof keybuf/sizeof (keybuf[0])),
ce98e608 9380 prompt, ! NILP (dont_downcase_last),
f571ae0d 9381 ! NILP (can_return_switch_frame), 0);
284f4730 9382
ae18aa3b 9383#if 0 /* The following is fine for code reading a key sequence and
f95c4fe5 9384 then proceeding with a lenghty computation, but it's not good
ae18aa3b 9385 for code reading keys in a loop, like an input method. */
d0c48478 9386#ifdef HAVE_X_WINDOWS
526a058f
GM
9387 if (display_hourglass_p)
9388 start_hourglass ();
ae18aa3b 9389#endif
d0c48478
GM
9390#endif
9391
dcc408a0
RS
9392 if (i == -1)
9393 {
9394 Vquit_flag = Qt;
9395 QUIT;
9396 }
284f4730 9397 UNGCPRO;
d5eecefb 9398 return unbind_to (count, make_event_array (i, keybuf));
284f4730 9399}
e39da3d7
RS
9400
9401DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector,
d5eecefb 9402 Sread_key_sequence_vector, 1, 5, 0,
4707d2d0
PJ
9403 doc: /* Like `read-key-sequence' but always return a vector. */)
9404 (prompt, continue_echo, dont_downcase_last, can_return_switch_frame,
9405 command_loop)
e39da3d7 9406 Lisp_Object prompt, continue_echo, dont_downcase_last;
d5eecefb 9407 Lisp_Object can_return_switch_frame, command_loop;
e39da3d7
RS
9408{
9409 Lisp_Object keybuf[30];
9410 register int i;
03cee6ae 9411 struct gcpro gcpro1;
aed13378 9412 int count = SPECPDL_INDEX ();
e39da3d7
RS
9413
9414 if (!NILP (prompt))
b7826503 9415 CHECK_STRING (prompt);
e39da3d7
RS
9416 QUIT;
9417
d5eecefb
RS
9418 specbind (Qinput_method_exit_on_first_char,
9419 (NILP (command_loop) ? Qt : Qnil));
9420 specbind (Qinput_method_use_echo_area,
9421 (NILP (command_loop) ? Qt : Qnil));
9422
e39da3d7
RS
9423 bzero (keybuf, sizeof keybuf);
9424 GCPRO1 (keybuf[0]);
9425 gcpro1.nvars = (sizeof keybuf/sizeof (keybuf[0]));
9426
9427 if (NILP (continue_echo))
9428 {
9429 this_command_key_count = 0;
9430 this_single_command_key_start = 0;
9431 }
9432
d0c48478 9433#ifdef HAVE_X_WINDOWS
526a058f
GM
9434 if (display_hourglass_p)
9435 cancel_hourglass ();
d0c48478
GM
9436#endif
9437
e39da3d7
RS
9438 i = read_key_sequence (keybuf, (sizeof keybuf/sizeof (keybuf[0])),
9439 prompt, ! NILP (dont_downcase_last),
9440 ! NILP (can_return_switch_frame), 0);
9441
d0c48478 9442#ifdef HAVE_X_WINDOWS
526a058f
GM
9443 if (display_hourglass_p)
9444 start_hourglass ();
d0c48478
GM
9445#endif
9446
e39da3d7
RS
9447 if (i == -1)
9448 {
9449 Vquit_flag = Qt;
9450 QUIT;
9451 }
9452 UNGCPRO;
d5eecefb 9453 return unbind_to (count, Fvector (i, keybuf));
e39da3d7 9454}
284f4730 9455\f
158f7532 9456DEFUN ("command-execute", Fcommand_execute, Scommand_execute, 1, 4, 0,
4707d2d0
PJ
9457 doc: /* Execute CMD as an editor command.
9458CMD must be a symbol that satisfies the `commandp' predicate.
9459Optional second arg RECORD-FLAG non-nil
9460means unconditionally put this command in `command-history'.
9461Otherwise, that is done only if an arg is read using the minibuffer.
9462The argument KEYS specifies the value to use instead of (this-command-keys)
9463when reading the arguments; if it is nil, (this-command-keys) is used.
9464The argument SPECIAL, if non-nil, means that this command is executing
9465a special event, so ignore the prefix argument and don't clear it. */)
158f7532
RS
9466 (cmd, record_flag, keys, special)
9467 Lisp_Object cmd, record_flag, keys, special;
284f4730
JB
9468{
9469 register Lisp_Object final;
9470 register Lisp_Object tem;
9471 Lisp_Object prefixarg;
9472 struct backtrace backtrace;
9473 extern int debug_on_next_call;
9474
284f4730
JB
9475 debug_on_next_call = 0;
9476
158f7532
RS
9477 if (NILP (special))
9478 {
9479 prefixarg = current_kboard->Vprefix_arg;
9480 Vcurrent_prefix_arg = prefixarg;
9481 current_kboard->Vprefix_arg = Qnil;
9482 }
9483 else
9484 prefixarg = Qnil;
9485
8c18cbfb 9486 if (SYMBOLP (cmd))
284f4730
JB
9487 {
9488 tem = Fget (cmd, Qdisabled);
88ce066e 9489 if (!NILP (tem) && !NILP (Vrun_hooks))
b78ce8fb
RS
9490 {
9491 tem = Fsymbol_value (Qdisabled_command_hook);
9492 if (!NILP (tem))
9493 return call1 (Vrun_hooks, Qdisabled_command_hook);
9494 }
284f4730
JB
9495 }
9496
01e26217 9497 while (1)
284f4730 9498 {
ffd56f97 9499 final = Findirect_function (cmd);
284f4730
JB
9500
9501 if (CONSP (final) && (tem = Fcar (final), EQ (tem, Qautoload)))
b516a185
RS
9502 {
9503 struct gcpro gcpro1, gcpro2;
9504
9505 GCPRO2 (cmd, prefixarg);
9506 do_autoload (final, cmd);
9507 UNGCPRO;
9508 }
284f4730
JB
9509 else
9510 break;
9511 }
9512
8c18cbfb 9513 if (STRINGP (final) || VECTORP (final))
284f4730
JB
9514 {
9515 /* If requested, place the macro in the command history. For
9516 other sorts of commands, call-interactively takes care of
9517 this. */
e57d8fd8 9518 if (!NILP (record_flag))
f4385381
RS
9519 {
9520 Vcommand_history
9521 = Fcons (Fcons (Qexecute_kbd_macro,
9522 Fcons (final, Fcons (prefixarg, Qnil))),
9523 Vcommand_history);
9524
9525 /* Don't keep command history around forever. */
9526 if (NUMBERP (Vhistory_length) && XINT (Vhistory_length) > 0)
9527 {
9528 tem = Fnthcdr (Vhistory_length, Vcommand_history);
9529 if (CONSP (tem))
f3fbd155 9530 XSETCDR (tem, Qnil);
f4385381
RS
9531 }
9532 }
284f4730 9533
caa06051 9534 return Fexecute_kbd_macro (final, prefixarg, Qnil);
284f4730 9535 }
f4385381 9536
8c18cbfb 9537 if (CONSP (final) || SUBRP (final) || COMPILEDP (final))
284f4730
JB
9538 {
9539 backtrace.next = backtrace_list;
9540 backtrace_list = &backtrace;
9541 backtrace.function = &Qcall_interactively;
9542 backtrace.args = &cmd;
9543 backtrace.nargs = 1;
9544 backtrace.evalargs = 0;
9545
e57d8fd8 9546 tem = Fcall_interactively (cmd, record_flag, keys);
284f4730
JB
9547
9548 backtrace_list = backtrace.next;
9549 return tem;
9550 }
9551 return Qnil;
9552}
c970a760
GM
9553
9554
284f4730 9555\f
284f4730 9556DEFUN ("execute-extended-command", Fexecute_extended_command, Sexecute_extended_command,
4707d2d0
PJ
9557 1, 1, "P",
9558 doc: /* Read function name, then read its arguments and call it. */)
9559 (prefixarg)
284f4730
JB
9560 Lisp_Object prefixarg;
9561{
9562 Lisp_Object function;
9563 char buf[40];
2e1a49ad
SM
9564 int saved_last_point_position;
9565 Lisp_Object saved_keys, saved_last_point_position_buffer;
5434fce6 9566 Lisp_Object bindings, value;
2e1a49ad 9567 struct gcpro gcpro1, gcpro2, gcpro3;
284f4730 9568
b0f2a7bf
KH
9569 saved_keys = Fvector (this_command_key_count,
9570 XVECTOR (this_command_keys)->contents);
2e1a49ad
SM
9571 saved_last_point_position_buffer = last_point_position_buffer;
9572 saved_last_point_position = last_point_position;
284f4730 9573 buf[0] = 0;
2e1a49ad 9574 GCPRO3 (saved_keys, prefixarg, saved_last_point_position_buffer);
284f4730
JB
9575
9576 if (EQ (prefixarg, Qminus))
9577 strcpy (buf, "- ");
7539e11f 9578 else if (CONSP (prefixarg) && XINT (XCAR (prefixarg)) == 4)
284f4730 9579 strcpy (buf, "C-u ");
7539e11f 9580 else if (CONSP (prefixarg) && INTEGERP (XCAR (prefixarg)))
5d5b907f
RS
9581 {
9582 if (sizeof (int) == sizeof (EMACS_INT))
7539e11f 9583 sprintf (buf, "%d ", XINT (XCAR (prefixarg)));
5d5b907f 9584 else if (sizeof (long) == sizeof (EMACS_INT))
7539e11f 9585 sprintf (buf, "%ld ", (long) XINT (XCAR (prefixarg)));
5d5b907f
RS
9586 else
9587 abort ();
9588 }
8c18cbfb 9589 else if (INTEGERP (prefixarg))
5d5b907f
RS
9590 {
9591 if (sizeof (int) == sizeof (EMACS_INT))
9592 sprintf (buf, "%d ", XINT (prefixarg));
9593 else if (sizeof (long) == sizeof (EMACS_INT))
03cee6ae 9594 sprintf (buf, "%ld ", (long) XINT (prefixarg));
5d5b907f
RS
9595 else
9596 abort ();
9597 }
284f4730
JB
9598
9599 /* This isn't strictly correct if execute-extended-command
9600 is bound to anything else. Perhaps it should use
9601 this_command_keys? */
9602 strcat (buf, "M-x ");
9603
9604 /* Prompt with buf, and then read a string, completing from and
9605 restricting to the set of all defined commands. Don't provide
51763820 9606 any initial input. Save the command read on the extended-command
03b4122a 9607 history list. */
284f4730
JB
9608 function = Fcompleting_read (build_string (buf),
9609 Vobarray, Qcommandp,
4328577a
KH
9610 Qt, Qnil, Qextended_command_history, Qnil,
9611 Qnil);
284f4730 9612
d5db4077 9613 if (STRINGP (function) && SCHARS (function) == 0)
1f5b1641
RS
9614 error ("No command name given");
9615
1113d9db
JB
9616 /* Set this_command_keys to the concatenation of saved_keys and
9617 function, followed by a RET. */
284f4730 9618 {
b0f2a7bf 9619 Lisp_Object *keys;
284f4730 9620 int i;
284f4730 9621
1113d9db 9622 this_command_key_count = 0;
6321824f 9623 this_single_command_key_start = 0;
1113d9db 9624
b0f2a7bf
KH
9625 keys = XVECTOR (saved_keys)->contents;
9626 for (i = 0; i < XVECTOR (saved_keys)->size; i++)
9627 add_command_key (keys[i]);
1113d9db 9628
1b049b51 9629 for (i = 0; i < SCHARS (function); i++)
301738ed 9630 add_command_key (Faref (function, make_number (i)));
1113d9db 9631
301738ed 9632 add_command_key (make_number ('\015'));
284f4730
JB
9633 }
9634
2e1a49ad
SM
9635 last_point_position = saved_last_point_position;
9636 last_point_position_buffer = saved_last_point_position_buffer;
9637
284f4730
JB
9638 UNGCPRO;
9639
0a7f1fc0 9640 function = Fintern (function, Qnil);
d8bcf58e 9641 current_kboard->Vprefix_arg = prefixarg;
d5eecefb
RS
9642 Vthis_command = function;
9643 real_this_command = function;
284f4730 9644
6526ab49
RS
9645 /* If enabled, show which key runs this command. */
9646 if (!NILP (Vsuggest_key_bindings)
71012575 9647 && NILP (Vexecuting_macro)
6526ab49 9648 && SYMBOLP (function))
5434fce6 9649 bindings = Fwhere_is_internal (function, Voverriding_local_map,
8b9940e6 9650 Qt, Qnil, Qnil);
5434fce6
RS
9651 else
9652 bindings = Qnil;
6526ab49 9653
5434fce6
RS
9654 value = Qnil;
9655 GCPRO2 (bindings, value);
9656 value = Fcommand_execute (function, Qt, Qnil, Qnil);
6526ab49 9657
5434fce6 9658 /* If the command has a key binding, print it now. */
3ababa60 9659 if (!NILP (bindings)
ee112567
KH
9660 && ! (VECTORP (bindings) && EQ (Faref (bindings, make_number (0)),
9661 Qmouse_movement)))
5434fce6
RS
9662 {
9663 /* But first wait, and skip the message if there is input. */
426939cc 9664 int delay_time;
985f9f66 9665 if (!NILP (echo_area_buffer[0]))
426939cc
RS
9666 /* This command displayed something in the echo area;
9667 so wait a few seconds, then display our suggestion message. */
9668 delay_time = (NUMBERP (Vsuggest_key_bindings)
9669 ? XINT (Vsuggest_key_bindings) : 2);
9670 else
9671 /* This command left the echo area empty,
9672 so display our message immediately. */
9673 delay_time = 0;
9674
9675 if (!NILP (Fsit_for (make_number (delay_time), Qnil, Qnil))
303b5b3f 9676 && ! CONSP (Vunread_command_events))
6526ab49 9677 {
5434fce6
RS
9678 Lisp_Object binding;
9679 char *newmessage;
985f9f66 9680 int message_p = push_message ();
331379bf 9681 int count = SPECPDL_INDEX ();
5434fce6 9682
65efd7da 9683 record_unwind_protect (pop_message_unwind, Qnil);
5434fce6
RS
9684 binding = Fkey_description (bindings);
9685
9686 newmessage
d5db4077
KR
9687 = (char *) alloca (SCHARS (SYMBOL_NAME (function))
9688 + SBYTES (binding)
5434fce6 9689 + 100);
3ababa60 9690 sprintf (newmessage, "You can run the command `%s' with %s",
d5db4077
KR
9691 SDATA (SYMBOL_NAME (function)),
9692 SDATA (binding));
301738ed
RS
9693 message2_nolog (newmessage,
9694 strlen (newmessage),
9695 STRING_MULTIBYTE (binding));
5434fce6
RS
9696 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings)
9697 ? Vsuggest_key_bindings : make_number (2)),
985f9f66
GM
9698 Qnil, Qnil))
9699 && message_p)
9700 restore_message ();
9701
c970a760 9702 unbind_to (count, Qnil);
6526ab49
RS
9703 }
9704 }
9705
5434fce6 9706 RETURN_UNGCPRO (value);
284f4730 9707}
6526ab49 9708
284f4730 9709\f
d9d4c147 9710/* Return nonzero if input events are pending. */
284f4730 9711
dfcf069d 9712int
284f4730
JB
9713detect_input_pending ()
9714{
9715 if (!input_pending)
d9d4c147
KH
9716 get_input_pending (&input_pending, 0);
9717
9718 return input_pending;
9719}
9720
b1878f45 9721/* Return nonzero if input events are pending, and run any pending timers. */
d9d4c147 9722
dfcf069d 9723int
87dd9b9b
RS
9724detect_input_pending_run_timers (do_display)
9725 int do_display;
d9d4c147 9726{
87dd9b9b
RS
9727 int old_timers_run = timers_run;
9728
d9d4c147
KH
9729 if (!input_pending)
9730 get_input_pending (&input_pending, 1);
284f4730 9731
87dd9b9b 9732 if (old_timers_run != timers_run && do_display)
7ee32cda 9733 {
3007ebfb 9734 redisplay_preserve_echo_area (8);
7ee32cda
GM
9735 /* The following fixes a bug when using lazy-lock with
9736 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9737 from an idle timer function. The symptom of the bug is that
9738 the cursor sometimes doesn't become visible until the next X
9739 event is processed. --gerd. */
9740 if (rif)
9741 rif->flush_display (NULL);
9742 }
87dd9b9b 9743
284f4730
JB
9744 return input_pending;
9745}
9746
ffd56f97
JB
9747/* This is called in some cases before a possible quit.
9748 It cases the next call to detect_input_pending to recompute input_pending.
9749 So calling this function unnecessarily can't do any harm. */
07a59269
KH
9750
9751void
ffd56f97
JB
9752clear_input_pending ()
9753{
9754 input_pending = 0;
9755}
9756
b1878f45
RS
9757/* Return nonzero if there are pending requeued events.
9758 This isn't used yet. The hope is to make wait_reading_process_input
27fd22dc 9759 call it, and return if it runs Lisp code that unreads something.
b1878f45
RS
9760 The problem is, kbd_buffer_get_event needs to be fixed to know what
9761 to do in that case. It isn't trivial. */
9762
dfcf069d 9763int
b1878f45
RS
9764requeued_events_pending_p ()
9765{
9766 return (!NILP (Vunread_command_events) || unread_command_char != -1);
9767}
9768
9769
284f4730 9770DEFUN ("input-pending-p", Finput_pending_p, Sinput_pending_p, 0, 0, 0,
a064684d
RS
9771 doc: /* Return t if command input is currently available with no wait.
9772Actually, the value is nil only if we can be sure that no input is available;
9773if there is a doubt, the value is t. */)
4707d2d0 9774 ()
284f4730 9775{
24597608 9776 if (!NILP (Vunread_command_events) || unread_command_char != -1)
284f4730
JB
9777 return (Qt);
9778
20057d52 9779 get_filtered_input_pending (&input_pending, 1, 1);
d9d4c147 9780 return input_pending > 0 ? Qt : Qnil;
284f4730
JB
9781}
9782
9783DEFUN ("recent-keys", Frecent_keys, Srecent_keys, 0, 0, 0,
4707d2d0
PJ
9784 doc: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9785 ()
284f4730 9786{
5160df46 9787 Lisp_Object *keys = XVECTOR (recent_keys)->contents;
284f4730
JB
9788 Lisp_Object val;
9789
9790 if (total_keys < NUM_RECENT_KEYS)
5160df46 9791 return Fvector (total_keys, keys);
284f4730
JB
9792 else
9793 {
5160df46
JB
9794 val = Fvector (NUM_RECENT_KEYS, keys);
9795 bcopy (keys + recent_keys_index,
284f4730
JB
9796 XVECTOR (val)->contents,
9797 (NUM_RECENT_KEYS - recent_keys_index) * sizeof (Lisp_Object));
5160df46 9798 bcopy (keys,
284f4730
JB
9799 XVECTOR (val)->contents + NUM_RECENT_KEYS - recent_keys_index,
9800 recent_keys_index * sizeof (Lisp_Object));
9801 return val;
9802 }
9803}
9804
9805DEFUN ("this-command-keys", Fthis_command_keys, Sthis_command_keys, 0, 0, 0,
4707d2d0 9806 doc: /* Return the key sequence that invoked this command.
92501652 9807However, if the command has called `read-key-sequence', it returns
4052e7bb 9808the last key sequence that has been read.
4707d2d0
PJ
9809The value is a string or a vector. */)
9810 ()
284f4730 9811{
86e5706b
RS
9812 return make_event_array (this_command_key_count,
9813 XVECTOR (this_command_keys)->contents);
284f4730
JB
9814}
9815
e39da3d7 9816DEFUN ("this-command-keys-vector", Fthis_command_keys_vector, Sthis_command_keys_vector, 0, 0, 0,
92501652
RS
9817 doc: /* Return the key sequence that invoked this command, as a vector.
9818However, if the command has called `read-key-sequence', it returns
4052e7bb 9819the last key sequence that has been read. */)
4707d2d0 9820 ()
e39da3d7
RS
9821{
9822 return Fvector (this_command_key_count,
9823 XVECTOR (this_command_keys)->contents);
9824}
9825
6321824f
RS
9826DEFUN ("this-single-command-keys", Fthis_single_command_keys,
9827 Sthis_single_command_keys, 0, 0, 0,
4707d2d0 9828 doc: /* Return the key sequence that invoked this command.
92501652
RS
9829More generally, it returns the last key sequence read, either by
9830the command loop or by `read-key-sequence'.
4707d2d0
PJ
9831Unlike `this-command-keys', this function's value
9832does not include prefix arguments.
9833The value is always a vector. */)
9834 ()
6321824f 9835{
e39da3d7
RS
9836 return Fvector (this_command_key_count
9837 - this_single_command_key_start,
9838 (XVECTOR (this_command_keys)->contents
9839 + this_single_command_key_start));
6321824f
RS
9840}
9841
7d18f9ae
RS
9842DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys,
9843 Sthis_single_command_raw_keys, 0, 0, 0,
4707d2d0 9844 doc: /* Return the raw events that were read for this command.
92501652
RS
9845More generally, it returns the last key sequence read, either by
9846the command loop or by `read-key-sequence'.
4707d2d0
PJ
9847Unlike `this-single-command-keys', this function's value
9848shows the events before all translations (except for input methods).
9849The value is always a vector. */)
9850 ()
7d18f9ae
RS
9851{
9852 return Fvector (raw_keybuf_count,
9853 (XVECTOR (raw_keybuf)->contents));
9854}
9855
71918b75 9856DEFUN ("reset-this-command-lengths", Freset_this_command_lengths,
4707d2d0
PJ
9857 Sreset_this_command_lengths, 0, 0, 0,
9858 doc: /* Used for complicated reasons in `universal-argument-other-key'.
9859
9860`universal-argument-other-key' rereads the event just typed.
9861It then gets translated through `function-key-map'.
9862The translated event gets included in the echo area and in
9863the value of `this-command-keys' in addition to the raw original event.
9864That is not right.
9865
9866Calling this function directs the translated event to replace
9867the original event, so that only one version of the event actually
9868appears in the echo area and in the value of `this-command-keys'. */)
9869 ()
71918b75
RS
9870{
9871 before_command_restore_flag = 1;
9872 before_command_key_count_1 = before_command_key_count;
9873 before_command_echo_length_1 = before_command_echo_length;
6e5742a0 9874 return Qnil;
71918b75
RS
9875}
9876
82e6e5af 9877DEFUN ("clear-this-command-keys", Fclear_this_command_keys,
ab1959fc 9878 Sclear_this_command_keys, 0, 1, 0,
4707d2d0 9879 doc: /* Clear out the vector that `this-command-keys' returns.
ab1959fc
KS
9880Also clear the record of the last 100 events, unless optional arg
9881KEEP-RECORD is non-nil. */)
9882 (keep_record)
9883 Lisp_Object keep_record;
82e6e5af 9884{
fb0dde6c
GM
9885 int i;
9886
82e6e5af 9887 this_command_key_count = 0;
fb0dde6c 9888
ab1959fc
KS
9889 if (NILP (keep_record))
9890 {
9891 for (i = 0; i < XVECTOR (recent_keys)->size; ++i)
9892 XVECTOR (recent_keys)->contents[i] = Qnil;
9893 total_keys = 0;
9894 recent_keys_index = 0;
9895 }
82e6e5af
RS
9896 return Qnil;
9897}
9898
284f4730 9899DEFUN ("recursion-depth", Frecursion_depth, Srecursion_depth, 0, 0, 0,
4707d2d0
PJ
9900 doc: /* Return the current depth in recursive edits. */)
9901 ()
284f4730
JB
9902{
9903 Lisp_Object temp;
bb9e9bed 9904 XSETFASTINT (temp, command_loop_level + minibuf_level);
284f4730
JB
9905 return temp;
9906}
9907
9908DEFUN ("open-dribble-file", Fopen_dribble_file, Sopen_dribble_file, 1, 1,
4707d2d0
PJ
9909 "FOpen dribble file: ",
9910 doc: /* Start writing all keyboard characters to a dribble file called FILE.
9911If FILE is nil, close any open dribble file. */)
9912 (file)
284f4730
JB
9913 Lisp_Object file;
9914{
6cb52def 9915 if (dribble)
284f4730 9916 {
6cb52def
KH
9917 fclose (dribble);
9918 dribble = 0;
284f4730 9919 }
6cb52def 9920 if (!NILP (file))
284f4730
JB
9921 {
9922 file = Fexpand_file_name (file, Qnil);
d5db4077 9923 dribble = fopen (SDATA (file), "w");
ab6ca1de
KH
9924 if (dribble == 0)
9925 report_file_error ("Opening dribble", Fcons (file, Qnil));
284f4730
JB
9926 }
9927 return Qnil;
9928}
9929
9930DEFUN ("discard-input", Fdiscard_input, Sdiscard_input, 0, 0, 0,
4707d2d0 9931 doc: /* Discard the contents of the terminal input buffer.
2b17d5ed 9932Also end any kbd macro being defined. */)
4707d2d0 9933 ()
284f4730 9934{
2b17d5ed
KS
9935 if (!NILP (current_kboard->defining_kbd_macro))
9936 {
9937 /* Discard the last command from the macro. */
9938 Fcancel_kbd_macro_events ();
9939 end_kbd_macro ();
9940 }
9941
284f4730
JB
9942 update_mode_lines++;
9943
24597608 9944 Vunread_command_events = Qnil;
86e5706b 9945 unread_command_char = -1;
284f4730
JB
9946
9947 discard_tty_input ();
9948
7ee32cda 9949 kbd_fetch_ptr = kbd_store_ptr;
da8f7368 9950 Ffillarray (kbd_buffer_gcpro, Qnil);
284f4730
JB
9951 input_pending = 0;
9952
9953 return Qnil;
9954}
9955\f
9956DEFUN ("suspend-emacs", Fsuspend_emacs, Ssuspend_emacs, 0, 1, "",
4707d2d0
PJ
9957 doc: /* Stop Emacs and return to superior process. You can resume later.
9958If `cannot-suspend' is non-nil, or if the system doesn't support job
9959control, run a subshell instead.
9960
9961If optional arg STUFFSTRING is non-nil, its characters are stuffed
9962to be read as terminal input by Emacs's parent, after suspension.
9963
9964Before suspending, run the normal hook `suspend-hook'.
9965After resumption run the normal hook `suspend-resume-hook'.
9966
9967Some operating systems cannot stop the Emacs process and resume it later.
9968On such systems, Emacs starts a subshell instead of suspending. */)
9969 (stuffstring)
284f4730
JB
9970 Lisp_Object stuffstring;
9971{
aed13378 9972 int count = SPECPDL_INDEX ();
284f4730
JB
9973 int old_height, old_width;
9974 int width, height;
03cee6ae 9975 struct gcpro gcpro1;
284f4730
JB
9976
9977 if (!NILP (stuffstring))
b7826503 9978 CHECK_STRING (stuffstring);
284f4730 9979
1e95ed28
JB
9980 /* Run the functions in suspend-hook. */
9981 if (!NILP (Vrun_hooks))
9982 call1 (Vrun_hooks, intern ("suspend-hook"));
284f4730 9983
b7d2ebbf 9984 GCPRO1 (stuffstring);
ff11dfa1 9985 get_frame_size (&old_width, &old_height);
284f4730
JB
9986 reset_sys_modes ();
9987 /* sys_suspend can get an error if it tries to fork a subshell
9988 and the system resources aren't available for that. */
91a0da02 9989 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object))) init_sys_modes,
d52a7a92 9990 Qnil);
284f4730 9991 stuff_buffered_input (stuffstring);
8026024c
KH
9992 if (cannot_suspend)
9993 sys_subshell ();
9994 else
9995 sys_suspend ();
284f4730
JB
9996 unbind_to (count, Qnil);
9997
9998 /* Check if terminal/window size has changed.
9999 Note that this is not useful when we are running directly
10000 with a window system; but suspend should be disabled in that case. */
ff11dfa1 10001 get_frame_size (&width, &height);
284f4730 10002 if (width != old_width || height != old_height)
788f89eb 10003 change_frame_size (SELECTED_FRAME (), height, width, 0, 0, 0);
284f4730 10004
1e95ed28 10005 /* Run suspend-resume-hook. */
284f4730
JB
10006 if (!NILP (Vrun_hooks))
10007 call1 (Vrun_hooks, intern ("suspend-resume-hook"));
df0f2ba1 10008
284f4730
JB
10009 UNGCPRO;
10010 return Qnil;
10011}
10012
10013/* If STUFFSTRING is a string, stuff its contents as pending terminal input.
eb8c3be9 10014 Then in any case stuff anything Emacs has read ahead and not used. */
284f4730 10015
07a59269 10016void
284f4730
JB
10017stuff_buffered_input (stuffstring)
10018 Lisp_Object stuffstring;
10019{
284f4730 10020/* stuff_char works only in BSD, versions 4.2 and up. */
6df54671 10021#ifdef BSD_SYSTEM
284f4730 10022#ifndef BSD4_1
612b78ef 10023 register unsigned char *p;
612b78ef 10024
8c18cbfb 10025 if (STRINGP (stuffstring))
284f4730
JB
10026 {
10027 register int count;
10028
d5db4077
KR
10029 p = SDATA (stuffstring);
10030 count = SBYTES (stuffstring);
284f4730
JB
10031 while (count-- > 0)
10032 stuff_char (*p++);
10033 stuff_char ('\n');
10034 }
da8f7368 10035
284f4730 10036 /* Anything we have read ahead, put back for the shell to read. */
beecf6a1 10037 /* ?? What should this do when we have multiple keyboards??
c5fdd383 10038 Should we ignore anything that was typed in at the "wrong" kboard? */
beecf6a1 10039 for (; kbd_fetch_ptr != kbd_store_ptr; kbd_fetch_ptr++)
284f4730 10040 {
da8f7368
GM
10041 int idx;
10042
beecf6a1
KH
10043 if (kbd_fetch_ptr == kbd_buffer + KBD_BUFFER_SIZE)
10044 kbd_fetch_ptr = kbd_buffer;
3b8f9651 10045 if (kbd_fetch_ptr->kind == ASCII_KEYSTROKE_EVENT)
beecf6a1 10046 stuff_char (kbd_fetch_ptr->code);
da8f7368 10047
3b8f9651 10048 kbd_fetch_ptr->kind = NO_EVENT;
da8f7368
GM
10049 idx = 2 * (kbd_fetch_ptr - kbd_buffer);
10050 ASET (kbd_buffer_gcpro, idx, Qnil);
10051 ASET (kbd_buffer_gcpro, idx + 1, Qnil);
284f4730 10052 }
da8f7368 10053
284f4730
JB
10054 input_pending = 0;
10055#endif
6df54671 10056#endif /* BSD_SYSTEM and not BSD4_1 */
284f4730
JB
10057}
10058\f
dfcf069d 10059void
ffd56f97
JB
10060set_waiting_for_input (time_to_clear)
10061 EMACS_TIME *time_to_clear;
284f4730 10062{
ffd56f97 10063 input_available_clear_time = time_to_clear;
284f4730
JB
10064
10065 /* Tell interrupt_signal to throw back to read_char, */
10066 waiting_for_input = 1;
10067
10068 /* If interrupt_signal was called before and buffered a C-g,
10069 make it run again now, to avoid timing error. */
10070 if (!NILP (Vquit_flag))
10071 quit_throw_to_read_char ();
284f4730
JB
10072}
10073
07a59269 10074void
284f4730
JB
10075clear_waiting_for_input ()
10076{
10077 /* Tell interrupt_signal not to throw back to read_char, */
10078 waiting_for_input = 0;
ffd56f97 10079 input_available_clear_time = 0;
284f4730
JB
10080}
10081
27fd22dc 10082/* This routine is called at interrupt level in response to C-g.
d4e68eea
GM
10083
10084 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10085 is called from kbd_buffer_store_event, in handling SIGIO or
10086 SIGTINT.
284f4730 10087
d4e68eea
GM
10088 If `waiting_for_input' is non zero, then unless `echoing' is
10089 nonzero, immediately throw back to read_char.
284f4730 10090
d4e68eea
GM
10091 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10092 eval to throw, when it gets a chance. If quit-flag is already
10093 non-nil, it stops the job right away. */
284f4730 10094
14e40288 10095static SIGTYPE
91c049d4
RS
10096interrupt_signal (signalnum) /* If we don't have an argument, */
10097 int signalnum; /* some compilers complain in signal calls. */
284f4730
JB
10098{
10099 char c;
10100 /* Must preserve main program's value of errno. */
10101 int old_errno = errno;
788f89eb 10102 struct frame *sf = SELECTED_FRAME ();
284f4730 10103
5970a8cb 10104#if defined (USG) && !defined (POSIX_SIGNALS)
7a80a6f6
RS
10105 if (!read_socket_hook && NILP (Vwindow_system))
10106 {
10107 /* USG systems forget handlers when they are used;
10108 must reestablish each time */
10109 signal (SIGINT, interrupt_signal);
10110 signal (SIGQUIT, interrupt_signal);
10111 }
284f4730
JB
10112#endif /* USG */
10113
10114 cancel_echoing ();
10115
31e4e97b 10116 if (!NILP (Vquit_flag)
788f89eb 10117 && (FRAME_TERMCAP_P (sf) || FRAME_MSDOS_P (sf)))
284f4730 10118 {
31e4e97b
EZ
10119 /* If SIGINT isn't blocked, don't let us be interrupted by
10120 another SIGINT, it might be harmful due to non-reentrancy
10121 in I/O functions. */
10122 sigblock (sigmask (SIGINT));
10123
284f4730
JB
10124 fflush (stdout);
10125 reset_sys_modes ();
31e4e97b 10126
284f4730
JB
10127#ifdef SIGTSTP /* Support possible in later USG versions */
10128/*
10129 * On systems which can suspend the current process and return to the original
10130 * shell, this command causes the user to end up back at the shell.
10131 * The "Auto-save" and "Abort" questions are not asked until
10132 * the user elects to return to emacs, at which point he can save the current
10133 * job and either dump core or continue.
10134 */
10135 sys_suspend ();
10136#else
10137#ifdef VMS
10138 if (sys_suspend () == -1)
10139 {
10140 printf ("Not running as a subprocess;\n");
10141 printf ("you can continue or abort.\n");
10142 }
10143#else /* not VMS */
10144 /* Perhaps should really fork an inferior shell?
10145 But that would not provide any way to get back
10146 to the original shell, ever. */
10147 printf ("No support for stopping a process on this operating system;\n");
10148 printf ("you can continue or abort.\n");
10149#endif /* not VMS */
10150#endif /* not SIGTSTP */
80e4aa30
RS
10151#ifdef MSDOS
10152 /* We must remain inside the screen area when the internal terminal
10153 is used. Note that [Enter] is not echoed by dos. */
10154 cursor_to (0, 0);
10155#endif
118d6ca9
RS
10156 /* It doesn't work to autosave while GC is in progress;
10157 the code used for auto-saving doesn't cope with the mark bit. */
10158 if (!gc_in_progress)
9fd7d808 10159 {
118d6ca9
RS
10160 printf ("Auto-save? (y or n) ");
10161 fflush (stdout);
10162 if (((c = getchar ()) & ~040) == 'Y')
10163 {
10164 Fdo_auto_save (Qt, Qnil);
80e4aa30 10165#ifdef MSDOS
118d6ca9 10166 printf ("\r\nAuto-save done");
80e4aa30 10167#else /* not MSDOS */
118d6ca9 10168 printf ("Auto-save done\n");
80e4aa30 10169#endif /* not MSDOS */
118d6ca9
RS
10170 }
10171 while (c != '\n') c = getchar ();
9fd7d808 10172 }
118d6ca9
RS
10173 else
10174 {
10175 /* During GC, it must be safe to reenable quitting again. */
10176 Vinhibit_quit = Qnil;
10177#ifdef MSDOS
10178 printf ("\r\n");
10179#endif /* not MSDOS */
10180 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10181 printf ("but will instead do a real quit after garbage collection ends\r\n");
10182 fflush (stdout);
10183 }
10184
80e4aa30
RS
10185#ifdef MSDOS
10186 printf ("\r\nAbort? (y or n) ");
10187#else /* not MSDOS */
284f4730
JB
10188#ifdef VMS
10189 printf ("Abort (and enter debugger)? (y or n) ");
10190#else /* not VMS */
10191 printf ("Abort (and dump core)? (y or n) ");
10192#endif /* not VMS */
80e4aa30 10193#endif /* not MSDOS */
284f4730
JB
10194 fflush (stdout);
10195 if (((c = getchar ()) & ~040) == 'Y')
10196 abort ();
10197 while (c != '\n') c = getchar ();
80e4aa30
RS
10198#ifdef MSDOS
10199 printf ("\r\nContinuing...\r\n");
10200#else /* not MSDOS */
284f4730 10201 printf ("Continuing...\n");
80e4aa30 10202#endif /* not MSDOS */
284f4730
JB
10203 fflush (stdout);
10204 init_sys_modes ();
31e4e97b 10205 sigfree ();
284f4730
JB
10206 }
10207 else
10208 {
10209 /* If executing a function that wants to be interrupted out of
10210 and the user has not deferred quitting by binding `inhibit-quit'
10211 then quit right away. */
10212 if (immediate_quit && NILP (Vinhibit_quit))
10213 {
e39da3d7
RS
10214 struct gl_state_s saved;
10215 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
10216
284f4730
JB
10217 immediate_quit = 0;
10218 sigfree ();
e39da3d7
RS
10219 saved = gl_state;
10220 GCPRO4 (saved.object, saved.global_code,
10221 saved.current_syntax_table, saved.old_prop);
284f4730 10222 Fsignal (Qquit, Qnil);
e39da3d7
RS
10223 gl_state = saved;
10224 UNGCPRO;
284f4730
JB
10225 }
10226 else
10227 /* Else request quit when it's safe */
10228 Vquit_flag = Qt;
10229 }
10230
10231 if (waiting_for_input && !echoing)
10232 quit_throw_to_read_char ();
10233
10234 errno = old_errno;
10235}
10236
10237/* Handle a C-g by making read_char return C-g. */
10238
07a59269 10239void
284f4730
JB
10240quit_throw_to_read_char ()
10241{
284f4730
JB
10242 sigfree ();
10243 /* Prevent another signal from doing this before we finish. */
f76475ad 10244 clear_waiting_for_input ();
284f4730
JB
10245 input_pending = 0;
10246
24597608 10247 Vunread_command_events = Qnil;
86e5706b 10248 unread_command_char = -1;
284f4730 10249
087feab3
RS
10250#if 0 /* Currently, sit_for is called from read_char without turning
10251 off polling. And that can call set_waiting_for_input.
10252 It seems to be harmless. */
e6b01c14
JB
10253#ifdef POLL_FOR_INPUT
10254 /* May be > 1 if in recursive minibuffer. */
10255 if (poll_suppress_count == 0)
10256 abort ();
10257#endif
087feab3 10258#endif
4c52b668 10259 if (FRAMEP (internal_last_event_frame)
788f89eb 10260 && !EQ (internal_last_event_frame, selected_frame))
719191cf 10261 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame),
827c686c 10262 0, 0);
e6b01c14 10263
284f4730
JB
10264 _longjmp (getcjmp, 1);
10265}
10266\f
10267DEFUN ("set-input-mode", Fset_input_mode, Sset_input_mode, 3, 4, 0,
4707d2d0
PJ
10268 doc: /* Set mode of reading keyboard input.
10269First arg INTERRUPT non-nil means use input interrupts;
10270 nil means use CBREAK mode.
10271Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10272 (no effect except in CBREAK mode).
10273Third arg META t means accept 8-bit input (for a Meta key).
10274 META nil means ignore the top bit, on the assumption it is parity.
10275 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10276Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10277See also `current-input-mode'. */)
10278 (interrupt, flow, meta, quit)
284f4730
JB
10279 Lisp_Object interrupt, flow, meta, quit;
10280{
10281 if (!NILP (quit)
8c18cbfb 10282 && (!INTEGERP (quit) || XINT (quit) < 0 || XINT (quit) > 0400))
34f04431
RS
10283 error ("set-input-mode: QUIT must be an ASCII character");
10284
10285#ifdef POLL_FOR_INPUT
10286 stop_polling ();
10287#endif
284f4730 10288
07de30b9 10289#ifndef DOS_NT
2ee250ec 10290 /* this causes startup screen to be restored and messes with the mouse */
284f4730 10291 reset_sys_modes ();
2ee250ec
RS
10292#endif
10293
284f4730
JB
10294#ifdef SIGIO
10295/* Note SIGIO has been undef'd if FIONREAD is missing. */
284f4730 10296 if (read_socket_hook)
9a0f60bb
KH
10297 {
10298 /* When using X, don't give the user a real choice,
10299 because we haven't implemented the mechanisms to support it. */
10300#ifdef NO_SOCK_SIGIO
10301 interrupt_input = 0;
10302#else /* not NO_SOCK_SIGIO */
10303 interrupt_input = 1;
284f4730 10304#endif /* NO_SOCK_SIGIO */
9a0f60bb
KH
10305 }
10306 else
284f4730
JB
10307 interrupt_input = !NILP (interrupt);
10308#else /* not SIGIO */
10309 interrupt_input = 0;
10310#endif /* not SIGIO */
9a0f60bb 10311
284f4730
JB
10312/* Our VMS input only works by interrupts, as of now. */
10313#ifdef VMS
10314 interrupt_input = 1;
10315#endif
9a0f60bb 10316
284f4730 10317 flow_control = !NILP (flow);
b04904fb
RS
10318 if (NILP (meta))
10319 meta_key = 0;
10320 else if (EQ (meta, Qt))
10321 meta_key = 1;
10322 else
10323 meta_key = 2;
284f4730
JB
10324 if (!NILP (quit))
10325 /* Don't let this value be out of range. */
10326 quit_char = XINT (quit) & (meta_key ? 0377 : 0177);
10327
07de30b9 10328#ifndef DOS_NT
284f4730 10329 init_sys_modes ();
2ee250ec 10330#endif
34f04431
RS
10331
10332#ifdef POLL_FOR_INPUT
10333 poll_suppress_count = 1;
10334 start_polling ();
10335#endif
284f4730
JB
10336 return Qnil;
10337}
80645119
JB
10338
10339DEFUN ("current-input-mode", Fcurrent_input_mode, Scurrent_input_mode, 0, 0, 0,
4707d2d0
PJ
10340 doc: /* Return information about the way Emacs currently reads keyboard input.
10341The value is a list of the form (INTERRUPT FLOW META QUIT), where
10342 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10343 nil, Emacs is using CBREAK mode.
10344 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10345 terminal; this does not apply if Emacs uses interrupt-driven input.
10346 META is t if accepting 8-bit input with 8th bit as Meta flag.
10347 META nil means ignoring the top bit, on the assumption it is parity.
10348 META is neither t nor nil if accepting 8-bit input and using
10349 all 8 bits as the character code.
10350 QUIT is the character Emacs currently uses to quit.
10351The elements of this list correspond to the arguments of
10352`set-input-mode'. */)
10353 ()
80645119
JB
10354{
10355 Lisp_Object val[4];
10356
10357 val[0] = interrupt_input ? Qt : Qnil;
10358 val[1] = flow_control ? Qt : Qnil;
a8ee7ef9 10359 val[2] = meta_key == 2 ? make_number (0) : meta_key == 1 ? Qt : Qnil;
bb9e9bed 10360 XSETFASTINT (val[3], quit_char);
80645119 10361
bf673a7a 10362 return Flist (sizeof (val) / sizeof (val[0]), val);
80645119
JB
10363}
10364
284f4730 10365\f
6c6083a9 10366/*
c5fdd383 10367 * Set up a new kboard object with reasonable initial values.
6c6083a9
KH
10368 */
10369void
c5fdd383
KH
10370init_kboard (kb)
10371 KBOARD *kb;
6c6083a9 10372{
217258d5 10373 kb->Voverriding_terminal_local_map = Qnil;
6c7178b9 10374 kb->Vlast_command = Qnil;
75045dcb 10375 kb->Vreal_last_command = Qnil;
d8bcf58e 10376 kb->Vprefix_arg = Qnil;
75045dcb 10377 kb->Vlast_prefix_arg = Qnil;
c5fdd383
KH
10378 kb->kbd_queue = Qnil;
10379 kb->kbd_queue_has_data = 0;
10380 kb->immediate_echo = 0;
678e9d18 10381 kb->echo_string = Qnil;
c5fdd383
KH
10382 kb->echo_after_prompt = -1;
10383 kb->kbd_macro_buffer = 0;
10384 kb->kbd_macro_bufsize = 0;
10385 kb->defining_kbd_macro = Qnil;
10386 kb->Vlast_kbd_macro = Qnil;
10387 kb->reference_count = 0;
7c97ffdc 10388 kb->Vsystem_key_alist = Qnil;
142e6c73 10389 kb->system_key_syms = Qnil;
9ba47203 10390 kb->Vdefault_minibuffer_frame = Qnil;
6c6083a9
KH
10391}
10392
10393/*
c5fdd383 10394 * Destroy the contents of a kboard object, but not the object itself.
8e6208c5 10395 * We use this just before deleting it, or if we're going to initialize
6c6083a9
KH
10396 * it a second time.
10397 */
e50b8090 10398static void
c5fdd383
KH
10399wipe_kboard (kb)
10400 KBOARD *kb;
6c6083a9 10401{
c5fdd383
KH
10402 if (kb->kbd_macro_buffer)
10403 xfree (kb->kbd_macro_buffer);
6c6083a9
KH
10404}
10405
e50b8090 10406#ifdef MULTI_KBOARD
a122a38e
GM
10407
10408/* Free KB and memory referenced from it. */
10409
e50b8090
KH
10410void
10411delete_kboard (kb)
a122a38e 10412 KBOARD *kb;
e50b8090
KH
10413{
10414 KBOARD **kbp;
a122a38e 10415
e50b8090
KH
10416 for (kbp = &all_kboards; *kbp != kb; kbp = &(*kbp)->next_kboard)
10417 if (*kbp == NULL)
10418 abort ();
10419 *kbp = kb->next_kboard;
a122a38e
GM
10420
10421 /* Prevent a dangling reference to KB. */
18f534df
GM
10422 if (kb == current_kboard
10423 && FRAMEP (selected_frame)
10424 && FRAME_LIVE_P (XFRAME (selected_frame)))
a122a38e 10425 {
18f534df 10426 current_kboard = XFRAME (selected_frame)->kboard;
a122a38e
GM
10427 if (current_kboard == kb)
10428 abort ();
10429 }
10430
e50b8090
KH
10431 wipe_kboard (kb);
10432 xfree (kb);
10433}
a122a38e
GM
10434
10435#endif /* MULTI_KBOARD */
e50b8090 10436
dfcf069d 10437void
284f4730
JB
10438init_keyboard ()
10439{
284f4730
JB
10440 /* This is correct before outermost invocation of the editor loop */
10441 command_loop_level = -1;
10442 immediate_quit = 0;
10443 quit_char = Ctl ('g');
24597608 10444 Vunread_command_events = Qnil;
86e5706b 10445 unread_command_char = -1;
87dd9b9b 10446 EMACS_SET_SECS_USECS (timer_idleness_start_time, -1, -1);
284f4730 10447 total_keys = 0;
9deb415a 10448 recent_keys_index = 0;
beecf6a1
KH
10449 kbd_fetch_ptr = kbd_buffer;
10450 kbd_store_ptr = kbd_buffer;
da8f7368 10451 kbd_buffer_gcpro = Fmake_vector (make_number (2 * KBD_BUFFER_SIZE), Qnil);
2eb6bfbe 10452#ifdef HAVE_MOUSE
a9d77f1f 10453 do_mouse_tracking = Qnil;
2eb6bfbe 10454#endif
284f4730
JB
10455 input_pending = 0;
10456
4c52b668
KH
10457 /* This means that command_loop_1 won't try to select anything the first
10458 time through. */
10459 internal_last_event_frame = Qnil;
10460 Vlast_event_frame = internal_last_event_frame;
4c52b668 10461
c5fdd383 10462#ifdef MULTI_KBOARD
aaca43a1 10463 current_kboard = initial_kboard;
6c6083a9 10464#endif
aaca43a1 10465 wipe_kboard (current_kboard);
c5fdd383 10466 init_kboard (current_kboard);
07d2b8de 10467
7a80a6f6 10468 if (!noninteractive && !read_socket_hook && NILP (Vwindow_system))
284f4730
JB
10469 {
10470 signal (SIGINT, interrupt_signal);
cb5df6ae 10471#if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
284f4730
JB
10472 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10473 SIGQUIT and we can't tell which one it will give us. */
10474 signal (SIGQUIT, interrupt_signal);
10475#endif /* HAVE_TERMIO */
7a80a6f6 10476 }
284f4730
JB
10477/* Note SIGIO has been undef'd if FIONREAD is missing. */
10478#ifdef SIGIO
7a80a6f6
RS
10479 if (!noninteractive)
10480 signal (SIGIO, input_available_signal);
8ea0a720 10481#endif /* SIGIO */
284f4730
JB
10482
10483/* Use interrupt input by default, if it works and noninterrupt input
10484 has deficiencies. */
10485
10486#ifdef INTERRUPT_INPUT
10487 interrupt_input = 1;
10488#else
10489 interrupt_input = 0;
10490#endif
10491
10492/* Our VMS input only works by interrupts, as of now. */
10493#ifdef VMS
10494 interrupt_input = 1;
10495#endif
10496
10497 sigfree ();
10498 dribble = 0;
10499
10500 if (keyboard_init_hook)
10501 (*keyboard_init_hook) ();
10502
10503#ifdef POLL_FOR_INPUT
10504 poll_suppress_count = 1;
10505 start_polling ();
10506#endif
10507}
10508
df0f2ba1 10509/* This type's only use is in syms_of_keyboard, to initialize the
284f4730
JB
10510 event header symbols and put properties on them. */
10511struct event_head {
10512 Lisp_Object *var;
10513 char *name;
10514 Lisp_Object *kind;
10515};
10516
10517struct event_head head_table[] = {
7406e988
PJ
10518 {&Qmouse_movement, "mouse-movement", &Qmouse_movement},
10519 {&Qscroll_bar_movement, "scroll-bar-movement", &Qmouse_movement},
10520 {&Qswitch_frame, "switch-frame", &Qswitch_frame},
10521 {&Qdelete_frame, "delete-frame", &Qdelete_frame},
10522 {&Qiconify_frame, "iconify-frame", &Qiconify_frame},
a697f886
PJ
10523 {&Qmake_frame_visible, "make-frame-visible", &Qmake_frame_visible},
10524 {&Qselect_window, "select-window", &Qselect_window}
284f4730
JB
10525};
10526
dfcf069d 10527void
284f4730
JB
10528syms_of_keyboard ()
10529{
f0c1cc56
GM
10530 Vpre_help_message = Qnil;
10531 staticpro (&Vpre_help_message);
10532
8e1e4240
GM
10533 Vlispy_mouse_stem = build_string ("mouse");
10534 staticpro (&Vlispy_mouse_stem);
f0c1cc56 10535
9ea173e8 10536 /* Tool-bars. */
7ee32cda
GM
10537 QCimage = intern (":image");
10538 staticpro (&QCimage);
10539
10540 staticpro (&Qhelp_echo);
10541 Qhelp_echo = intern ("help-echo");
10542
e8886a1d
RS
10543 staticpro (&item_properties);
10544 item_properties = Qnil;
10545
9ea173e8
GM
10546 staticpro (&tool_bar_item_properties);
10547 tool_bar_item_properties = Qnil;
10548 staticpro (&tool_bar_items_vector);
10549 tool_bar_items_vector = Qnil;
7ee32cda 10550
d5eecefb
RS
10551 staticpro (&real_this_command);
10552 real_this_command = Qnil;
10553
d925fb39
RS
10554 Qtimer_event_handler = intern ("timer-event-handler");
10555 staticpro (&Qtimer_event_handler);
10556
2e894dab
RS
10557 Qdisabled_command_hook = intern ("disabled-command-hook");
10558 staticpro (&Qdisabled_command_hook);
10559
284f4730
JB
10560 Qself_insert_command = intern ("self-insert-command");
10561 staticpro (&Qself_insert_command);
10562
10563 Qforward_char = intern ("forward-char");
10564 staticpro (&Qforward_char);
10565
10566 Qbackward_char = intern ("backward-char");
10567 staticpro (&Qbackward_char);
10568
10569 Qdisabled = intern ("disabled");
10570 staticpro (&Qdisabled);
10571
e58aa385
RS
10572 Qundefined = intern ("undefined");
10573 staticpro (&Qundefined);
10574
86e5706b
RS
10575 Qpre_command_hook = intern ("pre-command-hook");
10576 staticpro (&Qpre_command_hook);
10577
10578 Qpost_command_hook = intern ("post-command-hook");
10579 staticpro (&Qpost_command_hook);
10580
59aadc81
RS
10581 Qpost_command_idle_hook = intern ("post-command-idle-hook");
10582 staticpro (&Qpost_command_idle_hook);
10583
3ef14e46
RS
10584 Qdeferred_action_function = intern ("deferred-action-function");
10585 staticpro (&Qdeferred_action_function);
10586
40932d1a
RS
10587 Qcommand_hook_internal = intern ("command-hook-internal");
10588 staticpro (&Qcommand_hook_internal);
10589
284f4730
JB
10590 Qfunction_key = intern ("function-key");
10591 staticpro (&Qfunction_key);
13b5e56c 10592 Qmouse_click = intern ("mouse-click");
284f4730 10593 staticpro (&Qmouse_click);
742fbed7 10594#if defined(WINDOWSNT) || defined(MAC_OSX)
07de30b9
GV
10595 Qmouse_wheel = intern ("mouse-wheel");
10596 staticpro (&Qmouse_wheel);
742fbed7
AC
10597#endif
10598#ifdef WINDOWSNT
1161d367
GV
10599 Qlanguage_change = intern ("language-change");
10600 staticpro (&Qlanguage_change);
07de30b9 10601#endif
a24dc617
RS
10602 Qdrag_n_drop = intern ("drag-n-drop");
10603 staticpro (&Qdrag_n_drop);
284f4730 10604
4ebc27a5
JD
10605 Qsave_session = intern ("save-session");
10606 staticpro(&Qsave_session);
10607
5bf68f6e
AS
10608 Qusr1_signal = intern ("usr1-signal");
10609 staticpro (&Qusr1_signal);
10610 Qusr2_signal = intern ("usr2-signal");
10611 staticpro (&Qusr2_signal);
10612
598a9fa7
JB
10613 Qmenu_enable = intern ("menu-enable");
10614 staticpro (&Qmenu_enable);
e8886a1d
RS
10615 Qmenu_alias = intern ("menu-alias");
10616 staticpro (&Qmenu_alias);
10617 QCenable = intern (":enable");
10618 staticpro (&QCenable);
10619 QCvisible = intern (":visible");
10620 staticpro (&QCvisible);
7ee32cda
GM
10621 QChelp = intern (":help");
10622 staticpro (&QChelp);
e8886a1d
RS
10623 QCfilter = intern (":filter");
10624 staticpro (&QCfilter);
10625 QCbutton = intern (":button");
10626 staticpro (&QCbutton);
74c1de23
RS
10627 QCkeys = intern (":keys");
10628 staticpro (&QCkeys);
10629 QCkey_sequence = intern (":key-sequence");
10630 staticpro (&QCkey_sequence);
e8886a1d
RS
10631 QCtoggle = intern (":toggle");
10632 staticpro (&QCtoggle);
10633 QCradio = intern (":radio");
10634 staticpro (&QCradio);
598a9fa7 10635
284f4730
JB
10636 Qmode_line = intern ("mode-line");
10637 staticpro (&Qmode_line);
e5d77022
JB
10638 Qvertical_line = intern ("vertical-line");
10639 staticpro (&Qvertical_line);
3c370943
JB
10640 Qvertical_scroll_bar = intern ("vertical-scroll-bar");
10641 staticpro (&Qvertical_scroll_bar);
5ec75a55
RS
10642 Qmenu_bar = intern ("menu-bar");
10643 staticpro (&Qmenu_bar);
4bb994d1
JB
10644
10645 Qabove_handle = intern ("above-handle");
10646 staticpro (&Qabove_handle);
10647 Qhandle = intern ("handle");
10648 staticpro (&Qhandle);
10649 Qbelow_handle = intern ("below-handle");
10650 staticpro (&Qbelow_handle);
db08707d
RS
10651 Qup = intern ("up");
10652 staticpro (&Qup);
10653 Qdown = intern ("down");
10654 staticpro (&Qdown);
7ee32cda
GM
10655 Qtop = intern ("top");
10656 staticpro (&Qtop);
10657 Qbottom = intern ("bottom");
10658 staticpro (&Qbottom);
10659 Qend_scroll = intern ("end-scroll");
10660 staticpro (&Qend_scroll);
eef28553
SM
10661 Qratio = intern ("ratio");
10662 staticpro (&Qratio);
284f4730 10663
cd21b839 10664 Qevent_kind = intern ("event-kind");
284f4730 10665 staticpro (&Qevent_kind);
88cb0656
JB
10666 Qevent_symbol_elements = intern ("event-symbol-elements");
10667 staticpro (&Qevent_symbol_elements);
0a7f1fc0
JB
10668 Qevent_symbol_element_mask = intern ("event-symbol-element-mask");
10669 staticpro (&Qevent_symbol_element_mask);
10670 Qmodifier_cache = intern ("modifier-cache");
10671 staticpro (&Qmodifier_cache);
284f4730 10672
48e416d4
RS
10673 Qrecompute_lucid_menubar = intern ("recompute-lucid-menubar");
10674 staticpro (&Qrecompute_lucid_menubar);
10675 Qactivate_menubar_hook = intern ("activate-menubar-hook");
10676 staticpro (&Qactivate_menubar_hook);
10677
f4eef8b4
RS
10678 Qpolling_period = intern ("polling-period");
10679 staticpro (&Qpolling_period);
10680
7d18f9ae
RS
10681 Qinput_method_function = intern ("input-method-function");
10682 staticpro (&Qinput_method_function);
10683
d5eecefb
RS
10684 Qinput_method_exit_on_first_char = intern ("input-method-exit-on-first-char");
10685 staticpro (&Qinput_method_exit_on_first_char);
10686 Qinput_method_use_echo_area = intern ("input-method-use-echo-area");
10687 staticpro (&Qinput_method_use_echo_area);
10688
10689 Fset (Qinput_method_exit_on_first_char, Qnil);
10690 Fset (Qinput_method_use_echo_area, Qnil);
10691
e18dfbf4
KR
10692 last_point_position_buffer = Qnil;
10693
284f4730
JB
10694 {
10695 struct event_head *p;
10696
10697 for (p = head_table;
10698 p < head_table + (sizeof (head_table) / sizeof (head_table[0]));
10699 p++)
10700 {
10701 *p->var = intern (p->name);
10702 staticpro (p->var);
10703 Fput (*p->var, Qevent_kind, *p->kind);
88cb0656 10704 Fput (*p->var, Qevent_symbol_elements, Fcons (*p->var, Qnil));
284f4730
JB
10705 }
10706 }
10707
8e1e4240 10708 button_down_location = Fmake_vector (make_number (1), Qnil);
7b4aedb9 10709 staticpro (&button_down_location);
8e1e4240
GM
10710 mouse_syms = Fmake_vector (make_number (1), Qnil);
10711 staticpro (&mouse_syms);
88cb0656
JB
10712
10713 {
10714 int i;
10715 int len = sizeof (modifier_names) / sizeof (modifier_names[0]);
10716
10717 modifier_symbols = Fmake_vector (make_number (len), Qnil);
10718 for (i = 0; i < len; i++)
86e5706b
RS
10719 if (modifier_names[i])
10720 XVECTOR (modifier_symbols)->contents[i] = intern (modifier_names[i]);
88cb0656
JB
10721 staticpro (&modifier_symbols);
10722 }
10723
9deb415a
JB
10724 recent_keys = Fmake_vector (make_number (NUM_RECENT_KEYS), Qnil);
10725 staticpro (&recent_keys);
10726
6569cc8d 10727 this_command_keys = Fmake_vector (make_number (40), Qnil);
715d9345 10728 staticpro (&this_command_keys);
6569cc8d 10729
7d18f9ae
RS
10730 raw_keybuf = Fmake_vector (make_number (30), Qnil);
10731 staticpro (&raw_keybuf);
10732
03b4122a
BF
10733 Qextended_command_history = intern ("extended-command-history");
10734 Fset (Qextended_command_history, Qnil);
10735 staticpro (&Qextended_command_history);
10736
da8f7368
GM
10737 kbd_buffer_gcpro = Fmake_vector (make_number (2 * KBD_BUFFER_SIZE), Qnil);
10738 staticpro (&kbd_buffer_gcpro);
beecf6a1 10739
24597608
RS
10740 accent_key_syms = Qnil;
10741 staticpro (&accent_key_syms);
10742
284f4730
JB
10743 func_key_syms = Qnil;
10744 staticpro (&func_key_syms);
10745
742fbed7 10746#if defined(WINDOWSNT) || defined(MAC_OSX)
07de30b9
GV
10747 mouse_wheel_syms = Qnil;
10748 staticpro (&mouse_wheel_syms);
a24dc617
RS
10749 drag_n_drop_syms = Qnil;
10750 staticpro (&drag_n_drop_syms);
07de30b9
GV
10751#endif
10752
cd21b839
JB
10753 unread_switch_frame = Qnil;
10754 staticpro (&unread_switch_frame);
10755
fe412364
EN
10756 internal_last_event_frame = Qnil;
10757 staticpro (&internal_last_event_frame);
10758
10759 read_key_sequence_cmd = Qnil;
10760 staticpro (&read_key_sequence_cmd);
10761
759860a6
RS
10762 menu_bar_one_keymap_changed_items = Qnil;
10763 staticpro (&menu_bar_one_keymap_changed_items);
10764
a1706c30 10765 defsubr (&Sevent_convert_list);
284f4730 10766 defsubr (&Sread_key_sequence);
e39da3d7 10767 defsubr (&Sread_key_sequence_vector);
284f4730 10768 defsubr (&Srecursive_edit);
2eb6bfbe 10769#ifdef HAVE_MOUSE
284f4730 10770 defsubr (&Strack_mouse);
2eb6bfbe 10771#endif
284f4730
JB
10772 defsubr (&Sinput_pending_p);
10773 defsubr (&Scommand_execute);
10774 defsubr (&Srecent_keys);
10775 defsubr (&Sthis_command_keys);
e39da3d7 10776 defsubr (&Sthis_command_keys_vector);
6321824f 10777 defsubr (&Sthis_single_command_keys);
7d18f9ae 10778 defsubr (&Sthis_single_command_raw_keys);
71918b75 10779 defsubr (&Sreset_this_command_lengths);
82e6e5af 10780 defsubr (&Sclear_this_command_keys);
284f4730
JB
10781 defsubr (&Ssuspend_emacs);
10782 defsubr (&Sabort_recursive_edit);
10783 defsubr (&Sexit_recursive_edit);
10784 defsubr (&Srecursion_depth);
10785 defsubr (&Stop_level);
10786 defsubr (&Sdiscard_input);
10787 defsubr (&Sopen_dribble_file);
10788 defsubr (&Sset_input_mode);
80645119 10789 defsubr (&Scurrent_input_mode);
284f4730
JB
10790 defsubr (&Sexecute_extended_command);
10791
284f4730 10792 DEFVAR_LISP ("last-command-char", &last_command_char,
4707d2d0 10793 doc: /* Last input event that was part of a command. */);
86e5706b 10794
186cf719 10795 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char,
4707d2d0 10796 doc: /* Last input event that was part of a command. */);
284f4730 10797
7d6de002 10798 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event,
4707d2d0
PJ
10799 doc: /* Last input event in a command, except for mouse menu events.
10800Mouse menus give back keys that don't look like mouse events;
10801this variable holds the actual mouse event that led to the menu,
10802so that you can determine whether the command was run by mouse or not. */);
7d6de002 10803
284f4730 10804 DEFVAR_LISP ("last-input-char", &last_input_char,
fa1361cb 10805 doc: /* Last input event. */);
86e5706b 10806
186cf719 10807 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char,
4707d2d0 10808 doc: /* Last input event. */);
284f4730 10809
24597608 10810 DEFVAR_LISP ("unread-command-events", &Vunread_command_events,
4707d2d0
PJ
10811 doc: /* List of events to be read as the command input.
10812These events are processed first, before actual keyboard input. */);
7d18f9ae 10813 Vunread_command_events = Qnil;
284f4730 10814
86e5706b 10815 DEFVAR_INT ("unread-command-char", &unread_command_char,
4707d2d0 10816 doc: /* If not -1, an object to be read as next command input event. */);
86e5706b 10817
7d18f9ae 10818 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events,
4707d2d0
PJ
10819 doc: /* List of events to be processed as input by input methods.
10820These events are processed after `unread-command-events', but
10821before actual keyboard input. */);
7d18f9ae
RS
10822 Vunread_post_input_method_events = Qnil;
10823
10824 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events,
4707d2d0
PJ
10825 doc: /* List of events to be processed as input by input methods.
10826These events are processed after `unread-command-events', but
10827before actual keyboard input. */);
7d18f9ae
RS
10828 Vunread_input_method_events = Qnil;
10829
284f4730 10830 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char,
4707d2d0
PJ
10831 doc: /* Meta-prefix character code.
10832Meta-foo as command input turns into this character followed by foo. */);
18cd2eeb 10833 XSETINT (meta_prefix_char, 033);
284f4730 10834
6c7178b9 10835 DEFVAR_KBOARD ("last-command", Vlast_command,
4707d2d0
PJ
10836 doc: /* The last command executed.
10837Normally a symbol with a function definition, but can be whatever was found
10838in the keymap, or whatever the variable `this-command' was set to by that
10839command.
10840
10841The value `mode-exit' is special; it means that the previous command
10842read an event that told it to exit, and it did so and unread that event.
10843In other words, the present command is the event that made the previous
10844command exit.
10845
10846The value `kill-region' is special; it means that the previous command
10847was a kill command. */);
284f4730 10848
75045dcb 10849 DEFVAR_KBOARD ("real-last-command", Vreal_last_command,
4707d2d0 10850 doc: /* Same as `last-command', but never altered by Lisp code. */);
75045dcb 10851
d5eecefb 10852 DEFVAR_LISP ("this-command", &Vthis_command,
4707d2d0
PJ
10853 doc: /* The command now being executed.
10854The command can set this variable; whatever is put here
10855will be in `last-command' during the following command. */);
d5eecefb 10856 Vthis_command = Qnil;
284f4730 10857
8b9940e6
KS
10858 DEFVAR_LISP ("this-original-command", &Vthis_original_command,
10859 doc: /* If non-nil, the original command bound to the current key sequence.
10860The value of `this-command' is the result of looking up the original
10861command in the active keymaps. */);
10862 Vthis_original_command = Qnil;
10863
284f4730 10864 DEFVAR_INT ("auto-save-interval", &auto_save_interval,
4707d2d0
PJ
10865 doc: /* *Number of input events between auto-saves.
10866Zero means disable autosaving due to number of characters typed. */);
284f4730
JB
10867 auto_save_interval = 300;
10868
10869 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout,
4707d2d0
PJ
10870 doc: /* *Number of seconds idle time before auto-save.
10871Zero or nil means disable auto-saving due to idleness.
10872After auto-saving due to this many seconds of idle time,
10873Emacs also does a garbage collection if that seems to be warranted. */);
bb9e9bed 10874 XSETFASTINT (Vauto_save_timeout, 30);
284f4730 10875
39aab679 10876 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes,
4707d2d0
PJ
10877 doc: /* *Nonzero means echo unfinished commands after this many seconds of pause.
10878The value may be integer or floating point. */);
39aab679 10879 Vecho_keystrokes = make_number (1);
284f4730
JB
10880
10881 DEFVAR_INT ("polling-period", &polling_period,
4707d2d0
PJ
10882 doc: /* *Interval between polling for input during Lisp execution.
10883The reason for polling is to make C-g work to stop a running program.
10884Polling is needed only when using X windows and SIGIO does not work.
10885Polling is automatically disabled in all other cases. */);
284f4730 10886 polling_period = 2;
df0f2ba1 10887
564dc952 10888 DEFVAR_LISP ("double-click-time", &Vdouble_click_time,
4707d2d0
PJ
10889 doc: /* *Maximum time between mouse clicks to make a double-click.
10890Measured in milliseconds. nil means disable double-click recognition;
10891t means double-clicks have no time limit and are detected
10892by position only. */);
aab06933 10893 Vdouble_click_time = make_number (500);
fbcd35bd 10894
222d557c 10895 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz,
4707d2d0
PJ
10896 doc: /* *Maximum mouse movement between clicks to make a double-click.
10897On window-system frames, value is the number of pixels the mouse may have
10898moved horizontally or vertically between two clicks to make a double-click.
10899On non window-system frames, value is interpreted in units of 1/8 characters
1ca6a9c4
RS
10900instead of pixels.
10901
10902This variable is also the threshold for motion of the mouse
10903to count as a drag. */);
222d557c
GM
10904 double_click_fuzz = 3;
10905
03361bcc 10906 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus,
4707d2d0 10907 doc: /* *Non-nil means inhibit local map menu bar menus. */);
03361bcc
RS
10908 inhibit_local_menu_bar_menus = 0;
10909
284f4730 10910 DEFVAR_INT ("num-input-keys", &num_input_keys,
4707d2d0
PJ
10911 doc: /* Number of complete key sequences read as input so far.
10912This includes key sequences read from keyboard macros.
10913The number is effectively the number of interactive command invocations. */);
284f4730
JB
10914 num_input_keys = 0;
10915
c43b1734 10916 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events,
4707d2d0
PJ
10917 doc: /* Number of input events read from the keyboard so far.
10918This does not include events generated by keyboard macros. */);
c43b1734 10919 num_nonmacro_input_events = 0;
fa90970d 10920
4c52b668 10921 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame,
4707d2d0
PJ
10922 doc: /* The frame in which the most recently read event occurred.
10923If the last event came from a keyboard macro, this is set to `macro'. */);
4c52b668
KH
10924 Vlast_event_frame = Qnil;
10925
fa90970d
RS
10926 /* This variable is set up in sysdep.c. */
10927 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char,
4707d2d0 10928 doc: /* The ERASE character as set by the user with stty. */);
fa90970d 10929
7e85b935 10930 DEFVAR_LISP ("help-char", &Vhelp_char,
4707d2d0
PJ
10931 doc: /* Character to recognize as meaning Help.
10932When it is read, do `(eval help-form)', and display result if it's a string.
10933If the value of `help-form' is nil, this char can be read normally. */);
18cd2eeb 10934 XSETINT (Vhelp_char, Ctl ('H'));
284f4730 10935
ecb7cb34 10936 DEFVAR_LISP ("help-event-list", &Vhelp_event_list,
4707d2d0
PJ
10937 doc: /* List of input events to recognize as meaning Help.
10938These work just like the value of `help-char' (see that). */);
ecb7cb34
KH
10939 Vhelp_event_list = Qnil;
10940
284f4730 10941 DEFVAR_LISP ("help-form", &Vhelp_form,
4707d2d0
PJ
10942 doc: /* Form to execute when character `help-char' is read.
10943If the form returns a string, that string is displayed.
10944If `help-form' is nil, the help char is not recognized. */);
284f4730
JB
10945 Vhelp_form = Qnil;
10946
7e85b935 10947 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command,
4707d2d0
PJ
10948 doc: /* Command to run when `help-char' character follows a prefix key.
10949This command is used only when there is no actual binding
10950for that character after that prefix key. */);
7e85b935
RS
10951 Vprefix_help_command = Qnil;
10952
284f4730 10953 DEFVAR_LISP ("top-level", &Vtop_level,
4707d2d0
PJ
10954 doc: /* Form to evaluate when Emacs starts up.
10955Useful to set before you dump a modified Emacs. */);
284f4730
JB
10956 Vtop_level = Qnil;
10957
10958 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table,
4707d2d0
PJ
10959 doc: /* Translate table for keyboard input, or nil.
10960Each character is looked up in this string and the contents used instead.
10961The value may be a string, a vector, or a char-table.
10962If it is a string or vector of length N,
10963character codes N and up are untranslated.
a0acc6c7
DL
10964In a vector or a char-table, an element which is nil means "no translation".
10965
10966This is applied to the characters supplied to input methods, not their
10967output. See also `translation-table-for-input'. */);
284f4730
JB
10968 Vkeyboard_translate_table = Qnil;
10969
8026024c 10970 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend,
4707d2d0
PJ
10971 doc: /* Non-nil means to always spawn a subshell instead of suspending.
10972\(Even if the operating system has support for stopping a process.\) */);
8026024c
KH
10973 cannot_suspend = 0;
10974
284f4730 10975 DEFVAR_BOOL ("menu-prompting", &menu_prompting,
4707d2d0
PJ
10976 doc: /* Non-nil means prompt with menus when appropriate.
10977This is done when reading from a keymap that has a prompt string,
10978for elements that have prompt strings.
10979The menu is displayed on the screen
10980if X menus were enabled at configuration
10981time and the previous event was a mouse click prefix key.
10982Otherwise, menu prompting uses the echo area. */);
284f4730
JB
10983 menu_prompting = 1;
10984
10985 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char,
4707d2d0
PJ
10986 doc: /* Character to see next line of menu prompt.
10987Type this character while in a menu prompt to rotate around the lines of it. */);
18cd2eeb 10988 XSETINT (menu_prompt_more_char, ' ');
9fa4395d
RS
10989
10990 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers,
4707d2d0
PJ
10991 doc: /* A mask of additional modifier keys to use with every keyboard character.
10992Emacs applies the modifiers of the character stored here to each keyboard
10993character it reads. For example, after evaluating the expression
10994 (setq extra-keyboard-modifiers ?\\C-x)
10995all input characters will have the control modifier applied to them.
10996
10997Note that the character ?\\C-@, equivalent to the integer zero, does
10998not count as a control character; rather, it counts as a character
10999with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11000cancels any modification. */);
9fa4395d 11001 extra_keyboard_modifiers = 0;
86e5706b
RS
11002
11003 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark,
4707d2d0
PJ
11004 doc: /* If an editing command sets this to t, deactivate the mark afterward.
11005The command loop sets this to nil before each command,
11006and tests the value when the command returns.
11007Buffer modification stores t in this variable. */);
86e5706b
RS
11008 Vdeactivate_mark = Qnil;
11009
b0f2a7bf 11010 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal,
4707d2d0 11011 doc: /* Temporary storage of pre-command-hook or post-command-hook. */);
b0f2a7bf
KH
11012 Vcommand_hook_internal = Qnil;
11013
86e5706b 11014 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook,
4707d2d0
PJ
11015 doc: /* Normal hook run before each command is executed.
11016If an unhandled error happens in running this hook,
11017the hook value is set to nil, since otherwise the error
11018might happen repeatedly and make Emacs nonfunctional. */);
86e5706b
RS
11019 Vpre_command_hook = Qnil;
11020
11021 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook,
4707d2d0
PJ
11022 doc: /* Normal hook run after each command is executed.
11023If an unhandled error happens in running this hook,
11024the hook value is set to nil, since otherwise the error
11025might happen repeatedly and make Emacs nonfunctional. */);
86e5706b 11026 Vpost_command_hook = Qnil;
48e416d4 11027
59aadc81 11028 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook,
4707d2d0 11029 doc: /* Normal hook run after each command is executed, if idle.
cf9b6656 11030Errors running the hook are caught and ignored. */);
59aadc81
RS
11031 Vpost_command_idle_hook = Qnil;
11032
11033 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay,
4707d2d0
PJ
11034 doc: /* Delay time before running `post-command-idle-hook'.
11035This is measured in microseconds. */);
59aadc81
RS
11036 post_command_idle_delay = 100000;
11037
cf24f894
RS
11038#if 0
11039 DEFVAR_LISP ("echo-area-clear-hook", ...,
4707d2d0 11040 doc: /* Normal hook run when clearing the echo area. */);
cf24f894
RS
11041#endif
11042 Qecho_area_clear_hook = intern ("echo-area-clear-hook");
11043 SET_SYMBOL_VALUE (Qecho_area_clear_hook, Qnil);
cdb9d665 11044
48e416d4 11045 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag,
fa1361cb 11046 doc: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
48e416d4 11047 Vlucid_menu_bar_dirty_flag = Qnil;
a73c5e29 11048
9f9c0e27 11049 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items,
4707d2d0
PJ
11050 doc: /* List of menu bar items to move to the end of the menu bar.
11051The elements of the list are event types that may have menu bar bindings. */);
9f9c0e27 11052 Vmenu_bar_final_items = Qnil;
e9bf89a0 11053
217258d5
KH
11054 DEFVAR_KBOARD ("overriding-terminal-local-map",
11055 Voverriding_terminal_local_map,
4707d2d0
PJ
11056 doc: /* Per-terminal keymap that overrides all other local keymaps.
11057If this variable is non-nil, it is used as a keymap instead of the
11058buffer's local map, and the minor mode keymaps and text property keymaps.
11059This variable is intended to let commands such as `universal-argument'
11060set up a different keymap for reading the next command. */);
217258d5 11061
9dd3131c 11062 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map,
4707d2d0
PJ
11063 doc: /* Keymap that overrides all other local keymaps.
11064If this variable is non-nil, it is used as a keymap instead of the
11065buffer's local map, and the minor mode keymaps and text property keymaps. */);
9dd3131c
RS
11066 Voverriding_local_map = Qnil;
11067
d0a49716 11068 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag,
4707d2d0
PJ
11069 doc: /* Non-nil means `overriding-local-map' applies to the menu bar.
11070Otherwise, the menu bar continues to reflect the buffer's local map
11071and the minor mode maps regardless of `overriding-local-map'. */);
d0a49716
RS
11072 Voverriding_local_map_menu_flag = Qnil;
11073
7f07d5ca 11074 DEFVAR_LISP ("special-event-map", &Vspecial_event_map,
4707d2d0 11075 doc: /* Keymap defining bindings for special events to execute at low level. */);
7f07d5ca
RS
11076 Vspecial_event_map = Fcons (intern ("keymap"), Qnil);
11077
71edead1 11078 DEFVAR_LISP ("track-mouse", &do_mouse_tracking,
4707d2d0 11079 doc: /* *Non-nil means generate motion events for mouse motion. */);
80e4aa30 11080
7c97ffdc 11081 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist,
4707d2d0
PJ
11082 doc: /* Alist of system-specific X windows key symbols.
11083Each element should have the form (N . SYMBOL) where N is the
11084numeric keysym code (sans the \"system-specific\" bit 1<<28)
11085and SYMBOL is its name. */);
8a792f3a
RS
11086
11087 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list,
4707d2d0
PJ
11088 doc: /* List of deferred actions to be performed at a later time.
11089The precise format isn't relevant here; we just check whether it is nil. */);
8a792f3a
RS
11090 Vdeferred_action_list = Qnil;
11091
11092 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function,
4707d2d0
PJ
11093 doc: /* Function to call to handle deferred actions, after each command.
11094This function is called with no arguments after each command
11095whenever `deferred-action-list' is non-nil. */);
8a792f3a 11096 Vdeferred_action_function = Qnil;
6526ab49
RS
11097
11098 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings,
4707d2d0
PJ
11099 doc: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11100The value can be a length of time to show the message for.
11101If the value is non-nil and not a number, we wait 2 seconds. */);
6526ab49 11102 Vsuggest_key_bindings = Qt;
8bb1c042 11103
c04cbc3b 11104 DEFVAR_LISP ("timer-list", &Vtimer_list,
4707d2d0 11105 doc: /* List of active absolute time timers in order of increasing time. */);
c04cbc3b 11106 Vtimer_list = Qnil;
d9d4c147
KH
11107
11108 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list,
4707d2d0 11109 doc: /* List of active idle-time timers in order of increasing time. */);
d9d4c147 11110 Vtimer_idle_list = Qnil;
7d18f9ae
RS
11111
11112 DEFVAR_LISP ("input-method-function", &Vinput_method_function,
4707d2d0
PJ
11113 doc: /* If non-nil, the function that implements the current input method.
11114It's called with one argument, a printing character that was just read.
11115\(That means a character with code 040...0176.)
11116Typically this function uses `read-event' to read additional events.
11117When it does so, it should first bind `input-method-function' to nil
11118so it will not be called recursively.
11119
11120The function should return a list of zero or more events
11121to be used as input. If it wants to put back some events
11122to be reconsidered, separately, by the input method,
11123it can add them to the beginning of `unread-command-events'.
11124
11125The input method function can find in `input-method-previous-method'
11126the previous echo area message.
11127
11128The input method function should refer to the variables
11129`input-method-use-echo-area' and `input-method-exit-on-first-char'
11130for guidance on what to do. */);
7d18f9ae 11131 Vinput_method_function = Qnil;
d5eecefb
RS
11132
11133 DEFVAR_LISP ("input-method-previous-message",
11134 &Vinput_method_previous_message,
4707d2d0
PJ
11135 doc: /* When `input-method-function' is called, hold the previous echo area message.
11136This variable exists because `read-event' clears the echo area
11137before running the input method. It is nil if there was no message. */);
d5eecefb 11138 Vinput_method_previous_message = Qnil;
7ee32cda
GM
11139
11140 DEFVAR_LISP ("show-help-function", &Vshow_help_function,
4707d2d0
PJ
11141 doc: /* If non-nil, the function that implements the display of help.
11142It's called with one argument, the help string to display. */);
7ee32cda 11143 Vshow_help_function = Qnil;
adf5cb9c
KH
11144
11145 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment,
4707d2d0
PJ
11146 doc: /* If non-nil, suppress point adjustment after executing a command.
11147
11148After a command is executed, if point is moved into a region that has
11149special properties (e.g. composition, display), we adjust point to
11150the boundary of the region. But, several special commands sets this
11151variable to non-nil, then we suppress the point adjustment.
11152
11153This variable is set to nil before reading a command, and is checked
11154just after executing the command. */);
adf5cb9c
KH
11155 Vdisable_point_adjustment = Qnil;
11156
11157 DEFVAR_LISP ("global-disable-point-adjustment",
11158 &Vglobal_disable_point_adjustment,
4707d2d0
PJ
11159 doc: /* *If non-nil, always suppress point adjustment.
11160
11161The default value is nil, in which case, point adjustment are
11162suppressed only after special commands that set
11163`disable-point-adjustment' (which see) to non-nil. */);
adf5cb9c 11164 Vglobal_disable_point_adjustment = Qnil;
3626fb1a 11165
a1d34b1e 11166 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings,
4707d2d0
PJ
11167 doc: /* Non-nil means updating menu bindings is allowed.
11168A value of nil means menu bindings should not be updated.
11169Used during Emacs' startup. */);
3626fb1a 11170 update_menu_bindings = 1;
00392ce6
MB
11171
11172 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout,
4707d2d0
PJ
11173 doc: /* *How long to display an echo-area message when the minibuffer is active.
11174If the value is not a number, such messages don't time out. */);
00392ce6 11175 Vminibuffer_message_timeout = make_number (2);
284f4730
JB
11176}
11177
dfcf069d 11178void
284f4730
JB
11179keys_of_keyboard ()
11180{
11181 initial_define_key (global_map, Ctl ('Z'), "suspend-emacs");
11182 initial_define_key (control_x_map, Ctl ('Z'), "suspend-emacs");
11183 initial_define_key (meta_map, Ctl ('C'), "exit-recursive-edit");
11184 initial_define_key (global_map, Ctl (']'), "abort-recursive-edit");
11185 initial_define_key (meta_map, 'x', "execute-extended-command");
7f07d5ca
RS
11186
11187 initial_define_lispy_key (Vspecial_event_map, "delete-frame",
11188 "handle-delete-frame");
11189 initial_define_lispy_key (Vspecial_event_map, "iconify-frame",
11190 "ignore-event");
11191 initial_define_lispy_key (Vspecial_event_map, "make-frame-visible",
11192 "ignore-event");
a697f886
PJ
11193 initial_define_lispy_key (Vspecial_event_map, "select-window",
11194 "handle-select-window");
4ebc27a5
JD
11195 initial_define_lispy_key (Vspecial_event_map, "save-session",
11196 "handle-save-session");
284f4730 11197}