(put-string-on-kill-ring): Delete this function.
[bpt/emacs.git] / src / keyboard.c
CommitLineData
284f4730 1/* Keyboard and mouse input; editor command loop.
3a22ee35 2 Copyright (C) 1985,86,87,88,89,93,94 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
18the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
19
20/* Allow config.h to undefine symbols found here. */
21#include <signal.h>
22
18160b98 23#include <config.h>
284f4730
JB
24#include <stdio.h>
25#undef NULL
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"
35#include "disptab.h"
f4255cd1 36#include "dispextern.h"
284f4730 37#include "keyboard.h"
497ba7a1 38#include "intervals.h"
9ac0d9e0 39#include "blockinput.h"
284f4730
JB
40#include <setjmp.h>
41#include <errno.h>
42
80e4aa30
RS
43#ifdef MSDOS
44#include "msdos.h"
45#include <time.h>
46#else /* not MSDOS */
284f4730
JB
47#ifndef VMS
48#include <sys/ioctl.h>
284f4730 49#endif
80e4aa30 50#endif /* not MSDOS */
284f4730 51
52baf19e 52#include "syssignal.h"
6ef5b54f 53#include "systty.h"
52baf19e 54
c5e3b6c5
RS
55/* This is to get the definitions of the XK_ symbols. */
56#ifdef HAVE_X_WINDOWS
57#include "xterm.h"
58#endif
59
0c2611c5
RS
60/* Include systime.h after xterm.h to avoid double inclusion of time.h. */
61#include "systime.h"
62
52baf19e
JB
63extern int errno;
64
9ac0d9e0
JB
65/* Variables for blockinput.h: */
66
67/* Non-zero if interrupt input is blocked right now. */
63927c41 68int interrupt_input_blocked;
9ac0d9e0
JB
69
70/* Nonzero means an input interrupt has arrived
71 during the current critical section. */
63927c41 72int interrupt_input_pending;
9ac0d9e0
JB
73
74
284f4730
JB
75#ifdef HAVE_X_WINDOWS
76extern Lisp_Object Vmouse_grabbed;
77
78/* Make all keyboard buffers much bigger when using X windows. */
79#define KBD_BUFFER_SIZE 4096
80#else /* No X-windows, character input */
81#define KBD_BUFFER_SIZE 256
82#endif /* No X-windows */
83
84/* Following definition copied from eval.c */
85
86struct backtrace
87 {
88 struct backtrace *next;
89 Lisp_Object *function;
90 Lisp_Object *args; /* Points to vector of args. */
91 int nargs; /* length of vector. If nargs is UNEVALLED,
92 args points to slot holding list of
93 unevalled args */
94 char evalargs;
95 };
96
97/* Non-nil disable property on a command means
98 do not execute it; call disabled-command-hook's value instead. */
2e894dab 99Lisp_Object Qdisabled, Qdisabled_command_hook;
284f4730
JB
100
101#define NUM_RECENT_KEYS (100)
102int recent_keys_index; /* Index for storing next element into recent_keys */
103int total_keys; /* Total number of elements stored into recent_keys */
5160df46 104Lisp_Object recent_keys; /* A vector, holding the last 100 keystrokes */
284f4730 105
6569cc8d
JB
106/* Vector holding the key sequence that invoked the current command.
107 It is reused for each command, and it may be longer than the current
108 sequence; this_command_key_count indicates how many elements
109 actually mean something.
110 It's easier to staticpro a single Lisp_Object than an array. */
111Lisp_Object this_command_keys;
112int this_command_key_count;
284f4730
JB
113
114extern int minbuf_level;
115
116extern struct backtrace *backtrace_list;
117
118/* Nonzero means do menu prompting. */
119static int menu_prompting;
120
121/* Character to see next line of menu prompt. */
122static Lisp_Object menu_prompt_more_char;
123
124/* For longjmp to where kbd input is being done. */
125static jmp_buf getcjmp;
126
127/* True while doing kbd input. */
128int waiting_for_input;
129
130/* True while displaying for echoing. Delays C-g throwing. */
131static int echoing;
132
80e4aa30 133/* Nonzero means C-g should cause immediate error-signal. */
284f4730
JB
134int immediate_quit;
135
136/* Character to recognize as the help char. */
7e85b935 137Lisp_Object Vhelp_char;
284f4730
JB
138
139/* Form to execute when help char is typed. */
140Lisp_Object Vhelp_form;
141
7e85b935
RS
142/* Command to run when the help character follows a prefix key. */
143Lisp_Object Vprefix_help_command;
144
9f9c0e27
RS
145/* List of items that should move to the end of the menu bar. */
146Lisp_Object Vmenu_bar_final_items;
a73c5e29 147
284f4730
JB
148/* Character that causes a quit. Normally C-g.
149
150 If we are running on an ordinary terminal, this must be an ordinary
151 ASCII char, since we want to make it our interrupt character.
152
153 If we are not running on an ordinary terminal, it still needs to be
154 an ordinary ASCII char. This character needs to be recognized in
155 the input interrupt handler. At this point, the keystroke is
156 represented as a struct input_event, while the desired quit
157 character is specified as a lispy event. The mapping from struct
158 input_events to lispy events cannot run in an interrupt handler,
159 and the reverse mapping is difficult for anything but ASCII
160 keystrokes.
161
162 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
163 ASCII character. */
164int quit_char;
165
166extern Lisp_Object current_global_map;
167extern int minibuf_level;
168
9dd3131c
RS
169/* If non-nil, this is a map that overrides all other local maps. */
170Lisp_Object Voverriding_local_map;
171
284f4730
JB
172/* Current depth in recursive edits. */
173int command_loop_level;
174
175/* Total number of times command_loop has read a key sequence. */
176int num_input_keys;
177
178/* Last input character read as a command. */
179Lisp_Object last_command_char;
180
7d6de002
RS
181/* Last input character read as a command, not counting menus
182 reached by the mouse. */
183Lisp_Object last_nonmenu_event;
184
284f4730
JB
185/* Last input character read for any purpose. */
186Lisp_Object last_input_char;
187
dbc4e1c1 188/* If not Qnil, a list of objects to be read as subsequent command input. */
24597608 189Lisp_Object Vunread_command_events;
284f4730 190
86e5706b
RS
191/* If not -1, an event to be read as subsequent command input. */
192int unread_command_char;
193
cd21b839
JB
194/* If not Qnil, this is a switch-frame event which we decided to put
195 off until the end of a key sequence. This should be read as the
dbc4e1c1 196 next command input, after any unread_command_events.
8f805655
JB
197
198 read_key_sequence uses this to delay switch-frame events until the
199 end of the key sequence; Fread_char uses it to put off switch-frame
200 events until a non-ASCII event is acceptable as input. */
201Lisp_Object unread_switch_frame;
cd21b839 202
9fa4395d
RS
203/* A mask of extra modifier bits to put into every keyboard char. */
204int extra_keyboard_modifiers;
205
284f4730
JB
206/* Char to use as prefix when a meta character is typed in.
207 This is bound on entry to minibuffer in case ESC is changed there. */
208
209Lisp_Object meta_prefix_char;
210
211/* Last size recorded for a current buffer which is not a minibuffer. */
212static int last_non_minibuf_size;
213
06ef7355 214/* Number of idle seconds before an auto-save and garbage collection. */
284f4730
JB
215static Lisp_Object Vauto_save_timeout;
216
217/* Total number of times read_char has returned. */
218int num_input_chars;
219
51172b6d
RS
220/* Total number of times read_char has returned, outside of macros. */
221int num_nonmacro_input_chars;
222
284f4730
JB
223/* Auto-save automatically when this many characters have been typed
224 since the last time. */
225
226static int auto_save_interval;
227
51172b6d 228/* Value of num_nonmacro_input_chars as of last auto save. */
284f4730
JB
229
230int last_auto_save;
231
232/* Last command executed by the editor command loop, not counting
233 commands that set the prefix argument. */
234
235Lisp_Object last_command;
236
237/* The command being executed by the command loop.
238 Commands may set this, and the value set will be copied into last_command
239 instead of the actual command. */
240Lisp_Object this_command;
241
b453f72e
KH
242/* The value of point when the last command was executed. */
243int last_point_position;
244
047688cb
RS
245/* The buffer that was current when the last command was started. */
246Lisp_Object last_point_position_buffer;
247
07d2b8de 248#ifdef MULTI_FRAME
fce33686 249/* The frame in which the last input event occurred, or Qmacro if the
3c370943
JB
250 last event came from a macro. We use this to determine when to
251 generate switch-frame events. This may be cleared by functions
252 like Fselect_frame, to make sure that a switch-frame event is
253 generated by the next character. */
254Lisp_Object internal_last_event_frame;
a974bea1 255#endif
3c370943
JB
256
257/* A user-visible version of the above, intended to allow users to
258 figure out where the last event came from, if the event doesn't
259 carry that information itself (i.e. if it was a character). */
ff11dfa1 260Lisp_Object Vlast_event_frame;
284f4730 261
1113d9db
JB
262/* The timestamp of the last input event we received from the X server.
263 X Windows wants this for selection ownership. */
284f4730
JB
264unsigned long last_event_timestamp;
265
266Lisp_Object Qself_insert_command;
267Lisp_Object Qforward_char;
268Lisp_Object Qbackward_char;
e58aa385 269Lisp_Object Qundefined;
284f4730
JB
270
271/* read_key_sequence stores here the command definition of the
272 key sequence that it reads. */
273Lisp_Object read_key_sequence_cmd;
274
275/* Form to evaluate (if non-nil) when Emacs is started. */
276Lisp_Object Vtop_level;
277
278/* User-supplied string to translate input characters through. */
279Lisp_Object Vkeyboard_translate_table;
280
281/* Keymap mapping ASCII function key sequences onto their preferred forms. */
282extern Lisp_Object Vfunction_key_map;
283
a612e298
RS
284/* Keymap mapping ASCII function key sequences onto their preferred forms. */
285Lisp_Object Vkey_translation_map;
286
86e5706b
RS
287/* Non-nil means deactivate the mark at end of this command. */
288Lisp_Object Vdeactivate_mark;
289
48e416d4
RS
290/* Menu bar specified in Lucid Emacs fashion. */
291
292Lisp_Object Vlucid_menu_bar_dirty_flag;
293Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;
294
86e5706b
RS
295/* Hooks to run before and after each command. */
296Lisp_Object Qpre_command_hook, Qpost_command_hook;
297Lisp_Object Vpre_command_hook, Vpost_command_hook;
40932d1a 298Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
86e5706b 299
8a792f3a
RS
300/* List of deferred actions to be performed at a later time.
301 The precise format isn't relevant here; we just check whether it is nil. */
302Lisp_Object Vdeferred_action_list;
303
304/* Function to call to handle deferred actions, when there are any. */
305Lisp_Object Vdeferred_action_function;
306
284f4730
JB
307/* File in which we write all commands we read. */
308FILE *dribble;
309
310/* Nonzero if input is available. */
311int input_pending;
312
b04904fb
RS
313/* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
314 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
315
284f4730
JB
316int meta_key;
317
318extern char *pending_malloc_warning;
319
320/* Circular buffer for pre-read keyboard input. */
321static struct input_event kbd_buffer[KBD_BUFFER_SIZE];
322
7b4aedb9 323/* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
4bb994d1 324
7b4aedb9
JB
325 The interrupt-level event handlers will never enqueue an event on a
326 frame which is not in Vframe_list, and once an event is dequeued,
3c370943
JB
327 internal_last_event_frame or the event itself points to the frame.
328 So that's all fine.
4bb994d1
JB
329
330 But while the event is sitting in the queue, it's completely
331 unprotected. Suppose the user types one command which will run for
332 a while and then delete a frame, and then types another event at
333 the frame that will be deleted, before the command gets around to
334 it. Suppose there are no references to this frame elsewhere in
335 Emacs, and a GC occurs before the second event is dequeued. Now we
336 have an event referring to a freed frame, which will crash Emacs
337 when it is dequeued.
338
3c370943 339 Similar things happen when an event on a scroll bar is enqueued; the
7b4aedb9 340 window may be deleted while the event is in the queue.
4bb994d1 341
7b4aedb9
JB
342 So, we use this vector to protect the frame_or_window field in the
343 event queue. That way, they'll be dequeued as dead frames or
344 windows, but still valid lisp objects.
345
346 If kbd_buffer[i].kind != no_event, then
347 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
348 == kbd_buffer[i].frame_or_window. */
349static Lisp_Object kbd_buffer_frame_or_window;
4bb994d1 350
284f4730
JB
351/* Pointer to next available character in kbd_buffer.
352 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
353 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
354 next available char is in kbd_buffer[0]. */
355static struct input_event *kbd_fetch_ptr;
356
357/* Pointer to next place to store character in kbd_buffer. This
358 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
359 character should go in kbd_buffer[0]. */
ff0b5f4c
JB
360#ifdef __STDC__
361volatile
362#endif
284f4730
JB
363static struct input_event *kbd_store_ptr;
364
365/* The above pair of variables forms a "queue empty" flag. When we
366 enqueue a non-hook event, we increment kbd_write_count. When we
367 dequeue a non-hook event, we increment kbd_read_count. We say that
4bb994d1 368 there is input available iff the two counters are not equal.
284f4730
JB
369
370 Why not just have a flag set and cleared by the enqueuing and
371 dequeuing functions? Such a flag could be screwed up by interrupts
372 at inopportune times. */
373
663258f2 374/* If this flag is non-zero, we check mouse_moved to see when the
4bb994d1 375 mouse moves, and motion events will appear in the input stream. If
663258f2
JB
376 it is zero, mouse motion is ignored. */
377static int do_mouse_tracking;
284f4730
JB
378
379/* The window system handling code should set this if the mouse has
380 moved since the last call to the mouse_position_hook. Calling that
381 hook should clear this. Code assumes that if this is set, it can
382 call mouse_position_hook to get the promised position, so don't set
383 it unless you're prepared to substantiate the claim! */
384int mouse_moved;
385
386/* True iff there is an event in kbd_buffer, or if mouse tracking is
387 enabled and there is a new mouse position in the mouse movement
388 buffer. Note that if this is false, that doesn't mean that there
389 is readable input; all the events in the queue might be button-up
390 events, and do_mouse_tracking might be off. */
391#define EVENT_QUEUES_EMPTY \
392 ((kbd_fetch_ptr == kbd_store_ptr) && (!do_mouse_tracking || !mouse_moved))
393
394
395/* Symbols to head events. */
396Lisp_Object Qmouse_movement;
3c370943 397Lisp_Object Qscroll_bar_movement;
cd21b839
JB
398Lisp_Object Qswitch_frame;
399
284f4730
JB
400/* Symbols to denote kinds of events. */
401Lisp_Object Qfunction_key;
402Lisp_Object Qmouse_click;
403/* Lisp_Object Qmouse_movement; - also an event header */
284f4730
JB
404
405/* Properties of event headers. */
406Lisp_Object Qevent_kind;
88cb0656 407Lisp_Object Qevent_symbol_elements;
284f4730 408
598a9fa7
JB
409Lisp_Object Qmenu_enable;
410
0a7f1fc0
JB
411/* An event header symbol HEAD may have a property named
412 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
413 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
414 mask of modifiers applied to it. If present, this is used to help
415 speed up parse_modifiers. */
416Lisp_Object Qevent_symbol_element_mask;
417
418/* An unmodified event header BASE may have a property named
419 Qmodifier_cache, which is an alist mapping modifier masks onto
420 modified versions of BASE. If present, this helps speed up
421 apply_modifiers. */
422Lisp_Object Qmodifier_cache;
423
5ec75a55 424/* Symbols to use for parts of windows. */
284f4730 425Lisp_Object Qmode_line;
e5d77022 426Lisp_Object Qvertical_line;
3c370943 427Lisp_Object Qvertical_scroll_bar;
5ec75a55
RS
428Lisp_Object Qmenu_bar;
429
430extern Lisp_Object Qmenu_enable;
284f4730 431
f4255cd1
JB
432Lisp_Object recursive_edit_unwind (), command_loop ();
433Lisp_Object Fthis_command_keys ();
03b4122a 434Lisp_Object Qextended_command_history;
284f4730 435
f4eef8b4
RS
436Lisp_Object Qpolling_period;
437
ffd56f97
JB
438/* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
439 happens. */
440EMACS_TIME *input_available_clear_time;
284f4730
JB
441
442/* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
443 Default is 1 if INTERRUPT_INPUT is defined. */
444int interrupt_input;
445
446/* Nonzero while interrupts are temporarily deferred during redisplay. */
447int interrupts_deferred;
448
449/* nonzero means use ^S/^Q for flow control. */
450int flow_control;
451
284f4730
JB
452/* Allow m- file to inhibit use of FIONREAD. */
453#ifdef BROKEN_FIONREAD
454#undef FIONREAD
455#endif
456
457/* We are unable to use interrupts if FIONREAD is not available,
458 so flush SIGIO so we won't try. */
459#ifndef FIONREAD
460#ifdef SIGIO
461#undef SIGIO
462#endif
463#endif
464
34f04431
RS
465/* If we support X Windows, turn on the code to poll periodically
466 to detect C-g. It isn't actually used when doing interrupt input. */
284f4730 467#ifdef HAVE_X_WINDOWS
284f4730
JB
468#define POLL_FOR_INPUT
469#endif
284f4730
JB
470\f
471/* Global variable declarations. */
472
473/* Function for init_keyboard to call with no args (if nonzero). */
474void (*keyboard_init_hook) ();
475
476static int read_avail_input ();
477static void get_input_pending ();
9fd7d808 478static int readable_events ();
8150596a
RS
479static Lisp_Object read_char_x_menu_prompt ();
480static Lisp_Object read_char_minibuf_menu_prompt ();
a612e298
RS
481static Lisp_Object make_lispy_event ();
482static Lisp_Object make_lispy_movement ();
483static Lisp_Object modify_event_symbol ();
484static Lisp_Object make_lispy_switch_frame ();
284f4730
JB
485
486/* > 0 if we are to echo keystrokes. */
487static int echo_keystrokes;
488
489/* Nonzero means echo each character as typed. */
490static int immediate_echo;
491
492/* The text we're echoing in the modeline - partial key sequences,
f4255cd1
JB
493 usually. '\0'-terminated. This really shouldn't have a fixed size. */
494static char echobuf[300];
284f4730
JB
495
496/* Where to append more text to echobuf if we want to. */
497static char *echoptr;
498
7a80a6f6
RS
499/* If we have echoed a prompt string specified by the user,
500 this is its length. Otherwise this is -1. */
501static int echo_after_prompt;
502
8026024c
KH
503/* Nonzero means don't try to suspend even if the operating system seems
504 to support it. */
505static int cannot_suspend;
506
284f4730
JB
507#define min(a,b) ((a)<(b)?(a):(b))
508#define max(a,b) ((a)>(b)?(a):(b))
509
510/* Install the string STR as the beginning of the string of echoing,
511 so that it serves as a prompt for the next character.
512 Also start echoing. */
513
514echo_prompt (str)
515 char *str;
516{
517 int len = strlen (str);
7a80a6f6 518
284f4730
JB
519 if (len > sizeof echobuf - 4)
520 len = sizeof echobuf - 4;
0a7f1fc0 521 bcopy (str, echobuf, len);
284f4730 522 echoptr = echobuf + len;
0a7f1fc0 523 *echoptr = '\0';
284f4730 524
7a80a6f6
RS
525 echo_after_prompt = len;
526
284f4730
JB
527 echo ();
528}
529
530/* Add C to the echo string, if echoing is going on.
531 C can be a character, which is printed prettily ("M-C-x" and all that
532 jazz), or a symbol, whose name is printed. */
533
534echo_char (c)
535 Lisp_Object c;
536{
537 extern char *push_key_description ();
538
539 if (immediate_echo)
540 {
541 char *ptr = echoptr;
542
543 if (ptr != echobuf)
544 *ptr++ = ' ';
545
546 /* If someone has passed us a composite event, use its head symbol. */
88cb0656 547 c = EVENT_HEAD (c);
284f4730
JB
548
549 if (XTYPE (c) == Lisp_Int)
550 {
551 if (ptr - echobuf > sizeof echobuf - 6)
552 return;
553
cb5df6ae 554 ptr = push_key_description (XINT (c), ptr);
284f4730
JB
555 }
556 else if (XTYPE (c) == Lisp_Symbol)
557 {
558 struct Lisp_String *name = XSYMBOL (c)->name;
559 if (((ptr - echobuf) + name->size + 4) > sizeof echobuf)
560 return;
561 bcopy (name->data, ptr, name->size);
562 ptr += name->size;
563 }
564
7e85b935 565 if (echoptr == echobuf && EQ (c, Vhelp_char))
284f4730
JB
566 {
567 strcpy (ptr, " (Type ? for further options)");
568 ptr += strlen (ptr);
569 }
570
571 *ptr = 0;
572 echoptr = ptr;
573
574 echo ();
575 }
576}
577
578/* Temporarily add a dash to the end of the echo string if it's not
579 empty, so that it serves as a mini-prompt for the very next character. */
580
581echo_dash ()
582{
583 if (!immediate_echo && echoptr == echobuf)
584 return;
7a80a6f6 585 /* Do nothing if we just printed a prompt. */
7d637a0d 586 if (echo_after_prompt == echoptr - echobuf)
7a80a6f6 587 return;
4bafa972
JB
588 /* Do nothing if not echoing at all. */
589 if (echoptr == 0)
590 return;
284f4730
JB
591
592 /* Put a dash at the end of the buffer temporarily,
593 but make it go away when the next character is added. */
594 echoptr[0] = '-';
595 echoptr[1] = 0;
596
597 echo ();
598}
599
600/* Display the current echo string, and begin echoing if not already
601 doing so. */
602
603echo ()
604{
605 if (!immediate_echo)
606 {
607 int i;
608 immediate_echo = 1;
609
610 for (i = 0; i < this_command_key_count; i++)
d0a57728
RS
611 {
612 Lisp_Object c;
613 c = XVECTOR (this_command_keys)->contents[i];
614 if (! (EVENT_HAS_PARAMETERS (c)
615 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
616 echo_char (c);
617 }
284f4730
JB
618 echo_dash ();
619 }
620
621 echoing = 1;
622 message1 (echobuf);
623 echoing = 0;
624
625 if (waiting_for_input && !NILP (Vquit_flag))
626 quit_throw_to_read_char ();
627}
628
629/* Turn off echoing, for the start of a new command. */
630
631cancel_echoing ()
632{
633 immediate_echo = 0;
634 echoptr = echobuf;
7a80a6f6 635 echo_after_prompt = -1;
284f4730
JB
636}
637
638/* Return the length of the current echo string. */
639
640static int
641echo_length ()
642{
643 return echoptr - echobuf;
644}
645
646/* Truncate the current echo message to its first LEN chars.
647 This and echo_char get used by read_key_sequence when the user
ff11dfa1 648 switches frames while entering a key sequence. */
284f4730
JB
649
650static void
651echo_truncate (len)
652 int len;
653{
654 echobuf[len] = '\0';
0a7f1fc0 655 echoptr = echobuf + len;
40932d1a 656 truncate_echo_area (len);
284f4730
JB
657}
658
659\f
660/* Functions for manipulating this_command_keys. */
661static void
662add_command_key (key)
663 Lisp_Object key;
664{
6569cc8d
JB
665 int size = XVECTOR (this_command_keys)->size;
666
667 if (this_command_key_count >= size)
284f4730 668 {
9b8eb840 669 Lisp_Object new_keys;
6569cc8d 670
9b8eb840 671 new_keys = Fmake_vector (make_number (size * 2), Qnil);
6569cc8d
JB
672 bcopy (XVECTOR (this_command_keys)->contents,
673 XVECTOR (new_keys)->contents,
8f805655 674 size * sizeof (Lisp_Object));
6569cc8d
JB
675
676 this_command_keys = new_keys;
284f4730 677 }
6569cc8d
JB
678
679 XVECTOR (this_command_keys)->contents[this_command_key_count++] = key;
284f4730
JB
680}
681\f
682Lisp_Object
683recursive_edit_1 ()
684{
685 int count = specpdl_ptr - specpdl;
686 Lisp_Object val;
687
688 if (command_loop_level > 0)
689 {
690 specbind (Qstandard_output, Qt);
691 specbind (Qstandard_input, Qt);
692 }
693
694 val = command_loop ();
695 if (EQ (val, Qt))
696 Fsignal (Qquit, Qnil);
697
cb5df6ae 698 return unbind_to (count, Qnil);
284f4730
JB
699}
700
701/* When an auto-save happens, record the "time", and don't do again soon. */
5846638c 702
284f4730
JB
703record_auto_save ()
704{
51172b6d 705 last_auto_save = num_nonmacro_input_chars;
284f4730 706}
5846638c
RS
707
708/* Make an auto save happen as soon as possible at command level. */
709
710force_auto_save_soon ()
711{
712 last_auto_save = - auto_save_interval - 1;
241ceaf7
RS
713
714 record_asynch_buffer_change ();
5846638c 715}
284f4730 716\f
284f4730
JB
717DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
718 "Invoke the editor command loop recursively.\n\
719To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
720that tells this function to return.\n\
721Alternately, `(throw 'exit t)' makes this function signal an error.\n\
722This function is called by the editor initialization to begin editing.")
723 ()
724{
725 int count = specpdl_ptr - specpdl;
726 Lisp_Object val;
727
728 command_loop_level++;
729 update_mode_lines = 1;
730
731 record_unwind_protect (recursive_edit_unwind,
732 (command_loop_level
733 && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
734 ? Fcurrent_buffer ()
735 : Qnil);
736 recursive_edit_1 ();
737 return unbind_to (count, Qnil);
738}
739
740Lisp_Object
741recursive_edit_unwind (buffer)
742 Lisp_Object buffer;
743{
744 if (!NILP (buffer))
745 Fset_buffer (buffer);
746
747 command_loop_level--;
748 update_mode_lines = 1;
749 return Qnil;
750}
751\f
752Lisp_Object
753cmd_error (data)
754 Lisp_Object data;
755{
756 Lisp_Object errmsg, tail, errname, file_error;
757 Lisp_Object stream;
758 struct gcpro gcpro1;
759 int i;
760
761 Vquit_flag = Qnil;
762 Vinhibit_quit = Qt;
763 Vstandard_output = Qt;
764 Vstandard_input = Qt;
765 Vexecuting_macro = Qnil;
766 echo_area_glyphs = 0;
767
ff11dfa1 768 /* If the window system or terminal frame hasn't been initialized
284f4730
JB
769 yet, or we're not interactive, it's best to dump this message out
770 to stderr and exit. */
ff11dfa1 771 if (! FRAME_MESSAGE_BUF (selected_frame)
284f4730
JB
772 || noninteractive)
773 stream = Qexternal_debugging_output;
774 else
775 {
776 Fdiscard_input ();
777 bitch_at_user ();
778 stream = Qt;
779 }
780
781 errname = Fcar (data);
782
783 if (EQ (errname, Qerror))
784 {
785 data = Fcdr (data);
786 if (!CONSP (data)) data = Qnil;
787 errmsg = Fcar (data);
788 file_error = Qnil;
789 }
790 else
791 {
792 errmsg = Fget (errname, Qerror_message);
793 file_error = Fmemq (Qfile_error,
794 Fget (errname, Qerror_conditions));
795 }
796
797 /* Print an error message including the data items.
798 This is done by printing it into a scratch buffer
799 and then making a copy of the text in the buffer. */
800
801 if (!CONSP (data)) data = Qnil;
802 tail = Fcdr (data);
803 GCPRO1 (tail);
804
805 /* For file-error, make error message by concatenating
806 all the data items. They are all strings. */
807 if (!NILP (file_error) && !NILP (tail))
808 errmsg = XCONS (tail)->car, tail = XCONS (tail)->cdr;
809
810 if (XTYPE (errmsg) == Lisp_String)
811 Fprinc (errmsg, stream);
812 else
813 write_string_1 ("peculiar error", -1, stream);
814
815 for (i = 0; CONSP (tail); tail = Fcdr (tail), i++)
816 {
817 write_string_1 (i ? ", " : ": ", 2, stream);
818 if (!NILP (file_error))
819 Fprinc (Fcar (tail), stream);
820 else
821 Fprin1 (Fcar (tail), stream);
822 }
823 UNGCPRO;
824
ff11dfa1 825 /* If the window system or terminal frame hasn't been initialized
284f4730 826 yet, or we're in -batch mode, this error should cause Emacs to exit. */
ff11dfa1 827 if (! FRAME_MESSAGE_BUF (selected_frame)
284f4730
JB
828 || noninteractive)
829 {
830 Fterpri (stream);
831 Fkill_emacs (make_number (-1));
832 }
833
834 Vquit_flag = Qnil;
835
836 Vinhibit_quit = Qnil;
837 return make_number (0);
838}
839\f
840Lisp_Object command_loop_1 ();
841Lisp_Object command_loop_2 ();
842Lisp_Object top_level_1 ();
843
844/* Entry to editor-command-loop.
845 This level has the catches for exiting/returning to editor command loop.
846 It returns nil to exit recursive edit, t to abort it. */
847
848Lisp_Object
849command_loop ()
850{
851 if (command_loop_level > 0 || minibuf_level > 0)
852 {
853 return internal_catch (Qexit, command_loop_2, Qnil);
854 }
855 else
856 while (1)
857 {
858 internal_catch (Qtop_level, top_level_1, Qnil);
859 internal_catch (Qtop_level, command_loop_2, Qnil);
860
861 /* End of file in -batch run causes exit here. */
862 if (noninteractive)
863 Fkill_emacs (Qt);
864 }
865}
866
867/* Here we catch errors in execution of commands within the
868 editing loop, and reenter the editing loop.
869 When there is an error, cmd_error runs and returns a non-nil
870 value to us. A value of nil means that cmd_loop_1 itself
871 returned due to end of file (or end of kbd macro). */
872
873Lisp_Object
874command_loop_2 ()
875{
876 register Lisp_Object val;
877
878 do
879 val = internal_condition_case (command_loop_1, Qerror, cmd_error);
880 while (!NILP (val));
881
882 return Qnil;
883}
884
885Lisp_Object
886top_level_2 ()
887{
888 return Feval (Vtop_level);
889}
890
891Lisp_Object
892top_level_1 ()
893{
894 /* On entry to the outer level, run the startup file */
895 if (!NILP (Vtop_level))
896 internal_condition_case (top_level_2, Qerror, cmd_error);
897 else if (!NILP (Vpurify_flag))
898 message ("Bare impure Emacs (standard Lisp code not loaded)");
899 else
900 message ("Bare Emacs (standard Lisp code not loaded)");
901 return Qnil;
902}
903
904DEFUN ("top-level", Ftop_level, Stop_level, 0, 0, "",
905 "Exit all recursive editing levels.")
906 ()
907{
908 Fthrow (Qtop_level, Qnil);
909}
910
911DEFUN ("exit-recursive-edit", Fexit_recursive_edit, Sexit_recursive_edit, 0, 0, "",
912 "Exit from the innermost recursive edit or minibuffer.")
913 ()
914{
915 if (command_loop_level > 0 || minibuf_level > 0)
916 Fthrow (Qexit, Qnil);
917
918 error ("No recursive edit is in progress");
919}
920
921DEFUN ("abort-recursive-edit", Fabort_recursive_edit, Sabort_recursive_edit, 0, 0, "",
922 "Abort the command that requested this recursive edit or minibuffer input.")
923 ()
924{
925 if (command_loop_level > 0 || minibuf_level > 0)
926 Fthrow (Qexit, Qt);
927
928 error ("No recursive edit is in progress");
929}
930\f
931/* This is the actual command reading loop,
932 sans error-handling encapsulation. */
933
934Lisp_Object Fcommand_execute ();
935static int read_key_sequence ();
1c9784c9 936static void safe_run_hooks ();
284f4730
JB
937
938Lisp_Object
939command_loop_1 ()
940{
48e416d4 941 Lisp_Object cmd, tem;
284f4730
JB
942 int lose;
943 int nonundocount;
944 Lisp_Object keybuf[30];
945 int i;
946 int no_redisplay;
947 int no_direct;
86e5706b
RS
948 int prev_modiff;
949 struct buffer *prev_buffer;
284f4730
JB
950
951 Vprefix_arg = Qnil;
86e5706b 952 Vdeactivate_mark = Qnil;
284f4730
JB
953 waiting_for_input = 0;
954 cancel_echoing ();
955
284f4730
JB
956 nonundocount = 0;
957 no_redisplay = 0;
958 this_command_key_count = 0;
959
a612e298
RS
960 /* Make sure this hook runs after commands that get errors and
961 throw to top level. */
a98ea3f9
RS
962 /* Note that the value cell will never directly contain nil
963 if the symbol is a local variable. */
964 if (!NILP (XSYMBOL (Qpost_command_hook)->value) && !NILP (Vrun_hooks))
965 safe_run_hooks (Qpost_command_hook);
a612e298 966
8a792f3a
RS
967 if (!NILP (Vdeferred_action_list))
968 call0 (Vdeferred_action_function);
969
51d5a2c9
RS
970 /* Do this after running Vpost_command_hook, for consistency. */
971 last_command = this_command;
972
284f4730
JB
973 while (1)
974 {
975 /* Install chars successfully executed in kbd macro. */
976
977 if (defining_kbd_macro && NILP (Vprefix_arg))
978 finalize_kbd_macro_chars ();
979
980 /* Make sure the current window's buffer is selected. */
981 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
982 set_buffer_internal (XBUFFER (XWINDOW (selected_window)->buffer));
983
984 /* Display any malloc warning that just came out. Use while because
985 displaying one warning can cause another. */
986
987 while (pending_malloc_warning)
988 display_malloc_warning ();
989
990 no_direct = 0;
991
86e5706b
RS
992 Vdeactivate_mark = Qnil;
993
284f4730 994 /* If minibuffer on and echo area in use,
eb8c3be9 995 wait 2 sec and redraw minibuffer. */
284f4730
JB
996
997 if (minibuf_level && echo_area_glyphs)
998 {
f1bed6d8
RS
999 /* Bind inhibit-quit to t so that C-g gets read in
1000 rather than quitting back to the minibuffer. */
1001 int count = specpdl_ptr - specpdl;
1002 specbind (Qinhibit_quit, Qt);
284f4730 1003 Fsit_for (make_number (2), Qnil, Qnil);
cb5df6ae 1004 unbind_to (count, Qnil);
f1bed6d8 1005
284f4730
JB
1006 echo_area_glyphs = 0;
1007 no_direct = 1;
1008 if (!NILP (Vquit_flag))
1009 {
1010 Vquit_flag = Qnil;
24597608 1011 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
284f4730
JB
1012 }
1013 }
1014
1015#ifdef C_ALLOCA
1016 alloca (0); /* Cause a garbage collection now */
1017 /* Since we can free the most stuff here. */
1018#endif /* C_ALLOCA */
1019
8f805655 1020#if 0
ff11dfa1 1021#ifdef MULTI_FRAME
8f805655
JB
1022 /* Select the frame that the last event came from. Usually,
1023 switch-frame events will take care of this, but if some lisp
1024 code swallows a switch-frame event, we'll fix things up here.
1025 Is this a good idea? */
3c370943
JB
1026 if (XTYPE (internal_last_event_frame) == Lisp_Frame
1027 && XFRAME (internal_last_event_frame) != selected_frame)
1028 Fselect_frame (internal_last_event_frame, Qnil);
cd21b839 1029#endif
284f4730 1030#endif
48e416d4
RS
1031 /* If it has changed current-menubar from previous value,
1032 really recompute the menubar from the value. */
a646e520
RS
1033 if (! NILP (Vlucid_menu_bar_dirty_flag)
1034 && !NILP (Ffboundp (Qrecompute_lucid_menubar)))
48e416d4
RS
1035 call0 (Qrecompute_lucid_menubar);
1036
8f805655 1037 /* Read next key sequence; i gets its length. */
84d91fda 1038 i = read_key_sequence (keybuf, (sizeof keybuf / sizeof (keybuf[0])), Qnil);
8f805655
JB
1039
1040 ++num_input_keys;
1041
284f4730
JB
1042 /* Now we have read a key sequence of length I,
1043 or else I is 0 and we found end of file. */
1044
1045 if (i == 0) /* End of file -- happens only in */
1046 return Qnil; /* a kbd macro, at the end. */
dcc408a0
RS
1047 /* -1 means read_key_sequence got a menu that was rejected.
1048 Just loop around and read another command. */
1049 if (i == -1)
1050 {
1051 cancel_echoing ();
1052 this_command_key_count = 0;
1053 continue;
1054 }
284f4730 1055
284f4730
JB
1056 last_command_char = keybuf[i - 1];
1057
75c0b143
RS
1058 /* If the previous command tried to force a specific window-start,
1059 forget about that, in case this command moves point far away
1060 from that position. */
1061 XWINDOW (selected_window)->force_start = Qnil;
1062
284f4730
JB
1063 cmd = read_key_sequence_cmd;
1064 if (!NILP (Vexecuting_macro))
1065 {
1066 if (!NILP (Vquit_flag))
1067 {
1068 Vexecuting_macro = Qt;
1069 QUIT; /* Make some noise. */
1070 /* Will return since macro now empty. */
1071 }
1072 }
1073
1074 /* Do redisplay processing after this command except in special
40932d1a
RS
1075 cases identified below that set no_redisplay to 1.
1076 (actually, there's currently no way to prevent the redisplay,
1077 and no_redisplay is ignored.
1078 Perhaps someday we will really implement it. */
284f4730
JB
1079 no_redisplay = 0;
1080
86e5706b
RS
1081 prev_buffer = current_buffer;
1082 prev_modiff = MODIFF;
8746da95 1083 last_point_position = PT;
047688cb 1084 XSET (last_point_position_buffer, Lisp_Buffer, prev_buffer);
86e5706b 1085
284f4730
JB
1086 /* Execute the command. */
1087
86e5706b 1088 this_command = cmd;
a98ea3f9
RS
1089 /* Note that the value cell will never directly contain nil
1090 if the symbol is a local variable. */
1091 if (!NILP (XSYMBOL (Qpre_command_hook)->value) && !NILP (Vrun_hooks))
1092 safe_run_hooks (Qpre_command_hook);
86e5706b 1093
258bf746 1094 if (NILP (this_command))
284f4730
JB
1095 {
1096 /* nil means key is undefined. */
1097 bitch_at_user ();
1098 defining_kbd_macro = 0;
1099 update_mode_lines = 1;
1100 Vprefix_arg = Qnil;
86e5706b 1101
284f4730
JB
1102 }
1103 else
1104 {
284f4730
JB
1105 if (NILP (Vprefix_arg) && ! no_direct)
1106 {
1107 /* Recognize some common commands in common situations and
1108 do them directly. */
8001d352 1109 if (EQ (this_command, Qforward_char) && PT < ZV)
284f4730
JB
1110 {
1111 struct Lisp_Vector *dp
1112 = window_display_table (XWINDOW (selected_window));
8001d352
KH
1113 lose = FETCH_CHAR (PT);
1114 SET_PT (PT + 1);
0f7a8fee 1115 if ((dp
82ba47d7 1116 ? (VECTORP (DISP_CHAR_VECTOR (dp, lose))
9a5540db
RS
1117 ? XVECTOR (DISP_CHAR_VECTOR (dp, lose))->size == 1
1118 : (NILP (DISP_CHAR_VECTOR (dp, lose))
1119 && (lose >= 0x20 && lose < 0x7f)))
0f7a8fee 1120 : (lose >= 0x20 && lose < 0x7f))
284f4730
JB
1121 && (XFASTINT (XWINDOW (selected_window)->last_modified)
1122 >= MODIFF)
1123 && (XFASTINT (XWINDOW (selected_window)->last_point)
8001d352 1124 == PT - 1)
284f4730
JB
1125 && !windows_or_buffers_changed
1126 && EQ (current_buffer->selective_display, Qnil)
1127 && !detect_input_pending ()
1128 && NILP (Vexecuting_macro))
1129 no_redisplay = direct_output_forward_char (1);
1130 goto directly_done;
1131 }
8001d352 1132 else if (EQ (this_command, Qbackward_char) && PT > BEGV)
284f4730
JB
1133 {
1134 struct Lisp_Vector *dp
1135 = window_display_table (XWINDOW (selected_window));
8001d352
KH
1136 SET_PT (PT - 1);
1137 lose = FETCH_CHAR (PT);
0f7a8fee 1138 if ((dp
ca873d73 1139 ? (VECTORP (DISP_CHAR_VECTOR (dp, lose))
9a5540db
RS
1140 ? XVECTOR (DISP_CHAR_VECTOR (dp, lose))->size == 1
1141 : (NILP (DISP_CHAR_VECTOR (dp, lose))
1142 && (lose >= 0x20 && lose < 0x7f)))
0f7a8fee 1143 : (lose >= 0x20 && lose < 0x7f))
284f4730
JB
1144 && (XFASTINT (XWINDOW (selected_window)->last_modified)
1145 >= MODIFF)
1146 && (XFASTINT (XWINDOW (selected_window)->last_point)
8001d352 1147 == PT + 1)
284f4730
JB
1148 && !windows_or_buffers_changed
1149 && EQ (current_buffer->selective_display, Qnil)
1150 && !detect_input_pending ()
1151 && NILP (Vexecuting_macro))
1152 no_redisplay = direct_output_forward_char (-1);
1153 goto directly_done;
1154 }
258bf746 1155 else if (EQ (this_command, Qself_insert_command)
284f4730
JB
1156 /* Try this optimization only on ascii keystrokes. */
1157 && XTYPE (last_command_char) == Lisp_Int)
1158 {
1159 unsigned char c = XINT (last_command_char);
fc9cce4e 1160 int value;
284f4730 1161
fc9cce4e
RS
1162 if (NILP (Vexecuting_macro)
1163 && !EQ (minibuf_window, selected_window))
284f4730
JB
1164 {
1165 if (!nonundocount || nonundocount >= 20)
1166 {
1167 Fundo_boundary ();
1168 nonundocount = 0;
1169 }
1170 nonundocount++;
1171 }
fc9cce4e
RS
1172 lose = ((XFASTINT (XWINDOW (selected_window)->last_modified)
1173 < MODIFF)
1174 || (XFASTINT (XWINDOW (selected_window)->last_point)
1175 != PT)
1176 || MODIFF <= current_buffer->save_modified
1177 || windows_or_buffers_changed
1178 || !EQ (current_buffer->selective_display, Qnil)
1179 || detect_input_pending ()
1180 || !NILP (Vexecuting_macro));
1181 value = internal_self_insert (c, 0);
1182 if (value)
1183 lose = 1;
1184 if (value == 2)
1185 nonundocount = 0;
1186
1187 if (!lose
1188 && (PT == ZV || FETCH_CHAR (PT) == '\n'))
284f4730
JB
1189 {
1190 struct Lisp_Vector *dp
1191 = window_display_table (XWINDOW (selected_window));
b8d9050d 1192 int lose = c;
284f4730 1193
0f7a8fee
JB
1194 if (dp)
1195 {
9b8eb840 1196 Lisp_Object obj;
0f7a8fee 1197
9b8eb840 1198 obj = DISP_CHAR_VECTOR (dp, lose);
054c8675 1199 if (NILP (obj))
8e91f441
RS
1200 {
1201 /* Do it only for char codes
1202 that by default display as themselves. */
1203 if (lose >= 0x20 && lose <= 0x7e)
1204 no_redisplay = direct_output_for_insert (lose);
1205 }
054c8675
RS
1206 else if (XTYPE (obj) == Lisp_Vector
1207 && XVECTOR (obj)->size == 1
1208 && (XTYPE (obj = XVECTOR (obj)->contents[0])
1209 == Lisp_Int)
1210 /* Insist face not specified in glyph. */
1211 && (XINT (obj) & ((-1) << 8)) == 0)
bd48a052
RS
1212 no_redisplay
1213 = direct_output_for_insert (XINT (obj));
0f7a8fee
JB
1214 }
1215 else
1216 {
1217 if (lose >= 0x20 && lose <= 0x7e)
1218 no_redisplay = direct_output_for_insert (lose);
1219 }
284f4730
JB
1220 }
1221 goto directly_done;
1222 }
1223 }
1224
1225 /* Here for a command that isn't executed directly */
1226
1227 nonundocount = 0;
1228 if (NILP (Vprefix_arg))
1229 Fundo_boundary ();
258bf746 1230 Fcommand_execute (this_command, Qnil);
284f4730 1231
284f4730 1232 }
a764a753 1233 directly_done: ;
284f4730 1234
a98ea3f9
RS
1235 /* Note that the value cell will never directly contain nil
1236 if the symbol is a local variable. */
1237 if (!NILP (XSYMBOL (Qpost_command_hook)->value) && !NILP (Vrun_hooks))
1238 safe_run_hooks (Qpost_command_hook);
86e5706b 1239
8a792f3a
RS
1240 if (!NILP (Vdeferred_action_list))
1241 call0 (Vdeferred_action_function);
1242
284f4730
JB
1243 /* If there is a prefix argument,
1244 1) We don't want last_command to be ``universal-argument''
1245 (that would be dumb), so don't set last_command,
1246 2) we want to leave echoing on so that the prefix will be
1247 echoed as part of this key sequence, so don't call
1248 cancel_echoing, and
1249 3) we want to leave this_command_key_count non-zero, so that
1250 read_char will realize that it is re-reading a character, and
1251 not echo it a second time. */
1252 if (NILP (Vprefix_arg))
1253 {
1254 last_command = this_command;
1255 cancel_echoing ();
1256 this_command_key_count = 0;
1257 }
86e5706b 1258
88ce066e 1259 if (!NILP (current_buffer->mark_active) && !NILP (Vrun_hooks))
86e5706b
RS
1260 {
1261 if (!NILP (Vdeactivate_mark) && !NILP (Vtransient_mark_mode))
1262 {
1263 current_buffer->mark_active = Qnil;
1264 call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
1265 }
1266 else if (current_buffer != prev_buffer || MODIFF != prev_modiff)
1267 call1 (Vrun_hooks, intern ("activate-mark-hook"));
1268 }
284f4730
JB
1269 }
1270}
1c9784c9
KH
1271
1272/* If we get an error while running the hook, cause the hook variable
1273 to be nil. Also inhibit quits, so that C-g won't cause the hook
1274 to mysteriously evaporate. */
1275static void
1276safe_run_hooks (hook)
a98ea3f9 1277 Lisp_Object hook;
1c9784c9 1278{
68553292 1279 Lisp_Object value;
1c9784c9
KH
1280 int count = specpdl_ptr - specpdl;
1281 specbind (Qinhibit_quit, Qt);
1282
a98ea3f9
RS
1283 /* We read and set the variable with functions,
1284 in case it's buffer-local. */
68553292 1285 value = Vcommand_hook_internal = Fsymbol_value (hook);
a98ea3f9 1286 Fset (hook, Qnil);
1c9784c9 1287 call1 (Vrun_hooks, Qcommand_hook_internal);
68553292 1288 Fset (hook, value);
1c9784c9
KH
1289
1290 unbind_to (count, Qnil);
1291}
284f4730
JB
1292\f
1293/* Number of seconds between polling for input. */
1294int polling_period;
1295
eb8c3be9 1296/* Nonzero means polling for input is temporarily suppressed. */
284f4730
JB
1297int poll_suppress_count;
1298
36922b18 1299/* Nonzero if polling_for_input is actually being used. */
284f4730
JB
1300int polling_for_input;
1301
36922b18
RS
1302#ifdef POLL_FOR_INPUT
1303
284f4730
JB
1304/* Handle an alarm once each second and read pending input
1305 so as to handle a C-g if it comces in. */
1306
1307SIGTYPE
1308input_poll_signal ()
1309{
9ac0d9e0
JB
1310 if (interrupt_input_blocked == 0
1311 && !waiting_for_input)
1312 read_avail_input (0);
284f4730
JB
1313 signal (SIGALRM, input_poll_signal);
1314 alarm (polling_period);
1315}
1316
1317#endif
1318
1319/* Begin signals to poll for input, if they are appropriate.
1320 This function is called unconditionally from various places. */
1321
1322start_polling ()
1323{
1324#ifdef POLL_FOR_INPUT
34f04431 1325 if (read_socket_hook && !interrupt_input)
284f4730
JB
1326 {
1327 poll_suppress_count--;
1328 if (poll_suppress_count == 0)
1329 {
1330 signal (SIGALRM, input_poll_signal);
1331 polling_for_input = 1;
1332 alarm (polling_period);
1333 }
1334 }
1335#endif
1336}
1337
1d3195db
RS
1338/* Nonzero if we are using polling to handle input asynchronously. */
1339
1340int
1341input_polling_used ()
1342{
1343#ifdef POLL_FOR_INPUT
1344 return read_socket_hook && !interrupt_input;
1345#else
1346 return 0;
1347#endif
1348}
1349
284f4730
JB
1350/* Turn off polling. */
1351
1352stop_polling ()
1353{
1354#ifdef POLL_FOR_INPUT
34f04431 1355 if (read_socket_hook && !interrupt_input)
284f4730
JB
1356 {
1357 if (poll_suppress_count == 0)
1358 {
1359 polling_for_input = 0;
1360 alarm (0);
1361 }
1362 poll_suppress_count++;
1363 }
1364#endif
1365}
fe8aeef3
RS
1366
1367/* Set the value of poll_suppress_count to COUNT
1368 and start or stop polling accordingly. */
1369
1370void
1371set_poll_suppress_count (count)
1372 int count;
1373{
1374#ifdef POLL_FOR_INPUT
1375 if (count == 0 && poll_suppress_count != 0)
1376 {
1377 poll_suppress_count = 1;
1378 start_polling ();
1379 }
1380 else if (count != 0 && poll_suppress_count == 0)
1381 {
1382 stop_polling ();
1383 }
1384 poll_suppress_count = count;
1385#endif
1386}
f4eef8b4 1387
d0a57728
RS
1388/* Bind polling_period to a value at least N.
1389 But don't decrease it. */
1390
f4eef8b4
RS
1391bind_polling_period (n)
1392 int n;
1393{
1394#ifdef POLL_FOR_INPUT
d0a57728
RS
1395 int new = polling_period;
1396
1397 if (n > new)
1398 new = n;
1399
f4eef8b4 1400 stop_polling ();
d0a57728
RS
1401 specbind (Qpolling_period, make_number (new));
1402 /* Start a new alarm with the new period. */
f4eef8b4
RS
1403 start_polling ();
1404#endif
1405}
284f4730 1406\f
faf5e407
JB
1407/* Applying the control modifier to CHARACTER. */
1408int
1409make_ctrl_char (c)
1410 int c;
1411{
d205953b
JB
1412 /* Save the upper bits here. */
1413 int upper = c & ~0177;
1414
1415 c &= 0177;
1416
1417 /* Everything in the columns containing the upper-case letters
1418 denotes a control character. */
1419 if (c >= 0100 && c < 0140)
1420 {
1421 int oc = c;
1422 c &= ~0140;
1423 /* Set the shift modifier for a control char
1424 made from a shifted letter. But only for letters! */
1425 if (oc >= 'A' && oc <= 'Z')
1426 c |= shift_modifier;
1427 }
1428
1429 /* The lower-case letters denote control characters too. */
1430 else if (c >= 'a' && c <= 'z')
1431 c &= ~0140;
1432
1433 /* Include the bits for control and shift
1434 only if the basic ASCII code can't indicate them. */
1435 else if (c >= ' ')
1436 c |= ctrl_modifier;
1437
1438 /* Replace the high bits. */
1439 c |= (upper & ~ctrl_modifier);
faf5e407
JB
1440
1441 return c;
1442}
1443
1444
1445\f
284f4730
JB
1446/* Input of single characters from keyboard */
1447
1448Lisp_Object print_help ();
1449static Lisp_Object kbd_buffer_get_event ();
1450
1451/* read a character from the keyboard; call the redisplay if needed */
1452/* commandflag 0 means do not do auto-saving, but do do redisplay.
1453 -1 means do not do redisplay, but do do autosaving.
1454 1 means do both. */
1455
7d6de002
RS
1456/* The arguments MAPS and NMAPS are for menu prompting.
1457 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1458
1459 PREV_EVENT is the previous input event, or nil if we are reading
1460 the first event of a key sequence.
1461
6569cc8d
JB
1462 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1463 if we used a mouse menu to read the input, or zero otherwise. If
dcc408a0
RS
1464 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1465
1466 Value is t if we showed a menu and the user rejected it. */
7d6de002 1467
284f4730 1468Lisp_Object
7d6de002 1469read_char (commandflag, nmaps, maps, prev_event, used_mouse_menu)
284f4730 1470 int commandflag;
7d6de002
RS
1471 int nmaps;
1472 Lisp_Object *maps;
1473 Lisp_Object prev_event;
1474 int *used_mouse_menu;
284f4730
JB
1475{
1476 register Lisp_Object c;
1477 int count;
1478 jmp_buf save_jump;
1479
24597608 1480 if (CONSP (Vunread_command_events))
284f4730 1481 {
24597608
RS
1482 c = XCONS (Vunread_command_events)->car;
1483 Vunread_command_events = XCONS (Vunread_command_events)->cdr;
284f4730 1484
284f4730
JB
1485 if (this_command_key_count == 0)
1486 goto reread_first;
1487 else
1488 goto reread;
1489 }
1490
86e5706b
RS
1491 if (unread_command_char != -1)
1492 {
1493 XSET (c, Lisp_Int, unread_command_char);
1494 unread_command_char = -1;
1495
1496 if (this_command_key_count == 0)
1497 goto reread_first;
1498 else
1499 goto reread;
1500 }
1501
284f4730
JB
1502 if (!NILP (Vexecuting_macro))
1503 {
07d2b8de 1504#ifdef MULTI_FRAME
fce33686
JB
1505 /* We set this to Qmacro; since that's not a frame, nobody will
1506 try to switch frames on us, and the selected window will
1507 remain unchanged.
1508
1509 Since this event came from a macro, it would be misleading to
eb8c3be9 1510 leave internal_last_event_frame set to wherever the last
3c370943
JB
1511 real event came from. Normally, a switch-frame event selects
1512 internal_last_event_frame after each command is read, but
1513 events read from a macro should never cause a new frame to be
1514 selected. */
1515 Vlast_event_frame = internal_last_event_frame = Qmacro;
07d2b8de 1516#endif
fce33686 1517
663258f2
JB
1518 /* Exit the macro if we are at the end.
1519 Also, some things replace the macro with t
1520 to force an early exit. */
1521 if (EQ (Vexecuting_macro, Qt)
1522 || executing_macro_index >= XFASTINT (Flength (Vexecuting_macro)))
284f4730
JB
1523 {
1524 XSET (c, Lisp_Int, -1);
1525 return c;
1526 }
1527
1528 c = Faref (Vexecuting_macro, make_number (executing_macro_index));
86e5706b
RS
1529 if (XTYPE (Vexecuting_macro) == Lisp_String
1530 && (XINT (c) & 0x80))
1531 XFASTINT (c) = CHAR_META | (XINT (c) & ~0x80);
1532
284f4730
JB
1533 executing_macro_index++;
1534
1535 goto from_macro;
1536 }
1537
cd21b839
JB
1538 if (!NILP (unread_switch_frame))
1539 {
1540 c = unread_switch_frame;
1541 unread_switch_frame = Qnil;
1542
1543 /* This event should make it into this_command_keys, and get echoed
f4255cd1
JB
1544 again, so we go to reread_first, rather than reread. */
1545 goto reread_first;
cd21b839
JB
1546 }
1547
3f9929bf
RS
1548 /* Don't bother updating menu bars while doing mouse tracking.
1549 We get events very rapidly then, and the menu bar won't be changing.
1550 We do update the menu bar once on entry to Ftrack_mouse. */
b8556aee 1551 if (commandflag > 0 && !input_pending && !detect_input_pending ())
e9bf89a0
RS
1552 prepare_menu_bars ();
1553
284f4730 1554 /* Save outer setjmp data, in case called recursively. */
f76475ad 1555 save_getcjmp (save_jump);
284f4730
JB
1556
1557 stop_polling ();
1558
1559 if (commandflag >= 0 && !input_pending && !detect_input_pending ())
1560 redisplay ();
1561
1562 if (_setjmp (getcjmp))
1563 {
1564 XSET (c, Lisp_Int, quit_char);
07d2b8de 1565#ifdef MULTI_FRAME
3c370943
JB
1566 XSET (internal_last_event_frame, Lisp_Frame, selected_frame);
1567 Vlast_event_frame = internal_last_event_frame;
07d2b8de 1568#endif
04904c29
RS
1569 /* If we report the quit char as an event,
1570 don't do so more than once. */
1571 if (!NILP (Vinhibit_quit))
1572 Vquit_flag = Qnil;
284f4730 1573
284f4730
JB
1574 goto non_reread;
1575 }
1576
1577 /* Message turns off echoing unless more keystrokes turn it on again. */
1578 if (echo_area_glyphs && *echo_area_glyphs && echo_area_glyphs != echobuf)
1579 cancel_echoing ();
1580 else
1581 /* If already echoing, continue. */
1582 echo_dash ();
1583
8150596a
RS
1584 /* Try reading a character via menu prompting in the minibuf.
1585 Try this before the sit-for, because the sit-for
1586 would do the wrong thing if we are supposed to do
1587 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1588 after a mouse event so don't try a minibuf menu. */
1589 c = Qnil;
24597608
RS
1590 if (nmaps > 0 && INTERACTIVE
1591 && !NILP (prev_event) && ! EVENT_HAS_PARAMETERS (prev_event)
1592 /* Don't bring up a menu if we already have another event. */
1593 && NILP (Vunread_command_events)
1594 && unread_command_char < 0
b8556aee 1595 && !detect_input_pending ())
8150596a
RS
1596 {
1597 c = read_char_minibuf_menu_prompt (commandflag, nmaps, maps);
24597608 1598 if (! NILP (c))
588a7c5d 1599 goto non_reread;
8150596a
RS
1600 }
1601
284f4730
JB
1602 /* If in middle of key sequence and minibuffer not active,
1603 start echoing if enough time elapses. */
1604 if (minibuf_level == 0 && !immediate_echo && this_command_key_count > 0
27203ead 1605 && ! noninteractive
284f4730
JB
1606 && echo_keystrokes > 0
1607 && (echo_area_glyphs == 0 || *echo_area_glyphs == 0))
1608 {
1609 Lisp_Object tem0;
1610
7d6de002
RS
1611 /* After a mouse event, start echoing right away.
1612 This is because we are probably about to display a menu,
1613 and we don't want to delay before doing so. */
dbc4e1c1 1614 if (EVENT_HAS_PARAMETERS (prev_event))
284f4730 1615 echo ();
7d6de002
RS
1616 else
1617 {
1618 tem0 = sit_for (echo_keystrokes, 0, 1, 1);
1619 if (EQ (tem0, Qt))
1620 echo ();
1621 }
284f4730
JB
1622 }
1623
1624 /* Maybe auto save due to number of keystrokes or idle time. */
1625
1626 if (commandflag != 0
1627 && auto_save_interval > 0
51172b6d 1628 && num_nonmacro_input_chars - last_auto_save > max (auto_save_interval, 20)
284f4730
JB
1629 && !detect_input_pending ())
1630 {
1631 jmp_buf temp;
1632 save_getcjmp (temp);
1633 Fdo_auto_save (Qnil, Qnil);
1634 restore_getcjmp (temp);
1635 }
1636
8150596a 1637 /* Try reading using an X menu.
24597608
RS
1638 This is never confused with reading using the minibuf
1639 because the recursive call of read_char in read_char_minibuf_menu_prompt
1640 does not pass on any keymaps. */
1641 if (nmaps > 0 && INTERACTIVE
1642 && !NILP (prev_event) && EVENT_HAS_PARAMETERS (prev_event)
1643 /* Don't bring up a menu if we already have another event. */
1644 && NILP (Vunread_command_events)
b8556aee 1645 && unread_command_char < 0)
8150596a 1646 c = read_char_x_menu_prompt (nmaps, maps, prev_event, used_mouse_menu);
7d6de002 1647
284f4730
JB
1648 /* Slow down auto saves logarithmically in size of current buffer,
1649 and garbage collect while we're at it. */
26c1639e 1650 if (INTERACTIVE && NILP (c))
7d6de002
RS
1651 {
1652 int delay_level, buffer_size;
1653
1654 if (! MINI_WINDOW_P (XWINDOW (selected_window)))
1655 last_non_minibuf_size = Z - BEG;
1656 buffer_size = (last_non_minibuf_size >> 8) + 1;
1657 delay_level = 0;
1658 while (buffer_size > 64)
1659 delay_level++, buffer_size -= buffer_size >> 2;
1660 if (delay_level < 4) delay_level = 4;
1661 /* delay_level is 4 for files under around 50k, 7 at 100k,
1662 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1663
1664 /* Auto save if enough time goes by without input. */
1665 if (commandflag != 0
51172b6d 1666 && num_nonmacro_input_chars > last_auto_save
7d6de002
RS
1667 && XTYPE (Vauto_save_timeout) == Lisp_Int
1668 && XINT (Vauto_save_timeout) > 0)
1669 {
1670 Lisp_Object tem0;
1671 int delay = delay_level * XFASTINT (Vauto_save_timeout) / 4;
1672 tem0 = sit_for (delay, 0, 1, 1);
1673 if (EQ (tem0, Qt))
1674 {
1675 jmp_buf temp;
1676 save_getcjmp (temp);
1677 Fdo_auto_save (Qnil, Qnil);
1678 restore_getcjmp (temp);
1679
1680 /* If we have auto-saved and there is still no input
1681 available, garbage collect if there has been enough
1682 consing going on to make it worthwhile. */
1683 if (!detect_input_pending ()
1684 && consing_since_gc > gc_cons_threshold / 2)
7e85b935
RS
1685 {
1686 Fgarbage_collect ();
e9bf89a0
RS
1687 /* prepare_menu_bars isn't safe here, but it should
1688 also be unnecessary. */
7e85b935
RS
1689 redisplay ();
1690 }
7d6de002
RS
1691 }
1692 }
1693 }
284f4730
JB
1694
1695 /* Actually read a character, waiting if necessary. */
4eb4f926 1696 while (NILP (c))
1e12dd87
RS
1697 {
1698 c = kbd_buffer_get_event ();
1699 if (!NILP (c))
1700 break;
1701 if (commandflag >= 0 && !input_pending && !detect_input_pending ())
cd72760c
RS
1702 {
1703 prepare_menu_bars ();
1704 redisplay ();
1705 }
1e12dd87 1706 }
284f4730 1707
284f4730 1708 /* Terminate Emacs in batch mode if at eof. */
7d6de002 1709 if (noninteractive && XTYPE (c) == Lisp_Int && XINT (c) < 0)
284f4730
JB
1710 Fkill_emacs (make_number (1));
1711
80645119
JB
1712 if (XTYPE (c) == Lisp_Int)
1713 {
1714 /* Add in any extra modifiers, where appropriate. */
1715 if ((extra_keyboard_modifiers & CHAR_CTL)
1716 || ((extra_keyboard_modifiers & 0177) < ' '
1717 && (extra_keyboard_modifiers & 0177) != 0))
faf5e407 1718 XSETINT (c, make_ctrl_char (XINT (c)));
80645119
JB
1719
1720 /* Transfer any other modifier bits directly from
1721 extra_keyboard_modifiers to c. Ignore the actual character code
1722 in the low 16 bits of extra_keyboard_modifiers. */
b8d9050d 1723 XSETINT (c, XINT (c) | (extra_keyboard_modifiers & ~0xff7f & ~CHAR_CTL));
80645119 1724 }
9fa4395d 1725
284f4730
JB
1726 non_reread:
1727
f76475ad 1728 restore_getcjmp (save_jump);
284f4730
JB
1729
1730 start_polling ();
1731
dfd11da7
RS
1732 /* Buffer switch events are only for internal wakeups
1733 so don't show them to the user. */
1734 if (XTYPE (c) == Lisp_Buffer)
1735 return c;
1736
1737 /* Wipe the echo area. */
1738 echo_area_glyphs = 0;
284f4730
JB
1739
1740 /* Handle things that only apply to characters. */
1741 if (XTYPE (c) == Lisp_Int)
1742 {
1743 /* If kbd_buffer_get_event gave us an EOF, return that. */
86e5706b 1744 if (XINT (c) == -1)
284f4730
JB
1745 return c;
1746
284f4730 1747 if (XTYPE (Vkeyboard_translate_table) == Lisp_String
f4255cd1
JB
1748 && XSTRING (Vkeyboard_translate_table)->size > XFASTINT (c))
1749 XSETINT (c, XSTRING (Vkeyboard_translate_table)->data[XFASTINT (c)]);
284f4730
JB
1750 }
1751
1752 total_keys++;
5160df46
JB
1753 XVECTOR (recent_keys)->contents[recent_keys_index] = c;
1754 if (++recent_keys_index >= NUM_RECENT_KEYS)
284f4730
JB
1755 recent_keys_index = 0;
1756
1757 /* Write c to the dribble file. If c is a lispy event, write
1758 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1759 If you, dear reader, have a better idea, you've got the source. :-) */
1760 if (dribble)
1761 {
1762 if (XTYPE (c) == Lisp_Int)
dfd11da7
RS
1763 {
1764 if (XUINT (c) < 0x100)
1765 putc (XINT (c), dribble);
1766 else
1767 fprintf (dribble, " 0x%x", XUINT (c));
1768 }
284f4730
JB
1769 else
1770 {
9b8eb840 1771 Lisp_Object dribblee;
284f4730
JB
1772
1773 /* If it's a structured event, take the event header. */
9b8eb840 1774 dribblee = EVENT_HEAD (c);
284f4730 1775
8f805655 1776 if (XTYPE (dribblee) == Lisp_Symbol)
284f4730
JB
1777 {
1778 putc ('<', dribble);
8f805655
JB
1779 fwrite (XSYMBOL (dribblee)->name->data, sizeof (char),
1780 XSYMBOL (dribblee)->name->size,
284f4730
JB
1781 dribble);
1782 putc ('>', dribble);
1783 }
1784 }
1785
1786 fflush (dribble);
1787 }
1788
1789 store_kbd_macro_char (c);
1790
51172b6d
RS
1791 num_nonmacro_input_chars++;
1792
284f4730
JB
1793 from_macro:
1794 reread_first:
284f4730 1795
b8556aee 1796 /* Don't echo mouse motion events. */
4bb994d1
JB
1797 if (! (EVENT_HAS_PARAMETERS (c)
1798 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
b8556aee
RS
1799 echo_char (c);
1800
db8c1663 1801 /* Record this character as part of the current key. */
b8556aee 1802 add_command_key (c);
284f4730
JB
1803
1804 /* Re-reading in the middle of a command */
1805 reread:
1806 last_input_char = c;
1807 num_input_chars++;
1808
1809 /* Process the help character specially if enabled */
7e85b935 1810 if (EQ (c, Vhelp_char) && !NILP (Vhelp_form))
284f4730
JB
1811 {
1812 Lisp_Object tem0;
1813 count = specpdl_ptr - specpdl;
1814
1815 record_unwind_protect (Fset_window_configuration,
1816 Fcurrent_window_configuration (Qnil));
1817
1818 tem0 = Feval (Vhelp_form);
1819 if (XTYPE (tem0) == Lisp_String)
1820 internal_with_output_to_temp_buffer ("*Help*", print_help, tem0);
1821
1822 cancel_echoing ();
3cb81011
KH
1823 do
1824 c = read_char (0, 0, 0, Qnil, 0);
1825 while (XTYPE (c) == Lisp_Buffer);
ff11dfa1 1826 /* Remove the help from the frame */
284f4730 1827 unbind_to (count, Qnil);
e9bf89a0 1828 prepare_menu_bars ();
284f4730
JB
1829 redisplay ();
1830 if (EQ (c, make_number (040)))
1831 {
1832 cancel_echoing ();
3cb81011
KH
1833 do
1834 c = read_char (0, 0, 0, Qnil, 0);
1835 while (XTYPE (c) == Lisp_Buffer);
284f4730
JB
1836 }
1837 }
1838
1839 return c;
1840}
1841
1842Lisp_Object
1843print_help (object)
1844 Lisp_Object object;
1845{
1846 Fprinc (object, Qnil);
1847 return Qnil;
1848}
1849
1850/* Copy out or in the info on where C-g should throw to.
1851 This is used when running Lisp code from within get_char,
1852 in case get_char is called recursively.
1853 See read_process_output. */
1854
1855save_getcjmp (temp)
1856 jmp_buf temp;
1857{
1858 bcopy (getcjmp, temp, sizeof getcjmp);
1859}
1860
1861restore_getcjmp (temp)
1862 jmp_buf temp;
1863{
1864 bcopy (temp, getcjmp, sizeof getcjmp);
1865}
1866
1867\f
284f4730
JB
1868/* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1869 of this function. */
1870static Lisp_Object
1871tracking_off (old_value)
1872 Lisp_Object old_value;
1873{
1874 if (! XFASTINT (old_value))
1875 {
1876 do_mouse_tracking = 0;
1877
1878 /* Redisplay may have been preempted because there was input
1879 available, and it assumes it will be called again after the
1880 input has been processed. If the only input available was
1881 the sort that we have just disabled, then we need to call
1882 redisplay. */
1883 if (!readable_events ())
1884 {
e9bf89a0 1885 prepare_menu_bars ();
284f4730
JB
1886 redisplay_preserve_echo_area ();
1887 get_input_pending (&input_pending);
1888 }
1889 }
1890}
1891
1892DEFUN ("track-mouse", Ftrack_mouse, Strack_mouse, 0, UNEVALLED, 0,
4bb994d1
JB
1893 "Evaluate BODY with mouse movement events enabled.\n\
1894Within a `track-mouse' form, mouse motion generates input events that\n\
1895you can read with `read-event'.\n\
1896Normally, mouse motion is ignored.")
284f4730
JB
1897 (args)
1898 Lisp_Object args;
1899{
1900 int count = specpdl_ptr - specpdl;
1901 Lisp_Object val;
1902
1903 XSET (val, Lisp_Int, do_mouse_tracking);
1904 record_unwind_protect (tracking_off, val);
1905
3f9929bf
RS
1906 if (!input_pending && !detect_input_pending ())
1907 prepare_menu_bars ();
1908
284f4730
JB
1909 do_mouse_tracking = 1;
1910
1911 val = Fprogn (args);
1912 return unbind_to (count, val);
1913}
a612e298
RS
1914\f
1915/* Low level keyboard/mouse input.
1916 kbd_buffer_store_event places events in kbd_buffer, and
1917 kbd_buffer_get_event retrieves them.
1918 mouse_moved indicates when the mouse has moved again, and
1919 *mouse_position_hook provides the mouse position. */
1920
1921/* Return true iff there are any events in the queue that read-char
1922 would return. If this returns false, a read-char would block. */
1923static int
1924readable_events ()
1925{
1926 return ! EVENT_QUEUES_EMPTY;
1927}
1928
1929/* Set this for debugging, to have a way to get out */
1930int stop_character;
284f4730
JB
1931
1932/* Store an event obtained at interrupt level into kbd_buffer, fifo */
1933
1934void
1935kbd_buffer_store_event (event)
1936 register struct input_event *event;
1937{
1938 if (event->kind == no_event)
1939 abort ();
1940
1941 if (event->kind == ascii_keystroke)
1942 {
e9bf89a0 1943 register int c = event->code & 0377;
284f4730 1944
faf5e407
JB
1945 if (event->modifiers & ctrl_modifier)
1946 c = make_ctrl_char (c);
1947
9fd7d808
RS
1948 c |= (event->modifiers
1949 & (meta_modifier | alt_modifier
1950 | hyper_modifier | super_modifier));
1951
86e5706b 1952 if (c == quit_char)
284f4730 1953 {
3e51c7b7
JB
1954 extern SIGTYPE interrupt_signal ();
1955
07d2b8de 1956#ifdef MULTI_FRAME
284f4730 1957 /* If this results in a quit_char being returned to Emacs as
3c370943 1958 input, set Vlast_event_frame properly. If this doesn't
284f4730 1959 get returned to Emacs as an event, the next event read
ff11dfa1 1960 will set Vlast_event_frame again, so this is safe to do. */
4bb994d1 1961 {
9b8eb840 1962 Lisp_Object focus;
4bb994d1 1963
9b8eb840 1964 focus = FRAME_FOCUS_FRAME (XFRAME (event->frame_or_window));
4bb994d1 1965 if (NILP (focus))
3c370943 1966 internal_last_event_frame = event->frame_or_window;
4bb994d1 1967 else
3c370943
JB
1968 internal_last_event_frame = focus;
1969 Vlast_event_frame = internal_last_event_frame;
4bb994d1 1970 }
07d2b8de 1971#endif
3e51c7b7 1972
ffd56f97 1973 last_event_timestamp = event->timestamp;
284f4730
JB
1974 interrupt_signal ();
1975 return;
1976 }
1977
1978 if (c && c == stop_character)
1979 {
1980 sys_suspend ();
1981 return;
1982 }
284f4730
JB
1983 }
1984
1985 if (kbd_store_ptr - kbd_buffer == KBD_BUFFER_SIZE)
1986 kbd_store_ptr = kbd_buffer;
1987
1988 /* Don't let the very last slot in the buffer become full,
1989 since that would make the two pointers equal,
1990 and that is indistinguishable from an empty buffer.
1991 Discard the event if it would fill the last slot. */
1992 if (kbd_fetch_ptr - 1 != kbd_store_ptr)
1993 {
1994 kbd_store_ptr->kind = event->kind;
27203ead
RS
1995 if (event->kind == selection_request_event)
1996 {
1997 /* We must not use the ordinary copying code for this case,
1998 since `part' is an enum and copying it might not copy enough
1999 in this case. */
2000 bcopy (event, kbd_store_ptr, sizeof (*event));
2001 }
2002 else
2003 {
2004 kbd_store_ptr->code = event->code;
2005 kbd_store_ptr->part = event->part;
2006 kbd_store_ptr->frame_or_window = event->frame_or_window;
2007 kbd_store_ptr->modifiers = event->modifiers;
2008 kbd_store_ptr->x = event->x;
2009 kbd_store_ptr->y = event->y;
2010 kbd_store_ptr->timestamp = event->timestamp;
2011 }
7b4aedb9
JB
2012 (XVECTOR (kbd_buffer_frame_or_window)->contents[kbd_store_ptr
2013 - kbd_buffer]
2014 = event->frame_or_window);
284f4730
JB
2015
2016 kbd_store_ptr++;
2017 }
2018}
a612e298
RS
2019\f
2020/* Read one event from the event buffer, waiting if necessary.
2021 The value is a Lisp object representing the event.
2022 The value is nil for an event that should be ignored,
2023 or that was handled here.
2024 We always read and discard one event. */
284f4730
JB
2025
2026static Lisp_Object
2027kbd_buffer_get_event ()
2028{
2029 register int c;
2030 Lisp_Object obj;
2031
2032 if (noninteractive)
2033 {
2034 c = getchar ();
2035 XSET (obj, Lisp_Int, c);
2036 return obj;
2037 }
2038
2039 /* Wait until there is input available. */
2040 for (;;)
2041 {
284f4730
JB
2042 if (!EVENT_QUEUES_EMPTY)
2043 break;
2044
2045 /* If the quit flag is set, then read_char will return
2046 quit_char, so that counts as "available input." */
2047 if (!NILP (Vquit_flag))
2048 quit_throw_to_read_char ();
2049
2050 /* One way or another, wait until input is available; then, if
2051 interrupt handlers have not read it, read it now. */
2052
2053#ifdef OLDVMS
2054 wait_for_kbd_input ();
2055#else
2056/* Note SIGIO has been undef'd if FIONREAD is missing. */
2057#ifdef SIGIO
2058 gobble_input (0);
2059#endif /* SIGIO */
2060 if (EVENT_QUEUES_EMPTY)
2061 {
f76475ad
JB
2062 Lisp_Object minus_one;
2063
2064 XSET (minus_one, Lisp_Int, -1);
2065 wait_reading_process_input (0, 0, minus_one, 1);
284f4730
JB
2066
2067 if (!interrupt_input && EVENT_QUEUES_EMPTY)
bedae5a5
RS
2068 /* Pass 1 for EXPECT since we just waited to have input. */
2069 read_avail_input (1);
284f4730
JB
2070 }
2071#endif /* not VMS */
2072 }
2073
2074 /* At this point, we know that there is a readable event available
2075 somewhere. If the event queue is empty, then there must be a
2076 mouse movement enabled and available. */
2077 if (kbd_fetch_ptr != kbd_store_ptr)
2078 {
cd21b839 2079 struct input_event *event;
3e51c7b7 2080
856bf263 2081 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
cd21b839
JB
2082 ? kbd_fetch_ptr
2083 : kbd_buffer);
3e51c7b7 2084
cd21b839 2085 last_event_timestamp = event->timestamp;
cd21b839 2086
4bb994d1
JB
2087 obj = Qnil;
2088
48e416d4 2089 /* These two kinds of events get special handling
a612e298
RS
2090 and don't actually appear to the command loop.
2091 We return nil for them. */
48e416d4
RS
2092 if (event->kind == selection_request_event)
2093 {
598a9fa7 2094#ifdef HAVE_X11
48e416d4
RS
2095 x_handle_selection_request (event);
2096 kbd_fetch_ptr = event + 1;
598a9fa7
JB
2097#else
2098 /* We're getting selection request events, but we don't have
2099 a window system. */
2100 abort ();
2101#endif
48e416d4
RS
2102 }
2103
1e12dd87 2104 else if (event->kind == selection_clear_event)
48e416d4 2105 {
598a9fa7 2106#ifdef HAVE_X11
48e416d4
RS
2107 x_handle_selection_clear (event);
2108 kbd_fetch_ptr = event + 1;
598a9fa7
JB
2109#else
2110 /* We're getting selection request events, but we don't have
2111 a window system. */
2112 abort ();
2113#endif
48e416d4 2114 }
990acea3
RS
2115#ifdef HAVE_X11
2116 else if (event->kind == delete_window_event)
2117 {
58f6c8ab
RS
2118 Lisp_Object tail, frame;
2119 struct frame *f;
2120
2121 /* If the user destroys the only frame, Emacs should exit.
2122 Count visible frames and iconified frames. */
2123 for (tail = Vframe_list; CONSP (tail); tail = XCONS (tail)->cdr)
2124 {
2125 frame = XCONS (tail)->car;
2126 if (XTYPE (frame) != Lisp_Frame || EQ (frame, event->frame_or_window))
2127 continue;
2128 f = XFRAME (frame);
2129 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
2130 break;
2131 }
990acea3 2132
58f6c8ab 2133 if (! CONSP (tail))
80e4aa30 2134 Fkill_emacs (Qnil);
854f3a54
RS
2135
2136 Fdelete_frame (event->frame_or_window, Qt);
2137 kbd_fetch_ptr = event + 1;
990acea3
RS
2138 }
2139#endif
f5e09c8b
RS
2140 else if (event->kind == menu_bar_event)
2141 {
2142 /* The event value is in the frame_or_window slot. */
2143 obj = event->frame_or_window;
2144 kbd_fetch_ptr = event + 1;
2145 }
a8015ab5
KH
2146 else if (event->kind == buffer_switch_event)
2147 {
2148 /* The value doesn't matter here; only the type is tested. */
2149 XSET (obj, Lisp_Buffer, current_buffer);
2150 kbd_fetch_ptr = event + 1;
2151 }
a612e298
RS
2152 /* Just discard these, by returning nil.
2153 (They shouldn't be found in the buffer,
2154 but on some machines it appears they do show up.) */
2155 else if (event->kind == no_event)
2156 kbd_fetch_ptr = event + 1;
48e416d4 2157
4bb994d1
JB
2158 /* If this event is on a different frame, return a switch-frame this
2159 time, and leave the event in the queue for next time. */
1e12dd87
RS
2160 else
2161 {
a6d53864 2162#ifdef MULTI_FRAME
9b8eb840 2163 Lisp_Object frame;
1e12dd87 2164 Lisp_Object focus;
7b4aedb9 2165
9b8eb840 2166 frame = event->frame_or_window;
1e12dd87
RS
2167 if (XTYPE (frame) == Lisp_Window)
2168 frame = WINDOW_FRAME (XWINDOW (frame));
4bb994d1 2169
1e12dd87
RS
2170 focus = FRAME_FOCUS_FRAME (XFRAME (frame));
2171 if (! NILP (focus))
2172 frame = focus;
07d2b8de 2173
1e12dd87
RS
2174 if (! EQ (frame, internal_last_event_frame)
2175 && XFRAME (frame) != selected_frame)
2176 obj = make_lispy_switch_frame (frame);
2177 internal_last_event_frame = frame;
a6d53864 2178#endif /* MULTI_FRAME */
4bb994d1 2179
1e12dd87
RS
2180 /* If we didn't decide to make a switch-frame event, go ahead
2181 and build a real event from the queue entry. */
cd21b839 2182
1e12dd87
RS
2183 if (NILP (obj))
2184 {
2185 obj = make_lispy_event (event);
2186
2187 /* Wipe out this event, to catch bugs. */
2188 event->kind = no_event;
2189 (XVECTOR (kbd_buffer_frame_or_window)->contents[event - kbd_buffer]
2190 = Qnil);
2191
2192 kbd_fetch_ptr = event + 1;
2193 }
4bb994d1 2194 }
284f4730 2195 }
a612e298 2196 /* Try generating a mouse motion event. */
284f4730
JB
2197 else if (do_mouse_tracking && mouse_moved)
2198 {
7e85b935 2199 FRAME_PTR f = 0;
7b4aedb9 2200 Lisp_Object bar_window;
3c370943 2201 enum scroll_bar_part part;
e5d77022
JB
2202 Lisp_Object x, y;
2203 unsigned long time;
284f4730 2204
7b4aedb9 2205 (*mouse_position_hook) (&f, &bar_window, &part, &x, &y, &time);
4bb994d1
JB
2206
2207 obj = Qnil;
284f4730 2208
07d2b8de 2209#ifdef MULTI_FRAME
4bb994d1
JB
2210 /* Decide if we should generate a switch-frame event. Don't
2211 generate switch-frame events for motion outside of all Emacs
2212 frames. */
2213 if (f)
cd21b839 2214 {
9b8eb840 2215 Lisp_Object frame;
4bb994d1 2216
9b8eb840 2217 frame = FRAME_FOCUS_FRAME (f);
4bb994d1
JB
2218 if (NILP (frame))
2219 XSET (frame, Lisp_Frame, f);
2220
80645119
JB
2221 if (! EQ (frame, internal_last_event_frame)
2222 && XFRAME (frame) != selected_frame)
764cb3f9 2223 obj = make_lispy_switch_frame (frame);
80645119 2224 internal_last_event_frame = frame;
cd21b839 2225 }
68553292 2226#endif
4bb994d1 2227
68553292 2228#if defined(MULTI_FRAME) || defined(HAVE_MOUSE)
4bb994d1
JB
2229 /* If we didn't decide to make a switch-frame event, go ahead and
2230 return a mouse-motion event. */
2231 if (NILP (obj))
7b4aedb9 2232 obj = make_lispy_movement (f, bar_window, part, x, y, time);
6cbff1cb
RS
2233#endif
2234 }
284f4730
JB
2235 else
2236 /* We were promised by the above while loop that there was
2237 something for us to read! */
2238 abort ();
2239
2240 input_pending = readable_events ();
2241
3c370943
JB
2242#ifdef MULTI_FRAME
2243 Vlast_event_frame = internal_last_event_frame;
2244#endif
2245
284f4730
JB
2246 return (obj);
2247}
a612e298
RS
2248\f
2249/* Process any events that are not user-visible,
2250 then return, without reading any user-visible events. */
3a3b9632
RS
2251
2252void
2253swallow_events ()
2254{
2255 while (kbd_fetch_ptr != kbd_store_ptr)
2256 {
2257 struct input_event *event;
2258
2259 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
2260 ? kbd_fetch_ptr
2261 : kbd_buffer);
2262
2263 last_event_timestamp = event->timestamp;
2264
2265 /* These two kinds of events get special handling
2266 and don't actually appear to the command loop. */
2267 if (event->kind == selection_request_event)
2268 {
2269#ifdef HAVE_X11
2270 x_handle_selection_request (event);
2271 kbd_fetch_ptr = event + 1;
2272#else
2273 /* We're getting selection request events, but we don't have
2274 a window system. */
2275 abort ();
2276#endif
2277 }
2278
2279 else if (event->kind == selection_clear_event)
2280 {
2281#ifdef HAVE_X11
2282 x_handle_selection_clear (event);
2283 kbd_fetch_ptr = event + 1;
2284#else
2285 /* We're getting selection request events, but we don't have
2286 a window system. */
2287 abort ();
2288#endif
2289 }
2290 else
2291 break;
2292 }
2293
2294 get_input_pending (&input_pending);
2295}
a612e298 2296\f
284f4730 2297/* Caches for modify_event_symbol. */
e9bf89a0 2298static Lisp_Object accent_key_syms;
270a208f 2299static Lisp_Object system_key_syms;
284f4730
JB
2300static Lisp_Object func_key_syms;
2301static Lisp_Object mouse_syms;
2302
270a208f 2303Lisp_Object Vsystem_key_alist;
80e4aa30 2304
e9bf89a0
RS
2305/* This is a list of keysym codes for special "accent" characters.
2306 It parallels lispy_accent_keys. */
2307
2308static int lispy_accent_codes[] =
2309{
79a7046c 2310#ifdef XK_dead_circumflex
e9bf89a0 2311 XK_dead_circumflex,
79a7046c
RS
2312#else
2313 0,
2314#endif
2315#ifdef XK_dead_grave
e9bf89a0 2316 XK_dead_grave,
79a7046c
RS
2317#else
2318 0,
2319#endif
2320#ifdef XK_dead_tilde
e9bf89a0 2321 XK_dead_tilde,
79a7046c
RS
2322#else
2323 0,
2324#endif
2325#ifdef XK_dead_diaeresis
e9bf89a0 2326 XK_dead_diaeresis,
79a7046c
RS
2327#else
2328 0,
2329#endif
2330#ifdef XK_dead_macron
e9bf89a0 2331 XK_dead_macron,
79a7046c
RS
2332#else
2333 0,
2334#endif
2335#ifdef XK_dead_degree
e9bf89a0 2336 XK_dead_degree,
79a7046c
RS
2337#else
2338 0,
2339#endif
2340#ifdef XK_dead_acute
e9bf89a0 2341 XK_dead_acute,
79a7046c
RS
2342#else
2343 0,
2344#endif
2345#ifdef XK_dead_cedilla
e9bf89a0 2346 XK_dead_cedilla,
79a7046c
RS
2347#else
2348 0,
2349#endif
2350#ifdef XK_dead_breve
e9bf89a0 2351 XK_dead_breve,
79a7046c
RS
2352#else
2353 0,
2354#endif
2355#ifdef XK_dead_ogonek
e9bf89a0 2356 XK_dead_ogonek,
79a7046c
RS
2357#else
2358 0,
2359#endif
2360#ifdef XK_dead_caron
e9bf89a0 2361 XK_dead_caron,
79a7046c
RS
2362#else
2363 0,
2364#endif
2365#ifdef XK_dead_doubleacute
e9bf89a0 2366 XK_dead_doubleacute,
79a7046c
RS
2367#else
2368 0,
2369#endif
2370#ifdef XK_dead_abovedot
e9bf89a0 2371 XK_dead_abovedot,
79a7046c
RS
2372#else
2373 0,
2374#endif
e9bf89a0
RS
2375};
2376
2377/* This is a list of Lisp names for special "accent" characters.
2378 It parallels lispy_accent_codes. */
2379
2380static char *lispy_accent_keys[] =
2381{
2382 "dead-circumflex",
2383 "dead-grave",
2384 "dead-tilde",
2385 "dead-diaeresis",
2386 "dead-macron",
2387 "dead-degree",
2388 "dead-acute",
2389 "dead-cedilla",
2390 "dead-breve",
2391 "dead-ogonek",
2392 "dead-caron",
2393 "dead-doubleacute",
2394 "dead-abovedot",
2395};
2396
284f4730
JB
2397/* You'll notice that this table is arranged to be conveniently
2398 indexed by X Windows keysym values. */
2399static char *lispy_function_keys[] =
2400 {
2401 /* X Keysym value */
2402
80e4aa30 2403 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
86e5706b
RS
2404 "backspace",
2405 "tab",
2406 "linefeed",
2407 "clear",
2408 0,
2409 "return",
2410 0, 0,
2411 0, 0, 0, /* 0xff10 */
2412 "pause",
2413 0, 0, 0, 0, 0, 0, 0,
2414 "escape",
2415 0, 0, 0, 0,
2416 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2417 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2418 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2419
284f4730
JB
2420 "home", /* 0xff50 */ /* IsCursorKey */
2421 "left",
2422 "up",
2423 "right",
2424 "down",
2425 "prior",
2426 "next",
2427 "end",
2428 "begin",
2429 0, /* 0xff59 */
2430 0, 0, 0, 0, 0, 0,
2431 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2432 "print",
2433 "execute",
2434 "insert",
2435 0, /* 0xff64 */
2436 "undo",
2437 "redo",
2438 "menu",
2439 "find",
2440 "cancel",
2441 "help",
2442 "break", /* 0xff6b */
2443
9fdbfdf8 2444 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
284f4730 2445 0, /* 0xff76 */
36ae397e 2446 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
284f4730
JB
2447 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2448 0, 0, 0, 0, 0, 0, 0, 0,
2449 "kp-tab", /* 0xff89 */
2450 0, 0, 0,
2451 "kp-enter", /* 0xff8d */
2452 0, 0, 0,
2453 "kp-f1", /* 0xff91 */
2454 "kp-f2",
2455 "kp-f3",
2456 "kp-f4",
872157e7
RS
2457 "kp-home", /* 0xff95 */
2458 "kp-left",
2459 "kp-up",
2460 "kp-right",
2461 "kp-down",
2462 "kp-prior", /* kp-page-up */
2463 "kp-next", /* kp-page-down */
2464 "kp-end",
2465 "kp-begin",
2466 "kp-insert",
2467 "kp-delete",
2468 0, /* 0xffa0 */
2469 0, 0, 0, 0, 0, 0, 0, 0, 0,
284f4730
JB
2470 "kp-multiply", /* 0xffaa */
2471 "kp-add",
2472 "kp-separator",
2473 "kp-subtract",
2474 "kp-decimal",
2475 "kp-divide", /* 0xffaf */
2476 "kp-0", /* 0xffb0 */
2477 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2478 0, /* 0xffba */
2479 0, 0,
2480 "kp-equal", /* 0xffbd */
2481 "f1", /* 0xffbe */ /* IsFunctionKey */
86e5706b
RS
2482 "f2",
2483 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2484 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2485 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2486 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2487 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2488 0, 0, 0, 0, 0, 0, 0, 0,
2489 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2490 0, 0, 0, 0, 0, 0, 0, "delete"
284f4730
JB
2491 };
2492
2493static char *lispy_mouse_names[] =
2494{
2495 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2496};
2497
3c370943 2498/* Scroll bar parts. */
4bb994d1
JB
2499Lisp_Object Qabove_handle, Qhandle, Qbelow_handle;
2500
3c370943
JB
2501/* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2502Lisp_Object *scroll_bar_parts[] = {
4bb994d1
JB
2503 &Qabove_handle, &Qhandle, &Qbelow_handle
2504};
2505
2506
7b4aedb9 2507/* A vector, indexed by button number, giving the down-going location
3c370943 2508 of currently depressed buttons, both scroll bar and non-scroll bar.
7b4aedb9
JB
2509
2510 The elements have the form
2511 (BUTTON-NUMBER MODIFIER-MASK . REST)
2512 where REST is the cdr of a position as it would be reported in the event.
2513
2514 The make_lispy_event function stores positions here to tell the
2515 difference between click and drag events, and to store the starting
2516 location to be included in drag events. */
2517
2518static Lisp_Object button_down_location;
88cb0656 2519
fbcd35bd
JB
2520/* Information about the most recent up-going button event: Which
2521 button, what location, and what time. */
2522
559f9d04
RS
2523static int last_mouse_button;
2524static int last_mouse_x;
2525static int last_mouse_y;
2526static unsigned long button_down_time;
fbcd35bd 2527
564dc952
JB
2528/* The maximum time between clicks to make a double-click,
2529 or Qnil to disable double-click detection,
2530 or Qt for no time limit. */
2531Lisp_Object Vdouble_click_time;
fbcd35bd
JB
2532
2533/* The number of clicks in this multiple-click. */
2534
2535int double_click_count;
2536
bb936752
FP
2537#ifdef USE_X_TOOLKIT
2538extern Lisp_Object map_event_to_object ();
2539#endif /* USE_X_TOOLKIT */
2540
284f4730
JB
2541/* Given a struct input_event, build the lisp event which represents
2542 it. If EVENT is 0, build a mouse movement event from the mouse
88cb0656
JB
2543 movement buffer, which should have a movement event in it.
2544
2545 Note that events must be passed to this function in the order they
2546 are received; this function stores the location of button presses
2547 in order to build drag events when the button is released. */
284f4730
JB
2548
2549static Lisp_Object
2550make_lispy_event (event)
2551 struct input_event *event;
2552{
79a7046c
RS
2553 int i;
2554
284f4730
JB
2555#ifdef SWITCH_ENUM_BUG
2556 switch ((int) event->kind)
2557#else
2558 switch (event->kind)
2559#endif
2560 {
284f4730
JB
2561 /* A simple keystroke. */
2562 case ascii_keystroke:
86e5706b 2563 {
e9bf89a0 2564 int c = event->code & 0377;
5a1c6df8
JB
2565 /* Turn ASCII characters into control characters
2566 when proper. */
2567 if (event->modifiers & ctrl_modifier)
d205953b
JB
2568 c = make_ctrl_char (c);
2569
2570 /* Add in the other modifier bits. We took care of ctrl_modifier
2571 just above, and the shift key was taken care of by the X code,
2572 and applied to control characters by make_ctrl_char. */
86e5706b
RS
2573 c |= (event->modifiers
2574 & (meta_modifier | alt_modifier
2575 | hyper_modifier | super_modifier));
559f9d04 2576 button_down_time = 0;
86e5706b
RS
2577 return c;
2578 }
284f4730
JB
2579
2580 /* A function key. The symbol may need to have modifier prefixes
2581 tacked onto it. */
2582 case non_ascii_keystroke:
559f9d04 2583 button_down_time = 0;
e9bf89a0
RS
2584
2585 for (i = 0; i < sizeof (lispy_accent_codes) / sizeof (int); i++)
2586 if (event->code == lispy_accent_codes[i])
2587 return modify_event_symbol (i,
2588 event->modifiers,
80e4aa30 2589 Qfunction_key, Qnil,
e9bf89a0
RS
2590 lispy_accent_keys, &accent_key_syms,
2591 (sizeof (lispy_accent_keys)
2592 / sizeof (lispy_accent_keys[0])));
2593
270a208f 2594 /* Handle system-specific keysyms. */
80e4aa30
RS
2595 if (event->code & (1 << 28))
2596 {
2597 /* We need to use an alist rather than a vector as the cache
2598 since we can't make a vector long enuf. */
270a208f
RS
2599 if (NILP (system_key_syms))
2600 system_key_syms = Fcons (Qnil, Qnil);
80e4aa30
RS
2601 return modify_event_symbol (event->code & 0xffffff,
2602 event->modifiers,
270a208f
RS
2603 Qfunction_key, Vsystem_key_alist,
2604 0, &system_key_syms, 0xffffff);
80e4aa30
RS
2605 }
2606
e9bf89a0
RS
2607 return modify_event_symbol (event->code - 0xff00,
2608 event->modifiers,
80e4aa30 2609 Qfunction_key, Qnil,
284f4730
JB
2610 lispy_function_keys, &func_key_syms,
2611 (sizeof (lispy_function_keys)
2612 / sizeof (lispy_function_keys[0])));
2613 break;
2614
5846638c 2615#if defined(MULTI_FRAME) || defined(HAVE_MOUSE)
88cb0656
JB
2616 /* A mouse click. Figure out where it is, decide whether it's
2617 a press, click or drag, and build the appropriate structure. */
284f4730 2618 case mouse_click:
3c370943 2619 case scroll_bar_click:
284f4730 2620 {
e9bf89a0 2621 int button = event->code;
559f9d04 2622 int is_double;
7b4aedb9 2623 Lisp_Object position;
dbc4e1c1
JB
2624 Lisp_Object *start_pos_ptr;
2625 Lisp_Object start_pos;
284f4730 2626
7b4aedb9 2627 if (button < 0 || button >= NUM_MOUSE_BUTTONS)
88cb0656
JB
2628 abort ();
2629
7b4aedb9
JB
2630 /* Build the position as appropriate for this mouse click. */
2631 if (event->kind == mouse_click)
284f4730 2632 {
7b4aedb9 2633 int part;
598a9fa7 2634 FRAME_PTR f = XFRAME (event->frame_or_window);
0aafc975 2635 Lisp_Object window;
7b4aedb9 2636 Lisp_Object posn;
9e20143a
RS
2637 int row, column;
2638
5da3133a
RS
2639 /* Ignore mouse events that were made on frame that
2640 have been deleted. */
2641 if (! FRAME_LIVE_P (f))
2642 return Qnil;
2643
9e20143a
RS
2644 pixel_to_glyph_coords (f, XINT (event->x), XINT (event->y),
2645 &column, &row, 0, 0);
7b4aedb9 2646
bb936752
FP
2647#ifdef USE_X_TOOLKIT
2648 if (FRAME_EXTERNAL_MENU_BAR (f) && XINT (event->y) == -1)
7b260679 2649#else
9e20143a 2650 if (row < FRAME_MENU_BAR_LINES (f))
7b260679 2651#endif
bb936752 2652 {
b7c49376 2653 Lisp_Object items, item;
0a0e8fe6
RS
2654 int hpos;
2655 int i;
2656
2657 /* Activate the menu bar on the down event. If the
2658 up event comes in before the menu code can deal with it,
2659 just ignore it. */
2660 if (! (event->modifiers & down_modifier))
2661 return Qnil;
0aafc975 2662
7b260679 2663#ifdef USE_X_TOOLKIT
bb936752
FP
2664 /* The click happened in the menubar.
2665 Look for the menu item selected. */
b7c49376 2666 item = map_event_to_object (event, f);
0aafc975 2667
bb936752
FP
2668 XFASTINT (event->y) = 1;
2669#else /* not USE_X_TOOLKIT */
f2ae6b3f 2670 item = Qnil;
5ec75a55 2671 items = FRAME_MENU_BAR_ITEMS (f);
b7c49376 2672 for (i = 0; i < XVECTOR (items)->size; i += 3)
5ec75a55
RS
2673 {
2674 Lisp_Object pos, string;
b7c49376
RS
2675 string = XVECTOR (items)->contents[i + 1];
2676 pos = XVECTOR (items)->contents[i + 2];
2677 if (NILP (string))
2678 break;
9e20143a
RS
2679 if (column >= XINT (pos)
2680 && column < XINT (pos) + XSTRING (string)->size)
b7c49376
RS
2681 {
2682 item = XVECTOR (items)->contents[i];
2683 break;
2684 }
5ec75a55 2685 }
bb936752 2686#endif /* not USE_X_TOOLKIT */
9e20143a 2687
5ec75a55
RS
2688 position
2689 = Fcons (event->frame_or_window,
2690 Fcons (Qmenu_bar,
2691 Fcons (Fcons (event->x, event->y),
2692 Fcons (make_number (event->timestamp),
2693 Qnil))));
2694
b7c49376 2695 return Fcons (item, Fcons (position, Qnil));
5ec75a55 2696 }
0aafc975 2697
9e20143a 2698 window = window_from_coordinates (f, column, row, &part);
0aafc975
RS
2699
2700 if (XTYPE (window) != Lisp_Window)
78ced549
RS
2701 {
2702 window = event->frame_or_window;
2703 posn = Qnil;
2704 }
284f4730 2705 else
7b4aedb9 2706 {
9e20143a
RS
2707 int pixcolumn, pixrow;
2708 column -= XINT (XWINDOW (window)->left);
2709 row -= XINT (XWINDOW (window)->top);
2710 glyph_to_pixel_coords (f, column, row, &pixcolumn, &pixrow);
2711 XSETINT (event->x, pixcolumn);
2712 XSETINT (event->y, pixrow);
dbc4e1c1 2713
7b4aedb9
JB
2714 if (part == 1)
2715 posn = Qmode_line;
2716 else if (part == 2)
2717 posn = Qvertical_line;
2718 else
dbc4e1c1
JB
2719 XSET (posn, Lisp_Int,
2720 buffer_posn_from_coords (XWINDOW (window),
9e20143a 2721 column, row));
7b4aedb9
JB
2722 }
2723
5ec75a55
RS
2724 position
2725 = Fcons (window,
2726 Fcons (posn,
2727 Fcons (Fcons (event->x, event->y),
2728 Fcons (make_number (event->timestamp),
2729 Qnil))));
284f4730 2730 }
7b4aedb9 2731 else
88cb0656 2732 {
9e20143a
RS
2733 Lisp_Object window;
2734 Lisp_Object portion_whole;
2735 Lisp_Object part;
2736
2737 window = event->frame_or_window;
2738 portion_whole = Fcons (event->x, event->y);
2739 part = *scroll_bar_parts[(int) event->part];
7b4aedb9
JB
2740
2741 position =
2742 Fcons (window,
3c370943 2743 Fcons (Qvertical_scroll_bar,
7b4aedb9
JB
2744 Fcons (portion_whole,
2745 Fcons (make_number (event->timestamp),
9e20143a 2746 Fcons (part, Qnil)))));
88cb0656
JB
2747 }
2748
dbc4e1c1
JB
2749 start_pos_ptr = &XVECTOR (button_down_location)->contents[button];
2750
2751 start_pos = *start_pos_ptr;
2752 *start_pos_ptr = Qnil;
7b4aedb9 2753
559f9d04
RS
2754 is_double = (button == last_mouse_button
2755 && XINT (event->x) == last_mouse_x
2756 && XINT (event->y) == last_mouse_y
2757 && button_down_time != 0
2758 && (EQ (Vdouble_click_time, Qt)
2759 || (INTEGERP (Vdouble_click_time)
2760 && ((int)(event->timestamp - button_down_time)
2761 < XINT (Vdouble_click_time)))));
2762 last_mouse_button = button;
2763 last_mouse_x = XINT (event->x);
2764 last_mouse_y = XINT (event->y);
2765
7b4aedb9
JB
2766 /* If this is a button press, squirrel away the location, so
2767 we can decide later whether it was a click or a drag. */
2768 if (event->modifiers & down_modifier)
559f9d04
RS
2769 {
2770 if (is_double)
2771 {
2772 double_click_count++;
2773 event->modifiers |= ((double_click_count > 2)
2774 ? triple_modifier
2775 : double_modifier);
2776 }
2777 else
2778 double_click_count = 1;
2779 button_down_time = event->timestamp;
2780 *start_pos_ptr = Fcopy_alist (position);
2781 }
7b4aedb9 2782
88cb0656 2783 /* Now we're releasing a button - check the co-ordinates to
7b4aedb9 2784 see if this was a click or a drag. */
88cb0656
JB
2785 else if (event->modifiers & up_modifier)
2786 {
48e416d4
RS
2787 /* If we did not see a down before this up,
2788 ignore the up. Probably this happened because
2789 the down event chose a menu item.
2790 It would be an annoyance to treat the release
2791 of the button that chose the menu item
2792 as a separate event. */
2793
2794 if (XTYPE (start_pos) != Lisp_Cons)
2795 return Qnil;
2796
88cb0656 2797 event->modifiers &= ~up_modifier;
48e416d4 2798#if 0 /* Formerly we treated an up with no down as a click event. */
dbc4e1c1
JB
2799 if (XTYPE (start_pos) != Lisp_Cons)
2800 event->modifiers |= click_modifier;
2801 else
48e416d4 2802#endif
dbc4e1c1
JB
2803 {
2804 /* The third element of every position should be the (x,y)
2805 pair. */
9b8eb840 2806 Lisp_Object down;
dbc4e1c1 2807
9b8eb840 2808 down = Fnth (make_number (2), start_pos);
fbcd35bd
JB
2809 if (EQ (event->x, XCONS (down)->car)
2810 && EQ (event->y, XCONS (down)->cdr))
2811 {
559f9d04
RS
2812 if (is_double && double_click_count > 1)
2813 event->modifiers |= ((double_click_count > 2)
2814 ? triple_modifier
2815 : double_modifier);
fbcd35bd 2816 else
559f9d04 2817 event->modifiers |= click_modifier;
fbcd35bd
JB
2818 }
2819 else
2820 {
559f9d04 2821 button_down_time = 0;
fbcd35bd
JB
2822 event->modifiers |= drag_modifier;
2823 }
dbc4e1c1 2824 }
88cb0656
JB
2825 }
2826 else
2827 /* Every mouse event should either have the down_modifier or
7b4aedb9 2828 the up_modifier set. */
88cb0656
JB
2829 abort ();
2830
88cb0656 2831 {
7b4aedb9 2832 /* Get the symbol we should use for the mouse click. */
9b8eb840
KH
2833 Lisp_Object head;
2834
2835 head = modify_event_symbol (button,
2836 event->modifiers,
2837 Qmouse_click, Qnil,
2838 lispy_mouse_names, &mouse_syms,
2839 (sizeof (lispy_mouse_names)
2840 / sizeof (lispy_mouse_names[0])));
88cb0656 2841 if (event->modifiers & drag_modifier)
dbc4e1c1
JB
2842 return Fcons (head,
2843 Fcons (start_pos,
2844 Fcons (position,
2845 Qnil)));
fbcd35bd
JB
2846 else if (event->modifiers & (double_modifier | triple_modifier))
2847 return Fcons (head,
2848 Fcons (position,
2849 Fcons (make_number (double_click_count),
2850 Qnil)));
88cb0656
JB
2851 else
2852 return Fcons (head,
7b4aedb9 2853 Fcons (position,
88cb0656
JB
2854 Qnil));
2855 }
284f4730 2856 }
5846638c 2857#endif /* MULTI_FRAME or HAVE_MOUSE */
284f4730 2858
284f4730
JB
2859 /* The 'kind' field of the event is something we don't recognize. */
2860 default:
48e416d4 2861 abort ();
284f4730
JB
2862 }
2863}
2864
68553292 2865#if defined(MULTI_FRAME) || defined(HAVE_MOUSE)
6cbff1cb 2866
284f4730 2867static Lisp_Object
7b4aedb9 2868make_lispy_movement (frame, bar_window, part, x, y, time)
ff11dfa1 2869 FRAME_PTR frame;
7b4aedb9 2870 Lisp_Object bar_window;
3c370943 2871 enum scroll_bar_part part;
284f4730 2872 Lisp_Object x, y;
e5d77022 2873 unsigned long time;
284f4730 2874{
68553292 2875#ifdef MULTI_FRAME
3c370943 2876 /* Is it a scroll bar movement? */
7b4aedb9 2877 if (frame && ! NILP (bar_window))
4bb994d1 2878 {
9b8eb840 2879 Lisp_Object part_sym;
4bb994d1 2880
9b8eb840 2881 part_sym = *scroll_bar_parts[(int) part];
3c370943 2882 return Fcons (Qscroll_bar_movement,
7b4aedb9 2883 (Fcons (Fcons (bar_window,
3c370943 2884 Fcons (Qvertical_scroll_bar,
4bb994d1
JB
2885 Fcons (Fcons (x, y),
2886 Fcons (make_number (time),
cb5df6ae 2887 Fcons (part_sym,
4bb994d1
JB
2888 Qnil))))),
2889 Qnil)));
2890 }
2891
2892 /* Or is it an ordinary mouse movement? */
284f4730 2893 else
68553292 2894#endif /* MULTI_FRAME */
284f4730 2895 {
4bb994d1 2896 int area;
9e20143a 2897 Lisp_Object window;
4bb994d1 2898 Lisp_Object posn;
9e20143a
RS
2899 int column, row;
2900
68553292 2901#ifdef MULTI_FRAME
9e20143a 2902 if (frame)
68553292
RS
2903#else
2904 if (1)
2905#endif
047688cb
RS
2906 {
2907 /* It's in a frame; which window on that frame? */
2908 pixel_to_glyph_coords (frame, XINT (x), XINT (y), &column, &row, 0, 1);
2909 window = window_from_coordinates (frame, column, row, &area);
2910 }
9e20143a
RS
2911 else
2912 window = Qnil;
4bb994d1
JB
2913
2914 if (XTYPE (window) == Lisp_Window)
2915 {
9e20143a
RS
2916 int pixcolumn, pixrow;
2917 column -= XINT (XWINDOW (window)->left);
2918 row -= XINT (XWINDOW (window)->top);
2919 glyph_to_pixel_coords (frame, column, row, &pixcolumn, &pixrow);
2920 XSETINT (x, pixcolumn);
2921 XSETINT (y, pixrow);
4bb994d1
JB
2922
2923 if (area == 1)
2924 posn = Qmode_line;
2925 else if (area == 2)
2926 posn = Qvertical_line;
2927 else
2928 XSET (posn, Lisp_Int,
9e20143a 2929 buffer_posn_from_coords (XWINDOW (window), column, row));
4bb994d1 2930 }
68553292 2931#ifdef MULTI_FRAME
e9bf89a0
RS
2932 else if (frame != 0)
2933 {
2934 XSET (window, Lisp_Frame, frame);
2935 posn = Qnil;
2936 }
68553292 2937#endif
284f4730 2938 else
4bb994d1
JB
2939 {
2940 window = Qnil;
2941 posn = Qnil;
f76b81d6
JB
2942 XFASTINT (x) = 0;
2943 XFASTINT (y) = 0;
4bb994d1 2944 }
284f4730 2945
4bb994d1
JB
2946 return Fcons (Qmouse_movement,
2947 Fcons (Fcons (window,
2948 Fcons (posn,
2949 Fcons (Fcons (x, y),
2950 Fcons (make_number (time),
2951 Qnil)))),
2952 Qnil));
2953 }
284f4730
JB
2954}
2955
68553292 2956#endif /* neither MULTI_FRAME nor HAVE_MOUSE */
6cbff1cb 2957
cd21b839
JB
2958/* Construct a switch frame event. */
2959static Lisp_Object
2960make_lispy_switch_frame (frame)
2961 Lisp_Object frame;
2962{
2963 return Fcons (Qswitch_frame, Fcons (frame, Qnil));
2964}
0a7f1fc0
JB
2965\f
2966/* Manipulating modifiers. */
284f4730 2967
0a7f1fc0 2968/* Parse the name of SYMBOL, and return the set of modifiers it contains.
284f4730 2969
0a7f1fc0
JB
2970 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2971 SYMBOL's name of the end of the modifiers; the string from this
2972 position is the unmodified symbol name.
284f4730 2973
0a7f1fc0
JB
2974 This doesn't use any caches. */
2975static int
2976parse_modifiers_uncached (symbol, modifier_end)
284f4730 2977 Lisp_Object symbol;
0a7f1fc0 2978 int *modifier_end;
284f4730
JB
2979{
2980 struct Lisp_String *name;
2981 int i;
2982 int modifiers;
284f4730
JB
2983
2984 CHECK_SYMBOL (symbol, 1);
2985
2986 modifiers = 0;
2987 name = XSYMBOL (symbol)->name;
2988
284f4730 2989
0a7f1fc0 2990 for (i = 0; i+2 <= name->size; )
284f4730
JB
2991 switch (name->data[i])
2992 {
0a7f1fc0
JB
2993#define SINGLE_LETTER_MOD(bit) \
2994 if (name->data[i+1] != '-') \
2995 goto no_more_modifiers; \
2996 modifiers |= bit; \
fce33686 2997 i += 2;
0a7f1fc0
JB
2998
2999 case 'A':
3000 SINGLE_LETTER_MOD (alt_modifier);
284f4730
JB
3001 break;
3002
3003 case 'C':
0a7f1fc0 3004 SINGLE_LETTER_MOD (ctrl_modifier);
fce33686
JB
3005 break;
3006
3007 case 'H':
0a7f1fc0 3008 SINGLE_LETTER_MOD (hyper_modifier);
fce33686
JB
3009 break;
3010
3011 case 'M':
0a7f1fc0 3012 SINGLE_LETTER_MOD (meta_modifier);
284f4730
JB
3013 break;
3014
3015 case 'S':
0a7f1fc0 3016 SINGLE_LETTER_MOD (shift_modifier);
fce33686
JB
3017 break;
3018
3019 case 's':
86e5706b 3020 SINGLE_LETTER_MOD (super_modifier);
284f4730
JB
3021 break;
3022
fce33686
JB
3023 case 'd':
3024 if (i + 5 > name->size)
3025 goto no_more_modifiers;
3026 if (! strncmp (name->data + i, "drag-", 5))
3027 {
fce33686
JB
3028 modifiers |= drag_modifier;
3029 i += 5;
3030 }
3031 else if (! strncmp (name->data + i, "down-", 5))
3032 {
fce33686
JB
3033 modifiers |= down_modifier;
3034 i += 5;
3035 }
fbcd35bd
JB
3036 else if (i + 7 <= name->size
3037 && ! strncmp (name->data + i, "double-", 7))
3038 {
3039 modifiers |= double_modifier;
3040 i += 7;
3041 }
3042 else
3043 goto no_more_modifiers;
3044 break;
3045
3046 case 't':
3047 if (i + 7 > name->size)
3048 goto no_more_modifiers;
3049 if (! strncmp (name->data + i, "triple-", 7))
3050 {
3051 modifiers |= triple_modifier;
3052 i += 7;
3053 }
fce33686
JB
3054 else
3055 goto no_more_modifiers;
284f4730
JB
3056 break;
3057
3058 default:
3059 goto no_more_modifiers;
0a7f1fc0
JB
3060
3061#undef SINGLE_LETTER_MOD
284f4730
JB
3062 }
3063 no_more_modifiers:
3064
0a7f1fc0 3065 /* Should we include the `click' modifier? */
fbcd35bd
JB
3066 if (! (modifiers & (down_modifier | drag_modifier
3067 | double_modifier | triple_modifier))
0a7f1fc0 3068 && i + 7 == name->size
4bb994d1 3069 && strncmp (name->data + i, "mouse-", 6) == 0
6569cc8d 3070 && ('0' <= name->data[i + 6] && name->data[i + 6] <= '9'))
0a7f1fc0
JB
3071 modifiers |= click_modifier;
3072
3073 if (modifier_end)
3074 *modifier_end = i;
3075
3076 return modifiers;
3077}
3078
3079
3080/* Return a symbol whose name is the modifier prefixes for MODIFIERS
3081 prepended to the string BASE[0..BASE_LEN-1].
3082 This doesn't use any caches. */
3083static Lisp_Object
3084apply_modifiers_uncached (modifiers, base, base_len)
3085 int modifiers;
3086 char *base;
3087 int base_len;
3088{
3089 /* Since BASE could contain nulls, we can't use intern here; we have
3090 to use Fintern, which expects a genuine Lisp_String, and keeps a
3091 reference to it. */
3092 char *new_mods =
fbcd35bd 3093 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
0a7f1fc0 3094 int mod_len;
284f4730 3095
284f4730 3096 {
0a7f1fc0
JB
3097 char *p = new_mods;
3098
3099 /* Only the event queue may use the `up' modifier; it should always
3100 be turned into a click or drag event before presented to lisp code. */
3101 if (modifiers & up_modifier)
3102 abort ();
3103
3104 if (modifiers & alt_modifier) { *p++ = 'A'; *p++ = '-'; }
3105 if (modifiers & ctrl_modifier) { *p++ = 'C'; *p++ = '-'; }
3106 if (modifiers & hyper_modifier) { *p++ = 'H'; *p++ = '-'; }
3107 if (modifiers & meta_modifier) { *p++ = 'M'; *p++ = '-'; }
3108 if (modifiers & shift_modifier) { *p++ = 'S'; *p++ = '-'; }
86e5706b 3109 if (modifiers & super_modifier) { *p++ = 's'; *p++ = '-'; }
fbcd35bd
JB
3110 if (modifiers & double_modifier) { strcpy (p, "double-"); p += 7; }
3111 if (modifiers & triple_modifier) { strcpy (p, "triple-"); p += 7; }
559f9d04
RS
3112 if (modifiers & down_modifier) { strcpy (p, "down-"); p += 5; }
3113 if (modifiers & drag_modifier) { strcpy (p, "drag-"); p += 5; }
0a7f1fc0
JB
3114 /* The click modifier is denoted by the absence of other modifiers. */
3115
3116 *p = '\0';
3117
3118 mod_len = p - new_mods;
3119 }
284f4730 3120
0a7f1fc0 3121 {
9b8eb840 3122 Lisp_Object new_name;
0a7f1fc0 3123
9b8eb840 3124 new_name = make_uninit_string (mod_len + base_len);
0a7f1fc0
JB
3125 bcopy (new_mods, XSTRING (new_name)->data, mod_len);
3126 bcopy (base, XSTRING (new_name)->data + mod_len, base_len);
284f4730
JB
3127
3128 return Fintern (new_name, Qnil);
3129 }
3130}
3131
3132
0a7f1fc0
JB
3133static char *modifier_names[] =
3134{
fbcd35bd 3135 "up", "down", "drag", "click", "double", "triple", 0, 0,
1dfdf9e2 3136 0, 0, 0, 0, 0, 0, 0, 0,
86e5706b 3137 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
0a7f1fc0 3138};
80645119 3139#define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
0a7f1fc0
JB
3140
3141static Lisp_Object modifier_symbols;
3142
3143/* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
3144static Lisp_Object
3145lispy_modifier_list (modifiers)
3146 int modifiers;
3147{
3148 Lisp_Object modifier_list;
3149 int i;
3150
3151 modifier_list = Qnil;
80645119 3152 for (i = 0; (1<<i) <= modifiers && i < NUM_MOD_NAMES; i++)
0a7f1fc0 3153 if (modifiers & (1<<i))
80645119
JB
3154 modifier_list = Fcons (XVECTOR (modifier_symbols)->contents[i],
3155 modifier_list);
0a7f1fc0
JB
3156
3157 return modifier_list;
3158}
3159
3160
3161/* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
3162 where UNMODIFIED is the unmodified form of SYMBOL,
3163 MASK is the set of modifiers present in SYMBOL's name.
3164 This is similar to parse_modifiers_uncached, but uses the cache in
3165 SYMBOL's Qevent_symbol_element_mask property, and maintains the
3166 Qevent_symbol_elements property. */
3167static Lisp_Object
3168parse_modifiers (symbol)
3169 Lisp_Object symbol;
3170{
9b8eb840 3171 Lisp_Object elements;
0a7f1fc0 3172
9b8eb840 3173 elements = Fget (symbol, Qevent_symbol_element_mask);
0a7f1fc0
JB
3174 if (CONSP (elements))
3175 return elements;
3176 else
3177 {
3178 int end;
3179 int modifiers = parse_modifiers_uncached (symbol, &end);
9b8eb840 3180 Lisp_Object unmodified;
0a7f1fc0
JB
3181 Lisp_Object mask;
3182
9b8eb840
KH
3183 unmodified = Fintern (make_string (XSYMBOL (symbol)->name->data + end,
3184 XSYMBOL (symbol)->name->size - end),
3185 Qnil);
3186
734fef94
JB
3187 if (modifiers & ~((1<<VALBITS) - 1))
3188 abort ();
0a7f1fc0
JB
3189 XFASTINT (mask) = modifiers;
3190 elements = Fcons (unmodified, Fcons (mask, Qnil));
3191
3192 /* Cache the parsing results on SYMBOL. */
3193 Fput (symbol, Qevent_symbol_element_mask,
3194 elements);
3195 Fput (symbol, Qevent_symbol_elements,
3196 Fcons (unmodified, lispy_modifier_list (modifiers)));
3197
3198 /* Since we know that SYMBOL is modifiers applied to unmodified,
3199 it would be nice to put that in unmodified's cache.
3200 But we can't, since we're not sure that parse_modifiers is
3201 canonical. */
3202
3203 return elements;
3204 }
3205}
3206
3207/* Apply the modifiers MODIFIERS to the symbol BASE.
3208 BASE must be unmodified.
3209
3210 This is like apply_modifiers_uncached, but uses BASE's
3211 Qmodifier_cache property, if present. It also builds
cd21b839
JB
3212 Qevent_symbol_elements properties, since it has that info anyway.
3213
3214 apply_modifiers copies the value of BASE's Qevent_kind property to
3215 the modified symbol. */
0a7f1fc0
JB
3216static Lisp_Object
3217apply_modifiers (modifiers, base)
3218 int modifiers;
3219 Lisp_Object base;
3220{
7b4aedb9 3221 Lisp_Object cache, index, entry, new_symbol;
0a7f1fc0 3222
80645119
JB
3223 /* Mask out upper bits. We don't know where this value's been. */
3224 modifiers &= (1<<VALBITS) - 1;
3225
0a7f1fc0 3226 /* The click modifier never figures into cache indices. */
0a7f1fc0 3227 cache = Fget (base, Qmodifier_cache);
cd21b839 3228 XFASTINT (index) = (modifiers & ~click_modifier);
697e4895 3229 entry = assq_no_quit (index, cache);
0a7f1fc0
JB
3230
3231 if (CONSP (entry))
7b4aedb9
JB
3232 new_symbol = XCONS (entry)->cdr;
3233 else
3234 {
3235 /* We have to create the symbol ourselves. */
3236 new_symbol = apply_modifiers_uncached (modifiers,
3237 XSYMBOL (base)->name->data,
3238 XSYMBOL (base)->name->size);
3239
3240 /* Add the new symbol to the base's cache. */
3241 entry = Fcons (index, new_symbol);
3242 Fput (base, Qmodifier_cache, Fcons (entry, cache));
3243
3244 /* We have the parsing info now for free, so add it to the caches. */
3245 XFASTINT (index) = modifiers;
3246 Fput (new_symbol, Qevent_symbol_element_mask,
3247 Fcons (base, Fcons (index, Qnil)));
3248 Fput (new_symbol, Qevent_symbol_elements,
3249 Fcons (base, lispy_modifier_list (modifiers)));
3250 }
0a7f1fc0 3251
7b4aedb9
JB
3252 /* Make sure this symbol is of the same kind as BASE.
3253
3254 You'd think we could just set this once and for all when we
3255 intern the symbol above, but reorder_modifiers may call us when
3256 BASE's property isn't set right; we can't assume that just
80645119
JB
3257 because it has a Qmodifier_cache property it must have its
3258 Qevent_kind set right as well. */
7b4aedb9
JB
3259 if (NILP (Fget (new_symbol, Qevent_kind)))
3260 {
9b8eb840 3261 Lisp_Object kind;
7b4aedb9 3262
9b8eb840 3263 kind = Fget (base, Qevent_kind);
7b4aedb9
JB
3264 if (! NILP (kind))
3265 Fput (new_symbol, Qevent_kind, kind);
3266 }
3267
3268 return new_symbol;
0a7f1fc0
JB
3269}
3270
3271
3272/* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
3273 return a symbol with the modifiers placed in the canonical order.
3274 Canonical order is alphabetical, except for down and drag, which
3275 always come last. The 'click' modifier is never written out.
3276
3277 Fdefine_key calls this to make sure that (for example) C-M-foo
3278 and M-C-foo end up being equivalent in the keymap. */
3279
3280Lisp_Object
3281reorder_modifiers (symbol)
3282 Lisp_Object symbol;
3283{
3284 /* It's hopefully okay to write the code this way, since everything
3285 will soon be in caches, and no consing will be done at all. */
9b8eb840 3286 Lisp_Object parsed;
0a7f1fc0 3287
9b8eb840 3288 parsed = parse_modifiers (symbol);
0a7f1fc0
JB
3289 return apply_modifiers (XCONS (XCONS (parsed)->cdr)->car,
3290 XCONS (parsed)->car);
3291}
3292
3293
284f4730
JB
3294/* For handling events, we often want to produce a symbol whose name
3295 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
3296 to some base, like the name of a function key or mouse button.
3297 modify_event_symbol produces symbols of this sort.
3298
3299 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
3300 is the name of the i'th symbol. TABLE_SIZE is the number of elements
3301 in the table.
3302
80e4aa30
RS
3303 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
3304 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
3305
284f4730
JB
3306 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
3307 persist between calls to modify_event_symbol that it can use to
3308 store a cache of the symbols it's generated for this NAME_TABLE
80e4aa30 3309 before. The object stored there may be a vector or an alist.
284f4730
JB
3310
3311 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
3312
3313 MODIFIERS is a set of modifier bits (as given in struct input_events)
3314 whose prefixes should be applied to the symbol name.
3315
3316 SYMBOL_KIND is the value to be placed in the event_kind property of
88cb0656
JB
3317 the returned symbol.
3318
3319 The symbols we create are supposed to have an
eb8c3be9 3320 `event-symbol-elements' property, which lists the modifiers present
88cb0656
JB
3321 in the symbol's name. */
3322
284f4730 3323static Lisp_Object
80e4aa30
RS
3324modify_event_symbol (symbol_num, modifiers, symbol_kind, name_alist,
3325 name_table, symbol_table, table_size)
284f4730
JB
3326 int symbol_num;
3327 unsigned modifiers;
3328 Lisp_Object symbol_kind;
80e4aa30 3329 Lisp_Object name_alist;
284f4730
JB
3330 char **name_table;
3331 Lisp_Object *symbol_table;
3332 int table_size;
3333{
80e4aa30
RS
3334 Lisp_Object value;
3335 Lisp_Object symbol_int;
3336
3337 XSET (symbol_int, Lisp_Int, symbol_num);
284f4730
JB
3338
3339 /* Is this a request for a valid symbol? */
88cb0656 3340 if (symbol_num < 0 || symbol_num >= table_size)
0c2611c5 3341 return Qnil;
284f4730 3342
80e4aa30
RS
3343 if (CONSP (*symbol_table))
3344 value = Fcdr (assq_no_quit (symbol_int, *symbol_table));
3345
0a7f1fc0 3346 /* If *symbol_table doesn't seem to be initialized properly, fix that.
88cb0656 3347 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4bb994d1
JB
3348 where the Nth element is the symbol for NAME_TABLE[N], or nil if
3349 we've never used that symbol before. */
80e4aa30 3350 else
88cb0656 3351 {
80e4aa30
RS
3352 if (! VECTORP (*symbol_table)
3353 || XVECTOR (*symbol_table)->size != table_size)
3354 {
3355 Lisp_Object size;
0a7f1fc0 3356
80e4aa30
RS
3357 XFASTINT (size) = table_size;
3358 *symbol_table = Fmake_vector (size, Qnil);
3359 }
284f4730 3360
80e4aa30
RS
3361 value = XVECTOR (*symbol_table)->contents[symbol_num];
3362 }
284f4730 3363
0a7f1fc0 3364 /* Have we already used this symbol before? */
80e4aa30 3365 if (NILP (value))
284f4730 3366 {
0a7f1fc0 3367 /* No; let's create it. */
80e4aa30 3368 if (!NILP (name_alist))
b64b4075 3369 value = Fcdr_safe (Fassq (symbol_int, name_alist));
80e4aa30
RS
3370 else if (name_table[symbol_num])
3371 value = intern (name_table[symbol_num]);
b64b4075
RS
3372
3373 if (NILP (value))
d1f50460
RS
3374 {
3375 char buf[20];
3376 sprintf (buf, "key-%d", symbol_num);
80e4aa30 3377 value = intern (buf);
d1f50460 3378 }
0a7f1fc0 3379
80e4aa30
RS
3380 if (CONSP (*symbol_table))
3381 *symbol_table = Fcons (value, *symbol_table);
3382 else
3383 XVECTOR (*symbol_table)->contents[symbol_num] = value;
3384
0a7f1fc0
JB
3385 /* Fill in the cache entries for this symbol; this also
3386 builds the Qevent_symbol_elements property, which the user
3387 cares about. */
80e4aa30
RS
3388 apply_modifiers (modifiers & click_modifier, value);
3389 Fput (value, Qevent_kind, symbol_kind);
284f4730 3390 }
88cb0656 3391
0a7f1fc0 3392 /* Apply modifiers to that symbol. */
80e4aa30 3393 return apply_modifiers (modifiers, value);
284f4730 3394}
0a7f1fc0 3395
284f4730 3396\f
284f4730
JB
3397/* Store into *addr a value nonzero if terminal input chars are available.
3398 Serves the purpose of ioctl (0, FIONREAD, addr)
3399 but works even if FIONREAD does not exist.
3400 (In fact, this may actually read some input.) */
3401
3402static void
3403get_input_pending (addr)
3404 int *addr;
3405{
3406 /* First of all, have we already counted some input? */
3407 *addr = !NILP (Vquit_flag) || readable_events ();
3408
3409 /* If input is being read as it arrives, and we have none, there is none. */
3410 if (*addr > 0 || (interrupt_input && ! interrupts_deferred))
3411 return;
3412
3413 /* Try to read some input and see how much we get. */
3414 gobble_input (0);
3415 *addr = !NILP (Vquit_flag) || readable_events ();
3416}
3417
3418/* Interface to read_avail_input, blocking SIGIO if necessary. */
3419
3420int
3421gobble_input (expected)
3422 int expected;
3423{
3424#ifndef VMS
3425#ifdef SIGIO
3426 if (interrupt_input)
3427 {
32676c08 3428 SIGMASKTYPE mask;
e065a56e 3429 mask = sigblockx (SIGIO);
284f4730 3430 read_avail_input (expected);
e065a56e 3431 sigsetmask (mask);
284f4730
JB
3432 }
3433 else
3434#endif
3435 read_avail_input (expected);
3436#endif
3437}
a8015ab5 3438
241ceaf7
RS
3439/* Put a buffer_switch_event in the buffer
3440 so that read_key_sequence will notice the new current buffer. */
3441
a8015ab5
KH
3442record_asynch_buffer_change ()
3443{
3444 struct input_event event;
a30f0615
RS
3445 Lisp_Object tem;
3446
a8015ab5
KH
3447 event.kind = buffer_switch_event;
3448 event.frame_or_window = Qnil;
241ceaf7 3449
a30f0615
RS
3450 /* We don't need a buffer-switch event unless Emacs is waiting for input.
3451 The purpose of the event is to make read_key_sequence look up the
3452 keymaps again. If we aren't in read_key_sequence, we don't need one,
3453 and the event could cause trouble by messing up (input-pending-p). */
3454 tem = Fwaiting_for_user_input_p ();
3455 if (NILP (tem))
3456 return;
3457
241ceaf7
RS
3458 /* Make sure no interrupt happens while storing the event. */
3459#ifdef SIGIO
3460 if (interrupt_input)
3461 {
3462 SIGMASKTYPE mask;
3463 mask = sigblockx (SIGIO);
3464 kbd_buffer_store_event (&event);
3465 sigsetmask (mask);
3466 }
3467 else
3468#endif
3469 {
3470 stop_polling ();
3471 kbd_buffer_store_event (&event);
3472 start_polling ();
3473 }
a8015ab5 3474}
284f4730
JB
3475\f
3476#ifndef VMS
3477
3478/* Read any terminal input already buffered up by the system
3479 into the kbd_buffer, but do not wait.
3480
3481 EXPECTED should be nonzero if the caller knows there is some input.
3482
3483 Except on VMS, all input is read by this function.
3484 If interrupt_input is nonzero, this function MUST be called
3485 only when SIGIO is blocked.
3486
3487 Returns the number of keyboard chars read, or -1 meaning
3488 this is a bad time to try to read input. */
3489
3490static int
3491read_avail_input (expected)
3492 int expected;
3493{
3494 struct input_event buf[KBD_BUFFER_SIZE];
3495 register int i;
3496 int nread;
3497
3498 if (read_socket_hook)
3499 /* No need for FIONREAD or fcntl; just say don't wait. */
3500 nread = (*read_socket_hook) (0, buf, KBD_BUFFER_SIZE, expected, expected);
3501 else
3502 {
17270835
RS
3503 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3504 the kbd_buffer can really hold. That may prevent loss
3505 of characters on some systems when input is stuffed at us. */
3506 unsigned char cbuf[KBD_BUFFER_SIZE - 1];
58788063 3507 int n_to_read;
284f4730 3508
58788063 3509 /* Determine how many characters we should *try* to read. */
80e4aa30 3510#ifdef MSDOS
58788063
RS
3511 n_to_read = dos_keysns ();
3512 if (n_to_read == 0)
3513 return 0;
c3a2738c 3514#else /* not MSDOS */
284f4730
JB
3515#ifdef FIONREAD
3516 /* Find out how much input is available. */
58788063 3517 if (ioctl (0, FIONREAD, &n_to_read) < 0)
284f4730
JB
3518 /* Formerly simply reported no input, but that sometimes led to
3519 a failure of Emacs to terminate.
3520 SIGHUP seems appropriate if we can't reach the terminal. */
e4535288
RS
3521 /* ??? Is it really right to send the signal just to this process
3522 rather than to the whole process group?
3523 Perhaps on systems with FIONREAD Emacs is alone in its group. */
284f4730 3524 kill (getpid (), SIGHUP);
58788063 3525 if (n_to_read == 0)
284f4730 3526 return 0;
58788063
RS
3527 if (n_to_read > sizeof cbuf)
3528 n_to_read = sizeof cbuf;
284f4730 3529#else /* no FIONREAD */
482952ef 3530#if defined(USG) || defined(DGUX)
284f4730 3531 /* Read some input if available, but don't wait. */
58788063 3532 n_to_read = sizeof cbuf;
284f4730
JB
3533 fcntl (fileno (stdin), F_SETFL, O_NDELAY);
3534#else
3535 you lose;
3536#endif
3537#endif
80e4aa30 3538#endif /* not MSDOS */
284f4730 3539
58788063
RS
3540 /* Now read; for one reason or another, this will not block.
3541 NREAD is set to the number of chars read. */
9134775b 3542 do
284f4730 3543 {
80e4aa30
RS
3544#ifdef MSDOS
3545 cbuf[0] = dos_keyread();
3546 nread = 1;
3547#else
58788063 3548 nread = read (fileno (stdin), cbuf, n_to_read);
80e4aa30 3549#endif
762f2b92 3550#if defined (AIX) && (! defined (aix386) && defined (_BSD))
284f4730
JB
3551 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3552 This looks incorrect, but it isn't, because _BSD causes
3553 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3554 and that causes a value other than 0 when there is no input. */
854f3a54 3555 if (nread == 0)
80e4aa30 3556 kill (0, SIGHUP);
284f4730 3557#endif
9134775b 3558 }
791587ee
KH
3559 while (
3560 /* We used to retry the read if it was interrupted.
3561 But this does the wrong thing when O_NDELAY causes
3562 an EAGAIN error. Does anybody know of a situation
3563 where a retry is actually needed? */
3564#if 0
3565 nread < 0 && (errno == EAGAIN
6aec06f5 3566#ifdef EFAULT
9134775b 3567 || errno == EFAULT
80e4aa30 3568#endif
284f4730 3569#ifdef EBADSLT
9134775b 3570 || errno == EBADSLT
284f4730 3571#endif
791587ee
KH
3572 )
3573#else
3574 0
3575#endif
3576 );
284f4730
JB
3577
3578#ifndef FIONREAD
02c2c53f 3579#if defined (USG) || defined (DGUX)
284f4730 3580 fcntl (fileno (stdin), F_SETFL, 0);
02c2c53f 3581#endif /* USG or DGUX */
284f4730
JB
3582#endif /* no FIONREAD */
3583 for (i = 0; i < nread; i++)
3584 {
3585 buf[i].kind = ascii_keystroke;
86e5706b 3586 buf[i].modifiers = 0;
b04904fb 3587 if (meta_key == 1 && (cbuf[i] & 0x80))
86e5706b 3588 buf[i].modifiers = meta_modifier;
b04904fb
RS
3589 if (meta_key != 2)
3590 cbuf[i] &= ~0x80;
86e5706b 3591
7b4aedb9
JB
3592 XSET (buf[i].code, Lisp_Int, cbuf[i]);
3593#ifdef MULTI_FRAME
3594 XSET (buf[i].frame_or_window, Lisp_Frame, selected_frame);
3595#else
3596 buf[i].frame_or_window = Qnil;
3597#endif
284f4730
JB
3598 }
3599 }
3600
3601 /* Scan the chars for C-g and store them in kbd_buffer. */
3602 for (i = 0; i < nread; i++)
3603 {
3604 kbd_buffer_store_event (&buf[i]);
3605 /* Don't look at input that follows a C-g too closely.
3606 This reduces lossage due to autorepeat on C-g. */
3607 if (buf[i].kind == ascii_keystroke
3608 && XINT(buf[i].code) == quit_char)
3609 break;
3610 }
3611
3612 return nread;
3613}
3614#endif /* not VMS */
3615\f
3616#ifdef SIGIO /* for entire page */
3617/* Note SIGIO has been undef'd if FIONREAD is missing. */
3618
2ce30ea2 3619SIGTYPE
284f4730
JB
3620input_available_signal (signo)
3621 int signo;
3622{
3623 /* Must preserve main program's value of errno. */
3624 int old_errno = errno;
3625#ifdef BSD4_1
3626 extern int select_alarmed;
3627#endif
3628
3629#ifdef USG
3630 /* USG systems forget handlers when they are used;
3631 must reestablish each time */
3632 signal (signo, input_available_signal);
3633#endif /* USG */
3634
3635#ifdef BSD4_1
3636 sigisheld (SIGIO);
3637#endif
3638
ffd56f97
JB
3639 if (input_available_clear_time)
3640 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
284f4730
JB
3641
3642 while (1)
3643 {
3644 int nread;
3645 nread = read_avail_input (1);
3646 /* -1 means it's not ok to read the input now.
3647 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3648 0 means there was no keyboard input available. */
3649 if (nread <= 0)
3650 break;
3651
3652#ifdef BSD4_1
3653 select_alarmed = 1; /* Force the select emulator back to life */
3654#endif
3655 }
3656
3657#ifdef BSD4_1
3658 sigfree ();
3659#endif
3660 errno = old_errno;
3661}
3662#endif /* SIGIO */
ad163903
JB
3663
3664/* Send ourselves a SIGIO.
3665
3666 This function exists so that the UNBLOCK_INPUT macro in
3667 blockinput.h can have some way to take care of input we put off
3668 dealing with, without assuming that every file which uses
3669 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3670void
3671reinvoke_input_signal ()
3672{
3673#ifdef SIGIO
3674 kill (0, SIGIO);
3675#endif
3676}
3677
3678
284f4730
JB
3679\f
3680/* Return the prompt-string of a sparse keymap.
3681 This is the first element which is a string.
3682 Return nil if there is none. */
3683
3684Lisp_Object
3685map_prompt (map)
3686 Lisp_Object map;
3687{
3688 while (CONSP (map))
3689 {
3690 register Lisp_Object tem;
3691 tem = Fcar (map);
3692 if (XTYPE (tem) == Lisp_String)
3693 return tem;
3694 map = Fcdr (map);
3695 }
3696 return Qnil;
3697}
3698
b7c49376
RS
3699static void menu_bar_item ();
3700static void menu_bar_one_keymap ();
3701
3702/* These variables hold the vector under construction within
3703 menu_bar_items and its subroutines, and the current index
3704 for storing into that vector. */
3705static Lisp_Object menu_bar_items_vector;
3706static Lisp_Object menu_bar_items_index;
5ec75a55 3707
b7c49376
RS
3708/* Return a vector of menu items for a menu bar, appropriate
3709 to the current buffer. Each item has three elements in the vector:
f5e09c8b 3710 KEY STRING MAPLIST.
b7c49376
RS
3711
3712 OLD is an old vector we can optionally reuse, or nil. */
5ec75a55
RS
3713
3714Lisp_Object
b7c49376
RS
3715menu_bar_items (old)
3716 Lisp_Object old;
5ec75a55
RS
3717{
3718 /* The number of keymaps we're scanning right now, and the number of
3719 keymaps we have allocated space for. */
3720 int nmaps;
3721
3722 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3723 in the current keymaps, or nil where it is not a prefix. */
3724 Lisp_Object *maps;
3725
9f9c0e27 3726 Lisp_Object def, tem, tail;
5ec75a55
RS
3727
3728 Lisp_Object result;
3729
3730 int mapno;
47d319aa 3731 Lisp_Object oquit;
5ec75a55 3732
b7c49376
RS
3733 int i;
3734
3735 struct gcpro gcpro1;
3736
db60d856
JB
3737 /* In order to build the menus, we need to call the keymap
3738 accessors. They all call QUIT. But this function is called
3739 during redisplay, during which a quit is fatal. So inhibit
47d319aa
RS
3740 quitting while building the menus.
3741 We do this instead of specbind because (1) errors will clear it anyway
3742 and (2) this avoids risk of specpdl overflow. */
3743 oquit = Vinhibit_quit;
3744 Vinhibit_quit = Qt;
db60d856 3745
b7c49376
RS
3746 if (!NILP (old))
3747 menu_bar_items_vector = old;
3748 else
3749 menu_bar_items_vector = Fmake_vector (make_number (24), Qnil);
3750 menu_bar_items_index = 0;
3751
3752 GCPRO1 (menu_bar_items_vector);
3753
5ec75a55
RS
3754 /* Build our list of keymaps.
3755 If we recognize a function key and replace its escape sequence in
3756 keybuf with its symbol, or if the sequence starts with a mouse
3757 click and we need to switch buffers, we jump back here to rebuild
3758 the initial keymaps from the current buffer. */
3759 {
3760 Lisp_Object *tmaps;
3761
9dd3131c
RS
3762 if (!NILP (Voverriding_local_map))
3763 {
3764 nmaps = 2;
3765 maps = (Lisp_Object *) alloca (nmaps * sizeof (maps[0]));
3766 maps[0] = Voverriding_local_map;
3767 }
3768 else
3769 {
3770 nmaps = current_minor_maps (0, &tmaps) + 2;
3771 maps = (Lisp_Object *) alloca (nmaps * sizeof (maps[0]));
3772 bcopy (tmaps, maps, (nmaps - 2) * sizeof (maps[0]));
5ec75a55 3773#ifdef USE_TEXT_PROPERTIES
9dd3131c 3774 maps[nmaps-2] = get_local_map (PT, current_buffer);
5ec75a55 3775#else
9dd3131c 3776 maps[nmaps-2] = current_buffer->keymap;
5ec75a55 3777#endif
9dd3131c 3778 }
7e6992e0 3779 maps[nmaps-1] = current_global_map;
5ec75a55
RS
3780 }
3781
3782 /* Look up in each map the dummy prefix key `menu-bar'. */
3783
3784 result = Qnil;
3785
e58aa385 3786 for (mapno = nmaps - 1; mapno >= 0; mapno--)
5ec75a55
RS
3787 {
3788 if (! NILP (maps[mapno]))
e74fbc70 3789 def = get_keyelt (access_keymap (maps[mapno], Qmenu_bar, 1, 0));
5ec75a55
RS
3790 else
3791 def = Qnil;
3792
3793 tem = Fkeymapp (def);
3794 if (!NILP (tem))
b7c49376 3795 menu_bar_one_keymap (def);
5ec75a55
RS
3796 }
3797
b7c49376
RS
3798 /* Move to the end those items that should be at the end. */
3799
9f9c0e27
RS
3800 for (tail = Vmenu_bar_final_items; CONSP (tail); tail = XCONS (tail)->cdr)
3801 {
b7c49376
RS
3802 int i;
3803 int end = menu_bar_items_index;
3804
3805 for (i = 0; i < end; i += 3)
3806 if (EQ (XCONS (tail)->car, XVECTOR (menu_bar_items_vector)->contents[i]))
3807 {
0301268e
RS
3808 Lisp_Object tem0, tem1, tem2;
3809 /* Move the item at index I to the end,
3810 shifting all the others forward. */
3811 tem0 = XVECTOR (menu_bar_items_vector)->contents[i + 0];
3812 tem1 = XVECTOR (menu_bar_items_vector)->contents[i + 1];
3813 tem2 = XVECTOR (menu_bar_items_vector)->contents[i + 2];
3814 if (end > i + 3)
3815 bcopy (&XVECTOR (menu_bar_items_vector)->contents[i + 3],
3816 &XVECTOR (menu_bar_items_vector)->contents[i],
3817 (end - i - 3) * sizeof (Lisp_Object));
3818 XVECTOR (menu_bar_items_vector)->contents[end - 3] = tem0;
3819 XVECTOR (menu_bar_items_vector)->contents[end - 2] = tem1;
3820 XVECTOR (menu_bar_items_vector)->contents[end - 1] = tem2;
3821 break;
b7c49376
RS
3822 }
3823 }
9f9c0e27 3824
b7c49376
RS
3825 /* Add nil, nil, nil at the end. */
3826 i = menu_bar_items_index;
3827 if (i + 3 > XVECTOR (menu_bar_items_vector)->size)
3828 {
3829 Lisp_Object tem;
3830 int newsize = 2 * i;
3831 tem = Fmake_vector (make_number (2 * i), Qnil);
3832 bcopy (XVECTOR (menu_bar_items_vector)->contents,
3833 XVECTOR (tem)->contents, i * sizeof (Lisp_Object));
3834 menu_bar_items_vector = tem;
9f9c0e27 3835 }
b7c49376
RS
3836 /* Add this item. */
3837 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
3838 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
3839 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
3840 menu_bar_items_index = i;
a73c5e29 3841
47d319aa 3842 Vinhibit_quit = oquit;
b7c49376
RS
3843 UNGCPRO;
3844 return menu_bar_items_vector;
5ec75a55
RS
3845}
3846\f
3847/* Scan one map KEYMAP, accumulating any menu items it defines
f5e09c8b 3848 in menu_bar_items_vector. */
5ec75a55 3849
b7c49376
RS
3850static void
3851menu_bar_one_keymap (keymap)
3852 Lisp_Object keymap;
5ec75a55
RS
3853{
3854 Lisp_Object tail, item, key, binding, item_string, table;
3855
3856 /* Loop over all keymap entries that have menu strings. */
3857 for (tail = keymap; XTYPE (tail) == Lisp_Cons; tail = XCONS (tail)->cdr)
3858 {
3859 item = XCONS (tail)->car;
3860 if (XTYPE (item) == Lisp_Cons)
3861 {
3862 key = XCONS (item)->car;
3863 binding = XCONS (item)->cdr;
3864 if (XTYPE (binding) == Lisp_Cons)
3865 {
3866 item_string = XCONS (binding)->car;
3867 if (XTYPE (item_string) == Lisp_String)
b7c49376 3868 menu_bar_item (key, item_string, Fcdr (binding));
5ec75a55 3869 }
e58aa385 3870 else if (EQ (binding, Qundefined))
8aa034e1 3871 menu_bar_item (key, Qnil, binding);
5ec75a55
RS
3872 }
3873 else if (XTYPE (item) == Lisp_Vector)
3874 {
3875 /* Loop over the char values represented in the vector. */
3876 int len = XVECTOR (item)->size;
3877 int c;
3878 for (c = 0; c < len; c++)
3879 {
3880 Lisp_Object character;
3881 XFASTINT (character) = c;
3882 binding = XVECTOR (item)->contents[c];
3883 if (XTYPE (binding) == Lisp_Cons)
3884 {
3885 item_string = XCONS (binding)->car;
3886 if (XTYPE (item_string) == Lisp_String)
b7c49376 3887 menu_bar_item (key, item_string, Fcdr (binding));
5ec75a55 3888 }
e58aa385 3889 else if (EQ (binding, Qundefined))
8aa034e1 3890 menu_bar_item (key, Qnil, binding);
5ec75a55
RS
3891 }
3892 }
3893 }
5ec75a55
RS
3894}
3895
047a8ea7
RS
3896/* This is used as the handler when calling internal_condition_case_1. */
3897
3898static Lisp_Object
3899menu_bar_item_1 (arg)
3900 Lisp_Object arg;
3901{
3902 return Qnil;
3903}
3904
f5e09c8b
RS
3905/* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
3906 If there's already an item for KEY, add this DEF to it. */
3907
b7c49376
RS
3908static void
3909menu_bar_item (key, item_string, def)
3910 Lisp_Object key, item_string, def;
5ec75a55 3911{
e58aa385 3912 Lisp_Object tem;
5ec75a55 3913 Lisp_Object enabled;
b7c49376 3914 int i;
5ec75a55 3915
e58aa385
RS
3916 if (EQ (def, Qundefined))
3917 {
f5e09c8b 3918 /* If a map has an explicit `undefined' as definition,
e58aa385 3919 discard any previously made menu bar item. */
b7c49376
RS
3920
3921 for (i = 0; i < menu_bar_items_index; i += 3)
3922 if (EQ (key, XVECTOR (menu_bar_items_vector)->contents[i]))
3923 {
3924 if (menu_bar_items_index > i + 3)
3925 bcopy (&XVECTOR (menu_bar_items_vector)->contents[i + 3],
3926 &XVECTOR (menu_bar_items_vector)->contents[i],
3927 (menu_bar_items_index - i - 3) * sizeof (Lisp_Object));
3928 menu_bar_items_index -= 3;
3929 return;
3930 }
8aa034e1
RS
3931
3932 /* If there's no definition for this key yet,
3933 just ignore `undefined'. */
3934 return;
e58aa385
RS
3935 }
3936
5ec75a55
RS
3937 /* See if this entry is enabled. */
3938 enabled = Qt;
3939
3940 if (XTYPE (def) == Lisp_Symbol)
3941 {
3942 /* No property, or nil, means enable.
3943 Otherwise, enable if value is not nil. */
3944 tem = Fget (def, Qmenu_enable);
3945 if (!NILP (tem))
047a8ea7
RS
3946 /* (condition-case nil (eval tem)
3947 (error nil)) */
3948 enabled = internal_condition_case_1 (Feval, tem, Qerror,
3949 menu_bar_item_1);
5ec75a55
RS
3950 }
3951
b7c49376
RS
3952 /* Ignore this item if it's not enabled. */
3953 if (NILP (enabled))
3954 return;
5ec75a55 3955
f5e09c8b 3956 /* Find any existing item for this KEY. */
b7c49376
RS
3957 for (i = 0; i < menu_bar_items_index; i += 3)
3958 if (EQ (key, XVECTOR (menu_bar_items_vector)->contents[i]))
3959 break;
3960
f5e09c8b 3961 /* If we did not find this KEY, add it at the end. */
b7c49376
RS
3962 if (i == menu_bar_items_index)
3963 {
3964 /* If vector is too small, get a bigger one. */
3965 if (i + 3 > XVECTOR (menu_bar_items_vector)->size)
3966 {
3967 Lisp_Object tem;
3968 int newsize = 2 * i;
3969 tem = Fmake_vector (make_number (2 * i), Qnil);
3970 bcopy (XVECTOR (menu_bar_items_vector)->contents,
3971 XVECTOR (tem)->contents, i * sizeof (Lisp_Object));
3972 menu_bar_items_vector = tem;
3973 }
3974 /* Add this item. */
3975 XVECTOR (menu_bar_items_vector)->contents[i++] = key;
3976 XVECTOR (menu_bar_items_vector)->contents[i++] = item_string;
f5e09c8b 3977 XVECTOR (menu_bar_items_vector)->contents[i++] = Fcons (def, Qnil);
b7c49376
RS
3978 menu_bar_items_index = i;
3979 }
f5e09c8b
RS
3980 /* We did find an item for this KEY. Add DEF to its list of maps. */
3981 else
3982 {
3983 Lisp_Object old;
3984 old = XVECTOR (menu_bar_items_vector)->contents[i + 2];
3985 XVECTOR (menu_bar_items_vector)->contents[i + 2] = Fcons (def, old);
3986 }
5ec75a55
RS
3987}
3988\f
dcc408a0
RS
3989/* Read a character using menus based on maps in the array MAPS.
3990 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3991 Return t if we displayed a menu but the user rejected it.
7d6de002
RS
3992
3993 PREV_EVENT is the previous input event, or nil if we are reading
3994 the first event of a key sequence.
3995
6569cc8d
JB
3996 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3997 if we used a mouse menu to read the input, or zero otherwise. If
3998 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
284f4730
JB
3999
4000 The prompting is done based on the prompt-string of the map
8150596a
RS
4001 and the strings associated with various map elements.
4002
4003 This can be done with X menus or with menus put in the minibuf.
4004 These are done in different ways, depending on how the input will be read.
4005 Menus using X are done after auto-saving in read-char, getting the input
4006 event from Fx_popup_menu; menus using the minibuf use read_char recursively
4007 and do auto-saving in the inner call of read_char. */
284f4730 4008
7617111f 4009static Lisp_Object
8150596a 4010read_char_x_menu_prompt (nmaps, maps, prev_event, used_mouse_menu)
7d6de002
RS
4011 int nmaps;
4012 Lisp_Object *maps;
4013 Lisp_Object prev_event;
4014 int *used_mouse_menu;
284f4730 4015{
7d6de002
RS
4016 int mapno;
4017 register Lisp_Object name;
7d6de002
RS
4018 Lisp_Object rest, vector;
4019
6569cc8d
JB
4020 if (used_mouse_menu)
4021 *used_mouse_menu = 0;
284f4730
JB
4022
4023 /* Use local over global Menu maps */
4024
7d6de002
RS
4025 if (! menu_prompting)
4026 return Qnil;
4027
4028 /* Get the menu name from the first map that has one (a prompt string). */
4029 for (mapno = 0; mapno < nmaps; mapno++)
4030 {
4031 name = map_prompt (maps[mapno]);
4032 if (!NILP (name))
4033 break;
4034 }
284f4730 4035
7d6de002 4036 /* If we don't have any menus, just read a character normally. */
dbc4e1c1 4037 if (mapno >= nmaps)
7d6de002
RS
4038 return Qnil;
4039
dbc4e1c1
JB
4040#ifdef HAVE_X_WINDOWS
4041#ifdef HAVE_X_MENU
7d6de002
RS
4042 /* If we got to this point via a mouse click,
4043 use a real menu for mouse selection. */
dbc4e1c1 4044 if (EVENT_HAS_PARAMETERS (prev_event))
7d6de002
RS
4045 {
4046 /* Display the menu and get the selection. */
4047 Lisp_Object *realmaps
4048 = (Lisp_Object *) alloca (nmaps * sizeof (Lisp_Object));
4049 Lisp_Object value;
4050 int nmaps1 = 0;
4051
4052 /* Use the maps that are not nil. */
4053 for (mapno = 0; mapno < nmaps; mapno++)
4054 if (!NILP (maps[mapno]))
4055 realmaps[nmaps1++] = maps[mapno];
4056
4057 value = Fx_popup_menu (prev_event, Flist (nmaps1, realmaps));
663258f2
JB
4058 if (CONSP (value))
4059 {
4060 /* If we got more than one event, put all but the first
4061 onto this list to be read later.
4062 Return just the first event now. */
24597608
RS
4063 Vunread_command_events
4064 = nconc2 (XCONS (value)->cdr, Vunread_command_events);
663258f2
JB
4065 value = XCONS (value)->car;
4066 }
1c90c381 4067 else if (NILP (value))
dcc408a0 4068 value = Qt;
6569cc8d
JB
4069 if (used_mouse_menu)
4070 *used_mouse_menu = 1;
7d6de002
RS
4071 return value;
4072 }
dbc4e1c1
JB
4073#endif /* HAVE_X_MENU */
4074#endif /* HAVE_X_WINDOWS */
8150596a
RS
4075 return Qnil ;
4076}
4077
4078static Lisp_Object
24597608 4079read_char_minibuf_menu_prompt (commandflag, nmaps, maps)
8150596a
RS
4080 int commandflag ;
4081 int nmaps;
4082 Lisp_Object *maps;
4083{
4084 int mapno;
4085 register Lisp_Object name;
4086 int nlength;
4087 int width = FRAME_WIDTH (selected_frame) - 4;
4088 char *menu = (char *) alloca (width + 4);
4089 int idx = -1;
9fdbfdf8 4090 int nobindings = 1;
8150596a
RS
4091 Lisp_Object rest, vector;
4092
4093 if (! menu_prompting)
4094 return Qnil;
4095
4096 /* Get the menu name from the first map that has one (a prompt string). */
4097 for (mapno = 0; mapno < nmaps; mapno++)
4098 {
4099 name = map_prompt (maps[mapno]);
4100 if (!NILP (name))
4101 break;
4102 }
4103
4104 /* If we don't have any menus, just read a character normally. */
4105 if (mapno >= nmaps)
4106 return Qnil;
284f4730
JB
4107
4108 /* Prompt string always starts with map's prompt, and a space. */
4109 strcpy (menu, XSTRING (name)->data);
4110 nlength = XSTRING (name)->size;
7d6de002 4111 menu[nlength++] = ':';
284f4730
JB
4112 menu[nlength++] = ' ';
4113 menu[nlength] = 0;
4114
7d6de002
RS
4115 /* Start prompting at start of first map. */
4116 mapno = 0;
4117 rest = maps[mapno];
284f4730
JB
4118
4119 /* Present the documented bindings, a line at a time. */
4120 while (1)
4121 {
4122 int notfirst = 0;
4123 int i = nlength;
4124 Lisp_Object obj;
4125 int ch;
8150596a 4126 int orig_defn_macro ;
284f4730 4127
284f4730 4128 /* Loop over elements of map. */
7d6de002 4129 while (i < width)
284f4730 4130 {
7d6de002 4131 Lisp_Object s, elt;
284f4730 4132
7d6de002
RS
4133 /* If reached end of map, start at beginning of next map. */
4134 if (NILP (rest))
4135 {
4136 mapno++;
4137 /* At end of last map, wrap around to first map if just starting,
4138 or end this line if already have something on it. */
4139 if (mapno == nmaps)
284f4730 4140 {
8150596a 4141 mapno = 0;
40932d1a 4142 if (notfirst || nobindings) break;
284f4730 4143 }
7d6de002 4144 rest = maps[mapno];
284f4730 4145 }
7d6de002
RS
4146
4147 /* Look at the next element of the map. */
4148 if (idx >= 0)
4149 elt = XVECTOR (vector)->contents[idx];
284f4730 4150 else
7d6de002
RS
4151 elt = Fcar_safe (rest);
4152
4153 if (idx < 0 && XTYPE (elt) == Lisp_Vector)
284f4730 4154 {
7d6de002
RS
4155 /* If we found a dense table in the keymap,
4156 advanced past it, but start scanning its contents. */
4157 rest = Fcdr_safe (rest);
4158 vector = elt;
4159 idx = 0;
284f4730 4160 }
7d6de002
RS
4161 else
4162 {
4163 /* An ordinary element. */
8150596a
RS
4164 if ( idx < 0 )
4165 s = Fcar_safe (Fcdr_safe (elt)); /* alist */
4166 else
4167 s = Fcar_safe(elt); /* vector */
7d6de002
RS
4168 if (XTYPE (s) != Lisp_String)
4169 /* Ignore the element if it has no prompt string. */
4170 ;
4171 /* If we have room for the prompt string, add it to this line.
4172 If this is the first on the line, always add it. */
8150596a 4173 else if (XSTRING (s)->size + i + 2 < width
7d6de002
RS
4174 || !notfirst)
4175 {
4176 int thiswidth;
284f4730 4177
7d6de002
RS
4178 /* Punctuate between strings. */
4179 if (notfirst)
4180 {
4181 strcpy (menu + i, ", ");
4182 i += 2;
4183 }
4184 notfirst = 1;
8150596a 4185 nobindings = 0 ;
7d6de002
RS
4186
4187 /* Add as much of string as fits. */
4188 thiswidth = XSTRING (s)->size;
4189 if (thiswidth + i > width)
4190 thiswidth = width - i;
4191 bcopy (XSTRING (s)->data, menu + i, thiswidth);
4192 i += thiswidth;
8150596a 4193 menu[i] = 0;
7d6de002
RS
4194 }
4195 else
4196 {
4197 /* If this element does not fit, end the line now,
4198 and save the element for the next line. */
4199 strcpy (menu + i, "...");
4200 break;
4201 }
4202
4203 /* Move past this element. */
8150596a 4204 if (idx >= 0 && idx + 1 >= XVECTOR (vector)->size)
7d6de002
RS
4205 /* Handle reaching end of dense table. */
4206 idx = -1;
4207 if (idx >= 0)
4208 idx++;
4209 else
4210 rest = Fcdr_safe (rest);
4211 }
284f4730
JB
4212 }
4213
4214 /* Prompt with that and read response. */
4215 message1 (menu);
8150596a
RS
4216
4217 /* Make believe its not a keyboard macro in case the help char
4218 is pressed. Help characters are not recorded because menu prompting
4219 is not used on replay.
4220 */
4221 orig_defn_macro = defining_kbd_macro ;
4222 defining_kbd_macro = 0 ;
3cb81011
KH
4223 do
4224 obj = read_char (commandflag, 0, 0, Qnil, 0);
4225 while (XTYPE (obj) == Lisp_Buffer);
8150596a 4226 defining_kbd_macro = orig_defn_macro ;
284f4730
JB
4227
4228 if (XTYPE (obj) != Lisp_Int)
4229 return obj;
4230 else
4231 ch = XINT (obj);
4232
f4255cd1 4233 if (! EQ (obj, menu_prompt_more_char)
284f4730 4234 && (XTYPE (menu_prompt_more_char) != Lisp_Int
f4255cd1 4235 || ! EQ (obj, make_number (Ctl (XINT (menu_prompt_more_char))))))
8150596a
RS
4236 {
4237 if ( defining_kbd_macro )
4238 store_kbd_macro_char(obj) ;
4239 return obj;
4240 }
4241 /* Help char - go round again */
284f4730
JB
4242 }
4243}
284f4730
JB
4244\f
4245/* Reading key sequences. */
4246
4247/* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
4248 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
4249 keymap, or nil otherwise. Return the index of the first keymap in
4250 which KEY has any binding, or NMAPS if no map has a binding.
4251
4252 If KEY is a meta ASCII character, treat it like meta-prefix-char
4253 followed by the corresponding non-meta character. Keymaps in
4254 CURRENT with non-prefix bindings for meta-prefix-char become nil in
4255 NEXT.
4256
88cb0656
JB
4257 If KEY has no bindings in any of the CURRENT maps, NEXT is left
4258 unmodified.
4259
284f4730
JB
4260 NEXT may == CURRENT. */
4261
4262static int
4e50f26a 4263follow_key (key, nmaps, current, defs, next)
284f4730
JB
4264 Lisp_Object key;
4265 Lisp_Object *current, *defs, *next;
4266 int nmaps;
4267{
4268 int i, first_binding;
4269
4270 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
4271 followed by the corresponding non-meta character. */
86e5706b 4272 if (XTYPE (key) == Lisp_Int && (XINT (key) & CHAR_META))
284f4730
JB
4273 {
4274 for (i = 0; i < nmaps; i++)
4275 if (! NILP (current[i]))
4276 {
cd21b839 4277 next[i] =
e74fbc70 4278 get_keyelt (access_keymap (current[i], meta_prefix_char, 1, 0));
284f4730
JB
4279
4280 /* Note that since we pass the resulting bindings through
4281 get_keymap_1, non-prefix bindings for meta-prefix-char
4282 disappear. */
f4255cd1 4283 next[i] = get_keymap_1 (next[i], 0, 1);
284f4730
JB
4284 }
4285 else
4286 next[i] = Qnil;
4287
4288 current = next;
86e5706b 4289 XSET (key, Lisp_Int, XFASTINT (key) & ~CHAR_META);
284f4730
JB
4290 }
4291
4292 first_binding = nmaps;
4293 for (i = nmaps - 1; i >= 0; i--)
4294 {
4295 if (! NILP (current[i]))
4296 {
e74fbc70 4297 defs[i] = get_keyelt (access_keymap (current[i], key, 1, 0));
284f4730
JB
4298 if (! NILP (defs[i]))
4299 first_binding = i;
4300 }
4301 else
4302 defs[i] = Qnil;
4303 }
4304
284f4730 4305 /* Given the set of bindings we've found, produce the next set of maps. */
0a7f1fc0
JB
4306 if (first_binding < nmaps)
4307 for (i = 0; i < nmaps; i++)
f4255cd1 4308 next[i] = NILP (defs[i]) ? Qnil : get_keymap_1 (defs[i], 0, 1);
284f4730
JB
4309
4310 return first_binding;
4311}
4312
f4255cd1
JB
4313/* Read a sequence of keys that ends with a non prefix character,
4314 storing it in KEYBUF, a buffer of size BUFSIZE.
4315 Prompt with PROMPT.
284f4730 4316 Return the length of the key sequence stored.
dcc408a0 4317 Return -1 if the user rejected a command menu.
284f4730 4318
f4255cd1
JB
4319 Echo starting immediately unless `prompt' is 0.
4320
4321 Where a key sequence ends depends on the currently active keymaps.
4322 These include any minor mode keymaps active in the current buffer,
4323 the current buffer's local map, and the global map.
4324
4325 If a key sequence has no other bindings, we check Vfunction_key_map
4326 to see if some trailing subsequence might be the beginning of a
4327 function key's sequence. If so, we try to read the whole function
4328 key, and substitute its symbolic name into the key sequence.
4329
fbcd35bd
JB
4330 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
4331 `double-' events into similar click events, if that would make them
4332 bound. We try to turn `triple-' events first into `double-' events,
4333 then into clicks.
f4255cd1
JB
4334
4335 If we get a mouse click in a mode line, vertical divider, or other
4336 non-text area, we treat the click as if it were prefixed by the
4337 symbol denoting that area - `mode-line', `vertical-line', or
4338 whatever.
4339
4340 If the sequence starts with a mouse click, we read the key sequence
4341 with respect to the buffer clicked on, not the current buffer.
284f4730 4342
f4255cd1
JB
4343 If the user switches frames in the midst of a key sequence, we put
4344 off the switch-frame event until later; the next call to
4345 read_char will return it. */
48e416d4 4346
284f4730
JB
4347static int
4348read_key_sequence (keybuf, bufsize, prompt)
4349 Lisp_Object *keybuf;
4350 int bufsize;
84d91fda 4351 Lisp_Object prompt;
284f4730 4352{
f4255cd1
JB
4353 int count = specpdl_ptr - specpdl;
4354
284f4730
JB
4355 /* How many keys there are in the current key sequence. */
4356 int t;
4357
284f4730
JB
4358 /* The length of the echo buffer when we started reading, and
4359 the length of this_command_keys when we started reading. */
4360 int echo_start;
f4255cd1 4361 int keys_start;
284f4730
JB
4362
4363 /* The number of keymaps we're scanning right now, and the number of
4364 keymaps we have allocated space for. */
4365 int nmaps;
4366 int nmaps_allocated = 0;
4367
284f4730
JB
4368 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
4369 the current keymaps. */
4370 Lisp_Object *defs;
4371
f4255cd1
JB
4372 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
4373 in the current keymaps, or nil where it is not a prefix. */
4374 Lisp_Object *submaps;
4375
4376 /* The index in defs[] of the first keymap that has a binding for
4377 this key sequence. In other words, the lowest i such that
4378 defs[i] is non-nil. */
284f4730
JB
4379 int first_binding;
4380
f4255cd1 4381 /* If t < mock_input, then KEYBUF[t] should be read as the next
253598e4
JB
4382 input key.
4383
4384 We use this to recover after recognizing a function key. Once we
4385 realize that a suffix of the current key sequence is actually a
4386 function key's escape sequence, we replace the suffix with the
4387 function key's binding from Vfunction_key_map. Now keybuf
f4255cd1
JB
4388 contains a new and different key sequence, so the echo area,
4389 this_command_keys, and the submaps and defs arrays are wrong. In
4390 this situation, we set mock_input to t, set t to 0, and jump to
4391 restart_sequence; the loop will read keys from keybuf up until
4392 mock_input, thus rebuilding the state; and then it will resume
4393 reading characters from the keyboard. */
284f4730
JB
4394 int mock_input = 0;
4395
253598e4 4396 /* If the sequence is unbound in submaps[], then
f4255cd1
JB
4397 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
4398 and fkey_map is its binding.
253598e4 4399
f4255cd1
JB
4400 These might be > t, indicating that all function key scanning
4401 should hold off until t reaches them. We do this when we've just
4402 recognized a function key, to avoid searching for the function
4403 key's again in Vfunction_key_map. */
284f4730 4404 int fkey_start = 0, fkey_end = 0;
4efda7dd 4405 Lisp_Object fkey_map;
284f4730 4406
a612e298
RS
4407 /* Likewise, for key_translation_map. */
4408 int keytran_start = 0, keytran_end = 0;
4409 Lisp_Object keytran_map;
4410
cd21b839
JB
4411 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
4412 we put it off for later. While we're reading, we keep the event here. */
4efda7dd 4413 Lisp_Object delayed_switch_frame;
cd21b839 4414
51763820
BF
4415 /* See the comment below... */
4416#if defined (GOBBLE_FIRST_EVENT)
4efda7dd 4417 Lisp_Object first_event;
51763820 4418#endif
4efda7dd 4419
3b9189f8
RS
4420 struct buffer *starting_buffer;
4421
e9bf89a0
RS
4422 /* Nonzero if we seem to have got the beginning of a binding
4423 in function_key_map. */
4424 int function_key_possible = 0;
4425
4efda7dd
RS
4426 int junk;
4427
4428 last_nonmenu_event = Qnil;
4429
4430 delayed_switch_frame = Qnil;
4431 fkey_map = Vfunction_key_map;
a612e298 4432 keytran_map = Vkey_translation_map;
f4255cd1 4433
a612e298 4434 /* If there is no function-key-map, turn off function key scanning. */
f4255cd1
JB
4435 if (NILP (Fkeymapp (Vfunction_key_map)))
4436 fkey_start = fkey_end = bufsize + 1;
4437
a612e298
RS
4438 /* If there is no key-translation-map, turn off scanning. */
4439 if (NILP (Fkeymapp (Vkey_translation_map)))
4440 keytran_start = keytran_end = bufsize + 1;
4441
284f4730
JB
4442 if (INTERACTIVE)
4443 {
84d91fda
RS
4444 if (!NILP (prompt))
4445 echo_prompt (XSTRING (prompt)->data);
a98ea3f9 4446 else if (cursor_in_echo_area && echo_keystrokes)
284f4730
JB
4447 /* This doesn't put in a dash if the echo buffer is empty, so
4448 you don't always see a dash hanging out in the minibuffer. */
4449 echo_dash ();
284f4730
JB
4450 }
4451
f4255cd1
JB
4452 /* Record the initial state of the echo area and this_command_keys;
4453 we will need to restore them if we replay a key sequence. */
0a7f1fc0 4454 if (INTERACTIVE)
f4255cd1
JB
4455 echo_start = echo_length ();
4456 keys_start = this_command_key_count;
0a7f1fc0 4457
51763820
BF
4458#if defined (GOBBLE_FIRST_EVENT)
4459 /* This doesn't quite work, because some of the things that read_char
4460 does cannot safely be bypassed. It seems too risky to try to make
4461 this work right. */
4462
4efda7dd
RS
4463 /* Read the first char of the sequence specially, before setting
4464 up any keymaps, in case a filter runs and switches buffers on us. */
84d91fda 4465 first_event = read_char (NILP (prompt), 0, submaps, last_nonmenu_event,
4efda7dd 4466 &junk);
51763820 4467#endif /* GOBBLE_FIRST_EVENT */
4efda7dd 4468
7b4aedb9
JB
4469 /* We jump here when the key sequence has been thoroughly changed, and
4470 we need to rescan it starting from the beginning. When we jump here,
4471 keybuf[0..mock_input] holds the sequence we should reread. */
07d2b8de 4472 replay_sequence:
7b4aedb9 4473
3b9189f8 4474 starting_buffer = current_buffer;
e9bf89a0 4475 function_key_possible = 0;
3b9189f8 4476
f4255cd1 4477 /* Build our list of keymaps.
07d2b8de
JB
4478 If we recognize a function key and replace its escape sequence in
4479 keybuf with its symbol, or if the sequence starts with a mouse
4480 click and we need to switch buffers, we jump back here to rebuild
4481 the initial keymaps from the current buffer. */
284f4730
JB
4482 {
4483 Lisp_Object *maps;
4484
9dd3131c 4485 if (!NILP (Voverriding_local_map))
284f4730 4486 {
9dd3131c
RS
4487 nmaps = 2;
4488 if (nmaps > nmaps_allocated)
4489 {
4490 submaps = (Lisp_Object *) alloca (nmaps * sizeof (submaps[0]));
4491 defs = (Lisp_Object *) alloca (nmaps * sizeof (defs[0]));
4492 nmaps_allocated = nmaps;
4493 }
4494 submaps[0] = Voverriding_local_map;
284f4730 4495 }
9dd3131c
RS
4496 else
4497 {
4498 nmaps = current_minor_maps (0, &maps) + 2;
4499 if (nmaps > nmaps_allocated)
4500 {
4501 submaps = (Lisp_Object *) alloca (nmaps * sizeof (submaps[0]));
4502 defs = (Lisp_Object *) alloca (nmaps * sizeof (defs[0]));
4503 nmaps_allocated = nmaps;
4504 }
4505 bcopy (maps, submaps, (nmaps - 2) * sizeof (submaps[0]));
497ba7a1 4506#ifdef USE_TEXT_PROPERTIES
9dd3131c 4507 submaps[nmaps-2] = get_local_map (PT, current_buffer);
497ba7a1 4508#else
9dd3131c 4509 submaps[nmaps-2] = current_buffer->keymap;
497ba7a1 4510#endif
9dd3131c 4511 }
7e6992e0 4512 submaps[nmaps-1] = current_global_map;
284f4730
JB
4513 }
4514
4515 /* Find an accurate initial value for first_binding. */
4516 for (first_binding = 0; first_binding < nmaps; first_binding++)
253598e4 4517 if (! NILP (submaps[first_binding]))
284f4730
JB
4518 break;
4519
3b9189f8 4520 /* Start from the beginning in keybuf. */
f4255cd1
JB
4521 t = 0;
4522
4523 /* These are no-ops the first time through, but if we restart, they
4524 revert the echo area and this_command_keys to their original state. */
4525 this_command_key_count = keys_start;
40932d1a 4526 if (INTERACTIVE && t < mock_input)
f4255cd1
JB
4527 echo_truncate (echo_start);
4528
cca310da
JB
4529 /* If the best binding for the current key sequence is a keymap, or
4530 we may be looking at a function key's escape sequence, keep on
4531 reading. */
253598e4 4532 while ((first_binding < nmaps && ! NILP (submaps[first_binding]))
cca310da
JB
4533 || (first_binding >= nmaps
4534 && fkey_start < t
4535 /* mock input is never part of a function key's sequence. */
a612e298
RS
4536 && mock_input <= fkey_start)
4537 || (first_binding >= nmaps
4538 && keytran_start < t
4539 /* mock input is never part of a function key's sequence. */
e9bf89a0
RS
4540 && mock_input <= keytran_start)
4541 /* Don't return in the middle of a possible function key sequence,
4542 if the only bindings we found were via case conversion.
4543 Thus, if ESC O a has a function-key-map translation
4544 and ESC o has a binding, don't return after ESC O,
4545 so that we can translate ESC O plus the next character. */
4e50f26a 4546 )
284f4730
JB
4547 {
4548 Lisp_Object key;
7d6de002 4549 int used_mouse_menu = 0;
284f4730 4550
7b4aedb9
JB
4551 /* Where the last real key started. If we need to throw away a
4552 key that has expanded into more than one element of keybuf
4553 (say, a mouse click on the mode line which is being treated
4554 as [mode-line (mouse-...)], then we backtrack to this point
4555 of keybuf. */
4556 int last_real_key_start;
4557
0a7f1fc0
JB
4558 /* These variables are analogous to echo_start and keys_start;
4559 while those allow us to restart the entire key sequence,
4560 echo_local_start and keys_local_start allow us to throw away
4561 just one key. */
f4255cd1
JB
4562 int echo_local_start, keys_local_start, local_first_binding;
4563
284f4730
JB
4564 if (t >= bufsize)
4565 error ("key sequence too long");
4566
f4255cd1
JB
4567 if (INTERACTIVE)
4568 echo_local_start = echo_length ();
4569 keys_local_start = this_command_key_count;
4570 local_first_binding = first_binding;
4571
4572 replay_key:
0a7f1fc0 4573 /* These are no-ops, unless we throw away a keystroke below and
f4255cd1
JB
4574 jumped back up to replay_key; in that case, these restore the
4575 variables to their original state, allowing us to replay the
0a7f1fc0 4576 loop. */
40932d1a 4577 if (INTERACTIVE && t < mock_input)
f4255cd1 4578 echo_truncate (echo_local_start);
0a7f1fc0
JB
4579 this_command_key_count = keys_local_start;
4580 first_binding = local_first_binding;
4581
7e85b935
RS
4582 /* By default, assume each event is "real". */
4583 last_real_key_start = t;
4584
f4255cd1 4585 /* Does mock_input indicate that we are re-reading a key sequence? */
284f4730
JB
4586 if (t < mock_input)
4587 {
4588 key = keybuf[t];
4589 add_command_key (key);
a98ea3f9
RS
4590 if (echo_keystrokes)
4591 echo_char (key);
284f4730 4592 }
253598e4
JB
4593
4594 /* If not, we should actually read a character. */
284f4730
JB
4595 else
4596 {
a6d53864
RS
4597 struct buffer *buf = current_buffer;
4598
84d91fda 4599 key = read_char (NILP (prompt), nmaps, submaps, last_nonmenu_event,
a6d53864 4600 &used_mouse_menu);
284f4730 4601
dcc408a0
RS
4602 /* read_char returns t when it shows a menu and the user rejects it.
4603 Just return -1. */
4604 if (EQ (key, Qt))
4605 return -1;
4606
f4255cd1 4607 /* read_char returns -1 at the end of a macro.
284f4730
JB
4608 Emacs 18 handles this by returning immediately with a
4609 zero, so that's what we'll do. */
86e5706b 4610 if (XTYPE (key) == Lisp_Int && XINT (key) == -1)
cd21b839 4611 {
f4255cd1
JB
4612 t = 0;
4613 goto done;
cd21b839 4614 }
284f4730 4615
3cb81011
KH
4616 /* If the current buffer has been changed from under us, the
4617 keymap may have changed, so replay the sequence. */
4618 if (XTYPE (key) == Lisp_Buffer)
4619 {
4620 mock_input = t;
4621 goto replay_sequence;
4622 }
4623
3b9189f8
RS
4624 /* If we have a quit that was typed in another frame, and
4625 quit_throw_to_read_char switched buffers,
4626 replay to get the right keymap. */
4627 if (EQ (key, quit_char) && current_buffer != starting_buffer)
4628 {
4629 keybuf[t++] = key;
4630 mock_input = t;
4631 Vquit_flag = Qnil;
4632 goto replay_sequence;
4633 }
3cb81011 4634
284f4730 4635 Vquit_flag = Qnil;
7e85b935 4636 }
284f4730 4637
7e85b935
RS
4638 /* Clicks in non-text areas get prefixed by the symbol
4639 in their CHAR-ADDRESS field. For example, a click on
4640 the mode line is prefixed by the symbol `mode-line'.
4641
4642 Furthermore, key sequences beginning with mouse clicks
4643 are read using the keymaps of the buffer clicked on, not
4644 the current buffer. So we may have to switch the buffer
4645 here.
4646
4647 When we turn one event into two events, we must make sure
4648 that neither of the two looks like the original--so that,
4649 if we replay the events, they won't be expanded again.
4650 If not for this, such reexpansion could happen either here
4651 or when user programs play with this-command-keys. */
4652 if (EVENT_HAS_PARAMETERS (key))
4653 {
9b8eb840 4654 Lisp_Object kind;
cca310da 4655
9b8eb840 4656 kind = EVENT_HEAD_KIND (EVENT_HEAD (key));
7e85b935 4657 if (EQ (kind, Qmouse_click))
0a7f1fc0 4658 {
9b8eb840 4659 Lisp_Object window, posn;
f4255cd1 4660
9b8eb840
KH
4661 window = POSN_WINDOW (EVENT_START (key));
4662 posn = POSN_BUFFER_POSN (EVENT_START (key));
7e85b935 4663 if (XTYPE (posn) == Lisp_Cons)
0a7f1fc0 4664 {
7e85b935
RS
4665 /* We're looking at the second event of a
4666 sequence which we expanded before. Set
4667 last_real_key_start appropriately. */
4668 if (t > 0)
4669 last_real_key_start = t - 1;
cd21b839 4670 }
7e85b935
RS
4671
4672 /* Key sequences beginning with mouse clicks are
4673 read using the keymaps in the buffer clicked on,
4674 not the current buffer. If we're at the
4675 beginning of a key sequence, switch buffers. */
4676 if (last_real_key_start == 0
4677 && XTYPE (window) == Lisp_Window
4678 && XTYPE (XWINDOW (window)->buffer) == Lisp_Buffer
4679 && XBUFFER (XWINDOW (window)->buffer) != current_buffer)
cd21b839 4680 {
7e85b935
RS
4681 keybuf[t] = key;
4682 mock_input = t + 1;
4683
4684 /* Arrange to go back to the original buffer once we're
4685 done reading the key sequence. Note that we can't
4686 use save_excursion_{save,restore} here, because they
4687 save point as well as the current buffer; we don't
4688 want to save point, because redisplay may change it,
4689 to accommodate a Fset_window_start or something. We
4690 don't want to do this at the top of the function,
4691 because we may get input from a subprocess which
4692 wants to change the selected window and stuff (say,
4693 emacsclient). */
4694 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
4695
4696 set_buffer_internal (XBUFFER (XWINDOW (window)->buffer));
4697 goto replay_sequence;
0a7f1fc0 4698 }
7e85b935 4699 else if (XTYPE (posn) == Lisp_Symbol)
5ec75a55 4700 {
7e85b935
RS
4701 /* Expand mode-line and scroll-bar events into two events:
4702 use posn as a fake prefix key. */
5ec75a55 4703
7e85b935
RS
4704 if (t + 1 >= bufsize)
4705 error ("key sequence too long");
4706 keybuf[t] = posn;
4707 keybuf[t+1] = key;
4708 mock_input = t + 2;
4709
4710 /* Zap the position in key, so we know that we've
4711 expanded it, and don't try to do so again. */
4712 POSN_BUFFER_POSN (EVENT_START (key))
4713 = Fcons (posn, Qnil);
4714 goto replay_key;
5ec75a55 4715 }
0a7f1fc0 4716 }
7e85b935 4717 else if (EQ (kind, Qswitch_frame))
a6d53864 4718 {
7e85b935
RS
4719 /* If we're at the beginning of a key sequence, go
4720 ahead and return this event. If we're in the
4721 midst of a key sequence, delay it until the end. */
4722 if (t > 0)
4723 {
4724 delayed_switch_frame = key;
4725 goto replay_key;
4726 }
4727 }
7a80a6f6
RS
4728 else if (CONSP (XCONS (key)->cdr)
4729 && CONSP (EVENT_START (key))
4730 && CONSP (XCONS (EVENT_START (key))->cdr))
7e85b935 4731 {
9b8eb840 4732 Lisp_Object posn;
7e85b935 4733
9b8eb840 4734 posn = POSN_BUFFER_POSN (EVENT_START (key));
7e85b935
RS
4735 /* Handle menu-bar events:
4736 insert the dummy prefix event `menu-bar'. */
4737 if (EQ (posn, Qmenu_bar))
4738 {
4739 if (t + 1 >= bufsize)
4740 error ("key sequence too long");
4741 /* Run the Lucid hook. */
88ce066e
RS
4742 if (!NILP (Vrun_hooks))
4743 call1 (Vrun_hooks, Qactivate_menubar_hook);
7e85b935
RS
4744 /* If it has changed current-menubar from previous value,
4745 really recompute the menubar from the value. */
4746 if (! NILP (Vlucid_menu_bar_dirty_flag))
4747 call0 (Qrecompute_lucid_menubar);
4748 keybuf[t] = posn;
4749 keybuf[t+1] = key;
4750
4751 /* Zap the position in key, so we know that we've
4752 expanded it, and don't try to do so again. */
4753 POSN_BUFFER_POSN (EVENT_START (key))
4754 = Fcons (posn, Qnil);
4755
4756 mock_input = t + 2;
4757 goto replay_sequence;
4758 }
4759 else if (XTYPE (posn) == Lisp_Cons)
4760 {
4761 /* We're looking at the second event of a
4762 sequence which we expanded before. Set
4763 last_real_key_start appropriately. */
4764 if (last_real_key_start == t && t > 0)
4765 last_real_key_start = t - 1;
4766 }
a6d53864 4767 }
284f4730 4768 }
f4255cd1
JB
4769
4770 /* We have finally decided that KEY is something we might want
4771 to look up. */
284f4730
JB
4772 first_binding = (follow_key (key,
4773 nmaps - first_binding,
253598e4 4774 submaps + first_binding,
284f4730 4775 defs + first_binding,
4e50f26a 4776 submaps + first_binding)
284f4730 4777 + first_binding);
0a7f1fc0 4778
f4255cd1 4779 /* If KEY wasn't bound, we'll try some fallbacks. */
0a7f1fc0
JB
4780 if (first_binding >= nmaps)
4781 {
9b8eb840 4782 Lisp_Object head;
0a7f1fc0 4783
9b8eb840 4784 head = EVENT_HEAD (key);
7e85b935
RS
4785 if (EQ (head, Vhelp_char))
4786 {
4787 read_key_sequence_cmd = Vprefix_help_command;
4788 keybuf[t++] = key;
4789 last_nonmenu_event = key;
4790 goto done;
4791 }
4792
0a7f1fc0
JB
4793 if (XTYPE (head) == Lisp_Symbol)
4794 {
9b8eb840
KH
4795 Lisp_Object breakdown;
4796 int modifiers;
0a7f1fc0 4797
9b8eb840
KH
4798 breakdown = parse_modifiers (head);
4799 modifiers = XINT (XCONS (XCONS (breakdown)->cdr)->car);
559f9d04
RS
4800 /* Attempt to reduce an unbound mouse event to a simpler
4801 event that is bound:
4802 Drags reduce to clicks.
4803 Double-clicks reduce to clicks.
4804 Triple-clicks reduce to double-clicks, then to clicks.
4805 Down-clicks are eliminated.
4806 Double-downs reduce to downs, then are eliminated.
4807 Triple-downs reduce to double-downs, then to downs,
4808 then are eliminated. */
4809 if (modifiers & (down_modifier | drag_modifier
4810 | double_modifier | triple_modifier))
0a7f1fc0 4811 {
559f9d04
RS
4812 while (modifiers & (down_modifier | drag_modifier
4813 | double_modifier | triple_modifier))
fbcd35bd
JB
4814 {
4815 Lisp_Object new_head, new_click;
4816 if (modifiers & triple_modifier)
4817 modifiers ^= (double_modifier | triple_modifier);
559f9d04 4818 else if (modifiers & (drag_modifier | double_modifier))
fbcd35bd 4819 modifiers &= ~(drag_modifier | double_modifier);
559f9d04
RS
4820 else
4821 {
4822 /* Dispose of this `down' event by simply jumping
4823 back to replay_key, to get another event.
4824
4825 Note that if this event came from mock input,
4826 then just jumping back to replay_key will just
4827 hand it to us again. So we have to wipe out any
4828 mock input.
4829
4830 We could delete keybuf[t] and shift everything
4831 after that to the left by one spot, but we'd also
4832 have to fix up any variable that points into
4833 keybuf, and shifting isn't really necessary
4834 anyway.
4835
4836 Adding prefixes for non-textual mouse clicks
4837 creates two characters of mock input, and both
4838 must be thrown away. If we're only looking at
4839 the prefix now, we can just jump back to
4840 replay_key. On the other hand, if we've already
4841 processed the prefix, and now the actual click
4842 itself is giving us trouble, then we've lost the
4843 state of the keymaps we want to backtrack to, and
4844 we need to replay the whole sequence to rebuild
4845 it.
4846
4847 Beyond that, only function key expansion could
4848 create more than two keys, but that should never
4849 generate mouse events, so it's okay to zero
4850 mock_input in that case too.
4851
4852 Isn't this just the most wonderful code ever? */
4853 if (t == last_real_key_start)
4854 {
4855 mock_input = 0;
4856 goto replay_key;
4857 }
4858 else
4859 {
4860 mock_input = last_real_key_start;
4861 goto replay_sequence;
4862 }
4863 }
4864
27203ead
RS
4865 new_head
4866 = apply_modifiers (modifiers, XCONS (breakdown)->car);
4867 new_click
4868 = Fcons (new_head, Fcons (EVENT_START (key), Qnil));
fbcd35bd
JB
4869
4870 /* Look for a binding for this new key. follow_key
4871 promises that it didn't munge submaps the
4872 last time we called it, since key was unbound. */
27203ead
RS
4873 first_binding
4874 = (follow_key (new_click,
4875 nmaps - local_first_binding,
4876 submaps + local_first_binding,
4877 defs + local_first_binding,
4e50f26a 4878 submaps + local_first_binding)
27203ead 4879 + local_first_binding);
fbcd35bd
JB
4880
4881 /* If that click is bound, go for it. */
4882 if (first_binding < nmaps)
4883 {
4884 key = new_click;
4885 break;
4886 }
4887 /* Otherwise, we'll leave key set to the drag event. */
4888 }
0a7f1fc0
JB
4889 }
4890 }
4891 }
4892
284f4730 4893 keybuf[t++] = key;
7d6de002
RS
4894 /* Normally, last_nonmenu_event gets the previous key we read.
4895 But when a mouse popup menu is being used,
4896 we don't update last_nonmenu_event; it continues to hold the mouse
4897 event that preceded the first level of menu. */
4898 if (!used_mouse_menu)
4899 last_nonmenu_event = key;
284f4730
JB
4900
4901 /* If the sequence is unbound, see if we can hang a function key
253598e4
JB
4902 off the end of it. We only want to scan real keyboard input
4903 for function key sequences, so if mock_input says that we're
f4255cd1 4904 re-reading old events, don't examine it. */
4e50f26a 4905 if (first_binding >= nmaps
253598e4 4906 && t >= mock_input)
284f4730
JB
4907 {
4908 Lisp_Object fkey_next;
4909
e9bf89a0
RS
4910 /* Continue scan from fkey_end until we find a bound suffix.
4911 If we fail, increment fkey_start
4912 and start fkey_end from there. */
284f4730
JB
4913 while (fkey_end < t)
4914 {
f4255cd1
JB
4915 Lisp_Object key;
4916
4917 key = keybuf[fkey_end++];
067ffa38
JB
4918 /* Look up meta-characters by prefixing them
4919 with meta_prefix_char. I hate this. */
d3cc13fa 4920 if (XTYPE (key) == Lisp_Int && XINT (key) & meta_modifier)
f4255cd1 4921 {
e74fbc70
RS
4922 fkey_next
4923 = get_keymap_1
f4255cd1 4924 (get_keyelt
e74fbc70 4925 (access_keymap (fkey_map, meta_prefix_char, 1, 0)),
f4255cd1 4926 0, 1);
d3cc13fa 4927 XFASTINT (key) = XFASTINT (key) & ~meta_modifier;
f4255cd1 4928 }
067ffa38
JB
4929 else
4930 fkey_next = fkey_map;
4931
e74fbc70
RS
4932 fkey_next
4933 = get_keyelt (access_keymap (fkey_next, key, 1, 0));
067ffa38 4934
7a80a6f6
RS
4935#if 0 /* I didn't turn this on, because it might cause trouble
4936 for the mapping of return into C-m and tab into C-i. */
4937 /* Optionally don't map function keys into other things.
4938 This enables the user to redefine kp- keys easily. */
4939 if (SYMBOLP (key) && !NILP (Vinhibit_function_key_mapping))
4940 fkey_next = Qnil;
4941#endif
4942
1abe6abe
RS
4943 /* If the function key map gives a function, not an
4944 array, then call the function with no args and use
4945 its value instead. */
4946 if (SYMBOLP (fkey_next) && ! NILP (Ffboundp (fkey_next))
4947 && fkey_end == t)
4948 {
4949 struct gcpro gcpro1, gcpro2, gcpro3;
4950 Lisp_Object tem;
4951 tem = fkey_next;
4952
4953 GCPRO3 (fkey_map, keytran_map, delayed_switch_frame);
84d91fda 4954 fkey_next = call1 (fkey_next, prompt);
1abe6abe
RS
4955 UNGCPRO;
4956 /* If the function returned something invalid,
4957 barf--don't ignore it.
4958 (To ignore it safely, we would need to gcpro a bunch of
4959 other variables.) */
4960 if (! (VECTORP (fkey_next) || STRINGP (fkey_next)))
4961 error ("Function in function-key-map returns invalid key sequence");
4962 }
4963
e9bf89a0
RS
4964 function_key_possible = ! NILP (fkey_next);
4965
85bc5181 4966 /* If keybuf[fkey_start..fkey_end] is bound in the
a764a753 4967 function key map and it's a suffix of the current
85bc5181 4968 sequence (i.e. fkey_end == t), replace it with
a764a753 4969 the binding and restart with fkey_start at the end. */
f5ea6163 4970 if ((VECTORP (fkey_next) || STRINGP (fkey_next))
284f4730
JB
4971 && fkey_end == t)
4972 {
2e864a76 4973 int len = XFASTINT (Flength (fkey_next));
f5ea6163
JB
4974
4975 t = fkey_start + len;
284f4730
JB
4976 if (t >= bufsize)
4977 error ("key sequence too long");
4978
f5ea6163
JB
4979 if (VECTORP (fkey_next))
4980 bcopy (XVECTOR (fkey_next)->contents,
4981 keybuf + fkey_start,
4982 (t - fkey_start) * sizeof (keybuf[0]));
4983 else if (STRINGP (fkey_next))
4984 {
4985 int i;
4986
4987 for (i = 0; i < len; i++)
1abe6abe
RS
4988 XFASTINT (keybuf[fkey_start + i])
4989 = XSTRING (fkey_next)->data[i];
f5ea6163 4990 }
284f4730
JB
4991
4992 mock_input = t;
4993 fkey_start = fkey_end = t;
32e6d806 4994 fkey_map = Vfunction_key_map;
284f4730 4995
f4255cd1 4996 goto replay_sequence;
284f4730
JB
4997 }
4998
f4255cd1 4999 fkey_map = get_keymap_1 (fkey_next, 0, 1);
284f4730 5000
a764a753
JB
5001 /* If we no longer have a bound suffix, try a new positions for
5002 fkey_start. */
284f4730
JB
5003 if (NILP (fkey_map))
5004 {
5005 fkey_end = ++fkey_start;
5006 fkey_map = Vfunction_key_map;
e9bf89a0 5007 function_key_possible = 0;
284f4730
JB
5008 }
5009 }
5010 }
a612e298
RS
5011
5012 /* Look for this sequence in key-translation-map. */
5013 {
5014 Lisp_Object keytran_next;
5015
5016 /* Scan from keytran_end until we find a bound suffix. */
5017 while (keytran_end < t)
5018 {
5019 Lisp_Object key;
5020
5021 key = keybuf[keytran_end++];
5022 /* Look up meta-characters by prefixing them
5023 with meta_prefix_char. I hate this. */
5024 if (XTYPE (key) == Lisp_Int && XINT (key) & meta_modifier)
5025 {
5026 keytran_next
5027 = get_keymap_1
5028 (get_keyelt
5029 (access_keymap (keytran_map, meta_prefix_char, 1, 0)),
5030 0, 1);
5031 XFASTINT (key) = XFASTINT (key) & ~meta_modifier;
5032 }
5033 else
5034 keytran_next = keytran_map;
5035
5036 keytran_next
5037 = get_keyelt (access_keymap (keytran_next, key, 1, 0));
5038
1abe6abe
RS
5039 /* If the key translation map gives a function, not an
5040 array, then call the function with no args and use
5041 its value instead. */
5042 if (SYMBOLP (keytran_next) && ! NILP (Ffboundp (keytran_next))
5043 && keytran_end == t)
5044 {
5045 struct gcpro gcpro1, gcpro2, gcpro3;
5046 Lisp_Object tem;
5047 tem = keytran_next;
5048
40932d1a 5049 GCPRO3 (fkey_map, keytran_map, delayed_switch_frame);
84d91fda 5050 keytran_next = call1 (keytran_next, prompt);
1abe6abe
RS
5051 UNGCPRO;
5052 /* If the function returned something invalid,
5053 barf--don't ignore it.
5054 (To ignore it safely, we would need to gcpro a bunch of
5055 other variables.) */
5056 if (! (VECTORP (keytran_next) || STRINGP (keytran_next)))
40932d1a 5057 error ("Function in key-translation-map returns invalid key sequence");
1abe6abe
RS
5058 }
5059
a612e298 5060 /* If keybuf[keytran_start..keytran_end] is bound in the
1abe6abe 5061 key translation map and it's a suffix of the current
a612e298
RS
5062 sequence (i.e. keytran_end == t), replace it with
5063 the binding and restart with keytran_start at the end. */
5064 if ((VECTORP (keytran_next) || STRINGP (keytran_next))
5065 && keytran_end == t)
5066 {
2e864a76 5067 int len = XFASTINT (Flength (keytran_next));
a612e298
RS
5068
5069 t = keytran_start + len;
5070 if (t >= bufsize)
5071 error ("key sequence too long");
5072
5073 if (VECTORP (keytran_next))
5074 bcopy (XVECTOR (keytran_next)->contents,
5075 keybuf + keytran_start,
5076 (t - keytran_start) * sizeof (keybuf[0]));
5077 else if (STRINGP (keytran_next))
5078 {
5079 int i;
5080
5081 for (i = 0; i < len; i++)
5082 XFASTINT (keybuf[keytran_start + i])
5083 = XSTRING (keytran_next)->data[i];
5084 }
5085
5086 mock_input = t;
5087 keytran_start = keytran_end = t;
5088 keytran_map = Vkey_translation_map;
5089
5090 goto replay_sequence;
5091 }
5092
5093 keytran_map = get_keymap_1 (keytran_next, 0, 1);
5094
5095 /* If we no longer have a bound suffix, try a new positions for
5096 keytran_start. */
5097 if (NILP (keytran_map))
5098 {
5099 keytran_end = ++keytran_start;
5100 keytran_map = Vkey_translation_map;
5101 }
5102 }
5103 }
4e50f26a
RS
5104
5105 /* If KEY is not defined in any of the keymaps,
5106 and cannot be part of a function key or translation,
5107 and is an upper case letter
5108 use the corresponding lower-case letter instead. */
5109 if (first_binding == nmaps && ! function_key_possible
5110 && XTYPE (key) == Lisp_Int
5111 && ((((XINT (key) & 0x3ffff)
5112 < XSTRING (current_buffer->downcase_table)->size)
5113 && UPPERCASEP (XINT (key) & 0x3ffff))
5114 || (XINT (key) & shift_modifier)))
5115 {
5116 if (XINT (key) & shift_modifier)
5117 XSETINT (key, XINT (key) & ~shift_modifier);
5118 else
5119 XSETINT (key, (DOWNCASE (XINT (key) & 0x3ffff)
5120 | (XINT (key) & ~0x3ffff)));
5121
5122 keybuf[t - 1] = key;
5123 mock_input = t;
5124 goto replay_sequence;
5125 }
284f4730
JB
5126 }
5127
5128 read_key_sequence_cmd = (first_binding < nmaps
5129 ? defs[first_binding]
5130 : Qnil);
5131
f4255cd1 5132 done:
cd21b839 5133 unread_switch_frame = delayed_switch_frame;
f4255cd1 5134 unbind_to (count, Qnil);
07f76a14
JB
5135
5136 /* Occasionally we fabricate events, perhaps by expanding something
5137 according to function-key-map, or by adding a prefix symbol to a
5138 mouse click in the scroll bar or modeline. In this cases, return
5139 the entire generated key sequence, even if we hit an unbound
5140 prefix or a definition before the end. This means that you will
5141 be able to push back the event properly, and also means that
5142 read-key-sequence will always return a logical unit.
5143
5144 Better ideas? */
cca310da
JB
5145 for (; t < mock_input; t++)
5146 {
a98ea3f9
RS
5147 if (echo_keystrokes)
5148 echo_char (keybuf[t]);
cca310da
JB
5149 add_command_key (keybuf[t]);
5150 }
07f76a14 5151
284f4730
JB
5152 return t;
5153}
5154
a612e298
RS
5155#if 0 /* This doc string is too long for some compilers.
5156 This commented-out definition serves for DOC. */
c0a58692 5157DEFUN ("read-key-sequence", Fread_key_sequence, Sread_key_sequence, 1, 2, 0,
284f4730
JB
5158 "Read a sequence of keystrokes and return as a string or vector.\n\
5159The sequence is sufficient to specify a non-prefix command in the\n\
5160current local and global maps.\n\
5161\n\
c0a58692
RS
5162First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
5163Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
5164as a continuation of the previous key.\n\
284f4730 5165\n\
cb5df6ae
JB
5166A C-g typed while in this function is treated like any other character,\n\
5167and `quit-flag' is not set.\n\
5168\n\
5169If the key sequence starts with a mouse click, then the sequence is read\n\
5170using the keymaps of the buffer of the window clicked in, not the buffer\n\
5171of the selected window as normal.\n\
ede41463 5172""\n\
cb5df6ae
JB
5173`read-key-sequence' drops unbound button-down events, since you normally\n\
5174only care about the click or drag events which follow them. If a drag\n\
fbcd35bd
JB
5175or multi-click event is unbound, but the corresponding click event would\n\
5176be bound, `read-key-sequence' turns the event into a click event at the\n\
cb5df6ae 5177drag's starting position. This means that you don't have to distinguish\n\
fbcd35bd 5178between click and drag, double, or triple events unless you want to.\n\
cb5df6ae
JB
5179\n\
5180`read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
3c370943
JB
5181lines separating windows, and scroll bars with imaginary keys\n\
5182`mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
cb5df6ae
JB
5183\n\
5184If the user switches frames in the middle of a key sequence, the\n\
5185frame-switch event is put off until after the current key sequence.\n\
5186\n\
5187`read-key-sequence' checks `function-key-map' for function key\n\
5188sequences, where they wouldn't conflict with ordinary bindings. See\n\
4bb994d1 5189`function-key-map' for more details.")
a612e298
RS
5190 (prompt, continue_echo)
5191#endif
5192
5193DEFUN ("read-key-sequence", Fread_key_sequence, Sread_key_sequence, 1, 2, 0,
5194 0)
c0a58692
RS
5195 (prompt, continue_echo)
5196 Lisp_Object prompt, continue_echo;
284f4730
JB
5197{
5198 Lisp_Object keybuf[30];
5199 register int i;
5200 struct gcpro gcpro1, gcpro2;
5201
5202 if (!NILP (prompt))
5203 CHECK_STRING (prompt, 0);
5204 QUIT;
5205
5206 bzero (keybuf, sizeof keybuf);
5207 GCPRO1 (keybuf[0]);
5208 gcpro1.nvars = (sizeof keybuf/sizeof (keybuf[0]));
5209
daa37602 5210 if (NILP (continue_echo))
c0a58692
RS
5211 this_command_key_count = 0;
5212
84d91fda 5213 i = read_key_sequence (keybuf, (sizeof keybuf/sizeof (keybuf[0])), prompt);
284f4730 5214
dcc408a0
RS
5215 if (i == -1)
5216 {
5217 Vquit_flag = Qt;
5218 QUIT;
5219 }
284f4730 5220 UNGCPRO;
86e5706b 5221 return make_event_array (i, keybuf);
284f4730
JB
5222}
5223\f
5224DEFUN ("command-execute", Fcommand_execute, Scommand_execute, 1, 2, 0,
5225 "Execute CMD as an editor command.\n\
5226CMD must be a symbol that satisfies the `commandp' predicate.\n\
5227Optional second arg RECORD-FLAG non-nil\n\
5228means unconditionally put this command in `command-history'.\n\
5229Otherwise, that is done only if an arg is read using the minibuffer.")
5230 (cmd, record)
5231 Lisp_Object cmd, record;
5232{
5233 register Lisp_Object final;
5234 register Lisp_Object tem;
5235 Lisp_Object prefixarg;
5236 struct backtrace backtrace;
5237 extern int debug_on_next_call;
5238
5239 prefixarg = Vprefix_arg, Vprefix_arg = Qnil;
5240 Vcurrent_prefix_arg = prefixarg;
5241 debug_on_next_call = 0;
5242
5243 if (XTYPE (cmd) == Lisp_Symbol)
5244 {
5245 tem = Fget (cmd, Qdisabled);
88ce066e 5246 if (!NILP (tem) && !NILP (Vrun_hooks))
2e894dab 5247 return call1 (Vrun_hooks, Qdisabled_command_hook);
284f4730
JB
5248 }
5249
5250 while (1)
5251 {
ffd56f97 5252 final = Findirect_function (cmd);
284f4730
JB
5253
5254 if (CONSP (final) && (tem = Fcar (final), EQ (tem, Qautoload)))
5255 do_autoload (final, cmd);
5256 else
5257 break;
5258 }
5259
5260 if (XTYPE (final) == Lisp_String
5261 || XTYPE (final) == Lisp_Vector)
5262 {
5263 /* If requested, place the macro in the command history. For
5264 other sorts of commands, call-interactively takes care of
5265 this. */
5266 if (!NILP (record))
5267 Vcommand_history
5268 = Fcons (Fcons (Qexecute_kbd_macro,
5269 Fcons (final, Fcons (prefixarg, Qnil))),
5270 Vcommand_history);
5271
5272 return Fexecute_kbd_macro (final, prefixarg);
5273 }
5274 if (CONSP (final) || XTYPE (final) == Lisp_Subr
5275 || XTYPE (final) == Lisp_Compiled)
5276 {
5277 backtrace.next = backtrace_list;
5278 backtrace_list = &backtrace;
5279 backtrace.function = &Qcall_interactively;
5280 backtrace.args = &cmd;
5281 backtrace.nargs = 1;
5282 backtrace.evalargs = 0;
5283
5284 tem = Fcall_interactively (cmd, record);
5285
5286 backtrace_list = backtrace.next;
5287 return tem;
5288 }
5289 return Qnil;
5290}
5291\f
284f4730
JB
5292DEFUN ("execute-extended-command", Fexecute_extended_command, Sexecute_extended_command,
5293 1, 1, "P",
5294 "Read function name, then read its arguments and call it.")
5295 (prefixarg)
5296 Lisp_Object prefixarg;
5297{
5298 Lisp_Object function;
5299 char buf[40];
5300 Lisp_Object saved_keys;
5301 struct gcpro gcpro1;
5302
b0f2a7bf
KH
5303 saved_keys = Fvector (this_command_key_count,
5304 XVECTOR (this_command_keys)->contents);
284f4730
JB
5305 buf[0] = 0;
5306 GCPRO1 (saved_keys);
5307
5308 if (EQ (prefixarg, Qminus))
5309 strcpy (buf, "- ");
5310 else if (CONSP (prefixarg) && XINT (XCONS (prefixarg)->car) == 4)
5311 strcpy (buf, "C-u ");
5312 else if (CONSP (prefixarg) && XTYPE (XCONS (prefixarg)->car) == Lisp_Int)
5313 sprintf (buf, "%d ", XINT (XCONS (prefixarg)->car));
5314 else if (XTYPE (prefixarg) == Lisp_Int)
5315 sprintf (buf, "%d ", XINT (prefixarg));
5316
5317 /* This isn't strictly correct if execute-extended-command
5318 is bound to anything else. Perhaps it should use
5319 this_command_keys? */
5320 strcat (buf, "M-x ");
5321
5322 /* Prompt with buf, and then read a string, completing from and
5323 restricting to the set of all defined commands. Don't provide
51763820 5324 any initial input. Save the command read on the extended-command
03b4122a 5325 history list. */
284f4730
JB
5326 function = Fcompleting_read (build_string (buf),
5327 Vobarray, Qcommandp,
03b4122a 5328 Qt, Qnil, Qextended_command_history);
284f4730 5329
1113d9db
JB
5330 /* Set this_command_keys to the concatenation of saved_keys and
5331 function, followed by a RET. */
284f4730 5332 {
1113d9db 5333 struct Lisp_String *str;
b0f2a7bf 5334 Lisp_Object *keys;
284f4730
JB
5335 int i;
5336 Lisp_Object tem;
5337
1113d9db
JB
5338 this_command_key_count = 0;
5339
b0f2a7bf
KH
5340 keys = XVECTOR (saved_keys)->contents;
5341 for (i = 0; i < XVECTOR (saved_keys)->size; i++)
5342 add_command_key (keys[i]);
1113d9db
JB
5343
5344 str = XSTRING (function);
5345 for (i = 0; i < str->size; i++)
5346 {
5347 XFASTINT (tem) = str->data[i];
5348 add_command_key (tem);
5349 }
5350
5351 XFASTINT (tem) = '\015';
5352 add_command_key (tem);
284f4730
JB
5353 }
5354
5355 UNGCPRO;
5356
0a7f1fc0 5357 function = Fintern (function, Qnil);
284f4730
JB
5358 Vprefix_arg = prefixarg;
5359 this_command = function;
5360
5361 return Fcommand_execute (function, Qt);
5362}
5363\f
5364
5365detect_input_pending ()
5366{
5367 if (!input_pending)
5368 get_input_pending (&input_pending);
5369
5370 return input_pending;
5371}
5372
ffd56f97
JB
5373/* This is called in some cases before a possible quit.
5374 It cases the next call to detect_input_pending to recompute input_pending.
5375 So calling this function unnecessarily can't do any harm. */
5376clear_input_pending ()
5377{
5378 input_pending = 0;
5379}
5380
284f4730
JB
5381DEFUN ("input-pending-p", Finput_pending_p, Sinput_pending_p, 0, 0, 0,
5382 "T if command input is currently available with no waiting.\n\
5383Actually, the value is nil only if we can be sure that no input is available.")
5384 ()
5385{
24597608 5386 if (!NILP (Vunread_command_events) || unread_command_char != -1)
284f4730
JB
5387 return (Qt);
5388
5389 return detect_input_pending () ? Qt : Qnil;
5390}
5391
5392DEFUN ("recent-keys", Frecent_keys, Srecent_keys, 0, 0, 0,
22d7cb89 5393 "Return vector of last 100 events, not counting those from keyboard macros.")
284f4730
JB
5394 ()
5395{
5160df46 5396 Lisp_Object *keys = XVECTOR (recent_keys)->contents;
284f4730
JB
5397 Lisp_Object val;
5398
5399 if (total_keys < NUM_RECENT_KEYS)
5160df46 5400 return Fvector (total_keys, keys);
284f4730
JB
5401 else
5402 {
5160df46
JB
5403 val = Fvector (NUM_RECENT_KEYS, keys);
5404 bcopy (keys + recent_keys_index,
284f4730
JB
5405 XVECTOR (val)->contents,
5406 (NUM_RECENT_KEYS - recent_keys_index) * sizeof (Lisp_Object));
5160df46 5407 bcopy (keys,
284f4730
JB
5408 XVECTOR (val)->contents + NUM_RECENT_KEYS - recent_keys_index,
5409 recent_keys_index * sizeof (Lisp_Object));
5410 return val;
5411 }
5412}
5413
5414DEFUN ("this-command-keys", Fthis_command_keys, Sthis_command_keys, 0, 0, 0,
e5f920d7
RS
5415 "Return the key sequence that invoked this command.\n\
5416The value is a string or a vector.")
284f4730
JB
5417 ()
5418{
86e5706b
RS
5419 return make_event_array (this_command_key_count,
5420 XVECTOR (this_command_keys)->contents);
284f4730
JB
5421}
5422
5423DEFUN ("recursion-depth", Frecursion_depth, Srecursion_depth, 0, 0, 0,
5424 "Return the current depth in recursive edits.")
5425 ()
5426{
5427 Lisp_Object temp;
5428 XFASTINT (temp) = command_loop_level + minibuf_level;
5429 return temp;
5430}
5431
5432DEFUN ("open-dribble-file", Fopen_dribble_file, Sopen_dribble_file, 1, 1,
5433 "FOpen dribble file: ",
9b2471df
RS
5434 "Start writing all keyboard characters to a dribble file called FILE.\n\
5435If FILE is nil, close any open dribble file.")
284f4730
JB
5436 (file)
5437 Lisp_Object file;
5438{
5439 if (NILP (file))
5440 {
5441 fclose (dribble);
5442 dribble = 0;
5443 }
5444 else
5445 {
5446 file = Fexpand_file_name (file, Qnil);
5447 dribble = fopen (XSTRING (file)->data, "w");
5448 }
5449 return Qnil;
5450}
5451
5452DEFUN ("discard-input", Fdiscard_input, Sdiscard_input, 0, 0, 0,
5453 "Discard the contents of the terminal input buffer.\n\
5454Also cancel any kbd macro being defined.")
5455 ()
5456{
5457 defining_kbd_macro = 0;
5458 update_mode_lines++;
5459
24597608 5460 Vunread_command_events = Qnil;
86e5706b 5461 unread_command_char = -1;
284f4730
JB
5462
5463 discard_tty_input ();
5464
ff0b5f4c
JB
5465 /* Without the cast, GCC complains that this assignment loses the
5466 volatile qualifier of kbd_store_ptr. Is there anything wrong
5467 with that? */
5468 kbd_fetch_ptr = (struct input_event *) kbd_store_ptr;
7b4aedb9 5469 Ffillarray (kbd_buffer_frame_or_window, Qnil);
284f4730
JB
5470 input_pending = 0;
5471
5472 return Qnil;
5473}
5474\f
5475DEFUN ("suspend-emacs", Fsuspend_emacs, Ssuspend_emacs, 0, 1, "",
5476 "Stop Emacs and return to superior process. You can resume later.\n\
8026024c
KH
5477If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
5478control, run a subshell instead.\n\n\
284f4730 5479If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
b7d2ebbf
RS
5480to be read as terminal input by Emacs's parent, after suspension.\n\
5481\n\
7df30614 5482Before suspending, call the functions in `suspend-hook' with no args.\n\
b7d2ebbf
RS
5483If any of them returns nil, don't call the rest and don't suspend.\n\
5484Otherwise, suspend normally and after resumption run the normal hook\n\
284f4730
JB
5485`suspend-resume-hook' if that is bound and non-nil.\n\
5486\n\
5487Some operating systems cannot stop the Emacs process and resume it later.\n\
b7d2ebbf 5488On such systems, Emacs starts a subshell instead of suspending.")
284f4730
JB
5489 (stuffstring)
5490 Lisp_Object stuffstring;
5491{
3a69360c 5492 Lisp_Object tem;
284f4730
JB
5493 int count = specpdl_ptr - specpdl;
5494 int old_height, old_width;
5495 int width, height;
b7d2ebbf 5496 struct gcpro gcpro1, gcpro2;
284f4730
JB
5497 extern init_sys_modes ();
5498
5499 if (!NILP (stuffstring))
5500 CHECK_STRING (stuffstring, 0);
284f4730 5501
1e95ed28
JB
5502 /* Run the functions in suspend-hook. */
5503 if (!NILP (Vrun_hooks))
5504 call1 (Vrun_hooks, intern ("suspend-hook"));
284f4730 5505
b7d2ebbf 5506 GCPRO1 (stuffstring);
ff11dfa1 5507 get_frame_size (&old_width, &old_height);
284f4730
JB
5508 reset_sys_modes ();
5509 /* sys_suspend can get an error if it tries to fork a subshell
5510 and the system resources aren't available for that. */
5511 record_unwind_protect (init_sys_modes, 0);
5512 stuff_buffered_input (stuffstring);
8026024c
KH
5513 if (cannot_suspend)
5514 sys_subshell ();
5515 else
5516 sys_suspend ();
284f4730
JB
5517 unbind_to (count, Qnil);
5518
5519 /* Check if terminal/window size has changed.
5520 Note that this is not useful when we are running directly
5521 with a window system; but suspend should be disabled in that case. */
ff11dfa1 5522 get_frame_size (&width, &height);
284f4730 5523 if (width != old_width || height != old_height)
f5ea6163 5524 change_frame_size (selected_frame, height, width, 0, 0);
284f4730 5525
1e95ed28 5526 /* Run suspend-resume-hook. */
284f4730
JB
5527 if (!NILP (Vrun_hooks))
5528 call1 (Vrun_hooks, intern ("suspend-resume-hook"));
5529
5530 UNGCPRO;
5531 return Qnil;
5532}
5533
5534/* If STUFFSTRING is a string, stuff its contents as pending terminal input.
eb8c3be9 5535 Then in any case stuff anything Emacs has read ahead and not used. */
284f4730
JB
5536
5537stuff_buffered_input (stuffstring)
5538 Lisp_Object stuffstring;
5539{
5540 register unsigned char *p;
5541
5542/* stuff_char works only in BSD, versions 4.2 and up. */
5543#ifdef BSD
5544#ifndef BSD4_1
5545 if (XTYPE (stuffstring) == Lisp_String)
5546 {
5547 register int count;
5548
5549 p = XSTRING (stuffstring)->data;
5550 count = XSTRING (stuffstring)->size;
5551 while (count-- > 0)
5552 stuff_char (*p++);
5553 stuff_char ('\n');
5554 }
5555 /* Anything we have read ahead, put back for the shell to read. */
5556 while (kbd_fetch_ptr != kbd_store_ptr)
5557 {
5558 if (kbd_fetch_ptr == kbd_buffer + KBD_BUFFER_SIZE)
5559 kbd_fetch_ptr = kbd_buffer;
5560 if (kbd_fetch_ptr->kind == ascii_keystroke)
e9bf89a0 5561 stuff_char (kbd_fetch_ptr->code);
4bb994d1 5562 kbd_fetch_ptr->kind = no_event;
7b4aedb9
JB
5563 (XVECTOR (kbd_buffer_frame_or_window)->contents[kbd_fetch_ptr
5564 - kbd_buffer]
5565 = Qnil);
284f4730
JB
5566 kbd_fetch_ptr++;
5567 }
5568 input_pending = 0;
5569#endif
5570#endif /* BSD and not BSD4_1 */
5571}
5572\f
ffd56f97
JB
5573set_waiting_for_input (time_to_clear)
5574 EMACS_TIME *time_to_clear;
284f4730 5575{
ffd56f97 5576 input_available_clear_time = time_to_clear;
284f4730
JB
5577
5578 /* Tell interrupt_signal to throw back to read_char, */
5579 waiting_for_input = 1;
5580
5581 /* If interrupt_signal was called before and buffered a C-g,
5582 make it run again now, to avoid timing error. */
5583 if (!NILP (Vquit_flag))
5584 quit_throw_to_read_char ();
284f4730
JB
5585}
5586
5587clear_waiting_for_input ()
5588{
5589 /* Tell interrupt_signal not to throw back to read_char, */
5590 waiting_for_input = 0;
ffd56f97 5591 input_available_clear_time = 0;
284f4730
JB
5592}
5593
5594/* This routine is called at interrupt level in response to C-G.
5595 If interrupt_input, this is the handler for SIGINT.
5596 Otherwise, it is called from kbd_buffer_store_event,
5597 in handling SIGIO or SIGTINT.
5598
5599 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
5600 immediately throw back to read_char.
5601
5602 Otherwise it sets the Lisp variable quit-flag not-nil.
5603 This causes eval to throw, when it gets a chance.
5604 If quit-flag is already non-nil, it stops the job right away. */
5605
5606SIGTYPE
5607interrupt_signal ()
5608{
5609 char c;
5610 /* Must preserve main program's value of errno. */
5611 int old_errno = errno;
284f4730
JB
5612
5613#ifdef USG
7a80a6f6
RS
5614 if (!read_socket_hook && NILP (Vwindow_system))
5615 {
5616 /* USG systems forget handlers when they are used;
5617 must reestablish each time */
5618 signal (SIGINT, interrupt_signal);
5619 signal (SIGQUIT, interrupt_signal);
5620 }
284f4730
JB
5621#endif /* USG */
5622
5623 cancel_echoing ();
5624
d5045cf9 5625 if (!NILP (Vquit_flag) && FRAME_TERMCAP_P (selected_frame))
284f4730
JB
5626 {
5627 fflush (stdout);
5628 reset_sys_modes ();
5629 sigfree ();
5630#ifdef SIGTSTP /* Support possible in later USG versions */
5631/*
5632 * On systems which can suspend the current process and return to the original
5633 * shell, this command causes the user to end up back at the shell.
5634 * The "Auto-save" and "Abort" questions are not asked until
5635 * the user elects to return to emacs, at which point he can save the current
5636 * job and either dump core or continue.
5637 */
5638 sys_suspend ();
5639#else
5640#ifdef VMS
5641 if (sys_suspend () == -1)
5642 {
5643 printf ("Not running as a subprocess;\n");
5644 printf ("you can continue or abort.\n");
5645 }
5646#else /* not VMS */
5647 /* Perhaps should really fork an inferior shell?
5648 But that would not provide any way to get back
5649 to the original shell, ever. */
5650 printf ("No support for stopping a process on this operating system;\n");
5651 printf ("you can continue or abort.\n");
5652#endif /* not VMS */
5653#endif /* not SIGTSTP */
80e4aa30
RS
5654#ifdef MSDOS
5655 /* We must remain inside the screen area when the internal terminal
5656 is used. Note that [Enter] is not echoed by dos. */
5657 cursor_to (0, 0);
5658#endif
284f4730
JB
5659 printf ("Auto-save? (y or n) ");
5660 fflush (stdout);
5661 if (((c = getchar ()) & ~040) == 'Y')
9fd7d808
RS
5662 {
5663 Fdo_auto_save (Qt, Qnil);
80e4aa30
RS
5664#ifdef MSDOS
5665 printf ("\r\nAuto-save done");
5666#else /* not MSDOS */
9fd7d808 5667 printf ("Auto-save done\n");
80e4aa30 5668#endif /* not MSDOS */
9fd7d808 5669 }
284f4730 5670 while (c != '\n') c = getchar ();
80e4aa30
RS
5671#ifdef MSDOS
5672 printf ("\r\nAbort? (y or n) ");
5673#else /* not MSDOS */
284f4730
JB
5674#ifdef VMS
5675 printf ("Abort (and enter debugger)? (y or n) ");
5676#else /* not VMS */
5677 printf ("Abort (and dump core)? (y or n) ");
5678#endif /* not VMS */
80e4aa30 5679#endif /* not MSDOS */
284f4730
JB
5680 fflush (stdout);
5681 if (((c = getchar ()) & ~040) == 'Y')
5682 abort ();
5683 while (c != '\n') c = getchar ();
80e4aa30
RS
5684#ifdef MSDOS
5685 printf ("\r\nContinuing...\r\n");
5686#else /* not MSDOS */
284f4730 5687 printf ("Continuing...\n");
80e4aa30 5688#endif /* not MSDOS */
284f4730
JB
5689 fflush (stdout);
5690 init_sys_modes ();
5691 }
5692 else
5693 {
5694 /* If executing a function that wants to be interrupted out of
5695 and the user has not deferred quitting by binding `inhibit-quit'
5696 then quit right away. */
5697 if (immediate_quit && NILP (Vinhibit_quit))
5698 {
5699 immediate_quit = 0;
5700 sigfree ();
5701 Fsignal (Qquit, Qnil);
5702 }
5703 else
5704 /* Else request quit when it's safe */
5705 Vquit_flag = Qt;
5706 }
5707
5708 if (waiting_for_input && !echoing)
5709 quit_throw_to_read_char ();
5710
5711 errno = old_errno;
5712}
5713
5714/* Handle a C-g by making read_char return C-g. */
5715
5716quit_throw_to_read_char ()
5717{
5718 quit_error_check ();
5719 sigfree ();
5720 /* Prevent another signal from doing this before we finish. */
f76475ad 5721 clear_waiting_for_input ();
284f4730
JB
5722 input_pending = 0;
5723
24597608 5724 Vunread_command_events = Qnil;
86e5706b 5725 unread_command_char = -1;
284f4730 5726
e6b01c14
JB
5727#ifdef POLL_FOR_INPUT
5728 /* May be > 1 if in recursive minibuffer. */
5729 if (poll_suppress_count == 0)
5730 abort ();
5731#endif
0dfcc832 5732#ifdef MULTI_FRAME
e9bf89a0
RS
5733 if (XTYPE (internal_last_event_frame) == Lisp_Frame
5734 && XFRAME (internal_last_event_frame) != selected_frame)
3b9189f8 5735 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame));
0dfcc832 5736#endif
e6b01c14 5737
284f4730
JB
5738 _longjmp (getcjmp, 1);
5739}
5740\f
5741DEFUN ("set-input-mode", Fset_input_mode, Sset_input_mode, 3, 4, 0,
5742 "Set mode of reading keyboard input.\n\
464f8898
RS
5743First arg INTERRUPT non-nil means use input interrupts;\n\
5744 nil means use CBREAK mode.\n\
5745Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
284f4730 5746 (no effect except in CBREAK mode).\n\
b04904fb
RS
5747Third arg META t means accept 8-bit input (for a Meta key).\n\
5748 META nil means ignore the top bit, on the assumption it is parity.\n\
5749 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
a8ee7ef9
RS
5750Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5751See also `current-input-mode'.")
284f4730
JB
5752 (interrupt, flow, meta, quit)
5753 Lisp_Object interrupt, flow, meta, quit;
5754{
5755 if (!NILP (quit)
5756 && (XTYPE (quit) != Lisp_Int
5757 || XINT (quit) < 0 || XINT (quit) > 0400))
34f04431
RS
5758 error ("set-input-mode: QUIT must be an ASCII character");
5759
5760#ifdef POLL_FOR_INPUT
5761 stop_polling ();
5762#endif
284f4730
JB
5763
5764 reset_sys_modes ();
5765#ifdef SIGIO
5766/* Note SIGIO has been undef'd if FIONREAD is missing. */
5767#ifdef NO_SOCK_SIGIO
5768 if (read_socket_hook)
5769 interrupt_input = 0; /* No interrupts if reading from a socket. */
5770 else
5771#endif /* NO_SOCK_SIGIO */
5772 interrupt_input = !NILP (interrupt);
5773#else /* not SIGIO */
5774 interrupt_input = 0;
5775#endif /* not SIGIO */
5776/* Our VMS input only works by interrupts, as of now. */
5777#ifdef VMS
5778 interrupt_input = 1;
5779#endif
5780 flow_control = !NILP (flow);
b04904fb
RS
5781 if (NILP (meta))
5782 meta_key = 0;
5783 else if (EQ (meta, Qt))
5784 meta_key = 1;
5785 else
5786 meta_key = 2;
284f4730
JB
5787 if (!NILP (quit))
5788 /* Don't let this value be out of range. */
5789 quit_char = XINT (quit) & (meta_key ? 0377 : 0177);
5790
5791 init_sys_modes ();
34f04431
RS
5792
5793#ifdef POLL_FOR_INPUT
5794 poll_suppress_count = 1;
5795 start_polling ();
5796#endif
284f4730
JB
5797 return Qnil;
5798}
80645119
JB
5799
5800DEFUN ("current-input-mode", Fcurrent_input_mode, Scurrent_input_mode, 0, 0, 0,
5801 "Return information about the way Emacs currently reads keyboard input.\n\
5802The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
5803 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5804 nil, Emacs is using CBREAK mode.\n\
5805 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5806 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
a8ee7ef9
RS
5807 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5808 META nil means ignoring the top bit, on the assumption it is parity.\n\
5809 META is neither t nor nil if accepting 8-bit input and using\n\
5810 all 8 bits as the character code.\n\
80645119
JB
5811 QUIT is the character Emacs currently uses to quit.\n\
5812The elements of this list correspond to the arguments of\n\
a8ee7ef9 5813`set-input-mode'.")
80645119
JB
5814 ()
5815{
5816 Lisp_Object val[4];
5817
5818 val[0] = interrupt_input ? Qt : Qnil;
5819 val[1] = flow_control ? Qt : Qnil;
a8ee7ef9 5820 val[2] = meta_key == 2 ? make_number (0) : meta_key == 1 ? Qt : Qnil;
7b50ece7 5821 XFASTINT (val[3]) = quit_char;
80645119 5822
bf673a7a 5823 return Flist (sizeof (val) / sizeof (val[0]), val);
80645119
JB
5824}
5825
284f4730
JB
5826\f
5827init_keyboard ()
5828{
284f4730
JB
5829 /* This is correct before outermost invocation of the editor loop */
5830 command_loop_level = -1;
5831 immediate_quit = 0;
5832 quit_char = Ctl ('g');
24597608 5833 Vunread_command_events = Qnil;
86e5706b 5834 unread_command_char = -1;
284f4730 5835 total_keys = 0;
9deb415a 5836 recent_keys_index = 0;
284f4730
JB
5837 kbd_fetch_ptr = kbd_buffer;
5838 kbd_store_ptr = kbd_buffer;
5839 do_mouse_tracking = 0;
5840 input_pending = 0;
5841
07d2b8de 5842#ifdef MULTI_FRAME
8f805655
JB
5843 /* This means that command_loop_1 won't try to select anything the first
5844 time through. */
3c370943
JB
5845 internal_last_event_frame = Qnil;
5846 Vlast_event_frame = internal_last_event_frame;
7b4aedb9
JB
5847#endif
5848
5849 /* If we're running a dumped Emacs, we need to clear out
5850 kbd_buffer_frame_or_window, in case some events got into it
5851 before we dumped.
4bb994d1 5852
7b4aedb9
JB
5853 If we're running an undumped Emacs, it hasn't been initialized by
5854 syms_of_keyboard yet. */
4bb994d1 5855 if (initialized)
7b4aedb9 5856 Ffillarray (kbd_buffer_frame_or_window, Qnil);
07d2b8de 5857
7a80a6f6 5858 if (!noninteractive && !read_socket_hook && NILP (Vwindow_system))
284f4730
JB
5859 {
5860 signal (SIGINT, interrupt_signal);
cb5df6ae 5861#if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
284f4730
JB
5862 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5863 SIGQUIT and we can't tell which one it will give us. */
5864 signal (SIGQUIT, interrupt_signal);
5865#endif /* HAVE_TERMIO */
7a80a6f6 5866 }
284f4730
JB
5867/* Note SIGIO has been undef'd if FIONREAD is missing. */
5868#ifdef SIGIO
7a80a6f6
RS
5869 if (!noninteractive)
5870 signal (SIGIO, input_available_signal);
8ea0a720 5871#endif /* SIGIO */
284f4730
JB
5872
5873/* Use interrupt input by default, if it works and noninterrupt input
5874 has deficiencies. */
5875
5876#ifdef INTERRUPT_INPUT
5877 interrupt_input = 1;
5878#else
5879 interrupt_input = 0;
5880#endif
5881
5882/* Our VMS input only works by interrupts, as of now. */
5883#ifdef VMS
5884 interrupt_input = 1;
5885#endif
5886
5887 sigfree ();
5888 dribble = 0;
5889
5890 if (keyboard_init_hook)
5891 (*keyboard_init_hook) ();
5892
5893#ifdef POLL_FOR_INPUT
5894 poll_suppress_count = 1;
5895 start_polling ();
5896#endif
5897}
5898
5899/* This type's only use is in syms_of_keyboard, to initialize the
5900 event header symbols and put properties on them. */
5901struct event_head {
5902 Lisp_Object *var;
5903 char *name;
5904 Lisp_Object *kind;
5905};
5906
5907struct event_head head_table[] = {
7b4aedb9 5908 &Qmouse_movement, "mouse-movement", &Qmouse_movement,
3c370943 5909 &Qscroll_bar_movement, "scroll-bar-movement", &Qmouse_movement,
7b4aedb9 5910 &Qswitch_frame, "switch-frame", &Qswitch_frame,
284f4730
JB
5911};
5912
5913syms_of_keyboard ()
5914{
2e894dab
RS
5915 Qdisabled_command_hook = intern ("disabled-command-hook");
5916 staticpro (&Qdisabled_command_hook);
5917
284f4730
JB
5918 Qself_insert_command = intern ("self-insert-command");
5919 staticpro (&Qself_insert_command);
5920
5921 Qforward_char = intern ("forward-char");
5922 staticpro (&Qforward_char);
5923
5924 Qbackward_char = intern ("backward-char");
5925 staticpro (&Qbackward_char);
5926
5927 Qdisabled = intern ("disabled");
5928 staticpro (&Qdisabled);
5929
e58aa385
RS
5930 Qundefined = intern ("undefined");
5931 staticpro (&Qundefined);
5932
86e5706b
RS
5933 Qpre_command_hook = intern ("pre-command-hook");
5934 staticpro (&Qpre_command_hook);
5935
5936 Qpost_command_hook = intern ("post-command-hook");
5937 staticpro (&Qpost_command_hook);
5938
40932d1a
RS
5939 Qcommand_hook_internal = intern ("command-hook-internal");
5940 staticpro (&Qcommand_hook_internal);
5941
284f4730
JB
5942 Qfunction_key = intern ("function-key");
5943 staticpro (&Qfunction_key);
13b5e56c 5944 Qmouse_click = intern ("mouse-click");
284f4730 5945 staticpro (&Qmouse_click);
284f4730 5946
598a9fa7
JB
5947 Qmenu_enable = intern ("menu-enable");
5948 staticpro (&Qmenu_enable);
5949
284f4730
JB
5950 Qmode_line = intern ("mode-line");
5951 staticpro (&Qmode_line);
e5d77022
JB
5952 Qvertical_line = intern ("vertical-line");
5953 staticpro (&Qvertical_line);
3c370943
JB
5954 Qvertical_scroll_bar = intern ("vertical-scroll-bar");
5955 staticpro (&Qvertical_scroll_bar);
5ec75a55
RS
5956 Qmenu_bar = intern ("menu-bar");
5957 staticpro (&Qmenu_bar);
4bb994d1
JB
5958
5959 Qabove_handle = intern ("above-handle");
5960 staticpro (&Qabove_handle);
5961 Qhandle = intern ("handle");
5962 staticpro (&Qhandle);
5963 Qbelow_handle = intern ("below-handle");
5964 staticpro (&Qbelow_handle);
284f4730 5965
cd21b839 5966 Qevent_kind = intern ("event-kind");
284f4730 5967 staticpro (&Qevent_kind);
88cb0656
JB
5968 Qevent_symbol_elements = intern ("event-symbol-elements");
5969 staticpro (&Qevent_symbol_elements);
0a7f1fc0
JB
5970 Qevent_symbol_element_mask = intern ("event-symbol-element-mask");
5971 staticpro (&Qevent_symbol_element_mask);
5972 Qmodifier_cache = intern ("modifier-cache");
5973 staticpro (&Qmodifier_cache);
284f4730 5974
48e416d4
RS
5975 Qrecompute_lucid_menubar = intern ("recompute-lucid-menubar");
5976 staticpro (&Qrecompute_lucid_menubar);
5977 Qactivate_menubar_hook = intern ("activate-menubar-hook");
5978 staticpro (&Qactivate_menubar_hook);
5979
f4eef8b4
RS
5980 Qpolling_period = intern ("polling-period");
5981 staticpro (&Qpolling_period);
5982
284f4730
JB
5983 {
5984 struct event_head *p;
5985
5986 for (p = head_table;
5987 p < head_table + (sizeof (head_table) / sizeof (head_table[0]));
5988 p++)
5989 {
5990 *p->var = intern (p->name);
5991 staticpro (p->var);
5992 Fput (*p->var, Qevent_kind, *p->kind);
88cb0656 5993 Fput (*p->var, Qevent_symbol_elements, Fcons (*p->var, Qnil));
284f4730
JB
5994 }
5995 }
5996
7b4aedb9
JB
5997 button_down_location = Fmake_vector (make_number (NUM_MOUSE_BUTTONS), Qnil);
5998 staticpro (&button_down_location);
88cb0656
JB
5999
6000 {
6001 int i;
6002 int len = sizeof (modifier_names) / sizeof (modifier_names[0]);
6003
6004 modifier_symbols = Fmake_vector (make_number (len), Qnil);
6005 for (i = 0; i < len; i++)
86e5706b
RS
6006 if (modifier_names[i])
6007 XVECTOR (modifier_symbols)->contents[i] = intern (modifier_names[i]);
88cb0656
JB
6008 staticpro (&modifier_symbols);
6009 }
6010
9deb415a
JB
6011 recent_keys = Fmake_vector (make_number (NUM_RECENT_KEYS), Qnil);
6012 staticpro (&recent_keys);
6013
6569cc8d 6014 this_command_keys = Fmake_vector (make_number (40), Qnil);
715d9345 6015 staticpro (&this_command_keys);
6569cc8d 6016
03b4122a
BF
6017 Qextended_command_history = intern ("extended-command-history");
6018 Fset (Qextended_command_history, Qnil);
6019 staticpro (&Qextended_command_history);
6020
7b4aedb9
JB
6021 kbd_buffer_frame_or_window
6022 = Fmake_vector (make_number (KBD_BUFFER_SIZE), Qnil);
6023 staticpro (&kbd_buffer_frame_or_window);
4bb994d1 6024
24597608
RS
6025 accent_key_syms = Qnil;
6026 staticpro (&accent_key_syms);
6027
284f4730
JB
6028 func_key_syms = Qnil;
6029 staticpro (&func_key_syms);
6030
4e0e7d8e
RS
6031 system_key_syms = Qnil;
6032 staticpro (&system_key_syms);
6033
284f4730
JB
6034 mouse_syms = Qnil;
6035 staticpro (&mouse_syms);
6036
cd21b839
JB
6037 unread_switch_frame = Qnil;
6038 staticpro (&unread_switch_frame);
6039
284f4730
JB
6040 defsubr (&Sread_key_sequence);
6041 defsubr (&Srecursive_edit);
6042 defsubr (&Strack_mouse);
284f4730
JB
6043 defsubr (&Sinput_pending_p);
6044 defsubr (&Scommand_execute);
6045 defsubr (&Srecent_keys);
6046 defsubr (&Sthis_command_keys);
6047 defsubr (&Ssuspend_emacs);
6048 defsubr (&Sabort_recursive_edit);
6049 defsubr (&Sexit_recursive_edit);
6050 defsubr (&Srecursion_depth);
6051 defsubr (&Stop_level);
6052 defsubr (&Sdiscard_input);
6053 defsubr (&Sopen_dribble_file);
6054 defsubr (&Sset_input_mode);
80645119 6055 defsubr (&Scurrent_input_mode);
284f4730
JB
6056 defsubr (&Sexecute_extended_command);
6057
284f4730 6058 DEFVAR_LISP ("last-command-char", &last_command_char,
86e5706b
RS
6059 "Last input event that was part of a command.");
6060
186cf719 6061 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char,
86e5706b 6062 "Last input event that was part of a command.");
284f4730 6063
7d6de002 6064 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event,
86e5706b 6065 "Last input event in a command, except for mouse menu events.\n\
7d6de002
RS
6066Mouse menus give back keys that don't look like mouse events;\n\
6067this variable holds the actual mouse event that led to the menu,\n\
6068so that you can determine whether the command was run by mouse or not.");
6069
284f4730 6070 DEFVAR_LISP ("last-input-char", &last_input_char,
86e5706b
RS
6071 "Last input event.");
6072
186cf719 6073 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char,
86e5706b 6074 "Last input event.");
284f4730 6075
24597608 6076 DEFVAR_LISP ("unread-command-events", &Vunread_command_events,
1c07d0a6 6077 "List of objects to be read as next command input events.");
284f4730 6078
86e5706b
RS
6079 DEFVAR_INT ("unread-command-char", &unread_command_char,
6080 "If not -1, an object to be read as next command input event.");
6081
284f4730
JB
6082 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char,
6083 "Meta-prefix character code. Meta-foo as command input\n\
6084turns into this character followed by foo.");
6085 XSET (meta_prefix_char, Lisp_Int, 033);
6086
6087 DEFVAR_LISP ("last-command", &last_command,
6088 "The last command executed. Normally a symbol with a function definition,\n\
6089but can be whatever was found in the keymap, or whatever the variable\n\
6090`this-command' was set to by that command.");
6091 last_command = Qnil;
6092
6093 DEFVAR_LISP ("this-command", &this_command,
6094 "The command now being executed.\n\
6095The command can set this variable; whatever is put here\n\
6096will be in `last-command' during the following command.");
6097 this_command = Qnil;
6098
6099 DEFVAR_INT ("auto-save-interval", &auto_save_interval,
6100 "*Number of keyboard input characters between auto-saves.\n\
6101Zero means disable autosaving due to number of characters typed.");
6102 auto_save_interval = 300;
6103
6104 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout,
6105 "*Number of seconds idle time before auto-save.\n\
06ef7355
RS
6106Zero or nil means disable auto-saving due to idleness.\n\
6107After auto-saving due to this many seconds of idle time,\n\
84447c71 6108Emacs also does a garbage collection if that seems to be warranted.");
284f4730
JB
6109 XFASTINT (Vauto_save_timeout) = 30;
6110
6111 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes,
6112 "*Nonzero means echo unfinished commands after this many seconds of pause.");
6113 echo_keystrokes = 1;
6114
6115 DEFVAR_INT ("polling-period", &polling_period,
6116 "*Interval between polling for input during Lisp execution.\n\
6117The reason for polling is to make C-g work to stop a running program.\n\
6118Polling is needed only when using X windows and SIGIO does not work.\n\
6119Polling is automatically disabled in all other cases.");
6120 polling_period = 2;
6121
564dc952 6122 DEFVAR_LISP ("double-click-time", &Vdouble_click_time,
fbcd35bd 6123 "*Maximum time between mouse clicks to make a double-click.\n\
564dc952
JB
6124Measured in milliseconds. nil means disable double-click recognition;\n\
6125t means double-clicks have no time limit and are detected\n\
fbcd35bd 6126by position only.");
aab06933 6127 Vdouble_click_time = make_number (500);
fbcd35bd 6128
284f4730
JB
6129 DEFVAR_INT ("num-input-keys", &num_input_keys,
6130 "*Number of complete keys read from the keyboard so far.");
6131 num_input_keys = 0;
6132
ff11dfa1 6133 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame,
fce33686
JB
6134 "*The frame in which the most recently read event occurred.\n\
6135If the last event came from a keyboard macro, this is set to `macro'.");
ff11dfa1 6136 Vlast_event_frame = Qnil;
284f4730 6137
7e85b935 6138 DEFVAR_LISP ("help-char", &Vhelp_char,
284f4730
JB
6139 "Character to recognize as meaning Help.\n\
6140When it is read, do `(eval help-form)', and display result if it's a string.\n\
6141If the value of `help-form' is nil, this char can be read normally.");
7e85b935 6142 XSET (Vhelp_char, Lisp_Int, Ctl ('H'));
284f4730
JB
6143
6144 DEFVAR_LISP ("help-form", &Vhelp_form,
7e85b935 6145 "Form to execute when character `help-char' is read.\n\
284f4730
JB
6146If the form returns a string, that string is displayed.\n\
6147If `help-form' is nil, the help char is not recognized.");
6148 Vhelp_form = Qnil;
6149
7e85b935
RS
6150 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command,
6151 "Command to run when `help-char' character follows a prefix key.\n\
6152This command is used only when there is no actual binding\n\
6153for that character after that prefix key.");
6154 Vprefix_help_command = Qnil;
6155
284f4730
JB
6156 DEFVAR_LISP ("top-level", &Vtop_level,
6157 "Form to evaluate when Emacs starts up.\n\
6158Useful to set before you dump a modified Emacs.");
6159 Vtop_level = Qnil;
6160
6161 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table,
6162 "String used as translate table for keyboard input, or nil.\n\
6163Each character is looked up in this string and the contents used instead.\n\
6164If string is of length N, character codes N and up are untranslated.");
6165 Vkeyboard_translate_table = Qnil;
6166
a612e298
RS
6167 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map,
6168 "Keymap of key translations that can override keymaps.\n\
6169This keymap works like `function-key-map', but comes after that,\n\
6170and applies even for keys that have ordinary bindings.");
6171 Vkey_translation_map = Qnil;
6172
8026024c
KH
6173 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend,
6174 "Non-nil means to always spawn a subshell instead of suspending,\n\
6175even if the operating system has support for stopping a process.");
6176 cannot_suspend = 0;
6177
284f4730 6178 DEFVAR_BOOL ("menu-prompting", &menu_prompting,
7d6de002 6179 "Non-nil means prompt with menus when appropriate.\n\
284f4730 6180This is done when reading from a keymap that has a prompt string,\n\
7d6de002
RS
6181for elements that have prompt strings.\n\
6182The menu is displayed on the screen\n\
6183if X menus were enabled at configuration\n\
6184time and the previous event was a mouse click prefix key.\n\
6185Otherwise, menu prompting uses the echo area.");
284f4730
JB
6186 menu_prompting = 1;
6187
6188 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char,
6189 "Character to see next line of menu prompt.\n\
6190Type this character while in a menu prompt to rotate around the lines of it.");
6191 XSET (menu_prompt_more_char, Lisp_Int, ' ');
9fa4395d
RS
6192
6193 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers,
6194 "A mask of additional modifier keys to use with every keyboard character.\n\
ad163903
JB
6195Emacs applies the modifiers of the character stored here to each keyboard\n\
6196character it reads. For example, after evaluating the expression\n\
80645119
JB
6197 (setq extra-keyboard-modifiers ?\C-x)\n\
6198all input characters will have the control modifier applied to them.\n\
6199\n\
6200Note that the character ?\C-@, equivalent to the integer zero, does\n\
6201not count as a control character; rather, it counts as a character\n\
27203ead 6202with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
80645119 6203cancels any modification.");
9fa4395d 6204 extra_keyboard_modifiers = 0;
86e5706b
RS
6205
6206 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark,
6207 "If an editing command sets this to t, deactivate the mark afterward.\n\
6208The command loop sets this to nil before each command,\n\
6209and tests the value when the command returns.\n\
6210Buffer modification stores t in this variable.");
6211 Vdeactivate_mark = Qnil;
6212
b0f2a7bf
KH
6213 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal,
6214 "Temporary storage of pre-command-hook or post-command-hook.");
6215 Vcommand_hook_internal = Qnil;
6216
86e5706b 6217 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook,
a1fd42c0
RS
6218 "Normal hook run before each command is executed.\n\
6219While the hook is run, its value is temporarily set to nil\n\
6220to avoid an unbreakable infinite loop if a hook function gets an error.\n\
6221As a result, a hook function cannot straightforwardly alter the value of\n\
6222`pre-command-hook'. See the Emacs Lisp manual for a way of\n\
6223implementing hook functions that alter the set of hook functions.");
86e5706b
RS
6224 Vpre_command_hook = Qnil;
6225
6226 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook,
a1fd42c0
RS
6227 "Normal hook run after each command is executed.\n\
6228While the hook is run, its value is temporarily set to nil\n\
6229to avoid an unbreakable infinite loop if a hook function gets an error.\n\
6230As a result, a hook function cannot straightforwardly alter the value of\n\
6231`post-command-hook'. See the Emacs Lisp manual for a way of\n\
6232implementing hook functions that alter the set of hook functions.");
86e5706b 6233 Vpost_command_hook = Qnil;
48e416d4
RS
6234
6235 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag,
6236 "t means menu bar, specified Lucid style, needs to be recomputed.");
6237 Vlucid_menu_bar_dirty_flag = Qnil;
a73c5e29 6238
9f9c0e27
RS
6239 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items,
6240 "List of menu bar items to move to the end of the menu bar.\n\
a612e298 6241The elements of the list are event types that may have menu bar bindings.");
9f9c0e27 6242 Vmenu_bar_final_items = Qnil;
e9bf89a0 6243
9dd3131c
RS
6244 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map,
6245 "Keymap that overrides all other local keymaps.\n\
6246If this variable is non-nil, it is used as a keymap instead of the\n\
6247buffer's local map, and the minor mode keymaps and text property keymaps.");
6248 Voverriding_local_map = Qnil;
6249
e9bf89a0
RS
6250 DEFVAR_BOOL ("track-mouse", &do_mouse_tracking,
6251 "*Non-nil means generate motion events for mouse motion.");
80e4aa30 6252
270a208f
RS
6253 DEFVAR_LISP ("system-key-alist", &Vsystem_key_alist,
6254 "Alist of system-specific X windows key symbols.\n\
80e4aa30 6255Each element should have the form (N . SYMBOL) where N is the\n\
270a208f 6256numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
80e4aa30 6257and SYMBOL is its name.");
a69a8ca2 6258 Vsystem_key_alist = Qnil;
8a792f3a
RS
6259
6260 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list,
6261 "List of deferred actions to be performed at a later time.\n\
6262The precise format isn't relevant here; we just check whether it is nil.");
6263 Vdeferred_action_list = Qnil;
6264
6265 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function,
6266 "Function to call to handle deferred actions, after each command.\n\
6267This function is called with no arguments after each command\n\
6268whenever `deferred-action-list' is non-nil.");
6269 Vdeferred_action_function = Qnil;
284f4730
JB
6270}
6271
6272keys_of_keyboard ()
6273{
6274 initial_define_key (global_map, Ctl ('Z'), "suspend-emacs");
6275 initial_define_key (control_x_map, Ctl ('Z'), "suspend-emacs");
6276 initial_define_key (meta_map, Ctl ('C'), "exit-recursive-edit");
6277 initial_define_key (global_map, Ctl (']'), "abort-recursive-edit");
6278 initial_define_key (meta_map, 'x', "execute-extended-command");
6279}