(dired-do-shell-command): New arg FILE-LIST
[bpt/emacs.git] / src / keyboard.c
CommitLineData
284f4730 1/* Keyboard and mouse input; editor command loop.
d925fb39 2 Copyright (C) 1985,86,87,88,89,93,94,95,96,97 Free Software Foundation, Inc.
284f4730
JB
3
4This file is part of GNU Emacs.
5
6GNU Emacs is free software; you can redistribute it and/or modify
7it under the terms of the GNU General Public License as published by
7b4aedb9 8the Free Software Foundation; either version 2, or (at your option)
284f4730
JB
9any later version.
10
11GNU Emacs is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with GNU Emacs; see the file COPYING. If not, write to
3b7ad313
EN
18the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19Boston, MA 02111-1307, USA. */
284f4730
JB
20
21/* Allow config.h to undefine symbols found here. */
22#include <signal.h>
23
18160b98 24#include <config.h>
284f4730 25#include <stdio.h>
284f4730
JB
26#include "termchar.h"
27#include "termopts.h"
28#include "lisp.h"
29#include "termhooks.h"
30#include "macros.h"
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"
284f4730 38#include "keyboard.h"
497ba7a1 39#include "intervals.h"
9ac0d9e0 40#include "blockinput.h"
284f4730
JB
41#include <setjmp.h>
42#include <errno.h>
43
80e4aa30
RS
44#ifdef MSDOS
45#include "msdos.h"
46#include <time.h>
47#else /* not MSDOS */
284f4730
JB
48#ifndef VMS
49#include <sys/ioctl.h>
284f4730 50#endif
80e4aa30 51#endif /* not MSDOS */
284f4730 52
52baf19e 53#include "syssignal.h"
6ef5b54f 54#include "systty.h"
52baf19e 55
c5e3b6c5
RS
56/* This is to get the definitions of the XK_ symbols. */
57#ifdef HAVE_X_WINDOWS
58#include "xterm.h"
59#endif
60
e98a93eb
GV
61#ifdef HAVE_NTGUI
62#include "w32term.h"
63#endif /* HAVE_NTGUI */
64
0c2611c5
RS
65/* Include systime.h after xterm.h to avoid double inclusion of time.h. */
66#include "systime.h"
67
52baf19e
JB
68extern int errno;
69
9ac0d9e0
JB
70/* Variables for blockinput.h: */
71
72/* Non-zero if interrupt input is blocked right now. */
63927c41 73int interrupt_input_blocked;
9ac0d9e0
JB
74
75/* Nonzero means an input interrupt has arrived
76 during the current critical section. */
63927c41 77int interrupt_input_pending;
9ac0d9e0
JB
78
79
437f6112
RS
80/* File descriptor to use for input. */
81extern int input_fd;
284f4730 82
e98a93eb 83#ifdef HAVE_WINDOW_SYSTEM
284f4730
JB
84/* Make all keyboard buffers much bigger when using X windows. */
85#define KBD_BUFFER_SIZE 4096
86#else /* No X-windows, character input */
87#define KBD_BUFFER_SIZE 256
88#endif /* No X-windows */
89
90/* Following definition copied from eval.c */
91
92struct backtrace
93 {
94 struct backtrace *next;
95 Lisp_Object *function;
96 Lisp_Object *args; /* Points to vector of args. */
97 int nargs; /* length of vector. If nargs is UNEVALLED,
98 args points to slot holding list of
99 unevalled args */
100 char evalargs;
101 };
102
c5fdd383
KH
103#ifdef MULTI_KBOARD
104KBOARD *initial_kboard;
105KBOARD *current_kboard;
106KBOARD *all_kboards;
1e8bd3da 107int single_kboard;
6c6083a9 108#else
c5fdd383 109KBOARD the_only_kboard;
6c6083a9 110#endif
612b78ef 111
284f4730
JB
112/* Non-nil disable property on a command means
113 do not execute it; call disabled-command-hook's value instead. */
2e894dab 114Lisp_Object Qdisabled, Qdisabled_command_hook;
284f4730
JB
115
116#define NUM_RECENT_KEYS (100)
117int recent_keys_index; /* Index for storing next element into recent_keys */
118int total_keys; /* Total number of elements stored into recent_keys */
5160df46 119Lisp_Object recent_keys; /* A vector, holding the last 100 keystrokes */
284f4730 120
6569cc8d
JB
121/* Vector holding the key sequence that invoked the current command.
122 It is reused for each command, and it may be longer than the current
123 sequence; this_command_key_count indicates how many elements
124 actually mean something.
125 It's easier to staticpro a single Lisp_Object than an array. */
126Lisp_Object this_command_keys;
127int this_command_key_count;
284f4730 128
6321824f
RS
129/* Number of elements of this_command_keys
130 that precede this key sequence. */
131int this_single_command_key_start;
132
71918b75
RS
133/* Record values of this_command_key_count and echo_length ()
134 before this command was read. */
135static int before_command_key_count;
136static int before_command_echo_length;
137/* Values of before_command_key_count and before_command_echo_length
138 saved by reset-this-command-lengths. */
139static int before_command_key_count_1;
140static int before_command_echo_length_1;
141/* Flag set by reset-this-command-lengths,
142 saying to reset the lengths when add_command_key is called. */
143static int before_command_restore_flag;
144
284f4730
JB
145extern int minbuf_level;
146
147extern struct backtrace *backtrace_list;
148
149/* Nonzero means do menu prompting. */
150static int menu_prompting;
151
152/* Character to see next line of menu prompt. */
153static Lisp_Object menu_prompt_more_char;
154
155/* For longjmp to where kbd input is being done. */
156static jmp_buf getcjmp;
157
158/* True while doing kbd input. */
159int waiting_for_input;
160
161/* True while displaying for echoing. Delays C-g throwing. */
162static int echoing;
163
1fc93d49
RS
164/* True means we can start echoing at the next input pause
165 even though there is something in the echo area. */
0c04a67e 166static char *ok_to_echo_at_next_pause;
1fc93d49 167
03361bcc
RS
168/* Nonzero means disregard local maps for the menu bar. */
169static int inhibit_local_menu_bar_menus;
170
80e4aa30 171/* Nonzero means C-g should cause immediate error-signal. */
284f4730
JB
172int immediate_quit;
173
fa90970d
RS
174/* The user's ERASE setting. */
175Lisp_Object Vtty_erase_char;
176
284f4730 177/* Character to recognize as the help char. */
7e85b935 178Lisp_Object Vhelp_char;
284f4730 179
ecb7cb34
KH
180/* List of other event types to recognize as meaning "help". */
181Lisp_Object Vhelp_event_list;
182
284f4730
JB
183/* Form to execute when help char is typed. */
184Lisp_Object Vhelp_form;
185
7e85b935
RS
186/* Command to run when the help character follows a prefix key. */
187Lisp_Object Vprefix_help_command;
188
9f9c0e27
RS
189/* List of items that should move to the end of the menu bar. */
190Lisp_Object Vmenu_bar_final_items;
a73c5e29 191
6526ab49
RS
192/* Non-nil means show the equivalent key-binding for
193 any M-x command that has one.
194 The value can be a length of time to show the message for.
195 If the value is non-nil and not a number, we wait 2 seconds. */
196Lisp_Object Vsuggest_key_bindings;
197
284f4730
JB
198/* Character that causes a quit. Normally C-g.
199
200 If we are running on an ordinary terminal, this must be an ordinary
201 ASCII char, since we want to make it our interrupt character.
202
203 If we are not running on an ordinary terminal, it still needs to be
204 an ordinary ASCII char. This character needs to be recognized in
205 the input interrupt handler. At this point, the keystroke is
206 represented as a struct input_event, while the desired quit
207 character is specified as a lispy event. The mapping from struct
208 input_events to lispy events cannot run in an interrupt handler,
209 and the reverse mapping is difficult for anything but ASCII
210 keystrokes.
211
212 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
213 ASCII character. */
214int quit_char;
215
216extern Lisp_Object current_global_map;
217extern int minibuf_level;
218
9dd3131c
RS
219/* If non-nil, this is a map that overrides all other local maps. */
220Lisp_Object Voverriding_local_map;
221
d0a49716
RS
222/* If non-nil, Voverriding_local_map applies to the menu bar. */
223Lisp_Object Voverriding_local_map_menu_flag;
224
7f07d5ca
RS
225/* Keymap that defines special misc events that should
226 be processed immediately at a low level. */
227Lisp_Object Vspecial_event_map;
228
284f4730
JB
229/* Current depth in recursive edits. */
230int command_loop_level;
231
232/* Total number of times command_loop has read a key sequence. */
233int num_input_keys;
234
235/* Last input character read as a command. */
236Lisp_Object last_command_char;
237
7d6de002
RS
238/* Last input character read as a command, not counting menus
239 reached by the mouse. */
240Lisp_Object last_nonmenu_event;
241
284f4730
JB
242/* Last input character read for any purpose. */
243Lisp_Object last_input_char;
244
dbc4e1c1 245/* If not Qnil, a list of objects to be read as subsequent command input. */
24597608 246Lisp_Object Vunread_command_events;
284f4730 247
86e5706b
RS
248/* If not -1, an event to be read as subsequent command input. */
249int unread_command_char;
250
cd21b839
JB
251/* If not Qnil, this is a switch-frame event which we decided to put
252 off until the end of a key sequence. This should be read as the
dbc4e1c1 253 next command input, after any unread_command_events.
8f805655
JB
254
255 read_key_sequence uses this to delay switch-frame events until the
256 end of the key sequence; Fread_char uses it to put off switch-frame
257 events until a non-ASCII event is acceptable as input. */
258Lisp_Object unread_switch_frame;
cd21b839 259
9fa4395d
RS
260/* A mask of extra modifier bits to put into every keyboard char. */
261int extra_keyboard_modifiers;
262
284f4730
JB
263/* Char to use as prefix when a meta character is typed in.
264 This is bound on entry to minibuffer in case ESC is changed there. */
265
266Lisp_Object meta_prefix_char;
267
268/* Last size recorded for a current buffer which is not a minibuffer. */
269static int last_non_minibuf_size;
270
06ef7355 271/* Number of idle seconds before an auto-save and garbage collection. */
284f4730
JB
272static Lisp_Object Vauto_save_timeout;
273
274/* Total number of times read_char has returned. */
4abfba1f 275int num_input_events;
284f4730 276
51172b6d 277/* Total number of times read_char has returned, outside of macros. */
c43b1734 278int num_nonmacro_input_events;
51172b6d 279
284f4730
JB
280/* Auto-save automatically when this many characters have been typed
281 since the last time. */
282
283static int auto_save_interval;
284
c43b1734 285/* Value of num_nonmacro_input_events as of last auto save. */
284f4730
JB
286
287int last_auto_save;
288
284f4730 289/* The command being executed by the command loop.
6c7178b9
KH
290 Commands may set this, and the value set will be copied into
291 current_kboard->Vlast_command instead of the actual command. */
284f4730
JB
292Lisp_Object this_command;
293
b453f72e
KH
294/* The value of point when the last command was executed. */
295int last_point_position;
296
047688cb
RS
297/* The buffer that was current when the last command was started. */
298Lisp_Object last_point_position_buffer;
299
4c52b668
KH
300/* The frame in which the last input event occurred, or Qmacro if the
301 last event came from a macro. We use this to determine when to
302 generate switch-frame events. This may be cleared by functions
303 like Fselect_frame, to make sure that a switch-frame event is
304 generated by the next character. */
305Lisp_Object internal_last_event_frame;
4c52b668
KH
306
307/* A user-visible version of the above, intended to allow users to
308 figure out where the last event came from, if the event doesn't
309 carry that information itself (i.e. if it was a character). */
310Lisp_Object Vlast_event_frame;
311
1113d9db
JB
312/* The timestamp of the last input event we received from the X server.
313 X Windows wants this for selection ownership. */
284f4730
JB
314unsigned long last_event_timestamp;
315
316Lisp_Object Qself_insert_command;
317Lisp_Object Qforward_char;
318Lisp_Object Qbackward_char;
e58aa385 319Lisp_Object Qundefined;
d925fb39 320Lisp_Object Qtimer_event_handler;
284f4730
JB
321
322/* read_key_sequence stores here the command definition of the
323 key sequence that it reads. */
324Lisp_Object read_key_sequence_cmd;
325
326/* Form to evaluate (if non-nil) when Emacs is started. */
327Lisp_Object Vtop_level;
328
329/* User-supplied string to translate input characters through. */
330Lisp_Object Vkeyboard_translate_table;
331
332/* Keymap mapping ASCII function key sequences onto their preferred forms. */
333extern Lisp_Object Vfunction_key_map;
334
e0301c07
RS
335/* Another keymap that maps key sequences into key sequences.
336 This one takes precedence over ordinary definitions. */
337extern Lisp_Object Vkey_translation_map;
a612e298 338
86e5706b
RS
339/* Non-nil means deactivate the mark at end of this command. */
340Lisp_Object Vdeactivate_mark;
341
48e416d4
RS
342/* Menu bar specified in Lucid Emacs fashion. */
343
344Lisp_Object Vlucid_menu_bar_dirty_flag;
345Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;
346
cdb9d665
RS
347Lisp_Object Qecho_area_clear_hook;
348
86e5706b 349/* Hooks to run before and after each command. */
59aadc81
RS
350Lisp_Object Qpre_command_hook, Vpre_command_hook;
351Lisp_Object Qpost_command_hook, Vpost_command_hook;
40932d1a 352Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
59aadc81
RS
353/* Hook run after a command if there's no more input soon. */
354Lisp_Object Qpost_command_idle_hook, Vpost_command_idle_hook;
355
356/* Delay time in microseconds before running post-command-idle-hook. */
357int post_command_idle_delay;
86e5706b 358
8a792f3a
RS
359/* List of deferred actions to be performed at a later time.
360 The precise format isn't relevant here; we just check whether it is nil. */
361Lisp_Object Vdeferred_action_list;
362
363/* Function to call to handle deferred actions, when there are any. */
364Lisp_Object Vdeferred_action_function;
3ef14e46 365Lisp_Object Qdeferred_action_function;
8a792f3a 366
284f4730
JB
367/* File in which we write all commands we read. */
368FILE *dribble;
369
370/* Nonzero if input is available. */
371int input_pending;
372
b04904fb
RS
373/* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
374 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
375
284f4730
JB
376int meta_key;
377
378extern char *pending_malloc_warning;
379
beecf6a1
KH
380/* Circular buffer for pre-read keyboard input. */
381static struct input_event kbd_buffer[KBD_BUFFER_SIZE];
382
383/* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
384
385 The interrupt-level event handlers will never enqueue an event on a
386 frame which is not in Vframe_list, and once an event is dequeued,
387 internal_last_event_frame or the event itself points to the frame.
388 So that's all fine.
389
390 But while the event is sitting in the queue, it's completely
391 unprotected. Suppose the user types one command which will run for
392 a while and then delete a frame, and then types another event at
393 the frame that will be deleted, before the command gets around to
394 it. Suppose there are no references to this frame elsewhere in
395 Emacs, and a GC occurs before the second event is dequeued. Now we
396 have an event referring to a freed frame, which will crash Emacs
397 when it is dequeued.
398
399 Similar things happen when an event on a scroll bar is enqueued; the
400 window may be deleted while the event is in the queue.
401
402 So, we use this vector to protect the frame_or_window field in the
403 event queue. That way, they'll be dequeued as dead frames or
404 windows, but still valid lisp objects.
405
406 If kbd_buffer[i].kind != no_event, then
407 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
408 == kbd_buffer[i].frame_or_window. */
409static Lisp_Object kbd_buffer_frame_or_window;
410
411/* Pointer to next available character in kbd_buffer.
412 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
413 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
414 next available char is in kbd_buffer[0]. */
415static struct input_event *kbd_fetch_ptr;
416
417/* Pointer to next place to store character in kbd_buffer. This
418 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
419 character should go in kbd_buffer[0]. */
420static volatile struct input_event *kbd_store_ptr;
421
422/* The above pair of variables forms a "queue empty" flag. When we
423 enqueue a non-hook event, we increment kbd_store_ptr. When we
424 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
425 there is input available iff the two pointers are not equal.
426
427 Why not just have a flag set and cleared by the enqueuing and
428 dequeuing functions? Such a flag could be screwed up by interrupts
429 at inopportune times. */
430
f3253854 431/* If this flag is non-nil, we check mouse_moved to see when the
a9d77f1f
RS
432 mouse moves, and motion events will appear in the input stream.
433 Otherwise, mouse motion is ignored. */
434static Lisp_Object do_mouse_tracking;
284f4730 435
284f4730
JB
436/* Symbols to head events. */
437Lisp_Object Qmouse_movement;
3c370943 438Lisp_Object Qscroll_bar_movement;
cd21b839 439Lisp_Object Qswitch_frame;
bbdc2092 440Lisp_Object Qdelete_frame;
af17bd2b
KH
441Lisp_Object Qiconify_frame;
442Lisp_Object Qmake_frame_visible;
cd21b839 443
284f4730
JB
444/* Symbols to denote kinds of events. */
445Lisp_Object Qfunction_key;
446Lisp_Object Qmouse_click;
447/* Lisp_Object Qmouse_movement; - also an event header */
284f4730
JB
448
449/* Properties of event headers. */
450Lisp_Object Qevent_kind;
88cb0656 451Lisp_Object Qevent_symbol_elements;
284f4730 452
598a9fa7
JB
453Lisp_Object Qmenu_enable;
454
0a7f1fc0
JB
455/* An event header symbol HEAD may have a property named
456 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
457 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
458 mask of modifiers applied to it. If present, this is used to help
459 speed up parse_modifiers. */
460Lisp_Object Qevent_symbol_element_mask;
461
462/* An unmodified event header BASE may have a property named
463 Qmodifier_cache, which is an alist mapping modifier masks onto
464 modified versions of BASE. If present, this helps speed up
465 apply_modifiers. */
466Lisp_Object Qmodifier_cache;
467
5ec75a55 468/* Symbols to use for parts of windows. */
284f4730 469Lisp_Object Qmode_line;
e5d77022 470Lisp_Object Qvertical_line;
3c370943 471Lisp_Object Qvertical_scroll_bar;
5ec75a55
RS
472Lisp_Object Qmenu_bar;
473
474extern Lisp_Object Qmenu_enable;
284f4730 475
f4255cd1
JB
476Lisp_Object recursive_edit_unwind (), command_loop ();
477Lisp_Object Fthis_command_keys ();
03b4122a 478Lisp_Object Qextended_command_history;
c04cbc3b 479EMACS_TIME timer_check ();
284f4730 480
2c834fb3
KH
481extern char *x_get_keysym_name ();
482
8eb4d8ef
RS
483static void record_menu_key ();
484
f4eef8b4
RS
485Lisp_Object Qpolling_period;
486
d9d4c147 487/* List of absolute timers. Appears in order of next scheduled event. */
c04cbc3b
RS
488Lisp_Object Vtimer_list;
489
d9d4c147
KH
490/* List of idle time timers. Appears in order of next scheduled event. */
491Lisp_Object Vtimer_idle_list;
492
87dd9b9b
RS
493/* Incremented whenever a timer is run. */
494int timers_run;
495
a9f16aa9
KH
496extern Lisp_Object Vprint_level, Vprint_length;
497
ffd56f97
JB
498/* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
499 happens. */
500EMACS_TIME *input_available_clear_time;
284f4730
JB
501
502/* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
503 Default is 1 if INTERRUPT_INPUT is defined. */
504int interrupt_input;
505
506/* Nonzero while interrupts are temporarily deferred during redisplay. */
507int interrupts_deferred;
508
87dd9b9b 509/* Nonzero means use ^S/^Q for flow control. */
284f4730
JB
510int flow_control;
511
284f4730
JB
512/* Allow m- file to inhibit use of FIONREAD. */
513#ifdef BROKEN_FIONREAD
514#undef FIONREAD
515#endif
516
517/* We are unable to use interrupts if FIONREAD is not available,
518 so flush SIGIO so we won't try. */
519#ifndef FIONREAD
520#ifdef SIGIO
521#undef SIGIO
522#endif
523#endif
524
e98a93eb 525/* If we support a window system, turn on the code to poll periodically
34f04431 526 to detect C-g. It isn't actually used when doing interrupt input. */
e98a93eb 527#ifdef HAVE_WINDOW_SYSTEM
284f4730
JB
528#define POLL_FOR_INPUT
529#endif
284f4730
JB
530\f
531/* Global variable declarations. */
532
533/* Function for init_keyboard to call with no args (if nonzero). */
534void (*keyboard_init_hook) ();
535
536static int read_avail_input ();
537static void get_input_pending ();
9fd7d808 538static int readable_events ();
8150596a
RS
539static Lisp_Object read_char_x_menu_prompt ();
540static Lisp_Object read_char_minibuf_menu_prompt ();
a612e298 541static Lisp_Object make_lispy_event ();
514354e9 542#ifdef HAVE_MOUSE
a612e298 543static Lisp_Object make_lispy_movement ();
514354e9 544#endif
a612e298
RS
545static Lisp_Object modify_event_symbol ();
546static Lisp_Object make_lispy_switch_frame ();
3d31316f 547static int parse_solitary_modifier ();
284f4730
JB
548
549/* > 0 if we are to echo keystrokes. */
550static int echo_keystrokes;
551
8026024c
KH
552/* Nonzero means don't try to suspend even if the operating system seems
553 to support it. */
554static int cannot_suspend;
555
284f4730
JB
556#define min(a,b) ((a)<(b)?(a):(b))
557#define max(a,b) ((a)>(b)?(a):(b))
558
559/* Install the string STR as the beginning of the string of echoing,
560 so that it serves as a prompt for the next character.
561 Also start echoing. */
562
563echo_prompt (str)
564 char *str;
565{
566 int len = strlen (str);
7a80a6f6 567
ba72822c
KH
568 if (len > ECHOBUFSIZE - 4)
569 len = ECHOBUFSIZE - 4;
c5fdd383
KH
570 bcopy (str, current_kboard->echobuf, len);
571 current_kboard->echoptr = current_kboard->echobuf + len;
572 *current_kboard->echoptr = '\0';
284f4730 573
c5fdd383 574 current_kboard->echo_after_prompt = len;
7a80a6f6 575
3dbd9ee4 576 echo_now ();
284f4730
JB
577}
578
df0f2ba1 579/* Add C to the echo string, if echoing is going on.
284f4730
JB
580 C can be a character, which is printed prettily ("M-C-x" and all that
581 jazz), or a symbol, whose name is printed. */
582
583echo_char (c)
584 Lisp_Object c;
585{
586 extern char *push_key_description ();
587
c5fdd383 588 if (current_kboard->immediate_echo)
284f4730 589 {
c5fdd383 590 char *ptr = current_kboard->echoptr;
df0f2ba1 591
c5fdd383 592 if (ptr != current_kboard->echobuf)
284f4730
JB
593 *ptr++ = ' ';
594
595 /* If someone has passed us a composite event, use its head symbol. */
88cb0656 596 c = EVENT_HEAD (c);
284f4730 597
8c18cbfb 598 if (INTEGERP (c))
284f4730 599 {
c5fdd383 600 if (ptr - current_kboard->echobuf > ECHOBUFSIZE - 6)
284f4730
JB
601 return;
602
cb5df6ae 603 ptr = push_key_description (XINT (c), ptr);
284f4730 604 }
8c18cbfb 605 else if (SYMBOLP (c))
284f4730
JB
606 {
607 struct Lisp_String *name = XSYMBOL (c)->name;
c5fdd383 608 if ((ptr - current_kboard->echobuf) + name->size + 4 > ECHOBUFSIZE)
284f4730
JB
609 return;
610 bcopy (name->data, ptr, name->size);
611 ptr += name->size;
612 }
613
c5fdd383 614 if (current_kboard->echoptr == current_kboard->echobuf
ecb7cb34 615 && help_char_p (c))
284f4730
JB
616 {
617 strcpy (ptr, " (Type ? for further options)");
618 ptr += strlen (ptr);
619 }
620
621 *ptr = 0;
c5fdd383 622 current_kboard->echoptr = ptr;
284f4730 623
3dbd9ee4 624 echo_now ();
284f4730
JB
625 }
626}
627
628/* Temporarily add a dash to the end of the echo string if it's not
629 empty, so that it serves as a mini-prompt for the very next character. */
630
631echo_dash ()
632{
c5fdd383
KH
633 if (!current_kboard->immediate_echo
634 && current_kboard->echoptr == current_kboard->echobuf)
284f4730 635 return;
7a80a6f6 636 /* Do nothing if we just printed a prompt. */
c5fdd383
KH
637 if (current_kboard->echo_after_prompt
638 == current_kboard->echoptr - current_kboard->echobuf)
7a80a6f6 639 return;
4bafa972 640 /* Do nothing if not echoing at all. */
c5fdd383 641 if (current_kboard->echoptr == 0)
4bafa972 642 return;
284f4730
JB
643
644 /* Put a dash at the end of the buffer temporarily,
645 but make it go away when the next character is added. */
c5fdd383
KH
646 current_kboard->echoptr[0] = '-';
647 current_kboard->echoptr[1] = 0;
284f4730 648
3dbd9ee4 649 echo_now ();
284f4730
JB
650}
651
652/* Display the current echo string, and begin echoing if not already
653 doing so. */
654
3dbd9ee4 655echo_now ()
284f4730 656{
c5fdd383 657 if (!current_kboard->immediate_echo)
284f4730
JB
658 {
659 int i;
c5fdd383 660 current_kboard->immediate_echo = 1;
284f4730
JB
661
662 for (i = 0; i < this_command_key_count; i++)
d0a57728
RS
663 {
664 Lisp_Object c;
665 c = XVECTOR (this_command_keys)->contents[i];
666 if (! (EVENT_HAS_PARAMETERS (c)
667 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
668 echo_char (c);
669 }
284f4730
JB
670 echo_dash ();
671 }
672
673 echoing = 1;
c5fdd383 674 message1_nolog (current_kboard->echobuf);
284f4730
JB
675 echoing = 0;
676
677 if (waiting_for_input && !NILP (Vquit_flag))
678 quit_throw_to_read_char ();
679}
680
681/* Turn off echoing, for the start of a new command. */
682
683cancel_echoing ()
684{
c5fdd383
KH
685 current_kboard->immediate_echo = 0;
686 current_kboard->echoptr = current_kboard->echobuf;
687 current_kboard->echo_after_prompt = -1;
1fc93d49 688 ok_to_echo_at_next_pause = 0;
284f4730
JB
689}
690
691/* Return the length of the current echo string. */
692
693static int
694echo_length ()
695{
c5fdd383 696 return current_kboard->echoptr - current_kboard->echobuf;
284f4730
JB
697}
698
699/* Truncate the current echo message to its first LEN chars.
700 This and echo_char get used by read_key_sequence when the user
ff11dfa1 701 switches frames while entering a key sequence. */
284f4730
JB
702
703static void
704echo_truncate (len)
705 int len;
706{
c5fdd383
KH
707 current_kboard->echobuf[len] = '\0';
708 current_kboard->echoptr = current_kboard->echobuf + len;
40932d1a 709 truncate_echo_area (len);
284f4730
JB
710}
711
712\f
713/* Functions for manipulating this_command_keys. */
714static void
715add_command_key (key)
716 Lisp_Object key;
717{
6569cc8d
JB
718 int size = XVECTOR (this_command_keys)->size;
719
71918b75
RS
720 /* If reset-this-command-length was called recently, obey it now.
721 See the doc string of that function for an explanation of why. */
722 if (before_command_restore_flag)
723 {
724 this_command_key_count = before_command_key_count_1;
6321824f
RS
725 if (this_command_key_count < this_single_command_key_start)
726 this_single_command_key_start = this_command_key_count;
71918b75
RS
727 echo_truncate (before_command_echo_length_1);
728 before_command_restore_flag = 0;
729 }
730
6569cc8d 731 if (this_command_key_count >= size)
284f4730 732 {
9b8eb840 733 Lisp_Object new_keys;
6569cc8d 734
9b8eb840 735 new_keys = Fmake_vector (make_number (size * 2), Qnil);
6569cc8d
JB
736 bcopy (XVECTOR (this_command_keys)->contents,
737 XVECTOR (new_keys)->contents,
8f805655 738 size * sizeof (Lisp_Object));
6569cc8d
JB
739
740 this_command_keys = new_keys;
284f4730 741 }
6569cc8d
JB
742
743 XVECTOR (this_command_keys)->contents[this_command_key_count++] = key;
284f4730
JB
744}
745\f
746Lisp_Object
747recursive_edit_1 ()
748{
749 int count = specpdl_ptr - specpdl;
750 Lisp_Object val;
751
752 if (command_loop_level > 0)
753 {
754 specbind (Qstandard_output, Qt);
755 specbind (Qstandard_input, Qt);
756 }
757
758 val = command_loop ();
759 if (EQ (val, Qt))
760 Fsignal (Qquit, Qnil);
cb252880
RS
761 /* Handle throw from read_minibuf when using minibuffer
762 while it's active but we're in another window. */
763 if (STRINGP (val))
764 Fsignal (Qerror, Fcons (val, Qnil));
284f4730 765
cb5df6ae 766 return unbind_to (count, Qnil);
284f4730
JB
767}
768
769/* When an auto-save happens, record the "time", and don't do again soon. */
5846638c 770
284f4730
JB
771record_auto_save ()
772{
c43b1734 773 last_auto_save = num_nonmacro_input_events;
284f4730 774}
5846638c
RS
775
776/* Make an auto save happen as soon as possible at command level. */
777
778force_auto_save_soon ()
779{
780 last_auto_save = - auto_save_interval - 1;
241ceaf7
RS
781
782 record_asynch_buffer_change ();
5846638c 783}
284f4730 784\f
284f4730
JB
785DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
786 "Invoke the editor command loop recursively.\n\
787To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
788that tells this function to return.\n\
789Alternately, `(throw 'exit t)' makes this function signal an error.\n\
790This function is called by the editor initialization to begin editing.")
791 ()
792{
793 int count = specpdl_ptr - specpdl;
794 Lisp_Object val;
795
796 command_loop_level++;
797 update_mode_lines = 1;
798
799 record_unwind_protect (recursive_edit_unwind,
800 (command_loop_level
801 && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
802 ? Fcurrent_buffer ()
803 : Qnil);
804 recursive_edit_1 ();
805 return unbind_to (count, Qnil);
806}
807
808Lisp_Object
809recursive_edit_unwind (buffer)
810 Lisp_Object buffer;
811{
812 if (!NILP (buffer))
813 Fset_buffer (buffer);
814
815 command_loop_level--;
816 update_mode_lines = 1;
817 return Qnil;
818}
819\f
604ccd1d 820static void
1e8bd3da 821any_kboard_state ()
604ccd1d 822{
1e8bd3da
RS
823#ifdef MULTI_KBOARD
824#if 0 /* Theory: if there's anything in Vunread_command_events,
825 it will right away be read by read_key_sequence,
826 and then if we do switch KBOARDS, it will go into the side
827 queue then. So we don't need to do anything special here -- rms. */
604ccd1d 828 if (CONSP (Vunread_command_events))
4524b161 829 {
c5fdd383
KH
830 current_kboard->kbd_queue
831 = nconc2 (Vunread_command_events, current_kboard->kbd_queue);
832 current_kboard->kbd_queue_has_data = 1;
4524b161 833 }
604ccd1d 834 Vunread_command_events = Qnil;
1e8bd3da
RS
835#endif
836 single_kboard = 0;
837#endif
604ccd1d 838}
1e8bd3da
RS
839
840/* Switch to the single-kboard state, making current_kboard
841 the only KBOARD from which further input is accepted. */
842
843void
844single_kboard_state ()
845{
846#ifdef MULTI_KBOARD
847 single_kboard = 1;
604ccd1d 848#endif
1e8bd3da
RS
849}
850
851/* Maintain a stack of kboards, so other parts of Emacs
852 can switch temporarily to the kboard of a given frame
853 and then revert to the previous status. */
854
855struct kboard_stack
856{
857 KBOARD *kboard;
858 struct kboard_stack *next;
859};
860
861static struct kboard_stack *kboard_stack;
862
863void
864push_frame_kboard (f)
865 FRAME_PTR f;
866{
ab48365b 867#ifdef MULTI_KBOARD
1e8bd3da
RS
868 struct kboard_stack *p
869 = (struct kboard_stack *) xmalloc (sizeof (struct kboard_stack));
870
871 p->next = kboard_stack;
872 p->kboard = current_kboard;
873 kboard_stack = p;
874
875 current_kboard = FRAME_KBOARD (f);
ab48365b 876#endif
1e8bd3da
RS
877}
878
879void
880pop_frame_kboard ()
881{
ab48365b 882#ifdef MULTI_KBOARD
1e8bd3da
RS
883 struct kboard_stack *p = kboard_stack;
884 current_kboard = p->kboard;
885 kboard_stack = p->next;
886 xfree (p);
ab48365b 887#endif
1e8bd3da
RS
888}
889\f
890/* Handle errors that are not handled at inner levels
891 by printing an error message and returning to the editor command loop. */
604ccd1d 892
284f4730
JB
893Lisp_Object
894cmd_error (data)
895 Lisp_Object data;
a1341f75 896{
a9f16aa9 897 Lisp_Object old_level, old_length;
e881d8b2
RS
898 char macroerror[50];
899
900 if (!NILP (executing_macro))
901 {
902 if (executing_macro_iterations == 1)
903 sprintf (macroerror, "After 1 kbd macro iteration: ");
904 else
905 sprintf (macroerror, "After %d kbd macro iterations: ",
906 executing_macro_iterations);
907 }
908 else
909 *macroerror = 0;
a9f16aa9 910
a1341f75
RS
911 Vstandard_output = Qt;
912 Vstandard_input = Qt;
913 Vexecuting_macro = Qnil;
9f58e89e 914 executing_macro = Qnil;
d8bcf58e 915 current_kboard->Vprefix_arg = Qnil;
df0f2ba1 916 cancel_echoing ();
a9f16aa9
KH
917
918 /* Avoid unquittable loop if data contains a circular list. */
919 old_level = Vprint_level;
920 old_length = Vprint_length;
0c04a67e
RS
921 XSETFASTINT (Vprint_level, 10);
922 XSETFASTINT (Vprint_length, 10);
e881d8b2 923 cmd_error_internal (data, macroerror);
a9f16aa9
KH
924 Vprint_level = old_level;
925 Vprint_length = old_length;
a1341f75
RS
926
927 Vquit_flag = Qnil;
928
929 Vinhibit_quit = Qnil;
c5fdd383 930#ifdef MULTI_KBOARD
1e8bd3da 931 any_kboard_state ();
ff4b06d3 932#endif
a1341f75
RS
933
934 return make_number (0);
935}
936
937cmd_error_internal (data, context)
938 Lisp_Object data;
939 char *context;
284f4730 940{
284f4730 941 Lisp_Object stream;
284f4730
JB
942
943 Vquit_flag = Qnil;
944 Vinhibit_quit = Qt;
284f4730
JB
945 echo_area_glyphs = 0;
946
ff11dfa1 947 /* If the window system or terminal frame hasn't been initialized
284f4730
JB
948 yet, or we're not interactive, it's best to dump this message out
949 to stderr and exit. */
ff11dfa1 950 if (! FRAME_MESSAGE_BUF (selected_frame)
284f4730
JB
951 || noninteractive)
952 stream = Qexternal_debugging_output;
953 else
954 {
955 Fdiscard_input ();
956 bitch_at_user ();
957 stream = Qt;
958 }
959
a1341f75
RS
960 if (context != 0)
961 write_string_1 (context, -1, stream);
962
22a51344 963 print_error_message (data, stream);
284f4730 964
ff11dfa1 965 /* If the window system or terminal frame hasn't been initialized
284f4730 966 yet, or we're in -batch mode, this error should cause Emacs to exit. */
ff11dfa1 967 if (! FRAME_MESSAGE_BUF (selected_frame)
284f4730
JB
968 || noninteractive)
969 {
970 Fterpri (stream);
971 Fkill_emacs (make_number (-1));
972 }
284f4730
JB
973}
974\f
975Lisp_Object command_loop_1 ();
976Lisp_Object command_loop_2 ();
977Lisp_Object top_level_1 ();
978
979/* Entry to editor-command-loop.
980 This level has the catches for exiting/returning to editor command loop.
981 It returns nil to exit recursive edit, t to abort it. */
982
983Lisp_Object
984command_loop ()
985{
986 if (command_loop_level > 0 || minibuf_level > 0)
987 {
988 return internal_catch (Qexit, command_loop_2, Qnil);
989 }
990 else
991 while (1)
992 {
993 internal_catch (Qtop_level, top_level_1, Qnil);
994 internal_catch (Qtop_level, command_loop_2, Qnil);
df0f2ba1 995
284f4730
JB
996 /* End of file in -batch run causes exit here. */
997 if (noninteractive)
998 Fkill_emacs (Qt);
999 }
1000}
1001
1002/* Here we catch errors in execution of commands within the
1003 editing loop, and reenter the editing loop.
1004 When there is an error, cmd_error runs and returns a non-nil
1005 value to us. A value of nil means that cmd_loop_1 itself
1006 returned due to end of file (or end of kbd macro). */
1007
1008Lisp_Object
1009command_loop_2 ()
1010{
1011 register Lisp_Object val;
1012
1013 do
1014 val = internal_condition_case (command_loop_1, Qerror, cmd_error);
1015 while (!NILP (val));
1016
1017 return Qnil;
1018}
1019
1020Lisp_Object
1021top_level_2 ()
1022{
1023 return Feval (Vtop_level);
1024}
1025
1026Lisp_Object
1027top_level_1 ()
1028{
1029 /* On entry to the outer level, run the startup file */
1030 if (!NILP (Vtop_level))
1031 internal_condition_case (top_level_2, Qerror, cmd_error);
1032 else if (!NILP (Vpurify_flag))
1033 message ("Bare impure Emacs (standard Lisp code not loaded)");
1034 else
1035 message ("Bare Emacs (standard Lisp code not loaded)");
1036 return Qnil;
1037}
1038
1039DEFUN ("top-level", Ftop_level, Stop_level, 0, 0, "",
1040 "Exit all recursive editing levels.")
1041 ()
1042{
1043 Fthrow (Qtop_level, Qnil);
1044}
1045
1046DEFUN ("exit-recursive-edit", Fexit_recursive_edit, Sexit_recursive_edit, 0, 0, "",
1047 "Exit from the innermost recursive edit or minibuffer.")
1048 ()
1049{
1050 if (command_loop_level > 0 || minibuf_level > 0)
1051 Fthrow (Qexit, Qnil);
1052
1053 error ("No recursive edit is in progress");
1054}
1055
1056DEFUN ("abort-recursive-edit", Fabort_recursive_edit, Sabort_recursive_edit, 0, 0, "",
1057 "Abort the command that requested this recursive edit or minibuffer input.")
1058 ()
1059{
1060 if (command_loop_level > 0 || minibuf_level > 0)
1061 Fthrow (Qexit, Qt);
1062
1063 error ("No recursive edit is in progress");
1064}
1065\f
1066/* This is the actual command reading loop,
1067 sans error-handling encapsulation. */
1068
1069Lisp_Object Fcommand_execute ();
1070static int read_key_sequence ();
68f297c5 1071void safe_run_hooks ();
284f4730
JB
1072
1073Lisp_Object
1074command_loop_1 ()
1075{
48e416d4 1076 Lisp_Object cmd, tem;
37cd9f30 1077 int lose, lose2;
284f4730
JB
1078 int nonundocount;
1079 Lisp_Object keybuf[30];
1080 int i;
1081 int no_redisplay;
1082 int no_direct;
86e5706b
RS
1083 int prev_modiff;
1084 struct buffer *prev_buffer;
c5fdd383 1085#ifdef MULTI_KBOARD
1e8bd3da 1086 int was_locked = single_kboard;
bded54dd 1087#endif
284f4730 1088
d9b641bb 1089 current_kboard->Vprefix_arg = Qnil;
86e5706b 1090 Vdeactivate_mark = Qnil;
284f4730 1091 waiting_for_input = 0;
df0f2ba1 1092 cancel_echoing ();
284f4730 1093
284f4730
JB
1094 nonundocount = 0;
1095 no_redisplay = 0;
1096 this_command_key_count = 0;
6321824f 1097 this_single_command_key_start = 0;
284f4730 1098
a612e298
RS
1099 /* Make sure this hook runs after commands that get errors and
1100 throw to top level. */
a98ea3f9
RS
1101 /* Note that the value cell will never directly contain nil
1102 if the symbol is a local variable. */
e98a93eb 1103 if (!NILP (Vpost_command_hook) && !NILP (Vrun_hooks))
a98ea3f9 1104 safe_run_hooks (Qpost_command_hook);
a612e298 1105
8a792f3a
RS
1106 if (!NILP (Vdeferred_action_list))
1107 call0 (Vdeferred_action_function);
1108
e98a93eb 1109 if (!NILP (Vpost_command_idle_hook) && !NILP (Vrun_hooks))
59aadc81
RS
1110 {
1111 if (NILP (Vunread_command_events)
1112 && NILP (Vexecuting_macro)
41365083 1113 && !NILP (sit_for (0, post_command_idle_delay, 0, 1, 1)))
59aadc81
RS
1114 safe_run_hooks (Qpost_command_idle_hook);
1115 }
1116
51d5a2c9 1117 /* Do this after running Vpost_command_hook, for consistency. */
6c7178b9 1118 current_kboard->Vlast_command = this_command;
51d5a2c9 1119
284f4730
JB
1120 while (1)
1121 {
284f4730
JB
1122 /* Make sure the current window's buffer is selected. */
1123 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
1124 set_buffer_internal (XBUFFER (XWINDOW (selected_window)->buffer));
1125
1126 /* Display any malloc warning that just came out. Use while because
1127 displaying one warning can cause another. */
1128
1129 while (pending_malloc_warning)
1130 display_malloc_warning ();
1131
1132 no_direct = 0;
1133
86e5706b
RS
1134 Vdeactivate_mark = Qnil;
1135
284f4730 1136 /* If minibuffer on and echo area in use,
eb8c3be9 1137 wait 2 sec and redraw minibuffer. */
284f4730 1138
93127526
RS
1139 if (minibuf_level && echo_area_glyphs
1140 && EQ (minibuf_window, echo_area_window))
284f4730 1141 {
f1bed6d8
RS
1142 /* Bind inhibit-quit to t so that C-g gets read in
1143 rather than quitting back to the minibuffer. */
1144 int count = specpdl_ptr - specpdl;
1145 specbind (Qinhibit_quit, Qt);
f1bed6d8 1146
db08707d 1147 Fsit_for (make_number (2), Qnil, Qnil);
e6aa7813
RS
1148 /* Clear the echo area. */
1149 message2 (0);
cdb9d665 1150 safe_run_hooks (Qecho_area_clear_hook);
e6aa7813 1151
db08707d
RS
1152 unbind_to (count, Qnil);
1153
e6aa7813 1154 /* If a C-g came in before, treat it as input now. */
284f4730
JB
1155 if (!NILP (Vquit_flag))
1156 {
1157 Vquit_flag = Qnil;
24597608 1158 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
284f4730
JB
1159 }
1160 }
1161
1162#ifdef C_ALLOCA
ff4b06d3 1163 alloca (0); /* Cause a garbage collection now */
284f4730
JB
1164 /* Since we can free the most stuff here. */
1165#endif /* C_ALLOCA */
1166
8f805655 1167#if 0
8f805655
JB
1168 /* Select the frame that the last event came from. Usually,
1169 switch-frame events will take care of this, but if some lisp
1170 code swallows a switch-frame event, we'll fix things up here.
1171 Is this a good idea? */
8c18cbfb 1172 if (FRAMEP (internal_last_event_frame)
3c370943
JB
1173 && XFRAME (internal_last_event_frame) != selected_frame)
1174 Fselect_frame (internal_last_event_frame, Qnil);
284f4730 1175#endif
48e416d4
RS
1176 /* If it has changed current-menubar from previous value,
1177 really recompute the menubar from the value. */
a646e520
RS
1178 if (! NILP (Vlucid_menu_bar_dirty_flag)
1179 && !NILP (Ffboundp (Qrecompute_lucid_menubar)))
48e416d4
RS
1180 call0 (Qrecompute_lucid_menubar);
1181
71918b75
RS
1182 before_command_key_count = this_command_key_count;
1183 before_command_echo_length = echo_length ();
1184
d7437ef6
RS
1185 this_command = Qnil;
1186
8f805655 1187 /* Read next key sequence; i gets its length. */
ce98e608 1188 i = read_key_sequence (keybuf, sizeof keybuf / sizeof keybuf[0],
f571ae0d 1189 Qnil, 0, 1, 1);
8f805655 1190
6fac1409
RS
1191 /* A filter may have run while we were reading the input. */
1192 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
1193 set_buffer_internal (XBUFFER (XWINDOW (selected_window)->buffer));
1194
8f805655
JB
1195 ++num_input_keys;
1196
284f4730
JB
1197 /* Now we have read a key sequence of length I,
1198 or else I is 0 and we found end of file. */
1199
1200 if (i == 0) /* End of file -- happens only in */
1201 return Qnil; /* a kbd macro, at the end. */
dcc408a0
RS
1202 /* -1 means read_key_sequence got a menu that was rejected.
1203 Just loop around and read another command. */
1204 if (i == -1)
1205 {
1206 cancel_echoing ();
1207 this_command_key_count = 0;
6321824f 1208 this_single_command_key_start = 0;
ff4b06d3 1209 goto finalize;
dcc408a0 1210 }
284f4730 1211
284f4730
JB
1212 last_command_char = keybuf[i - 1];
1213
75c0b143
RS
1214 /* If the previous command tried to force a specific window-start,
1215 forget about that, in case this command moves point far away
c422836d
KH
1216 from that position. But also throw away beg_unchanged and
1217 end_unchanged information in that case, so that redisplay will
1218 update the whole window properly. */
1219 if (!NILP (XWINDOW (selected_window)->force_start))
1220 {
1221 XWINDOW (selected_window)->force_start = Qnil;
1222 beg_unchanged = end_unchanged = 0;
1223 }
75c0b143 1224
284f4730
JB
1225 cmd = read_key_sequence_cmd;
1226 if (!NILP (Vexecuting_macro))
1227 {
1228 if (!NILP (Vquit_flag))
1229 {
1230 Vexecuting_macro = Qt;
1231 QUIT; /* Make some noise. */
1232 /* Will return since macro now empty. */
1233 }
1234 }
1235
1236 /* Do redisplay processing after this command except in special
40932d1a
RS
1237 cases identified below that set no_redisplay to 1.
1238 (actually, there's currently no way to prevent the redisplay,
1239 and no_redisplay is ignored.
beecf6a1 1240 Perhaps someday we will really implement it.) */
284f4730
JB
1241 no_redisplay = 0;
1242
86e5706b
RS
1243 prev_buffer = current_buffer;
1244 prev_modiff = MODIFF;
8746da95 1245 last_point_position = PT;
18cd2eeb 1246 XSETBUFFER (last_point_position_buffer, prev_buffer);
86e5706b 1247
284f4730
JB
1248 /* Execute the command. */
1249
86e5706b 1250 this_command = cmd;
a98ea3f9
RS
1251 /* Note that the value cell will never directly contain nil
1252 if the symbol is a local variable. */
e98a93eb 1253 if (!NILP (Vpre_command_hook) && !NILP (Vrun_hooks))
a98ea3f9 1254 safe_run_hooks (Qpre_command_hook);
86e5706b 1255
258bf746 1256 if (NILP (this_command))
284f4730
JB
1257 {
1258 /* nil means key is undefined. */
1259 bitch_at_user ();
c5fdd383 1260 current_kboard->defining_kbd_macro = Qnil;
284f4730 1261 update_mode_lines = 1;
d8bcf58e 1262 current_kboard->Vprefix_arg = Qnil;
284f4730
JB
1263 }
1264 else
1265 {
d8bcf58e 1266 if (NILP (current_kboard->Vprefix_arg) && ! no_direct)
284f4730
JB
1267 {
1268 /* Recognize some common commands in common situations and
1269 do them directly. */
8001d352 1270 if (EQ (this_command, Qforward_char) && PT < ZV)
284f4730 1271 {
51ad8a68 1272 struct Lisp_Char_Table *dp
284f4730 1273 = window_display_table (XWINDOW (selected_window));
37cd9f30
KH
1274 lose = FETCH_BYTE (PT);
1275 SET_PT (forward_point (1));
0f7a8fee 1276 if ((dp
82ba47d7 1277 ? (VECTORP (DISP_CHAR_VECTOR (dp, lose))
9a5540db
RS
1278 ? XVECTOR (DISP_CHAR_VECTOR (dp, lose))->size == 1
1279 : (NILP (DISP_CHAR_VECTOR (dp, lose))
1280 && (lose >= 0x20 && lose < 0x7f)))
0f7a8fee 1281 : (lose >= 0x20 && lose < 0x7f))
37cd9f30
KH
1282 /* To extract the case of continuation on
1283 wide-column characters. */
1284 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT)) == 1)
284f4730
JB
1285 && (XFASTINT (XWINDOW (selected_window)->last_modified)
1286 >= MODIFF)
598ba4c7
RS
1287 && (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1288 >= OVERLAY_MODIFF)
284f4730 1289 && (XFASTINT (XWINDOW (selected_window)->last_point)
8001d352 1290 == PT - 1)
284f4730
JB
1291 && !windows_or_buffers_changed
1292 && EQ (current_buffer->selective_display, Qnil)
1293 && !detect_input_pending ()
962ae636 1294 && NILP (XWINDOW (selected_window)->column_number_displayed)
284f4730
JB
1295 && NILP (Vexecuting_macro))
1296 no_redisplay = direct_output_forward_char (1);
1297 goto directly_done;
1298 }
8001d352 1299 else if (EQ (this_command, Qbackward_char) && PT > BEGV)
284f4730 1300 {
51ad8a68 1301 struct Lisp_Char_Table *dp
284f4730 1302 = window_display_table (XWINDOW (selected_window));
37cd9f30
KH
1303 SET_PT (forward_point (-1));
1304 lose = FETCH_BYTE (PT);
0f7a8fee 1305 if ((dp
ca873d73 1306 ? (VECTORP (DISP_CHAR_VECTOR (dp, lose))
9a5540db
RS
1307 ? XVECTOR (DISP_CHAR_VECTOR (dp, lose))->size == 1
1308 : (NILP (DISP_CHAR_VECTOR (dp, lose))
1309 && (lose >= 0x20 && lose < 0x7f)))
0f7a8fee 1310 : (lose >= 0x20 && lose < 0x7f))
284f4730
JB
1311 && (XFASTINT (XWINDOW (selected_window)->last_modified)
1312 >= MODIFF)
598ba4c7
RS
1313 && (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1314 >= OVERLAY_MODIFF)
284f4730 1315 && (XFASTINT (XWINDOW (selected_window)->last_point)
8001d352 1316 == PT + 1)
284f4730
JB
1317 && !windows_or_buffers_changed
1318 && EQ (current_buffer->selective_display, Qnil)
1319 && !detect_input_pending ()
962ae636 1320 && NILP (XWINDOW (selected_window)->column_number_displayed)
284f4730
JB
1321 && NILP (Vexecuting_macro))
1322 no_redisplay = direct_output_forward_char (-1);
1323 goto directly_done;
1324 }
258bf746 1325 else if (EQ (this_command, Qself_insert_command)
284f4730 1326 /* Try this optimization only on ascii keystrokes. */
8c18cbfb 1327 && INTEGERP (last_command_char))
284f4730 1328 {
89599794 1329 unsigned int c = XINT (last_command_char);
fc9cce4e 1330 int value;
284f4730 1331
fc9cce4e
RS
1332 if (NILP (Vexecuting_macro)
1333 && !EQ (minibuf_window, selected_window))
284f4730
JB
1334 {
1335 if (!nonundocount || nonundocount >= 20)
1336 {
1337 Fundo_boundary ();
1338 nonundocount = 0;
1339 }
1340 nonundocount++;
1341 }
fc9cce4e
RS
1342 lose = ((XFASTINT (XWINDOW (selected_window)->last_modified)
1343 < MODIFF)
598ba4c7
RS
1344 || (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1345 < OVERLAY_MODIFF)
fc9cce4e
RS
1346 || (XFASTINT (XWINDOW (selected_window)->last_point)
1347 != PT)
4c61f38e 1348 || MODIFF <= SAVE_MODIFF
fc9cce4e
RS
1349 || windows_or_buffers_changed
1350 || !EQ (current_buffer->selective_display, Qnil)
1351 || detect_input_pending ()
962ae636 1352 || !NILP (XWINDOW (selected_window)->column_number_displayed)
fc9cce4e
RS
1353 || !NILP (Vexecuting_macro));
1354 value = internal_self_insert (c, 0);
1355 if (value)
1356 lose = 1;
1357 if (value == 2)
1358 nonundocount = 0;
1359
1360 if (!lose
37cd9f30 1361 && (PT == ZV || FETCH_BYTE (PT) == '\n'))
284f4730 1362 {
51ad8a68 1363 struct Lisp_Char_Table *dp
284f4730 1364 = window_display_table (XWINDOW (selected_window));
b8d9050d 1365 int lose = c;
284f4730 1366
0f7a8fee
JB
1367 if (dp)
1368 {
9b8eb840 1369 Lisp_Object obj;
0f7a8fee 1370
9b8eb840 1371 obj = DISP_CHAR_VECTOR (dp, lose);
054c8675 1372 if (NILP (obj))
8e91f441
RS
1373 {
1374 /* Do it only for char codes
1375 that by default display as themselves. */
1376 if (lose >= 0x20 && lose <= 0x7e)
1377 no_redisplay = direct_output_for_insert (lose);
1378 }
8c18cbfb 1379 else if (VECTORP (obj)
054c8675 1380 && XVECTOR (obj)->size == 1
8c18cbfb
KH
1381 && (obj = XVECTOR (obj)->contents[0],
1382 INTEGERP (obj))
054c8675
RS
1383 /* Insist face not specified in glyph. */
1384 && (XINT (obj) & ((-1) << 8)) == 0)
bd48a052
RS
1385 no_redisplay
1386 = direct_output_for_insert (XINT (obj));
0f7a8fee
JB
1387 }
1388 else
1389 {
1390 if (lose >= 0x20 && lose <= 0x7e)
1391 no_redisplay = direct_output_for_insert (lose);
1392 }
284f4730
JB
1393 }
1394 goto directly_done;
1395 }
1396 }
1397
1398 /* Here for a command that isn't executed directly */
1399
1400 nonundocount = 0;
d8bcf58e 1401 if (NILP (current_kboard->Vprefix_arg))
284f4730 1402 Fundo_boundary ();
158f7532 1403 Fcommand_execute (this_command, Qnil, Qnil, Qnil);
284f4730 1404
284f4730 1405 }
a764a753 1406 directly_done: ;
284f4730
JB
1407
1408 /* If there is a prefix argument,
6c7178b9
KH
1409 1) We don't want Vlast_command to be ``universal-argument''
1410 (that would be dumb), so don't set Vlast_command,
284f4730
JB
1411 2) we want to leave echoing on so that the prefix will be
1412 echoed as part of this key sequence, so don't call
1413 cancel_echoing, and
1414 3) we want to leave this_command_key_count non-zero, so that
1415 read_char will realize that it is re-reading a character, and
217258d5
KH
1416 not echo it a second time.
1417
1418 If the command didn't actually create a prefix arg,
1419 but is merely a frame event that is transparent to prefix args,
1420 then the above doesn't apply. */
1421 if (NILP (current_kboard->Vprefix_arg) || CONSP (last_command_char))
284f4730 1422 {
6c7178b9 1423 current_kboard->Vlast_command = this_command;
284f4730
JB
1424 cancel_echoing ();
1425 this_command_key_count = 0;
6321824f 1426 this_single_command_key_start = 0;
284f4730 1427 }
86e5706b 1428
51603bd0
RS
1429 /* Note that the value cell will never directly contain nil
1430 if the symbol is a local variable. */
1431 if (!NILP (Vpost_command_hook) && !NILP (Vrun_hooks))
1432 safe_run_hooks (Qpost_command_hook);
1433
1434 if (!NILP (Vdeferred_action_list))
1435 safe_run_hooks (Qdeferred_action_function);
1436
1437 if (!NILP (Vpost_command_idle_hook) && !NILP (Vrun_hooks))
1438 {
1439 if (NILP (Vunread_command_events)
1440 && NILP (Vexecuting_macro)
41365083 1441 && !NILP (sit_for (0, post_command_idle_delay, 0, 1, 1)))
51603bd0
RS
1442 safe_run_hooks (Qpost_command_idle_hook);
1443 }
1444
88ce066e 1445 if (!NILP (current_buffer->mark_active) && !NILP (Vrun_hooks))
86e5706b
RS
1446 {
1447 if (!NILP (Vdeactivate_mark) && !NILP (Vtransient_mark_mode))
1448 {
1449 current_buffer->mark_active = Qnil;
1450 call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
1451 }
1452 else if (current_buffer != prev_buffer || MODIFF != prev_modiff)
1453 call1 (Vrun_hooks, intern ("activate-mark-hook"));
1454 }
ff4b06d3
KH
1455
1456 finalize:
1457 /* Install chars successfully executed in kbd macro. */
1458
d8bcf58e
KH
1459 if (!NILP (current_kboard->defining_kbd_macro)
1460 && NILP (current_kboard->Vprefix_arg))
ff4b06d3
KH
1461 finalize_kbd_macro_chars ();
1462
c5fdd383 1463#ifdef MULTI_KBOARD
604ccd1d 1464 if (!was_locked)
1e8bd3da 1465 any_kboard_state ();
ff4b06d3 1466#endif
284f4730
JB
1467 }
1468}
1c9784c9 1469
0bc3db2b
RS
1470/* Subroutine for safe_run_hooks: run the hook HOOK. */
1471
1472static Lisp_Object
1473safe_run_hooks_1 (hook)
1474 Lisp_Object hook;
1475{
1476 return call1 (Vrun_hooks, Vinhibit_quit);
1477}
1478
1479/* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1480
1481static Lisp_Object
1482safe_run_hooks_error (data)
1483 Lisp_Object data;
1484{
1485 Fset (Vinhibit_quit, Qnil);
1486}
1487
1c9784c9
KH
1488/* If we get an error while running the hook, cause the hook variable
1489 to be nil. Also inhibit quits, so that C-g won't cause the hook
1490 to mysteriously evaporate. */
0bc3db2b 1491
68f297c5 1492void
1c9784c9 1493safe_run_hooks (hook)
a98ea3f9 1494 Lisp_Object hook;
1c9784c9 1495{
68553292 1496 Lisp_Object value;
1c9784c9 1497 int count = specpdl_ptr - specpdl;
0bc3db2b
RS
1498 specbind (Qinhibit_quit, hook);
1499
e702932d 1500 internal_condition_case (safe_run_hooks_1, Qt, safe_run_hooks_error);
1c9784c9
KH
1501
1502 unbind_to (count, Qnil);
1503}
284f4730
JB
1504\f
1505/* Number of seconds between polling for input. */
1506int polling_period;
1507
eb8c3be9 1508/* Nonzero means polling for input is temporarily suppressed. */
284f4730
JB
1509int poll_suppress_count;
1510
36922b18 1511/* Nonzero if polling_for_input is actually being used. */
284f4730
JB
1512int polling_for_input;
1513
36922b18
RS
1514#ifdef POLL_FOR_INPUT
1515
284f4730
JB
1516/* Handle an alarm once each second and read pending input
1517 so as to handle a C-g if it comces in. */
1518
1519SIGTYPE
91c049d4
RS
1520input_poll_signal (signalnum) /* If we don't have an argument, */
1521 int signalnum; /* some compilers complain in signal calls. */
284f4730 1522{
87dd9b9b
RS
1523 /* This causes the call to start_polling at the end
1524 to do its job. It also arranges for a quit or error
1525 from within read_avail_input to resume polling. */
1526 poll_suppress_count++;
9ac0d9e0
JB
1527 if (interrupt_input_blocked == 0
1528 && !waiting_for_input)
1529 read_avail_input (0);
87dd9b9b
RS
1530 /* Turn on the SIGALRM handler and request another alarm. */
1531 start_polling ();
284f4730
JB
1532}
1533
1534#endif
1535
1536/* Begin signals to poll for input, if they are appropriate.
1537 This function is called unconditionally from various places. */
1538
1539start_polling ()
1540{
1541#ifdef POLL_FOR_INPUT
34f04431 1542 if (read_socket_hook && !interrupt_input)
284f4730
JB
1543 {
1544 poll_suppress_count--;
1545 if (poll_suppress_count == 0)
1546 {
1547 signal (SIGALRM, input_poll_signal);
1548 polling_for_input = 1;
1549 alarm (polling_period);
1550 }
1551 }
1552#endif
1553}
1554
1d3195db
RS
1555/* Nonzero if we are using polling to handle input asynchronously. */
1556
1557int
1558input_polling_used ()
1559{
1560#ifdef POLL_FOR_INPUT
1561 return read_socket_hook && !interrupt_input;
1562#else
1563 return 0;
1564#endif
1565}
1566
284f4730
JB
1567/* Turn off polling. */
1568
1569stop_polling ()
1570{
1571#ifdef POLL_FOR_INPUT
34f04431 1572 if (read_socket_hook && !interrupt_input)
284f4730
JB
1573 {
1574 if (poll_suppress_count == 0)
1575 {
1576 polling_for_input = 0;
1577 alarm (0);
1578 }
1579 poll_suppress_count++;
1580 }
1581#endif
1582}
fe8aeef3
RS
1583
1584/* Set the value of poll_suppress_count to COUNT
1585 and start or stop polling accordingly. */
1586
1587void
1588set_poll_suppress_count (count)
1589 int count;
1590{
1591#ifdef POLL_FOR_INPUT
1592 if (count == 0 && poll_suppress_count != 0)
1593 {
1594 poll_suppress_count = 1;
1595 start_polling ();
1596 }
1597 else if (count != 0 && poll_suppress_count == 0)
1598 {
1599 stop_polling ();
1600 }
1601 poll_suppress_count = count;
1602#endif
1603}
f4eef8b4 1604
d0a57728
RS
1605/* Bind polling_period to a value at least N.
1606 But don't decrease it. */
1607
f4eef8b4
RS
1608bind_polling_period (n)
1609 int n;
1610{
1611#ifdef POLL_FOR_INPUT
d0a57728
RS
1612 int new = polling_period;
1613
1614 if (n > new)
1615 new = n;
1616
f4eef8b4 1617 stop_polling ();
d0a57728
RS
1618 specbind (Qpolling_period, make_number (new));
1619 /* Start a new alarm with the new period. */
f4eef8b4
RS
1620 start_polling ();
1621#endif
1622}
284f4730 1623\f
6da3dd3a
RS
1624/* Apply the control modifier to CHARACTER. */
1625
faf5e407
JB
1626int
1627make_ctrl_char (c)
1628 int c;
1629{
d205953b
JB
1630 /* Save the upper bits here. */
1631 int upper = c & ~0177;
1632
1633 c &= 0177;
1634
1635 /* Everything in the columns containing the upper-case letters
1636 denotes a control character. */
1637 if (c >= 0100 && c < 0140)
1638 {
1639 int oc = c;
1640 c &= ~0140;
1641 /* Set the shift modifier for a control char
1642 made from a shifted letter. But only for letters! */
1643 if (oc >= 'A' && oc <= 'Z')
1644 c |= shift_modifier;
1645 }
1646
1647 /* The lower-case letters denote control characters too. */
1648 else if (c >= 'a' && c <= 'z')
1649 c &= ~0140;
1650
1651 /* Include the bits for control and shift
1652 only if the basic ASCII code can't indicate them. */
1653 else if (c >= ' ')
1654 c |= ctrl_modifier;
1655
1656 /* Replace the high bits. */
1657 c |= (upper & ~ctrl_modifier);
faf5e407
JB
1658
1659 return c;
1660}
1661
1662
1663\f
284f4730
JB
1664/* Input of single characters from keyboard */
1665
1666Lisp_Object print_help ();
1667static Lisp_Object kbd_buffer_get_event ();
e4fe371d 1668static void record_char ();
284f4730 1669
c5fdd383
KH
1670#ifdef MULTI_KBOARD
1671static jmp_buf wrong_kboard_jmpbuf;
bded54dd 1672#endif
beecf6a1 1673
284f4730
JB
1674/* read a character from the keyboard; call the redisplay if needed */
1675/* commandflag 0 means do not do auto-saving, but do do redisplay.
1676 -1 means do not do redisplay, but do do autosaving.
1677 1 means do both. */
1678
7d6de002
RS
1679/* The arguments MAPS and NMAPS are for menu prompting.
1680 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1681
1682 PREV_EVENT is the previous input event, or nil if we are reading
1683 the first event of a key sequence.
1684
83d68044 1685 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
6569cc8d 1686 if we used a mouse menu to read the input, or zero otherwise. If
83d68044 1687 USED_MOUSE_MENU is null, we don't dereference it.
dcc408a0
RS
1688
1689 Value is t if we showed a menu and the user rejected it. */
7d6de002 1690
284f4730 1691Lisp_Object
7d6de002 1692read_char (commandflag, nmaps, maps, prev_event, used_mouse_menu)
284f4730 1693 int commandflag;
7d6de002
RS
1694 int nmaps;
1695 Lisp_Object *maps;
1696 Lisp_Object prev_event;
1697 int *used_mouse_menu;
284f4730
JB
1698{
1699 register Lisp_Object c;
1700 int count;
410d4de9 1701 jmp_buf local_getcjmp;
284f4730 1702 jmp_buf save_jump;
a1341f75 1703 int key_already_recorded = 0;
017c7cb6 1704 Lisp_Object tem, save;
e4fe371d
RS
1705 Lisp_Object also_record;
1706 also_record = Qnil;
284f4730 1707
71918b75
RS
1708 before_command_key_count = this_command_key_count;
1709 before_command_echo_length = echo_length ();
1710
7f07d5ca
RS
1711 retry:
1712
24597608 1713 if (CONSP (Vunread_command_events))
284f4730 1714 {
24597608
RS
1715 c = XCONS (Vunread_command_events)->car;
1716 Vunread_command_events = XCONS (Vunread_command_events)->cdr;
284f4730 1717
2479e91e
RS
1718 /* Undo what read_char_x_menu_prompt did when it unread
1719 additional keys returned by Fx_popup_menu. */
1720 if (CONSP (c)
1721 && (SYMBOLP (XCONS (c)->car) || INTEGERP (XCONS (c)->car))
1722 && NILP (XCONS (c)->cdr))
1723 c = XCONS (c)->car;
1724
284f4730
JB
1725 if (this_command_key_count == 0)
1726 goto reread_first;
1727 else
1728 goto reread;
1729 }
1730
86e5706b
RS
1731 if (unread_command_char != -1)
1732 {
18cd2eeb 1733 XSETINT (c, unread_command_char);
86e5706b
RS
1734 unread_command_char = -1;
1735
1736 if (this_command_key_count == 0)
1737 goto reread_first;
1738 else
1739 goto reread;
1740 }
1741
71918b75
RS
1742 /* If there is no function key translated before
1743 reset-this-command-lengths takes effect, forget about it. */
1744 before_command_restore_flag = 0;
1745
284f4730
JB
1746 if (!NILP (Vexecuting_macro))
1747 {
fce33686
JB
1748 /* We set this to Qmacro; since that's not a frame, nobody will
1749 try to switch frames on us, and the selected window will
1750 remain unchanged.
1751
1752 Since this event came from a macro, it would be misleading to
eb8c3be9 1753 leave internal_last_event_frame set to wherever the last
3c370943
JB
1754 real event came from. Normally, a switch-frame event selects
1755 internal_last_event_frame after each command is read, but
1756 events read from a macro should never cause a new frame to be
1757 selected. */
4c52b668 1758 Vlast_event_frame = internal_last_event_frame = Qmacro;
fce33686 1759
663258f2
JB
1760 /* Exit the macro if we are at the end.
1761 Also, some things replace the macro with t
1762 to force an early exit. */
1763 if (EQ (Vexecuting_macro, Qt)
1764 || executing_macro_index >= XFASTINT (Flength (Vexecuting_macro)))
284f4730 1765 {
18cd2eeb 1766 XSETINT (c, -1);
284f4730
JB
1767 return c;
1768 }
df0f2ba1 1769
284f4730 1770 c = Faref (Vexecuting_macro, make_number (executing_macro_index));
8c18cbfb 1771 if (STRINGP (Vexecuting_macro)
86e5706b 1772 && (XINT (c) & 0x80))
bb9e9bed 1773 XSETFASTINT (c, CHAR_META | (XINT (c) & ~0x80));
86e5706b 1774
284f4730
JB
1775 executing_macro_index++;
1776
1777 goto from_macro;
1778 }
1779
cd21b839
JB
1780 if (!NILP (unread_switch_frame))
1781 {
1782 c = unread_switch_frame;
1783 unread_switch_frame = Qnil;
1784
1785 /* This event should make it into this_command_keys, and get echoed
f4255cd1
JB
1786 again, so we go to reread_first, rather than reread. */
1787 goto reread_first;
cd21b839
JB
1788 }
1789
4ec4ed6a
RS
1790 if (commandflag >= 0 && !input_pending
1791 && !detect_input_pending_run_timers (0))
410d4de9 1792 redisplay ();
e9bf89a0 1793
410d4de9
RS
1794 /* Message turns off echoing unless more keystrokes turn it on again. */
1795 if (echo_area_glyphs && *echo_area_glyphs
1fc93d49 1796 && echo_area_glyphs != current_kboard->echobuf
0c04a67e 1797 && ok_to_echo_at_next_pause != echo_area_glyphs)
410d4de9
RS
1798 cancel_echoing ();
1799 else
1800 /* If already echoing, continue. */
1801 echo_dash ();
284f4730 1802
410d4de9
RS
1803 /* Try reading a character via menu prompting in the minibuf.
1804 Try this before the sit-for, because the sit-for
1805 would do the wrong thing if we are supposed to do
1806 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1807 after a mouse event so don't try a minibuf menu. */
1808 c = Qnil;
1809 if (nmaps > 0 && INTERACTIVE
1810 && !NILP (prev_event) && ! EVENT_HAS_PARAMETERS (prev_event)
1811 /* Don't bring up a menu if we already have another event. */
1812 && NILP (Vunread_command_events)
1813 && unread_command_char < 0
4ec4ed6a 1814 && !detect_input_pending_run_timers (0))
410d4de9
RS
1815 {
1816 c = read_char_minibuf_menu_prompt (commandflag, nmaps, maps);
1817 if (! NILP (c))
1818 {
1819 key_already_recorded = 1;
1820 goto non_reread_1;
1821 }
1822 }
284f4730 1823
410d4de9
RS
1824 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
1825 We will do that below, temporarily for short sections of code,
1826 when appropriate. local_getcjmp must be in effect
1827 around any call to sit_for or kbd_buffer_get_event;
1828 it *must not* be in effect when we call redisplay. */
284f4730 1829
410d4de9 1830 if (_setjmp (local_getcjmp))
284f4730 1831 {
18cd2eeb 1832 XSETINT (c, quit_char);
4c52b668
KH
1833 XSETFRAME (internal_last_event_frame, selected_frame);
1834 Vlast_event_frame = internal_last_event_frame;
04904c29
RS
1835 /* If we report the quit char as an event,
1836 don't do so more than once. */
1837 if (!NILP (Vinhibit_quit))
1838 Vquit_flag = Qnil;
284f4730 1839
c5fdd383 1840#ifdef MULTI_KBOARD
df0f2ba1 1841 {
c5fdd383
KH
1842 KBOARD *kb = FRAME_KBOARD (selected_frame);
1843 if (kb != current_kboard)
df0f2ba1 1844 {
c5fdd383 1845 Lisp_Object *tailp = &kb->kbd_queue;
1e8bd3da
RS
1846 /* We shouldn't get here if we were in single-kboard mode! */
1847 if (single_kboard)
df0f2ba1
KH
1848 abort ();
1849 while (CONSP (*tailp))
1850 tailp = &XCONS (*tailp)->cdr;
1851 if (!NILP (*tailp))
1852 abort ();
1853 *tailp = Fcons (c, Qnil);
c5fdd383
KH
1854 kb->kbd_queue_has_data = 1;
1855 current_kboard = kb;
1856 longjmp (wrong_kboard_jmpbuf, 1);
df0f2ba1
KH
1857 }
1858 }
1859#endif
284f4730
JB
1860 goto non_reread;
1861 }
1862
d9d4c147
KH
1863 timer_start_idle ();
1864
284f4730
JB
1865 /* If in middle of key sequence and minibuffer not active,
1866 start echoing if enough time elapses. */
410d4de9 1867
c5fdd383 1868 if (minibuf_level == 0 && !current_kboard->immediate_echo
6c6083a9 1869 && this_command_key_count > 0
27203ead 1870 && ! noninteractive
284f4730 1871 && echo_keystrokes > 0
1fc93d49 1872 && (echo_area_glyphs == 0 || *echo_area_glyphs == 0
0c04a67e 1873 || ok_to_echo_at_next_pause == echo_area_glyphs))
284f4730
JB
1874 {
1875 Lisp_Object tem0;
1876
7d6de002
RS
1877 /* After a mouse event, start echoing right away.
1878 This is because we are probably about to display a menu,
1879 and we don't want to delay before doing so. */
dbc4e1c1 1880 if (EVENT_HAS_PARAMETERS (prev_event))
3dbd9ee4 1881 echo_now ();
7d6de002
RS
1882 else
1883 {
410d4de9
RS
1884 save_getcjmp (save_jump);
1885 restore_getcjmp (local_getcjmp);
41365083 1886 tem0 = sit_for (echo_keystrokes, 0, 1, 1, 0);
410d4de9 1887 restore_getcjmp (save_jump);
303b5b3f
RS
1888 if (EQ (tem0, Qt)
1889 && ! CONSP (Vunread_command_events))
3dbd9ee4 1890 echo_now ();
7d6de002 1891 }
284f4730
JB
1892 }
1893
410d4de9 1894 /* Maybe auto save due to number of keystrokes. */
284f4730
JB
1895
1896 if (commandflag != 0
1897 && auto_save_interval > 0
c43b1734 1898 && num_nonmacro_input_events - last_auto_save > max (auto_save_interval, 20)
4ec4ed6a 1899 && !detect_input_pending_run_timers (0))
284f4730 1900 {
284f4730 1901 Fdo_auto_save (Qnil, Qnil);
ef8fd672
RS
1902 /* Hooks can actually change some buffers in auto save. */
1903 redisplay ();
284f4730
JB
1904 }
1905
8150596a 1906 /* Try reading using an X menu.
24597608
RS
1907 This is never confused with reading using the minibuf
1908 because the recursive call of read_char in read_char_minibuf_menu_prompt
1909 does not pass on any keymaps. */
410d4de9 1910
24597608 1911 if (nmaps > 0 && INTERACTIVE
5a8d99e0
KH
1912 && !NILP (prev_event)
1913 && EVENT_HAS_PARAMETERS (prev_event)
1914 && !EQ (XCONS (prev_event)->car, Qmenu_bar)
24597608
RS
1915 /* Don't bring up a menu if we already have another event. */
1916 && NILP (Vunread_command_events)
b8556aee 1917 && unread_command_char < 0)
8eb4d8ef
RS
1918 {
1919 c = read_char_x_menu_prompt (nmaps, maps, prev_event, used_mouse_menu);
1920
1921 /* Now that we have read an event, Emacs is not idle. */
1922 timer_stop_idle ();
1923
1924 return c;
1925 }
7d6de002 1926
410d4de9
RS
1927 /* Maybe autosave and/or garbage collect due to idleness. */
1928
26c1639e 1929 if (INTERACTIVE && NILP (c))
7d6de002
RS
1930 {
1931 int delay_level, buffer_size;
1932
410d4de9
RS
1933 /* Slow down auto saves logarithmically in size of current buffer,
1934 and garbage collect while we're at it. */
7d6de002
RS
1935 if (! MINI_WINDOW_P (XWINDOW (selected_window)))
1936 last_non_minibuf_size = Z - BEG;
1937 buffer_size = (last_non_minibuf_size >> 8) + 1;
1938 delay_level = 0;
1939 while (buffer_size > 64)
1940 delay_level++, buffer_size -= buffer_size >> 2;
1941 if (delay_level < 4) delay_level = 4;
1942 /* delay_level is 4 for files under around 50k, 7 at 100k,
1943 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1944
1945 /* Auto save if enough time goes by without input. */
1946 if (commandflag != 0
c43b1734 1947 && num_nonmacro_input_events > last_auto_save
8c18cbfb 1948 && INTEGERP (Vauto_save_timeout)
7d6de002
RS
1949 && XINT (Vauto_save_timeout) > 0)
1950 {
1951 Lisp_Object tem0;
410d4de9
RS
1952
1953 save_getcjmp (save_jump);
1954 restore_getcjmp (local_getcjmp);
d9d4c147 1955 tem0 = sit_for (delay_level * XFASTINT (Vauto_save_timeout) / 4,
41365083 1956 0, 1, 1, 0);
410d4de9
RS
1957 restore_getcjmp (save_jump);
1958
303b5b3f
RS
1959 if (EQ (tem0, Qt)
1960 && ! CONSP (Vunread_command_events))
7d6de002 1961 {
7d6de002 1962 Fdo_auto_save (Qnil, Qnil);
7d6de002
RS
1963
1964 /* If we have auto-saved and there is still no input
1965 available, garbage collect if there has been enough
1966 consing going on to make it worthwhile. */
4ec4ed6a 1967 if (!detect_input_pending_run_timers (0)
7d6de002 1968 && consing_since_gc > gc_cons_threshold / 2)
ef8fd672 1969 Fgarbage_collect ();
410d4de9 1970
ef8fd672 1971 redisplay ();
7d6de002
RS
1972 }
1973 }
1974 }
284f4730 1975
303b5b3f
RS
1976 /* If this has become non-nil here, it has been set by a timer
1977 or sentinel or filter. */
1978 if (CONSP (Vunread_command_events))
1979 {
1980 c = XCONS (Vunread_command_events)->car;
1981 Vunread_command_events = XCONS (Vunread_command_events)->cdr;
1982 }
1983
410d4de9
RS
1984 /* Read something from current KBOARD's side queue, if possible. */
1985
beecf6a1 1986 if (NILP (c))
1e12dd87 1987 {
c5fdd383 1988 if (current_kboard->kbd_queue_has_data)
beecf6a1 1989 {
c5fdd383 1990 if (!CONSP (current_kboard->kbd_queue))
4524b161 1991 abort ();
c5fdd383
KH
1992 c = XCONS (current_kboard->kbd_queue)->car;
1993 current_kboard->kbd_queue
1994 = XCONS (current_kboard->kbd_queue)->cdr;
1995 if (NILP (current_kboard->kbd_queue))
1996 current_kboard->kbd_queue_has_data = 0;
d9d4c147 1997 input_pending = readable_events (0);
4c52b668
KH
1998 if (EVENT_HAS_PARAMETERS (c)
1999 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qswitch_frame))
2000 internal_last_event_frame = XCONS (XCONS (c)->cdr)->car;
2001 Vlast_event_frame = internal_last_event_frame;
beecf6a1 2002 }
1e8bd3da
RS
2003 }
2004
c5fdd383 2005#ifdef MULTI_KBOARD
1e8bd3da
RS
2006 /* If current_kboard's side queue is empty check the other kboards.
2007 If one of them has data that we have not yet seen here,
2008 switch to it and process the data waiting for it.
2009
2010 Note: if the events queued up for another kboard
2011 have already been seen here, and therefore are not a complete command,
2012 the kbd_queue_has_data field is 0, so we skip that kboard here.
2013 That's to avoid an infinite loop switching between kboards here. */
2014 if (NILP (c) && !single_kboard)
2015 {
2016 KBOARD *kb;
2017 for (kb = all_kboards; kb; kb = kb->next_kboard)
2018 if (kb->kbd_queue_has_data)
2019 {
2020 current_kboard = kb;
2021 longjmp (wrong_kboard_jmpbuf, 1);
2022 }
2023 }
df0f2ba1
KH
2024#endif
2025
410d4de9
RS
2026 wrong_kboard:
2027
2028 stop_polling ();
2029
1e8bd3da
RS
2030 /* Finally, we read from the main queue,
2031 and if that gives us something we can't use yet, we put it on the
2032 appropriate side queue and try again. */
410d4de9 2033
1e8bd3da
RS
2034 if (NILP (c))
2035 {
2036 KBOARD *kb;
2037
1e8bd3da 2038 /* Actually read a character, waiting if necessary. */
410d4de9
RS
2039 save_getcjmp (save_jump);
2040 restore_getcjmp (local_getcjmp);
83d68044 2041 c = kbd_buffer_get_event (&kb, used_mouse_menu);
410d4de9
RS
2042 restore_getcjmp (save_jump);
2043
c5fdd383 2044#ifdef MULTI_KBOARD
410d4de9 2045 if (! NILP (c) && (kb != current_kboard))
1e8bd3da
RS
2046 {
2047 Lisp_Object *tailp = &kb->kbd_queue;
2048 while (CONSP (*tailp))
2049 tailp = &XCONS (*tailp)->cdr;
2050 if (!NILP (*tailp))
2051 abort ();
2052 *tailp = Fcons (c, Qnil);
2053 kb->kbd_queue_has_data = 1;
46b84797 2054 c = Qnil;
1e8bd3da
RS
2055 if (single_kboard)
2056 goto wrong_kboard;
2057 current_kboard = kb;
2058 longjmp (wrong_kboard_jmpbuf, 1);
df0f2ba1 2059 }
1e8bd3da 2060#endif
beecf6a1 2061 }
1e8bd3da 2062
284f4730 2063 /* Terminate Emacs in batch mode if at eof. */
8c18cbfb 2064 if (noninteractive && INTEGERP (c) && XINT (c) < 0)
284f4730
JB
2065 Fkill_emacs (make_number (1));
2066
8c18cbfb 2067 if (INTEGERP (c))
80645119
JB
2068 {
2069 /* Add in any extra modifiers, where appropriate. */
2070 if ((extra_keyboard_modifiers & CHAR_CTL)
2071 || ((extra_keyboard_modifiers & 0177) < ' '
2072 && (extra_keyboard_modifiers & 0177) != 0))
faf5e407 2073 XSETINT (c, make_ctrl_char (XINT (c)));
80645119
JB
2074
2075 /* Transfer any other modifier bits directly from
2076 extra_keyboard_modifiers to c. Ignore the actual character code
2077 in the low 16 bits of extra_keyboard_modifiers. */
b8d9050d 2078 XSETINT (c, XINT (c) | (extra_keyboard_modifiers & ~0xff7f & ~CHAR_CTL));
80645119 2079 }
9fa4395d 2080
284f4730
JB
2081 non_reread:
2082
d9d4c147 2083 /* Now that we have read an event, Emacs is not idle--
4ec4ed6a 2084 unless the event was a timer event (not used now). */
d925fb39 2085 if (! CONSP (c))
d9d4c147
KH
2086 timer_stop_idle ();
2087
284f4730
JB
2088 start_polling ();
2089
410d4de9
RS
2090 if (NILP (c))
2091 {
2092 if (commandflag >= 0
4ec4ed6a 2093 && !input_pending && !detect_input_pending_run_timers (0))
410d4de9
RS
2094 redisplay ();
2095
2096 goto wrong_kboard;
2097 }
2098
2099 non_reread_1:
2100
dfd11da7
RS
2101 /* Buffer switch events are only for internal wakeups
2102 so don't show them to the user. */
8c18cbfb 2103 if (BUFFERP (c))
dfd11da7
RS
2104 return c;
2105
a1341f75
RS
2106 if (key_already_recorded)
2107 return c;
2108
7f07d5ca
RS
2109 /* Process special events within read_char
2110 and loop around to read another event. */
017c7cb6
RS
2111 save = Vquit_flag;
2112 Vquit_flag = Qnil;
7f07d5ca
RS
2113 tem = get_keyelt (access_keymap (get_keymap_1 (Vspecial_event_map, 0, 0),
2114 c, 0, 0), 1);
017c7cb6 2115 Vquit_flag = save;
7f07d5ca
RS
2116
2117 if (!NILP (tem))
2118 {
ba8dfba8
RS
2119 int was_locked = single_kboard;
2120
7f07d5ca 2121 last_input_char = c;
158f7532 2122 Fcommand_execute (tem, Qnil, Fvector (1, &last_input_char), Qt);
ba8dfba8
RS
2123
2124 /* Resume allowing input from any kboard, if that was true before. */
2125 if (!was_locked)
2126 any_kboard_state ();
2127
7f07d5ca
RS
2128 goto retry;
2129 }
2130
dfd11da7 2131 /* Wipe the echo area. */
cdb9d665
RS
2132 if (echo_area_glyphs)
2133 safe_run_hooks (Qecho_area_clear_hook);
dfd11da7 2134 echo_area_glyphs = 0;
284f4730
JB
2135
2136 /* Handle things that only apply to characters. */
8c18cbfb 2137 if (INTEGERP (c))
284f4730
JB
2138 {
2139 /* If kbd_buffer_get_event gave us an EOF, return that. */
86e5706b 2140 if (XINT (c) == -1)
284f4730
JB
2141 return c;
2142
8c18cbfb 2143 if (STRINGP (Vkeyboard_translate_table)
845fe94e 2144 && XSTRING (Vkeyboard_translate_table)->size > (unsigned) XFASTINT (c))
f4255cd1 2145 XSETINT (c, XSTRING (Vkeyboard_translate_table)->data[XFASTINT (c)]);
f9414d62 2146 else if ((VECTORP (Vkeyboard_translate_table)
845fe94e
RS
2147 && XVECTOR (Vkeyboard_translate_table)->size > (unsigned) XFASTINT (c))
2148 || (CHAR_TABLE_P (Vkeyboard_translate_table)
2149 && CHAR_TABLE_ORDINARY_SLOTS > (unsigned) XFASTINT (c)))
f9414d62
RS
2150 {
2151 Lisp_Object d;
2152 d = Faref (Vkeyboard_translate_table, c);
2153 /* nil in keyboard-translate-table means no translation. */
2154 if (!NILP (d))
2155 c = d;
2156 }
284f4730
JB
2157 }
2158
e4fe371d
RS
2159 /* If this event is a mouse click in the menu bar,
2160 return just menu-bar for now. Modify the mouse click event
2161 so we won't do this twice, then queue it up. */
2162 if (EVENT_HAS_PARAMETERS (c)
2163 && CONSP (XCONS (c)->cdr)
2164 && CONSP (EVENT_START (c))
2165 && CONSP (XCONS (EVENT_START (c))->cdr))
284f4730 2166 {
e4fe371d 2167 Lisp_Object posn;
284f4730 2168
e4fe371d
RS
2169 posn = POSN_BUFFER_POSN (EVENT_START (c));
2170 /* Handle menu-bar events:
2171 insert the dummy prefix event `menu-bar'. */
2172 if (EQ (posn, Qmenu_bar))
2173 {
2174 /* Change menu-bar to (menu-bar) as the event "position". */
2175 POSN_BUFFER_POSN (EVENT_START (c)) = Fcons (posn, Qnil);
284f4730 2176
e4fe371d
RS
2177 also_record = c;
2178 Vunread_command_events = Fcons (c, Vunread_command_events);
2179 c = posn;
284f4730 2180 }
284f4730
JB
2181 }
2182
e4fe371d
RS
2183 record_char (c);
2184 if (! NILP (also_record))
2185 record_char (also_record);
51172b6d 2186
284f4730
JB
2187 from_macro:
2188 reread_first:
71918b75
RS
2189 before_command_key_count = this_command_key_count;
2190 before_command_echo_length = echo_length ();
284f4730 2191
b8556aee 2192 /* Don't echo mouse motion events. */
8ea231fc
RS
2193 if (echo_keystrokes
2194 && ! (EVENT_HAS_PARAMETERS (c)
2195 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
e4fe371d
RS
2196 {
2197 echo_char (c);
2198 if (! NILP (also_record))
2199 echo_char (also_record);
1fc93d49
RS
2200 /* Once we reread a character, echoing can happen
2201 the next time we pause to read a new one. */
0c04a67e 2202 ok_to_echo_at_next_pause = echo_area_glyphs;
e4fe371d 2203 }
b8556aee 2204
db8c1663 2205 /* Record this character as part of the current key. */
b8556aee 2206 add_command_key (c);
e4fe371d
RS
2207 if (! NILP (also_record))
2208 add_command_key (also_record);
284f4730
JB
2209
2210 /* Re-reading in the middle of a command */
2211 reread:
2212 last_input_char = c;
c43b1734 2213 num_input_events++;
284f4730
JB
2214
2215 /* Process the help character specially if enabled */
ecb7cb34 2216 if (!NILP (Vhelp_form) && help_char_p (c))
284f4730
JB
2217 {
2218 Lisp_Object tem0;
2219 count = specpdl_ptr - specpdl;
2220
2221 record_unwind_protect (Fset_window_configuration,
2222 Fcurrent_window_configuration (Qnil));
2223
2224 tem0 = Feval (Vhelp_form);
8c18cbfb 2225 if (STRINGP (tem0))
284f4730
JB
2226 internal_with_output_to_temp_buffer ("*Help*", print_help, tem0);
2227
2228 cancel_echoing ();
3cb81011
KH
2229 do
2230 c = read_char (0, 0, 0, Qnil, 0);
8c18cbfb 2231 while (BUFFERP (c));
ff11dfa1 2232 /* Remove the help from the frame */
284f4730 2233 unbind_to (count, Qnil);
410d4de9 2234
284f4730
JB
2235 redisplay ();
2236 if (EQ (c, make_number (040)))
2237 {
2238 cancel_echoing ();
3cb81011
KH
2239 do
2240 c = read_char (0, 0, 0, Qnil, 0);
8c18cbfb 2241 while (BUFFERP (c));
284f4730
JB
2242 }
2243 }
2244
2245 return c;
2246}
2247
8eb4d8ef
RS
2248/* Record a key that came from a mouse menu.
2249 Record it for echoing, for this-command-keys, and so on. */
2250
2251static void
2252record_menu_key (c)
2253 Lisp_Object c;
2254{
2255 /* Wipe the echo area. */
2256 echo_area_glyphs = 0;
2257
2258 record_char (c);
2259
2260 before_command_key_count = this_command_key_count;
2261 before_command_echo_length = echo_length ();
2262
2263 /* Don't echo mouse motion events. */
2264 if (echo_keystrokes)
2265 {
2266 echo_char (c);
2267
2268 /* Once we reread a character, echoing can happen
2269 the next time we pause to read a new one. */
2270 ok_to_echo_at_next_pause = 0;
2271 }
2272
2273 /* Record this character as part of the current key. */
2274 add_command_key (c);
2275
2276 /* Re-reading in the middle of a command */
2277 last_input_char = c;
c43b1734 2278 num_input_events++;
8eb4d8ef
RS
2279}
2280
ecb7cb34
KH
2281/* Return 1 if should recognize C as "the help character". */
2282
2283int
2284help_char_p (c)
2285 Lisp_Object c;
2286{
2287 Lisp_Object tail;
2288
2289 if (EQ (c, Vhelp_char))
2290 return 1;
2291 for (tail = Vhelp_event_list; CONSP (tail); tail = XCONS (tail)->cdr)
2292 if (EQ (c, XCONS (tail)->car))
2293 return 1;
2294 return 0;
2295}
2296
e4fe371d
RS
2297/* Record the input event C in various ways. */
2298
2299static void
2300record_char (c)
2301 Lisp_Object c;
2302{
2303 total_keys++;
2304 XVECTOR (recent_keys)->contents[recent_keys_index] = c;
2305 if (++recent_keys_index >= NUM_RECENT_KEYS)
2306 recent_keys_index = 0;
2307
2308 /* Write c to the dribble file. If c is a lispy event, write
2309 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2310 If you, dear reader, have a better idea, you've got the source. :-) */
2311 if (dribble)
2312 {
2313 if (INTEGERP (c))
2314 {
2315 if (XUINT (c) < 0x100)
2316 putc (XINT (c), dribble);
2317 else
6de34814 2318 fprintf (dribble, " 0x%x", (int) XUINT (c));
e4fe371d
RS
2319 }
2320 else
2321 {
2322 Lisp_Object dribblee;
2323
2324 /* If it's a structured event, take the event header. */
2325 dribblee = EVENT_HEAD (c);
2326
2327 if (SYMBOLP (dribblee))
2328 {
2329 putc ('<', dribble);
2330 fwrite (XSYMBOL (dribblee)->name->data, sizeof (char),
2331 XSYMBOL (dribblee)->name->size,
2332 dribble);
2333 putc ('>', dribble);
2334 }
2335 }
2336
2337 fflush (dribble);
2338 }
2339
2340 store_kbd_macro_char (c);
2341
c43b1734 2342 num_nonmacro_input_events++;
e4fe371d
RS
2343}
2344
284f4730
JB
2345Lisp_Object
2346print_help (object)
2347 Lisp_Object object;
2348{
622de3e9 2349 struct buffer *old = current_buffer;
284f4730 2350 Fprinc (object, Qnil);
622de3e9
KH
2351 set_buffer_internal (XBUFFER (Vstandard_output));
2352 call0 (intern ("help-mode"));
2353 set_buffer_internal (old);
284f4730
JB
2354 return Qnil;
2355}
2356
2357/* Copy out or in the info on where C-g should throw to.
2358 This is used when running Lisp code from within get_char,
2359 in case get_char is called recursively.
2360 See read_process_output. */
2361
2362save_getcjmp (temp)
2363 jmp_buf temp;
2364{
2365 bcopy (getcjmp, temp, sizeof getcjmp);
2366}
2367
2368restore_getcjmp (temp)
2369 jmp_buf temp;
2370{
2371 bcopy (temp, getcjmp, sizeof getcjmp);
2372}
284f4730 2373\f
2eb6bfbe
RM
2374#ifdef HAVE_MOUSE
2375
284f4730
JB
2376/* Restore mouse tracking enablement. See Ftrack_mouse for the only use
2377 of this function. */
a9d77f1f 2378
284f4730
JB
2379static Lisp_Object
2380tracking_off (old_value)
2381 Lisp_Object old_value;
2382{
71edead1
RS
2383 do_mouse_tracking = old_value;
2384 if (NILP (old_value))
284f4730 2385 {
284f4730
JB
2386 /* Redisplay may have been preempted because there was input
2387 available, and it assumes it will be called again after the
2388 input has been processed. If the only input available was
2389 the sort that we have just disabled, then we need to call
2390 redisplay. */
d9d4c147 2391 if (!readable_events (1))
284f4730
JB
2392 {
2393 redisplay_preserve_echo_area ();
d9d4c147 2394 get_input_pending (&input_pending, 1);
284f4730
JB
2395 }
2396 }
2397}
2398
2399DEFUN ("track-mouse", Ftrack_mouse, Strack_mouse, 0, UNEVALLED, 0,
4bb994d1
JB
2400 "Evaluate BODY with mouse movement events enabled.\n\
2401Within a `track-mouse' form, mouse motion generates input events that\n\
2402you can read with `read-event'.\n\
2403Normally, mouse motion is ignored.")
284f4730
JB
2404 (args)
2405 Lisp_Object args;
2406{
2407 int count = specpdl_ptr - specpdl;
2408 Lisp_Object val;
2409
a9d77f1f 2410 record_unwind_protect (tracking_off, do_mouse_tracking);
284f4730 2411
f3253854 2412 do_mouse_tracking = Qt;
df0f2ba1 2413
284f4730
JB
2414 val = Fprogn (args);
2415 return unbind_to (count, val);
2416}
2eb6bfbe 2417
f3253854
KH
2418/* If mouse has moved on some frame, return one of those frames.
2419 Return 0 otherwise. */
2420
2421static FRAME_PTR
2422some_mouse_moved ()
2423{
2424 Lisp_Object tail, frame;
2425
2426 FOR_EACH_FRAME (tail, frame)
2427 {
2428 if (XFRAME (frame)->mouse_moved)
2429 return XFRAME (frame);
2430 }
2431
2432 return 0;
2433}
2434
2eb6bfbe 2435#endif /* HAVE_MOUSE */
a612e298
RS
2436\f
2437/* Low level keyboard/mouse input.
2438 kbd_buffer_store_event places events in kbd_buffer, and
0646c0dd 2439 kbd_buffer_get_event retrieves them. */
a612e298
RS
2440
2441/* Return true iff there are any events in the queue that read-char
2442 would return. If this returns false, a read-char would block. */
2443static int
d9d4c147
KH
2444readable_events (do_timers_now)
2445 int do_timers_now;
a612e298 2446{
4ec4ed6a
RS
2447 if (do_timers_now)
2448 timer_check (do_timers_now);
2449
beecf6a1
KH
2450 if (kbd_fetch_ptr != kbd_store_ptr)
2451 return 1;
2452#ifdef HAVE_MOUSE
f3253854 2453 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
beecf6a1
KH
2454 return 1;
2455#endif
1e8bd3da 2456 if (single_kboard)
4c52b668 2457 {
c5fdd383 2458 if (current_kboard->kbd_queue_has_data)
4c52b668
KH
2459 return 1;
2460 }
2461 else
2462 {
c5fdd383
KH
2463 KBOARD *kb;
2464 for (kb = all_kboards; kb; kb = kb->next_kboard)
2465 if (kb->kbd_queue_has_data)
4c52b668
KH
2466 return 1;
2467 }
beecf6a1 2468 return 0;
a612e298
RS
2469}
2470
2471/* Set this for debugging, to have a way to get out */
2472int stop_character;
284f4730 2473
c5fdd383
KH
2474#ifdef MULTI_KBOARD
2475static KBOARD *
2476event_to_kboard (event)
5798cf15
KH
2477 struct input_event *event;
2478{
2479 Lisp_Object frame;
2480 frame = event->frame_or_window;
2481 if (CONSP (frame))
2482 frame = XCONS (frame)->car;
2483 else if (WINDOWP (frame))
2484 frame = WINDOW_FRAME (XWINDOW (frame));
2485
2486 /* There are still some events that don't set this field.
f5b56972
KH
2487 For now, just ignore the problem.
2488 Also ignore dead frames here. */
2489 if (!FRAMEP (frame) || !FRAME_LIVE_P (XFRAME (frame)))
5798cf15
KH
2490 return 0;
2491 else
c5fdd383 2492 return FRAME_KBOARD (XFRAME (frame));
5798cf15
KH
2493}
2494#endif
2495
284f4730
JB
2496/* Store an event obtained at interrupt level into kbd_buffer, fifo */
2497
2498void
2499kbd_buffer_store_event (event)
2500 register struct input_event *event;
2501{
2502 if (event->kind == no_event)
2503 abort ();
2504
2505 if (event->kind == ascii_keystroke)
2506 {
e9bf89a0 2507 register int c = event->code & 0377;
284f4730 2508
faf5e407
JB
2509 if (event->modifiers & ctrl_modifier)
2510 c = make_ctrl_char (c);
2511
9fd7d808
RS
2512 c |= (event->modifiers
2513 & (meta_modifier | alt_modifier
2514 | hyper_modifier | super_modifier));
2515
86e5706b 2516 if (c == quit_char)
284f4730 2517 {
3e51c7b7 2518 extern SIGTYPE interrupt_signal ();
c5fdd383
KH
2519#ifdef MULTI_KBOARD
2520 KBOARD *kb;
5798cf15
KH
2521 struct input_event *sp;
2522
1e8bd3da 2523 if (single_kboard
c5fdd383
KH
2524 && (kb = FRAME_KBOARD (XFRAME (event->frame_or_window)),
2525 kb != current_kboard))
5798cf15 2526 {
c5fdd383 2527 kb->kbd_queue
5798cf15
KH
2528 = Fcons (make_lispy_switch_frame (event->frame_or_window),
2529 Fcons (make_number (c), Qnil));
c5fdd383 2530 kb->kbd_queue_has_data = 1;
5798cf15
KH
2531 for (sp = kbd_fetch_ptr; sp != kbd_store_ptr; sp++)
2532 {
2533 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
2534 sp = kbd_buffer;
2535
c5fdd383 2536 if (event_to_kboard (sp) == kb)
5798cf15
KH
2537 {
2538 sp->kind = no_event;
2539 sp->frame_or_window = Qnil;
2540 }
2541 }
2542 return;
2543 }
2544#endif
3e51c7b7 2545
284f4730 2546 /* If this results in a quit_char being returned to Emacs as
3c370943 2547 input, set Vlast_event_frame properly. If this doesn't
284f4730 2548 get returned to Emacs as an event, the next event read
ff11dfa1 2549 will set Vlast_event_frame again, so this is safe to do. */
4bb994d1 2550 {
9b8eb840 2551 Lisp_Object focus;
4bb994d1 2552
9b8eb840 2553 focus = FRAME_FOCUS_FRAME (XFRAME (event->frame_or_window));
4bb994d1 2554 if (NILP (focus))
beecf6a1 2555 focus = event->frame_or_window;
4c52b668
KH
2556 internal_last_event_frame = focus;
2557 Vlast_event_frame = focus;
4bb994d1 2558 }
3e51c7b7 2559
ffd56f97 2560 last_event_timestamp = event->timestamp;
284f4730
JB
2561 interrupt_signal ();
2562 return;
2563 }
2564
2565 if (c && c == stop_character)
2566 {
2567 sys_suspend ();
2568 return;
2569 }
284f4730 2570 }
3fe8e9a2
RS
2571 /* Don't insert two buffer_switch_event's in a row.
2572 Just ignore the second one. */
2573 else if (event->kind == buffer_switch_event
2574 && kbd_fetch_ptr != kbd_store_ptr
2575 && kbd_store_ptr->kind == buffer_switch_event)
2576 return;
284f4730 2577
beecf6a1
KH
2578 if (kbd_store_ptr - kbd_buffer == KBD_BUFFER_SIZE)
2579 kbd_store_ptr = kbd_buffer;
284f4730
JB
2580
2581 /* Don't let the very last slot in the buffer become full,
2582 since that would make the two pointers equal,
2583 and that is indistinguishable from an empty buffer.
2584 Discard the event if it would fill the last slot. */
beecf6a1 2585 if (kbd_fetch_ptr - 1 != kbd_store_ptr)
284f4730 2586 {
beecf6a1 2587 volatile struct input_event *sp = kbd_store_ptr;
612b78ef 2588 sp->kind = event->kind;
27203ead
RS
2589 if (event->kind == selection_request_event)
2590 {
2591 /* We must not use the ordinary copying code for this case,
2592 since `part' is an enum and copying it might not copy enough
2593 in this case. */
612b78ef 2594 bcopy (event, (char *) sp, sizeof (*event));
27203ead
RS
2595 }
2596 else
2597 {
612b78ef
KH
2598 sp->code = event->code;
2599 sp->part = event->part;
2600 sp->frame_or_window = event->frame_or_window;
2601 sp->modifiers = event->modifiers;
2602 sp->x = event->x;
2603 sp->y = event->y;
2604 sp->timestamp = event->timestamp;
27203ead 2605 }
beecf6a1
KH
2606 (XVECTOR (kbd_buffer_frame_or_window)->contents[kbd_store_ptr
2607 - kbd_buffer]
7b4aedb9 2608 = event->frame_or_window);
284f4730 2609
beecf6a1 2610 kbd_store_ptr++;
284f4730
JB
2611 }
2612}
a612e298
RS
2613\f
2614/* Read one event from the event buffer, waiting if necessary.
2615 The value is a Lisp object representing the event.
2616 The value is nil for an event that should be ignored,
2617 or that was handled here.
2618 We always read and discard one event. */
284f4730
JB
2619
2620static Lisp_Object
83d68044 2621kbd_buffer_get_event (kbp, used_mouse_menu)
410d4de9 2622 KBOARD **kbp;
83d68044 2623 int *used_mouse_menu;
284f4730
JB
2624{
2625 register int c;
2626 Lisp_Object obj;
c04cbc3b 2627 EMACS_TIME next_timer_delay;
284f4730
JB
2628
2629 if (noninteractive)
2630 {
2631 c = getchar ();
18cd2eeb 2632 XSETINT (obj, c);
f5b56972 2633 *kbp = current_kboard;
284f4730
JB
2634 return obj;
2635 }
2636
2637 /* Wait until there is input available. */
2638 for (;;)
2639 {
beecf6a1
KH
2640 if (kbd_fetch_ptr != kbd_store_ptr)
2641 break;
2642#ifdef HAVE_MOUSE
f3253854 2643 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
284f4730 2644 break;
beecf6a1 2645#endif
284f4730
JB
2646
2647 /* If the quit flag is set, then read_char will return
2648 quit_char, so that counts as "available input." */
2649 if (!NILP (Vquit_flag))
2650 quit_throw_to_read_char ();
2651
2652 /* One way or another, wait until input is available; then, if
2653 interrupt handlers have not read it, read it now. */
2654
2655#ifdef OLDVMS
2656 wait_for_kbd_input ();
2657#else
2658/* Note SIGIO has been undef'd if FIONREAD is missing. */
2659#ifdef SIGIO
2660 gobble_input (0);
2661#endif /* SIGIO */
beecf6a1
KH
2662 if (kbd_fetch_ptr != kbd_store_ptr)
2663 break;
2664#ifdef HAVE_MOUSE
f3253854 2665 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
beecf6a1
KH
2666 break;
2667#endif
2668 {
2669 Lisp_Object minus_one;
f76475ad 2670
beecf6a1 2671 XSETINT (minus_one, -1);
d9d4c147 2672 wait_reading_process_input (0, 0, minus_one, 1);
284f4730 2673
beecf6a1
KH
2674 if (!interrupt_input && kbd_fetch_ptr == kbd_store_ptr)
2675 /* Pass 1 for EXPECT since we just waited to have input. */
2676 read_avail_input (1);
2677 }
284f4730
JB
2678#endif /* not VMS */
2679 }
2680
303b5b3f
RS
2681 if (CONSP (Vunread_command_events))
2682 {
2683 Lisp_Object first;
2684 first = XCONS (Vunread_command_events)->car;
2685 Vunread_command_events = XCONS (Vunread_command_events)->cdr;
2686 *kbp = current_kboard;
2687 return first;
2688 }
2689
284f4730
JB
2690 /* At this point, we know that there is a readable event available
2691 somewhere. If the event queue is empty, then there must be a
2692 mouse movement enabled and available. */
beecf6a1 2693 if (kbd_fetch_ptr != kbd_store_ptr)
284f4730 2694 {
cd21b839 2695 struct input_event *event;
3e51c7b7 2696
beecf6a1
KH
2697 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
2698 ? kbd_fetch_ptr
2699 : kbd_buffer);
3e51c7b7 2700
cd21b839 2701 last_event_timestamp = event->timestamp;
cd21b839 2702
c5fdd383
KH
2703#ifdef MULTI_KBOARD
2704 *kbp = event_to_kboard (event);
2705 if (*kbp == 0)
2706 *kbp = current_kboard; /* Better than returning null ptr? */
5798cf15 2707#else
c5fdd383 2708 *kbp = &the_only_kboard;
5798cf15 2709#endif
beecf6a1 2710
4bb994d1
JB
2711 obj = Qnil;
2712
48e416d4 2713 /* These two kinds of events get special handling
a612e298
RS
2714 and don't actually appear to the command loop.
2715 We return nil for them. */
48e416d4
RS
2716 if (event->kind == selection_request_event)
2717 {
598a9fa7 2718#ifdef HAVE_X11
1e8bd3da
RS
2719 struct input_event copy;
2720
4581e928
RS
2721 /* Remove it from the buffer before processing it,
2722 since otherwise swallow_events will see it
2723 and process it again. */
1e8bd3da 2724 copy = *event;
beecf6a1 2725 kbd_fetch_ptr = event + 1;
d9d4c147 2726 input_pending = readable_events (0);
4581e928 2727 x_handle_selection_request (&copy);
598a9fa7
JB
2728#else
2729 /* We're getting selection request events, but we don't have
2730 a window system. */
2731 abort ();
2732#endif
48e416d4
RS
2733 }
2734
1e12dd87 2735 else if (event->kind == selection_clear_event)
48e416d4 2736 {
598a9fa7 2737#ifdef HAVE_X11
e0301c07
RS
2738 struct input_event copy;
2739
2740 /* Remove it from the buffer before processing it. */
2741 copy = *event;
beecf6a1 2742 kbd_fetch_ptr = event + 1;
d9d4c147 2743 input_pending = readable_events (0);
90c2bb0c 2744 x_handle_selection_clear (&copy);
598a9fa7
JB
2745#else
2746 /* We're getting selection request events, but we don't have
2747 a window system. */
2748 abort ();
2749#endif
48e416d4 2750 }
e98a93eb 2751#if defined (HAVE_X11) || defined (HAVE_NTGUI)
990acea3
RS
2752 else if (event->kind == delete_window_event)
2753 {
bbdc2092
RS
2754 /* Make an event (delete-frame (FRAME)). */
2755 obj = Fcons (event->frame_or_window, Qnil);
af17bd2b 2756 obj = Fcons (Qdelete_frame, Fcons (obj, Qnil));
beecf6a1 2757 kbd_fetch_ptr = event + 1;
af17bd2b
KH
2758 }
2759 else if (event->kind == iconify_event)
2760 {
2761 /* Make an event (iconify-frame (FRAME)). */
2762 obj = Fcons (event->frame_or_window, Qnil);
2763 obj = Fcons (Qiconify_frame, Fcons (obj, Qnil));
beecf6a1 2764 kbd_fetch_ptr = event + 1;
af17bd2b
KH
2765 }
2766 else if (event->kind == deiconify_event)
2767 {
2768 /* Make an event (make-frame-visible (FRAME)). */
2769 obj = Fcons (event->frame_or_window, Qnil);
2770 obj = Fcons (Qmake_frame_visible, Fcons (obj, Qnil));
beecf6a1 2771 kbd_fetch_ptr = event + 1;
990acea3
RS
2772 }
2773#endif
a8015ab5
KH
2774 else if (event->kind == buffer_switch_event)
2775 {
2776 /* The value doesn't matter here; only the type is tested. */
18cd2eeb 2777 XSETBUFFER (obj, current_buffer);
beecf6a1 2778 kbd_fetch_ptr = event + 1;
a8015ab5 2779 }
099787c1
RS
2780#ifdef USE_X_TOOLKIT
2781 else if (event->kind == menu_bar_activate_event)
2782 {
2783 kbd_fetch_ptr = event + 1;
d9d4c147 2784 input_pending = readable_events (0);
e649d076
RS
2785 if (FRAME_LIVE_P (XFRAME (event->frame_or_window)))
2786 x_activate_menubar (XFRAME (event->frame_or_window));
099787c1
RS
2787 }
2788#endif
a612e298 2789 /* Just discard these, by returning nil.
c5fdd383 2790 With MULTI_KBOARD, these events are used as placeholders
5798cf15
KH
2791 when we need to randomly delete events from the queue.
2792 (They shouldn't otherwise be found in the buffer,
2793 but on some machines it appears they do show up
c5fdd383 2794 even without MULTI_KBOARD.) */
a612e298 2795 else if (event->kind == no_event)
beecf6a1 2796 kbd_fetch_ptr = event + 1;
48e416d4 2797
4bb994d1
JB
2798 /* If this event is on a different frame, return a switch-frame this
2799 time, and leave the event in the queue for next time. */
1e12dd87
RS
2800 else
2801 {
9b8eb840 2802 Lisp_Object frame;
1e12dd87 2803 Lisp_Object focus;
7b4aedb9 2804
9b8eb840 2805 frame = event->frame_or_window;
2470a66f
KH
2806 if (CONSP (frame))
2807 frame = XCONS (frame)->car;
2808 else if (WINDOWP (frame))
1e12dd87 2809 frame = WINDOW_FRAME (XWINDOW (frame));
4bb994d1 2810
1e12dd87
RS
2811 focus = FRAME_FOCUS_FRAME (XFRAME (frame));
2812 if (! NILP (focus))
2813 frame = focus;
07d2b8de 2814
4c52b668 2815 if (! EQ (frame, internal_last_event_frame)
1e12dd87
RS
2816 && XFRAME (frame) != selected_frame)
2817 obj = make_lispy_switch_frame (frame);
4c52b668 2818 internal_last_event_frame = frame;
4bb994d1 2819
1e12dd87
RS
2820 /* If we didn't decide to make a switch-frame event, go ahead
2821 and build a real event from the queue entry. */
cd21b839 2822
1e12dd87
RS
2823 if (NILP (obj))
2824 {
2825 obj = make_lispy_event (event);
e98a93eb 2826#if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
83d68044
KH
2827 /* If this was a menu selection, then set the flag to inhibit
2828 writing to last_nonmenu_event. Don't do this if the event
2829 we're returning is (menu-bar), though; that indicates the
2830 beginning of the menu sequence, and we might as well leave
2831 that as the `event with parameters' for this selection. */
2832 if (event->kind == menu_bar_event
2833 && !(CONSP (obj) && EQ (XCONS (obj)->car, Qmenu_bar))
2834 && used_mouse_menu)
2835 *used_mouse_menu = 1;
2836#endif
1e12dd87
RS
2837
2838 /* Wipe out this event, to catch bugs. */
2839 event->kind = no_event;
beecf6a1 2840 XVECTOR (kbd_buffer_frame_or_window)->contents[event - kbd_buffer] = Qnil;
1e12dd87 2841
beecf6a1 2842 kbd_fetch_ptr = event + 1;
1e12dd87 2843 }
4bb994d1 2844 }
284f4730 2845 }
2eb6bfbe 2846#ifdef HAVE_MOUSE
a612e298 2847 /* Try generating a mouse motion event. */
f3253854 2848 else if (!NILP (do_mouse_tracking) && some_mouse_moved ())
284f4730 2849 {
f3253854 2850 FRAME_PTR f = some_mouse_moved ();
7b4aedb9 2851 Lisp_Object bar_window;
3c370943 2852 enum scroll_bar_part part;
e5d77022
JB
2853 Lisp_Object x, y;
2854 unsigned long time;
284f4730 2855
c5fdd383 2856 *kbp = current_kboard;
e177ac3a
RS
2857 /* Note that this uses F to determine which display to look at.
2858 If there is no valid info, it does not store anything
2859 so x remains nil. */
2860 x = Qnil;
dd26ab75 2861 (*mouse_position_hook) (&f, 0, &bar_window, &part, &x, &y, &time);
4bb994d1
JB
2862
2863 obj = Qnil;
284f4730 2864
4bb994d1
JB
2865 /* Decide if we should generate a switch-frame event. Don't
2866 generate switch-frame events for motion outside of all Emacs
2867 frames. */
e177ac3a 2868 if (!NILP (x) && f)
cd21b839 2869 {
9b8eb840 2870 Lisp_Object frame;
4bb994d1 2871
9b8eb840 2872 frame = FRAME_FOCUS_FRAME (f);
4bb994d1 2873 if (NILP (frame))
18cd2eeb 2874 XSETFRAME (frame, f);
4bb994d1 2875
4c52b668 2876 if (! EQ (frame, internal_last_event_frame)
80645119 2877 && XFRAME (frame) != selected_frame)
764cb3f9 2878 obj = make_lispy_switch_frame (frame);
4c52b668 2879 internal_last_event_frame = frame;
cd21b839 2880 }
4bb994d1 2881
df0f2ba1 2882 /* If we didn't decide to make a switch-frame event, go ahead and
4bb994d1 2883 return a mouse-motion event. */
e177ac3a 2884 if (!NILP (x) && NILP (obj))
7b4aedb9 2885 obj = make_lispy_movement (f, bar_window, part, x, y, time);
6cbff1cb 2886 }
2eb6bfbe 2887#endif /* HAVE_MOUSE */
284f4730
JB
2888 else
2889 /* We were promised by the above while loop that there was
2890 something for us to read! */
2891 abort ();
2892
d9d4c147 2893 input_pending = readable_events (0);
284f4730 2894
4c52b668 2895 Vlast_event_frame = internal_last_event_frame;
3c370943 2896
284f4730
JB
2897 return (obj);
2898}
a612e298
RS
2899\f
2900/* Process any events that are not user-visible,
2901 then return, without reading any user-visible events. */
3a3b9632
RS
2902
2903void
d9d4c147
KH
2904swallow_events (do_display)
2905 int do_display;
3a3b9632 2906{
87dd9b9b
RS
2907 int old_timers_run;
2908
beecf6a1 2909 while (kbd_fetch_ptr != kbd_store_ptr)
3a3b9632
RS
2910 {
2911 struct input_event *event;
2912
beecf6a1
KH
2913 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
2914 ? kbd_fetch_ptr
2915 : kbd_buffer);
3a3b9632
RS
2916
2917 last_event_timestamp = event->timestamp;
2918
2919 /* These two kinds of events get special handling
2920 and don't actually appear to the command loop. */
2921 if (event->kind == selection_request_event)
2922 {
2923#ifdef HAVE_X11
4581e928 2924 struct input_event copy;
e0301c07
RS
2925
2926 /* Remove it from the buffer before processing it,
2927 since otherwise swallow_events called recursively could see it
2928 and process it again. */
4581e928 2929 copy = *event;
beecf6a1 2930 kbd_fetch_ptr = event + 1;
d9d4c147 2931 input_pending = readable_events (0);
4581e928 2932 x_handle_selection_request (&copy);
3a3b9632
RS
2933#else
2934 /* We're getting selection request events, but we don't have
2935 a window system. */
2936 abort ();
2937#endif
2938 }
2939
2940 else if (event->kind == selection_clear_event)
2941 {
2942#ifdef HAVE_X11
e0301c07
RS
2943 struct input_event copy;
2944
2945 /* Remove it from the buffer before processing it, */
2946 copy = *event;
2947
beecf6a1 2948 kbd_fetch_ptr = event + 1;
d9d4c147 2949 input_pending = readable_events (0);
90c2bb0c 2950 x_handle_selection_clear (&copy);
3a3b9632
RS
2951#else
2952 /* We're getting selection request events, but we don't have
2953 a window system. */
2954 abort ();
2955#endif
2956 }
2957 else
2958 break;
2959 }
2960
87dd9b9b 2961 old_timers_run = timers_run;
d9d4c147 2962 get_input_pending (&input_pending, 1);
87dd9b9b
RS
2963
2964 if (timers_run != old_timers_run && do_display)
2965 redisplay_preserve_echo_area ();
3a3b9632 2966}
a612e298 2967\f
d9d4c147
KH
2968static EMACS_TIME timer_idleness_start_time;
2969
2970/* Record the start of when Emacs is idle,
2971 for the sake of running idle-time timers. */
2972
2973timer_start_idle ()
2974{
2975 Lisp_Object timers;
2976
2977 /* If we are already in the idle state, do nothing. */
2978 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
2979 return;
2980
2981 EMACS_GET_TIME (timer_idleness_start_time);
2982
2983 /* Mark all idle-time timers as once again candidates for running. */
2984 for (timers = Vtimer_idle_list; CONSP (timers); timers = XCONS (timers)->cdr)
2985 {
2986 Lisp_Object timer;
2987
2988 timer = XCONS (timers)->car;
2989
2990 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
2991 continue;
2992 XVECTOR (timer)->contents[0] = Qnil;
2993 }
2994}
2995
2996/* Record that Emacs is no longer idle, so stop running idle-time timers. */
2997
2998timer_stop_idle ()
2999{
3000 EMACS_SET_SECS_USECS (timer_idleness_start_time, -1, -1);
3001}
3002
e044e87c
RS
3003/* This is only for debugging. */
3004struct input_event last_timer_event;
3005
c04cbc3b
RS
3006/* Check whether a timer has fired. To prevent larger problems we simply
3007 disregard elements that are not proper timers. Do not make a circular
3008 timer list for the time being.
3009
3010 Returns the number of seconds to wait until the next timer fires. If a
3011 timer is triggering now, return zero seconds.
3012 If no timer is active, return -1 seconds.
3013
4ec4ed6a
RS
3014 If a timer is ripe, we run it, with quitting turned off.
3015
3016 DO_IT_NOW is now ignored. It used to mean that we should
3017 run the timer directly instead of queueing a timer-event.
3018 Now we always run timers directly. */
c04cbc3b
RS
3019
3020EMACS_TIME
3021timer_check (do_it_now)
3022 int do_it_now;
3023{
3024 EMACS_TIME nexttime;
9291c072
RS
3025 EMACS_TIME now, idleness_now;
3026 Lisp_Object timers, idle_timers, chosen_timer;
9291c072 3027 struct gcpro gcpro1, gcpro2, gcpro3;
c04cbc3b 3028
c04cbc3b
RS
3029 EMACS_SET_SECS (nexttime, -1);
3030 EMACS_SET_USECS (nexttime, -1);
3031
9291c072 3032 /* Always consider the ordinary timers. */
7ea13e12 3033 timers = Vtimer_list;
9291c072
RS
3034 /* Consider the idle timers only if Emacs is idle. */
3035 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
3036 idle_timers = Vtimer_idle_list;
3037 else
3038 idle_timers = Qnil;
3039 chosen_timer = Qnil;
3040 GCPRO3 (timers, idle_timers, chosen_timer);
7ea13e12 3041
9291c072 3042 if (CONSP (timers) || CONSP (idle_timers))
c04cbc3b 3043 {
9291c072
RS
3044 EMACS_GET_TIME (now);
3045 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
3046 EMACS_SUB_TIME (idleness_now, now, timer_idleness_start_time);
3047 }
c04cbc3b 3048
9291c072
RS
3049 while (CONSP (timers) || CONSP (idle_timers))
3050 {
3051 int triggertime = EMACS_SECS (now);
3052 Lisp_Object *vector;
3053 Lisp_Object timer, idle_timer;
3054 EMACS_TIME timer_time, idle_timer_time;
3055 EMACS_TIME difference, timer_difference, idle_timer_difference;
3056
3057 /* Skip past invalid timers and timers already handled. */
3058 if (!NILP (timers))
c04cbc3b 3059 {
d9d4c147 3060 timer = XCONS (timers)->car;
9291c072
RS
3061 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
3062 {
3063 timers = XCONS (timers)->cdr;
3064 continue;
3065 }
3066 vector = XVECTOR (timer)->contents;
d9d4c147 3067
9291c072
RS
3068 if (!INTEGERP (vector[1]) || !INTEGERP (vector[2])
3069 || !INTEGERP (vector[3])
3070 || ! NILP (vector[0]))
3071 {
3072 timers = XCONS (timers)->cdr;
3073 continue;
3074 }
3075 }
3076 if (!NILP (idle_timers))
3077 {
3078 timer = XCONS (idle_timers)->car;
d9d4c147 3079 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
9291c072
RS
3080 {
3081 idle_timers = XCONS (idle_timers)->cdr;
3082 continue;
3083 }
d9d4c147
KH
3084 vector = XVECTOR (timer)->contents;
3085
3086 if (!INTEGERP (vector[1]) || !INTEGERP (vector[2])
9291c072
RS
3087 || !INTEGERP (vector[3])
3088 || ! NILP (vector[0]))
3089 {
3090 idle_timers = XCONS (idle_timers)->cdr;
3091 continue;
3092 }
3093 }
d9d4c147 3094
9291c072
RS
3095 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
3096 based on the next ordinary timer.
3097 TIMER_DIFFERENCE is the distance in time from NOW to when
3098 this timer becomes ripe (negative if it's already ripe). */
3099 if (!NILP (timers))
3100 {
3101 timer = XCONS (timers)->car;
3102 vector = XVECTOR (timer)->contents;
d9d4c147
KH
3103 EMACS_SET_SECS (timer_time,
3104 (XINT (vector[1]) << 16) | (XINT (vector[2])));
3105 EMACS_SET_USECS (timer_time, XINT (vector[3]));
9291c072
RS
3106 EMACS_SUB_TIME (timer_difference, timer_time, now);
3107 }
ba8dfba8 3108
9291c072
RS
3109 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
3110 based on the next idle timer. */
3111 if (!NILP (idle_timers))
3112 {
3113 idle_timer = XCONS (idle_timers)->car;
3114 vector = XVECTOR (idle_timer)->contents;
3115 EMACS_SET_SECS (idle_timer_time,
3116 (XINT (vector[1]) << 16) | (XINT (vector[2])));
3117 EMACS_SET_USECS (idle_timer_time, XINT (vector[3]));
3118 EMACS_SUB_TIME (idle_timer_difference, idle_timer_time, idleness_now);
3119 }
ba8dfba8 3120
9291c072
RS
3121 /* Decide which timer is the next timer,
3122 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
3123 Also step down the list where we found that timer. */
d9d4c147 3124
9291c072
RS
3125 if (! NILP (timers) && ! NILP (idle_timers))
3126 {
3127 EMACS_TIME temp;
3128 EMACS_SUB_TIME (temp, timer_difference, idle_timer_difference);
3129 if (EMACS_TIME_NEG_P (temp))
3130 {
3131 chosen_timer = timer;
3132 timers = XCONS (timers)->cdr;
3133 difference = timer_difference;
c04cbc3b 3134 }
d9d4c147 3135 else
d9d4c147 3136 {
9291c072
RS
3137 chosen_timer = idle_timer;
3138 idle_timers = XCONS (idle_timers)->cdr;
3139 difference = idle_timer_difference;
d9d4c147 3140 }
7ea13e12 3141 }
9291c072
RS
3142 else if (! NILP (timers))
3143 {
3144 chosen_timer = timer;
3145 timers = XCONS (timers)->cdr;
3146 difference = timer_difference;
3147 }
3148 else
3149 {
3150 chosen_timer = idle_timer;
3151 idle_timers = XCONS (idle_timers)->cdr;
3152 difference = idle_timer_difference;
3153 }
3154 vector = XVECTOR (chosen_timer)->contents;
3155
3156 /* If timer is rupe, run it if it hasn't been run. */
3157 if (EMACS_TIME_NEG_P (difference)
3158 || (EMACS_SECS (difference) == 0
3159 && EMACS_USECS (difference) == 0))
3160 {
3161 if (NILP (vector[0]))
3162 {
d925fb39
RS
3163 Lisp_Object tem;
3164 int was_locked = single_kboard;
3165 int count = specpdl_ptr - specpdl;
3166
9291c072
RS
3167 /* Mark the timer as triggered to prevent problems if the lisp
3168 code fails to reschedule it right. */
3169 vector[0] = Qt;
3170
d925fb39 3171 specbind (Qinhibit_quit, Qt);
9291c072 3172
d925fb39
RS
3173 call1 (Qtimer_event_handler, chosen_timer);
3174 timers_run++;
9291c072 3175
d925fb39 3176 unbind_to (count, Qnil);
4ec4ed6a 3177
d925fb39
RS
3178 /* Resume allowing input from any kboard, if that was true before. */
3179 if (!was_locked)
3180 any_kboard_state ();
9291c072 3181
d925fb39
RS
3182 /* Since we have handled the event,
3183 we don't need to tell the caller to wake up and do it. */
9291c072
RS
3184 }
3185 }
3186 else
3187 /* When we encounter a timer that is still waiting,
3188 return the amount of time to wait before it is ripe. */
3189 {
3190 UNGCPRO;
9291c072
RS
3191 return difference;
3192 }
c04cbc3b 3193 }
9291c072 3194
7ea13e12
RS
3195 /* No timers are pending in the future. */
3196 /* Return 0 if we generated an event, and -1 if not. */
3197 UNGCPRO;
c04cbc3b
RS
3198 return nexttime;
3199}
3200\f
284f4730 3201/* Caches for modify_event_symbol. */
e9bf89a0 3202static Lisp_Object accent_key_syms;
284f4730
JB
3203static Lisp_Object func_key_syms;
3204static Lisp_Object mouse_syms;
3205
e9bf89a0
RS
3206/* This is a list of keysym codes for special "accent" characters.
3207 It parallels lispy_accent_keys. */
3208
3209static int lispy_accent_codes[] =
3210{
79a7046c 3211#ifdef XK_dead_circumflex
e9bf89a0 3212 XK_dead_circumflex,
79a7046c
RS
3213#else
3214 0,
3215#endif
3216#ifdef XK_dead_grave
e9bf89a0 3217 XK_dead_grave,
79a7046c
RS
3218#else
3219 0,
3220#endif
3221#ifdef XK_dead_tilde
e9bf89a0 3222 XK_dead_tilde,
79a7046c
RS
3223#else
3224 0,
3225#endif
3226#ifdef XK_dead_diaeresis
e9bf89a0 3227 XK_dead_diaeresis,
79a7046c
RS
3228#else
3229 0,
3230#endif
3231#ifdef XK_dead_macron
e9bf89a0 3232 XK_dead_macron,
79a7046c
RS
3233#else
3234 0,
3235#endif
3236#ifdef XK_dead_degree
e9bf89a0 3237 XK_dead_degree,
79a7046c
RS
3238#else
3239 0,
3240#endif
3241#ifdef XK_dead_acute
e9bf89a0 3242 XK_dead_acute,
79a7046c
RS
3243#else
3244 0,
3245#endif
3246#ifdef XK_dead_cedilla
e9bf89a0 3247 XK_dead_cedilla,
79a7046c
RS
3248#else
3249 0,
3250#endif
3251#ifdef XK_dead_breve
e9bf89a0 3252 XK_dead_breve,
79a7046c
RS
3253#else
3254 0,
3255#endif
3256#ifdef XK_dead_ogonek
e9bf89a0 3257 XK_dead_ogonek,
79a7046c
RS
3258#else
3259 0,
3260#endif
3261#ifdef XK_dead_caron
e9bf89a0 3262 XK_dead_caron,
79a7046c
RS
3263#else
3264 0,
3265#endif
3266#ifdef XK_dead_doubleacute
e9bf89a0 3267 XK_dead_doubleacute,
79a7046c
RS
3268#else
3269 0,
3270#endif
3271#ifdef XK_dead_abovedot
e9bf89a0 3272 XK_dead_abovedot,
79a7046c
RS
3273#else
3274 0,
3275#endif
e9bf89a0
RS
3276};
3277
3278/* This is a list of Lisp names for special "accent" characters.
3279 It parallels lispy_accent_codes. */
3280
3281static char *lispy_accent_keys[] =
3282{
3283 "dead-circumflex",
3284 "dead-grave",
3285 "dead-tilde",
3286 "dead-diaeresis",
3287 "dead-macron",
3288 "dead-degree",
3289 "dead-acute",
3290 "dead-cedilla",
3291 "dead-breve",
3292 "dead-ogonek",
3293 "dead-caron",
3294 "dead-doubleacute",
3295 "dead-abovedot",
3296};
3297
e98a93eb
GV
3298#ifdef HAVE_NTGUI
3299#define FUNCTION_KEY_OFFSET 0x0
3300
3301char *lispy_function_keys[] =
3302 {
3303 0, /* 0 */
3304
3305 0, /* VK_LBUTTON 0x01 */
3306 0, /* VK_RBUTTON 0x02 */
3307 "cancel", /* VK_CANCEL 0x03 */
3308 0, /* VK_MBUTTON 0x04 */
3309
3310 0, 0, 0, /* 0x05 .. 0x07 */
3311
3312 "backspace", /* VK_BACK 0x08 */
3313 "tab", /* VK_TAB 0x09 */
3314
3315 0, 0, /* 0x0A .. 0x0B */
3316
3317 "clear", /* VK_CLEAR 0x0C */
3318 "return", /* VK_RETURN 0x0D */
3319
3320 0, 0, /* 0x0E .. 0x0F */
3321
3322 "shift", /* VK_SHIFT 0x10 */
3323 "control", /* VK_CONTROL 0x11 */
3324 "menu", /* VK_MENU 0x12 */
3325 "pause", /* VK_PAUSE 0x13 */
3326 "capital", /* VK_CAPITAL 0x14 */
3327
3328 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
3329
3330 0, /* VK_ESCAPE 0x1B */
3331
3332 0, 0, 0, 0, /* 0x1C .. 0x1F */
3333
3334 0, /* VK_SPACE 0x20 */
3335 "prior", /* VK_PRIOR 0x21 */
3336 "next", /* VK_NEXT 0x22 */
3337 "end", /* VK_END 0x23 */
3338 "home", /* VK_HOME 0x24 */
3339 "left", /* VK_LEFT 0x25 */
3340 "up", /* VK_UP 0x26 */
3341 "right", /* VK_RIGHT 0x27 */
3342 "down", /* VK_DOWN 0x28 */
3343 "select", /* VK_SELECT 0x29 */
3344 "print", /* VK_PRINT 0x2A */
3345 "execute", /* VK_EXECUTE 0x2B */
3346 "snapshot", /* VK_SNAPSHOT 0x2C */
3347 "insert", /* VK_INSERT 0x2D */
3348 "delete", /* VK_DELETE 0x2E */
3349 "help", /* VK_HELP 0x2F */
3350
3351 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
3352
3353 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3354
3355 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
3356
3357 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
3358
3359 0, 0, 0, 0, 0, 0, 0, 0, 0,
3360 0, 0, 0, 0, 0, 0, 0, 0, 0,
3361 0, 0, 0, 0, 0, 0, 0, 0,
3362
e376f90d
RS
3363 "lwindow", /* VK_LWIN 0x5B */
3364 "rwindow", /* VK_RWIN 0x5C */
3365 "apps", /* VK_APPS 0x5D */
e98a93eb
GV
3366
3367 0, 0, /* 0x5E .. 0x5F */
3368
3369 "kp-0", /* VK_NUMPAD0 0x60 */
3370 "kp-1", /* VK_NUMPAD1 0x61 */
3371 "kp-2", /* VK_NUMPAD2 0x62 */
3372 "kp-3", /* VK_NUMPAD3 0x63 */
3373 "kp-4", /* VK_NUMPAD4 0x64 */
3374 "kp-5", /* VK_NUMPAD5 0x65 */
3375 "kp-6", /* VK_NUMPAD6 0x66 */
3376 "kp-7", /* VK_NUMPAD7 0x67 */
3377 "kp-8", /* VK_NUMPAD8 0x68 */
3378 "kp-9", /* VK_NUMPAD9 0x69 */
3379 "kp-multiply", /* VK_MULTIPLY 0x6A */
3380 "kp-add", /* VK_ADD 0x6B */
3381 "kp-separator", /* VK_SEPARATOR 0x6C */
3382 "kp-subtract", /* VK_SUBTRACT 0x6D */
3383 "kp-decimal", /* VK_DECIMAL 0x6E */
3384 "kp-divide", /* VK_DIVIDE 0x6F */
3385 "f1", /* VK_F1 0x70 */
3386 "f2", /* VK_F2 0x71 */
3387 "f3", /* VK_F3 0x72 */
3388 "f4", /* VK_F4 0x73 */
3389 "f5", /* VK_F5 0x74 */
3390 "f6", /* VK_F6 0x75 */
3391 "f7", /* VK_F7 0x76 */
3392 "f8", /* VK_F8 0x77 */
3393 "f9", /* VK_F9 0x78 */
3394 "f10", /* VK_F10 0x79 */
3395 "f11", /* VK_F11 0x7A */
3396 "f12", /* VK_F12 0x7B */
3397 "f13", /* VK_F13 0x7C */
3398 "f14", /* VK_F14 0x7D */
3399 "f15", /* VK_F15 0x7E */
3400 "f16", /* VK_F16 0x7F */
3401 "f17", /* VK_F17 0x80 */
3402 "f18", /* VK_F18 0x81 */
3403 "f19", /* VK_F19 0x82 */
3404 "f20", /* VK_F20 0x83 */
3405 "f21", /* VK_F21 0x84 */
3406 "f22", /* VK_F22 0x85 */
3407 "f23", /* VK_F23 0x86 */
3408 "f24", /* VK_F24 0x87 */
3409
3410 0, 0, 0, 0, /* 0x88 .. 0x8B */
3411 0, 0, 0, 0, /* 0x8C .. 0x8F */
3412
3413 "kp-numlock", /* VK_NUMLOCK 0x90 */
3414 "scroll", /* VK_SCROLL 0x91 */
3415
e376f90d
RS
3416 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
3417 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
3418 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
3419 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
3420 "kp-end", /* VK_NUMPAD_END 0x96 */
3421 "kp-home", /* VK_NUMPAD_HOME 0x97 */
3422 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
3423 "kp-up", /* VK_NUMPAD_UP 0x99 */
3424 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
3425 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
3426 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
3427 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
3428
3429 0, 0, /* 0x9E .. 0x9F */
3430
e98a93eb
GV
3431 /*
3432 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
3433 * Used only as parameters to GetAsyncKeyState() and GetKeyState().
3434 * No other API or message will distinguish left and right keys this way.
3435 */
3436 /* 0xA0 .. 0xEF */
3437
3438 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3439 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3440 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3441 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3442 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3443
3444 /* 0xF0 .. 0xF5 */
3445
3446 0, 0, 0, 0, 0, 0,
3447
3448 "attn", /* VK_ATTN 0xF6 */
3449 "crsel", /* VK_CRSEL 0xF7 */
3450 "exsel", /* VK_EXSEL 0xF8 */
3451 "ereof", /* VK_EREOF 0xF9 */
3452 "play", /* VK_PLAY 0xFA */
3453 "zoom", /* VK_ZOOM 0xFB */
3454 "noname", /* VK_NONAME 0xFC */
3455 "pa1", /* VK_PA1 0xFD */
3456 "oem_clear", /* VK_OEM_CLEAR 0xFE */
3457 };
3458
04f215f0 3459#else /* not HAVE_NTGUI */
e98a93eb 3460
37cd9f30
KH
3461#ifdef XK_kana_A
3462static char *lispy_kana_keys[] =
3463 {
3464 /* X Keysym value */
3465 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
3466 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
3467 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
3468 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
3469 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
3470 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
3471 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
3472 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
3473 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
3474 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
3475 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
3476 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
3477 "kana-i", "kana-u", "kana-e", "kana-o",
3478 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
3479 "prolongedsound", "kana-A", "kana-I", "kana-U",
3480 "kana-E", "kana-O", "kana-KA", "kana-KI",
3481 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
3482 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
3483 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
3484 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
3485 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
3486 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
3487 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
3488 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
3489 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
3490 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
3491 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
3492 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
3493 };
3494#endif /* XK_kana_A */
3495
04f215f0
RS
3496#define FUNCTION_KEY_OFFSET 0xff00
3497
284f4730
JB
3498/* You'll notice that this table is arranged to be conveniently
3499 indexed by X Windows keysym values. */
3500static char *lispy_function_keys[] =
3501 {
3502 /* X Keysym value */
3503
80e4aa30 3504 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
86e5706b
RS
3505 "backspace",
3506 "tab",
3507 "linefeed",
3508 "clear",
3509 0,
3510 "return",
3511 0, 0,
3512 0, 0, 0, /* 0xff10 */
3513 "pause",
3514 0, 0, 0, 0, 0, 0, 0,
3515 "escape",
3516 0, 0, 0, 0,
37cd9f30
KH
3517 0, "kanji", "muhenkan",
3518 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
86e5706b
RS
3519 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
3520 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
3521
284f4730
JB
3522 "home", /* 0xff50 */ /* IsCursorKey */
3523 "left",
3524 "up",
3525 "right",
3526 "down",
3527 "prior",
3528 "next",
3529 "end",
3530 "begin",
3531 0, /* 0xff59 */
3532 0, 0, 0, 0, 0, 0,
3533 "select", /* 0xff60 */ /* IsMiscFunctionKey */
3534 "print",
3535 "execute",
3536 "insert",
3537 0, /* 0xff64 */
3538 "undo",
3539 "redo",
3540 "menu",
3541 "find",
3542 "cancel",
3543 "help",
3544 "break", /* 0xff6b */
3545
9fdbfdf8 3546 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
284f4730 3547 0, /* 0xff76 */
36ae397e 3548 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
284f4730
JB
3549 "kp-space", /* 0xff80 */ /* IsKeypadKey */
3550 0, 0, 0, 0, 0, 0, 0, 0,
3551 "kp-tab", /* 0xff89 */
3552 0, 0, 0,
3553 "kp-enter", /* 0xff8d */
3554 0, 0, 0,
3555 "kp-f1", /* 0xff91 */
3556 "kp-f2",
3557 "kp-f3",
3558 "kp-f4",
872157e7
RS
3559 "kp-home", /* 0xff95 */
3560 "kp-left",
3561 "kp-up",
3562 "kp-right",
3563 "kp-down",
3564 "kp-prior", /* kp-page-up */
3565 "kp-next", /* kp-page-down */
3566 "kp-end",
3567 "kp-begin",
3568 "kp-insert",
3569 "kp-delete",
3570 0, /* 0xffa0 */
3571 0, 0, 0, 0, 0, 0, 0, 0, 0,
284f4730
JB
3572 "kp-multiply", /* 0xffaa */
3573 "kp-add",
3574 "kp-separator",
3575 "kp-subtract",
3576 "kp-decimal",
3577 "kp-divide", /* 0xffaf */
3578 "kp-0", /* 0xffb0 */
3579 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
3580 0, /* 0xffba */
3581 0, 0,
3582 "kp-equal", /* 0xffbd */
3583 "f1", /* 0xffbe */ /* IsFunctionKey */
86e5706b
RS
3584 "f2",
3585 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
3586 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
3587 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
3588 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
3589 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
3590 0, 0, 0, 0, 0, 0, 0, 0,
3591 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
3592 0, 0, 0, 0, 0, 0, 0, "delete"
04f215f0 3593 };
284f4730 3594
04f215f0
RS
3595/* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
3596#define ISO_FUNCTION_KEY_OFFSET 0xfe00
3597
3598static char *iso_lispy_function_keys[] =
3599 {
3600 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
3601 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
3602 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
3603 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
3604 "iso-lefttab", /* 0xfe20 */
3605 "iso-move-line-up", "iso-move-line-down",
3606 "iso-partial-line-up", "iso-partial-line-down",
3607 "iso-partial-space-left", "iso-partial-space-right",
3608 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
3609 "iso-release-margin-left", "iso-release-margin-right",
3610 "iso-release-both-margins",
3611 "iso-fast-cursor-left", "iso-fast-cursor-right",
3612 "iso-fast-cursor-up", "iso-fast-cursor-down",
3613 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
3614 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
3615 };
3616
3617#endif /* not HAVE_NTGUI */
e98a93eb 3618
df0f2ba1 3619static char *lispy_mouse_names[] =
284f4730
JB
3620{
3621 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
3622};
3623
3c370943 3624/* Scroll bar parts. */
4bb994d1 3625Lisp_Object Qabove_handle, Qhandle, Qbelow_handle;
db08707d 3626Lisp_Object Qup, Qdown;
4bb994d1 3627
3c370943
JB
3628/* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
3629Lisp_Object *scroll_bar_parts[] = {
db08707d
RS
3630 &Qabove_handle, &Qhandle, &Qbelow_handle,
3631 &Qup, &Qdown,
4bb994d1
JB
3632};
3633
3634
7b4aedb9 3635/* A vector, indexed by button number, giving the down-going location
3c370943 3636 of currently depressed buttons, both scroll bar and non-scroll bar.
7b4aedb9
JB
3637
3638 The elements have the form
3639 (BUTTON-NUMBER MODIFIER-MASK . REST)
3640 where REST is the cdr of a position as it would be reported in the event.
3641
3642 The make_lispy_event function stores positions here to tell the
3643 difference between click and drag events, and to store the starting
3644 location to be included in drag events. */
3645
3646static Lisp_Object button_down_location;
88cb0656 3647
fbcd35bd
JB
3648/* Information about the most recent up-going button event: Which
3649 button, what location, and what time. */
3650
559f9d04
RS
3651static int last_mouse_button;
3652static int last_mouse_x;
3653static int last_mouse_y;
3654static unsigned long button_down_time;
fbcd35bd 3655
564dc952
JB
3656/* The maximum time between clicks to make a double-click,
3657 or Qnil to disable double-click detection,
3658 or Qt for no time limit. */
3659Lisp_Object Vdouble_click_time;
fbcd35bd
JB
3660
3661/* The number of clicks in this multiple-click. */
3662
3663int double_click_count;
3664
284f4730
JB
3665/* Given a struct input_event, build the lisp event which represents
3666 it. If EVENT is 0, build a mouse movement event from the mouse
88cb0656
JB
3667 movement buffer, which should have a movement event in it.
3668
3669 Note that events must be passed to this function in the order they
3670 are received; this function stores the location of button presses
3671 in order to build drag events when the button is released. */
284f4730
JB
3672
3673static Lisp_Object
3674make_lispy_event (event)
3675 struct input_event *event;
3676{
79a7046c
RS
3677 int i;
3678
0220c518 3679 switch (SWITCH_ENUM_CAST (event->kind))
284f4730 3680 {
284f4730
JB
3681 /* A simple keystroke. */
3682 case ascii_keystroke:
86e5706b 3683 {
9343ab07 3684 Lisp_Object lispy_c;
e9bf89a0 3685 int c = event->code & 0377;
5a1c6df8
JB
3686 /* Turn ASCII characters into control characters
3687 when proper. */
3688 if (event->modifiers & ctrl_modifier)
d205953b
JB
3689 c = make_ctrl_char (c);
3690
3691 /* Add in the other modifier bits. We took care of ctrl_modifier
3692 just above, and the shift key was taken care of by the X code,
3693 and applied to control characters by make_ctrl_char. */
86e5706b
RS
3694 c |= (event->modifiers
3695 & (meta_modifier | alt_modifier
3696 | hyper_modifier | super_modifier));
559f9d04 3697 button_down_time = 0;
bb9e9bed 3698 XSETFASTINT (lispy_c, c);
9343ab07 3699 return lispy_c;
86e5706b 3700 }
284f4730
JB
3701
3702 /* A function key. The symbol may need to have modifier prefixes
3703 tacked onto it. */
3704 case non_ascii_keystroke:
559f9d04 3705 button_down_time = 0;
e9bf89a0
RS
3706
3707 for (i = 0; i < sizeof (lispy_accent_codes) / sizeof (int); i++)
3708 if (event->code == lispy_accent_codes[i])
3709 return modify_event_symbol (i,
3710 event->modifiers,
80e4aa30 3711 Qfunction_key, Qnil,
e9bf89a0
RS
3712 lispy_accent_keys, &accent_key_syms,
3713 (sizeof (lispy_accent_keys)
3714 / sizeof (lispy_accent_keys[0])));
3715
270a208f 3716 /* Handle system-specific keysyms. */
80e4aa30
RS
3717 if (event->code & (1 << 28))
3718 {
3719 /* We need to use an alist rather than a vector as the cache
3720 since we can't make a vector long enuf. */
142e6c73
KH
3721 if (NILP (current_kboard->system_key_syms))
3722 current_kboard->system_key_syms = Fcons (Qnil, Qnil);
2c834fb3 3723 return modify_event_symbol (event->code,
80e4aa30 3724 event->modifiers,
7c97ffdc
KH
3725 Qfunction_key,
3726 current_kboard->Vsystem_key_alist,
142e6c73
KH
3727 0, &current_kboard->system_key_syms,
3728 (unsigned)-1);
80e4aa30
RS
3729 }
3730
37cd9f30
KH
3731#ifdef XK_kana_A
3732 if (event->code >= 0x400 && event->code < 0x500)
3733 return modify_event_symbol (event->code - 0x400,
3734 event->modifiers & ~shift_modifier,
3735 Qfunction_key, Qnil,
3736 lispy_kana_keys, &func_key_syms,
3737 (sizeof (lispy_kana_keys)
3738 / sizeof (lispy_kana_keys[0])));
3739#endif /* XK_kana_A */
3740
04f215f0
RS
3741 if (event->code < FUNCTION_KEY_OFFSET
3742 && event->code >= ISO_FUNCTION_KEY_OFFSET)
3743 return modify_event_symbol (event->code - ISO_FUNCTION_KEY_OFFSET,
3744 event->modifiers,
3745 Qfunction_key, Qnil,
3746 iso_lispy_function_keys, &func_key_syms,
3747 (sizeof (iso_lispy_function_keys)
3748 / sizeof (iso_lispy_function_keys[0])));
3749 else
3750 return modify_event_symbol (event->code - FUNCTION_KEY_OFFSET,
3751 event->modifiers,
3752 Qfunction_key, Qnil,
3753 lispy_function_keys, &func_key_syms,
3754 (sizeof (lispy_function_keys)
3755 / sizeof (lispy_function_keys[0])));
284f4730 3756
514354e9 3757#ifdef HAVE_MOUSE
df0f2ba1 3758 /* A mouse click. Figure out where it is, decide whether it's
88cb0656 3759 a press, click or drag, and build the appropriate structure. */
284f4730 3760 case mouse_click:
3c370943 3761 case scroll_bar_click:
284f4730 3762 {
e9bf89a0 3763 int button = event->code;
559f9d04 3764 int is_double;
7b4aedb9 3765 Lisp_Object position;
dbc4e1c1
JB
3766 Lisp_Object *start_pos_ptr;
3767 Lisp_Object start_pos;
284f4730 3768
7b4aedb9 3769 if (button < 0 || button >= NUM_MOUSE_BUTTONS)
88cb0656
JB
3770 abort ();
3771
7b4aedb9
JB
3772 /* Build the position as appropriate for this mouse click. */
3773 if (event->kind == mouse_click)
284f4730 3774 {
7b4aedb9 3775 int part;
598a9fa7 3776 FRAME_PTR f = XFRAME (event->frame_or_window);
0aafc975 3777 Lisp_Object window;
7b4aedb9 3778 Lisp_Object posn;
9e20143a
RS
3779 int row, column;
3780
5da3133a
RS
3781 /* Ignore mouse events that were made on frame that
3782 have been deleted. */
3783 if (! FRAME_LIVE_P (f))
3784 return Qnil;
3785
9e20143a 3786 pixel_to_glyph_coords (f, XINT (event->x), XINT (event->y),
6c6a9be8 3787 &column, &row, NULL, 1);
7b4aedb9 3788
eef045bf
RS
3789#ifndef USE_X_TOOLKIT
3790 /* In the non-toolkit version, clicks on the menu bar
3791 are ordinary button events in the event buffer.
3792 Distinguish them, and invoke the menu.
3793
3794 (In the toolkit version, the toolkit handles the menu bar
3795 and Emacs doesn't know about it until after the user
3796 makes a selection.) */
2ee250ec
RS
3797 if (row >= 0 && row < FRAME_MENU_BAR_LINES (f)
3798 && (event->modifiers & down_modifier))
bb936752 3799 {
b7c49376 3800 Lisp_Object items, item;
0a0e8fe6
RS
3801 int hpos;
3802 int i;
3803
2ee250ec 3804#if 0
0a0e8fe6
RS
3805 /* Activate the menu bar on the down event. If the
3806 up event comes in before the menu code can deal with it,
3807 just ignore it. */
3808 if (! (event->modifiers & down_modifier))
3809 return Qnil;
2ee250ec 3810#endif
0aafc975 3811
f2ae6b3f 3812 item = Qnil;
5ec75a55 3813 items = FRAME_MENU_BAR_ITEMS (f);
35b3402f 3814 for (i = 0; i < XVECTOR (items)->size; i += 4)
5ec75a55
RS
3815 {
3816 Lisp_Object pos, string;
b7c49376 3817 string = XVECTOR (items)->contents[i + 1];
35b3402f 3818 pos = XVECTOR (items)->contents[i + 3];
b7c49376
RS
3819 if (NILP (string))
3820 break;
9e20143a
RS
3821 if (column >= XINT (pos)
3822 && column < XINT (pos) + XSTRING (string)->size)
b7c49376
RS
3823 {
3824 item = XVECTOR (items)->contents[i];
3825 break;
3826 }
5ec75a55 3827 }
9e20143a 3828
5ec75a55
RS
3829 position
3830 = Fcons (event->frame_or_window,
3831 Fcons (Qmenu_bar,
3832 Fcons (Fcons (event->x, event->y),
3833 Fcons (make_number (event->timestamp),
3834 Qnil))));
3835
b7c49376 3836 return Fcons (item, Fcons (position, Qnil));
5ec75a55 3837 }
eef045bf 3838#endif /* not USE_X_TOOLKIT */
0aafc975 3839
9e20143a 3840 window = window_from_coordinates (f, column, row, &part);
0aafc975 3841
8c18cbfb 3842 if (!WINDOWP (window))
78ced549
RS
3843 {
3844 window = event->frame_or_window;
3845 posn = Qnil;
3846 }
284f4730 3847 else
7b4aedb9 3848 {
9e20143a 3849 int pixcolumn, pixrow;
c8738c33 3850 column -= WINDOW_LEFT_MARGIN (XWINDOW (window));
9e20143a
RS
3851 row -= XINT (XWINDOW (window)->top);
3852 glyph_to_pixel_coords (f, column, row, &pixcolumn, &pixrow);
3853 XSETINT (event->x, pixcolumn);
3854 XSETINT (event->y, pixrow);
dbc4e1c1 3855
7b4aedb9
JB
3856 if (part == 1)
3857 posn = Qmode_line;
3858 else if (part == 2)
3859 posn = Qvertical_line;
3860 else
18cd2eeb
KH
3861 XSETINT (posn,
3862 buffer_posn_from_coords (XWINDOW (window),
3863 column, row));
7b4aedb9
JB
3864 }
3865
5ec75a55
RS
3866 position
3867 = Fcons (window,
3868 Fcons (posn,
3869 Fcons (Fcons (event->x, event->y),
3870 Fcons (make_number (event->timestamp),
3871 Qnil))));
284f4730 3872 }
7b4aedb9 3873 else
88cb0656 3874 {
9e20143a
RS
3875 Lisp_Object window;
3876 Lisp_Object portion_whole;
3877 Lisp_Object part;
3878
3879 window = event->frame_or_window;
3880 portion_whole = Fcons (event->x, event->y);
3881 part = *scroll_bar_parts[(int) event->part];
7b4aedb9 3882
db08707d
RS
3883 position
3884 = Fcons (window,
3885 Fcons (Qvertical_scroll_bar,
3886 Fcons (portion_whole,
3887 Fcons (make_number (event->timestamp),
3888 Fcons (part, Qnil)))));
88cb0656
JB
3889 }
3890
dbc4e1c1
JB
3891 start_pos_ptr = &XVECTOR (button_down_location)->contents[button];
3892
3893 start_pos = *start_pos_ptr;
3894 *start_pos_ptr = Qnil;
7b4aedb9 3895
559f9d04
RS
3896 is_double = (button == last_mouse_button
3897 && XINT (event->x) == last_mouse_x
3898 && XINT (event->y) == last_mouse_y
3899 && button_down_time != 0
3900 && (EQ (Vdouble_click_time, Qt)
3901 || (INTEGERP (Vdouble_click_time)
3902 && ((int)(event->timestamp - button_down_time)
3903 < XINT (Vdouble_click_time)))));
3904 last_mouse_button = button;
3905 last_mouse_x = XINT (event->x);
3906 last_mouse_y = XINT (event->y);
3907
7b4aedb9
JB
3908 /* If this is a button press, squirrel away the location, so
3909 we can decide later whether it was a click or a drag. */
3910 if (event->modifiers & down_modifier)
559f9d04
RS
3911 {
3912 if (is_double)
3913 {
3914 double_click_count++;
3915 event->modifiers |= ((double_click_count > 2)
3916 ? triple_modifier
3917 : double_modifier);
3918 }
3919 else
3920 double_click_count = 1;
3921 button_down_time = event->timestamp;
3922 *start_pos_ptr = Fcopy_alist (position);
3923 }
7b4aedb9 3924
88cb0656 3925 /* Now we're releasing a button - check the co-ordinates to
7b4aedb9 3926 see if this was a click or a drag. */
88cb0656
JB
3927 else if (event->modifiers & up_modifier)
3928 {
48e416d4
RS
3929 /* If we did not see a down before this up,
3930 ignore the up. Probably this happened because
3931 the down event chose a menu item.
3932 It would be an annoyance to treat the release
3933 of the button that chose the menu item
3934 as a separate event. */
3935
8c18cbfb 3936 if (!CONSP (start_pos))
48e416d4
RS
3937 return Qnil;
3938
88cb0656 3939 event->modifiers &= ~up_modifier;
48e416d4 3940#if 0 /* Formerly we treated an up with no down as a click event. */
8c18cbfb 3941 if (!CONSP (start_pos))
dbc4e1c1
JB
3942 event->modifiers |= click_modifier;
3943 else
48e416d4 3944#endif
dbc4e1c1
JB
3945 {
3946 /* The third element of every position should be the (x,y)
3947 pair. */
9b8eb840 3948 Lisp_Object down;
dbc4e1c1 3949
9b8eb840 3950 down = Fnth (make_number (2), start_pos);
fbcd35bd
JB
3951 if (EQ (event->x, XCONS (down)->car)
3952 && EQ (event->y, XCONS (down)->cdr))
3953 {
bc536d84 3954 event->modifiers |= click_modifier;
fbcd35bd
JB
3955 }
3956 else
3957 {
559f9d04 3958 button_down_time = 0;
fbcd35bd
JB
3959 event->modifiers |= drag_modifier;
3960 }
bc536d84
RS
3961 /* Don't check is_double; treat this as multiple
3962 if the down-event was multiple. */
3963 if (double_click_count > 1)
3964 event->modifiers |= ((double_click_count > 2)
3965 ? triple_modifier
3966 : double_modifier);
dbc4e1c1 3967 }
88cb0656
JB
3968 }
3969 else
3970 /* Every mouse event should either have the down_modifier or
7b4aedb9 3971 the up_modifier set. */
88cb0656
JB
3972 abort ();
3973
88cb0656 3974 {
7b4aedb9 3975 /* Get the symbol we should use for the mouse click. */
9b8eb840
KH
3976 Lisp_Object head;
3977
3978 head = modify_event_symbol (button,
3979 event->modifiers,
3980 Qmouse_click, Qnil,
3981 lispy_mouse_names, &mouse_syms,
3982 (sizeof (lispy_mouse_names)
3983 / sizeof (lispy_mouse_names[0])));
88cb0656 3984 if (event->modifiers & drag_modifier)
dbc4e1c1
JB
3985 return Fcons (head,
3986 Fcons (start_pos,
3987 Fcons (position,
3988 Qnil)));
fbcd35bd
JB
3989 else if (event->modifiers & (double_modifier | triple_modifier))
3990 return Fcons (head,
3991 Fcons (position,
3992 Fcons (make_number (double_click_count),
3993 Qnil)));
88cb0656
JB
3994 else
3995 return Fcons (head,
7b4aedb9 3996 Fcons (position,
88cb0656
JB
3997 Qnil));
3998 }
284f4730 3999 }
db08707d
RS
4000
4001#ifdef WINDOWSNT
fbd6baed 4002 case w32_scroll_bar_click:
db08707d
RS
4003 {
4004 int button = event->code;
4005 int is_double;
4006 Lisp_Object position;
4007 Lisp_Object *start_pos_ptr;
4008 Lisp_Object start_pos;
4009
4010 if (button < 0 || button >= NUM_MOUSE_BUTTONS)
4011 abort ();
4012
4013 {
4014 Lisp_Object window;
4015 Lisp_Object portion_whole;
4016 Lisp_Object part;
4017
4018 window = event->frame_or_window;
4019 portion_whole = Fcons (event->x, event->y);
4020 part = *scroll_bar_parts[(int) event->part];
4021
4022 position =
4023 Fcons (window,
4024 Fcons (Qvertical_scroll_bar,
4025 Fcons (portion_whole,
4026 Fcons (make_number (event->timestamp),
4027 Fcons (part, Qnil)))));
4028 }
4029
fbd6baed 4030 /* Always treat W32 scroll bar events as clicks. */
db08707d
RS
4031 event->modifiers |= click_modifier;
4032
4033 {
4034 /* Get the symbol we should use for the mouse click. */
4035 Lisp_Object head;
4036
4037 head = modify_event_symbol (button,
4038 event->modifiers,
4039 Qmouse_click, Qnil,
4040 lispy_mouse_names, &mouse_syms,
4041 (sizeof (lispy_mouse_names)
4042 / sizeof (lispy_mouse_names[0])));
4043 return Fcons (head,
4044 Fcons (position,
4045 Qnil));
4046 }
4047 }
4048#endif
4049
514354e9 4050#endif /* HAVE_MOUSE */
284f4730 4051
e98a93eb 4052#if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2470a66f
KH
4053 case menu_bar_event:
4054 /* The event value is in the cdr of the frame_or_window slot. */
4055 if (!CONSP (event->frame_or_window))
4056 abort ();
4057 return XCONS (event->frame_or_window)->cdr;
4058#endif
4059
284f4730
JB
4060 /* The 'kind' field of the event is something we don't recognize. */
4061 default:
48e416d4 4062 abort ();
284f4730
JB
4063 }
4064}
4065
514354e9 4066#ifdef HAVE_MOUSE
6cbff1cb 4067
284f4730 4068static Lisp_Object
7b4aedb9 4069make_lispy_movement (frame, bar_window, part, x, y, time)
ff11dfa1 4070 FRAME_PTR frame;
7b4aedb9 4071 Lisp_Object bar_window;
3c370943 4072 enum scroll_bar_part part;
284f4730 4073 Lisp_Object x, y;
e5d77022 4074 unsigned long time;
284f4730 4075{
3c370943 4076 /* Is it a scroll bar movement? */
7b4aedb9 4077 if (frame && ! NILP (bar_window))
4bb994d1 4078 {
9b8eb840 4079 Lisp_Object part_sym;
4bb994d1 4080
9b8eb840 4081 part_sym = *scroll_bar_parts[(int) part];
3c370943 4082 return Fcons (Qscroll_bar_movement,
7b4aedb9 4083 (Fcons (Fcons (bar_window,
3c370943 4084 Fcons (Qvertical_scroll_bar,
4bb994d1
JB
4085 Fcons (Fcons (x, y),
4086 Fcons (make_number (time),
cb5df6ae 4087 Fcons (part_sym,
4bb994d1
JB
4088 Qnil))))),
4089 Qnil)));
4090 }
4091
4092 /* Or is it an ordinary mouse movement? */
284f4730
JB
4093 else
4094 {
4bb994d1 4095 int area;
9e20143a 4096 Lisp_Object window;
4bb994d1 4097 Lisp_Object posn;
9e20143a
RS
4098 int column, row;
4099
9e20143a 4100 if (frame)
047688cb
RS
4101 {
4102 /* It's in a frame; which window on that frame? */
6c6a9be8
KH
4103 pixel_to_glyph_coords (frame, XINT (x), XINT (y), &column, &row,
4104 NULL, 1);
047688cb
RS
4105 window = window_from_coordinates (frame, column, row, &area);
4106 }
9e20143a
RS
4107 else
4108 window = Qnil;
4bb994d1 4109
8c18cbfb 4110 if (WINDOWP (window))
4bb994d1 4111 {
9e20143a 4112 int pixcolumn, pixrow;
c8738c33 4113 column -= WINDOW_LEFT_MARGIN (XWINDOW (window));
9e20143a
RS
4114 row -= XINT (XWINDOW (window)->top);
4115 glyph_to_pixel_coords (frame, column, row, &pixcolumn, &pixrow);
4116 XSETINT (x, pixcolumn);
4117 XSETINT (y, pixrow);
4bb994d1
JB
4118
4119 if (area == 1)
4120 posn = Qmode_line;
4121 else if (area == 2)
4122 posn = Qvertical_line;
4123 else
18cd2eeb
KH
4124 XSETINT (posn,
4125 buffer_posn_from_coords (XWINDOW (window), column, row));
4bb994d1 4126 }
e9bf89a0
RS
4127 else if (frame != 0)
4128 {
18cd2eeb 4129 XSETFRAME (window, frame);
e9bf89a0
RS
4130 posn = Qnil;
4131 }
284f4730 4132 else
4bb994d1
JB
4133 {
4134 window = Qnil;
4135 posn = Qnil;
bb9e9bed
KH
4136 XSETFASTINT (x, 0);
4137 XSETFASTINT (y, 0);
4bb994d1 4138 }
284f4730 4139
4bb994d1
JB
4140 return Fcons (Qmouse_movement,
4141 Fcons (Fcons (window,
4142 Fcons (posn,
4143 Fcons (Fcons (x, y),
4144 Fcons (make_number (time),
4145 Qnil)))),
4146 Qnil));
4147 }
284f4730
JB
4148}
4149
514354e9 4150#endif /* HAVE_MOUSE */
6cbff1cb 4151
cd21b839
JB
4152/* Construct a switch frame event. */
4153static Lisp_Object
4154make_lispy_switch_frame (frame)
4155 Lisp_Object frame;
4156{
4157 return Fcons (Qswitch_frame, Fcons (frame, Qnil));
4158}
0a7f1fc0
JB
4159\f
4160/* Manipulating modifiers. */
284f4730 4161
0a7f1fc0 4162/* Parse the name of SYMBOL, and return the set of modifiers it contains.
284f4730 4163
0a7f1fc0
JB
4164 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
4165 SYMBOL's name of the end of the modifiers; the string from this
4166 position is the unmodified symbol name.
284f4730 4167
0a7f1fc0 4168 This doesn't use any caches. */
6da3dd3a 4169
0a7f1fc0
JB
4170static int
4171parse_modifiers_uncached (symbol, modifier_end)
284f4730 4172 Lisp_Object symbol;
0a7f1fc0 4173 int *modifier_end;
284f4730
JB
4174{
4175 struct Lisp_String *name;
4176 int i;
4177 int modifiers;
284f4730
JB
4178
4179 CHECK_SYMBOL (symbol, 1);
df0f2ba1 4180
284f4730
JB
4181 modifiers = 0;
4182 name = XSYMBOL (symbol)->name;
4183
0a7f1fc0 4184 for (i = 0; i+2 <= name->size; )
6da3dd3a
RS
4185 {
4186 int this_mod_end = 0;
4187 int this_mod = 0;
284f4730 4188
6da3dd3a
RS
4189 /* See if the name continues with a modifier word.
4190 Check that the word appears, but don't check what follows it.
4191 Set this_mod and this_mod_end to record what we find. */
fce33686 4192
6da3dd3a
RS
4193 switch (name->data[i])
4194 {
4195#define SINGLE_LETTER_MOD(BIT) \
4196 (this_mod_end = i + 1, this_mod = BIT)
4197
6da3dd3a
RS
4198 case 'A':
4199 SINGLE_LETTER_MOD (alt_modifier);
4200 break;
284f4730 4201
6da3dd3a
RS
4202 case 'C':
4203 SINGLE_LETTER_MOD (ctrl_modifier);
4204 break;
284f4730 4205
6da3dd3a
RS
4206 case 'H':
4207 SINGLE_LETTER_MOD (hyper_modifier);
4208 break;
4209
6da3dd3a
RS
4210 case 'M':
4211 SINGLE_LETTER_MOD (meta_modifier);
4212 break;
4213
6da3dd3a
RS
4214 case 'S':
4215 SINGLE_LETTER_MOD (shift_modifier);
4216 break;
4217
4218 case 's':
6da3dd3a
RS
4219 SINGLE_LETTER_MOD (super_modifier);
4220 break;
4221
0a7f1fc0 4222#undef SINGLE_LETTER_MOD
6da3dd3a
RS
4223 }
4224
4225 /* If we found no modifier, stop looking for them. */
4226 if (this_mod_end == 0)
4227 break;
4228
4229 /* Check there is a dash after the modifier, so that it
4230 really is a modifier. */
4231 if (this_mod_end >= name->size || name->data[this_mod_end] != '-')
4232 break;
4233
4234 /* This modifier is real; look for another. */
4235 modifiers |= this_mod;
4236 i = this_mod_end + 1;
4237 }
284f4730 4238
0a7f1fc0 4239 /* Should we include the `click' modifier? */
fbcd35bd
JB
4240 if (! (modifiers & (down_modifier | drag_modifier
4241 | double_modifier | triple_modifier))
0a7f1fc0 4242 && i + 7 == name->size
4bb994d1 4243 && strncmp (name->data + i, "mouse-", 6) == 0
6569cc8d 4244 && ('0' <= name->data[i + 6] && name->data[i + 6] <= '9'))
0a7f1fc0
JB
4245 modifiers |= click_modifier;
4246
4247 if (modifier_end)
4248 *modifier_end = i;
4249
4250 return modifiers;
4251}
4252
0a7f1fc0
JB
4253/* Return a symbol whose name is the modifier prefixes for MODIFIERS
4254 prepended to the string BASE[0..BASE_LEN-1].
4255 This doesn't use any caches. */
4256static Lisp_Object
4257apply_modifiers_uncached (modifiers, base, base_len)
4258 int modifiers;
4259 char *base;
4260 int base_len;
4261{
4262 /* Since BASE could contain nulls, we can't use intern here; we have
4263 to use Fintern, which expects a genuine Lisp_String, and keeps a
4264 reference to it. */
4265 char *new_mods =
fbcd35bd 4266 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
0a7f1fc0 4267 int mod_len;
284f4730 4268
284f4730 4269 {
0a7f1fc0
JB
4270 char *p = new_mods;
4271
4272 /* Only the event queue may use the `up' modifier; it should always
4273 be turned into a click or drag event before presented to lisp code. */
4274 if (modifiers & up_modifier)
4275 abort ();
4276
4277 if (modifiers & alt_modifier) { *p++ = 'A'; *p++ = '-'; }
4278 if (modifiers & ctrl_modifier) { *p++ = 'C'; *p++ = '-'; }
4279 if (modifiers & hyper_modifier) { *p++ = 'H'; *p++ = '-'; }
4280 if (modifiers & meta_modifier) { *p++ = 'M'; *p++ = '-'; }
4281 if (modifiers & shift_modifier) { *p++ = 'S'; *p++ = '-'; }
86e5706b 4282 if (modifiers & super_modifier) { *p++ = 's'; *p++ = '-'; }
fbcd35bd
JB
4283 if (modifiers & double_modifier) { strcpy (p, "double-"); p += 7; }
4284 if (modifiers & triple_modifier) { strcpy (p, "triple-"); p += 7; }
559f9d04
RS
4285 if (modifiers & down_modifier) { strcpy (p, "down-"); p += 5; }
4286 if (modifiers & drag_modifier) { strcpy (p, "drag-"); p += 5; }
0a7f1fc0
JB
4287 /* The click modifier is denoted by the absence of other modifiers. */
4288
4289 *p = '\0';
4290
4291 mod_len = p - new_mods;
4292 }
284f4730 4293
0a7f1fc0 4294 {
9b8eb840 4295 Lisp_Object new_name;
df0f2ba1 4296
9b8eb840 4297 new_name = make_uninit_string (mod_len + base_len);
0a7f1fc0
JB
4298 bcopy (new_mods, XSTRING (new_name)->data, mod_len);
4299 bcopy (base, XSTRING (new_name)->data + mod_len, base_len);
284f4730
JB
4300
4301 return Fintern (new_name, Qnil);
4302 }
4303}
4304
4305
0a7f1fc0
JB
4306static char *modifier_names[] =
4307{
fbcd35bd 4308 "up", "down", "drag", "click", "double", "triple", 0, 0,
f335fabe 4309 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
86e5706b 4310 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
0a7f1fc0 4311};
80645119 4312#define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
0a7f1fc0
JB
4313
4314static Lisp_Object modifier_symbols;
4315
4316/* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
4317static Lisp_Object
4318lispy_modifier_list (modifiers)
4319 int modifiers;
4320{
4321 Lisp_Object modifier_list;
4322 int i;
4323
4324 modifier_list = Qnil;
80645119 4325 for (i = 0; (1<<i) <= modifiers && i < NUM_MOD_NAMES; i++)
0a7f1fc0 4326 if (modifiers & (1<<i))
80645119
JB
4327 modifier_list = Fcons (XVECTOR (modifier_symbols)->contents[i],
4328 modifier_list);
0a7f1fc0
JB
4329
4330 return modifier_list;
4331}
4332
4333
4334/* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
4335 where UNMODIFIED is the unmodified form of SYMBOL,
4336 MASK is the set of modifiers present in SYMBOL's name.
4337 This is similar to parse_modifiers_uncached, but uses the cache in
4338 SYMBOL's Qevent_symbol_element_mask property, and maintains the
4339 Qevent_symbol_elements property. */
3d31316f 4340
0a7f1fc0
JB
4341static Lisp_Object
4342parse_modifiers (symbol)
4343 Lisp_Object symbol;
4344{
9b8eb840 4345 Lisp_Object elements;
0a7f1fc0 4346
9b8eb840 4347 elements = Fget (symbol, Qevent_symbol_element_mask);
0a7f1fc0
JB
4348 if (CONSP (elements))
4349 return elements;
4350 else
4351 {
4352 int end;
ec0faad2 4353 int modifiers = parse_modifiers_uncached (symbol, &end);
9b8eb840 4354 Lisp_Object unmodified;
0a7f1fc0
JB
4355 Lisp_Object mask;
4356
9b8eb840
KH
4357 unmodified = Fintern (make_string (XSYMBOL (symbol)->name->data + end,
4358 XSYMBOL (symbol)->name->size - end),
4359 Qnil);
4360
ec0faad2 4361 if (modifiers & ~(((EMACS_INT)1 << VALBITS) - 1))
734fef94 4362 abort ();
bb9e9bed 4363 XSETFASTINT (mask, modifiers);
0a7f1fc0
JB
4364 elements = Fcons (unmodified, Fcons (mask, Qnil));
4365
4366 /* Cache the parsing results on SYMBOL. */
4367 Fput (symbol, Qevent_symbol_element_mask,
4368 elements);
4369 Fput (symbol, Qevent_symbol_elements,
4370 Fcons (unmodified, lispy_modifier_list (modifiers)));
4371
4372 /* Since we know that SYMBOL is modifiers applied to unmodified,
4373 it would be nice to put that in unmodified's cache.
4374 But we can't, since we're not sure that parse_modifiers is
4375 canonical. */
4376
4377 return elements;
4378 }
4379}
4380
4381/* Apply the modifiers MODIFIERS to the symbol BASE.
4382 BASE must be unmodified.
4383
4384 This is like apply_modifiers_uncached, but uses BASE's
4385 Qmodifier_cache property, if present. It also builds
cd21b839
JB
4386 Qevent_symbol_elements properties, since it has that info anyway.
4387
4388 apply_modifiers copies the value of BASE's Qevent_kind property to
4389 the modified symbol. */
0a7f1fc0
JB
4390static Lisp_Object
4391apply_modifiers (modifiers, base)
4392 int modifiers;
4393 Lisp_Object base;
4394{
7b4aedb9 4395 Lisp_Object cache, index, entry, new_symbol;
0a7f1fc0 4396
80645119 4397 /* Mask out upper bits. We don't know where this value's been. */
ec0faad2 4398 modifiers &= ((EMACS_INT)1 << VALBITS) - 1;
80645119 4399
0a7f1fc0 4400 /* The click modifier never figures into cache indices. */
0a7f1fc0 4401 cache = Fget (base, Qmodifier_cache);
bb9e9bed 4402 XSETFASTINT (index, (modifiers & ~click_modifier));
697e4895 4403 entry = assq_no_quit (index, cache);
0a7f1fc0
JB
4404
4405 if (CONSP (entry))
7b4aedb9
JB
4406 new_symbol = XCONS (entry)->cdr;
4407 else
4408 {
df0f2ba1 4409 /* We have to create the symbol ourselves. */
7b4aedb9
JB
4410 new_symbol = apply_modifiers_uncached (modifiers,
4411 XSYMBOL (base)->name->data,
4412 XSYMBOL (base)->name->size);
4413
4414 /* Add the new symbol to the base's cache. */
4415 entry = Fcons (index, new_symbol);
4416 Fput (base, Qmodifier_cache, Fcons (entry, cache));
4417
4418 /* We have the parsing info now for free, so add it to the caches. */
bb9e9bed 4419 XSETFASTINT (index, modifiers);
7b4aedb9
JB
4420 Fput (new_symbol, Qevent_symbol_element_mask,
4421 Fcons (base, Fcons (index, Qnil)));
4422 Fput (new_symbol, Qevent_symbol_elements,
4423 Fcons (base, lispy_modifier_list (modifiers)));
4424 }
0a7f1fc0 4425
df0f2ba1 4426 /* Make sure this symbol is of the same kind as BASE.
7b4aedb9
JB
4427
4428 You'd think we could just set this once and for all when we
4429 intern the symbol above, but reorder_modifiers may call us when
4430 BASE's property isn't set right; we can't assume that just
80645119
JB
4431 because it has a Qmodifier_cache property it must have its
4432 Qevent_kind set right as well. */
7b4aedb9
JB
4433 if (NILP (Fget (new_symbol, Qevent_kind)))
4434 {
9b8eb840 4435 Lisp_Object kind;
7b4aedb9 4436
9b8eb840 4437 kind = Fget (base, Qevent_kind);
7b4aedb9
JB
4438 if (! NILP (kind))
4439 Fput (new_symbol, Qevent_kind, kind);
4440 }
4441
4442 return new_symbol;
0a7f1fc0
JB
4443}
4444
4445
4446/* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
4447 return a symbol with the modifiers placed in the canonical order.
4448 Canonical order is alphabetical, except for down and drag, which
4449 always come last. The 'click' modifier is never written out.
4450
4451 Fdefine_key calls this to make sure that (for example) C-M-foo
4452 and M-C-foo end up being equivalent in the keymap. */
4453
4454Lisp_Object
4455reorder_modifiers (symbol)
4456 Lisp_Object symbol;
4457{
4458 /* It's hopefully okay to write the code this way, since everything
4459 will soon be in caches, and no consing will be done at all. */
9b8eb840 4460 Lisp_Object parsed;
0a7f1fc0 4461
9b8eb840 4462 parsed = parse_modifiers (symbol);
54593ed9 4463 return apply_modifiers ((int) XINT (XCONS (XCONS (parsed)->cdr)->car),
0a7f1fc0
JB
4464 XCONS (parsed)->car);
4465}
4466
4467
284f4730
JB
4468/* For handling events, we often want to produce a symbol whose name
4469 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
4470 to some base, like the name of a function key or mouse button.
4471 modify_event_symbol produces symbols of this sort.
4472
4473 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
4474 is the name of the i'th symbol. TABLE_SIZE is the number of elements
4475 in the table.
4476
80e4aa30
RS
4477 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
4478 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
4479
284f4730
JB
4480 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
4481 persist between calls to modify_event_symbol that it can use to
4482 store a cache of the symbols it's generated for this NAME_TABLE
80e4aa30 4483 before. The object stored there may be a vector or an alist.
284f4730
JB
4484
4485 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
df0f2ba1 4486
284f4730
JB
4487 MODIFIERS is a set of modifier bits (as given in struct input_events)
4488 whose prefixes should be applied to the symbol name.
4489
4490 SYMBOL_KIND is the value to be placed in the event_kind property of
df0f2ba1 4491 the returned symbol.
88cb0656
JB
4492
4493 The symbols we create are supposed to have an
eb8c3be9 4494 `event-symbol-elements' property, which lists the modifiers present
88cb0656
JB
4495 in the symbol's name. */
4496
284f4730 4497static Lisp_Object
80e4aa30
RS
4498modify_event_symbol (symbol_num, modifiers, symbol_kind, name_alist,
4499 name_table, symbol_table, table_size)
284f4730
JB
4500 int symbol_num;
4501 unsigned modifiers;
4502 Lisp_Object symbol_kind;
80e4aa30 4503 Lisp_Object name_alist;
284f4730
JB
4504 char **name_table;
4505 Lisp_Object *symbol_table;
2c834fb3 4506 unsigned int table_size;
284f4730 4507{
80e4aa30
RS
4508 Lisp_Object value;
4509 Lisp_Object symbol_int;
4510
2c834fb3
KH
4511 /* Get rid of the "vendor-specific" bit here. */
4512 XSETINT (symbol_int, symbol_num & 0xffffff);
284f4730
JB
4513
4514 /* Is this a request for a valid symbol? */
88cb0656 4515 if (symbol_num < 0 || symbol_num >= table_size)
0c2611c5 4516 return Qnil;
284f4730 4517
80e4aa30
RS
4518 if (CONSP (*symbol_table))
4519 value = Fcdr (assq_no_quit (symbol_int, *symbol_table));
4520
0a7f1fc0 4521 /* If *symbol_table doesn't seem to be initialized properly, fix that.
88cb0656 4522 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4bb994d1
JB
4523 where the Nth element is the symbol for NAME_TABLE[N], or nil if
4524 we've never used that symbol before. */
80e4aa30 4525 else
88cb0656 4526 {
80e4aa30
RS
4527 if (! VECTORP (*symbol_table)
4528 || XVECTOR (*symbol_table)->size != table_size)
4529 {
4530 Lisp_Object size;
0a7f1fc0 4531
bb9e9bed 4532 XSETFASTINT (size, table_size);
80e4aa30
RS
4533 *symbol_table = Fmake_vector (size, Qnil);
4534 }
284f4730 4535
80e4aa30
RS
4536 value = XVECTOR (*symbol_table)->contents[symbol_num];
4537 }
284f4730 4538
0a7f1fc0 4539 /* Have we already used this symbol before? */
80e4aa30 4540 if (NILP (value))
284f4730 4541 {
0a7f1fc0 4542 /* No; let's create it. */
80e4aa30 4543 if (!NILP (name_alist))
b64b4075 4544 value = Fcdr_safe (Fassq (symbol_int, name_alist));
2ff6714d 4545 else if (name_table != 0 && name_table[symbol_num])
80e4aa30 4546 value = intern (name_table[symbol_num]);
b64b4075 4547
e98a93eb 4548#ifdef HAVE_WINDOW_SYSTEM
2c834fb3
KH
4549 if (NILP (value))
4550 {
4551 char *name = x_get_keysym_name (symbol_num);
4552 if (name)
4553 value = intern (name);
4554 }
4555#endif
4556
b64b4075 4557 if (NILP (value))
d1f50460
RS
4558 {
4559 char buf[20];
4560 sprintf (buf, "key-%d", symbol_num);
80e4aa30 4561 value = intern (buf);
d1f50460 4562 }
0a7f1fc0 4563
80e4aa30 4564 if (CONSP (*symbol_table))
4205cb08 4565 *symbol_table = Fcons (Fcons (symbol_int, value), *symbol_table);
80e4aa30
RS
4566 else
4567 XVECTOR (*symbol_table)->contents[symbol_num] = value;
4568
df0f2ba1 4569 /* Fill in the cache entries for this symbol; this also
0a7f1fc0
JB
4570 builds the Qevent_symbol_elements property, which the user
4571 cares about. */
80e4aa30
RS
4572 apply_modifiers (modifiers & click_modifier, value);
4573 Fput (value, Qevent_kind, symbol_kind);
284f4730 4574 }
88cb0656 4575
0a7f1fc0 4576 /* Apply modifiers to that symbol. */
80e4aa30 4577 return apply_modifiers (modifiers, value);
284f4730 4578}
6da3dd3a
RS
4579\f
4580/* Convert a list that represents an event type,
4581 such as (ctrl meta backspace), into the usual representation of that
4582 event type as a number or a symbol. */
4583
a1706c30 4584DEFUN ("event-convert-list", Fevent_convert_list, Sevent_convert_list, 1, 1, 0,
e57d8fd8
EN
4585 "Convert the event description list EVENT-DESC to an event type.\n\
4586EVENT-DESC should contain one base event type (a character or symbol)\n\
a1706c30 4587and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
377f24f5 4588drag, down, double or triple). The base must be last.\n\
a1706c30
KH
4589The return value is an event type (a character or symbol) which\n\
4590has the same base event type and all the specified modifiers.")
e57d8fd8
EN
4591 (event_desc)
4592 Lisp_Object event_desc;
6da3dd3a
RS
4593{
4594 Lisp_Object base;
4595 int modifiers = 0;
4596 Lisp_Object rest;
4597
4598 base = Qnil;
e57d8fd8 4599 rest = event_desc;
6da3dd3a
RS
4600 while (CONSP (rest))
4601 {
4602 Lisp_Object elt;
4603 int this = 0;
4604
4605 elt = XCONS (rest)->car;
377f24f5 4606 rest = XCONS (rest)->cdr;
6da3dd3a 4607
3d31316f 4608 /* Given a symbol, see if it is a modifier name. */
377f24f5 4609 if (SYMBOLP (elt) && CONSP (rest))
3d31316f 4610 this = parse_solitary_modifier (elt);
6da3dd3a
RS
4611
4612 if (this != 0)
4613 modifiers |= this;
4614 else if (!NILP (base))
4615 error ("Two bases given in one event");
4616 else
4617 base = elt;
4618
6da3dd3a
RS
4619 }
4620
3d31316f
RS
4621 /* Let the symbol A refer to the character A. */
4622 if (SYMBOLP (base) && XSYMBOL (base)->name->size == 1)
4623 XSETINT (base, XSYMBOL (base)->name->data[0]);
4624
6da3dd3a
RS
4625 if (INTEGERP (base))
4626 {
3d31316f
RS
4627 /* Turn (shift a) into A. */
4628 if ((modifiers & shift_modifier) != 0
4629 && (XINT (base) >= 'a' && XINT (base) <= 'z'))
4630 {
4631 XSETINT (base, XINT (base) - ('a' - 'A'));
4632 modifiers &= ~shift_modifier;
4633 }
4634
4635 /* Turn (control a) into C-a. */
6da3dd3a 4636 if (modifiers & ctrl_modifier)
3d31316f 4637 return make_number ((modifiers & ~ctrl_modifier)
6da3dd3a
RS
4638 | make_ctrl_char (XINT (base)));
4639 else
4640 return make_number (modifiers | XINT (base));
4641 }
4642 else if (SYMBOLP (base))
4643 return apply_modifiers (modifiers, base);
4644 else
4645 error ("Invalid base event");
4646}
4647
3d31316f
RS
4648/* Try to recognize SYMBOL as a modifier name.
4649 Return the modifier flag bit, or 0 if not recognized. */
4650
4651static int
4652parse_solitary_modifier (symbol)
4653 Lisp_Object symbol;
4654{
4655 struct Lisp_String *name = XSYMBOL (symbol)->name;
4656
4657 switch (name->data[0])
4658 {
4659#define SINGLE_LETTER_MOD(BIT) \
4660 if (name->size == 1) \
4661 return BIT;
4662
4663#define MULTI_LETTER_MOD(BIT, NAME, LEN) \
4664 if (LEN == name->size \
4665 && ! strncmp (name->data, NAME, LEN)) \
4666 return BIT;
4667
4668 case 'A':
4669 SINGLE_LETTER_MOD (alt_modifier);
4670 break;
4671
4672 case 'a':
4673 MULTI_LETTER_MOD (alt_modifier, "alt", 3);
4674 break;
4675
4676 case 'C':
4677 SINGLE_LETTER_MOD (ctrl_modifier);
4678 break;
4679
4680 case 'c':
4681 MULTI_LETTER_MOD (ctrl_modifier, "ctrl", 4);
4682 MULTI_LETTER_MOD (ctrl_modifier, "control", 7);
4683 break;
4684
4685 case 'H':
4686 SINGLE_LETTER_MOD (hyper_modifier);
4687 break;
4688
4689 case 'h':
4690 MULTI_LETTER_MOD (hyper_modifier, "hyper", 5);
4691 break;
4692
4693 case 'M':
4694 SINGLE_LETTER_MOD (meta_modifier);
4695 break;
4696
4697 case 'm':
4698 MULTI_LETTER_MOD (meta_modifier, "meta", 4);
4699 break;
4700
4701 case 'S':
4702 SINGLE_LETTER_MOD (shift_modifier);
4703 break;
4704
4705 case 's':
4706 MULTI_LETTER_MOD (shift_modifier, "shift", 5);
4707 MULTI_LETTER_MOD (super_modifier, "super", 5);
4708 SINGLE_LETTER_MOD (super_modifier);
4709 break;
4710
4711 case 'd':
4712 MULTI_LETTER_MOD (drag_modifier, "drag", 4);
4713 MULTI_LETTER_MOD (down_modifier, "down", 4);
4714 MULTI_LETTER_MOD (double_modifier, "double", 6);
4715 break;
4716
4717 case 't':
4718 MULTI_LETTER_MOD (triple_modifier, "triple", 6);
4719 break;
4720
4721#undef SINGLE_LETTER_MOD
4722#undef MULTI_LETTER_MOD
4723 }
4724
4725 return 0;
4726}
4727
6da3dd3a
RS
4728/* Return 1 if EVENT is a list whose elements are all integers or symbols.
4729 Such a list is not valid as an event,
4730 but it can be a Lucid-style event type list. */
4731
4732int
4733lucid_event_type_list_p (object)
4734 Lisp_Object object;
4735{
4736 Lisp_Object tail;
4737
4738 if (! CONSP (object))
4739 return 0;
4740
4741 for (tail = object; CONSP (tail); tail = XCONS (tail)->cdr)
4742 {
4743 Lisp_Object elt;
4744 elt = XCONS (tail)->car;
4745 if (! (INTEGERP (elt) || SYMBOLP (elt)))
4746 return 0;
4747 }
4748
4749 return NILP (tail);
4750}
284f4730 4751\f
284f4730
JB
4752/* Store into *addr a value nonzero if terminal input chars are available.
4753 Serves the purpose of ioctl (0, FIONREAD, addr)
4754 but works even if FIONREAD does not exist.
d9d4c147
KH
4755 (In fact, this may actually read some input.)
4756
4757 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
284f4730
JB
4758
4759static void
d9d4c147 4760get_input_pending (addr, do_timers_now)
284f4730 4761 int *addr;
d9d4c147 4762 int do_timers_now;
284f4730
JB
4763{
4764 /* First of all, have we already counted some input? */
d9d4c147 4765 *addr = !NILP (Vquit_flag) || readable_events (do_timers_now);
284f4730
JB
4766
4767 /* If input is being read as it arrives, and we have none, there is none. */
4768 if (*addr > 0 || (interrupt_input && ! interrupts_deferred))
4769 return;
4770
4771 /* Try to read some input and see how much we get. */
4772 gobble_input (0);
d9d4c147 4773 *addr = !NILP (Vquit_flag) || readable_events (do_timers_now);
284f4730
JB
4774}
4775
81931ba1 4776/* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
284f4730
JB
4777
4778int
4779gobble_input (expected)
4780 int expected;
4781{
4782#ifndef VMS
4783#ifdef SIGIO
4784 if (interrupt_input)
4785 {
32676c08 4786 SIGMASKTYPE mask;
4f8aaa74 4787 mask = sigblock (sigmask (SIGIO));
284f4730 4788 read_avail_input (expected);
e065a56e 4789 sigsetmask (mask);
284f4730
JB
4790 }
4791 else
81931ba1
RS
4792#ifdef POLL_FOR_INPUT
4793 if (read_socket_hook && !interrupt_input && poll_suppress_count == 0)
4794 {
4795 SIGMASKTYPE mask;
4f8aaa74 4796 mask = sigblock (sigmask (SIGALRM));
81931ba1
RS
4797 read_avail_input (expected);
4798 sigsetmask (mask);
4799 }
4800 else
87485d6f 4801#endif
284f4730
JB
4802#endif
4803 read_avail_input (expected);
4804#endif
4805}
a8015ab5 4806
241ceaf7
RS
4807/* Put a buffer_switch_event in the buffer
4808 so that read_key_sequence will notice the new current buffer. */
4809
a8015ab5
KH
4810record_asynch_buffer_change ()
4811{
4812 struct input_event event;
a30f0615
RS
4813 Lisp_Object tem;
4814
a8015ab5
KH
4815 event.kind = buffer_switch_event;
4816 event.frame_or_window = Qnil;
241ceaf7 4817
f65e6f7d 4818#ifdef subprocesses
a30f0615
RS
4819 /* We don't need a buffer-switch event unless Emacs is waiting for input.
4820 The purpose of the event is to make read_key_sequence look up the
4821 keymaps again. If we aren't in read_key_sequence, we don't need one,
4822 and the event could cause trouble by messing up (input-pending-p). */
4823 tem = Fwaiting_for_user_input_p ();
4824 if (NILP (tem))
4825 return;
f65e6f7d
RS
4826#else
4827 /* We never need these events if we have no asynchronous subprocesses. */
4828 return;
4829#endif
a30f0615 4830
241ceaf7
RS
4831 /* Make sure no interrupt happens while storing the event. */
4832#ifdef SIGIO
4833 if (interrupt_input)
4834 {
4835 SIGMASKTYPE mask;
4f8aaa74 4836 mask = sigblock (sigmask (SIGIO));
241ceaf7
RS
4837 kbd_buffer_store_event (&event);
4838 sigsetmask (mask);
4839 }
4840 else
4841#endif
4842 {
4843 stop_polling ();
4844 kbd_buffer_store_event (&event);
4845 start_polling ();
4846 }
a8015ab5 4847}
284f4730
JB
4848\f
4849#ifndef VMS
4850
4851/* Read any terminal input already buffered up by the system
4852 into the kbd_buffer, but do not wait.
4853
4854 EXPECTED should be nonzero if the caller knows there is some input.
4855
4856 Except on VMS, all input is read by this function.
4857 If interrupt_input is nonzero, this function MUST be called
4858 only when SIGIO is blocked.
4859
4860 Returns the number of keyboard chars read, or -1 meaning
4861 this is a bad time to try to read input. */
4862
4863static int
4864read_avail_input (expected)
4865 int expected;
4866{
4867 struct input_event buf[KBD_BUFFER_SIZE];
4868 register int i;
4869 int nread;
4870
4871 if (read_socket_hook)
4872 /* No need for FIONREAD or fcntl; just say don't wait. */
33e19c6e 4873 nread = (*read_socket_hook) (input_fd, buf, KBD_BUFFER_SIZE, expected);
284f4730
JB
4874 else
4875 {
17270835
RS
4876 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
4877 the kbd_buffer can really hold. That may prevent loss
4878 of characters on some systems when input is stuffed at us. */
4879 unsigned char cbuf[KBD_BUFFER_SIZE - 1];
58788063 4880 int n_to_read;
284f4730 4881
58788063 4882 /* Determine how many characters we should *try* to read. */
bc536d84
RS
4883#ifdef WINDOWSNT
4884 return 0;
4885#else /* not WINDOWSNT */
80e4aa30 4886#ifdef MSDOS
58788063
RS
4887 n_to_read = dos_keysns ();
4888 if (n_to_read == 0)
4889 return 0;
c3a2738c 4890#else /* not MSDOS */
284f4730
JB
4891#ifdef FIONREAD
4892 /* Find out how much input is available. */
437f6112 4893 if (ioctl (input_fd, FIONREAD, &n_to_read) < 0)
284f4730
JB
4894 /* Formerly simply reported no input, but that sometimes led to
4895 a failure of Emacs to terminate.
4896 SIGHUP seems appropriate if we can't reach the terminal. */
e4535288
RS
4897 /* ??? Is it really right to send the signal just to this process
4898 rather than to the whole process group?
4899 Perhaps on systems with FIONREAD Emacs is alone in its group. */
284f4730 4900 kill (getpid (), SIGHUP);
58788063 4901 if (n_to_read == 0)
284f4730 4902 return 0;
58788063
RS
4903 if (n_to_read > sizeof cbuf)
4904 n_to_read = sizeof cbuf;
284f4730 4905#else /* no FIONREAD */
0c04a67e 4906#if defined (USG) || defined (DGUX)
284f4730 4907 /* Read some input if available, but don't wait. */
58788063 4908 n_to_read = sizeof cbuf;
437f6112 4909 fcntl (input_fd, F_SETFL, O_NDELAY);
284f4730
JB
4910#else
4911 you lose;
4912#endif
4913#endif
80e4aa30 4914#endif /* not MSDOS */
bc536d84 4915#endif /* not WINDOWSNT */
284f4730 4916
58788063
RS
4917 /* Now read; for one reason or another, this will not block.
4918 NREAD is set to the number of chars read. */
9134775b 4919 do
284f4730 4920 {
80e4aa30 4921#ifdef MSDOS
0c04a67e 4922 cbuf[0] = dos_keyread ();
80e4aa30
RS
4923 nread = 1;
4924#else
437f6112 4925 nread = read (input_fd, cbuf, n_to_read);
80e4aa30 4926#endif
49854566
RS
4927 /* POSIX infers that processes which are not in the session leader's
4928 process group won't get SIGHUP's at logout time. BSDI adheres to
4929 this part standard and returns -1 from read(0) with errno==EIO
4930 when the control tty is taken away.
4931 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
4932 if (nread == -1 && errno == EIO)
4933 kill (0, SIGHUP);
762f2b92 4934#if defined (AIX) && (! defined (aix386) && defined (_BSD))
284f4730
JB
4935 /* The kernel sometimes fails to deliver SIGHUP for ptys.
4936 This looks incorrect, but it isn't, because _BSD causes
4937 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
4938 and that causes a value other than 0 when there is no input. */
854f3a54 4939 if (nread == 0)
80e4aa30 4940 kill (0, SIGHUP);
284f4730 4941#endif
9134775b 4942 }
791587ee
KH
4943 while (
4944 /* We used to retry the read if it was interrupted.
4945 But this does the wrong thing when O_NDELAY causes
4946 an EAGAIN error. Does anybody know of a situation
4947 where a retry is actually needed? */
4948#if 0
4949 nread < 0 && (errno == EAGAIN
6aec06f5 4950#ifdef EFAULT
9134775b 4951 || errno == EFAULT
80e4aa30 4952#endif
284f4730 4953#ifdef EBADSLT
9134775b 4954 || errno == EBADSLT
284f4730 4955#endif
791587ee
KH
4956 )
4957#else
4958 0
4959#endif
4960 );
284f4730
JB
4961
4962#ifndef FIONREAD
02c2c53f 4963#if defined (USG) || defined (DGUX)
437f6112 4964 fcntl (input_fd, F_SETFL, 0);
02c2c53f 4965#endif /* USG or DGUX */
284f4730
JB
4966#endif /* no FIONREAD */
4967 for (i = 0; i < nread; i++)
4968 {
4969 buf[i].kind = ascii_keystroke;
86e5706b 4970 buf[i].modifiers = 0;
b04904fb 4971 if (meta_key == 1 && (cbuf[i] & 0x80))
86e5706b 4972 buf[i].modifiers = meta_modifier;
b04904fb
RS
4973 if (meta_key != 2)
4974 cbuf[i] &= ~0x80;
f3e59d5e
KH
4975
4976 buf[i].code = cbuf[i];
18cd2eeb 4977 XSETFRAME (buf[i].frame_or_window, selected_frame);
284f4730
JB
4978 }
4979 }
4980
4981 /* Scan the chars for C-g and store them in kbd_buffer. */
4982 for (i = 0; i < nread; i++)
4983 {
4984 kbd_buffer_store_event (&buf[i]);
4985 /* Don't look at input that follows a C-g too closely.
4986 This reduces lossage due to autorepeat on C-g. */
4987 if (buf[i].kind == ascii_keystroke
9343ab07 4988 && buf[i].code == quit_char)
284f4730
JB
4989 break;
4990 }
4991
4992 return nread;
4993}
4994#endif /* not VMS */
4995\f
4996#ifdef SIGIO /* for entire page */
4997/* Note SIGIO has been undef'd if FIONREAD is missing. */
4998
2ce30ea2 4999SIGTYPE
284f4730
JB
5000input_available_signal (signo)
5001 int signo;
5002{
5003 /* Must preserve main program's value of errno. */
5004 int old_errno = errno;
5005#ifdef BSD4_1
5006 extern int select_alarmed;
5007#endif
5008
5970a8cb 5009#if defined (USG) && !defined (POSIX_SIGNALS)
284f4730
JB
5010 /* USG systems forget handlers when they are used;
5011 must reestablish each time */
5012 signal (signo, input_available_signal);
5013#endif /* USG */
5014
5015#ifdef BSD4_1
5016 sigisheld (SIGIO);
5017#endif
5018
ffd56f97
JB
5019 if (input_available_clear_time)
5020 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
284f4730
JB
5021
5022 while (1)
5023 {
5024 int nread;
5025 nread = read_avail_input (1);
5026 /* -1 means it's not ok to read the input now.
5027 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
5028 0 means there was no keyboard input available. */
5029 if (nread <= 0)
5030 break;
5031
5032#ifdef BSD4_1
5033 select_alarmed = 1; /* Force the select emulator back to life */
5034#endif
5035 }
5036
5037#ifdef BSD4_1
5038 sigfree ();
5039#endif
5040 errno = old_errno;
5041}
5042#endif /* SIGIO */
ad163903
JB
5043
5044/* Send ourselves a SIGIO.
5045
5046 This function exists so that the UNBLOCK_INPUT macro in
5047 blockinput.h can have some way to take care of input we put off
5048 dealing with, without assuming that every file which uses
5049 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
5050void
5051reinvoke_input_signal ()
5052{
df0f2ba1 5053#ifdef SIGIO
87dd9b9b 5054 kill (getpid (), SIGIO);
ad163903
JB
5055#endif
5056}
5057
5058
284f4730
JB
5059\f
5060/* Return the prompt-string of a sparse keymap.
5061 This is the first element which is a string.
5062 Return nil if there is none. */
5063
5064Lisp_Object
5065map_prompt (map)
5066 Lisp_Object map;
5067{
5068 while (CONSP (map))
5069 {
5070 register Lisp_Object tem;
5071 tem = Fcar (map);
8c18cbfb 5072 if (STRINGP (tem))
284f4730
JB
5073 return tem;
5074 map = Fcdr (map);
5075 }
5076 return Qnil;
5077}
5078
b7c49376
RS
5079static void menu_bar_item ();
5080static void menu_bar_one_keymap ();
5081
5082/* These variables hold the vector under construction within
5083 menu_bar_items and its subroutines, and the current index
5084 for storing into that vector. */
5085static Lisp_Object menu_bar_items_vector;
9343ab07 5086static int menu_bar_items_index;
5ec75a55 5087
b7c49376
RS
5088/* Return a vector of menu items for a menu bar, appropriate
5089 to the current buffer. Each item has three elements in the vector:
f5e09c8b 5090 KEY STRING MAPLIST.
b7c49376
RS
5091
5092 OLD is an old vector we can optionally reuse, or nil. */
5ec75a55
RS
5093
5094Lisp_Object
b7c49376
RS
5095menu_bar_items (old)
5096 Lisp_Object old;
5ec75a55
RS
5097{
5098 /* The number of keymaps we're scanning right now, and the number of
5099 keymaps we have allocated space for. */
5100 int nmaps;
5101
5102 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5103 in the current keymaps, or nil where it is not a prefix. */
5104 Lisp_Object *maps;
5105
9f9c0e27 5106 Lisp_Object def, tem, tail;
5ec75a55
RS
5107
5108 Lisp_Object result;
5109
5110 int mapno;
47d319aa 5111 Lisp_Object oquit;
5ec75a55 5112
b7c49376
RS
5113 int i;
5114
5115 struct gcpro gcpro1;
5116
db60d856
JB
5117 /* In order to build the menus, we need to call the keymap
5118 accessors. They all call QUIT. But this function is called
5119 during redisplay, during which a quit is fatal. So inhibit
47d319aa
RS
5120 quitting while building the menus.
5121 We do this instead of specbind because (1) errors will clear it anyway
5122 and (2) this avoids risk of specpdl overflow. */
5123 oquit = Vinhibit_quit;
df0f2ba1 5124 Vinhibit_quit = Qt;
db60d856 5125
b7c49376
RS
5126 if (!NILP (old))
5127 menu_bar_items_vector = old;
5128 else
5129 menu_bar_items_vector = Fmake_vector (make_number (24), Qnil);
5130 menu_bar_items_index = 0;
5131
5132 GCPRO1 (menu_bar_items_vector);
5133
5ec75a55
RS
5134 /* Build our list of keymaps.
5135 If we recognize a function key and replace its escape sequence in
5136 keybuf with its symbol, or if the sequence starts with a mouse
5137 click and we need to switch buffers, we jump back here to rebuild
5138 the initial keymaps from the current buffer. */
df0f2ba1 5139 {
5ec75a55
RS
5140 Lisp_Object *tmaps;
5141
217258d5 5142 /* Should overriding-terminal-local-map and overriding-local-map apply? */
d0a49716 5143 if (!NILP (Voverriding_local_map_menu_flag))
9dd3131c 5144 {
217258d5
KH
5145 /* Yes, use them (if non-nil) as well as the global map. */
5146 maps = (Lisp_Object *) alloca (3 * sizeof (maps[0]));
5147 nmaps = 0;
5148 if (!NILP (current_kboard->Voverriding_terminal_local_map))
5149 maps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
5150 if (!NILP (Voverriding_local_map))
5151 maps[nmaps++] = Voverriding_local_map;
9dd3131c
RS
5152 }
5153 else
5154 {
d0a49716 5155 /* No, so use major and minor mode keymaps. */
217258d5
KH
5156 nmaps = current_minor_maps (NULL, &tmaps);
5157 maps = (Lisp_Object *) alloca ((nmaps + 2) * sizeof (maps[0]));
5158 bcopy (tmaps, maps, nmaps * sizeof (maps[0]));
5ec75a55 5159#ifdef USE_TEXT_PROPERTIES
217258d5 5160 maps[nmaps++] = get_local_map (PT, current_buffer);
5ec75a55 5161#else
217258d5 5162 maps[nmaps++] = current_buffer->keymap;
5ec75a55 5163#endif
9dd3131c 5164 }
217258d5 5165 maps[nmaps++] = current_global_map;
5ec75a55
RS
5166 }
5167
5168 /* Look up in each map the dummy prefix key `menu-bar'. */
5169
5170 result = Qnil;
5171
e58aa385 5172 for (mapno = nmaps - 1; mapno >= 0; mapno--)
5ec75a55
RS
5173 {
5174 if (! NILP (maps[mapno]))
e74fbc70 5175 def = get_keyelt (access_keymap (maps[mapno], Qmenu_bar, 1, 0));
5ec75a55
RS
5176 else
5177 def = Qnil;
5178
5179 tem = Fkeymapp (def);
5180 if (!NILP (tem))
b7c49376 5181 menu_bar_one_keymap (def);
5ec75a55
RS
5182 }
5183
b7c49376
RS
5184 /* Move to the end those items that should be at the end. */
5185
9f9c0e27
RS
5186 for (tail = Vmenu_bar_final_items; CONSP (tail); tail = XCONS (tail)->cdr)
5187 {
b7c49376
RS
5188 int i;
5189 int end = menu_bar_items_index;
5190
35b3402f 5191 for (i = 0; i < end; i += 4)
b7c49376
RS
5192 if (EQ (XCONS (tail)->car, XVECTOR (menu_bar_items_vector)->contents[i]))
5193 {
35b3402f 5194 Lisp_Object tem0, tem1, tem2, tem3;
0301268e
RS
5195 /* Move the item at index I to the end,
5196 shifting all the others forward. */
5197 tem0 = XVECTOR (menu_bar_items_vector)->contents[i + 0];
5198 tem1 = XVECTOR (menu_bar_items_vector)->contents[i + 1];
5199 tem2 = XVECTOR (menu_bar_items_vector)->contents[i + 2];
35b3402f
RS
5200 tem3 = XVECTOR (menu_bar_items_vector)->contents[i + 3];
5201 if (end > i + 4)
5202 bcopy (&XVECTOR (menu_bar_items_vector)->contents[i + 4],
0301268e 5203 &XVECTOR (menu_bar_items_vector)->contents[i],
35b3402f
RS
5204 (end - i - 4) * sizeof (Lisp_Object));
5205 XVECTOR (menu_bar_items_vector)->contents[end - 4] = tem0;
5206 XVECTOR (menu_bar_items_vector)->contents[end - 3] = tem1;
5207 XVECTOR (menu_bar_items_vector)->contents[end - 2] = tem2;
5208 XVECTOR (menu_bar_items_vector)->contents[end - 1] = tem3;
0301268e 5209 break;
b7c49376
RS
5210 }
5211 }
9f9c0e27 5212
0c9071cd 5213 /* Add nil, nil, nil, nil at the end. */
b7c49376 5214 i = menu_bar_items_index;
35b3402f 5215 if (i + 4 > XVECTOR (menu_bar_items_vector)->size)
b7c49376
RS
5216 {
5217 Lisp_Object tem;
5218 int newsize = 2 * i;
5219 tem = Fmake_vector (make_number (2 * i), Qnil);
5220 bcopy (XVECTOR (menu_bar_items_vector)->contents,
5221 XVECTOR (tem)->contents, i * sizeof (Lisp_Object));
5222 menu_bar_items_vector = tem;
9f9c0e27 5223 }
b7c49376
RS
5224 /* Add this item. */
5225 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
5226 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
5227 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
35b3402f 5228 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
b7c49376 5229 menu_bar_items_index = i;
a73c5e29 5230
47d319aa 5231 Vinhibit_quit = oquit;
b7c49376
RS
5232 UNGCPRO;
5233 return menu_bar_items_vector;
5ec75a55
RS
5234}
5235\f
5236/* Scan one map KEYMAP, accumulating any menu items it defines
f5e09c8b 5237 in menu_bar_items_vector. */
5ec75a55 5238
b7c49376
RS
5239static void
5240menu_bar_one_keymap (keymap)
5241 Lisp_Object keymap;
5ec75a55
RS
5242{
5243 Lisp_Object tail, item, key, binding, item_string, table;
5244
5245 /* Loop over all keymap entries that have menu strings. */
8c18cbfb 5246 for (tail = keymap; CONSP (tail); tail = XCONS (tail)->cdr)
5ec75a55
RS
5247 {
5248 item = XCONS (tail)->car;
8c18cbfb 5249 if (CONSP (item))
5ec75a55
RS
5250 {
5251 key = XCONS (item)->car;
5252 binding = XCONS (item)->cdr;
8c18cbfb 5253 if (CONSP (binding))
5ec75a55
RS
5254 {
5255 item_string = XCONS (binding)->car;
8c18cbfb 5256 if (STRINGP (item_string))
b7c49376 5257 menu_bar_item (key, item_string, Fcdr (binding));
5ec75a55 5258 }
e58aa385 5259 else if (EQ (binding, Qundefined))
8aa034e1 5260 menu_bar_item (key, Qnil, binding);
5ec75a55 5261 }
8c18cbfb 5262 else if (VECTORP (item))
5ec75a55
RS
5263 {
5264 /* Loop over the char values represented in the vector. */
5265 int len = XVECTOR (item)->size;
5266 int c;
5267 for (c = 0; c < len; c++)
5268 {
5269 Lisp_Object character;
bb9e9bed 5270 XSETFASTINT (character, c);
5ec75a55 5271 binding = XVECTOR (item)->contents[c];
8c18cbfb 5272 if (CONSP (binding))
5ec75a55
RS
5273 {
5274 item_string = XCONS (binding)->car;
8c18cbfb 5275 if (STRINGP (item_string))
b7c49376 5276 menu_bar_item (key, item_string, Fcdr (binding));
5ec75a55 5277 }
e58aa385 5278 else if (EQ (binding, Qundefined))
8aa034e1 5279 menu_bar_item (key, Qnil, binding);
5ec75a55
RS
5280 }
5281 }
5282 }
5ec75a55
RS
5283}
5284
047a8ea7
RS
5285/* This is used as the handler when calling internal_condition_case_1. */
5286
5287static Lisp_Object
5288menu_bar_item_1 (arg)
5289 Lisp_Object arg;
5290{
5291 return Qnil;
5292}
5293
f5e09c8b
RS
5294/* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
5295 If there's already an item for KEY, add this DEF to it. */
5296
b7c49376
RS
5297static void
5298menu_bar_item (key, item_string, def)
5299 Lisp_Object key, item_string, def;
5ec75a55 5300{
e58aa385 5301 Lisp_Object tem;
5ec75a55 5302 Lisp_Object enabled;
b7c49376 5303 int i;
5ec75a55 5304
210df3bf
KH
5305 /* Skip menu-bar equiv keys data. */
5306 if (CONSP (def) && CONSP (XCONS (def)->car))
5307 def = XCONS (def)->cdr;
5308
e58aa385
RS
5309 if (EQ (def, Qundefined))
5310 {
f5e09c8b 5311 /* If a map has an explicit `undefined' as definition,
e58aa385 5312 discard any previously made menu bar item. */
b7c49376 5313
35b3402f 5314 for (i = 0; i < menu_bar_items_index; i += 4)
b7c49376
RS
5315 if (EQ (key, XVECTOR (menu_bar_items_vector)->contents[i]))
5316 {
35b3402f
RS
5317 if (menu_bar_items_index > i + 4)
5318 bcopy (&XVECTOR (menu_bar_items_vector)->contents[i + 4],
b7c49376 5319 &XVECTOR (menu_bar_items_vector)->contents[i],
35b3402f
RS
5320 (menu_bar_items_index - i - 4) * sizeof (Lisp_Object));
5321 menu_bar_items_index -= 4;
b7c49376
RS
5322 return;
5323 }
8aa034e1
RS
5324
5325 /* If there's no definition for this key yet,
5326 just ignore `undefined'. */
5327 return;
e58aa385
RS
5328 }
5329
5ec75a55
RS
5330 /* See if this entry is enabled. */
5331 enabled = Qt;
5332
8c18cbfb 5333 if (SYMBOLP (def))
5ec75a55
RS
5334 {
5335 /* No property, or nil, means enable.
5336 Otherwise, enable if value is not nil. */
5337 tem = Fget (def, Qmenu_enable);
5338 if (!NILP (tem))
047a8ea7
RS
5339 /* (condition-case nil (eval tem)
5340 (error nil)) */
5341 enabled = internal_condition_case_1 (Feval, tem, Qerror,
5342 menu_bar_item_1);
5ec75a55
RS
5343 }
5344
b7c49376
RS
5345 /* Ignore this item if it's not enabled. */
5346 if (NILP (enabled))
5347 return;
5ec75a55 5348
f5e09c8b 5349 /* Find any existing item for this KEY. */
35b3402f 5350 for (i = 0; i < menu_bar_items_index; i += 4)
b7c49376
RS
5351 if (EQ (key, XVECTOR (menu_bar_items_vector)->contents[i]))
5352 break;
5353
f5e09c8b 5354 /* If we did not find this KEY, add it at the end. */
b7c49376
RS
5355 if (i == menu_bar_items_index)
5356 {
5357 /* If vector is too small, get a bigger one. */
35b3402f 5358 if (i + 4 > XVECTOR (menu_bar_items_vector)->size)
b7c49376
RS
5359 {
5360 Lisp_Object tem;
5361 int newsize = 2 * i;
5362 tem = Fmake_vector (make_number (2 * i), Qnil);
5363 bcopy (XVECTOR (menu_bar_items_vector)->contents,
5364 XVECTOR (tem)->contents, i * sizeof (Lisp_Object));
5365 menu_bar_items_vector = tem;
5366 }
5367 /* Add this item. */
5368 XVECTOR (menu_bar_items_vector)->contents[i++] = key;
5369 XVECTOR (menu_bar_items_vector)->contents[i++] = item_string;
f5e09c8b 5370 XVECTOR (menu_bar_items_vector)->contents[i++] = Fcons (def, Qnil);
35b3402f 5371 XVECTOR (menu_bar_items_vector)->contents[i++] = make_number (0);
b7c49376
RS
5372 menu_bar_items_index = i;
5373 }
f5e09c8b
RS
5374 /* We did find an item for this KEY. Add DEF to its list of maps. */
5375 else
5376 {
5377 Lisp_Object old;
5378 old = XVECTOR (menu_bar_items_vector)->contents[i + 2];
5379 XVECTOR (menu_bar_items_vector)->contents[i + 2] = Fcons (def, old);
5380 }
5ec75a55
RS
5381}
5382\f
dcc408a0
RS
5383/* Read a character using menus based on maps in the array MAPS.
5384 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
5385 Return t if we displayed a menu but the user rejected it.
7d6de002
RS
5386
5387 PREV_EVENT is the previous input event, or nil if we are reading
5388 the first event of a key sequence.
5389
83d68044 5390 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
6569cc8d 5391 if we used a mouse menu to read the input, or zero otherwise. If
83d68044 5392 USED_MOUSE_MENU is null, we don't dereference it.
284f4730
JB
5393
5394 The prompting is done based on the prompt-string of the map
df0f2ba1 5395 and the strings associated with various map elements.
8150596a
RS
5396
5397 This can be done with X menus or with menus put in the minibuf.
5398 These are done in different ways, depending on how the input will be read.
5399 Menus using X are done after auto-saving in read-char, getting the input
5400 event from Fx_popup_menu; menus using the minibuf use read_char recursively
5401 and do auto-saving in the inner call of read_char. */
284f4730 5402
7617111f 5403static Lisp_Object
8150596a 5404read_char_x_menu_prompt (nmaps, maps, prev_event, used_mouse_menu)
7d6de002
RS
5405 int nmaps;
5406 Lisp_Object *maps;
5407 Lisp_Object prev_event;
5408 int *used_mouse_menu;
284f4730 5409{
7d6de002
RS
5410 int mapno;
5411 register Lisp_Object name;
7d6de002
RS
5412 Lisp_Object rest, vector;
5413
6569cc8d
JB
5414 if (used_mouse_menu)
5415 *used_mouse_menu = 0;
284f4730
JB
5416
5417 /* Use local over global Menu maps */
5418
7d6de002
RS
5419 if (! menu_prompting)
5420 return Qnil;
5421
03361bcc
RS
5422 /* Optionally disregard all but the global map. */
5423 if (inhibit_local_menu_bar_menus)
5424 {
5425 maps += (nmaps - 1);
5426 nmaps = 1;
5427 }
5428
7d6de002
RS
5429 /* Get the menu name from the first map that has one (a prompt string). */
5430 for (mapno = 0; mapno < nmaps; mapno++)
5431 {
5432 name = map_prompt (maps[mapno]);
5433 if (!NILP (name))
5434 break;
5435 }
284f4730 5436
7d6de002 5437 /* If we don't have any menus, just read a character normally. */
dbc4e1c1 5438 if (mapno >= nmaps)
7d6de002
RS
5439 return Qnil;
5440
1f5b1641 5441#ifdef HAVE_MENUS
7d6de002
RS
5442 /* If we got to this point via a mouse click,
5443 use a real menu for mouse selection. */
5a8d99e0
KH
5444 if (EVENT_HAS_PARAMETERS (prev_event)
5445 && !EQ (XCONS (prev_event)->car, Qmenu_bar))
7d6de002
RS
5446 {
5447 /* Display the menu and get the selection. */
5448 Lisp_Object *realmaps
5449 = (Lisp_Object *) alloca (nmaps * sizeof (Lisp_Object));
5450 Lisp_Object value;
5451 int nmaps1 = 0;
5452
5453 /* Use the maps that are not nil. */
5454 for (mapno = 0; mapno < nmaps; mapno++)
5455 if (!NILP (maps[mapno]))
5456 realmaps[nmaps1++] = maps[mapno];
5457
5458 value = Fx_popup_menu (prev_event, Flist (nmaps1, realmaps));
663258f2
JB
5459 if (CONSP (value))
5460 {
68f297c5
RS
5461 Lisp_Object tem;
5462
8eb4d8ef
RS
5463 record_menu_key (XCONS (value)->car);
5464
68f297c5
RS
5465 /* If we got multiple events, unread all but
5466 the first.
5467 There is no way to prevent those unread events
5468 from showing up later in last_nonmenu_event.
5469 So turn symbol and integer events into lists,
5470 to indicate that they came from a mouse menu,
5471 so that when present in last_nonmenu_event
5472 they won't confuse things. */
5473 for (tem = XCONS (value)->cdr; !NILP (tem);
5474 tem = XCONS (tem)->cdr)
8eb4d8ef
RS
5475 {
5476 record_menu_key (XCONS (tem)->car);
5477 if (SYMBOLP (XCONS (tem)->car)
5478 || INTEGERP (XCONS (tem)->car))
5479 XCONS (tem)->car
5480 = Fcons (XCONS (tem)->car, Qnil);
5481 }
68f297c5 5482
663258f2
JB
5483 /* If we got more than one event, put all but the first
5484 onto this list to be read later.
5485 Return just the first event now. */
24597608
RS
5486 Vunread_command_events
5487 = nconc2 (XCONS (value)->cdr, Vunread_command_events);
663258f2
JB
5488 value = XCONS (value)->car;
5489 }
1c90c381 5490 else if (NILP (value))
dcc408a0 5491 value = Qt;
6569cc8d
JB
5492 if (used_mouse_menu)
5493 *used_mouse_menu = 1;
7d6de002
RS
5494 return value;
5495 }
1f5b1641 5496#endif /* HAVE_MENUS */
8150596a
RS
5497 return Qnil ;
5498}
5499
68e0de82
RS
5500/* Buffer in use so far for the minibuf prompts for menu keymaps.
5501 We make this bigger when necessary, and never free it. */
5502static char *read_char_minibuf_menu_text;
5503/* Size of that buffer. */
5504static int read_char_minibuf_menu_width;
5505
8150596a 5506static Lisp_Object
24597608 5507read_char_minibuf_menu_prompt (commandflag, nmaps, maps)
8150596a
RS
5508 int commandflag ;
5509 int nmaps;
5510 Lisp_Object *maps;
5511{
5512 int mapno;
5513 register Lisp_Object name;
5514 int nlength;
5515 int width = FRAME_WIDTH (selected_frame) - 4;
8150596a 5516 int idx = -1;
9fdbfdf8 5517 int nobindings = 1;
8150596a 5518 Lisp_Object rest, vector;
68e0de82 5519 char *menu;
8150596a
RS
5520
5521 if (! menu_prompting)
5522 return Qnil;
5523
68e0de82
RS
5524 /* Make sure we have a big enough buffer for the menu text. */
5525 if (read_char_minibuf_menu_text == 0)
5526 {
5527 read_char_minibuf_menu_width = width + 4;
5528 read_char_minibuf_menu_text = (char *) xmalloc (width + 4);
5529 }
5530 else if (width + 4 > read_char_minibuf_menu_width)
5531 {
5532 read_char_minibuf_menu_width = width + 4;
5533 read_char_minibuf_menu_text
5534 = (char *) xrealloc (read_char_minibuf_menu_text, width + 4);
5535 }
5536 menu = read_char_minibuf_menu_text;
5537
8150596a
RS
5538 /* Get the menu name from the first map that has one (a prompt string). */
5539 for (mapno = 0; mapno < nmaps; mapno++)
5540 {
5541 name = map_prompt (maps[mapno]);
5542 if (!NILP (name))
5543 break;
5544 }
5545
5546 /* If we don't have any menus, just read a character normally. */
5547 if (mapno >= nmaps)
5548 return Qnil;
284f4730
JB
5549
5550 /* Prompt string always starts with map's prompt, and a space. */
5551 strcpy (menu, XSTRING (name)->data);
5552 nlength = XSTRING (name)->size;
7d6de002 5553 menu[nlength++] = ':';
284f4730
JB
5554 menu[nlength++] = ' ';
5555 menu[nlength] = 0;
5556
7d6de002
RS
5557 /* Start prompting at start of first map. */
5558 mapno = 0;
5559 rest = maps[mapno];
284f4730
JB
5560
5561 /* Present the documented bindings, a line at a time. */
5562 while (1)
5563 {
5564 int notfirst = 0;
5565 int i = nlength;
5566 Lisp_Object obj;
5567 int ch;
8066f1a1 5568 Lisp_Object orig_defn_macro;
284f4730 5569
284f4730 5570 /* Loop over elements of map. */
7d6de002 5571 while (i < width)
284f4730 5572 {
7d6de002 5573 Lisp_Object s, elt;
284f4730 5574
7d6de002
RS
5575 /* If reached end of map, start at beginning of next map. */
5576 if (NILP (rest))
5577 {
5578 mapno++;
5579 /* At end of last map, wrap around to first map if just starting,
5580 or end this line if already have something on it. */
5581 if (mapno == nmaps)
284f4730 5582 {
8150596a 5583 mapno = 0;
40932d1a 5584 if (notfirst || nobindings) break;
284f4730 5585 }
7d6de002 5586 rest = maps[mapno];
284f4730 5587 }
7d6de002
RS
5588
5589 /* Look at the next element of the map. */
5590 if (idx >= 0)
5591 elt = XVECTOR (vector)->contents[idx];
284f4730 5592 else
7d6de002
RS
5593 elt = Fcar_safe (rest);
5594
8c18cbfb 5595 if (idx < 0 && VECTORP (elt))
284f4730 5596 {
7d6de002
RS
5597 /* If we found a dense table in the keymap,
5598 advanced past it, but start scanning its contents. */
5599 rest = Fcdr_safe (rest);
5600 vector = elt;
5601 idx = 0;
284f4730 5602 }
7d6de002
RS
5603 else
5604 {
5605 /* An ordinary element. */
0a2ea221
KH
5606 Lisp_Object event;
5607
5608 if (idx < 0)
5609 {
5610 s = Fcar_safe (Fcdr_safe (elt)); /* alist */
5611 event = Fcar_safe (elt);
5612 }
8150596a 5613 else
7d6de002 5614 {
0a2ea221
KH
5615 s = Fcar_safe (elt); /* vector */
5616 XSETINT (event, idx);
5617 }
5618
5619 /* Ignore the element if it has no prompt string. */
5620 if (STRINGP (s) && INTEGERP (event))
5621 {
5622 /* 1 if the char to type matches the string. */
5623 int char_matches;
5624 Lisp_Object upcased_event, downcased_event;
5625 Lisp_Object desc;
5626
5627 upcased_event = Fupcase (event);
5628 downcased_event = Fdowncase (event);
5629 char_matches = (XINT (upcased_event) == XSTRING (s)->data[0]
5630 || XINT (downcased_event) == XSTRING (s)->data[0]);
5631 if (! char_matches)
5632 desc = Fsingle_key_description (event);
5633
5634 /* If we have room for the prompt string, add it to this line.
5635 If this is the first on the line, always add it. */
5636 if ((XSTRING (s)->size + i + 2
5637 + (char_matches ? 0 : XSTRING (desc)->size + 3))
5638 < width
5639 || !notfirst)
5640 {
5641 int thiswidth;
5642
5643 /* Punctuate between strings. */
5644 if (notfirst)
5645 {
5646 strcpy (menu + i, ", ");
5647 i += 2;
5648 }
5649 notfirst = 1;
5650 nobindings = 0 ;
284f4730 5651
0a2ea221
KH
5652 /* If the char to type doesn't match the string's
5653 first char, explicitly show what char to type. */
5654 if (! char_matches)
5655 {
5656 /* Add as much of string as fits. */
5657 thiswidth = XSTRING (desc)->size;
5658 if (thiswidth + i > width)
5659 thiswidth = width - i;
5660 bcopy (XSTRING (desc)->data, menu + i, thiswidth);
5661 i += thiswidth;
5662 strcpy (menu + i, " = ");
5663 i += 3;
5664 }
5665
5666 /* Add as much of string as fits. */
5667 thiswidth = XSTRING (s)->size;
5668 if (thiswidth + i > width)
5669 thiswidth = width - i;
5670 bcopy (XSTRING (s)->data, menu + i, thiswidth);
5671 i += thiswidth;
5672 menu[i] = 0;
5673 }
5674 else
7d6de002 5675 {
0a2ea221
KH
5676 /* If this element does not fit, end the line now,
5677 and save the element for the next line. */
5678 strcpy (menu + i, "...");
5679 break;
7d6de002 5680 }
7d6de002
RS
5681 }
5682
5683 /* Move past this element. */
8150596a 5684 if (idx >= 0 && idx + 1 >= XVECTOR (vector)->size)
7d6de002
RS
5685 /* Handle reaching end of dense table. */
5686 idx = -1;
5687 if (idx >= 0)
5688 idx++;
5689 else
5690 rest = Fcdr_safe (rest);
5691 }
284f4730
JB
5692 }
5693
5694 /* Prompt with that and read response. */
5695 message1 (menu);
8150596a 5696
df0f2ba1 5697 /* Make believe its not a keyboard macro in case the help char
8150596a
RS
5698 is pressed. Help characters are not recorded because menu prompting
5699 is not used on replay.
5700 */
c5fdd383
KH
5701 orig_defn_macro = current_kboard->defining_kbd_macro;
5702 current_kboard->defining_kbd_macro = Qnil;
3cb81011
KH
5703 do
5704 obj = read_char (commandflag, 0, 0, Qnil, 0);
8c18cbfb 5705 while (BUFFERP (obj));
c5fdd383 5706 current_kboard->defining_kbd_macro = orig_defn_macro;
284f4730 5707
8c18cbfb 5708 if (!INTEGERP (obj))
284f4730
JB
5709 return obj;
5710 else
5711 ch = XINT (obj);
5712
f4255cd1 5713 if (! EQ (obj, menu_prompt_more_char)
8c18cbfb 5714 && (!INTEGERP (menu_prompt_more_char)
f4255cd1 5715 || ! EQ (obj, make_number (Ctl (XINT (menu_prompt_more_char))))))
8150596a 5716 {
c5fdd383 5717 if (!NILP (current_kboard->defining_kbd_macro))
8066f1a1 5718 store_kbd_macro_char (obj);
8150596a
RS
5719 return obj;
5720 }
5721 /* Help char - go round again */
284f4730
JB
5722 }
5723}
284f4730
JB
5724\f
5725/* Reading key sequences. */
5726
5727/* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
5728 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
5729 keymap, or nil otherwise. Return the index of the first keymap in
5730 which KEY has any binding, or NMAPS if no map has a binding.
5731
5732 If KEY is a meta ASCII character, treat it like meta-prefix-char
5733 followed by the corresponding non-meta character. Keymaps in
5734 CURRENT with non-prefix bindings for meta-prefix-char become nil in
5735 NEXT.
5736
88cb0656
JB
5737 If KEY has no bindings in any of the CURRENT maps, NEXT is left
5738 unmodified.
5739
569871d2 5740 NEXT may be the same array as CURRENT. */
284f4730
JB
5741
5742static int
4e50f26a 5743follow_key (key, nmaps, current, defs, next)
284f4730
JB
5744 Lisp_Object key;
5745 Lisp_Object *current, *defs, *next;
5746 int nmaps;
5747{
5748 int i, first_binding;
569871d2 5749 int did_meta = 0;
284f4730
JB
5750
5751 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
569871d2
RS
5752 followed by the corresponding non-meta character.
5753 Put the results into DEFS, since we are going to alter that anyway.
5754 Do not alter CURRENT or NEXT. */
8c18cbfb 5755 if (INTEGERP (key) && (XINT (key) & CHAR_META))
284f4730
JB
5756 {
5757 for (i = 0; i < nmaps; i++)
5758 if (! NILP (current[i]))
5759 {
569871d2
RS
5760 Lisp_Object def;
5761 def = get_keyelt (access_keymap (current[i],
5762 meta_prefix_char, 1, 0));
284f4730
JB
5763
5764 /* Note that since we pass the resulting bindings through
5765 get_keymap_1, non-prefix bindings for meta-prefix-char
5766 disappear. */
569871d2 5767 defs[i] = get_keymap_1 (def, 0, 1);
284f4730
JB
5768 }
5769 else
569871d2 5770 defs[i] = Qnil;
284f4730 5771
569871d2 5772 did_meta = 1;
18cd2eeb 5773 XSETINT (key, XFASTINT (key) & ~CHAR_META);
284f4730
JB
5774 }
5775
5776 first_binding = nmaps;
5777 for (i = nmaps - 1; i >= 0; i--)
5778 {
5779 if (! NILP (current[i]))
5780 {
569871d2
RS
5781 Lisp_Object map;
5782 if (did_meta)
5783 map = defs[i];
5784 else
5785 map = current[i];
5786
5787 defs[i] = get_keyelt (access_keymap (map, key, 1, 0));
284f4730
JB
5788 if (! NILP (defs[i]))
5789 first_binding = i;
5790 }
5791 else
5792 defs[i] = Qnil;
5793 }
5794
284f4730 5795 /* Given the set of bindings we've found, produce the next set of maps. */
0a7f1fc0
JB
5796 if (first_binding < nmaps)
5797 for (i = 0; i < nmaps; i++)
f4255cd1 5798 next[i] = NILP (defs[i]) ? Qnil : get_keymap_1 (defs[i], 0, 1);
284f4730
JB
5799
5800 return first_binding;
5801}
5802
df0f2ba1 5803/* Read a sequence of keys that ends with a non prefix character,
f4255cd1
JB
5804 storing it in KEYBUF, a buffer of size BUFSIZE.
5805 Prompt with PROMPT.
284f4730 5806 Return the length of the key sequence stored.
dcc408a0 5807 Return -1 if the user rejected a command menu.
284f4730 5808
f4255cd1
JB
5809 Echo starting immediately unless `prompt' is 0.
5810
5811 Where a key sequence ends depends on the currently active keymaps.
5812 These include any minor mode keymaps active in the current buffer,
5813 the current buffer's local map, and the global map.
5814
5815 If a key sequence has no other bindings, we check Vfunction_key_map
5816 to see if some trailing subsequence might be the beginning of a
5817 function key's sequence. If so, we try to read the whole function
5818 key, and substitute its symbolic name into the key sequence.
5819
fbcd35bd
JB
5820 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
5821 `double-' events into similar click events, if that would make them
5822 bound. We try to turn `triple-' events first into `double-' events,
5823 then into clicks.
f4255cd1
JB
5824
5825 If we get a mouse click in a mode line, vertical divider, or other
5826 non-text area, we treat the click as if it were prefixed by the
5827 symbol denoting that area - `mode-line', `vertical-line', or
5828 whatever.
5829
5830 If the sequence starts with a mouse click, we read the key sequence
5831 with respect to the buffer clicked on, not the current buffer.
284f4730 5832
f4255cd1
JB
5833 If the user switches frames in the midst of a key sequence, we put
5834 off the switch-frame event until later; the next call to
f571ae0d
RS
5835 read_char will return it.
5836
5837 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
5838 from the selected window's buffer. */
48e416d4 5839
284f4730 5840static int
ce98e608 5841read_key_sequence (keybuf, bufsize, prompt, dont_downcase_last,
f571ae0d 5842 can_return_switch_frame, fix_current_buffer)
284f4730
JB
5843 Lisp_Object *keybuf;
5844 int bufsize;
84d91fda 5845 Lisp_Object prompt;
309b0fc8 5846 int dont_downcase_last;
ce98e608 5847 int can_return_switch_frame;
f571ae0d 5848 int fix_current_buffer;
284f4730 5849{
f4255cd1
JB
5850 int count = specpdl_ptr - specpdl;
5851
284f4730
JB
5852 /* How many keys there are in the current key sequence. */
5853 int t;
5854
284f4730
JB
5855 /* The length of the echo buffer when we started reading, and
5856 the length of this_command_keys when we started reading. */
5857 int echo_start;
f4255cd1 5858 int keys_start;
284f4730
JB
5859
5860 /* The number of keymaps we're scanning right now, and the number of
5861 keymaps we have allocated space for. */
5862 int nmaps;
5863 int nmaps_allocated = 0;
5864
284f4730
JB
5865 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
5866 the current keymaps. */
5867 Lisp_Object *defs;
5868
f4255cd1
JB
5869 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5870 in the current keymaps, or nil where it is not a prefix. */
5871 Lisp_Object *submaps;
5872
e0dff5f6
RS
5873 /* The local map to start out with at start of key sequence. */
5874 Lisp_Object orig_local_map;
5875
5876 /* 1 if we have already considered switching to the local-map property
5877 of the place where a mouse click occurred. */
5878 int localized_local_map = 0;
5879
f4255cd1
JB
5880 /* The index in defs[] of the first keymap that has a binding for
5881 this key sequence. In other words, the lowest i such that
5882 defs[i] is non-nil. */
284f4730
JB
5883 int first_binding;
5884
f4255cd1 5885 /* If t < mock_input, then KEYBUF[t] should be read as the next
253598e4
JB
5886 input key.
5887
5888 We use this to recover after recognizing a function key. Once we
5889 realize that a suffix of the current key sequence is actually a
5890 function key's escape sequence, we replace the suffix with the
5891 function key's binding from Vfunction_key_map. Now keybuf
f4255cd1
JB
5892 contains a new and different key sequence, so the echo area,
5893 this_command_keys, and the submaps and defs arrays are wrong. In
5894 this situation, we set mock_input to t, set t to 0, and jump to
5895 restart_sequence; the loop will read keys from keybuf up until
5896 mock_input, thus rebuilding the state; and then it will resume
5897 reading characters from the keyboard. */
284f4730
JB
5898 int mock_input = 0;
5899
253598e4 5900 /* If the sequence is unbound in submaps[], then
f4255cd1
JB
5901 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
5902 and fkey_map is its binding.
253598e4 5903
f4255cd1
JB
5904 These might be > t, indicating that all function key scanning
5905 should hold off until t reaches them. We do this when we've just
5906 recognized a function key, to avoid searching for the function
5907 key's again in Vfunction_key_map. */
284f4730 5908 int fkey_start = 0, fkey_end = 0;
4efda7dd 5909 Lisp_Object fkey_map;
284f4730 5910
a612e298
RS
5911 /* Likewise, for key_translation_map. */
5912 int keytran_start = 0, keytran_end = 0;
5913 Lisp_Object keytran_map;
5914
cd21b839
JB
5915 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
5916 we put it off for later. While we're reading, we keep the event here. */
4efda7dd 5917 Lisp_Object delayed_switch_frame;
cd21b839 5918
51763820
BF
5919 /* See the comment below... */
5920#if defined (GOBBLE_FIRST_EVENT)
4efda7dd 5921 Lisp_Object first_event;
51763820 5922#endif
4efda7dd 5923
309b0fc8
RS
5924 Lisp_Object original_uppercase;
5925 int original_uppercase_position = -1;
5926
bc536d84 5927 /* Gets around Microsoft compiler limitations. */
309b0fc8 5928 int dummyflag = 0;
bc536d84 5929
3b9189f8
RS
5930 struct buffer *starting_buffer;
5931
e9bf89a0
RS
5932 /* Nonzero if we seem to have got the beginning of a binding
5933 in function_key_map. */
5934 int function_key_possible = 0;
00a78037 5935 int key_translation_possible = 0;
e9bf89a0 5936
3fe8e9a2
RS
5937 /* Save the status of key translation before each step,
5938 so that we can restore this after downcasing. */
5939 Lisp_Object prev_fkey_map;
3fdfceb3
RS
5940 int prev_fkey_start;
5941 int prev_fkey_end;
3fe8e9a2
RS
5942
5943 Lisp_Object prev_keytran_map;
3fdfceb3
RS
5944 int prev_keytran_start;
5945 int prev_keytran_end;
3fe8e9a2 5946
4efda7dd
RS
5947 int junk;
5948
5949 last_nonmenu_event = Qnil;
5950
5951 delayed_switch_frame = Qnil;
5952 fkey_map = Vfunction_key_map;
a612e298 5953 keytran_map = Vkey_translation_map;
f4255cd1 5954
a612e298 5955 /* If there is no function-key-map, turn off function key scanning. */
f4255cd1
JB
5956 if (NILP (Fkeymapp (Vfunction_key_map)))
5957 fkey_start = fkey_end = bufsize + 1;
5958
a612e298
RS
5959 /* If there is no key-translation-map, turn off scanning. */
5960 if (NILP (Fkeymapp (Vkey_translation_map)))
5961 keytran_start = keytran_end = bufsize + 1;
5962
284f4730
JB
5963 if (INTERACTIVE)
5964 {
84d91fda
RS
5965 if (!NILP (prompt))
5966 echo_prompt (XSTRING (prompt)->data);
a98ea3f9 5967 else if (cursor_in_echo_area && echo_keystrokes)
284f4730
JB
5968 /* This doesn't put in a dash if the echo buffer is empty, so
5969 you don't always see a dash hanging out in the minibuffer. */
5970 echo_dash ();
284f4730
JB
5971 }
5972
f4255cd1
JB
5973 /* Record the initial state of the echo area and this_command_keys;
5974 we will need to restore them if we replay a key sequence. */
0a7f1fc0 5975 if (INTERACTIVE)
df0f2ba1 5976 echo_start = echo_length ();
f4255cd1 5977 keys_start = this_command_key_count;
6321824f 5978 this_single_command_key_start = keys_start;
0a7f1fc0 5979
51763820
BF
5980#if defined (GOBBLE_FIRST_EVENT)
5981 /* This doesn't quite work, because some of the things that read_char
5982 does cannot safely be bypassed. It seems too risky to try to make
df0f2ba1 5983 this work right. */
51763820 5984
4efda7dd
RS
5985 /* Read the first char of the sequence specially, before setting
5986 up any keymaps, in case a filter runs and switches buffers on us. */
84d91fda 5987 first_event = read_char (NILP (prompt), 0, submaps, last_nonmenu_event,
4efda7dd 5988 &junk);
51763820 5989#endif /* GOBBLE_FIRST_EVENT */
4efda7dd 5990
e0dff5f6
RS
5991 orig_local_map = get_local_map (PT, current_buffer);
5992
7b4aedb9
JB
5993 /* We jump here when the key sequence has been thoroughly changed, and
5994 we need to rescan it starting from the beginning. When we jump here,
5995 keybuf[0..mock_input] holds the sequence we should reread. */
07d2b8de 5996 replay_sequence:
7b4aedb9 5997
3b9189f8 5998 starting_buffer = current_buffer;
e9bf89a0 5999 function_key_possible = 0;
00a78037 6000 key_translation_possible = 0;
3b9189f8 6001
f4255cd1 6002 /* Build our list of keymaps.
07d2b8de
JB
6003 If we recognize a function key and replace its escape sequence in
6004 keybuf with its symbol, or if the sequence starts with a mouse
6005 click and we need to switch buffers, we jump back here to rebuild
6006 the initial keymaps from the current buffer. */
df0f2ba1 6007 {
284f4730
JB
6008 Lisp_Object *maps;
6009
217258d5
KH
6010 if (!NILP (current_kboard->Voverriding_terminal_local_map)
6011 || !NILP (Voverriding_local_map))
284f4730 6012 {
217258d5 6013 if (3 > nmaps_allocated)
9dd3131c 6014 {
217258d5
KH
6015 submaps = (Lisp_Object *) alloca (3 * sizeof (submaps[0]));
6016 defs = (Lisp_Object *) alloca (3 * sizeof (defs[0]));
6017 nmaps_allocated = 3;
9dd3131c 6018 }
217258d5
KH
6019 nmaps = 0;
6020 if (!NILP (current_kboard->Voverriding_terminal_local_map))
6021 submaps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
6022 if (!NILP (Voverriding_local_map))
6023 submaps[nmaps++] = Voverriding_local_map;
284f4730 6024 }
9dd3131c
RS
6025 else
6026 {
217258d5
KH
6027 nmaps = current_minor_maps (0, &maps);
6028 if (nmaps + 2 > nmaps_allocated)
9dd3131c 6029 {
217258d5
KH
6030 submaps = (Lisp_Object *) alloca ((nmaps+2) * sizeof (submaps[0]));
6031 defs = (Lisp_Object *) alloca ((nmaps+2) * sizeof (defs[0]));
6032 nmaps_allocated = nmaps + 2;
9dd3131c 6033 }
217258d5 6034 bcopy (maps, submaps, nmaps * sizeof (submaps[0]));
497ba7a1 6035#ifdef USE_TEXT_PROPERTIES
217258d5 6036 submaps[nmaps++] = orig_local_map;
497ba7a1 6037#else
217258d5 6038 submaps[nmaps++] = current_buffer->keymap;
497ba7a1 6039#endif
9dd3131c 6040 }
217258d5 6041 submaps[nmaps++] = current_global_map;
284f4730
JB
6042 }
6043
6044 /* Find an accurate initial value for first_binding. */
6045 for (first_binding = 0; first_binding < nmaps; first_binding++)
253598e4 6046 if (! NILP (submaps[first_binding]))
284f4730
JB
6047 break;
6048
3b9189f8 6049 /* Start from the beginning in keybuf. */
f4255cd1
JB
6050 t = 0;
6051
6052 /* These are no-ops the first time through, but if we restart, they
6053 revert the echo area and this_command_keys to their original state. */
6054 this_command_key_count = keys_start;
df0f2ba1 6055 if (INTERACTIVE && t < mock_input)
f4255cd1
JB
6056 echo_truncate (echo_start);
6057
cca310da
JB
6058 /* If the best binding for the current key sequence is a keymap, or
6059 we may be looking at a function key's escape sequence, keep on
6060 reading. */
253598e4 6061 while ((first_binding < nmaps && ! NILP (submaps[first_binding]))
cca310da
JB
6062 || (first_binding >= nmaps
6063 && fkey_start < t
6064 /* mock input is never part of a function key's sequence. */
a612e298 6065 && mock_input <= fkey_start)
0d882d52
KH
6066 || (first_binding >= nmaps
6067 && keytran_start < t && key_translation_possible)
e9bf89a0
RS
6068 /* Don't return in the middle of a possible function key sequence,
6069 if the only bindings we found were via case conversion.
6070 Thus, if ESC O a has a function-key-map translation
6071 and ESC o has a binding, don't return after ESC O,
6072 so that we can translate ESC O plus the next character. */
4e50f26a 6073 )
284f4730
JB
6074 {
6075 Lisp_Object key;
7d6de002 6076 int used_mouse_menu = 0;
284f4730 6077
7b4aedb9
JB
6078 /* Where the last real key started. If we need to throw away a
6079 key that has expanded into more than one element of keybuf
6080 (say, a mouse click on the mode line which is being treated
6081 as [mode-line (mouse-...)], then we backtrack to this point
6082 of keybuf. */
6083 int last_real_key_start;
6084
0a7f1fc0
JB
6085 /* These variables are analogous to echo_start and keys_start;
6086 while those allow us to restart the entire key sequence,
6087 echo_local_start and keys_local_start allow us to throw away
6088 just one key. */
f4255cd1
JB
6089 int echo_local_start, keys_local_start, local_first_binding;
6090
284f4730 6091 if (t >= bufsize)
3fe8e9a2 6092 error ("Key sequence too long");
284f4730 6093
f4255cd1
JB
6094 if (INTERACTIVE)
6095 echo_local_start = echo_length ();
6096 keys_local_start = this_command_key_count;
6097 local_first_binding = first_binding;
df0f2ba1 6098
f4255cd1 6099 replay_key:
0a7f1fc0 6100 /* These are no-ops, unless we throw away a keystroke below and
f4255cd1
JB
6101 jumped back up to replay_key; in that case, these restore the
6102 variables to their original state, allowing us to replay the
0a7f1fc0 6103 loop. */
40932d1a 6104 if (INTERACTIVE && t < mock_input)
f4255cd1 6105 echo_truncate (echo_local_start);
0a7f1fc0
JB
6106 this_command_key_count = keys_local_start;
6107 first_binding = local_first_binding;
6108
7e85b935
RS
6109 /* By default, assume each event is "real". */
6110 last_real_key_start = t;
6111
f4255cd1 6112 /* Does mock_input indicate that we are re-reading a key sequence? */
284f4730
JB
6113 if (t < mock_input)
6114 {
6115 key = keybuf[t];
6116 add_command_key (key);
a98ea3f9
RS
6117 if (echo_keystrokes)
6118 echo_char (key);
284f4730 6119 }
253598e4
JB
6120
6121 /* If not, we should actually read a character. */
284f4730
JB
6122 else
6123 {
a6d53864
RS
6124 struct buffer *buf = current_buffer;
6125
beecf6a1 6126 {
c5fdd383
KH
6127#ifdef MULTI_KBOARD
6128 KBOARD *interrupted_kboard = current_kboard;
df0f2ba1 6129 struct frame *interrupted_frame = selected_frame;
c5fdd383 6130 if (setjmp (wrong_kboard_jmpbuf))
beecf6a1 6131 {
5798cf15
KH
6132 if (!NILP (delayed_switch_frame))
6133 {
c5fdd383 6134 interrupted_kboard->kbd_queue
5798cf15 6135 = Fcons (delayed_switch_frame,
c5fdd383 6136 interrupted_kboard->kbd_queue);
5798cf15
KH
6137 delayed_switch_frame = Qnil;
6138 }
beecf6a1 6139 while (t > 0)
c5fdd383
KH
6140 interrupted_kboard->kbd_queue
6141 = Fcons (keybuf[--t], interrupted_kboard->kbd_queue);
5798cf15
KH
6142
6143 /* If the side queue is non-empty, ensure it begins with a
6144 switch-frame, so we'll replay it in the right context. */
c5fdd383
KH
6145 if (CONSP (interrupted_kboard->kbd_queue)
6146 && (key = XCONS (interrupted_kboard->kbd_queue)->car,
5798cf15
KH
6147 !(EVENT_HAS_PARAMETERS (key)
6148 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key)),
6149 Qswitch_frame))))
df0f2ba1
KH
6150 {
6151 Lisp_Object frame;
6152 XSETFRAME (frame, interrupted_frame);
c5fdd383 6153 interrupted_kboard->kbd_queue
df0f2ba1 6154 = Fcons (make_lispy_switch_frame (frame),
c5fdd383 6155 interrupted_kboard->kbd_queue);
df0f2ba1 6156 }
beecf6a1 6157 mock_input = 0;
a6e0153c 6158 orig_local_map = get_local_map (PT, current_buffer);
beecf6a1
KH
6159 goto replay_sequence;
6160 }
bded54dd 6161#endif
beecf6a1
KH
6162 key = read_char (NILP (prompt), nmaps, submaps, last_nonmenu_event,
6163 &used_mouse_menu);
6164 }
284f4730 6165
dcc408a0
RS
6166 /* read_char returns t when it shows a menu and the user rejects it.
6167 Just return -1. */
6168 if (EQ (key, Qt))
6169 return -1;
6170
f4255cd1 6171 /* read_char returns -1 at the end of a macro.
284f4730
JB
6172 Emacs 18 handles this by returning immediately with a
6173 zero, so that's what we'll do. */
8c18cbfb 6174 if (INTEGERP (key) && XINT (key) == -1)
cd21b839 6175 {
f4255cd1 6176 t = 0;
bc536d84
RS
6177 /* The Microsoft C compiler can't handle the goto that
6178 would go here. */
309b0fc8 6179 dummyflag = 1;
bc536d84 6180 break;
cd21b839 6181 }
df0f2ba1 6182
3cb81011
KH
6183 /* If the current buffer has been changed from under us, the
6184 keymap may have changed, so replay the sequence. */
8c18cbfb 6185 if (BUFFERP (key))
3cb81011
KH
6186 {
6187 mock_input = t;
f571ae0d
RS
6188 /* Reset the current buffer from the selected window
6189 in case something changed the former and not the latter.
6190 This is to be more consistent with the behavior
6191 of the command_loop_1. */
6192 if (fix_current_buffer)
6193 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
6194 Fset_buffer (XWINDOW (selected_window)->buffer);
6195
a6e0153c 6196 orig_local_map = get_local_map (PT, current_buffer);
3cb81011
KH
6197 goto replay_sequence;
6198 }
6199
3b9189f8
RS
6200 /* If we have a quit that was typed in another frame, and
6201 quit_throw_to_read_char switched buffers,
6202 replay to get the right keymap. */
9343ab07 6203 if (XINT (key) == quit_char && current_buffer != starting_buffer)
3b9189f8
RS
6204 {
6205 keybuf[t++] = key;
6206 mock_input = t;
6207 Vquit_flag = Qnil;
a6e0153c 6208 orig_local_map = get_local_map (PT, current_buffer);
3b9189f8
RS
6209 goto replay_sequence;
6210 }
3cb81011 6211
284f4730 6212 Vquit_flag = Qnil;
7e85b935 6213 }
284f4730 6214
df0f2ba1 6215 /* Clicks in non-text areas get prefixed by the symbol
7e85b935
RS
6216 in their CHAR-ADDRESS field. For example, a click on
6217 the mode line is prefixed by the symbol `mode-line'.
6218
6219 Furthermore, key sequences beginning with mouse clicks
6220 are read using the keymaps of the buffer clicked on, not
6221 the current buffer. So we may have to switch the buffer
6222 here.
6223
6224 When we turn one event into two events, we must make sure
6225 that neither of the two looks like the original--so that,
6226 if we replay the events, they won't be expanded again.
6227 If not for this, such reexpansion could happen either here
6228 or when user programs play with this-command-keys. */
6229 if (EVENT_HAS_PARAMETERS (key))
6230 {
9b8eb840 6231 Lisp_Object kind;
cca310da 6232
9b8eb840 6233 kind = EVENT_HEAD_KIND (EVENT_HEAD (key));
7e85b935 6234 if (EQ (kind, Qmouse_click))
0a7f1fc0 6235 {
9b8eb840 6236 Lisp_Object window, posn;
f4255cd1 6237
9b8eb840
KH
6238 window = POSN_WINDOW (EVENT_START (key));
6239 posn = POSN_BUFFER_POSN (EVENT_START (key));
8c18cbfb 6240 if (CONSP (posn))
0a7f1fc0 6241 {
7e85b935
RS
6242 /* We're looking at the second event of a
6243 sequence which we expanded before. Set
6244 last_real_key_start appropriately. */
6245 if (t > 0)
6246 last_real_key_start = t - 1;
cd21b839 6247 }
7e85b935
RS
6248
6249 /* Key sequences beginning with mouse clicks are
6250 read using the keymaps in the buffer clicked on,
6251 not the current buffer. If we're at the
6252 beginning of a key sequence, switch buffers. */
6253 if (last_real_key_start == 0
8c18cbfb
KH
6254 && WINDOWP (window)
6255 && BUFFERP (XWINDOW (window)->buffer)
7e85b935 6256 && XBUFFER (XWINDOW (window)->buffer) != current_buffer)
cd21b839 6257 {
7e85b935
RS
6258 keybuf[t] = key;
6259 mock_input = t + 1;
6260
6261 /* Arrange to go back to the original buffer once we're
6262 done reading the key sequence. Note that we can't
6263 use save_excursion_{save,restore} here, because they
6264 save point as well as the current buffer; we don't
6265 want to save point, because redisplay may change it,
6266 to accommodate a Fset_window_start or something. We
6267 don't want to do this at the top of the function,
6268 because we may get input from a subprocess which
6269 wants to change the selected window and stuff (say,
6270 emacsclient). */
6271 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
6272
6273 set_buffer_internal (XBUFFER (XWINDOW (window)->buffer));
e0dff5f6 6274 orig_local_map = get_local_map (PT, current_buffer);
7e85b935 6275 goto replay_sequence;
0a7f1fc0 6276 }
e0dff5f6
RS
6277 /* For a mouse click, get the local text-property keymap
6278 of the place clicked on, rather than point. */
6279 if (last_real_key_start == 0 && CONSP (XCONS (key)->cdr)
6280 && ! localized_local_map)
5ec75a55 6281 {
e0dff5f6
RS
6282 Lisp_Object map_here, start, pos;
6283
6284 localized_local_map = 1;
6285 start = EVENT_START (key);
6286 if (CONSP (start) && CONSP (XCONS (start)->cdr))
6287 {
6288 pos = POSN_BUFFER_POSN (start);
b78ce8fb
RS
6289 if (INTEGERP (pos)
6290 && XINT (pos) >= BEG && XINT (pos) <= Z)
e0dff5f6
RS
6291 {
6292 map_here = get_local_map (XINT (pos), current_buffer);
6293 if (!EQ (map_here, orig_local_map))
6294 {
6295 orig_local_map = map_here;
6296 keybuf[t] = key;
6297 mock_input = t + 1;
5ec75a55 6298
e0dff5f6
RS
6299 goto replay_sequence;
6300 }
6301 }
6302 }
6303 }
6304
6305 /* Expand mode-line and scroll-bar events into two events:
6306 use posn as a fake prefix key. */
6307 if (SYMBOLP (posn))
6308 {
7e85b935 6309 if (t + 1 >= bufsize)
3fe8e9a2 6310 error ("Key sequence too long");
7e85b935
RS
6311 keybuf[t] = posn;
6312 keybuf[t+1] = key;
6313 mock_input = t + 2;
6314
6315 /* Zap the position in key, so we know that we've
6316 expanded it, and don't try to do so again. */
6317 POSN_BUFFER_POSN (EVENT_START (key))
6318 = Fcons (posn, Qnil);
6319 goto replay_key;
5ec75a55 6320 }
0a7f1fc0 6321 }
7e85b935 6322 else if (EQ (kind, Qswitch_frame))
a6d53864 6323 {
ce98e608
KH
6324 /* If we're at the beginning of a key sequence, and the caller
6325 says it's okay, go ahead and return this event. If we're
6326 in the midst of a key sequence, delay it until the end. */
6327 if (t > 0 || !can_return_switch_frame)
7e85b935
RS
6328 {
6329 delayed_switch_frame = key;
6330 goto replay_key;
6331 }
6332 }
7a80a6f6
RS
6333 else if (CONSP (XCONS (key)->cdr)
6334 && CONSP (EVENT_START (key))
6335 && CONSP (XCONS (EVENT_START (key))->cdr))
7e85b935 6336 {
9b8eb840 6337 Lisp_Object posn;
7e85b935 6338
9b8eb840 6339 posn = POSN_BUFFER_POSN (EVENT_START (key));
7e85b935
RS
6340 /* Handle menu-bar events:
6341 insert the dummy prefix event `menu-bar'. */
6342 if (EQ (posn, Qmenu_bar))
6343 {
6344 if (t + 1 >= bufsize)
3fe8e9a2 6345 error ("Key sequence too long");
7e85b935
RS
6346 keybuf[t] = posn;
6347 keybuf[t+1] = key;
6348
6349 /* Zap the position in key, so we know that we've
6350 expanded it, and don't try to do so again. */
6351 POSN_BUFFER_POSN (EVENT_START (key))
6352 = Fcons (posn, Qnil);
6353
6354 mock_input = t + 2;
6355 goto replay_sequence;
6356 }
8c18cbfb 6357 else if (CONSP (posn))
7e85b935
RS
6358 {
6359 /* We're looking at the second event of a
6360 sequence which we expanded before. Set
6361 last_real_key_start appropriately. */
6362 if (last_real_key_start == t && t > 0)
6363 last_real_key_start = t - 1;
6364 }
a6d53864 6365 }
284f4730 6366 }
f4255cd1
JB
6367
6368 /* We have finally decided that KEY is something we might want
6369 to look up. */
284f4730
JB
6370 first_binding = (follow_key (key,
6371 nmaps - first_binding,
253598e4 6372 submaps + first_binding,
284f4730 6373 defs + first_binding,
4e50f26a 6374 submaps + first_binding)
284f4730 6375 + first_binding);
0a7f1fc0 6376
f4255cd1 6377 /* If KEY wasn't bound, we'll try some fallbacks. */
0a7f1fc0
JB
6378 if (first_binding >= nmaps)
6379 {
9b8eb840 6380 Lisp_Object head;
0a7f1fc0 6381
9b8eb840 6382 head = EVENT_HEAD (key);
24736fbc 6383 if (help_char_p (head) && t > 0)
7e85b935
RS
6384 {
6385 read_key_sequence_cmd = Vprefix_help_command;
6386 keybuf[t++] = key;
6387 last_nonmenu_event = key;
bc536d84
RS
6388 /* The Microsoft C compiler can't handle the goto that
6389 would go here. */
309b0fc8 6390 dummyflag = 1;
0d882d52 6391 break;
7e85b935
RS
6392 }
6393
8c18cbfb 6394 if (SYMBOLP (head))
0a7f1fc0 6395 {
9b8eb840
KH
6396 Lisp_Object breakdown;
6397 int modifiers;
0a7f1fc0 6398
9b8eb840
KH
6399 breakdown = parse_modifiers (head);
6400 modifiers = XINT (XCONS (XCONS (breakdown)->cdr)->car);
559f9d04
RS
6401 /* Attempt to reduce an unbound mouse event to a simpler
6402 event that is bound:
6403 Drags reduce to clicks.
6404 Double-clicks reduce to clicks.
6405 Triple-clicks reduce to double-clicks, then to clicks.
6406 Down-clicks are eliminated.
6407 Double-downs reduce to downs, then are eliminated.
6408 Triple-downs reduce to double-downs, then to downs,
6409 then are eliminated. */
6410 if (modifiers & (down_modifier | drag_modifier
6411 | double_modifier | triple_modifier))
0a7f1fc0 6412 {
559f9d04
RS
6413 while (modifiers & (down_modifier | drag_modifier
6414 | double_modifier | triple_modifier))
fbcd35bd
JB
6415 {
6416 Lisp_Object new_head, new_click;
6417 if (modifiers & triple_modifier)
6418 modifiers ^= (double_modifier | triple_modifier);
bc536d84
RS
6419 else if (modifiers & double_modifier)
6420 modifiers &= ~double_modifier;
6421 else if (modifiers & drag_modifier)
6422 modifiers &= ~drag_modifier;
559f9d04
RS
6423 else
6424 {
6425 /* Dispose of this `down' event by simply jumping
6426 back to replay_key, to get another event.
6427
6428 Note that if this event came from mock input,
6429 then just jumping back to replay_key will just
6430 hand it to us again. So we have to wipe out any
6431 mock input.
6432
6433 We could delete keybuf[t] and shift everything
6434 after that to the left by one spot, but we'd also
6435 have to fix up any variable that points into
6436 keybuf, and shifting isn't really necessary
6437 anyway.
6438
6439 Adding prefixes for non-textual mouse clicks
6440 creates two characters of mock input, and both
6441 must be thrown away. If we're only looking at
6442 the prefix now, we can just jump back to
6443 replay_key. On the other hand, if we've already
6444 processed the prefix, and now the actual click
6445 itself is giving us trouble, then we've lost the
6446 state of the keymaps we want to backtrack to, and
6447 we need to replay the whole sequence to rebuild
6448 it.
6449
6450 Beyond that, only function key expansion could
6451 create more than two keys, but that should never
6452 generate mouse events, so it's okay to zero
6453 mock_input in that case too.
6454
6455 Isn't this just the most wonderful code ever? */
6456 if (t == last_real_key_start)
6457 {
6458 mock_input = 0;
6459 goto replay_key;
6460 }
6461 else
6462 {
6463 mock_input = last_real_key_start;
6464 goto replay_sequence;
6465 }
6466 }
6467
27203ead
RS
6468 new_head
6469 = apply_modifiers (modifiers, XCONS (breakdown)->car);
6470 new_click
6471 = Fcons (new_head, Fcons (EVENT_START (key), Qnil));
fbcd35bd
JB
6472
6473 /* Look for a binding for this new key. follow_key
6474 promises that it didn't munge submaps the
6475 last time we called it, since key was unbound. */
27203ead
RS
6476 first_binding
6477 = (follow_key (new_click,
6478 nmaps - local_first_binding,
6479 submaps + local_first_binding,
6480 defs + local_first_binding,
4e50f26a 6481 submaps + local_first_binding)
27203ead 6482 + local_first_binding);
fbcd35bd
JB
6483
6484 /* If that click is bound, go for it. */
6485 if (first_binding < nmaps)
6486 {
6487 key = new_click;
6488 break;
6489 }
6490 /* Otherwise, we'll leave key set to the drag event. */
6491 }
0a7f1fc0
JB
6492 }
6493 }
6494 }
6495
284f4730 6496 keybuf[t++] = key;
7d6de002
RS
6497 /* Normally, last_nonmenu_event gets the previous key we read.
6498 But when a mouse popup menu is being used,
6499 we don't update last_nonmenu_event; it continues to hold the mouse
6500 event that preceded the first level of menu. */
6501 if (!used_mouse_menu)
6502 last_nonmenu_event = key;
284f4730 6503
6321824f
RS
6504 /* Record what part of this_command_keys is the current key sequence. */
6505 this_single_command_key_start = this_command_key_count - t;
6506
3fe8e9a2
RS
6507 prev_fkey_map = fkey_map;
6508 prev_fkey_start = fkey_start;
6509 prev_fkey_end = fkey_end;
6510
6511 prev_keytran_map = keytran_map;
6512 prev_keytran_start = keytran_start;
6513 prev_keytran_end = keytran_end;
6514
284f4730 6515 /* If the sequence is unbound, see if we can hang a function key
253598e4
JB
6516 off the end of it. We only want to scan real keyboard input
6517 for function key sequences, so if mock_input says that we're
f4255cd1 6518 re-reading old events, don't examine it. */
4e50f26a 6519 if (first_binding >= nmaps
253598e4 6520 && t >= mock_input)
284f4730
JB
6521 {
6522 Lisp_Object fkey_next;
6523
e9bf89a0
RS
6524 /* Continue scan from fkey_end until we find a bound suffix.
6525 If we fail, increment fkey_start
6526 and start fkey_end from there. */
284f4730
JB
6527 while (fkey_end < t)
6528 {
f4255cd1
JB
6529 Lisp_Object key;
6530
6531 key = keybuf[fkey_end++];
067ffa38
JB
6532 /* Look up meta-characters by prefixing them
6533 with meta_prefix_char. I hate this. */
8c18cbfb 6534 if (INTEGERP (key) && XINT (key) & meta_modifier)
f4255cd1 6535 {
e74fbc70
RS
6536 fkey_next
6537 = get_keymap_1
f4255cd1 6538 (get_keyelt
e74fbc70 6539 (access_keymap (fkey_map, meta_prefix_char, 1, 0)),
f4255cd1 6540 0, 1);
bb9e9bed 6541 XSETFASTINT (key, XFASTINT (key) & ~meta_modifier);
f4255cd1 6542 }
067ffa38
JB
6543 else
6544 fkey_next = fkey_map;
6545
e74fbc70
RS
6546 fkey_next
6547 = get_keyelt (access_keymap (fkey_next, key, 1, 0));
067ffa38 6548
7a80a6f6
RS
6549#if 0 /* I didn't turn this on, because it might cause trouble
6550 for the mapping of return into C-m and tab into C-i. */
6551 /* Optionally don't map function keys into other things.
6552 This enables the user to redefine kp- keys easily. */
6553 if (SYMBOLP (key) && !NILP (Vinhibit_function_key_mapping))
6554 fkey_next = Qnil;
6555#endif
6556
1abe6abe
RS
6557 /* If the function key map gives a function, not an
6558 array, then call the function with no args and use
6559 its value instead. */
6560 if (SYMBOLP (fkey_next) && ! NILP (Ffboundp (fkey_next))
6561 && fkey_end == t)
6562 {
6563 struct gcpro gcpro1, gcpro2, gcpro3;
6564 Lisp_Object tem;
6565 tem = fkey_next;
6566
6567 GCPRO3 (fkey_map, keytran_map, delayed_switch_frame);
84d91fda 6568 fkey_next = call1 (fkey_next, prompt);
1abe6abe
RS
6569 UNGCPRO;
6570 /* If the function returned something invalid,
6571 barf--don't ignore it.
df0f2ba1 6572 (To ignore it safely, we would need to gcpro a bunch of
1abe6abe
RS
6573 other variables.) */
6574 if (! (VECTORP (fkey_next) || STRINGP (fkey_next)))
6321824f 6575 error ("Function in key-translation-map returns invalid key sequence");
1abe6abe
RS
6576 }
6577
e9bf89a0
RS
6578 function_key_possible = ! NILP (fkey_next);
6579
85bc5181 6580 /* If keybuf[fkey_start..fkey_end] is bound in the
a764a753 6581 function key map and it's a suffix of the current
85bc5181 6582 sequence (i.e. fkey_end == t), replace it with
a764a753 6583 the binding and restart with fkey_start at the end. */
f5ea6163 6584 if ((VECTORP (fkey_next) || STRINGP (fkey_next))
284f4730
JB
6585 && fkey_end == t)
6586 {
2e864a76 6587 int len = XFASTINT (Flength (fkey_next));
f5ea6163
JB
6588
6589 t = fkey_start + len;
284f4730 6590 if (t >= bufsize)
3fe8e9a2 6591 error ("Key sequence too long");
284f4730 6592
f5ea6163
JB
6593 if (VECTORP (fkey_next))
6594 bcopy (XVECTOR (fkey_next)->contents,
6595 keybuf + fkey_start,
6596 (t - fkey_start) * sizeof (keybuf[0]));
6597 else if (STRINGP (fkey_next))
6598 {
6599 int i;
6600
6601 for (i = 0; i < len; i++)
bb9e9bed
KH
6602 XSETFASTINT (keybuf[fkey_start + i],
6603 XSTRING (fkey_next)->data[i]);
f5ea6163 6604 }
df0f2ba1 6605
284f4730
JB
6606 mock_input = t;
6607 fkey_start = fkey_end = t;
32e6d806 6608 fkey_map = Vfunction_key_map;
284f4730 6609
00a78037
RS
6610 /* Do pass the results through key-translation-map. */
6611 keytran_start = keytran_end = 0;
6612 keytran_map = Vkey_translation_map;
6613
f4255cd1 6614 goto replay_sequence;
284f4730 6615 }
df0f2ba1 6616
f4255cd1 6617 fkey_map = get_keymap_1 (fkey_next, 0, 1);
284f4730 6618
df0f2ba1 6619 /* If we no longer have a bound suffix, try a new positions for
a764a753 6620 fkey_start. */
284f4730
JB
6621 if (NILP (fkey_map))
6622 {
6623 fkey_end = ++fkey_start;
6624 fkey_map = Vfunction_key_map;
e9bf89a0 6625 function_key_possible = 0;
284f4730
JB
6626 }
6627 }
6628 }
a612e298
RS
6629
6630 /* Look for this sequence in key-translation-map. */
6631 {
6632 Lisp_Object keytran_next;
6633
6634 /* Scan from keytran_end until we find a bound suffix. */
6635 while (keytran_end < t)
6636 {
6637 Lisp_Object key;
6638
6639 key = keybuf[keytran_end++];
6640 /* Look up meta-characters by prefixing them
6641 with meta_prefix_char. I hate this. */
8c18cbfb 6642 if (INTEGERP (key) && XINT (key) & meta_modifier)
a612e298
RS
6643 {
6644 keytran_next
6645 = get_keymap_1
6646 (get_keyelt
6647 (access_keymap (keytran_map, meta_prefix_char, 1, 0)),
6648 0, 1);
bb9e9bed 6649 XSETFASTINT (key, XFASTINT (key) & ~meta_modifier);
a612e298
RS
6650 }
6651 else
6652 keytran_next = keytran_map;
6653
6654 keytran_next
6655 = get_keyelt (access_keymap (keytran_next, key, 1, 0));
6656
1abe6abe
RS
6657 /* If the key translation map gives a function, not an
6658 array, then call the function with no args and use
6659 its value instead. */
6660 if (SYMBOLP (keytran_next) && ! NILP (Ffboundp (keytran_next))
6661 && keytran_end == t)
6662 {
6663 struct gcpro gcpro1, gcpro2, gcpro3;
6664 Lisp_Object tem;
6665 tem = keytran_next;
6666
40932d1a 6667 GCPRO3 (fkey_map, keytran_map, delayed_switch_frame);
84d91fda 6668 keytran_next = call1 (keytran_next, prompt);
1abe6abe
RS
6669 UNGCPRO;
6670 /* If the function returned something invalid,
6671 barf--don't ignore it.
df0f2ba1 6672 (To ignore it safely, we would need to gcpro a bunch of
1abe6abe
RS
6673 other variables.) */
6674 if (! (VECTORP (keytran_next) || STRINGP (keytran_next)))
40932d1a 6675 error ("Function in key-translation-map returns invalid key sequence");
1abe6abe
RS
6676 }
6677
00a78037
RS
6678 key_translation_possible = ! NILP (keytran_next);
6679
a612e298 6680 /* If keybuf[keytran_start..keytran_end] is bound in the
1abe6abe 6681 key translation map and it's a suffix of the current
a612e298
RS
6682 sequence (i.e. keytran_end == t), replace it with
6683 the binding and restart with keytran_start at the end. */
6684 if ((VECTORP (keytran_next) || STRINGP (keytran_next))
6685 && keytran_end == t)
6686 {
2e864a76 6687 int len = XFASTINT (Flength (keytran_next));
a612e298
RS
6688
6689 t = keytran_start + len;
6690 if (t >= bufsize)
3fe8e9a2 6691 error ("Key sequence too long");
a612e298
RS
6692
6693 if (VECTORP (keytran_next))
6694 bcopy (XVECTOR (keytran_next)->contents,
6695 keybuf + keytran_start,
6696 (t - keytran_start) * sizeof (keybuf[0]));
6697 else if (STRINGP (keytran_next))
6698 {
6699 int i;
6700
6701 for (i = 0; i < len; i++)
bb9e9bed
KH
6702 XSETFASTINT (keybuf[keytran_start + i],
6703 XSTRING (keytran_next)->data[i]);
a612e298
RS
6704 }
6705
6706 mock_input = t;
6707 keytran_start = keytran_end = t;
6708 keytran_map = Vkey_translation_map;
6709
00a78037
RS
6710 /* Don't pass the results of key-translation-map
6711 through function-key-map. */
6712 fkey_start = fkey_end = t;
6713 fkey_map = Vkey_translation_map;
6714
a612e298
RS
6715 goto replay_sequence;
6716 }
6717
6718 keytran_map = get_keymap_1 (keytran_next, 0, 1);
6719
df0f2ba1 6720 /* If we no longer have a bound suffix, try a new positions for
a612e298
RS
6721 keytran_start. */
6722 if (NILP (keytran_map))
6723 {
6724 keytran_end = ++keytran_start;
6725 keytran_map = Vkey_translation_map;
00a78037 6726 key_translation_possible = 0;
a612e298
RS
6727 }
6728 }
6729 }
4e50f26a
RS
6730
6731 /* If KEY is not defined in any of the keymaps,
6732 and cannot be part of a function key or translation,
6733 and is an upper case letter
6734 use the corresponding lower-case letter instead. */
6735 if (first_binding == nmaps && ! function_key_possible
00a78037 6736 && ! key_translation_possible
8c18cbfb 6737 && INTEGERP (key)
4e50f26a
RS
6738 && ((((XINT (key) & 0x3ffff)
6739 < XSTRING (current_buffer->downcase_table)->size)
6740 && UPPERCASEP (XINT (key) & 0x3ffff))
6741 || (XINT (key) & shift_modifier)))
6742 {
569871d2 6743 Lisp_Object new_key;
569871d2 6744
309b0fc8
RS
6745 original_uppercase = key;
6746 original_uppercase_position = t - 1;
6747
831f35a2 6748 if (XINT (key) & shift_modifier)
569871d2 6749 XSETINT (new_key, XINT (key) & ~shift_modifier);
4e50f26a 6750 else
569871d2
RS
6751 XSETINT (new_key, (DOWNCASE (XINT (key) & 0x3ffff)
6752 | (XINT (key) & ~0x3ffff)));
6753
3fe8e9a2
RS
6754 /* We have to do this unconditionally, regardless of whether
6755 the lower-case char is defined in the keymaps, because they
6756 might get translated through function-key-map. */
6757 keybuf[t - 1] = new_key;
6758 mock_input = t;
6759
6760 fkey_map = prev_fkey_map;
6761 fkey_start = prev_fkey_start;
6762 fkey_end = prev_fkey_end;
6763
6764 keytran_map = prev_keytran_map;
6765 keytran_start = prev_keytran_start;
6766 keytran_end = prev_keytran_end;
6767
6768 goto replay_sequence;
4e50f26a 6769 }
ef8fd672
RS
6770 /* If KEY is not defined in any of the keymaps,
6771 and cannot be part of a function key or translation,
6772 and is a shifted function key,
6773 use the corresponding unshifted function key instead. */
6774 if (first_binding == nmaps && ! function_key_possible
6775 && ! key_translation_possible
6776 && SYMBOLP (key))
6777 {
6778 Lisp_Object breakdown;
6779 int modifiers;
6780
6781 breakdown = parse_modifiers (key);
6782 modifiers = XINT (XCONS (XCONS (breakdown)->cdr)->car);
6783 if (modifiers & shift_modifier)
6784 {
569871d2 6785 Lisp_Object new_key;
3fe8e9a2
RS
6786
6787 original_uppercase = key;
6788 original_uppercase_position = t - 1;
ef8fd672 6789
569871d2
RS
6790 modifiers &= ~shift_modifier;
6791 new_key = apply_modifiers (modifiers,
6792 XCONS (breakdown)->car);
6793
3fe8e9a2
RS
6794 keybuf[t - 1] = new_key;
6795 mock_input = t;
6796
6797 fkey_map = prev_fkey_map;
6798 fkey_start = prev_fkey_start;
6799 fkey_end = prev_fkey_end;
6800
6801 keytran_map = prev_keytran_map;
6802 keytran_start = prev_keytran_start;
6803 keytran_end = prev_keytran_end;
6804
6805 goto replay_sequence;
ef8fd672
RS
6806 }
6807 }
284f4730
JB
6808 }
6809
309b0fc8 6810 if (!dummyflag)
bc536d84
RS
6811 read_key_sequence_cmd = (first_binding < nmaps
6812 ? defs[first_binding]
6813 : Qnil);
284f4730 6814
cd21b839 6815 unread_switch_frame = delayed_switch_frame;
f4255cd1 6816 unbind_to (count, Qnil);
07f76a14 6817
3fe8e9a2
RS
6818 /* Don't downcase the last character if the caller says don't.
6819 Don't downcase it if the result is undefined, either. */
6820 if ((dont_downcase_last || first_binding >= nmaps)
6821 && t - 1 == original_uppercase_position)
309b0fc8
RS
6822 keybuf[t - 1] = original_uppercase;
6823
07f76a14
JB
6824 /* Occasionally we fabricate events, perhaps by expanding something
6825 according to function-key-map, or by adding a prefix symbol to a
6826 mouse click in the scroll bar or modeline. In this cases, return
6827 the entire generated key sequence, even if we hit an unbound
6828 prefix or a definition before the end. This means that you will
6829 be able to push back the event properly, and also means that
6830 read-key-sequence will always return a logical unit.
6831
6832 Better ideas? */
cca310da
JB
6833 for (; t < mock_input; t++)
6834 {
a98ea3f9
RS
6835 if (echo_keystrokes)
6836 echo_char (keybuf[t]);
cca310da
JB
6837 add_command_key (keybuf[t]);
6838 }
07f76a14 6839
284f4730
JB
6840 return t;
6841}
6842
a612e298
RS
6843#if 0 /* This doc string is too long for some compilers.
6844 This commented-out definition serves for DOC. */
ce98e608 6845DEFUN ("read-key-sequence", Fread_key_sequence, Sread_key_sequence, 1, 4, 0,
284f4730
JB
6846 "Read a sequence of keystrokes and return as a string or vector.\n\
6847The sequence is sufficient to specify a non-prefix command in the\n\
6848current local and global maps.\n\
6849\n\
c0a58692
RS
6850First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
6851Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
6852as a continuation of the previous key.\n\
284f4730 6853\n\
309b0fc8
RS
6854The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
6855convert the last event to lower case. (Normally any upper case event\n\
6856is converted to lower case if the original event is undefined and the lower\n\
6857case equivalent is defined.) A non-nil value is appropriate for reading\n\
6858a key sequence to be defined.\n\
6859\n\
cb5df6ae
JB
6860A C-g typed while in this function is treated like any other character,\n\
6861and `quit-flag' is not set.\n\
6862\n\
6863If the key sequence starts with a mouse click, then the sequence is read\n\
6864using the keymaps of the buffer of the window clicked in, not the buffer\n\
6865of the selected window as normal.\n\
ede41463 6866""\n\
cb5df6ae
JB
6867`read-key-sequence' drops unbound button-down events, since you normally\n\
6868only care about the click or drag events which follow them. If a drag\n\
fbcd35bd
JB
6869or multi-click event is unbound, but the corresponding click event would\n\
6870be bound, `read-key-sequence' turns the event into a click event at the\n\
cb5df6ae 6871drag's starting position. This means that you don't have to distinguish\n\
fbcd35bd 6872between click and drag, double, or triple events unless you want to.\n\
cb5df6ae
JB
6873\n\
6874`read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
3c370943
JB
6875lines separating windows, and scroll bars with imaginary keys\n\
6876`mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
cb5df6ae 6877\n\
ce98e608
KH
6878Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
6879function will process a switch-frame event if the user switches frames\n\
6880before typing anything. If the user switches frames in the middle of a\n\
6881key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
6882is nil, then the event will be put off until after the current key sequence.\n\
cb5df6ae
JB
6883\n\
6884`read-key-sequence' checks `function-key-map' for function key\n\
6885sequences, where they wouldn't conflict with ordinary bindings. See\n\
4bb994d1 6886`function-key-map' for more details.")
11e08aab 6887 (prompt, continue_echo, dont_downcase_last, can_return_switch_frame)
a612e298
RS
6888#endif
6889
ce98e608 6890DEFUN ("read-key-sequence", Fread_key_sequence, Sread_key_sequence, 1, 4, 0,
a612e298 6891 0)
ce98e608 6892 (prompt, continue_echo, dont_downcase_last, can_return_switch_frame)
309b0fc8 6893 Lisp_Object prompt, continue_echo, dont_downcase_last;
ce98e608 6894 Lisp_Object can_return_switch_frame;
284f4730
JB
6895{
6896 Lisp_Object keybuf[30];
6897 register int i;
6898 struct gcpro gcpro1, gcpro2;
6899
6900 if (!NILP (prompt))
6901 CHECK_STRING (prompt, 0);
6902 QUIT;
6903
6904 bzero (keybuf, sizeof keybuf);
6905 GCPRO1 (keybuf[0]);
6906 gcpro1.nvars = (sizeof keybuf/sizeof (keybuf[0]));
6907
daa37602 6908 if (NILP (continue_echo))
6321824f
RS
6909 {
6910 this_command_key_count = 0;
6911 this_single_command_key_start = 0;
6912 }
c0a58692 6913
309b0fc8 6914 i = read_key_sequence (keybuf, (sizeof keybuf/sizeof (keybuf[0])),
ce98e608 6915 prompt, ! NILP (dont_downcase_last),
f571ae0d 6916 ! NILP (can_return_switch_frame), 0);
284f4730 6917
dcc408a0
RS
6918 if (i == -1)
6919 {
6920 Vquit_flag = Qt;
6921 QUIT;
6922 }
284f4730 6923 UNGCPRO;
86e5706b 6924 return make_event_array (i, keybuf);
284f4730
JB
6925}
6926\f
158f7532 6927DEFUN ("command-execute", Fcommand_execute, Scommand_execute, 1, 4, 0,
284f4730
JB
6928 "Execute CMD as an editor command.\n\
6929CMD must be a symbol that satisfies the `commandp' predicate.\n\
6930Optional second arg RECORD-FLAG non-nil\n\
6931means unconditionally put this command in `command-history'.\n\
aaf2ead7
RS
6932Otherwise, that is done only if an arg is read using the minibuffer.\n\
6933The argument KEYS specifies the value to use instead of (this-command-keys)\n\
6321824f 6934when reading the arguments; if it is nil, (this-command-keys) is used.\n\
158f7532
RS
6935The argument SPECIAL, if non-nil, means that this command is executing\n\
6936a special event, so ignore the prefix argument and don't clear it.")
6937 (cmd, record_flag, keys, special)
6938 Lisp_Object cmd, record_flag, keys, special;
284f4730
JB
6939{
6940 register Lisp_Object final;
6941 register Lisp_Object tem;
6942 Lisp_Object prefixarg;
6943 struct backtrace backtrace;
6944 extern int debug_on_next_call;
6945
284f4730
JB
6946 debug_on_next_call = 0;
6947
158f7532
RS
6948 if (NILP (special))
6949 {
6950 prefixarg = current_kboard->Vprefix_arg;
6951 Vcurrent_prefix_arg = prefixarg;
6952 current_kboard->Vprefix_arg = Qnil;
6953 }
6954 else
6955 prefixarg = Qnil;
6956
8c18cbfb 6957 if (SYMBOLP (cmd))
284f4730
JB
6958 {
6959 tem = Fget (cmd, Qdisabled);
88ce066e 6960 if (!NILP (tem) && !NILP (Vrun_hooks))
b78ce8fb
RS
6961 {
6962 tem = Fsymbol_value (Qdisabled_command_hook);
6963 if (!NILP (tem))
6964 return call1 (Vrun_hooks, Qdisabled_command_hook);
6965 }
284f4730
JB
6966 }
6967
01e26217 6968 while (1)
284f4730 6969 {
ffd56f97 6970 final = Findirect_function (cmd);
284f4730
JB
6971
6972 if (CONSP (final) && (tem = Fcar (final), EQ (tem, Qautoload)))
b516a185
RS
6973 {
6974 struct gcpro gcpro1, gcpro2;
6975
6976 GCPRO2 (cmd, prefixarg);
6977 do_autoload (final, cmd);
6978 UNGCPRO;
6979 }
284f4730
JB
6980 else
6981 break;
6982 }
6983
8c18cbfb 6984 if (STRINGP (final) || VECTORP (final))
284f4730
JB
6985 {
6986 /* If requested, place the macro in the command history. For
6987 other sorts of commands, call-interactively takes care of
6988 this. */
e57d8fd8 6989 if (!NILP (record_flag))
284f4730
JB
6990 Vcommand_history
6991 = Fcons (Fcons (Qexecute_kbd_macro,
6992 Fcons (final, Fcons (prefixarg, Qnil))),
6993 Vcommand_history);
6994
6995 return Fexecute_kbd_macro (final, prefixarg);
6996 }
8c18cbfb 6997 if (CONSP (final) || SUBRP (final) || COMPILEDP (final))
284f4730
JB
6998 {
6999 backtrace.next = backtrace_list;
7000 backtrace_list = &backtrace;
7001 backtrace.function = &Qcall_interactively;
7002 backtrace.args = &cmd;
7003 backtrace.nargs = 1;
7004 backtrace.evalargs = 0;
7005
e57d8fd8 7006 tem = Fcall_interactively (cmd, record_flag, keys);
284f4730
JB
7007
7008 backtrace_list = backtrace.next;
7009 return tem;
7010 }
7011 return Qnil;
7012}
7013\f
284f4730
JB
7014DEFUN ("execute-extended-command", Fexecute_extended_command, Sexecute_extended_command,
7015 1, 1, "P",
7016 "Read function name, then read its arguments and call it.")
7017 (prefixarg)
7018 Lisp_Object prefixarg;
7019{
7020 Lisp_Object function;
7021 char buf[40];
7022 Lisp_Object saved_keys;
5434fce6 7023 Lisp_Object bindings, value;
214360e9 7024 struct gcpro gcpro1, gcpro2;
284f4730 7025
b0f2a7bf
KH
7026 saved_keys = Fvector (this_command_key_count,
7027 XVECTOR (this_command_keys)->contents);
284f4730 7028 buf[0] = 0;
fde7aff8 7029 GCPRO2 (saved_keys, prefixarg);
284f4730
JB
7030
7031 if (EQ (prefixarg, Qminus))
7032 strcpy (buf, "- ");
7033 else if (CONSP (prefixarg) && XINT (XCONS (prefixarg)->car) == 4)
7034 strcpy (buf, "C-u ");
8c18cbfb 7035 else if (CONSP (prefixarg) && INTEGERP (XCONS (prefixarg)->car))
5d5b907f
RS
7036 {
7037 if (sizeof (int) == sizeof (EMACS_INT))
7038 sprintf (buf, "%d ", XINT (XCONS (prefixarg)->car));
7039 else if (sizeof (long) == sizeof (EMACS_INT))
7040 sprintf (buf, "%ld ", XINT (XCONS (prefixarg)->car));
7041 else
7042 abort ();
7043 }
8c18cbfb 7044 else if (INTEGERP (prefixarg))
5d5b907f
RS
7045 {
7046 if (sizeof (int) == sizeof (EMACS_INT))
7047 sprintf (buf, "%d ", XINT (prefixarg));
7048 else if (sizeof (long) == sizeof (EMACS_INT))
7049 sprintf (buf, "%ld ", XINT (prefixarg));
7050 else
7051 abort ();
7052 }
284f4730
JB
7053
7054 /* This isn't strictly correct if execute-extended-command
7055 is bound to anything else. Perhaps it should use
7056 this_command_keys? */
7057 strcat (buf, "M-x ");
7058
7059 /* Prompt with buf, and then read a string, completing from and
7060 restricting to the set of all defined commands. Don't provide
51763820 7061 any initial input. Save the command read on the extended-command
03b4122a 7062 history list. */
284f4730
JB
7063 function = Fcompleting_read (build_string (buf),
7064 Vobarray, Qcommandp,
5b467a52 7065 Qt, Qnil, Qextended_command_history, Qnil);
284f4730 7066
1f5b1641
RS
7067 if (STRINGP (function) && XSTRING (function)->size == 0)
7068 error ("No command name given");
7069
1113d9db
JB
7070 /* Set this_command_keys to the concatenation of saved_keys and
7071 function, followed by a RET. */
284f4730 7072 {
1113d9db 7073 struct Lisp_String *str;
b0f2a7bf 7074 Lisp_Object *keys;
284f4730
JB
7075 int i;
7076 Lisp_Object tem;
7077
1113d9db 7078 this_command_key_count = 0;
6321824f 7079 this_single_command_key_start = 0;
1113d9db 7080
b0f2a7bf
KH
7081 keys = XVECTOR (saved_keys)->contents;
7082 for (i = 0; i < XVECTOR (saved_keys)->size; i++)
7083 add_command_key (keys[i]);
1113d9db
JB
7084
7085 str = XSTRING (function);
7086 for (i = 0; i < str->size; i++)
7087 {
bb9e9bed 7088 XSETFASTINT (tem, str->data[i]);
1113d9db
JB
7089 add_command_key (tem);
7090 }
7091
bb9e9bed 7092 XSETFASTINT (tem, '\015');
1113d9db 7093 add_command_key (tem);
284f4730
JB
7094 }
7095
7096 UNGCPRO;
7097
0a7f1fc0 7098 function = Fintern (function, Qnil);
d8bcf58e 7099 current_kboard->Vprefix_arg = prefixarg;
284f4730
JB
7100 this_command = function;
7101
6526ab49
RS
7102 /* If enabled, show which key runs this command. */
7103 if (!NILP (Vsuggest_key_bindings)
71012575 7104 && NILP (Vexecuting_macro)
6526ab49 7105 && SYMBOLP (function))
5434fce6
RS
7106 bindings = Fwhere_is_internal (function, Voverriding_local_map,
7107 Qt, Qnil);
7108 else
7109 bindings = Qnil;
6526ab49 7110
5434fce6
RS
7111 value = Qnil;
7112 GCPRO2 (bindings, value);
7113 value = Fcommand_execute (function, Qt, Qnil, Qnil);
6526ab49 7114
5434fce6
RS
7115 /* If the command has a key binding, print it now. */
7116 if (!NILP (bindings))
7117 {
7118 /* But first wait, and skip the message if there is input. */
7119 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings)
7120 ? Vsuggest_key_bindings : make_number (2)),
303b5b3f
RS
7121 Qnil, Qnil))
7122 && ! CONSP (Vunread_command_events))
6526ab49 7123 {
5434fce6
RS
7124 Lisp_Object binding;
7125 char *newmessage;
7126 char *oldmessage = echo_area_glyphs;
7127 int oldmessage_len = echo_area_glyphs_length;
7128
7129 binding = Fkey_description (bindings);
7130
7131 newmessage
7132 = (char *) alloca (XSYMBOL (function)->name->size
7133 + XSTRING (binding)->size
7134 + 100);
7135 sprintf (newmessage, "You can run the command `%s' by typing %s",
6526ab49 7136 XSYMBOL (function)->name->data,
5434fce6
RS
7137 XSTRING (binding)->data);
7138 message1_nolog (newmessage);
7139 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings)
7140 ? Vsuggest_key_bindings : make_number (2)),
7141 Qnil, Qnil)))
7142 message2_nolog (oldmessage, oldmessage_len);
6526ab49
RS
7143 }
7144 }
7145
5434fce6 7146 RETURN_UNGCPRO (value);
284f4730 7147}
6526ab49
RS
7148
7149/* Find the set of keymaps now active.
7150 Store into *MAPS_P a vector holding the various maps
7151 and return the number of them. The vector was malloc'd
7152 and the caller should free it. */
7153
7154int
7155current_active_maps (maps_p)
7156 Lisp_Object **maps_p;
7157{
7158 Lisp_Object *tmaps, *maps;
7159 int nmaps;
7160
7161 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7162 if (!NILP (Voverriding_local_map_menu_flag))
7163 {
7164 /* Yes, use them (if non-nil) as well as the global map. */
7165 maps = (Lisp_Object *) xmalloc (3 * sizeof (maps[0]));
7166 nmaps = 0;
7167 if (!NILP (current_kboard->Voverriding_terminal_local_map))
7168 maps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
7169 if (!NILP (Voverriding_local_map))
7170 maps[nmaps++] = Voverriding_local_map;
7171 }
7172 else
7173 {
7174 /* No, so use major and minor mode keymaps. */
7175 nmaps = current_minor_maps (NULL, &tmaps);
7176 maps = (Lisp_Object *) xmalloc ((nmaps + 2) * sizeof (maps[0]));
7177 bcopy (tmaps, maps, nmaps * sizeof (maps[0]));
7178#ifdef USE_TEXT_PROPERTIES
7179 maps[nmaps++] = get_local_map (PT, current_buffer);
7180#else
7181 maps[nmaps++] = current_buffer->keymap;
7182#endif
7183 }
7184 maps[nmaps++] = current_global_map;
7185
7186 *maps_p = maps;
7187 return nmaps;
7188}
284f4730 7189\f
d9d4c147 7190/* Return nonzero if input events are pending. */
284f4730
JB
7191
7192detect_input_pending ()
7193{
7194 if (!input_pending)
d9d4c147
KH
7195 get_input_pending (&input_pending, 0);
7196
7197 return input_pending;
7198}
7199
b1878f45 7200/* Return nonzero if input events are pending, and run any pending timers. */
d9d4c147 7201
87dd9b9b
RS
7202detect_input_pending_run_timers (do_display)
7203 int do_display;
d9d4c147 7204{
87dd9b9b
RS
7205 int old_timers_run = timers_run;
7206
d9d4c147
KH
7207 if (!input_pending)
7208 get_input_pending (&input_pending, 1);
284f4730 7209
87dd9b9b
RS
7210 if (old_timers_run != timers_run && do_display)
7211 redisplay_preserve_echo_area ();
7212
284f4730
JB
7213 return input_pending;
7214}
7215
ffd56f97
JB
7216/* This is called in some cases before a possible quit.
7217 It cases the next call to detect_input_pending to recompute input_pending.
7218 So calling this function unnecessarily can't do any harm. */
7219clear_input_pending ()
7220{
7221 input_pending = 0;
7222}
7223
b1878f45
RS
7224/* Return nonzero if there are pending requeued events.
7225 This isn't used yet. The hope is to make wait_reading_process_input
7226 call it, and return return if it runs Lisp code that unreads something.
7227 The problem is, kbd_buffer_get_event needs to be fixed to know what
7228 to do in that case. It isn't trivial. */
7229
7230requeued_events_pending_p ()
7231{
7232 return (!NILP (Vunread_command_events) || unread_command_char != -1);
7233}
7234
7235
284f4730
JB
7236DEFUN ("input-pending-p", Finput_pending_p, Sinput_pending_p, 0, 0, 0,
7237 "T if command input is currently available with no waiting.\n\
7238Actually, the value is nil only if we can be sure that no input is available.")
7239 ()
7240{
24597608 7241 if (!NILP (Vunread_command_events) || unread_command_char != -1)
284f4730
JB
7242 return (Qt);
7243
d9d4c147
KH
7244 get_input_pending (&input_pending, 1);
7245 return input_pending > 0 ? Qt : Qnil;
284f4730
JB
7246}
7247
7248DEFUN ("recent-keys", Frecent_keys, Srecent_keys, 0, 0, 0,
22d7cb89 7249 "Return vector of last 100 events, not counting those from keyboard macros.")
284f4730
JB
7250 ()
7251{
5160df46 7252 Lisp_Object *keys = XVECTOR (recent_keys)->contents;
284f4730
JB
7253 Lisp_Object val;
7254
7255 if (total_keys < NUM_RECENT_KEYS)
5160df46 7256 return Fvector (total_keys, keys);
284f4730
JB
7257 else
7258 {
5160df46
JB
7259 val = Fvector (NUM_RECENT_KEYS, keys);
7260 bcopy (keys + recent_keys_index,
284f4730
JB
7261 XVECTOR (val)->contents,
7262 (NUM_RECENT_KEYS - recent_keys_index) * sizeof (Lisp_Object));
5160df46 7263 bcopy (keys,
284f4730
JB
7264 XVECTOR (val)->contents + NUM_RECENT_KEYS - recent_keys_index,
7265 recent_keys_index * sizeof (Lisp_Object));
7266 return val;
7267 }
7268}
7269
7270DEFUN ("this-command-keys", Fthis_command_keys, Sthis_command_keys, 0, 0, 0,
e5f920d7
RS
7271 "Return the key sequence that invoked this command.\n\
7272The value is a string or a vector.")
284f4730
JB
7273 ()
7274{
86e5706b
RS
7275 return make_event_array (this_command_key_count,
7276 XVECTOR (this_command_keys)->contents);
284f4730
JB
7277}
7278
6321824f
RS
7279DEFUN ("this-single-command-keys", Fthis_single_command_keys,
7280 Sthis_single_command_keys, 0, 0, 0,
7281 "Return the key sequence that invoked this command.\n\
7282Unlike `this-command-keys', this function's value\n\
7283does not include prefix arguments.\n\
7284The value is a string or a vector.")
7285 ()
7286{
7287 return make_event_array (this_command_key_count
7288 - this_single_command_key_start,
7289 (XVECTOR (this_command_keys)->contents
7290 + this_single_command_key_start));
7291}
7292
71918b75
RS
7293DEFUN ("reset-this-command-lengths", Freset_this_command_lengths,
7294 Sreset_this_command_lengths, 0, 0, 0,
7295 "Used for complicated reasons in `universal-argument-other-key'.\n\
7296\n\
7297`universal-argument-other-key' rereads the event just typed.\n\
7298It then gets translated through `function-key-map'.\n\
7299The translated event gets included in the echo area and in\n\
7300the value of `this-command-keys' in addition to the raw original event.\n\
7301That is not right.\n\
7302\n\
7303Calling this function directs the translated event to replace\n\
7304the original event, so that only one version of the event actually\n\
7305appears in the echo area and in the value of `this-command-keys.'.")
7306 ()
7307{
7308 before_command_restore_flag = 1;
7309 before_command_key_count_1 = before_command_key_count;
7310 before_command_echo_length_1 = before_command_echo_length;
7311}
7312
284f4730
JB
7313DEFUN ("recursion-depth", Frecursion_depth, Srecursion_depth, 0, 0, 0,
7314 "Return the current depth in recursive edits.")
7315 ()
7316{
7317 Lisp_Object temp;
bb9e9bed 7318 XSETFASTINT (temp, command_loop_level + minibuf_level);
284f4730
JB
7319 return temp;
7320}
7321
7322DEFUN ("open-dribble-file", Fopen_dribble_file, Sopen_dribble_file, 1, 1,
7323 "FOpen dribble file: ",
9b2471df
RS
7324 "Start writing all keyboard characters to a dribble file called FILE.\n\
7325If FILE is nil, close any open dribble file.")
284f4730
JB
7326 (file)
7327 Lisp_Object file;
7328{
6cb52def 7329 if (dribble)
284f4730 7330 {
6cb52def
KH
7331 fclose (dribble);
7332 dribble = 0;
284f4730 7333 }
6cb52def 7334 if (!NILP (file))
284f4730
JB
7335 {
7336 file = Fexpand_file_name (file, Qnil);
7337 dribble = fopen (XSTRING (file)->data, "w");
ab6ca1de
KH
7338 if (dribble == 0)
7339 report_file_error ("Opening dribble", Fcons (file, Qnil));
284f4730
JB
7340 }
7341 return Qnil;
7342}
7343
7344DEFUN ("discard-input", Fdiscard_input, Sdiscard_input, 0, 0, 0,
7345 "Discard the contents of the terminal input buffer.\n\
7346Also cancel any kbd macro being defined.")
7347 ()
7348{
c5fdd383 7349 current_kboard->defining_kbd_macro = Qnil;
284f4730
JB
7350 update_mode_lines++;
7351
24597608 7352 Vunread_command_events = Qnil;
86e5706b 7353 unread_command_char = -1;
284f4730
JB
7354
7355 discard_tty_input ();
7356
ff0b5f4c
JB
7357 /* Without the cast, GCC complains that this assignment loses the
7358 volatile qualifier of kbd_store_ptr. Is there anything wrong
7359 with that? */
beecf6a1
KH
7360 kbd_fetch_ptr = (struct input_event *) kbd_store_ptr;
7361 Ffillarray (kbd_buffer_frame_or_window, Qnil);
284f4730
JB
7362 input_pending = 0;
7363
7364 return Qnil;
7365}
7366\f
7367DEFUN ("suspend-emacs", Fsuspend_emacs, Ssuspend_emacs, 0, 1, "",
7368 "Stop Emacs and return to superior process. You can resume later.\n\
8026024c
KH
7369If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
7370control, run a subshell instead.\n\n\
284f4730 7371If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
b7d2ebbf
RS
7372to be read as terminal input by Emacs's parent, after suspension.\n\
7373\n\
bbdc2092
RS
7374Before suspending, run the normal hook `suspend-hook'.\n\
7375After resumption run the normal hook `suspend-resume-hook'.\n\
284f4730
JB
7376\n\
7377Some operating systems cannot stop the Emacs process and resume it later.\n\
b7d2ebbf 7378On such systems, Emacs starts a subshell instead of suspending.")
284f4730
JB
7379 (stuffstring)
7380 Lisp_Object stuffstring;
7381{
3a69360c 7382 Lisp_Object tem;
284f4730
JB
7383 int count = specpdl_ptr - specpdl;
7384 int old_height, old_width;
7385 int width, height;
b7d2ebbf 7386 struct gcpro gcpro1, gcpro2;
284f4730
JB
7387 extern init_sys_modes ();
7388
7389 if (!NILP (stuffstring))
7390 CHECK_STRING (stuffstring, 0);
284f4730 7391
1e95ed28
JB
7392 /* Run the functions in suspend-hook. */
7393 if (!NILP (Vrun_hooks))
7394 call1 (Vrun_hooks, intern ("suspend-hook"));
284f4730 7395
b7d2ebbf 7396 GCPRO1 (stuffstring);
ff11dfa1 7397 get_frame_size (&old_width, &old_height);
284f4730
JB
7398 reset_sys_modes ();
7399 /* sys_suspend can get an error if it tries to fork a subshell
7400 and the system resources aren't available for that. */
7401 record_unwind_protect (init_sys_modes, 0);
7402 stuff_buffered_input (stuffstring);
8026024c
KH
7403 if (cannot_suspend)
7404 sys_subshell ();
7405 else
7406 sys_suspend ();
284f4730
JB
7407 unbind_to (count, Qnil);
7408
7409 /* Check if terminal/window size has changed.
7410 Note that this is not useful when we are running directly
7411 with a window system; but suspend should be disabled in that case. */
ff11dfa1 7412 get_frame_size (&width, &height);
284f4730 7413 if (width != old_width || height != old_height)
f5ea6163 7414 change_frame_size (selected_frame, height, width, 0, 0);
284f4730 7415
1e95ed28 7416 /* Run suspend-resume-hook. */
284f4730
JB
7417 if (!NILP (Vrun_hooks))
7418 call1 (Vrun_hooks, intern ("suspend-resume-hook"));
df0f2ba1 7419
284f4730
JB
7420 UNGCPRO;
7421 return Qnil;
7422}
7423
7424/* If STUFFSTRING is a string, stuff its contents as pending terminal input.
eb8c3be9 7425 Then in any case stuff anything Emacs has read ahead and not used. */
284f4730
JB
7426
7427stuff_buffered_input (stuffstring)
7428 Lisp_Object stuffstring;
7429{
284f4730 7430/* stuff_char works only in BSD, versions 4.2 and up. */
6df54671 7431#ifdef BSD_SYSTEM
284f4730 7432#ifndef BSD4_1
612b78ef 7433 register unsigned char *p;
612b78ef 7434
8c18cbfb 7435 if (STRINGP (stuffstring))
284f4730
JB
7436 {
7437 register int count;
7438
7439 p = XSTRING (stuffstring)->data;
7440 count = XSTRING (stuffstring)->size;
7441 while (count-- > 0)
7442 stuff_char (*p++);
7443 stuff_char ('\n');
7444 }
7445 /* Anything we have read ahead, put back for the shell to read. */
beecf6a1 7446 /* ?? What should this do when we have multiple keyboards??
c5fdd383 7447 Should we ignore anything that was typed in at the "wrong" kboard? */
beecf6a1 7448 for (; kbd_fetch_ptr != kbd_store_ptr; kbd_fetch_ptr++)
284f4730 7449 {
beecf6a1
KH
7450 if (kbd_fetch_ptr == kbd_buffer + KBD_BUFFER_SIZE)
7451 kbd_fetch_ptr = kbd_buffer;
7452 if (kbd_fetch_ptr->kind == ascii_keystroke)
7453 stuff_char (kbd_fetch_ptr->code);
7454 kbd_fetch_ptr->kind = no_event;
7455 (XVECTOR (kbd_buffer_frame_or_window)->contents[kbd_fetch_ptr
7456 - kbd_buffer]
7b4aedb9 7457 = Qnil);
284f4730
JB
7458 }
7459 input_pending = 0;
7460#endif
6df54671 7461#endif /* BSD_SYSTEM and not BSD4_1 */
284f4730
JB
7462}
7463\f
ffd56f97
JB
7464set_waiting_for_input (time_to_clear)
7465 EMACS_TIME *time_to_clear;
284f4730 7466{
ffd56f97 7467 input_available_clear_time = time_to_clear;
284f4730
JB
7468
7469 /* Tell interrupt_signal to throw back to read_char, */
7470 waiting_for_input = 1;
7471
7472 /* If interrupt_signal was called before and buffered a C-g,
7473 make it run again now, to avoid timing error. */
7474 if (!NILP (Vquit_flag))
7475 quit_throw_to_read_char ();
284f4730
JB
7476}
7477
7478clear_waiting_for_input ()
7479{
7480 /* Tell interrupt_signal not to throw back to read_char, */
7481 waiting_for_input = 0;
ffd56f97 7482 input_available_clear_time = 0;
284f4730
JB
7483}
7484
7485/* This routine is called at interrupt level in response to C-G.
7486 If interrupt_input, this is the handler for SIGINT.
7487 Otherwise, it is called from kbd_buffer_store_event,
7488 in handling SIGIO or SIGTINT.
7489
7490 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
7491 immediately throw back to read_char.
7492
7493 Otherwise it sets the Lisp variable quit-flag not-nil.
7494 This causes eval to throw, when it gets a chance.
7495 If quit-flag is already non-nil, it stops the job right away. */
7496
7497SIGTYPE
91c049d4
RS
7498interrupt_signal (signalnum) /* If we don't have an argument, */
7499 int signalnum; /* some compilers complain in signal calls. */
284f4730
JB
7500{
7501 char c;
7502 /* Must preserve main program's value of errno. */
7503 int old_errno = errno;
284f4730 7504
5970a8cb 7505#if defined (USG) && !defined (POSIX_SIGNALS)
7a80a6f6
RS
7506 if (!read_socket_hook && NILP (Vwindow_system))
7507 {
7508 /* USG systems forget handlers when they are used;
7509 must reestablish each time */
7510 signal (SIGINT, interrupt_signal);
7511 signal (SIGQUIT, interrupt_signal);
7512 }
284f4730
JB
7513#endif /* USG */
7514
7515 cancel_echoing ();
7516
31e4e97b
EZ
7517 if (!NILP (Vquit_flag)
7518 && (FRAME_TERMCAP_P (selected_frame) || FRAME_MSDOS_P (selected_frame)))
284f4730 7519 {
31e4e97b
EZ
7520 /* If SIGINT isn't blocked, don't let us be interrupted by
7521 another SIGINT, it might be harmful due to non-reentrancy
7522 in I/O functions. */
7523 sigblock (sigmask (SIGINT));
7524
284f4730
JB
7525 fflush (stdout);
7526 reset_sys_modes ();
31e4e97b 7527
284f4730
JB
7528#ifdef SIGTSTP /* Support possible in later USG versions */
7529/*
7530 * On systems which can suspend the current process and return to the original
7531 * shell, this command causes the user to end up back at the shell.
7532 * The "Auto-save" and "Abort" questions are not asked until
7533 * the user elects to return to emacs, at which point he can save the current
7534 * job and either dump core or continue.
7535 */
7536 sys_suspend ();
7537#else
7538#ifdef VMS
7539 if (sys_suspend () == -1)
7540 {
7541 printf ("Not running as a subprocess;\n");
7542 printf ("you can continue or abort.\n");
7543 }
7544#else /* not VMS */
7545 /* Perhaps should really fork an inferior shell?
7546 But that would not provide any way to get back
7547 to the original shell, ever. */
7548 printf ("No support for stopping a process on this operating system;\n");
7549 printf ("you can continue or abort.\n");
7550#endif /* not VMS */
7551#endif /* not SIGTSTP */
80e4aa30
RS
7552#ifdef MSDOS
7553 /* We must remain inside the screen area when the internal terminal
7554 is used. Note that [Enter] is not echoed by dos. */
7555 cursor_to (0, 0);
7556#endif
118d6ca9
RS
7557 /* It doesn't work to autosave while GC is in progress;
7558 the code used for auto-saving doesn't cope with the mark bit. */
7559 if (!gc_in_progress)
9fd7d808 7560 {
118d6ca9
RS
7561 printf ("Auto-save? (y or n) ");
7562 fflush (stdout);
7563 if (((c = getchar ()) & ~040) == 'Y')
7564 {
7565 Fdo_auto_save (Qt, Qnil);
80e4aa30 7566#ifdef MSDOS
118d6ca9 7567 printf ("\r\nAuto-save done");
80e4aa30 7568#else /* not MSDOS */
118d6ca9 7569 printf ("Auto-save done\n");
80e4aa30 7570#endif /* not MSDOS */
118d6ca9
RS
7571 }
7572 while (c != '\n') c = getchar ();
9fd7d808 7573 }
118d6ca9
RS
7574 else
7575 {
7576 /* During GC, it must be safe to reenable quitting again. */
7577 Vinhibit_quit = Qnil;
7578#ifdef MSDOS
7579 printf ("\r\n");
7580#endif /* not MSDOS */
7581 printf ("Garbage collection in progress; cannot auto-save now\r\n");
7582 printf ("but will instead do a real quit after garbage collection ends\r\n");
7583 fflush (stdout);
7584 }
7585
80e4aa30
RS
7586#ifdef MSDOS
7587 printf ("\r\nAbort? (y or n) ");
7588#else /* not MSDOS */
284f4730
JB
7589#ifdef VMS
7590 printf ("Abort (and enter debugger)? (y or n) ");
7591#else /* not VMS */
7592 printf ("Abort (and dump core)? (y or n) ");
7593#endif /* not VMS */
80e4aa30 7594#endif /* not MSDOS */
284f4730
JB
7595 fflush (stdout);
7596 if (((c = getchar ()) & ~040) == 'Y')
7597 abort ();
7598 while (c != '\n') c = getchar ();
80e4aa30
RS
7599#ifdef MSDOS
7600 printf ("\r\nContinuing...\r\n");
7601#else /* not MSDOS */
284f4730 7602 printf ("Continuing...\n");
80e4aa30 7603#endif /* not MSDOS */
284f4730
JB
7604 fflush (stdout);
7605 init_sys_modes ();
31e4e97b 7606 sigfree ();
284f4730
JB
7607 }
7608 else
7609 {
7610 /* If executing a function that wants to be interrupted out of
7611 and the user has not deferred quitting by binding `inhibit-quit'
7612 then quit right away. */
7613 if (immediate_quit && NILP (Vinhibit_quit))
7614 {
7615 immediate_quit = 0;
7616 sigfree ();
7617 Fsignal (Qquit, Qnil);
7618 }
7619 else
7620 /* Else request quit when it's safe */
7621 Vquit_flag = Qt;
7622 }
7623
7624 if (waiting_for_input && !echoing)
7625 quit_throw_to_read_char ();
7626
7627 errno = old_errno;
7628}
7629
7630/* Handle a C-g by making read_char return C-g. */
7631
7632quit_throw_to_read_char ()
7633{
7634 quit_error_check ();
7635 sigfree ();
7636 /* Prevent another signal from doing this before we finish. */
f76475ad 7637 clear_waiting_for_input ();
284f4730
JB
7638 input_pending = 0;
7639
24597608 7640 Vunread_command_events = Qnil;
86e5706b 7641 unread_command_char = -1;
284f4730 7642
087feab3
RS
7643#if 0 /* Currently, sit_for is called from read_char without turning
7644 off polling. And that can call set_waiting_for_input.
7645 It seems to be harmless. */
e6b01c14
JB
7646#ifdef POLL_FOR_INPUT
7647 /* May be > 1 if in recursive minibuffer. */
7648 if (poll_suppress_count == 0)
7649 abort ();
7650#endif
087feab3 7651#endif
4c52b668
KH
7652 if (FRAMEP (internal_last_event_frame)
7653 && XFRAME (internal_last_event_frame) != selected_frame)
719191cf
RS
7654 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame),
7655 Qnil, 0);
e6b01c14 7656
284f4730
JB
7657 _longjmp (getcjmp, 1);
7658}
7659\f
7660DEFUN ("set-input-mode", Fset_input_mode, Sset_input_mode, 3, 4, 0,
7661 "Set mode of reading keyboard input.\n\
464f8898
RS
7662First arg INTERRUPT non-nil means use input interrupts;\n\
7663 nil means use CBREAK mode.\n\
7664Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
284f4730 7665 (no effect except in CBREAK mode).\n\
b04904fb
RS
7666Third arg META t means accept 8-bit input (for a Meta key).\n\
7667 META nil means ignore the top bit, on the assumption it is parity.\n\
7668 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
a8ee7ef9
RS
7669Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
7670See also `current-input-mode'.")
284f4730
JB
7671 (interrupt, flow, meta, quit)
7672 Lisp_Object interrupt, flow, meta, quit;
7673{
7674 if (!NILP (quit)
8c18cbfb 7675 && (!INTEGERP (quit) || XINT (quit) < 0 || XINT (quit) > 0400))
34f04431
RS
7676 error ("set-input-mode: QUIT must be an ASCII character");
7677
7678#ifdef POLL_FOR_INPUT
7679 stop_polling ();
7680#endif
284f4730 7681
2ee250ec
RS
7682#ifndef MSDOS
7683 /* this causes startup screen to be restored and messes with the mouse */
284f4730 7684 reset_sys_modes ();
2ee250ec
RS
7685#endif
7686
284f4730
JB
7687#ifdef SIGIO
7688/* Note SIGIO has been undef'd if FIONREAD is missing. */
284f4730 7689 if (read_socket_hook)
9a0f60bb
KH
7690 {
7691 /* When using X, don't give the user a real choice,
7692 because we haven't implemented the mechanisms to support it. */
7693#ifdef NO_SOCK_SIGIO
7694 interrupt_input = 0;
7695#else /* not NO_SOCK_SIGIO */
7696 interrupt_input = 1;
284f4730 7697#endif /* NO_SOCK_SIGIO */
9a0f60bb
KH
7698 }
7699 else
284f4730
JB
7700 interrupt_input = !NILP (interrupt);
7701#else /* not SIGIO */
7702 interrupt_input = 0;
7703#endif /* not SIGIO */
9a0f60bb 7704
284f4730
JB
7705/* Our VMS input only works by interrupts, as of now. */
7706#ifdef VMS
7707 interrupt_input = 1;
7708#endif
9a0f60bb 7709
284f4730 7710 flow_control = !NILP (flow);
b04904fb
RS
7711 if (NILP (meta))
7712 meta_key = 0;
7713 else if (EQ (meta, Qt))
7714 meta_key = 1;
7715 else
7716 meta_key = 2;
284f4730
JB
7717 if (!NILP (quit))
7718 /* Don't let this value be out of range. */
7719 quit_char = XINT (quit) & (meta_key ? 0377 : 0177);
7720
2ee250ec 7721#ifndef MSDOS
284f4730 7722 init_sys_modes ();
2ee250ec 7723#endif
34f04431
RS
7724
7725#ifdef POLL_FOR_INPUT
7726 poll_suppress_count = 1;
7727 start_polling ();
7728#endif
284f4730
JB
7729 return Qnil;
7730}
80645119
JB
7731
7732DEFUN ("current-input-mode", Fcurrent_input_mode, Scurrent_input_mode, 0, 0, 0,
7733 "Return information about the way Emacs currently reads keyboard input.\n\
7734The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
7735 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
7736 nil, Emacs is using CBREAK mode.\n\
7737 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
7738 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
a8ee7ef9
RS
7739 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
7740 META nil means ignoring the top bit, on the assumption it is parity.\n\
7741 META is neither t nor nil if accepting 8-bit input and using\n\
7742 all 8 bits as the character code.\n\
80645119
JB
7743 QUIT is the character Emacs currently uses to quit.\n\
7744The elements of this list correspond to the arguments of\n\
a8ee7ef9 7745`set-input-mode'.")
80645119
JB
7746 ()
7747{
7748 Lisp_Object val[4];
7749
7750 val[0] = interrupt_input ? Qt : Qnil;
7751 val[1] = flow_control ? Qt : Qnil;
a8ee7ef9 7752 val[2] = meta_key == 2 ? make_number (0) : meta_key == 1 ? Qt : Qnil;
bb9e9bed 7753 XSETFASTINT (val[3], quit_char);
80645119 7754
bf673a7a 7755 return Flist (sizeof (val) / sizeof (val[0]), val);
80645119
JB
7756}
7757
284f4730 7758\f
6c6083a9 7759/*
c5fdd383 7760 * Set up a new kboard object with reasonable initial values.
6c6083a9
KH
7761 */
7762void
c5fdd383
KH
7763init_kboard (kb)
7764 KBOARD *kb;
6c6083a9 7765{
217258d5 7766 kb->Voverriding_terminal_local_map = Qnil;
6c7178b9 7767 kb->Vlast_command = Qnil;
d8bcf58e 7768 kb->Vprefix_arg = Qnil;
c5fdd383
KH
7769 kb->kbd_queue = Qnil;
7770 kb->kbd_queue_has_data = 0;
7771 kb->immediate_echo = 0;
7772 kb->echoptr = kb->echobuf;
7773 kb->echo_after_prompt = -1;
7774 kb->kbd_macro_buffer = 0;
7775 kb->kbd_macro_bufsize = 0;
7776 kb->defining_kbd_macro = Qnil;
7777 kb->Vlast_kbd_macro = Qnil;
7778 kb->reference_count = 0;
7c97ffdc 7779 kb->Vsystem_key_alist = Qnil;
142e6c73 7780 kb->system_key_syms = Qnil;
9ba47203 7781 kb->Vdefault_minibuffer_frame = Qnil;
6c6083a9
KH
7782}
7783
7784/*
c5fdd383 7785 * Destroy the contents of a kboard object, but not the object itself.
8e6208c5 7786 * We use this just before deleting it, or if we're going to initialize
6c6083a9
KH
7787 * it a second time.
7788 */
e50b8090 7789static void
c5fdd383
KH
7790wipe_kboard (kb)
7791 KBOARD *kb;
6c6083a9 7792{
c5fdd383
KH
7793 if (kb->kbd_macro_buffer)
7794 xfree (kb->kbd_macro_buffer);
6c6083a9
KH
7795}
7796
e50b8090
KH
7797#ifdef MULTI_KBOARD
7798void
7799delete_kboard (kb)
7800 KBOARD *kb;
7801{
7802 KBOARD **kbp;
7803 for (kbp = &all_kboards; *kbp != kb; kbp = &(*kbp)->next_kboard)
7804 if (*kbp == NULL)
7805 abort ();
7806 *kbp = kb->next_kboard;
7807 wipe_kboard (kb);
7808 xfree (kb);
7809}
7810#endif
7811
284f4730
JB
7812init_keyboard ()
7813{
284f4730
JB
7814 /* This is correct before outermost invocation of the editor loop */
7815 command_loop_level = -1;
7816 immediate_quit = 0;
7817 quit_char = Ctl ('g');
24597608 7818 Vunread_command_events = Qnil;
86e5706b 7819 unread_command_char = -1;
87dd9b9b 7820 EMACS_SET_SECS_USECS (timer_idleness_start_time, -1, -1);
284f4730 7821 total_keys = 0;
9deb415a 7822 recent_keys_index = 0;
beecf6a1
KH
7823 kbd_fetch_ptr = kbd_buffer;
7824 kbd_store_ptr = kbd_buffer;
7825 kbd_buffer_frame_or_window
7826 = Fmake_vector (make_number (KBD_BUFFER_SIZE), Qnil);
2eb6bfbe 7827#ifdef HAVE_MOUSE
a9d77f1f 7828 do_mouse_tracking = Qnil;
2eb6bfbe 7829#endif
284f4730
JB
7830 input_pending = 0;
7831
4c52b668
KH
7832 /* This means that command_loop_1 won't try to select anything the first
7833 time through. */
7834 internal_last_event_frame = Qnil;
7835 Vlast_event_frame = internal_last_event_frame;
4c52b668 7836
c5fdd383 7837#ifdef MULTI_KBOARD
aaca43a1 7838 current_kboard = initial_kboard;
6c6083a9 7839#endif
aaca43a1 7840 wipe_kboard (current_kboard);
c5fdd383 7841 init_kboard (current_kboard);
07d2b8de 7842
beecf6a1
KH
7843 if (initialized)
7844 Ffillarray (kbd_buffer_frame_or_window, Qnil);
7845
7846 kbd_buffer_frame_or_window
7847 = Fmake_vector (make_number (KBD_BUFFER_SIZE), Qnil);
7a80a6f6 7848 if (!noninteractive && !read_socket_hook && NILP (Vwindow_system))
284f4730
JB
7849 {
7850 signal (SIGINT, interrupt_signal);
cb5df6ae 7851#if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
284f4730
JB
7852 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
7853 SIGQUIT and we can't tell which one it will give us. */
7854 signal (SIGQUIT, interrupt_signal);
7855#endif /* HAVE_TERMIO */
7a80a6f6 7856 }
284f4730
JB
7857/* Note SIGIO has been undef'd if FIONREAD is missing. */
7858#ifdef SIGIO
7a80a6f6
RS
7859 if (!noninteractive)
7860 signal (SIGIO, input_available_signal);
8ea0a720 7861#endif /* SIGIO */
284f4730
JB
7862
7863/* Use interrupt input by default, if it works and noninterrupt input
7864 has deficiencies. */
7865
7866#ifdef INTERRUPT_INPUT
7867 interrupt_input = 1;
7868#else
7869 interrupt_input = 0;
7870#endif
7871
7872/* Our VMS input only works by interrupts, as of now. */
7873#ifdef VMS
7874 interrupt_input = 1;
7875#endif
7876
7877 sigfree ();
7878 dribble = 0;
7879
7880 if (keyboard_init_hook)
7881 (*keyboard_init_hook) ();
7882
7883#ifdef POLL_FOR_INPUT
7884 poll_suppress_count = 1;
7885 start_polling ();
7886#endif
7887}
7888
df0f2ba1 7889/* This type's only use is in syms_of_keyboard, to initialize the
284f4730
JB
7890 event header symbols and put properties on them. */
7891struct event_head {
7892 Lisp_Object *var;
7893 char *name;
7894 Lisp_Object *kind;
7895};
7896
7897struct event_head head_table[] = {
7b4aedb9 7898 &Qmouse_movement, "mouse-movement", &Qmouse_movement,
3c370943 7899 &Qscroll_bar_movement, "scroll-bar-movement", &Qmouse_movement,
7b4aedb9 7900 &Qswitch_frame, "switch-frame", &Qswitch_frame,
bbdc2092 7901 &Qdelete_frame, "delete-frame", &Qdelete_frame,
af17bd2b
KH
7902 &Qiconify_frame, "iconify-frame", &Qiconify_frame,
7903 &Qmake_frame_visible, "make-frame-visible", &Qmake_frame_visible,
284f4730
JB
7904};
7905
7906syms_of_keyboard ()
7907{
d925fb39
RS
7908 Qtimer_event_handler = intern ("timer-event-handler");
7909 staticpro (&Qtimer_event_handler);
7910
2e894dab
RS
7911 Qdisabled_command_hook = intern ("disabled-command-hook");
7912 staticpro (&Qdisabled_command_hook);
7913
284f4730
JB
7914 Qself_insert_command = intern ("self-insert-command");
7915 staticpro (&Qself_insert_command);
7916
7917 Qforward_char = intern ("forward-char");
7918 staticpro (&Qforward_char);
7919
7920 Qbackward_char = intern ("backward-char");
7921 staticpro (&Qbackward_char);
7922
7923 Qdisabled = intern ("disabled");
7924 staticpro (&Qdisabled);
7925
e58aa385
RS
7926 Qundefined = intern ("undefined");
7927 staticpro (&Qundefined);
7928
86e5706b
RS
7929 Qpre_command_hook = intern ("pre-command-hook");
7930 staticpro (&Qpre_command_hook);
7931
7932 Qpost_command_hook = intern ("post-command-hook");
7933 staticpro (&Qpost_command_hook);
7934
59aadc81
RS
7935 Qpost_command_idle_hook = intern ("post-command-idle-hook");
7936 staticpro (&Qpost_command_idle_hook);
7937
3ef14e46
RS
7938 Qdeferred_action_function = intern ("deferred-action-function");
7939 staticpro (&Qdeferred_action_function);
7940
40932d1a
RS
7941 Qcommand_hook_internal = intern ("command-hook-internal");
7942 staticpro (&Qcommand_hook_internal);
7943
284f4730
JB
7944 Qfunction_key = intern ("function-key");
7945 staticpro (&Qfunction_key);
13b5e56c 7946 Qmouse_click = intern ("mouse-click");
284f4730 7947 staticpro (&Qmouse_click);
284f4730 7948
598a9fa7
JB
7949 Qmenu_enable = intern ("menu-enable");
7950 staticpro (&Qmenu_enable);
7951
284f4730
JB
7952 Qmode_line = intern ("mode-line");
7953 staticpro (&Qmode_line);
e5d77022
JB
7954 Qvertical_line = intern ("vertical-line");
7955 staticpro (&Qvertical_line);
3c370943
JB
7956 Qvertical_scroll_bar = intern ("vertical-scroll-bar");
7957 staticpro (&Qvertical_scroll_bar);
5ec75a55
RS
7958 Qmenu_bar = intern ("menu-bar");
7959 staticpro (&Qmenu_bar);
4bb994d1
JB
7960
7961 Qabove_handle = intern ("above-handle");
7962 staticpro (&Qabove_handle);
7963 Qhandle = intern ("handle");
7964 staticpro (&Qhandle);
7965 Qbelow_handle = intern ("below-handle");
7966 staticpro (&Qbelow_handle);
db08707d
RS
7967 Qup = intern ("up");
7968 staticpro (&Qup);
7969 Qdown = intern ("down");
7970 staticpro (&Qdown);
284f4730 7971
cd21b839 7972 Qevent_kind = intern ("event-kind");
284f4730 7973 staticpro (&Qevent_kind);
88cb0656
JB
7974 Qevent_symbol_elements = intern ("event-symbol-elements");
7975 staticpro (&Qevent_symbol_elements);
0a7f1fc0
JB
7976 Qevent_symbol_element_mask = intern ("event-symbol-element-mask");
7977 staticpro (&Qevent_symbol_element_mask);
7978 Qmodifier_cache = intern ("modifier-cache");
7979 staticpro (&Qmodifier_cache);
284f4730 7980
48e416d4
RS
7981 Qrecompute_lucid_menubar = intern ("recompute-lucid-menubar");
7982 staticpro (&Qrecompute_lucid_menubar);
7983 Qactivate_menubar_hook = intern ("activate-menubar-hook");
7984 staticpro (&Qactivate_menubar_hook);
7985
f4eef8b4
RS
7986 Qpolling_period = intern ("polling-period");
7987 staticpro (&Qpolling_period);
7988
284f4730
JB
7989 {
7990 struct event_head *p;
7991
7992 for (p = head_table;
7993 p < head_table + (sizeof (head_table) / sizeof (head_table[0]));
7994 p++)
7995 {
7996 *p->var = intern (p->name);
7997 staticpro (p->var);
7998 Fput (*p->var, Qevent_kind, *p->kind);
88cb0656 7999 Fput (*p->var, Qevent_symbol_elements, Fcons (*p->var, Qnil));
284f4730
JB
8000 }
8001 }
8002
7b4aedb9
JB
8003 button_down_location = Fmake_vector (make_number (NUM_MOUSE_BUTTONS), Qnil);
8004 staticpro (&button_down_location);
88cb0656
JB
8005
8006 {
8007 int i;
8008 int len = sizeof (modifier_names) / sizeof (modifier_names[0]);
8009
8010 modifier_symbols = Fmake_vector (make_number (len), Qnil);
8011 for (i = 0; i < len; i++)
86e5706b
RS
8012 if (modifier_names[i])
8013 XVECTOR (modifier_symbols)->contents[i] = intern (modifier_names[i]);
88cb0656
JB
8014 staticpro (&modifier_symbols);
8015 }
8016
9deb415a
JB
8017 recent_keys = Fmake_vector (make_number (NUM_RECENT_KEYS), Qnil);
8018 staticpro (&recent_keys);
8019
6569cc8d 8020 this_command_keys = Fmake_vector (make_number (40), Qnil);
715d9345 8021 staticpro (&this_command_keys);
6569cc8d 8022
03b4122a
BF
8023 Qextended_command_history = intern ("extended-command-history");
8024 Fset (Qextended_command_history, Qnil);
8025 staticpro (&Qextended_command_history);
8026
beecf6a1
KH
8027 kbd_buffer_frame_or_window
8028 = Fmake_vector (make_number (KBD_BUFFER_SIZE), Qnil);
8029 staticpro (&kbd_buffer_frame_or_window);
8030
24597608
RS
8031 accent_key_syms = Qnil;
8032 staticpro (&accent_key_syms);
8033
284f4730
JB
8034 func_key_syms = Qnil;
8035 staticpro (&func_key_syms);
8036
8037 mouse_syms = Qnil;
8038 staticpro (&mouse_syms);
8039
cd21b839
JB
8040 unread_switch_frame = Qnil;
8041 staticpro (&unread_switch_frame);
8042
fe412364
EN
8043 internal_last_event_frame = Qnil;
8044 staticpro (&internal_last_event_frame);
8045
8046 read_key_sequence_cmd = Qnil;
8047 staticpro (&read_key_sequence_cmd);
8048
a1706c30 8049 defsubr (&Sevent_convert_list);
284f4730
JB
8050 defsubr (&Sread_key_sequence);
8051 defsubr (&Srecursive_edit);
2eb6bfbe 8052#ifdef HAVE_MOUSE
284f4730 8053 defsubr (&Strack_mouse);
2eb6bfbe 8054#endif
284f4730
JB
8055 defsubr (&Sinput_pending_p);
8056 defsubr (&Scommand_execute);
8057 defsubr (&Srecent_keys);
8058 defsubr (&Sthis_command_keys);
6321824f 8059 defsubr (&Sthis_single_command_keys);
71918b75 8060 defsubr (&Sreset_this_command_lengths);
284f4730
JB
8061 defsubr (&Ssuspend_emacs);
8062 defsubr (&Sabort_recursive_edit);
8063 defsubr (&Sexit_recursive_edit);
8064 defsubr (&Srecursion_depth);
8065 defsubr (&Stop_level);
8066 defsubr (&Sdiscard_input);
8067 defsubr (&Sopen_dribble_file);
8068 defsubr (&Sset_input_mode);
80645119 8069 defsubr (&Scurrent_input_mode);
284f4730
JB
8070 defsubr (&Sexecute_extended_command);
8071
284f4730 8072 DEFVAR_LISP ("last-command-char", &last_command_char,
86e5706b
RS
8073 "Last input event that was part of a command.");
8074
186cf719 8075 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char,
86e5706b 8076 "Last input event that was part of a command.");
284f4730 8077
7d6de002 8078 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event,
86e5706b 8079 "Last input event in a command, except for mouse menu events.\n\
7d6de002
RS
8080Mouse menus give back keys that don't look like mouse events;\n\
8081this variable holds the actual mouse event that led to the menu,\n\
8082so that you can determine whether the command was run by mouse or not.");
8083
284f4730 8084 DEFVAR_LISP ("last-input-char", &last_input_char,
86e5706b
RS
8085 "Last input event.");
8086
186cf719 8087 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char,
86e5706b 8088 "Last input event.");
284f4730 8089
24597608 8090 DEFVAR_LISP ("unread-command-events", &Vunread_command_events,
1c07d0a6 8091 "List of objects to be read as next command input events.");
284f4730 8092
86e5706b
RS
8093 DEFVAR_INT ("unread-command-char", &unread_command_char,
8094 "If not -1, an object to be read as next command input event.");
8095
284f4730
JB
8096 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char,
8097 "Meta-prefix character code. Meta-foo as command input\n\
8098turns into this character followed by foo.");
18cd2eeb 8099 XSETINT (meta_prefix_char, 033);
284f4730 8100
6c7178b9 8101 DEFVAR_KBOARD ("last-command", Vlast_command,
284f4730
JB
8102 "The last command executed. Normally a symbol with a function definition,\n\
8103but can be whatever was found in the keymap, or whatever the variable\n\
18f29056
RS
8104`this-command' was set to by that command.\n\
8105\n\
8106The value `mode-exit' is special; it means that the previous command\n\
8107read an event that told it to exit, and it did so and unread that event.\n\
8108In other words, the present command is the event that made the previous\n\
8109command exit.\n\
8110\n\
8111The value `kill-region' is special; it means that the previous command\n\
8112was a kill command.");
284f4730
JB
8113
8114 DEFVAR_LISP ("this-command", &this_command,
8115 "The command now being executed.\n\
8116The command can set this variable; whatever is put here\n\
8117will be in `last-command' during the following command.");
8118 this_command = Qnil;
8119
8120 DEFVAR_INT ("auto-save-interval", &auto_save_interval,
8121 "*Number of keyboard input characters between auto-saves.\n\
8122Zero means disable autosaving due to number of characters typed.");
8123 auto_save_interval = 300;
8124
8125 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout,
8126 "*Number of seconds idle time before auto-save.\n\
06ef7355
RS
8127Zero or nil means disable auto-saving due to idleness.\n\
8128After auto-saving due to this many seconds of idle time,\n\
84447c71 8129Emacs also does a garbage collection if that seems to be warranted.");
bb9e9bed 8130 XSETFASTINT (Vauto_save_timeout, 30);
284f4730
JB
8131
8132 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes,
8133 "*Nonzero means echo unfinished commands after this many seconds of pause.");
8134 echo_keystrokes = 1;
8135
8136 DEFVAR_INT ("polling-period", &polling_period,
8137 "*Interval between polling for input during Lisp execution.\n\
8138The reason for polling is to make C-g work to stop a running program.\n\
8139Polling is needed only when using X windows and SIGIO does not work.\n\
8140Polling is automatically disabled in all other cases.");
8141 polling_period = 2;
df0f2ba1 8142
564dc952 8143 DEFVAR_LISP ("double-click-time", &Vdouble_click_time,
fbcd35bd 8144 "*Maximum time between mouse clicks to make a double-click.\n\
564dc952
JB
8145Measured in milliseconds. nil means disable double-click recognition;\n\
8146t means double-clicks have no time limit and are detected\n\
fbcd35bd 8147by position only.");
aab06933 8148 Vdouble_click_time = make_number (500);
fbcd35bd 8149
03361bcc
RS
8150 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus,
8151 "*Non-nil means inhibit local map menu bar menus.");
8152 inhibit_local_menu_bar_menus = 0;
8153
284f4730 8154 DEFVAR_INT ("num-input-keys", &num_input_keys,
c43b1734 8155 "Number of complete key sequences read as input so far.\n\
58ce35fb
KH
8156This includes key sequences read from keyboard macros.\n\
8157The number is effectively the number of interactive command invocations.");
284f4730
JB
8158 num_input_keys = 0;
8159
c43b1734
RS
8160 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events,
8161 "Number of input events read from the keyboard so far.\n\
8162This does not include events generated by keyboard macros.");
8163 num_nonmacro_input_events = 0;
fa90970d 8164
4c52b668
KH
8165 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame,
8166 "The frame in which the most recently read event occurred.\n\
8167If the last event came from a keyboard macro, this is set to `macro'.");
8168 Vlast_event_frame = Qnil;
8169
fa90970d
RS
8170 /* This variable is set up in sysdep.c. */
8171 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char,
8172 "The ERASE character as set by the user with stty.");
8173
7e85b935 8174 DEFVAR_LISP ("help-char", &Vhelp_char,
284f4730
JB
8175 "Character to recognize as meaning Help.\n\
8176When it is read, do `(eval help-form)', and display result if it's a string.\n\
8177If the value of `help-form' is nil, this char can be read normally.");
18cd2eeb 8178 XSETINT (Vhelp_char, Ctl ('H'));
284f4730 8179
ecb7cb34
KH
8180 DEFVAR_LISP ("help-event-list", &Vhelp_event_list,
8181 "List of input events to recognize as meaning Help.\n\
8182These work just like the value of `help-char' (see that).");
8183 Vhelp_event_list = Qnil;
8184
284f4730 8185 DEFVAR_LISP ("help-form", &Vhelp_form,
7e85b935 8186 "Form to execute when character `help-char' is read.\n\
284f4730
JB
8187If the form returns a string, that string is displayed.\n\
8188If `help-form' is nil, the help char is not recognized.");
8189 Vhelp_form = Qnil;
8190
7e85b935
RS
8191 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command,
8192 "Command to run when `help-char' character follows a prefix key.\n\
8193This command is used only when there is no actual binding\n\
8194for that character after that prefix key.");
8195 Vprefix_help_command = Qnil;
8196
284f4730
JB
8197 DEFVAR_LISP ("top-level", &Vtop_level,
8198 "Form to evaluate when Emacs starts up.\n\
8199Useful to set before you dump a modified Emacs.");
8200 Vtop_level = Qnil;
8201
8202 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table,
f9414d62 8203 "Translate table for keyboard input, or nil.\n\
284f4730 8204Each character is looked up in this string and the contents used instead.\n\
f9414d62
RS
8205The value may be a string, a vector, or a char-table.\n\
8206If it is a string or vector of length N,\n\
8207character codes N and up are untranslated.\n\
8208In a vector or a char-table, an element which is nil means \"no translation\".");
284f4730
JB
8209 Vkeyboard_translate_table = Qnil;
8210
8026024c
KH
8211 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend,
8212 "Non-nil means to always spawn a subshell instead of suspending,\n\
8213even if the operating system has support for stopping a process.");
8214 cannot_suspend = 0;
8215
284f4730 8216 DEFVAR_BOOL ("menu-prompting", &menu_prompting,
7d6de002 8217 "Non-nil means prompt with menus when appropriate.\n\
284f4730 8218This is done when reading from a keymap that has a prompt string,\n\
7d6de002
RS
8219for elements that have prompt strings.\n\
8220The menu is displayed on the screen\n\
8221if X menus were enabled at configuration\n\
8222time and the previous event was a mouse click prefix key.\n\
8223Otherwise, menu prompting uses the echo area.");
284f4730
JB
8224 menu_prompting = 1;
8225
8226 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char,
8227 "Character to see next line of menu prompt.\n\
8228Type this character while in a menu prompt to rotate around the lines of it.");
18cd2eeb 8229 XSETINT (menu_prompt_more_char, ' ');
9fa4395d
RS
8230
8231 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers,
8232 "A mask of additional modifier keys to use with every keyboard character.\n\
ad163903
JB
8233Emacs applies the modifiers of the character stored here to each keyboard\n\
8234character it reads. For example, after evaluating the expression\n\
9d9f56dd 8235 (setq extra-keyboard-modifiers ?\\C-x)\n\
80645119
JB
8236all input characters will have the control modifier applied to them.\n\
8237\n\
9d9f56dd 8238Note that the character ?\\C-@, equivalent to the integer zero, does\n\
80645119 8239not count as a control character; rather, it counts as a character\n\
27203ead 8240with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
80645119 8241cancels any modification.");
9fa4395d 8242 extra_keyboard_modifiers = 0;
86e5706b
RS
8243
8244 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark,
8245 "If an editing command sets this to t, deactivate the mark afterward.\n\
8246The command loop sets this to nil before each command,\n\
8247and tests the value when the command returns.\n\
8248Buffer modification stores t in this variable.");
8249 Vdeactivate_mark = Qnil;
8250
b0f2a7bf
KH
8251 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal,
8252 "Temporary storage of pre-command-hook or post-command-hook.");
8253 Vcommand_hook_internal = Qnil;
8254
86e5706b 8255 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook,
a1fd42c0 8256 "Normal hook run before each command is executed.\n\
59aadc81 8257Errors running the hook are caught and ignored.");
86e5706b
RS
8258 Vpre_command_hook = Qnil;
8259
8260 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook,
a1fd42c0 8261 "Normal hook run after each command is executed.\n\
59aadc81 8262Errors running the hook are caught and ignored.");
86e5706b 8263 Vpost_command_hook = Qnil;
48e416d4 8264
59aadc81
RS
8265 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook,
8266 "Normal hook run after each command is executed, if idle.\n\
d4d62e8d
RS
8267Errors running the hook are caught and ignored.\n\
8268This feature is obsolete; use idle timers instead. See `etc/NEWS'.");
59aadc81
RS
8269 Vpost_command_idle_hook = Qnil;
8270
8271 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay,
7051b69b 8272 "Delay time before running `post-command-idle-hook'.\n\
59aadc81
RS
8273This is measured in microseconds.");
8274 post_command_idle_delay = 100000;
8275
cdb9d665
RS
8276#if 0
8277 DEFVAR_LISP ("echo-area-clear-hook", ...,
8278 "Normal hook run when clearing the echo area.");
8279#endif
8280 Qecho_area_clear_hook = intern ("echo-area-clear-hook");
8281 XSYMBOL (Qecho_area_clear_hook)->value = Qnil;
8282
48e416d4
RS
8283 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag,
8284 "t means menu bar, specified Lucid style, needs to be recomputed.");
8285 Vlucid_menu_bar_dirty_flag = Qnil;
a73c5e29 8286
9f9c0e27
RS
8287 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items,
8288 "List of menu bar items to move to the end of the menu bar.\n\
a612e298 8289The elements of the list are event types that may have menu bar bindings.");
9f9c0e27 8290 Vmenu_bar_final_items = Qnil;
e9bf89a0 8291
217258d5
KH
8292 DEFVAR_KBOARD ("overriding-terminal-local-map",
8293 Voverriding_terminal_local_map,
779b34df 8294 "Per-terminal keymap that overrides all other local keymaps.\n\
217258d5 8295If this variable is non-nil, it is used as a keymap instead of the\n\
779b34df
RS
8296buffer's local map, and the minor mode keymaps and text property keymaps.\n\
8297This variable is intended to let commands such as `universal-argumemnt'\n\
8298set up a different keymap for reading the next command.");
217258d5 8299
9dd3131c
RS
8300 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map,
8301 "Keymap that overrides all other local keymaps.\n\
8302If this variable is non-nil, it is used as a keymap instead of the\n\
8303buffer's local map, and the minor mode keymaps and text property keymaps.");
8304 Voverriding_local_map = Qnil;
8305
d0a49716
RS
8306 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag,
8307 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
8308Otherwise, the menu bar continues to reflect the buffer's local map\n\
8309and the minor mode maps regardless of `overriding-local-map'.");
8310 Voverriding_local_map_menu_flag = Qnil;
8311
7f07d5ca
RS
8312 DEFVAR_LISP ("special-event-map", &Vspecial_event_map,
8313 "Keymap defining bindings for special events to execute at low level.");
8314 Vspecial_event_map = Fcons (intern ("keymap"), Qnil);
8315
71edead1 8316 DEFVAR_LISP ("track-mouse", &do_mouse_tracking,
a53c7666 8317 "*Non-nil means generate motion events for mouse motion.");
80e4aa30 8318
7c97ffdc 8319 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist,
270a208f 8320 "Alist of system-specific X windows key symbols.\n\
80e4aa30 8321Each element should have the form (N . SYMBOL) where N is the\n\
270a208f 8322numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
80e4aa30 8323and SYMBOL is its name.");
8a792f3a
RS
8324
8325 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list,
8326 "List of deferred actions to be performed at a later time.\n\
8327The precise format isn't relevant here; we just check whether it is nil.");
8328 Vdeferred_action_list = Qnil;
8329
8330 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function,
8331 "Function to call to handle deferred actions, after each command.\n\
8332This function is called with no arguments after each command\n\
8333whenever `deferred-action-list' is non-nil.");
8334 Vdeferred_action_function = Qnil;
6526ab49
RS
8335
8336 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings,
8337 "Non-nil means show the equivalent key-binding when M-x command has one.\n\
8338The value can be a length of time to show the message for.\n\
8339If the value is non-nil and not a number, we wait 2 seconds.");
8340 Vsuggest_key_bindings = Qt;
8bb1c042 8341
c04cbc3b 8342 DEFVAR_LISP ("timer-list", &Vtimer_list,
d9d4c147 8343 "List of active absolute time timers in order of increasing time");
c04cbc3b 8344 Vtimer_list = Qnil;
d9d4c147
KH
8345
8346 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list,
8347 "List of active idle-time timers in order of increasing time");
8348 Vtimer_idle_list = Qnil;
284f4730
JB
8349}
8350
8351keys_of_keyboard ()
8352{
8353 initial_define_key (global_map, Ctl ('Z'), "suspend-emacs");
8354 initial_define_key (control_x_map, Ctl ('Z'), "suspend-emacs");
8355 initial_define_key (meta_map, Ctl ('C'), "exit-recursive-edit");
8356 initial_define_key (global_map, Ctl (']'), "abort-recursive-edit");
8357 initial_define_key (meta_map, 'x', "execute-extended-command");
7f07d5ca
RS
8358
8359 initial_define_lispy_key (Vspecial_event_map, "delete-frame",
8360 "handle-delete-frame");
8361 initial_define_lispy_key (Vspecial_event_map, "iconify-frame",
8362 "ignore-event");
8363 initial_define_lispy_key (Vspecial_event_map, "make-frame-visible",
8364 "ignore-event");
284f4730 8365}