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