Add Support for x86-64.
[emacs.git] / src / keyboard.c
blobffc868408658e795380e297df10d5555756f170e
1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95,96,97,99, 2000, 2001
3 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 2, or (at your option)
10 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; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 #include <config.h>
23 #include <signal.h>
24 #include <stdio.h>
25 #include "termchar.h"
26 #include "termopts.h"
27 #include "lisp.h"
28 #include "termhooks.h"
29 #include "macros.h"
30 #include "keyboard.h"
31 #include "frame.h"
32 #include "window.h"
33 #include "commands.h"
34 #include "buffer.h"
35 #include "charset.h"
36 #include "disptab.h"
37 #include "dispextern.h"
38 #include "syntax.h"
39 #include "intervals.h"
40 #include "keymap.h"
41 #include "blockinput.h"
42 #include "puresize.h"
43 #include "systime.h"
44 #include "atimer.h"
45 #include <setjmp.h>
46 #include <errno.h>
48 #ifdef MSDOS
49 #include "msdos.h"
50 #include <time.h>
51 #else /* not MSDOS */
52 #ifndef VMS
53 #include <sys/ioctl.h>
54 #endif
55 #endif /* not MSDOS */
57 #include "syssignal.h"
58 #include "systty.h"
60 #include <sys/types.h>
61 #ifdef HAVE_UNISTD_H
62 #include <unistd.h>
63 #endif
65 /* This is to get the definitions of the XK_ symbols. */
66 #ifdef HAVE_X_WINDOWS
67 #include "xterm.h"
68 #endif
70 #ifdef HAVE_NTGUI
71 #include "w32term.h"
72 #endif /* HAVE_NTGUI */
74 #ifdef MAC_OS
75 #include "macterm.h"
76 #endif
78 #ifndef USE_CRT_DLL
79 extern int errno;
80 #endif
82 /* Variables for blockinput.h: */
84 /* Non-zero if interrupt input is blocked right now. */
85 int interrupt_input_blocked;
87 /* Nonzero means an input interrupt has arrived
88 during the current critical section. */
89 int interrupt_input_pending;
92 /* File descriptor to use for input. */
93 extern int input_fd;
95 #ifdef HAVE_WINDOW_SYSTEM
96 /* Make all keyboard buffers much bigger when using X windows. */
97 #ifdef MAC_OS8
98 /* But not too big (local data > 32K error) if on Mac OS Classic. */
99 #define KBD_BUFFER_SIZE 512
100 #else
101 #define KBD_BUFFER_SIZE 4096
102 #endif
103 #else /* No X-windows, character input */
104 #define KBD_BUFFER_SIZE 4096
105 #endif /* No X-windows */
107 #define abs(x) ((x) >= 0 ? (x) : -(x))
109 /* Following definition copied from eval.c */
111 struct backtrace
113 struct backtrace *next;
114 Lisp_Object *function;
115 Lisp_Object *args; /* Points to vector of args. */
116 int nargs; /* length of vector. If nargs is UNEVALLED,
117 args points to slot holding list of
118 unevalled args */
119 char evalargs;
122 #ifdef MULTI_KBOARD
123 KBOARD *initial_kboard;
124 KBOARD *current_kboard;
125 KBOARD *all_kboards;
126 int single_kboard;
127 #else
128 KBOARD the_only_kboard;
129 #endif
131 /* Non-nil disable property on a command means
132 do not execute it; call disabled-command-hook's value instead. */
133 Lisp_Object Qdisabled, Qdisabled_command_hook;
135 #define NUM_RECENT_KEYS (100)
136 int recent_keys_index; /* Index for storing next element into recent_keys */
137 int total_keys; /* Total number of elements stored into recent_keys */
138 Lisp_Object recent_keys; /* A vector, holding the last 100 keystrokes */
140 /* Vector holding the key sequence that invoked the current command.
141 It is reused for each command, and it may be longer than the current
142 sequence; this_command_key_count indicates how many elements
143 actually mean something.
144 It's easier to staticpro a single Lisp_Object than an array. */
145 Lisp_Object this_command_keys;
146 int this_command_key_count;
148 /* This vector is used as a buffer to record the events that were actually read
149 by read_key_sequence. */
150 Lisp_Object raw_keybuf;
151 int raw_keybuf_count;
153 #define GROW_RAW_KEYBUF \
154 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
156 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
157 Lisp_Object new; \
158 new = Fmake_vector (make_number (newsize), Qnil); \
159 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
160 raw_keybuf_count * sizeof (Lisp_Object)); \
161 raw_keybuf = new; \
164 /* Number of elements of this_command_keys
165 that precede this key sequence. */
166 int this_single_command_key_start;
168 /* Record values of this_command_key_count and echo_length ()
169 before this command was read. */
170 static int before_command_key_count;
171 static int before_command_echo_length;
172 /* Values of before_command_key_count and before_command_echo_length
173 saved by reset-this-command-lengths. */
174 static int before_command_key_count_1;
175 static int before_command_echo_length_1;
176 /* Flag set by reset-this-command-lengths,
177 saying to reset the lengths when add_command_key is called. */
178 static int before_command_restore_flag;
180 extern int minbuf_level;
182 extern int message_enable_multibyte;
184 extern struct backtrace *backtrace_list;
186 /* If non-nil, the function that implements the display of help.
187 It's called with one argument, the help string to display. */
189 Lisp_Object Vshow_help_function;
191 /* If a string, the message displayed before displaying a help-echo
192 in the echo area. */
194 Lisp_Object Vpre_help_message;
196 /* Nonzero means do menu prompting. */
198 static int menu_prompting;
200 /* Character to see next line of menu prompt. */
202 static Lisp_Object menu_prompt_more_char;
204 /* For longjmp to where kbd input is being done. */
206 static jmp_buf getcjmp;
208 /* True while doing kbd input. */
209 int waiting_for_input;
211 /* True while displaying for echoing. Delays C-g throwing. */
213 int echoing;
215 /* Non-null means we can start echoing at the next input pause even
216 though there is something in the echo area. */
218 static struct kboard *ok_to_echo_at_next_pause;
220 /* The kboard last echoing, or null for none. Reset to 0 in
221 cancel_echoing. If non-null, and a current echo area message
222 exists, and echo_message_buffer is eq to the current message
223 buffer, we know that the message comes from echo_kboard. */
225 struct kboard *echo_kboard;
227 /* The buffer used for echoing. Set in echo_now, reset in
228 cancel_echoing. */
230 Lisp_Object echo_message_buffer;
232 /* Nonzero means disregard local maps for the menu bar. */
233 static int inhibit_local_menu_bar_menus;
235 /* Nonzero means C-g should cause immediate error-signal. */
236 int immediate_quit;
238 /* The user's ERASE setting. */
239 Lisp_Object Vtty_erase_char;
241 /* Character to recognize as the help char. */
242 Lisp_Object Vhelp_char;
244 /* List of other event types to recognize as meaning "help". */
245 Lisp_Object Vhelp_event_list;
247 /* Form to execute when help char is typed. */
248 Lisp_Object Vhelp_form;
250 /* Command to run when the help character follows a prefix key. */
251 Lisp_Object Vprefix_help_command;
253 /* List of items that should move to the end of the menu bar. */
254 Lisp_Object Vmenu_bar_final_items;
256 /* Non-nil means show the equivalent key-binding for
257 any M-x command that has one.
258 The value can be a length of time to show the message for.
259 If the value is non-nil and not a number, we wait 2 seconds. */
260 Lisp_Object Vsuggest_key_bindings;
262 /* How long to display an echo-area message when the minibuffer is active.
263 If the value is not a number, such messages don't time out. */
264 Lisp_Object Vminibuffer_message_timeout;
266 /* Character that causes a quit. Normally C-g.
268 If we are running on an ordinary terminal, this must be an ordinary
269 ASCII char, since we want to make it our interrupt character.
271 If we are not running on an ordinary terminal, it still needs to be
272 an ordinary ASCII char. This character needs to be recognized in
273 the input interrupt handler. At this point, the keystroke is
274 represented as a struct input_event, while the desired quit
275 character is specified as a lispy event. The mapping from struct
276 input_events to lispy events cannot run in an interrupt handler,
277 and the reverse mapping is difficult for anything but ASCII
278 keystrokes.
280 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
281 ASCII character. */
282 int quit_char;
284 extern Lisp_Object current_global_map;
285 extern int minibuf_level;
287 /* If non-nil, this is a map that overrides all other local maps. */
288 Lisp_Object Voverriding_local_map;
290 /* If non-nil, Voverriding_local_map applies to the menu bar. */
291 Lisp_Object Voverriding_local_map_menu_flag;
293 /* Keymap that defines special misc events that should
294 be processed immediately at a low level. */
295 Lisp_Object Vspecial_event_map;
297 /* Current depth in recursive edits. */
298 int command_loop_level;
300 /* Total number of times command_loop has read a key sequence. */
301 EMACS_INT num_input_keys;
303 /* Last input character read as a command. */
304 Lisp_Object last_command_char;
306 /* Last input character read as a command, not counting menus
307 reached by the mouse. */
308 Lisp_Object last_nonmenu_event;
310 /* Last input character read for any purpose. */
311 Lisp_Object last_input_char;
313 /* If not Qnil, a list of objects to be read as subsequent command input. */
314 Lisp_Object Vunread_command_events;
316 /* If not Qnil, a list of objects to be read as subsequent command input
317 including input method processing. */
318 Lisp_Object Vunread_input_method_events;
320 /* If not Qnil, a list of objects to be read as subsequent command input
321 but NOT including input method processing. */
322 Lisp_Object Vunread_post_input_method_events;
324 /* If not -1, an event to be read as subsequent command input. */
325 EMACS_INT unread_command_char;
327 /* If not Qnil, this is a switch-frame event which we decided to put
328 off until the end of a key sequence. This should be read as the
329 next command input, after any unread_command_events.
331 read_key_sequence uses this to delay switch-frame events until the
332 end of the key sequence; Fread_char uses it to put off switch-frame
333 events until a non-ASCII event is acceptable as input. */
334 Lisp_Object unread_switch_frame;
336 /* A mask of extra modifier bits to put into every keyboard char. */
337 EMACS_INT extra_keyboard_modifiers;
339 /* Char to use as prefix when a meta character is typed in.
340 This is bound on entry to minibuffer in case ESC is changed there. */
342 Lisp_Object meta_prefix_char;
344 /* Last size recorded for a current buffer which is not a minibuffer. */
345 static int last_non_minibuf_size;
347 /* Number of idle seconds before an auto-save and garbage collection. */
348 static Lisp_Object Vauto_save_timeout;
350 /* Total number of times read_char has returned. */
351 int num_input_events;
353 /* Total number of times read_char has returned, outside of macros. */
354 EMACS_INT num_nonmacro_input_events;
356 /* Auto-save automatically when this many characters have been typed
357 since the last time. */
359 static EMACS_INT auto_save_interval;
361 /* Value of num_nonmacro_input_events as of last auto save. */
363 int last_auto_save;
365 /* The command being executed by the command loop.
366 Commands may set this, and the value set will be copied into
367 current_kboard->Vlast_command instead of the actual command. */
368 Lisp_Object Vthis_command;
370 /* This is like Vthis_command, except that commands never set it. */
371 Lisp_Object real_this_command;
373 /* If the lookup of the command returns a binding, the original
374 command is stored in this-original-command. It is nil otherwise. */
375 Lisp_Object Vthis_original_command;
377 /* The value of point when the last command was executed. */
378 int last_point_position;
380 /* The buffer that was current when the last command was started. */
381 Lisp_Object last_point_position_buffer;
383 /* The frame in which the last input event occurred, or Qmacro if the
384 last event came from a macro. We use this to determine when to
385 generate switch-frame events. This may be cleared by functions
386 like Fselect_frame, to make sure that a switch-frame event is
387 generated by the next character. */
388 Lisp_Object internal_last_event_frame;
390 /* A user-visible version of the above, intended to allow users to
391 figure out where the last event came from, if the event doesn't
392 carry that information itself (i.e. if it was a character). */
393 Lisp_Object Vlast_event_frame;
395 /* The timestamp of the last input event we received from the X server.
396 X Windows wants this for selection ownership. */
397 unsigned long last_event_timestamp;
399 Lisp_Object Qself_insert_command;
400 Lisp_Object Qforward_char;
401 Lisp_Object Qbackward_char;
402 Lisp_Object Qundefined;
403 Lisp_Object Qtimer_event_handler;
405 /* read_key_sequence stores here the command definition of the
406 key sequence that it reads. */
407 Lisp_Object read_key_sequence_cmd;
409 /* Echo unfinished commands after this many seconds of pause. */
410 Lisp_Object Vecho_keystrokes;
412 /* Form to evaluate (if non-nil) when Emacs is started. */
413 Lisp_Object Vtop_level;
415 /* User-supplied string to translate input characters through. */
416 Lisp_Object Vkeyboard_translate_table;
418 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
419 extern Lisp_Object Vfunction_key_map;
421 /* Another keymap that maps key sequences into key sequences.
422 This one takes precedence over ordinary definitions. */
423 extern Lisp_Object Vkey_translation_map;
425 /* If non-nil, this implements the current input method. */
426 Lisp_Object Vinput_method_function;
427 Lisp_Object Qinput_method_function;
429 /* When we call Vinput_method_function,
430 this holds the echo area message that was just erased. */
431 Lisp_Object Vinput_method_previous_message;
433 /* Non-nil means deactivate the mark at end of this command. */
434 Lisp_Object Vdeactivate_mark;
436 /* Menu bar specified in Lucid Emacs fashion. */
438 Lisp_Object Vlucid_menu_bar_dirty_flag;
439 Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;
441 Lisp_Object Qecho_area_clear_hook;
443 /* Hooks to run before and after each command. */
444 Lisp_Object Qpre_command_hook, Vpre_command_hook;
445 Lisp_Object Qpost_command_hook, Vpost_command_hook;
446 Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
447 /* Hook run after a command if there's no more input soon. */
448 Lisp_Object Qpost_command_idle_hook, Vpost_command_idle_hook;
450 /* Delay time in microseconds before running post-command-idle-hook. */
451 EMACS_INT post_command_idle_delay;
453 /* List of deferred actions to be performed at a later time.
454 The precise format isn't relevant here; we just check whether it is nil. */
455 Lisp_Object Vdeferred_action_list;
457 /* Function to call to handle deferred actions, when there are any. */
458 Lisp_Object Vdeferred_action_function;
459 Lisp_Object Qdeferred_action_function;
461 Lisp_Object Qinput_method_exit_on_first_char;
462 Lisp_Object Qinput_method_use_echo_area;
464 /* File in which we write all commands we read. */
465 FILE *dribble;
467 /* Nonzero if input is available. */
468 int input_pending;
470 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
471 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
473 int meta_key;
475 /* Non-zero means force key bindings update in parse_menu_item. */
477 int update_menu_bindings;
479 extern char *pending_malloc_warning;
481 /* Circular buffer for pre-read keyboard input. */
483 static struct input_event kbd_buffer[KBD_BUFFER_SIZE];
485 /* Vector to GCPRO the Lisp objects referenced from kbd_buffer.
487 The interrupt-level event handlers will never enqueue an event on a
488 frame which is not in Vframe_list, and once an event is dequeued,
489 internal_last_event_frame or the event itself points to the frame.
490 So that's all fine.
492 But while the event is sitting in the queue, it's completely
493 unprotected. Suppose the user types one command which will run for
494 a while and then delete a frame, and then types another event at
495 the frame that will be deleted, before the command gets around to
496 it. Suppose there are no references to this frame elsewhere in
497 Emacs, and a GC occurs before the second event is dequeued. Now we
498 have an event referring to a freed frame, which will crash Emacs
499 when it is dequeued.
501 Similar things happen when an event on a scroll bar is enqueued; the
502 window may be deleted while the event is in the queue.
504 So, we use this vector to protect the Lisp_Objects in the event
505 queue. That way, they'll be dequeued as dead frames or windows,
506 but still valid Lisp objects.
508 If kbd_buffer[i].kind != no_event, then
510 AREF (kbd_buffer_gcpro, 2 * i) == kbd_buffer[i].frame_or_window.
511 AREF (kbd_buffer_gcpro, 2 * i + 1) == kbd_buffer[i].arg. */
513 static Lisp_Object kbd_buffer_gcpro;
515 /* Pointer to next available character in kbd_buffer.
516 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
517 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
518 next available char is in kbd_buffer[0]. */
519 static struct input_event *kbd_fetch_ptr;
521 /* Pointer to next place to store character in kbd_buffer. This
522 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
523 character should go in kbd_buffer[0]. */
524 static struct input_event * volatile kbd_store_ptr;
526 /* The above pair of variables forms a "queue empty" flag. When we
527 enqueue a non-hook event, we increment kbd_store_ptr. When we
528 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
529 there is input available iff the two pointers are not equal.
531 Why not just have a flag set and cleared by the enqueuing and
532 dequeuing functions? Such a flag could be screwed up by interrupts
533 at inopportune times. */
535 /* If this flag is non-nil, we check mouse_moved to see when the
536 mouse moves, and motion events will appear in the input stream.
537 Otherwise, mouse motion is ignored. */
538 Lisp_Object do_mouse_tracking;
540 /* Symbols to head events. */
541 Lisp_Object Qmouse_movement;
542 Lisp_Object Qscroll_bar_movement;
543 Lisp_Object Qswitch_frame;
544 Lisp_Object Qdelete_frame;
545 Lisp_Object Qiconify_frame;
546 Lisp_Object Qmake_frame_visible;
547 Lisp_Object Qselect_window;
548 Lisp_Object Qhelp_echo;
550 /* Symbols to denote kinds of events. */
551 Lisp_Object Qfunction_key;
552 Lisp_Object Qmouse_click;
553 #ifdef WINDOWSNT
554 Lisp_Object Qmouse_wheel;
555 Lisp_Object Qlanguage_change;
556 #endif
557 Lisp_Object Qdrag_n_drop;
558 Lisp_Object Qsave_session;
560 /* Lisp_Object Qmouse_movement; - also an event header */
562 /* Properties of event headers. */
563 Lisp_Object Qevent_kind;
564 Lisp_Object Qevent_symbol_elements;
566 /* menu item parts */
567 Lisp_Object Qmenu_alias;
568 Lisp_Object Qmenu_enable;
569 Lisp_Object QCenable, QCvisible, QChelp, QCfilter, QCkeys, QCkey_sequence;
570 Lisp_Object QCbutton, QCtoggle, QCradio;
571 extern Lisp_Object Vdefine_key_rebound_commands;
572 extern Lisp_Object Qmenu_item;
574 /* An event header symbol HEAD may have a property named
575 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
576 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
577 mask of modifiers applied to it. If present, this is used to help
578 speed up parse_modifiers. */
579 Lisp_Object Qevent_symbol_element_mask;
581 /* An unmodified event header BASE may have a property named
582 Qmodifier_cache, which is an alist mapping modifier masks onto
583 modified versions of BASE. If present, this helps speed up
584 apply_modifiers. */
585 Lisp_Object Qmodifier_cache;
587 /* Symbols to use for parts of windows. */
588 Lisp_Object Qmode_line;
589 Lisp_Object Qvertical_line;
590 Lisp_Object Qvertical_scroll_bar;
591 Lisp_Object Qmenu_bar;
592 extern Lisp_Object Qleft_margin, Qright_margin;
594 Lisp_Object recursive_edit_unwind (), command_loop ();
595 Lisp_Object Fthis_command_keys ();
596 Lisp_Object Qextended_command_history;
597 EMACS_TIME timer_check ();
599 extern Lisp_Object Vhistory_length;
601 extern char *x_get_keysym_name ();
603 static void record_menu_key ();
605 Lisp_Object Qpolling_period;
607 /* List of absolute timers. Appears in order of next scheduled event. */
608 Lisp_Object Vtimer_list;
610 /* List of idle time timers. Appears in order of next scheduled event. */
611 Lisp_Object Vtimer_idle_list;
613 /* Incremented whenever a timer is run. */
614 int timers_run;
616 extern Lisp_Object Vprint_level, Vprint_length;
618 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
619 happens. */
620 EMACS_TIME *input_available_clear_time;
622 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
623 Default is 1 if INTERRUPT_INPUT is defined. */
624 int interrupt_input;
626 /* Nonzero while interrupts are temporarily deferred during redisplay. */
627 int interrupts_deferred;
629 /* Nonzero means use ^S/^Q for flow control. */
630 int flow_control;
632 /* Allow m- file to inhibit use of FIONREAD. */
633 #ifdef BROKEN_FIONREAD
634 #undef FIONREAD
635 #endif
637 /* We are unable to use interrupts if FIONREAD is not available,
638 so flush SIGIO so we won't try. */
639 #ifndef FIONREAD
640 #ifdef SIGIO
641 #undef SIGIO
642 #endif
643 #endif
645 /* If we support a window system, turn on the code to poll periodically
646 to detect C-g. It isn't actually used when doing interrupt input. */
647 #ifdef HAVE_WINDOW_SYSTEM
648 #define POLL_FOR_INPUT
649 #endif
651 /* After a command is executed, if point is moved into a region that
652 has specific properties (e.g. composition, display), we adjust
653 point to the boundary of the region. But, if a command sets this
654 variable to non-nil, we suppress this point adjustment. This
655 variable is set to nil before reading a command. */
657 Lisp_Object Vdisable_point_adjustment;
659 /* If non-nil, always disable point adjustment. */
661 Lisp_Object Vglobal_disable_point_adjustment;
663 /* The time when Emacs started being idle. */
665 static EMACS_TIME timer_idleness_start_time;
668 /* Global variable declarations. */
670 /* Function for init_keyboard to call with no args (if nonzero). */
671 void (*keyboard_init_hook) ();
673 static int read_avail_input P_ ((int));
674 static void get_input_pending P_ ((int *, int));
675 static int readable_events P_ ((int));
676 static Lisp_Object read_char_x_menu_prompt P_ ((int, Lisp_Object *,
677 Lisp_Object, int *));
678 static Lisp_Object read_char_x_menu_prompt ();
679 static Lisp_Object read_char_minibuf_menu_prompt P_ ((int, int,
680 Lisp_Object *));
681 static Lisp_Object make_lispy_event P_ ((struct input_event *));
682 #ifdef HAVE_MOUSE
683 static Lisp_Object make_lispy_movement P_ ((struct frame *, Lisp_Object,
684 enum scroll_bar_part,
685 Lisp_Object, Lisp_Object,
686 unsigned long));
687 #endif
688 static Lisp_Object modify_event_symbol P_ ((int, unsigned, Lisp_Object,
689 Lisp_Object, char **,
690 Lisp_Object *, unsigned));
691 static Lisp_Object make_lispy_switch_frame P_ ((Lisp_Object));
692 static int parse_solitary_modifier P_ ((Lisp_Object));
693 static int parse_solitary_modifier ();
694 static void save_getcjmp P_ ((jmp_buf));
695 static void save_getcjmp ();
696 static void restore_getcjmp P_ ((jmp_buf));
697 static Lisp_Object apply_modifiers P_ ((int, Lisp_Object));
698 static void clear_event P_ ((struct input_event *));
699 static void any_kboard_state P_ ((void));
701 /* Nonzero means don't try to suspend even if the operating system seems
702 to support it. */
703 static int cannot_suspend;
705 /* Install the string STR as the beginning of the string of echoing,
706 so that it serves as a prompt for the next character.
707 Also start echoing. */
709 void
710 echo_prompt (str)
711 Lisp_Object str;
713 current_kboard->echo_string = str;
714 current_kboard->echo_after_prompt = SCHARS (str);
715 echo_now ();
718 /* Add C to the echo string, if echoing is going on.
719 C can be a character, which is printed prettily ("M-C-x" and all that
720 jazz), or a symbol, whose name is printed. */
722 void
723 echo_char (c)
724 Lisp_Object c;
726 if (current_kboard->immediate_echo)
728 int size = KEY_DESCRIPTION_SIZE + 100;
729 char *buffer = (char *) alloca (size);
730 char *ptr = buffer;
731 Lisp_Object echo_string;
733 echo_string = current_kboard->echo_string;
735 /* If someone has passed us a composite event, use its head symbol. */
736 c = EVENT_HEAD (c);
738 if (INTEGERP (c))
740 ptr = push_key_description (XINT (c), ptr, 1);
742 else if (SYMBOLP (c))
744 struct Lisp_String *name = XSTRING (SYMBOL_NAME (c));
745 int nbytes = STRING_BYTES (name);
747 if (size - (ptr - buffer) < nbytes)
749 int offset = ptr - buffer;
750 size = max (2 * size, size + nbytes);
751 buffer = (char *) alloca (size);
752 ptr = buffer + offset;
755 ptr += copy_text (name->data, ptr, nbytes,
756 name->size_byte >= 0, 1);
759 if ((NILP (echo_string) || SCHARS (echo_string) == 0)
760 && help_char_p (c))
762 const char *text = " (Type ? for further options)";
763 int len = strlen (text);
765 if (size - (ptr - buffer) < len)
767 int offset = ptr - buffer;
768 size += len;
769 buffer = (char *) alloca (size);
770 ptr = buffer + offset;
773 bcopy (text, ptr, len);
774 ptr += len;
777 /* Replace a dash from echo_dash with a space, otherwise
778 add a space at the end as a separator between keys. */
779 if (STRINGP (echo_string)
780 && SCHARS (echo_string) > 0)
782 Lisp_Object last_char, idx;
784 idx = make_number (SCHARS (echo_string) - 1);
785 last_char = Faref (echo_string, idx);
787 if (XINT (last_char) == '-')
788 Faset (echo_string, idx, make_number (' '));
789 else
790 echo_string = concat2 (echo_string, build_string (" "));
793 current_kboard->echo_string
794 = concat2 (echo_string, make_string (buffer, ptr - buffer));
796 echo_now ();
800 /* Temporarily add a dash to the end of the echo string if it's not
801 empty, so that it serves as a mini-prompt for the very next character. */
803 void
804 echo_dash ()
806 /* Do nothing if not echoing at all. */
807 if (NILP (current_kboard->echo_string))
808 return;
810 if (!current_kboard->immediate_echo
811 && SCHARS (current_kboard->echo_string) == 0)
812 return;
814 /* Do nothing if we just printed a prompt. */
815 if (current_kboard->echo_after_prompt
816 == SCHARS (current_kboard->echo_string))
817 return;
819 /* Put a dash at the end of the buffer temporarily,
820 but make it go away when the next character is added. */
821 current_kboard->echo_string = concat2 (current_kboard->echo_string,
822 build_string ("-"));
823 echo_now ();
826 /* Display the current echo string, and begin echoing if not already
827 doing so. */
829 void
830 echo_now ()
832 if (!current_kboard->immediate_echo)
834 int i;
835 current_kboard->immediate_echo = 1;
837 for (i = 0; i < this_command_key_count; i++)
839 Lisp_Object c;
840 c = XVECTOR (this_command_keys)->contents[i];
841 if (! (EVENT_HAS_PARAMETERS (c)
842 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
843 echo_char (c);
845 echo_dash ();
848 echoing = 1;
849 message3_nolog (current_kboard->echo_string,
850 SBYTES (current_kboard->echo_string),
851 SMBP (current_kboard->echo_string));
852 echoing = 0;
854 /* Record in what buffer we echoed, and from which kboard. */
855 echo_message_buffer = echo_area_buffer[0];
856 echo_kboard = current_kboard;
858 if (waiting_for_input && !NILP (Vquit_flag))
859 quit_throw_to_read_char ();
862 /* Turn off echoing, for the start of a new command. */
864 void
865 cancel_echoing ()
867 current_kboard->immediate_echo = 0;
868 current_kboard->echo_after_prompt = -1;
869 current_kboard->echo_string = Qnil;
870 ok_to_echo_at_next_pause = NULL;
871 echo_kboard = NULL;
872 echo_message_buffer = Qnil;
875 /* Return the length of the current echo string. */
877 static int
878 echo_length ()
880 return (STRINGP (current_kboard->echo_string)
881 ? SCHARS (current_kboard->echo_string)
882 : 0);
885 /* Truncate the current echo message to its first LEN chars.
886 This and echo_char get used by read_key_sequence when the user
887 switches frames while entering a key sequence. */
889 static void
890 echo_truncate (nchars)
891 int nchars;
893 if (STRINGP (current_kboard->echo_string))
894 current_kboard->echo_string
895 = Fsubstring (current_kboard->echo_string,
896 make_number (0), make_number (nchars));
897 truncate_echo_area (nchars);
901 /* Functions for manipulating this_command_keys. */
902 static void
903 add_command_key (key)
904 Lisp_Object key;
906 /* If reset-this-command-length was called recently, obey it now.
907 See the doc string of that function for an explanation of why. */
908 if (before_command_restore_flag)
910 this_command_key_count = before_command_key_count_1;
911 if (this_command_key_count < this_single_command_key_start)
912 this_single_command_key_start = this_command_key_count;
913 echo_truncate (before_command_echo_length_1);
914 before_command_restore_flag = 0;
917 if (this_command_key_count >= ASIZE (this_command_keys))
918 this_command_keys = larger_vector (this_command_keys,
919 2 * ASIZE (this_command_keys),
920 Qnil);
922 AREF (this_command_keys, this_command_key_count) = key;
923 ++this_command_key_count;
927 Lisp_Object
928 recursive_edit_1 ()
930 int count = specpdl_ptr - specpdl;
931 Lisp_Object val;
933 if (command_loop_level > 0)
935 specbind (Qstandard_output, Qt);
936 specbind (Qstandard_input, Qt);
939 #ifdef HAVE_X_WINDOWS
940 /* The command loop has started an hourglass timer, so we have to
941 cancel it here, otherwise it will fire because the recursive edit
942 can take some time. Do not check for display_hourglass_p here,
943 because it could already be nil. */
944 cancel_hourglass ();
945 #endif
947 /* This function may have been called from a debugger called from
948 within redisplay, for instance by Edebugging a function called
949 from fontification-functions. We want to allow redisplay in
950 the debugging session.
952 The recursive edit is left with a `(throw exit ...)'. The `exit'
953 tag is not caught anywhere in redisplay, i.e. when we leave the
954 recursive edit, the original redisplay leading to the recursive
955 edit will be unwound. The outcome should therefore be safe. */
956 specbind (Qinhibit_redisplay, Qnil);
957 redisplaying_p = 0;
959 val = command_loop ();
960 if (EQ (val, Qt))
961 Fsignal (Qquit, Qnil);
962 /* Handle throw from read_minibuf when using minibuffer
963 while it's active but we're in another window. */
964 if (STRINGP (val))
965 Fsignal (Qerror, Fcons (val, Qnil));
967 return unbind_to (count, Qnil);
970 /* When an auto-save happens, record the "time", and don't do again soon. */
972 void
973 record_auto_save ()
975 last_auto_save = num_nonmacro_input_events;
978 /* Make an auto save happen as soon as possible at command level. */
980 void
981 force_auto_save_soon ()
983 last_auto_save = - auto_save_interval - 1;
985 record_asynch_buffer_change ();
988 DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
989 doc: /* Invoke the editor command loop recursively.
990 To get out of the recursive edit, a command can do `(throw 'exit nil)';
991 that tells this function to return.
992 Alternately, `(throw 'exit t)' makes this function signal an error.
993 This function is called by the editor initialization to begin editing. */)
996 int count = specpdl_ptr - specpdl;
997 Lisp_Object buffer;
999 command_loop_level++;
1000 update_mode_lines = 1;
1002 if (command_loop_level
1003 && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
1004 buffer = Fcurrent_buffer ();
1005 else
1006 buffer = Qnil;
1008 /* If we leave recursive_edit_1 below with a `throw' for instance,
1009 like it is done in the splash screen display, we have to
1010 make sure that we restore single_kboard as command_loop_1
1011 would have done if it were left normally. */
1012 record_unwind_protect (recursive_edit_unwind,
1013 Fcons (buffer, single_kboard ? Qt : Qnil));
1015 recursive_edit_1 ();
1016 return unbind_to (count, Qnil);
1019 Lisp_Object
1020 recursive_edit_unwind (info)
1021 Lisp_Object info;
1023 if (BUFFERP (XCAR (info)))
1024 Fset_buffer (XCAR (info));
1026 if (NILP (XCDR (info)))
1027 any_kboard_state ();
1028 else
1029 single_kboard_state ();
1031 command_loop_level--;
1032 update_mode_lines = 1;
1033 return Qnil;
1037 static void
1038 any_kboard_state ()
1040 #ifdef MULTI_KBOARD
1041 #if 0 /* Theory: if there's anything in Vunread_command_events,
1042 it will right away be read by read_key_sequence,
1043 and then if we do switch KBOARDS, it will go into the side
1044 queue then. So we don't need to do anything special here -- rms. */
1045 if (CONSP (Vunread_command_events))
1047 current_kboard->kbd_queue
1048 = nconc2 (Vunread_command_events, current_kboard->kbd_queue);
1049 current_kboard->kbd_queue_has_data = 1;
1051 Vunread_command_events = Qnil;
1052 #endif
1053 single_kboard = 0;
1054 #endif
1057 /* Switch to the single-kboard state, making current_kboard
1058 the only KBOARD from which further input is accepted. */
1060 void
1061 single_kboard_state ()
1063 #ifdef MULTI_KBOARD
1064 single_kboard = 1;
1065 #endif
1068 /* Maintain a stack of kboards, so other parts of Emacs
1069 can switch temporarily to the kboard of a given frame
1070 and then revert to the previous status. */
1072 struct kboard_stack
1074 KBOARD *kboard;
1075 struct kboard_stack *next;
1078 static struct kboard_stack *kboard_stack;
1080 void
1081 push_frame_kboard (f)
1082 FRAME_PTR f;
1084 #ifdef MULTI_KBOARD
1085 struct kboard_stack *p
1086 = (struct kboard_stack *) xmalloc (sizeof (struct kboard_stack));
1088 p->next = kboard_stack;
1089 p->kboard = current_kboard;
1090 kboard_stack = p;
1092 current_kboard = FRAME_KBOARD (f);
1093 #endif
1096 void
1097 pop_frame_kboard ()
1099 #ifdef MULTI_KBOARD
1100 struct kboard_stack *p = kboard_stack;
1101 current_kboard = p->kboard;
1102 kboard_stack = p->next;
1103 xfree (p);
1104 #endif
1107 /* Handle errors that are not handled at inner levels
1108 by printing an error message and returning to the editor command loop. */
1110 Lisp_Object
1111 cmd_error (data)
1112 Lisp_Object data;
1114 Lisp_Object old_level, old_length;
1115 char macroerror[50];
1117 if (!NILP (executing_macro))
1119 if (executing_macro_iterations == 1)
1120 sprintf (macroerror, "After 1 kbd macro iteration: ");
1121 else
1122 sprintf (macroerror, "After %d kbd macro iterations: ",
1123 executing_macro_iterations);
1125 else
1126 *macroerror = 0;
1128 Vstandard_output = Qt;
1129 Vstandard_input = Qt;
1130 Vexecuting_macro = Qnil;
1131 executing_macro = Qnil;
1132 current_kboard->Vprefix_arg = Qnil;
1133 current_kboard->Vlast_prefix_arg = Qnil;
1134 cancel_echoing ();
1136 /* Avoid unquittable loop if data contains a circular list. */
1137 old_level = Vprint_level;
1138 old_length = Vprint_length;
1139 XSETFASTINT (Vprint_level, 10);
1140 XSETFASTINT (Vprint_length, 10);
1141 cmd_error_internal (data, macroerror);
1142 Vprint_level = old_level;
1143 Vprint_length = old_length;
1145 Vquit_flag = Qnil;
1147 Vinhibit_quit = Qnil;
1148 #ifdef MULTI_KBOARD
1149 any_kboard_state ();
1150 #endif
1152 return make_number (0);
1155 /* Take actions on handling an error. DATA is the data that describes
1156 the error.
1158 CONTEXT is a C-string containing ASCII characters only which
1159 describes the context in which the error happened. If we need to
1160 generalize CONTEXT to allow multibyte characters, make it a Lisp
1161 string. */
1163 void
1164 cmd_error_internal (data, context)
1165 Lisp_Object data;
1166 char *context;
1168 Lisp_Object stream;
1169 int kill_emacs_p = 0;
1170 struct frame *sf = SELECTED_FRAME ();
1172 Vquit_flag = Qnil;
1173 Vinhibit_quit = Qt;
1174 clear_message (1, 0);
1176 /* If the window system or terminal frame hasn't been initialized
1177 yet, or we're not interactive, it's best to dump this message out
1178 to stderr and exit. */
1179 if (!sf->glyphs_initialized_p
1180 /* This is the case of the frame dumped with Emacs, when we're
1181 running under a window system. */
1182 || (!NILP (Vwindow_system)
1183 && !inhibit_window_system
1184 && FRAME_TERMCAP_P (sf))
1185 || noninteractive)
1187 stream = Qexternal_debugging_output;
1188 kill_emacs_p = 1;
1190 else
1192 Fdiscard_input ();
1193 bitch_at_user ();
1194 stream = Qt;
1197 if (context != 0)
1198 write_string_1 (context, -1, stream);
1200 print_error_message (data, stream);
1202 /* If the window system or terminal frame hasn't been initialized
1203 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1204 if (kill_emacs_p)
1206 Fterpri (stream);
1207 Fkill_emacs (make_number (-1));
1211 Lisp_Object command_loop_1 ();
1212 Lisp_Object command_loop_2 ();
1213 Lisp_Object top_level_1 ();
1215 /* Entry to editor-command-loop.
1216 This level has the catches for exiting/returning to editor command loop.
1217 It returns nil to exit recursive edit, t to abort it. */
1219 Lisp_Object
1220 command_loop ()
1222 if (command_loop_level > 0 || minibuf_level > 0)
1224 Lisp_Object val;
1225 val = internal_catch (Qexit, command_loop_2, Qnil);
1226 executing_macro = Qnil;
1227 return val;
1229 else
1230 while (1)
1232 internal_catch (Qtop_level, top_level_1, Qnil);
1233 internal_catch (Qtop_level, command_loop_2, Qnil);
1234 executing_macro = Qnil;
1236 /* End of file in -batch run causes exit here. */
1237 if (noninteractive)
1238 Fkill_emacs (Qt);
1242 /* Here we catch errors in execution of commands within the
1243 editing loop, and reenter the editing loop.
1244 When there is an error, cmd_error runs and returns a non-nil
1245 value to us. A value of nil means that command_loop_1 itself
1246 returned due to end of file (or end of kbd macro). */
1248 Lisp_Object
1249 command_loop_2 ()
1251 register Lisp_Object val;
1254 val = internal_condition_case (command_loop_1, Qerror, cmd_error);
1255 while (!NILP (val));
1257 return Qnil;
1260 Lisp_Object
1261 top_level_2 ()
1263 return Feval (Vtop_level);
1266 Lisp_Object
1267 top_level_1 ()
1269 /* On entry to the outer level, run the startup file */
1270 if (!NILP (Vtop_level))
1271 internal_condition_case (top_level_2, Qerror, cmd_error);
1272 else if (!NILP (Vpurify_flag))
1273 message ("Bare impure Emacs (standard Lisp code not loaded)");
1274 else
1275 message ("Bare Emacs (standard Lisp code not loaded)");
1276 return Qnil;
1279 DEFUN ("top-level", Ftop_level, Stop_level, 0, 0, "",
1280 doc: /* Exit all recursive editing levels. */)
1283 #ifdef HAVE_X_WINDOWS
1284 if (display_hourglass_p)
1285 cancel_hourglass ();
1286 #endif
1287 return Fthrow (Qtop_level, Qnil);
1290 DEFUN ("exit-recursive-edit", Fexit_recursive_edit, Sexit_recursive_edit, 0, 0, "",
1291 doc: /* Exit from the innermost recursive edit or minibuffer. */)
1294 if (command_loop_level > 0 || minibuf_level > 0)
1295 Fthrow (Qexit, Qnil);
1297 error ("No recursive edit is in progress");
1298 return Qnil;
1301 DEFUN ("abort-recursive-edit", Fabort_recursive_edit, Sabort_recursive_edit, 0, 0, "",
1302 doc: /* Abort the command that requested this recursive edit or minibuffer input. */)
1305 if (command_loop_level > 0 || minibuf_level > 0)
1306 Fthrow (Qexit, Qt);
1308 error ("No recursive edit is in progress");
1309 return Qnil;
1312 /* This is the actual command reading loop,
1313 sans error-handling encapsulation. */
1315 static int read_key_sequence P_ ((Lisp_Object *, int, Lisp_Object,
1316 int, int, int));
1317 void safe_run_hooks P_ ((Lisp_Object));
1318 static void adjust_point_for_property P_ ((int));
1320 Lisp_Object
1321 command_loop_1 ()
1323 Lisp_Object cmd;
1324 int lose;
1325 int nonundocount;
1326 Lisp_Object keybuf[30];
1327 int i;
1328 int no_direct;
1329 int prev_modiff;
1330 struct buffer *prev_buffer = NULL;
1331 #ifdef MULTI_KBOARD
1332 int was_locked = single_kboard;
1333 #endif
1335 current_kboard->Vprefix_arg = Qnil;
1336 current_kboard->Vlast_prefix_arg = Qnil;
1337 Vdeactivate_mark = Qnil;
1338 waiting_for_input = 0;
1339 cancel_echoing ();
1341 nonundocount = 0;
1342 this_command_key_count = 0;
1343 this_single_command_key_start = 0;
1345 /* Make sure this hook runs after commands that get errors and
1346 throw to top level. */
1347 /* Note that the value cell will never directly contain nil
1348 if the symbol is a local variable. */
1349 if (!NILP (Vpost_command_hook) && !NILP (Vrun_hooks))
1350 safe_run_hooks (Qpost_command_hook);
1352 /* If displaying a message, resize the echo area window to fit
1353 that message's size exactly. */
1354 if (!NILP (echo_area_buffer[0]))
1355 resize_echo_area_exactly ();
1357 if (!NILP (Vdeferred_action_list))
1358 call0 (Vdeferred_action_function);
1360 if (!NILP (Vpost_command_idle_hook) && !NILP (Vrun_hooks))
1362 if (NILP (Vunread_command_events)
1363 && NILP (Vunread_input_method_events)
1364 && NILP (Vunread_post_input_method_events)
1365 && NILP (Vexecuting_macro)
1366 && !NILP (sit_for (0, post_command_idle_delay, 0, 1, 1)))
1367 safe_run_hooks (Qpost_command_idle_hook);
1370 /* Do this after running Vpost_command_hook, for consistency. */
1371 current_kboard->Vlast_command = Vthis_command;
1372 current_kboard->Vreal_last_command = real_this_command;
1374 while (1)
1376 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
1377 Fkill_emacs (Qnil);
1379 /* Make sure the current window's buffer is selected. */
1380 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
1381 set_buffer_internal (XBUFFER (XWINDOW (selected_window)->buffer));
1383 /* Display any malloc warning that just came out. Use while because
1384 displaying one warning can cause another. */
1386 while (pending_malloc_warning)
1387 display_malloc_warning ();
1389 no_direct = 0;
1391 Vdeactivate_mark = Qnil;
1393 /* If minibuffer on and echo area in use,
1394 wait a short time and redraw minibuffer. */
1396 if (minibuf_level
1397 && !NILP (echo_area_buffer[0])
1398 && EQ (minibuf_window, echo_area_window)
1399 && NUMBERP (Vminibuffer_message_timeout))
1401 /* Bind inhibit-quit to t so that C-g gets read in
1402 rather than quitting back to the minibuffer. */
1403 int count = specpdl_ptr - specpdl;
1404 specbind (Qinhibit_quit, Qt);
1406 Fsit_for (Vminibuffer_message_timeout, Qnil, Qnil);
1407 /* Clear the echo area. */
1408 message2 (0, 0, 0);
1409 safe_run_hooks (Qecho_area_clear_hook);
1411 unbind_to (count, Qnil);
1413 /* If a C-g came in before, treat it as input now. */
1414 if (!NILP (Vquit_flag))
1416 Vquit_flag = Qnil;
1417 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
1421 #ifdef C_ALLOCA
1422 alloca (0); /* Cause a garbage collection now */
1423 /* Since we can free the most stuff here. */
1424 #endif /* C_ALLOCA */
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 real_this_command = Qnil;
1447 /* Read next key sequence; i gets its length. */
1448 i = read_key_sequence (keybuf, sizeof keybuf / sizeof keybuf[0],
1449 Qnil, 0, 1, 1);
1451 /* A filter may have run while we were reading the input. */
1452 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
1453 Fkill_emacs (Qnil);
1454 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
1455 set_buffer_internal (XBUFFER (XWINDOW (selected_window)->buffer));
1457 ++num_input_keys;
1459 /* Now we have read a key sequence of length I,
1460 or else I is 0 and we found end of file. */
1462 if (i == 0) /* End of file -- happens only in */
1463 return Qnil; /* a kbd macro, at the end. */
1464 /* -1 means read_key_sequence got a menu that was rejected.
1465 Just loop around and read another command. */
1466 if (i == -1)
1468 cancel_echoing ();
1469 this_command_key_count = 0;
1470 this_single_command_key_start = 0;
1471 goto finalize;
1474 last_command_char = keybuf[i - 1];
1476 /* If the previous command tried to force a specific window-start,
1477 forget about that, in case this command moves point far away
1478 from that position. But also throw away beg_unchanged and
1479 end_unchanged information in that case, so that redisplay will
1480 update the whole window properly. */
1481 if (!NILP (XWINDOW (selected_window)->force_start))
1483 struct buffer *b;
1484 XWINDOW (selected_window)->force_start = Qnil;
1485 b = XBUFFER (XWINDOW (selected_window)->buffer);
1486 BUF_BEG_UNCHANGED (b) = BUF_END_UNCHANGED (b) = 0;
1489 cmd = read_key_sequence_cmd;
1490 if (!NILP (Vexecuting_macro))
1492 if (!NILP (Vquit_flag))
1494 Vexecuting_macro = Qt;
1495 QUIT; /* Make some noise. */
1496 /* Will return since macro now empty. */
1500 /* Do redisplay processing after this command except in special
1501 cases identified below. */
1502 prev_buffer = current_buffer;
1503 prev_modiff = MODIFF;
1504 last_point_position = PT;
1505 XSETBUFFER (last_point_position_buffer, prev_buffer);
1507 /* By default, we adjust point to a boundary of a region that
1508 has such a property that should be treated intangible
1509 (e.g. composition, display). But, some commands will set
1510 this variable differently. */
1511 Vdisable_point_adjustment = Qnil;
1513 /* Process filters and timers may have messed with deactivate-mark.
1514 reset it before we execute the command. */
1515 Vdeactivate_mark = Qnil;
1517 /* Remap command through active keymaps */
1518 Vthis_original_command = cmd;
1519 if (SYMBOLP (cmd))
1521 Lisp_Object cmd1;
1522 if (cmd1 = Fremap_command (cmd), !NILP (cmd1))
1523 cmd = cmd1;
1526 /* Execute the command. */
1528 Vthis_command = cmd;
1529 real_this_command = cmd;
1530 /* Note that the value cell will never directly contain nil
1531 if the symbol is a local variable. */
1532 if (!NILP (Vpre_command_hook) && !NILP (Vrun_hooks))
1533 safe_run_hooks (Qpre_command_hook);
1535 if (NILP (Vthis_command))
1537 /* nil means key is undefined. */
1538 bitch_at_user ();
1539 current_kboard->defining_kbd_macro = Qnil;
1540 update_mode_lines = 1;
1541 current_kboard->Vprefix_arg = Qnil;
1543 else
1545 if (NILP (current_kboard->Vprefix_arg) && ! no_direct)
1547 /* In case we jump to directly_done. */
1548 Vcurrent_prefix_arg = current_kboard->Vprefix_arg;
1550 /* Recognize some common commands in common situations and
1551 do them directly. */
1552 if (EQ (Vthis_command, Qforward_char) && PT < ZV)
1554 struct Lisp_Char_Table *dp
1555 = window_display_table (XWINDOW (selected_window));
1556 lose = FETCH_CHAR (PT_BYTE);
1557 SET_PT (PT + 1);
1558 if ((dp
1559 ? (VECTORP (DISP_CHAR_VECTOR (dp, lose))
1560 ? XVECTOR (DISP_CHAR_VECTOR (dp, lose))->size == 1
1561 : (NILP (DISP_CHAR_VECTOR (dp, lose))
1562 && (lose >= 0x20 && lose < 0x7f)))
1563 : (lose >= 0x20 && lose < 0x7f))
1564 /* To extract the case of continuation on
1565 wide-column characters. */
1566 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE)) == 1)
1567 && (XFASTINT (XWINDOW (selected_window)->last_modified)
1568 >= MODIFF)
1569 && (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1570 >= OVERLAY_MODIFF)
1571 && (XFASTINT (XWINDOW (selected_window)->last_point)
1572 == PT - 1)
1573 && !windows_or_buffers_changed
1574 && EQ (current_buffer->selective_display, Qnil)
1575 && !detect_input_pending ()
1576 && NILP (XWINDOW (selected_window)->column_number_displayed)
1577 && NILP (Vexecuting_macro))
1578 direct_output_forward_char (1);
1579 goto directly_done;
1581 else if (EQ (Vthis_command, Qbackward_char) && PT > BEGV)
1583 struct Lisp_Char_Table *dp
1584 = window_display_table (XWINDOW (selected_window));
1585 SET_PT (PT - 1);
1586 lose = FETCH_CHAR (PT_BYTE);
1587 if ((dp
1588 ? (VECTORP (DISP_CHAR_VECTOR (dp, lose))
1589 ? XVECTOR (DISP_CHAR_VECTOR (dp, lose))->size == 1
1590 : (NILP (DISP_CHAR_VECTOR (dp, lose))
1591 && (lose >= 0x20 && lose < 0x7f)))
1592 : (lose >= 0x20 && lose < 0x7f))
1593 && (XFASTINT (XWINDOW (selected_window)->last_modified)
1594 >= MODIFF)
1595 && (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1596 >= OVERLAY_MODIFF)
1597 && (XFASTINT (XWINDOW (selected_window)->last_point)
1598 == PT + 1)
1599 && !windows_or_buffers_changed
1600 && EQ (current_buffer->selective_display, Qnil)
1601 && !detect_input_pending ()
1602 && NILP (XWINDOW (selected_window)->column_number_displayed)
1603 && NILP (Vexecuting_macro))
1604 direct_output_forward_char (-1);
1605 goto directly_done;
1607 else if (EQ (Vthis_command, Qself_insert_command)
1608 /* Try this optimization only on ascii keystrokes. */
1609 && INTEGERP (last_command_char))
1611 unsigned int c = XINT (last_command_char);
1612 int value;
1613 if (NILP (Vexecuting_macro)
1614 && !EQ (minibuf_window, selected_window))
1616 if (!nonundocount || nonundocount >= 20)
1618 Fundo_boundary ();
1619 nonundocount = 0;
1621 nonundocount++;
1624 lose = ((XFASTINT (XWINDOW (selected_window)->last_modified)
1625 < MODIFF)
1626 || (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1627 < OVERLAY_MODIFF)
1628 || (XFASTINT (XWINDOW (selected_window)->last_point)
1629 != PT)
1630 || MODIFF <= SAVE_MODIFF
1631 || windows_or_buffers_changed
1632 || !EQ (current_buffer->selective_display, Qnil)
1633 || detect_input_pending ()
1634 || !NILP (XWINDOW (selected_window)->column_number_displayed)
1635 || !NILP (Vexecuting_macro));
1637 value = internal_self_insert (c, 0);
1639 if (value == 2)
1640 nonundocount = 0;
1642 /* VALUE == 1 when AFTER-CHANGE functions are
1643 installed which is the case most of the time
1644 because FONT-LOCK installs one. */
1645 if (!lose && !value)
1646 direct_output_for_insert (c);
1647 goto directly_done;
1651 /* Here for a command that isn't executed directly */
1653 #ifdef HAVE_X_WINDOWS
1654 if (display_hourglass_p
1655 && NILP (Vexecuting_macro))
1656 start_hourglass ();
1657 #endif
1659 nonundocount = 0;
1660 if (NILP (current_kboard->Vprefix_arg))
1661 Fundo_boundary ();
1662 Fcommand_execute (Vthis_command, Qnil, Qnil, Qnil);
1664 #ifdef HAVE_X_WINDOWS
1665 /* Do not check display_hourglass_p here, because
1666 Fcommand_execute could change it, but we should cancel
1667 hourglass cursor anyway.
1668 But don't cancel the hourglass within a macro
1669 just because a command in the macro finishes. */
1670 if (NILP (Vexecuting_macro))
1671 cancel_hourglass ();
1672 #endif
1674 directly_done: ;
1675 current_kboard->Vlast_prefix_arg = Vcurrent_prefix_arg;
1677 /* Note that the value cell will never directly contain nil
1678 if the symbol is a local variable. */
1679 if (!NILP (Vpost_command_hook) && !NILP (Vrun_hooks))
1680 safe_run_hooks (Qpost_command_hook);
1682 /* If displaying a message, resize the echo area window to fit
1683 that message's size exactly. */
1684 if (!NILP (echo_area_buffer[0]))
1685 resize_echo_area_exactly ();
1687 if (!NILP (Vdeferred_action_list))
1688 safe_run_hooks (Qdeferred_action_function);
1690 if (!NILP (Vpost_command_idle_hook) && !NILP (Vrun_hooks))
1692 if (NILP (Vunread_command_events)
1693 && NILP (Vunread_input_method_events)
1694 && NILP (Vunread_post_input_method_events)
1695 && NILP (Vexecuting_macro)
1696 && !NILP (sit_for (0, post_command_idle_delay, 0, 1, 1)))
1697 safe_run_hooks (Qpost_command_idle_hook);
1700 /* If there is a prefix argument,
1701 1) We don't want Vlast_command to be ``universal-argument''
1702 (that would be dumb), so don't set Vlast_command,
1703 2) we want to leave echoing on so that the prefix will be
1704 echoed as part of this key sequence, so don't call
1705 cancel_echoing, and
1706 3) we want to leave this_command_key_count non-zero, so that
1707 read_char will realize that it is re-reading a character, and
1708 not echo it a second time.
1710 If the command didn't actually create a prefix arg,
1711 but is merely a frame event that is transparent to prefix args,
1712 then the above doesn't apply. */
1713 if (NILP (current_kboard->Vprefix_arg) || CONSP (last_command_char))
1715 current_kboard->Vlast_command = Vthis_command;
1716 current_kboard->Vreal_last_command = real_this_command;
1717 cancel_echoing ();
1718 this_command_key_count = 0;
1719 this_single_command_key_start = 0;
1722 if (!NILP (current_buffer->mark_active) && !NILP (Vrun_hooks))
1724 if (!NILP (Vdeactivate_mark) && !NILP (Vtransient_mark_mode))
1726 /* We could also call `deactivate'mark'. */
1727 if (EQ (Vtransient_mark_mode, Qlambda))
1728 Vtransient_mark_mode = Qnil;
1729 else
1731 current_buffer->mark_active = Qnil;
1732 call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
1735 else if (current_buffer != prev_buffer || MODIFF != prev_modiff)
1736 call1 (Vrun_hooks, intern ("activate-mark-hook"));
1739 finalize:
1741 if (current_buffer == prev_buffer
1742 && last_point_position != PT
1743 && NILP (Vdisable_point_adjustment)
1744 && NILP (Vglobal_disable_point_adjustment))
1745 adjust_point_for_property (last_point_position);
1747 /* Install chars successfully executed in kbd macro. */
1749 if (!NILP (current_kboard->defining_kbd_macro)
1750 && NILP (current_kboard->Vprefix_arg))
1751 finalize_kbd_macro_chars ();
1753 #ifdef MULTI_KBOARD
1754 if (!was_locked)
1755 any_kboard_state ();
1756 #endif
1760 extern Lisp_Object Qcomposition, Qdisplay;
1762 /* Adjust point to a boundary of a region that has such a property
1763 that should be treated intangible. For the moment, we check
1764 `composition' and `display' property. LAST_PT is the last position
1765 of point. */
1767 static void
1768 adjust_point_for_property (last_pt)
1769 int last_pt;
1771 int start, end;
1772 Lisp_Object val;
1773 int check_composition = 1, check_display = 1;
1775 while (check_composition || check_display)
1777 if (check_composition
1778 && PT > BEGV && PT < ZV
1779 && get_property_and_range (PT, Qcomposition, &val, &start, &end, Qnil)
1780 && COMPOSITION_VALID_P (start, end, val)
1781 && start < PT && end > PT
1782 && (last_pt <= start || last_pt >= end))
1784 if (PT < last_pt)
1785 SET_PT (start);
1786 else
1787 SET_PT (end);
1788 check_display = 1;
1790 check_composition = 0;
1791 if (check_display
1792 && PT > BEGV && PT < ZV
1793 && get_property_and_range (PT, Qdisplay, &val, &start, &end, Qnil)
1794 && display_prop_intangible_p (val)
1795 && start < PT && end > PT
1796 && (last_pt <= start || last_pt >= end))
1798 if (PT < last_pt)
1799 SET_PT (start);
1800 else
1801 SET_PT (end);
1802 check_composition = 1;
1804 check_display = 0;
1808 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1810 static Lisp_Object
1811 safe_run_hooks_1 (hook)
1812 Lisp_Object hook;
1814 return call1 (Vrun_hooks, Vinhibit_quit);
1817 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1819 static Lisp_Object
1820 safe_run_hooks_error (data)
1821 Lisp_Object data;
1823 return Fset (Vinhibit_quit, Qnil);
1826 /* If we get an error while running the hook, cause the hook variable
1827 to be nil. Also inhibit quits, so that C-g won't cause the hook
1828 to mysteriously evaporate. */
1830 void
1831 safe_run_hooks (hook)
1832 Lisp_Object hook;
1834 int count = specpdl_ptr - specpdl;
1835 specbind (Qinhibit_quit, hook);
1837 internal_condition_case (safe_run_hooks_1, Qt, safe_run_hooks_error);
1839 unbind_to (count, Qnil);
1843 /* Number of seconds between polling for input. This is a Lisp
1844 variable that can be bound. */
1846 EMACS_INT polling_period;
1848 /* Nonzero means polling for input is temporarily suppressed. */
1850 int poll_suppress_count;
1852 /* Asynchronous timer for polling. */
1854 struct atimer *poll_timer;
1857 #ifdef POLL_FOR_INPUT
1859 /* Poll for input, so what we catch a C-g if it comes in. This
1860 function is called from x_make_frame_visible, see comment
1861 there. */
1863 void
1864 poll_for_input_1 ()
1866 if (interrupt_input_blocked == 0
1867 && !waiting_for_input)
1868 read_avail_input (0);
1871 /* Timer callback function for poll_timer. TIMER is equal to
1872 poll_timer. */
1874 void
1875 poll_for_input (timer)
1876 struct atimer *timer;
1878 if (poll_suppress_count == 0)
1879 poll_for_input_1 ();
1882 #endif /* POLL_FOR_INPUT */
1884 /* Begin signals to poll for input, if they are appropriate.
1885 This function is called unconditionally from various places. */
1887 void
1888 start_polling ()
1890 #ifdef POLL_FOR_INPUT
1891 if (read_socket_hook && !interrupt_input)
1893 /* Turn alarm handling on unconditionally. It might have
1894 been turned off in process.c. */
1895 turn_on_atimers (1);
1897 /* If poll timer doesn't exist, are we need one with
1898 a different interval, start a new one. */
1899 if (poll_timer == NULL
1900 || EMACS_SECS (poll_timer->interval) != polling_period)
1902 EMACS_TIME interval;
1904 if (poll_timer)
1905 cancel_atimer (poll_timer);
1907 EMACS_SET_SECS_USECS (interval, polling_period, 0);
1908 poll_timer = start_atimer (ATIMER_CONTINUOUS, interval,
1909 poll_for_input, NULL);
1912 /* Let the timer's callback function poll for input
1913 if this becomes zero. */
1914 --poll_suppress_count;
1916 #endif
1919 /* Nonzero if we are using polling to handle input asynchronously. */
1922 input_polling_used ()
1924 #ifdef POLL_FOR_INPUT
1925 return read_socket_hook && !interrupt_input;
1926 #else
1927 return 0;
1928 #endif
1931 /* Turn off polling. */
1933 void
1934 stop_polling ()
1936 #ifdef POLL_FOR_INPUT
1937 if (read_socket_hook && !interrupt_input)
1938 ++poll_suppress_count;
1939 #endif
1942 /* Set the value of poll_suppress_count to COUNT
1943 and start or stop polling accordingly. */
1945 void
1946 set_poll_suppress_count (count)
1947 int count;
1949 #ifdef POLL_FOR_INPUT
1950 if (count == 0 && poll_suppress_count != 0)
1952 poll_suppress_count = 1;
1953 start_polling ();
1955 else if (count != 0 && poll_suppress_count == 0)
1957 stop_polling ();
1959 poll_suppress_count = count;
1960 #endif
1963 /* Bind polling_period to a value at least N.
1964 But don't decrease it. */
1966 void
1967 bind_polling_period (n)
1968 int n;
1970 #ifdef POLL_FOR_INPUT
1971 int new = polling_period;
1973 if (n > new)
1974 new = n;
1976 stop_other_atimers (poll_timer);
1977 stop_polling ();
1978 specbind (Qpolling_period, make_number (new));
1979 /* Start a new alarm with the new period. */
1980 start_polling ();
1981 #endif
1984 /* Apply the control modifier to CHARACTER. */
1987 make_ctrl_char (c)
1988 int c;
1990 /* Save the upper bits here. */
1991 int upper = c & ~0177;
1993 c &= 0177;
1995 /* Everything in the columns containing the upper-case letters
1996 denotes a control character. */
1997 if (c >= 0100 && c < 0140)
1999 int oc = c;
2000 c &= ~0140;
2001 /* Set the shift modifier for a control char
2002 made from a shifted letter. But only for letters! */
2003 if (oc >= 'A' && oc <= 'Z')
2004 c |= shift_modifier;
2007 /* The lower-case letters denote control characters too. */
2008 else if (c >= 'a' && c <= 'z')
2009 c &= ~0140;
2011 /* Include the bits for control and shift
2012 only if the basic ASCII code can't indicate them. */
2013 else if (c >= ' ')
2014 c |= ctrl_modifier;
2016 /* Replace the high bits. */
2017 c |= (upper & ~ctrl_modifier);
2019 return c;
2022 /* Display help echo in the echo area.
2024 HELP a string means display that string, HELP nil means clear the
2025 help echo. If HELP is a function, call it with OBJECT and POS as
2026 arguments; the function should return a help string or nil for
2027 none. For all other types of HELP evaluate it to obtain a string.
2029 WINDOW is the window in which the help was generated, if any.
2030 It is nil if not in a window.
2032 If OBJECT is a buffer, POS is the position in the buffer where the
2033 `help-echo' text property was found.
2035 If OBJECT is an overlay, that overlay has a `help-echo' property,
2036 and POS is the position in the overlay's buffer under the mouse.
2038 If OBJECT is a string (an overlay string or a string displayed with
2039 the `display' property). POS is the position in that string under
2040 the mouse.
2042 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2043 echo overwrites a keystroke echo currently displayed in the echo
2044 area.
2046 Note: this function may only be called with HELP nil or a string
2047 from X code running asynchronously. */
2049 void
2050 show_help_echo (help, window, object, pos, ok_to_overwrite_keystroke_echo)
2051 Lisp_Object help, window, object, pos;
2052 int ok_to_overwrite_keystroke_echo;
2054 if (!NILP (help) && !STRINGP (help))
2056 if (FUNCTIONP (help))
2058 Lisp_Object args[4];
2059 args[0] = help;
2060 args[1] = window;
2061 args[2] = object;
2062 args[3] = pos;
2063 help = safe_call (4, args);
2065 else
2066 help = safe_eval (help);
2068 if (!STRINGP (help))
2069 return;
2072 if (STRINGP (help) || NILP (help))
2074 if (!NILP (Vshow_help_function))
2075 call1 (Vshow_help_function, help);
2076 else if (/* Don't overwrite minibuffer contents. */
2077 !MINI_WINDOW_P (XWINDOW (selected_window))
2078 /* Don't overwrite a keystroke echo. */
2079 && (NILP (echo_message_buffer)
2080 || ok_to_overwrite_keystroke_echo)
2081 /* Don't overwrite a prompt. */
2082 && !cursor_in_echo_area)
2084 if (STRINGP (help))
2086 int count = BINDING_STACK_SIZE ();
2088 if (!help_echo_showing_p)
2089 Vpre_help_message = current_message ();
2091 specbind (Qmessage_truncate_lines, Qt);
2092 message3_nolog (help, STRING_BYTES (XSTRING (help)),
2093 STRING_MULTIBYTE (help));
2094 unbind_to (count, Qnil);
2096 else if (STRINGP (Vpre_help_message))
2098 message3_nolog (Vpre_help_message,
2099 STRING_BYTES (XSTRING (Vpre_help_message)),
2100 STRING_MULTIBYTE (Vpre_help_message));
2101 Vpre_help_message = Qnil;
2103 else
2104 message (0);
2107 help_echo_showing_p = STRINGP (help);
2113 /* Input of single characters from keyboard */
2115 Lisp_Object print_help ();
2116 static Lisp_Object kbd_buffer_get_event ();
2117 static void record_char ();
2119 #ifdef MULTI_KBOARD
2120 static jmp_buf wrong_kboard_jmpbuf;
2121 #endif
2123 /* read a character from the keyboard; call the redisplay if needed */
2124 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2125 -1 means do not do redisplay, but do do autosaving.
2126 1 means do both. */
2128 /* The arguments MAPS and NMAPS are for menu prompting.
2129 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2131 PREV_EVENT is the previous input event, or nil if we are reading
2132 the first event of a key sequence (or not reading a key sequence).
2133 If PREV_EVENT is t, that is a "magic" value that says
2134 not to run input methods, but in other respects to act as if
2135 not reading a key sequence.
2137 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2138 if we used a mouse menu to read the input, or zero otherwise. If
2139 USED_MOUSE_MENU is null, we don't dereference it.
2141 Value is t if we showed a menu and the user rejected it. */
2143 Lisp_Object
2144 read_char (commandflag, nmaps, maps, prev_event, used_mouse_menu)
2145 int commandflag;
2146 int nmaps;
2147 Lisp_Object *maps;
2148 Lisp_Object prev_event;
2149 int *used_mouse_menu;
2151 volatile Lisp_Object c;
2152 int count;
2153 jmp_buf local_getcjmp;
2154 jmp_buf save_jump;
2155 volatile int key_already_recorded = 0;
2156 Lisp_Object tem, save;
2157 volatile Lisp_Object previous_echo_area_message;
2158 volatile Lisp_Object also_record;
2159 volatile int reread;
2160 struct gcpro gcpro1, gcpro2;
2161 EMACS_TIME last_idle_start;
2163 also_record = Qnil;
2165 before_command_key_count = this_command_key_count;
2166 before_command_echo_length = echo_length ();
2167 c = Qnil;
2168 previous_echo_area_message = Qnil;
2170 GCPRO2 (c, previous_echo_area_message);
2172 retry:
2174 reread = 0;
2175 if (CONSP (Vunread_post_input_method_events))
2177 c = XCAR (Vunread_post_input_method_events);
2178 Vunread_post_input_method_events
2179 = XCDR (Vunread_post_input_method_events);
2181 /* Undo what read_char_x_menu_prompt did when it unread
2182 additional keys returned by Fx_popup_menu. */
2183 if (CONSP (c)
2184 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c)))
2185 && NILP (XCDR (c)))
2186 c = XCAR (c);
2188 reread = 1;
2189 goto reread_first;
2192 if (unread_command_char != -1)
2194 XSETINT (c, unread_command_char);
2195 unread_command_char = -1;
2197 reread = 1;
2198 goto reread_first;
2201 if (CONSP (Vunread_command_events))
2203 c = XCAR (Vunread_command_events);
2204 Vunread_command_events = XCDR (Vunread_command_events);
2206 /* Undo what read_char_x_menu_prompt did when it unread
2207 additional keys returned by Fx_popup_menu. */
2208 if (CONSP (c)
2209 && EQ (XCDR (c), Qdisabled)
2210 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c))))
2211 c = XCAR (c);
2213 /* If the queued event is something that used the mouse,
2214 set used_mouse_menu accordingly. */
2215 if (used_mouse_menu
2216 && (EQ (c, Qtool_bar) || EQ (c, Qmenu_bar)))
2217 *used_mouse_menu = 1;
2219 reread = 1;
2220 goto reread_for_input_method;
2223 if (CONSP (Vunread_input_method_events))
2225 c = XCAR (Vunread_input_method_events);
2226 Vunread_input_method_events = XCDR (Vunread_input_method_events);
2228 /* Undo what read_char_x_menu_prompt did when it unread
2229 additional keys returned by Fx_popup_menu. */
2230 if (CONSP (c)
2231 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c)))
2232 && NILP (XCDR (c)))
2233 c = XCAR (c);
2234 reread = 1;
2235 goto reread_for_input_method;
2238 /* If there is no function key translated before
2239 reset-this-command-lengths takes effect, forget about it. */
2240 before_command_restore_flag = 0;
2242 if (!NILP (Vexecuting_macro))
2244 /* We set this to Qmacro; since that's not a frame, nobody will
2245 try to switch frames on us, and the selected window will
2246 remain unchanged.
2248 Since this event came from a macro, it would be misleading to
2249 leave internal_last_event_frame set to wherever the last
2250 real event came from. Normally, a switch-frame event selects
2251 internal_last_event_frame after each command is read, but
2252 events read from a macro should never cause a new frame to be
2253 selected. */
2254 Vlast_event_frame = internal_last_event_frame = Qmacro;
2256 /* Exit the macro if we are at the end.
2257 Also, some things replace the macro with t
2258 to force an early exit. */
2259 if (EQ (Vexecuting_macro, Qt)
2260 || executing_macro_index >= XFASTINT (Flength (Vexecuting_macro)))
2262 XSETINT (c, -1);
2263 RETURN_UNGCPRO (c);
2266 c = Faref (Vexecuting_macro, make_number (executing_macro_index));
2267 if (STRINGP (Vexecuting_macro)
2268 && (XINT (c) & 0x80))
2269 XSETFASTINT (c, CHAR_META | (XINT (c) & ~0x80));
2271 executing_macro_index++;
2273 goto from_macro;
2276 if (!NILP (unread_switch_frame))
2278 c = unread_switch_frame;
2279 unread_switch_frame = Qnil;
2281 /* This event should make it into this_command_keys, and get echoed
2282 again, so we do not set `reread'. */
2283 goto reread_first;
2286 /* if redisplay was requested */
2287 if (commandflag >= 0)
2289 /* If there is pending input, process any events which are not
2290 user-visible, such as X selection_request events. */
2291 if (input_pending
2292 || detect_input_pending_run_timers (0))
2293 swallow_events (0); /* may clear input_pending */
2295 /* Redisplay if no pending input. */
2296 while (!input_pending)
2298 if (help_echo_showing_p && !EQ (selected_window, minibuf_window))
2299 redisplay_preserve_echo_area (5);
2300 else
2301 redisplay ();
2303 if (!input_pending)
2304 /* Normal case: no input arrived during redisplay. */
2305 break;
2307 /* Input arrived and pre-empted redisplay.
2308 Process any events which are not user-visible. */
2309 swallow_events (0);
2310 /* If that cleared input_pending, try again to redisplay. */
2314 /* Message turns off echoing unless more keystrokes turn it on again.
2316 The code in 20.x for the condition was
2318 1. echo_area_glyphs && *echo_area_glyphs
2319 2. && echo_area_glyphs != current_kboard->echobuf
2320 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2322 (1) means there's a current message displayed
2324 (2) means it's not the message from echoing from the current
2325 kboard.
2327 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2328 is set to a non-null value. This is done in read_char and it is
2329 set to echo_area_glyphs after a call to echo_char. That means
2330 ok_to_echo_at_next_pause is either null or
2331 current_kboard->echobuf with the appropriate current_kboard at
2332 that time.
2334 So, condition (3) means in clear text ok_to_echo_at_next_pause
2335 must be either null, or the current message isn't from echoing at
2336 all, or it's from echoing from a different kboard than the
2337 current one. */
2339 if (/* There currently is something in the echo area. */
2340 !NILP (echo_area_buffer[0])
2341 && (/* And it's either not from echoing. */
2342 !EQ (echo_area_buffer[0], echo_message_buffer)
2343 /* Or it's an echo from a different kboard. */
2344 || echo_kboard != current_kboard
2345 /* Or we explicitly allow overwriting whatever there is. */
2346 || ok_to_echo_at_next_pause == NULL))
2347 cancel_echoing ();
2348 else
2349 echo_dash ();
2351 /* Try reading a character via menu prompting in the minibuf.
2352 Try this before the sit-for, because the sit-for
2353 would do the wrong thing if we are supposed to do
2354 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2355 after a mouse event so don't try a minibuf menu. */
2356 c = Qnil;
2357 if (nmaps > 0 && INTERACTIVE
2358 && !NILP (prev_event) && ! EVENT_HAS_PARAMETERS (prev_event)
2359 /* Don't bring up a menu if we already have another event. */
2360 && NILP (Vunread_command_events)
2361 && unread_command_char < 0
2362 && !detect_input_pending_run_timers (0))
2364 c = read_char_minibuf_menu_prompt (commandflag, nmaps, maps);
2365 if (! NILP (c))
2367 key_already_recorded = 1;
2368 goto non_reread_1;
2372 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2373 We will do that below, temporarily for short sections of code,
2374 when appropriate. local_getcjmp must be in effect
2375 around any call to sit_for or kbd_buffer_get_event;
2376 it *must not* be in effect when we call redisplay. */
2378 if (_setjmp (local_getcjmp))
2380 XSETINT (c, quit_char);
2381 internal_last_event_frame = selected_frame;
2382 Vlast_event_frame = internal_last_event_frame;
2383 /* If we report the quit char as an event,
2384 don't do so more than once. */
2385 if (!NILP (Vinhibit_quit))
2386 Vquit_flag = Qnil;
2388 #ifdef MULTI_KBOARD
2390 KBOARD *kb = FRAME_KBOARD (XFRAME (selected_frame));
2391 if (kb != current_kboard)
2393 Lisp_Object link = kb->kbd_queue;
2394 /* We shouldn't get here if we were in single-kboard mode! */
2395 if (single_kboard)
2396 abort ();
2397 if (CONSP (link))
2399 while (CONSP (XCDR (link)))
2400 link = XCDR (link);
2401 if (!NILP (XCDR (link)))
2402 abort ();
2404 if (!CONSP (link))
2405 kb->kbd_queue = Fcons (c, Qnil);
2406 else
2407 XSETCDR (link, Fcons (c, Qnil));
2408 kb->kbd_queue_has_data = 1;
2409 current_kboard = kb;
2410 /* This is going to exit from read_char
2411 so we had better get rid of this frame's stuff. */
2412 UNGCPRO;
2413 longjmp (wrong_kboard_jmpbuf, 1);
2416 #endif
2417 goto non_reread;
2420 timer_start_idle ();
2422 /* If in middle of key sequence and minibuffer not active,
2423 start echoing if enough time elapses. */
2425 if (minibuf_level == 0
2426 && !current_kboard->immediate_echo
2427 && this_command_key_count > 0
2428 && ! noninteractive
2429 && (FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
2430 && NILP (Fzerop (Vecho_keystrokes))
2431 && (/* No message. */
2432 NILP (echo_area_buffer[0])
2433 /* Or empty message. */
2434 || (BUF_BEG (XBUFFER (echo_area_buffer[0]))
2435 == BUF_Z (XBUFFER (echo_area_buffer[0])))
2436 /* Or already echoing from same kboard. */
2437 || (echo_kboard && ok_to_echo_at_next_pause == echo_kboard)
2438 /* Or not echoing before and echoing allowed. */
2439 || (!echo_kboard && ok_to_echo_at_next_pause)))
2441 Lisp_Object tem0;
2443 /* After a mouse event, start echoing right away.
2444 This is because we are probably about to display a menu,
2445 and we don't want to delay before doing so. */
2446 if (EVENT_HAS_PARAMETERS (prev_event))
2447 echo_now ();
2448 else
2450 int sec, usec;
2451 double duration = extract_float (Vecho_keystrokes);
2452 sec = (int) duration;
2453 usec = (duration - sec) * 1000000;
2454 save_getcjmp (save_jump);
2455 restore_getcjmp (local_getcjmp);
2456 tem0 = sit_for (sec, usec, 1, 1, 0);
2457 restore_getcjmp (save_jump);
2458 if (EQ (tem0, Qt)
2459 && ! CONSP (Vunread_command_events))
2460 echo_now ();
2464 /* Maybe auto save due to number of keystrokes. */
2466 if (commandflag != 0
2467 && auto_save_interval > 0
2468 && num_nonmacro_input_events - last_auto_save > max (auto_save_interval, 20)
2469 && !detect_input_pending_run_timers (0))
2471 Fdo_auto_save (Qnil, Qnil);
2472 /* Hooks can actually change some buffers in auto save. */
2473 redisplay ();
2476 /* Try reading using an X menu.
2477 This is never confused with reading using the minibuf
2478 because the recursive call of read_char in read_char_minibuf_menu_prompt
2479 does not pass on any keymaps. */
2481 if (nmaps > 0 && INTERACTIVE
2482 && !NILP (prev_event)
2483 && EVENT_HAS_PARAMETERS (prev_event)
2484 && !EQ (XCAR (prev_event), Qmenu_bar)
2485 && !EQ (XCAR (prev_event), Qtool_bar)
2486 /* Don't bring up a menu if we already have another event. */
2487 && NILP (Vunread_command_events)
2488 && unread_command_char < 0)
2490 c = read_char_x_menu_prompt (nmaps, maps, prev_event, used_mouse_menu);
2492 /* Now that we have read an event, Emacs is not idle. */
2493 timer_stop_idle ();
2495 RETURN_UNGCPRO (c);
2498 /* Maybe autosave and/or garbage collect due to idleness. */
2500 if (INTERACTIVE && NILP (c))
2502 int delay_level, buffer_size;
2504 /* Slow down auto saves logarithmically in size of current buffer,
2505 and garbage collect while we're at it. */
2506 if (! MINI_WINDOW_P (XWINDOW (selected_window)))
2507 last_non_minibuf_size = Z - BEG;
2508 buffer_size = (last_non_minibuf_size >> 8) + 1;
2509 delay_level = 0;
2510 while (buffer_size > 64)
2511 delay_level++, buffer_size -= buffer_size >> 2;
2512 if (delay_level < 4) delay_level = 4;
2513 /* delay_level is 4 for files under around 50k, 7 at 100k,
2514 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2516 /* Auto save if enough time goes by without input. */
2517 if (commandflag != 0
2518 && num_nonmacro_input_events > last_auto_save
2519 && INTEGERP (Vauto_save_timeout)
2520 && XINT (Vauto_save_timeout) > 0)
2522 Lisp_Object tem0;
2524 save_getcjmp (save_jump);
2525 restore_getcjmp (local_getcjmp);
2526 tem0 = sit_for (delay_level * XFASTINT (Vauto_save_timeout) / 4,
2527 0, 1, 1, 0);
2528 restore_getcjmp (save_jump);
2530 if (EQ (tem0, Qt)
2531 && ! CONSP (Vunread_command_events))
2533 Fdo_auto_save (Qnil, Qnil);
2535 /* If we have auto-saved and there is still no input
2536 available, garbage collect if there has been enough
2537 consing going on to make it worthwhile. */
2538 if (!detect_input_pending_run_timers (0)
2539 && consing_since_gc > gc_cons_threshold / 2)
2540 Fgarbage_collect ();
2542 redisplay ();
2547 /* If this has become non-nil here, it has been set by a timer
2548 or sentinel or filter. */
2549 if (CONSP (Vunread_command_events))
2551 c = XCAR (Vunread_command_events);
2552 Vunread_command_events = XCDR (Vunread_command_events);
2555 /* Read something from current KBOARD's side queue, if possible. */
2557 if (NILP (c))
2559 if (current_kboard->kbd_queue_has_data)
2561 if (!CONSP (current_kboard->kbd_queue))
2562 abort ();
2563 c = XCAR (current_kboard->kbd_queue);
2564 current_kboard->kbd_queue
2565 = XCDR (current_kboard->kbd_queue);
2566 if (NILP (current_kboard->kbd_queue))
2567 current_kboard->kbd_queue_has_data = 0;
2568 input_pending = readable_events (0);
2569 if (EVENT_HAS_PARAMETERS (c)
2570 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qswitch_frame))
2571 internal_last_event_frame = XCAR (XCDR (c));
2572 Vlast_event_frame = internal_last_event_frame;
2576 #ifdef MULTI_KBOARD
2577 /* If current_kboard's side queue is empty check the other kboards.
2578 If one of them has data that we have not yet seen here,
2579 switch to it and process the data waiting for it.
2581 Note: if the events queued up for another kboard
2582 have already been seen here, and therefore are not a complete command,
2583 the kbd_queue_has_data field is 0, so we skip that kboard here.
2584 That's to avoid an infinite loop switching between kboards here. */
2585 if (NILP (c) && !single_kboard)
2587 KBOARD *kb;
2588 for (kb = all_kboards; kb; kb = kb->next_kboard)
2589 if (kb->kbd_queue_has_data)
2591 current_kboard = kb;
2592 /* This is going to exit from read_char
2593 so we had better get rid of this frame's stuff. */
2594 UNGCPRO;
2595 longjmp (wrong_kboard_jmpbuf, 1);
2598 #endif
2600 wrong_kboard:
2602 stop_polling ();
2604 /* Finally, we read from the main queue,
2605 and if that gives us something we can't use yet, we put it on the
2606 appropriate side queue and try again. */
2608 if (NILP (c))
2610 KBOARD *kb;
2612 /* Actually read a character, waiting if necessary. */
2613 save_getcjmp (save_jump);
2614 restore_getcjmp (local_getcjmp);
2615 timer_start_idle ();
2616 c = kbd_buffer_get_event (&kb, used_mouse_menu);
2617 restore_getcjmp (save_jump);
2619 #ifdef MULTI_KBOARD
2620 if (! NILP (c) && (kb != current_kboard))
2622 Lisp_Object link = kb->kbd_queue;
2623 if (CONSP (link))
2625 while (CONSP (XCDR (link)))
2626 link = XCDR (link);
2627 if (!NILP (XCDR (link)))
2628 abort ();
2630 if (!CONSP (link))
2631 kb->kbd_queue = Fcons (c, Qnil);
2632 else
2633 XSETCDR (link, Fcons (c, Qnil));
2634 kb->kbd_queue_has_data = 1;
2635 c = Qnil;
2636 if (single_kboard)
2637 goto wrong_kboard;
2638 current_kboard = kb;
2639 /* This is going to exit from read_char
2640 so we had better get rid of this frame's stuff. */
2641 UNGCPRO;
2642 longjmp (wrong_kboard_jmpbuf, 1);
2644 #endif
2647 /* Terminate Emacs in batch mode if at eof. */
2648 if (noninteractive && INTEGERP (c) && XINT (c) < 0)
2649 Fkill_emacs (make_number (1));
2651 if (INTEGERP (c))
2653 /* Add in any extra modifiers, where appropriate. */
2654 if ((extra_keyboard_modifiers & CHAR_CTL)
2655 || ((extra_keyboard_modifiers & 0177) < ' '
2656 && (extra_keyboard_modifiers & 0177) != 0))
2657 XSETINT (c, make_ctrl_char (XINT (c)));
2659 /* Transfer any other modifier bits directly from
2660 extra_keyboard_modifiers to c. Ignore the actual character code
2661 in the low 16 bits of extra_keyboard_modifiers. */
2662 XSETINT (c, XINT (c) | (extra_keyboard_modifiers & ~0xff7f & ~CHAR_CTL));
2665 non_reread:
2667 /* Record the last idle start time so that we can reset it
2668 should the next event read be a help-echo. */
2669 last_idle_start = timer_idleness_start_time;
2670 timer_stop_idle ();
2671 start_polling ();
2673 if (NILP (c))
2675 if (commandflag >= 0
2676 && !input_pending && !detect_input_pending_run_timers (0))
2677 redisplay ();
2679 goto wrong_kboard;
2682 non_reread_1:
2684 /* Buffer switch events are only for internal wakeups
2685 so don't show them to the user.
2686 Also, don't record a key if we already did. */
2687 if (BUFFERP (c) || key_already_recorded)
2688 RETURN_UNGCPRO (c);
2690 /* Process special events within read_char
2691 and loop around to read another event. */
2692 save = Vquit_flag;
2693 Vquit_flag = Qnil;
2694 tem = access_keymap (get_keymap (Vspecial_event_map, 0, 1), c, 0, 0, 1);
2695 Vquit_flag = save;
2697 if (!NILP (tem))
2699 int was_locked = single_kboard;
2701 last_input_char = c;
2702 Fcommand_execute (tem, Qnil, Fvector (1, &last_input_char), Qt);
2704 if (CONSP (c) && EQ (XCAR (c), Qselect_window))
2705 /* We stopped being idle for this event; undo that. This
2706 prevents automatic window selection (under
2707 mouse_autoselect_window from acting as a real input event, for
2708 example banishing the mouse under mouse-avoidance-mode. */
2709 timer_idleness_start_time = last_idle_start;
2711 /* Resume allowing input from any kboard, if that was true before. */
2712 if (!was_locked)
2713 any_kboard_state ();
2715 goto retry;
2718 /* Handle things that only apply to characters. */
2719 if (INTEGERP (c))
2721 /* If kbd_buffer_get_event gave us an EOF, return that. */
2722 if (XINT (c) == -1)
2723 RETURN_UNGCPRO (c);
2725 if ((STRINGP (Vkeyboard_translate_table)
2726 && XSTRING (Vkeyboard_translate_table)->size > (unsigned) XFASTINT (c))
2727 || (VECTORP (Vkeyboard_translate_table)
2728 && XVECTOR (Vkeyboard_translate_table)->size > (unsigned) XFASTINT (c))
2729 || (CHAR_TABLE_P (Vkeyboard_translate_table)
2730 && CHAR_TABLE_ORDINARY_SLOTS > (unsigned) XFASTINT (c)))
2732 Lisp_Object d;
2733 d = Faref (Vkeyboard_translate_table, c);
2734 /* nil in keyboard-translate-table means no translation. */
2735 if (!NILP (d))
2736 c = d;
2740 /* If this event is a mouse click in the menu bar,
2741 return just menu-bar for now. Modify the mouse click event
2742 so we won't do this twice, then queue it up. */
2743 if (EVENT_HAS_PARAMETERS (c)
2744 && CONSP (XCDR (c))
2745 && CONSP (EVENT_START (c))
2746 && CONSP (XCDR (EVENT_START (c))))
2748 Lisp_Object posn;
2750 posn = POSN_BUFFER_POSN (EVENT_START (c));
2751 /* Handle menu-bar events:
2752 insert the dummy prefix event `menu-bar'. */
2753 if (EQ (posn, Qmenu_bar) || EQ (posn, Qtool_bar))
2755 /* Change menu-bar to (menu-bar) as the event "position". */
2756 POSN_BUFFER_SET_POSN (EVENT_START (c), Fcons (posn, Qnil));
2758 also_record = c;
2759 Vunread_command_events = Fcons (c, Vunread_command_events);
2760 c = posn;
2764 /* Store these characters into recent_keys, the dribble file if any,
2765 and the keyboard macro being defined, if any. */
2766 record_char (c);
2767 if (! NILP (also_record))
2768 record_char (also_record);
2770 /* Wipe the echo area.
2771 But first, if we are about to use an input method,
2772 save the echo area contents for it to refer to. */
2773 if (INTEGERP (c)
2774 && ! NILP (Vinput_method_function)
2775 && (unsigned) XINT (c) >= ' '
2776 && (unsigned) XINT (c) != 127
2777 && (unsigned) XINT (c) < 256)
2779 previous_echo_area_message = Fcurrent_message ();
2780 Vinput_method_previous_message = previous_echo_area_message;
2783 /* Now wipe the echo area, except for help events which do their
2784 own stuff with the echo area. */
2785 if (!CONSP (c)
2786 || (!(EQ (Qhelp_echo, XCAR (c)))
2787 && !(EQ (Qswitch_frame, XCAR (c)))))
2789 if (!NILP (echo_area_buffer[0]))
2790 safe_run_hooks (Qecho_area_clear_hook);
2791 clear_message (1, 0);
2794 reread_for_input_method:
2795 from_macro:
2796 /* Pass this to the input method, if appropriate. */
2797 if (INTEGERP (c)
2798 && ! NILP (Vinput_method_function)
2799 /* Don't run the input method within a key sequence,
2800 after the first event of the key sequence. */
2801 && NILP (prev_event)
2802 && (unsigned) XINT (c) >= ' '
2803 && (unsigned) XINT (c) != 127
2804 && (unsigned) XINT (c) < 256)
2806 Lisp_Object keys;
2807 int key_count;
2808 struct gcpro gcpro1;
2809 int count = specpdl_ptr - specpdl;
2811 /* Save the echo status. */
2812 int saved_immediate_echo = current_kboard->immediate_echo;
2813 struct kboard *saved_ok_to_echo = ok_to_echo_at_next_pause;
2814 int saved_echo_after_prompt = current_kboard->echo_after_prompt;
2816 if (before_command_restore_flag)
2818 this_command_key_count = before_command_key_count_1;
2819 if (this_command_key_count < this_single_command_key_start)
2820 this_single_command_key_start = this_command_key_count;
2821 echo_truncate (before_command_echo_length_1);
2822 before_command_restore_flag = 0;
2825 /* Save the this_command_keys status. */
2826 key_count = this_command_key_count;
2828 if (key_count > 0)
2829 keys = Fcopy_sequence (this_command_keys);
2830 else
2831 keys = Qnil;
2832 GCPRO1 (keys);
2834 /* Clear out this_command_keys. */
2835 this_command_key_count = 0;
2837 /* Now wipe the echo area. */
2838 if (!NILP (echo_area_buffer[0]))
2839 safe_run_hooks (Qecho_area_clear_hook);
2840 clear_message (1, 0);
2841 echo_truncate (0);
2843 /* If we are not reading a key sequence,
2844 never use the echo area. */
2845 if (maps == 0)
2847 specbind (Qinput_method_use_echo_area, Qt);
2850 /* Call the input method. */
2851 tem = call1 (Vinput_method_function, c);
2853 tem = unbind_to (count, tem);
2855 /* Restore the saved echoing state
2856 and this_command_keys state. */
2857 this_command_key_count = key_count;
2858 if (key_count > 0)
2859 this_command_keys = keys;
2861 cancel_echoing ();
2862 ok_to_echo_at_next_pause = saved_ok_to_echo;
2863 current_kboard->echo_after_prompt = saved_echo_after_prompt;
2864 if (saved_immediate_echo)
2865 echo_now ();
2867 UNGCPRO;
2869 /* The input method can return no events. */
2870 if (! CONSP (tem))
2872 /* Bring back the previous message, if any. */
2873 if (! NILP (previous_echo_area_message))
2874 message_with_string ("%s", previous_echo_area_message, 0);
2875 goto retry;
2877 /* It returned one event or more. */
2878 c = XCAR (tem);
2879 Vunread_post_input_method_events
2880 = nconc2 (XCDR (tem), Vunread_post_input_method_events);
2883 reread_first:
2885 /* Display help if not echoing. */
2886 if (CONSP (c) && EQ (XCAR (c), Qhelp_echo))
2888 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
2889 Lisp_Object help, object, position, window, tem;
2891 tem = Fcdr (XCDR (c));
2892 help = Fcar (tem);
2893 tem = Fcdr (tem);
2894 window = Fcar (tem);
2895 tem = Fcdr (tem);
2896 object = Fcar (tem);
2897 tem = Fcdr (tem);
2898 position = Fcar (tem);
2900 show_help_echo (help, window, object, position, 0);
2902 /* We stopped being idle for this event; undo that. */
2903 timer_idleness_start_time = last_idle_start;
2904 goto retry;
2907 if (this_command_key_count == 0 || ! reread)
2909 before_command_key_count = this_command_key_count;
2910 before_command_echo_length = echo_length ();
2912 /* Don't echo mouse motion events. */
2913 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
2914 && NILP (Fzerop (Vecho_keystrokes))
2915 && ! (EVENT_HAS_PARAMETERS (c)
2916 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
2918 echo_char (c);
2919 if (! NILP (also_record))
2920 echo_char (also_record);
2921 /* Once we reread a character, echoing can happen
2922 the next time we pause to read a new one. */
2923 ok_to_echo_at_next_pause = current_kboard;
2926 /* Record this character as part of the current key. */
2927 add_command_key (c);
2928 if (! NILP (also_record))
2929 add_command_key (also_record);
2932 last_input_char = c;
2933 num_input_events++;
2935 /* Process the help character specially if enabled */
2936 if (!NILP (Vhelp_form) && help_char_p (c))
2938 Lisp_Object tem0;
2939 count = specpdl_ptr - specpdl;
2941 record_unwind_protect (Fset_window_configuration,
2942 Fcurrent_window_configuration (Qnil));
2944 tem0 = Feval (Vhelp_form);
2945 if (STRINGP (tem0))
2946 internal_with_output_to_temp_buffer ("*Help*", print_help, tem0);
2948 cancel_echoing ();
2950 c = read_char (0, 0, 0, Qnil, 0);
2951 while (BUFFERP (c));
2952 /* Remove the help from the frame */
2953 unbind_to (count, Qnil);
2955 redisplay ();
2956 if (EQ (c, make_number (040)))
2958 cancel_echoing ();
2960 c = read_char (0, 0, 0, Qnil, 0);
2961 while (BUFFERP (c));
2965 RETURN_UNGCPRO (c);
2968 /* Record a key that came from a mouse menu.
2969 Record it for echoing, for this-command-keys, and so on. */
2971 static void
2972 record_menu_key (c)
2973 Lisp_Object c;
2975 /* Wipe the echo area. */
2976 clear_message (1, 0);
2978 record_char (c);
2980 before_command_key_count = this_command_key_count;
2981 before_command_echo_length = echo_length ();
2983 /* Don't echo mouse motion events. */
2984 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
2985 && NILP (Fzerop (Vecho_keystrokes)))
2987 echo_char (c);
2989 /* Once we reread a character, echoing can happen
2990 the next time we pause to read a new one. */
2991 ok_to_echo_at_next_pause = 0;
2994 /* Record this character as part of the current key. */
2995 add_command_key (c);
2997 /* Re-reading in the middle of a command */
2998 last_input_char = c;
2999 num_input_events++;
3002 /* Return 1 if should recognize C as "the help character". */
3005 help_char_p (c)
3006 Lisp_Object c;
3008 Lisp_Object tail;
3010 if (EQ (c, Vhelp_char))
3011 return 1;
3012 for (tail = Vhelp_event_list; CONSP (tail); tail = XCDR (tail))
3013 if (EQ (c, XCAR (tail)))
3014 return 1;
3015 return 0;
3018 /* Record the input event C in various ways. */
3020 static void
3021 record_char (c)
3022 Lisp_Object c;
3024 int recorded = 0;
3026 if (CONSP (c) && (EQ (XCAR (c), Qhelp_echo) || EQ (XCAR (c), Qmouse_movement)))
3028 /* To avoid filling recent_keys with help-echo and mouse-movement
3029 events, we filter out repeated help-echo events, only store the
3030 first and last in a series of mouse-movement events, and don't
3031 store repeated help-echo events which are only separated by
3032 mouse-movement events. */
3034 Lisp_Object ev1, ev2, ev3;
3035 int ix1, ix2, ix3;
3037 if ((ix1 = recent_keys_index - 1) < 0)
3038 ix1 = NUM_RECENT_KEYS - 1;
3039 ev1 = AREF (recent_keys, ix1);
3041 if ((ix2 = ix1 - 1) < 0)
3042 ix2 = NUM_RECENT_KEYS - 1;
3043 ev2 = AREF (recent_keys, ix2);
3045 if ((ix3 = ix2 - 1) < 0)
3046 ix3 = NUM_RECENT_KEYS - 1;
3047 ev3 = AREF (recent_keys, ix3);
3049 if (EQ (XCAR (c), Qhelp_echo))
3051 /* Don't record `help-echo' in recent_keys unless it shows some help
3052 message, and a different help than the previously recorded
3053 event. */
3054 Lisp_Object help, last_help;
3056 help = Fcar_safe (Fcdr_safe (XCDR (c)));
3057 if (!STRINGP (help))
3058 recorded = 1;
3059 else if (CONSP (ev1) && EQ (XCAR (ev1), Qhelp_echo)
3060 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev1))), EQ (last_help, help)))
3061 recorded = 1;
3062 else if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3063 && CONSP (ev2) && EQ (XCAR (ev2), Qhelp_echo)
3064 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev2))), EQ (last_help, help)))
3065 recorded = -1;
3066 else if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3067 && CONSP (ev2) && EQ (XCAR (ev2), Qmouse_movement)
3068 && CONSP (ev3) && EQ (XCAR (ev3), Qhelp_echo)
3069 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev3))), EQ (last_help, help)))
3070 recorded = -2;
3072 else if (EQ (XCAR (c), Qmouse_movement))
3074 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3075 So additional mouse movement events replace the last element. */
3076 Lisp_Object last_window, window;
3078 window = Fcar_safe (Fcar_safe (XCDR (c)));
3079 if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3080 && (last_window = Fcar_safe (Fcar_safe (XCDR (ev1))), EQ (last_window, window))
3081 && CONSP (ev2) && EQ (XCAR (ev2), Qmouse_movement)
3082 && (last_window = Fcar_safe (Fcar_safe (XCDR (ev2))), EQ (last_window, window)))
3084 ASET (recent_keys, ix1, c);
3085 recorded = 1;
3089 else
3090 store_kbd_macro_char (c);
3092 if (!recorded)
3094 total_keys++;
3095 ASET (recent_keys, recent_keys_index, c);
3096 if (++recent_keys_index >= NUM_RECENT_KEYS)
3097 recent_keys_index = 0;
3099 else if (recorded < 0)
3101 /* We need to remove one or two events from recent_keys.
3102 To do this, we simply put nil at those events and move the
3103 recent_keys_index backwards over those events. Usually,
3104 users will never see those nil events, as they will be
3105 overwritten by the command keys entered to see recent_keys
3106 (e.g. C-h l). */
3108 while (recorded++ < 0 && total_keys > 0)
3110 if (total_keys < NUM_RECENT_KEYS)
3111 total_keys--;
3112 if (--recent_keys_index < 0)
3113 recent_keys_index = NUM_RECENT_KEYS - 1;
3114 ASET (recent_keys, recent_keys_index, Qnil);
3118 num_nonmacro_input_events++;
3120 /* Write c to the dribble file. If c is a lispy event, write
3121 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3122 If you, dear reader, have a better idea, you've got the source. :-) */
3123 if (dribble)
3125 if (INTEGERP (c))
3127 if (XUINT (c) < 0x100)
3128 putc (XINT (c), dribble);
3129 else
3130 fprintf (dribble, " 0x%x", (int) XUINT (c));
3132 else
3134 Lisp_Object dribblee;
3136 /* If it's a structured event, take the event header. */
3137 dribblee = EVENT_HEAD (c);
3139 if (SYMBOLP (dribblee))
3141 putc ('<', dribble);
3142 fwrite (XSTRING (SYMBOL_NAME (dribblee))->data, sizeof (char),
3143 STRING_BYTES (XSTRING (SYMBOL_NAME (dribblee))),
3144 dribble);
3145 putc ('>', dribble);
3149 fflush (dribble);
3153 Lisp_Object
3154 print_help (object)
3155 Lisp_Object object;
3157 struct buffer *old = current_buffer;
3158 Fprinc (object, Qnil);
3159 set_buffer_internal (XBUFFER (Vstandard_output));
3160 call0 (intern ("help-mode"));
3161 set_buffer_internal (old);
3162 return Qnil;
3165 /* Copy out or in the info on where C-g should throw to.
3166 This is used when running Lisp code from within get_char,
3167 in case get_char is called recursively.
3168 See read_process_output. */
3170 static void
3171 save_getcjmp (temp)
3172 jmp_buf temp;
3174 bcopy (getcjmp, temp, sizeof getcjmp);
3177 static void
3178 restore_getcjmp (temp)
3179 jmp_buf temp;
3181 bcopy (temp, getcjmp, sizeof getcjmp);
3184 #ifdef HAVE_MOUSE
3186 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3187 of this function. */
3189 static Lisp_Object
3190 tracking_off (old_value)
3191 Lisp_Object old_value;
3193 do_mouse_tracking = old_value;
3194 if (NILP (old_value))
3196 /* Redisplay may have been preempted because there was input
3197 available, and it assumes it will be called again after the
3198 input has been processed. If the only input available was
3199 the sort that we have just disabled, then we need to call
3200 redisplay. */
3201 if (!readable_events (1))
3203 redisplay_preserve_echo_area (6);
3204 get_input_pending (&input_pending, 1);
3207 return Qnil;
3210 DEFUN ("track-mouse", Ftrack_mouse, Strack_mouse, 0, UNEVALLED, 0,
3211 doc: /* Evaluate BODY with mouse movement events enabled.
3212 Within a `track-mouse' form, mouse motion generates input events that
3213 you can read with `read-event'.
3214 Normally, mouse motion is ignored.
3215 usage: (track-mouse BODY ...) */)
3216 (args)
3217 Lisp_Object args;
3219 int count = specpdl_ptr - specpdl;
3220 Lisp_Object val;
3222 record_unwind_protect (tracking_off, do_mouse_tracking);
3224 do_mouse_tracking = Qt;
3226 val = Fprogn (args);
3227 return unbind_to (count, val);
3230 /* If mouse has moved on some frame, return one of those frames.
3231 Return 0 otherwise. */
3233 static FRAME_PTR
3234 some_mouse_moved ()
3236 Lisp_Object tail, frame;
3238 FOR_EACH_FRAME (tail, frame)
3240 if (XFRAME (frame)->mouse_moved)
3241 return XFRAME (frame);
3244 return 0;
3247 #endif /* HAVE_MOUSE */
3249 /* Low level keyboard/mouse input.
3250 kbd_buffer_store_event places events in kbd_buffer, and
3251 kbd_buffer_get_event retrieves them. */
3253 /* Return true iff there are any events in the queue that read-char
3254 would return. If this returns false, a read-char would block. */
3255 static int
3256 readable_events (do_timers_now)
3257 int do_timers_now;
3259 if (do_timers_now)
3260 timer_check (do_timers_now);
3262 if (kbd_fetch_ptr != kbd_store_ptr)
3263 return 1;
3264 #ifdef HAVE_MOUSE
3265 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
3266 return 1;
3267 #endif
3268 if (single_kboard)
3270 if (current_kboard->kbd_queue_has_data)
3271 return 1;
3273 else
3275 KBOARD *kb;
3276 for (kb = all_kboards; kb; kb = kb->next_kboard)
3277 if (kb->kbd_queue_has_data)
3278 return 1;
3280 return 0;
3283 /* Set this for debugging, to have a way to get out */
3284 int stop_character;
3286 #ifdef MULTI_KBOARD
3287 static KBOARD *
3288 event_to_kboard (event)
3289 struct input_event *event;
3291 Lisp_Object frame;
3292 frame = event->frame_or_window;
3293 if (CONSP (frame))
3294 frame = XCAR (frame);
3295 else if (WINDOWP (frame))
3296 frame = WINDOW_FRAME (XWINDOW (frame));
3298 /* There are still some events that don't set this field.
3299 For now, just ignore the problem.
3300 Also ignore dead frames here. */
3301 if (!FRAMEP (frame) || !FRAME_LIVE_P (XFRAME (frame)))
3302 return 0;
3303 else
3304 return FRAME_KBOARD (XFRAME (frame));
3306 #endif
3308 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3310 void
3311 kbd_buffer_store_event (event)
3312 register struct input_event *event;
3314 if (event->kind == no_event)
3315 abort ();
3317 if (event->kind == ascii_keystroke)
3319 register int c = event->code & 0377;
3321 if (event->modifiers & ctrl_modifier)
3322 c = make_ctrl_char (c);
3324 c |= (event->modifiers
3325 & (meta_modifier | alt_modifier
3326 | hyper_modifier | super_modifier));
3328 if (c == quit_char)
3330 static SIGTYPE interrupt_signal (int);
3331 #ifdef MULTI_KBOARD
3332 KBOARD *kb;
3333 struct input_event *sp;
3335 if (single_kboard
3336 && (kb = FRAME_KBOARD (XFRAME (event->frame_or_window)),
3337 kb != current_kboard))
3339 kb->kbd_queue
3340 = Fcons (make_lispy_switch_frame (event->frame_or_window),
3341 Fcons (make_number (c), Qnil));
3342 kb->kbd_queue_has_data = 1;
3343 for (sp = kbd_fetch_ptr; sp != kbd_store_ptr; sp++)
3345 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3346 sp = kbd_buffer;
3348 if (event_to_kboard (sp) == kb)
3350 sp->kind = no_event;
3351 sp->frame_or_window = Qnil;
3352 sp->arg = Qnil;
3355 return;
3357 #endif
3359 /* If this results in a quit_char being returned to Emacs as
3360 input, set Vlast_event_frame properly. If this doesn't
3361 get returned to Emacs as an event, the next event read
3362 will set Vlast_event_frame again, so this is safe to do. */
3364 Lisp_Object focus;
3366 focus = FRAME_FOCUS_FRAME (XFRAME (event->frame_or_window));
3367 if (NILP (focus))
3368 focus = event->frame_or_window;
3369 internal_last_event_frame = focus;
3370 Vlast_event_frame = focus;
3373 last_event_timestamp = event->timestamp;
3374 interrupt_signal (0 /* dummy */);
3375 return;
3378 if (c && c == stop_character)
3380 sys_suspend ();
3381 return;
3384 /* Don't insert two buffer_switch_event's in a row.
3385 Just ignore the second one. */
3386 else if (event->kind == buffer_switch_event
3387 && kbd_fetch_ptr != kbd_store_ptr
3388 && kbd_store_ptr->kind == buffer_switch_event)
3389 return;
3391 if (kbd_store_ptr - kbd_buffer == KBD_BUFFER_SIZE)
3392 kbd_store_ptr = kbd_buffer;
3394 /* Don't let the very last slot in the buffer become full,
3395 since that would make the two pointers equal,
3396 and that is indistinguishable from an empty buffer.
3397 Discard the event if it would fill the last slot. */
3398 if (kbd_fetch_ptr - 1 != kbd_store_ptr)
3400 int idx;
3402 #if 0 /* The selection_request_event case looks bogus, and it's error
3403 prone to assign individual members for other events, in case
3404 the input_event structure is changed. --2000-07-13, gerd. */
3405 struct input_event *sp = kbd_store_ptr;
3406 sp->kind = event->kind;
3407 if (event->kind == selection_request_event)
3409 /* We must not use the ordinary copying code for this case,
3410 since `part' is an enum and copying it might not copy enough
3411 in this case. */
3412 bcopy (event, (char *) sp, sizeof (*event));
3414 else
3417 sp->code = event->code;
3418 sp->part = event->part;
3419 sp->frame_or_window = event->frame_or_window;
3420 sp->arg = event->arg;
3421 sp->modifiers = event->modifiers;
3422 sp->x = event->x;
3423 sp->y = event->y;
3424 sp->timestamp = event->timestamp;
3426 #else
3427 *kbd_store_ptr = *event;
3428 #endif
3430 idx = 2 * (kbd_store_ptr - kbd_buffer);
3431 ASET (kbd_buffer_gcpro, idx, event->frame_or_window);
3432 ASET (kbd_buffer_gcpro, idx + 1, event->arg);
3433 ++kbd_store_ptr;
3438 /* Generate HELP_EVENT input_events in BUFP which has room for
3439 SIZE events. If there's not enough room in BUFP, ignore this
3440 event.
3442 HELP is the help form.
3444 FRAME is the frame on which the help is generated. OBJECT is the
3445 Lisp object where the help was found (a buffer, a string, an
3446 overlay, or nil if neither from a string nor from a buffer. POS is
3447 the position within OBJECT where the help was found.
3449 Value is the number of input_events generated. */
3452 gen_help_event (bufp, size, help, frame, window, object, pos)
3453 struct input_event *bufp;
3454 int size;
3455 Lisp_Object help, frame, object, window;
3456 int pos;
3458 if (size >= 1)
3460 bufp->kind = HELP_EVENT;
3461 bufp->frame_or_window = frame;
3462 bufp->arg = object;
3463 bufp->x = WINDOWP (window) ? window : frame;
3464 bufp->y = help;
3465 bufp->code = pos;
3466 return 1;
3468 return 0;
3472 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3474 void
3475 kbd_buffer_store_help_event (frame, help)
3476 Lisp_Object frame, help;
3478 struct input_event event;
3480 event.kind = HELP_EVENT;
3481 event.frame_or_window = frame;
3482 event.arg = Qnil;
3483 event.x = Qnil;
3484 event.y = help;
3485 event.code = 0;
3486 kbd_buffer_store_event (&event);
3490 /* Discard any mouse events in the event buffer by setting them to
3491 no_event. */
3492 void
3493 discard_mouse_events ()
3495 struct input_event *sp;
3496 for (sp = kbd_fetch_ptr; sp != kbd_store_ptr; sp++)
3498 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3499 sp = kbd_buffer;
3501 if (sp->kind == mouse_click
3502 #ifdef WINDOWSNT
3503 || sp->kind == w32_scroll_bar_click
3504 #endif
3505 || sp->kind == scroll_bar_click)
3507 sp->kind = no_event;
3513 /* Return non-zero if there are any real events waiting in the event
3514 buffer, not counting `no_event's.
3516 If DISCARD is non-zero, discard no_event events at the front of
3517 the input queue, possibly leaving the input queue empty if there
3518 are no real input events. */
3521 kbd_buffer_events_waiting (discard)
3522 int discard;
3524 struct input_event *sp;
3526 for (sp = kbd_fetch_ptr;
3527 sp != kbd_store_ptr && sp->kind == no_event;
3528 ++sp)
3530 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3531 sp = kbd_buffer;
3534 if (discard)
3535 kbd_fetch_ptr = sp;
3537 return sp != kbd_store_ptr && sp->kind != no_event;
3541 /* Clear input event EVENT. */
3543 static INLINE void
3544 clear_event (event)
3545 struct input_event *event;
3547 int idx = 2 * (event - kbd_buffer);
3548 ASET (kbd_buffer_gcpro, idx, Qnil);
3549 ASET (kbd_buffer_gcpro, idx + 1, Qnil);
3550 event->kind = no_event;
3554 /* Read one event from the event buffer, waiting if necessary.
3555 The value is a Lisp object representing the event.
3556 The value is nil for an event that should be ignored,
3557 or that was handled here.
3558 We always read and discard one event. */
3560 static Lisp_Object
3561 kbd_buffer_get_event (kbp, used_mouse_menu)
3562 KBOARD **kbp;
3563 int *used_mouse_menu;
3565 register int c;
3566 Lisp_Object obj;
3568 if (noninteractive)
3570 c = getchar ();
3571 XSETINT (obj, c);
3572 *kbp = current_kboard;
3573 return obj;
3576 /* Wait until there is input available. */
3577 for (;;)
3579 if (kbd_fetch_ptr != kbd_store_ptr)
3580 break;
3581 #ifdef HAVE_MOUSE
3582 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
3583 break;
3584 #endif
3586 /* If the quit flag is set, then read_char will return
3587 quit_char, so that counts as "available input." */
3588 if (!NILP (Vquit_flag))
3589 quit_throw_to_read_char ();
3591 /* One way or another, wait until input is available; then, if
3592 interrupt handlers have not read it, read it now. */
3594 #ifdef OLDVMS
3595 wait_for_kbd_input ();
3596 #else
3597 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3598 #ifdef SIGIO
3599 gobble_input (0);
3600 #endif /* SIGIO */
3601 if (kbd_fetch_ptr != kbd_store_ptr)
3602 break;
3603 #ifdef HAVE_MOUSE
3604 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
3605 break;
3606 #endif
3608 Lisp_Object minus_one;
3610 XSETINT (minus_one, -1);
3611 wait_reading_process_input (0, 0, minus_one, 1);
3613 if (!interrupt_input && kbd_fetch_ptr == kbd_store_ptr)
3614 /* Pass 1 for EXPECT since we just waited to have input. */
3615 read_avail_input (1);
3617 #endif /* not VMS */
3620 if (CONSP (Vunread_command_events))
3622 Lisp_Object first;
3623 first = XCAR (Vunread_command_events);
3624 Vunread_command_events = XCDR (Vunread_command_events);
3625 *kbp = current_kboard;
3626 return first;
3629 /* At this point, we know that there is a readable event available
3630 somewhere. If the event queue is empty, then there must be a
3631 mouse movement enabled and available. */
3632 if (kbd_fetch_ptr != kbd_store_ptr)
3634 struct input_event *event;
3636 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
3637 ? kbd_fetch_ptr
3638 : kbd_buffer);
3640 last_event_timestamp = event->timestamp;
3642 #ifdef MULTI_KBOARD
3643 *kbp = event_to_kboard (event);
3644 if (*kbp == 0)
3645 *kbp = current_kboard; /* Better than returning null ptr? */
3646 #else
3647 *kbp = &the_only_kboard;
3648 #endif
3650 obj = Qnil;
3652 /* These two kinds of events get special handling
3653 and don't actually appear to the command loop.
3654 We return nil for them. */
3655 if (event->kind == selection_request_event)
3657 #ifdef HAVE_X11
3658 struct input_event copy;
3660 /* Remove it from the buffer before processing it,
3661 since otherwise swallow_events will see it
3662 and process it again. */
3663 copy = *event;
3664 kbd_fetch_ptr = event + 1;
3665 input_pending = readable_events (0);
3666 x_handle_selection_request (&copy);
3667 #else
3668 /* We're getting selection request events, but we don't have
3669 a window system. */
3670 abort ();
3671 #endif
3674 else if (event->kind == selection_clear_event)
3676 #ifdef HAVE_X11
3677 struct input_event copy;
3679 /* Remove it from the buffer before processing it. */
3680 copy = *event;
3681 kbd_fetch_ptr = event + 1;
3682 input_pending = readable_events (0);
3683 x_handle_selection_clear (&copy);
3684 #else
3685 /* We're getting selection request events, but we don't have
3686 a window system. */
3687 abort ();
3688 #endif
3690 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3691 else if (event->kind == delete_window_event)
3693 /* Make an event (delete-frame (FRAME)). */
3694 obj = Fcons (event->frame_or_window, Qnil);
3695 obj = Fcons (Qdelete_frame, Fcons (obj, Qnil));
3696 kbd_fetch_ptr = event + 1;
3698 #endif
3699 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3700 else if (event->kind == iconify_event)
3702 /* Make an event (iconify-frame (FRAME)). */
3703 obj = Fcons (event->frame_or_window, Qnil);
3704 obj = Fcons (Qiconify_frame, Fcons (obj, Qnil));
3705 kbd_fetch_ptr = event + 1;
3707 else if (event->kind == deiconify_event)
3709 /* Make an event (make-frame-visible (FRAME)). */
3710 obj = Fcons (event->frame_or_window, Qnil);
3711 obj = Fcons (Qmake_frame_visible, Fcons (obj, Qnil));
3712 kbd_fetch_ptr = event + 1;
3714 #endif
3715 else if (event->kind == buffer_switch_event)
3717 /* The value doesn't matter here; only the type is tested. */
3718 XSETBUFFER (obj, current_buffer);
3719 kbd_fetch_ptr = event + 1;
3721 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS)
3722 else if (event->kind == menu_bar_activate_event)
3724 kbd_fetch_ptr = event + 1;
3725 input_pending = readable_events (0);
3726 if (FRAME_LIVE_P (XFRAME (event->frame_or_window)))
3727 x_activate_menubar (XFRAME (event->frame_or_window));
3729 #endif
3730 #ifdef WINDOWSNT
3731 else if (event->kind == language_change_event)
3733 /* Make an event (language-change (FRAME CHARSET LCID)). */
3734 obj = Fcons (event->modifiers, Qnil);
3735 obj = Fcons (event->code, obj);
3736 obj = Fcons (event->frame_or_window, obj);
3737 obj = Fcons (Qlanguage_change, Fcons (obj, Qnil));
3738 kbd_fetch_ptr = event + 1;
3740 #endif
3741 else if (event->kind == save_session_event)
3743 obj = Fcons (Qsave_session, Qnil);
3744 kbd_fetch_ptr = event + 1;
3746 /* Just discard these, by returning nil.
3747 With MULTI_KBOARD, these events are used as placeholders
3748 when we need to randomly delete events from the queue.
3749 (They shouldn't otherwise be found in the buffer,
3750 but on some machines it appears they do show up
3751 even without MULTI_KBOARD.) */
3752 /* On Windows NT/9X, no_event is used to delete extraneous
3753 mouse events during a popup-menu call. */
3754 else if (event->kind == no_event)
3755 kbd_fetch_ptr = event + 1;
3756 else if (event->kind == HELP_EVENT)
3758 Lisp_Object object, position, help, frame, window;
3760 frame = event->frame_or_window;
3761 object = event->arg;
3762 position = make_number (event->code);
3763 window = event->x;
3764 help = event->y;
3765 clear_event (event);
3767 kbd_fetch_ptr = event + 1;
3768 if (!WINDOWP (window))
3769 window = Qnil;
3770 obj = Fcons (Qhelp_echo,
3771 list5 (frame, help, window, object, position));
3773 else if (event->kind == FOCUS_IN_EVENT)
3775 /* Notification of a FocusIn event. The frame receiving the
3776 focus is in event->frame_or_window. Generate a
3777 switch-frame event if necessary. */
3778 Lisp_Object frame, focus;
3780 frame = event->frame_or_window;
3781 focus = FRAME_FOCUS_FRAME (XFRAME (frame));
3782 if (FRAMEP (focus))
3783 frame = focus;
3785 if (!EQ (frame, internal_last_event_frame)
3786 && !EQ (frame, selected_frame))
3787 obj = make_lispy_switch_frame (frame);
3788 internal_last_event_frame = frame;
3789 kbd_fetch_ptr = event + 1;
3791 else if (event->kind == SELECT_WINDOW_EVENT)
3793 /* Make an event (select-window (WINDOW)). */
3794 obj = Fcons (event->frame_or_window, Qnil);
3795 obj = Fcons (Qselect_window, Fcons (obj, Qnil));
3797 kbd_fetch_ptr = event + 1;
3799 else
3801 /* If this event is on a different frame, return a switch-frame this
3802 time, and leave the event in the queue for next time. */
3803 Lisp_Object frame;
3804 Lisp_Object focus;
3806 frame = event->frame_or_window;
3807 if (CONSP (frame))
3808 frame = XCAR (frame);
3809 else if (WINDOWP (frame))
3810 frame = WINDOW_FRAME (XWINDOW (frame));
3812 focus = FRAME_FOCUS_FRAME (XFRAME (frame));
3813 if (! NILP (focus))
3814 frame = focus;
3816 if (! EQ (frame, internal_last_event_frame)
3817 && !EQ (frame, selected_frame))
3818 obj = make_lispy_switch_frame (frame);
3819 internal_last_event_frame = frame;
3821 /* If we didn't decide to make a switch-frame event, go ahead
3822 and build a real event from the queue entry. */
3824 if (NILP (obj))
3826 obj = make_lispy_event (event);
3828 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
3829 /* If this was a menu selection, then set the flag to inhibit
3830 writing to last_nonmenu_event. Don't do this if the event
3831 we're returning is (menu-bar), though; that indicates the
3832 beginning of the menu sequence, and we might as well leave
3833 that as the `event with parameters' for this selection. */
3834 if (used_mouse_menu
3835 && !EQ (event->frame_or_window, event->arg)
3836 && (event->kind == MENU_BAR_EVENT
3837 || event->kind == TOOL_BAR_EVENT))
3838 *used_mouse_menu = 1;
3839 #endif
3841 /* Wipe out this event, to catch bugs. */
3842 clear_event (event);
3843 kbd_fetch_ptr = event + 1;
3847 #ifdef HAVE_MOUSE
3848 /* Try generating a mouse motion event. */
3849 else if (!NILP (do_mouse_tracking) && some_mouse_moved ())
3851 FRAME_PTR f = some_mouse_moved ();
3852 Lisp_Object bar_window;
3853 enum scroll_bar_part part;
3854 Lisp_Object x, y;
3855 unsigned long time;
3857 *kbp = current_kboard;
3858 /* Note that this uses F to determine which display to look at.
3859 If there is no valid info, it does not store anything
3860 so x remains nil. */
3861 x = Qnil;
3862 (*mouse_position_hook) (&f, 0, &bar_window, &part, &x, &y, &time);
3864 obj = Qnil;
3866 /* Decide if we should generate a switch-frame event. Don't
3867 generate switch-frame events for motion outside of all Emacs
3868 frames. */
3869 if (!NILP (x) && f)
3871 Lisp_Object frame;
3873 frame = FRAME_FOCUS_FRAME (f);
3874 if (NILP (frame))
3875 XSETFRAME (frame, f);
3877 if (! EQ (frame, internal_last_event_frame)
3878 && !EQ (frame, selected_frame))
3879 obj = make_lispy_switch_frame (frame);
3880 internal_last_event_frame = frame;
3883 /* If we didn't decide to make a switch-frame event, go ahead and
3884 return a mouse-motion event. */
3885 if (!NILP (x) && NILP (obj))
3886 obj = make_lispy_movement (f, bar_window, part, x, y, time);
3888 #endif /* HAVE_MOUSE */
3889 else
3890 /* We were promised by the above while loop that there was
3891 something for us to read! */
3892 abort ();
3894 input_pending = readable_events (0);
3896 Vlast_event_frame = internal_last_event_frame;
3898 return (obj);
3901 /* Process any events that are not user-visible,
3902 then return, without reading any user-visible events. */
3904 void
3905 swallow_events (do_display)
3906 int do_display;
3908 int old_timers_run;
3910 while (kbd_fetch_ptr != kbd_store_ptr)
3912 struct input_event *event;
3914 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
3915 ? kbd_fetch_ptr
3916 : kbd_buffer);
3918 last_event_timestamp = event->timestamp;
3920 /* These two kinds of events get special handling
3921 and don't actually appear to the command loop. */
3922 if (event->kind == selection_request_event)
3924 #ifdef HAVE_X11
3925 struct input_event copy;
3927 /* Remove it from the buffer before processing it,
3928 since otherwise swallow_events called recursively could see it
3929 and process it again. */
3930 copy = *event;
3931 kbd_fetch_ptr = event + 1;
3932 input_pending = readable_events (0);
3933 x_handle_selection_request (&copy);
3934 #else
3935 /* We're getting selection request events, but we don't have
3936 a window system. */
3937 abort ();
3938 #endif
3941 else if (event->kind == selection_clear_event)
3943 #ifdef HAVE_X11
3944 struct input_event copy;
3946 /* Remove it from the buffer before processing it, */
3947 copy = *event;
3949 kbd_fetch_ptr = event + 1;
3950 input_pending = readable_events (0);
3951 x_handle_selection_clear (&copy);
3952 #else
3953 /* We're getting selection request events, but we don't have
3954 a window system. */
3955 abort ();
3956 #endif
3958 else
3959 break;
3962 old_timers_run = timers_run;
3963 get_input_pending (&input_pending, 1);
3965 if (timers_run != old_timers_run && do_display)
3966 redisplay_preserve_echo_area (7);
3969 /* Record the start of when Emacs is idle,
3970 for the sake of running idle-time timers. */
3972 void
3973 timer_start_idle ()
3975 Lisp_Object timers;
3977 /* If we are already in the idle state, do nothing. */
3978 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
3979 return;
3981 EMACS_GET_TIME (timer_idleness_start_time);
3983 /* Mark all idle-time timers as once again candidates for running. */
3984 for (timers = Vtimer_idle_list; CONSP (timers); timers = XCDR (timers))
3986 Lisp_Object timer;
3988 timer = XCAR (timers);
3990 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
3991 continue;
3992 XVECTOR (timer)->contents[0] = Qnil;
3996 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
3998 void
3999 timer_stop_idle ()
4001 EMACS_SET_SECS_USECS (timer_idleness_start_time, -1, -1);
4004 /* This is only for debugging. */
4005 struct input_event last_timer_event;
4007 /* Check whether a timer has fired. To prevent larger problems we simply
4008 disregard elements that are not proper timers. Do not make a circular
4009 timer list for the time being.
4011 Returns the number of seconds to wait until the next timer fires. If a
4012 timer is triggering now, return zero seconds.
4013 If no timer is active, return -1 seconds.
4015 If a timer is ripe, we run it, with quitting turned off.
4017 DO_IT_NOW is now ignored. It used to mean that we should
4018 run the timer directly instead of queueing a timer-event.
4019 Now we always run timers directly. */
4021 EMACS_TIME
4022 timer_check (do_it_now)
4023 int do_it_now;
4025 EMACS_TIME nexttime;
4026 EMACS_TIME now, idleness_now;
4027 Lisp_Object timers, idle_timers, chosen_timer;
4028 struct gcpro gcpro1, gcpro2, gcpro3;
4030 EMACS_SET_SECS (nexttime, -1);
4031 EMACS_SET_USECS (nexttime, -1);
4033 /* Always consider the ordinary timers. */
4034 timers = Vtimer_list;
4035 /* Consider the idle timers only if Emacs is idle. */
4036 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4037 idle_timers = Vtimer_idle_list;
4038 else
4039 idle_timers = Qnil;
4040 chosen_timer = Qnil;
4041 GCPRO3 (timers, idle_timers, chosen_timer);
4043 if (CONSP (timers) || CONSP (idle_timers))
4045 EMACS_GET_TIME (now);
4046 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4047 EMACS_SUB_TIME (idleness_now, now, timer_idleness_start_time);
4050 while (CONSP (timers) || CONSP (idle_timers))
4052 Lisp_Object *vector;
4053 Lisp_Object timer = Qnil, idle_timer = Qnil;
4054 EMACS_TIME timer_time, idle_timer_time;
4055 EMACS_TIME difference, timer_difference, idle_timer_difference;
4057 /* Skip past invalid timers and timers already handled. */
4058 if (!NILP (timers))
4060 timer = XCAR (timers);
4061 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
4063 timers = XCDR (timers);
4064 continue;
4066 vector = XVECTOR (timer)->contents;
4068 if (!INTEGERP (vector[1]) || !INTEGERP (vector[2])
4069 || !INTEGERP (vector[3])
4070 || ! NILP (vector[0]))
4072 timers = XCDR (timers);
4073 continue;
4076 if (!NILP (idle_timers))
4078 timer = XCAR (idle_timers);
4079 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
4081 idle_timers = XCDR (idle_timers);
4082 continue;
4084 vector = XVECTOR (timer)->contents;
4086 if (!INTEGERP (vector[1]) || !INTEGERP (vector[2])
4087 || !INTEGERP (vector[3])
4088 || ! NILP (vector[0]))
4090 idle_timers = XCDR (idle_timers);
4091 continue;
4095 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4096 based on the next ordinary timer.
4097 TIMER_DIFFERENCE is the distance in time from NOW to when
4098 this timer becomes ripe (negative if it's already ripe). */
4099 if (!NILP (timers))
4101 timer = XCAR (timers);
4102 vector = XVECTOR (timer)->contents;
4103 EMACS_SET_SECS (timer_time,
4104 (XINT (vector[1]) << 16) | (XINT (vector[2])));
4105 EMACS_SET_USECS (timer_time, XINT (vector[3]));
4106 EMACS_SUB_TIME (timer_difference, timer_time, now);
4109 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4110 based on the next idle timer. */
4111 if (!NILP (idle_timers))
4113 idle_timer = XCAR (idle_timers);
4114 vector = XVECTOR (idle_timer)->contents;
4115 EMACS_SET_SECS (idle_timer_time,
4116 (XINT (vector[1]) << 16) | (XINT (vector[2])));
4117 EMACS_SET_USECS (idle_timer_time, XINT (vector[3]));
4118 EMACS_SUB_TIME (idle_timer_difference, idle_timer_time, idleness_now);
4121 /* Decide which timer is the next timer,
4122 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4123 Also step down the list where we found that timer. */
4125 if (! NILP (timers) && ! NILP (idle_timers))
4127 EMACS_TIME temp;
4128 EMACS_SUB_TIME (temp, timer_difference, idle_timer_difference);
4129 if (EMACS_TIME_NEG_P (temp))
4131 chosen_timer = timer;
4132 timers = XCDR (timers);
4133 difference = timer_difference;
4135 else
4137 chosen_timer = idle_timer;
4138 idle_timers = XCDR (idle_timers);
4139 difference = idle_timer_difference;
4142 else if (! NILP (timers))
4144 chosen_timer = timer;
4145 timers = XCDR (timers);
4146 difference = timer_difference;
4148 else
4150 chosen_timer = idle_timer;
4151 idle_timers = XCDR (idle_timers);
4152 difference = idle_timer_difference;
4154 vector = XVECTOR (chosen_timer)->contents;
4156 /* If timer is ripe, run it if it hasn't been run. */
4157 if (EMACS_TIME_NEG_P (difference)
4158 || (EMACS_SECS (difference) == 0
4159 && EMACS_USECS (difference) == 0))
4161 if (NILP (vector[0]))
4163 int was_locked = single_kboard;
4164 int count = BINDING_STACK_SIZE ();
4165 Lisp_Object old_deactivate_mark = Vdeactivate_mark;
4167 /* Mark the timer as triggered to prevent problems if the lisp
4168 code fails to reschedule it right. */
4169 vector[0] = Qt;
4171 specbind (Qinhibit_quit, Qt);
4173 call1 (Qtimer_event_handler, chosen_timer);
4174 Vdeactivate_mark = old_deactivate_mark;
4175 timers_run++;
4176 unbind_to (count, Qnil);
4178 /* Resume allowing input from any kboard, if that was true before. */
4179 if (!was_locked)
4180 any_kboard_state ();
4182 /* Since we have handled the event,
4183 we don't need to tell the caller to wake up and do it. */
4186 else
4187 /* When we encounter a timer that is still waiting,
4188 return the amount of time to wait before it is ripe. */
4190 UNGCPRO;
4191 return difference;
4195 /* No timers are pending in the future. */
4196 /* Return 0 if we generated an event, and -1 if not. */
4197 UNGCPRO;
4198 return nexttime;
4201 /* Caches for modify_event_symbol. */
4202 static Lisp_Object accent_key_syms;
4203 static Lisp_Object func_key_syms;
4204 static Lisp_Object mouse_syms;
4205 #ifdef WINDOWSNT
4206 static Lisp_Object mouse_wheel_syms;
4207 #endif
4208 static Lisp_Object drag_n_drop_syms;
4210 /* This is a list of keysym codes for special "accent" characters.
4211 It parallels lispy_accent_keys. */
4213 static int lispy_accent_codes[] =
4215 #ifdef XK_dead_circumflex
4216 XK_dead_circumflex,
4217 #else
4219 #endif
4220 #ifdef XK_dead_grave
4221 XK_dead_grave,
4222 #else
4224 #endif
4225 #ifdef XK_dead_tilde
4226 XK_dead_tilde,
4227 #else
4229 #endif
4230 #ifdef XK_dead_diaeresis
4231 XK_dead_diaeresis,
4232 #else
4234 #endif
4235 #ifdef XK_dead_macron
4236 XK_dead_macron,
4237 #else
4239 #endif
4240 #ifdef XK_dead_degree
4241 XK_dead_degree,
4242 #else
4244 #endif
4245 #ifdef XK_dead_acute
4246 XK_dead_acute,
4247 #else
4249 #endif
4250 #ifdef XK_dead_cedilla
4251 XK_dead_cedilla,
4252 #else
4254 #endif
4255 #ifdef XK_dead_breve
4256 XK_dead_breve,
4257 #else
4259 #endif
4260 #ifdef XK_dead_ogonek
4261 XK_dead_ogonek,
4262 #else
4264 #endif
4265 #ifdef XK_dead_caron
4266 XK_dead_caron,
4267 #else
4269 #endif
4270 #ifdef XK_dead_doubleacute
4271 XK_dead_doubleacute,
4272 #else
4274 #endif
4275 #ifdef XK_dead_abovedot
4276 XK_dead_abovedot,
4277 #else
4279 #endif
4282 /* This is a list of Lisp names for special "accent" characters.
4283 It parallels lispy_accent_codes. */
4285 static char *lispy_accent_keys[] =
4287 "dead-circumflex",
4288 "dead-grave",
4289 "dead-tilde",
4290 "dead-diaeresis",
4291 "dead-macron",
4292 "dead-degree",
4293 "dead-acute",
4294 "dead-cedilla",
4295 "dead-breve",
4296 "dead-ogonek",
4297 "dead-caron",
4298 "dead-doubleacute",
4299 "dead-abovedot",
4302 #ifdef HAVE_NTGUI
4303 #define FUNCTION_KEY_OFFSET 0x0
4305 char *lispy_function_keys[] =
4307 0, /* 0 */
4309 0, /* VK_LBUTTON 0x01 */
4310 0, /* VK_RBUTTON 0x02 */
4311 "cancel", /* VK_CANCEL 0x03 */
4312 0, /* VK_MBUTTON 0x04 */
4314 0, 0, 0, /* 0x05 .. 0x07 */
4316 "backspace", /* VK_BACK 0x08 */
4317 "tab", /* VK_TAB 0x09 */
4319 0, 0, /* 0x0A .. 0x0B */
4321 "clear", /* VK_CLEAR 0x0C */
4322 "return", /* VK_RETURN 0x0D */
4324 0, 0, /* 0x0E .. 0x0F */
4326 0, /* VK_SHIFT 0x10 */
4327 0, /* VK_CONTROL 0x11 */
4328 0, /* VK_MENU 0x12 */
4329 "pause", /* VK_PAUSE 0x13 */
4330 "capslock", /* VK_CAPITAL 0x14 */
4332 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4334 "escape", /* VK_ESCAPE 0x1B */
4336 0, 0, 0, 0, /* 0x1C .. 0x1F */
4338 0, /* VK_SPACE 0x20 */
4339 "prior", /* VK_PRIOR 0x21 */
4340 "next", /* VK_NEXT 0x22 */
4341 "end", /* VK_END 0x23 */
4342 "home", /* VK_HOME 0x24 */
4343 "left", /* VK_LEFT 0x25 */
4344 "up", /* VK_UP 0x26 */
4345 "right", /* VK_RIGHT 0x27 */
4346 "down", /* VK_DOWN 0x28 */
4347 "select", /* VK_SELECT 0x29 */
4348 "print", /* VK_PRINT 0x2A */
4349 "execute", /* VK_EXECUTE 0x2B */
4350 "snapshot", /* VK_SNAPSHOT 0x2C */
4351 "insert", /* VK_INSERT 0x2D */
4352 "delete", /* VK_DELETE 0x2E */
4353 "help", /* VK_HELP 0x2F */
4355 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4357 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4359 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4361 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4363 0, 0, 0, 0, 0, 0, 0, 0, 0,
4364 0, 0, 0, 0, 0, 0, 0, 0, 0,
4365 0, 0, 0, 0, 0, 0, 0, 0,
4367 "lwindow", /* VK_LWIN 0x5B */
4368 "rwindow", /* VK_RWIN 0x5C */
4369 "apps", /* VK_APPS 0x5D */
4371 0, 0, /* 0x5E .. 0x5F */
4373 "kp-0", /* VK_NUMPAD0 0x60 */
4374 "kp-1", /* VK_NUMPAD1 0x61 */
4375 "kp-2", /* VK_NUMPAD2 0x62 */
4376 "kp-3", /* VK_NUMPAD3 0x63 */
4377 "kp-4", /* VK_NUMPAD4 0x64 */
4378 "kp-5", /* VK_NUMPAD5 0x65 */
4379 "kp-6", /* VK_NUMPAD6 0x66 */
4380 "kp-7", /* VK_NUMPAD7 0x67 */
4381 "kp-8", /* VK_NUMPAD8 0x68 */
4382 "kp-9", /* VK_NUMPAD9 0x69 */
4383 "kp-multiply", /* VK_MULTIPLY 0x6A */
4384 "kp-add", /* VK_ADD 0x6B */
4385 "kp-separator", /* VK_SEPARATOR 0x6C */
4386 "kp-subtract", /* VK_SUBTRACT 0x6D */
4387 "kp-decimal", /* VK_DECIMAL 0x6E */
4388 "kp-divide", /* VK_DIVIDE 0x6F */
4389 "f1", /* VK_F1 0x70 */
4390 "f2", /* VK_F2 0x71 */
4391 "f3", /* VK_F3 0x72 */
4392 "f4", /* VK_F4 0x73 */
4393 "f5", /* VK_F5 0x74 */
4394 "f6", /* VK_F6 0x75 */
4395 "f7", /* VK_F7 0x76 */
4396 "f8", /* VK_F8 0x77 */
4397 "f9", /* VK_F9 0x78 */
4398 "f10", /* VK_F10 0x79 */
4399 "f11", /* VK_F11 0x7A */
4400 "f12", /* VK_F12 0x7B */
4401 "f13", /* VK_F13 0x7C */
4402 "f14", /* VK_F14 0x7D */
4403 "f15", /* VK_F15 0x7E */
4404 "f16", /* VK_F16 0x7F */
4405 "f17", /* VK_F17 0x80 */
4406 "f18", /* VK_F18 0x81 */
4407 "f19", /* VK_F19 0x82 */
4408 "f20", /* VK_F20 0x83 */
4409 "f21", /* VK_F21 0x84 */
4410 "f22", /* VK_F22 0x85 */
4411 "f23", /* VK_F23 0x86 */
4412 "f24", /* VK_F24 0x87 */
4414 0, 0, 0, 0, /* 0x88 .. 0x8B */
4415 0, 0, 0, 0, /* 0x8C .. 0x8F */
4417 "kp-numlock", /* VK_NUMLOCK 0x90 */
4418 "scroll", /* VK_SCROLL 0x91 */
4420 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4421 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4422 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4423 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4424 "kp-end", /* VK_NUMPAD_END 0x96 */
4425 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4426 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4427 "kp-up", /* VK_NUMPAD_UP 0x99 */
4428 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4429 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4430 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4431 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4433 0, 0, /* 0x9E .. 0x9F */
4436 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4437 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4438 * No other API or message will distinguish left and right keys this way.
4440 /* 0xA0 .. 0xEF */
4442 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4443 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4444 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4445 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4446 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4448 /* 0xF0 .. 0xF5 */
4450 0, 0, 0, 0, 0, 0,
4452 "attn", /* VK_ATTN 0xF6 */
4453 "crsel", /* VK_CRSEL 0xF7 */
4454 "exsel", /* VK_EXSEL 0xF8 */
4455 "ereof", /* VK_EREOF 0xF9 */
4456 "play", /* VK_PLAY 0xFA */
4457 "zoom", /* VK_ZOOM 0xFB */
4458 "noname", /* VK_NONAME 0xFC */
4459 "pa1", /* VK_PA1 0xFD */
4460 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4461 0 /* 0xFF */
4464 #else /* not HAVE_NTGUI */
4466 #ifdef XK_kana_A
4467 static char *lispy_kana_keys[] =
4469 /* X Keysym value */
4470 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4471 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4472 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4473 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4474 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4475 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4476 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4477 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4478 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4479 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4480 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4481 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4482 "kana-i", "kana-u", "kana-e", "kana-o",
4483 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4484 "prolongedsound", "kana-A", "kana-I", "kana-U",
4485 "kana-E", "kana-O", "kana-KA", "kana-KI",
4486 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4487 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4488 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4489 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4490 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4491 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4492 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4493 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4494 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4495 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4496 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4497 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4499 #endif /* XK_kana_A */
4501 #define FUNCTION_KEY_OFFSET 0xff00
4503 /* You'll notice that this table is arranged to be conveniently
4504 indexed by X Windows keysym values. */
4505 static char *lispy_function_keys[] =
4507 /* X Keysym value */
4509 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4510 "backspace", "tab", "linefeed", "clear",
4511 0, "return", 0, 0,
4512 0, 0, 0, "pause", /* 0xff10...1f */
4513 0, 0, 0, 0, 0, 0, 0, "escape",
4514 0, 0, 0, 0,
4515 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4516 "romaji", "hiragana", "katakana", "hiragana-katakana",
4517 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4518 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4519 "eisu-toggle", /* 0xff30...3f */
4520 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4521 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4523 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4524 "down", "prior", "next", "end",
4525 "begin", 0, 0, 0, 0, 0, 0, 0,
4526 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4527 "print",
4528 "execute",
4529 "insert",
4530 0, /* 0xff64 */
4531 "undo",
4532 "redo",
4533 "menu",
4534 "find",
4535 "cancel",
4536 "help",
4537 "break", /* 0xff6b */
4539 0, 0, 0, 0,
4540 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4541 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4542 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4543 0, 0, 0, 0, 0, 0, 0, 0,
4544 "kp-tab", /* 0xff89 */
4545 0, 0, 0,
4546 "kp-enter", /* 0xff8d */
4547 0, 0, 0,
4548 "kp-f1", /* 0xff91 */
4549 "kp-f2",
4550 "kp-f3",
4551 "kp-f4",
4552 "kp-home", /* 0xff95 */
4553 "kp-left",
4554 "kp-up",
4555 "kp-right",
4556 "kp-down",
4557 "kp-prior", /* kp-page-up */
4558 "kp-next", /* kp-page-down */
4559 "kp-end",
4560 "kp-begin",
4561 "kp-insert",
4562 "kp-delete",
4563 0, /* 0xffa0 */
4564 0, 0, 0, 0, 0, 0, 0, 0, 0,
4565 "kp-multiply", /* 0xffaa */
4566 "kp-add",
4567 "kp-separator",
4568 "kp-subtract",
4569 "kp-decimal",
4570 "kp-divide", /* 0xffaf */
4571 "kp-0", /* 0xffb0 */
4572 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4573 0, /* 0xffba */
4574 0, 0,
4575 "kp-equal", /* 0xffbd */
4576 "f1", /* 0xffbe */ /* IsFunctionKey */
4577 "f2",
4578 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4579 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4580 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4581 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4582 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4583 0, 0, 0, 0, 0, 0, 0, 0,
4584 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4585 0, 0, 0, 0, 0, 0, 0, "delete"
4588 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4589 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4591 static char *iso_lispy_function_keys[] =
4593 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4594 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4595 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4596 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4597 "iso-lefttab", /* 0xfe20 */
4598 "iso-move-line-up", "iso-move-line-down",
4599 "iso-partial-line-up", "iso-partial-line-down",
4600 "iso-partial-space-left", "iso-partial-space-right",
4601 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4602 "iso-release-margin-left", "iso-release-margin-right",
4603 "iso-release-both-margins",
4604 "iso-fast-cursor-left", "iso-fast-cursor-right",
4605 "iso-fast-cursor-up", "iso-fast-cursor-down",
4606 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4607 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4610 #endif /* not HAVE_NTGUI */
4612 Lisp_Object Vlispy_mouse_stem;
4614 #ifdef WINDOWSNT
4615 /* mouse-wheel events are generated by the wheel on devices such as
4616 the MS Intellimouse. The wheel sits in between the left and right
4617 mouse buttons, and is typically used to scroll or zoom the window
4618 underneath the pointer. mouse-wheel events specify the object on
4619 which they operate, and a delta corresponding to the amount and
4620 direction that the wheel is rotated. Clicking the mouse-wheel
4621 generates a mouse-2 event. */
4622 static char *lispy_mouse_wheel_names[] =
4624 "mouse-wheel"
4627 #endif /* WINDOWSNT */
4629 /* drag-n-drop events are generated when a set of selected files are
4630 dragged from another application and dropped onto an Emacs window. */
4631 static char *lispy_drag_n_drop_names[] =
4633 "drag-n-drop"
4636 /* Scroll bar parts. */
4637 Lisp_Object Qabove_handle, Qhandle, Qbelow_handle;
4638 Lisp_Object Qup, Qdown, Qbottom, Qend_scroll;
4639 Lisp_Object Qtop, Qratio;
4641 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4642 Lisp_Object *scroll_bar_parts[] = {
4643 &Qabove_handle, &Qhandle, &Qbelow_handle,
4644 &Qup, &Qdown, &Qtop, &Qbottom, &Qend_scroll, &Qratio
4647 /* User signal events. */
4648 Lisp_Object Qusr1_signal, Qusr2_signal;
4650 Lisp_Object *lispy_user_signals[] =
4652 &Qusr1_signal, &Qusr2_signal
4656 /* A vector, indexed by button number, giving the down-going location
4657 of currently depressed buttons, both scroll bar and non-scroll bar.
4659 The elements have the form
4660 (BUTTON-NUMBER MODIFIER-MASK . REST)
4661 where REST is the cdr of a position as it would be reported in the event.
4663 The make_lispy_event function stores positions here to tell the
4664 difference between click and drag events, and to store the starting
4665 location to be included in drag events. */
4667 static Lisp_Object button_down_location;
4669 /* Information about the most recent up-going button event: Which
4670 button, what location, and what time. */
4672 static int last_mouse_button;
4673 static int last_mouse_x;
4674 static int last_mouse_y;
4675 static unsigned long button_down_time;
4677 /* The maximum time between clicks to make a double-click, or Qnil to
4678 disable double-click detection, or Qt for no time limit. */
4680 Lisp_Object Vdouble_click_time;
4682 /* Maximum number of pixels the mouse may be moved between clicks
4683 to make a double-click. */
4685 EMACS_INT double_click_fuzz;
4687 /* The number of clicks in this multiple-click. */
4689 int double_click_count;
4691 /* Given a struct input_event, build the lisp event which represents
4692 it. If EVENT is 0, build a mouse movement event from the mouse
4693 movement buffer, which should have a movement event in it.
4695 Note that events must be passed to this function in the order they
4696 are received; this function stores the location of button presses
4697 in order to build drag events when the button is released. */
4699 static Lisp_Object
4700 make_lispy_event (event)
4701 struct input_event *event;
4703 int i;
4705 switch (SWITCH_ENUM_CAST (event->kind))
4707 /* A simple keystroke. */
4708 case ascii_keystroke:
4710 Lisp_Object lispy_c;
4711 int c = event->code & 0377;
4712 /* Turn ASCII characters into control characters
4713 when proper. */
4714 if (event->modifiers & ctrl_modifier)
4715 c = make_ctrl_char (c);
4717 /* Add in the other modifier bits. We took care of ctrl_modifier
4718 just above, and the shift key was taken care of by the X code,
4719 and applied to control characters by make_ctrl_char. */
4720 c |= (event->modifiers
4721 & (meta_modifier | alt_modifier
4722 | hyper_modifier | super_modifier));
4723 /* Distinguish Shift-SPC from SPC. */
4724 if ((event->code & 0377) == 040
4725 && event->modifiers & shift_modifier)
4726 c |= shift_modifier;
4727 button_down_time = 0;
4728 XSETFASTINT (lispy_c, c);
4729 return lispy_c;
4732 case multibyte_char_keystroke:
4734 Lisp_Object lispy_c;
4736 XSETFASTINT (lispy_c, event->code);
4737 return lispy_c;
4740 /* A function key. The symbol may need to have modifier prefixes
4741 tacked onto it. */
4742 case non_ascii_keystroke:
4743 button_down_time = 0;
4745 for (i = 0; i < sizeof (lispy_accent_codes) / sizeof (int); i++)
4746 if (event->code == lispy_accent_codes[i])
4747 return modify_event_symbol (i,
4748 event->modifiers,
4749 Qfunction_key, Qnil,
4750 lispy_accent_keys, &accent_key_syms,
4751 (sizeof (lispy_accent_keys)
4752 / sizeof (lispy_accent_keys[0])));
4754 #ifdef XK_kana_A
4755 if (event->code >= 0x400 && event->code < 0x500)
4756 return modify_event_symbol (event->code - 0x400,
4757 event->modifiers & ~shift_modifier,
4758 Qfunction_key, Qnil,
4759 lispy_kana_keys, &func_key_syms,
4760 (sizeof (lispy_kana_keys)
4761 / sizeof (lispy_kana_keys[0])));
4762 #endif /* XK_kana_A */
4764 #ifdef ISO_FUNCTION_KEY_OFFSET
4765 if (event->code < FUNCTION_KEY_OFFSET
4766 && event->code >= ISO_FUNCTION_KEY_OFFSET)
4767 return modify_event_symbol (event->code - ISO_FUNCTION_KEY_OFFSET,
4768 event->modifiers,
4769 Qfunction_key, Qnil,
4770 iso_lispy_function_keys, &func_key_syms,
4771 (sizeof (iso_lispy_function_keys)
4772 / sizeof (iso_lispy_function_keys[0])));
4773 #endif
4775 /* Handle system-specific or unknown keysyms. */
4776 if (event->code & (1 << 28)
4777 || event->code - FUNCTION_KEY_OFFSET < 0
4778 || (event->code - FUNCTION_KEY_OFFSET
4779 >= sizeof lispy_function_keys / sizeof *lispy_function_keys)
4780 || !lispy_function_keys[event->code - FUNCTION_KEY_OFFSET])
4782 /* We need to use an alist rather than a vector as the cache
4783 since we can't make a vector long enuf. */
4784 if (NILP (current_kboard->system_key_syms))
4785 current_kboard->system_key_syms = Fcons (Qnil, Qnil);
4786 return modify_event_symbol (event->code,
4787 event->modifiers,
4788 Qfunction_key,
4789 current_kboard->Vsystem_key_alist,
4790 0, &current_kboard->system_key_syms,
4791 (unsigned) -1);
4794 return modify_event_symbol (event->code - FUNCTION_KEY_OFFSET,
4795 event->modifiers,
4796 Qfunction_key, Qnil,
4797 lispy_function_keys, &func_key_syms,
4798 (sizeof (lispy_function_keys)
4799 / sizeof (lispy_function_keys[0])));
4801 #ifdef HAVE_MOUSE
4802 /* A mouse click. Figure out where it is, decide whether it's
4803 a press, click or drag, and build the appropriate structure. */
4804 case mouse_click:
4805 #ifndef USE_TOOLKIT_SCROLL_BARS
4806 case scroll_bar_click:
4807 #endif
4809 int button = event->code;
4810 int is_double;
4811 Lisp_Object position;
4812 Lisp_Object *start_pos_ptr;
4813 Lisp_Object start_pos;
4814 Lisp_Object window;
4816 position = Qnil;
4818 /* Build the position as appropriate for this mouse click. */
4819 if (event->kind == mouse_click)
4821 int part;
4822 struct frame *f = XFRAME (event->frame_or_window);
4823 Lisp_Object posn;
4824 Lisp_Object string_info = Qnil;
4825 int row, column;
4827 /* Ignore mouse events that were made on frame that
4828 have been deleted. */
4829 if (! FRAME_LIVE_P (f))
4830 return Qnil;
4832 /* EVENT->x and EVENT->y are frame-relative pixel
4833 coordinates at this place. Under old redisplay, COLUMN
4834 and ROW are set to frame relative glyph coordinates
4835 which are then used to determine whether this click is
4836 in a menu (non-toolkit version). */
4837 pixel_to_glyph_coords (f, XINT (event->x), XINT (event->y),
4838 &column, &row, NULL, 1);
4840 #ifndef USE_X_TOOLKIT
4841 /* In the non-toolkit version, clicks on the menu bar
4842 are ordinary button events in the event buffer.
4843 Distinguish them, and invoke the menu.
4845 (In the toolkit version, the toolkit handles the menu bar
4846 and Emacs doesn't know about it until after the user
4847 makes a selection.) */
4848 if (row >= 0 && row < FRAME_MENU_BAR_LINES (f)
4849 && (event->modifiers & down_modifier))
4851 Lisp_Object items, item;
4852 int hpos;
4853 int i;
4855 #if 0
4856 /* Activate the menu bar on the down event. If the
4857 up event comes in before the menu code can deal with it,
4858 just ignore it. */
4859 if (! (event->modifiers & down_modifier))
4860 return Qnil;
4861 #endif
4863 /* Find the menu bar item under `column'. */
4864 item = Qnil;
4865 items = FRAME_MENU_BAR_ITEMS (f);
4866 for (i = 0; i < XVECTOR (items)->size; i += 4)
4868 Lisp_Object pos, string;
4869 string = AREF (items, i + 1);
4870 pos = AREF (items, i + 3);
4871 if (NILP (string))
4872 break;
4873 if (column >= XINT (pos)
4874 && column < XINT (pos) + XSTRING (string)->size)
4876 item = AREF (items, i);
4877 break;
4881 /* ELisp manual 2.4b says (x y) are window relative but
4882 code says they are frame-relative. */
4883 position
4884 = Fcons (event->frame_or_window,
4885 Fcons (Qmenu_bar,
4886 Fcons (Fcons (event->x, event->y),
4887 Fcons (make_number (event->timestamp),
4888 Qnil))));
4890 return Fcons (item, Fcons (position, Qnil));
4892 #endif /* not USE_X_TOOLKIT */
4894 /* Set `window' to the window under frame pixel coordinates
4895 event->x/event->y. */
4896 window = window_from_coordinates (f, XINT (event->x),
4897 XINT (event->y), &part, 0);
4899 if (!WINDOWP (window))
4901 window = event->frame_or_window;
4902 posn = Qnil;
4904 else
4906 /* It's a click in window window at frame coordinates
4907 event->x/ event->y. */
4908 struct window *w = XWINDOW (window);
4910 /* Get window relative coordinates. Original code
4911 `rounded' this to glyph boundaries. */
4912 int wx = FRAME_TO_WINDOW_PIXEL_X (w, XINT (event->x));
4913 int wy = FRAME_TO_WINDOW_PIXEL_Y (w, XINT (event->y));
4915 /* Set event coordinates to window-relative coordinates
4916 for constructing the Lisp event below. */
4917 XSETINT (event->x, wx);
4918 XSETINT (event->y, wy);
4920 if (part == 1 || part == 3)
4922 /* Mode line or header line. Look for a string under
4923 the mouse that may have a `local-map' property. */
4924 Lisp_Object string;
4925 int charpos;
4927 posn = part == 1 ? Qmode_line : Qheader_line;
4928 string = mode_line_string (w, wx, wy, part == 1, &charpos);
4929 if (STRINGP (string))
4930 string_info = Fcons (string, make_number (charpos));
4932 else if (part == 2)
4933 posn = Qvertical_line;
4934 else if (part == 6 || part == 7)
4936 int charpos;
4937 Lisp_Object object = marginal_area_string (w, wx, wy, part,
4938 &charpos);
4939 posn = (part == 6) ? Qleft_margin : Qright_margin;
4940 if (STRINGP (object))
4941 string_info = Fcons (object, make_number (charpos));
4943 else
4945 Lisp_Object object;
4946 struct display_pos p;
4947 buffer_posn_from_coords (w, &wx, &wy, &object, &p);
4948 posn = make_number (CHARPOS (p.pos));
4949 if (STRINGP (object))
4950 string_info
4951 = Fcons (object,
4952 make_number (CHARPOS (p.string_pos)));
4956 position
4957 = Fcons (window,
4958 Fcons (posn,
4959 Fcons (Fcons (event->x, event->y),
4960 Fcons (make_number (event->timestamp),
4961 (NILP (string_info)
4962 ? Qnil
4963 : Fcons (string_info, Qnil))))));
4965 #ifndef USE_TOOLKIT_SCROLL_BARS
4966 else
4968 /* It's a scrollbar click. */
4969 Lisp_Object portion_whole;
4970 Lisp_Object part;
4972 window = event->frame_or_window;
4973 portion_whole = Fcons (event->x, event->y);
4974 part = *scroll_bar_parts[(int) event->part];
4976 position
4977 = Fcons (window,
4978 Fcons (Qvertical_scroll_bar,
4979 Fcons (portion_whole,
4980 Fcons (make_number (event->timestamp),
4981 Fcons (part, Qnil)))));
4983 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4985 if (button >= ASIZE (button_down_location))
4987 button_down_location = larger_vector (button_down_location,
4988 button + 1, Qnil);
4989 mouse_syms = larger_vector (mouse_syms, button + 1, Qnil);
4992 start_pos_ptr = &AREF (button_down_location, button);
4993 start_pos = *start_pos_ptr;
4994 *start_pos_ptr = Qnil;
4997 /* On window-system frames, use the value of
4998 double-click-fuzz as is. On other frames, interpret it
4999 as a multiple of 1/8 characters. */
5000 struct frame *f;
5001 int fuzz;
5003 if (WINDOWP (event->frame_or_window))
5004 f = XFRAME (XWINDOW (event->frame_or_window)->frame);
5005 else if (FRAMEP (event->frame_or_window))
5006 f = XFRAME (event->frame_or_window);
5007 else
5008 abort ();
5010 if (FRAME_WINDOW_P (f))
5011 fuzz = double_click_fuzz;
5012 else
5013 fuzz = double_click_fuzz / 8;
5015 is_double = (button == last_mouse_button
5016 && (abs (XINT (event->x) - last_mouse_x) <= fuzz)
5017 && (abs (XINT (event->y) - last_mouse_y) <= fuzz)
5018 && button_down_time != 0
5019 && (EQ (Vdouble_click_time, Qt)
5020 || (INTEGERP (Vdouble_click_time)
5021 && ((int)(event->timestamp - button_down_time)
5022 < XINT (Vdouble_click_time)))));
5025 last_mouse_button = button;
5026 last_mouse_x = XINT (event->x);
5027 last_mouse_y = XINT (event->y);
5029 /* If this is a button press, squirrel away the location, so
5030 we can decide later whether it was a click or a drag. */
5031 if (event->modifiers & down_modifier)
5033 if (is_double)
5035 double_click_count++;
5036 event->modifiers |= ((double_click_count > 2)
5037 ? triple_modifier
5038 : double_modifier);
5040 else
5041 double_click_count = 1;
5042 button_down_time = event->timestamp;
5043 *start_pos_ptr = Fcopy_alist (position);
5046 /* Now we're releasing a button - check the co-ordinates to
5047 see if this was a click or a drag. */
5048 else if (event->modifiers & up_modifier)
5050 /* If we did not see a down before this up, ignore the up.
5051 Probably this happened because the down event chose a
5052 menu item. It would be an annoyance to treat the
5053 release of the button that chose the menu item as a
5054 separate event. */
5056 if (!CONSP (start_pos))
5057 return Qnil;
5059 event->modifiers &= ~up_modifier;
5060 #if 0 /* Formerly we treated an up with no down as a click event. */
5061 if (!CONSP (start_pos))
5062 event->modifiers |= click_modifier;
5063 else
5064 #endif
5066 Lisp_Object down;
5067 EMACS_INT xdiff = double_click_fuzz, ydiff = double_click_fuzz;
5069 /* The third element of every position
5070 should be the (x,y) pair. */
5071 down = Fcar (Fcdr (Fcdr (start_pos)));
5072 if (CONSP (down)
5073 && INTEGERP (XCAR (down)) && INTEGERP (XCDR (down)))
5075 xdiff = XFASTINT (event->x) - XFASTINT (XCAR (down));
5076 ydiff = XFASTINT (event->y) - XFASTINT (XCDR (down));
5079 if (xdiff < double_click_fuzz && xdiff > - double_click_fuzz
5080 && ydiff < double_click_fuzz
5081 && ydiff > - double_click_fuzz)
5082 /* Mouse hasn't moved (much). */
5083 event->modifiers |= click_modifier;
5084 else
5086 button_down_time = 0;
5087 event->modifiers |= drag_modifier;
5090 /* Don't check is_double; treat this as multiple
5091 if the down-event was multiple. */
5092 if (double_click_count > 1)
5093 event->modifiers |= ((double_click_count > 2)
5094 ? triple_modifier
5095 : double_modifier);
5098 else
5099 /* Every mouse event should either have the down_modifier or
5100 the up_modifier set. */
5101 abort ();
5104 /* Get the symbol we should use for the mouse click. */
5105 Lisp_Object head;
5107 head = modify_event_symbol (button,
5108 event->modifiers,
5109 Qmouse_click, Vlispy_mouse_stem,
5110 NULL,
5111 &mouse_syms,
5112 XVECTOR (mouse_syms)->size);
5113 if (event->modifiers & drag_modifier)
5114 return Fcons (head,
5115 Fcons (start_pos,
5116 Fcons (position,
5117 Qnil)));
5118 else if (event->modifiers & (double_modifier | triple_modifier))
5119 return Fcons (head,
5120 Fcons (position,
5121 Fcons (make_number (double_click_count),
5122 Qnil)));
5123 else
5124 return Fcons (head,
5125 Fcons (position,
5126 Qnil));
5130 #if USE_TOOLKIT_SCROLL_BARS
5132 /* We don't have down and up events if using toolkit scroll bars,
5133 so make this always a click event. Store in the `part' of
5134 the Lisp event a symbol which maps to the following actions:
5136 `above_handle' page up
5137 `below_handle' page down
5138 `up' line up
5139 `down' line down
5140 `top' top of buffer
5141 `bottom' bottom of buffer
5142 `handle' thumb has been dragged.
5143 `end-scroll' end of interaction with scroll bar
5145 The incoming input_event contains in its `part' member an
5146 index of type `enum scroll_bar_part' which we can use as an
5147 index in scroll_bar_parts to get the appropriate symbol. */
5149 case scroll_bar_click:
5151 Lisp_Object position, head, window, portion_whole, part;
5153 window = event->frame_or_window;
5154 portion_whole = Fcons (event->x, event->y);
5155 part = *scroll_bar_parts[(int) event->part];
5157 position
5158 = Fcons (window,
5159 Fcons (Qvertical_scroll_bar,
5160 Fcons (portion_whole,
5161 Fcons (make_number (event->timestamp),
5162 Fcons (part, Qnil)))));
5164 /* Always treat scroll bar events as clicks. */
5165 event->modifiers |= click_modifier;
5167 /* Get the symbol we should use for the mouse click. */
5168 head = modify_event_symbol (event->code,
5169 event->modifiers,
5170 Qmouse_click,
5171 Vlispy_mouse_stem,
5172 NULL, &mouse_syms,
5173 XVECTOR (mouse_syms)->size);
5174 return Fcons (head, Fcons (position, Qnil));
5177 #endif /* USE_TOOLKIT_SCROLL_BARS */
5179 #ifdef WINDOWSNT
5180 case w32_scroll_bar_click:
5182 int button = event->code;
5183 int is_double;
5184 Lisp_Object position;
5185 Lisp_Object *start_pos_ptr;
5186 Lisp_Object start_pos;
5189 Lisp_Object window;
5190 Lisp_Object portion_whole;
5191 Lisp_Object part;
5193 window = event->frame_or_window;
5194 portion_whole = Fcons (event->x, event->y);
5195 part = *scroll_bar_parts[(int) event->part];
5197 position
5198 = Fcons (window,
5199 Fcons (Qvertical_scroll_bar,
5200 Fcons (portion_whole,
5201 Fcons (make_number (event->timestamp),
5202 Fcons (part, Qnil)))));
5205 /* Always treat W32 scroll bar events as clicks. */
5206 event->modifiers |= click_modifier;
5209 /* Get the symbol we should use for the mouse click. */
5210 Lisp_Object head;
5212 head = modify_event_symbol (button,
5213 event->modifiers,
5214 Qmouse_click,
5215 Vlispy_mouse_stem,
5216 NULL, &mouse_syms,
5217 XVECTOR (mouse_syms)->size);
5218 return Fcons (head,
5219 Fcons (position,
5220 Qnil));
5223 case mouse_wheel:
5225 int part;
5226 FRAME_PTR f = XFRAME (event->frame_or_window);
5227 Lisp_Object window;
5228 Lisp_Object posn;
5229 Lisp_Object head, position;
5230 int row, column;
5232 /* Ignore mouse events that were made on frame that
5233 have been deleted. */
5234 if (! FRAME_LIVE_P (f))
5235 return Qnil;
5236 pixel_to_glyph_coords (f, XINT (event->x), XINT (event->y),
5237 &column, &row, NULL, 1);
5238 window = window_from_coordinates (f, XINT (event->x),
5239 XINT (event->y), &part, 0);
5241 if (!WINDOWP (window))
5243 window = event->frame_or_window;
5244 posn = Qnil;
5246 else
5248 int pixcolumn, pixrow;
5249 column -= XINT (XWINDOW (window)->left);
5250 row -= XINT (XWINDOW (window)->top);
5251 glyph_to_pixel_coords (XWINDOW(window), column, row,
5252 &pixcolumn, &pixrow);
5253 XSETINT (event->x, pixcolumn);
5254 XSETINT (event->y, pixrow);
5256 if (part == 1)
5257 posn = Qmode_line;
5258 else if (part == 2)
5259 posn = Qvertical_line;
5260 else if (part == 3)
5261 posn = Qheader_line;
5262 else
5264 Lisp_Object object;
5265 struct display_pos p;
5266 buffer_posn_from_coords (XWINDOW (window), &column, &row,
5267 &object, &p);
5268 posn = make_number (CHARPOS (p.pos));
5273 Lisp_Object head, position;
5275 position
5276 = Fcons (window,
5277 Fcons (posn,
5278 Fcons (Fcons (event->x, event->y),
5279 Fcons (make_number (event->timestamp),
5280 Qnil))));
5282 head = modify_event_symbol (0, event->modifiers,
5283 Qmouse_wheel, Qnil,
5284 lispy_mouse_wheel_names,
5285 &mouse_wheel_syms, 1);
5286 return Fcons (head,
5287 Fcons (position,
5288 /* Insert 1 here so event-click-count works. */
5289 Fcons (make_number (1),
5290 Fcons (make_number (event->code),
5291 Qnil))));
5294 #endif /* WINDOWSNT */
5296 case drag_n_drop:
5298 int part;
5299 FRAME_PTR f;
5300 Lisp_Object window;
5301 Lisp_Object posn;
5302 Lisp_Object files;
5304 /* The frame_or_window field should be a cons of the frame in
5305 which the event occurred and a list of the filenames
5306 dropped. */
5307 if (! CONSP (event->frame_or_window))
5308 abort ();
5310 f = XFRAME (XCAR (event->frame_or_window));
5311 files = XCDR (event->frame_or_window);
5313 /* Ignore mouse events that were made on frames that
5314 have been deleted. */
5315 if (! FRAME_LIVE_P (f))
5316 return Qnil;
5318 window = window_from_coordinates (f, XINT (event->x),
5319 XINT (event->y), &part, 0);
5321 if (!WINDOWP (window))
5323 window = XCAR (event->frame_or_window);
5324 posn = Qnil;
5326 else
5328 /* It's an event in window `window' at frame coordinates
5329 event->x/ event->y. */
5330 struct window *w = XWINDOW (window);
5332 /* Get window relative coordinates. */
5333 int wx = FRAME_TO_WINDOW_PIXEL_X (w, XINT (event->x));
5334 int wy = FRAME_TO_WINDOW_PIXEL_Y (w, XINT (event->y));
5336 /* Set event coordinates to window-relative coordinates
5337 for constructing the Lisp event below. */
5338 XSETINT (event->x, wx);
5339 XSETINT (event->y, wy);
5341 if (part == 1)
5342 posn = Qmode_line;
5343 else if (part == 2)
5344 posn = Qvertical_line;
5345 else if (part == 3)
5346 posn = Qheader_line;
5347 else
5349 Lisp_Object object;
5350 struct display_pos p;
5351 buffer_posn_from_coords (w, &wx, &wy, &object, &p);
5352 posn = make_number (CHARPOS (p.pos));
5357 Lisp_Object head, position;
5359 position
5360 = Fcons (window,
5361 Fcons (posn,
5362 Fcons (Fcons (event->x, event->y),
5363 Fcons (make_number (event->timestamp),
5364 Qnil))));
5366 head = modify_event_symbol (0, event->modifiers,
5367 Qdrag_n_drop, Qnil,
5368 lispy_drag_n_drop_names,
5369 &drag_n_drop_syms, 1);
5370 return Fcons (head,
5371 Fcons (position,
5372 Fcons (files,
5373 Qnil)));
5376 #endif /* HAVE_MOUSE */
5378 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS)
5379 case MENU_BAR_EVENT:
5380 if (EQ (event->arg, event->frame_or_window))
5381 /* This is the prefix key. We translate this to
5382 `(menu_bar)' because the code in keyboard.c for menu
5383 events, which we use, relies on this. */
5384 return Fcons (Qmenu_bar, Qnil);
5385 return event->arg;
5386 #endif
5388 case TOOL_BAR_EVENT:
5389 if (EQ (event->arg, event->frame_or_window))
5390 /* This is the prefix key. We translate this to
5391 `(tool_bar)' because the code in keyboard.c for tool bar
5392 events, which we use, relies on this. */
5393 return Fcons (Qtool_bar, Qnil);
5394 else if (SYMBOLP (event->arg))
5395 return apply_modifiers (event->modifiers, event->arg);
5396 return event->arg;
5398 case USER_SIGNAL_EVENT:
5399 /* A user signal. */
5400 return *lispy_user_signals[event->code];
5402 case save_session_event:
5403 return Qsave_session;
5405 /* The 'kind' field of the event is something we don't recognize. */
5406 default:
5407 abort ();
5411 #ifdef HAVE_MOUSE
5413 static Lisp_Object
5414 make_lispy_movement (frame, bar_window, part, x, y, time)
5415 FRAME_PTR frame;
5416 Lisp_Object bar_window;
5417 enum scroll_bar_part part;
5418 Lisp_Object x, y;
5419 unsigned long time;
5421 /* Is it a scroll bar movement? */
5422 if (frame && ! NILP (bar_window))
5424 Lisp_Object part_sym;
5426 part_sym = *scroll_bar_parts[(int) part];
5427 return Fcons (Qscroll_bar_movement,
5428 (Fcons (Fcons (bar_window,
5429 Fcons (Qvertical_scroll_bar,
5430 Fcons (Fcons (x, y),
5431 Fcons (make_number (time),
5432 Fcons (part_sym,
5433 Qnil))))),
5434 Qnil)));
5437 /* Or is it an ordinary mouse movement? */
5438 else
5440 int area;
5441 Lisp_Object window;
5442 Lisp_Object posn;
5444 if (frame)
5445 /* It's in a frame; which window on that frame? */
5446 window = window_from_coordinates (frame, XINT (x), XINT (y), &area, 0);
5447 else
5448 window = Qnil;
5450 if (WINDOWP (window))
5452 struct window *w = XWINDOW (window);
5453 int wx, wy;
5455 /* Get window relative coordinates. */
5456 wx = FRAME_TO_WINDOW_PIXEL_X (w, XINT (x));
5457 wy = FRAME_TO_WINDOW_PIXEL_Y (w, XINT (y));
5458 XSETINT (x, wx);
5459 XSETINT (y, wy);
5461 if (area == 1)
5462 posn = Qmode_line;
5463 else if (area == 2)
5464 posn = Qvertical_line;
5465 else if (area == 3)
5466 posn = Qheader_line;
5467 else
5469 Lisp_Object object;
5470 struct display_pos p;
5471 buffer_posn_from_coords (w, &wx, &wy, &object, &p);
5472 posn = make_number (CHARPOS (p.pos));
5475 else if (frame != 0)
5477 XSETFRAME (window, frame);
5478 posn = Qnil;
5480 else
5482 window = Qnil;
5483 posn = Qnil;
5484 XSETFASTINT (x, 0);
5485 XSETFASTINT (y, 0);
5488 return Fcons (Qmouse_movement,
5489 Fcons (Fcons (window,
5490 Fcons (posn,
5491 Fcons (Fcons (x, y),
5492 Fcons (make_number (time),
5493 Qnil)))),
5494 Qnil));
5498 #endif /* HAVE_MOUSE */
5500 /* Construct a switch frame event. */
5501 static Lisp_Object
5502 make_lispy_switch_frame (frame)
5503 Lisp_Object frame;
5505 return Fcons (Qswitch_frame, Fcons (frame, Qnil));
5508 /* Manipulating modifiers. */
5510 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5512 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5513 SYMBOL's name of the end of the modifiers; the string from this
5514 position is the unmodified symbol name.
5516 This doesn't use any caches. */
5518 static int
5519 parse_modifiers_uncached (symbol, modifier_end)
5520 Lisp_Object symbol;
5521 int *modifier_end;
5523 struct Lisp_String *name;
5524 int i;
5525 int modifiers;
5527 CHECK_SYMBOL (symbol);
5529 modifiers = 0;
5530 name = XSTRING (SYMBOL_NAME (symbol));
5532 for (i = 0; i+2 <= STRING_BYTES (name); )
5534 int this_mod_end = 0;
5535 int this_mod = 0;
5537 /* See if the name continues with a modifier word.
5538 Check that the word appears, but don't check what follows it.
5539 Set this_mod and this_mod_end to record what we find. */
5541 switch (name->data[i])
5543 #define SINGLE_LETTER_MOD(BIT) \
5544 (this_mod_end = i + 1, this_mod = BIT)
5546 case 'A':
5547 SINGLE_LETTER_MOD (alt_modifier);
5548 break;
5550 case 'C':
5551 SINGLE_LETTER_MOD (ctrl_modifier);
5552 break;
5554 case 'H':
5555 SINGLE_LETTER_MOD (hyper_modifier);
5556 break;
5558 case 'M':
5559 SINGLE_LETTER_MOD (meta_modifier);
5560 break;
5562 case 'S':
5563 SINGLE_LETTER_MOD (shift_modifier);
5564 break;
5566 case 's':
5567 SINGLE_LETTER_MOD (super_modifier);
5568 break;
5570 #undef SINGLE_LETTER_MOD
5573 /* If we found no modifier, stop looking for them. */
5574 if (this_mod_end == 0)
5575 break;
5577 /* Check there is a dash after the modifier, so that it
5578 really is a modifier. */
5579 if (this_mod_end >= STRING_BYTES (name)
5580 || name->data[this_mod_end] != '-')
5581 break;
5583 /* This modifier is real; look for another. */
5584 modifiers |= this_mod;
5585 i = this_mod_end + 1;
5588 /* Should we include the `click' modifier? */
5589 if (! (modifiers & (down_modifier | drag_modifier
5590 | double_modifier | triple_modifier))
5591 && i + 7 == STRING_BYTES (name)
5592 && strncmp (name->data + i, "mouse-", 6) == 0
5593 && ('0' <= name->data[i + 6] && name->data[i + 6] <= '9'))
5594 modifiers |= click_modifier;
5596 if (modifier_end)
5597 *modifier_end = i;
5599 return modifiers;
5602 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5603 prepended to the string BASE[0..BASE_LEN-1].
5604 This doesn't use any caches. */
5605 static Lisp_Object
5606 apply_modifiers_uncached (modifiers, base, base_len, base_len_byte)
5607 int modifiers;
5608 char *base;
5609 int base_len, base_len_byte;
5611 /* Since BASE could contain nulls, we can't use intern here; we have
5612 to use Fintern, which expects a genuine Lisp_String, and keeps a
5613 reference to it. */
5614 char *new_mods
5615 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5616 int mod_len;
5619 char *p = new_mods;
5621 /* Only the event queue may use the `up' modifier; it should always
5622 be turned into a click or drag event before presented to lisp code. */
5623 if (modifiers & up_modifier)
5624 abort ();
5626 if (modifiers & alt_modifier) { *p++ = 'A'; *p++ = '-'; }
5627 if (modifiers & ctrl_modifier) { *p++ = 'C'; *p++ = '-'; }
5628 if (modifiers & hyper_modifier) { *p++ = 'H'; *p++ = '-'; }
5629 if (modifiers & meta_modifier) { *p++ = 'M'; *p++ = '-'; }
5630 if (modifiers & shift_modifier) { *p++ = 'S'; *p++ = '-'; }
5631 if (modifiers & super_modifier) { *p++ = 's'; *p++ = '-'; }
5632 if (modifiers & double_modifier) { strcpy (p, "double-"); p += 7; }
5633 if (modifiers & triple_modifier) { strcpy (p, "triple-"); p += 7; }
5634 if (modifiers & down_modifier) { strcpy (p, "down-"); p += 5; }
5635 if (modifiers & drag_modifier) { strcpy (p, "drag-"); p += 5; }
5636 /* The click modifier is denoted by the absence of other modifiers. */
5638 *p = '\0';
5640 mod_len = p - new_mods;
5644 Lisp_Object new_name;
5646 new_name = make_uninit_multibyte_string (mod_len + base_len,
5647 mod_len + base_len_byte);
5648 bcopy (new_mods, XSTRING (new_name)->data, mod_len);
5649 bcopy (base, XSTRING (new_name)->data + mod_len, base_len_byte);
5651 return Fintern (new_name, Qnil);
5656 static char *modifier_names[] =
5658 "up", "down", "drag", "click", "double", "triple", 0, 0,
5659 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5660 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
5662 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
5664 static Lisp_Object modifier_symbols;
5666 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5667 static Lisp_Object
5668 lispy_modifier_list (modifiers)
5669 int modifiers;
5671 Lisp_Object modifier_list;
5672 int i;
5674 modifier_list = Qnil;
5675 for (i = 0; (1<<i) <= modifiers && i < NUM_MOD_NAMES; i++)
5676 if (modifiers & (1<<i))
5677 modifier_list = Fcons (XVECTOR (modifier_symbols)->contents[i],
5678 modifier_list);
5680 return modifier_list;
5684 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
5685 where UNMODIFIED is the unmodified form of SYMBOL,
5686 MASK is the set of modifiers present in SYMBOL's name.
5687 This is similar to parse_modifiers_uncached, but uses the cache in
5688 SYMBOL's Qevent_symbol_element_mask property, and maintains the
5689 Qevent_symbol_elements property. */
5691 Lisp_Object
5692 parse_modifiers (symbol)
5693 Lisp_Object symbol;
5695 Lisp_Object elements;
5697 elements = Fget (symbol, Qevent_symbol_element_mask);
5698 if (CONSP (elements))
5699 return elements;
5700 else
5702 int end;
5703 int modifiers = parse_modifiers_uncached (symbol, &end);
5704 Lisp_Object unmodified;
5705 Lisp_Object mask;
5707 unmodified = Fintern (make_string (XSTRING (SYMBOL_NAME (symbol))->data + end,
5708 STRING_BYTES (XSTRING (SYMBOL_NAME (symbol))) - end),
5709 Qnil);
5711 if (modifiers & ~VALMASK)
5712 abort ();
5713 XSETFASTINT (mask, modifiers);
5714 elements = Fcons (unmodified, Fcons (mask, Qnil));
5716 /* Cache the parsing results on SYMBOL. */
5717 Fput (symbol, Qevent_symbol_element_mask,
5718 elements);
5719 Fput (symbol, Qevent_symbol_elements,
5720 Fcons (unmodified, lispy_modifier_list (modifiers)));
5722 /* Since we know that SYMBOL is modifiers applied to unmodified,
5723 it would be nice to put that in unmodified's cache.
5724 But we can't, since we're not sure that parse_modifiers is
5725 canonical. */
5727 return elements;
5731 /* Apply the modifiers MODIFIERS to the symbol BASE.
5732 BASE must be unmodified.
5734 This is like apply_modifiers_uncached, but uses BASE's
5735 Qmodifier_cache property, if present. It also builds
5736 Qevent_symbol_elements properties, since it has that info anyway.
5738 apply_modifiers copies the value of BASE's Qevent_kind property to
5739 the modified symbol. */
5740 static Lisp_Object
5741 apply_modifiers (modifiers, base)
5742 int modifiers;
5743 Lisp_Object base;
5745 Lisp_Object cache, index, entry, new_symbol;
5747 /* Mask out upper bits. We don't know where this value's been. */
5748 modifiers &= VALMASK;
5750 /* The click modifier never figures into cache indices. */
5751 cache = Fget (base, Qmodifier_cache);
5752 XSETFASTINT (index, (modifiers & ~click_modifier));
5753 entry = assq_no_quit (index, cache);
5755 if (CONSP (entry))
5756 new_symbol = XCDR (entry);
5757 else
5759 /* We have to create the symbol ourselves. */
5760 new_symbol = apply_modifiers_uncached (modifiers,
5761 XSTRING (SYMBOL_NAME (base))->data,
5762 XSTRING (SYMBOL_NAME (base))->size,
5763 STRING_BYTES (XSTRING (SYMBOL_NAME (base))));
5765 /* Add the new symbol to the base's cache. */
5766 entry = Fcons (index, new_symbol);
5767 Fput (base, Qmodifier_cache, Fcons (entry, cache));
5769 /* We have the parsing info now for free, so add it to the caches. */
5770 XSETFASTINT (index, modifiers);
5771 Fput (new_symbol, Qevent_symbol_element_mask,
5772 Fcons (base, Fcons (index, Qnil)));
5773 Fput (new_symbol, Qevent_symbol_elements,
5774 Fcons (base, lispy_modifier_list (modifiers)));
5777 /* Make sure this symbol is of the same kind as BASE.
5779 You'd think we could just set this once and for all when we
5780 intern the symbol above, but reorder_modifiers may call us when
5781 BASE's property isn't set right; we can't assume that just
5782 because it has a Qmodifier_cache property it must have its
5783 Qevent_kind set right as well. */
5784 if (NILP (Fget (new_symbol, Qevent_kind)))
5786 Lisp_Object kind;
5788 kind = Fget (base, Qevent_kind);
5789 if (! NILP (kind))
5790 Fput (new_symbol, Qevent_kind, kind);
5793 return new_symbol;
5797 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
5798 return a symbol with the modifiers placed in the canonical order.
5799 Canonical order is alphabetical, except for down and drag, which
5800 always come last. The 'click' modifier is never written out.
5802 Fdefine_key calls this to make sure that (for example) C-M-foo
5803 and M-C-foo end up being equivalent in the keymap. */
5805 Lisp_Object
5806 reorder_modifiers (symbol)
5807 Lisp_Object symbol;
5809 /* It's hopefully okay to write the code this way, since everything
5810 will soon be in caches, and no consing will be done at all. */
5811 Lisp_Object parsed;
5813 parsed = parse_modifiers (symbol);
5814 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed))),
5815 XCAR (parsed));
5819 /* For handling events, we often want to produce a symbol whose name
5820 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
5821 to some base, like the name of a function key or mouse button.
5822 modify_event_symbol produces symbols of this sort.
5824 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
5825 is the name of the i'th symbol. TABLE_SIZE is the number of elements
5826 in the table.
5828 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
5829 into symbol names, or a string specifying a name stem used to
5830 construct a symbol name or the form `STEM-N', where N is the decimal
5831 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
5832 non-nil; otherwise NAME_TABLE is used.
5834 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
5835 persist between calls to modify_event_symbol that it can use to
5836 store a cache of the symbols it's generated for this NAME_TABLE
5837 before. The object stored there may be a vector or an alist.
5839 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
5841 MODIFIERS is a set of modifier bits (as given in struct input_events)
5842 whose prefixes should be applied to the symbol name.
5844 SYMBOL_KIND is the value to be placed in the event_kind property of
5845 the returned symbol.
5847 The symbols we create are supposed to have an
5848 `event-symbol-elements' property, which lists the modifiers present
5849 in the symbol's name. */
5851 static Lisp_Object
5852 modify_event_symbol (symbol_num, modifiers, symbol_kind, name_alist_or_stem,
5853 name_table, symbol_table, table_size)
5854 int symbol_num;
5855 unsigned modifiers;
5856 Lisp_Object symbol_kind;
5857 Lisp_Object name_alist_or_stem;
5858 char **name_table;
5859 Lisp_Object *symbol_table;
5860 unsigned int table_size;
5862 Lisp_Object value;
5863 Lisp_Object symbol_int;
5865 /* Get rid of the "vendor-specific" bit here. */
5866 XSETINT (symbol_int, symbol_num & 0xffffff);
5868 /* Is this a request for a valid symbol? */
5869 if (symbol_num < 0 || symbol_num >= table_size)
5870 return Qnil;
5872 if (CONSP (*symbol_table))
5873 value = Fcdr (assq_no_quit (symbol_int, *symbol_table));
5875 /* If *symbol_table doesn't seem to be initialized properly, fix that.
5876 *symbol_table should be a lisp vector TABLE_SIZE elements long,
5877 where the Nth element is the symbol for NAME_TABLE[N], or nil if
5878 we've never used that symbol before. */
5879 else
5881 if (! VECTORP (*symbol_table)
5882 || XVECTOR (*symbol_table)->size != table_size)
5884 Lisp_Object size;
5886 XSETFASTINT (size, table_size);
5887 *symbol_table = Fmake_vector (size, Qnil);
5890 value = XVECTOR (*symbol_table)->contents[symbol_num];
5893 /* Have we already used this symbol before? */
5894 if (NILP (value))
5896 /* No; let's create it. */
5897 if (CONSP (name_alist_or_stem))
5898 value = Fcdr_safe (Fassq (symbol_int, name_alist_or_stem));
5899 else if (STRINGP (name_alist_or_stem))
5901 int len = STRING_BYTES (XSTRING (name_alist_or_stem));
5902 char *buf = (char *) alloca (len + 50);
5903 sprintf (buf, "%s-%d", XSTRING (name_alist_or_stem)->data,
5904 XINT (symbol_int) + 1);
5905 value = intern (buf);
5907 else if (name_table != 0 && name_table[symbol_num])
5908 value = intern (name_table[symbol_num]);
5910 #ifdef HAVE_WINDOW_SYSTEM
5911 if (NILP (value))
5913 char *name = x_get_keysym_name (symbol_num);
5914 if (name)
5915 value = intern (name);
5917 #endif
5919 if (NILP (value))
5921 char buf[20];
5922 sprintf (buf, "key-%d", symbol_num);
5923 value = intern (buf);
5926 if (CONSP (*symbol_table))
5927 *symbol_table = Fcons (Fcons (symbol_int, value), *symbol_table);
5928 else
5929 XVECTOR (*symbol_table)->contents[symbol_num] = value;
5931 /* Fill in the cache entries for this symbol; this also
5932 builds the Qevent_symbol_elements property, which the user
5933 cares about. */
5934 apply_modifiers (modifiers & click_modifier, value);
5935 Fput (value, Qevent_kind, symbol_kind);
5938 /* Apply modifiers to that symbol. */
5939 return apply_modifiers (modifiers, value);
5942 /* Convert a list that represents an event type,
5943 such as (ctrl meta backspace), into the usual representation of that
5944 event type as a number or a symbol. */
5946 DEFUN ("event-convert-list", Fevent_convert_list, Sevent_convert_list, 1, 1, 0,
5947 doc: /* Convert the event description list EVENT-DESC to an event type.
5948 EVENT-DESC should contain one base event type (a character or symbol)
5949 and zero or more modifier names (control, meta, hyper, super, shift, alt,
5950 drag, down, double or triple). The base must be last.
5951 The return value is an event type (a character or symbol) which
5952 has the same base event type and all the specified modifiers. */)
5953 (event_desc)
5954 Lisp_Object event_desc;
5956 Lisp_Object base;
5957 int modifiers = 0;
5958 Lisp_Object rest;
5960 base = Qnil;
5961 rest = event_desc;
5962 while (CONSP (rest))
5964 Lisp_Object elt;
5965 int this = 0;
5967 elt = XCAR (rest);
5968 rest = XCDR (rest);
5970 /* Given a symbol, see if it is a modifier name. */
5971 if (SYMBOLP (elt) && CONSP (rest))
5972 this = parse_solitary_modifier (elt);
5974 if (this != 0)
5975 modifiers |= this;
5976 else if (!NILP (base))
5977 error ("Two bases given in one event");
5978 else
5979 base = elt;
5983 /* Let the symbol A refer to the character A. */
5984 if (SYMBOLP (base) && XSTRING (SYMBOL_NAME (base))->size == 1)
5985 XSETINT (base, XSTRING (SYMBOL_NAME (base))->data[0]);
5987 if (INTEGERP (base))
5989 /* Turn (shift a) into A. */
5990 if ((modifiers & shift_modifier) != 0
5991 && (XINT (base) >= 'a' && XINT (base) <= 'z'))
5993 XSETINT (base, XINT (base) - ('a' - 'A'));
5994 modifiers &= ~shift_modifier;
5997 /* Turn (control a) into C-a. */
5998 if (modifiers & ctrl_modifier)
5999 return make_number ((modifiers & ~ctrl_modifier)
6000 | make_ctrl_char (XINT (base)));
6001 else
6002 return make_number (modifiers | XINT (base));
6004 else if (SYMBOLP (base))
6005 return apply_modifiers (modifiers, base);
6006 else
6008 error ("Invalid base event");
6009 return Qnil;
6013 /* Try to recognize SYMBOL as a modifier name.
6014 Return the modifier flag bit, or 0 if not recognized. */
6016 static int
6017 parse_solitary_modifier (symbol)
6018 Lisp_Object symbol;
6020 struct Lisp_String *name = XSTRING (SYMBOL_NAME (symbol));
6022 switch (name->data[0])
6024 #define SINGLE_LETTER_MOD(BIT) \
6025 if (STRING_BYTES (name) == 1) \
6026 return BIT;
6028 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6029 if (LEN == STRING_BYTES (name) \
6030 && ! strncmp (name->data, NAME, LEN)) \
6031 return BIT;
6033 case 'A':
6034 SINGLE_LETTER_MOD (alt_modifier);
6035 break;
6037 case 'a':
6038 MULTI_LETTER_MOD (alt_modifier, "alt", 3);
6039 break;
6041 case 'C':
6042 SINGLE_LETTER_MOD (ctrl_modifier);
6043 break;
6045 case 'c':
6046 MULTI_LETTER_MOD (ctrl_modifier, "ctrl", 4);
6047 MULTI_LETTER_MOD (ctrl_modifier, "control", 7);
6048 break;
6050 case 'H':
6051 SINGLE_LETTER_MOD (hyper_modifier);
6052 break;
6054 case 'h':
6055 MULTI_LETTER_MOD (hyper_modifier, "hyper", 5);
6056 break;
6058 case 'M':
6059 SINGLE_LETTER_MOD (meta_modifier);
6060 break;
6062 case 'm':
6063 MULTI_LETTER_MOD (meta_modifier, "meta", 4);
6064 break;
6066 case 'S':
6067 SINGLE_LETTER_MOD (shift_modifier);
6068 break;
6070 case 's':
6071 MULTI_LETTER_MOD (shift_modifier, "shift", 5);
6072 MULTI_LETTER_MOD (super_modifier, "super", 5);
6073 SINGLE_LETTER_MOD (super_modifier);
6074 break;
6076 case 'd':
6077 MULTI_LETTER_MOD (drag_modifier, "drag", 4);
6078 MULTI_LETTER_MOD (down_modifier, "down", 4);
6079 MULTI_LETTER_MOD (double_modifier, "double", 6);
6080 break;
6082 case 't':
6083 MULTI_LETTER_MOD (triple_modifier, "triple", 6);
6084 break;
6086 #undef SINGLE_LETTER_MOD
6087 #undef MULTI_LETTER_MOD
6090 return 0;
6093 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6094 Such a list is not valid as an event,
6095 but it can be a Lucid-style event type list. */
6098 lucid_event_type_list_p (object)
6099 Lisp_Object object;
6101 Lisp_Object tail;
6103 if (! CONSP (object))
6104 return 0;
6106 if (EQ (XCAR (object), Qhelp_echo)
6107 || EQ (XCAR (object), Qvertical_line)
6108 || EQ (XCAR (object), Qmode_line)
6109 || EQ (XCAR (object), Qheader_line))
6110 return 0;
6112 for (tail = object; CONSP (tail); tail = XCDR (tail))
6114 Lisp_Object elt;
6115 elt = XCAR (tail);
6116 if (! (INTEGERP (elt) || SYMBOLP (elt)))
6117 return 0;
6120 return NILP (tail);
6123 /* Store into *addr a value nonzero if terminal input chars are available.
6124 Serves the purpose of ioctl (0, FIONREAD, addr)
6125 but works even if FIONREAD does not exist.
6126 (In fact, this may actually read some input.)
6128 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6130 static void
6131 get_input_pending (addr, do_timers_now)
6132 int *addr;
6133 int do_timers_now;
6135 /* First of all, have we already counted some input? */
6136 *addr = !NILP (Vquit_flag) || readable_events (do_timers_now);
6138 /* If input is being read as it arrives, and we have none, there is none. */
6139 if (*addr > 0 || (interrupt_input && ! interrupts_deferred))
6140 return;
6142 /* Try to read some input and see how much we get. */
6143 gobble_input (0);
6144 *addr = !NILP (Vquit_flag) || readable_events (do_timers_now);
6147 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6149 void
6150 gobble_input (expected)
6151 int expected;
6153 #ifndef VMS
6154 #ifdef SIGIO
6155 if (interrupt_input)
6157 SIGMASKTYPE mask;
6158 mask = sigblock (sigmask (SIGIO));
6159 read_avail_input (expected);
6160 sigsetmask (mask);
6162 else
6163 #ifdef POLL_FOR_INPUT
6164 if (read_socket_hook && !interrupt_input && poll_suppress_count == 0)
6166 SIGMASKTYPE mask;
6167 mask = sigblock (sigmask (SIGALRM));
6168 read_avail_input (expected);
6169 sigsetmask (mask);
6171 else
6172 #endif
6173 #endif
6174 read_avail_input (expected);
6175 #endif
6178 /* Put a buffer_switch_event in the buffer
6179 so that read_key_sequence will notice the new current buffer. */
6181 void
6182 record_asynch_buffer_change ()
6184 struct input_event event;
6185 Lisp_Object tem;
6187 event.kind = buffer_switch_event;
6188 event.frame_or_window = Qnil;
6189 event.arg = Qnil;
6191 #ifdef subprocesses
6192 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6193 The purpose of the event is to make read_key_sequence look up the
6194 keymaps again. If we aren't in read_key_sequence, we don't need one,
6195 and the event could cause trouble by messing up (input-pending-p). */
6196 tem = Fwaiting_for_user_input_p ();
6197 if (NILP (tem))
6198 return;
6199 #else
6200 /* We never need these events if we have no asynchronous subprocesses. */
6201 return;
6202 #endif
6204 /* Make sure no interrupt happens while storing the event. */
6205 #ifdef SIGIO
6206 if (interrupt_input)
6208 SIGMASKTYPE mask;
6209 mask = sigblock (sigmask (SIGIO));
6210 kbd_buffer_store_event (&event);
6211 sigsetmask (mask);
6213 else
6214 #endif
6216 stop_polling ();
6217 kbd_buffer_store_event (&event);
6218 start_polling ();
6222 #ifndef VMS
6224 /* Read any terminal input already buffered up by the system
6225 into the kbd_buffer, but do not wait.
6227 EXPECTED should be nonzero if the caller knows there is some input.
6229 Except on VMS, all input is read by this function.
6230 If interrupt_input is nonzero, this function MUST be called
6231 only when SIGIO is blocked.
6233 Returns the number of keyboard chars read, or -1 meaning
6234 this is a bad time to try to read input. */
6236 static int
6237 read_avail_input (expected)
6238 int expected;
6240 struct input_event buf[KBD_BUFFER_SIZE];
6241 register int i;
6242 int nread;
6244 if (read_socket_hook)
6245 /* No need for FIONREAD or fcntl; just say don't wait. */
6246 nread = (*read_socket_hook) (input_fd, buf, KBD_BUFFER_SIZE, expected);
6247 else
6249 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6250 the kbd_buffer can really hold. That may prevent loss
6251 of characters on some systems when input is stuffed at us. */
6252 unsigned char cbuf[KBD_BUFFER_SIZE - 1];
6253 int n_to_read;
6255 /* Determine how many characters we should *try* to read. */
6256 #ifdef WINDOWSNT
6257 return 0;
6258 #else /* not WINDOWSNT */
6259 #ifdef MSDOS
6260 n_to_read = dos_keysns ();
6261 if (n_to_read == 0)
6262 return 0;
6263 #else /* not MSDOS */
6264 #ifdef FIONREAD
6265 /* Find out how much input is available. */
6266 if (ioctl (input_fd, FIONREAD, &n_to_read) < 0)
6267 /* Formerly simply reported no input, but that sometimes led to
6268 a failure of Emacs to terminate.
6269 SIGHUP seems appropriate if we can't reach the terminal. */
6270 /* ??? Is it really right to send the signal just to this process
6271 rather than to the whole process group?
6272 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6273 kill (getpid (), SIGHUP);
6274 if (n_to_read == 0)
6275 return 0;
6276 if (n_to_read > sizeof cbuf)
6277 n_to_read = sizeof cbuf;
6278 #else /* no FIONREAD */
6279 #if defined (USG) || defined (DGUX)
6280 /* Read some input if available, but don't wait. */
6281 n_to_read = sizeof cbuf;
6282 fcntl (input_fd, F_SETFL, O_NDELAY);
6283 #else
6284 you lose;
6285 #endif
6286 #endif
6287 #endif /* not MSDOS */
6288 #endif /* not WINDOWSNT */
6290 /* Now read; for one reason or another, this will not block.
6291 NREAD is set to the number of chars read. */
6294 #ifdef MSDOS
6295 cbuf[0] = dos_keyread ();
6296 nread = 1;
6297 #else
6298 nread = emacs_read (input_fd, cbuf, n_to_read);
6299 #endif
6300 /* POSIX infers that processes which are not in the session leader's
6301 process group won't get SIGHUP's at logout time. BSDI adheres to
6302 this part standard and returns -1 from read (0) with errno==EIO
6303 when the control tty is taken away.
6304 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6305 if (nread == -1 && errno == EIO)
6306 kill (0, SIGHUP);
6307 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6308 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6309 This looks incorrect, but it isn't, because _BSD causes
6310 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6311 and that causes a value other than 0 when there is no input. */
6312 if (nread == 0)
6313 kill (0, SIGHUP);
6314 #endif
6316 while (
6317 /* We used to retry the read if it was interrupted.
6318 But this does the wrong thing when O_NDELAY causes
6319 an EAGAIN error. Does anybody know of a situation
6320 where a retry is actually needed? */
6321 #if 0
6322 nread < 0 && (errno == EAGAIN
6323 #ifdef EFAULT
6324 || errno == EFAULT
6325 #endif
6326 #ifdef EBADSLT
6327 || errno == EBADSLT
6328 #endif
6330 #else
6332 #endif
6335 #ifndef FIONREAD
6336 #if defined (USG) || defined (DGUX)
6337 fcntl (input_fd, F_SETFL, 0);
6338 #endif /* USG or DGUX */
6339 #endif /* no FIONREAD */
6340 for (i = 0; i < nread; i++)
6342 buf[i].kind = ascii_keystroke;
6343 buf[i].modifiers = 0;
6344 if (meta_key == 1 && (cbuf[i] & 0x80))
6345 buf[i].modifiers = meta_modifier;
6346 if (meta_key != 2)
6347 cbuf[i] &= ~0x80;
6349 buf[i].code = cbuf[i];
6350 buf[i].frame_or_window = selected_frame;
6351 buf[i].arg = Qnil;
6355 /* Scan the chars for C-g and store them in kbd_buffer. */
6356 for (i = 0; i < nread; i++)
6358 kbd_buffer_store_event (&buf[i]);
6359 /* Don't look at input that follows a C-g too closely.
6360 This reduces lossage due to autorepeat on C-g. */
6361 if (buf[i].kind == ascii_keystroke
6362 && buf[i].code == quit_char)
6363 break;
6366 return nread;
6368 #endif /* not VMS */
6370 #ifdef SIGIO /* for entire page */
6371 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6373 SIGTYPE
6374 input_available_signal (signo)
6375 int signo;
6377 /* Must preserve main program's value of errno. */
6378 int old_errno = errno;
6379 #ifdef BSD4_1
6380 extern int select_alarmed;
6381 #endif
6383 #if defined (USG) && !defined (POSIX_SIGNALS)
6384 /* USG systems forget handlers when they are used;
6385 must reestablish each time */
6386 signal (signo, input_available_signal);
6387 #endif /* USG */
6389 #ifdef BSD4_1
6390 sigisheld (SIGIO);
6391 #endif
6393 if (input_available_clear_time)
6394 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
6396 while (1)
6398 int nread;
6399 nread = read_avail_input (1);
6400 /* -1 means it's not ok to read the input now.
6401 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6402 0 means there was no keyboard input available. */
6403 if (nread <= 0)
6404 break;
6406 #ifdef BSD4_1
6407 select_alarmed = 1; /* Force the select emulator back to life */
6408 #endif
6411 #ifdef BSD4_1
6412 sigfree ();
6413 #endif
6414 errno = old_errno;
6416 #endif /* SIGIO */
6418 /* Send ourselves a SIGIO.
6420 This function exists so that the UNBLOCK_INPUT macro in
6421 blockinput.h can have some way to take care of input we put off
6422 dealing with, without assuming that every file which uses
6423 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6424 void
6425 reinvoke_input_signal ()
6427 #ifdef SIGIO
6428 kill (getpid (), SIGIO);
6429 #endif
6434 static void menu_bar_item P_ ((Lisp_Object, Lisp_Object));
6435 static void menu_bar_one_keymap P_ ((Lisp_Object));
6437 /* These variables hold the vector under construction within
6438 menu_bar_items and its subroutines, and the current index
6439 for storing into that vector. */
6440 static Lisp_Object menu_bar_items_vector;
6441 static int menu_bar_items_index;
6443 /* Return a vector of menu items for a menu bar, appropriate
6444 to the current buffer. Each item has three elements in the vector:
6445 KEY STRING MAPLIST.
6447 OLD is an old vector we can optionally reuse, or nil. */
6449 Lisp_Object
6450 menu_bar_items (old)
6451 Lisp_Object old;
6453 /* The number of keymaps we're scanning right now, and the number of
6454 keymaps we have allocated space for. */
6455 int nmaps;
6457 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6458 in the current keymaps, or nil where it is not a prefix. */
6459 Lisp_Object *maps;
6461 Lisp_Object def, tail;
6463 Lisp_Object result;
6465 int mapno;
6466 Lisp_Object oquit;
6468 int i;
6470 struct gcpro gcpro1;
6472 /* In order to build the menus, we need to call the keymap
6473 accessors. They all call QUIT. But this function is called
6474 during redisplay, during which a quit is fatal. So inhibit
6475 quitting while building the menus.
6476 We do this instead of specbind because (1) errors will clear it anyway
6477 and (2) this avoids risk of specpdl overflow. */
6478 oquit = Vinhibit_quit;
6479 Vinhibit_quit = Qt;
6481 if (!NILP (old))
6482 menu_bar_items_vector = old;
6483 else
6484 menu_bar_items_vector = Fmake_vector (make_number (24), Qnil);
6485 menu_bar_items_index = 0;
6487 GCPRO1 (menu_bar_items_vector);
6489 /* Build our list of keymaps.
6490 If we recognize a function key and replace its escape sequence in
6491 keybuf with its symbol, or if the sequence starts with a mouse
6492 click and we need to switch buffers, we jump back here to rebuild
6493 the initial keymaps from the current buffer. */
6495 Lisp_Object *tmaps;
6497 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6498 if (!NILP (Voverriding_local_map_menu_flag))
6500 /* Yes, use them (if non-nil) as well as the global map. */
6501 maps = (Lisp_Object *) alloca (3 * sizeof (maps[0]));
6502 nmaps = 0;
6503 if (!NILP (current_kboard->Voverriding_terminal_local_map))
6504 maps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
6505 if (!NILP (Voverriding_local_map))
6506 maps[nmaps++] = Voverriding_local_map;
6508 else
6510 /* No, so use major and minor mode keymaps and keymap property.
6511 Note that menu-bar bindings in the local-map and keymap
6512 properties may not work reliable, as they are only
6513 recognized when the menu-bar (or mode-line) is updated,
6514 which does not normally happen after every command. */
6515 Lisp_Object tem;
6516 int nminor;
6517 nminor = current_minor_maps (NULL, &tmaps);
6518 maps = (Lisp_Object *) alloca ((nminor + 3) * sizeof (maps[0]));
6519 nmaps = 0;
6520 if (tem = get_local_map (PT, current_buffer, Qkeymap), !NILP (tem))
6521 maps[nmaps++] = tem;
6522 bcopy (tmaps, (void *) (maps + nmaps), nminor * sizeof (maps[0]));
6523 nmaps += nminor;
6524 maps[nmaps++] = get_local_map (PT, current_buffer, Qlocal_map);
6526 maps[nmaps++] = current_global_map;
6529 /* Look up in each map the dummy prefix key `menu-bar'. */
6531 result = Qnil;
6533 for (mapno = nmaps - 1; mapno >= 0; mapno--)
6534 if (!NILP (maps[mapno]))
6536 def = get_keymap (access_keymap (maps[mapno], Qmenu_bar, 1, 0, 1),
6537 0, 1);
6538 if (CONSP (def))
6539 menu_bar_one_keymap (def);
6542 /* Move to the end those items that should be at the end. */
6544 for (tail = Vmenu_bar_final_items; CONSP (tail); tail = XCDR (tail))
6546 int i;
6547 int end = menu_bar_items_index;
6549 for (i = 0; i < end; i += 4)
6550 if (EQ (XCAR (tail), XVECTOR (menu_bar_items_vector)->contents[i]))
6552 Lisp_Object tem0, tem1, tem2, tem3;
6553 /* Move the item at index I to the end,
6554 shifting all the others forward. */
6555 tem0 = XVECTOR (menu_bar_items_vector)->contents[i + 0];
6556 tem1 = XVECTOR (menu_bar_items_vector)->contents[i + 1];
6557 tem2 = XVECTOR (menu_bar_items_vector)->contents[i + 2];
6558 tem3 = XVECTOR (menu_bar_items_vector)->contents[i + 3];
6559 if (end > i + 4)
6560 bcopy (&XVECTOR (menu_bar_items_vector)->contents[i + 4],
6561 &XVECTOR (menu_bar_items_vector)->contents[i],
6562 (end - i - 4) * sizeof (Lisp_Object));
6563 XVECTOR (menu_bar_items_vector)->contents[end - 4] = tem0;
6564 XVECTOR (menu_bar_items_vector)->contents[end - 3] = tem1;
6565 XVECTOR (menu_bar_items_vector)->contents[end - 2] = tem2;
6566 XVECTOR (menu_bar_items_vector)->contents[end - 1] = tem3;
6567 break;
6571 /* Add nil, nil, nil, nil at the end. */
6572 i = menu_bar_items_index;
6573 if (i + 4 > XVECTOR (menu_bar_items_vector)->size)
6575 Lisp_Object tem;
6576 tem = Fmake_vector (make_number (2 * i), Qnil);
6577 bcopy (XVECTOR (menu_bar_items_vector)->contents,
6578 XVECTOR (tem)->contents, i * sizeof (Lisp_Object));
6579 menu_bar_items_vector = tem;
6581 /* Add this item. */
6582 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
6583 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
6584 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
6585 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
6586 menu_bar_items_index = i;
6588 Vinhibit_quit = oquit;
6589 UNGCPRO;
6590 return menu_bar_items_vector;
6593 /* Scan one map KEYMAP, accumulating any menu items it defines
6594 in menu_bar_items_vector. */
6596 static Lisp_Object menu_bar_one_keymap_changed_items;
6598 static void
6599 menu_bar_one_keymap (keymap)
6600 Lisp_Object keymap;
6602 Lisp_Object tail, item;
6604 menu_bar_one_keymap_changed_items = Qnil;
6606 /* Loop over all keymap entries that have menu strings. */
6607 for (tail = keymap; CONSP (tail); tail = XCDR (tail))
6609 item = XCAR (tail);
6610 if (CONSP (item))
6611 menu_bar_item (XCAR (item), XCDR (item));
6612 else if (VECTORP (item))
6614 /* Loop over the char values represented in the vector. */
6615 int len = XVECTOR (item)->size;
6616 int c;
6617 for (c = 0; c < len; c++)
6619 Lisp_Object character;
6620 XSETFASTINT (character, c);
6621 menu_bar_item (character, XVECTOR (item)->contents[c]);
6627 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
6628 If there's already an item for KEY, add this DEF to it. */
6630 Lisp_Object item_properties;
6632 static void
6633 menu_bar_item (key, item)
6634 Lisp_Object key, item;
6636 struct gcpro gcpro1;
6637 int i;
6638 Lisp_Object tem;
6640 if (EQ (item, Qundefined))
6642 /* If a map has an explicit `undefined' as definition,
6643 discard any previously made menu bar item. */
6645 for (i = 0; i < menu_bar_items_index; i += 4)
6646 if (EQ (key, XVECTOR (menu_bar_items_vector)->contents[i]))
6648 if (menu_bar_items_index > i + 4)
6649 bcopy (&XVECTOR (menu_bar_items_vector)->contents[i + 4],
6650 &XVECTOR (menu_bar_items_vector)->contents[i],
6651 (menu_bar_items_index - i - 4) * sizeof (Lisp_Object));
6652 menu_bar_items_index -= 4;
6656 /* If this keymap has already contributed to this KEY,
6657 don't contribute to it a second time. */
6658 tem = Fmemq (key, menu_bar_one_keymap_changed_items);
6659 if (!NILP (tem) || NILP (item))
6660 return;
6662 menu_bar_one_keymap_changed_items
6663 = Fcons (key, menu_bar_one_keymap_changed_items);
6665 /* We add to menu_bar_one_keymap_changed_items before doing the
6666 parse_menu_item, so that if it turns out it wasn't a menu item,
6667 it still correctly hides any further menu item. */
6668 GCPRO1 (key);
6669 i = parse_menu_item (item, 0, 1);
6670 UNGCPRO;
6671 if (!i)
6672 return;
6674 item = XVECTOR (item_properties)->contents[ITEM_PROPERTY_DEF];
6676 /* Find any existing item for this KEY. */
6677 for (i = 0; i < menu_bar_items_index; i += 4)
6678 if (EQ (key, XVECTOR (menu_bar_items_vector)->contents[i]))
6679 break;
6681 /* If we did not find this KEY, add it at the end. */
6682 if (i == menu_bar_items_index)
6684 /* If vector is too small, get a bigger one. */
6685 if (i + 4 > XVECTOR (menu_bar_items_vector)->size)
6687 Lisp_Object tem;
6688 tem = Fmake_vector (make_number (2 * i), Qnil);
6689 bcopy (XVECTOR (menu_bar_items_vector)->contents,
6690 XVECTOR (tem)->contents, i * sizeof (Lisp_Object));
6691 menu_bar_items_vector = tem;
6694 /* Add this item. */
6695 XVECTOR (menu_bar_items_vector)->contents[i++] = key;
6696 XVECTOR (menu_bar_items_vector)->contents[i++]
6697 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_NAME];
6698 XVECTOR (menu_bar_items_vector)->contents[i++] = Fcons (item, Qnil);
6699 XVECTOR (menu_bar_items_vector)->contents[i++] = make_number (0);
6700 menu_bar_items_index = i;
6702 /* We did find an item for this KEY. Add ITEM to its list of maps. */
6703 else
6705 Lisp_Object old;
6706 old = XVECTOR (menu_bar_items_vector)->contents[i + 2];
6707 XVECTOR (menu_bar_items_vector)->contents[i + 2] = Fcons (item, old);
6711 /* This is used as the handler when calling menu_item_eval_property. */
6712 static Lisp_Object
6713 menu_item_eval_property_1 (arg)
6714 Lisp_Object arg;
6716 /* If we got a quit from within the menu computation,
6717 quit all the way out of it. This takes care of C-] in the debugger. */
6718 if (CONSP (arg) && EQ (XCAR (arg), Qquit))
6719 Fsignal (Qquit, Qnil);
6721 return Qnil;
6724 /* Evaluate an expression and return the result (or nil if something
6725 went wrong). Used to evaluate dynamic parts of menu items. */
6726 Lisp_Object
6727 menu_item_eval_property (sexpr)
6728 Lisp_Object sexpr;
6730 int count = specpdl_ptr - specpdl;
6731 Lisp_Object val;
6732 specbind (Qinhibit_redisplay, Qt);
6733 val = internal_condition_case_1 (Feval, sexpr, Qerror,
6734 menu_item_eval_property_1);
6735 return unbind_to (count, val);
6738 /* This function parses a menu item and leaves the result in the
6739 vector item_properties.
6740 ITEM is a key binding, a possible menu item.
6741 If NOTREAL is nonzero, only check for equivalent key bindings, don't
6742 evaluate dynamic expressions in the menu item.
6743 INMENUBAR is > 0 when this is considered for an entry in a menu bar
6744 top level.
6745 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
6746 parse_menu_item returns true if the item is a menu item and false
6747 otherwise. */
6750 parse_menu_item (item, notreal, inmenubar)
6751 Lisp_Object item;
6752 int notreal, inmenubar;
6754 Lisp_Object def, tem, item_string, start;
6755 Lisp_Object cachelist;
6756 Lisp_Object filter;
6757 Lisp_Object keyhint;
6758 int i;
6759 int newcache = 0;
6761 cachelist = Qnil;
6762 filter = Qnil;
6763 keyhint = Qnil;
6765 if (!CONSP (item))
6766 return 0;
6768 /* Create item_properties vector if necessary. */
6769 if (NILP (item_properties))
6770 item_properties
6771 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE + 1), Qnil);
6773 /* Initialize optional entries. */
6774 for (i = ITEM_PROPERTY_DEF; i < ITEM_PROPERTY_ENABLE; i++)
6775 AREF (item_properties, i) = Qnil;
6776 AREF (item_properties, ITEM_PROPERTY_ENABLE) = Qt;
6778 /* Save the item here to protect it from GC. */
6779 AREF (item_properties, ITEM_PROPERTY_ITEM) = item;
6781 item_string = XCAR (item);
6783 start = item;
6784 item = XCDR (item);
6785 if (STRINGP (item_string))
6787 /* Old format menu item. */
6788 AREF (item_properties, ITEM_PROPERTY_NAME) = item_string;
6790 /* Maybe help string. */
6791 if (CONSP (item) && STRINGP (XCAR (item)))
6793 AREF (item_properties, ITEM_PROPERTY_HELP) = XCAR (item);
6794 start = item;
6795 item = XCDR (item);
6798 /* Maybe key binding cache. */
6799 if (CONSP (item) && CONSP (XCAR (item))
6800 && (NILP (XCAR (XCAR (item)))
6801 || VECTORP (XCAR (XCAR (item)))))
6803 cachelist = XCAR (item);
6804 item = XCDR (item);
6807 /* This is the real definition--the function to run. */
6808 AREF (item_properties, ITEM_PROPERTY_DEF) = item;
6810 /* Get enable property, if any. */
6811 if (SYMBOLP (item))
6813 tem = Fget (item, Qmenu_enable);
6814 if (!NILP (tem))
6815 AREF (item_properties, ITEM_PROPERTY_ENABLE) = tem;
6818 else if (EQ (item_string, Qmenu_item) && CONSP (item))
6820 /* New format menu item. */
6821 AREF (item_properties, ITEM_PROPERTY_NAME) = XCAR (item);
6822 start = XCDR (item);
6823 if (CONSP (start))
6825 /* We have a real binding. */
6826 AREF (item_properties, ITEM_PROPERTY_DEF) = XCAR (start);
6828 item = XCDR (start);
6829 /* Is there a cache list with key equivalences. */
6830 if (CONSP (item) && CONSP (XCAR (item)))
6832 cachelist = XCAR (item);
6833 item = XCDR (item);
6836 /* Parse properties. */
6837 while (CONSP (item) && CONSP (XCDR (item)))
6839 tem = XCAR (item);
6840 item = XCDR (item);
6842 if (EQ (tem, QCenable))
6843 AREF (item_properties, ITEM_PROPERTY_ENABLE) = XCAR (item);
6844 else if (EQ (tem, QCvisible) && !notreal)
6846 /* If got a visible property and that evaluates to nil
6847 then ignore this item. */
6848 tem = menu_item_eval_property (XCAR (item));
6849 if (NILP (tem))
6850 return 0;
6852 else if (EQ (tem, QChelp))
6853 AREF (item_properties, ITEM_PROPERTY_HELP) = XCAR (item);
6854 else if (EQ (tem, QCfilter))
6855 filter = item;
6856 else if (EQ (tem, QCkey_sequence))
6858 tem = XCAR (item);
6859 if (NILP (cachelist)
6860 && (SYMBOLP (tem) || STRINGP (tem) || VECTORP (tem)))
6861 /* Be GC protected. Set keyhint to item instead of tem. */
6862 keyhint = item;
6864 else if (EQ (tem, QCkeys))
6866 tem = XCAR (item);
6867 if (CONSP (tem) || (STRINGP (tem) && NILP (cachelist)))
6868 AREF (item_properties, ITEM_PROPERTY_KEYEQ) = tem;
6870 else if (EQ (tem, QCbutton) && CONSP (XCAR (item)))
6872 Lisp_Object type;
6873 tem = XCAR (item);
6874 type = XCAR (tem);
6875 if (EQ (type, QCtoggle) || EQ (type, QCradio))
6877 AREF (item_properties, ITEM_PROPERTY_SELECTED)
6878 = XCDR (tem);
6879 AREF (item_properties, ITEM_PROPERTY_TYPE)
6880 = type;
6883 item = XCDR (item);
6886 else if (inmenubar || !NILP (start))
6887 return 0;
6889 else
6890 return 0; /* not a menu item */
6892 /* If item string is not a string, evaluate it to get string.
6893 If we don't get a string, skip this item. */
6894 item_string = AREF (item_properties, ITEM_PROPERTY_NAME);
6895 if (!(STRINGP (item_string) || notreal))
6897 item_string = menu_item_eval_property (item_string);
6898 if (!STRINGP (item_string))
6899 return 0;
6900 AREF (item_properties, ITEM_PROPERTY_NAME) = item_string;
6903 /* If got a filter apply it on definition. */
6904 def = AREF (item_properties, ITEM_PROPERTY_DEF);
6905 if (!NILP (filter))
6907 def = menu_item_eval_property (list2 (XCAR (filter),
6908 list2 (Qquote, def)));
6910 AREF (item_properties, ITEM_PROPERTY_DEF) = def;
6913 /* Enable or disable selection of item. */
6914 tem = AREF (item_properties, ITEM_PROPERTY_ENABLE);
6915 if (!EQ (tem, Qt))
6917 if (notreal)
6918 tem = Qt;
6919 else
6920 tem = menu_item_eval_property (tem);
6921 if (inmenubar && NILP (tem))
6922 return 0; /* Ignore disabled items in menu bar. */
6923 AREF (item_properties, ITEM_PROPERTY_ENABLE) = tem;
6926 /* If we got no definition, this item is just unselectable text which
6927 is OK in a submenu but not in the menubar. */
6928 if (NILP (def))
6929 return (inmenubar ? 0 : 1);
6931 /* See if this is a separate pane or a submenu. */
6932 def = AREF (item_properties, ITEM_PROPERTY_DEF);
6933 tem = get_keymap (def, 0, 1);
6934 /* For a subkeymap, just record its details and exit. */
6935 if (CONSP (tem))
6937 AREF (item_properties, ITEM_PROPERTY_MAP) = tem;
6938 AREF (item_properties, ITEM_PROPERTY_DEF) = tem;
6939 return 1;
6942 /* At the top level in the menu bar, do likewise for commands also.
6943 The menu bar does not display equivalent key bindings anyway.
6944 ITEM_PROPERTY_DEF is already set up properly. */
6945 if (inmenubar > 0)
6946 return 1;
6948 /* This is a command. See if there is an equivalent key binding. */
6949 if (NILP (cachelist))
6951 /* We have to create a cachelist. */
6952 CHECK_IMPURE (start);
6953 XSETCDR (start, Fcons (Fcons (Qnil, Qnil), XCDR (start)));
6954 cachelist = XCAR (XCDR (start));
6955 newcache = 1;
6956 tem = AREF (item_properties, ITEM_PROPERTY_KEYEQ);
6957 if (!NILP (keyhint))
6959 XSETCAR (cachelist, XCAR (keyhint));
6960 newcache = 0;
6962 else if (STRINGP (tem))
6964 XSETCDR (cachelist, Fsubstitute_command_keys (tem));
6965 XSETCAR (cachelist, Qt);
6969 tem = XCAR (cachelist);
6970 if (!EQ (tem, Qt))
6972 int chkcache = 0;
6973 Lisp_Object prefix;
6975 if (!NILP (tem))
6976 tem = Fkey_binding (tem, Qnil, Qnil);
6978 prefix = AREF (item_properties, ITEM_PROPERTY_KEYEQ);
6979 if (CONSP (prefix))
6981 def = XCAR (prefix);
6982 prefix = XCDR (prefix);
6984 else
6985 def = AREF (item_properties, ITEM_PROPERTY_DEF);
6987 if (!update_menu_bindings)
6988 chkcache = 0;
6989 else if (NILP (XCAR (cachelist))) /* Have no saved key. */
6991 if (newcache /* Always check first time. */
6992 /* Should we check everything when precomputing key
6993 bindings? */
6994 /* If something had no key binding before, don't recheck it
6995 because that is too slow--except if we have a list of
6996 rebound commands in Vdefine_key_rebound_commands, do
6997 recheck any command that appears in that list. */
6998 || (CONSP (Vdefine_key_rebound_commands)
6999 && !NILP (Fmemq (def, Vdefine_key_rebound_commands))))
7000 chkcache = 1;
7002 /* We had a saved key. Is it still bound to the command? */
7003 else if (NILP (tem)
7004 || (!EQ (tem, def)
7005 /* If the command is an alias for another
7006 (such as lmenu.el set it up), check if the
7007 original command matches the cached command. */
7008 && !(SYMBOLP (def) && EQ (tem, XSYMBOL (def)->function))))
7009 chkcache = 1; /* Need to recompute key binding. */
7011 if (chkcache)
7013 /* Recompute equivalent key binding. If the command is an alias
7014 for another (such as lmenu.el set it up), see if the original
7015 command name has equivalent keys. Otherwise look up the
7016 specified command itself. We don't try both, because that
7017 makes lmenu menus slow. */
7018 if (SYMBOLP (def)
7019 && SYMBOLP (XSYMBOL (def)->function)
7020 && ! NILP (Fget (def, Qmenu_alias)))
7021 def = XSYMBOL (def)->function;
7022 tem = Fwhere_is_internal (def, Qnil, Qt, Qnil, Qt);
7023 XSETCAR (cachelist, tem);
7024 if (NILP (tem))
7026 XSETCDR (cachelist, Qnil);
7027 chkcache = 0;
7030 else if (!NILP (keyhint) && !NILP (XCAR (cachelist)))
7032 tem = XCAR (cachelist);
7033 chkcache = 1;
7036 newcache = chkcache;
7037 if (chkcache)
7039 tem = Fkey_description (tem);
7040 if (CONSP (prefix))
7042 if (STRINGP (XCAR (prefix)))
7043 tem = concat2 (XCAR (prefix), tem);
7044 if (STRINGP (XCDR (prefix)))
7045 tem = concat2 (tem, XCDR (prefix));
7047 XSETCDR (cachelist, tem);
7051 tem = XCDR (cachelist);
7052 if (newcache && !NILP (tem))
7054 tem = concat3 (build_string (" ("), tem, build_string (")"));
7055 XSETCDR (cachelist, tem);
7058 /* If we only want to precompute equivalent key bindings, stop here. */
7059 if (notreal)
7060 return 1;
7062 /* If we have an equivalent key binding, use that. */
7063 AREF (item_properties, ITEM_PROPERTY_KEYEQ) = tem;
7065 /* Include this when menu help is implemented.
7066 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7067 if (!(NILP (tem) || STRINGP (tem)))
7069 tem = menu_item_eval_property (tem);
7070 if (!STRINGP (tem))
7071 tem = Qnil;
7072 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7076 /* Handle radio buttons or toggle boxes. */
7077 tem = AREF (item_properties, ITEM_PROPERTY_SELECTED);
7078 if (!NILP (tem))
7079 AREF (item_properties, ITEM_PROPERTY_SELECTED)
7080 = menu_item_eval_property (tem);
7082 return 1;
7087 /***********************************************************************
7088 Tool-bars
7089 ***********************************************************************/
7091 /* A vector holding tool bar items while they are parsed in function
7092 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7093 in the vector. */
7095 static Lisp_Object tool_bar_items_vector;
7097 /* A vector holding the result of parse_tool_bar_item. Layout is like
7098 the one for a single item in tool_bar_items_vector. */
7100 static Lisp_Object tool_bar_item_properties;
7102 /* Next free index in tool_bar_items_vector. */
7104 static int ntool_bar_items;
7106 /* The symbols `tool-bar', and `:image'. */
7108 extern Lisp_Object Qtool_bar;
7109 Lisp_Object QCimage;
7111 /* Function prototypes. */
7113 static void init_tool_bar_items P_ ((Lisp_Object));
7114 static void process_tool_bar_item P_ ((Lisp_Object, Lisp_Object));
7115 static int parse_tool_bar_item P_ ((Lisp_Object, Lisp_Object));
7116 static void append_tool_bar_item P_ ((void));
7119 /* Return a vector of tool bar items for keymaps currently in effect.
7120 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7121 tool bar items found. */
7123 Lisp_Object
7124 tool_bar_items (reuse, nitems)
7125 Lisp_Object reuse;
7126 int *nitems;
7128 Lisp_Object *maps;
7129 int nmaps, i;
7130 Lisp_Object oquit;
7131 Lisp_Object *tmaps;
7133 *nitems = 0;
7135 /* In order to build the menus, we need to call the keymap
7136 accessors. They all call QUIT. But this function is called
7137 during redisplay, during which a quit is fatal. So inhibit
7138 quitting while building the menus. We do this instead of
7139 specbind because (1) errors will clear it anyway and (2) this
7140 avoids risk of specpdl overflow. */
7141 oquit = Vinhibit_quit;
7142 Vinhibit_quit = Qt;
7144 /* Initialize tool_bar_items_vector and protect it from GC. */
7145 init_tool_bar_items (reuse);
7147 /* Build list of keymaps in maps. Set nmaps to the number of maps
7148 to process. */
7150 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7151 if (!NILP (Voverriding_local_map_menu_flag))
7153 /* Yes, use them (if non-nil) as well as the global map. */
7154 maps = (Lisp_Object *) alloca (3 * sizeof (maps[0]));
7155 nmaps = 0;
7156 if (!NILP (current_kboard->Voverriding_terminal_local_map))
7157 maps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
7158 if (!NILP (Voverriding_local_map))
7159 maps[nmaps++] = Voverriding_local_map;
7161 else
7163 /* No, so use major and minor mode keymaps and keymap property.
7164 Note that tool-bar bindings in the local-map and keymap
7165 properties may not work reliable, as they are only
7166 recognized when the tool-bar (or mode-line) is updated,
7167 which does not normally happen after every command. */
7168 Lisp_Object tem;
7169 int nminor;
7170 nminor = current_minor_maps (NULL, &tmaps);
7171 maps = (Lisp_Object *) alloca ((nminor + 3) * sizeof (maps[0]));
7172 nmaps = 0;
7173 if (tem = get_local_map (PT, current_buffer, Qkeymap), !NILP (tem))
7174 maps[nmaps++] = tem;
7175 bcopy (tmaps, (void *) (maps + nmaps), nminor * sizeof (maps[0]));
7176 nmaps += nminor;
7177 maps[nmaps++] = get_local_map (PT, current_buffer, Qlocal_map);
7180 /* Add global keymap at the end. */
7181 maps[nmaps++] = current_global_map;
7183 /* Process maps in reverse order and look up in each map the prefix
7184 key `tool-bar'. */
7185 for (i = nmaps - 1; i >= 0; --i)
7186 if (!NILP (maps[i]))
7188 Lisp_Object keymap;
7190 keymap = get_keymap (access_keymap (maps[i], Qtool_bar, 1, 0, 1), 0, 1);
7191 if (CONSP (keymap))
7193 Lisp_Object tail;
7195 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7196 for (tail = keymap; CONSP (tail); tail = XCDR (tail))
7198 Lisp_Object keydef = XCAR (tail);
7199 if (CONSP (keydef))
7200 process_tool_bar_item (XCAR (keydef), XCDR (keydef));
7205 Vinhibit_quit = oquit;
7206 *nitems = ntool_bar_items / TOOL_BAR_ITEM_NSLOTS;
7207 return tool_bar_items_vector;
7211 /* Process the definition of KEY which is DEF. */
7213 static void
7214 process_tool_bar_item (key, def)
7215 Lisp_Object key, def;
7217 int i;
7218 extern Lisp_Object Qundefined;
7219 struct gcpro gcpro1, gcpro2;
7221 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7222 eval. */
7223 GCPRO2 (key, def);
7225 if (EQ (def, Qundefined))
7227 /* If a map has an explicit `undefined' as definition,
7228 discard any previously made item. */
7229 for (i = 0; i < ntool_bar_items; i += TOOL_BAR_ITEM_NSLOTS)
7231 Lisp_Object *v = XVECTOR (tool_bar_items_vector)->contents + i;
7233 if (EQ (key, v[TOOL_BAR_ITEM_KEY]))
7235 if (ntool_bar_items > i + TOOL_BAR_ITEM_NSLOTS)
7236 bcopy (v + TOOL_BAR_ITEM_NSLOTS, v,
7237 ((ntool_bar_items - i - TOOL_BAR_ITEM_NSLOTS)
7238 * sizeof (Lisp_Object)));
7239 ntool_bar_items -= TOOL_BAR_ITEM_NSLOTS;
7240 break;
7244 else if (parse_tool_bar_item (key, def))
7245 /* Append a new tool bar item to tool_bar_items_vector. Accept
7246 more than one definition for the same key. */
7247 append_tool_bar_item ();
7249 UNGCPRO;
7253 /* Parse a tool bar item specification ITEM for key KEY and return the
7254 result in tool_bar_item_properties. Value is zero if ITEM is
7255 invalid.
7257 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7259 CAPTION is the caption of the item, If it's not a string, it is
7260 evaluated to get a string.
7262 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7263 as binding are currently ignored.
7265 The following properties are recognized:
7267 - `:enable FORM'.
7269 FORM is evaluated and specifies whether the tool bar item is
7270 enabled or disabled.
7272 - `:visible FORM'
7274 FORM is evaluated and specifies whether the tool bar item is visible.
7276 - `:filter FUNCTION'
7278 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7279 result is stored as the new binding.
7281 - `:button (TYPE SELECTED)'
7283 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7284 and specifies whether the button is selected (pressed) or not.
7286 - `:image IMAGES'
7288 IMAGES is either a single image specification or a vector of four
7289 image specifications. See enum tool_bar_item_images.
7291 - `:help HELP-STRING'.
7293 Gives a help string to display for the tool bar item. */
7295 static int
7296 parse_tool_bar_item (key, item)
7297 Lisp_Object key, item;
7299 /* Access slot with index IDX of vector tool_bar_item_properties. */
7300 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7302 Lisp_Object filter = Qnil;
7303 Lisp_Object caption;
7304 int i;
7306 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7307 Rule out items that aren't lists, don't start with
7308 `menu-item' or whose rest following `tool-bar-item' is not a
7309 list. */
7310 if (!CONSP (item)
7311 || !EQ (XCAR (item), Qmenu_item)
7312 || (item = XCDR (item),
7313 !CONSP (item)))
7314 return 0;
7316 /* Create tool_bar_item_properties vector if necessary. Reset it to
7317 defaults. */
7318 if (VECTORP (tool_bar_item_properties))
7320 for (i = 0; i < TOOL_BAR_ITEM_NSLOTS; ++i)
7321 PROP (i) = Qnil;
7323 else
7324 tool_bar_item_properties
7325 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS), Qnil);
7327 /* Set defaults. */
7328 PROP (TOOL_BAR_ITEM_KEY) = key;
7329 PROP (TOOL_BAR_ITEM_ENABLED_P) = Qt;
7331 /* Get the caption of the item. If the caption is not a string,
7332 evaluate it to get a string. If we don't get a string, skip this
7333 item. */
7334 caption = XCAR (item);
7335 if (!STRINGP (caption))
7337 caption = menu_item_eval_property (caption);
7338 if (!STRINGP (caption))
7339 return 0;
7341 PROP (TOOL_BAR_ITEM_CAPTION) = caption;
7343 /* Give up if rest following the caption is not a list. */
7344 item = XCDR (item);
7345 if (!CONSP (item))
7346 return 0;
7348 /* Store the binding. */
7349 PROP (TOOL_BAR_ITEM_BINDING) = XCAR (item);
7350 item = XCDR (item);
7352 /* Ignore cached key binding, if any. */
7353 if (CONSP (item) && CONSP (XCAR (item)))
7354 item = XCDR (item);
7356 /* Process the rest of the properties. */
7357 for (; CONSP (item) && CONSP (XCDR (item)); item = XCDR (XCDR (item)))
7359 Lisp_Object key, value;
7361 key = XCAR (item);
7362 value = XCAR (XCDR (item));
7364 if (EQ (key, QCenable))
7365 /* `:enable FORM'. */
7366 PROP (TOOL_BAR_ITEM_ENABLED_P) = value;
7367 else if (EQ (key, QCvisible))
7369 /* `:visible FORM'. If got a visible property and that
7370 evaluates to nil then ignore this item. */
7371 if (NILP (menu_item_eval_property (value)))
7372 return 0;
7374 else if (EQ (key, QChelp))
7375 /* `:help HELP-STRING'. */
7376 PROP (TOOL_BAR_ITEM_HELP) = value;
7377 else if (EQ (key, QCfilter))
7378 /* ':filter FORM'. */
7379 filter = value;
7380 else if (EQ (key, QCbutton) && CONSP (value))
7382 /* `:button (TYPE . SELECTED)'. */
7383 Lisp_Object type, selected;
7385 type = XCAR (value);
7386 selected = XCDR (value);
7387 if (EQ (type, QCtoggle) || EQ (type, QCradio))
7389 PROP (TOOL_BAR_ITEM_SELECTED_P) = selected;
7390 PROP (TOOL_BAR_ITEM_TYPE) = type;
7393 else if (EQ (key, QCimage)
7394 && (CONSP (value)
7395 || (VECTORP (value) && XVECTOR (value)->size == 4)))
7396 /* Value is either a single image specification or a vector
7397 of 4 such specifications for the different button states. */
7398 PROP (TOOL_BAR_ITEM_IMAGES) = value;
7401 /* If got a filter apply it on binding. */
7402 if (!NILP (filter))
7403 PROP (TOOL_BAR_ITEM_BINDING)
7404 = menu_item_eval_property (list2 (filter,
7405 list2 (Qquote,
7406 PROP (TOOL_BAR_ITEM_BINDING))));
7408 /* See if the binding is a keymap. Give up if it is. */
7409 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING), 0, 1)))
7410 return 0;
7412 /* Enable or disable selection of item. */
7413 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P), Qt))
7414 PROP (TOOL_BAR_ITEM_ENABLED_P)
7415 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P));
7417 /* Handle radio buttons or toggle boxes. */
7418 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P)))
7419 PROP (TOOL_BAR_ITEM_SELECTED_P)
7420 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P));
7422 return 1;
7424 #undef PROP
7428 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7429 that can be reused. */
7431 static void
7432 init_tool_bar_items (reuse)
7433 Lisp_Object reuse;
7435 if (VECTORP (reuse))
7436 tool_bar_items_vector = reuse;
7437 else
7438 tool_bar_items_vector = Fmake_vector (make_number (64), Qnil);
7439 ntool_bar_items = 0;
7443 /* Append parsed tool bar item properties from
7444 tool_bar_item_properties */
7446 static void
7447 append_tool_bar_item ()
7449 Lisp_Object *to, *from;
7451 /* Enlarge tool_bar_items_vector if necessary. */
7452 if (ntool_bar_items + TOOL_BAR_ITEM_NSLOTS
7453 >= XVECTOR (tool_bar_items_vector)->size)
7455 Lisp_Object new_vector;
7456 int old_size = XVECTOR (tool_bar_items_vector)->size;
7458 new_vector = Fmake_vector (make_number (2 * old_size), Qnil);
7459 bcopy (XVECTOR (tool_bar_items_vector)->contents,
7460 XVECTOR (new_vector)->contents,
7461 old_size * sizeof (Lisp_Object));
7462 tool_bar_items_vector = new_vector;
7465 /* Append entries from tool_bar_item_properties to the end of
7466 tool_bar_items_vector. */
7467 to = XVECTOR (tool_bar_items_vector)->contents + ntool_bar_items;
7468 from = XVECTOR (tool_bar_item_properties)->contents;
7469 bcopy (from, to, TOOL_BAR_ITEM_NSLOTS * sizeof *to);
7470 ntool_bar_items += TOOL_BAR_ITEM_NSLOTS;
7477 /* Read a character using menus based on maps in the array MAPS.
7478 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7479 Return t if we displayed a menu but the user rejected it.
7481 PREV_EVENT is the previous input event, or nil if we are reading
7482 the first event of a key sequence.
7484 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7485 if we used a mouse menu to read the input, or zero otherwise. If
7486 USED_MOUSE_MENU is null, we don't dereference it.
7488 The prompting is done based on the prompt-string of the map
7489 and the strings associated with various map elements.
7491 This can be done with X menus or with menus put in the minibuf.
7492 These are done in different ways, depending on how the input will be read.
7493 Menus using X are done after auto-saving in read-char, getting the input
7494 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7495 and do auto-saving in the inner call of read_char. */
7497 static Lisp_Object
7498 read_char_x_menu_prompt (nmaps, maps, prev_event, used_mouse_menu)
7499 int nmaps;
7500 Lisp_Object *maps;
7501 Lisp_Object prev_event;
7502 int *used_mouse_menu;
7504 int mapno;
7505 register Lisp_Object name;
7507 if (used_mouse_menu)
7508 *used_mouse_menu = 0;
7510 /* Use local over global Menu maps */
7512 if (! menu_prompting)
7513 return Qnil;
7515 /* Optionally disregard all but the global map. */
7516 if (inhibit_local_menu_bar_menus)
7518 maps += (nmaps - 1);
7519 nmaps = 1;
7522 /* Get the menu name from the first map that has one (a prompt string). */
7523 for (mapno = 0; mapno < nmaps; mapno++)
7525 name = Fkeymap_prompt (maps[mapno]);
7526 if (!NILP (name))
7527 break;
7530 /* If we don't have any menus, just read a character normally. */
7531 if (!STRINGP (name))
7532 return Qnil;
7534 #ifdef HAVE_MENUS
7535 /* If we got to this point via a mouse click,
7536 use a real menu for mouse selection. */
7537 if (EVENT_HAS_PARAMETERS (prev_event)
7538 && !EQ (XCAR (prev_event), Qmenu_bar)
7539 && !EQ (XCAR (prev_event), Qtool_bar))
7541 /* Display the menu and get the selection. */
7542 Lisp_Object *realmaps
7543 = (Lisp_Object *) alloca (nmaps * sizeof (Lisp_Object));
7544 Lisp_Object value;
7545 int nmaps1 = 0;
7547 /* Use the maps that are not nil. */
7548 for (mapno = 0; mapno < nmaps; mapno++)
7549 if (!NILP (maps[mapno]))
7550 realmaps[nmaps1++] = maps[mapno];
7552 value = Fx_popup_menu (prev_event, Flist (nmaps1, realmaps));
7553 if (CONSP (value))
7555 Lisp_Object tem;
7557 record_menu_key (XCAR (value));
7559 /* If we got multiple events, unread all but
7560 the first.
7561 There is no way to prevent those unread events
7562 from showing up later in last_nonmenu_event.
7563 So turn symbol and integer events into lists,
7564 to indicate that they came from a mouse menu,
7565 so that when present in last_nonmenu_event
7566 they won't confuse things. */
7567 for (tem = XCDR (value); !NILP (tem); tem = XCDR (tem))
7569 record_menu_key (XCAR (tem));
7570 if (SYMBOLP (XCAR (tem))
7571 || INTEGERP (XCAR (tem)))
7572 XSETCAR (tem, Fcons (XCAR (tem), Qdisabled));
7575 /* If we got more than one event, put all but the first
7576 onto this list to be read later.
7577 Return just the first event now. */
7578 Vunread_command_events
7579 = nconc2 (XCDR (value), Vunread_command_events);
7580 value = XCAR (value);
7582 else if (NILP (value))
7583 value = Qt;
7584 if (used_mouse_menu)
7585 *used_mouse_menu = 1;
7586 return value;
7588 #endif /* HAVE_MENUS */
7589 return Qnil ;
7592 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7593 We make this bigger when necessary, and never free it. */
7594 static char *read_char_minibuf_menu_text;
7595 /* Size of that buffer. */
7596 static int read_char_minibuf_menu_width;
7598 static Lisp_Object
7599 read_char_minibuf_menu_prompt (commandflag, nmaps, maps)
7600 int commandflag ;
7601 int nmaps;
7602 Lisp_Object *maps;
7604 int mapno;
7605 register Lisp_Object name;
7606 int nlength;
7607 int width = FRAME_WIDTH (SELECTED_FRAME ()) - 4;
7608 int idx = -1;
7609 int nobindings = 1;
7610 Lisp_Object rest, vector;
7611 char *menu;
7613 vector = Qnil;
7614 name = Qnil;
7616 if (! menu_prompting)
7617 return Qnil;
7619 /* Make sure we have a big enough buffer for the menu text. */
7620 if (read_char_minibuf_menu_text == 0)
7622 read_char_minibuf_menu_width = width + 4;
7623 read_char_minibuf_menu_text = (char *) xmalloc (width + 4);
7625 else if (width + 4 > read_char_minibuf_menu_width)
7627 read_char_minibuf_menu_width = width + 4;
7628 read_char_minibuf_menu_text
7629 = (char *) xrealloc (read_char_minibuf_menu_text, width + 4);
7631 menu = read_char_minibuf_menu_text;
7633 /* Get the menu name from the first map that has one (a prompt string). */
7634 for (mapno = 0; mapno < nmaps; mapno++)
7636 name = Fkeymap_prompt (maps[mapno]);
7637 if (!NILP (name))
7638 break;
7641 /* If we don't have any menus, just read a character normally. */
7642 if (!STRINGP (name))
7643 return Qnil;
7645 /* Prompt string always starts with map's prompt, and a space. */
7646 strcpy (menu, XSTRING (name)->data);
7647 nlength = STRING_BYTES (XSTRING (name));
7648 menu[nlength++] = ':';
7649 menu[nlength++] = ' ';
7650 menu[nlength] = 0;
7652 /* Start prompting at start of first map. */
7653 mapno = 0;
7654 rest = maps[mapno];
7656 /* Present the documented bindings, a line at a time. */
7657 while (1)
7659 int notfirst = 0;
7660 int i = nlength;
7661 Lisp_Object obj;
7662 int ch;
7663 Lisp_Object orig_defn_macro;
7665 /* Loop over elements of map. */
7666 while (i < width)
7668 Lisp_Object elt;
7670 /* If reached end of map, start at beginning of next map. */
7671 if (NILP (rest))
7673 mapno++;
7674 /* At end of last map, wrap around to first map if just starting,
7675 or end this line if already have something on it. */
7676 if (mapno == nmaps)
7678 mapno = 0;
7679 if (notfirst || nobindings) break;
7681 rest = maps[mapno];
7684 /* Look at the next element of the map. */
7685 if (idx >= 0)
7686 elt = XVECTOR (vector)->contents[idx];
7687 else
7688 elt = Fcar_safe (rest);
7690 if (idx < 0 && VECTORP (elt))
7692 /* If we found a dense table in the keymap,
7693 advanced past it, but start scanning its contents. */
7694 rest = Fcdr_safe (rest);
7695 vector = elt;
7696 idx = 0;
7698 else
7700 /* An ordinary element. */
7701 Lisp_Object event, tem;
7703 if (idx < 0)
7705 event = Fcar_safe (elt); /* alist */
7706 elt = Fcdr_safe (elt);
7708 else
7710 XSETINT (event, idx); /* vector */
7713 /* Ignore the element if it has no prompt string. */
7714 if (INTEGERP (event) && parse_menu_item (elt, 0, -1))
7716 /* 1 if the char to type matches the string. */
7717 int char_matches;
7718 Lisp_Object upcased_event, downcased_event;
7719 Lisp_Object desc = Qnil;
7720 Lisp_Object s
7721 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_NAME];
7723 upcased_event = Fupcase (event);
7724 downcased_event = Fdowncase (event);
7725 char_matches = (XINT (upcased_event) == XSTRING (s)->data[0]
7726 || XINT (downcased_event) == XSTRING (s)->data[0]);
7727 if (! char_matches)
7728 desc = Fsingle_key_description (event, Qnil);
7730 #if 0 /* It is redundant to list the equivalent key bindings because
7731 the prefix is what the user has already typed. */
7733 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_KEYEQ];
7734 if (!NILP (tem))
7735 /* Insert equivalent keybinding. */
7736 s = concat2 (s, tem);
7737 #endif
7739 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_TYPE];
7740 if (EQ (tem, QCradio) || EQ (tem, QCtoggle))
7742 /* Insert button prefix. */
7743 Lisp_Object selected
7744 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_SELECTED];
7745 if (EQ (tem, QCradio))
7746 tem = build_string (NILP (selected) ? "(*) " : "( ) ");
7747 else
7748 tem = build_string (NILP (selected) ? "[X] " : "[ ] ");
7749 s = concat2 (tem, s);
7753 /* If we have room for the prompt string, add it to this line.
7754 If this is the first on the line, always add it. */
7755 if ((XSTRING (s)->size + i + 2
7756 + (char_matches ? 0 : XSTRING (desc)->size + 3))
7757 < width
7758 || !notfirst)
7760 int thiswidth;
7762 /* Punctuate between strings. */
7763 if (notfirst)
7765 strcpy (menu + i, ", ");
7766 i += 2;
7768 notfirst = 1;
7769 nobindings = 0 ;
7771 /* If the char to type doesn't match the string's
7772 first char, explicitly show what char to type. */
7773 if (! char_matches)
7775 /* Add as much of string as fits. */
7776 thiswidth = XSTRING (desc)->size;
7777 if (thiswidth + i > width)
7778 thiswidth = width - i;
7779 bcopy (XSTRING (desc)->data, menu + i, thiswidth);
7780 i += thiswidth;
7781 strcpy (menu + i, " = ");
7782 i += 3;
7785 /* Add as much of string as fits. */
7786 thiswidth = XSTRING (s)->size;
7787 if (thiswidth + i > width)
7788 thiswidth = width - i;
7789 bcopy (XSTRING (s)->data, menu + i, thiswidth);
7790 i += thiswidth;
7791 menu[i] = 0;
7793 else
7795 /* If this element does not fit, end the line now,
7796 and save the element for the next line. */
7797 strcpy (menu + i, "...");
7798 break;
7802 /* Move past this element. */
7803 if (idx >= 0 && idx + 1 >= XVECTOR (vector)->size)
7804 /* Handle reaching end of dense table. */
7805 idx = -1;
7806 if (idx >= 0)
7807 idx++;
7808 else
7809 rest = Fcdr_safe (rest);
7813 /* Prompt with that and read response. */
7814 message2_nolog (menu, strlen (menu),
7815 ! NILP (current_buffer->enable_multibyte_characters));
7817 /* Make believe its not a keyboard macro in case the help char
7818 is pressed. Help characters are not recorded because menu prompting
7819 is not used on replay.
7821 orig_defn_macro = current_kboard->defining_kbd_macro;
7822 current_kboard->defining_kbd_macro = Qnil;
7824 obj = read_char (commandflag, 0, 0, Qt, 0);
7825 while (BUFFERP (obj));
7826 current_kboard->defining_kbd_macro = orig_defn_macro;
7828 if (!INTEGERP (obj))
7829 return obj;
7830 else
7831 ch = XINT (obj);
7833 if (! EQ (obj, menu_prompt_more_char)
7834 && (!INTEGERP (menu_prompt_more_char)
7835 || ! EQ (obj, make_number (Ctl (XINT (menu_prompt_more_char))))))
7837 if (!NILP (current_kboard->defining_kbd_macro))
7838 store_kbd_macro_char (obj);
7839 return obj;
7841 /* Help char - go round again */
7845 /* Reading key sequences. */
7847 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
7848 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
7849 keymap, or nil otherwise. Return the index of the first keymap in
7850 which KEY has any binding, or NMAPS if no map has a binding.
7852 If KEY is a meta ASCII character, treat it like meta-prefix-char
7853 followed by the corresponding non-meta character. Keymaps in
7854 CURRENT with non-prefix bindings for meta-prefix-char become nil in
7855 NEXT.
7857 If KEY has no bindings in any of the CURRENT maps, NEXT is left
7858 unmodified.
7860 NEXT may be the same array as CURRENT. */
7862 static int
7863 follow_key (key, nmaps, current, defs, next)
7864 Lisp_Object key;
7865 Lisp_Object *current, *defs, *next;
7866 int nmaps;
7868 int i, first_binding;
7869 int did_meta = 0;
7871 first_binding = nmaps;
7872 for (i = nmaps - 1; i >= 0; i--)
7874 if (! NILP (current[i]))
7876 Lisp_Object map;
7877 if (did_meta)
7878 map = defs[i];
7879 else
7880 map = current[i];
7882 defs[i] = access_keymap (map, key, 1, 0, 1);
7883 if (! NILP (defs[i]))
7884 first_binding = i;
7886 else
7887 defs[i] = Qnil;
7890 /* Given the set of bindings we've found, produce the next set of maps. */
7891 if (first_binding < nmaps)
7892 for (i = 0; i < nmaps; i++)
7893 next[i] = NILP (defs[i]) ? Qnil : get_keymap (defs[i], 0, 1);
7895 return first_binding;
7898 /* Read a sequence of keys that ends with a non prefix character,
7899 storing it in KEYBUF, a buffer of size BUFSIZE.
7900 Prompt with PROMPT.
7901 Return the length of the key sequence stored.
7902 Return -1 if the user rejected a command menu.
7904 Echo starting immediately unless `prompt' is 0.
7906 Where a key sequence ends depends on the currently active keymaps.
7907 These include any minor mode keymaps active in the current buffer,
7908 the current buffer's local map, and the global map.
7910 If a key sequence has no other bindings, we check Vfunction_key_map
7911 to see if some trailing subsequence might be the beginning of a
7912 function key's sequence. If so, we try to read the whole function
7913 key, and substitute its symbolic name into the key sequence.
7915 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
7916 `double-' events into similar click events, if that would make them
7917 bound. We try to turn `triple-' events first into `double-' events,
7918 then into clicks.
7920 If we get a mouse click in a mode line, vertical divider, or other
7921 non-text area, we treat the click as if it were prefixed by the
7922 symbol denoting that area - `mode-line', `vertical-line', or
7923 whatever.
7925 If the sequence starts with a mouse click, we read the key sequence
7926 with respect to the buffer clicked on, not the current buffer.
7928 If the user switches frames in the midst of a key sequence, we put
7929 off the switch-frame event until later; the next call to
7930 read_char will return it.
7932 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
7933 from the selected window's buffer. */
7935 static int
7936 read_key_sequence (keybuf, bufsize, prompt, dont_downcase_last,
7937 can_return_switch_frame, fix_current_buffer)
7938 Lisp_Object *keybuf;
7939 int bufsize;
7940 Lisp_Object prompt;
7941 int dont_downcase_last;
7942 int can_return_switch_frame;
7943 int fix_current_buffer;
7945 volatile Lisp_Object from_string;
7946 volatile int count = specpdl_ptr - specpdl;
7948 /* How many keys there are in the current key sequence. */
7949 volatile int t;
7951 /* The length of the echo buffer when we started reading, and
7952 the length of this_command_keys when we started reading. */
7953 volatile int echo_start;
7954 volatile int keys_start;
7956 /* The number of keymaps we're scanning right now, and the number of
7957 keymaps we have allocated space for. */
7958 volatile int nmaps;
7959 volatile int nmaps_allocated = 0;
7961 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
7962 the current keymaps. */
7963 Lisp_Object *volatile defs = NULL;
7965 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7966 in the current keymaps, or nil where it is not a prefix. */
7967 Lisp_Object *volatile submaps = NULL;
7969 /* The local map to start out with at start of key sequence. */
7970 volatile Lisp_Object orig_local_map;
7972 /* The map from the `keymap' property to start out with at start of
7973 key sequence. */
7974 volatile Lisp_Object orig_keymap;
7976 /* 1 if we have already considered switching to the local-map property
7977 of the place where a mouse click occurred. */
7978 volatile int localized_local_map = 0;
7980 /* The index in defs[] of the first keymap that has a binding for
7981 this key sequence. In other words, the lowest i such that
7982 defs[i] is non-nil. */
7983 volatile int first_binding;
7984 /* Index of the first key that has no binding.
7985 It is useless to try fkey_start larger than that. */
7986 volatile int first_unbound;
7988 /* If t < mock_input, then KEYBUF[t] should be read as the next
7989 input key.
7991 We use this to recover after recognizing a function key. Once we
7992 realize that a suffix of the current key sequence is actually a
7993 function key's escape sequence, we replace the suffix with the
7994 function key's binding from Vfunction_key_map. Now keybuf
7995 contains a new and different key sequence, so the echo area,
7996 this_command_keys, and the submaps and defs arrays are wrong. In
7997 this situation, we set mock_input to t, set t to 0, and jump to
7998 restart_sequence; the loop will read keys from keybuf up until
7999 mock_input, thus rebuilding the state; and then it will resume
8000 reading characters from the keyboard. */
8001 volatile int mock_input = 0;
8003 /* If the sequence is unbound in submaps[], then
8004 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
8005 and fkey_map is its binding.
8007 These might be > t, indicating that all function key scanning
8008 should hold off until t reaches them. We do this when we've just
8009 recognized a function key, to avoid searching for the function
8010 key's again in Vfunction_key_map. */
8011 volatile int fkey_start = 0, fkey_end = 0;
8012 volatile Lisp_Object fkey_map;
8014 /* Likewise, for key_translation_map. */
8015 volatile int keytran_start = 0, keytran_end = 0;
8016 volatile Lisp_Object keytran_map;
8018 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
8019 we put it off for later. While we're reading, we keep the event here. */
8020 volatile Lisp_Object delayed_switch_frame;
8022 /* See the comment below... */
8023 #if defined (GOBBLE_FIRST_EVENT)
8024 Lisp_Object first_event;
8025 #endif
8027 volatile Lisp_Object original_uppercase;
8028 volatile int original_uppercase_position = -1;
8030 /* Gets around Microsoft compiler limitations. */
8031 int dummyflag = 0;
8033 struct buffer *starting_buffer;
8035 /* Nonzero if we seem to have got the beginning of a binding
8036 in function_key_map. */
8037 volatile int function_key_possible = 0;
8038 volatile int key_translation_possible = 0;
8040 /* List of events for which a fake prefix key has been generated. */
8041 volatile Lisp_Object fake_prefixed_keys = Qnil;
8043 /* Save the status of key translation before each step,
8044 so that we can restore this after downcasing. */
8045 Lisp_Object prev_fkey_map;
8046 int prev_fkey_start;
8047 int prev_fkey_end;
8049 Lisp_Object prev_keytran_map;
8050 int prev_keytran_start;
8051 int prev_keytran_end;
8053 #if defined (GOBBLE_FIRST_EVENT)
8054 int junk;
8055 #endif
8057 struct gcpro gcpro1;
8059 GCPRO1 (fake_prefixed_keys);
8060 raw_keybuf_count = 0;
8062 last_nonmenu_event = Qnil;
8064 delayed_switch_frame = Qnil;
8065 fkey_map = Vfunction_key_map;
8066 keytran_map = Vkey_translation_map;
8068 /* If there is no function-key-map, turn off function key scanning. */
8069 if (!KEYMAPP (Vfunction_key_map))
8070 fkey_start = fkey_end = bufsize + 1;
8072 /* If there is no key-translation-map, turn off scanning. */
8073 if (!KEYMAPP (Vkey_translation_map))
8074 keytran_start = keytran_end = bufsize + 1;
8076 if (INTERACTIVE)
8078 if (!NILP (prompt))
8079 echo_prompt (prompt);
8080 else if (cursor_in_echo_area
8081 && (FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
8082 && NILP (Fzerop (Vecho_keystrokes)))
8083 /* This doesn't put in a dash if the echo buffer is empty, so
8084 you don't always see a dash hanging out in the minibuffer. */
8085 echo_dash ();
8088 /* Record the initial state of the echo area and this_command_keys;
8089 we will need to restore them if we replay a key sequence. */
8090 if (INTERACTIVE)
8091 echo_start = echo_length ();
8092 keys_start = this_command_key_count;
8093 this_single_command_key_start = keys_start;
8095 #if defined (GOBBLE_FIRST_EVENT)
8096 /* This doesn't quite work, because some of the things that read_char
8097 does cannot safely be bypassed. It seems too risky to try to make
8098 this work right. */
8100 /* Read the first char of the sequence specially, before setting
8101 up any keymaps, in case a filter runs and switches buffers on us. */
8102 first_event = read_char (NILP (prompt), 0, submaps, last_nonmenu_event,
8103 &junk);
8104 #endif /* GOBBLE_FIRST_EVENT */
8106 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
8107 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
8108 from_string = Qnil;
8110 /* We jump here when the key sequence has been thoroughly changed, and
8111 we need to rescan it starting from the beginning. When we jump here,
8112 keybuf[0..mock_input] holds the sequence we should reread. */
8113 replay_sequence:
8115 starting_buffer = current_buffer;
8116 function_key_possible = 0;
8117 key_translation_possible = 0;
8118 first_unbound = bufsize + 1;
8120 /* Build our list of keymaps.
8121 If we recognize a function key and replace its escape sequence in
8122 keybuf with its symbol, or if the sequence starts with a mouse
8123 click and we need to switch buffers, we jump back here to rebuild
8124 the initial keymaps from the current buffer. */
8125 nmaps = 0;
8127 if (!NILP (current_kboard->Voverriding_terminal_local_map)
8128 || !NILP (Voverriding_local_map))
8130 if (3 > nmaps_allocated)
8132 submaps = (Lisp_Object *) alloca (3 * sizeof (submaps[0]));
8133 defs = (Lisp_Object *) alloca (3 * sizeof (defs[0]));
8134 nmaps_allocated = 3;
8136 if (!NILP (current_kboard->Voverriding_terminal_local_map))
8137 submaps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
8138 if (!NILP (Voverriding_local_map))
8139 submaps[nmaps++] = Voverriding_local_map;
8141 else
8143 int nminor;
8144 int total;
8145 Lisp_Object *maps;
8147 nminor = current_minor_maps (0, &maps);
8148 total = nminor + (!NILP (orig_keymap) ? 3 : 2);
8150 if (total > nmaps_allocated)
8152 submaps = (Lisp_Object *) alloca (total * sizeof (submaps[0]));
8153 defs = (Lisp_Object *) alloca (total * sizeof (defs[0]));
8154 nmaps_allocated = total;
8157 if (!NILP (orig_keymap))
8158 submaps[nmaps++] = orig_keymap;
8160 bcopy (maps, (void *) (submaps + nmaps),
8161 nminor * sizeof (submaps[0]));
8163 nmaps += nminor;
8165 submaps[nmaps++] = orig_local_map;
8167 submaps[nmaps++] = current_global_map;
8169 /* Find an accurate initial value for first_binding. */
8170 for (first_binding = 0; first_binding < nmaps; first_binding++)
8171 if (! NILP (submaps[first_binding]))
8172 break;
8174 /* Start from the beginning in keybuf. */
8175 t = 0;
8177 /* These are no-ops the first time through, but if we restart, they
8178 revert the echo area and this_command_keys to their original state. */
8179 this_command_key_count = keys_start;
8180 if (INTERACTIVE && t < mock_input)
8181 echo_truncate (echo_start);
8183 /* If the best binding for the current key sequence is a keymap, or
8184 we may be looking at a function key's escape sequence, keep on
8185 reading. */
8186 while ((first_binding < nmaps && ! NILP (submaps[first_binding]))
8187 || (first_binding >= nmaps
8188 && fkey_start < t)
8189 || (first_binding >= nmaps
8190 && keytran_start < t && key_translation_possible)
8191 /* Don't return in the middle of a possible function key sequence,
8192 if the only bindings we found were via case conversion.
8193 Thus, if ESC O a has a function-key-map translation
8194 and ESC o has a binding, don't return after ESC O,
8195 so that we can translate ESC O plus the next character. */
8198 Lisp_Object key;
8199 int used_mouse_menu = 0;
8201 /* Where the last real key started. If we need to throw away a
8202 key that has expanded into more than one element of keybuf
8203 (say, a mouse click on the mode line which is being treated
8204 as [mode-line (mouse-...)], then we backtrack to this point
8205 of keybuf. */
8206 volatile int last_real_key_start;
8208 /* These variables are analogous to echo_start and keys_start;
8209 while those allow us to restart the entire key sequence,
8210 echo_local_start and keys_local_start allow us to throw away
8211 just one key. */
8212 volatile int echo_local_start, keys_local_start, local_first_binding;
8215 if (first_unbound < fkey_start && first_unbound < keytran_start)
8216 { /* The prefix upto first_unbound has no binding and has
8217 no translation left to do either, so we know it's unbound.
8218 If we don't stop now, we risk staying here indefinitely
8219 (if the user keeps entering fkey or keytran prefixes
8220 like C-c ESC ESC ESC ESC ...) */
8221 int i;
8222 for (i = first_unbound + 1; i < t; i++)
8223 keybuf[i - first_unbound - 1] = keybuf[i];
8224 mock_input = t - first_unbound - 1;
8225 fkey_end = fkey_start -= first_unbound + 1;
8226 fkey_map = Vfunction_key_map;
8227 keytran_end = keytran_start -= first_unbound + 1;
8228 keytran_map = Vkey_translation_map;
8229 goto replay_sequence;
8232 if (t >= bufsize)
8233 error ("Key sequence too long");
8235 if (INTERACTIVE)
8236 echo_local_start = echo_length ();
8237 keys_local_start = this_command_key_count;
8238 local_first_binding = first_binding;
8240 replay_key:
8241 /* These are no-ops, unless we throw away a keystroke below and
8242 jumped back up to replay_key; in that case, these restore the
8243 variables to their original state, allowing us to replay the
8244 loop. */
8245 if (INTERACTIVE && t < mock_input)
8246 echo_truncate (echo_local_start);
8247 this_command_key_count = keys_local_start;
8248 first_binding = local_first_binding;
8250 /* By default, assume each event is "real". */
8251 last_real_key_start = t;
8253 /* Does mock_input indicate that we are re-reading a key sequence? */
8254 if (t < mock_input)
8256 key = keybuf[t];
8257 add_command_key (key);
8258 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
8259 && NILP (Fzerop (Vecho_keystrokes)))
8260 echo_char (key);
8263 /* If not, we should actually read a character. */
8264 else
8267 #ifdef MULTI_KBOARD
8268 KBOARD *interrupted_kboard = current_kboard;
8269 struct frame *interrupted_frame = SELECTED_FRAME ();
8270 if (setjmp (wrong_kboard_jmpbuf))
8272 if (!NILP (delayed_switch_frame))
8274 interrupted_kboard->kbd_queue
8275 = Fcons (delayed_switch_frame,
8276 interrupted_kboard->kbd_queue);
8277 delayed_switch_frame = Qnil;
8279 while (t > 0)
8280 interrupted_kboard->kbd_queue
8281 = Fcons (keybuf[--t], interrupted_kboard->kbd_queue);
8283 /* If the side queue is non-empty, ensure it begins with a
8284 switch-frame, so we'll replay it in the right context. */
8285 if (CONSP (interrupted_kboard->kbd_queue)
8286 && (key = XCAR (interrupted_kboard->kbd_queue),
8287 !(EVENT_HAS_PARAMETERS (key)
8288 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key)),
8289 Qswitch_frame))))
8291 Lisp_Object frame;
8292 XSETFRAME (frame, interrupted_frame);
8293 interrupted_kboard->kbd_queue
8294 = Fcons (make_lispy_switch_frame (frame),
8295 interrupted_kboard->kbd_queue);
8297 mock_input = 0;
8298 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
8299 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
8300 goto replay_sequence;
8302 #endif
8303 key = read_char (NILP (prompt), nmaps,
8304 (Lisp_Object *) submaps, last_nonmenu_event,
8305 &used_mouse_menu);
8308 /* read_char returns t when it shows a menu and the user rejects it.
8309 Just return -1. */
8310 if (EQ (key, Qt))
8312 unbind_to (count, Qnil);
8313 UNGCPRO;
8314 return -1;
8317 /* read_char returns -1 at the end of a macro.
8318 Emacs 18 handles this by returning immediately with a
8319 zero, so that's what we'll do. */
8320 if (INTEGERP (key) && XINT (key) == -1)
8322 t = 0;
8323 /* The Microsoft C compiler can't handle the goto that
8324 would go here. */
8325 dummyflag = 1;
8326 break;
8329 /* If the current buffer has been changed from under us, the
8330 keymap may have changed, so replay the sequence. */
8331 if (BUFFERP (key))
8333 mock_input = t;
8334 /* Reset the current buffer from the selected window
8335 in case something changed the former and not the latter.
8336 This is to be more consistent with the behavior
8337 of the command_loop_1. */
8338 if (fix_current_buffer)
8340 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
8341 Fkill_emacs (Qnil);
8342 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
8343 Fset_buffer (XWINDOW (selected_window)->buffer);
8346 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
8347 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
8348 goto replay_sequence;
8351 /* If we have a quit that was typed in another frame, and
8352 quit_throw_to_read_char switched buffers,
8353 replay to get the right keymap. */
8354 if (INTEGERP (key)
8355 && XINT (key) == quit_char
8356 && current_buffer != starting_buffer)
8358 GROW_RAW_KEYBUF;
8359 XVECTOR (raw_keybuf)->contents[raw_keybuf_count++] = key;
8360 keybuf[t++] = key;
8361 mock_input = t;
8362 Vquit_flag = Qnil;
8363 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
8364 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
8365 goto replay_sequence;
8368 Vquit_flag = Qnil;
8370 if (EVENT_HAS_PARAMETERS (key)
8371 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key)), Qswitch_frame))
8373 /* If we're at the beginning of a key sequence, and the caller
8374 says it's okay, go ahead and return this event. If we're
8375 in the midst of a key sequence, delay it until the end. */
8376 if (t > 0 || !can_return_switch_frame)
8378 delayed_switch_frame = key;
8379 goto replay_key;
8383 GROW_RAW_KEYBUF;
8384 XVECTOR (raw_keybuf)->contents[raw_keybuf_count++] = key;
8387 /* Clicks in non-text areas get prefixed by the symbol
8388 in their CHAR-ADDRESS field. For example, a click on
8389 the mode line is prefixed by the symbol `mode-line'.
8391 Furthermore, key sequences beginning with mouse clicks
8392 are read using the keymaps of the buffer clicked on, not
8393 the current buffer. So we may have to switch the buffer
8394 here.
8396 When we turn one event into two events, we must make sure
8397 that neither of the two looks like the original--so that,
8398 if we replay the events, they won't be expanded again.
8399 If not for this, such reexpansion could happen either here
8400 or when user programs play with this-command-keys. */
8401 if (EVENT_HAS_PARAMETERS (key))
8403 Lisp_Object kind;
8405 kind = EVENT_HEAD_KIND (EVENT_HEAD (key));
8406 if (EQ (kind, Qmouse_click))
8408 Lisp_Object window, posn;
8410 window = POSN_WINDOW (EVENT_START (key));
8411 posn = POSN_BUFFER_POSN (EVENT_START (key));
8413 if (CONSP (posn)
8414 || (!NILP (fake_prefixed_keys)
8415 && !NILP (Fmemq (key, fake_prefixed_keys))))
8417 /* We're looking a second time at an event for which
8418 we generated a fake prefix key. Set
8419 last_real_key_start appropriately. */
8420 if (t > 0)
8421 last_real_key_start = t - 1;
8424 /* Key sequences beginning with mouse clicks are
8425 read using the keymaps in the buffer clicked on,
8426 not the current buffer. If we're at the
8427 beginning of a key sequence, switch buffers. */
8428 if (last_real_key_start == 0
8429 && WINDOWP (window)
8430 && BUFFERP (XWINDOW (window)->buffer)
8431 && XBUFFER (XWINDOW (window)->buffer) != current_buffer)
8433 XVECTOR (raw_keybuf)->contents[raw_keybuf_count++] = key;
8434 keybuf[t] = key;
8435 mock_input = t + 1;
8437 /* Arrange to go back to the original buffer once we're
8438 done reading the key sequence. Note that we can't
8439 use save_excursion_{save,restore} here, because they
8440 save point as well as the current buffer; we don't
8441 want to save point, because redisplay may change it,
8442 to accommodate a Fset_window_start or something. We
8443 don't want to do this at the top of the function,
8444 because we may get input from a subprocess which
8445 wants to change the selected window and stuff (say,
8446 emacsclient). */
8447 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
8449 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
8450 Fkill_emacs (Qnil);
8451 set_buffer_internal (XBUFFER (XWINDOW (window)->buffer));
8452 orig_local_map = get_local_map (PT, current_buffer,
8453 Qlocal_map);
8454 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
8455 goto replay_sequence;
8458 /* For a mouse click, get the local text-property keymap
8459 of the place clicked on, rather than point. */
8460 if (last_real_key_start == 0
8461 && CONSP (XCDR (key))
8462 && ! localized_local_map)
8464 Lisp_Object map_here, start, pos;
8466 localized_local_map = 1;
8467 start = EVENT_START (key);
8469 if (CONSP (start) && CONSP (XCDR (start)))
8471 pos = POSN_BUFFER_POSN (start);
8472 if (INTEGERP (pos)
8473 && XINT (pos) >= BEG && XINT (pos) <= Z)
8475 map_here = get_local_map (XINT (pos),
8476 current_buffer, Qlocal_map);
8477 if (!EQ (map_here, orig_local_map))
8479 orig_local_map = map_here;
8480 keybuf[t] = key;
8481 mock_input = t + 1;
8483 goto replay_sequence;
8485 map_here = get_local_map (XINT (pos),
8486 current_buffer, Qkeymap);
8487 if (!EQ (map_here, orig_keymap))
8489 orig_keymap = map_here;
8490 keybuf[t] = key;
8491 mock_input = t + 1;
8493 goto replay_sequence;
8499 /* Expand mode-line and scroll-bar events into two events:
8500 use posn as a fake prefix key. */
8501 if (SYMBOLP (posn)
8502 && (NILP (fake_prefixed_keys)
8503 || NILP (Fmemq (key, fake_prefixed_keys))))
8505 if (t + 1 >= bufsize)
8506 error ("Key sequence too long");
8508 keybuf[t] = posn;
8509 keybuf[t + 1] = key;
8510 mock_input = t + 2;
8512 /* Record that a fake prefix key has been generated
8513 for KEY. Don't modify the event; this would
8514 prevent proper action when the event is pushed
8515 back tino unread-command-events. */
8516 fake_prefixed_keys = Fcons (key, fake_prefixed_keys);
8518 /* If on a mode line string with a local keymap,
8519 reconsider the key sequence with that keymap. */
8520 if (CONSP (POSN_STRING (EVENT_START (key))))
8522 Lisp_Object string, pos, map, map2;
8524 string = POSN_STRING (EVENT_START (key));
8525 pos = XCDR (string);
8526 string = XCAR (string);
8527 if (XINT (pos) >= 0
8528 && XINT (pos) < XSTRING (string)->size)
8530 map = Fget_text_property (pos, Qlocal_map, string);
8531 if (!NILP (map))
8532 orig_local_map = map;
8533 map2 = Fget_text_property (pos, Qkeymap, string);
8534 if (!NILP (map2))
8535 orig_keymap = map2;
8536 if (!NILP (map) || !NILP (map2))
8537 goto replay_sequence;
8541 goto replay_key;
8543 else if (CONSP (POSN_STRING (EVENT_START (key)))
8544 && NILP (from_string))
8546 /* For a click on a string, i.e. overlay string or a
8547 string displayed via the `display' property,
8548 consider `local-map' and `keymap' properties of
8549 that string. */
8550 Lisp_Object string, pos, map, map2;
8552 string = POSN_STRING (EVENT_START (key));
8553 pos = XCDR (string);
8554 string = XCAR (string);
8555 if (XINT (pos) >= 0
8556 && XINT (pos) < XSTRING (string)->size)
8558 map = Fget_text_property (pos, Qlocal_map, string);
8559 if (!NILP (map))
8560 orig_local_map = map;
8561 map2 = Fget_text_property (pos, Qkeymap, string);
8562 if (!NILP (map2))
8563 orig_keymap = map2;
8565 if (!NILP (map) || !NILP (map2))
8567 from_string = string;
8568 goto replay_sequence;
8573 else if (CONSP (XCDR (key))
8574 && CONSP (EVENT_START (key))
8575 && CONSP (XCDR (EVENT_START (key))))
8577 Lisp_Object posn;
8579 posn = POSN_BUFFER_POSN (EVENT_START (key));
8580 /* Handle menu-bar events:
8581 insert the dummy prefix event `menu-bar'. */
8582 if (EQ (posn, Qmenu_bar) || EQ (posn, Qtool_bar))
8584 if (t + 1 >= bufsize)
8585 error ("Key sequence too long");
8586 keybuf[t] = posn;
8587 keybuf[t+1] = key;
8589 /* Zap the position in key, so we know that we've
8590 expanded it, and don't try to do so again. */
8591 POSN_BUFFER_SET_POSN (EVENT_START (key),
8592 Fcons (posn, Qnil));
8594 mock_input = t + 2;
8595 goto replay_sequence;
8597 else if (CONSP (posn))
8599 /* We're looking at the second event of a
8600 sequence which we expanded before. Set
8601 last_real_key_start appropriately. */
8602 if (last_real_key_start == t && t > 0)
8603 last_real_key_start = t - 1;
8608 /* We have finally decided that KEY is something we might want
8609 to look up. */
8610 first_binding = (follow_key (key,
8611 nmaps - first_binding,
8612 submaps + first_binding,
8613 defs + first_binding,
8614 submaps + first_binding)
8615 + first_binding);
8617 /* If KEY wasn't bound, we'll try some fallbacks. */
8618 if (first_binding >= nmaps)
8620 Lisp_Object head;
8622 /* Remember the position to put an upper bound on fkey_start. */
8623 first_unbound = min (t, first_unbound);
8625 head = EVENT_HEAD (key);
8626 if (help_char_p (head) && t > 0)
8628 read_key_sequence_cmd = Vprefix_help_command;
8629 keybuf[t++] = key;
8630 last_nonmenu_event = key;
8631 /* The Microsoft C compiler can't handle the goto that
8632 would go here. */
8633 dummyflag = 1;
8634 break;
8637 if (SYMBOLP (head))
8639 Lisp_Object breakdown;
8640 int modifiers;
8642 breakdown = parse_modifiers (head);
8643 modifiers = XINT (XCAR (XCDR (breakdown)));
8644 /* Attempt to reduce an unbound mouse event to a simpler
8645 event that is bound:
8646 Drags reduce to clicks.
8647 Double-clicks reduce to clicks.
8648 Triple-clicks reduce to double-clicks, then to clicks.
8649 Down-clicks are eliminated.
8650 Double-downs reduce to downs, then are eliminated.
8651 Triple-downs reduce to double-downs, then to downs,
8652 then are eliminated. */
8653 if (modifiers & (down_modifier | drag_modifier
8654 | double_modifier | triple_modifier))
8656 while (modifiers & (down_modifier | drag_modifier
8657 | double_modifier | triple_modifier))
8659 Lisp_Object new_head, new_click;
8660 if (modifiers & triple_modifier)
8661 modifiers ^= (double_modifier | triple_modifier);
8662 else if (modifiers & double_modifier)
8663 modifiers &= ~double_modifier;
8664 else if (modifiers & drag_modifier)
8665 modifiers &= ~drag_modifier;
8666 else
8668 /* Dispose of this `down' event by simply jumping
8669 back to replay_key, to get another event.
8671 Note that if this event came from mock input,
8672 then just jumping back to replay_key will just
8673 hand it to us again. So we have to wipe out any
8674 mock input.
8676 We could delete keybuf[t] and shift everything
8677 after that to the left by one spot, but we'd also
8678 have to fix up any variable that points into
8679 keybuf, and shifting isn't really necessary
8680 anyway.
8682 Adding prefixes for non-textual mouse clicks
8683 creates two characters of mock input, and both
8684 must be thrown away. If we're only looking at
8685 the prefix now, we can just jump back to
8686 replay_key. On the other hand, if we've already
8687 processed the prefix, and now the actual click
8688 itself is giving us trouble, then we've lost the
8689 state of the keymaps we want to backtrack to, and
8690 we need to replay the whole sequence to rebuild
8693 Beyond that, only function key expansion could
8694 create more than two keys, but that should never
8695 generate mouse events, so it's okay to zero
8696 mock_input in that case too.
8698 Isn't this just the most wonderful code ever? */
8699 if (t == last_real_key_start)
8701 mock_input = 0;
8702 goto replay_key;
8704 else
8706 mock_input = last_real_key_start;
8707 goto replay_sequence;
8711 new_head
8712 = apply_modifiers (modifiers, XCAR (breakdown));
8713 new_click
8714 = Fcons (new_head, Fcons (EVENT_START (key), Qnil));
8716 /* Look for a binding for this new key. follow_key
8717 promises that it didn't munge submaps the
8718 last time we called it, since key was unbound. */
8719 first_binding
8720 = (follow_key (new_click,
8721 nmaps - local_first_binding,
8722 submaps + local_first_binding,
8723 defs + local_first_binding,
8724 submaps + local_first_binding)
8725 + local_first_binding);
8727 /* If that click is bound, go for it. */
8728 if (first_binding < nmaps)
8730 key = new_click;
8731 break;
8733 /* Otherwise, we'll leave key set to the drag event. */
8739 keybuf[t++] = key;
8740 /* Normally, last_nonmenu_event gets the previous key we read.
8741 But when a mouse popup menu is being used,
8742 we don't update last_nonmenu_event; it continues to hold the mouse
8743 event that preceded the first level of menu. */
8744 if (!used_mouse_menu)
8745 last_nonmenu_event = key;
8747 /* Record what part of this_command_keys is the current key sequence. */
8748 this_single_command_key_start = this_command_key_count - t;
8750 prev_fkey_map = fkey_map;
8751 prev_fkey_start = fkey_start;
8752 prev_fkey_end = fkey_end;
8754 prev_keytran_map = keytran_map;
8755 prev_keytran_start = keytran_start;
8756 prev_keytran_end = keytran_end;
8758 /* If the sequence is unbound, see if we can hang a function key
8759 off the end of it. We only want to scan real keyboard input
8760 for function key sequences, so if mock_input says that we're
8761 re-reading old events, don't examine it. */
8762 if (first_binding >= nmaps
8763 && t >= mock_input)
8765 Lisp_Object fkey_next;
8767 /* Continue scan from fkey_end until we find a bound suffix.
8768 If we fail, increment fkey_start
8769 and start fkey_end from there. */
8770 while (fkey_end < t)
8772 Lisp_Object key;
8774 key = keybuf[fkey_end++];
8775 fkey_next
8776 = access_keymap (fkey_map, key, 1, 0, 1);
8778 /* Handle symbol with autoload definition. */
8779 if (SYMBOLP (fkey_next) && ! NILP (Ffboundp (fkey_next))
8780 && CONSP (XSYMBOL (fkey_next)->function)
8781 && EQ (XCAR (XSYMBOL (fkey_next)->function), Qautoload))
8782 do_autoload (XSYMBOL (fkey_next)->function,
8783 fkey_next);
8785 /* Handle a symbol whose function definition is a keymap
8786 or an array. */
8787 if (SYMBOLP (fkey_next) && ! NILP (Ffboundp (fkey_next))
8788 && (!NILP (Farrayp (XSYMBOL (fkey_next)->function))
8789 || KEYMAPP (XSYMBOL (fkey_next)->function)))
8790 fkey_next = XSYMBOL (fkey_next)->function;
8792 #if 0 /* I didn't turn this on, because it might cause trouble
8793 for the mapping of return into C-m and tab into C-i. */
8794 /* Optionally don't map function keys into other things.
8795 This enables the user to redefine kp- keys easily. */
8796 if (SYMBOLP (key) && !NILP (Vinhibit_function_key_mapping))
8797 fkey_next = Qnil;
8798 #endif
8800 /* If the function key map gives a function, not an
8801 array, then call the function with no args and use
8802 its value instead. */
8803 if (SYMBOLP (fkey_next) && ! NILP (Ffboundp (fkey_next))
8804 && fkey_end == t)
8806 struct gcpro gcpro1, gcpro2, gcpro3;
8807 Lisp_Object tem;
8808 tem = fkey_next;
8810 GCPRO3 (fkey_map, keytran_map, delayed_switch_frame);
8811 fkey_next = call1 (fkey_next, prompt);
8812 UNGCPRO;
8813 /* If the function returned something invalid,
8814 barf--don't ignore it.
8815 (To ignore it safely, we would need to gcpro a bunch of
8816 other variables.) */
8817 if (! (VECTORP (fkey_next) || STRINGP (fkey_next)))
8818 error ("Function in key-translation-map returns invalid key sequence");
8821 function_key_possible = ! NILP (fkey_next);
8823 /* If keybuf[fkey_start..fkey_end] is bound in the
8824 function key map and it's a suffix of the current
8825 sequence (i.e. fkey_end == t), replace it with
8826 the binding and restart with fkey_start at the end. */
8827 if ((VECTORP (fkey_next) || STRINGP (fkey_next))
8828 && fkey_end == t)
8830 int len = XFASTINT (Flength (fkey_next));
8832 t = fkey_start + len;
8833 if (t >= bufsize)
8834 error ("Key sequence too long");
8836 if (VECTORP (fkey_next))
8837 bcopy (XVECTOR (fkey_next)->contents,
8838 keybuf + fkey_start,
8839 (t - fkey_start) * sizeof (keybuf[0]));
8840 else if (STRINGP (fkey_next))
8842 int i;
8844 for (i = 0; i < len; i++)
8845 XSETFASTINT (keybuf[fkey_start + i],
8846 XSTRING (fkey_next)->data[i]);
8849 mock_input = t;
8850 fkey_start = fkey_end = t;
8851 fkey_map = Vfunction_key_map;
8853 /* Do pass the results through key-translation-map.
8854 But don't retranslate what key-translation-map
8855 has already translated. */
8856 keytran_end = keytran_start;
8857 keytran_map = Vkey_translation_map;
8859 goto replay_sequence;
8862 fkey_map = get_keymap (fkey_next, 0, 1);
8864 /* If we no longer have a bound suffix, try a new positions for
8865 fkey_start. */
8866 if (!CONSP (fkey_map))
8868 fkey_end = ++fkey_start;
8869 fkey_map = Vfunction_key_map;
8870 function_key_possible = 0;
8875 /* Look for this sequence in key-translation-map. */
8877 Lisp_Object keytran_next;
8879 /* Scan from keytran_end until we find a bound suffix. */
8880 while (keytran_end < t)
8882 Lisp_Object key;
8884 key = keybuf[keytran_end++];
8885 keytran_next
8886 = access_keymap (keytran_map, key, 1, 0, 1);
8888 /* Handle symbol with autoload definition. */
8889 if (SYMBOLP (keytran_next) && ! NILP (Ffboundp (keytran_next))
8890 && CONSP (XSYMBOL (keytran_next)->function)
8891 && EQ (XCAR (XSYMBOL (keytran_next)->function), Qautoload))
8892 do_autoload (XSYMBOL (keytran_next)->function,
8893 keytran_next);
8895 /* Handle a symbol whose function definition is a keymap
8896 or an array. */
8897 if (SYMBOLP (keytran_next) && ! NILP (Ffboundp (keytran_next))
8898 && (!NILP (Farrayp (XSYMBOL (keytran_next)->function))
8899 || KEYMAPP (XSYMBOL (keytran_next)->function)))
8900 keytran_next = XSYMBOL (keytran_next)->function;
8902 /* If the key translation map gives a function, not an
8903 array, then call the function with one arg and use
8904 its value instead. */
8905 if (SYMBOLP (keytran_next) && ! NILP (Ffboundp (keytran_next))
8906 && keytran_end == t)
8908 struct gcpro gcpro1, gcpro2, gcpro3;
8909 Lisp_Object tem;
8910 tem = keytran_next;
8912 GCPRO3 (fkey_map, keytran_map, delayed_switch_frame);
8913 keytran_next = call1 (keytran_next, prompt);
8914 UNGCPRO;
8915 /* If the function returned something invalid,
8916 barf--don't ignore it.
8917 (To ignore it safely, we would need to gcpro a bunch of
8918 other variables.) */
8919 if (! (VECTORP (keytran_next) || STRINGP (keytran_next)))
8920 error ("Function in key-translation-map returns invalid key sequence");
8923 key_translation_possible = ! NILP (keytran_next);
8925 /* If keybuf[keytran_start..keytran_end] is bound in the
8926 key translation map and it's a suffix of the current
8927 sequence (i.e. keytran_end == t), replace it with
8928 the binding and restart with keytran_start at the end. */
8929 if ((VECTORP (keytran_next) || STRINGP (keytran_next))
8930 && keytran_end == t)
8932 int len = XFASTINT (Flength (keytran_next));
8934 t = keytran_start + len;
8935 if (t >= bufsize)
8936 error ("Key sequence too long");
8938 if (VECTORP (keytran_next))
8939 bcopy (XVECTOR (keytran_next)->contents,
8940 keybuf + keytran_start,
8941 (t - keytran_start) * sizeof (keybuf[0]));
8942 else if (STRINGP (keytran_next))
8944 int i;
8946 for (i = 0; i < len; i++)
8947 XSETFASTINT (keybuf[keytran_start + i],
8948 XSTRING (keytran_next)->data[i]);
8951 mock_input = t;
8952 keytran_start = keytran_end = t;
8953 keytran_map = Vkey_translation_map;
8955 /* Don't pass the results of key-translation-map
8956 through function-key-map. */
8957 fkey_start = fkey_end = t;
8958 fkey_map = Vfunction_key_map;
8960 goto replay_sequence;
8963 keytran_map = get_keymap (keytran_next, 0, 1);
8965 /* If we no longer have a bound suffix, try a new positions for
8966 keytran_start. */
8967 if (!CONSP (keytran_map))
8969 keytran_end = ++keytran_start;
8970 keytran_map = Vkey_translation_map;
8971 key_translation_possible = 0;
8976 /* If KEY is not defined in any of the keymaps,
8977 and cannot be part of a function key or translation,
8978 and is an upper case letter
8979 use the corresponding lower-case letter instead. */
8980 if (first_binding == nmaps && ! function_key_possible
8981 && ! key_translation_possible
8982 && INTEGERP (key)
8983 && ((((XINT (key) & 0x3ffff)
8984 < XCHAR_TABLE (current_buffer->downcase_table)->size)
8985 && UPPERCASEP (XINT (key) & 0x3ffff))
8986 || (XINT (key) & shift_modifier)))
8988 Lisp_Object new_key;
8990 original_uppercase = key;
8991 original_uppercase_position = t - 1;
8993 if (XINT (key) & shift_modifier)
8994 XSETINT (new_key, XINT (key) & ~shift_modifier);
8995 else
8996 XSETINT (new_key, (DOWNCASE (XINT (key) & 0x3ffff)
8997 | (XINT (key) & ~0x3ffff)));
8999 /* We have to do this unconditionally, regardless of whether
9000 the lower-case char is defined in the keymaps, because they
9001 might get translated through function-key-map. */
9002 keybuf[t - 1] = new_key;
9003 mock_input = t;
9005 fkey_map = prev_fkey_map;
9006 fkey_start = prev_fkey_start;
9007 fkey_end = prev_fkey_end;
9009 keytran_map = prev_keytran_map;
9010 keytran_start = prev_keytran_start;
9011 keytran_end = prev_keytran_end;
9013 goto replay_sequence;
9015 /* If KEY is not defined in any of the keymaps,
9016 and cannot be part of a function key or translation,
9017 and is a shifted function key,
9018 use the corresponding unshifted function key instead. */
9019 if (first_binding == nmaps && ! function_key_possible
9020 && ! key_translation_possible
9021 && SYMBOLP (key))
9023 Lisp_Object breakdown;
9024 int modifiers;
9026 breakdown = parse_modifiers (key);
9027 modifiers = XINT (XCAR (XCDR (breakdown)));
9028 if (modifiers & shift_modifier)
9030 Lisp_Object new_key;
9032 original_uppercase = key;
9033 original_uppercase_position = t - 1;
9035 modifiers &= ~shift_modifier;
9036 new_key = apply_modifiers (modifiers,
9037 XCAR (breakdown));
9039 keybuf[t - 1] = new_key;
9040 mock_input = t;
9042 fkey_map = prev_fkey_map;
9043 fkey_start = prev_fkey_start;
9044 fkey_end = prev_fkey_end;
9046 keytran_map = prev_keytran_map;
9047 keytran_start = prev_keytran_start;
9048 keytran_end = prev_keytran_end;
9050 goto replay_sequence;
9055 if (!dummyflag)
9056 read_key_sequence_cmd = (first_binding < nmaps
9057 ? defs[first_binding]
9058 : Qnil);
9060 unread_switch_frame = delayed_switch_frame;
9061 unbind_to (count, Qnil);
9063 /* Don't downcase the last character if the caller says don't.
9064 Don't downcase it if the result is undefined, either. */
9065 if ((dont_downcase_last || first_binding >= nmaps)
9066 && t - 1 == original_uppercase_position)
9067 keybuf[t - 1] = original_uppercase;
9069 /* Occasionally we fabricate events, perhaps by expanding something
9070 according to function-key-map, or by adding a prefix symbol to a
9071 mouse click in the scroll bar or modeline. In this cases, return
9072 the entire generated key sequence, even if we hit an unbound
9073 prefix or a definition before the end. This means that you will
9074 be able to push back the event properly, and also means that
9075 read-key-sequence will always return a logical unit.
9077 Better ideas? */
9078 for (; t < mock_input; t++)
9080 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
9081 && NILP (Fzerop (Vecho_keystrokes)))
9082 echo_char (keybuf[t]);
9083 add_command_key (keybuf[t]);
9088 UNGCPRO;
9089 return t;
9092 DEFUN ("read-key-sequence", Fread_key_sequence, Sread_key_sequence, 1, 5, 0,
9093 doc: /* Read a sequence of keystrokes and return as a string or vector.
9094 The sequence is sufficient to specify a non-prefix command in the
9095 current local and global maps.
9097 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9098 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9099 as a continuation of the previous key.
9101 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9102 convert the last event to lower case. (Normally any upper case event
9103 is converted to lower case if the original event is undefined and the lower
9104 case equivalent is defined.) A non-nil value is appropriate for reading
9105 a key sequence to be defined.
9107 A C-g typed while in this function is treated like any other character,
9108 and `quit-flag' is not set.
9110 If the key sequence starts with a mouse click, then the sequence is read
9111 using the keymaps of the buffer of the window clicked in, not the buffer
9112 of the selected window as normal.
9114 `read-key-sequence' drops unbound button-down events, since you normally
9115 only care about the click or drag events which follow them. If a drag
9116 or multi-click event is unbound, but the corresponding click event would
9117 be bound, `read-key-sequence' turns the event into a click event at the
9118 drag's starting position. This means that you don't have to distinguish
9119 between click and drag, double, or triple events unless you want to.
9121 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9122 lines separating windows, and scroll bars with imaginary keys
9123 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9125 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9126 function will process a switch-frame event if the user switches frames
9127 before typing anything. If the user switches frames in the middle of a
9128 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9129 is nil, then the event will be put off until after the current key sequence.
9131 `read-key-sequence' checks `function-key-map' for function key
9132 sequences, where they wouldn't conflict with ordinary bindings. See
9133 `function-key-map' for more details.
9135 The optional fifth argument COMMAND-LOOP, if non-nil, means
9136 that this key sequence is being read by something that will
9137 read commands one after another. It should be nil if the caller
9138 will read just one key sequence. */)
9139 (prompt, continue_echo, dont_downcase_last, can_return_switch_frame,
9140 command_loop)
9141 Lisp_Object prompt, continue_echo, dont_downcase_last;
9142 Lisp_Object can_return_switch_frame, command_loop;
9144 Lisp_Object keybuf[30];
9145 register int i;
9146 struct gcpro gcpro1;
9147 int count = specpdl_ptr - specpdl;
9149 if (!NILP (prompt))
9150 CHECK_STRING (prompt);
9151 QUIT;
9153 specbind (Qinput_method_exit_on_first_char,
9154 (NILP (command_loop) ? Qt : Qnil));
9155 specbind (Qinput_method_use_echo_area,
9156 (NILP (command_loop) ? Qt : Qnil));
9158 bzero (keybuf, sizeof keybuf);
9159 GCPRO1 (keybuf[0]);
9160 gcpro1.nvars = (sizeof keybuf/sizeof (keybuf[0]));
9162 if (NILP (continue_echo))
9164 this_command_key_count = 0;
9165 this_single_command_key_start = 0;
9168 #ifdef HAVE_X_WINDOWS
9169 if (display_hourglass_p)
9170 cancel_hourglass ();
9171 #endif
9173 i = read_key_sequence (keybuf, (sizeof keybuf/sizeof (keybuf[0])),
9174 prompt, ! NILP (dont_downcase_last),
9175 ! NILP (can_return_switch_frame), 0);
9177 #if 0 /* The following is fine for code reading a key sequence and
9178 then proceeding with a lenghty computation, but it's not good
9179 for code reading keys in a loop, like an input method. */
9180 #ifdef HAVE_X_WINDOWS
9181 if (display_hourglass_p)
9182 start_hourglass ();
9183 #endif
9184 #endif
9186 if (i == -1)
9188 Vquit_flag = Qt;
9189 QUIT;
9191 UNGCPRO;
9192 return unbind_to (count, make_event_array (i, keybuf));
9195 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector,
9196 Sread_key_sequence_vector, 1, 5, 0,
9197 doc: /* Like `read-key-sequence' but always return a vector. */)
9198 (prompt, continue_echo, dont_downcase_last, can_return_switch_frame,
9199 command_loop)
9200 Lisp_Object prompt, continue_echo, dont_downcase_last;
9201 Lisp_Object can_return_switch_frame, command_loop;
9203 Lisp_Object keybuf[30];
9204 register int i;
9205 struct gcpro gcpro1;
9206 int count = specpdl_ptr - specpdl;
9208 if (!NILP (prompt))
9209 CHECK_STRING (prompt);
9210 QUIT;
9212 specbind (Qinput_method_exit_on_first_char,
9213 (NILP (command_loop) ? Qt : Qnil));
9214 specbind (Qinput_method_use_echo_area,
9215 (NILP (command_loop) ? Qt : Qnil));
9217 bzero (keybuf, sizeof keybuf);
9218 GCPRO1 (keybuf[0]);
9219 gcpro1.nvars = (sizeof keybuf/sizeof (keybuf[0]));
9221 if (NILP (continue_echo))
9223 this_command_key_count = 0;
9224 this_single_command_key_start = 0;
9227 #ifdef HAVE_X_WINDOWS
9228 if (display_hourglass_p)
9229 cancel_hourglass ();
9230 #endif
9232 i = read_key_sequence (keybuf, (sizeof keybuf/sizeof (keybuf[0])),
9233 prompt, ! NILP (dont_downcase_last),
9234 ! NILP (can_return_switch_frame), 0);
9236 #ifdef HAVE_X_WINDOWS
9237 if (display_hourglass_p)
9238 start_hourglass ();
9239 #endif
9241 if (i == -1)
9243 Vquit_flag = Qt;
9244 QUIT;
9246 UNGCPRO;
9247 return unbind_to (count, Fvector (i, keybuf));
9250 DEFUN ("command-execute", Fcommand_execute, Scommand_execute, 1, 4, 0,
9251 doc: /* Execute CMD as an editor command.
9252 CMD must be a symbol that satisfies the `commandp' predicate.
9253 Optional second arg RECORD-FLAG non-nil
9254 means unconditionally put this command in `command-history'.
9255 Otherwise, that is done only if an arg is read using the minibuffer.
9256 The argument KEYS specifies the value to use instead of (this-command-keys)
9257 when reading the arguments; if it is nil, (this-command-keys) is used.
9258 The argument SPECIAL, if non-nil, means that this command is executing
9259 a special event, so ignore the prefix argument and don't clear it. */)
9260 (cmd, record_flag, keys, special)
9261 Lisp_Object cmd, record_flag, keys, special;
9263 register Lisp_Object final;
9264 register Lisp_Object tem;
9265 Lisp_Object prefixarg;
9266 struct backtrace backtrace;
9267 extern int debug_on_next_call;
9269 debug_on_next_call = 0;
9271 if (NILP (special))
9273 prefixarg = current_kboard->Vprefix_arg;
9274 Vcurrent_prefix_arg = prefixarg;
9275 current_kboard->Vprefix_arg = Qnil;
9277 else
9278 prefixarg = Qnil;
9280 if (SYMBOLP (cmd))
9282 tem = Fget (cmd, Qdisabled);
9283 if (!NILP (tem) && !NILP (Vrun_hooks))
9285 tem = Fsymbol_value (Qdisabled_command_hook);
9286 if (!NILP (tem))
9287 return call1 (Vrun_hooks, Qdisabled_command_hook);
9291 while (1)
9293 final = Findirect_function (cmd);
9295 if (CONSP (final) && (tem = Fcar (final), EQ (tem, Qautoload)))
9297 struct gcpro gcpro1, gcpro2;
9299 GCPRO2 (cmd, prefixarg);
9300 do_autoload (final, cmd);
9301 UNGCPRO;
9303 else
9304 break;
9307 if (STRINGP (final) || VECTORP (final))
9309 /* If requested, place the macro in the command history. For
9310 other sorts of commands, call-interactively takes care of
9311 this. */
9312 if (!NILP (record_flag))
9314 Vcommand_history
9315 = Fcons (Fcons (Qexecute_kbd_macro,
9316 Fcons (final, Fcons (prefixarg, Qnil))),
9317 Vcommand_history);
9319 /* Don't keep command history around forever. */
9320 if (NUMBERP (Vhistory_length) && XINT (Vhistory_length) > 0)
9322 tem = Fnthcdr (Vhistory_length, Vcommand_history);
9323 if (CONSP (tem))
9324 XSETCDR (tem, Qnil);
9328 return Fexecute_kbd_macro (final, prefixarg);
9331 if (CONSP (final) || SUBRP (final) || COMPILEDP (final))
9333 backtrace.next = backtrace_list;
9334 backtrace_list = &backtrace;
9335 backtrace.function = &Qcall_interactively;
9336 backtrace.args = &cmd;
9337 backtrace.nargs = 1;
9338 backtrace.evalargs = 0;
9340 tem = Fcall_interactively (cmd, record_flag, keys);
9342 backtrace_list = backtrace.next;
9343 return tem;
9345 return Qnil;
9350 DEFUN ("execute-extended-command", Fexecute_extended_command, Sexecute_extended_command,
9351 1, 1, "P",
9352 doc: /* Read function name, then read its arguments and call it. */)
9353 (prefixarg)
9354 Lisp_Object prefixarg;
9356 Lisp_Object function;
9357 char buf[40];
9358 int saved_last_point_position;
9359 Lisp_Object saved_keys, saved_last_point_position_buffer;
9360 Lisp_Object bindings, value;
9361 struct gcpro gcpro1, gcpro2, gcpro3;
9363 saved_keys = Fvector (this_command_key_count,
9364 XVECTOR (this_command_keys)->contents);
9365 saved_last_point_position_buffer = last_point_position_buffer;
9366 saved_last_point_position = last_point_position;
9367 buf[0] = 0;
9368 GCPRO3 (saved_keys, prefixarg, saved_last_point_position_buffer);
9370 if (EQ (prefixarg, Qminus))
9371 strcpy (buf, "- ");
9372 else if (CONSP (prefixarg) && XINT (XCAR (prefixarg)) == 4)
9373 strcpy (buf, "C-u ");
9374 else if (CONSP (prefixarg) && INTEGERP (XCAR (prefixarg)))
9376 if (sizeof (int) == sizeof (EMACS_INT))
9377 sprintf (buf, "%d ", XINT (XCAR (prefixarg)));
9378 else if (sizeof (long) == sizeof (EMACS_INT))
9379 sprintf (buf, "%ld ", (long) XINT (XCAR (prefixarg)));
9380 else
9381 abort ();
9383 else if (INTEGERP (prefixarg))
9385 if (sizeof (int) == sizeof (EMACS_INT))
9386 sprintf (buf, "%d ", XINT (prefixarg));
9387 else if (sizeof (long) == sizeof (EMACS_INT))
9388 sprintf (buf, "%ld ", (long) XINT (prefixarg));
9389 else
9390 abort ();
9393 /* This isn't strictly correct if execute-extended-command
9394 is bound to anything else. Perhaps it should use
9395 this_command_keys? */
9396 strcat (buf, "M-x ");
9398 /* Prompt with buf, and then read a string, completing from and
9399 restricting to the set of all defined commands. Don't provide
9400 any initial input. Save the command read on the extended-command
9401 history list. */
9402 function = Fcompleting_read (build_string (buf),
9403 Vobarray, Qcommandp,
9404 Qt, Qnil, Qextended_command_history, Qnil,
9405 Qnil);
9407 if (STRINGP (function) && XSTRING (function)->size == 0)
9408 error ("No command name given");
9410 /* Set this_command_keys to the concatenation of saved_keys and
9411 function, followed by a RET. */
9413 struct Lisp_String *str;
9414 Lisp_Object *keys;
9415 int i;
9417 this_command_key_count = 0;
9418 this_single_command_key_start = 0;
9420 keys = XVECTOR (saved_keys)->contents;
9421 for (i = 0; i < XVECTOR (saved_keys)->size; i++)
9422 add_command_key (keys[i]);
9424 str = XSTRING (function);
9425 for (i = 0; i < str->size; i++)
9426 add_command_key (Faref (function, make_number (i)));
9428 add_command_key (make_number ('\015'));
9431 last_point_position = saved_last_point_position;
9432 last_point_position_buffer = saved_last_point_position_buffer;
9434 UNGCPRO;
9436 function = Fintern (function, Qnil);
9437 current_kboard->Vprefix_arg = prefixarg;
9438 Vthis_command = function;
9439 real_this_command = function;
9441 /* If enabled, show which key runs this command. */
9442 if (!NILP (Vsuggest_key_bindings)
9443 && NILP (Vexecuting_macro)
9444 && SYMBOLP (function))
9445 bindings = Fwhere_is_internal (function, Voverriding_local_map,
9446 Qt, Qnil, Qnil);
9447 else
9448 bindings = Qnil;
9450 value = Qnil;
9451 GCPRO2 (bindings, value);
9452 value = Fcommand_execute (function, Qt, Qnil, Qnil);
9454 /* If the command has a key binding, print it now. */
9455 if (!NILP (bindings)
9456 && ! (VECTORP (bindings) && EQ (Faref (bindings, make_number (0)),
9457 Qmouse_movement)))
9459 /* But first wait, and skip the message if there is input. */
9460 int delay_time;
9461 if (!NILP (echo_area_buffer[0]))
9462 /* This command displayed something in the echo area;
9463 so wait a few seconds, then display our suggestion message. */
9464 delay_time = (NUMBERP (Vsuggest_key_bindings)
9465 ? XINT (Vsuggest_key_bindings) : 2);
9466 else
9467 /* This command left the echo area empty,
9468 so display our message immediately. */
9469 delay_time = 0;
9471 if (!NILP (Fsit_for (make_number (delay_time), Qnil, Qnil))
9472 && ! CONSP (Vunread_command_events))
9474 Lisp_Object binding;
9475 char *newmessage;
9476 int message_p = push_message ();
9477 int count = BINDING_STACK_SIZE ();
9479 record_unwind_protect (push_message_unwind, Qnil);
9480 binding = Fkey_description (bindings);
9482 newmessage
9483 = (char *) alloca (XSTRING (SYMBOL_NAME (function))->size
9484 + STRING_BYTES (XSTRING (binding))
9485 + 100);
9486 sprintf (newmessage, "You can run the command `%s' with %s",
9487 XSTRING (SYMBOL_NAME (function))->data,
9488 XSTRING (binding)->data);
9489 message2_nolog (newmessage,
9490 strlen (newmessage),
9491 STRING_MULTIBYTE (binding));
9492 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings)
9493 ? Vsuggest_key_bindings : make_number (2)),
9494 Qnil, Qnil))
9495 && message_p)
9496 restore_message ();
9498 unbind_to (count, Qnil);
9502 RETURN_UNGCPRO (value);
9506 /* Return nonzero if input events are pending. */
9509 detect_input_pending ()
9511 if (!input_pending)
9512 get_input_pending (&input_pending, 0);
9514 return input_pending;
9517 /* Return nonzero if input events are pending, and run any pending timers. */
9520 detect_input_pending_run_timers (do_display)
9521 int do_display;
9523 int old_timers_run = timers_run;
9525 if (!input_pending)
9526 get_input_pending (&input_pending, 1);
9528 if (old_timers_run != timers_run && do_display)
9530 redisplay_preserve_echo_area (8);
9531 /* The following fixes a bug when using lazy-lock with
9532 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9533 from an idle timer function. The symptom of the bug is that
9534 the cursor sometimes doesn't become visible until the next X
9535 event is processed. --gerd. */
9536 if (rif)
9537 rif->flush_display (NULL);
9540 return input_pending;
9543 /* This is called in some cases before a possible quit.
9544 It cases the next call to detect_input_pending to recompute input_pending.
9545 So calling this function unnecessarily can't do any harm. */
9547 void
9548 clear_input_pending ()
9550 input_pending = 0;
9553 /* Return nonzero if there are pending requeued events.
9554 This isn't used yet. The hope is to make wait_reading_process_input
9555 call it, and return if it runs Lisp code that unreads something.
9556 The problem is, kbd_buffer_get_event needs to be fixed to know what
9557 to do in that case. It isn't trivial. */
9560 requeued_events_pending_p ()
9562 return (!NILP (Vunread_command_events) || unread_command_char != -1);
9566 DEFUN ("input-pending-p", Finput_pending_p, Sinput_pending_p, 0, 0, 0,
9567 doc: /* Return t if command input is currently available with no wait.
9568 Actually, the value is nil only if we can be sure that no input is available;
9569 if there is a doubt, the value is t. */)
9572 if (!NILP (Vunread_command_events) || unread_command_char != -1)
9573 return (Qt);
9575 get_input_pending (&input_pending, 1);
9576 return input_pending > 0 ? Qt : Qnil;
9579 DEFUN ("recent-keys", Frecent_keys, Srecent_keys, 0, 0, 0,
9580 doc: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9583 Lisp_Object *keys = XVECTOR (recent_keys)->contents;
9584 Lisp_Object val;
9586 if (total_keys < NUM_RECENT_KEYS)
9587 return Fvector (total_keys, keys);
9588 else
9590 val = Fvector (NUM_RECENT_KEYS, keys);
9591 bcopy (keys + recent_keys_index,
9592 XVECTOR (val)->contents,
9593 (NUM_RECENT_KEYS - recent_keys_index) * sizeof (Lisp_Object));
9594 bcopy (keys,
9595 XVECTOR (val)->contents + NUM_RECENT_KEYS - recent_keys_index,
9596 recent_keys_index * sizeof (Lisp_Object));
9597 return val;
9601 DEFUN ("this-command-keys", Fthis_command_keys, Sthis_command_keys, 0, 0, 0,
9602 doc: /* Return the key sequence that invoked this command.
9603 However, if the command has called `read-key-sequence', it returns
9604 the last key sequence that has been read.
9605 The value is a string or a vector. */)
9608 return make_event_array (this_command_key_count,
9609 XVECTOR (this_command_keys)->contents);
9612 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector, Sthis_command_keys_vector, 0, 0, 0,
9613 doc: /* Return the key sequence that invoked this command, as a vector.
9614 However, if the command has called `read-key-sequence', it returns
9615 the last key sequence that has been read. */)
9618 return Fvector (this_command_key_count,
9619 XVECTOR (this_command_keys)->contents);
9622 DEFUN ("this-single-command-keys", Fthis_single_command_keys,
9623 Sthis_single_command_keys, 0, 0, 0,
9624 doc: /* Return the key sequence that invoked this command.
9625 More generally, it returns the last key sequence read, either by
9626 the command loop or by `read-key-sequence'.
9627 Unlike `this-command-keys', this function's value
9628 does not include prefix arguments.
9629 The value is always a vector. */)
9632 return Fvector (this_command_key_count
9633 - this_single_command_key_start,
9634 (XVECTOR (this_command_keys)->contents
9635 + this_single_command_key_start));
9638 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys,
9639 Sthis_single_command_raw_keys, 0, 0, 0,
9640 doc: /* Return the raw events that were read for this command.
9641 More generally, it returns the last key sequence read, either by
9642 the command loop or by `read-key-sequence'.
9643 Unlike `this-single-command-keys', this function's value
9644 shows the events before all translations (except for input methods).
9645 The value is always a vector. */)
9648 return Fvector (raw_keybuf_count,
9649 (XVECTOR (raw_keybuf)->contents));
9652 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths,
9653 Sreset_this_command_lengths, 0, 0, 0,
9654 doc: /* Used for complicated reasons in `universal-argument-other-key'.
9656 `universal-argument-other-key' rereads the event just typed.
9657 It then gets translated through `function-key-map'.
9658 The translated event gets included in the echo area and in
9659 the value of `this-command-keys' in addition to the raw original event.
9660 That is not right.
9662 Calling this function directs the translated event to replace
9663 the original event, so that only one version of the event actually
9664 appears in the echo area and in the value of `this-command-keys'. */)
9667 before_command_restore_flag = 1;
9668 before_command_key_count_1 = before_command_key_count;
9669 before_command_echo_length_1 = before_command_echo_length;
9670 return Qnil;
9673 DEFUN ("clear-this-command-keys", Fclear_this_command_keys,
9674 Sclear_this_command_keys, 0, 0, 0,
9675 doc: /* Clear out the vector that `this-command-keys' returns.
9676 Also clear the record of the last 100 events. */)
9679 int i;
9681 this_command_key_count = 0;
9683 for (i = 0; i < XVECTOR (recent_keys)->size; ++i)
9684 XVECTOR (recent_keys)->contents[i] = Qnil;
9685 total_keys = 0;
9686 recent_keys_index = 0;
9687 return Qnil;
9690 DEFUN ("recursion-depth", Frecursion_depth, Srecursion_depth, 0, 0, 0,
9691 doc: /* Return the current depth in recursive edits. */)
9694 Lisp_Object temp;
9695 XSETFASTINT (temp, command_loop_level + minibuf_level);
9696 return temp;
9699 DEFUN ("open-dribble-file", Fopen_dribble_file, Sopen_dribble_file, 1, 1,
9700 "FOpen dribble file: ",
9701 doc: /* Start writing all keyboard characters to a dribble file called FILE.
9702 If FILE is nil, close any open dribble file. */)
9703 (file)
9704 Lisp_Object file;
9706 if (dribble)
9708 fclose (dribble);
9709 dribble = 0;
9711 if (!NILP (file))
9713 file = Fexpand_file_name (file, Qnil);
9714 dribble = fopen (XSTRING (file)->data, "w");
9715 if (dribble == 0)
9716 report_file_error ("Opening dribble", Fcons (file, Qnil));
9718 return Qnil;
9721 DEFUN ("discard-input", Fdiscard_input, Sdiscard_input, 0, 0, 0,
9722 doc: /* Discard the contents of the terminal input buffer.
9723 Also cancel any kbd macro being defined. */)
9726 current_kboard->defining_kbd_macro = Qnil;
9727 update_mode_lines++;
9729 Vunread_command_events = Qnil;
9730 unread_command_char = -1;
9732 discard_tty_input ();
9734 kbd_fetch_ptr = kbd_store_ptr;
9735 Ffillarray (kbd_buffer_gcpro, Qnil);
9736 input_pending = 0;
9738 return Qnil;
9741 DEFUN ("suspend-emacs", Fsuspend_emacs, Ssuspend_emacs, 0, 1, "",
9742 doc: /* Stop Emacs and return to superior process. You can resume later.
9743 If `cannot-suspend' is non-nil, or if the system doesn't support job
9744 control, run a subshell instead.
9746 If optional arg STUFFSTRING is non-nil, its characters are stuffed
9747 to be read as terminal input by Emacs's parent, after suspension.
9749 Before suspending, run the normal hook `suspend-hook'.
9750 After resumption run the normal hook `suspend-resume-hook'.
9752 Some operating systems cannot stop the Emacs process and resume it later.
9753 On such systems, Emacs starts a subshell instead of suspending. */)
9754 (stuffstring)
9755 Lisp_Object stuffstring;
9757 int count = specpdl_ptr - specpdl;
9758 int old_height, old_width;
9759 int width, height;
9760 struct gcpro gcpro1;
9762 if (!NILP (stuffstring))
9763 CHECK_STRING (stuffstring);
9765 /* Run the functions in suspend-hook. */
9766 if (!NILP (Vrun_hooks))
9767 call1 (Vrun_hooks, intern ("suspend-hook"));
9769 GCPRO1 (stuffstring);
9770 get_frame_size (&old_width, &old_height);
9771 reset_sys_modes ();
9772 /* sys_suspend can get an error if it tries to fork a subshell
9773 and the system resources aren't available for that. */
9774 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object))) init_sys_modes,
9775 Qnil);
9776 stuff_buffered_input (stuffstring);
9777 if (cannot_suspend)
9778 sys_subshell ();
9779 else
9780 sys_suspend ();
9781 unbind_to (count, Qnil);
9783 /* Check if terminal/window size has changed.
9784 Note that this is not useful when we are running directly
9785 with a window system; but suspend should be disabled in that case. */
9786 get_frame_size (&width, &height);
9787 if (width != old_width || height != old_height)
9788 change_frame_size (SELECTED_FRAME (), height, width, 0, 0, 0);
9790 /* Run suspend-resume-hook. */
9791 if (!NILP (Vrun_hooks))
9792 call1 (Vrun_hooks, intern ("suspend-resume-hook"));
9794 UNGCPRO;
9795 return Qnil;
9798 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
9799 Then in any case stuff anything Emacs has read ahead and not used. */
9801 void
9802 stuff_buffered_input (stuffstring)
9803 Lisp_Object stuffstring;
9805 /* stuff_char works only in BSD, versions 4.2 and up. */
9806 #ifdef BSD_SYSTEM
9807 #ifndef BSD4_1
9808 register unsigned char *p;
9810 if (STRINGP (stuffstring))
9812 register int count;
9814 p = XSTRING (stuffstring)->data;
9815 count = STRING_BYTES (XSTRING (stuffstring));
9816 while (count-- > 0)
9817 stuff_char (*p++);
9818 stuff_char ('\n');
9821 /* Anything we have read ahead, put back for the shell to read. */
9822 /* ?? What should this do when we have multiple keyboards??
9823 Should we ignore anything that was typed in at the "wrong" kboard? */
9824 for (; kbd_fetch_ptr != kbd_store_ptr; kbd_fetch_ptr++)
9826 int idx;
9828 if (kbd_fetch_ptr == kbd_buffer + KBD_BUFFER_SIZE)
9829 kbd_fetch_ptr = kbd_buffer;
9830 if (kbd_fetch_ptr->kind == ascii_keystroke)
9831 stuff_char (kbd_fetch_ptr->code);
9833 kbd_fetch_ptr->kind = no_event;
9834 idx = 2 * (kbd_fetch_ptr - kbd_buffer);
9835 ASET (kbd_buffer_gcpro, idx, Qnil);
9836 ASET (kbd_buffer_gcpro, idx + 1, Qnil);
9839 input_pending = 0;
9840 #endif
9841 #endif /* BSD_SYSTEM and not BSD4_1 */
9844 void
9845 set_waiting_for_input (time_to_clear)
9846 EMACS_TIME *time_to_clear;
9848 input_available_clear_time = time_to_clear;
9850 /* Tell interrupt_signal to throw back to read_char, */
9851 waiting_for_input = 1;
9853 /* If interrupt_signal was called before and buffered a C-g,
9854 make it run again now, to avoid timing error. */
9855 if (!NILP (Vquit_flag))
9856 quit_throw_to_read_char ();
9859 void
9860 clear_waiting_for_input ()
9862 /* Tell interrupt_signal not to throw back to read_char, */
9863 waiting_for_input = 0;
9864 input_available_clear_time = 0;
9867 /* This routine is called at interrupt level in response to C-g.
9869 If interrupt_input, this is the handler for SIGINT. Otherwise, it
9870 is called from kbd_buffer_store_event, in handling SIGIO or
9871 SIGTINT.
9873 If `waiting_for_input' is non zero, then unless `echoing' is
9874 nonzero, immediately throw back to read_char.
9876 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
9877 eval to throw, when it gets a chance. If quit-flag is already
9878 non-nil, it stops the job right away. */
9880 SIGTYPE
9881 interrupt_signal (signalnum) /* If we don't have an argument, */
9882 int signalnum; /* some compilers complain in signal calls. */
9884 char c;
9885 /* Must preserve main program's value of errno. */
9886 int old_errno = errno;
9887 struct frame *sf = SELECTED_FRAME ();
9889 #if defined (USG) && !defined (POSIX_SIGNALS)
9890 if (!read_socket_hook && NILP (Vwindow_system))
9892 /* USG systems forget handlers when they are used;
9893 must reestablish each time */
9894 signal (SIGINT, interrupt_signal);
9895 signal (SIGQUIT, interrupt_signal);
9897 #endif /* USG */
9899 cancel_echoing ();
9901 if (!NILP (Vquit_flag)
9902 && (FRAME_TERMCAP_P (sf) || FRAME_MSDOS_P (sf)))
9904 /* If SIGINT isn't blocked, don't let us be interrupted by
9905 another SIGINT, it might be harmful due to non-reentrancy
9906 in I/O functions. */
9907 sigblock (sigmask (SIGINT));
9909 fflush (stdout);
9910 reset_sys_modes ();
9912 #ifdef SIGTSTP /* Support possible in later USG versions */
9914 * On systems which can suspend the current process and return to the original
9915 * shell, this command causes the user to end up back at the shell.
9916 * The "Auto-save" and "Abort" questions are not asked until
9917 * the user elects to return to emacs, at which point he can save the current
9918 * job and either dump core or continue.
9920 sys_suspend ();
9921 #else
9922 #ifdef VMS
9923 if (sys_suspend () == -1)
9925 printf ("Not running as a subprocess;\n");
9926 printf ("you can continue or abort.\n");
9928 #else /* not VMS */
9929 /* Perhaps should really fork an inferior shell?
9930 But that would not provide any way to get back
9931 to the original shell, ever. */
9932 printf ("No support for stopping a process on this operating system;\n");
9933 printf ("you can continue or abort.\n");
9934 #endif /* not VMS */
9935 #endif /* not SIGTSTP */
9936 #ifdef MSDOS
9937 /* We must remain inside the screen area when the internal terminal
9938 is used. Note that [Enter] is not echoed by dos. */
9939 cursor_to (0, 0);
9940 #endif
9941 /* It doesn't work to autosave while GC is in progress;
9942 the code used for auto-saving doesn't cope with the mark bit. */
9943 if (!gc_in_progress)
9945 printf ("Auto-save? (y or n) ");
9946 fflush (stdout);
9947 if (((c = getchar ()) & ~040) == 'Y')
9949 Fdo_auto_save (Qt, Qnil);
9950 #ifdef MSDOS
9951 printf ("\r\nAuto-save done");
9952 #else /* not MSDOS */
9953 printf ("Auto-save done\n");
9954 #endif /* not MSDOS */
9956 while (c != '\n') c = getchar ();
9958 else
9960 /* During GC, it must be safe to reenable quitting again. */
9961 Vinhibit_quit = Qnil;
9962 #ifdef MSDOS
9963 printf ("\r\n");
9964 #endif /* not MSDOS */
9965 printf ("Garbage collection in progress; cannot auto-save now\r\n");
9966 printf ("but will instead do a real quit after garbage collection ends\r\n");
9967 fflush (stdout);
9970 #ifdef MSDOS
9971 printf ("\r\nAbort? (y or n) ");
9972 #else /* not MSDOS */
9973 #ifdef VMS
9974 printf ("Abort (and enter debugger)? (y or n) ");
9975 #else /* not VMS */
9976 printf ("Abort (and dump core)? (y or n) ");
9977 #endif /* not VMS */
9978 #endif /* not MSDOS */
9979 fflush (stdout);
9980 if (((c = getchar ()) & ~040) == 'Y')
9981 abort ();
9982 while (c != '\n') c = getchar ();
9983 #ifdef MSDOS
9984 printf ("\r\nContinuing...\r\n");
9985 #else /* not MSDOS */
9986 printf ("Continuing...\n");
9987 #endif /* not MSDOS */
9988 fflush (stdout);
9989 init_sys_modes ();
9990 sigfree ();
9992 else
9994 /* If executing a function that wants to be interrupted out of
9995 and the user has not deferred quitting by binding `inhibit-quit'
9996 then quit right away. */
9997 if (immediate_quit && NILP (Vinhibit_quit))
9999 struct gl_state_s saved;
10000 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
10002 immediate_quit = 0;
10003 sigfree ();
10004 saved = gl_state;
10005 GCPRO4 (saved.object, saved.global_code,
10006 saved.current_syntax_table, saved.old_prop);
10007 Fsignal (Qquit, Qnil);
10008 gl_state = saved;
10009 UNGCPRO;
10011 else
10012 /* Else request quit when it's safe */
10013 Vquit_flag = Qt;
10016 if (waiting_for_input && !echoing)
10017 quit_throw_to_read_char ();
10019 errno = old_errno;
10022 /* Handle a C-g by making read_char return C-g. */
10024 void
10025 quit_throw_to_read_char ()
10027 sigfree ();
10028 /* Prevent another signal from doing this before we finish. */
10029 clear_waiting_for_input ();
10030 input_pending = 0;
10032 Vunread_command_events = Qnil;
10033 unread_command_char = -1;
10035 #if 0 /* Currently, sit_for is called from read_char without turning
10036 off polling. And that can call set_waiting_for_input.
10037 It seems to be harmless. */
10038 #ifdef POLL_FOR_INPUT
10039 /* May be > 1 if in recursive minibuffer. */
10040 if (poll_suppress_count == 0)
10041 abort ();
10042 #endif
10043 #endif
10044 if (FRAMEP (internal_last_event_frame)
10045 && !EQ (internal_last_event_frame, selected_frame))
10046 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame),
10047 0, 0);
10049 _longjmp (getcjmp, 1);
10052 DEFUN ("set-input-mode", Fset_input_mode, Sset_input_mode, 3, 4, 0,
10053 doc: /* Set mode of reading keyboard input.
10054 First arg INTERRUPT non-nil means use input interrupts;
10055 nil means use CBREAK mode.
10056 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10057 (no effect except in CBREAK mode).
10058 Third arg META t means accept 8-bit input (for a Meta key).
10059 META nil means ignore the top bit, on the assumption it is parity.
10060 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10061 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10062 See also `current-input-mode'. */)
10063 (interrupt, flow, meta, quit)
10064 Lisp_Object interrupt, flow, meta, quit;
10066 if (!NILP (quit)
10067 && (!INTEGERP (quit) || XINT (quit) < 0 || XINT (quit) > 0400))
10068 error ("set-input-mode: QUIT must be an ASCII character");
10070 #ifdef POLL_FOR_INPUT
10071 stop_polling ();
10072 #endif
10074 #ifndef DOS_NT
10075 /* this causes startup screen to be restored and messes with the mouse */
10076 reset_sys_modes ();
10077 #endif
10079 #ifdef SIGIO
10080 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10081 if (read_socket_hook)
10083 /* When using X, don't give the user a real choice,
10084 because we haven't implemented the mechanisms to support it. */
10085 #ifdef NO_SOCK_SIGIO
10086 interrupt_input = 0;
10087 #else /* not NO_SOCK_SIGIO */
10088 interrupt_input = 1;
10089 #endif /* NO_SOCK_SIGIO */
10091 else
10092 interrupt_input = !NILP (interrupt);
10093 #else /* not SIGIO */
10094 interrupt_input = 0;
10095 #endif /* not SIGIO */
10097 /* Our VMS input only works by interrupts, as of now. */
10098 #ifdef VMS
10099 interrupt_input = 1;
10100 #endif
10102 flow_control = !NILP (flow);
10103 if (NILP (meta))
10104 meta_key = 0;
10105 else if (EQ (meta, Qt))
10106 meta_key = 1;
10107 else
10108 meta_key = 2;
10109 if (!NILP (quit))
10110 /* Don't let this value be out of range. */
10111 quit_char = XINT (quit) & (meta_key ? 0377 : 0177);
10113 #ifndef DOS_NT
10114 init_sys_modes ();
10115 #endif
10117 #ifdef POLL_FOR_INPUT
10118 poll_suppress_count = 1;
10119 start_polling ();
10120 #endif
10121 return Qnil;
10124 DEFUN ("current-input-mode", Fcurrent_input_mode, Scurrent_input_mode, 0, 0, 0,
10125 doc: /* Return information about the way Emacs currently reads keyboard input.
10126 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10127 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10128 nil, Emacs is using CBREAK mode.
10129 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10130 terminal; this does not apply if Emacs uses interrupt-driven input.
10131 META is t if accepting 8-bit input with 8th bit as Meta flag.
10132 META nil means ignoring the top bit, on the assumption it is parity.
10133 META is neither t nor nil if accepting 8-bit input and using
10134 all 8 bits as the character code.
10135 QUIT is the character Emacs currently uses to quit.
10136 The elements of this list correspond to the arguments of
10137 `set-input-mode'. */)
10140 Lisp_Object val[4];
10142 val[0] = interrupt_input ? Qt : Qnil;
10143 val[1] = flow_control ? Qt : Qnil;
10144 val[2] = meta_key == 2 ? make_number (0) : meta_key == 1 ? Qt : Qnil;
10145 XSETFASTINT (val[3], quit_char);
10147 return Flist (sizeof (val) / sizeof (val[0]), val);
10152 * Set up a new kboard object with reasonable initial values.
10154 void
10155 init_kboard (kb)
10156 KBOARD *kb;
10158 kb->Voverriding_terminal_local_map = Qnil;
10159 kb->Vlast_command = Qnil;
10160 kb->Vreal_last_command = Qnil;
10161 kb->Vprefix_arg = Qnil;
10162 kb->Vlast_prefix_arg = Qnil;
10163 kb->kbd_queue = Qnil;
10164 kb->kbd_queue_has_data = 0;
10165 kb->immediate_echo = 0;
10166 kb->echo_string = Qnil;
10167 kb->echo_after_prompt = -1;
10168 kb->kbd_macro_buffer = 0;
10169 kb->kbd_macro_bufsize = 0;
10170 kb->defining_kbd_macro = Qnil;
10171 kb->Vlast_kbd_macro = Qnil;
10172 kb->reference_count = 0;
10173 kb->Vsystem_key_alist = Qnil;
10174 kb->system_key_syms = Qnil;
10175 kb->Vdefault_minibuffer_frame = Qnil;
10179 * Destroy the contents of a kboard object, but not the object itself.
10180 * We use this just before deleting it, or if we're going to initialize
10181 * it a second time.
10183 static void
10184 wipe_kboard (kb)
10185 KBOARD *kb;
10187 if (kb->kbd_macro_buffer)
10188 xfree (kb->kbd_macro_buffer);
10191 #ifdef MULTI_KBOARD
10193 /* Free KB and memory referenced from it. */
10195 void
10196 delete_kboard (kb)
10197 KBOARD *kb;
10199 KBOARD **kbp;
10201 for (kbp = &all_kboards; *kbp != kb; kbp = &(*kbp)->next_kboard)
10202 if (*kbp == NULL)
10203 abort ();
10204 *kbp = kb->next_kboard;
10206 /* Prevent a dangling reference to KB. */
10207 if (kb == current_kboard
10208 && FRAMEP (selected_frame)
10209 && FRAME_LIVE_P (XFRAME (selected_frame)))
10211 current_kboard = XFRAME (selected_frame)->kboard;
10212 if (current_kboard == kb)
10213 abort ();
10216 wipe_kboard (kb);
10217 xfree (kb);
10220 #endif /* MULTI_KBOARD */
10222 void
10223 init_keyboard ()
10225 /* This is correct before outermost invocation of the editor loop */
10226 command_loop_level = -1;
10227 immediate_quit = 0;
10228 quit_char = Ctl ('g');
10229 Vunread_command_events = Qnil;
10230 unread_command_char = -1;
10231 EMACS_SET_SECS_USECS (timer_idleness_start_time, -1, -1);
10232 total_keys = 0;
10233 recent_keys_index = 0;
10234 kbd_fetch_ptr = kbd_buffer;
10235 kbd_store_ptr = kbd_buffer;
10236 kbd_buffer_gcpro = Fmake_vector (make_number (2 * KBD_BUFFER_SIZE), Qnil);
10237 #ifdef HAVE_MOUSE
10238 do_mouse_tracking = Qnil;
10239 #endif
10240 input_pending = 0;
10242 /* This means that command_loop_1 won't try to select anything the first
10243 time through. */
10244 internal_last_event_frame = Qnil;
10245 Vlast_event_frame = internal_last_event_frame;
10247 #ifdef MULTI_KBOARD
10248 current_kboard = initial_kboard;
10249 #endif
10250 wipe_kboard (current_kboard);
10251 init_kboard (current_kboard);
10253 if (!noninteractive && !read_socket_hook && NILP (Vwindow_system))
10255 signal (SIGINT, interrupt_signal);
10256 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10257 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10258 SIGQUIT and we can't tell which one it will give us. */
10259 signal (SIGQUIT, interrupt_signal);
10260 #endif /* HAVE_TERMIO */
10262 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10263 #ifdef SIGIO
10264 if (!noninteractive)
10265 signal (SIGIO, input_available_signal);
10266 #endif /* SIGIO */
10268 /* Use interrupt input by default, if it works and noninterrupt input
10269 has deficiencies. */
10271 #ifdef INTERRUPT_INPUT
10272 interrupt_input = 1;
10273 #else
10274 interrupt_input = 0;
10275 #endif
10277 /* Our VMS input only works by interrupts, as of now. */
10278 #ifdef VMS
10279 interrupt_input = 1;
10280 #endif
10282 sigfree ();
10283 dribble = 0;
10285 if (keyboard_init_hook)
10286 (*keyboard_init_hook) ();
10288 #ifdef POLL_FOR_INPUT
10289 poll_suppress_count = 1;
10290 start_polling ();
10291 #endif
10294 /* This type's only use is in syms_of_keyboard, to initialize the
10295 event header symbols and put properties on them. */
10296 struct event_head {
10297 Lisp_Object *var;
10298 char *name;
10299 Lisp_Object *kind;
10302 struct event_head head_table[] = {
10303 {&Qmouse_movement, "mouse-movement", &Qmouse_movement},
10304 {&Qscroll_bar_movement, "scroll-bar-movement", &Qmouse_movement},
10305 {&Qswitch_frame, "switch-frame", &Qswitch_frame},
10306 {&Qdelete_frame, "delete-frame", &Qdelete_frame},
10307 {&Qiconify_frame, "iconify-frame", &Qiconify_frame},
10308 {&Qmake_frame_visible, "make-frame-visible", &Qmake_frame_visible},
10309 {&Qselect_window, "select-window", &Qselect_window}
10312 void
10313 syms_of_keyboard ()
10315 Vpre_help_message = Qnil;
10316 staticpro (&Vpre_help_message);
10318 Vlispy_mouse_stem = build_string ("mouse");
10319 staticpro (&Vlispy_mouse_stem);
10321 /* Tool-bars. */
10322 QCimage = intern (":image");
10323 staticpro (&QCimage);
10325 staticpro (&Qhelp_echo);
10326 Qhelp_echo = intern ("help-echo");
10328 staticpro (&item_properties);
10329 item_properties = Qnil;
10331 staticpro (&tool_bar_item_properties);
10332 tool_bar_item_properties = Qnil;
10333 staticpro (&tool_bar_items_vector);
10334 tool_bar_items_vector = Qnil;
10336 staticpro (&real_this_command);
10337 real_this_command = Qnil;
10339 Qtimer_event_handler = intern ("timer-event-handler");
10340 staticpro (&Qtimer_event_handler);
10342 Qdisabled_command_hook = intern ("disabled-command-hook");
10343 staticpro (&Qdisabled_command_hook);
10345 Qself_insert_command = intern ("self-insert-command");
10346 staticpro (&Qself_insert_command);
10348 Qforward_char = intern ("forward-char");
10349 staticpro (&Qforward_char);
10351 Qbackward_char = intern ("backward-char");
10352 staticpro (&Qbackward_char);
10354 Qdisabled = intern ("disabled");
10355 staticpro (&Qdisabled);
10357 Qundefined = intern ("undefined");
10358 staticpro (&Qundefined);
10360 Qpre_command_hook = intern ("pre-command-hook");
10361 staticpro (&Qpre_command_hook);
10363 Qpost_command_hook = intern ("post-command-hook");
10364 staticpro (&Qpost_command_hook);
10366 Qpost_command_idle_hook = intern ("post-command-idle-hook");
10367 staticpro (&Qpost_command_idle_hook);
10369 Qdeferred_action_function = intern ("deferred-action-function");
10370 staticpro (&Qdeferred_action_function);
10372 Qcommand_hook_internal = intern ("command-hook-internal");
10373 staticpro (&Qcommand_hook_internal);
10375 Qfunction_key = intern ("function-key");
10376 staticpro (&Qfunction_key);
10377 Qmouse_click = intern ("mouse-click");
10378 staticpro (&Qmouse_click);
10379 #ifdef WINDOWSNT
10380 Qmouse_wheel = intern ("mouse-wheel");
10381 staticpro (&Qmouse_wheel);
10382 Qlanguage_change = intern ("language-change");
10383 staticpro (&Qlanguage_change);
10384 #endif
10385 Qdrag_n_drop = intern ("drag-n-drop");
10386 staticpro (&Qdrag_n_drop);
10388 Qsave_session = intern ("save-session");
10389 staticpro(&Qsave_session);
10391 Qusr1_signal = intern ("usr1-signal");
10392 staticpro (&Qusr1_signal);
10393 Qusr2_signal = intern ("usr2-signal");
10394 staticpro (&Qusr2_signal);
10396 Qmenu_enable = intern ("menu-enable");
10397 staticpro (&Qmenu_enable);
10398 Qmenu_alias = intern ("menu-alias");
10399 staticpro (&Qmenu_alias);
10400 QCenable = intern (":enable");
10401 staticpro (&QCenable);
10402 QCvisible = intern (":visible");
10403 staticpro (&QCvisible);
10404 QChelp = intern (":help");
10405 staticpro (&QChelp);
10406 QCfilter = intern (":filter");
10407 staticpro (&QCfilter);
10408 QCbutton = intern (":button");
10409 staticpro (&QCbutton);
10410 QCkeys = intern (":keys");
10411 staticpro (&QCkeys);
10412 QCkey_sequence = intern (":key-sequence");
10413 staticpro (&QCkey_sequence);
10414 QCtoggle = intern (":toggle");
10415 staticpro (&QCtoggle);
10416 QCradio = intern (":radio");
10417 staticpro (&QCradio);
10419 Qmode_line = intern ("mode-line");
10420 staticpro (&Qmode_line);
10421 Qvertical_line = intern ("vertical-line");
10422 staticpro (&Qvertical_line);
10423 Qvertical_scroll_bar = intern ("vertical-scroll-bar");
10424 staticpro (&Qvertical_scroll_bar);
10425 Qmenu_bar = intern ("menu-bar");
10426 staticpro (&Qmenu_bar);
10428 Qabove_handle = intern ("above-handle");
10429 staticpro (&Qabove_handle);
10430 Qhandle = intern ("handle");
10431 staticpro (&Qhandle);
10432 Qbelow_handle = intern ("below-handle");
10433 staticpro (&Qbelow_handle);
10434 Qup = intern ("up");
10435 staticpro (&Qup);
10436 Qdown = intern ("down");
10437 staticpro (&Qdown);
10438 Qtop = intern ("top");
10439 staticpro (&Qtop);
10440 Qbottom = intern ("bottom");
10441 staticpro (&Qbottom);
10442 Qend_scroll = intern ("end-scroll");
10443 staticpro (&Qend_scroll);
10444 Qratio = intern ("ratio");
10445 staticpro (&Qratio);
10447 Qevent_kind = intern ("event-kind");
10448 staticpro (&Qevent_kind);
10449 Qevent_symbol_elements = intern ("event-symbol-elements");
10450 staticpro (&Qevent_symbol_elements);
10451 Qevent_symbol_element_mask = intern ("event-symbol-element-mask");
10452 staticpro (&Qevent_symbol_element_mask);
10453 Qmodifier_cache = intern ("modifier-cache");
10454 staticpro (&Qmodifier_cache);
10456 Qrecompute_lucid_menubar = intern ("recompute-lucid-menubar");
10457 staticpro (&Qrecompute_lucid_menubar);
10458 Qactivate_menubar_hook = intern ("activate-menubar-hook");
10459 staticpro (&Qactivate_menubar_hook);
10461 Qpolling_period = intern ("polling-period");
10462 staticpro (&Qpolling_period);
10464 Qinput_method_function = intern ("input-method-function");
10465 staticpro (&Qinput_method_function);
10467 Qinput_method_exit_on_first_char = intern ("input-method-exit-on-first-char");
10468 staticpro (&Qinput_method_exit_on_first_char);
10469 Qinput_method_use_echo_area = intern ("input-method-use-echo-area");
10470 staticpro (&Qinput_method_use_echo_area);
10472 Fset (Qinput_method_exit_on_first_char, Qnil);
10473 Fset (Qinput_method_use_echo_area, Qnil);
10475 last_point_position_buffer = Qnil;
10478 struct event_head *p;
10480 for (p = head_table;
10481 p < head_table + (sizeof (head_table) / sizeof (head_table[0]));
10482 p++)
10484 *p->var = intern (p->name);
10485 staticpro (p->var);
10486 Fput (*p->var, Qevent_kind, *p->kind);
10487 Fput (*p->var, Qevent_symbol_elements, Fcons (*p->var, Qnil));
10491 button_down_location = Fmake_vector (make_number (1), Qnil);
10492 staticpro (&button_down_location);
10493 mouse_syms = Fmake_vector (make_number (1), Qnil);
10494 staticpro (&mouse_syms);
10497 int i;
10498 int len = sizeof (modifier_names) / sizeof (modifier_names[0]);
10500 modifier_symbols = Fmake_vector (make_number (len), Qnil);
10501 for (i = 0; i < len; i++)
10502 if (modifier_names[i])
10503 XVECTOR (modifier_symbols)->contents[i] = intern (modifier_names[i]);
10504 staticpro (&modifier_symbols);
10507 recent_keys = Fmake_vector (make_number (NUM_RECENT_KEYS), Qnil);
10508 staticpro (&recent_keys);
10510 this_command_keys = Fmake_vector (make_number (40), Qnil);
10511 staticpro (&this_command_keys);
10513 raw_keybuf = Fmake_vector (make_number (30), Qnil);
10514 staticpro (&raw_keybuf);
10516 Qextended_command_history = intern ("extended-command-history");
10517 Fset (Qextended_command_history, Qnil);
10518 staticpro (&Qextended_command_history);
10520 kbd_buffer_gcpro = Fmake_vector (make_number (2 * KBD_BUFFER_SIZE), Qnil);
10521 staticpro (&kbd_buffer_gcpro);
10523 accent_key_syms = Qnil;
10524 staticpro (&accent_key_syms);
10526 func_key_syms = Qnil;
10527 staticpro (&func_key_syms);
10529 #ifdef WINDOWSNT
10530 mouse_wheel_syms = Qnil;
10531 staticpro (&mouse_wheel_syms);
10533 drag_n_drop_syms = Qnil;
10534 staticpro (&drag_n_drop_syms);
10535 #endif
10537 unread_switch_frame = Qnil;
10538 staticpro (&unread_switch_frame);
10540 internal_last_event_frame = Qnil;
10541 staticpro (&internal_last_event_frame);
10543 read_key_sequence_cmd = Qnil;
10544 staticpro (&read_key_sequence_cmd);
10546 menu_bar_one_keymap_changed_items = Qnil;
10547 staticpro (&menu_bar_one_keymap_changed_items);
10549 defsubr (&Sevent_convert_list);
10550 defsubr (&Sread_key_sequence);
10551 defsubr (&Sread_key_sequence_vector);
10552 defsubr (&Srecursive_edit);
10553 #ifdef HAVE_MOUSE
10554 defsubr (&Strack_mouse);
10555 #endif
10556 defsubr (&Sinput_pending_p);
10557 defsubr (&Scommand_execute);
10558 defsubr (&Srecent_keys);
10559 defsubr (&Sthis_command_keys);
10560 defsubr (&Sthis_command_keys_vector);
10561 defsubr (&Sthis_single_command_keys);
10562 defsubr (&Sthis_single_command_raw_keys);
10563 defsubr (&Sreset_this_command_lengths);
10564 defsubr (&Sclear_this_command_keys);
10565 defsubr (&Ssuspend_emacs);
10566 defsubr (&Sabort_recursive_edit);
10567 defsubr (&Sexit_recursive_edit);
10568 defsubr (&Srecursion_depth);
10569 defsubr (&Stop_level);
10570 defsubr (&Sdiscard_input);
10571 defsubr (&Sopen_dribble_file);
10572 defsubr (&Sset_input_mode);
10573 defsubr (&Scurrent_input_mode);
10574 defsubr (&Sexecute_extended_command);
10576 DEFVAR_LISP ("last-command-char", &last_command_char,
10577 doc: /* Last input event that was part of a command. */);
10579 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char,
10580 doc: /* Last input event that was part of a command. */);
10582 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event,
10583 doc: /* Last input event in a command, except for mouse menu events.
10584 Mouse menus give back keys that don't look like mouse events;
10585 this variable holds the actual mouse event that led to the menu,
10586 so that you can determine whether the command was run by mouse or not. */);
10588 DEFVAR_LISP ("last-input-char", &last_input_char,
10589 doc: /* Last input event. */);
10591 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char,
10592 doc: /* Last input event. */);
10594 DEFVAR_LISP ("unread-command-events", &Vunread_command_events,
10595 doc: /* List of events to be read as the command input.
10596 These events are processed first, before actual keyboard input. */);
10597 Vunread_command_events = Qnil;
10599 DEFVAR_INT ("unread-command-char", &unread_command_char,
10600 doc: /* If not -1, an object to be read as next command input event. */);
10602 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events,
10603 doc: /* List of events to be processed as input by input methods.
10604 These events are processed after `unread-command-events', but
10605 before actual keyboard input. */);
10606 Vunread_post_input_method_events = Qnil;
10608 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events,
10609 doc: /* List of events to be processed as input by input methods.
10610 These events are processed after `unread-command-events', but
10611 before actual keyboard input. */);
10612 Vunread_input_method_events = Qnil;
10614 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char,
10615 doc: /* Meta-prefix character code.
10616 Meta-foo as command input turns into this character followed by foo. */);
10617 XSETINT (meta_prefix_char, 033);
10619 DEFVAR_KBOARD ("last-command", Vlast_command,
10620 doc: /* The last command executed.
10621 Normally a symbol with a function definition, but can be whatever was found
10622 in the keymap, or whatever the variable `this-command' was set to by that
10623 command.
10625 The value `mode-exit' is special; it means that the previous command
10626 read an event that told it to exit, and it did so and unread that event.
10627 In other words, the present command is the event that made the previous
10628 command exit.
10630 The value `kill-region' is special; it means that the previous command
10631 was a kill command. */);
10633 DEFVAR_KBOARD ("real-last-command", Vreal_last_command,
10634 doc: /* Same as `last-command', but never altered by Lisp code. */);
10636 DEFVAR_LISP ("this-command", &Vthis_command,
10637 doc: /* The command now being executed.
10638 The command can set this variable; whatever is put here
10639 will be in `last-command' during the following command. */);
10640 Vthis_command = Qnil;
10642 DEFVAR_LISP ("this-original-command", &Vthis_original_command,
10643 doc: /* If non-nil, the original command bound to the current key sequence.
10644 The value of `this-command' is the result of looking up the original
10645 command in the active keymaps. */);
10646 Vthis_original_command = Qnil;
10648 DEFVAR_INT ("auto-save-interval", &auto_save_interval,
10649 doc: /* *Number of input events between auto-saves.
10650 Zero means disable autosaving due to number of characters typed. */);
10651 auto_save_interval = 300;
10653 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout,
10654 doc: /* *Number of seconds idle time before auto-save.
10655 Zero or nil means disable auto-saving due to idleness.
10656 After auto-saving due to this many seconds of idle time,
10657 Emacs also does a garbage collection if that seems to be warranted. */);
10658 XSETFASTINT (Vauto_save_timeout, 30);
10660 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes,
10661 doc: /* *Nonzero means echo unfinished commands after this many seconds of pause.
10662 The value may be integer or floating point. */);
10663 Vecho_keystrokes = make_number (1);
10665 DEFVAR_INT ("polling-period", &polling_period,
10666 doc: /* *Interval between polling for input during Lisp execution.
10667 The reason for polling is to make C-g work to stop a running program.
10668 Polling is needed only when using X windows and SIGIO does not work.
10669 Polling is automatically disabled in all other cases. */);
10670 polling_period = 2;
10672 DEFVAR_LISP ("double-click-time", &Vdouble_click_time,
10673 doc: /* *Maximum time between mouse clicks to make a double-click.
10674 Measured in milliseconds. nil means disable double-click recognition;
10675 t means double-clicks have no time limit and are detected
10676 by position only. */);
10677 Vdouble_click_time = make_number (500);
10679 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz,
10680 doc: /* *Maximum mouse movement between clicks to make a double-click.
10681 On window-system frames, value is the number of pixels the mouse may have
10682 moved horizontally or vertically between two clicks to make a double-click.
10683 On non window-system frames, value is interpreted in units of 1/8 characters
10684 instead of pixels.
10686 This variable is also the threshold for motion of the mouse
10687 to count as a drag. */);
10688 double_click_fuzz = 3;
10690 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus,
10691 doc: /* *Non-nil means inhibit local map menu bar menus. */);
10692 inhibit_local_menu_bar_menus = 0;
10694 DEFVAR_INT ("num-input-keys", &num_input_keys,
10695 doc: /* Number of complete key sequences read as input so far.
10696 This includes key sequences read from keyboard macros.
10697 The number is effectively the number of interactive command invocations. */);
10698 num_input_keys = 0;
10700 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events,
10701 doc: /* Number of input events read from the keyboard so far.
10702 This does not include events generated by keyboard macros. */);
10703 num_nonmacro_input_events = 0;
10705 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame,
10706 doc: /* The frame in which the most recently read event occurred.
10707 If the last event came from a keyboard macro, this is set to `macro'. */);
10708 Vlast_event_frame = Qnil;
10710 /* This variable is set up in sysdep.c. */
10711 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char,
10712 doc: /* The ERASE character as set by the user with stty. */);
10714 DEFVAR_LISP ("help-char", &Vhelp_char,
10715 doc: /* Character to recognize as meaning Help.
10716 When it is read, do `(eval help-form)', and display result if it's a string.
10717 If the value of `help-form' is nil, this char can be read normally. */);
10718 XSETINT (Vhelp_char, Ctl ('H'));
10720 DEFVAR_LISP ("help-event-list", &Vhelp_event_list,
10721 doc: /* List of input events to recognize as meaning Help.
10722 These work just like the value of `help-char' (see that). */);
10723 Vhelp_event_list = Qnil;
10725 DEFVAR_LISP ("help-form", &Vhelp_form,
10726 doc: /* Form to execute when character `help-char' is read.
10727 If the form returns a string, that string is displayed.
10728 If `help-form' is nil, the help char is not recognized. */);
10729 Vhelp_form = Qnil;
10731 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command,
10732 doc: /* Command to run when `help-char' character follows a prefix key.
10733 This command is used only when there is no actual binding
10734 for that character after that prefix key. */);
10735 Vprefix_help_command = Qnil;
10737 DEFVAR_LISP ("top-level", &Vtop_level,
10738 doc: /* Form to evaluate when Emacs starts up.
10739 Useful to set before you dump a modified Emacs. */);
10740 Vtop_level = Qnil;
10742 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table,
10743 doc: /* Translate table for keyboard input, or nil.
10744 Each character is looked up in this string and the contents used instead.
10745 The value may be a string, a vector, or a char-table.
10746 If it is a string or vector of length N,
10747 character codes N and up are untranslated.
10748 In a vector or a char-table, an element which is nil means "no translation". */);
10749 Vkeyboard_translate_table = Qnil;
10751 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend,
10752 doc: /* Non-nil means to always spawn a subshell instead of suspending.
10753 \(Even if the operating system has support for stopping a process.\) */);
10754 cannot_suspend = 0;
10756 DEFVAR_BOOL ("menu-prompting", &menu_prompting,
10757 doc: /* Non-nil means prompt with menus when appropriate.
10758 This is done when reading from a keymap that has a prompt string,
10759 for elements that have prompt strings.
10760 The menu is displayed on the screen
10761 if X menus were enabled at configuration
10762 time and the previous event was a mouse click prefix key.
10763 Otherwise, menu prompting uses the echo area. */);
10764 menu_prompting = 1;
10766 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char,
10767 doc: /* Character to see next line of menu prompt.
10768 Type this character while in a menu prompt to rotate around the lines of it. */);
10769 XSETINT (menu_prompt_more_char, ' ');
10771 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers,
10772 doc: /* A mask of additional modifier keys to use with every keyboard character.
10773 Emacs applies the modifiers of the character stored here to each keyboard
10774 character it reads. For example, after evaluating the expression
10775 (setq extra-keyboard-modifiers ?\\C-x)
10776 all input characters will have the control modifier applied to them.
10778 Note that the character ?\\C-@, equivalent to the integer zero, does
10779 not count as a control character; rather, it counts as a character
10780 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
10781 cancels any modification. */);
10782 extra_keyboard_modifiers = 0;
10784 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark,
10785 doc: /* If an editing command sets this to t, deactivate the mark afterward.
10786 The command loop sets this to nil before each command,
10787 and tests the value when the command returns.
10788 Buffer modification stores t in this variable. */);
10789 Vdeactivate_mark = Qnil;
10791 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal,
10792 doc: /* Temporary storage of pre-command-hook or post-command-hook. */);
10793 Vcommand_hook_internal = Qnil;
10795 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook,
10796 doc: /* Normal hook run before each command is executed.
10797 If an unhandled error happens in running this hook,
10798 the hook value is set to nil, since otherwise the error
10799 might happen repeatedly and make Emacs nonfunctional. */);
10800 Vpre_command_hook = Qnil;
10802 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook,
10803 doc: /* Normal hook run after each command is executed.
10804 If an unhandled error happens in running this hook,
10805 the hook value is set to nil, since otherwise the error
10806 might happen repeatedly and make Emacs nonfunctional. */);
10807 Vpost_command_hook = Qnil;
10809 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook,
10810 doc: /* Normal hook run after each command is executed, if idle.
10811 Errors running the hook are caught and ignored.
10812 This feature is obsolete; use idle timers instead. See `etc/NEWS'. */);
10813 Vpost_command_idle_hook = Qnil;
10815 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay,
10816 doc: /* Delay time before running `post-command-idle-hook'.
10817 This is measured in microseconds. */);
10818 post_command_idle_delay = 100000;
10820 #if 0
10821 DEFVAR_LISP ("echo-area-clear-hook", ...,
10822 doc: /* Normal hook run when clearing the echo area. */);
10823 #endif
10824 Qecho_area_clear_hook = intern ("echo-area-clear-hook");
10825 SET_SYMBOL_VALUE (Qecho_area_clear_hook, Qnil);
10827 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag,
10828 doc: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
10829 Vlucid_menu_bar_dirty_flag = Qnil;
10831 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items,
10832 doc: /* List of menu bar items to move to the end of the menu bar.
10833 The elements of the list are event types that may have menu bar bindings. */);
10834 Vmenu_bar_final_items = Qnil;
10836 DEFVAR_KBOARD ("overriding-terminal-local-map",
10837 Voverriding_terminal_local_map,
10838 doc: /* Per-terminal keymap that overrides all other local keymaps.
10839 If this variable is non-nil, it is used as a keymap instead of the
10840 buffer's local map, and the minor mode keymaps and text property keymaps.
10841 This variable is intended to let commands such as `universal-argument'
10842 set up a different keymap for reading the next command. */);
10844 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map,
10845 doc: /* Keymap that overrides all other local keymaps.
10846 If this variable is non-nil, it is used as a keymap instead of the
10847 buffer's local map, and the minor mode keymaps and text property keymaps. */);
10848 Voverriding_local_map = Qnil;
10850 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag,
10851 doc: /* Non-nil means `overriding-local-map' applies to the menu bar.
10852 Otherwise, the menu bar continues to reflect the buffer's local map
10853 and the minor mode maps regardless of `overriding-local-map'. */);
10854 Voverriding_local_map_menu_flag = Qnil;
10856 DEFVAR_LISP ("special-event-map", &Vspecial_event_map,
10857 doc: /* Keymap defining bindings for special events to execute at low level. */);
10858 Vspecial_event_map = Fcons (intern ("keymap"), Qnil);
10860 DEFVAR_LISP ("track-mouse", &do_mouse_tracking,
10861 doc: /* *Non-nil means generate motion events for mouse motion. */);
10863 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist,
10864 doc: /* Alist of system-specific X windows key symbols.
10865 Each element should have the form (N . SYMBOL) where N is the
10866 numeric keysym code (sans the \"system-specific\" bit 1<<28)
10867 and SYMBOL is its name. */);
10869 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list,
10870 doc: /* List of deferred actions to be performed at a later time.
10871 The precise format isn't relevant here; we just check whether it is nil. */);
10872 Vdeferred_action_list = Qnil;
10874 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function,
10875 doc: /* Function to call to handle deferred actions, after each command.
10876 This function is called with no arguments after each command
10877 whenever `deferred-action-list' is non-nil. */);
10878 Vdeferred_action_function = Qnil;
10880 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings,
10881 doc: /* *Non-nil means show the equivalent key-binding when M-x command has one.
10882 The value can be a length of time to show the message for.
10883 If the value is non-nil and not a number, we wait 2 seconds. */);
10884 Vsuggest_key_bindings = Qt;
10886 DEFVAR_LISP ("timer-list", &Vtimer_list,
10887 doc: /* List of active absolute time timers in order of increasing time. */);
10888 Vtimer_list = Qnil;
10890 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list,
10891 doc: /* List of active idle-time timers in order of increasing time. */);
10892 Vtimer_idle_list = Qnil;
10894 DEFVAR_LISP ("input-method-function", &Vinput_method_function,
10895 doc: /* If non-nil, the function that implements the current input method.
10896 It's called with one argument, a printing character that was just read.
10897 \(That means a character with code 040...0176.)
10898 Typically this function uses `read-event' to read additional events.
10899 When it does so, it should first bind `input-method-function' to nil
10900 so it will not be called recursively.
10902 The function should return a list of zero or more events
10903 to be used as input. If it wants to put back some events
10904 to be reconsidered, separately, by the input method,
10905 it can add them to the beginning of `unread-command-events'.
10907 The input method function can find in `input-method-previous-method'
10908 the previous echo area message.
10910 The input method function should refer to the variables
10911 `input-method-use-echo-area' and `input-method-exit-on-first-char'
10912 for guidance on what to do. */);
10913 Vinput_method_function = Qnil;
10915 DEFVAR_LISP ("input-method-previous-message",
10916 &Vinput_method_previous_message,
10917 doc: /* When `input-method-function' is called, hold the previous echo area message.
10918 This variable exists because `read-event' clears the echo area
10919 before running the input method. It is nil if there was no message. */);
10920 Vinput_method_previous_message = Qnil;
10922 DEFVAR_LISP ("show-help-function", &Vshow_help_function,
10923 doc: /* If non-nil, the function that implements the display of help.
10924 It's called with one argument, the help string to display. */);
10925 Vshow_help_function = Qnil;
10927 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment,
10928 doc: /* If non-nil, suppress point adjustment after executing a command.
10930 After a command is executed, if point is moved into a region that has
10931 special properties (e.g. composition, display), we adjust point to
10932 the boundary of the region. But, several special commands sets this
10933 variable to non-nil, then we suppress the point adjustment.
10935 This variable is set to nil before reading a command, and is checked
10936 just after executing the command. */);
10937 Vdisable_point_adjustment = Qnil;
10939 DEFVAR_LISP ("global-disable-point-adjustment",
10940 &Vglobal_disable_point_adjustment,
10941 doc: /* *If non-nil, always suppress point adjustment.
10943 The default value is nil, in which case, point adjustment are
10944 suppressed only after special commands that set
10945 `disable-point-adjustment' (which see) to non-nil. */);
10946 Vglobal_disable_point_adjustment = Qnil;
10948 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings,
10949 doc: /* Non-nil means updating menu bindings is allowed.
10950 A value of nil means menu bindings should not be updated.
10951 Used during Emacs' startup. */);
10952 update_menu_bindings = 1;
10954 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout,
10955 doc: /* *How long to display an echo-area message when the minibuffer is active.
10956 If the value is not a number, such messages don't time out. */);
10957 Vminibuffer_message_timeout = make_number (2);
10960 void
10961 keys_of_keyboard ()
10963 initial_define_key (global_map, Ctl ('Z'), "suspend-emacs");
10964 initial_define_key (control_x_map, Ctl ('Z'), "suspend-emacs");
10965 initial_define_key (meta_map, Ctl ('C'), "exit-recursive-edit");
10966 initial_define_key (global_map, Ctl (']'), "abort-recursive-edit");
10967 initial_define_key (meta_map, 'x', "execute-extended-command");
10969 initial_define_lispy_key (Vspecial_event_map, "delete-frame",
10970 "handle-delete-frame");
10971 initial_define_lispy_key (Vspecial_event_map, "iconify-frame",
10972 "ignore-event");
10973 initial_define_lispy_key (Vspecial_event_map, "make-frame-visible",
10974 "ignore-event");
10975 initial_define_lispy_key (Vspecial_event_map, "select-window",
10976 "handle-select-window");
10977 initial_define_lispy_key (Vspecial_event_map, "save-session",
10978 "handle-save-session");