Merge from trunk
[emacs.git] / src / keyboard.c
blobd307250b8683b4f3fa4ffb1102ff28cdffff1fdf
1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 #include <config.h>
21 #include <signal.h>
22 #include <stdio.h>
23 #include <setjmp.h>
24 #include "lisp.h"
25 #include "termchar.h"
26 #include "termopts.h"
27 #include "frame.h"
28 #include "termhooks.h"
29 #include "macros.h"
30 #include "keyboard.h"
31 #include "window.h"
32 #include "commands.h"
33 #include "buffer.h"
34 #include "character.h"
35 #include "disptab.h"
36 #include "dispextern.h"
37 #include "syntax.h"
38 #include "intervals.h"
39 #include "keymap.h"
40 #include "blockinput.h"
41 #include "puresize.h"
42 #include "systime.h"
43 #include "atimer.h"
44 #include "process.h"
45 #include <errno.h>
47 #ifdef HAVE_GTK_AND_PTHREAD
48 #include <pthread.h>
49 #endif
50 #ifdef MSDOS
51 #include "msdos.h"
52 #include <time.h>
53 #else /* not MSDOS */
54 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
59 #include <sys/types.h>
60 #include <unistd.h>
61 #include <fcntl.h>
63 /* This is to get the definitions of the XK_ symbols. */
64 #ifdef HAVE_X_WINDOWS
65 #include "xterm.h"
66 #endif
68 #ifdef HAVE_NTGUI
69 #include "w32term.h"
70 #endif /* HAVE_NTGUI */
72 #ifdef HAVE_NS
73 #include "nsterm.h"
74 #endif
76 /* Variables for blockinput.h: */
78 /* Non-zero if interrupt input is blocked right now. */
79 volatile int interrupt_input_blocked;
81 /* Nonzero means an input interrupt has arrived
82 during the current critical section. */
83 int interrupt_input_pending;
85 /* This var should be (interrupt_input_pending || pending_atimers).
86 The QUIT macro checks this instead of interrupt_input_pending and
87 pending_atimers separately, to reduce code size. So, any code that
88 changes interrupt_input_pending or pending_atimers should update
89 this too. */
90 #ifdef SYNC_INPUT
91 int pending_signals;
92 #endif
94 #define KBD_BUFFER_SIZE 4096
96 KBOARD *initial_kboard;
97 KBOARD *current_kboard;
98 KBOARD *all_kboards;
99 int single_kboard;
101 /* Non-nil disable property on a command means
102 do not execute it; call disabled-command-function's value instead. */
103 Lisp_Object Qdisabled, Qdisabled_command_function;
105 #define NUM_RECENT_KEYS (300)
106 int recent_keys_index; /* Index for storing next element into recent_keys */
107 int total_keys; /* Total number of elements stored into recent_keys */
108 Lisp_Object recent_keys; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
110 /* Vector holding the key sequence that invoked the current command.
111 It is reused for each command, and it may be longer than the current
112 sequence; this_command_key_count indicates how many elements
113 actually mean something.
114 It's easier to staticpro a single Lisp_Object than an array. */
115 Lisp_Object this_command_keys;
116 int this_command_key_count;
118 /* 1 after calling Freset_this_command_lengths.
119 Usually it is 0. */
120 int this_command_key_count_reset;
122 /* This vector is used as a buffer to record the events that were actually read
123 by read_key_sequence. */
124 Lisp_Object raw_keybuf;
125 int raw_keybuf_count;
127 #define GROW_RAW_KEYBUF \
128 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
129 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
131 /* Number of elements of this_command_keys
132 that precede this key sequence. */
133 int this_single_command_key_start;
135 /* Record values of this_command_key_count and echo_length ()
136 before this command was read. */
137 static int before_command_key_count;
138 static int before_command_echo_length;
140 /* For longjmp to where kbd input is being done. */
142 static jmp_buf getcjmp;
144 /* True while doing kbd input. */
145 int waiting_for_input;
147 /* True while displaying for echoing. Delays C-g throwing. */
149 int echoing;
151 /* Non-null means we can start echoing at the next input pause even
152 though there is something in the echo area. */
154 static struct kboard *ok_to_echo_at_next_pause;
156 /* The kboard last echoing, or null for none. Reset to 0 in
157 cancel_echoing. If non-null, and a current echo area message
158 exists, and echo_message_buffer is eq to the current message
159 buffer, we know that the message comes from echo_kboard. */
161 struct kboard *echo_kboard;
163 /* The buffer used for echoing. Set in echo_now, reset in
164 cancel_echoing. */
166 Lisp_Object echo_message_buffer;
168 /* Nonzero means C-g should cause immediate error-signal. */
169 int immediate_quit;
171 /* Character that causes a quit. Normally C-g.
173 If we are running on an ordinary terminal, this must be an ordinary
174 ASCII char, since we want to make it our interrupt character.
176 If we are not running on an ordinary terminal, it still needs to be
177 an ordinary ASCII char. This character needs to be recognized in
178 the input interrupt handler. At this point, the keystroke is
179 represented as a struct input_event, while the desired quit
180 character is specified as a lispy event. The mapping from struct
181 input_events to lispy events cannot run in an interrupt handler,
182 and the reverse mapping is difficult for anything but ASCII
183 keystrokes.
185 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
186 ASCII character. */
187 int quit_char;
189 /* Current depth in recursive edits. */
190 int command_loop_level;
192 /* If not Qnil, this is a switch-frame event which we decided to put
193 off until the end of a key sequence. This should be read as the
194 next command input, after any unread_command_events.
196 read_key_sequence uses this to delay switch-frame events until the
197 end of the key sequence; Fread_char uses it to put off switch-frame
198 events until a non-ASCII event is acceptable as input. */
199 Lisp_Object unread_switch_frame;
201 /* Last size recorded for a current buffer which is not a minibuffer. */
202 static EMACS_INT last_non_minibuf_size;
204 /* Total number of times read_char has returned, modulo SIZE_MAX + 1. */
205 size_t num_input_events;
207 /* Value of num_nonmacro_input_events as of last auto save. */
209 int last_auto_save;
211 /* This is like Vthis_command, except that commands never set it. */
212 Lisp_Object real_this_command;
214 /* The value of point when the last command was started. */
215 EMACS_INT last_point_position;
217 /* The buffer that was current when the last command was started. */
218 Lisp_Object last_point_position_buffer;
220 /* The window that was selected when the last command was started. */
221 Lisp_Object last_point_position_window;
223 /* The frame in which the last input event occurred, or Qmacro if the
224 last event came from a macro. We use this to determine when to
225 generate switch-frame events. This may be cleared by functions
226 like Fselect_frame, to make sure that a switch-frame event is
227 generated by the next character. */
228 Lisp_Object internal_last_event_frame;
230 /* The timestamp of the last input event we received from the X server.
231 X Windows wants this for selection ownership. */
232 unsigned long last_event_timestamp;
234 Lisp_Object Qx_set_selection, QPRIMARY, Qhandle_switch_frame;
236 Lisp_Object Qself_insert_command;
237 Lisp_Object Qforward_char;
238 Lisp_Object Qbackward_char;
239 Lisp_Object Qundefined;
240 Lisp_Object Qtimer_event_handler;
242 /* read_key_sequence stores here the command definition of the
243 key sequence that it reads. */
244 Lisp_Object read_key_sequence_cmd;
246 Lisp_Object Qinput_method_function;
248 Lisp_Object Qdeactivate_mark;
250 Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;
252 Lisp_Object Qecho_area_clear_hook;
254 /* Hooks to run before and after each command. */
255 Lisp_Object Qpre_command_hook;
256 Lisp_Object Qpost_command_hook;
258 Lisp_Object Qdeferred_action_function;
260 Lisp_Object Qinput_method_exit_on_first_char;
261 Lisp_Object Qinput_method_use_echo_area;
263 /* File in which we write all commands we read. */
264 FILE *dribble;
266 /* Nonzero if input is available. */
267 int input_pending;
269 /* Circular buffer for pre-read keyboard input. */
271 static struct input_event kbd_buffer[KBD_BUFFER_SIZE];
273 /* Pointer to next available character in kbd_buffer.
274 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
275 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
276 next available char is in kbd_buffer[0]. */
277 static struct input_event *kbd_fetch_ptr;
279 /* Pointer to next place to store character in kbd_buffer. This
280 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
281 character should go in kbd_buffer[0]. */
282 static struct input_event * volatile kbd_store_ptr;
284 /* The above pair of variables forms a "queue empty" flag. When we
285 enqueue a non-hook event, we increment kbd_store_ptr. When we
286 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
287 there is input available if the two pointers are not equal.
289 Why not just have a flag set and cleared by the enqueuing and
290 dequeuing functions? Such a flag could be screwed up by interrupts
291 at inopportune times. */
293 /* Symbols to head events. */
294 Lisp_Object Qmouse_movement;
295 Lisp_Object Qscroll_bar_movement;
296 Lisp_Object Qswitch_frame;
297 Lisp_Object Qdelete_frame;
298 Lisp_Object Qiconify_frame;
299 Lisp_Object Qmake_frame_visible;
300 Lisp_Object Qselect_window;
301 Lisp_Object Qhelp_echo;
303 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
304 Lisp_Object Qmouse_fixup_help_message;
305 #endif
307 /* Symbols to denote kinds of events. */
308 Lisp_Object Qfunction_key;
309 Lisp_Object Qmouse_click;
310 #if defined (WINDOWSNT)
311 Lisp_Object Qlanguage_change;
312 #endif
313 Lisp_Object Qdrag_n_drop;
314 Lisp_Object Qsave_session;
315 #ifdef HAVE_DBUS
316 Lisp_Object Qdbus_event;
317 #endif
318 Lisp_Object Qconfig_changed_event;
320 /* Lisp_Object Qmouse_movement; - also an event header */
322 /* Properties of event headers. */
323 Lisp_Object Qevent_kind;
324 Lisp_Object Qevent_symbol_elements;
326 /* menu and tool bar item parts */
327 Lisp_Object Qmenu_enable;
328 Lisp_Object QCenable, QCvisible, QChelp, QCfilter, QCkeys, QCkey_sequence;
329 Lisp_Object QCbutton, QCtoggle, QCradio, QClabel, QCvert_only;
331 /* An event header symbol HEAD may have a property named
332 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
333 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
334 mask of modifiers applied to it. If present, this is used to help
335 speed up parse_modifiers. */
336 Lisp_Object Qevent_symbol_element_mask;
338 /* An unmodified event header BASE may have a property named
339 Qmodifier_cache, which is an alist mapping modifier masks onto
340 modified versions of BASE. If present, this helps speed up
341 apply_modifiers. */
342 Lisp_Object Qmodifier_cache;
344 /* Symbols to use for parts of windows. */
345 Lisp_Object Qmode_line;
346 Lisp_Object Qvertical_line;
347 Lisp_Object Qvertical_scroll_bar;
348 Lisp_Object Qmenu_bar;
350 Lisp_Object recursive_edit_unwind (Lisp_Object buffer), command_loop (void);
351 Lisp_Object Fthis_command_keys (void);
352 Lisp_Object Qextended_command_history;
353 EMACS_TIME timer_check (void);
355 static void record_menu_key (Lisp_Object c);
356 static int echo_length (void);
358 Lisp_Object Qpolling_period;
360 /* Incremented whenever a timer is run. */
361 int timers_run;
363 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
364 happens. */
365 EMACS_TIME *input_available_clear_time;
367 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
368 Default is 1 if INTERRUPT_INPUT is defined. */
369 int interrupt_input;
371 /* Nonzero while interrupts are temporarily deferred during redisplay. */
372 int interrupts_deferred;
374 /* Allow m- file to inhibit use of FIONREAD. */
375 #ifdef BROKEN_FIONREAD
376 #undef FIONREAD
377 #endif
379 /* We are unable to use interrupts if FIONREAD is not available,
380 so flush SIGIO so we won't try. */
381 #if !defined (FIONREAD)
382 #ifdef SIGIO
383 #undef SIGIO
384 #endif
385 #endif
387 /* If we support a window system, turn on the code to poll periodically
388 to detect C-g. It isn't actually used when doing interrupt input. */
389 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
390 #define POLL_FOR_INPUT
391 #endif
393 /* The time when Emacs started being idle. */
395 static EMACS_TIME timer_idleness_start_time;
397 /* After Emacs stops being idle, this saves the last value
398 of timer_idleness_start_time from when it was idle. */
400 static EMACS_TIME timer_last_idleness_start_time;
403 /* Global variable declarations. */
405 /* Flags for readable_events. */
406 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
407 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
408 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
410 /* Function for init_keyboard to call with no args (if nonzero). */
411 void (*keyboard_init_hook) (void);
413 static int read_avail_input (int);
414 static void get_input_pending (int *, int);
415 static int readable_events (int);
416 static Lisp_Object read_char_x_menu_prompt (int, Lisp_Object *,
417 Lisp_Object, int *);
418 static Lisp_Object read_char_minibuf_menu_prompt (int, int,
419 Lisp_Object *);
420 static Lisp_Object make_lispy_event (struct input_event *);
421 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
422 static Lisp_Object make_lispy_movement (struct frame *, Lisp_Object,
423 enum scroll_bar_part,
424 Lisp_Object, Lisp_Object,
425 unsigned long);
426 #endif
427 static Lisp_Object modify_event_symbol (EMACS_INT, unsigned, Lisp_Object,
428 Lisp_Object, const char *const *,
429 Lisp_Object *, unsigned);
430 static Lisp_Object make_lispy_switch_frame (Lisp_Object);
431 static void save_getcjmp (jmp_buf);
432 static void restore_getcjmp (jmp_buf);
433 static Lisp_Object apply_modifiers (int, Lisp_Object);
434 static void clear_event (struct input_event *);
435 static Lisp_Object restore_kboard_configuration (Lisp_Object);
436 static void interrupt_signal (int signalnum);
437 #ifdef SIGIO
438 static void input_available_signal (int signo);
439 #endif
440 static void handle_interrupt (void);
441 static void timer_start_idle (void);
442 static void timer_stop_idle (void);
443 static void timer_resume_idle (void);
444 static void handle_user_signal (int);
445 static char *find_user_signal_name (int);
446 static int store_user_signal_events (void);
449 /* Add C to the echo string, if echoing is going on.
450 C can be a character, which is printed prettily ("M-C-x" and all that
451 jazz), or a symbol, whose name is printed. */
453 static void
454 echo_char (Lisp_Object c)
456 if (current_kboard->immediate_echo)
458 int size = KEY_DESCRIPTION_SIZE + 100;
459 char *buffer = (char *) alloca (size);
460 char *ptr = buffer;
461 Lisp_Object echo_string;
463 echo_string = KVAR (current_kboard, echo_string);
465 /* If someone has passed us a composite event, use its head symbol. */
466 c = EVENT_HEAD (c);
468 if (INTEGERP (c))
470 ptr = push_key_description (XINT (c), ptr, 1);
472 else if (SYMBOLP (c))
474 Lisp_Object name = SYMBOL_NAME (c);
475 int nbytes = SBYTES (name);
477 if (size - (ptr - buffer) < nbytes)
479 int offset = ptr - buffer;
480 size = max (2 * size, size + nbytes);
481 buffer = (char *) alloca (size);
482 ptr = buffer + offset;
485 ptr += copy_text (SDATA (name), (unsigned char *) ptr, nbytes,
486 STRING_MULTIBYTE (name), 1);
489 if ((NILP (echo_string) || SCHARS (echo_string) == 0)
490 && help_char_p (c))
492 const char *text = " (Type ? for further options)";
493 int len = strlen (text);
495 if (size - (ptr - buffer) < len)
497 int offset = ptr - buffer;
498 size += len;
499 buffer = (char *) alloca (size);
500 ptr = buffer + offset;
503 memcpy (ptr, text, len);
504 ptr += len;
507 /* Replace a dash from echo_dash with a space, otherwise
508 add a space at the end as a separator between keys. */
509 if (STRINGP (echo_string)
510 && SCHARS (echo_string) > 1)
512 Lisp_Object last_char, prev_char, idx;
514 idx = make_number (SCHARS (echo_string) - 2);
515 prev_char = Faref (echo_string, idx);
517 idx = make_number (SCHARS (echo_string) - 1);
518 last_char = Faref (echo_string, idx);
520 /* We test PREV_CHAR to make sure this isn't the echoing
521 of a minus-sign. */
522 if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
523 Faset (echo_string, idx, make_number (' '));
524 else
525 echo_string = concat2 (echo_string, build_string (" "));
527 else if (STRINGP (echo_string))
528 echo_string = concat2 (echo_string, build_string (" "));
530 KVAR (current_kboard, echo_string)
531 = concat2 (echo_string, make_string (buffer, ptr - buffer));
533 echo_now ();
537 /* Temporarily add a dash to the end of the echo string if it's not
538 empty, so that it serves as a mini-prompt for the very next character. */
540 static void
541 echo_dash (void)
543 /* Do nothing if not echoing at all. */
544 if (NILP (KVAR (current_kboard, echo_string)))
545 return;
547 if (this_command_key_count == 0)
548 return;
550 if (!current_kboard->immediate_echo
551 && SCHARS (KVAR (current_kboard, echo_string)) == 0)
552 return;
554 /* Do nothing if we just printed a prompt. */
555 if (current_kboard->echo_after_prompt
556 == SCHARS (KVAR (current_kboard, echo_string)))
557 return;
559 /* Do nothing if we have already put a dash at the end. */
560 if (SCHARS (KVAR (current_kboard, echo_string)) > 1)
562 Lisp_Object last_char, prev_char, idx;
564 idx = make_number (SCHARS (KVAR (current_kboard, echo_string)) - 2);
565 prev_char = Faref (KVAR (current_kboard, echo_string), idx);
567 idx = make_number (SCHARS (KVAR (current_kboard, echo_string)) - 1);
568 last_char = Faref (KVAR (current_kboard, echo_string), idx);
570 if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
571 return;
574 /* Put a dash at the end of the buffer temporarily,
575 but make it go away when the next character is added. */
576 KVAR (current_kboard, echo_string) = concat2 (KVAR (current_kboard, echo_string),
577 build_string ("-"));
578 echo_now ();
581 /* Display the current echo string, and begin echoing if not already
582 doing so. */
584 void
585 echo_now (void)
587 if (!current_kboard->immediate_echo)
589 int i;
590 current_kboard->immediate_echo = 1;
592 for (i = 0; i < this_command_key_count; i++)
594 Lisp_Object c;
596 /* Set before_command_echo_length to the value that would
597 have been saved before the start of this subcommand in
598 command_loop_1, if we had already been echoing then. */
599 if (i == this_single_command_key_start)
600 before_command_echo_length = echo_length ();
602 c = XVECTOR (this_command_keys)->contents[i];
603 if (! (EVENT_HAS_PARAMETERS (c)
604 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
605 echo_char (c);
608 /* Set before_command_echo_length to the value that would
609 have been saved before the start of this subcommand in
610 command_loop_1, if we had already been echoing then. */
611 if (this_command_key_count == this_single_command_key_start)
612 before_command_echo_length = echo_length ();
614 /* Put a dash at the end to invite the user to type more. */
615 echo_dash ();
618 echoing = 1;
619 message3_nolog (KVAR (current_kboard, echo_string),
620 SBYTES (KVAR (current_kboard, echo_string)),
621 STRING_MULTIBYTE (KVAR (current_kboard, echo_string)));
622 echoing = 0;
624 /* Record in what buffer we echoed, and from which kboard. */
625 echo_message_buffer = echo_area_buffer[0];
626 echo_kboard = current_kboard;
628 if (waiting_for_input && !NILP (Vquit_flag))
629 quit_throw_to_read_char ();
632 /* Turn off echoing, for the start of a new command. */
634 void
635 cancel_echoing (void)
637 current_kboard->immediate_echo = 0;
638 current_kboard->echo_after_prompt = -1;
639 KVAR (current_kboard, echo_string) = Qnil;
640 ok_to_echo_at_next_pause = NULL;
641 echo_kboard = NULL;
642 echo_message_buffer = Qnil;
645 /* Return the length of the current echo string. */
647 static int
648 echo_length (void)
650 return (STRINGP (KVAR (current_kboard, echo_string))
651 ? SCHARS (KVAR (current_kboard, echo_string))
652 : 0);
655 /* Truncate the current echo message to its first LEN chars.
656 This and echo_char get used by read_key_sequence when the user
657 switches frames while entering a key sequence. */
659 static void
660 echo_truncate (EMACS_INT nchars)
662 if (STRINGP (KVAR (current_kboard, echo_string)))
663 KVAR (current_kboard, echo_string)
664 = Fsubstring (KVAR (current_kboard, echo_string),
665 make_number (0), make_number (nchars));
666 truncate_echo_area (nchars);
670 /* Functions for manipulating this_command_keys. */
671 static void
672 add_command_key (Lisp_Object key)
674 #if 0 /* Not needed after we made Freset_this_command_lengths
675 do the job immediately. */
676 /* If reset-this-command-length was called recently, obey it now.
677 See the doc string of that function for an explanation of why. */
678 if (before_command_restore_flag)
680 this_command_key_count = before_command_key_count_1;
681 if (this_command_key_count < this_single_command_key_start)
682 this_single_command_key_start = this_command_key_count;
683 echo_truncate (before_command_echo_length_1);
684 before_command_restore_flag = 0;
686 #endif
688 if (this_command_key_count >= ASIZE (this_command_keys))
689 this_command_keys = larger_vector (this_command_keys,
690 2 * ASIZE (this_command_keys),
691 Qnil);
693 ASET (this_command_keys, this_command_key_count, key);
694 ++this_command_key_count;
698 Lisp_Object
699 recursive_edit_1 (void)
701 int count = SPECPDL_INDEX ();
702 Lisp_Object val;
704 if (command_loop_level > 0)
706 specbind (Qstandard_output, Qt);
707 specbind (Qstandard_input, Qt);
710 #ifdef HAVE_WINDOW_SYSTEM
711 /* The command loop has started an hourglass timer, so we have to
712 cancel it here, otherwise it will fire because the recursive edit
713 can take some time. Do not check for display_hourglass_p here,
714 because it could already be nil. */
715 cancel_hourglass ();
716 #endif
718 /* This function may have been called from a debugger called from
719 within redisplay, for instance by Edebugging a function called
720 from fontification-functions. We want to allow redisplay in
721 the debugging session.
723 The recursive edit is left with a `(throw exit ...)'. The `exit'
724 tag is not caught anywhere in redisplay, i.e. when we leave the
725 recursive edit, the original redisplay leading to the recursive
726 edit will be unwound. The outcome should therefore be safe. */
727 specbind (Qinhibit_redisplay, Qnil);
728 redisplaying_p = 0;
730 val = command_loop ();
731 if (EQ (val, Qt))
732 Fsignal (Qquit, Qnil);
733 /* Handle throw from read_minibuf when using minibuffer
734 while it's active but we're in another window. */
735 if (STRINGP (val))
736 xsignal1 (Qerror, val);
738 return unbind_to (count, Qnil);
741 /* When an auto-save happens, record the "time", and don't do again soon. */
743 void
744 record_auto_save (void)
746 last_auto_save = num_nonmacro_input_events;
749 /* Make an auto save happen as soon as possible at command level. */
751 void
752 force_auto_save_soon (void)
754 last_auto_save = - auto_save_interval - 1;
756 record_asynch_buffer_change ();
759 DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
760 doc: /* Invoke the editor command loop recursively.
761 To get out of the recursive edit, a command can do `(throw 'exit nil)';
762 that tells this function to return.
763 Alternatively, `(throw 'exit t)' makes this function signal an error.
764 This function is called by the editor initialization to begin editing. */)
765 (void)
767 int count = SPECPDL_INDEX ();
768 Lisp_Object buffer;
770 /* If we enter while input is blocked, don't lock up here.
771 This may happen through the debugger during redisplay. */
772 if (INPUT_BLOCKED_P)
773 return Qnil;
775 command_loop_level++;
776 update_mode_lines = 1;
778 if (command_loop_level
779 && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
780 buffer = Fcurrent_buffer ();
781 else
782 buffer = Qnil;
784 /* If we leave recursive_edit_1 below with a `throw' for instance,
785 like it is done in the splash screen display, we have to
786 make sure that we restore single_kboard as command_loop_1
787 would have done if it were left normally. */
788 if (command_loop_level > 0)
789 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
790 record_unwind_protect (recursive_edit_unwind, buffer);
792 recursive_edit_1 ();
793 return unbind_to (count, Qnil);
796 Lisp_Object
797 recursive_edit_unwind (Lisp_Object buffer)
799 if (BUFFERP (buffer))
800 Fset_buffer (buffer);
802 command_loop_level--;
803 update_mode_lines = 1;
804 return Qnil;
808 #if 0 /* These two functions are now replaced with
809 temporarily_switch_to_single_kboard. */
810 static void
811 any_kboard_state ()
813 #if 0 /* Theory: if there's anything in Vunread_command_events,
814 it will right away be read by read_key_sequence,
815 and then if we do switch KBOARDS, it will go into the side
816 queue then. So we don't need to do anything special here -- rms. */
817 if (CONSP (Vunread_command_events))
819 current_kboard->kbd_queue
820 = nconc2 (Vunread_command_events, current_kboard->kbd_queue);
821 current_kboard->kbd_queue_has_data = 1;
823 Vunread_command_events = Qnil;
824 #endif
825 single_kboard = 0;
828 /* Switch to the single-kboard state, making current_kboard
829 the only KBOARD from which further input is accepted. */
831 void
832 single_kboard_state ()
834 single_kboard = 1;
836 #endif
838 /* If we're in single_kboard state for kboard KBOARD,
839 get out of it. */
841 void
842 not_single_kboard_state (KBOARD *kboard)
844 if (kboard == current_kboard)
845 single_kboard = 0;
848 /* Maintain a stack of kboards, so other parts of Emacs
849 can switch temporarily to the kboard of a given frame
850 and then revert to the previous status. */
852 struct kboard_stack
854 KBOARD *kboard;
855 struct kboard_stack *next;
858 static struct kboard_stack *kboard_stack;
860 void
861 push_kboard (struct kboard *k)
863 struct kboard_stack *p
864 = (struct kboard_stack *) xmalloc (sizeof (struct kboard_stack));
866 p->next = kboard_stack;
867 p->kboard = current_kboard;
868 kboard_stack = p;
870 current_kboard = k;
873 void
874 pop_kboard (void)
876 struct terminal *t;
877 struct kboard_stack *p = kboard_stack;
878 int found = 0;
879 for (t = terminal_list; t; t = t->next_terminal)
881 if (t->kboard == p->kboard)
883 current_kboard = p->kboard;
884 found = 1;
885 break;
888 if (!found)
890 /* The terminal we remembered has been deleted. */
891 current_kboard = FRAME_KBOARD (SELECTED_FRAME ());
892 single_kboard = 0;
894 kboard_stack = p->next;
895 xfree (p);
898 /* Switch to single_kboard mode, making current_kboard the only KBOARD
899 from which further input is accepted. If F is non-nil, set its
900 KBOARD as the current keyboard.
902 This function uses record_unwind_protect to return to the previous
903 state later.
905 If Emacs is already in single_kboard mode, and F's keyboard is
906 locked, then this function will throw an errow. */
908 void
909 temporarily_switch_to_single_kboard (struct frame *f)
911 int was_locked = single_kboard;
912 if (was_locked)
914 if (f != NULL && FRAME_KBOARD (f) != current_kboard)
915 /* We can not switch keyboards while in single_kboard mode.
916 In rare cases, Lisp code may call `recursive-edit' (or
917 `read-minibuffer' or `y-or-n-p') after it switched to a
918 locked frame. For example, this is likely to happen
919 when server.el connects to a new terminal while Emacs is in
920 single_kboard mode. It is best to throw an error instead
921 of presenting the user with a frozen screen. */
922 error ("Terminal %d is locked, cannot read from it",
923 FRAME_TERMINAL (f)->id);
924 else
925 /* This call is unnecessary, but helps
926 `restore_kboard_configuration' discover if somebody changed
927 `current_kboard' behind our back. */
928 push_kboard (current_kboard);
930 else if (f != NULL)
931 current_kboard = FRAME_KBOARD (f);
932 single_kboard = 1;
933 record_unwind_protect (restore_kboard_configuration,
934 (was_locked ? Qt : Qnil));
937 #if 0 /* This function is not needed anymore. */
938 void
939 record_single_kboard_state ()
941 if (single_kboard)
942 push_kboard (current_kboard);
943 record_unwind_protect (restore_kboard_configuration,
944 (single_kboard ? Qt : Qnil));
946 #endif
948 static Lisp_Object
949 restore_kboard_configuration (Lisp_Object was_locked)
951 if (NILP (was_locked))
952 single_kboard = 0;
953 else
955 struct kboard *prev = current_kboard;
956 single_kboard = 1;
957 pop_kboard ();
958 /* The pop should not change the kboard. */
959 if (single_kboard && current_kboard != prev)
960 abort ();
962 return Qnil;
966 /* Handle errors that are not handled at inner levels
967 by printing an error message and returning to the editor command loop. */
969 static Lisp_Object
970 cmd_error (Lisp_Object data)
972 Lisp_Object old_level, old_length;
973 char macroerror[50];
975 #ifdef HAVE_WINDOW_SYSTEM
976 if (display_hourglass_p)
977 cancel_hourglass ();
978 #endif
980 if (!NILP (executing_kbd_macro))
982 if (executing_kbd_macro_iterations == 1)
983 sprintf (macroerror, "After 1 kbd macro iteration: ");
984 else
985 sprintf (macroerror, "After %d kbd macro iterations: ",
986 executing_kbd_macro_iterations);
988 else
989 *macroerror = 0;
991 Vstandard_output = Qt;
992 Vstandard_input = Qt;
993 Vexecuting_kbd_macro = Qnil;
994 executing_kbd_macro = Qnil;
995 KVAR (current_kboard, Vprefix_arg) = Qnil;
996 KVAR (current_kboard, Vlast_prefix_arg) = Qnil;
997 cancel_echoing ();
999 /* Avoid unquittable loop if data contains a circular list. */
1000 old_level = Vprint_level;
1001 old_length = Vprint_length;
1002 XSETFASTINT (Vprint_level, 10);
1003 XSETFASTINT (Vprint_length, 10);
1004 cmd_error_internal (data, macroerror);
1005 Vprint_level = old_level;
1006 Vprint_length = old_length;
1008 Vquit_flag = Qnil;
1010 Vinhibit_quit = Qnil;
1011 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1012 if (command_loop_level == 0 && minibuf_level == 0)
1013 any_kboard_state ();
1014 #endif
1016 return make_number (0);
1019 /* Take actions on handling an error. DATA is the data that describes
1020 the error.
1022 CONTEXT is a C-string containing ASCII characters only which
1023 describes the context in which the error happened. If we need to
1024 generalize CONTEXT to allow multibyte characters, make it a Lisp
1025 string. */
1027 void
1028 cmd_error_internal (Lisp_Object data, const char *context)
1030 struct frame *sf = SELECTED_FRAME ();
1032 /* The immediate context is not interesting for Quits,
1033 since they are asyncronous. */
1034 if (EQ (XCAR (data), Qquit))
1035 Vsignaling_function = Qnil;
1037 Vquit_flag = Qnil;
1038 Vinhibit_quit = Qt;
1040 /* Use user's specified output function if any. */
1041 if (!NILP (Vcommand_error_function))
1042 call3 (Vcommand_error_function, data,
1043 context ? build_string (context) : empty_unibyte_string,
1044 Vsignaling_function);
1045 /* If the window system or terminal frame hasn't been initialized
1046 yet, or we're not interactive, write the message to stderr and exit. */
1047 else if (!sf->glyphs_initialized_p
1048 /* The initial frame is a special non-displaying frame. It
1049 will be current in daemon mode when there are no frames
1050 to display, and in non-daemon mode before the real frame
1051 has finished initializing. If an error is thrown in the
1052 latter case while creating the frame, then the frame
1053 will never be displayed, so the safest thing to do is
1054 write to stderr and quit. In daemon mode, there are
1055 many other potential errors that do not prevent frames
1056 from being created, so continuing as normal is better in
1057 that case. */
1058 || (!IS_DAEMON && FRAME_INITIAL_P (sf))
1059 || noninteractive)
1061 print_error_message (data, Qexternal_debugging_output,
1062 context, Vsignaling_function);
1063 Fterpri (Qexternal_debugging_output);
1064 Fkill_emacs (make_number (-1));
1066 else
1068 clear_message (1, 0);
1069 Fdiscard_input ();
1070 message_log_maybe_newline ();
1071 bitch_at_user ();
1073 print_error_message (data, Qt, context, Vsignaling_function);
1076 Vsignaling_function = Qnil;
1079 Lisp_Object command_loop_1 (void);
1080 Lisp_Object command_loop_2 (Lisp_Object);
1081 Lisp_Object top_level_1 (Lisp_Object);
1083 /* Entry to editor-command-loop.
1084 This level has the catches for exiting/returning to editor command loop.
1085 It returns nil to exit recursive edit, t to abort it. */
1087 Lisp_Object
1088 command_loop (void)
1090 if (command_loop_level > 0 || minibuf_level > 0)
1092 Lisp_Object val;
1093 val = internal_catch (Qexit, command_loop_2, Qnil);
1094 executing_kbd_macro = Qnil;
1095 return val;
1097 else
1098 while (1)
1100 internal_catch (Qtop_level, top_level_1, Qnil);
1101 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1102 /* Reset single_kboard in case top-level set it while
1103 evaluating an -f option, or we are stuck there for some
1104 other reason. */
1105 any_kboard_state ();
1106 #endif
1107 internal_catch (Qtop_level, command_loop_2, Qnil);
1108 executing_kbd_macro = Qnil;
1110 /* End of file in -batch run causes exit here. */
1111 if (noninteractive)
1112 Fkill_emacs (Qt);
1116 /* Here we catch errors in execution of commands within the
1117 editing loop, and reenter the editing loop.
1118 When there is an error, cmd_error runs and returns a non-nil
1119 value to us. A value of nil means that command_loop_1 itself
1120 returned due to end of file (or end of kbd macro). */
1122 Lisp_Object
1123 command_loop_2 (Lisp_Object ignore)
1125 register Lisp_Object val;
1128 val = internal_condition_case (command_loop_1, Qerror, cmd_error);
1129 while (!NILP (val));
1131 return Qnil;
1134 static Lisp_Object
1135 top_level_2 (void)
1137 return Feval (Vtop_level, Qnil);
1140 Lisp_Object
1141 top_level_1 (Lisp_Object ignore)
1143 /* On entry to the outer level, run the startup file */
1144 if (!NILP (Vtop_level))
1145 internal_condition_case (top_level_2, Qerror, cmd_error);
1146 else if (!NILP (Vpurify_flag))
1147 message ("Bare impure Emacs (standard Lisp code not loaded)");
1148 else
1149 message ("Bare Emacs (standard Lisp code not loaded)");
1150 return Qnil;
1153 DEFUN ("top-level", Ftop_level, Stop_level, 0, 0, "",
1154 doc: /* Exit all recursive editing levels.
1155 This also exits all active minibuffers. */)
1156 (void)
1158 #ifdef HAVE_WINDOW_SYSTEM
1159 if (display_hourglass_p)
1160 cancel_hourglass ();
1161 #endif
1163 /* Unblock input if we enter with input blocked. This may happen if
1164 redisplay traps e.g. during tool-bar update with input blocked. */
1165 while (INPUT_BLOCKED_P)
1166 UNBLOCK_INPUT;
1168 Fthrow (Qtop_level, Qnil);
1171 Lisp_Object Fexit_recursive_edit (void) NO_RETURN;
1172 DEFUN ("exit-recursive-edit", Fexit_recursive_edit, Sexit_recursive_edit, 0, 0, "",
1173 doc: /* Exit from the innermost recursive edit or minibuffer. */)
1174 (void)
1176 if (command_loop_level > 0 || minibuf_level > 0)
1177 Fthrow (Qexit, Qnil);
1179 error ("No recursive edit is in progress");
1182 Lisp_Object Fabort_recursive_edit (void) NO_RETURN;
1183 DEFUN ("abort-recursive-edit", Fabort_recursive_edit, Sabort_recursive_edit, 0, 0, "",
1184 doc: /* Abort the command that requested this recursive edit or minibuffer input. */)
1185 (void)
1187 if (command_loop_level > 0 || minibuf_level > 0)
1188 Fthrow (Qexit, Qt);
1190 error ("No recursive edit is in progress");
1193 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1195 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1196 of this function. */
1198 static Lisp_Object
1199 tracking_off (Lisp_Object old_value)
1201 do_mouse_tracking = old_value;
1202 if (NILP (old_value))
1204 /* Redisplay may have been preempted because there was input
1205 available, and it assumes it will be called again after the
1206 input has been processed. If the only input available was
1207 the sort that we have just disabled, then we need to call
1208 redisplay. */
1209 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW))
1211 redisplay_preserve_echo_area (6);
1212 get_input_pending (&input_pending,
1213 READABLE_EVENTS_DO_TIMERS_NOW);
1216 return Qnil;
1219 DEFUN ("track-mouse", Ftrack_mouse, Strack_mouse, 0, UNEVALLED, 0,
1220 doc: /* Evaluate BODY with mouse movement events enabled.
1221 Within a `track-mouse' form, mouse motion generates input events that
1222 you can read with `read-event'.
1223 Normally, mouse motion is ignored.
1224 usage: (track-mouse BODY...) */)
1225 (Lisp_Object args)
1227 int count = SPECPDL_INDEX ();
1228 Lisp_Object val;
1230 record_unwind_protect (tracking_off, do_mouse_tracking);
1232 do_mouse_tracking = Qt;
1234 val = Fprogn (args);
1235 return unbind_to (count, val);
1238 /* If mouse has moved on some frame, return one of those frames.
1240 Return 0 otherwise.
1242 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1243 after resizing the tool-bar window. */
1245 int ignore_mouse_drag_p;
1247 static FRAME_PTR
1248 some_mouse_moved (void)
1250 Lisp_Object tail, frame;
1252 if (ignore_mouse_drag_p)
1254 /* ignore_mouse_drag_p = 0; */
1255 return 0;
1258 FOR_EACH_FRAME (tail, frame)
1260 if (XFRAME (frame)->mouse_moved)
1261 return XFRAME (frame);
1264 return 0;
1267 #endif /* HAVE_MOUSE || HAVE_GPM */
1269 /* This is the actual command reading loop,
1270 sans error-handling encapsulation. */
1272 static int read_key_sequence (Lisp_Object *, size_t, Lisp_Object,
1273 int, int, int);
1274 void safe_run_hooks (Lisp_Object);
1275 static void adjust_point_for_property (EMACS_INT, int);
1277 /* Cancel hourglass from protect_unwind.
1278 ARG is not used. */
1279 #ifdef HAVE_WINDOW_SYSTEM
1280 static Lisp_Object
1281 cancel_hourglass_unwind (Lisp_Object arg)
1283 cancel_hourglass ();
1284 return Qnil;
1286 #endif
1288 /* FIXME: This is wrong rather than test window-system, we should call
1289 a new set-selection, which will then dispatch to x-set-selection, or
1290 tty-set-selection, or w32-set-selection, ... */
1291 EXFUN (Fwindow_system, 1);
1293 Lisp_Object
1294 command_loop_1 (void)
1296 Lisp_Object cmd;
1297 Lisp_Object keybuf[30];
1298 int i;
1299 int prev_modiff = 0;
1300 struct buffer *prev_buffer = NULL;
1301 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1302 int was_locked = single_kboard;
1303 #endif
1304 int already_adjusted = 0;
1306 KVAR (current_kboard, Vprefix_arg) = Qnil;
1307 KVAR (current_kboard, Vlast_prefix_arg) = Qnil;
1308 Vdeactivate_mark = Qnil;
1309 waiting_for_input = 0;
1310 cancel_echoing ();
1312 this_command_key_count = 0;
1313 this_command_key_count_reset = 0;
1314 this_single_command_key_start = 0;
1316 if (NILP (Vmemory_full))
1318 /* Make sure this hook runs after commands that get errors and
1319 throw to top level. */
1320 /* Note that the value cell will never directly contain nil
1321 if the symbol is a local variable. */
1322 if (!NILP (Vpost_command_hook) && !NILP (Vrun_hooks))
1323 safe_run_hooks (Qpost_command_hook);
1325 /* If displaying a message, resize the echo area window to fit
1326 that message's size exactly. */
1327 if (!NILP (echo_area_buffer[0]))
1328 resize_echo_area_exactly ();
1330 if (!NILP (Vdeferred_action_list))
1331 safe_run_hooks (Qdeferred_action_function);
1334 /* Do this after running Vpost_command_hook, for consistency. */
1335 KVAR (current_kboard, Vlast_command) = Vthis_command;
1336 KVAR (current_kboard, Vreal_last_command) = real_this_command;
1337 if (!CONSP (last_command_event))
1338 KVAR (current_kboard, Vlast_repeatable_command) = real_this_command;
1340 while (1)
1342 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
1343 Fkill_emacs (Qnil);
1345 /* Make sure the current window's buffer is selected. */
1346 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
1347 set_buffer_internal (XBUFFER (XWINDOW (selected_window)->buffer));
1349 /* Display any malloc warning that just came out. Use while because
1350 displaying one warning can cause another. */
1352 while (pending_malloc_warning)
1353 display_malloc_warning ();
1355 Vdeactivate_mark = Qnil;
1357 /* If minibuffer on and echo area in use,
1358 wait a short time and redraw minibuffer. */
1360 if (minibuf_level
1361 && !NILP (echo_area_buffer[0])
1362 && EQ (minibuf_window, echo_area_window)
1363 && NUMBERP (Vminibuffer_message_timeout))
1365 /* Bind inhibit-quit to t so that C-g gets read in
1366 rather than quitting back to the minibuffer. */
1367 int count = SPECPDL_INDEX ();
1368 specbind (Qinhibit_quit, Qt);
1370 sit_for (Vminibuffer_message_timeout, 0, 2);
1372 /* Clear the echo area. */
1373 message2 (0, 0, 0);
1374 safe_run_hooks (Qecho_area_clear_hook);
1376 unbind_to (count, Qnil);
1378 /* If a C-g came in before, treat it as input now. */
1379 if (!NILP (Vquit_flag))
1381 Vquit_flag = Qnil;
1382 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
1386 #if 0
1387 /* Select the frame that the last event came from. Usually,
1388 switch-frame events will take care of this, but if some lisp
1389 code swallows a switch-frame event, we'll fix things up here.
1390 Is this a good idea? */
1391 if (FRAMEP (internal_last_event_frame)
1392 && !EQ (internal_last_event_frame, selected_frame))
1393 Fselect_frame (internal_last_event_frame, Qnil);
1394 #endif
1395 /* If it has changed current-menubar from previous value,
1396 really recompute the menubar from the value. */
1397 if (! NILP (Vlucid_menu_bar_dirty_flag)
1398 && !NILP (Ffboundp (Qrecompute_lucid_menubar)))
1399 call0 (Qrecompute_lucid_menubar);
1401 before_command_key_count = this_command_key_count;
1402 before_command_echo_length = echo_length ();
1404 Vthis_command = Qnil;
1405 real_this_command = Qnil;
1406 Vthis_original_command = Qnil;
1407 Vthis_command_keys_shift_translated = Qnil;
1409 /* Read next key sequence; i gets its length. */
1410 i = read_key_sequence (keybuf, sizeof keybuf / sizeof keybuf[0],
1411 Qnil, 0, 1, 1);
1413 /* A filter may have run while we were reading the input. */
1414 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
1415 Fkill_emacs (Qnil);
1416 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
1417 set_buffer_internal (XBUFFER (XWINDOW (selected_window)->buffer));
1419 ++num_input_keys;
1421 /* Now we have read a key sequence of length I,
1422 or else I is 0 and we found end of file. */
1424 if (i == 0) /* End of file -- happens only in */
1425 return Qnil; /* a kbd macro, at the end. */
1426 /* -1 means read_key_sequence got a menu that was rejected.
1427 Just loop around and read another command. */
1428 if (i == -1)
1430 cancel_echoing ();
1431 this_command_key_count = 0;
1432 this_command_key_count_reset = 0;
1433 this_single_command_key_start = 0;
1434 goto finalize;
1437 last_command_event = keybuf[i - 1];
1439 /* If the previous command tried to force a specific window-start,
1440 forget about that, in case this command moves point far away
1441 from that position. But also throw away beg_unchanged and
1442 end_unchanged information in that case, so that redisplay will
1443 update the whole window properly. */
1444 if (!NILP (XWINDOW (selected_window)->force_start))
1446 struct buffer *b;
1447 XWINDOW (selected_window)->force_start = Qnil;
1448 b = XBUFFER (XWINDOW (selected_window)->buffer);
1449 BUF_BEG_UNCHANGED (b) = BUF_END_UNCHANGED (b) = 0;
1452 cmd = read_key_sequence_cmd;
1453 if (!NILP (Vexecuting_kbd_macro))
1455 if (!NILP (Vquit_flag))
1457 Vexecuting_kbd_macro = Qt;
1458 QUIT; /* Make some noise. */
1459 /* Will return since macro now empty. */
1463 /* Do redisplay processing after this command except in special
1464 cases identified below. */
1465 prev_buffer = current_buffer;
1466 prev_modiff = MODIFF;
1467 last_point_position = PT;
1468 last_point_position_window = selected_window;
1469 XSETBUFFER (last_point_position_buffer, prev_buffer);
1471 /* By default, we adjust point to a boundary of a region that
1472 has such a property that should be treated intangible
1473 (e.g. composition, display). But, some commands will set
1474 this variable differently. */
1475 Vdisable_point_adjustment = Qnil;
1477 /* Process filters and timers may have messed with deactivate-mark.
1478 reset it before we execute the command. */
1479 Vdeactivate_mark = Qnil;
1481 /* Remap command through active keymaps */
1482 Vthis_original_command = cmd;
1483 if (SYMBOLP (cmd))
1485 Lisp_Object cmd1;
1486 if (cmd1 = Fcommand_remapping (cmd, Qnil, Qnil), !NILP (cmd1))
1487 cmd = cmd1;
1490 /* Execute the command. */
1492 Vthis_command = cmd;
1493 real_this_command = cmd;
1494 safe_run_hooks (Qpre_command_hook);
1496 already_adjusted = 0;
1498 if (NILP (Vthis_command))
1500 /* nil means key is undefined. */
1501 Lisp_Object keys = Fvector (i, keybuf);
1502 keys = Fkey_description (keys, Qnil);
1503 bitch_at_user ();
1504 message_with_string ("%s is undefined", keys, 0);
1505 KVAR (current_kboard, defining_kbd_macro) = Qnil;
1506 update_mode_lines = 1;
1507 KVAR (current_kboard, Vprefix_arg) = Qnil;
1509 else
1511 /* Here for a command that isn't executed directly */
1513 #ifdef HAVE_WINDOW_SYSTEM
1514 int scount = SPECPDL_INDEX ();
1516 if (display_hourglass_p
1517 && NILP (Vexecuting_kbd_macro))
1519 record_unwind_protect (cancel_hourglass_unwind, Qnil);
1520 start_hourglass ();
1522 #endif
1524 if (NILP (KVAR (current_kboard, Vprefix_arg))) /* FIXME: Why? --Stef */
1525 Fundo_boundary ();
1526 Fcommand_execute (Vthis_command, Qnil, Qnil, Qnil);
1528 #ifdef HAVE_WINDOW_SYSTEM
1529 /* Do not check display_hourglass_p here, because
1530 Fcommand_execute could change it, but we should cancel
1531 hourglass cursor anyway.
1532 But don't cancel the hourglass within a macro
1533 just because a command in the macro finishes. */
1534 if (NILP (Vexecuting_kbd_macro))
1535 unbind_to (scount, Qnil);
1536 #endif
1538 KVAR (current_kboard, Vlast_prefix_arg) = Vcurrent_prefix_arg;
1540 safe_run_hooks (Qpost_command_hook);
1542 /* If displaying a message, resize the echo area window to fit
1543 that message's size exactly. */
1544 if (!NILP (echo_area_buffer[0]))
1545 resize_echo_area_exactly ();
1547 safe_run_hooks (Qdeferred_action_function);
1549 /* If there is a prefix argument,
1550 1) We don't want Vlast_command to be ``universal-argument''
1551 (that would be dumb), so don't set Vlast_command,
1552 2) we want to leave echoing on so that the prefix will be
1553 echoed as part of this key sequence, so don't call
1554 cancel_echoing, and
1555 3) we want to leave this_command_key_count non-zero, so that
1556 read_char will realize that it is re-reading a character, and
1557 not echo it a second time.
1559 If the command didn't actually create a prefix arg,
1560 but is merely a frame event that is transparent to prefix args,
1561 then the above doesn't apply. */
1562 if (NILP (KVAR (current_kboard, Vprefix_arg)) || CONSP (last_command_event))
1564 KVAR (current_kboard, Vlast_command) = Vthis_command;
1565 KVAR (current_kboard, Vreal_last_command) = real_this_command;
1566 if (!CONSP (last_command_event))
1567 KVAR (current_kboard, Vlast_repeatable_command) = real_this_command;
1568 cancel_echoing ();
1569 this_command_key_count = 0;
1570 this_command_key_count_reset = 0;
1571 this_single_command_key_start = 0;
1574 if (!NILP (BVAR (current_buffer, mark_active))
1575 && !NILP (Vrun_hooks))
1577 /* In Emacs 22, setting transient-mark-mode to `only' was a
1578 way of turning it on for just one command. This usage is
1579 obsolete, but support it anyway. */
1580 if (EQ (Vtransient_mark_mode, Qidentity))
1581 Vtransient_mark_mode = Qnil;
1582 else if (EQ (Vtransient_mark_mode, Qonly))
1583 Vtransient_mark_mode = Qidentity;
1585 if (!NILP (Vdeactivate_mark))
1586 /* If `select-active-regions' is non-nil, this call to
1587 `deactivate-mark' also sets the PRIMARY selection. */
1588 call0 (Qdeactivate_mark);
1589 else
1591 /* Even if not deactivating the mark, set PRIMARY if
1592 `select-active-regions' is non-nil. */
1593 if (!NILP (Fwindow_system (Qnil))
1594 /* Even if mark_active is non-nil, the actual buffer
1595 marker may not have been set yet (Bug#7044). */
1596 && XMARKER (BVAR (current_buffer, mark))->buffer
1597 && (EQ (Vselect_active_regions, Qonly)
1598 ? EQ (CAR_SAFE (Vtransient_mark_mode), Qonly)
1599 : (!NILP (Vselect_active_regions)
1600 && !NILP (Vtransient_mark_mode)))
1601 && !EQ (Vthis_command, Qhandle_switch_frame))
1603 EMACS_INT beg =
1604 XINT (Fmarker_position (BVAR (current_buffer, mark)));
1605 EMACS_INT end = PT;
1606 if (beg < end)
1607 call2 (Qx_set_selection, QPRIMARY,
1608 make_buffer_string (beg, end, 0));
1609 else if (beg > end)
1610 call2 (Qx_set_selection, QPRIMARY,
1611 make_buffer_string (end, beg, 0));
1612 /* Don't set empty selections. */
1615 if (current_buffer != prev_buffer || MODIFF != prev_modiff)
1617 Lisp_Object hook = intern ("activate-mark-hook");
1618 Frun_hooks (1, &hook);
1622 Vsaved_region_selection = Qnil;
1625 finalize:
1627 if (current_buffer == prev_buffer
1628 && last_point_position != PT
1629 && NILP (Vdisable_point_adjustment)
1630 && NILP (Vglobal_disable_point_adjustment))
1632 if (last_point_position > BEGV
1633 && last_point_position < ZV
1634 && (composition_adjust_point (last_point_position,
1635 last_point_position)
1636 != last_point_position))
1637 /* The last point was temporarily set within a grapheme
1638 cluster to prevent automatic composition. To recover
1639 the automatic composition, we must update the
1640 display. */
1641 windows_or_buffers_changed++;
1642 if (!already_adjusted)
1643 adjust_point_for_property (last_point_position,
1644 MODIFF != prev_modiff);
1647 /* Install chars successfully executed in kbd macro. */
1649 if (!NILP (KVAR (current_kboard, defining_kbd_macro))
1650 && NILP (KVAR (current_kboard, Vprefix_arg)))
1651 finalize_kbd_macro_chars ();
1652 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1653 if (!was_locked)
1654 any_kboard_state ();
1655 #endif
1659 /* Adjust point to a boundary of a region that has such a property
1660 that should be treated intangible. For the moment, we check
1661 `composition', `display' and `invisible' properties.
1662 LAST_PT is the last position of point. */
1664 static void
1665 adjust_point_for_property (EMACS_INT last_pt, int modified)
1667 EMACS_INT beg, end;
1668 Lisp_Object val, overlay, tmp;
1669 /* When called after buffer modification, we should temporarily
1670 suppress the point adjustment for automatic composition so that a
1671 user can keep inserting another character at point or keep
1672 deleting characters around point. */
1673 int check_composition = ! modified, check_display = 1, check_invisible = 1;
1674 EMACS_INT orig_pt = PT;
1676 /* FIXME: cycling is probably not necessary because these properties
1677 can't be usefully combined anyway. */
1678 while (check_composition || check_display || check_invisible)
1680 /* FIXME: check `intangible'. */
1681 if (check_composition
1682 && PT > BEGV && PT < ZV
1683 && (beg = composition_adjust_point (last_pt, PT)) != PT)
1685 SET_PT (beg);
1686 check_display = check_invisible = 1;
1688 check_composition = 0;
1689 if (check_display
1690 && PT > BEGV && PT < ZV
1691 && !NILP (val = get_char_property_and_overlay
1692 (make_number (PT), Qdisplay, Qnil, &overlay))
1693 && display_prop_intangible_p (val)
1694 && (!OVERLAYP (overlay)
1695 ? get_property_and_range (PT, Qdisplay, &val, &beg, &end, Qnil)
1696 : (beg = OVERLAY_POSITION (OVERLAY_START (overlay)),
1697 end = OVERLAY_POSITION (OVERLAY_END (overlay))))
1698 && (beg < PT /* && end > PT <- It's always the case. */
1699 || (beg <= PT && STRINGP (val) && SCHARS (val) == 0)))
1701 xassert (end > PT);
1702 SET_PT (PT < last_pt
1703 ? (STRINGP (val) && SCHARS (val) == 0 ? beg - 1 : beg)
1704 : end);
1705 check_composition = check_invisible = 1;
1707 check_display = 0;
1708 if (check_invisible && PT > BEGV && PT < ZV)
1710 int inv, ellipsis = 0;
1711 beg = end = PT;
1713 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1714 while (end < ZV
1715 #if 0
1716 /* FIXME: We should stop if we find a spot between
1717 two runs of `invisible' where inserted text would
1718 be visible. This is important when we have two
1719 invisible boundaries that enclose an area: if the
1720 area is empty, we need this test in order to make
1721 it possible to place point in the middle rather
1722 than skip both boundaries. However, this code
1723 also stops anywhere in a non-sticky text-property,
1724 which breaks (e.g.) Org mode. */
1725 && (val = get_pos_property (make_number (end),
1726 Qinvisible, Qnil),
1727 TEXT_PROP_MEANS_INVISIBLE (val))
1728 #endif
1729 && !NILP (val = get_char_property_and_overlay
1730 (make_number (end), Qinvisible, Qnil, &overlay))
1731 && (inv = TEXT_PROP_MEANS_INVISIBLE (val)))
1733 ellipsis = ellipsis || inv > 1
1734 || (OVERLAYP (overlay)
1735 && (!NILP (Foverlay_get (overlay, Qafter_string))
1736 || !NILP (Foverlay_get (overlay, Qbefore_string))));
1737 tmp = Fnext_single_char_property_change
1738 (make_number (end), Qinvisible, Qnil, Qnil);
1739 end = NATNUMP (tmp) ? XFASTINT (tmp) : ZV;
1741 while (beg > BEGV
1742 #if 0
1743 && (val = get_pos_property (make_number (beg),
1744 Qinvisible, Qnil),
1745 TEXT_PROP_MEANS_INVISIBLE (val))
1746 #endif
1747 && !NILP (val = get_char_property_and_overlay
1748 (make_number (beg - 1), Qinvisible, Qnil, &overlay))
1749 && (inv = TEXT_PROP_MEANS_INVISIBLE (val)))
1751 ellipsis = ellipsis || inv > 1
1752 || (OVERLAYP (overlay)
1753 && (!NILP (Foverlay_get (overlay, Qafter_string))
1754 || !NILP (Foverlay_get (overlay, Qbefore_string))));
1755 tmp = Fprevious_single_char_property_change
1756 (make_number (beg), Qinvisible, Qnil, Qnil);
1757 beg = NATNUMP (tmp) ? XFASTINT (tmp) : BEGV;
1760 /* Move away from the inside area. */
1761 if (beg < PT && end > PT)
1763 SET_PT ((orig_pt == PT && (last_pt < beg || last_pt > end))
1764 /* We haven't moved yet (so we don't need to fear
1765 infinite-looping) and we were outside the range
1766 before (so either end of the range still corresponds
1767 to a move in the right direction): pretend we moved
1768 less than we actually did, so that we still have
1769 more freedom below in choosing which end of the range
1770 to go to. */
1771 ? (orig_pt = -1, PT < last_pt ? end : beg)
1772 /* We either have moved already or the last point
1773 was already in the range: we don't get to choose
1774 which end of the range we have to go to. */
1775 : (PT < last_pt ? beg : end));
1776 check_composition = check_display = 1;
1778 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1779 the point to something other than its argument, due to
1780 point-motion hooks, intangibility, etc. */
1781 xassert (PT == beg || PT == end);
1782 #endif
1784 /* Pretend the area doesn't exist if the buffer is not
1785 modified. */
1786 if (!modified && !ellipsis && beg < end)
1788 if (last_pt == beg && PT == end && end < ZV)
1789 (check_composition = check_display = 1, SET_PT (end + 1));
1790 else if (last_pt == end && PT == beg && beg > BEGV)
1791 (check_composition = check_display = 1, SET_PT (beg - 1));
1792 else if (PT == ((PT < last_pt) ? beg : end))
1793 /* We've already moved as far as we can. Trying to go
1794 to the other end would mean moving backwards and thus
1795 could lead to an infinite loop. */
1797 else if (val = get_pos_property (make_number (PT),
1798 Qinvisible, Qnil),
1799 TEXT_PROP_MEANS_INVISIBLE (val)
1800 && (val = get_pos_property
1801 (make_number (PT == beg ? end : beg),
1802 Qinvisible, Qnil),
1803 !TEXT_PROP_MEANS_INVISIBLE (val)))
1804 (check_composition = check_display = 1,
1805 SET_PT (PT == beg ? end : beg));
1808 check_invisible = 0;
1812 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1814 static Lisp_Object
1815 safe_run_hooks_1 (void)
1817 eassert (CONSP (Vinhibit_quit));
1818 return call0 (XCDR (Vinhibit_quit));
1821 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1822 from the hook. */
1824 static Lisp_Object
1825 safe_run_hooks_error (Lisp_Object error_data)
1827 Lisp_Object hook
1828 = CONSP (Vinhibit_quit) ? XCAR (Vinhibit_quit) : Vinhibit_quit;
1829 Lisp_Object fun = CONSP (Vinhibit_quit) ? XCDR (Vinhibit_quit) : Qnil;
1830 Lisp_Object args[4];
1831 args[0] = build_string ("Error in %s (%s): %s");
1832 args[1] = hook;
1833 args[2] = fun;
1834 args[3] = error_data;
1835 Fmessage (4, args);
1836 if (SYMBOLP (hook))
1838 Lisp_Object val;
1839 int found = 0;
1840 Lisp_Object newval = Qnil;
1841 for (val = find_symbol_value (hook); CONSP (val); val = XCDR (val))
1842 if (EQ (fun, XCAR (val)))
1843 found = 1;
1844 else
1845 newval = Fcons (XCAR (val), newval);
1846 if (found)
1847 return Fset (hook, Fnreverse (newval));
1848 /* Not found in the local part of the hook. Let's look at the global
1849 part. */
1850 newval = Qnil;
1851 for (val = (NILP (Fdefault_boundp (hook)) ? Qnil
1852 : Fdefault_value (hook));
1853 CONSP (val); val = XCDR (val))
1854 if (EQ (fun, XCAR (val)))
1855 found = 1;
1856 else
1857 newval = Fcons (XCAR (val), newval);
1858 if (found)
1859 return Fset_default (hook, Fnreverse (newval));
1861 return Qnil;
1864 static Lisp_Object
1865 safe_run_hook_funcall (size_t nargs, Lisp_Object *args)
1867 eassert (nargs == 1);
1868 if (CONSP (Vinhibit_quit))
1869 XSETCDR (Vinhibit_quit, args[0]);
1870 else
1871 Vinhibit_quit = Fcons (Vinhibit_quit, args[0]);
1873 return internal_condition_case (safe_run_hooks_1, Qt, safe_run_hooks_error);
1876 /* If we get an error while running the hook, cause the hook variable
1877 to be nil. Also inhibit quits, so that C-g won't cause the hook
1878 to mysteriously evaporate. */
1880 void
1881 safe_run_hooks (Lisp_Object hook)
1883 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1884 to its body or to its handlers other than via globals such as
1885 dynamically-bound variables ;-) */
1886 int count = SPECPDL_INDEX ();
1887 specbind (Qinhibit_quit, hook);
1889 run_hook_with_args (1, &hook, safe_run_hook_funcall);
1891 unbind_to (count, Qnil);
1895 /* Nonzero means polling for input is temporarily suppressed. */
1897 int poll_suppress_count;
1899 /* Asynchronous timer for polling. */
1901 struct atimer *poll_timer;
1904 #ifdef POLL_FOR_INPUT
1906 /* Poll for input, so that we catch a C-g if it comes in. This
1907 function is called from x_make_frame_visible, see comment
1908 there. */
1910 void
1911 poll_for_input_1 (void)
1913 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1914 doing anything dangerous. */
1915 #ifdef HAVE_NS
1916 ++handling_signal;
1917 #endif
1918 if (interrupt_input_blocked == 0
1919 && !waiting_for_input)
1920 read_avail_input (0);
1921 #ifdef HAVE_NS
1922 --handling_signal;
1923 #endif
1926 /* Timer callback function for poll_timer. TIMER is equal to
1927 poll_timer. */
1929 static void
1930 poll_for_input (struct atimer *timer)
1932 if (poll_suppress_count == 0)
1934 #ifdef SYNC_INPUT
1935 interrupt_input_pending = 1;
1936 pending_signals = 1;
1937 #else
1938 poll_for_input_1 ();
1939 #endif
1943 #endif /* POLL_FOR_INPUT */
1945 /* Begin signals to poll for input, if they are appropriate.
1946 This function is called unconditionally from various places. */
1948 void
1949 start_polling (void)
1951 #ifdef POLL_FOR_INPUT
1952 /* XXX This condition was (read_socket_hook && !interrupt_input),
1953 but read_socket_hook is not global anymore. Let's pretend that
1954 it's always set. */
1955 if (!interrupt_input)
1957 /* Turn alarm handling on unconditionally. It might have
1958 been turned off in process.c. */
1959 turn_on_atimers (1);
1961 /* If poll timer doesn't exist, are we need one with
1962 a different interval, start a new one. */
1963 if (poll_timer == NULL
1964 || EMACS_SECS (poll_timer->interval) != polling_period)
1966 EMACS_TIME interval;
1968 if (poll_timer)
1969 cancel_atimer (poll_timer);
1971 EMACS_SET_SECS_USECS (interval, polling_period, 0);
1972 poll_timer = start_atimer (ATIMER_CONTINUOUS, interval,
1973 poll_for_input, NULL);
1976 /* Let the timer's callback function poll for input
1977 if this becomes zero. */
1978 --poll_suppress_count;
1980 #endif
1983 /* Nonzero if we are using polling to handle input asynchronously. */
1986 input_polling_used (void)
1988 #ifdef POLL_FOR_INPUT
1989 /* XXX This condition was (read_socket_hook && !interrupt_input),
1990 but read_socket_hook is not global anymore. Let's pretend that
1991 it's always set. */
1992 return !interrupt_input;
1993 #else
1994 return 0;
1995 #endif
1998 /* Turn off polling. */
2000 void
2001 stop_polling (void)
2003 #ifdef POLL_FOR_INPUT
2004 /* XXX This condition was (read_socket_hook && !interrupt_input),
2005 but read_socket_hook is not global anymore. Let's pretend that
2006 it's always set. */
2007 if (!interrupt_input)
2008 ++poll_suppress_count;
2009 #endif
2012 /* Set the value of poll_suppress_count to COUNT
2013 and start or stop polling accordingly. */
2015 void
2016 set_poll_suppress_count (int count)
2018 #ifdef POLL_FOR_INPUT
2019 if (count == 0 && poll_suppress_count != 0)
2021 poll_suppress_count = 1;
2022 start_polling ();
2024 else if (count != 0 && poll_suppress_count == 0)
2026 stop_polling ();
2028 poll_suppress_count = count;
2029 #endif
2032 /* Bind polling_period to a value at least N.
2033 But don't decrease it. */
2035 void
2036 bind_polling_period (int n)
2038 #ifdef POLL_FOR_INPUT
2039 int new = polling_period;
2041 if (n > new)
2042 new = n;
2044 stop_other_atimers (poll_timer);
2045 stop_polling ();
2046 specbind (Qpolling_period, make_number (new));
2047 /* Start a new alarm with the new period. */
2048 start_polling ();
2049 #endif
2052 /* Apply the control modifier to CHARACTER. */
2055 make_ctrl_char (int c)
2057 /* Save the upper bits here. */
2058 int upper = c & ~0177;
2060 if (! ASCII_BYTE_P (c))
2061 return c |= ctrl_modifier;
2063 c &= 0177;
2065 /* Everything in the columns containing the upper-case letters
2066 denotes a control character. */
2067 if (c >= 0100 && c < 0140)
2069 int oc = c;
2070 c &= ~0140;
2071 /* Set the shift modifier for a control char
2072 made from a shifted letter. But only for letters! */
2073 if (oc >= 'A' && oc <= 'Z')
2074 c |= shift_modifier;
2077 /* The lower-case letters denote control characters too. */
2078 else if (c >= 'a' && c <= 'z')
2079 c &= ~0140;
2081 /* Include the bits for control and shift
2082 only if the basic ASCII code can't indicate them. */
2083 else if (c >= ' ')
2084 c |= ctrl_modifier;
2086 /* Replace the high bits. */
2087 c |= (upper & ~ctrl_modifier);
2089 return c;
2092 /* Display the help-echo property of the character after the mouse pointer.
2093 Either show it in the echo area, or call show-help-function to display
2094 it by other means (maybe in a tooltip).
2096 If HELP is nil, that means clear the previous help echo.
2098 If HELP is a string, display that string. If HELP is a function,
2099 call it with OBJECT and POS as arguments; the function should
2100 return a help string or nil for none. For all other types of HELP,
2101 evaluate it to obtain a string.
2103 WINDOW is the window in which the help was generated, if any.
2104 It is nil if not in a window.
2106 If OBJECT is a buffer, POS is the position in the buffer where the
2107 `help-echo' text property was found.
2109 If OBJECT is an overlay, that overlay has a `help-echo' property,
2110 and POS is the position in the overlay's buffer under the mouse.
2112 If OBJECT is a string (an overlay string or a string displayed with
2113 the `display' property). POS is the position in that string under
2114 the mouse.
2116 Note: this function may only be called with HELP nil or a string
2117 from X code running asynchronously. */
2119 void
2120 show_help_echo (Lisp_Object help, Lisp_Object window, Lisp_Object object,
2121 Lisp_Object pos)
2123 if (!NILP (help) && !STRINGP (help))
2125 if (FUNCTIONP (help))
2127 Lisp_Object args[4];
2128 args[0] = help;
2129 args[1] = window;
2130 args[2] = object;
2131 args[3] = pos;
2132 help = safe_call (4, args);
2134 else
2135 help = safe_eval (help);
2137 if (!STRINGP (help))
2138 return;
2141 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2142 if (!noninteractive && STRINGP (help))
2144 /* The mouse-fixup-help-message Lisp function can call
2145 mouse_position_hook, which resets the mouse_moved flags.
2146 This causes trouble if we are trying to read a mouse motion
2147 event (i.e., if we are inside a `track-mouse' form), so we
2148 restore the mouse_moved flag. */
2149 FRAME_PTR f = NILP (do_mouse_tracking) ? NULL : some_mouse_moved ();
2150 help = call1 (Qmouse_fixup_help_message, help);
2151 if (f)
2152 f->mouse_moved = 1;
2154 #endif
2156 if (STRINGP (help) || NILP (help))
2158 if (!NILP (Vshow_help_function))
2159 call1 (Vshow_help_function, help);
2160 help_echo_showing_p = STRINGP (help);
2166 /* Input of single characters from keyboard */
2168 Lisp_Object print_help (Lisp_Object object);
2169 static Lisp_Object kbd_buffer_get_event (KBOARD **kbp, int *used_mouse_menu,
2170 struct timeval *end_time);
2171 static void record_char (Lisp_Object c);
2173 static Lisp_Object help_form_saved_window_configs;
2174 static Lisp_Object
2175 read_char_help_form_unwind (Lisp_Object arg)
2177 Lisp_Object window_config = XCAR (help_form_saved_window_configs);
2178 help_form_saved_window_configs = XCDR (help_form_saved_window_configs);
2179 if (!NILP (window_config))
2180 Fset_window_configuration (window_config);
2181 return Qnil;
2184 #define STOP_POLLING \
2185 do { if (! polling_stopped_here) stop_polling (); \
2186 polling_stopped_here = 1; } while (0)
2188 #define RESUME_POLLING \
2189 do { if (polling_stopped_here) start_polling (); \
2190 polling_stopped_here = 0; } while (0)
2192 /* read a character from the keyboard; call the redisplay if needed */
2193 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2194 -1 means do not do redisplay, but do do autosaving.
2195 1 means do both. */
2197 /* The arguments MAPS and NMAPS are for menu prompting.
2198 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2200 PREV_EVENT is the previous input event, or nil if we are reading
2201 the first event of a key sequence (or not reading a key sequence).
2202 If PREV_EVENT is t, that is a "magic" value that says
2203 not to run input methods, but in other respects to act as if
2204 not reading a key sequence.
2206 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2207 if we used a mouse menu to read the input, or zero otherwise. If
2208 USED_MOUSE_MENU is null, we don't dereference it.
2210 Value is -2 when we find input on another keyboard. A second call
2211 to read_char will read it.
2213 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2214 specifying the maximum time to wait until. If no input arrives by
2215 that time, stop waiting and return nil.
2217 Value is t if we showed a menu and the user rejected it. */
2219 Lisp_Object
2220 read_char (int commandflag, int nmaps, Lisp_Object *maps, Lisp_Object prev_event,
2221 int *used_mouse_menu, struct timeval *end_time)
2223 volatile Lisp_Object c;
2224 int jmpcount;
2225 jmp_buf local_getcjmp;
2226 jmp_buf save_jump;
2227 volatile int key_already_recorded = 0;
2228 Lisp_Object tem, save;
2229 volatile Lisp_Object previous_echo_area_message;
2230 volatile Lisp_Object also_record;
2231 volatile int reread;
2232 struct gcpro gcpro1, gcpro2;
2233 int polling_stopped_here = 0;
2234 struct kboard *orig_kboard = current_kboard;
2236 also_record = Qnil;
2238 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2239 before_command_key_count = this_command_key_count;
2240 before_command_echo_length = echo_length ();
2241 #endif
2242 c = Qnil;
2243 previous_echo_area_message = Qnil;
2245 GCPRO2 (c, previous_echo_area_message);
2247 retry:
2249 reread = 0;
2250 if (CONSP (Vunread_post_input_method_events))
2252 c = XCAR (Vunread_post_input_method_events);
2253 Vunread_post_input_method_events
2254 = XCDR (Vunread_post_input_method_events);
2256 /* Undo what read_char_x_menu_prompt did when it unread
2257 additional keys returned by Fx_popup_menu. */
2258 if (CONSP (c)
2259 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c)))
2260 && NILP (XCDR (c)))
2261 c = XCAR (c);
2263 reread = 1;
2264 goto reread_first;
2267 if (unread_command_char != -1)
2269 XSETINT (c, unread_command_char);
2270 unread_command_char = -1;
2272 reread = 1;
2273 goto reread_first;
2276 if (CONSP (Vunread_command_events))
2278 int was_disabled = 0;
2280 c = XCAR (Vunread_command_events);
2281 Vunread_command_events = XCDR (Vunread_command_events);
2283 reread = 1;
2285 /* Undo what sit-for did when it unread additional keys
2286 inside universal-argument. */
2288 if (CONSP (c)
2289 && EQ (XCAR (c), Qt))
2291 reread = 0;
2292 c = XCDR (c);
2295 /* Undo what read_char_x_menu_prompt did when it unread
2296 additional keys returned by Fx_popup_menu. */
2297 if (CONSP (c)
2298 && EQ (XCDR (c), Qdisabled)
2299 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c))))
2301 was_disabled = 1;
2302 c = XCAR (c);
2305 /* If the queued event is something that used the mouse,
2306 set used_mouse_menu accordingly. */
2307 if (used_mouse_menu
2308 /* Also check was_disabled so last-nonmenu-event won't return
2309 a bad value when submenus are involved. (Bug#447) */
2310 && (EQ (c, Qtool_bar) || EQ (c, Qmenu_bar) || was_disabled))
2311 *used_mouse_menu = 1;
2313 goto reread_for_input_method;
2316 if (CONSP (Vunread_input_method_events))
2318 c = XCAR (Vunread_input_method_events);
2319 Vunread_input_method_events = XCDR (Vunread_input_method_events);
2321 /* Undo what read_char_x_menu_prompt did when it unread
2322 additional keys returned by Fx_popup_menu. */
2323 if (CONSP (c)
2324 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c)))
2325 && NILP (XCDR (c)))
2326 c = XCAR (c);
2327 reread = 1;
2328 goto reread_for_input_method;
2331 this_command_key_count_reset = 0;
2333 if (!NILP (Vexecuting_kbd_macro))
2335 /* We set this to Qmacro; since that's not a frame, nobody will
2336 try to switch frames on us, and the selected window will
2337 remain unchanged.
2339 Since this event came from a macro, it would be misleading to
2340 leave internal_last_event_frame set to wherever the last
2341 real event came from. Normally, a switch-frame event selects
2342 internal_last_event_frame after each command is read, but
2343 events read from a macro should never cause a new frame to be
2344 selected. */
2345 Vlast_event_frame = internal_last_event_frame = Qmacro;
2347 /* Exit the macro if we are at the end.
2348 Also, some things replace the macro with t
2349 to force an early exit. */
2350 if (EQ (Vexecuting_kbd_macro, Qt)
2351 || executing_kbd_macro_index >= XFASTINT (Flength (Vexecuting_kbd_macro)))
2353 XSETINT (c, -1);
2354 goto exit;
2357 c = Faref (Vexecuting_kbd_macro, make_number (executing_kbd_macro_index));
2358 if (STRINGP (Vexecuting_kbd_macro)
2359 && (XINT (c) & 0x80) && (XUINT (c) <= 0xff))
2360 XSETFASTINT (c, CHAR_META | (XINT (c) & ~0x80));
2362 executing_kbd_macro_index++;
2364 goto from_macro;
2367 if (!NILP (unread_switch_frame))
2369 c = unread_switch_frame;
2370 unread_switch_frame = Qnil;
2372 /* This event should make it into this_command_keys, and get echoed
2373 again, so we do not set `reread'. */
2374 goto reread_first;
2377 /* if redisplay was requested */
2378 if (commandflag >= 0)
2380 int echo_current = EQ (echo_message_buffer, echo_area_buffer[0]);
2382 /* If there is pending input, process any events which are not
2383 user-visible, such as X selection_request events. */
2384 if (input_pending
2385 || detect_input_pending_run_timers (0))
2386 swallow_events (0); /* may clear input_pending */
2388 /* Redisplay if no pending input. */
2389 while (!input_pending)
2391 if (help_echo_showing_p && !EQ (selected_window, minibuf_window))
2392 redisplay_preserve_echo_area (5);
2393 else
2394 redisplay ();
2396 if (!input_pending)
2397 /* Normal case: no input arrived during redisplay. */
2398 break;
2400 /* Input arrived and pre-empted redisplay.
2401 Process any events which are not user-visible. */
2402 swallow_events (0);
2403 /* If that cleared input_pending, try again to redisplay. */
2406 /* Prevent the redisplay we just did
2407 from messing up echoing of the input after the prompt. */
2408 if (commandflag == 0 && echo_current)
2409 echo_message_buffer = echo_area_buffer[0];
2413 /* Message turns off echoing unless more keystrokes turn it on again.
2415 The code in 20.x for the condition was
2417 1. echo_area_glyphs && *echo_area_glyphs
2418 2. && echo_area_glyphs != current_kboard->echobuf
2419 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2421 (1) means there's a current message displayed
2423 (2) means it's not the message from echoing from the current
2424 kboard.
2426 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2427 is set to a non-null value. This is done in read_char and it is
2428 set to echo_area_glyphs after a call to echo_char. That means
2429 ok_to_echo_at_next_pause is either null or
2430 current_kboard->echobuf with the appropriate current_kboard at
2431 that time.
2433 So, condition (3) means in clear text ok_to_echo_at_next_pause
2434 must be either null, or the current message isn't from echoing at
2435 all, or it's from echoing from a different kboard than the
2436 current one. */
2438 if (/* There currently is something in the echo area. */
2439 !NILP (echo_area_buffer[0])
2440 && (/* And it's either not from echoing. */
2441 !EQ (echo_area_buffer[0], echo_message_buffer)
2442 /* Or it's an echo from a different kboard. */
2443 || echo_kboard != current_kboard
2444 /* Or we explicitly allow overwriting whatever there is. */
2445 || ok_to_echo_at_next_pause == NULL))
2446 cancel_echoing ();
2447 else
2448 echo_dash ();
2450 /* Try reading a character via menu prompting in the minibuf.
2451 Try this before the sit-for, because the sit-for
2452 would do the wrong thing if we are supposed to do
2453 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2454 after a mouse event so don't try a minibuf menu. */
2455 c = Qnil;
2456 if (nmaps > 0 && INTERACTIVE
2457 && !NILP (prev_event) && ! EVENT_HAS_PARAMETERS (prev_event)
2458 /* Don't bring up a menu if we already have another event. */
2459 && NILP (Vunread_command_events)
2460 && unread_command_char < 0
2461 && !detect_input_pending_run_timers (0))
2463 c = read_char_minibuf_menu_prompt (commandflag, nmaps, maps);
2465 if (INTEGERP (c) && XINT (c) == -2)
2466 return c; /* wrong_kboard_jmpbuf */
2468 if (! NILP (c))
2470 key_already_recorded = 1;
2471 goto non_reread_1;
2475 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2476 We will do that below, temporarily for short sections of code,
2477 when appropriate. local_getcjmp must be in effect
2478 around any call to sit_for or kbd_buffer_get_event;
2479 it *must not* be in effect when we call redisplay. */
2481 jmpcount = SPECPDL_INDEX ();
2482 if (_setjmp (local_getcjmp))
2484 /* Handle quits while reading the keyboard. */
2485 /* We must have saved the outer value of getcjmp here,
2486 so restore it now. */
2487 restore_getcjmp (save_jump);
2488 unbind_to (jmpcount, Qnil);
2489 XSETINT (c, quit_char);
2490 internal_last_event_frame = selected_frame;
2491 Vlast_event_frame = internal_last_event_frame;
2492 /* If we report the quit char as an event,
2493 don't do so more than once. */
2494 if (!NILP (Vinhibit_quit))
2495 Vquit_flag = Qnil;
2498 KBOARD *kb = FRAME_KBOARD (XFRAME (selected_frame));
2499 if (kb != current_kboard)
2501 Lisp_Object last = KVAR (kb, kbd_queue);
2502 /* We shouldn't get here if we were in single-kboard mode! */
2503 if (single_kboard)
2504 abort ();
2505 if (CONSP (last))
2507 while (CONSP (XCDR (last)))
2508 last = XCDR (last);
2509 if (!NILP (XCDR (last)))
2510 abort ();
2512 if (!CONSP (last))
2513 KVAR (kb, kbd_queue) = Fcons (c, Qnil);
2514 else
2515 XSETCDR (last, Fcons (c, Qnil));
2516 kb->kbd_queue_has_data = 1;
2517 current_kboard = kb;
2518 /* This is going to exit from read_char
2519 so we had better get rid of this frame's stuff. */
2520 UNGCPRO;
2521 return make_number (-2); /* wrong_kboard_jmpbuf */
2524 goto non_reread;
2527 /* Start idle timers if no time limit is supplied. We don't do it
2528 if a time limit is supplied to avoid an infinite recursion in the
2529 situation where an idle timer calls `sit-for'. */
2531 if (!end_time)
2532 timer_start_idle ();
2534 /* If in middle of key sequence and minibuffer not active,
2535 start echoing if enough time elapses. */
2537 if (minibuf_level == 0
2538 && !end_time
2539 && !current_kboard->immediate_echo
2540 && this_command_key_count > 0
2541 && ! noninteractive
2542 && (FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
2543 && NILP (Fzerop (Vecho_keystrokes))
2544 && (/* No message. */
2545 NILP (echo_area_buffer[0])
2546 /* Or empty message. */
2547 || (BUF_BEG (XBUFFER (echo_area_buffer[0]))
2548 == BUF_Z (XBUFFER (echo_area_buffer[0])))
2549 /* Or already echoing from same kboard. */
2550 || (echo_kboard && ok_to_echo_at_next_pause == echo_kboard)
2551 /* Or not echoing before and echoing allowed. */
2552 || (!echo_kboard && ok_to_echo_at_next_pause)))
2554 /* After a mouse event, start echoing right away.
2555 This is because we are probably about to display a menu,
2556 and we don't want to delay before doing so. */
2557 if (EVENT_HAS_PARAMETERS (prev_event))
2558 echo_now ();
2559 else
2561 Lisp_Object tem0;
2563 save_getcjmp (save_jump);
2564 restore_getcjmp (local_getcjmp);
2565 tem0 = sit_for (Vecho_keystrokes, 1, 1);
2566 restore_getcjmp (save_jump);
2567 if (EQ (tem0, Qt)
2568 && ! CONSP (Vunread_command_events))
2569 echo_now ();
2573 /* Maybe auto save due to number of keystrokes. */
2575 if (commandflag != 0
2576 && auto_save_interval > 0
2577 && num_nonmacro_input_events - last_auto_save > max (auto_save_interval, 20)
2578 && !detect_input_pending_run_timers (0))
2580 Fdo_auto_save (Qnil, Qnil);
2581 /* Hooks can actually change some buffers in auto save. */
2582 redisplay ();
2585 /* Try reading using an X menu.
2586 This is never confused with reading using the minibuf
2587 because the recursive call of read_char in read_char_minibuf_menu_prompt
2588 does not pass on any keymaps. */
2590 if (nmaps > 0 && INTERACTIVE
2591 && !NILP (prev_event)
2592 && EVENT_HAS_PARAMETERS (prev_event)
2593 && !EQ (XCAR (prev_event), Qmenu_bar)
2594 && !EQ (XCAR (prev_event), Qtool_bar)
2595 /* Don't bring up a menu if we already have another event. */
2596 && NILP (Vunread_command_events)
2597 && unread_command_char < 0)
2599 c = read_char_x_menu_prompt (nmaps, maps, prev_event, used_mouse_menu);
2601 /* Now that we have read an event, Emacs is not idle. */
2602 if (!end_time)
2603 timer_stop_idle ();
2605 goto exit;
2608 /* Maybe autosave and/or garbage collect due to idleness. */
2610 if (INTERACTIVE && NILP (c))
2612 int delay_level;
2613 EMACS_INT buffer_size;
2615 /* Slow down auto saves logarithmically in size of current buffer,
2616 and garbage collect while we're at it. */
2617 if (! MINI_WINDOW_P (XWINDOW (selected_window)))
2618 last_non_minibuf_size = Z - BEG;
2619 buffer_size = (last_non_minibuf_size >> 8) + 1;
2620 delay_level = 0;
2621 while (buffer_size > 64)
2622 delay_level++, buffer_size -= buffer_size >> 2;
2623 if (delay_level < 4) delay_level = 4;
2624 /* delay_level is 4 for files under around 50k, 7 at 100k,
2625 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2627 /* Auto save if enough time goes by without input. */
2628 if (commandflag != 0
2629 && num_nonmacro_input_events > last_auto_save
2630 && INTEGERP (Vauto_save_timeout)
2631 && XINT (Vauto_save_timeout) > 0)
2633 Lisp_Object tem0;
2634 int timeout = delay_level * XFASTINT (Vauto_save_timeout) / 4;
2636 save_getcjmp (save_jump);
2637 restore_getcjmp (local_getcjmp);
2638 tem0 = sit_for (make_number (timeout), 1, 1);
2639 restore_getcjmp (save_jump);
2641 if (EQ (tem0, Qt)
2642 && ! CONSP (Vunread_command_events))
2644 Fdo_auto_save (Qnil, Qnil);
2646 /* If we have auto-saved and there is still no input
2647 available, garbage collect if there has been enough
2648 consing going on to make it worthwhile. */
2649 if (!detect_input_pending_run_timers (0)
2650 && consing_since_gc > gc_cons_threshold / 2)
2651 Fgarbage_collect ();
2653 redisplay ();
2658 /* Notify the caller if an autosave hook, or a timer, sentinel or
2659 filter in the sit_for calls above have changed the current
2660 kboard. This could happen if they use the minibuffer or start a
2661 recursive edit, like the fancy splash screen in server.el's
2662 filter. If this longjmp wasn't here, read_key_sequence would
2663 interpret the next key sequence using the wrong translation
2664 tables and function keymaps. */
2665 if (NILP (c) && current_kboard != orig_kboard)
2667 UNGCPRO;
2668 return make_number (-2); /* wrong_kboard_jmpbuf */
2671 /* If this has become non-nil here, it has been set by a timer
2672 or sentinel or filter. */
2673 if (CONSP (Vunread_command_events))
2675 c = XCAR (Vunread_command_events);
2676 Vunread_command_events = XCDR (Vunread_command_events);
2679 /* Read something from current KBOARD's side queue, if possible. */
2681 if (NILP (c))
2683 if (current_kboard->kbd_queue_has_data)
2685 if (!CONSP (KVAR (current_kboard, kbd_queue)))
2686 abort ();
2687 c = XCAR (KVAR (current_kboard, kbd_queue));
2688 KVAR (current_kboard, kbd_queue)
2689 = XCDR (KVAR (current_kboard, kbd_queue));
2690 if (NILP (KVAR (current_kboard, kbd_queue)))
2691 current_kboard->kbd_queue_has_data = 0;
2692 input_pending = readable_events (0);
2693 if (EVENT_HAS_PARAMETERS (c)
2694 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qswitch_frame))
2695 internal_last_event_frame = XCAR (XCDR (c));
2696 Vlast_event_frame = internal_last_event_frame;
2700 /* If current_kboard's side queue is empty check the other kboards.
2701 If one of them has data that we have not yet seen here,
2702 switch to it and process the data waiting for it.
2704 Note: if the events queued up for another kboard
2705 have already been seen here, and therefore are not a complete command,
2706 the kbd_queue_has_data field is 0, so we skip that kboard here.
2707 That's to avoid an infinite loop switching between kboards here. */
2708 if (NILP (c) && !single_kboard)
2710 KBOARD *kb;
2711 for (kb = all_kboards; kb; kb = kb->next_kboard)
2712 if (kb->kbd_queue_has_data)
2714 current_kboard = kb;
2715 /* This is going to exit from read_char
2716 so we had better get rid of this frame's stuff. */
2717 UNGCPRO;
2718 return make_number (-2); /* wrong_kboard_jmpbuf */
2722 wrong_kboard:
2724 STOP_POLLING;
2726 /* Finally, we read from the main queue,
2727 and if that gives us something we can't use yet, we put it on the
2728 appropriate side queue and try again. */
2730 if (NILP (c))
2732 KBOARD *kb IF_LINT (= NULL);
2734 if (end_time)
2736 EMACS_TIME now;
2737 EMACS_GET_TIME (now);
2738 if (EMACS_TIME_GE (now, *end_time))
2739 goto exit;
2742 /* Actually read a character, waiting if necessary. */
2743 save_getcjmp (save_jump);
2744 restore_getcjmp (local_getcjmp);
2745 if (!end_time)
2746 timer_start_idle ();
2747 c = kbd_buffer_get_event (&kb, used_mouse_menu, end_time);
2748 restore_getcjmp (save_jump);
2750 if (! NILP (c) && (kb != current_kboard))
2752 Lisp_Object last = KVAR (kb, kbd_queue);
2753 if (CONSP (last))
2755 while (CONSP (XCDR (last)))
2756 last = XCDR (last);
2757 if (!NILP (XCDR (last)))
2758 abort ();
2760 if (!CONSP (last))
2761 KVAR (kb, kbd_queue) = Fcons (c, Qnil);
2762 else
2763 XSETCDR (last, Fcons (c, Qnil));
2764 kb->kbd_queue_has_data = 1;
2765 c = Qnil;
2766 if (single_kboard)
2767 goto wrong_kboard;
2768 current_kboard = kb;
2769 /* This is going to exit from read_char
2770 so we had better get rid of this frame's stuff. */
2771 UNGCPRO;
2772 return make_number (-2);
2776 /* Terminate Emacs in batch mode if at eof. */
2777 if (noninteractive && INTEGERP (c) && XINT (c) < 0)
2778 Fkill_emacs (make_number (1));
2780 if (INTEGERP (c))
2782 /* Add in any extra modifiers, where appropriate. */
2783 if ((extra_keyboard_modifiers & CHAR_CTL)
2784 || ((extra_keyboard_modifiers & 0177) < ' '
2785 && (extra_keyboard_modifiers & 0177) != 0))
2786 XSETINT (c, make_ctrl_char (XINT (c)));
2788 /* Transfer any other modifier bits directly from
2789 extra_keyboard_modifiers to c. Ignore the actual character code
2790 in the low 16 bits of extra_keyboard_modifiers. */
2791 XSETINT (c, XINT (c) | (extra_keyboard_modifiers & ~0xff7f & ~CHAR_CTL));
2794 non_reread:
2796 if (!end_time)
2797 timer_stop_idle ();
2798 RESUME_POLLING;
2800 if (NILP (c))
2802 if (commandflag >= 0
2803 && !input_pending && !detect_input_pending_run_timers (0))
2804 redisplay ();
2806 goto wrong_kboard;
2809 non_reread_1:
2811 /* Buffer switch events are only for internal wakeups
2812 so don't show them to the user.
2813 Also, don't record a key if we already did. */
2814 if (BUFFERP (c) || key_already_recorded)
2815 goto exit;
2817 /* Process special events within read_char
2818 and loop around to read another event. */
2819 save = Vquit_flag;
2820 Vquit_flag = Qnil;
2821 tem = access_keymap (get_keymap (Vspecial_event_map, 0, 1), c, 0, 0, 1);
2822 Vquit_flag = save;
2824 if (!NILP (tem))
2826 struct buffer *prev_buffer = current_buffer;
2827 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2828 int was_locked = single_kboard;
2829 int count = SPECPDL_INDEX ();
2830 record_single_kboard_state ();
2831 #endif
2833 last_input_event = c;
2834 Fcommand_execute (tem, Qnil, Fvector (1, &last_input_event), Qt);
2836 if (CONSP (c) && EQ (XCAR (c), Qselect_window) && !end_time)
2837 /* We stopped being idle for this event; undo that. This
2838 prevents automatic window selection (under
2839 mouse_autoselect_window from acting as a real input event, for
2840 example banishing the mouse under mouse-avoidance-mode. */
2841 timer_resume_idle ();
2843 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2844 /* Resume allowing input from any kboard, if that was true before. */
2845 if (!was_locked)
2846 any_kboard_state ();
2847 unbind_to (count, Qnil);
2848 #endif
2850 if (current_buffer != prev_buffer)
2852 /* The command may have changed the keymaps. Pretend there
2853 is input in another keyboard and return. This will
2854 recalculate keymaps. */
2855 c = make_number (-2);
2856 goto exit;
2858 else
2859 goto retry;
2862 /* Handle things that only apply to characters. */
2863 if (INTEGERP (c))
2865 /* If kbd_buffer_get_event gave us an EOF, return that. */
2866 if (XINT (c) == -1)
2867 goto exit;
2869 if ((STRINGP (KVAR (current_kboard, Vkeyboard_translate_table))
2870 && SCHARS (KVAR (current_kboard, Vkeyboard_translate_table)) > (unsigned) XFASTINT (c))
2871 || (VECTORP (KVAR (current_kboard, Vkeyboard_translate_table))
2872 && XVECTOR (KVAR (current_kboard, Vkeyboard_translate_table))->size > (unsigned) XFASTINT (c))
2873 || (CHAR_TABLE_P (KVAR (current_kboard, Vkeyboard_translate_table))
2874 && CHARACTERP (c)))
2876 Lisp_Object d;
2877 d = Faref (KVAR (current_kboard, Vkeyboard_translate_table), c);
2878 /* nil in keyboard-translate-table means no translation. */
2879 if (!NILP (d))
2880 c = d;
2884 /* If this event is a mouse click in the menu bar,
2885 return just menu-bar for now. Modify the mouse click event
2886 so we won't do this twice, then queue it up. */
2887 if (EVENT_HAS_PARAMETERS (c)
2888 && CONSP (XCDR (c))
2889 && CONSP (EVENT_START (c))
2890 && CONSP (XCDR (EVENT_START (c))))
2892 Lisp_Object posn;
2894 posn = POSN_POSN (EVENT_START (c));
2895 /* Handle menu-bar events:
2896 insert the dummy prefix event `menu-bar'. */
2897 if (EQ (posn, Qmenu_bar) || EQ (posn, Qtool_bar))
2899 /* Change menu-bar to (menu-bar) as the event "position". */
2900 POSN_SET_POSN (EVENT_START (c), Fcons (posn, Qnil));
2902 also_record = c;
2903 Vunread_command_events = Fcons (c, Vunread_command_events);
2904 c = posn;
2908 /* Store these characters into recent_keys, the dribble file if any,
2909 and the keyboard macro being defined, if any. */
2910 record_char (c);
2911 if (! NILP (also_record))
2912 record_char (also_record);
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 && (unsigned) XINT (c) >= ' '
2920 && (unsigned) XINT (c) != 127
2921 && (unsigned) XINT (c) < 256)
2923 previous_echo_area_message = Fcurrent_message ();
2924 Vinput_method_previous_message = previous_echo_area_message;
2927 /* Now wipe the echo area, except for help events which do their
2928 own stuff with the echo area. */
2929 if (!CONSP (c)
2930 || (!(EQ (Qhelp_echo, XCAR (c)))
2931 && !(EQ (Qswitch_frame, XCAR (c)))))
2933 if (!NILP (echo_area_buffer[0]))
2934 safe_run_hooks (Qecho_area_clear_hook);
2935 clear_message (1, 0);
2938 reread_for_input_method:
2939 from_macro:
2940 /* Pass this to the input method, if appropriate. */
2941 if (INTEGERP (c)
2942 && ! NILP (Vinput_method_function)
2943 /* Don't run the input method within a key sequence,
2944 after the first event of the key sequence. */
2945 && NILP (prev_event)
2946 && (unsigned) XINT (c) >= ' '
2947 && (unsigned) XINT (c) != 127
2948 && (unsigned) XINT (c) < 256)
2950 Lisp_Object keys;
2951 int key_count, key_count_reset;
2952 struct gcpro inner_gcpro1;
2953 int count = SPECPDL_INDEX ();
2955 /* Save the echo status. */
2956 int saved_immediate_echo = current_kboard->immediate_echo;
2957 struct kboard *saved_ok_to_echo = ok_to_echo_at_next_pause;
2958 Lisp_Object saved_echo_string = KVAR (current_kboard, echo_string);
2959 int saved_echo_after_prompt = current_kboard->echo_after_prompt;
2961 #if 0
2962 if (before_command_restore_flag)
2964 this_command_key_count = before_command_key_count_1;
2965 if (this_command_key_count < this_single_command_key_start)
2966 this_single_command_key_start = this_command_key_count;
2967 echo_truncate (before_command_echo_length_1);
2968 before_command_restore_flag = 0;
2970 #endif
2972 /* Save the this_command_keys status. */
2973 key_count = this_command_key_count;
2974 key_count_reset = this_command_key_count_reset;
2976 if (key_count > 0)
2977 keys = Fcopy_sequence (this_command_keys);
2978 else
2979 keys = Qnil;
2980 GCPRO1_VAR (keys, inner_gcpro);
2982 /* Clear out this_command_keys. */
2983 this_command_key_count = 0;
2984 this_command_key_count_reset = 0;
2986 /* Now wipe the echo area. */
2987 if (!NILP (echo_area_buffer[0]))
2988 safe_run_hooks (Qecho_area_clear_hook);
2989 clear_message (1, 0);
2990 echo_truncate (0);
2992 /* If we are not reading a key sequence,
2993 never use the echo area. */
2994 if (maps == 0)
2996 specbind (Qinput_method_use_echo_area, Qt);
2999 /* Call the input method. */
3000 tem = call1 (Vinput_method_function, c);
3002 tem = unbind_to (count, tem);
3004 /* Restore the saved echoing state
3005 and this_command_keys state. */
3006 this_command_key_count = key_count;
3007 this_command_key_count_reset = key_count_reset;
3008 if (key_count > 0)
3009 this_command_keys = keys;
3011 cancel_echoing ();
3012 ok_to_echo_at_next_pause = saved_ok_to_echo;
3013 KVAR (current_kboard, echo_string) = saved_echo_string;
3014 current_kboard->echo_after_prompt = saved_echo_after_prompt;
3015 if (saved_immediate_echo)
3016 echo_now ();
3018 UNGCPRO_VAR (inner_gcpro);
3020 /* The input method can return no events. */
3021 if (! CONSP (tem))
3023 /* Bring back the previous message, if any. */
3024 if (! NILP (previous_echo_area_message))
3025 message_with_string ("%s", previous_echo_area_message, 0);
3026 goto retry;
3028 /* It returned one event or more. */
3029 c = XCAR (tem);
3030 Vunread_post_input_method_events
3031 = nconc2 (XCDR (tem), Vunread_post_input_method_events);
3034 reread_first:
3036 /* Display help if not echoing. */
3037 if (CONSP (c) && EQ (XCAR (c), Qhelp_echo))
3039 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3040 Lisp_Object help, object, position, window, htem;
3042 htem = Fcdr (XCDR (c));
3043 help = Fcar (htem);
3044 htem = Fcdr (htem);
3045 window = Fcar (htem);
3046 htem = Fcdr (htem);
3047 object = Fcar (htem);
3048 htem = Fcdr (htem);
3049 position = Fcar (htem);
3051 show_help_echo (help, window, object, position);
3053 /* We stopped being idle for this event; undo that. */
3054 if (!end_time)
3055 timer_resume_idle ();
3056 goto retry;
3059 if ((! reread || this_command_key_count == 0
3060 || this_command_key_count_reset)
3061 && !end_time)
3064 /* Don't echo mouse motion events. */
3065 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
3066 && NILP (Fzerop (Vecho_keystrokes))
3067 && ! (EVENT_HAS_PARAMETERS (c)
3068 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
3070 echo_char (c);
3071 if (! NILP (also_record))
3072 echo_char (also_record);
3073 /* Once we reread a character, echoing can happen
3074 the next time we pause to read a new one. */
3075 ok_to_echo_at_next_pause = current_kboard;
3078 /* Record this character as part of the current key. */
3079 add_command_key (c);
3080 if (! NILP (also_record))
3081 add_command_key (also_record);
3084 last_input_event = c;
3085 num_input_events++;
3087 /* Process the help character specially if enabled */
3088 if (!NILP (Vhelp_form) && help_char_p (c))
3090 Lisp_Object tem0;
3091 int count = SPECPDL_INDEX ();
3093 help_form_saved_window_configs
3094 = Fcons (Fcurrent_window_configuration (Qnil),
3095 help_form_saved_window_configs);
3096 record_unwind_protect (read_char_help_form_unwind, Qnil);
3098 tem0 = Feval (Vhelp_form, Qnil);
3099 if (STRINGP (tem0))
3100 internal_with_output_to_temp_buffer ("*Help*", print_help, tem0);
3102 cancel_echoing ();
3105 c = read_char (0, 0, 0, Qnil, 0, NULL);
3106 if (EVENT_HAS_PARAMETERS (c)
3107 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_click))
3108 XSETCAR (help_form_saved_window_configs, Qnil);
3110 while (BUFFERP (c));
3111 /* Remove the help from the frame */
3112 unbind_to (count, Qnil);
3114 redisplay ();
3115 if (EQ (c, make_number (040)))
3117 cancel_echoing ();
3119 c = read_char (0, 0, 0, Qnil, 0, NULL);
3120 while (BUFFERP (c));
3124 exit:
3125 RESUME_POLLING;
3126 RETURN_UNGCPRO (c);
3129 /* Record a key that came from a mouse menu.
3130 Record it for echoing, for this-command-keys, and so on. */
3132 static void
3133 record_menu_key (Lisp_Object c)
3135 /* Wipe the echo area. */
3136 clear_message (1, 0);
3138 record_char (c);
3140 #if 0
3141 before_command_key_count = this_command_key_count;
3142 before_command_echo_length = echo_length ();
3143 #endif
3145 /* Don't echo mouse motion events. */
3146 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
3147 && NILP (Fzerop (Vecho_keystrokes)))
3149 echo_char (c);
3151 /* Once we reread a character, echoing can happen
3152 the next time we pause to read a new one. */
3153 ok_to_echo_at_next_pause = 0;
3156 /* Record this character as part of the current key. */
3157 add_command_key (c);
3159 /* Re-reading in the middle of a command */
3160 last_input_event = c;
3161 num_input_events++;
3164 /* Return 1 if should recognize C as "the help character". */
3167 help_char_p (Lisp_Object c)
3169 Lisp_Object tail;
3171 if (EQ (c, Vhelp_char))
3172 return 1;
3173 for (tail = Vhelp_event_list; CONSP (tail); tail = XCDR (tail))
3174 if (EQ (c, XCAR (tail)))
3175 return 1;
3176 return 0;
3179 /* Record the input event C in various ways. */
3181 static void
3182 record_char (Lisp_Object c)
3184 int recorded = 0;
3186 if (CONSP (c) && (EQ (XCAR (c), Qhelp_echo) || EQ (XCAR (c), Qmouse_movement)))
3188 /* To avoid filling recent_keys with help-echo and mouse-movement
3189 events, we filter out repeated help-echo events, only store the
3190 first and last in a series of mouse-movement events, and don't
3191 store repeated help-echo events which are only separated by
3192 mouse-movement events. */
3194 Lisp_Object ev1, ev2, ev3;
3195 int ix1, ix2, ix3;
3197 if ((ix1 = recent_keys_index - 1) < 0)
3198 ix1 = NUM_RECENT_KEYS - 1;
3199 ev1 = AREF (recent_keys, ix1);
3201 if ((ix2 = ix1 - 1) < 0)
3202 ix2 = NUM_RECENT_KEYS - 1;
3203 ev2 = AREF (recent_keys, ix2);
3205 if ((ix3 = ix2 - 1) < 0)
3206 ix3 = NUM_RECENT_KEYS - 1;
3207 ev3 = AREF (recent_keys, ix3);
3209 if (EQ (XCAR (c), Qhelp_echo))
3211 /* Don't record `help-echo' in recent_keys unless it shows some help
3212 message, and a different help than the previously recorded
3213 event. */
3214 Lisp_Object help, last_help;
3216 help = Fcar_safe (Fcdr_safe (XCDR (c)));
3217 if (!STRINGP (help))
3218 recorded = 1;
3219 else if (CONSP (ev1) && EQ (XCAR (ev1), Qhelp_echo)
3220 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev1))), EQ (last_help, help)))
3221 recorded = 1;
3222 else if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3223 && CONSP (ev2) && EQ (XCAR (ev2), Qhelp_echo)
3224 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev2))), EQ (last_help, help)))
3225 recorded = -1;
3226 else if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3227 && CONSP (ev2) && EQ (XCAR (ev2), Qmouse_movement)
3228 && CONSP (ev3) && EQ (XCAR (ev3), Qhelp_echo)
3229 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev3))), EQ (last_help, help)))
3230 recorded = -2;
3232 else if (EQ (XCAR (c), Qmouse_movement))
3234 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3235 So additional mouse movement events replace the last element. */
3236 Lisp_Object last_window, window;
3238 window = Fcar_safe (Fcar_safe (XCDR (c)));
3239 if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3240 && (last_window = Fcar_safe (Fcar_safe (XCDR (ev1))), EQ (last_window, window))
3241 && CONSP (ev2) && EQ (XCAR (ev2), Qmouse_movement)
3242 && (last_window = Fcar_safe (Fcar_safe (XCDR (ev2))), EQ (last_window, window)))
3244 ASET (recent_keys, ix1, c);
3245 recorded = 1;
3249 else
3250 store_kbd_macro_char (c);
3252 if (!recorded)
3254 total_keys++;
3255 ASET (recent_keys, recent_keys_index, c);
3256 if (++recent_keys_index >= NUM_RECENT_KEYS)
3257 recent_keys_index = 0;
3259 else if (recorded < 0)
3261 /* We need to remove one or two events from recent_keys.
3262 To do this, we simply put nil at those events and move the
3263 recent_keys_index backwards over those events. Usually,
3264 users will never see those nil events, as they will be
3265 overwritten by the command keys entered to see recent_keys
3266 (e.g. C-h l). */
3268 while (recorded++ < 0 && total_keys > 0)
3270 if (total_keys < NUM_RECENT_KEYS)
3271 total_keys--;
3272 if (--recent_keys_index < 0)
3273 recent_keys_index = NUM_RECENT_KEYS - 1;
3274 ASET (recent_keys, recent_keys_index, Qnil);
3278 num_nonmacro_input_events++;
3280 /* Write c to the dribble file. If c is a lispy event, write
3281 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3282 If you, dear reader, have a better idea, you've got the source. :-) */
3283 if (dribble)
3285 BLOCK_INPUT;
3286 if (INTEGERP (c))
3288 if (XUINT (c) < 0x100)
3289 putc (XINT (c), dribble);
3290 else
3291 fprintf (dribble, " 0x%x", (int) XUINT (c));
3293 else
3295 Lisp_Object dribblee;
3297 /* If it's a structured event, take the event header. */
3298 dribblee = EVENT_HEAD (c);
3300 if (SYMBOLP (dribblee))
3302 putc ('<', dribble);
3303 fwrite (SDATA (SYMBOL_NAME (dribblee)), sizeof (char),
3304 SBYTES (SYMBOL_NAME (dribblee)),
3305 dribble);
3306 putc ('>', dribble);
3310 fflush (dribble);
3311 UNBLOCK_INPUT;
3315 Lisp_Object
3316 print_help (Lisp_Object object)
3318 struct buffer *old = current_buffer;
3319 Fprinc (object, Qnil);
3320 set_buffer_internal (XBUFFER (Vstandard_output));
3321 call0 (intern ("help-mode"));
3322 set_buffer_internal (old);
3323 return Qnil;
3326 /* Copy out or in the info on where C-g should throw to.
3327 This is used when running Lisp code from within get_char,
3328 in case get_char is called recursively.
3329 See read_process_output. */
3331 static void
3332 save_getcjmp (jmp_buf temp)
3334 memcpy (temp, getcjmp, sizeof getcjmp);
3337 static void
3338 restore_getcjmp (jmp_buf temp)
3340 memcpy (getcjmp, temp, sizeof getcjmp);
3343 /* Low level keyboard/mouse input.
3344 kbd_buffer_store_event places events in kbd_buffer, and
3345 kbd_buffer_get_event retrieves them. */
3347 /* Return true if there are any events in the queue that read-char
3348 would return. If this returns false, a read-char would block. */
3349 static int
3350 readable_events (int flags)
3352 if (flags & READABLE_EVENTS_DO_TIMERS_NOW)
3353 timer_check ();
3355 /* If the buffer contains only FOCUS_IN_EVENT events, and
3356 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3357 if (kbd_fetch_ptr != kbd_store_ptr)
3359 if (flags & (READABLE_EVENTS_FILTER_EVENTS
3360 #ifdef USE_TOOLKIT_SCROLL_BARS
3361 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3362 #endif
3365 struct input_event *event;
3367 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
3368 ? kbd_fetch_ptr
3369 : kbd_buffer);
3373 if (!(
3374 #ifdef USE_TOOLKIT_SCROLL_BARS
3375 (flags & READABLE_EVENTS_FILTER_EVENTS) &&
3376 #endif
3377 event->kind == FOCUS_IN_EVENT)
3378 #ifdef USE_TOOLKIT_SCROLL_BARS
3379 && !((flags & READABLE_EVENTS_IGNORE_SQUEEZABLES)
3380 && event->kind == SCROLL_BAR_CLICK_EVENT
3381 && event->part == scroll_bar_handle
3382 && event->modifiers == 0)
3383 #endif
3385 return 1;
3386 event++;
3387 if (event == kbd_buffer + KBD_BUFFER_SIZE)
3388 event = kbd_buffer;
3390 while (event != kbd_store_ptr);
3392 else
3393 return 1;
3396 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3397 if (!(flags & READABLE_EVENTS_IGNORE_SQUEEZABLES)
3398 && !NILP (do_mouse_tracking) && some_mouse_moved ())
3399 return 1;
3400 #endif
3401 if (single_kboard)
3403 if (current_kboard->kbd_queue_has_data)
3404 return 1;
3406 else
3408 KBOARD *kb;
3409 for (kb = all_kboards; kb; kb = kb->next_kboard)
3410 if (kb->kbd_queue_has_data)
3411 return 1;
3413 return 0;
3416 /* Set this for debugging, to have a way to get out */
3417 int stop_character;
3419 static KBOARD *
3420 event_to_kboard (struct input_event *event)
3422 Lisp_Object frame;
3423 frame = event->frame_or_window;
3424 if (CONSP (frame))
3425 frame = XCAR (frame);
3426 else if (WINDOWP (frame))
3427 frame = WINDOW_FRAME (XWINDOW (frame));
3429 /* There are still some events that don't set this field.
3430 For now, just ignore the problem.
3431 Also ignore dead frames here. */
3432 if (!FRAMEP (frame) || !FRAME_LIVE_P (XFRAME (frame)))
3433 return 0;
3434 else
3435 return FRAME_KBOARD (XFRAME (frame));
3438 #ifdef subprocesses
3439 /* Return the number of slots occupied in kbd_buffer. */
3441 static int
3442 kbd_buffer_nr_stored (void)
3444 return kbd_fetch_ptr == kbd_store_ptr
3446 : (kbd_fetch_ptr < kbd_store_ptr
3447 ? kbd_store_ptr - kbd_fetch_ptr
3448 : ((kbd_buffer + KBD_BUFFER_SIZE) - kbd_fetch_ptr
3449 + (kbd_store_ptr - kbd_buffer)));
3451 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3453 void
3454 kbd_buffer_store_event (register struct input_event *event)
3456 kbd_buffer_store_event_hold (event, 0);
3459 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3461 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3462 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3463 Else, if EVENT is a quit event, store the quit event
3464 in HOLD_QUIT, and return (thus ignoring further events).
3466 This is used in read_avail_input to postpone the processing
3467 of the quit event until all subsequent input events have been
3468 parsed (and discarded).
3471 void
3472 kbd_buffer_store_event_hold (register struct input_event *event,
3473 struct input_event *hold_quit)
3475 if (event->kind == NO_EVENT)
3476 abort ();
3478 if (hold_quit && hold_quit->kind != NO_EVENT)
3479 return;
3481 if (event->kind == ASCII_KEYSTROKE_EVENT)
3483 register int c = event->code & 0377;
3485 if (event->modifiers & ctrl_modifier)
3486 c = make_ctrl_char (c);
3488 c |= (event->modifiers
3489 & (meta_modifier | alt_modifier
3490 | hyper_modifier | super_modifier));
3492 if (c == quit_char)
3494 KBOARD *kb = FRAME_KBOARD (XFRAME (event->frame_or_window));
3495 struct input_event *sp;
3497 if (single_kboard && kb != current_kboard)
3499 KVAR (kb, kbd_queue)
3500 = Fcons (make_lispy_switch_frame (event->frame_or_window),
3501 Fcons (make_number (c), Qnil));
3502 kb->kbd_queue_has_data = 1;
3503 for (sp = kbd_fetch_ptr; sp != kbd_store_ptr; sp++)
3505 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3506 sp = kbd_buffer;
3508 if (event_to_kboard (sp) == kb)
3510 sp->kind = NO_EVENT;
3511 sp->frame_or_window = Qnil;
3512 sp->arg = Qnil;
3515 return;
3518 if (hold_quit)
3520 memcpy (hold_quit, event, sizeof (*event));
3521 return;
3524 /* If this results in a quit_char being returned to Emacs as
3525 input, set Vlast_event_frame properly. If this doesn't
3526 get returned to Emacs as an event, the next event read
3527 will set Vlast_event_frame again, so this is safe to do. */
3529 Lisp_Object focus;
3531 focus = FRAME_FOCUS_FRAME (XFRAME (event->frame_or_window));
3532 if (NILP (focus))
3533 focus = event->frame_or_window;
3534 internal_last_event_frame = focus;
3535 Vlast_event_frame = focus;
3538 last_event_timestamp = event->timestamp;
3539 handle_interrupt ();
3540 return;
3543 if (c && c == stop_character)
3545 sys_suspend ();
3546 return;
3549 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3550 Just ignore the second one. */
3551 else if (event->kind == BUFFER_SWITCH_EVENT
3552 && kbd_fetch_ptr != kbd_store_ptr
3553 && ((kbd_store_ptr == kbd_buffer
3554 ? kbd_buffer + KBD_BUFFER_SIZE - 1
3555 : kbd_store_ptr - 1)->kind) == BUFFER_SWITCH_EVENT)
3556 return;
3558 if (kbd_store_ptr - kbd_buffer == KBD_BUFFER_SIZE)
3559 kbd_store_ptr = kbd_buffer;
3561 /* Don't let the very last slot in the buffer become full,
3562 since that would make the two pointers equal,
3563 and that is indistinguishable from an empty buffer.
3564 Discard the event if it would fill the last slot. */
3565 if (kbd_fetch_ptr - 1 != kbd_store_ptr)
3567 *kbd_store_ptr = *event;
3568 ++kbd_store_ptr;
3569 #ifdef subprocesses
3570 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE/2 && ! kbd_on_hold_p ())
3572 /* Don't read keyboard input until we have processed kbd_buffer.
3573 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3574 hold_keyboard_input ();
3575 #ifdef SIGIO
3576 if (!noninteractive)
3577 signal (SIGIO, SIG_IGN);
3578 #endif
3579 stop_polling ();
3581 #endif /* subprocesses */
3584 /* If we're inside while-no-input, and this event qualifies
3585 as input, set quit-flag to cause an interrupt. */
3586 if (!NILP (Vthrow_on_input)
3587 && event->kind != FOCUS_IN_EVENT
3588 && event->kind != HELP_EVENT
3589 && event->kind != DEICONIFY_EVENT)
3591 Vquit_flag = Vthrow_on_input;
3592 /* If we're inside a function that wants immediate quits,
3593 do it now. */
3594 if (immediate_quit && NILP (Vinhibit_quit))
3596 immediate_quit = 0;
3597 sigfree ();
3598 QUIT;
3604 /* Put an input event back in the head of the event queue. */
3606 void
3607 kbd_buffer_unget_event (register struct input_event *event)
3609 if (kbd_fetch_ptr == kbd_buffer)
3610 kbd_fetch_ptr = kbd_buffer + KBD_BUFFER_SIZE;
3612 /* Don't let the very last slot in the buffer become full, */
3613 if (kbd_fetch_ptr - 1 != kbd_store_ptr)
3615 --kbd_fetch_ptr;
3616 *kbd_fetch_ptr = *event;
3621 /* Generate a HELP_EVENT input_event and store it in the keyboard
3622 buffer.
3624 HELP is the help form.
3626 FRAME and WINDOW are the frame and window where the help is
3627 generated. OBJECT is the Lisp object where the help was found (a
3628 buffer, a string, an overlay, or nil if neither from a string nor
3629 from a buffer). POS is the position within OBJECT where the help
3630 was found. */
3632 void
3633 gen_help_event (Lisp_Object help, Lisp_Object frame, Lisp_Object window,
3634 Lisp_Object object, EMACS_INT pos)
3636 struct input_event event;
3638 EVENT_INIT (event);
3640 event.kind = HELP_EVENT;
3641 event.frame_or_window = frame;
3642 event.arg = object;
3643 event.x = WINDOWP (window) ? window : frame;
3644 event.y = help;
3645 event.code = pos;
3646 kbd_buffer_store_event (&event);
3650 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3652 void
3653 kbd_buffer_store_help_event (Lisp_Object frame, Lisp_Object help)
3655 struct input_event event;
3657 event.kind = HELP_EVENT;
3658 event.frame_or_window = frame;
3659 event.arg = Qnil;
3660 event.x = Qnil;
3661 event.y = help;
3662 event.code = 0;
3663 kbd_buffer_store_event (&event);
3667 /* Discard any mouse events in the event buffer by setting them to
3668 NO_EVENT. */
3669 void
3670 discard_mouse_events (void)
3672 struct input_event *sp;
3673 for (sp = kbd_fetch_ptr; sp != kbd_store_ptr; sp++)
3675 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3676 sp = kbd_buffer;
3678 if (sp->kind == MOUSE_CLICK_EVENT
3679 || sp->kind == WHEEL_EVENT
3680 || sp->kind == HORIZ_WHEEL_EVENT
3681 #ifdef HAVE_GPM
3682 || sp->kind == GPM_CLICK_EVENT
3683 #endif
3684 || sp->kind == SCROLL_BAR_CLICK_EVENT)
3686 sp->kind = NO_EVENT;
3692 /* Return non-zero if there are any real events waiting in the event
3693 buffer, not counting `NO_EVENT's.
3695 If DISCARD is non-zero, discard NO_EVENT events at the front of
3696 the input queue, possibly leaving the input queue empty if there
3697 are no real input events. */
3700 kbd_buffer_events_waiting (int discard)
3702 struct input_event *sp;
3704 for (sp = kbd_fetch_ptr;
3705 sp != kbd_store_ptr && sp->kind == NO_EVENT;
3706 ++sp)
3708 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3709 sp = kbd_buffer;
3712 if (discard)
3713 kbd_fetch_ptr = sp;
3715 return sp != kbd_store_ptr && sp->kind != NO_EVENT;
3719 /* Clear input event EVENT. */
3721 static INLINE void
3722 clear_event (struct input_event *event)
3724 event->kind = NO_EVENT;
3728 /* Read one event from the event buffer, waiting if necessary.
3729 The value is a Lisp object representing the event.
3730 The value is nil for an event that should be ignored,
3731 or that was handled here.
3732 We always read and discard one event. */
3734 static Lisp_Object
3735 kbd_buffer_get_event (KBOARD **kbp,
3736 int *used_mouse_menu,
3737 struct timeval *end_time)
3739 register int c;
3740 Lisp_Object obj;
3742 #ifdef subprocesses
3743 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE/4)
3745 /* Start reading input again, we have processed enough so we can
3746 accept new events again. */
3747 unhold_keyboard_input ();
3748 #ifdef SIGIO
3749 if (!noninteractive)
3750 signal (SIGIO, input_available_signal);
3751 #endif /* SIGIO */
3752 start_polling ();
3754 #endif /* subprocesses */
3756 if (noninteractive
3757 /* In case we are running as a daemon, only do this before
3758 detaching from the terminal. */
3759 || (IS_DAEMON && daemon_pipe[1] >= 0))
3761 c = getchar ();
3762 XSETINT (obj, c);
3763 *kbp = current_kboard;
3764 return obj;
3767 /* Wait until there is input available. */
3768 for (;;)
3770 /* Break loop if there's an unread command event. Needed in
3771 moused window autoselection which uses a timer to insert such
3772 events. */
3773 if (CONSP (Vunread_command_events))
3774 break;
3776 if (kbd_fetch_ptr != kbd_store_ptr)
3777 break;
3778 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3779 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
3780 break;
3781 #endif
3783 /* If the quit flag is set, then read_char will return
3784 quit_char, so that counts as "available input." */
3785 if (!NILP (Vquit_flag))
3786 quit_throw_to_read_char ();
3788 /* One way or another, wait until input is available; then, if
3789 interrupt handlers have not read it, read it now. */
3791 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3792 #ifdef SIGIO
3793 gobble_input (0);
3794 #endif /* SIGIO */
3795 if (kbd_fetch_ptr != kbd_store_ptr)
3796 break;
3797 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3798 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
3799 break;
3800 #endif
3801 if (end_time)
3803 EMACS_TIME duration;
3804 EMACS_GET_TIME (duration);
3805 if (EMACS_TIME_GE (duration, *end_time))
3806 return Qnil; /* finished waiting */
3807 else
3809 EMACS_SUB_TIME (duration, *end_time, duration);
3810 wait_reading_process_output (EMACS_SECS (duration),
3811 EMACS_USECS (duration),
3812 -1, 1, Qnil, NULL, 0);
3815 else
3816 wait_reading_process_output (0, 0, -1, 1, Qnil, NULL, 0);
3818 if (!interrupt_input && kbd_fetch_ptr == kbd_store_ptr)
3819 /* Pass 1 for EXPECT since we just waited to have input. */
3820 read_avail_input (1);
3823 if (CONSP (Vunread_command_events))
3825 Lisp_Object first;
3826 first = XCAR (Vunread_command_events);
3827 Vunread_command_events = XCDR (Vunread_command_events);
3828 *kbp = current_kboard;
3829 return first;
3832 /* At this point, we know that there is a readable event available
3833 somewhere. If the event queue is empty, then there must be a
3834 mouse movement enabled and available. */
3835 if (kbd_fetch_ptr != kbd_store_ptr)
3837 struct input_event *event;
3839 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
3840 ? kbd_fetch_ptr
3841 : kbd_buffer);
3843 last_event_timestamp = event->timestamp;
3845 *kbp = event_to_kboard (event);
3846 if (*kbp == 0)
3847 *kbp = current_kboard; /* Better than returning null ptr? */
3849 obj = Qnil;
3851 /* These two kinds of events get special handling
3852 and don't actually appear to the command loop.
3853 We return nil for them. */
3854 if (event->kind == SELECTION_REQUEST_EVENT
3855 || event->kind == SELECTION_CLEAR_EVENT)
3857 #ifdef HAVE_X11
3858 struct input_event copy;
3860 /* Remove it from the buffer before processing it,
3861 since otherwise swallow_events will see it
3862 and process it again. */
3863 copy = *event;
3864 kbd_fetch_ptr = event + 1;
3865 input_pending = readable_events (0);
3866 x_handle_selection_event (&copy);
3867 #else
3868 /* We're getting selection request events, but we don't have
3869 a window system. */
3870 abort ();
3871 #endif
3874 #if defined (HAVE_NS)
3875 else if (event->kind == NS_TEXT_EVENT)
3877 if (event->code == KEY_NS_PUT_WORKING_TEXT)
3878 obj = Fcons (intern ("ns-put-working-text"), Qnil);
3879 else
3880 obj = Fcons (intern ("ns-unput-working-text"), Qnil);
3881 kbd_fetch_ptr = event + 1;
3882 if (used_mouse_menu)
3883 *used_mouse_menu = 1;
3885 #endif
3887 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3888 || defined (HAVE_NS)
3889 else if (event->kind == DELETE_WINDOW_EVENT)
3891 /* Make an event (delete-frame (FRAME)). */
3892 obj = Fcons (event->frame_or_window, Qnil);
3893 obj = Fcons (Qdelete_frame, Fcons (obj, Qnil));
3894 kbd_fetch_ptr = event + 1;
3896 #endif
3897 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3898 || defined (HAVE_NS)
3899 else if (event->kind == ICONIFY_EVENT)
3901 /* Make an event (iconify-frame (FRAME)). */
3902 obj = Fcons (event->frame_or_window, Qnil);
3903 obj = Fcons (Qiconify_frame, Fcons (obj, Qnil));
3904 kbd_fetch_ptr = event + 1;
3906 else if (event->kind == DEICONIFY_EVENT)
3908 /* Make an event (make-frame-visible (FRAME)). */
3909 obj = Fcons (event->frame_or_window, Qnil);
3910 obj = Fcons (Qmake_frame_visible, Fcons (obj, Qnil));
3911 kbd_fetch_ptr = event + 1;
3913 #endif
3914 else if (event->kind == BUFFER_SWITCH_EVENT)
3916 /* The value doesn't matter here; only the type is tested. */
3917 XSETBUFFER (obj, current_buffer);
3918 kbd_fetch_ptr = event + 1;
3920 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3921 || defined(HAVE_NS) || defined (USE_GTK)
3922 else if (event->kind == MENU_BAR_ACTIVATE_EVENT)
3924 kbd_fetch_ptr = event + 1;
3925 input_pending = readable_events (0);
3926 if (FRAME_LIVE_P (XFRAME (event->frame_or_window)))
3927 x_activate_menubar (XFRAME (event->frame_or_window));
3929 #endif
3930 #if defined (WINDOWSNT)
3931 else if (event->kind == LANGUAGE_CHANGE_EVENT)
3933 /* Make an event (language-change (FRAME CHARSET LCID)). */
3934 obj = Fcons (event->frame_or_window, Qnil);
3935 obj = Fcons (Qlanguage_change, Fcons (obj, Qnil));
3936 kbd_fetch_ptr = event + 1;
3938 #endif
3939 else if (event->kind == SAVE_SESSION_EVENT)
3941 obj = Fcons (Qsave_session, Fcons (event->arg, Qnil));
3942 kbd_fetch_ptr = event + 1;
3944 /* Just discard these, by returning nil.
3945 With MULTI_KBOARD, these events are used as placeholders
3946 when we need to randomly delete events from the queue.
3947 (They shouldn't otherwise be found in the buffer,
3948 but on some machines it appears they do show up
3949 even without MULTI_KBOARD.) */
3950 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3951 mouse events during a popup-menu call. */
3952 else if (event->kind == NO_EVENT)
3953 kbd_fetch_ptr = event + 1;
3954 else if (event->kind == HELP_EVENT)
3956 Lisp_Object object, position, help, frame, window;
3958 frame = event->frame_or_window;
3959 object = event->arg;
3960 position = make_number (event->code);
3961 window = event->x;
3962 help = event->y;
3963 clear_event (event);
3965 kbd_fetch_ptr = event + 1;
3966 if (!WINDOWP (window))
3967 window = Qnil;
3968 obj = Fcons (Qhelp_echo,
3969 list5 (frame, help, window, object, position));
3971 else if (event->kind == FOCUS_IN_EVENT)
3973 /* Notification of a FocusIn event. The frame receiving the
3974 focus is in event->frame_or_window. Generate a
3975 switch-frame event if necessary. */
3976 Lisp_Object frame, focus;
3978 frame = event->frame_or_window;
3979 focus = FRAME_FOCUS_FRAME (XFRAME (frame));
3980 if (FRAMEP (focus))
3981 frame = focus;
3983 if (!EQ (frame, internal_last_event_frame)
3984 && !EQ (frame, selected_frame))
3985 obj = make_lispy_switch_frame (frame);
3986 internal_last_event_frame = frame;
3987 kbd_fetch_ptr = event + 1;
3989 #ifdef HAVE_DBUS
3990 else if (event->kind == DBUS_EVENT)
3992 obj = make_lispy_event (event);
3993 kbd_fetch_ptr = event + 1;
3995 #endif
3996 else if (event->kind == CONFIG_CHANGED_EVENT)
3998 obj = make_lispy_event (event);
3999 kbd_fetch_ptr = event + 1;
4001 else
4003 /* If this event is on a different frame, return a switch-frame this
4004 time, and leave the event in the queue for next time. */
4005 Lisp_Object frame;
4006 Lisp_Object focus;
4008 frame = event->frame_or_window;
4009 if (CONSP (frame))
4010 frame = XCAR (frame);
4011 else if (WINDOWP (frame))
4012 frame = WINDOW_FRAME (XWINDOW (frame));
4014 focus = FRAME_FOCUS_FRAME (XFRAME (frame));
4015 if (! NILP (focus))
4016 frame = focus;
4018 if (! EQ (frame, internal_last_event_frame)
4019 && !EQ (frame, selected_frame))
4020 obj = make_lispy_switch_frame (frame);
4021 internal_last_event_frame = frame;
4023 /* If we didn't decide to make a switch-frame event, go ahead
4024 and build a real event from the queue entry. */
4026 if (NILP (obj))
4028 obj = make_lispy_event (event);
4030 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4031 || defined(HAVE_NS) || defined (USE_GTK)
4032 /* If this was a menu selection, then set the flag to inhibit
4033 writing to last_nonmenu_event. Don't do this if the event
4034 we're returning is (menu-bar), though; that indicates the
4035 beginning of the menu sequence, and we might as well leave
4036 that as the `event with parameters' for this selection. */
4037 if (used_mouse_menu
4038 && !EQ (event->frame_or_window, event->arg)
4039 && (event->kind == MENU_BAR_EVENT
4040 || event->kind == TOOL_BAR_EVENT))
4041 *used_mouse_menu = 1;
4042 #endif
4043 #ifdef HAVE_NS
4044 /* certain system events are non-key events */
4045 if (used_mouse_menu
4046 && event->kind == NS_NONKEY_EVENT)
4047 *used_mouse_menu = 1;
4048 #endif
4050 /* Wipe out this event, to catch bugs. */
4051 clear_event (event);
4052 kbd_fetch_ptr = event + 1;
4056 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4057 /* Try generating a mouse motion event. */
4058 else if (!NILP (do_mouse_tracking) && some_mouse_moved ())
4060 FRAME_PTR f = some_mouse_moved ();
4061 Lisp_Object bar_window;
4062 enum scroll_bar_part part;
4063 Lisp_Object x, y;
4064 unsigned long t;
4066 *kbp = current_kboard;
4067 /* Note that this uses F to determine which terminal to look at.
4068 If there is no valid info, it does not store anything
4069 so x remains nil. */
4070 x = Qnil;
4072 /* XXX Can f or mouse_position_hook be NULL here? */
4073 if (f && FRAME_TERMINAL (f)->mouse_position_hook)
4074 (*FRAME_TERMINAL (f)->mouse_position_hook) (&f, 0, &bar_window,
4075 &part, &x, &y, &t);
4077 obj = Qnil;
4079 /* Decide if we should generate a switch-frame event. Don't
4080 generate switch-frame events for motion outside of all Emacs
4081 frames. */
4082 if (!NILP (x) && f)
4084 Lisp_Object frame;
4086 frame = FRAME_FOCUS_FRAME (f);
4087 if (NILP (frame))
4088 XSETFRAME (frame, f);
4090 if (! EQ (frame, internal_last_event_frame)
4091 && !EQ (frame, selected_frame))
4092 obj = make_lispy_switch_frame (frame);
4093 internal_last_event_frame = frame;
4096 /* If we didn't decide to make a switch-frame event, go ahead and
4097 return a mouse-motion event. */
4098 if (!NILP (x) && NILP (obj))
4099 obj = make_lispy_movement (f, bar_window, part, x, y, t);
4101 #endif /* HAVE_MOUSE || HAVE GPM */
4102 else
4103 /* We were promised by the above while loop that there was
4104 something for us to read! */
4105 abort ();
4107 input_pending = readable_events (0);
4109 Vlast_event_frame = internal_last_event_frame;
4111 return (obj);
4114 /* Process any events that are not user-visible,
4115 then return, without reading any user-visible events. */
4117 void
4118 swallow_events (int do_display)
4120 int old_timers_run;
4122 while (kbd_fetch_ptr != kbd_store_ptr)
4124 struct input_event *event;
4126 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
4127 ? kbd_fetch_ptr
4128 : kbd_buffer);
4130 last_event_timestamp = event->timestamp;
4132 /* These two kinds of events get special handling
4133 and don't actually appear to the command loop. */
4134 if (event->kind == SELECTION_REQUEST_EVENT
4135 || event->kind == SELECTION_CLEAR_EVENT)
4137 #ifdef HAVE_X11
4138 struct input_event copy;
4140 /* Remove it from the buffer before processing it,
4141 since otherwise swallow_events called recursively could see it
4142 and process it again. */
4143 copy = *event;
4144 kbd_fetch_ptr = event + 1;
4145 input_pending = readable_events (0);
4146 x_handle_selection_event (&copy);
4147 #else
4148 /* We're getting selection request events, but we don't have
4149 a window system. */
4150 abort ();
4151 #endif
4153 else
4154 break;
4157 old_timers_run = timers_run;
4158 get_input_pending (&input_pending, READABLE_EVENTS_DO_TIMERS_NOW);
4160 if (timers_run != old_timers_run && do_display)
4161 redisplay_preserve_echo_area (7);
4164 /* Record the start of when Emacs is idle,
4165 for the sake of running idle-time timers. */
4167 static void
4168 timer_start_idle (void)
4170 Lisp_Object timers;
4172 /* If we are already in the idle state, do nothing. */
4173 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4174 return;
4176 EMACS_GET_TIME (timer_idleness_start_time);
4178 timer_last_idleness_start_time = timer_idleness_start_time;
4180 /* Mark all idle-time timers as once again candidates for running. */
4181 for (timers = Vtimer_idle_list; CONSP (timers); timers = XCDR (timers))
4183 Lisp_Object timer;
4185 timer = XCAR (timers);
4187 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
4188 continue;
4189 XVECTOR (timer)->contents[0] = Qnil;
4193 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4195 static void
4196 timer_stop_idle (void)
4198 EMACS_SET_SECS_USECS (timer_idleness_start_time, -1, -1);
4201 /* Resume idle timer from last idle start time. */
4203 static void
4204 timer_resume_idle (void)
4206 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4207 return;
4209 timer_idleness_start_time = timer_last_idleness_start_time;
4212 /* This is only for debugging. */
4213 struct input_event last_timer_event;
4215 /* List of elisp functions to call, delayed because they were generated in
4216 a context where Elisp could not be safely run (e.g. redisplay, signal,
4217 ...). Each element has the form (FUN . ARGS). */
4218 Lisp_Object pending_funcalls;
4220 /* Check whether a timer has fired. To prevent larger problems we simply
4221 disregard elements that are not proper timers. Do not make a circular
4222 timer list for the time being.
4224 Returns the time to wait until the next timer fires. If a
4225 timer is triggering now, return zero.
4226 If no timer is active, return -1.
4228 If a timer is ripe, we run it, with quitting turned off.
4229 In that case we return 0 to indicate that a new timer_check_2 call
4230 should be done. */
4232 static EMACS_TIME
4233 timer_check_2 (void)
4235 EMACS_TIME nexttime;
4236 EMACS_TIME now, idleness_now;
4237 Lisp_Object timers, idle_timers, chosen_timer;
4238 struct gcpro gcpro1, gcpro2, gcpro3;
4240 EMACS_SET_SECS (nexttime, -1);
4241 EMACS_SET_USECS (nexttime, -1);
4243 /* Always consider the ordinary timers. */
4244 timers = Vtimer_list;
4245 /* Consider the idle timers only if Emacs is idle. */
4246 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4247 idle_timers = Vtimer_idle_list;
4248 else
4249 idle_timers = Qnil;
4250 chosen_timer = Qnil;
4251 GCPRO3 (timers, idle_timers, chosen_timer);
4253 /* First run the code that was delayed. */
4254 while (CONSP (pending_funcalls))
4256 Lisp_Object funcall = XCAR (pending_funcalls);
4257 pending_funcalls = XCDR (pending_funcalls);
4258 safe_call2 (Qapply, XCAR (funcall), XCDR (funcall));
4261 if (CONSP (timers) || CONSP (idle_timers))
4263 EMACS_GET_TIME (now);
4264 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4265 EMACS_SUB_TIME (idleness_now, now, timer_idleness_start_time);
4268 while (CONSP (timers) || CONSP (idle_timers))
4270 Lisp_Object *vector;
4271 Lisp_Object timer = Qnil, idle_timer = Qnil;
4272 EMACS_TIME timer_time, idle_timer_time;
4273 EMACS_TIME difference, timer_difference, idle_timer_difference;
4275 /* Skip past invalid timers and timers already handled. */
4276 if (!NILP (timers))
4278 timer = XCAR (timers);
4279 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
4281 timers = XCDR (timers);
4282 continue;
4284 vector = XVECTOR (timer)->contents;
4286 if (!INTEGERP (vector[1]) || !INTEGERP (vector[2])
4287 || !INTEGERP (vector[3])
4288 || ! NILP (vector[0]))
4290 timers = XCDR (timers);
4291 continue;
4294 if (!NILP (idle_timers))
4296 timer = XCAR (idle_timers);
4297 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
4299 idle_timers = XCDR (idle_timers);
4300 continue;
4302 vector = XVECTOR (timer)->contents;
4304 if (!INTEGERP (vector[1]) || !INTEGERP (vector[2])
4305 || !INTEGERP (vector[3])
4306 || ! NILP (vector[0]))
4308 idle_timers = XCDR (idle_timers);
4309 continue;
4313 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4314 based on the next ordinary timer.
4315 TIMER_DIFFERENCE is the distance in time from NOW to when
4316 this timer becomes ripe (negative if it's already ripe). */
4317 if (!NILP (timers))
4319 timer = XCAR (timers);
4320 vector = XVECTOR (timer)->contents;
4321 EMACS_SET_SECS (timer_time,
4322 (XINT (vector[1]) << 16) | (XINT (vector[2])));
4323 EMACS_SET_USECS (timer_time, XINT (vector[3]));
4324 EMACS_SUB_TIME (timer_difference, timer_time, now);
4327 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4328 based on the next idle timer. */
4329 if (!NILP (idle_timers))
4331 idle_timer = XCAR (idle_timers);
4332 vector = XVECTOR (idle_timer)->contents;
4333 EMACS_SET_SECS (idle_timer_time,
4334 (XINT (vector[1]) << 16) | (XINT (vector[2])));
4335 EMACS_SET_USECS (idle_timer_time, XINT (vector[3]));
4336 EMACS_SUB_TIME (idle_timer_difference, idle_timer_time, idleness_now);
4339 /* Decide which timer is the next timer,
4340 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4341 Also step down the list where we found that timer. */
4343 if (! NILP (timers) && ! NILP (idle_timers))
4345 EMACS_TIME temp;
4346 EMACS_SUB_TIME (temp, timer_difference, idle_timer_difference);
4347 if (EMACS_TIME_NEG_P (temp))
4349 chosen_timer = timer;
4350 timers = XCDR (timers);
4351 difference = timer_difference;
4353 else
4355 chosen_timer = idle_timer;
4356 idle_timers = XCDR (idle_timers);
4357 difference = idle_timer_difference;
4360 else if (! NILP (timers))
4362 chosen_timer = timer;
4363 timers = XCDR (timers);
4364 difference = timer_difference;
4366 else
4368 chosen_timer = idle_timer;
4369 idle_timers = XCDR (idle_timers);
4370 difference = idle_timer_difference;
4372 vector = XVECTOR (chosen_timer)->contents;
4374 /* If timer is ripe, run it if it hasn't been run. */
4375 if (EMACS_TIME_NEG_P (difference)
4376 || (EMACS_SECS (difference) == 0
4377 && EMACS_USECS (difference) == 0))
4379 if (NILP (vector[0]))
4381 int count = SPECPDL_INDEX ();
4382 Lisp_Object old_deactivate_mark = Vdeactivate_mark;
4384 /* Mark the timer as triggered to prevent problems if the lisp
4385 code fails to reschedule it right. */
4386 vector[0] = Qt;
4388 specbind (Qinhibit_quit, Qt);
4390 call1 (Qtimer_event_handler, chosen_timer);
4391 Vdeactivate_mark = old_deactivate_mark;
4392 timers_run++;
4393 unbind_to (count, Qnil);
4395 /* Since we have handled the event,
4396 we don't need to tell the caller to wake up and do it. */
4397 /* But the caller must still wait for the next timer, so
4398 return 0 to indicate that. */
4401 EMACS_SET_SECS (nexttime, 0);
4402 EMACS_SET_USECS (nexttime, 0);
4404 else
4405 /* When we encounter a timer that is still waiting,
4406 return the amount of time to wait before it is ripe. */
4408 UNGCPRO;
4409 return difference;
4413 /* No timers are pending in the future. */
4414 /* Return 0 if we generated an event, and -1 if not. */
4415 UNGCPRO;
4416 return nexttime;
4420 /* Check whether a timer has fired. To prevent larger problems we simply
4421 disregard elements that are not proper timers. Do not make a circular
4422 timer list for the time being.
4424 Returns the time to wait until the next timer fires.
4425 If no timer is active, return -1.
4427 As long as any timer is ripe, we run it. */
4429 EMACS_TIME
4430 timer_check (void)
4432 EMACS_TIME nexttime;
4436 nexttime = timer_check_2 ();
4438 while (EMACS_SECS (nexttime) == 0 && EMACS_USECS (nexttime) == 0);
4440 return nexttime;
4443 DEFUN ("current-idle-time", Fcurrent_idle_time, Scurrent_idle_time, 0, 0, 0,
4444 doc: /* Return the current length of Emacs idleness, or nil.
4445 The value when Emacs is idle is a list of three integers. The first has
4446 the most significant 16 bits of the seconds, while the second has the least
4447 significant 16 bits. The third integer gives the microsecond count.
4449 The value when Emacs is not idle is nil.
4451 The microsecond count is zero on systems that do not provide
4452 resolution finer than a second. */)
4453 (void)
4455 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4457 EMACS_TIME now, idleness_now;
4459 EMACS_GET_TIME (now);
4460 EMACS_SUB_TIME (idleness_now, now, timer_idleness_start_time);
4462 return list3 (make_number ((EMACS_SECS (idleness_now) >> 16) & 0xffff),
4463 make_number ((EMACS_SECS (idleness_now) >> 0) & 0xffff),
4464 make_number (EMACS_USECS (idleness_now)));
4467 return Qnil;
4470 /* Caches for modify_event_symbol. */
4471 static Lisp_Object accent_key_syms;
4472 static Lisp_Object func_key_syms;
4473 static Lisp_Object mouse_syms;
4474 static Lisp_Object wheel_syms;
4475 static Lisp_Object drag_n_drop_syms;
4477 /* This is a list of keysym codes for special "accent" characters.
4478 It parallels lispy_accent_keys. */
4480 static const int lispy_accent_codes[] =
4482 #ifdef XK_dead_circumflex
4483 XK_dead_circumflex,
4484 #else
4486 #endif
4487 #ifdef XK_dead_grave
4488 XK_dead_grave,
4489 #else
4491 #endif
4492 #ifdef XK_dead_tilde
4493 XK_dead_tilde,
4494 #else
4496 #endif
4497 #ifdef XK_dead_diaeresis
4498 XK_dead_diaeresis,
4499 #else
4501 #endif
4502 #ifdef XK_dead_macron
4503 XK_dead_macron,
4504 #else
4506 #endif
4507 #ifdef XK_dead_degree
4508 XK_dead_degree,
4509 #else
4511 #endif
4512 #ifdef XK_dead_acute
4513 XK_dead_acute,
4514 #else
4516 #endif
4517 #ifdef XK_dead_cedilla
4518 XK_dead_cedilla,
4519 #else
4521 #endif
4522 #ifdef XK_dead_breve
4523 XK_dead_breve,
4524 #else
4526 #endif
4527 #ifdef XK_dead_ogonek
4528 XK_dead_ogonek,
4529 #else
4531 #endif
4532 #ifdef XK_dead_caron
4533 XK_dead_caron,
4534 #else
4536 #endif
4537 #ifdef XK_dead_doubleacute
4538 XK_dead_doubleacute,
4539 #else
4541 #endif
4542 #ifdef XK_dead_abovedot
4543 XK_dead_abovedot,
4544 #else
4546 #endif
4547 #ifdef XK_dead_abovering
4548 XK_dead_abovering,
4549 #else
4551 #endif
4552 #ifdef XK_dead_iota
4553 XK_dead_iota,
4554 #else
4556 #endif
4557 #ifdef XK_dead_belowdot
4558 XK_dead_belowdot,
4559 #else
4561 #endif
4562 #ifdef XK_dead_voiced_sound
4563 XK_dead_voiced_sound,
4564 #else
4566 #endif
4567 #ifdef XK_dead_semivoiced_sound
4568 XK_dead_semivoiced_sound,
4569 #else
4571 #endif
4572 #ifdef XK_dead_hook
4573 XK_dead_hook,
4574 #else
4576 #endif
4577 #ifdef XK_dead_horn
4578 XK_dead_horn,
4579 #else
4581 #endif
4584 /* This is a list of Lisp names for special "accent" characters.
4585 It parallels lispy_accent_codes. */
4587 static const char *const lispy_accent_keys[] =
4589 "dead-circumflex",
4590 "dead-grave",
4591 "dead-tilde",
4592 "dead-diaeresis",
4593 "dead-macron",
4594 "dead-degree",
4595 "dead-acute",
4596 "dead-cedilla",
4597 "dead-breve",
4598 "dead-ogonek",
4599 "dead-caron",
4600 "dead-doubleacute",
4601 "dead-abovedot",
4602 "dead-abovering",
4603 "dead-iota",
4604 "dead-belowdot",
4605 "dead-voiced-sound",
4606 "dead-semivoiced-sound",
4607 "dead-hook",
4608 "dead-horn",
4611 #ifdef HAVE_NTGUI
4612 #define FUNCTION_KEY_OFFSET 0x0
4614 const char *const lispy_function_keys[] =
4616 0, /* 0 */
4618 0, /* VK_LBUTTON 0x01 */
4619 0, /* VK_RBUTTON 0x02 */
4620 "cancel", /* VK_CANCEL 0x03 */
4621 0, /* VK_MBUTTON 0x04 */
4623 0, 0, 0, /* 0x05 .. 0x07 */
4625 "backspace", /* VK_BACK 0x08 */
4626 "tab", /* VK_TAB 0x09 */
4628 0, 0, /* 0x0A .. 0x0B */
4630 "clear", /* VK_CLEAR 0x0C */
4631 "return", /* VK_RETURN 0x0D */
4633 0, 0, /* 0x0E .. 0x0F */
4635 0, /* VK_SHIFT 0x10 */
4636 0, /* VK_CONTROL 0x11 */
4637 0, /* VK_MENU 0x12 */
4638 "pause", /* VK_PAUSE 0x13 */
4639 "capslock", /* VK_CAPITAL 0x14 */
4640 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4641 0, /* 0x16 */
4642 "junja", /* VK_JUNJA 0x17 */
4643 "final", /* VK_FINAL 0x18 */
4644 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4645 0, /* 0x1A */
4646 "escape", /* VK_ESCAPE 0x1B */
4647 "convert", /* VK_CONVERT 0x1C */
4648 "non-convert", /* VK_NONCONVERT 0x1D */
4649 "accept", /* VK_ACCEPT 0x1E */
4650 "mode-change", /* VK_MODECHANGE 0x1F */
4651 0, /* VK_SPACE 0x20 */
4652 "prior", /* VK_PRIOR 0x21 */
4653 "next", /* VK_NEXT 0x22 */
4654 "end", /* VK_END 0x23 */
4655 "home", /* VK_HOME 0x24 */
4656 "left", /* VK_LEFT 0x25 */
4657 "up", /* VK_UP 0x26 */
4658 "right", /* VK_RIGHT 0x27 */
4659 "down", /* VK_DOWN 0x28 */
4660 "select", /* VK_SELECT 0x29 */
4661 "print", /* VK_PRINT 0x2A */
4662 "execute", /* VK_EXECUTE 0x2B */
4663 "snapshot", /* VK_SNAPSHOT 0x2C */
4664 "insert", /* VK_INSERT 0x2D */
4665 "delete", /* VK_DELETE 0x2E */
4666 "help", /* VK_HELP 0x2F */
4668 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4670 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4672 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4674 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4676 0, 0, 0, 0, 0, 0, 0, 0, 0,
4677 0, 0, 0, 0, 0, 0, 0, 0, 0,
4678 0, 0, 0, 0, 0, 0, 0, 0,
4680 "lwindow", /* VK_LWIN 0x5B */
4681 "rwindow", /* VK_RWIN 0x5C */
4682 "apps", /* VK_APPS 0x5D */
4683 0, /* 0x5E */
4684 "sleep",
4685 "kp-0", /* VK_NUMPAD0 0x60 */
4686 "kp-1", /* VK_NUMPAD1 0x61 */
4687 "kp-2", /* VK_NUMPAD2 0x62 */
4688 "kp-3", /* VK_NUMPAD3 0x63 */
4689 "kp-4", /* VK_NUMPAD4 0x64 */
4690 "kp-5", /* VK_NUMPAD5 0x65 */
4691 "kp-6", /* VK_NUMPAD6 0x66 */
4692 "kp-7", /* VK_NUMPAD7 0x67 */
4693 "kp-8", /* VK_NUMPAD8 0x68 */
4694 "kp-9", /* VK_NUMPAD9 0x69 */
4695 "kp-multiply", /* VK_MULTIPLY 0x6A */
4696 "kp-add", /* VK_ADD 0x6B */
4697 "kp-separator", /* VK_SEPARATOR 0x6C */
4698 "kp-subtract", /* VK_SUBTRACT 0x6D */
4699 "kp-decimal", /* VK_DECIMAL 0x6E */
4700 "kp-divide", /* VK_DIVIDE 0x6F */
4701 "f1", /* VK_F1 0x70 */
4702 "f2", /* VK_F2 0x71 */
4703 "f3", /* VK_F3 0x72 */
4704 "f4", /* VK_F4 0x73 */
4705 "f5", /* VK_F5 0x74 */
4706 "f6", /* VK_F6 0x75 */
4707 "f7", /* VK_F7 0x76 */
4708 "f8", /* VK_F8 0x77 */
4709 "f9", /* VK_F9 0x78 */
4710 "f10", /* VK_F10 0x79 */
4711 "f11", /* VK_F11 0x7A */
4712 "f12", /* VK_F12 0x7B */
4713 "f13", /* VK_F13 0x7C */
4714 "f14", /* VK_F14 0x7D */
4715 "f15", /* VK_F15 0x7E */
4716 "f16", /* VK_F16 0x7F */
4717 "f17", /* VK_F17 0x80 */
4718 "f18", /* VK_F18 0x81 */
4719 "f19", /* VK_F19 0x82 */
4720 "f20", /* VK_F20 0x83 */
4721 "f21", /* VK_F21 0x84 */
4722 "f22", /* VK_F22 0x85 */
4723 "f23", /* VK_F23 0x86 */
4724 "f24", /* VK_F24 0x87 */
4726 0, 0, 0, 0, /* 0x88 .. 0x8B */
4727 0, 0, 0, 0, /* 0x8C .. 0x8F */
4729 "kp-numlock", /* VK_NUMLOCK 0x90 */
4730 "scroll", /* VK_SCROLL 0x91 */
4731 /* Not sure where the following block comes from.
4732 Windows headers have NEC and Fujitsu specific keys in
4733 this block, but nothing generic. */
4734 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4735 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4736 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4737 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4738 "kp-end", /* VK_NUMPAD_END 0x96 */
4739 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4740 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4741 "kp-up", /* VK_NUMPAD_UP 0x99 */
4742 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4743 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4744 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4745 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4747 0, 0, /* 0x9E .. 0x9F */
4750 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4751 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4752 * No other API or message will distinguish left and right keys this way.
4753 * 0xA0 .. 0xA5
4755 0, 0, 0, 0, 0, 0,
4757 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4758 to enable them selectively, and gives access to a few more functions.
4759 See lispy_multimedia_keys below. */
4760 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4761 0, 0, 0, /* 0xAD .. 0xAF Volume */
4762 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4763 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4765 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4766 0, 0, 0, 0, 0, 0, 0, 0, 0,
4768 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4769 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4770 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4772 0, /* 0xE0 */
4773 "ax", /* VK_OEM_AX 0xE1 */
4774 0, /* VK_OEM_102 0xE2 */
4775 "ico-help", /* VK_ICO_HELP 0xE3 */
4776 "ico-00", /* VK_ICO_00 0xE4 */
4777 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4778 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4779 0, /* VK_PACKET 0xE7 - used to pass unicode chars */
4780 0, /* 0xE8 */
4781 "reset", /* VK_OEM_RESET 0xE9 */
4782 "jump", /* VK_OEM_JUMP 0xEA */
4783 "oem-pa1", /* VK_OEM_PA1 0xEB */
4784 "oem-pa2", /* VK_OEM_PA2 0xEC */
4785 "oem-pa3", /* VK_OEM_PA3 0xED */
4786 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4787 "cusel", /* VK_OEM_CUSEL 0xEF */
4788 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4789 "finish", /* VK_OEM_FINISH 0xF1 */
4790 "copy", /* VK_OEM_COPY 0xF2 */
4791 "auto", /* VK_OEM_AUTO 0xF3 */
4792 "enlw", /* VK_OEM_ENLW 0xF4 */
4793 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4794 "attn", /* VK_ATTN 0xF6 */
4795 "crsel", /* VK_CRSEL 0xF7 */
4796 "exsel", /* VK_EXSEL 0xF8 */
4797 "ereof", /* VK_EREOF 0xF9 */
4798 "play", /* VK_PLAY 0xFA */
4799 "zoom", /* VK_ZOOM 0xFB */
4800 "noname", /* VK_NONAME 0xFC */
4801 "pa1", /* VK_PA1 0xFD */
4802 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4803 0 /* 0xFF */
4806 /* Some of these duplicate the "Media keys" on newer keyboards,
4807 but they are delivered to the application in a different way. */
4808 static const char *const lispy_multimedia_keys[] =
4811 "browser-back",
4812 "browser-forward",
4813 "browser-refresh",
4814 "browser-stop",
4815 "browser-search",
4816 "browser-favorites",
4817 "browser-home",
4818 "volume-mute",
4819 "volume-down",
4820 "volume-up",
4821 "media-next",
4822 "media-previous",
4823 "media-stop",
4824 "media-play-pause",
4825 "mail",
4826 "media-select",
4827 "app-1",
4828 "app-2",
4829 "bass-down",
4830 "bass-boost",
4831 "bass-up",
4832 "treble-down",
4833 "treble-up",
4834 "mic-volume-mute",
4835 "mic-volume-down",
4836 "mic-volume-up",
4837 "help",
4838 "find",
4839 "new",
4840 "open",
4841 "close",
4842 "save",
4843 "print",
4844 "undo",
4845 "redo",
4846 "copy",
4847 "cut",
4848 "paste",
4849 "mail-reply",
4850 "mail-forward",
4851 "mail-send",
4852 "spell-check",
4853 "toggle-dictate-command",
4854 "mic-toggle",
4855 "correction-list",
4856 "media-play",
4857 "media-pause",
4858 "media-record",
4859 "media-fast-forward",
4860 "media-rewind",
4861 "media-channel-up",
4862 "media-channel-down"
4865 #else /* not HAVE_NTGUI */
4867 /* This should be dealt with in XTread_socket now, and that doesn't
4868 depend on the client system having the Kana syms defined. See also
4869 the XK_kana_A case below. */
4870 #if 0
4871 #ifdef XK_kana_A
4872 static const char *const lispy_kana_keys[] =
4874 /* X Keysym value */
4875 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4876 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4877 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4878 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4879 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4880 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4881 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4882 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4883 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4884 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4885 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4886 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4887 "kana-i", "kana-u", "kana-e", "kana-o",
4888 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4889 "prolongedsound", "kana-A", "kana-I", "kana-U",
4890 "kana-E", "kana-O", "kana-KA", "kana-KI",
4891 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4892 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4893 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4894 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4895 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4896 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4897 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4898 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4899 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4900 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4901 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4902 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4904 #endif /* XK_kana_A */
4905 #endif /* 0 */
4907 #define FUNCTION_KEY_OFFSET 0xff00
4909 /* You'll notice that this table is arranged to be conveniently
4910 indexed by X Windows keysym values. */
4911 static const char *const lispy_function_keys[] =
4913 /* X Keysym value */
4915 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4916 "backspace", "tab", "linefeed", "clear",
4917 0, "return", 0, 0,
4918 0, 0, 0, "pause", /* 0xff10...1f */
4919 0, 0, 0, 0, 0, 0, 0, "escape",
4920 0, 0, 0, 0,
4921 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4922 "romaji", "hiragana", "katakana", "hiragana-katakana",
4923 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4924 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4925 "eisu-toggle", /* 0xff30...3f */
4926 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4927 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4929 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4930 "down", "prior", "next", "end",
4931 "begin", 0, 0, 0, 0, 0, 0, 0,
4932 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4933 "print",
4934 "execute",
4935 "insert",
4936 0, /* 0xff64 */
4937 "undo",
4938 "redo",
4939 "menu",
4940 "find",
4941 "cancel",
4942 "help",
4943 "break", /* 0xff6b */
4945 0, 0, 0, 0,
4946 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4947 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4948 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4949 0, 0, 0, 0, 0, 0, 0, 0,
4950 "kp-tab", /* 0xff89 */
4951 0, 0, 0,
4952 "kp-enter", /* 0xff8d */
4953 0, 0, 0,
4954 "kp-f1", /* 0xff91 */
4955 "kp-f2",
4956 "kp-f3",
4957 "kp-f4",
4958 "kp-home", /* 0xff95 */
4959 "kp-left",
4960 "kp-up",
4961 "kp-right",
4962 "kp-down",
4963 "kp-prior", /* kp-page-up */
4964 "kp-next", /* kp-page-down */
4965 "kp-end",
4966 "kp-begin",
4967 "kp-insert",
4968 "kp-delete",
4969 0, /* 0xffa0 */
4970 0, 0, 0, 0, 0, 0, 0, 0, 0,
4971 "kp-multiply", /* 0xffaa */
4972 "kp-add",
4973 "kp-separator",
4974 "kp-subtract",
4975 "kp-decimal",
4976 "kp-divide", /* 0xffaf */
4977 "kp-0", /* 0xffb0 */
4978 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4979 0, /* 0xffba */
4980 0, 0,
4981 "kp-equal", /* 0xffbd */
4982 "f1", /* 0xffbe */ /* IsFunctionKey */
4983 "f2",
4984 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4985 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4986 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4987 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4988 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4989 0, 0, 0, 0, 0, 0, 0, 0,
4990 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4991 0, 0, 0, 0, 0, 0, 0, "delete"
4994 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4995 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4997 static const char *const iso_lispy_function_keys[] =
4999 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5000 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5001 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5002 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5003 "iso-lefttab", /* 0xfe20 */
5004 "iso-move-line-up", "iso-move-line-down",
5005 "iso-partial-line-up", "iso-partial-line-down",
5006 "iso-partial-space-left", "iso-partial-space-right",
5007 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5008 "iso-release-margin-left", "iso-release-margin-right",
5009 "iso-release-both-margins",
5010 "iso-fast-cursor-left", "iso-fast-cursor-right",
5011 "iso-fast-cursor-up", "iso-fast-cursor-down",
5012 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5013 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5016 #endif /* not HAVE_NTGUI */
5018 Lisp_Object Vlispy_mouse_stem;
5020 static const char *const lispy_wheel_names[] =
5022 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5025 /* drag-n-drop events are generated when a set of selected files are
5026 dragged from another application and dropped onto an Emacs window. */
5027 static const char *const lispy_drag_n_drop_names[] =
5029 "drag-n-drop"
5032 /* Scroll bar parts. */
5033 Lisp_Object Qabove_handle, Qhandle, Qbelow_handle;
5034 Lisp_Object Qup, Qdown, Qbottom, Qend_scroll;
5035 Lisp_Object Qtop, Qratio;
5037 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5038 static Lisp_Object *const scroll_bar_parts[] = {
5039 &Qabove_handle, &Qhandle, &Qbelow_handle,
5040 &Qup, &Qdown, &Qtop, &Qbottom, &Qend_scroll, &Qratio
5043 /* A vector, indexed by button number, giving the down-going location
5044 of currently depressed buttons, both scroll bar and non-scroll bar.
5046 The elements have the form
5047 (BUTTON-NUMBER MODIFIER-MASK . REST)
5048 where REST is the cdr of a position as it would be reported in the event.
5050 The make_lispy_event function stores positions here to tell the
5051 difference between click and drag events, and to store the starting
5052 location to be included in drag events. */
5054 static Lisp_Object button_down_location;
5056 /* Information about the most recent up-going button event: Which
5057 button, what location, and what time. */
5059 static int last_mouse_button;
5060 static int last_mouse_x;
5061 static int last_mouse_y;
5062 static unsigned long button_down_time;
5064 /* The number of clicks in this multiple-click. */
5066 int double_click_count;
5068 /* X and Y are frame-relative coordinates for a click or wheel event.
5069 Return a Lisp-style event list. */
5071 static Lisp_Object
5072 make_lispy_position (struct frame *f, Lisp_Object x, Lisp_Object y,
5073 unsigned long t)
5075 enum window_part part;
5076 Lisp_Object posn = Qnil;
5077 Lisp_Object extra_info = Qnil;
5078 /* Coordinate pixel positions to return. */
5079 int xret = 0, yret = 0;
5080 /* The window under frame pixel coordinates (x,y) */
5081 Lisp_Object window = f
5082 ? window_from_coordinates (f, XINT (x), XINT (y), &part, 0)
5083 : Qnil;
5085 if (WINDOWP (window))
5087 /* It's a click in window window at frame coordinates (x,y) */
5088 struct window *w = XWINDOW (window);
5089 Lisp_Object string_info = Qnil;
5090 EMACS_INT textpos = -1;
5091 int col = -1, row = -1;
5092 int dx = -1, dy = -1;
5093 int width = -1, height = -1;
5094 Lisp_Object object = Qnil;
5096 /* Pixel coordinates relative to the window corner. */
5097 int wx = XINT (x) - WINDOW_LEFT_EDGE_X (w);
5098 int wy = XINT (y) - WINDOW_TOP_EDGE_Y (w);
5100 /* For text area clicks, return X, Y relative to the corner of
5101 this text area. Note that dX, dY etc are set below, by
5102 buffer_posn_from_coords. */
5103 if (part == ON_TEXT)
5105 xret = XINT (x) - window_box_left (w, TEXT_AREA);
5106 yret = wy - WINDOW_HEADER_LINE_HEIGHT (w);
5108 /* For mode line and header line clicks, return X, Y relative to
5109 the left window edge. Use mode_line_string to look for a
5110 string on the click position. */
5111 else if (part == ON_MODE_LINE || part == ON_HEADER_LINE)
5113 Lisp_Object string;
5114 EMACS_INT charpos;
5116 posn = (part == ON_MODE_LINE) ? Qmode_line : Qheader_line;
5117 /* Note that mode_line_string takes COL, ROW as pixels and
5118 converts them to characters. */
5119 col = wx;
5120 row = wy;
5121 string = mode_line_string (w, part, &col, &row, &charpos,
5122 &object, &dx, &dy, &width, &height);
5123 if (STRINGP (string))
5124 string_info = Fcons (string, make_number (charpos));
5125 textpos = (w == XWINDOW (selected_window)
5126 && current_buffer == XBUFFER (w->buffer))
5127 ? PT : XMARKER (w->pointm)->charpos;
5129 xret = wx;
5130 yret = wy;
5132 /* For fringes and margins, Y is relative to the area's (and the
5133 window's) top edge, while X is meaningless. */
5134 else if (part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
5136 Lisp_Object string;
5137 EMACS_INT charpos;
5139 posn = (part == ON_LEFT_MARGIN) ? Qleft_margin : Qright_margin;
5140 col = wx;
5141 row = wy;
5142 string = marginal_area_string (w, part, &col, &row, &charpos,
5143 &object, &dx, &dy, &width, &height);
5144 if (STRINGP (string))
5145 string_info = Fcons (string, make_number (charpos));
5146 yret = wy - WINDOW_HEADER_LINE_HEIGHT (w);
5148 else if (part == ON_LEFT_FRINGE)
5150 posn = Qleft_fringe;
5151 col = 0;
5152 dx = wx
5153 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5154 ? 0 : window_box_width (w, LEFT_MARGIN_AREA));
5155 dy = yret = wy - WINDOW_HEADER_LINE_HEIGHT (w);
5157 else if (part == ON_RIGHT_FRINGE)
5159 posn = Qright_fringe;
5160 col = 0;
5161 dx = wx
5162 - window_box_width (w, LEFT_MARGIN_AREA)
5163 - window_box_width (w, TEXT_AREA)
5164 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5165 ? window_box_width (w, RIGHT_MARGIN_AREA)
5166 : 0);
5167 dy = yret = wy - WINDOW_HEADER_LINE_HEIGHT (w);
5169 else if (part == ON_VERTICAL_BORDER)
5171 posn = Qvertical_line;
5172 width = 1;
5173 dx = 0;
5174 dy = yret = wy;
5176 /* Nothing special for part == ON_SCROLL_BAR. */
5178 /* For clicks in the text area, fringes, or margins, call
5179 buffer_posn_from_coords to extract TEXTPOS, the buffer
5180 position nearest to the click. */
5181 if (textpos < 0)
5183 Lisp_Object string2, object2 = Qnil;
5184 struct display_pos p;
5185 int dx2, dy2;
5186 int width2, height2;
5187 /* The pixel X coordinate passed to buffer_posn_from_coords
5188 is the X coordinate relative to the text area for
5189 text-area and right-margin clicks, zero otherwise. */
5190 int x2
5191 = (part == ON_TEXT) ? xret
5192 : (part == ON_RIGHT_FRINGE || part == ON_RIGHT_MARGIN)
5193 ? (XINT (x) - window_box_left (w, TEXT_AREA))
5194 : 0;
5195 int y2 = wy;
5197 string2 = buffer_posn_from_coords (w, &x2, &y2, &p,
5198 &object2, &dx2, &dy2,
5199 &width2, &height2);
5200 textpos = CHARPOS (p.pos);
5201 if (col < 0) col = x2;
5202 if (row < 0) row = y2;
5203 if (dx < 0) dx = dx2;
5204 if (dy < 0) dy = dy2;
5205 if (width < 0) width = width2;
5206 if (height < 0) height = height2;
5208 if (NILP (posn))
5210 posn = make_number (textpos);
5211 if (STRINGP (string2))
5212 string_info = Fcons (string2,
5213 make_number (CHARPOS (p.string_pos)));
5215 if (NILP (object))
5216 object = object2;
5219 #ifdef HAVE_WINDOW_SYSTEM
5220 if (IMAGEP (object))
5222 Lisp_Object image_map, hotspot;
5223 if ((image_map = Fplist_get (XCDR (object), QCmap),
5224 !NILP (image_map))
5225 && (hotspot = find_hot_spot (image_map, dx, dy),
5226 CONSP (hotspot))
5227 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
5228 posn = XCAR (hotspot);
5230 #endif
5232 /* Object info */
5233 extra_info
5234 = list3 (object,
5235 Fcons (make_number (dx), make_number (dy)),
5236 Fcons (make_number (width), make_number (height)));
5238 /* String info */
5239 extra_info = Fcons (string_info,
5240 Fcons (make_number (textpos),
5241 Fcons (Fcons (make_number (col),
5242 make_number (row)),
5243 extra_info)));
5245 else if (f != 0)
5246 XSETFRAME (window, f);
5247 else
5248 window = Qnil;
5250 return Fcons (window,
5251 Fcons (posn,
5252 Fcons (Fcons (make_number (xret),
5253 make_number (yret)),
5254 Fcons (make_number (t),
5255 extra_info))));
5258 /* Given a struct input_event, build the lisp event which represents
5259 it. If EVENT is 0, build a mouse movement event from the mouse
5260 movement buffer, which should have a movement event in it.
5262 Note that events must be passed to this function in the order they
5263 are received; this function stores the location of button presses
5264 in order to build drag events when the button is released. */
5266 static Lisp_Object
5267 make_lispy_event (struct input_event *event)
5269 int i;
5271 switch (SWITCH_ENUM_CAST (event->kind))
5273 /* A simple keystroke. */
5274 case ASCII_KEYSTROKE_EVENT:
5275 case MULTIBYTE_CHAR_KEYSTROKE_EVENT:
5277 Lisp_Object lispy_c;
5278 EMACS_INT c = event->code;
5279 if (event->kind == ASCII_KEYSTROKE_EVENT)
5281 c &= 0377;
5282 eassert (c == event->code);
5283 /* Turn ASCII characters into control characters
5284 when proper. */
5285 if (event->modifiers & ctrl_modifier)
5287 c = make_ctrl_char (c);
5288 event->modifiers &= ~ctrl_modifier;
5292 /* Add in the other modifier bits. The shift key was taken care
5293 of by the X code. */
5294 c |= (event->modifiers
5295 & (meta_modifier | alt_modifier
5296 | hyper_modifier | super_modifier | ctrl_modifier));
5297 /* Distinguish Shift-SPC from SPC. */
5298 if ((event->code) == 040
5299 && event->modifiers & shift_modifier)
5300 c |= shift_modifier;
5301 button_down_time = 0;
5302 XSETFASTINT (lispy_c, c);
5303 return lispy_c;
5306 #ifdef HAVE_NS
5307 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5308 except that they are non-key events (last-nonmenu-event is nil). */
5309 case NS_NONKEY_EVENT:
5310 #endif
5312 /* A function key. The symbol may need to have modifier prefixes
5313 tacked onto it. */
5314 case NON_ASCII_KEYSTROKE_EVENT:
5315 button_down_time = 0;
5317 for (i = 0; i < sizeof (lispy_accent_codes) / sizeof (int); i++)
5318 if (event->code == lispy_accent_codes[i])
5319 return modify_event_symbol (i,
5320 event->modifiers,
5321 Qfunction_key, Qnil,
5322 lispy_accent_keys, &accent_key_syms,
5323 (sizeof (lispy_accent_keys)
5324 / sizeof (lispy_accent_keys[0])));
5326 #if 0
5327 #ifdef XK_kana_A
5328 if (event->code >= 0x400 && event->code < 0x500)
5329 return modify_event_symbol (event->code - 0x400,
5330 event->modifiers & ~shift_modifier,
5331 Qfunction_key, Qnil,
5332 lispy_kana_keys, &func_key_syms,
5333 (sizeof (lispy_kana_keys)
5334 / sizeof (lispy_kana_keys[0])));
5335 #endif /* XK_kana_A */
5336 #endif /* 0 */
5338 #ifdef ISO_FUNCTION_KEY_OFFSET
5339 if (event->code < FUNCTION_KEY_OFFSET
5340 && event->code >= ISO_FUNCTION_KEY_OFFSET)
5341 return modify_event_symbol (event->code - ISO_FUNCTION_KEY_OFFSET,
5342 event->modifiers,
5343 Qfunction_key, Qnil,
5344 iso_lispy_function_keys, &func_key_syms,
5345 (sizeof (iso_lispy_function_keys)
5346 / sizeof (iso_lispy_function_keys[0])));
5347 #endif
5349 /* Handle system-specific or unknown keysyms. */
5350 if (event->code & (1 << 28)
5351 || event->code - FUNCTION_KEY_OFFSET < 0
5352 || (event->code - FUNCTION_KEY_OFFSET
5353 >= sizeof lispy_function_keys / sizeof *lispy_function_keys)
5354 || !lispy_function_keys[event->code - FUNCTION_KEY_OFFSET])
5356 /* We need to use an alist rather than a vector as the cache
5357 since we can't make a vector long enuf. */
5358 if (NILP (KVAR (current_kboard, system_key_syms)))
5359 KVAR (current_kboard, system_key_syms) = Fcons (Qnil, Qnil);
5360 return modify_event_symbol (event->code,
5361 event->modifiers,
5362 Qfunction_key,
5363 KVAR (current_kboard, Vsystem_key_alist),
5364 0, &KVAR (current_kboard, system_key_syms),
5365 (unsigned) -1);
5368 return modify_event_symbol (event->code - FUNCTION_KEY_OFFSET,
5369 event->modifiers,
5370 Qfunction_key, Qnil,
5371 lispy_function_keys, &func_key_syms,
5372 (sizeof (lispy_function_keys)
5373 / sizeof (lispy_function_keys[0])));
5375 #ifdef WINDOWSNT
5376 case MULTIMEDIA_KEY_EVENT:
5377 if (event->code < (sizeof (lispy_multimedia_keys)
5378 / sizeof (lispy_multimedia_keys[0]))
5379 && event->code > 0 && lispy_multimedia_keys[event->code])
5381 return modify_event_symbol (event->code, event->modifiers,
5382 Qfunction_key, Qnil,
5383 lispy_multimedia_keys, &func_key_syms,
5384 (sizeof (lispy_multimedia_keys)
5385 / sizeof (lispy_multimedia_keys[0])));
5387 return Qnil;
5388 #endif
5390 #ifdef HAVE_MOUSE
5391 /* A mouse click. Figure out where it is, decide whether it's
5392 a press, click or drag, and build the appropriate structure. */
5393 case MOUSE_CLICK_EVENT:
5394 #ifndef USE_TOOLKIT_SCROLL_BARS
5395 case SCROLL_BAR_CLICK_EVENT:
5396 #endif
5398 int button = event->code;
5399 int is_double;
5400 Lisp_Object position;
5401 Lisp_Object *start_pos_ptr;
5402 Lisp_Object start_pos;
5404 position = Qnil;
5406 /* Build the position as appropriate for this mouse click. */
5407 if (event->kind == MOUSE_CLICK_EVENT)
5409 struct frame *f = XFRAME (event->frame_or_window);
5410 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5411 int row, column;
5412 #endif
5414 /* Ignore mouse events that were made on frame that
5415 have been deleted. */
5416 if (! FRAME_LIVE_P (f))
5417 return Qnil;
5419 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5420 /* EVENT->x and EVENT->y are frame-relative pixel
5421 coordinates at this place. Under old redisplay, COLUMN
5422 and ROW are set to frame relative glyph coordinates
5423 which are then used to determine whether this click is
5424 in a menu (non-toolkit version). */
5425 pixel_to_glyph_coords (f, XINT (event->x), XINT (event->y),
5426 &column, &row, NULL, 1);
5428 /* In the non-toolkit version, clicks on the menu bar
5429 are ordinary button events in the event buffer.
5430 Distinguish them, and invoke the menu.
5432 (In the toolkit version, the toolkit handles the menu bar
5433 and Emacs doesn't know about it until after the user
5434 makes a selection.) */
5435 if (row >= 0 && row < FRAME_MENU_BAR_LINES (f)
5436 && (event->modifiers & down_modifier))
5438 Lisp_Object items, item;
5439 int i;
5441 /* Find the menu bar item under `column'. */
5442 item = Qnil;
5443 items = FRAME_MENU_BAR_ITEMS (f);
5444 for (i = 0; i < XVECTOR (items)->size; i += 4)
5446 Lisp_Object pos, string;
5447 string = AREF (items, i + 1);
5448 pos = AREF (items, i + 3);
5449 if (NILP (string))
5450 break;
5451 if (column >= XINT (pos)
5452 && column < XINT (pos) + SCHARS (string))
5454 item = AREF (items, i);
5455 break;
5459 /* ELisp manual 2.4b says (x y) are window relative but
5460 code says they are frame-relative. */
5461 position
5462 = Fcons (event->frame_or_window,
5463 Fcons (Qmenu_bar,
5464 Fcons (Fcons (event->x, event->y),
5465 Fcons (make_number (event->timestamp),
5466 Qnil))));
5468 return Fcons (item, Fcons (position, Qnil));
5470 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5472 position = make_lispy_position (f, event->x, event->y,
5473 event->timestamp);
5475 #ifndef USE_TOOLKIT_SCROLL_BARS
5476 else
5478 /* It's a scrollbar click. */
5479 Lisp_Object window;
5480 Lisp_Object portion_whole;
5481 Lisp_Object part;
5483 window = event->frame_or_window;
5484 portion_whole = Fcons (event->x, event->y);
5485 part = *scroll_bar_parts[(int) event->part];
5487 position
5488 = Fcons (window,
5489 Fcons (Qvertical_scroll_bar,
5490 Fcons (portion_whole,
5491 Fcons (make_number (event->timestamp),
5492 Fcons (part, Qnil)))));
5494 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5496 if (button >= ASIZE (button_down_location))
5498 button_down_location = larger_vector (button_down_location,
5499 button + 1, Qnil);
5500 mouse_syms = larger_vector (mouse_syms, button + 1, Qnil);
5503 start_pos_ptr = &AREF (button_down_location, button);
5504 start_pos = *start_pos_ptr;
5505 *start_pos_ptr = Qnil;
5508 /* On window-system frames, use the value of
5509 double-click-fuzz as is. On other frames, interpret it
5510 as a multiple of 1/8 characters. */
5511 struct frame *f;
5512 int fuzz;
5514 if (WINDOWP (event->frame_or_window))
5515 f = XFRAME (XWINDOW (event->frame_or_window)->frame);
5516 else if (FRAMEP (event->frame_or_window))
5517 f = XFRAME (event->frame_or_window);
5518 else
5519 abort ();
5521 if (FRAME_WINDOW_P (f))
5522 fuzz = double_click_fuzz;
5523 else
5524 fuzz = double_click_fuzz / 8;
5526 is_double = (button == last_mouse_button
5527 && (eabs (XINT (event->x) - last_mouse_x) <= fuzz)
5528 && (eabs (XINT (event->y) - last_mouse_y) <= fuzz)
5529 && button_down_time != 0
5530 && (EQ (Vdouble_click_time, Qt)
5531 || (INTEGERP (Vdouble_click_time)
5532 && ((int)(event->timestamp - button_down_time)
5533 < XINT (Vdouble_click_time)))));
5536 last_mouse_button = button;
5537 last_mouse_x = XINT (event->x);
5538 last_mouse_y = XINT (event->y);
5540 /* If this is a button press, squirrel away the location, so
5541 we can decide later whether it was a click or a drag. */
5542 if (event->modifiers & down_modifier)
5544 if (is_double)
5546 double_click_count++;
5547 event->modifiers |= ((double_click_count > 2)
5548 ? triple_modifier
5549 : double_modifier);
5551 else
5552 double_click_count = 1;
5553 button_down_time = event->timestamp;
5554 *start_pos_ptr = Fcopy_alist (position);
5555 ignore_mouse_drag_p = 0;
5558 /* Now we're releasing a button - check the co-ordinates to
5559 see if this was a click or a drag. */
5560 else if (event->modifiers & up_modifier)
5562 /* If we did not see a down before this up, ignore the up.
5563 Probably this happened because the down event chose a
5564 menu item. It would be an annoyance to treat the
5565 release of the button that chose the menu item as a
5566 separate event. */
5568 if (!CONSP (start_pos))
5569 return Qnil;
5571 event->modifiers &= ~up_modifier;
5574 Lisp_Object new_down, down;
5575 EMACS_INT xdiff = double_click_fuzz, ydiff = double_click_fuzz;
5577 /* The third element of every position
5578 should be the (x,y) pair. */
5579 down = Fcar (Fcdr (Fcdr (start_pos)));
5580 new_down = Fcar (Fcdr (Fcdr (position)));
5582 if (CONSP (down)
5583 && INTEGERP (XCAR (down)) && INTEGERP (XCDR (down)))
5585 xdiff = XINT (XCAR (new_down)) - XINT (XCAR (down));
5586 ydiff = XINT (XCDR (new_down)) - XINT (XCDR (down));
5589 if (ignore_mouse_drag_p)
5591 event->modifiers |= click_modifier;
5592 ignore_mouse_drag_p = 0;
5594 else if (xdiff < double_click_fuzz && xdiff > - double_click_fuzz
5595 && ydiff < double_click_fuzz && ydiff > - double_click_fuzz
5596 /* Maybe the mouse has moved a lot, caused scrolling, and
5597 eventually ended up at the same screen position (but
5598 not buffer position) in which case it is a drag, not
5599 a click. */
5600 /* FIXME: OTOH if the buffer position has changed
5601 because of a timer or process filter rather than
5602 because of mouse movement, it should be considered as
5603 a click. But mouse-drag-region completely ignores
5604 this case and it hasn't caused any real problem, so
5605 it's probably OK to ignore it as well. */
5606 && EQ (Fcar (Fcdr (start_pos)), Fcar (Fcdr (position))))
5607 /* Mouse hasn't moved (much). */
5608 event->modifiers |= click_modifier;
5609 else
5611 button_down_time = 0;
5612 event->modifiers |= drag_modifier;
5615 /* Don't check is_double; treat this as multiple
5616 if the down-event was multiple. */
5617 if (double_click_count > 1)
5618 event->modifiers |= ((double_click_count > 2)
5619 ? triple_modifier
5620 : double_modifier);
5623 else
5624 /* Every mouse event should either have the down_modifier or
5625 the up_modifier set. */
5626 abort ();
5629 /* Get the symbol we should use for the mouse click. */
5630 Lisp_Object head;
5632 head = modify_event_symbol (button,
5633 event->modifiers,
5634 Qmouse_click, Vlispy_mouse_stem,
5635 NULL,
5636 &mouse_syms,
5637 XVECTOR (mouse_syms)->size);
5638 if (event->modifiers & drag_modifier)
5639 return Fcons (head,
5640 Fcons (start_pos,
5641 Fcons (position,
5642 Qnil)));
5643 else if (event->modifiers & (double_modifier | triple_modifier))
5644 return Fcons (head,
5645 Fcons (position,
5646 Fcons (make_number (double_click_count),
5647 Qnil)));
5648 else
5649 return Fcons (head,
5650 Fcons (position,
5651 Qnil));
5655 case WHEEL_EVENT:
5656 case HORIZ_WHEEL_EVENT:
5658 Lisp_Object position;
5659 Lisp_Object head;
5661 /* Build the position as appropriate for this mouse click. */
5662 struct frame *f = XFRAME (event->frame_or_window);
5664 /* Ignore wheel events that were made on frame that have been
5665 deleted. */
5666 if (! FRAME_LIVE_P (f))
5667 return Qnil;
5669 position = make_lispy_position (f, event->x, event->y,
5670 event->timestamp);
5672 /* Set double or triple modifiers to indicate the wheel speed. */
5674 /* On window-system frames, use the value of
5675 double-click-fuzz as is. On other frames, interpret it
5676 as a multiple of 1/8 characters. */
5677 struct frame *fr;
5678 int fuzz;
5679 int symbol_num;
5680 int is_double;
5682 if (WINDOWP (event->frame_or_window))
5683 fr = XFRAME (XWINDOW (event->frame_or_window)->frame);
5684 else if (FRAMEP (event->frame_or_window))
5685 fr = XFRAME (event->frame_or_window);
5686 else
5687 abort ();
5689 fuzz = FRAME_WINDOW_P (fr)
5690 ? double_click_fuzz : double_click_fuzz / 8;
5692 if (event->modifiers & up_modifier)
5694 /* Emit a wheel-up event. */
5695 event->modifiers &= ~up_modifier;
5696 symbol_num = 0;
5698 else if (event->modifiers & down_modifier)
5700 /* Emit a wheel-down event. */
5701 event->modifiers &= ~down_modifier;
5702 symbol_num = 1;
5704 else
5705 /* Every wheel event should either have the down_modifier or
5706 the up_modifier set. */
5707 abort ();
5709 if (event->kind == HORIZ_WHEEL_EVENT)
5710 symbol_num += 2;
5712 is_double = (last_mouse_button == - (1 + symbol_num)
5713 && (eabs (XINT (event->x) - last_mouse_x) <= fuzz)
5714 && (eabs (XINT (event->y) - last_mouse_y) <= fuzz)
5715 && button_down_time != 0
5716 && (EQ (Vdouble_click_time, Qt)
5717 || (INTEGERP (Vdouble_click_time)
5718 && ((int)(event->timestamp - button_down_time)
5719 < XINT (Vdouble_click_time)))));
5720 if (is_double)
5722 double_click_count++;
5723 event->modifiers |= ((double_click_count > 2)
5724 ? triple_modifier
5725 : double_modifier);
5727 else
5729 double_click_count = 1;
5730 event->modifiers |= click_modifier;
5733 button_down_time = event->timestamp;
5734 /* Use a negative value to distinguish wheel from mouse button. */
5735 last_mouse_button = - (1 + symbol_num);
5736 last_mouse_x = XINT (event->x);
5737 last_mouse_y = XINT (event->y);
5739 /* Get the symbol we should use for the wheel event. */
5740 head = modify_event_symbol (symbol_num,
5741 event->modifiers,
5742 Qmouse_click,
5743 Qnil,
5744 lispy_wheel_names,
5745 &wheel_syms,
5746 ASIZE (wheel_syms));
5749 if (event->modifiers & (double_modifier | triple_modifier))
5750 return Fcons (head,
5751 Fcons (position,
5752 Fcons (make_number (double_click_count),
5753 Qnil)));
5754 else
5755 return Fcons (head,
5756 Fcons (position,
5757 Qnil));
5761 #ifdef USE_TOOLKIT_SCROLL_BARS
5763 /* We don't have down and up events if using toolkit scroll bars,
5764 so make this always a click event. Store in the `part' of
5765 the Lisp event a symbol which maps to the following actions:
5767 `above_handle' page up
5768 `below_handle' page down
5769 `up' line up
5770 `down' line down
5771 `top' top of buffer
5772 `bottom' bottom of buffer
5773 `handle' thumb has been dragged.
5774 `end-scroll' end of interaction with scroll bar
5776 The incoming input_event contains in its `part' member an
5777 index of type `enum scroll_bar_part' which we can use as an
5778 index in scroll_bar_parts to get the appropriate symbol. */
5780 case SCROLL_BAR_CLICK_EVENT:
5782 Lisp_Object position, head, window, portion_whole, part;
5784 window = event->frame_or_window;
5785 portion_whole = Fcons (event->x, event->y);
5786 part = *scroll_bar_parts[(int) event->part];
5788 position
5789 = Fcons (window,
5790 Fcons (Qvertical_scroll_bar,
5791 Fcons (portion_whole,
5792 Fcons (make_number (event->timestamp),
5793 Fcons (part, Qnil)))));
5795 /* Always treat scroll bar events as clicks. */
5796 event->modifiers |= click_modifier;
5797 event->modifiers &= ~up_modifier;
5799 if (event->code >= ASIZE (mouse_syms))
5800 mouse_syms = larger_vector (mouse_syms, event->code + 1, Qnil);
5802 /* Get the symbol we should use for the mouse click. */
5803 head = modify_event_symbol (event->code,
5804 event->modifiers,
5805 Qmouse_click,
5806 Vlispy_mouse_stem,
5807 NULL, &mouse_syms,
5808 XVECTOR (mouse_syms)->size);
5809 return Fcons (head, Fcons (position, Qnil));
5812 #endif /* USE_TOOLKIT_SCROLL_BARS */
5814 case DRAG_N_DROP_EVENT:
5816 FRAME_PTR f;
5817 Lisp_Object head, position;
5818 Lisp_Object files;
5820 f = XFRAME (event->frame_or_window);
5821 files = event->arg;
5823 /* Ignore mouse events that were made on frames that
5824 have been deleted. */
5825 if (! FRAME_LIVE_P (f))
5826 return Qnil;
5828 position = make_lispy_position (f, event->x, event->y,
5829 event->timestamp);
5831 head = modify_event_symbol (0, event->modifiers,
5832 Qdrag_n_drop, Qnil,
5833 lispy_drag_n_drop_names,
5834 &drag_n_drop_syms, 1);
5835 return Fcons (head,
5836 Fcons (position,
5837 Fcons (files,
5838 Qnil)));
5840 #endif /* HAVE_MOUSE */
5842 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5843 || defined(HAVE_NS) || defined (USE_GTK)
5844 case MENU_BAR_EVENT:
5845 if (EQ (event->arg, event->frame_or_window))
5846 /* This is the prefix key. We translate this to
5847 `(menu_bar)' because the code in keyboard.c for menu
5848 events, which we use, relies on this. */
5849 return Fcons (Qmenu_bar, Qnil);
5850 return event->arg;
5851 #endif
5853 case SELECT_WINDOW_EVENT:
5854 /* Make an event (select-window (WINDOW)). */
5855 return Fcons (Qselect_window,
5856 Fcons (Fcons (event->frame_or_window, Qnil),
5857 Qnil));
5859 case TOOL_BAR_EVENT:
5860 if (EQ (event->arg, event->frame_or_window))
5861 /* This is the prefix key. We translate this to
5862 `(tool_bar)' because the code in keyboard.c for tool bar
5863 events, which we use, relies on this. */
5864 return Fcons (Qtool_bar, Qnil);
5865 else if (SYMBOLP (event->arg))
5866 return apply_modifiers (event->modifiers, event->arg);
5867 return event->arg;
5869 case USER_SIGNAL_EVENT:
5870 /* A user signal. */
5872 char *name = find_user_signal_name (event->code);
5873 if (!name)
5874 abort ();
5875 return intern (name);
5878 case SAVE_SESSION_EVENT:
5879 return Qsave_session;
5881 #ifdef HAVE_DBUS
5882 case DBUS_EVENT:
5884 return Fcons (Qdbus_event, event->arg);
5886 #endif /* HAVE_DBUS */
5888 case CONFIG_CHANGED_EVENT:
5889 return Fcons (Qconfig_changed_event,
5890 Fcons (event->arg,
5891 Fcons (event->frame_or_window, Qnil)));
5892 #ifdef HAVE_GPM
5893 case GPM_CLICK_EVENT:
5895 FRAME_PTR f = XFRAME (event->frame_or_window);
5896 Lisp_Object head, position;
5897 Lisp_Object *start_pos_ptr;
5898 Lisp_Object start_pos;
5899 int button = event->code;
5901 if (button >= ASIZE (button_down_location))
5903 button_down_location = larger_vector (button_down_location,
5904 button + 1, Qnil);
5905 mouse_syms = larger_vector (mouse_syms, button + 1, Qnil);
5908 start_pos_ptr = &AREF (button_down_location, button);
5909 start_pos = *start_pos_ptr;
5911 position = make_lispy_position (f, event->x, event->y,
5912 event->timestamp);
5914 if (event->modifiers & down_modifier)
5915 *start_pos_ptr = Fcopy_alist (position);
5916 else if (event->modifiers & (up_modifier | drag_modifier))
5918 if (!CONSP (start_pos))
5919 return Qnil;
5920 event->modifiers &= ~up_modifier;
5923 head = modify_event_symbol (button,
5924 event->modifiers,
5925 Qmouse_click, Vlispy_mouse_stem,
5926 NULL,
5927 &mouse_syms,
5928 XVECTOR (mouse_syms)->size);
5930 if (event->modifiers & drag_modifier)
5931 return Fcons (head,
5932 Fcons (start_pos,
5933 Fcons (position,
5934 Qnil)));
5935 else if (event->modifiers & double_modifier)
5936 return Fcons (head,
5937 Fcons (position,
5938 Fcons (make_number (2),
5939 Qnil)));
5940 else if (event->modifiers & triple_modifier)
5941 return Fcons (head,
5942 Fcons (position,
5943 Fcons (make_number (3),
5944 Qnil)));
5945 else
5946 return Fcons (head,
5947 Fcons (position,
5948 Qnil));
5950 #endif /* HAVE_GPM */
5952 /* The 'kind' field of the event is something we don't recognize. */
5953 default:
5954 abort ();
5958 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
5960 static Lisp_Object
5961 make_lispy_movement (FRAME_PTR frame, Lisp_Object bar_window, enum scroll_bar_part part,
5962 Lisp_Object x, Lisp_Object y, unsigned long t)
5964 /* Is it a scroll bar movement? */
5965 if (frame && ! NILP (bar_window))
5967 Lisp_Object part_sym;
5969 part_sym = *scroll_bar_parts[(int) part];
5970 return Fcons (Qscroll_bar_movement,
5971 Fcons (list5 (bar_window,
5972 Qvertical_scroll_bar,
5973 Fcons (x, y),
5974 make_number (t),
5975 part_sym),
5976 Qnil));
5978 /* Or is it an ordinary mouse movement? */
5979 else
5981 Lisp_Object position;
5982 position = make_lispy_position (frame, x, y, t);
5983 return list2 (Qmouse_movement, position);
5987 #endif /* HAVE_MOUSE || HAVE GPM */
5989 /* Construct a switch frame event. */
5990 static Lisp_Object
5991 make_lispy_switch_frame (Lisp_Object frame)
5993 return Fcons (Qswitch_frame, Fcons (frame, Qnil));
5996 /* Manipulating modifiers. */
5998 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6000 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6001 SYMBOL's name of the end of the modifiers; the string from this
6002 position is the unmodified symbol name.
6004 This doesn't use any caches. */
6006 static int
6007 parse_modifiers_uncached (Lisp_Object symbol, EMACS_INT *modifier_end)
6009 Lisp_Object name;
6010 EMACS_INT i;
6011 int modifiers;
6013 CHECK_SYMBOL (symbol);
6015 modifiers = 0;
6016 name = SYMBOL_NAME (symbol);
6018 for (i = 0; i+2 <= SBYTES (name); )
6020 EMACS_INT this_mod_end = 0;
6021 int this_mod = 0;
6023 /* See if the name continues with a modifier word.
6024 Check that the word appears, but don't check what follows it.
6025 Set this_mod and this_mod_end to record what we find. */
6027 switch (SREF (name, i))
6029 #define SINGLE_LETTER_MOD(BIT) \
6030 (this_mod_end = i + 1, this_mod = BIT)
6032 case 'A':
6033 SINGLE_LETTER_MOD (alt_modifier);
6034 break;
6036 case 'C':
6037 SINGLE_LETTER_MOD (ctrl_modifier);
6038 break;
6040 case 'H':
6041 SINGLE_LETTER_MOD (hyper_modifier);
6042 break;
6044 case 'M':
6045 SINGLE_LETTER_MOD (meta_modifier);
6046 break;
6048 case 'S':
6049 SINGLE_LETTER_MOD (shift_modifier);
6050 break;
6052 case 's':
6053 SINGLE_LETTER_MOD (super_modifier);
6054 break;
6056 #undef SINGLE_LETTER_MOD
6058 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6059 if (i + LEN + 1 <= SBYTES (name) \
6060 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6062 this_mod_end = i + LEN; \
6063 this_mod = BIT; \
6066 case 'd':
6067 MULTI_LETTER_MOD (drag_modifier, "drag", 4);
6068 MULTI_LETTER_MOD (down_modifier, "down", 4);
6069 MULTI_LETTER_MOD (double_modifier, "double", 6);
6070 break;
6072 case 't':
6073 MULTI_LETTER_MOD (triple_modifier, "triple", 6);
6074 break;
6075 #undef MULTI_LETTER_MOD
6079 /* If we found no modifier, stop looking for them. */
6080 if (this_mod_end == 0)
6081 break;
6083 /* Check there is a dash after the modifier, so that it
6084 really is a modifier. */
6085 if (this_mod_end >= SBYTES (name)
6086 || SREF (name, this_mod_end) != '-')
6087 break;
6089 /* This modifier is real; look for another. */
6090 modifiers |= this_mod;
6091 i = this_mod_end + 1;
6094 /* Should we include the `click' modifier? */
6095 if (! (modifiers & (down_modifier | drag_modifier
6096 | double_modifier | triple_modifier))
6097 && i + 7 == SBYTES (name)
6098 && strncmp (SSDATA (name) + i, "mouse-", 6) == 0
6099 && ('0' <= SREF (name, i + 6) && SREF (name, i + 6) <= '9'))
6100 modifiers |= click_modifier;
6102 if (! (modifiers & (double_modifier | triple_modifier))
6103 && i + 6 < SBYTES (name)
6104 && strncmp (SSDATA (name) + i, "wheel-", 6) == 0)
6105 modifiers |= click_modifier;
6107 if (modifier_end)
6108 *modifier_end = i;
6110 return modifiers;
6113 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6114 prepended to the string BASE[0..BASE_LEN-1].
6115 This doesn't use any caches. */
6116 static Lisp_Object
6117 apply_modifiers_uncached (int modifiers, char *base, int base_len, int base_len_byte)
6119 /* Since BASE could contain nulls, we can't use intern here; we have
6120 to use Fintern, which expects a genuine Lisp_String, and keeps a
6121 reference to it. */
6122 char *new_mods
6123 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6124 int mod_len;
6127 char *p = new_mods;
6129 /* Only the event queue may use the `up' modifier; it should always
6130 be turned into a click or drag event before presented to lisp code. */
6131 if (modifiers & up_modifier)
6132 abort ();
6134 if (modifiers & alt_modifier) { *p++ = 'A'; *p++ = '-'; }
6135 if (modifiers & ctrl_modifier) { *p++ = 'C'; *p++ = '-'; }
6136 if (modifiers & hyper_modifier) { *p++ = 'H'; *p++ = '-'; }
6137 if (modifiers & meta_modifier) { *p++ = 'M'; *p++ = '-'; }
6138 if (modifiers & shift_modifier) { *p++ = 'S'; *p++ = '-'; }
6139 if (modifiers & super_modifier) { *p++ = 's'; *p++ = '-'; }
6140 if (modifiers & double_modifier) { strcpy (p, "double-"); p += 7; }
6141 if (modifiers & triple_modifier) { strcpy (p, "triple-"); p += 7; }
6142 if (modifiers & down_modifier) { strcpy (p, "down-"); p += 5; }
6143 if (modifiers & drag_modifier) { strcpy (p, "drag-"); p += 5; }
6144 /* The click modifier is denoted by the absence of other modifiers. */
6146 *p = '\0';
6148 mod_len = p - new_mods;
6152 Lisp_Object new_name;
6154 new_name = make_uninit_multibyte_string (mod_len + base_len,
6155 mod_len + base_len_byte);
6156 memcpy (SDATA (new_name), new_mods, mod_len);
6157 memcpy (SDATA (new_name) + mod_len, base, base_len_byte);
6159 return Fintern (new_name, Qnil);
6164 static const char *const modifier_names[] =
6166 "up", "down", "drag", "click", "double", "triple", 0, 0,
6167 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6168 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6170 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6172 static Lisp_Object modifier_symbols;
6174 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6175 static Lisp_Object
6176 lispy_modifier_list (int modifiers)
6178 Lisp_Object modifier_list;
6179 int i;
6181 modifier_list = Qnil;
6182 for (i = 0; (1<<i) <= modifiers && i < NUM_MOD_NAMES; i++)
6183 if (modifiers & (1<<i))
6184 modifier_list = Fcons (XVECTOR (modifier_symbols)->contents[i],
6185 modifier_list);
6187 return modifier_list;
6191 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6192 where UNMODIFIED is the unmodified form of SYMBOL,
6193 MASK is the set of modifiers present in SYMBOL's name.
6194 This is similar to parse_modifiers_uncached, but uses the cache in
6195 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6196 Qevent_symbol_elements property. */
6198 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6200 Lisp_Object
6201 parse_modifiers (Lisp_Object symbol)
6203 Lisp_Object elements;
6205 if (INTEGERP (symbol))
6206 return (Fcons (make_number (KEY_TO_CHAR (symbol)),
6207 Fcons (make_number (XINT (symbol) & CHAR_MODIFIER_MASK),
6208 Qnil)));
6209 else if (!SYMBOLP (symbol))
6210 return Qnil;
6212 elements = Fget (symbol, Qevent_symbol_element_mask);
6213 if (CONSP (elements))
6214 return elements;
6215 else
6217 EMACS_INT end;
6218 int modifiers = parse_modifiers_uncached (symbol, &end);
6219 Lisp_Object unmodified;
6220 Lisp_Object mask;
6222 unmodified = Fintern (make_string (SSDATA (SYMBOL_NAME (symbol)) + end,
6223 SBYTES (SYMBOL_NAME (symbol)) - end),
6224 Qnil);
6226 if (modifiers & ~INTMASK)
6227 abort ();
6228 XSETFASTINT (mask, modifiers);
6229 elements = Fcons (unmodified, Fcons (mask, Qnil));
6231 /* Cache the parsing results on SYMBOL. */
6232 Fput (symbol, Qevent_symbol_element_mask,
6233 elements);
6234 Fput (symbol, Qevent_symbol_elements,
6235 Fcons (unmodified, lispy_modifier_list (modifiers)));
6237 /* Since we know that SYMBOL is modifiers applied to unmodified,
6238 it would be nice to put that in unmodified's cache.
6239 But we can't, since we're not sure that parse_modifiers is
6240 canonical. */
6242 return elements;
6246 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers,
6247 Sevent_symbol_parse_modifiers, 1, 1, 0,
6248 doc: /* Parse the event symbol. For internal use. */)
6249 (Lisp_Object symbol)
6251 /* Fill the cache if needed. */
6252 parse_modifiers (symbol);
6253 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6254 and use the Lispier representation stored on Qevent_symbol_elements
6255 instead. */
6256 return Fget (symbol, Qevent_symbol_elements);
6259 /* Apply the modifiers MODIFIERS to the symbol BASE.
6260 BASE must be unmodified.
6262 This is like apply_modifiers_uncached, but uses BASE's
6263 Qmodifier_cache property, if present. It also builds
6264 Qevent_symbol_elements properties, since it has that info anyway.
6266 apply_modifiers copies the value of BASE's Qevent_kind property to
6267 the modified symbol. */
6268 static Lisp_Object
6269 apply_modifiers (int modifiers, Lisp_Object base)
6271 Lisp_Object cache, idx, entry, new_symbol;
6273 /* Mask out upper bits. We don't know where this value's been. */
6274 modifiers &= INTMASK;
6276 if (INTEGERP (base))
6277 return make_number (XINT (base) | modifiers);
6279 /* The click modifier never figures into cache indices. */
6280 cache = Fget (base, Qmodifier_cache);
6281 XSETFASTINT (idx, (modifiers & ~click_modifier));
6282 entry = assq_no_quit (idx, cache);
6284 if (CONSP (entry))
6285 new_symbol = XCDR (entry);
6286 else
6288 /* We have to create the symbol ourselves. */
6289 new_symbol = apply_modifiers_uncached (modifiers,
6290 SSDATA (SYMBOL_NAME (base)),
6291 SCHARS (SYMBOL_NAME (base)),
6292 SBYTES (SYMBOL_NAME (base)));
6294 /* Add the new symbol to the base's cache. */
6295 entry = Fcons (idx, new_symbol);
6296 Fput (base, Qmodifier_cache, Fcons (entry, cache));
6298 /* We have the parsing info now for free, so we could add it to
6299 the caches:
6300 XSETFASTINT (idx, modifiers);
6301 Fput (new_symbol, Qevent_symbol_element_mask,
6302 Fcons (base, Fcons (idx, Qnil)));
6303 Fput (new_symbol, Qevent_symbol_elements,
6304 Fcons (base, lispy_modifier_list (modifiers)));
6305 Sadly, this is only correct if `base' is indeed a base event,
6306 which is not necessarily the case. -stef */
6309 /* Make sure this symbol is of the same kind as BASE.
6311 You'd think we could just set this once and for all when we
6312 intern the symbol above, but reorder_modifiers may call us when
6313 BASE's property isn't set right; we can't assume that just
6314 because it has a Qmodifier_cache property it must have its
6315 Qevent_kind set right as well. */
6316 if (NILP (Fget (new_symbol, Qevent_kind)))
6318 Lisp_Object kind;
6320 kind = Fget (base, Qevent_kind);
6321 if (! NILP (kind))
6322 Fput (new_symbol, Qevent_kind, kind);
6325 return new_symbol;
6329 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6330 return a symbol with the modifiers placed in the canonical order.
6331 Canonical order is alphabetical, except for down and drag, which
6332 always come last. The 'click' modifier is never written out.
6334 Fdefine_key calls this to make sure that (for example) C-M-foo
6335 and M-C-foo end up being equivalent in the keymap. */
6337 Lisp_Object
6338 reorder_modifiers (Lisp_Object symbol)
6340 /* It's hopefully okay to write the code this way, since everything
6341 will soon be in caches, and no consing will be done at all. */
6342 Lisp_Object parsed;
6344 parsed = parse_modifiers (symbol);
6345 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed))),
6346 XCAR (parsed));
6350 /* For handling events, we often want to produce a symbol whose name
6351 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6352 to some base, like the name of a function key or mouse button.
6353 modify_event_symbol produces symbols of this sort.
6355 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6356 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6357 in the table.
6359 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6360 into symbol names, or a string specifying a name stem used to
6361 construct a symbol name or the form `STEM-N', where N is the decimal
6362 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6363 non-nil; otherwise NAME_TABLE is used.
6365 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6366 persist between calls to modify_event_symbol that it can use to
6367 store a cache of the symbols it's generated for this NAME_TABLE
6368 before. The object stored there may be a vector or an alist.
6370 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6372 MODIFIERS is a set of modifier bits (as given in struct input_events)
6373 whose prefixes should be applied to the symbol name.
6375 SYMBOL_KIND is the value to be placed in the event_kind property of
6376 the returned symbol.
6378 The symbols we create are supposed to have an
6379 `event-symbol-elements' property, which lists the modifiers present
6380 in the symbol's name. */
6382 static Lisp_Object
6383 modify_event_symbol (EMACS_INT symbol_num, unsigned int modifiers, Lisp_Object symbol_kind,
6384 Lisp_Object name_alist_or_stem, const char *const *name_table,
6385 Lisp_Object *symbol_table, unsigned int table_size)
6387 Lisp_Object value;
6388 Lisp_Object symbol_int;
6390 /* Get rid of the "vendor-specific" bit here. */
6391 XSETINT (symbol_int, symbol_num & 0xffffff);
6393 /* Is this a request for a valid symbol? */
6394 if (symbol_num < 0 || symbol_num >= table_size)
6395 return Qnil;
6397 if (CONSP (*symbol_table))
6398 value = Fcdr (assq_no_quit (symbol_int, *symbol_table));
6400 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6401 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6402 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6403 we've never used that symbol before. */
6404 else
6406 if (! VECTORP (*symbol_table)
6407 || XVECTOR (*symbol_table)->size != table_size)
6409 Lisp_Object size;
6411 XSETFASTINT (size, table_size);
6412 *symbol_table = Fmake_vector (size, Qnil);
6415 value = XVECTOR (*symbol_table)->contents[symbol_num];
6418 /* Have we already used this symbol before? */
6419 if (NILP (value))
6421 /* No; let's create it. */
6422 if (CONSP (name_alist_or_stem))
6423 value = Fcdr_safe (Fassq (symbol_int, name_alist_or_stem));
6424 else if (STRINGP (name_alist_or_stem))
6426 int len = SBYTES (name_alist_or_stem);
6427 char *buf = (char *) alloca (len + 50);
6428 sprintf (buf, "%s-%ld", SDATA (name_alist_or_stem),
6429 (long) XINT (symbol_int) + 1);
6430 value = intern (buf);
6432 else if (name_table != 0 && name_table[symbol_num])
6433 value = intern (name_table[symbol_num]);
6435 #ifdef HAVE_WINDOW_SYSTEM
6436 if (NILP (value))
6438 char *name = x_get_keysym_name (symbol_num);
6439 if (name)
6440 value = intern (name);
6442 #endif
6444 if (NILP (value))
6446 char buf[20];
6447 sprintf (buf, "key-%ld", (long)symbol_num);
6448 value = intern (buf);
6451 if (CONSP (*symbol_table))
6452 *symbol_table = Fcons (Fcons (symbol_int, value), *symbol_table);
6453 else
6454 XVECTOR (*symbol_table)->contents[symbol_num] = value;
6456 /* Fill in the cache entries for this symbol; this also
6457 builds the Qevent_symbol_elements property, which the user
6458 cares about. */
6459 apply_modifiers (modifiers & click_modifier, value);
6460 Fput (value, Qevent_kind, symbol_kind);
6463 /* Apply modifiers to that symbol. */
6464 return apply_modifiers (modifiers, value);
6467 /* Convert a list that represents an event type,
6468 such as (ctrl meta backspace), into the usual representation of that
6469 event type as a number or a symbol. */
6471 DEFUN ("event-convert-list", Fevent_convert_list, Sevent_convert_list, 1, 1, 0,
6472 doc: /* Convert the event description list EVENT-DESC to an event type.
6473 EVENT-DESC should contain one base event type (a character or symbol)
6474 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6475 drag, down, double or triple). The base must be last.
6476 The return value is an event type (a character or symbol) which
6477 has the same base event type and all the specified modifiers. */)
6478 (Lisp_Object event_desc)
6480 Lisp_Object base;
6481 int modifiers = 0;
6482 Lisp_Object rest;
6484 base = Qnil;
6485 rest = event_desc;
6486 while (CONSP (rest))
6488 Lisp_Object elt;
6489 int this = 0;
6491 elt = XCAR (rest);
6492 rest = XCDR (rest);
6494 /* Given a symbol, see if it is a modifier name. */
6495 if (SYMBOLP (elt) && CONSP (rest))
6496 this = parse_solitary_modifier (elt);
6498 if (this != 0)
6499 modifiers |= this;
6500 else if (!NILP (base))
6501 error ("Two bases given in one event");
6502 else
6503 base = elt;
6507 /* Let the symbol A refer to the character A. */
6508 if (SYMBOLP (base) && SCHARS (SYMBOL_NAME (base)) == 1)
6509 XSETINT (base, SREF (SYMBOL_NAME (base), 0));
6511 if (INTEGERP (base))
6513 /* Turn (shift a) into A. */
6514 if ((modifiers & shift_modifier) != 0
6515 && (XINT (base) >= 'a' && XINT (base) <= 'z'))
6517 XSETINT (base, XINT (base) - ('a' - 'A'));
6518 modifiers &= ~shift_modifier;
6521 /* Turn (control a) into C-a. */
6522 if (modifiers & ctrl_modifier)
6523 return make_number ((modifiers & ~ctrl_modifier)
6524 | make_ctrl_char (XINT (base)));
6525 else
6526 return make_number (modifiers | XINT (base));
6528 else if (SYMBOLP (base))
6529 return apply_modifiers (modifiers, base);
6530 else
6532 error ("Invalid base event");
6533 return Qnil;
6537 /* Try to recognize SYMBOL as a modifier name.
6538 Return the modifier flag bit, or 0 if not recognized. */
6541 parse_solitary_modifier (Lisp_Object symbol)
6543 Lisp_Object name = SYMBOL_NAME (symbol);
6545 switch (SREF (name, 0))
6547 #define SINGLE_LETTER_MOD(BIT) \
6548 if (SBYTES (name) == 1) \
6549 return BIT;
6551 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6552 if (LEN == SBYTES (name) \
6553 && ! strncmp (SSDATA (name), NAME, LEN)) \
6554 return BIT;
6556 case 'A':
6557 SINGLE_LETTER_MOD (alt_modifier);
6558 break;
6560 case 'a':
6561 MULTI_LETTER_MOD (alt_modifier, "alt", 3);
6562 break;
6564 case 'C':
6565 SINGLE_LETTER_MOD (ctrl_modifier);
6566 break;
6568 case 'c':
6569 MULTI_LETTER_MOD (ctrl_modifier, "ctrl", 4);
6570 MULTI_LETTER_MOD (ctrl_modifier, "control", 7);
6571 break;
6573 case 'H':
6574 SINGLE_LETTER_MOD (hyper_modifier);
6575 break;
6577 case 'h':
6578 MULTI_LETTER_MOD (hyper_modifier, "hyper", 5);
6579 break;
6581 case 'M':
6582 SINGLE_LETTER_MOD (meta_modifier);
6583 break;
6585 case 'm':
6586 MULTI_LETTER_MOD (meta_modifier, "meta", 4);
6587 break;
6589 case 'S':
6590 SINGLE_LETTER_MOD (shift_modifier);
6591 break;
6593 case 's':
6594 MULTI_LETTER_MOD (shift_modifier, "shift", 5);
6595 MULTI_LETTER_MOD (super_modifier, "super", 5);
6596 SINGLE_LETTER_MOD (super_modifier);
6597 break;
6599 case 'd':
6600 MULTI_LETTER_MOD (drag_modifier, "drag", 4);
6601 MULTI_LETTER_MOD (down_modifier, "down", 4);
6602 MULTI_LETTER_MOD (double_modifier, "double", 6);
6603 break;
6605 case 't':
6606 MULTI_LETTER_MOD (triple_modifier, "triple", 6);
6607 break;
6609 #undef SINGLE_LETTER_MOD
6610 #undef MULTI_LETTER_MOD
6613 return 0;
6616 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6617 Such a list is not valid as an event,
6618 but it can be a Lucid-style event type list. */
6621 lucid_event_type_list_p (Lisp_Object object)
6623 Lisp_Object tail;
6625 if (! CONSP (object))
6626 return 0;
6628 if (EQ (XCAR (object), Qhelp_echo)
6629 || EQ (XCAR (object), Qvertical_line)
6630 || EQ (XCAR (object), Qmode_line)
6631 || EQ (XCAR (object), Qheader_line))
6632 return 0;
6634 for (tail = object; CONSP (tail); tail = XCDR (tail))
6636 Lisp_Object elt;
6637 elt = XCAR (tail);
6638 if (! (INTEGERP (elt) || SYMBOLP (elt)))
6639 return 0;
6642 return NILP (tail);
6645 /* Store into *addr a value nonzero if terminal input chars are available.
6646 Serves the purpose of ioctl (0, FIONREAD, addr)
6647 but works even if FIONREAD does not exist.
6648 (In fact, this may actually read some input.)
6650 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6651 timer events that are ripe.
6652 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6653 events (FOCUS_IN_EVENT).
6654 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6655 movements and toolkit scroll bar thumb drags. */
6657 static void
6658 get_input_pending (int *addr, int flags)
6660 /* First of all, have we already counted some input? */
6661 *addr = (!NILP (Vquit_flag) || readable_events (flags));
6663 /* If input is being read as it arrives, and we have none, there is none. */
6664 if (*addr > 0 || (interrupt_input && ! interrupts_deferred))
6665 return;
6667 /* Try to read some input and see how much we get. */
6668 gobble_input (0);
6669 *addr = (!NILP (Vquit_flag) || readable_events (flags));
6672 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6674 void
6675 gobble_input (int expected)
6677 #ifdef SIGIO
6678 if (interrupt_input)
6680 SIGMASKTYPE mask;
6681 mask = sigblock (sigmask (SIGIO));
6682 read_avail_input (expected);
6683 sigsetmask (mask);
6685 else
6686 #ifdef POLL_FOR_INPUT
6687 /* XXX This condition was (read_socket_hook && !interrupt_input),
6688 but read_socket_hook is not global anymore. Let's pretend that
6689 it's always set. */
6690 if (!interrupt_input && poll_suppress_count == 0)
6692 SIGMASKTYPE mask;
6693 mask = sigblock (sigmask (SIGALRM));
6694 read_avail_input (expected);
6695 sigsetmask (mask);
6697 else
6698 #endif
6699 #endif
6700 read_avail_input (expected);
6703 /* Put a BUFFER_SWITCH_EVENT in the buffer
6704 so that read_key_sequence will notice the new current buffer. */
6706 void
6707 record_asynch_buffer_change (void)
6709 struct input_event event;
6710 Lisp_Object tem;
6711 EVENT_INIT (event);
6713 event.kind = BUFFER_SWITCH_EVENT;
6714 event.frame_or_window = Qnil;
6715 event.arg = Qnil;
6717 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6718 The purpose of the event is to make read_key_sequence look up the
6719 keymaps again. If we aren't in read_key_sequence, we don't need one,
6720 and the event could cause trouble by messing up (input-pending-p).
6721 Note: Fwaiting_for_user_input_p always returns nil when async
6722 subprocesses aren't supported. */
6723 tem = Fwaiting_for_user_input_p ();
6724 if (NILP (tem))
6725 return;
6727 /* Make sure no interrupt happens while storing the event. */
6728 #ifdef SIGIO
6729 if (interrupt_input)
6731 SIGMASKTYPE mask;
6732 mask = sigblock (sigmask (SIGIO));
6733 kbd_buffer_store_event (&event);
6734 sigsetmask (mask);
6736 else
6737 #endif
6739 stop_polling ();
6740 kbd_buffer_store_event (&event);
6741 start_polling ();
6745 /* Read any terminal input already buffered up by the system
6746 into the kbd_buffer, but do not wait.
6748 EXPECTED should be nonzero if the caller knows there is some input.
6750 Returns the number of keyboard chars read, or -1 meaning
6751 this is a bad time to try to read input. */
6753 static int
6754 read_avail_input (int expected)
6756 int nread = 0;
6757 int err = 0;
6758 struct terminal *t;
6760 /* Store pending user signal events, if any. */
6761 if (store_user_signal_events ())
6762 expected = 0;
6764 /* Loop through the available terminals, and call their input hooks. */
6765 t = terminal_list;
6766 while (t)
6768 struct terminal *next = t->next_terminal;
6770 if (t->read_socket_hook)
6772 int nr;
6773 struct input_event hold_quit;
6775 EVENT_INIT (hold_quit);
6776 hold_quit.kind = NO_EVENT;
6778 /* No need for FIONREAD or fcntl; just say don't wait. */
6779 while (nr = (*t->read_socket_hook) (t, expected, &hold_quit), nr > 0)
6781 nread += nr;
6782 expected = 0;
6785 if (nr == -1) /* Not OK to read input now. */
6787 err = 1;
6789 else if (nr == -2) /* Non-transient error. */
6791 /* The terminal device terminated; it should be closed. */
6793 /* Kill Emacs if this was our last terminal. */
6794 if (!terminal_list->next_terminal)
6795 /* Formerly simply reported no input, but that
6796 sometimes led to a failure of Emacs to terminate.
6797 SIGHUP seems appropriate if we can't reach the
6798 terminal. */
6799 /* ??? Is it really right to send the signal just to
6800 this process rather than to the whole process
6801 group? Perhaps on systems with FIONREAD Emacs is
6802 alone in its group. */
6803 kill (getpid (), SIGHUP);
6805 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6807 Lisp_Object tmp;
6808 XSETTERMINAL (tmp, t);
6809 Fdelete_terminal (tmp, Qnoelisp);
6813 if (hold_quit.kind != NO_EVENT)
6814 kbd_buffer_store_event (&hold_quit);
6817 t = next;
6820 if (err && !nread)
6821 nread = -1;
6823 frame_make_pointer_visible ();
6825 return nread;
6828 static void
6829 decode_keyboard_code (struct tty_display_info *tty,
6830 struct coding_system *coding,
6831 unsigned char *buf, int nbytes)
6833 unsigned char *src = buf;
6834 const unsigned char *p;
6835 int i;
6837 if (nbytes == 0)
6838 return;
6839 if (tty->meta_key != 2)
6840 for (i = 0; i < nbytes; i++)
6841 buf[i] &= ~0x80;
6842 if (coding->carryover_bytes > 0)
6844 src = alloca (coding->carryover_bytes + nbytes);
6845 memcpy (src, coding->carryover, coding->carryover_bytes);
6846 memcpy (src + coding->carryover_bytes, buf, nbytes);
6847 nbytes += coding->carryover_bytes;
6849 coding->destination = alloca (nbytes * 4);
6850 coding->dst_bytes = nbytes * 4;
6851 decode_coding_c_string (coding, src, nbytes, Qnil);
6852 if (coding->produced_char == 0)
6853 return;
6854 for (i = 0, p = coding->destination; i < coding->produced_char; i++)
6856 struct input_event event_buf;
6858 EVENT_INIT (event_buf);
6859 event_buf.code = STRING_CHAR_ADVANCE (p);
6860 event_buf.kind =
6861 (ASCII_CHAR_P (event_buf.code)
6862 ? ASCII_KEYSTROKE_EVENT : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6863 /* See the comment in tty_read_avail_input. */
6864 event_buf.frame_or_window = tty->top_frame;
6865 event_buf.arg = Qnil;
6866 kbd_buffer_store_event (&event_buf);
6870 /* This is the tty way of reading available input.
6872 Note that each terminal device has its own `struct terminal' object,
6873 and so this function is called once for each individual termcap
6874 terminal. The first parameter indicates which terminal to read from. */
6877 tty_read_avail_input (struct terminal *terminal,
6878 int expected,
6879 struct input_event *hold_quit)
6881 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6882 the kbd_buffer can really hold. That may prevent loss
6883 of characters on some systems when input is stuffed at us. */
6884 unsigned char cbuf[KBD_BUFFER_SIZE - 1];
6885 int n_to_read, i;
6886 struct tty_display_info *tty = terminal->display_info.tty;
6887 int nread = 0;
6888 #ifdef subprocesses
6889 int buffer_free = KBD_BUFFER_SIZE - kbd_buffer_nr_stored () - 1;
6891 if (kbd_on_hold_p () || buffer_free <= 0)
6892 return 0;
6893 #endif /* subprocesses */
6895 if (!terminal->name) /* Don't read from a dead terminal. */
6896 return 0;
6898 if (terminal->type != output_termcap
6899 && terminal->type != output_msdos_raw)
6900 abort ();
6902 /* XXX I think the following code should be moved to separate hook
6903 functions in system-dependent files. */
6904 #ifdef WINDOWSNT
6905 return 0;
6906 #else /* not WINDOWSNT */
6907 if (! tty->term_initted) /* In case we get called during bootstrap. */
6908 return 0;
6910 if (! tty->input)
6911 return 0; /* The terminal is suspended. */
6913 #ifdef MSDOS
6914 n_to_read = dos_keysns ();
6915 if (n_to_read == 0)
6916 return 0;
6918 cbuf[0] = dos_keyread ();
6919 nread = 1;
6921 #else /* not MSDOS */
6922 #ifdef HAVE_GPM
6923 if (gpm_tty == tty)
6925 Gpm_Event event;
6926 struct input_event gpm_hold_quit;
6927 int gpm, fd = gpm_fd;
6929 EVENT_INIT (gpm_hold_quit);
6930 gpm_hold_quit.kind = NO_EVENT;
6932 /* gpm==1 if event received.
6933 gpm==0 if the GPM daemon has closed the connection, in which case
6934 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6935 we save it in `fd' so close_gpm can remove it from the
6936 select masks.
6937 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6938 while (gpm = Gpm_GetEvent (&event), gpm == 1) {
6939 nread += handle_one_term_event (tty, &event, &gpm_hold_quit);
6941 if (gpm == 0)
6942 /* Presumably the GPM daemon has closed the connection. */
6943 close_gpm (fd);
6944 if (gpm_hold_quit.kind != NO_EVENT)
6945 kbd_buffer_store_event (&gpm_hold_quit);
6946 if (nread)
6947 return nread;
6949 #endif /* HAVE_GPM */
6951 /* Determine how many characters we should *try* to read. */
6952 #ifdef FIONREAD
6953 /* Find out how much input is available. */
6954 if (ioctl (fileno (tty->input), FIONREAD, &n_to_read) < 0)
6956 if (! noninteractive)
6957 return -2; /* Close this terminal. */
6958 else
6959 n_to_read = 0;
6961 if (n_to_read == 0)
6962 return 0;
6963 if (n_to_read > sizeof cbuf)
6964 n_to_read = sizeof cbuf;
6965 #else /* no FIONREAD */
6966 #if defined (USG) || defined(CYGWIN)
6967 /* Read some input if available, but don't wait. */
6968 n_to_read = sizeof cbuf;
6969 fcntl (fileno (tty->input), F_SETFL, O_NDELAY);
6970 #else
6971 you lose;
6972 #endif
6973 #endif
6975 #ifdef subprocesses
6976 /* Don't read more than we can store. */
6977 if (n_to_read > buffer_free)
6978 n_to_read = buffer_free;
6979 #endif /* subprocesses */
6981 /* Now read; for one reason or another, this will not block.
6982 NREAD is set to the number of chars read. */
6985 nread = emacs_read (fileno (tty->input), (char *) cbuf, n_to_read);
6986 /* POSIX infers that processes which are not in the session leader's
6987 process group won't get SIGHUP's at logout time. BSDI adheres to
6988 this part standard and returns -1 from read (0) with errno==EIO
6989 when the control tty is taken away.
6990 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6991 if (nread == -1 && errno == EIO)
6992 return -2; /* Close this terminal. */
6993 #if defined (AIX) && defined (_BSD)
6994 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6995 This looks incorrect, but it isn't, because _BSD causes
6996 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6997 and that causes a value other than 0 when there is no input. */
6998 if (nread == 0)
6999 return -2; /* Close this terminal. */
7000 #endif
7002 while (
7003 /* We used to retry the read if it was interrupted.
7004 But this does the wrong thing when O_NDELAY causes
7005 an EAGAIN error. Does anybody know of a situation
7006 where a retry is actually needed? */
7007 #if 0
7008 nread < 0 && (errno == EAGAIN
7009 #ifdef EFAULT
7010 || errno == EFAULT
7011 #endif
7012 #ifdef EBADSLT
7013 || errno == EBADSLT
7014 #endif
7016 #else
7018 #endif
7021 #ifndef FIONREAD
7022 #if defined (USG) || defined (CYGWIN)
7023 fcntl (fileno (tty->input), F_SETFL, 0);
7024 #endif /* USG or CYGWIN */
7025 #endif /* no FIONREAD */
7027 if (nread <= 0)
7028 return nread;
7030 #endif /* not MSDOS */
7031 #endif /* not WINDOWSNT */
7033 if (TERMINAL_KEYBOARD_CODING (terminal)->common_flags
7034 & CODING_REQUIRE_DECODING_MASK)
7036 struct coding_system *coding = TERMINAL_KEYBOARD_CODING (terminal);
7037 int from;
7039 /* Decode the key sequence except for those with meta
7040 modifiers. */
7041 for (i = from = 0; ; i++)
7042 if (i == nread || (tty->meta_key == 1 && (cbuf[i] & 0x80)))
7044 struct input_event buf;
7046 decode_keyboard_code (tty, coding, cbuf + from, i - from);
7047 if (i == nread)
7048 break;
7050 EVENT_INIT (buf);
7051 buf.kind = ASCII_KEYSTROKE_EVENT;
7052 buf.modifiers = meta_modifier;
7053 buf.code = cbuf[i] & ~0x80;
7054 /* See the comment below. */
7055 buf.frame_or_window = tty->top_frame;
7056 buf.arg = Qnil;
7057 kbd_buffer_store_event (&buf);
7058 from = i + 1;
7060 return nread;
7063 for (i = 0; i < nread; i++)
7065 struct input_event buf;
7066 EVENT_INIT (buf);
7067 buf.kind = ASCII_KEYSTROKE_EVENT;
7068 buf.modifiers = 0;
7069 if (tty->meta_key == 1 && (cbuf[i] & 0x80))
7070 buf.modifiers = meta_modifier;
7071 if (tty->meta_key != 2)
7072 cbuf[i] &= ~0x80;
7074 buf.code = cbuf[i];
7075 /* Set the frame corresponding to the active tty. Note that the
7076 value of selected_frame is not reliable here, redisplay tends
7077 to temporarily change it. */
7078 buf.frame_or_window = tty->top_frame;
7079 buf.arg = Qnil;
7081 kbd_buffer_store_event (&buf);
7082 /* Don't look at input that follows a C-g too closely.
7083 This reduces lossage due to autorepeat on C-g. */
7084 if (buf.kind == ASCII_KEYSTROKE_EVENT
7085 && buf.code == quit_char)
7086 break;
7089 return nread;
7092 static void
7093 handle_async_input (void)
7095 interrupt_input_pending = 0;
7096 #ifdef SYNC_INPUT
7097 pending_signals = pending_atimers;
7098 #endif
7099 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7100 doing anything dangerous. */
7101 #ifdef HAVE_NS
7102 ++handling_signal;
7103 #endif
7104 while (1)
7106 int nread;
7107 nread = read_avail_input (1);
7108 /* -1 means it's not ok to read the input now.
7109 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7110 0 means there was no keyboard input available. */
7111 if (nread <= 0)
7112 break;
7114 #ifdef HAVE_NS
7115 --handling_signal;
7116 #endif
7119 void
7120 process_pending_signals (void)
7122 if (interrupt_input_pending)
7123 handle_async_input ();
7124 do_pending_atimers ();
7127 #ifdef SIGIO /* for entire page */
7128 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7130 static void
7131 input_available_signal (int signo)
7133 /* Must preserve main program's value of errno. */
7134 int old_errno = errno;
7135 SIGNAL_THREAD_CHECK (signo);
7137 #ifdef SYNC_INPUT
7138 interrupt_input_pending = 1;
7139 pending_signals = 1;
7140 #endif
7142 if (input_available_clear_time)
7143 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
7145 #ifndef SYNC_INPUT
7146 handle_async_input ();
7147 #endif
7149 errno = old_errno;
7151 #endif /* SIGIO */
7153 /* Send ourselves a SIGIO.
7155 This function exists so that the UNBLOCK_INPUT macro in
7156 blockinput.h can have some way to take care of input we put off
7157 dealing with, without assuming that every file which uses
7158 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7159 void
7160 reinvoke_input_signal (void)
7162 #ifdef SIGIO
7163 handle_async_input ();
7164 #endif
7169 /* User signal events. */
7171 struct user_signal_info
7173 /* Signal number. */
7174 int sig;
7176 /* Name of the signal. */
7177 char *name;
7179 /* Number of pending signals. */
7180 int npending;
7182 struct user_signal_info *next;
7185 /* List of user signals. */
7186 static struct user_signal_info *user_signals = NULL;
7188 void
7189 add_user_signal (int sig, const char *name)
7191 struct user_signal_info *p;
7193 for (p = user_signals; p; p = p->next)
7194 if (p->sig == sig)
7195 /* Already added. */
7196 return;
7198 p = xmalloc (sizeof (struct user_signal_info));
7199 p->sig = sig;
7200 p->name = xstrdup (name);
7201 p->npending = 0;
7202 p->next = user_signals;
7203 user_signals = p;
7205 signal (sig, handle_user_signal);
7208 static void
7209 handle_user_signal (int sig)
7211 int old_errno = errno;
7212 struct user_signal_info *p;
7214 SIGNAL_THREAD_CHECK (sig);
7216 for (p = user_signals; p; p = p->next)
7217 if (p->sig == sig)
7219 p->npending++;
7220 #ifdef SIGIO
7221 if (interrupt_input)
7222 kill (getpid (), SIGIO);
7223 else
7224 #endif
7226 /* Tell wait_reading_process_output that it needs to wake
7227 up and look around. */
7228 if (input_available_clear_time)
7229 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
7231 break;
7234 errno = old_errno;
7237 static char *
7238 find_user_signal_name (int sig)
7240 struct user_signal_info *p;
7242 for (p = user_signals; p; p = p->next)
7243 if (p->sig == sig)
7244 return p->name;
7246 return NULL;
7249 static int
7250 store_user_signal_events (void)
7252 struct user_signal_info *p;
7253 struct input_event buf;
7254 int nstored = 0;
7256 for (p = user_signals; p; p = p->next)
7257 if (p->npending > 0)
7259 SIGMASKTYPE mask;
7261 if (nstored == 0)
7263 memset (&buf, 0, sizeof buf);
7264 buf.kind = USER_SIGNAL_EVENT;
7265 buf.frame_or_window = selected_frame;
7267 nstored += p->npending;
7269 mask = sigblock (sigmask (p->sig));
7272 buf.code = p->sig;
7273 kbd_buffer_store_event (&buf);
7274 p->npending--;
7276 while (p->npending > 0);
7277 sigsetmask (mask);
7280 return nstored;
7284 static void menu_bar_item (Lisp_Object, Lisp_Object, Lisp_Object, void*);
7285 static Lisp_Object menu_bar_one_keymap_changed_items;
7287 /* These variables hold the vector under construction within
7288 menu_bar_items and its subroutines, and the current index
7289 for storing into that vector. */
7290 static Lisp_Object menu_bar_items_vector;
7291 static int menu_bar_items_index;
7294 static const char* separator_names[] = {
7295 "space",
7296 "no-line",
7297 "single-line",
7298 "double-line",
7299 "single-dashed-line",
7300 "double-dashed-line",
7301 "shadow-etched-in",
7302 "shadow-etched-out",
7303 "shadow-etched-in-dash",
7304 "shadow-etched-out-dash",
7305 "shadow-double-etched-in",
7306 "shadow-double-etched-out",
7307 "shadow-double-etched-in-dash",
7308 "shadow-double-etched-out-dash",
7312 /* Return non-zero if LABEL specifies a separator. */
7315 menu_separator_name_p (const char *label)
7317 if (!label)
7318 return 0;
7319 else if (strlen (label) > 3
7320 && strncmp (label, "--", 2) == 0
7321 && label[2] != '-')
7323 int i;
7324 label += 2;
7325 for (i = 0; separator_names[i]; ++i)
7326 if (strcmp (label, separator_names[i]) == 0)
7327 return 1;
7329 else
7331 /* It's a separator if it contains only dashes. */
7332 while (*label == '-')
7333 ++label;
7334 return (*label == 0);
7337 return 0;
7341 /* Return a vector of menu items for a menu bar, appropriate
7342 to the current buffer. Each item has three elements in the vector:
7343 KEY STRING MAPLIST.
7345 OLD is an old vector we can optionally reuse, or nil. */
7347 Lisp_Object
7348 menu_bar_items (Lisp_Object old)
7350 /* The number of keymaps we're scanning right now, and the number of
7351 keymaps we have allocated space for. */
7352 int nmaps;
7354 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7355 in the current keymaps, or nil where it is not a prefix. */
7356 Lisp_Object *maps;
7358 Lisp_Object def, tail;
7360 Lisp_Object result;
7362 int mapno;
7363 Lisp_Object oquit;
7365 /* In order to build the menus, we need to call the keymap
7366 accessors. They all call QUIT. But this function is called
7367 during redisplay, during which a quit is fatal. So inhibit
7368 quitting while building the menus.
7369 We do this instead of specbind because (1) errors will clear it anyway
7370 and (2) this avoids risk of specpdl overflow. */
7371 oquit = Vinhibit_quit;
7372 Vinhibit_quit = Qt;
7374 if (!NILP (old))
7375 menu_bar_items_vector = old;
7376 else
7377 menu_bar_items_vector = Fmake_vector (make_number (24), Qnil);
7378 menu_bar_items_index = 0;
7380 /* Build our list of keymaps.
7381 If we recognize a function key and replace its escape sequence in
7382 keybuf with its symbol, or if the sequence starts with a mouse
7383 click and we need to switch buffers, we jump back here to rebuild
7384 the initial keymaps from the current buffer. */
7386 Lisp_Object *tmaps;
7388 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7389 if (!NILP (Voverriding_local_map_menu_flag))
7391 /* Yes, use them (if non-nil) as well as the global map. */
7392 maps = (Lisp_Object *) alloca (3 * sizeof (maps[0]));
7393 nmaps = 0;
7394 if (!NILP (KVAR (current_kboard, Voverriding_terminal_local_map)))
7395 maps[nmaps++] = KVAR (current_kboard, Voverriding_terminal_local_map);
7396 if (!NILP (Voverriding_local_map))
7397 maps[nmaps++] = Voverriding_local_map;
7399 else
7401 /* No, so use major and minor mode keymaps and keymap property.
7402 Note that menu-bar bindings in the local-map and keymap
7403 properties may not work reliable, as they are only
7404 recognized when the menu-bar (or mode-line) is updated,
7405 which does not normally happen after every command. */
7406 Lisp_Object tem;
7407 int nminor;
7408 nminor = current_minor_maps (NULL, &tmaps);
7409 maps = (Lisp_Object *) alloca ((nminor + 3) * sizeof (maps[0]));
7410 nmaps = 0;
7411 if (tem = get_local_map (PT, current_buffer, Qkeymap), !NILP (tem))
7412 maps[nmaps++] = tem;
7413 memcpy (maps + nmaps, tmaps, nminor * sizeof (maps[0]));
7414 nmaps += nminor;
7415 maps[nmaps++] = get_local_map (PT, current_buffer, Qlocal_map);
7417 maps[nmaps++] = current_global_map;
7420 /* Look up in each map the dummy prefix key `menu-bar'. */
7422 result = Qnil;
7424 for (mapno = nmaps - 1; mapno >= 0; mapno--)
7425 if (!NILP (maps[mapno]))
7427 def = get_keymap (access_keymap (maps[mapno], Qmenu_bar, 1, 0, 1),
7428 0, 1);
7429 if (CONSP (def))
7431 menu_bar_one_keymap_changed_items = Qnil;
7432 map_keymap (def, menu_bar_item, Qnil, NULL, 1);
7436 /* Move to the end those items that should be at the end. */
7438 for (tail = Vmenu_bar_final_items; CONSP (tail); tail = XCDR (tail))
7440 int i;
7441 int end = menu_bar_items_index;
7443 for (i = 0; i < end; i += 4)
7444 if (EQ (XCAR (tail), XVECTOR (menu_bar_items_vector)->contents[i]))
7446 Lisp_Object tem0, tem1, tem2, tem3;
7447 /* Move the item at index I to the end,
7448 shifting all the others forward. */
7449 tem0 = XVECTOR (menu_bar_items_vector)->contents[i + 0];
7450 tem1 = XVECTOR (menu_bar_items_vector)->contents[i + 1];
7451 tem2 = XVECTOR (menu_bar_items_vector)->contents[i + 2];
7452 tem3 = XVECTOR (menu_bar_items_vector)->contents[i + 3];
7453 if (end > i + 4)
7454 memmove (&XVECTOR (menu_bar_items_vector)->contents[i],
7455 &XVECTOR (menu_bar_items_vector)->contents[i + 4],
7456 (end - i - 4) * sizeof (Lisp_Object));
7457 XVECTOR (menu_bar_items_vector)->contents[end - 4] = tem0;
7458 XVECTOR (menu_bar_items_vector)->contents[end - 3] = tem1;
7459 XVECTOR (menu_bar_items_vector)->contents[end - 2] = tem2;
7460 XVECTOR (menu_bar_items_vector)->contents[end - 1] = tem3;
7461 break;
7465 /* Add nil, nil, nil, nil at the end. */
7467 int i = menu_bar_items_index;
7468 if (i + 4 > XVECTOR (menu_bar_items_vector)->size)
7469 menu_bar_items_vector =
7470 larger_vector (menu_bar_items_vector, 2 * i, Qnil);
7471 /* Add this item. */
7472 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
7473 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
7474 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
7475 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
7476 menu_bar_items_index = i;
7479 Vinhibit_quit = oquit;
7480 return menu_bar_items_vector;
7483 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7484 If there's already an item for KEY, add this DEF to it. */
7486 Lisp_Object item_properties;
7488 static void
7489 menu_bar_item (Lisp_Object key, Lisp_Object item, Lisp_Object dummy1, void *dummy2)
7491 struct gcpro gcpro1;
7492 int i;
7493 Lisp_Object tem;
7495 if (EQ (item, Qundefined))
7497 /* If a map has an explicit `undefined' as definition,
7498 discard any previously made menu bar item. */
7500 for (i = 0; i < menu_bar_items_index; i += 4)
7501 if (EQ (key, XVECTOR (menu_bar_items_vector)->contents[i]))
7503 if (menu_bar_items_index > i + 4)
7504 memmove (&XVECTOR (menu_bar_items_vector)->contents[i],
7505 &XVECTOR (menu_bar_items_vector)->contents[i + 4],
7506 (menu_bar_items_index - i - 4) * sizeof (Lisp_Object));
7507 menu_bar_items_index -= 4;
7511 /* If this keymap has already contributed to this KEY,
7512 don't contribute to it a second time. */
7513 tem = Fmemq (key, menu_bar_one_keymap_changed_items);
7514 if (!NILP (tem) || NILP (item))
7515 return;
7517 menu_bar_one_keymap_changed_items
7518 = Fcons (key, menu_bar_one_keymap_changed_items);
7520 /* We add to menu_bar_one_keymap_changed_items before doing the
7521 parse_menu_item, so that if it turns out it wasn't a menu item,
7522 it still correctly hides any further menu item. */
7523 GCPRO1 (key);
7524 i = parse_menu_item (item, 1);
7525 UNGCPRO;
7526 if (!i)
7527 return;
7529 item = XVECTOR (item_properties)->contents[ITEM_PROPERTY_DEF];
7531 /* Find any existing item for this KEY. */
7532 for (i = 0; i < menu_bar_items_index; i += 4)
7533 if (EQ (key, XVECTOR (menu_bar_items_vector)->contents[i]))
7534 break;
7536 /* If we did not find this KEY, add it at the end. */
7537 if (i == menu_bar_items_index)
7539 /* If vector is too small, get a bigger one. */
7540 if (i + 4 > XVECTOR (menu_bar_items_vector)->size)
7541 menu_bar_items_vector = larger_vector (menu_bar_items_vector, 2 * i, Qnil);
7542 /* Add this item. */
7543 XVECTOR (menu_bar_items_vector)->contents[i++] = key;
7544 XVECTOR (menu_bar_items_vector)->contents[i++]
7545 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_NAME];
7546 XVECTOR (menu_bar_items_vector)->contents[i++] = Fcons (item, Qnil);
7547 XVECTOR (menu_bar_items_vector)->contents[i++] = make_number (0);
7548 menu_bar_items_index = i;
7550 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7551 else
7553 Lisp_Object old;
7554 old = XVECTOR (menu_bar_items_vector)->contents[i + 2];
7555 /* If the new and the old items are not both keymaps,
7556 the lookup will only find `item'. */
7557 item = Fcons (item, KEYMAPP (item) && KEYMAPP (XCAR (old)) ? old : Qnil);
7558 XVECTOR (menu_bar_items_vector)->contents[i + 2] = item;
7562 /* This is used as the handler when calling menu_item_eval_property. */
7563 static Lisp_Object
7564 menu_item_eval_property_1 (Lisp_Object arg)
7566 /* If we got a quit from within the menu computation,
7567 quit all the way out of it. This takes care of C-] in the debugger. */
7568 if (CONSP (arg) && EQ (XCAR (arg), Qquit))
7569 Fsignal (Qquit, Qnil);
7571 return Qnil;
7574 static Lisp_Object
7575 eval_dyn (Lisp_Object form)
7577 return Feval (form, Qnil);
7580 /* Evaluate an expression and return the result (or nil if something
7581 went wrong). Used to evaluate dynamic parts of menu items. */
7582 Lisp_Object
7583 menu_item_eval_property (Lisp_Object sexpr)
7585 int count = SPECPDL_INDEX ();
7586 Lisp_Object val;
7587 specbind (Qinhibit_redisplay, Qt);
7588 val = internal_condition_case_1 (eval_dyn, sexpr, Qerror,
7589 menu_item_eval_property_1);
7590 return unbind_to (count, val);
7593 /* This function parses a menu item and leaves the result in the
7594 vector item_properties.
7595 ITEM is a key binding, a possible menu item.
7596 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7597 top level.
7598 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7599 parse_menu_item returns true if the item is a menu item and false
7600 otherwise. */
7603 parse_menu_item (Lisp_Object item, int inmenubar)
7605 Lisp_Object def, tem, item_string, start;
7606 Lisp_Object filter;
7607 Lisp_Object keyhint;
7608 int i;
7610 filter = Qnil;
7611 keyhint = Qnil;
7613 if (!CONSP (item))
7614 return 0;
7616 /* Create item_properties vector if necessary. */
7617 if (NILP (item_properties))
7618 item_properties
7619 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE + 1), Qnil);
7621 /* Initialize optional entries. */
7622 for (i = ITEM_PROPERTY_DEF; i < ITEM_PROPERTY_ENABLE; i++)
7623 ASET (item_properties, i, Qnil);
7624 ASET (item_properties, ITEM_PROPERTY_ENABLE, Qt);
7626 /* Save the item here to protect it from GC. */
7627 ASET (item_properties, ITEM_PROPERTY_ITEM, item);
7629 item_string = XCAR (item);
7631 start = item;
7632 item = XCDR (item);
7633 if (STRINGP (item_string))
7635 /* Old format menu item. */
7636 ASET (item_properties, ITEM_PROPERTY_NAME, item_string);
7638 /* Maybe help string. */
7639 if (CONSP (item) && STRINGP (XCAR (item)))
7641 ASET (item_properties, ITEM_PROPERTY_HELP, XCAR (item));
7642 start = item;
7643 item = XCDR (item);
7646 /* Maybe an obsolete key binding cache. */
7647 if (CONSP (item) && CONSP (XCAR (item))
7648 && (NILP (XCAR (XCAR (item)))
7649 || VECTORP (XCAR (XCAR (item)))))
7650 item = XCDR (item);
7652 /* This is the real definition--the function to run. */
7653 ASET (item_properties, ITEM_PROPERTY_DEF, item);
7655 /* Get enable property, if any. */
7656 if (SYMBOLP (item))
7658 tem = Fget (item, Qmenu_enable);
7659 if (!NILP (Venable_disabled_menus_and_buttons))
7660 ASET (item_properties, ITEM_PROPERTY_ENABLE, Qt);
7661 else if (!NILP (tem))
7662 ASET (item_properties, ITEM_PROPERTY_ENABLE, tem);
7665 else if (EQ (item_string, Qmenu_item) && CONSP (item))
7667 /* New format menu item. */
7668 ASET (item_properties, ITEM_PROPERTY_NAME, XCAR (item));
7669 start = XCDR (item);
7670 if (CONSP (start))
7672 /* We have a real binding. */
7673 ASET (item_properties, ITEM_PROPERTY_DEF, XCAR (start));
7675 item = XCDR (start);
7676 /* Is there an obsolete cache list with key equivalences. */
7677 if (CONSP (item) && CONSP (XCAR (item)))
7678 item = XCDR (item);
7680 /* Parse properties. */
7681 while (CONSP (item) && CONSP (XCDR (item)))
7683 tem = XCAR (item);
7684 item = XCDR (item);
7686 if (EQ (tem, QCenable))
7688 if (!NILP (Venable_disabled_menus_and_buttons))
7689 ASET (item_properties, ITEM_PROPERTY_ENABLE, Qt);
7690 else
7691 ASET (item_properties, ITEM_PROPERTY_ENABLE, XCAR (item));
7693 else if (EQ (tem, QCvisible))
7695 /* If got a visible property and that evaluates to nil
7696 then ignore this item. */
7697 tem = menu_item_eval_property (XCAR (item));
7698 if (NILP (tem))
7699 return 0;
7701 else if (EQ (tem, QChelp))
7702 ASET (item_properties, ITEM_PROPERTY_HELP, XCAR (item));
7703 else if (EQ (tem, QCfilter))
7704 filter = item;
7705 else if (EQ (tem, QCkey_sequence))
7707 tem = XCAR (item);
7708 if (SYMBOLP (tem) || STRINGP (tem) || VECTORP (tem))
7709 /* Be GC protected. Set keyhint to item instead of tem. */
7710 keyhint = item;
7712 else if (EQ (tem, QCkeys))
7714 tem = XCAR (item);
7715 if (CONSP (tem) || STRINGP (tem))
7716 ASET (item_properties, ITEM_PROPERTY_KEYEQ, tem);
7718 else if (EQ (tem, QCbutton) && CONSP (XCAR (item)))
7720 Lisp_Object type;
7721 tem = XCAR (item);
7722 type = XCAR (tem);
7723 if (EQ (type, QCtoggle) || EQ (type, QCradio))
7725 ASET (item_properties, ITEM_PROPERTY_SELECTED,
7726 XCDR (tem));
7727 ASET (item_properties, ITEM_PROPERTY_TYPE, type);
7730 item = XCDR (item);
7733 else if (inmenubar || !NILP (start))
7734 return 0;
7736 else
7737 return 0; /* not a menu item */
7739 /* If item string is not a string, evaluate it to get string.
7740 If we don't get a string, skip this item. */
7741 item_string = AREF (item_properties, ITEM_PROPERTY_NAME);
7742 if (!(STRINGP (item_string)))
7744 item_string = menu_item_eval_property (item_string);
7745 if (!STRINGP (item_string))
7746 return 0;
7747 ASET (item_properties, ITEM_PROPERTY_NAME, item_string);
7750 /* If got a filter apply it on definition. */
7751 def = AREF (item_properties, ITEM_PROPERTY_DEF);
7752 if (!NILP (filter))
7754 def = menu_item_eval_property (list2 (XCAR (filter),
7755 list2 (Qquote, def)));
7757 ASET (item_properties, ITEM_PROPERTY_DEF, def);
7760 /* Enable or disable selection of item. */
7761 tem = AREF (item_properties, ITEM_PROPERTY_ENABLE);
7762 if (!EQ (tem, Qt))
7764 tem = menu_item_eval_property (tem);
7765 if (inmenubar && NILP (tem))
7766 return 0; /* Ignore disabled items in menu bar. */
7767 ASET (item_properties, ITEM_PROPERTY_ENABLE, tem);
7770 /* If we got no definition, this item is just unselectable text which
7771 is OK in a submenu but not in the menubar. */
7772 if (NILP (def))
7773 return (inmenubar ? 0 : 1);
7775 /* See if this is a separate pane or a submenu. */
7776 def = AREF (item_properties, ITEM_PROPERTY_DEF);
7777 tem = get_keymap (def, 0, 1);
7778 /* For a subkeymap, just record its details and exit. */
7779 if (CONSP (tem))
7781 ASET (item_properties, ITEM_PROPERTY_MAP, tem);
7782 ASET (item_properties, ITEM_PROPERTY_DEF, tem);
7783 return 1;
7786 /* At the top level in the menu bar, do likewise for commands also.
7787 The menu bar does not display equivalent key bindings anyway.
7788 ITEM_PROPERTY_DEF is already set up properly. */
7789 if (inmenubar > 0)
7790 return 1;
7792 { /* This is a command. See if there is an equivalent key binding. */
7793 Lisp_Object keyeq = AREF (item_properties, ITEM_PROPERTY_KEYEQ);
7795 /* The previous code preferred :key-sequence to :keys, so we
7796 preserve this behavior. */
7797 if (STRINGP (keyeq) && !CONSP (keyhint))
7798 keyeq = concat2 (build_string (" "), Fsubstitute_command_keys (keyeq));
7799 else
7801 Lisp_Object prefix = keyeq;
7802 Lisp_Object keys = Qnil;
7804 if (CONSP (prefix))
7806 def = XCAR (prefix);
7807 prefix = XCDR (prefix);
7809 else
7810 def = AREF (item_properties, ITEM_PROPERTY_DEF);
7812 if (CONSP (keyhint) && !NILP (XCAR (keyhint)))
7814 keys = XCAR (keyhint);
7815 tem = Fkey_binding (keys, Qnil, Qnil, Qnil);
7817 /* We have a suggested key. Is it bound to the command? */
7818 if (NILP (tem)
7819 || (!EQ (tem, def)
7820 /* If the command is an alias for another
7821 (such as lmenu.el set it up), check if the
7822 original command matches the cached command. */
7823 && !(SYMBOLP (def) && EQ (tem, XSYMBOL (def)->function))))
7824 keys = Qnil;
7827 if (NILP (keys))
7828 keys = Fwhere_is_internal (def, Qnil, Qt, Qnil, Qnil);
7830 if (!NILP (keys))
7832 tem = Fkey_description (keys, Qnil);
7833 if (CONSP (prefix))
7835 if (STRINGP (XCAR (prefix)))
7836 tem = concat2 (XCAR (prefix), tem);
7837 if (STRINGP (XCDR (prefix)))
7838 tem = concat2 (tem, XCDR (prefix));
7840 keyeq = concat2 (build_string (" "), tem);
7841 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7843 else
7844 keyeq = Qnil;
7847 /* If we have an equivalent key binding, use that. */
7848 ASET (item_properties, ITEM_PROPERTY_KEYEQ, keyeq);
7851 /* Include this when menu help is implemented.
7852 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7853 if (!(NILP (tem) || STRINGP (tem)))
7855 tem = menu_item_eval_property (tem);
7856 if (!STRINGP (tem))
7857 tem = Qnil;
7858 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7862 /* Handle radio buttons or toggle boxes. */
7863 tem = AREF (item_properties, ITEM_PROPERTY_SELECTED);
7864 if (!NILP (tem))
7865 ASET (item_properties, ITEM_PROPERTY_SELECTED,
7866 menu_item_eval_property (tem));
7868 return 1;
7873 /***********************************************************************
7874 Tool-bars
7875 ***********************************************************************/
7877 /* A vector holding tool bar items while they are parsed in function
7878 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7879 in the vector. */
7881 static Lisp_Object tool_bar_items_vector;
7883 /* A vector holding the result of parse_tool_bar_item. Layout is like
7884 the one for a single item in tool_bar_items_vector. */
7886 static Lisp_Object tool_bar_item_properties;
7888 /* Next free index in tool_bar_items_vector. */
7890 static int ntool_bar_items;
7892 /* The symbols `:image' and `:rtl'. */
7894 Lisp_Object QCimage;
7895 Lisp_Object Qrtl;
7897 /* Function prototypes. */
7899 static void init_tool_bar_items (Lisp_Object);
7900 static void process_tool_bar_item (Lisp_Object, Lisp_Object, Lisp_Object, void*);
7901 static int parse_tool_bar_item (Lisp_Object, Lisp_Object);
7902 static void append_tool_bar_item (void);
7905 /* Return a vector of tool bar items for keymaps currently in effect.
7906 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7907 tool bar items found. */
7909 Lisp_Object
7910 tool_bar_items (Lisp_Object reuse, int *nitems)
7912 Lisp_Object *maps;
7913 int nmaps, i;
7914 Lisp_Object oquit;
7915 Lisp_Object *tmaps;
7917 *nitems = 0;
7919 /* In order to build the menus, we need to call the keymap
7920 accessors. They all call QUIT. But this function is called
7921 during redisplay, during which a quit is fatal. So inhibit
7922 quitting while building the menus. We do this instead of
7923 specbind because (1) errors will clear it anyway and (2) this
7924 avoids risk of specpdl overflow. */
7925 oquit = Vinhibit_quit;
7926 Vinhibit_quit = Qt;
7928 /* Initialize tool_bar_items_vector and protect it from GC. */
7929 init_tool_bar_items (reuse);
7931 /* Build list of keymaps in maps. Set nmaps to the number of maps
7932 to process. */
7934 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7935 if (!NILP (Voverriding_local_map_menu_flag))
7937 /* Yes, use them (if non-nil) as well as the global map. */
7938 maps = (Lisp_Object *) alloca (3 * sizeof (maps[0]));
7939 nmaps = 0;
7940 if (!NILP (KVAR (current_kboard, Voverriding_terminal_local_map)))
7941 maps[nmaps++] = KVAR (current_kboard, Voverriding_terminal_local_map);
7942 if (!NILP (Voverriding_local_map))
7943 maps[nmaps++] = Voverriding_local_map;
7945 else
7947 /* No, so use major and minor mode keymaps and keymap property.
7948 Note that tool-bar bindings in the local-map and keymap
7949 properties may not work reliable, as they are only
7950 recognized when the tool-bar (or mode-line) is updated,
7951 which does not normally happen after every command. */
7952 Lisp_Object tem;
7953 int nminor;
7954 nminor = current_minor_maps (NULL, &tmaps);
7955 maps = (Lisp_Object *) alloca ((nminor + 3) * sizeof (maps[0]));
7956 nmaps = 0;
7957 if (tem = get_local_map (PT, current_buffer, Qkeymap), !NILP (tem))
7958 maps[nmaps++] = tem;
7959 memcpy (maps + nmaps, tmaps, nminor * sizeof (maps[0]));
7960 nmaps += nminor;
7961 maps[nmaps++] = get_local_map (PT, current_buffer, Qlocal_map);
7964 /* Add global keymap at the end. */
7965 maps[nmaps++] = current_global_map;
7967 /* Process maps in reverse order and look up in each map the prefix
7968 key `tool-bar'. */
7969 for (i = nmaps - 1; i >= 0; --i)
7970 if (!NILP (maps[i]))
7972 Lisp_Object keymap;
7974 keymap = get_keymap (access_keymap (maps[i], Qtool_bar, 1, 0, 1), 0, 1);
7975 if (CONSP (keymap))
7976 map_keymap (keymap, process_tool_bar_item, Qnil, NULL, 1);
7979 Vinhibit_quit = oquit;
7980 *nitems = ntool_bar_items / TOOL_BAR_ITEM_NSLOTS;
7981 return tool_bar_items_vector;
7985 /* Process the definition of KEY which is DEF. */
7987 static void
7988 process_tool_bar_item (Lisp_Object key, Lisp_Object def, Lisp_Object data, void *args)
7990 int i;
7991 struct gcpro gcpro1, gcpro2;
7993 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7994 eval. */
7995 GCPRO2 (key, def);
7997 if (EQ (def, Qundefined))
7999 /* If a map has an explicit `undefined' as definition,
8000 discard any previously made item. */
8001 for (i = 0; i < ntool_bar_items; i += TOOL_BAR_ITEM_NSLOTS)
8003 Lisp_Object *v = XVECTOR (tool_bar_items_vector)->contents + i;
8005 if (EQ (key, v[TOOL_BAR_ITEM_KEY]))
8007 if (ntool_bar_items > i + TOOL_BAR_ITEM_NSLOTS)
8008 memmove (v, v + TOOL_BAR_ITEM_NSLOTS,
8009 ((ntool_bar_items - i - TOOL_BAR_ITEM_NSLOTS)
8010 * sizeof (Lisp_Object)));
8011 ntool_bar_items -= TOOL_BAR_ITEM_NSLOTS;
8012 break;
8016 else if (parse_tool_bar_item (key, def))
8017 /* Append a new tool bar item to tool_bar_items_vector. Accept
8018 more than one definition for the same key. */
8019 append_tool_bar_item ();
8021 UNGCPRO;
8025 /* Parse a tool bar item specification ITEM for key KEY and return the
8026 result in tool_bar_item_properties. Value is zero if ITEM is
8027 invalid.
8029 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8031 CAPTION is the caption of the item, If it's not a string, it is
8032 evaluated to get a string.
8034 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8035 as binding are currently ignored.
8037 The following properties are recognized:
8039 - `:enable FORM'.
8041 FORM is evaluated and specifies whether the tool bar item is
8042 enabled or disabled.
8044 - `:visible FORM'
8046 FORM is evaluated and specifies whether the tool bar item is visible.
8048 - `:filter FUNCTION'
8050 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8051 result is stored as the new binding.
8053 - `:button (TYPE SELECTED)'
8055 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8056 and specifies whether the button is selected (pressed) or not.
8058 - `:image IMAGES'
8060 IMAGES is either a single image specification or a vector of four
8061 image specifications. See enum tool_bar_item_images.
8063 - `:help HELP-STRING'.
8065 Gives a help string to display for the tool bar item.
8067 - `:label LABEL-STRING'.
8069 A text label to show with the tool bar button if labels are enabled. */
8071 static int
8072 parse_tool_bar_item (Lisp_Object key, Lisp_Object item)
8074 /* Access slot with index IDX of vector tool_bar_item_properties. */
8075 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8077 Lisp_Object filter = Qnil;
8078 Lisp_Object caption;
8079 int i, have_label = 0;
8081 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8082 Rule out items that aren't lists, don't start with
8083 `menu-item' or whose rest following `tool-bar-item' is not a
8084 list. */
8085 if (!CONSP (item))
8086 return 0;
8088 /* As an exception, allow old-style menu separators. */
8089 if (STRINGP (XCAR (item)))
8090 item = Fcons (XCAR (item), Qnil);
8091 else if (!EQ (XCAR (item), Qmenu_item)
8092 || (item = XCDR (item), !CONSP (item)))
8093 return 0;
8095 /* Create tool_bar_item_properties vector if necessary. Reset it to
8096 defaults. */
8097 if (VECTORP (tool_bar_item_properties))
8099 for (i = 0; i < TOOL_BAR_ITEM_NSLOTS; ++i)
8100 PROP (i) = Qnil;
8102 else
8103 tool_bar_item_properties
8104 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS), Qnil);
8106 /* Set defaults. */
8107 PROP (TOOL_BAR_ITEM_KEY) = key;
8108 PROP (TOOL_BAR_ITEM_ENABLED_P) = Qt;
8110 /* Get the caption of the item. If the caption is not a string,
8111 evaluate it to get a string. If we don't get a string, skip this
8112 item. */
8113 caption = XCAR (item);
8114 if (!STRINGP (caption))
8116 caption = menu_item_eval_property (caption);
8117 if (!STRINGP (caption))
8118 return 0;
8120 PROP (TOOL_BAR_ITEM_CAPTION) = caption;
8122 /* If the rest following the caption is not a list, the menu item is
8123 either a separator, or invalid. */
8124 item = XCDR (item);
8125 if (!CONSP (item))
8127 if (menu_separator_name_p (SSDATA (caption)))
8129 PROP (TOOL_BAR_ITEM_TYPE) = Qt;
8130 #if !defined (USE_GTK) && !defined (HAVE_NS)
8131 /* If we use build_desired_tool_bar_string to render the
8132 tool bar, the separator is rendered as an image. */
8133 PROP (TOOL_BAR_ITEM_IMAGES)
8134 = menu_item_eval_property (Vtool_bar_separator_image_expression);
8135 PROP (TOOL_BAR_ITEM_ENABLED_P) = Qnil;
8136 PROP (TOOL_BAR_ITEM_SELECTED_P) = Qnil;
8137 PROP (TOOL_BAR_ITEM_CAPTION) = Qnil;
8138 #endif
8139 return 1;
8141 return 0;
8144 /* Store the binding. */
8145 PROP (TOOL_BAR_ITEM_BINDING) = XCAR (item);
8146 item = XCDR (item);
8148 /* Ignore cached key binding, if any. */
8149 if (CONSP (item) && CONSP (XCAR (item)))
8150 item = XCDR (item);
8152 /* Process the rest of the properties. */
8153 for (; CONSP (item) && CONSP (XCDR (item)); item = XCDR (XCDR (item)))
8155 Lisp_Object ikey, value;
8157 ikey = XCAR (item);
8158 value = XCAR (XCDR (item));
8160 if (EQ (ikey, QCenable))
8162 /* `:enable FORM'. */
8163 if (!NILP (Venable_disabled_menus_and_buttons))
8164 PROP (TOOL_BAR_ITEM_ENABLED_P) = Qt;
8165 else
8166 PROP (TOOL_BAR_ITEM_ENABLED_P) = value;
8168 else if (EQ (ikey, QCvisible))
8170 /* `:visible FORM'. If got a visible property and that
8171 evaluates to nil then ignore this item. */
8172 if (NILP (menu_item_eval_property (value)))
8173 return 0;
8175 else if (EQ (ikey, QChelp))
8176 /* `:help HELP-STRING'. */
8177 PROP (TOOL_BAR_ITEM_HELP) = value;
8178 else if (EQ (ikey, QCvert_only))
8179 /* `:vert-only t/nil'. */
8180 PROP (TOOL_BAR_ITEM_VERT_ONLY) = value;
8181 else if (EQ (ikey, QClabel))
8183 const char *bad_label = "!!?GARBLED ITEM?!!";
8184 /* `:label LABEL-STRING'. */
8185 PROP (TOOL_BAR_ITEM_LABEL) = STRINGP (value)
8186 ? value
8187 : make_string (bad_label, strlen (bad_label));
8188 have_label = 1;
8190 else if (EQ (ikey, QCfilter))
8191 /* ':filter FORM'. */
8192 filter = value;
8193 else if (EQ (ikey, QCbutton) && CONSP (value))
8195 /* `:button (TYPE . SELECTED)'. */
8196 Lisp_Object type, selected;
8198 type = XCAR (value);
8199 selected = XCDR (value);
8200 if (EQ (type, QCtoggle) || EQ (type, QCradio))
8202 PROP (TOOL_BAR_ITEM_SELECTED_P) = selected;
8203 PROP (TOOL_BAR_ITEM_TYPE) = type;
8206 else if (EQ (ikey, QCimage)
8207 && (CONSP (value)
8208 || (VECTORP (value) && XVECTOR (value)->size == 4)))
8209 /* Value is either a single image specification or a vector
8210 of 4 such specifications for the different button states. */
8211 PROP (TOOL_BAR_ITEM_IMAGES) = value;
8212 else if (EQ (ikey, Qrtl))
8213 /* ':rtl STRING' */
8214 PROP (TOOL_BAR_ITEM_RTL_IMAGE) = value;
8218 if (!have_label)
8220 /* Try to make one from caption and key. */
8221 Lisp_Object tkey = PROP (TOOL_BAR_ITEM_KEY);
8222 Lisp_Object tcapt = PROP (TOOL_BAR_ITEM_CAPTION);
8223 const char *label = SYMBOLP (tkey) ? SSDATA (SYMBOL_NAME (tkey)) : "";
8224 const char *capt = STRINGP (tcapt) ? SSDATA (tcapt) : "";
8225 EMACS_INT max_lbl = 2 * tool_bar_max_label_size;
8226 char *buf = (char *) xmalloc (max_lbl + 1);
8227 Lisp_Object new_lbl;
8228 size_t caption_len = strlen (capt);
8230 if (caption_len <= max_lbl && capt[0] != '\0')
8232 strcpy (buf, capt);
8233 while (caption_len > 0 && buf[caption_len - 1] == '.')
8234 caption_len--;
8235 buf[caption_len] = '\0';
8236 label = capt = buf;
8239 if (strlen (label) <= max_lbl && label[0] != '\0')
8241 int j;
8242 if (label != buf)
8243 strcpy (buf, label);
8245 for (j = 0; buf[j] != '\0'; ++j)
8246 if (buf[j] == '-')
8247 buf[j] = ' ';
8248 label = buf;
8250 else
8251 label = "";
8253 new_lbl = Fupcase_initials (make_string (label, strlen (label)));
8254 if (SCHARS (new_lbl) <= tool_bar_max_label_size)
8255 PROP (TOOL_BAR_ITEM_LABEL) = new_lbl;
8256 else
8257 PROP (TOOL_BAR_ITEM_LABEL) = make_string ("", 0);
8258 free (buf);
8261 /* If got a filter apply it on binding. */
8262 if (!NILP (filter))
8263 PROP (TOOL_BAR_ITEM_BINDING)
8264 = menu_item_eval_property (list2 (filter,
8265 list2 (Qquote,
8266 PROP (TOOL_BAR_ITEM_BINDING))));
8268 /* See if the binding is a keymap. Give up if it is. */
8269 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING), 0, 1)))
8270 return 0;
8272 /* Enable or disable selection of item. */
8273 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P), Qt))
8274 PROP (TOOL_BAR_ITEM_ENABLED_P)
8275 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P));
8277 /* Handle radio buttons or toggle boxes. */
8278 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P)))
8279 PROP (TOOL_BAR_ITEM_SELECTED_P)
8280 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P));
8282 return 1;
8284 #undef PROP
8288 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8289 that can be reused. */
8291 static void
8292 init_tool_bar_items (Lisp_Object reuse)
8294 if (VECTORP (reuse))
8295 tool_bar_items_vector = reuse;
8296 else
8297 tool_bar_items_vector = Fmake_vector (make_number (64), Qnil);
8298 ntool_bar_items = 0;
8302 /* Append parsed tool bar item properties from
8303 tool_bar_item_properties */
8305 static void
8306 append_tool_bar_item (void)
8308 Lisp_Object *to, *from;
8310 /* Enlarge tool_bar_items_vector if necessary. */
8311 if (ntool_bar_items + TOOL_BAR_ITEM_NSLOTS
8312 >= XVECTOR (tool_bar_items_vector)->size)
8313 tool_bar_items_vector
8314 = larger_vector (tool_bar_items_vector,
8315 2 * XVECTOR (tool_bar_items_vector)->size, Qnil);
8317 /* Append entries from tool_bar_item_properties to the end of
8318 tool_bar_items_vector. */
8319 to = XVECTOR (tool_bar_items_vector)->contents + ntool_bar_items;
8320 from = XVECTOR (tool_bar_item_properties)->contents;
8321 memcpy (to, from, TOOL_BAR_ITEM_NSLOTS * sizeof *to);
8322 ntool_bar_items += TOOL_BAR_ITEM_NSLOTS;
8329 /* Read a character using menus based on maps in the array MAPS.
8330 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8331 Return t if we displayed a menu but the user rejected it.
8333 PREV_EVENT is the previous input event, or nil if we are reading
8334 the first event of a key sequence.
8336 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8337 if we used a mouse menu to read the input, or zero otherwise. If
8338 USED_MOUSE_MENU is null, we don't dereference it.
8340 The prompting is done based on the prompt-string of the map
8341 and the strings associated with various map elements.
8343 This can be done with X menus or with menus put in the minibuf.
8344 These are done in different ways, depending on how the input will be read.
8345 Menus using X are done after auto-saving in read-char, getting the input
8346 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8347 and do auto-saving in the inner call of read_char. */
8349 static Lisp_Object
8350 read_char_x_menu_prompt (int nmaps, Lisp_Object *maps, Lisp_Object prev_event,
8351 int *used_mouse_menu)
8353 int mapno;
8355 if (used_mouse_menu)
8356 *used_mouse_menu = 0;
8358 /* Use local over global Menu maps */
8360 if (! menu_prompting)
8361 return Qnil;
8363 /* Optionally disregard all but the global map. */
8364 if (inhibit_local_menu_bar_menus)
8366 maps += (nmaps - 1);
8367 nmaps = 1;
8370 #ifdef HAVE_MENUS
8371 /* If we got to this point via a mouse click,
8372 use a real menu for mouse selection. */
8373 if (EVENT_HAS_PARAMETERS (prev_event)
8374 && !EQ (XCAR (prev_event), Qmenu_bar)
8375 && !EQ (XCAR (prev_event), Qtool_bar))
8377 /* Display the menu and get the selection. */
8378 Lisp_Object *realmaps
8379 = (Lisp_Object *) alloca (nmaps * sizeof (Lisp_Object));
8380 Lisp_Object value;
8381 int nmaps1 = 0;
8383 /* Use the maps that are not nil. */
8384 for (mapno = 0; mapno < nmaps; mapno++)
8385 if (!NILP (maps[mapno]))
8386 realmaps[nmaps1++] = maps[mapno];
8388 value = Fx_popup_menu (prev_event, Flist (nmaps1, realmaps));
8389 if (CONSP (value))
8391 Lisp_Object tem;
8393 record_menu_key (XCAR (value));
8395 /* If we got multiple events, unread all but
8396 the first.
8397 There is no way to prevent those unread events
8398 from showing up later in last_nonmenu_event.
8399 So turn symbol and integer events into lists,
8400 to indicate that they came from a mouse menu,
8401 so that when present in last_nonmenu_event
8402 they won't confuse things. */
8403 for (tem = XCDR (value); CONSP (tem); tem = XCDR (tem))
8405 record_menu_key (XCAR (tem));
8406 if (SYMBOLP (XCAR (tem))
8407 || INTEGERP (XCAR (tem)))
8408 XSETCAR (tem, Fcons (XCAR (tem), Qdisabled));
8411 /* If we got more than one event, put all but the first
8412 onto this list to be read later.
8413 Return just the first event now. */
8414 Vunread_command_events
8415 = nconc2 (XCDR (value), Vunread_command_events);
8416 value = XCAR (value);
8418 else if (NILP (value))
8419 value = Qt;
8420 if (used_mouse_menu)
8421 *used_mouse_menu = 1;
8422 return value;
8424 #endif /* HAVE_MENUS */
8425 return Qnil ;
8428 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8429 We make this bigger when necessary, and never free it. */
8430 static char *read_char_minibuf_menu_text;
8431 /* Size of that buffer. */
8432 static int read_char_minibuf_menu_width;
8434 static Lisp_Object
8435 read_char_minibuf_menu_prompt (int commandflag, int nmaps, Lisp_Object *maps)
8437 int mapno;
8438 register Lisp_Object name;
8439 int nlength;
8440 /* FIXME: Use the minibuffer's frame width. */
8441 int width = FRAME_COLS (SELECTED_FRAME ()) - 4;
8442 int idx = -1;
8443 int nobindings = 1;
8444 Lisp_Object rest, vector;
8445 char *menu;
8447 vector = Qnil;
8448 name = Qnil;
8450 if (! menu_prompting)
8451 return Qnil;
8453 /* Get the menu name from the first map that has one (a prompt string). */
8454 for (mapno = 0; mapno < nmaps; mapno++)
8456 name = Fkeymap_prompt (maps[mapno]);
8457 if (!NILP (name))
8458 break;
8461 /* If we don't have any menus, just read a character normally. */
8462 if (!STRINGP (name))
8463 return Qnil;
8465 /* Make sure we have a big enough buffer for the menu text. */
8466 width = max (width, SBYTES (name));
8467 if (read_char_minibuf_menu_text == 0)
8469 read_char_minibuf_menu_width = width + 4;
8470 read_char_minibuf_menu_text = (char *) xmalloc (width + 4);
8472 else if (width + 4 > read_char_minibuf_menu_width)
8474 read_char_minibuf_menu_width = width + 4;
8475 read_char_minibuf_menu_text
8476 = (char *) xrealloc (read_char_minibuf_menu_text, width + 4);
8478 menu = read_char_minibuf_menu_text;
8480 /* Prompt string always starts with map's prompt, and a space. */
8481 strcpy (menu, SSDATA (name));
8482 nlength = SBYTES (name);
8483 menu[nlength++] = ':';
8484 menu[nlength++] = ' ';
8485 menu[nlength] = 0;
8487 /* Start prompting at start of first map. */
8488 mapno = 0;
8489 rest = maps[mapno];
8491 /* Present the documented bindings, a line at a time. */
8492 while (1)
8494 int notfirst = 0;
8495 int i = nlength;
8496 Lisp_Object obj;
8497 int ch;
8498 Lisp_Object orig_defn_macro;
8500 /* Loop over elements of map. */
8501 while (i < width)
8503 Lisp_Object elt;
8505 /* If reached end of map, start at beginning of next map. */
8506 if (NILP (rest))
8508 mapno++;
8509 /* At end of last map, wrap around to first map if just starting,
8510 or end this line if already have something on it. */
8511 if (mapno == nmaps)
8513 mapno = 0;
8514 if (notfirst || nobindings) break;
8516 rest = maps[mapno];
8519 /* Look at the next element of the map. */
8520 if (idx >= 0)
8521 elt = XVECTOR (vector)->contents[idx];
8522 else
8523 elt = Fcar_safe (rest);
8525 if (idx < 0 && VECTORP (elt))
8527 /* If we found a dense table in the keymap,
8528 advanced past it, but start scanning its contents. */
8529 rest = Fcdr_safe (rest);
8530 vector = elt;
8531 idx = 0;
8533 else
8535 /* An ordinary element. */
8536 Lisp_Object event, tem;
8538 if (idx < 0)
8540 event = Fcar_safe (elt); /* alist */
8541 elt = Fcdr_safe (elt);
8543 else
8545 XSETINT (event, idx); /* vector */
8548 /* Ignore the element if it has no prompt string. */
8549 if (INTEGERP (event) && parse_menu_item (elt, -1))
8551 /* 1 if the char to type matches the string. */
8552 int char_matches;
8553 Lisp_Object upcased_event, downcased_event;
8554 Lisp_Object desc = Qnil;
8555 Lisp_Object s
8556 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_NAME];
8558 upcased_event = Fupcase (event);
8559 downcased_event = Fdowncase (event);
8560 char_matches = (XINT (upcased_event) == SREF (s, 0)
8561 || XINT (downcased_event) == SREF (s, 0));
8562 if (! char_matches)
8563 desc = Fsingle_key_description (event, Qnil);
8565 #if 0 /* It is redundant to list the equivalent key bindings because
8566 the prefix is what the user has already typed. */
8568 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_KEYEQ];
8569 if (!NILP (tem))
8570 /* Insert equivalent keybinding. */
8571 s = concat2 (s, tem);
8572 #endif
8574 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_TYPE];
8575 if (EQ (tem, QCradio) || EQ (tem, QCtoggle))
8577 /* Insert button prefix. */
8578 Lisp_Object selected
8579 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_SELECTED];
8580 if (EQ (tem, QCradio))
8581 tem = build_string (NILP (selected) ? "(*) " : "( ) ");
8582 else
8583 tem = build_string (NILP (selected) ? "[X] " : "[ ] ");
8584 s = concat2 (tem, s);
8588 /* If we have room for the prompt string, add it to this line.
8589 If this is the first on the line, always add it. */
8590 if ((SCHARS (s) + i + 2
8591 + (char_matches ? 0 : SCHARS (desc) + 3))
8592 < width
8593 || !notfirst)
8595 int thiswidth;
8597 /* Punctuate between strings. */
8598 if (notfirst)
8600 strcpy (menu + i, ", ");
8601 i += 2;
8603 notfirst = 1;
8604 nobindings = 0 ;
8606 /* If the char to type doesn't match the string's
8607 first char, explicitly show what char to type. */
8608 if (! char_matches)
8610 /* Add as much of string as fits. */
8611 thiswidth = SCHARS (desc);
8612 if (thiswidth + i > width)
8613 thiswidth = width - i;
8614 memcpy (menu + i, SDATA (desc), thiswidth);
8615 i += thiswidth;
8616 strcpy (menu + i, " = ");
8617 i += 3;
8620 /* Add as much of string as fits. */
8621 thiswidth = SCHARS (s);
8622 if (thiswidth + i > width)
8623 thiswidth = width - i;
8624 memcpy (menu + i, SDATA (s), thiswidth);
8625 i += thiswidth;
8626 menu[i] = 0;
8628 else
8630 /* If this element does not fit, end the line now,
8631 and save the element for the next line. */
8632 strcpy (menu + i, "...");
8633 break;
8637 /* Move past this element. */
8638 if (idx >= 0 && idx + 1 >= XVECTOR (vector)->size)
8639 /* Handle reaching end of dense table. */
8640 idx = -1;
8641 if (idx >= 0)
8642 idx++;
8643 else
8644 rest = Fcdr_safe (rest);
8648 /* Prompt with that and read response. */
8649 message2_nolog (menu, strlen (menu),
8650 ! NILP (BVAR (current_buffer, enable_multibyte_characters)));
8652 /* Make believe its not a keyboard macro in case the help char
8653 is pressed. Help characters are not recorded because menu prompting
8654 is not used on replay.
8656 orig_defn_macro = KVAR (current_kboard, defining_kbd_macro);
8657 KVAR (current_kboard, defining_kbd_macro) = Qnil;
8659 obj = read_char (commandflag, 0, 0, Qt, 0, NULL);
8660 while (BUFFERP (obj));
8661 KVAR (current_kboard, defining_kbd_macro) = orig_defn_macro;
8663 if (!INTEGERP (obj))
8664 return obj;
8665 else if (XINT (obj) == -2)
8666 return obj;
8667 else
8668 ch = XINT (obj);
8670 if (! EQ (obj, menu_prompt_more_char)
8671 && (!INTEGERP (menu_prompt_more_char)
8672 || ! EQ (obj, make_number (Ctl (XINT (menu_prompt_more_char))))))
8674 if (!NILP (KVAR (current_kboard, defining_kbd_macro)))
8675 store_kbd_macro_char (obj);
8676 return obj;
8678 /* Help char - go round again */
8682 /* Reading key sequences. */
8684 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8685 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8686 keymap, or nil otherwise. Return the index of the first keymap in
8687 which KEY has any binding, or NMAPS if no map has a binding.
8689 If KEY is a meta ASCII character, treat it like meta-prefix-char
8690 followed by the corresponding non-meta character. Keymaps in
8691 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8692 NEXT.
8694 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8695 unmodified.
8697 NEXT may be the same array as CURRENT. */
8699 static int
8700 follow_key (Lisp_Object key, int nmaps, Lisp_Object *current, Lisp_Object *defs,
8701 Lisp_Object *next)
8703 int i, first_binding;
8705 first_binding = nmaps;
8706 for (i = nmaps - 1; i >= 0; i--)
8708 if (! NILP (current[i]))
8710 defs[i] = access_keymap (current[i], key, 1, 0, 1);
8711 if (! NILP (defs[i]))
8712 first_binding = i;
8714 else
8715 defs[i] = Qnil;
8718 /* Given the set of bindings we've found, produce the next set of maps. */
8719 if (first_binding < nmaps)
8720 for (i = 0; i < nmaps; i++)
8721 next[i] = NILP (defs[i]) ? Qnil : get_keymap (defs[i], 0, 1);
8723 return first_binding;
8726 /* Structure used to keep track of partial application of key remapping
8727 such as Vfunction_key_map and Vkey_translation_map. */
8728 typedef struct keyremap
8730 /* This is the map originally specified for this use. */
8731 Lisp_Object parent;
8732 /* This is a submap reached by looking up, in PARENT,
8733 the events from START to END. */
8734 Lisp_Object map;
8735 /* Positions [START, END) in the key sequence buffer
8736 are the key that we have scanned so far.
8737 Those events are the ones that we will replace
8738 if PAREHT maps them into a key sequence. */
8739 int start, end;
8740 } keyremap;
8742 /* Lookup KEY in MAP.
8743 MAP is a keymap mapping keys to key vectors or functions.
8744 If the mapping is a function and DO_FUNCTION is non-zero, then
8745 the function is called with PROMPT as parameter and its return
8746 value is used as the return value of this function (after checking
8747 that it is indeed a vector). */
8749 static Lisp_Object
8750 access_keymap_keyremap (Lisp_Object map, Lisp_Object key, Lisp_Object prompt,
8751 int do_funcall)
8753 Lisp_Object next;
8755 next = access_keymap (map, key, 1, 0, 1);
8757 /* Handle symbol with autoload definition. */
8758 if (SYMBOLP (next) && !NILP (Ffboundp (next))
8759 && CONSP (XSYMBOL (next)->function)
8760 && EQ (XCAR (XSYMBOL (next)->function), Qautoload))
8761 do_autoload (XSYMBOL (next)->function, next);
8763 /* Handle a symbol whose function definition is a keymap
8764 or an array. */
8765 if (SYMBOLP (next) && !NILP (Ffboundp (next))
8766 && (ARRAYP (XSYMBOL (next)->function)
8767 || KEYMAPP (XSYMBOL (next)->function)))
8768 next = XSYMBOL (next)->function;
8770 /* If the keymap gives a function, not an
8771 array, then call the function with one arg and use
8772 its value instead. */
8773 if (SYMBOLP (next) && !NILP (Ffboundp (next)) && do_funcall)
8775 Lisp_Object tem;
8776 tem = next;
8778 next = call1 (next, prompt);
8779 /* If the function returned something invalid,
8780 barf--don't ignore it.
8781 (To ignore it safely, we would need to gcpro a bunch of
8782 other variables.) */
8783 if (! (VECTORP (next) || STRINGP (next)))
8784 error ("Function %s returns invalid key sequence", tem);
8786 return next;
8789 /* Do one step of the key remapping used for function-key-map and
8790 key-translation-map:
8791 KEYBUF is the buffer holding the input events.
8792 BUFSIZE is its maximum size.
8793 FKEY is a pointer to the keyremap structure to use.
8794 INPUT is the index of the last element in KEYBUF.
8795 DOIT if non-zero says that the remapping can actually take place.
8796 DIFF is used to return the number of keys added/removed by the remapping.
8797 PARENT is the root of the keymap.
8798 PROMPT is the prompt to use if the remapping happens through a function.
8799 The return value is non-zero if the remapping actually took place. */
8801 static int
8802 keyremap_step (Lisp_Object *keybuf, size_t bufsize, volatile keyremap *fkey,
8803 int input, int doit, int *diff, Lisp_Object prompt)
8805 Lisp_Object next, key;
8807 key = keybuf[fkey->end++];
8809 if (KEYMAPP (fkey->parent))
8810 next = access_keymap_keyremap (fkey->map, key, prompt, doit);
8811 else
8812 next = Qnil;
8814 /* If keybuf[fkey->start..fkey->end] is bound in the
8815 map and we're in a position to do the key remapping, replace it with
8816 the binding and restart with fkey->start at the end. */
8817 if ((VECTORP (next) || STRINGP (next)) && doit)
8819 int len = XFASTINT (Flength (next));
8820 int i;
8822 *diff = len - (fkey->end - fkey->start);
8824 if (input + *diff >= bufsize)
8825 error ("Key sequence too long");
8827 /* Shift the keys that follow fkey->end. */
8828 if (*diff < 0)
8829 for (i = fkey->end; i < input; i++)
8830 keybuf[i + *diff] = keybuf[i];
8831 else if (*diff > 0)
8832 for (i = input - 1; i >= fkey->end; i--)
8833 keybuf[i + *diff] = keybuf[i];
8834 /* Overwrite the old keys with the new ones. */
8835 for (i = 0; i < len; i++)
8836 keybuf[fkey->start + i]
8837 = Faref (next, make_number (i));
8839 fkey->start = fkey->end += *diff;
8840 fkey->map = fkey->parent;
8842 return 1;
8845 fkey->map = get_keymap (next, 0, 1);
8847 /* If we no longer have a bound suffix, try a new position for
8848 fkey->start. */
8849 if (!CONSP (fkey->map))
8851 fkey->end = ++fkey->start;
8852 fkey->map = fkey->parent;
8854 return 0;
8857 /* Read a sequence of keys that ends with a non prefix character,
8858 storing it in KEYBUF, a buffer of size BUFSIZE.
8859 Prompt with PROMPT.
8860 Return the length of the key sequence stored.
8861 Return -1 if the user rejected a command menu.
8863 Echo starting immediately unless `prompt' is 0.
8865 Where a key sequence ends depends on the currently active keymaps.
8866 These include any minor mode keymaps active in the current buffer,
8867 the current buffer's local map, and the global map.
8869 If a key sequence has no other bindings, we check Vfunction_key_map
8870 to see if some trailing subsequence might be the beginning of a
8871 function key's sequence. If so, we try to read the whole function
8872 key, and substitute its symbolic name into the key sequence.
8874 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8875 `double-' events into similar click events, if that would make them
8876 bound. We try to turn `triple-' events first into `double-' events,
8877 then into clicks.
8879 If we get a mouse click in a mode line, vertical divider, or other
8880 non-text area, we treat the click as if it were prefixed by the
8881 symbol denoting that area - `mode-line', `vertical-line', or
8882 whatever.
8884 If the sequence starts with a mouse click, we read the key sequence
8885 with respect to the buffer clicked on, not the current buffer.
8887 If the user switches frames in the midst of a key sequence, we put
8888 off the switch-frame event until later; the next call to
8889 read_char will return it.
8891 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8892 from the selected window's buffer. */
8894 static int
8895 read_key_sequence (Lisp_Object *keybuf, size_t bufsize, Lisp_Object prompt,
8896 int dont_downcase_last, int can_return_switch_frame,
8897 int fix_current_buffer)
8899 Lisp_Object from_string;
8900 int count = SPECPDL_INDEX ();
8902 /* How many keys there are in the current key sequence. */
8903 int t;
8905 /* The length of the echo buffer when we started reading, and
8906 the length of this_command_keys when we started reading. */
8907 int echo_start IF_LINT (= 0);
8908 int keys_start;
8910 /* The number of keymaps we're scanning right now, and the number of
8911 keymaps we have allocated space for. */
8912 int nmaps;
8913 int nmaps_allocated = 0;
8915 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8916 the current keymaps. */
8917 Lisp_Object *defs = NULL;
8919 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8920 in the current keymaps, or nil where it is not a prefix. */
8921 Lisp_Object *submaps = NULL;
8923 /* The local map to start out with at start of key sequence. */
8924 Lisp_Object orig_local_map;
8926 /* The map from the `keymap' property to start out with at start of
8927 key sequence. */
8928 Lisp_Object orig_keymap;
8930 /* 1 if we have already considered switching to the local-map property
8931 of the place where a mouse click occurred. */
8932 int localized_local_map = 0;
8934 /* The index in submaps[] of the first keymap that has a binding for
8935 this key sequence. In other words, the lowest i such that
8936 submaps[i] is non-nil. */
8937 int first_binding;
8938 /* Index of the first key that has no binding.
8939 It is useless to try fkey.start larger than that. */
8940 int first_unbound;
8942 /* If t < mock_input, then KEYBUF[t] should be read as the next
8943 input key.
8945 We use this to recover after recognizing a function key. Once we
8946 realize that a suffix of the current key sequence is actually a
8947 function key's escape sequence, we replace the suffix with the
8948 function key's binding from Vfunction_key_map. Now keybuf
8949 contains a new and different key sequence, so the echo area,
8950 this_command_keys, and the submaps and defs arrays are wrong. In
8951 this situation, we set mock_input to t, set t to 0, and jump to
8952 restart_sequence; the loop will read keys from keybuf up until
8953 mock_input, thus rebuilding the state; and then it will resume
8954 reading characters from the keyboard. */
8955 int mock_input = 0;
8957 /* If the sequence is unbound in submaps[], then
8958 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8959 and fkey.map is its binding.
8961 These might be > t, indicating that all function key scanning
8962 should hold off until t reaches them. We do this when we've just
8963 recognized a function key, to avoid searching for the function
8964 key's again in Vfunction_key_map. */
8965 keyremap fkey;
8967 /* Likewise, for key_translation_map and input-decode-map. */
8968 keyremap keytran, indec;
8970 /* Non-zero if we are trying to map a key by changing an upper-case
8971 letter to lower case, or a shifted function key to an unshifted
8972 one. */
8973 int shift_translated = 0;
8975 /* If we receive a `switch-frame' or `select-window' event in the middle of
8976 a key sequence, we put it off for later.
8977 While we're reading, we keep the event here. */
8978 Lisp_Object delayed_switch_frame;
8980 /* See the comment below... */
8981 #if defined (GOBBLE_FIRST_EVENT)
8982 Lisp_Object first_event;
8983 #endif
8985 Lisp_Object original_uppercase IF_LINT (= Qnil);
8986 int original_uppercase_position = -1;
8988 /* Gets around Microsoft compiler limitations. */
8989 int dummyflag = 0;
8991 struct buffer *starting_buffer;
8993 /* List of events for which a fake prefix key has been generated. */
8994 Lisp_Object fake_prefixed_keys = Qnil;
8996 #if defined (GOBBLE_FIRST_EVENT)
8997 int junk;
8998 #endif
9000 struct gcpro outer_gcpro1;
9002 GCPRO1_VAR (fake_prefixed_keys, outer_gcpro);
9003 raw_keybuf_count = 0;
9005 last_nonmenu_event = Qnil;
9007 delayed_switch_frame = Qnil;
9009 if (INTERACTIVE)
9011 if (!NILP (prompt))
9013 /* Install the string STR as the beginning of the string of
9014 echoing, so that it serves as a prompt for the next
9015 character. */
9016 KVAR (current_kboard, echo_string) = prompt;
9017 current_kboard->echo_after_prompt = SCHARS (prompt);
9018 echo_now ();
9020 else if (cursor_in_echo_area
9021 && (FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
9022 && NILP (Fzerop (Vecho_keystrokes)))
9023 /* This doesn't put in a dash if the echo buffer is empty, so
9024 you don't always see a dash hanging out in the minibuffer. */
9025 echo_dash ();
9028 /* Record the initial state of the echo area and this_command_keys;
9029 we will need to restore them if we replay a key sequence. */
9030 if (INTERACTIVE)
9031 echo_start = echo_length ();
9032 keys_start = this_command_key_count;
9033 this_single_command_key_start = keys_start;
9035 #if defined (GOBBLE_FIRST_EVENT)
9036 /* This doesn't quite work, because some of the things that read_char
9037 does cannot safely be bypassed. It seems too risky to try to make
9038 this work right. */
9040 /* Read the first char of the sequence specially, before setting
9041 up any keymaps, in case a filter runs and switches buffers on us. */
9042 first_event = read_char (NILP (prompt), 0, submaps, last_nonmenu_event,
9043 &junk, NULL);
9044 #endif /* GOBBLE_FIRST_EVENT */
9046 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
9047 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
9048 from_string = Qnil;
9050 /* We jump here when we need to reinitialize fkey and keytran; this
9051 happens if we switch keyboards between rescans. */
9052 replay_entire_sequence:
9054 indec.map = indec.parent = KVAR (current_kboard, Vinput_decode_map);
9055 fkey.map = fkey.parent = KVAR (current_kboard, Vlocal_function_key_map);
9056 keytran.map = keytran.parent = Vkey_translation_map;
9057 indec.start = indec.end = 0;
9058 fkey.start = fkey.end = 0;
9059 keytran.start = keytran.end = 0;
9061 /* We jump here when the key sequence has been thoroughly changed, and
9062 we need to rescan it starting from the beginning. When we jump here,
9063 keybuf[0..mock_input] holds the sequence we should reread. */
9064 replay_sequence:
9066 starting_buffer = current_buffer;
9067 first_unbound = bufsize + 1;
9069 /* Build our list of keymaps.
9070 If we recognize a function key and replace its escape sequence in
9071 keybuf with its symbol, or if the sequence starts with a mouse
9072 click and we need to switch buffers, we jump back here to rebuild
9073 the initial keymaps from the current buffer. */
9074 nmaps = 0;
9076 if (!NILP (KVAR (current_kboard, Voverriding_terminal_local_map)))
9078 if (2 > nmaps_allocated)
9080 submaps = (Lisp_Object *) alloca (2 * sizeof (submaps[0]));
9081 defs = (Lisp_Object *) alloca (2 * sizeof (defs[0]));
9082 nmaps_allocated = 2;
9084 submaps[nmaps++] = KVAR (current_kboard, Voverriding_terminal_local_map);
9086 else if (!NILP (Voverriding_local_map))
9088 if (2 > nmaps_allocated)
9090 submaps = (Lisp_Object *) alloca (2 * sizeof (submaps[0]));
9091 defs = (Lisp_Object *) alloca (2 * sizeof (defs[0]));
9092 nmaps_allocated = 2;
9094 submaps[nmaps++] = Voverriding_local_map;
9096 else
9098 int nminor;
9099 int total;
9100 Lisp_Object *maps;
9102 nminor = current_minor_maps (0, &maps);
9103 total = nminor + (!NILP (orig_keymap) ? 3 : 2);
9105 if (total > nmaps_allocated)
9107 submaps = (Lisp_Object *) alloca (total * sizeof (submaps[0]));
9108 defs = (Lisp_Object *) alloca (total * sizeof (defs[0]));
9109 nmaps_allocated = total;
9112 if (!NILP (orig_keymap))
9113 submaps[nmaps++] = orig_keymap;
9115 memcpy (submaps + nmaps, maps, nminor * sizeof (submaps[0]));
9117 nmaps += nminor;
9119 submaps[nmaps++] = orig_local_map;
9121 submaps[nmaps++] = current_global_map;
9123 /* Find an accurate initial value for first_binding. */
9124 for (first_binding = 0; first_binding < nmaps; first_binding++)
9125 if (! NILP (submaps[first_binding]))
9126 break;
9128 /* Start from the beginning in keybuf. */
9129 t = 0;
9131 /* These are no-ops the first time through, but if we restart, they
9132 revert the echo area and this_command_keys to their original state. */
9133 this_command_key_count = keys_start;
9134 if (INTERACTIVE && t < mock_input)
9135 echo_truncate (echo_start);
9137 /* If the best binding for the current key sequence is a keymap, or
9138 we may be looking at a function key's escape sequence, keep on
9139 reading. */
9140 while (first_binding < nmaps
9141 /* Keep reading as long as there's a prefix binding. */
9142 ? !NILP (submaps[first_binding])
9143 /* Don't return in the middle of a possible function key sequence,
9144 if the only bindings we found were via case conversion.
9145 Thus, if ESC O a has a function-key-map translation
9146 and ESC o has a binding, don't return after ESC O,
9147 so that we can translate ESC O plus the next character. */
9148 : (/* indec.start < t || fkey.start < t || */ keytran.start < t))
9150 Lisp_Object key;
9151 int used_mouse_menu = 0;
9153 /* Where the last real key started. If we need to throw away a
9154 key that has expanded into more than one element of keybuf
9155 (say, a mouse click on the mode line which is being treated
9156 as [mode-line (mouse-...)], then we backtrack to this point
9157 of keybuf. */
9158 int last_real_key_start;
9160 /* These variables are analogous to echo_start and keys_start;
9161 while those allow us to restart the entire key sequence,
9162 echo_local_start and keys_local_start allow us to throw away
9163 just one key. */
9164 int echo_local_start IF_LINT (= 0);
9165 int keys_local_start, local_first_binding;
9167 eassert (indec.end == t || (indec.end > t && indec.end <= mock_input));
9168 eassert (indec.start <= indec.end);
9169 eassert (fkey.start <= fkey.end);
9170 eassert (keytran.start <= keytran.end);
9171 /* key-translation-map is applied *after* function-key-map
9172 which is itself applied *after* input-decode-map. */
9173 eassert (fkey.end <= indec.start);
9174 eassert (keytran.end <= fkey.start);
9176 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9177 first_unbound < keytran.start)
9178 { /* The prefix upto first_unbound has no binding and has
9179 no translation left to do either, so we know it's unbound.
9180 If we don't stop now, we risk staying here indefinitely
9181 (if the user keeps entering fkey or keytran prefixes
9182 like C-c ESC ESC ESC ESC ...) */
9183 int i;
9184 for (i = first_unbound + 1; i < t; i++)
9185 keybuf[i - first_unbound - 1] = keybuf[i];
9186 mock_input = t - first_unbound - 1;
9187 indec.end = indec.start -= first_unbound + 1;
9188 indec.map = indec.parent;
9189 fkey.end = fkey.start -= first_unbound + 1;
9190 fkey.map = fkey.parent;
9191 keytran.end = keytran.start -= first_unbound + 1;
9192 keytran.map = keytran.parent;
9193 goto replay_sequence;
9196 if (t >= bufsize)
9197 error ("Key sequence too long");
9199 if (INTERACTIVE)
9200 echo_local_start = echo_length ();
9201 keys_local_start = this_command_key_count;
9202 local_first_binding = first_binding;
9204 replay_key:
9205 /* These are no-ops, unless we throw away a keystroke below and
9206 jumped back up to replay_key; in that case, these restore the
9207 variables to their original state, allowing us to replay the
9208 loop. */
9209 if (INTERACTIVE && t < mock_input)
9210 echo_truncate (echo_local_start);
9211 this_command_key_count = keys_local_start;
9212 first_binding = local_first_binding;
9214 /* By default, assume each event is "real". */
9215 last_real_key_start = t;
9217 /* Does mock_input indicate that we are re-reading a key sequence? */
9218 if (t < mock_input)
9220 key = keybuf[t];
9221 add_command_key (key);
9222 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
9223 && NILP (Fzerop (Vecho_keystrokes)))
9224 echo_char (key);
9227 /* If not, we should actually read a character. */
9228 else
9231 KBOARD *interrupted_kboard = current_kboard;
9232 struct frame *interrupted_frame = SELECTED_FRAME ();
9233 key = read_char (NILP (prompt), nmaps,
9234 (Lisp_Object *) submaps, last_nonmenu_event,
9235 &used_mouse_menu, NULL);
9236 if ((INTEGERP (key) && XINT (key) == -2) /* wrong_kboard_jmpbuf */
9237 /* When switching to a new tty (with a new keyboard),
9238 read_char returns the new buffer, rather than -2
9239 (Bug#5095). This is because `terminal-init-xterm'
9240 calls read-char, which eats the wrong_kboard_jmpbuf
9241 return. Any better way to fix this? -- cyd */
9242 || (interrupted_kboard != current_kboard))
9244 int found = 0;
9245 struct kboard *k;
9247 for (k = all_kboards; k; k = k->next_kboard)
9248 if (k == interrupted_kboard)
9249 found = 1;
9251 if (!found)
9253 /* Don't touch interrupted_kboard when it's been
9254 deleted. */
9255 delayed_switch_frame = Qnil;
9256 goto replay_entire_sequence;
9259 if (!NILP (delayed_switch_frame))
9261 KVAR (interrupted_kboard, kbd_queue)
9262 = Fcons (delayed_switch_frame,
9263 KVAR (interrupted_kboard, kbd_queue));
9264 delayed_switch_frame = Qnil;
9267 while (t > 0)
9268 KVAR (interrupted_kboard, kbd_queue)
9269 = Fcons (keybuf[--t], KVAR (interrupted_kboard, kbd_queue));
9271 /* If the side queue is non-empty, ensure it begins with a
9272 switch-frame, so we'll replay it in the right context. */
9273 if (CONSP (KVAR (interrupted_kboard, kbd_queue))
9274 && (key = XCAR (KVAR (interrupted_kboard, kbd_queue)),
9275 !(EVENT_HAS_PARAMETERS (key)
9276 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key)),
9277 Qswitch_frame))))
9279 Lisp_Object frame;
9280 XSETFRAME (frame, interrupted_frame);
9281 KVAR (interrupted_kboard, kbd_queue)
9282 = Fcons (make_lispy_switch_frame (frame),
9283 KVAR (interrupted_kboard, kbd_queue));
9285 mock_input = 0;
9286 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
9287 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
9288 goto replay_entire_sequence;
9292 /* read_char returns t when it shows a menu and the user rejects it.
9293 Just return -1. */
9294 if (EQ (key, Qt))
9296 unbind_to (count, Qnil);
9297 UNGCPRO_VAR (outer_gcpro);
9298 return -1;
9301 /* read_char returns -1 at the end of a macro.
9302 Emacs 18 handles this by returning immediately with a
9303 zero, so that's what we'll do. */
9304 if (INTEGERP (key) && XINT (key) == -1)
9306 t = 0;
9307 /* The Microsoft C compiler can't handle the goto that
9308 would go here. */
9309 dummyflag = 1;
9310 break;
9313 /* If the current buffer has been changed from under us, the
9314 keymap may have changed, so replay the sequence. */
9315 if (BUFFERP (key))
9317 timer_resume_idle ();
9319 mock_input = t;
9320 /* Reset the current buffer from the selected window
9321 in case something changed the former and not the latter.
9322 This is to be more consistent with the behavior
9323 of the command_loop_1. */
9324 if (fix_current_buffer)
9326 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
9327 Fkill_emacs (Qnil);
9328 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
9329 Fset_buffer (XWINDOW (selected_window)->buffer);
9332 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
9333 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
9334 goto replay_sequence;
9337 /* If we have a quit that was typed in another frame, and
9338 quit_throw_to_read_char switched buffers,
9339 replay to get the right keymap. */
9340 if (INTEGERP (key)
9341 && XINT (key) == quit_char
9342 && current_buffer != starting_buffer)
9344 GROW_RAW_KEYBUF;
9345 XVECTOR (raw_keybuf)->contents[raw_keybuf_count++] = key;
9346 keybuf[t++] = key;
9347 mock_input = t;
9348 Vquit_flag = Qnil;
9349 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
9350 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
9351 goto replay_sequence;
9354 Vquit_flag = Qnil;
9356 if (EVENT_HAS_PARAMETERS (key)
9357 /* Either a `switch-frame' or a `select-window' event. */
9358 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key)), Qswitch_frame))
9360 /* If we're at the beginning of a key sequence, and the caller
9361 says it's okay, go ahead and return this event. If we're
9362 in the midst of a key sequence, delay it until the end. */
9363 if (t > 0 || !can_return_switch_frame)
9365 delayed_switch_frame = key;
9366 goto replay_key;
9370 GROW_RAW_KEYBUF;
9371 ASET (raw_keybuf, raw_keybuf_count, key);
9372 raw_keybuf_count++;
9375 /* Clicks in non-text areas get prefixed by the symbol
9376 in their CHAR-ADDRESS field. For example, a click on
9377 the mode line is prefixed by the symbol `mode-line'.
9379 Furthermore, key sequences beginning with mouse clicks
9380 are read using the keymaps of the buffer clicked on, not
9381 the current buffer. So we may have to switch the buffer
9382 here.
9384 When we turn one event into two events, we must make sure
9385 that neither of the two looks like the original--so that,
9386 if we replay the events, they won't be expanded again.
9387 If not for this, such reexpansion could happen either here
9388 or when user programs play with this-command-keys. */
9389 if (EVENT_HAS_PARAMETERS (key))
9391 Lisp_Object kind;
9392 Lisp_Object string;
9394 kind = EVENT_HEAD_KIND (EVENT_HEAD (key));
9395 if (EQ (kind, Qmouse_click))
9397 Lisp_Object window, posn;
9399 window = POSN_WINDOW (EVENT_START (key));
9400 posn = POSN_POSN (EVENT_START (key));
9402 if (CONSP (posn)
9403 || (!NILP (fake_prefixed_keys)
9404 && !NILP (Fmemq (key, fake_prefixed_keys))))
9406 /* We're looking a second time at an event for which
9407 we generated a fake prefix key. Set
9408 last_real_key_start appropriately. */
9409 if (t > 0)
9410 last_real_key_start = t - 1;
9413 if (last_real_key_start == 0)
9415 /* Key sequences beginning with mouse clicks are
9416 read using the keymaps in the buffer clicked on,
9417 not the current buffer. If we're at the
9418 beginning of a key sequence, switch buffers. */
9419 if (WINDOWP (window)
9420 && BUFFERP (XWINDOW (window)->buffer)
9421 && XBUFFER (XWINDOW (window)->buffer) != current_buffer)
9423 XVECTOR (raw_keybuf)->contents[raw_keybuf_count++] = key;
9424 keybuf[t] = key;
9425 mock_input = t + 1;
9427 /* Arrange to go back to the original buffer once we're
9428 done reading the key sequence. Note that we can't
9429 use save_excursion_{save,restore} here, because they
9430 save point as well as the current buffer; we don't
9431 want to save point, because redisplay may change it,
9432 to accommodate a Fset_window_start or something. We
9433 don't want to do this at the top of the function,
9434 because we may get input from a subprocess which
9435 wants to change the selected window and stuff (say,
9436 emacsclient). */
9437 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
9439 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
9440 Fkill_emacs (Qnil);
9441 set_buffer_internal (XBUFFER (XWINDOW (window)->buffer));
9442 orig_local_map = get_local_map (PT, current_buffer,
9443 Qlocal_map);
9444 orig_keymap = get_local_map (PT, current_buffer,
9445 Qkeymap);
9446 goto replay_sequence;
9449 /* For a mouse click, get the local text-property keymap
9450 of the place clicked on, rather than point. */
9451 if (CONSP (XCDR (key))
9452 && ! localized_local_map)
9454 Lisp_Object map_here, start, pos;
9456 localized_local_map = 1;
9457 start = EVENT_START (key);
9459 if (CONSP (start) && POSN_INBUFFER_P (start))
9461 pos = POSN_BUFFER_POSN (start);
9462 if (INTEGERP (pos)
9463 && XINT (pos) >= BEGV
9464 && XINT (pos) <= ZV)
9466 map_here = get_local_map (XINT (pos),
9467 current_buffer,
9468 Qlocal_map);
9469 if (!EQ (map_here, orig_local_map))
9471 orig_local_map = map_here;
9472 ++localized_local_map;
9475 map_here = get_local_map (XINT (pos),
9476 current_buffer,
9477 Qkeymap);
9478 if (!EQ (map_here, orig_keymap))
9480 orig_keymap = map_here;
9481 ++localized_local_map;
9484 if (localized_local_map > 1)
9486 keybuf[t] = key;
9487 mock_input = t + 1;
9489 goto replay_sequence;
9496 /* Expand mode-line and scroll-bar events into two events:
9497 use posn as a fake prefix key. */
9498 if (SYMBOLP (posn)
9499 && (NILP (fake_prefixed_keys)
9500 || NILP (Fmemq (key, fake_prefixed_keys))))
9502 if (t + 1 >= bufsize)
9503 error ("Key sequence too long");
9505 keybuf[t] = posn;
9506 keybuf[t + 1] = key;
9507 mock_input = t + 2;
9509 /* Record that a fake prefix key has been generated
9510 for KEY. Don't modify the event; this would
9511 prevent proper action when the event is pushed
9512 back into unread-command-events. */
9513 fake_prefixed_keys = Fcons (key, fake_prefixed_keys);
9515 /* If on a mode line string with a local keymap,
9516 reconsider the key sequence with that keymap. */
9517 if (string = POSN_STRING (EVENT_START (key)),
9518 (CONSP (string) && STRINGP (XCAR (string))))
9520 Lisp_Object pos, map, map2;
9522 pos = XCDR (string);
9523 string = XCAR (string);
9524 if (XINT (pos) >= 0
9525 && XINT (pos) < SCHARS (string))
9527 map = Fget_text_property (pos, Qlocal_map, string);
9528 if (!NILP (map))
9529 orig_local_map = map;
9530 map2 = Fget_text_property (pos, Qkeymap, string);
9531 if (!NILP (map2))
9532 orig_keymap = map2;
9533 if (!NILP (map) || !NILP (map2))
9534 goto replay_sequence;
9538 goto replay_key;
9540 else if (NILP (from_string)
9541 && (string = POSN_STRING (EVENT_START (key)),
9542 (CONSP (string) && STRINGP (XCAR (string)))))
9544 /* For a click on a string, i.e. overlay string or a
9545 string displayed via the `display' property,
9546 consider `local-map' and `keymap' properties of
9547 that string. */
9548 Lisp_Object pos, map, map2;
9550 pos = XCDR (string);
9551 string = XCAR (string);
9552 if (XINT (pos) >= 0
9553 && XINT (pos) < SCHARS (string))
9555 map = Fget_text_property (pos, Qlocal_map, string);
9556 if (!NILP (map))
9557 orig_local_map = map;
9558 map2 = Fget_text_property (pos, Qkeymap, string);
9559 if (!NILP (map2))
9560 orig_keymap = map2;
9562 if (!NILP (map) || !NILP (map2))
9564 from_string = string;
9565 keybuf[t++] = key;
9566 mock_input = t;
9567 goto replay_sequence;
9572 else if (CONSP (XCDR (key))
9573 && CONSP (EVENT_START (key))
9574 && CONSP (XCDR (EVENT_START (key))))
9576 Lisp_Object posn;
9578 posn = POSN_POSN (EVENT_START (key));
9579 /* Handle menu-bar events:
9580 insert the dummy prefix event `menu-bar'. */
9581 if (EQ (posn, Qmenu_bar) || EQ (posn, Qtool_bar))
9583 if (t + 1 >= bufsize)
9584 error ("Key sequence too long");
9585 keybuf[t] = posn;
9586 keybuf[t+1] = key;
9588 /* Zap the position in key, so we know that we've
9589 expanded it, and don't try to do so again. */
9590 POSN_SET_POSN (EVENT_START (key),
9591 Fcons (posn, Qnil));
9593 mock_input = t + 2;
9594 goto replay_sequence;
9596 else if (CONSP (posn))
9598 /* We're looking at the second event of a
9599 sequence which we expanded before. Set
9600 last_real_key_start appropriately. */
9601 if (last_real_key_start == t && t > 0)
9602 last_real_key_start = t - 1;
9607 /* We have finally decided that KEY is something we might want
9608 to look up. */
9609 first_binding = (follow_key (key,
9610 nmaps - first_binding,
9611 submaps + first_binding,
9612 defs + first_binding,
9613 submaps + first_binding)
9614 + first_binding);
9616 /* If KEY wasn't bound, we'll try some fallbacks. */
9617 if (first_binding < nmaps)
9618 /* This is needed for the following scenario:
9619 event 0: a down-event that gets dropped by calling replay_key.
9620 event 1: some normal prefix like C-h.
9621 After event 0, first_unbound is 0, after event 1 indec.start,
9622 fkey.start, and keytran.start are all 1, so when we see that
9623 C-h is bound, we need to update first_unbound. */
9624 first_unbound = max (t + 1, first_unbound);
9625 else
9627 Lisp_Object head;
9629 /* Remember the position to put an upper bound on indec.start. */
9630 first_unbound = min (t, first_unbound);
9632 head = EVENT_HEAD (key);
9633 if (help_char_p (head) && t > 0)
9635 read_key_sequence_cmd = Vprefix_help_command;
9636 keybuf[t++] = key;
9637 last_nonmenu_event = key;
9638 /* The Microsoft C compiler can't handle the goto that
9639 would go here. */
9640 dummyflag = 1;
9641 break;
9644 if (SYMBOLP (head))
9646 Lisp_Object breakdown;
9647 int modifiers;
9649 breakdown = parse_modifiers (head);
9650 modifiers = XINT (XCAR (XCDR (breakdown)));
9651 /* Attempt to reduce an unbound mouse event to a simpler
9652 event that is bound:
9653 Drags reduce to clicks.
9654 Double-clicks reduce to clicks.
9655 Triple-clicks reduce to double-clicks, then to clicks.
9656 Down-clicks are eliminated.
9657 Double-downs reduce to downs, then are eliminated.
9658 Triple-downs reduce to double-downs, then to downs,
9659 then are eliminated. */
9660 if (modifiers & (down_modifier | drag_modifier
9661 | double_modifier | triple_modifier))
9663 while (modifiers & (down_modifier | drag_modifier
9664 | double_modifier | triple_modifier))
9666 Lisp_Object new_head, new_click;
9667 if (modifiers & triple_modifier)
9668 modifiers ^= (double_modifier | triple_modifier);
9669 else if (modifiers & double_modifier)
9670 modifiers &= ~double_modifier;
9671 else if (modifiers & drag_modifier)
9672 modifiers &= ~drag_modifier;
9673 else
9675 /* Dispose of this `down' event by simply jumping
9676 back to replay_key, to get another event.
9678 Note that if this event came from mock input,
9679 then just jumping back to replay_key will just
9680 hand it to us again. So we have to wipe out any
9681 mock input.
9683 We could delete keybuf[t] and shift everything
9684 after that to the left by one spot, but we'd also
9685 have to fix up any variable that points into
9686 keybuf, and shifting isn't really necessary
9687 anyway.
9689 Adding prefixes for non-textual mouse clicks
9690 creates two characters of mock input, and both
9691 must be thrown away. If we're only looking at
9692 the prefix now, we can just jump back to
9693 replay_key. On the other hand, if we've already
9694 processed the prefix, and now the actual click
9695 itself is giving us trouble, then we've lost the
9696 state of the keymaps we want to backtrack to, and
9697 we need to replay the whole sequence to rebuild
9700 Beyond that, only function key expansion could
9701 create more than two keys, but that should never
9702 generate mouse events, so it's okay to zero
9703 mock_input in that case too.
9705 FIXME: The above paragraph seems just plain
9706 wrong, if you consider things like
9707 xterm-mouse-mode. -stef
9709 Isn't this just the most wonderful code ever? */
9711 /* If mock_input > t + 1, the above simplification
9712 will actually end up dropping keys on the floor.
9713 This is probably OK for now, but even
9714 if mock_input <= t + 1, we need to adjust indec,
9715 fkey, and keytran.
9716 Typical case [header-line down-mouse-N]:
9717 mock_input = 2, t = 1, fkey.end = 1,
9718 last_real_key_start = 0. */
9719 if (indec.end > last_real_key_start)
9721 indec.end = indec.start
9722 = min (last_real_key_start, indec.start);
9723 indec.map = indec.parent;
9724 if (fkey.end > last_real_key_start)
9726 fkey.end = fkey.start
9727 = min (last_real_key_start, fkey.start);
9728 fkey.map = fkey.parent;
9729 if (keytran.end > last_real_key_start)
9731 keytran.end = keytran.start
9732 = min (last_real_key_start, keytran.start);
9733 keytran.map = keytran.parent;
9737 if (t == last_real_key_start)
9739 mock_input = 0;
9740 goto replay_key;
9742 else
9744 mock_input = last_real_key_start;
9745 goto replay_sequence;
9749 new_head
9750 = apply_modifiers (modifiers, XCAR (breakdown));
9751 new_click
9752 = Fcons (new_head, Fcons (EVENT_START (key), Qnil));
9754 /* Look for a binding for this new key. follow_key
9755 promises that it didn't munge submaps the
9756 last time we called it, since key was unbound. */
9757 first_binding
9758 = (follow_key (new_click,
9759 nmaps - local_first_binding,
9760 submaps + local_first_binding,
9761 defs + local_first_binding,
9762 submaps + local_first_binding)
9763 + local_first_binding);
9765 /* If that click is bound, go for it. */
9766 if (first_binding < nmaps)
9768 key = new_click;
9769 break;
9771 /* Otherwise, we'll leave key set to the drag event. */
9777 keybuf[t++] = key;
9778 /* Normally, last_nonmenu_event gets the previous key we read.
9779 But when a mouse popup menu is being used,
9780 we don't update last_nonmenu_event; it continues to hold the mouse
9781 event that preceded the first level of menu. */
9782 if (!used_mouse_menu)
9783 last_nonmenu_event = key;
9785 /* Record what part of this_command_keys is the current key sequence. */
9786 this_single_command_key_start = this_command_key_count - t;
9788 /* Look for this sequence in input-decode-map.
9789 Scan from indec.end until we find a bound suffix. */
9790 while (indec.end < t)
9792 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
9793 int done, diff;
9795 GCPRO4 (indec.map, fkey.map, keytran.map, delayed_switch_frame);
9796 done = keyremap_step (keybuf, bufsize, &indec, max (t, mock_input),
9797 1, &diff, prompt);
9798 UNGCPRO;
9799 if (done)
9801 mock_input = diff + max (t, mock_input);
9802 goto replay_sequence;
9806 if (first_binding < nmaps && NILP (submaps[first_binding])
9807 && indec.start >= t)
9808 /* There is a binding and it's not a prefix.
9809 (and it doesn't have any input-decode-map translation pending).
9810 There is thus no function-key in this sequence.
9811 Moving fkey.start is important in this case to allow keytran.start
9812 to go over the sequence before we return (since we keep the
9813 invariant that keytran.end <= fkey.start). */
9815 if (fkey.start < t)
9816 (fkey.start = fkey.end = t, fkey.map = fkey.parent);
9818 else
9819 /* If the sequence is unbound, see if we can hang a function key
9820 off the end of it. */
9821 /* Continue scan from fkey.end until we find a bound suffix. */
9822 while (fkey.end < indec.start)
9824 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
9825 int done, diff;
9827 GCPRO4 (indec.map, fkey.map, keytran.map, delayed_switch_frame);
9828 done = keyremap_step (keybuf, bufsize, &fkey,
9829 max (t, mock_input),
9830 /* If there's a binding (i.e.
9831 first_binding >= nmaps) we don't want
9832 to apply this function-key-mapping. */
9833 fkey.end + 1 == t && first_binding >= nmaps,
9834 &diff, prompt);
9835 UNGCPRO;
9836 if (done)
9838 mock_input = diff + max (t, mock_input);
9839 /* Adjust the input-decode-map counters. */
9840 indec.end += diff;
9841 indec.start += diff;
9843 goto replay_sequence;
9847 /* Look for this sequence in key-translation-map.
9848 Scan from keytran.end until we find a bound suffix. */
9849 while (keytran.end < fkey.start)
9851 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
9852 int done, diff;
9854 GCPRO4 (indec.map, fkey.map, keytran.map, delayed_switch_frame);
9855 done = keyremap_step (keybuf, bufsize, &keytran, max (t, mock_input),
9856 1, &diff, prompt);
9857 UNGCPRO;
9858 if (done)
9860 mock_input = diff + max (t, mock_input);
9861 /* Adjust the function-key-map and input-decode-map counters. */
9862 indec.end += diff;
9863 indec.start += diff;
9864 fkey.end += diff;
9865 fkey.start += diff;
9867 goto replay_sequence;
9871 /* If KEY is not defined in any of the keymaps,
9872 and cannot be part of a function key or translation,
9873 and is an upper case letter
9874 use the corresponding lower-case letter instead. */
9875 if (first_binding >= nmaps
9876 && /* indec.start >= t && fkey.start >= t && */ keytran.start >= t
9877 && INTEGERP (key)
9878 && ((CHARACTERP (make_number (XINT (key) & ~CHAR_MODIFIER_MASK))
9879 && uppercasep (XINT (key) & ~CHAR_MODIFIER_MASK))
9880 || (XINT (key) & shift_modifier)))
9882 Lisp_Object new_key;
9884 original_uppercase = key;
9885 original_uppercase_position = t - 1;
9887 if (XINT (key) & shift_modifier)
9888 XSETINT (new_key, XINT (key) & ~shift_modifier);
9889 else
9890 XSETINT (new_key, (downcase (XINT (key) & ~CHAR_MODIFIER_MASK)
9891 | (XINT (key) & CHAR_MODIFIER_MASK)));
9893 /* We have to do this unconditionally, regardless of whether
9894 the lower-case char is defined in the keymaps, because they
9895 might get translated through function-key-map. */
9896 keybuf[t - 1] = new_key;
9897 mock_input = max (t, mock_input);
9898 shift_translated = 1;
9900 goto replay_sequence;
9902 /* If KEY is not defined in any of the keymaps,
9903 and cannot be part of a function key or translation,
9904 and is a shifted function key,
9905 use the corresponding unshifted function key instead. */
9906 if (first_binding >= nmaps
9907 && /* indec.start >= t && fkey.start >= t && */ keytran.start >= t)
9909 Lisp_Object breakdown = parse_modifiers (key);
9910 int modifiers
9911 = CONSP (breakdown) ? (XINT (XCAR (XCDR (breakdown)))) : 0;
9913 if (modifiers & shift_modifier
9914 /* Treat uppercase keys as shifted. */
9915 || (INTEGERP (key)
9916 && (KEY_TO_CHAR (key)
9917 < XCHAR_TABLE (BVAR (current_buffer, downcase_table))->size)
9918 && uppercasep (KEY_TO_CHAR (key))))
9920 Lisp_Object new_key
9921 = (modifiers & shift_modifier
9922 ? apply_modifiers (modifiers & ~shift_modifier,
9923 XCAR (breakdown))
9924 : make_number (downcase (KEY_TO_CHAR (key)) | modifiers));
9926 original_uppercase = key;
9927 original_uppercase_position = t - 1;
9929 /* We have to do this unconditionally, regardless of whether
9930 the lower-case char is defined in the keymaps, because they
9931 might get translated through function-key-map. */
9932 keybuf[t - 1] = new_key;
9933 mock_input = max (t, mock_input);
9934 /* Reset fkey (and consequently keytran) to apply
9935 function-key-map on the result, so that S-backspace is
9936 correctly mapped to DEL (via backspace). OTOH,
9937 input-decode-map doesn't need to go through it again. */
9938 fkey.start = fkey.end = 0;
9939 keytran.start = keytran.end = 0;
9940 shift_translated = 1;
9942 goto replay_sequence;
9946 if (!dummyflag)
9947 read_key_sequence_cmd = (first_binding < nmaps
9948 ? defs[first_binding]
9949 : Qnil);
9951 unread_switch_frame = delayed_switch_frame;
9952 unbind_to (count, Qnil);
9954 /* Don't downcase the last character if the caller says don't.
9955 Don't downcase it if the result is undefined, either. */
9956 if ((dont_downcase_last || first_binding >= nmaps)
9957 && t > 0
9958 && t - 1 == original_uppercase_position)
9960 keybuf[t - 1] = original_uppercase;
9961 shift_translated = 0;
9964 if (shift_translated)
9965 Vthis_command_keys_shift_translated = Qt;
9967 /* Occasionally we fabricate events, perhaps by expanding something
9968 according to function-key-map, or by adding a prefix symbol to a
9969 mouse click in the scroll bar or modeline. In this cases, return
9970 the entire generated key sequence, even if we hit an unbound
9971 prefix or a definition before the end. This means that you will
9972 be able to push back the event properly, and also means that
9973 read-key-sequence will always return a logical unit.
9975 Better ideas? */
9976 for (; t < mock_input; t++)
9978 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
9979 && NILP (Fzerop (Vecho_keystrokes)))
9980 echo_char (keybuf[t]);
9981 add_command_key (keybuf[t]);
9984 UNGCPRO_VAR (outer_gcpro);
9985 return t;
9988 DEFUN ("read-key-sequence", Fread_key_sequence, Sread_key_sequence, 1, 5, 0,
9989 doc: /* Read a sequence of keystrokes and return as a string or vector.
9990 The sequence is sufficient to specify a non-prefix command in the
9991 current local and global maps.
9993 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9994 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9995 as a continuation of the previous key.
9997 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9998 convert the last event to lower case. (Normally any upper case event
9999 is converted to lower case if the original event is undefined and the lower
10000 case equivalent is defined.) A non-nil value is appropriate for reading
10001 a key sequence to be defined.
10003 A C-g typed while in this function is treated like any other character,
10004 and `quit-flag' is not set.
10006 If the key sequence starts with a mouse click, then the sequence is read
10007 using the keymaps of the buffer of the window clicked in, not the buffer
10008 of the selected window as normal.
10010 `read-key-sequence' drops unbound button-down events, since you normally
10011 only care about the click or drag events which follow them. If a drag
10012 or multi-click event is unbound, but the corresponding click event would
10013 be bound, `read-key-sequence' turns the event into a click event at the
10014 drag's starting position. This means that you don't have to distinguish
10015 between click and drag, double, or triple events unless you want to.
10017 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10018 lines separating windows, and scroll bars with imaginary keys
10019 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10021 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10022 function will process a switch-frame event if the user switches frames
10023 before typing anything. If the user switches frames in the middle of a
10024 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10025 is nil, then the event will be put off until after the current key sequence.
10027 `read-key-sequence' checks `function-key-map' for function key
10028 sequences, where they wouldn't conflict with ordinary bindings. See
10029 `function-key-map' for more details.
10031 The optional fifth argument CMD-LOOP, if non-nil, means
10032 that this key sequence is being read by something that will
10033 read commands one after another. It should be nil if the caller
10034 will read just one key sequence. */)
10035 (Lisp_Object prompt, Lisp_Object continue_echo, Lisp_Object dont_downcase_last, Lisp_Object can_return_switch_frame, Lisp_Object cmd_loop)
10037 Lisp_Object keybuf[30];
10038 register int i;
10039 struct gcpro gcpro1;
10040 int count = SPECPDL_INDEX ();
10042 if (!NILP (prompt))
10043 CHECK_STRING (prompt);
10044 QUIT;
10046 specbind (Qinput_method_exit_on_first_char,
10047 (NILP (cmd_loop) ? Qt : Qnil));
10048 specbind (Qinput_method_use_echo_area,
10049 (NILP (cmd_loop) ? Qt : Qnil));
10051 memset (keybuf, 0, sizeof keybuf);
10052 GCPRO1 (keybuf[0]);
10053 gcpro1.nvars = (sizeof keybuf/sizeof (keybuf[0]));
10055 if (NILP (continue_echo))
10057 this_command_key_count = 0;
10058 this_command_key_count_reset = 0;
10059 this_single_command_key_start = 0;
10062 #ifdef HAVE_WINDOW_SYSTEM
10063 if (display_hourglass_p)
10064 cancel_hourglass ();
10065 #endif
10067 i = read_key_sequence (keybuf, (sizeof keybuf/sizeof (keybuf[0])),
10068 prompt, ! NILP (dont_downcase_last),
10069 ! NILP (can_return_switch_frame), 0);
10071 #if 0 /* The following is fine for code reading a key sequence and
10072 then proceeding with a lenghty computation, but it's not good
10073 for code reading keys in a loop, like an input method. */
10074 #ifdef HAVE_WINDOW_SYSTEM
10075 if (display_hourglass_p)
10076 start_hourglass ();
10077 #endif
10078 #endif
10080 if (i == -1)
10082 Vquit_flag = Qt;
10083 QUIT;
10085 UNGCPRO;
10086 return unbind_to (count, make_event_array (i, keybuf));
10089 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector,
10090 Sread_key_sequence_vector, 1, 5, 0,
10091 doc: /* Like `read-key-sequence' but always return a vector. */)
10092 (Lisp_Object prompt, Lisp_Object continue_echo, Lisp_Object dont_downcase_last, Lisp_Object can_return_switch_frame, Lisp_Object cmd_loop)
10094 Lisp_Object keybuf[30];
10095 register int i;
10096 struct gcpro gcpro1;
10097 int count = SPECPDL_INDEX ();
10099 if (!NILP (prompt))
10100 CHECK_STRING (prompt);
10101 QUIT;
10103 specbind (Qinput_method_exit_on_first_char,
10104 (NILP (cmd_loop) ? Qt : Qnil));
10105 specbind (Qinput_method_use_echo_area,
10106 (NILP (cmd_loop) ? Qt : Qnil));
10108 memset (keybuf, 0, sizeof keybuf);
10109 GCPRO1 (keybuf[0]);
10110 gcpro1.nvars = (sizeof keybuf/sizeof (keybuf[0]));
10112 if (NILP (continue_echo))
10114 this_command_key_count = 0;
10115 this_command_key_count_reset = 0;
10116 this_single_command_key_start = 0;
10119 #ifdef HAVE_WINDOW_SYSTEM
10120 if (display_hourglass_p)
10121 cancel_hourglass ();
10122 #endif
10124 i = read_key_sequence (keybuf, (sizeof keybuf/sizeof (keybuf[0])),
10125 prompt, ! NILP (dont_downcase_last),
10126 ! NILP (can_return_switch_frame), 0);
10128 #ifdef HAVE_WINDOW_SYSTEM
10129 if (display_hourglass_p)
10130 start_hourglass ();
10131 #endif
10133 if (i == -1)
10135 Vquit_flag = Qt;
10136 QUIT;
10138 UNGCPRO;
10139 return unbind_to (count, Fvector (i, keybuf));
10142 DEFUN ("command-execute", Fcommand_execute, Scommand_execute, 1, 4, 0,
10143 doc: /* Execute CMD as an editor command.
10144 CMD must be a symbol that satisfies the `commandp' predicate.
10145 Optional second arg RECORD-FLAG non-nil
10146 means unconditionally put this command in `command-history'.
10147 Otherwise, that is done only if an arg is read using the minibuffer.
10148 The argument KEYS specifies the value to use instead of (this-command-keys)
10149 when reading the arguments; if it is nil, (this-command-keys) is used.
10150 The argument SPECIAL, if non-nil, means that this command is executing
10151 a special event, so ignore the prefix argument and don't clear it. */)
10152 (Lisp_Object cmd, Lisp_Object record_flag, Lisp_Object keys, Lisp_Object special)
10154 register Lisp_Object final;
10155 register Lisp_Object tem;
10156 Lisp_Object prefixarg;
10158 debug_on_next_call = 0;
10160 if (NILP (special))
10162 prefixarg = KVAR (current_kboard, Vprefix_arg);
10163 Vcurrent_prefix_arg = prefixarg;
10164 KVAR (current_kboard, Vprefix_arg) = Qnil;
10166 else
10167 prefixarg = Qnil;
10169 if (SYMBOLP (cmd))
10171 tem = Fget (cmd, Qdisabled);
10172 if (!NILP (tem))
10174 tem = Fsymbol_value (Qdisabled_command_function);
10175 if (!NILP (tem))
10176 return Frun_hooks (1, &Qdisabled_command_function);
10180 while (1)
10182 final = Findirect_function (cmd, Qnil);
10184 if (CONSP (final) && (tem = Fcar (final), EQ (tem, Qautoload)))
10186 struct gcpro gcpro1, gcpro2;
10188 GCPRO2 (cmd, prefixarg);
10189 do_autoload (final, cmd);
10190 UNGCPRO;
10192 else
10193 break;
10196 if (STRINGP (final) || VECTORP (final))
10198 /* If requested, place the macro in the command history. For
10199 other sorts of commands, call-interactively takes care of
10200 this. */
10201 if (!NILP (record_flag))
10203 Vcommand_history
10204 = Fcons (Fcons (Qexecute_kbd_macro,
10205 Fcons (final, Fcons (prefixarg, Qnil))),
10206 Vcommand_history);
10208 /* Don't keep command history around forever. */
10209 if (NUMBERP (Vhistory_length) && XINT (Vhistory_length) > 0)
10211 tem = Fnthcdr (Vhistory_length, Vcommand_history);
10212 if (CONSP (tem))
10213 XSETCDR (tem, Qnil);
10217 return Fexecute_kbd_macro (final, prefixarg, Qnil);
10220 if (CONSP (final) || SUBRP (final) || COMPILEDP (final))
10221 /* Don't call Fcall_interactively directly because we want to make
10222 sure the backtrace has an entry for `call-interactively'.
10223 For the same reason, pass `cmd' rather than `final'. */
10224 return call3 (Qcall_interactively, cmd, record_flag, keys);
10226 return Qnil;
10231 DEFUN ("execute-extended-command", Fexecute_extended_command, Sexecute_extended_command,
10232 1, 1, "P",
10233 doc: /* Read function name, then read its arguments and call it.
10235 To pass a numeric argument to the command you are invoking with, specify
10236 the numeric argument to this command.
10238 Noninteractively, the argument PREFIXARG is the prefix argument to
10239 give to the command you invoke, if it asks for an argument. */)
10240 (Lisp_Object prefixarg)
10242 Lisp_Object function;
10243 EMACS_INT saved_last_point_position;
10244 Lisp_Object saved_keys, saved_last_point_position_buffer;
10245 Lisp_Object bindings, value;
10246 struct gcpro gcpro1, gcpro2, gcpro3;
10247 #ifdef HAVE_WINDOW_SYSTEM
10248 /* The call to Fcompleting_read will start and cancel the hourglass,
10249 but if the hourglass was already scheduled, this means that no
10250 hourglass will be shown for the actual M-x command itself.
10251 So we restart it if it is already scheduled. Note that checking
10252 hourglass_shown_p is not enough, normally the hourglass is not shown,
10253 just scheduled to be shown. */
10254 int hstarted = hourglass_started ();
10255 #endif
10257 saved_keys = Fvector (this_command_key_count,
10258 XVECTOR (this_command_keys)->contents);
10259 saved_last_point_position_buffer = last_point_position_buffer;
10260 saved_last_point_position = last_point_position;
10261 GCPRO3 (saved_keys, prefixarg, saved_last_point_position_buffer);
10263 function = call0 (intern ("read-extended-command"));
10265 #ifdef HAVE_WINDOW_SYSTEM
10266 if (hstarted) start_hourglass ();
10267 #endif
10269 if (STRINGP (function) && SCHARS (function) == 0)
10270 error ("No command name given");
10272 /* Set this_command_keys to the concatenation of saved_keys and
10273 function, followed by a RET. */
10275 Lisp_Object *keys;
10276 int i;
10278 this_command_key_count = 0;
10279 this_command_key_count_reset = 0;
10280 this_single_command_key_start = 0;
10282 keys = XVECTOR (saved_keys)->contents;
10283 for (i = 0; i < XVECTOR (saved_keys)->size; i++)
10284 add_command_key (keys[i]);
10286 for (i = 0; i < SCHARS (function); i++)
10287 add_command_key (Faref (function, make_number (i)));
10289 add_command_key (make_number ('\015'));
10292 last_point_position = saved_last_point_position;
10293 last_point_position_buffer = saved_last_point_position_buffer;
10295 UNGCPRO;
10297 function = Fintern (function, Qnil);
10298 KVAR (current_kboard, Vprefix_arg) = prefixarg;
10299 Vthis_command = function;
10300 real_this_command = function;
10302 /* If enabled, show which key runs this command. */
10303 if (!NILP (Vsuggest_key_bindings)
10304 && NILP (Vexecuting_kbd_macro)
10305 && SYMBOLP (function))
10306 bindings = Fwhere_is_internal (function, Voverriding_local_map,
10307 Qt, Qnil, Qnil);
10308 else
10309 bindings = Qnil;
10311 value = Qnil;
10312 GCPRO3 (bindings, value, function);
10313 value = Fcommand_execute (function, Qt, Qnil, Qnil);
10315 /* If the command has a key binding, print it now. */
10316 if (!NILP (bindings)
10317 && ! (VECTORP (bindings) && EQ (Faref (bindings, make_number (0)),
10318 Qmouse_movement)))
10320 /* But first wait, and skip the message if there is input. */
10321 Lisp_Object waited;
10323 /* If this command displayed something in the echo area;
10324 wait a few seconds, then display our suggestion message. */
10325 if (NILP (echo_area_buffer[0]))
10326 waited = sit_for (make_number (0), 0, 2);
10327 else if (NUMBERP (Vsuggest_key_bindings))
10328 waited = sit_for (Vsuggest_key_bindings, 0, 2);
10329 else
10330 waited = sit_for (make_number (2), 0, 2);
10332 if (!NILP (waited) && ! CONSP (Vunread_command_events))
10334 Lisp_Object binding;
10335 char *newmessage;
10336 int message_p = push_message ();
10337 int count = SPECPDL_INDEX ();
10339 record_unwind_protect (pop_message_unwind, Qnil);
10340 binding = Fkey_description (bindings, Qnil);
10342 newmessage
10343 = (char *) alloca (SCHARS (SYMBOL_NAME (function))
10344 + SBYTES (binding)
10345 + 100);
10346 sprintf (newmessage, "You can run the command `%s' with %s",
10347 SDATA (SYMBOL_NAME (function)),
10348 SDATA (binding));
10349 message2 (newmessage,
10350 strlen (newmessage),
10351 STRING_MULTIBYTE (binding));
10352 if (NUMBERP (Vsuggest_key_bindings))
10353 waited = sit_for (Vsuggest_key_bindings, 0, 2);
10354 else
10355 waited = sit_for (make_number (2), 0, 2);
10357 if (!NILP (waited) && message_p)
10358 restore_message ();
10360 unbind_to (count, Qnil);
10364 RETURN_UNGCPRO (value);
10368 /* Return nonzero if input events are pending. */
10371 detect_input_pending (void)
10373 if (!input_pending)
10374 get_input_pending (&input_pending, 0);
10376 return input_pending;
10379 /* Return nonzero if input events other than mouse movements are
10380 pending. */
10383 detect_input_pending_ignore_squeezables (void)
10385 if (!input_pending)
10386 get_input_pending (&input_pending, READABLE_EVENTS_IGNORE_SQUEEZABLES);
10388 return input_pending;
10391 /* Return nonzero if input events are pending, and run any pending timers. */
10394 detect_input_pending_run_timers (int do_display)
10396 int old_timers_run = timers_run;
10398 if (!input_pending)
10399 get_input_pending (&input_pending, READABLE_EVENTS_DO_TIMERS_NOW);
10401 if (old_timers_run != timers_run && do_display)
10403 redisplay_preserve_echo_area (8);
10404 /* The following fixes a bug when using lazy-lock with
10405 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10406 from an idle timer function. The symptom of the bug is that
10407 the cursor sometimes doesn't become visible until the next X
10408 event is processed. --gerd. */
10410 Lisp_Object tail, frame;
10411 FOR_EACH_FRAME (tail, frame)
10412 if (FRAME_RIF (XFRAME (frame)))
10413 FRAME_RIF (XFRAME (frame))->flush_display (XFRAME (frame));
10417 return input_pending;
10420 /* This is called in some cases before a possible quit.
10421 It cases the next call to detect_input_pending to recompute input_pending.
10422 So calling this function unnecessarily can't do any harm. */
10424 void
10425 clear_input_pending (void)
10427 input_pending = 0;
10430 /* Return nonzero if there are pending requeued events.
10431 This isn't used yet. The hope is to make wait_reading_process_output
10432 call it, and return if it runs Lisp code that unreads something.
10433 The problem is, kbd_buffer_get_event needs to be fixed to know what
10434 to do in that case. It isn't trivial. */
10437 requeued_events_pending_p (void)
10439 return (!NILP (Vunread_command_events) || unread_command_char != -1);
10443 DEFUN ("input-pending-p", Finput_pending_p, Sinput_pending_p, 0, 0, 0,
10444 doc: /* Return t if command input is currently available with no wait.
10445 Actually, the value is nil only if we can be sure that no input is available;
10446 if there is a doubt, the value is t. */)
10447 (void)
10449 if (!NILP (Vunread_command_events) || unread_command_char != -1
10450 || !NILP (Vunread_post_input_method_events)
10451 || !NILP (Vunread_input_method_events))
10452 return (Qt);
10454 get_input_pending (&input_pending,
10455 READABLE_EVENTS_DO_TIMERS_NOW
10456 | READABLE_EVENTS_FILTER_EVENTS);
10457 return input_pending > 0 ? Qt : Qnil;
10460 DEFUN ("recent-keys", Frecent_keys, Srecent_keys, 0, 0, 0,
10461 doc: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10462 (void)
10464 Lisp_Object *keys = XVECTOR (recent_keys)->contents;
10465 Lisp_Object val;
10467 if (total_keys < NUM_RECENT_KEYS)
10468 return Fvector (total_keys, keys);
10469 else
10471 val = Fvector (NUM_RECENT_KEYS, keys);
10472 memcpy (XVECTOR (val)->contents, keys + recent_keys_index,
10473 (NUM_RECENT_KEYS - recent_keys_index) * sizeof (Lisp_Object));
10474 memcpy (XVECTOR (val)->contents + NUM_RECENT_KEYS - recent_keys_index,
10475 keys, recent_keys_index * sizeof (Lisp_Object));
10476 return val;
10480 DEFUN ("this-command-keys", Fthis_command_keys, Sthis_command_keys, 0, 0, 0,
10481 doc: /* Return the key sequence that invoked this command.
10482 However, if the command has called `read-key-sequence', it returns
10483 the last key sequence that has been read.
10484 The value is a string or a vector.
10486 See also `this-command-keys-vector'. */)
10487 (void)
10489 return make_event_array (this_command_key_count,
10490 XVECTOR (this_command_keys)->contents);
10493 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector, Sthis_command_keys_vector, 0, 0, 0,
10494 doc: /* Return the key sequence that invoked this command, as a vector.
10495 However, if the command has called `read-key-sequence', it returns
10496 the last key sequence that has been read.
10498 See also `this-command-keys'. */)
10499 (void)
10501 return Fvector (this_command_key_count,
10502 XVECTOR (this_command_keys)->contents);
10505 DEFUN ("this-single-command-keys", Fthis_single_command_keys,
10506 Sthis_single_command_keys, 0, 0, 0,
10507 doc: /* Return the key sequence that invoked this command.
10508 More generally, it returns the last key sequence read, either by
10509 the command loop or by `read-key-sequence'.
10510 Unlike `this-command-keys', this function's value
10511 does not include prefix arguments.
10512 The value is always a vector. */)
10513 (void)
10515 return Fvector (this_command_key_count
10516 - this_single_command_key_start,
10517 (XVECTOR (this_command_keys)->contents
10518 + this_single_command_key_start));
10521 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys,
10522 Sthis_single_command_raw_keys, 0, 0, 0,
10523 doc: /* Return the raw events that were read for this command.
10524 More generally, it returns the last key sequence read, either by
10525 the command loop or by `read-key-sequence'.
10526 Unlike `this-single-command-keys', this function's value
10527 shows the events before all translations (except for input methods).
10528 The value is always a vector. */)
10529 (void)
10531 return Fvector (raw_keybuf_count,
10532 (XVECTOR (raw_keybuf)->contents));
10535 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths,
10536 Sreset_this_command_lengths, 0, 0, 0,
10537 doc: /* Make the unread events replace the last command and echo.
10538 Used in `universal-argument-other-key'.
10540 `universal-argument-other-key' rereads the event just typed.
10541 It then gets translated through `function-key-map'.
10542 The translated event has to replace the real events,
10543 both in the value of (this-command-keys) and in echoing.
10544 To achieve this, `universal-argument-other-key' calls
10545 `reset-this-command-lengths', which discards the record of reading
10546 these events the first time. */)
10547 (void)
10549 this_command_key_count = before_command_key_count;
10550 if (this_command_key_count < this_single_command_key_start)
10551 this_single_command_key_start = this_command_key_count;
10553 echo_truncate (before_command_echo_length);
10555 /* Cause whatever we put into unread-command-events
10556 to echo as if it were being freshly read from the keyboard. */
10557 this_command_key_count_reset = 1;
10559 return Qnil;
10562 DEFUN ("clear-this-command-keys", Fclear_this_command_keys,
10563 Sclear_this_command_keys, 0, 1, 0,
10564 doc: /* Clear out the vector that `this-command-keys' returns.
10565 Also clear the record of the last 100 events, unless optional arg
10566 KEEP-RECORD is non-nil. */)
10567 (Lisp_Object keep_record)
10569 int i;
10571 this_command_key_count = 0;
10572 this_command_key_count_reset = 0;
10574 if (NILP (keep_record))
10576 for (i = 0; i < XVECTOR (recent_keys)->size; ++i)
10577 XVECTOR (recent_keys)->contents[i] = Qnil;
10578 total_keys = 0;
10579 recent_keys_index = 0;
10581 return Qnil;
10584 DEFUN ("recursion-depth", Frecursion_depth, Srecursion_depth, 0, 0, 0,
10585 doc: /* Return the current depth in recursive edits. */)
10586 (void)
10588 Lisp_Object temp;
10589 XSETFASTINT (temp, command_loop_level + minibuf_level);
10590 return temp;
10593 DEFUN ("open-dribble-file", Fopen_dribble_file, Sopen_dribble_file, 1, 1,
10594 "FOpen dribble file: ",
10595 doc: /* Start writing all keyboard characters to a dribble file called FILE.
10596 If FILE is nil, close any open dribble file. */)
10597 (Lisp_Object file)
10599 if (dribble)
10601 BLOCK_INPUT;
10602 fclose (dribble);
10603 UNBLOCK_INPUT;
10604 dribble = 0;
10606 if (!NILP (file))
10608 file = Fexpand_file_name (file, Qnil);
10609 dribble = fopen (SSDATA (file), "w");
10610 if (dribble == 0)
10611 report_file_error ("Opening dribble", Fcons (file, Qnil));
10613 return Qnil;
10616 DEFUN ("discard-input", Fdiscard_input, Sdiscard_input, 0, 0, 0,
10617 doc: /* Discard the contents of the terminal input buffer.
10618 Also end any kbd macro being defined. */)
10619 (void)
10621 if (!NILP (KVAR (current_kboard, defining_kbd_macro)))
10623 /* Discard the last command from the macro. */
10624 Fcancel_kbd_macro_events ();
10625 end_kbd_macro ();
10628 update_mode_lines++;
10630 Vunread_command_events = Qnil;
10631 unread_command_char = -1;
10633 discard_tty_input ();
10635 kbd_fetch_ptr = kbd_store_ptr;
10636 input_pending = 0;
10638 return Qnil;
10641 DEFUN ("suspend-emacs", Fsuspend_emacs, Ssuspend_emacs, 0, 1, "",
10642 doc: /* Stop Emacs and return to superior process. You can resume later.
10643 If `cannot-suspend' is non-nil, or if the system doesn't support job
10644 control, run a subshell instead.
10646 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10647 to be read as terminal input by Emacs's parent, after suspension.
10649 Before suspending, run the normal hook `suspend-hook'.
10650 After resumption run the normal hook `suspend-resume-hook'.
10652 Some operating systems cannot stop the Emacs process and resume it later.
10653 On such systems, Emacs starts a subshell instead of suspending. */)
10654 (Lisp_Object stuffstring)
10656 int count = SPECPDL_INDEX ();
10657 int old_height, old_width;
10658 int width, height;
10659 struct gcpro gcpro1;
10660 Lisp_Object hook;
10662 if (tty_list && tty_list->next)
10663 error ("There are other tty frames open; close them before suspending Emacs");
10665 if (!NILP (stuffstring))
10666 CHECK_STRING (stuffstring);
10668 /* Run the functions in suspend-hook. */
10669 hook = intern ("suspend-hook");
10670 Frun_hooks (1, &hook);
10672 GCPRO1 (stuffstring);
10673 get_tty_size (fileno (CURTTY ()->input), &old_width, &old_height);
10674 reset_all_sys_modes ();
10675 /* sys_suspend can get an error if it tries to fork a subshell
10676 and the system resources aren't available for that. */
10677 record_unwind_protect ((Lisp_Object (*) (Lisp_Object)) init_all_sys_modes,
10678 Qnil);
10679 stuff_buffered_input (stuffstring);
10680 if (cannot_suspend)
10681 sys_subshell ();
10682 else
10683 sys_suspend ();
10684 unbind_to (count, Qnil);
10686 /* Check if terminal/window size has changed.
10687 Note that this is not useful when we are running directly
10688 with a window system; but suspend should be disabled in that case. */
10689 get_tty_size (fileno (CURTTY ()->input), &width, &height);
10690 if (width != old_width || height != old_height)
10691 change_frame_size (SELECTED_FRAME (), height, width, 0, 0, 0);
10693 /* Run suspend-resume-hook. */
10694 hook = intern ("suspend-resume-hook");
10695 Frun_hooks (1, &hook);
10697 UNGCPRO;
10698 return Qnil;
10701 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10702 Then in any case stuff anything Emacs has read ahead and not used. */
10704 void
10705 stuff_buffered_input (Lisp_Object stuffstring)
10707 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10708 register unsigned char *p;
10710 if (STRINGP (stuffstring))
10712 register EMACS_INT count;
10714 p = SDATA (stuffstring);
10715 count = SBYTES (stuffstring);
10716 while (count-- > 0)
10717 stuff_char (*p++);
10718 stuff_char ('\n');
10721 /* Anything we have read ahead, put back for the shell to read. */
10722 /* ?? What should this do when we have multiple keyboards??
10723 Should we ignore anything that was typed in at the "wrong" kboard?
10725 rms: we should stuff everything back into the kboard
10726 it came from. */
10727 for (; kbd_fetch_ptr != kbd_store_ptr; kbd_fetch_ptr++)
10730 if (kbd_fetch_ptr == kbd_buffer + KBD_BUFFER_SIZE)
10731 kbd_fetch_ptr = kbd_buffer;
10732 if (kbd_fetch_ptr->kind == ASCII_KEYSTROKE_EVENT)
10733 stuff_char (kbd_fetch_ptr->code);
10735 clear_event (kbd_fetch_ptr);
10738 input_pending = 0;
10739 #endif /* SIGTSTP */
10742 void
10743 set_waiting_for_input (struct timeval *time_to_clear)
10745 input_available_clear_time = time_to_clear;
10747 /* Tell handle_interrupt to throw back to read_char, */
10748 waiting_for_input = 1;
10750 /* If handle_interrupt was called before and buffered a C-g,
10751 make it run again now, to avoid timing error. */
10752 if (!NILP (Vquit_flag))
10753 quit_throw_to_read_char ();
10756 void
10757 clear_waiting_for_input (void)
10759 /* Tell handle_interrupt not to throw back to read_char, */
10760 waiting_for_input = 0;
10761 input_available_clear_time = 0;
10764 /* The SIGINT handler.
10766 If we have a frame on the controlling tty, we assume that the
10767 SIGINT was generated by C-g, so we call handle_interrupt.
10768 Otherwise, the handler kills Emacs. */
10770 static void
10771 interrupt_signal (int signalnum) /* If we don't have an argument, some */
10772 /* compilers complain in signal calls. */
10774 /* Must preserve main program's value of errno. */
10775 int old_errno = errno;
10776 struct terminal *terminal;
10778 SIGNAL_THREAD_CHECK (signalnum);
10780 /* See if we have an active terminal on our controlling tty. */
10781 terminal = get_named_tty ("/dev/tty");
10782 if (!terminal)
10784 /* If there are no frames there, let's pretend that we are a
10785 well-behaving UN*X program and quit. */
10786 Fkill_emacs (Qnil);
10788 else
10790 /* Otherwise, the SIGINT was probably generated by C-g. */
10792 /* Set internal_last_event_frame to the top frame of the
10793 controlling tty, if we have a frame there. We disable the
10794 interrupt key on secondary ttys, so the SIGINT must have come
10795 from the controlling tty. */
10796 internal_last_event_frame = terminal->display_info.tty->top_frame;
10798 handle_interrupt ();
10801 errno = old_errno;
10804 /* This routine is called at interrupt level in response to C-g.
10806 It is called from the SIGINT handler or kbd_buffer_store_event.
10808 If `waiting_for_input' is non zero, then unless `echoing' is
10809 nonzero, immediately throw back to read_char.
10811 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10812 eval to throw, when it gets a chance. If quit-flag is already
10813 non-nil, it stops the job right away. */
10815 static void
10816 handle_interrupt (void)
10818 char c;
10820 cancel_echoing ();
10822 /* XXX This code needs to be revised for multi-tty support. */
10823 if (!NILP (Vquit_flag) && get_named_tty ("/dev/tty"))
10825 /* If SIGINT isn't blocked, don't let us be interrupted by
10826 another SIGINT, it might be harmful due to non-reentrancy
10827 in I/O functions. */
10828 sigblock (sigmask (SIGINT));
10830 fflush (stdout);
10831 reset_all_sys_modes ();
10833 #ifdef SIGTSTP /* Support possible in later USG versions */
10835 * On systems which can suspend the current process and return to the original
10836 * shell, this command causes the user to end up back at the shell.
10837 * The "Auto-save" and "Abort" questions are not asked until
10838 * the user elects to return to emacs, at which point he can save the current
10839 * job and either dump core or continue.
10841 sys_suspend ();
10842 #else
10843 /* Perhaps should really fork an inferior shell?
10844 But that would not provide any way to get back
10845 to the original shell, ever. */
10846 printf ("No support for stopping a process on this operating system;\n");
10847 printf ("you can continue or abort.\n");
10848 #endif /* not SIGTSTP */
10849 #ifdef MSDOS
10850 /* We must remain inside the screen area when the internal terminal
10851 is used. Note that [Enter] is not echoed by dos. */
10852 cursor_to (SELECTED_FRAME (), 0, 0);
10853 #endif
10854 /* It doesn't work to autosave while GC is in progress;
10855 the code used for auto-saving doesn't cope with the mark bit. */
10856 if (!gc_in_progress)
10858 printf ("Auto-save? (y or n) ");
10859 fflush (stdout);
10860 if (((c = getchar ()) & ~040) == 'Y')
10862 Fdo_auto_save (Qt, Qnil);
10863 #ifdef MSDOS
10864 printf ("\r\nAuto-save done");
10865 #else /* not MSDOS */
10866 printf ("Auto-save done\n");
10867 #endif /* not MSDOS */
10869 while (c != '\n') c = getchar ();
10871 else
10873 /* During GC, it must be safe to reenable quitting again. */
10874 Vinhibit_quit = Qnil;
10875 #ifdef MSDOS
10876 printf ("\r\n");
10877 #endif /* not MSDOS */
10878 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10879 printf ("but will instead do a real quit after garbage collection ends\r\n");
10880 fflush (stdout);
10883 #ifdef MSDOS
10884 printf ("\r\nAbort? (y or n) ");
10885 #else /* not MSDOS */
10886 printf ("Abort (and dump core)? (y or n) ");
10887 #endif /* not MSDOS */
10888 fflush (stdout);
10889 if (((c = getchar ()) & ~040) == 'Y')
10890 abort ();
10891 while (c != '\n') c = getchar ();
10892 #ifdef MSDOS
10893 printf ("\r\nContinuing...\r\n");
10894 #else /* not MSDOS */
10895 printf ("Continuing...\n");
10896 #endif /* not MSDOS */
10897 fflush (stdout);
10898 init_all_sys_modes ();
10899 sigfree ();
10901 else
10903 /* If executing a function that wants to be interrupted out of
10904 and the user has not deferred quitting by binding `inhibit-quit'
10905 then quit right away. */
10906 if (immediate_quit && NILP (Vinhibit_quit))
10908 struct gl_state_s saved;
10909 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
10911 immediate_quit = 0;
10912 sigfree ();
10913 saved = gl_state;
10914 GCPRO4 (saved.object, saved.global_code,
10915 saved.current_syntax_table, saved.old_prop);
10916 Fsignal (Qquit, Qnil);
10917 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10918 gl_state = saved;
10919 UNGCPRO;
10921 else
10922 /* Else request quit when it's safe */
10923 Vquit_flag = Qt;
10926 /* TODO: The longjmp in this call throws the NS event loop integration off,
10927 and it seems to do fine without this. Probably some attention
10928 needs to be paid to the setting of waiting_for_input in
10929 wait_reading_process_output() under HAVE_NS because of the call
10930 to ns_select there (needed because otherwise events aren't picked up
10931 outside of polling since we don't get SIGIO like X and we don't have a
10932 separate event loop thread like W32. */
10933 #ifndef HAVE_NS
10934 if (waiting_for_input && !echoing)
10935 quit_throw_to_read_char ();
10936 #endif
10939 /* Handle a C-g by making read_char return C-g. */
10941 void
10942 quit_throw_to_read_char (void)
10944 sigfree ();
10945 /* Prevent another signal from doing this before we finish. */
10946 clear_waiting_for_input ();
10947 input_pending = 0;
10949 Vunread_command_events = Qnil;
10950 unread_command_char = -1;
10952 #if 0 /* Currently, sit_for is called from read_char without turning
10953 off polling. And that can call set_waiting_for_input.
10954 It seems to be harmless. */
10955 #ifdef POLL_FOR_INPUT
10956 /* May be > 1 if in recursive minibuffer. */
10957 if (poll_suppress_count == 0)
10958 abort ();
10959 #endif
10960 #endif
10961 if (FRAMEP (internal_last_event_frame)
10962 && !EQ (internal_last_event_frame, selected_frame))
10963 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame),
10964 0, 0, Qnil);
10966 _longjmp (getcjmp, 1);
10969 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode, Sset_input_interrupt_mode, 1, 1, 0,
10970 doc: /* Set interrupt mode of reading keyboard input.
10971 If INTERRUPT is non-nil, Emacs will use input interrupts;
10972 otherwise Emacs uses CBREAK mode.
10974 See also `current-input-mode'. */)
10975 (Lisp_Object interrupt)
10977 int new_interrupt_input;
10978 #ifdef SIGIO
10979 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10980 #ifdef HAVE_X_WINDOWS
10981 if (x_display_list != NULL)
10983 /* When using X, don't give the user a real choice,
10984 because we haven't implemented the mechanisms to support it. */
10985 new_interrupt_input = 1;
10987 else
10988 #endif /* HAVE_X_WINDOWS */
10989 new_interrupt_input = !NILP (interrupt);
10990 #else /* not SIGIO */
10991 new_interrupt_input = 0;
10992 #endif /* not SIGIO */
10994 if (new_interrupt_input != interrupt_input)
10996 #ifdef POLL_FOR_INPUT
10997 stop_polling ();
10998 #endif
10999 #ifndef DOS_NT
11000 /* this causes startup screen to be restored and messes with the mouse */
11001 reset_all_sys_modes ();
11002 interrupt_input = new_interrupt_input;
11003 init_all_sys_modes ();
11004 #else
11005 interrupt_input = new_interrupt_input;
11006 #endif
11008 #ifdef POLL_FOR_INPUT
11009 poll_suppress_count = 1;
11010 start_polling ();
11011 #endif
11013 return Qnil;
11016 DEFUN ("set-output-flow-control", Fset_output_flow_control, Sset_output_flow_control, 1, 2, 0,
11017 doc: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11018 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11019 C-q in key sequences.
11021 This setting only has an effect on tty terminals and only when
11022 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11024 See also `current-input-mode'. */)
11025 (Lisp_Object flow, Lisp_Object terminal)
11027 struct terminal *t = get_terminal (terminal, 1);
11028 struct tty_display_info *tty;
11029 if (t == NULL || (t->type != output_termcap && t->type != output_msdos_raw))
11030 return Qnil;
11031 tty = t->display_info.tty;
11033 if (tty->flow_control != !NILP (flow))
11035 #ifndef DOS_NT
11036 /* this causes startup screen to be restored and messes with the mouse */
11037 reset_sys_modes (tty);
11038 #endif
11040 tty->flow_control = !NILP (flow);
11042 #ifndef DOS_NT
11043 init_sys_modes (tty);
11044 #endif
11046 return Qnil;
11049 DEFUN ("set-input-meta-mode", Fset_input_meta_mode, Sset_input_meta_mode, 1, 2, 0,
11050 doc: /* Enable or disable 8-bit input on TERMINAL.
11051 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11052 bit as the Meta modifier.
11054 If META is nil, Emacs will ignore the top bit, on the assumption it is
11055 parity.
11057 Otherwise, Emacs will accept and pass through 8-bit input without
11058 specially interpreting the top bit.
11060 This setting only has an effect on tty terminal devices.
11062 Optional parameter TERMINAL specifies the tty terminal device to use.
11063 It may be a terminal object, a frame, or nil for the terminal used by
11064 the currently selected frame.
11066 See also `current-input-mode'. */)
11067 (Lisp_Object meta, Lisp_Object terminal)
11069 struct terminal *t = get_terminal (terminal, 1);
11070 struct tty_display_info *tty;
11071 int new_meta;
11073 if (t == NULL || (t->type != output_termcap && t->type != output_msdos_raw))
11074 return Qnil;
11075 tty = t->display_info.tty;
11077 if (NILP (meta))
11078 new_meta = 0;
11079 else if (EQ (meta, Qt))
11080 new_meta = 1;
11081 else
11082 new_meta = 2;
11084 if (tty->meta_key != new_meta)
11086 #ifndef DOS_NT
11087 /* this causes startup screen to be restored and messes with the mouse */
11088 reset_sys_modes (tty);
11089 #endif
11091 tty->meta_key = new_meta;
11093 #ifndef DOS_NT
11094 init_sys_modes (tty);
11095 #endif
11097 return Qnil;
11100 DEFUN ("set-quit-char", Fset_quit_char, Sset_quit_char, 1, 1, 0,
11101 doc: /* Specify character used for quitting.
11102 QUIT must be an ASCII character.
11104 This function only has an effect on the controlling tty of the Emacs
11105 process.
11107 See also `current-input-mode'. */)
11108 (Lisp_Object quit)
11110 struct terminal *t = get_named_tty ("/dev/tty");
11111 struct tty_display_info *tty;
11112 if (t == NULL || (t->type != output_termcap && t->type != output_msdos_raw))
11113 return Qnil;
11114 tty = t->display_info.tty;
11116 if (NILP (quit) || !INTEGERP (quit) || XINT (quit) < 0 || XINT (quit) > 0400)
11117 error ("QUIT must be an ASCII character");
11119 #ifndef DOS_NT
11120 /* this causes startup screen to be restored and messes with the mouse */
11121 reset_sys_modes (tty);
11122 #endif
11124 /* Don't let this value be out of range. */
11125 quit_char = XINT (quit) & (tty->meta_key == 0 ? 0177 : 0377);
11127 #ifndef DOS_NT
11128 init_sys_modes (tty);
11129 #endif
11131 return Qnil;
11134 DEFUN ("set-input-mode", Fset_input_mode, Sset_input_mode, 3, 4, 0,
11135 doc: /* Set mode of reading keyboard input.
11136 First arg INTERRUPT non-nil means use input interrupts;
11137 nil means use CBREAK mode.
11138 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11139 (no effect except in CBREAK mode).
11140 Third arg META t means accept 8-bit input (for a Meta key).
11141 META nil means ignore the top bit, on the assumption it is parity.
11142 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11143 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11144 See also `current-input-mode'. */)
11145 (Lisp_Object interrupt, Lisp_Object flow, Lisp_Object meta, Lisp_Object quit)
11147 Fset_input_interrupt_mode (interrupt);
11148 Fset_output_flow_control (flow, Qnil);
11149 Fset_input_meta_mode (meta, Qnil);
11150 if (!NILP (quit))
11151 Fset_quit_char (quit);
11152 return Qnil;
11155 DEFUN ("current-input-mode", Fcurrent_input_mode, Scurrent_input_mode, 0, 0, 0,
11156 doc: /* Return information about the way Emacs currently reads keyboard input.
11157 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11158 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11159 nil, Emacs is using CBREAK mode.
11160 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11161 terminal; this does not apply if Emacs uses interrupt-driven input.
11162 META is t if accepting 8-bit input with 8th bit as Meta flag.
11163 META nil means ignoring the top bit, on the assumption it is parity.
11164 META is neither t nor nil if accepting 8-bit input and using
11165 all 8 bits as the character code.
11166 QUIT is the character Emacs currently uses to quit.
11167 The elements of this list correspond to the arguments of
11168 `set-input-mode'. */)
11169 (void)
11171 Lisp_Object val[4];
11172 struct frame *sf = XFRAME (selected_frame);
11174 val[0] = interrupt_input ? Qt : Qnil;
11175 if (FRAME_TERMCAP_P (sf) || FRAME_MSDOS_P (sf))
11177 val[1] = FRAME_TTY (sf)->flow_control ? Qt : Qnil;
11178 val[2] = (FRAME_TTY (sf)->meta_key == 2
11179 ? make_number (0)
11180 : (CURTTY ()->meta_key == 1 ? Qt : Qnil));
11182 else
11184 val[1] = Qnil;
11185 val[2] = Qt;
11187 XSETFASTINT (val[3], quit_char);
11189 return Flist (sizeof (val) / sizeof (val[0]), val);
11192 DEFUN ("posn-at-x-y", Fposn_at_x_y, Sposn_at_x_y, 2, 4, 0,
11193 doc: /* Return position information for pixel coordinates X and Y.
11194 By default, X and Y are relative to text area of the selected window.
11195 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11196 If optional fourth arg WHOLE is non-nil, X is relative to the left
11197 edge of the window.
11199 The return value is similar to a mouse click position:
11200 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11201 IMAGE (DX . DY) (WIDTH . HEIGHT))
11202 The `posn-' functions access elements of such lists. */)
11203 (Lisp_Object x, Lisp_Object y, Lisp_Object frame_or_window, Lisp_Object whole)
11205 CHECK_NATNUM (x);
11206 CHECK_NATNUM (y);
11208 if (NILP (frame_or_window))
11209 frame_or_window = selected_window;
11211 if (WINDOWP (frame_or_window))
11213 struct window *w;
11215 CHECK_LIVE_WINDOW (frame_or_window);
11217 w = XWINDOW (frame_or_window);
11218 XSETINT (x, (XINT (x)
11219 + WINDOW_LEFT_EDGE_X (w)
11220 + (NILP (whole)
11221 ? window_box_left_offset (w, TEXT_AREA)
11222 : 0)));
11223 XSETINT (y, WINDOW_TO_FRAME_PIXEL_Y (w, XINT (y)));
11224 frame_or_window = w->frame;
11227 CHECK_LIVE_FRAME (frame_or_window);
11229 return make_lispy_position (XFRAME (frame_or_window), x, y, 0);
11232 DEFUN ("posn-at-point", Fposn_at_point, Sposn_at_point, 0, 2, 0,
11233 doc: /* Return position information for buffer POS in WINDOW.
11234 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11236 Return nil if position is not visible in window. Otherwise,
11237 the return value is similar to that returned by `event-start' for
11238 a mouse click at the upper left corner of the glyph corresponding
11239 to the given buffer position:
11240 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11241 IMAGE (DX . DY) (WIDTH . HEIGHT))
11242 The `posn-' functions access elements of such lists. */)
11243 (Lisp_Object pos, Lisp_Object window)
11245 Lisp_Object tem;
11247 if (NILP (window))
11248 window = selected_window;
11250 tem = Fpos_visible_in_window_p (pos, window, Qt);
11251 if (!NILP (tem))
11253 Lisp_Object x = XCAR (tem);
11254 Lisp_Object y = XCAR (XCDR (tem));
11256 /* Point invisible due to hscrolling? */
11257 if (XINT (x) < 0)
11258 return Qnil;
11259 tem = Fposn_at_x_y (x, y, window, Qnil);
11262 return tem;
11267 * Set up a new kboard object with reasonable initial values.
11269 void
11270 init_kboard (KBOARD *kb)
11272 KVAR (kb, Voverriding_terminal_local_map) = Qnil;
11273 KVAR (kb, Vlast_command) = Qnil;
11274 KVAR (kb, Vreal_last_command) = Qnil;
11275 KVAR (kb, Vkeyboard_translate_table) = Qnil;
11276 KVAR (kb, Vlast_repeatable_command) = Qnil;
11277 KVAR (kb, Vprefix_arg) = Qnil;
11278 KVAR (kb, Vlast_prefix_arg) = Qnil;
11279 KVAR (kb, kbd_queue) = Qnil;
11280 kb->kbd_queue_has_data = 0;
11281 kb->immediate_echo = 0;
11282 KVAR (kb, echo_string) = Qnil;
11283 kb->echo_after_prompt = -1;
11284 kb->kbd_macro_buffer = 0;
11285 kb->kbd_macro_bufsize = 0;
11286 KVAR (kb, defining_kbd_macro) = Qnil;
11287 KVAR (kb, Vlast_kbd_macro) = Qnil;
11288 kb->reference_count = 0;
11289 KVAR (kb, Vsystem_key_alist) = Qnil;
11290 KVAR (kb, system_key_syms) = Qnil;
11291 KVAR (kb, Vwindow_system) = Qt; /* Unset. */
11292 KVAR (kb, Vinput_decode_map) = Fmake_sparse_keymap (Qnil);
11293 KVAR (kb, Vlocal_function_key_map) = Fmake_sparse_keymap (Qnil);
11294 Fset_keymap_parent (KVAR (kb, Vlocal_function_key_map), Vfunction_key_map);
11295 KVAR (kb, Vdefault_minibuffer_frame) = Qnil;
11299 * Destroy the contents of a kboard object, but not the object itself.
11300 * We use this just before deleting it, or if we're going to initialize
11301 * it a second time.
11303 static void
11304 wipe_kboard (KBOARD *kb)
11306 xfree (kb->kbd_macro_buffer);
11309 /* Free KB and memory referenced from it. */
11311 void
11312 delete_kboard (KBOARD *kb)
11314 KBOARD **kbp;
11316 for (kbp = &all_kboards; *kbp != kb; kbp = &(*kbp)->next_kboard)
11317 if (*kbp == NULL)
11318 abort ();
11319 *kbp = kb->next_kboard;
11321 /* Prevent a dangling reference to KB. */
11322 if (kb == current_kboard
11323 && FRAMEP (selected_frame)
11324 && FRAME_LIVE_P (XFRAME (selected_frame)))
11326 current_kboard = FRAME_KBOARD (XFRAME (selected_frame));
11327 single_kboard = 0;
11328 if (current_kboard == kb)
11329 abort ();
11332 wipe_kboard (kb);
11333 xfree (kb);
11336 void
11337 init_keyboard (void)
11339 /* This is correct before outermost invocation of the editor loop */
11340 command_loop_level = -1;
11341 immediate_quit = 0;
11342 quit_char = Ctl ('g');
11343 Vunread_command_events = Qnil;
11344 unread_command_char = -1;
11345 EMACS_SET_SECS_USECS (timer_idleness_start_time, -1, -1);
11346 total_keys = 0;
11347 recent_keys_index = 0;
11348 kbd_fetch_ptr = kbd_buffer;
11349 kbd_store_ptr = kbd_buffer;
11350 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11351 do_mouse_tracking = Qnil;
11352 #endif
11353 input_pending = 0;
11354 interrupt_input_blocked = 0;
11355 interrupt_input_pending = 0;
11356 #ifdef SYNC_INPUT
11357 pending_signals = 0;
11358 #endif
11360 /* This means that command_loop_1 won't try to select anything the first
11361 time through. */
11362 internal_last_event_frame = Qnil;
11363 Vlast_event_frame = internal_last_event_frame;
11365 current_kboard = initial_kboard;
11366 /* Re-initialize the keyboard again. */
11367 wipe_kboard (current_kboard);
11368 init_kboard (current_kboard);
11369 /* A value of nil for Vwindow_system normally means a tty, but we also use
11370 it for the initial terminal since there is no window system there. */
11371 KVAR (current_kboard, Vwindow_system) = Qnil;
11373 if (!noninteractive)
11375 /* Before multi-tty support, these handlers used to be installed
11376 only if the current session was a tty session. Now an Emacs
11377 session may have multiple display types, so we always handle
11378 SIGINT. There is special code in interrupt_signal to exit
11379 Emacs on SIGINT when there are no termcap frames on the
11380 controlling terminal. */
11381 signal (SIGINT, interrupt_signal);
11382 #ifndef DOS_NT
11383 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11384 SIGQUIT and we can't tell which one it will give us. */
11385 signal (SIGQUIT, interrupt_signal);
11386 #endif /* not DOS_NT */
11388 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11389 #ifdef SIGIO
11390 if (!noninteractive)
11391 signal (SIGIO, input_available_signal);
11392 #endif /* SIGIO */
11394 /* Use interrupt input by default, if it works and noninterrupt input
11395 has deficiencies. */
11397 #ifdef INTERRUPT_INPUT
11398 interrupt_input = 1;
11399 #else
11400 interrupt_input = 0;
11401 #endif
11403 sigfree ();
11404 dribble = 0;
11406 if (keyboard_init_hook)
11407 (*keyboard_init_hook) ();
11409 #ifdef POLL_FOR_INPUT
11410 poll_timer = NULL;
11411 poll_suppress_count = 1;
11412 start_polling ();
11413 #endif
11416 /* This type's only use is in syms_of_keyboard, to initialize the
11417 event header symbols and put properties on them. */
11418 struct event_head {
11419 Lisp_Object *var;
11420 const char *name;
11421 Lisp_Object *kind;
11424 static const struct event_head head_table[] = {
11425 {&Qmouse_movement, "mouse-movement", &Qmouse_movement},
11426 {&Qscroll_bar_movement, "scroll-bar-movement", &Qmouse_movement},
11427 {&Qswitch_frame, "switch-frame", &Qswitch_frame},
11428 {&Qdelete_frame, "delete-frame", &Qdelete_frame},
11429 {&Qiconify_frame, "iconify-frame", &Qiconify_frame},
11430 {&Qmake_frame_visible, "make-frame-visible", &Qmake_frame_visible},
11431 /* `select-window' should be handled just like `switch-frame'
11432 in read_key_sequence. */
11433 {&Qselect_window, "select-window", &Qswitch_frame}
11436 void
11437 syms_of_keyboard (void)
11439 pending_funcalls = Qnil;
11440 staticpro (&pending_funcalls);
11442 Vlispy_mouse_stem = make_pure_c_string ("mouse");
11443 staticpro (&Vlispy_mouse_stem);
11445 /* Tool-bars. */
11446 QCimage = intern_c_string (":image");
11447 staticpro (&QCimage);
11449 staticpro (&Qhelp_echo);
11450 Qhelp_echo = intern_c_string ("help-echo");
11452 staticpro (&Qrtl);
11453 Qrtl = intern_c_string (":rtl");
11455 staticpro (&item_properties);
11456 item_properties = Qnil;
11458 staticpro (&tool_bar_item_properties);
11459 tool_bar_item_properties = Qnil;
11460 staticpro (&tool_bar_items_vector);
11461 tool_bar_items_vector = Qnil;
11463 staticpro (&real_this_command);
11464 real_this_command = Qnil;
11466 Qtimer_event_handler = intern_c_string ("timer-event-handler");
11467 staticpro (&Qtimer_event_handler);
11469 Qdisabled_command_function = intern_c_string ("disabled-command-function");
11470 staticpro (&Qdisabled_command_function);
11472 Qself_insert_command = intern_c_string ("self-insert-command");
11473 staticpro (&Qself_insert_command);
11475 Qforward_char = intern_c_string ("forward-char");
11476 staticpro (&Qforward_char);
11478 Qbackward_char = intern_c_string ("backward-char");
11479 staticpro (&Qbackward_char);
11481 Qdisabled = intern_c_string ("disabled");
11482 staticpro (&Qdisabled);
11484 Qundefined = intern_c_string ("undefined");
11485 staticpro (&Qundefined);
11487 Qpre_command_hook = intern_c_string ("pre-command-hook");
11488 staticpro (&Qpre_command_hook);
11490 Qpost_command_hook = intern_c_string ("post-command-hook");
11491 staticpro (&Qpost_command_hook);
11493 Qdeferred_action_function = intern_c_string ("deferred-action-function");
11494 staticpro (&Qdeferred_action_function);
11496 Qfunction_key = intern_c_string ("function-key");
11497 staticpro (&Qfunction_key);
11498 Qmouse_click = intern_c_string ("mouse-click");
11499 staticpro (&Qmouse_click);
11500 #if defined (WINDOWSNT)
11501 Qlanguage_change = intern_c_string ("language-change");
11502 staticpro (&Qlanguage_change);
11503 #endif
11504 Qdrag_n_drop = intern_c_string ("drag-n-drop");
11505 staticpro (&Qdrag_n_drop);
11507 Qsave_session = intern_c_string ("save-session");
11508 staticpro (&Qsave_session);
11510 #ifdef HAVE_DBUS
11511 Qdbus_event = intern_c_string ("dbus-event");
11512 staticpro (&Qdbus_event);
11513 #endif
11515 Qconfig_changed_event = intern_c_string ("config-changed-event");
11516 staticpro (&Qconfig_changed_event);
11518 Qmenu_enable = intern_c_string ("menu-enable");
11519 staticpro (&Qmenu_enable);
11520 QCenable = intern_c_string (":enable");
11521 staticpro (&QCenable);
11522 QCvisible = intern_c_string (":visible");
11523 staticpro (&QCvisible);
11524 QChelp = intern_c_string (":help");
11525 staticpro (&QChelp);
11526 QCfilter = intern_c_string (":filter");
11527 staticpro (&QCfilter);
11528 QCbutton = intern_c_string (":button");
11529 staticpro (&QCbutton);
11530 QCkeys = intern_c_string (":keys");
11531 staticpro (&QCkeys);
11532 QCkey_sequence = intern_c_string (":key-sequence");
11533 staticpro (&QCkey_sequence);
11534 QCtoggle = intern_c_string (":toggle");
11535 staticpro (&QCtoggle);
11536 QCradio = intern_c_string (":radio");
11537 staticpro (&QCradio);
11538 QClabel = intern_c_string (":label");
11539 staticpro (&QClabel);
11540 QCvert_only = intern_c_string (":vert-only");
11541 staticpro (&QCvert_only);
11543 Qmode_line = intern_c_string ("mode-line");
11544 staticpro (&Qmode_line);
11545 Qvertical_line = intern_c_string ("vertical-line");
11546 staticpro (&Qvertical_line);
11547 Qvertical_scroll_bar = intern_c_string ("vertical-scroll-bar");
11548 staticpro (&Qvertical_scroll_bar);
11549 Qmenu_bar = intern_c_string ("menu-bar");
11550 staticpro (&Qmenu_bar);
11552 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11553 Qmouse_fixup_help_message = intern_c_string ("mouse-fixup-help-message");
11554 staticpro (&Qmouse_fixup_help_message);
11555 #endif
11557 Qabove_handle = intern_c_string ("above-handle");
11558 staticpro (&Qabove_handle);
11559 Qhandle = intern_c_string ("handle");
11560 staticpro (&Qhandle);
11561 Qbelow_handle = intern_c_string ("below-handle");
11562 staticpro (&Qbelow_handle);
11563 Qup = intern_c_string ("up");
11564 staticpro (&Qup);
11565 Qdown = intern_c_string ("down");
11566 staticpro (&Qdown);
11567 Qtop = intern_c_string ("top");
11568 staticpro (&Qtop);
11569 Qbottom = intern_c_string ("bottom");
11570 staticpro (&Qbottom);
11571 Qend_scroll = intern_c_string ("end-scroll");
11572 staticpro (&Qend_scroll);
11573 Qratio = intern_c_string ("ratio");
11574 staticpro (&Qratio);
11576 Qevent_kind = intern_c_string ("event-kind");
11577 staticpro (&Qevent_kind);
11578 Qevent_symbol_elements = intern_c_string ("event-symbol-elements");
11579 staticpro (&Qevent_symbol_elements);
11580 Qevent_symbol_element_mask = intern_c_string ("event-symbol-element-mask");
11581 staticpro (&Qevent_symbol_element_mask);
11582 Qmodifier_cache = intern_c_string ("modifier-cache");
11583 staticpro (&Qmodifier_cache);
11585 Qrecompute_lucid_menubar = intern_c_string ("recompute-lucid-menubar");
11586 staticpro (&Qrecompute_lucid_menubar);
11587 Qactivate_menubar_hook = intern_c_string ("activate-menubar-hook");
11588 staticpro (&Qactivate_menubar_hook);
11590 Qpolling_period = intern_c_string ("polling-period");
11591 staticpro (&Qpolling_period);
11593 Qinput_method_function = intern_c_string ("input-method-function");
11594 staticpro (&Qinput_method_function);
11596 Qx_set_selection = intern_c_string ("x-set-selection");
11597 staticpro (&Qx_set_selection);
11598 QPRIMARY = intern_c_string ("PRIMARY");
11599 staticpro (&QPRIMARY);
11600 Qhandle_switch_frame = intern_c_string ("handle-switch-frame");
11601 staticpro (&Qhandle_switch_frame);
11603 Qinput_method_exit_on_first_char = intern_c_string ("input-method-exit-on-first-char");
11604 staticpro (&Qinput_method_exit_on_first_char);
11605 Qinput_method_use_echo_area = intern_c_string ("input-method-use-echo-area");
11606 staticpro (&Qinput_method_use_echo_area);
11608 Fset (Qinput_method_exit_on_first_char, Qnil);
11609 Fset (Qinput_method_use_echo_area, Qnil);
11611 last_point_position_buffer = Qnil;
11612 last_point_position_window = Qnil;
11615 int i;
11616 int len = sizeof (head_table) / sizeof (head_table[0]);
11618 for (i = 0; i < len; i++)
11620 const struct event_head *p = &head_table[i];
11621 *p->var = intern_c_string (p->name);
11622 staticpro (p->var);
11623 Fput (*p->var, Qevent_kind, *p->kind);
11624 Fput (*p->var, Qevent_symbol_elements, Fcons (*p->var, Qnil));
11628 button_down_location = Fmake_vector (make_number (5), Qnil);
11629 staticpro (&button_down_location);
11630 mouse_syms = Fmake_vector (make_number (5), Qnil);
11631 staticpro (&mouse_syms);
11632 wheel_syms = Fmake_vector (make_number (sizeof (lispy_wheel_names)
11633 / sizeof (lispy_wheel_names[0])),
11634 Qnil);
11635 staticpro (&wheel_syms);
11638 int i;
11639 int len = sizeof (modifier_names) / sizeof (modifier_names[0]);
11641 modifier_symbols = Fmake_vector (make_number (len), Qnil);
11642 for (i = 0; i < len; i++)
11643 if (modifier_names[i])
11644 XVECTOR (modifier_symbols)->contents[i] = intern_c_string (modifier_names[i]);
11645 staticpro (&modifier_symbols);
11648 recent_keys = Fmake_vector (make_number (NUM_RECENT_KEYS), Qnil);
11649 staticpro (&recent_keys);
11651 this_command_keys = Fmake_vector (make_number (40), Qnil);
11652 staticpro (&this_command_keys);
11654 raw_keybuf = Fmake_vector (make_number (30), Qnil);
11655 staticpro (&raw_keybuf);
11657 Qextended_command_history = intern_c_string ("extended-command-history");
11658 Fset (Qextended_command_history, Qnil);
11659 staticpro (&Qextended_command_history);
11661 accent_key_syms = Qnil;
11662 staticpro (&accent_key_syms);
11664 func_key_syms = Qnil;
11665 staticpro (&func_key_syms);
11667 drag_n_drop_syms = Qnil;
11668 staticpro (&drag_n_drop_syms);
11670 unread_switch_frame = Qnil;
11671 staticpro (&unread_switch_frame);
11673 internal_last_event_frame = Qnil;
11674 staticpro (&internal_last_event_frame);
11676 read_key_sequence_cmd = Qnil;
11677 staticpro (&read_key_sequence_cmd);
11679 menu_bar_one_keymap_changed_items = Qnil;
11680 staticpro (&menu_bar_one_keymap_changed_items);
11682 menu_bar_items_vector = Qnil;
11683 staticpro (&menu_bar_items_vector);
11685 help_form_saved_window_configs = Qnil;
11686 staticpro (&help_form_saved_window_configs);
11688 defsubr (&Scurrent_idle_time);
11689 defsubr (&Sevent_symbol_parse_modifiers);
11690 defsubr (&Sevent_convert_list);
11691 defsubr (&Sread_key_sequence);
11692 defsubr (&Sread_key_sequence_vector);
11693 defsubr (&Srecursive_edit);
11694 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11695 defsubr (&Strack_mouse);
11696 #endif
11697 defsubr (&Sinput_pending_p);
11698 defsubr (&Scommand_execute);
11699 defsubr (&Srecent_keys);
11700 defsubr (&Sthis_command_keys);
11701 defsubr (&Sthis_command_keys_vector);
11702 defsubr (&Sthis_single_command_keys);
11703 defsubr (&Sthis_single_command_raw_keys);
11704 defsubr (&Sreset_this_command_lengths);
11705 defsubr (&Sclear_this_command_keys);
11706 defsubr (&Ssuspend_emacs);
11707 defsubr (&Sabort_recursive_edit);
11708 defsubr (&Sexit_recursive_edit);
11709 defsubr (&Srecursion_depth);
11710 defsubr (&Stop_level);
11711 defsubr (&Sdiscard_input);
11712 defsubr (&Sopen_dribble_file);
11713 defsubr (&Sset_input_interrupt_mode);
11714 defsubr (&Sset_output_flow_control);
11715 defsubr (&Sset_input_meta_mode);
11716 defsubr (&Sset_quit_char);
11717 defsubr (&Sset_input_mode);
11718 defsubr (&Scurrent_input_mode);
11719 defsubr (&Sexecute_extended_command);
11720 defsubr (&Sposn_at_point);
11721 defsubr (&Sposn_at_x_y);
11723 DEFVAR_LISP ("last-command-event", last_command_event,
11724 doc: /* Last input event that was part of a command. */);
11726 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event,
11727 doc: /* Last input event in a command, except for mouse menu events.
11728 Mouse menus give back keys that don't look like mouse events;
11729 this variable holds the actual mouse event that led to the menu,
11730 so that you can determine whether the command was run by mouse or not. */);
11732 DEFVAR_LISP ("last-input-event", last_input_event,
11733 doc: /* Last input event. */);
11735 DEFVAR_LISP ("unread-command-events", Vunread_command_events,
11736 doc: /* List of events to be read as the command input.
11737 These events are processed first, before actual keyboard input.
11738 Events read from this list are not normally added to `this-command-keys',
11739 as they will already have been added once as they were read for the first time.
11740 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11741 Vunread_command_events = Qnil;
11743 DEFVAR_INT ("unread-command-char", unread_command_char,
11744 doc: /* If not -1, an object to be read as next command input event. */);
11746 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events,
11747 doc: /* List of events to be processed as input by input methods.
11748 These events are processed before `unread-command-events'
11749 and actual keyboard input, but are not given to `input-method-function'. */);
11750 Vunread_post_input_method_events = Qnil;
11752 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events,
11753 doc: /* List of events to be processed as input by input methods.
11754 These events are processed after `unread-command-events', but
11755 before actual keyboard input.
11756 If there's an active input method, the events are given to
11757 `input-method-function'. */);
11758 Vunread_input_method_events = Qnil;
11760 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char,
11761 doc: /* Meta-prefix character code.
11762 Meta-foo as command input turns into this character followed by foo. */);
11763 XSETINT (meta_prefix_char, 033);
11765 DEFVAR_KBOARD ("last-command", Vlast_command,
11766 doc: /* The last command executed.
11767 Normally a symbol with a function definition, but can be whatever was found
11768 in the keymap, or whatever the variable `this-command' was set to by that
11769 command.
11771 The value `mode-exit' is special; it means that the previous command
11772 read an event that told it to exit, and it did so and unread that event.
11773 In other words, the present command is the event that made the previous
11774 command exit.
11776 The value `kill-region' is special; it means that the previous command
11777 was a kill command.
11779 `last-command' has a separate binding for each terminal device.
11780 See Info node `(elisp)Multiple Terminals'. */);
11782 DEFVAR_KBOARD ("real-last-command", Vreal_last_command,
11783 doc: /* Same as `last-command', but never altered by Lisp code. */);
11785 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command,
11786 doc: /* Last command that may be repeated.
11787 The last command executed that was not bound to an input event.
11788 This is the command `repeat' will try to repeat. */);
11790 DEFVAR_LISP ("this-command", Vthis_command,
11791 doc: /* The command now being executed.
11792 The command can set this variable; whatever is put here
11793 will be in `last-command' during the following command. */);
11794 Vthis_command = Qnil;
11796 DEFVAR_LISP ("this-command-keys-shift-translated",
11797 Vthis_command_keys_shift_translated,
11798 doc: /* Non-nil if the key sequence activating this command was shift-translated.
11799 Shift-translation occurs when there is no binding for the key sequence
11800 as entered, but a binding was found by changing an upper-case letter
11801 to lower-case, or a shifted function key to an unshifted one. */);
11802 Vthis_command_keys_shift_translated = Qnil;
11804 DEFVAR_LISP ("this-original-command", Vthis_original_command,
11805 doc: /* The command bound to the current key sequence before remapping.
11806 It equals `this-command' if the original command was not remapped through
11807 any of the active keymaps. Otherwise, the value of `this-command' is the
11808 result of looking up the original command in the active keymaps. */);
11809 Vthis_original_command = Qnil;
11811 DEFVAR_INT ("auto-save-interval", auto_save_interval,
11812 doc: /* *Number of input events between auto-saves.
11813 Zero means disable autosaving due to number of characters typed. */);
11814 auto_save_interval = 300;
11816 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout,
11817 doc: /* *Number of seconds idle time before auto-save.
11818 Zero or nil means disable auto-saving due to idleness.
11819 After auto-saving due to this many seconds of idle time,
11820 Emacs also does a garbage collection if that seems to be warranted. */);
11821 XSETFASTINT (Vauto_save_timeout, 30);
11823 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes,
11824 doc: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11825 The value may be integer or floating point. */);
11826 Vecho_keystrokes = make_number (1);
11828 DEFVAR_INT ("polling-period", polling_period,
11829 doc: /* *Interval between polling for input during Lisp execution.
11830 The reason for polling is to make C-g work to stop a running program.
11831 Polling is needed only when using X windows and SIGIO does not work.
11832 Polling is automatically disabled in all other cases. */);
11833 polling_period = 2;
11835 DEFVAR_LISP ("double-click-time", Vdouble_click_time,
11836 doc: /* *Maximum time between mouse clicks to make a double-click.
11837 Measured in milliseconds. The value nil means disable double-click
11838 recognition; t means double-clicks have no time limit and are detected
11839 by position only. */);
11840 Vdouble_click_time = make_number (500);
11842 DEFVAR_INT ("double-click-fuzz", double_click_fuzz,
11843 doc: /* *Maximum mouse movement between clicks to make a double-click.
11844 On window-system frames, value is the number of pixels the mouse may have
11845 moved horizontally or vertically between two clicks to make a double-click.
11846 On non window-system frames, value is interpreted in units of 1/8 characters
11847 instead of pixels.
11849 This variable is also the threshold for motion of the mouse
11850 to count as a drag. */);
11851 double_click_fuzz = 3;
11853 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus,
11854 doc: /* *Non-nil means inhibit local map menu bar menus. */);
11855 inhibit_local_menu_bar_menus = 0;
11857 DEFVAR_INT ("num-input-keys", num_input_keys,
11858 doc: /* Number of complete key sequences read as input so far.
11859 This includes key sequences read from keyboard macros.
11860 The number is effectively the number of interactive command invocations. */);
11861 num_input_keys = 0;
11863 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events,
11864 doc: /* Number of input events read from the keyboard so far.
11865 This does not include events generated by keyboard macros. */);
11866 num_nonmacro_input_events = 0;
11868 DEFVAR_LISP ("last-event-frame", Vlast_event_frame,
11869 doc: /* The frame in which the most recently read event occurred.
11870 If the last event came from a keyboard macro, this is set to `macro'. */);
11871 Vlast_event_frame = Qnil;
11873 /* This variable is set up in sysdep.c. */
11874 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char,
11875 doc: /* The ERASE character as set by the user with stty. */);
11877 DEFVAR_LISP ("help-char", Vhelp_char,
11878 doc: /* Character to recognize as meaning Help.
11879 When it is read, do `(eval help-form)', and display result if it's a string.
11880 If the value of `help-form' is nil, this char can be read normally. */);
11881 XSETINT (Vhelp_char, Ctl ('H'));
11883 DEFVAR_LISP ("help-event-list", Vhelp_event_list,
11884 doc: /* List of input events to recognize as meaning Help.
11885 These work just like the value of `help-char' (see that). */);
11886 Vhelp_event_list = Qnil;
11888 DEFVAR_LISP ("help-form", Vhelp_form,
11889 doc: /* Form to execute when character `help-char' is read.
11890 If the form returns a string, that string is displayed.
11891 If `help-form' is nil, the help char is not recognized. */);
11892 Vhelp_form = Qnil;
11894 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command,
11895 doc: /* Command to run when `help-char' character follows a prefix key.
11896 This command is used only when there is no actual binding
11897 for that character after that prefix key. */);
11898 Vprefix_help_command = Qnil;
11900 DEFVAR_LISP ("top-level", Vtop_level,
11901 doc: /* Form to evaluate when Emacs starts up.
11902 Useful to set before you dump a modified Emacs. */);
11903 Vtop_level = Qnil;
11905 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table,
11906 doc: /* Translate table for local keyboard input, or nil.
11907 If non-nil, the value should be a char-table. Each character read
11908 from the keyboard is looked up in this char-table. If the value found
11909 there is non-nil, then it is used instead of the actual input character.
11911 The value can also be a string or vector, but this is considered obsolete.
11912 If it is a string or vector of length N, character codes N and up are left
11913 untranslated. In a vector, an element which is nil means "no translation".
11915 This is applied to the characters supplied to input methods, not their
11916 output. See also `translation-table-for-input'.
11918 This variable has a separate binding for each terminal.
11919 See Info node `(elisp)Multiple Terminals'. */);
11921 DEFVAR_BOOL ("cannot-suspend", cannot_suspend,
11922 doc: /* Non-nil means to always spawn a subshell instead of suspending.
11923 \(Even if the operating system has support for stopping a process.\) */);
11924 cannot_suspend = 0;
11926 DEFVAR_BOOL ("menu-prompting", menu_prompting,
11927 doc: /* Non-nil means prompt with menus when appropriate.
11928 This is done when reading from a keymap that has a prompt string,
11929 for elements that have prompt strings.
11930 The menu is displayed on the screen
11931 if X menus were enabled at configuration
11932 time and the previous event was a mouse click prefix key.
11933 Otherwise, menu prompting uses the echo area. */);
11934 menu_prompting = 1;
11936 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char,
11937 doc: /* Character to see next line of menu prompt.
11938 Type this character while in a menu prompt to rotate around the lines of it. */);
11939 XSETINT (menu_prompt_more_char, ' ');
11941 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers,
11942 doc: /* A mask of additional modifier keys to use with every keyboard character.
11943 Emacs applies the modifiers of the character stored here to each keyboard
11944 character it reads. For example, after evaluating the expression
11945 (setq extra-keyboard-modifiers ?\\C-x)
11946 all input characters will have the control modifier applied to them.
11948 Note that the character ?\\C-@, equivalent to the integer zero, does
11949 not count as a control character; rather, it counts as a character
11950 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11951 cancels any modification. */);
11952 extra_keyboard_modifiers = 0;
11954 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark,
11955 doc: /* If an editing command sets this to t, deactivate the mark afterward.
11956 The command loop sets this to nil before each command,
11957 and tests the value when the command returns.
11958 Buffer modification stores t in this variable. */);
11959 Vdeactivate_mark = Qnil;
11960 Qdeactivate_mark = intern_c_string ("deactivate-mark");
11961 staticpro (&Qdeactivate_mark);
11963 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook,
11964 doc: /* Normal hook run before each command is executed.
11965 If an unhandled error happens in running this hook,
11966 the function in which the error occurred is unconditionally removed, since
11967 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11968 Vpre_command_hook = Qnil;
11970 DEFVAR_LISP ("post-command-hook", Vpost_command_hook,
11971 doc: /* Normal hook run after each command is executed.
11972 If an unhandled error happens in running this hook,
11973 the function in which the error occurred is unconditionally removed, since
11974 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11975 Vpost_command_hook = Qnil;
11977 #if 0
11978 DEFVAR_LISP ("echo-area-clear-hook", ...,
11979 doc: /* Normal hook run when clearing the echo area. */);
11980 #endif
11981 Qecho_area_clear_hook = intern_c_string ("echo-area-clear-hook");
11982 staticpro (&Qecho_area_clear_hook);
11983 Fset (Qecho_area_clear_hook, Qnil);
11985 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag,
11986 doc: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11987 Vlucid_menu_bar_dirty_flag = Qnil;
11989 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items,
11990 doc: /* List of menu bar items to move to the end of the menu bar.
11991 The elements of the list are event types that may have menu bar bindings. */);
11992 Vmenu_bar_final_items = Qnil;
11994 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression,
11995 doc: /* Expression evaluating to the image spec for a tool-bar separator.
11996 This is used internally by graphical displays that do not render
11997 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11998 Vtool_bar_separator_image_expression = Qnil;
12000 DEFVAR_KBOARD ("overriding-terminal-local-map",
12001 Voverriding_terminal_local_map,
12002 doc: /* Per-terminal keymap that overrides all other local keymaps.
12003 If this variable is non-nil, it is used as a keymap instead of the
12004 buffer's local map, and the minor mode keymaps and text property keymaps.
12005 It also replaces `overriding-local-map'.
12007 This variable is intended to let commands such as `universal-argument'
12008 set up a different keymap for reading the next command.
12010 `overriding-terminal-local-map' has a separate binding for each
12011 terminal device.
12012 See Info node `(elisp)Multiple Terminals'. */);
12014 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map,
12015 doc: /* Keymap that overrides all other local keymaps.
12016 If this variable is non-nil, it is used as a keymap--replacing the
12017 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12018 Voverriding_local_map = Qnil;
12020 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag,
12021 doc: /* Non-nil means `overriding-local-map' applies to the menu bar.
12022 Otherwise, the menu bar continues to reflect the buffer's local map
12023 and the minor mode maps regardless of `overriding-local-map'. */);
12024 Voverriding_local_map_menu_flag = Qnil;
12026 DEFVAR_LISP ("special-event-map", Vspecial_event_map,
12027 doc: /* Keymap defining bindings for special events to execute at low level. */);
12028 Vspecial_event_map = Fcons (intern_c_string ("keymap"), Qnil);
12030 DEFVAR_LISP ("track-mouse", do_mouse_tracking,
12031 doc: /* *Non-nil means generate motion events for mouse motion. */);
12033 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist,
12034 doc: /* Alist of system-specific X windows key symbols.
12035 Each element should have the form (N . SYMBOL) where N is the
12036 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12037 and SYMBOL is its name.
12039 `system-key-alist' has a separate binding for each terminal device.
12040 See Info node `(elisp)Multiple Terminals'. */);
12042 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map,
12043 doc: /* Keymap that translates key sequences to key sequences during input.
12044 This is used mainly for mapping key sequences into some preferred
12045 key events (symbols).
12047 The `read-key-sequence' function replaces any subsequence bound by
12048 `local-function-key-map' with its binding. More precisely, when the
12049 active keymaps have no binding for the current key sequence but
12050 `local-function-key-map' binds a suffix of the sequence to a vector or
12051 string, `read-key-sequence' replaces the matching suffix with its
12052 binding, and continues with the new sequence.
12054 If the binding is a function, it is called with one argument (the prompt)
12055 and its return value (a key sequence) is used.
12057 The events that come from bindings in `local-function-key-map' are not
12058 themselves looked up in `local-function-key-map'.
12060 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12061 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12062 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12063 typing `ESC O P x' would return [f1 x].
12065 `local-function-key-map' has a separate binding for each terminal
12066 device. See Info node `(elisp)Multiple Terminals'. If you need to
12067 define a binding on all terminals, change `function-key-map'
12068 instead. Initially, `local-function-key-map' is an empty keymap that
12069 has `function-key-map' as its parent on all terminal devices. */);
12071 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map,
12072 doc: /* Keymap that decodes input escape sequences.
12073 This is used mainly for mapping ASCII function key sequences into
12074 real Emacs function key events (symbols).
12076 The `read-key-sequence' function replaces any subsequence bound by
12077 `input-decode-map' with its binding. Contrary to `function-key-map',
12078 this map applies its rebinding regardless of the presence of an ordinary
12079 binding. So it is more like `key-translation-map' except that it applies
12080 before `function-key-map' rather than after.
12082 If the binding is a function, it is called with one argument (the prompt)
12083 and its return value (a key sequence) is used.
12085 The events that come from bindings in `input-decode-map' are not
12086 themselves looked up in `input-decode-map'.
12088 This variable is keyboard-local. */);
12090 DEFVAR_LISP ("function-key-map", Vfunction_key_map,
12091 doc: /* The parent keymap of all `local-function-key-map' instances.
12092 Function key definitions that apply to all terminal devices should go
12093 here. If a mapping is defined in both the current
12094 `local-function-key-map' binding and this variable, then the local
12095 definition will take precendence. */);
12096 Vfunction_key_map = Fmake_sparse_keymap (Qnil);
12098 DEFVAR_LISP ("key-translation-map", Vkey_translation_map,
12099 doc: /* Keymap of key translations that can override keymaps.
12100 This keymap works like `function-key-map', but comes after that,
12101 and its non-prefix bindings override ordinary bindings.
12102 Another difference is that it is global rather than keyboard-local. */);
12103 Vkey_translation_map = Fmake_sparse_keymap (Qnil);
12105 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list,
12106 doc: /* List of deferred actions to be performed at a later time.
12107 The precise format isn't relevant here; we just check whether it is nil. */);
12108 Vdeferred_action_list = Qnil;
12110 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function,
12111 doc: /* Function to call to handle deferred actions, after each command.
12112 This function is called with no arguments after each command
12113 whenever `deferred-action-list' is non-nil. */);
12114 Vdeferred_action_function = Qnil;
12116 DEFVAR_LISP ("suggest-key-bindings", Vsuggest_key_bindings,
12117 doc: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12118 The value can be a length of time to show the message for.
12119 If the value is non-nil and not a number, we wait 2 seconds. */);
12120 Vsuggest_key_bindings = Qt;
12122 DEFVAR_LISP ("timer-list", Vtimer_list,
12123 doc: /* List of active absolute time timers in order of increasing time. */);
12124 Vtimer_list = Qnil;
12126 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list,
12127 doc: /* List of active idle-time timers in order of increasing time. */);
12128 Vtimer_idle_list = Qnil;
12130 DEFVAR_LISP ("input-method-function", Vinput_method_function,
12131 doc: /* If non-nil, the function that implements the current input method.
12132 It's called with one argument, a printing character that was just read.
12133 \(That means a character with code 040...0176.)
12134 Typically this function uses `read-event' to read additional events.
12135 When it does so, it should first bind `input-method-function' to nil
12136 so it will not be called recursively.
12138 The function should return a list of zero or more events
12139 to be used as input. If it wants to put back some events
12140 to be reconsidered, separately, by the input method,
12141 it can add them to the beginning of `unread-command-events'.
12143 The input method function can find in `input-method-previous-message'
12144 the previous echo area message.
12146 The input method function should refer to the variables
12147 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12148 for guidance on what to do. */);
12149 Vinput_method_function = Qnil;
12151 DEFVAR_LISP ("input-method-previous-message",
12152 Vinput_method_previous_message,
12153 doc: /* When `input-method-function' is called, hold the previous echo area message.
12154 This variable exists because `read-event' clears the echo area
12155 before running the input method. It is nil if there was no message. */);
12156 Vinput_method_previous_message = Qnil;
12158 DEFVAR_LISP ("show-help-function", Vshow_help_function,
12159 doc: /* If non-nil, the function that implements the display of help.
12160 It's called with one argument, the help string to display. */);
12161 Vshow_help_function = Qnil;
12163 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment,
12164 doc: /* If non-nil, suppress point adjustment after executing a command.
12166 After a command is executed, if point is moved into a region that has
12167 special properties (e.g. composition, display), we adjust point to
12168 the boundary of the region. But, when a command sets this variable to
12169 non-nil, we suppress the point adjustment.
12171 This variable is set to nil before reading a command, and is checked
12172 just after executing the command. */);
12173 Vdisable_point_adjustment = Qnil;
12175 DEFVAR_LISP ("global-disable-point-adjustment",
12176 Vglobal_disable_point_adjustment,
12177 doc: /* *If non-nil, always suppress point adjustment.
12179 The default value is nil, in which case, point adjustment are
12180 suppressed only after special commands that set
12181 `disable-point-adjustment' (which see) to non-nil. */);
12182 Vglobal_disable_point_adjustment = Qnil;
12184 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout,
12185 doc: /* *How long to display an echo-area message when the minibuffer is active.
12186 If the value is not a number, such messages don't time out. */);
12187 Vminibuffer_message_timeout = make_number (2);
12189 DEFVAR_LISP ("throw-on-input", Vthrow_on_input,
12190 doc: /* If non-nil, any keyboard input throws to this symbol.
12191 The value of that variable is passed to `quit-flag' and later causes a
12192 peculiar kind of quitting. */);
12193 Vthrow_on_input = Qnil;
12195 DEFVAR_LISP ("command-error-function", Vcommand_error_function,
12196 doc: /* If non-nil, function to output error messages.
12197 The arguments are the error data, a list of the form
12198 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12199 such as just as `condition-case' would bind its variable to,
12200 the context (a string which normally goes at the start of the message),
12201 and the Lisp function within which the error was signaled. */);
12202 Vcommand_error_function = Qnil;
12204 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12205 Venable_disabled_menus_and_buttons,
12206 doc: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12208 Help functions bind this to allow help on disabled menu items
12209 and tool-bar buttons. */);
12210 Venable_disabled_menus_and_buttons = Qnil;
12212 DEFVAR_LISP ("select-active-regions",
12213 Vselect_active_regions,
12214 doc: /* If non-nil, an active region automatically sets the primary selection.
12215 If the value is `only', only temporarily active regions (usually made
12216 by mouse-dragging or shift-selection) set the window selection.
12218 This takes effect only when Transient Mark mode is enabled. */);
12219 Vselect_active_regions = Qt;
12221 DEFVAR_LISP ("saved-region-selection",
12222 Vsaved_region_selection,
12223 doc: /* Contents of active region prior to buffer modification.
12224 If `select-active-regions' is non-nil, Emacs sets this to the
12225 text in the region before modifying the buffer. The next
12226 `deactivate-mark' call uses this to set the window selection. */);
12227 Vsaved_region_selection = Qnil;
12229 /* Create the initial keyboard. */
12230 initial_kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
12231 init_kboard (initial_kboard);
12232 /* Vwindow_system is left at t for now. */
12233 initial_kboard->next_kboard = all_kboards;
12234 all_kboards = initial_kboard;
12237 void
12238 keys_of_keyboard (void)
12240 initial_define_key (global_map, Ctl ('Z'), "suspend-emacs");
12241 initial_define_key (control_x_map, Ctl ('Z'), "suspend-emacs");
12242 initial_define_key (meta_map, Ctl ('C'), "exit-recursive-edit");
12243 initial_define_key (global_map, Ctl (']'), "abort-recursive-edit");
12244 initial_define_key (meta_map, 'x', "execute-extended-command");
12246 initial_define_lispy_key (Vspecial_event_map, "delete-frame",
12247 "handle-delete-frame");
12248 initial_define_lispy_key (Vspecial_event_map, "ns-put-working-text",
12249 "ns-put-working-text");
12250 initial_define_lispy_key (Vspecial_event_map, "ns-unput-working-text",
12251 "ns-unput-working-text");
12252 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12253 current-prefix-arg, as is done in `handle-switch-frame'.
12254 But `handle-switch-frame is not run from the special-map.
12255 Commands from that map are run in a special way that automatically
12256 preserves the prefix-arg. Restoring the prefix arg here is not just
12257 redundant but harmful:
12258 - C-u C-x v =
12259 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12260 - after the first prompt, the exit-minibuffer-hook is run which may
12261 iconify a frame and thus push a `iconify-frame' event.
12262 - after running exit-minibuffer-hook, current-prefix-arg is
12263 restored to the non-nil value it had before the prompt.
12264 - we enter the second prompt.
12265 current-prefix-arg is non-nil, prefix-arg is nil.
12266 - before running the first real event, we run the special iconify-frame
12267 event, but we pass the `special' arg to execute-command so
12268 current-prefix-arg and prefix-arg are left untouched.
12269 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12270 - the next key event will have a spuriously non-nil current-prefix-arg. */
12271 initial_define_lispy_key (Vspecial_event_map, "iconify-frame",
12272 "ignore");
12273 initial_define_lispy_key (Vspecial_event_map, "make-frame-visible",
12274 "ignore");
12275 /* Handling it at such a low-level causes read_key_sequence to get
12276 * confused because it doesn't realize that the current_buffer was
12277 * changed by read_char.
12279 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12280 * "handle-select-window"); */
12281 initial_define_lispy_key (Vspecial_event_map, "save-session",
12282 "handle-save-session");
12284 #ifdef HAVE_DBUS
12285 /* Define a special event which is raised for dbus callback
12286 functions. */
12287 initial_define_lispy_key (Vspecial_event_map, "dbus-event",
12288 "dbus-handle-event");
12289 #endif
12291 initial_define_lispy_key (Vspecial_event_map, "config-changed-event",
12292 "ignore");
12295 /* Mark the pointers in the kboard objects.
12296 Called by the Fgarbage_collector. */
12297 void
12298 mark_kboards (void)
12300 KBOARD *kb;
12301 Lisp_Object *p;
12302 for (kb = all_kboards; kb; kb = kb->next_kboard)
12304 if (kb->kbd_macro_buffer)
12305 for (p = kb->kbd_macro_buffer; p < kb->kbd_macro_ptr; p++)
12306 mark_object (*p);
12307 mark_object (KVAR (kb, Voverriding_terminal_local_map));
12308 mark_object (KVAR (kb, Vlast_command));
12309 mark_object (KVAR (kb, Vreal_last_command));
12310 mark_object (KVAR (kb, Vkeyboard_translate_table));
12311 mark_object (KVAR (kb, Vlast_repeatable_command));
12312 mark_object (KVAR (kb, Vprefix_arg));
12313 mark_object (KVAR (kb, Vlast_prefix_arg));
12314 mark_object (KVAR (kb, kbd_queue));
12315 mark_object (KVAR (kb, defining_kbd_macro));
12316 mark_object (KVAR (kb, Vlast_kbd_macro));
12317 mark_object (KVAR (kb, Vsystem_key_alist));
12318 mark_object (KVAR (kb, system_key_syms));
12319 mark_object (KVAR (kb, Vwindow_system));
12320 mark_object (KVAR (kb, Vinput_decode_map));
12321 mark_object (KVAR (kb, Vlocal_function_key_map));
12322 mark_object (KVAR (kb, Vdefault_minibuffer_frame));
12323 mark_object (KVAR (kb, echo_string));
12326 struct input_event *event;
12327 for (event = kbd_fetch_ptr; event != kbd_store_ptr; event++)
12329 if (event == kbd_buffer + KBD_BUFFER_SIZE)
12330 event = kbd_buffer;
12331 if (event->kind != SELECTION_REQUEST_EVENT
12332 && event->kind != SELECTION_CLEAR_EVENT)
12334 mark_object (event->x);
12335 mark_object (event->y);
12337 mark_object (event->frame_or_window);
12338 mark_object (event->arg);