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