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