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