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