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