Merge from emacs-24; up to 2012-04-25T15:23:19Z!sdl.web@gmail.com
[emacs.git] / src / keyboard.c
blob093e33ec67c4dea3c18d3c9d9309f693ee32a45e
1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2012 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_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;
100 /* Nonzero in the single-kboard state, 0 in the any-kboard state. */
101 static int single_kboard;
103 /* Non-nil disable property on a command means
104 do not execute it; call disabled-command-function's value instead. */
105 Lisp_Object Qdisabled;
106 static Lisp_Object Qdisabled_command_function;
108 #define NUM_RECENT_KEYS (300)
110 /* Index for storing next element into recent_keys. */
111 static int recent_keys_index;
113 /* Total number of elements stored into recent_keys. */
114 static int total_keys;
116 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
117 static Lisp_Object recent_keys;
119 /* Vector holding the key sequence that invoked the current command.
120 It is reused for each command, and it may be longer than the current
121 sequence; this_command_key_count indicates how many elements
122 actually mean something.
123 It's easier to staticpro a single Lisp_Object than an array. */
124 Lisp_Object this_command_keys;
125 ptrdiff_t this_command_key_count;
127 /* 1 after calling Freset_this_command_lengths.
128 Usually it is 0. */
129 static int this_command_key_count_reset;
131 /* This vector is used as a buffer to record the events that were actually read
132 by read_key_sequence. */
133 static Lisp_Object raw_keybuf;
134 static int raw_keybuf_count;
136 #define GROW_RAW_KEYBUF \
137 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
138 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
140 /* Number of elements of this_command_keys
141 that precede this key sequence. */
142 static ptrdiff_t this_single_command_key_start;
144 /* Record values of this_command_key_count and echo_length ()
145 before this command was read. */
146 static ptrdiff_t before_command_key_count;
147 static ptrdiff_t before_command_echo_length;
149 /* For longjmp to where kbd input is being done. */
151 static jmp_buf getcjmp;
153 /* True while doing kbd input. */
154 int waiting_for_input;
156 /* True while displaying for echoing. Delays C-g throwing. */
158 static int echoing;
160 /* Non-null means we can start echoing at the next input pause even
161 though there is something in the echo area. */
163 static struct kboard *ok_to_echo_at_next_pause;
165 /* The kboard last echoing, or null for none. Reset to 0 in
166 cancel_echoing. If non-null, and a current echo area message
167 exists, and echo_message_buffer is eq to the current message
168 buffer, we know that the message comes from echo_kboard. */
170 struct kboard *echo_kboard;
172 /* The buffer used for echoing. Set in echo_now, reset in
173 cancel_echoing. */
175 Lisp_Object echo_message_buffer;
177 /* Nonzero means C-g should cause immediate error-signal. */
178 int immediate_quit;
180 /* Character that causes a quit. Normally C-g.
182 If we are running on an ordinary terminal, this must be an ordinary
183 ASCII char, since we want to make it our interrupt character.
185 If we are not running on an ordinary terminal, it still needs to be
186 an ordinary ASCII char. This character needs to be recognized in
187 the input interrupt handler. At this point, the keystroke is
188 represented as a struct input_event, while the desired quit
189 character is specified as a lispy event. The mapping from struct
190 input_events to lispy events cannot run in an interrupt handler,
191 and the reverse mapping is difficult for anything but ASCII
192 keystrokes.
194 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
195 ASCII character. */
196 int quit_char;
198 /* Current depth in recursive edits. */
199 EMACS_INT command_loop_level;
201 /* If not Qnil, this is a switch-frame event which we decided to put
202 off until the end of a key sequence. This should be read as the
203 next command input, after any unread_command_events.
205 read_key_sequence uses this to delay switch-frame events until the
206 end of the key sequence; Fread_char uses it to put off switch-frame
207 events until a non-ASCII event is acceptable as input. */
208 Lisp_Object unread_switch_frame;
210 /* Last size recorded for a current buffer which is not a minibuffer. */
211 static ptrdiff_t last_non_minibuf_size;
213 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
214 uintmax_t num_input_events;
216 /* Value of num_nonmacro_input_events as of last auto save. */
218 static EMACS_INT last_auto_save;
220 /* The value of point when the last command was started. */
221 static ptrdiff_t last_point_position;
223 /* The buffer that was current when the last command was started. */
224 static Lisp_Object last_point_position_buffer;
226 /* The window that was selected when the last command was started. */
227 static Lisp_Object last_point_position_window;
229 /* The frame in which the last input event occurred, or Qmacro if the
230 last event came from a macro. We use this to determine when to
231 generate switch-frame events. This may be cleared by functions
232 like Fselect_frame, to make sure that a switch-frame event is
233 generated by the next character. */
234 Lisp_Object internal_last_event_frame;
236 /* The timestamp of the last input event we received from the X server.
237 X Windows wants this for selection ownership. */
238 Time last_event_timestamp;
240 static Lisp_Object Qx_set_selection, Qhandle_switch_frame;
241 static Lisp_Object Qhandle_select_window;
242 Lisp_Object QPRIMARY;
244 static Lisp_Object Qself_insert_command;
245 static Lisp_Object Qforward_char;
246 static Lisp_Object Qbackward_char;
247 Lisp_Object Qundefined;
248 static Lisp_Object Qtimer_event_handler;
250 /* read_key_sequence stores here the command definition of the
251 key sequence that it reads. */
252 static Lisp_Object read_key_sequence_cmd;
253 static Lisp_Object read_key_sequence_remapped;
255 static Lisp_Object Qinput_method_function;
257 static Lisp_Object Qdeactivate_mark;
259 Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;
261 static Lisp_Object Qecho_area_clear_hook;
263 /* Hooks to run before and after each command. */
264 static Lisp_Object Qpre_command_hook;
265 static Lisp_Object Qpost_command_hook;
267 static Lisp_Object Qdeferred_action_function;
269 static Lisp_Object Qdelayed_warnings_hook;
271 static Lisp_Object Qinput_method_exit_on_first_char;
272 static Lisp_Object Qinput_method_use_echo_area;
274 static Lisp_Object Qhelp_form_show;
276 /* File in which we write all commands we read. */
277 static FILE *dribble;
279 /* Nonzero if input is available. */
280 int input_pending;
282 /* Circular buffer for pre-read keyboard input. */
284 static struct input_event kbd_buffer[KBD_BUFFER_SIZE];
286 /* Pointer to next available character in kbd_buffer.
287 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
288 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
289 next available char is in kbd_buffer[0]. */
290 static struct input_event *kbd_fetch_ptr;
292 /* Pointer to next place to store character in kbd_buffer. This
293 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
294 character should go in kbd_buffer[0]. */
295 static struct input_event * volatile kbd_store_ptr;
297 /* The above pair of variables forms a "queue empty" flag. When we
298 enqueue a non-hook event, we increment kbd_store_ptr. When we
299 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
300 there is input available if the two pointers are not equal.
302 Why not just have a flag set and cleared by the enqueuing and
303 dequeuing functions? Such a flag could be screwed up by interrupts
304 at inopportune times. */
306 /* Symbols to head events. */
307 static Lisp_Object Qmouse_movement;
308 static Lisp_Object Qscroll_bar_movement;
309 Lisp_Object Qswitch_frame;
310 static Lisp_Object Qdelete_frame;
311 static Lisp_Object Qiconify_frame;
312 static Lisp_Object Qmake_frame_visible;
313 static Lisp_Object Qselect_window;
314 Lisp_Object Qhelp_echo;
316 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
317 static Lisp_Object Qmouse_fixup_help_message;
318 #endif
320 /* Symbols to denote kinds of events. */
321 static Lisp_Object Qfunction_key;
322 Lisp_Object Qmouse_click;
323 #if defined (WINDOWSNT)
324 Lisp_Object Qlanguage_change;
325 #endif
326 static Lisp_Object Qdrag_n_drop;
327 static Lisp_Object Qsave_session;
328 #ifdef HAVE_DBUS
329 static Lisp_Object Qdbus_event;
330 #endif
331 static Lisp_Object Qconfig_changed_event;
333 /* Lisp_Object Qmouse_movement; - also an event header */
335 /* Properties of event headers. */
336 Lisp_Object Qevent_kind;
337 static Lisp_Object Qevent_symbol_elements;
339 /* Menu and tool bar item parts. */
340 static Lisp_Object Qmenu_enable;
341 static Lisp_Object QCenable, QCvisible, QChelp, QCkeys, QCkey_sequence;
342 Lisp_Object QCfilter;
344 /* Non-nil disable property on a command means
345 do not execute it; call disabled-command-function's value instead. */
346 Lisp_Object QCtoggle, QCradio;
347 static Lisp_Object QCbutton, QClabel;
349 static Lisp_Object QCvert_only;
351 /* An event header symbol HEAD may have a property named
352 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
353 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
354 mask of modifiers applied to it. If present, this is used to help
355 speed up parse_modifiers. */
356 Lisp_Object Qevent_symbol_element_mask;
358 /* An unmodified event header BASE may have a property named
359 Qmodifier_cache, which is an alist mapping modifier masks onto
360 modified versions of BASE. If present, this helps speed up
361 apply_modifiers. */
362 static Lisp_Object Qmodifier_cache;
364 /* Symbols to use for parts of windows. */
365 Lisp_Object Qmode_line;
366 Lisp_Object Qvertical_line;
367 static Lisp_Object Qvertical_scroll_bar;
368 Lisp_Object Qmenu_bar;
370 static Lisp_Object recursive_edit_unwind (Lisp_Object buffer);
371 static Lisp_Object command_loop (void);
372 static Lisp_Object Qextended_command_history;
373 EMACS_TIME timer_check (void);
375 static void record_menu_key (Lisp_Object c);
376 static void echo_now (void);
377 static ptrdiff_t echo_length (void);
379 static Lisp_Object Qpolling_period;
381 /* Incremented whenever a timer is run. */
382 int timers_run;
384 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
385 happens. */
386 EMACS_TIME *input_available_clear_time;
388 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
389 Default is 1 if INTERRUPT_INPUT is defined. */
390 int interrupt_input;
392 /* Nonzero while interrupts are temporarily deferred during redisplay. */
393 int interrupts_deferred;
395 /* Allow m- file to inhibit use of FIONREAD. */
396 #ifdef BROKEN_FIONREAD
397 #undef FIONREAD
398 #endif
400 /* We are unable to use interrupts if FIONREAD is not available,
401 so flush SIGIO so we won't try. */
402 #if !defined (FIONREAD)
403 #ifdef SIGIO
404 #undef SIGIO
405 #endif
406 #endif
408 /* If we support a window system, turn on the code to poll periodically
409 to detect C-g. It isn't actually used when doing interrupt input. */
410 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_ASYNC_EVENTS)
411 #define POLL_FOR_INPUT
412 #endif
414 /* The time when Emacs started being idle. */
416 static EMACS_TIME timer_idleness_start_time;
418 /* After Emacs stops being idle, this saves the last value
419 of timer_idleness_start_time from when it was idle. */
421 static EMACS_TIME timer_last_idleness_start_time;
424 /* Global variable declarations. */
426 /* Flags for readable_events. */
427 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
428 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
429 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
431 /* Function for init_keyboard to call with no args (if nonzero). */
432 static void (*keyboard_init_hook) (void);
434 static int read_avail_input (int);
435 static void get_input_pending (int *, int);
436 static int readable_events (int);
437 static Lisp_Object read_char_x_menu_prompt (ptrdiff_t, Lisp_Object *,
438 Lisp_Object, int *);
439 static Lisp_Object read_char_minibuf_menu_prompt (int, ptrdiff_t,
440 Lisp_Object *);
441 static Lisp_Object make_lispy_event (struct input_event *);
442 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
443 static Lisp_Object make_lispy_movement (struct frame *, Lisp_Object,
444 enum scroll_bar_part,
445 Lisp_Object, Lisp_Object,
446 Time);
447 #endif
448 static Lisp_Object modify_event_symbol (ptrdiff_t, int, Lisp_Object,
449 Lisp_Object, const char *const *,
450 Lisp_Object *, ptrdiff_t);
451 static Lisp_Object make_lispy_switch_frame (Lisp_Object);
452 static int help_char_p (Lisp_Object);
453 static void save_getcjmp (jmp_buf);
454 static void restore_getcjmp (jmp_buf);
455 static Lisp_Object apply_modifiers (int, Lisp_Object);
456 static void clear_event (struct input_event *);
457 static Lisp_Object restore_kboard_configuration (Lisp_Object);
458 static void interrupt_signal (int signalnum);
459 #ifdef SIGIO
460 static void input_available_signal (int signo);
461 #endif
462 static Lisp_Object (Fcommand_execute) (Lisp_Object, Lisp_Object, Lisp_Object,
463 Lisp_Object);
464 static void handle_interrupt (void);
465 static void quit_throw_to_read_char (int) NO_RETURN;
466 static void process_special_events (void);
467 static void timer_start_idle (void);
468 static void timer_stop_idle (void);
469 static void timer_resume_idle (void);
470 static void handle_user_signal (int);
471 static char *find_user_signal_name (int);
472 static int store_user_signal_events (void);
475 /* Add C to the echo string, if echoing is going on.
476 C can be a character, which is printed prettily ("M-C-x" and all that
477 jazz), or a symbol, whose name is printed. */
479 static void
480 echo_char (Lisp_Object c)
482 if (current_kboard->immediate_echo)
484 int size = KEY_DESCRIPTION_SIZE + 100;
485 char *buffer = (char *) alloca (size);
486 char *ptr = buffer;
487 Lisp_Object echo_string;
489 echo_string = KVAR (current_kboard, echo_string);
491 /* If someone has passed us a composite event, use its head symbol. */
492 c = EVENT_HEAD (c);
494 if (INTEGERP (c))
496 ptr = push_key_description (XINT (c), ptr, 1);
498 else if (SYMBOLP (c))
500 Lisp_Object name = SYMBOL_NAME (c);
501 int nbytes = SBYTES (name);
503 if (size - (ptr - buffer) < nbytes)
505 int offset = ptr - buffer;
506 size = max (2 * size, size + nbytes);
507 buffer = (char *) alloca (size);
508 ptr = buffer + offset;
511 ptr += copy_text (SDATA (name), (unsigned char *) ptr, nbytes,
512 STRING_MULTIBYTE (name), 1);
515 if ((NILP (echo_string) || SCHARS (echo_string) == 0)
516 && help_char_p (c))
518 const char *text = " (Type ? for further options)";
519 int len = strlen (text);
521 if (size - (ptr - buffer) < len)
523 int offset = ptr - buffer;
524 size += len;
525 buffer = (char *) alloca (size);
526 ptr = buffer + offset;
529 memcpy (ptr, text, len);
530 ptr += len;
533 /* Replace a dash from echo_dash with a space, otherwise
534 add a space at the end as a separator between keys. */
535 if (STRINGP (echo_string)
536 && SCHARS (echo_string) > 1)
538 Lisp_Object last_char, prev_char, idx;
540 idx = make_number (SCHARS (echo_string) - 2);
541 prev_char = Faref (echo_string, idx);
543 idx = make_number (SCHARS (echo_string) - 1);
544 last_char = Faref (echo_string, idx);
546 /* We test PREV_CHAR to make sure this isn't the echoing
547 of a minus-sign. */
548 if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
549 Faset (echo_string, idx, make_number (' '));
550 else
551 echo_string = concat2 (echo_string, build_string (" "));
553 else if (STRINGP (echo_string))
554 echo_string = concat2 (echo_string, build_string (" "));
556 KVAR (current_kboard, echo_string)
557 = concat2 (echo_string, make_string (buffer, ptr - buffer));
559 echo_now ();
563 /* Temporarily add a dash to the end of the echo string if it's not
564 empty, so that it serves as a mini-prompt for the very next character. */
566 static void
567 echo_dash (void)
569 /* Do nothing if not echoing at all. */
570 if (NILP (KVAR (current_kboard, echo_string)))
571 return;
573 if (this_command_key_count == 0)
574 return;
576 if (!current_kboard->immediate_echo
577 && SCHARS (KVAR (current_kboard, echo_string)) == 0)
578 return;
580 /* Do nothing if we just printed a prompt. */
581 if (current_kboard->echo_after_prompt
582 == SCHARS (KVAR (current_kboard, echo_string)))
583 return;
585 /* Do nothing if we have already put a dash at the end. */
586 if (SCHARS (KVAR (current_kboard, echo_string)) > 1)
588 Lisp_Object last_char, prev_char, idx;
590 idx = make_number (SCHARS (KVAR (current_kboard, echo_string)) - 2);
591 prev_char = Faref (KVAR (current_kboard, echo_string), idx);
593 idx = make_number (SCHARS (KVAR (current_kboard, echo_string)) - 1);
594 last_char = Faref (KVAR (current_kboard, echo_string), idx);
596 if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
597 return;
600 /* Put a dash at the end of the buffer temporarily,
601 but make it go away when the next character is added. */
602 KVAR (current_kboard, echo_string) = concat2 (KVAR (current_kboard, echo_string),
603 build_string ("-"));
604 echo_now ();
607 /* Display the current echo string, and begin echoing if not already
608 doing so. */
610 static void
611 echo_now (void)
613 if (!current_kboard->immediate_echo)
615 ptrdiff_t i;
616 current_kboard->immediate_echo = 1;
618 for (i = 0; i < this_command_key_count; i++)
620 Lisp_Object c;
622 /* Set before_command_echo_length to the value that would
623 have been saved before the start of this subcommand in
624 command_loop_1, if we had already been echoing then. */
625 if (i == this_single_command_key_start)
626 before_command_echo_length = echo_length ();
628 c = XVECTOR (this_command_keys)->contents[i];
629 if (! (EVENT_HAS_PARAMETERS (c)
630 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
631 echo_char (c);
634 /* Set before_command_echo_length to the value that would
635 have been saved before the start of this subcommand in
636 command_loop_1, if we had already been echoing then. */
637 if (this_command_key_count == this_single_command_key_start)
638 before_command_echo_length = echo_length ();
640 /* Put a dash at the end to invite the user to type more. */
641 echo_dash ();
644 echoing = 1;
645 message3_nolog (KVAR (current_kboard, echo_string),
646 SBYTES (KVAR (current_kboard, echo_string)),
647 STRING_MULTIBYTE (KVAR (current_kboard, echo_string)));
648 echoing = 0;
650 /* Record in what buffer we echoed, and from which kboard. */
651 echo_message_buffer = echo_area_buffer[0];
652 echo_kboard = current_kboard;
654 if (waiting_for_input && !NILP (Vquit_flag))
655 quit_throw_to_read_char (0);
658 /* Turn off echoing, for the start of a new command. */
660 void
661 cancel_echoing (void)
663 current_kboard->immediate_echo = 0;
664 current_kboard->echo_after_prompt = -1;
665 KVAR (current_kboard, echo_string) = Qnil;
666 ok_to_echo_at_next_pause = NULL;
667 echo_kboard = NULL;
668 echo_message_buffer = Qnil;
671 /* Return the length of the current echo string. */
673 static ptrdiff_t
674 echo_length (void)
676 return (STRINGP (KVAR (current_kboard, echo_string))
677 ? SCHARS (KVAR (current_kboard, echo_string))
678 : 0);
681 /* Truncate the current echo message to its first LEN chars.
682 This and echo_char get used by read_key_sequence when the user
683 switches frames while entering a key sequence. */
685 static void
686 echo_truncate (ptrdiff_t nchars)
688 if (STRINGP (KVAR (current_kboard, echo_string)))
689 KVAR (current_kboard, echo_string)
690 = Fsubstring (KVAR (current_kboard, echo_string),
691 make_number (0), make_number (nchars));
692 truncate_echo_area (nchars);
696 /* Functions for manipulating this_command_keys. */
697 static void
698 add_command_key (Lisp_Object key)
700 #if 0 /* Not needed after we made Freset_this_command_lengths
701 do the job immediately. */
702 /* If reset-this-command-length was called recently, obey it now.
703 See the doc string of that function for an explanation of why. */
704 if (before_command_restore_flag)
706 this_command_key_count = before_command_key_count_1;
707 if (this_command_key_count < this_single_command_key_start)
708 this_single_command_key_start = this_command_key_count;
709 echo_truncate (before_command_echo_length_1);
710 before_command_restore_flag = 0;
712 #endif
714 if (this_command_key_count >= ASIZE (this_command_keys))
715 this_command_keys = larger_vector (this_command_keys, 1, -1);
717 ASET (this_command_keys, this_command_key_count, key);
718 ++this_command_key_count;
722 Lisp_Object
723 recursive_edit_1 (void)
725 ptrdiff_t count = SPECPDL_INDEX ();
726 Lisp_Object val;
728 if (command_loop_level > 0)
730 specbind (Qstandard_output, Qt);
731 specbind (Qstandard_input, Qt);
734 #ifdef HAVE_WINDOW_SYSTEM
735 /* The command loop has started an hourglass timer, so we have to
736 cancel it here, otherwise it will fire because the recursive edit
737 can take some time. Do not check for display_hourglass_p here,
738 because it could already be nil. */
739 cancel_hourglass ();
740 #endif
742 /* This function may have been called from a debugger called from
743 within redisplay, for instance by Edebugging a function called
744 from fontification-functions. We want to allow redisplay in
745 the debugging session.
747 The recursive edit is left with a `(throw exit ...)'. The `exit'
748 tag is not caught anywhere in redisplay, i.e. when we leave the
749 recursive edit, the original redisplay leading to the recursive
750 edit will be unwound. The outcome should therefore be safe. */
751 specbind (Qinhibit_redisplay, Qnil);
752 redisplaying_p = 0;
754 val = command_loop ();
755 if (EQ (val, Qt))
756 Fsignal (Qquit, Qnil);
757 /* Handle throw from read_minibuf when using minibuffer
758 while it's active but we're in another window. */
759 if (STRINGP (val))
760 xsignal1 (Qerror, val);
762 return unbind_to (count, Qnil);
765 /* When an auto-save happens, record the "time", and don't do again soon. */
767 void
768 record_auto_save (void)
770 last_auto_save = num_nonmacro_input_events;
773 /* Make an auto save happen as soon as possible at command level. */
775 #ifdef SIGDANGER
776 void
777 force_auto_save_soon (void)
779 last_auto_save = - auto_save_interval - 1;
781 record_asynch_buffer_change ();
783 #endif
785 DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
786 doc: /* Invoke the editor command loop recursively.
787 To get out of the recursive edit, a command can do `(throw 'exit nil)';
788 that tells this function to return.
789 Alternatively, `(throw 'exit t)' makes this function signal an error.
790 This function is called by the editor initialization to begin editing. */)
791 (void)
793 ptrdiff_t count = SPECPDL_INDEX ();
794 Lisp_Object buffer;
796 /* If we enter while input is blocked, don't lock up here.
797 This may happen through the debugger during redisplay. */
798 if (INPUT_BLOCKED_P)
799 return Qnil;
801 command_loop_level++;
802 update_mode_lines = 1;
804 if (command_loop_level
805 && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
806 buffer = Fcurrent_buffer ();
807 else
808 buffer = Qnil;
810 /* If we leave recursive_edit_1 below with a `throw' for instance,
811 like it is done in the splash screen display, we have to
812 make sure that we restore single_kboard as command_loop_1
813 would have done if it were left normally. */
814 if (command_loop_level > 0)
815 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
816 record_unwind_protect (recursive_edit_unwind, buffer);
818 recursive_edit_1 ();
819 return unbind_to (count, Qnil);
822 Lisp_Object
823 recursive_edit_unwind (Lisp_Object buffer)
825 if (BUFFERP (buffer))
826 Fset_buffer (buffer);
828 command_loop_level--;
829 update_mode_lines = 1;
830 return Qnil;
834 #if 0 /* These two functions are now replaced with
835 temporarily_switch_to_single_kboard. */
836 static void
837 any_kboard_state ()
839 #if 0 /* Theory: if there's anything in Vunread_command_events,
840 it will right away be read by read_key_sequence,
841 and then if we do switch KBOARDS, it will go into the side
842 queue then. So we don't need to do anything special here -- rms. */
843 if (CONSP (Vunread_command_events))
845 current_kboard->kbd_queue
846 = nconc2 (Vunread_command_events, current_kboard->kbd_queue);
847 current_kboard->kbd_queue_has_data = 1;
849 Vunread_command_events = Qnil;
850 #endif
851 single_kboard = 0;
854 /* Switch to the single-kboard state, making current_kboard
855 the only KBOARD from which further input is accepted. */
857 void
858 single_kboard_state ()
860 single_kboard = 1;
862 #endif
864 /* If we're in single_kboard state for kboard KBOARD,
865 get out of it. */
867 void
868 not_single_kboard_state (KBOARD *kboard)
870 if (kboard == current_kboard)
871 single_kboard = 0;
874 /* Maintain a stack of kboards, so other parts of Emacs
875 can switch temporarily to the kboard of a given frame
876 and then revert to the previous status. */
878 struct kboard_stack
880 KBOARD *kboard;
881 struct kboard_stack *next;
884 static struct kboard_stack *kboard_stack;
886 void
887 push_kboard (struct kboard *k)
889 struct kboard_stack *p
890 = (struct kboard_stack *) xmalloc (sizeof (struct kboard_stack));
892 p->next = kboard_stack;
893 p->kboard = current_kboard;
894 kboard_stack = p;
896 current_kboard = k;
899 void
900 pop_kboard (void)
902 struct terminal *t;
903 struct kboard_stack *p = kboard_stack;
904 int found = 0;
905 for (t = terminal_list; t; t = t->next_terminal)
907 if (t->kboard == p->kboard)
909 current_kboard = p->kboard;
910 found = 1;
911 break;
914 if (!found)
916 /* The terminal we remembered has been deleted. */
917 current_kboard = FRAME_KBOARD (SELECTED_FRAME ());
918 single_kboard = 0;
920 kboard_stack = p->next;
921 xfree (p);
924 /* Switch to single_kboard mode, making current_kboard the only KBOARD
925 from which further input is accepted. If F is non-nil, set its
926 KBOARD as the current keyboard.
928 This function uses record_unwind_protect to return to the previous
929 state later.
931 If Emacs is already in single_kboard mode, and F's keyboard is
932 locked, then this function will throw an error. */
934 void
935 temporarily_switch_to_single_kboard (struct frame *f)
937 int was_locked = single_kboard;
938 if (was_locked)
940 if (f != NULL && FRAME_KBOARD (f) != current_kboard)
941 /* We can not switch keyboards while in single_kboard mode.
942 In rare cases, Lisp code may call `recursive-edit' (or
943 `read-minibuffer' or `y-or-n-p') after it switched to a
944 locked frame. For example, this is likely to happen
945 when server.el connects to a new terminal while Emacs is in
946 single_kboard mode. It is best to throw an error instead
947 of presenting the user with a frozen screen. */
948 error ("Terminal %d is locked, cannot read from it",
949 FRAME_TERMINAL (f)->id);
950 else
951 /* This call is unnecessary, but helps
952 `restore_kboard_configuration' discover if somebody changed
953 `current_kboard' behind our back. */
954 push_kboard (current_kboard);
956 else if (f != NULL)
957 current_kboard = FRAME_KBOARD (f);
958 single_kboard = 1;
959 record_unwind_protect (restore_kboard_configuration,
960 (was_locked ? Qt : Qnil));
963 #if 0 /* This function is not needed anymore. */
964 void
965 record_single_kboard_state ()
967 if (single_kboard)
968 push_kboard (current_kboard);
969 record_unwind_protect (restore_kboard_configuration,
970 (single_kboard ? Qt : Qnil));
972 #endif
974 static Lisp_Object
975 restore_kboard_configuration (Lisp_Object was_locked)
977 if (NILP (was_locked))
978 single_kboard = 0;
979 else
981 struct kboard *prev = current_kboard;
982 single_kboard = 1;
983 pop_kboard ();
984 /* The pop should not change the kboard. */
985 if (single_kboard && current_kboard != prev)
986 abort ();
988 return Qnil;
992 /* Handle errors that are not handled at inner levels
993 by printing an error message and returning to the editor command loop. */
995 static Lisp_Object
996 cmd_error (Lisp_Object data)
998 Lisp_Object old_level, old_length;
999 char macroerror[sizeof "After..kbd macro iterations: "
1000 + INT_STRLEN_BOUND (EMACS_INT)];
1002 #ifdef HAVE_WINDOW_SYSTEM
1003 if (display_hourglass_p)
1004 cancel_hourglass ();
1005 #endif
1007 if (!NILP (executing_kbd_macro))
1009 if (executing_kbd_macro_iterations == 1)
1010 sprintf (macroerror, "After 1 kbd macro iteration: ");
1011 else
1012 sprintf (macroerror, "After %"pI"d kbd macro iterations: ",
1013 executing_kbd_macro_iterations);
1015 else
1016 *macroerror = 0;
1018 Vstandard_output = Qt;
1019 Vstandard_input = Qt;
1020 Vexecuting_kbd_macro = Qnil;
1021 executing_kbd_macro = Qnil;
1022 KVAR (current_kboard, Vprefix_arg) = Qnil;
1023 KVAR (current_kboard, Vlast_prefix_arg) = Qnil;
1024 cancel_echoing ();
1026 /* Avoid unquittable loop if data contains a circular list. */
1027 old_level = Vprint_level;
1028 old_length = Vprint_length;
1029 XSETFASTINT (Vprint_level, 10);
1030 XSETFASTINT (Vprint_length, 10);
1031 cmd_error_internal (data, macroerror);
1032 Vprint_level = old_level;
1033 Vprint_length = old_length;
1035 Vquit_flag = Qnil;
1037 Vinhibit_quit = Qnil;
1038 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1039 if (command_loop_level == 0 && minibuf_level == 0)
1040 any_kboard_state ();
1041 #endif
1043 return make_number (0);
1046 /* Take actions on handling an error. DATA is the data that describes
1047 the error.
1049 CONTEXT is a C-string containing ASCII characters only which
1050 describes the context in which the error happened. If we need to
1051 generalize CONTEXT to allow multibyte characters, make it a Lisp
1052 string. */
1054 void
1055 cmd_error_internal (Lisp_Object data, const char *context)
1057 struct frame *sf = SELECTED_FRAME ();
1059 /* The immediate context is not interesting for Quits,
1060 since they are asynchronous. */
1061 if (EQ (XCAR (data), Qquit))
1062 Vsignaling_function = Qnil;
1064 Vquit_flag = Qnil;
1065 Vinhibit_quit = Qt;
1067 /* Use user's specified output function if any. */
1068 if (!NILP (Vcommand_error_function))
1069 call3 (Vcommand_error_function, data,
1070 context ? build_string (context) : empty_unibyte_string,
1071 Vsignaling_function);
1072 /* If the window system or terminal frame hasn't been initialized
1073 yet, or we're not interactive, write the message to stderr and exit. */
1074 else if (!sf->glyphs_initialized_p
1075 /* The initial frame is a special non-displaying frame. It
1076 will be current in daemon mode when there are no frames
1077 to display, and in non-daemon mode before the real frame
1078 has finished initializing. If an error is thrown in the
1079 latter case while creating the frame, then the frame
1080 will never be displayed, so the safest thing to do is
1081 write to stderr and quit. In daemon mode, there are
1082 many other potential errors that do not prevent frames
1083 from being created, so continuing as normal is better in
1084 that case. */
1085 || (!IS_DAEMON && FRAME_INITIAL_P (sf))
1086 || noninteractive)
1088 print_error_message (data, Qexternal_debugging_output,
1089 context, Vsignaling_function);
1090 Fterpri (Qexternal_debugging_output);
1091 Fkill_emacs (make_number (-1));
1093 else
1095 clear_message (1, 0);
1096 Fdiscard_input ();
1097 message_log_maybe_newline ();
1098 bitch_at_user ();
1100 print_error_message (data, Qt, context, Vsignaling_function);
1103 Vsignaling_function = Qnil;
1106 Lisp_Object command_loop_1 (void);
1107 static Lisp_Object command_loop_2 (Lisp_Object);
1108 static Lisp_Object top_level_1 (Lisp_Object);
1110 /* Entry to editor-command-loop.
1111 This level has the catches for exiting/returning to editor command loop.
1112 It returns nil to exit recursive edit, t to abort it. */
1114 Lisp_Object
1115 command_loop (void)
1117 if (command_loop_level > 0 || minibuf_level > 0)
1119 Lisp_Object val;
1120 val = internal_catch (Qexit, command_loop_2, Qnil);
1121 executing_kbd_macro = Qnil;
1122 return val;
1124 else
1125 while (1)
1127 internal_catch (Qtop_level, top_level_1, Qnil);
1128 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1129 /* Reset single_kboard in case top-level set it while
1130 evaluating an -f option, or we are stuck there for some
1131 other reason. */
1132 any_kboard_state ();
1133 #endif
1134 internal_catch (Qtop_level, command_loop_2, Qnil);
1135 executing_kbd_macro = Qnil;
1137 /* End of file in -batch run causes exit here. */
1138 if (noninteractive)
1139 Fkill_emacs (Qt);
1143 /* Here we catch errors in execution of commands within the
1144 editing loop, and reenter the editing loop.
1145 When there is an error, cmd_error runs and returns a non-nil
1146 value to us. A value of nil means that command_loop_1 itself
1147 returned due to end of file (or end of kbd macro). */
1149 Lisp_Object
1150 command_loop_2 (Lisp_Object ignore)
1152 register Lisp_Object val;
1155 val = internal_condition_case (command_loop_1, Qerror, cmd_error);
1156 while (!NILP (val));
1158 return Qnil;
1161 static Lisp_Object
1162 top_level_2 (void)
1164 return Feval (Vtop_level, Qnil);
1167 Lisp_Object
1168 top_level_1 (Lisp_Object ignore)
1170 /* On entry to the outer level, run the startup file */
1171 if (!NILP (Vtop_level))
1172 internal_condition_case (top_level_2, Qerror, cmd_error);
1173 else if (!NILP (Vpurify_flag))
1174 message ("Bare impure Emacs (standard Lisp code not loaded)");
1175 else
1176 message ("Bare Emacs (standard Lisp code not loaded)");
1177 return Qnil;
1180 DEFUN ("top-level", Ftop_level, Stop_level, 0, 0, "",
1181 doc: /* Exit all recursive editing levels.
1182 This also exits all active minibuffers. */)
1183 (void)
1185 #ifdef HAVE_WINDOW_SYSTEM
1186 if (display_hourglass_p)
1187 cancel_hourglass ();
1188 #endif
1190 /* Unblock input if we enter with input blocked. This may happen if
1191 redisplay traps e.g. during tool-bar update with input blocked. */
1192 while (INPUT_BLOCKED_P)
1193 UNBLOCK_INPUT;
1195 Fthrow (Qtop_level, Qnil);
1198 static void user_error (const char*) NO_RETURN;
1199 static void user_error (const char *msg)
1201 xsignal1 (Quser_error, build_string (msg));
1204 static Lisp_Object Fexit_recursive_edit (void) NO_RETURN;
1205 DEFUN ("exit-recursive-edit", Fexit_recursive_edit, Sexit_recursive_edit, 0, 0, "",
1206 doc: /* Exit from the innermost recursive edit or minibuffer. */)
1207 (void)
1209 if (command_loop_level > 0 || minibuf_level > 0)
1210 Fthrow (Qexit, Qnil);
1212 user_error ("No recursive edit is in progress");
1215 static Lisp_Object Fabort_recursive_edit (void) NO_RETURN;
1216 DEFUN ("abort-recursive-edit", Fabort_recursive_edit, Sabort_recursive_edit, 0, 0, "",
1217 doc: /* Abort the command that requested this recursive edit or minibuffer input. */)
1218 (void)
1220 if (command_loop_level > 0 || minibuf_level > 0)
1221 Fthrow (Qexit, Qt);
1223 user_error ("No recursive edit is in progress");
1226 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1228 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1229 of this function. */
1231 static Lisp_Object
1232 tracking_off (Lisp_Object old_value)
1234 do_mouse_tracking = old_value;
1235 if (NILP (old_value))
1237 /* Redisplay may have been preempted because there was input
1238 available, and it assumes it will be called again after the
1239 input has been processed. If the only input available was
1240 the sort that we have just disabled, then we need to call
1241 redisplay. */
1242 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW))
1244 redisplay_preserve_echo_area (6);
1245 get_input_pending (&input_pending,
1246 READABLE_EVENTS_DO_TIMERS_NOW);
1249 return Qnil;
1252 DEFUN ("track-mouse", Ftrack_mouse, Strack_mouse, 0, UNEVALLED, 0,
1253 doc: /* Evaluate BODY with mouse movement events enabled.
1254 Within a `track-mouse' form, mouse motion generates input events that
1255 you can read with `read-event'.
1256 Normally, mouse motion is ignored.
1257 usage: (track-mouse BODY...) */)
1258 (Lisp_Object args)
1260 ptrdiff_t count = SPECPDL_INDEX ();
1261 Lisp_Object val;
1263 record_unwind_protect (tracking_off, do_mouse_tracking);
1265 do_mouse_tracking = Qt;
1267 val = Fprogn (args);
1268 return unbind_to (count, val);
1271 /* If mouse has moved on some frame, return one of those frames.
1273 Return 0 otherwise.
1275 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1276 after resizing the tool-bar window. */
1278 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1279 static
1280 #endif
1281 int ignore_mouse_drag_p;
1283 static FRAME_PTR
1284 some_mouse_moved (void)
1286 Lisp_Object tail, frame;
1288 if (ignore_mouse_drag_p)
1290 /* ignore_mouse_drag_p = 0; */
1291 return 0;
1294 FOR_EACH_FRAME (tail, frame)
1296 if (XFRAME (frame)->mouse_moved)
1297 return XFRAME (frame);
1300 return 0;
1303 #endif /* HAVE_MOUSE || HAVE_GPM */
1305 /* This is the actual command reading loop,
1306 sans error-handling encapsulation. */
1308 static int read_key_sequence (Lisp_Object *, int, Lisp_Object,
1309 int, int, int);
1310 void safe_run_hooks (Lisp_Object);
1311 static void adjust_point_for_property (ptrdiff_t, int);
1313 /* Cancel hourglass from protect_unwind.
1314 ARG is not used. */
1315 #ifdef HAVE_WINDOW_SYSTEM
1316 static Lisp_Object
1317 cancel_hourglass_unwind (Lisp_Object arg)
1319 cancel_hourglass ();
1320 return Qnil;
1322 #endif
1324 /* FIXME: This is wrong rather than test window-system, we should call
1325 a new set-selection, which will then dispatch to x-set-selection, or
1326 tty-set-selection, or w32-set-selection, ... */
1327 EXFUN (Fwindow_system, 1);
1329 Lisp_Object
1330 command_loop_1 (void)
1332 Lisp_Object cmd;
1333 Lisp_Object keybuf[30];
1334 int i;
1335 EMACS_INT prev_modiff = 0;
1336 struct buffer *prev_buffer = NULL;
1337 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1338 int was_locked = single_kboard;
1339 #endif
1340 int already_adjusted = 0;
1342 KVAR (current_kboard, Vprefix_arg) = Qnil;
1343 KVAR (current_kboard, Vlast_prefix_arg) = Qnil;
1344 Vdeactivate_mark = Qnil;
1345 waiting_for_input = 0;
1346 cancel_echoing ();
1348 this_command_key_count = 0;
1349 this_command_key_count_reset = 0;
1350 this_single_command_key_start = 0;
1352 if (NILP (Vmemory_full))
1354 /* Make sure this hook runs after commands that get errors and
1355 throw to top level. */
1356 /* Note that the value cell will never directly contain nil
1357 if the symbol is a local variable. */
1358 if (!NILP (Vpost_command_hook) && !NILP (Vrun_hooks))
1359 safe_run_hooks (Qpost_command_hook);
1361 /* If displaying a message, resize the echo area window to fit
1362 that message's size exactly. */
1363 if (!NILP (echo_area_buffer[0]))
1364 resize_echo_area_exactly ();
1366 /* If there are warnings waiting, process them. */
1367 if (!NILP (Vdelayed_warnings_list))
1368 safe_run_hooks (Qdelayed_warnings_hook);
1370 if (!NILP (Vdeferred_action_list))
1371 safe_run_hooks (Qdeferred_action_function);
1374 /* Do this after running Vpost_command_hook, for consistency. */
1375 KVAR (current_kboard, Vlast_command) = Vthis_command;
1376 KVAR (current_kboard, Vreal_last_command) = Vreal_this_command;
1377 if (!CONSP (last_command_event))
1378 KVAR (current_kboard, Vlast_repeatable_command) = Vreal_this_command;
1380 while (1)
1382 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
1383 Fkill_emacs (Qnil);
1385 /* Make sure the current window's buffer is selected. */
1386 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
1387 set_buffer_internal (XBUFFER (XWINDOW (selected_window)->buffer));
1389 /* Display any malloc warning that just came out. Use while because
1390 displaying one warning can cause another. */
1392 while (pending_malloc_warning)
1393 display_malloc_warning ();
1395 Vdeactivate_mark = Qnil;
1397 /* If minibuffer on and echo area in use,
1398 wait a short time and redraw minibuffer. */
1400 if (minibuf_level
1401 && !NILP (echo_area_buffer[0])
1402 && EQ (minibuf_window, echo_area_window)
1403 && NUMBERP (Vminibuffer_message_timeout))
1405 /* Bind inhibit-quit to t so that C-g gets read in
1406 rather than quitting back to the minibuffer. */
1407 ptrdiff_t count = SPECPDL_INDEX ();
1408 specbind (Qinhibit_quit, Qt);
1410 sit_for (Vminibuffer_message_timeout, 0, 2);
1412 /* Clear the echo area. */
1413 message2 (0, 0, 0);
1414 safe_run_hooks (Qecho_area_clear_hook);
1416 unbind_to (count, Qnil);
1418 /* If a C-g came in before, treat it as input now. */
1419 if (!NILP (Vquit_flag))
1421 Vquit_flag = Qnil;
1422 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
1426 #if 0
1427 /* Select the frame that the last event came from. Usually,
1428 switch-frame events will take care of this, but if some lisp
1429 code swallows a switch-frame event, we'll fix things up here.
1430 Is this a good idea? */
1431 if (FRAMEP (internal_last_event_frame)
1432 && !EQ (internal_last_event_frame, selected_frame))
1433 Fselect_frame (internal_last_event_frame, Qnil);
1434 #endif
1435 /* If it has changed current-menubar from previous value,
1436 really recompute the menubar from the value. */
1437 if (! NILP (Vlucid_menu_bar_dirty_flag)
1438 && !NILP (Ffboundp (Qrecompute_lucid_menubar)))
1439 call0 (Qrecompute_lucid_menubar);
1441 before_command_key_count = this_command_key_count;
1442 before_command_echo_length = echo_length ();
1444 Vthis_command = Qnil;
1445 Vreal_this_command = Qnil;
1446 Vthis_original_command = Qnil;
1447 Vthis_command_keys_shift_translated = Qnil;
1449 /* Read next key sequence; i gets its length. */
1450 i = read_key_sequence (keybuf, sizeof keybuf / sizeof keybuf[0],
1451 Qnil, 0, 1, 1);
1453 /* A filter may have run while we were reading the input. */
1454 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
1455 Fkill_emacs (Qnil);
1456 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
1457 set_buffer_internal (XBUFFER (XWINDOW (selected_window)->buffer));
1459 ++num_input_keys;
1461 /* Now we have read a key sequence of length I,
1462 or else I is 0 and we found end of file. */
1464 if (i == 0) /* End of file -- happens only in */
1465 return Qnil; /* a kbd macro, at the end. */
1466 /* -1 means read_key_sequence got a menu that was rejected.
1467 Just loop around and read another command. */
1468 if (i == -1)
1470 cancel_echoing ();
1471 this_command_key_count = 0;
1472 this_command_key_count_reset = 0;
1473 this_single_command_key_start = 0;
1474 goto finalize;
1477 last_command_event = keybuf[i - 1];
1479 /* If the previous command tried to force a specific window-start,
1480 forget about that, in case this command moves point far away
1481 from that position. But also throw away beg_unchanged and
1482 end_unchanged information in that case, so that redisplay will
1483 update the whole window properly. */
1484 if (XWINDOW (selected_window)->force_start)
1486 struct buffer *b;
1487 XWINDOW (selected_window)->force_start = 0;
1488 b = XBUFFER (XWINDOW (selected_window)->buffer);
1489 BUF_BEG_UNCHANGED (b) = BUF_END_UNCHANGED (b) = 0;
1492 cmd = read_key_sequence_cmd;
1493 if (!NILP (Vexecuting_kbd_macro))
1495 if (!NILP (Vquit_flag))
1497 Vexecuting_kbd_macro = Qt;
1498 QUIT; /* Make some noise. */
1499 /* Will return since macro now empty. */
1503 /* Do redisplay processing after this command except in special
1504 cases identified below. */
1505 prev_buffer = current_buffer;
1506 prev_modiff = MODIFF;
1507 last_point_position = PT;
1508 last_point_position_window = selected_window;
1509 XSETBUFFER (last_point_position_buffer, prev_buffer);
1511 /* By default, we adjust point to a boundary of a region that
1512 has such a property that should be treated intangible
1513 (e.g. composition, display). But, some commands will set
1514 this variable differently. */
1515 Vdisable_point_adjustment = Qnil;
1517 /* Process filters and timers may have messed with deactivate-mark.
1518 reset it before we execute the command. */
1519 Vdeactivate_mark = Qnil;
1521 /* Remap command through active keymaps. */
1522 Vthis_original_command = cmd;
1523 if (!NILP (read_key_sequence_remapped))
1524 cmd = read_key_sequence_remapped;
1526 /* Execute the command. */
1528 Vthis_command = cmd;
1529 Vreal_this_command = cmd;
1530 safe_run_hooks (Qpre_command_hook);
1532 already_adjusted = 0;
1534 if (NILP (Vthis_command))
1536 /* nil means key is undefined. */
1537 Lisp_Object keys = Fvector (i, keybuf);
1538 keys = Fkey_description (keys, Qnil);
1539 bitch_at_user ();
1540 message_with_string ("%s is undefined", keys, 0);
1541 KVAR (current_kboard, defining_kbd_macro) = Qnil;
1542 update_mode_lines = 1;
1543 /* If this is a down-mouse event, don't reset prefix-arg;
1544 pass it to the command run by the up event. */
1545 if (EVENT_HAS_PARAMETERS (last_command_event))
1547 Lisp_Object breakdown
1548 = parse_modifiers (EVENT_HEAD (last_command_event));
1549 int modifiers = XINT (XCAR (XCDR (breakdown)));
1550 if (!(modifiers & down_modifier))
1551 KVAR (current_kboard, Vprefix_arg) = Qnil;
1553 else
1554 KVAR (current_kboard, Vprefix_arg) = Qnil;
1556 else
1558 /* Here for a command that isn't executed directly. */
1560 #ifdef HAVE_WINDOW_SYSTEM
1561 ptrdiff_t scount = SPECPDL_INDEX ();
1563 if (display_hourglass_p
1564 && NILP (Vexecuting_kbd_macro))
1566 record_unwind_protect (cancel_hourglass_unwind, Qnil);
1567 start_hourglass ();
1569 #endif
1571 if (NILP (KVAR (current_kboard, Vprefix_arg))) /* FIXME: Why? --Stef */
1572 Fundo_boundary ();
1573 Fcommand_execute (Vthis_command, Qnil, Qnil, Qnil);
1575 #ifdef HAVE_WINDOW_SYSTEM
1576 /* Do not check display_hourglass_p here, because
1577 Fcommand_execute could change it, but we should cancel
1578 hourglass cursor anyway.
1579 But don't cancel the hourglass within a macro
1580 just because a command in the macro finishes. */
1581 if (NILP (Vexecuting_kbd_macro))
1582 unbind_to (scount, Qnil);
1583 #endif
1585 KVAR (current_kboard, Vlast_prefix_arg) = Vcurrent_prefix_arg;
1587 safe_run_hooks (Qpost_command_hook);
1589 /* If displaying a message, resize the echo area window to fit
1590 that message's size exactly. */
1591 if (!NILP (echo_area_buffer[0]))
1592 resize_echo_area_exactly ();
1594 /* If there are warnings waiting, process them. */
1595 if (!NILP (Vdelayed_warnings_list))
1596 safe_run_hooks (Qdelayed_warnings_hook);
1598 safe_run_hooks (Qdeferred_action_function);
1600 /* If there is a prefix argument,
1601 1) We don't want Vlast_command to be ``universal-argument''
1602 (that would be dumb), so don't set Vlast_command,
1603 2) we want to leave echoing on so that the prefix will be
1604 echoed as part of this key sequence, so don't call
1605 cancel_echoing, and
1606 3) we want to leave this_command_key_count non-zero, so that
1607 read_char will realize that it is re-reading a character, and
1608 not echo it a second time.
1610 If the command didn't actually create a prefix arg,
1611 but is merely a frame event that is transparent to prefix args,
1612 then the above doesn't apply. */
1613 if (NILP (KVAR (current_kboard, Vprefix_arg))
1614 || CONSP (last_command_event))
1616 KVAR (current_kboard, Vlast_command) = Vthis_command;
1617 KVAR (current_kboard, Vreal_last_command) = Vreal_this_command;
1618 if (!CONSP (last_command_event))
1619 KVAR (current_kboard, Vlast_repeatable_command)
1620 = Vreal_this_command;
1621 cancel_echoing ();
1622 this_command_key_count = 0;
1623 this_command_key_count_reset = 0;
1624 this_single_command_key_start = 0;
1627 if (!NILP (BVAR (current_buffer, mark_active))
1628 && !NILP (Vrun_hooks))
1630 /* In Emacs 22, setting transient-mark-mode to `only' was a
1631 way of turning it on for just one command. This usage is
1632 obsolete, but support it anyway. */
1633 if (EQ (Vtransient_mark_mode, Qidentity))
1634 Vtransient_mark_mode = Qnil;
1635 else if (EQ (Vtransient_mark_mode, Qonly))
1636 Vtransient_mark_mode = Qidentity;
1638 if (!NILP (Vdeactivate_mark))
1639 /* If `select-active-regions' is non-nil, this call to
1640 `deactivate-mark' also sets the PRIMARY selection. */
1641 call0 (Qdeactivate_mark);
1642 else
1644 /* Even if not deactivating the mark, set PRIMARY if
1645 `select-active-regions' is non-nil. */
1646 if (!NILP (Fwindow_system (Qnil))
1647 /* Even if mark_active is non-nil, the actual buffer
1648 marker may not have been set yet (Bug#7044). */
1649 && XMARKER (BVAR (current_buffer, mark))->buffer
1650 && (EQ (Vselect_active_regions, Qonly)
1651 ? EQ (CAR_SAFE (Vtransient_mark_mode), Qonly)
1652 : (!NILP (Vselect_active_regions)
1653 && !NILP (Vtransient_mark_mode)))
1654 && NILP (Fmemq (Vthis_command,
1655 Vselection_inhibit_update_commands)))
1657 ptrdiff_t beg =
1658 XINT (Fmarker_position (BVAR (current_buffer, mark)));
1659 ptrdiff_t end = PT;
1660 if (beg < end)
1661 call2 (Qx_set_selection, QPRIMARY,
1662 make_buffer_string (beg, end, 0));
1663 else if (beg > end)
1664 call2 (Qx_set_selection, QPRIMARY,
1665 make_buffer_string (end, beg, 0));
1666 /* Don't set empty selections. */
1669 if (current_buffer != prev_buffer || MODIFF != prev_modiff)
1671 Lisp_Object hook = intern ("activate-mark-hook");
1672 Frun_hooks (1, &hook);
1676 Vsaved_region_selection = Qnil;
1679 finalize:
1681 if (current_buffer == prev_buffer
1682 && last_point_position != PT
1683 && NILP (Vdisable_point_adjustment)
1684 && NILP (Vglobal_disable_point_adjustment))
1686 if (last_point_position > BEGV
1687 && last_point_position < ZV
1688 && (composition_adjust_point (last_point_position,
1689 last_point_position)
1690 != last_point_position))
1691 /* The last point was temporarily set within a grapheme
1692 cluster to prevent automatic composition. To recover
1693 the automatic composition, we must update the
1694 display. */
1695 windows_or_buffers_changed++;
1696 if (!already_adjusted)
1697 adjust_point_for_property (last_point_position,
1698 MODIFF != prev_modiff);
1701 /* Install chars successfully executed in kbd macro. */
1703 if (!NILP (KVAR (current_kboard, defining_kbd_macro))
1704 && NILP (KVAR (current_kboard, Vprefix_arg)))
1705 finalize_kbd_macro_chars ();
1706 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1707 if (!was_locked)
1708 any_kboard_state ();
1709 #endif
1713 /* Adjust point to a boundary of a region that has such a property
1714 that should be treated intangible. For the moment, we check
1715 `composition', `display' and `invisible' properties.
1716 LAST_PT is the last position of point. */
1718 static void
1719 adjust_point_for_property (ptrdiff_t last_pt, int modified)
1721 ptrdiff_t beg, end;
1722 Lisp_Object val, overlay, tmp;
1723 /* When called after buffer modification, we should temporarily
1724 suppress the point adjustment for automatic composition so that a
1725 user can keep inserting another character at point or keep
1726 deleting characters around point. */
1727 int check_composition = ! modified, check_display = 1, check_invisible = 1;
1728 ptrdiff_t orig_pt = PT;
1730 /* FIXME: cycling is probably not necessary because these properties
1731 can't be usefully combined anyway. */
1732 while (check_composition || check_display || check_invisible)
1734 /* FIXME: check `intangible'. */
1735 if (check_composition
1736 && PT > BEGV && PT < ZV
1737 && (beg = composition_adjust_point (last_pt, PT)) != PT)
1739 SET_PT (beg);
1740 check_display = check_invisible = 1;
1742 check_composition = 0;
1743 if (check_display
1744 && PT > BEGV && PT < ZV
1745 && !NILP (val = get_char_property_and_overlay
1746 (make_number (PT), Qdisplay, Qnil, &overlay))
1747 && display_prop_intangible_p (val, overlay, PT, PT_BYTE)
1748 && (!OVERLAYP (overlay)
1749 ? get_property_and_range (PT, Qdisplay, &val, &beg, &end, Qnil)
1750 : (beg = OVERLAY_POSITION (OVERLAY_START (overlay)),
1751 end = OVERLAY_POSITION (OVERLAY_END (overlay))))
1752 && (beg < PT /* && end > PT <- It's always the case. */
1753 || (beg <= PT && STRINGP (val) && SCHARS (val) == 0)))
1755 xassert (end > PT);
1756 SET_PT (PT < last_pt
1757 ? (STRINGP (val) && SCHARS (val) == 0
1758 ? max (beg - 1, BEGV)
1759 : beg)
1760 : end);
1761 check_composition = check_invisible = 1;
1763 check_display = 0;
1764 if (check_invisible && PT > BEGV && PT < ZV)
1766 int inv, ellipsis = 0;
1767 beg = end = PT;
1769 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1770 while (end < ZV
1771 #if 0
1772 /* FIXME: We should stop if we find a spot between
1773 two runs of `invisible' where inserted text would
1774 be visible. This is important when we have two
1775 invisible boundaries that enclose an area: if the
1776 area is empty, we need this test in order to make
1777 it possible to place point in the middle rather
1778 than skip both boundaries. However, this code
1779 also stops anywhere in a non-sticky text-property,
1780 which breaks (e.g.) Org mode. */
1781 && (val = get_pos_property (make_number (end),
1782 Qinvisible, Qnil),
1783 TEXT_PROP_MEANS_INVISIBLE (val))
1784 #endif
1785 && !NILP (val = get_char_property_and_overlay
1786 (make_number (end), Qinvisible, Qnil, &overlay))
1787 && (inv = TEXT_PROP_MEANS_INVISIBLE (val)))
1789 ellipsis = ellipsis || inv > 1
1790 || (OVERLAYP (overlay)
1791 && (!NILP (Foverlay_get (overlay, Qafter_string))
1792 || !NILP (Foverlay_get (overlay, Qbefore_string))));
1793 tmp = Fnext_single_char_property_change
1794 (make_number (end), Qinvisible, Qnil, Qnil);
1795 end = NATNUMP (tmp) ? XFASTINT (tmp) : ZV;
1797 while (beg > BEGV
1798 #if 0
1799 && (val = get_pos_property (make_number (beg),
1800 Qinvisible, Qnil),
1801 TEXT_PROP_MEANS_INVISIBLE (val))
1802 #endif
1803 && !NILP (val = get_char_property_and_overlay
1804 (make_number (beg - 1), Qinvisible, Qnil, &overlay))
1805 && (inv = TEXT_PROP_MEANS_INVISIBLE (val)))
1807 ellipsis = ellipsis || inv > 1
1808 || (OVERLAYP (overlay)
1809 && (!NILP (Foverlay_get (overlay, Qafter_string))
1810 || !NILP (Foverlay_get (overlay, Qbefore_string))));
1811 tmp = Fprevious_single_char_property_change
1812 (make_number (beg), Qinvisible, Qnil, Qnil);
1813 beg = NATNUMP (tmp) ? XFASTINT (tmp) : BEGV;
1816 /* Move away from the inside area. */
1817 if (beg < PT && end > PT)
1819 SET_PT ((orig_pt == PT && (last_pt < beg || last_pt > end))
1820 /* We haven't moved yet (so we don't need to fear
1821 infinite-looping) and we were outside the range
1822 before (so either end of the range still corresponds
1823 to a move in the right direction): pretend we moved
1824 less than we actually did, so that we still have
1825 more freedom below in choosing which end of the range
1826 to go to. */
1827 ? (orig_pt = -1, PT < last_pt ? end : beg)
1828 /* We either have moved already or the last point
1829 was already in the range: we don't get to choose
1830 which end of the range we have to go to. */
1831 : (PT < last_pt ? beg : end));
1832 check_composition = check_display = 1;
1834 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1835 the point to something other than its argument, due to
1836 point-motion hooks, intangibility, etc. */
1837 xassert (PT == beg || PT == end);
1838 #endif
1840 /* Pretend the area doesn't exist if the buffer is not
1841 modified. */
1842 if (!modified && !ellipsis && beg < end)
1844 if (last_pt == beg && PT == end && end < ZV)
1845 (check_composition = check_display = 1, SET_PT (end + 1));
1846 else if (last_pt == end && PT == beg && beg > BEGV)
1847 (check_composition = check_display = 1, SET_PT (beg - 1));
1848 else if (PT == ((PT < last_pt) ? beg : end))
1849 /* We've already moved as far as we can. Trying to go
1850 to the other end would mean moving backwards and thus
1851 could lead to an infinite loop. */
1853 else if (val = get_pos_property (make_number (PT),
1854 Qinvisible, Qnil),
1855 TEXT_PROP_MEANS_INVISIBLE (val)
1856 && (val = get_pos_property
1857 (make_number (PT == beg ? end : beg),
1858 Qinvisible, Qnil),
1859 !TEXT_PROP_MEANS_INVISIBLE (val)))
1860 (check_composition = check_display = 1,
1861 SET_PT (PT == beg ? end : beg));
1864 check_invisible = 0;
1868 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1870 static Lisp_Object
1871 safe_run_hooks_1 (void)
1873 eassert (CONSP (Vinhibit_quit));
1874 return call0 (XCDR (Vinhibit_quit));
1877 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1878 from the hook. */
1880 static Lisp_Object
1881 safe_run_hooks_error (Lisp_Object error_data)
1883 Lisp_Object hook
1884 = CONSP (Vinhibit_quit) ? XCAR (Vinhibit_quit) : Vinhibit_quit;
1885 Lisp_Object fun = CONSP (Vinhibit_quit) ? XCDR (Vinhibit_quit) : Qnil;
1886 Lisp_Object args[4];
1887 args[0] = build_string ("Error in %s (%s): %S");
1888 args[1] = hook;
1889 args[2] = fun;
1890 args[3] = error_data;
1891 Fmessage (4, args);
1892 if (SYMBOLP (hook))
1894 Lisp_Object val;
1895 int found = 0;
1896 Lisp_Object newval = Qnil;
1897 for (val = find_symbol_value (hook); CONSP (val); val = XCDR (val))
1898 if (EQ (fun, XCAR (val)))
1899 found = 1;
1900 else
1901 newval = Fcons (XCAR (val), newval);
1902 if (found)
1903 return Fset (hook, Fnreverse (newval));
1904 /* Not found in the local part of the hook. Let's look at the global
1905 part. */
1906 newval = Qnil;
1907 for (val = (NILP (Fdefault_boundp (hook)) ? Qnil
1908 : Fdefault_value (hook));
1909 CONSP (val); val = XCDR (val))
1910 if (EQ (fun, XCAR (val)))
1911 found = 1;
1912 else
1913 newval = Fcons (XCAR (val), newval);
1914 if (found)
1915 return Fset_default (hook, Fnreverse (newval));
1917 return Qnil;
1920 static Lisp_Object
1921 safe_run_hook_funcall (ptrdiff_t nargs, Lisp_Object *args)
1923 eassert (nargs == 1);
1924 if (CONSP (Vinhibit_quit))
1925 XSETCDR (Vinhibit_quit, args[0]);
1926 else
1927 Vinhibit_quit = Fcons (Vinhibit_quit, args[0]);
1929 internal_condition_case (safe_run_hooks_1, Qt, safe_run_hooks_error);
1930 return Qnil;
1933 /* If we get an error while running the hook, cause the hook variable
1934 to be nil. Also inhibit quits, so that C-g won't cause the hook
1935 to mysteriously evaporate. */
1937 void
1938 safe_run_hooks (Lisp_Object hook)
1940 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1941 to its body or to its handlers other than via globals such as
1942 dynamically-bound variables ;-) */
1943 ptrdiff_t count = SPECPDL_INDEX ();
1944 specbind (Qinhibit_quit, hook);
1946 run_hook_with_args (1, &hook, safe_run_hook_funcall);
1948 unbind_to (count, Qnil);
1952 /* Nonzero means polling for input is temporarily suppressed. */
1954 int poll_suppress_count;
1956 /* Asynchronous timer for polling. */
1958 static struct atimer *poll_timer;
1961 #ifdef POLL_FOR_INPUT
1963 /* Poll for input, so that we catch a C-g if it comes in. This
1964 function is called from x_make_frame_visible, see comment
1965 there. */
1967 void
1968 poll_for_input_1 (void)
1970 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1971 doing anything dangerous. */
1972 #ifdef HAVE_NS
1973 ++handling_signal;
1974 #endif
1975 if (interrupt_input_blocked == 0
1976 && !waiting_for_input)
1977 read_avail_input (0);
1978 #ifdef HAVE_NS
1979 --handling_signal;
1980 #endif
1983 /* Timer callback function for poll_timer. TIMER is equal to
1984 poll_timer. */
1986 static void
1987 poll_for_input (struct atimer *timer)
1989 if (poll_suppress_count == 0)
1991 #ifdef SYNC_INPUT
1992 interrupt_input_pending = 1;
1993 pending_signals = 1;
1994 #else
1995 poll_for_input_1 ();
1996 #endif
2000 #endif /* POLL_FOR_INPUT */
2002 /* Begin signals to poll for input, if they are appropriate.
2003 This function is called unconditionally from various places. */
2005 void
2006 start_polling (void)
2008 #ifdef POLL_FOR_INPUT
2009 /* XXX This condition was (read_socket_hook && !interrupt_input),
2010 but read_socket_hook is not global anymore. Let's pretend that
2011 it's always set. */
2012 if (!interrupt_input)
2014 /* Turn alarm handling on unconditionally. It might have
2015 been turned off in process.c. */
2016 turn_on_atimers (1);
2018 /* If poll timer doesn't exist, are we need one with
2019 a different interval, start a new one. */
2020 if (poll_timer == NULL
2021 || EMACS_SECS (poll_timer->interval) != polling_period)
2023 EMACS_TIME interval;
2025 if (poll_timer)
2026 cancel_atimer (poll_timer);
2028 EMACS_SET_SECS_USECS (interval, polling_period, 0);
2029 poll_timer = start_atimer (ATIMER_CONTINUOUS, interval,
2030 poll_for_input, NULL);
2033 /* Let the timer's callback function poll for input
2034 if this becomes zero. */
2035 --poll_suppress_count;
2037 #endif
2040 /* Nonzero if we are using polling to handle input asynchronously. */
2043 input_polling_used (void)
2045 #ifdef POLL_FOR_INPUT
2046 /* XXX This condition was (read_socket_hook && !interrupt_input),
2047 but read_socket_hook is not global anymore. Let's pretend that
2048 it's always set. */
2049 return !interrupt_input;
2050 #else
2051 return 0;
2052 #endif
2055 /* Turn off polling. */
2057 void
2058 stop_polling (void)
2060 #ifdef POLL_FOR_INPUT
2061 /* XXX This condition was (read_socket_hook && !interrupt_input),
2062 but read_socket_hook is not global anymore. Let's pretend that
2063 it's always set. */
2064 if (!interrupt_input)
2065 ++poll_suppress_count;
2066 #endif
2069 /* Set the value of poll_suppress_count to COUNT
2070 and start or stop polling accordingly. */
2072 void
2073 set_poll_suppress_count (int count)
2075 #ifdef POLL_FOR_INPUT
2076 if (count == 0 && poll_suppress_count != 0)
2078 poll_suppress_count = 1;
2079 start_polling ();
2081 else if (count != 0 && poll_suppress_count == 0)
2083 stop_polling ();
2085 poll_suppress_count = count;
2086 #endif
2089 /* Bind polling_period to a value at least N.
2090 But don't decrease it. */
2092 void
2093 bind_polling_period (int n)
2095 #ifdef POLL_FOR_INPUT
2096 int new = polling_period;
2098 if (n > new)
2099 new = n;
2101 stop_other_atimers (poll_timer);
2102 stop_polling ();
2103 specbind (Qpolling_period, make_number (new));
2104 /* Start a new alarm with the new period. */
2105 start_polling ();
2106 #endif
2109 /* Apply the control modifier to CHARACTER. */
2112 make_ctrl_char (int c)
2114 /* Save the upper bits here. */
2115 int upper = c & ~0177;
2117 if (! ASCII_BYTE_P (c))
2118 return c |= ctrl_modifier;
2120 c &= 0177;
2122 /* Everything in the columns containing the upper-case letters
2123 denotes a control character. */
2124 if (c >= 0100 && c < 0140)
2126 int oc = c;
2127 c &= ~0140;
2128 /* Set the shift modifier for a control char
2129 made from a shifted letter. But only for letters! */
2130 if (oc >= 'A' && oc <= 'Z')
2131 c |= shift_modifier;
2134 /* The lower-case letters denote control characters too. */
2135 else if (c >= 'a' && c <= 'z')
2136 c &= ~0140;
2138 /* Include the bits for control and shift
2139 only if the basic ASCII code can't indicate them. */
2140 else if (c >= ' ')
2141 c |= ctrl_modifier;
2143 /* Replace the high bits. */
2144 c |= (upper & ~ctrl_modifier);
2146 return c;
2149 /* Display the help-echo property of the character after the mouse pointer.
2150 Either show it in the echo area, or call show-help-function to display
2151 it by other means (maybe in a tooltip).
2153 If HELP is nil, that means clear the previous help echo.
2155 If HELP is a string, display that string. If HELP is a function,
2156 call it with OBJECT and POS as arguments; the function should
2157 return a help string or nil for none. For all other types of HELP,
2158 evaluate it to obtain a string.
2160 WINDOW is the window in which the help was generated, if any.
2161 It is nil if not in a window.
2163 If OBJECT is a buffer, POS is the position in the buffer where the
2164 `help-echo' text property was found.
2166 If OBJECT is an overlay, that overlay has a `help-echo' property,
2167 and POS is the position in the overlay's buffer under the mouse.
2169 If OBJECT is a string (an overlay string or a string displayed with
2170 the `display' property). POS is the position in that string under
2171 the mouse.
2173 Note: this function may only be called with HELP nil or a string
2174 from X code running asynchronously. */
2176 void
2177 show_help_echo (Lisp_Object help, Lisp_Object window, Lisp_Object object,
2178 Lisp_Object pos)
2180 if (!NILP (help) && !STRINGP (help))
2182 if (FUNCTIONP (help))
2184 Lisp_Object args[4];
2185 args[0] = help;
2186 args[1] = window;
2187 args[2] = object;
2188 args[3] = pos;
2189 help = safe_call (4, args);
2191 else
2192 help = safe_eval (help);
2194 if (!STRINGP (help))
2195 return;
2198 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2199 if (!noninteractive && STRINGP (help))
2201 /* The mouse-fixup-help-message Lisp function can call
2202 mouse_position_hook, which resets the mouse_moved flags.
2203 This causes trouble if we are trying to read a mouse motion
2204 event (i.e., if we are inside a `track-mouse' form), so we
2205 restore the mouse_moved flag. */
2206 FRAME_PTR f = NILP (do_mouse_tracking) ? NULL : some_mouse_moved ();
2207 help = call1 (Qmouse_fixup_help_message, help);
2208 if (f)
2209 f->mouse_moved = 1;
2211 #endif
2213 if (STRINGP (help) || NILP (help))
2215 if (!NILP (Vshow_help_function))
2216 call1 (Vshow_help_function, help);
2217 help_echo_showing_p = STRINGP (help);
2223 /* Input of single characters from keyboard */
2225 static Lisp_Object kbd_buffer_get_event (KBOARD **kbp, int *used_mouse_menu,
2226 struct timeval *end_time);
2227 static void record_char (Lisp_Object c);
2229 static Lisp_Object help_form_saved_window_configs;
2230 static Lisp_Object
2231 read_char_help_form_unwind (Lisp_Object arg)
2233 Lisp_Object window_config = XCAR (help_form_saved_window_configs);
2234 help_form_saved_window_configs = XCDR (help_form_saved_window_configs);
2235 if (!NILP (window_config))
2236 Fset_window_configuration (window_config);
2237 return Qnil;
2240 #define STOP_POLLING \
2241 do { if (! polling_stopped_here) stop_polling (); \
2242 polling_stopped_here = 1; } while (0)
2244 #define RESUME_POLLING \
2245 do { if (polling_stopped_here) start_polling (); \
2246 polling_stopped_here = 0; } while (0)
2248 /* read a character from the keyboard; call the redisplay if needed */
2249 /* commandflag 0 means do not autosave, but do redisplay.
2250 -1 means do not redisplay, but do autosave.
2251 1 means do both. */
2253 /* The arguments MAPS and NMAPS are for menu prompting.
2254 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2256 PREV_EVENT is the previous input event, or nil if we are reading
2257 the first event of a key sequence (or not reading a key sequence).
2258 If PREV_EVENT is t, that is a "magic" value that says
2259 not to run input methods, but in other respects to act as if
2260 not reading a key sequence.
2262 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2263 if we used a mouse menu to read the input, or zero otherwise. If
2264 USED_MOUSE_MENU is null, we don't dereference it.
2266 Value is -2 when we find input on another keyboard. A second call
2267 to read_char will read it.
2269 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2270 specifying the maximum time to wait until. If no input arrives by
2271 that time, stop waiting and return nil.
2273 Value is t if we showed a menu and the user rejected it. */
2275 Lisp_Object
2276 read_char (int commandflag, ptrdiff_t nmaps, Lisp_Object *maps,
2277 Lisp_Object prev_event,
2278 int *used_mouse_menu, struct timeval *end_time)
2280 volatile Lisp_Object c;
2281 ptrdiff_t jmpcount;
2282 jmp_buf local_getcjmp;
2283 jmp_buf save_jump;
2284 volatile int key_already_recorded = 0;
2285 Lisp_Object tem, save;
2286 volatile Lisp_Object previous_echo_area_message;
2287 volatile Lisp_Object also_record;
2288 volatile int reread;
2289 struct gcpro gcpro1, gcpro2;
2290 int volatile polling_stopped_here = 0;
2291 struct kboard *orig_kboard = current_kboard;
2293 also_record = Qnil;
2295 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2296 before_command_key_count = this_command_key_count;
2297 before_command_echo_length = echo_length ();
2298 #endif
2299 c = Qnil;
2300 previous_echo_area_message = Qnil;
2302 GCPRO2 (c, previous_echo_area_message);
2304 retry:
2306 reread = 0;
2307 if (CONSP (Vunread_post_input_method_events))
2309 c = XCAR (Vunread_post_input_method_events);
2310 Vunread_post_input_method_events
2311 = XCDR (Vunread_post_input_method_events);
2313 /* Undo what read_char_x_menu_prompt did when it unread
2314 additional keys returned by Fx_popup_menu. */
2315 if (CONSP (c)
2316 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c)))
2317 && NILP (XCDR (c)))
2318 c = XCAR (c);
2320 reread = 1;
2321 goto reread_first;
2324 if (unread_command_char != -1)
2326 XSETINT (c, unread_command_char);
2327 unread_command_char = -1;
2329 reread = 1;
2330 goto reread_first;
2333 if (CONSP (Vunread_command_events))
2335 int was_disabled = 0;
2337 c = XCAR (Vunread_command_events);
2338 Vunread_command_events = XCDR (Vunread_command_events);
2340 reread = 1;
2342 /* Undo what sit-for did when it unread additional keys
2343 inside universal-argument. */
2345 if (CONSP (c)
2346 && EQ (XCAR (c), Qt))
2348 reread = 0;
2349 c = XCDR (c);
2352 /* Undo what read_char_x_menu_prompt did when it unread
2353 additional keys returned by Fx_popup_menu. */
2354 if (CONSP (c)
2355 && EQ (XCDR (c), Qdisabled)
2356 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c))))
2358 was_disabled = 1;
2359 c = XCAR (c);
2362 /* If the queued event is something that used the mouse,
2363 set used_mouse_menu accordingly. */
2364 if (used_mouse_menu
2365 /* Also check was_disabled so last-nonmenu-event won't return
2366 a bad value when submenus are involved. (Bug#447) */
2367 && (EQ (c, Qtool_bar) || EQ (c, Qmenu_bar) || was_disabled))
2368 *used_mouse_menu = 1;
2370 goto reread_for_input_method;
2373 if (CONSP (Vunread_input_method_events))
2375 c = XCAR (Vunread_input_method_events);
2376 Vunread_input_method_events = XCDR (Vunread_input_method_events);
2378 /* Undo what read_char_x_menu_prompt did when it unread
2379 additional keys returned by Fx_popup_menu. */
2380 if (CONSP (c)
2381 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c)))
2382 && NILP (XCDR (c)))
2383 c = XCAR (c);
2384 reread = 1;
2385 goto reread_for_input_method;
2388 this_command_key_count_reset = 0;
2390 if (!NILP (Vexecuting_kbd_macro))
2392 /* We set this to Qmacro; since that's not a frame, nobody will
2393 try to switch frames on us, and the selected window will
2394 remain unchanged.
2396 Since this event came from a macro, it would be misleading to
2397 leave internal_last_event_frame set to wherever the last
2398 real event came from. Normally, a switch-frame event selects
2399 internal_last_event_frame after each command is read, but
2400 events read from a macro should never cause a new frame to be
2401 selected. */
2402 Vlast_event_frame = internal_last_event_frame = Qmacro;
2404 /* Exit the macro if we are at the end.
2405 Also, some things replace the macro with t
2406 to force an early exit. */
2407 if (EQ (Vexecuting_kbd_macro, Qt)
2408 || executing_kbd_macro_index >= XFASTINT (Flength (Vexecuting_kbd_macro)))
2410 XSETINT (c, -1);
2411 goto exit;
2414 c = Faref (Vexecuting_kbd_macro, make_number (executing_kbd_macro_index));
2415 if (STRINGP (Vexecuting_kbd_macro)
2416 && (XFASTINT (c) & 0x80) && (XFASTINT (c) <= 0xff))
2417 XSETFASTINT (c, CHAR_META | (XFASTINT (c) & ~0x80));
2419 executing_kbd_macro_index++;
2421 goto from_macro;
2424 if (!NILP (unread_switch_frame))
2426 c = unread_switch_frame;
2427 unread_switch_frame = Qnil;
2429 /* This event should make it into this_command_keys, and get echoed
2430 again, so we do not set `reread'. */
2431 goto reread_first;
2434 /* if redisplay was requested */
2435 if (commandflag >= 0)
2437 int echo_current = EQ (echo_message_buffer, echo_area_buffer[0]);
2439 /* If there is pending input, process any events which are not
2440 user-visible, such as X selection_request events. */
2441 if (input_pending
2442 || detect_input_pending_run_timers (0))
2443 swallow_events (0); /* may clear input_pending */
2445 /* Redisplay if no pending input. */
2446 while (!input_pending)
2448 if (help_echo_showing_p && !EQ (selected_window, minibuf_window))
2449 redisplay_preserve_echo_area (5);
2450 else
2451 redisplay ();
2453 if (!input_pending)
2454 /* Normal case: no input arrived during redisplay. */
2455 break;
2457 /* Input arrived and pre-empted redisplay.
2458 Process any events which are not user-visible. */
2459 swallow_events (0);
2460 /* If that cleared input_pending, try again to redisplay. */
2463 /* Prevent the redisplay we just did
2464 from messing up echoing of the input after the prompt. */
2465 if (commandflag == 0 && echo_current)
2466 echo_message_buffer = echo_area_buffer[0];
2470 /* Message turns off echoing unless more keystrokes turn it on again.
2472 The code in 20.x for the condition was
2474 1. echo_area_glyphs && *echo_area_glyphs
2475 2. && echo_area_glyphs != current_kboard->echobuf
2476 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2478 (1) means there's a current message displayed
2480 (2) means it's not the message from echoing from the current
2481 kboard.
2483 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2484 is set to a non-null value. This is done in read_char and it is
2485 set to echo_area_glyphs after a call to echo_char. That means
2486 ok_to_echo_at_next_pause is either null or
2487 current_kboard->echobuf with the appropriate current_kboard at
2488 that time.
2490 So, condition (3) means in clear text ok_to_echo_at_next_pause
2491 must be either null, or the current message isn't from echoing at
2492 all, or it's from echoing from a different kboard than the
2493 current one. */
2495 if (/* There currently is something in the echo area. */
2496 !NILP (echo_area_buffer[0])
2497 && (/* And it's either not from echoing. */
2498 !EQ (echo_area_buffer[0], echo_message_buffer)
2499 /* Or it's an echo from a different kboard. */
2500 || echo_kboard != current_kboard
2501 /* Or we explicitly allow overwriting whatever there is. */
2502 || ok_to_echo_at_next_pause == NULL))
2503 cancel_echoing ();
2504 else
2505 echo_dash ();
2507 /* Try reading a character via menu prompting in the minibuf.
2508 Try this before the sit-for, because the sit-for
2509 would do the wrong thing if we are supposed to do
2510 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2511 after a mouse event so don't try a minibuf menu. */
2512 c = Qnil;
2513 if (nmaps > 0 && INTERACTIVE
2514 && !NILP (prev_event) && ! EVENT_HAS_PARAMETERS (prev_event)
2515 /* Don't bring up a menu if we already have another event. */
2516 && NILP (Vunread_command_events)
2517 && unread_command_char < 0
2518 && !detect_input_pending_run_timers (0))
2520 c = read_char_minibuf_menu_prompt (commandflag, nmaps, maps);
2522 if (INTEGERP (c) && XINT (c) == -2)
2523 return c; /* wrong_kboard_jmpbuf */
2525 if (! NILP (c))
2527 key_already_recorded = 1;
2528 goto non_reread_1;
2532 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2533 We will do that below, temporarily for short sections of code,
2534 when appropriate. local_getcjmp must be in effect
2535 around any call to sit_for or kbd_buffer_get_event;
2536 it *must not* be in effect when we call redisplay. */
2538 jmpcount = SPECPDL_INDEX ();
2539 if (_setjmp (local_getcjmp))
2541 /* Handle quits while reading the keyboard. */
2542 /* We must have saved the outer value of getcjmp here,
2543 so restore it now. */
2544 restore_getcjmp (save_jump);
2545 unbind_to (jmpcount, Qnil);
2546 XSETINT (c, quit_char);
2547 internal_last_event_frame = selected_frame;
2548 Vlast_event_frame = internal_last_event_frame;
2549 /* If we report the quit char as an event,
2550 don't do so more than once. */
2551 if (!NILP (Vinhibit_quit))
2552 Vquit_flag = Qnil;
2555 KBOARD *kb = FRAME_KBOARD (XFRAME (selected_frame));
2556 if (kb != current_kboard)
2558 Lisp_Object last = KVAR (kb, kbd_queue);
2559 /* We shouldn't get here if we were in single-kboard mode! */
2560 if (single_kboard)
2561 abort ();
2562 if (CONSP (last))
2564 while (CONSP (XCDR (last)))
2565 last = XCDR (last);
2566 if (!NILP (XCDR (last)))
2567 abort ();
2569 if (!CONSP (last))
2570 KVAR (kb, kbd_queue) = Fcons (c, Qnil);
2571 else
2572 XSETCDR (last, Fcons (c, Qnil));
2573 kb->kbd_queue_has_data = 1;
2574 current_kboard = kb;
2575 /* This is going to exit from read_char
2576 so we had better get rid of this frame's stuff. */
2577 UNGCPRO;
2578 return make_number (-2); /* wrong_kboard_jmpbuf */
2581 goto non_reread;
2584 /* Start idle timers if no time limit is supplied. We don't do it
2585 if a time limit is supplied to avoid an infinite recursion in the
2586 situation where an idle timer calls `sit-for'. */
2588 if (!end_time)
2589 timer_start_idle ();
2591 /* If in middle of key sequence and minibuffer not active,
2592 start echoing if enough time elapses. */
2594 if (minibuf_level == 0
2595 && !end_time
2596 && !current_kboard->immediate_echo
2597 && this_command_key_count > 0
2598 && ! noninteractive
2599 && (FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
2600 && NILP (Fzerop (Vecho_keystrokes))
2601 && (/* No message. */
2602 NILP (echo_area_buffer[0])
2603 /* Or empty message. */
2604 || (BUF_BEG (XBUFFER (echo_area_buffer[0]))
2605 == BUF_Z (XBUFFER (echo_area_buffer[0])))
2606 /* Or already echoing from same kboard. */
2607 || (echo_kboard && ok_to_echo_at_next_pause == echo_kboard)
2608 /* Or not echoing before and echoing allowed. */
2609 || (!echo_kboard && ok_to_echo_at_next_pause)))
2611 /* After a mouse event, start echoing right away.
2612 This is because we are probably about to display a menu,
2613 and we don't want to delay before doing so. */
2614 if (EVENT_HAS_PARAMETERS (prev_event))
2615 echo_now ();
2616 else
2618 Lisp_Object tem0;
2620 save_getcjmp (save_jump);
2621 restore_getcjmp (local_getcjmp);
2622 tem0 = sit_for (Vecho_keystrokes, 1, 1);
2623 restore_getcjmp (save_jump);
2624 if (EQ (tem0, Qt)
2625 && ! CONSP (Vunread_command_events))
2626 echo_now ();
2630 /* Maybe auto save due to number of keystrokes. */
2632 if (commandflag != 0
2633 && auto_save_interval > 0
2634 && num_nonmacro_input_events - last_auto_save > max (auto_save_interval, 20)
2635 && !detect_input_pending_run_timers (0))
2637 Fdo_auto_save (Qnil, Qnil);
2638 /* Hooks can actually change some buffers in auto save. */
2639 redisplay ();
2642 /* Try reading using an X menu.
2643 This is never confused with reading using the minibuf
2644 because the recursive call of read_char in read_char_minibuf_menu_prompt
2645 does not pass on any keymaps. */
2647 if (nmaps > 0 && INTERACTIVE
2648 && !NILP (prev_event)
2649 && EVENT_HAS_PARAMETERS (prev_event)
2650 && !EQ (XCAR (prev_event), Qmenu_bar)
2651 && !EQ (XCAR (prev_event), Qtool_bar)
2652 /* Don't bring up a menu if we already have another event. */
2653 && NILP (Vunread_command_events)
2654 && unread_command_char < 0)
2656 c = read_char_x_menu_prompt (nmaps, maps, prev_event, used_mouse_menu);
2658 /* Now that we have read an event, Emacs is not idle. */
2659 if (!end_time)
2660 timer_stop_idle ();
2662 goto exit;
2665 /* Maybe autosave and/or garbage collect due to idleness. */
2667 if (INTERACTIVE && NILP (c))
2669 int delay_level;
2670 ptrdiff_t buffer_size;
2672 /* Slow down auto saves logarithmically in size of current buffer,
2673 and garbage collect while we're at it. */
2674 if (! MINI_WINDOW_P (XWINDOW (selected_window)))
2675 last_non_minibuf_size = Z - BEG;
2676 buffer_size = (last_non_minibuf_size >> 8) + 1;
2677 delay_level = 0;
2678 while (buffer_size > 64)
2679 delay_level++, buffer_size -= buffer_size >> 2;
2680 if (delay_level < 4) delay_level = 4;
2681 /* delay_level is 4 for files under around 50k, 7 at 100k,
2682 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2684 /* Auto save if enough time goes by without input. */
2685 if (commandflag != 0
2686 && num_nonmacro_input_events > last_auto_save
2687 && INTEGERP (Vauto_save_timeout)
2688 && XINT (Vauto_save_timeout) > 0)
2690 Lisp_Object tem0;
2691 EMACS_INT timeout = (delay_level
2692 * min (XFASTINT (Vauto_save_timeout) / 4,
2693 MOST_POSITIVE_FIXNUM / delay_level));
2694 save_getcjmp (save_jump);
2695 restore_getcjmp (local_getcjmp);
2696 tem0 = sit_for (make_number (timeout), 1, 1);
2697 restore_getcjmp (save_jump);
2699 if (EQ (tem0, Qt)
2700 && ! CONSP (Vunread_command_events))
2702 Fdo_auto_save (Qnil, Qnil);
2704 /* If we have auto-saved and there is still no input
2705 available, garbage collect if there has been enough
2706 consing going on to make it worthwhile. */
2707 if (!detect_input_pending_run_timers (0)
2708 && consing_since_gc > gc_cons_threshold / 2)
2709 Fgarbage_collect ();
2711 redisplay ();
2716 /* Notify the caller if an autosave hook, or a timer, sentinel or
2717 filter in the sit_for calls above have changed the current
2718 kboard. This could happen if they use the minibuffer or start a
2719 recursive edit, like the fancy splash screen in server.el's
2720 filter. If this longjmp wasn't here, read_key_sequence would
2721 interpret the next key sequence using the wrong translation
2722 tables and function keymaps. */
2723 if (NILP (c) && current_kboard != orig_kboard)
2725 UNGCPRO;
2726 return make_number (-2); /* wrong_kboard_jmpbuf */
2729 /* If this has become non-nil here, it has been set by a timer
2730 or sentinel or filter. */
2731 if (CONSP (Vunread_command_events))
2733 c = XCAR (Vunread_command_events);
2734 Vunread_command_events = XCDR (Vunread_command_events);
2737 /* Read something from current KBOARD's side queue, if possible. */
2739 if (NILP (c))
2741 if (current_kboard->kbd_queue_has_data)
2743 if (!CONSP (KVAR (current_kboard, kbd_queue)))
2744 abort ();
2745 c = XCAR (KVAR (current_kboard, kbd_queue));
2746 KVAR (current_kboard, kbd_queue)
2747 = XCDR (KVAR (current_kboard, kbd_queue));
2748 if (NILP (KVAR (current_kboard, kbd_queue)))
2749 current_kboard->kbd_queue_has_data = 0;
2750 input_pending = readable_events (0);
2751 if (EVENT_HAS_PARAMETERS (c)
2752 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qswitch_frame))
2753 internal_last_event_frame = XCAR (XCDR (c));
2754 Vlast_event_frame = internal_last_event_frame;
2758 /* If current_kboard's side queue is empty check the other kboards.
2759 If one of them has data that we have not yet seen here,
2760 switch to it and process the data waiting for it.
2762 Note: if the events queued up for another kboard
2763 have already been seen here, and therefore are not a complete command,
2764 the kbd_queue_has_data field is 0, so we skip that kboard here.
2765 That's to avoid an infinite loop switching between kboards here. */
2766 if (NILP (c) && !single_kboard)
2768 KBOARD *kb;
2769 for (kb = all_kboards; kb; kb = kb->next_kboard)
2770 if (kb->kbd_queue_has_data)
2772 current_kboard = kb;
2773 /* This is going to exit from read_char
2774 so we had better get rid of this frame's stuff. */
2775 UNGCPRO;
2776 return make_number (-2); /* wrong_kboard_jmpbuf */
2780 wrong_kboard:
2782 STOP_POLLING;
2784 /* Finally, we read from the main queue,
2785 and if that gives us something we can't use yet, we put it on the
2786 appropriate side queue and try again. */
2788 if (NILP (c))
2790 KBOARD *kb IF_LINT (= NULL);
2792 if (end_time)
2794 EMACS_TIME now;
2795 EMACS_GET_TIME (now);
2796 if (EMACS_TIME_GE (now, *end_time))
2797 goto exit;
2800 /* Actually read a character, waiting if necessary. */
2801 save_getcjmp (save_jump);
2802 restore_getcjmp (local_getcjmp);
2803 if (!end_time)
2804 timer_start_idle ();
2805 c = kbd_buffer_get_event (&kb, used_mouse_menu, end_time);
2806 restore_getcjmp (save_jump);
2808 if (! NILP (c) && (kb != current_kboard))
2810 Lisp_Object last = KVAR (kb, kbd_queue);
2811 if (CONSP (last))
2813 while (CONSP (XCDR (last)))
2814 last = XCDR (last);
2815 if (!NILP (XCDR (last)))
2816 abort ();
2818 if (!CONSP (last))
2819 KVAR (kb, kbd_queue) = Fcons (c, Qnil);
2820 else
2821 XSETCDR (last, Fcons (c, Qnil));
2822 kb->kbd_queue_has_data = 1;
2823 c = Qnil;
2824 if (single_kboard)
2825 goto wrong_kboard;
2826 current_kboard = kb;
2827 /* This is going to exit from read_char
2828 so we had better get rid of this frame's stuff. */
2829 UNGCPRO;
2830 return make_number (-2);
2834 /* Terminate Emacs in batch mode if at eof. */
2835 if (noninteractive && INTEGERP (c) && XINT (c) < 0)
2836 Fkill_emacs (make_number (1));
2838 if (INTEGERP (c))
2840 /* Add in any extra modifiers, where appropriate. */
2841 if ((extra_keyboard_modifiers & CHAR_CTL)
2842 || ((extra_keyboard_modifiers & 0177) < ' '
2843 && (extra_keyboard_modifiers & 0177) != 0))
2844 XSETINT (c, make_ctrl_char (XINT (c)));
2846 /* Transfer any other modifier bits directly from
2847 extra_keyboard_modifiers to c. Ignore the actual character code
2848 in the low 16 bits of extra_keyboard_modifiers. */
2849 XSETINT (c, XINT (c) | (extra_keyboard_modifiers & ~0xff7f & ~CHAR_CTL));
2852 non_reread:
2854 if (!end_time)
2855 timer_stop_idle ();
2856 RESUME_POLLING;
2858 if (NILP (c))
2860 if (commandflag >= 0
2861 && !input_pending && !detect_input_pending_run_timers (0))
2862 redisplay ();
2864 goto wrong_kboard;
2867 non_reread_1:
2869 /* Buffer switch events are only for internal wakeups
2870 so don't show them to the user.
2871 Also, don't record a key if we already did. */
2872 if (BUFFERP (c) || key_already_recorded)
2873 goto exit;
2875 /* Process special events within read_char
2876 and loop around to read another event. */
2877 save = Vquit_flag;
2878 Vquit_flag = Qnil;
2879 tem = access_keymap (get_keymap (Vspecial_event_map, 0, 1), c, 0, 0, 1);
2880 Vquit_flag = save;
2882 if (!NILP (tem))
2884 struct buffer *prev_buffer = current_buffer;
2885 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2886 int was_locked = single_kboard;
2887 ptrdiff_t count = SPECPDL_INDEX ();
2888 record_single_kboard_state ();
2889 #endif
2891 last_input_event = c;
2892 Fcommand_execute (tem, Qnil, Fvector (1, &last_input_event), Qt);
2894 if (CONSP (c) && EQ (XCAR (c), Qselect_window) && !end_time)
2895 /* We stopped being idle for this event; undo that. This
2896 prevents automatic window selection (under
2897 mouse_autoselect_window from acting as a real input event, for
2898 example banishing the mouse under mouse-avoidance-mode. */
2899 timer_resume_idle ();
2901 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2902 /* Resume allowing input from any kboard, if that was true before. */
2903 if (!was_locked)
2904 any_kboard_state ();
2905 unbind_to (count, Qnil);
2906 #endif
2908 if (current_buffer != prev_buffer)
2910 /* The command may have changed the keymaps. Pretend there
2911 is input in another keyboard and return. This will
2912 recalculate keymaps. */
2913 c = make_number (-2);
2914 goto exit;
2916 else
2917 goto retry;
2920 /* Handle things that only apply to characters. */
2921 if (INTEGERP (c))
2923 /* If kbd_buffer_get_event gave us an EOF, return that. */
2924 if (XINT (c) == -1)
2925 goto exit;
2927 if ((STRINGP (KVAR (current_kboard, Vkeyboard_translate_table))
2928 && UNSIGNED_CMP (XFASTINT (c), <,
2929 SCHARS (KVAR (current_kboard,
2930 Vkeyboard_translate_table))))
2931 || (VECTORP (KVAR (current_kboard, Vkeyboard_translate_table))
2932 && UNSIGNED_CMP (XFASTINT (c), <,
2933 ASIZE (KVAR (current_kboard,
2934 Vkeyboard_translate_table))))
2935 || (CHAR_TABLE_P (KVAR (current_kboard, Vkeyboard_translate_table))
2936 && CHARACTERP (c)))
2938 Lisp_Object d;
2939 d = Faref (KVAR (current_kboard, Vkeyboard_translate_table), c);
2940 /* nil in keyboard-translate-table means no translation. */
2941 if (!NILP (d))
2942 c = d;
2946 /* If this event is a mouse click in the menu bar,
2947 return just menu-bar for now. Modify the mouse click event
2948 so we won't do this twice, then queue it up. */
2949 if (EVENT_HAS_PARAMETERS (c)
2950 && CONSP (XCDR (c))
2951 && CONSP (EVENT_START (c))
2952 && CONSP (XCDR (EVENT_START (c))))
2954 Lisp_Object posn;
2956 posn = POSN_POSN (EVENT_START (c));
2957 /* Handle menu-bar events:
2958 insert the dummy prefix event `menu-bar'. */
2959 if (EQ (posn, Qmenu_bar) || EQ (posn, Qtool_bar))
2961 /* Change menu-bar to (menu-bar) as the event "position". */
2962 POSN_SET_POSN (EVENT_START (c), Fcons (posn, Qnil));
2964 also_record = c;
2965 Vunread_command_events = Fcons (c, Vunread_command_events);
2966 c = posn;
2970 /* Store these characters into recent_keys, the dribble file if any,
2971 and the keyboard macro being defined, if any. */
2972 record_char (c);
2973 if (! NILP (also_record))
2974 record_char (also_record);
2976 /* Wipe the echo area.
2977 But first, if we are about to use an input method,
2978 save the echo area contents for it to refer to. */
2979 if (INTEGERP (c)
2980 && ! NILP (Vinput_method_function)
2981 && ' ' <= XINT (c) && XINT (c) < 256 && XINT (c) != 127)
2983 previous_echo_area_message = Fcurrent_message ();
2984 Vinput_method_previous_message = previous_echo_area_message;
2987 /* Now wipe the echo area, except for help events which do their
2988 own stuff with the echo area. */
2989 if (!CONSP (c)
2990 || (!(EQ (Qhelp_echo, XCAR (c)))
2991 && !(EQ (Qswitch_frame, XCAR (c)))
2992 /* Don't wipe echo area for select window events: These might
2993 get delayed via `mouse-autoselect-window' (Bug#11304). */
2994 && !(EQ (Qselect_window, XCAR (c)))))
2996 if (!NILP (echo_area_buffer[0]))
2998 safe_run_hooks (Qecho_area_clear_hook);
2999 clear_message (1, 0);
3003 reread_for_input_method:
3004 from_macro:
3005 /* Pass this to the input method, if appropriate. */
3006 if (INTEGERP (c)
3007 && ! NILP (Vinput_method_function)
3008 /* Don't run the input method within a key sequence,
3009 after the first event of the key sequence. */
3010 && NILP (prev_event)
3011 && ' ' <= XINT (c) && XINT (c) < 256 && XINT (c) != 127)
3013 Lisp_Object keys;
3014 ptrdiff_t key_count;
3015 int key_count_reset;
3016 struct gcpro gcpro1;
3017 ptrdiff_t count = SPECPDL_INDEX ();
3019 /* Save the echo status. */
3020 int saved_immediate_echo = current_kboard->immediate_echo;
3021 struct kboard *saved_ok_to_echo = ok_to_echo_at_next_pause;
3022 Lisp_Object saved_echo_string = KVAR (current_kboard, echo_string);
3023 int saved_echo_after_prompt = current_kboard->echo_after_prompt;
3025 #if 0
3026 if (before_command_restore_flag)
3028 this_command_key_count = before_command_key_count_1;
3029 if (this_command_key_count < this_single_command_key_start)
3030 this_single_command_key_start = this_command_key_count;
3031 echo_truncate (before_command_echo_length_1);
3032 before_command_restore_flag = 0;
3034 #endif
3036 /* Save the this_command_keys status. */
3037 key_count = this_command_key_count;
3038 key_count_reset = this_command_key_count_reset;
3040 if (key_count > 0)
3041 keys = Fcopy_sequence (this_command_keys);
3042 else
3043 keys = Qnil;
3044 GCPRO1 (keys);
3046 /* Clear out this_command_keys. */
3047 this_command_key_count = 0;
3048 this_command_key_count_reset = 0;
3050 /* Now wipe the echo area. */
3051 if (!NILP (echo_area_buffer[0]))
3052 safe_run_hooks (Qecho_area_clear_hook);
3053 clear_message (1, 0);
3054 echo_truncate (0);
3056 /* If we are not reading a key sequence,
3057 never use the echo area. */
3058 if (maps == 0)
3060 specbind (Qinput_method_use_echo_area, Qt);
3063 /* Call the input method. */
3064 tem = call1 (Vinput_method_function, c);
3066 tem = unbind_to (count, tem);
3068 /* Restore the saved echoing state
3069 and this_command_keys state. */
3070 this_command_key_count = key_count;
3071 this_command_key_count_reset = key_count_reset;
3072 if (key_count > 0)
3073 this_command_keys = keys;
3075 cancel_echoing ();
3076 ok_to_echo_at_next_pause = saved_ok_to_echo;
3077 KVAR (current_kboard, echo_string) = saved_echo_string;
3078 current_kboard->echo_after_prompt = saved_echo_after_prompt;
3079 if (saved_immediate_echo)
3080 echo_now ();
3082 UNGCPRO;
3084 /* The input method can return no events. */
3085 if (! CONSP (tem))
3087 /* Bring back the previous message, if any. */
3088 if (! NILP (previous_echo_area_message))
3089 message_with_string ("%s", previous_echo_area_message, 0);
3090 goto retry;
3092 /* It returned one event or more. */
3093 c = XCAR (tem);
3094 Vunread_post_input_method_events
3095 = nconc2 (XCDR (tem), Vunread_post_input_method_events);
3098 reread_first:
3100 /* Display help if not echoing. */
3101 if (CONSP (c) && EQ (XCAR (c), Qhelp_echo))
3103 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3104 Lisp_Object help, object, position, window, htem;
3106 htem = Fcdr (XCDR (c));
3107 help = Fcar (htem);
3108 htem = Fcdr (htem);
3109 window = Fcar (htem);
3110 htem = Fcdr (htem);
3111 object = Fcar (htem);
3112 htem = Fcdr (htem);
3113 position = Fcar (htem);
3115 show_help_echo (help, window, object, position);
3117 /* We stopped being idle for this event; undo that. */
3118 if (!end_time)
3119 timer_resume_idle ();
3120 goto retry;
3123 if ((! reread || this_command_key_count == 0
3124 || this_command_key_count_reset)
3125 && !end_time)
3128 /* Don't echo mouse motion events. */
3129 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
3130 && NILP (Fzerop (Vecho_keystrokes))
3131 && ! (EVENT_HAS_PARAMETERS (c)
3132 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
3134 echo_char (c);
3135 if (! NILP (also_record))
3136 echo_char (also_record);
3137 /* Once we reread a character, echoing can happen
3138 the next time we pause to read a new one. */
3139 ok_to_echo_at_next_pause = current_kboard;
3142 /* Record this character as part of the current key. */
3143 add_command_key (c);
3144 if (! NILP (also_record))
3145 add_command_key (also_record);
3148 last_input_event = c;
3149 num_input_events++;
3151 /* Process the help character specially if enabled */
3152 if (!NILP (Vhelp_form) && help_char_p (c))
3154 ptrdiff_t count = SPECPDL_INDEX ();
3156 help_form_saved_window_configs
3157 = Fcons (Fcurrent_window_configuration (Qnil),
3158 help_form_saved_window_configs);
3159 record_unwind_protect (read_char_help_form_unwind, Qnil);
3160 call0 (Qhelp_form_show);
3162 cancel_echoing ();
3165 c = read_char (0, 0, 0, Qnil, 0, NULL);
3166 if (EVENT_HAS_PARAMETERS (c)
3167 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_click))
3168 XSETCAR (help_form_saved_window_configs, Qnil);
3170 while (BUFFERP (c));
3171 /* Remove the help from the frame */
3172 unbind_to (count, Qnil);
3174 redisplay ();
3175 if (EQ (c, make_number (040)))
3177 cancel_echoing ();
3179 c = read_char (0, 0, 0, Qnil, 0, NULL);
3180 while (BUFFERP (c));
3184 exit:
3185 RESUME_POLLING;
3186 RETURN_UNGCPRO (c);
3189 /* Record a key that came from a mouse menu.
3190 Record it for echoing, for this-command-keys, and so on. */
3192 static void
3193 record_menu_key (Lisp_Object c)
3195 /* Wipe the echo area. */
3196 clear_message (1, 0);
3198 record_char (c);
3200 #if 0
3201 before_command_key_count = this_command_key_count;
3202 before_command_echo_length = echo_length ();
3203 #endif
3205 /* Don't echo mouse motion events. */
3206 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
3207 && NILP (Fzerop (Vecho_keystrokes)))
3209 echo_char (c);
3211 /* Once we reread a character, echoing can happen
3212 the next time we pause to read a new one. */
3213 ok_to_echo_at_next_pause = 0;
3216 /* Record this character as part of the current key. */
3217 add_command_key (c);
3219 /* Re-reading in the middle of a command */
3220 last_input_event = c;
3221 num_input_events++;
3224 /* Return 1 if should recognize C as "the help character". */
3226 static int
3227 help_char_p (Lisp_Object c)
3229 Lisp_Object tail;
3231 if (EQ (c, Vhelp_char))
3232 return 1;
3233 for (tail = Vhelp_event_list; CONSP (tail); tail = XCDR (tail))
3234 if (EQ (c, XCAR (tail)))
3235 return 1;
3236 return 0;
3239 /* Record the input event C in various ways. */
3241 static void
3242 record_char (Lisp_Object c)
3244 int recorded = 0;
3246 if (CONSP (c) && (EQ (XCAR (c), Qhelp_echo) || EQ (XCAR (c), Qmouse_movement)))
3248 /* To avoid filling recent_keys with help-echo and mouse-movement
3249 events, we filter out repeated help-echo events, only store the
3250 first and last in a series of mouse-movement events, and don't
3251 store repeated help-echo events which are only separated by
3252 mouse-movement events. */
3254 Lisp_Object ev1, ev2, ev3;
3255 int ix1, ix2, ix3;
3257 if ((ix1 = recent_keys_index - 1) < 0)
3258 ix1 = NUM_RECENT_KEYS - 1;
3259 ev1 = AREF (recent_keys, ix1);
3261 if ((ix2 = ix1 - 1) < 0)
3262 ix2 = NUM_RECENT_KEYS - 1;
3263 ev2 = AREF (recent_keys, ix2);
3265 if ((ix3 = ix2 - 1) < 0)
3266 ix3 = NUM_RECENT_KEYS - 1;
3267 ev3 = AREF (recent_keys, ix3);
3269 if (EQ (XCAR (c), Qhelp_echo))
3271 /* Don't record `help-echo' in recent_keys unless it shows some help
3272 message, and a different help than the previously recorded
3273 event. */
3274 Lisp_Object help, last_help;
3276 help = Fcar_safe (Fcdr_safe (XCDR (c)));
3277 if (!STRINGP (help))
3278 recorded = 1;
3279 else if (CONSP (ev1) && EQ (XCAR (ev1), Qhelp_echo)
3280 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev1))), EQ (last_help, help)))
3281 recorded = 1;
3282 else if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3283 && CONSP (ev2) && EQ (XCAR (ev2), Qhelp_echo)
3284 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev2))), EQ (last_help, help)))
3285 recorded = -1;
3286 else if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3287 && CONSP (ev2) && EQ (XCAR (ev2), Qmouse_movement)
3288 && CONSP (ev3) && EQ (XCAR (ev3), Qhelp_echo)
3289 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev3))), EQ (last_help, help)))
3290 recorded = -2;
3292 else if (EQ (XCAR (c), Qmouse_movement))
3294 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3295 So additional mouse movement events replace the last element. */
3296 Lisp_Object last_window, window;
3298 window = Fcar_safe (Fcar_safe (XCDR (c)));
3299 if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3300 && (last_window = Fcar_safe (Fcar_safe (XCDR (ev1))), EQ (last_window, window))
3301 && CONSP (ev2) && EQ (XCAR (ev2), Qmouse_movement)
3302 && (last_window = Fcar_safe (Fcar_safe (XCDR (ev2))), EQ (last_window, window)))
3304 ASET (recent_keys, ix1, c);
3305 recorded = 1;
3309 else
3310 store_kbd_macro_char (c);
3312 if (!recorded)
3314 total_keys += total_keys < NUM_RECENT_KEYS;
3315 ASET (recent_keys, recent_keys_index, c);
3316 if (++recent_keys_index >= NUM_RECENT_KEYS)
3317 recent_keys_index = 0;
3319 else if (recorded < 0)
3321 /* We need to remove one or two events from recent_keys.
3322 To do this, we simply put nil at those events and move the
3323 recent_keys_index backwards over those events. Usually,
3324 users will never see those nil events, as they will be
3325 overwritten by the command keys entered to see recent_keys
3326 (e.g. C-h l). */
3328 while (recorded++ < 0 && total_keys > 0)
3330 if (total_keys < NUM_RECENT_KEYS)
3331 total_keys--;
3332 if (--recent_keys_index < 0)
3333 recent_keys_index = NUM_RECENT_KEYS - 1;
3334 ASET (recent_keys, recent_keys_index, Qnil);
3338 num_nonmacro_input_events++;
3340 /* Write c to the dribble file. If c is a lispy event, write
3341 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3342 If you, dear reader, have a better idea, you've got the source. :-) */
3343 if (dribble)
3345 BLOCK_INPUT;
3346 if (INTEGERP (c))
3348 if (XUINT (c) < 0x100)
3349 putc (XUINT (c), dribble);
3350 else
3351 fprintf (dribble, " 0x%"pI"x", XUINT (c));
3353 else
3355 Lisp_Object dribblee;
3357 /* If it's a structured event, take the event header. */
3358 dribblee = EVENT_HEAD (c);
3360 if (SYMBOLP (dribblee))
3362 putc ('<', dribble);
3363 fwrite (SDATA (SYMBOL_NAME (dribblee)), sizeof (char),
3364 SBYTES (SYMBOL_NAME (dribblee)),
3365 dribble);
3366 putc ('>', dribble);
3370 fflush (dribble);
3371 UNBLOCK_INPUT;
3375 /* Copy out or in the info on where C-g should throw to.
3376 This is used when running Lisp code from within get_char,
3377 in case get_char is called recursively.
3378 See read_process_output. */
3380 static void
3381 save_getcjmp (jmp_buf temp)
3383 memcpy (temp, getcjmp, sizeof getcjmp);
3386 static void
3387 restore_getcjmp (jmp_buf temp)
3389 memcpy (getcjmp, temp, sizeof getcjmp);
3392 /* Low level keyboard/mouse input.
3393 kbd_buffer_store_event places events in kbd_buffer, and
3394 kbd_buffer_get_event retrieves them. */
3396 /* Return true if there are any events in the queue that read-char
3397 would return. If this returns false, a read-char would block. */
3398 static int
3399 readable_events (int flags)
3401 if (flags & READABLE_EVENTS_DO_TIMERS_NOW)
3402 timer_check ();
3404 /* If the buffer contains only FOCUS_IN_EVENT events, and
3405 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3406 if (kbd_fetch_ptr != kbd_store_ptr)
3408 if (flags & (READABLE_EVENTS_FILTER_EVENTS
3409 #ifdef USE_TOOLKIT_SCROLL_BARS
3410 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3411 #endif
3414 struct input_event *event;
3416 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
3417 ? kbd_fetch_ptr
3418 : kbd_buffer);
3422 if (!(
3423 #ifdef USE_TOOLKIT_SCROLL_BARS
3424 (flags & READABLE_EVENTS_FILTER_EVENTS) &&
3425 #endif
3426 event->kind == FOCUS_IN_EVENT)
3427 #ifdef USE_TOOLKIT_SCROLL_BARS
3428 && !((flags & READABLE_EVENTS_IGNORE_SQUEEZABLES)
3429 && event->kind == SCROLL_BAR_CLICK_EVENT
3430 && event->part == scroll_bar_handle
3431 && event->modifiers == 0)
3432 #endif
3434 return 1;
3435 event++;
3436 if (event == kbd_buffer + KBD_BUFFER_SIZE)
3437 event = kbd_buffer;
3439 while (event != kbd_store_ptr);
3441 else
3442 return 1;
3445 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3446 if (!(flags & READABLE_EVENTS_IGNORE_SQUEEZABLES)
3447 && !NILP (do_mouse_tracking) && some_mouse_moved ())
3448 return 1;
3449 #endif
3450 if (single_kboard)
3452 if (current_kboard->kbd_queue_has_data)
3453 return 1;
3455 else
3457 KBOARD *kb;
3458 for (kb = all_kboards; kb; kb = kb->next_kboard)
3459 if (kb->kbd_queue_has_data)
3460 return 1;
3462 return 0;
3465 /* Set this for debugging, to have a way to get out */
3466 int stop_character EXTERNALLY_VISIBLE;
3468 static KBOARD *
3469 event_to_kboard (struct input_event *event)
3471 Lisp_Object frame;
3472 frame = event->frame_or_window;
3473 if (CONSP (frame))
3474 frame = XCAR (frame);
3475 else if (WINDOWP (frame))
3476 frame = WINDOW_FRAME (XWINDOW (frame));
3478 /* There are still some events that don't set this field.
3479 For now, just ignore the problem.
3480 Also ignore dead frames here. */
3481 if (!FRAMEP (frame) || !FRAME_LIVE_P (XFRAME (frame)))
3482 return 0;
3483 else
3484 return FRAME_KBOARD (XFRAME (frame));
3487 #ifdef subprocesses
3488 /* Return the number of slots occupied in kbd_buffer. */
3490 static int
3491 kbd_buffer_nr_stored (void)
3493 return kbd_fetch_ptr == kbd_store_ptr
3495 : (kbd_fetch_ptr < kbd_store_ptr
3496 ? kbd_store_ptr - kbd_fetch_ptr
3497 : ((kbd_buffer + KBD_BUFFER_SIZE) - kbd_fetch_ptr
3498 + (kbd_store_ptr - kbd_buffer)));
3500 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3502 void
3503 kbd_buffer_store_event (register struct input_event *event)
3505 kbd_buffer_store_event_hold (event, 0);
3508 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3510 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3511 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3512 Else, if EVENT is a quit event, store the quit event
3513 in HOLD_QUIT, and return (thus ignoring further events).
3515 This is used in read_avail_input to postpone the processing
3516 of the quit event until all subsequent input events have been
3517 parsed (and discarded).
3520 void
3521 kbd_buffer_store_event_hold (register struct input_event *event,
3522 struct input_event *hold_quit)
3524 if (event->kind == NO_EVENT)
3525 abort ();
3527 if (hold_quit && hold_quit->kind != NO_EVENT)
3528 return;
3530 if (event->kind == ASCII_KEYSTROKE_EVENT)
3532 register int c = event->code & 0377;
3534 if (event->modifiers & ctrl_modifier)
3535 c = make_ctrl_char (c);
3537 c |= (event->modifiers
3538 & (meta_modifier | alt_modifier
3539 | hyper_modifier | super_modifier));
3541 if (c == quit_char)
3543 KBOARD *kb = FRAME_KBOARD (XFRAME (event->frame_or_window));
3544 struct input_event *sp;
3546 if (single_kboard && kb != current_kboard)
3548 KVAR (kb, kbd_queue)
3549 = Fcons (make_lispy_switch_frame (event->frame_or_window),
3550 Fcons (make_number (c), Qnil));
3551 kb->kbd_queue_has_data = 1;
3552 for (sp = kbd_fetch_ptr; sp != kbd_store_ptr; sp++)
3554 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3555 sp = kbd_buffer;
3557 if (event_to_kboard (sp) == kb)
3559 sp->kind = NO_EVENT;
3560 sp->frame_or_window = Qnil;
3561 sp->arg = Qnil;
3564 return;
3567 if (hold_quit)
3569 memcpy (hold_quit, event, sizeof (*event));
3570 return;
3573 /* If this results in a quit_char being returned to Emacs as
3574 input, set Vlast_event_frame properly. If this doesn't
3575 get returned to Emacs as an event, the next event read
3576 will set Vlast_event_frame again, so this is safe to do. */
3578 Lisp_Object focus;
3580 focus = FRAME_FOCUS_FRAME (XFRAME (event->frame_or_window));
3581 if (NILP (focus))
3582 focus = event->frame_or_window;
3583 internal_last_event_frame = focus;
3584 Vlast_event_frame = focus;
3587 last_event_timestamp = event->timestamp;
3588 handle_interrupt ();
3589 return;
3592 if (c && c == stop_character)
3594 sys_suspend ();
3595 return;
3598 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3599 Just ignore the second one. */
3600 else if (event->kind == BUFFER_SWITCH_EVENT
3601 && kbd_fetch_ptr != kbd_store_ptr
3602 && ((kbd_store_ptr == kbd_buffer
3603 ? kbd_buffer + KBD_BUFFER_SIZE - 1
3604 : kbd_store_ptr - 1)->kind) == BUFFER_SWITCH_EVENT)
3605 return;
3607 if (kbd_store_ptr - kbd_buffer == KBD_BUFFER_SIZE)
3608 kbd_store_ptr = kbd_buffer;
3610 /* Don't let the very last slot in the buffer become full,
3611 since that would make the two pointers equal,
3612 and that is indistinguishable from an empty buffer.
3613 Discard the event if it would fill the last slot. */
3614 if (kbd_fetch_ptr - 1 != kbd_store_ptr)
3616 *kbd_store_ptr = *event;
3617 ++kbd_store_ptr;
3618 #ifdef subprocesses
3619 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE/2 && ! kbd_on_hold_p ())
3621 /* Don't read keyboard input until we have processed kbd_buffer.
3622 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3623 hold_keyboard_input ();
3624 #ifdef SIGIO
3625 if (!noninteractive)
3626 signal (SIGIO, SIG_IGN);
3627 #endif
3628 stop_polling ();
3630 #endif /* subprocesses */
3633 /* If we're inside while-no-input, and this event qualifies
3634 as input, set quit-flag to cause an interrupt. */
3635 if (!NILP (Vthrow_on_input)
3636 && event->kind != FOCUS_IN_EVENT
3637 && event->kind != HELP_EVENT
3638 && event->kind != DEICONIFY_EVENT)
3640 Vquit_flag = Vthrow_on_input;
3641 /* If we're inside a function that wants immediate quits,
3642 do it now. */
3643 if (immediate_quit && NILP (Vinhibit_quit))
3645 immediate_quit = 0;
3646 sigfree ();
3647 QUIT;
3653 /* Put an input event back in the head of the event queue. */
3655 void
3656 kbd_buffer_unget_event (register struct input_event *event)
3658 if (kbd_fetch_ptr == kbd_buffer)
3659 kbd_fetch_ptr = kbd_buffer + KBD_BUFFER_SIZE;
3661 /* Don't let the very last slot in the buffer become full, */
3662 if (kbd_fetch_ptr - 1 != kbd_store_ptr)
3664 --kbd_fetch_ptr;
3665 *kbd_fetch_ptr = *event;
3670 /* Generate a HELP_EVENT input_event and store it in the keyboard
3671 buffer.
3673 HELP is the help form.
3675 FRAME and WINDOW are the frame and window where the help is
3676 generated. OBJECT is the Lisp object where the help was found (a
3677 buffer, a string, an overlay, or nil if neither from a string nor
3678 from a buffer). POS is the position within OBJECT where the help
3679 was found. */
3681 void
3682 gen_help_event (Lisp_Object help, Lisp_Object frame, Lisp_Object window,
3683 Lisp_Object object, ptrdiff_t pos)
3685 struct input_event event;
3687 EVENT_INIT (event);
3689 event.kind = HELP_EVENT;
3690 event.frame_or_window = frame;
3691 event.arg = object;
3692 event.x = WINDOWP (window) ? window : frame;
3693 event.y = help;
3694 event.code = pos;
3695 kbd_buffer_store_event (&event);
3699 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3701 void
3702 kbd_buffer_store_help_event (Lisp_Object frame, Lisp_Object help)
3704 struct input_event event;
3706 event.kind = HELP_EVENT;
3707 event.frame_or_window = frame;
3708 event.arg = Qnil;
3709 event.x = Qnil;
3710 event.y = help;
3711 event.code = 0;
3712 kbd_buffer_store_event (&event);
3716 /* Discard any mouse events in the event buffer by setting them to
3717 NO_EVENT. */
3718 void
3719 discard_mouse_events (void)
3721 struct input_event *sp;
3722 for (sp = kbd_fetch_ptr; sp != kbd_store_ptr; sp++)
3724 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3725 sp = kbd_buffer;
3727 if (sp->kind == MOUSE_CLICK_EVENT
3728 || sp->kind == WHEEL_EVENT
3729 || sp->kind == HORIZ_WHEEL_EVENT
3730 #ifdef HAVE_GPM
3731 || sp->kind == GPM_CLICK_EVENT
3732 #endif
3733 || sp->kind == SCROLL_BAR_CLICK_EVENT)
3735 sp->kind = NO_EVENT;
3741 /* Return non-zero if there are any real events waiting in the event
3742 buffer, not counting `NO_EVENT's.
3744 If DISCARD is non-zero, discard NO_EVENT events at the front of
3745 the input queue, possibly leaving the input queue empty if there
3746 are no real input events. */
3749 kbd_buffer_events_waiting (int discard)
3751 struct input_event *sp;
3753 for (sp = kbd_fetch_ptr;
3754 sp != kbd_store_ptr && sp->kind == NO_EVENT;
3755 ++sp)
3757 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3758 sp = kbd_buffer;
3761 if (discard)
3762 kbd_fetch_ptr = sp;
3764 return sp != kbd_store_ptr && sp->kind != NO_EVENT;
3768 /* Clear input event EVENT. */
3770 static inline void
3771 clear_event (struct input_event *event)
3773 event->kind = NO_EVENT;
3777 /* Read one event from the event buffer, waiting if necessary.
3778 The value is a Lisp object representing the event.
3779 The value is nil for an event that should be ignored,
3780 or that was handled here.
3781 We always read and discard one event. */
3783 static Lisp_Object
3784 kbd_buffer_get_event (KBOARD **kbp,
3785 int *used_mouse_menu,
3786 struct timeval *end_time)
3788 Lisp_Object obj;
3790 #ifdef subprocesses
3791 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE/4)
3793 /* Start reading input again, we have processed enough so we can
3794 accept new events again. */
3795 unhold_keyboard_input ();
3796 #ifdef SIGIO
3797 if (!noninteractive)
3798 signal (SIGIO, input_available_signal);
3799 #endif /* SIGIO */
3800 start_polling ();
3802 #endif /* subprocesses */
3804 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3805 if (noninteractive
3806 /* In case we are running as a daemon, only do this before
3807 detaching from the terminal. */
3808 || (IS_DAEMON && daemon_pipe[1] >= 0))
3810 int c = getchar ();
3811 XSETINT (obj, c);
3812 *kbp = current_kboard;
3813 return obj;
3815 #endif /* ! HAVE_DBUS */
3817 /* Wait until there is input available. */
3818 for (;;)
3820 /* Break loop if there's an unread command event. Needed in
3821 moused window autoselection which uses a timer to insert such
3822 events. */
3823 if (CONSP (Vunread_command_events))
3824 break;
3826 if (kbd_fetch_ptr != kbd_store_ptr)
3827 break;
3828 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3829 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
3830 break;
3831 #endif
3833 /* If the quit flag is set, then read_char will return
3834 quit_char, so that counts as "available input." */
3835 if (!NILP (Vquit_flag))
3836 quit_throw_to_read_char (0);
3838 /* One way or another, wait until input is available; then, if
3839 interrupt handlers have not read it, read it now. */
3841 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3842 #ifdef SIGIO
3843 gobble_input (0);
3844 #endif /* SIGIO */
3845 if (kbd_fetch_ptr != kbd_store_ptr)
3846 break;
3847 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3848 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
3849 break;
3850 #endif
3851 if (end_time)
3853 EMACS_TIME duration;
3854 EMACS_GET_TIME (duration);
3855 if (EMACS_TIME_GE (duration, *end_time))
3856 return Qnil; /* finished waiting */
3857 else
3859 EMACS_SUB_TIME (duration, *end_time, duration);
3860 wait_reading_process_output (EMACS_SECS (duration),
3861 EMACS_USECS (duration),
3862 -1, 1, Qnil, NULL, 0);
3865 else
3866 wait_reading_process_output (0, 0, -1, 1, Qnil, NULL, 0);
3868 if (!interrupt_input && kbd_fetch_ptr == kbd_store_ptr)
3869 /* Pass 1 for EXPECT since we just waited to have input. */
3870 read_avail_input (1);
3873 if (CONSP (Vunread_command_events))
3875 Lisp_Object first;
3876 first = XCAR (Vunread_command_events);
3877 Vunread_command_events = XCDR (Vunread_command_events);
3878 *kbp = current_kboard;
3879 return first;
3882 /* At this point, we know that there is a readable event available
3883 somewhere. If the event queue is empty, then there must be a
3884 mouse movement enabled and available. */
3885 if (kbd_fetch_ptr != kbd_store_ptr)
3887 struct input_event *event;
3889 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
3890 ? kbd_fetch_ptr
3891 : kbd_buffer);
3893 last_event_timestamp = event->timestamp;
3895 *kbp = event_to_kboard (event);
3896 if (*kbp == 0)
3897 *kbp = current_kboard; /* Better than returning null ptr? */
3899 obj = Qnil;
3901 /* These two kinds of events get special handling
3902 and don't actually appear to the command loop.
3903 We return nil for them. */
3904 if (event->kind == SELECTION_REQUEST_EVENT
3905 || event->kind == SELECTION_CLEAR_EVENT)
3907 #ifdef HAVE_X11
3908 struct input_event copy;
3910 /* Remove it from the buffer before processing it,
3911 since otherwise swallow_events will see it
3912 and process it again. */
3913 copy = *event;
3914 kbd_fetch_ptr = event + 1;
3915 input_pending = readable_events (0);
3916 x_handle_selection_event (&copy);
3917 #else
3918 /* We're getting selection request events, but we don't have
3919 a window system. */
3920 abort ();
3921 #endif
3924 #if defined (HAVE_NS)
3925 else if (event->kind == NS_TEXT_EVENT)
3927 if (event->code == KEY_NS_PUT_WORKING_TEXT)
3928 obj = Fcons (intern ("ns-put-working-text"), Qnil);
3929 else
3930 obj = Fcons (intern ("ns-unput-working-text"), Qnil);
3931 kbd_fetch_ptr = event + 1;
3932 if (used_mouse_menu)
3933 *used_mouse_menu = 1;
3935 #endif
3937 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3938 || defined (HAVE_NS)
3939 else if (event->kind == DELETE_WINDOW_EVENT)
3941 /* Make an event (delete-frame (FRAME)). */
3942 obj = Fcons (event->frame_or_window, Qnil);
3943 obj = Fcons (Qdelete_frame, Fcons (obj, Qnil));
3944 kbd_fetch_ptr = event + 1;
3946 #endif
3947 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3948 || defined (HAVE_NS)
3949 else if (event->kind == ICONIFY_EVENT)
3951 /* Make an event (iconify-frame (FRAME)). */
3952 obj = Fcons (event->frame_or_window, Qnil);
3953 obj = Fcons (Qiconify_frame, Fcons (obj, Qnil));
3954 kbd_fetch_ptr = event + 1;
3956 else if (event->kind == DEICONIFY_EVENT)
3958 /* Make an event (make-frame-visible (FRAME)). */
3959 obj = Fcons (event->frame_or_window, Qnil);
3960 obj = Fcons (Qmake_frame_visible, Fcons (obj, Qnil));
3961 kbd_fetch_ptr = event + 1;
3963 #endif
3964 else if (event->kind == BUFFER_SWITCH_EVENT)
3966 /* The value doesn't matter here; only the type is tested. */
3967 XSETBUFFER (obj, current_buffer);
3968 kbd_fetch_ptr = event + 1;
3970 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3971 || defined (HAVE_NS) || defined (USE_GTK)
3972 else if (event->kind == MENU_BAR_ACTIVATE_EVENT)
3974 kbd_fetch_ptr = event + 1;
3975 input_pending = readable_events (0);
3976 if (FRAME_LIVE_P (XFRAME (event->frame_or_window)))
3977 x_activate_menubar (XFRAME (event->frame_or_window));
3979 #endif
3980 #if defined (WINDOWSNT)
3981 else if (event->kind == LANGUAGE_CHANGE_EVENT)
3983 /* Make an event (language-change (FRAME CHARSET LCID)). */
3984 obj = Fcons (event->frame_or_window, Qnil);
3985 obj = Fcons (Qlanguage_change, Fcons (obj, Qnil));
3986 kbd_fetch_ptr = event + 1;
3988 #endif
3989 else if (event->kind == SAVE_SESSION_EVENT)
3991 obj = Fcons (Qsave_session, Fcons (event->arg, Qnil));
3992 kbd_fetch_ptr = event + 1;
3994 /* Just discard these, by returning nil.
3995 With MULTI_KBOARD, these events are used as placeholders
3996 when we need to randomly delete events from the queue.
3997 (They shouldn't otherwise be found in the buffer,
3998 but on some machines it appears they do show up
3999 even without MULTI_KBOARD.) */
4000 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4001 mouse events during a popup-menu call. */
4002 else if (event->kind == NO_EVENT)
4003 kbd_fetch_ptr = event + 1;
4004 else if (event->kind == HELP_EVENT)
4006 Lisp_Object object, position, help, frame, window;
4008 frame = event->frame_or_window;
4009 object = event->arg;
4010 position = make_number (event->code);
4011 window = event->x;
4012 help = event->y;
4013 clear_event (event);
4015 kbd_fetch_ptr = event + 1;
4016 if (!WINDOWP (window))
4017 window = Qnil;
4018 obj = Fcons (Qhelp_echo,
4019 list5 (frame, help, window, object, position));
4021 else if (event->kind == FOCUS_IN_EVENT)
4023 /* Notification of a FocusIn event. The frame receiving the
4024 focus is in event->frame_or_window. Generate a
4025 switch-frame event if necessary. */
4026 Lisp_Object frame, focus;
4028 frame = event->frame_or_window;
4029 focus = FRAME_FOCUS_FRAME (XFRAME (frame));
4030 if (FRAMEP (focus))
4031 frame = focus;
4033 if (!EQ (frame, internal_last_event_frame)
4034 && !EQ (frame, selected_frame))
4035 obj = make_lispy_switch_frame (frame);
4036 internal_last_event_frame = frame;
4037 kbd_fetch_ptr = event + 1;
4039 #ifdef HAVE_DBUS
4040 else if (event->kind == DBUS_EVENT)
4042 obj = make_lispy_event (event);
4043 kbd_fetch_ptr = event + 1;
4045 #endif
4046 else if (event->kind == CONFIG_CHANGED_EVENT)
4048 obj = make_lispy_event (event);
4049 kbd_fetch_ptr = event + 1;
4051 else
4053 /* If this event is on a different frame, return a switch-frame this
4054 time, and leave the event in the queue for next time. */
4055 Lisp_Object frame;
4056 Lisp_Object focus;
4058 frame = event->frame_or_window;
4059 if (CONSP (frame))
4060 frame = XCAR (frame);
4061 else if (WINDOWP (frame))
4062 frame = WINDOW_FRAME (XWINDOW (frame));
4064 focus = FRAME_FOCUS_FRAME (XFRAME (frame));
4065 if (! NILP (focus))
4066 frame = focus;
4068 if (! EQ (frame, internal_last_event_frame)
4069 && !EQ (frame, selected_frame))
4070 obj = make_lispy_switch_frame (frame);
4071 internal_last_event_frame = frame;
4073 /* If we didn't decide to make a switch-frame event, go ahead
4074 and build a real event from the queue entry. */
4076 if (NILP (obj))
4078 obj = make_lispy_event (event);
4080 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4081 || defined (HAVE_NS) || defined (USE_GTK)
4082 /* If this was a menu selection, then set the flag to inhibit
4083 writing to last_nonmenu_event. Don't do this if the event
4084 we're returning is (menu-bar), though; that indicates the
4085 beginning of the menu sequence, and we might as well leave
4086 that as the `event with parameters' for this selection. */
4087 if (used_mouse_menu
4088 && !EQ (event->frame_or_window, event->arg)
4089 && (event->kind == MENU_BAR_EVENT
4090 || event->kind == TOOL_BAR_EVENT))
4091 *used_mouse_menu = 1;
4092 #endif
4093 #ifdef HAVE_NS
4094 /* certain system events are non-key events */
4095 if (used_mouse_menu
4096 && event->kind == NS_NONKEY_EVENT)
4097 *used_mouse_menu = 1;
4098 #endif
4100 /* Wipe out this event, to catch bugs. */
4101 clear_event (event);
4102 kbd_fetch_ptr = event + 1;
4106 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4107 /* Try generating a mouse motion event. */
4108 else if (!NILP (do_mouse_tracking) && some_mouse_moved ())
4110 FRAME_PTR f = some_mouse_moved ();
4111 Lisp_Object bar_window;
4112 enum scroll_bar_part part;
4113 Lisp_Object x, y;
4114 Time t;
4116 *kbp = current_kboard;
4117 /* Note that this uses F to determine which terminal to look at.
4118 If there is no valid info, it does not store anything
4119 so x remains nil. */
4120 x = Qnil;
4122 /* XXX Can f or mouse_position_hook be NULL here? */
4123 if (f && FRAME_TERMINAL (f)->mouse_position_hook)
4124 (*FRAME_TERMINAL (f)->mouse_position_hook) (&f, 0, &bar_window,
4125 &part, &x, &y, &t);
4127 obj = Qnil;
4129 /* Decide if we should generate a switch-frame event. Don't
4130 generate switch-frame events for motion outside of all Emacs
4131 frames. */
4132 if (!NILP (x) && f)
4134 Lisp_Object frame;
4136 frame = FRAME_FOCUS_FRAME (f);
4137 if (NILP (frame))
4138 XSETFRAME (frame, f);
4140 if (! EQ (frame, internal_last_event_frame)
4141 && !EQ (frame, selected_frame))
4142 obj = make_lispy_switch_frame (frame);
4143 internal_last_event_frame = frame;
4146 /* If we didn't decide to make a switch-frame event, go ahead and
4147 return a mouse-motion event. */
4148 if (!NILP (x) && NILP (obj))
4149 obj = make_lispy_movement (f, bar_window, part, x, y, t);
4151 #endif /* HAVE_MOUSE || HAVE GPM */
4152 else
4153 /* We were promised by the above while loop that there was
4154 something for us to read! */
4155 abort ();
4157 input_pending = readable_events (0);
4159 Vlast_event_frame = internal_last_event_frame;
4161 return (obj);
4164 /* Process any non-user-visible events (currently X selection events),
4165 without reading any user-visible events. */
4167 static void
4168 process_special_events (void)
4170 struct input_event *event;
4172 for (event = kbd_fetch_ptr; event != kbd_store_ptr; ++event)
4174 if (event == kbd_buffer + KBD_BUFFER_SIZE)
4176 event = kbd_buffer;
4177 if (event == kbd_store_ptr)
4178 break;
4181 /* If we find a stored X selection request, handle it now. */
4182 if (event->kind == SELECTION_REQUEST_EVENT
4183 || event->kind == SELECTION_CLEAR_EVENT)
4185 #ifdef HAVE_X11
4187 /* Remove the event from the fifo buffer before processing;
4188 otherwise swallow_events called recursively could see it
4189 and process it again. To do this, we move the events
4190 between kbd_fetch_ptr and EVENT one slot to the right,
4191 cyclically. */
4193 struct input_event copy = *event;
4194 struct input_event *beg
4195 = (kbd_fetch_ptr == kbd_buffer + KBD_BUFFER_SIZE)
4196 ? kbd_buffer : kbd_fetch_ptr;
4198 if (event > beg)
4199 memmove (beg + 1, beg, (event - beg) * sizeof (struct input_event));
4200 else if (event < beg)
4202 if (event > kbd_buffer)
4203 memmove (kbd_buffer + 1, kbd_buffer,
4204 (event - kbd_buffer) * sizeof (struct input_event));
4205 *kbd_buffer = *(kbd_buffer + KBD_BUFFER_SIZE - 1);
4206 if (beg < kbd_buffer + KBD_BUFFER_SIZE - 1)
4207 memmove (beg + 1, beg,
4208 (kbd_buffer + KBD_BUFFER_SIZE - 1 - beg)
4209 * sizeof (struct input_event));
4212 if (kbd_fetch_ptr == kbd_buffer + KBD_BUFFER_SIZE)
4213 kbd_fetch_ptr = kbd_buffer + 1;
4214 else
4215 kbd_fetch_ptr++;
4217 /* X wants last_event_timestamp for selection ownership. */
4218 last_event_timestamp = copy.timestamp;
4219 input_pending = readable_events (0);
4220 x_handle_selection_event (&copy);
4221 #else
4222 /* We're getting selection request events, but we don't have
4223 a window system. */
4224 abort ();
4225 #endif
4230 /* Process any events that are not user-visible, run timer events that
4231 are ripe, and return, without reading any user-visible events. */
4233 void
4234 swallow_events (int do_display)
4236 int old_timers_run;
4238 process_special_events ();
4240 old_timers_run = timers_run;
4241 get_input_pending (&input_pending, READABLE_EVENTS_DO_TIMERS_NOW);
4243 if (timers_run != old_timers_run && do_display)
4244 redisplay_preserve_echo_area (7);
4247 /* Record the start of when Emacs is idle,
4248 for the sake of running idle-time timers. */
4250 static void
4251 timer_start_idle (void)
4253 Lisp_Object timers;
4255 /* If we are already in the idle state, do nothing. */
4256 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4257 return;
4259 EMACS_GET_TIME (timer_idleness_start_time);
4261 timer_last_idleness_start_time = timer_idleness_start_time;
4263 /* Mark all idle-time timers as once again candidates for running. */
4264 for (timers = Vtimer_idle_list; CONSP (timers); timers = XCDR (timers))
4266 Lisp_Object timer;
4268 timer = XCAR (timers);
4270 if (!VECTORP (timer) || ASIZE (timer) != 8)
4271 continue;
4272 XVECTOR (timer)->contents[0] = Qnil;
4276 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4278 static void
4279 timer_stop_idle (void)
4281 EMACS_SET_SECS_USECS (timer_idleness_start_time, -1, -1);
4284 /* Resume idle timer from last idle start time. */
4286 static void
4287 timer_resume_idle (void)
4289 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4290 return;
4292 timer_idleness_start_time = timer_last_idleness_start_time;
4295 /* This is only for debugging. */
4296 struct input_event last_timer_event EXTERNALLY_VISIBLE;
4298 /* List of elisp functions to call, delayed because they were generated in
4299 a context where Elisp could not be safely run (e.g. redisplay, signal,
4300 ...). Each element has the form (FUN . ARGS). */
4301 Lisp_Object pending_funcalls;
4303 /* Check whether a timer has fired. To prevent larger problems we simply
4304 disregard elements that are not proper timers. Do not make a circular
4305 timer list for the time being.
4307 Returns the time to wait until the next timer fires. If a
4308 timer is triggering now, return zero.
4309 If no timer is active, return -1.
4311 If a timer is ripe, we run it, with quitting turned off.
4312 In that case we return 0 to indicate that a new timer_check_2 call
4313 should be done. */
4315 static EMACS_TIME
4316 timer_check_2 (void)
4318 EMACS_TIME nexttime;
4319 EMACS_TIME now;
4320 EMACS_TIME idleness_now IF_LINT (= {0});
4321 Lisp_Object timers, idle_timers, chosen_timer;
4322 struct gcpro gcpro1, gcpro2, gcpro3;
4324 EMACS_SET_SECS (nexttime, -1);
4325 EMACS_SET_USECS (nexttime, -1);
4327 /* Always consider the ordinary timers. */
4328 timers = Vtimer_list;
4329 /* Consider the idle timers only if Emacs is idle. */
4330 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4331 idle_timers = Vtimer_idle_list;
4332 else
4333 idle_timers = Qnil;
4334 chosen_timer = Qnil;
4335 GCPRO3 (timers, idle_timers, chosen_timer);
4337 /* First run the code that was delayed. */
4338 while (CONSP (pending_funcalls))
4340 Lisp_Object funcall = XCAR (pending_funcalls);
4341 pending_funcalls = XCDR (pending_funcalls);
4342 safe_call2 (Qapply, XCAR (funcall), XCDR (funcall));
4345 if (CONSP (timers) || CONSP (idle_timers))
4347 EMACS_GET_TIME (now);
4348 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4349 EMACS_SUB_TIME (idleness_now, now, timer_idleness_start_time);
4352 while (CONSP (timers) || CONSP (idle_timers))
4354 Lisp_Object *vector;
4355 Lisp_Object timer = Qnil, idle_timer = Qnil;
4356 EMACS_TIME timer_time, idle_timer_time;
4357 EMACS_TIME difference;
4358 EMACS_TIME timer_difference IF_LINT (= {0});
4359 EMACS_TIME idle_timer_difference IF_LINT (= {0});
4361 /* Skip past invalid timers and timers already handled. */
4362 if (CONSP (timers))
4364 timer = XCAR (timers);
4365 if (!VECTORP (timer) || ASIZE (timer) != 8)
4367 timers = XCDR (timers);
4368 continue;
4370 vector = XVECTOR (timer)->contents;
4372 if (!INTEGERP (vector[1]) || !INTEGERP (vector[2])
4373 || !INTEGERP (vector[3])
4374 || ! NILP (vector[0]))
4376 timers = XCDR (timers);
4377 continue;
4380 if (CONSP (idle_timers))
4382 timer = XCAR (idle_timers);
4383 if (!VECTORP (timer) || ASIZE (timer) != 8)
4385 idle_timers = XCDR (idle_timers);
4386 continue;
4388 vector = XVECTOR (timer)->contents;
4390 if (!INTEGERP (vector[1]) || !INTEGERP (vector[2])
4391 || !INTEGERP (vector[3])
4392 || ! NILP (vector[0]))
4394 idle_timers = XCDR (idle_timers);
4395 continue;
4399 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4400 based on the next ordinary timer.
4401 TIMER_DIFFERENCE is the distance in time from NOW to when
4402 this timer becomes ripe (negative if it's already ripe). */
4403 if (CONSP (timers))
4405 timer = XCAR (timers);
4406 vector = XVECTOR (timer)->contents;
4407 EMACS_SET_SECS (timer_time,
4408 (XINT (vector[1]) << 16) | (XINT (vector[2])));
4409 EMACS_SET_USECS (timer_time, XINT (vector[3]));
4410 EMACS_SUB_TIME (timer_difference, timer_time, now);
4413 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4414 based on the next idle timer. */
4415 if (CONSP (idle_timers))
4417 idle_timer = XCAR (idle_timers);
4418 vector = XVECTOR (idle_timer)->contents;
4419 EMACS_SET_SECS (idle_timer_time,
4420 (XINT (vector[1]) << 16) | (XINT (vector[2])));
4421 EMACS_SET_USECS (idle_timer_time, XINT (vector[3]));
4422 EMACS_SUB_TIME (idle_timer_difference, idle_timer_time, idleness_now);
4425 /* Decide which timer is the next timer,
4426 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4427 Also step down the list where we found that timer. */
4429 if (CONSP (timers) && CONSP (idle_timers))
4431 EMACS_TIME temp;
4432 EMACS_SUB_TIME (temp, timer_difference, idle_timer_difference);
4433 if (EMACS_TIME_NEG_P (temp))
4435 chosen_timer = timer;
4436 timers = XCDR (timers);
4437 difference = timer_difference;
4439 else
4441 chosen_timer = idle_timer;
4442 idle_timers = XCDR (idle_timers);
4443 difference = idle_timer_difference;
4446 else if (CONSP (timers))
4448 chosen_timer = timer;
4449 timers = XCDR (timers);
4450 difference = timer_difference;
4452 else
4454 chosen_timer = idle_timer;
4455 idle_timers = XCDR (idle_timers);
4456 difference = idle_timer_difference;
4458 vector = XVECTOR (chosen_timer)->contents;
4460 /* If timer is ripe, run it if it hasn't been run. */
4461 if (EMACS_TIME_NEG_P (difference)
4462 || (EMACS_SECS (difference) == 0
4463 && EMACS_USECS (difference) == 0))
4465 if (NILP (vector[0]))
4467 ptrdiff_t count = SPECPDL_INDEX ();
4468 Lisp_Object old_deactivate_mark = Vdeactivate_mark;
4470 /* Mark the timer as triggered to prevent problems if the lisp
4471 code fails to reschedule it right. */
4472 vector[0] = Qt;
4474 specbind (Qinhibit_quit, Qt);
4476 call1 (Qtimer_event_handler, chosen_timer);
4477 Vdeactivate_mark = old_deactivate_mark;
4478 timers_run++;
4479 unbind_to (count, Qnil);
4481 /* Since we have handled the event,
4482 we don't need to tell the caller to wake up and do it. */
4483 /* But the caller must still wait for the next timer, so
4484 return 0 to indicate that. */
4487 EMACS_SET_SECS (nexttime, 0);
4488 EMACS_SET_USECS (nexttime, 0);
4490 else
4491 /* When we encounter a timer that is still waiting,
4492 return the amount of time to wait before it is ripe. */
4494 UNGCPRO;
4495 return difference;
4499 /* No timers are pending in the future. */
4500 /* Return 0 if we generated an event, and -1 if not. */
4501 UNGCPRO;
4502 return nexttime;
4506 /* Check whether a timer has fired. To prevent larger problems we simply
4507 disregard elements that are not proper timers. Do not make a circular
4508 timer list for the time being.
4510 Returns the time to wait until the next timer fires.
4511 If no timer is active, return -1.
4513 As long as any timer is ripe, we run it. */
4515 EMACS_TIME
4516 timer_check (void)
4518 EMACS_TIME nexttime;
4522 nexttime = timer_check_2 ();
4524 while (EMACS_SECS (nexttime) == 0 && EMACS_USECS (nexttime) == 0);
4526 return nexttime;
4529 DEFUN ("current-idle-time", Fcurrent_idle_time, Scurrent_idle_time, 0, 0, 0,
4530 doc: /* Return the current length of Emacs idleness, or nil.
4531 The value when Emacs is idle is a list of three integers. The first has
4532 the most significant 16 bits of the seconds, while the second has the least
4533 significant 16 bits. The third integer gives the microsecond count.
4535 The value when Emacs is not idle is nil.
4537 The microsecond count is zero on systems that do not provide
4538 resolution finer than a second. */)
4539 (void)
4541 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4543 EMACS_TIME now, idleness_now;
4545 EMACS_GET_TIME (now);
4546 EMACS_SUB_TIME (idleness_now, now, timer_idleness_start_time);
4548 return list3 (make_number ((EMACS_SECS (idleness_now) >> 16) & 0xffff),
4549 make_number ((EMACS_SECS (idleness_now) >> 0) & 0xffff),
4550 make_number (EMACS_USECS (idleness_now)));
4553 return Qnil;
4556 /* Caches for modify_event_symbol. */
4557 static Lisp_Object accent_key_syms;
4558 static Lisp_Object func_key_syms;
4559 static Lisp_Object mouse_syms;
4560 static Lisp_Object wheel_syms;
4561 static Lisp_Object drag_n_drop_syms;
4563 /* This is a list of keysym codes for special "accent" characters.
4564 It parallels lispy_accent_keys. */
4566 static const int lispy_accent_codes[] =
4568 #ifdef XK_dead_circumflex
4569 XK_dead_circumflex,
4570 #else
4572 #endif
4573 #ifdef XK_dead_grave
4574 XK_dead_grave,
4575 #else
4577 #endif
4578 #ifdef XK_dead_tilde
4579 XK_dead_tilde,
4580 #else
4582 #endif
4583 #ifdef XK_dead_diaeresis
4584 XK_dead_diaeresis,
4585 #else
4587 #endif
4588 #ifdef XK_dead_macron
4589 XK_dead_macron,
4590 #else
4592 #endif
4593 #ifdef XK_dead_degree
4594 XK_dead_degree,
4595 #else
4597 #endif
4598 #ifdef XK_dead_acute
4599 XK_dead_acute,
4600 #else
4602 #endif
4603 #ifdef XK_dead_cedilla
4604 XK_dead_cedilla,
4605 #else
4607 #endif
4608 #ifdef XK_dead_breve
4609 XK_dead_breve,
4610 #else
4612 #endif
4613 #ifdef XK_dead_ogonek
4614 XK_dead_ogonek,
4615 #else
4617 #endif
4618 #ifdef XK_dead_caron
4619 XK_dead_caron,
4620 #else
4622 #endif
4623 #ifdef XK_dead_doubleacute
4624 XK_dead_doubleacute,
4625 #else
4627 #endif
4628 #ifdef XK_dead_abovedot
4629 XK_dead_abovedot,
4630 #else
4632 #endif
4633 #ifdef XK_dead_abovering
4634 XK_dead_abovering,
4635 #else
4637 #endif
4638 #ifdef XK_dead_iota
4639 XK_dead_iota,
4640 #else
4642 #endif
4643 #ifdef XK_dead_belowdot
4644 XK_dead_belowdot,
4645 #else
4647 #endif
4648 #ifdef XK_dead_voiced_sound
4649 XK_dead_voiced_sound,
4650 #else
4652 #endif
4653 #ifdef XK_dead_semivoiced_sound
4654 XK_dead_semivoiced_sound,
4655 #else
4657 #endif
4658 #ifdef XK_dead_hook
4659 XK_dead_hook,
4660 #else
4662 #endif
4663 #ifdef XK_dead_horn
4664 XK_dead_horn,
4665 #else
4667 #endif
4670 /* This is a list of Lisp names for special "accent" characters.
4671 It parallels lispy_accent_codes. */
4673 static const char *const lispy_accent_keys[] =
4675 "dead-circumflex",
4676 "dead-grave",
4677 "dead-tilde",
4678 "dead-diaeresis",
4679 "dead-macron",
4680 "dead-degree",
4681 "dead-acute",
4682 "dead-cedilla",
4683 "dead-breve",
4684 "dead-ogonek",
4685 "dead-caron",
4686 "dead-doubleacute",
4687 "dead-abovedot",
4688 "dead-abovering",
4689 "dead-iota",
4690 "dead-belowdot",
4691 "dead-voiced-sound",
4692 "dead-semivoiced-sound",
4693 "dead-hook",
4694 "dead-horn",
4697 #ifdef HAVE_NTGUI
4698 #define FUNCTION_KEY_OFFSET 0x0
4700 const char *const lispy_function_keys[] =
4702 0, /* 0 */
4704 0, /* VK_LBUTTON 0x01 */
4705 0, /* VK_RBUTTON 0x02 */
4706 "cancel", /* VK_CANCEL 0x03 */
4707 0, /* VK_MBUTTON 0x04 */
4709 0, 0, 0, /* 0x05 .. 0x07 */
4711 "backspace", /* VK_BACK 0x08 */
4712 "tab", /* VK_TAB 0x09 */
4714 0, 0, /* 0x0A .. 0x0B */
4716 "clear", /* VK_CLEAR 0x0C */
4717 "return", /* VK_RETURN 0x0D */
4719 0, 0, /* 0x0E .. 0x0F */
4721 0, /* VK_SHIFT 0x10 */
4722 0, /* VK_CONTROL 0x11 */
4723 0, /* VK_MENU 0x12 */
4724 "pause", /* VK_PAUSE 0x13 */
4725 "capslock", /* VK_CAPITAL 0x14 */
4726 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4727 0, /* 0x16 */
4728 "junja", /* VK_JUNJA 0x17 */
4729 "final", /* VK_FINAL 0x18 */
4730 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4731 0, /* 0x1A */
4732 "escape", /* VK_ESCAPE 0x1B */
4733 "convert", /* VK_CONVERT 0x1C */
4734 "non-convert", /* VK_NONCONVERT 0x1D */
4735 "accept", /* VK_ACCEPT 0x1E */
4736 "mode-change", /* VK_MODECHANGE 0x1F */
4737 0, /* VK_SPACE 0x20 */
4738 "prior", /* VK_PRIOR 0x21 */
4739 "next", /* VK_NEXT 0x22 */
4740 "end", /* VK_END 0x23 */
4741 "home", /* VK_HOME 0x24 */
4742 "left", /* VK_LEFT 0x25 */
4743 "up", /* VK_UP 0x26 */
4744 "right", /* VK_RIGHT 0x27 */
4745 "down", /* VK_DOWN 0x28 */
4746 "select", /* VK_SELECT 0x29 */
4747 "print", /* VK_PRINT 0x2A */
4748 "execute", /* VK_EXECUTE 0x2B */
4749 "snapshot", /* VK_SNAPSHOT 0x2C */
4750 "insert", /* VK_INSERT 0x2D */
4751 "delete", /* VK_DELETE 0x2E */
4752 "help", /* VK_HELP 0x2F */
4754 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4756 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4758 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4760 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4762 0, 0, 0, 0, 0, 0, 0, 0, 0,
4763 0, 0, 0, 0, 0, 0, 0, 0, 0,
4764 0, 0, 0, 0, 0, 0, 0, 0,
4766 "lwindow", /* VK_LWIN 0x5B */
4767 "rwindow", /* VK_RWIN 0x5C */
4768 "apps", /* VK_APPS 0x5D */
4769 0, /* 0x5E */
4770 "sleep",
4771 "kp-0", /* VK_NUMPAD0 0x60 */
4772 "kp-1", /* VK_NUMPAD1 0x61 */
4773 "kp-2", /* VK_NUMPAD2 0x62 */
4774 "kp-3", /* VK_NUMPAD3 0x63 */
4775 "kp-4", /* VK_NUMPAD4 0x64 */
4776 "kp-5", /* VK_NUMPAD5 0x65 */
4777 "kp-6", /* VK_NUMPAD6 0x66 */
4778 "kp-7", /* VK_NUMPAD7 0x67 */
4779 "kp-8", /* VK_NUMPAD8 0x68 */
4780 "kp-9", /* VK_NUMPAD9 0x69 */
4781 "kp-multiply", /* VK_MULTIPLY 0x6A */
4782 "kp-add", /* VK_ADD 0x6B */
4783 "kp-separator", /* VK_SEPARATOR 0x6C */
4784 "kp-subtract", /* VK_SUBTRACT 0x6D */
4785 "kp-decimal", /* VK_DECIMAL 0x6E */
4786 "kp-divide", /* VK_DIVIDE 0x6F */
4787 "f1", /* VK_F1 0x70 */
4788 "f2", /* VK_F2 0x71 */
4789 "f3", /* VK_F3 0x72 */
4790 "f4", /* VK_F4 0x73 */
4791 "f5", /* VK_F5 0x74 */
4792 "f6", /* VK_F6 0x75 */
4793 "f7", /* VK_F7 0x76 */
4794 "f8", /* VK_F8 0x77 */
4795 "f9", /* VK_F9 0x78 */
4796 "f10", /* VK_F10 0x79 */
4797 "f11", /* VK_F11 0x7A */
4798 "f12", /* VK_F12 0x7B */
4799 "f13", /* VK_F13 0x7C */
4800 "f14", /* VK_F14 0x7D */
4801 "f15", /* VK_F15 0x7E */
4802 "f16", /* VK_F16 0x7F */
4803 "f17", /* VK_F17 0x80 */
4804 "f18", /* VK_F18 0x81 */
4805 "f19", /* VK_F19 0x82 */
4806 "f20", /* VK_F20 0x83 */
4807 "f21", /* VK_F21 0x84 */
4808 "f22", /* VK_F22 0x85 */
4809 "f23", /* VK_F23 0x86 */
4810 "f24", /* VK_F24 0x87 */
4812 0, 0, 0, 0, /* 0x88 .. 0x8B */
4813 0, 0, 0, 0, /* 0x8C .. 0x8F */
4815 "kp-numlock", /* VK_NUMLOCK 0x90 */
4816 "scroll", /* VK_SCROLL 0x91 */
4817 /* Not sure where the following block comes from.
4818 Windows headers have NEC and Fujitsu specific keys in
4819 this block, but nothing generic. */
4820 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4821 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4822 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4823 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4824 "kp-end", /* VK_NUMPAD_END 0x96 */
4825 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4826 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4827 "kp-up", /* VK_NUMPAD_UP 0x99 */
4828 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4829 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4830 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4831 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4833 0, 0, /* 0x9E .. 0x9F */
4836 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4837 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4838 * No other API or message will distinguish left and right keys this way.
4839 * 0xA0 .. 0xA5
4841 0, 0, 0, 0, 0, 0,
4843 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4844 to enable them selectively, and gives access to a few more functions.
4845 See lispy_multimedia_keys below. */
4846 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4847 0, 0, 0, /* 0xAD .. 0xAF Volume */
4848 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4849 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4851 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4852 0, 0, 0, 0, 0, 0, 0, 0, 0,
4854 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4855 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4856 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4858 0, /* 0xE0 */
4859 "ax", /* VK_OEM_AX 0xE1 */
4860 0, /* VK_OEM_102 0xE2 */
4861 "ico-help", /* VK_ICO_HELP 0xE3 */
4862 "ico-00", /* VK_ICO_00 0xE4 */
4863 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4864 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4865 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4866 0, /* 0xE8 */
4867 "reset", /* VK_OEM_RESET 0xE9 */
4868 "jump", /* VK_OEM_JUMP 0xEA */
4869 "oem-pa1", /* VK_OEM_PA1 0xEB */
4870 "oem-pa2", /* VK_OEM_PA2 0xEC */
4871 "oem-pa3", /* VK_OEM_PA3 0xED */
4872 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4873 "cusel", /* VK_OEM_CUSEL 0xEF */
4874 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4875 "finish", /* VK_OEM_FINISH 0xF1 */
4876 "copy", /* VK_OEM_COPY 0xF2 */
4877 "auto", /* VK_OEM_AUTO 0xF3 */
4878 "enlw", /* VK_OEM_ENLW 0xF4 */
4879 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4880 "attn", /* VK_ATTN 0xF6 */
4881 "crsel", /* VK_CRSEL 0xF7 */
4882 "exsel", /* VK_EXSEL 0xF8 */
4883 "ereof", /* VK_EREOF 0xF9 */
4884 "play", /* VK_PLAY 0xFA */
4885 "zoom", /* VK_ZOOM 0xFB */
4886 "noname", /* VK_NONAME 0xFC */
4887 "pa1", /* VK_PA1 0xFD */
4888 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4889 0 /* 0xFF */
4892 /* Some of these duplicate the "Media keys" on newer keyboards,
4893 but they are delivered to the application in a different way. */
4894 static const char *const lispy_multimedia_keys[] =
4897 "browser-back",
4898 "browser-forward",
4899 "browser-refresh",
4900 "browser-stop",
4901 "browser-search",
4902 "browser-favorites",
4903 "browser-home",
4904 "volume-mute",
4905 "volume-down",
4906 "volume-up",
4907 "media-next",
4908 "media-previous",
4909 "media-stop",
4910 "media-play-pause",
4911 "mail",
4912 "media-select",
4913 "app-1",
4914 "app-2",
4915 "bass-down",
4916 "bass-boost",
4917 "bass-up",
4918 "treble-down",
4919 "treble-up",
4920 "mic-volume-mute",
4921 "mic-volume-down",
4922 "mic-volume-up",
4923 "help",
4924 "find",
4925 "new",
4926 "open",
4927 "close",
4928 "save",
4929 "print",
4930 "undo",
4931 "redo",
4932 "copy",
4933 "cut",
4934 "paste",
4935 "mail-reply",
4936 "mail-forward",
4937 "mail-send",
4938 "spell-check",
4939 "toggle-dictate-command",
4940 "mic-toggle",
4941 "correction-list",
4942 "media-play",
4943 "media-pause",
4944 "media-record",
4945 "media-fast-forward",
4946 "media-rewind",
4947 "media-channel-up",
4948 "media-channel-down"
4951 #else /* not HAVE_NTGUI */
4953 /* This should be dealt with in XTread_socket now, and that doesn't
4954 depend on the client system having the Kana syms defined. See also
4955 the XK_kana_A case below. */
4956 #if 0
4957 #ifdef XK_kana_A
4958 static const char *const lispy_kana_keys[] =
4960 /* X Keysym value */
4961 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4962 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4963 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4964 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4965 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4966 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4967 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4968 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4969 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4970 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4971 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4972 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4973 "kana-i", "kana-u", "kana-e", "kana-o",
4974 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4975 "prolongedsound", "kana-A", "kana-I", "kana-U",
4976 "kana-E", "kana-O", "kana-KA", "kana-KI",
4977 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4978 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4979 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4980 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4981 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4982 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4983 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4984 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4985 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4986 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4987 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4988 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4990 #endif /* XK_kana_A */
4991 #endif /* 0 */
4993 #define FUNCTION_KEY_OFFSET 0xff00
4995 /* You'll notice that this table is arranged to be conveniently
4996 indexed by X Windows keysym values. */
4997 static const char *const lispy_function_keys[] =
4999 /* X Keysym value */
5001 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5002 "backspace", "tab", "linefeed", "clear",
5003 0, "return", 0, 0,
5004 0, 0, 0, "pause", /* 0xff10...1f */
5005 0, 0, 0, 0, 0, 0, 0, "escape",
5006 0, 0, 0, 0,
5007 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5008 "romaji", "hiragana", "katakana", "hiragana-katakana",
5009 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5010 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5011 "eisu-toggle", /* 0xff30...3f */
5012 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5013 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5015 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5016 "down", "prior", "next", "end",
5017 "begin", 0, 0, 0, 0, 0, 0, 0,
5018 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5019 "print",
5020 "execute",
5021 "insert",
5022 0, /* 0xff64 */
5023 "undo",
5024 "redo",
5025 "menu",
5026 "find",
5027 "cancel",
5028 "help",
5029 "break", /* 0xff6b */
5031 0, 0, 0, 0,
5032 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5033 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5034 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5035 0, 0, 0, 0, 0, 0, 0, 0,
5036 "kp-tab", /* 0xff89 */
5037 0, 0, 0,
5038 "kp-enter", /* 0xff8d */
5039 0, 0, 0,
5040 "kp-f1", /* 0xff91 */
5041 "kp-f2",
5042 "kp-f3",
5043 "kp-f4",
5044 "kp-home", /* 0xff95 */
5045 "kp-left",
5046 "kp-up",
5047 "kp-right",
5048 "kp-down",
5049 "kp-prior", /* kp-page-up */
5050 "kp-next", /* kp-page-down */
5051 "kp-end",
5052 "kp-begin",
5053 "kp-insert",
5054 "kp-delete",
5055 0, /* 0xffa0 */
5056 0, 0, 0, 0, 0, 0, 0, 0, 0,
5057 "kp-multiply", /* 0xffaa */
5058 "kp-add",
5059 "kp-separator",
5060 "kp-subtract",
5061 "kp-decimal",
5062 "kp-divide", /* 0xffaf */
5063 "kp-0", /* 0xffb0 */
5064 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5065 0, /* 0xffba */
5066 0, 0,
5067 "kp-equal", /* 0xffbd */
5068 "f1", /* 0xffbe */ /* IsFunctionKey */
5069 "f2",
5070 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5071 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5072 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5073 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5074 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5075 0, 0, 0, 0, 0, 0, 0, 0,
5076 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5077 0, 0, 0, 0, 0, 0, 0, "delete"
5080 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5081 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5083 static const char *const iso_lispy_function_keys[] =
5085 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5086 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5087 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5088 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5089 "iso-lefttab", /* 0xfe20 */
5090 "iso-move-line-up", "iso-move-line-down",
5091 "iso-partial-line-up", "iso-partial-line-down",
5092 "iso-partial-space-left", "iso-partial-space-right",
5093 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5094 "iso-release-margin-left", "iso-release-margin-right",
5095 "iso-release-both-margins",
5096 "iso-fast-cursor-left", "iso-fast-cursor-right",
5097 "iso-fast-cursor-up", "iso-fast-cursor-down",
5098 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5099 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5102 #endif /* not HAVE_NTGUI */
5104 static Lisp_Object Vlispy_mouse_stem;
5106 static const char *const lispy_wheel_names[] =
5108 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5111 /* drag-n-drop events are generated when a set of selected files are
5112 dragged from another application and dropped onto an Emacs window. */
5113 static const char *const lispy_drag_n_drop_names[] =
5115 "drag-n-drop"
5118 /* Scroll bar parts. */
5119 static Lisp_Object Qabove_handle, Qhandle, Qbelow_handle;
5120 Lisp_Object Qup, Qdown, Qbottom;
5121 static Lisp_Object Qend_scroll;
5122 Lisp_Object Qtop;
5123 static Lisp_Object Qratio;
5125 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5126 static Lisp_Object *const scroll_bar_parts[] = {
5127 &Qabove_handle, &Qhandle, &Qbelow_handle,
5128 &Qup, &Qdown, &Qtop, &Qbottom, &Qend_scroll, &Qratio
5131 /* A vector, indexed by button number, giving the down-going location
5132 of currently depressed buttons, both scroll bar and non-scroll bar.
5134 The elements have the form
5135 (BUTTON-NUMBER MODIFIER-MASK . REST)
5136 where REST is the cdr of a position as it would be reported in the event.
5138 The make_lispy_event function stores positions here to tell the
5139 difference between click and drag events, and to store the starting
5140 location to be included in drag events. */
5142 static Lisp_Object button_down_location;
5144 /* Information about the most recent up-going button event: Which
5145 button, what location, and what time. */
5147 static int last_mouse_button;
5148 static int last_mouse_x;
5149 static int last_mouse_y;
5150 static Time button_down_time;
5152 /* The number of clicks in this multiple-click. */
5154 static int double_click_count;
5156 /* X and Y are frame-relative coordinates for a click or wheel event.
5157 Return a Lisp-style event list. */
5159 static Lisp_Object
5160 make_lispy_position (struct frame *f, Lisp_Object x, Lisp_Object y,
5161 Time t)
5163 enum window_part part;
5164 Lisp_Object posn = Qnil;
5165 Lisp_Object extra_info = Qnil;
5166 /* Coordinate pixel positions to return. */
5167 int xret = 0, yret = 0;
5168 /* The window under frame pixel coordinates (x,y) */
5169 Lisp_Object window = f
5170 ? window_from_coordinates (f, XINT (x), XINT (y), &part, 0)
5171 : Qnil;
5173 if (WINDOWP (window))
5175 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5176 struct window *w = XWINDOW (window);
5177 Lisp_Object string_info = Qnil;
5178 ptrdiff_t textpos = -1;
5179 int col = -1, row = -1;
5180 int dx = -1, dy = -1;
5181 int width = -1, height = -1;
5182 Lisp_Object object = Qnil;
5184 /* Pixel coordinates relative to the window corner. */
5185 int wx = XINT (x) - WINDOW_LEFT_EDGE_X (w);
5186 int wy = XINT (y) - WINDOW_TOP_EDGE_Y (w);
5188 /* For text area clicks, return X, Y relative to the corner of
5189 this text area. Note that dX, dY etc are set below, by
5190 buffer_posn_from_coords. */
5191 if (part == ON_TEXT)
5193 xret = XINT (x) - window_box_left (w, TEXT_AREA);
5194 yret = wy - WINDOW_HEADER_LINE_HEIGHT (w);
5196 /* For mode line and header line clicks, return X, Y relative to
5197 the left window edge. Use mode_line_string to look for a
5198 string on the click position. */
5199 else if (part == ON_MODE_LINE || part == ON_HEADER_LINE)
5201 Lisp_Object string;
5202 ptrdiff_t charpos;
5204 posn = (part == ON_MODE_LINE) ? Qmode_line : Qheader_line;
5205 /* Note that mode_line_string takes COL, ROW as pixels and
5206 converts them to characters. */
5207 col = wx;
5208 row = wy;
5209 string = mode_line_string (w, part, &col, &row, &charpos,
5210 &object, &dx, &dy, &width, &height);
5211 if (STRINGP (string))
5212 string_info = Fcons (string, make_number (charpos));
5213 textpos = (w == XWINDOW (selected_window)
5214 && current_buffer == XBUFFER (w->buffer))
5215 ? PT : XMARKER (w->pointm)->charpos;
5217 xret = wx;
5218 yret = wy;
5220 /* For fringes and margins, Y is relative to the area's (and the
5221 window's) top edge, while X is meaningless. */
5222 else if (part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
5224 Lisp_Object string;
5225 ptrdiff_t charpos;
5227 posn = (part == ON_LEFT_MARGIN) ? Qleft_margin : Qright_margin;
5228 col = wx;
5229 row = wy;
5230 string = marginal_area_string (w, part, &col, &row, &charpos,
5231 &object, &dx, &dy, &width, &height);
5232 if (STRINGP (string))
5233 string_info = Fcons (string, make_number (charpos));
5234 yret = wy - WINDOW_HEADER_LINE_HEIGHT (w);
5236 else if (part == ON_LEFT_FRINGE)
5238 posn = Qleft_fringe;
5239 col = 0;
5240 dx = wx
5241 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5242 ? 0 : window_box_width (w, LEFT_MARGIN_AREA));
5243 dy = yret = wy - WINDOW_HEADER_LINE_HEIGHT (w);
5245 else if (part == ON_RIGHT_FRINGE)
5247 posn = Qright_fringe;
5248 col = 0;
5249 dx = wx
5250 - window_box_width (w, LEFT_MARGIN_AREA)
5251 - window_box_width (w, TEXT_AREA)
5252 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5253 ? window_box_width (w, RIGHT_MARGIN_AREA)
5254 : 0);
5255 dy = yret = wy - WINDOW_HEADER_LINE_HEIGHT (w);
5257 else if (part == ON_VERTICAL_BORDER)
5259 posn = Qvertical_line;
5260 width = 1;
5261 dx = 0;
5262 dy = yret = wy;
5264 /* Nothing special for part == ON_SCROLL_BAR. */
5266 /* For clicks in the text area, fringes, or margins, call
5267 buffer_posn_from_coords to extract TEXTPOS, the buffer
5268 position nearest to the click. */
5269 if (textpos < 0)
5271 Lisp_Object string2, object2 = Qnil;
5272 struct display_pos p;
5273 int dx2, dy2;
5274 int width2, height2;
5275 /* The pixel X coordinate passed to buffer_posn_from_coords
5276 is the X coordinate relative to the text area for
5277 text-area and right-margin clicks, zero otherwise. */
5278 int x2
5279 = (part == ON_TEXT) ? xret
5280 : (part == ON_RIGHT_FRINGE || part == ON_RIGHT_MARGIN)
5281 ? (XINT (x) - window_box_left (w, TEXT_AREA))
5282 : 0;
5283 int y2 = wy;
5285 string2 = buffer_posn_from_coords (w, &x2, &y2, &p,
5286 &object2, &dx2, &dy2,
5287 &width2, &height2);
5288 textpos = CHARPOS (p.pos);
5289 if (col < 0) col = x2;
5290 if (row < 0) row = y2;
5291 if (dx < 0) dx = dx2;
5292 if (dy < 0) dy = dy2;
5293 if (width < 0) width = width2;
5294 if (height < 0) height = height2;
5296 if (NILP (posn))
5298 posn = make_number (textpos);
5299 if (STRINGP (string2))
5300 string_info = Fcons (string2,
5301 make_number (CHARPOS (p.string_pos)));
5303 if (NILP (object))
5304 object = object2;
5307 #ifdef HAVE_WINDOW_SYSTEM
5308 if (IMAGEP (object))
5310 Lisp_Object image_map, hotspot;
5311 if ((image_map = Fplist_get (XCDR (object), QCmap),
5312 !NILP (image_map))
5313 && (hotspot = find_hot_spot (image_map, dx, dy),
5314 CONSP (hotspot))
5315 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
5316 posn = XCAR (hotspot);
5318 #endif
5320 /* Object info */
5321 extra_info
5322 = list3 (object,
5323 Fcons (make_number (dx), make_number (dy)),
5324 Fcons (make_number (width), make_number (height)));
5326 /* String info */
5327 extra_info = Fcons (string_info,
5328 Fcons (make_number (textpos),
5329 Fcons (Fcons (make_number (col),
5330 make_number (row)),
5331 extra_info)));
5333 else if (f != 0)
5334 XSETFRAME (window, f);
5335 else
5336 window = Qnil;
5338 return Fcons (window,
5339 Fcons (posn,
5340 Fcons (Fcons (make_number (xret),
5341 make_number (yret)),
5342 Fcons (make_number (t),
5343 extra_info))));
5346 /* Given a struct input_event, build the lisp event which represents
5347 it. If EVENT is 0, build a mouse movement event from the mouse
5348 movement buffer, which should have a movement event in it.
5350 Note that events must be passed to this function in the order they
5351 are received; this function stores the location of button presses
5352 in order to build drag events when the button is released. */
5354 static Lisp_Object
5355 make_lispy_event (struct input_event *event)
5357 int i;
5359 switch (SWITCH_ENUM_CAST (event->kind))
5361 /* A simple keystroke. */
5362 case ASCII_KEYSTROKE_EVENT:
5363 case MULTIBYTE_CHAR_KEYSTROKE_EVENT:
5365 Lisp_Object lispy_c;
5366 EMACS_INT c = event->code;
5367 if (event->kind == ASCII_KEYSTROKE_EVENT)
5369 c &= 0377;
5370 eassert (c == event->code);
5371 /* Turn ASCII characters into control characters
5372 when proper. */
5373 if (event->modifiers & ctrl_modifier)
5375 c = make_ctrl_char (c);
5376 event->modifiers &= ~ctrl_modifier;
5380 /* Add in the other modifier bits. The shift key was taken care
5381 of by the X code. */
5382 c |= (event->modifiers
5383 & (meta_modifier | alt_modifier
5384 | hyper_modifier | super_modifier | ctrl_modifier));
5385 /* Distinguish Shift-SPC from SPC. */
5386 if ((event->code) == 040
5387 && event->modifiers & shift_modifier)
5388 c |= shift_modifier;
5389 button_down_time = 0;
5390 XSETFASTINT (lispy_c, c);
5391 return lispy_c;
5394 #ifdef HAVE_NS
5395 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5396 except that they are non-key events (last-nonmenu-event is nil). */
5397 case NS_NONKEY_EVENT:
5398 #endif
5400 /* A function key. The symbol may need to have modifier prefixes
5401 tacked onto it. */
5402 case NON_ASCII_KEYSTROKE_EVENT:
5403 button_down_time = 0;
5405 for (i = 0; i < sizeof (lispy_accent_codes) / sizeof (int); i++)
5406 if (event->code == lispy_accent_codes[i])
5407 return modify_event_symbol (i,
5408 event->modifiers,
5409 Qfunction_key, Qnil,
5410 lispy_accent_keys, &accent_key_syms,
5411 (sizeof (lispy_accent_keys)
5412 / sizeof (lispy_accent_keys[0])));
5414 #if 0
5415 #ifdef XK_kana_A
5416 if (event->code >= 0x400 && event->code < 0x500)
5417 return modify_event_symbol (event->code - 0x400,
5418 event->modifiers & ~shift_modifier,
5419 Qfunction_key, Qnil,
5420 lispy_kana_keys, &func_key_syms,
5421 (sizeof (lispy_kana_keys)
5422 / sizeof (lispy_kana_keys[0])));
5423 #endif /* XK_kana_A */
5424 #endif /* 0 */
5426 #ifdef ISO_FUNCTION_KEY_OFFSET
5427 if (event->code < FUNCTION_KEY_OFFSET
5428 && event->code >= ISO_FUNCTION_KEY_OFFSET)
5429 return modify_event_symbol (event->code - ISO_FUNCTION_KEY_OFFSET,
5430 event->modifiers,
5431 Qfunction_key, Qnil,
5432 iso_lispy_function_keys, &func_key_syms,
5433 (sizeof (iso_lispy_function_keys)
5434 / sizeof (iso_lispy_function_keys[0])));
5435 #endif
5437 /* Handle system-specific or unknown keysyms. */
5438 if (event->code & (1 << 28)
5439 || event->code - FUNCTION_KEY_OFFSET < 0
5440 || (event->code - FUNCTION_KEY_OFFSET
5441 >= sizeof lispy_function_keys / sizeof *lispy_function_keys)
5442 || !lispy_function_keys[event->code - FUNCTION_KEY_OFFSET])
5444 /* We need to use an alist rather than a vector as the cache
5445 since we can't make a vector long enough. */
5446 if (NILP (KVAR (current_kboard, system_key_syms)))
5447 KVAR (current_kboard, system_key_syms) = Fcons (Qnil, Qnil);
5448 return modify_event_symbol (event->code,
5449 event->modifiers,
5450 Qfunction_key,
5451 KVAR (current_kboard, Vsystem_key_alist),
5452 0, &KVAR (current_kboard, system_key_syms),
5453 PTRDIFF_MAX);
5456 return modify_event_symbol (event->code - FUNCTION_KEY_OFFSET,
5457 event->modifiers,
5458 Qfunction_key, Qnil,
5459 lispy_function_keys, &func_key_syms,
5460 (sizeof (lispy_function_keys)
5461 / sizeof (lispy_function_keys[0])));
5463 #ifdef WINDOWSNT
5464 case MULTIMEDIA_KEY_EVENT:
5465 if (event->code < (sizeof (lispy_multimedia_keys)
5466 / sizeof (lispy_multimedia_keys[0]))
5467 && event->code > 0 && lispy_multimedia_keys[event->code])
5469 return modify_event_symbol (event->code, event->modifiers,
5470 Qfunction_key, Qnil,
5471 lispy_multimedia_keys, &func_key_syms,
5472 (sizeof (lispy_multimedia_keys)
5473 / sizeof (lispy_multimedia_keys[0])));
5475 return Qnil;
5476 #endif
5478 #ifdef HAVE_MOUSE
5479 /* A mouse click. Figure out where it is, decide whether it's
5480 a press, click or drag, and build the appropriate structure. */
5481 case MOUSE_CLICK_EVENT:
5482 #ifndef USE_TOOLKIT_SCROLL_BARS
5483 case SCROLL_BAR_CLICK_EVENT:
5484 #endif
5486 int button = event->code;
5487 int is_double;
5488 Lisp_Object position;
5489 Lisp_Object *start_pos_ptr;
5490 Lisp_Object start_pos;
5492 position = Qnil;
5494 /* Build the position as appropriate for this mouse click. */
5495 if (event->kind == MOUSE_CLICK_EVENT)
5497 struct frame *f = XFRAME (event->frame_or_window);
5498 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5499 int row, column;
5500 #endif
5502 /* Ignore mouse events that were made on frame that
5503 have been deleted. */
5504 if (! FRAME_LIVE_P (f))
5505 return Qnil;
5507 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5508 /* EVENT->x and EVENT->y are frame-relative pixel
5509 coordinates at this place. Under old redisplay, COLUMN
5510 and ROW are set to frame relative glyph coordinates
5511 which are then used to determine whether this click is
5512 in a menu (non-toolkit version). */
5513 pixel_to_glyph_coords (f, XINT (event->x), XINT (event->y),
5514 &column, &row, NULL, 1);
5516 /* In the non-toolkit version, clicks on the menu bar
5517 are ordinary button events in the event buffer.
5518 Distinguish them, and invoke the menu.
5520 (In the toolkit version, the toolkit handles the menu bar
5521 and Emacs doesn't know about it until after the user
5522 makes a selection.) */
5523 if (row >= 0 && row < FRAME_MENU_BAR_LINES (f)
5524 && (event->modifiers & down_modifier))
5526 Lisp_Object items, item;
5528 /* Find the menu bar item under `column'. */
5529 item = Qnil;
5530 items = FRAME_MENU_BAR_ITEMS (f);
5531 for (i = 0; i < ASIZE (items); i += 4)
5533 Lisp_Object pos, string;
5534 string = AREF (items, i + 1);
5535 pos = AREF (items, i + 3);
5536 if (NILP (string))
5537 break;
5538 if (column >= XINT (pos)
5539 && column < XINT (pos) + SCHARS (string))
5541 item = AREF (items, i);
5542 break;
5546 /* ELisp manual 2.4b says (x y) are window relative but
5547 code says they are frame-relative. */
5548 position
5549 = Fcons (event->frame_or_window,
5550 Fcons (Qmenu_bar,
5551 Fcons (Fcons (event->x, event->y),
5552 Fcons (make_number (event->timestamp),
5553 Qnil))));
5555 return Fcons (item, Fcons (position, Qnil));
5557 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5559 position = make_lispy_position (f, event->x, event->y,
5560 event->timestamp);
5562 #ifndef USE_TOOLKIT_SCROLL_BARS
5563 else
5565 /* It's a scrollbar click. */
5566 Lisp_Object window;
5567 Lisp_Object portion_whole;
5568 Lisp_Object part;
5570 window = event->frame_or_window;
5571 portion_whole = Fcons (event->x, event->y);
5572 part = *scroll_bar_parts[(int) event->part];
5574 position
5575 = Fcons (window,
5576 Fcons (Qvertical_scroll_bar,
5577 Fcons (portion_whole,
5578 Fcons (make_number (event->timestamp),
5579 Fcons (part, Qnil)))));
5581 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5583 if (button >= ASIZE (button_down_location))
5585 ptrdiff_t incr = button - ASIZE (button_down_location) + 1;
5586 button_down_location = larger_vector (button_down_location,
5587 incr, -1);
5588 mouse_syms = larger_vector (mouse_syms, incr, -1);
5591 start_pos_ptr = &AREF (button_down_location, button);
5592 start_pos = *start_pos_ptr;
5593 *start_pos_ptr = Qnil;
5596 /* On window-system frames, use the value of
5597 double-click-fuzz as is. On other frames, interpret it
5598 as a multiple of 1/8 characters. */
5599 struct frame *f;
5600 int fuzz;
5602 if (WINDOWP (event->frame_or_window))
5603 f = XFRAME (XWINDOW (event->frame_or_window)->frame);
5604 else if (FRAMEP (event->frame_or_window))
5605 f = XFRAME (event->frame_or_window);
5606 else
5607 abort ();
5609 if (FRAME_WINDOW_P (f))
5610 fuzz = double_click_fuzz;
5611 else
5612 fuzz = double_click_fuzz / 8;
5614 is_double = (button == last_mouse_button
5615 && (eabs (XINT (event->x) - last_mouse_x) <= fuzz)
5616 && (eabs (XINT (event->y) - last_mouse_y) <= fuzz)
5617 && button_down_time != 0
5618 && (EQ (Vdouble_click_time, Qt)
5619 || (NATNUMP (Vdouble_click_time)
5620 && (event->timestamp - button_down_time
5621 < XFASTINT (Vdouble_click_time)))));
5624 last_mouse_button = button;
5625 last_mouse_x = XINT (event->x);
5626 last_mouse_y = XINT (event->y);
5628 /* If this is a button press, squirrel away the location, so
5629 we can decide later whether it was a click or a drag. */
5630 if (event->modifiers & down_modifier)
5632 if (is_double)
5634 double_click_count++;
5635 event->modifiers |= ((double_click_count > 2)
5636 ? triple_modifier
5637 : double_modifier);
5639 else
5640 double_click_count = 1;
5641 button_down_time = event->timestamp;
5642 *start_pos_ptr = Fcopy_alist (position);
5643 ignore_mouse_drag_p = 0;
5646 /* Now we're releasing a button - check the co-ordinates to
5647 see if this was a click or a drag. */
5648 else if (event->modifiers & up_modifier)
5650 /* If we did not see a down before this up, ignore the up.
5651 Probably this happened because the down event chose a
5652 menu item. It would be an annoyance to treat the
5653 release of the button that chose the menu item as a
5654 separate event. */
5656 if (!CONSP (start_pos))
5657 return Qnil;
5659 event->modifiers &= ~up_modifier;
5662 Lisp_Object new_down, down;
5663 EMACS_INT xdiff = double_click_fuzz, ydiff = double_click_fuzz;
5665 /* The third element of every position
5666 should be the (x,y) pair. */
5667 down = Fcar (Fcdr (Fcdr (start_pos)));
5668 new_down = Fcar (Fcdr (Fcdr (position)));
5670 if (CONSP (down)
5671 && INTEGERP (XCAR (down)) && INTEGERP (XCDR (down)))
5673 xdiff = XINT (XCAR (new_down)) - XINT (XCAR (down));
5674 ydiff = XINT (XCDR (new_down)) - XINT (XCDR (down));
5677 if (ignore_mouse_drag_p)
5679 event->modifiers |= click_modifier;
5680 ignore_mouse_drag_p = 0;
5682 else if (xdiff < double_click_fuzz && xdiff > - double_click_fuzz
5683 && ydiff < double_click_fuzz && ydiff > - double_click_fuzz
5684 /* Maybe the mouse has moved a lot, caused scrolling, and
5685 eventually ended up at the same screen position (but
5686 not buffer position) in which case it is a drag, not
5687 a click. */
5688 /* FIXME: OTOH if the buffer position has changed
5689 because of a timer or process filter rather than
5690 because of mouse movement, it should be considered as
5691 a click. But mouse-drag-region completely ignores
5692 this case and it hasn't caused any real problem, so
5693 it's probably OK to ignore it as well. */
5694 && EQ (Fcar (Fcdr (start_pos)), Fcar (Fcdr (position))))
5695 /* Mouse hasn't moved (much). */
5696 event->modifiers |= click_modifier;
5697 else
5699 button_down_time = 0;
5700 event->modifiers |= drag_modifier;
5703 /* Don't check is_double; treat this as multiple
5704 if the down-event was multiple. */
5705 if (double_click_count > 1)
5706 event->modifiers |= ((double_click_count > 2)
5707 ? triple_modifier
5708 : double_modifier);
5711 else
5712 /* Every mouse event should either have the down_modifier or
5713 the up_modifier set. */
5714 abort ();
5717 /* Get the symbol we should use for the mouse click. */
5718 Lisp_Object head;
5720 head = modify_event_symbol (button,
5721 event->modifiers,
5722 Qmouse_click, Vlispy_mouse_stem,
5723 NULL,
5724 &mouse_syms,
5725 ASIZE (mouse_syms));
5726 if (event->modifiers & drag_modifier)
5727 return Fcons (head,
5728 Fcons (start_pos,
5729 Fcons (position,
5730 Qnil)));
5731 else if (event->modifiers & (double_modifier | triple_modifier))
5732 return Fcons (head,
5733 Fcons (position,
5734 Fcons (make_number (double_click_count),
5735 Qnil)));
5736 else
5737 return Fcons (head,
5738 Fcons (position,
5739 Qnil));
5743 case WHEEL_EVENT:
5744 case HORIZ_WHEEL_EVENT:
5746 Lisp_Object position;
5747 Lisp_Object head;
5749 /* Build the position as appropriate for this mouse click. */
5750 struct frame *f = XFRAME (event->frame_or_window);
5752 /* Ignore wheel events that were made on frame that have been
5753 deleted. */
5754 if (! FRAME_LIVE_P (f))
5755 return Qnil;
5757 position = make_lispy_position (f, event->x, event->y,
5758 event->timestamp);
5760 /* Set double or triple modifiers to indicate the wheel speed. */
5762 /* On window-system frames, use the value of
5763 double-click-fuzz as is. On other frames, interpret it
5764 as a multiple of 1/8 characters. */
5765 struct frame *fr;
5766 int fuzz;
5767 int symbol_num;
5768 int is_double;
5770 if (WINDOWP (event->frame_or_window))
5771 fr = XFRAME (XWINDOW (event->frame_or_window)->frame);
5772 else if (FRAMEP (event->frame_or_window))
5773 fr = XFRAME (event->frame_or_window);
5774 else
5775 abort ();
5777 fuzz = FRAME_WINDOW_P (fr)
5778 ? double_click_fuzz : double_click_fuzz / 8;
5780 if (event->modifiers & up_modifier)
5782 /* Emit a wheel-up event. */
5783 event->modifiers &= ~up_modifier;
5784 symbol_num = 0;
5786 else if (event->modifiers & down_modifier)
5788 /* Emit a wheel-down event. */
5789 event->modifiers &= ~down_modifier;
5790 symbol_num = 1;
5792 else
5793 /* Every wheel event should either have the down_modifier or
5794 the up_modifier set. */
5795 abort ();
5797 if (event->kind == HORIZ_WHEEL_EVENT)
5798 symbol_num += 2;
5800 is_double = (last_mouse_button == - (1 + symbol_num)
5801 && (eabs (XINT (event->x) - last_mouse_x) <= fuzz)
5802 && (eabs (XINT (event->y) - last_mouse_y) <= fuzz)
5803 && button_down_time != 0
5804 && (EQ (Vdouble_click_time, Qt)
5805 || (NATNUMP (Vdouble_click_time)
5806 && (event->timestamp - button_down_time
5807 < XFASTINT (Vdouble_click_time)))));
5808 if (is_double)
5810 double_click_count++;
5811 event->modifiers |= ((double_click_count > 2)
5812 ? triple_modifier
5813 : double_modifier);
5815 else
5817 double_click_count = 1;
5818 event->modifiers |= click_modifier;
5821 button_down_time = event->timestamp;
5822 /* Use a negative value to distinguish wheel from mouse button. */
5823 last_mouse_button = - (1 + symbol_num);
5824 last_mouse_x = XINT (event->x);
5825 last_mouse_y = XINT (event->y);
5827 /* Get the symbol we should use for the wheel event. */
5828 head = modify_event_symbol (symbol_num,
5829 event->modifiers,
5830 Qmouse_click,
5831 Qnil,
5832 lispy_wheel_names,
5833 &wheel_syms,
5834 ASIZE (wheel_syms));
5837 if (event->modifiers & (double_modifier | triple_modifier))
5838 return Fcons (head,
5839 Fcons (position,
5840 Fcons (make_number (double_click_count),
5841 Qnil)));
5842 else
5843 return Fcons (head,
5844 Fcons (position,
5845 Qnil));
5849 #ifdef USE_TOOLKIT_SCROLL_BARS
5851 /* We don't have down and up events if using toolkit scroll bars,
5852 so make this always a click event. Store in the `part' of
5853 the Lisp event a symbol which maps to the following actions:
5855 `above_handle' page up
5856 `below_handle' page down
5857 `up' line up
5858 `down' line down
5859 `top' top of buffer
5860 `bottom' bottom of buffer
5861 `handle' thumb has been dragged.
5862 `end-scroll' end of interaction with scroll bar
5864 The incoming input_event contains in its `part' member an
5865 index of type `enum scroll_bar_part' which we can use as an
5866 index in scroll_bar_parts to get the appropriate symbol. */
5868 case SCROLL_BAR_CLICK_EVENT:
5870 Lisp_Object position, head, window, portion_whole, part;
5872 window = event->frame_or_window;
5873 portion_whole = Fcons (event->x, event->y);
5874 part = *scroll_bar_parts[(int) event->part];
5876 position
5877 = Fcons (window,
5878 Fcons (Qvertical_scroll_bar,
5879 Fcons (portion_whole,
5880 Fcons (make_number (event->timestamp),
5881 Fcons (part, Qnil)))));
5883 /* Always treat scroll bar events as clicks. */
5884 event->modifiers |= click_modifier;
5885 event->modifiers &= ~up_modifier;
5887 if (event->code >= ASIZE (mouse_syms))
5888 mouse_syms = larger_vector (mouse_syms,
5889 event->code - ASIZE (mouse_syms) + 1,
5890 -1);
5892 /* Get the symbol we should use for the mouse click. */
5893 head = modify_event_symbol (event->code,
5894 event->modifiers,
5895 Qmouse_click,
5896 Vlispy_mouse_stem,
5897 NULL, &mouse_syms,
5898 ASIZE (mouse_syms));
5899 return Fcons (head, Fcons (position, Qnil));
5902 #endif /* USE_TOOLKIT_SCROLL_BARS */
5904 case DRAG_N_DROP_EVENT:
5906 FRAME_PTR f;
5907 Lisp_Object head, position;
5908 Lisp_Object files;
5910 f = XFRAME (event->frame_or_window);
5911 files = event->arg;
5913 /* Ignore mouse events that were made on frames that
5914 have been deleted. */
5915 if (! FRAME_LIVE_P (f))
5916 return Qnil;
5918 position = make_lispy_position (f, event->x, event->y,
5919 event->timestamp);
5921 head = modify_event_symbol (0, event->modifiers,
5922 Qdrag_n_drop, Qnil,
5923 lispy_drag_n_drop_names,
5924 &drag_n_drop_syms, 1);
5925 return Fcons (head,
5926 Fcons (position,
5927 Fcons (files,
5928 Qnil)));
5930 #endif /* HAVE_MOUSE */
5932 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5933 || defined (HAVE_NS) || defined (USE_GTK)
5934 case MENU_BAR_EVENT:
5935 if (EQ (event->arg, event->frame_or_window))
5936 /* This is the prefix key. We translate this to
5937 `(menu_bar)' because the code in keyboard.c for menu
5938 events, which we use, relies on this. */
5939 return Fcons (Qmenu_bar, Qnil);
5940 return event->arg;
5941 #endif
5943 case SELECT_WINDOW_EVENT:
5944 /* Make an event (select-window (WINDOW)). */
5945 return Fcons (Qselect_window,
5946 Fcons (Fcons (event->frame_or_window, Qnil),
5947 Qnil));
5949 case TOOL_BAR_EVENT:
5950 if (EQ (event->arg, event->frame_or_window))
5951 /* This is the prefix key. We translate this to
5952 `(tool_bar)' because the code in keyboard.c for tool bar
5953 events, which we use, relies on this. */
5954 return Fcons (Qtool_bar, Qnil);
5955 else if (SYMBOLP (event->arg))
5956 return apply_modifiers (event->modifiers, event->arg);
5957 return event->arg;
5959 case USER_SIGNAL_EVENT:
5960 /* A user signal. */
5962 char *name = find_user_signal_name (event->code);
5963 if (!name)
5964 abort ();
5965 return intern (name);
5968 case SAVE_SESSION_EVENT:
5969 return Qsave_session;
5971 #ifdef HAVE_DBUS
5972 case DBUS_EVENT:
5974 return Fcons (Qdbus_event, event->arg);
5976 #endif /* HAVE_DBUS */
5978 case CONFIG_CHANGED_EVENT:
5979 return Fcons (Qconfig_changed_event,
5980 Fcons (event->arg,
5981 Fcons (event->frame_or_window, Qnil)));
5982 #ifdef HAVE_GPM
5983 case GPM_CLICK_EVENT:
5985 FRAME_PTR f = XFRAME (event->frame_or_window);
5986 Lisp_Object head, position;
5987 Lisp_Object *start_pos_ptr;
5988 Lisp_Object start_pos;
5989 int button = event->code;
5991 if (button >= ASIZE (button_down_location))
5993 ptrdiff_t incr = button - ASIZE (button_down_location) + 1;
5994 button_down_location = larger_vector (button_down_location,
5995 incr, -1);
5996 mouse_syms = larger_vector (mouse_syms, incr, -1);
5999 start_pos_ptr = &AREF (button_down_location, button);
6000 start_pos = *start_pos_ptr;
6002 position = make_lispy_position (f, event->x, event->y,
6003 event->timestamp);
6005 if (event->modifiers & down_modifier)
6006 *start_pos_ptr = Fcopy_alist (position);
6007 else if (event->modifiers & (up_modifier | drag_modifier))
6009 if (!CONSP (start_pos))
6010 return Qnil;
6011 event->modifiers &= ~up_modifier;
6014 head = modify_event_symbol (button,
6015 event->modifiers,
6016 Qmouse_click, Vlispy_mouse_stem,
6017 NULL,
6018 &mouse_syms,
6019 ASIZE (mouse_syms));
6021 if (event->modifiers & drag_modifier)
6022 return Fcons (head,
6023 Fcons (start_pos,
6024 Fcons (position,
6025 Qnil)));
6026 else if (event->modifiers & double_modifier)
6027 return Fcons (head,
6028 Fcons (position,
6029 Fcons (make_number (2),
6030 Qnil)));
6031 else if (event->modifiers & triple_modifier)
6032 return Fcons (head,
6033 Fcons (position,
6034 Fcons (make_number (3),
6035 Qnil)));
6036 else
6037 return Fcons (head,
6038 Fcons (position,
6039 Qnil));
6041 #endif /* HAVE_GPM */
6043 /* The 'kind' field of the event is something we don't recognize. */
6044 default:
6045 abort ();
6049 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6051 static Lisp_Object
6052 make_lispy_movement (FRAME_PTR frame, Lisp_Object bar_window, enum scroll_bar_part part,
6053 Lisp_Object x, Lisp_Object y, Time t)
6055 /* Is it a scroll bar movement? */
6056 if (frame && ! NILP (bar_window))
6058 Lisp_Object part_sym;
6060 part_sym = *scroll_bar_parts[(int) part];
6061 return Fcons (Qscroll_bar_movement,
6062 Fcons (list5 (bar_window,
6063 Qvertical_scroll_bar,
6064 Fcons (x, y),
6065 make_number (t),
6066 part_sym),
6067 Qnil));
6069 /* Or is it an ordinary mouse movement? */
6070 else
6072 Lisp_Object position;
6073 position = make_lispy_position (frame, x, y, t);
6074 return list2 (Qmouse_movement, position);
6078 #endif /* HAVE_MOUSE || HAVE GPM */
6080 /* Construct a switch frame event. */
6081 static Lisp_Object
6082 make_lispy_switch_frame (Lisp_Object frame)
6084 return Fcons (Qswitch_frame, Fcons (frame, Qnil));
6087 /* Manipulating modifiers. */
6089 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6091 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6092 SYMBOL's name of the end of the modifiers; the string from this
6093 position is the unmodified symbol name.
6095 This doesn't use any caches. */
6097 static int
6098 parse_modifiers_uncached (Lisp_Object symbol, ptrdiff_t *modifier_end)
6100 Lisp_Object name;
6101 ptrdiff_t i;
6102 int modifiers;
6104 CHECK_SYMBOL (symbol);
6106 modifiers = 0;
6107 name = SYMBOL_NAME (symbol);
6109 for (i = 0; i < SBYTES (name) - 1; )
6111 ptrdiff_t this_mod_end = 0;
6112 int this_mod = 0;
6114 /* See if the name continues with a modifier word.
6115 Check that the word appears, but don't check what follows it.
6116 Set this_mod and this_mod_end to record what we find. */
6118 switch (SREF (name, i))
6120 #define SINGLE_LETTER_MOD(BIT) \
6121 (this_mod_end = i + 1, this_mod = BIT)
6123 case 'A':
6124 SINGLE_LETTER_MOD (alt_modifier);
6125 break;
6127 case 'C':
6128 SINGLE_LETTER_MOD (ctrl_modifier);
6129 break;
6131 case 'H':
6132 SINGLE_LETTER_MOD (hyper_modifier);
6133 break;
6135 case 'M':
6136 SINGLE_LETTER_MOD (meta_modifier);
6137 break;
6139 case 'S':
6140 SINGLE_LETTER_MOD (shift_modifier);
6141 break;
6143 case 's':
6144 SINGLE_LETTER_MOD (super_modifier);
6145 break;
6147 #undef SINGLE_LETTER_MOD
6149 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6150 if (i + LEN + 1 <= SBYTES (name) \
6151 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6153 this_mod_end = i + LEN; \
6154 this_mod = BIT; \
6157 case 'd':
6158 MULTI_LETTER_MOD (drag_modifier, "drag", 4);
6159 MULTI_LETTER_MOD (down_modifier, "down", 4);
6160 MULTI_LETTER_MOD (double_modifier, "double", 6);
6161 break;
6163 case 't':
6164 MULTI_LETTER_MOD (triple_modifier, "triple", 6);
6165 break;
6166 #undef MULTI_LETTER_MOD
6170 /* If we found no modifier, stop looking for them. */
6171 if (this_mod_end == 0)
6172 break;
6174 /* Check there is a dash after the modifier, so that it
6175 really is a modifier. */
6176 if (this_mod_end >= SBYTES (name)
6177 || SREF (name, this_mod_end) != '-')
6178 break;
6180 /* This modifier is real; look for another. */
6181 modifiers |= this_mod;
6182 i = this_mod_end + 1;
6185 /* Should we include the `click' modifier? */
6186 if (! (modifiers & (down_modifier | drag_modifier
6187 | double_modifier | triple_modifier))
6188 && i + 7 == SBYTES (name)
6189 && strncmp (SSDATA (name) + i, "mouse-", 6) == 0
6190 && ('0' <= SREF (name, i + 6) && SREF (name, i + 6) <= '9'))
6191 modifiers |= click_modifier;
6193 if (! (modifiers & (double_modifier | triple_modifier))
6194 && i + 6 < SBYTES (name)
6195 && strncmp (SSDATA (name) + i, "wheel-", 6) == 0)
6196 modifiers |= click_modifier;
6198 if (modifier_end)
6199 *modifier_end = i;
6201 return modifiers;
6204 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6205 prepended to the string BASE[0..BASE_LEN-1].
6206 This doesn't use any caches. */
6207 static Lisp_Object
6208 apply_modifiers_uncached (int modifiers, char *base, int base_len, int base_len_byte)
6210 /* Since BASE could contain nulls, we can't use intern here; we have
6211 to use Fintern, which expects a genuine Lisp_String, and keeps a
6212 reference to it. */
6213 char *new_mods
6214 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6215 int mod_len;
6218 char *p = new_mods;
6220 /* Only the event queue may use the `up' modifier; it should always
6221 be turned into a click or drag event before presented to lisp code. */
6222 if (modifiers & up_modifier)
6223 abort ();
6225 if (modifiers & alt_modifier) { *p++ = 'A'; *p++ = '-'; }
6226 if (modifiers & ctrl_modifier) { *p++ = 'C'; *p++ = '-'; }
6227 if (modifiers & hyper_modifier) { *p++ = 'H'; *p++ = '-'; }
6228 if (modifiers & meta_modifier) { *p++ = 'M'; *p++ = '-'; }
6229 if (modifiers & shift_modifier) { *p++ = 'S'; *p++ = '-'; }
6230 if (modifiers & super_modifier) { *p++ = 's'; *p++ = '-'; }
6231 if (modifiers & double_modifier) { strcpy (p, "double-"); p += 7; }
6232 if (modifiers & triple_modifier) { strcpy (p, "triple-"); p += 7; }
6233 if (modifiers & down_modifier) { strcpy (p, "down-"); p += 5; }
6234 if (modifiers & drag_modifier) { strcpy (p, "drag-"); p += 5; }
6235 /* The click modifier is denoted by the absence of other modifiers. */
6237 *p = '\0';
6239 mod_len = p - new_mods;
6243 Lisp_Object new_name;
6245 new_name = make_uninit_multibyte_string (mod_len + base_len,
6246 mod_len + base_len_byte);
6247 memcpy (SDATA (new_name), new_mods, mod_len);
6248 memcpy (SDATA (new_name) + mod_len, base, base_len_byte);
6250 return Fintern (new_name, Qnil);
6255 static const char *const modifier_names[] =
6257 "up", "down", "drag", "click", "double", "triple", 0, 0,
6258 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6259 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6261 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6263 static Lisp_Object modifier_symbols;
6265 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6266 static Lisp_Object
6267 lispy_modifier_list (int modifiers)
6269 Lisp_Object modifier_list;
6270 int i;
6272 modifier_list = Qnil;
6273 for (i = 0; (1<<i) <= modifiers && i < NUM_MOD_NAMES; i++)
6274 if (modifiers & (1<<i))
6275 modifier_list = Fcons (XVECTOR (modifier_symbols)->contents[i],
6276 modifier_list);
6278 return modifier_list;
6282 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6283 where UNMODIFIED is the unmodified form of SYMBOL,
6284 MASK is the set of modifiers present in SYMBOL's name.
6285 This is similar to parse_modifiers_uncached, but uses the cache in
6286 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6287 Qevent_symbol_elements property. */
6289 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6291 Lisp_Object
6292 parse_modifiers (Lisp_Object symbol)
6294 Lisp_Object elements;
6296 if (INTEGERP (symbol))
6297 return (Fcons (make_number (KEY_TO_CHAR (symbol)),
6298 Fcons (make_number (XINT (symbol) & CHAR_MODIFIER_MASK),
6299 Qnil)));
6300 else if (!SYMBOLP (symbol))
6301 return Qnil;
6303 elements = Fget (symbol, Qevent_symbol_element_mask);
6304 if (CONSP (elements))
6305 return elements;
6306 else
6308 ptrdiff_t end;
6309 int modifiers = parse_modifiers_uncached (symbol, &end);
6310 Lisp_Object unmodified;
6311 Lisp_Object mask;
6313 unmodified = Fintern (make_string (SSDATA (SYMBOL_NAME (symbol)) + end,
6314 SBYTES (SYMBOL_NAME (symbol)) - end),
6315 Qnil);
6317 if (modifiers & ~INTMASK)
6318 abort ();
6319 XSETFASTINT (mask, modifiers);
6320 elements = Fcons (unmodified, Fcons (mask, Qnil));
6322 /* Cache the parsing results on SYMBOL. */
6323 Fput (symbol, Qevent_symbol_element_mask,
6324 elements);
6325 Fput (symbol, Qevent_symbol_elements,
6326 Fcons (unmodified, lispy_modifier_list (modifiers)));
6328 /* Since we know that SYMBOL is modifiers applied to unmodified,
6329 it would be nice to put that in unmodified's cache.
6330 But we can't, since we're not sure that parse_modifiers is
6331 canonical. */
6333 return elements;
6337 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers,
6338 Sevent_symbol_parse_modifiers, 1, 1, 0,
6339 doc: /* Parse the event symbol. For internal use. */)
6340 (Lisp_Object symbol)
6342 /* Fill the cache if needed. */
6343 parse_modifiers (symbol);
6344 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6345 and use the Lispier representation stored on Qevent_symbol_elements
6346 instead. */
6347 return Fget (symbol, Qevent_symbol_elements);
6350 /* Apply the modifiers MODIFIERS to the symbol BASE.
6351 BASE must be unmodified.
6353 This is like apply_modifiers_uncached, but uses BASE's
6354 Qmodifier_cache property, if present. It also builds
6355 Qevent_symbol_elements properties, since it has that info anyway.
6357 apply_modifiers copies the value of BASE's Qevent_kind property to
6358 the modified symbol. */
6359 static Lisp_Object
6360 apply_modifiers (int modifiers, Lisp_Object base)
6362 Lisp_Object cache, idx, entry, new_symbol;
6364 /* Mask out upper bits. We don't know where this value's been. */
6365 modifiers &= INTMASK;
6367 if (INTEGERP (base))
6368 return make_number (XINT (base) | modifiers);
6370 /* The click modifier never figures into cache indices. */
6371 cache = Fget (base, Qmodifier_cache);
6372 XSETFASTINT (idx, (modifiers & ~click_modifier));
6373 entry = assq_no_quit (idx, cache);
6375 if (CONSP (entry))
6376 new_symbol = XCDR (entry);
6377 else
6379 /* We have to create the symbol ourselves. */
6380 new_symbol = apply_modifiers_uncached (modifiers,
6381 SSDATA (SYMBOL_NAME (base)),
6382 SCHARS (SYMBOL_NAME (base)),
6383 SBYTES (SYMBOL_NAME (base)));
6385 /* Add the new symbol to the base's cache. */
6386 entry = Fcons (idx, new_symbol);
6387 Fput (base, Qmodifier_cache, Fcons (entry, cache));
6389 /* We have the parsing info now for free, so we could add it to
6390 the caches:
6391 XSETFASTINT (idx, modifiers);
6392 Fput (new_symbol, Qevent_symbol_element_mask,
6393 Fcons (base, Fcons (idx, Qnil)));
6394 Fput (new_symbol, Qevent_symbol_elements,
6395 Fcons (base, lispy_modifier_list (modifiers)));
6396 Sadly, this is only correct if `base' is indeed a base event,
6397 which is not necessarily the case. -stef */
6400 /* Make sure this symbol is of the same kind as BASE.
6402 You'd think we could just set this once and for all when we
6403 intern the symbol above, but reorder_modifiers may call us when
6404 BASE's property isn't set right; we can't assume that just
6405 because it has a Qmodifier_cache property it must have its
6406 Qevent_kind set right as well. */
6407 if (NILP (Fget (new_symbol, Qevent_kind)))
6409 Lisp_Object kind;
6411 kind = Fget (base, Qevent_kind);
6412 if (! NILP (kind))
6413 Fput (new_symbol, Qevent_kind, kind);
6416 return new_symbol;
6420 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6421 return a symbol with the modifiers placed in the canonical order.
6422 Canonical order is alphabetical, except for down and drag, which
6423 always come last. The 'click' modifier is never written out.
6425 Fdefine_key calls this to make sure that (for example) C-M-foo
6426 and M-C-foo end up being equivalent in the keymap. */
6428 Lisp_Object
6429 reorder_modifiers (Lisp_Object symbol)
6431 /* It's hopefully okay to write the code this way, since everything
6432 will soon be in caches, and no consing will be done at all. */
6433 Lisp_Object parsed;
6435 parsed = parse_modifiers (symbol);
6436 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed))),
6437 XCAR (parsed));
6441 /* For handling events, we often want to produce a symbol whose name
6442 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6443 to some base, like the name of a function key or mouse button.
6444 modify_event_symbol produces symbols of this sort.
6446 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6447 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6448 in the table.
6450 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6451 into symbol names, or a string specifying a name stem used to
6452 construct a symbol name or the form `STEM-N', where N is the decimal
6453 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6454 non-nil; otherwise NAME_TABLE is used.
6456 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6457 persist between calls to modify_event_symbol that it can use to
6458 store a cache of the symbols it's generated for this NAME_TABLE
6459 before. The object stored there may be a vector or an alist.
6461 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6463 MODIFIERS is a set of modifier bits (as given in struct input_events)
6464 whose prefixes should be applied to the symbol name.
6466 SYMBOL_KIND is the value to be placed in the event_kind property of
6467 the returned symbol.
6469 The symbols we create are supposed to have an
6470 `event-symbol-elements' property, which lists the modifiers present
6471 in the symbol's name. */
6473 static Lisp_Object
6474 modify_event_symbol (ptrdiff_t symbol_num, int modifiers, Lisp_Object symbol_kind,
6475 Lisp_Object name_alist_or_stem, const char *const *name_table,
6476 Lisp_Object *symbol_table, ptrdiff_t table_size)
6478 Lisp_Object value;
6479 Lisp_Object symbol_int;
6481 /* Get rid of the "vendor-specific" bit here. */
6482 XSETINT (symbol_int, symbol_num & 0xffffff);
6484 /* Is this a request for a valid symbol? */
6485 if (symbol_num < 0 || symbol_num >= table_size)
6486 return Qnil;
6488 if (CONSP (*symbol_table))
6489 value = Fcdr (assq_no_quit (symbol_int, *symbol_table));
6491 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6492 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6493 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6494 we've never used that symbol before. */
6495 else
6497 if (! VECTORP (*symbol_table)
6498 || ASIZE (*symbol_table) != table_size)
6500 Lisp_Object size;
6502 XSETFASTINT (size, table_size);
6503 *symbol_table = Fmake_vector (size, Qnil);
6506 value = XVECTOR (*symbol_table)->contents[symbol_num];
6509 /* Have we already used this symbol before? */
6510 if (NILP (value))
6512 /* No; let's create it. */
6513 if (CONSP (name_alist_or_stem))
6514 value = Fcdr_safe (Fassq (symbol_int, name_alist_or_stem));
6515 else if (STRINGP (name_alist_or_stem))
6517 char *buf;
6518 ptrdiff_t len = (SBYTES (name_alist_or_stem)
6519 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT));
6520 USE_SAFE_ALLOCA;
6521 SAFE_ALLOCA (buf, char *, len);
6522 esprintf (buf, "%s-%"pI"d", SDATA (name_alist_or_stem),
6523 XINT (symbol_int) + 1);
6524 value = intern (buf);
6525 SAFE_FREE ();
6527 else if (name_table != 0 && name_table[symbol_num])
6528 value = intern (name_table[symbol_num]);
6530 #ifdef HAVE_WINDOW_SYSTEM
6531 if (NILP (value))
6533 char *name = x_get_keysym_name (symbol_num);
6534 if (name)
6535 value = intern (name);
6537 #endif
6539 if (NILP (value))
6541 char buf[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT)];
6542 sprintf (buf, "key-%"pD"d", symbol_num);
6543 value = intern (buf);
6546 if (CONSP (*symbol_table))
6547 *symbol_table = Fcons (Fcons (symbol_int, value), *symbol_table);
6548 else
6549 XVECTOR (*symbol_table)->contents[symbol_num] = value;
6551 /* Fill in the cache entries for this symbol; this also
6552 builds the Qevent_symbol_elements property, which the user
6553 cares about. */
6554 apply_modifiers (modifiers & click_modifier, value);
6555 Fput (value, Qevent_kind, symbol_kind);
6558 /* Apply modifiers to that symbol. */
6559 return apply_modifiers (modifiers, value);
6562 /* Convert a list that represents an event type,
6563 such as (ctrl meta backspace), into the usual representation of that
6564 event type as a number or a symbol. */
6566 DEFUN ("event-convert-list", Fevent_convert_list, Sevent_convert_list, 1, 1, 0,
6567 doc: /* Convert the event description list EVENT-DESC to an event type.
6568 EVENT-DESC should contain one base event type (a character or symbol)
6569 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6570 drag, down, double or triple). The base must be last.
6571 The return value is an event type (a character or symbol) which
6572 has the same base event type and all the specified modifiers. */)
6573 (Lisp_Object event_desc)
6575 Lisp_Object base;
6576 int modifiers = 0;
6577 Lisp_Object rest;
6579 base = Qnil;
6580 rest = event_desc;
6581 while (CONSP (rest))
6583 Lisp_Object elt;
6584 int this = 0;
6586 elt = XCAR (rest);
6587 rest = XCDR (rest);
6589 /* Given a symbol, see if it is a modifier name. */
6590 if (SYMBOLP (elt) && CONSP (rest))
6591 this = parse_solitary_modifier (elt);
6593 if (this != 0)
6594 modifiers |= this;
6595 else if (!NILP (base))
6596 error ("Two bases given in one event");
6597 else
6598 base = elt;
6602 /* Let the symbol A refer to the character A. */
6603 if (SYMBOLP (base) && SCHARS (SYMBOL_NAME (base)) == 1)
6604 XSETINT (base, SREF (SYMBOL_NAME (base), 0));
6606 if (INTEGERP (base))
6608 /* Turn (shift a) into A. */
6609 if ((modifiers & shift_modifier) != 0
6610 && (XINT (base) >= 'a' && XINT (base) <= 'z'))
6612 XSETINT (base, XINT (base) - ('a' - 'A'));
6613 modifiers &= ~shift_modifier;
6616 /* Turn (control a) into C-a. */
6617 if (modifiers & ctrl_modifier)
6618 return make_number ((modifiers & ~ctrl_modifier)
6619 | make_ctrl_char (XINT (base)));
6620 else
6621 return make_number (modifiers | XINT (base));
6623 else if (SYMBOLP (base))
6624 return apply_modifiers (modifiers, base);
6625 else
6627 error ("Invalid base event");
6628 return Qnil;
6632 /* Try to recognize SYMBOL as a modifier name.
6633 Return the modifier flag bit, or 0 if not recognized. */
6636 parse_solitary_modifier (Lisp_Object symbol)
6638 Lisp_Object name = SYMBOL_NAME (symbol);
6640 switch (SREF (name, 0))
6642 #define SINGLE_LETTER_MOD(BIT) \
6643 if (SBYTES (name) == 1) \
6644 return BIT;
6646 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6647 if (LEN == SBYTES (name) \
6648 && ! strncmp (SSDATA (name), NAME, LEN)) \
6649 return BIT;
6651 case 'A':
6652 SINGLE_LETTER_MOD (alt_modifier);
6653 break;
6655 case 'a':
6656 MULTI_LETTER_MOD (alt_modifier, "alt", 3);
6657 break;
6659 case 'C':
6660 SINGLE_LETTER_MOD (ctrl_modifier);
6661 break;
6663 case 'c':
6664 MULTI_LETTER_MOD (ctrl_modifier, "ctrl", 4);
6665 MULTI_LETTER_MOD (ctrl_modifier, "control", 7);
6666 break;
6668 case 'H':
6669 SINGLE_LETTER_MOD (hyper_modifier);
6670 break;
6672 case 'h':
6673 MULTI_LETTER_MOD (hyper_modifier, "hyper", 5);
6674 break;
6676 case 'M':
6677 SINGLE_LETTER_MOD (meta_modifier);
6678 break;
6680 case 'm':
6681 MULTI_LETTER_MOD (meta_modifier, "meta", 4);
6682 break;
6684 case 'S':
6685 SINGLE_LETTER_MOD (shift_modifier);
6686 break;
6688 case 's':
6689 MULTI_LETTER_MOD (shift_modifier, "shift", 5);
6690 MULTI_LETTER_MOD (super_modifier, "super", 5);
6691 SINGLE_LETTER_MOD (super_modifier);
6692 break;
6694 case 'd':
6695 MULTI_LETTER_MOD (drag_modifier, "drag", 4);
6696 MULTI_LETTER_MOD (down_modifier, "down", 4);
6697 MULTI_LETTER_MOD (double_modifier, "double", 6);
6698 break;
6700 case 't':
6701 MULTI_LETTER_MOD (triple_modifier, "triple", 6);
6702 break;
6704 #undef SINGLE_LETTER_MOD
6705 #undef MULTI_LETTER_MOD
6708 return 0;
6711 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6712 Such a list is not valid as an event,
6713 but it can be a Lucid-style event type list. */
6716 lucid_event_type_list_p (Lisp_Object object)
6718 Lisp_Object tail;
6720 if (! CONSP (object))
6721 return 0;
6723 if (EQ (XCAR (object), Qhelp_echo)
6724 || EQ (XCAR (object), Qvertical_line)
6725 || EQ (XCAR (object), Qmode_line)
6726 || EQ (XCAR (object), Qheader_line))
6727 return 0;
6729 for (tail = object; CONSP (tail); tail = XCDR (tail))
6731 Lisp_Object elt;
6732 elt = XCAR (tail);
6733 if (! (INTEGERP (elt) || SYMBOLP (elt)))
6734 return 0;
6737 return NILP (tail);
6740 /* Store into *addr a value nonzero if terminal input chars are available.
6741 Serves the purpose of ioctl (0, FIONREAD, addr)
6742 but works even if FIONREAD does not exist.
6743 (In fact, this may actually read some input.)
6745 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6746 timer events that are ripe.
6747 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6748 events (FOCUS_IN_EVENT).
6749 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6750 movements and toolkit scroll bar thumb drags. */
6752 static void
6753 get_input_pending (int *addr, int flags)
6755 /* First of all, have we already counted some input? */
6756 *addr = (!NILP (Vquit_flag) || readable_events (flags));
6758 /* If input is being read as it arrives, and we have none, there is none. */
6759 if (*addr > 0 || (interrupt_input && ! interrupts_deferred))
6760 return;
6762 /* Try to read some input and see how much we get. */
6763 gobble_input (0);
6764 *addr = (!NILP (Vquit_flag) || readable_events (flags));
6767 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6769 void
6770 gobble_input (int expected)
6772 #ifdef SIGIO
6773 if (interrupt_input)
6775 SIGMASKTYPE mask;
6776 mask = sigblock (sigmask (SIGIO));
6777 read_avail_input (expected);
6778 sigsetmask (mask);
6780 else
6781 #ifdef POLL_FOR_INPUT
6782 /* XXX This condition was (read_socket_hook && !interrupt_input),
6783 but read_socket_hook is not global anymore. Let's pretend that
6784 it's always set. */
6785 if (!interrupt_input && poll_suppress_count == 0)
6787 SIGMASKTYPE mask;
6788 mask = sigblock (sigmask (SIGALRM));
6789 read_avail_input (expected);
6790 sigsetmask (mask);
6792 else
6793 #endif
6794 #endif
6795 read_avail_input (expected);
6798 /* Put a BUFFER_SWITCH_EVENT in the buffer
6799 so that read_key_sequence will notice the new current buffer. */
6801 void
6802 record_asynch_buffer_change (void)
6804 struct input_event event;
6805 Lisp_Object tem;
6806 EVENT_INIT (event);
6808 event.kind = BUFFER_SWITCH_EVENT;
6809 event.frame_or_window = Qnil;
6810 event.arg = Qnil;
6812 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6813 The purpose of the event is to make read_key_sequence look up the
6814 keymaps again. If we aren't in read_key_sequence, we don't need one,
6815 and the event could cause trouble by messing up (input-pending-p).
6816 Note: Fwaiting_for_user_input_p always returns nil when async
6817 subprocesses aren't supported. */
6818 tem = Fwaiting_for_user_input_p ();
6819 if (NILP (tem))
6820 return;
6822 /* Make sure no interrupt happens while storing the event. */
6823 #ifdef SIGIO
6824 if (interrupt_input)
6826 SIGMASKTYPE mask;
6827 mask = sigblock (sigmask (SIGIO));
6828 kbd_buffer_store_event (&event);
6829 sigsetmask (mask);
6831 else
6832 #endif
6834 stop_polling ();
6835 kbd_buffer_store_event (&event);
6836 start_polling ();
6840 /* Read any terminal input already buffered up by the system
6841 into the kbd_buffer, but do not wait.
6843 EXPECTED should be nonzero if the caller knows there is some input.
6845 Returns the number of keyboard chars read, or -1 meaning
6846 this is a bad time to try to read input. */
6848 static int
6849 read_avail_input (int expected)
6851 int nread = 0;
6852 int err = 0;
6853 struct terminal *t;
6855 /* Store pending user signal events, if any. */
6856 if (store_user_signal_events ())
6857 expected = 0;
6859 /* Loop through the available terminals, and call their input hooks. */
6860 t = terminal_list;
6861 while (t)
6863 struct terminal *next = t->next_terminal;
6865 if (t->read_socket_hook)
6867 int nr;
6868 struct input_event hold_quit;
6870 EVENT_INIT (hold_quit);
6871 hold_quit.kind = NO_EVENT;
6873 /* No need for FIONREAD or fcntl; just say don't wait. */
6874 while (nr = (*t->read_socket_hook) (t, expected, &hold_quit), nr > 0)
6876 nread += nr;
6877 expected = 0;
6880 if (nr == -1) /* Not OK to read input now. */
6882 err = 1;
6884 else if (nr == -2) /* Non-transient error. */
6886 /* The terminal device terminated; it should be closed. */
6888 /* Kill Emacs if this was our last terminal. */
6889 if (!terminal_list->next_terminal)
6890 /* Formerly simply reported no input, but that
6891 sometimes led to a failure of Emacs to terminate.
6892 SIGHUP seems appropriate if we can't reach the
6893 terminal. */
6894 /* ??? Is it really right to send the signal just to
6895 this process rather than to the whole process
6896 group? Perhaps on systems with FIONREAD Emacs is
6897 alone in its group. */
6898 kill (getpid (), SIGHUP);
6900 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6902 Lisp_Object tmp;
6903 XSETTERMINAL (tmp, t);
6904 Fdelete_terminal (tmp, Qnoelisp);
6908 if (hold_quit.kind != NO_EVENT)
6909 kbd_buffer_store_event (&hold_quit);
6912 t = next;
6915 if (err && !nread)
6916 nread = -1;
6918 frame_make_pointer_visible ();
6920 return nread;
6923 static void
6924 decode_keyboard_code (struct tty_display_info *tty,
6925 struct coding_system *coding,
6926 unsigned char *buf, int nbytes)
6928 unsigned char *src = buf;
6929 const unsigned char *p;
6930 int i;
6932 if (nbytes == 0)
6933 return;
6934 if (tty->meta_key != 2)
6935 for (i = 0; i < nbytes; i++)
6936 buf[i] &= ~0x80;
6937 if (coding->carryover_bytes > 0)
6939 src = alloca (coding->carryover_bytes + nbytes);
6940 memcpy (src, coding->carryover, coding->carryover_bytes);
6941 memcpy (src + coding->carryover_bytes, buf, nbytes);
6942 nbytes += coding->carryover_bytes;
6944 coding->destination = alloca (nbytes * 4);
6945 coding->dst_bytes = nbytes * 4;
6946 decode_coding_c_string (coding, src, nbytes, Qnil);
6947 if (coding->produced_char == 0)
6948 return;
6949 for (i = 0, p = coding->destination; i < coding->produced_char; i++)
6951 struct input_event event_buf;
6953 EVENT_INIT (event_buf);
6954 event_buf.code = STRING_CHAR_ADVANCE (p);
6955 event_buf.kind =
6956 (ASCII_CHAR_P (event_buf.code)
6957 ? ASCII_KEYSTROKE_EVENT : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6958 /* See the comment in tty_read_avail_input. */
6959 event_buf.frame_or_window = tty->top_frame;
6960 event_buf.arg = Qnil;
6961 kbd_buffer_store_event (&event_buf);
6965 /* This is the tty way of reading available input.
6967 Note that each terminal device has its own `struct terminal' object,
6968 and so this function is called once for each individual termcap
6969 terminal. The first parameter indicates which terminal to read from. */
6972 tty_read_avail_input (struct terminal *terminal,
6973 int expected,
6974 struct input_event *hold_quit)
6976 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6977 the kbd_buffer can really hold. That may prevent loss
6978 of characters on some systems when input is stuffed at us. */
6979 unsigned char cbuf[KBD_BUFFER_SIZE - 1];
6980 int n_to_read, i;
6981 struct tty_display_info *tty = terminal->display_info.tty;
6982 int nread = 0;
6983 #ifdef subprocesses
6984 int buffer_free = KBD_BUFFER_SIZE - kbd_buffer_nr_stored () - 1;
6986 if (kbd_on_hold_p () || buffer_free <= 0)
6987 return 0;
6988 #endif /* subprocesses */
6990 if (!terminal->name) /* Don't read from a dead terminal. */
6991 return 0;
6993 if (terminal->type != output_termcap
6994 && terminal->type != output_msdos_raw)
6995 abort ();
6997 /* XXX I think the following code should be moved to separate hook
6998 functions in system-dependent files. */
6999 #ifdef WINDOWSNT
7000 return 0;
7001 #else /* not WINDOWSNT */
7002 if (! tty->term_initted) /* In case we get called during bootstrap. */
7003 return 0;
7005 if (! tty->input)
7006 return 0; /* The terminal is suspended. */
7008 #ifdef MSDOS
7009 n_to_read = dos_keysns ();
7010 if (n_to_read == 0)
7011 return 0;
7013 cbuf[0] = dos_keyread ();
7014 nread = 1;
7016 #else /* not MSDOS */
7017 #ifdef HAVE_GPM
7018 if (gpm_tty == tty)
7020 Gpm_Event event;
7021 struct input_event gpm_hold_quit;
7022 int gpm, fd = gpm_fd;
7024 EVENT_INIT (gpm_hold_quit);
7025 gpm_hold_quit.kind = NO_EVENT;
7027 /* gpm==1 if event received.
7028 gpm==0 if the GPM daemon has closed the connection, in which case
7029 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7030 we save it in `fd' so close_gpm can remove it from the
7031 select masks.
7032 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7033 while (gpm = Gpm_GetEvent (&event), gpm == 1) {
7034 nread += handle_one_term_event (tty, &event, &gpm_hold_quit);
7036 if (gpm == 0)
7037 /* Presumably the GPM daemon has closed the connection. */
7038 close_gpm (fd);
7039 if (gpm_hold_quit.kind != NO_EVENT)
7040 kbd_buffer_store_event (&gpm_hold_quit);
7041 if (nread)
7042 return nread;
7044 #endif /* HAVE_GPM */
7046 /* Determine how many characters we should *try* to read. */
7047 #ifdef FIONREAD
7048 /* Find out how much input is available. */
7049 if (ioctl (fileno (tty->input), FIONREAD, &n_to_read) < 0)
7051 if (! noninteractive)
7052 return -2; /* Close this terminal. */
7053 else
7054 n_to_read = 0;
7056 if (n_to_read == 0)
7057 return 0;
7058 if (n_to_read > sizeof cbuf)
7059 n_to_read = sizeof cbuf;
7060 #else /* no FIONREAD */
7061 #if defined (USG) || defined (CYGWIN)
7062 /* Read some input if available, but don't wait. */
7063 n_to_read = sizeof cbuf;
7064 fcntl (fileno (tty->input), F_SETFL, O_NDELAY);
7065 #else
7066 you lose;
7067 #endif
7068 #endif
7070 #ifdef subprocesses
7071 /* Don't read more than we can store. */
7072 if (n_to_read > buffer_free)
7073 n_to_read = buffer_free;
7074 #endif /* subprocesses */
7076 /* Now read; for one reason or another, this will not block.
7077 NREAD is set to the number of chars read. */
7080 nread = emacs_read (fileno (tty->input), (char *) cbuf, n_to_read);
7081 /* POSIX infers that processes which are not in the session leader's
7082 process group won't get SIGHUP's at logout time. BSDI adheres to
7083 this part standard and returns -1 from read (0) with errno==EIO
7084 when the control tty is taken away.
7085 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7086 if (nread == -1 && errno == EIO)
7087 return -2; /* Close this terminal. */
7088 #if defined (AIX) && defined (_BSD)
7089 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7090 This looks incorrect, but it isn't, because _BSD causes
7091 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7092 and that causes a value other than 0 when there is no input. */
7093 if (nread == 0)
7094 return -2; /* Close this terminal. */
7095 #endif
7097 while (
7098 /* We used to retry the read if it was interrupted.
7099 But this does the wrong thing when O_NDELAY causes
7100 an EAGAIN error. Does anybody know of a situation
7101 where a retry is actually needed? */
7102 #if 0
7103 nread < 0 && (errno == EAGAIN
7104 #ifdef EFAULT
7105 || errno == EFAULT
7106 #endif
7107 #ifdef EBADSLT
7108 || errno == EBADSLT
7109 #endif
7111 #else
7113 #endif
7116 #ifndef FIONREAD
7117 #if defined (USG) || defined (CYGWIN)
7118 fcntl (fileno (tty->input), F_SETFL, 0);
7119 #endif /* USG or CYGWIN */
7120 #endif /* no FIONREAD */
7122 if (nread <= 0)
7123 return nread;
7125 #endif /* not MSDOS */
7126 #endif /* not WINDOWSNT */
7128 if (TERMINAL_KEYBOARD_CODING (terminal)->common_flags
7129 & CODING_REQUIRE_DECODING_MASK)
7131 struct coding_system *coding = TERMINAL_KEYBOARD_CODING (terminal);
7132 int from;
7134 /* Decode the key sequence except for those with meta
7135 modifiers. */
7136 for (i = from = 0; ; i++)
7137 if (i == nread || (tty->meta_key == 1 && (cbuf[i] & 0x80)))
7139 struct input_event buf;
7141 decode_keyboard_code (tty, coding, cbuf + from, i - from);
7142 if (i == nread)
7143 break;
7145 EVENT_INIT (buf);
7146 buf.kind = ASCII_KEYSTROKE_EVENT;
7147 buf.modifiers = meta_modifier;
7148 buf.code = cbuf[i] & ~0x80;
7149 /* See the comment below. */
7150 buf.frame_or_window = tty->top_frame;
7151 buf.arg = Qnil;
7152 kbd_buffer_store_event (&buf);
7153 from = i + 1;
7155 return nread;
7158 for (i = 0; i < nread; i++)
7160 struct input_event buf;
7161 EVENT_INIT (buf);
7162 buf.kind = ASCII_KEYSTROKE_EVENT;
7163 buf.modifiers = 0;
7164 if (tty->meta_key == 1 && (cbuf[i] & 0x80))
7165 buf.modifiers = meta_modifier;
7166 if (tty->meta_key != 2)
7167 cbuf[i] &= ~0x80;
7169 buf.code = cbuf[i];
7170 /* Set the frame corresponding to the active tty. Note that the
7171 value of selected_frame is not reliable here, redisplay tends
7172 to temporarily change it. */
7173 buf.frame_or_window = tty->top_frame;
7174 buf.arg = Qnil;
7176 kbd_buffer_store_event (&buf);
7177 /* Don't look at input that follows a C-g too closely.
7178 This reduces lossage due to autorepeat on C-g. */
7179 if (buf.kind == ASCII_KEYSTROKE_EVENT
7180 && buf.code == quit_char)
7181 break;
7184 return nread;
7187 #if defined SYNC_INPUT || defined SIGIO
7188 static void
7189 handle_async_input (void)
7191 interrupt_input_pending = 0;
7192 #ifdef SYNC_INPUT
7193 pending_signals = pending_atimers;
7194 #endif
7195 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7196 doing anything dangerous. */
7197 #ifdef HAVE_NS
7198 ++handling_signal;
7199 #endif
7200 while (1)
7202 int nread;
7203 nread = read_avail_input (1);
7204 /* -1 means it's not ok to read the input now.
7205 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7206 0 means there was no keyboard input available. */
7207 if (nread <= 0)
7208 break;
7210 #ifdef HAVE_NS
7211 --handling_signal;
7212 #endif
7214 #endif /* SYNC_INPUT || SIGIO */
7216 #ifdef SYNC_INPUT
7217 void
7218 process_pending_signals (void)
7220 if (interrupt_input_pending)
7221 handle_async_input ();
7222 do_pending_atimers ();
7224 #endif
7226 #ifdef SIGIO /* for entire page */
7227 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7229 static void
7230 input_available_signal (int signo)
7232 /* Must preserve main program's value of errno. */
7233 int old_errno = errno;
7234 SIGNAL_THREAD_CHECK (signo);
7236 #ifdef SYNC_INPUT
7237 interrupt_input_pending = 1;
7238 pending_signals = 1;
7239 #endif
7241 if (input_available_clear_time)
7242 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
7244 #ifndef SYNC_INPUT
7245 handle_async_input ();
7246 #endif
7248 errno = old_errno;
7250 #endif /* SIGIO */
7252 /* Send ourselves a SIGIO.
7254 This function exists so that the UNBLOCK_INPUT macro in
7255 blockinput.h can have some way to take care of input we put off
7256 dealing with, without assuming that every file which uses
7257 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7258 void
7259 reinvoke_input_signal (void)
7261 #ifdef SIGIO
7262 handle_async_input ();
7263 #endif
7268 /* User signal events. */
7270 struct user_signal_info
7272 /* Signal number. */
7273 int sig;
7275 /* Name of the signal. */
7276 char *name;
7278 /* Number of pending signals. */
7279 int npending;
7281 struct user_signal_info *next;
7284 /* List of user signals. */
7285 static struct user_signal_info *user_signals = NULL;
7287 void
7288 add_user_signal (int sig, const char *name)
7290 struct user_signal_info *p;
7292 for (p = user_signals; p; p = p->next)
7293 if (p->sig == sig)
7294 /* Already added. */
7295 return;
7297 p = xmalloc (sizeof (struct user_signal_info));
7298 p->sig = sig;
7299 p->name = xstrdup (name);
7300 p->npending = 0;
7301 p->next = user_signals;
7302 user_signals = p;
7304 signal (sig, handle_user_signal);
7307 static void
7308 handle_user_signal (int sig)
7310 int old_errno = errno;
7311 struct user_signal_info *p;
7312 const char *special_event_name = NULL;
7314 SIGNAL_THREAD_CHECK (sig);
7316 if (SYMBOLP (Vdebug_on_event))
7317 special_event_name = SSDATA (SYMBOL_NAME (Vdebug_on_event));
7319 for (p = user_signals; p; p = p->next)
7320 if (p->sig == sig)
7322 if (special_event_name &&
7323 strcmp (special_event_name, p->name) == 0)
7325 /* Enter the debugger in many ways. */
7326 debug_on_next_call = 1;
7327 debug_on_quit = 1;
7328 Vquit_flag = Qt;
7329 Vinhibit_quit = Qnil;
7331 /* Eat the event. */
7332 break;
7335 p->npending++;
7336 #ifdef SIGIO
7337 if (interrupt_input)
7338 kill (getpid (), SIGIO);
7339 else
7340 #endif
7342 /* Tell wait_reading_process_output that it needs to wake
7343 up and look around. */
7344 if (input_available_clear_time)
7345 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
7347 break;
7350 errno = old_errno;
7353 static char *
7354 find_user_signal_name (int sig)
7356 struct user_signal_info *p;
7358 for (p = user_signals; p; p = p->next)
7359 if (p->sig == sig)
7360 return p->name;
7362 return NULL;
7365 static int
7366 store_user_signal_events (void)
7368 struct user_signal_info *p;
7369 struct input_event buf;
7370 int nstored = 0;
7372 for (p = user_signals; p; p = p->next)
7373 if (p->npending > 0)
7375 SIGMASKTYPE mask;
7377 if (nstored == 0)
7379 memset (&buf, 0, sizeof buf);
7380 buf.kind = USER_SIGNAL_EVENT;
7381 buf.frame_or_window = selected_frame;
7383 nstored += p->npending;
7385 mask = sigblock (sigmask (p->sig));
7388 buf.code = p->sig;
7389 kbd_buffer_store_event (&buf);
7390 p->npending--;
7392 while (p->npending > 0);
7393 sigsetmask (mask);
7396 return nstored;
7400 static void menu_bar_item (Lisp_Object, Lisp_Object, Lisp_Object, void*);
7401 static Lisp_Object menu_bar_one_keymap_changed_items;
7403 /* These variables hold the vector under construction within
7404 menu_bar_items and its subroutines, and the current index
7405 for storing into that vector. */
7406 static Lisp_Object menu_bar_items_vector;
7407 static int menu_bar_items_index;
7410 static const char* separator_names[] = {
7411 "space",
7412 "no-line",
7413 "single-line",
7414 "double-line",
7415 "single-dashed-line",
7416 "double-dashed-line",
7417 "shadow-etched-in",
7418 "shadow-etched-out",
7419 "shadow-etched-in-dash",
7420 "shadow-etched-out-dash",
7421 "shadow-double-etched-in",
7422 "shadow-double-etched-out",
7423 "shadow-double-etched-in-dash",
7424 "shadow-double-etched-out-dash",
7428 /* Return non-zero if LABEL specifies a separator. */
7431 menu_separator_name_p (const char *label)
7433 if (!label)
7434 return 0;
7435 else if (strlen (label) > 3
7436 && strncmp (label, "--", 2) == 0
7437 && label[2] != '-')
7439 int i;
7440 label += 2;
7441 for (i = 0; separator_names[i]; ++i)
7442 if (strcmp (label, separator_names[i]) == 0)
7443 return 1;
7445 else
7447 /* It's a separator if it contains only dashes. */
7448 while (*label == '-')
7449 ++label;
7450 return (*label == 0);
7453 return 0;
7457 /* Return a vector of menu items for a menu bar, appropriate
7458 to the current buffer. Each item has three elements in the vector:
7459 KEY STRING MAPLIST.
7461 OLD is an old vector we can optionally reuse, or nil. */
7463 Lisp_Object
7464 menu_bar_items (Lisp_Object old)
7466 /* The number of keymaps we're scanning right now, and the number of
7467 keymaps we have allocated space for. */
7468 ptrdiff_t nmaps;
7470 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7471 in the current keymaps, or nil where it is not a prefix. */
7472 Lisp_Object *maps;
7474 Lisp_Object def, tail;
7476 ptrdiff_t mapno;
7477 Lisp_Object oquit;
7479 /* In order to build the menus, we need to call the keymap
7480 accessors. They all call QUIT. But this function is called
7481 during redisplay, during which a quit is fatal. So inhibit
7482 quitting while building the menus.
7483 We do this instead of specbind because (1) errors will clear it anyway
7484 and (2) this avoids risk of specpdl overflow. */
7485 oquit = Vinhibit_quit;
7486 Vinhibit_quit = Qt;
7488 if (!NILP (old))
7489 menu_bar_items_vector = old;
7490 else
7491 menu_bar_items_vector = Fmake_vector (make_number (24), Qnil);
7492 menu_bar_items_index = 0;
7494 /* Build our list of keymaps.
7495 If we recognize a function key and replace its escape sequence in
7496 keybuf with its symbol, or if the sequence starts with a mouse
7497 click and we need to switch buffers, we jump back here to rebuild
7498 the initial keymaps from the current buffer. */
7500 Lisp_Object *tmaps;
7502 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7503 if (!NILP (Voverriding_local_map_menu_flag))
7505 /* Yes, use them (if non-nil) as well as the global map. */
7506 maps = (Lisp_Object *) alloca (3 * sizeof (maps[0]));
7507 nmaps = 0;
7508 if (!NILP (KVAR (current_kboard, Voverriding_terminal_local_map)))
7509 maps[nmaps++] = KVAR (current_kboard, Voverriding_terminal_local_map);
7510 if (!NILP (Voverriding_local_map))
7511 maps[nmaps++] = Voverriding_local_map;
7513 else
7515 /* No, so use major and minor mode keymaps and keymap property.
7516 Note that menu-bar bindings in the local-map and keymap
7517 properties may not work reliable, as they are only
7518 recognized when the menu-bar (or mode-line) is updated,
7519 which does not normally happen after every command. */
7520 Lisp_Object tem;
7521 ptrdiff_t nminor;
7522 nminor = current_minor_maps (NULL, &tmaps);
7523 maps = (Lisp_Object *) alloca ((nminor + 3) * sizeof (maps[0]));
7524 nmaps = 0;
7525 if (tem = get_local_map (PT, current_buffer, Qkeymap), !NILP (tem))
7526 maps[nmaps++] = tem;
7527 memcpy (maps + nmaps, tmaps, nminor * sizeof (maps[0]));
7528 nmaps += nminor;
7529 maps[nmaps++] = get_local_map (PT, current_buffer, Qlocal_map);
7531 maps[nmaps++] = current_global_map;
7534 /* Look up in each map the dummy prefix key `menu-bar'. */
7536 for (mapno = nmaps - 1; mapno >= 0; mapno--)
7537 if (!NILP (maps[mapno]))
7539 def = get_keymap (access_keymap (maps[mapno], Qmenu_bar, 1, 0, 1),
7540 0, 1);
7541 if (CONSP (def))
7543 menu_bar_one_keymap_changed_items = Qnil;
7544 map_keymap_canonical (def, menu_bar_item, Qnil, NULL);
7548 /* Move to the end those items that should be at the end. */
7550 for (tail = Vmenu_bar_final_items; CONSP (tail); tail = XCDR (tail))
7552 int i;
7553 int end = menu_bar_items_index;
7555 for (i = 0; i < end; i += 4)
7556 if (EQ (XCAR (tail), XVECTOR (menu_bar_items_vector)->contents[i]))
7558 Lisp_Object tem0, tem1, tem2, tem3;
7559 /* Move the item at index I to the end,
7560 shifting all the others forward. */
7561 tem0 = XVECTOR (menu_bar_items_vector)->contents[i + 0];
7562 tem1 = XVECTOR (menu_bar_items_vector)->contents[i + 1];
7563 tem2 = XVECTOR (menu_bar_items_vector)->contents[i + 2];
7564 tem3 = XVECTOR (menu_bar_items_vector)->contents[i + 3];
7565 if (end > i + 4)
7566 memmove (&XVECTOR (menu_bar_items_vector)->contents[i],
7567 &XVECTOR (menu_bar_items_vector)->contents[i + 4],
7568 (end - i - 4) * sizeof (Lisp_Object));
7569 XVECTOR (menu_bar_items_vector)->contents[end - 4] = tem0;
7570 XVECTOR (menu_bar_items_vector)->contents[end - 3] = tem1;
7571 XVECTOR (menu_bar_items_vector)->contents[end - 2] = tem2;
7572 XVECTOR (menu_bar_items_vector)->contents[end - 1] = tem3;
7573 break;
7577 /* Add nil, nil, nil, nil at the end. */
7579 int i = menu_bar_items_index;
7580 if (i + 4 > ASIZE (menu_bar_items_vector))
7581 menu_bar_items_vector =
7582 larger_vector (menu_bar_items_vector, 4, -1);
7583 /* Add this item. */
7584 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
7585 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
7586 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
7587 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
7588 menu_bar_items_index = i;
7591 Vinhibit_quit = oquit;
7592 return menu_bar_items_vector;
7595 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7596 If there's already an item for KEY, add this DEF to it. */
7598 Lisp_Object item_properties;
7600 static void
7601 menu_bar_item (Lisp_Object key, Lisp_Object item, Lisp_Object dummy1, void *dummy2)
7603 struct gcpro gcpro1;
7604 int i;
7605 Lisp_Object tem;
7607 if (EQ (item, Qundefined))
7609 /* If a map has an explicit `undefined' as definition,
7610 discard any previously made menu bar item. */
7612 for (i = 0; i < menu_bar_items_index; i += 4)
7613 if (EQ (key, XVECTOR (menu_bar_items_vector)->contents[i]))
7615 if (menu_bar_items_index > i + 4)
7616 memmove (&XVECTOR (menu_bar_items_vector)->contents[i],
7617 &XVECTOR (menu_bar_items_vector)->contents[i + 4],
7618 (menu_bar_items_index - i - 4) * sizeof (Lisp_Object));
7619 menu_bar_items_index -= 4;
7623 /* If this keymap has already contributed to this KEY,
7624 don't contribute to it a second time. */
7625 tem = Fmemq (key, menu_bar_one_keymap_changed_items);
7626 if (!NILP (tem) || NILP (item))
7627 return;
7629 menu_bar_one_keymap_changed_items
7630 = Fcons (key, menu_bar_one_keymap_changed_items);
7632 /* We add to menu_bar_one_keymap_changed_items before doing the
7633 parse_menu_item, so that if it turns out it wasn't a menu item,
7634 it still correctly hides any further menu item. */
7635 GCPRO1 (key);
7636 i = parse_menu_item (item, 1);
7637 UNGCPRO;
7638 if (!i)
7639 return;
7641 item = XVECTOR (item_properties)->contents[ITEM_PROPERTY_DEF];
7643 /* Find any existing item for this KEY. */
7644 for (i = 0; i < menu_bar_items_index; i += 4)
7645 if (EQ (key, XVECTOR (menu_bar_items_vector)->contents[i]))
7646 break;
7648 /* If we did not find this KEY, add it at the end. */
7649 if (i == menu_bar_items_index)
7651 /* If vector is too small, get a bigger one. */
7652 if (i + 4 > ASIZE (menu_bar_items_vector))
7653 menu_bar_items_vector = larger_vector (menu_bar_items_vector, 4, -1);
7654 /* Add this item. */
7655 XVECTOR (menu_bar_items_vector)->contents[i++] = key;
7656 XVECTOR (menu_bar_items_vector)->contents[i++]
7657 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_NAME];
7658 XVECTOR (menu_bar_items_vector)->contents[i++] = Fcons (item, Qnil);
7659 XVECTOR (menu_bar_items_vector)->contents[i++] = make_number (0);
7660 menu_bar_items_index = i;
7662 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7663 else
7665 Lisp_Object old;
7666 old = XVECTOR (menu_bar_items_vector)->contents[i + 2];
7667 /* If the new and the old items are not both keymaps,
7668 the lookup will only find `item'. */
7669 item = Fcons (item, KEYMAPP (item) && KEYMAPP (XCAR (old)) ? old : Qnil);
7670 XVECTOR (menu_bar_items_vector)->contents[i + 2] = item;
7674 /* This is used as the handler when calling menu_item_eval_property. */
7675 static Lisp_Object
7676 menu_item_eval_property_1 (Lisp_Object arg)
7678 /* If we got a quit from within the menu computation,
7679 quit all the way out of it. This takes care of C-] in the debugger. */
7680 if (CONSP (arg) && EQ (XCAR (arg), Qquit))
7681 Fsignal (Qquit, Qnil);
7683 return Qnil;
7686 static Lisp_Object
7687 eval_dyn (Lisp_Object form)
7689 return Feval (form, Qnil);
7692 /* Evaluate an expression and return the result (or nil if something
7693 went wrong). Used to evaluate dynamic parts of menu items. */
7694 Lisp_Object
7695 menu_item_eval_property (Lisp_Object sexpr)
7697 ptrdiff_t count = SPECPDL_INDEX ();
7698 Lisp_Object val;
7699 specbind (Qinhibit_redisplay, Qt);
7700 val = internal_condition_case_1 (eval_dyn, sexpr, Qerror,
7701 menu_item_eval_property_1);
7702 return unbind_to (count, val);
7705 /* This function parses a menu item and leaves the result in the
7706 vector item_properties.
7707 ITEM is a key binding, a possible menu item.
7708 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7709 top level.
7710 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7711 parse_menu_item returns true if the item is a menu item and false
7712 otherwise. */
7715 parse_menu_item (Lisp_Object item, int inmenubar)
7717 Lisp_Object def, tem, item_string, start;
7718 Lisp_Object filter;
7719 Lisp_Object keyhint;
7720 int i;
7722 filter = Qnil;
7723 keyhint = Qnil;
7725 if (!CONSP (item))
7726 return 0;
7728 /* Create item_properties vector if necessary. */
7729 if (NILP (item_properties))
7730 item_properties
7731 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE + 1), Qnil);
7733 /* Initialize optional entries. */
7734 for (i = ITEM_PROPERTY_DEF; i < ITEM_PROPERTY_ENABLE; i++)
7735 ASET (item_properties, i, Qnil);
7736 ASET (item_properties, ITEM_PROPERTY_ENABLE, Qt);
7738 /* Save the item here to protect it from GC. */
7739 ASET (item_properties, ITEM_PROPERTY_ITEM, item);
7741 item_string = XCAR (item);
7743 start = item;
7744 item = XCDR (item);
7745 if (STRINGP (item_string))
7747 /* Old format menu item. */
7748 ASET (item_properties, ITEM_PROPERTY_NAME, item_string);
7750 /* Maybe help string. */
7751 if (CONSP (item) && STRINGP (XCAR (item)))
7753 ASET (item_properties, ITEM_PROPERTY_HELP, XCAR (item));
7754 start = item;
7755 item = XCDR (item);
7758 /* Maybe an obsolete key binding cache. */
7759 if (CONSP (item) && CONSP (XCAR (item))
7760 && (NILP (XCAR (XCAR (item)))
7761 || VECTORP (XCAR (XCAR (item)))))
7762 item = XCDR (item);
7764 /* This is the real definition--the function to run. */
7765 ASET (item_properties, ITEM_PROPERTY_DEF, item);
7767 /* Get enable property, if any. */
7768 if (SYMBOLP (item))
7770 tem = Fget (item, Qmenu_enable);
7771 if (!NILP (Venable_disabled_menus_and_buttons))
7772 ASET (item_properties, ITEM_PROPERTY_ENABLE, Qt);
7773 else if (!NILP (tem))
7774 ASET (item_properties, ITEM_PROPERTY_ENABLE, tem);
7777 else if (EQ (item_string, Qmenu_item) && CONSP (item))
7779 /* New format menu item. */
7780 ASET (item_properties, ITEM_PROPERTY_NAME, XCAR (item));
7781 start = XCDR (item);
7782 if (CONSP (start))
7784 /* We have a real binding. */
7785 ASET (item_properties, ITEM_PROPERTY_DEF, XCAR (start));
7787 item = XCDR (start);
7788 /* Is there an obsolete cache list with key equivalences. */
7789 if (CONSP (item) && CONSP (XCAR (item)))
7790 item = XCDR (item);
7792 /* Parse properties. */
7793 while (CONSP (item) && CONSP (XCDR (item)))
7795 tem = XCAR (item);
7796 item = XCDR (item);
7798 if (EQ (tem, QCenable))
7800 if (!NILP (Venable_disabled_menus_and_buttons))
7801 ASET (item_properties, ITEM_PROPERTY_ENABLE, Qt);
7802 else
7803 ASET (item_properties, ITEM_PROPERTY_ENABLE, XCAR (item));
7805 else if (EQ (tem, QCvisible))
7807 /* If got a visible property and that evaluates to nil
7808 then ignore this item. */
7809 tem = menu_item_eval_property (XCAR (item));
7810 if (NILP (tem))
7811 return 0;
7813 else if (EQ (tem, QChelp))
7814 ASET (item_properties, ITEM_PROPERTY_HELP, XCAR (item));
7815 else if (EQ (tem, QCfilter))
7816 filter = item;
7817 else if (EQ (tem, QCkey_sequence))
7819 tem = XCAR (item);
7820 if (SYMBOLP (tem) || STRINGP (tem) || VECTORP (tem))
7821 /* Be GC protected. Set keyhint to item instead of tem. */
7822 keyhint = item;
7824 else if (EQ (tem, QCkeys))
7826 tem = XCAR (item);
7827 if (CONSP (tem) || STRINGP (tem))
7828 ASET (item_properties, ITEM_PROPERTY_KEYEQ, tem);
7830 else if (EQ (tem, QCbutton) && CONSP (XCAR (item)))
7832 Lisp_Object type;
7833 tem = XCAR (item);
7834 type = XCAR (tem);
7835 if (EQ (type, QCtoggle) || EQ (type, QCradio))
7837 ASET (item_properties, ITEM_PROPERTY_SELECTED,
7838 XCDR (tem));
7839 ASET (item_properties, ITEM_PROPERTY_TYPE, type);
7842 item = XCDR (item);
7845 else if (inmenubar || !NILP (start))
7846 return 0;
7848 else
7849 return 0; /* not a menu item */
7851 /* If item string is not a string, evaluate it to get string.
7852 If we don't get a string, skip this item. */
7853 item_string = AREF (item_properties, ITEM_PROPERTY_NAME);
7854 if (!(STRINGP (item_string)))
7856 item_string = menu_item_eval_property (item_string);
7857 if (!STRINGP (item_string))
7858 return 0;
7859 ASET (item_properties, ITEM_PROPERTY_NAME, item_string);
7862 /* If got a filter apply it on definition. */
7863 def = AREF (item_properties, ITEM_PROPERTY_DEF);
7864 if (!NILP (filter))
7866 def = menu_item_eval_property (list2 (XCAR (filter),
7867 list2 (Qquote, def)));
7869 ASET (item_properties, ITEM_PROPERTY_DEF, def);
7872 /* Enable or disable selection of item. */
7873 tem = AREF (item_properties, ITEM_PROPERTY_ENABLE);
7874 if (!EQ (tem, Qt))
7876 tem = menu_item_eval_property (tem);
7877 if (inmenubar && NILP (tem))
7878 return 0; /* Ignore disabled items in menu bar. */
7879 ASET (item_properties, ITEM_PROPERTY_ENABLE, tem);
7882 /* If we got no definition, this item is just unselectable text which
7883 is OK in a submenu but not in the menubar. */
7884 if (NILP (def))
7885 return (!inmenubar);
7887 /* See if this is a separate pane or a submenu. */
7888 def = AREF (item_properties, ITEM_PROPERTY_DEF);
7889 tem = get_keymap (def, 0, 1);
7890 /* For a subkeymap, just record its details and exit. */
7891 if (CONSP (tem))
7893 ASET (item_properties, ITEM_PROPERTY_MAP, tem);
7894 ASET (item_properties, ITEM_PROPERTY_DEF, tem);
7895 return 1;
7898 /* At the top level in the menu bar, do likewise for commands also.
7899 The menu bar does not display equivalent key bindings anyway.
7900 ITEM_PROPERTY_DEF is already set up properly. */
7901 if (inmenubar > 0)
7902 return 1;
7904 { /* This is a command. See if there is an equivalent key binding. */
7905 Lisp_Object keyeq = AREF (item_properties, ITEM_PROPERTY_KEYEQ);
7907 /* The previous code preferred :key-sequence to :keys, so we
7908 preserve this behavior. */
7909 if (STRINGP (keyeq) && !CONSP (keyhint))
7910 keyeq = concat2 (build_string (" "), Fsubstitute_command_keys (keyeq));
7911 else
7913 Lisp_Object prefix = keyeq;
7914 Lisp_Object keys = Qnil;
7916 if (CONSP (prefix))
7918 def = XCAR (prefix);
7919 prefix = XCDR (prefix);
7921 else
7922 def = AREF (item_properties, ITEM_PROPERTY_DEF);
7924 if (CONSP (keyhint) && !NILP (XCAR (keyhint)))
7926 keys = XCAR (keyhint);
7927 tem = Fkey_binding (keys, Qnil, Qnil, Qnil);
7929 /* We have a suggested key. Is it bound to the command? */
7930 if (NILP (tem)
7931 || (!EQ (tem, def)
7932 /* If the command is an alias for another
7933 (such as lmenu.el set it up), check if the
7934 original command matches the cached command. */
7935 && !(SYMBOLP (def) && EQ (tem, XSYMBOL (def)->function))))
7936 keys = Qnil;
7939 if (NILP (keys))
7940 keys = Fwhere_is_internal (def, Qnil, Qt, Qnil, Qnil);
7942 if (!NILP (keys))
7944 tem = Fkey_description (keys, Qnil);
7945 if (CONSP (prefix))
7947 if (STRINGP (XCAR (prefix)))
7948 tem = concat2 (XCAR (prefix), tem);
7949 if (STRINGP (XCDR (prefix)))
7950 tem = concat2 (tem, XCDR (prefix));
7952 keyeq = concat2 (build_string (" "), tem);
7953 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7955 else
7956 keyeq = Qnil;
7959 /* If we have an equivalent key binding, use that. */
7960 ASET (item_properties, ITEM_PROPERTY_KEYEQ, keyeq);
7963 /* Include this when menu help is implemented.
7964 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7965 if (!(NILP (tem) || STRINGP (tem)))
7967 tem = menu_item_eval_property (tem);
7968 if (!STRINGP (tem))
7969 tem = Qnil;
7970 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7974 /* Handle radio buttons or toggle boxes. */
7975 tem = AREF (item_properties, ITEM_PROPERTY_SELECTED);
7976 if (!NILP (tem))
7977 ASET (item_properties, ITEM_PROPERTY_SELECTED,
7978 menu_item_eval_property (tem));
7980 return 1;
7985 /***********************************************************************
7986 Tool-bars
7987 ***********************************************************************/
7989 /* A vector holding tool bar items while they are parsed in function
7990 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7991 in the vector. */
7993 static Lisp_Object tool_bar_items_vector;
7995 /* A vector holding the result of parse_tool_bar_item. Layout is like
7996 the one for a single item in tool_bar_items_vector. */
7998 static Lisp_Object tool_bar_item_properties;
8000 /* Next free index in tool_bar_items_vector. */
8002 static int ntool_bar_items;
8004 /* The symbols `:image' and `:rtl'. */
8006 static Lisp_Object QCimage;
8007 static Lisp_Object QCrtl;
8009 /* Function prototypes. */
8011 static void init_tool_bar_items (Lisp_Object);
8012 static void process_tool_bar_item (Lisp_Object, Lisp_Object, Lisp_Object, void*);
8013 static int parse_tool_bar_item (Lisp_Object, Lisp_Object);
8014 static void append_tool_bar_item (void);
8017 /* Return a vector of tool bar items for keymaps currently in effect.
8018 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8019 tool bar items found. */
8021 Lisp_Object
8022 tool_bar_items (Lisp_Object reuse, int *nitems)
8024 Lisp_Object *maps;
8025 ptrdiff_t nmaps, i;
8026 Lisp_Object oquit;
8027 Lisp_Object *tmaps;
8029 *nitems = 0;
8031 /* In order to build the menus, we need to call the keymap
8032 accessors. They all call QUIT. But this function is called
8033 during redisplay, during which a quit is fatal. So inhibit
8034 quitting while building the menus. We do this instead of
8035 specbind because (1) errors will clear it anyway and (2) this
8036 avoids risk of specpdl overflow. */
8037 oquit = Vinhibit_quit;
8038 Vinhibit_quit = Qt;
8040 /* Initialize tool_bar_items_vector and protect it from GC. */
8041 init_tool_bar_items (reuse);
8043 /* Build list of keymaps in maps. Set nmaps to the number of maps
8044 to process. */
8046 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8047 if (!NILP (Voverriding_local_map_menu_flag))
8049 /* Yes, use them (if non-nil) as well as the global map. */
8050 maps = (Lisp_Object *) alloca (3 * sizeof (maps[0]));
8051 nmaps = 0;
8052 if (!NILP (KVAR (current_kboard, Voverriding_terminal_local_map)))
8053 maps[nmaps++] = KVAR (current_kboard, Voverriding_terminal_local_map);
8054 if (!NILP (Voverriding_local_map))
8055 maps[nmaps++] = Voverriding_local_map;
8057 else
8059 /* No, so use major and minor mode keymaps and keymap property.
8060 Note that tool-bar bindings in the local-map and keymap
8061 properties may not work reliable, as they are only
8062 recognized when the tool-bar (or mode-line) is updated,
8063 which does not normally happen after every command. */
8064 Lisp_Object tem;
8065 ptrdiff_t nminor;
8066 nminor = current_minor_maps (NULL, &tmaps);
8067 maps = (Lisp_Object *) alloca ((nminor + 3) * sizeof (maps[0]));
8068 nmaps = 0;
8069 if (tem = get_local_map (PT, current_buffer, Qkeymap), !NILP (tem))
8070 maps[nmaps++] = tem;
8071 memcpy (maps + nmaps, tmaps, nminor * sizeof (maps[0]));
8072 nmaps += nminor;
8073 maps[nmaps++] = get_local_map (PT, current_buffer, Qlocal_map);
8076 /* Add global keymap at the end. */
8077 maps[nmaps++] = current_global_map;
8079 /* Process maps in reverse order and look up in each map the prefix
8080 key `tool-bar'. */
8081 for (i = nmaps - 1; i >= 0; --i)
8082 if (!NILP (maps[i]))
8084 Lisp_Object keymap;
8086 keymap = get_keymap (access_keymap (maps[i], Qtool_bar, 1, 0, 1), 0, 1);
8087 if (CONSP (keymap))
8088 map_keymap (keymap, process_tool_bar_item, Qnil, NULL, 1);
8091 Vinhibit_quit = oquit;
8092 *nitems = ntool_bar_items / TOOL_BAR_ITEM_NSLOTS;
8093 return tool_bar_items_vector;
8097 /* Process the definition of KEY which is DEF. */
8099 static void
8100 process_tool_bar_item (Lisp_Object key, Lisp_Object def, Lisp_Object data, void *args)
8102 int i;
8103 struct gcpro gcpro1, gcpro2;
8105 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8106 eval. */
8107 GCPRO2 (key, def);
8109 if (EQ (def, Qundefined))
8111 /* If a map has an explicit `undefined' as definition,
8112 discard any previously made item. */
8113 for (i = 0; i < ntool_bar_items; i += TOOL_BAR_ITEM_NSLOTS)
8115 Lisp_Object *v = XVECTOR (tool_bar_items_vector)->contents + i;
8117 if (EQ (key, v[TOOL_BAR_ITEM_KEY]))
8119 if (ntool_bar_items > i + TOOL_BAR_ITEM_NSLOTS)
8120 memmove (v, v + TOOL_BAR_ITEM_NSLOTS,
8121 ((ntool_bar_items - i - TOOL_BAR_ITEM_NSLOTS)
8122 * sizeof (Lisp_Object)));
8123 ntool_bar_items -= TOOL_BAR_ITEM_NSLOTS;
8124 break;
8128 else if (parse_tool_bar_item (key, def))
8129 /* Append a new tool bar item to tool_bar_items_vector. Accept
8130 more than one definition for the same key. */
8131 append_tool_bar_item ();
8133 UNGCPRO;
8137 /* Parse a tool bar item specification ITEM for key KEY and return the
8138 result in tool_bar_item_properties. Value is zero if ITEM is
8139 invalid.
8141 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8143 CAPTION is the caption of the item, If it's not a string, it is
8144 evaluated to get a string.
8146 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8147 as binding are currently ignored.
8149 The following properties are recognized:
8151 - `:enable FORM'.
8153 FORM is evaluated and specifies whether the tool bar item is
8154 enabled or disabled.
8156 - `:visible FORM'
8158 FORM is evaluated and specifies whether the tool bar item is visible.
8160 - `:filter FUNCTION'
8162 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8163 result is stored as the new binding.
8165 - `:button (TYPE SELECTED)'
8167 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8168 and specifies whether the button is selected (pressed) or not.
8170 - `:image IMAGES'
8172 IMAGES is either a single image specification or a vector of four
8173 image specifications. See enum tool_bar_item_images.
8175 - `:help HELP-STRING'.
8177 Gives a help string to display for the tool bar item.
8179 - `:label LABEL-STRING'.
8181 A text label to show with the tool bar button if labels are enabled. */
8183 static int
8184 parse_tool_bar_item (Lisp_Object key, Lisp_Object item)
8186 /* Access slot with index IDX of vector tool_bar_item_properties. */
8187 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8189 Lisp_Object filter = Qnil;
8190 Lisp_Object caption;
8191 int i, have_label = 0;
8193 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8194 Rule out items that aren't lists, don't start with
8195 `menu-item' or whose rest following `tool-bar-item' is not a
8196 list. */
8197 if (!CONSP (item))
8198 return 0;
8200 /* As an exception, allow old-style menu separators. */
8201 if (STRINGP (XCAR (item)))
8202 item = Fcons (XCAR (item), Qnil);
8203 else if (!EQ (XCAR (item), Qmenu_item)
8204 || (item = XCDR (item), !CONSP (item)))
8205 return 0;
8207 /* Create tool_bar_item_properties vector if necessary. Reset it to
8208 defaults. */
8209 if (VECTORP (tool_bar_item_properties))
8211 for (i = 0; i < TOOL_BAR_ITEM_NSLOTS; ++i)
8212 PROP (i) = Qnil;
8214 else
8215 tool_bar_item_properties
8216 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS), Qnil);
8218 /* Set defaults. */
8219 PROP (TOOL_BAR_ITEM_KEY) = key;
8220 PROP (TOOL_BAR_ITEM_ENABLED_P) = Qt;
8222 /* Get the caption of the item. If the caption is not a string,
8223 evaluate it to get a string. If we don't get a string, skip this
8224 item. */
8225 caption = XCAR (item);
8226 if (!STRINGP (caption))
8228 caption = menu_item_eval_property (caption);
8229 if (!STRINGP (caption))
8230 return 0;
8232 PROP (TOOL_BAR_ITEM_CAPTION) = caption;
8234 /* If the rest following the caption is not a list, the menu item is
8235 either a separator, or invalid. */
8236 item = XCDR (item);
8237 if (!CONSP (item))
8239 if (menu_separator_name_p (SSDATA (caption)))
8241 PROP (TOOL_BAR_ITEM_TYPE) = Qt;
8242 #if !defined (USE_GTK) && !defined (HAVE_NS)
8243 /* If we use build_desired_tool_bar_string to render the
8244 tool bar, the separator is rendered as an image. */
8245 PROP (TOOL_BAR_ITEM_IMAGES)
8246 = menu_item_eval_property (Vtool_bar_separator_image_expression);
8247 PROP (TOOL_BAR_ITEM_ENABLED_P) = Qnil;
8248 PROP (TOOL_BAR_ITEM_SELECTED_P) = Qnil;
8249 PROP (TOOL_BAR_ITEM_CAPTION) = Qnil;
8250 #endif
8251 return 1;
8253 return 0;
8256 /* Store the binding. */
8257 PROP (TOOL_BAR_ITEM_BINDING) = XCAR (item);
8258 item = XCDR (item);
8260 /* Ignore cached key binding, if any. */
8261 if (CONSP (item) && CONSP (XCAR (item)))
8262 item = XCDR (item);
8264 /* Process the rest of the properties. */
8265 for (; CONSP (item) && CONSP (XCDR (item)); item = XCDR (XCDR (item)))
8267 Lisp_Object ikey, value;
8269 ikey = XCAR (item);
8270 value = XCAR (XCDR (item));
8272 if (EQ (ikey, QCenable))
8274 /* `:enable FORM'. */
8275 if (!NILP (Venable_disabled_menus_and_buttons))
8276 PROP (TOOL_BAR_ITEM_ENABLED_P) = Qt;
8277 else
8278 PROP (TOOL_BAR_ITEM_ENABLED_P) = value;
8280 else if (EQ (ikey, QCvisible))
8282 /* `:visible FORM'. If got a visible property and that
8283 evaluates to nil then ignore this item. */
8284 if (NILP (menu_item_eval_property (value)))
8285 return 0;
8287 else if (EQ (ikey, QChelp))
8288 /* `:help HELP-STRING'. */
8289 PROP (TOOL_BAR_ITEM_HELP) = value;
8290 else if (EQ (ikey, QCvert_only))
8291 /* `:vert-only t/nil'. */
8292 PROP (TOOL_BAR_ITEM_VERT_ONLY) = value;
8293 else if (EQ (ikey, QClabel))
8295 const char *bad_label = "!!?GARBLED ITEM?!!";
8296 /* `:label LABEL-STRING'. */
8297 PROP (TOOL_BAR_ITEM_LABEL) = STRINGP (value)
8298 ? value
8299 : build_string (bad_label);
8300 have_label = 1;
8302 else if (EQ (ikey, QCfilter))
8303 /* ':filter FORM'. */
8304 filter = value;
8305 else if (EQ (ikey, QCbutton) && CONSP (value))
8307 /* `:button (TYPE . SELECTED)'. */
8308 Lisp_Object type, selected;
8310 type = XCAR (value);
8311 selected = XCDR (value);
8312 if (EQ (type, QCtoggle) || EQ (type, QCradio))
8314 PROP (TOOL_BAR_ITEM_SELECTED_P) = selected;
8315 PROP (TOOL_BAR_ITEM_TYPE) = type;
8318 else if (EQ (ikey, QCimage)
8319 && (CONSP (value)
8320 || (VECTORP (value) && ASIZE (value) == 4)))
8321 /* Value is either a single image specification or a vector
8322 of 4 such specifications for the different button states. */
8323 PROP (TOOL_BAR_ITEM_IMAGES) = value;
8324 else if (EQ (ikey, QCrtl))
8325 /* ':rtl STRING' */
8326 PROP (TOOL_BAR_ITEM_RTL_IMAGE) = value;
8330 if (!have_label)
8332 /* Try to make one from caption and key. */
8333 Lisp_Object tkey = PROP (TOOL_BAR_ITEM_KEY);
8334 Lisp_Object tcapt = PROP (TOOL_BAR_ITEM_CAPTION);
8335 const char *label = SYMBOLP (tkey) ? SSDATA (SYMBOL_NAME (tkey)) : "";
8336 const char *capt = STRINGP (tcapt) ? SSDATA (tcapt) : "";
8337 ptrdiff_t max_lbl =
8338 2 * max (0, min (tool_bar_max_label_size, STRING_BYTES_BOUND / 2));
8339 char *buf = (char *) xmalloc (max_lbl + 1);
8340 Lisp_Object new_lbl;
8341 ptrdiff_t caption_len = strlen (capt);
8343 if (caption_len <= max_lbl && capt[0] != '\0')
8345 strcpy (buf, capt);
8346 while (caption_len > 0 && buf[caption_len - 1] == '.')
8347 caption_len--;
8348 buf[caption_len] = '\0';
8349 label = capt = buf;
8352 if (strlen (label) <= max_lbl && label[0] != '\0')
8354 ptrdiff_t j;
8355 if (label != buf)
8356 strcpy (buf, label);
8358 for (j = 0; buf[j] != '\0'; ++j)
8359 if (buf[j] == '-')
8360 buf[j] = ' ';
8361 label = buf;
8363 else
8364 label = "";
8366 new_lbl = Fupcase_initials (build_string (label));
8367 if (SCHARS (new_lbl) <= tool_bar_max_label_size)
8368 PROP (TOOL_BAR_ITEM_LABEL) = new_lbl;
8369 else
8370 PROP (TOOL_BAR_ITEM_LABEL) = make_string ("", 0);
8371 xfree (buf);
8374 /* If got a filter apply it on binding. */
8375 if (!NILP (filter))
8376 PROP (TOOL_BAR_ITEM_BINDING)
8377 = menu_item_eval_property (list2 (filter,
8378 list2 (Qquote,
8379 PROP (TOOL_BAR_ITEM_BINDING))));
8381 /* See if the binding is a keymap. Give up if it is. */
8382 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING), 0, 1)))
8383 return 0;
8385 /* Enable or disable selection of item. */
8386 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P), Qt))
8387 PROP (TOOL_BAR_ITEM_ENABLED_P)
8388 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P));
8390 /* Handle radio buttons or toggle boxes. */
8391 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P)))
8392 PROP (TOOL_BAR_ITEM_SELECTED_P)
8393 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P));
8395 return 1;
8397 #undef PROP
8401 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8402 that can be reused. */
8404 static void
8405 init_tool_bar_items (Lisp_Object reuse)
8407 if (VECTORP (reuse))
8408 tool_bar_items_vector = reuse;
8409 else
8410 tool_bar_items_vector = Fmake_vector (make_number (64), Qnil);
8411 ntool_bar_items = 0;
8415 /* Append parsed tool bar item properties from
8416 tool_bar_item_properties */
8418 static void
8419 append_tool_bar_item (void)
8421 Lisp_Object *to, *from;
8422 ptrdiff_t incr =
8423 (ntool_bar_items
8424 - (ASIZE (tool_bar_items_vector) - TOOL_BAR_ITEM_NSLOTS));
8426 /* Enlarge tool_bar_items_vector if necessary. */
8427 if (0 < incr)
8428 tool_bar_items_vector
8429 = larger_vector (tool_bar_items_vector, incr, -1);
8431 /* Append entries from tool_bar_item_properties to the end of
8432 tool_bar_items_vector. */
8433 to = XVECTOR (tool_bar_items_vector)->contents + ntool_bar_items;
8434 from = XVECTOR (tool_bar_item_properties)->contents;
8435 memcpy (to, from, TOOL_BAR_ITEM_NSLOTS * sizeof *to);
8436 ntool_bar_items += TOOL_BAR_ITEM_NSLOTS;
8443 /* Read a character using menus based on maps in the array MAPS.
8444 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8445 Return t if we displayed a menu but the user rejected it.
8447 PREV_EVENT is the previous input event, or nil if we are reading
8448 the first event of a key sequence.
8450 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8451 if we used a mouse menu to read the input, or zero otherwise. If
8452 USED_MOUSE_MENU is null, we don't dereference it.
8454 The prompting is done based on the prompt-string of the map
8455 and the strings associated with various map elements.
8457 This can be done with X menus or with menus put in the minibuf.
8458 These are done in different ways, depending on how the input will be read.
8459 Menus using X are done after auto-saving in read-char, getting the input
8460 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8461 and do auto-saving in the inner call of read_char. */
8463 static Lisp_Object
8464 read_char_x_menu_prompt (ptrdiff_t nmaps, Lisp_Object *maps,
8465 Lisp_Object prev_event, int *used_mouse_menu)
8467 ptrdiff_t mapno;
8469 if (used_mouse_menu)
8470 *used_mouse_menu = 0;
8472 /* Use local over global Menu maps */
8474 if (! menu_prompting)
8475 return Qnil;
8477 /* Optionally disregard all but the global map. */
8478 if (inhibit_local_menu_bar_menus)
8480 maps += (nmaps - 1);
8481 nmaps = 1;
8484 #ifdef HAVE_MENUS
8485 /* If we got to this point via a mouse click,
8486 use a real menu for mouse selection. */
8487 if (EVENT_HAS_PARAMETERS (prev_event)
8488 && !EQ (XCAR (prev_event), Qmenu_bar)
8489 && !EQ (XCAR (prev_event), Qtool_bar))
8491 /* Display the menu and get the selection. */
8492 Lisp_Object *realmaps
8493 = (Lisp_Object *) alloca (nmaps * sizeof (Lisp_Object));
8494 Lisp_Object value;
8495 ptrdiff_t nmaps1 = 0;
8497 /* Use the maps that are not nil. */
8498 for (mapno = 0; mapno < nmaps; mapno++)
8499 if (!NILP (maps[mapno]))
8500 realmaps[nmaps1++] = maps[mapno];
8502 value = Fx_popup_menu (prev_event, Flist (nmaps1, realmaps));
8503 if (CONSP (value))
8505 Lisp_Object tem;
8507 record_menu_key (XCAR (value));
8509 /* If we got multiple events, unread all but
8510 the first.
8511 There is no way to prevent those unread events
8512 from showing up later in last_nonmenu_event.
8513 So turn symbol and integer events into lists,
8514 to indicate that they came from a mouse menu,
8515 so that when present in last_nonmenu_event
8516 they won't confuse things. */
8517 for (tem = XCDR (value); CONSP (tem); tem = XCDR (tem))
8519 record_menu_key (XCAR (tem));
8520 if (SYMBOLP (XCAR (tem))
8521 || INTEGERP (XCAR (tem)))
8522 XSETCAR (tem, Fcons (XCAR (tem), Qdisabled));
8525 /* If we got more than one event, put all but the first
8526 onto this list to be read later.
8527 Return just the first event now. */
8528 Vunread_command_events
8529 = nconc2 (XCDR (value), Vunread_command_events);
8530 value = XCAR (value);
8532 else if (NILP (value))
8533 value = Qt;
8534 if (used_mouse_menu)
8535 *used_mouse_menu = 1;
8536 return value;
8538 #endif /* HAVE_MENUS */
8539 return Qnil ;
8542 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8543 We make this bigger when necessary, and never free it. */
8544 static char *read_char_minibuf_menu_text;
8545 /* Size of that buffer. */
8546 static ptrdiff_t read_char_minibuf_menu_width;
8548 static Lisp_Object
8549 read_char_minibuf_menu_prompt (int commandflag,
8550 ptrdiff_t nmaps, Lisp_Object *maps)
8552 ptrdiff_t mapno;
8553 register Lisp_Object name;
8554 ptrdiff_t nlength;
8555 /* FIXME: Use the minibuffer's frame width. */
8556 ptrdiff_t width = FRAME_COLS (SELECTED_FRAME ()) - 4;
8557 ptrdiff_t idx = -1;
8558 int nobindings = 1;
8559 Lisp_Object rest, vector;
8560 char *menu;
8562 vector = Qnil;
8563 name = Qnil;
8565 if (! menu_prompting)
8566 return Qnil;
8568 /* Get the menu name from the first map that has one (a prompt string). */
8569 for (mapno = 0; mapno < nmaps; mapno++)
8571 name = Fkeymap_prompt (maps[mapno]);
8572 if (!NILP (name))
8573 break;
8576 /* If we don't have any menus, just read a character normally. */
8577 if (!STRINGP (name))
8578 return Qnil;
8580 /* Make sure we have a big enough buffer for the menu text. */
8581 width = max (width, SBYTES (name));
8582 if (STRING_BYTES_BOUND - 4 < width)
8583 memory_full (SIZE_MAX);
8584 if (width + 4 > read_char_minibuf_menu_width)
8586 read_char_minibuf_menu_text
8587 = (char *) xrealloc (read_char_minibuf_menu_text, width + 4);
8588 read_char_minibuf_menu_width = width + 4;
8590 menu = read_char_minibuf_menu_text;
8592 /* Prompt string always starts with map's prompt, and a space. */
8593 strcpy (menu, SSDATA (name));
8594 nlength = SBYTES (name);
8595 menu[nlength++] = ':';
8596 menu[nlength++] = ' ';
8597 menu[nlength] = 0;
8599 /* Start prompting at start of first map. */
8600 mapno = 0;
8601 rest = maps[mapno];
8603 /* Present the documented bindings, a line at a time. */
8604 while (1)
8606 int notfirst = 0;
8607 ptrdiff_t i = nlength;
8608 Lisp_Object obj;
8609 Lisp_Object orig_defn_macro;
8611 /* Loop over elements of map. */
8612 while (i < width)
8614 Lisp_Object elt;
8616 /* If reached end of map, start at beginning of next map. */
8617 if (NILP (rest))
8619 mapno++;
8620 /* At end of last map, wrap around to first map if just starting,
8621 or end this line if already have something on it. */
8622 if (mapno == nmaps)
8624 mapno = 0;
8625 if (notfirst || nobindings) break;
8627 rest = maps[mapno];
8630 /* Look at the next element of the map. */
8631 if (idx >= 0)
8632 elt = XVECTOR (vector)->contents[idx];
8633 else
8634 elt = Fcar_safe (rest);
8636 if (idx < 0 && VECTORP (elt))
8638 /* If we found a dense table in the keymap,
8639 advanced past it, but start scanning its contents. */
8640 rest = Fcdr_safe (rest);
8641 vector = elt;
8642 idx = 0;
8644 else
8646 /* An ordinary element. */
8647 Lisp_Object event, tem;
8649 if (idx < 0)
8651 event = Fcar_safe (elt); /* alist */
8652 elt = Fcdr_safe (elt);
8654 else
8656 XSETINT (event, idx); /* vector */
8659 /* Ignore the element if it has no prompt string. */
8660 if (INTEGERP (event) && parse_menu_item (elt, -1))
8662 /* 1 if the char to type matches the string. */
8663 int char_matches;
8664 Lisp_Object upcased_event, downcased_event;
8665 Lisp_Object desc = Qnil;
8666 Lisp_Object s
8667 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_NAME];
8669 upcased_event = Fupcase (event);
8670 downcased_event = Fdowncase (event);
8671 char_matches = (XINT (upcased_event) == SREF (s, 0)
8672 || XINT (downcased_event) == SREF (s, 0));
8673 if (! char_matches)
8674 desc = Fsingle_key_description (event, Qnil);
8676 #if 0 /* It is redundant to list the equivalent key bindings because
8677 the prefix is what the user has already typed. */
8679 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_KEYEQ];
8680 if (!NILP (tem))
8681 /* Insert equivalent keybinding. */
8682 s = concat2 (s, tem);
8683 #endif
8685 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_TYPE];
8686 if (EQ (tem, QCradio) || EQ (tem, QCtoggle))
8688 /* Insert button prefix. */
8689 Lisp_Object selected
8690 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_SELECTED];
8691 if (EQ (tem, QCradio))
8692 tem = build_string (NILP (selected) ? "(*) " : "( ) ");
8693 else
8694 tem = build_string (NILP (selected) ? "[X] " : "[ ] ");
8695 s = concat2 (tem, s);
8699 /* If we have room for the prompt string, add it to this line.
8700 If this is the first on the line, always add it. */
8701 if ((SCHARS (s) + i + 2
8702 + (char_matches ? 0 : SCHARS (desc) + 3))
8703 < width
8704 || !notfirst)
8706 ptrdiff_t thiswidth;
8708 /* Punctuate between strings. */
8709 if (notfirst)
8711 strcpy (menu + i, ", ");
8712 i += 2;
8714 notfirst = 1;
8715 nobindings = 0 ;
8717 /* If the char to type doesn't match the string's
8718 first char, explicitly show what char to type. */
8719 if (! char_matches)
8721 /* Add as much of string as fits. */
8722 thiswidth = min (SCHARS (desc), width - i);
8723 memcpy (menu + i, SDATA (desc), thiswidth);
8724 i += thiswidth;
8725 strcpy (menu + i, " = ");
8726 i += 3;
8729 /* Add as much of string as fits. */
8730 thiswidth = min (SCHARS (s), width - i);
8731 memcpy (menu + i, SDATA (s), thiswidth);
8732 i += thiswidth;
8733 menu[i] = 0;
8735 else
8737 /* If this element does not fit, end the line now,
8738 and save the element for the next line. */
8739 strcpy (menu + i, "...");
8740 break;
8744 /* Move past this element. */
8745 if (idx >= 0 && idx + 1 >= ASIZE (vector))
8746 /* Handle reaching end of dense table. */
8747 idx = -1;
8748 if (idx >= 0)
8749 idx++;
8750 else
8751 rest = Fcdr_safe (rest);
8755 /* Prompt with that and read response. */
8756 message2_nolog (menu, strlen (menu),
8757 ! NILP (BVAR (current_buffer, enable_multibyte_characters)));
8759 /* Make believe its not a keyboard macro in case the help char
8760 is pressed. Help characters are not recorded because menu prompting
8761 is not used on replay.
8763 orig_defn_macro = KVAR (current_kboard, defining_kbd_macro);
8764 KVAR (current_kboard, defining_kbd_macro) = Qnil;
8766 obj = read_char (commandflag, 0, 0, Qt, 0, NULL);
8767 while (BUFFERP (obj));
8768 KVAR (current_kboard, defining_kbd_macro) = orig_defn_macro;
8770 if (!INTEGERP (obj))
8771 return obj;
8772 else if (XINT (obj) == -2)
8773 return obj;
8775 if (! EQ (obj, menu_prompt_more_char)
8776 && (!INTEGERP (menu_prompt_more_char)
8777 || ! EQ (obj, make_number (Ctl (XINT (menu_prompt_more_char))))))
8779 if (!NILP (KVAR (current_kboard, defining_kbd_macro)))
8780 store_kbd_macro_char (obj);
8781 return obj;
8783 /* Help char - go round again */
8787 /* Reading key sequences. */
8789 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8790 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8791 keymap, or nil otherwise. Return the index of the first keymap in
8792 which KEY has any binding, or NMAPS if no map has a binding.
8794 If KEY is a meta ASCII character, treat it like meta-prefix-char
8795 followed by the corresponding non-meta character. Keymaps in
8796 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8797 NEXT.
8799 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8800 unmodified.
8802 NEXT may be the same array as CURRENT. */
8804 static int
8805 follow_key (Lisp_Object key, ptrdiff_t nmaps, Lisp_Object *current,
8806 Lisp_Object *defs, Lisp_Object *next)
8808 ptrdiff_t i, first_binding;
8810 first_binding = nmaps;
8811 for (i = nmaps - 1; i >= 0; i--)
8813 if (! NILP (current[i]))
8815 defs[i] = access_keymap (current[i], key, 1, 0, 1);
8816 if (! NILP (defs[i]))
8817 first_binding = i;
8819 else
8820 defs[i] = Qnil;
8823 /* Given the set of bindings we've found, produce the next set of maps. */
8824 if (first_binding < nmaps)
8825 for (i = 0; i < nmaps; i++)
8826 next[i] = NILP (defs[i]) ? Qnil : get_keymap (defs[i], 0, 1);
8828 return first_binding;
8831 /* Structure used to keep track of partial application of key remapping
8832 such as Vfunction_key_map and Vkey_translation_map. */
8833 typedef struct keyremap
8835 /* This is the map originally specified for this use. */
8836 Lisp_Object parent;
8837 /* This is a submap reached by looking up, in PARENT,
8838 the events from START to END. */
8839 Lisp_Object map;
8840 /* Positions [START, END) in the key sequence buffer
8841 are the key that we have scanned so far.
8842 Those events are the ones that we will replace
8843 if PARENT maps them into a key sequence. */
8844 int start, end;
8845 } keyremap;
8847 /* Lookup KEY in MAP.
8848 MAP is a keymap mapping keys to key vectors or functions.
8849 If the mapping is a function and DO_FUNCTION is non-zero, then
8850 the function is called with PROMPT as parameter and its return
8851 value is used as the return value of this function (after checking
8852 that it is indeed a vector). */
8854 static Lisp_Object
8855 access_keymap_keyremap (Lisp_Object map, Lisp_Object key, Lisp_Object prompt,
8856 int do_funcall)
8858 Lisp_Object next;
8860 next = access_keymap (map, key, 1, 0, 1);
8862 /* Handle symbol with autoload definition. */
8863 if (SYMBOLP (next) && !NILP (Ffboundp (next))
8864 && CONSP (XSYMBOL (next)->function)
8865 && EQ (XCAR (XSYMBOL (next)->function), Qautoload))
8866 do_autoload (XSYMBOL (next)->function, next);
8868 /* Handle a symbol whose function definition is a keymap
8869 or an array. */
8870 if (SYMBOLP (next) && !NILP (Ffboundp (next))
8871 && (ARRAYP (XSYMBOL (next)->function)
8872 || KEYMAPP (XSYMBOL (next)->function)))
8873 next = XSYMBOL (next)->function;
8875 /* If the keymap gives a function, not an
8876 array, then call the function with one arg and use
8877 its value instead. */
8878 if (SYMBOLP (next) && !NILP (Ffboundp (next)) && do_funcall)
8880 Lisp_Object tem;
8881 tem = next;
8883 next = call1 (next, prompt);
8884 /* If the function returned something invalid,
8885 barf--don't ignore it.
8886 (To ignore it safely, we would need to gcpro a bunch of
8887 other variables.) */
8888 if (! (VECTORP (next) || STRINGP (next)))
8889 error ("Function %s returns invalid key sequence",
8890 SSDATA (SYMBOL_NAME (tem)));
8892 return next;
8895 /* Do one step of the key remapping used for function-key-map and
8896 key-translation-map:
8897 KEYBUF is the buffer holding the input events.
8898 BUFSIZE is its maximum size.
8899 FKEY is a pointer to the keyremap structure to use.
8900 INPUT is the index of the last element in KEYBUF.
8901 DOIT if non-zero says that the remapping can actually take place.
8902 DIFF is used to return the number of keys added/removed by the remapping.
8903 PARENT is the root of the keymap.
8904 PROMPT is the prompt to use if the remapping happens through a function.
8905 The return value is non-zero if the remapping actually took place. */
8907 static int
8908 keyremap_step (Lisp_Object *keybuf, int bufsize, volatile keyremap *fkey,
8909 int input, int doit, int *diff, Lisp_Object prompt)
8911 Lisp_Object next, key;
8913 key = keybuf[fkey->end++];
8915 if (KEYMAPP (fkey->parent))
8916 next = access_keymap_keyremap (fkey->map, key, prompt, doit);
8917 else
8918 next = Qnil;
8920 /* If keybuf[fkey->start..fkey->end] is bound in the
8921 map and we're in a position to do the key remapping, replace it with
8922 the binding and restart with fkey->start at the end. */
8923 if ((VECTORP (next) || STRINGP (next)) && doit)
8925 int len = XFASTINT (Flength (next));
8926 int i;
8928 *diff = len - (fkey->end - fkey->start);
8930 if (bufsize - input <= *diff)
8931 error ("Key sequence too long");
8933 /* Shift the keys that follow fkey->end. */
8934 if (*diff < 0)
8935 for (i = fkey->end; i < input; i++)
8936 keybuf[i + *diff] = keybuf[i];
8937 else if (*diff > 0)
8938 for (i = input - 1; i >= fkey->end; i--)
8939 keybuf[i + *diff] = keybuf[i];
8940 /* Overwrite the old keys with the new ones. */
8941 for (i = 0; i < len; i++)
8942 keybuf[fkey->start + i]
8943 = Faref (next, make_number (i));
8945 fkey->start = fkey->end += *diff;
8946 fkey->map = fkey->parent;
8948 return 1;
8951 fkey->map = get_keymap (next, 0, 1);
8953 /* If we no longer have a bound suffix, try a new position for
8954 fkey->start. */
8955 if (!CONSP (fkey->map))
8957 fkey->end = ++fkey->start;
8958 fkey->map = fkey->parent;
8960 return 0;
8963 static int
8964 test_undefined (Lisp_Object binding)
8966 return (EQ (binding, Qundefined)
8967 || (!NILP (binding) && SYMBOLP (binding)
8968 && EQ (Fcommand_remapping (binding, Qnil, Qnil), Qundefined)));
8971 /* Read a sequence of keys that ends with a non prefix character,
8972 storing it in KEYBUF, a buffer of size BUFSIZE.
8973 Prompt with PROMPT.
8974 Return the length of the key sequence stored.
8975 Return -1 if the user rejected a command menu.
8977 Echo starting immediately unless `prompt' is 0.
8979 Where a key sequence ends depends on the currently active keymaps.
8980 These include any minor mode keymaps active in the current buffer,
8981 the current buffer's local map, and the global map.
8983 If a key sequence has no other bindings, we check Vfunction_key_map
8984 to see if some trailing subsequence might be the beginning of a
8985 function key's sequence. If so, we try to read the whole function
8986 key, and substitute its symbolic name into the key sequence.
8988 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8989 `double-' events into similar click events, if that would make them
8990 bound. We try to turn `triple-' events first into `double-' events,
8991 then into clicks.
8993 If we get a mouse click in a mode line, vertical divider, or other
8994 non-text area, we treat the click as if it were prefixed by the
8995 symbol denoting that area - `mode-line', `vertical-line', or
8996 whatever.
8998 If the sequence starts with a mouse click, we read the key sequence
8999 with respect to the buffer clicked on, not the current buffer.
9001 If the user switches frames in the midst of a key sequence, we put
9002 off the switch-frame event until later; the next call to
9003 read_char will return it.
9005 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9006 from the selected window's buffer. */
9008 static int
9009 read_key_sequence (Lisp_Object *keybuf, int bufsize, Lisp_Object prompt,
9010 int dont_downcase_last, int can_return_switch_frame,
9011 int fix_current_buffer)
9013 Lisp_Object from_string;
9014 ptrdiff_t count = SPECPDL_INDEX ();
9016 /* How many keys there are in the current key sequence. */
9017 int t;
9019 /* The length of the echo buffer when we started reading, and
9020 the length of this_command_keys when we started reading. */
9021 ptrdiff_t echo_start IF_LINT (= 0);
9022 ptrdiff_t keys_start;
9024 /* The number of keymaps we're scanning right now, and the number of
9025 keymaps we have allocated space for. */
9026 ptrdiff_t nmaps;
9027 ptrdiff_t nmaps_allocated = 0;
9029 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9030 the current keymaps. */
9031 Lisp_Object *defs = NULL;
9033 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9034 in the current keymaps, or nil where it is not a prefix. */
9035 Lisp_Object *submaps = NULL;
9037 /* The local map to start out with at start of key sequence. */
9038 Lisp_Object orig_local_map;
9040 /* The map from the `keymap' property to start out with at start of
9041 key sequence. */
9042 Lisp_Object orig_keymap;
9044 /* 1 if we have already considered switching to the local-map property
9045 of the place where a mouse click occurred. */
9046 int localized_local_map = 0;
9048 /* The index in submaps[] of the first keymap that has a binding for
9049 this key sequence. In other words, the lowest i such that
9050 submaps[i] is non-nil. */
9051 ptrdiff_t first_binding;
9052 /* Index of the first key that has no binding.
9053 It is useless to try fkey.start larger than that. */
9054 int first_unbound;
9056 /* If t < mock_input, then KEYBUF[t] should be read as the next
9057 input key.
9059 We use this to recover after recognizing a function key. Once we
9060 realize that a suffix of the current key sequence is actually a
9061 function key's escape sequence, we replace the suffix with the
9062 function key's binding from Vfunction_key_map. Now keybuf
9063 contains a new and different key sequence, so the echo area,
9064 this_command_keys, and the submaps and defs arrays are wrong. In
9065 this situation, we set mock_input to t, set t to 0, and jump to
9066 restart_sequence; the loop will read keys from keybuf up until
9067 mock_input, thus rebuilding the state; and then it will resume
9068 reading characters from the keyboard. */
9069 int mock_input = 0;
9071 /* If the sequence is unbound in submaps[], then
9072 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9073 and fkey.map is its binding.
9075 These might be > t, indicating that all function key scanning
9076 should hold off until t reaches them. We do this when we've just
9077 recognized a function key, to avoid searching for the function
9078 key's again in Vfunction_key_map. */
9079 keyremap fkey;
9081 /* Likewise, for key_translation_map and input-decode-map. */
9082 keyremap keytran, indec;
9084 /* Non-zero if we are trying to map a key by changing an upper-case
9085 letter to lower case, or a shifted function key to an unshifted
9086 one. */
9087 int shift_translated = 0;
9089 /* If we receive a `switch-frame' or `select-window' event in the middle of
9090 a key sequence, we put it off for later.
9091 While we're reading, we keep the event here. */
9092 Lisp_Object delayed_switch_frame;
9094 /* See the comment below... */
9095 #if defined (GOBBLE_FIRST_EVENT)
9096 Lisp_Object first_event;
9097 #endif
9099 Lisp_Object original_uppercase IF_LINT (= Qnil);
9100 int original_uppercase_position = -1;
9102 /* Gets around Microsoft compiler limitations. */
9103 int dummyflag = 0;
9105 struct buffer *starting_buffer;
9107 /* List of events for which a fake prefix key has been generated. */
9108 Lisp_Object fake_prefixed_keys = Qnil;
9110 #if defined (GOBBLE_FIRST_EVENT)
9111 int junk;
9112 #endif
9114 struct gcpro gcpro1;
9116 GCPRO1 (fake_prefixed_keys);
9117 raw_keybuf_count = 0;
9119 last_nonmenu_event = Qnil;
9121 delayed_switch_frame = Qnil;
9123 if (INTERACTIVE)
9125 if (!NILP (prompt))
9127 /* Install the string STR as the beginning of the string of
9128 echoing, so that it serves as a prompt for the next
9129 character. */
9130 KVAR (current_kboard, echo_string) = prompt;
9131 current_kboard->echo_after_prompt = SCHARS (prompt);
9132 echo_now ();
9134 else if (cursor_in_echo_area
9135 && (FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
9136 && NILP (Fzerop (Vecho_keystrokes)))
9137 /* This doesn't put in a dash if the echo buffer is empty, so
9138 you don't always see a dash hanging out in the minibuffer. */
9139 echo_dash ();
9142 /* Record the initial state of the echo area and this_command_keys;
9143 we will need to restore them if we replay a key sequence. */
9144 if (INTERACTIVE)
9145 echo_start = echo_length ();
9146 keys_start = this_command_key_count;
9147 this_single_command_key_start = keys_start;
9149 #if defined (GOBBLE_FIRST_EVENT)
9150 /* This doesn't quite work, because some of the things that read_char
9151 does cannot safely be bypassed. It seems too risky to try to make
9152 this work right. */
9154 /* Read the first char of the sequence specially, before setting
9155 up any keymaps, in case a filter runs and switches buffers on us. */
9156 first_event = read_char (NILP (prompt), 0, submaps, last_nonmenu_event,
9157 &junk, NULL);
9158 #endif /* GOBBLE_FIRST_EVENT */
9160 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
9161 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
9162 from_string = Qnil;
9164 /* We jump here when we need to reinitialize fkey and keytran; this
9165 happens if we switch keyboards between rescans. */
9166 replay_entire_sequence:
9168 indec.map = indec.parent = KVAR (current_kboard, Vinput_decode_map);
9169 fkey.map = fkey.parent = KVAR (current_kboard, Vlocal_function_key_map);
9170 keytran.map = keytran.parent = Vkey_translation_map;
9171 indec.start = indec.end = 0;
9172 fkey.start = fkey.end = 0;
9173 keytran.start = keytran.end = 0;
9175 /* We jump here when the key sequence has been thoroughly changed, and
9176 we need to rescan it starting from the beginning. When we jump here,
9177 keybuf[0..mock_input] holds the sequence we should reread. */
9178 replay_sequence:
9180 starting_buffer = current_buffer;
9181 first_unbound = bufsize + 1;
9183 /* Build our list of keymaps.
9184 If we recognize a function key and replace its escape sequence in
9185 keybuf with its symbol, or if the sequence starts with a mouse
9186 click and we need to switch buffers, we jump back here to rebuild
9187 the initial keymaps from the current buffer. */
9188 nmaps = 0;
9190 if (!NILP (KVAR (current_kboard, Voverriding_terminal_local_map)))
9192 if (2 > nmaps_allocated)
9194 submaps = (Lisp_Object *) alloca (2 * sizeof (submaps[0]));
9195 defs = (Lisp_Object *) alloca (2 * sizeof (defs[0]));
9196 nmaps_allocated = 2;
9198 submaps[nmaps++] = KVAR (current_kboard, Voverriding_terminal_local_map);
9200 else if (!NILP (Voverriding_local_map))
9202 if (2 > nmaps_allocated)
9204 submaps = (Lisp_Object *) alloca (2 * sizeof (submaps[0]));
9205 defs = (Lisp_Object *) alloca (2 * sizeof (defs[0]));
9206 nmaps_allocated = 2;
9208 submaps[nmaps++] = Voverriding_local_map;
9210 else
9212 ptrdiff_t nminor;
9213 ptrdiff_t total;
9214 Lisp_Object *maps;
9216 nminor = current_minor_maps (0, &maps);
9217 total = nminor + (!NILP (orig_keymap) ? 3 : 2);
9219 if (total > nmaps_allocated)
9221 submaps = (Lisp_Object *) alloca (total * sizeof (submaps[0]));
9222 defs = (Lisp_Object *) alloca (total * sizeof (defs[0]));
9223 nmaps_allocated = total;
9226 if (!NILP (orig_keymap))
9227 submaps[nmaps++] = orig_keymap;
9229 memcpy (submaps + nmaps, maps, nminor * sizeof (submaps[0]));
9231 nmaps += nminor;
9233 submaps[nmaps++] = orig_local_map;
9235 submaps[nmaps++] = current_global_map;
9237 /* Find an accurate initial value for first_binding. */
9238 for (first_binding = 0; first_binding < nmaps; first_binding++)
9239 if (! NILP (submaps[first_binding]))
9240 break;
9242 /* Start from the beginning in keybuf. */
9243 t = 0;
9245 /* These are no-ops the first time through, but if we restart, they
9246 revert the echo area and this_command_keys to their original state. */
9247 this_command_key_count = keys_start;
9248 if (INTERACTIVE && t < mock_input)
9249 echo_truncate (echo_start);
9251 /* If the best binding for the current key sequence is a keymap, or
9252 we may be looking at a function key's escape sequence, keep on
9253 reading. */
9254 while (first_binding < nmaps
9255 /* Keep reading as long as there's a prefix binding. */
9256 ? !NILP (submaps[first_binding])
9257 /* Don't return in the middle of a possible function key sequence,
9258 if the only bindings we found were via case conversion.
9259 Thus, if ESC O a has a function-key-map translation
9260 and ESC o has a binding, don't return after ESC O,
9261 so that we can translate ESC O plus the next character. */
9262 : (/* indec.start < t || fkey.start < t || */ keytran.start < t))
9264 Lisp_Object key;
9265 int used_mouse_menu = 0;
9267 /* Where the last real key started. If we need to throw away a
9268 key that has expanded into more than one element of keybuf
9269 (say, a mouse click on the mode line which is being treated
9270 as [mode-line (mouse-...)], then we backtrack to this point
9271 of keybuf. */
9272 int last_real_key_start;
9274 /* These variables are analogous to echo_start and keys_start;
9275 while those allow us to restart the entire key sequence,
9276 echo_local_start and keys_local_start allow us to throw away
9277 just one key. */
9278 ptrdiff_t echo_local_start IF_LINT (= 0);
9279 int keys_local_start;
9280 ptrdiff_t local_first_binding;
9282 eassert (indec.end == t || (indec.end > t && indec.end <= mock_input));
9283 eassert (indec.start <= indec.end);
9284 eassert (fkey.start <= fkey.end);
9285 eassert (keytran.start <= keytran.end);
9286 /* key-translation-map is applied *after* function-key-map
9287 which is itself applied *after* input-decode-map. */
9288 eassert (fkey.end <= indec.start);
9289 eassert (keytran.end <= fkey.start);
9291 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9292 first_unbound < keytran.start)
9293 { /* The prefix upto first_unbound has no binding and has
9294 no translation left to do either, so we know it's unbound.
9295 If we don't stop now, we risk staying here indefinitely
9296 (if the user keeps entering fkey or keytran prefixes
9297 like C-c ESC ESC ESC ESC ...) */
9298 int i;
9299 for (i = first_unbound + 1; i < t; i++)
9300 keybuf[i - first_unbound - 1] = keybuf[i];
9301 mock_input = t - first_unbound - 1;
9302 indec.end = indec.start -= first_unbound + 1;
9303 indec.map = indec.parent;
9304 fkey.end = fkey.start -= first_unbound + 1;
9305 fkey.map = fkey.parent;
9306 keytran.end = keytran.start -= first_unbound + 1;
9307 keytran.map = keytran.parent;
9308 goto replay_sequence;
9311 if (t >= bufsize)
9312 error ("Key sequence too long");
9314 if (INTERACTIVE)
9315 echo_local_start = echo_length ();
9316 keys_local_start = this_command_key_count;
9317 local_first_binding = first_binding;
9319 replay_key:
9320 /* These are no-ops, unless we throw away a keystroke below and
9321 jumped back up to replay_key; in that case, these restore the
9322 variables to their original state, allowing us to replay the
9323 loop. */
9324 if (INTERACTIVE && t < mock_input)
9325 echo_truncate (echo_local_start);
9326 this_command_key_count = keys_local_start;
9327 first_binding = local_first_binding;
9329 /* By default, assume each event is "real". */
9330 last_real_key_start = t;
9332 /* Does mock_input indicate that we are re-reading a key sequence? */
9333 if (t < mock_input)
9335 key = keybuf[t];
9336 add_command_key (key);
9337 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
9338 && NILP (Fzerop (Vecho_keystrokes)))
9339 echo_char (key);
9342 /* If not, we should actually read a character. */
9343 else
9346 KBOARD *interrupted_kboard = current_kboard;
9347 struct frame *interrupted_frame = SELECTED_FRAME ();
9348 key = read_char (NILP (prompt), nmaps,
9349 (Lisp_Object *) submaps, last_nonmenu_event,
9350 &used_mouse_menu, NULL);
9351 if ((INTEGERP (key) && XINT (key) == -2) /* wrong_kboard_jmpbuf */
9352 /* When switching to a new tty (with a new keyboard),
9353 read_char returns the new buffer, rather than -2
9354 (Bug#5095). This is because `terminal-init-xterm'
9355 calls read-char, which eats the wrong_kboard_jmpbuf
9356 return. Any better way to fix this? -- cyd */
9357 || (interrupted_kboard != current_kboard))
9359 int found = 0;
9360 struct kboard *k;
9362 for (k = all_kboards; k; k = k->next_kboard)
9363 if (k == interrupted_kboard)
9364 found = 1;
9366 if (!found)
9368 /* Don't touch interrupted_kboard when it's been
9369 deleted. */
9370 delayed_switch_frame = Qnil;
9371 goto replay_entire_sequence;
9374 if (!NILP (delayed_switch_frame))
9376 KVAR (interrupted_kboard, kbd_queue)
9377 = Fcons (delayed_switch_frame,
9378 KVAR (interrupted_kboard, kbd_queue));
9379 delayed_switch_frame = Qnil;
9382 while (t > 0)
9383 KVAR (interrupted_kboard, kbd_queue)
9384 = Fcons (keybuf[--t], KVAR (interrupted_kboard, kbd_queue));
9386 /* If the side queue is non-empty, ensure it begins with a
9387 switch-frame, so we'll replay it in the right context. */
9388 if (CONSP (KVAR (interrupted_kboard, kbd_queue))
9389 && (key = XCAR (KVAR (interrupted_kboard, kbd_queue)),
9390 !(EVENT_HAS_PARAMETERS (key)
9391 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key)),
9392 Qswitch_frame))))
9394 Lisp_Object frame;
9395 XSETFRAME (frame, interrupted_frame);
9396 KVAR (interrupted_kboard, kbd_queue)
9397 = Fcons (make_lispy_switch_frame (frame),
9398 KVAR (interrupted_kboard, kbd_queue));
9400 mock_input = 0;
9401 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
9402 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
9403 goto replay_entire_sequence;
9407 /* read_char returns t when it shows a menu and the user rejects it.
9408 Just return -1. */
9409 if (EQ (key, Qt))
9411 unbind_to (count, Qnil);
9412 UNGCPRO;
9413 return -1;
9416 /* read_char returns -1 at the end of a macro.
9417 Emacs 18 handles this by returning immediately with a
9418 zero, so that's what we'll do. */
9419 if (INTEGERP (key) && XINT (key) == -1)
9421 t = 0;
9422 /* The Microsoft C compiler can't handle the goto that
9423 would go here. */
9424 dummyflag = 1;
9425 break;
9428 /* If the current buffer has been changed from under us, the
9429 keymap may have changed, so replay the sequence. */
9430 if (BUFFERP (key))
9432 timer_resume_idle ();
9434 mock_input = t;
9435 /* Reset the current buffer from the selected window
9436 in case something changed the former and not the latter.
9437 This is to be more consistent with the behavior
9438 of the command_loop_1. */
9439 if (fix_current_buffer)
9441 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
9442 Fkill_emacs (Qnil);
9443 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
9444 Fset_buffer (XWINDOW (selected_window)->buffer);
9447 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
9448 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
9449 goto replay_sequence;
9452 /* If we have a quit that was typed in another frame, and
9453 quit_throw_to_read_char switched buffers,
9454 replay to get the right keymap. */
9455 if (INTEGERP (key)
9456 && XINT (key) == quit_char
9457 && current_buffer != starting_buffer)
9459 GROW_RAW_KEYBUF;
9460 XVECTOR (raw_keybuf)->contents[raw_keybuf_count++] = key;
9461 keybuf[t++] = key;
9462 mock_input = t;
9463 Vquit_flag = Qnil;
9464 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
9465 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
9466 goto replay_sequence;
9469 Vquit_flag = Qnil;
9471 if (EVENT_HAS_PARAMETERS (key)
9472 /* Either a `switch-frame' or a `select-window' event. */
9473 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key)), Qswitch_frame))
9475 /* If we're at the beginning of a key sequence, and the caller
9476 says it's okay, go ahead and return this event. If we're
9477 in the midst of a key sequence, delay it until the end. */
9478 if (t > 0 || !can_return_switch_frame)
9480 delayed_switch_frame = key;
9481 goto replay_key;
9485 GROW_RAW_KEYBUF;
9486 ASET (raw_keybuf, raw_keybuf_count, key);
9487 raw_keybuf_count++;
9490 /* Clicks in non-text areas get prefixed by the symbol
9491 in their CHAR-ADDRESS field. For example, a click on
9492 the mode line is prefixed by the symbol `mode-line'.
9494 Furthermore, key sequences beginning with mouse clicks
9495 are read using the keymaps of the buffer clicked on, not
9496 the current buffer. So we may have to switch the buffer
9497 here.
9499 When we turn one event into two events, we must make sure
9500 that neither of the two looks like the original--so that,
9501 if we replay the events, they won't be expanded again.
9502 If not for this, such reexpansion could happen either here
9503 or when user programs play with this-command-keys. */
9504 if (EVENT_HAS_PARAMETERS (key))
9506 Lisp_Object kind;
9507 Lisp_Object string;
9509 kind = EVENT_HEAD_KIND (EVENT_HEAD (key));
9510 if (EQ (kind, Qmouse_click))
9512 Lisp_Object window, posn;
9514 window = POSN_WINDOW (EVENT_START (key));
9515 posn = POSN_POSN (EVENT_START (key));
9517 if (CONSP (posn)
9518 || (!NILP (fake_prefixed_keys)
9519 && !NILP (Fmemq (key, fake_prefixed_keys))))
9521 /* We're looking a second time at an event for which
9522 we generated a fake prefix key. Set
9523 last_real_key_start appropriately. */
9524 if (t > 0)
9525 last_real_key_start = t - 1;
9528 if (last_real_key_start == 0)
9530 /* Key sequences beginning with mouse clicks are
9531 read using the keymaps in the buffer clicked on,
9532 not the current buffer. If we're at the
9533 beginning of a key sequence, switch buffers. */
9534 if (WINDOWP (window)
9535 && BUFFERP (XWINDOW (window)->buffer)
9536 && XBUFFER (XWINDOW (window)->buffer) != current_buffer)
9538 XVECTOR (raw_keybuf)->contents[raw_keybuf_count++] = key;
9539 keybuf[t] = key;
9540 mock_input = t + 1;
9542 /* Arrange to go back to the original buffer once we're
9543 done reading the key sequence. Note that we can't
9544 use save_excursion_{save,restore} here, because they
9545 save point as well as the current buffer; we don't
9546 want to save point, because redisplay may change it,
9547 to accommodate a Fset_window_start or something. We
9548 don't want to do this at the top of the function,
9549 because we may get input from a subprocess which
9550 wants to change the selected window and stuff (say,
9551 emacsclient). */
9552 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
9554 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
9555 Fkill_emacs (Qnil);
9556 set_buffer_internal (XBUFFER (XWINDOW (window)->buffer));
9557 orig_local_map = get_local_map (PT, current_buffer,
9558 Qlocal_map);
9559 orig_keymap = get_local_map (PT, current_buffer,
9560 Qkeymap);
9561 goto replay_sequence;
9564 /* For a mouse click, get the local text-property keymap
9565 of the place clicked on, rather than point. */
9566 if (CONSP (XCDR (key))
9567 && ! localized_local_map)
9569 Lisp_Object map_here, start, pos;
9571 localized_local_map = 1;
9572 start = EVENT_START (key);
9574 if (CONSP (start) && POSN_INBUFFER_P (start))
9576 pos = POSN_BUFFER_POSN (start);
9577 if (INTEGERP (pos)
9578 && XINT (pos) >= BEGV
9579 && XINT (pos) <= ZV)
9581 map_here = get_local_map (XINT (pos),
9582 current_buffer,
9583 Qlocal_map);
9584 if (!EQ (map_here, orig_local_map))
9586 orig_local_map = map_here;
9587 ++localized_local_map;
9590 map_here = get_local_map (XINT (pos),
9591 current_buffer,
9592 Qkeymap);
9593 if (!EQ (map_here, orig_keymap))
9595 orig_keymap = map_here;
9596 ++localized_local_map;
9599 if (localized_local_map > 1)
9601 keybuf[t] = key;
9602 mock_input = t + 1;
9604 goto replay_sequence;
9611 /* Expand mode-line and scroll-bar events into two events:
9612 use posn as a fake prefix key. */
9613 if (SYMBOLP (posn)
9614 && (NILP (fake_prefixed_keys)
9615 || NILP (Fmemq (key, fake_prefixed_keys))))
9617 if (bufsize - t <= 1)
9618 error ("Key sequence too long");
9620 keybuf[t] = posn;
9621 keybuf[t + 1] = key;
9622 mock_input = t + 2;
9624 /* Record that a fake prefix key has been generated
9625 for KEY. Don't modify the event; this would
9626 prevent proper action when the event is pushed
9627 back into unread-command-events. */
9628 fake_prefixed_keys = Fcons (key, fake_prefixed_keys);
9630 /* If on a mode line string with a local keymap,
9631 reconsider the key sequence with that keymap. */
9632 if (string = POSN_STRING (EVENT_START (key)),
9633 (CONSP (string) && STRINGP (XCAR (string))))
9635 Lisp_Object pos, map, map2;
9637 pos = XCDR (string);
9638 string = XCAR (string);
9639 if (XINT (pos) >= 0
9640 && XINT (pos) < SCHARS (string))
9642 map = Fget_text_property (pos, Qlocal_map, string);
9643 if (!NILP (map))
9644 orig_local_map = map;
9645 map2 = Fget_text_property (pos, Qkeymap, string);
9646 if (!NILP (map2))
9647 orig_keymap = map2;
9648 if (!NILP (map) || !NILP (map2))
9649 goto replay_sequence;
9653 goto replay_key;
9655 else if (NILP (from_string)
9656 && (string = POSN_STRING (EVENT_START (key)),
9657 (CONSP (string) && STRINGP (XCAR (string)))))
9659 /* For a click on a string, i.e. overlay string or a
9660 string displayed via the `display' property,
9661 consider `local-map' and `keymap' properties of
9662 that string. */
9663 Lisp_Object pos, map, map2;
9665 pos = XCDR (string);
9666 string = XCAR (string);
9667 if (XINT (pos) >= 0
9668 && XINT (pos) < SCHARS (string))
9670 map = Fget_text_property (pos, Qlocal_map, string);
9671 if (!NILP (map))
9672 orig_local_map = map;
9673 map2 = Fget_text_property (pos, Qkeymap, string);
9674 if (!NILP (map2))
9675 orig_keymap = map2;
9677 if (!NILP (map) || !NILP (map2))
9679 from_string = string;
9680 keybuf[t++] = key;
9681 mock_input = t;
9682 goto replay_sequence;
9687 else if (CONSP (XCDR (key))
9688 && CONSP (EVENT_START (key))
9689 && CONSP (XCDR (EVENT_START (key))))
9691 Lisp_Object posn;
9693 posn = POSN_POSN (EVENT_START (key));
9694 /* Handle menu-bar events:
9695 insert the dummy prefix event `menu-bar'. */
9696 if (EQ (posn, Qmenu_bar) || EQ (posn, Qtool_bar))
9698 if (bufsize - t <= 1)
9699 error ("Key sequence too long");
9700 keybuf[t] = posn;
9701 keybuf[t+1] = key;
9703 /* Zap the position in key, so we know that we've
9704 expanded it, and don't try to do so again. */
9705 POSN_SET_POSN (EVENT_START (key),
9706 Fcons (posn, Qnil));
9708 mock_input = t + 2;
9709 goto replay_sequence;
9711 else if (CONSP (posn))
9713 /* We're looking at the second event of a
9714 sequence which we expanded before. Set
9715 last_real_key_start appropriately. */
9716 if (last_real_key_start == t && t > 0)
9717 last_real_key_start = t - 1;
9722 /* We have finally decided that KEY is something we might want
9723 to look up. */
9724 first_binding = (follow_key (key,
9725 nmaps - first_binding,
9726 submaps + first_binding,
9727 defs + first_binding,
9728 submaps + first_binding)
9729 + first_binding);
9731 /* If KEY wasn't bound, we'll try some fallbacks. */
9732 if (first_binding < nmaps)
9733 /* This is needed for the following scenario:
9734 event 0: a down-event that gets dropped by calling replay_key.
9735 event 1: some normal prefix like C-h.
9736 After event 0, first_unbound is 0, after event 1 indec.start,
9737 fkey.start, and keytran.start are all 1, so when we see that
9738 C-h is bound, we need to update first_unbound. */
9739 first_unbound = max (t + 1, first_unbound);
9740 else
9742 Lisp_Object head;
9744 /* Remember the position to put an upper bound on indec.start. */
9745 first_unbound = min (t, first_unbound);
9747 head = EVENT_HEAD (key);
9748 if (help_char_p (head) && t > 0)
9750 read_key_sequence_cmd = Vprefix_help_command;
9751 keybuf[t++] = key;
9752 last_nonmenu_event = key;
9753 /* The Microsoft C compiler can't handle the goto that
9754 would go here. */
9755 dummyflag = 1;
9756 break;
9759 if (SYMBOLP (head))
9761 Lisp_Object breakdown;
9762 int modifiers;
9764 breakdown = parse_modifiers (head);
9765 modifiers = XINT (XCAR (XCDR (breakdown)));
9766 /* Attempt to reduce an unbound mouse event to a simpler
9767 event that is bound:
9768 Drags reduce to clicks.
9769 Double-clicks reduce to clicks.
9770 Triple-clicks reduce to double-clicks, then to clicks.
9771 Down-clicks are eliminated.
9772 Double-downs reduce to downs, then are eliminated.
9773 Triple-downs reduce to double-downs, then to downs,
9774 then are eliminated. */
9775 if (modifiers & (down_modifier | drag_modifier
9776 | double_modifier | triple_modifier))
9778 while (modifiers & (down_modifier | drag_modifier
9779 | double_modifier | triple_modifier))
9781 Lisp_Object new_head, new_click;
9782 if (modifiers & triple_modifier)
9783 modifiers ^= (double_modifier | triple_modifier);
9784 else if (modifiers & double_modifier)
9785 modifiers &= ~double_modifier;
9786 else if (modifiers & drag_modifier)
9787 modifiers &= ~drag_modifier;
9788 else
9790 /* Dispose of this `down' event by simply jumping
9791 back to replay_key, to get another event.
9793 Note that if this event came from mock input,
9794 then just jumping back to replay_key will just
9795 hand it to us again. So we have to wipe out any
9796 mock input.
9798 We could delete keybuf[t] and shift everything
9799 after that to the left by one spot, but we'd also
9800 have to fix up any variable that points into
9801 keybuf, and shifting isn't really necessary
9802 anyway.
9804 Adding prefixes for non-textual mouse clicks
9805 creates two characters of mock input, and both
9806 must be thrown away. If we're only looking at
9807 the prefix now, we can just jump back to
9808 replay_key. On the other hand, if we've already
9809 processed the prefix, and now the actual click
9810 itself is giving us trouble, then we've lost the
9811 state of the keymaps we want to backtrack to, and
9812 we need to replay the whole sequence to rebuild
9815 Beyond that, only function key expansion could
9816 create more than two keys, but that should never
9817 generate mouse events, so it's okay to zero
9818 mock_input in that case too.
9820 FIXME: The above paragraph seems just plain
9821 wrong, if you consider things like
9822 xterm-mouse-mode. -stef
9824 Isn't this just the most wonderful code ever? */
9826 /* If mock_input > t + 1, the above simplification
9827 will actually end up dropping keys on the floor.
9828 This is probably OK for now, but even
9829 if mock_input <= t + 1, we need to adjust indec,
9830 fkey, and keytran.
9831 Typical case [header-line down-mouse-N]:
9832 mock_input = 2, t = 1, fkey.end = 1,
9833 last_real_key_start = 0. */
9834 if (indec.end > last_real_key_start)
9836 indec.end = indec.start
9837 = min (last_real_key_start, indec.start);
9838 indec.map = indec.parent;
9839 if (fkey.end > last_real_key_start)
9841 fkey.end = fkey.start
9842 = min (last_real_key_start, fkey.start);
9843 fkey.map = fkey.parent;
9844 if (keytran.end > last_real_key_start)
9846 keytran.end = keytran.start
9847 = min (last_real_key_start, keytran.start);
9848 keytran.map = keytran.parent;
9852 if (t == last_real_key_start)
9854 mock_input = 0;
9855 goto replay_key;
9857 else
9859 mock_input = last_real_key_start;
9860 goto replay_sequence;
9864 new_head
9865 = apply_modifiers (modifiers, XCAR (breakdown));
9866 new_click
9867 = Fcons (new_head, Fcons (EVENT_START (key), Qnil));
9869 /* Look for a binding for this new key. follow_key
9870 promises that it didn't munge submaps the
9871 last time we called it, since key was unbound. */
9872 first_binding
9873 = (follow_key (new_click,
9874 nmaps - local_first_binding,
9875 submaps + local_first_binding,
9876 defs + local_first_binding,
9877 submaps + local_first_binding)
9878 + local_first_binding);
9880 /* If that click is bound, go for it. */
9881 if (first_binding < nmaps)
9883 key = new_click;
9884 break;
9886 /* Otherwise, we'll leave key set to the drag event. */
9892 keybuf[t++] = key;
9893 /* Normally, last_nonmenu_event gets the previous key we read.
9894 But when a mouse popup menu is being used,
9895 we don't update last_nonmenu_event; it continues to hold the mouse
9896 event that preceded the first level of menu. */
9897 if (!used_mouse_menu)
9898 last_nonmenu_event = key;
9900 /* Record what part of this_command_keys is the current key sequence. */
9901 this_single_command_key_start = this_command_key_count - t;
9903 /* Look for this sequence in input-decode-map.
9904 Scan from indec.end until we find a bound suffix. */
9905 while (indec.end < t)
9907 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
9908 int done, diff;
9910 GCPRO4 (indec.map, fkey.map, keytran.map, delayed_switch_frame);
9911 done = keyremap_step (keybuf, bufsize, &indec, max (t, mock_input),
9912 1, &diff, prompt);
9913 UNGCPRO;
9914 if (done)
9916 mock_input = diff + max (t, mock_input);
9917 goto replay_sequence;
9921 if (first_binding < nmaps
9922 && NILP (submaps[first_binding])
9923 && !test_undefined (defs[first_binding])
9924 && indec.start >= t)
9925 /* There is a binding and it's not a prefix.
9926 (and it doesn't have any input-decode-map translation pending).
9927 There is thus no function-key in this sequence.
9928 Moving fkey.start is important in this case to allow keytran.start
9929 to go over the sequence before we return (since we keep the
9930 invariant that keytran.end <= fkey.start). */
9932 if (fkey.start < t)
9933 (fkey.start = fkey.end = t, fkey.map = fkey.parent);
9935 else
9936 /* If the sequence is unbound, see if we can hang a function key
9937 off the end of it. */
9938 /* Continue scan from fkey.end until we find a bound suffix. */
9939 while (fkey.end < indec.start)
9941 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
9942 int done, diff;
9944 GCPRO4 (indec.map, fkey.map, keytran.map, delayed_switch_frame);
9945 done = keyremap_step (keybuf, bufsize, &fkey,
9946 max (t, mock_input),
9947 /* If there's a binding (i.e.
9948 first_binding >= nmaps) we don't want
9949 to apply this function-key-mapping. */
9950 fkey.end + 1 == t
9951 && (first_binding >= nmaps
9952 || test_undefined (defs[first_binding])),
9953 &diff, prompt);
9954 UNGCPRO;
9955 if (done)
9957 mock_input = diff + max (t, mock_input);
9958 /* Adjust the input-decode-map counters. */
9959 indec.end += diff;
9960 indec.start += diff;
9962 goto replay_sequence;
9966 /* Look for this sequence in key-translation-map.
9967 Scan from keytran.end until we find a bound suffix. */
9968 while (keytran.end < fkey.start)
9970 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
9971 int done, diff;
9973 GCPRO4 (indec.map, fkey.map, keytran.map, delayed_switch_frame);
9974 done = keyremap_step (keybuf, bufsize, &keytran, max (t, mock_input),
9975 1, &diff, prompt);
9976 UNGCPRO;
9977 if (done)
9979 mock_input = diff + max (t, mock_input);
9980 /* Adjust the function-key-map and input-decode-map counters. */
9981 indec.end += diff;
9982 indec.start += diff;
9983 fkey.end += diff;
9984 fkey.start += diff;
9986 goto replay_sequence;
9990 /* If KEY is not defined in any of the keymaps,
9991 and cannot be part of a function key or translation,
9992 and is an upper case letter
9993 use the corresponding lower-case letter instead. */
9994 if (first_binding >= nmaps
9995 && /* indec.start >= t && fkey.start >= t && */ keytran.start >= t
9996 && INTEGERP (key)
9997 && ((CHARACTERP (make_number (XINT (key) & ~CHAR_MODIFIER_MASK))
9998 && uppercasep (XINT (key) & ~CHAR_MODIFIER_MASK))
9999 || (XINT (key) & shift_modifier)))
10001 Lisp_Object new_key;
10003 original_uppercase = key;
10004 original_uppercase_position = t - 1;
10006 if (XINT (key) & shift_modifier)
10007 XSETINT (new_key, XINT (key) & ~shift_modifier);
10008 else
10009 XSETINT (new_key, (downcase (XINT (key) & ~CHAR_MODIFIER_MASK)
10010 | (XINT (key) & CHAR_MODIFIER_MASK)));
10012 /* We have to do this unconditionally, regardless of whether
10013 the lower-case char is defined in the keymaps, because they
10014 might get translated through function-key-map. */
10015 keybuf[t - 1] = new_key;
10016 mock_input = max (t, mock_input);
10017 shift_translated = 1;
10019 goto replay_sequence;
10021 /* If KEY is not defined in any of the keymaps,
10022 and cannot be part of a function key or translation,
10023 and is a shifted function key,
10024 use the corresponding unshifted function key instead. */
10025 if (first_binding >= nmaps
10026 && /* indec.start >= t && fkey.start >= t && */ keytran.start >= t)
10028 Lisp_Object breakdown = parse_modifiers (key);
10029 int modifiers
10030 = CONSP (breakdown) ? (XINT (XCAR (XCDR (breakdown)))) : 0;
10032 if (modifiers & shift_modifier
10033 /* Treat uppercase keys as shifted. */
10034 || (INTEGERP (key)
10035 && (KEY_TO_CHAR (key)
10036 < XCHAR_TABLE (BVAR (current_buffer, downcase_table))->header.size)
10037 && uppercasep (KEY_TO_CHAR (key))))
10039 Lisp_Object new_key
10040 = (modifiers & shift_modifier
10041 ? apply_modifiers (modifiers & ~shift_modifier,
10042 XCAR (breakdown))
10043 : make_number (downcase (KEY_TO_CHAR (key)) | modifiers));
10045 original_uppercase = key;
10046 original_uppercase_position = t - 1;
10048 /* We have to do this unconditionally, regardless of whether
10049 the lower-case char is defined in the keymaps, because they
10050 might get translated through function-key-map. */
10051 keybuf[t - 1] = new_key;
10052 mock_input = max (t, mock_input);
10053 /* Reset fkey (and consequently keytran) to apply
10054 function-key-map on the result, so that S-backspace is
10055 correctly mapped to DEL (via backspace). OTOH,
10056 input-decode-map doesn't need to go through it again. */
10057 fkey.start = fkey.end = 0;
10058 keytran.start = keytran.end = 0;
10059 shift_translated = 1;
10061 goto replay_sequence;
10065 if (!dummyflag)
10066 read_key_sequence_cmd = (first_binding < nmaps
10067 ? defs[first_binding]
10068 : Qnil);
10069 read_key_sequence_remapped
10070 /* Remap command through active keymaps.
10071 Do the remapping here, before the unbind_to so it uses the keymaps
10072 of the appropriate buffer. */
10073 = SYMBOLP (read_key_sequence_cmd)
10074 ? Fcommand_remapping (read_key_sequence_cmd, Qnil, Qnil)
10075 : Qnil;
10077 unread_switch_frame = delayed_switch_frame;
10078 unbind_to (count, Qnil);
10080 /* Don't downcase the last character if the caller says don't.
10081 Don't downcase it if the result is undefined, either. */
10082 if ((dont_downcase_last || first_binding >= nmaps)
10083 && t > 0
10084 && t - 1 == original_uppercase_position)
10086 keybuf[t - 1] = original_uppercase;
10087 shift_translated = 0;
10090 if (shift_translated)
10091 Vthis_command_keys_shift_translated = Qt;
10093 /* Occasionally we fabricate events, perhaps by expanding something
10094 according to function-key-map, or by adding a prefix symbol to a
10095 mouse click in the scroll bar or modeline. In this cases, return
10096 the entire generated key sequence, even if we hit an unbound
10097 prefix or a definition before the end. This means that you will
10098 be able to push back the event properly, and also means that
10099 read-key-sequence will always return a logical unit.
10101 Better ideas? */
10102 for (; t < mock_input; t++)
10104 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
10105 && NILP (Fzerop (Vecho_keystrokes)))
10106 echo_char (keybuf[t]);
10107 add_command_key (keybuf[t]);
10110 UNGCPRO;
10111 return t;
10114 DEFUN ("read-key-sequence", Fread_key_sequence, Sread_key_sequence, 1, 5, 0,
10115 doc: /* Read a sequence of keystrokes and return as a string or vector.
10116 The sequence is sufficient to specify a non-prefix command in the
10117 current local and global maps.
10119 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10120 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10121 as a continuation of the previous key.
10123 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10124 convert the last event to lower case. (Normally any upper case event
10125 is converted to lower case if the original event is undefined and the lower
10126 case equivalent is defined.) A non-nil value is appropriate for reading
10127 a key sequence to be defined.
10129 A C-g typed while in this function is treated like any other character,
10130 and `quit-flag' is not set.
10132 If the key sequence starts with a mouse click, then the sequence is read
10133 using the keymaps of the buffer of the window clicked in, not the buffer
10134 of the selected window as normal.
10136 `read-key-sequence' drops unbound button-down events, since you normally
10137 only care about the click or drag events which follow them. If a drag
10138 or multi-click event is unbound, but the corresponding click event would
10139 be bound, `read-key-sequence' turns the event into a click event at the
10140 drag's starting position. This means that you don't have to distinguish
10141 between click and drag, double, or triple events unless you want to.
10143 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10144 lines separating windows, and scroll bars with imaginary keys
10145 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10147 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10148 function will process a switch-frame event if the user switches frames
10149 before typing anything. If the user switches frames in the middle of a
10150 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10151 is nil, then the event will be put off until after the current key sequence.
10153 `read-key-sequence' checks `function-key-map' for function key
10154 sequences, where they wouldn't conflict with ordinary bindings. See
10155 `function-key-map' for more details.
10157 The optional fifth argument CMD-LOOP, if non-nil, means
10158 that this key sequence is being read by something that will
10159 read commands one after another. It should be nil if the caller
10160 will read just one key sequence. */)
10161 (Lisp_Object prompt, Lisp_Object continue_echo, Lisp_Object dont_downcase_last, Lisp_Object can_return_switch_frame, Lisp_Object cmd_loop)
10163 Lisp_Object keybuf[30];
10164 register int i;
10165 struct gcpro gcpro1;
10166 ptrdiff_t count = SPECPDL_INDEX ();
10168 if (!NILP (prompt))
10169 CHECK_STRING (prompt);
10170 QUIT;
10172 specbind (Qinput_method_exit_on_first_char,
10173 (NILP (cmd_loop) ? Qt : Qnil));
10174 specbind (Qinput_method_use_echo_area,
10175 (NILP (cmd_loop) ? Qt : Qnil));
10177 memset (keybuf, 0, sizeof keybuf);
10178 GCPRO1 (keybuf[0]);
10179 gcpro1.nvars = (sizeof keybuf/sizeof (keybuf[0]));
10181 if (NILP (continue_echo))
10183 this_command_key_count = 0;
10184 this_command_key_count_reset = 0;
10185 this_single_command_key_start = 0;
10188 #ifdef HAVE_WINDOW_SYSTEM
10189 if (display_hourglass_p)
10190 cancel_hourglass ();
10191 #endif
10193 i = read_key_sequence (keybuf, (sizeof keybuf/sizeof (keybuf[0])),
10194 prompt, ! NILP (dont_downcase_last),
10195 ! NILP (can_return_switch_frame), 0);
10197 #if 0 /* The following is fine for code reading a key sequence and
10198 then proceeding with a lengthy computation, but it's not good
10199 for code reading keys in a loop, like an input method. */
10200 #ifdef HAVE_WINDOW_SYSTEM
10201 if (display_hourglass_p)
10202 start_hourglass ();
10203 #endif
10204 #endif
10206 if (i == -1)
10208 Vquit_flag = Qt;
10209 QUIT;
10211 UNGCPRO;
10212 return unbind_to (count, make_event_array (i, keybuf));
10215 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector,
10216 Sread_key_sequence_vector, 1, 5, 0,
10217 doc: /* Like `read-key-sequence' but always return a vector. */)
10218 (Lisp_Object prompt, Lisp_Object continue_echo, Lisp_Object dont_downcase_last, Lisp_Object can_return_switch_frame, Lisp_Object cmd_loop)
10220 Lisp_Object keybuf[30];
10221 register int i;
10222 struct gcpro gcpro1;
10223 ptrdiff_t count = SPECPDL_INDEX ();
10225 if (!NILP (prompt))
10226 CHECK_STRING (prompt);
10227 QUIT;
10229 specbind (Qinput_method_exit_on_first_char,
10230 (NILP (cmd_loop) ? Qt : Qnil));
10231 specbind (Qinput_method_use_echo_area,
10232 (NILP (cmd_loop) ? Qt : Qnil));
10234 memset (keybuf, 0, sizeof keybuf);
10235 GCPRO1 (keybuf[0]);
10236 gcpro1.nvars = (sizeof keybuf / sizeof (keybuf[0]));
10238 if (NILP (continue_echo))
10240 this_command_key_count = 0;
10241 this_command_key_count_reset = 0;
10242 this_single_command_key_start = 0;
10245 #ifdef HAVE_WINDOW_SYSTEM
10246 if (display_hourglass_p)
10247 cancel_hourglass ();
10248 #endif
10250 i = read_key_sequence (keybuf, (sizeof keybuf / sizeof (keybuf[0])),
10251 prompt, ! NILP (dont_downcase_last),
10252 ! NILP (can_return_switch_frame), 0);
10254 #ifdef HAVE_WINDOW_SYSTEM
10255 if (display_hourglass_p)
10256 start_hourglass ();
10257 #endif
10259 if (i == -1)
10261 Vquit_flag = Qt;
10262 QUIT;
10264 UNGCPRO;
10265 return unbind_to (count, Fvector (i, keybuf));
10268 DEFUN ("command-execute", Fcommand_execute, Scommand_execute, 1, 4, 0,
10269 doc: /* Execute CMD as an editor command.
10270 CMD must be a symbol that satisfies the `commandp' predicate.
10271 Optional second arg RECORD-FLAG non-nil
10272 means unconditionally put this command in `command-history'.
10273 Otherwise, that is done only if an arg is read using the minibuffer.
10274 The argument KEYS specifies the value to use instead of (this-command-keys)
10275 when reading the arguments; if it is nil, (this-command-keys) is used.
10276 The argument SPECIAL, if non-nil, means that this command is executing
10277 a special event, so ignore the prefix argument and don't clear it. */)
10278 (Lisp_Object cmd, Lisp_Object record_flag, Lisp_Object keys, Lisp_Object special)
10280 register Lisp_Object final;
10281 register Lisp_Object tem;
10282 Lisp_Object prefixarg;
10284 debug_on_next_call = 0;
10286 if (NILP (special))
10288 prefixarg = KVAR (current_kboard, Vprefix_arg);
10289 Vcurrent_prefix_arg = prefixarg;
10290 KVAR (current_kboard, Vprefix_arg) = Qnil;
10292 else
10293 prefixarg = Qnil;
10295 if (SYMBOLP (cmd))
10297 tem = Fget (cmd, Qdisabled);
10298 if (!NILP (tem))
10300 tem = Fsymbol_value (Qdisabled_command_function);
10301 if (!NILP (tem))
10302 return Frun_hooks (1, &Qdisabled_command_function);
10306 while (1)
10308 final = Findirect_function (cmd, Qnil);
10310 if (CONSP (final) && (tem = Fcar (final), EQ (tem, Qautoload)))
10312 struct gcpro gcpro1, gcpro2;
10314 GCPRO2 (cmd, prefixarg);
10315 do_autoload (final, cmd);
10316 UNGCPRO;
10318 else
10319 break;
10322 if (STRINGP (final) || VECTORP (final))
10324 /* If requested, place the macro in the command history. For
10325 other sorts of commands, call-interactively takes care of
10326 this. */
10327 if (!NILP (record_flag))
10329 Vcommand_history
10330 = Fcons (Fcons (Qexecute_kbd_macro,
10331 Fcons (final, Fcons (prefixarg, Qnil))),
10332 Vcommand_history);
10334 /* Don't keep command history around forever. */
10335 if (NUMBERP (Vhistory_length) && XINT (Vhistory_length) > 0)
10337 tem = Fnthcdr (Vhistory_length, Vcommand_history);
10338 if (CONSP (tem))
10339 XSETCDR (tem, Qnil);
10343 return Fexecute_kbd_macro (final, prefixarg, Qnil);
10346 if (CONSP (final) || SUBRP (final) || COMPILEDP (final))
10347 /* Don't call Fcall_interactively directly because we want to make
10348 sure the backtrace has an entry for `call-interactively'.
10349 For the same reason, pass `cmd' rather than `final'. */
10350 return call3 (Qcall_interactively, cmd, record_flag, keys);
10352 return Qnil;
10357 /* Return nonzero if input events are pending. */
10360 detect_input_pending (void)
10362 if (!input_pending)
10363 get_input_pending (&input_pending, 0);
10365 return input_pending;
10368 /* Return nonzero if input events other than mouse movements are
10369 pending. */
10372 detect_input_pending_ignore_squeezables (void)
10374 if (!input_pending)
10375 get_input_pending (&input_pending, READABLE_EVENTS_IGNORE_SQUEEZABLES);
10377 return input_pending;
10380 /* Return nonzero if input events are pending, and run any pending timers. */
10383 detect_input_pending_run_timers (int do_display)
10385 int old_timers_run = timers_run;
10387 if (!input_pending)
10388 get_input_pending (&input_pending, READABLE_EVENTS_DO_TIMERS_NOW);
10390 if (old_timers_run != timers_run && do_display)
10392 redisplay_preserve_echo_area (8);
10393 /* The following fixes a bug when using lazy-lock with
10394 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10395 from an idle timer function. The symptom of the bug is that
10396 the cursor sometimes doesn't become visible until the next X
10397 event is processed. --gerd. */
10399 Lisp_Object tail, frame;
10400 FOR_EACH_FRAME (tail, frame)
10401 if (FRAME_RIF (XFRAME (frame)))
10402 FRAME_RIF (XFRAME (frame))->flush_display (XFRAME (frame));
10406 return input_pending;
10409 /* This is called in some cases before a possible quit.
10410 It cases the next call to detect_input_pending to recompute input_pending.
10411 So calling this function unnecessarily can't do any harm. */
10413 void
10414 clear_input_pending (void)
10416 input_pending = 0;
10419 /* Return nonzero if there are pending requeued events.
10420 This isn't used yet. The hope is to make wait_reading_process_output
10421 call it, and return if it runs Lisp code that unreads something.
10422 The problem is, kbd_buffer_get_event needs to be fixed to know what
10423 to do in that case. It isn't trivial. */
10426 requeued_events_pending_p (void)
10428 return (!NILP (Vunread_command_events) || unread_command_char != -1);
10432 DEFUN ("input-pending-p", Finput_pending_p, Sinput_pending_p, 0, 0, 0,
10433 doc: /* Return t if command input is currently available with no wait.
10434 Actually, the value is nil only if we can be sure that no input is available;
10435 if there is a doubt, the value is t. */)
10436 (void)
10438 if (!NILP (Vunread_command_events) || unread_command_char != -1
10439 || !NILP (Vunread_post_input_method_events)
10440 || !NILP (Vunread_input_method_events))
10441 return (Qt);
10443 /* Process non-user-visible events (Bug#10195). */
10444 process_special_events ();
10446 get_input_pending (&input_pending,
10447 READABLE_EVENTS_DO_TIMERS_NOW
10448 | READABLE_EVENTS_FILTER_EVENTS);
10449 return input_pending > 0 ? Qt : Qnil;
10452 DEFUN ("recent-keys", Frecent_keys, Srecent_keys, 0, 0, 0,
10453 doc: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10454 (void)
10456 Lisp_Object *keys = XVECTOR (recent_keys)->contents;
10457 Lisp_Object val;
10459 if (total_keys < NUM_RECENT_KEYS)
10460 return Fvector (total_keys, keys);
10461 else
10463 val = Fvector (NUM_RECENT_KEYS, keys);
10464 memcpy (XVECTOR (val)->contents, keys + recent_keys_index,
10465 (NUM_RECENT_KEYS - recent_keys_index) * sizeof (Lisp_Object));
10466 memcpy (XVECTOR (val)->contents + NUM_RECENT_KEYS - recent_keys_index,
10467 keys, recent_keys_index * sizeof (Lisp_Object));
10468 return val;
10472 DEFUN ("this-command-keys", Fthis_command_keys, Sthis_command_keys, 0, 0, 0,
10473 doc: /* Return the key sequence that invoked this command.
10474 However, if the command has called `read-key-sequence', it returns
10475 the last key sequence that has been read.
10476 The value is a string or a vector.
10478 See also `this-command-keys-vector'. */)
10479 (void)
10481 return make_event_array (this_command_key_count,
10482 XVECTOR (this_command_keys)->contents);
10485 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector, Sthis_command_keys_vector, 0, 0, 0,
10486 doc: /* Return the key sequence that invoked this command, as a vector.
10487 However, if the command has called `read-key-sequence', it returns
10488 the last key sequence that has been read.
10490 See also `this-command-keys'. */)
10491 (void)
10493 return Fvector (this_command_key_count,
10494 XVECTOR (this_command_keys)->contents);
10497 DEFUN ("this-single-command-keys", Fthis_single_command_keys,
10498 Sthis_single_command_keys, 0, 0, 0,
10499 doc: /* Return the key sequence that invoked this command.
10500 More generally, it returns the last key sequence read, either by
10501 the command loop or by `read-key-sequence'.
10502 Unlike `this-command-keys', this function's value
10503 does not include prefix arguments.
10504 The value is always a vector. */)
10505 (void)
10507 return Fvector (this_command_key_count
10508 - this_single_command_key_start,
10509 (XVECTOR (this_command_keys)->contents
10510 + this_single_command_key_start));
10513 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys,
10514 Sthis_single_command_raw_keys, 0, 0, 0,
10515 doc: /* Return the raw events that were read for this command.
10516 More generally, it returns the last key sequence read, either by
10517 the command loop or by `read-key-sequence'.
10518 Unlike `this-single-command-keys', this function's value
10519 shows the events before all translations (except for input methods).
10520 The value is always a vector. */)
10521 (void)
10523 return Fvector (raw_keybuf_count,
10524 (XVECTOR (raw_keybuf)->contents));
10527 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths,
10528 Sreset_this_command_lengths, 0, 0, 0,
10529 doc: /* Make the unread events replace the last command and echo.
10530 Used in `universal-argument-other-key'.
10532 `universal-argument-other-key' rereads the event just typed.
10533 It then gets translated through `function-key-map'.
10534 The translated event has to replace the real events,
10535 both in the value of (this-command-keys) and in echoing.
10536 To achieve this, `universal-argument-other-key' calls
10537 `reset-this-command-lengths', which discards the record of reading
10538 these events the first time. */)
10539 (void)
10541 this_command_key_count = before_command_key_count;
10542 if (this_command_key_count < this_single_command_key_start)
10543 this_single_command_key_start = this_command_key_count;
10545 echo_truncate (before_command_echo_length);
10547 /* Cause whatever we put into unread-command-events
10548 to echo as if it were being freshly read from the keyboard. */
10549 this_command_key_count_reset = 1;
10551 return Qnil;
10554 DEFUN ("clear-this-command-keys", Fclear_this_command_keys,
10555 Sclear_this_command_keys, 0, 1, 0,
10556 doc: /* Clear out the vector that `this-command-keys' returns.
10557 Also clear the record of the last 100 events, unless optional arg
10558 KEEP-RECORD is non-nil. */)
10559 (Lisp_Object keep_record)
10561 int i;
10563 this_command_key_count = 0;
10564 this_command_key_count_reset = 0;
10566 if (NILP (keep_record))
10568 for (i = 0; i < ASIZE (recent_keys); ++i)
10569 XVECTOR (recent_keys)->contents[i] = Qnil;
10570 total_keys = 0;
10571 recent_keys_index = 0;
10573 return Qnil;
10576 DEFUN ("recursion-depth", Frecursion_depth, Srecursion_depth, 0, 0, 0,
10577 doc: /* Return the current depth in recursive edits. */)
10578 (void)
10580 Lisp_Object temp;
10581 /* Wrap around reliably on integer overflow. */
10582 EMACS_INT sum = (command_loop_level & INTMASK) + (minibuf_level & INTMASK);
10583 XSETINT (temp, sum);
10584 return temp;
10587 DEFUN ("open-dribble-file", Fopen_dribble_file, Sopen_dribble_file, 1, 1,
10588 "FOpen dribble file: ",
10589 doc: /* Start writing all keyboard characters to a dribble file called FILE.
10590 If FILE is nil, close any open dribble file.
10591 The file will be closed when Emacs exits. */)
10592 (Lisp_Object file)
10594 if (dribble)
10596 BLOCK_INPUT;
10597 fclose (dribble);
10598 UNBLOCK_INPUT;
10599 dribble = 0;
10601 if (!NILP (file))
10603 file = Fexpand_file_name (file, Qnil);
10604 dribble = fopen (SSDATA (file), "w");
10605 if (dribble == 0)
10606 report_file_error ("Opening dribble", Fcons (file, Qnil));
10608 return Qnil;
10611 DEFUN ("discard-input", Fdiscard_input, Sdiscard_input, 0, 0, 0,
10612 doc: /* Discard the contents of the terminal input buffer.
10613 Also end any kbd macro being defined. */)
10614 (void)
10616 if (!NILP (KVAR (current_kboard, defining_kbd_macro)))
10618 /* Discard the last command from the macro. */
10619 Fcancel_kbd_macro_events ();
10620 end_kbd_macro ();
10623 update_mode_lines++;
10625 Vunread_command_events = Qnil;
10626 unread_command_char = -1;
10628 discard_tty_input ();
10630 kbd_fetch_ptr = kbd_store_ptr;
10631 input_pending = 0;
10633 return Qnil;
10636 DEFUN ("suspend-emacs", Fsuspend_emacs, Ssuspend_emacs, 0, 1, "",
10637 doc: /* Stop Emacs and return to superior process. You can resume later.
10638 If `cannot-suspend' is non-nil, or if the system doesn't support job
10639 control, run a subshell instead.
10641 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10642 to be read as terminal input by Emacs's parent, after suspension.
10644 Before suspending, run the normal hook `suspend-hook'.
10645 After resumption run the normal hook `suspend-resume-hook'.
10647 Some operating systems cannot stop the Emacs process and resume it later.
10648 On such systems, Emacs starts a subshell instead of suspending. */)
10649 (Lisp_Object stuffstring)
10651 ptrdiff_t count = SPECPDL_INDEX ();
10652 int old_height, old_width;
10653 int width, height;
10654 struct gcpro gcpro1;
10655 Lisp_Object hook;
10657 if (tty_list && tty_list->next)
10658 error ("There are other tty frames open; close them before suspending Emacs");
10660 if (!NILP (stuffstring))
10661 CHECK_STRING (stuffstring);
10663 /* Run the functions in suspend-hook. */
10664 hook = intern ("suspend-hook");
10665 Frun_hooks (1, &hook);
10667 GCPRO1 (stuffstring);
10668 get_tty_size (fileno (CURTTY ()->input), &old_width, &old_height);
10669 reset_all_sys_modes ();
10670 /* sys_suspend can get an error if it tries to fork a subshell
10671 and the system resources aren't available for that. */
10672 record_unwind_protect ((Lisp_Object (*) (Lisp_Object)) init_all_sys_modes,
10673 Qnil);
10674 stuff_buffered_input (stuffstring);
10675 if (cannot_suspend)
10676 sys_subshell ();
10677 else
10678 sys_suspend ();
10679 unbind_to (count, Qnil);
10681 /* Check if terminal/window size has changed.
10682 Note that this is not useful when we are running directly
10683 with a window system; but suspend should be disabled in that case. */
10684 get_tty_size (fileno (CURTTY ()->input), &width, &height);
10685 if (width != old_width || height != old_height)
10686 change_frame_size (SELECTED_FRAME (), height, width, 0, 0, 0);
10688 /* Run suspend-resume-hook. */
10689 hook = intern ("suspend-resume-hook");
10690 Frun_hooks (1, &hook);
10692 UNGCPRO;
10693 return Qnil;
10696 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10697 Then in any case stuff anything Emacs has read ahead and not used. */
10699 void
10700 stuff_buffered_input (Lisp_Object stuffstring)
10702 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10703 register unsigned char *p;
10705 if (STRINGP (stuffstring))
10707 register ptrdiff_t count;
10709 p = SDATA (stuffstring);
10710 count = SBYTES (stuffstring);
10711 while (count-- > 0)
10712 stuff_char (*p++);
10713 stuff_char ('\n');
10716 /* Anything we have read ahead, put back for the shell to read. */
10717 /* ?? What should this do when we have multiple keyboards??
10718 Should we ignore anything that was typed in at the "wrong" kboard?
10720 rms: we should stuff everything back into the kboard
10721 it came from. */
10722 for (; kbd_fetch_ptr != kbd_store_ptr; kbd_fetch_ptr++)
10725 if (kbd_fetch_ptr == kbd_buffer + KBD_BUFFER_SIZE)
10726 kbd_fetch_ptr = kbd_buffer;
10727 if (kbd_fetch_ptr->kind == ASCII_KEYSTROKE_EVENT)
10728 stuff_char (kbd_fetch_ptr->code);
10730 clear_event (kbd_fetch_ptr);
10733 input_pending = 0;
10734 #endif /* SIGTSTP */
10737 void
10738 set_waiting_for_input (struct timeval *time_to_clear)
10740 input_available_clear_time = time_to_clear;
10742 /* Tell handle_interrupt to throw back to read_char, */
10743 waiting_for_input = 1;
10745 /* If handle_interrupt was called before and buffered a C-g,
10746 make it run again now, to avoid timing error. */
10747 if (!NILP (Vquit_flag))
10748 quit_throw_to_read_char (0);
10751 void
10752 clear_waiting_for_input (void)
10754 /* Tell handle_interrupt not to throw back to read_char, */
10755 waiting_for_input = 0;
10756 input_available_clear_time = 0;
10759 /* The SIGINT handler.
10761 If we have a frame on the controlling tty, we assume that the
10762 SIGINT was generated by C-g, so we call handle_interrupt.
10763 Otherwise, tell QUIT to kill Emacs. */
10765 static void
10766 interrupt_signal (int signalnum) /* If we don't have an argument, some */
10767 /* compilers complain in signal calls. */
10769 /* Must preserve main program's value of errno. */
10770 int old_errno = errno;
10771 struct terminal *terminal;
10773 SIGNAL_THREAD_CHECK (signalnum);
10775 /* See if we have an active terminal on our controlling tty. */
10776 terminal = get_named_tty ("/dev/tty");
10777 if (!terminal)
10779 /* If there are no frames there, let's pretend that we are a
10780 well-behaving UN*X program and quit. We must not call Lisp
10781 in a signal handler, so tell QUIT to exit when it is
10782 safe. */
10783 Vquit_flag = Qkill_emacs;
10785 else
10787 /* Otherwise, the SIGINT was probably generated by C-g. */
10789 /* Set internal_last_event_frame to the top frame of the
10790 controlling tty, if we have a frame there. We disable the
10791 interrupt key on secondary ttys, so the SIGINT must have come
10792 from the controlling tty. */
10793 internal_last_event_frame = terminal->display_info.tty->top_frame;
10795 handle_interrupt ();
10798 errno = old_errno;
10801 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10802 of the number of times C-g has been requested. If C-g is pressed
10803 enough times, then quit anyway. See bug#6585. */
10804 static int force_quit_count;
10806 /* This routine is called at interrupt level in response to C-g.
10808 It is called from the SIGINT handler or kbd_buffer_store_event.
10810 If `waiting_for_input' is non zero, then unless `echoing' is
10811 nonzero, immediately throw back to read_char.
10813 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10814 eval to throw, when it gets a chance. If quit-flag is already
10815 non-nil, it stops the job right away. */
10817 static void
10818 handle_interrupt (void)
10820 char c;
10822 cancel_echoing ();
10824 /* XXX This code needs to be revised for multi-tty support. */
10825 if (!NILP (Vquit_flag) && get_named_tty ("/dev/tty"))
10827 /* If SIGINT isn't blocked, don't let us be interrupted by
10828 another SIGINT, it might be harmful due to non-reentrancy
10829 in I/O functions. */
10830 sigblock (sigmask (SIGINT));
10832 fflush (stdout);
10833 reset_all_sys_modes ();
10835 #ifdef SIGTSTP /* Support possible in later USG versions */
10837 * On systems which can suspend the current process and return to the original
10838 * shell, this command causes the user to end up back at the shell.
10839 * The "Auto-save" and "Abort" questions are not asked until
10840 * the user elects to return to emacs, at which point he can save the current
10841 * job and either dump core or continue.
10843 sys_suspend ();
10844 #else
10845 /* Perhaps should really fork an inferior shell?
10846 But that would not provide any way to get back
10847 to the original shell, ever. */
10848 printf ("No support for stopping a process on this operating system;\n");
10849 printf ("you can continue or abort.\n");
10850 #endif /* not SIGTSTP */
10851 #ifdef MSDOS
10852 /* We must remain inside the screen area when the internal terminal
10853 is used. Note that [Enter] is not echoed by dos. */
10854 cursor_to (SELECTED_FRAME (), 0, 0);
10855 #endif
10856 /* It doesn't work to autosave while GC is in progress;
10857 the code used for auto-saving doesn't cope with the mark bit. */
10858 if (!gc_in_progress)
10860 printf ("Auto-save? (y or n) ");
10861 fflush (stdout);
10862 if (((c = getchar ()) & ~040) == 'Y')
10864 Fdo_auto_save (Qt, Qnil);
10865 #ifdef MSDOS
10866 printf ("\r\nAuto-save done");
10867 #else /* not MSDOS */
10868 printf ("Auto-save done\n");
10869 #endif /* not MSDOS */
10871 while (c != '\n') c = getchar ();
10873 else
10875 /* During GC, it must be safe to reenable quitting again. */
10876 Vinhibit_quit = Qnil;
10877 #ifdef MSDOS
10878 printf ("\r\n");
10879 #endif /* not MSDOS */
10880 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10881 printf ("but will instead do a real quit after garbage collection ends\r\n");
10882 fflush (stdout);
10885 #ifdef MSDOS
10886 printf ("\r\nAbort? (y or n) ");
10887 #else /* not MSDOS */
10888 printf ("Abort (and dump core)? (y or n) ");
10889 #endif /* not MSDOS */
10890 fflush (stdout);
10891 if (((c = getchar ()) & ~040) == 'Y')
10892 abort ();
10893 while (c != '\n') c = getchar ();
10894 #ifdef MSDOS
10895 printf ("\r\nContinuing...\r\n");
10896 #else /* not MSDOS */
10897 printf ("Continuing...\n");
10898 #endif /* not MSDOS */
10899 fflush (stdout);
10900 init_all_sys_modes ();
10901 sigfree ();
10903 else
10905 /* If executing a function that wants to be interrupted out of
10906 and the user has not deferred quitting by binding `inhibit-quit'
10907 then quit right away. */
10908 if (immediate_quit && NILP (Vinhibit_quit))
10910 struct gl_state_s saved;
10911 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
10913 immediate_quit = 0;
10914 sigfree ();
10915 saved = gl_state;
10916 GCPRO4 (saved.object, saved.global_code,
10917 saved.current_syntax_table, saved.old_prop);
10918 Fsignal (Qquit, Qnil);
10919 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10920 gl_state = saved;
10921 UNGCPRO;
10923 else
10924 { /* Else request quit when it's safe. */
10925 if (NILP (Vquit_flag))
10926 force_quit_count = 0;
10927 if (++force_quit_count == 3)
10929 immediate_quit = 1;
10930 Vinhibit_quit = Qnil;
10932 Vquit_flag = Qt;
10936 /* TODO: The longjmp in this call throws the NS event loop integration off,
10937 and it seems to do fine without this. Probably some attention
10938 needs to be paid to the setting of waiting_for_input in
10939 wait_reading_process_output() under HAVE_NS because of the call
10940 to ns_select there (needed because otherwise events aren't picked up
10941 outside of polling since we don't get SIGIO like X and we don't have a
10942 separate event loop thread like W32. */
10943 #ifndef HAVE_NS
10944 if (waiting_for_input && !echoing)
10945 quit_throw_to_read_char (1);
10946 #endif
10949 /* Handle a C-g by making read_char return C-g. */
10951 static void
10952 quit_throw_to_read_char (int from_signal)
10954 /* When not called from a signal handler it is safe to call
10955 Lisp. */
10956 if (!from_signal && EQ (Vquit_flag, Qkill_emacs))
10957 Fkill_emacs (Qnil);
10959 sigfree ();
10960 /* Prevent another signal from doing this before we finish. */
10961 clear_waiting_for_input ();
10962 input_pending = 0;
10964 Vunread_command_events = Qnil;
10965 unread_command_char = -1;
10967 #if 0 /* Currently, sit_for is called from read_char without turning
10968 off polling. And that can call set_waiting_for_input.
10969 It seems to be harmless. */
10970 #ifdef POLL_FOR_INPUT
10971 /* May be > 1 if in recursive minibuffer. */
10972 if (poll_suppress_count == 0)
10973 abort ();
10974 #endif
10975 #endif
10976 if (FRAMEP (internal_last_event_frame)
10977 && !EQ (internal_last_event_frame, selected_frame))
10978 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame),
10979 0, 0, Qnil);
10981 _longjmp (getcjmp, 1);
10984 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode,
10985 Sset_input_interrupt_mode, 1, 1, 0,
10986 doc: /* Set interrupt mode of reading keyboard input.
10987 If INTERRUPT is non-nil, Emacs will use input interrupts;
10988 otherwise Emacs uses CBREAK mode.
10990 See also `current-input-mode'. */)
10991 (Lisp_Object interrupt)
10993 int new_interrupt_input;
10994 #ifdef SIGIO
10995 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10996 #ifdef HAVE_X_WINDOWS
10997 if (x_display_list != NULL)
10999 /* When using X, don't give the user a real choice,
11000 because we haven't implemented the mechanisms to support it. */
11001 new_interrupt_input = 1;
11003 else
11004 #endif /* HAVE_X_WINDOWS */
11005 new_interrupt_input = !NILP (interrupt);
11006 #else /* not SIGIO */
11007 new_interrupt_input = 0;
11008 #endif /* not SIGIO */
11010 if (new_interrupt_input != interrupt_input)
11012 #ifdef POLL_FOR_INPUT
11013 stop_polling ();
11014 #endif
11015 #ifndef DOS_NT
11016 /* this causes startup screen to be restored and messes with the mouse */
11017 reset_all_sys_modes ();
11018 interrupt_input = new_interrupt_input;
11019 init_all_sys_modes ();
11020 #else
11021 interrupt_input = new_interrupt_input;
11022 #endif
11024 #ifdef POLL_FOR_INPUT
11025 poll_suppress_count = 1;
11026 start_polling ();
11027 #endif
11029 return Qnil;
11032 DEFUN ("set-output-flow-control", Fset_output_flow_control, Sset_output_flow_control, 1, 2, 0,
11033 doc: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11034 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11035 C-q in key sequences.
11037 This setting only has an effect on tty terminals and only when
11038 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11040 See also `current-input-mode'. */)
11041 (Lisp_Object flow, Lisp_Object terminal)
11043 struct terminal *t = get_terminal (terminal, 1);
11044 struct tty_display_info *tty;
11045 if (t == NULL || (t->type != output_termcap && t->type != output_msdos_raw))
11046 return Qnil;
11047 tty = t->display_info.tty;
11049 if (tty->flow_control != !NILP (flow))
11051 #ifndef DOS_NT
11052 /* this causes startup screen to be restored and messes with the mouse */
11053 reset_sys_modes (tty);
11054 #endif
11056 tty->flow_control = !NILP (flow);
11058 #ifndef DOS_NT
11059 init_sys_modes (tty);
11060 #endif
11062 return Qnil;
11065 DEFUN ("set-input-meta-mode", Fset_input_meta_mode, Sset_input_meta_mode, 1, 2, 0,
11066 doc: /* Enable or disable 8-bit input on TERMINAL.
11067 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11068 bit as the Meta modifier.
11070 If META is nil, Emacs will ignore the top bit, on the assumption it is
11071 parity.
11073 Otherwise, Emacs will accept and pass through 8-bit input without
11074 specially interpreting the top bit.
11076 This setting only has an effect on tty terminal devices.
11078 Optional parameter TERMINAL specifies the tty terminal device to use.
11079 It may be a terminal object, a frame, or nil for the terminal used by
11080 the currently selected frame.
11082 See also `current-input-mode'. */)
11083 (Lisp_Object meta, Lisp_Object terminal)
11085 struct terminal *t = get_terminal (terminal, 1);
11086 struct tty_display_info *tty;
11087 int new_meta;
11089 if (t == NULL || (t->type != output_termcap && t->type != output_msdos_raw))
11090 return Qnil;
11091 tty = t->display_info.tty;
11093 if (NILP (meta))
11094 new_meta = 0;
11095 else if (EQ (meta, Qt))
11096 new_meta = 1;
11097 else
11098 new_meta = 2;
11100 if (tty->meta_key != new_meta)
11102 #ifndef DOS_NT
11103 /* this causes startup screen to be restored and messes with the mouse */
11104 reset_sys_modes (tty);
11105 #endif
11107 tty->meta_key = new_meta;
11109 #ifndef DOS_NT
11110 init_sys_modes (tty);
11111 #endif
11113 return Qnil;
11116 DEFUN ("set-quit-char", Fset_quit_char, Sset_quit_char, 1, 1, 0,
11117 doc: /* Specify character used for quitting.
11118 QUIT must be an ASCII character.
11120 This function only has an effect on the controlling tty of the Emacs
11121 process.
11123 See also `current-input-mode'. */)
11124 (Lisp_Object quit)
11126 struct terminal *t = get_named_tty ("/dev/tty");
11127 struct tty_display_info *tty;
11128 if (t == NULL || (t->type != output_termcap && t->type != output_msdos_raw))
11129 return Qnil;
11130 tty = t->display_info.tty;
11132 if (NILP (quit) || !INTEGERP (quit) || XINT (quit) < 0 || XINT (quit) > 0400)
11133 error ("QUIT must be an ASCII character");
11135 #ifndef DOS_NT
11136 /* this causes startup screen to be restored and messes with the mouse */
11137 reset_sys_modes (tty);
11138 #endif
11140 /* Don't let this value be out of range. */
11141 quit_char = XINT (quit) & (tty->meta_key == 0 ? 0177 : 0377);
11143 #ifndef DOS_NT
11144 init_sys_modes (tty);
11145 #endif
11147 return Qnil;
11150 DEFUN ("set-input-mode", Fset_input_mode, Sset_input_mode, 3, 4, 0,
11151 doc: /* Set mode of reading keyboard input.
11152 First arg INTERRUPT non-nil means use input interrupts;
11153 nil means use CBREAK mode.
11154 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11155 (no effect except in CBREAK mode).
11156 Third arg META t means accept 8-bit input (for a Meta key).
11157 META nil means ignore the top bit, on the assumption it is parity.
11158 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11159 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11160 See also `current-input-mode'. */)
11161 (Lisp_Object interrupt, Lisp_Object flow, Lisp_Object meta, Lisp_Object quit)
11163 Fset_input_interrupt_mode (interrupt);
11164 Fset_output_flow_control (flow, Qnil);
11165 Fset_input_meta_mode (meta, Qnil);
11166 if (!NILP (quit))
11167 Fset_quit_char (quit);
11168 return Qnil;
11171 DEFUN ("current-input-mode", Fcurrent_input_mode, Scurrent_input_mode, 0, 0, 0,
11172 doc: /* Return information about the way Emacs currently reads keyboard input.
11173 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11174 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11175 nil, Emacs is using CBREAK mode.
11176 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11177 terminal; this does not apply if Emacs uses interrupt-driven input.
11178 META is t if accepting 8-bit input with 8th bit as Meta flag.
11179 META nil means ignoring the top bit, on the assumption it is parity.
11180 META is neither t nor nil if accepting 8-bit input and using
11181 all 8 bits as the character code.
11182 QUIT is the character Emacs currently uses to quit.
11183 The elements of this list correspond to the arguments of
11184 `set-input-mode'. */)
11185 (void)
11187 Lisp_Object val[4];
11188 struct frame *sf = XFRAME (selected_frame);
11190 val[0] = interrupt_input ? Qt : Qnil;
11191 if (FRAME_TERMCAP_P (sf) || FRAME_MSDOS_P (sf))
11193 val[1] = FRAME_TTY (sf)->flow_control ? Qt : Qnil;
11194 val[2] = (FRAME_TTY (sf)->meta_key == 2
11195 ? make_number (0)
11196 : (CURTTY ()->meta_key == 1 ? Qt : Qnil));
11198 else
11200 val[1] = Qnil;
11201 val[2] = Qt;
11203 XSETFASTINT (val[3], quit_char);
11205 return Flist (sizeof (val) / sizeof (val[0]), val);
11208 DEFUN ("posn-at-x-y", Fposn_at_x_y, Sposn_at_x_y, 2, 4, 0,
11209 doc: /* Return position information for pixel coordinates X and Y.
11210 By default, X and Y are relative to text area of the selected window.
11211 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11212 If optional fourth arg WHOLE is non-nil, X is relative to the left
11213 edge of the window.
11215 The return value is similar to a mouse click position:
11216 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11217 IMAGE (DX . DY) (WIDTH . HEIGHT))
11218 The `posn-' functions access elements of such lists. */)
11219 (Lisp_Object x, Lisp_Object y, Lisp_Object frame_or_window, Lisp_Object whole)
11221 CHECK_NATNUM (x);
11222 CHECK_NATNUM (y);
11224 if (NILP (frame_or_window))
11225 frame_or_window = selected_window;
11227 if (WINDOWP (frame_or_window))
11229 struct window *w;
11231 CHECK_LIVE_WINDOW (frame_or_window);
11233 w = XWINDOW (frame_or_window);
11234 XSETINT (x, (XINT (x)
11235 + WINDOW_LEFT_EDGE_X (w)
11236 + (NILP (whole)
11237 ? window_box_left_offset (w, TEXT_AREA)
11238 : 0)));
11239 XSETINT (y, WINDOW_TO_FRAME_PIXEL_Y (w, XINT (y)));
11240 frame_or_window = w->frame;
11243 CHECK_LIVE_FRAME (frame_or_window);
11245 return make_lispy_position (XFRAME (frame_or_window), x, y, 0);
11248 DEFUN ("posn-at-point", Fposn_at_point, Sposn_at_point, 0, 2, 0,
11249 doc: /* Return position information for buffer POS in WINDOW.
11250 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11252 Return nil if position is not visible in window. Otherwise,
11253 the return value is similar to that returned by `event-start' for
11254 a mouse click at the upper left corner of the glyph corresponding
11255 to the given buffer position:
11256 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11257 IMAGE (DX . DY) (WIDTH . HEIGHT))
11258 The `posn-' functions access elements of such lists. */)
11259 (Lisp_Object pos, Lisp_Object window)
11261 Lisp_Object tem;
11263 if (NILP (window))
11264 window = selected_window;
11266 tem = Fpos_visible_in_window_p (pos, window, Qt);
11267 if (!NILP (tem))
11269 Lisp_Object x = XCAR (tem);
11270 Lisp_Object y = XCAR (XCDR (tem));
11272 /* Point invisible due to hscrolling? */
11273 if (XINT (x) < 0)
11274 return Qnil;
11275 tem = Fposn_at_x_y (x, y, window, Qnil);
11278 return tem;
11283 * Set up a new kboard object with reasonable initial values.
11285 void
11286 init_kboard (KBOARD *kb)
11288 KVAR (kb, Voverriding_terminal_local_map) = Qnil;
11289 KVAR (kb, Vlast_command) = Qnil;
11290 KVAR (kb, Vreal_last_command) = Qnil;
11291 KVAR (kb, Vkeyboard_translate_table) = Qnil;
11292 KVAR (kb, Vlast_repeatable_command) = Qnil;
11293 KVAR (kb, Vprefix_arg) = Qnil;
11294 KVAR (kb, Vlast_prefix_arg) = Qnil;
11295 KVAR (kb, kbd_queue) = Qnil;
11296 kb->kbd_queue_has_data = 0;
11297 kb->immediate_echo = 0;
11298 KVAR (kb, echo_string) = Qnil;
11299 kb->echo_after_prompt = -1;
11300 kb->kbd_macro_buffer = 0;
11301 kb->kbd_macro_bufsize = 0;
11302 KVAR (kb, defining_kbd_macro) = Qnil;
11303 KVAR (kb, Vlast_kbd_macro) = Qnil;
11304 kb->reference_count = 0;
11305 KVAR (kb, Vsystem_key_alist) = Qnil;
11306 KVAR (kb, system_key_syms) = Qnil;
11307 KVAR (kb, Vwindow_system) = Qt; /* Unset. */
11308 KVAR (kb, Vinput_decode_map) = Fmake_sparse_keymap (Qnil);
11309 KVAR (kb, Vlocal_function_key_map) = Fmake_sparse_keymap (Qnil);
11310 Fset_keymap_parent (KVAR (kb, Vlocal_function_key_map), Vfunction_key_map);
11311 KVAR (kb, Vdefault_minibuffer_frame) = Qnil;
11315 * Destroy the contents of a kboard object, but not the object itself.
11316 * We use this just before deleting it, or if we're going to initialize
11317 * it a second time.
11319 static void
11320 wipe_kboard (KBOARD *kb)
11322 xfree (kb->kbd_macro_buffer);
11325 /* Free KB and memory referenced from it. */
11327 void
11328 delete_kboard (KBOARD *kb)
11330 KBOARD **kbp;
11332 for (kbp = &all_kboards; *kbp != kb; kbp = &(*kbp)->next_kboard)
11333 if (*kbp == NULL)
11334 abort ();
11335 *kbp = kb->next_kboard;
11337 /* Prevent a dangling reference to KB. */
11338 if (kb == current_kboard
11339 && FRAMEP (selected_frame)
11340 && FRAME_LIVE_P (XFRAME (selected_frame)))
11342 current_kboard = FRAME_KBOARD (XFRAME (selected_frame));
11343 single_kboard = 0;
11344 if (current_kboard == kb)
11345 abort ();
11348 wipe_kboard (kb);
11349 xfree (kb);
11352 void
11353 init_keyboard (void)
11355 /* This is correct before outermost invocation of the editor loop */
11356 command_loop_level = -1;
11357 immediate_quit = 0;
11358 quit_char = Ctl ('g');
11359 Vunread_command_events = Qnil;
11360 unread_command_char = -1;
11361 EMACS_SET_SECS_USECS (timer_idleness_start_time, -1, -1);
11362 total_keys = 0;
11363 recent_keys_index = 0;
11364 kbd_fetch_ptr = kbd_buffer;
11365 kbd_store_ptr = kbd_buffer;
11366 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11367 do_mouse_tracking = Qnil;
11368 #endif
11369 input_pending = 0;
11370 interrupt_input_blocked = 0;
11371 interrupt_input_pending = 0;
11372 #ifdef SYNC_INPUT
11373 pending_signals = 0;
11374 #endif
11376 /* This means that command_loop_1 won't try to select anything the first
11377 time through. */
11378 internal_last_event_frame = Qnil;
11379 Vlast_event_frame = internal_last_event_frame;
11381 current_kboard = initial_kboard;
11382 /* Re-initialize the keyboard again. */
11383 wipe_kboard (current_kboard);
11384 init_kboard (current_kboard);
11385 /* A value of nil for Vwindow_system normally means a tty, but we also use
11386 it for the initial terminal since there is no window system there. */
11387 KVAR (current_kboard, Vwindow_system) = Qnil;
11389 if (!noninteractive)
11391 /* Before multi-tty support, these handlers used to be installed
11392 only if the current session was a tty session. Now an Emacs
11393 session may have multiple display types, so we always handle
11394 SIGINT. There is special code in interrupt_signal to exit
11395 Emacs on SIGINT when there are no termcap frames on the
11396 controlling terminal. */
11397 signal (SIGINT, interrupt_signal);
11398 #ifndef DOS_NT
11399 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11400 SIGQUIT and we can't tell which one it will give us. */
11401 signal (SIGQUIT, interrupt_signal);
11402 #endif /* not DOS_NT */
11404 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11405 #ifdef SIGIO
11406 if (!noninteractive)
11407 signal (SIGIO, input_available_signal);
11408 #endif /* SIGIO */
11410 /* Use interrupt input by default, if it works and noninterrupt input
11411 has deficiencies. */
11413 #ifdef INTERRUPT_INPUT
11414 interrupt_input = 1;
11415 #else
11416 interrupt_input = 0;
11417 #endif
11419 sigfree ();
11420 dribble = 0;
11422 if (keyboard_init_hook)
11423 (*keyboard_init_hook) ();
11425 #ifdef POLL_FOR_INPUT
11426 poll_timer = NULL;
11427 poll_suppress_count = 1;
11428 start_polling ();
11429 #endif
11432 /* This type's only use is in syms_of_keyboard, to initialize the
11433 event header symbols and put properties on them. */
11434 struct event_head {
11435 Lisp_Object *var;
11436 const char *name;
11437 Lisp_Object *kind;
11440 static const struct event_head head_table[] = {
11441 {&Qmouse_movement, "mouse-movement", &Qmouse_movement},
11442 {&Qscroll_bar_movement, "scroll-bar-movement", &Qmouse_movement},
11443 {&Qswitch_frame, "switch-frame", &Qswitch_frame},
11444 {&Qdelete_frame, "delete-frame", &Qdelete_frame},
11445 {&Qiconify_frame, "iconify-frame", &Qiconify_frame},
11446 {&Qmake_frame_visible, "make-frame-visible", &Qmake_frame_visible},
11447 /* `select-window' should be handled just like `switch-frame'
11448 in read_key_sequence. */
11449 {&Qselect_window, "select-window", &Qswitch_frame}
11452 void
11453 syms_of_keyboard (void)
11455 pending_funcalls = Qnil;
11456 staticpro (&pending_funcalls);
11458 Vlispy_mouse_stem = make_pure_c_string ("mouse");
11459 staticpro (&Vlispy_mouse_stem);
11461 /* Tool-bars. */
11462 DEFSYM (QCimage, ":image");
11463 DEFSYM (Qhelp_echo, "help-echo");
11464 DEFSYM (QCrtl, ":rtl");
11466 staticpro (&item_properties);
11467 item_properties = Qnil;
11469 staticpro (&tool_bar_item_properties);
11470 tool_bar_item_properties = Qnil;
11471 staticpro (&tool_bar_items_vector);
11472 tool_bar_items_vector = Qnil;
11474 DEFSYM (Qtimer_event_handler, "timer-event-handler");
11475 DEFSYM (Qdisabled_command_function, "disabled-command-function");
11476 DEFSYM (Qself_insert_command, "self-insert-command");
11477 DEFSYM (Qforward_char, "forward-char");
11478 DEFSYM (Qbackward_char, "backward-char");
11479 DEFSYM (Qdisabled, "disabled");
11480 DEFSYM (Qundefined, "undefined");
11481 DEFSYM (Qpre_command_hook, "pre-command-hook");
11482 DEFSYM (Qpost_command_hook, "post-command-hook");
11483 DEFSYM (Qdeferred_action_function, "deferred-action-function");
11484 DEFSYM (Qdelayed_warnings_hook, "delayed-warnings-hook");
11485 DEFSYM (Qfunction_key, "function-key");
11486 DEFSYM (Qmouse_click, "mouse-click");
11487 DEFSYM (Qdrag_n_drop, "drag-n-drop");
11488 DEFSYM (Qsave_session, "save-session");
11489 DEFSYM (Qconfig_changed_event, "config-changed-event");
11490 DEFSYM (Qmenu_enable, "menu-enable");
11492 #if defined (WINDOWSNT)
11493 DEFSYM (Qlanguage_change, "language-change");
11494 #endif
11496 #ifdef HAVE_DBUS
11497 DEFSYM (Qdbus_event, "dbus-event");
11498 #endif
11500 DEFSYM (QCenable, ":enable");
11501 DEFSYM (QCvisible, ":visible");
11502 DEFSYM (QChelp, ":help");
11503 DEFSYM (QCfilter, ":filter");
11504 DEFSYM (QCbutton, ":button");
11505 DEFSYM (QCkeys, ":keys");
11506 DEFSYM (QCkey_sequence, ":key-sequence");
11507 DEFSYM (QCtoggle, ":toggle");
11508 DEFSYM (QCradio, ":radio");
11509 DEFSYM (QClabel, ":label");
11510 DEFSYM (QCvert_only, ":vert-only");
11512 DEFSYM (Qmode_line, "mode-line");
11513 DEFSYM (Qvertical_line, "vertical-line");
11514 DEFSYM (Qvertical_scroll_bar, "vertical-scroll-bar");
11515 DEFSYM (Qmenu_bar, "menu-bar");
11517 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11518 DEFSYM (Qmouse_fixup_help_message, "mouse-fixup-help-message");
11519 #endif
11521 DEFSYM (Qabove_handle, "above-handle");
11522 DEFSYM (Qhandle, "handle");
11523 DEFSYM (Qbelow_handle, "below-handle");
11524 DEFSYM (Qup, "up");
11525 DEFSYM (Qdown, "down");
11526 DEFSYM (Qtop, "top");
11527 DEFSYM (Qbottom, "bottom");
11528 DEFSYM (Qend_scroll, "end-scroll");
11529 DEFSYM (Qratio, "ratio");
11531 DEFSYM (Qevent_kind, "event-kind");
11532 DEFSYM (Qevent_symbol_elements, "event-symbol-elements");
11533 DEFSYM (Qevent_symbol_element_mask, "event-symbol-element-mask");
11534 DEFSYM (Qmodifier_cache, "modifier-cache");
11536 DEFSYM (Qrecompute_lucid_menubar, "recompute-lucid-menubar");
11537 DEFSYM (Qactivate_menubar_hook, "activate-menubar-hook");
11539 DEFSYM (Qpolling_period, "polling-period");
11541 DEFSYM (Qx_set_selection, "x-set-selection");
11542 DEFSYM (QPRIMARY, "PRIMARY");
11543 DEFSYM (Qhandle_switch_frame, "handle-switch-frame");
11544 DEFSYM (Qhandle_select_window, "handle-select-window");
11546 DEFSYM (Qinput_method_function, "input-method-function");
11547 DEFSYM (Qinput_method_exit_on_first_char, "input-method-exit-on-first-char");
11548 DEFSYM (Qinput_method_use_echo_area, "input-method-use-echo-area");
11550 DEFSYM (Qhelp_form_show, "help-form-show");
11552 Fset (Qinput_method_exit_on_first_char, Qnil);
11553 Fset (Qinput_method_use_echo_area, Qnil);
11555 last_point_position_buffer = Qnil;
11556 last_point_position_window = Qnil;
11559 int i;
11560 int len = sizeof (head_table) / sizeof (head_table[0]);
11562 for (i = 0; i < len; i++)
11564 const struct event_head *p = &head_table[i];
11565 *p->var = intern_c_string (p->name);
11566 staticpro (p->var);
11567 Fput (*p->var, Qevent_kind, *p->kind);
11568 Fput (*p->var, Qevent_symbol_elements, Fcons (*p->var, Qnil));
11572 button_down_location = Fmake_vector (make_number (5), Qnil);
11573 staticpro (&button_down_location);
11574 mouse_syms = Fmake_vector (make_number (5), Qnil);
11575 staticpro (&mouse_syms);
11576 wheel_syms = Fmake_vector (make_number (sizeof (lispy_wheel_names)
11577 / sizeof (lispy_wheel_names[0])),
11578 Qnil);
11579 staticpro (&wheel_syms);
11582 int i;
11583 int len = sizeof (modifier_names) / sizeof (modifier_names[0]);
11585 modifier_symbols = Fmake_vector (make_number (len), Qnil);
11586 for (i = 0; i < len; i++)
11587 if (modifier_names[i])
11588 XVECTOR (modifier_symbols)->contents[i] = intern_c_string (modifier_names[i]);
11589 staticpro (&modifier_symbols);
11592 recent_keys = Fmake_vector (make_number (NUM_RECENT_KEYS), Qnil);
11593 staticpro (&recent_keys);
11595 this_command_keys = Fmake_vector (make_number (40), Qnil);
11596 staticpro (&this_command_keys);
11598 raw_keybuf = Fmake_vector (make_number (30), Qnil);
11599 staticpro (&raw_keybuf);
11601 DEFSYM (Qextended_command_history, "extended-command-history");
11602 Fset (Qextended_command_history, Qnil);
11604 accent_key_syms = Qnil;
11605 staticpro (&accent_key_syms);
11607 func_key_syms = Qnil;
11608 staticpro (&func_key_syms);
11610 drag_n_drop_syms = Qnil;
11611 staticpro (&drag_n_drop_syms);
11613 unread_switch_frame = Qnil;
11614 staticpro (&unread_switch_frame);
11616 internal_last_event_frame = Qnil;
11617 staticpro (&internal_last_event_frame);
11619 read_key_sequence_cmd = Qnil;
11620 staticpro (&read_key_sequence_cmd);
11621 read_key_sequence_remapped = Qnil;
11622 staticpro (&read_key_sequence_remapped);
11624 menu_bar_one_keymap_changed_items = Qnil;
11625 staticpro (&menu_bar_one_keymap_changed_items);
11627 menu_bar_items_vector = Qnil;
11628 staticpro (&menu_bar_items_vector);
11630 help_form_saved_window_configs = Qnil;
11631 staticpro (&help_form_saved_window_configs);
11633 defsubr (&Scurrent_idle_time);
11634 defsubr (&Sevent_symbol_parse_modifiers);
11635 defsubr (&Sevent_convert_list);
11636 defsubr (&Sread_key_sequence);
11637 defsubr (&Sread_key_sequence_vector);
11638 defsubr (&Srecursive_edit);
11639 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11640 defsubr (&Strack_mouse);
11641 #endif
11642 defsubr (&Sinput_pending_p);
11643 defsubr (&Scommand_execute);
11644 defsubr (&Srecent_keys);
11645 defsubr (&Sthis_command_keys);
11646 defsubr (&Sthis_command_keys_vector);
11647 defsubr (&Sthis_single_command_keys);
11648 defsubr (&Sthis_single_command_raw_keys);
11649 defsubr (&Sreset_this_command_lengths);
11650 defsubr (&Sclear_this_command_keys);
11651 defsubr (&Ssuspend_emacs);
11652 defsubr (&Sabort_recursive_edit);
11653 defsubr (&Sexit_recursive_edit);
11654 defsubr (&Srecursion_depth);
11655 defsubr (&Stop_level);
11656 defsubr (&Sdiscard_input);
11657 defsubr (&Sopen_dribble_file);
11658 defsubr (&Sset_input_interrupt_mode);
11659 defsubr (&Sset_output_flow_control);
11660 defsubr (&Sset_input_meta_mode);
11661 defsubr (&Sset_quit_char);
11662 defsubr (&Sset_input_mode);
11663 defsubr (&Scurrent_input_mode);
11664 defsubr (&Sposn_at_point);
11665 defsubr (&Sposn_at_x_y);
11667 DEFVAR_LISP ("last-command-event", last_command_event,
11668 doc: /* Last input event that was part of a command. */);
11670 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event,
11671 doc: /* Last input event in a command, except for mouse menu events.
11672 Mouse menus give back keys that don't look like mouse events;
11673 this variable holds the actual mouse event that led to the menu,
11674 so that you can determine whether the command was run by mouse or not. */);
11676 DEFVAR_LISP ("last-input-event", last_input_event,
11677 doc: /* Last input event. */);
11679 DEFVAR_LISP ("unread-command-events", Vunread_command_events,
11680 doc: /* List of events to be read as the command input.
11681 These events are processed first, before actual keyboard input.
11682 Events read from this list are not normally added to `this-command-keys',
11683 as they will already have been added once as they were read for the first time.
11684 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11685 Vunread_command_events = Qnil;
11687 DEFVAR_INT ("unread-command-char", unread_command_char,
11688 doc: /* If not -1, an object to be read as next command input event. */);
11690 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events,
11691 doc: /* List of events to be processed as input by input methods.
11692 These events are processed before `unread-command-events'
11693 and actual keyboard input, but are not given to `input-method-function'. */);
11694 Vunread_post_input_method_events = Qnil;
11696 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events,
11697 doc: /* List of events to be processed as input by input methods.
11698 These events are processed after `unread-command-events', but
11699 before actual keyboard input.
11700 If there's an active input method, the events are given to
11701 `input-method-function'. */);
11702 Vunread_input_method_events = Qnil;
11704 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char,
11705 doc: /* Meta-prefix character code.
11706 Meta-foo as command input turns into this character followed by foo. */);
11707 XSETINT (meta_prefix_char, 033);
11709 DEFVAR_KBOARD ("last-command", Vlast_command,
11710 doc: /* The last command executed.
11711 Normally a symbol with a function definition, but can be whatever was found
11712 in the keymap, or whatever the variable `this-command' was set to by that
11713 command.
11715 The value `mode-exit' is special; it means that the previous command
11716 read an event that told it to exit, and it did so and unread that event.
11717 In other words, the present command is the event that made the previous
11718 command exit.
11720 The value `kill-region' is special; it means that the previous command
11721 was a kill command.
11723 `last-command' has a separate binding for each terminal device.
11724 See Info node `(elisp)Multiple Terminals'. */);
11726 DEFVAR_KBOARD ("real-last-command", Vreal_last_command,
11727 doc: /* Same as `last-command', but never altered by Lisp code.
11728 Taken from the previous value of `real-this-command'. */);
11730 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command,
11731 doc: /* Last command that may be repeated.
11732 The last command executed that was not bound to an input event.
11733 This is the command `repeat' will try to repeat.
11734 Taken from a previous value of `real-this-command'. */);
11736 DEFVAR_LISP ("this-command", Vthis_command,
11737 doc: /* The command now being executed.
11738 The command can set this variable; whatever is put here
11739 will be in `last-command' during the following command. */);
11740 Vthis_command = Qnil;
11742 DEFVAR_LISP ("real-this-command", Vreal_this_command,
11743 doc: /* This is like `this-command', except that commands should never modify it. */);
11744 Vreal_this_command = Qnil;
11746 DEFVAR_LISP ("this-command-keys-shift-translated",
11747 Vthis_command_keys_shift_translated,
11748 doc: /* Non-nil if the key sequence activating this command was shift-translated.
11749 Shift-translation occurs when there is no binding for the key sequence
11750 as entered, but a binding was found by changing an upper-case letter
11751 to lower-case, or a shifted function key to an unshifted one. */);
11752 Vthis_command_keys_shift_translated = Qnil;
11754 DEFVAR_LISP ("this-original-command", Vthis_original_command,
11755 doc: /* The command bound to the current key sequence before remapping.
11756 It equals `this-command' if the original command was not remapped through
11757 any of the active keymaps. Otherwise, the value of `this-command' is the
11758 result of looking up the original command in the active keymaps. */);
11759 Vthis_original_command = Qnil;
11761 DEFVAR_INT ("auto-save-interval", auto_save_interval,
11762 doc: /* Number of input events between auto-saves.
11763 Zero means disable autosaving due to number of characters typed. */);
11764 auto_save_interval = 300;
11766 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout,
11767 doc: /* Number of seconds idle time before auto-save.
11768 Zero or nil means disable auto-saving due to idleness.
11769 After auto-saving due to this many seconds of idle time,
11770 Emacs also does a garbage collection if that seems to be warranted. */);
11771 XSETFASTINT (Vauto_save_timeout, 30);
11773 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes,
11774 doc: /* Nonzero means echo unfinished commands after this many seconds of pause.
11775 The value may be integer or floating point.
11776 If the value is zero, don't echo at all. */);
11777 Vecho_keystrokes = make_number (1);
11779 DEFVAR_INT ("polling-period", polling_period,
11780 doc: /* Interval between polling for input during Lisp execution.
11781 The reason for polling is to make C-g work to stop a running program.
11782 Polling is needed only when using X windows and SIGIO does not work.
11783 Polling is automatically disabled in all other cases. */);
11784 polling_period = 2;
11786 DEFVAR_LISP ("double-click-time", Vdouble_click_time,
11787 doc: /* Maximum time between mouse clicks to make a double-click.
11788 Measured in milliseconds. The value nil means disable double-click
11789 recognition; t means double-clicks have no time limit and are detected
11790 by position only. */);
11791 Vdouble_click_time = make_number (500);
11793 DEFVAR_INT ("double-click-fuzz", double_click_fuzz,
11794 doc: /* Maximum mouse movement between clicks to make a double-click.
11795 On window-system frames, value is the number of pixels the mouse may have
11796 moved horizontally or vertically between two clicks to make a double-click.
11797 On non window-system frames, value is interpreted in units of 1/8 characters
11798 instead of pixels.
11800 This variable is also the threshold for motion of the mouse
11801 to count as a drag. */);
11802 double_click_fuzz = 3;
11804 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus,
11805 doc: /* Non-nil means inhibit local map menu bar menus. */);
11806 inhibit_local_menu_bar_menus = 0;
11808 DEFVAR_INT ("num-input-keys", num_input_keys,
11809 doc: /* Number of complete key sequences read as input so far.
11810 This includes key sequences read from keyboard macros.
11811 The number is effectively the number of interactive command invocations. */);
11812 num_input_keys = 0;
11814 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events,
11815 doc: /* Number of input events read from the keyboard so far.
11816 This does not include events generated by keyboard macros. */);
11817 num_nonmacro_input_events = 0;
11819 DEFVAR_LISP ("last-event-frame", Vlast_event_frame,
11820 doc: /* The frame in which the most recently read event occurred.
11821 If the last event came from a keyboard macro, this is set to `macro'. */);
11822 Vlast_event_frame = Qnil;
11824 /* This variable is set up in sysdep.c. */
11825 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char,
11826 doc: /* The ERASE character as set by the user with stty. */);
11828 DEFVAR_LISP ("help-char", Vhelp_char,
11829 doc: /* Character to recognize as meaning Help.
11830 When it is read, do `(eval help-form)', and display result if it's a string.
11831 If the value of `help-form' is nil, this char can be read normally. */);
11832 XSETINT (Vhelp_char, Ctl ('H'));
11834 DEFVAR_LISP ("help-event-list", Vhelp_event_list,
11835 doc: /* List of input events to recognize as meaning Help.
11836 These work just like the value of `help-char' (see that). */);
11837 Vhelp_event_list = Qnil;
11839 DEFVAR_LISP ("help-form", Vhelp_form,
11840 doc: /* Form to execute when character `help-char' is read.
11841 If the form returns a string, that string is displayed.
11842 If `help-form' is nil, the help char is not recognized. */);
11843 Vhelp_form = Qnil;
11845 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command,
11846 doc: /* Command to run when `help-char' character follows a prefix key.
11847 This command is used only when there is no actual binding
11848 for that character after that prefix key. */);
11849 Vprefix_help_command = Qnil;
11851 DEFVAR_LISP ("top-level", Vtop_level,
11852 doc: /* Form to evaluate when Emacs starts up.
11853 Useful to set before you dump a modified Emacs. */);
11854 Vtop_level = Qnil;
11856 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table,
11857 doc: /* Translate table for local keyboard input, or nil.
11858 If non-nil, the value should be a char-table. Each character read
11859 from the keyboard is looked up in this char-table. If the value found
11860 there is non-nil, then it is used instead of the actual input character.
11862 The value can also be a string or vector, but this is considered obsolete.
11863 If it is a string or vector of length N, character codes N and up are left
11864 untranslated. In a vector, an element which is nil means "no translation".
11866 This is applied to the characters supplied to input methods, not their
11867 output. See also `translation-table-for-input'.
11869 This variable has a separate binding for each terminal.
11870 See Info node `(elisp)Multiple Terminals'. */);
11872 DEFVAR_BOOL ("cannot-suspend", cannot_suspend,
11873 doc: /* Non-nil means to always spawn a subshell instead of suspending.
11874 \(Even if the operating system has support for stopping a process.\) */);
11875 cannot_suspend = 0;
11877 DEFVAR_BOOL ("menu-prompting", menu_prompting,
11878 doc: /* Non-nil means prompt with menus when appropriate.
11879 This is done when reading from a keymap that has a prompt string,
11880 for elements that have prompt strings.
11881 The menu is displayed on the screen
11882 if X menus were enabled at configuration
11883 time and the previous event was a mouse click prefix key.
11884 Otherwise, menu prompting uses the echo area. */);
11885 menu_prompting = 1;
11887 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char,
11888 doc: /* Character to see next line of menu prompt.
11889 Type this character while in a menu prompt to rotate around the lines of it. */);
11890 XSETINT (menu_prompt_more_char, ' ');
11892 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers,
11893 doc: /* A mask of additional modifier keys to use with every keyboard character.
11894 Emacs applies the modifiers of the character stored here to each keyboard
11895 character it reads. For example, after evaluating the expression
11896 (setq extra-keyboard-modifiers ?\\C-x)
11897 all input characters will have the control modifier applied to them.
11899 Note that the character ?\\C-@, equivalent to the integer zero, does
11900 not count as a control character; rather, it counts as a character
11901 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11902 cancels any modification. */);
11903 extra_keyboard_modifiers = 0;
11905 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark,
11906 doc: /* If an editing command sets this to t, deactivate the mark afterward.
11907 The command loop sets this to nil before each command,
11908 and tests the value when the command returns.
11909 Buffer modification stores t in this variable. */);
11910 Vdeactivate_mark = Qnil;
11911 DEFSYM (Qdeactivate_mark, "deactivate-mark");
11913 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook,
11914 doc: /* Normal hook run before each command is executed.
11915 If an unhandled error happens in running this hook,
11916 the function in which the error occurred is unconditionally removed, since
11917 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11918 Vpre_command_hook = Qnil;
11920 DEFVAR_LISP ("post-command-hook", Vpost_command_hook,
11921 doc: /* Normal hook run after each command is executed.
11922 If an unhandled error happens in running this hook,
11923 the function in which the error occurred is unconditionally removed, since
11924 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11925 Vpost_command_hook = Qnil;
11927 #if 0
11928 DEFVAR_LISP ("echo-area-clear-hook", ...,
11929 doc: /* Normal hook run when clearing the echo area. */);
11930 #endif
11931 DEFSYM (Qecho_area_clear_hook, "echo-area-clear-hook");
11932 Fset (Qecho_area_clear_hook, Qnil);
11934 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag,
11935 doc: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11936 Vlucid_menu_bar_dirty_flag = Qnil;
11938 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items,
11939 doc: /* List of menu bar items to move to the end of the menu bar.
11940 The elements of the list are event types that may have menu bar bindings. */);
11941 Vmenu_bar_final_items = Qnil;
11943 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression,
11944 doc: /* Expression evaluating to the image spec for a tool-bar separator.
11945 This is used internally by graphical displays that do not render
11946 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11947 Vtool_bar_separator_image_expression = Qnil;
11949 DEFVAR_KBOARD ("overriding-terminal-local-map",
11950 Voverriding_terminal_local_map,
11951 doc: /* Per-terminal keymap that overrides all other local keymaps.
11952 If this variable is non-nil, it is used as a keymap instead of the
11953 buffer's local map, and the minor mode keymaps and text property keymaps.
11954 It also replaces `overriding-local-map'.
11956 This variable is intended to let commands such as `universal-argument'
11957 set up a different keymap for reading the next command.
11959 `overriding-terminal-local-map' has a separate binding for each
11960 terminal device.
11961 See Info node `(elisp)Multiple Terminals'. */);
11963 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map,
11964 doc: /* Keymap that overrides all other local keymaps.
11965 If this variable is non-nil, it is used as a keymap--replacing the
11966 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11967 Voverriding_local_map = Qnil;
11969 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag,
11970 doc: /* Non-nil means `overriding-local-map' applies to the menu bar.
11971 Otherwise, the menu bar continues to reflect the buffer's local map
11972 and the minor mode maps regardless of `overriding-local-map'. */);
11973 Voverriding_local_map_menu_flag = Qnil;
11975 DEFVAR_LISP ("special-event-map", Vspecial_event_map,
11976 doc: /* Keymap defining bindings for special events to execute at low level. */);
11977 Vspecial_event_map = Fcons (intern_c_string ("keymap"), Qnil);
11979 DEFVAR_LISP ("track-mouse", do_mouse_tracking,
11980 doc: /* Non-nil means generate motion events for mouse motion. */);
11982 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist,
11983 doc: /* Alist of system-specific X windows key symbols.
11984 Each element should have the form (N . SYMBOL) where N is the
11985 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11986 and SYMBOL is its name.
11988 `system-key-alist' has a separate binding for each terminal device.
11989 See Info node `(elisp)Multiple Terminals'. */);
11991 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map,
11992 doc: /* Keymap that translates key sequences to key sequences during input.
11993 This is used mainly for mapping key sequences into some preferred
11994 key events (symbols).
11996 The `read-key-sequence' function replaces any subsequence bound by
11997 `local-function-key-map' with its binding. More precisely, when the
11998 active keymaps have no binding for the current key sequence but
11999 `local-function-key-map' binds a suffix of the sequence to a vector or
12000 string, `read-key-sequence' replaces the matching suffix with its
12001 binding, and continues with the new sequence.
12003 If the binding is a function, it is called with one argument (the prompt)
12004 and its return value (a key sequence) is used.
12006 The events that come from bindings in `local-function-key-map' are not
12007 themselves looked up in `local-function-key-map'.
12009 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12010 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12011 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12012 typing `ESC O P x' would return [f1 x].
12014 `local-function-key-map' has a separate binding for each terminal
12015 device. See Info node `(elisp)Multiple Terminals'. If you need to
12016 define a binding on all terminals, change `function-key-map'
12017 instead. Initially, `local-function-key-map' is an empty keymap that
12018 has `function-key-map' as its parent on all terminal devices. */);
12020 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map,
12021 doc: /* Keymap that decodes input escape sequences.
12022 This is used mainly for mapping ASCII function key sequences into
12023 real Emacs function key events (symbols).
12025 The `read-key-sequence' function replaces any subsequence bound by
12026 `input-decode-map' with its binding. Contrary to `function-key-map',
12027 this map applies its rebinding regardless of the presence of an ordinary
12028 binding. So it is more like `key-translation-map' except that it applies
12029 before `function-key-map' rather than after.
12031 If the binding is a function, it is called with one argument (the prompt)
12032 and its return value (a key sequence) is used.
12034 The events that come from bindings in `input-decode-map' are not
12035 themselves looked up in `input-decode-map'.
12037 This variable is keyboard-local. */);
12039 DEFVAR_LISP ("function-key-map", Vfunction_key_map,
12040 doc: /* The parent keymap of all `local-function-key-map' instances.
12041 Function key definitions that apply to all terminal devices should go
12042 here. If a mapping is defined in both the current
12043 `local-function-key-map' binding and this variable, then the local
12044 definition will take precedence. */);
12045 Vfunction_key_map = Fmake_sparse_keymap (Qnil);
12047 DEFVAR_LISP ("key-translation-map", Vkey_translation_map,
12048 doc: /* Keymap of key translations that can override keymaps.
12049 This keymap works like `function-key-map', but comes after that,
12050 and its non-prefix bindings override ordinary bindings.
12051 Another difference is that it is global rather than keyboard-local. */);
12052 Vkey_translation_map = Fmake_sparse_keymap (Qnil);
12054 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list,
12055 doc: /* List of deferred actions to be performed at a later time.
12056 The precise format isn't relevant here; we just check whether it is nil. */);
12057 Vdeferred_action_list = Qnil;
12059 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function,
12060 doc: /* Function to call to handle deferred actions, after each command.
12061 This function is called with no arguments after each command
12062 whenever `deferred-action-list' is non-nil. */);
12063 Vdeferred_action_function = Qnil;
12065 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list,
12066 doc: /* List of warnings to be displayed after this command.
12067 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12068 as per the args of `display-warning' (which see).
12069 If this variable is non-nil, `delayed-warnings-hook' will be run
12070 immediately after running `post-command-hook'. */);
12071 Vdelayed_warnings_list = Qnil;
12073 DEFVAR_LISP ("timer-list", Vtimer_list,
12074 doc: /* List of active absolute time timers in order of increasing time. */);
12075 Vtimer_list = Qnil;
12077 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list,
12078 doc: /* List of active idle-time timers in order of increasing time. */);
12079 Vtimer_idle_list = Qnil;
12081 DEFVAR_LISP ("input-method-function", Vinput_method_function,
12082 doc: /* If non-nil, the function that implements the current input method.
12083 It's called with one argument, a printing character that was just read.
12084 \(That means a character with code 040...0176.)
12085 Typically this function uses `read-event' to read additional events.
12086 When it does so, it should first bind `input-method-function' to nil
12087 so it will not be called recursively.
12089 The function should return a list of zero or more events
12090 to be used as input. If it wants to put back some events
12091 to be reconsidered, separately, by the input method,
12092 it can add them to the beginning of `unread-command-events'.
12094 The input method function can find in `input-method-previous-message'
12095 the previous echo area message.
12097 The input method function should refer to the variables
12098 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12099 for guidance on what to do. */);
12100 Vinput_method_function = Qnil;
12102 DEFVAR_LISP ("input-method-previous-message",
12103 Vinput_method_previous_message,
12104 doc: /* When `input-method-function' is called, hold the previous echo area message.
12105 This variable exists because `read-event' clears the echo area
12106 before running the input method. It is nil if there was no message. */);
12107 Vinput_method_previous_message = Qnil;
12109 DEFVAR_LISP ("show-help-function", Vshow_help_function,
12110 doc: /* If non-nil, the function that implements the display of help.
12111 It's called with one argument, the help string to display. */);
12112 Vshow_help_function = Qnil;
12114 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment,
12115 doc: /* If non-nil, suppress point adjustment after executing a command.
12117 After a command is executed, if point is moved into a region that has
12118 special properties (e.g. composition, display), we adjust point to
12119 the boundary of the region. But, when a command sets this variable to
12120 non-nil, we suppress the point adjustment.
12122 This variable is set to nil before reading a command, and is checked
12123 just after executing the command. */);
12124 Vdisable_point_adjustment = Qnil;
12126 DEFVAR_LISP ("global-disable-point-adjustment",
12127 Vglobal_disable_point_adjustment,
12128 doc: /* If non-nil, always suppress point adjustment.
12130 The default value is nil, in which case, point adjustment are
12131 suppressed only after special commands that set
12132 `disable-point-adjustment' (which see) to non-nil. */);
12133 Vglobal_disable_point_adjustment = Qnil;
12135 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout,
12136 doc: /* How long to display an echo-area message when the minibuffer is active.
12137 If the value is not a number, such messages don't time out. */);
12138 Vminibuffer_message_timeout = make_number (2);
12140 DEFVAR_LISP ("throw-on-input", Vthrow_on_input,
12141 doc: /* If non-nil, any keyboard input throws to this symbol.
12142 The value of that variable is passed to `quit-flag' and later causes a
12143 peculiar kind of quitting. */);
12144 Vthrow_on_input = Qnil;
12146 DEFVAR_LISP ("command-error-function", Vcommand_error_function,
12147 doc: /* If non-nil, function to output error messages.
12148 The arguments are the error data, a list of the form
12149 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12150 such as just as `condition-case' would bind its variable to,
12151 the context (a string which normally goes at the start of the message),
12152 and the Lisp function within which the error was signaled. */);
12153 Vcommand_error_function = Qnil;
12155 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12156 Venable_disabled_menus_and_buttons,
12157 doc: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12159 Help functions bind this to allow help on disabled menu items
12160 and tool-bar buttons. */);
12161 Venable_disabled_menus_and_buttons = Qnil;
12163 DEFVAR_LISP ("select-active-regions",
12164 Vselect_active_regions,
12165 doc: /* If non-nil, an active region automatically sets the primary selection.
12166 If the value is `only', only temporarily active regions (usually made
12167 by mouse-dragging or shift-selection) set the window selection.
12169 This takes effect only when Transient Mark mode is enabled. */);
12170 Vselect_active_regions = Qt;
12172 DEFVAR_LISP ("saved-region-selection",
12173 Vsaved_region_selection,
12174 doc: /* Contents of active region prior to buffer modification.
12175 If `select-active-regions' is non-nil, Emacs sets this to the
12176 text in the region before modifying the buffer. The next
12177 `deactivate-mark' call uses this to set the window selection. */);
12178 Vsaved_region_selection = Qnil;
12180 DEFVAR_LISP ("selection-inhibit-update-commands",
12181 Vselection_inhibit_update_commands,
12182 doc: /* List of commands which should not update the selection.
12183 Normally, if `select-active-regions' is non-nil and the mark remains
12184 active after a command (i.e. the mark was not deactivated), the Emacs
12185 command loop sets the selection to the text in the region. However,
12186 if the command is in this list, the selection is not updated. */);
12187 Vselection_inhibit_update_commands
12188 = list2 (Qhandle_switch_frame, Qhandle_select_window);
12190 DEFVAR_LISP ("debug-on-event",
12191 Vdebug_on_event,
12192 doc: /* Enter debugger on this event. When Emacs
12193 receives the special event specified by this variable, it will try to
12194 break into the debugger as soon as possible instead of processing the
12195 event normally through `special-event-map'.
12197 Currently, the only supported values for this
12198 variable are `sigusr1' and `sigusr2'. */);
12199 Vdebug_on_event = intern_c_string ("sigusr2");
12201 /* Create the initial keyboard. */
12202 initial_kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
12203 init_kboard (initial_kboard);
12204 /* Vwindow_system is left at t for now. */
12205 initial_kboard->next_kboard = all_kboards;
12206 all_kboards = initial_kboard;
12209 void
12210 keys_of_keyboard (void)
12212 initial_define_key (global_map, Ctl ('Z'), "suspend-emacs");
12213 initial_define_key (control_x_map, Ctl ('Z'), "suspend-emacs");
12214 initial_define_key (meta_map, Ctl ('C'), "exit-recursive-edit");
12215 initial_define_key (global_map, Ctl (']'), "abort-recursive-edit");
12216 initial_define_key (meta_map, 'x', "execute-extended-command");
12218 initial_define_lispy_key (Vspecial_event_map, "delete-frame",
12219 "handle-delete-frame");
12220 initial_define_lispy_key (Vspecial_event_map, "ns-put-working-text",
12221 "ns-put-working-text");
12222 initial_define_lispy_key (Vspecial_event_map, "ns-unput-working-text",
12223 "ns-unput-working-text");
12224 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12225 current-prefix-arg, as is done in `handle-switch-frame'.
12226 But `handle-switch-frame is not run from the special-map.
12227 Commands from that map are run in a special way that automatically
12228 preserves the prefix-arg. Restoring the prefix arg here is not just
12229 redundant but harmful:
12230 - C-u C-x v =
12231 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12232 - after the first prompt, the exit-minibuffer-hook is run which may
12233 iconify a frame and thus push a `iconify-frame' event.
12234 - after running exit-minibuffer-hook, current-prefix-arg is
12235 restored to the non-nil value it had before the prompt.
12236 - we enter the second prompt.
12237 current-prefix-arg is non-nil, prefix-arg is nil.
12238 - before running the first real event, we run the special iconify-frame
12239 event, but we pass the `special' arg to execute-command so
12240 current-prefix-arg and prefix-arg are left untouched.
12241 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12242 - the next key event will have a spuriously non-nil current-prefix-arg. */
12243 initial_define_lispy_key (Vspecial_event_map, "iconify-frame",
12244 "ignore");
12245 initial_define_lispy_key (Vspecial_event_map, "make-frame-visible",
12246 "ignore");
12247 /* Handling it at such a low-level causes read_key_sequence to get
12248 * confused because it doesn't realize that the current_buffer was
12249 * changed by read_char.
12251 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12252 * "handle-select-window"); */
12253 initial_define_lispy_key (Vspecial_event_map, "save-session",
12254 "handle-save-session");
12256 #ifdef HAVE_DBUS
12257 /* Define a special event which is raised for dbus callback
12258 functions. */
12259 initial_define_lispy_key (Vspecial_event_map, "dbus-event",
12260 "dbus-handle-event");
12261 #endif
12263 initial_define_lispy_key (Vspecial_event_map, "config-changed-event",
12264 "ignore");
12267 /* Mark the pointers in the kboard objects.
12268 Called by Fgarbage_collect. */
12269 void
12270 mark_kboards (void)
12272 KBOARD *kb;
12273 Lisp_Object *p;
12274 for (kb = all_kboards; kb; kb = kb->next_kboard)
12276 if (kb->kbd_macro_buffer)
12277 for (p = kb->kbd_macro_buffer; p < kb->kbd_macro_ptr; p++)
12278 mark_object (*p);
12279 mark_object (KVAR (kb, Voverriding_terminal_local_map));
12280 mark_object (KVAR (kb, Vlast_command));
12281 mark_object (KVAR (kb, Vreal_last_command));
12282 mark_object (KVAR (kb, Vkeyboard_translate_table));
12283 mark_object (KVAR (kb, Vlast_repeatable_command));
12284 mark_object (KVAR (kb, Vprefix_arg));
12285 mark_object (KVAR (kb, Vlast_prefix_arg));
12286 mark_object (KVAR (kb, kbd_queue));
12287 mark_object (KVAR (kb, defining_kbd_macro));
12288 mark_object (KVAR (kb, Vlast_kbd_macro));
12289 mark_object (KVAR (kb, Vsystem_key_alist));
12290 mark_object (KVAR (kb, system_key_syms));
12291 mark_object (KVAR (kb, Vwindow_system));
12292 mark_object (KVAR (kb, Vinput_decode_map));
12293 mark_object (KVAR (kb, Vlocal_function_key_map));
12294 mark_object (KVAR (kb, Vdefault_minibuffer_frame));
12295 mark_object (KVAR (kb, echo_string));
12298 struct input_event *event;
12299 for (event = kbd_fetch_ptr; event != kbd_store_ptr; event++)
12301 if (event == kbd_buffer + KBD_BUFFER_SIZE)
12302 event = kbd_buffer;
12303 if (event->kind != SELECTION_REQUEST_EVENT
12304 && event->kind != SELECTION_CLEAR_EVENT)
12306 mark_object (event->x);
12307 mark_object (event->y);
12309 mark_object (event->frame_or_window);
12310 mark_object (event->arg);